1 /* 2 * JFFS2 -- Journalling Flash File System, Version 2. 3 * 4 * Copyright (C) 2001-2003 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 * $Id: nodelist.h,v 1.140 2005/09/07 08:34:54 havasi Exp $ 11 * 12 */ 13 14 #ifndef __JFFS2_NODELIST_H__ 15 #define __JFFS2_NODELIST_H__ 16 17 #include <linux/fs.h> 18 #include <linux/types.h> 19 #include <linux/jffs2.h> 20 #include "jffs2_fs_sb.h" 21 #include "jffs2_fs_i.h" 22 #include "xattr.h" 23 #include "acl.h" 24 #include "summary.h" 25 26 #ifdef __ECOS 27 #include "os-ecos.h" 28 #else 29 #include <linux/mtd/compatmac.h> /* For compatibility with older kernels */ 30 #include "os-linux.h" 31 #endif 32 33 #define JFFS2_NATIVE_ENDIAN 34 35 /* Note we handle mode bits conversion from JFFS2 (i.e. Linux) to/from 36 whatever OS we're actually running on here too. */ 37 38 #if defined(JFFS2_NATIVE_ENDIAN) 39 #define cpu_to_je16(x) ((jint16_t){x}) 40 #define cpu_to_je32(x) ((jint32_t){x}) 41 #define cpu_to_jemode(x) ((jmode_t){os_to_jffs2_mode(x)}) 42 43 #define constant_cpu_to_je16(x) ((jint16_t){x}) 44 #define constant_cpu_to_je32(x) ((jint32_t){x}) 45 46 #define je16_to_cpu(x) ((x).v16) 47 #define je32_to_cpu(x) ((x).v32) 48 #define jemode_to_cpu(x) (jffs2_to_os_mode((x).m)) 49 #elif defined(JFFS2_BIG_ENDIAN) 50 #define cpu_to_je16(x) ((jint16_t){cpu_to_be16(x)}) 51 #define cpu_to_je32(x) ((jint32_t){cpu_to_be32(x)}) 52 #define cpu_to_jemode(x) ((jmode_t){cpu_to_be32(os_to_jffs2_mode(x))}) 53 54 #define constant_cpu_to_je16(x) ((jint16_t){__constant_cpu_to_be16(x)}) 55 #define constant_cpu_to_je32(x) ((jint32_t){__constant_cpu_to_be32(x)}) 56 57 #define je16_to_cpu(x) (be16_to_cpu(x.v16)) 58 #define je32_to_cpu(x) (be32_to_cpu(x.v32)) 59 #define jemode_to_cpu(x) (be32_to_cpu(jffs2_to_os_mode((x).m))) 60 #elif defined(JFFS2_LITTLE_ENDIAN) 61 #define cpu_to_je16(x) ((jint16_t){cpu_to_le16(x)}) 62 #define cpu_to_je32(x) ((jint32_t){cpu_to_le32(x)}) 63 #define cpu_to_jemode(x) ((jmode_t){cpu_to_le32(os_to_jffs2_mode(x))}) 64 65 #define constant_cpu_to_je16(x) ((jint16_t){__constant_cpu_to_le16(x)}) 66 #define constant_cpu_to_je32(x) ((jint32_t){__constant_cpu_to_le32(x)}) 67 68 #define je16_to_cpu(x) (le16_to_cpu(x.v16)) 69 #define je32_to_cpu(x) (le32_to_cpu(x.v32)) 70 #define jemode_to_cpu(x) (le32_to_cpu(jffs2_to_os_mode((x).m))) 71 #else 72 #error wibble 73 #endif 74 75 /* The minimal node header size */ 76 #define JFFS2_MIN_NODE_HEADER sizeof(struct jffs2_raw_dirent) 77 78 /* 79 This is all we need to keep in-core for each raw node during normal 80 operation. As and when we do read_inode on a particular inode, we can 81 scan the nodes which are listed for it and build up a proper map of 82 which nodes are currently valid. JFFSv1 always used to keep that whole 83 map in core for each inode. 84 */ 85 struct jffs2_raw_node_ref 86 { 87 struct jffs2_raw_node_ref *next_in_ino; /* Points to the next raw_node_ref 88 for this object. If this _is_ the last, it points to the inode_cache, 89 xattr_ref or xattr_datum instead. The common part of those structures 90 has NULL in the first word. See jffs2_raw_ref_to_ic() below */ 91 uint32_t flash_offset; 92 #define TEST_TOTLEN 93 #ifdef TEST_TOTLEN 94 uint32_t __totlen; /* This may die; use ref_totlen(c, jeb, ) below */ 95 #endif 96 }; 97 98 #define REF_LINK_NODE ((int32_t)-1) 99 #define REF_EMPTY_NODE ((int32_t)-2) 100 101 /* Use blocks of about 256 bytes */ 102 #define REFS_PER_BLOCK ((255/sizeof(struct jffs2_raw_node_ref))-1) 103 104 static inline struct jffs2_raw_node_ref *ref_next(struct jffs2_raw_node_ref *ref) 105 { 106 ref++; 107 108 /* Link to another block of refs */ 109 if (ref->flash_offset == REF_LINK_NODE) { 110 ref = ref->next_in_ino; 111 if (!ref) 112 return ref; 113 } 114 115 /* End of chain */ 116 if (ref->flash_offset == REF_EMPTY_NODE) 117 return NULL; 118 119 return ref; 120 } 121 122 static inline struct jffs2_inode_cache *jffs2_raw_ref_to_ic(struct jffs2_raw_node_ref *raw) 123 { 124 while(raw->next_in_ino) 125 raw = raw->next_in_ino; 126 127 /* NB. This can be a jffs2_xattr_datum or jffs2_xattr_ref and 128 not actually a jffs2_inode_cache. Check ->class */ 129 return ((struct jffs2_inode_cache *)raw); 130 } 131 132 /* flash_offset & 3 always has to be zero, because nodes are 133 always aligned at 4 bytes. So we have a couple of extra bits 134 to play with, which indicate the node's status; see below: */ 135 #define REF_UNCHECKED 0 /* We haven't yet checked the CRC or built its inode */ 136 #define REF_OBSOLETE 1 /* Obsolete, can be completely ignored */ 137 #define REF_PRISTINE 2 /* Completely clean. GC without looking */ 138 #define REF_NORMAL 3 /* Possibly overlapped. Read the page and write again on GC */ 139 #define ref_flags(ref) ((ref)->flash_offset & 3) 140 #define ref_offset(ref) ((ref)->flash_offset & ~3) 141 #define ref_obsolete(ref) (((ref)->flash_offset & 3) == REF_OBSOLETE) 142 #define mark_ref_normal(ref) do { (ref)->flash_offset = ref_offset(ref) | REF_NORMAL; } while(0) 143 144 /* NB: REF_PRISTINE for an inode-less node (ref->next_in_ino == NULL) indicates 145 it is an unknown node of type JFFS2_NODETYPE_RWCOMPAT_COPY, so it'll get 146 copied. If you need to do anything different to GC inode-less nodes, then 147 you need to modify gc.c accordingly. */ 148 149 /* For each inode in the filesystem, we need to keep a record of 150 nlink, because it would be a PITA to scan the whole directory tree 151 at read_inode() time to calculate it, and to keep sufficient information 152 in the raw_node_ref (basically both parent and child inode number for 153 dirent nodes) would take more space than this does. We also keep 154 a pointer to the first physical node which is part of this inode, too. 155 */ 156 struct jffs2_inode_cache { 157 /* First part of structure is shared with other objects which 158 can terminate the raw node refs' next_in_ino list -- which 159 currently struct jffs2_xattr_datum and struct jffs2_xattr_ref. */ 160 161 struct jffs2_full_dirent *scan_dents; /* Used during scan to hold 162 temporary lists of dirents, and later must be set to 163 NULL to mark the end of the raw_node_ref->next_in_ino 164 chain. */ 165 struct jffs2_raw_node_ref *nodes; 166 uint8_t class; /* It's used for identification */ 167 168 /* end of shared structure */ 169 170 uint8_t flags; 171 uint16_t state; 172 uint32_t ino; 173 struct jffs2_inode_cache *next; 174 #ifdef CONFIG_JFFS2_FS_XATTR 175 struct jffs2_xattr_ref *xref; 176 #endif 177 int nlink; 178 }; 179 180 /* Inode states for 'state' above. We need the 'GC' state to prevent 181 someone from doing a read_inode() while we're moving a 'REF_PRISTINE' 182 node without going through all the iget() nonsense */ 183 #define INO_STATE_UNCHECKED 0 /* CRC checks not yet done */ 184 #define INO_STATE_CHECKING 1 /* CRC checks in progress */ 185 #define INO_STATE_PRESENT 2 /* In core */ 186 #define INO_STATE_CHECKEDABSENT 3 /* Checked, cleared again */ 187 #define INO_STATE_GC 4 /* GCing a 'pristine' node */ 188 #define INO_STATE_READING 5 /* In read_inode() */ 189 #define INO_STATE_CLEARING 6 /* In clear_inode() */ 190 191 #define INO_FLAGS_XATTR_CHECKED 0x01 /* has no duplicate xattr_ref */ 192 193 #define RAWNODE_CLASS_INODE_CACHE 0 194 #define RAWNODE_CLASS_XATTR_DATUM 1 195 #define RAWNODE_CLASS_XATTR_REF 2 196 197 #define INOCACHE_HASHSIZE 128 198 199 #define write_ofs(c) ((c)->nextblock->offset + (c)->sector_size - (c)->nextblock->free_size) 200 201 /* 202 Larger representation of a raw node, kept in-core only when the 203 struct inode for this particular ino is instantiated. 204 */ 205 206 struct jffs2_full_dnode 207 { 208 struct jffs2_raw_node_ref *raw; 209 uint32_t ofs; /* The offset to which the data of this node belongs */ 210 uint32_t size; 211 uint32_t frags; /* Number of fragments which currently refer 212 to this node. When this reaches zero, 213 the node is obsolete. */ 214 }; 215 216 /* 217 Even larger representation of a raw node, kept in-core only while 218 we're actually building up the original map of which nodes go where, 219 in read_inode() 220 */ 221 struct jffs2_tmp_dnode_info 222 { 223 struct rb_node rb; 224 struct jffs2_full_dnode *fn; 225 uint32_t version; 226 uint32_t data_crc; 227 uint32_t partial_crc; 228 uint16_t csize; 229 uint16_t overlapped; 230 }; 231 232 /* Temporary data structure used during readinode. */ 233 struct jffs2_readinode_info 234 { 235 struct rb_root tn_root; 236 struct jffs2_tmp_dnode_info *mdata_tn; 237 uint32_t highest_version; 238 uint32_t latest_mctime; 239 uint32_t mctime_ver; 240 struct jffs2_full_dirent *fds; 241 struct jffs2_raw_node_ref *latest_ref; 242 }; 243 244 struct jffs2_full_dirent 245 { 246 struct jffs2_raw_node_ref *raw; 247 struct jffs2_full_dirent *next; 248 uint32_t version; 249 uint32_t ino; /* == zero for unlink */ 250 unsigned int nhash; 251 unsigned char type; 252 unsigned char name[0]; 253 }; 254 255 /* 256 Fragments - used to build a map of which raw node to obtain 257 data from for each part of the ino 258 */ 259 struct jffs2_node_frag 260 { 261 struct rb_node rb; 262 struct jffs2_full_dnode *node; /* NULL for holes */ 263 uint32_t size; 264 uint32_t ofs; /* The offset to which this fragment belongs */ 265 }; 266 267 struct jffs2_eraseblock 268 { 269 struct list_head list; 270 int bad_count; 271 uint32_t offset; /* of this block in the MTD */ 272 273 uint32_t unchecked_size; 274 uint32_t used_size; 275 uint32_t dirty_size; 276 uint32_t wasted_size; 277 uint32_t free_size; /* Note that sector_size - free_size 278 is the address of the first free space */ 279 uint32_t allocated_refs; 280 struct jffs2_raw_node_ref *first_node; 281 struct jffs2_raw_node_ref *last_node; 282 283 struct jffs2_raw_node_ref *gc_node; /* Next node to be garbage collected */ 284 }; 285 286 static inline int jffs2_blocks_use_vmalloc(struct jffs2_sb_info *c) 287 { 288 return ((c->flash_size / c->sector_size) * sizeof (struct jffs2_eraseblock)) > (128 * 1024); 289 } 290 291 #define ref_totlen(a, b, c) __jffs2_ref_totlen((a), (b), (c)) 292 293 #define ALLOC_NORMAL 0 /* Normal allocation */ 294 #define ALLOC_DELETION 1 /* Deletion node. Best to allow it */ 295 #define ALLOC_GC 2 /* Space requested for GC. Give it or die */ 296 #define ALLOC_NORETRY 3 /* For jffs2_write_dnode: On failure, return -EAGAIN instead of retrying */ 297 298 /* How much dirty space before it goes on the very_dirty_list */ 299 #define VERYDIRTY(c, size) ((size) >= ((c)->sector_size / 2)) 300 301 /* check if dirty space is more than 255 Byte */ 302 #define ISDIRTY(size) ((size) > sizeof (struct jffs2_raw_inode) + JFFS2_MIN_DATA_LEN) 303 304 #define PAD(x) (((x)+3)&~3) 305 306 static inline int jffs2_encode_dev(union jffs2_device_node *jdev, dev_t rdev) 307 { 308 if (old_valid_dev(rdev)) { 309 jdev->old = cpu_to_je16(old_encode_dev(rdev)); 310 return sizeof(jdev->old); 311 } else { 312 jdev->new = cpu_to_je32(new_encode_dev(rdev)); 313 return sizeof(jdev->new); 314 } 315 } 316 317 static inline struct jffs2_node_frag *frag_first(struct rb_root *root) 318 { 319 struct rb_node *node = rb_first(root); 320 321 if (!node) 322 return NULL; 323 324 return rb_entry(node, struct jffs2_node_frag, rb); 325 } 326 327 static inline struct jffs2_node_frag *frag_last(struct rb_root *root) 328 { 329 struct rb_node *node = rb_last(root); 330 331 if (!node) 332 return NULL; 333 334 return rb_entry(node, struct jffs2_node_frag, rb); 335 } 336 337 #define frag_next(frag) rb_entry(rb_next(&(frag)->rb), struct jffs2_node_frag, rb) 338 #define frag_prev(frag) rb_entry(rb_prev(&(frag)->rb), struct jffs2_node_frag, rb) 339 #define frag_parent(frag) rb_entry(rb_parent(&(frag)->rb), struct jffs2_node_frag, rb) 340 #define frag_left(frag) rb_entry((frag)->rb.rb_left, struct jffs2_node_frag, rb) 341 #define frag_right(frag) rb_entry((frag)->rb.rb_right, struct jffs2_node_frag, rb) 342 #define frag_erase(frag, list) rb_erase(&frag->rb, list); 343 344 #define tn_next(tn) rb_entry(rb_next(&(tn)->rb), struct jffs2_tmp_dnode_info, rb) 345 #define tn_prev(tn) rb_entry(rb_prev(&(tn)->rb), struct jffs2_tmp_dnode_info, rb) 346 #define tn_parent(tn) rb_entry(rb_parent(&(tn)->rb), struct jffs2_tmp_dnode_info, rb) 347 #define tn_left(tn) rb_entry((tn)->rb.rb_left, struct jffs2_tmp_dnode_info, rb) 348 #define tn_right(tn) rb_entry((tn)->rb.rb_right, struct jffs2_tmp_dnode_info, rb) 349 #define tn_erase(tn, list) rb_erase(&tn->rb, list); 350 #define tn_last(list) rb_entry(rb_last(list), struct jffs2_tmp_dnode_info, rb) 351 #define tn_first(list) rb_entry(rb_first(list), struct jffs2_tmp_dnode_info, rb) 352 353 /* nodelist.c */ 354 void jffs2_add_fd_to_list(struct jffs2_sb_info *c, struct jffs2_full_dirent *new, struct jffs2_full_dirent **list); 355 void jffs2_set_inocache_state(struct jffs2_sb_info *c, struct jffs2_inode_cache *ic, int state); 356 struct jffs2_inode_cache *jffs2_get_ino_cache(struct jffs2_sb_info *c, uint32_t ino); 357 void jffs2_add_ino_cache (struct jffs2_sb_info *c, struct jffs2_inode_cache *new); 358 void jffs2_del_ino_cache(struct jffs2_sb_info *c, struct jffs2_inode_cache *old); 359 void jffs2_free_ino_caches(struct jffs2_sb_info *c); 360 void jffs2_free_raw_node_refs(struct jffs2_sb_info *c); 361 struct jffs2_node_frag *jffs2_lookup_node_frag(struct rb_root *fragtree, uint32_t offset); 362 void jffs2_kill_fragtree(struct rb_root *root, struct jffs2_sb_info *c_delete); 363 struct rb_node *rb_next(struct rb_node *); 364 struct rb_node *rb_prev(struct rb_node *); 365 void rb_replace_node(struct rb_node *victim, struct rb_node *new, struct rb_root *root); 366 int jffs2_add_full_dnode_to_inode(struct jffs2_sb_info *c, struct jffs2_inode_info *f, struct jffs2_full_dnode *fn); 367 void jffs2_truncate_fragtree (struct jffs2_sb_info *c, struct rb_root *list, uint32_t size); 368 struct jffs2_raw_node_ref *jffs2_link_node_ref(struct jffs2_sb_info *c, 369 struct jffs2_eraseblock *jeb, 370 uint32_t ofs, uint32_t len, 371 struct jffs2_inode_cache *ic); 372 extern uint32_t __jffs2_ref_totlen(struct jffs2_sb_info *c, 373 struct jffs2_eraseblock *jeb, 374 struct jffs2_raw_node_ref *ref); 375 376 /* nodemgmt.c */ 377 int jffs2_thread_should_wake(struct jffs2_sb_info *c); 378 int jffs2_reserve_space(struct jffs2_sb_info *c, uint32_t minsize, 379 uint32_t *len, int prio, uint32_t sumsize); 380 int jffs2_reserve_space_gc(struct jffs2_sb_info *c, uint32_t minsize, 381 uint32_t *len, uint32_t sumsize); 382 struct jffs2_raw_node_ref *jffs2_add_physical_node_ref(struct jffs2_sb_info *c, 383 uint32_t ofs, uint32_t len, 384 struct jffs2_inode_cache *ic); 385 void jffs2_complete_reservation(struct jffs2_sb_info *c); 386 void jffs2_mark_node_obsolete(struct jffs2_sb_info *c, struct jffs2_raw_node_ref *raw); 387 388 /* write.c */ 389 int jffs2_do_new_inode(struct jffs2_sb_info *c, struct jffs2_inode_info *f, uint32_t mode, struct jffs2_raw_inode *ri); 390 391 struct jffs2_full_dnode *jffs2_write_dnode(struct jffs2_sb_info *c, struct jffs2_inode_info *f, 392 struct jffs2_raw_inode *ri, const unsigned char *data, 393 uint32_t datalen, int alloc_mode); 394 struct jffs2_full_dirent *jffs2_write_dirent(struct jffs2_sb_info *c, struct jffs2_inode_info *f, 395 struct jffs2_raw_dirent *rd, const unsigned char *name, 396 uint32_t namelen, int alloc_mode); 397 int jffs2_write_inode_range(struct jffs2_sb_info *c, struct jffs2_inode_info *f, 398 struct jffs2_raw_inode *ri, unsigned char *buf, 399 uint32_t offset, uint32_t writelen, uint32_t *retlen); 400 int jffs2_do_create(struct jffs2_sb_info *c, struct jffs2_inode_info *dir_f, struct jffs2_inode_info *f, 401 struct jffs2_raw_inode *ri, const char *name, int namelen); 402 int jffs2_do_unlink(struct jffs2_sb_info *c, struct jffs2_inode_info *dir_f, const char *name, 403 int namelen, struct jffs2_inode_info *dead_f, uint32_t time); 404 int jffs2_do_link(struct jffs2_sb_info *c, struct jffs2_inode_info *dir_f, uint32_t ino, 405 uint8_t type, const char *name, int namelen, uint32_t time); 406 407 408 /* readinode.c */ 409 int jffs2_do_read_inode(struct jffs2_sb_info *c, struct jffs2_inode_info *f, 410 uint32_t ino, struct jffs2_raw_inode *latest_node); 411 int jffs2_do_crccheck_inode(struct jffs2_sb_info *c, struct jffs2_inode_cache *ic); 412 void jffs2_do_clear_inode(struct jffs2_sb_info *c, struct jffs2_inode_info *f); 413 414 /* malloc.c */ 415 int jffs2_create_slab_caches(void); 416 void jffs2_destroy_slab_caches(void); 417 418 struct jffs2_full_dirent *jffs2_alloc_full_dirent(int namesize); 419 void jffs2_free_full_dirent(struct jffs2_full_dirent *); 420 struct jffs2_full_dnode *jffs2_alloc_full_dnode(void); 421 void jffs2_free_full_dnode(struct jffs2_full_dnode *); 422 struct jffs2_raw_dirent *jffs2_alloc_raw_dirent(void); 423 void jffs2_free_raw_dirent(struct jffs2_raw_dirent *); 424 struct jffs2_raw_inode *jffs2_alloc_raw_inode(void); 425 void jffs2_free_raw_inode(struct jffs2_raw_inode *); 426 struct jffs2_tmp_dnode_info *jffs2_alloc_tmp_dnode_info(void); 427 void jffs2_free_tmp_dnode_info(struct jffs2_tmp_dnode_info *); 428 int jffs2_prealloc_raw_node_refs(struct jffs2_sb_info *c, 429 struct jffs2_eraseblock *jeb, int nr); 430 void jffs2_free_refblock(struct jffs2_raw_node_ref *); 431 struct jffs2_node_frag *jffs2_alloc_node_frag(void); 432 void jffs2_free_node_frag(struct jffs2_node_frag *); 433 struct jffs2_inode_cache *jffs2_alloc_inode_cache(void); 434 void jffs2_free_inode_cache(struct jffs2_inode_cache *); 435 #ifdef CONFIG_JFFS2_FS_XATTR 436 struct jffs2_xattr_datum *jffs2_alloc_xattr_datum(void); 437 void jffs2_free_xattr_datum(struct jffs2_xattr_datum *); 438 struct jffs2_xattr_ref *jffs2_alloc_xattr_ref(void); 439 void jffs2_free_xattr_ref(struct jffs2_xattr_ref *); 440 #endif 441 442 /* gc.c */ 443 int jffs2_garbage_collect_pass(struct jffs2_sb_info *c); 444 445 /* read.c */ 446 int jffs2_read_dnode(struct jffs2_sb_info *c, struct jffs2_inode_info *f, 447 struct jffs2_full_dnode *fd, unsigned char *buf, 448 int ofs, int len); 449 int jffs2_read_inode_range(struct jffs2_sb_info *c, struct jffs2_inode_info *f, 450 unsigned char *buf, uint32_t offset, uint32_t len); 451 char *jffs2_getlink(struct jffs2_sb_info *c, struct jffs2_inode_info *f); 452 453 /* scan.c */ 454 int jffs2_scan_medium(struct jffs2_sb_info *c); 455 void jffs2_rotate_lists(struct jffs2_sb_info *c); 456 struct jffs2_inode_cache *jffs2_scan_make_ino_cache(struct jffs2_sb_info *c, uint32_t ino); 457 int jffs2_scan_classify_jeb(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb); 458 int jffs2_scan_dirty_space(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb, uint32_t size); 459 460 /* build.c */ 461 int jffs2_do_mount_fs(struct jffs2_sb_info *c); 462 463 /* erase.c */ 464 void jffs2_erase_pending_blocks(struct jffs2_sb_info *c, int count); 465 void jffs2_free_jeb_node_refs(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb); 466 467 #ifdef CONFIG_JFFS2_FS_WRITEBUFFER 468 /* wbuf.c */ 469 int jffs2_flush_wbuf_gc(struct jffs2_sb_info *c, uint32_t ino); 470 int jffs2_flush_wbuf_pad(struct jffs2_sb_info *c); 471 int jffs2_check_nand_cleanmarker(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb); 472 int jffs2_write_nand_cleanmarker(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb); 473 #endif 474 475 #include "debug.h" 476 477 #endif /* __JFFS2_NODELIST_H__ */ 478