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.10 2005-07-26 03:05:28 charles Exp $";
21 #include "yaffsinterface.h"
22 #include "yaffs_guts.h"
23 #include "yaffs_tagsvalidity.h"
26 #include "yaffs_tagscompat.h"
28 #ifdef CONFIG_YAFFS_WINCE
29 void yfsd_LockYAFFS(BOOL fsLockOnly);
30 void yfsd_UnlockYAFFS(BOOL fsLockOnly);
33 #define YAFFS_PASSIVE_GC_CHUNKS 2
36 // Use Steven Hill's ECC struff instead
37 // External functions for ECC on data
38 void nand_calculate_ecc (const u_char *dat, u_char *ecc_code);
39 int nand_correct_data (u_char *dat, u_char *read_ecc, u_char *calc_ecc);
40 #define yaffs_ECCCalculate(data,ecc) nand_calculate_ecc(data,ecc)
41 #define yaffs_ECCCorrect(data,read_ecc,calc_ecc) nand_correct_ecc(data,read_ecc,calc_ecc)
43 #include "yaffs_ecc.h"
47 // countBits is a quick way of counting the number of bits in a byte.
48 // ie. countBits[n] holds the number of 1 bits in a byte with the value n.
50 static const char yaffs_countBitsTable[256] =
52 0,1,1,2,1,2,2,3,1,2,2,3,2,3,3,4,
53 1,2,2,3,2,3,3,4,2,3,3,4,3,4,4,5,
54 1,2,2,3,2,3,3,4,2,3,3,4,3,4,4,5,
55 2,3,3,4,3,4,4,5,3,4,4,5,4,5,5,6,
56 1,2,2,3,2,3,3,4,2,3,3,4,3,4,4,5,
57 2,3,3,4,3,4,4,5,3,4,4,5,4,5,5,6,
58 2,3,3,4,3,4,4,5,3,4,4,5,4,5,5,6,
59 3,4,4,5,4,5,5,6,4,5,5,6,5,6,6,7,
60 1,2,2,3,2,3,3,4,2,3,3,4,3,4,4,5,
61 2,3,3,4,3,4,4,5,3,4,4,5,4,5,5,6,
62 2,3,3,4,3,4,4,5,3,4,4,5,4,5,5,6,
63 3,4,4,5,4,5,5,6,4,5,5,6,5,6,6,7,
64 2,3,3,4,3,4,4,5,3,4,4,5,4,5,5,6,
65 3,4,4,5,4,5,5,6,4,5,5,6,5,6,6,7,
66 3,4,4,5,4,5,5,6,4,5,5,6,5,6,6,7,
67 4,5,5,6,5,6,6,7,5,6,6,7,6,7,7,8
70 static int yaffs_CountBits(__u8 x)
73 retVal = yaffs_countBitsTable[x];
81 // Stuff using yea olde tags
82 static void yaffs_LoadTagsIntoSpare(yaffs_Spare *sparePtr, yaffs_Tags *tagsPtr);
83 static void yaffs_GetTagsFromSpare(yaffs_Device *dev, yaffs_Spare *sparePtr,yaffs_Tags *tagsPtr);
85 static int yaffs_ReadChunkTagsFromNAND(yaffs_Device *dev,int chunkInNAND, yaffs_Tags *tags, int *chunkDeleted);
86 static int yaffs_TagsMatch(const yaffs_Tags *tags, int objectId, int chunkInObject, int chunkDeleted);
93 static Y_INLINE int yaffs_ReadChunkWithTagsFromNAND(yaffs_Device *dev,int chunkInNAND, __u8 *buffer, yaffs_ExtendedTags *tags);
94 static Y_INLINE int yaffs_WriteChunkWithTagsToNAND(yaffs_Device *dev,int chunkInNAND, const __u8 *data, yaffs_ExtendedTags *tags);
95 static Y_INLINE int yaffs_MarkBlockBad(yaffs_Device *dev, int blockNo);
96 static Y_INLINE int yaffs_QueryInitialBlockState(yaffs_Device *dev,int blockNo, yaffs_BlockState *state,unsigned *sequenceNumber);
98 static int yaffs_WriteNewChunkWithTagsToNAND(yaffs_Device *dev, const __u8 *buffer, yaffs_ExtendedTags *tags, int useReserve);
100 static int yaffs_CheckObjectHashSanity(yaffs_Device *dev);
102 static int yaffs_PutChunkIntoFile(yaffs_Object *in,int chunkInInode, int chunkInNAND, int inScan);
104 static yaffs_Object *yaffs_CreateNewObject(yaffs_Device *dev,int number,yaffs_ObjectType type);
105 static void yaffs_AddObjectToDirectory(yaffs_Object *directory, yaffs_Object *obj);
106 static int yaffs_UpdateObjectHeader(yaffs_Object *in,const YCHAR *name, int force,int isShrink);
107 static void yaffs_RemoveObjectFromDirectory(yaffs_Object *obj);
108 static int yaffs_CheckStructures(void);
109 static int yaffs_DeleteWorker(yaffs_Object *in, yaffs_Tnode *tn, __u32 level, int chunkOffset,int *limit);
110 static int yaffs_DoGenericObjectDeletion(yaffs_Object *in);
112 static yaffs_BlockInfo *yaffs_GetBlockInfo(yaffs_Device *dev,int blockNo);
114 static __u8 *yaffs_GetTempBuffer(yaffs_Device *dev,int lineNo);
115 static void yaffs_ReleaseTempBuffer(yaffs_Device *dev, __u8 *buffer, int lineNo);
118 // Robustification (if it ever comes about...)
119 static void yaffs_RetireBlock(yaffs_Device *dev,int blockInNAND);
121 static void yaffs_HandleReadDataError(yaffs_Device *dev,int chunkInNAND);
123 static void yaffs_HandleWriteChunkError(yaffs_Device *dev,int chunkInNAND);
124 static void yaffs_HandleWriteChunkOk(yaffs_Device *dev,int chunkInNAND,const __u8 *data, const yaffs_ExtendedTags *tags);
125 static void yaffs_HandleUpdateChunk(yaffs_Device *dev,int chunkInNAND, const yaffs_ExtendedTags *tags);
127 static int yaffs_CheckChunkErased(struct yaffs_DeviceStruct *dev,int chunkInNAND);
129 static int yaffs_UnlinkWorker(yaffs_Object *obj);
130 static void yaffs_DestroyObject(yaffs_Object *obj);
133 static int yaffs_VerifyCompare(const __u8 *d0, const __u8 * d1, const yaffs_Spare *s0, const yaffs_Spare *s1,int dataSize);
136 static int yaffs_TagsMatch(const yaffs_ExtendedTags *tags, int objectId, int chunkInObject);
139 loff_t yaffs_GetFileSize(yaffs_Object *obj);
142 static int yaffs_AllocateChunk(yaffs_Device *dev,int useReserve);
144 static void yaffs_VerifyFreeChunks(yaffs_Device *dev);
146 #ifdef YAFFS_PARANOID
147 static int yaffs_CheckFileSanity(yaffs_Object *in);
149 #define yaffs_CheckFileSanity(in)
152 static void yaffs_InvalidateWholeChunkCache(yaffs_Object *in);
153 static void yaffs_InvalidateChunkCache(yaffs_Object *object, int chunkId);
155 static int yaffs_ReadChunkWithTagsFromNAND(yaffs_Device *dev,int chunkInNAND, __u8 *buffer, yaffs_ExtendedTags *tags)
157 chunkInNAND -= dev->chunkOffset;
159 if(dev->readChunkWithTagsFromNAND)
160 return dev->readChunkWithTagsFromNAND(dev,chunkInNAND,buffer,tags);
162 return yaffs_TagsCompatabilityReadChunkWithTagsFromNAND(dev,chunkInNAND,buffer,tags);
165 static Y_INLINE int yaffs_WriteChunkWithTagsToNAND(yaffs_Device *dev,int chunkInNAND, const __u8 *buffer, yaffs_ExtendedTags *tags)
167 chunkInNAND -= dev->chunkOffset;
171 tags->sequenceNumber = dev->sequenceNumber;
173 if(!yaffs_ValidateTags(tags))
175 T(YAFFS_TRACE_ERROR,(TSTR("Writing uninitialised tags" TENDSTR)));
178 T(YAFFS_TRACE_WRITE,(TSTR("Writing chunk %d tags %d %d"TENDSTR),chunkInNAND,tags->objectId,tags->chunkId));
182 T(YAFFS_TRACE_ERROR,(TSTR("Writing with no tags" TENDSTR)));
186 if(dev->writeChunkWithTagsToNAND)
187 return dev->writeChunkWithTagsToNAND(dev,chunkInNAND,buffer,tags);
189 return yaffs_TagsCompatabilityWriteChunkWithTagsToNAND(dev,chunkInNAND,buffer,tags);
192 static Y_INLINE int yaffs_MarkBlockBad(yaffs_Device *dev, int blockNo)
194 blockNo -= dev->blockOffset;
196 if(dev->markNANDBlockBad)
197 return dev->markNANDBlockBad(dev,blockNo);
199 return yaffs_TagsCompatabilityMarkNANDBlockBad(dev,blockNo);
201 static Y_INLINE int yaffs_QueryInitialBlockState(yaffs_Device *dev,int blockNo, yaffs_BlockState *state, unsigned *sequenceNumber)
203 blockNo -= dev->blockOffset;
205 if(dev->queryNANDBlock)
206 return dev->queryNANDBlock(dev,blockNo,state,sequenceNumber);
208 return yaffs_TagsCompatabilityQueryNANDBlock(dev,blockNo,state,sequenceNumber);
211 int yaffs_EraseBlockInNAND(struct yaffs_DeviceStruct *dev,int blockInNAND)
215 blockInNAND -= dev->blockOffset;
217 dev->nBlockErasures++;
218 result = dev->eraseBlockInNAND(dev,blockInNAND);
220 if(!result)result = dev->eraseBlockInNAND(dev,blockInNAND); // If at first we don't succeed, try again *once*.
224 static int yaffs_InitialiseNAND(struct yaffs_DeviceStruct *dev)
226 return dev->initialiseNAND(dev);
232 // Temporary buffer manipulations
234 static __u8 *yaffs_GetTempBuffer(yaffs_Device *dev,int lineNo)
237 for(i = 0; i < YAFFS_N_TEMP_BUFFERS; i++)
239 if(dev->tempBuffer[i].line == 0)
241 dev->tempBuffer[i].line = lineNo;
242 if((i+1) > dev->maxTemp)
244 dev->maxTemp = i + 1;
245 for(j = 0; j <= i; j++)
246 dev->tempBuffer[j].maxLine = dev->tempBuffer[j].line;
249 return dev->tempBuffer[i].buffer;
253 T(YAFFS_TRACE_BUFFERS,(TSTR("Out of temp buffers at line %d, other held by lines:"),lineNo));
254 for(i = 0; i < YAFFS_N_TEMP_BUFFERS; i++)
256 T(YAFFS_TRACE_BUFFERS,(TSTR(" %d "),dev->tempBuffer[i].line));
258 T(YAFFS_TRACE_BUFFERS,(TSTR(" "TENDSTR)));
260 dev->unmanagedTempAllocations++;
261 // Get an unmanaged one
262 return YMALLOC(dev->nBytesPerChunk);
267 static void yaffs_ReleaseTempBuffer(yaffs_Device *dev, __u8 *buffer, int lineNo)
270 for(i = 0; i < YAFFS_N_TEMP_BUFFERS; i++)
272 if(dev->tempBuffer[i].buffer == buffer)
274 dev->tempBuffer[i].line = 0;
281 // assume it is an unmanaged one.
282 T(YAFFS_TRACE_BUFFERS,(TSTR("Releasing unmanaged temp buffer in line %d" TENDSTR),lineNo));
284 dev->unmanagedTempDeallocations++;
290 // Chunk bitmap manipulations
292 static Y_INLINE __u8 *yaffs_BlockBits(yaffs_Device *dev, int blk)
294 if(blk < dev->internalStartBlock || blk > dev->internalEndBlock)
296 T(YAFFS_TRACE_ERROR,(TSTR("**>> yaffs: BlockBits block %d is not valid" TENDSTR),blk));
299 return dev->chunkBits + (dev->chunkBitmapStride * (blk - dev->internalStartBlock));
302 static Y_INLINE void yaffs_ClearChunkBits(yaffs_Device *dev,int blk)
304 __u8 *blkBits = yaffs_BlockBits(dev,blk);
306 memset(blkBits,0,dev->chunkBitmapStride);
309 static Y_INLINE void yaffs_ClearChunkBit(yaffs_Device *dev,int blk,int chunk)
311 __u8 *blkBits = yaffs_BlockBits(dev,blk);
313 blkBits[chunk/8] &= ~ (1<<(chunk & 7));
316 static Y_INLINE void yaffs_SetChunkBit(yaffs_Device *dev,int blk,int chunk)
318 __u8 *blkBits = yaffs_BlockBits(dev,blk);
320 blkBits[chunk/8] |= (1<<(chunk & 7));
323 static Y_INLINE int yaffs_CheckChunkBit(yaffs_Device *dev,int blk,int chunk)
325 __u8 *blkBits = yaffs_BlockBits(dev,blk);
326 return (blkBits[chunk/8] & (1<<(chunk & 7))) ? 1 :0;
329 static Y_INLINE int yaffs_StillSomeChunkBits(yaffs_Device *dev,int blk)
331 __u8 *blkBits = yaffs_BlockBits(dev,blk);
333 for(i = 0; i < dev->chunkBitmapStride; i++)
335 if(*blkBits) return 1;
342 static Y_INLINE int yaffs_HashFunction(int n)
344 return (n % YAFFS_NOBJECT_BUCKETS);
348 yaffs_Object *yaffs_Root(yaffs_Device *dev)
353 yaffs_Object *yaffs_LostNFound(yaffs_Device *dev)
355 return dev->lostNFoundDir;
361 int yaffs_CheckFF(__u8 *buffer,int nBytes)
363 //Horrible, slow implementation
366 if(*buffer != 0xFF) return 0;
372 static int yaffs_CheckChunkErased(struct yaffs_DeviceStruct *dev,int chunkInNAND)
375 int retval = YAFFS_OK;
376 __u8 *data = yaffs_GetTempBuffer(dev,__LINE__);
377 yaffs_ExtendedTags tags;
379 // NCB dev->readChunkWithTagsFromNAND(dev,chunkInNAND,data,&tags);
380 yaffs_ReadChunkWithTagsFromNAND(dev,chunkInNAND,data,&tags);
382 if(!yaffs_CheckFF(data,dev->nBytesPerChunk) || tags.chunkUsed)
384 T(YAFFS_TRACE_NANDACCESS,(TSTR("Chunk %d not erased" TENDSTR),chunkInNAND));
388 yaffs_ReleaseTempBuffer(dev,data,__LINE__);
397 static int yaffs_WriteNewChunkWithTagsToNAND(struct yaffs_DeviceStruct *dev, const __u8 *data, yaffs_ExtendedTags *tags,int useReserve)
407 chunk = yaffs_AllocateChunk(dev,useReserve);
412 // First check this chunk is erased...
413 #ifndef CONFIG_YAFFS_DISABLE_CHUNK_ERASED_CHECK
414 writeOk = yaffs_CheckChunkErased(dev,chunk);
418 T(YAFFS_TRACE_ERROR,(TSTR("**>> yaffs chunk %d was not erased" TENDSTR),chunk));
422 writeOk = yaffs_WriteChunkWithTagsToNAND(dev,chunk,data,tags);
428 // Copy the data into the robustification buffer.
429 // NB We do this at the end to prevent duplicates in the case of a write error.
431 yaffs_HandleWriteChunkOk(dev,chunk,data,tags);
435 yaffs_HandleWriteChunkError(dev,chunk);
439 } while(chunk >= 0 && ! writeOk);
443 T(YAFFS_TRACE_ERROR,(TSTR("**>> yaffs write required %d attempts" TENDSTR),attempts));
444 dev->nRetriedWrites+= (attempts - 1);
455 // Functions for robustisizing
459 static void yaffs_RetireBlock(yaffs_Device *dev,int blockInNAND)
462 yaffs_MarkBlockBad(dev,blockInNAND);
464 yaffs_GetBlockInfo(dev,blockInNAND)->blockState = YAFFS_BLOCK_STATE_DEAD;
466 dev->nRetiredBlocks++;
471 static int yaffs_RewriteBufferedBlock(yaffs_Device *dev)
473 dev->doingBufferedBlockRewrite = 1;
475 // Remove erased chunks
476 // Rewrite existing chunks to a new block
477 // Set current write block to the new block
479 dev->doingBufferedBlockRewrite = 0;
485 static void yaffs_HandleReadDataError(yaffs_Device *dev,int chunkInNAND)
487 int blockInNAND = chunkInNAND/dev->nChunksPerBlock;
489 // Mark the block for retirement
490 yaffs_GetBlockInfo(dev,blockInNAND)->needsRetiring = 1;
491 T(YAFFS_TRACE_ERROR | YAFFS_TRACE_BAD_BLOCKS,(TSTR("**>>Block %d marked for retirement" TENDSTR),blockInNAND));
495 // Just do a garbage collection on the affected block then retire the block
500 static void yaffs_CheckWrittenBlock(yaffs_Device *dev,int chunkInNAND)
506 static void yaffs_HandleWriteChunkOk(yaffs_Device *dev,int chunkInNAND,const __u8 *data, const yaffs_ExtendedTags *tags)
510 static void yaffs_HandleUpdateChunk(yaffs_Device *dev,int chunkInNAND, const yaffs_ExtendedTags *tags)
514 static void yaffs_HandleWriteChunkError(yaffs_Device *dev,int chunkInNAND)
516 int blockInNAND = chunkInNAND/dev->nChunksPerBlock;
518 // Mark the block for retirement
519 yaffs_GetBlockInfo(dev,blockInNAND)->needsRetiring = 1;
521 yaffs_DeleteChunk(dev,chunkInNAND,1,__LINE__);
527 static int yaffs_VerifyCompare(const __u8 *d0, const __u8 * d1, const yaffs_Spare *s0, const yaffs_Spare *s1,int dataSize)
531 if( memcmp(d0,d1,dataSize) != 0 ||
532 s0->tagByte0 != s1->tagByte0 ||
533 s0->tagByte1 != s1->tagByte1 ||
534 s0->tagByte2 != s1->tagByte2 ||
535 s0->tagByte3 != s1->tagByte3 ||
536 s0->tagByte4 != s1->tagByte4 ||
537 s0->tagByte5 != s1->tagByte5 ||
538 s0->tagByte6 != s1->tagByte6 ||
539 s0->tagByte7 != s1->tagByte7 ||
540 s0->ecc1[0] != s1->ecc1[0] ||
541 s0->ecc1[1] != s1->ecc1[1] ||
542 s0->ecc1[2] != s1->ecc1[2] ||
543 s0->ecc2[0] != s1->ecc2[0] ||
544 s0->ecc2[1] != s1->ecc2[1] ||
545 s0->ecc2[2] != s1->ecc2[2] )
555 ///////////////////////// Object management //////////////////
556 // List of spare objects
557 // The list is hooked together using the first pointer
560 // static yaffs_Object *yaffs_freeObjects = NULL;
562 // static int yaffs_nFreeObjects;
564 // static yaffs_ObjectList *yaffs_allocatedObjectList = NULL;
566 // static yaffs_ObjectBucket yaffs_objectBucket[YAFFS_NOBJECT_BUCKETS];
569 static __u16 yaffs_CalcNameSum(const YCHAR *name)
574 YUCHAR *bname = (YUCHAR *)name;
577 while ((*bname) && (i <=YAFFS_MAX_NAME_LENGTH))
580 #ifdef CONFIG_YAFFS_CASE_INSENSITIVE
581 sum += yaffs_toupper(*bname) * i;
592 void yaffs_SetObjectName(yaffs_Object *obj, const YCHAR *name)
594 #ifdef CONFIG_YAFFS_SHORT_NAMES_IN_RAM
595 if(name && yaffs_strlen(name) <= YAFFS_SHORT_NAME_LENGTH)
597 yaffs_strcpy(obj->shortName,name);
601 obj->shortName[0]=_Y('\0');
604 obj->sum = yaffs_CalcNameSum(name);
608 void yaffs_CalcECC(const __u8 *data, yaffs_Spare *spare)
610 yaffs_ECCCalculate(data , spare->ecc1);
611 yaffs_ECCCalculate(&data[256] , spare->ecc2);
616 ///////////////////////// TNODES ///////////////////////
618 // List of spare tnodes
619 // The list is hooked together using the first pointer
622 //static yaffs_Tnode *yaffs_freeTnodes = NULL;
624 // static int yaffs_nFreeTnodes;
626 //static yaffs_TnodeList *yaffs_allocatedTnodeList = NULL;
630 // yaffs_CreateTnodes creates a bunch more tnodes and
631 // adds them to the tnode free list.
632 // Don't use this function directly
634 static int yaffs_CreateTnodes(yaffs_Device *dev,int nTnodes)
637 yaffs_Tnode *newTnodes;
638 yaffs_TnodeList *tnl;
640 if(nTnodes < 1) return YAFFS_OK;
644 newTnodes = YMALLOC(nTnodes * sizeof(yaffs_Tnode));
648 T(YAFFS_TRACE_ERROR,(TSTR("yaffs: Could not allocate Tnodes"TENDSTR)));
652 // Hook them into the free list
653 for(i = 0; i < nTnodes - 1; i++)
655 newTnodes[i].internal[0] = &newTnodes[i+1];
656 #ifdef CONFIG_YAFFS_TNODE_LIST_DEBUG
657 newTnodes[i].internal[YAFFS_NTNODES_INTERNAL] = 1;
661 newTnodes[nTnodes - 1].internal[0] = dev->freeTnodes;
662 #ifdef CONFIG_YAFFS_TNODE_LIST_DEBUG
663 newTnodes[nTnodes - 1].internal[YAFFS_NTNODES_INTERNAL] = 1;
665 dev->freeTnodes = newTnodes;
666 dev->nFreeTnodes+= nTnodes;
667 dev->nTnodesCreated += nTnodes;
669 // Now add this bunch of tnodes to a list for freeing up.
670 // NB If we can't add this to the management list it isn't fatal
671 // but it just means we can't free this bunch of tnodes later.
672 tnl = YMALLOC(sizeof(yaffs_TnodeList));
675 T(YAFFS_TRACE_ERROR,(TSTR("yaffs: Could not add tnodes to management list" TENDSTR)));
680 tnl->tnodes = newTnodes;
681 tnl->next = dev->allocatedTnodeList;
682 dev->allocatedTnodeList = tnl;
686 T(YAFFS_TRACE_ALLOCATE,(TSTR("yaffs: Tnodes added" TENDSTR)));
693 // GetTnode gets us a clean tnode. Tries to make allocate more if we run out
694 static yaffs_Tnode *yaffs_GetTnode(yaffs_Device *dev)
696 yaffs_Tnode *tn = NULL;
698 // If there are none left make more
701 yaffs_CreateTnodes(dev,YAFFS_ALLOCATION_NTNODES);
706 tn = dev->freeTnodes;
707 #ifdef CONFIG_YAFFS_TNODE_LIST_DEBUG
708 if(tn->internal[YAFFS_NTNODES_INTERNAL] != 1)
710 // Hoosterman, this thing looks like it isn't in the list
711 T(YAFFS_TRACE_ALWAYS,(TSTR("yaffs: Tnode list bug 1" TENDSTR)));
714 dev->freeTnodes = dev->freeTnodes->internal[0];
717 memset(tn,0,sizeof(yaffs_Tnode));
725 // FreeTnode frees up a tnode and puts it back on the free list
726 static void yaffs_FreeTnode(yaffs_Device*dev, yaffs_Tnode *tn)
730 #ifdef CONFIG_YAFFS_TNODE_LIST_DEBUG
731 if(tn->internal[YAFFS_NTNODES_INTERNAL] != 0)
733 // Hoosterman, this thing looks like it is already in the list
734 T(YAFFS_TRACE_ALWAYS,(TSTR("yaffs: Tnode list bug 2" TENDSTR)));
736 tn->internal[YAFFS_NTNODES_INTERNAL] = 1;
738 tn->internal[0] = dev->freeTnodes;
739 dev->freeTnodes = tn;
745 static void yaffs_DeinitialiseTnodes(yaffs_Device*dev)
747 // Free the list of allocated tnodes
748 yaffs_TnodeList *tmp;
750 while(dev->allocatedTnodeList)
752 tmp = dev->allocatedTnodeList->next;
754 YFREE(dev->allocatedTnodeList->tnodes);
755 YFREE(dev->allocatedTnodeList);
756 dev->allocatedTnodeList = tmp;
760 dev->freeTnodes = NULL;
761 dev->nFreeTnodes = 0;
764 static void yaffs_InitialiseTnodes(yaffs_Device*dev)
766 dev->allocatedTnodeList = NULL;
767 dev->freeTnodes = NULL;
768 dev->nFreeTnodes = 0;
769 dev->nTnodesCreated = 0;
774 void yaffs_TnodeTest(yaffs_Device *dev)
779 yaffs_Tnode *tn[1000];
781 YINFO("Testing TNodes");
783 for(j = 0; j < 50; j++)
785 for(i = 0; i < 1000; i++)
787 tn[i] = yaffs_GetTnode(dev);
790 YALERT("Getting tnode failed");
793 for(i = 0; i < 1000; i+=3)
795 yaffs_FreeTnode(dev,tn[i]);
804 ////////////////// END OF TNODE MANIPULATION ///////////////////////////
806 /////////////// Functions to manipulate the look-up tree (made up of tnodes)
807 // The look up tree is represented by the top tnode and the number of topLevel
808 // in the tree. 0 means only the level 0 tnode is in the tree.
811 // FindLevel0Tnode finds the level 0 tnode, if one exists.
812 // Used when reading.....
813 static yaffs_Tnode *yaffs_FindLevel0Tnode(yaffs_Device *dev,yaffs_FileStructure *fStruct, __u32 chunkId)
816 yaffs_Tnode *tn = fStruct->top;
818 int requiredTallness;
819 int level = fStruct->topLevel;
821 // Check sane level and chunk Id
822 if(level < 0 || level > YAFFS_TNODES_MAX_LEVEL)
825 // sprintf(str,"Bad level %d",level);
830 if(chunkId > YAFFS_MAX_CHUNK_ID)
833 // sprintf(str,"Bad chunkId %d",chunkId);
838 // First check we're tall enough (ie enough topLevel)
840 i = chunkId >> (/*dev->chunkGroupBits + */YAFFS_TNODES_LEVEL0_BITS);
841 requiredTallness = 0;
844 i >>= YAFFS_TNODES_INTERNAL_BITS;
849 if(requiredTallness > fStruct->topLevel)
851 // Not tall enough, so we can't find it, return NULL.
856 // Traverse down to level 0
857 while (level > 0 && tn)
859 tn = tn->internal[(chunkId >>(/* dev->chunkGroupBits + */ YAFFS_TNODES_LEVEL0_BITS + (level-1) * YAFFS_TNODES_INTERNAL_BITS)) &
860 YAFFS_TNODES_INTERNAL_MASK];
868 // AddOrFindLevel0Tnode finds the level 0 tnode if it exists, otherwise first expands the tree.
869 // This happens in two steps:
870 // 1. If the tree isn't tall enough, then make it taller.
871 // 2. Scan down the tree towards the level 0 tnode adding tnodes if required.
873 // Used when modifying the tree.
875 static yaffs_Tnode *yaffs_AddOrFindLevel0Tnode(yaffs_Device *dev, yaffs_FileStructure *fStruct, __u32 chunkId)
880 int requiredTallness;
887 //T((TSTR("AddOrFind topLevel=%d, chunk=%d"),fStruct->topLevel,chunkId));
889 // Check sane level and page Id
890 if(fStruct->topLevel < 0 || fStruct->topLevel > YAFFS_TNODES_MAX_LEVEL)
893 // sprintf(str,"Bad level %d",fStruct->topLevel);
898 if(chunkId > YAFFS_MAX_CHUNK_ID)
901 // sprintf(str,"Bad chunkId %d",chunkId);
906 // First check we're tall enough (ie enough topLevel)
908 x = chunkId >> (/*dev->chunkGroupBits + */YAFFS_TNODES_LEVEL0_BITS);
909 requiredTallness = 0;
912 x >>= YAFFS_TNODES_INTERNAL_BITS;
916 //T((TSTR(" required=%d"),requiredTallness));
919 if(requiredTallness > fStruct->topLevel)
921 // Not tall enough,gotta make the tree taller
922 for(i = fStruct->topLevel; i < requiredTallness; i++)
924 //T((TSTR(" add new top")));
926 tn = yaffs_GetTnode(dev);
930 tn->internal[0] = fStruct->top;
935 T(YAFFS_TRACE_ERROR,(TSTR("yaffs: no more tnodes" TENDSTR)));
939 fStruct->topLevel = requiredTallness;
943 // Traverse down to level 0, adding anything we need
945 l = fStruct->topLevel;
949 x = (chunkId >> (/*dev->chunkGroupBits + */YAFFS_TNODES_LEVEL0_BITS + (l-1) * YAFFS_TNODES_INTERNAL_BITS)) &
950 YAFFS_TNODES_INTERNAL_MASK;
952 //T((TSTR(" [%d:%d]"),l,i));
956 //T((TSTR(" added")));
958 tn->internal[x] = yaffs_GetTnode(dev);
961 tn = tn->internal[x];
972 int yaffs_FindChunkInGroup(yaffs_Device *dev, int theChunk, yaffs_ExtendedTags *tags, int objectId, int chunkInInode)
977 for(j = 0; theChunk && j < dev->chunkGroupSize; j++)
979 if(yaffs_CheckChunkBit(dev,theChunk / dev->nChunksPerBlock,theChunk % dev->nChunksPerBlock))
981 yaffs_ReadChunkWithTagsFromNAND(dev,theChunk,NULL,tags);
982 if(yaffs_TagsMatch(tags,objectId,chunkInInode))
994 // DeleteWorker scans backwards through the tnode tree and deletes all the
995 // chunks and tnodes in the file
996 // Returns 1 if the tree was deleted. Returns 0 if it stopped early due to hitting the limit and the delete is incomplete.
998 static int yaffs_DeleteWorker(yaffs_Object *in, yaffs_Tnode *tn, __u32 level, int chunkOffset,int *limit)
1003 yaffs_ExtendedTags tags;
1005 yaffs_Device *dev = in->myDev;
1015 for(i = YAFFS_NTNODES_INTERNAL -1; allDone && i >= 0; i--)
1019 if(limit && (*limit) < 0)
1025 allDone = yaffs_DeleteWorker(in,tn->internal[i],level - 1,
1026 (chunkOffset << YAFFS_TNODES_INTERNAL_BITS ) + i ,limit);
1030 yaffs_FreeTnode(dev,tn->internal[i]);
1031 tn->internal[i] = NULL;
1036 return (allDone) ? 1 : 0;
1042 for(i = YAFFS_NTNODES_LEVEL0 -1; i >= 0 && !hitLimit; i--)
1047 chunkInInode = (chunkOffset << YAFFS_TNODES_LEVEL0_BITS ) + i;
1049 theChunk = tn->level0[i] << dev->chunkGroupBits;
1051 foundChunk = yaffs_FindChunkInGroup(dev,theChunk,&tags,in->objectId,chunkInInode);
1055 yaffs_DeleteChunk(dev,foundChunk,1,__LINE__);
1072 return (i < 0) ? 1 : 0;
1084 static void yaffs_SoftDeleteChunk(yaffs_Device *dev, int chunk)
1087 yaffs_BlockInfo *theBlock;
1089 T(YAFFS_TRACE_DELETION,(TSTR("soft delete chunk %d" TENDSTR),chunk));
1091 theBlock = yaffs_GetBlockInfo(dev, chunk/dev->nChunksPerBlock);
1094 theBlock->softDeletions++;
1099 // SoftDeleteWorker scans backwards through the tnode tree and soft deletes all the chunks in the file.
1100 // All soft deleting does is increment the block's softdelete count and pulls the chunk out
1102 // THus, essentially this is the same as DeleteWorker except that the chunks are soft deleted.
1104 static int yaffs_SoftDeleteWorker(yaffs_Object *in, yaffs_Tnode *tn, __u32 level, int chunkOffset)
1109 yaffs_Device *dev = in->myDev;
1117 for(i = YAFFS_NTNODES_INTERNAL -1; allDone && i >= 0; i--)
1121 allDone = yaffs_SoftDeleteWorker(in,tn->internal[i],level - 1,
1122 (chunkOffset << YAFFS_TNODES_INTERNAL_BITS ) + i);
1125 yaffs_FreeTnode(dev,tn->internal[i]);
1126 tn->internal[i] = NULL;
1130 //Hoosterman... how could this happen.
1134 return (allDone) ? 1 : 0;
1139 for(i = YAFFS_NTNODES_LEVEL0 -1; i >=0; i--)
1143 // Note this does not find the real chunk, only the chunk group.
1144 // We make an assumption that a chunk group is niot larger than a block.
1145 theChunk = (tn->level0[i] << dev->chunkGroupBits);
1147 yaffs_SoftDeleteChunk(dev,theChunk);
1164 static void yaffs_SoftDeleteFile(yaffs_Object *obj)
1167 obj->variantType == YAFFS_OBJECT_TYPE_FILE &&
1170 if(obj->nDataChunks <= 0)
1172 // Empty file with no duplicate object headers, just delete it immediately
1173 yaffs_FreeTnode(obj->myDev,obj->variant.fileVariant.top);
1174 obj->variant.fileVariant.top = NULL;
1175 T(YAFFS_TRACE_TRACING,(TSTR("yaffs: Deleting empty file %d" TENDSTR),obj->objectId));
1176 yaffs_DoGenericObjectDeletion(obj);
1180 yaffs_SoftDeleteWorker(obj, obj->variant.fileVariant.top, obj->variant.fileVariant.topLevel, 0);
1181 obj->softDeleted = 1;
1190 // Pruning removes any part of the file structure tree that is beyond the
1191 // bounds of the file (ie that does not point to chunks).
1193 // A file should only get pruned when its size is reduced.
1195 // Before pruning, the chunks must be pulled from the tree and the
1196 // level 0 tnode entries must be zeroed out.
1197 // Could also use this for file deletion, but that's probably better handled
1198 // by a special case.
1200 // yaffs_PruneWorker should only be called by yaffs_PruneFileStructure()
1202 static yaffs_Tnode *yaffs_PruneWorker(yaffs_Device *dev, yaffs_Tnode *tn, __u32 level, int del0)
1211 for(i = 0; i < YAFFS_NTNODES_INTERNAL; i++)
1213 if(tn->internal[i] && level > 0)
1215 tn->internal[i] = yaffs_PruneWorker(dev,tn->internal[i],level - 1, ( i == 0) ? del0 : 1);
1224 if(hasData == 0 && del0)
1226 // Free and return NULL
1228 yaffs_FreeTnode(dev,tn);
1238 static int yaffs_PruneFileStructure(yaffs_Device *dev, yaffs_FileStructure *fStruct)
1245 if(fStruct->topLevel > 0)
1247 fStruct->top = yaffs_PruneWorker(dev,fStruct->top, fStruct->topLevel,0);
1249 // Now we have a tree with all the non-zero branches NULL but the height
1250 // is the same as it was.
1251 // Let's see if we can trim internal tnodes to shorten the tree.
1252 // We can do this if only the 0th element in the tnode is in use
1253 // (ie all the non-zero are NULL)
1255 while(fStruct->topLevel && !done)
1260 for(i = 1; i <YAFFS_NTNODES_INTERNAL; i++)
1270 fStruct->top = tn->internal[0];
1271 fStruct->topLevel--;
1272 yaffs_FreeTnode(dev,tn);
1288 /////////////////////// End of File Structure functions. /////////////////
1290 // yaffs_CreateFreeObjects creates a bunch more objects and
1291 // adds them to the object free list.
1292 static int yaffs_CreateFreeObjects(yaffs_Device *dev, int nObjects)
1295 yaffs_Object *newObjects;
1296 yaffs_ObjectList *list;
1298 if(nObjects < 1) return YAFFS_OK;
1300 // make these things
1302 newObjects = YMALLOC(nObjects * sizeof(yaffs_Object));
1306 T(YAFFS_TRACE_ALLOCATE,(TSTR("yaffs: Could not allocate more objects" TENDSTR)));
1310 // Hook them into the free list
1311 for(i = 0; i < nObjects - 1; i++)
1313 newObjects[i].siblings.next = (struct list_head *)(&newObjects[i+1]);
1316 newObjects[nObjects - 1].siblings.next = (void *)dev->freeObjects;
1317 dev->freeObjects = newObjects;
1318 dev->nFreeObjects+= nObjects;
1319 dev->nObjectsCreated+= nObjects;
1321 // Now add this bunch of Objects to a list for freeing up.
1323 list = YMALLOC(sizeof(yaffs_ObjectList));
1326 T(YAFFS_TRACE_ALLOCATE,(TSTR("Could not add objects to management list" TENDSTR)));
1330 list->objects = newObjects;
1331 list->next = dev->allocatedObjectList;
1332 dev->allocatedObjectList = list;
1341 // AllocateEmptyObject gets us a clean Object. Tries to make allocate more if we run out
1342 static yaffs_Object *yaffs_AllocateEmptyObject(yaffs_Device *dev)
1344 yaffs_Object *tn = NULL;
1346 // If there are none left make more
1347 if(!dev->freeObjects)
1349 yaffs_CreateFreeObjects(dev,YAFFS_ALLOCATION_NOBJECTS);
1352 if(dev->freeObjects)
1354 tn = dev->freeObjects;
1355 dev->freeObjects = (yaffs_Object *)(dev->freeObjects->siblings.next);
1356 dev->nFreeObjects--;
1358 // Now sweeten it up...
1360 memset(tn,0,sizeof(yaffs_Object));
1363 tn->variantType = YAFFS_OBJECT_TYPE_UNKNOWN;
1364 INIT_LIST_HEAD(&(tn->hardLinks));
1365 INIT_LIST_HEAD(&(tn->hashLink));
1366 INIT_LIST_HEAD(&tn->siblings);
1368 // Add it to the lost and found directory.
1369 // NB Can't put root or lostNFound in lostNFound so
1370 // check if lostNFound exists first
1371 if(dev->lostNFoundDir)
1373 yaffs_AddObjectToDirectory(dev->lostNFoundDir,tn);
1381 static yaffs_Object *yaffs_CreateFakeDirectory(yaffs_Device *dev,int number,__u32 mode)
1384 yaffs_Object *obj = yaffs_CreateNewObject(dev,number,YAFFS_OBJECT_TYPE_DIRECTORY);
1387 obj->fake = 1; // it is fake so it has no NAND presence...
1388 obj->renameAllowed= 0; // ... and we're not allowed to rename it...
1389 obj->unlinkAllowed= 0; // ... or unlink it
1392 obj->yst_mode = mode;
1394 obj->chunkId = 0; // Not a valid chunk.
1402 static void yaffs_UnhashObject(yaffs_Object *tn)
1405 yaffs_Device *dev = tn->myDev;
1408 // If it is still linked into the bucket list, free from the list
1409 if(!list_empty(&tn->hashLink))
1411 list_del_init(&tn->hashLink);
1412 bucket = yaffs_HashFunction(tn->objectId);
1413 dev->objectBucket[bucket].count--;
1419 // FreeObject frees up a Object and puts it back on the free list
1420 static void yaffs_FreeObject(yaffs_Object *tn)
1423 yaffs_Device *dev = tn->myDev;
1428 // We're still hooked up to a cached inode.
1429 // Don't delete now, but mark for later deletion
1430 tn->deferedFree = 1;
1435 yaffs_UnhashObject(tn);
1437 // Link into the free list.
1438 tn->siblings.next = (struct list_head *)(dev->freeObjects);
1439 dev->freeObjects = tn;
1440 dev->nFreeObjects++;
1447 void yaffs_HandleDeferedFree(yaffs_Object *obj)
1449 if(obj->deferedFree)
1451 yaffs_FreeObject(obj);
1459 static void yaffs_DeinitialiseObjects(yaffs_Device *dev)
1461 // Free the list of allocated Objects
1463 yaffs_ObjectList *tmp;
1465 while( dev->allocatedObjectList)
1467 tmp = dev->allocatedObjectList->next;
1468 YFREE(dev->allocatedObjectList->objects);
1469 YFREE(dev->allocatedObjectList);
1471 dev->allocatedObjectList = tmp;
1474 dev->freeObjects = NULL;
1475 dev->nFreeObjects = 0;
1478 static void yaffs_InitialiseObjects(yaffs_Device *dev)
1482 dev->allocatedObjectList = NULL;
1483 dev->freeObjects = NULL;
1484 dev->nFreeObjects = 0;
1486 for(i = 0; i < YAFFS_NOBJECT_BUCKETS; i++)
1488 INIT_LIST_HEAD(&dev->objectBucket[i].list);
1489 dev->objectBucket[i].count = 0;
1499 int yaffs_FindNiceObjectBucket(yaffs_Device *dev)
1504 int lowest = 999999;
1507 // First let's see if we can find one that's empty.
1509 for(i = 0; i < 10 && lowest > 0; i++)
1512 x %= YAFFS_NOBJECT_BUCKETS;
1513 if(dev->objectBucket[x].count < lowest)
1515 lowest = dev->objectBucket[x].count;
1521 // If we didn't find an empty list, then try
1522 // looking a bit further for a short one
1524 for(i = 0; i < 10 && lowest > 3; i++)
1527 x %= YAFFS_NOBJECT_BUCKETS;
1528 if(dev->objectBucket[x].count < lowest)
1530 lowest = dev->objectBucket[x].count;
1539 static int yaffs_CreateNewObjectNumber(yaffs_Device *dev)
1541 int bucket = yaffs_FindNiceObjectBucket(dev);
1543 // Now find an object value that has not already been taken
1544 // by scanning the list.
1547 struct list_head *i;
1549 __u32 n = (__u32)bucket;
1551 //yaffs_CheckObjectHashSanity();
1556 n += YAFFS_NOBJECT_BUCKETS;
1557 if(1 ||dev->objectBucket[bucket].count > 0)
1559 list_for_each(i,&dev->objectBucket[bucket].list)
1561 // If there is already one in the list
1562 if(i && list_entry(i, yaffs_Object,hashLink)->objectId == n)
1570 //T(("bucket %d count %d inode %d\n",bucket,yaffs_objectBucket[bucket].count,n);
1575 void yaffs_HashObject(yaffs_Object *in)
1577 int bucket = yaffs_HashFunction(in->objectId);
1578 yaffs_Device *dev = in->myDev;
1580 if(!list_empty(&in->hashLink))
1586 list_add(&in->hashLink,&dev->objectBucket[bucket].list);
1587 dev->objectBucket[bucket].count++;
1591 yaffs_Object *yaffs_FindObjectByNumber(yaffs_Device *dev,__u32 number)
1593 int bucket = yaffs_HashFunction(number);
1594 struct list_head *i;
1597 list_for_each(i,&dev->objectBucket[bucket].list)
1599 // Look if it is in the list
1602 in = list_entry(i, yaffs_Object,hashLink);
1603 if(in->objectId == number)
1606 // Don't tell the VFS about this one if it is defered free
1621 yaffs_Object *yaffs_CreateNewObject(yaffs_Device *dev,int number,yaffs_ObjectType type)
1624 yaffs_Object *theObject;
1628 number = yaffs_CreateNewObjectNumber(dev);
1631 theObject = yaffs_AllocateEmptyObject(dev);
1635 theObject->fake = 0;
1636 theObject->renameAllowed = 1;
1637 theObject->unlinkAllowed = 1;
1638 theObject->objectId = number;
1639 yaffs_HashObject(theObject);
1640 theObject->variantType = type;
1641 #ifdef CONFIG_YAFFS_WINCE
1642 yfsd_WinFileTimeNow(theObject->win_atime);
1643 theObject->win_ctime[0] = theObject->win_mtime[0] = theObject->win_atime[0];
1644 theObject->win_ctime[1] = theObject->win_mtime[1] = theObject->win_atime[1];
1648 theObject->yst_atime = theObject->yst_mtime = theObject->yst_ctime = Y_CURRENT_TIME;
1652 case YAFFS_OBJECT_TYPE_FILE:
1653 theObject->variant.fileVariant.fileSize = 0;
1654 theObject->variant.fileVariant.scannedFileSize = 0;
1655 theObject->variant.fileVariant.shrinkSize = 0xFFFFFFFF; // max __u32
1656 theObject->variant.fileVariant.topLevel = 0;
1657 theObject->variant.fileVariant.top = yaffs_GetTnode(dev);
1659 case YAFFS_OBJECT_TYPE_DIRECTORY:
1660 INIT_LIST_HEAD(&theObject->variant.directoryVariant.children);
1662 case YAFFS_OBJECT_TYPE_SYMLINK:
1663 // No action required
1665 case YAFFS_OBJECT_TYPE_HARDLINK:
1666 // No action required
1668 case YAFFS_OBJECT_TYPE_SPECIAL:
1669 // No action required
1671 case YAFFS_OBJECT_TYPE_UNKNOWN:
1672 // todo this should not happen
1680 yaffs_Object *yaffs_FindOrCreateObjectByNumber(yaffs_Device *dev, int number,yaffs_ObjectType type)
1682 yaffs_Object *theObject = NULL;
1686 theObject = yaffs_FindObjectByNumber(dev,number);
1691 theObject = yaffs_CreateNewObject(dev,number,type);
1698 YCHAR *yaffs_CloneString(const YCHAR *str)
1700 YCHAR *newStr = NULL;
1704 newStr = YMALLOC((yaffs_strlen(str) + 1) * sizeof(YCHAR));
1705 yaffs_strcpy(newStr,str);
1713 // Mknod (create) a new object.
1714 // equivalentObject only has meaning for a hard link;
1715 // aliasString only has meaning for a sumlink.
1716 // rdev only has meaning for devices (a subset of special objects)
1717 yaffs_Object *yaffs_MknodObject( yaffs_ObjectType type,
1718 yaffs_Object *parent,
1723 yaffs_Object *equivalentObject,
1724 const YCHAR *aliasString,
1729 yaffs_Device *dev = parent->myDev;
1731 // Check if the entry exists. If it does then fail the call since we don't want a dup.
1732 if(yaffs_FindObjectByName(parent,name))
1737 in = yaffs_CreateNewObject(dev,-1,type);
1743 in->variantType = type;
1745 in->yst_mode = mode;
1747 #ifdef CONFIG_YAFFS_WINCE
1748 yfsd_WinFileTimeNow(in->win_atime);
1749 in->win_ctime[0] = in->win_mtime[0] = in->win_atime[0];
1750 in->win_ctime[1] = in->win_mtime[1] = in->win_atime[1];
1753 in->yst_atime = in->yst_mtime = in->yst_ctime = Y_CURRENT_TIME;
1755 in->yst_rdev = rdev;
1759 in->nDataChunks = 0;
1761 yaffs_SetObjectName(in,name);
1764 yaffs_AddObjectToDirectory(parent,in);
1766 in->myDev = parent->myDev;
1771 case YAFFS_OBJECT_TYPE_SYMLINK:
1772 in->variant.symLinkVariant.alias = yaffs_CloneString(aliasString);
1774 case YAFFS_OBJECT_TYPE_HARDLINK:
1775 in->variant.hardLinkVariant.equivalentObject = equivalentObject;
1776 in->variant.hardLinkVariant.equivalentObjectId = equivalentObject->objectId;
1777 list_add(&in->hardLinks,&equivalentObject->hardLinks);
1779 case YAFFS_OBJECT_TYPE_FILE: // do nothing
1780 case YAFFS_OBJECT_TYPE_DIRECTORY: // do nothing
1781 case YAFFS_OBJECT_TYPE_SPECIAL: // do nothing
1782 case YAFFS_OBJECT_TYPE_UNKNOWN:
1786 if(/*yaffs_GetNumberOfFreeChunks(dev) <= 0 || */
1787 yaffs_UpdateObjectHeader(in,name,0,0) < 0)
1789 // Could not create the object header, fail the creation
1790 yaffs_DestroyObject(in);
1799 yaffs_Object *yaffs_MknodFile(yaffs_Object *parent,const YCHAR *name, __u32 mode, __u32 uid, __u32 gid)
1801 return yaffs_MknodObject(YAFFS_OBJECT_TYPE_FILE,parent,name,mode,uid,gid,NULL,NULL,0);
1804 yaffs_Object *yaffs_MknodDirectory(yaffs_Object *parent,const YCHAR *name, __u32 mode, __u32 uid, __u32 gid)
1806 return yaffs_MknodObject(YAFFS_OBJECT_TYPE_DIRECTORY,parent,name,mode,uid,gid,NULL,NULL,0);
1809 yaffs_Object *yaffs_MknodSpecial(yaffs_Object *parent,const YCHAR *name, __u32 mode, __u32 uid, __u32 gid, __u32 rdev)
1811 return yaffs_MknodObject(YAFFS_OBJECT_TYPE_SPECIAL,parent,name,mode,uid,gid,NULL,NULL,rdev);
1814 yaffs_Object *yaffs_MknodSymLink(yaffs_Object *parent,const YCHAR *name, __u32 mode, __u32 uid, __u32 gid,const YCHAR *alias)
1816 return yaffs_MknodObject(YAFFS_OBJECT_TYPE_SYMLINK,parent,name,mode,uid,gid,NULL,alias,0);
1819 // NB yaffs_Link returns the object id of the equivalent object.
1820 yaffs_Object *yaffs_Link(yaffs_Object *parent, const YCHAR *name, yaffs_Object *equivalentObject)
1822 // Get the real object in case we were fed a hard link as an equivalent object
1823 equivalentObject = yaffs_GetEquivalentObject(equivalentObject);
1825 if(yaffs_MknodObject(YAFFS_OBJECT_TYPE_HARDLINK,parent,name,0,0,0,equivalentObject,NULL,0))
1827 return equivalentObject;
1837 static int yaffs_ChangeObjectName(yaffs_Object *obj, yaffs_Object *newDir, const YCHAR *newName,int force)
1844 newDir = obj->parent; // use the old directory
1847 if(newDir->variantType != YAFFS_OBJECT_TYPE_DIRECTORY)
1849 T(YAFFS_TRACE_ALWAYS,(TSTR("tragendy: yaffs_ChangeObjectName: newDir is not a directory"TENDSTR)));
1853 // TODO: Do we need this different handling for YAFFS2 and YAFFS1??
1854 if(obj->myDev->isYaffs2)
1856 unlinkOp = (newDir == obj->myDev->unlinkedDir);
1860 unlinkOp = (newDir == obj->myDev->unlinkedDir && obj->variantType == YAFFS_OBJECT_TYPE_FILE);
1863 deleteOp = (newDir == obj->myDev->deletedDir);
1865 // If the object is a file going into the unlinked directory, then it is OK to just stuff it in since
1866 // duplicate names are allowed.
1867 // Otherwise only proceed if the new name does not exist and if we're putting it into a directory.
1871 !yaffs_FindObjectByName(newDir,newName)) &&
1872 newDir->variantType == YAFFS_OBJECT_TYPE_DIRECTORY)
1874 yaffs_SetObjectName(obj,newName);
1877 yaffs_AddObjectToDirectory(newDir,obj);
1879 if(unlinkOp) obj->unlinked = 1;
1881 // If it is a deletion then we mark it as a shrink for gc purposes.
1882 if(yaffs_UpdateObjectHeader(obj,newName,0,deleteOp) >= 0)
1893 int yaffs_RenameObject(yaffs_Object *oldDir, const YCHAR *oldName, yaffs_Object *newDir, const YCHAR *newName)
1898 #ifdef CONFIG_YAFFS_CASE_INSENSITIVE
1899 // Special case for case insemsitive systems (eg. WinCE).
1900 // While look-up is case insensitive, the name isn't.
1901 // THerefore we might want to change x.txt to X.txt
1902 if(oldDir == newDir && yaffs_strcmp(oldName,newName) == 0)
1908 obj = yaffs_FindObjectByName(oldDir,oldName);
1909 if(obj && obj->renameAllowed)
1911 return yaffs_ChangeObjectName(obj,newDir,newName,force);
1919 static int yaffs_CheckObjectHashSanity(yaffs_Device *dev)
1921 // Scan the buckets and check that the lists
1922 // have as many members as the count says there are
1925 struct list_head *j;
1928 for(bucket = 0; bucket < YAFFS_NOBJECT_BUCKETS; bucket++)
1932 list_for_each(j,&dev->objectBucket[bucket].list)
1937 if(countEm != dev->objectBucket[bucket].count)
1939 T(YAFFS_TRACE_ERROR,(TSTR("Inode hash inconsistency" TENDSTR)));
1948 void yaffs_ObjectTest(yaffs_Device *dev)
1950 yaffs_Object *in[1000];
1952 yaffs_Object *inold[1000];
1956 memset(in,0,1000*sizeof(yaffs_Object *));
1957 memset(inold,0,1000*sizeof(yaffs_Object *));
1959 yaffs_CheckObjectHashSanity(dev);
1961 for(j = 0; j < 10; j++)
1965 for(i = 0; i < 1000; i++)
1967 in[i] = yaffs_CreateNewObject(dev,-1,YAFFS_OBJECT_TYPE_FILE);
1970 YINFO("No more inodes");
1974 inNo[i] = in[i]->objectId;
1978 for(i = 0; i < 1000; i++)
1980 if(yaffs_FindObjectByNumber(dev,inNo[i]) != in[i])
1982 //T(("Differnce in look up test\n"));
1986 // T(("Look up ok\n"));
1990 yaffs_CheckObjectHashSanity(dev);
1992 for(i = 0; i < 1000; i+=3)
1994 yaffs_FreeObject(in[i]);
1999 yaffs_CheckObjectHashSanity(dev);
2006 /////////////////////////// Block Management and Page Allocation ///////////////////
2009 static int yaffs_InitialiseBlocks(yaffs_Device *dev,int nBlocks)
2011 dev->allocationBlock = -1; // force it to get a new one
2012 //Todo we're assuming the malloc will pass.
2013 dev->blockInfo = YMALLOC(nBlocks * sizeof(yaffs_BlockInfo));
2014 // Set up dynamic blockinfo stuff.
2015 dev->chunkBitmapStride = (dev->nChunksPerBlock+7)/8;
2016 dev->chunkBits = YMALLOC(dev->chunkBitmapStride * nBlocks);
2017 if(dev->blockInfo && dev->chunkBits)
2019 memset(dev->blockInfo,0,nBlocks * sizeof(yaffs_BlockInfo));
2020 memset(dev->chunkBits,0,dev->chunkBitmapStride * nBlocks);
2028 static void yaffs_DeinitialiseBlocks(yaffs_Device *dev)
2030 YFREE(dev->blockInfo);
2031 dev->blockInfo = NULL;
2032 YFREE(dev->chunkBits);
2033 dev->chunkBits = NULL;
2037 static int yaffs_BlockNotDisqualifiedFromGC(yaffs_Device *dev, yaffs_BlockInfo *bi)
2043 if(!dev->isYaffs2) return 1; // disqualification only applies to yaffs2.
2045 if(!bi->hasShrinkHeader) return 1; // can gc
2048 // Find the oldest dirty sequence number if we don't know it and save it
2049 // so we don't have to keep recomputing it.
2050 if(!dev->oldestDirtySequence)
2052 seq = dev->sequenceNumber;
2054 for(i = dev->internalStartBlock; i <= dev->internalEndBlock; i++)
2056 b = yaffs_GetBlockInfo(dev,i);
2057 if(b->blockState == YAFFS_BLOCK_STATE_FULL &&
2058 (b->pagesInUse - b->softDeletions )< dev->nChunksPerBlock &&
2059 b->sequenceNumber < seq)
2061 seq = b->sequenceNumber;
2064 dev->oldestDirtySequence = seq;
2068 // Can't do gc of this block if there are any blocks older than this one that have
2070 return (bi->sequenceNumber <= dev->oldestDirtySequence);
2077 // FindDiretiestBlock is used to select the dirtiest block (or close enough)
2078 // for garbage collection.
2083 static int yaffs_FindBlockForGarbageCollection(yaffs_Device *dev,int aggressive)
2086 int b = dev->currentDirtyChecker;
2092 yaffs_BlockInfo *bi;
2093 static int nonAggressiveSkip = 0;
2095 // If we're doing aggressive GC then we are happy to take a less-dirty block, and
2097 // else (we're doing a leasurely gc), then we only bother to do this if the
2098 // block has only a few pages in use.
2101 nonAggressiveSkip--;
2103 if(!aggressive &&(nonAggressiveSkip > 0))
2108 pagesInUse = (aggressive)? dev->nChunksPerBlock : YAFFS_PASSIVE_GC_CHUNKS + 1;
2112 iterations = dev->internalEndBlock - dev->internalStartBlock + 1;
2116 iterations = dev->internalEndBlock - dev->internalStartBlock + 1;
2117 iterations = iterations / 16;
2118 if(iterations > 200)
2124 for(i = 0; i <= iterations && pagesInUse > 0 ; i++)
2127 if ( b < dev->internalStartBlock || b > dev->internalEndBlock)
2129 b = dev->internalStartBlock;
2132 if(b < dev->internalStartBlock || b > dev->internalEndBlock)
2134 T(YAFFS_TRACE_ERROR,(TSTR("**>> Block %d is not valid" TENDSTR),b));
2138 bi = yaffs_GetBlockInfo(dev,b);
2140 if(bi->blockState == YAFFS_BLOCK_STATE_FULL &&
2141 (bi->pagesInUse - bi->softDeletions )< pagesInUse &&
2142 yaffs_BlockNotDisqualifiedFromGC(dev,bi))
2145 pagesInUse = (bi->pagesInUse - bi->softDeletions);
2149 dev->currentDirtyChecker = b;
2153 T(YAFFS_TRACE_GC,(TSTR("GC Selected block %d with %d free" TENDSTR),dirtiest,dev->nChunksPerBlock - pagesInUse));
2156 dev->oldestDirtySequence = 0; // clear this
2160 nonAggressiveSkip = 4;
2167 static void yaffs_BlockBecameDirty(yaffs_Device *dev,int blockNo)
2169 yaffs_BlockInfo *bi = yaffs_GetBlockInfo(dev,blockNo);
2173 // If the block is still healthy erase it and mark as clean.
2174 // If the block has had a data failure, then retire it.
2175 bi->blockState = YAFFS_BLOCK_STATE_DIRTY;
2177 if(!bi->needsRetiring)
2179 erasedOk = yaffs_EraseBlockInNAND(dev,blockNo);
2182 dev->nErasureFailures++;
2183 T(YAFFS_TRACE_ERROR | YAFFS_TRACE_BAD_BLOCKS,(TSTR("**>> Erasure failed %d" TENDSTR),blockNo));
2187 if(erasedOk && (yaffs_traceMask & YAFFS_TRACE_ERASE))
2190 for(i = 0; i < dev->nChunksPerBlock; i++)
2192 if(!yaffs_CheckChunkErased(dev,blockNo * dev->nChunksPerBlock + i))
2194 T(YAFFS_TRACE_ERROR,(TSTR(">>Block %d erasure supposedly OK, but chunk %d not erased" TENDSTR),blockNo,i));
2202 bi->blockState = YAFFS_BLOCK_STATE_EMPTY;
2203 dev->nErasedBlocks++;
2205 bi->softDeletions = 0;
2206 bi->hasShrinkHeader=0;
2207 yaffs_ClearChunkBits(dev,blockNo);
2209 T(YAFFS_TRACE_ERASE,(TSTR("Erased block %d" TENDSTR),blockNo));
2213 dev->nFreeChunks -= dev->nChunksPerBlock; // We lost a block of free space
2215 yaffs_RetireBlock(dev,blockNo);
2216 T(YAFFS_TRACE_ERROR | YAFFS_TRACE_BAD_BLOCKS,(TSTR("**>> Block %d retired" TENDSTR),blockNo));
2221 static void yaffs_DumpBlockStats(yaffs_Device *dev)
2224 yaffs_BlockInfo *bi;
2226 for(i= dev->internalStartBlock; i <=dev->internalEndBlock; i++)
2228 bi = yaffs_GetBlockInfo(dev,i);
2229 T(YAFFS_TRACE_ALLOCATE,(TSTR("%3d state %d shrink %d inuse %d/%d seq %d pages"),i,
2230 bi->blockState,bi->hasShrinkHeader,bi->pagesInUse,bi->softDeletions,bi->sequenceNumber));
2232 for(j = 0; j < dev->nChunksPerBlock; j++)
2234 if(yaffs_CheckChunkBit(dev,i,j))
2236 T(YAFFS_TRACE_ALLOCATE,(TSTR(" %d"),j));
2240 T(YAFFS_TRACE_ALLOCATE,(TSTR(" " TENDSTR)));
2247 static int yaffs_FindBlockForAllocation(yaffs_Device *dev)
2251 yaffs_BlockInfo *bi;
2256 if(j < 0 || j > 100)
2259 yaffs_DumpBlockStats(dev);
2264 if(dev->nErasedBlocks < 1)
2266 // Hoosterman we've got a problem.
2267 // Can't get space to gc
2268 T(YAFFS_TRACE_ERROR, (TSTR("yaffs tragedy: no more eraased blocks" TENDSTR)));
2273 // Find an empty block.
2275 for(i = dev->internalStartBlock; i <= dev->internalEndBlock; i++)
2277 dev->allocationBlockFinder++;
2278 if(dev->allocationBlockFinder < dev->internalStartBlock || dev->allocationBlockFinder> dev->internalEndBlock)
2280 dev->allocationBlockFinder = dev->internalStartBlock;
2283 bi = yaffs_GetBlockInfo(dev,dev->allocationBlockFinder);
2285 if(bi->blockState == YAFFS_BLOCK_STATE_EMPTY)
2287 bi->blockState = YAFFS_BLOCK_STATE_ALLOCATING;
2288 dev->sequenceNumber++;
2289 bi->sequenceNumber = dev->sequenceNumber;
2290 dev->nErasedBlocks--;
2291 T(YAFFS_TRACE_ALLOCATE,(TSTR("Allocated block %d, seq %d, %d left" TENDSTR),dev->allocationBlockFinder,dev->sequenceNumber, dev->nErasedBlocks));
2292 return dev->allocationBlockFinder;
2297 T(YAFFS_TRACE_ALWAYS, (TSTR("yaffs tragedy: no more eraased blocks, but there should have been %d" TENDSTR),dev->nErasedBlocks));
2307 // To determine if we have enough space we just look at the
2308 // number of erased blocks.
2310 static int yaffs_CheckSpaceForAllocation(yaffs_Device *dev)
2312 int reservedChunks = (dev->nReservedBlocks * dev->nChunksPerBlock);
2313 return (dev->nFreeChunks > reservedChunks);
2317 static int yaffs_AllocateChunk(yaffs_Device *dev,int useReserve)
2320 yaffs_BlockInfo *bi;
2322 if(dev->allocationBlock < 0)
2324 // Get next block to allocate off
2325 dev->allocationBlock = yaffs_FindBlockForAllocation(dev);
2326 dev->allocationPage = 0;
2329 if(!useReserve && !yaffs_CheckSpaceForAllocation(dev))
2331 // Not enough space to allocate unless we're allowed to use the reserve.
2335 if(dev->nErasedBlocks < dev->nReservedBlocks && dev->allocationPage == 0)
2337 T(YAFFS_TRACE_ALLOCATE,(TSTR("Allocating reserve" TENDSTR)));
2341 // Next page please....
2342 if(dev->allocationBlock >= 0)
2344 bi = yaffs_GetBlockInfo(dev,dev->allocationBlock);
2346 retVal = (dev->allocationBlock * dev->nChunksPerBlock) +
2347 dev->allocationPage;
2349 yaffs_SetChunkBit(dev,dev->allocationBlock,dev->allocationPage);
2351 dev->allocationPage++;
2355 // If the block is full set the state to full
2356 if(dev->allocationPage >= dev->nChunksPerBlock)
2358 bi->blockState = YAFFS_BLOCK_STATE_FULL;
2359 dev->allocationBlock = -1;
2366 T(YAFFS_TRACE_ERROR,(TSTR("!!!!!!!!! Allocator out !!!!!!!!!!!!!!!!!" TENDSTR)));
2374 static int yaffs_GetErasedChunks(yaffs_Device *dev)
2378 n = dev->nErasedBlocks * dev->nChunksPerBlock;
2380 if(dev->allocationBlock> 0)
2382 n += (dev->nChunksPerBlock - dev->allocationPage);
2389 int yaffs_GarbageCollectBlock(yaffs_Device *dev,int block)
2395 int retVal = YAFFS_OK;
2399 int chunksBefore = yaffs_GetErasedChunks(dev);
2402 yaffs_ExtendedTags tags;
2404 yaffs_BlockInfo *bi = yaffs_GetBlockInfo(dev,block);
2406 yaffs_Object *object;
2408 bi->blockState = YAFFS_BLOCK_STATE_COLLECTING;
2410 T(YAFFS_TRACE_TRACING,(TSTR("Collecting block %d, in use %d, shrink %d, " TENDSTR),block,bi->pagesInUse,bi->hasShrinkHeader));
2411 //T(("Collecting block %d n %d bits %x\n",block, bi->pagesInUse, bi->pageBits));
2413 //yaffs_VerifyFreeChunks(dev);
2415 bi->hasShrinkHeader = 0; // clear the flag so that the block can erase
2417 dev->nFreeChunks -= bi->softDeletions; // Take off the number of soft deleted entries because
2418 // they're going to get really deleted during GC.
2422 if(!yaffs_StillSomeChunkBits(dev,block))
2424 T(YAFFS_TRACE_TRACING,(TSTR("Collecting block %d that has no chunks in use" TENDSTR),block));
2425 yaffs_BlockBecameDirty(dev,block);
2430 __u8 *buffer = yaffs_GetTempBuffer(dev,__LINE__);
2432 for(chunkInBlock = 0,oldChunk = block * dev->nChunksPerBlock;
2433 chunkInBlock < dev->nChunksPerBlock && yaffs_StillSomeChunkBits(dev,block);
2434 chunkInBlock++, oldChunk++ )
2436 if(yaffs_CheckChunkBit(dev,block,chunkInBlock))
2439 // This page is in use and might need to be copied off
2443 //T(("copying page %x from %d to %d\n",mask,oldChunk,newChunk));
2445 yaffs_InitialiseTags(&tags);
2447 yaffs_ReadChunkWithTagsFromNAND(dev,oldChunk,buffer, &tags);
2449 object = yaffs_FindObjectByNumber(dev,tags.objectId);
2451 T(YAFFS_TRACE_GC_DETAIL,(TSTR("Collecting page %d, %d %d %d " TENDSTR),chunkInBlock,tags.objectId,tags.chunkId,tags.byteCount));
2455 T(YAFFS_TRACE_ERROR,(TSTR("page %d in gc has no object " TENDSTR),oldChunk));
2458 if(object && object->deleted && tags.chunkId != 0)
2460 // Data chunk in a deleted file, throw it away
2461 // It's a soft deleted data chunk,
2462 // No need to copy this, just forget about it and fix up the
2465 //yaffs_PutChunkIntoFile(object, tags.chunkId, 0,0);
2466 object->nDataChunks--;
2468 if(object->nDataChunks <= 0)
2470 // remeber to clean up the object
2471 dev->gcCleanupList[cleanups] = tags.objectId;
2476 else if( 0 /* Todo object && object->deleted && object->nDataChunks == 0 */)
2478 // Deleted object header with no data chunks.
2479 // Can be discarded and the file deleted.
2480 object->chunkId = 0;
2481 yaffs_FreeTnode(object->myDev,object->variant.fileVariant.top);
2482 object->variant.fileVariant.top = NULL;
2483 yaffs_DoGenericObjectDeletion(object);
2488 // It's either a data chunk in a live file or
2489 // an ObjectHeader, so we're interested in it.
2490 // NB Need to keep the ObjectHeaders of deleted files
2491 // until the whole file has been deleted off
2492 tags.serialNumber++;
2496 newChunk = yaffs_WriteNewChunkWithTagsToNAND(dev, buffer, &tags,1);
2500 retVal = YAFFS_FAIL;
2505 // Ok, now fix up the Tnodes etc.
2507 if(tags.chunkId == 0)
2510 object->chunkId = newChunk;
2511 object->serial = tags.serialNumber;
2515 // It's a data chunk
2516 yaffs_PutChunkIntoFile(object, tags.chunkId, newChunk,0);
2521 yaffs_DeleteChunk(dev,oldChunk,markNAND,__LINE__);
2526 yaffs_ReleaseTempBuffer(dev,buffer,__LINE__);
2528 //yaffs_VerifyFreeChunks(dev);
2530 // Do any required cleanups
2531 for(i = 0; i < cleanups; i++)
2533 // Time to delete the file too
2534 object = yaffs_FindObjectByNumber(dev,dev->gcCleanupList[i]);
2537 yaffs_FreeTnode(dev,object->variant.fileVariant.top);
2538 object->variant.fileVariant.top = NULL;
2539 T(YAFFS_TRACE_GC,(TSTR("yaffs: About to finally delete object %d" TENDSTR),object->objectId));
2540 yaffs_DoGenericObjectDeletion(object);
2547 if(chunksBefore >= (chunksAfter = yaffs_GetErasedChunks(dev)))
2549 T(YAFFS_TRACE_GC,(TSTR("gc did not increase free chunks before %d after %d" TENDSTR),chunksBefore,chunksAfter));
2555 //yaffs_VerifyFreeChunks(dev);
2561 static yaffs_Object *yaffs_FindDeletedUnlinkedFile(yaffs_Device *dev)
2563 // find a file to delete
2564 struct list_head *i;
2568 //Scan the unlinked files looking for one to delete
2569 list_for_each(i,&dev->unlinkedDir->variant.directoryVariant.children)
2573 l = list_entry(i, yaffs_Object,siblings);
2584 static void yaffs_DoUnlinkedFileDeletion(yaffs_Device *dev)
2586 // This does background deletion on unlinked files.. only deleted ones.
2587 // If we don't have a file we're working on then find one
2588 if(!dev->unlinkedDeletion && dev->nDeletedFiles > 0)
2590 dev->unlinkedDeletion = yaffs_FindDeletedUnlinkedFile(dev);
2593 // OK, we're working on a file...
2594 if(dev->unlinkedDeletion)
2596 yaffs_Object *obj = dev->unlinkedDeletion;
2598 int limit; // Number of chunks to delete in a file.
2599 // NB this can be exceeded, but not by much.
2603 delresult = yaffs_DeleteWorker(obj, obj->variant.fileVariant.top, obj->variant.fileVariant.topLevel, 0,&limit);
2605 if(obj->nDataChunks == 0)
2607 // Done all the deleting of data chunks.
2608 // Now dump the header and clean up
2609 yaffs_FreeTnode(dev,obj->variant.fileVariant.top);
2610 obj->variant.fileVariant.top = NULL;
2611 yaffs_DoGenericObjectDeletion(obj);
2612 dev->nDeletedFiles--;
2613 dev->nUnlinkedFiles--;
2614 dev->nBackgroundDeletions++;
2615 dev->unlinkedDeletion = NULL;
2624 // New garbage collector
2625 // If we're very low on erased blocks then we do aggressive garbage collection
2626 // otherwise we do "leasurely" garbage collection.
2627 // Aggressive gc looks further (whole array) and will accept dirtier blocks.
2628 // Passive gc only inspects smaller areas and will only accept cleaner blocks.
2630 // The idea is to help clear out space in a more spread-out manner.
2631 // Dunno if it really does anything useful.
2633 int yaffs_CheckGarbageCollection(yaffs_Device *dev)
2637 int gcOk = YAFFS_OK;
2640 //yaffs_VerifyFreeChunks(dev);
2644 // Bail out so we don't get recursive gc
2648 // This loop should pass the first time.
2649 // We'll only see looping here if the erase of the collected block fails.
2653 if(dev->nErasedBlocks < dev->nReservedBlocks)
2655 // We need a block soon...
2660 // We're in no hurry
2664 block = yaffs_FindBlockForGarbageCollection(dev,aggressive);
2668 dev->garbageCollections++;
2671 dev->passiveGarbageCollections++;
2674 T(YAFFS_TRACE_GC,(TSTR("yaffs: GC erasedBlocks %d aggressive %d" TENDSTR),dev->nErasedBlocks,aggressive));
2676 gcOk = yaffs_GarbageCollectBlock(dev,block);
2679 if(dev->nErasedBlocks < (dev->nReservedBlocks) && block > 0)
2681 T(YAFFS_TRACE_GC,(TSTR("yaffs: GC !!!no reclaim!!! erasedBlocks %d after try %d block %d" TENDSTR),dev->nErasedBlocks,maxTries,block));
2683 } while((dev->nErasedBlocks < dev->nReservedBlocks) && (block > 0) && (maxTries < 2));
2685 return aggressive ? gcOk: YAFFS_OK;
2689 //////////////////////////// TAGS ///////////////////////////////////////
2695 void yaffs_CalcTagsECC(yaffs_Tags *tags)
2699 unsigned char *b = ((yaffs_TagsUnion *)tags)->asBytes;
2706 for(i = 0; i < 8; i++)
2708 for(j = 1; j &0xff; j<<=1)
2723 int yaffs_CheckECCOnTags(yaffs_Tags *tags)
2725 unsigned ecc = tags->ecc;
2727 yaffs_CalcTagsECC(tags);
2731 if(ecc && ecc <= 64)
2733 // TODO: Handle the failure better. Retire?
2734 unsigned char *b = ((yaffs_TagsUnion *)tags)->asBytes;
2738 b[ecc / 8] ^= (1 << (ecc & 7));
2740 // Now recvalc the ecc
2741 yaffs_CalcTagsECC(tags);
2743 return 1; // recovered error
2747 // Wierd ecc failure value
2748 // TODO Need to do somethiong here
2749 return -1; //unrecovered error
2755 static void yaffs_LoadTagsIntoSpare(yaffs_Spare *sparePtr, yaffs_Tags *tagsPtr)
2757 yaffs_TagsUnion *tu = (yaffs_TagsUnion *)tagsPtr;
2759 yaffs_CalcTagsECC(tagsPtr);
2761 sparePtr->tagByte0 = tu->asBytes[0];
2762 sparePtr->tagByte1 = tu->asBytes[1];
2763 sparePtr->tagByte2 = tu->asBytes[2];
2764 sparePtr->tagByte3 = tu->asBytes[3];
2765 sparePtr->tagByte4 = tu->asBytes[4];
2766 sparePtr->tagByte5 = tu->asBytes[5];
2767 sparePtr->tagByte6 = tu->asBytes[6];
2768 sparePtr->tagByte7 = tu->asBytes[7];
2771 static void yaffs_GetTagsFromSpare(yaffs_Device *dev, yaffs_Spare *sparePtr,yaffs_Tags *tagsPtr)
2773 yaffs_TagsUnion *tu = (yaffs_TagsUnion *)tagsPtr;
2776 tu->asBytes[0]= sparePtr->tagByte0;
2777 tu->asBytes[1]= sparePtr->tagByte1;
2778 tu->asBytes[2]= sparePtr->tagByte2;
2779 tu->asBytes[3]= sparePtr->tagByte3;
2780 tu->asBytes[4]= sparePtr->tagByte4;
2781 tu->asBytes[5]= sparePtr->tagByte5;
2782 tu->asBytes[6]= sparePtr->tagByte6;
2783 tu->asBytes[7]= sparePtr->tagByte7;
2785 result = yaffs_CheckECCOnTags(tagsPtr);
2788 dev->tagsEccFixed++;
2792 dev->tagsEccUnfixed++;
2796 static void yaffs_SpareInitialise(yaffs_Spare *spare)
2798 memset(spare,0xFF,sizeof(yaffs_Spare));
2804 static int yaffs_WriteNewChunkWithTagsToNAND(yaffs_Device *dev, const __u8 *buffer, yaffs_ExtendedTags *tags, int useReserve)
2806 // NB There must be tags, data is optional
2807 // If there is data, then an ECC is calculated on it.
2816 //yaffs_SpareInitialise(&spare);
2818 //if(!dev->useNANDECC && buffer)
2820 // yaffs_CalcECC(buffer,&spare);
2823 //yaffs_LoadTagsIntoSpare(&spare,tags);
2825 return yaffs_WriteNewChunkToNAND(dev,buffer,&spare,useReserve);
2830 static int yaffs_TagsMatch(const yaffs_ExtendedTags *tags, int objectId, int chunkInObject)
2832 return ( tags->chunkId == chunkInObject &&
2833 tags->objectId == objectId &&
2834 !tags->chunkDeleted) ? 1 : 0;
2838 /////////////////////////////////////////////////////////////////////////////////////////////////////////
2841 int yaffs_FindChunkInFile(yaffs_Object *in,int chunkInInode,yaffs_ExtendedTags *tags)
2843 //Get the Tnode, then get the level 0 offset chunk offset
2846 yaffs_ExtendedTags localTags;
2849 yaffs_Device *dev = in->myDev;
2854 // Passed a NULL, so use our own tags space
2858 tn = yaffs_FindLevel0Tnode(dev,&in->variant.fileVariant, chunkInInode);
2862 theChunk = tn->level0[chunkInInode & YAFFS_TNODES_LEVEL0_MASK] << dev->chunkGroupBits;
2864 retVal = yaffs_FindChunkInGroup(dev,theChunk,tags,in->objectId,chunkInInode);
2869 int yaffs_FindAndDeleteChunkInFile(yaffs_Object *in,int chunkInInode,yaffs_ExtendedTags *tags)
2871 //Get the Tnode, then get the level 0 offset chunk offset
2874 yaffs_ExtendedTags localTags;
2876 yaffs_Device *dev = in->myDev;
2881 // Passed a NULL, so use our own tags space
2885 tn = yaffs_FindLevel0Tnode(dev,&in->variant.fileVariant, chunkInInode);
2890 theChunk = tn->level0[chunkInInode & YAFFS_TNODES_LEVEL0_MASK] << dev->chunkGroupBits;
2892 retVal = yaffs_FindChunkInGroup(dev,theChunk,tags,in->objectId,chunkInInode);
2894 // Delete the entry in the filestructure (if found)
2897 tn->level0[chunkInInode & YAFFS_TNODES_LEVEL0_MASK] = 0;
2902 //T(("No level 0 found for %d\n", chunkInInode));
2907 //T(("Could not find %d to delete\n",chunkInInode));
2913 #ifdef YAFFS_PARANOID
2915 static int yaffs_CheckFileSanity(yaffs_Object *in)
2923 yaffs_Tags localTags;
2924 yaffs_Tags *tags = &localTags;
2929 if(in->variantType != YAFFS_OBJECT_TYPE_FILE)
2931 //T(("Object not a file\n"));
2935 objId = in->objectId;
2936 fSize = in->variant.fileVariant.fileSize;
2937 nChunks = (fSize + in->myDev->nBytesPerChunk -1)/in->myDev->nBytesPerChunk;
2939 for(chunk = 1; chunk <= nChunks; chunk++)
2941 tn = yaffs_FindLevel0Tnode(in->myDev,&in->variant.fileVariant, chunk);
2946 theChunk = tn->level0[chunk & YAFFS_TNODES_LEVEL0_MASK] << in->myDev->chunkGroupBits;
2948 if(yaffs_CheckChunkBits(dev,theChunk/dev->nChunksPerBlock,theChunk%dev->nChunksPerBlock))
2952 yaffs_ReadChunkTagsFromNAND(in->myDev,theChunk,tags,&chunkDeleted);
2953 if(yaffs_TagsMatch(tags,in->objectId,chunk,chunkDeleted))
2961 //T(("File problem file [%d,%d] NAND %d tags[%d,%d]\n",
2962 // objId,chunk,theChunk,tags->chunkId,tags->objectId);
2971 //T(("No level 0 found for %d\n", chunk));
2975 return failed ? YAFFS_FAIL : YAFFS_OK;
2980 static int yaffs_PutChunkIntoFile(yaffs_Object *in,int chunkInInode, int chunkInNAND, int inScan)
2982 // NB inScan is zero unless scanning. For forward scanning, inScan is > 0; for backward scanning inScan is < 0
2984 yaffs_Device *dev = in->myDev;
2986 yaffs_ExtendedTags existingTags;
2987 yaffs_ExtendedTags newTags;
2988 unsigned existingSerial, newSerial;
2990 if(in->variantType != YAFFS_OBJECT_TYPE_FILE)
2992 // Just ignore an attempt at putting a chunk into a non-file during scanning
2993 // If it is not during Scanning then something went wrong!
2996 T(YAFFS_TRACE_ERROR, (TSTR("yaffs tragedy:attempt to put data chunk into a non-file" TENDSTR)));
3000 yaffs_DeleteChunk(dev,chunkInNAND,1,__LINE__);
3004 tn = yaffs_AddOrFindLevel0Tnode(dev,&in->variant.fileVariant, chunkInInode);
3010 existingChunk = tn->level0[chunkInInode & YAFFS_TNODES_LEVEL0_MASK];
3014 // If we're scanning then we need to test for duplicates
3015 // NB This does not need to be efficient since it should only ever
3016 // happen when the power fails during a write, then only one
3017 // chunk should ever be affected.
3019 // Correction for YAFFS2: This could happen quite a lot and we need to think about efficiency! TODO
3020 // Update: For backward scanning we don't need to re-read tags so this is quite cheap.
3024 if(existingChunk != 0)
3026 // NB Right now existing chunk will not be real chunkId if the device >= 32MB
3027 // thus we have to do a FindChunkInFile to get the real chunk id.
3029 // We have a duplicate now we need to decide which one to use:
3031 // Backwards scanning YAFFS2: The old one is what we use, dump the new one.
3032 // Forward scanning YAFFS2: The new one is what we use, dump the old one.
3033 // YAFFS1: Get both sets of tags and compare serial numbers.
3039 // Only do this for forward scanning
3040 yaffs_ReadChunkWithTagsFromNAND(dev,chunkInNAND, NULL,&newTags);
3044 existingChunk = yaffs_FindChunkInFile(in,chunkInInode, &existingTags);
3047 if(existingChunk <=0)
3049 //Hoosterman - how did this happen?
3051 T(YAFFS_TRACE_ERROR, (TSTR("yaffs tragedy: existing chunk < 0 in scan" TENDSTR)));
3056 // NB The deleted flags should be false, otherwise the chunks will
3057 // not be loaded during a scan
3059 newSerial = newTags.serialNumber;
3060 existingSerial = existingTags.serialNumber;
3063 ( in->myDev->isYaffs2 ||
3064 existingChunk <= 0 ||
3065 ((existingSerial+1) & 3) == newSerial))
3067 // Forward scanning.
3069 // Delete the old one and drop through to update the tnode
3070 yaffs_DeleteChunk(dev,existingChunk,1,__LINE__);
3074 // Backward scanning or we want to use the existing one
3076 // Delete the new one and return early so that the tnode isn't changed
3077 yaffs_DeleteChunk(dev,chunkInNAND,1,__LINE__);
3084 if(existingChunk == 0)
3089 tn->level0[chunkInInode & YAFFS_TNODES_LEVEL0_MASK] = (chunkInNAND >> dev->chunkGroupBits);
3096 int yaffs_ReadChunkDataFromObject(yaffs_Object *in,int chunkInInode, __u8 *buffer)
3098 int chunkInNAND = yaffs_FindChunkInFile(in,chunkInInode,NULL);
3100 if(chunkInNAND >= 0)
3102 return yaffs_ReadChunkWithTagsFromNAND(in->myDev,chunkInNAND,buffer,NULL);
3106 T(YAFFS_TRACE_NANDACCESS,(TSTR("Chunk %d not found zero instead" TENDSTR),chunkInNAND));
3108 memset(buffer,0,in->myDev->nBytesPerChunk); // get sane data if you read a hole
3115 void yaffs_DeleteChunk(yaffs_Device *dev,int chunkId,int markNAND,int lyn)
3119 yaffs_ExtendedTags tags;
3120 yaffs_BlockInfo *bi;
3122 if(chunkId <= 0) return;
3125 block = chunkId / dev->nChunksPerBlock;
3126 page = chunkId % dev->nChunksPerBlock;
3128 bi = yaffs_GetBlockInfo(dev,block);
3130 T(YAFFS_TRACE_DELETION,(TSTR("line %d delete of chunk %d" TENDSTR),lyn,chunkId));
3133 bi->blockState != YAFFS_BLOCK_STATE_COLLECTING &&
3136 // yaffs_SpareInitialise(&spare);
3138 #ifdef CONFIG_MTD_NAND_VERIFY_WRITE
3140 //read data before write, to ensure correct ecc
3141 //if we're using MTD verification under Linux
3142 yaffs_ReadChunkFromNAND(dev,chunkId,NULL,&spare,0);
3145 yaffs_InitialiseTags(&tags);
3147 tags.chunkDeleted = 1;
3150 yaffs_WriteChunkWithTagsToNAND(dev,chunkId,NULL,&tags);
3151 yaffs_HandleUpdateChunk(dev,chunkId,&tags);
3155 dev->nUnmarkedDeletions++;
3159 // Pull out of the management area.
3160 // If the whole block became dirty, this will kick off an erasure.
3161 if( bi->blockState == YAFFS_BLOCK_STATE_ALLOCATING ||
3162 bi->blockState == YAFFS_BLOCK_STATE_FULL ||
3163 bi->blockState == YAFFS_BLOCK_STATE_NEEDS_SCANNING ||
3164 bi->blockState == YAFFS_BLOCK_STATE_COLLECTING)
3168 yaffs_ClearChunkBit(dev,block,page);
3172 if(bi->pagesInUse == 0 &&
3173 !bi->hasShrinkHeader &&
3174 bi->blockState != YAFFS_BLOCK_STATE_ALLOCATING &&
3175 bi->blockState != YAFFS_BLOCK_STATE_NEEDS_SCANNING)
3177 yaffs_BlockBecameDirty(dev,block);
3183 // T(("Bad news deleting chunk %d\n",chunkId));
3191 int yaffs_WriteChunkDataToObject(yaffs_Object *in,int chunkInInode, const __u8 *buffer,int nBytes,int useReserve)
3193 // Find old chunk Need to do this to get serial number
3194 // Write new one and patch into tree.
3195 // Invalidate old tags.
3198 yaffs_ExtendedTags prevTags;
3201 yaffs_ExtendedTags newTags;
3203 yaffs_Device *dev = in->myDev;
3205 yaffs_CheckGarbageCollection(dev);
3207 // Get the previous chunk at this location in the file if it exists
3208 prevChunkId = yaffs_FindChunkInFile(in,chunkInInode,&prevTags);
3211 yaffs_InitialiseTags(&newTags);
3213 newTags.chunkId = chunkInInode;
3214 newTags.objectId = in->objectId;
3215 newTags.serialNumber = (prevChunkId >= 0) ? prevTags.serialNumber + 1 : 1;
3216 newTags.byteCount = nBytes;
3218 // yaffs_CalcTagsECC(&newTags);
3220 newChunkId = yaffs_WriteNewChunkWithTagsToNAND(dev,buffer,&newTags,useReserve);
3224 yaffs_PutChunkIntoFile(in,chunkInInode,newChunkId,0);
3227 if(prevChunkId >= 0)
3229 yaffs_DeleteChunk(dev,prevChunkId,1,__LINE__);
3233 yaffs_CheckFileSanity(in);
3244 // UpdateObjectHeader updates the header on NAND for an object.
3245 // If name is not NULL, then that new name is used.
3247 int yaffs_UpdateObjectHeader(yaffs_Object *in,const YCHAR *name, int force,int isShrink)
3250 yaffs_BlockInfo *bi;
3252 yaffs_Device *dev = in->myDev;
3258 yaffs_ExtendedTags newTags;
3260 __u8 *buffer = NULL;
3261 YCHAR oldName[YAFFS_MAX_NAME_LENGTH+1];
3263 // __u8 bufferOld[YAFFS_BYTES_PER_CHUNK];
3265 yaffs_ObjectHeader *oh = NULL;
3266 // yaffs_ObjectHeader *ohOld = (yaffs_ObjectHeader *)bufferOld;
3269 if(!in->fake || force)
3272 yaffs_CheckGarbageCollection(dev);
3274 buffer = yaffs_GetTempBuffer(in->myDev,__LINE__);
3275 oh = (yaffs_ObjectHeader *)buffer;
3277 prevChunkId = in->chunkId;
3279 if(prevChunkId >= 0)
3281 yaffs_ReadChunkWithTagsFromNAND(dev,prevChunkId,buffer,NULL);
3282 memcpy(oldName,oh->name,sizeof(oh->name));
3285 memset(buffer,0xFF,dev->nBytesPerChunk);
3288 oh->type = in->variantType;
3290 oh->yst_mode = in->yst_mode;
3292 #ifdef CONFIG_YAFFS_WINCE
3293 oh->win_atime[0] = in->win_atime[0];
3294 oh->win_ctime[0] = in->win_ctime[0];
3295 oh->win_mtime[0] = in->win_mtime[0];
3296 oh->win_atime[1] = in->win_atime[1];
3297 oh->win_ctime[1] = in->win_ctime[1];
3298 oh->win_mtime[1] = in->win_mtime[1];
3300 oh->yst_uid = in->yst_uid;
3301 oh->yst_gid = in->yst_gid;
3302 oh->yst_atime = in->yst_atime;
3303 oh->yst_mtime = in->yst_mtime;
3304 oh->yst_ctime = in->yst_ctime;
3305 oh->yst_rdev = in->yst_rdev;
3309 oh->parentObjectId = in->parent->objectId;
3313 oh->parentObjectId = 0;
3316 //oh->sum = in->sum;
3319 memset(oh->name,0,sizeof(oh->name));
3320 yaffs_strncpy(oh->name,name,YAFFS_MAX_NAME_LENGTH);
3322 else if(prevChunkId)
3324 memcpy(oh->name, oldName,sizeof(oh->name));
3328 memset(oh->name,0,sizeof(oh->name));
3331 oh->isShrink = isShrink;
3333 switch(in->variantType)
3335 case YAFFS_OBJECT_TYPE_UNKNOWN:
3336 // Should not happen
3338 case YAFFS_OBJECT_TYPE_FILE:
3339 oh->fileSize = (oh->parentObjectId == YAFFS_OBJECTID_DELETED ||
3340 oh->parentObjectId == YAFFS_OBJECTID_UNLINKED) ? 0 : in->variant.fileVariant.fileSize;
3342 case YAFFS_OBJECT_TYPE_HARDLINK:
3343 oh->equivalentObjectId = in->variant.hardLinkVariant.equivalentObjectId;
3345 case YAFFS_OBJECT_TYPE_SPECIAL:
3348 case YAFFS_OBJECT_TYPE_DIRECTORY:
3351 case YAFFS_OBJECT_TYPE_SYMLINK:
3352 yaffs_strncpy(oh->alias,in->variant.symLinkVariant.alias,YAFFS_MAX_ALIAS_LENGTH);
3353 oh->alias[YAFFS_MAX_ALIAS_LENGTH] = 0;
3358 yaffs_InitialiseTags(&newTags);
3360 newTags.chunkId = 0;
3361 newTags.objectId = in->objectId;
3362 newTags.serialNumber = in->serial;
3364 // Add extra info for file header
3366 newTags.extraHeaderInfoAvailable = 1;
3367 newTags.extraParentObjectId = oh->parentObjectId;
3368 newTags.extraFileLength = oh->fileSize;
3369 newTags.extraIsShrinkHeader = oh->isShrink;
3370 newTags.extraEquivalentObjectId = oh->equivalentObjectId;
3371 newTags.extraObjectType = in->variantType;
3373 // Create new chunk in NAND
3374 newChunkId = yaffs_WriteNewChunkWithTagsToNAND(dev,buffer,&newTags, (prevChunkId >= 0) ? 1 : 0 );
3379 in->chunkId = newChunkId;
3381 if(prevChunkId >= 0)
3383 yaffs_DeleteChunk(dev,prevChunkId,1,__LINE__);
3388 // If this was a shrink, then mark the block that the chunk lives on
3391 bi = yaffs_GetBlockInfo(in->myDev,newChunkId / in->myDev->nChunksPerBlock);
3392 bi->hasShrinkHeader = 1;
3397 retVal = newChunkId;
3402 yaffs_ReleaseTempBuffer(dev,buffer,__LINE__);
3408 /////////////////////// Short Operations Cache ////////////////////////////////
3409 // In many siturations where there is no high level buffering (eg WinCE) a lot of
3410 // reads might be short sequential reads, and a lot of writes may be short
3411 // sequential writes. eg. scanning/writing a jpeg file.
3412 // In these cases, a short read/write cache can provide a huge perfomance benefit
3413 // with dumb-as-a-rock code.
3414 // There are a limited number (~10) of cache chunks per device so that we don't
3415 // need a very intelligent search.
3421 static void yaffs_FlushFilesChunkCache(yaffs_Object *obj)
3423 yaffs_Device *dev = obj->myDev;
3426 yaffs_ChunkCache *cache;
3427 int chunkWritten = 0;
3429 int nCaches = obj->myDev->nShortOpCaches;
3436 // Find the dirty cache for this object with the lowest chunk id.
3437 for(i = 0; i < nCaches; i++)
3439 if(dev->srCache[i].object == obj &&
3440 dev->srCache[i].dirty)
3442 if(!cache || dev->srCache[i].chunkId < lowest)
3444 cache = &dev->srCache[i];
3445 lowest = cache->chunkId;
3450 if(cache && !cache->locked)
3452 //Write it out and free it up