2 * YAFFS: Yet Another Flash File System. A NAND-flash specific file system.
4 * Copyright (C) 2002-2007 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 const char *yaffs_guts_c_version =
15 "$Id: yaffs_guts.c,v 1.65 2008-11-26 20:42:04 charles Exp $";
19 #include "yaffsinterface.h"
20 #include "yaffs_guts.h"
21 #include "yaffs_tagsvalidity.h"
22 #include "yaffs_getblockinfo.h"
24 #include "yaffs_tagscompat.h"
25 #ifndef CONFIG_YAFFS_USE_OWN_SORT
26 #include "yaffs_qsort.h"
28 #include "yaffs_nand.h"
30 #include "yaffs_checkptrw.h"
32 #include "yaffs_nand.h"
33 #include "yaffs_packedtags2.h"
36 #ifdef CONFIG_YAFFS_WINCE
37 void yfsd_LockYAFFS(BOOL fsLockOnly);
38 void yfsd_UnlockYAFFS(BOOL fsLockOnly);
41 #define YAFFS_PASSIVE_GC_CHUNKS 2
43 #include "yaffs_ecc.h"
46 /* Robustification (if it ever comes about...) */
47 static void yaffs_RetireBlock(yaffs_Device * dev, int blockInNAND);
48 static void yaffs_HandleWriteChunkError(yaffs_Device * dev, int chunkInNAND, int erasedOk);
49 static void yaffs_HandleWriteChunkOk(yaffs_Device * dev, int chunkInNAND,
51 const yaffs_ExtendedTags * tags);
52 static void yaffs_HandleUpdateChunk(yaffs_Device * dev, int chunkInNAND,
53 const yaffs_ExtendedTags * tags);
55 /* Other local prototypes */
56 static int yaffs_UnlinkObject( yaffs_Object *obj);
57 static int yaffs_ObjectHasCachedWriteData(yaffs_Object *obj);
59 static void yaffs_HardlinkFixup(yaffs_Device *dev, yaffs_Object *hardList);
61 static int yaffs_WriteNewChunkWithTagsToNAND(yaffs_Device * dev,
63 yaffs_ExtendedTags * tags,
65 static int yaffs_PutChunkIntoFile(yaffs_Object * in, int chunkInInode,
66 int chunkInNAND, int inScan);
68 static yaffs_Object *yaffs_CreateNewObject(yaffs_Device * dev, int number,
69 yaffs_ObjectType type);
70 static void yaffs_AddObjectToDirectory(yaffs_Object * directory,
72 static int yaffs_UpdateObjectHeader(yaffs_Object * in, const YCHAR * name,
73 int force, int isShrink, int shadows);
74 static void yaffs_RemoveObjectFromDirectory(yaffs_Object * obj);
75 static int yaffs_CheckStructures(void);
76 static int yaffs_DeleteWorker(yaffs_Object * in, yaffs_Tnode * tn, __u32 level,
77 int chunkOffset, int *limit);
78 static int yaffs_DoGenericObjectDeletion(yaffs_Object * in);
80 static yaffs_BlockInfo *yaffs_GetBlockInfo(yaffs_Device * dev, int blockNo);
83 static int yaffs_CheckChunkErased(struct yaffs_DeviceStruct *dev,
86 static int yaffs_UnlinkWorker(yaffs_Object * obj);
87 static void yaffs_DestroyObject(yaffs_Object * obj);
89 static int yaffs_TagsMatch(const yaffs_ExtendedTags * tags, int objectId,
92 loff_t yaffs_GetFileSize(yaffs_Object * obj);
94 static int yaffs_AllocateChunk(yaffs_Device * dev, int useReserve, yaffs_BlockInfo **blockUsedPtr);
96 static void yaffs_VerifyFreeChunks(yaffs_Device * dev);
98 static void yaffs_CheckObjectDetailsLoaded(yaffs_Object *in);
100 static void yaffs_VerifyDirectory(yaffs_Object *directory);
101 #ifdef YAFFS_PARANOID
102 static int yaffs_CheckFileSanity(yaffs_Object * in);
104 #define yaffs_CheckFileSanity(in)
107 static void yaffs_InvalidateWholeChunkCache(yaffs_Object * in);
108 static void yaffs_InvalidateChunkCache(yaffs_Object * object, int chunkId);
110 static void yaffs_InvalidateCheckpoint(yaffs_Device *dev);
112 static int yaffs_FindChunkInFile(yaffs_Object * in, int chunkInInode,
113 yaffs_ExtendedTags * tags);
115 static __u32 yaffs_GetChunkGroupBase(yaffs_Device *dev, yaffs_Tnode *tn, unsigned pos);
116 static yaffs_Tnode *yaffs_FindLevel0Tnode(yaffs_Device * dev,
117 yaffs_FileStructure * fStruct,
121 /* Function to calculate chunk and offset */
123 static void yaffs_AddrToChunk(yaffs_Device *dev, loff_t addr, int *chunkOut, __u32 *offsetOut)
128 chunk = (__u32)(addr >> dev->chunkShift);
130 if(dev->chunkDiv == 1)
132 /* easy power of 2 case */
133 offset = (__u32)(addr & dev->chunkMask);
137 /* Non power-of-2 case */
141 chunk /= dev->chunkDiv;
143 chunkBase = ((loff_t)chunk) * dev->nDataBytesPerChunk;
144 offset = (__u32)(addr - chunkBase);
151 /* Function to return the number of shifts for a power of 2 greater than or equal
152 * to the given number
153 * Note we don't try to cater for all possible numbers and this does not have to
154 * be hellishly efficient.
157 static __u32 ShiftsGE(__u32 x)
162 nShifts = extraBits = 0;
165 if(x & 1) extraBits++;
176 /* Function to return the number of shifts to get a 1 in bit 0
179 static __u32 Shifts(__u32 x)
198 * Temporary buffer manipulations.
201 static int yaffs_InitialiseTempBuffers(yaffs_Device *dev)
204 __u8 *buf = (__u8 *)1;
206 memset(dev->tempBuffer,0,sizeof(dev->tempBuffer));
208 for (i = 0; buf && i < YAFFS_N_TEMP_BUFFERS; i++) {
209 dev->tempBuffer[i].line = 0; /* not in use */
210 dev->tempBuffer[i].buffer = buf =
211 YMALLOC_DMA(dev->totalBytesPerChunk);
214 return buf ? YAFFS_OK : YAFFS_FAIL;
218 __u8 *yaffs_GetTempBuffer(yaffs_Device * dev, int lineNo)
223 if(dev->tempInUse > dev->maxTemp)
224 dev->maxTemp = dev->tempInUse;
226 for (i = 0; i < YAFFS_N_TEMP_BUFFERS; i++) {
227 if (dev->tempBuffer[i].line == 0) {
228 dev->tempBuffer[i].line = lineNo;
229 if ((i + 1) > dev->maxTemp) {
230 dev->maxTemp = i + 1;
231 for (j = 0; j <= i; j++)
232 dev->tempBuffer[j].maxLine =
233 dev->tempBuffer[j].line;
236 return dev->tempBuffer[i].buffer;
240 T(YAFFS_TRACE_BUFFERS,
241 (TSTR("Out of temp buffers at line %d, other held by lines:"),
243 for (i = 0; i < YAFFS_N_TEMP_BUFFERS; i++) {
244 T(YAFFS_TRACE_BUFFERS, (TSTR(" %d "), dev->tempBuffer[i].line));
246 T(YAFFS_TRACE_BUFFERS, (TSTR(" " TENDSTR)));
249 * If we got here then we have to allocate an unmanaged one
253 dev->unmanagedTempAllocations++;
254 return YMALLOC(dev->nDataBytesPerChunk);
258 void yaffs_ReleaseTempBuffer(yaffs_Device * dev, __u8 * buffer,
265 for (i = 0; i < YAFFS_N_TEMP_BUFFERS; i++) {
266 if (dev->tempBuffer[i].buffer == buffer) {
267 dev->tempBuffer[i].line = 0;
273 /* assume it is an unmanaged one. */
274 T(YAFFS_TRACE_BUFFERS,
275 (TSTR("Releasing unmanaged temp buffer in line %d" TENDSTR),
278 dev->unmanagedTempDeallocations++;
284 * Determine if we have a managed buffer.
286 int yaffs_IsManagedTempBuffer(yaffs_Device * dev, const __u8 * buffer)
289 for (i = 0; i < YAFFS_N_TEMP_BUFFERS; i++) {
290 if (dev->tempBuffer[i].buffer == buffer)
295 for (i = 0; i < dev->nShortOpCaches; i++) {
296 if( dev->srCache[i].data == buffer )
301 if (buffer == dev->checkpointBuffer)
304 T(YAFFS_TRACE_ALWAYS,
305 (TSTR("yaffs: unmaged buffer detected.\n" TENDSTR)));
312 * Chunk bitmap manipulations
315 static Y_INLINE __u8 *yaffs_BlockBits(yaffs_Device * dev, int blk)
317 if (blk < dev->internalStartBlock || blk > dev->internalEndBlock) {
319 (TSTR("**>> yaffs: BlockBits block %d is not valid" TENDSTR),
323 return dev->chunkBits +
324 (dev->chunkBitmapStride * (blk - dev->internalStartBlock));
327 static Y_INLINE void yaffs_VerifyChunkBitId(yaffs_Device *dev, int blk, int chunk)
329 if(blk < dev->internalStartBlock || blk > dev->internalEndBlock ||
330 chunk < 0 || chunk >= dev->nChunksPerBlock) {
332 (TSTR("**>> yaffs: Chunk Id (%d:%d) invalid"TENDSTR),blk,chunk));
337 static Y_INLINE void yaffs_ClearChunkBits(yaffs_Device * dev, int blk)
339 __u8 *blkBits = yaffs_BlockBits(dev, blk);
341 memset(blkBits, 0, dev->chunkBitmapStride);
344 static Y_INLINE void yaffs_ClearChunkBit(yaffs_Device * dev, int blk, int chunk)
346 __u8 *blkBits = yaffs_BlockBits(dev, blk);
348 yaffs_VerifyChunkBitId(dev,blk,chunk);
350 blkBits[chunk / 8] &= ~(1 << (chunk & 7));
353 static Y_INLINE void yaffs_SetChunkBit(yaffs_Device * dev, int blk, int chunk)
355 __u8 *blkBits = yaffs_BlockBits(dev, blk);
357 yaffs_VerifyChunkBitId(dev,blk,chunk);
359 blkBits[chunk / 8] |= (1 << (chunk & 7));
362 static Y_INLINE int yaffs_CheckChunkBit(yaffs_Device * dev, int blk, int chunk)
364 __u8 *blkBits = yaffs_BlockBits(dev, blk);
365 yaffs_VerifyChunkBitId(dev,blk,chunk);
367 return (blkBits[chunk / 8] & (1 << (chunk & 7))) ? 1 : 0;
370 static Y_INLINE int yaffs_StillSomeChunkBits(yaffs_Device * dev, int blk)
372 __u8 *blkBits = yaffs_BlockBits(dev, blk);
374 for (i = 0; i < dev->chunkBitmapStride; i++) {
382 static int yaffs_CountChunkBits(yaffs_Device * dev, int blk)
384 __u8 *blkBits = yaffs_BlockBits(dev, blk);
387 for (i = 0; i < dev->chunkBitmapStride; i++) {
404 static int yaffs_SkipVerification(yaffs_Device *dev)
406 return !(yaffs_traceMask & (YAFFS_TRACE_VERIFY | YAFFS_TRACE_VERIFY_FULL));
410 static int yaffs_SkipFullVerification(yaffs_Device *dev)
412 return !(yaffs_traceMask & (YAFFS_TRACE_VERIFY_FULL));
417 static int yaffs_SkipNANDVerification(yaffs_Device *dev)
419 return !(yaffs_traceMask & (YAFFS_TRACE_VERIFY_NAND));
422 static const char * blockStateName[] = {
435 static void yaffs_VerifyBlock(yaffs_Device *dev,yaffs_BlockInfo *bi,int n)
440 if(yaffs_SkipVerification(dev))
443 /* Report illegal runtime states */
444 if(bi->blockState >= YAFFS_NUMBER_OF_BLOCK_STATES)
445 T(YAFFS_TRACE_VERIFY,(TSTR("Block %d has undefined state %d"TENDSTR),n,bi->blockState));
447 switch(bi->blockState){
448 case YAFFS_BLOCK_STATE_UNKNOWN:
449 case YAFFS_BLOCK_STATE_SCANNING:
450 case YAFFS_BLOCK_STATE_NEEDS_SCANNING:
451 T(YAFFS_TRACE_VERIFY,(TSTR("Block %d has bad run-state %s"TENDSTR),
452 n,blockStateName[bi->blockState]));
455 /* Check pages in use and soft deletions are legal */
457 actuallyUsed = bi->pagesInUse - bi->softDeletions;
459 if(bi->pagesInUse < 0 || bi->pagesInUse > dev->nChunksPerBlock ||
460 bi->softDeletions < 0 || bi->softDeletions > dev->nChunksPerBlock ||
461 actuallyUsed < 0 || actuallyUsed > dev->nChunksPerBlock)
462 T(YAFFS_TRACE_VERIFY,(TSTR("Block %d has illegal values pagesInUsed %d softDeletions %d"TENDSTR),
463 n,bi->pagesInUse,bi->softDeletions));
466 /* Check chunk bitmap legal */
467 inUse = yaffs_CountChunkBits(dev,n);
468 if(inUse != bi->pagesInUse)
469 T(YAFFS_TRACE_VERIFY,(TSTR("Block %d has inconsistent values pagesInUse %d counted chunk bits %d"TENDSTR),
470 n,bi->pagesInUse,inUse));
472 /* Check that the sequence number is valid.
473 * Ten million is legal, but is very unlikely
476 (bi->blockState == YAFFS_BLOCK_STATE_ALLOCATING || bi->blockState == YAFFS_BLOCK_STATE_FULL) &&
477 (bi->sequenceNumber < YAFFS_LOWEST_SEQUENCE_NUMBER || bi->sequenceNumber > 10000000 ))
478 T(YAFFS_TRACE_VERIFY,(TSTR("Block %d has suspect sequence number of %d"TENDSTR),
479 n,bi->sequenceNumber));
483 static void yaffs_VerifyCollectedBlock(yaffs_Device *dev,yaffs_BlockInfo *bi,int n)
485 yaffs_VerifyBlock(dev,bi,n);
487 /* After collection the block should be in the erased state */
488 /* TODO: This will need to change if we do partial gc */
490 if(bi->blockState != YAFFS_BLOCK_STATE_EMPTY){
491 T(YAFFS_TRACE_ERROR,(TSTR("Block %d is in state %d after gc, should be erased"TENDSTR),
496 static void yaffs_VerifyBlocks(yaffs_Device *dev)
499 int nBlocksPerState[YAFFS_NUMBER_OF_BLOCK_STATES];
500 int nIllegalBlockStates = 0;
503 if(yaffs_SkipVerification(dev))
506 memset(nBlocksPerState,0,sizeof(nBlocksPerState));
509 for(i = dev->internalStartBlock; i <= dev->internalEndBlock; i++){
510 yaffs_BlockInfo *bi = yaffs_GetBlockInfo(dev,i);
511 yaffs_VerifyBlock(dev,bi,i);
513 if(bi->blockState < YAFFS_NUMBER_OF_BLOCK_STATES)
514 nBlocksPerState[bi->blockState]++;
516 nIllegalBlockStates++;
520 T(YAFFS_TRACE_VERIFY,(TSTR(""TENDSTR)));
521 T(YAFFS_TRACE_VERIFY,(TSTR("Block summary"TENDSTR)));
523 T(YAFFS_TRACE_VERIFY,(TSTR("%d blocks have illegal states"TENDSTR),nIllegalBlockStates));
524 if(nBlocksPerState[YAFFS_BLOCK_STATE_ALLOCATING] > 1)
525 T(YAFFS_TRACE_VERIFY,(TSTR("Too many allocating blocks"TENDSTR)));
527 for(i = 0; i < YAFFS_NUMBER_OF_BLOCK_STATES; i++)
528 T(YAFFS_TRACE_VERIFY,
529 (TSTR("%s %d blocks"TENDSTR),
530 blockStateName[i],nBlocksPerState[i]));
532 if(dev->blocksInCheckpoint != nBlocksPerState[YAFFS_BLOCK_STATE_CHECKPOINT])
533 T(YAFFS_TRACE_VERIFY,
534 (TSTR("Checkpoint block count wrong dev %d count %d"TENDSTR),
535 dev->blocksInCheckpoint, nBlocksPerState[YAFFS_BLOCK_STATE_CHECKPOINT]));
537 if(dev->nErasedBlocks != nBlocksPerState[YAFFS_BLOCK_STATE_EMPTY])
538 T(YAFFS_TRACE_VERIFY,
539 (TSTR("Erased block count wrong dev %d count %d"TENDSTR),
540 dev->nErasedBlocks, nBlocksPerState[YAFFS_BLOCK_STATE_EMPTY]));
542 if(nBlocksPerState[YAFFS_BLOCK_STATE_COLLECTING] > 1)
543 T(YAFFS_TRACE_VERIFY,
544 (TSTR("Too many collecting blocks %d (max is 1)"TENDSTR),
545 nBlocksPerState[YAFFS_BLOCK_STATE_COLLECTING]));
547 T(YAFFS_TRACE_VERIFY,(TSTR(""TENDSTR)));
552 * Verify the object header. oh must be valid, but obj and tags may be NULL in which
553 * case those tests will not be performed.
555 static void yaffs_VerifyObjectHeader(yaffs_Object *obj, yaffs_ObjectHeader *oh, yaffs_ExtendedTags *tags, int parentCheck)
557 if(obj && yaffs_SkipVerification(obj->myDev))
560 if(!(tags && obj && oh)){
561 T(YAFFS_TRACE_VERIFY,
562 (TSTR("Verifying object header tags %x obj %x oh %x"TENDSTR),
563 (__u32)tags,(__u32)obj,(__u32)oh));
567 if(oh->type <= YAFFS_OBJECT_TYPE_UNKNOWN ||
568 oh->type > YAFFS_OBJECT_TYPE_MAX)
569 T(YAFFS_TRACE_VERIFY,
570 (TSTR("Obj %d header type is illegal value 0x%x"TENDSTR),
571 tags->objectId, oh->type));
573 if(tags->objectId != obj->objectId)
574 T(YAFFS_TRACE_VERIFY,
575 (TSTR("Obj %d header mismatch objectId %d"TENDSTR),
576 tags->objectId, obj->objectId));
580 * Check that the object's parent ids match if parentCheck requested.
582 * Tests do not apply to the root object.
585 if(parentCheck && tags->objectId > 1 && !obj->parent)
586 T(YAFFS_TRACE_VERIFY,
587 (TSTR("Obj %d header mismatch parentId %d obj->parent is NULL"TENDSTR),
588 tags->objectId, oh->parentObjectId));
591 if(parentCheck && obj->parent &&
592 oh->parentObjectId != obj->parent->objectId &&
593 (oh->parentObjectId != YAFFS_OBJECTID_UNLINKED ||
594 obj->parent->objectId != YAFFS_OBJECTID_DELETED))
595 T(YAFFS_TRACE_VERIFY,
596 (TSTR("Obj %d header mismatch parentId %d parentObjectId %d"TENDSTR),
597 tags->objectId, oh->parentObjectId, obj->parent->objectId));
600 if(tags->objectId > 1 && oh->name[0] == 0) /* Null name */
601 T(YAFFS_TRACE_VERIFY,
602 (TSTR("Obj %d header name is NULL"TENDSTR),
605 if(tags->objectId > 1 && ((__u8)(oh->name[0])) == 0xff) /* Trashed name */
606 T(YAFFS_TRACE_VERIFY,
607 (TSTR("Obj %d header name is 0xFF"TENDSTR),
613 static int yaffs_VerifyTnodeWorker(yaffs_Object * obj, yaffs_Tnode * tn,
614 __u32 level, int chunkOffset)
617 yaffs_Device *dev = obj->myDev;
623 for (i = 0; i < YAFFS_NTNODES_INTERNAL && ok; i++){
624 if (tn->internal[i]) {
625 ok = yaffs_VerifyTnodeWorker(obj,
628 (chunkOffset<<YAFFS_TNODES_INTERNAL_BITS) + i);
631 } else if (level == 0) {
632 yaffs_ExtendedTags tags;
633 __u32 objectId = obj->objectId;
635 chunkOffset <<= YAFFS_TNODES_LEVEL0_BITS;
637 for(i = 0; i < YAFFS_NTNODES_LEVEL0; i++){
638 __u32 theChunk = yaffs_GetChunkGroupBase(dev,tn,i);
641 /* T(~0,(TSTR("verifying (%d:%d) %d"TENDSTR),tags.objectId,tags.chunkId,theChunk)); */
642 yaffs_ReadChunkWithTagsFromNAND(dev,theChunk,NULL, &tags);
643 if(tags.objectId != objectId || tags.chunkId != chunkOffset){
644 T(~0,(TSTR("Object %d chunkId %d NAND mismatch chunk %d tags (%d:%d)"TENDSTR),
645 objectId, chunkOffset, theChunk,
646 tags.objectId, tags.chunkId));
659 static void yaffs_VerifyFile(yaffs_Object *obj)
661 int requiredTallness;
667 yaffs_ExtendedTags tags;
674 if(yaffs_SkipVerification(obj->myDev))
678 objectId = obj->objectId;
680 /* Check file size is consistent with tnode depth */
681 lastChunk = obj->variant.fileVariant.fileSize / dev->nDataBytesPerChunk + 1;
682 x = lastChunk >> YAFFS_TNODES_LEVEL0_BITS;
683 requiredTallness = 0;
685 x >>= YAFFS_TNODES_INTERNAL_BITS;
689 actualTallness = obj->variant.fileVariant.topLevel;
691 if(requiredTallness > actualTallness )
692 T(YAFFS_TRACE_VERIFY,
693 (TSTR("Obj %d had tnode tallness %d, needs to be %d"TENDSTR),
694 obj->objectId,actualTallness, requiredTallness));
697 /* Check that the chunks in the tnode tree are all correct.
698 * We do this by scanning through the tnode tree and
699 * checking the tags for every chunk match.
702 if(yaffs_SkipNANDVerification(dev))
705 for(i = 1; i <= lastChunk; i++){
706 tn = yaffs_FindLevel0Tnode(dev, &obj->variant.fileVariant,i);
709 __u32 theChunk = yaffs_GetChunkGroupBase(dev,tn,i);
711 /* T(~0,(TSTR("verifying (%d:%d) %d"TENDSTR),objectId,i,theChunk)); */
712 yaffs_ReadChunkWithTagsFromNAND(dev,theChunk,NULL, &tags);
713 if(tags.objectId != objectId || tags.chunkId != i){
714 T(~0,(TSTR("Object %d chunkId %d NAND mismatch chunk %d tags (%d:%d)"TENDSTR),
715 objectId, i, theChunk,
716 tags.objectId, tags.chunkId));
726 static void yaffs_VerifyHardLink(yaffs_Object *obj)
728 if(obj && yaffs_SkipVerification(obj->myDev))
731 /* Verify sane equivalent object */
734 static void yaffs_VerifySymlink(yaffs_Object *obj)
736 if(obj && yaffs_SkipVerification(obj->myDev))
739 /* Verify symlink string */
742 static void yaffs_VerifySpecial(yaffs_Object *obj)
744 if(obj && yaffs_SkipVerification(obj->myDev))
748 static void yaffs_VerifyObject(yaffs_Object *obj)
763 if(yaffs_SkipVerification(dev))
766 /* Check sane object header chunk */
768 chunkMin = dev->internalStartBlock * dev->nChunksPerBlock;
769 chunkMax = (dev->internalEndBlock+1) * dev->nChunksPerBlock - 1;
771 chunkIdOk = (((unsigned)(obj->hdrChunk)) >= chunkMin && ((unsigned)(obj->hdrChunk)) <= chunkMax);
772 chunkIsLive = chunkIdOk &&
773 yaffs_CheckChunkBit(dev,
774 obj->hdrChunk / dev->nChunksPerBlock,
775 obj->hdrChunk % dev->nChunksPerBlock);
777 (!chunkIdOk || !chunkIsLive)) {
778 T(YAFFS_TRACE_VERIFY,
779 (TSTR("Obj %d has chunkId %d %s %s"TENDSTR),
780 obj->objectId,obj->hdrChunk,
781 chunkIdOk ? "" : ",out of range",
782 chunkIsLive || !chunkIdOk ? "" : ",marked as deleted"));
785 if(chunkIdOk && chunkIsLive &&!yaffs_SkipNANDVerification(dev)) {
786 yaffs_ExtendedTags tags;
787 yaffs_ObjectHeader *oh;
788 __u8 *buffer = yaffs_GetTempBuffer(dev,__LINE__);
790 oh = (yaffs_ObjectHeader *)buffer;
792 yaffs_ReadChunkWithTagsFromNAND(dev, obj->hdrChunk,buffer, &tags);
794 yaffs_VerifyObjectHeader(obj,oh,&tags,1);
796 yaffs_ReleaseTempBuffer(dev,buffer,__LINE__);
799 /* Verify it has a parent */
800 if(obj && !obj->fake &&
801 (!obj->parent || obj->parent->myDev != dev)){
802 T(YAFFS_TRACE_VERIFY,
803 (TSTR("Obj %d has parent pointer %p which does not look like an object"TENDSTR),
804 obj->objectId,obj->parent));
807 /* Verify parent is a directory */
808 if(obj->parent && obj->parent->variantType != YAFFS_OBJECT_TYPE_DIRECTORY){
809 T(YAFFS_TRACE_VERIFY,
810 (TSTR("Obj %d's parent is not a directory (type %d)"TENDSTR),
811 obj->objectId,obj->parent->variantType));
814 switch(obj->variantType){
815 case YAFFS_OBJECT_TYPE_FILE:
816 yaffs_VerifyFile(obj);
818 case YAFFS_OBJECT_TYPE_SYMLINK:
819 yaffs_VerifySymlink(obj);
821 case YAFFS_OBJECT_TYPE_DIRECTORY:
822 yaffs_VerifyDirectory(obj);
824 case YAFFS_OBJECT_TYPE_HARDLINK:
825 yaffs_VerifyHardLink(obj);
827 case YAFFS_OBJECT_TYPE_SPECIAL:
828 yaffs_VerifySpecial(obj);
830 case YAFFS_OBJECT_TYPE_UNKNOWN:
832 T(YAFFS_TRACE_VERIFY,
833 (TSTR("Obj %d has illegaltype %d"TENDSTR),
834 obj->objectId,obj->variantType));
841 static void yaffs_VerifyObjects(yaffs_Device *dev)
845 struct ylist_head *lh;
847 if(yaffs_SkipVerification(dev))
850 /* Iterate through the objects in each hash entry */
852 for(i = 0; i < YAFFS_NOBJECT_BUCKETS; i++){
853 ylist_for_each(lh, &dev->objectBucket[i].list) {
855 obj = ylist_entry(lh, yaffs_Object, hashLink);
856 yaffs_VerifyObject(obj);
865 * Simple hash function. Needs to have a reasonable spread
868 static Y_INLINE int yaffs_HashFunction(int n)
871 return (n % YAFFS_NOBJECT_BUCKETS);
875 * Access functions to useful fake objects.
876 * Note that root might have a presence in NAND if permissions are set.
879 yaffs_Object *yaffs_Root(yaffs_Device * dev)
884 yaffs_Object *yaffs_LostNFound(yaffs_Device * dev)
886 return dev->lostNFoundDir;
891 * Erased NAND checking functions
894 int yaffs_CheckFF(__u8 * buffer, int nBytes)
896 /* Horrible, slow implementation */
905 static int yaffs_CheckChunkErased(struct yaffs_DeviceStruct *dev,
909 int retval = YAFFS_OK;
910 __u8 *data = yaffs_GetTempBuffer(dev, __LINE__);
911 yaffs_ExtendedTags tags;
914 result = yaffs_ReadChunkWithTagsFromNAND(dev, chunkInNAND, data, &tags);
916 if(tags.eccResult > YAFFS_ECC_RESULT_NO_ERROR)
920 if (!yaffs_CheckFF(data, dev->nDataBytesPerChunk) || tags.chunkUsed) {
921 T(YAFFS_TRACE_NANDACCESS,
922 (TSTR("Chunk %d not erased" TENDSTR), chunkInNAND));
926 yaffs_ReleaseTempBuffer(dev, data, __LINE__);
932 static int yaffs_WriteNewChunkWithTagsToNAND(struct yaffs_DeviceStruct *dev,
934 yaffs_ExtendedTags * tags,
941 yaffs_InvalidateCheckpoint(dev);
944 yaffs_BlockInfo *bi = 0;
947 chunk = yaffs_AllocateChunk(dev, useReserve, &bi);
953 /* First check this chunk is erased, if it needs
954 * checking. The checking policy (unless forced
955 * always on) is as follows:
957 * Check the first page we try to write in a block.
958 * If the check passes then we don't need to check any
959 * more. If the check fails, we check again...
960 * If the block has been erased, we don't need to check.
962 * However, if the block has been prioritised for gc,
963 * then we think there might be something odd about
964 * this block and stop using it.
966 * Rationale: We should only ever see chunks that have
967 * not been erased if there was a partially written
968 * chunk due to power loss. This checking policy should
969 * catch that case with very few checks and thus save a
970 * lot of checks that are most likely not needed.
972 if (bi->gcPrioritise) {
973 yaffs_DeleteChunk(dev, chunk, 1, __LINE__);
974 /* try another chunk */
978 /* let's give it a try */
981 #ifdef CONFIG_YAFFS_ALWAYS_CHECK_CHUNK_ERASED
982 bi->skipErasedCheck = 0;
984 if (!bi->skipErasedCheck) {
985 erasedOk = yaffs_CheckChunkErased(dev, chunk);
986 if (erasedOk != YAFFS_OK) {
988 (TSTR ("**>> yaffs chunk %d was not erased"
991 /* try another chunk */
994 bi->skipErasedCheck = 1;
997 writeOk = yaffs_WriteChunkWithTagsToNAND(dev, chunk,
999 if (writeOk != YAFFS_OK) {
1000 yaffs_HandleWriteChunkError(dev, chunk, erasedOk);
1001 /* try another chunk */
1005 /* Copy the data into the robustification buffer */
1006 yaffs_HandleWriteChunkOk(dev, chunk, data, tags);
1008 } while (writeOk != YAFFS_OK &&
1009 (yaffs_wr_attempts <= 0 || attempts <= yaffs_wr_attempts));
1015 T(YAFFS_TRACE_ERROR,
1016 (TSTR("**>> yaffs write required %d attempts" TENDSTR),
1019 dev->nRetriedWrites += (attempts - 1);
1026 * Block retiring for handling a broken block.
1029 static void yaffs_RetireBlock(yaffs_Device * dev, int blockInNAND)
1031 yaffs_BlockInfo *bi = yaffs_GetBlockInfo(dev, blockInNAND);
1033 yaffs_InvalidateCheckpoint(dev);
1035 yaffs_MarkBlockBad(dev, blockInNAND);
1037 bi->blockState = YAFFS_BLOCK_STATE_DEAD;
1038 bi->gcPrioritise = 0;
1039 bi->needsRetiring = 0;
1041 dev->nRetiredBlocks++;
1045 * Functions for robustisizing TODO
1049 static void yaffs_HandleWriteChunkOk(yaffs_Device * dev, int chunkInNAND,
1051 const yaffs_ExtendedTags * tags)
1055 static void yaffs_HandleUpdateChunk(yaffs_Device * dev, int chunkInNAND,
1056 const yaffs_ExtendedTags * tags)
1060 void yaffs_HandleChunkError(yaffs_Device *dev, yaffs_BlockInfo *bi)
1062 if(!bi->gcPrioritise){
1063 bi->gcPrioritise = 1;
1064 dev->hasPendingPrioritisedGCs = 1;
1065 bi->chunkErrorStrikes ++;
1067 if(bi->chunkErrorStrikes > 3){
1068 bi->needsRetiring = 1; /* Too many stikes, so retire this */
1069 T(YAFFS_TRACE_ALWAYS, (TSTR("yaffs: Block struck out" TENDSTR)));
1076 static void yaffs_HandleWriteChunkError(yaffs_Device * dev, int chunkInNAND, int erasedOk)
1079 int blockInNAND = chunkInNAND / dev->nChunksPerBlock;
1080 yaffs_BlockInfo *bi = yaffs_GetBlockInfo(dev, blockInNAND);
1082 yaffs_HandleChunkError(dev,bi);
1086 /* Was an actual write failure, so mark the block for retirement */
1087 bi->needsRetiring = 1;
1088 T(YAFFS_TRACE_ERROR | YAFFS_TRACE_BAD_BLOCKS,
1089 (TSTR("**>> Block %d needs retiring" TENDSTR), blockInNAND));
1094 /* Delete the chunk */
1095 yaffs_DeleteChunk(dev, chunkInNAND, 1, __LINE__);
1099 /*---------------- Name handling functions ------------*/
1101 static __u16 yaffs_CalcNameSum(const YCHAR * name)
1106 const YUCHAR *bname = (const YUCHAR *) name;
1108 while ((*bname) && (i < (YAFFS_MAX_NAME_LENGTH/2))) {
1110 #ifdef CONFIG_YAFFS_CASE_INSENSITIVE
1111 sum += yaffs_toupper(*bname) * i;
1113 sum += (*bname) * i;
1123 static void yaffs_SetObjectName(yaffs_Object * obj, const YCHAR * name)
1125 #ifdef CONFIG_YAFFS_SHORT_NAMES_IN_RAM
1126 memset(obj->shortName,0,sizeof (YCHAR) * (YAFFS_SHORT_NAME_LENGTH+1));
1127 if (name && yaffs_strlen(name) <= YAFFS_SHORT_NAME_LENGTH) {
1128 yaffs_strcpy(obj->shortName, name);
1130 obj->shortName[0] = _Y('\0');
1133 obj->sum = yaffs_CalcNameSum(name);
1136 /*-------------------- TNODES -------------------
1138 * List of spare tnodes
1139 * The list is hooked together using the first pointer
1143 /* yaffs_CreateTnodes creates a bunch more tnodes and
1144 * adds them to the tnode free list.
1145 * Don't use this function directly
1148 static int yaffs_CreateTnodes(yaffs_Device * dev, int nTnodes)
1152 yaffs_Tnode *newTnodes;
1156 yaffs_TnodeList *tnl;
1161 /* Calculate the tnode size in bytes for variable width tnode support.
1162 * Must be a multiple of 32-bits */
1163 tnodeSize = (dev->tnodeWidth * YAFFS_NTNODES_LEVEL0)/8;
1165 if(tnodeSize < sizeof(yaffs_Tnode))
1166 tnodeSize = sizeof(yaffs_Tnode);
1169 /* make these things */
1171 newTnodes = YMALLOC(nTnodes * tnodeSize);
1172 mem = (__u8 *)newTnodes;
1175 T(YAFFS_TRACE_ERROR,
1176 (TSTR("yaffs: Could not allocate Tnodes" TENDSTR)));
1180 /* Hook them into the free list */
1182 for (i = 0; i < nTnodes - 1; i++) {
1183 newTnodes[i].internal[0] = &newTnodes[i + 1];
1184 #ifdef CONFIG_YAFFS_TNODE_LIST_DEBUG
1185 newTnodes[i].internal[YAFFS_NTNODES_INTERNAL] = (void *)1;
1189 newTnodes[nTnodes - 1].internal[0] = dev->freeTnodes;
1190 #ifdef CONFIG_YAFFS_TNODE_LIST_DEBUG
1191 newTnodes[nTnodes - 1].internal[YAFFS_NTNODES_INTERNAL] = (void *)1;
1193 dev->freeTnodes = newTnodes;
1195 /* New hookup for wide tnodes */
1196 for(i = 0; i < nTnodes -1; i++) {
1197 curr = (yaffs_Tnode *) &mem[i * tnodeSize];
1198 next = (yaffs_Tnode *) &mem[(i+1) * tnodeSize];
1199 curr->internal[0] = next;
1202 curr = (yaffs_Tnode *) &mem[(nTnodes - 1) * tnodeSize];
1203 curr->internal[0] = dev->freeTnodes;
1204 dev->freeTnodes = (yaffs_Tnode *)mem;
1209 dev->nFreeTnodes += nTnodes;
1210 dev->nTnodesCreated += nTnodes;
1212 /* Now add this bunch of tnodes to a list for freeing up.
1213 * NB If we can't add this to the management list it isn't fatal
1214 * but it just means we can't free this bunch of tnodes later.
1217 tnl = YMALLOC(sizeof(yaffs_TnodeList));
1219 T(YAFFS_TRACE_ERROR,
1221 ("yaffs: Could not add tnodes to management list" TENDSTR)));
1225 tnl->tnodes = newTnodes;
1226 tnl->next = dev->allocatedTnodeList;
1227 dev->allocatedTnodeList = tnl;
1230 T(YAFFS_TRACE_ALLOCATE, (TSTR("yaffs: Tnodes added" TENDSTR)));
1235 /* GetTnode gets us a clean tnode. Tries to make allocate more if we run out */
1237 static yaffs_Tnode *yaffs_GetTnodeRaw(yaffs_Device * dev)
1239 yaffs_Tnode *tn = NULL;
1241 /* If there are none left make more */
1242 if (!dev->freeTnodes) {
1243 yaffs_CreateTnodes(dev, YAFFS_ALLOCATION_NTNODES);
1246 if (dev->freeTnodes) {
1247 tn = dev->freeTnodes;
1248 #ifdef CONFIG_YAFFS_TNODE_LIST_DEBUG
1249 if (tn->internal[YAFFS_NTNODES_INTERNAL] != (void *)1) {
1250 /* Hoosterman, this thing looks like it isn't in the list */
1251 T(YAFFS_TRACE_ALWAYS,
1252 (TSTR("yaffs: Tnode list bug 1" TENDSTR)));
1255 dev->freeTnodes = dev->freeTnodes->internal[0];
1259 dev->nCheckpointBlocksRequired = 0; /* force recalculation*/
1264 static yaffs_Tnode *yaffs_GetTnode(yaffs_Device * dev)
1266 yaffs_Tnode *tn = yaffs_GetTnodeRaw(dev);
1267 int tnodeSize = (dev->tnodeWidth * YAFFS_NTNODES_LEVEL0)/8;
1269 if(tnodeSize < sizeof(yaffs_Tnode))
1270 tnodeSize = sizeof(yaffs_Tnode);
1273 memset(tn, 0, tnodeSize);
1278 /* FreeTnode frees up a tnode and puts it back on the free list */
1279 static void yaffs_FreeTnode(yaffs_Device * dev, yaffs_Tnode * tn)
1282 #ifdef CONFIG_YAFFS_TNODE_LIST_DEBUG
1283 if (tn->internal[YAFFS_NTNODES_INTERNAL] != 0) {
1284 /* Hoosterman, this thing looks like it is already in the list */
1285 T(YAFFS_TRACE_ALWAYS,
1286 (TSTR("yaffs: Tnode list bug 2" TENDSTR)));
1288 tn->internal[YAFFS_NTNODES_INTERNAL] = (void *)1;
1290 tn->internal[0] = dev->freeTnodes;
1291 dev->freeTnodes = tn;
1294 dev->nCheckpointBlocksRequired = 0; /* force recalculation*/
1298 static void yaffs_DeinitialiseTnodes(yaffs_Device * dev)
1300 /* Free the list of allocated tnodes */
1301 yaffs_TnodeList *tmp;
1303 while (dev->allocatedTnodeList) {
1304 tmp = dev->allocatedTnodeList->next;
1306 YFREE(dev->allocatedTnodeList->tnodes);
1307 YFREE(dev->allocatedTnodeList);
1308 dev->allocatedTnodeList = tmp;
1312 dev->freeTnodes = NULL;
1313 dev->nFreeTnodes = 0;
1316 static void yaffs_InitialiseTnodes(yaffs_Device * dev)
1318 dev->allocatedTnodeList = NULL;
1319 dev->freeTnodes = NULL;
1320 dev->nFreeTnodes = 0;
1321 dev->nTnodesCreated = 0;
1326 void yaffs_PutLevel0Tnode(yaffs_Device *dev, yaffs_Tnode *tn, unsigned pos, unsigned val)
1328 __u32 *map = (__u32 *)tn;
1334 pos &= YAFFS_TNODES_LEVEL0_MASK;
1335 val >>= dev->chunkGroupBits;
1337 bitInMap = pos * dev->tnodeWidth;
1338 wordInMap = bitInMap /32;
1339 bitInWord = bitInMap & (32 -1);
1341 mask = dev->tnodeMask << bitInWord;
1343 map[wordInMap] &= ~mask;
1344 map[wordInMap] |= (mask & (val << bitInWord));
1346 if(dev->tnodeWidth > (32-bitInWord)) {
1347 bitInWord = (32 - bitInWord);
1349 mask = dev->tnodeMask >> (/*dev->tnodeWidth -*/ bitInWord);
1350 map[wordInMap] &= ~mask;
1351 map[wordInMap] |= (mask & (val >> bitInWord));
1355 static __u32 yaffs_GetChunkGroupBase(yaffs_Device *dev, yaffs_Tnode *tn, unsigned pos)
1357 __u32 *map = (__u32 *)tn;
1363 pos &= YAFFS_TNODES_LEVEL0_MASK;
1365 bitInMap = pos * dev->tnodeWidth;
1366 wordInMap = bitInMap /32;
1367 bitInWord = bitInMap & (32 -1);
1369 val = map[wordInMap] >> bitInWord;
1371 if(dev->tnodeWidth > (32-bitInWord)) {
1372 bitInWord = (32 - bitInWord);
1374 val |= (map[wordInMap] << bitInWord);
1377 val &= dev->tnodeMask;
1378 val <<= dev->chunkGroupBits;
1383 /* ------------------- End of individual tnode manipulation -----------------*/
1385 /* ---------Functions to manipulate the look-up tree (made up of tnodes) ------
1386 * The look up tree is represented by the top tnode and the number of topLevel
1387 * in the tree. 0 means only the level 0 tnode is in the tree.
1390 /* FindLevel0Tnode finds the level 0 tnode, if one exists. */
1391 static yaffs_Tnode *yaffs_FindLevel0Tnode(yaffs_Device * dev,
1392 yaffs_FileStructure * fStruct,
1396 yaffs_Tnode *tn = fStruct->top;
1398 int requiredTallness;
1399 int level = fStruct->topLevel;
1401 /* Check sane level and chunk Id */
1402 if (level < 0 || level > YAFFS_TNODES_MAX_LEVEL) {
1406 if (chunkId > YAFFS_MAX_CHUNK_ID) {
1410 /* First check we're tall enough (ie enough topLevel) */
1412 i = chunkId >> YAFFS_TNODES_LEVEL0_BITS;
1413 requiredTallness = 0;
1415 i >>= YAFFS_TNODES_INTERNAL_BITS;
1419 if (requiredTallness > fStruct->topLevel) {
1420 /* Not tall enough, so we can't find it, return NULL. */
1424 /* Traverse down to level 0 */
1425 while (level > 0 && tn) {
1427 internal[(chunkId >>
1428 ( YAFFS_TNODES_LEVEL0_BITS +
1430 YAFFS_TNODES_INTERNAL_BITS)
1432 YAFFS_TNODES_INTERNAL_MASK];
1440 /* AddOrFindLevel0Tnode finds the level 0 tnode if it exists, otherwise first expands the tree.
1441 * This happens in two steps:
1442 * 1. If the tree isn't tall enough, then make it taller.
1443 * 2. Scan down the tree towards the level 0 tnode adding tnodes if required.
1445 * Used when modifying the tree.
1447 * If the tn argument is NULL, then a fresh tnode will be added otherwise the specified tn will
1448 * be plugged into the ttree.
1451 static yaffs_Tnode *yaffs_AddOrFindLevel0Tnode(yaffs_Device * dev,
1452 yaffs_FileStructure * fStruct,
1454 yaffs_Tnode *passedTn)
1457 int requiredTallness;
1465 /* Check sane level and page Id */
1466 if (fStruct->topLevel < 0 || fStruct->topLevel > YAFFS_TNODES_MAX_LEVEL) {
1470 if (chunkId > YAFFS_MAX_CHUNK_ID) {
1474 /* First check we're tall enough (ie enough topLevel) */
1476 x = chunkId >> YAFFS_TNODES_LEVEL0_BITS;
1477 requiredTallness = 0;
1479 x >>= YAFFS_TNODES_INTERNAL_BITS;
1484 if (requiredTallness > fStruct->topLevel) {
1485 /* Not tall enough,gotta make the tree taller */
1486 for (i = fStruct->topLevel; i < requiredTallness; i++) {
1488 tn = yaffs_GetTnode(dev);
1491 tn->internal[0] = fStruct->top;
1494 T(YAFFS_TRACE_ERROR,
1495 (TSTR("yaffs: no more tnodes" TENDSTR)));
1499 fStruct->topLevel = requiredTallness;
1502 /* Traverse down to level 0, adding anything we need */
1504 l = fStruct->topLevel;
1508 while (l > 0 && tn) {
1510 ( YAFFS_TNODES_LEVEL0_BITS +
1511 (l - 1) * YAFFS_TNODES_INTERNAL_BITS)) &
1512 YAFFS_TNODES_INTERNAL_MASK;
1515 if((l>1) && !tn->internal[x]){
1516 /* Add missing non-level-zero tnode */
1517 tn->internal[x] = yaffs_GetTnode(dev);
1520 /* Looking from level 1 at level 0 */
1522 /* If we already have one, then release it.*/
1524 yaffs_FreeTnode(dev,tn->internal[x]);
1525 tn->internal[x] = passedTn;
1527 } else if(!tn->internal[x]) {
1528 /* Don't have one, none passed in */
1529 tn->internal[x] = yaffs_GetTnode(dev);
1533 tn = tn->internal[x];
1537 /* top is level 0 */
1539 memcpy(tn,passedTn,(dev->tnodeWidth * YAFFS_NTNODES_LEVEL0)/8);
1540 yaffs_FreeTnode(dev,passedTn);
1547 static int yaffs_FindChunkInGroup(yaffs_Device * dev, int theChunk,
1548 yaffs_ExtendedTags * tags, int objectId,
1553 for (j = 0; theChunk && j < dev->chunkGroupSize; j++) {
1554 if (yaffs_CheckChunkBit
1555 (dev, theChunk / dev->nChunksPerBlock,
1556 theChunk % dev->nChunksPerBlock)) {
1557 yaffs_ReadChunkWithTagsFromNAND(dev, theChunk, NULL,
1559 if (yaffs_TagsMatch(tags, objectId, chunkInInode)) {
1571 /* DeleteWorker scans backwards through the tnode tree and deletes all the
1572 * chunks and tnodes in the file
1573 * Returns 1 if the tree was deleted.
1574 * Returns 0 if it stopped early due to hitting the limit and the delete is incomplete.
1577 static int yaffs_DeleteWorker(yaffs_Object * in, yaffs_Tnode * tn, __u32 level,
1578 int chunkOffset, int *limit)
1583 yaffs_ExtendedTags tags;
1585 yaffs_Device *dev = in->myDev;
1592 for (i = YAFFS_NTNODES_INTERNAL - 1; allDone && i >= 0;
1594 if (tn->internal[i]) {
1595 if (limit && (*limit) < 0) {
1599 yaffs_DeleteWorker(in,
1607 YAFFS_TNODES_INTERNAL_BITS)
1612 yaffs_FreeTnode(dev,
1615 tn->internal[i] = NULL;
1620 return (allDone) ? 1 : 0;
1621 } else if (level == 0) {
1624 for (i = YAFFS_NTNODES_LEVEL0 - 1; i >= 0 && !hitLimit;
1626 theChunk = yaffs_GetChunkGroupBase(dev,tn,i);
1631 YAFFS_TNODES_LEVEL0_BITS) + i;
1634 yaffs_FindChunkInGroup(dev,
1640 if (foundChunk > 0) {
1641 yaffs_DeleteChunk(dev,
1646 *limit = *limit - 1;
1654 yaffs_PutLevel0Tnode(dev,tn,i,0);
1658 return (i < 0) ? 1 : 0;
1668 static void yaffs_SoftDeleteChunk(yaffs_Device * dev, int chunk)
1671 yaffs_BlockInfo *theBlock;
1673 T(YAFFS_TRACE_DELETION, (TSTR("soft delete chunk %d" TENDSTR), chunk));
1675 theBlock = yaffs_GetBlockInfo(dev, chunk / dev->nChunksPerBlock);
1677 theBlock->softDeletions++;
1682 /* SoftDeleteWorker scans backwards through the tnode tree and soft deletes all the chunks in the file.
1683 * All soft deleting does is increment the block's softdelete count and pulls the chunk out
1685 * Thus, essentially this is the same as DeleteWorker except that the chunks are soft deleted.
1688 static int yaffs_SoftDeleteWorker(yaffs_Object * in, yaffs_Tnode * tn,
1689 __u32 level, int chunkOffset)
1694 yaffs_Device *dev = in->myDev;
1699 for (i = YAFFS_NTNODES_INTERNAL - 1; allDone && i >= 0;
1701 if (tn->internal[i]) {
1703 yaffs_SoftDeleteWorker(in,
1709 YAFFS_TNODES_INTERNAL_BITS)
1712 yaffs_FreeTnode(dev,
1715 tn->internal[i] = NULL;
1717 /* Hoosterman... how could this happen? */
1721 return (allDone) ? 1 : 0;
1722 } else if (level == 0) {
1724 for (i = YAFFS_NTNODES_LEVEL0 - 1; i >= 0; i--) {
1725 theChunk = yaffs_GetChunkGroupBase(dev,tn,i);
1727 /* Note this does not find the real chunk, only the chunk group.
1728 * We make an assumption that a chunk group is not larger than
1731 yaffs_SoftDeleteChunk(dev, theChunk);
1732 yaffs_PutLevel0Tnode(dev,tn,i,0);
1746 static void yaffs_SoftDeleteFile(yaffs_Object * obj)
1749 obj->variantType == YAFFS_OBJECT_TYPE_FILE && !obj->softDeleted) {
1750 if (obj->nDataChunks <= 0) {
1751 /* Empty file with no duplicate object headers, just delete it immediately */
1752 yaffs_FreeTnode(obj->myDev,
1753 obj->variant.fileVariant.top);
1754 obj->variant.fileVariant.top = NULL;
1755 T(YAFFS_TRACE_TRACING,
1756 (TSTR("yaffs: Deleting empty file %d" TENDSTR),
1758 yaffs_DoGenericObjectDeletion(obj);
1760 yaffs_SoftDeleteWorker(obj,
1761 obj->variant.fileVariant.top,
1762 obj->variant.fileVariant.
1764 obj->softDeleted = 1;
1769 /* Pruning removes any part of the file structure tree that is beyond the
1770 * bounds of the file (ie that does not point to chunks).
1772 * A file should only get pruned when its size is reduced.
1774 * Before pruning, the chunks must be pulled from the tree and the
1775 * level 0 tnode entries must be zeroed out.
1776 * Could also use this for file deletion, but that's probably better handled
1777 * by a special case.
1780 static yaffs_Tnode *yaffs_PruneWorker(yaffs_Device * dev, yaffs_Tnode * tn,
1781 __u32 level, int del0)
1789 for (i = 0; i < YAFFS_NTNODES_INTERNAL; i++) {
1790 if (tn->internal[i] && level > 0) {
1792 yaffs_PruneWorker(dev, tn->internal[i],
1794 (i == 0) ? del0 : 1);
1797 if (tn->internal[i]) {
1802 if (hasData == 0 && del0) {
1803 /* Free and return NULL */
1805 yaffs_FreeTnode(dev, tn);
1815 static int yaffs_PruneFileStructure(yaffs_Device * dev,
1816 yaffs_FileStructure * fStruct)
1823 if (fStruct->topLevel > 0) {
1825 yaffs_PruneWorker(dev, fStruct->top, fStruct->topLevel, 0);
1827 /* Now we have a tree with all the non-zero branches NULL but the height
1828 * is the same as it was.
1829 * Let's see if we can trim internal tnodes to shorten the tree.
1830 * We can do this if only the 0th element in the tnode is in use
1831 * (ie all the non-zero are NULL)
1834 while (fStruct->topLevel && !done) {
1838 for (i = 1; i < YAFFS_NTNODES_INTERNAL; i++) {
1839 if (tn->internal[i]) {
1845 fStruct->top = tn->internal[0];
1846 fStruct->topLevel--;
1847 yaffs_FreeTnode(dev, tn);
1857 /*-------------------- End of File Structure functions.-------------------*/
1859 /* yaffs_CreateFreeObjects creates a bunch more objects and
1860 * adds them to the object free list.
1862 static int yaffs_CreateFreeObjects(yaffs_Device * dev, int nObjects)
1865 yaffs_Object *newObjects;
1866 yaffs_ObjectList *list;
1871 /* make these things */
1872 newObjects = YMALLOC(nObjects * sizeof(yaffs_Object));
1873 list = YMALLOC(sizeof(yaffs_ObjectList));
1875 if (!newObjects || !list) {
1880 T(YAFFS_TRACE_ALLOCATE,
1881 (TSTR("yaffs: Could not allocate more objects" TENDSTR)));
1885 /* Hook them into the free list */
1886 for (i = 0; i < nObjects - 1; i++) {
1887 newObjects[i].siblings.next =
1888 (struct ylist_head *)(&newObjects[i + 1]);
1891 newObjects[nObjects - 1].siblings.next = (void *)dev->freeObjects;
1892 dev->freeObjects = newObjects;
1893 dev->nFreeObjects += nObjects;
1894 dev->nObjectsCreated += nObjects;
1896 /* Now add this bunch of Objects to a list for freeing up. */
1898 list->objects = newObjects;
1899 list->next = dev->allocatedObjectList;
1900 dev->allocatedObjectList = list;
1906 /* AllocateEmptyObject gets us a clean Object. Tries to make allocate more if we run out */
1907 static yaffs_Object *yaffs_AllocateEmptyObject(yaffs_Device * dev)
1909 yaffs_Object *tn = NULL;
1911 #ifdef VALGRIND_TEST
1912 tn = YMALLOC(sizeof(yaffs_Object));
1914 /* If there are none left make more */
1915 if (!dev->freeObjects) {
1916 yaffs_CreateFreeObjects(dev, YAFFS_ALLOCATION_NOBJECTS);
1919 if (dev->freeObjects) {
1920 tn = dev->freeObjects;
1922 (yaffs_Object *) (dev->freeObjects->siblings.next);
1923 dev->nFreeObjects--;
1927 /* Now sweeten it up... */
1929 memset(tn, 0, sizeof(yaffs_Object));
1932 tn->variantType = YAFFS_OBJECT_TYPE_UNKNOWN;
1933 YINIT_LIST_HEAD(&(tn->hardLinks));
1934 YINIT_LIST_HEAD(&(tn->hashLink));
1935 YINIT_LIST_HEAD(&tn->siblings);
1938 /* Now make the directory sane */
1940 tn->parent = dev->rootDir;
1941 ylist_add(&(tn->siblings),&dev->rootDir->variant.directoryVariant.children);
1944 /* Add it to the lost and found directory.
1945 * NB Can't put root or lostNFound in lostNFound so
1946 * check if lostNFound exists first
1948 if (dev->lostNFoundDir) {
1949 yaffs_AddObjectToDirectory(dev->lostNFoundDir, tn);
1953 dev->nCheckpointBlocksRequired = 0; /* force recalculation*/
1958 static yaffs_Object *yaffs_CreateFakeDirectory(yaffs_Device * dev, int number,
1963 yaffs_CreateNewObject(dev, number, YAFFS_OBJECT_TYPE_DIRECTORY);
1965 obj->fake = 1; /* it is fake so it might have no NAND presence... */
1966 obj->renameAllowed = 0; /* ... and we're not allowed to rename it... */
1967 obj->unlinkAllowed = 0; /* ... or unlink it */
1970 obj->yst_mode = mode;
1972 obj->hdrChunk = 0; /* Not a valid chunk. */
1979 static void yaffs_UnhashObject(yaffs_Object * tn)
1982 yaffs_Device *dev = tn->myDev;
1984 /* If it is still linked into the bucket list, free from the list */
1985 if (!ylist_empty(&tn->hashLink)) {
1986 ylist_del_init(&tn->hashLink);
1987 bucket = yaffs_HashFunction(tn->objectId);
1988 dev->objectBucket[bucket].count--;
1993 /* FreeObject frees up a Object and puts it back on the free list */
1994 static void yaffs_FreeObject(yaffs_Object * tn)
1997 yaffs_Device *dev = tn->myDev;
2002 if(!ylist_empty(&tn->siblings))
2008 /* We're still hooked up to a cached inode.
2009 * Don't delete now, but mark for later deletion
2011 tn->deferedFree = 1;
2016 yaffs_UnhashObject(tn);
2018 #ifdef VALGRIND_TEST
2021 /* Link into the free list. */
2022 tn->siblings.next = (struct ylist_head *)(dev->freeObjects);
2023 dev->freeObjects = tn;
2024 dev->nFreeObjects++;
2026 dev->nCheckpointBlocksRequired = 0; /* force recalculation*/
2032 void yaffs_HandleDeferedFree(yaffs_Object * obj)
2034 if (obj->deferedFree) {
2035 yaffs_FreeObject(obj);
2041 static void yaffs_DeinitialiseObjects(yaffs_Device * dev)
2043 /* Free the list of allocated Objects */
2045 yaffs_ObjectList *tmp;
2047 while (dev->allocatedObjectList) {
2048 tmp = dev->allocatedObjectList->next;
2049 YFREE(dev->allocatedObjectList->objects);
2050 YFREE(dev->allocatedObjectList);
2052 dev->allocatedObjectList = tmp;
2055 dev->freeObjects = NULL;
2056 dev->nFreeObjects = 0;
2059 static void yaffs_InitialiseObjects(yaffs_Device * dev)
2063 dev->allocatedObjectList = NULL;
2064 dev->freeObjects = NULL;
2065 dev->nFreeObjects = 0;
2067 for (i = 0; i < YAFFS_NOBJECT_BUCKETS; i++) {
2068 YINIT_LIST_HEAD(&dev->objectBucket[i].list);
2069 dev->objectBucket[i].count = 0;
2074 static int yaffs_FindNiceObjectBucket(yaffs_Device * dev)
2079 int lowest = 999999;
2081 /* First let's see if we can find one that's empty. */
2083 for (i = 0; i < 10 && lowest > 0; i++) {
2085 x %= YAFFS_NOBJECT_BUCKETS;
2086 if (dev->objectBucket[x].count < lowest) {
2087 lowest = dev->objectBucket[x].count;
2093 /* If we didn't find an empty list, then try
2094 * looking a bit further for a short one
2097 for (i = 0; i < 10 && lowest > 3; i++) {
2099 x %= YAFFS_NOBJECT_BUCKETS;
2100 if (dev->objectBucket[x].count < lowest) {
2101 lowest = dev->objectBucket[x].count;
2110 static int yaffs_CreateNewObjectNumber(yaffs_Device * dev)
2112 int bucket = yaffs_FindNiceObjectBucket(dev);
2114 /* Now find an object value that has not already been taken
2115 * by scanning the list.
2119 struct ylist_head *i;
2121 __u32 n = (__u32) bucket;
2123 /* yaffs_CheckObjectHashSanity(); */
2127 n += YAFFS_NOBJECT_BUCKETS;
2128 if (1 || dev->objectBucket[bucket].count > 0) {
2129 ylist_for_each(i, &dev->objectBucket[bucket].list) {
2130 /* If there is already one in the list */
2132 && ylist_entry(i, yaffs_Object,
2133 hashLink)->objectId == n) {
2144 static void yaffs_HashObject(yaffs_Object * in)
2146 int bucket = yaffs_HashFunction(in->objectId);
2147 yaffs_Device *dev = in->myDev;
2149 ylist_add(&in->hashLink, &dev->objectBucket[bucket].list);
2150 dev->objectBucket[bucket].count++;
2154 yaffs_Object *yaffs_FindObjectByNumber(yaffs_Device * dev, __u32 number)
2156 int bucket = yaffs_HashFunction(number);
2157 struct ylist_head *i;
2160 ylist_for_each(i, &dev->objectBucket[bucket].list) {
2161 /* Look if it is in the list */
2163 in = ylist_entry(i, yaffs_Object, hashLink);
2164 if (in->objectId == number) {
2166 /* Don't tell the VFS about this one if it is defered free */
2167 if (in->deferedFree)
2179 yaffs_Object *yaffs_CreateNewObject(yaffs_Device * dev, int number,
2180 yaffs_ObjectType type)
2183 yaffs_Object *theObject;
2184 yaffs_Tnode *tn = NULL;
2187 number = yaffs_CreateNewObjectNumber(dev);
2190 theObject = yaffs_AllocateEmptyObject(dev);
2194 if(type == YAFFS_OBJECT_TYPE_FILE){
2195 tn = yaffs_GetTnode(dev);
2197 yaffs_FreeObject(theObject);
2205 theObject->fake = 0;
2206 theObject->renameAllowed = 1;
2207 theObject->unlinkAllowed = 1;
2208 theObject->objectId = number;
2209 yaffs_HashObject(theObject);
2210 theObject->variantType = type;
2211 #ifdef CONFIG_YAFFS_WINCE
2212 yfsd_WinFileTimeNow(theObject->win_atime);
2213 theObject->win_ctime[0] = theObject->win_mtime[0] =
2214 theObject->win_atime[0];
2215 theObject->win_ctime[1] = theObject->win_mtime[1] =
2216 theObject->win_atime[1];
2220 theObject->yst_atime = theObject->yst_mtime =
2221 theObject->yst_ctime = Y_CURRENT_TIME;
2225 theObject->sum_prev = 12345;
2226 theObject->sum_trailer = 6789;
2230 case YAFFS_OBJECT_TYPE_FILE:
2231 theObject->variant.fileVariant.fileSize = 0;
2232 theObject->variant.fileVariant.scannedFileSize = 0;
2233 theObject->variant.fileVariant.shrinkSize = 0xFFFFFFFF; /* max __u32 */
2234 theObject->variant.fileVariant.topLevel = 0;
2235 theObject->variant.fileVariant.top = tn;
2237 case YAFFS_OBJECT_TYPE_DIRECTORY:
2238 YINIT_LIST_HEAD(&theObject->variant.directoryVariant.
2241 case YAFFS_OBJECT_TYPE_SYMLINK:
2242 case YAFFS_OBJECT_TYPE_HARDLINK:
2243 case YAFFS_OBJECT_TYPE_SPECIAL:
2244 /* No action required */
2246 case YAFFS_OBJECT_TYPE_UNKNOWN:
2247 /* todo this should not happen */
2255 static yaffs_Object *yaffs_FindOrCreateObjectByNumber(yaffs_Device * dev,
2257 yaffs_ObjectType type)
2259 yaffs_Object *theObject = NULL;
2262 theObject = yaffs_FindObjectByNumber(dev, number);
2266 theObject = yaffs_CreateNewObject(dev, number, type);
2274 static YCHAR *yaffs_CloneString(const YCHAR * str)
2276 YCHAR *newStr = NULL;
2279 newStr = YMALLOC((yaffs_strlen(str) + 1) * sizeof(YCHAR));
2281 yaffs_strcpy(newStr, str);
2289 * Mknod (create) a new object.
2290 * equivalentObject only has meaning for a hard link;
2291 * aliasString only has meaning for a sumlink.
2292 * rdev only has meaning for devices (a subset of special objects)
2295 static yaffs_Object *yaffs_MknodObject(yaffs_ObjectType type,
2296 yaffs_Object * parent,
2301 yaffs_Object * equivalentObject,
2302 const YCHAR * aliasString, __u32 rdev)
2307 yaffs_Device *dev = parent->myDev;
2309 /* Check if the entry exists. If it does then fail the call since we don't want a dup.*/
2310 if (yaffs_FindObjectByName(parent, name)) {
2314 in = yaffs_CreateNewObject(dev, -1, type);
2319 if(type == YAFFS_OBJECT_TYPE_SYMLINK){
2320 str = yaffs_CloneString(aliasString);
2322 yaffs_FreeObject(in);
2332 in->variantType = type;
2334 in->yst_mode = mode;
2336 #ifdef CONFIG_YAFFS_WINCE
2337 yfsd_WinFileTimeNow(in->win_atime);
2338 in->win_ctime[0] = in->win_mtime[0] = in->win_atime[0];
2339 in->win_ctime[1] = in->win_mtime[1] = in->win_atime[1];
2342 in->yst_atime = in->yst_mtime = in->yst_ctime = Y_CURRENT_TIME;
2344 in->yst_rdev = rdev;
2348 in->nDataChunks = 0;
2350 yaffs_SetObjectName(in, name);
2353 yaffs_AddObjectToDirectory(parent, in);
2355 in->myDev = parent->myDev;
2358 case YAFFS_OBJECT_TYPE_SYMLINK:
2359 in->variant.symLinkVariant.alias = str;
2361 case YAFFS_OBJECT_TYPE_HARDLINK:
2362 in->variant.hardLinkVariant.equivalentObject =
2364 in->variant.hardLinkVariant.equivalentObjectId =
2365 equivalentObject->objectId;
2366 ylist_add(&in->hardLinks, &equivalentObject->hardLinks);
2368 case YAFFS_OBJECT_TYPE_FILE:
2369 case YAFFS_OBJECT_TYPE_DIRECTORY:
2370 case YAFFS_OBJECT_TYPE_SPECIAL:
2371 case YAFFS_OBJECT_TYPE_UNKNOWN:
2376 if (yaffs_UpdateObjectHeader(in, name, 0, 0, 0) < 0) {
2377 /* Could not create the object header, fail the creation */
2378 yaffs_DestroyObject(in);
2387 yaffs_Object *yaffs_MknodFile(yaffs_Object * parent, const YCHAR * name,
2388 __u32 mode, __u32 uid, __u32 gid)
2390 return yaffs_MknodObject(YAFFS_OBJECT_TYPE_FILE, parent, name, mode,
2391 uid, gid, NULL, NULL, 0);
2394 yaffs_Object *yaffs_MknodDirectory(yaffs_Object * parent, const YCHAR * name,
2395 __u32 mode, __u32 uid, __u32 gid)
2397 return yaffs_MknodObject(YAFFS_OBJECT_TYPE_DIRECTORY, parent, name,
2398 mode, uid, gid, NULL, NULL, 0);
2401 yaffs_Object *yaffs_MknodSpecial(yaffs_Object * parent, const YCHAR * name,
2402 __u32 mode, __u32 uid, __u32 gid, __u32 rdev)
2404 return yaffs_MknodObject(YAFFS_OBJECT_TYPE_SPECIAL, parent, name, mode,
2405 uid, gid, NULL, NULL, rdev);
2408 yaffs_Object *yaffs_MknodSymLink(yaffs_Object * parent, const YCHAR * name,
2409 __u32 mode, __u32 uid, __u32 gid,
2410 const YCHAR * alias)
2412 return yaffs_MknodObject(YAFFS_OBJECT_TYPE_SYMLINK, parent, name, mode,
2413 uid, gid, NULL, alias, 0);
2416 /* yaffs_Link returns the object id of the equivalent object.*/
2417 yaffs_Object *yaffs_Link(yaffs_Object * parent, const YCHAR * name,
2418 yaffs_Object * equivalentObject)
2420 /* Get the real object in case we were fed a hard link as an equivalent object */
2421 equivalentObject = yaffs_GetEquivalentObject(equivalentObject);
2423 if (yaffs_MknodObject
2424 (YAFFS_OBJECT_TYPE_HARDLINK, parent, name, 0, 0, 0,
2425 equivalentObject, NULL, 0)) {
2426 return equivalentObject;
2433 static int yaffs_ChangeObjectName(yaffs_Object * obj, yaffs_Object * newDir,
2434 const YCHAR * newName, int force, int shadows)
2439 yaffs_Object *existingTarget;
2441 if (newDir == NULL) {
2442 newDir = obj->parent; /* use the old directory */
2445 if (newDir->variantType != YAFFS_OBJECT_TYPE_DIRECTORY) {
2446 T(YAFFS_TRACE_ALWAYS,
2448 ("tragedy: yaffs_ChangeObjectName: newDir is not a directory"
2453 /* TODO: Do we need this different handling for YAFFS2 and YAFFS1?? */
2454 if (obj->myDev->isYaffs2) {
2455 unlinkOp = (newDir == obj->myDev->unlinkedDir);
2457 unlinkOp = (newDir == obj->myDev->unlinkedDir
2458 && obj->variantType == YAFFS_OBJECT_TYPE_FILE);
2461 deleteOp = (newDir == obj->myDev->deletedDir);
2463 existingTarget = yaffs_FindObjectByName(newDir, newName);
2465 /* If the object is a file going into the unlinked directory,
2466 * then it is OK to just stuff it in since duplicate names are allowed.
2467 * else only proceed if the new name does not exist and if we're putting
2468 * it into a directory.
2475 newDir->variantType == YAFFS_OBJECT_TYPE_DIRECTORY) {
2476 yaffs_SetObjectName(obj, newName);
2479 yaffs_AddObjectToDirectory(newDir, obj);
2484 /* If it is a deletion then we mark it as a shrink for gc purposes. */
2485 if (yaffs_UpdateObjectHeader(obj, newName, 0, deleteOp, shadows)>= 0)
2492 int yaffs_RenameObject(yaffs_Object * oldDir, const YCHAR * oldName,
2493 yaffs_Object * newDir, const YCHAR * newName)
2495 yaffs_Object *obj=NULL;
2496 yaffs_Object *existingTarget=NULL;
2500 if(!oldDir || oldDir->variantType != YAFFS_OBJECT_TYPE_DIRECTORY)
2502 if(!newDir || newDir->variantType != YAFFS_OBJECT_TYPE_DIRECTORY)
2505 #ifdef CONFIG_YAFFS_CASE_INSENSITIVE
2506 /* Special case for case insemsitive systems (eg. WinCE).
2507 * While look-up is case insensitive, the name isn't.
2508 * Therefore we might want to change x.txt to X.txt
2510 if (oldDir == newDir && yaffs_strcmp(oldName, newName) == 0) {
2515 else if (yaffs_strlen(newName) > YAFFS_MAX_NAME_LENGTH)
2519 obj = yaffs_FindObjectByName(oldDir, oldName);
2521 if (obj && obj->renameAllowed) {
2523 /* Now do the handling for an existing target, if there is one */
2525 existingTarget = yaffs_FindObjectByName(newDir, newName);
2526 if (existingTarget &&
2527 existingTarget->variantType == YAFFS_OBJECT_TYPE_DIRECTORY &&
2528 !ylist_empty(&existingTarget->variant.directoryVariant.children)) {
2529 /* There is a target that is a non-empty directory, so we fail */
2530 return YAFFS_FAIL; /* EEXIST or ENOTEMPTY */
2531 } else if (existingTarget && existingTarget != obj) {
2532 /* Nuke the target first, using shadowing,
2533 * but only if it isn't the same object
2535 yaffs_ChangeObjectName(obj, newDir, newName, force,
2536 existingTarget->objectId);
2537 yaffs_UnlinkObject(existingTarget);
2540 return yaffs_ChangeObjectName(obj, newDir, newName, 1, 0);
2545 /*------------------------- Block Management and Page Allocation ----------------*/
2547 static int yaffs_InitialiseBlocks(yaffs_Device * dev)
2549 int nBlocks = dev->internalEndBlock - dev->internalStartBlock + 1;
2551 dev->blockInfo = NULL;
2552 dev->chunkBits = NULL;
2554 dev->allocationBlock = -1; /* force it to get a new one */
2556 /* If the first allocation strategy fails, thry the alternate one */
2557 dev->blockInfo = YMALLOC(nBlocks * sizeof(yaffs_BlockInfo));
2558 if(!dev->blockInfo){
2559 dev->blockInfo = YMALLOC_ALT(nBlocks * sizeof(yaffs_BlockInfo));
2560 dev->blockInfoAlt = 1;
2563 dev->blockInfoAlt = 0;
2567 /* Set up dynamic blockinfo stuff. */
2568 dev->chunkBitmapStride = (dev->nChunksPerBlock + 7) / 8; /* round up bytes */
2569 dev->chunkBits = YMALLOC(dev->chunkBitmapStride * nBlocks);
2570 if(!dev->chunkBits){
2571 dev->chunkBits = YMALLOC_ALT(dev->chunkBitmapStride * nBlocks);
2572 dev->chunkBitsAlt = 1;
2575 dev->chunkBitsAlt = 0;
2578 if (dev->blockInfo && dev->chunkBits) {
2579 memset(dev->blockInfo, 0, nBlocks * sizeof(yaffs_BlockInfo));
2580 memset(dev->chunkBits, 0, dev->chunkBitmapStride * nBlocks);
2588 static void yaffs_DeinitialiseBlocks(yaffs_Device * dev)
2590 if(dev->blockInfoAlt && dev->blockInfo)
2591 YFREE_ALT(dev->blockInfo);
2592 else if(dev->blockInfo)
2593 YFREE(dev->blockInfo);
2595 dev->blockInfoAlt = 0;
2597 dev->blockInfo = NULL;
2599 if(dev->chunkBitsAlt && dev->chunkBits)
2600 YFREE_ALT(dev->chunkBits);
2601 else if(dev->chunkBits)
2602 YFREE(dev->chunkBits);
2603 dev->chunkBitsAlt = 0;
2604 dev->chunkBits = NULL;
2607 static int yaffs_BlockNotDisqualifiedFromGC(yaffs_Device * dev,
2608 yaffs_BlockInfo * bi)
2615 return 1; /* disqualification only applies to yaffs2. */
2617 if (!bi->hasShrinkHeader)
2618 return 1; /* can gc */
2620 /* Find the oldest dirty sequence number if we don't know it and save it
2621 * so we don't have to keep recomputing it.
2623 if (!dev->oldestDirtySequence) {
2624 seq = dev->sequenceNumber;
2626 for (i = dev->internalStartBlock; i <= dev->internalEndBlock;
2628 b = yaffs_GetBlockInfo(dev, i);
2629 if (b->blockState == YAFFS_BLOCK_STATE_FULL &&
2630 (b->pagesInUse - b->softDeletions) <
2631 dev->nChunksPerBlock && b->sequenceNumber < seq) {
2632 seq = b->sequenceNumber;
2635 dev->oldestDirtySequence = seq;
2638 /* Can't do gc of this block if there are any blocks older than this one that have
2641 return (bi->sequenceNumber <= dev->oldestDirtySequence);
2645 /* FindDiretiestBlock is used to select the dirtiest block (or close enough)
2646 * for garbage collection.
2649 static int yaffs_FindBlockForGarbageCollection(yaffs_Device * dev,
2653 int b = dev->currentDirtyChecker;
2660 yaffs_BlockInfo *bi;
2661 int pendingPrioritisedExist = 0;
2663 /* First let's see if we need to grab a prioritised block */
2664 if(dev->hasPendingPrioritisedGCs){
2665 for(i = dev->internalStartBlock; i < dev->internalEndBlock && !prioritised; i++){
2667 bi = yaffs_GetBlockInfo(dev, i);
2668 //yaffs_VerifyBlock(dev,bi,i);
2670 if(bi->gcPrioritise) {
2671 pendingPrioritisedExist = 1;
2672 if(bi->blockState == YAFFS_BLOCK_STATE_FULL &&
2673 yaffs_BlockNotDisqualifiedFromGC(dev, bi)){
2674 pagesInUse = (bi->pagesInUse - bi->softDeletions);
2677 aggressive = 1; /* Fool the non-aggressive skip logiv below */
2682 if(!pendingPrioritisedExist) /* None found, so we can clear this */
2683 dev->hasPendingPrioritisedGCs = 0;
2686 /* If we're doing aggressive GC then we are happy to take a less-dirty block, and
2688 * else (we're doing a leasurely gc), then we only bother to do this if the
2689 * block has only a few pages in use.
2692 dev->nonAggressiveSkip--;
2694 if (!aggressive && (dev->nonAggressiveSkip > 0)) {
2700 (aggressive) ? dev->nChunksPerBlock : YAFFS_PASSIVE_GC_CHUNKS + 1;
2704 dev->internalEndBlock - dev->internalStartBlock + 1;
2707 dev->internalEndBlock - dev->internalStartBlock + 1;
2708 iterations = iterations / 16;
2709 if (iterations > 200) {
2714 for (i = 0; i <= iterations && pagesInUse > 0 && !prioritised; i++) {
2716 if (b < dev->internalStartBlock || b > dev->internalEndBlock) {
2717 b = dev->internalStartBlock;
2720 if (b < dev->internalStartBlock || b > dev->internalEndBlock) {
2721 T(YAFFS_TRACE_ERROR,
2722 (TSTR("**>> Block %d is not valid" TENDSTR), b));
2726 bi = yaffs_GetBlockInfo(dev, b);
2729 if (bi->blockState == YAFFS_BLOCK_STATE_CHECKPOINT) {
2736 if (bi->blockState == YAFFS_BLOCK_STATE_FULL &&
2737 (bi->pagesInUse - bi->softDeletions) < pagesInUse &&
2738 yaffs_BlockNotDisqualifiedFromGC(dev, bi)) {
2740 pagesInUse = (bi->pagesInUse - bi->softDeletions);
2744 dev->currentDirtyChecker = b;
2748 (TSTR("GC Selected block %d with %d free, prioritised:%d" TENDSTR), dirtiest,
2749 dev->nChunksPerBlock - pagesInUse,prioritised));
2752 dev->oldestDirtySequence = 0;
2755 dev->nonAggressiveSkip = 4;
2761 static void yaffs_BlockBecameDirty(yaffs_Device * dev, int blockNo)
2763 yaffs_BlockInfo *bi = yaffs_GetBlockInfo(dev, blockNo);
2767 /* If the block is still healthy erase it and mark as clean.
2768 * If the block has had a data failure, then retire it.
2771 T(YAFFS_TRACE_GC | YAFFS_TRACE_ERASE,
2772 (TSTR("yaffs_BlockBecameDirty block %d state %d %s"TENDSTR),
2773 blockNo, bi->blockState, (bi->needsRetiring) ? "needs retiring" : ""));
2775 bi->blockState = YAFFS_BLOCK_STATE_DIRTY;
2777 if (!bi->needsRetiring) {
2778 yaffs_InvalidateCheckpoint(dev);
2779 erasedOk = yaffs_EraseBlockInNAND(dev, blockNo);
2781 dev->nErasureFailures++;
2782 T(YAFFS_TRACE_ERROR | YAFFS_TRACE_BAD_BLOCKS,
2783 (TSTR("**>> Erasure failed %d" TENDSTR), blockNo));
2788 ((yaffs_traceMask & YAFFS_TRACE_ERASE) || !yaffs_SkipVerification(dev))) {
2790 for (i = 0; i < dev->nChunksPerBlock; i++) {
2791 if (!yaffs_CheckChunkErased
2792 (dev, blockNo * dev->nChunksPerBlock + i)) {
2793 T(YAFFS_TRACE_ERROR,
2795 (">>Block %d erasure supposedly OK, but chunk %d not erased"
2796 TENDSTR), blockNo, i));
2802 /* Clean it up... */
2803 bi->blockState = YAFFS_BLOCK_STATE_EMPTY;
2804 dev->nErasedBlocks++;
2806 bi->softDeletions = 0;
2807 bi->hasShrinkHeader = 0;
2808 bi->skipErasedCheck = 1; /* This is clean, so no need to check */
2809 bi->gcPrioritise = 0;
2810 yaffs_ClearChunkBits(dev, blockNo);
2812 T(YAFFS_TRACE_ERASE,
2813 (TSTR("Erased block %d" TENDSTR), blockNo));
2815 dev->nFreeChunks -= dev->nChunksPerBlock; /* We lost a block of free space */
2817 yaffs_RetireBlock(dev, blockNo);
2818 T(YAFFS_TRACE_ERROR | YAFFS_TRACE_BAD_BLOCKS,
2819 (TSTR("**>> Block %d retired" TENDSTR), blockNo));
2823 static int yaffs_FindBlockForAllocation(yaffs_Device * dev)
2827 yaffs_BlockInfo *bi;
2829 if (dev->nErasedBlocks < 1) {
2830 /* Hoosterman we've got a problem.
2831 * Can't get space to gc
2833 T(YAFFS_TRACE_ERROR,
2834 (TSTR("yaffs tragedy: no more erased blocks" TENDSTR)));
2839 /* Find an empty block. */
2841 for (i = dev->internalStartBlock; i <= dev->internalEndBlock; i++) {
2842 dev->allocationBlockFinder++;
2843 if (dev->allocationBlockFinder < dev->internalStartBlock
2844 || dev->allocationBlockFinder > dev->internalEndBlock) {
2845 dev->allocationBlockFinder = dev->internalStartBlock;
2848 bi = yaffs_GetBlockInfo(dev, dev->allocationBlockFinder);
2850 if (bi->blockState == YAFFS_BLOCK_STATE_EMPTY) {
2851 bi->blockState = YAFFS_BLOCK_STATE_ALLOCATING;
2852 dev->sequenceNumber++;
2853 bi->sequenceNumber = dev->sequenceNumber;
2854 dev->nErasedBlocks--;
2855 T(YAFFS_TRACE_ALLOCATE,
2856 (TSTR("Allocated block %d, seq %d, %d left" TENDSTR),
2857 dev->allocationBlockFinder, dev->sequenceNumber,
2858 dev->nErasedBlocks));
2859 return dev->allocationBlockFinder;
2863 T(YAFFS_TRACE_ALWAYS,
2865 ("yaffs tragedy: no more erased blocks, but there should have been %d"
2866 TENDSTR), dev->nErasedBlocks));
2873 static int yaffs_CalcCheckpointBlocksRequired(yaffs_Device *dev)
2875 if(!dev->nCheckpointBlocksRequired &&
2877 /* Not a valid value so recalculate */
2880 int devBlocks = (dev->endBlock - dev->startBlock + 1);
2883 tnodeSize = (dev->tnodeWidth * YAFFS_NTNODES_LEVEL0)/8;
2885 if(tnodeSize < sizeof(yaffs_Tnode))
2886 tnodeSize = sizeof(yaffs_Tnode);
2888 nBytes += sizeof(yaffs_CheckpointValidity);
2889 nBytes += sizeof(yaffs_CheckpointDevice);
2890 nBytes += devBlocks * sizeof(yaffs_BlockInfo);
2891 nBytes += devBlocks * dev->chunkBitmapStride;
2892 nBytes += (sizeof(yaffs_CheckpointObject) + sizeof(__u32)) * (dev->nObjectsCreated - dev->nFreeObjects);
2893 nBytes += (tnodeSize + sizeof(__u32)) * (dev->nTnodesCreated - dev->nFreeTnodes);
2894 nBytes += sizeof(yaffs_CheckpointValidity);
2895 nBytes += sizeof(__u32); /* checksum*/
2897 /* Round up and add 2 blocks to allow for some bad blocks, so add 3 */
2899 nBlocks = (nBytes/(dev->nDataBytesPerChunk * dev->nChunksPerBlock)) + 3;
2901 dev->nCheckpointBlocksRequired = nBlocks;
2904 return dev->nCheckpointBlocksRequired;
2907 // Check if there's space to allocate...
2908 // Thinks.... do we need top make this ths same as yaffs_GetFreeChunks()?
2909 static int yaffs_CheckSpaceForAllocation(yaffs_Device * dev)
2912 int reservedBlocks = dev->nReservedBlocks;
2913 int checkpointBlocks;
2916 checkpointBlocks = yaffs_CalcCheckpointBlocksRequired(dev) -
2917 dev->blocksInCheckpoint;
2918 if(checkpointBlocks < 0)
2919 checkpointBlocks = 0;
2921 checkpointBlocks =0;
2924 reservedChunks = ((reservedBlocks + checkpointBlocks) * dev->nChunksPerBlock);
2926 return (dev->nFreeChunks > reservedChunks);
2929 static int yaffs_AllocateChunk(yaffs_Device * dev, int useReserve, yaffs_BlockInfo **blockUsedPtr)
2932 yaffs_BlockInfo *bi;
2934 if (dev->allocationBlock < 0) {
2935 /* Get next block to allocate off */
2936 dev->allocationBlock = yaffs_FindBlockForAllocation(dev);
2937 dev->allocationPage = 0;
2940 if (!useReserve && !yaffs_CheckSpaceForAllocation(dev)) {
2941 /* Not enough space to allocate unless we're allowed to use the reserve. */
2945 if (dev->nErasedBlocks < dev->nReservedBlocks
2946 && dev->allocationPage == 0) {
2947 T(YAFFS_TRACE_ALLOCATE, (TSTR("Allocating reserve" TENDSTR)));
2950 /* Next page please.... */
2951 if (dev->allocationBlock >= 0) {
2952 bi = yaffs_GetBlockInfo(dev, dev->allocationBlock);
2954 retVal = (dev->allocationBlock * dev->nChunksPerBlock) +
2955 dev->allocationPage;
2957 yaffs_SetChunkBit(dev, dev->allocationBlock,
2958 dev->allocationPage);
2960 dev->allocationPage++;
2964 /* If the block is full set the state to full */
2965 if (dev->allocationPage >= dev->nChunksPerBlock) {
2966 bi->blockState = YAFFS_BLOCK_STATE_FULL;
2967 dev->allocationBlock = -1;
2976 T(YAFFS_TRACE_ERROR,
2977 (TSTR("!!!!!!!!! Allocator out !!!!!!!!!!!!!!!!!" TENDSTR)));
2982 static int yaffs_GetErasedChunks(yaffs_Device * dev)
2986 n = dev->nErasedBlocks * dev->nChunksPerBlock;
2988 if (dev->allocationBlock > 0) {
2989 n += (dev->nChunksPerBlock - dev->allocationPage);
2996 static int yaffs_GarbageCollectBlock(yaffs_Device * dev, int block)
3002 int retVal = YAFFS_OK;
3005 int isCheckpointBlock;
3008 int chunksBefore = yaffs_GetErasedChunks(dev);
3011 yaffs_ExtendedTags tags;
3013 yaffs_BlockInfo *bi = yaffs_GetBlockInfo(dev, block);
3015 yaffs_Object *object;
3017 isCheckpointBlock = (bi->blockState == YAFFS_BLOCK_STATE_CHECKPOINT);
3019 bi->blockState = YAFFS_BLOCK_STATE_COLLECTING;
3021 T(YAFFS_TRACE_TRACING,
3022 (TSTR("Collecting block %d, in use %d, shrink %d, " TENDSTR), block,
3023 bi->pagesInUse, bi->hasShrinkHeader));
3025 /*yaffs_VerifyFreeChunks(dev); */
3027 bi->hasShrinkHeader = 0; /* clear the flag so that the block can erase */
3029 /* Take off the number of soft deleted entries because
3030 * they're going to get really deleted during GC.
3032 dev->nFreeChunks -= bi->softDeletions;
3036 if (isCheckpointBlock ||
3037 !yaffs_StillSomeChunkBits(dev, block)) {
3038 T(YAFFS_TRACE_TRACING,
3040 ("Collecting block %d that has no chunks in use" TENDSTR),
3042 yaffs_BlockBecameDirty(dev, block);
3045 __u8 *buffer = yaffs_GetTempBuffer(dev, __LINE__);
3047 yaffs_VerifyBlock(dev,bi,block);
3049 for (chunkInBlock = 0, oldChunk = block * dev->nChunksPerBlock;
3050 retVal == YAFFS_OK &&
3051 chunkInBlock < dev->nChunksPerBlock
3052 && yaffs_StillSomeChunkBits(dev, block);
3053 chunkInBlock++, oldChunk++) {
3054 if (yaffs_CheckChunkBit(dev, block, chunkInBlock)) {
3056 /* This page is in use and might need to be copied off */
3060 yaffs_InitialiseTags(&tags);
3062 yaffs_ReadChunkWithTagsFromNAND(dev, oldChunk,
3066 yaffs_FindObjectByNumber(dev,
3069 T(YAFFS_TRACE_GC_DETAIL,
3071 ("Collecting page %d, %d %d %d " TENDSTR),
3072 chunkInBlock, tags.objectId, tags.chunkId,
3075 if(object && !yaffs_SkipVerification(dev)){
3076 if(tags.chunkId == 0)
3077 matchingChunk = object->hdrChunk;
3078 else if(object->softDeleted)
3079 matchingChunk = oldChunk; /* Defeat the test */
3081 matchingChunk = yaffs_FindChunkInFile(object,tags.chunkId,NULL);
3083 if(oldChunk != matchingChunk)
3084 T(YAFFS_TRACE_ERROR,
3085 (TSTR("gc: page in gc mismatch: %d %d %d %d"TENDSTR),
3086 oldChunk,matchingChunk,tags.objectId, tags.chunkId));
3091 T(YAFFS_TRACE_ERROR,
3093 ("page %d in gc has no object: %d %d %d "
3095 tags.objectId, tags.chunkId, tags.byteCount));
3100 object->softDeleted &&
3101 tags.chunkId != 0) {
3102 /* Data chunk in a soft deleted file, throw it away
3103 * It's a soft deleted data chunk,
3104 * No need to copy this, just forget about it and
3105 * fix up the object.
3108 object->nDataChunks--;
3110 if (object->nDataChunks <= 0) {
3111 /* remeber to clean up the object */
3112 dev->gcCleanupList[cleanups] =
3118 /* Todo object && object->deleted && object->nDataChunks == 0 */
3120 /* Deleted object header with no data chunks.
3121 * Can be discarded and the file deleted.
3123 object->hdrChunk = 0;
3124 yaffs_FreeTnode(object->myDev,
3127 object->variant.fileVariant.top = NULL;
3128 yaffs_DoGenericObjectDeletion(object);
3130 } else if (object) {
3131 /* It's either a data chunk in a live file or
3132 * an ObjectHeader, so we're interested in it.
3133 * NB Need to keep the ObjectHeaders of deleted files
3134 * until the whole file has been deleted off
3136 tags.serialNumber++;
3140 if (tags.chunkId == 0) {
3141 /* It is an object Id,
3142 * We need to nuke the shrinkheader flags first
3143 * We no longer want the shrinkHeader flag since its work is done
3144 * and if it is left in place it will mess up scanning.
3145 * Also, clear out any shadowing stuff
3148 yaffs_ObjectHeader *oh;
3149 oh = (yaffs_ObjectHeader *)buffer;
3151 /* oh->shadowsObject = oh->inbandShadowsObject = -1; */
3152 tags.extraShadows = 0;
3153 tags.extraIsShrinkHeader = 0;
3155 yaffs_VerifyObjectHeader(object,oh,&tags,1);
3159 yaffs_WriteNewChunkWithTagsToNAND(dev, buffer, &tags, 1);
3162 retVal = YAFFS_FAIL;
3165 /* Ok, now fix up the Tnodes etc. */
3167 if (tags.chunkId == 0) {
3169 object->hdrChunk = newChunk;
3170 object->serial = tags.serialNumber;
3172 /* It's a data chunk */
3173 yaffs_PutChunkIntoFile
3181 if(retVal == YAFFS_OK)
3182 yaffs_DeleteChunk(dev, oldChunk, markNAND, __LINE__);
3187 yaffs_ReleaseTempBuffer(dev, buffer, __LINE__);
3190 /* Do any required cleanups */
3191 for (i = 0; i < cleanups; i++) {
3192 /* Time to delete the file too */
3194 yaffs_FindObjectByNumber(dev,
3195 dev->gcCleanupList[i]);
3197 yaffs_FreeTnode(dev,
3198 object->variant.fileVariant.
3200 object->variant.fileVariant.top = NULL;
3203 ("yaffs: About to finally delete object %d"
3204 TENDSTR), object->objectId));
3205 yaffs_DoGenericObjectDeletion(object);
3206 object->myDev->nDeletedFiles--;
3213 yaffs_VerifyCollectedBlock(dev,bi,block);
3215 if (chunksBefore >= (chunksAfter = yaffs_GetErasedChunks(dev))) {
3218 ("gc did not increase free chunks before %d after %d"
3219 TENDSTR), chunksBefore, chunksAfter));
3227 /* New garbage collector
3228 * If we're very low on erased blocks then we do aggressive garbage collection
3229 * otherwise we do "leasurely" garbage collection.
3230 * Aggressive gc looks further (whole array) and will accept less dirty blocks.
3231 * Passive gc only inspects smaller areas and will only accept more dirty blocks.
3233 * The idea is to help clear out space in a more spread-out manner.
3234 * Dunno if it really does anything useful.
3236 static int yaffs_CheckGarbageCollection(yaffs_Device * dev)
3240 int gcOk = YAFFS_OK;
3243 int checkpointBlockAdjust;
3245 if (dev->isDoingGC) {
3246 /* Bail out so we don't get recursive gc */
3250 /* This loop should pass the first time.
3251 * We'll only see looping here if the erase of the collected block fails.
3257 checkpointBlockAdjust = yaffs_CalcCheckpointBlocksRequired(dev) - dev->blocksInCheckpoint;
3258 if(checkpointBlockAdjust < 0)
3259 checkpointBlockAdjust = 0;
3261 if (dev->nErasedBlocks < (dev->nReservedBlocks + checkpointBlockAdjust + 2)) {
3262 /* We need a block soon...*/
3265 /* We're in no hurry */
3269 block = yaffs_FindBlockForGarbageCollection(dev, aggressive);
3272 dev->garbageCollections++;
3274 dev->passiveGarbageCollections++;
3279 ("yaffs: GC erasedBlocks %d aggressive %d" TENDSTR),
3280 dev->nErasedBlocks, aggressive));
3282 gcOk = yaffs_GarbageCollectBlock(dev, block);
3285 if (dev->nErasedBlocks < (dev->nReservedBlocks) && block > 0) {
3288 ("yaffs: GC !!!no reclaim!!! erasedBlocks %d after try %d block %d"
3289 TENDSTR), dev->nErasedBlocks, maxTries, block));
3291 } while ((dev->nErasedBlocks < dev->nReservedBlocks) && (block > 0)
3294 return aggressive ? gcOk : YAFFS_OK;
3297 /*------------------------- TAGS --------------------------------*/
3299 static int yaffs_TagsMatch(const yaffs_ExtendedTags * tags, int objectId,
3302 return (tags->chunkId == chunkInObject &&
3303 tags->objectId == objectId && !tags->chunkDeleted) ? 1 : 0;
3308 /*-------------------- Data file manipulation -----------------*/
3310 static int yaffs_FindChunkInFile(yaffs_Object * in, int chunkInInode,
3311 yaffs_ExtendedTags * tags)
3313 /*Get the Tnode, then get the level 0 offset chunk offset */
3316 yaffs_ExtendedTags localTags;
3319 yaffs_Device *dev = in->myDev;
3322 /* Passed a NULL, so use our own tags space */
3326 tn = yaffs_FindLevel0Tnode(dev, &in->variant.fileVariant, chunkInInode);
3329 theChunk = yaffs_GetChunkGroupBase(dev,tn,chunkInInode);
3332 yaffs_FindChunkInGroup(dev, theChunk, tags, in->objectId,
3338 static int yaffs_FindAndDeleteChunkInFile(yaffs_Object * in, int chunkInInode,
3339 yaffs_ExtendedTags * tags)
3341 /* Get the Tnode, then get the level 0 offset chunk offset */
3344 yaffs_ExtendedTags localTags;
3346 yaffs_Device *dev = in->myDev;
3350 /* Passed a NULL, so use our own tags space */
3354 tn = yaffs_FindLevel0Tnode(dev, &in->variant.fileVariant, chunkInInode);
3358 theChunk = yaffs_GetChunkGroupBase(dev,tn,chunkInInode);
3361 yaffs_FindChunkInGroup(dev, theChunk, tags, in->objectId,
3364 /* Delete the entry in the filestructure (if found) */