[net-next-2.6.git] / include / linux / jffs2_fs_sb.h

/* $Id: jffs2_fs_sb.h,v 1.52 2005/05/19 16:12:17 gleixner Exp $ */

#ifndef _JFFS2_FS_SB
#define _JFFS2_FS_SB

#include <linux/types.h>
#include <linux/spinlock.h>
#include <linux/workqueue.h>
#include <linux/completion.h>
#include <asm/semaphore.h>
#include <linux/timer.h>
#include <linux/wait.h>
#include <linux/list.h>
#include <linux/rwsem.h>

#define JFFS2_SB_FLAG_RO 1
#define JFFS2_SB_FLAG_SCANNING 2 /* Flash scanning is in progress */
#define JFFS2_SB_FLAG_BUILDING 4 /* File system building is in progress */

struct jffs2_inodirty;

/* A struct for the overall file system control.  Pointers to
   jffs2_sb_info structs are named `c' in the source code.  
   Nee jffs_control
*/
struct jffs2_sb_info {
	struct mtd_info *mtd;

	uint32_t highest_ino;
	uint32_t checked_ino;

	unsigned int flags;

	struct task_struct *gc_task;	/* GC task struct */
	struct completion gc_thread_start; /* GC thread start completion */
	struct completion gc_thread_exit; /* GC thread exit completion port */

	struct semaphore alloc_sem;	/* Used to protect all the following 
					   fields, and also to protect against
					   out-of-order writing of nodes. And GC. */
	uint32_t cleanmarker_size;	/* Size of an _inline_ CLEANMARKER
					 (i.e. zero for OOB CLEANMARKER */

	uint32_t flash_size;
	uint32_t used_size;
	uint32_t dirty_size;
	uint32_t wasted_size;
	uint32_t free_size;
	uint32_t erasing_size;
	uint32_t bad_size;
	uint32_t sector_size;
	uint32_t unchecked_size;

	uint32_t nr_free_blocks;
	uint32_t nr_erasing_blocks;

	/* Number of free blocks there must be before we... */
	uint8_t resv_blocks_write;	/* ... allow a normal filesystem write */
	uint8_t resv_blocks_deletion;	/* ... allow a normal filesystem deletion */
	uint8_t resv_blocks_gctrigger;	/* ... wake up the GC thread */
	uint8_t resv_blocks_gcbad;	/* ... pick a block from the bad_list to GC */
	uint8_t resv_blocks_gcmerge;	/* ... merge pages when garbage collecting */

	uint32_t nospc_dirty_size;

	uint32_t nr_blocks;
	struct jffs2_eraseblock *blocks;	/* The whole array of blocks. Used for getting blocks 
						 * from the offset (blocks[ofs / sector_size]) */
	struct jffs2_eraseblock *nextblock;	/* The block we're currently filling */

	struct jffs2_eraseblock *gcblock;	/* The block we're currently garbage-collecting */

	struct list_head clean_list;		/* Blocks 100% full of clean data */
	struct list_head very_dirty_list;	/* Blocks with lots of dirty space */
	struct list_head dirty_list;		/* Blocks with some dirty space */
	struct list_head erasable_list;		/* Blocks which are completely dirty, and need erasing */
	struct list_head erasable_pending_wbuf_list;	/* Blocks which need erasing but only after the current wbuf is flushed */
	struct list_head erasing_list;		/* Blocks which are currently erasing */
	struct list_head erase_pending_list;	/* Blocks which need erasing now */
	struct list_head erase_complete_list;	/* Blocks which are erased and need the clean marker written to them */
	struct list_head free_list;		/* Blocks which are free and ready to be used */
	struct list_head bad_list;		/* Bad blocks. */
	struct list_head bad_used_list;		/* Bad blocks with valid data in. */

	spinlock_t erase_completion_lock;	/* Protect free_list and erasing_list 
						   against erase completion handler */
	wait_queue_head_t erase_wait;		/* For waiting for erases to complete */

	wait_queue_head_t inocache_wq;
	struct jffs2_inode_cache **inocache_list;
	spinlock_t inocache_lock;
	
	/* Sem to allow jffs2_garbage_collect_deletion_dirent to
	   drop the erase_completion_lock while it's holding a pointer 
	   to an obsoleted node. I don't like this. Alternatives welcomed. */
	struct semaphore erase_free_sem;

#ifdef CONFIG_JFFS2_FS_WRITEBUFFER
	/* Write-behind buffer for NAND flash */
	unsigned char *wbuf;
	uint32_t wbuf_ofs;
	uint32_t wbuf_len;
	uint32_t wbuf_pagesize;
	struct jffs2_inodirty *wbuf_inodes;

	struct rw_semaphore wbuf_sem;	/* Protects the write buffer */

	/* Information about out-of-band area usage... */
	struct nand_oobinfo *oobinfo;
	uint32_t badblock_pos;
	uint32_t fsdata_pos;
	uint32_t fsdata_len;
#endif

	/* OS-private pointer for getting back to master superblock info */
	void *os_priv;
};

#endif /* _JFFS2_FB_SB */
Commit	Line	Data
fff7afd7	1	/* $Id: jffs2_fs_sb.h,v 1.52 2005/05/19 16:12:17 gleixner Exp $ */
1da177e4 LT	2
	3	#ifndef _JFFS2_FS_SB
	4	#define _JFFS2_FS_SB
	5
	6	#include <linux/types.h>
	7	#include <linux/spinlock.h>
	8	#include <linux/workqueue.h>
	9	#include <linux/completion.h>
	10	#include <asm/semaphore.h>
	11	#include <linux/timer.h>
	12	#include <linux/wait.h>
	13	#include <linux/list.h>
	14	#include <linux/rwsem.h>
	15
	16	#define JFFS2_SB_FLAG_RO 1
