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 * const 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)
62 yaffs_trace(YAFFS_TRACE_VERIFY,
63 "Block %d has undefined state %d",
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]);
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)
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);
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);
96 void yaffs_verify_collected_blk(struct yaffs_dev *dev,
97 struct yaffs_block_info *bi, int n)
99 yaffs_verify_blk(dev, bi, n);
101 /* After collection the block should be in the erased state */
103 if (bi->block_state != YAFFS_BLOCK_STATE_COLLECTING &&
104 bi->block_state != YAFFS_BLOCK_STATE_EMPTY) {
105 yaffs_trace(YAFFS_TRACE_ERROR,
106 "Block %d is in state %d after gc, should be erased",
111 void yaffs_verify_blocks(struct yaffs_dev *dev)
114 int state_count[YAFFS_NUMBER_OF_BLOCK_STATES];
115 int illegal_states = 0;
117 if (yaffs_skip_verification(dev))
120 memset(state_count, 0, sizeof(state_count));
122 for (i = dev->internal_start_block; i <= dev->internal_end_block; i++) {
123 struct yaffs_block_info *bi = yaffs_get_block_info(dev, i);
124 yaffs_verify_blk(dev, bi, i);
126 if (bi->block_state < YAFFS_NUMBER_OF_BLOCK_STATES)
127 state_count[bi->block_state]++;
132 yaffs_trace(YAFFS_TRACE_VERIFY, "Block summary");
134 yaffs_trace(YAFFS_TRACE_VERIFY,
135 "%d blocks have illegal states",
137 if (state_count[YAFFS_BLOCK_STATE_ALLOCATING] > 1)
138 yaffs_trace(YAFFS_TRACE_VERIFY,
139 "Too many allocating blocks");
141 for (i = 0; i < YAFFS_NUMBER_OF_BLOCK_STATES; i++)
142 yaffs_trace(YAFFS_TRACE_VERIFY,
144 block_state_name[i], state_count[i]);
146 if (dev->blocks_in_checkpt != state_count[YAFFS_BLOCK_STATE_CHECKPOINT])
147 yaffs_trace(YAFFS_TRACE_VERIFY,
148 "Checkpoint block count wrong dev %d count %d",
149 dev->blocks_in_checkpt,
150 state_count[YAFFS_BLOCK_STATE_CHECKPOINT]);
152 if (dev->n_erased_blocks != state_count[YAFFS_BLOCK_STATE_EMPTY])
153 yaffs_trace(YAFFS_TRACE_VERIFY,
154 "Erased block count wrong dev %d count %d",
155 dev->n_erased_blocks,
156 state_count[YAFFS_BLOCK_STATE_EMPTY]);
158 if (state_count[YAFFS_BLOCK_STATE_COLLECTING] > 1)
159 yaffs_trace(YAFFS_TRACE_VERIFY,
160 "Too many collecting blocks %d (max is 1)",
161 state_count[YAFFS_BLOCK_STATE_COLLECTING]);
165 * Verify the object header. oh must be valid, but obj and tags may be NULL in
166 * which case those tests will not be performed.
168 void yaffs_verify_oh(struct yaffs_obj *obj, struct yaffs_obj_hdr *oh,
169 struct yaffs_ext_tags *tags, int parent_check)
171 if (obj && yaffs_skip_verification(obj->my_dev))
174 if (!(tags && obj && oh)) {
175 yaffs_trace(YAFFS_TRACE_VERIFY,
176 "Verifying object header tags %p obj %p oh %p",
181 if (oh->type <= YAFFS_OBJECT_TYPE_UNKNOWN ||
182 oh->type > YAFFS_OBJECT_TYPE_MAX)
183 yaffs_trace(YAFFS_TRACE_VERIFY,
184 "Obj %d header type is illegal value 0x%x",
185 tags->obj_id, oh->type);
187 if (tags->obj_id != obj->obj_id)
188 yaffs_trace(YAFFS_TRACE_VERIFY,
189 "Obj %d header mismatch obj_id %d",
190 tags->obj_id, obj->obj_id);
193 * Check that the object's parent ids match if parent_check requested.
195 * Tests do not apply to the root object.
198 if (parent_check && tags->obj_id > 1 && !obj->parent)
199 yaffs_trace(YAFFS_TRACE_VERIFY,
200 "Obj %d header mismatch parent_id %d obj->parent is NULL",
201 tags->obj_id, oh->parent_obj_id);
203 if (parent_check && obj->parent &&
204 oh->parent_obj_id != obj->parent->obj_id &&
205 (oh->parent_obj_id != YAFFS_OBJECTID_UNLINKED ||
206 obj->parent->obj_id != YAFFS_OBJECTID_DELETED))
207 yaffs_trace(YAFFS_TRACE_VERIFY,
208 "Obj %d header mismatch parent_id %d parent_obj_id %d",
209 tags->obj_id, oh->parent_obj_id,
210 obj->parent->obj_id);
212 if (tags->obj_id > 1 && oh->name[0] == 0) /* Null name */
213 yaffs_trace(YAFFS_TRACE_VERIFY,
214 "Obj %d header name is NULL",
217 if (tags->obj_id > 1 && ((u8) (oh->name[0])) == 0xff) /* Junk name */
218 yaffs_trace(YAFFS_TRACE_VERIFY,
219 "Obj %d header name is 0xFF",
223 void yaffs_verify_file(struct yaffs_obj *obj)
230 struct yaffs_dev *dev;
231 struct yaffs_ext_tags tags;
232 struct yaffs_tnode *tn;
238 if (yaffs_skip_verification(obj->my_dev))
242 obj_id = obj->obj_id;
244 /* Check file size is consistent with tnode depth */
246 obj->variant.file_variant.file_size / dev->data_bytes_per_chunk + 1;
247 x = last_chunk >> YAFFS_TNODES_LEVEL0_BITS;
250 x >>= YAFFS_TNODES_INTERNAL_BITS;
254 actual_depth = obj->variant.file_variant.top_level;
256 /* Check that the chunks in the tnode tree are all correct.
257 * We do this by scanning through the tnode tree and
258 * checking the tags for every chunk match.
261 if (yaffs_skip_nand_verification(dev))
264 for (i = 1; i <= last_chunk; i++) {
265 tn = yaffs_find_tnode_0(dev, &obj->variant.file_variant, i);
268 u32 the_chunk = yaffs_get_group_base(dev, tn, i);
270 yaffs_rd_chunk_tags_nand(dev, the_chunk, NULL,
272 if (tags.obj_id != obj_id || tags.chunk_id != i)
273 yaffs_trace(YAFFS_TRACE_VERIFY,
274 "Object %d chunk_id %d NAND mismatch chunk %d tags (%d:%d)",
275 obj_id, i, the_chunk,
276 tags.obj_id, tags.chunk_id);
282 void yaffs_verify_link(struct yaffs_obj *obj)
284 if (obj && yaffs_skip_verification(obj->my_dev))
287 /* Verify sane equivalent object */
290 void yaffs_verify_symlink(struct yaffs_obj *obj)
292 if (obj && yaffs_skip_verification(obj->my_dev))
295 /* Verify symlink string */
298 void yaffs_verify_special(struct yaffs_obj *obj)
300 if (obj && yaffs_skip_verification(obj->my_dev))
304 void yaffs_verify_obj(struct yaffs_obj *obj)
306 struct yaffs_dev *dev;
311 u32 chunk_wrongly_deleted;
317 if (obj->being_created)
322 if (yaffs_skip_verification(dev))
325 /* Check sane object header chunk */
327 chunk_min = dev->internal_start_block * dev->param.chunks_per_block;
329 (dev->internal_end_block + 1) * dev->param.chunks_per_block - 1;
331 chunk_in_range = (((unsigned)(obj->hdr_chunk)) >= chunk_min &&
332 ((unsigned)(obj->hdr_chunk)) <= chunk_max);
333 chunk_id_ok = chunk_in_range || (obj->hdr_chunk == 0);
334 chunk_valid = chunk_in_range &&
335 yaffs_check_chunk_bit(dev,
336 obj->hdr_chunk / dev->param.chunks_per_block,
337 obj->hdr_chunk % dev->param.chunks_per_block);
338 chunk_wrongly_deleted = chunk_in_range && !chunk_valid;
340 if (!obj->fake && (!chunk_id_ok || chunk_wrongly_deleted))
341 yaffs_trace(YAFFS_TRACE_VERIFY,
342 "Obj %d has chunk_id %d %s %s",
343 obj->obj_id, obj->hdr_chunk,
344 chunk_id_ok ? "" : ",out of range",
345 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, &tags);
356 yaffs_verify_oh(obj, oh, &tags, 1);
358 yaffs_release_temp_buffer(dev, buffer, __LINE__);
361 /* Verify it has a parent */
362 if (obj && !obj->fake && (!obj->parent || obj->parent->my_dev != dev)) {
363 yaffs_trace(YAFFS_TRACE_VERIFY,
364 "Obj %d has parent pointer %p which does not look like an object",
365 obj->obj_id, obj->parent);
368 /* Verify parent is a directory */
370 && obj->parent->variant_type != YAFFS_OBJECT_TYPE_DIRECTORY) {
371 yaffs_trace(YAFFS_TRACE_VERIFY,
372 "Obj %d's parent is not a directory (type %d)",
373 obj->obj_id, obj->parent->variant_type);
376 switch (obj->variant_type) {
377 case YAFFS_OBJECT_TYPE_FILE:
378 yaffs_verify_file(obj);
380 case YAFFS_OBJECT_TYPE_SYMLINK:
381 yaffs_verify_symlink(obj);
383 case YAFFS_OBJECT_TYPE_DIRECTORY:
384 yaffs_verify_dir(obj);
386 case YAFFS_OBJECT_TYPE_HARDLINK:
387 yaffs_verify_link(obj);
389 case YAFFS_OBJECT_TYPE_SPECIAL:
390 yaffs_verify_special(obj);
392 case YAFFS_OBJECT_TYPE_UNKNOWN:
394 yaffs_trace(YAFFS_TRACE_VERIFY,
395 "Obj %d has illegaltype %d",
396 obj->obj_id, obj->variant_type);
401 void yaffs_verify_objects(struct yaffs_dev *dev)
403 struct yaffs_obj *obj;
405 struct list_head *lh;
407 if (yaffs_skip_verification(dev))
410 /* Iterate through the objects in each hash entry */
412 for (i = 0; i < YAFFS_NOBJECT_BUCKETS; i++) {
413 list_for_each(lh, &dev->obj_bucket[i].list) {
414 obj = list_entry(lh, struct yaffs_obj, hash_link);
415 yaffs_verify_obj(obj);
420 void yaffs_verify_obj_in_dir(struct yaffs_obj *obj)
422 struct list_head *lh;
423 struct yaffs_obj *list_obj;
427 yaffs_trace(YAFFS_TRACE_ALWAYS, "No object to verify");
432 if (yaffs_skip_verification(obj->my_dev))
436 yaffs_trace(YAFFS_TRACE_ALWAYS, "Object does not have parent");
441 if (obj->parent->variant_type != YAFFS_OBJECT_TYPE_DIRECTORY) {
442 yaffs_trace(YAFFS_TRACE_ALWAYS, "Parent is not directory");
446 /* Iterate through the objects in each hash entry */
448 list_for_each(lh, &obj->parent->variant.dir_variant.children) {
449 list_obj = list_entry(lh, struct yaffs_obj, siblings);
450 yaffs_verify_obj(list_obj);
456 yaffs_trace(YAFFS_TRACE_ALWAYS,
457 "Object in directory %d times",
463 void yaffs_verify_dir(struct yaffs_obj *directory)
465 struct list_head *lh;
466 struct yaffs_obj *list_obj;
473 if (yaffs_skip_full_verification(directory->my_dev))
476 if (directory->variant_type != YAFFS_OBJECT_TYPE_DIRECTORY) {
477 yaffs_trace(YAFFS_TRACE_ALWAYS,
478 "Directory has wrong type: %d",
479 directory->variant_type);
483 /* Iterate through the objects in each hash entry */
485 list_for_each(lh, &directory->variant.dir_variant.children) {
486 list_obj = list_entry(lh, struct yaffs_obj, siblings);
487 if (list_obj->parent != directory) {
488 yaffs_trace(YAFFS_TRACE_ALWAYS,
489 "Object in directory list has wrong parent %p",
493 yaffs_verify_obj_in_dir(list_obj);
497 static int yaffs_free_verification_failures;
499 void yaffs_verify_free_chunks(struct yaffs_dev *dev)
504 if (yaffs_skip_verification(dev))
507 counted = yaffs_count_free_chunks(dev);
509 difference = dev->n_free_chunks - counted;
512 yaffs_trace(YAFFS_TRACE_ALWAYS,
513 "Freechunks verification failure %d %d %d",
514 dev->n_free_chunks, counted, difference);
515 yaffs_free_verification_failures++;
519 int yaffs_verify_file_sane(struct yaffs_obj *in)