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