fat: Remove FAT Directory Bread message
[linux-2.6.git] / fs / yaffs2 / yaffs_verify.c
1 /*
2  * YAFFS: Yet Another Flash File System. A NAND-flash specific file system.
3  *
4  * Copyright (C) 2002-2010 Aleph One Ltd.
5  *   for Toby Churchill Ltd and Brightstar Engineering
6  *
7  * Created by Charles Manning <charles@aleph1.co.uk>
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License version 2 as
11  * published by the Free Software Foundation.
12  */
13
14 #include "yaffs_verify.h"
15 #include "yaffs_trace.h"
16 #include "yaffs_bitmap.h"
17 #include "yaffs_getblockinfo.h"
18 #include "yaffs_nand.h"
19
20 int yaffs_skip_verification(struct yaffs_dev *dev)
21 {
22         dev = dev;
23         return !(yaffs_trace_mask &
24                  (YAFFS_TRACE_VERIFY | YAFFS_TRACE_VERIFY_FULL));
25 }
26
27 static int yaffs_skip_full_verification(struct yaffs_dev *dev)
28 {
29         dev = dev;
30         return !(yaffs_trace_mask & (YAFFS_TRACE_VERIFY_FULL));
31 }
32
33 static int yaffs_skip_nand_verification(struct yaffs_dev *dev)
34 {
35         dev = dev;
36         return !(yaffs_trace_mask & (YAFFS_TRACE_VERIFY_NAND));
37 }
38
39 static const char *block_state_name[] = {
40         "Unknown",
41         "Needs scanning",
42         "Scanning",
43         "Empty",
44         "Allocating",
45         "Full",
46         "Dirty",
47         "Checkpoint",
48         "Collecting",
49         "Dead"
50 };
51
52 void yaffs_verify_blk(struct yaffs_dev *dev, struct yaffs_block_info *bi, int n)
53 {
54         int actually_used;
55         int in_use;
56
57         if (yaffs_skip_verification(dev))
58                 return;
59
60         /* Report illegal runtime states */
61         if (bi->block_state >= YAFFS_NUMBER_OF_BLOCK_STATES)
62                 yaffs_trace(YAFFS_TRACE_VERIFY,
63                         "Block %d has undefined state %d",
64                         n, bi->block_state);
65
66         switch (bi->block_state) {
67         case YAFFS_BLOCK_STATE_UNKNOWN:
68         case YAFFS_BLOCK_STATE_SCANNING:
69         case YAFFS_BLOCK_STATE_NEEDS_SCANNING:
70                 yaffs_trace(YAFFS_TRACE_VERIFY,
71                         "Block %d has bad run-state %s",
72                         n, block_state_name[bi->block_state]);
73         }
74
75         /* Check pages in use and soft deletions are legal */
76
77         actually_used = bi->pages_in_use - bi->soft_del_pages;
78
79         if (bi->pages_in_use < 0
80             || bi->pages_in_use > dev->param.chunks_per_block
81             || bi->soft_del_pages < 0
82             || bi->soft_del_pages > dev->param.chunks_per_block
83             || actually_used < 0 || actually_used > dev->param.chunks_per_block)
84                 yaffs_trace(YAFFS_TRACE_VERIFY,
85                         "Block %d has illegal values pages_in_used %d soft_del_pages %d",
86                         n, bi->pages_in_use, bi->soft_del_pages);
87
88         /* Check chunk bitmap legal */
89         in_use = yaffs_count_chunk_bits(dev, n);
90         if (in_use != bi->pages_in_use)
91                 yaffs_trace(YAFFS_TRACE_VERIFY,
92                         "Block %d has inconsistent values pages_in_use %d counted chunk bits %d",
93                         n, bi->pages_in_use, in_use);
94
95 }
96
97 void yaffs_verify_collected_blk(struct yaffs_dev *dev,
98                                 struct yaffs_block_info *bi, int n)
99 {
100         yaffs_verify_blk(dev, bi, n);
101
102         /* After collection the block should be in the erased state */
103
104         if (bi->block_state != YAFFS_BLOCK_STATE_COLLECTING &&
105             bi->block_state != YAFFS_BLOCK_STATE_EMPTY) {
106                 yaffs_trace(YAFFS_TRACE_ERROR,
107                         "Block %d is in state %d after gc, should be erased",
108                         n, bi->block_state);
109         }
110 }
111
112 void yaffs_verify_blocks(struct yaffs_dev *dev)
113 {
114         int i;
115         int state_count[YAFFS_NUMBER_OF_BLOCK_STATES];
116         int illegal_states = 0;
117
118         if (yaffs_skip_verification(dev))
119                 return;
120
121         memset(state_count, 0, sizeof(state_count));
122
123         for (i = dev->internal_start_block; i <= dev->internal_end_block; i++) {
124                 struct yaffs_block_info *bi = yaffs_get_block_info(dev, i);
125                 yaffs_verify_blk(dev, bi, i);
126
127                 if (bi->block_state < YAFFS_NUMBER_OF_BLOCK_STATES)
128                         state_count[bi->block_state]++;
129                 else
130                         illegal_states++;
131         }
132
133         yaffs_trace(YAFFS_TRACE_VERIFY, "Block summary");
134
135         yaffs_trace(YAFFS_TRACE_VERIFY,
136                 "%d blocks have illegal states",
137                 illegal_states);
138         if (state_count[YAFFS_BLOCK_STATE_ALLOCATING] > 1)
139                 yaffs_trace(YAFFS_TRACE_VERIFY,
140                         "Too many allocating blocks");
141
142         for (i = 0; i < YAFFS_NUMBER_OF_BLOCK_STATES; i++)
143                 yaffs_trace(YAFFS_TRACE_VERIFY,
144                         "%s %d blocks",
145                         block_state_name[i], state_count[i]);
146
147         if (dev->blocks_in_checkpt != state_count[YAFFS_BLOCK_STATE_CHECKPOINT])
148                 yaffs_trace(YAFFS_TRACE_VERIFY,
149                         "Checkpoint block count wrong dev %d count %d",
150                         dev->blocks_in_checkpt,
151                         state_count[YAFFS_BLOCK_STATE_CHECKPOINT]);
152
153         if (dev->n_erased_blocks != state_count[YAFFS_BLOCK_STATE_EMPTY])
154                 yaffs_trace(YAFFS_TRACE_VERIFY,
155                         "Erased block count wrong dev %d count %d",
156                         dev->n_erased_blocks,
157                         state_count[YAFFS_BLOCK_STATE_EMPTY]);
158
159         if (state_count[YAFFS_BLOCK_STATE_COLLECTING] > 1)
160                 yaffs_trace(YAFFS_TRACE_VERIFY,
161                         "Too many collecting blocks %d (max is 1)",
162                         state_count[YAFFS_BLOCK_STATE_COLLECTING]);
163 }
164
165 /*
166  * Verify the object header. oh must be valid, but obj and tags may be NULL in which
167  * case those tests will not be performed.
168  */
169 void yaffs_verify_oh(struct yaffs_obj *obj, struct yaffs_obj_hdr *oh,
170                      struct yaffs_ext_tags *tags, int parent_check)
171 {
172         if (obj && yaffs_skip_verification(obj->my_dev))
173                 return;
174
175         if (!(tags && obj && oh)) {
176                 yaffs_trace(YAFFS_TRACE_VERIFY,
177                         "Verifying object header tags %p obj %p oh %p",
178                         tags, obj, oh);
179                 return;
180         }
181
182         if (oh->type <= YAFFS_OBJECT_TYPE_UNKNOWN ||
183             oh->type > YAFFS_OBJECT_TYPE_MAX)
184                 yaffs_trace(YAFFS_TRACE_VERIFY,
185                         "Obj %d header type is illegal value 0x%x",
186                         tags->obj_id, oh->type);
187
188         if (tags->obj_id != obj->obj_id)
189                 yaffs_trace(YAFFS_TRACE_VERIFY,
190                         "Obj %d header mismatch obj_id %d",
191                         tags->obj_id, obj->obj_id);
192
193         /*
194          * Check that the object's parent ids match if parent_check requested.
195          *
196          * Tests do not apply to the root object.
197          */
198
199         if (parent_check && tags->obj_id > 1 && !obj->parent)
200                 yaffs_trace(YAFFS_TRACE_VERIFY,
201                         "Obj %d header mismatch parent_id %d obj->parent is NULL",
202                         tags->obj_id, oh->parent_obj_id);
203
204         if (parent_check && obj->parent &&
205             oh->parent_obj_id != obj->parent->obj_id &&
206             (oh->parent_obj_id != YAFFS_OBJECTID_UNLINKED ||
207              obj->parent->obj_id != YAFFS_OBJECTID_DELETED))
208                 yaffs_trace(YAFFS_TRACE_VERIFY,
209                         "Obj %d header mismatch parent_id %d parent_obj_id %d",
210                         tags->obj_id, oh->parent_obj_id,
211                         obj->parent->obj_id);
212
213         if (tags->obj_id > 1 && oh->name[0] == 0)       /* Null name */
214                 yaffs_trace(YAFFS_TRACE_VERIFY,
215                         "Obj %d header name is NULL",
216                         obj->obj_id);
217
218         if (tags->obj_id > 1 && ((u8) (oh->name[0])) == 0xff)   /* Trashed name */
219                 yaffs_trace(YAFFS_TRACE_VERIFY,
220                         "Obj %d header name is 0xFF",
221                         obj->obj_id);
222 }
223
224 void yaffs_verify_file(struct yaffs_obj *obj)
225 {
226         int required_depth;
227         int actual_depth;
228         u32 last_chunk;
229         u32 x;
230         u32 i;
231         struct yaffs_dev *dev;
232         struct yaffs_ext_tags tags;
233         struct yaffs_tnode *tn;
234         u32 obj_id;
235
236         if (!obj)
237                 return;
238
239         if (yaffs_skip_verification(obj->my_dev))
240                 return;
241
242         dev = obj->my_dev;
243         obj_id = obj->obj_id;
244
245         /* Check file size is consistent with tnode depth */
246         last_chunk =
247             obj->variant.file_variant.file_size / dev->data_bytes_per_chunk + 1;
248         x = last_chunk >> YAFFS_TNODES_LEVEL0_BITS;
249         required_depth = 0;
250         while (x > 0) {
251                 x >>= YAFFS_TNODES_INTERNAL_BITS;
252                 required_depth++;
253         }
254
255         actual_depth = obj->variant.file_variant.top_level;
256
257         /* Check that the chunks in the tnode tree are all correct.
258          * We do this by scanning through the tnode tree and
259          * checking the tags for every chunk match.
260          */
261
262         if (yaffs_skip_nand_verification(dev))
263                 return;
264
265         for (i = 1; i <= last_chunk; i++) {
266                 tn = yaffs_find_tnode_0(dev, &obj->variant.file_variant, i);
267
268                 if (tn) {
269                         u32 the_chunk = yaffs_get_group_base(dev, tn, i);
270                         if (the_chunk > 0) {
271                                 yaffs_rd_chunk_tags_nand(dev, the_chunk, NULL,
272                                                          &tags);
273                                 if (tags.obj_id != obj_id || tags.chunk_id != i)
274                                 yaffs_trace(YAFFS_TRACE_VERIFY,
275                                         "Object %d chunk_id %d NAND mismatch chunk %d tags (%d:%d)",
276                                          obj_id, i, the_chunk,
277                                          tags.obj_id, tags.chunk_id);
278                         }
279                 }
280         }
281 }
282
283 void yaffs_verify_link(struct yaffs_obj *obj)
284 {
285         if (obj && yaffs_skip_verification(obj->my_dev))
286                 return;
287
288         /* Verify sane equivalent object */
289 }
290
291 void yaffs_verify_symlink(struct yaffs_obj *obj)
292 {
293         if (obj && yaffs_skip_verification(obj->my_dev))
294                 return;
295
296         /* Verify symlink string */
297 }
298
299 void yaffs_verify_special(struct yaffs_obj *obj)
300 {
301         if (obj && yaffs_skip_verification(obj->my_dev))
302                 return;
303 }
304
305 void yaffs_verify_obj(struct yaffs_obj *obj)
306 {
307         struct yaffs_dev *dev;
308
309         u32 chunk_min;
310         u32 chunk_max;
311
312         u32 chunk_id_ok;
313         u32 chunk_in_range;
314         u32 chunk_wrongly_deleted;
315         u32 chunk_valid;
316
317         if (!obj)
318                 return;
319
320         if (obj->being_created)
321                 return;
322
323         dev = obj->my_dev;
324
325         if (yaffs_skip_verification(dev))
326                 return;
327
328         /* Check sane object header chunk */
329
330         chunk_min = dev->internal_start_block * dev->param.chunks_per_block;
331         chunk_max =
332             (dev->internal_end_block + 1) * dev->param.chunks_per_block - 1;
333
334         chunk_in_range = (((unsigned)(obj->hdr_chunk)) >= chunk_min &&
335                           ((unsigned)(obj->hdr_chunk)) <= chunk_max);
336         chunk_id_ok = chunk_in_range || (obj->hdr_chunk == 0);
337         chunk_valid = chunk_in_range &&
338             yaffs_check_chunk_bit(dev,
339                                   obj->hdr_chunk / dev->param.chunks_per_block,
340                                   obj->hdr_chunk % dev->param.chunks_per_block);
341         chunk_wrongly_deleted = chunk_in_range && !chunk_valid;
342
343         if (!obj->fake && (!chunk_id_ok || chunk_wrongly_deleted))
344                 yaffs_trace(YAFFS_TRACE_VERIFY,
345                         "Obj %d has chunk_id %d %s %s",
346                         obj->obj_id, obj->hdr_chunk,
347                         chunk_id_ok ? "" : ",out of range",
348                         chunk_wrongly_deleted ? ",marked as deleted" : "");
349
350         if (chunk_valid && !yaffs_skip_nand_verification(dev)) {
351                 struct yaffs_ext_tags tags;
352                 struct yaffs_obj_hdr *oh;
353                 u8 *buffer = yaffs_get_temp_buffer(dev, __LINE__);
354
355                 oh = (struct yaffs_obj_hdr *)buffer;
356
357                 yaffs_rd_chunk_tags_nand(dev, obj->hdr_chunk, buffer, &tags);
358
359                 yaffs_verify_oh(obj, oh, &tags, 1);
360
361                 yaffs_release_temp_buffer(dev, buffer, __LINE__);
362         }
363
364         /* Verify it has a parent */
365         if (obj && !obj->fake && (!obj->parent || obj->parent->my_dev != dev)) {
366                 yaffs_trace(YAFFS_TRACE_VERIFY,
367                         "Obj %d has parent pointer %p which does not look like an object",
368                         obj->obj_id, obj->parent);
369         }
370
371         /* Verify parent is a directory */
372         if (obj->parent
373             && obj->parent->variant_type != YAFFS_OBJECT_TYPE_DIRECTORY) {
374                 yaffs_trace(YAFFS_TRACE_VERIFY,
375                         "Obj %d's parent is not a directory (type %d)",
376                         obj->obj_id, obj->parent->variant_type);
377         }
378
379         switch (obj->variant_type) {
380         case YAFFS_OBJECT_TYPE_FILE:
381                 yaffs_verify_file(obj);
382                 break;
383         case YAFFS_OBJECT_TYPE_SYMLINK:
384                 yaffs_verify_symlink(obj);
385                 break;
386         case YAFFS_OBJECT_TYPE_DIRECTORY:
387                 yaffs_verify_dir(obj);
388                 break;
389         case YAFFS_OBJECT_TYPE_HARDLINK:
390                 yaffs_verify_link(obj);
391                 break;
392         case YAFFS_OBJECT_TYPE_SPECIAL:
393                 yaffs_verify_special(obj);
394                 break;
395         case YAFFS_OBJECT_TYPE_UNKNOWN:
396         default:
397                 yaffs_trace(YAFFS_TRACE_VERIFY,
398                         "Obj %d has illegaltype %d",
399                    obj->obj_id, obj->variant_type);
400                 break;
401         }
402 }
403
404 void yaffs_verify_objects(struct yaffs_dev *dev)
405 {
406         struct yaffs_obj *obj;
407         int i;
408         struct list_head *lh;
409
410         if (yaffs_skip_verification(dev))
411                 return;
412
413         /* Iterate through the objects in each hash entry */
414
415         for (i = 0; i < YAFFS_NOBJECT_BUCKETS; i++) {
416                 list_for_each(lh, &dev->obj_bucket[i].list) {
417                         if (lh) {
418                                 obj =
419                                     list_entry(lh, struct yaffs_obj, hash_link);
420                                 yaffs_verify_obj(obj);
421                         }
422                 }
423         }
424 }
425
426 void yaffs_verify_obj_in_dir(struct yaffs_obj *obj)
427 {
428         struct list_head *lh;
429         struct yaffs_obj *list_obj;
430
431         int count = 0;
432
433         if (!obj) {
434                 yaffs_trace(YAFFS_TRACE_ALWAYS, "No object to verify");
435                 YBUG();
436                 return;
437         }
438
439         if (yaffs_skip_verification(obj->my_dev))
440                 return;
441
442         if (!obj->parent) {
443                 yaffs_trace(YAFFS_TRACE_ALWAYS, "Object does not have parent" );
444                 YBUG();
445                 return;
446         }
447
448         if (obj->parent->variant_type != YAFFS_OBJECT_TYPE_DIRECTORY) {
449                 yaffs_trace(YAFFS_TRACE_ALWAYS, "Parent is not directory");
450                 YBUG();
451         }
452
453         /* Iterate through the objects in each hash entry */
454
455         list_for_each(lh, &obj->parent->variant.dir_variant.children) {
456                 if (lh) {
457                         list_obj = list_entry(lh, struct yaffs_obj, siblings);
458                         yaffs_verify_obj(list_obj);
459                         if (obj == list_obj)
460                                 count++;
461                 }
462         }
463
464         if (count != 1) {
465                 yaffs_trace(YAFFS_TRACE_ALWAYS,
466                         "Object in directory %d times",
467                         count);
468                 YBUG();
469         }
470 }
471
472 void yaffs_verify_dir(struct yaffs_obj *directory)
473 {
474         struct list_head *lh;
475         struct yaffs_obj *list_obj;
476
477         if (!directory) {
478                 YBUG();
479                 return;
480         }
481
482         if (yaffs_skip_full_verification(directory->my_dev))
483                 return;
484
485         if (directory->variant_type != YAFFS_OBJECT_TYPE_DIRECTORY) {
486                 yaffs_trace(YAFFS_TRACE_ALWAYS,
487                         "Directory has wrong type: %d",
488                         directory->variant_type);
489                 YBUG();
490         }
491
492         /* Iterate through the objects in each hash entry */
493
494         list_for_each(lh, &directory->variant.dir_variant.children) {
495                 if (lh) {
496                         list_obj = list_entry(lh, struct yaffs_obj, siblings);
497                         if (list_obj->parent != directory) {
498                                 yaffs_trace(YAFFS_TRACE_ALWAYS,
499                                         "Object in directory list has wrong parent %p",
500                                         list_obj->parent);
501                                 YBUG();
502                         }
503                         yaffs_verify_obj_in_dir(list_obj);
504                 }
505         }
506 }
507
508 static int yaffs_free_verification_failures;
509
510 void yaffs_verify_free_chunks(struct yaffs_dev *dev)
511 {
512         int counted;
513         int difference;
514
515         if (yaffs_skip_verification(dev))
516                 return;
517
518         counted = yaffs_count_free_chunks(dev);
519
520         difference = dev->n_free_chunks - counted;
521
522         if (difference) {
523                 yaffs_trace(YAFFS_TRACE_ALWAYS,
524                         "Freechunks verification failure %d %d %d",
525                         dev->n_free_chunks, counted, difference);
526                 yaffs_free_verification_failures++;
527         }
528 }
529
530 int yaffs_verify_file_sane(struct yaffs_obj *in)
531 {
532         in = in;
533         return YAFFS_OK;
534 }
535