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.
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"
20 int yaffs_skip_verification(struct yaffs_dev *dev)
23 return !(yaffs_trace_mask &
24 (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));
39 static const char *block_state_name[] = {
52 void yaffs_verify_blk(struct yaffs_dev *dev, struct yaffs_block_info *bi, int n)
57 if (yaffs_skip_verification(dev))
60 /* Report illegal runtime states */
61 if (bi->block_state >= YAFFS_NUMBER_OF_BLOCK_STATES)
63 (TSTR("Block %d has undefined state %d" TENDSTR), n,
66 switch (bi->block_state) {
67 case YAFFS_BLOCK_STATE_UNKNOWN:
68 case YAFFS_BLOCK_STATE_SCANNING:
69 case YAFFS_BLOCK_STATE_NEEDS_SCANNING:
71 (TSTR("Block %d has bad run-state %s" TENDSTR), n,
72 block_state_name[bi->block_state]));
75 /* Check pages in use and soft deletions are legal */
77 actually_used = bi->pages_in_use - bi->soft_del_pages;
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)
86 ("Block %d has illegal values pages_in_used %d soft_del_pages %d"
87 TENDSTR), n, bi->pages_in_use, bi->soft_del_pages));
89 /* Check chunk bitmap legal */
90 in_use = yaffs_count_chunk_bits(dev, n);
91 if (in_use != bi->pages_in_use)
94 ("Block %d has inconsistent values pages_in_use %d counted chunk bits %d"
95 TENDSTR), n, bi->pages_in_use, in_use));
99 void yaffs_verify_collected_blk(struct yaffs_dev *dev,
100 struct yaffs_block_info *bi, int n)
102 yaffs_verify_blk(dev, bi, n);
104 /* After collection the block should be in the erased state */
106 if (bi->block_state != YAFFS_BLOCK_STATE_COLLECTING &&
107 bi->block_state != YAFFS_BLOCK_STATE_EMPTY) {
110 ("Block %d is in state %d after gc, should be erased"
111 TENDSTR), n, bi->block_state));
115 void yaffs_verify_blocks(struct yaffs_dev *dev)
118 int state_count[YAFFS_NUMBER_OF_BLOCK_STATES];
119 int illegal_states = 0;
121 if (yaffs_skip_verification(dev))
124 memset(state_count, 0, sizeof(state_count));
126 for (i = dev->internal_start_block; i <= dev->internal_end_block; i++) {
127 struct yaffs_block_info *bi = yaffs_get_block_info(dev, i);
128 yaffs_verify_blk(dev, bi, i);
130 if (bi->block_state < YAFFS_NUMBER_OF_BLOCK_STATES)
131 state_count[bi->block_state]++;
136 T(YAFFS_TRACE_VERIFY, (TSTR("" TENDSTR)));
137 T(YAFFS_TRACE_VERIFY, (TSTR("Block summary" TENDSTR)));
139 T(YAFFS_TRACE_VERIFY,
140 (TSTR("%d blocks have illegal states" TENDSTR), illegal_states));
141 if (state_count[YAFFS_BLOCK_STATE_ALLOCATING] > 1)
142 T(YAFFS_TRACE_VERIFY,
143 (TSTR("Too many allocating blocks" TENDSTR)));
145 for (i = 0; i < YAFFS_NUMBER_OF_BLOCK_STATES; i++)
146 T(YAFFS_TRACE_VERIFY,
147 (TSTR("%s %d blocks" TENDSTR),
148 block_state_name[i], state_count[i]));
150 if (dev->blocks_in_checkpt != state_count[YAFFS_BLOCK_STATE_CHECKPOINT])
151 T(YAFFS_TRACE_VERIFY,
152 (TSTR("Checkpoint block count wrong dev %d count %d" TENDSTR),
153 dev->blocks_in_checkpt,
154 state_count[YAFFS_BLOCK_STATE_CHECKPOINT]));
156 if (dev->n_erased_blocks != state_count[YAFFS_BLOCK_STATE_EMPTY])
157 T(YAFFS_TRACE_VERIFY,
158 (TSTR("Erased block count wrong dev %d count %d" TENDSTR),
159 dev->n_erased_blocks, state_count[YAFFS_BLOCK_STATE_EMPTY]));
161 if (state_count[YAFFS_BLOCK_STATE_COLLECTING] > 1)
162 T(YAFFS_TRACE_VERIFY,
163 (TSTR("Too many collecting blocks %d (max is 1)" TENDSTR),
164 state_count[YAFFS_BLOCK_STATE_COLLECTING]));
166 T(YAFFS_TRACE_VERIFY, (TSTR("" TENDSTR)));
171 * Verify the object header. oh must be valid, but obj and tags may be NULL in which
172 * case those tests will not be performed.
174 void yaffs_verify_oh(struct yaffs_obj *obj, struct yaffs_obj_hdr *oh,
175 struct yaffs_ext_tags *tags, int parent_check)
177 if (obj && yaffs_skip_verification(obj->my_dev))
180 if (!(tags && obj && oh)) {
181 T(YAFFS_TRACE_VERIFY,
182 (TSTR("Verifying object header tags %p obj %p oh %p" TENDSTR),
187 if (oh->type <= YAFFS_OBJECT_TYPE_UNKNOWN ||
188 oh->type > YAFFS_OBJECT_TYPE_MAX)
189 T(YAFFS_TRACE_VERIFY,
190 (TSTR("Obj %d header type is illegal value 0x%x" TENDSTR),
191 tags->obj_id, oh->type));
193 if (tags->obj_id != obj->obj_id)
194 T(YAFFS_TRACE_VERIFY,
195 (TSTR("Obj %d header mismatch obj_id %d" TENDSTR),
196 tags->obj_id, obj->obj_id));
199 * Check that the object's parent ids match if parent_check requested.
201 * Tests do not apply to the root object.
204 if (parent_check && tags->obj_id > 1 && !obj->parent)
205 T(YAFFS_TRACE_VERIFY,
207 ("Obj %d header mismatch parent_id %d obj->parent is NULL"
208 TENDSTR), tags->obj_id, oh->parent_obj_id));
210 if (parent_check && obj->parent &&
211 oh->parent_obj_id != obj->parent->obj_id &&
212 (oh->parent_obj_id != YAFFS_OBJECTID_UNLINKED ||
213 obj->parent->obj_id != YAFFS_OBJECTID_DELETED))
214 T(YAFFS_TRACE_VERIFY,
216 ("Obj %d header mismatch parent_id %d parent_obj_id %d"
217 TENDSTR), tags->obj_id, oh->parent_obj_id,
218 obj->parent->obj_id));
220 if (tags->obj_id > 1 && oh->name[0] == 0) /* Null name */
221 T(YAFFS_TRACE_VERIFY,
222 (TSTR("Obj %d header name is NULL" TENDSTR), obj->obj_id));
224 if (tags->obj_id > 1 && ((u8) (oh->name[0])) == 0xff) /* Trashed name */
225 T(YAFFS_TRACE_VERIFY,
226 (TSTR("Obj %d header name is 0xFF" TENDSTR), obj->obj_id));
229 void yaffs_verify_file(struct yaffs_obj *obj)
236 struct yaffs_dev *dev;
237 struct yaffs_ext_tags tags;
238 struct yaffs_tnode *tn;
244 if (yaffs_skip_verification(obj->my_dev))
248 obj_id = obj->obj_id;
250 /* Check file size is consistent with tnode depth */
252 obj->variant.file_variant.file_size / dev->data_bytes_per_chunk + 1;
253 x = last_chunk >> YAFFS_TNODES_LEVEL0_BITS;
256 x >>= YAFFS_TNODES_INTERNAL_BITS;
260 actual_depth = obj->variant.file_variant.top_level;
262 /* Check that the chunks in the tnode tree are all correct.
263 * We do this by scanning through the tnode tree and
264 * checking the tags for every chunk match.
267 if (yaffs_skip_nand_verification(dev))
270 for (i = 1; i <= last_chunk; i++) {
271 tn = yaffs_find_tnode_0(dev, &obj->variant.file_variant, i);
274 u32 the_chunk = yaffs_get_group_base(dev, tn, i);
276 /* T(~0,(TSTR("verifying (%d:%d) %d"TENDSTR),obj_id,i,the_chunk)); */
277 yaffs_rd_chunk_tags_nand(dev, the_chunk, NULL,
279 if (tags.obj_id != obj_id || tags.chunk_id != i) {
282 ("Object %d chunk_id %d NAND mismatch chunk %d tags (%d:%d)"
283 TENDSTR), obj_id, i, the_chunk,
284 tags.obj_id, tags.chunk_id));
291 void yaffs_verify_link(struct yaffs_obj *obj)
293 if (obj && yaffs_skip_verification(obj->my_dev))
296 /* Verify sane equivalent object */
299 void yaffs_verify_symlink(struct yaffs_obj *obj)
301 if (obj && yaffs_skip_verification(obj->my_dev))
304 /* Verify symlink string */
307 void yaffs_verify_special(struct yaffs_obj *obj)
309 if (obj && yaffs_skip_verification(obj->my_dev))
313 void yaffs_verify_obj(struct yaffs_obj *obj)
315 struct yaffs_dev *dev;
322 u32 chunk_wrongly_deleted;
328 if (obj->being_created)
333 if (yaffs_skip_verification(dev))
336 /* Check sane object header chunk */
338 chunk_min = dev->internal_start_block * dev->param.chunks_per_block;
340 (dev->internal_end_block + 1) * dev->param.chunks_per_block - 1;
342 chunk_in_range = (((unsigned)(obj->hdr_chunk)) >= chunk_min &&
343 ((unsigned)(obj->hdr_chunk)) <= chunk_max);
344 chunk_id_ok = chunk_in_range || (obj->hdr_chunk == 0);
345 chunk_valid = chunk_in_range &&
346 yaffs_check_chunk_bit(dev,
347 obj->hdr_chunk / dev->param.chunks_per_block,
348 obj->hdr_chunk % dev->param.chunks_per_block);
349 chunk_wrongly_deleted = chunk_in_range && !chunk_valid;
351 if (!obj->fake && (!chunk_id_ok || chunk_wrongly_deleted)) {
352 T(YAFFS_TRACE_VERIFY,
353 (TSTR("Obj %d has chunk_id %d %s %s" TENDSTR),
354 obj->obj_id, obj->hdr_chunk,
355 chunk_id_ok ? "" : ",out of range",
356 chunk_wrongly_deleted ? ",marked as deleted" : ""));
359 if (chunk_valid && !yaffs_skip_nand_verification(dev)) {
360 struct yaffs_ext_tags tags;
361 struct yaffs_obj_hdr *oh;
362 u8 *buffer = yaffs_get_temp_buffer(dev, __LINE__);
364 oh = (struct yaffs_obj_hdr *)buffer;
366 yaffs_rd_chunk_tags_nand(dev, obj->hdr_chunk, buffer, &tags);
368 yaffs_verify_oh(obj, oh, &tags, 1);
370 yaffs_release_temp_buffer(dev, buffer, __LINE__);
373 /* Verify it has a parent */
374 if (obj && !obj->fake && (!obj->parent || obj->parent->my_dev != dev)) {
375 T(YAFFS_TRACE_VERIFY,
377 ("Obj %d has parent pointer %p which does not look like an object"
378 TENDSTR), obj->obj_id, obj->parent));
381 /* Verify parent is a directory */
383 && obj->parent->variant_type != YAFFS_OBJECT_TYPE_DIRECTORY) {
384 T(YAFFS_TRACE_VERIFY,
385 (TSTR("Obj %d's parent is not a directory (type %d)" TENDSTR),
386 obj->obj_id, obj->parent->variant_type));
389 switch (obj->variant_type) {
390 case YAFFS_OBJECT_TYPE_FILE:
391 yaffs_verify_file(obj);
393 case YAFFS_OBJECT_TYPE_SYMLINK:
394 yaffs_verify_symlink(obj);
396 case YAFFS_OBJECT_TYPE_DIRECTORY:
397 yaffs_verify_dir(obj);
399 case YAFFS_OBJECT_TYPE_HARDLINK:
400 yaffs_verify_link(obj);
402 case YAFFS_OBJECT_TYPE_SPECIAL:
403 yaffs_verify_special(obj);
405 case YAFFS_OBJECT_TYPE_UNKNOWN:
407 T(YAFFS_TRACE_VERIFY,
408 (TSTR("Obj %d has illegaltype %d" TENDSTR),
409 obj->obj_id, obj->variant_type));
414 void yaffs_verify_objects(struct yaffs_dev *dev)
416 struct yaffs_obj *obj;
418 struct list_head *lh;
420 if (yaffs_skip_verification(dev))
423 /* Iterate through the objects in each hash entry */
425 for (i = 0; i < YAFFS_NOBJECT_BUCKETS; i++) {
426 list_for_each(lh, &dev->obj_bucket[i].list) {
429 list_entry(lh, struct yaffs_obj, hash_link);
430 yaffs_verify_obj(obj);
436 void yaffs_verify_obj_in_dir(struct yaffs_obj *obj)
438 struct list_head *lh;
439 struct yaffs_obj *list_obj;
444 T(YAFFS_TRACE_ALWAYS, (TSTR("No object to verify" TENDSTR)));
449 if (yaffs_skip_verification(obj->my_dev))
453 T(YAFFS_TRACE_ALWAYS,
454 (TSTR("Object does not have parent" TENDSTR)));
459 if (obj->parent->variant_type != YAFFS_OBJECT_TYPE_DIRECTORY) {
460 T(YAFFS_TRACE_ALWAYS,
461 (TSTR("Parent is not directory" TENDSTR)));
465 /* Iterate through the objects in each hash entry */
467 list_for_each(lh, &obj->parent->variant.dir_variant.children) {
469 list_obj = list_entry(lh, struct yaffs_obj, siblings);
470 yaffs_verify_obj(list_obj);
477 T(YAFFS_TRACE_ALWAYS,
478 (TSTR("Object in directory %d times" TENDSTR), count));
483 void yaffs_verify_dir(struct yaffs_obj *directory)
485 struct list_head *lh;
486 struct yaffs_obj *list_obj;
493 if (yaffs_skip_full_verification(directory->my_dev))
496 if (directory->variant_type != YAFFS_OBJECT_TYPE_DIRECTORY) {
497 T(YAFFS_TRACE_ALWAYS,
498 (TSTR("Directory has wrong type: %d" TENDSTR),
499 directory->variant_type));
503 /* Iterate through the objects in each hash entry */
505 list_for_each(lh, &directory->variant.dir_variant.children) {
507 list_obj = list_entry(lh, struct yaffs_obj, siblings);
508 if (list_obj->parent != directory) {
509 T(YAFFS_TRACE_ALWAYS,
511 ("Object in directory list has wrong parent %p"
512 TENDSTR), list_obj->parent));
515 yaffs_verify_obj_in_dir(list_obj);
520 static int yaffs_free_verification_failures;
522 void yaffs_verify_free_chunks(struct yaffs_dev *dev)
527 if (yaffs_skip_verification(dev))
530 counted = yaffs_count_free_chunks(dev);
532 difference = dev->n_free_chunks - counted;
535 T(YAFFS_TRACE_ALWAYS,
536 (TSTR("Freechunks verification failure %d %d %d" TENDSTR),
537 dev->n_free_chunks, counted, difference));
538 yaffs_free_verification_failures++;
542 int yaffs_verify_file_sane(struct yaffs_obj *in)