blob: 85ef6dbb1be7adb3dbbd3553f008a32fe1c35dfc [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.
5 *
6 * Created by David Woodhouse <dwmw2@infradead.org>
7 *
8 * For licensing information, see the file 'LICENCE' in this directory.
9 *
10 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070011
12#ifndef _JFFS2_FS_SB
13#define _JFFS2_FS_SB
14
15#include <linux/types.h>
16#include <linux/spinlock.h>
17#include <linux/workqueue.h>
18#include <linux/completion.h>
David Woodhouseced22072008-04-22 15:13:40 +010019#include <linux/mutex.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070020#include <linux/timer.h>
21#include <linux/wait.h>
22#include <linux/list.h>
23#include <linux/rwsem.h>
24
25#define JFFS2_SB_FLAG_RO 1
Artem B. Bityuckiy31fbdf72005-02-28 08:21:09 +000026#define JFFS2_SB_FLAG_SCANNING 2 /* Flash scanning is in progress */
27#define JFFS2_SB_FLAG_BUILDING 4 /* File system building is in progress */
Linus Torvalds1da177e2005-04-16 15:20:36 -070028
29struct jffs2_inodirty;
30
31/* A struct for the overall file system control. Pointers to
Thomas Gleixner182ec4e2005-11-07 11:16:07 +000032 jffs2_sb_info structs are named `c' in the source code.
Linus Torvalds1da177e2005-04-16 15:20:36 -070033 Nee jffs_control
34*/
35struct jffs2_sb_info {
36 struct mtd_info *mtd;
37
38 uint32_t highest_ino;
39 uint32_t checked_ino;
40
41 unsigned int flags;
42
43 struct task_struct *gc_task; /* GC task struct */
Thomas Gleixnerfff7afd2005-05-19 17:18:11 +010044 struct completion gc_thread_start; /* GC thread start completion */
Linus Torvalds1da177e2005-04-16 15:20:36 -070045 struct completion gc_thread_exit; /* GC thread exit completion port */
46
David Woodhouseced22072008-04-22 15:13:40 +010047 struct mutex alloc_sem; /* Used to protect all the following
Linus Torvalds1da177e2005-04-16 15:20:36 -070048 fields, and also to protect against
49 out-of-order writing of nodes. And GC. */
50 uint32_t cleanmarker_size; /* Size of an _inline_ CLEANMARKER
51 (i.e. zero for OOB CLEANMARKER */
52
53 uint32_t flash_size;
54 uint32_t used_size;
55 uint32_t dirty_size;
56 uint32_t wasted_size;
57 uint32_t free_size;
58 uint32_t erasing_size;
59 uint32_t bad_size;
60 uint32_t sector_size;
61 uint32_t unchecked_size;
62
63 uint32_t nr_free_blocks;
64 uint32_t nr_erasing_blocks;
65
66 /* Number of free blocks there must be before we... */
67 uint8_t resv_blocks_write; /* ... allow a normal filesystem write */
68 uint8_t resv_blocks_deletion; /* ... allow a normal filesystem deletion */
69 uint8_t resv_blocks_gctrigger; /* ... wake up the GC thread */
70 uint8_t resv_blocks_gcbad; /* ... pick a block from the bad_list to GC */
71 uint8_t resv_blocks_gcmerge; /* ... merge pages when garbage collecting */
David Woodhouse8fb870df2007-10-06 15:12:58 -040072 /* Number of 'very dirty' blocks before we trigger immediate GC */
73 uint8_t vdirty_blocks_gctrigger;
Linus Torvalds1da177e2005-04-16 15:20:36 -070074
75 uint32_t nospc_dirty_size;
76
77 uint32_t nr_blocks;
Thomas Gleixner182ec4e2005-11-07 11:16:07 +000078 struct jffs2_eraseblock *blocks; /* The whole array of blocks. Used for getting blocks
Linus Torvalds1da177e2005-04-16 15:20:36 -070079 * from the offset (blocks[ofs / sector_size]) */
80 struct jffs2_eraseblock *nextblock; /* The block we're currently filling */
81
82 struct jffs2_eraseblock *gcblock; /* The block we're currently garbage-collecting */
83
84 struct list_head clean_list; /* Blocks 100% full of clean data */
85 struct list_head very_dirty_list; /* Blocks with lots of dirty space */
86 struct list_head dirty_list; /* Blocks with some dirty space */
87 struct list_head erasable_list; /* Blocks which are completely dirty, and need erasing */
88 struct list_head erasable_pending_wbuf_list; /* Blocks which need erasing but only after the current wbuf is flushed */
89 struct list_head erasing_list; /* Blocks which are currently erasing */
David Woodhousee2bc3222008-04-23 14:15:24 +010090 struct list_head erase_checking_list; /* Blocks which are being checked and marked */
Linus Torvalds1da177e2005-04-16 15:20:36 -070091 struct list_head erase_pending_list; /* Blocks which need erasing now */
92 struct list_head erase_complete_list; /* Blocks which are erased and need the clean marker written to them */
93 struct list_head free_list; /* Blocks which are free and ready to be used */
94 struct list_head bad_list; /* Bad blocks. */
95 struct list_head bad_used_list; /* Bad blocks with valid data in. */
96
Thomas Gleixner182ec4e2005-11-07 11:16:07 +000097 spinlock_t erase_completion_lock; /* Protect free_list and erasing_list
Linus Torvalds1da177e2005-04-16 15:20:36 -070098 against erase completion handler */
99 wait_queue_head_t erase_wait; /* For waiting for erases to complete */
100
101 wait_queue_head_t inocache_wq;
102 struct jffs2_inode_cache **inocache_list;
103 spinlock_t inocache_lock;
Thomas Gleixner182ec4e2005-11-07 11:16:07 +0000104
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105 /* Sem to allow jffs2_garbage_collect_deletion_dirent to
Thomas Gleixner182ec4e2005-11-07 11:16:07 +0000106 drop the erase_completion_lock while it's holding a pointer
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107 to an obsoleted node. I don't like this. Alternatives welcomed. */
David Woodhouseced22072008-04-22 15:13:40 +0100108 struct mutex erase_free_sem;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109
Artem B. Bityutskiy733802d2005-09-22 12:25:00 +0100110 uint32_t wbuf_pagesize; /* 0 for NOR and other flashes with no wbuf */
Thomas Gleixner182ec4e2005-11-07 11:16:07 +0000111
David Woodhousea6bc4322007-07-11 14:23:54 +0100112#ifdef CONFIG_JFFS2_FS_WBUF_VERIFY
113 unsigned char *wbuf_verify; /* read-back buffer for verification */
114#endif
Andrew Victor2f82ce12005-02-09 09:24:26 +0000115#ifdef CONFIG_JFFS2_FS_WRITEBUFFER
Artem Bityutskiya7a6ace12007-01-31 11:38:53 +0200116 unsigned char *wbuf; /* Write-behind buffer for NAND flash */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117 uint32_t wbuf_ofs;
118 uint32_t wbuf_len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119 struct jffs2_inodirty *wbuf_inodes;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120 struct rw_semaphore wbuf_sem; /* Protects the write buffer */
121
Artem Bityutskiya7a6ace12007-01-31 11:38:53 +0200122 unsigned char *oobbuf;
123 int oobavail; /* How many bytes are available for JFFS2 in OOB */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124#endif
125
Ferenc Havasie631ddb2005-09-07 09:35:26 +0100126 struct jffs2_summary *summary; /* Summary information */
127
KaiGai Koheiaa98d7c2006-05-13 15:09:47 +0900128#ifdef CONFIG_JFFS2_FS_XATTR
129#define XATTRINDEX_HASHSIZE (57)
130 uint32_t highest_xid;
KaiGai Koheic9f700f2006-06-11 10:35:15 +0900131 uint32_t highest_xseqno;
KaiGai Koheiaa98d7c2006-05-13 15:09:47 +0900132 struct list_head xattrindex[XATTRINDEX_HASHSIZE];
KaiGai Koheiaa98d7c2006-05-13 15:09:47 +0900133 struct list_head xattr_unchecked;
KaiGai Koheic9f700f2006-06-11 10:35:15 +0900134 struct list_head xattr_dead_list;
135 struct jffs2_xattr_ref *xref_dead_list;
KaiGai Kohei8f2b6f42006-05-13 15:15:07 +0900136 struct jffs2_xattr_ref *xref_temp;
KaiGai Koheiaa98d7c2006-05-13 15:09:47 +0900137 struct rw_semaphore xattr_sem;
138 uint32_t xdatum_mem_usage;
139 uint32_t xdatum_mem_threshold;
140#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141 /* OS-private pointer for getting back to master superblock info */
142 void *os_priv;
143};
144
145#endif /* _JFFS2_FB_SB */