blob: ce47d5530a70ce200e40c8de8d9b251e75a63afc [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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 *
Artem B. Bityutskiy3a69e0c2005-08-17 14:46:26 +010010 * $Id: nodelist.h,v 1.138 2005/08/17 13:46:23 dedekind Exp $
Linus Torvalds1da177e2005-04-16 15:20:36 -070011 *
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 <linux/jffs2_fs_sb.h>
22#include <linux/jffs2_fs_i.h>
23
24#ifdef __ECOS
25#include "os-ecos.h"
26#else
Artem B. Bityutskiy730554d2005-07-17 07:56:26 +010027#include <linux/mtd/compatmac.h> /* For compatibility with older kernels */
Linus Torvalds1da177e2005-04-16 15:20:36 -070028#include "os-linux.h"
29#endif
30
Linus Torvalds1da177e2005-04-16 15:20:36 -070031#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 je16_to_cpu(x) ((x).v16)
42#define je32_to_cpu(x) ((x).v32)
43#define jemode_to_cpu(x) (jffs2_to_os_mode((x).m))
44#elif defined(JFFS2_BIG_ENDIAN)
45#define cpu_to_je16(x) ((jint16_t){cpu_to_be16(x)})
46#define cpu_to_je32(x) ((jint32_t){cpu_to_be32(x)})
47#define cpu_to_jemode(x) ((jmode_t){cpu_to_be32(os_to_jffs2_mode(x))})
48
49#define je16_to_cpu(x) (be16_to_cpu(x.v16))
50#define je32_to_cpu(x) (be32_to_cpu(x.v32))
51#define jemode_to_cpu(x) (be32_to_cpu(jffs2_to_os_mode((x).m)))
52#elif defined(JFFS2_LITTLE_ENDIAN)
53#define cpu_to_je16(x) ((jint16_t){cpu_to_le16(x)})
54#define cpu_to_je32(x) ((jint32_t){cpu_to_le32(x)})
55#define cpu_to_jemode(x) ((jmode_t){cpu_to_le32(os_to_jffs2_mode(x))})
56
57#define je16_to_cpu(x) (le16_to_cpu(x.v16))
58#define je32_to_cpu(x) (le32_to_cpu(x.v32))
59#define jemode_to_cpu(x) (le32_to_cpu(jffs2_to_os_mode((x).m)))
60#else
61#error wibble
62#endif
63
Artem B. Bityutskiy1e0da3c2005-08-01 13:05:22 +010064/* The minimal node header size */
65#define JFFS2_MIN_NODE_HEADER sizeof(struct jffs2_raw_dirent)
66
Linus Torvalds1da177e2005-04-16 15:20:36 -070067/*
68 This is all we need to keep in-core for each raw node during normal
69 operation. As and when we do read_inode on a particular inode, we can
70 scan the nodes which are listed for it and build up a proper map of
71 which nodes are currently valid. JFFSv1 always used to keep that whole
72 map in core for each inode.
73*/
74struct jffs2_raw_node_ref
75{
76 struct jffs2_raw_node_ref *next_in_ino; /* Points to the next raw_node_ref
77 for this inode. If this is the last, it points to the inode_cache
78 for this inode instead. The inode_cache will have NULL in the first
79 word so you know when you've got there :) */
80 struct jffs2_raw_node_ref *next_phys;
81 uint32_t flash_offset;
82 uint32_t __totlen; /* This may die; use ref_totlen(c, jeb, ) below */
83};
84
85 /* flash_offset & 3 always has to be zero, because nodes are
86 always aligned at 4 bytes. So we have a couple of extra bits
87 to play with, which indicate the node's status; see below: */
88#define REF_UNCHECKED 0 /* We haven't yet checked the CRC or built its inode */
89#define REF_OBSOLETE 1 /* Obsolete, can be completely ignored */
90#define REF_PRISTINE 2 /* Completely clean. GC without looking */
91#define REF_NORMAL 3 /* Possibly overlapped. Read the page and write again on GC */
92#define ref_flags(ref) ((ref)->flash_offset & 3)
93#define ref_offset(ref) ((ref)->flash_offset & ~3)
94#define ref_obsolete(ref) (((ref)->flash_offset & 3) == REF_OBSOLETE)
95#define mark_ref_normal(ref) do { (ref)->flash_offset = ref_offset(ref) | REF_NORMAL; } while(0)
96
97/* For each inode in the filesystem, we need to keep a record of
98 nlink, because it would be a PITA to scan the whole directory tree
99 at read_inode() time to calculate it, and to keep sufficient information
100 in the raw_node_ref (basically both parent and child inode number for
101 dirent nodes) would take more space than this does. We also keep
102 a pointer to the first physical node which is part of this inode, too.
103*/
104struct jffs2_inode_cache {
105 struct jffs2_full_dirent *scan_dents; /* Used during scan to hold
106 temporary lists of dirents, and later must be set to
107 NULL to mark the end of the raw_node_ref->next_in_ino
108 chain. */
109 struct jffs2_inode_cache *next;
110 struct jffs2_raw_node_ref *nodes;
111 uint32_t ino;
112 int nlink;
113 int state;
114};
115
116/* Inode states for 'state' above. We need the 'GC' state to prevent
117 someone from doing a read_inode() while we're moving a 'REF_PRISTINE'
118 node without going through all the iget() nonsense */
119#define INO_STATE_UNCHECKED 0 /* CRC checks not yet done */
120#define INO_STATE_CHECKING 1 /* CRC checks in progress */
121#define INO_STATE_PRESENT 2 /* In core */
122#define INO_STATE_CHECKEDABSENT 3 /* Checked, cleared again */
123#define INO_STATE_GC 4 /* GCing a 'pristine' node */
124#define INO_STATE_READING 5 /* In read_inode() */
David Woodhouse67e345d2005-02-27 23:01:36 +0000125#define INO_STATE_CLEARING 6 /* In clear_inode() */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126
127#define INOCACHE_HASHSIZE 128
128
129/*
130 Larger representation of a raw node, kept in-core only when the
131 struct inode for this particular ino is instantiated.
132*/
133
134struct jffs2_full_dnode
135{
136 struct jffs2_raw_node_ref *raw;
137 uint32_t ofs; /* The offset to which the data of this node belongs */
138 uint32_t size;
139 uint32_t frags; /* Number of fragments which currently refer
140 to this node. When this reaches zero,
141 the node is obsolete. */
142};
143
144/*
145 Even larger representation of a raw node, kept in-core only while
146 we're actually building up the original map of which nodes go where,
147 in read_inode()
148*/
149struct jffs2_tmp_dnode_info
150{
David Woodhouse9dee7502005-07-05 22:03:10 +0100151 struct rb_node rb;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152 struct jffs2_full_dnode *fn;
153 uint32_t version;
Artem B. Bityutskiy1e0da3c2005-08-01 13:05:22 +0100154 uint32_t data_crc;
155 uint32_t partial_crc;
156 uint32_t csize;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157};
158
159struct jffs2_full_dirent
160{
161 struct jffs2_raw_node_ref *raw;
162 struct jffs2_full_dirent *next;
163 uint32_t version;
164 uint32_t ino; /* == zero for unlink */
165 unsigned int nhash;
166 unsigned char type;
167 unsigned char name[0];
168};
169
170/*
171 Fragments - used to build a map of which raw node to obtain
172 data from for each part of the ino
173*/
174struct jffs2_node_frag
175{
176 struct rb_node rb;
177 struct jffs2_full_dnode *node; /* NULL for holes */
178 uint32_t size;
179 uint32_t ofs; /* The offset to which this fragment belongs */
180};
181
182struct jffs2_eraseblock
183{
184 struct list_head list;
185 int bad_count;
186 uint32_t offset; /* of this block in the MTD */
187
188 uint32_t unchecked_size;
189 uint32_t used_size;
190 uint32_t dirty_size;
191 uint32_t wasted_size;
192 uint32_t free_size; /* Note that sector_size - free_size
193 is the address of the first free space */
194 struct jffs2_raw_node_ref *first_node;
195 struct jffs2_raw_node_ref *last_node;
196
197 struct jffs2_raw_node_ref *gc_node; /* Next node to be garbage collected */
198};
199
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200/* Calculate totlen from surrounding nodes or eraseblock */
201static inline uint32_t __ref_totlen(struct jffs2_sb_info *c,
202 struct jffs2_eraseblock *jeb,
203 struct jffs2_raw_node_ref *ref)
204{
205 uint32_t ref_end;
206
207 if (ref->next_phys)
208 ref_end = ref_offset(ref->next_phys);
209 else {
210 if (!jeb)
211 jeb = &c->blocks[ref->flash_offset / c->sector_size];
212
213 /* Last node in block. Use free_space */
214 BUG_ON(ref != jeb->last_node);
215 ref_end = jeb->offset + c->sector_size - jeb->free_size;
216 }
217 return ref_end - ref_offset(ref);
218}
219
220static 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 ret;
225
Artem B. Bityutskiy730554d2005-07-17 07:56:26 +0100226#if CONFIG_JFFS2_FS_DEBUG > 0
227 if (jeb && jeb != &c->blocks[ref->flash_offset / c->sector_size]) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228 printk(KERN_CRIT "ref_totlen called with wrong block -- at 0x%08x instead of 0x%08x; ref 0x%08x\n",
229 jeb->offset, c->blocks[ref->flash_offset / c->sector_size].offset, ref_offset(ref));
230 BUG();
Artem B. Bityutskiy730554d2005-07-17 07:56:26 +0100231 }
232#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233
234#if 1
235 ret = ref->__totlen;
236#else
237 /* This doesn't actually work yet */
238 ret = __ref_totlen(c, jeb, ref);
239 if (ret != ref->__totlen) {
240 printk(KERN_CRIT "Totlen for ref at %p (0x%08x-0x%08x) miscalculated as 0x%x instead of %x\n",
241 ref, ref_offset(ref), ref_offset(ref)+ref->__totlen,
242 ret, ref->__totlen);
243 if (!jeb)
244 jeb = &c->blocks[ref->flash_offset / c->sector_size];
Artem B. Bityutskiye0c8e422005-07-24 16:14:17 +0100245 jffs2_dbg_dump_node_refs_nolock(c, jeb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246 BUG();
247 }
248#endif
249 return ret;
250}
251
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252#define ALLOC_NORMAL 0 /* Normal allocation */
253#define ALLOC_DELETION 1 /* Deletion node. Best to allow it */
254#define ALLOC_GC 2 /* Space requested for GC. Give it or die */
255#define ALLOC_NORETRY 3 /* For jffs2_write_dnode: On failure, return -EAGAIN instead of retrying */
256
257/* How much dirty space before it goes on the very_dirty_list */
258#define VERYDIRTY(c, size) ((size) >= ((c)->sector_size / 2))
259
260/* check if dirty space is more than 255 Byte */
261#define ISDIRTY(size) ((size) > sizeof (struct jffs2_raw_inode) + JFFS2_MIN_DATA_LEN)
262
263#define PAD(x) (((x)+3)&~3)
264
265static inline struct jffs2_inode_cache *jffs2_raw_ref_to_ic(struct jffs2_raw_node_ref *raw)
266{
267 while(raw->next_in_ino) {
268 raw = raw->next_in_ino;
269 }
270
271 return ((struct jffs2_inode_cache *)raw);
272}
273
274static inline struct jffs2_node_frag *frag_first(struct rb_root *root)
275{
276 struct rb_node *node = root->rb_node;
277
278 if (!node)
279 return NULL;
280 while(node->rb_left)
281 node = node->rb_left;
282 return rb_entry(node, struct jffs2_node_frag, rb);
283}
Artem B. Bityuckiy8557fd52005-04-09 11:47:03 +0100284
285static inline struct jffs2_node_frag *frag_last(struct rb_root *root)
286{
287 struct rb_node *node = root->rb_node;
288
289 if (!node)
290 return NULL;
291 while(node->rb_right)
292 node = node->rb_right;
293 return rb_entry(node, struct jffs2_node_frag, rb);
294}
295
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296#define rb_parent(rb) ((rb)->rb_parent)
297#define frag_next(frag) rb_entry(rb_next(&(frag)->rb), struct jffs2_node_frag, rb)
298#define frag_prev(frag) rb_entry(rb_prev(&(frag)->rb), struct jffs2_node_frag, rb)
299#define frag_parent(frag) rb_entry(rb_parent(&(frag)->rb), struct jffs2_node_frag, rb)
300#define frag_left(frag) rb_entry((frag)->rb.rb_left, struct jffs2_node_frag, rb)
301#define frag_right(frag) rb_entry((frag)->rb.rb_right, struct jffs2_node_frag, rb)
302#define frag_erase(frag, list) rb_erase(&frag->rb, list);
303
304/* nodelist.c */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305void jffs2_add_fd_to_list(struct jffs2_sb_info *c, struct jffs2_full_dirent *new, struct jffs2_full_dirent **list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306void jffs2_set_inocache_state(struct jffs2_sb_info *c, struct jffs2_inode_cache *ic, int state);
307struct jffs2_inode_cache *jffs2_get_ino_cache(struct jffs2_sb_info *c, uint32_t ino);
308void jffs2_add_ino_cache (struct jffs2_sb_info *c, struct jffs2_inode_cache *new);
309void jffs2_del_ino_cache(struct jffs2_sb_info *c, struct jffs2_inode_cache *old);
310void jffs2_free_ino_caches(struct jffs2_sb_info *c);
311void jffs2_free_raw_node_refs(struct jffs2_sb_info *c);
312struct jffs2_node_frag *jffs2_lookup_node_frag(struct rb_root *fragtree, uint32_t offset);
313void jffs2_kill_fragtree(struct rb_root *root, struct jffs2_sb_info *c_delete);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314struct rb_node *rb_next(struct rb_node *);
315struct rb_node *rb_prev(struct rb_node *);
316void rb_replace_node(struct rb_node *victim, struct rb_node *new, struct rb_root *root);
Artem B. Bityutskiyf97117d2005-07-27 15:46:14 +0100317void jffs2_obsolete_node_frag(struct jffs2_sb_info *c, struct jffs2_node_frag *this);
318int jffs2_add_full_dnode_to_inode(struct jffs2_sb_info *c, struct jffs2_inode_info *f, struct jffs2_full_dnode *fn);
Artem B. Bityutskiy1e900972005-07-31 09:20:48 +0100319void jffs2_truncate_fragtree (struct jffs2_sb_info *c, struct rb_root *list, uint32_t size);
Artem B. Bityutskiy1e0da3c2005-08-01 13:05:22 +0100320int jffs2_add_older_frag_to_fragtree(struct jffs2_sb_info *c, struct jffs2_inode_info *f, struct jffs2_tmp_dnode_info *tn);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321
322/* nodemgmt.c */
323int jffs2_thread_should_wake(struct jffs2_sb_info *c);
324int jffs2_reserve_space(struct jffs2_sb_info *c, uint32_t minsize, uint32_t *ofs, uint32_t *len, int prio);
325int jffs2_reserve_space_gc(struct jffs2_sb_info *c, uint32_t minsize, uint32_t *ofs, uint32_t *len);
326int jffs2_add_physical_node_ref(struct jffs2_sb_info *c, struct jffs2_raw_node_ref *new);
327void jffs2_complete_reservation(struct jffs2_sb_info *c);
328void jffs2_mark_node_obsolete(struct jffs2_sb_info *c, struct jffs2_raw_node_ref *raw);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329
330/* write.c */
331int jffs2_do_new_inode(struct jffs2_sb_info *c, struct jffs2_inode_info *f, uint32_t mode, struct jffs2_raw_inode *ri);
332
333struct 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);
334struct 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);
335int jffs2_write_inode_range(struct jffs2_sb_info *c, struct jffs2_inode_info *f,
336 struct jffs2_raw_inode *ri, unsigned char *buf,
337 uint32_t offset, uint32_t writelen, uint32_t *retlen);
338int 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);
Artem B. Bityutskiy3a69e0c2005-08-17 14:46:26 +0100339int 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);
340int 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);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341
342
343/* readinode.c */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344int jffs2_do_read_inode(struct jffs2_sb_info *c, struct jffs2_inode_info *f,
345 uint32_t ino, struct jffs2_raw_inode *latest_node);
346int jffs2_do_crccheck_inode(struct jffs2_sb_info *c, struct jffs2_inode_cache *ic);
347void jffs2_do_clear_inode(struct jffs2_sb_info *c, struct jffs2_inode_info *f);
348
349/* malloc.c */
350int jffs2_create_slab_caches(void);
351void jffs2_destroy_slab_caches(void);
352
353struct jffs2_full_dirent *jffs2_alloc_full_dirent(int namesize);
354void jffs2_free_full_dirent(struct jffs2_full_dirent *);
355struct jffs2_full_dnode *jffs2_alloc_full_dnode(void);
356void jffs2_free_full_dnode(struct jffs2_full_dnode *);
357struct jffs2_raw_dirent *jffs2_alloc_raw_dirent(void);
358void jffs2_free_raw_dirent(struct jffs2_raw_dirent *);
359struct jffs2_raw_inode *jffs2_alloc_raw_inode(void);
360void jffs2_free_raw_inode(struct jffs2_raw_inode *);
361struct jffs2_tmp_dnode_info *jffs2_alloc_tmp_dnode_info(void);
362void jffs2_free_tmp_dnode_info(struct jffs2_tmp_dnode_info *);
363struct jffs2_raw_node_ref *jffs2_alloc_raw_node_ref(void);
364void jffs2_free_raw_node_ref(struct jffs2_raw_node_ref *);
365struct jffs2_node_frag *jffs2_alloc_node_frag(void);
366void jffs2_free_node_frag(struct jffs2_node_frag *);
367struct jffs2_inode_cache *jffs2_alloc_inode_cache(void);
368void jffs2_free_inode_cache(struct jffs2_inode_cache *);
369
370/* gc.c */
371int jffs2_garbage_collect_pass(struct jffs2_sb_info *c);
372
373/* read.c */
374int jffs2_read_dnode(struct jffs2_sb_info *c, struct jffs2_inode_info *f,
375 struct jffs2_full_dnode *fd, unsigned char *buf,
376 int ofs, int len);
377int jffs2_read_inode_range(struct jffs2_sb_info *c, struct jffs2_inode_info *f,
378 unsigned char *buf, uint32_t offset, uint32_t len);
379char *jffs2_getlink(struct jffs2_sb_info *c, struct jffs2_inode_info *f);
380
381/* scan.c */
382int jffs2_scan_medium(struct jffs2_sb_info *c);
383void jffs2_rotate_lists(struct jffs2_sb_info *c);
384
385/* build.c */
386int jffs2_do_mount_fs(struct jffs2_sb_info *c);
387
388/* erase.c */
389void jffs2_erase_pending_blocks(struct jffs2_sb_info *c, int count);
390
Andrew Victor2f82ce12005-02-09 09:24:26 +0000391#ifdef CONFIG_JFFS2_FS_WRITEBUFFER
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392/* wbuf.c */
393int jffs2_flush_wbuf_gc(struct jffs2_sb_info *c, uint32_t ino);
394int jffs2_flush_wbuf_pad(struct jffs2_sb_info *c);
395int jffs2_check_nand_cleanmarker(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb);
396int jffs2_write_nand_cleanmarker(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb);
397#endif
398
Artem B. Bityutskiy730554d2005-07-17 07:56:26 +0100399#include "debug.h"
400
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401#endif /* __JFFS2_NODELIST_H__ */