xref: /openbmc/linux/fs/jffs2/jffs2_fs_sb.h (revision 8593fbc6)
1 /* $Id: jffs2_fs_sb.h,v 1.54 2005/09/21 13:37:34 dedekind Exp $ */
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
17 #define JFFS2_SB_FLAG_SCANNING 2 /* Flash scanning is in progress */
18 #define JFFS2_SB_FLAG_BUILDING 4 /* File system building is in progress */
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 */
35 	struct completion gc_thread_start; /* GC thread start completion */
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 
98 	uint32_t wbuf_pagesize; /* 0 for NOR and other flashes with no wbuf */
99 
100 #ifdef CONFIG_JFFS2_FS_WRITEBUFFER
101 	/* Write-behind buffer for NAND flash */
102 	unsigned char *wbuf;
103 	unsigned char *oobbuf;
104 	uint32_t wbuf_ofs;
105 	uint32_t wbuf_len;
106 	struct jffs2_inodirty *wbuf_inodes;
107 
108 	struct rw_semaphore wbuf_sem;	/* Protects the write buffer */
109 
110 	/* Information about out-of-band area usage... */
111 	struct nand_ecclayout *ecclayout;
112 	uint32_t badblock_pos;
113 	uint32_t fsdata_pos;
114 	uint32_t fsdata_len;
115 #endif
116 
117 	struct jffs2_summary *summary;		/* Summary information */
118 
119 #ifdef CONFIG_JFFS2_FS_XATTR
120 #define XATTRINDEX_HASHSIZE	(57)
121 	uint32_t highest_xid;
122 	struct list_head xattrindex[XATTRINDEX_HASHSIZE];
123 	struct list_head xattr_unchecked;
124 	struct jffs2_xattr_ref *xref_temp;
125 	struct rw_semaphore xattr_sem;
126 	uint32_t xdatum_mem_usage;
127 	uint32_t xdatum_mem_threshold;
128 #endif
129 	/* OS-private pointer for getting back to master superblock info */
130 	void *os_priv;
131 };
132 
133 #endif /* _JFFS2_FB_SB */
134