yaffs_guts.c

   1 /*
   2  * YAFFS: Yet Another Flash File System. A NAND-flash specific file system.
   3  *
   4  * Copyright (C) 2002-2007 Aleph One Ltd.
   5  *   for Toby Churchill Ltd and Brightstar Engineering
   6  *
   7  * Created by Charles Manning <charles@aleph1.co.uk>
   8  *
   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.
  12  */
  13
  14 const char *yaffs_guts_c_version =
  15     "$Id: yaffs_guts.c,v 1.120 2010-03-15 23:10:34 charles Exp $";
  16
  17 #include "yportenv.h"
  18 #include "yaffs_trace.h"
  19
  20 #include "yaffsinterface.h"
  21 #include "yaffs_guts.h"
  22 #include "yaffs_tagsvalidity.h"
  23 #include "yaffs_getblockinfo.h"
  24
  25 #include "yaffs_tagscompat.h"
  26 #ifndef CONFIG_YAFFS_USE_OWN_SORT
  27 #include "yaffs_qsort.h"
  28 #endif
  29 #include "yaffs_nand.h"
  30
  31 #include "yaffs_checkptrw.h"
  32
  33 #include "yaffs_nand.h"
  34 #include "yaffs_packedtags2.h"
  35
  36
  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
  41
  42 #include "yaffs_ecc.h"
  43
  44
  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,
  48                 int erasedOk);
  49 static void yaffs_HandleWriteChunkOk(yaffs_Device *dev, int chunkInNAND,
  50                                 const __u8 *data,
  51                                 const yaffs_ExtendedTags *tags);
  52 static void yaffs_HandleUpdateChunk(yaffs_Device *dev, int chunkInNAND,
  53                                 const yaffs_ExtendedTags *tags);
  54
  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);
  59
  60 static void yaffs_HardlinkFixup(yaffs_Device *dev, yaffs_Object *hardList);
  61
  62 static int yaffs_WriteNewChunkWithTagsToNAND(yaffs_Device *dev,
  63                                         const __u8 *buffer,
  64                                         yaffs_ExtendedTags *tags,
  65                                         int useReserve);
  66 static int yaffs_PutChunkIntoFile(yaffs_Object *in, int chunkInInode,
  67                                 int chunkInNAND, int inScan);
  68
  69 static yaffs_Object *yaffs_CreateNewObject(yaffs_Device *dev, int number,
  70                                         yaffs_ObjectType type);
  71 static void yaffs_AddObjectToDirectory(yaffs_Object *directory,
  72                                 yaffs_Object *obj);
  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);
  80
  81 static yaffs_BlockInfo *yaffs_GetBlockInfo(yaffs_Device *dev, int blockNo);
  82
  83
  84 static int yaffs_CheckChunkErased(struct yaffs_DeviceStruct *dev,
  85                                 int chunkInNAND);
  86
  87 static int yaffs_UnlinkWorker(yaffs_Object *obj);
  88
  89 static int yaffs_TagsMatch(const yaffs_ExtendedTags *tags, int objectId,
  90                         int chunkInObject);
  91
  92 static int yaffs_AllocateChunk(yaffs_Device *dev, int useReserve,
  93                                 yaffs_BlockInfo **blockUsedPtr);
  94
  95 static void yaffs_VerifyFreeChunks(yaffs_Device *dev);
  96
  97 static void yaffs_CheckObjectDetailsLoaded(yaffs_Object *in);
  98
  99 static void yaffs_VerifyDirectory(yaffs_Object *directory);
 100 #ifdef YAFFS_PARANOID
 101 static int yaffs_CheckFileSanity(yaffs_Object *in);
 102 #else
 103 #define yaffs_CheckFileSanity(in)
 104 #endif
 105
 106 static void yaffs_InvalidateWholeChunkCache(yaffs_Object *in);
 107 static void yaffs_InvalidateChunkCache(yaffs_Object *object, int chunkId);
 108
 109 static void yaffs_InvalidateCheckpoint(yaffs_Device *dev);
 110
 111 static int yaffs_FindChunkInFile(yaffs_Object *in, int chunkInInode,
 112                                 yaffs_ExtendedTags *tags);
 113
 114 static __u32 yaffs_GetChunkGroupBase(yaffs_Device *dev, yaffs_Tnode *tn,
 115                 unsigned pos);
 116 static yaffs_Tnode *yaffs_FindLevel0Tnode(yaffs_Device *dev,
 117                                         yaffs_FileStructure *fStruct,
 118                                         __u32 chunkId);
 119
 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,
 123                                         int chunkInNAND,
 124                                         const __u8 *data,
 125                                         yaffs_ExtendedTags *tags);
 126
 127 /* Function to calculate chunk and offset */
 128
 129 static void yaffs_AddrToChunk(yaffs_Device *dev, loff_t addr, int *chunkOut,
 130                 __u32 *offsetOut)
 131 {
 132         int chunk;
 133         __u32 offset;
 134
 135         chunk  = (__u32)(addr >> dev->chunkShift);
 136
 137         if (dev->chunkDiv == 1) {
 138                 /* easy power of 2 case */
 139                 offset = (__u32)(addr & dev->chunkMask);
 140         } else {
 141                 /* Non power-of-2 case */
 142
 143                 loff_t chunkBase;
 144
 145                 chunk /= dev->chunkDiv;
 146
 147                 chunkBase = ((loff_t)chunk) * dev->nDataBytesPerChunk;
 148                 offset = (__u32)(addr - chunkBase);
 149         }
 150
 151         *chunkOut = chunk;
 152         *offsetOut = offset;
 153 }
 154
 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.
 159  */
 160
 161 static __u32 ShiftsGE(__u32 x)
 162 {
 163         int extraBits;
 164         int nShifts;
 165
 166         nShifts = extraBits = 0;
 167
 168         while (x > 1) {
 169                 if (x & 1)
 170                         extraBits++;
 171                 x >>= 1;
 172                 nShifts++;
 173         }
 174
 175         if (extraBits)
 176                 nShifts++;
 177
 178         return nShifts;
 179 }
 180
 181 /* Function to return the number of shifts to get a 1 in bit 0
 182  */
 183
 184 static __u32 Shifts(__u32 x)
 185 {
 186         int nShifts;
 187
 188         nShifts =  0;
 189
 190         if (!x)
 191                 return 0;
 192
 193         while (!(x&1)) {
 194                 x >>= 1;
 195                 nShifts++;
 196         }
 197
 198         return nShifts;
 199 }
 200
 201
 202
 203 /*
 204  * Temporary buffer manipulations.
 205  */
 206
 207 static int yaffs_InitialiseTempBuffers(yaffs_Device *dev)
 208 {
 209         int i;
 210         __u8 *buf = (__u8 *)1;
 211
 212         memset(dev->tempBuffer, 0, sizeof(dev->tempBuffer));
 213
 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);
 218         }
 219
 220         return buf ? YAFFS_OK : YAFFS_FAIL;
 221 }
 222
 223 __u8 *yaffs_GetTempBuffer(yaffs_Device *dev, int lineNo)
 224 {
 225         int i, j;
 226
 227         dev->tempInUse++;
 228         if (dev->tempInUse > dev->maxTemp)
 229                 dev->maxTemp = dev->tempInUse;
 230
 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;
 239                         }
 240
 241                         return dev->tempBuffer[i].buffer;
 242                 }
 243         }
 244
 245         T(YAFFS_TRACE_BUFFERS,
 246           (TSTR("Out of temp buffers at line %d, other held by lines:"),
 247            lineNo));
 248         for (i = 0; i < YAFFS_N_TEMP_BUFFERS; i++)
 249                 T(YAFFS_TRACE_BUFFERS, (TSTR(" %d "), dev->tempBuffer[i].line));
 250
 251         T(YAFFS_TRACE_BUFFERS, (TSTR(" " TENDSTR)));
 252
 253         /*
 254          * If we got here then we have to allocate an unmanaged one
 255          * This is not good.
 256          */
 257
 258         dev->unmanagedTempAllocations++;
 259         return YMALLOC(dev->nDataBytesPerChunk);
 260
 261 }
 262
 263 void yaffs_ReleaseTempBuffer(yaffs_Device *dev, __u8 *buffer,
 264                                     int lineNo)
 265 {
 266         int i;
 267
 268         dev->tempInUse--;
 269
 270         for (i = 0; i < YAFFS_N_TEMP_BUFFERS; i++) {
 271                 if (dev->tempBuffer[i].buffer == buffer) {
 272                         dev->tempBuffer[i].line = 0;
 273                         return;
 274                 }
 275         }
 276
 277         if (buffer) {
 278                 /* assume it is an unmanaged one. */
 279                 T(YAFFS_TRACE_BUFFERS,
 280                   (TSTR("Releasing unmanaged temp buffer in line %d" TENDSTR),
 281                    lineNo));
 282                 YFREE(buffer);
 283                 dev->unmanagedTempDeallocations++;
 284         }
 285
 286 }
 287
 288 /*
 289  * Determine if we have a managed buffer.
 290  */
 291 int yaffs_IsManagedTempBuffer(yaffs_Device *dev, const __u8 *buffer)
 292 {
 293         int i;
 294
 295         for (i = 0; i < YAFFS_N_TEMP_BUFFERS; i++) {
 296                 if (dev->tempBuffer[i].buffer == buffer)
 297                         return 1;
 298         }
 299
 300         for (i = 0; i < dev->param.nShortOpCaches; i++) {
 301                 if (dev->srCache[i].data == buffer)
 302                         return 1;
 303         }
 304
 305         if (buffer == dev->checkpointBuffer)
 306                 return 1;
 307
 308         T(YAFFS_TRACE_ALWAYS,
 309                 (TSTR("yaffs: unmaged buffer detected.\n" TENDSTR)));
 310         return 0;
 311 }
 312
 313
 314
 315 /*
 316  * Chunk bitmap manipulations
 317  */
 318
 319 static Y_INLINE __u8 *yaffs_BlockBits(yaffs_Device *dev, int blk)
 320 {
 321         if (blk < dev->internalStartBlock || blk > dev->internalEndBlock) {
 322                 T(YAFFS_TRACE_ERROR,
 323                         (TSTR("**>> yaffs: BlockBits block %d is not valid" TENDSTR),
 324                         blk));
 325                 YBUG();
 326         }
 327         return dev->chunkBits +
 328                 (dev->chunkBitmapStride * (blk - dev->internalStartBlock));
 329 }
 330
 331 static Y_INLINE void yaffs_VerifyChunkBitId(yaffs_Device *dev, int blk, int chunk)
 332 {
 333         if (blk < dev->internalStartBlock || blk > dev->internalEndBlock ||
 334                         chunk < 0 || chunk >= dev->param.nChunksPerBlock) {
 335                 T(YAFFS_TRACE_ERROR,
 336                 (TSTR("**>> yaffs: Chunk Id (%d:%d) invalid"TENDSTR),
 337                         blk, chunk));
 338                 YBUG();
 339         }
 340 }
 341
 342 static Y_INLINE void yaffs_ClearChunkBits(yaffs_Device *dev, int blk)
 343 {
 344         __u8 *blkBits = yaffs_BlockBits(dev, blk);
 345
 346         memset(blkBits, 0, dev->chunkBitmapStride);
 347 }
 348
 349 static Y_INLINE void yaffs_ClearChunkBit(yaffs_Device *dev, int blk, int chunk)
 350 {
 351         __u8 *blkBits = yaffs_BlockBits(dev, blk);
 352
 353         yaffs_VerifyChunkBitId(dev, blk, chunk);
 354
 355         blkBits[chunk / 8] &= ~(1 << (chunk & 7));
 356 }
 357
 358 static Y_INLINE void yaffs_SetChunkBit(yaffs_Device *dev, int blk, int chunk)
 359 {
 360         __u8 *blkBits = yaffs_BlockBits(dev, blk);
 361
 362         yaffs_VerifyChunkBitId(dev, blk, chunk);
 363
 364         blkBits[chunk / 8] |= (1 << (chunk & 7));
 365 }
 366
 367 static Y_INLINE int yaffs_CheckChunkBit(yaffs_Device *dev, int blk, int chunk)
 368 {
 369         __u8 *blkBits = yaffs_BlockBits(dev, blk);
 370         yaffs_VerifyChunkBitId(dev, blk, chunk);
 371
 372         return (blkBits[chunk / 8] & (1 << (chunk & 7))) ? 1 : 0;
 373 }
 374
 375 static Y_INLINE int yaffs_StillSomeChunkBits(yaffs_Device *dev, int blk)
 376 {
 377         __u8 *blkBits = yaffs_BlockBits(dev, blk);
 378         int i;
 379         for (i = 0; i < dev->chunkBitmapStride; i++) {
 380                 if (*blkBits)
 381                         return 1;
 382                 blkBits++;
 383         }
 384         return 0;
 385 }
 386
 387 static int yaffs_CountChunkBits(yaffs_Device *dev, int blk)
 388 {
 389         __u8 *blkBits = yaffs_BlockBits(dev, blk);
 390         int i;
 391         int n = 0;
 392         for (i = 0; i < dev->chunkBitmapStride; i++) {
 393                 __u8 x = *blkBits;
 394                 while (x) {
 395                         if (x & 1)
 396                                 n++;
 397                         x >>= 1;
 398                 }
 399
 400                 blkBits++;
 401         }
 402         return n;
 403 }
 404
 405 /*
 406  * Verification code
 407  */
 408
 409 static int yaffs_SkipVerification(yaffs_Device *dev)
 410 {
 411         dev=dev;
 412         return !(yaffs_traceMask & (YAFFS_TRACE_VERIFY | YAFFS_TRACE_VERIFY_FULL));
 413 }
 414
 415 static int yaffs_SkipFullVerification(yaffs_Device *dev)
 416 {
 417         dev=dev;
 418         return !(yaffs_traceMask & (YAFFS_TRACE_VERIFY_FULL));
 419 }
 420
 421 static int yaffs_SkipNANDVerification(yaffs_Device *dev)
 422 {
 423         dev=dev;
 424         return !(yaffs_traceMask & (YAFFS_TRACE_VERIFY_NAND));
 425 }
 426
 427 static const char *blockStateName[] = {
 428 "Unknown",
 429 "Needs scanning",
 430 "Scanning",
 431 "Empty",
 432 "Allocating",
 433 "Full",
 434 "Dirty",
 435 "Checkpoint",
 436 "Collecting",
 437 "Dead"
 438 };
 439
 440 static void yaffs_VerifyBlock(yaffs_Device *dev, yaffs_BlockInfo *bi, int n)
 441 {
 442         int actuallyUsed;
 443         int inUse;
 444
 445         if (yaffs_SkipVerification(dev))
 446                 return;
 447
 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));
 451
 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]));
 458         }
 459
 460         /* Check pages in use and soft deletions are legal */
 461
 462         actuallyUsed = bi->pagesInUse - bi->softDeletions;
 463
 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));
 469
 470
 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));
 476
 477         /* Check that the sequence number is valid.
 478          * Ten million is legal, but is very unlikely
 479          */
 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));
 485 }
 486
 487 static void yaffs_VerifyCollectedBlock(yaffs_Device *dev, yaffs_BlockInfo *bi,
 488                 int n)
 489 {
 490         yaffs_VerifyBlock(dev, bi, n);
 491
 492         /* After collection the block should be in the erased state */
 493         /* This will need to change if we do partial gc */
 494
 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),
 498                         n, bi->blockState));
 499         }
 500 }
 501
 502 static void yaffs_VerifyBlocks(yaffs_Device *dev)
 503 {
 504         int i;
 505         int nBlocksPerState[YAFFS_NUMBER_OF_BLOCK_STATES];
 506         int nIllegalBlockStates = 0;
 507
 508         if (yaffs_SkipVerification(dev))
 509                 return;
 510
 511         memset(nBlocksPerState, 0, sizeof(nBlocksPerState));
 512
 513         for (i = dev->internalStartBlock; i <= dev->internalEndBlock; i++) {
 514                 yaffs_BlockInfo *bi = yaffs_GetBlockInfo(dev, i);
 515                 yaffs_VerifyBlock(dev, bi, i);
 516
 517                 if (bi->blockState < YAFFS_NUMBER_OF_BLOCK_STATES)
 518                         nBlocksPerState[bi->blockState]++;
 519                 else
 520                         nIllegalBlockStates++;
 521         }
 522
 523         T(YAFFS_TRACE_VERIFY, (TSTR(""TENDSTR)));
 524         T(YAFFS_TRACE_VERIFY, (TSTR("Block summary"TENDSTR)));
 525
 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)));
 529
 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]));
 534
 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]));
 539
 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]));
 544
 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]));
 549
 550         T(YAFFS_TRACE_VERIFY, (TSTR(""TENDSTR)));
 551
 552 }
 553
 554 /*
 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.
 557  */
 558 static void yaffs_VerifyObjectHeader(yaffs_Object *obj, yaffs_ObjectHeader *oh, yaffs_ExtendedTags *tags, int parentCheck)
 559 {
 560         if (obj && yaffs_SkipVerification(obj->myDev))
 561                 return;
 562
 563         if (!(tags && obj && oh)) {
 564                 T(YAFFS_TRACE_VERIFY,
 565                                 (TSTR("Verifying object header tags %p obj %p oh %p"TENDSTR),
 566                                 tags, obj, oh));
 567                 return;
 568         }
 569
 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));
 575
 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));
 580
 581
 582         /*
 583          * Check that the object's parent ids match if parentCheck requested.
 584          *
 585          * Tests do not apply to the root object.
 586          */
 587
 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));
 592
 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));
 600
 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),
 604                         obj->objectId));
 605
 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),
 609                         obj->objectId));
 610 }
 611
 612
 613
 614 static int yaffs_VerifyTnodeWorker(yaffs_Object *obj, yaffs_Tnode *tn,
 615                                         __u32 level, int chunkOffset)
 616 {
 617         int i;
 618         yaffs_Device *dev = obj->myDev;
 619         int ok = 1;
 620
 621         if (tn) {
 622                 if (level > 0) {
 623
 624                         for (i = 0; i < YAFFS_NTNODES_INTERNAL && ok; i++) {
 625                                 if (tn->internal[i]) {
 626                                         ok = yaffs_VerifyTnodeWorker(obj,
 627                                                         tn->internal[i],
 628                                                         level - 1,
 629                                                         (chunkOffset<<YAFFS_TNODES_INTERNAL_BITS) + i);
 630                                 }
 631                         }
 632                 } else if (level == 0) {
 633                         yaffs_ExtendedTags tags;
 634                         __u32 objectId = obj->objectId;
 635
 636                         chunkOffset <<=  YAFFS_TNODES_LEVEL0_BITS;
 637
 638                         for (i = 0; i < YAFFS_NTNODES_LEVEL0; i++) {
 639                                 __u32 theChunk = yaffs_GetChunkGroupBase(dev, tn, i);
 640
 641                                 if (theChunk > 0) {
 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));
 648                                         }
 649                                 }
 650                                 chunkOffset++;
 651                         }
 652                 }
 653         }
 654
 655         return ok;
 656
 657 }
 658
 659
 660 static void yaffs_VerifyFile(yaffs_Object *obj)
 661 {
 662         int requiredTallness;
 663         int actualTallness;
 664         __u32 lastChunk;
 665         __u32 x;
 666         __u32 i;
 667         yaffs_Device *dev;
 668         yaffs_ExtendedTags tags;
 669         yaffs_Tnode *tn;
 670         __u32 objectId;
 671
 672         if (!obj)
 673                 return;
 674
 675         if (yaffs_SkipVerification(obj->myDev))
 676                 return;
 677
 678         dev = obj->myDev;
 679         objectId = obj->objectId;
 680
 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;
 685         while (x > 0) {
 686                 x >>= YAFFS_TNODES_INTERNAL_BITS;
 687                 requiredTallness++;
 688         }
 689
 690         actualTallness = obj->variant.fileVariant.topLevel;
 691
 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.
 695          */
 696
 697         if (yaffs_SkipNANDVerification(dev))
 698                 return;
 699
 700         for (i = 1; i <= lastChunk; i++) {
 701                 tn = yaffs_FindLevel0Tnode(dev, &obj->variant.fileVariant, i);
 702
 703                 if (tn) {
 704                         __u32 theChunk = yaffs_GetChunkGroupBase(dev, tn, i);
 705                         if (theChunk > 0) {
 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));
 712                                 }
 713                         }
 714                 }
 715         }
 716 }
 717
 718
 719 static void yaffs_VerifyHardLink(yaffs_Object *obj)
 720 {
 721         if (obj && yaffs_SkipVerification(obj->myDev))
 722                 return;
 723
 724         /* Verify sane equivalent object */
 725 }
 726
 727 static void yaffs_VerifySymlink(yaffs_Object *obj)
 728 {
 729         if (obj && yaffs_SkipVerification(obj->myDev))
 730                 return;
 731
 732         /* Verify symlink string */
 733 }
 734
 735 static void yaffs_VerifySpecial(yaffs_Object *obj)
 736 {
 737         if (obj && yaffs_SkipVerification(obj->myDev))
 738                 return;
 739 }
 740
 741 static void yaffs_VerifyObject(yaffs_Object *obj)
 742 {
 743         yaffs_Device *dev;
 744
 745         __u32 chunkMin;
 746         __u32 chunkMax;
 747
 748         __u32 chunkIdOk;
 749         __u32 chunkInRange;
 750         __u32 chunkShouldNotBeDeleted;
 751         __u32 chunkValid;
 752
 753         if (!obj)
 754                 return;
 755
 756         if (obj->beingCreated)
 757                 return;
 758
 759         dev = obj->myDev;
 760
 761         if (yaffs_SkipVerification(dev))
 762                 return;
 763
 764         /* Check sane object header chunk */
 765
 766         chunkMin = dev->internalStartBlock * dev->param.nChunksPerBlock;
 767         chunkMax = (dev->internalEndBlock+1) * dev->param.nChunksPerBlock - 1;
 768
 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;
 776
 777         if (!obj->fake &&
 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" : ""));
 784         }
 785
 786         if (chunkValid && !yaffs_SkipNANDVerification(dev)) {
 787                 yaffs_ExtendedTags tags;
 788                 yaffs_ObjectHeader *oh;
 789                 __u8 *buffer = yaffs_GetTempBuffer(dev, __LINE__);
 790
 791                 oh = (yaffs_ObjectHeader *)buffer;
 792
 793                 yaffs_ReadChunkWithTagsFromNAND(dev, obj->hdrChunk, buffer,
 794                                 &tags);
 795
 796                 yaffs_VerifyObjectHeader(obj, oh, &tags, 1);
 797
 798                 yaffs_ReleaseTempBuffer(dev, buffer, __LINE__);
 799         }
 800
 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));
 807         }
 808
 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));
 814         }
 815
 816         switch (obj->variantType) {
 817         case YAFFS_OBJECT_TYPE_FILE:
 818                 yaffs_VerifyFile(obj);
 819                 break;
 820         case YAFFS_OBJECT_TYPE_SYMLINK:
 821                 yaffs_VerifySymlink(obj);
 822                 break;
 823         case YAFFS_OBJECT_TYPE_DIRECTORY:
 824                 yaffs_VerifyDirectory(obj);
 825                 break;
 826         case YAFFS_OBJECT_TYPE_HARDLINK:
 827                 yaffs_VerifyHardLink(obj);
 828                 break;
 829         case YAFFS_OBJECT_TYPE_SPECIAL:
 830                 yaffs_VerifySpecial(obj);
 831                 break;
 832         case YAFFS_OBJECT_TYPE_UNKNOWN:
 833         default:
 834                 T(YAFFS_TRACE_VERIFY,
 835                 (TSTR("Obj %d has illegaltype %d"TENDSTR),
 836                 obj->objectId, obj->variantType));
 837                 break;
 838         }
 839 }
 840
 841 static void yaffs_VerifyObjects(yaffs_Device *dev)
 842 {
 843         yaffs_Object *obj;
 844         int i;
 845         struct ylist_head *lh;
 846
 847         if (yaffs_SkipVerification(dev))
 848                 return;
 849
 850         /* Iterate through the objects in each hash entry */
 851
 852         for (i = 0; i <  YAFFS_NOBJECT_BUCKETS; i++) {
 853                 ylist_for_each(lh, &dev->objectBucket[i].list) {
 854                         if (lh) {
 855                                 obj = ylist_entry(lh, yaffs_Object, hashLink);
 856                                 yaffs_VerifyObject(obj);
 857                         }
 858                 }
 859         }
 860 }
 861
 862
 863 /*
 864  *  Simple hash function. Needs to have a reasonable spread
 865  */
 866
 867 static Y_INLINE int yaffs_HashFunction(int n)
 868 {
 869         n = abs(n);
 870         return n % YAFFS_NOBJECT_BUCKETS;
 871 }
 872
 873 /*
 874  * Access functions to useful fake objects.
 875  * Note that root might have a presence in NAND if permissions are set.
 876  */
 877
 878 yaffs_Object *yaffs_Root(yaffs_Device *dev)
 879 {
 880         return dev->rootDir;
 881 }
 882
 883 yaffs_Object *yaffs_LostNFound(yaffs_Device *dev)
 884 {
 885         return dev->lostNFoundDir;
 886 }
 887
 888
 889 /*
 890  *  Erased NAND checking functions
 891  */
 892
 893 int yaffs_CheckFF(__u8 *buffer, int nBytes)
 894 {
 895         /* Horrible, slow implementation */
 896         while (nBytes--) {
 897                 if (*buffer != 0xFF)
 898                         return 0;
 899                 buffer++;
 900         }
 901         return 1;
 902 }
 903
 904 static int yaffs_CheckChunkErased(struct yaffs_DeviceStruct *dev,
 905                                 int chunkInNAND)
 906 {
 907         int retval = YAFFS_OK;
 908         __u8 *data = yaffs_GetTempBuffer(dev, __LINE__);
 909         yaffs_ExtendedTags tags;
 910         int result;
 911
 912         result = yaffs_ReadChunkWithTagsFromNAND(dev, chunkInNAND, data, &tags);
 913
 914         if (tags.eccResult > YAFFS_ECC_RESULT_NO_ERROR)
 915                 retval = YAFFS_FAIL;
 916
 917         if (!yaffs_CheckFF(data, dev->nDataBytesPerChunk) || tags.chunkUsed) {
 918                 T(YAFFS_TRACE_NANDACCESS,
 919                   (TSTR("Chunk %d not erased" TENDSTR), chunkInNAND));
 920                 retval = YAFFS_FAIL;
 921         }
 922
 923         yaffs_ReleaseTempBuffer(dev, data, __LINE__);
 924
 925         return retval;
 926
 927 }
 928
 929
 930 static int yaffs_VerifyChunkWritten(yaffs_Device *dev,
 931                                         int chunkInNAND,
 932                                         const __u8 *data,
 933                                         yaffs_ExtendedTags *tags)
 934 {
 935         int retval = YAFFS_OK;
 936         yaffs_ExtendedTags tempTags;
 937         __u8 *buffer = yaffs_GetTempBuffer(dev,__LINE__);
 938         int result;
 939
 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)
 945                 retval = YAFFS_FAIL;
 946
 947         yaffs_ReleaseTempBuffer(dev, buffer, __LINE__);
 948
 949         return retval;
 950 }
 951
 952 static int yaffs_WriteNewChunkWithTagsToNAND(struct yaffs_DeviceStruct *dev,
 953                                         const __u8 *data,
 954                                         yaffs_ExtendedTags *tags,
 955                                         int useReserve)
 956 {
 957         int attempts = 0;
 958         int writeOk = 0;
 959         int chunk;
 960
 961         yaffs_InvalidateCheckpoint(dev);
 962
 963         do {
 964                 yaffs_BlockInfo *bi = 0;
 965                 int erasedOk = 0;
 966
 967                 chunk = yaffs_AllocateChunk(dev, useReserve, &bi);
 968                 if (chunk < 0) {
 969                         /* no space */
 970                         break;
 971                 }
 972
 973                 /* First check this chunk is erased, if it needs
 974                  * checking.  The checking policy (unless forced
 975                  * always on) is as follows:
 976                  *
 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.
 981                  *
 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.
 985                  *
 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.
 991                  *
 992                  * Mods to the above
 993                  * If an erase check fails or the write fails we skip the
 994                  * rest of the block.
 995                  */
 996
 997                 /* let's give it a try */
 998                 attempts++;
 999
1000 #ifdef CONFIG_YAFFS_ALWAYS_CHECK_CHUNK_ERASED
1001                 bi->skipErasedCheck = 0;
1002 #endif
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"
1008                                 TENDSTR), chunk));
1009
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);
1015                                 continue;
1016                         }
1017                 }
1018
1019                 writeOk = yaffs_WriteChunkWithTagsToNAND(dev, chunk,
1020                                 data, tags);
1021
1022                 if(!bi->skipErasedCheck)
1023                         writeOk = yaffs_VerifyChunkWritten(dev, chunk, data, tags);
1024
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);
1029                         continue;
1030                 }
1031
1032                 bi->skipErasedCheck = 1;
1033
1034                 /* Copy the data into the robustification buffer */
1035                 yaffs_HandleWriteChunkOk(dev, chunk, data, tags);
1036
1037         } while (writeOk != YAFFS_OK &&
1038                 (yaffs_wr_attempts <= 0 || attempts <= yaffs_wr_attempts));
1039
1040         if (!writeOk)
1041                 chunk = -1;
1042
1043         if (attempts > 1) {
1044                 T(YAFFS_TRACE_ERROR,
1045                         (TSTR("**>> yaffs write required %d attempts" TENDSTR),
1046                         attempts));
1047
1048                 dev->nRetriedWrites += (attempts - 1);
1049         }
1050
1051         return chunk;
1052 }
1053
1054
1055 /*
1056  * Oldest Dirty Sequence Number handling.
1057  */
1058
1059 /* yaffs_CalcOldestDirtySequence()
1060  * yaffs_FindOldestDirtySequence()
1061  * Calculate the oldest dirty sequence number if we don't know it.
1062  */
1063 static void yaffs_CalcOldestDirtySequence(yaffs_Device *dev)
1064 {
1065         int i;
1066         unsigned seq;
1067         unsigned blockNo = 0;
1068         yaffs_BlockInfo *b;
1069
1070         if(!dev->param.isYaffs2)
1071                 return;
1072
1073         /* Find the oldest dirty sequence number. */
1074         seq = dev->sequenceNumber + 1;
1075         b = dev->blockInfo;
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;
1081                         blockNo = i;
1082                 }
1083                 b++;
1084         }
1085
1086         if(blockNo){
1087                 dev->oldestDirtySequence = seq;
1088                 dev->oldestDirtyBlock = blockNo;
1089         }
1090
1091 }
1092
1093
1094 static void yaffs_FindOldestDirtySequence(yaffs_Device *dev)
1095 {
1096         if(dev->param.isYaffs2 && !dev->oldestDirtySequence)
1097                 yaffs_CalcOldestDirtySequence(dev);
1098 }
1099
1100 /*
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.
1105  */
1106 static void yaffs_ClearOldestDirtySequence(yaffs_Device *dev, yaffs_BlockInfo *bi)
1107 {
1108
1109         if(!dev->param.isYaffs2)
1110                 return;
1111
1112         if(!bi || bi->sequenceNumber == dev->oldestDirtySequence){
1113                 dev->oldestDirtySequence = 0;
1114                 dev->oldestDirtyBlock = 0;
1115         }
1116 }
1117
1118 /*
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.
1122  */
1123 static void yaffs_UpdateOldestDirtySequence(yaffs_Device *dev, unsigned blockNo, yaffs_BlockInfo *bi)
1124 {
1125         if(dev->param.isYaffs2 && dev->oldestDirtySequence){
1126                 if(dev->oldestDirtySequence > bi->sequenceNumber){
1127                         dev->oldestDirtySequence = bi->sequenceNumber;
1128                         dev->oldestDirtyBlock = blockNo;
1129                 }
1130         }
1131 }
1132
1133 /*
1134  * Block retiring for handling a broken block.
1135  */
1136
1137 static void yaffs_RetireBlock(yaffs_Device *dev, int blockInNAND)
1138 {
1139         yaffs_BlockInfo *bi = yaffs_GetBlockInfo(dev, blockInNAND);
1140
1141         yaffs_InvalidateCheckpoint(dev);
1142
1143         yaffs_ClearOldestDirtySequence(dev,bi);
1144
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));
1150                 } else {
1151                         yaffs_ExtendedTags tags;
1152                         int chunkId = blockInNAND * dev->param.nChunksPerBlock;
1153
1154                         __u8 *buffer = yaffs_GetTempBuffer(dev, __LINE__);
1155
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));
1164
1165                         yaffs_ReleaseTempBuffer(dev, buffer, __LINE__);
1166                 }
1167         }
1168
1169         bi->blockState = YAFFS_BLOCK_STATE_DEAD;
1170         bi->gcPrioritise = 0;
1171         bi->needsRetiring = 0;
1172
1173         dev->nRetiredBlocks++;
1174 }
1175
1176 /*
1177  * Functions for robustisizing TODO
1178  *
1179  */
1180
1181 static void yaffs_HandleWriteChunkOk(yaffs_Device *dev, int chunkInNAND,
1182                                 const __u8 *data,
1183                                 const yaffs_ExtendedTags *tags)
1184 {
1185         dev=dev;
1186         chunkInNAND=chunkInNAND;
1187         data=data;
1188         tags=tags;
1189 }
1190
1191 static void yaffs_HandleUpdateChunk(yaffs_Device *dev, int chunkInNAND,
1192                                 const yaffs_ExtendedTags *tags)
1193 {
1194         dev=dev;
1195         chunkInNAND=chunkInNAND;
1196         tags=tags;
1197 }
1198
1199 void yaffs_HandleChunkError(yaffs_Device *dev, yaffs_BlockInfo *bi)
1200 {
1201         if (!bi->gcPrioritise) {
1202                 bi->gcPrioritise = 1;
1203                 dev->hasPendingPrioritisedGCs = 1;
1204                 bi->chunkErrorStrikes++;
1205
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)));
1209
1210                 }
1211         }
1212 }
1213
1214 static void yaffs_HandleWriteChunkError(yaffs_Device *dev, int chunkInNAND,
1215                 int erasedOk)
1216 {
1217         int blockInNAND = chunkInNAND / dev->param.nChunksPerBlock;
1218         yaffs_BlockInfo *bi = yaffs_GetBlockInfo(dev, blockInNAND);
1219
1220         yaffs_HandleChunkError(dev, bi);
1221
1222         if (erasedOk) {
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));
1227         }
1228
1229         /* Delete the chunk */
1230         yaffs_DeleteChunk(dev, chunkInNAND, 1, __LINE__);
1231         yaffs_SkipRestOfBlock(dev);
1232 }
1233
1234
1235 /*---------------- Name handling functions ------------*/
1236
1237 static __u16 yaffs_CalcNameSum(const YCHAR *name)
1238 {
1239         __u16 sum = 0;
1240         __u16 i = 1;
1241
1242         const YUCHAR *bname = (const YUCHAR *) name;
1243         if (bname) {
1244                 while ((*bname) && (i < (YAFFS_MAX_NAME_LENGTH/2))) {
1245
1246 #ifdef CONFIG_YAFFS_CASE_INSENSITIVE
1247                         sum += yaffs_toupper(*bname) * i;
1248 #else
1249                         sum += (*bname) * i;
1250 #endif
1251                         i++;
1252                         bname++;
1253                 }
1254         }
1255         return sum;
1256 }
1257
1258 static void yaffs_SetObjectName(yaffs_Object *obj, const YCHAR *name)
1259 {
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);
1264         else
1265                 obj->shortName[0] = _Y('\0');
1266 #endif
1267         obj->sum = yaffs_CalcNameSum(name);
1268 }
1269
1270 /*-------------------- TNODES -------------------
1271
1272  * List of spare tnodes
1273  * The list is hooked together using the first pointer
1274  * in the tnode.
1275  */
1276
1277 /* yaffs_CreateTnodes creates a bunch more tnodes and
1278  * adds them to the tnode free list.
1279  * Don't use this function directly
1280  */
1281 static Y_INLINE int yaffs_CalcTnodeSize(yaffs_Device *dev)
1282 {
1283         int tnodeSize;
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;
1287
1288         if (tnodeSize < sizeof(yaffs_Tnode))
1289                 tnodeSize = sizeof(yaffs_Tnode);
1290         return tnodeSize;
1291 }
1292
1293 static int yaffs_CreateTnodes(yaffs_Device *dev, int nTnodes)
1294 {
1295         int i;
1296         int tnodeSize = yaffs_CalcTnodeSize(dev);
1297         yaffs_Tnode *newTnodes;
1298         __u8 *mem;
1299         yaffs_Tnode *curr;
1300         yaffs_Tnode *next;
1301         yaffs_TnodeList *tnl;
1302
1303         if (nTnodes < 1)
1304                 return YAFFS_OK;
1305
1306
1307         /* make these things */
1308
1309         newTnodes = YMALLOC(nTnodes * tnodeSize);
1310         mem = (__u8 *)newTnodes;
1311
1312         if (!newTnodes) {
1313                 T(YAFFS_TRACE_ERROR,
1314                         (TSTR("yaffs: Could not allocate Tnodes" TENDSTR)));
1315                 return YAFFS_FAIL;
1316         }
1317
1318         /* Hook them into the free list */
1319 #if 0
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;
1324 #endif
1325         }
1326
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;
1330 #endif
1331         dev->freeTnodes = newTnodes;
1332 #else
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;
1338         }
1339
1340         curr = (yaffs_Tnode *) &mem[(nTnodes - 1) * tnodeSize];
1341         curr->internal[0] = dev->freeTnodes;
1342         dev->freeTnodes = (yaffs_Tnode *)mem;
1343
1344 #endif
1345
1346
1347         dev->nFreeTnodes += nTnodes;
1348         dev->nTnodesCreated += nTnodes;
1349
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.
1353          */
1354
1355         tnl = YMALLOC(sizeof(yaffs_TnodeList));
1356         if (!tnl) {
1357                 T(YAFFS_TRACE_ERROR,
1358                   (TSTR
1359                    ("yaffs: Could not add tnodes to management list" TENDSTR)));
1360                    return YAFFS_FAIL;
1361         } else {
1362                 tnl->tnodes = newTnodes;
1363                 tnl->next = dev->allocatedTnodeList;
1364                 dev->allocatedTnodeList = tnl;
1365         }
1366
1367         T(YAFFS_TRACE_ALLOCATE, (TSTR("yaffs: Tnodes added" TENDSTR)));
1368
1369         return YAFFS_OK;
1370 }
1371
1372 /* GetTnode gets us a clean tnode. Tries to make allocate more if we run out */
1373
1374 static yaffs_Tnode *yaffs_GetTnodeRaw(yaffs_Device *dev)
1375 {
1376         yaffs_Tnode *tn = NULL;
1377
1378 #ifdef CONFIG_YAFFS_VALGRIND_TEST
1379         tn = YMALLOC(yaffs_CalcTnodeSize(dev));
1380         if(tn)
1381                 dev->nTnodesCreated++;
1382 #else
1383         /* If there are none left make more */
1384         if (!dev->freeTnodes)
1385                 yaffs_CreateTnodes(dev, YAFFS_ALLOCATION_NTNODES);
1386
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)));
1394                 }
1395 #endif
1396                 dev->freeTnodes = dev->freeTnodes->internal[0];
1397                 dev->nFreeTnodes--;
1398         }
1399 #endif
1400         dev->nCheckpointBlocksRequired = 0; /* force recalculation*/
1401
1402         return tn;
1403 }
1404
1405 static yaffs_Tnode *yaffs_GetTnode(yaffs_Device *dev)
1406 {
1407         yaffs_Tnode *tn = yaffs_GetTnodeRaw(dev);
1408         int tnodeSize = yaffs_CalcTnodeSize(dev);
1409
1410         if (tn)
1411                 memset(tn, 0, tnodeSize);
1412
1413         return tn;
1414 }
1415
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)
1418 {
1419         if (tn) {
1420 #ifdef CONFIG_YAFFS_VALGRIND_TEST
1421                 YFREE(tn);
1422                 dev->nTnodesCreated--;
1423 #else
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)));
1429                 }
1430                 tn->internal[YAFFS_NTNODES_INTERNAL] = (void *)1;
1431 #endif
1432                 tn->internal[0] = dev->freeTnodes;
1433                 dev->freeTnodes = tn;
1434                 dev->nFreeTnodes++;
1435 #endif
1436         }
1437         dev->nCheckpointBlocksRequired = 0; /* force recalculation*/
1438 }
1439
1440 static void yaffs_DeinitialiseTnodes(yaffs_Device *dev)
1441 {
1442         /* Free the list of allocated tnodes */
1443         yaffs_TnodeList *tmp;
1444
1445         while (dev->allocatedTnodeList) {
1446                 tmp = dev->allocatedTnodeList->next;
1447
1448                 YFREE(dev->allocatedTnodeList->tnodes);
1449                 YFREE(dev->allocatedTnodeList);
1450                 dev->allocatedTnodeList = tmp;
1451
1452         }
1453
1454         dev->freeTnodes = NULL;
1455         dev->nFreeTnodes = 0;
1456         dev->nTnodesCreated = 0;
1457 }
1458
1459 static void yaffs_InitialiseTnodes(yaffs_Device *dev)
1460 {
1461         dev->allocatedTnodeList = NULL;
1462         dev->freeTnodes = NULL;
1463         dev->nFreeTnodes = 0;
1464         dev->nTnodesCreated = 0;
1465 }
1466
1467
1468 void yaffs_LoadLevel0Tnode(yaffs_Device *dev, yaffs_Tnode *tn, unsigned pos,
1469                 unsigned val)
1470 {
1471         __u32 *map = (__u32 *)tn;
1472         __u32 bitInMap;
1473         __u32 bitInWord;
1474         __u32 wordInMap;
1475         __u32 mask;
1476
1477         pos &= YAFFS_TNODES_LEVEL0_MASK;
1478         val >>= dev->chunkGroupBits;
1479
1480         bitInMap = pos * dev->tnodeWidth;
1481         wordInMap = bitInMap / 32;
1482         bitInWord = bitInMap & (32 - 1);
1483
1484         mask = dev->tnodeMask << bitInWord;
1485
1486         map[wordInMap] &= ~mask;
1487         map[wordInMap] |= (mask & (val << bitInWord));
1488
1489         if (dev->tnodeWidth > (32 - bitInWord)) {
1490                 bitInWord = (32 - bitInWord);
1491                 wordInMap++;;
1492                 mask = dev->tnodeMask >> (/*dev->tnodeWidth -*/ bitInWord);
1493                 map[wordInMap] &= ~mask;
1494                 map[wordInMap] |= (mask & (val >> bitInWord));
1495         }
1496 }
1497
1498 static __u32 yaffs_GetChunkGroupBase(yaffs_Device *dev, yaffs_Tnode *tn,
1499                 unsigned pos)
1500 {
1501         __u32 *map = (__u32 *)tn;
1502         __u32 bitInMap;
1503         __u32 bitInWord;
1504         __u32 wordInMap;
1505         __u32 val;
1506
1507         pos &= YAFFS_TNODES_LEVEL0_MASK;
1508
1509         bitInMap = pos * dev->tnodeWidth;
1510         wordInMap = bitInMap / 32;
1511         bitInWord = bitInMap & (32 - 1);
1512
1513         val = map[wordInMap] >> bitInWord;
1514
1515         if      (dev->tnodeWidth > (32 - bitInWord)) {
1516                 bitInWord = (32 - bitInWord);
1517                 wordInMap++;;
1518                 val |= (map[wordInMap] << bitInWord);
1519         }
1520
1521         val &= dev->tnodeMask;
1522         val <<= dev->chunkGroupBits;
1523
1524         return val;
1525 }
1526
1527 /* ------------------- End of individual tnode manipulation -----------------*/
1528
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.
1532  */
1533
1534 /* FindLevel0Tnode finds the level 0 tnode, if one exists. */
1535 static yaffs_Tnode *yaffs_FindLevel0Tnode(yaffs_Device *dev,
1536                                         yaffs_FileStructure *fStruct,
1537                                         __u32 chunkId)
1538 {
1539         yaffs_Tnode *tn = fStruct->top;
1540         __u32 i;
1541         int requiredTallness;
1542         int level = fStruct->topLevel;
1543
1544         dev=dev;
1545
1546         /* Check sane level and chunk Id */
1547         if (level < 0 || level > YAFFS_TNODES_MAX_LEVEL)
1548                 return NULL;
1549
1550         if (chunkId > YAFFS_MAX_CHUNK_ID)
1551                 return NULL;
1552
1553         /* First check we're tall enough (ie enough topLevel) */
1554
1555         i = chunkId >> YAFFS_TNODES_LEVEL0_BITS;
1556         requiredTallness = 0;
1557         while (i) {
1558                 i >>= YAFFS_TNODES_INTERNAL_BITS;
1559                 requiredTallness++;
1560         }
1561
1562         if (requiredTallness > fStruct->topLevel)
1563                 return NULL; /* Not tall enough, so we can't find it */
1564
1565         /* Traverse down to level 0 */
1566         while (level > 0 && tn) {
1567                 tn = tn->internal[(chunkId >>
1568                         (YAFFS_TNODES_LEVEL0_BITS +
1569                                 (level - 1) *
1570                                 YAFFS_TNODES_INTERNAL_BITS)) &
1571                         YAFFS_TNODES_INTERNAL_MASK];
1572                 level--;
1573         }
1574
1575         return tn;
1576 }
1577
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.
1582  *
1583  * Used when modifying the tree.
1584  *
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.
1587  */
1588
1589 static yaffs_Tnode *yaffs_AddOrFindLevel0Tnode(yaffs_Device *dev,
1590                                         yaffs_FileStructure *fStruct,
1591                                         __u32 chunkId,
1592                                         yaffs_Tnode *passedTn)
1593 {
1594         int requiredTallness;
1595         int i;
1596         int l;
1597         yaffs_Tnode *tn;
1598
1599         __u32 x;
1600
1601
1602         /* Check sane level and page Id */
1603         if (fStruct->topLevel < 0 || fStruct->topLevel > YAFFS_TNODES_MAX_LEVEL)
1604                 return NULL;
1605
1606         if (chunkId > YAFFS_MAX_CHUNK_ID)
1607                 return NULL;
1608
1609         /* First check we're tall enough (ie enough topLevel) */
1610
1611         x = chunkId >> YAFFS_TNODES_LEVEL0_BITS;
1612         requiredTallness = 0;
1613         while (x) {
1614                 x >>= YAFFS_TNODES_INTERNAL_BITS;
1615                 requiredTallness++;
1616         }
1617
1618
1619         if (requiredTallness > fStruct->topLevel) {
1620                 /* Not tall enough, gotta make the tree taller */
1621                 for (i = fStruct->topLevel; i < requiredTallness; i++) {
1622
1623                         tn = yaffs_GetTnode(dev);
1624
1625                         if (tn) {
1626                                 tn->internal[0] = fStruct->top;
1627                                 fStruct->top = tn;
1628                                 fStruct->topLevel++;
1629                         } else {
1630                                 T(YAFFS_TRACE_ERROR,
1631                                         (TSTR("yaffs: no more tnodes" TENDSTR)));
1632                                 return NULL;
1633                         }
1634                 }
1635         }
1636
1637         /* Traverse down to level 0, adding anything we need */
1638
1639         l = fStruct->topLevel;
1640         tn = fStruct->top;
1641
1642         if (l > 0) {
1643                 while (l > 0 && tn) {
1644                         x = (chunkId >>
1645                              (YAFFS_TNODES_LEVEL0_BITS +
1646                               (l - 1) * YAFFS_TNODES_INTERNAL_BITS)) &
1647                             YAFFS_TNODES_INTERNAL_MASK;
1648
1649
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])
1654                                         return NULL;
1655                         } else if (l == 1) {
1656                                 /* Looking from level 1 at level 0 */
1657                                 if (passedTn) {
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;
1662
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])
1667                                                 return NULL;
1668                                 }
1669                         }
1670
1671                         tn = tn->internal[x];
1672                         l--;
1673                 }
1674         } else {
1675                 /* top is level 0 */
1676                 if (passedTn) {
1677                         memcpy(tn, passedTn, (dev->tnodeWidth * YAFFS_NTNODES_LEVEL0)/8);
1678                         yaffs_FreeTnode(dev, passedTn);
1679                 }
1680         }
1681
1682         return tn;
1683 }
1684
1685 static int yaffs_FindChunkInGroup(yaffs_Device *dev, int theChunk,
1686                                 yaffs_ExtendedTags *tags, int objectId,
1687                                 int chunkInInode)
1688 {
1689         int j;
1690
1691         for (j = 0; theChunk && j < dev->chunkGroupSize; j++) {
1692                 if (yaffs_CheckChunkBit(dev, theChunk / dev->param.nChunksPerBlock,
1693                                 theChunk % dev->param.nChunksPerBlock)) {
1694
1695                         if(dev->chunkGroupSize == 1)
1696                                 return theChunk;
1697                         else {
1698                                 yaffs_ReadChunkWithTagsFromNAND(dev, theChunk, NULL,
1699                                                                 tags);
1700                                 if (yaffs_TagsMatch(tags, objectId, chunkInInode)) {
1701                                         /* found it; */
1702                                         return theChunk;
1703                                 }
1704                         }
1705                 }
1706                 theChunk++;
1707         }
1708         return -1;
1709 }
1710
1711
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.
1716  */
1717
1718 static int yaffs_DeleteWorker(yaffs_Object *in, yaffs_Tnode *tn, __u32 level,
1719                               int chunkOffset, int *limit)
1720 {
1721         int i;
1722         int chunkInInode;
1723         int theChunk;
1724         yaffs_ExtendedTags tags;
1725         int foundChunk;
1726         yaffs_Device *dev = in->myDev;
1727
1728         int allDone = 1;
1729
1730         if (tn) {
1731                 if (level > 0) {
1732                         for (i = YAFFS_NTNODES_INTERNAL - 1; allDone && i >= 0;
1733                              i--) {
1734                                 if (tn->internal[i]) {
1735                                         if (limit && (*limit) < 0) {
1736                                                 allDone = 0;
1737                                         } else {
1738                                                 allDone =
1739                                                         yaffs_DeleteWorker(in,
1740                                                                 tn->
1741                                                                 internal
1742                                                                 [i],
1743                                                                 level -
1744                                                                 1,
1745                                                                 (chunkOffset
1746                                                                         <<
1747                                                                         YAFFS_TNODES_INTERNAL_BITS)
1748                                                                 + i,
1749                                                                 limit);
1750                                         }
1751                                         if (allDone) {
1752                                                 yaffs_FreeTnode(dev,
1753                                                                 tn->
1754                                                                 internal[i]);
1755                                                 tn->internal[i] = NULL;
1756                                         }
1757                                 }
1758                         }
1759                         return (allDone) ? 1 : 0;
1760                 } else if (level == 0) {
1761                         int hitLimit = 0;
1762
1763                         for (i = YAFFS_NTNODES_LEVEL0 - 1; i >= 0 && !hitLimit;
1764                                         i--) {
1765                                 theChunk = yaffs_GetChunkGroupBase(dev, tn, i);
1766                                 if (theChunk) {
1767
1768                                         chunkInInode = (chunkOffset <<
1769                                                 YAFFS_TNODES_LEVEL0_BITS) + i;
1770
1771                                         foundChunk =
1772                                                 yaffs_FindChunkInGroup(dev,
1773                                                                 theChunk,
1774                                                                 &tags,
1775                                                                 in->objectId,
1776                                                                 chunkInInode);
1777
1778                                         if (foundChunk > 0) {
1779                                                 yaffs_DeleteChunk(dev,
1780                                                                   foundChunk, 1,
1781                                                                   __LINE__);
1782                                                 in->nDataChunks--;
1783                                                 if (limit) {
1784                                                         *limit = *limit - 1;
1785                                                         if (*limit <= 0)
1786                                                                 hitLimit = 1;
1787                                                 }
1788
1789                                         }
1790
1791                                         yaffs_LoadLevel0Tnode(dev, tn, i, 0);
1792                                 }
1793
1794                         }
1795                         return (i < 0) ? 1 : 0;
1796
1797                 }
1798
1799         }
1800
1801         return 1;
1802
1803 }
1804
1805 static void yaffs_SoftDeleteChunk(yaffs_Device *dev, int chunk)
1806 {
1807         yaffs_BlockInfo *theBlock;
1808         unsigned blockNo;
1809
1810         T(YAFFS_TRACE_DELETION, (TSTR("soft delete chunk %d" TENDSTR), chunk));
1811
1812         blockNo =  chunk / dev->param.nChunksPerBlock;
1813         theBlock = yaffs_GetBlockInfo(dev, blockNo);
1814         if (theBlock) {
1815                 theBlock->softDeletions++;
1816                 dev->nFreeChunks++;
1817                 yaffs_UpdateOldestDirtySequence(dev, blockNo, theBlock);
1818         }
1819 }
1820
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
1823  * of the tnode.
1824  * Thus, essentially this is the same as DeleteWorker except that the chunks are soft deleted.
1825  */
1826
1827 static int yaffs_SoftDeleteWorker(yaffs_Object *in, yaffs_Tnode *tn,
1828                                   __u32 level, int chunkOffset)
1829 {
1830         int i;
1831         int theChunk;
1832         int allDone = 1;
1833         yaffs_Device *dev = in->myDev;
1834
1835         if (tn) {
1836                 if (level > 0) {
1837
1838                         for (i = YAFFS_NTNODES_INTERNAL - 1; allDone && i >= 0;
1839                              i--) {
1840                                 if (tn->internal[i]) {
1841                                         allDone =
1842                                             yaffs_SoftDeleteWorker(in,
1843                                                                    tn->
1844                                                                    internal[i],
1845                                                                    level - 1,
1846                                                                    (chunkOffset
1847                                                                     <<
1848                                                                     YAFFS_TNODES_INTERNAL_BITS)
1849                                                                    + i);
1850                                         if (allDone) {
1851                                                 yaffs_FreeTnode(dev,
1852                                                                 tn->
1853                                                                 internal[i]);
1854                                                 tn->internal[i] = NULL;
1855                                         } else {
1856                                                 /* Hoosterman... how could this happen? */
1857                                         }
1858                                 }
1859                         }
1860                         return (allDone) ? 1 : 0;
1861                 } else if (level == 0) {
1862
1863                         for (i = YAFFS_NTNODES_LEVEL0 - 1; i >= 0; i--) {
1864                                 theChunk = yaffs_GetChunkGroupBase(dev, tn, i);
1865                                 if (theChunk) {
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
1868                                          * a block.
1869                                          */
1870                                         yaffs_SoftDeleteChunk(dev, theChunk);
1871                                         yaffs_LoadLevel0Tnode(dev, tn, i, 0);
1872                                 }
1873
1874                         }
1875                         return 1;
1876
1877                 }
1878
1879         }
1880
1881         return 1;
1882
1883 }
1884
1885 static void yaffs_SoftDeleteFile(yaffs_Object *obj)
1886 {
1887         if (obj->deleted &&
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),
1896                            obj->objectId));
1897                         yaffs_DoGenericObjectDeletion(obj);
1898                 } else {
1899                         yaffs_SoftDeleteWorker(obj,
1900                                                obj->variant.fileVariant.top,
1901                                                obj->variant.fileVariant.
1902                                                topLevel, 0);
1903                         obj->softDeleted = 1;
1904                 }
1905         }
1906 }
1907
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).
1910  *
1911  * A file should only get pruned when its size is reduced.
1912  *
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.
1917  *
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.
1921  */
1922
1923 static yaffs_Tnode *yaffs_PruneWorker(yaffs_Device *dev, yaffs_Tnode *tn,
1924                                 __u32 level, int del0)
1925 {
1926         int i;
1927         int hasData;
1928
1929         if (tn) {
1930                 hasData = 0;
1931
1932                 if(level > 0){
1933                         for (i = 0; i < YAFFS_NTNODES_INTERNAL; i++) {
1934                                 if (tn->internal[i]) {
1935                                         tn->internal[i] =
1936                                                 yaffs_PruneWorker(dev, tn->internal[i],
1937                                                         level - 1,
1938                                                         (i == 0) ? del0 : 1);
1939                                 }
1940
1941                                 if (tn->internal[i])
1942                                         hasData++;
1943                         }
1944                 } else {
1945                         int tnodeSize_u32 = yaffs_CalcTnodeSize(dev)/sizeof(__u32);
1946                         __u32 *map = (__u32 *)tn;
1947
1948                         for(i = 0; !hasData && i < tnodeSize_u32; i++){
1949                                 if(map[i])
1950                                         hasData++;
1951                         }
1952                 }
1953
1954                 if (hasData == 0 && del0) {
1955                         /* Free and return NULL */
1956
1957                         yaffs_FreeTnode(dev, tn);
1958                         tn = NULL;
1959                 }
1960
1961         }
1962
1963         return tn;
1964
1965 }
1966
1967 static int yaffs_PruneFileStructure(yaffs_Device *dev,
1968                                 yaffs_FileStructure *fStruct)
1969 {
1970         int i;
1971         int hasData;
1972         int done = 0;
1973         yaffs_Tnode *tn;
1974
1975         if (fStruct->topLevel > 0) {
1976                 fStruct->top =
1977                     yaffs_PruneWorker(dev, fStruct->top, fStruct->topLevel, 0);
1978
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)
1984                  */
1985
1986                 while (fStruct->topLevel && !done) {
1987                         tn = fStruct->top;
1988
1989                         hasData = 0;
1990                         for (i = 1; i < YAFFS_NTNODES_INTERNAL; i++) {
1991                                 if (tn->internal[i])
1992                                         hasData++;
1993                         }
1994
1995                         if (!hasData) {
1996                                 fStruct->top = tn->internal[0];
1997                                 fStruct->topLevel--;
1998                                 yaffs_FreeTnode(dev, tn);
1999                         } else {
2000                                 done = 1;
2001                         }
2002                 }
2003         }
2004
2005         return YAFFS_OK;
2006 }
2007
2008 /*-------------------- End of File Structure functions.-------------------*/
2009
2010 /* yaffs_CreateFreeObjects creates a bunch more objects and
2011  * adds them to the object free list.
2012  */
2013 static int yaffs_CreateFreeObjects(yaffs_Device *dev, int nObjects)
2014 {
2015         int i;
2016         yaffs_Object *newObjects;
2017         yaffs_ObjectList *list;
2018
2019         if (nObjects < 1)
2020                 return YAFFS_OK;
2021
2022         /* make these things */
2023         newObjects = YMALLOC(nObjects * sizeof(yaffs_Object));
2024         list = YMALLOC(sizeof(yaffs_ObjectList));
2025
2026         if (!newObjects || !list) {
2027                 if (newObjects){
2028                         YFREE(newObjects);
2029                         newObjects = NULL;
2030                 }
2031                 if (list){
2032                         YFREE(list);
2033                         list = NULL;
2034                 }
2035                 T(YAFFS_TRACE_ALLOCATE,
2036                   (TSTR("yaffs: Could not allocate more objects" TENDSTR)));
2037                 return YAFFS_FAIL;
2038         }
2039
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]);
2044         }
2045
2046         newObjects[nObjects - 1].siblings.next = (void *)dev->freeObjects;
2047         dev->freeObjects = newObjects;
2048         dev->nFreeObjects += nObjects;
2049         dev->nObjectsCreated += nObjects;
2050
2051         /* Now add this bunch of Objects to a list for freeing up. */
2052
2053         list->objects = newObjects;
2054         list->next = dev->allocatedObjectList;
2055         dev->allocatedObjectList = list;
2056
2057         return YAFFS_OK;
2058 }
2059
2060
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)
2063 {
2064         yaffs_Object *tn = NULL;
2065
2066 #ifdef CONFIG_YAFFS_VALGRIND_TEST
2067         tn = YMALLOC(sizeof(yaffs_Object));
2068         if(tn)
2069                 dev->nObjectsCreated++;
2070 #else
2071         /* If there are none left make more */
2072         if (!dev->freeObjects)
2073                 yaffs_CreateFreeObjects(dev, YAFFS_ALLOCATION_NOBJECTS);
2074
2075         if (dev->freeObjects) {
2076                 tn = dev->freeObjects;
2077                 dev->freeObjects =
2078                         (yaffs_Object *) (dev->freeObjects->siblings.next);
2079                 dev->nFreeObjects--;
2080         }
2081 #endif
2082         if (tn) {
2083                 /* Now sweeten it up... */
2084
2085                 memset(tn, 0, sizeof(yaffs_Object));
2086                 tn->beingCreated = 1;
2087
2088                 tn->myDev = dev;
2089                 tn->hdrChunk = 0;
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);
2094
2095
2096                 /* Now make the directory sane */
2097                 if (dev->rootDir) {
2098                         tn->parent = dev->rootDir;
2099                         ylist_add(&(tn->siblings), &dev->rootDir->variant.directoryVariant.children);
2100                 }
2101
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
2105                  */
2106                 if (dev->lostNFoundDir)
2107                         yaffs_AddObjectToDirectory(dev->lostNFoundDir, tn);
2108
2109                 tn->beingCreated = 0;
2110         }
2111
2112         dev->nCheckpointBlocksRequired = 0; /* force recalculation*/
2113
2114         return tn;
2115 }
2116
2117 static yaffs_Object *yaffs_CreateFakeDirectory(yaffs_Device *dev, int number,
2118                                                __u32 mode)
2119 {
2120
2121         yaffs_Object *obj =
2122             yaffs_CreateNewObject(dev, number, YAFFS_OBJECT_TYPE_DIRECTORY);
2123         if (obj) {
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 */
2127                 obj->deleted = 0;
2128                 obj->unlinked = 0;
2129                 obj->yst_mode = mode;
2130                 obj->myDev = dev;
2131                 obj->hdrChunk = 0;      /* Not a valid chunk. */
2132         }
2133
2134         return obj;
2135
2136 }
2137
2138 static void yaffs_UnhashObject(yaffs_Object *tn)
2139 {
2140         int bucket;
2141         yaffs_Device *dev = tn->myDev;
2142
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--;
2148         }
2149 }
2150
2151 /*  FreeObject frees up a Object and puts it back on the free list */
2152 static void yaffs_FreeObject(yaffs_Object *tn)
2153 {
2154         yaffs_Device *dev = tn->myDev;
2155
2156         T(YAFFS_TRACE_OS, (TSTR("FreeObject %p inode %p"TENDSTR), tn, tn->myInode));
2157
2158         if (!tn)
2159                 YBUG();
2160         if (tn->parent)
2161                 YBUG();
2162         if (!ylist_empty(&tn->siblings))
2163                 YBUG();
2164
2165
2166         if (tn->myInode) {
2167                 /* We're still hooked up to a cached inode.
2168                  * Don't delete now, but mark for later deletion
2169                  */
2170                 tn->deferedFree = 1;
2171                 return;
2172         }
2173
2174         yaffs_UnhashObject(tn);
2175
2176 #ifdef CONFIG_YAFFS_VALGRIND_TEST
2177         YFREE(tn);
2178         dev->nObjectsCreated--;
2179         tn = NULL;
2180 #else
2181         /* Link into the free list. */
2182         tn->siblings.next = (struct ylist_head *)(dev->freeObjects);
2183         dev->freeObjects = tn;
2184         dev->nFreeObjects++;
2185 #endif
2186         dev->nCheckpointBlocksRequired = 0; /* force recalculation*/
2187 }
2188
2189
2190 void yaffs_HandleDeferedFree(yaffs_Object *obj)
2191 {
2192         if (obj->deferedFree)
2193                 yaffs_FreeObject(obj);
2194 }
2195
2196
2197 static void yaffs_DeinitialiseObjects(yaffs_Device *dev)
2198 {
2199         /* Free the list of allocated Objects */
2200
2201         yaffs_ObjectList *tmp;
2202
2203         while (dev->allocatedObjectList) {
2204                 tmp = dev->allocatedObjectList->next;
2205                 YFREE(dev->allocatedObjectList->objects);
2206                 YFREE(dev->allocatedObjectList);
2207
2208                 dev->allocatedObjectList = tmp;
2209         }
2210
2211         dev->freeObjects = NULL;
2212         dev->nFreeObjects = 0;
2213         dev->nObjectsCreated = 0;
2214 }
2215
2216 static void yaffs_InitialiseObjects(yaffs_Device *dev)
2217 {
2218         int i;
2219
2220         dev->allocatedObjectList = NULL;
2221         dev->freeObjects = NULL;
2222         dev->nFreeObjects = 0;
2223
2224         for (i = 0; i < YAFFS_NOBJECT_BUCKETS; i++) {
2225                 YINIT_LIST_HEAD(&dev->objectBucket[i].list);
2226                 dev->objectBucket[i].count = 0;
2227         }
2228 }
2229
2230 static int yaffs_FindNiceObjectBucket(yaffs_Device *dev)
2231 {
2232         int i;
2233         int l = 999;
2234         int lowest = 999999;
2235
2236
2237         /* Search for the shortest list or one that
2238          * isn't too long.
2239          */
2240
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;
2247                 }
2248
2249         }
2250
2251         return l;
2252 }
2253
2254 static int yaffs_CreateNewObjectNumber(yaffs_Device *dev)
2255 {
2256         int bucket = yaffs_FindNiceObjectBucket(dev);
2257
2258         /* Now find an object value that has not already been taken
2259          * by scanning the list.
2260          */
2261
2262         int found = 0;
2263         struct ylist_head *i;
2264
2265         __u32 n = (__u32) bucket;
2266
2267         /* yaffs_CheckObjectHashSanity();  */
2268
2269         while (!found) {
2270                 found = 1;
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) {
2277                                         found = 0;
2278                                 }
2279                         }
2280                 }
2281         }
2282
2283         return n;
2284 }
2285
2286 static void yaffs_HashObject(yaffs_Object *in)
2287 {
2288         int bucket = yaffs_HashFunction(in->objectId);
2289         yaffs_Device *dev = in->myDev;
2290
2291         ylist_add(&in->hashLink, &dev->objectBucket[bucket].list);
2292         dev->objectBucket[bucket].count++;
2293 }
2294
2295 yaffs_Object *yaffs_FindObjectByNumber(yaffs_Device *dev, __u32 number)
2296 {
2297         int bucket = yaffs_HashFunction(number);
2298         struct ylist_head *i;
2299         yaffs_Object *in;
2300
2301         ylist_for_each(i, &dev->objectBucket[bucket].list) {
2302                 /* Look if it is in the list */
2303                 if (i) {
2304                         in = ylist_entry(i, yaffs_Object, hashLink);
2305                         if (in->objectId == number) {
2306
2307                                 /* Don't tell the VFS about this one if it is defered free */
2308                                 if (in->deferedFree)
2309                                         return NULL;
2310
2311                                 return in;
2312                         }
2313                 }
2314         }
2315
2316         return NULL;
2317 }
2318
2319 yaffs_Object *yaffs_CreateNewObject(yaffs_Device *dev, int number,
2320                                     yaffs_ObjectType type)
2321 {
2322         yaffs_Object *theObject=NULL;
2323         yaffs_Tnode *tn = NULL;
2324
2325         if (number < 0)
2326                 number = yaffs_CreateNewObjectNumber(dev);
2327
2328         if (type == YAFFS_OBJECT_TYPE_FILE) {
2329                 tn = yaffs_GetTnode(dev);
2330                 if (!tn)
2331                         return NULL;
2332         }
2333
2334         theObject = yaffs_AllocateEmptyObject(dev);
2335         if (!theObject){
2336                 if(tn)
2337                         yaffs_FreeTnode(dev,tn);
2338                 return NULL;
2339         }
2340
2341
2342         if (theObject) {
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];
2355
2356 #else
2357
2358                 theObject->yst_atime = theObject->yst_mtime =
2359                     theObject->yst_ctime = Y_CURRENT_TIME;
2360 #endif
2361                 switch (type) {
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;
2368                         break;
2369                 case YAFFS_OBJECT_TYPE_DIRECTORY:
2370                         YINIT_LIST_HEAD(&theObject->variant.directoryVariant.
2371                                         children);
2372                         YINIT_LIST_HEAD(&theObject->variant.directoryVariant.
2373                                         dirty);
2374                         break;
2375                 case YAFFS_OBJECT_TYPE_SYMLINK:
2376                 case YAFFS_OBJECT_TYPE_HARDLINK:
2377                 case YAFFS_OBJECT_TYPE_SPECIAL:
2378                         /* No action required */
2379                         break;
2380                 case YAFFS_OBJECT_TYPE_UNKNOWN:
2381                         /* todo this should not happen */
2382                         break;
2383                 }
2384         }
2385
2386         return theObject;
2387 }
2388
2389 static yaffs_Object *yaffs_FindOrCreateObjectByNumber(yaffs_Device *dev,
2390                                                       int number,
2391                                                       yaffs_ObjectType type)
2392 {
2393         yaffs_Object *theObject = NULL;
2394
2395         if (number > 0)
2396                 theObject = yaffs_FindObjectByNumber(dev, number);
2397
2398         if (!theObject)
2399                 theObject = yaffs_CreateNewObject(dev, number, type);
2400
2401         return theObject;
2402
2403 }
2404
2405
2406 static YCHAR *yaffs_CloneString(const YCHAR *str)
2407 {
2408         YCHAR *newStr = NULL;
2409         int len;
2410
2411         if (!str)
2412                 str = _Y("");
2413
2414         len = yaffs_strnlen(str,YAFFS_MAX_ALIAS_LENGTH);
2415         newStr = YMALLOC((len + 1) * sizeof(YCHAR));
2416         if (newStr){
2417                 yaffs_strncpy(newStr, str,len);
2418                 newStr[len] = 0;
2419         }
2420         return newStr;
2421
2422 }
2423
2424 /*
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)
2429  */
2430
2431 static yaffs_Object *yaffs_MknodObject(yaffs_ObjectType type,
2432                                        yaffs_Object *parent,
2433                                        const YCHAR *name,
2434                                        __u32 mode,
2435                                        __u32 uid,
2436                                        __u32 gid,
2437                                        yaffs_Object *equivalentObject,
2438                                        const YCHAR *aliasString, __u32 rdev)
2439 {
2440         yaffs_Object *in;
2441         YCHAR *str = NULL;
2442
2443         yaffs_Device *dev = parent->myDev;
2444
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))
2447                 return NULL;
2448
2449         if (type == YAFFS_OBJECT_TYPE_SYMLINK) {
2450                 str = yaffs_CloneString(aliasString);
2451                 if (!str)
2452                         return NULL;
2453         }
2454
2455         in = yaffs_CreateNewObject(dev, -1, type);
2456
2457         if (!in){
2458                 if(str)
2459                         YFREE(str);
2460                 return NULL;
2461         }
2462
2463
2464
2465
2466
2467         if (in) {
2468                 in->hdrChunk = 0;
2469                 in->valid = 1;
2470                 in->variantType = type;
2471
2472                 in->yst_mode = mode;
2473
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];
2478
2479 #else
2480                 in->yst_atime = in->yst_mtime = in->yst_ctime = Y_CURRENT_TIME;
2481
2482                 in->yst_rdev = rdev;
2483                 in->yst_uid = uid;
2484                 in->yst_gid = gid;
2485 #endif
2486                 in->nDataChunks = 0;
2487
2488                 yaffs_SetObjectName(in, name);
2489                 in->dirty = 1;
2490
2491                 yaffs_AddObjectToDirectory(parent, in);
2492
2493                 in->myDev = parent->myDev;
2494
2495                 switch (type) {
2496                 case YAFFS_OBJECT_TYPE_SYMLINK:
2497                         in->variant.symLinkVariant.alias = str;
2498                         break;
2499                 case YAFFS_OBJECT_TYPE_HARDLINK:
2500                         in->variant.hardLinkVariant.equivalentObject =
2501                                 equivalentObject;
2502                         in->variant.hardLinkVariant.equivalentObjectId =
2503                                 equivalentObject->objectId;
2504                         ylist_add(&in->hardLinks, &equivalentObject->hardLinks);
2505                         break;
2506                 case YAFFS_OBJECT_TYPE_FILE:
2507                 case YAFFS_OBJECT_TYPE_DIRECTORY:
2508                 case YAFFS_OBJECT_TYPE_SPECIAL:
2509                 case YAFFS_OBJECT_TYPE_UNKNOWN:
2510                         /* do nothing */
2511                         break;
2512                 }
2513
2514                 if (yaffs_UpdateObjectHeader(in, name, 0, 0, 0) < 0) {
2515                         /* Could not create the object header, fail the creation */
2516                         yaffs_DeleteObject(in);
2517                         in = NULL;
2518                 }
2519
2520                 yaffs_UpdateParent(parent);
2521         }
2522
2523         return in;
2524 }
2525
2526 yaffs_Object *yaffs_MknodFile(yaffs_Object *parent, const YCHAR *name,
2527                         __u32 mode, __u32 uid, __u32 gid)
2528 {
2529         return yaffs_MknodObject(YAFFS_OBJECT_TYPE_FILE, parent, name, mode,
2530                                 uid, gid, NULL, NULL, 0);
2531 }
2532
2533 yaffs_Object *yaffs_MknodDirectory(yaffs_Object *parent, const YCHAR *name,
2534                                 __u32 mode, __u32 uid, __u32 gid)
2535 {
2536         return yaffs_MknodObject(YAFFS_OBJECT_TYPE_DIRECTORY, parent, name,
2537                                  mode, uid, gid, NULL, NULL, 0);
2538 }
2539
2540 yaffs_Object *yaffs_MknodSpecial(yaffs_Object *parent, const YCHAR *name,
2541                                 __u32 mode, __u32 uid, __u32 gid, __u32 rdev)
2542 {
2543         return yaffs_MknodObject(YAFFS_OBJECT_TYPE_SPECIAL, parent, name, mode,
2544                                  uid, gid, NULL, NULL, rdev);
2545 }
2546
2547 yaffs_Object *yaffs_MknodSymLink(yaffs_Object *parent, const YCHAR *name,
2548                                 __u32 mode, __u32 uid, __u32 gid,
2549                                 const YCHAR *alias)
2550 {
2551         return yaffs_MknodObject(YAFFS_OBJECT_TYPE_SYMLINK, parent, name, mode,
2552                                 uid, gid, NULL, alias, 0);
2553 }
2554
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)
2558 {
2559         /* Get the real object in case we were fed a hard link as an equivalent object */
2560         equivalentObject = yaffs_GetEquivalentObject(equivalentObject);
2561
2562         if (yaffs_MknodObject
2563             (YAFFS_OBJECT_TYPE_HARDLINK, parent, name, 0, 0, 0,
2564              equivalentObject, NULL, 0)) {
2565                 return equivalentObject;
2566         } else {
2567                 return NULL;
2568         }
2569
2570 }
2571
2572 static int yaffs_ChangeObjectName(yaffs_Object *obj, yaffs_Object *newDir,
2573                                 const YCHAR *newName, int force, int shadows)
2574 {
2575         int unlinkOp;
2576         int deleteOp;
2577
2578         yaffs_Object *existingTarget;
2579
2580         if (newDir == NULL)
2581                 newDir = obj->parent;   /* use the old directory */
2582
2583         if (newDir->variantType != YAFFS_OBJECT_TYPE_DIRECTORY) {
2584                 T(YAFFS_TRACE_ALWAYS,
2585                   (TSTR
2586                    ("tragedy: yaffs_ChangeObjectName: newDir is not a directory"
2587                     TENDSTR)));
2588                 YBUG();
2589         }
2590
2591         /* TODO: Do we need this different handling for YAFFS2 and YAFFS1?? */
2592         if (obj->myDev->param.isYaffs2)
2593                 unlinkOp = (newDir == obj->myDev->unlinkedDir);
2594         else
2595                 unlinkOp = (newDir == obj->myDev->unlinkedDir
2596                             && obj->variantType == YAFFS_OBJECT_TYPE_FILE);
2597
2598         deleteOp = (newDir == obj->myDev->deletedDir);
2599
2600         existingTarget = yaffs_FindObjectByName(newDir, newName);
2601
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.
2606          */
2607         if ((unlinkOp ||
2608              deleteOp ||
2609              force ||
2610              (shadows > 0) ||
2611              !existingTarget) &&
2612             newDir->variantType == YAFFS_OBJECT_TYPE_DIRECTORY) {
2613                 yaffs_SetObjectName(obj, newName);
2614                 obj->dirty = 1;
2615
2616                 yaffs_AddObjectToDirectory(newDir, obj);
2617
2618                 if (unlinkOp)
2619                         obj->unlinked = 1;
2620
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)
2623                         return YAFFS_OK;
2624         }
2625
2626         return YAFFS_FAIL;
2627 }
2628
2629 int yaffs_RenameObject(yaffs_Object *oldDir, const YCHAR *oldName,
2630                 yaffs_Object *newDir, const YCHAR *newName)
2631 {
2632         yaffs_Object *obj = NULL;
2633         yaffs_Object *existingTarget = NULL;
2634         int force = 0;
2635         int result;
2636         yaffs_Device *dev;
2637
2638
2639         if (!oldDir || oldDir->variantType != YAFFS_OBJECT_TYPE_DIRECTORY)
2640                 YBUG();
2641         if (!newDir || newDir->variantType != YAFFS_OBJECT_TYPE_DIRECTORY)
2642                 YBUG();
2643
2644         dev = oldDir->myDev;
2645
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
2650         */
2651         if (oldDir == newDir && yaffs_strcmp(oldName, newName) == 0)
2652                 force = 1;
2653 #endif
2654
2655         if(yaffs_strnlen(newName,YAFFS_MAX_NAME_LENGTH+1) > YAFFS_MAX_NAME_LENGTH)
2656                 /* ENAMETOOLONG */
2657                 return YAFFS_FAIL;
2658
2659         obj = yaffs_FindObjectByName(oldDir, oldName);
2660
2661         if (obj && obj->renameAllowed) {
2662
2663                 /* Now do the handling for an existing target, if there is one */
2664
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.
2674                          *
2675                          * Note we must disable gc otherwise it can mess up the shadowing.
2676                          *
2677                          */
2678                         dev->gcDisable=1;
2679                         yaffs_ChangeObjectName(obj, newDir, newName, force,
2680                                                 existingTarget->objectId);
2681                         existingTarget->isShadowed = 1;
2682                         yaffs_UnlinkObject(existingTarget);
2683                         dev->gcDisable=0;
2684                 }
2685
2686                 result = yaffs_ChangeObjectName(obj, newDir, newName, 1, 0);
2687
2688                 yaffs_UpdateParent(oldDir);
2689                 if(newDir != oldDir)
2690                         yaffs_UpdateParent(newDir);
2691
2692                 return result;
2693         }
2694         return YAFFS_FAIL;
2695 }
2696
2697 /*------------------------- Block Management and Page Allocation ----------------*/
2698
2699 static int yaffs_InitialiseBlocks(yaffs_Device *dev)
2700 {
2701         int nBlocks = dev->internalEndBlock - dev->internalStartBlock + 1;
2702
2703         dev->blockInfo = NULL;
2704         dev->chunkBits = NULL;
2705
2706         dev->allocationBlock = -1;      /* force it to get a new one */
2707
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;
2713         } else
2714                 dev->blockInfoAlt = 0;
2715
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;
2723                 } else
2724                         dev->chunkBitsAlt = 0;
2725         }
2726
2727         if (dev->blockInfo && dev->chunkBits) {
2728                 memset(dev->blockInfo, 0, nBlocks * sizeof(yaffs_BlockInfo));
2729                 memset(dev->chunkBits, 0, dev->chunkBitmapStride * nBlocks);
2730                 return YAFFS_OK;
2731         }
2732
2733         return YAFFS_FAIL;
2734 }
2735
2736 static void yaffs_DeinitialiseBlocks(yaffs_Device *dev)
2737 {
2738         if (dev->blockInfoAlt && dev->blockInfo)
2739                 YFREE_ALT(dev->blockInfo);
2740         else if (dev->blockInfo)
2741                 YFREE(dev->blockInfo);
2742
2743         dev->blockInfoAlt = 0;
2744
2745         dev->blockInfo = NULL;
2746
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;
2753 }
2754
2755 static int yaffs_BlockNotDisqualifiedFromGC(yaffs_Device *dev,
2756                                         yaffs_BlockInfo *bi)
2757 {
2758
2759         if (!dev->param.isYaffs2)
2760                 return 1;       /* disqualification only applies to yaffs2. */
2761
2762         if (!bi->hasShrinkHeader)
2763                 return 1;       /* can gc */
2764
2765         yaffs_FindOldestDirtySequence(dev);
2766
2767         /* Can't do gc of this block if there are any blocks older than this one that have
2768          * discarded pages.
2769          */
2770         return (bi->sequenceNumber <= dev->oldestDirtySequence);
2771 }
2772
2773 /*
2774  * yaffs_FindRefreshBlock()
2775  * periodically finds the oldest full block by sequence number for refreshing.
2776  * Only for yaffs2.
2777  */
2778 static __u32 yaffs_FindRefreshBlock(yaffs_Device *dev)
2779 {
2780         __u32 b ;
2781
2782         __u32 oldest = 0;
2783         __u32 oldestSequence = 0;
2784
2785         yaffs_BlockInfo *bi;
2786
2787         /*
2788          * If refresh period < 10 then refreshing is disabled.
2789          */
2790         if(dev->param.refreshPeriod < 10 ||
2791                 !dev->param.isYaffs2)
2792                 return oldest;
2793
2794         /*
2795          * Fix broken values.
2796          */
2797         if(dev->refreshSkip > dev->param.refreshPeriod)
2798                 dev->refreshSkip = dev->param.refreshPeriod;
2799
2800         if(dev->refreshSkip > 0)
2801                 return oldest;
2802
2803         /*
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.
2807          */
2808         dev->refreshSkip = dev->param.refreshPeriod;
2809         dev->refreshCount++;
2810         bi = dev->blockInfo;
2811         for (b = dev->internalStartBlock; b <=dev->internalEndBlock; b++){
2812
2813                 if (bi->blockState == YAFFS_BLOCK_STATE_FULL){
2814
2815                         if(oldest < 1 ||
2816                                 bi->sequenceNumber < oldestSequence){
2817                                 oldest = b;
2818                                 oldestSequence = bi->sequenceNumber;
2819                         }
2820                 }
2821                 bi++;
2822         }
2823
2824         if (oldest > 0) {
2825                 T(YAFFS_TRACE_GC,
2826                   (TSTR("GC refresh count %d selected block %d with sequenceNumber %d" TENDSTR),
2827                    dev->refreshCount, oldest, oldestSequence));
2828         }
2829
2830         return oldest;
2831 }
2832
2833
2834 static void yaffs_BlockBecameDirty(yaffs_Device *dev, int blockNo)
2835 {
2836         yaffs_BlockInfo *bi = yaffs_GetBlockInfo(dev, blockNo);
2837
2838         int erasedOk = 0;
2839
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.
2842          */
2843
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" : ""));
2847
2848         yaffs_ClearOldestDirtySequence(dev,bi);
2849
2850         bi->blockState = YAFFS_BLOCK_STATE_DIRTY;
2851
2852         /* If this is the block being garbage collected then stop gc'ing this block */
2853         if(blockNo == dev->gcBlock)
2854                 dev->gcBlock = 0;
2855
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;
2860         }
2861
2862         if (!bi->needsRetiring) {
2863                 yaffs_InvalidateCheckpoint(dev);
2864                 erasedOk = yaffs_EraseBlockInNAND(dev, blockNo);
2865                 if (!erasedOk) {
2866                         dev->nErasureFailures++;
2867                         T(YAFFS_TRACE_ERROR | YAFFS_TRACE_BAD_BLOCKS,
2868                           (TSTR("**>> Erasure failed %d" TENDSTR), blockNo));
2869                 }
2870         }
2871
2872         if (erasedOk &&
2873             ((yaffs_traceMask & YAFFS_TRACE_ERASE) || !yaffs_SkipVerification(dev))) {
2874                 int i;
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,
2879                                   (TSTR
2880                                    (">>Block %d erasure supposedly OK, but chunk %d not erased"
2881                                     TENDSTR), blockNo, i));
2882                         }
2883                 }
2884         }
2885
2886         if (erasedOk) {
2887                 /* Clean it up... */
2888                 bi->blockState = YAFFS_BLOCK_STATE_EMPTY;
2889                 bi->sequenceNumber = 0;
2890                 dev->nErasedBlocks++;
2891                 bi->pagesInUse = 0;
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);
2897
2898                 T(YAFFS_TRACE_ERASE,
2899                   (TSTR("Erased block %d" TENDSTR), blockNo));
2900         } else {
2901                 dev->nFreeChunks -= dev->param.nChunksPerBlock; /* We lost a block of free space */
2902
2903                 yaffs_RetireBlock(dev, blockNo);
2904                 T(YAFFS_TRACE_ERROR | YAFFS_TRACE_BAD_BLOCKS,
2905                   (TSTR("**>> Block %d retired" TENDSTR), blockNo));
2906         }
2907 }
2908
2909 static int yaffs_FindBlockForAllocation(yaffs_Device *dev)
2910 {
2911         int i;
2912
2913         yaffs_BlockInfo *bi;
2914
2915         if (dev->nErasedBlocks < 1) {
2916                 /* Hoosterman we've got a problem.
2917                  * Can't get space to gc
2918                  */
2919                 T(YAFFS_TRACE_ERROR,
2920                   (TSTR("yaffs tragedy: no more erased blocks" TENDSTR)));
2921
2922                 return -1;
2923         }
2924
2925         /* Find an empty block. */
2926
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;
2932                 }
2933
2934                 bi = yaffs_GetBlockInfo(dev, dev->allocationBlockFinder);
2935
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;
2946                 }
2947         }
2948
2949         T(YAFFS_TRACE_ALWAYS,
2950           (TSTR
2951            ("yaffs tragedy: no more erased blocks, but there should have been %d"
2952             TENDSTR), dev->nErasedBlocks));
2953
2954         return -1;
2955 }
2956
2957
2958
2959 static int yaffs_CalcCheckpointBlocksRequired(yaffs_Device *dev)
2960 {
2961         if (!dev->nCheckpointBlocksRequired &&
2962            dev->param.isYaffs2) {
2963                 /* Not a valid value so recalculate */
2964                 int nBytes = 0;
2965                 int nBlocks;
2966                 int devBlocks = (dev->param.endBlock - dev->param.startBlock + 1);
2967                 int tnodeSize = yaffs_CalcTnodeSize(dev);
2968
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*/
2977
2978                 /* Round up and add 2 blocks to allow for some bad blocks, so add 3 */
2979
2980                 nBlocks = (nBytes/(dev->nDataBytesPerChunk * dev->param.nChunksPerBlock)) + 3;
2981
2982                 dev->nCheckpointBlocksRequired = nBlocks;
2983         }
2984
2985         return dev->nCheckpointBlocksRequired;
2986 }
2987
2988 /*
2989  * Check if there's space to allocate...
2990  * Thinks.... do we need top make this ths same as yaffs_GetFreeChunks()?
2991  */
2992 static int yaffs_CheckSpaceForAllocation(yaffs_Device *dev, int nChunks)
2993 {
2994         int reservedChunks;
2995         int reservedBlocks = dev->param.nReservedBlocks;
2996         int checkpointBlocks;
2997
2998         if (dev->param.isYaffs2) {
2999                 checkpointBlocks =  yaffs_CalcCheckpointBlocksRequired(dev) -
3000                                     dev->blocksInCheckpoint;
3001                 if (checkpointBlocks < 0)
3002                         checkpointBlocks = 0;
3003         } else {
3004                 checkpointBlocks = 0;
3005         }
3006
3007         reservedChunks = ((reservedBlocks + checkpointBlocks) * dev->param.nChunksPerBlock);
3008
3009         return (dev->nFreeChunks > (reservedChunks + nChunks));
3010 }
3011
3012 static int yaffs_AllocateChunk(yaffs_Device *dev, int useReserve,
3013                 yaffs_BlockInfo **blockUsedPtr)
3014 {
3015         int retVal;
3016         yaffs_BlockInfo *bi;
3017
3018         if (dev->allocationBlock < 0) {
3019                 /* Get next block to allocate off */
3020                 dev->allocationBlock = yaffs_FindBlockForAllocation(dev);
3021                 dev->allocationPage = 0;
3022         }
3023
3024         if (!useReserve && !yaffs_CheckSpaceForAllocation(dev, 1)) {
3025                 /* Not enough space to allocate unless we're allowed to use the reserve. */
3026                 return -1;
3027         }
3028
3029         if (dev->nErasedBlocks < dev->param.nReservedBlocks
3030                         && dev->allocationPage == 0) {
3031                 T(YAFFS_TRACE_ALLOCATE, (TSTR("Allocating reserve" TENDSTR)));
3032         }
3033
3034         /* Next page please.... */
3035         if (dev->allocationBlock >= 0) {
3036                 bi = yaffs_GetBlockInfo(dev, dev->allocationBlock);
3037
3038                 retVal = (dev->allocationBlock * dev->param.nChunksPerBlock) +
3039                         dev->allocationPage;
3040                 bi->pagesInUse++;
3041                 yaffs_SetChunkBit(dev, dev->allocationBlock,
3042                                 dev->allocationPage);
3043
3044                 dev->allocationPage++;
3045
3046                 dev->nFreeChunks--;
3047
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;
3052                 }
3053
3054                 if (blockUsedPtr)
3055                         *blockUsedPtr = bi;
3056
3057                 return retVal;
3058         }
3059
3060         T(YAFFS_TRACE_ERROR,
3061                         (TSTR("!!!!!!!!! Allocator out !!!!!!!!!!!!!!!!!" TENDSTR)));
3062
3063         return -1;
3064 }
3065
3066 static int yaffs_GetErasedChunks(yaffs_Device *dev)
3067 {
3068         int n;
3069
3070         n = dev->nErasedBlocks * dev->param.nChunksPerBlock;
3071
3072         if (dev->allocationBlock > 0)
3073                 n += (dev->param.nChunksPerBlock - dev->allocationPage);
3074
3075         return n;
3076
3077 }
3078
3079 /*
3080  * yaffs_SkipRestOfBlock() skips over the rest of the allocation block
3081  * if we don't want to write to it.
3082  */
3083 static void yaffs_SkipRestOfBlock(yaffs_Device *dev)
3084 {
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;
3090                 }
3091         }
3092 }
3093
3094
3095 static int yaffs_GarbageCollectBlock(yaffs_Device *dev, int block,
3096                 int wholeBlock)
3097 {
3098         int oldChunk;
3099         int newChunk;
3100         int markNAND;
3101         int retVal = YAFFS_OK;
3102         int cleanups = 0;
3103         int i;
3104         int isCheckpointBlock;
3105         int matchingChunk;
3106         int maxCopies;
3107
3108         int chunksBefore = yaffs_GetErasedChunks(dev);
3109         int chunksAfter;
3110
3111         yaffs_ExtendedTags tags;
3112
3113         yaffs_BlockInfo *bi = yaffs_GetBlockInfo(dev, block);
3114
3115         yaffs_Object *object;
3116
3117         isCheckpointBlock = (bi->blockState == YAFFS_BLOCK_STATE_CHECKPOINT);
3118
3119
3120         T(YAFFS_TRACE_TRACING,
3121                         (TSTR("Collecting block %d, in use %d, shrink %d, wholeBlock %d" TENDSTR),
3122                          block,
3123                          bi->pagesInUse,
3124                          bi->hasShrinkHeader,
3125                          wholeBlock));
3126
3127         /*yaffs_VerifyFreeChunks(dev); */
3128
3129         if(bi->blockState == YAFFS_BLOCK_STATE_FULL)
3130                 bi->blockState = YAFFS_BLOCK_STATE_COLLECTING;
3131
3132         bi->hasShrinkHeader = 0;        /* clear the flag so that the block can erase */
3133
3134         dev->gcDisable = 1;
3135
3136         if (isCheckpointBlock ||
3137                         !yaffs_StillSomeChunkBits(dev, block)) {
3138                 T(YAFFS_TRACE_TRACING,
3139                                 (TSTR
3140                                  ("Collecting block %d that has no chunks in use" TENDSTR),
3141                                  block));
3142                 yaffs_BlockBecameDirty(dev, block);
3143         } else {
3144
3145                 __u8 *buffer = yaffs_GetTempBuffer(dev, __LINE__);
3146
3147                 yaffs_VerifyBlock(dev, bi, block);
3148
3149                 maxCopies = (wholeBlock) ? dev->param.nChunksPerBlock : 5;
3150                 oldChunk = block * dev->param.nChunksPerBlock + dev->gcChunk;
3151
3152                 for (/* init already done */;
3153                      retVal == YAFFS_OK &&
3154                      dev->gcChunk < dev->param.nChunksPerBlock &&
3155                      (bi->blockState == YAFFS_BLOCK_STATE_COLLECTING) &&
3156                      maxCopies > 0;
3157                      dev->gcChunk++, oldChunk++) {
3158                         if (yaffs_CheckChunkBit(dev, block, dev->gcChunk)) {
3159
3160                                 /* This page is in use and might need to be copied off */
3161
3162                                 maxCopies--;
3163
3164                                 markNAND = 1;
3165
3166                                 yaffs_InitialiseTags(&tags);
3167
3168                                 yaffs_ReadChunkWithTagsFromNAND(dev, oldChunk,
3169                                                                 buffer, &tags);
3170
3171                                 object =
3172                                     yaffs_FindObjectByNumber(dev,
3173                                                              tags.objectId);
3174
3175                                 T(YAFFS_TRACE_GC_DETAIL,
3176                                   (TSTR
3177                                    ("Collecting chunk in block %d, %d %d %d " TENDSTR),
3178                                    dev->gcChunk, tags.objectId, tags.chunkId,
3179                                    tags.byteCount));
3180
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 */
3186                                         else
3187                                                 matchingChunk = yaffs_FindChunkInFile(object, tags.chunkId, NULL);
3188
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));
3193
3194                                 }
3195
3196                                 if (!object) {
3197                                         T(YAFFS_TRACE_ERROR,
3198                                           (TSTR
3199                                            ("page %d in gc has no object: %d %d %d "
3200                                             TENDSTR), oldChunk,
3201                                             tags.objectId, tags.chunkId, tags.byteCount));
3202                                 }
3203
3204                                 if (object &&
3205                                     object->deleted &&
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.
3212                                          */
3213
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.
3218                                          */
3219                                         dev->nFreeChunks--;
3220
3221                                         object->nDataChunks--;
3222
3223                                         if (object->nDataChunks <= 0) {
3224                                                 /* remeber to clean up the object */
3225                                                 dev->gcCleanupList[cleanups] =
3226                                                     tags.objectId;
3227                                                 cleanups++;
3228                                         }
3229                                         markNAND = 0;
3230                                 } else if (0) {
3231                                         /* Todo object && object->deleted && object->nDataChunks == 0 */
3232                                         /* Deleted object header with no data chunks.
3233                                          * Can be discarded and the file deleted.
3234                                          */
3235                                         object->hdrChunk = 0;
3236                                         yaffs_FreeTnode(object->myDev,
3237                                                         object->variant.
3238                                                         fileVariant.top);
3239                                         object->variant.fileVariant.top = NULL;
3240                                         yaffs_DoGenericObjectDeletion(object);
3241
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
3247                                          */
3248                                         tags.serialNumber++;
3249
3250                                         dev->nGCCopies++;
3251
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.
3258                                                  */
3259
3260                                                 yaffs_ObjectHeader *oh;
3261                                                 oh = (yaffs_ObjectHeader *)buffer;
3262
3263                                                 oh->isShrink = 0;
3264                                                 tags.extraIsShrinkHeader = 0;
3265
3266                                                 oh->shadowsObject = 0;
3267                                                 oh->inbandShadowsObject = 0;
3268                                                 tags.extraShadows = 0;
3269
3270                                                 /* Update file size */
3271                                                 if(object->variantType == YAFFS_OBJECT_TYPE_FILE){
3272                                                         oh->fileSize = object->variant.fileVariant.fileSize;
3273                                                         tags.extraFileLength = oh->fileSize;
3274                                                 }
3275
3276                                                 yaffs_VerifyObjectHeader(object, oh, &tags, 1);
3277                                                 newChunk =
3278                                                     yaffs_WriteNewChunkWithTagsToNAND(dev,(__u8 *) oh, &tags, 1);
3279                                         } else
3280                                                 newChunk =
3281                                                     yaffs_WriteNewChunkWithTagsToNAND(dev, buffer, &tags, 1);
3282
3283                                         if (newChunk < 0) {
3284                                                 retVal = YAFFS_FAIL;
3285                                         } else {
3286
3287                                                 /* Ok, now fix up the Tnodes etc. */
3288
3289                                                 if (tags.chunkId == 0) {
3290                                                         /* It's a header */
3291                                                         object->hdrChunk =  newChunk;
3292                                                         object->serial =   tags.serialNumber;
3293                                                 } else {
3294                                                         /* It's a data chunk */
3295                                                         int ok;
3296                                                         ok = yaffs_PutChunkIntoFile
3297                                                             (object,
3298                                                              tags.chunkId,
3299                                                              newChunk, 0);
3300                                                 }
3301                                         }
3302                                 }
3303
3304                                 if (retVal == YAFFS_OK)
3305                                         yaffs_DeleteChunk(dev, oldChunk, markNAND, __LINE__);
3306
3307                         }
3308                 }
3309
3310                 yaffs_ReleaseTempBuffer(dev, buffer, __LINE__);
3311
3312
3313                 /* Do any required cleanups */
3314                 for (i = 0; i < cleanups; i++) {
3315                         /* Time to delete the file too */
3316                         object =
3317                             yaffs_FindObjectByNumber(dev,
3318                                                      dev->gcCleanupList[i]);
3319                         if (object) {
3320                                 yaffs_FreeTnode(dev,
3321                                                 object->variant.fileVariant.
3322                                                 top);
3323                                 object->variant.fileVariant.top = NULL;
3324                                 T(YAFFS_TRACE_GC,
3325                                   (TSTR
3326                                    ("yaffs: About to finally delete object %d"
3327                                     TENDSTR), object->objectId));
3328                                 yaffs_DoGenericObjectDeletion(object);
3329                                 object->myDev->nDeletedFiles--;
3330                         }
3331
3332                 }
3333
3334         }
3335
3336         yaffs_VerifyCollectedBlock(dev, bi, block);
3337
3338
3339
3340         if (bi->blockState == YAFFS_BLOCK_STATE_COLLECTING) {
3341                 /*
3342                  * The gc did not complete. Set block state back to FULL
3343                  * because checkpointing does not restore gc.
3344                  */
3345                 bi->blockState = YAFFS_BLOCK_STATE_FULL;
3346         } else {
3347                 /* The gc completed. */
3348                 chunksAfter = yaffs_GetErasedChunks(dev);
3349                 if (chunksBefore >= chunksAfter) {
3350                         T(YAFFS_TRACE_GC,
3351                           (TSTR
3352                            ("gc did not increase free chunks before %d after %d"
3353                             TENDSTR), chunksBefore, chunksAfter));
3354                 }
3355                 dev->gcBlock = 0;
3356                 dev->gcChunk = 0;
3357         }
3358