v2.4.9.9 -> v2.4.9.10
[opensuse:kernel.git] / fs / jffs2 / nodelist.h
1 /*
2  * JFFS2 -- Journalling Flash File System, Version 2.
3  *
4  * Copyright (C) 2001 Red Hat, Inc.
5  *
6  * Created by David Woodhouse <dwmw2@cambridge.redhat.com>
7  *
8  * The original JFFS, from which the design for JFFS2 was derived,
9  * was designed and implemented by Axis Communications AB.
10  *
11  * The contents of this file are subject to the Red Hat eCos Public
12  * License Version 1.1 (the "Licence"); you may not use this file
13  * except in compliance with the Licence.  You may obtain a copy of
14  * the Licence at http://www.redhat.com/
15  *
16  * Software distributed under the Licence is distributed on an "AS IS"
17  * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied.
18  * See the Licence for the specific language governing rights and
19  * limitations under the Licence.
20  *
21  * The Original Code is JFFS2 - Journalling Flash File System, version 2
22  *
23  * Alternatively, the contents of this file may be used under the
24  * terms of the GNU General Public License version 2 (the "GPL"), in
25  * which case the provisions of the GPL are applicable instead of the
26  * above.  If you wish to allow the use of your version of this file
27  * only under the terms of the GPL and not to allow others to use your
28  * version of this file under the RHEPL, indicate your decision by
29  * deleting the provisions above and replace them with the notice and
30  * other provisions required by the GPL.  If you do not delete the
31  * provisions above, a recipient may use your version of this file
32  * under either the RHEPL or the GPL.
33  *
34  * $Id: nodelist.h,v 1.45 2001/03/20 17:43:57 dwmw2 Exp $
35  *
36  */
37
38 #include <linux/config.h>
39 #include <linux/fs.h>
40
41 #include <linux/jffs2_fs_sb.h>
42 #include <linux/jffs2_fs_i.h>
43
44 #ifndef CONFIG_JFFS2_FS_DEBUG
45 #define CONFIG_JFFS2_FS_DEBUG 2
46 #endif
47
48 #if CONFIG_JFFS2_FS_DEBUG > 0
49 #define D1(x) x
50 #else
51 #define D1(x)
52 #endif
53
54 #if CONFIG_JFFS2_FS_DEBUG > 1
55 #define D2(x) x
56 #else
57 #define D2(x)
58 #endif
59
60 /*
61   This is all we need to keep in-core for each raw node during normal
62   operation. As and when we do read_inode on a particular inode, we can
63   scan the nodes which are listed for it and build up a proper map of 
64   which nodes are currently valid. JFFSv1 always used to keep that whole
65   map in core for each inode.
66 */
67 struct jffs2_raw_node_ref
68 {
69         struct jffs2_raw_node_ref *next_in_ino; /* Points to the next raw_node_ref
70                 for this inode. If this is the last, it points to the inode_cache
71                 for this inode instead. The inode_cache will have NULL in the first
72                 word so you know when you've got there :) */
73         struct jffs2_raw_node_ref *next_phys;
74         //      __u32 ino;
75         __u32 flash_offset;
76         __u32 totlen;
77 //      __u16 nodetype;
78         
79         /* flash_offset & 3 always has to be zero, because nodes are
80            always aligned at 4 bytes. So we have a couple of extra bits
81            to play with. So we set the least significant bit to 1 to
82            signify that the node is obsoleted by later nodes.
83         */
84 };
85
86 /* 
87    Used for keeping track of deletion nodes &c, which can only be marked
88    as obsolete when the node which they mark as deleted has actually been 
89    removed from the flash.
90 */
91 struct jffs2_raw_node_ref_list {
92         struct jffs2_raw_node_ref *rew;
93         struct jffs2_raw_node_ref_list *next;
94 };
95
96 /* For each inode in the filesystem, we need to keep a record of
97    nlink, because it would be a PITA to scan the whole directory tree
98    at read_inode() time to calculate it, and to keep sufficient information
99    in the raw_node_ref (basically both parent and child inode number for 
100    dirent nodes) would take more space than this does. We also keep
101    a pointer to the first physical node which is part of this inode, too.
102 */
103 struct jffs2_inode_cache {
104         struct jffs2_scan_info *scan; /* Used during scan to hold
105                 temporary lists of nodes, and later must be set to
106                 NULL to mark the end of the raw_node_ref->next_in_ino
107                 chain. */
108         struct jffs2_inode_cache *next;
109         struct jffs2_raw_node_ref *nodes;
110         __u32 ino;
111         int nlink;
112 };
113
114 struct jffs2_scan_info {
115         struct jffs2_full_dirent *dents;
116         struct jffs2_tmp_dnode_info *tmpnodes;
117 };
118 /*
119   Larger representation of a raw node, kept in-core only when the 
120   struct inode for this particular ino is instantiated.
121 */
122
123 struct jffs2_full_dnode
124 {
125         struct jffs2_raw_node_ref *raw;
126         __u32 ofs; /* Don't really need this, but optimisation */
127         __u32 size;
128         __u32 frags; /* Number of fragments which currently refer
129                         to this node. When this reaches zero, 
130                         the node is obsolete.
131                      */
132 };
133
134 /* 
135    Even larger representation of a raw node, kept in-core only while
136    we're actually building up the original map of which nodes go where,
137    in read_inode()
138 */
139 struct jffs2_tmp_dnode_info
140 {
141         struct jffs2_tmp_dnode_info *next;
142         struct jffs2_full_dnode *fn;
143         __u32 version;
144 };       
145
146 struct jffs2_full_dirent
147 {
148         struct jffs2_raw_node_ref *raw;
149         struct jffs2_full_dirent *next;
150         __u32 version;
151         __u32 ino; /* == zero for unlink */
152         unsigned int nhash;
153         unsigned char type;
154         unsigned char name[0];
155 };
156 /*
157   Fragments - used to build a map of which raw node to obtain 
158   data from for each part of the ino
159 */
160 struct jffs2_node_frag
161 {
162         struct jffs2_node_frag *next;
163         struct jffs2_full_dnode *node; /* NULL for holes */
164         __u32 size;
165         __u32 ofs; /* Don't really need this, but optimisation */
166         __u32 node_ofs; /* offset within the physical node */
167 };
168
169 struct jffs2_eraseblock
170 {
171         struct list_head list;
172         int bad_count;
173         __u32 offset;           /* of this block in the MTD */
174
175         __u32 used_size;
176         __u32 dirty_size;
177         __u32 free_size;        /* Note that sector_size - free_size
178                                    is the address of the first free space */
179         struct jffs2_raw_node_ref *first_node;
180         struct jffs2_raw_node_ref *last_node;
181
182         struct jffs2_raw_node_ref *gc_node;     /* Next node to be garbage collected */
183
184         /* For deletia. When a dirent node in this eraseblock is
185            deleted by a node elsewhere, that other node can only 
186            be marked as obsolete when this block is actually erased.
187            So we keep a list of the nodes to mark as obsolete when
188            the erase is completed.
189         */
190         // MAYBE        struct jffs2_raw_node_ref_list *deletia;
191 };
192
193 #define ACCT_SANITY_CHECK(c, jeb) do { \
194         if (jeb->used_size + jeb->dirty_size + jeb->free_size != c->sector_size) { \
195                 printk(KERN_NOTICE "Eeep. Space accounting for block at 0x%08x is screwed\n", jeb->offset); \
196                 printk(KERN_NOTICE "free 0x%08x + dirty 0x%08x + used %08x != total %08x\n", \
197                 jeb->free_size, jeb->dirty_size, jeb->used_size, c->sector_size); \
198                 BUG(); \
199         } \
200         if (c->used_size + c->dirty_size + c->free_size + c->erasing_size + c->bad_size != c->flash_size) { \
201                 printk(KERN_NOTICE "Eeep. Space accounting superblock info is screwed\n"); \
202                 printk(KERN_NOTICE "free 0x%08x + dirty 0x%08x + used %08x + erasing %08x + bad %08x != total %08x\n", \
203                 c->free_size, c->dirty_size, c->used_size, c->erasing_size, c->bad_size, c->flash_size); \
204                 BUG(); \
205         } \
206 } while(0)
207
208 #define ACCT_PARANOIA_CHECK(jeb) do { \
209                 __u32 my_used_size = 0; \
210                 struct jffs2_raw_node_ref *ref2 = jeb->first_node; \
211                 while (ref2) { \
212                         if (!(ref2->flash_offset & 1)) \
213                                 my_used_size += ref2->totlen; \
214                         ref2 = ref2->next_phys; \
215                 } \
216                 if (my_used_size != jeb->used_size) { \
217                         printk(KERN_NOTICE "Calculated used size %08x != stored used size %08x\n", my_used_size, jeb->used_size); \
218                         BUG(); \
219                 } \
220         } while(0)
221
222 #define ALLOC_NORMAL    0       /* Normal allocation */
223 #define ALLOC_DELETION  1       /* Deletion node. Best to allow it */
224 #define ALLOC_GC        2       /* Space requested for GC. Give it or die */
225
226 #define JFFS2_RESERVED_BLOCKS_BASE 3                                            /* Number of free blocks there must be before we... */
227 #define JFFS2_RESERVED_BLOCKS_WRITE (JFFS2_RESERVED_BLOCKS_BASE + 2)            /* ... allow a normal filesystem write */
228 #define JFFS2_RESERVED_BLOCKS_DELETION (JFFS2_RESERVED_BLOCKS_BASE + 1)         /* ... allow a normal filesystem deletion */
229 #define JFFS2_RESERVED_BLOCKS_GCTRIGGER (JFFS2_RESERVED_BLOCKS_BASE + 3)        /* ... wake up the GC thread */
230 #define JFFS2_RESERVED_BLOCKS_GCBAD (JFFS2_RESERVED_BLOCKS_BASE + 1)            /* ... pick a block from the bad_list to GC */
231 #define JFFS2_RESERVED_BLOCKS_GCMERGE (JFFS2_RESERVED_BLOCKS_BASE)              /* ... merge pages when garbage collecting */
232
233
234 #define PAD(x) (((x)+3)&~3)
235
236 /* These probably ought to be somewhere central. */
237 //#define min(x,y) ({ typeof((x)) _x = (x); typeof((y)) _y = (y); (_x>_y)?_y:_x; })
238 //#define max(x,y) ({ typeof((x)) _x = (x); typeof((y)) _y = (y); (_x>_y)?_x:_y; })
239
240 static inline int jffs2_raw_ref_to_inum(struct jffs2_raw_node_ref *raw)
241 {
242         while(raw->next_in_ino) {
243                 raw = raw->next_in_ino;
244         }
245
246         return ((struct jffs2_inode_cache *)raw)->ino;
247 }
248
249 /* nodelist.c */
250 D1(void jffs2_print_frag_list(struct jffs2_inode_info *f));
251 void jffs2_add_fd_to_list(struct jffs2_sb_info *c, struct jffs2_full_dirent *new, struct jffs2_full_dirent **list);
252 void jffs2_add_tn_to_list(struct jffs2_tmp_dnode_info *tn, struct jffs2_tmp_dnode_info **list);
253 int jffs2_get_inode_nodes(struct jffs2_sb_info *c, ino_t ino, struct jffs2_inode_info *f,
254                           struct jffs2_tmp_dnode_info **tnp, struct jffs2_full_dirent **fdp,
255                           __u32 *highest_version);
256 struct jffs2_inode_cache *jffs2_get_ino_cache(struct jffs2_sb_info *c, int ino);
257 void jffs2_add_ino_cache (struct jffs2_sb_info *c, struct jffs2_inode_cache *new);
258 void jffs2_del_ino_cache(struct jffs2_sb_info *c, struct jffs2_inode_cache *old);
259 void jffs2_free_ino_caches(struct jffs2_sb_info *c);
260 void jffs2_free_raw_node_refs(struct jffs2_sb_info *c);
261
262 /* nodemgmt.c */
263 int jffs2_reserve_space(struct jffs2_sb_info *c, __u32 minsize, __u32 *ofs, __u32 *len, int prio);
264 int jffs2_reserve_space_gc(struct jffs2_sb_info *c, __u32 minsize, __u32 *ofs, __u32 *len);
265 int jffs2_add_physical_node_ref(struct jffs2_sb_info *c, struct jffs2_raw_node_ref *new, __u32 len, int dirty);
266 void jffs2_complete_reservation(struct jffs2_sb_info *c);
267 void jffs2_mark_node_obsolete(struct jffs2_sb_info *c, struct jffs2_raw_node_ref *raw);
268
269 /* write.c */
270 struct inode *jffs2_new_inode (struct inode *dir_i, int mode, struct jffs2_raw_inode *ri);
271 struct jffs2_full_dnode *jffs2_write_dnode(struct inode *inode, struct jffs2_raw_inode *ri, const unsigned char *data, __u32 datalen, __u32 flash_ofs,  __u32 *writelen);
272 struct jffs2_full_dirent *jffs2_write_dirent(struct inode *inode, struct jffs2_raw_dirent *rd, const unsigned char *name, __u32 namelen, __u32 flash_ofs,  __u32 *writelen);
273
274 /* readinode.c */
275 void jffs2_truncate_fraglist (struct jffs2_sb_info *c, struct jffs2_node_frag **list, __u32 size);
276 int jffs2_add_full_dnode_to_fraglist(struct jffs2_sb_info *c, struct jffs2_node_frag **list, struct jffs2_full_dnode *fn);
277 int jffs2_add_full_dnode_to_inode(struct jffs2_sb_info *c, struct jffs2_inode_info *f, struct jffs2_full_dnode *fn);
278 void jffs2_read_inode (struct inode *);
279 void jffs2_clear_inode (struct inode *);
280
281 /* malloc.c */
282 void jffs2_free_tmp_dnode_info_list(struct jffs2_tmp_dnode_info *tn);
283 void jffs2_free_full_dirent_list(struct jffs2_full_dirent *fd);
284
285 int jffs2_create_slab_caches(void);
286 void jffs2_destroy_slab_caches(void);
287
288 struct jffs2_full_dirent *jffs2_alloc_full_dirent(int namesize);
289 void jffs2_free_full_dirent(struct jffs2_full_dirent *);
290 struct jffs2_full_dnode *jffs2_alloc_full_dnode(void);
291 void jffs2_free_full_dnode(struct jffs2_full_dnode *);
292 struct jffs2_raw_dirent *jffs2_alloc_raw_dirent(void);
293 void jffs2_free_raw_dirent(struct jffs2_raw_dirent *);
294 struct jffs2_raw_inode *jffs2_alloc_raw_inode(void);
295 void jffs2_free_raw_inode(struct jffs2_raw_inode *);
296 struct jffs2_tmp_dnode_info *jffs2_alloc_tmp_dnode_info(void);
297 void jffs2_free_tmp_dnode_info(struct jffs2_tmp_dnode_info *);
298 struct jffs2_raw_node_ref *jffs2_alloc_raw_node_ref(void);
299 void jffs2_free_raw_node_ref(struct jffs2_raw_node_ref *);
300 struct jffs2_node_frag *jffs2_alloc_node_frag(void);
301 void jffs2_free_node_frag(struct jffs2_node_frag *);
302 struct jffs2_inode_cache *jffs2_alloc_inode_cache(void);
303 void jffs2_free_inode_cache(struct jffs2_inode_cache *);
304
305 /* gc.c */
306 int jffs2_garbage_collect_pass(struct jffs2_sb_info *c);
307
308 /* background.c */
309 int jffs2_start_garbage_collect_thread(struct jffs2_sb_info *c);
310 void jffs2_stop_garbage_collect_thread(struct jffs2_sb_info *c);
311 void jffs2_garbage_collect_trigger(struct jffs2_sb_info *c);
312
313 /* dir.c */
314 extern struct file_operations jffs2_dir_operations;
315 extern struct inode_operations jffs2_dir_inode_operations;
316
317 /* file.c */
318 extern struct file_operations jffs2_file_operations;
319 extern struct inode_operations jffs2_file_inode_operations;
320 extern struct address_space_operations jffs2_file_address_operations;
321 int jffs2_null_fsync(struct file *, struct dentry *, int);
322 int jffs2_setattr (struct dentry *dentry, struct iattr *iattr);
323 int jffs2_do_readpage_nolock (struct inode *inode, struct page *pg);
324 int jffs2_do_readpage_unlock (struct inode *inode, struct page *pg);
325 int jffs2_readpage (struct file *, struct page *);
326 int jffs2_prepare_write (struct file *, struct page *, unsigned, unsigned);
327 int jffs2_commit_write (struct file *, struct page *, unsigned, unsigned);
328
329 /* ioctl.c */
330 int jffs2_ioctl(struct inode *, struct file *, unsigned int, unsigned long);
331
332 /* read.c */
333 int jffs2_read_dnode(struct jffs2_sb_info *c, struct jffs2_full_dnode *fd, unsigned char *buf, int ofs, int len);
334
335 /* compr.c */
336 unsigned char jffs2_compress(unsigned char *data_in, unsigned char *cpage_out, 
337                              __u32 *datalen, __u32 *cdatalen);
338 int jffs2_decompress(unsigned char comprtype, unsigned char *cdata_in, 
339                      unsigned char *data_out, __u32 cdatalen, __u32 datalen);
340
341 /* scan.c */
342 int jffs2_scan_medium(struct jffs2_sb_info *c);
343
344 /* build.c */
345 int jffs2_build_filesystem(struct jffs2_sb_info *c);
346
347 /* symlink.c */
348 extern struct inode_operations jffs2_symlink_inode_operations;
349
350 /* erase.c */
351 void jffs2_erase_block(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb);
352 void jffs2_erase_pending_blocks(struct jffs2_sb_info *c);
353 void jffs2_mark_erased_blocks(struct jffs2_sb_info *c);
354 void jffs2_erase_pending_trigger(struct jffs2_sb_info *c);