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_SkipVerification(yaffs_Device *dev)
24 return !(yaffs_traceMask & (YAFFS_TRACE_VERIFY | YAFFS_TRACE_VERIFY_FULL));
27 static int yaffs_SkipFullVerification(yaffs_Device *dev)
30 return !(yaffs_traceMask & (YAFFS_TRACE_VERIFY_FULL));
33 static int yaffs_SkipNANDVerification(yaffs_Device *dev)
36 return !(yaffs_traceMask & (YAFFS_TRACE_VERIFY_NAND));
40 static const char *blockStateName[] = {
54 void yaffs_VerifyBlock(yaffs_Device *dev, yaffs_BlockInfo *bi, int n)
59 if (yaffs_SkipVerification(dev))
62 /* Report illegal runtime states */
63 if (bi->blockState >= YAFFS_NUMBER_OF_BLOCK_STATES)
64 T(YAFFS_TRACE_VERIFY, (TSTR("Block %d has undefined state %d"TENDSTR), n, bi->blockState));
66 switch (bi->blockState) {
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, blockStateName[bi->blockState]));
74 /* Check pages in use and soft deletions are legal */
76 actuallyUsed = bi->pagesInUse - bi->softDeletions;
78 if (bi->pagesInUse < 0 || bi->pagesInUse > dev->param.nChunksPerBlock ||
79 bi->softDeletions < 0 || bi->softDeletions > dev->param.nChunksPerBlock ||
80 actuallyUsed < 0 || actuallyUsed > dev->param.nChunksPerBlock)
81 T(YAFFS_TRACE_VERIFY, (TSTR("Block %d has illegal values pagesInUsed %d softDeletions %d"TENDSTR),
82 n, bi->pagesInUse, bi->softDeletions));
85 /* Check chunk bitmap legal */
86 inUse = yaffs_CountChunkBits(dev, n);
87 if (inUse != bi->pagesInUse)
88 T(YAFFS_TRACE_VERIFY, (TSTR("Block %d has inconsistent values pagesInUse %d counted chunk bits %d"TENDSTR),
89 n, bi->pagesInUse, inUse));
95 void yaffs_VerifyCollectedBlock(yaffs_Device *dev, yaffs_BlockInfo *bi, int n)
97 yaffs_VerifyBlock(dev, bi, n);
99 /* After collection the block should be in the erased state */
100 /* This will need to change if we do partial gc */
102 if (bi->blockState != YAFFS_BLOCK_STATE_COLLECTING &&
103 bi->blockState != YAFFS_BLOCK_STATE_EMPTY) {
104 T(YAFFS_TRACE_ERROR, (TSTR("Block %d is in state %d after gc, should be erased"TENDSTR),
109 void yaffs_VerifyBlocks(yaffs_Device *dev)
112 int nBlocksPerState[YAFFS_NUMBER_OF_BLOCK_STATES];
113 int nIllegalBlockStates = 0;
115 if (yaffs_SkipVerification(dev))
118 memset(nBlocksPerState, 0, sizeof(nBlocksPerState));
120 for (i = dev->internalStartBlock; i <= dev->internalEndBlock; i++) {
121 yaffs_BlockInfo *bi = yaffs_GetBlockInfo(dev, i);
122 yaffs_VerifyBlock(dev, bi, i);
124 if (bi->blockState < YAFFS_NUMBER_OF_BLOCK_STATES)
125 nBlocksPerState[bi->blockState]++;
127 nIllegalBlockStates++;
130 T(YAFFS_TRACE_VERIFY, (TSTR(""TENDSTR)));
131 T(YAFFS_TRACE_VERIFY, (TSTR("Block summary"TENDSTR)));
133 T(YAFFS_TRACE_VERIFY, (TSTR("%d blocks have illegal states"TENDSTR), nIllegalBlockStates));
134 if (nBlocksPerState[YAFFS_BLOCK_STATE_ALLOCATING] > 1)
135 T(YAFFS_TRACE_VERIFY, (TSTR("Too many allocating blocks"TENDSTR)));
137 for (i = 0; i < YAFFS_NUMBER_OF_BLOCK_STATES; i++)
138 T(YAFFS_TRACE_VERIFY,
139 (TSTR("%s %d blocks"TENDSTR),
140 blockStateName[i], nBlocksPerState[i]));
142 if (dev->blocksInCheckpoint != nBlocksPerState[YAFFS_BLOCK_STATE_CHECKPOINT])
143 T(YAFFS_TRACE_VERIFY,
144 (TSTR("Checkpoint block count wrong dev %d count %d"TENDSTR),
145 dev->blocksInCheckpoint, nBlocksPerState[YAFFS_BLOCK_STATE_CHECKPOINT]));
147 if (dev->nErasedBlocks != nBlocksPerState[YAFFS_BLOCK_STATE_EMPTY])
148 T(YAFFS_TRACE_VERIFY,
149 (TSTR("Erased block count wrong dev %d count %d"TENDSTR),
150 dev->nErasedBlocks, nBlocksPerState[YAFFS_BLOCK_STATE_EMPTY]));
152 if (nBlocksPerState[YAFFS_BLOCK_STATE_COLLECTING] > 1)
153 T(YAFFS_TRACE_VERIFY,
154 (TSTR("Too many collecting blocks %d (max is 1)"TENDSTR),
155 nBlocksPerState[YAFFS_BLOCK_STATE_COLLECTING]));
157 T(YAFFS_TRACE_VERIFY, (TSTR(""TENDSTR)));
162 * Verify the object header. oh must be valid, but obj and tags may be NULL in which
163 * case those tests will not be performed.
165 void yaffs_VerifyObjectHeader(yaffs_Object *obj, yaffs_ObjectHeader *oh, yaffs_ExtendedTags *tags, int parentCheck)
167 if (obj && yaffs_SkipVerification(obj->myDev))
170 if (!(tags && obj && oh)) {
171 T(YAFFS_TRACE_VERIFY,
172 (TSTR("Verifying object header tags %p obj %p oh %p"TENDSTR),
177 if (oh->type <= YAFFS_OBJECT_TYPE_UNKNOWN ||
178 oh->type > YAFFS_OBJECT_TYPE_MAX)
179 T(YAFFS_TRACE_VERIFY,
180 (TSTR("Obj %d header type is illegal value 0x%x"TENDSTR),
181 tags->objectId, oh->type));
183 if (tags->objectId != obj->objectId)
184 T(YAFFS_TRACE_VERIFY,
185 (TSTR("Obj %d header mismatch objectId %d"TENDSTR),
186 tags->objectId, obj->objectId));
190 * Check that the object's parent ids match if parentCheck requested.
192 * Tests do not apply to the root object.
195 if (parentCheck && tags->objectId > 1 && !obj->parent)
196 T(YAFFS_TRACE_VERIFY,
197 (TSTR("Obj %d header mismatch parentId %d obj->parent is NULL"TENDSTR),
198 tags->objectId, oh->parentObjectId));
200 if (parentCheck && obj->parent &&
201 oh->parentObjectId != obj->parent->objectId &&
202 (oh->parentObjectId != YAFFS_OBJECTID_UNLINKED ||
203 obj->parent->objectId != YAFFS_OBJECTID_DELETED))
204 T(YAFFS_TRACE_VERIFY,
205 (TSTR("Obj %d header mismatch parentId %d parentObjectId %d"TENDSTR),
206 tags->objectId, oh->parentObjectId, obj->parent->objectId));
208 if (tags->objectId > 1 && oh->name[0] == 0) /* Null name */
209 T(YAFFS_TRACE_VERIFY,
210 (TSTR("Obj %d header name is NULL"TENDSTR),
213 if (tags->objectId > 1 && ((__u8)(oh->name[0])) == 0xff) /* Trashed name */
214 T(YAFFS_TRACE_VERIFY,
215 (TSTR("Obj %d header name is 0xFF"TENDSTR),
221 /* Not being used, but don't want to throw away yet */
222 int yaffs_VerifyTnodeWorker(yaffs_Object *obj, yaffs_Tnode *tn,
223 __u32 level, int chunkOffset)
226 yaffs_Device *dev = obj->myDev;
232 for (i = 0; i < YAFFS_NTNODES_INTERNAL && ok; i++) {
233 if (tn->internal[i]) {
234 ok = yaffs_VerifyTnodeWorker(obj,
237 (chunkOffset<<YAFFS_TNODES_INTERNAL_BITS) + i);
240 } else if (level == 0) {
241 yaffs_ExtendedTags tags;
242 __u32 objectId = obj->objectId;
244 chunkOffset <<= YAFFS_TNODES_LEVEL0_BITS;
246 for (i = 0; i < YAFFS_NTNODES_LEVEL0; i++) {
247 __u32 theChunk = yaffs_GetChunkGroupBase(dev, tn, i);
250 /* T(~0,(TSTR("verifying (%d:%d) %d"TENDSTR),tags.objectId,tags.chunkId,theChunk)); */
251 yaffs_ReadChunkWithTagsFromNAND(dev, theChunk, NULL, &tags);
252 if (tags.objectId != objectId || tags.chunkId != chunkOffset) {
253 T(~0, (TSTR("Object %d chunkId %d NAND mismatch chunk %d tags (%d:%d)"TENDSTR),
254 objectId, chunkOffset, theChunk,
255 tags.objectId, tags.chunkId));
269 void yaffs_VerifyFile(yaffs_Object *obj)
271 int requiredTallness;
277 yaffs_ExtendedTags tags;
284 if (yaffs_SkipVerification(obj->myDev))
288 objectId = obj->objectId;
290 /* Check file size is consistent with tnode depth */
291 lastChunk = obj->variant.fileVariant.fileSize / dev->nDataBytesPerChunk + 1;
292 x = lastChunk >> YAFFS_TNODES_LEVEL0_BITS;
293 requiredTallness = 0;
295 x >>= YAFFS_TNODES_INTERNAL_BITS;
299 actualTallness = obj->variant.fileVariant.topLevel;
301 /* Check that the chunks in the tnode tree are all correct.
302 * We do this by scanning through the tnode tree and
303 * checking the tags for every chunk match.
306 if (yaffs_SkipNANDVerification(dev))
309 for (i = 1; i <= lastChunk; i++) {
310 tn = yaffs_FindLevel0Tnode(dev, &obj->variant.fileVariant, i);
313 __u32 theChunk = yaffs_GetChunkGroupBase(dev, tn, i);
315 /* T(~0,(TSTR("verifying (%d:%d) %d"TENDSTR),objectId,i,theChunk)); */
316 yaffs_ReadChunkWithTagsFromNAND(dev, theChunk, NULL, &tags);
317 if (tags.objectId != objectId || tags.chunkId != i) {
318 T(~0, (TSTR("Object %d chunkId %d NAND mismatch chunk %d tags (%d:%d)"TENDSTR),
319 objectId, i, theChunk,
320 tags.objectId, tags.chunkId));
328 void yaffs_VerifyHardLink(yaffs_Object *obj)
330 if (obj && yaffs_SkipVerification(obj->myDev))
333 /* Verify sane equivalent object */
336 void yaffs_VerifySymlink(yaffs_Object *obj)
338 if (obj && yaffs_SkipVerification(obj->myDev))
341 /* Verify symlink string */
344 void yaffs_VerifySpecial(yaffs_Object *obj)
346 if (obj && yaffs_SkipVerification(obj->myDev))
350 void yaffs_VerifyObject(yaffs_Object *obj)
359 __u32 chunkShouldNotBeDeleted;
365 if (obj->beingCreated)
370 if (yaffs_SkipVerification(dev))
373 /* Check sane object header chunk */
375 chunkMin = dev->internalStartBlock * dev->param.nChunksPerBlock;
376 chunkMax = (dev->internalEndBlock+1) * dev->param.nChunksPerBlock - 1;
378 chunkInRange = (((unsigned)(obj->hdrChunk)) >= chunkMin && ((unsigned)(obj->hdrChunk)) <= chunkMax);
379 chunkIdOk = chunkInRange || (obj->hdrChunk == 0);
380 chunkValid = chunkInRange &&
381 yaffs_CheckChunkBit(dev,
382 obj->hdrChunk / dev->param.nChunksPerBlock,
383 obj->hdrChunk % dev->param.nChunksPerBlock);
384 chunkShouldNotBeDeleted = chunkInRange && !chunkValid;
387 (!chunkIdOk || chunkShouldNotBeDeleted)) {
388 T(YAFFS_TRACE_VERIFY,
389 (TSTR("Obj %d has chunkId %d %s %s"TENDSTR),
390 obj->objectId, obj->hdrChunk,
391 chunkIdOk ? "" : ",out of range",
392 chunkShouldNotBeDeleted ? ",marked as deleted" : ""));
395 if (chunkValid && !yaffs_SkipNANDVerification(dev)) {
396 yaffs_ExtendedTags tags;
397 yaffs_ObjectHeader *oh;
398 __u8 *buffer = yaffs_GetTempBuffer(dev, __LINE__);
400 oh = (yaffs_ObjectHeader *)buffer;
402 yaffs_ReadChunkWithTagsFromNAND(dev, obj->hdrChunk, buffer,
405 yaffs_VerifyObjectHeader(obj, oh, &tags, 1);
407 yaffs_ReleaseTempBuffer(dev, buffer, __LINE__);
410 /* Verify it has a parent */
411 if (obj && !obj->fake &&
412 (!obj->parent || obj->parent->myDev != dev)) {
413 T(YAFFS_TRACE_VERIFY,
414 (TSTR("Obj %d has parent pointer %p which does not look like an object"TENDSTR),
415 obj->objectId, obj->parent));
418 /* Verify parent is a directory */
419 if (obj->parent && obj->parent->variantType != YAFFS_OBJECT_TYPE_DIRECTORY) {
420 T(YAFFS_TRACE_VERIFY,
421 (TSTR("Obj %d's parent is not a directory (type %d)"TENDSTR),
422 obj->objectId, obj->parent->variantType));
425 switch (obj->variantType) {
426 case YAFFS_OBJECT_TYPE_FILE:
427 yaffs_VerifyFile(obj);
429 case YAFFS_OBJECT_TYPE_SYMLINK:
430 yaffs_VerifySymlink(obj);
432 case YAFFS_OBJECT_TYPE_DIRECTORY:
433 yaffs_VerifyDirectory(obj);
435 case YAFFS_OBJECT_TYPE_HARDLINK:
436 yaffs_VerifyHardLink(obj);
438 case YAFFS_OBJECT_TYPE_SPECIAL:
439 yaffs_VerifySpecial(obj);
441 case YAFFS_OBJECT_TYPE_UNKNOWN:
443 T(YAFFS_TRACE_VERIFY,
444 (TSTR("Obj %d has illegaltype %d"TENDSTR),
445 obj->objectId, obj->variantType));
450 void yaffs_VerifyObjects(yaffs_Device *dev)
454 struct ylist_head *lh;
456 if (yaffs_SkipVerification(dev))
459 /* Iterate through the objects in each hash entry */
461 for (i = 0; i < YAFFS_NOBJECT_BUCKETS; i++) {
462 ylist_for_each(lh, &dev->objectBucket[i].list) {
464 obj = ylist_entry(lh, yaffs_Object, hashLink);
465 yaffs_VerifyObject(obj);
472 void yaffs_VerifyObjectInDirectory(yaffs_Object *obj)
474 struct ylist_head *lh;
475 yaffs_Object *listObj;
480 T(YAFFS_TRACE_ALWAYS, (TSTR("No object to verify" TENDSTR)));
485 if (yaffs_SkipVerification(obj->myDev))
489 T(YAFFS_TRACE_ALWAYS, (TSTR("Object does not have parent" TENDSTR)));
494 if (obj->parent->variantType != YAFFS_OBJECT_TYPE_DIRECTORY) {
495 T(YAFFS_TRACE_ALWAYS, (TSTR("Parent is not directory" TENDSTR)));
499 /* Iterate through the objects in each hash entry */
501 ylist_for_each(lh, &obj->parent->variant.directoryVariant.children) {
503 listObj = ylist_entry(lh, yaffs_Object, siblings);
504 yaffs_VerifyObject(listObj);
511 T(YAFFS_TRACE_ALWAYS, (TSTR("Object in directory %d times" TENDSTR), count));
516 void yaffs_VerifyDirectory(yaffs_Object *directory)
518 struct ylist_head *lh;
519 yaffs_Object *listObj;
526 if (yaffs_SkipFullVerification(directory->myDev))
529 if (directory->variantType != YAFFS_OBJECT_TYPE_DIRECTORY) {
530 T(YAFFS_TRACE_ALWAYS, (TSTR("Directory has wrong type: %d" TENDSTR), directory->variantType));
534 /* Iterate through the objects in each hash entry */
536 ylist_for_each(lh, &directory->variant.directoryVariant.children) {
538 listObj = ylist_entry(lh, yaffs_Object, siblings);
539 if (listObj->parent != directory) {
540 T(YAFFS_TRACE_ALWAYS, (TSTR("Object in directory list has wrong parent %p" TENDSTR), listObj->parent));
543 yaffs_VerifyObjectInDirectory(listObj);
548 static int yaffs_freeVerificationFailures;
550 void yaffs_VerifyFreeChunks(yaffs_Device *dev)
555 if (yaffs_SkipVerification(dev))
558 counted = yaffs_CountFreeChunks(dev);
560 difference = dev->nFreeChunks - counted;
563 T(YAFFS_TRACE_ALWAYS,
564 (TSTR("Freechunks verification failure %d %d %d" TENDSTR),
565 dev->nFreeChunks, counted, difference));
566 yaffs_freeVerificationFailures++;
570 int yaffs_VerifyFileSanity(yaffs_Object *in)
579 yaffs_Tags localTags;
580 yaffs_Tags *tags = &localTags;
584 if (in->variantType != YAFFS_OBJECT_TYPE_FILE)
587 objId = in->objectId;
588 fSize = in->variant.fileVariant.fileSize;
590 (fSize + in->myDev->nDataBytesPerChunk - 1) / in->myDev->nDataBytesPerChunk;
592 for (chunk = 1; chunk <= nChunks; chunk++) {
593 tn = yaffs_FindLevel0Tnode(in->myDev, &in->variant.fileVariant,
598 theChunk = yaffs_GetChunkGroupBase(dev, tn, chunk);
600 if (yaffs_CheckChunkBits
601 (dev, theChunk / dev->param.nChunksPerBlock,
602 theChunk % dev->param.nChunksPerBlock)) {
604 yaffs_ReadChunkTagsFromNAND(in->myDev, theChunk,
608 (tags, in->objectId, chunk, chunkDeleted)) {
618 /* T(("No level 0 found for %d\n", chunk)); */
622 return failed ? YAFFS_FAIL : YAFFS_OK;