fs/jffs2/nodelist.h

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