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.120 2010-03-15 23:10:34 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 /* Note YAFFS_GC_GOOD_ENOUGH must be <= YAFFS_GC_PASSIVE_THRESHOLD */
38 #define YAFFS_GC_GOOD_ENOUGH 2
39 #define YAFFS_GC_PASSIVE_THRESHOLD 4
40 #define YAFFS_SMALL_HOLE_THRESHOLD 3
42 #include "yaffs_ecc.h"
45 /* Robustification (if it ever comes about...) */
46 static void yaffs_RetireBlock(yaffs_Device *dev, int blockInNAND);
47 static void yaffs_HandleWriteChunkError(yaffs_Device *dev, int chunkInNAND,
49 static void yaffs_HandleWriteChunkOk(yaffs_Device *dev, int chunkInNAND,
51 const yaffs_ExtendedTags *tags);
52 static void yaffs_HandleUpdateChunk(yaffs_Device *dev, int chunkInNAND,
53 const yaffs_ExtendedTags *tags);
55 /* Other local prototypes */
56 static void yaffs_UpdateParent(yaffs_Object *obj);
57 static int yaffs_UnlinkObject(yaffs_Object *obj);
58 static int yaffs_ObjectHasCachedWriteData(yaffs_Object *obj);
60 static void yaffs_HardlinkFixup(yaffs_Device *dev, yaffs_Object *hardList);
62 static int yaffs_WriteNewChunkWithTagsToNAND(yaffs_Device *dev,
64 yaffs_ExtendedTags *tags,
66 static int yaffs_PutChunkIntoFile(yaffs_Object *in, int chunkInInode,
67 int chunkInNAND, int inScan);
69 static yaffs_Object *yaffs_CreateNewObject(yaffs_Device *dev, int number,
70 yaffs_ObjectType type);
71 static void yaffs_AddObjectToDirectory(yaffs_Object *directory,
73 static int yaffs_UpdateObjectHeader(yaffs_Object *in, const YCHAR *name,
74 int force, int isShrink, int shadows);
75 static void yaffs_RemoveObjectFromDirectory(yaffs_Object *obj);
76 static int yaffs_CheckStructures(void);
77 static int yaffs_DeleteWorker(yaffs_Object *in, yaffs_Tnode *tn, __u32 level,
78 int chunkOffset, int *limit);
79 static int yaffs_DoGenericObjectDeletion(yaffs_Object *in);
81 static yaffs_BlockInfo *yaffs_GetBlockInfo(yaffs_Device *dev, int blockNo);
84 static int yaffs_CheckChunkErased(struct yaffs_DeviceStruct *dev,
87 static int yaffs_UnlinkWorker(yaffs_Object *obj);
89 static int yaffs_TagsMatch(const yaffs_ExtendedTags *tags, int objectId,
92 static int yaffs_AllocateChunk(yaffs_Device *dev, int useReserve,
93 yaffs_BlockInfo **blockUsedPtr);
95 static void yaffs_VerifyFreeChunks(yaffs_Device *dev);
97 static void yaffs_CheckObjectDetailsLoaded(yaffs_Object *in);
99 static void yaffs_VerifyDirectory(yaffs_Object *directory);
100 #ifdef YAFFS_PARANOID
101 static int yaffs_CheckFileSanity(yaffs_Object *in);
103 #define yaffs_CheckFileSanity(in)
106 static void yaffs_InvalidateWholeChunkCache(yaffs_Object *in);
107 static void yaffs_InvalidateChunkCache(yaffs_Object *object, int chunkId);
109 static void yaffs_InvalidateCheckpoint(yaffs_Device *dev);
111 static int yaffs_FindChunkInFile(yaffs_Object *in, int chunkInInode,
112 yaffs_ExtendedTags *tags);
114 static __u32 yaffs_GetChunkGroupBase(yaffs_Device *dev, yaffs_Tnode *tn,
116 static yaffs_Tnode *yaffs_FindLevel0Tnode(yaffs_Device *dev,
117 yaffs_FileStructure *fStruct,
120 static int yaffs_HandleHole(yaffs_Object *obj, loff_t newSize);
121 static void yaffs_SkipRestOfBlock(yaffs_Device *dev);
122 static int yaffs_VerifyChunkWritten(yaffs_Device *dev,
125 yaffs_ExtendedTags *tags);
127 /* Function to calculate chunk and offset */
129 static void yaffs_AddrToChunk(yaffs_Device *dev, loff_t addr, int *chunkOut,
135 chunk = (__u32)(addr >> dev->chunkShift);
137 if (dev->chunkDiv == 1) {
138 /* easy power of 2 case */
139 offset = (__u32)(addr & dev->chunkMask);
141 /* Non power-of-2 case */
145 chunk /= dev->chunkDiv;
147 chunkBase = ((loff_t)chunk) * dev->nDataBytesPerChunk;
148 offset = (__u32)(addr - chunkBase);
155 /* Function to return the number of shifts for a power of 2 greater than or
156 * equal to the given number
157 * Note we don't try to cater for all possible numbers and this does not have to
158 * be hellishly efficient.
161 static __u32 ShiftsGE(__u32 x)
166 nShifts = extraBits = 0;
181 /* Function to return the number of shifts to get a 1 in bit 0
184 static __u32 Shifts(__u32 x)
204 * Temporary buffer manipulations.
207 static int yaffs_InitialiseTempBuffers(yaffs_Device *dev)
210 __u8 *buf = (__u8 *)1;
212 memset(dev->tempBuffer, 0, sizeof(dev->tempBuffer));
214 for (i = 0; buf && i < YAFFS_N_TEMP_BUFFERS; i++) {
215 dev->tempBuffer[i].line = 0; /* not in use */
216 dev->tempBuffer[i].buffer = buf =
217 YMALLOC_DMA(dev->param.totalBytesPerChunk);
220 return buf ? YAFFS_OK : YAFFS_FAIL;
223 __u8 *yaffs_GetTempBuffer(yaffs_Device *dev, int lineNo)
228 if (dev->tempInUse > dev->maxTemp)
229 dev->maxTemp = dev->tempInUse;
231 for (i = 0; i < YAFFS_N_TEMP_BUFFERS; i++) {
232 if (dev->tempBuffer[i].line == 0) {
233 dev->tempBuffer[i].line = lineNo;
234 if ((i + 1) > dev->maxTemp) {
235 dev->maxTemp = i + 1;
236 for (j = 0; j <= i; j++)
237 dev->tempBuffer[j].maxLine =
238 dev->tempBuffer[j].line;
241 return dev->tempBuffer[i].buffer;
245 T(YAFFS_TRACE_BUFFERS,
246 (TSTR("Out of temp buffers at line %d, other held by lines:"),
248 for (i = 0; i < YAFFS_N_TEMP_BUFFERS; i++)
249 T(YAFFS_TRACE_BUFFERS, (TSTR(" %d "), dev->tempBuffer[i].line));
251 T(YAFFS_TRACE_BUFFERS, (TSTR(" " TENDSTR)));
254 * If we got here then we have to allocate an unmanaged one
258 dev->unmanagedTempAllocations++;
259 return YMALLOC(dev->nDataBytesPerChunk);
263 void yaffs_ReleaseTempBuffer(yaffs_Device *dev, __u8 *buffer,
270 for (i = 0; i < YAFFS_N_TEMP_BUFFERS; i++) {
271 if (dev->tempBuffer[i].buffer == buffer) {
272 dev->tempBuffer[i].line = 0;
278 /* assume it is an unmanaged one. */
279 T(YAFFS_TRACE_BUFFERS,
280 (TSTR("Releasing unmanaged temp buffer in line %d" TENDSTR),
283 dev->unmanagedTempDeallocations++;
289 * Determine if we have a managed buffer.
291 int yaffs_IsManagedTempBuffer(yaffs_Device *dev, const __u8 *buffer)
295 for (i = 0; i < YAFFS_N_TEMP_BUFFERS; i++) {
296 if (dev->tempBuffer[i].buffer == buffer)
300 for (i = 0; i < dev->param.nShortOpCaches; i++) {
301 if (dev->srCache[i].data == buffer)
305 if (buffer == dev->checkpointBuffer)
308 T(YAFFS_TRACE_ALWAYS,
309 (TSTR("yaffs: unmaged buffer detected.\n" TENDSTR)));
316 * Chunk bitmap manipulations
319 static Y_INLINE __u8 *yaffs_BlockBits(yaffs_Device *dev, int blk)
321 if (blk < dev->internalStartBlock || blk > dev->internalEndBlock) {
323 (TSTR("**>> yaffs: BlockBits block %d is not valid" TENDSTR),
327 return dev->chunkBits +
328 (dev->chunkBitmapStride * (blk - dev->internalStartBlock));
331 static Y_INLINE void yaffs_VerifyChunkBitId(yaffs_Device *dev, int blk, int chunk)
333 if (blk < dev->internalStartBlock || blk > dev->internalEndBlock ||
334 chunk < 0 || chunk >= dev->param.nChunksPerBlock) {
336 (TSTR("**>> yaffs: Chunk Id (%d:%d) invalid"TENDSTR),
342 static Y_INLINE void yaffs_ClearChunkBits(yaffs_Device *dev, int blk)
344 __u8 *blkBits = yaffs_BlockBits(dev, blk);
346 memset(blkBits, 0, dev->chunkBitmapStride);
349 static Y_INLINE void yaffs_ClearChunkBit(yaffs_Device *dev, int blk, int chunk)
351 __u8 *blkBits = yaffs_BlockBits(dev, blk);
353 yaffs_VerifyChunkBitId(dev, blk, chunk);
355 blkBits[chunk / 8] &= ~(1 << (chunk & 7));
358 static Y_INLINE void yaffs_SetChunkBit(yaffs_Device *dev, int blk, int chunk)
360 __u8 *blkBits = yaffs_BlockBits(dev, blk);
362 yaffs_VerifyChunkBitId(dev, blk, chunk);
364 blkBits[chunk / 8] |= (1 << (chunk & 7));
367 static Y_INLINE int yaffs_CheckChunkBit(yaffs_Device *dev, int blk, int chunk)
369 __u8 *blkBits = yaffs_BlockBits(dev, blk);
370 yaffs_VerifyChunkBitId(dev, blk, chunk);
372 return (blkBits[chunk / 8] & (1 << (chunk & 7))) ? 1 : 0;
375 static Y_INLINE int yaffs_StillSomeChunkBits(yaffs_Device *dev, int blk)
377 __u8 *blkBits = yaffs_BlockBits(dev, blk);
379 for (i = 0; i < dev->chunkBitmapStride; i++) {
387 static int yaffs_CountChunkBits(yaffs_Device *dev, int blk)
389 __u8 *blkBits = yaffs_BlockBits(dev, blk);
392 for (i = 0; i < dev->chunkBitmapStride; i++) {
409 static int yaffs_SkipVerification(yaffs_Device *dev)
412 return !(yaffs_traceMask & (YAFFS_TRACE_VERIFY | YAFFS_TRACE_VERIFY_FULL));
415 static int yaffs_SkipFullVerification(yaffs_Device *dev)
418 return !(yaffs_traceMask & (YAFFS_TRACE_VERIFY_FULL));
421 static int yaffs_SkipNANDVerification(yaffs_Device *dev)
424 return !(yaffs_traceMask & (YAFFS_TRACE_VERIFY_NAND));
427 static const char *blockStateName[] = {
440 static void yaffs_VerifyBlock(yaffs_Device *dev, yaffs_BlockInfo *bi, int n)
445 if (yaffs_SkipVerification(dev))
448 /* Report illegal runtime states */
449 if (bi->blockState >= YAFFS_NUMBER_OF_BLOCK_STATES)
450 T(YAFFS_TRACE_VERIFY, (TSTR("Block %d has undefined state %d"TENDSTR), n, bi->blockState));
452 switch (bi->blockState) {
453 case YAFFS_BLOCK_STATE_UNKNOWN:
454 case YAFFS_BLOCK_STATE_SCANNING:
455 case YAFFS_BLOCK_STATE_NEEDS_SCANNING:
456 T(YAFFS_TRACE_VERIFY, (TSTR("Block %d has bad run-state %s"TENDSTR),
457 n, blockStateName[bi->blockState]));
460 /* Check pages in use and soft deletions are legal */
462 actuallyUsed = bi->pagesInUse - bi->softDeletions;
464 if (bi->pagesInUse < 0 || bi->pagesInUse > dev->param.nChunksPerBlock ||
465 bi->softDeletions < 0 || bi->softDeletions > dev->param.nChunksPerBlock ||
466 actuallyUsed < 0 || actuallyUsed > dev->param.nChunksPerBlock)
467 T(YAFFS_TRACE_VERIFY, (TSTR("Block %d has illegal values pagesInUsed %d softDeletions %d"TENDSTR),
468 n, bi->pagesInUse, bi->softDeletions));
471 /* Check chunk bitmap legal */
472 inUse = yaffs_CountChunkBits(dev, n);
473 if (inUse != bi->pagesInUse)
474 T(YAFFS_TRACE_VERIFY, (TSTR("Block %d has inconsistent values pagesInUse %d counted chunk bits %d"TENDSTR),
475 n, bi->pagesInUse, inUse));
477 /* Check that the sequence number is valid.
478 * Ten million is legal, but is very unlikely
480 if (dev->param.isYaffs2 &&
481 (bi->blockState == YAFFS_BLOCK_STATE_ALLOCATING || bi->blockState == YAFFS_BLOCK_STATE_FULL) &&
482 (bi->sequenceNumber < YAFFS_LOWEST_SEQUENCE_NUMBER || bi->sequenceNumber > 10000000))
483 T(YAFFS_TRACE_VERIFY, (TSTR("Block %d has suspect sequence number of %d"TENDSTR),
484 n, bi->sequenceNumber));
487 static void yaffs_VerifyCollectedBlock(yaffs_Device *dev, yaffs_BlockInfo *bi,
490 yaffs_VerifyBlock(dev, bi, n);
492 /* After collection the block should be in the erased state */
493 /* This will need to change if we do partial gc */
495 if (bi->blockState != YAFFS_BLOCK_STATE_COLLECTING &&
496 bi->blockState != YAFFS_BLOCK_STATE_EMPTY) {
497 T(YAFFS_TRACE_ERROR, (TSTR("Block %d is in state %d after gc, should be erased"TENDSTR),
502 static void yaffs_VerifyBlocks(yaffs_Device *dev)
505 int nBlocksPerState[YAFFS_NUMBER_OF_BLOCK_STATES];
506 int nIllegalBlockStates = 0;
508 if (yaffs_SkipVerification(dev))
511 memset(nBlocksPerState, 0, sizeof(nBlocksPerState));
513 for (i = dev->internalStartBlock; i <= dev->internalEndBlock; i++) {
514 yaffs_BlockInfo *bi = yaffs_GetBlockInfo(dev, i);
515 yaffs_VerifyBlock(dev, bi, i);
517 if (bi->blockState < YAFFS_NUMBER_OF_BLOCK_STATES)
518 nBlocksPerState[bi->blockState]++;
520 nIllegalBlockStates++;
523 T(YAFFS_TRACE_VERIFY, (TSTR(""TENDSTR)));
524 T(YAFFS_TRACE_VERIFY, (TSTR("Block summary"TENDSTR)));
526 T(YAFFS_TRACE_VERIFY, (TSTR("%d blocks have illegal states"TENDSTR), nIllegalBlockStates));
527 if (nBlocksPerState[YAFFS_BLOCK_STATE_ALLOCATING] > 1)
528 T(YAFFS_TRACE_VERIFY, (TSTR("Too many allocating blocks"TENDSTR)));
530 for (i = 0; i < YAFFS_NUMBER_OF_BLOCK_STATES; i++)
531 T(YAFFS_TRACE_VERIFY,
532 (TSTR("%s %d blocks"TENDSTR),
533 blockStateName[i], nBlocksPerState[i]));
535 if (dev->blocksInCheckpoint != nBlocksPerState[YAFFS_BLOCK_STATE_CHECKPOINT])
536 T(YAFFS_TRACE_VERIFY,
537 (TSTR("Checkpoint block count wrong dev %d count %d"TENDSTR),
538 dev->blocksInCheckpoint, nBlocksPerState[YAFFS_BLOCK_STATE_CHECKPOINT]));
540 if (dev->nErasedBlocks != nBlocksPerState[YAFFS_BLOCK_STATE_EMPTY])
541 T(YAFFS_TRACE_VERIFY,
542 (TSTR("Erased block count wrong dev %d count %d"TENDSTR),
543 dev->nErasedBlocks, nBlocksPerState[YAFFS_BLOCK_STATE_EMPTY]));
545 if (nBlocksPerState[YAFFS_BLOCK_STATE_COLLECTING] > 1)
546 T(YAFFS_TRACE_VERIFY,
547 (TSTR("Too many collecting blocks %d (max is 1)"TENDSTR),
548 nBlocksPerState[YAFFS_BLOCK_STATE_COLLECTING]));
550 T(YAFFS_TRACE_VERIFY, (TSTR(""TENDSTR)));
555 * Verify the object header. oh must be valid, but obj and tags may be NULL in which
556 * case those tests will not be performed.
558 static void yaffs_VerifyObjectHeader(yaffs_Object *obj, yaffs_ObjectHeader *oh, yaffs_ExtendedTags *tags, int parentCheck)
560 if (obj && yaffs_SkipVerification(obj->myDev))
563 if (!(tags && obj && oh)) {
564 T(YAFFS_TRACE_VERIFY,
565 (TSTR("Verifying object header tags %p obj %p oh %p"TENDSTR),
570 if (oh->type <= YAFFS_OBJECT_TYPE_UNKNOWN ||
571 oh->type > YAFFS_OBJECT_TYPE_MAX)
572 T(YAFFS_TRACE_VERIFY,
573 (TSTR("Obj %d header type is illegal value 0x%x"TENDSTR),
574 tags->objectId, oh->type));
576 if (tags->objectId != obj->objectId)
577 T(YAFFS_TRACE_VERIFY,
578 (TSTR("Obj %d header mismatch objectId %d"TENDSTR),
579 tags->objectId, obj->objectId));
583 * Check that the object's parent ids match if parentCheck requested.
585 * Tests do not apply to the root object.
588 if (parentCheck && tags->objectId > 1 && !obj->parent)
589 T(YAFFS_TRACE_VERIFY,
590 (TSTR("Obj %d header mismatch parentId %d obj->parent is NULL"TENDSTR),
591 tags->objectId, oh->parentObjectId));
593 if (parentCheck && obj->parent &&
594 oh->parentObjectId != obj->parent->objectId &&
595 (oh->parentObjectId != YAFFS_OBJECTID_UNLINKED ||
596 obj->parent->objectId != YAFFS_OBJECTID_DELETED))
597 T(YAFFS_TRACE_VERIFY,
598 (TSTR("Obj %d header mismatch parentId %d parentObjectId %d"TENDSTR),
599 tags->objectId, oh->parentObjectId, obj->parent->objectId));
601 if (tags->objectId > 1 && oh->name[0] == 0) /* Null name */
602 T(YAFFS_TRACE_VERIFY,
603 (TSTR("Obj %d header name is NULL"TENDSTR),
606 if (tags->objectId > 1 && ((__u8)(oh->name[0])) == 0xff) /* Trashed name */
607 T(YAFFS_TRACE_VERIFY,
608 (TSTR("Obj %d header name is 0xFF"TENDSTR),
614 static int yaffs_VerifyTnodeWorker(yaffs_Object *obj, yaffs_Tnode *tn,
615 __u32 level, int chunkOffset)
618 yaffs_Device *dev = obj->myDev;
624 for (i = 0; i < YAFFS_NTNODES_INTERNAL && ok; i++) {
625 if (tn->internal[i]) {
626 ok = yaffs_VerifyTnodeWorker(obj,
629 (chunkOffset<<YAFFS_TNODES_INTERNAL_BITS) + i);
632 } else if (level == 0) {
633 yaffs_ExtendedTags tags;
634 __u32 objectId = obj->objectId;
636 chunkOffset <<= YAFFS_TNODES_LEVEL0_BITS;
638 for (i = 0; i < YAFFS_NTNODES_LEVEL0; i++) {
639 __u32 theChunk = yaffs_GetChunkGroupBase(dev, tn, i);
642 /* T(~0,(TSTR("verifying (%d:%d) %d"TENDSTR),tags.objectId,tags.chunkId,theChunk)); */
643 yaffs_ReadChunkWithTagsFromNAND(dev, theChunk, NULL, &tags);
644 if (tags.objectId != objectId || tags.chunkId != chunkOffset) {
645 T(~0, (TSTR("Object %d chunkId %d NAND mismatch chunk %d tags (%d:%d)"TENDSTR),
646 objectId, chunkOffset, theChunk,
647 tags.objectId, tags.chunkId));
660 static void yaffs_VerifyFile(yaffs_Object *obj)
662 int requiredTallness;
668 yaffs_ExtendedTags tags;
675 if (yaffs_SkipVerification(obj->myDev))
679 objectId = obj->objectId;
681 /* Check file size is consistent with tnode depth */
682 lastChunk = obj->variant.fileVariant.fileSize / dev->nDataBytesPerChunk + 1;
683 x = lastChunk >> YAFFS_TNODES_LEVEL0_BITS;
684 requiredTallness = 0;
686 x >>= YAFFS_TNODES_INTERNAL_BITS;
690 actualTallness = obj->variant.fileVariant.topLevel;
692 /* Check that the chunks in the tnode tree are all correct.
693 * We do this by scanning through the tnode tree and
694 * checking the tags for every chunk match.
697 if (yaffs_SkipNANDVerification(dev))
700 for (i = 1; i <= lastChunk; i++) {
701 tn = yaffs_FindLevel0Tnode(dev, &obj->variant.fileVariant, i);
704 __u32 theChunk = yaffs_GetChunkGroupBase(dev, tn, i);
706 /* T(~0,(TSTR("verifying (%d:%d) %d"TENDSTR),objectId,i,theChunk)); */
707 yaffs_ReadChunkWithTagsFromNAND(dev, theChunk, NULL, &tags);
708 if (tags.objectId != objectId || tags.chunkId != i) {
709 T(~0, (TSTR("Object %d chunkId %d NAND mismatch chunk %d tags (%d:%d)"TENDSTR),
710 objectId, i, theChunk,
711 tags.objectId, tags.chunkId));
719 static void yaffs_VerifyHardLink(yaffs_Object *obj)
721 if (obj && yaffs_SkipVerification(obj->myDev))
724 /* Verify sane equivalent object */
727 static void yaffs_VerifySymlink(yaffs_Object *obj)
729 if (obj && yaffs_SkipVerification(obj->myDev))
732 /* Verify symlink string */
735 static void yaffs_VerifySpecial(yaffs_Object *obj)
737 if (obj && yaffs_SkipVerification(obj->myDev))
741 static void yaffs_VerifyObject(yaffs_Object *obj)
750 __u32 chunkShouldNotBeDeleted;
756 if (obj->beingCreated)
761 if (yaffs_SkipVerification(dev))
764 /* Check sane object header chunk */
766 chunkMin = dev->internalStartBlock * dev->param.nChunksPerBlock;
767 chunkMax = (dev->internalEndBlock+1) * dev->param.nChunksPerBlock - 1;
769 chunkInRange = (((unsigned)(obj->hdrChunk)) >= chunkMin && ((unsigned)(obj->hdrChunk)) <= chunkMax);
770 chunkIdOk = chunkInRange || (obj->hdrChunk == 0);
771 chunkValid = chunkInRange &&
772 yaffs_CheckChunkBit(dev,
773 obj->hdrChunk / dev->param.nChunksPerBlock,
774 obj->hdrChunk % dev->param.nChunksPerBlock);
775 chunkShouldNotBeDeleted = chunkInRange && !chunkValid;
778 (!chunkIdOk || chunkShouldNotBeDeleted)) {
779 T(YAFFS_TRACE_VERIFY,
780 (TSTR("Obj %d has chunkId %d %s %s"TENDSTR),
781 obj->objectId, obj->hdrChunk,
782 chunkIdOk ? "" : ",out of range",
783 chunkShouldNotBeDeleted ? ",marked as deleted" : ""));
786 if (chunkValid && !yaffs_SkipNANDVerification(dev)) {
787 yaffs_ExtendedTags tags;
788 yaffs_ObjectHeader *oh;
789 __u8 *buffer = yaffs_GetTempBuffer(dev, __LINE__);
791 oh = (yaffs_ObjectHeader *)buffer;
793 yaffs_ReadChunkWithTagsFromNAND(dev, obj->hdrChunk, buffer,
796 yaffs_VerifyObjectHeader(obj, oh, &tags, 1);
798 yaffs_ReleaseTempBuffer(dev, buffer, __LINE__);
801 /* Verify it has a parent */
802 if (obj && !obj->fake &&
803 (!obj->parent || obj->parent->myDev != dev)) {
804 T(YAFFS_TRACE_VERIFY,
805 (TSTR("Obj %d has parent pointer %p which does not look like an object"TENDSTR),
806 obj->objectId, obj->parent));
809 /* Verify parent is a directory */
810 if (obj->parent && obj->parent->variantType != YAFFS_OBJECT_TYPE_DIRECTORY) {
811 T(YAFFS_TRACE_VERIFY,
812 (TSTR("Obj %d's parent is not a directory (type %d)"TENDSTR),
813 obj->objectId, obj->parent->variantType));
816 switch (obj->variantType) {
817 case YAFFS_OBJECT_TYPE_FILE:
818 yaffs_VerifyFile(obj);
820 case YAFFS_OBJECT_TYPE_SYMLINK:
821 yaffs_VerifySymlink(obj);
823 case YAFFS_OBJECT_TYPE_DIRECTORY:
824 yaffs_VerifyDirectory(obj);
826 case YAFFS_OBJECT_TYPE_HARDLINK:
827 yaffs_VerifyHardLink(obj);
829 case YAFFS_OBJECT_TYPE_SPECIAL:
830 yaffs_VerifySpecial(obj);
832 case YAFFS_OBJECT_TYPE_UNKNOWN:
834 T(YAFFS_TRACE_VERIFY,
835 (TSTR("Obj %d has illegaltype %d"TENDSTR),
836 obj->objectId, obj->variantType));
841 static void yaffs_VerifyObjects(yaffs_Device *dev)
845 struct ylist_head *lh;
847 if (yaffs_SkipVerification(dev))
850 /* Iterate through the objects in each hash entry */
852 for (i = 0; i < YAFFS_NOBJECT_BUCKETS; i++) {
853 ylist_for_each(lh, &dev->objectBucket[i].list) {
855 obj = ylist_entry(lh, yaffs_Object, hashLink);
856 yaffs_VerifyObject(obj);
864 * Simple hash function. Needs to have a reasonable spread
867 static Y_INLINE int yaffs_HashFunction(int n)
870 return n % YAFFS_NOBJECT_BUCKETS;
874 * Access functions to useful fake objects.
875 * Note that root might have a presence in NAND if permissions are set.
878 yaffs_Object *yaffs_Root(yaffs_Device *dev)
883 yaffs_Object *yaffs_LostNFound(yaffs_Device *dev)
885 return dev->lostNFoundDir;
890 * Erased NAND checking functions
893 int yaffs_CheckFF(__u8 *buffer, int nBytes)
895 /* Horrible, slow implementation */
904 static int yaffs_CheckChunkErased(struct yaffs_DeviceStruct *dev,
907 int retval = YAFFS_OK;
908 __u8 *data = yaffs_GetTempBuffer(dev, __LINE__);
909 yaffs_ExtendedTags tags;
912 result = yaffs_ReadChunkWithTagsFromNAND(dev, chunkInNAND, data, &tags);
914 if (tags.eccResult > YAFFS_ECC_RESULT_NO_ERROR)
917 if (!yaffs_CheckFF(data, dev->nDataBytesPerChunk) || tags.chunkUsed) {
918 T(YAFFS_TRACE_NANDACCESS,
919 (TSTR("Chunk %d not erased" TENDSTR), chunkInNAND));
923 yaffs_ReleaseTempBuffer(dev, data, __LINE__);
930 static int yaffs_VerifyChunkWritten(yaffs_Device *dev,
933 yaffs_ExtendedTags *tags)
935 int retval = YAFFS_OK;
936 yaffs_ExtendedTags tempTags;
937 __u8 *buffer = yaffs_GetTempBuffer(dev,__LINE__);
940 result = yaffs_ReadChunkWithTagsFromNAND(dev,chunkInNAND,buffer,&tempTags);
941 if(memcmp(buffer,data,dev->nDataBytesPerChunk) ||
942 tempTags.objectId != tags->objectId ||
943 tempTags.chunkId != tags->chunkId ||
944 tempTags.byteCount != tags->byteCount)
947 yaffs_ReleaseTempBuffer(dev, buffer, __LINE__);
952 static int yaffs_WriteNewChunkWithTagsToNAND(struct yaffs_DeviceStruct *dev,
954 yaffs_ExtendedTags *tags,
961 yaffs_InvalidateCheckpoint(dev);
964 yaffs_BlockInfo *bi = 0;
967 chunk = yaffs_AllocateChunk(dev, useReserve, &bi);
973 /* First check this chunk is erased, if it needs
974 * checking. The checking policy (unless forced
975 * always on) is as follows:
977 * Check the first page we try to write in a block.
978 * If the check passes then we don't need to check any
979 * more. If the check fails, we check again...
980 * If the block has been erased, we don't need to check.
982 * However, if the block has been prioritised for gc,
983 * then we think there might be something odd about
984 * this block and stop using it.
986 * Rationale: We should only ever see chunks that have
987 * not been erased if there was a partially written
988 * chunk due to power loss. This checking policy should
989 * catch that case with very few checks and thus save a
990 * lot of checks that are most likely not needed.
993 * If an erase check fails or the write fails we skip the
997 /* let's give it a try */
1000 #ifdef CONFIG_YAFFS_ALWAYS_CHECK_CHUNK_ERASED
1001 bi->skipErasedCheck = 0;
1003 if (!bi->skipErasedCheck) {
1004 erasedOk = yaffs_CheckChunkErased(dev, chunk);
1005 if (erasedOk != YAFFS_OK) {
1006 T(YAFFS_TRACE_ERROR,
1007 (TSTR("**>> yaffs chunk %d was not erased"
1010 /* If not erased, delete this one,
1011 * skip rest of block and
1012 * try another chunk */
1013 yaffs_DeleteChunk(dev,chunk,1,__LINE__);
1014 yaffs_SkipRestOfBlock(dev);
1019 writeOk = yaffs_WriteChunkWithTagsToNAND(dev, chunk,
1022 if(!bi->skipErasedCheck)
1023 writeOk = yaffs_VerifyChunkWritten(dev, chunk, data, tags);
1025 if (writeOk != YAFFS_OK) {
1026 /* Clean up aborted write, skip to next block and
1027 * try another chunk */
1028 yaffs_HandleWriteChunkError(dev, chunk, erasedOk);
1032 bi->skipErasedCheck = 1;
1034 /* Copy the data into the robustification buffer */
1035 yaffs_HandleWriteChunkOk(dev, chunk, data, tags);
1037 } while (writeOk != YAFFS_OK &&
1038 (yaffs_wr_attempts <= 0 || attempts <= yaffs_wr_attempts));
1044 T(YAFFS_TRACE_ERROR,
1045 (TSTR("**>> yaffs write required %d attempts" TENDSTR),
1048 dev->nRetriedWrites += (attempts - 1);
1056 * Oldest Dirty Sequence Number handling.
1059 /* yaffs_CalcOldestDirtySequence()
1060 * yaffs_FindOldestDirtySequence()
1061 * Calculate the oldest dirty sequence number if we don't know it.
1063 static void yaffs_CalcOldestDirtySequence(yaffs_Device *dev)
1067 unsigned blockNo = 0;
1070 if(!dev->param.isYaffs2)
1073 /* Find the oldest dirty sequence number. */
1074 seq = dev->sequenceNumber + 1;
1076 for (i = dev->internalStartBlock; i <= dev->internalEndBlock; i++) {
1077 if (b->blockState == YAFFS_BLOCK_STATE_FULL &&
1078 (b->pagesInUse - b->softDeletions) < dev->param.nChunksPerBlock &&
1079 b->sequenceNumber < seq) {
1080 seq = b->sequenceNumber;
1087 dev->oldestDirtySequence = seq;
1088 dev->oldestDirtyBlock = blockNo;
1094 static void yaffs_FindOldestDirtySequence(yaffs_Device *dev)
1096 if(dev->param.isYaffs2 && !dev->oldestDirtySequence)
1097 yaffs_CalcOldestDirtySequence(dev);
1101 * yaffs_ClearOldestDirtySequence()
1102 * Called when a block is erased or marked bad. (ie. when its sequenceNumber
1103 * becomes invalid). If the value matches the oldest then we clear
1104 * dev->oldestDirtySequence to force its recomputation.
1106 static void yaffs_ClearOldestDirtySequence(yaffs_Device *dev, yaffs_BlockInfo *bi)
1109 if(!dev->param.isYaffs2)
1112 if(!bi || bi->sequenceNumber == dev->oldestDirtySequence){
1113 dev->oldestDirtySequence = 0;
1114 dev->oldestDirtyBlock = 0;
1119 * yaffs_UpdateOldestDirtySequence()
1120 * Update the oldest dirty sequence number whenever we dirty a block.
1121 * Only do this if the oldestDirtySequence is actually being tracked.
1123 static void yaffs_UpdateOldestDirtySequence(yaffs_Device *dev, unsigned blockNo, yaffs_BlockInfo *bi)
1125 if(dev->param.isYaffs2 && dev->oldestDirtySequence){
1126 if(dev->oldestDirtySequence > bi->sequenceNumber){
1127 dev->oldestDirtySequence = bi->sequenceNumber;
1128 dev->oldestDirtyBlock = blockNo;
1134 * Block retiring for handling a broken block.
1137 static void yaffs_RetireBlock(yaffs_Device *dev, int blockInNAND)
1139 yaffs_BlockInfo *bi = yaffs_GetBlockInfo(dev, blockInNAND);
1141 yaffs_InvalidateCheckpoint(dev);
1143 yaffs_ClearOldestDirtySequence(dev,bi);
1145 if (yaffs_MarkBlockBad(dev, blockInNAND) != YAFFS_OK) {
1146 if (yaffs_EraseBlockInNAND(dev, blockInNAND) != YAFFS_OK) {
1147 T(YAFFS_TRACE_ALWAYS, (TSTR(
1148 "yaffs: Failed to mark bad and erase block %d"
1149 TENDSTR), blockInNAND));
1151 yaffs_ExtendedTags tags;
1152 int chunkId = blockInNAND * dev->param.nChunksPerBlock;
1154 __u8 *buffer = yaffs_GetTempBuffer(dev, __LINE__);
1156 memset(buffer, 0xff, dev->nDataBytesPerChunk);
1157 yaffs_InitialiseTags(&tags);
1158 tags.sequenceNumber = YAFFS_SEQUENCE_BAD_BLOCK;
1159 if (dev->param.writeChunkWithTagsToNAND(dev, chunkId -
1160 dev->chunkOffset, buffer, &tags) != YAFFS_OK)
1161 T(YAFFS_TRACE_ALWAYS, (TSTR("yaffs: Failed to "
1162 TCONT("write bad block marker to block %d")
1163 TENDSTR), blockInNAND));
1165 yaffs_ReleaseTempBuffer(dev, buffer, __LINE__);
1169 bi->blockState = YAFFS_BLOCK_STATE_DEAD;
1170 bi->gcPrioritise = 0;
1171 bi->needsRetiring = 0;
1173 dev->nRetiredBlocks++;
1177 * Functions for robustisizing TODO
1181 static void yaffs_HandleWriteChunkOk(yaffs_Device *dev, int chunkInNAND,
1183 const yaffs_ExtendedTags *tags)
1186 chunkInNAND=chunkInNAND;
1191 static void yaffs_HandleUpdateChunk(yaffs_Device *dev, int chunkInNAND,
1192 const yaffs_ExtendedTags *tags)
1195 chunkInNAND=chunkInNAND;
1199 void yaffs_HandleChunkError(yaffs_Device *dev, yaffs_BlockInfo *bi)
1201 if (!bi->gcPrioritise) {
1202 bi->gcPrioritise = 1;
1203 dev->hasPendingPrioritisedGCs = 1;
1204 bi->chunkErrorStrikes++;
1206 if (bi->chunkErrorStrikes > 3) {
1207 bi->needsRetiring = 1; /* Too many stikes, so retire this */
1208 T(YAFFS_TRACE_ALWAYS, (TSTR("yaffs: Block struck out" TENDSTR)));
1214 static void yaffs_HandleWriteChunkError(yaffs_Device *dev, int chunkInNAND,
1217 int blockInNAND = chunkInNAND / dev->param.nChunksPerBlock;
1218 yaffs_BlockInfo *bi = yaffs_GetBlockInfo(dev, blockInNAND);
1220 yaffs_HandleChunkError(dev, bi);
1223 /* Was an actual write failure, so mark the block for retirement */
1224 bi->needsRetiring = 1;
1225 T(YAFFS_TRACE_ERROR | YAFFS_TRACE_BAD_BLOCKS,
1226 (TSTR("**>> Block %d needs retiring" TENDSTR), blockInNAND));
1229 /* Delete the chunk */
1230 yaffs_DeleteChunk(dev, chunkInNAND, 1, __LINE__);
1231 yaffs_SkipRestOfBlock(dev);
1235 /*---------------- Name handling functions ------------*/
1237 static __u16 yaffs_CalcNameSum(const YCHAR *name)
1242 const YUCHAR *bname = (const YUCHAR *) name;
1244 while ((*bname) && (i < (YAFFS_MAX_NAME_LENGTH/2))) {
1246 #ifdef CONFIG_YAFFS_CASE_INSENSITIVE
1247 sum += yaffs_toupper(*bname) * i;
1249 sum += (*bname) * i;
1258 static void yaffs_SetObjectName(yaffs_Object *obj, const YCHAR *name)
1260 #ifdef CONFIG_YAFFS_SHORT_NAMES_IN_RAM
1261 memset(obj->shortName, 0, sizeof(YCHAR) * (YAFFS_SHORT_NAME_LENGTH+1));
1262 if (name && yaffs_strnlen(name,YAFFS_SHORT_NAME_LENGTH+1) <= YAFFS_SHORT_NAME_LENGTH)
1263 yaffs_strcpy(obj->shortName, name);
1265 obj->shortName[0] = _Y('\0');
1267 obj->sum = yaffs_CalcNameSum(name);
1270 /*-------------------- TNODES -------------------
1272 * List of spare tnodes
1273 * The list is hooked together using the first pointer
1277 /* yaffs_CreateTnodes creates a bunch more tnodes and
1278 * adds them to the tnode free list.
1279 * Don't use this function directly
1281 static Y_INLINE int yaffs_CalcTnodeSize(yaffs_Device *dev)
1284 /* Calculate the tnode size in bytes for variable width tnode support.
1285 * Must be a multiple of 32-bits */
1286 tnodeSize = (dev->tnodeWidth * YAFFS_NTNODES_LEVEL0)/8;
1288 if (tnodeSize < sizeof(yaffs_Tnode))
1289 tnodeSize = sizeof(yaffs_Tnode);
1293 static int yaffs_CreateTnodes(yaffs_Device *dev, int nTnodes)
1296 int tnodeSize = yaffs_CalcTnodeSize(dev);
1297 yaffs_Tnode *newTnodes;
1301 yaffs_TnodeList *tnl;
1307 /* make these things */
1309 newTnodes = YMALLOC(nTnodes * tnodeSize);
1310 mem = (__u8 *)newTnodes;
1313 T(YAFFS_TRACE_ERROR,
1314 (TSTR("yaffs: Could not allocate Tnodes" TENDSTR)));
1318 /* Hook them into the free list */
1320 for (i = 0; i < nTnodes - 1; i++) {
1321 newTnodes[i].internal[0] = &newTnodes[i + 1];
1322 #ifdef CONFIG_YAFFS_TNODE_LIST_DEBUG
1323 newTnodes[i].internal[YAFFS_NTNODES_INTERNAL] = (void *)1;
1327 newTnodes[nTnodes - 1].internal[0] = dev->freeTnodes;
1328 #ifdef CONFIG_YAFFS_TNODE_LIST_DEBUG
1329 newTnodes[nTnodes - 1].internal[YAFFS_NTNODES_INTERNAL] = (void *)1;
1331 dev->freeTnodes = newTnodes;
1333 /* New hookup for wide tnodes */
1334 for (i = 0; i < nTnodes - 1; i++) {
1335 curr = (yaffs_Tnode *) &mem[i * tnodeSize];
1336 next = (yaffs_Tnode *) &mem[(i+1) * tnodeSize];
1337 curr->internal[0] = next;
1340 curr = (yaffs_Tnode *) &mem[(nTnodes - 1) * tnodeSize];
1341 curr->internal[0] = dev->freeTnodes;
1342 dev->freeTnodes = (yaffs_Tnode *)mem;
1347 dev->nFreeTnodes += nTnodes;
1348 dev->nTnodesCreated += nTnodes;
1350 /* Now add this bunch of tnodes to a list for freeing up.
1351 * NB If we can't add this to the management list it isn't fatal
1352 * but it just means we can't free this bunch of tnodes later.
1355 tnl = YMALLOC(sizeof(yaffs_TnodeList));
1357 T(YAFFS_TRACE_ERROR,
1359 ("yaffs: Could not add tnodes to management list" TENDSTR)));
1362 tnl->tnodes = newTnodes;
1363 tnl->next = dev->allocatedTnodeList;
1364 dev->allocatedTnodeList = tnl;
1367 T(YAFFS_TRACE_ALLOCATE, (TSTR("yaffs: Tnodes added" TENDSTR)));
1372 /* GetTnode gets us a clean tnode. Tries to make allocate more if we run out */
1374 static yaffs_Tnode *yaffs_GetTnodeRaw(yaffs_Device *dev)
1376 yaffs_Tnode *tn = NULL;
1378 #ifdef CONFIG_YAFFS_VALGRIND_TEST
1379 tn = YMALLOC(yaffs_CalcTnodeSize(dev));
1381 dev->nTnodesCreated++;
1383 /* If there are none left make more */
1384 if (!dev->freeTnodes)
1385 yaffs_CreateTnodes(dev, YAFFS_ALLOCATION_NTNODES);
1387 if (dev->freeTnodes) {
1388 tn = dev->freeTnodes;
1389 #ifdef CONFIG_YAFFS_TNODE_LIST_DEBUG
1390 if (tn->internal[YAFFS_NTNODES_INTERNAL] != (void *)1) {
1391 /* Hoosterman, this thing looks like it isn't in the list */
1392 T(YAFFS_TRACE_ALWAYS,
1393 (TSTR("yaffs: Tnode list bug 1" TENDSTR)));
1396 dev->freeTnodes = dev->freeTnodes->internal[0];
1400 dev->nCheckpointBlocksRequired = 0; /* force recalculation*/
1405 static yaffs_Tnode *yaffs_GetTnode(yaffs_Device *dev)
1407 yaffs_Tnode *tn = yaffs_GetTnodeRaw(dev);
1408 int tnodeSize = yaffs_CalcTnodeSize(dev);
1411 memset(tn, 0, tnodeSize);
1416 /* FreeTnode frees up a tnode and puts it back on the free list */
1417 static void yaffs_FreeTnode(yaffs_Device *dev, yaffs_Tnode *tn)
1420 #ifdef CONFIG_YAFFS_VALGRIND_TEST
1422 dev->nTnodesCreated--;
1424 #ifdef CONFIG_YAFFS_TNODE_LIST_DEBUG
1425 if (tn->internal[YAFFS_NTNODES_INTERNAL] != 0) {
1426 /* Hoosterman, this thing looks like it is already in the list */
1427 T(YAFFS_TRACE_ALWAYS,
1428 (TSTR("yaffs: Tnode list bug 2" TENDSTR)));
1430 tn->internal[YAFFS_NTNODES_INTERNAL] = (void *)1;
1432 tn->internal[0] = dev->freeTnodes;
1433 dev->freeTnodes = tn;
1437 dev->nCheckpointBlocksRequired = 0; /* force recalculation*/
1440 static void yaffs_DeinitialiseTnodes(yaffs_Device *dev)
1442 /* Free the list of allocated tnodes */
1443 yaffs_TnodeList *tmp;
1445 while (dev->allocatedTnodeList) {
1446 tmp = dev->allocatedTnodeList->next;
1448 YFREE(dev->allocatedTnodeList->tnodes);
1449 YFREE(dev->allocatedTnodeList);
1450 dev->allocatedTnodeList = tmp;
1454 dev->freeTnodes = NULL;
1455 dev->nFreeTnodes = 0;
1456 dev->nTnodesCreated = 0;
1459 static void yaffs_InitialiseTnodes(yaffs_Device *dev)
1461 dev->allocatedTnodeList = NULL;
1462 dev->freeTnodes = NULL;
1463 dev->nFreeTnodes = 0;
1464 dev->nTnodesCreated = 0;
1468 void yaffs_LoadLevel0Tnode(yaffs_Device *dev, yaffs_Tnode *tn, unsigned pos,
1471 __u32 *map = (__u32 *)tn;
1477 pos &= YAFFS_TNODES_LEVEL0_MASK;
1478 val >>= dev->chunkGroupBits;
1480 bitInMap = pos * dev->tnodeWidth;
1481 wordInMap = bitInMap / 32;
1482 bitInWord = bitInMap & (32 - 1);
1484 mask = dev->tnodeMask << bitInWord;
1486 map[wordInMap] &= ~mask;
1487 map[wordInMap] |= (mask & (val << bitInWord));
1489 if (dev->tnodeWidth > (32 - bitInWord)) {
1490 bitInWord = (32 - bitInWord);
1492 mask = dev->tnodeMask >> (/*dev->tnodeWidth -*/ bitInWord);
1493 map[wordInMap] &= ~mask;
1494 map[wordInMap] |= (mask & (val >> bitInWord));
1498 static __u32 yaffs_GetChunkGroupBase(yaffs_Device *dev, yaffs_Tnode *tn,
1501 __u32 *map = (__u32 *)tn;
1507 pos &= YAFFS_TNODES_LEVEL0_MASK;
1509 bitInMap = pos * dev->tnodeWidth;
1510 wordInMap = bitInMap / 32;
1511 bitInWord = bitInMap & (32 - 1);
1513 val = map[wordInMap] >> bitInWord;
1515 if (dev->tnodeWidth > (32 - bitInWord)) {
1516 bitInWord = (32 - bitInWord);
1518 val |= (map[wordInMap] << bitInWord);
1521 val &= dev->tnodeMask;
1522 val <<= dev->chunkGroupBits;
1527 /* ------------------- End of individual tnode manipulation -----------------*/
1529 /* ---------Functions to manipulate the look-up tree (made up of tnodes) ------
1530 * The look up tree is represented by the top tnode and the number of topLevel
1531 * in the tree. 0 means only the level 0 tnode is in the tree.
1534 /* FindLevel0Tnode finds the level 0 tnode, if one exists. */
1535 static yaffs_Tnode *yaffs_FindLevel0Tnode(yaffs_Device *dev,
1536 yaffs_FileStructure *fStruct,
1539 yaffs_Tnode *tn = fStruct->top;
1541 int requiredTallness;
1542 int level = fStruct->topLevel;
1546 /* Check sane level and chunk Id */
1547 if (level < 0 || level > YAFFS_TNODES_MAX_LEVEL)
1550 if (chunkId > YAFFS_MAX_CHUNK_ID)
1553 /* First check we're tall enough (ie enough topLevel) */
1555 i = chunkId >> YAFFS_TNODES_LEVEL0_BITS;
1556 requiredTallness = 0;
1558 i >>= YAFFS_TNODES_INTERNAL_BITS;
1562 if (requiredTallness > fStruct->topLevel)
1563 return NULL; /* Not tall enough, so we can't find it */
1565 /* Traverse down to level 0 */
1566 while (level > 0 && tn) {
1567 tn = tn->internal[(chunkId >>
1568 (YAFFS_TNODES_LEVEL0_BITS +
1570 YAFFS_TNODES_INTERNAL_BITS)) &
1571 YAFFS_TNODES_INTERNAL_MASK];
1578 /* AddOrFindLevel0Tnode finds the level 0 tnode if it exists, otherwise first expands the tree.
1579 * This happens in two steps:
1580 * 1. If the tree isn't tall enough, then make it taller.
1581 * 2. Scan down the tree towards the level 0 tnode adding tnodes if required.
1583 * Used when modifying the tree.
1585 * If the tn argument is NULL, then a fresh tnode will be added otherwise the specified tn will
1586 * be plugged into the ttree.
1589 static yaffs_Tnode *yaffs_AddOrFindLevel0Tnode(yaffs_Device *dev,
1590 yaffs_FileStructure *fStruct,
1592 yaffs_Tnode *passedTn)
1594 int requiredTallness;
1602 /* Check sane level and page Id */
1603 if (fStruct->topLevel < 0 || fStruct->topLevel > YAFFS_TNODES_MAX_LEVEL)
1606 if (chunkId > YAFFS_MAX_CHUNK_ID)
1609 /* First check we're tall enough (ie enough topLevel) */
1611 x = chunkId >> YAFFS_TNODES_LEVEL0_BITS;
1612 requiredTallness = 0;
1614 x >>= YAFFS_TNODES_INTERNAL_BITS;
1619 if (requiredTallness > fStruct->topLevel) {
1620 /* Not tall enough, gotta make the tree taller */
1621 for (i = fStruct->topLevel; i < requiredTallness; i++) {
1623 tn = yaffs_GetTnode(dev);
1626 tn->internal[0] = fStruct->top;
1628 fStruct->topLevel++;
1630 T(YAFFS_TRACE_ERROR,
1631 (TSTR("yaffs: no more tnodes" TENDSTR)));
1637 /* Traverse down to level 0, adding anything we need */
1639 l = fStruct->topLevel;
1643 while (l > 0 && tn) {
1645 (YAFFS_TNODES_LEVEL0_BITS +
1646 (l - 1) * YAFFS_TNODES_INTERNAL_BITS)) &
1647 YAFFS_TNODES_INTERNAL_MASK;
1650 if ((l > 1) && !tn->internal[x]) {
1651 /* Add missing non-level-zero tnode */
1652 tn->internal[x] = yaffs_GetTnode(dev);
1653 if(!tn->internal[x])
1655 } else if (l == 1) {
1656 /* Looking from level 1 at level 0 */
1658 /* If we already have one, then release it.*/
1659 if (tn->internal[x])
1660 yaffs_FreeTnode(dev, tn->internal[x]);
1661 tn->internal[x] = passedTn;
1663 } else if (!tn->internal[x]) {
1664 /* Don't have one, none passed in */
1665 tn->internal[x] = yaffs_GetTnode(dev);
1666 if(!tn->internal[x])
1671 tn = tn->internal[x];
1675 /* top is level 0 */
1677 memcpy(tn, passedTn, (dev->tnodeWidth * YAFFS_NTNODES_LEVEL0)/8);
1678 yaffs_FreeTnode(dev, passedTn);
1685 static int yaffs_FindChunkInGroup(yaffs_Device *dev, int theChunk,
1686 yaffs_ExtendedTags *tags, int objectId,
1691 for (j = 0; theChunk && j < dev->chunkGroupSize; j++) {
1692 if (yaffs_CheckChunkBit(dev, theChunk / dev->param.nChunksPerBlock,
1693 theChunk % dev->param.nChunksPerBlock)) {
1695 if(dev->chunkGroupSize == 1)
1698 yaffs_ReadChunkWithTagsFromNAND(dev, theChunk, NULL,
1700 if (yaffs_TagsMatch(tags, objectId, chunkInInode)) {
1712 /* DeleteWorker scans backwards through the tnode tree and deletes all the
1713 * chunks and tnodes in the file
1714 * Returns 1 if the tree was deleted.
1715 * Returns 0 if it stopped early due to hitting the limit and the delete is incomplete.
1718 static int yaffs_DeleteWorker(yaffs_Object *in, yaffs_Tnode *tn, __u32 level,
1719 int chunkOffset, int *limit)
1724 yaffs_ExtendedTags tags;
1726 yaffs_Device *dev = in->myDev;
1732 for (i = YAFFS_NTNODES_INTERNAL - 1; allDone && i >= 0;
1734 if (tn->internal[i]) {
1735 if (limit && (*limit) < 0) {
1739 yaffs_DeleteWorker(in,
1747 YAFFS_TNODES_INTERNAL_BITS)
1752 yaffs_FreeTnode(dev,
1755 tn->internal[i] = NULL;
1759 return (allDone) ? 1 : 0;
1760 } else if (level == 0) {
1763 for (i = YAFFS_NTNODES_LEVEL0 - 1; i >= 0 && !hitLimit;
1765 theChunk = yaffs_GetChunkGroupBase(dev, tn, i);
1768 chunkInInode = (chunkOffset <<
1769 YAFFS_TNODES_LEVEL0_BITS) + i;
1772 yaffs_FindChunkInGroup(dev,
1778 if (foundChunk > 0) {
1779 yaffs_DeleteChunk(dev,
1784 *limit = *limit - 1;
1791 yaffs_LoadLevel0Tnode(dev, tn, i, 0);
1795 return (i < 0) ? 1 : 0;
1805 static void yaffs_SoftDeleteChunk(yaffs_Device *dev, int chunk)
1807 yaffs_BlockInfo *theBlock;
1810 T(YAFFS_TRACE_DELETION, (TSTR("soft delete chunk %d" TENDSTR), chunk));
1812 blockNo = chunk / dev->param.nChunksPerBlock;
1813 theBlock = yaffs_GetBlockInfo(dev, blockNo);
1815 theBlock->softDeletions++;
1817 yaffs_UpdateOldestDirtySequence(dev, blockNo, theBlock);
1821 /* SoftDeleteWorker scans backwards through the tnode tree and soft deletes all the chunks in the file.
1822 * All soft deleting does is increment the block's softdelete count and pulls the chunk out
1824 * Thus, essentially this is the same as DeleteWorker except that the chunks are soft deleted.
1827 static int yaffs_SoftDeleteWorker(yaffs_Object *in, yaffs_Tnode *tn,
1828 __u32 level, int chunkOffset)
1833 yaffs_Device *dev = in->myDev;
1838 for (i = YAFFS_NTNODES_INTERNAL - 1; allDone && i >= 0;
1840 if (tn->internal[i]) {
1842 yaffs_SoftDeleteWorker(in,
1848 YAFFS_TNODES_INTERNAL_BITS)
1851 yaffs_FreeTnode(dev,
1854 tn->internal[i] = NULL;
1856 /* Hoosterman... how could this happen? */
1860 return (allDone) ? 1 : 0;
1861 } else if (level == 0) {
1863 for (i = YAFFS_NTNODES_LEVEL0 - 1; i >= 0; i--) {
1864 theChunk = yaffs_GetChunkGroupBase(dev, tn, i);
1866 /* Note this does not find the real chunk, only the chunk group.
1867 * We make an assumption that a chunk group is not larger than
1870 yaffs_SoftDeleteChunk(dev, theChunk);
1871 yaffs_LoadLevel0Tnode(dev, tn, i, 0);
1885 static void yaffs_SoftDeleteFile(yaffs_Object *obj)
1888 obj->variantType == YAFFS_OBJECT_TYPE_FILE && !obj->softDeleted) {
1889 if (obj->nDataChunks <= 0) {
1890 /* Empty file with no duplicate object headers, just delete it immediately */
1891 yaffs_FreeTnode(obj->myDev,
1892 obj->variant.fileVariant.top);
1893 obj->variant.fileVariant.top = NULL;
1894 T(YAFFS_TRACE_TRACING,
1895 (TSTR("yaffs: Deleting empty file %d" TENDSTR),
1897 yaffs_DoGenericObjectDeletion(obj);
1899 yaffs_SoftDeleteWorker(obj,
1900 obj->variant.fileVariant.top,
1901 obj->variant.fileVariant.
1903 obj->softDeleted = 1;
1908 /* Pruning removes any part of the file structure tree that is beyond the
1909 * bounds of the file (ie that does not point to chunks).
1911 * A file should only get pruned when its size is reduced.
1913 * Before pruning, the chunks must be pulled from the tree and the
1914 * level 0 tnode entries must be zeroed out.
1915 * Could also use this for file deletion, but that's probably better handled
1916 * by a special case.
1918 * This function is recursive. For levels > 0 the function is called again on
1919 * any sub-tree. For level == 0 we just check if the sub-tree has data.
1920 * If there is no data in a subtree then it is pruned.
1923 static yaffs_Tnode *yaffs_PruneWorker(yaffs_Device *dev, yaffs_Tnode *tn,
1924 __u32 level, int del0)
1933 for (i = 0; i < YAFFS_NTNODES_INTERNAL; i++) {
1934 if (tn->internal[i]) {
1936 yaffs_PruneWorker(dev, tn->internal[i],
1938 (i == 0) ? del0 : 1);
1941 if (tn->internal[i])
1945 int tnodeSize_u32 = yaffs_CalcTnodeSize(dev)/sizeof(__u32);
1946 __u32 *map = (__u32 *)tn;
1948 for(i = 0; !hasData && i < tnodeSize_u32; i++){
1954 if (hasData == 0 && del0) {
1955 /* Free and return NULL */
1957 yaffs_FreeTnode(dev, tn);
1967 static int yaffs_PruneFileStructure(yaffs_Device *dev,
1968 yaffs_FileStructure *fStruct)
1975 if (fStruct->topLevel > 0) {
1977 yaffs_PruneWorker(dev, fStruct->top, fStruct->topLevel, 0);
1979 /* Now we have a tree with all the non-zero branches NULL but the height
1980 * is the same as it was.
1981 * Let's see if we can trim internal tnodes to shorten the tree.
1982 * We can do this if only the 0th element in the tnode is in use
1983 * (ie all the non-zero are NULL)
1986 while (fStruct->topLevel && !done) {
1990 for (i = 1; i < YAFFS_NTNODES_INTERNAL; i++) {
1991 if (tn->internal[i])
1996 fStruct->top = tn->internal[0];
1997 fStruct->topLevel--;
1998 yaffs_FreeTnode(dev, tn);
2008 /*-------------------- End of File Structure functions.-------------------*/
2010 /* yaffs_CreateFreeObjects creates a bunch more objects and
2011 * adds them to the object free list.
2013 static int yaffs_CreateFreeObjects(yaffs_Device *dev, int nObjects)
2016 yaffs_Object *newObjects;
2017 yaffs_ObjectList *list;
2022 /* make these things */
2023 newObjects = YMALLOC(nObjects * sizeof(yaffs_Object));
2024 list = YMALLOC(sizeof(yaffs_ObjectList));
2026 if (!newObjects || !list) {
2035 T(YAFFS_TRACE_ALLOCATE,
2036 (TSTR("yaffs: Could not allocate more objects" TENDSTR)));
2040 /* Hook them into the free list */
2041 for (i = 0; i < nObjects - 1; i++) {
2042 newObjects[i].siblings.next =
2043 (struct ylist_head *)(&newObjects[i + 1]);
2046 newObjects[nObjects - 1].siblings.next = (void *)dev->freeObjects;
2047 dev->freeObjects = newObjects;
2048 dev->nFreeObjects += nObjects;
2049 dev->nObjectsCreated += nObjects;
2051 /* Now add this bunch of Objects to a list for freeing up. */
2053 list->objects = newObjects;
2054 list->next = dev->allocatedObjectList;
2055 dev->allocatedObjectList = list;
2061 /* AllocateEmptyObject gets us a clean Object. Tries to make allocate more if we run out */
2062 static yaffs_Object *yaffs_AllocateEmptyObject(yaffs_Device *dev)
2064 yaffs_Object *tn = NULL;
2066 #ifdef CONFIG_YAFFS_VALGRIND_TEST
2067 tn = YMALLOC(sizeof(yaffs_Object));
2069 dev->nObjectsCreated++;
2071 /* If there are none left make more */
2072 if (!dev->freeObjects)
2073 yaffs_CreateFreeObjects(dev, YAFFS_ALLOCATION_NOBJECTS);
2075 if (dev->freeObjects) {
2076 tn = dev->freeObjects;
2078 (yaffs_Object *) (dev->freeObjects->siblings.next);
2079 dev->nFreeObjects--;
2083 /* Now sweeten it up... */
2085 memset(tn, 0, sizeof(yaffs_Object));
2086 tn->beingCreated = 1;
2090 tn->variantType = YAFFS_OBJECT_TYPE_UNKNOWN;
2091 YINIT_LIST_HEAD(&(tn->hardLinks));
2092 YINIT_LIST_HEAD(&(tn->hashLink));
2093 YINIT_LIST_HEAD(&tn->siblings);
2096 /* Now make the directory sane */
2098 tn->parent = dev->rootDir;
2099 ylist_add(&(tn->siblings), &dev->rootDir->variant.directoryVariant.children);
2102 /* Add it to the lost and found directory.
2103 * NB Can't put root or lostNFound in lostNFound so
2104 * check if lostNFound exists first
2106 if (dev->lostNFoundDir)
2107 yaffs_AddObjectToDirectory(dev->lostNFoundDir, tn);
2109 tn->beingCreated = 0;
2112 dev->nCheckpointBlocksRequired = 0; /* force recalculation*/
2117 static yaffs_Object *yaffs_CreateFakeDirectory(yaffs_Device *dev, int number,
2122 yaffs_CreateNewObject(dev, number, YAFFS_OBJECT_TYPE_DIRECTORY);
2124 obj->fake = 1; /* it is fake so it might have no NAND presence... */
2125 obj->renameAllowed = 0; /* ... and we're not allowed to rename it... */
2126 obj->unlinkAllowed = 0; /* ... or unlink it */
2129 obj->yst_mode = mode;
2131 obj->hdrChunk = 0; /* Not a valid chunk. */
2138 static void yaffs_UnhashObject(yaffs_Object *tn)
2141 yaffs_Device *dev = tn->myDev;
2143 /* If it is still linked into the bucket list, free from the list */
2144 if (!ylist_empty(&tn->hashLink)) {
2145 ylist_del_init(&tn->hashLink);
2146 bucket = yaffs_HashFunction(tn->objectId);
2147 dev->objectBucket[bucket].count--;
2151 /* FreeObject frees up a Object and puts it back on the free list */
2152 static void yaffs_FreeObject(yaffs_Object *tn)
2154 yaffs_Device *dev = tn->myDev;
2156 T(YAFFS_TRACE_OS, (TSTR("FreeObject %p inode %p"TENDSTR), tn, tn->myInode));
2162 if (!ylist_empty(&tn->siblings))
2167 /* We're still hooked up to a cached inode.
2168 * Don't delete now, but mark for later deletion
2170 tn->deferedFree = 1;
2174 yaffs_UnhashObject(tn);
2176 #ifdef CONFIG_YAFFS_VALGRIND_TEST
2178 dev->nObjectsCreated--;
2181 /* Link into the free list. */
2182 tn->siblings.next = (struct ylist_head *)(dev->freeObjects);
2183 dev->freeObjects = tn;
2184 dev->nFreeObjects++;
2186 dev->nCheckpointBlocksRequired = 0; /* force recalculation*/
2190 void yaffs_HandleDeferedFree(yaffs_Object *obj)
2192 if (obj->deferedFree)
2193 yaffs_FreeObject(obj);
2197 static void yaffs_DeinitialiseObjects(yaffs_Device *dev)
2199 /* Free the list of allocated Objects */
2201 yaffs_ObjectList *tmp;
2203 while (dev->allocatedObjectList) {
2204 tmp = dev->allocatedObjectList->next;
2205 YFREE(dev->allocatedObjectList->objects);
2206 YFREE(dev->allocatedObjectList);
2208 dev->allocatedObjectList = tmp;
2211 dev->freeObjects = NULL;
2212 dev->nFreeObjects = 0;
2213 dev->nObjectsCreated = 0;
2216 static void yaffs_InitialiseObjects(yaffs_Device *dev)
2220 dev->allocatedObjectList = NULL;
2221 dev->freeObjects = NULL;
2222 dev->nFreeObjects = 0;
2224 for (i = 0; i < YAFFS_NOBJECT_BUCKETS; i++) {
2225 YINIT_LIST_HEAD(&dev->objectBucket[i].list);
2226 dev->objectBucket[i].count = 0;
2230 static int yaffs_FindNiceObjectBucket(yaffs_Device *dev)
2234 int lowest = 999999;
2237 /* Search for the shortest list or one that
2241 for (i = 0; i < 10 && lowest > 4; i++) {
2242 dev->bucketFinder++;
2243 dev->bucketFinder %= YAFFS_NOBJECT_BUCKETS;
2244 if (dev->objectBucket[dev->bucketFinder].count < lowest) {
2245 lowest = dev->objectBucket[dev->bucketFinder].count;
2246 l = dev->bucketFinder;
2254 static int yaffs_CreateNewObjectNumber(yaffs_Device *dev)
2256 int bucket = yaffs_FindNiceObjectBucket(dev);
2258 /* Now find an object value that has not already been taken
2259 * by scanning the list.
2263 struct ylist_head *i;
2265 __u32 n = (__u32) bucket;
2267 /* yaffs_CheckObjectHashSanity(); */
2271 n += YAFFS_NOBJECT_BUCKETS;
2272 if (1 || dev->objectBucket[bucket].count > 0) {
2273 ylist_for_each(i, &dev->objectBucket[bucket].list) {
2274 /* If there is already one in the list */
2275 if (i && ylist_entry(i, yaffs_Object,
2276 hashLink)->objectId == n) {
2286 static void yaffs_HashObject(yaffs_Object *in)
2288 int bucket = yaffs_HashFunction(in->objectId);
2289 yaffs_Device *dev = in->myDev;
2291 ylist_add(&in->hashLink, &dev->objectBucket[bucket].list);
2292 dev->objectBucket[bucket].count++;
2295 yaffs_Object *yaffs_FindObjectByNumber(yaffs_Device *dev, __u32 number)
2297 int bucket = yaffs_HashFunction(number);
2298 struct ylist_head *i;
2301 ylist_for_each(i, &dev->objectBucket[bucket].list) {
2302 /* Look if it is in the list */
2304 in = ylist_entry(i, yaffs_Object, hashLink);
2305 if (in->objectId == number) {
2307 /* Don't tell the VFS about this one if it is defered free */
2308 if (in->deferedFree)
2319 yaffs_Object *yaffs_CreateNewObject(yaffs_Device *dev, int number,
2320 yaffs_ObjectType type)
2322 yaffs_Object *theObject=NULL;
2323 yaffs_Tnode *tn = NULL;
2326 number = yaffs_CreateNewObjectNumber(dev);
2328 if (type == YAFFS_OBJECT_TYPE_FILE) {
2329 tn = yaffs_GetTnode(dev);
2334 theObject = yaffs_AllocateEmptyObject(dev);
2337 yaffs_FreeTnode(dev,tn);
2343 theObject->fake = 0;
2344 theObject->renameAllowed = 1;
2345 theObject->unlinkAllowed = 1;
2346 theObject->objectId = number;
2347 yaffs_HashObject(theObject);
2348 theObject->variantType = type;
2349 #ifdef CONFIG_YAFFS_WINCE
2350 yfsd_WinFileTimeNow(theObject->win_atime);
2351 theObject->win_ctime[0] = theObject->win_mtime[0] =
2352 theObject->win_atime[0];
2353 theObject->win_ctime[1] = theObject->win_mtime[1] =
2354 theObject->win_atime[1];
2358 theObject->yst_atime = theObject->yst_mtime =
2359 theObject->yst_ctime = Y_CURRENT_TIME;
2362 case YAFFS_OBJECT_TYPE_FILE:
2363 theObject->variant.fileVariant.fileSize = 0;
2364 theObject->variant.fileVariant.scannedFileSize = 0;
2365 theObject->variant.fileVariant.shrinkSize = 0xFFFFFFFF; /* max __u32 */
2366 theObject->variant.fileVariant.topLevel = 0;
2367 theObject->variant.fileVariant.top = tn;
2369 case YAFFS_OBJECT_TYPE_DIRECTORY:
2370 YINIT_LIST_HEAD(&theObject->variant.directoryVariant.
2372 YINIT_LIST_HEAD(&theObject->variant.directoryVariant.
2375 case YAFFS_OBJECT_TYPE_SYMLINK:
2376 case YAFFS_OBJECT_TYPE_HARDLINK:
2377 case YAFFS_OBJECT_TYPE_SPECIAL:
2378 /* No action required */
2380 case YAFFS_OBJECT_TYPE_UNKNOWN:
2381 /* todo this should not happen */
2389 static yaffs_Object *yaffs_FindOrCreateObjectByNumber(yaffs_Device *dev,
2391 yaffs_ObjectType type)
2393 yaffs_Object *theObject = NULL;
2396 theObject = yaffs_FindObjectByNumber(dev, number);
2399 theObject = yaffs_CreateNewObject(dev, number, type);
2406 static YCHAR *yaffs_CloneString(const YCHAR *str)
2408 YCHAR *newStr = NULL;
2414 len = yaffs_strnlen(str,YAFFS_MAX_ALIAS_LENGTH);
2415 newStr = YMALLOC((len + 1) * sizeof(YCHAR));
2417 yaffs_strncpy(newStr, str,len);
2425 * Mknod (create) a new object.
2426 * equivalentObject only has meaning for a hard link;
2427 * aliasString only has meaning for a symlink.
2428 * rdev only has meaning for devices (a subset of special objects)
2431 static yaffs_Object *yaffs_MknodObject(yaffs_ObjectType type,
2432 yaffs_Object *parent,
2437 yaffs_Object *equivalentObject,
2438 const YCHAR *aliasString, __u32 rdev)
2443 yaffs_Device *dev = parent->myDev;
2445 /* Check if the entry exists. If it does then fail the call since we don't want a dup.*/
2446 if (yaffs_FindObjectByName(parent, name))
2449 if (type == YAFFS_OBJECT_TYPE_SYMLINK) {
2450 str = yaffs_CloneString(aliasString);
2455 in = yaffs_CreateNewObject(dev, -1, type);
2470 in->variantType = type;
2472 in->yst_mode = mode;
2474 #ifdef CONFIG_YAFFS_WINCE
2475 yfsd_WinFileTimeNow(in->win_atime);
2476 in->win_ctime[0] = in->win_mtime[0] = in->win_atime[0];
2477 in->win_ctime[1] = in->win_mtime[1] = in->win_atime[1];
2480 in->yst_atime = in->yst_mtime = in->yst_ctime = Y_CURRENT_TIME;
2482 in->yst_rdev = rdev;
2486 in->nDataChunks = 0;
2488 yaffs_SetObjectName(in, name);
2491 yaffs_AddObjectToDirectory(parent, in);
2493 in->myDev = parent->myDev;
2496 case YAFFS_OBJECT_TYPE_SYMLINK:
2497 in->variant.symLinkVariant.alias = str;
2499 case YAFFS_OBJECT_TYPE_HARDLINK:
2500 in->variant.hardLinkVariant.equivalentObject =
2502 in->variant.hardLinkVariant.equivalentObjectId =
2503 equivalentObject->objectId;
2504 ylist_add(&in->hardLinks, &equivalentObject->hardLinks);
2506 case YAFFS_OBJECT_TYPE_FILE:
2507 case YAFFS_OBJECT_TYPE_DIRECTORY:
2508 case YAFFS_OBJECT_TYPE_SPECIAL:
2509 case YAFFS_OBJECT_TYPE_UNKNOWN:
2514 if (yaffs_UpdateObjectHeader(in, name, 0, 0, 0) < 0) {
2515 /* Could not create the object header, fail the creation */
2516 yaffs_DeleteObject(in);
2520 yaffs_UpdateParent(parent);
2526 yaffs_Object *yaffs_MknodFile(yaffs_Object *parent, const YCHAR *name,
2527 __u32 mode, __u32 uid, __u32 gid)
2529 return yaffs_MknodObject(YAFFS_OBJECT_TYPE_FILE, parent, name, mode,
2530 uid, gid, NULL, NULL, 0);
2533 yaffs_Object *yaffs_MknodDirectory(yaffs_Object *parent, const YCHAR *name,
2534 __u32 mode, __u32 uid, __u32 gid)
2536 return yaffs_MknodObject(YAFFS_OBJECT_TYPE_DIRECTORY, parent, name,
2537 mode, uid, gid, NULL, NULL, 0);
2540 yaffs_Object *yaffs_MknodSpecial(yaffs_Object *parent, const YCHAR *name,
2541 __u32 mode, __u32 uid, __u32 gid, __u32 rdev)
2543 return yaffs_MknodObject(YAFFS_OBJECT_TYPE_SPECIAL, parent, name, mode,
2544 uid, gid, NULL, NULL, rdev);
2547 yaffs_Object *yaffs_MknodSymLink(yaffs_Object *parent, const YCHAR *name,
2548 __u32 mode, __u32 uid, __u32 gid,
2551 return yaffs_MknodObject(YAFFS_OBJECT_TYPE_SYMLINK, parent, name, mode,
2552 uid, gid, NULL, alias, 0);
2555 /* yaffs_Link returns the object id of the equivalent object.*/
2556 yaffs_Object *yaffs_Link(yaffs_Object *parent, const YCHAR *name,
2557 yaffs_Object *equivalentObject)
2559 /* Get the real object in case we were fed a hard link as an equivalent object */
2560 equivalentObject = yaffs_GetEquivalentObject(equivalentObject);
2562 if (yaffs_MknodObject
2563 (YAFFS_OBJECT_TYPE_HARDLINK, parent, name, 0, 0, 0,
2564 equivalentObject, NULL, 0)) {
2565 return equivalentObject;
2572 static int yaffs_ChangeObjectName(yaffs_Object *obj, yaffs_Object *newDir,
2573 const YCHAR *newName, int force, int shadows)
2578 yaffs_Object *existingTarget;
2581 newDir = obj->parent; /* use the old directory */
2583 if (newDir->variantType != YAFFS_OBJECT_TYPE_DIRECTORY) {
2584 T(YAFFS_TRACE_ALWAYS,
2586 ("tragedy: yaffs_ChangeObjectName: newDir is not a directory"
2591 /* TODO: Do we need this different handling for YAFFS2 and YAFFS1?? */
2592 if (obj->myDev->param.isYaffs2)
2593 unlinkOp = (newDir == obj->myDev->unlinkedDir);
2595 unlinkOp = (newDir == obj->myDev->unlinkedDir
2596 && obj->variantType == YAFFS_OBJECT_TYPE_FILE);
2598 deleteOp = (newDir == obj->myDev->deletedDir);
2600 existingTarget = yaffs_FindObjectByName(newDir, newName);
2602 /* If the object is a file going into the unlinked directory,
2603 * then it is OK to just stuff it in since duplicate names are allowed.
2604 * else only proceed if the new name does not exist and if we're putting
2605 * it into a directory.
2612 newDir->variantType == YAFFS_OBJECT_TYPE_DIRECTORY) {
2613 yaffs_SetObjectName(obj, newName);
2616 yaffs_AddObjectToDirectory(newDir, obj);
2621 /* If it is a deletion then we mark it as a shrink for gc purposes. */
2622 if (yaffs_UpdateObjectHeader(obj, newName, 0, deleteOp, shadows) >= 0)
2629 int yaffs_RenameObject(yaffs_Object *oldDir, const YCHAR *oldName,
2630 yaffs_Object *newDir, const YCHAR *newName)
2632 yaffs_Object *obj = NULL;
2633 yaffs_Object *existingTarget = NULL;
2639 if (!oldDir || oldDir->variantType != YAFFS_OBJECT_TYPE_DIRECTORY)
2641 if (!newDir || newDir->variantType != YAFFS_OBJECT_TYPE_DIRECTORY)
2644 dev = oldDir->myDev;
2646 #ifdef CONFIG_YAFFS_CASE_INSENSITIVE
2647 /* Special case for case insemsitive systems (eg. WinCE).
2648 * While look-up is case insensitive, the name isn't.
2649 * Therefore we might want to change x.txt to X.txt
2651 if (oldDir == newDir && yaffs_strcmp(oldName, newName) == 0)
2655 if(yaffs_strnlen(newName,YAFFS_MAX_NAME_LENGTH+1) > YAFFS_MAX_NAME_LENGTH)
2659 obj = yaffs_FindObjectByName(oldDir, oldName);
2661 if (obj && obj->renameAllowed) {
2663 /* Now do the handling for an existing target, if there is one */
2665 existingTarget = yaffs_FindObjectByName(newDir, newName);
2666 if (existingTarget &&
2667 existingTarget->variantType == YAFFS_OBJECT_TYPE_DIRECTORY &&
2668 !ylist_empty(&existingTarget->variant.directoryVariant.children)) {
2669 /* There is a target that is a non-empty directory, so we fail */
2670 return YAFFS_FAIL; /* EEXIST or ENOTEMPTY */
2671 } else if (existingTarget && existingTarget != obj) {
2672 /* Nuke the target first, using shadowing,
2673 * but only if it isn't the same object.
2675 * Note we must disable gc otherwise it can mess up the shadowing.
2679 yaffs_ChangeObjectName(obj, newDir, newName, force,
2680 existingTarget->objectId);
2681 existingTarget->isShadowed = 1;
2682 yaffs_UnlinkObject(existingTarget);
2686 result = yaffs_ChangeObjectName(obj, newDir, newName, 1, 0);
2688 yaffs_UpdateParent(oldDir);
2689 if(newDir != oldDir)
2690 yaffs_UpdateParent(newDir);
2697 /*------------------------- Block Management and Page Allocation ----------------*/
2699 static int yaffs_InitialiseBlocks(yaffs_Device *dev)
2701 int nBlocks = dev->internalEndBlock - dev->internalStartBlock + 1;
2703 dev->blockInfo = NULL;
2704 dev->chunkBits = NULL;
2706 dev->allocationBlock = -1; /* force it to get a new one */
2708 /* If the first allocation strategy fails, thry the alternate one */
2709 dev->blockInfo = YMALLOC(nBlocks * sizeof(yaffs_BlockInfo));
2710 if (!dev->blockInfo) {
2711 dev->blockInfo = YMALLOC_ALT(nBlocks * sizeof(yaffs_BlockInfo));
2712 dev->blockInfoAlt = 1;
2714 dev->blockInfoAlt = 0;
2716 if (dev->blockInfo) {
2717 /* Set up dynamic blockinfo stuff. */
2718 dev->chunkBitmapStride = (dev->param.nChunksPerBlock + 7) / 8; /* round up bytes */
2719 dev->chunkBits = YMALLOC(dev->chunkBitmapStride * nBlocks);
2720 if (!dev->chunkBits) {
2721 dev->chunkBits = YMALLOC_ALT(dev->chunkBitmapStride * nBlocks);
2722 dev->chunkBitsAlt = 1;
2724 dev->chunkBitsAlt = 0;
2727 if (dev->blockInfo && dev->chunkBits) {
2728 memset(dev->blockInfo, 0, nBlocks * sizeof(yaffs_BlockInfo));
2729 memset(dev->chunkBits, 0, dev->chunkBitmapStride * nBlocks);
2736 static void yaffs_DeinitialiseBlocks(yaffs_Device *dev)
2738 if (dev->blockInfoAlt && dev->blockInfo)
2739 YFREE_ALT(dev->blockInfo);
2740 else if (dev->blockInfo)
2741 YFREE(dev->blockInfo);
2743 dev->blockInfoAlt = 0;
2745 dev->blockInfo = NULL;
2747 if (dev->chunkBitsAlt && dev->chunkBits)
2748 YFREE_ALT(dev->chunkBits);
2749 else if (dev->chunkBits)
2750 YFREE(dev->chunkBits);
2751 dev->chunkBitsAlt = 0;
2752 dev->chunkBits = NULL;
2755 static int yaffs_BlockNotDisqualifiedFromGC(yaffs_Device *dev,
2756 yaffs_BlockInfo *bi)
2759 if (!dev->param.isYaffs2)
2760 return 1; /* disqualification only applies to yaffs2. */
2762 if (!bi->hasShrinkHeader)
2763 return 1; /* can gc */
2765 yaffs_FindOldestDirtySequence(dev);
2767 /* Can't do gc of this block if there are any blocks older than this one that have
2770 return (bi->sequenceNumber <= dev->oldestDirtySequence);
2774 * yaffs_FindRefreshBlock()
2775 * periodically finds the oldest full block by sequence number for refreshing.
2778 static __u32 yaffs_FindRefreshBlock(yaffs_Device *dev)
2783 __u32 oldestSequence = 0;
2785 yaffs_BlockInfo *bi;
2788 * If refresh period < 10 then refreshing is disabled.
2790 if(dev->param.refreshPeriod < 10 ||
2791 !dev->param.isYaffs2)
2795 * Fix broken values.
2797 if(dev->refreshSkip > dev->param.refreshPeriod)
2798 dev->refreshSkip = dev->param.refreshPeriod;
2800 if(dev->refreshSkip > 0)
2804 * Refresh skip is now zero.
2805 * We'll do a refresh this time around....
2806 * Update the refresh skip and find the oldest block.
2808 dev->refreshSkip = dev->param.refreshPeriod;
2809 dev->refreshCount++;
2810 bi = dev->blockInfo;
2811 for (b = dev->internalStartBlock; b <=dev->internalEndBlock; b++){
2813 if (bi->blockState == YAFFS_BLOCK_STATE_FULL){
2816 bi->sequenceNumber < oldestSequence){
2818 oldestSequence = bi->sequenceNumber;
2826 (TSTR("GC refresh count %d selected block %d with sequenceNumber %d" TENDSTR),
2827 dev->refreshCount, oldest, oldestSequence));
2834 static void yaffs_BlockBecameDirty(yaffs_Device *dev, int blockNo)
2836 yaffs_BlockInfo *bi = yaffs_GetBlockInfo(dev, blockNo);
2840 /* If the block is still healthy erase it and mark as clean.
2841 * If the block has had a data failure, then retire it.
2844 T(YAFFS_TRACE_GC | YAFFS_TRACE_ERASE,
2845 (TSTR("yaffs_BlockBecameDirty block %d state %d %s"TENDSTR),
2846 blockNo, bi->blockState, (bi->needsRetiring) ? "needs retiring" : ""));
2848 yaffs_ClearOldestDirtySequence(dev,bi);
2850 bi->blockState = YAFFS_BLOCK_STATE_DIRTY;
2852 /* If this is the block being garbage collected then stop gc'ing this block */
2853 if(blockNo == dev->gcBlock)
2856 /* If this block is currently the best candidate for gc then drop as a candidate */
2857 if(blockNo == dev->gcDirtiest){
2858 dev->gcDirtiest = 0;
2859 dev->gcPagesInUse = 0;
2862 if (!bi->needsRetiring) {
2863 yaffs_InvalidateCheckpoint(dev);
2864 erasedOk = yaffs_EraseBlockInNAND(dev, blockNo);
2866 dev->nErasureFailures++;
2867 T(YAFFS_TRACE_ERROR | YAFFS_TRACE_BAD_BLOCKS,
2868 (TSTR("**>> Erasure failed %d" TENDSTR), blockNo));
2873 ((yaffs_traceMask & YAFFS_TRACE_ERASE) || !yaffs_SkipVerification(dev))) {
2875 for (i = 0; i < dev->param.nChunksPerBlock; i++) {
2876 if (!yaffs_CheckChunkErased
2877 (dev, blockNo * dev->param.nChunksPerBlock + i)) {
2878 T(YAFFS_TRACE_ERROR,
2880 (">>Block %d erasure supposedly OK, but chunk %d not erased"
2881 TENDSTR), blockNo, i));
2887 /* Clean it up... */
2888 bi->blockState = YAFFS_BLOCK_STATE_EMPTY;
2889 bi->sequenceNumber = 0;
2890 dev->nErasedBlocks++;
2892 bi->softDeletions = 0;
2893 bi->hasShrinkHeader = 0;
2894 bi->skipErasedCheck = 1; /* This is clean, so no need to check */
2895 bi->gcPrioritise = 0;
2896 yaffs_ClearChunkBits(dev, blockNo);
2898 T(YAFFS_TRACE_ERASE,
2899 (TSTR("Erased block %d" TENDSTR), blockNo));
2901 dev->nFreeChunks -= dev->param.nChunksPerBlock; /* We lost a block of free space */
2903 yaffs_RetireBlock(dev, blockNo);
2904 T(YAFFS_TRACE_ERROR | YAFFS_TRACE_BAD_BLOCKS,
2905 (TSTR("**>> Block %d retired" TENDSTR), blockNo));
2909 static int yaffs_FindBlockForAllocation(yaffs_Device *dev)
2913 yaffs_BlockInfo *bi;
2915 if (dev->nErasedBlocks < 1) {
2916 /* Hoosterman we've got a problem.
2917 * Can't get space to gc
2919 T(YAFFS_TRACE_ERROR,
2920 (TSTR("yaffs tragedy: no more erased blocks" TENDSTR)));
2925 /* Find an empty block. */
2927 for (i = dev->internalStartBlock; i <= dev->internalEndBlock; i++) {
2928 dev->allocationBlockFinder++;
2929 if (dev->allocationBlockFinder < dev->internalStartBlock
2930 || dev->allocationBlockFinder > dev->internalEndBlock) {
2931 dev->allocationBlockFinder = dev->internalStartBlock;
2934 bi = yaffs_GetBlockInfo(dev, dev->allocationBlockFinder);
2936 if (bi->blockState == YAFFS_BLOCK_STATE_EMPTY) {
2937 bi->blockState = YAFFS_BLOCK_STATE_ALLOCATING;
2938 dev->sequenceNumber++;
2939 bi->sequenceNumber = dev->sequenceNumber;
2940 dev->nErasedBlocks--;
2941 T(YAFFS_TRACE_ALLOCATE,
2942 (TSTR("Allocated block %d, seq %d, %d left" TENDSTR),
2943 dev->allocationBlockFinder, dev->sequenceNumber,
2944 dev->nErasedBlocks));
2945 return dev->allocationBlockFinder;
2949 T(YAFFS_TRACE_ALWAYS,
2951 ("yaffs tragedy: no more erased blocks, but there should have been %d"
2952 TENDSTR), dev->nErasedBlocks));
2959 static int yaffs_CalcCheckpointBlocksRequired(yaffs_Device *dev)
2961 if (!dev->nCheckpointBlocksRequired &&
2962 dev->param.isYaffs2) {
2963 /* Not a valid value so recalculate */
2966 int devBlocks = (dev->param.endBlock - dev->param.startBlock + 1);
2967 int tnodeSize = yaffs_CalcTnodeSize(dev);
2969 nBytes += sizeof(yaffs_CheckpointValidity);
2970 nBytes += sizeof(yaffs_CheckpointDevice);
2971 nBytes += devBlocks * sizeof(yaffs_BlockInfo);
2972 nBytes += devBlocks * dev->chunkBitmapStride;
2973 nBytes += (sizeof(yaffs_CheckpointObject) + sizeof(__u32)) * (dev->nObjectsCreated - dev->nFreeObjects);
2974 nBytes += (tnodeSize + sizeof(__u32)) * (dev->nTnodesCreated - dev->nFreeTnodes);
2975 nBytes += sizeof(yaffs_CheckpointValidity);
2976 nBytes += sizeof(__u32); /* checksum*/
2978 /* Round up and add 2 blocks to allow for some bad blocks, so add 3 */
2980 nBlocks = (nBytes/(dev->nDataBytesPerChunk * dev->param.nChunksPerBlock)) + 3;
2982 dev->nCheckpointBlocksRequired = nBlocks;
2985 return dev->nCheckpointBlocksRequired;
2989 * Check if there's space to allocate...
2990 * Thinks.... do we need top make this ths same as yaffs_GetFreeChunks()?
2992 static int yaffs_CheckSpaceForAllocation(yaffs_Device *dev, int nChunks)
2995 int reservedBlocks = dev->param.nReservedBlocks;
2996 int checkpointBlocks;
2998 if (dev->param.isYaffs2) {
2999 checkpointBlocks = yaffs_CalcCheckpointBlocksRequired(dev) -
3000 dev->blocksInCheckpoint;
3001 if (checkpointBlocks < 0)
3002 checkpointBlocks = 0;
3004 checkpointBlocks = 0;
3007 reservedChunks = ((reservedBlocks + checkpointBlocks) * dev->param.nChunksPerBlock);
3009 return (dev->nFreeChunks > (reservedChunks + nChunks));
3012 static int yaffs_AllocateChunk(yaffs_Device *dev, int useReserve,
3013 yaffs_BlockInfo **blockUsedPtr)
3016 yaffs_BlockInfo *bi;
3018 if (dev->allocationBlock < 0) {
3019 /* Get next block to allocate off */
3020 dev->allocationBlock = yaffs_FindBlockForAllocation(dev);
3021 dev->allocationPage = 0;
3024 if (!useReserve && !yaffs_CheckSpaceForAllocation(dev, 1)) {
3025 /* Not enough space to allocate unless we're allowed to use the reserve. */
3029 if (dev->nErasedBlocks < dev->param.nReservedBlocks
3030 && dev->allocationPage == 0) {
3031 T(YAFFS_TRACE_ALLOCATE, (TSTR("Allocating reserve" TENDSTR)));
3034 /* Next page please.... */
3035 if (dev->allocationBlock >= 0) {
3036 bi = yaffs_GetBlockInfo(dev, dev->allocationBlock);
3038 retVal = (dev->allocationBlock * dev->param.nChunksPerBlock) +
3039 dev->allocationPage;
3041 yaffs_SetChunkBit(dev, dev->allocationBlock,
3042 dev->allocationPage);
3044 dev->allocationPage++;
3048 /* If the block is full set the state to full */
3049 if (dev->allocationPage >= dev->param.nChunksPerBlock) {
3050 bi->blockState = YAFFS_BLOCK_STATE_FULL;
3051 dev->allocationBlock = -1;
3060 T(YAFFS_TRACE_ERROR,
3061 (TSTR("!!!!!!!!! Allocator out !!!!!!!!!!!!!!!!!" TENDSTR)));
3066 static int yaffs_GetErasedChunks(yaffs_Device *dev)
3070 n = dev->nErasedBlocks * dev->param.nChunksPerBlock;
3072 if (dev->allocationBlock > 0)
3073 n += (dev->param.nChunksPerBlock - dev->allocationPage);
3080 * yaffs_SkipRestOfBlock() skips over the rest of the allocation block
3081 * if we don't want to write to it.
3083 static void yaffs_SkipRestOfBlock(yaffs_Device *dev)
3085 if(dev->allocationBlock > 0){
3086 yaffs_BlockInfo *bi = yaffs_GetBlockInfo(dev, dev->allocationBlock);
3087 if(bi->blockState == YAFFS_BLOCK_STATE_ALLOCATING){
3088 bi->blockState = YAFFS_BLOCK_STATE_FULL;
3089 dev->allocationBlock = -1;
3095 static int yaffs_GarbageCollectBlock(yaffs_Device *dev, int block,
3101 int retVal = YAFFS_OK;
3104 int isCheckpointBlock;
3108 int chunksBefore = yaffs_GetErasedChunks(dev);
3111 yaffs_ExtendedTags tags;
3113 yaffs_BlockInfo *bi = yaffs_GetBlockInfo(dev, block);
3115 yaffs_Object *object;
3117 isCheckpointBlock = (bi->blockState == YAFFS_BLOCK_STATE_CHECKPOINT);
3120 T(YAFFS_TRACE_TRACING,
3121 (TSTR("Collecting block %d, in use %d, shrink %d, wholeBlock %d" TENDSTR),
3124 bi->hasShrinkHeader,
3127 /*yaffs_VerifyFreeChunks(dev); */
3129 if(bi->blockState == YAFFS_BLOCK_STATE_FULL)
3130 bi->blockState = YAFFS_BLOCK_STATE_COLLECTING;
3132 bi->hasShrinkHeader = 0; /* clear the flag so that the block can erase */
3136 if (isCheckpointBlock ||
3137 !yaffs_StillSomeChunkBits(dev, block)) {
3138 T(YAFFS_TRACE_TRACING,
3140 ("Collecting block %d that has no chunks in use" TENDSTR),
3142 yaffs_BlockBecameDirty(dev, block);
3145 __u8 *buffer = yaffs_GetTempBuffer(dev, __LINE__);
3147 yaffs_VerifyBlock(dev, bi, block);
3149 maxCopies = (wholeBlock) ? dev->param.nChunksPerBlock : 5;
3150 oldChunk = block * dev->param.nChunksPerBlock + dev->gcChunk;
3152 for (/* init already done */;
3153 retVal == YAFFS_OK &&
3154 dev->gcChunk < dev->param.nChunksPerBlock &&
3155 (bi->blockState == YAFFS_BLOCK_STATE_COLLECTING) &&
3157 dev->gcChunk++, oldChunk++) {
3158 if (yaffs_CheckChunkBit(dev, block, dev->gcChunk)) {
3160 /* This page is in use and might need to be copied off */
3166 yaffs_InitialiseTags(&tags);
3168 yaffs_ReadChunkWithTagsFromNAND(dev, oldChunk,
3172 yaffs_FindObjectByNumber(dev,
3175 T(YAFFS_TRACE_GC_DETAIL,
3177 ("Collecting chunk in block %d, %d %d %d " TENDSTR),
3178 dev->gcChunk, tags.objectId, tags.chunkId,
3181 if (object && !yaffs_SkipVerification(dev)) {
3182 if (tags.chunkId == 0)
3183 matchingChunk = object->hdrChunk;
3184 else if (object->softDeleted)
3185 matchingChunk = oldChunk; /* Defeat the test */
3187 matchingChunk = yaffs_FindChunkInFile(object, tags.chunkId, NULL);
3189 if (oldChunk != matchingChunk)
3190 T(YAFFS_TRACE_ERROR,
3191 (TSTR("gc: page in gc mismatch: %d %d %d %d"TENDSTR),
3192 oldChunk, matchingChunk, tags.objectId, tags.chunkId));
3197 T(YAFFS_TRACE_ERROR,
3199 ("page %d in gc has no object: %d %d %d "
3201 tags.objectId, tags.chunkId, tags.byteCount));
3206 object->softDeleted &&
3207 tags.chunkId != 0) {
3208 /* Data chunk in a soft deleted file, throw it away
3209 * It's a soft deleted data chunk,
3210 * No need to copy this, just forget about it and
3211 * fix up the object.
3214 /* Free chunks already includes softdeleted chunks.
3215 * How ever this chunk is going to soon be really deleted
3216 * which will increment free chunks.
3217 * We have to decrement free chunks so this works out properly.
3221 object->nDataChunks--;
3223 if (object->nDataChunks <= 0) {
3224 /* remeber to clean up the object */
3225 dev->gcCleanupList[cleanups] =
3231 /* Todo object && object->deleted && object->nDataChunks == 0 */
3232 /* Deleted object header with no data chunks.
3233 * Can be discarded and the file deleted.
3235 object->hdrChunk = 0;
3236 yaffs_FreeTnode(object->myDev,
3239 object->variant.fileVariant.top = NULL;
3240 yaffs_DoGenericObjectDeletion(object);
3242 } else if (object) {
3243 /* It's either a data chunk in a live file or
3244 * an ObjectHeader, so we're interested in it.
3245 * NB Need to keep the ObjectHeaders of deleted files
3246 * until the whole file has been deleted off
3248 tags.serialNumber++;
3252 if (tags.chunkId == 0) {
3253 /* It is an object Id,
3254 * We need to nuke the shrinkheader flags first
3255 * Also need to clean up shadowing.
3256 * We no longer want the shrinkHeader flag since its work is done
3257 * and if it is left in place it will mess up scanning.
3260 yaffs_ObjectHeader *oh;
3261 oh = (yaffs_ObjectHeader *)buffer;
3264 tags.extraIsShrinkHeader = 0;
3266 oh->shadowsObject = 0;
3267 oh->inbandShadowsObject = 0;
3268 tags.extraShadows = 0;
3270 /* Update file size */
3271 if(object->variantType == YAFFS_OBJECT_TYPE_FILE){
3272 oh->fileSize = object->variant.fileVariant.fileSize;
3273 tags.extraFileLength = oh->fileSize;
3276 yaffs_VerifyObjectHeader(object, oh, &tags, 1);
3278 yaffs_WriteNewChunkWithTagsToNAND(dev,(__u8 *) oh, &tags, 1);
3281 yaffs_WriteNewChunkWithTagsToNAND(dev, buffer, &tags, 1);
3284 retVal = YAFFS_FAIL;
3287 /* Ok, now fix up the Tnodes etc. */
3289 if (tags.chunkId == 0) {
3291 object->hdrChunk = newChunk;
3292 object->serial = tags.serialNumber;
3294 /* It's a data chunk */
3296 ok = yaffs_PutChunkIntoFile
3304 if (retVal == YAFFS_OK)
3305 yaffs_DeleteChunk(dev, oldChunk, markNAND, __LINE__);
3310 yaffs_ReleaseTempBuffer(dev, buffer, __LINE__);
3313 /* Do any required cleanups */
3314 for (i = 0; i < cleanups; i++) {
3315 /* Time to delete the file too */
3317 yaffs_FindObjectByNumber(dev,
3318 dev->gcCleanupList[i]);
3320 yaffs_FreeTnode(dev,
3321 object->variant.fileVariant.
3323 object->variant.fileVariant.top = NULL;
3326 ("yaffs: About to finally delete object %d"
3327 TENDSTR), object->objectId));
3328 yaffs_DoGenericObjectDeletion(object);
3329 object->myDev->nDeletedFiles--;
3336 yaffs_VerifyCollectedBlock(dev, bi, block);
3340 if (bi->blockState == YAFFS_BLOCK_STATE_COLLECTING) {
3342 * The gc did not complete. Set block state back to FULL
3343 * because checkpointing does not restore gc.
3345 bi->blockState = YAFFS_BLOCK_STATE_FULL;
3347 /* The gc completed. */
3348 chunksAfter = yaffs_GetErasedChunks(dev);
3349 if (chunksBefore >= chunksAfter) {
3352 ("gc did not increase free chunks before %d after %d"
3353 TENDSTR), chunksBefore, chunksAfter));