xref: /openbmc/linux/fs/jffs2/jffs2_fs_sb.h (revision 2f785402)
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 	struct jffs2_raw_node_ref *refs;
30 	int reserved_refs;
31 
32 	uint32_t highest_ino;
33 	uint32_t checked_ino;
34 
35 	unsigned int flags;
36 
37 	struct task_struct *gc_task;	/* GC task struct */
38 	struct completion gc_thread_start; /* GC thread start completion */
39 	struct completion gc_thread_exit; /* GC thread exit completion port */
40 
41 	struct semaphore alloc_sem;	/* Used to protect all the following
42 					   fields, and also to protect against
43 					   out-of-order writing of nodes. And GC. */
44 	uint32_t cleanmarker_size;	/* Size of an _inline_ CLEANMARKER
45 					 (i.e. zero for OOB CLEANMARKER */
46 
47 	uint32_t flash_size;
48 	uint32_t used_size;
49 	uint32_t dirty_size;
50 	uint32_t wasted_size;
51 	uint32_t free_size;
52 	uint32_t erasing_size;
53 	uint32_t bad_size;
54 	uint32_t sector_size;
55 	uint32_t unchecked_size;
56 
57 	uint32_t nr_free_blocks;
58 	uint32_t nr_erasing_blocks;
59 
60 	/* Number of free blocks there must be before we... */
61 	uint8_t resv_blocks_write;	/* ... allow a normal filesystem write */
62 	uint8_t resv_blocks_deletion;	/* ... allow a normal filesystem deletion */
63 	uint8_t resv_blocks_gctrigger;	/* ... wake up the GC thread */
64 	uint8_t resv_blocks_gcbad;	/* ... pick a block from the bad_list to GC */
65 	uint8_t resv_blocks_gcmerge;	/* ... merge pages when garbage collecting */
66 
67 	uint32_t nospc_dirty_size;
68 
69 	uint32_t nr_blocks;
70 	struct jffs2_eraseblock *blocks;	/* The whole array of blocks. Used for getting blocks
71 						 * from the offset (blocks[ofs / sector_size]) */
72 	struct jffs2_eraseblock *nextblock;	/* The block we're currently filling */
73 
74 	struct jffs2_eraseblock *gcblock;	/* The block we're currently garbage-collecting */
75 
76 	struct list_head clean_list;		/* Blocks 100% full of clean data */
77 	struct list_head very_dirty_list;	/* Blocks with lots of dirty space */
78 	struct list_head dirty_list;		/* Blocks with some dirty space */
79 	struct list_head erasable_list;		/* Blocks which are completely dirty, and need erasing */
80 	struct list_head erasable_pending_wbuf_list;	/* Blocks which need erasing but only after the current wbuf is flushed */
81 	struct list_head erasing_list;		/* Blocks which are currently erasing */
82 	struct list_head erase_pending_list;	/* Blocks which need erasing now */
83 	struct list_head erase_complete_list;	/* Blocks which are erased and need the clean marker written to them */
84 	struct list_head free_list;		/* Blocks which are free and ready to be used */
85 	struct list_head bad_list;		/* Bad blocks. */
86 	struct list_head bad_used_list;		/* Bad blocks with valid data in. */
87 
88 	spinlock_t erase_completion_lock;	/* Protect free_list and erasing_list
89 						   against erase completion handler */
90 	wait_queue_head_t erase_wait;		/* For waiting for erases to complete */
91 
92 	wait_queue_head_t inocache_wq;
93 	struct jffs2_inode_cache **inocache_list;
94 	spinlock_t inocache_lock;
95 
96 	/* Sem to allow jffs2_garbage_collect_deletion_dirent to
97 	   drop the erase_completion_lock while it's holding a pointer
98 	   to an obsoleted node. I don't like this. Alternatives welcomed. */
99 	struct semaphore erase_free_sem;
100 
101 	uint32_t wbuf_pagesize; /* 0 for NOR and other flashes with no wbuf */
102 
103 #ifdef CONFIG_JFFS2_FS_WRITEBUFFER
104 	/* Write-behind buffer for NAND flash */
105 	unsigned char *wbuf;
106 	uint32_t wbuf_ofs;
107 	uint32_t wbuf_len;
108 	struct jffs2_inodirty *wbuf_inodes;
109 
110 	struct rw_semaphore wbuf_sem;	/* Protects the write buffer */
111 
112 	/* Information about out-of-band area usage... */
113 	struct nand_oobinfo *oobinfo;
114 	uint32_t badblock_pos;
115 	uint32_t fsdata_pos;
116 	uint32_t fsdata_len;
117 #endif
118 
119 	struct jffs2_summary *summary;		/* Summary information */
120 
121 #ifdef CONFIG_JFFS2_FS_XATTR
122 #define XATTRINDEX_HASHSIZE	(57)
123 	uint32_t highest_xid;
124 	struct list_head xattrindex[XATTRINDEX_HASHSIZE];
125 	struct list_head xattr_unchecked;
126 	struct jffs2_xattr_ref *xref_temp;
127 	struct rw_semaphore xattr_sem;
128 	uint32_t xdatum_mem_usage;
129 	uint32_t xdatum_mem_threshold;
130 #endif
131 	/* OS-private pointer for getting back to master superblock info */
132 	void *os_priv;
133 };
134 
135 #endif /* _JFFS2_FB_SB */
136