blob: 413ef89c2d1ba32fe8507f29355d11c5873bc7d0 [file] [log] [blame]
David Woodhousec00c3102007-04-25 14:16:47 +01001/*
2 * JFFS2 -- Journalling Flash File System, Version 2.
3 *
4 * Copyright © 2001-2007 Red Hat, Inc.
David Woodhouse6088c052010-08-08 14:15:22 +01005 * Copyright © 2004-2010 David Woodhouse <dwmw2@infradead.org>
David Woodhousec00c3102007-04-25 14:16:47 +01006 *
7 * Created by David Woodhouse <dwmw2@infradead.org>
8 *
9 * For licensing information, see the file 'LICENCE' in this directory.
10 *
11 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070012
13#ifndef _JFFS2_FS_SB
14#define _JFFS2_FS_SB
15
16#include <linux/types.h>
17#include <linux/spinlock.h>
18#include <linux/workqueue.h>
19#include <linux/completion.h>
David Woodhouseced22072008-04-22 15:13:40 +010020#include <linux/mutex.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070021#include <linux/timer.h>
22#include <linux/wait.h>
23#include <linux/list.h>
24#include <linux/rwsem.h>
25
26#define JFFS2_SB_FLAG_RO 1
Artem B. Bityuckiy31fbdf72005-02-28 08:21:09 +000027#define JFFS2_SB_FLAG_SCANNING 2 /* Flash scanning is in progress */
28#define JFFS2_SB_FLAG_BUILDING 4 /* File system building is in progress */
Linus Torvalds1da177e2005-04-16 15:20:36 -070029
30struct jffs2_inodirty;
31
Andres Salomon92abc472011-10-16 18:15:16 -070032struct jffs2_mount_opts {
33 bool override_compr;
34 unsigned int compr;
Daniel Drake8da8ba22012-04-10 22:22:35 +010035
36 /* The size of the reserved pool. The reserved pool is the JFFS2 flash
37 * space which may only be used by root cannot be used by the other
38 * users. This is implemented simply by means of not allowing the
39 * latter users to write to the file system if the amount if the
40 * available space is less then 'rp_size'. */
41 unsigned int rp_size;
Andres Salomon92abc472011-10-16 18:15:16 -070042};
43
Linus Torvalds1da177e2005-04-16 15:20:36 -070044/* A struct for the overall file system control. Pointers to
Thomas Gleixner182ec4e2005-11-07 11:16:07 +000045 jffs2_sb_info structs are named `c' in the source code.
Linus Torvalds1da177e2005-04-16 15:20:36 -070046 Nee jffs_control
47*/
48struct jffs2_sb_info {
49 struct mtd_info *mtd;
50
51 uint32_t highest_ino;
52 uint32_t checked_ino;
53
54 unsigned int flags;
55
56 struct task_struct *gc_task; /* GC task struct */
Thomas Gleixnerfff7afd2005-05-19 17:18:11 +010057 struct completion gc_thread_start; /* GC thread start completion */
Linus Torvalds1da177e2005-04-16 15:20:36 -070058 struct completion gc_thread_exit; /* GC thread exit completion port */
59
David Woodhouseced22072008-04-22 15:13:40 +010060 struct mutex alloc_sem; /* Used to protect all the following
Linus Torvalds1da177e2005-04-16 15:20:36 -070061 fields, and also to protect against
62 out-of-order writing of nodes. And GC. */
63 uint32_t cleanmarker_size; /* Size of an _inline_ CLEANMARKER
64 (i.e. zero for OOB CLEANMARKER */
65
66 uint32_t flash_size;
67 uint32_t used_size;
68 uint32_t dirty_size;
69 uint32_t wasted_size;
70 uint32_t free_size;
71 uint32_t erasing_size;
72 uint32_t bad_size;
73 uint32_t sector_size;
74 uint32_t unchecked_size;
75
76 uint32_t nr_free_blocks;
77 uint32_t nr_erasing_blocks;
78
79 /* Number of free blocks there must be before we... */
80 uint8_t resv_blocks_write; /* ... allow a normal filesystem write */
81 uint8_t resv_blocks_deletion; /* ... allow a normal filesystem deletion */
82 uint8_t resv_blocks_gctrigger; /* ... wake up the GC thread */
83 uint8_t resv_blocks_gcbad; /* ... pick a block from the bad_list to GC */
84 uint8_t resv_blocks_gcmerge; /* ... merge pages when garbage collecting */
David Woodhouse8fb870df2007-10-06 15:12:58 -040085 /* Number of 'very dirty' blocks before we trigger immediate GC */
86 uint8_t vdirty_blocks_gctrigger;
Linus Torvalds1da177e2005-04-16 15:20:36 -070087
88 uint32_t nospc_dirty_size;
89
90 uint32_t nr_blocks;
Thomas Gleixner182ec4e2005-11-07 11:16:07 +000091 struct jffs2_eraseblock *blocks; /* The whole array of blocks. Used for getting blocks
Linus Torvalds1da177e2005-04-16 15:20:36 -070092 * from the offset (blocks[ofs / sector_size]) */
93 struct jffs2_eraseblock *nextblock; /* The block we're currently filling */
94
95 struct jffs2_eraseblock *gcblock; /* The block we're currently garbage-collecting */
96
97 struct list_head clean_list; /* Blocks 100% full of clean data */
98 struct list_head very_dirty_list; /* Blocks with lots of dirty space */
99 struct list_head dirty_list; /* Blocks with some dirty space */
100 struct list_head erasable_list; /* Blocks which are completely dirty, and need erasing */
101 struct list_head erasable_pending_wbuf_list; /* Blocks which need erasing but only after the current wbuf is flushed */
102 struct list_head erasing_list; /* Blocks which are currently erasing */
David Woodhousee2bc3222008-04-23 14:15:24 +0100103 struct list_head erase_checking_list; /* Blocks which are being checked and marked */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104 struct list_head erase_pending_list; /* Blocks which need erasing now */
105 struct list_head erase_complete_list; /* Blocks which are erased and need the clean marker written to them */
106 struct list_head free_list; /* Blocks which are free and ready to be used */
107 struct list_head bad_list; /* Bad blocks. */
108 struct list_head bad_used_list; /* Bad blocks with valid data in. */
109
Thomas Gleixner182ec4e2005-11-07 11:16:07 +0000110 spinlock_t erase_completion_lock; /* Protect free_list and erasing_list
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111 against erase completion handler */
112 wait_queue_head_t erase_wait; /* For waiting for erases to complete */
113
114 wait_queue_head_t inocache_wq;
Daniel Drake65e5a0e2010-10-07 19:14:02 +0100115 int inocache_hashsize;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116 struct jffs2_inode_cache **inocache_list;
117 spinlock_t inocache_lock;
Thomas Gleixner182ec4e2005-11-07 11:16:07 +0000118
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119 /* Sem to allow jffs2_garbage_collect_deletion_dirent to
Thomas Gleixner182ec4e2005-11-07 11:16:07 +0000120 drop the erase_completion_lock while it's holding a pointer
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121 to an obsoleted node. I don't like this. Alternatives welcomed. */
David Woodhouseced22072008-04-22 15:13:40 +0100122 struct mutex erase_free_sem;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123
Artem B. Bityutskiy733802d2005-09-22 12:25:00 +0100124 uint32_t wbuf_pagesize; /* 0 for NOR and other flashes with no wbuf */
Thomas Gleixner182ec4e2005-11-07 11:16:07 +0000125
David Woodhousea6bc4322007-07-11 14:23:54 +0100126#ifdef CONFIG_JFFS2_FS_WBUF_VERIFY
127 unsigned char *wbuf_verify; /* read-back buffer for verification */
128#endif
Andrew Victor2f82ce12005-02-09 09:24:26 +0000129#ifdef CONFIG_JFFS2_FS_WRITEBUFFER
Artem Bityutskiya7a6ace12007-01-31 11:38:53 +0200130 unsigned char *wbuf; /* Write-behind buffer for NAND flash */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131 uint32_t wbuf_ofs;
132 uint32_t wbuf_len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133 struct jffs2_inodirty *wbuf_inodes;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134 struct rw_semaphore wbuf_sem; /* Protects the write buffer */
135
Artem Bityutskiy208b14e2012-05-07 19:02:46 +0300136 struct delayed_work wbuf_dwork; /* write-buffer write-out work */
137 int wbuf_queued; /* non-zero delayed work is queued */
138 spinlock_t wbuf_dwork_lock; /* protects wbuf_dwork and and wbuf_queued */
139
Artem Bityutskiya7a6ace12007-01-31 11:38:53 +0200140 unsigned char *oobbuf;
141 int oobavail; /* How many bytes are available for JFFS2 in OOB */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142#endif
143
Ferenc Havasie631ddb2005-09-07 09:35:26 +0100144 struct jffs2_summary *summary; /* Summary information */
Andres Salomon92abc472011-10-16 18:15:16 -0700145 struct jffs2_mount_opts mount_opts;
Ferenc Havasie631ddb2005-09-07 09:35:26 +0100146
KaiGai Koheiaa98d7c2006-05-13 15:09:47 +0900147#ifdef CONFIG_JFFS2_FS_XATTR
148#define XATTRINDEX_HASHSIZE (57)
149 uint32_t highest_xid;
KaiGai Koheic9f700f2006-06-11 10:35:15 +0900150 uint32_t highest_xseqno;
KaiGai Koheiaa98d7c2006-05-13 15:09:47 +0900151 struct list_head xattrindex[XATTRINDEX_HASHSIZE];
KaiGai Koheiaa98d7c2006-05-13 15:09:47 +0900152 struct list_head xattr_unchecked;
KaiGai Koheic9f700f2006-06-11 10:35:15 +0900153 struct list_head xattr_dead_list;
154 struct jffs2_xattr_ref *xref_dead_list;
KaiGai Kohei8f2b6f42006-05-13 15:15:07 +0900155 struct jffs2_xattr_ref *xref_temp;
KaiGai Koheiaa98d7c2006-05-13 15:09:47 +0900156 struct rw_semaphore xattr_sem;
157 uint32_t xdatum_mem_usage;
158 uint32_t xdatum_mem_threshold;
159#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160 /* OS-private pointer for getting back to master superblock info */
161 void *os_priv;
162};
163
Dan Carpenter027d9ac2010-11-15 21:20:05 +0300164#endif /* _JFFS2_FS_SB */