Commit | Line | Data |
---|---|---|
1da177e4 LT |
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 | * | |
3a69e0cd | 10 | * $Id: nodelist.h,v 1.138 2005/08/17 13:46:23 dedekind Exp $ |
1da177e4 LT |
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 <linux/jffs2_fs_sb.h> | |
22 | #include <linux/jffs2_fs_i.h> | |
23 | ||
24 | #ifdef __ECOS | |
25 | #include "os-ecos.h" | |
26 | #else | |
730554d9 | 27 | #include <linux/mtd/compatmac.h> /* For compatibility with older kernels */ |
1da177e4 LT |
28 | #include "os-linux.h" |
29 | #endif | |
30 | ||
1da177e4 LT |
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 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 | ||
1e0da3cb AB |
64 | /* The minimal node header size */ |
65 | #define JFFS2_MIN_NODE_HEADER sizeof(struct jffs2_raw_dirent) | |
66 | ||
1da177e4 LT |
67 | /* |
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 | */ | |
74 | struct 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 | */ | |
104 | struct 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() */ | |
67e345d1 | 125 | #define INO_STATE_CLEARING 6 /* In clear_inode() */ |
1da177e4 LT |
126 | |
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 | ||
134 | struct 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 | */ | |
149 | struct jffs2_tmp_dnode_info | |
150 | { | |
9dee7503 | 151 | struct rb_node rb; |
1da177e4 LT |
152 | struct jffs2_full_dnode *fn; |
153 | uint32_t version; | |
1e0da3cb AB |
154 | uint32_t data_crc; |
155 | uint32_t partial_crc; | |
156 | uint32_t csize; | |
1da177e4 LT |
157 | }; |
158 | ||
159 | struct 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 | */ | |
174 | struct 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 | ||
182 | struct 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 | ||
1da177e4 LT |
200 | /* Calculate totlen from surrounding nodes or eraseblock */ |
201 | static 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 | ||
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 ret; | |
225 | ||
730554d9 AB |
226 | #if CONFIG_JFFS2_FS_DEBUG > 0 |
227 | if (jeb && jeb != &c->blocks[ref->flash_offset / c->sector_size]) { | |
1da177e4 LT |
228 | 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(); | |
730554d9 AB |
231 | } |
232 | #endif | |
1da177e4 LT |
233 | |
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]; | |
e0c8e42f | 245 | jffs2_dbg_dump_node_refs_nolock(c, jeb); |
1da177e4 LT |
246 | BUG(); |
247 | } | |
248 | #endif | |
249 | return ret; | |
250 | } | |
251 | ||
1da177e4 LT |
252 | #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 | ||
265 | static 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 | ||
274 | static 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 | } | |
8557fd51 AB |
284 | |
285 | static 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 | ||
1da177e4 LT |
296 | #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 */ | |
1da177e4 | 305 | void jffs2_add_fd_to_list(struct jffs2_sb_info *c, struct jffs2_full_dirent *new, struct jffs2_full_dirent **list); |
1da177e4 LT |
306 | void jffs2_set_inocache_state(struct jffs2_sb_info *c, struct jffs2_inode_cache *ic, int state); |
307 | struct jffs2_inode_cache *jffs2_get_ino_cache(struct jffs2_sb_info *c, uint32_t ino); | |
308 | void jffs2_add_ino_cache (struct jffs2_sb_info *c, struct jffs2_inode_cache *new); | |
309 | void jffs2_del_ino_cache(struct jffs2_sb_info *c, struct jffs2_inode_cache *old); | |
310 | void jffs2_free_ino_caches(struct jffs2_sb_info *c); | |
311 | void jffs2_free_raw_node_refs(struct jffs2_sb_info *c); | |
312 | struct jffs2_node_frag *jffs2_lookup_node_frag(struct rb_root *fragtree, uint32_t offset); | |
313 | void jffs2_kill_fragtree(struct rb_root *root, struct jffs2_sb_info *c_delete); | |
1da177e4 LT |
314 | struct rb_node *rb_next(struct rb_node *); |
315 | struct rb_node *rb_prev(struct rb_node *); | |
316 | void rb_replace_node(struct rb_node *victim, struct rb_node *new, struct rb_root *root); | |
f97117d1 AB |
317 | void jffs2_obsolete_node_frag(struct jffs2_sb_info *c, struct jffs2_node_frag *this); |
318 | int jffs2_add_full_dnode_to_inode(struct jffs2_sb_info *c, struct jffs2_inode_info *f, struct jffs2_full_dnode *fn); | |
1e900979 | 319 | void jffs2_truncate_fragtree (struct jffs2_sb_info *c, struct rb_root *list, uint32_t size); |
1e0da3cb | 320 | int jffs2_add_older_frag_to_fragtree(struct jffs2_sb_info *c, struct jffs2_inode_info *f, struct jffs2_tmp_dnode_info *tn); |
1da177e4 LT |
321 | |
322 | /* nodemgmt.c */ | |
323 | int jffs2_thread_should_wake(struct jffs2_sb_info *c); | |
324 | int jffs2_reserve_space(struct jffs2_sb_info *c, uint32_t minsize, uint32_t *ofs, uint32_t *len, int prio); | |
325 | int jffs2_reserve_space_gc(struct jffs2_sb_info *c, uint32_t minsize, uint32_t *ofs, uint32_t *len); | |
326 | int jffs2_add_physical_node_ref(struct jffs2_sb_info *c, struct jffs2_raw_node_ref *new); | |
327 | void jffs2_complete_reservation(struct jffs2_sb_info *c); | |
328 | void jffs2_mark_node_obsolete(struct jffs2_sb_info *c, struct jffs2_raw_node_ref *raw); | |
1da177e4 LT |
329 | |
330 | /* write.c */ | |
331 | int jffs2_do_new_inode(struct jffs2_sb_info *c, struct jffs2_inode_info *f, uint32_t mode, struct jffs2_raw_inode *ri); | |
332 | ||
333 | 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); | |
334 | 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); | |
335 | int 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); | |
338 | 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); | |
3a69e0cd AB |
339 | 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); |
340 | 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); | |
1da177e4 LT |
341 | |
342 | ||
343 | /* readinode.c */ | |
1da177e4 LT |
344 | int jffs2_do_read_inode(struct jffs2_sb_info *c, struct jffs2_inode_info *f, |
345 | uint32_t ino, struct jffs2_raw_inode *latest_node); | |
346 | int jffs2_do_crccheck_inode(struct jffs2_sb_info *c, struct jffs2_inode_cache *ic); | |
347 | void jffs2_do_clear_inode(struct jffs2_sb_info *c, struct jffs2_inode_info *f); | |
348 | ||
349 | /* malloc.c */ | |
350 | int jffs2_create_slab_caches(void); | |
351 | void jffs2_destroy_slab_caches(void); | |
352 | ||
353 | struct jffs2_full_dirent *jffs2_alloc_full_dirent(int namesize); | |
354 | void jffs2_free_full_dirent(struct jffs2_full_dirent *); | |
355 | struct jffs2_full_dnode *jffs2_alloc_full_dnode(void); | |
356 | void jffs2_free_full_dnode(struct jffs2_full_dnode *); | |
357 | struct jffs2_raw_dirent *jffs2_alloc_raw_dirent(void); | |
358 | void jffs2_free_raw_dirent(struct jffs2_raw_dirent *); | |
359 | struct jffs2_raw_inode *jffs2_alloc_raw_inode(void); | |
360 | void jffs2_free_raw_inode(struct jffs2_raw_inode *); | |
361 | struct jffs2_tmp_dnode_info *jffs2_alloc_tmp_dnode_info(void); | |
362 | void jffs2_free_tmp_dnode_info(struct jffs2_tmp_dnode_info *); | |
363 | struct jffs2_raw_node_ref *jffs2_alloc_raw_node_ref(void); | |
364 | void jffs2_free_raw_node_ref(struct jffs2_raw_node_ref *); | |
365 | struct jffs2_node_frag *jffs2_alloc_node_frag(void); | |
366 | void jffs2_free_node_frag(struct jffs2_node_frag *); | |
367 | struct jffs2_inode_cache *jffs2_alloc_inode_cache(void); | |
368 | void jffs2_free_inode_cache(struct jffs2_inode_cache *); | |
369 | ||
370 | /* gc.c */ | |
371 | int jffs2_garbage_collect_pass(struct jffs2_sb_info *c); | |
372 | ||
373 | /* read.c */ | |
374 | int 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); | |
377 | int jffs2_read_inode_range(struct jffs2_sb_info *c, struct jffs2_inode_info *f, | |
378 | unsigned char *buf, uint32_t offset, uint32_t len); | |
379 | char *jffs2_getlink(struct jffs2_sb_info *c, struct jffs2_inode_info *f); | |
380 | ||
381 | /* scan.c */ | |
382 | int jffs2_scan_medium(struct jffs2_sb_info *c); | |
383 | void jffs2_rotate_lists(struct jffs2_sb_info *c); | |
384 | ||
385 | /* build.c */ | |
386 | int jffs2_do_mount_fs(struct jffs2_sb_info *c); | |
387 | ||
388 | /* erase.c */ | |
389 | void jffs2_erase_pending_blocks(struct jffs2_sb_info *c, int count); | |
390 | ||
2f82ce1e | 391 | #ifdef CONFIG_JFFS2_FS_WRITEBUFFER |
1da177e4 LT |
392 | /* wbuf.c */ |
393 | int jffs2_flush_wbuf_gc(struct jffs2_sb_info *c, uint32_t ino); | |
394 | int jffs2_flush_wbuf_pad(struct jffs2_sb_info *c); | |
395 | int jffs2_check_nand_cleanmarker(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb); | |
396 | int jffs2_write_nand_cleanmarker(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb); | |
397 | #endif | |
398 | ||
730554d9 AB |
399 | #include "debug.h" |
400 | ||
1da177e4 | 401 | #endif /* __JFFS2_NODELIST_H__ */ |