2 * YAFFS: Yet Another Flash File System. A NAND-flash specific file system.
4 * Copyright (C) 2002-2007 Aleph One Ltd.
5 * for Toby Churchill Ltd and Brightstar Engineering
7 * Created by Charles Manning <charles@aleph1.co.uk>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License version 2 as
11 * published by the Free Software Foundation.
14 const char *yaffs_guts_c_version =
15 "$Id: yaffs_guts.c,v 1.112 2010-03-05 01:49:00 charles Exp $";
18 #include "yaffs_trace.h"
20 #include "yaffsinterface.h"
21 #include "yaffs_guts.h"
22 #include "yaffs_tagsvalidity.h"
23 #include "yaffs_getblockinfo.h"
25 #include "yaffs_tagscompat.h"
26 #ifndef CONFIG_YAFFS_USE_OWN_SORT
27 #include "yaffs_qsort.h"
29 #include "yaffs_nand.h"
31 #include "yaffs_checkptrw.h"
33 #include "yaffs_nand.h"
34 #include "yaffs_packedtags2.h"
37 #define YAFFS_PASSIVE_GC_CHUNKS 2
39 #include "yaffs_ecc.h"
42 /* Robustification (if it ever comes about...) */
43 static void yaffs_RetireBlock(yaffs_Device *dev, int blockInNAND);
44 static void yaffs_HandleWriteChunkError(yaffs_Device *dev, int chunkInNAND,
46 static void yaffs_HandleWriteChunkOk(yaffs_Device *dev, int chunkInNAND,
48 const yaffs_ExtendedTags *tags);
49 static void yaffs_HandleUpdateChunk(yaffs_Device *dev, int chunkInNAND,
50 const yaffs_ExtendedTags *tags);
52 /* Other local prototypes */
53 static void yaffs_UpdateParent(yaffs_Object *obj);
54 static int yaffs_UnlinkObject(yaffs_Object *obj);
55 static int yaffs_ObjectHasCachedWriteData(yaffs_Object *obj);
57 static void yaffs_HardlinkFixup(yaffs_Device *dev, yaffs_Object *hardList);
59 static int yaffs_WriteNewChunkWithTagsToNAND(yaffs_Device *dev,
61 yaffs_ExtendedTags *tags,
63 static int yaffs_PutChunkIntoFile(yaffs_Object *in, int chunkInInode,
64 int chunkInNAND, int inScan);
66 static yaffs_Object *yaffs_CreateNewObject(yaffs_Device *dev, int number,
67 yaffs_ObjectType type);
68 static void yaffs_AddObjectToDirectory(yaffs_Object *directory,
70 static int yaffs_UpdateObjectHeader(yaffs_Object *in, const YCHAR *name,
71 int force, int isShrink, int shadows);
72 static void yaffs_RemoveObjectFromDirectory(yaffs_Object *obj);
73 static int yaffs_CheckStructures(void);
74 static int yaffs_DeleteWorker(yaffs_Object *in, yaffs_Tnode *tn, __u32 level,
75 int chunkOffset, int *limit);
76 static int yaffs_DoGenericObjectDeletion(yaffs_Object *in);
78 static yaffs_BlockInfo *yaffs_GetBlockInfo(yaffs_Device *dev, int blockNo);
81 static int yaffs_CheckChunkErased(struct yaffs_DeviceStruct *dev,
84 static int yaffs_UnlinkWorker(yaffs_Object *obj);
86 static int yaffs_TagsMatch(const yaffs_ExtendedTags *tags, int objectId,
89 static int yaffs_AllocateChunk(yaffs_Device *dev, int useReserve,
90 yaffs_BlockInfo **blockUsedPtr);
92 static void yaffs_VerifyFreeChunks(yaffs_Device *dev);
94 static void yaffs_CheckObjectDetailsLoaded(yaffs_Object *in);
96 static void yaffs_VerifyDirectory(yaffs_Object *directory);
98 static int yaffs_CheckFileSanity(yaffs_Object *in);
100 #define yaffs_CheckFileSanity(in)
103 static void yaffs_InvalidateWholeChunkCache(yaffs_Object *in);
104 static void yaffs_InvalidateChunkCache(yaffs_Object *object, int chunkId);
106 static void yaffs_InvalidateCheckpoint(yaffs_Device *dev);
108 static int yaffs_FindChunkInFile(yaffs_Object *in, int chunkInInode,
109 yaffs_ExtendedTags *tags);
111 static __u32 yaffs_GetChunkGroupBase(yaffs_Device *dev, yaffs_Tnode *tn,
113 static yaffs_Tnode *yaffs_FindLevel0Tnode(yaffs_Device *dev,
114 yaffs_FileStructure *fStruct,
117 static void yaffs_SkipRestOfBlock(yaffs_Device *dev);
118 static int yaffs_VerifyChunkWritten(yaffs_Device *dev,
121 yaffs_ExtendedTags *tags);
123 /* Function to calculate chunk and offset */
125 static void yaffs_AddrToChunk(yaffs_Device *dev, loff_t addr, int *chunkOut,
131 chunk = (__u32)(addr >> dev->chunkShift);
133 if (dev->chunkDiv == 1) {
134 /* easy power of 2 case */
135 offset = (__u32)(addr & dev->chunkMask);
137 /* Non power-of-2 case */
141 chunk /= dev->chunkDiv;
143 chunkBase = ((loff_t)chunk) * dev->nDataBytesPerChunk;
144 offset = (__u32)(addr - chunkBase);
151 /* Function to return the number of shifts for a power of 2 greater than or
152 * equal to the given number
153 * Note we don't try to cater for all possible numbers and this does not have to
154 * be hellishly efficient.
157 static __u32 ShiftsGE(__u32 x)
162 nShifts = extraBits = 0;
177 /* Function to return the number of shifts to get a 1 in bit 0
180 static __u32 Shifts(__u32 x)
200 * Temporary buffer manipulations.
203 static int yaffs_InitialiseTempBuffers(yaffs_Device *dev)
206 __u8 *buf = (__u8 *)1;
208 memset(dev->tempBuffer, 0, sizeof(dev->tempBuffer));
210 for (i = 0; buf && i < YAFFS_N_TEMP_BUFFERS; i++) {
211 dev->tempBuffer[i].line = 0; /* not in use */
212 dev->tempBuffer[i].buffer = buf =
213 YMALLOC_DMA(dev->param.totalBytesPerChunk);
216 return buf ? YAFFS_OK : YAFFS_FAIL;
219 __u8 *yaffs_GetTempBuffer(yaffs_Device *dev, int lineNo)
224 if (dev->tempInUse > dev->maxTemp)
225 dev->maxTemp = dev->tempInUse;
227 for (i = 0; i < YAFFS_N_TEMP_BUFFERS; i++) {
228 if (dev->tempBuffer[i].line == 0) {
229 dev->tempBuffer[i].line = lineNo;
230 if ((i + 1) > dev->maxTemp) {
231 dev->maxTemp = i + 1;
232 for (j = 0; j <= i; j++)
233 dev->tempBuffer[j].maxLine =
234 dev->tempBuffer[j].line;
237 return dev->tempBuffer[i].buffer;
241 T(YAFFS_TRACE_BUFFERS,
242 (TSTR("Out of temp buffers at line %d, other held by lines:"),
244 for (i = 0; i < YAFFS_N_TEMP_BUFFERS; i++)
245 T(YAFFS_TRACE_BUFFERS, (TSTR(" %d "), dev->tempBuffer[i].line));
247 T(YAFFS_TRACE_BUFFERS, (TSTR(" " TENDSTR)));
250 * If we got here then we have to allocate an unmanaged one
254 dev->unmanagedTempAllocations++;
255 return YMALLOC(dev->nDataBytesPerChunk);
259 void yaffs_ReleaseTempBuffer(yaffs_Device *dev, __u8 *buffer,
266 for (i = 0; i < YAFFS_N_TEMP_BUFFERS; i++) {
267 if (dev->tempBuffer[i].buffer == buffer) {
268 dev->tempBuffer[i].line = 0;
274 /* assume it is an unmanaged one. */
275 T(YAFFS_TRACE_BUFFERS,
276 (TSTR("Releasing unmanaged temp buffer in line %d" TENDSTR),
279 dev->unmanagedTempDeallocations++;
285 * Determine if we have a managed buffer.
287 int yaffs_IsManagedTempBuffer(yaffs_Device *dev, const __u8 *buffer)
291 for (i = 0; i < YAFFS_N_TEMP_BUFFERS; i++) {
292 if (dev->tempBuffer[i].buffer == buffer)
296 for (i = 0; i < dev->param.nShortOpCaches; i++) {
297 if (dev->srCache[i].data == buffer)
301 if (buffer == dev->checkpointBuffer)
304 T(YAFFS_TRACE_ALWAYS,
305 (TSTR("yaffs: unmaged buffer detected.\n" TENDSTR)));
312 * Chunk bitmap manipulations
315 static Y_INLINE __u8 *yaffs_BlockBits(yaffs_Device *dev, int blk)
317 if (blk < dev->internalStartBlock || blk > dev->internalEndBlock) {
319 (TSTR("**>> yaffs: BlockBits block %d is not valid" TENDSTR),
323 return dev->chunkBits +
324 (dev->chunkBitmapStride * (blk - dev->internalStartBlock));
327 static Y_INLINE void yaffs_VerifyChunkBitId(yaffs_Device *dev, int blk, int chunk)
329 if (blk < dev->internalStartBlock || blk > dev->internalEndBlock ||
330 chunk < 0 || chunk >= dev->param.nChunksPerBlock) {
332 (TSTR("**>> yaffs: Chunk Id (%d:%d) invalid"TENDSTR),
338 static Y_INLINE void yaffs_ClearChunkBits(yaffs_Device *dev, int blk)
340 __u8 *blkBits = yaffs_BlockBits(dev, blk);
342 memset(blkBits, 0, dev->chunkBitmapStride);
345 static Y_INLINE void yaffs_ClearChunkBit(yaffs_Device *dev, int blk, int chunk)
347 __u8 *blkBits = yaffs_BlockBits(dev, blk);
349 yaffs_VerifyChunkBitId(dev, blk, chunk);
351 blkBits[chunk / 8] &= ~(1 << (chunk & 7));
354 static Y_INLINE void yaffs_SetChunkBit(yaffs_Device *dev, int blk, int chunk)
356 __u8 *blkBits = yaffs_BlockBits(dev, blk);
358 yaffs_VerifyChunkBitId(dev, blk, chunk);
360 blkBits[chunk / 8] |= (1 << (chunk & 7));
363 static Y_INLINE int yaffs_CheckChunkBit(yaffs_Device *dev, int blk, int chunk)
365 __u8 *blkBits = yaffs_BlockBits(dev, blk);
366 yaffs_VerifyChunkBitId(dev, blk, chunk);
368 return (blkBits[chunk / 8] & (1 << (chunk & 7))) ? 1 : 0;
371 static Y_INLINE int yaffs_StillSomeChunkBits(yaffs_Device *dev, int blk)
373 __u8 *blkBits = yaffs_BlockBits(dev, blk);
375 for (i = 0; i < dev->chunkBitmapStride; i++) {
383 static int yaffs_CountChunkBits(yaffs_Device *dev, int blk)
385 __u8 *blkBits = yaffs_BlockBits(dev, blk);
388 for (i = 0; i < dev->chunkBitmapStride; i++) {
405 static int yaffs_SkipVerification(yaffs_Device *dev)
407 return !(yaffs_traceMask & (YAFFS_TRACE_VERIFY | YAFFS_TRACE_VERIFY_FULL));
410 static int yaffs_SkipFullVerification(yaffs_Device *dev)
412 return !(yaffs_traceMask & (YAFFS_TRACE_VERIFY_FULL));
415 static int yaffs_SkipNANDVerification(yaffs_Device *dev)
417 return !(yaffs_traceMask & (YAFFS_TRACE_VERIFY_NAND));
420 static const char *blockStateName[] = {
433 static void yaffs_VerifyBlock(yaffs_Device *dev, yaffs_BlockInfo *bi, int n)
438 if (yaffs_SkipVerification(dev))
441 /* Report illegal runtime states */
442 if (bi->blockState >= YAFFS_NUMBER_OF_BLOCK_STATES)
443 T(YAFFS_TRACE_VERIFY, (TSTR("Block %d has undefined state %d"TENDSTR), n, bi->blockState));
445 switch (bi->blockState) {
446 case YAFFS_BLOCK_STATE_UNKNOWN:
447 case YAFFS_BLOCK_STATE_SCANNING:
448 case YAFFS_BLOCK_STATE_NEEDS_SCANNING:
449 T(YAFFS_TRACE_VERIFY, (TSTR("Block %d has bad run-state %s"TENDSTR),
450 n, blockStateName[bi->blockState]));
453 /* Check pages in use and soft deletions are legal */
455 actuallyUsed = bi->pagesInUse - bi->softDeletions;
457 if (bi->pagesInUse < 0 || bi->pagesInUse > dev->param.nChunksPerBlock ||
458 bi->softDeletions < 0 || bi->softDeletions > dev->param.nChunksPerBlock ||
459 actuallyUsed < 0 || actuallyUsed > dev->param.nChunksPerBlock)
460 T(YAFFS_TRACE_VERIFY, (TSTR("Block %d has illegal values pagesInUsed %d softDeletions %d"TENDSTR),
461 n, bi->pagesInUse, bi->softDeletions));
464 /* Check chunk bitmap legal */
465 inUse = yaffs_CountChunkBits(dev, n);
466 if (inUse != bi->pagesInUse)
467 T(YAFFS_TRACE_VERIFY, (TSTR("Block %d has inconsistent values pagesInUse %d counted chunk bits %d"TENDSTR),
468 n, bi->pagesInUse, inUse));
470 /* Check that the sequence number is valid.
471 * Ten million is legal, but is very unlikely
473 if (dev->param.isYaffs2 &&
474 (bi->blockState == YAFFS_BLOCK_STATE_ALLOCATING || bi->blockState == YAFFS_BLOCK_STATE_FULL) &&
475 (bi->sequenceNumber < YAFFS_LOWEST_SEQUENCE_NUMBER || bi->sequenceNumber > 10000000))
476 T(YAFFS_TRACE_VERIFY, (TSTR("Block %d has suspect sequence number of %d"TENDSTR),
477 n, bi->sequenceNumber));
480 static void yaffs_VerifyCollectedBlock(yaffs_Device *dev, yaffs_BlockInfo *bi,
483 yaffs_VerifyBlock(dev, bi, n);
485 /* After collection the block should be in the erased state */
486 /* This will need to change if we do partial gc */
488 if (bi->blockState != YAFFS_BLOCK_STATE_COLLECTING &&
489 bi->blockState != YAFFS_BLOCK_STATE_EMPTY) {
490 T(YAFFS_TRACE_ERROR, (TSTR("Block %d is in state %d after gc, should be erased"TENDSTR),
495 static void yaffs_VerifyBlocks(yaffs_Device *dev)
498 int nBlocksPerState[YAFFS_NUMBER_OF_BLOCK_STATES];
499 int nIllegalBlockStates = 0;
501 if (yaffs_SkipVerification(dev))
504 memset(nBlocksPerState, 0, sizeof(nBlocksPerState));
506 for (i = dev->internalStartBlock; i <= dev->internalEndBlock; i++) {
507 yaffs_BlockInfo *bi = yaffs_GetBlockInfo(dev, i);
508 yaffs_VerifyBlock(dev, bi, i);
510 if (bi->blockState < YAFFS_NUMBER_OF_BLOCK_STATES)
511 nBlocksPerState[bi->blockState]++;
513 nIllegalBlockStates++;
516 T(YAFFS_TRACE_VERIFY, (TSTR(""TENDSTR)));
517 T(YAFFS_TRACE_VERIFY, (TSTR("Block summary"TENDSTR)));
519 T(YAFFS_TRACE_VERIFY, (TSTR("%d blocks have illegal states"TENDSTR), nIllegalBlockStates));
520 if (nBlocksPerState[YAFFS_BLOCK_STATE_ALLOCATING] > 1)
521 T(YAFFS_TRACE_VERIFY, (TSTR("Too many allocating blocks"TENDSTR)));
523 for (i = 0; i < YAFFS_NUMBER_OF_BLOCK_STATES; i++)
524 T(YAFFS_TRACE_VERIFY,
525 (TSTR("%s %d blocks"TENDSTR),
526 blockStateName[i], nBlocksPerState[i]));
528 if (dev->blocksInCheckpoint != nBlocksPerState[YAFFS_BLOCK_STATE_CHECKPOINT])
529 T(YAFFS_TRACE_VERIFY,
530 (TSTR("Checkpoint block count wrong dev %d count %d"TENDSTR),
531 dev->blocksInCheckpoint, nBlocksPerState[YAFFS_BLOCK_STATE_CHECKPOINT]));
533 if (dev->nErasedBlocks != nBlocksPerState[YAFFS_BLOCK_STATE_EMPTY])
534 T(YAFFS_TRACE_VERIFY,
535 (TSTR("Erased block count wrong dev %d count %d"TENDSTR),
536 dev->nErasedBlocks, nBlocksPerState[YAFFS_BLOCK_STATE_EMPTY]));
538 if (nBlocksPerState[YAFFS_BLOCK_STATE_COLLECTING] > 1)
539 T(YAFFS_TRACE_VERIFY,
540 (TSTR("Too many collecting blocks %d (max is 1)"TENDSTR),
541 nBlocksPerState[YAFFS_BLOCK_STATE_COLLECTING]));
543 T(YAFFS_TRACE_VERIFY, (TSTR(""TENDSTR)));
548 * Verify the object header. oh must be valid, but obj and tags may be NULL in which
549 * case those tests will not be performed.
551 static void yaffs_VerifyObjectHeader(yaffs_Object *obj, yaffs_ObjectHeader *oh, yaffs_ExtendedTags *tags, int parentCheck)
553 if (obj && yaffs_SkipVerification(obj->myDev))
556 if (!(tags && obj && oh)) {
557 T(YAFFS_TRACE_VERIFY,
558 (TSTR("Verifying object header tags %p obj %p oh %p"TENDSTR),
563 if (oh->type <= YAFFS_OBJECT_TYPE_UNKNOWN ||
564 oh->type > YAFFS_OBJECT_TYPE_MAX)
565 T(YAFFS_TRACE_VERIFY,
566 (TSTR("Obj %d header type is illegal value 0x%x"TENDSTR),
567 tags->objectId, oh->type));
569 if (tags->objectId != obj->objectId)
570 T(YAFFS_TRACE_VERIFY,
571 (TSTR("Obj %d header mismatch objectId %d"TENDSTR),
572 tags->objectId, obj->objectId));
576 * Check that the object's parent ids match if parentCheck requested.
578 * Tests do not apply to the root object.
581 if (parentCheck && tags->objectId > 1 && !obj->parent)
582 T(YAFFS_TRACE_VERIFY,
583 (TSTR("Obj %d header mismatch parentId %d obj->parent is NULL"TENDSTR),
584 tags->objectId, oh->parentObjectId));
586 if (parentCheck && obj->parent &&
587 oh->parentObjectId != obj->parent->objectId &&
588 (oh->parentObjectId != YAFFS_OBJECTID_UNLINKED ||
589 obj->parent->objectId != YAFFS_OBJECTID_DELETED))
590 T(YAFFS_TRACE_VERIFY,
591 (TSTR("Obj %d header mismatch parentId %d parentObjectId %d"TENDSTR),
592 tags->objectId, oh->parentObjectId, obj->parent->objectId));
594 if (tags->objectId > 1 && oh->name[0] == 0) /* Null name */
595 T(YAFFS_TRACE_VERIFY,
596 (TSTR("Obj %d header name is NULL"TENDSTR),
599 if (tags->objectId > 1 && ((__u8)(oh->name[0])) == 0xff) /* Trashed name */
600 T(YAFFS_TRACE_VERIFY,
601 (TSTR("Obj %d header name is 0xFF"TENDSTR),
607 static int yaffs_VerifyTnodeWorker(yaffs_Object *obj, yaffs_Tnode *tn,
608 __u32 level, int chunkOffset)
611 yaffs_Device *dev = obj->myDev;
617 for (i = 0; i < YAFFS_NTNODES_INTERNAL && ok; i++) {
618 if (tn->internal[i]) {
619 ok = yaffs_VerifyTnodeWorker(obj,
622 (chunkOffset<<YAFFS_TNODES_INTERNAL_BITS) + i);
625 } else if (level == 0) {
626 yaffs_ExtendedTags tags;
627 __u32 objectId = obj->objectId;
629 chunkOffset <<= YAFFS_TNODES_LEVEL0_BITS;
631 for (i = 0; i < YAFFS_NTNODES_LEVEL0; i++) {
632 __u32 theChunk = yaffs_GetChunkGroupBase(dev, tn, i);
635 /* T(~0,(TSTR("verifying (%d:%d) %d"TENDSTR),tags.objectId,tags.chunkId,theChunk)); */
636 yaffs_ReadChunkWithTagsFromNAND(dev, theChunk, NULL, &tags);
637 if (tags.objectId != objectId || tags.chunkId != chunkOffset) {
638 T(~0, (TSTR("Object %d chunkId %d NAND mismatch chunk %d tags (%d:%d)"TENDSTR),
639 objectId, chunkOffset, theChunk,
640 tags.objectId, tags.chunkId));
653 static void yaffs_VerifyFile(yaffs_Object *obj)
655 int requiredTallness;
661 yaffs_ExtendedTags tags;
668 if (yaffs_SkipVerification(obj->myDev))
672 objectId = obj->objectId;
674 /* Check file size is consistent with tnode depth */
675 lastChunk = obj->variant.fileVariant.fileSize / dev->nDataBytesPerChunk + 1;
676 x = lastChunk >> YAFFS_TNODES_LEVEL0_BITS;
677 requiredTallness = 0;
679 x >>= YAFFS_TNODES_INTERNAL_BITS;
683 actualTallness = obj->variant.fileVariant.topLevel;
685 /* Check that the chunks in the tnode tree are all correct.
686 * We do this by scanning through the tnode tree and
687 * checking the tags for every chunk match.
690 if (yaffs_SkipNANDVerification(dev))
693 for (i = 1; i <= lastChunk; i++) {
694 tn = yaffs_FindLevel0Tnode(dev, &obj->variant.fileVariant, i);
697 __u32 theChunk = yaffs_GetChunkGroupBase(dev, tn, i);
699 /* T(~0,(TSTR("verifying (%d:%d) %d"TENDSTR),objectId,i,theChunk)); */
700 yaffs_ReadChunkWithTagsFromNAND(dev, theChunk, NULL, &tags);
701 if (tags.objectId != objectId || tags.chunkId != i) {
702 T(~0, (TSTR("Object %d chunkId %d NAND mismatch chunk %d tags (%d:%d)"TENDSTR),
703 objectId, i, theChunk,
704 tags.objectId, tags.chunkId));
712 static void yaffs_VerifyHardLink(yaffs_Object *obj)
714 if (obj && yaffs_SkipVerification(obj->myDev))
717 /* Verify sane equivalent object */
720 static void yaffs_VerifySymlink(yaffs_Object *obj)
722 if (obj && yaffs_SkipVerification(obj->myDev))
725 /* Verify symlink string */
728 static void yaffs_VerifySpecial(yaffs_Object *obj)
730 if (obj && yaffs_SkipVerification(obj->myDev))
734 static void yaffs_VerifyObject(yaffs_Object *obj)
743 __u32 chunkShouldNotBeDeleted;
749 if (obj->beingCreated)
754 if (yaffs_SkipVerification(dev))
757 /* Check sane object header chunk */
759 chunkMin = dev->internalStartBlock * dev->param.nChunksPerBlock;
760 chunkMax = (dev->internalEndBlock+1) * dev->param.nChunksPerBlock - 1;
762 chunkInRange = (((unsigned)(obj->hdrChunk)) >= chunkMin && ((unsigned)(obj->hdrChunk)) <= chunkMax);
763 chunkIdOk = chunkInRange || (obj->hdrChunk == 0);
764 chunkValid = chunkInRange &&
765 yaffs_CheckChunkBit(dev,
766 obj->hdrChunk / dev->param.nChunksPerBlock,
767 obj->hdrChunk % dev->param.nChunksPerBlock);
768 chunkShouldNotBeDeleted = chunkInRange && !chunkValid;
771 (!chunkIdOk || chunkShouldNotBeDeleted)) {
772 T(YAFFS_TRACE_VERIFY,
773 (TSTR("Obj %d has chunkId %d %s %s"TENDSTR),
774 obj->objectId, obj->hdrChunk,
775 chunkIdOk ? "" : ",out of range",
776 chunkShouldNotBeDeleted ? ",marked as deleted" : ""));
779 if (chunkValid && !yaffs_SkipNANDVerification(dev)) {
780 yaffs_ExtendedTags tags;
781 yaffs_ObjectHeader *oh;
782 __u8 *buffer = yaffs_GetTempBuffer(dev, __LINE__);
784 oh = (yaffs_ObjectHeader *)buffer;
786 yaffs_ReadChunkWithTagsFromNAND(dev, obj->hdrChunk, buffer,
789 yaffs_VerifyObjectHeader(obj, oh, &tags, 1);
791 yaffs_ReleaseTempBuffer(dev, buffer, __LINE__);
794 /* Verify it has a parent */
795 if (obj && !obj->fake &&
796 (!obj->parent || obj->parent->myDev != dev)) {
797 T(YAFFS_TRACE_VERIFY,
798 (TSTR("Obj %d has parent pointer %p which does not look like an object"TENDSTR),
799 obj->objectId, obj->parent));
802 /* Verify parent is a directory */
803 if (obj->parent && obj->parent->variantType != YAFFS_OBJECT_TYPE_DIRECTORY) {
804 T(YAFFS_TRACE_VERIFY,
805 (TSTR("Obj %d's parent is not a directory (type %d)"TENDSTR),
806 obj->objectId, obj->parent->variantType));
809 switch (obj->variantType) {
810 case YAFFS_OBJECT_TYPE_FILE:
811 yaffs_VerifyFile(obj);
813 case YAFFS_OBJECT_TYPE_SYMLINK:
814 yaffs_VerifySymlink(obj);
816 case YAFFS_OBJECT_TYPE_DIRECTORY:
817 yaffs_VerifyDirectory(obj);
819 case YAFFS_OBJECT_TYPE_HARDLINK:
820 yaffs_VerifyHardLink(obj);
822 case YAFFS_OBJECT_TYPE_SPECIAL:
823 yaffs_VerifySpecial(obj);
825 case YAFFS_OBJECT_TYPE_UNKNOWN:
827 T(YAFFS_TRACE_VERIFY,
828 (TSTR("Obj %d has illegaltype %d"TENDSTR),
829 obj->objectId, obj->variantType));
834 static void yaffs_VerifyObjects(yaffs_Device *dev)
838 struct ylist_head *lh;
840 if (yaffs_SkipVerification(dev))
843 /* Iterate through the objects in each hash entry */
845 for (i = 0; i < YAFFS_NOBJECT_BUCKETS; i++) {
846 ylist_for_each(lh, &dev->objectBucket[i].list) {
848 obj = ylist_entry(lh, yaffs_Object, hashLink);
849 yaffs_VerifyObject(obj);
857 * Simple hash function. Needs to have a reasonable spread
860 static Y_INLINE int yaffs_HashFunction(int n)
863 return n % YAFFS_NOBJECT_BUCKETS;
867 * Access functions to useful fake objects.
868 * Note that root might have a presence in NAND if permissions are set.
871 yaffs_Object *yaffs_Root(yaffs_Device *dev)
876 yaffs_Object *yaffs_LostNFound(yaffs_Device *dev)
878 return dev->lostNFoundDir;
883 * Erased NAND checking functions
886 int yaffs_CheckFF(__u8 *buffer, int nBytes)
888 /* Horrible, slow implementation */
897 static int yaffs_CheckChunkErased(struct yaffs_DeviceStruct *dev,
900 int retval = YAFFS_OK;
901 __u8 *data = yaffs_GetTempBuffer(dev, __LINE__);
902 yaffs_ExtendedTags tags;
905 result = yaffs_ReadChunkWithTagsFromNAND(dev, chunkInNAND, data, &tags);
907 if (tags.eccResult > YAFFS_ECC_RESULT_NO_ERROR)
910 if (!yaffs_CheckFF(data, dev->nDataBytesPerChunk) || tags.chunkUsed) {
911 T(YAFFS_TRACE_NANDACCESS,
912 (TSTR("Chunk %d not erased" TENDSTR), chunkInNAND));
916 yaffs_ReleaseTempBuffer(dev, data, __LINE__);
923 static int yaffs_VerifyChunkWritten(yaffs_Device *dev,
926 yaffs_ExtendedTags *tags)
928 int retval = YAFFS_OK;
929 yaffs_ExtendedTags tempTags;
930 __u8 *buffer = yaffs_GetTempBuffer(dev,__LINE__);
933 result = yaffs_ReadChunkWithTagsFromNAND(dev,chunkInNAND,buffer,&tempTags);
934 if(memcmp(buffer,data,dev->nDataBytesPerChunk) ||
935 tempTags.objectId != tags->objectId ||
936 tempTags.chunkId != tags->chunkId ||
937 tempTags.byteCount != tags->byteCount)
940 yaffs_ReleaseTempBuffer(dev, buffer, __LINE__);
945 static int yaffs_WriteNewChunkWithTagsToNAND(struct yaffs_DeviceStruct *dev,
947 yaffs_ExtendedTags *tags,
954 yaffs_InvalidateCheckpoint(dev);
957 yaffs_BlockInfo *bi = 0;
960 chunk = yaffs_AllocateChunk(dev, useReserve, &bi);
966 /* First check this chunk is erased, if it needs
967 * checking. The checking policy (unless forced
968 * always on) is as follows:
970 * Check the first page we try to write in a block.
971 * If the check passes then we don't need to check any
972 * more. If the check fails, we check again...
973 * If the block has been erased, we don't need to check.
975 * However, if the block has been prioritised for gc,
976 * then we think there might be something odd about
977 * this block and stop using it.
979 * Rationale: We should only ever see chunks that have
980 * not been erased if there was a partially written
981 * chunk due to power loss. This checking policy should
982 * catch that case with very few checks and thus save a
983 * lot of checks that are most likely not needed.
986 * If an erase check fails or the write fails we skip the
990 /* let's give it a try */
993 #ifdef CONFIG_YAFFS_ALWAYS_CHECK_CHUNK_ERASED
994 bi->skipErasedCheck = 0;
996 if (!bi->skipErasedCheck) {
997 erasedOk = yaffs_CheckChunkErased(dev, chunk);
998 if (erasedOk != YAFFS_OK) {
1000 (TSTR("**>> yaffs chunk %d was not erased"
1003 /* If not erased, delete this one,
1004 * skip rest of block and
1005 * try another chunk */
1006 yaffs_DeleteChunk(dev,chunk,1,__LINE__);
1007 yaffs_SkipRestOfBlock(dev);
1012 writeOk = yaffs_WriteChunkWithTagsToNAND(dev, chunk,
1015 if(!bi->skipErasedCheck)
1016 writeOk = yaffs_VerifyChunkWritten(dev, chunk, data, tags);
1018 if (writeOk != YAFFS_OK) {
1019 /* Clean up aborted write, skip to next block and
1020 * try another chunk */
1021 yaffs_HandleWriteChunkError(dev, chunk, erasedOk);
1025 bi->skipErasedCheck = 1;
1027 /* Copy the data into the robustification buffer */
1028 yaffs_HandleWriteChunkOk(dev, chunk, data, tags);
1030 } while (writeOk != YAFFS_OK &&
1031 (yaffs_wr_attempts <= 0 || attempts <= yaffs_wr_attempts));
1037 T(YAFFS_TRACE_ERROR,
1038 (TSTR("**>> yaffs write required %d attempts" TENDSTR),
1041 dev->nRetriedWrites += (attempts - 1);
1048 * Block retiring for handling a broken block.
1051 static void yaffs_RetireBlock(yaffs_Device *dev, int blockInNAND)
1053 yaffs_BlockInfo *bi = yaffs_GetBlockInfo(dev, blockInNAND);
1055 yaffs_InvalidateCheckpoint(dev);
1057 if (yaffs_MarkBlockBad(dev, blockInNAND) != YAFFS_OK) {
1058 if (yaffs_EraseBlockInNAND(dev, blockInNAND) != YAFFS_OK) {
1059 T(YAFFS_TRACE_ALWAYS, (TSTR(
1060 "yaffs: Failed to mark bad and erase block %d"
1061 TENDSTR), blockInNAND));
1063 yaffs_ExtendedTags tags;
1064 int chunkId = blockInNAND * dev->param.nChunksPerBlock;
1066 __u8 *buffer = yaffs_GetTempBuffer(dev, __LINE__);
1068 memset(buffer, 0xff, dev->nDataBytesPerChunk);
1069 yaffs_InitialiseTags(&tags);
1070 tags.sequenceNumber = YAFFS_SEQUENCE_BAD_BLOCK;
1071 if (dev->param.writeChunkWithTagsToNAND(dev, chunkId -
1072 dev->chunkOffset, buffer, &tags) != YAFFS_OK)
1073 T(YAFFS_TRACE_ALWAYS, (TSTR("yaffs: Failed to "
1074 TCONT("write bad block marker to block %d")
1075 TENDSTR), blockInNAND));
1077 yaffs_ReleaseTempBuffer(dev, buffer, __LINE__);
1081 bi->blockState = YAFFS_BLOCK_STATE_DEAD;
1082 bi->gcPrioritise = 0;
1083 bi->needsRetiring = 0;
1085 dev->nRetiredBlocks++;
1089 * Functions for robustisizing TODO
1093 static void yaffs_HandleWriteChunkOk(yaffs_Device *dev, int chunkInNAND,
1095 const yaffs_ExtendedTags *tags)
1099 static void yaffs_HandleUpdateChunk(yaffs_Device *dev, int chunkInNAND,
1100 const yaffs_ExtendedTags *tags)
1104 void yaffs_HandleChunkError(yaffs_Device *dev, yaffs_BlockInfo *bi)
1106 if (!bi->gcPrioritise) {
1107 bi->gcPrioritise = 1;
1108 dev->hasPendingPrioritisedGCs = 1;
1109 bi->chunkErrorStrikes++;
1111 if (bi->chunkErrorStrikes > 3) {
1112 bi->needsRetiring = 1; /* Too many stikes, so retire this */
1113 T(YAFFS_TRACE_ALWAYS, (TSTR("yaffs: Block struck out" TENDSTR)));
1119 static void yaffs_HandleWriteChunkError(yaffs_Device *dev, int chunkInNAND,
1122 int blockInNAND = chunkInNAND / dev->param.nChunksPerBlock;
1123 yaffs_BlockInfo *bi = yaffs_GetBlockInfo(dev, blockInNAND);
1125 yaffs_HandleChunkError(dev, bi);
1128 /* Was an actual write failure, so mark the block for retirement */
1129 bi->needsRetiring = 1;
1130 T(YAFFS_TRACE_ERROR | YAFFS_TRACE_BAD_BLOCKS,
1131 (TSTR("**>> Block %d needs retiring" TENDSTR), blockInNAND));
1134 /* Delete the chunk */
1135 yaffs_DeleteChunk(dev, chunkInNAND, 1, __LINE__);
1136 yaffs_SkipRestOfBlock(dev);
1140 /*---------------- Name handling functions ------------*/
1142 static __u16 yaffs_CalcNameSum(const YCHAR *name)
1147 const YUCHAR *bname = (const YUCHAR *) name;
1149 while ((*bname) && (i < (YAFFS_MAX_NAME_LENGTH/2))) {
1151 #ifdef CONFIG_YAFFS_CASE_INSENSITIVE
1152 sum += yaffs_toupper(*bname) * i;
1154 sum += (*bname) * i;
1163 static void yaffs_SetObjectName(yaffs_Object *obj, const YCHAR *name)
1165 #ifdef CONFIG_YAFFS_SHORT_NAMES_IN_RAM
1166 memset(obj->shortName, 0, sizeof(YCHAR) * (YAFFS_SHORT_NAME_LENGTH+1));
1167 if (name && yaffs_strnlen(name,YAFFS_SHORT_NAME_LENGTH+1) <= YAFFS_SHORT_NAME_LENGTH)
1168 yaffs_strcpy(obj->shortName, name);
1170 obj->shortName[0] = _Y('\0');
1172 obj->sum = yaffs_CalcNameSum(name);
1175 /*-------------------- TNODES -------------------
1177 * List of spare tnodes
1178 * The list is hooked together using the first pointer
1182 /* yaffs_CreateTnodes creates a bunch more tnodes and
1183 * adds them to the tnode free list.
1184 * Don't use this function directly
1186 static Y_INLINE int yaffs_CalcTnodeSize(yaffs_Device *dev)
1189 /* Calculate the tnode size in bytes for variable width tnode support.
1190 * Must be a multiple of 32-bits */
1191 tnodeSize = (dev->tnodeWidth * YAFFS_NTNODES_LEVEL0)/8;
1193 if (tnodeSize < sizeof(yaffs_Tnode))
1194 tnodeSize = sizeof(yaffs_Tnode);
1198 static int yaffs_CreateTnodes(yaffs_Device *dev, int nTnodes)
1201 int tnodeSize = yaffs_CalcTnodeSize(dev);
1202 yaffs_Tnode *newTnodes;
1206 yaffs_TnodeList *tnl;
1212 /* make these things */
1214 newTnodes = YMALLOC(nTnodes * tnodeSize);
1215 mem = (__u8 *)newTnodes;
1218 T(YAFFS_TRACE_ERROR,
1219 (TSTR("yaffs: Could not allocate Tnodes" TENDSTR)));
1223 /* Hook them into the free list */
1225 for (i = 0; i < nTnodes - 1; i++) {
1226 newTnodes[i].internal[0] = &newTnodes[i + 1];
1227 #ifdef CONFIG_YAFFS_TNODE_LIST_DEBUG
1228 newTnodes[i].internal[YAFFS_NTNODES_INTERNAL] = (void *)1;
1232 newTnodes[nTnodes - 1].internal[0] = dev->freeTnodes;
1233 #ifdef CONFIG_YAFFS_TNODE_LIST_DEBUG
1234 newTnodes[nTnodes - 1].internal[YAFFS_NTNODES_INTERNAL] = (void *)1;
1236 dev->freeTnodes = newTnodes;
1238 /* New hookup for wide tnodes */
1239 for (i = 0; i < nTnodes - 1; i++) {
1240 curr = (yaffs_Tnode *) &mem[i * tnodeSize];
1241 next = (yaffs_Tnode *) &mem[(i+1) * tnodeSize];
1242 curr->internal[0] = next;
1245 curr = (yaffs_Tnode *) &mem[(nTnodes - 1) * tnodeSize];
1246 curr->internal[0] = dev->freeTnodes;
1247 dev->freeTnodes = (yaffs_Tnode *)mem;
1252 dev->nFreeTnodes += nTnodes;
1253 dev->nTnodesCreated += nTnodes;
1255 /* Now add this bunch of tnodes to a list for freeing up.
1256 * NB If we can't add this to the management list it isn't fatal
1257 * but it just means we can't free this bunch of tnodes later.
1260 tnl = YMALLOC(sizeof(yaffs_TnodeList));
1262 T(YAFFS_TRACE_ERROR,
1264 ("yaffs: Could not add tnodes to management list" TENDSTR)));
1267 tnl->tnodes = newTnodes;
1268 tnl->next = dev->allocatedTnodeList;
1269 dev->allocatedTnodeList = tnl;
1272 T(YAFFS_TRACE_ALLOCATE, (TSTR("yaffs: Tnodes added" TENDSTR)));
1277 /* GetTnode gets us a clean tnode. Tries to make allocate more if we run out */
1279 static yaffs_Tnode *yaffs_GetTnodeRaw(yaffs_Device *dev)
1281 yaffs_Tnode *tn = NULL;
1283 #ifdef CONFIG_YAFFS_VALGRIND_TEST
1284 tn = YMALLOC(yaffs_CalcTnodeSize(dev));
1286 dev->nTnodesCreated++;
1288 /* If there are none left make more */
1289 if (!dev->freeTnodes)
1290 yaffs_CreateTnodes(dev, YAFFS_ALLOCATION_NTNODES);
1292 if (dev->freeTnodes) {
1293 tn = dev->freeTnodes;
1294 #ifdef CONFIG_YAFFS_TNODE_LIST_DEBUG
1295 if (tn->internal[YAFFS_NTNODES_INTERNAL] != (void *)1) {
1296 /* Hoosterman, this thing looks like it isn't in the list */
1297 T(YAFFS_TRACE_ALWAYS,
1298 (TSTR("yaffs: Tnode list bug 1" TENDSTR)));
1301 dev->freeTnodes = dev->freeTnodes->internal[0];
1305 dev->nCheckpointBlocksRequired = 0; /* force recalculation*/
1310 static yaffs_Tnode *yaffs_GetTnode(yaffs_Device *dev)
1312 yaffs_Tnode *tn = yaffs_GetTnodeRaw(dev);
1313 int tnodeSize = yaffs_CalcTnodeSize(dev);
1316 memset(tn, 0, tnodeSize);
1321 /* FreeTnode frees up a tnode and puts it back on the free list */
1322 static void yaffs_FreeTnode(yaffs_Device *dev, yaffs_Tnode *tn)
1325 #ifdef CONFIG_YAFFS_VALGRIND_TEST
1327 dev->nTnodesCreated--;
1329 #ifdef CONFIG_YAFFS_TNODE_LIST_DEBUG
1330 if (tn->internal[YAFFS_NTNODES_INTERNAL] != 0) {
1331 /* Hoosterman, this thing looks like it is already in the list */
1332 T(YAFFS_TRACE_ALWAYS,
1333 (TSTR("yaffs: Tnode list bug 2" TENDSTR)));
1335 tn->internal[YAFFS_NTNODES_INTERNAL] = (void *)1;
1337 tn->internal[0] = dev->freeTnodes;
1338 dev->freeTnodes = tn;
1342 dev->nCheckpointBlocksRequired = 0; /* force recalculation*/
1345 static void yaffs_DeinitialiseTnodes(yaffs_Device *dev)
1347 /* Free the list of allocated tnodes */
1348 yaffs_TnodeList *tmp;
1350 while (dev->allocatedTnodeList) {
1351 tmp = dev->allocatedTnodeList->next;
1353 YFREE(dev->allocatedTnodeList->tnodes);
1354 YFREE(dev->allocatedTnodeList);
1355 dev->allocatedTnodeList = tmp;
1359 dev->freeTnodes = NULL;
1360 dev->nFreeTnodes = 0;
1361 dev->nTnodesCreated = 0;
1364 static void yaffs_InitialiseTnodes(yaffs_Device *dev)
1366 dev->allocatedTnodeList = NULL;
1367 dev->freeTnodes = NULL;
1368 dev->nFreeTnodes = 0;
1369 dev->nTnodesCreated = 0;
1373 void yaffs_LoadLevel0Tnode(yaffs_Device *dev, yaffs_Tnode *tn, unsigned pos,
1376 __u32 *map = (__u32 *)tn;
1382 pos &= YAFFS_TNODES_LEVEL0_MASK;
1383 val >>= dev->chunkGroupBits;
1385 bitInMap = pos * dev->tnodeWidth;
1386 wordInMap = bitInMap / 32;
1387 bitInWord = bitInMap & (32 - 1);
1389 mask = dev->tnodeMask << bitInWord;
1391 map[wordInMap] &= ~mask;
1392 map[wordInMap] |= (mask & (val << bitInWord));
1394 if (dev->tnodeWidth > (32 - bitInWord)) {
1395 bitInWord = (32 - bitInWord);
1397 mask = dev->tnodeMask >> (/*dev->tnodeWidth -*/ bitInWord);
1398 map[wordInMap] &= ~mask;
1399 map[wordInMap] |= (mask & (val >> bitInWord));
1403 static __u32 yaffs_GetChunkGroupBase(yaffs_Device *dev, yaffs_Tnode *tn,
1406 __u32 *map = (__u32 *)tn;
1412 pos &= YAFFS_TNODES_LEVEL0_MASK;
1414 bitInMap = pos * dev->tnodeWidth;
1415 wordInMap = bitInMap / 32;
1416 bitInWord = bitInMap & (32 - 1);
1418 val = map[wordInMap] >> bitInWord;
1420 if (dev->tnodeWidth > (32 - bitInWord)) {
1421 bitInWord = (32 - bitInWord);
1423 val |= (map[wordInMap] << bitInWord);
1426 val &= dev->tnodeMask;
1427 val <<= dev->chunkGroupBits;
1432 /* ------------------- End of individual tnode manipulation -----------------*/
1434 /* ---------Functions to manipulate the look-up tree (made up of tnodes) ------
1435 * The look up tree is represented by the top tnode and the number of topLevel
1436 * in the tree. 0 means only the level 0 tnode is in the tree.
1439 /* FindLevel0Tnode finds the level 0 tnode, if one exists. */
1440 static yaffs_Tnode *yaffs_FindLevel0Tnode(yaffs_Device *dev,
1441 yaffs_FileStructure *fStruct,
1444 yaffs_Tnode *tn = fStruct->top;
1446 int requiredTallness;
1447 int level = fStruct->topLevel;
1449 /* Check sane level and chunk Id */
1450 if (level < 0 || level > YAFFS_TNODES_MAX_LEVEL)
1453 if (chunkId > YAFFS_MAX_CHUNK_ID)
1456 /* First check we're tall enough (ie enough topLevel) */
1458 i = chunkId >> YAFFS_TNODES_LEVEL0_BITS;
1459 requiredTallness = 0;
1461 i >>= YAFFS_TNODES_INTERNAL_BITS;
1465 if (requiredTallness > fStruct->topLevel)
1466 return NULL; /* Not tall enough, so we can't find it */
1468 /* Traverse down to level 0 */
1469 while (level > 0 && tn) {
1470 tn = tn->internal[(chunkId >>
1471 (YAFFS_TNODES_LEVEL0_BITS +
1473 YAFFS_TNODES_INTERNAL_BITS)) &
1474 YAFFS_TNODES_INTERNAL_MASK];
1481 /* AddOrFindLevel0Tnode finds the level 0 tnode if it exists, otherwise first expands the tree.
1482 * This happens in two steps:
1483 * 1. If the tree isn't tall enough, then make it taller.
1484 * 2. Scan down the tree towards the level 0 tnode adding tnodes if required.
1486 * Used when modifying the tree.
1488 * If the tn argument is NULL, then a fresh tnode will be added otherwise the specified tn will
1489 * be plugged into the ttree.
1492 static yaffs_Tnode *yaffs_AddOrFindLevel0Tnode(yaffs_Device *dev,
1493 yaffs_FileStructure *fStruct,
1495 yaffs_Tnode *passedTn)
1497 int requiredTallness;
1505 /* Check sane level and page Id */
1506 if (fStruct->topLevel < 0 || fStruct->topLevel > YAFFS_TNODES_MAX_LEVEL)
1509 if (chunkId > YAFFS_MAX_CHUNK_ID)
1512 /* First check we're tall enough (ie enough topLevel) */
1514 x = chunkId >> YAFFS_TNODES_LEVEL0_BITS;
1515 requiredTallness = 0;
1517 x >>= YAFFS_TNODES_INTERNAL_BITS;
1522 if (requiredTallness > fStruct->topLevel) {
1523 /* Not tall enough, gotta make the tree taller */
1524 for (i = fStruct->topLevel; i < requiredTallness; i++) {
1526 tn = yaffs_GetTnode(dev);
1529 tn->internal[0] = fStruct->top;
1531 fStruct->topLevel++;
1533 T(YAFFS_TRACE_ERROR,
1534 (TSTR("yaffs: no more tnodes" TENDSTR)));
1540 /* Traverse down to level 0, adding anything we need */
1542 l = fStruct->topLevel;
1546 while (l > 0 && tn) {
1548 (YAFFS_TNODES_LEVEL0_BITS +
1549 (l - 1) * YAFFS_TNODES_INTERNAL_BITS)) &
1550 YAFFS_TNODES_INTERNAL_MASK;
1553 if ((l > 1) && !tn->internal[x]) {
1554 /* Add missing non-level-zero tnode */
1555 tn->internal[x] = yaffs_GetTnode(dev);
1556 if(!tn->internal[x])
1558 } else if (l == 1) {
1559 /* Looking from level 1 at level 0 */
1561 /* If we already have one, then release it.*/
1562 if (tn->internal[x])
1563 yaffs_FreeTnode(dev, tn->internal[x]);
1564 tn->internal[x] = passedTn;
1566 } else if (!tn->internal[x]) {
1567 /* Don't have one, none passed in */
1568 tn->internal[x] = yaffs_GetTnode(dev);
1569 if(!tn->internal[x])
1574 tn = tn->internal[x];
1578 /* top is level 0 */
1580 memcpy(tn, passedTn, (dev->tnodeWidth * YAFFS_NTNODES_LEVEL0)/8);
1581 yaffs_FreeTnode(dev, passedTn);
1588 static int yaffs_FindChunkInGroup(yaffs_Device *dev, int theChunk,
1589 yaffs_ExtendedTags *tags, int objectId,
1594 for (j = 0; theChunk && j < dev->chunkGroupSize; j++) {
1595 if (yaffs_CheckChunkBit(dev, theChunk / dev->param.nChunksPerBlock,
1596 theChunk % dev->param.nChunksPerBlock)) {
1598 if(dev->chunkGroupSize == 1)
1601 yaffs_ReadChunkWithTagsFromNAND(dev, theChunk, NULL,
1603 if (yaffs_TagsMatch(tags, objectId, chunkInInode)) {
1615 /* DeleteWorker scans backwards through the tnode tree and deletes all the
1616 * chunks and tnodes in the file
1617 * Returns 1 if the tree was deleted.
1618 * Returns 0 if it stopped early due to hitting the limit and the delete is incomplete.
1621 static int yaffs_DeleteWorker(yaffs_Object *in, yaffs_Tnode *tn, __u32 level,
1622 int chunkOffset, int *limit)
1627 yaffs_ExtendedTags tags;
1629 yaffs_Device *dev = in->myDev;
1635 for (i = YAFFS_NTNODES_INTERNAL - 1; allDone && i >= 0;
1637 if (tn->internal[i]) {
1638 if (limit && (*limit) < 0) {
1642 yaffs_DeleteWorker(in,
1650 YAFFS_TNODES_INTERNAL_BITS)
1655 yaffs_FreeTnode(dev,
1658 tn->internal[i] = NULL;
1662 return (allDone) ? 1 : 0;
1663 } else if (level == 0) {
1666 for (i = YAFFS_NTNODES_LEVEL0 - 1; i >= 0 && !hitLimit;
1668 theChunk = yaffs_GetChunkGroupBase(dev, tn, i);
1671 chunkInInode = (chunkOffset <<
1672 YAFFS_TNODES_LEVEL0_BITS) + i;
1675 yaffs_FindChunkInGroup(dev,
1681 if (foundChunk > 0) {
1682 yaffs_DeleteChunk(dev,
1687 *limit = *limit - 1;
1694 yaffs_LoadLevel0Tnode(dev, tn, i, 0);
1698 return (i < 0) ? 1 : 0;
1708 static void yaffs_SoftDeleteChunk(yaffs_Device *dev, int chunk)
1710 yaffs_BlockInfo *theBlock;
1712 T(YAFFS_TRACE_DELETION, (TSTR("soft delete chunk %d" TENDSTR), chunk));
1714 theBlock = yaffs_GetBlockInfo(dev, chunk / dev->param.nChunksPerBlock);
1716 theBlock->softDeletions++;
1721 /* SoftDeleteWorker scans backwards through the tnode tree and soft deletes all the chunks in the file.
1722 * All soft deleting does is increment the block's softdelete count and pulls the chunk out
1724 * Thus, essentially this is the same as DeleteWorker except that the chunks are soft deleted.
1727 static int yaffs_SoftDeleteWorker(yaffs_Object *in, yaffs_Tnode *tn,
1728 __u32 level, int chunkOffset)
1733 yaffs_Device *dev = in->myDev;
1738 for (i = YAFFS_NTNODES_INTERNAL - 1; allDone && i >= 0;
1740 if (tn->internal[i]) {
1742 yaffs_SoftDeleteWorker(in,
1748 YAFFS_TNODES_INTERNAL_BITS)
1751 yaffs_FreeTnode(dev,
1754 tn->internal[i] = NULL;
1756 /* Hoosterman... how could this happen? */
1760 return (allDone) ? 1 : 0;
1761 } else if (level == 0) {
1763 for (i = YAFFS_NTNODES_LEVEL0 - 1; i >= 0; i--) {
1764 theChunk = yaffs_GetChunkGroupBase(dev, tn, i);
1766 /* Note this does not find the real chunk, only the chunk group.
1767 * We make an assumption that a chunk group is not larger than
1770 yaffs_SoftDeleteChunk(dev, theChunk);
1771 yaffs_LoadLevel0Tnode(dev, tn, i, 0);
1785 static void yaffs_SoftDeleteFile(yaffs_Object *obj)
1788 obj->variantType == YAFFS_OBJECT_TYPE_FILE && !obj->softDeleted) {
1789 if (obj->nDataChunks <= 0) {
1790 /* Empty file with no duplicate object headers, just delete it immediately */
1791 yaffs_FreeTnode(obj->myDev,
1792 obj->variant.fileVariant.top);
1793 obj->variant.fileVariant.top = NULL;
1794 T(YAFFS_TRACE_TRACING,
1795 (TSTR("yaffs: Deleting empty file %d" TENDSTR),
1797 yaffs_DoGenericObjectDeletion(obj);
1799 yaffs_SoftDeleteWorker(obj,
1800 obj->variant.fileVariant.top,
1801 obj->variant.fileVariant.
1803 obj->softDeleted = 1;
1808 /* Pruning removes any part of the file structure tree that is beyond the
1809 * bounds of the file (ie that does not point to chunks).
1811 * A file should only get pruned when its size is reduced.
1813 * Before pruning, the chunks must be pulled from the tree and the
1814 * level 0 tnode entries must be zeroed out.
1815 * Could also use this for file deletion, but that's probably better handled
1816 * by a special case.
1818 * This function is recursive. For levels > 0 the function is called again on
1819 * any sub-tree. For level == 0 we just check if the sub-tree has data.
1820 * If there is no data in a subtree then it is pruned.
1823 static yaffs_Tnode *yaffs_PruneWorker(yaffs_Device *dev, yaffs_Tnode *tn,
1824 __u32 level, int del0)
1833 for (i = 0; i < YAFFS_NTNODES_INTERNAL; i++) {
1834 if (tn->internal[i]) {
1836 yaffs_PruneWorker(dev, tn->internal[i],
1838 (i == 0) ? del0 : 1);
1841 if (tn->internal[i])
1845 int tnodeSize_u32 = yaffs_CalcTnodeSize(dev)/sizeof(__u32);
1846 __u32 *map = (__u32 *)tn;
1848 for(i = 0; !hasData && i < tnodeSize_u32; i++){
1854 if (hasData == 0 && del0) {
1855 /* Free and return NULL */
1857 yaffs_FreeTnode(dev, tn);
1867 static int yaffs_PruneFileStructure(yaffs_Device *dev,
1868 yaffs_FileStructure *fStruct)
1875 if (fStruct->topLevel > 0) {
1877 yaffs_PruneWorker(dev, fStruct->top, fStruct->topLevel, 0);
1879 /* Now we have a tree with all the non-zero branches NULL but the height
1880 * is the same as it was.
1881 * Let's see if we can trim internal tnodes to shorten the tree.
1882 * We can do this if only the 0th element in the tnode is in use
1883 * (ie all the non-zero are NULL)
1886 while (fStruct->topLevel && !done) {
1890 for (i = 1; i < YAFFS_NTNODES_INTERNAL; i++) {
1891 if (tn->internal[i])
1896 fStruct->top = tn->internal[0];
1897 fStruct->topLevel--;
1898 yaffs_FreeTnode(dev, tn);
1908 /*-------------------- End of File Structure functions.-------------------*/
1910 /* yaffs_CreateFreeObjects creates a bunch more objects and
1911 * adds them to the object free list.
1913 static int yaffs_CreateFreeObjects(yaffs_Device *dev, int nObjects)
1916 yaffs_Object *newObjects;
1917 yaffs_ObjectList *list;
1922 /* make these things */
1923 newObjects = YMALLOC(nObjects * sizeof(yaffs_Object));
1924 list = YMALLOC(sizeof(yaffs_ObjectList));
1926 if (!newObjects || !list) {
1935 T(YAFFS_TRACE_ALLOCATE,
1936 (TSTR("yaffs: Could not allocate more objects" TENDSTR)));
1940 /* Hook them into the free list */
1941 for (i = 0; i < nObjects - 1; i++) {
1942 newObjects[i].siblings.next =
1943 (struct ylist_head *)(&newObjects[i + 1]);
1946 newObjects[nObjects - 1].siblings.next = (void *)dev->freeObjects;
1947 dev->freeObjects = newObjects;
1948 dev->nFreeObjects += nObjects;
1949 dev->nObjectsCreated += nObjects;
1951 /* Now add this bunch of Objects to a list for freeing up. */
1953 list->objects = newObjects;
1954 list->next = dev->allocatedObjectList;
1955 dev->allocatedObjectList = list;
1961 /* AllocateEmptyObject gets us a clean Object. Tries to make allocate more if we run out */
1962 static yaffs_Object *yaffs_AllocateEmptyObject(yaffs_Device *dev)
1964 yaffs_Object *tn = NULL;
1966 #ifdef CONFIG_YAFFS_VALGRIND_TEST
1967 tn = YMALLOC(sizeof(yaffs_Object));
1969 dev->nObjectsCreated++;
1971 /* If there are none left make more */
1972 if (!dev->freeObjects)
1973 yaffs_CreateFreeObjects(dev, YAFFS_ALLOCATION_NOBJECTS);
1975 if (dev->freeObjects) {
1976 tn = dev->freeObjects;
1978 (yaffs_Object *) (dev->freeObjects->siblings.next);
1979 dev->nFreeObjects--;
1983 /* Now sweeten it up... */
1985 memset(tn, 0, sizeof(yaffs_Object));
1986 tn->beingCreated = 1;
1990 tn->variantType = YAFFS_OBJECT_TYPE_UNKNOWN;
1991 YINIT_LIST_HEAD(&(tn->hardLinks));
1992 YINIT_LIST_HEAD(&(tn->hashLink));
1993 YINIT_LIST_HEAD(&tn->siblings);
1996 /* Now make the directory sane */
1998 tn->parent = dev->rootDir;
1999 ylist_add(&(tn->siblings), &dev->rootDir->variant.directoryVariant.children);
2002 /* Add it to the lost and found directory.
2003 * NB Can't put root or lostNFound in lostNFound so
2004 * check if lostNFound exists first
2006 if (dev->lostNFoundDir)
2007 yaffs_AddObjectToDirectory(dev->lostNFoundDir, tn);
2009 tn->beingCreated = 0;
2012 dev->nCheckpointBlocksRequired = 0; /* force recalculation*/
2017 static yaffs_Object *yaffs_CreateFakeDirectory(yaffs_Device *dev, int number,
2022 yaffs_CreateNewObject(dev, number, YAFFS_OBJECT_TYPE_DIRECTORY);
2024 obj->fake = 1; /* it is fake so it might have no NAND presence... */
2025 obj->renameAllowed = 0; /* ... and we're not allowed to rename it... */
2026 obj->unlinkAllowed = 0; /* ... or unlink it */
2029 obj->yst_mode = mode;
2031 obj->hdrChunk = 0; /* Not a valid chunk. */
2038 static void yaffs_UnhashObject(yaffs_Object *tn)
2041 yaffs_Device *dev = tn->myDev;
2043 /* If it is still linked into the bucket list, free from the list */
2044 if (!ylist_empty(&tn->hashLink)) {
2045 ylist_del_init(&tn->hashLink);
2046 bucket = yaffs_HashFunction(tn->objectId);
2047 dev->objectBucket[bucket].count--;
2051 /* FreeObject frees up a Object and puts it back on the free list */
2052 static void yaffs_FreeObject(yaffs_Object *tn)
2054 yaffs_Device *dev = tn->myDev;
2056 T(YAFFS_TRACE_OS, (TSTR("FreeObject %p inode %p"TENDSTR), tn, tn->myInode));
2062 if (!ylist_empty(&tn->siblings))
2067 /* We're still hooked up to a cached inode.
2068 * Don't delete now, but mark for later deletion
2070 tn->deferedFree = 1;
2074 yaffs_UnhashObject(tn);
2076 #ifdef CONFIG_YAFFS_VALGRIND_TEST
2078 dev->nObjectsCreated--;
2081 /* Link into the free list. */
2082 tn->siblings.next = (struct ylist_head *)(dev->freeObjects);
2083 dev->freeObjects = tn;
2084 dev->nFreeObjects++;
2086 dev->nCheckpointBlocksRequired = 0; /* force recalculation*/
2090 void yaffs_HandleDeferedFree(yaffs_Object *obj)
2092 if (obj->deferedFree)
2093 yaffs_FreeObject(obj);
2097 static void yaffs_DeinitialiseObjects(yaffs_Device *dev)
2099 /* Free the list of allocated Objects */
2101 yaffs_ObjectList *tmp;
2103 while (dev->allocatedObjectList) {
2104 tmp = dev->allocatedObjectList->next;
2105 YFREE(dev->allocatedObjectList->objects);
2106 YFREE(dev->allocatedObjectList);
2108 dev->allocatedObjectList = tmp;
2111 dev->freeObjects = NULL;
2112 dev->nFreeObjects = 0;
2113 dev->nObjectsCreated = 0;
2116 static void yaffs_InitialiseObjects(yaffs_Device *dev)
2120 dev->allocatedObjectList = NULL;
2121 dev->freeObjects = NULL;
2122 dev->nFreeObjects = 0;
2124 for (i = 0; i < YAFFS_NOBJECT_BUCKETS; i++) {
2125 YINIT_LIST_HEAD(&dev->objectBucket[i].list);
2126 dev->objectBucket[i].count = 0;
2130 static int yaffs_FindNiceObjectBucket(yaffs_Device *dev)
2134 int lowest = 999999;
2137 /* Search for the shortest list or one that
2141 for (i = 0; i < 10 && lowest > 4; i++) {
2142 dev->bucketFinder++;
2143 dev->bucketFinder %= YAFFS_NOBJECT_BUCKETS;
2144 if (dev->objectBucket[dev->bucketFinder].count < lowest) {
2145 lowest = dev->objectBucket[dev->bucketFinder].count;
2146 l = dev->bucketFinder;
2154 static int yaffs_CreateNewObjectNumber(yaffs_Device *dev)
2156 int bucket = yaffs_FindNiceObjectBucket(dev);
2158 /* Now find an object value that has not already been taken
2159 * by scanning the list.
2163 struct ylist_head *i;
2165 __u32 n = (__u32) bucket;
2167 /* yaffs_CheckObjectHashSanity(); */
2171 n += YAFFS_NOBJECT_BUCKETS;
2172 if (1 || dev->objectBucket[bucket].count > 0) {
2173 ylist_for_each(i, &dev->objectBucket[bucket].list) {
2174 /* If there is already one in the list */
2175 if (i && ylist_entry(i, yaffs_Object,
2176 hashLink)->objectId == n) {
2186 static void yaffs_HashObject(yaffs_Object *in)
2188 int bucket = yaffs_HashFunction(in->objectId);
2189 yaffs_Device *dev = in->myDev;
2191 ylist_add(&in->hashLink, &dev->objectBucket[bucket].list);
2192 dev->objectBucket[bucket].count++;
2195 yaffs_Object *yaffs_FindObjectByNumber(yaffs_Device *dev, __u32 number)
2197 int bucket = yaffs_HashFunction(number);
2198 struct ylist_head *i;
2201 ylist_for_each(i, &dev->objectBucket[bucket].list) {
2202 /* Look if it is in the list */
2204 in = ylist_entry(i, yaffs_Object, hashLink);
2205 if (in->objectId == number) {
2207 /* Don't tell the VFS about this one if it is defered free */
2208 if (in->deferedFree)
2219 yaffs_Object *yaffs_CreateNewObject(yaffs_Device *dev, int number,
2220 yaffs_ObjectType type)
2222 yaffs_Object *theObject=NULL;
2223 yaffs_Tnode *tn = NULL;
2226 number = yaffs_CreateNewObjectNumber(dev);
2228 if (type == YAFFS_OBJECT_TYPE_FILE) {
2229 tn = yaffs_GetTnode(dev);
2234 theObject = yaffs_AllocateEmptyObject(dev);
2237 yaffs_FreeTnode(dev,tn);
2243 theObject->fake = 0;
2244 theObject->renameAllowed = 1;
2245 theObject->unlinkAllowed = 1;
2246 theObject->objectId = number;
2247 yaffs_HashObject(theObject);
2248 theObject->variantType = type;
2249 #ifdef CONFIG_YAFFS_WINCE
2250 yfsd_WinFileTimeNow(theObject->win_atime);
2251 theObject->win_ctime[0] = theObject->win_mtime[0] =
2252 theObject->win_atime[0];
2253 theObject->win_ctime[1] = theObject->win_mtime[1] =
2254 theObject->win_atime[1];
2258 theObject->yst_atime = theObject->yst_mtime =
2259 theObject->yst_ctime = Y_CURRENT_TIME;
2262 case YAFFS_OBJECT_TYPE_FILE:
2263 theObject->variant.fileVariant.fileSize = 0;
2264 theObject->variant.fileVariant.scannedFileSize = 0;
2265 theObject->variant.fileVariant.shrinkSize = 0xFFFFFFFF; /* max __u32 */
2266 theObject->variant.fileVariant.topLevel = 0;
2267 theObject->variant.fileVariant.top = tn;
2269 case YAFFS_OBJECT_TYPE_DIRECTORY:
2270 YINIT_LIST_HEAD(&theObject->variant.directoryVariant.
2273 case YAFFS_OBJECT_TYPE_SYMLINK:
2274 case YAFFS_OBJECT_TYPE_HARDLINK:
2275 case YAFFS_OBJECT_TYPE_SPECIAL:
2276 /* No action required */
2278 case YAFFS_OBJECT_TYPE_UNKNOWN:
2279 /* todo this should not happen */
2287 static yaffs_Object *yaffs_FindOrCreateObjectByNumber(yaffs_Device *dev,
2289 yaffs_ObjectType type)
2291 yaffs_Object *theObject = NULL;
2294 theObject = yaffs_FindObjectByNumber(dev, number);
2297 theObject = yaffs_CreateNewObject(dev, number, type);
2304 static YCHAR *yaffs_CloneString(const YCHAR *str)
2306 YCHAR *newStr = NULL;
2312 len = yaffs_strnlen(str,YAFFS_MAX_ALIAS_LENGTH);
2313 newStr = YMALLOC((len + 1) * sizeof(YCHAR));
2315 yaffs_strncpy(newStr, str,len);
2323 * Mknod (create) a new object.
2324 * equivalentObject only has meaning for a hard link;
2325 * aliasString only has meaning for a symlink.
2326 * rdev only has meaning for devices (a subset of special objects)
2329 static yaffs_Object *yaffs_MknodObject(yaffs_ObjectType type,
2330 yaffs_Object *parent,
2335 yaffs_Object *equivalentObject,
2336 const YCHAR *aliasString, __u32 rdev)
2341 yaffs_Device *dev = parent->myDev;
2343 /* Check if the entry exists. If it does then fail the call since we don't want a dup.*/
2344 if (yaffs_FindObjectByName(parent, name))
2347 if (type == YAFFS_OBJECT_TYPE_SYMLINK) {
2348 str = yaffs_CloneString(aliasString);
2353 in = yaffs_CreateNewObject(dev, -1, type);
2368 in->variantType = type;
2370 in->yst_mode = mode;
2372 #ifdef CONFIG_YAFFS_WINCE
2373 yfsd_WinFileTimeNow(in->win_atime);
2374 in->win_ctime[0] = in->win_mtime[0] = in->win_atime[0];
2375 in->win_ctime[1] = in->win_mtime[1] = in->win_atime[1];
2378 in->yst_atime = in->yst_mtime = in->yst_ctime = Y_CURRENT_TIME;
2380 in->yst_rdev = rdev;
2384 in->nDataChunks = 0;
2386 yaffs_SetObjectName(in, name);
2389 yaffs_AddObjectToDirectory(parent, in);
2391 in->myDev = parent->myDev;
2394 case YAFFS_OBJECT_TYPE_SYMLINK:
2395 in->variant.symLinkVariant.alias = str;
2397 case YAFFS_OBJECT_TYPE_HARDLINK:
2398 in->variant.hardLinkVariant.equivalentObject =
2400 in->variant.hardLinkVariant.equivalentObjectId =
2401 equivalentObject->objectId;
2402 ylist_add(&in->hardLinks, &equivalentObject->hardLinks);
2404 case YAFFS_OBJECT_TYPE_FILE:
2405 case YAFFS_OBJECT_TYPE_DIRECTORY:
2406 case YAFFS_OBJECT_TYPE_SPECIAL:
2407 case YAFFS_OBJECT_TYPE_UNKNOWN:
2412 if (yaffs_UpdateObjectHeader(in, name, 0, 0, 0) < 0) {
2413 /* Could not create the object header, fail the creation */
2414 yaffs_DeleteObject(in);
2418 yaffs_UpdateParent(parent);
2424 yaffs_Object *yaffs_MknodFile(yaffs_Object *parent, const YCHAR *name,
2425 __u32 mode, __u32 uid, __u32 gid)
2427 return yaffs_MknodObject(YAFFS_OBJECT_TYPE_FILE, parent, name, mode,
2428 uid, gid, NULL, NULL, 0);
2431 yaffs_Object *yaffs_MknodDirectory(yaffs_Object *parent, const YCHAR *name,
2432 __u32 mode, __u32 uid, __u32 gid)
2434 return yaffs_MknodObject(YAFFS_OBJECT_TYPE_DIRECTORY, parent, name,
2435 mode, uid, gid, NULL, NULL, 0);
2438 yaffs_Object *yaffs_MknodSpecial(yaffs_Object *parent, const YCHAR *name,
2439 __u32 mode, __u32 uid, __u32 gid, __u32 rdev)
2441 return yaffs_MknodObject(YAFFS_OBJECT_TYPE_SPECIAL, parent, name, mode,
2442 uid, gid, NULL, NULL, rdev);
2445 yaffs_Object *yaffs_MknodSymLink(yaffs_Object *parent, const YCHAR *name,
2446 __u32 mode, __u32 uid, __u32 gid,
2449 return yaffs_MknodObject(YAFFS_OBJECT_TYPE_SYMLINK, parent, name, mode,
2450 uid, gid, NULL, alias, 0);
2453 /* yaffs_Link returns the object id of the equivalent object.*/
2454 yaffs_Object *yaffs_Link(yaffs_Object *parent, const YCHAR *name,
2455 yaffs_Object *equivalentObject)
2457 /* Get the real object in case we were fed a hard link as an equivalent object */
2458 equivalentObject = yaffs_GetEquivalentObject(equivalentObject);
2460 if (yaffs_MknodObject
2461 (YAFFS_OBJECT_TYPE_HARDLINK, parent, name, 0, 0, 0,
2462 equivalentObject, NULL, 0)) {
2463 return equivalentObject;
2470 static int yaffs_ChangeObjectName(yaffs_Object *obj, yaffs_Object *newDir,
2471 const YCHAR *newName, int force, int shadows)
2476 yaffs_Object *existingTarget;
2479 newDir = obj->parent; /* use the old directory */
2481 if (newDir->variantType != YAFFS_OBJECT_TYPE_DIRECTORY) {
2482 T(YAFFS_TRACE_ALWAYS,
2484 ("tragedy: yaffs_ChangeObjectName: newDir is not a directory"
2489 /* TODO: Do we need this different handling for YAFFS2 and YAFFS1?? */
2490 if (obj->myDev->param.isYaffs2)
2491 unlinkOp = (newDir == obj->myDev->unlinkedDir);
2493 unlinkOp = (newDir == obj->myDev->unlinkedDir
2494 && obj->variantType == YAFFS_OBJECT_TYPE_FILE);
2496 deleteOp = (newDir == obj->myDev->deletedDir);
2498 existingTarget = yaffs_FindObjectByName(newDir, newName);
2500 /* If the object is a file going into the unlinked directory,
2501 * then it is OK to just stuff it in since duplicate names are allowed.
2502 * else only proceed if the new name does not exist and if we're putting
2503 * it into a directory.
2510 newDir->variantType == YAFFS_OBJECT_TYPE_DIRECTORY) {
2511 yaffs_SetObjectName(obj, newName);
2514 yaffs_AddObjectToDirectory(newDir, obj);
2519 /* If it is a deletion then we mark it as a shrink for gc purposes. */
2520 if (yaffs_UpdateObjectHeader(obj, newName, 0, deleteOp, shadows) >= 0)
2527 int yaffs_RenameObject(yaffs_Object *oldDir, const YCHAR *oldName,
2528 yaffs_Object *newDir, const YCHAR *newName)
2530 yaffs_Object *obj = NULL;
2531 yaffs_Object *existingTarget = NULL;
2537 if (!oldDir || oldDir->variantType != YAFFS_OBJECT_TYPE_DIRECTORY)
2539 if (!newDir || newDir->variantType != YAFFS_OBJECT_TYPE_DIRECTORY)
2542 dev = oldDir->myDev;
2544 #ifdef CONFIG_YAFFS_CASE_INSENSITIVE
2545 /* Special case for case insemsitive systems (eg. WinCE).
2546 * While look-up is case insensitive, the name isn't.
2547 * Therefore we might want to change x.txt to X.txt
2549 if (oldDir == newDir && yaffs_strcmp(oldName, newName) == 0)
2553 if(yaffs_strnlen(newName,YAFFS_MAX_NAME_LENGTH+1) > YAFFS_MAX_NAME_LENGTH)
2557 obj = yaffs_FindObjectByName(oldDir, oldName);
2559 if (obj && obj->renameAllowed) {
2561 /* Now do the handling for an existing target, if there is one */
2563 existingTarget = yaffs_FindObjectByName(newDir, newName);
2564 if (existingTarget &&
2565 existingTarget->variantType == YAFFS_OBJECT_TYPE_DIRECTORY &&
2566 !ylist_empty(&existingTarget->variant.directoryVariant.children)) {
2567 /* There is a target that is a non-empty directory, so we fail */
2568 return YAFFS_FAIL; /* EEXIST or ENOTEMPTY */
2569 } else if (existingTarget && existingTarget != obj) {
2570 /* Nuke the target first, using shadowing,
2571 * but only if it isn't the same object.
2573 * Note we must disable gc otherwise it can mess up the shadowing.
2577 yaffs_ChangeObjectName(obj, newDir, newName, force,
2578 existingTarget->objectId);
2579 existingTarget->isShadowed = 1;
2580 yaffs_UnlinkObject(existingTarget);
2584 result = yaffs_ChangeObjectName(obj, newDir, newName, 1, 0);
2586 yaffs_UpdateParent(oldDir);
2587 if(newDir != oldDir)
2588 yaffs_UpdateParent(newDir);
2595 /*------------------------- Block Management and Page Allocation ----------------*/
2597 static int yaffs_InitialiseBlocks(yaffs_Device *dev)
2599 int nBlocks = dev->internalEndBlock - dev->internalStartBlock + 1;
2601 dev->blockInfo = NULL;
2602 dev->chunkBits = NULL;
2604 dev->allocationBlock = -1; /* force it to get a new one */
2606 /* If the first allocation strategy fails, thry the alternate one */
2607 dev->blockInfo = YMALLOC(nBlocks * sizeof(yaffs_BlockInfo));
2608 if (!dev->blockInfo) {
2609 dev->blockInfo = YMALLOC_ALT(nBlocks * sizeof(yaffs_BlockInfo));
2610 dev->blockInfoAlt = 1;
2612 dev->blockInfoAlt = 0;
2614 if (dev->blockInfo) {
2615 /* Set up dynamic blockinfo stuff. */
2616 dev->chunkBitmapStride = (dev->param.nChunksPerBlock + 7) / 8; /* round up bytes */
2617 dev->chunkBits = YMALLOC(dev->chunkBitmapStride * nBlocks);
2618 if (!dev->chunkBits) {
2619 dev->chunkBits = YMALLOC_ALT(dev->chunkBitmapStride * nBlocks);
2620 dev->chunkBitsAlt = 1;
2622 dev->chunkBitsAlt = 0;
2625 if (dev->blockInfo && dev->chunkBits) {
2626 memset(dev->blockInfo, 0, nBlocks * sizeof(yaffs_BlockInfo));
2627 memset(dev->chunkBits, 0, dev->chunkBitmapStride * nBlocks);
2634 static void yaffs_DeinitialiseBlocks(yaffs_Device *dev)
2636 if (dev->blockInfoAlt && dev->blockInfo)
2637 YFREE_ALT(dev->blockInfo);
2638 else if (dev->blockInfo)
2639 YFREE(dev->blockInfo);
2641 dev->blockInfoAlt = 0;
2643 dev->blockInfo = NULL;
2645 if (dev->chunkBitsAlt && dev->chunkBits)
2646 YFREE_ALT(dev->chunkBits);
2647 else if (dev->chunkBits)
2648 YFREE(dev->chunkBits);
2649 dev->chunkBitsAlt = 0;
2650 dev->chunkBits = NULL;
2653 static int yaffs_BlockNotDisqualifiedFromGC(yaffs_Device *dev,
2654 yaffs_BlockInfo *bi)
2660 if (!dev->param.isYaffs2)
2661 return 1; /* disqualification only applies to yaffs2. */
2663 if (!bi->hasShrinkHeader)
2664 return 1; /* can gc */
2666 /* Find the oldest dirty sequence number if we don't know it and save it
2667 * so we don't have to keep recomputing it.
2669 if (!dev->oldestDirtySequence) {
2670 seq = dev->sequenceNumber;
2672 for (i = dev->internalStartBlock; i <= dev->internalEndBlock;
2674 b = yaffs_GetBlockInfo(dev, i);
2675 if (b->blockState == YAFFS_BLOCK_STATE_FULL &&
2676 (b->pagesInUse - b->softDeletions) <
2677 dev->param.nChunksPerBlock && b->sequenceNumber < seq) {
2678 seq = b->sequenceNumber;
2681 dev->oldestDirtySequence = seq;
2684 /* Can't do gc of this block if there are any blocks older than this one that have
2687 return (bi->sequenceNumber <= dev->oldestDirtySequence);
2691 * yaffs_FindRefreshBlock()
2692 * periodically finds the oldest full block by sequence number for refreshing.
2695 static __u32 yaffs_FindRefreshBlock(yaffs_Device *dev)
2700 __u32 oldestSequence = 0;
2702 yaffs_BlockInfo *bi;
2705 * If refresh period < 10 then refreshing is disabled.
2707 if(dev->param.refreshPeriod < 10 ||
2708 !dev->param.isYaffs2)
2712 * Fix broken values.
2714 if(dev->refreshSkip > dev->param.refreshPeriod)
2715 dev->refreshSkip = dev->param.refreshPeriod;
2717 if(dev->refreshSkip > 0){
2723 * Refresh skip is now zero.
2724 * We'll do a refresh this time around....
2725 * Update the refresh skip and find the oldest block.
2727 dev->refreshSkip = dev->param.refreshPeriod;
2728 dev->refreshCount++;
2730 for (b = dev->internalStartBlock; b <=dev->internalEndBlock; b++){
2732 bi = yaffs_GetBlockInfo(dev, b);
2735 if (bi->blockState == YAFFS_BLOCK_STATE_FULL){
2738 bi->sequenceNumber < oldestSequence){
2740 oldestSequence = bi->sequenceNumber;
2747 (TSTR("GC refresh count %d selected block %d with sequenceNumber %d" TENDSTR),
2748 dev->refreshCount, oldest, oldestSequence));
2755 * FindDiretiestBlock is used to select the dirtiest block (or close enough)
2756 * for garbage collection.
2759 static int yaffs_FindBlockForGarbageCollection(yaffs_Device *dev,
2762 int b = dev->currentDirtyChecker;
2768 int prioritised = 0;
2769 yaffs_BlockInfo *bi;
2770 int pendingPrioritisedExist = 0;
2772 /* First let's see if we need to grab a prioritised block */
2773 if (dev->hasPendingPrioritisedGCs) {
2774 for (i = dev->internalStartBlock; i < dev->internalEndBlock && !prioritised; i++) {
2776 bi = yaffs_GetBlockInfo(dev, i);
2777 /* yaffs_VerifyBlock(dev,bi,i); */
2779 if (bi->gcPrioritise) {
2780 pendingPrioritisedExist = 1;
2781 if (bi->blockState == YAFFS_BLOCK_STATE_FULL &&
2782 yaffs_BlockNotDisqualifiedFromGC(dev, bi)) {
2783 pagesInUse = (bi->pagesInUse - bi->softDeletions);
2786 aggressive = 1; /* Fool the non-aggressive skip logiv below */
2791 if (!pendingPrioritisedExist) /* None found, so we can clear this */
2792 dev->hasPendingPrioritisedGCs = 0;
2795 /* If we're doing aggressive GC then we are happy to take a less-dirty block, and
2797 * else (we're doing a leasurely gc), then we only bother to do this if the
2798 * block has only a few pages in use.
2801 dev->nonAggressiveSkip--;
2803 if (!aggressive && (dev->nonAggressiveSkip > 0))
2808 (aggressive) ? dev->param.nChunksPerBlock : YAFFS_PASSIVE_GC_CHUNKS + 1;
2812 dev->internalEndBlock - dev->internalStartBlock + 1;
2815 dev->internalEndBlock - dev->internalStartBlock + 1;
2816 iterations = iterations / 16;
2817 if (iterations > 200)
2821 for (i = 0; i <= iterations && pagesInUse > 0 && !prioritised; i++) {
2823 if (b < dev->internalStartBlock || b > dev->internalEndBlock)
2824 b = dev->internalStartBlock;
2826 if (b < dev->internalStartBlock || b > dev->internalEndBlock) {
2827 T(YAFFS_TRACE_ERROR,
2828 (TSTR("**>> Block %d is not valid" TENDSTR), b));
2832 bi = yaffs_GetBlockInfo(dev, b);
2834 if (bi->blockState == YAFFS_BLOCK_STATE_FULL &&
2835 (bi->pagesInUse - bi->softDeletions) < pagesInUse &&
2836 yaffs_BlockNotDisqualifiedFromGC(dev, bi)) {
2838 pagesInUse = (bi->pagesInUse - bi->softDeletions);
2842 dev->currentDirtyChecker = b;
2846 (TSTR("GC Selected block %d with %d free, prioritised:%d" TENDSTR), dirtiest,
2847 dev->param.nChunksPerBlock - pagesInUse, prioritised));
2850 dev->oldestDirtySequence = 0;
2853 dev->nonAggressiveSkip = 4;
2858 static void yaffs_BlockBecameDirty(yaffs_Device *dev, int blockNo)
2860 yaffs_BlockInfo *bi = yaffs_GetBlockInfo(dev, blockNo);
2864 /* If the block is still healthy erase it and mark as clean.
2865 * If the block has had a data failure, then retire it.
2868 T(YAFFS_TRACE_GC | YAFFS_TRACE_ERASE,
2869 (TSTR("yaffs_BlockBecameDirty block %d state %d %s"TENDSTR),
2870 blockNo, bi->blockState, (bi->needsRetiring) ? "needs retiring" : ""));
2872 bi->blockState = YAFFS_BLOCK_STATE_DIRTY;
2874 if (!bi->needsRetiring) {
2875 yaffs_InvalidateCheckpoint(dev);
2876 erasedOk = yaffs_EraseBlockInNAND(dev, blockNo);
2878 dev->nErasureFailures++;
2879 T(YAFFS_TRACE_ERROR | YAFFS_TRACE_BAD_BLOCKS,
2880 (TSTR("**>> Erasure failed %d" TENDSTR), blockNo));
2885 ((yaffs_traceMask & YAFFS_TRACE_ERASE) || !yaffs_SkipVerification(dev))) {
2887 for (i = 0; i < dev->param.nChunksPerBlock; i++) {
2888 if (!yaffs_CheckChunkErased
2889 (dev, blockNo * dev->param.nChunksPerBlock + i)) {
2890 T(YAFFS_TRACE_ERROR,
2892 (">>Block %d erasure supposedly OK, but chunk %d not erased"
2893 TENDSTR), blockNo, i));
2899 /* Clean it up... */
2900 bi->blockState = YAFFS_BLOCK_STATE_EMPTY;
2901 bi->sequenceNumber = 0;
2902 dev->nErasedBlocks++;
2904 bi->softDeletions = 0;
2905 bi->hasShrinkHeader = 0;
2906 bi->skipErasedCheck = 1; /* This is clean, so no need to check */
2907 bi->gcPrioritise = 0;
2908 yaffs_ClearChunkBits(dev, blockNo);
2910 T(YAFFS_TRACE_ERASE,
2911 (TSTR("Erased block %d" TENDSTR), blockNo));
2913 dev->nFreeChunks -= dev->param.nChunksPerBlock; /* We lost a block of free space */
2915 yaffs_RetireBlock(dev, blockNo);
2916 T(YAFFS_TRACE_ERROR | YAFFS_TRACE_BAD_BLOCKS,
2917 (TSTR("**>> Block %d retired" TENDSTR), blockNo));
2921 static int yaffs_FindBlockForAllocation(yaffs_Device *dev)
2925 yaffs_BlockInfo *bi;
2927 if (dev->nErasedBlocks < 1) {
2928 /* Hoosterman we've got a problem.
2929 * Can't get space to gc
2931 T(YAFFS_TRACE_ERROR,
2932 (TSTR("yaffs tragedy: no more erased blocks" TENDSTR)));
2937 /* Find an empty block. */
2939 for (i = dev->internalStartBlock; i <= dev->internalEndBlock; i++) {
2940 dev->allocationBlockFinder++;
2941 if (dev->allocationBlockFinder < dev->internalStartBlock
2942 || dev->allocationBlockFinder > dev->internalEndBlock) {
2943 dev->allocationBlockFinder = dev->internalStartBlock;
2946 bi = yaffs_GetBlockInfo(dev, dev->allocationBlockFinder);
2948 if (bi->blockState == YAFFS_BLOCK_STATE_EMPTY) {
2949 bi->blockState = YAFFS_BLOCK_STATE_ALLOCATING;
2950 dev->sequenceNumber++;
2951 bi->sequenceNumber = dev->sequenceNumber;
2952 dev->nErasedBlocks--;
2953 T(YAFFS_TRACE_ALLOCATE,
2954 (TSTR("Allocated block %d, seq %d, %d left" TENDSTR),
2955 dev->allocationBlockFinder, dev->sequenceNumber,
2956 dev->nErasedBlocks));
2957 return dev->allocationBlockFinder;
2961 T(YAFFS_TRACE_ALWAYS,
2963 ("yaffs tragedy: no more erased blocks, but there should have been %d"
2964 TENDSTR), dev->nErasedBlocks));
2971 static int yaffs_CalcCheckpointBlocksRequired(yaffs_Device *dev)
2973 if (!dev->nCheckpointBlocksRequired &&
2974 dev->param.isYaffs2) {
2975 /* Not a valid value so recalculate */
2978 int devBlocks = (dev->param.endBlock - dev->param.startBlock + 1);
2979 int tnodeSize = yaffs_CalcTnodeSize(dev);
2981 nBytes += sizeof(yaffs_CheckpointValidity);
2982 nBytes += sizeof(yaffs_CheckpointDevice);
2983 nBytes += devBlocks * sizeof(yaffs_BlockInfo);
2984 nBytes += devBlocks * dev->chunkBitmapStride;
2985 nBytes += (sizeof(yaffs_CheckpointObject) + sizeof(__u32)) * (dev->nObjectsCreated - dev->nFreeObjects);
2986 nBytes += (tnodeSize + sizeof(__u32)) * (dev->nTnodesCreated - dev->nFreeTnodes);
2987 nBytes += sizeof(yaffs_CheckpointValidity);
2988 nBytes += sizeof(__u32); /* checksum*/
2990 /* Round up and add 2 blocks to allow for some bad blocks, so add 3 */
2992 nBlocks = (nBytes/(dev->nDataBytesPerChunk * dev->param.nChunksPerBlock)) + 3;
2994 dev->nCheckpointBlocksRequired = nBlocks;
2997 return dev->nCheckpointBlocksRequired;
3001 * Check if there's space to allocate...
3002 * Thinks.... do we need top make this ths same as yaffs_GetFreeChunks()?
3004 static int yaffs_CheckSpaceForAllocation(yaffs_Device *dev)
3007 int reservedBlocks = dev->param.nReservedBlocks;
3008 int checkpointBlocks;
3010 if (dev->param.isYaffs2) {
3011 checkpointBlocks = yaffs_CalcCheckpointBlocksRequired(dev) -
3012 dev->blocksInCheckpoint;
3013 if (checkpointBlocks < 0)
3014 checkpointBlocks = 0;
3016 checkpointBlocks = 0;
3019 reservedChunks = ((reservedBlocks + checkpointBlocks) * dev->param.nChunksPerBlock);
3021 return (dev->nFreeChunks > reservedChunks);
3024 static int yaffs_AllocateChunk(yaffs_Device *dev, int useReserve,
3025 yaffs_BlockInfo **blockUsedPtr)
3028 yaffs_BlockInfo *bi;
3030 if (dev->allocationBlock < 0) {
3031 /* Get next block to allocate off */
3032 dev->allocationBlock = yaffs_FindBlockForAllocation(dev);
3033 dev->allocationPage = 0;
3036 if (!useReserve && !yaffs_CheckSpaceForAllocation(dev)) {
3037 /* Not enough space to allocate unless we're allowed to use the reserve. */
3041 if (dev->nErasedBlocks < dev->param.nReservedBlocks
3042 && dev->allocationPage == 0) {
3043 T(YAFFS_TRACE_ALLOCATE, (TSTR("Allocating reserve" TENDSTR)));
3046 /* Next page please.... */
3047 if (dev->allocationBlock >= 0) {
3048 bi = yaffs_GetBlockInfo(dev, dev->allocationBlock);
3050 retVal = (dev->allocationBlock * dev->param.nChunksPerBlock) +
3051 dev->allocationPage;
3053 yaffs_SetChunkBit(dev, dev->allocationBlock,
3054 dev->allocationPage);
3056 dev->allocationPage++;
3060 /* If the block is full set the state to full */
3061 if (dev->allocationPage >= dev->param.nChunksPerBlock) {
3062 bi->blockState = YAFFS_BLOCK_STATE_FULL;
3063 dev->allocationBlock = -1;
3072 T(YAFFS_TRACE_ERROR,
3073 (TSTR("!!!!!!!!! Allocator out !!!!!!!!!!!!!!!!!" TENDSTR)));
3078 static int yaffs_GetErasedChunks(yaffs_Device *dev)
3082 n = dev->nErasedBlocks * dev->param.nChunksPerBlock;
3084 if (dev->allocationBlock > 0)
3085 n += (dev->param.nChunksPerBlock - dev->allocationPage);
3092 * yaffs_SkipRestOfBlock() skips over the rest of the allocation block
3093 * if we don't want to write to it.
3095 static void yaffs_SkipRestOfBlock(yaffs_Device *dev)
3097 if(dev->allocationBlock > 0){
3098 yaffs_BlockInfo *bi = yaffs_GetBlockInfo(dev, dev->allocationBlock);
3099 if(bi->blockState == YAFFS_BLOCK_STATE_ALLOCATING){
3100 bi->blockState = YAFFS_BLOCK_STATE_FULL;
3101 dev->allocationBlock = -1;
3107 static int yaffs_GarbageCollectBlock(yaffs_Device *dev, int block,
3113 int retVal = YAFFS_OK;
3116 int isCheckpointBlock;
3120 int chunksBefore = yaffs_GetErasedChunks(dev);
3123 yaffs_ExtendedTags tags;
3125 yaffs_BlockInfo *bi = yaffs_GetBlockInfo(dev, block);
3127 yaffs_Object *object;
3129 isCheckpointBlock = (bi->blockState == YAFFS_BLOCK_STATE_CHECKPOINT);
3132 T(YAFFS_TRACE_TRACING,
3133 (TSTR("Collecting block %d, in use %d, shrink %d, wholeBlock %d" TENDSTR),
3136 bi->hasShrinkHeader,
3139 /*yaffs_VerifyFreeChunks(dev); */
3141 if(bi->blockState == YAFFS_BLOCK_STATE_FULL)
3142 bi->blockState = YAFFS_BLOCK_STATE_COLLECTING;
3144 bi->hasShrinkHeader = 0; /* clear the flag so that the block can erase */
3146 /* Take off the number of soft deleted entries because
3147 * they're going to get really deleted during GC.
3149 if(dev->gcChunk == 0) /* first time through for this block */
3150 dev->nFreeChunks -= bi->softDeletions;
3154 if (isCheckpointBlock ||
3155 !yaffs_StillSomeChunkBits(dev, block)) {
3156 T(YAFFS_TRACE_TRACING,
3158 ("Collecting block %d that has no chunks in use" TENDSTR),
3160 yaffs_BlockBecameDirty(dev, block);
3163 __u8 *buffer = yaffs_GetTempBuffer(dev, __LINE__);
3165 yaffs_VerifyBlock(dev, bi, block);
3167 maxCopies = (wholeBlock) ? dev->param.nChunksPerBlock : 10;
3168 oldChunk = block * dev->param.nChunksPerBlock + dev->gcChunk;
3170 for (/* init already done */;
3171 retVal == YAFFS_OK &&
3172 dev->gcChunk < dev->param.nChunksPerBlock &&
3173 (bi->blockState == YAFFS_BLOCK_STATE_COLLECTING) &&
3175 dev->gcChunk++, oldChunk++) {
3176 if (yaffs_CheckChunkBit(dev, block, dev->gcChunk)) {
3178 /* This page is in use and might need to be copied off */
3184 yaffs_InitialiseTags(&tags);
3186 yaffs_ReadChunkWithTagsFromNAND(dev, oldChunk,
3190 yaffs_FindObjectByNumber(dev,
3193 T(YAFFS_TRACE_GC_DETAIL,
3195 ("Collecting chunk in block %d, %d %d %d " TENDSTR),
3196 dev->gcChunk, tags.objectId, tags.chunkId,
3199 if (object && !yaffs_SkipVerification(dev)) {
3200 if (tags.chunkId == 0)
3201 matchingChunk = object->hdrChunk;
3202 else if (object->softDeleted)
3203 matchingChunk = oldChunk; /* Defeat the test */
3205 matchingChunk = yaffs_FindChunkInFile(object, tags.chunkId, NULL);
3207 if (oldChunk != matchingChunk)
3208 T(YAFFS_TRACE_ERROR,
3209 (TSTR("gc: page in gc mismatch: %d %d %d %d"TENDSTR),
3210 oldChunk, matchingChunk, tags.objectId, tags.chunkId));
3215 T(YAFFS_TRACE_ERROR,
3217 ("page %d in gc has no object: %d %d %d "
3219 tags.objectId, tags.chunkId, tags.byteCount));
3224 object->softDeleted &&
3225 tags.chunkId != 0) {
3226 /* Data chunk in a soft deleted file, throw it away
3227 * It's a soft deleted data chunk,
3228 * No need to copy this, just forget about it and
3229 * fix up the object.
3232 object->nDataChunks--;
3234 if (object->nDataChunks <= 0) {
3235 /* remeber to clean up the object */
3236 dev->gcCleanupList[cleanups] =
3242 /* Todo object && object->deleted && object->nDataChunks == 0 */
3243 /* Deleted object header with no data chunks.
3244 * Can be discarded and the file deleted.
3246 object->hdrChunk = 0;
3247 yaffs_FreeTnode(object->myDev,
3250 object->variant.fileVariant.top = NULL;
3251 yaffs_DoGenericObjectDeletion(object);
3253 } else if (object) {
3254 /* It's either a data chunk in a live file or
3255 * an ObjectHeader, so we're interested in it.
3256 * NB Need to keep the ObjectHeaders of deleted files
3257 * until the whole file has been deleted off
3259 tags.serialNumber++;
3263 if (tags.chunkId == 0) {
3264 /* It is an object Id,
3265 * We need to nuke the shrinkheader flags first
3266 * Also need to clean up shadowing.
3267 * We no longer want the shrinkHeader flag since its work is done
3268 * and if it is left in place it will mess up scanning.
3271 yaffs_ObjectHeader *oh;
3272 oh = (yaffs_ObjectHeader *)buffer;
3274 tags.extraIsShrinkHeader = 0;
3275 oh->shadowsObject = 0;
3276 oh->inbandShadowsObject = 0;
3277 if(object->variantType == YAFFS_OBJECT_TYPE_FILE)
3278 oh->fileSize = object->variant.fileVariant.fileSize;
3279 tags.extraShadows = 0;
3281 yaffs_VerifyObjectHeader(object, oh, &tags, 1);
3283 yaffs_WriteNewChunkWithTagsToNAND(dev,(__u8 *) oh, &tags, 1);
3286 yaffs_WriteNewChunkWithTagsToNAND(dev, buffer, &tags, 1);
3289 retVal = YAFFS_FAIL;
3292 /* Ok, now fix up the Tnodes etc. */
3294 if (tags.chunkId == 0) {
3296 object->hdrChunk = newChunk;
3297 object->serial = tags.serialNumber;
3299 /* It's a data chunk */
3301 ok = yaffs_PutChunkIntoFile
3309 if (retVal == YAFFS_OK)
3310 yaffs_DeleteChunk(dev, oldChunk, markNAND, __LINE__);
3315 yaffs_ReleaseTempBuffer(dev, buffer, __LINE__);
3318 /* Do any required cleanups */
3319 for (i = 0; i < cleanups; i++) {
3320 /* Time to delete the file too */
3322 yaffs_FindObjectByNumber(dev,
3323 dev->gcCleanupList[i]);
3325 yaffs_FreeTnode(dev,
3326 object->variant.fileVariant.
3328 object->variant.fileVariant.top = NULL;
3331 ("yaffs: About to finally delete object %d"
3332 TENDSTR), object->objectId));
3333 yaffs_DoGenericObjectDeletion(object);
3334 object->myDev->nDeletedFiles--;
3341 yaffs_VerifyCollectedBlock(dev, bi, block);
3345 /* If the gc completed then clear the current gcBlock so that we find another. */
3346 if (bi->blockState != YAFFS_BLOCK_STATE_COLLECTING) {
3347 chunksAfter = yaffs_GetErasedChunks(dev);
3348 if (chunksBefore >= chunksAfter) {