SAFE public projects git trees. - safe/jmp/linux-2.6/blob - 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/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         uint32_t csize;
 229 };
 230
 231 struct jffs2_full_dirent
 232 {
 233         struct jffs2_raw_node_ref *raw;
 234         struct jffs2_full_dirent *next;
 235         uint32_t version;
 236         uint32_t ino; /* == zero for unlink */
 237         unsigned int nhash;
 238         unsigned char type;
 239         unsigned char name[0];
 240 };
 241
 242 /*
 243   Fragments - used to build a map of which raw node to obtain
 244   data from for each part of the ino
 245 */
 246 struct jffs2_node_frag
 247 {
 248         struct rb_node rb;
 249         struct jffs2_full_dnode *node; /* NULL for holes */
 250         uint32_t size;
 251         uint32_t ofs; /* The offset to which this fragment belongs */
 252 };
 253
 254 struct jffs2_eraseblock
 255 {
 256         struct list_head list;
 257         int bad_count;
 258         uint32_t offset;                /* of this block in the MTD */
 259
 260         uint32_t unchecked_size;
 261         uint32_t used_size;
 262         uint32_t dirty_size;
 263         uint32_t wasted_size;
 264         uint32_t free_size;     /* Note that sector_size - free_size
 265                                    is the address of the first free space */
 266         uint32_t allocated_refs;
 267         struct jffs2_raw_node_ref *first_node;
 268         struct jffs2_raw_node_ref *last_node;
 269
 270         struct jffs2_raw_node_ref *gc_node;     /* Next node to be garbage collected */
 271 };
 272
 273 static inline int jffs2_blocks_use_vmalloc(struct jffs2_sb_info *c)
 274 {
 275         return ((c->flash_size / c->sector_size) * sizeof (struct jffs2_eraseblock)) > (128 * 1024);
 276 }
 277
 278 #define ref_totlen(a, b, c) __jffs2_ref_totlen((a), (b), (c))
 279
 280 #define ALLOC_NORMAL    0       /* Normal allocation */
 281 #define ALLOC_DELETION  1       /* Deletion node. Best to allow it */
 282 #define ALLOC_GC        2       /* Space requested for GC. Give it or die */
 283 #define ALLOC_NORETRY   3       /* For jffs2_write_dnode: On failure, return -EAGAIN instead of retrying */
 284
 285 /* How much dirty space before it goes on the very_dirty_list */
 286 #define VERYDIRTY(c, size) ((size) >= ((c)->sector_size / 2))
 287
 288 /* check if dirty space is more than 255 Byte */
 289 #define ISDIRTY(size) ((size) >  sizeof (struct jffs2_raw_inode) + JFFS2_MIN_DATA_LEN)
 290
 291 #define PAD(x) (((x)+3)&~3)
 292
 293 static inline int jffs2_encode_dev(union jffs2_device_node *jdev, dev_t rdev)
 294 {
 295         if (old_valid_dev(rdev)) {
 296                 jdev->old = cpu_to_je16(old_encode_dev(rdev));
 297                 return sizeof(jdev->old);
 298         } else {
 299                 jdev->new = cpu_to_je32(new_encode_dev(rdev));
 300                 return sizeof(jdev->new);
 301         }
 302 }
 303
 304 static inline struct jffs2_node_frag *frag_first(struct rb_root *root)
 305 {
 306         struct rb_node *node = rb_first(root);
 307
 308         if (!node)
 309                 return NULL;
 310
 311         return rb_entry(node, struct jffs2_node_frag, rb);
 312 }
 313
 314 static inline struct jffs2_node_frag *frag_last(struct rb_root *root)
 315 {
 316         struct rb_node *node = rb_last(root);
 317
 318         if (!node)
 319                 return NULL;
 320
 321         return rb_entry(node, struct jffs2_node_frag, rb);
 322 }
 323
 324 #define frag_next(frag) rb_entry(rb_next(&(frag)->rb), struct jffs2_node_frag, rb)
 325 #define frag_prev(frag) rb_entry(rb_prev(&(frag)->rb), struct jffs2_node_frag, rb)
 326 #define frag_parent(frag) rb_entry(rb_parent(&(frag)->rb), struct jffs2_node_frag, rb)
 327 #define frag_left(frag) rb_entry((frag)->rb.rb_left, struct jffs2_node_frag, rb)
 328 #define frag_right(frag) rb_entry((frag)->rb.rb_right, struct jffs2_node_frag, rb)
 329 #define frag_erase(frag, list) rb_erase(&frag->rb, list);
 330
 331 /* nodelist.c */
 332 void jffs2_add_fd_to_list(struct jffs2_sb_info *c, struct jffs2_full_dirent *new, struct jffs2_full_dirent **list);
 333 void jffs2_set_inocache_state(struct jffs2_sb_info *c, struct jffs2_inode_cache *ic, int state);
 334 struct jffs2_inode_cache *jffs2_get_ino_cache(struct jffs2_sb_info *c, uint32_t ino);
 335 void jffs2_add_ino_cache (struct jffs2_sb_info *c, struct jffs2_inode_cache *new);
 336 void jffs2_del_ino_cache(struct jffs2_sb_info *c, struct jffs2_inode_cache *old);
 337 void jffs2_free_ino_caches(struct jffs2_sb_info *c);
 338 void jffs2_free_raw_node_refs(struct jffs2_sb_info *c);
 339 struct jffs2_node_frag *jffs2_lookup_node_frag(struct rb_root *fragtree, uint32_t offset);
 340 void jffs2_kill_fragtree(struct rb_root *root, struct jffs2_sb_info *c_delete);
 341 struct rb_node *rb_next(struct rb_node *);
 342 struct rb_node *rb_prev(struct rb_node *);
 343 void rb_replace_node(struct rb_node *victim, struct rb_node *new, struct rb_root *root);
 344 int jffs2_add_full_dnode_to_inode(struct jffs2_sb_info *c, struct jffs2_inode_info *f, struct jffs2_full_dnode *fn);
 345 void jffs2_truncate_fragtree (struct jffs2_sb_info *c, struct rb_root *list, uint32_t size);
 346 int jffs2_add_older_frag_to_fragtree(struct jffs2_sb_info *c, struct jffs2_inode_info *f, struct jffs2_tmp_dnode_info *tn);
 347 struct jffs2_raw_node_ref *jffs2_link_node_ref(struct jffs2_sb_info *c,
 348                                                struct jffs2_eraseblock *jeb,
 349                                                uint32_t ofs, uint32_t len,
 350                                                struct jffs2_inode_cache *ic);
 351 extern uint32_t __jffs2_ref_totlen(struct jffs2_sb_info *c,
 352                                    struct jffs2_eraseblock *jeb,
 353                                    struct jffs2_raw_node_ref *ref);
 354
 355 /* nodemgmt.c */
 356 int jffs2_thread_should_wake(struct jffs2_sb_info *c);
 357 int jffs2_reserve_space(struct jffs2_sb_info *c, uint32_t minsize,
 358                         uint32_t *len, int prio, uint32_t sumsize);
 359 int jffs2_reserve_space_gc(struct jffs2_sb_info *c, uint32_t minsize,
 360                         uint32_t *len, uint32_t sumsize);
 361 struct jffs2_raw_node_ref *jffs2_add_physical_node_ref(struct jffs2_sb_info *c,
 362                                                        uint32_t ofs, uint32_t len,
 363                                                        struct jffs2_inode_cache *ic);
 364 void jffs2_complete_reservation(struct jffs2_sb_info *c);
 365 void jffs2_mark_node_obsolete(struct jffs2_sb_info *c, struct jffs2_raw_node_ref *raw);
 366
 367 /* write.c */
 368 int jffs2_do_new_inode(struct jffs2_sb_info *c, struct jffs2_inode_info *f, uint32_t mode, struct jffs2_raw_inode *ri);
 369
 370 struct jffs2_full_dnode *jffs2_write_dnode(struct jffs2_sb_info *c, struct jffs2_inode_info *f,
 371                                            struct jffs2_raw_inode *ri, const unsigned char *data,
 372                                            uint32_t datalen, int alloc_mode);
 373 struct jffs2_full_dirent *jffs2_write_dirent(struct jffs2_sb_info *c, struct jffs2_inode_info *f,
 374                                              struct jffs2_raw_dirent *rd, const unsigned char *name,
 375                                              uint32_t namelen, int alloc_mode);
 376 int jffs2_write_inode_range(struct jffs2_sb_info *c, struct jffs2_inode_info *f,
 377                             struct jffs2_raw_inode *ri, unsigned char *buf,
 378                             uint32_t offset, uint32_t writelen, uint32_t *retlen);
 379 int jffs2_do_create(struct jffs2_sb_info *c, struct jffs2_inode_info *dir_f, struct jffs2_inode_info *f,
 380                     struct jffs2_raw_inode *ri, const char *name, int namelen);
 381 int jffs2_do_unlink(struct jffs2_sb_info *c, struct jffs2_inode_info *dir_f, const char *name,
 382                     int namelen, struct jffs2_inode_info *dead_f, uint32_t time);
 383 int jffs2_do_link(struct jffs2_sb_info *c, struct jffs2_inode_info *dir_f, uint32_t ino,
 384                    uint8_t type, const char *name, int namelen, uint32_t time);
 385
 386
 387 /* readinode.c */
 388 int jffs2_do_read_inode(struct jffs2_sb_info *c, struct jffs2_inode_info *f,
 389                         uint32_t ino, struct jffs2_raw_inode *latest_node);
 390 int jffs2_do_crccheck_inode(struct jffs2_sb_info *c, struct jffs2_inode_cache *ic);
 391 void jffs2_do_clear_inode(struct jffs2_sb_info *c, struct jffs2_inode_info *f);
 392
 393 /* malloc.c */
 394 int jffs2_create_slab_caches(void);
 395 void jffs2_destroy_slab_caches(void);
 396
 397 struct jffs2_full_dirent *jffs2_alloc_full_dirent(int namesize);
 398 void jffs2_free_full_dirent(struct jffs2_full_dirent *);
 399 struct jffs2_full_dnode *jffs2_alloc_full_dnode(void);
 400 void jffs2_free_full_dnode(struct jffs2_full_dnode *);
 401 struct jffs2_raw_dirent *jffs2_alloc_raw_dirent(void);
 402 void jffs2_free_raw_dirent(struct jffs2_raw_dirent *);
 403 struct jffs2_raw_inode *jffs2_alloc_raw_inode(void);
 404 void jffs2_free_raw_inode(struct jffs2_raw_inode *);
 405 struct jffs2_tmp_dnode_info *jffs2_alloc_tmp_dnode_info(void);
 406 void jffs2_free_tmp_dnode_info(struct jffs2_tmp_dnode_info *);
 407 int jffs2_prealloc_raw_node_refs(struct jffs2_sb_info *c,
 408                                  struct jffs2_eraseblock *jeb, int nr);
 409 void jffs2_free_refblock(struct jffs2_raw_node_ref *);
 410 struct jffs2_node_frag *jffs2_alloc_node_frag(void);
 411 void jffs2_free_node_frag(struct jffs2_node_frag *);
 412 struct jffs2_inode_cache *jffs2_alloc_inode_cache(void);
 413 void jffs2_free_inode_cache(struct jffs2_inode_cache *);
 414 #ifdef CONFIG_JFFS2_FS_XATTR
 415 struct jffs2_xattr_datum *jffs2_alloc_xattr_datum(void);
 416 void jffs2_free_xattr_datum(struct jffs2_xattr_datum *);
 417 struct jffs2_xattr_ref *jffs2_alloc_xattr_ref(void);
 418 void jffs2_free_xattr_ref(struct jffs2_xattr_ref *);
 419 #endif
 420
 421 /* gc.c */
 422 int jffs2_garbage_collect_pass(struct jffs2_sb_info *c);
 423
 424 /* read.c */
 425 int jffs2_read_dnode(struct jffs2_sb_info *c, struct jffs2_inode_info *f,
 426                      struct jffs2_full_dnode *fd, unsigned char *buf,
 427                      int ofs, int len);
 428 int jffs2_read_inode_range(struct jffs2_sb_info *c, struct jffs2_inode_info *f,
 429                            unsigned char *buf, uint32_t offset, uint32_t len);
 430 char *jffs2_getlink(struct jffs2_sb_info *c, struct jffs2_inode_info *f);
 431
 432 /* scan.c */
 433 int jffs2_scan_medium(struct jffs2_sb_info *c);
 434 void jffs2_rotate_lists(struct jffs2_sb_info *c);
 435 struct jffs2_inode_cache *jffs2_scan_make_ino_cache(struct jffs2_sb_info *c, uint32_t ino);
 436 int jffs2_scan_classify_jeb(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb);
 437 int jffs2_scan_dirty_space(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb, uint32_t size);
 438
 439 /* build.c */
 440 int jffs2_do_mount_fs(struct jffs2_sb_info *c);
 441
 442 /* erase.c */
 443 void jffs2_erase_pending_blocks(struct jffs2_sb_info *c, int count);
 444 void jffs2_free_jeb_node_refs(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb);
 445
 446 #ifdef CONFIG_JFFS2_FS_WRITEBUFFER
 447 /* wbuf.c */
 448 int jffs2_flush_wbuf_gc(struct jffs2_sb_info *c, uint32_t ino);
 449 int jffs2_flush_wbuf_pad(struct jffs2_sb_info *c);
 450 int jffs2_check_nand_cleanmarker(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb);
 451 int jffs2_write_nand_cleanmarker(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb);
 452 #endif
 453
 454 #include "debug.h"
 455
 456 #endif /* __JFFS2_NODELIST_H__ */