2 * YAFFS: Yet Another Flash File System. A NAND-flash specific file system.
4 * Copyright (C) 2002-2010 Aleph One Ltd.
5 * for Toby Churchill Ltd and Brightstar Engineering
7 * Created by Charles Manning <charles@aleph1.co.uk>
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.
15 #include "yaffs_verify.h"
16 #include "yaffs_trace.h"
17 #include "yaffs_bitmap.h"
18 #include "yaffs_getblockinfo.h"
19 #include "yaffs_nand.h"
21 int yaffs_skip_verification(struct yaffs_dev *dev)
24 return !(yaffs_trace_mask & (YAFFS_TRACE_VERIFY | YAFFS_TRACE_VERIFY_FULL));
27 static int yaffs_skip_full_verification(struct yaffs_dev *dev)
30 return !(yaffs_trace_mask & (YAFFS_TRACE_VERIFY_FULL));
33 static int yaffs_skip_nand_verification(struct yaffs_dev *dev)
36 return !(yaffs_trace_mask & (YAFFS_TRACE_VERIFY_NAND));
40 static const char *block_state_name[] = {
54 void yaffs_verify_blk(struct yaffs_dev *dev, struct yaffs_block_info *bi, int n)
59 if (yaffs_skip_verification(dev))
62 /* Report illegal runtime states */
63 if (bi->block_state >= YAFFS_NUMBER_OF_BLOCK_STATES)
64 T(YAFFS_TRACE_VERIFY, (TSTR("Block %d has undefined state %d"TENDSTR), n, bi->block_state));
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 T(YAFFS_TRACE_VERIFY, (TSTR("Block %d has bad run-state %s"TENDSTR),
71 n, block_state_name[bi->block_state]));
74 /* Check pages in use and soft deletions are legal */
76 actually_used = bi->pages_in_use - bi->soft_del_pages;
78 if (bi->pages_in_use < 0 || bi->pages_in_use > dev->param.chunks_per_block ||
79 bi->soft_del_pages < 0 || bi->soft_del_pages > dev->param.chunks_per_block ||
80 actually_used < 0 || actually_used > dev->param.chunks_per_block)
81 T(YAFFS_TRACE_VERIFY, (TSTR("Block %d has illegal values pages_in_used %d soft_del_pages %d"TENDSTR),
82 n, bi->pages_in_use, bi->soft_del_pages));
85 /* Check chunk bitmap legal */
86 in_use = yaffs_count_chunk_bits(dev, n);
87 if (in_use != bi->pages_in_use)
88 T(YAFFS_TRACE_VERIFY, (TSTR("Block %d has inconsistent values pages_in_use %d counted chunk bits %d"TENDSTR),
89 n, bi->pages_in_use, in_use));
95 void yaffs_verify_collected_blk(struct yaffs_dev *dev, struct yaffs_block_info *bi, int n)
97 yaffs_verify_blk(dev, bi, n);
99 /* After collection the block should be in the erased state */
101 if (bi->block_state != YAFFS_BLOCK_STATE_COLLECTING &&
102 bi->block_state != YAFFS_BLOCK_STATE_EMPTY) {
103 T(YAFFS_TRACE_ERROR, (TSTR("Block %d is in state %d after gc, should be erased"TENDSTR),
104 n, bi->block_state));
108 void yaffs_verify_blocks(struct yaffs_dev *dev)
111 int state_count[YAFFS_NUMBER_OF_BLOCK_STATES];
112 int illegal_states = 0;
114 if (yaffs_skip_verification(dev))
117 memset(state_count, 0, sizeof(state_count));
119 for (i = dev->internal_start_block; i <= dev->internal_end_block; i++) {
120 struct yaffs_block_info *bi = yaffs_get_block_info(dev, i);
121 yaffs_verify_blk(dev, bi, i);
123 if (bi->block_state < YAFFS_NUMBER_OF_BLOCK_STATES)
124 state_count[bi->block_state]++;
129 T(YAFFS_TRACE_VERIFY, (TSTR(""TENDSTR)));
130 T(YAFFS_TRACE_VERIFY, (TSTR("Block summary"TENDSTR)));
132 T(YAFFS_TRACE_VERIFY, (TSTR("%d blocks have illegal states"TENDSTR), illegal_states));
133 if (state_count[YAFFS_BLOCK_STATE_ALLOCATING] > 1)
134 T(YAFFS_TRACE_VERIFY, (TSTR("Too many allocating blocks"TENDSTR)));
136 for (i = 0; i < YAFFS_NUMBER_OF_BLOCK_STATES; i++)
137 T(YAFFS_TRACE_VERIFY,
138 (TSTR("%s %d blocks"TENDSTR),
139 block_state_name[i], state_count[i]));
141 if (dev->blocks_in_checkpt != state_count[YAFFS_BLOCK_STATE_CHECKPOINT])
142 T(YAFFS_TRACE_VERIFY,
143 (TSTR("Checkpoint block count wrong dev %d count %d"TENDSTR),
144 dev->blocks_in_checkpt, state_count[YAFFS_BLOCK_STATE_CHECKPOINT]));
146 if (dev->n_erased_blocks != state_count[YAFFS_BLOCK_STATE_EMPTY])
147 T(YAFFS_TRACE_VERIFY,
148 (TSTR("Erased block count wrong dev %d count %d"TENDSTR),
149 dev->n_erased_blocks, state_count[YAFFS_BLOCK_STATE_EMPTY]));
151 if (state_count[YAFFS_BLOCK_STATE_COLLECTING] > 1)
152 T(YAFFS_TRACE_VERIFY,
153 (TSTR("Too many collecting blocks %d (max is 1)"TENDSTR),
154 state_count[YAFFS_BLOCK_STATE_COLLECTING]));
156 T(YAFFS_TRACE_VERIFY, (TSTR(""TENDSTR)));
161 * Verify the object header. oh must be valid, but obj and tags may be NULL in which
162 * case those tests will not be performed.
164 void yaffs_verify_oh(struct yaffs_obj *obj, struct yaffs_obj_hdr *oh, struct yaffs_ext_tags *tags, int parent_check)
166 if (obj && yaffs_skip_verification(obj->my_dev))
169 if (!(tags && obj && oh)) {
170 T(YAFFS_TRACE_VERIFY,
171 (TSTR("Verifying object header tags %p obj %p oh %p"TENDSTR),
176 if (oh->type <= YAFFS_OBJECT_TYPE_UNKNOWN ||
177 oh->type > YAFFS_OBJECT_TYPE_MAX)
178 T(YAFFS_TRACE_VERIFY,
179 (TSTR("Obj %d header type is illegal value 0x%x"TENDSTR),
180 tags->obj_id, oh->type));
182 if (tags->obj_id != obj->obj_id)
183 T(YAFFS_TRACE_VERIFY,
184 (TSTR("Obj %d header mismatch obj_id %d"TENDSTR),
185 tags->obj_id, obj->obj_id));
189 * Check that the object's parent ids match if parent_check requested.
191 * Tests do not apply to the root object.
194 if (parent_check && tags->obj_id > 1 && !obj->parent)
195 T(YAFFS_TRACE_VERIFY,
196 (TSTR("Obj %d header mismatch parent_id %d obj->parent is NULL"TENDSTR),
197 tags->obj_id, oh->parent_obj_id));
199 if (parent_check && obj->parent &&
200 oh->parent_obj_id != obj->parent->obj_id &&
201 (oh->parent_obj_id != YAFFS_OBJECTID_UNLINKED ||
202 obj->parent->obj_id != YAFFS_OBJECTID_DELETED))
203 T(YAFFS_TRACE_VERIFY,
204 (TSTR("Obj %d header mismatch parent_id %d parent_obj_id %d"TENDSTR),
205 tags->obj_id, oh->parent_obj_id, obj->parent->obj_id));
207 if (tags->obj_id > 1 && oh->name[0] == 0) /* Null name */
208 T(YAFFS_TRACE_VERIFY,
209 (TSTR("Obj %d header name is NULL"TENDSTR),
212 if (tags->obj_id > 1 && ((u8)(oh->name[0])) == 0xff) /* Trashed name */
213 T(YAFFS_TRACE_VERIFY,
214 (TSTR("Obj %d header name is 0xFF"TENDSTR),
220 void yaffs_verify_file(struct yaffs_obj *obj)
227 struct yaffs_dev *dev;
228 struct yaffs_ext_tags tags;
229 struct yaffs_tnode *tn;
235 if (yaffs_skip_verification(obj->my_dev))
239 obj_id = obj->obj_id;
241 /* Check file size is consistent with tnode depth */
242 last_chunk = obj->variant.file_variant.file_size / dev->data_bytes_per_chunk + 1;
243 x = last_chunk >> YAFFS_TNODES_LEVEL0_BITS;
246 x >>= YAFFS_TNODES_INTERNAL_BITS;
250 actual_depth = obj->variant.file_variant.top_level;
252 /* Check that the chunks in the tnode tree are all correct.
253 * We do this by scanning through the tnode tree and
254 * checking the tags for every chunk match.
257 if (yaffs_skip_nand_verification(dev))
260 for (i = 1; i <= last_chunk; i++) {
261 tn = yaffs_find_tnode_0(dev, &obj->variant.file_variant, i);
264 u32 the_chunk = yaffs_get_group_base(dev, tn, i);
266 /* T(~0,(TSTR("verifying (%d:%d) %d"TENDSTR),obj_id,i,the_chunk)); */
267 yaffs_rd_chunk_tags_nand(dev, the_chunk, NULL, &tags);
268 if (tags.obj_id != obj_id || tags.chunk_id != i) {
269 T(~0, (TSTR("Object %d chunk_id %d NAND mismatch chunk %d tags (%d:%d)"TENDSTR),
270 obj_id, i, the_chunk,
271 tags.obj_id, tags.chunk_id));
279 void yaffs_verify_link(struct yaffs_obj *obj)
281 if (obj && yaffs_skip_verification(obj->my_dev))
284 /* Verify sane equivalent object */
287 void yaffs_verify_symlink(struct yaffs_obj *obj)
289 if (obj && yaffs_skip_verification(obj->my_dev))
292 /* Verify symlink string */
295 void yaffs_verify_special(struct yaffs_obj *obj)
297 if (obj && yaffs_skip_verification(obj->my_dev))
301 void yaffs_verify_obj(struct yaffs_obj *obj)
303 struct yaffs_dev *dev;
310 u32 chunk_wrongly_deleted;
316 if (obj->being_created)
321 if (yaffs_skip_verification(dev))
324 /* Check sane object header chunk */
326 chunk_min = dev->internal_start_block * dev->param.chunks_per_block;
327 chunk_max = (dev->internal_end_block+1) * dev->param.chunks_per_block - 1;
329 chunk_in_range = (((unsigned)(obj->hdr_chunk)) >= chunk_min &&
330 ((unsigned)(obj->hdr_chunk)) <= chunk_max);
331 chunk_id_ok = chunk_in_range || (obj->hdr_chunk == 0);
332 chunk_valid = chunk_in_range &&
333 yaffs_check_chunk_bit(dev,
334 obj->hdr_chunk / dev->param.chunks_per_block,
335 obj->hdr_chunk % dev->param.chunks_per_block);
336 chunk_wrongly_deleted = chunk_in_range && !chunk_valid;
339 (!chunk_id_ok || chunk_wrongly_deleted)) {
340 T(YAFFS_TRACE_VERIFY,
341 (TSTR("Obj %d has chunk_id %d %s %s"TENDSTR),
342 obj->obj_id, obj->hdr_chunk,
343 chunk_id_ok ? "" : ",out of range",
344 chunk_wrongly_deleted ? ",marked as deleted" : ""));
347 if (chunk_valid && !yaffs_skip_nand_verification(dev)) {
348 struct yaffs_ext_tags tags;
349 struct yaffs_obj_hdr *oh;
350 u8 *buffer = yaffs_get_temp_buffer(dev, __LINE__);
352 oh = (struct yaffs_obj_hdr *)buffer;
354 yaffs_rd_chunk_tags_nand(dev, obj->hdr_chunk, buffer,
357 yaffs_verify_oh(obj, oh, &tags, 1);
359 yaffs_release_temp_buffer(dev, buffer, __LINE__);
362 /* Verify it has a parent */
363 if (obj && !obj->fake &&
364 (!obj->parent || obj->parent->my_dev != dev)) {
365 T(YAFFS_TRACE_VERIFY,
366 (TSTR("Obj %d has parent pointer %p which does not look like an object"TENDSTR),
367 obj->obj_id, obj->parent));
370 /* Verify parent is a directory */
371 if (obj->parent && obj->parent->variant_type != YAFFS_OBJECT_TYPE_DIRECTORY) {
372 T(YAFFS_TRACE_VERIFY,
373 (TSTR("Obj %d's parent is not a directory (type %d)"TENDSTR),
374 obj->obj_id, obj->parent->variant_type));
377 switch (obj->variant_type) {
378 case YAFFS_OBJECT_TYPE_FILE:
379 yaffs_verify_file(obj);
381 case YAFFS_OBJECT_TYPE_SYMLINK:
382 yaffs_verify_symlink(obj);
384 case YAFFS_OBJECT_TYPE_DIRECTORY:
385 yaffs_verify_dir(obj);
387 case YAFFS_OBJECT_TYPE_HARDLINK:
388 yaffs_verify_link(obj);
390 case YAFFS_OBJECT_TYPE_SPECIAL:
391 yaffs_verify_special(obj);
393 case YAFFS_OBJECT_TYPE_UNKNOWN:
395 T(YAFFS_TRACE_VERIFY,
396 (TSTR("Obj %d has illegaltype %d"TENDSTR),
397 obj->obj_id, obj->variant_type));
402 void yaffs_verify_objects(struct yaffs_dev *dev)
404 struct yaffs_obj *obj;
406 struct list_head *lh;
408 if (yaffs_skip_verification(dev))
411 /* Iterate through the objects in each hash entry */
413 for (i = 0; i < YAFFS_NOBJECT_BUCKETS; i++) {
414 list_for_each(lh, &dev->obj_bucket[i].list) {
416 obj = list_entry(lh, struct yaffs_obj, hash_link);
417 yaffs_verify_obj(obj);
424 void yaffs_verify_obj_in_dir(struct yaffs_obj *obj)
426 struct list_head *lh;
427 struct yaffs_obj *list_obj;
432 T(YAFFS_TRACE_ALWAYS, (TSTR("No object to verify" TENDSTR)));
437 if (yaffs_skip_verification(obj->my_dev))
441 T(YAFFS_TRACE_ALWAYS, (TSTR("Object does not have parent" TENDSTR)));
446 if (obj->parent->variant_type != YAFFS_OBJECT_TYPE_DIRECTORY) {
447 T(YAFFS_TRACE_ALWAYS, (TSTR("Parent is not directory" TENDSTR)));
451 /* Iterate through the objects in each hash entry */
453 list_for_each(lh, &obj->parent->variant.dir_variant.children) {
455 list_obj = list_entry(lh, struct yaffs_obj, siblings);
456 yaffs_verify_obj(list_obj);
463 T(YAFFS_TRACE_ALWAYS, (TSTR("Object in directory %d times" TENDSTR), count));
468 void yaffs_verify_dir(struct yaffs_obj *directory)
470 struct list_head *lh;
471 struct yaffs_obj *list_obj;
478 if (yaffs_skip_full_verification(directory->my_dev))
481 if (directory->variant_type != YAFFS_OBJECT_TYPE_DIRECTORY) {
482 T(YAFFS_TRACE_ALWAYS,
483 (TSTR("Directory has wrong type: %d" TENDSTR),
484 directory->variant_type));
488 /* Iterate through the objects in each hash entry */
490 list_for_each(lh, &directory->variant.dir_variant.children) {
492 list_obj = list_entry(lh, struct yaffs_obj, siblings);
493 if (list_obj->parent != directory) {
494 T(YAFFS_TRACE_ALWAYS, (
495 TSTR("Object in directory list has wrong parent %p" TENDSTR),
499 yaffs_verify_obj_in_dir(list_obj);
504 static int yaffs_free_verification_failures;
506 void yaffs_verify_free_chunks(struct yaffs_dev *dev)
511 if (yaffs_skip_verification(dev))
514 counted = yaffs_count_free_chunks(dev);
516 difference = dev->n_free_chunks - counted;
519 T(YAFFS_TRACE_ALWAYS,
520 (TSTR("Freechunks verification failure %d %d %d" TENDSTR),
521 dev->n_free_chunks, counted, difference));
522 yaffs_free_verification_failures++;
526 int yaffs_verify_file_sane(struct yaffs_obj *in)