2 * JFFS2 -- Journalling Flash File System, Version 2.
4 * Copyright (C) 2001-2003 Red Hat, Inc.
6 * Created by David Woodhouse <dwmw2@infradead.org>
8 * For licensing information, see the file 'LICENCE' in this directory.
10 * $Id: nodelist.h,v 1.135 2005/07/27 14:46:11 dedekind Exp $
14 #ifndef __JFFS2_NODELIST_H__
15 #define __JFFS2_NODELIST_H__
17 #include <linux/config.h>
19 #include <linux/types.h>
20 #include <linux/jffs2.h>
21 #include <linux/jffs2_fs_sb.h>
22 #include <linux/jffs2_fs_i.h>
27 #include <linux/mtd/compatmac.h> /* For compatibility with older kernels */
31 #define JFFS2_NATIVE_ENDIAN
33 /* Note we handle mode bits conversion from JFFS2 (i.e. Linux) to/from
34 whatever OS we're actually running on here too. */
36 #if defined(JFFS2_NATIVE_ENDIAN)
37 #define cpu_to_je16(x) ((jint16_t){x})
38 #define cpu_to_je32(x) ((jint32_t){x})
39 #define cpu_to_jemode(x) ((jmode_t){os_to_jffs2_mode(x)})
41 #define je16_to_cpu(x) ((x).v16)
42 #define je32_to_cpu(x) ((x).v32)
43 #define jemode_to_cpu(x) (jffs2_to_os_mode((x).m))
44 #elif defined(JFFS2_BIG_ENDIAN)
45 #define cpu_to_je16(x) ((jint16_t){cpu_to_be16(x)})
46 #define cpu_to_je32(x) ((jint32_t){cpu_to_be32(x)})
47 #define cpu_to_jemode(x) ((jmode_t){cpu_to_be32(os_to_jffs2_mode(x))})
49 #define je16_to_cpu(x) (be16_to_cpu(x.v16))
50 #define je32_to_cpu(x) (be32_to_cpu(x.v32))
51 #define jemode_to_cpu(x) (be32_to_cpu(jffs2_to_os_mode((x).m)))
52 #elif defined(JFFS2_LITTLE_ENDIAN)
53 #define cpu_to_je16(x) ((jint16_t){cpu_to_le16(x)})
54 #define cpu_to_je32(x) ((jint32_t){cpu_to_le32(x)})
55 #define cpu_to_jemode(x) ((jmode_t){cpu_to_le32(os_to_jffs2_mode(x))})
57 #define je16_to_cpu(x) (le16_to_cpu(x.v16))
58 #define je32_to_cpu(x) (le32_to_cpu(x.v32))
59 #define jemode_to_cpu(x) (le32_to_cpu(jffs2_to_os_mode((x).m)))
65 This is all we need to keep in-core for each raw node during normal
66 operation. As and when we do read_inode on a particular inode, we can
67 scan the nodes which are listed for it and build up a proper map of
68 which nodes are currently valid. JFFSv1 always used to keep that whole
69 map in core for each inode.
71 struct jffs2_raw_node_ref
73 struct jffs2_raw_node_ref *next_in_ino; /* Points to the next raw_node_ref
74 for this inode. If this is the last, it points to the inode_cache
75 for this inode instead. The inode_cache will have NULL in the first
76 word so you know when you've got there :) */
77 struct jffs2_raw_node_ref *next_phys;
78 uint32_t flash_offset;
79 uint32_t __totlen; /* This may die; use ref_totlen(c, jeb, ) below */
82 /* flash_offset & 3 always has to be zero, because nodes are
83 always aligned at 4 bytes. So we have a couple of extra bits
84 to play with, which indicate the node's status; see below: */
85 #define REF_UNCHECKED 0 /* We haven't yet checked the CRC or built its inode */
86 #define REF_OBSOLETE 1 /* Obsolete, can be completely ignored */
87 #define REF_PRISTINE 2 /* Completely clean. GC without looking */
88 #define REF_NORMAL 3 /* Possibly overlapped. Read the page and write again on GC */
89 #define ref_flags(ref) ((ref)->flash_offset & 3)
90 #define ref_offset(ref) ((ref)->flash_offset & ~3)
91 #define ref_obsolete(ref) (((ref)->flash_offset & 3) == REF_OBSOLETE)
92 #define mark_ref_normal(ref) do { (ref)->flash_offset = ref_offset(ref) | REF_NORMAL; } while(0)
94 /* For each inode in the filesystem, we need to keep a record of
95 nlink, because it would be a PITA to scan the whole directory tree
96 at read_inode() time to calculate it, and to keep sufficient information
97 in the raw_node_ref (basically both parent and child inode number for
98 dirent nodes) would take more space than this does. We also keep
99 a pointer to the first physical node which is part of this inode, too.
101 struct jffs2_inode_cache {
102 struct jffs2_full_dirent *scan_dents; /* Used during scan to hold
103 temporary lists of dirents, and later must be set to
104 NULL to mark the end of the raw_node_ref->next_in_ino
106 struct jffs2_inode_cache *next;
107 struct jffs2_raw_node_ref *nodes;
113 /* Inode states for 'state' above. We need the 'GC' state to prevent
114 someone from doing a read_inode() while we're moving a 'REF_PRISTINE'
115 node without going through all the iget() nonsense */
116 #define INO_STATE_UNCHECKED 0 /* CRC checks not yet done */
117 #define INO_STATE_CHECKING 1 /* CRC checks in progress */
118 #define INO_STATE_PRESENT 2 /* In core */
119 #define INO_STATE_CHECKEDABSENT 3 /* Checked, cleared again */
120 #define INO_STATE_GC 4 /* GCing a 'pristine' node */
121 #define INO_STATE_READING 5 /* In read_inode() */
122 #define INO_STATE_CLEARING 6 /* In clear_inode() */
124 #define INOCACHE_HASHSIZE 128
127 Larger representation of a raw node, kept in-core only when the
128 struct inode for this particular ino is instantiated.
131 struct jffs2_full_dnode
133 struct jffs2_raw_node_ref *raw;
134 uint32_t ofs; /* The offset to which the data of this node belongs */
136 uint32_t frags; /* Number of fragments which currently refer
137 to this node. When this reaches zero,
138 the node is obsolete. */
142 Even larger representation of a raw node, kept in-core only while
143 we're actually building up the original map of which nodes go where,
146 struct jffs2_tmp_dnode_info
149 struct jffs2_full_dnode *fn;
153 struct jffs2_full_dirent
155 struct jffs2_raw_node_ref *raw;
156 struct jffs2_full_dirent *next;
158 uint32_t ino; /* == zero for unlink */
161 unsigned char name[0];
165 Fragments - used to build a map of which raw node to obtain
166 data from for each part of the ino
168 struct jffs2_node_frag
171 struct jffs2_full_dnode *node; /* NULL for holes */
173 uint32_t ofs; /* The offset to which this fragment belongs */
176 struct jffs2_eraseblock
178 struct list_head list;
180 uint32_t offset; /* of this block in the MTD */
182 uint32_t unchecked_size;
185 uint32_t wasted_size;
186 uint32_t free_size; /* Note that sector_size - free_size
187 is the address of the first free space */
188 struct jffs2_raw_node_ref *first_node;
189 struct jffs2_raw_node_ref *last_node;
191 struct jffs2_raw_node_ref *gc_node; /* Next node to be garbage collected */
194 /* Calculate totlen from surrounding nodes or eraseblock */
195 static inline uint32_t __ref_totlen(struct jffs2_sb_info *c,
196 struct jffs2_eraseblock *jeb,
197 struct jffs2_raw_node_ref *ref)
202 ref_end = ref_offset(ref->next_phys);
205 jeb = &c->blocks[ref->flash_offset / c->sector_size];
207 /* Last node in block. Use free_space */
208 BUG_ON(ref != jeb->last_node);
209 ref_end = jeb->offset + c->sector_size - jeb->free_size;
211 return ref_end - ref_offset(ref);
214 static inline uint32_t ref_totlen(struct jffs2_sb_info *c,
215 struct jffs2_eraseblock *jeb,
216 struct jffs2_raw_node_ref *ref)
220 #if CONFIG_JFFS2_FS_DEBUG > 0
221 if (jeb && jeb != &c->blocks[ref->flash_offset / c->sector_size]) {
222 printk(KERN_CRIT "ref_totlen called with wrong block -- at 0x%08x instead of 0x%08x; ref 0x%08x\n",
223 jeb->offset, c->blocks[ref->flash_offset / c->sector_size].offset, ref_offset(ref));
231 /* This doesn't actually work yet */
232 ret = __ref_totlen(c, jeb, ref);
233 if (ret != ref->__totlen) {
234 printk(KERN_CRIT "Totlen for ref at %p (0x%08x-0x%08x) miscalculated as 0x%x instead of %x\n",
235 ref, ref_offset(ref), ref_offset(ref)+ref->__totlen,
238 jeb = &c->blocks[ref->flash_offset / c->sector_size];
239 jffs2_dbg_dump_node_refs_nolock(c, jeb);
246 #define ALLOC_NORMAL 0 /* Normal allocation */
247 #define ALLOC_DELETION 1 /* Deletion node. Best to allow it */
248 #define ALLOC_GC 2 /* Space requested for GC. Give it or die */
249 #define ALLOC_NORETRY 3 /* For jffs2_write_dnode: On failure, return -EAGAIN instead of retrying */
251 /* How much dirty space before it goes on the very_dirty_list */
252 #define VERYDIRTY(c, size) ((size) >= ((c)->sector_size / 2))
254 /* check if dirty space is more than 255 Byte */
255 #define ISDIRTY(size) ((size) > sizeof (struct jffs2_raw_inode) + JFFS2_MIN_DATA_LEN)
257 #define PAD(x) (((x)+3)&~3)
259 static inline struct jffs2_inode_cache *jffs2_raw_ref_to_ic(struct jffs2_raw_node_ref *raw)
261 while(raw->next_in_ino) {
262 raw = raw->next_in_ino;
265 return ((struct jffs2_inode_cache *)raw);
268 static inline struct jffs2_node_frag *frag_first(struct rb_root *root)
270 struct rb_node *node = root->rb_node;
275 node = node->rb_left;
276 return rb_entry(node, struct jffs2_node_frag, rb);
279 static inline struct jffs2_node_frag *frag_last(struct rb_root *root)
281 struct rb_node *node = root->rb_node;
285 while(node->rb_right)
286 node = node->rb_right;
287 return rb_entry(node, struct jffs2_node_frag, rb);
290 #define rb_parent(rb) ((rb)->rb_parent)
291 #define frag_next(frag) rb_entry(rb_next(&(frag)->rb), struct jffs2_node_frag, rb)
292 #define frag_prev(frag) rb_entry(rb_prev(&(frag)->rb), struct jffs2_node_frag, rb)
293 #define frag_parent(frag) rb_entry(rb_parent(&(frag)->rb), struct jffs2_node_frag, rb)
294 #define frag_left(frag) rb_entry((frag)->rb.rb_left, struct jffs2_node_frag, rb)
295 #define frag_right(frag) rb_entry((frag)->rb.rb_right, struct jffs2_node_frag, rb)
296 #define frag_erase(frag, list) rb_erase(&frag->rb, list);
299 void jffs2_add_fd_to_list(struct jffs2_sb_info *c, struct jffs2_full_dirent *new, struct jffs2_full_dirent **list);
300 void jffs2_set_inocache_state(struct jffs2_sb_info *c, struct jffs2_inode_cache *ic, int state);
301 struct jffs2_inode_cache *jffs2_get_ino_cache(struct jffs2_sb_info *c, uint32_t ino);
302 void jffs2_add_ino_cache (struct jffs2_sb_info *c, struct jffs2_inode_cache *new);
303 void jffs2_del_ino_cache(struct jffs2_sb_info *c, struct jffs2_inode_cache *old);
304 void jffs2_free_ino_caches(struct jffs2_sb_info *c);
305 void jffs2_free_raw_node_refs(struct jffs2_sb_info *c);
306 struct jffs2_node_frag *jffs2_lookup_node_frag(struct rb_root *fragtree, uint32_t offset);
307 void jffs2_kill_fragtree(struct rb_root *root, struct jffs2_sb_info *c_delete);
308 struct rb_node *rb_next(struct rb_node *);
309 struct rb_node *rb_prev(struct rb_node *);
310 void rb_replace_node(struct rb_node *victim, struct rb_node *new, struct rb_root *root);
311 void jffs2_obsolete_node_frag(struct jffs2_sb_info *c, struct jffs2_node_frag *this);
312 int jffs2_add_full_dnode_to_inode(struct jffs2_sb_info *c, struct jffs2_inode_info *f, struct jffs2_full_dnode *fn);
315 int jffs2_thread_should_wake(struct jffs2_sb_info *c);
316 int jffs2_reserve_space(struct jffs2_sb_info *c, uint32_t minsize, uint32_t *ofs, uint32_t *len, int prio);
317 int jffs2_reserve_space_gc(struct jffs2_sb_info *c, uint32_t minsize, uint32_t *ofs, uint32_t *len);
318 int jffs2_add_physical_node_ref(struct jffs2_sb_info *c, struct jffs2_raw_node_ref *new);
319 void jffs2_complete_reservation(struct jffs2_sb_info *c);
320 void jffs2_mark_node_obsolete(struct jffs2_sb_info *c, struct jffs2_raw_node_ref *raw);
323 int jffs2_do_new_inode(struct jffs2_sb_info *c, struct jffs2_inode_info *f, uint32_t mode, struct jffs2_raw_inode *ri);
325 struct jffs2_full_dnode *jffs2_write_dnode(struct jffs2_sb_info *c, struct jffs2_inode_info *f, struct jffs2_raw_inode *ri, const unsigned char *data, uint32_t datalen, uint32_t flash_ofs, int alloc_mode);
326 struct jffs2_full_dirent *jffs2_write_dirent(struct jffs2_sb_info *c, struct jffs2_inode_info *f, struct jffs2_raw_dirent *rd, const unsigned char *name, uint32_t namelen, uint32_t flash_ofs, int alloc_mode);
327 int jffs2_write_inode_range(struct jffs2_sb_info *c, struct jffs2_inode_info *f,
328 struct jffs2_raw_inode *ri, unsigned char *buf,
329 uint32_t offset, uint32_t writelen, uint32_t *retlen);
330 int jffs2_do_create(struct jffs2_sb_info *c, struct jffs2_inode_info *dir_f, struct jffs2_inode_info *f, struct jffs2_raw_inode *ri, const char *name, int namelen);
331 int jffs2_do_unlink(struct jffs2_sb_info *c, struct jffs2_inode_info *dir_f, const char *name, int namelen, struct jffs2_inode_info *dead_f);
332 int jffs2_do_link (struct jffs2_sb_info *c, struct jffs2_inode_info *dir_f, uint32_t ino, uint8_t type, const char *name, int namelen);
336 void jffs2_truncate_fragtree (struct jffs2_sb_info *c, struct rb_root *list, uint32_t size);
337 int jffs2_do_read_inode(struct jffs2_sb_info *c, struct jffs2_inode_info *f,
338 uint32_t ino, struct jffs2_raw_inode *latest_node);
339 int jffs2_do_crccheck_inode(struct jffs2_sb_info *c, struct jffs2_inode_cache *ic);
340 void jffs2_do_clear_inode(struct jffs2_sb_info *c, struct jffs2_inode_info *f);
343 int jffs2_create_slab_caches(void);
344 void jffs2_destroy_slab_caches(void);
346 struct jffs2_full_dirent *jffs2_alloc_full_dirent(int namesize);
347 void jffs2_free_full_dirent(struct jffs2_full_dirent *);
348 struct jffs2_full_dnode *jffs2_alloc_full_dnode(void);
349 void jffs2_free_full_dnode(struct jffs2_full_dnode *);
350 struct jffs2_raw_dirent *jffs2_alloc_raw_dirent(void);
351 void jffs2_free_raw_dirent(struct jffs2_raw_dirent *);
352 struct jffs2_raw_inode *jffs2_alloc_raw_inode(void);
353 void jffs2_free_raw_inode(struct jffs2_raw_inode *);
354 struct jffs2_tmp_dnode_info *jffs2_alloc_tmp_dnode_info(void);
355 void jffs2_free_tmp_dnode_info(struct jffs2_tmp_dnode_info *);
356 struct jffs2_raw_node_ref *jffs2_alloc_raw_node_ref(void);
357 void jffs2_free_raw_node_ref(struct jffs2_raw_node_ref *);
358 struct jffs2_node_frag *jffs2_alloc_node_frag(void);
359 void jffs2_free_node_frag(struct jffs2_node_frag *);
360 struct jffs2_inode_cache *jffs2_alloc_inode_cache(void);
361 void jffs2_free_inode_cache(struct jffs2_inode_cache *);
364 int jffs2_garbage_collect_pass(struct jffs2_sb_info *c);
367 int jffs2_read_dnode(struct jffs2_sb_info *c, struct jffs2_inode_info *f,
368 struct jffs2_full_dnode *fd, unsigned char *buf,
370 int jffs2_read_inode_range(struct jffs2_sb_info *c, struct jffs2_inode_info *f,
371 unsigned char *buf, uint32_t offset, uint32_t len);
372 char *jffs2_getlink(struct jffs2_sb_info *c, struct jffs2_inode_info *f);
375 int jffs2_scan_medium(struct jffs2_sb_info *c);
376 void jffs2_rotate_lists(struct jffs2_sb_info *c);
379 int jffs2_do_mount_fs(struct jffs2_sb_info *c);
382 void jffs2_erase_pending_blocks(struct jffs2_sb_info *c, int count);
384 #ifdef CONFIG_JFFS2_FS_WRITEBUFFER
386 int jffs2_flush_wbuf_gc(struct jffs2_sb_info *c, uint32_t ino);
387 int jffs2_flush_wbuf_pad(struct jffs2_sb_info *c);
388 int jffs2_check_nand_cleanmarker(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb);
389 int jffs2_write_nand_cleanmarker(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb);
394 #endif /* __JFFS2_NODELIST_H__ */