[mirror_ubuntu-jammy-kernel.git] / fs / jffs2 / jffs2_fs_sb.h

/*
 * JFFS2 -- Journalling Flash File System, Version 2.
 *
 * Copyright © 2001-2007 Red Hat, Inc.
 * Copyright © 2004-2010 David Woodhouse <dwmw2@infradead.org>
 *
 * Created by David Woodhouse <dwmw2@infradead.org>
 *
 * For licensing information, see the file 'LICENCE' in this directory.
 *
 */

#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 <linux/mutex.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;

struct jffs2_mount_opts {
	bool override_compr;
	unsigned int compr;

	/* The size of the reserved pool. The reserved pool is the JFFS2 flash
	 * space which may only be used by root cannot be used by the other
	 * users. This is implemented simply by means of not allowing the
	 * latter users to write to the file system if the amount if the
	 * available space is less then 'rp_size'. */
	bool set_rp_size;
	unsigned int rp_size;
};

/* 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 check_ino;		/* *NEXT* inode to be checked */

	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 mutex 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 */
	/* Number of 'very dirty' blocks before we trigger immediate GC */
	uint8_t vdirty_blocks_gctrigger;

	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_checking_list;	/* Blocks which are being checked and marked */
	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;
	int inocache_hashsize;
	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 mutex erase_free_sem;

	uint32_t wbuf_pagesize; /* 0 for NOR and other flashes with no wbuf */

#ifdef CONFIG_JFFS2_FS_WBUF_VERIFY
	unsigned char *wbuf_verify; /* read-back buffer for verification */
#endif
#ifdef CONFIG_JFFS2_FS_WRITEBUFFER
	unsigned char *wbuf; /* Write-behind buffer for NAND flash */
	uint32_t wbuf_ofs;
	uint32_t wbuf_len;
	struct jffs2_inodirty *wbuf_inodes;
	struct rw_semaphore wbuf_sem;	/* Protects the write buffer */

	struct delayed_work wbuf_dwork; /* write-buffer write-out work */

	unsigned char *oobbuf;
	int oobavail; /* How many bytes are available for JFFS2 in OOB */
#endif

	struct jffs2_summary *summary;		/* Summary information */
	struct jffs2_mount_opts mount_opts;

#ifdef CONFIG_JFFS2_FS_XATTR
#define XATTRINDEX_HASHSIZE	(57)
	uint32_t highest_xid;
	uint32_t highest_xseqno;
	struct list_head xattrindex[XATTRINDEX_HASHSIZE];
	struct list_head xattr_unchecked;
	struct list_head xattr_dead_list;
	struct jffs2_xattr_ref *xref_dead_list;
	struct jffs2_xattr_ref *xref_temp;
	struct rw_semaphore xattr_sem;
	uint32_t xdatum_mem_usage;
	uint32_t xdatum_mem_threshold;
#endif
	/* OS-private pointer for getting back to master superblock info */
	void *os_priv;
};

#endif /* _JFFS2_FS_SB */
Commit	Line	Data
c00c310e DW	1	/*
	2	* JFFS2 -- Journalling Flash File System, Version 2.
	3	*
	4	* Copyright © 2001-2007 Red Hat, Inc.
6088c058	5	* Copyright © 2004-2010 David Woodhouse <dwmw2@infradead.org>
c00c310e DW	6	*
	7	* Created by David Woodhouse <dwmw2@infradead.org>
	8	*
	9	* For licensing information, see the file 'LICENCE' in this directory.
	10	*
	11	*/
1da177e4 LT	12
	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>
ced22070	20	#include <linux/mutex.h>
1da177e4 LT	21	#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
31fbdf7a AB	27	#define JFFS2_SB_FLAG_SCANNING 2 /* Flash scanning is in progress */
31fbdf7a AB	28	#define JFFS2_SB_FLAG_BUILDING 4 /* File system building is in progress */
1da177e4 LT	29
	30	struct jffs2_inodirty;
	31
