1 /* 2 * JFFS2 -- Journalling Flash File System, Version 2. 3 * 4 * Copyright (C) 2001-2003 Red Hat, Inc. 5 * 6 * Created by David Woodhouse <[email protected]> 7 * 8 * For licensing information, see the file 'LICENCE' in this directory. 9 * 10 * $Id: nodelist.h,v 1.135 2005/07/27 14:46:11 dedekind Exp $ 11 * 12 */ 13 14 #ifndef __JFFS2_NODELIST_H__ 15 #define __JFFS2_NODELIST_H__ 16 17 #include "jffs2_config.h" 18 #include <linux/config.h> 19 #include <linux/fs.h> 20 #include <linux/types.h> 21 #include <linux/jffs2.h> 22 #include <linux/jffs2_fs_sb.h> 23 #include <linux/jffs2_fs_i.h> 24 25 #ifdef __ECOS 26 #include "os-ecos.h" 27 #elif defined(RT_THREAD) 28 #include "os-rtthread.h" 29 #else 30 #include <linux/mtd/compatmac.h> /* For compatibility with older kernels */ 31 #include "os-linux.h" 32 #endif 33 34 #define JFFS2_NATIVE_ENDIAN 35 36 /* Note we handle mode bits conversion from JFFS2 (i.e. Linux) to/from 37 whatever OS we're actually running on here too. */ 38 39 #if defined(JFFS2_NATIVE_ENDIAN) 40 #if defined (__GNUC__) 41 #define cpu_to_je16(x) ((jint16_t){x}) 42 #define cpu_to_je32(x) ((jint32_t){x}) 43 #define cpu_to_jemode(x) ((jmode_t){os_to_jffs2_mode(x)}) 44 45 #define je16_to_cpu(x) ((x).v16) 46 #define je32_to_cpu(x) ((x).v32) 47 #define jemode_to_cpu(x) (jffs2_to_os_mode((x).m)) 48 #elif defined (MSVC) 49 #define cpu_to_je16(x) ((jint16_t)(x)) 50 #define cpu_to_je32(x) ((jint32_t)(x)) 51 static __inline jmode_t cpu_to_jemode(x) 52 { 53 jmode_t _x; 54 _x.m = os_to_jffs2_mode(x); 55 return _x; 56 } 57 58 #define je16_to_cpu(x) (x) 59 #define je32_to_cpu(x) (x) 60 #define jemode_to_cpu(x) (jffs2_to_os_mode((x).m)) 61 #else 62 #endif 63 64 65 #elif defined(JFFS2_BIG_ENDIAN) 66 #define cpu_to_je16(x) ((jint16_t){cpu_to_be16(x)}) 67 #define cpu_to_je32(x) ((jint32_t){cpu_to_be32(x)}) 68 #define cpu_to_jemode(x) ((jmode_t){cpu_to_be32(os_to_jffs2_mode(x))}) 69 70 #define je16_to_cpu(x) (be16_to_cpu(x.v16)) 71 #define je32_to_cpu(x) (be32_to_cpu(x.v32)) 72 #define jemode_to_cpu(x) (be32_to_cpu(jffs2_to_os_mode((x).m))) 73 #elif defined(JFFS2_LITTLE_ENDIAN) 74 #define cpu_to_je16(x) ((jint16_t){cpu_to_le16(x)}) 75 #define cpu_to_je32(x) ((jint32_t){cpu_to_le32(x)}) 76 #define cpu_to_jemode(x) ((jmode_t){cpu_to_le32(os_to_jffs2_mode(x))}) 77 78 #define je16_to_cpu(x) (le16_to_cpu(x.v16)) 79 #define je32_to_cpu(x) (le32_to_cpu(x.v32)) 80 #define jemode_to_cpu(x) (le32_to_cpu(jffs2_to_os_mode((x).m))) 81 #else 82 #error wibble 83 #endif 84 85 /* 86 This is all we need to keep in-core for each raw node during normal 87 operation. As and when we do read_inode on a particular inode, we can 88 scan the nodes which are listed for it and build up a proper map of 89 which nodes are currently valid. JFFSv1 always used to keep that whole 90 map in core for each inode. 91 */ 92 struct jffs2_raw_node_ref 93 { 94 struct jffs2_raw_node_ref *next_in_ino; /* Points to the next raw_node_ref 95 for this inode. If this is the last, it points to the inode_cache 96 for this inode instead. The inode_cache will have NULL in the first 97 word so you know when you've got there :) */ 98 struct jffs2_raw_node_ref *next_phys; 99 uint32_t flash_offset; 100 uint32_t __totlen; /* This may die; use ref_totlen(c, jeb, ) below */ 101 }; 102 103 /* flash_offset & 3 always has to be zero, because nodes are 104 always aligned at 4 bytes. So we have a couple of extra bits 105 to play with, which indicate the node's status; see below: */ 106 #define REF_UNCHECKED 0 /* We haven't yet checked the CRC or built its inode */ 107 #define REF_OBSOLETE 1 /* Obsolete, can be completely ignored */ 108 #define REF_PRISTINE 2 /* Completely clean. GC without looking */ 109 #define REF_NORMAL 3 /* Possibly overlapped. Read the page and write again on GC */ 110 #define ref_flags(ref) ((ref)->flash_offset & 3) 111 #define ref_offset(ref) ((ref)->flash_offset & ~3) 112 #define ref_obsolete(ref) (((ref)->flash_offset & 3) == REF_OBSOLETE) 113 #define mark_ref_normal(ref) do { (ref)->flash_offset = ref_offset(ref) | REF_NORMAL; } while(0) 114 115 /* For each inode in the filesystem, we need to keep a record of 116 nlink, because it would be a PITA to scan the whole directory tree 117 at read_inode() time to calculate it, and to keep sufficient information 118 in the raw_node_ref (basically both parent and child inode number for 119 dirent nodes) would take more space than this does. We also keep 120 a pointer to the first physical node which is part of this inode, too. 121 */ 122 struct jffs2_inode_cache { 123 struct jffs2_full_dirent *scan_dents; /* Used during scan to hold 124 temporary lists of dirents, and later must be set to 125 NULL to mark the end of the raw_node_ref->next_in_ino 126 chain. */ 127 struct jffs2_inode_cache *next; 128 struct jffs2_raw_node_ref *nodes; 129 uint32_t ino; 130 int nlink; 131 int state; 132 }; 133 134 /* Inode states for 'state' above. We need the 'GC' state to prevent 135 someone from doing a read_inode() while we're moving a 'REF_PRISTINE' 136 node without going through all the iget() nonsense */ 137 #define INO_STATE_UNCHECKED 0 /* CRC checks not yet done */ 138 #define INO_STATE_CHECKING 1 /* CRC checks in progress */ 139 #define INO_STATE_PRESENT 2 /* In core */ 140 #define INO_STATE_CHECKEDABSENT 3 /* Checked, cleared again */ 141 #define INO_STATE_GC 4 /* GCing a 'pristine' node */ 142 #define INO_STATE_READING 5 /* In read_inode() */ 143 #define INO_STATE_CLEARING 6 /* In clear_inode() */ 144 145 #define INOCACHE_HASHSIZE 128 146 147 /* 148 Larger representation of a raw node, kept in-core only when the 149 struct inode for this particular ino is instantiated. 150 */ 151 152 struct jffs2_full_dnode 153 { 154 struct jffs2_raw_node_ref *raw; 155 uint32_t ofs; /* The offset to which the data of this node belongs */ 156 uint32_t size; 157 uint32_t frags; /* Number of fragments which currently refer 158 to this node. When this reaches zero, 159 the node is obsolete. */ 160 }; 161 162 /* 163 Even larger representation of a raw node, kept in-core only while 164 we're actually building up the original map of which nodes go where, 165 in read_inode() 166 */ 167 struct jffs2_tmp_dnode_info 168 { 169 struct rb_node rb; 170 struct jffs2_full_dnode *fn; 171 uint32_t version; 172 }; 173 174 struct jffs2_full_dirent 175 { 176 struct jffs2_raw_node_ref *raw; 177 struct jffs2_full_dirent *next; 178 uint32_t version; 179 uint32_t ino; /* == zero for unlink */ 180 unsigned int nhash; 181 unsigned char type; 182 unsigned char name[0]; 183 }; 184 185 /* 186 Fragments - used to build a map of which raw node to obtain 187 data from for each part of the ino 188 */ 189 struct jffs2_node_frag 190 { 191 struct rb_node rb; 192 struct jffs2_full_dnode *node; /* NULL for holes */ 193 uint32_t size; 194 uint32_t ofs; /* The offset to which this fragment belongs */ 195 }; 196 197 struct jffs2_eraseblock 198 { 199 struct list_head list; 200 int bad_count; 201 uint32_t offset; /* of this block in the MTD */ 202 203 uint32_t unchecked_size; 204 uint32_t used_size; 205 uint32_t dirty_size; 206 uint32_t wasted_size; 207 uint32_t free_size; /* Note that sector_size - free_size 208 is the address of the first free space */ 209 struct jffs2_raw_node_ref *first_node; 210 struct jffs2_raw_node_ref *last_node; 211 212 struct jffs2_raw_node_ref *gc_node; /* Next node to be garbage collected */ 213 }; 214 215 /* Calculate totlen from surrounding nodes or eraseblock */ 216 static inline uint32_t __ref_totlen(struct jffs2_sb_info *c, 217 struct jffs2_eraseblock *jeb, 218 struct jffs2_raw_node_ref *ref) 219 { 220 uint32_t ref_end; 221 222 if (ref->next_phys) 223 ref_end = ref_offset(ref->next_phys); 224 else { 225 if (!jeb) 226 jeb = &c->blocks[ref->flash_offset / c->sector_size]; 227 228 /* Last node in block. Use free_space */ 229 BUG_ON(ref != jeb->last_node); 230 ref_end = jeb->offset + c->sector_size - jeb->free_size; 231 } 232 return ref_end - ref_offset(ref); 233 } 234 235 static inline uint32_t ref_totlen(struct jffs2_sb_info *c, 236 struct jffs2_eraseblock *jeb, 237 struct jffs2_raw_node_ref *ref) 238 { 239 uint32_t ret; 240 241 #if CONFIG_JFFS2_FS_DEBUG > 0 242 if (jeb && jeb != &c->blocks[ref->flash_offset / c->sector_size]) { 243 printk(KERN_CRIT "ref_totlen called with wrong block -- at 0x%08x instead of 0x%08x; ref 0x%08x\n", 244 jeb->offset, c->blocks[ref->flash_offset / c->sector_size].offset, ref_offset(ref)); 245 BUG(); 246 } 247 #endif 248 249 #if 1 250 ret = ref->__totlen; 251 #else 252 /* This doesn't actually work yet */ 253 ret = __ref_totlen(c, jeb, ref); 254 if (ret != ref->__totlen) { 255 printk(KERN_CRIT "Totlen for ref at %p (0x%08x-0x%08x) miscalculated as 0x%x instead of %x\n", 256 ref, ref_offset(ref), ref_offset(ref)+ref->__totlen, 257 ret, ref->__totlen); 258 if (!jeb) 259 jeb = &c->blocks[ref->flash_offset / c->sector_size]; 260 jffs2_dbg_dump_node_refs_nolock(c, jeb); 261 BUG(); 262 } 263 #endif 264 return ret; 265 } 266 267 #define ALLOC_NORMAL 0 /* Normal allocation */ 268 #define ALLOC_DELETION 1 /* Deletion node. Best to allow it */ 269 #define ALLOC_GC 2 /* Space requested for GC. Give it or die */ 270 #define ALLOC_NORETRY 3 /* For jffs2_write_dnode: On failure, return -EAGAIN instead of retrying */ 271 272 /* How much dirty space before it goes on the very_dirty_list */ 273 #define VERYDIRTY(c, size) ((size) >= ((c)->sector_size / 2)) 274 275 /* check if dirty space is more than 255 Byte */ 276 #define ISDIRTY(size) ((size) > sizeof (struct jffs2_raw_inode) + JFFS2_MIN_DATA_LEN) 277 278 #define PAD(x) (((x)+3)&~3) 279 280 static inline struct jffs2_inode_cache *jffs2_raw_ref_to_ic(struct jffs2_raw_node_ref *raw) 281 { 282 while(raw->next_in_ino) { 283 raw = raw->next_in_ino; 284 } 285 286 return ((struct jffs2_inode_cache *)raw); 287 } 288 289 static inline struct jffs2_node_frag *frag_first(struct rb_root *root) 290 { 291 struct rb_node *node = root->rb_node; 292 293 if (!node) 294 return NULL; 295 while(node->rb_left) 296 node = node->rb_left; 297 return rb_entry(node, struct jffs2_node_frag, rb); 298 } 299 300 static inline struct jffs2_node_frag *frag_last(struct rb_root *root) 301 { 302 struct rb_node *node = root->rb_node; 303 304 if (!node) 305 return NULL; 306 while(node->rb_right) 307 node = node->rb_right; 308 return rb_entry(node, struct jffs2_node_frag, rb); 309 } 310 311 #define rb_parent(rb) ((rb)->rb_parent) 312 #define frag_next(frag) rb_entry(rb_next(&(frag)->rb), struct jffs2_node_frag, rb) 313 #define frag_prev(frag) rb_entry(rb_prev(&(frag)->rb), struct jffs2_node_frag, rb) 314 #define frag_parent(frag) rb_entry(rb_parent(&(frag)->rb), struct jffs2_node_frag, rb) 315 #define frag_left(frag) rb_entry((frag)->rb.rb_left, struct jffs2_node_frag, rb) 316 #define frag_right(frag) rb_entry((frag)->rb.rb_right, struct jffs2_node_frag, rb) 317 #define frag_erase(frag, list) rb_erase(&frag->rb, list); 318 319 /* nodelist.c */ 320 void jffs2_add_fd_to_list(struct jffs2_sb_info *c, struct jffs2_full_dirent *new, struct jffs2_full_dirent **list); 321 void jffs2_set_inocache_state(struct jffs2_sb_info *c, struct jffs2_inode_cache *ic, int state); 322 struct jffs2_inode_cache *jffs2_get_ino_cache(struct jffs2_sb_info *c, uint32_t ino); 323 void jffs2_add_ino_cache (struct jffs2_sb_info *c, struct jffs2_inode_cache *new); 324 void jffs2_del_ino_cache(struct jffs2_sb_info *c, struct jffs2_inode_cache *old); 325 void jffs2_free_ino_caches(struct jffs2_sb_info *c); 326 void jffs2_free_raw_node_refs(struct jffs2_sb_info *c); 327 struct jffs2_node_frag *jffs2_lookup_node_frag(struct rb_root *fragtree, uint32_t offset); 328 void jffs2_kill_fragtree(struct rb_root *root, struct jffs2_sb_info *c_delete); 329 struct rb_node *rb_next(struct rb_node *); 330 struct rb_node *rb_prev(struct rb_node *); 331 void rb_replace_node(struct rb_node *victim, struct rb_node *new, struct rb_root *root); 332 void jffs2_obsolete_node_frag(struct jffs2_sb_info *c, struct jffs2_node_frag *this); 333 int jffs2_add_full_dnode_to_inode(struct jffs2_sb_info *c, struct jffs2_inode_info *f, struct jffs2_full_dnode *fn); 334 335 /* nodemgmt.c */ 336 int jffs2_thread_should_wake(struct jffs2_sb_info *c); 337 int jffs2_reserve_space(struct jffs2_sb_info *c, uint32_t minsize, uint32_t *ofs, uint32_t *len, int prio); 338 int jffs2_reserve_space_gc(struct jffs2_sb_info *c, uint32_t minsize, uint32_t *ofs, uint32_t *len); 339 int jffs2_add_physical_node_ref(struct jffs2_sb_info *c, struct jffs2_raw_node_ref *new); 340 void jffs2_complete_reservation(struct jffs2_sb_info *c); 341 void jffs2_mark_node_obsolete(struct jffs2_sb_info *c, struct jffs2_raw_node_ref *raw); 342 343 /* write.c */ 344 int jffs2_do_new_inode(struct jffs2_sb_info *c, struct jffs2_inode_info *f, uint32_t mode, struct jffs2_raw_inode *ri); 345 346 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); 347 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); 348 int jffs2_write_inode_range(struct jffs2_sb_info *c, struct jffs2_inode_info *f, 349 struct jffs2_raw_inode *ri, unsigned char *buf, 350 uint32_t offset, uint32_t writelen, uint32_t *retlen); 351 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); 352 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); 353 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); 354 355 356 /* readinode.c */ 357 void jffs2_truncate_fragtree (struct jffs2_sb_info *c, struct rb_root *list, uint32_t size); 358 int jffs2_do_read_inode(struct jffs2_sb_info *c, struct jffs2_inode_info *f, 359 uint32_t ino, struct jffs2_raw_inode *latest_node); 360 int jffs2_do_crccheck_inode(struct jffs2_sb_info *c, struct jffs2_inode_cache *ic); 361 void jffs2_do_clear_inode(struct jffs2_sb_info *c, struct jffs2_inode_info *f); 362 363 /* malloc.c */ 364 int jffs2_create_slab_caches(void); 365 void jffs2_destroy_slab_caches(void); 366 367 struct jffs2_full_dirent *jffs2_alloc_full_dirent(int namesize); 368 void jffs2_free_full_dirent(struct jffs2_full_dirent *); 369 struct jffs2_full_dnode *jffs2_alloc_full_dnode(void); 370 void jffs2_free_full_dnode(struct jffs2_full_dnode *); 371 struct jffs2_raw_dirent *jffs2_alloc_raw_dirent(void); 372 void jffs2_free_raw_dirent(struct jffs2_raw_dirent *); 373 struct jffs2_raw_inode *jffs2_alloc_raw_inode(void); 374 void jffs2_free_raw_inode(struct jffs2_raw_inode *); 375 struct jffs2_tmp_dnode_info *jffs2_alloc_tmp_dnode_info(void); 376 void jffs2_free_tmp_dnode_info(struct jffs2_tmp_dnode_info *); 377 struct jffs2_raw_node_ref *jffs2_alloc_raw_node_ref(void); 378 void jffs2_free_raw_node_ref(struct jffs2_raw_node_ref *); 379 struct jffs2_node_frag *jffs2_alloc_node_frag(void); 380 void jffs2_free_node_frag(struct jffs2_node_frag *); 381 struct jffs2_inode_cache *jffs2_alloc_inode_cache(void); 382 void jffs2_free_inode_cache(struct jffs2_inode_cache *); 383 384 /* gc.c */ 385 int jffs2_garbage_collect_pass(struct jffs2_sb_info *c); 386 387 /* read.c */ 388 int jffs2_read_dnode(struct jffs2_sb_info *c, struct jffs2_inode_info *f, 389 struct jffs2_full_dnode *fd, unsigned char *buf, 390 int ofs, int len); 391 int jffs2_read_inode_range(struct jffs2_sb_info *c, struct jffs2_inode_info *f, 392 unsigned char *buf, uint32_t offset, uint32_t len); 393 char *jffs2_getlink(struct jffs2_sb_info *c, struct jffs2_inode_info *f); 394 395 /* scan.c */ 396 int jffs2_scan_medium(struct jffs2_sb_info *c); 397 void jffs2_rotate_lists(struct jffs2_sb_info *c); 398 399 /* build.c */ 400 int jffs2_do_mount_fs(struct jffs2_sb_info *c); 401 402 /* erase.c */ 403 void jffs2_erase_pending_blocks(struct jffs2_sb_info *c, int count); 404 405 #ifdef CONFIG_JFFS2_FS_WRITEBUFFER 406 /* wbuf.c */ 407 int jffs2_flush_wbuf_gc(struct jffs2_sb_info *c, uint32_t ino); 408 int jffs2_flush_wbuf_pad(struct jffs2_sb_info *c); 409 int jffs2_check_nand_cleanmarker(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb); 410 int jffs2_write_nand_cleanmarker(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb); 411 #endif 412 413 #include "debug.h" 414 415 #endif /* __JFFS2_NODELIST_H__ */ 416