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