92abc475 AS	32	struct jffs2_mount_opts {
	33	bool override_compr;
	34	unsigned int compr;
8da8ba2e DD	35
	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'. */
cd3ed3c7	41	bool set_rp_size;
8da8ba2e	42	unsigned int rp_size;
92abc475 AS	43	};
92abc475 AS	44
1da177e4	45	/* A struct for the overall file system control. Pointers to
182ec4ee	46	jffs2_sb_info structs are named `c' in the source code.
1da177e4 LT	47	Nee jffs_control
	48	*/
	49	struct jffs2_sb_info {
	50	struct mtd_info *mtd;
	51
	52	uint32_t highest_ino;
5817b9dc	53	uint32_t check_ino; /* NEXT inode to be checked */
1da177e4 LT	54
	55	unsigned int flags;
	56
	57	struct task_struct gc_task; / GC task struct */
fff7afd7	58	struct completion gc_thread_start; /* GC thread start completion */
1da177e4 LT	59	struct completion gc_thread_exit; /* GC thread exit completion port */
1da177e4 LT	60
ced22070	61	struct mutex alloc_sem; /* Used to protect all the following
1da177e4 LT	62	fields, and also to protect against
	63	out-of-order writing of nodes. And GC. */
	64	uint32_t cleanmarker_size; /* Size of an _inline_ CLEANMARKER
	65	(i.e. zero for OOB CLEANMARKER */
	66
	67	uint32_t flash_size;
	68	uint32_t used_size;
	69	uint32_t dirty_size;
	70	uint32_t wasted_size;
	71	uint32_t free_size;
	72	uint32_t erasing_size;
	73	uint32_t bad_size;
	74	uint32_t sector_size;
	75	uint32_t unchecked_size;
	76
	77	uint32_t nr_free_blocks;
	78	uint32_t nr_erasing_blocks;
	79
	80	/* Number of free blocks there must be before we... */
	81	uint8_t resv_blocks_write; /* ... allow a normal filesystem write */
	82	uint8_t resv_blocks_deletion; /* ... allow a normal filesystem deletion */
	83	uint8_t resv_blocks_gctrigger; /* ... wake up the GC thread */
	84	uint8_t resv_blocks_gcbad; /* ... pick a block from the bad_list to GC */
	85	uint8_t resv_blocks_gcmerge; /* ... merge pages when garbage collecting */
8fb870df DW	86	/* Number of 'very dirty' blocks before we trigger immediate GC */
8fb870df DW	87	uint8_t vdirty_blocks_gctrigger;
1da177e4 LT	88
	89	uint32_t nospc_dirty_size;
	90
	91	uint32_t nr_blocks;
182ec4ee	92	struct jffs2_eraseblock blocks; / The whole array of blocks. Used for getting blocks
1da177e4 LT	93	* from the offset (blocks[ofs / sector_size]) */
	94	struct jffs2_eraseblock nextblock; / The block we're currently filling */
	95
	96	struct jffs2_eraseblock gcblock; / The block we're currently garbage-collecting */
	97
	98	struct list_head clean_list; /* Blocks 100% full of clean data */
	99	struct list_head very_dirty_list; /* Blocks with lots of dirty space */
	100	struct list_head dirty_list; /* Blocks with some dirty space */
	101	struct list_head erasable_list; /* Blocks which are completely dirty, and need erasing */
	102	struct list_head erasable_pending_wbuf_list; /* Blocks which need erasing but only after the current wbuf is flushed */
	103	struct list_head erasing_list; /* Blocks which are currently erasing */
e2bc322b	104	struct list_head erase_checking_list; /* Blocks which are being checked and marked */
1da177e4 LT	105	struct list_head erase_pending_list; /* Blocks which need erasing now */
	106	struct list_head erase_complete_list; /* Blocks which are erased and need the clean marker written to them */
	107	struct list_head free_list; /* Blocks which are free and ready to be used */
	108	struct list_head bad_list; /* Bad blocks. */
	109	struct list_head bad_used_list; /* Bad blocks with valid data in. */
	110
182ec4ee	111	spinlock_t erase_completion_lock; /* Protect free_list and erasing_list
1da177e4 LT	112	against erase completion handler */
	113	wait_queue_head_t erase_wait; /* For waiting for erases to complete */
	114
	115	wait_queue_head_t inocache_wq;
65e5a0e1	116	int inocache_hashsize;
1da177e4 LT	117	struct jffs2_inode_cache **inocache_list;
1da177e4 LT	118	spinlock_t inocache_lock;
182ec4ee	119
1da177e4	120	/* Sem to allow jffs2_garbage_collect_deletion_dirent to
182ec4ee	121	drop the erase_completion_lock while it's holding a pointer
1da177e4	122	to an obsoleted node. I don't like this. Alternatives welcomed. */
ced22070	123	struct mutex erase_free_sem;
1da177e4	124
733802d9	125	uint32_t wbuf_pagesize; /* 0 for NOR and other flashes with no wbuf */
182ec4ee	126
a6bc432e DW	127	#ifdef CONFIG_JFFS2_FS_WBUF_VERIFY
	128	unsigned char wbuf_verify; / read-back buffer for verification */
	129	#endif
2f82ce1e	130	#ifdef CONFIG_JFFS2_FS_WRITEBUFFER
a7a6ace1	131	unsigned char wbuf; / Write-behind buffer for NAND flash */
1da177e4 LT	132	uint32_t wbuf_ofs;
1da177e4 LT	133	uint32_t wbuf_len;
1da177e4	134	struct jffs2_inodirty *wbuf_inodes;
1da177e4 LT	135	struct rw_semaphore wbuf_sem; /* Protects the write buffer */
1da177e4 LT	136
208b14e5	137	struct delayed_work wbuf_dwork; /* write-buffer write-out work */
208b14e5	138
a7a6ace1 AB	139	unsigned char *oobbuf;
a7a6ace1 AB	140	int oobavail; /* How many bytes are available for JFFS2 in OOB */
1da177e4 LT	141	#endif
1da177e4 LT	142
e631ddba	143	struct jffs2_summary summary; / Summary information */
92abc475	144	struct jffs2_mount_opts mount_opts;
e631ddba	145
aa98d7cf KK	146	#ifdef CONFIG_JFFS2_FS_XATTR
	147	#define XATTRINDEX_HASHSIZE (57)
	148	uint32_t highest_xid;
c9f700f8	149	uint32_t highest_xseqno;
aa98d7cf	150	struct list_head xattrindex[XATTRINDEX_HASHSIZE];
aa98d7cf	151	struct list_head xattr_unchecked;
c9f700f8 KK	152	struct list_head xattr_dead_list;
c9f700f8 KK	153	struct jffs2_xattr_ref *xref_dead_list;
8f2b6f49	154	struct jffs2_xattr_ref *xref_temp;
aa98d7cf KK	155	struct rw_semaphore xattr_sem;
	156	uint32_t xdatum_mem_usage;
	157	uint32_t xdatum_mem_threshold;
	158	#endif
1da177e4 LT	159	/* OS-private pointer for getting back to master superblock info */
	160	void *os_priv;
	161	};
	162
027d9ac2	163	#endif /* _JFFS2_FS_SB */