Merge git://git.infradead.org/mtd-2.6
[linux-3.10.git] / 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 inode. If this is the last, it points to the inode_cache
81                 for this inode instead. The inode_cache will have NULL in the first
82                 word so you know when you've got there :) */
83         struct jffs2_raw_node_ref *next_phys;
84         uint32_t flash_offset;
85         uint32_t __totlen; /* This may die; use ref_totlen(c, jeb, ) below */
86 };
87
88         /* flash_offset & 3 always has to be zero, because nodes are
89            always aligned at 4 bytes. So we have a couple of extra bits
90            to play with, which indicate the node's status; see below: */
91 #define REF_UNCHECKED   0       /* We haven't yet checked the CRC or built its inode */
92 #define REF_OBSOLETE    1       /* Obsolete, can be completely ignored */
93 #define REF_PRISTINE    2       /* Completely clean. GC without looking */
94 #define REF_NORMAL      3       /* Possibly overlapped. Read the page and write again on GC */
95 #define ref_flags(ref)          ((ref)->flash_offset & 3)
96 #define ref_offset(ref)         ((ref)->flash_offset & ~3)
97 #define ref_obsolete(ref)       (((ref)->flash_offset & 3) == REF_OBSOLETE)
98 #define mark_ref_normal(ref)    do { (ref)->flash_offset = ref_offset(ref) | REF_NORMAL; } while(0)
99
100 /* For each inode in the filesystem, we need to keep a record of
101    nlink, because it would be a PITA to scan the whole directory tree
102    at read_inode() time to calculate it, and to keep sufficient information
103    in the raw_node_ref (basically both parent and child inode number for
104    dirent nodes) would take more space than this does. We also keep
105    a pointer to the first physical node which is part of this inode, too.
106 */
107 struct jffs2_inode_cache {
108         struct jffs2_full_dirent *scan_dents; /* Used during scan to hold
109                 temporary lists of dirents, and later must be set to
110                 NULL to mark the end of the raw_node_ref->next_in_ino
111                 chain. */
112         u8 class;       /* It's used for identification */
113         u8 flags;
114         uint16_t state;
115         struct jffs2_inode_cache *next;
116         struct jffs2_raw_node_ref *nodes;
117         uint32_t ino;
118         int nlink;
119 #ifdef CONFIG_JFFS2_FS_XATTR
120         struct jffs2_xattr_ref *xref;
121 #endif
122 };
123
124 /* Inode states for 'state' above. We need the 'GC' state to prevent
125    someone from doing a read_inode() while we're moving a 'REF_PRISTINE'
126    node without going through all the iget() nonsense */
127 #define INO_STATE_UNCHECKED     0       /* CRC checks not yet done */
128 #define INO_STATE_CHECKING      1       /* CRC checks in progress */
129 #define INO_STATE_PRESENT       2       /* In core */
130 #define INO_STATE_CHECKEDABSENT 3       /* Checked, cleared again */
131 #define INO_STATE_GC            4       /* GCing a 'pristine' node */
132 #define INO_STATE_READING       5       /* In read_inode() */
133 #define INO_STATE_CLEARING      6       /* In clear_inode() */
134
135 #define INO_FLAGS_XATTR_CHECKED 0x01    /* has no duplicate xattr_ref */
136
137 #define RAWNODE_CLASS_INODE_CACHE       0
138 #define RAWNODE_CLASS_XATTR_DATUM       1
139 #define RAWNODE_CLASS_XATTR_REF         2
140
141 #define INOCACHE_HASHSIZE 128
142
143 /*
144   Larger representation of a raw node, kept in-core only when the
145   struct inode for this particular ino is instantiated.
146 */
147
148 struct jffs2_full_dnode
149 {
150         struct jffs2_raw_node_ref *raw;
151         uint32_t ofs; /* The offset to which the data of this node belongs */
152         uint32_t size;
153         uint32_t frags; /* Number of fragments which currently refer
154                         to this node. When this reaches zero,
155                         the node is obsolete.  */
156 };
157
158 /*
159    Even larger representation of a raw node, kept in-core only while
160    we're actually building up the original map of which nodes go where,
161    in read_inode()
162 */
163 struct jffs2_tmp_dnode_info
164 {
165         struct rb_node rb;
166         struct jffs2_full_dnode *fn;
167         uint32_t version;
168         uint32_t data_crc;
169         uint32_t partial_crc;
170         uint32_t csize;
171 };
172
173 struct jffs2_full_dirent
174 {
175         struct jffs2_raw_node_ref *raw;
176         struct jffs2_full_dirent *next;
177         uint32_t version;
178         uint32_t ino; /* == zero for unlink */
179         unsigned int nhash;
180         unsigned char type;
181         unsigned char name[0];
182 };
183
184 /*
185   Fragments - used to build a map of which raw node to obtain
186   data from for each part of the ino
187 */
188 struct jffs2_node_frag
189 {
190         struct rb_node rb;
191         struct jffs2_full_dnode *node; /* NULL for holes */
192         uint32_t size;
193         uint32_t ofs; /* The offset to which this fragment belongs */
194 };
195
196 struct jffs2_eraseblock
197 {
198         struct list_head list;
199         int bad_count;
200         uint32_t offset;                /* of this block in the MTD */
201
202         uint32_t unchecked_size;
203         uint32_t used_size;
204         uint32_t dirty_size;
205         uint32_t wasted_size;
206         uint32_t free_size;     /* Note that sector_size - free_size
207                                    is the address of the first free space */
208         struct jffs2_raw_node_ref *first_node;
209         struct jffs2_raw_node_ref *last_node;
210
211         struct jffs2_raw_node_ref *gc_node;     /* Next node to be garbage collected */
212 };
213
214 static inline int jffs2_blocks_use_vmalloc(struct jffs2_sb_info *c)
215 {
216         return ((c->flash_size / c->sector_size) * sizeof (struct jffs2_eraseblock)) > (128 * 1024);
217 }
218
219 /* Calculate totlen from surrounding nodes or eraseblock */
220 static inline uint32_t __ref_totlen(struct jffs2_sb_info *c,
221                                     struct jffs2_eraseblock *jeb,
222                                     struct jffs2_raw_node_ref *ref)
223 {
224         uint32_t ref_end;
225
226         if (ref->next_phys)
227                 ref_end = ref_offset(ref->next_phys);
228         else {
229                 if (!jeb)
230                         jeb = &c->blocks[ref->flash_offset / c->sector_size];
231
232                 /* Last node in block. Use free_space */
233                 BUG_ON(ref != jeb->last_node);
234                 ref_end = jeb->offset + c->sector_size - jeb->free_size;
235         }
236         return ref_end - ref_offset(ref);
237 }
238
239 static inline uint32_t ref_totlen(struct jffs2_sb_info *c,
240                                   struct jffs2_eraseblock *jeb,
241                                   struct jffs2_raw_node_ref *ref)
242 {
243         uint32_t ret;
244
245 #if CONFIG_JFFS2_FS_DEBUG > 0
246         if (jeb && jeb != &c->blocks[ref->flash_offset / c->sector_size]) {
247                 printk(KERN_CRIT "ref_totlen called with wrong block -- at 0x%08x instead of 0x%08x; ref 0x%08x\n",
248                        jeb->offset, c->blocks[ref->flash_offset / c->sector_size].offset, ref_offset(ref));
249                 BUG();
250         }
251 #endif
252
253 #if 1
254         ret = ref->__totlen;
255 #else
256         /* This doesn't actually work yet */
257         ret = __ref_totlen(c, jeb, ref);
258         if (ret != ref->__totlen) {
259                 printk(KERN_CRIT "Totlen for ref at %p (0x%08x-0x%08x) miscalculated as 0x%x instead of %x\n",
260                        ref, ref_offset(ref), ref_offset(ref)+ref->__totlen,
261                        ret, ref->__totlen);
262                 if (!jeb)
263                         jeb = &c->blocks[ref->flash_offset / c->sector_size];
264                 jffs2_dbg_dump_node_refs_nolock(c, jeb);
265                 BUG();
266         }
267 #endif
268         return ret;
269 }
270
271 #define ALLOC_NORMAL    0       /* Normal allocation */
272 #define ALLOC_DELETION  1       /* Deletion node. Best to allow it */
273 #define ALLOC_GC        2       /* Space requested for GC. Give it or die */
274 #define ALLOC_NORETRY   3       /* For jffs2_write_dnode: On failure, return -EAGAIN instead of retrying */
275
276 /* How much dirty space before it goes on the very_dirty_list */
277 #define VERYDIRTY(c, size) ((size) >= ((c)->sector_size / 2))
278
279 /* check if dirty space is more than 255 Byte */
280 #define ISDIRTY(size) ((size) >  sizeof (struct jffs2_raw_inode) + JFFS2_MIN_DATA_LEN)
281
282 #define PAD(x) (((x)+3)&~3)
283
284 static inline struct jffs2_inode_cache *jffs2_raw_ref_to_ic(struct jffs2_raw_node_ref *raw)
285 {
286         while(raw->next_in_ino) {
287                 raw = raw->next_in_ino;
288         }
289
290         return ((struct jffs2_inode_cache *)raw);
291 }
292
293 static inline struct jffs2_node_frag *frag_first(struct rb_root *root)
294 {
295         struct rb_node *node = root->rb_node;
296
297         if (!node)
298                 return NULL;
299         while(node->rb_left)
300                 node = node->rb_left;
301         return rb_entry(node, struct jffs2_node_frag, rb);
302 }
303
304 static inline struct jffs2_node_frag *frag_last(struct rb_root *root)
305 {
306         struct rb_node *node = root->rb_node;
307
308         if (!node)
309                 return NULL;
310         while(node->rb_right)
311                 node = node->rb_right;
312         return rb_entry(node, struct jffs2_node_frag, rb);
313 }
314
315 #define rb_parent(rb) ((rb)->rb_parent)
316 #define frag_next(frag) rb_entry(rb_next(&(frag)->rb), struct jffs2_node_frag, rb)
317 #define frag_prev(frag) rb_entry(rb_prev(&(frag)->rb), struct jffs2_node_frag, rb)
318 #define frag_parent(frag) rb_entry(rb_parent(&(frag)->rb), struct jffs2_node_frag, rb)
319 #define frag_left(frag) rb_entry((frag)->rb.rb_left, struct jffs2_node_frag, rb)
320 #define frag_right(frag) rb_entry((frag)->rb.rb_right, struct jffs2_node_frag, rb)
321 #define frag_erase(frag, list) rb_erase(&frag->rb, list);
322
323 /* nodelist.c */
324 void jffs2_add_fd_to_list(struct jffs2_sb_info *c, struct jffs2_full_dirent *new, struct jffs2_full_dirent **list);
325 void jffs2_set_inocache_state(struct jffs2_sb_info *c, struct jffs2_inode_cache *ic, int state);
326 struct jffs2_inode_cache *jffs2_get_ino_cache(struct jffs2_sb_info *c, uint32_t ino);
327 void jffs2_add_ino_cache (struct jffs2_sb_info *c, struct jffs2_inode_cache *new);
328 void jffs2_del_ino_cache(struct jffs2_sb_info *c, struct jffs2_inode_cache *old);
329 void jffs2_free_ino_caches(struct jffs2_sb_info *c);
330 void jffs2_free_raw_node_refs(struct jffs2_sb_info *c);
331 struct jffs2_node_frag *jffs2_lookup_node_frag(struct rb_root *fragtree, uint32_t offset);
332 void jffs2_kill_fragtree(struct rb_root *root, struct jffs2_sb_info *c_delete);
333 struct rb_node *rb_next(struct rb_node *);
334 struct rb_node *rb_prev(struct rb_node *);
335 void rb_replace_node(struct rb_node *victim, struct rb_node *new, struct rb_root *root);
336 void jffs2_obsolete_node_frag(struct jffs2_sb_info *c, struct jffs2_node_frag *this);
337 int jffs2_add_full_dnode_to_inode(struct jffs2_sb_info *c, struct jffs2_inode_info *f, struct jffs2_full_dnode *fn);
338 void jffs2_truncate_fragtree (struct jffs2_sb_info *c, struct rb_root *list, uint32_t size);
339 int jffs2_add_older_frag_to_fragtree(struct jffs2_sb_info *c, struct jffs2_inode_info *f, struct jffs2_tmp_dnode_info *tn);
340
341 /* nodemgmt.c */
342 int jffs2_thread_should_wake(struct jffs2_sb_info *c);
343 int jffs2_reserve_space(struct jffs2_sb_info *c, uint32_t minsize, uint32_t *ofs,
344                         uint32_t *len, int prio, uint32_t sumsize);
345 int jffs2_reserve_space_gc(struct jffs2_sb_info *c, uint32_t minsize, uint32_t *ofs,
346                         uint32_t *len, uint32_t sumsize);
347 int jffs2_add_physical_node_ref(struct jffs2_sb_info *c, struct jffs2_raw_node_ref *new);
348 void jffs2_complete_reservation(struct jffs2_sb_info *c);
349 void jffs2_mark_node_obsolete(struct jffs2_sb_info *c, struct jffs2_raw_node_ref *raw);
350
351 /* write.c */
352 int jffs2_do_new_inode(struct jffs2_sb_info *c, struct jffs2_inode_info *f, uint32_t mode, struct jffs2_raw_inode *ri);
353
354 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);
355 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);
356 int jffs2_write_inode_range(struct jffs2_sb_info *c, struct jffs2_inode_info *f,
357                             struct jffs2_raw_inode *ri, unsigned char *buf,
358                             uint32_t offset, uint32_t writelen, uint32_t *retlen);
359 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);
360 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);
361 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);
362
363
364 /* readinode.c */
365 int jffs2_do_read_inode(struct jffs2_sb_info *c, struct jffs2_inode_info *f,
366                         uint32_t ino, struct jffs2_raw_inode *latest_node);
367 int jffs2_do_crccheck_inode(struct jffs2_sb_info *c, struct jffs2_inode_cache *ic);
368 void jffs2_do_clear_inode(struct jffs2_sb_info *c, struct jffs2_inode_info *f);
369
370 /* malloc.c */
371 int jffs2_create_slab_caches(void);
372 void jffs2_destroy_slab_caches(void);
373
374 struct jffs2_full_dirent *jffs2_alloc_full_dirent(int namesize);
375 void jffs2_free_full_dirent(struct jffs2_full_dirent *);
376 struct jffs2_full_dnode *jffs2_alloc_full_dnode(void);
377 void jffs2_free_full_dnode(struct jffs2_full_dnode *);
378 struct jffs2_raw_dirent *jffs2_alloc_raw_dirent(void);
379 void jffs2_free_raw_dirent(struct jffs2_raw_dirent *);
380 struct jffs2_raw_inode *jffs2_alloc_raw_inode(void);
381 void jffs2_free_raw_inode(struct jffs2_raw_inode *);
382 struct jffs2_tmp_dnode_info *jffs2_alloc_tmp_dnode_info(void);
383 void jffs2_free_tmp_dnode_info(struct jffs2_tmp_dnode_info *);
384 struct jffs2_raw_node_ref *jffs2_alloc_raw_node_ref(void);
385 void jffs2_free_raw_node_ref(struct jffs2_raw_node_ref *);
386 struct jffs2_node_frag *jffs2_alloc_node_frag(void);
387 void jffs2_free_node_frag(struct jffs2_node_frag *);
388 struct jffs2_inode_cache *jffs2_alloc_inode_cache(void);
389 void jffs2_free_inode_cache(struct jffs2_inode_cache *);
390 #ifdef CONFIG_JFFS2_FS_XATTR
391 struct jffs2_xattr_datum *jffs2_alloc_xattr_datum(void);
392 void jffs2_free_xattr_datum(struct jffs2_xattr_datum *);
393 struct jffs2_xattr_ref *jffs2_alloc_xattr_ref(void);
394 void jffs2_free_xattr_ref(struct jffs2_xattr_ref *);
395 #endif
396
397 /* gc.c */
398 int jffs2_garbage_collect_pass(struct jffs2_sb_info *c);
399
400 /* read.c */
401 int jffs2_read_dnode(struct jffs2_sb_info *c, struct jffs2_inode_info *f,
402                      struct jffs2_full_dnode *fd, unsigned char *buf,
403                      int ofs, int len);
404 int jffs2_read_inode_range(struct jffs2_sb_info *c, struct jffs2_inode_info *f,
405                            unsigned char *buf, uint32_t offset, uint32_t len);
406 char *jffs2_getlink(struct jffs2_sb_info *c, struct jffs2_inode_info *f);
407
408 /* scan.c */
409 int jffs2_scan_medium(struct jffs2_sb_info *c);
410 void jffs2_rotate_lists(struct jffs2_sb_info *c);
411 int jffs2_fill_scan_buf(struct jffs2_sb_info *c, void *buf,
412                                 uint32_t ofs, uint32_t len);
413 struct jffs2_inode_cache *jffs2_scan_make_ino_cache(struct jffs2_sb_info *c, uint32_t ino);
414 int jffs2_scan_classify_jeb(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb);
415
416 /* build.c */
417 int jffs2_do_mount_fs(struct jffs2_sb_info *c);
418
419 /* erase.c */
420 void jffs2_erase_pending_blocks(struct jffs2_sb_info *c, int count);
421
422 #ifdef CONFIG_JFFS2_FS_WRITEBUFFER
423 /* wbuf.c */
424 int jffs2_flush_wbuf_gc(struct jffs2_sb_info *c, uint32_t ino);
425 int jffs2_flush_wbuf_pad(struct jffs2_sb_info *c);
426 int jffs2_check_nand_cleanmarker(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb);
427 int jffs2_write_nand_cleanmarker(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb);
428 #endif
429
430 #include "debug.h"
431
432 #endif /* __JFFS2_NODELIST_H__ */