31fbdf7a AB	17	#define JFFS2_SB_FLAG_SCANNING 2 /* Flash scanning is in progress */
31fbdf7a AB	18	#define JFFS2_SB_FLAG_BUILDING 4 /* File system building is in progress */
1da177e4 LT	19
	20	struct jffs2_inodirty;
	21
	22	/* A struct for the overall file system control. Pointers to
	23	jffs2_sb_info structs are named `c' in the source code.
	24	Nee jffs_control
	25	*/
	26	struct jffs2_sb_info {
	27	struct mtd_info *mtd;
	28
	29	uint32_t highest_ino;
	30	uint32_t checked_ino;
	31
	32	unsigned int flags;
	33
	34	struct task_struct gc_task; / GC task struct */
fff7afd7	35	struct completion gc_thread_start; /* GC thread start completion */
1da177e4 LT	36	struct completion gc_thread_exit; /* GC thread exit completion port */
	37
	38	struct semaphore alloc_sem; /* Used to protect all the following
	39	fields, and also to protect against
	40	out-of-order writing of nodes. And GC. */
	41	uint32_t cleanmarker_size; /* Size of an _inline_ CLEANMARKER
	42	(i.e. zero for OOB CLEANMARKER */
	43
	44	uint32_t flash_size;
	45	uint32_t used_size;
	46	uint32_t dirty_size;
	47	uint32_t wasted_size;
	48	uint32_t free_size;
	49	uint32_t erasing_size;
	50	uint32_t bad_size;
	51	uint32_t sector_size;
	52	uint32_t unchecked_size;
	53
	54	uint32_t nr_free_blocks;
	55	uint32_t nr_erasing_blocks;
	56
	57	/* Number of free blocks there must be before we... */
	58	uint8_t resv_blocks_write; /* ... allow a normal filesystem write */
	59	uint8_t resv_blocks_deletion; /* ... allow a normal filesystem deletion */
	60	uint8_t resv_blocks_gctrigger; /* ... wake up the GC thread */
	61	uint8_t resv_blocks_gcbad; /* ... pick a block from the bad_list to GC */
	62	uint8_t resv_blocks_gcmerge; /* ... merge pages when garbage collecting */
	63
	64	uint32_t nospc_dirty_size;
	65
	66	uint32_t nr_blocks;
	67	struct jffs2_eraseblock blocks; / The whole array of blocks. Used for getting blocks
	68	* from the offset (blocks[ofs / sector_size]) */
	69	struct jffs2_eraseblock nextblock; / The block we're currently filling */
	70
	71	struct jffs2_eraseblock gcblock; / The block we're currently garbage-collecting */
	72
	73	struct list_head clean_list; /* Blocks 100% full of clean data */
	74	struct list_head very_dirty_list; /* Blocks with lots of dirty space */
	75	struct list_head dirty_list; /* Blocks with some dirty space */
	76	struct list_head erasable_list; /* Blocks which are completely dirty, and need erasing */
	77	struct list_head erasable_pending_wbuf_list; /* Blocks which need erasing but only after the current wbuf is flushed */
	78	struct list_head erasing_list; /* Blocks which are currently erasing */
	79	struct list_head erase_pending_list; /* Blocks which need erasing now */
	80	struct list_head erase_complete_list; /* Blocks which are erased and need the clean marker written to them */
	81	struct list_head free_list; /* Blocks which are free and ready to be used */
	82	struct list_head bad_list; /* Bad blocks. */
	83	struct list_head bad_used_list; /* Bad blocks with valid data in. */
	84
	85	spinlock_t erase_completion_lock; /* Protect free_list and erasing_list
	86	against erase completion handler */
	87	wait_queue_head_t erase_wait; /* For waiting for erases to complete */
	88
	89	wait_queue_head_t inocache_wq;
	90	struct jffs2_inode_cache **inocache_list;
	91	spinlock_t inocache_lock;
	92
	93	/* Sem to allow jffs2_garbage_collect_deletion_dirent to
	94	drop the erase_completion_lock while it's holding a pointer
	95	to an obsoleted node. I don't like this. Alternatives welcomed. */
	96	struct semaphore erase_free_sem;
	97
2f82ce1e	98	#ifdef CONFIG_JFFS2_FS_WRITEBUFFER
1da177e4 LT	99	/* Write-behind buffer for NAND flash */
	100	unsigned char *wbuf;
	101	uint32_t wbuf_ofs;
	102	uint32_t wbuf_len;
	103	uint32_t wbuf_pagesize;
	104	struct jffs2_inodirty *wbuf_inodes;
	105
	106	struct rw_semaphore wbuf_sem; /* Protects the write buffer */
	107
	108	/* Information about out-of-band area usage... */
	109	struct nand_oobinfo *oobinfo;
	110	uint32_t badblock_pos;
	111	uint32_t fsdata_pos;
	112	uint32_t fsdata_len;
	113	#endif
	114
	115	/* OS-private pointer for getting back to master superblock info */
	116	void *os_priv;
	117	};
	118
	119	#endif /* _JFFS2_FB_SB */