3 * YAFFS: Yet another FFS. A NAND-flash specific file system.
5 * Copyright (C) 2002 Aleph One Ltd.
6 * for Toby Churchill Ltd and Brightstar Engineering
8 * Created by Charles Manning <charles@aleph1.co.uk>
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License version 2 as
12 * published by the Free Software Foundation.
17 const char *yaffs_guts_c_version="$Id: yaffs_guts.c,v 1.5 2005-03-16 04:00:36 charles Exp $";
21 #include "yaffsinterface.h"
22 #include "yaffs_guts.h"
24 #include "yaffs_tagscompat.h"
26 #ifdef CONFIG_YAFFS_WINCE
27 void yfsd_LockYAFFS(BOOL fsLockOnly);
28 void yfsd_UnlockYAFFS(BOOL fsLockOnly);
31 #define YAFFS_PASSIVE_GC_CHUNKS 2
34 // Use Steven Hill's ECC struff instead
35 // External functions for ECC on data
36 void nand_calculate_ecc (const u_char *dat, u_char *ecc_code);
37 int nand_correct_data (u_char *dat, u_char *read_ecc, u_char *calc_ecc);
38 #define yaffs_ECCCalculate(data,ecc) nand_calculate_ecc(data,ecc)
39 #define yaffs_ECCCorrect(data,read_ecc,calc_ecc) nand_correct_ecc(data,read_ecc,calc_ecc)
41 #include "yaffs_ecc.h"
44 // countBits is a quick way of counting the number of bits in a byte.
45 // ie. countBits[n] holds the number of 1 bits in a byte with the value n.
47 static const char yaffs_countBitsTable[256] =
49 0,1,1,2,1,2,2,3,1,2,2,3,2,3,3,4,
50 1,2,2,3,2,3,3,4,2,3,3,4,3,4,4,5,
51 1,2,2,3,2,3,3,4,2,3,3,4,3,4,4,5,
52 2,3,3,4,3,4,4,5,3,4,4,5,4,5,5,6,
53 1,2,2,3,2,3,3,4,2,3,3,4,3,4,4,5,
54 2,3,3,4,3,4,4,5,3,4,4,5,4,5,5,6,
55 2,3,3,4,3,4,4,5,3,4,4,5,4,5,5,6,
56 3,4,4,5,4,5,5,6,4,5,5,6,5,6,6,7,
57 1,2,2,3,2,3,3,4,2,3,3,4,3,4,4,5,
58 2,3,3,4,3,4,4,5,3,4,4,5,4,5,5,6,
59 2,3,3,4,3,4,4,5,3,4,4,5,4,5,5,6,
60 3,4,4,5,4,5,5,6,4,5,5,6,5,6,6,7,
61 2,3,3,4,3,4,4,5,3,4,4,5,4,5,5,6,
62 3,4,4,5,4,5,5,6,4,5,5,6,5,6,6,7,
63 3,4,4,5,4,5,5,6,4,5,5,6,5,6,6,7,
64 4,5,5,6,5,6,6,7,5,6,6,7,6,7,7,8
67 static int yaffs_CountBits(__u8 x)
70 retVal = yaffs_countBitsTable[x];
76 // Stuff using yea olde tags
77 static void yaffs_LoadTagsIntoSpare(yaffs_Spare *sparePtr, yaffs_Tags *tagsPtr);
78 static void yaffs_GetTagsFromSpare(yaffs_Device *dev, yaffs_Spare *sparePtr,yaffs_Tags *tagsPtr);
80 static int yaffs_ReadChunkTagsFromNAND(yaffs_Device *dev,int chunkInNAND, yaffs_Tags *tags, int *chunkDeleted);
81 static int yaffs_TagsMatch(const yaffs_Tags *tags, int objectId, int chunkInObject, int chunkDeleted);
88 static Y_INLINE int yaffs_ReadChunkWithTagsFromNAND(yaffs_Device *dev,int chunkInNAND, __u8 *buffer, yaffs_ExtendedTags *tags);
89 static Y_INLINE int yaffs_WriteChunkWithTagsToNAND(yaffs_Device *dev,int chunkInNAND, const __u8 *data, yaffs_ExtendedTags *tags);
90 static Y_INLINE int yaffs_MarkBlockBad(yaffs_Device *dev, int blockNo);
91 static Y_INLINE int yaffs_QueryInitialBlockState(yaffs_Device *dev,int blockNo, yaffs_BlockState *state,unsigned *sequenceNumber);
93 static int yaffs_WriteNewChunkWithTagsToNAND(yaffs_Device *dev, const __u8 *buffer, yaffs_ExtendedTags *tags, int useReserve);
94 static int yaffs_CheckObjectHashSanity(yaffs_Device *dev);
95 static int yaffs_PutChunkIntoFile(yaffs_Object *in,int chunkInInode, int chunkInNAND, int inScan);
97 static yaffs_Object *yaffs_CreateNewObject(yaffs_Device *dev,int number,yaffs_ObjectType type);
98 static void yaffs_AddObjectToDirectory(yaffs_Object *directory, yaffs_Object *obj);
99 static int yaffs_UpdateObjectHeader(yaffs_Object *in,const YCHAR *name, int force,int isShrink);
100 static void yaffs_RemoveObjectFromDirectory(yaffs_Object *obj);
101 static int yaffs_CheckStructures(void);
102 static int yaffs_DeleteWorker(yaffs_Object *in, yaffs_Tnode *tn, __u32 level, int chunkOffset,int *limit);
103 static int yaffs_DoGenericObjectDeletion(yaffs_Object *in);
105 static yaffs_BlockInfo *yaffs_GetBlockInfo(yaffs_Device *dev,int blockNo);
107 static __u8 *yaffs_GetTempBuffer(yaffs_Device *dev,int lineNo);
108 static void yaffs_ReleaseTempBuffer(yaffs_Device *dev, __u8 *buffer, int lineNo);
111 static int yaffs_ValidateTags(yaffs_ExtendedTags *tags);
113 // Robustification (if it ever comes about...)
114 static void yaffs_RetireBlock(yaffs_Device *dev,int blockInNAND);
115 static void yaffs_HandleReadDataError(yaffs_Device *dev,int chunkInNAND);
116 static void yaffs_HandleWriteChunkError(yaffs_Device *dev,int chunkInNAND);
117 static void yaffs_HandleWriteChunkOk(yaffs_Device *dev,int chunkInNAND,const __u8 *data, const yaffs_ExtendedTags *tags);
118 static void yaffs_HandleUpdateChunk(yaffs_Device *dev,int chunkInNAND, const yaffs_ExtendedTags *tags);
120 static int yaffs_CheckChunkErased(struct yaffs_DeviceStruct *dev,int chunkInNAND);
122 static int yaffs_UnlinkWorker(yaffs_Object *obj);
123 static void yaffs_DestroyObject(yaffs_Object *obj);
126 static int yaffs_VerifyCompare(const __u8 *d0, const __u8 * d1, const yaffs_Spare *s0, const yaffs_Spare *s1,int dataSize);
129 static int yaffs_TagsMatch(const yaffs_ExtendedTags *tags, int objectId, int chunkInObject);
132 loff_t yaffs_GetFileSize(yaffs_Object *obj);
135 static int yaffs_AllocateChunk(yaffs_Device *dev,int useReserve);
137 #ifdef YAFFS_PARANOID
138 static int yaffs_CheckFileSanity(yaffs_Object *in);
140 #define yaffs_CheckFileSanity(in)
143 static void yaffs_InvalidateWholeChunkCache(yaffs_Object *in);
144 static void yaffs_InvalidateChunkCache(yaffs_Object *object, int chunkId);
146 static int yaffs_ReadChunkWithTagsFromNAND(yaffs_Device *dev,int chunkInNAND, __u8 *buffer, yaffs_ExtendedTags *tags)
148 if(dev->readChunkWithTagsFromNAND)
149 return dev->readChunkWithTagsFromNAND(dev,chunkInNAND,buffer,tags);
151 return yaffs_TagsCompatabilityReadChunkWithTagsFromNAND(dev,chunkInNAND,buffer,tags);
154 static Y_INLINE int yaffs_WriteChunkWithTagsToNAND(yaffs_Device *dev,int chunkInNAND, const __u8 *buffer, yaffs_ExtendedTags *tags)
158 tags->sequenceNumber = dev->sequenceNumber;
160 if(!yaffs_ValidateTags(tags))
162 T(YAFFS_TRACE_ERROR,(TSTR("Writing uninitialised tags" TENDSTR)));
165 T(YAFFS_TRACE_WRITE,(TSTR("Writing chunk %d tags %d %d"TENDSTR),chunkInNAND,tags->objectId,tags->chunkId));
169 T(YAFFS_TRACE_ERROR,(TSTR("Writing with no tags" TENDSTR)));
173 if(dev->writeChunkWithTagsToNAND)
174 return dev->writeChunkWithTagsToNAND(dev,chunkInNAND,buffer,tags);
176 return yaffs_TagsCompatabilityWriteChunkWithTagsToNAND(dev,chunkInNAND,buffer,tags);
179 static Y_INLINE int yaffs_MarkBlockBad(yaffs_Device *dev, int blockNo)
181 if(dev->markNANDBlockBad)
182 return dev->markNANDBlockBad(dev,blockNo);
184 return yaffs_TagsCompatabilityMarkNANDBlockBad(dev,blockNo);
186 static Y_INLINE int yaffs_QueryInitialBlockState(yaffs_Device *dev,int blockNo, yaffs_BlockState *state, unsigned *sequenceNumber)
188 if(dev->queryNANDBlock)
189 return dev->queryNANDBlock(dev,blockNo,state,sequenceNumber);
191 return yaffs_TagsCompatabilityQueryNANDBlock(dev,blockNo,state,sequenceNumber);
194 int yaffs_EraseBlockInNAND(struct yaffs_DeviceStruct *dev,int blockInNAND)
198 dev->nBlockErasures++;
199 result = dev->eraseBlockInNAND(dev,blockInNAND);
201 if(!result)result = dev->eraseBlockInNAND(dev,blockInNAND); // If at first we don't succeed, try again *once*.
205 static int yaffs_InitialiseNAND(struct yaffs_DeviceStruct *dev)
207 return dev->initialiseNAND(dev);
213 // Temporary buffer manipulations
215 static __u8 *yaffs_GetTempBuffer(yaffs_Device *dev,int lineNo)
218 for(i = 0; i < YAFFS_N_TEMP_BUFFERS; i++)
220 if(dev->tempBuffer[i].line == 0)
222 dev->tempBuffer[i].line = lineNo;
223 if((i+1) > dev->maxTemp)
225 dev->maxTemp = i + 1;
226 for(j = 0; j <= i; j++)
227 dev->tempBuffer[j].maxLine = dev->tempBuffer[j].line;
230 return dev->tempBuffer[i].buffer;
234 T(YAFFS_TRACE_BUFFERS,(TSTR("Out of temp buffers at line %d, other held by lines:"),lineNo));
235 for(i = 0; i < YAFFS_N_TEMP_BUFFERS; i++)
237 T(YAFFS_TRACE_BUFFERS,(TSTR(" %d "),dev->tempBuffer[i].line));
239 T(YAFFS_TRACE_BUFFERS,(TSTR(" "TENDSTR)));
241 dev->unmanagedTempAllocations++;
242 // Get an unmanaged one
243 return YMALLOC(dev->nBytesPerChunk);
248 static void yaffs_ReleaseTempBuffer(yaffs_Device *dev, __u8 *buffer, int lineNo)
251 for(i = 0; i < YAFFS_N_TEMP_BUFFERS; i++)
253 if(dev->tempBuffer[i].buffer == buffer)
255 dev->tempBuffer[i].line = 0;
262 // assume it is an unmanaged one.
263 T(YAFFS_TRACE_BUFFERS,(TSTR("Releasing unmanaged temp buffer in line %d" TENDSTR),lineNo));
265 dev->unmanagedTempDeallocations++;
271 // Chunk bitmap manipulations
273 static Y_INLINE __u8 *yaffs_BlockBits(yaffs_Device *dev, int blk)
275 if(blk < dev->startBlock || blk > dev->endBlock)
277 T(YAFFS_TRACE_ERROR,(TSTR("**>> yaffs: BlockBits block %d is not valid" TENDSTR),blk));
280 return dev->chunkBits + (dev->chunkBitmapStride * (blk - dev->startBlock));
283 static Y_INLINE void yaffs_ClearChunkBits(yaffs_Device *dev,int blk)
285 __u8 *blkBits = yaffs_BlockBits(dev,blk);
287 memset(blkBits,0,dev->chunkBitmapStride);
290 static Y_INLINE void yaffs_ClearChunkBit(yaffs_Device *dev,int blk,int chunk)
292 __u8 *blkBits = yaffs_BlockBits(dev,blk);
294 blkBits[chunk/8] &= ~ (1<<(chunk & 7));
297 static Y_INLINE void yaffs_SetChunkBit(yaffs_Device *dev,int blk,int chunk)
299 __u8 *blkBits = yaffs_BlockBits(dev,blk);
301 blkBits[chunk/8] |= (1<<(chunk & 7));
304 static Y_INLINE int yaffs_CheckChunkBit(yaffs_Device *dev,int blk,int chunk)
306 __u8 *blkBits = yaffs_BlockBits(dev,blk);
307 return (blkBits[chunk/8] & (1<<(chunk & 7))) ? 1 :0;
310 static Y_INLINE int yaffs_StillSomeChunkBits(yaffs_Device *dev,int blk)
312 __u8 *blkBits = yaffs_BlockBits(dev,blk);
314 for(i = 0; i < dev->chunkBitmapStride; i++)
316 if(*blkBits) return 1;
323 // Function to manipulate block info
324 static Y_INLINE yaffs_BlockInfo* yaffs_GetBlockInfo(yaffs_Device *dev, int blk)
326 if(blk < dev->startBlock || blk > dev->endBlock)
328 T(YAFFS_TRACE_ERROR,(TSTR("**>> yaffs: getBlockInfo block %d is not valid" TENDSTR),blk));
331 return &dev->blockInfo[blk - dev->startBlock];
336 static Y_INLINE int yaffs_HashFunction(int n)
338 return (n % YAFFS_NOBJECT_BUCKETS);
342 yaffs_Object *yaffs_Root(yaffs_Device *dev)
347 yaffs_Object *yaffs_LostNFound(yaffs_Device *dev)
349 return dev->lostNFoundDir;
353 static int yaffs_WriteChunkToNAND(struct yaffs_DeviceStruct *dev,int chunkInNAND, const __u8 *data, yaffs_Spare *spare)
355 if(chunkInNAND < dev->startBlock * dev->nChunksPerBlock)
357 T(YAFFS_TRACE_ERROR,(TSTR("**>> yaffs chunk %d is not valid" TENDSTR),chunkInNAND));
362 return dev->writeChunkToNAND(dev,chunkInNAND,data,spare);
367 static int yaffs_ReadChunkFromNAND(struct yaffs_DeviceStruct *dev,
371 int doErrorCorrection)
374 yaffs_Spare localSpare;
383 // If we don't have a real spare, then we use a local one.
384 // Need this for the calculation of the ecc
391 retVal = dev->readChunkFromNAND(dev,chunkInNAND,data,spare);
392 if(data && doErrorCorrection)
395 //Todo handle any errors
396 int eccResult1,eccResult2;
399 yaffs_ECCCalculate(data,calcEcc);
400 eccResult1 = yaffs_ECCCorrect (data,spare->ecc1, calcEcc);
401 yaffs_ECCCalculate(&data[256],calcEcc);
402 eccResult2 = yaffs_ECCCorrect(&data[256],spare->ecc2, calcEcc);
406 T(YAFFS_TRACE_ERROR, (TSTR("**>>ecc error fix performed on chunk %d:0" TENDSTR),chunkInNAND));
409 else if(eccResult1<0)
411 T(YAFFS_TRACE_ERROR,(TSTR("**>>ecc error unfixed on chunk %d:0" TENDSTR),chunkInNAND));
417 T(YAFFS_TRACE_ERROR,(TSTR("**>>ecc error fix performed on chunk %d:1" TENDSTR),chunkInNAND));
420 else if(eccResult2<0)
422 T(YAFFS_TRACE_ERROR,(TSTR("**>>ecc error unfixed on chunk %d:1" TENDSTR),chunkInNAND));
426 if(eccResult1 || eccResult2)
428 // Hoosterman, we had a data problem on this page
429 yaffs_HandleReadDataError(dev,chunkInNAND);
435 // Must allocate enough memory for spare+2*sizeof(int) for ecc results from device.
436 struct yaffs_NANDSpare nspare;
437 retVal = dev->readChunkFromNAND(dev,chunkInNAND,data,(yaffs_Spare*)&nspare);
438 memcpy (spare, &nspare, sizeof(yaffs_Spare));
439 if(data && doErrorCorrection)
443 T(YAFFS_TRACE_ERROR,(TSTR("**>>ecc error fix performed on chunk %d:0" TENDSTR),chunkInNAND));
445 else if(nspare.eccres1<0)
447 T(YAFFS_TRACE_ERROR,(TSTR("**>>ecc error unfixed on chunk %d:0" TENDSTR),chunkInNAND));
452 T(YAFFS_TRACE_ERROR,(TSTR("**>>ecc error fix performed on chunk %d:1" TENDSTR),chunkInNAND));
454 else if(nspare.eccres2<0)
456 T(YAFFS_TRACE_ERROR,(TSTR("**>>ecc error unfixed on chunk %d:1" TENDSTR),chunkInNAND));
459 if(nspare.eccres1 || nspare.eccres2)
461 // Hoosterman, we had a data problem on this page
462 yaffs_HandleReadDataError(dev,chunkInNAND);
474 int yaffs_CheckFF(__u8 *buffer,int nBytes)
476 //Horrible, slow implementation
479 if(*buffer != 0xFF) return 0;
485 static int yaffs_CheckChunkErased(struct yaffs_DeviceStruct *dev,int chunkInNAND)
488 int retval = YAFFS_OK;
489 __u8 *data = yaffs_GetTempBuffer(dev,__LINE__);
490 yaffs_ExtendedTags tags;
492 // NCB dev->readChunkWithTagsFromNAND(dev,chunkInNAND,data,&tags);
493 yaffs_ReadChunkWithTagsFromNAND(dev,chunkInNAND,data,&tags);
495 if(!yaffs_CheckFF(data,dev->nBytesPerChunk) || tags.chunkUsed)
497 T(YAFFS_TRACE_NANDACCESS,(TSTR("Chunk %d not erased" TENDSTR),chunkInNAND));
501 yaffs_ReleaseTempBuffer(dev,data,__LINE__);
510 static int yaffs_WriteNewChunkWithTagsToNAND(struct yaffs_DeviceStruct *dev, const __u8 *data, yaffs_ExtendedTags *tags,int useReserve)
520 chunk = yaffs_AllocateChunk(dev,useReserve);
525 // First check this chunk is erased...
526 #ifndef CONFIG_YAFFS_DISABLE_CHUNK_ERASED_CHECK
527 writeOk = yaffs_CheckChunkErased(dev,chunk);
531 T(YAFFS_TRACE_ERROR,(TSTR("**>> yaffs chunk %d was not erased" TENDSTR),chunk));
535 writeOk = yaffs_WriteChunkWithTagsToNAND(dev,chunk,data,tags);
541 // Copy the data into the robustification buffer.
542 // NB We do this at the end to prevent duplicates in the case of a write error.
544 yaffs_HandleWriteChunkOk(dev,chunk,data,tags);
548 yaffs_HandleWriteChunkError(dev,chunk);
552 } while(chunk >= 0 && ! writeOk);
556 T(YAFFS_TRACE_ERROR,(TSTR("**>> yaffs write required %d attempts" TENDSTR),attempts));
557 dev->nRetriedWrites+= (attempts - 1);
568 // Functions for robustisizing
572 static void yaffs_RetireBlock(yaffs_Device *dev,int blockInNAND)
575 yaffs_MarkBlockBad(dev,blockInNAND);
577 yaffs_GetBlockInfo(dev,blockInNAND)->blockState = YAFFS_BLOCK_STATE_DEAD;
579 dev->nRetiredBlocks++;
584 static int yaffs_RewriteBufferedBlock(yaffs_Device *dev)
586 dev->doingBufferedBlockRewrite = 1;
588 // Remove erased chunks
589 // Rewrite existing chunks to a new block
590 // Set current write block to the new block
592 dev->doingBufferedBlockRewrite = 0;
598 static void yaffs_HandleReadDataError(yaffs_Device *dev,int chunkInNAND)
600 int blockInNAND = chunkInNAND/dev->nChunksPerBlock;
602 // Mark the block for retirement
603 yaffs_GetBlockInfo(dev,blockInNAND)->needsRetiring = 1;
604 T(YAFFS_TRACE_ERROR | YAFFS_TRACE_BAD_BLOCKS,(TSTR("**>>Block %d marked for retirement" TENDSTR),blockInNAND));
608 // Just do a garbage collection on the affected block then retire the block
613 static void yaffs_CheckWrittenBlock(yaffs_Device *dev,int chunkInNAND)
617 static void yaffs_HandleWriteChunkOk(yaffs_Device *dev,int chunkInNAND,const __u8 *data, const yaffs_ExtendedTags *tags)
621 static void yaffs_HandleUpdateChunk(yaffs_Device *dev,int chunkInNAND, const yaffs_ExtendedTags *tags)
625 static void yaffs_HandleWriteChunkError(yaffs_Device *dev,int chunkInNAND)
627 int blockInNAND = chunkInNAND/dev->nChunksPerBlock;
629 // Mark the block for retirement
630 yaffs_GetBlockInfo(dev,blockInNAND)->needsRetiring = 1;
632 yaffs_DeleteChunk(dev,chunkInNAND,1,__LINE__);
638 static int yaffs_VerifyCompare(const __u8 *d0, const __u8 * d1, const yaffs_Spare *s0, const yaffs_Spare *s1,int dataSize)
642 if( memcmp(d0,d1,dataSize) != 0 ||
643 s0->tagByte0 != s1->tagByte0 ||
644 s0->tagByte1 != s1->tagByte1 ||
645 s0->tagByte2 != s1->tagByte2 ||
646 s0->tagByte3 != s1->tagByte3 ||
647 s0->tagByte4 != s1->tagByte4 ||
648 s0->tagByte5 != s1->tagByte5 ||
649 s0->tagByte6 != s1->tagByte6 ||
650 s0->tagByte7 != s1->tagByte7 ||
651 s0->ecc1[0] != s1->ecc1[0] ||
652 s0->ecc1[1] != s1->ecc1[1] ||
653 s0->ecc1[2] != s1->ecc1[2] ||
654 s0->ecc2[0] != s1->ecc2[0] ||
655 s0->ecc2[1] != s1->ecc2[1] ||
656 s0->ecc2[2] != s1->ecc2[2] )
666 ///////////////////////// Object management //////////////////
667 // List of spare objects
668 // The list is hooked together using the first pointer
671 // static yaffs_Object *yaffs_freeObjects = NULL;
673 // static int yaffs_nFreeObjects;
675 // static yaffs_ObjectList *yaffs_allocatedObjectList = NULL;
677 // static yaffs_ObjectBucket yaffs_objectBucket[YAFFS_NOBJECT_BUCKETS];
680 static __u16 yaffs_CalcNameSum(const YCHAR *name)
685 YUCHAR *bname = (YUCHAR *)name;
688 while ((*bname) && (i <=YAFFS_MAX_NAME_LENGTH))
691 #ifdef CONFIG_YAFFS_CASE_INSENSITIVE
692 sum += yaffs_toupper(*bname) * i;
703 void yaffs_SetObjectName(yaffs_Object *obj, const YCHAR *name)
705 #ifdef CONFIG_YAFFS_SHORT_NAMES_IN_RAM
706 if(name && yaffs_strlen(name) <= YAFFS_SHORT_NAME_LENGTH)
708 yaffs_strcpy(obj->shortName,name);
712 obj->shortName[0]=_Y('\0');
715 obj->sum = yaffs_CalcNameSum(name);
719 void yaffs_CalcECC(const __u8 *data, yaffs_Spare *spare)
721 yaffs_ECCCalculate(data , spare->ecc1);
722 yaffs_ECCCalculate(&data[256] , spare->ecc2);
727 ///////////////////////// TNODES ///////////////////////
729 // List of spare tnodes
730 // The list is hooked together using the first pointer
733 //static yaffs_Tnode *yaffs_freeTnodes = NULL;
735 // static int yaffs_nFreeTnodes;
737 //static yaffs_TnodeList *yaffs_allocatedTnodeList = NULL;
741 // yaffs_CreateTnodes creates a bunch more tnodes and
742 // adds them to the tnode free list.
743 // Don't use this function directly
745 static int yaffs_CreateTnodes(yaffs_Device *dev,int nTnodes)
748 yaffs_Tnode *newTnodes;
749 yaffs_TnodeList *tnl;
751 if(nTnodes < 1) return YAFFS_OK;
755 newTnodes = YMALLOC(nTnodes * sizeof(yaffs_Tnode));
759 T(YAFFS_TRACE_ERROR,(TSTR("yaffs: Could not allocate Tnodes"TENDSTR)));
763 // Hook them into the free list
764 for(i = 0; i < nTnodes - 1; i++)
766 newTnodes[i].internal[0] = &newTnodes[i+1];
767 #ifdef CONFIG_YAFFS_TNODE_LIST_DEBUG
768 newTnodes[i].internal[YAFFS_NTNODES_INTERNAL] = 1;
772 newTnodes[nTnodes - 1].internal[0] = dev->freeTnodes;
773 #ifdef CONFIG_YAFFS_TNODE_LIST_DEBUG
774 newTnodes[nTnodes - 1].internal[YAFFS_NTNODES_INTERNAL] = 1;
776 dev->freeTnodes = newTnodes;
777 dev->nFreeTnodes+= nTnodes;
778 dev->nTnodesCreated += nTnodes;
780 // Now add this bunch of tnodes to a list for freeing up.
781 // NB If we can't add this to the management list it isn't fatal
782 // but it just means we can't free this bunch of tnodes later.
783 tnl = YMALLOC(sizeof(yaffs_TnodeList));
786 T(YAFFS_TRACE_ERROR,(TSTR("yaffs: Could not add tnodes to management list" TENDSTR)));
791 tnl->tnodes = newTnodes;
792 tnl->next = dev->allocatedTnodeList;
793 dev->allocatedTnodeList = tnl;
797 T(YAFFS_TRACE_ALLOCATE,(TSTR("yaffs: Tnodes added" TENDSTR)));
804 // GetTnode gets us a clean tnode. Tries to make allocate more if we run out
805 static yaffs_Tnode *yaffs_GetTnode(yaffs_Device *dev)
807 yaffs_Tnode *tn = NULL;
809 // If there are none left make more
812 yaffs_CreateTnodes(dev,YAFFS_ALLOCATION_NTNODES);
817 tn = dev->freeTnodes;
818 #ifdef CONFIG_YAFFS_TNODE_LIST_DEBUG
819 if(tn->internal[YAFFS_NTNODES_INTERNAL] != 1)
821 // Hoosterman, this thing looks like it isn't in the list
822 T(YAFFS_TRACE_ALWAYS,(TSTR("yaffs: Tnode list bug 1" TENDSTR)));
825 dev->freeTnodes = dev->freeTnodes->internal[0];
828 memset(tn,0,sizeof(yaffs_Tnode));
836 // FreeTnode frees up a tnode and puts it back on the free list
837 static void yaffs_FreeTnode(yaffs_Device*dev, yaffs_Tnode *tn)
841 #ifdef CONFIG_YAFFS_TNODE_LIST_DEBUG
842 if(tn->internal[YAFFS_NTNODES_INTERNAL] != 0)
844 // Hoosterman, this thing looks like it is already in the list
845 T(YAFFS_TRACE_ALWAYS,(TSTR("yaffs: Tnode list bug 2" TENDSTR)));
847 tn->internal[YAFFS_NTNODES_INTERNAL] = 1;
849 tn->internal[0] = dev->freeTnodes;
850 dev->freeTnodes = tn;
856 static void yaffs_DeinitialiseTnodes(yaffs_Device*dev)
858 // Free the list of allocated tnodes
859 yaffs_TnodeList *tmp;
861 while(dev->allocatedTnodeList)
863 tmp = dev->allocatedTnodeList->next;
865 YFREE(dev->allocatedTnodeList->tnodes);
866 YFREE(dev->allocatedTnodeList);
867 dev->allocatedTnodeList = tmp;
871 dev->freeTnodes = NULL;
872 dev->nFreeTnodes = 0;
875 static void yaffs_InitialiseTnodes(yaffs_Device*dev)
877 dev->allocatedTnodeList = NULL;
878 dev->freeTnodes = NULL;
879 dev->nFreeTnodes = 0;
880 dev->nTnodesCreated = 0;
885 void yaffs_TnodeTest(yaffs_Device *dev)
890 yaffs_Tnode *tn[1000];
892 YINFO("Testing TNodes");
894 for(j = 0; j < 50; j++)
896 for(i = 0; i < 1000; i++)
898 tn[i] = yaffs_GetTnode(dev);
901 YALERT("Getting tnode failed");
904 for(i = 0; i < 1000; i+=3)
906 yaffs_FreeTnode(dev,tn[i]);
915 ////////////////// END OF TNODE MANIPULATION ///////////////////////////
917 /////////////// Functions to manipulate the look-up tree (made up of tnodes)
918 // The look up tree is represented by the top tnode and the number of topLevel
919 // in the tree. 0 means only the level 0 tnode is in the tree.
922 // FindLevel0Tnode finds the level 0 tnode, if one exists.
923 // Used when reading.....
924 static yaffs_Tnode *yaffs_FindLevel0Tnode(yaffs_Device *dev,yaffs_FileStructure *fStruct, __u32 chunkId)
927 yaffs_Tnode *tn = fStruct->top;
929 int requiredTallness;
930 int level = fStruct->topLevel;
932 // Check sane level and chunk Id
933 if(level < 0 || level > YAFFS_TNODES_MAX_LEVEL)
936 // sprintf(str,"Bad level %d",level);
941 if(chunkId > YAFFS_MAX_CHUNK_ID)
944 // sprintf(str,"Bad chunkId %d",chunkId);
949 // First check we're tall enough (ie enough topLevel)
951 i = chunkId >> (/*dev->chunkGroupBits + */YAFFS_TNODES_LEVEL0_BITS);
952 requiredTallness = 0;
955 i >>= YAFFS_TNODES_INTERNAL_BITS;
960 if(requiredTallness > fStruct->topLevel)
962 // Not tall enough, so we can't find it, return NULL.
967 // Traverse down to level 0
968 while (level > 0 && tn)
970 tn = tn->internal[(chunkId >>(/* dev->chunkGroupBits + */ YAFFS_TNODES_LEVEL0_BITS + (level-1) * YAFFS_TNODES_INTERNAL_BITS)) &
971 YAFFS_TNODES_INTERNAL_MASK];
979 // AddOrFindLevel0Tnode finds the level 0 tnode if it exists, otherwise first expands the tree.
980 // This happens in two steps:
981 // 1. If the tree isn't tall enough, then make it taller.
982 // 2. Scan down the tree towards the level 0 tnode adding tnodes if required.
984 // Used when modifying the tree.
986 static yaffs_Tnode *yaffs_AddOrFindLevel0Tnode(yaffs_Device *dev, yaffs_FileStructure *fStruct, __u32 chunkId)
991 int requiredTallness;
998 //T((TSTR("AddOrFind topLevel=%d, chunk=%d"),fStruct->topLevel,chunkId));
1000 // Check sane level and page Id
1001 if(fStruct->topLevel < 0 || fStruct->topLevel > YAFFS_TNODES_MAX_LEVEL)
1004 // sprintf(str,"Bad level %d",fStruct->topLevel);
1009 if(chunkId > YAFFS_MAX_CHUNK_ID)
1012 // sprintf(str,"Bad chunkId %d",chunkId);
1017 // First check we're tall enough (ie enough topLevel)
1019 x = chunkId >> (/*dev->chunkGroupBits + */YAFFS_TNODES_LEVEL0_BITS);
1020 requiredTallness = 0;
1023 x >>= YAFFS_TNODES_INTERNAL_BITS;
1027 //T((TSTR(" required=%d"),requiredTallness));
1030 if(requiredTallness > fStruct->topLevel)
1032 // Not tall enough,gotta make the tree taller
1033 for(i = fStruct->topLevel; i < requiredTallness; i++)
1035 //T((TSTR(" add new top")));
1037 tn = yaffs_GetTnode(dev);
1041 tn->internal[0] = fStruct->top;
1046 T(YAFFS_TRACE_ERROR,(TSTR("yaffs: no more tnodes" TENDSTR)));
1050 fStruct->topLevel = requiredTallness;
1054 // Traverse down to level 0, adding anything we need
1056 l = fStruct->topLevel;
1060 x = (chunkId >> (/*dev->chunkGroupBits + */YAFFS_TNODES_LEVEL0_BITS + (l-1) * YAFFS_TNODES_INTERNAL_BITS)) &
1061 YAFFS_TNODES_INTERNAL_MASK;
1063 //T((TSTR(" [%d:%d]"),l,i));
1065 if(!tn->internal[x])
1067 //T((TSTR(" added")));
1069 tn->internal[x] = yaffs_GetTnode(dev);
1072 tn = tn->internal[x];
1083 int yaffs_FindChunkInGroup(yaffs_Device *dev, int theChunk, yaffs_ExtendedTags *tags, int objectId, int chunkInInode)
1088 for(j = 0; theChunk && j < dev->chunkGroupSize; j++)
1090 if(yaffs_CheckChunkBit(dev,theChunk / dev->nChunksPerBlock,theChunk % dev->nChunksPerBlock))
1092 yaffs_ReadChunkWithTagsFromNAND(dev,theChunk,NULL,tags);
1093 if(yaffs_TagsMatch(tags,objectId,chunkInInode))
1105 // DeleteWorker scans backwards through the tnode tree and deletes all the
1106 // chunks and tnodes in the file
1107 // Returns 1 if the tree was deleted. Returns 0 if it stopped early due to hitting the limit and the delete is incomplete.
1109 static int yaffs_DeleteWorker(yaffs_Object *in, yaffs_Tnode *tn, __u32 level, int chunkOffset,int *limit)
1114 yaffs_ExtendedTags tags;
1116 yaffs_Device *dev = in->myDev;
1126 for(i = YAFFS_NTNODES_INTERNAL -1; allDone && i >= 0; i--)
1130 if(limit && (*limit) < 0)
1136 allDone = yaffs_DeleteWorker(in,tn->internal[i],level - 1,
1137 (chunkOffset << YAFFS_TNODES_INTERNAL_BITS ) + i ,limit);
1141 yaffs_FreeTnode(dev,tn->internal[i]);
1142 tn->internal[i] = NULL;
1147 return (allDone) ? 1 : 0;
1153 for(i = YAFFS_NTNODES_LEVEL0 -1; i >= 0 && !hitLimit; i--)
1158 chunkInInode = (chunkOffset << YAFFS_TNODES_LEVEL0_BITS ) + i;
1160 theChunk = tn->level0[i] << dev->chunkGroupBits;
1162 foundChunk = yaffs_FindChunkInGroup(dev,theChunk,&tags,in->objectId,chunkInInode);
1166 yaffs_DeleteChunk(dev,foundChunk,1,__LINE__);
1183 return (i < 0) ? 1 : 0;
1195 static void yaffs_SoftDeleteChunk(yaffs_Device *dev, int chunk)
1198 yaffs_BlockInfo *theBlock;
1200 T(YAFFS_TRACE_DELETION,(TSTR("soft delete chunk %d" TENDSTR),chunk));
1202 theBlock = yaffs_GetBlockInfo(dev, chunk/dev->nChunksPerBlock);
1205 theBlock->softDeletions++;
1209 // SoftDeleteWorker scans backwards through the tnode tree and soft deletes all the chunks in the file.
1210 // All soft deleting does is increment the block's softdelete count and pulls the chunk out
1212 // THus, essentially this is the same as DeleteWorker except that the chunks are soft deleted.
1214 static int yaffs_SoftDeleteWorker(yaffs_Object *in, yaffs_Tnode *tn, __u32 level, int chunkOffset)
1219 yaffs_Device *dev = in->myDev;
1227 for(i = YAFFS_NTNODES_INTERNAL -1; allDone && i >= 0; i--)
1231 allDone = yaffs_SoftDeleteWorker(in,tn->internal[i],level - 1,
1232 (chunkOffset << YAFFS_TNODES_INTERNAL_BITS ) + i);
1235 yaffs_FreeTnode(dev,tn->internal[i]);
1236 tn->internal[i] = NULL;
1240 //Hoosterman... how could this happen.
1244 return (allDone) ? 1 : 0;
1249 for(i = YAFFS_NTNODES_LEVEL0 -1; i >=0; i--)
1253 // Note this does not find the real chunk, only the chunk group.
1254 // We make an assumption that a chunk group is niot larger than a block.
1255 theChunk = (tn->level0[i] << dev->chunkGroupBits);
1257 yaffs_SoftDeleteChunk(dev,theChunk);
1274 static void yaffs_SoftDeleteFile(yaffs_Object *obj)
1277 obj->variantType == YAFFS_OBJECT_TYPE_FILE &&
1280 if(obj->nDataChunks <= 0)
1282 // Empty file with no duplicate object headers, just delete it immediately
1283 yaffs_FreeTnode(obj->myDev,obj->variant.fileVariant.top);
1284 obj->variant.fileVariant.top = NULL;
1285 T(YAFFS_TRACE_TRACING,(TSTR("yaffs: Deleting empty file %d" TENDSTR),obj->objectId));
1286 yaffs_DoGenericObjectDeletion(obj);
1290 yaffs_SoftDeleteWorker(obj, obj->variant.fileVariant.top, obj->variant.fileVariant.topLevel, 0);
1291 obj->softDeleted = 1;
1300 // Pruning removes any part of the file structure tree that is beyond the
1301 // bounds of the file (ie that does not point to chunks).
1303 // A file should only get pruned when its size is reduced.
1305 // Before pruning, the chunks must be pulled from the tree and the
1306 // level 0 tnode entries must be zeroed out.
1307 // Could also use this for file deletion, but that's probably better handled
1308 // by a special case.
1310 // yaffs_PruneWorker should only be called by yaffs_PruneFileStructure()
1312 static yaffs_Tnode *yaffs_PruneWorker(yaffs_Device *dev, yaffs_Tnode *tn, __u32 level, int del0)
1321 for(i = 0; i < YAFFS_NTNODES_INTERNAL; i++)
1323 if(tn->internal[i] && level > 0)
1325 tn->internal[i] = yaffs_PruneWorker(dev,tn->internal[i],level - 1, ( i == 0) ? del0 : 1);
1334 if(hasData == 0 && del0)
1336 // Free and return NULL
1338 yaffs_FreeTnode(dev,tn);
1348 static int yaffs_PruneFileStructure(yaffs_Device *dev, yaffs_FileStructure *fStruct)
1355 if(fStruct->topLevel > 0)
1357 fStruct->top = yaffs_PruneWorker(dev,fStruct->top, fStruct->topLevel,0);
1359 // Now we have a tree with all the non-zero branches NULL but the height
1360 // is the same as it was.
1361 // Let's see if we can trim internal tnodes to shorten the tree.
1362 // We can do this if only the 0th element in the tnode is in use
1363 // (ie all the non-zero are NULL)
1365 while(fStruct->topLevel && !done)
1370 for(i = 1; i <YAFFS_NTNODES_INTERNAL; i++)
1380 fStruct->top = tn->internal[0];
1381 fStruct->topLevel--;
1382 yaffs_FreeTnode(dev,tn);
1398 /////////////////////// End of File Structure functions. /////////////////
1400 // yaffs_CreateFreeObjects creates a bunch more objects and
1401 // adds them to the object free list.
1402 static int yaffs_CreateFreeObjects(yaffs_Device *dev, int nObjects)
1405 yaffs_Object *newObjects;
1406 yaffs_ObjectList *list;
1408 if(nObjects < 1) return YAFFS_OK;
1410 // make these things
1412 newObjects = YMALLOC(nObjects * sizeof(yaffs_Object));
1416 T(YAFFS_TRACE_ALLOCATE,(TSTR("yaffs: Could not allocate more objects" TENDSTR)));
1420 // Hook them into the free list
1421 for(i = 0; i < nObjects - 1; i++)
1423 newObjects[i].siblings.next = (struct list_head *)(&newObjects[i+1]);
1426 newObjects[nObjects - 1].siblings.next = (void *)dev->freeObjects;
1427 dev->freeObjects = newObjects;
1428 dev->nFreeObjects+= nObjects;
1429 dev->nObjectsCreated+= nObjects;
1431 // Now add this bunch of Objects to a list for freeing up.
1433 list = YMALLOC(sizeof(yaffs_ObjectList));
1436 T(YAFFS_TRACE_ALLOCATE,(TSTR("Could not add objects to management list" TENDSTR)));
1440 list->objects = newObjects;
1441 list->next = dev->allocatedObjectList;
1442 dev->allocatedObjectList = list;
1451 // AllocateEmptyObject gets us a clean Object. Tries to make allocate more if we run out
1452 static yaffs_Object *yaffs_AllocateEmptyObject(yaffs_Device *dev)
1454 yaffs_Object *tn = NULL;
1456 // If there are none left make more
1457 if(!dev->freeObjects)
1459 yaffs_CreateFreeObjects(dev,YAFFS_ALLOCATION_NOBJECTS);
1462 if(dev->freeObjects)
1464 tn = dev->freeObjects;
1465 dev->freeObjects = (yaffs_Object *)(dev->freeObjects->siblings.next);
1466 dev->nFreeObjects--;
1468 // Now sweeten it up...
1470 memset(tn,0,sizeof(yaffs_Object));
1473 tn->variantType = YAFFS_OBJECT_TYPE_UNKNOWN;
1474 INIT_LIST_HEAD(&(tn->hardLinks));
1475 INIT_LIST_HEAD(&(tn->hashLink));
1476 INIT_LIST_HEAD(&tn->siblings);
1478 // Add it to the lost and found directory.
1479 // NB Can't put root or lostNFound in lostNFound so
1480 // check if lostNFound exists first
1481 if(dev->lostNFoundDir)
1483 yaffs_AddObjectToDirectory(dev->lostNFoundDir,tn);
1491 static yaffs_Object *yaffs_CreateFakeDirectory(yaffs_Device *dev,int number,__u32 mode)
1494 yaffs_Object *obj = yaffs_CreateNewObject(dev,number,YAFFS_OBJECT_TYPE_DIRECTORY);
1497 obj->fake = 1; // it is fake so it has no NAND presence...
1498 obj->renameAllowed= 0; // ... and we're not allowed to rename it...
1499 obj->unlinkAllowed= 0; // ... or unlink it
1502 obj->st_mode = mode;
1504 obj->chunkId = 0; // Not a valid chunk.
1512 static void yaffs_UnhashObject(yaffs_Object *tn)
1515 yaffs_Device *dev = tn->myDev;
1518 // If it is still linked into the bucket list, free from the list
1519 if(!list_empty(&tn->hashLink))
1521 list_del_init(&tn->hashLink);
1522 bucket = yaffs_HashFunction(tn->objectId);
1523 dev->objectBucket[bucket].count--;
1529 // FreeObject frees up a Object and puts it back on the free list
1530 static void yaffs_FreeObject(yaffs_Object *tn)
1533 yaffs_Device *dev = tn->myDev;
1538 // We're still hooked up to a cached inode.
1539 // Don't delete now, but mark for later deletion
1540 tn->deferedFree = 1;
1545 yaffs_UnhashObject(tn);
1547 // Link into the free list.
1548 tn->siblings.next = (struct list_head *)(dev->freeObjects);
1549 dev->freeObjects = tn;
1550 dev->nFreeObjects++;
1557 void yaffs_HandleDeferedFree(yaffs_Object *obj)
1559 if(obj->deferedFree)
1561 yaffs_FreeObject(obj);
1569 static void yaffs_DeinitialiseObjects(yaffs_Device *dev)
1571 // Free the list of allocated Objects
1573 yaffs_ObjectList *tmp;
1575 while( dev->allocatedObjectList)
1577 tmp = dev->allocatedObjectList->next;
1578 YFREE(dev->allocatedObjectList->objects);
1579 YFREE(dev->allocatedObjectList);
1581 dev->allocatedObjectList = tmp;
1584 dev->freeObjects = NULL;
1585 dev->nFreeObjects = 0;
1588 static void yaffs_InitialiseObjects(yaffs_Device *dev)
1592 dev->allocatedObjectList = NULL;
1593 dev->freeObjects = NULL;
1594 dev->nFreeObjects = 0;
1596 for(i = 0; i < YAFFS_NOBJECT_BUCKETS; i++)
1598 INIT_LIST_HEAD(&dev->objectBucket[i].list);
1599 dev->objectBucket[i].count = 0;
1609 int yaffs_FindNiceObjectBucket(yaffs_Device *dev)
1614 int lowest = 999999;
1617 // First let's see if we can find one that's empty.
1619 for(i = 0; i < 10 && lowest > 0; i++)
1622 x %= YAFFS_NOBJECT_BUCKETS;
1623 if(dev->objectBucket[x].count < lowest)
1625 lowest = dev->objectBucket[x].count;
1631 // If we didn't find an empty list, then try
1632 // looking a bit further for a short one
1634 for(i = 0; i < 10 && lowest > 3; i++)
1637 x %= YAFFS_NOBJECT_BUCKETS;
1638 if(dev->objectBucket[x].count < lowest)
1640 lowest = dev->objectBucket[x].count;
1649 static int yaffs_CreateNewObjectNumber(yaffs_Device *dev)
1651 int bucket = yaffs_FindNiceObjectBucket(dev);
1653 // Now find an object value that has not already been taken
1654 // by scanning the list.
1657 struct list_head *i;
1659 __u32 n = (__u32)bucket;
1661 //yaffs_CheckObjectHashSanity();
1666 n += YAFFS_NOBJECT_BUCKETS;
1667 if(1 ||dev->objectBucket[bucket].count > 0)
1669 list_for_each(i,&dev->objectBucket[bucket].list)
1671 // If there is already one in the list
1672 if(i && list_entry(i, yaffs_Object,hashLink)->objectId == n)
1680 //T(("bucket %d count %d inode %d\n",bucket,yaffs_objectBucket[bucket].count,n);
1685 void yaffs_HashObject(yaffs_Object *in)
1687 int bucket = yaffs_HashFunction(in->objectId);
1688 yaffs_Device *dev = in->myDev;
1690 if(!list_empty(&in->hashLink))
1696 list_add(&in->hashLink,&dev->objectBucket[bucket].list);
1697 dev->objectBucket[bucket].count++;
1701 yaffs_Object *yaffs_FindObjectByNumber(yaffs_Device *dev,__u32 number)
1703 int bucket = yaffs_HashFunction(number);
1704 struct list_head *i;
1707 list_for_each(i,&dev->objectBucket[bucket].list)
1709 // Look if it is in the list
1712 in = list_entry(i, yaffs_Object,hashLink);
1713 if(in->objectId == number)
1725 yaffs_Object *yaffs_CreateNewObject(yaffs_Device *dev,int number,yaffs_ObjectType type)
1728 yaffs_Object *theObject;
1732 number = yaffs_CreateNewObjectNumber(dev);
1735 theObject = yaffs_AllocateEmptyObject(dev);
1739 theObject->fake = 0;
1740 theObject->renameAllowed = 1;
1741 theObject->unlinkAllowed = 1;
1742 theObject->objectId = number;
1743 yaffs_HashObject(theObject);
1744 theObject->variantType = type;
1745 #ifdef CONFIG_YAFFS_WINCE
1746 yfsd_WinFileTimeNow(theObject->win_atime);
1747 theObject->win_ctime[0] = theObject->win_mtime[0] = theObject->win_atime[0];
1748 theObject->win_ctime[1] = theObject->win_mtime[1] = theObject->win_atime[1];
1752 theObject->st_atime = theObject->st_mtime = theObject->st_ctime = Y_CURRENT_TIME;
1756 case YAFFS_OBJECT_TYPE_FILE:
1757 theObject->variant.fileVariant.fileSize = 0;
1758 theObject->variant.fileVariant.scannedFileSize = 0;
1759 theObject->variant.fileVariant.topLevel = 0;
1760 theObject->variant.fileVariant.top = yaffs_GetTnode(dev);
1762 case YAFFS_OBJECT_TYPE_DIRECTORY:
1763 INIT_LIST_HEAD(&theObject->variant.directoryVariant.children);
1765 case YAFFS_OBJECT_TYPE_SYMLINK:
1766 // No action required
1768 case YAFFS_OBJECT_TYPE_HARDLINK:
1769 // No action required
1771 case YAFFS_OBJECT_TYPE_SPECIAL:
1772 // No action required
1774 case YAFFS_OBJECT_TYPE_UNKNOWN:
1775 // todo this should not happen
1783 yaffs_Object *yaffs_FindOrCreateObjectByNumber(yaffs_Device *dev, int number,yaffs_ObjectType type)
1785 yaffs_Object *theObject = NULL;
1789 theObject = yaffs_FindObjectByNumber(dev,number);
1794 theObject = yaffs_CreateNewObject(dev,number,type);
1801 YCHAR *yaffs_CloneString(const YCHAR *str)
1803 YCHAR *newStr = NULL;
1807 newStr = YMALLOC((yaffs_strlen(str) + 1) * sizeof(YCHAR));
1808 yaffs_strcpy(newStr,str);
1816 // Mknod (create) a new object.
1817 // equivalentObject only has meaning for a hard link;
1818 // aliasString only has meaning for a sumlink.
1819 // rdev only has meaning for devices (a subset of special objects)
1820 yaffs_Object *yaffs_MknodObject( yaffs_ObjectType type,
1821 yaffs_Object *parent,
1826 yaffs_Object *equivalentObject,
1827 const YCHAR *aliasString,
1832 yaffs_Device *dev = parent->myDev;
1834 // Check if the entry exists. If it does then fail the call since we don't want a dup.
1835 if(yaffs_FindObjectByName(parent,name))
1840 in = yaffs_CreateNewObject(dev,-1,type);
1846 in->variantType = type;
1850 #ifdef CONFIG_YAFFS_WINCE
1851 yfsd_WinFileTimeNow(in->win_atime);
1852 in->win_ctime[0] = in->win_mtime[0] = in->win_atime[0];
1853 in->win_ctime[1] = in->win_mtime[1] = in->win_atime[1];
1856 in->st_atime = in->st_mtime = in->st_ctime = Y_CURRENT_TIME;
1862 in->nDataChunks = 0;
1864 yaffs_SetObjectName(in,name);
1867 yaffs_AddObjectToDirectory(parent,in);
1869 in->myDev = parent->myDev;
1874 case YAFFS_OBJECT_TYPE_SYMLINK:
1875 in->variant.symLinkVariant.alias = yaffs_CloneString(aliasString);
1877 case YAFFS_OBJECT_TYPE_HARDLINK:
1878 in->variant.hardLinkVariant.equivalentObject = equivalentObject;
1879 in->variant.hardLinkVariant.equivalentObjectId = equivalentObject->objectId;
1880 list_add(&in->hardLinks,&equivalentObject->hardLinks);
1882 case YAFFS_OBJECT_TYPE_FILE: // do nothing
1883 case YAFFS_OBJECT_TYPE_DIRECTORY: // do nothing
1884 case YAFFS_OBJECT_TYPE_SPECIAL: // do nothing
1885 case YAFFS_OBJECT_TYPE_UNKNOWN:
1889 if(/*yaffs_GetNumberOfFreeChunks(dev) <= 0 || */
1890 yaffs_UpdateObjectHeader(in,name,0,0) < 0)
1892 // Could not create the object header, fail the creation
1893 yaffs_DestroyObject(in);
1902 yaffs_Object *yaffs_MknodFile(yaffs_Object *parent,const YCHAR *name, __u32 mode, __u32 uid, __u32 gid)
1904 return yaffs_MknodObject(YAFFS_OBJECT_TYPE_FILE,parent,name,mode,uid,gid,NULL,NULL,0);
1907 yaffs_Object *yaffs_MknodDirectory(yaffs_Object *parent,const YCHAR *name, __u32 mode, __u32 uid, __u32 gid)
1909 return yaffs_MknodObject(YAFFS_OBJECT_TYPE_DIRECTORY,parent,name,mode,uid,gid,NULL,NULL,0);
1912 yaffs_Object *yaffs_MknodSpecial(yaffs_Object *parent,const YCHAR *name, __u32 mode, __u32 uid, __u32 gid, __u32 rdev)
1914 return yaffs_MknodObject(YAFFS_OBJECT_TYPE_DIRECTORY,parent,name,mode,uid,gid,NULL,NULL,rdev);
1917 yaffs_Object *yaffs_MknodSymLink(yaffs_Object *parent,const YCHAR *name, __u32 mode, __u32 uid, __u32 gid,const YCHAR *alias)
1919 return yaffs_MknodObject(YAFFS_OBJECT_TYPE_SYMLINK,parent,name,mode,uid,gid,NULL,alias,0);
1922 // NB yaffs_Link returns the object id of the equivalent object.
1923 yaffs_Object *yaffs_Link(yaffs_Object *parent, const YCHAR *name, yaffs_Object *equivalentObject)
1925 // Get the real object in case we were fed a hard link as an equivalent object
1926 equivalentObject = yaffs_GetEquivalentObject(equivalentObject);
1928 if(yaffs_MknodObject(YAFFS_OBJECT_TYPE_HARDLINK,parent,name,0,0,0,equivalentObject,NULL,0))
1930 return equivalentObject;
1940 static int yaffs_ChangeObjectName(yaffs_Object *obj, yaffs_Object *newDir, const YCHAR *newName,int force)
1947 newDir = obj->parent; // use the old directory
1950 // TODO: Do we need this different handling for YAFFS2 and YAFFS1??
1951 if(obj->myDev->isYaffs2)
1953 unlinkOp = (newDir == obj->myDev->unlinkedDir);
1957 unlinkOp = (newDir == obj->myDev->unlinkedDir && obj->variantType == YAFFS_OBJECT_TYPE_FILE);
1960 deleteOp = (newDir == obj->myDev->deletedDir);
1962 // If the object is a file going into the unlinked directory, then it is OK to just stuff it in since
1963 // duplicate names are allowed.
1964 // Otherwise only proceed if the new name does not exist and if we're putting it into a directory.
1968 !yaffs_FindObjectByName(newDir,newName)) &&
1969 newDir->variantType == YAFFS_OBJECT_TYPE_DIRECTORY)
1971 yaffs_SetObjectName(obj,newName);
1974 yaffs_AddObjectToDirectory(newDir,obj);
1976 if(unlinkOp) obj->unlinked = 1;
1978 // If it is a dletion then we mark it as a shrink for gc purposes.
1979 if(yaffs_UpdateObjectHeader(obj,newName,0,deleteOp) >= 0)
1990 int yaffs_RenameObject(yaffs_Object *oldDir, const YCHAR *oldName, yaffs_Object *newDir, const YCHAR *newName)
1995 #ifdef CONFIG_YAFFS_CASE_INSENSITIVE
1996 // Special case for case insemsitive systems (eg. WinCE).
1997 // While look-up is case insensitive, the name isn't.
1998 // THerefore we might want to change x.txt to X.txt
1999 if(oldDir == newDir && yaffs_strcmp(oldName,newName) == 0)
2005 obj = yaffs_FindObjectByName(oldDir,oldName);
2006 if(obj && obj->renameAllowed)
2008 return yaffs_ChangeObjectName(obj,newDir,newName,force);
2015 static int yaffs_CheckObjectHashSanity(yaffs_Device *dev)
2017 // Scan the buckets and check that the lists
2018 // have as many members as the count says there are
2021 struct list_head *j;
2024 for(bucket = 0; bucket < YAFFS_NOBJECT_BUCKETS; bucket++)
2028 list_for_each(j,&dev->objectBucket[bucket].list)
2033 if(countEm != dev->objectBucket[bucket].count)
2035 T(YAFFS_TRACE_ERROR,(TSTR("Inode hash inconsistency" TENDSTR)));
2044 void yaffs_ObjectTest(yaffs_Device *dev)
2046 yaffs_Object *in[1000];
2048 yaffs_Object *inold[1000];
2052 memset(in,0,1000*sizeof(yaffs_Object *));
2053 memset(inold,0,1000*sizeof(yaffs_Object *));
2055 yaffs_CheckObjectHashSanity(dev);
2057 for(j = 0; j < 10; j++)
2061 for(i = 0; i < 1000; i++)
2063 in[i] = yaffs_CreateNewObject(dev,-1,YAFFS_OBJECT_TYPE_FILE);
2066 YINFO("No more inodes");
2070 inNo[i] = in[i]->objectId;
2074 for(i = 0; i < 1000; i++)
2076 if(yaffs_FindObjectByNumber(dev,inNo[i]) != in[i])
2078 //T(("Differnce in look up test\n"));
2082 // T(("Look up ok\n"));
2086 yaffs_CheckObjectHashSanity(dev);
2088 for(i = 0; i < 1000; i+=3)
2090 yaffs_FreeObject(in[i]);
2095 yaffs_CheckObjectHashSanity(dev);
2102 /////////////////////////// Block Management and Page Allocation ///////////////////
2105 static int yaffs_InitialiseBlocks(yaffs_Device *dev,int nBlocks)
2107 dev->allocationBlock = -1; // force it to get a new one
2108 //Todo we're assuming the malloc will pass.
2109 dev->blockInfo = YMALLOC(nBlocks * sizeof(yaffs_BlockInfo));
2110 // Set up dynamic blockinfo stuff.
2111 dev->chunkBitmapStride = (dev->nChunksPerBlock+7)/8;
2112 dev->chunkBits = YMALLOC(dev->chunkBitmapStride * nBlocks);
2113 if(dev->blockInfo && dev->chunkBits)
2115 memset(dev->blockInfo,0,nBlocks * sizeof(yaffs_BlockInfo));
2116 memset(dev->chunkBits,0,dev->chunkBitmapStride * nBlocks);
2124 static void yaffs_DeinitialiseBlocks(yaffs_Device *dev)
2126 YFREE(dev->blockInfo);
2127 dev->blockInfo = NULL;
2128 YFREE(dev->chunkBits);
2129 dev->chunkBits = NULL;
2133 static int yaffs_BlockNotDisqualifiedFromGC(yaffs_Device *dev, yaffs_BlockInfo *bi)
2139 if(!dev->isYaffs2) return 1; // disqualification only applies to yaffs2.
2141 if(!bi->hasShrinkHeader) return 1; // can gc
2144 // Find the oldest dirty sequence number if we don't know it and save it
2145 // so we don't have to keep recomputing it.
2146 if(!dev->oldestDirtySequence)
2148 seq = dev->sequenceNumber;
2150 for(i = dev->startBlock; i <= dev->endBlock; i++)
2152 b = yaffs_GetBlockInfo(dev,i);
2153 if(b->blockState == YAFFS_BLOCK_STATE_FULL &&
2154 (b->pagesInUse - b->softDeletions )< dev->nChunksPerBlock &&
2155 b->sequenceNumber < seq)
2157 seq = b->sequenceNumber;
2160 dev->oldestDirtySequence = seq;
2164 // Can't do gc of this block if there are any blocks older than this one that have
2166 return (bi->sequenceNumber <= dev->oldestDirtySequence);
2173 // FindDiretiestBlock is used to select the dirtiest block (or close enough)
2174 // for garbage collection.
2179 static int yaffs_FindBlockForGarbageCollection(yaffs_Device *dev,int aggressive)
2182 int b = dev->currentDirtyChecker;
2188 yaffs_BlockInfo *bi;
2189 static int nonAggressiveSkip = 0;
2191 // If we're doing aggressive GC then we are happy to take a less-dirty block, and
2193 // else (we're doing a leasurely gc), then we only bother to do this if the
2194 // block has only a few pages in use.
2197 nonAggressiveSkip--;
2199 if(!aggressive &&(nonAggressiveSkip > 0))
2204 pagesInUse = (aggressive)? dev->nChunksPerBlock : YAFFS_PASSIVE_GC_CHUNKS + 1;
2207 iterations = dev->endBlock - dev->startBlock + 1;
2211 iterations = dev->endBlock - dev->startBlock + 1;
2212 iterations = iterations / 16;
2213 if(iterations > 200)
2219 for(i = 0; i <= iterations && pagesInUse > 0 ; i++)
2222 if ( b < dev->startBlock || b > dev->endBlock)
2224 b = dev->startBlock;
2227 if(b < dev->startBlock || b > dev->endBlock)
2229 T(YAFFS_TRACE_ERROR,(TSTR("**>> Block %d is not valid" TENDSTR),b));
2233 bi = yaffs_GetBlockInfo(dev,b);
2235 if(bi->blockState == YAFFS_BLOCK_STATE_FULL &&
2236 (bi->pagesInUse - bi->softDeletions )< pagesInUse &&
2237 yaffs_BlockNotDisqualifiedFromGC(dev,bi))
2240 pagesInUse = (bi->pagesInUse - bi->softDeletions);
2244 dev->currentDirtyChecker = b;
2248 T(YAFFS_TRACE_GC,(TSTR("GC Selected block %d with %d free" TENDSTR),dirtiest,dev->nChunksPerBlock - pagesInUse));
2251 dev->oldestDirtySequence = 0; // clear this
2255 nonAggressiveSkip = 4;
2262 static void yaffs_BlockBecameDirty(yaffs_Device *dev,int blockNo)
2264 yaffs_BlockInfo *bi = yaffs_GetBlockInfo(dev,blockNo);
2268 // If the block is still healthy erase it and mark as clean.
2269 // If the block has had a data failure, then retire it.
2270 bi->blockState = YAFFS_BLOCK_STATE_DIRTY;
2272 if(!bi->needsRetiring)
2274 erasedOk = yaffs_EraseBlockInNAND(dev,blockNo);
2277 dev->nErasureFailures++;
2278 T(YAFFS_TRACE_ERROR | YAFFS_TRACE_BAD_BLOCKS,(TSTR("**>> Erasure failed %d" TENDSTR),blockNo));
2282 if(erasedOk && (yaffs_traceMask & YAFFS_TRACE_ERASE))
2285 for(i = 0; i < dev->nChunksPerBlock; i++)
2287 if(!yaffs_CheckChunkErased(dev,blockNo * dev->nChunksPerBlock + i))
2289 T(YAFFS_TRACE_ERROR,(TSTR(">>Block %d erasure supposedly OK, but chunk %d not erased" TENDSTR),blockNo,i));
2297 bi->blockState = YAFFS_BLOCK_STATE_EMPTY;
2298 dev->nErasedBlocks++;
2300 bi->softDeletions = 0;
2301 bi->hasShrinkHeader=0;
2302 yaffs_ClearChunkBits(dev,blockNo);
2304 T(YAFFS_TRACE_ERASE,(TSTR("Erased block %d" TENDSTR),blockNo));
2308 yaffs_RetireBlock(dev,blockNo);
2309 T(YAFFS_TRACE_ERROR | YAFFS_TRACE_BAD_BLOCKS,(TSTR("**>> Block %d retired" TENDSTR),blockNo));
2313 static void yaffs_DumpBlockStats(yaffs_Device *dev)
2316 yaffs_BlockInfo *bi;
2318 for(i= dev->startBlock; i <=dev->endBlock; i++)
2320 bi = yaffs_GetBlockInfo(dev,i);
2321 T(YAFFS_TRACE_ALLOCATE,(TSTR("%3d state %d shrink %d inuse %d/%d seq %d pages"),i,
2322 bi->blockState,bi->hasShrinkHeader,bi->pagesInUse,bi->softDeletions,bi->sequenceNumber));
2324 for(j = 0; j < dev->nChunksPerBlock; j++)
2326 if(yaffs_CheckChunkBit(dev,i,j))
2328 T(YAFFS_TRACE_ALLOCATE,(TSTR(" %d"),j));
2332 T(YAFFS_TRACE_ALLOCATE,(TSTR(" " TENDSTR)));
2338 static int yaffs_FindBlockForAllocation(yaffs_Device *dev)
2342 yaffs_BlockInfo *bi;
2347 if(j < 0 || j > 100)
2350 yaffs_DumpBlockStats(dev);
2355 if(dev->nErasedBlocks < 1)
2357 // Hoosterman we've got a problem.
2358 // Can't get space to gc
2359 T(YAFFS_TRACE_ERROR, (TSTR("yaffs tragedy: no more eraased blocks" TENDSTR)));
2364 // Find an empty block.
2366 for(i = dev->startBlock; i <= dev->endBlock; i++)
2368 dev->allocationBlockFinder++;
2369 if(dev->allocationBlockFinder < dev->startBlock || dev->allocationBlockFinder> dev->endBlock)
2371 dev->allocationBlockFinder = dev->startBlock;
2374 bi = yaffs_GetBlockInfo(dev,dev->allocationBlockFinder);
2376 if(bi->blockState == YAFFS_BLOCK_STATE_EMPTY)
2378 bi->blockState = YAFFS_BLOCK_STATE_ALLOCATING;
2379 dev->sequenceNumber++;
2380 bi->sequenceNumber = dev->sequenceNumber;
2381 dev->nErasedBlocks--;
2382 T(YAFFS_TRACE_ALLOCATE,(TSTR("Allocated block %d, seq %d" TENDSTR),dev->allocationBlockFinder,dev->sequenceNumber));
2383 return dev->allocationBlockFinder;
2386 T(YAFFS_TRACE_ERROR, (TSTR("yaffs tragedy: no more eraased blocks, but there should have been one" TENDSTR)));
2394 static int yaffs_AllocateChunk(yaffs_Device *dev,int useReserve)
2397 yaffs_BlockInfo *bi;
2399 if(dev->allocationBlock < 0)
2401 // Get next block to allocate off
2402 dev->allocationBlock = yaffs_FindBlockForAllocation(dev);
2403 dev->allocationPage = 0;
2406 if(!useReserve && dev->nErasedBlocks </*=*/ dev->nReservedBlocks)
2408 // Not enough space to allocate unless we're allowed to use the reserve.
2412 if(dev->nErasedBlocks < dev->nReservedBlocks && dev->allocationPage == 0)
2414 T(YAFFS_TRACE_ALLOCATE,(TSTR("Allocating reserve" TENDSTR)));
2418 // Next page please....
2419 if(dev->allocationBlock >= 0)
2421 bi = yaffs_GetBlockInfo(dev,dev->allocationBlock);
2423 retVal = (dev->allocationBlock * dev->nChunksPerBlock) +
2424 dev->allocationPage;
2426 yaffs_SetChunkBit(dev,dev->allocationBlock,dev->allocationPage);
2428 dev->allocationPage++;
2432 // If the block is full set the state to full
2433 if(dev->allocationPage >= dev->nChunksPerBlock)
2435 bi->blockState = YAFFS_BLOCK_STATE_FULL;
2436 dev->allocationBlock = -1;
2443 T(YAFFS_TRACE_ERROR,(TSTR("!!!!!!!!! Allocator out !!!!!!!!!!!!!!!!!" TENDSTR)));
2449 // To determine if we have enough space we just look at the
2450 // number of erased blocks.
2451 // The cache is allowed to use reserved blocks.
2453 static int yaffs_CheckSpaceForChunkCache(yaffs_Device *dev)
2455 return (dev->nErasedBlocks >= dev->nReservedBlocks);
2459 static int yaffs_GetErasedChunks(yaffs_Device *dev)
2463 n = dev->nErasedBlocks * dev->nChunksPerBlock;
2465 if(dev->allocationBlock> 0)
2467 n += (dev->nChunksPerBlock - dev->allocationPage);
2474 int yaffs_GarbageCollectBlock(yaffs_Device *dev,int block)
2480 int retVal = YAFFS_OK;
2484 int chunksBefore = yaffs_GetErasedChunks(dev);
2487 yaffs_ExtendedTags tags;
2489 yaffs_BlockInfo *bi = yaffs_GetBlockInfo(dev,block);
2491 yaffs_Object *object;
2493 bi->blockState = YAFFS_BLOCK_STATE_COLLECTING;
2495 T(YAFFS_TRACE_TRACING,(TSTR("Collecting block %d, in use %d, shrink %d, " TENDSTR),block,bi->pagesInUse,bi->hasShrinkHeader));
2496 //T(("Collecting block %d n %d bits %x\n",block, bi->pagesInUse, bi->pageBits));
2498 bi->hasShrinkHeader = 0; // clear the flag so that the block can erase
2501 if(!yaffs_StillSomeChunkBits(dev,block))
2503 T(YAFFS_TRACE_TRACING,(TSTR("Collecting block %d that has no chunks in use" TENDSTR),block));
2504 yaffs_BlockBecameDirty(dev,block);
2509 __u8 *buffer = yaffs_GetTempBuffer(dev,__LINE__);
2511 for(chunkInBlock = 0,oldChunk = block * dev->nChunksPerBlock;
2512 chunkInBlock < dev->nChunksPerBlock && yaffs_StillSomeChunkBits(dev,block);
2513 chunkInBlock++, oldChunk++ )
2515 if(yaffs_CheckChunkBit(dev,block,chunkInBlock))
2518 // This page is in use and might need to be copied off
2522 //T(("copying page %x from %d to %d\n",mask,oldChunk,newChunk));
2524 yaffs_InitialiseTags(&tags);
2526 yaffs_ReadChunkWithTagsFromNAND(dev,oldChunk,buffer, &tags);
2528 object = yaffs_FindObjectByNumber(dev,tags.objectId);
2530 T(YAFFS_TRACE_GC_DETAIL,(TSTR("Collecting page %d, %d %d %d " TENDSTR),chunkInBlock,tags.objectId,tags.chunkId,tags.byteCount));
2534 T(YAFFS_TRACE_ERROR,(TSTR("page %d in gc has no object " TENDSTR),oldChunk));
2537 if(object && object->deleted && tags.chunkId != 0)
2539 // Data chunk in a deleted file, throw it away
2540 // It's a deleted data chunk,
2541 // No need to copy this, just forget about it and fix up the
2544 //yaffs_PutChunkIntoFile(object, tags.chunkId, 0,0);
2545 object->nDataChunks--;
2547 if(object->nDataChunks <= 0)
2549 // remeber to clean up the object
2550 dev->gcCleanupList[cleanups] = tags.objectId;
2555 else if( 0 /* Todo object && object->deleted && object->nDataChunks == 0 */)
2557 // Deleted object header with no data chunks.
2558 // Can be discarded and the file deleted.
2559 object->chunkId = 0;
2560 yaffs_FreeTnode(object->myDev,object->variant.fileVariant.top);
2561 object->variant.fileVariant.top = NULL;
2562 yaffs_DoGenericObjectDeletion(object);
2567 // It's either a data chunk in a live file or
2568 // an ObjectHeader, so we're interested in it.
2569 // NB Need to keep the ObjectHeaders of deleted files
2570 // until the whole file has been deleted off
2571 tags.serialNumber++;
2575 newChunk = yaffs_WriteNewChunkWithTagsToNAND(dev, buffer, &tags,1);
2579 retVal = YAFFS_FAIL;
2584 // Ok, now fix up the Tnodes etc.
2586 if(tags.chunkId == 0)
2589 object->chunkId = newChunk;
2590 object->serial = tags.serialNumber;
2594 // It's a data chunk
2595 yaffs_PutChunkIntoFile(object, tags.chunkId, newChunk,0);
2600 yaffs_DeleteChunk(dev,oldChunk,markNAND,__LINE__);
2605 yaffs_ReleaseTempBuffer(dev,buffer,__LINE__);
2608 // Do any required cleanups
2609 for(i = 0; i < cleanups; i++)
2611 // Time to delete the file too
2612 object = yaffs_FindObjectByNumber(dev,dev->gcCleanupList[i]);
2615 yaffs_FreeTnode(dev,object->variant.fileVariant.top);
2616 object->variant.fileVariant.top = NULL;
2617 T(YAFFS_TRACE_GC,(TSTR("yaffs: About to finally delete object %d" TENDSTR),object->objectId));
2618 yaffs_DoGenericObjectDeletion(object);
2625 if(chunksBefore >= (chunksAfter = yaffs_GetErasedChunks(dev)))
2627 T(YAFFS_TRACE_GC,(TSTR("gc did not increase free chunks before %d after %d" TENDSTR),chunksBefore,chunksAfter));
2634 static yaffs_Object *yaffs_FindDeletedUnlinkedFile(yaffs_Device *dev)
2636 // find a file to delete
2637 struct list_head *i;
2641 //Scan the unlinked files looking for one to delete
2642 list_for_each(i,&dev->unlinkedDir->variant.directoryVariant.children)
2646 l = list_entry(i, yaffs_Object,siblings);
2657 static void yaffs_DoUnlinkedFileDeletion(yaffs_Device *dev)
2659 // This does background deletion on unlinked files.. only deleted ones.
2660 // If we don't have a file we're working on then find one
2661 if(!dev->unlinkedDeletion && dev->nDeletedFiles > 0)
2663 dev->unlinkedDeletion = yaffs_FindDeletedUnlinkedFile(dev);
2666 // OK, we're working on a file...
2667 if(dev->unlinkedDeletion)
2669 yaffs_Object *obj = dev->unlinkedDeletion;
2671 int limit; // Number of chunks to delete in a file.
2672 // NB this can be exceeded, but not by much.
2676 delresult = yaffs_DeleteWorker(obj, obj->variant.fileVariant.top, obj->variant.fileVariant.topLevel, 0,&limit);
2678 if(obj->nDataChunks == 0)
2680 // Done all the deleting of data chunks.
2681 // Now dump the header and clean up
2682 yaffs_FreeTnode(dev,obj->variant.fileVariant.top);
2683 obj->variant.fileVariant.top = NULL;
2684 yaffs_DoGenericObjectDeletion(obj);
2685 dev->nDeletedFiles--;
2686 dev->nUnlinkedFiles--;
2687 dev->nBackgroundDeletions++;
2688 dev->unlinkedDeletion = NULL;
2696 #define YAFFS_GARBAGE_COLLECT_LOW_WATER 2
2697 static int yaffs_CheckGarbageCollection(yaffs_Device *dev)
2702 //yaffs_DoUnlinkedFileDeletion(dev);
2704 if(dev->nErasedBlocks <= (dev->nReservedBlocks + YAFFS_GARBAGE_COLLECT_LOW_WATER))
2711 block = yaffs_FindBlockForGarbageCollection(dev,aggressive);
2715 dev->garbageCollections++;
2716 return yaffs_GarbageCollectBlock(dev,block);
2728 // New garbage collector
2729 // If we're very low on erased blocks then we do aggressive garbage collection
2730 // otherwise we do "leasurely" garbage collection.
2731 // Aggressive gc looks further (whole array) and will accept dirtier blocks.
2732 // Passive gc only inspects smaller areas and will only accept cleaner blocks.
2734 // The idea is to help clear out space in a more spread-out manner.
2735 // Dunno if it really does anything useful.
2737 int yaffs_CheckGarbageCollection(yaffs_Device *dev)
2741 int gcOk = YAFFS_OK;
2744 //yaffs_DoUnlinkedFileDeletion(dev);
2746 // This loop should pass the first time.
2747 // We'll only see looping here if the erase of the collected block fails.
2751 if(dev->nErasedBlocks <= (dev->nReservedBlocks + 2))
2753 // We need a block soon...
2758 // We're in no hurry
2762 block = yaffs_FindBlockForGarbageCollection(dev,aggressive);
2766 dev->garbageCollections++;
2769 dev->passiveGarbageCollections++;
2772 T(YAFFS_TRACE_GC,(TSTR("yaffs: GC erasedBlocks %d aggressive %d" TENDSTR),dev->nErasedBlocks,aggressive));
2774 gcOk = yaffs_GarbageCollectBlock(dev,block);
2777 if(dev->nErasedBlocks <= (dev->nReservedBlocks + 1))
2779 T(YAFFS_TRACE_GC,(TSTR("yaffs: GC !!!no reclaim!!! erasedBlocks %d after try %d block %d" TENDSTR),dev->nErasedBlocks,maxTries,block));
2781 } while((dev->nErasedBlocks <= (dev->nReservedBlocks + 1)) && (block > 0) && (maxTries < 5));
2783 return aggressive ? gcOk: YAFFS_OK;
2787 //////////////////////////// TAGS ///////////////////////////////////////
2790 void yaffs_InitialiseTags(yaffs_ExtendedTags *tags)
2792 memset(tags,0,sizeof(yaffs_ExtendedTags));
2793 tags->validMarker0 = 0xAAAAAAAA;
2794 tags->validMarker1 = 0x55555555;
2797 static int yaffs_ValidateTags(yaffs_ExtendedTags *tags)
2799 return (tags->validMarker0 == 0xAAAAAAAA && tags->validMarker1 == 0x55555555);
2806 void yaffs_CalcTagsECC(yaffs_Tags *tags)
2810 unsigned char *b = ((yaffs_TagsUnion *)tags)->asBytes;
2817 for(i = 0; i < 8; i++)
2819 for(j = 1; j &0xff; j<<=1)
2834 int yaffs_CheckECCOnTags(yaffs_Tags *tags)
2836 unsigned ecc = tags->ecc;
2838 yaffs_CalcTagsECC(tags);
2842 if(ecc && ecc <= 64)
2844 // TODO: Handle the failure better. Retire?
2845 unsigned char *b = ((yaffs_TagsUnion *)tags)->asBytes;
2849 b[ecc / 8] ^= (1 << (ecc & 7));
2851 // Now recvalc the ecc
2852 yaffs_CalcTagsECC(tags);
2854 return 1; // recovered error
2858 // Wierd ecc failure value
2859 // TODO Need to do somethiong here
2860 return -1; //unrecovered error
2866 static void yaffs_LoadTagsIntoSpare(yaffs_Spare *sparePtr, yaffs_Tags *tagsPtr)
2868 yaffs_TagsUnion *tu = (yaffs_TagsUnion *)tagsPtr;
2870 yaffs_CalcTagsECC(tagsPtr);
2872 sparePtr->tagByte0 = tu->asBytes[0];
2873 sparePtr->tagByte1 = tu->asBytes[1];
2874 sparePtr->tagByte2 = tu->asBytes[2];
2875 sparePtr->tagByte3 = tu->asBytes[3];
2876 sparePtr->tagByte4 = tu->asBytes[4];
2877 sparePtr->tagByte5 = tu->asBytes[5];
2878 sparePtr->tagByte6 = tu->asBytes[6];
2879 sparePtr->tagByte7 = tu->asBytes[7];
2882 static void yaffs_GetTagsFromSpare(yaffs_Device *dev, yaffs_Spare *sparePtr,yaffs_Tags *tagsPtr)
2884 yaffs_TagsUnion *tu = (yaffs_TagsUnion *)tagsPtr;
2887 tu->asBytes[0]= sparePtr->tagByte0;
2888 tu->asBytes[1]= sparePtr->tagByte1;
2889 tu->asBytes[2]= sparePtr->tagByte2;
2890 tu->asBytes[3]= sparePtr->tagByte3;
2891 tu->asBytes[4]= sparePtr->tagByte4;
2892 tu->asBytes[5]= sparePtr->tagByte5;
2893 tu->asBytes[6]= sparePtr->tagByte6;
2894 tu->asBytes[7]= sparePtr->tagByte7;
2896 result = yaffs_CheckECCOnTags(tagsPtr);
2899 dev->tagsEccFixed++;
2903 dev->tagsEccUnfixed++;
2907 static void yaffs_SpareInitialise(yaffs_Spare *spare)
2909 memset(spare,0xFF,sizeof(yaffs_Spare));
2915 static int yaffs_WriteNewChunkWithTagsToNAND(yaffs_Device *dev, const __u8 *buffer, yaffs_ExtendedTags *tags, int useReserve)
2917 // NB There must be tags, data is optional
2918 // If there is data, then an ECC is calculated on it.
2927 //yaffs_SpareInitialise(&spare);
2929 //if(!dev->useNANDECC && buffer)
2931 // yaffs_CalcECC(buffer,&spare);
2934 //yaffs_LoadTagsIntoSpare(&spare,tags);
2936 return yaffs_WriteNewChunkToNAND(dev,buffer,&spare,useReserve);
2941 static int yaffs_TagsMatch(const yaffs_ExtendedTags *tags, int objectId, int chunkInObject)
2943 return ( tags->chunkId == chunkInObject &&
2944 tags->objectId == objectId &&
2945 !tags->chunkDeleted) ? 1 : 0;
2951 int yaffs_FindChunkInFile(yaffs_Object *in,int chunkInInode,yaffs_ExtendedTags *tags)
2953 //Get the Tnode, then get the level 0 offset chunk offset
2956 yaffs_ExtendedTags localTags;
2959 yaffs_Device *dev = in->myDev;
2964 // Passed a NULL, so use our own tags space
2968 tn = yaffs_FindLevel0Tnode(dev,&in->variant.fileVariant, chunkInInode);
2972 theChunk = tn->level0[chunkInInode & YAFFS_TNODES_LEVEL0_MASK] << dev->chunkGroupBits;
2974 retVal = yaffs_FindChunkInGroup(dev,theChunk,tags,in->objectId,chunkInInode);
2979 int yaffs_FindAndDeleteChunkInFile(yaffs_Object *in,int chunkInInode,yaffs_ExtendedTags *tags)
2981 //Get the Tnode, then get the level 0 offset chunk offset
2984 yaffs_ExtendedTags localTags;
2986 yaffs_Device *dev = in->myDev;
2991 // Passed a NULL, so use our own tags space
2995 tn = yaffs_FindLevel0Tnode(dev,&in->variant.fileVariant, chunkInInode);
3000 theChunk = tn->level0[chunkInInode & YAFFS_TNODES_LEVEL0_MASK] << dev->chunkGroupBits;
3002 retVal = yaffs_FindChunkInGroup(dev,theChunk,tags,in->objectId,chunkInInode);
3004 // Delete the entry in the filestructure (if found)
3007 tn->level0[chunkInInode & YAFFS_TNODES_LEVEL0_MASK] = 0;
3012 //T(("No level 0 found for %d\n", chunkInInode));
3017 //T(("Could not find %d to delete\n",chunkInInode));
3023 #ifdef YAFFS_PARANOID
3025 static int yaffs_CheckFileSanity(yaffs_Object *in)
3033 yaffs_Tags localTags;
3034 yaffs_Tags *tags = &localTags;
3039 if(in->variantType != YAFFS_OBJECT_TYPE_FILE)
3041 //T(("Object not a file\n"));
3045 objId = in->objectId;
3046 fSize = in->variant.fileVariant.fileSize;
3047 nChunks = (fSize + in->myDev->nBytesPerChunk -1)/in->myDev->nBytesPerChunk;
3049 for(chunk = 1; chunk <= nChunks; chunk++)
3051 tn = yaffs_FindLevel0Tnode(in->myDev,&in->variant.fileVariant, chunk);
3056 theChunk = tn->level0[chunk & YAFFS_TNODES_LEVEL0_MASK] << in->myDev->chunkGroupBits;
3058 if(yaffs_CheckChunkBits(dev,theChunk/dev->nChunksPerBlock,theChunk%dev->nChunksPerBlock))
3062 yaffs_ReadChunkTagsFromNAND(in->myDev,theChunk,tags,&chunkDeleted);
3063 if(yaffs_TagsMatch(tags,in->objectId,chunk,chunkDeleted))
3071 //T(("File problem file [%d,%d] NAND %d tags[%d,%d]\n",
3072 // objId,chunk,theChunk,tags->chunkId,tags->objectId);
3081 //T(("No level 0 found for %d\n", chunk));
3085 return failed ? YAFFS_FAIL : YAFFS_OK;
3090 static int yaffs_PutChunkIntoFile(yaffs_Object *in,int chunkInInode, int chunkInNAND, int inScan)
3093 yaffs_Device *dev = in->myDev;
3095 yaffs_ExtendedTags existingTags;
3096 yaffs_ExtendedTags newTags;
3097 unsigned existingSerial, newSerial;
3099 tn = yaffs_AddOrFindLevel0Tnode(dev,&in->variant.fileVariant, chunkInInode);
3105 existingChunk = tn->level0[chunkInInode & YAFFS_TNODES_LEVEL0_MASK];
3109 // If we're scanning then we need to test for duplicates
3110 // NB This does not need to be efficient since it should only ever
3111 // happen when the power fails during a write, then only one
3112 // chunk should ever be affected.
3115 if(existingChunk != 0)
3117 // NB Right now existing chunk will not be real chunkId if the device >= 32MB
3118 // thus we have to do a FindChunkInFile to get the real chunk id.
3120 // We have a duplicate now we need to decide which one to use
3121 // To do this we get both sets of tags and compare serial numbers.
3122 yaffs_ReadChunkWithTagsFromNAND(dev,chunkInNAND, NULL,&newTags);
3126 existingChunk = yaffs_FindChunkInFile(in,chunkInInode, &existingTags);
3128 if(existingChunk <=0)
3130 //Hoosterman - how did this happen?
3132 T(YAFFS_TRACE_ERROR, (TSTR("yaffs tragedy: existing chunk < 0 in scan" TENDSTR)));
3137 // NB The deleted flags should be false, otherwise the chunks will
3138 // not be loaded during a scan
3140 newSerial = newTags.serialNumber;
3141 existingSerial = existingTags.serialNumber;
3143 if( in->myDev->isYaffs2 ||
3144 existingChunk <= 0 ||
3145 ((existingSerial+1) & 3) == newSerial)
3148 // Delete the old one and drop through to update the tnode
3149 yaffs_DeleteChunk(dev,existingChunk,1,__LINE__);
3154 // Delete the new one and return early so that the tnode isn't changed
3155 yaffs_DeleteChunk(dev,chunkInNAND,1,__LINE__);
3162 if(existingChunk == 0)
3167 tn->level0[chunkInInode & YAFFS_TNODES_LEVEL0_MASK] = (chunkInNAND >> dev->chunkGroupBits);
3174 int yaffs_ReadChunkDataFromObject(yaffs_Object *in,int chunkInInode, __u8 *buffer)
3176 int chunkInNAND = yaffs_FindChunkInFile(in,chunkInInode,NULL);
3178 if(chunkInNAND >= 0)
3180 return yaffs_ReadChunkWithTagsFromNAND(in->myDev,chunkInNAND,buffer,NULL);
3184 T(YAFFS_TRACE_NANDACCESS,(TSTR("Chunk %d not found zero instead" TENDSTR),chunkInNAND));
3186 memset(buffer,0,in->myDev->nBytesPerChunk); // get sane data if you read a hole
3193 void yaffs_DeleteChunk(yaffs_Device *dev,int chunkId,int markNAND,int lyn)
3197 yaffs_ExtendedTags tags;
3198 yaffs_BlockInfo *bi;
3200 if(chunkId <= 0) return;
3203 block = chunkId / dev->nChunksPerBlock;
3204 page = chunkId % dev->nChunksPerBlock;
3206 bi = yaffs_GetBlockInfo(dev,block);
3208 T(YAFFS_TRACE_DELETION,(TSTR("line %d delete of chunk %d" TENDSTR),lyn,chunkId));
3211 bi->blockState != YAFFS_BLOCK_STATE_COLLECTING &&
3214 // yaffs_SpareInitialise(&spare);
3216 #ifdef CONFIG_MTD_NAND_VERIFY_WRITE
3218 //read data before write, to ensure correct ecc
3219 //if we're using MTD verification under Linux
3220 yaffs_ReadChunkFromNAND(dev,chunkId,NULL,&spare,0);
3223 yaffs_InitialiseTags(&tags);
3225 tags.chunkDeleted = 1;
3228 yaffs_WriteChunkWithTagsToNAND(dev,chunkId,NULL,&tags);
3229 yaffs_HandleUpdateChunk(dev,chunkId,&tags);
3233 dev->nUnmarkedDeletions++;
3237 // Pull out of the management area.
3238 // If the whole block became dirty, this will kick off an erasure.
3239 if( bi->blockState == YAFFS_BLOCK_STATE_ALLOCATING ||
3240 bi->blockState == YAFFS_BLOCK_STATE_FULL ||
3241 bi->blockState == YAFFS_BLOCK_STATE_NEEDS_SCANNING ||
3242 bi->blockState == YAFFS_BLOCK_STATE_COLLECTING)
3246 yaffs_ClearChunkBit(dev,block,page);
3249 if(bi->pagesInUse == 0 &&
3250 !bi->hasShrinkHeader &&
3251 bi->blockState != YAFFS_BLOCK_STATE_ALLOCATING &&
3252 bi->blockState != YAFFS_BLOCK_STATE_NEEDS_SCANNING)
3254 yaffs_BlockBecameDirty(dev,block);
3260 // T(("Bad news deleting chunk %d\n",chunkId));
3268 int yaffs_WriteChunkDataToObject(yaffs_Object *in,int chunkInInode, const __u8 *buffer,int nBytes,int useReserve)
3270 // Find old chunk Need to do this to get serial number
3271 // Write new one and patch into tree.
3272 // Invalidate old tags.
3275 yaffs_ExtendedTags prevTags;
3278 yaffs_ExtendedTags newTags;
3280 yaffs_Device *dev = in->myDev;
3282 yaffs_CheckGarbageCollection(dev);
3284 // Get the previous chunk at this location in the file if it exists
3285 prevChunkId = yaffs_FindChunkInFile(in,chunkInInode,&prevTags);
3288 yaffs_InitialiseTags(&newTags);
3290 newTags.chunkId = chunkInInode;
3291 newTags.objectId = in->objectId;
3292 newTags.serialNumber = (prevChunkId >= 0) ? prevTags.serialNumber + 1 : 1;
3293 newTags.byteCount = nBytes;
3295 // yaffs_CalcTagsECC(&newTags);
3297 newChunkId = yaffs_WriteNewChunkWithTagsToNAND(dev,buffer,&newTags,useReserve);
3301 yaffs_PutChunkIntoFile(in,chunkInInode,newChunkId,0);
3304 if(prevChunkId >= 0)
3306 yaffs_DeleteChunk(dev,prevChunkId,1,__LINE__);
3310 yaffs_CheckFileSanity(in);
3321 // UpdateObjectHeader updates the header on NAND for an object.
3322 // If name is not NULL, then that new name is used.
3324 int yaffs_UpdateObjectHeader(yaffs_Object *in,const YCHAR *name, int force,int isShrink)
3327 yaffs_BlockInfo *bi;
3329 yaffs_Device *dev = in->myDev;
3335 yaffs_ExtendedTags newTags;
3337 __u8 *buffer = NULL;
3338 YCHAR oldName[YAFFS_MAX_NAME_LENGTH+1];
3340 // __u8 bufferOld[YAFFS_BYTES_PER_CHUNK];
3342 yaffs_ObjectHeader *oh = NULL;
3343 // yaffs_ObjectHeader *ohOld = (yaffs_ObjectHeader *)bufferOld;
3346 if(!in->fake || force)
3349 yaffs_CheckGarbageCollection(dev);
3351 buffer = yaffs_GetTempBuffer(in->myDev,__LINE__);
3352 oh = (yaffs_ObjectHeader *)buffer;
3354 prevChunkId = in->chunkId;
3356 if(prevChunkId >= 0)
3358 yaffs_ReadChunkWithTagsFromNAND(dev,prevChunkId,buffer,NULL);
3359 memcpy(oldName,oh->name,sizeof(oh->name));
3362 memset(buffer,0xFF,dev->nBytesPerChunk);
3365 oh->type = in->variantType;
3367 oh->st_mode = in->st_mode;
3369 #ifdef CONFIG_YAFFS_WINCE
3370 oh->win_atime[0] = in->win_atime[0];
3371 oh->win_ctime[0] = in->win_ctime[0];
3372 oh->win_mtime[0] = in->win_mtime[0];
3373 oh->win_atime[1] = in->win_atime[1];
3374 oh->win_ctime[1] = in->win_ctime[1];
3375 oh->win_mtime[1] = in->win_mtime[1];
3377 oh->st_uid = in->st_uid;
3378 oh->st_gid = in->st_gid;
3379 oh->st_atime = in->st_atime;
3380 oh->st_mtime = in->st_mtime;
3381 oh->st_ctime = in->st_ctime;
3382 oh->st_rdev = in->st_rdev;
3386 oh->parentObjectId = in->parent->objectId;
3390 oh->parentObjectId = 0;
3393 //oh->sum = in->sum;
3396 memset(oh->name,0,sizeof(oh->name));
3397 yaffs_strncpy(oh->name,name,YAFFS_MAX_NAME_LENGTH);
3399 else if(prevChunkId)
3401 memcpy(oh->name, oldName,sizeof(oh->name));
3405 memset(oh->name,0,sizeof(oh->name));
3408 oh->isShrink = isShrink;
3410 switch(in->variantType)
3412 case YAFFS_OBJECT_TYPE_UNKNOWN:
3413 // Should not happen
3415 case YAFFS_OBJECT_TYPE_FILE:
3416 oh->fileSize = in->variant.fileVariant.fileSize;
3418 case YAFFS_OBJECT_TYPE_HARDLINK:
3419 oh->equivalentObjectId = in->variant.hardLinkVariant.equivalentObjectId;
3421 case YAFFS_OBJECT_TYPE_SPECIAL:
3424 case YAFFS_OBJECT_TYPE_DIRECTORY:
3427 case YAFFS_OBJECT_TYPE_SYMLINK:
3428 yaffs_strncpy(oh->alias,in->variant.symLinkVariant.alias,YAFFS_MAX_ALIAS_LENGTH);
3429 oh->alias[YAFFS_MAX_ALIAS_LENGTH] = 0;
3434 yaffs_InitialiseTags(&newTags);
3436 newTags.chunkId = 0;
3437 newTags.objectId = in->objectId;
3438 newTags.serialNumber = in->serial;
3441 // Create new chunk in NAND
3442 newChunkId = yaffs_WriteNewChunkWithTagsToNAND(dev,buffer,&newTags, (prevChunkId >= 0) ? 1 : 0 );
3447 in->chunkId = newChunkId;
3449 if(prevChunkId >= 0)
3451 yaffs_DeleteChunk(dev,prevChunkId,1,__LINE__);
3456 // If this was a shrink, then&n