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.66 2008-11-26 20:46:47 charles Exp $";
  16
  17 #include "yportenv.h"
  18
  19 #include "yaffsinterface.h"
  20 #include "yaffs_guts.h"
  21 #include "yaffs_tagsvalidity.h"
  22 #include "yaffs_getblockinfo.h"
  23
  24 #include "yaffs_tagscompat.h"
  25 #ifndef  CONFIG_YAFFS_USE_OWN_SORT
  26 #include "yaffs_qsort.h"
  27 #endif
  28 #include "yaffs_nand.h"
  29
  30 #include "yaffs_checkptrw.h"
  31
  32 #include "yaffs_nand.h"
  33 #include "yaffs_packedtags2.h"
  34
  35
  36 #ifdef CONFIG_YAFFS_WINCE
  37 void yfsd_LockYAFFS(BOOL fsLockOnly);
  38 void yfsd_UnlockYAFFS(BOOL fsLockOnly);
  39 #endif
  40
  41 #define YAFFS_PASSIVE_GC_CHUNKS 2
  42
  43 #include "yaffs_ecc.h"
  44
  45
  46 /* Robustification (if it ever comes about...) */
  47 static void yaffs_RetireBlock(yaffs_Device * dev, int blockInNAND);
  48 static void yaffs_HandleWriteChunkError(yaffs_Device * dev, int chunkInNAND, 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 int yaffs_UnlinkObject( yaffs_Object *obj);
  57 static int yaffs_ObjectHasCachedWriteData(yaffs_Object *obj);
  58
  59 static void yaffs_HardlinkFixup(yaffs_Device *dev, yaffs_Object *hardList);
  60
  61 static int yaffs_WriteNewChunkWithTagsToNAND(yaffs_Device * dev,
  62                                              const __u8 * buffer,
  63                                              yaffs_ExtendedTags * tags,
  64                                              int useReserve);
  65 static int yaffs_PutChunkIntoFile(yaffs_Object * in, int chunkInInode,
  66                                   int chunkInNAND, int inScan);
  67
  68 static yaffs_Object *yaffs_CreateNewObject(yaffs_Device * dev, int number,
  69                                            yaffs_ObjectType type);
  70 static void yaffs_AddObjectToDirectory(yaffs_Object * directory,
  71                                        yaffs_Object * obj);
  72 static int yaffs_UpdateObjectHeader(yaffs_Object * in, const YCHAR * name,
  73                                     int force, int isShrink, int shadows);
  74 static void yaffs_RemoveObjectFromDirectory(yaffs_Object * obj);
  75 static int yaffs_CheckStructures(void);
  76 static int yaffs_DeleteWorker(yaffs_Object * in, yaffs_Tnode * tn, __u32 level,
  77                               int chunkOffset, int *limit);
  78 static int yaffs_DoGenericObjectDeletion(yaffs_Object * in);
  79
  80 static yaffs_BlockInfo *yaffs_GetBlockInfo(yaffs_Device * dev, int blockNo);
  81
  82
  83 static int yaffs_CheckChunkErased(struct yaffs_DeviceStruct *dev,
  84                                   int chunkInNAND);
  85
  86 static int yaffs_UnlinkWorker(yaffs_Object * obj);
  87 static void yaffs_DestroyObject(yaffs_Object * obj);
  88
  89 static int yaffs_TagsMatch(const yaffs_ExtendedTags * tags, int objectId,
  90                            int chunkInObject);
  91
  92 loff_t yaffs_GetFileSize(yaffs_Object * obj);
  93
  94 static int yaffs_AllocateChunk(yaffs_Device * dev, int useReserve, yaffs_BlockInfo **blockUsedPtr);
  95
  96 static void yaffs_VerifyFreeChunks(yaffs_Device * dev);
  97
  98 static void yaffs_CheckObjectDetailsLoaded(yaffs_Object *in);
  99
 100 static void yaffs_VerifyDirectory(yaffs_Object *directory);
 101 #ifdef YAFFS_PARANOID
 102 static int yaffs_CheckFileSanity(yaffs_Object * in);
 103 #else
 104 #define yaffs_CheckFileSanity(in)
 105 #endif
 106
 107 static void yaffs_InvalidateWholeChunkCache(yaffs_Object * in);
 108 static void yaffs_InvalidateChunkCache(yaffs_Object * object, int chunkId);
 109
 110 static void yaffs_InvalidateCheckpoint(yaffs_Device *dev);
 111
 112 static int yaffs_FindChunkInFile(yaffs_Object * in, int chunkInInode,
 113                                  yaffs_ExtendedTags * tags);
 114
 115 static __u32 yaffs_GetChunkGroupBase(yaffs_Device *dev, yaffs_Tnode *tn, unsigned pos);
 116 static yaffs_Tnode *yaffs_FindLevel0Tnode(yaffs_Device * dev,
 117                                           yaffs_FileStructure * fStruct,
 118                                           __u32 chunkId);
 119
 120
 121 /* Function to calculate chunk and offset */
 122
 123 static void yaffs_AddrToChunk(yaffs_Device *dev, loff_t addr, int *chunkOut, __u32 *offsetOut)
 124 {
 125         int chunk;
 126         __u32 offset;
 127
 128         chunk  = (__u32)(addr >> dev->chunkShift);
 129
 130         if(dev->chunkDiv == 1)
 131         {
 132                 /* easy power of 2 case */
 133                 offset = (__u32)(addr & dev->chunkMask);
 134         }
 135         else
 136         {
 137                 /* Non power-of-2 case */
 138
 139                 loff_t chunkBase;
 140
 141                 chunk /= dev->chunkDiv;
 142
 143                 chunkBase = ((loff_t)chunk) * dev->nDataBytesPerChunk;
 144                 offset = (__u32)(addr - chunkBase);
 145         }
 146
 147         *chunkOut = chunk;
 148         *offsetOut = offset;
 149 }
 150
 151 /* Function to return the number of shifts for a power of 2 greater than or equal
 152  * to the given number
 153  * Note we don't try to cater for all possible numbers and this does not have to
 154  * be hellishly efficient.
 155  */
 156
 157 static __u32 ShiftsGE(__u32 x)
 158 {
 159         int extraBits;
 160         int nShifts;
 161
 162         nShifts = extraBits = 0;
 163
 164         while(x>1){
 165                 if(x & 1) extraBits++;
 166                 x>>=1;
 167                 nShifts++;
 168         }
 169
 170         if(extraBits)
 171                 nShifts++;
 172
 173         return nShifts;
 174 }
 175
 176 /* Function to return the number of shifts to get a 1 in bit 0
 177  */
 178
 179 static __u32 Shifts(__u32 x)
 180 {
 181         int nShifts;
 182
 183         nShifts =  0;
 184
 185         if(!x) return 0;
 186
 187         while( !(x&1)){
 188                 x>>=1;
 189                 nShifts++;
 190         }
 191
 192         return nShifts;
 193 }
 194
 195
 196
 197 /*
 198  * Temporary buffer manipulations.
 199  */
 200
 201 static int yaffs_InitialiseTempBuffers(yaffs_Device *dev)
 202 {
 203         int i;
 204         __u8 *buf = (__u8 *)1;
 205
 206         memset(dev->tempBuffer,0,sizeof(dev->tempBuffer));
 207
 208         for (i = 0; buf && i < YAFFS_N_TEMP_BUFFERS; i++) {
 209                 dev->tempBuffer[i].line = 0;    /* not in use */
 210                 dev->tempBuffer[i].buffer = buf =
 211                     YMALLOC_DMA(dev->totalBytesPerChunk);
 212         }
 213
 214         return buf ? YAFFS_OK : YAFFS_FAIL;
 215
 216 }
 217
 218 __u8 *yaffs_GetTempBuffer(yaffs_Device * dev, int lineNo)
 219 {
 220         int i, j;
 221
 222         dev->tempInUse++;
 223         if(dev->tempInUse > dev->maxTemp)
 224                 dev->maxTemp = dev->tempInUse;
 225
 226         for (i = 0; i < YAFFS_N_TEMP_BUFFERS; i++) {
 227                 if (dev->tempBuffer[i].line == 0) {
 228                         dev->tempBuffer[i].line = lineNo;
 229                         if ((i + 1) > dev->maxTemp) {
 230                                 dev->maxTemp = i + 1;
 231                                 for (j = 0; j <= i; j++)
 232                                         dev->tempBuffer[j].maxLine =
 233                                             dev->tempBuffer[j].line;
 234                         }
 235
 236                         return dev->tempBuffer[i].buffer;
 237                 }
 238         }
 239
 240         T(YAFFS_TRACE_BUFFERS,
 241           (TSTR("Out of temp buffers at line %d, other held by lines:"),
 242            lineNo));
 243         for (i = 0; i < YAFFS_N_TEMP_BUFFERS; i++) {
 244                 T(YAFFS_TRACE_BUFFERS, (TSTR(" %d "), dev->tempBuffer[i].line));
 245         }
 246         T(YAFFS_TRACE_BUFFERS, (TSTR(" " TENDSTR)));
 247
 248         /*
 249          * If we got here then we have to allocate an unmanaged one
 250          * This is not good.
 251          */
 252
 253         dev->unmanagedTempAllocations++;
 254         return YMALLOC(dev->nDataBytesPerChunk);
 255
 256 }
 257
 258 void yaffs_ReleaseTempBuffer(yaffs_Device * dev, __u8 * buffer,
 259                                     int lineNo)
 260 {
 261         int i;
 262
 263         dev->tempInUse--;
 264
 265         for (i = 0; i < YAFFS_N_TEMP_BUFFERS; i++) {
 266                 if (dev->tempBuffer[i].buffer == buffer) {
 267                         dev->tempBuffer[i].line = 0;
 268                         return;
 269                 }
 270         }
 271
 272         if (buffer) {
 273                 /* assume it is an unmanaged one. */
 274                 T(YAFFS_TRACE_BUFFERS,
 275                   (TSTR("Releasing unmanaged temp buffer in line %d" TENDSTR),
 276                    lineNo));
 277                 YFREE(buffer);
 278                 dev->unmanagedTempDeallocations++;
 279         }
 280
 281 }
 282
 283 /*
 284  * Determine if we have a managed buffer.
 285  */
 286 int yaffs_IsManagedTempBuffer(yaffs_Device * dev, const __u8 * buffer)
 287 {
 288         int i;
 289         for (i = 0; i < YAFFS_N_TEMP_BUFFERS; i++) {
 290                 if (dev->tempBuffer[i].buffer == buffer)
 291                         return 1;
 292
 293         }
 294
 295     for (i = 0; i < dev->nShortOpCaches; i++) {
 296         if( dev->srCache[i].data == buffer )
 297             return 1;
 298
 299     }
 300
 301     if (buffer == dev->checkpointBuffer)
 302       return 1;
 303
 304     T(YAFFS_TRACE_ALWAYS,
 305           (TSTR("yaffs: unmaged buffer detected.\n" TENDSTR)));
 306     return 0;
 307 }
 308
 309
 310
 311 /*
 312  * Chunk bitmap manipulations
 313  */
 314
 315 static Y_INLINE __u8 *yaffs_BlockBits(yaffs_Device * dev, int blk)
 316 {
 317         if (blk < dev->internalStartBlock || blk > dev->internalEndBlock) {
 318                 T(YAFFS_TRACE_ERROR,
 319                   (TSTR("**>> yaffs: BlockBits block %d is not valid" TENDSTR),
 320                    blk));
 321                 YBUG();
 322         }
 323         return dev->chunkBits +
 324             (dev->chunkBitmapStride * (blk - dev->internalStartBlock));
 325 }
 326
 327 static Y_INLINE void yaffs_VerifyChunkBitId(yaffs_Device *dev, int blk, int chunk)
 328 {
 329         if(blk < dev->internalStartBlock || blk > dev->internalEndBlock ||
 330            chunk < 0 || chunk >= dev->nChunksPerBlock) {
 331            T(YAFFS_TRACE_ERROR,
 332             (TSTR("**>> yaffs: Chunk Id (%d:%d) invalid"TENDSTR),blk,chunk));
 333             YBUG();
 334         }
 335 }
 336
 337 static Y_INLINE void yaffs_ClearChunkBits(yaffs_Device * dev, int blk)
 338 {
 339         __u8 *blkBits = yaffs_BlockBits(dev, blk);
 340
 341         memset(blkBits, 0, dev->chunkBitmapStride);
 342 }
 343
 344 static Y_INLINE void yaffs_ClearChunkBit(yaffs_Device * dev, int blk, int chunk)
 345 {
 346         __u8 *blkBits = yaffs_BlockBits(dev, blk);
 347
 348         yaffs_VerifyChunkBitId(dev,blk,chunk);
 349
 350         blkBits[chunk / 8] &= ~(1 << (chunk & 7));
 351 }
 352
 353 static Y_INLINE void yaffs_SetChunkBit(yaffs_Device * dev, int blk, int chunk)
 354 {
 355         __u8 *blkBits = yaffs_BlockBits(dev, blk);
 356
 357         yaffs_VerifyChunkBitId(dev,blk,chunk);
 358
 359         blkBits[chunk / 8] |= (1 << (chunk & 7));
 360 }
 361
 362 static Y_INLINE int yaffs_CheckChunkBit(yaffs_Device * dev, int blk, int chunk)
 363 {
 364         __u8 *blkBits = yaffs_BlockBits(dev, blk);
 365         yaffs_VerifyChunkBitId(dev,blk,chunk);
 366
 367         return (blkBits[chunk / 8] & (1 << (chunk & 7))) ? 1 : 0;
 368 }
 369
 370 static Y_INLINE int yaffs_StillSomeChunkBits(yaffs_Device * dev, int blk)
 371 {
 372         __u8 *blkBits = yaffs_BlockBits(dev, blk);
 373         int i;
 374         for (i = 0; i < dev->chunkBitmapStride; i++) {
 375                 if (*blkBits)
 376                         return 1;
 377                 blkBits++;
 378         }
 379         return 0;
 380 }
 381
 382 static int yaffs_CountChunkBits(yaffs_Device * dev, int blk)
 383 {
 384         __u8 *blkBits = yaffs_BlockBits(dev, blk);
 385         int i;
 386         int n = 0;
 387         for (i = 0; i < dev->chunkBitmapStride; i++) {
 388                 __u8 x = *blkBits;
 389                 while(x){
 390                         if(x & 1)
 391                                 n++;
 392                         x >>=1;
 393                 }
 394
 395                 blkBits++;
 396         }
 397         return n;
 398 }
 399
 400 /*
 401  * Verification code
 402  */
 403
 404 static int yaffs_SkipVerification(yaffs_Device *dev)
 405 {
 406         return !(yaffs_traceMask & (YAFFS_TRACE_VERIFY | YAFFS_TRACE_VERIFY_FULL));
 407 }
 408
 409 #if 0
 410 static int yaffs_SkipFullVerification(yaffs_Device *dev)
 411 {
 412         return !(yaffs_traceMask & (YAFFS_TRACE_VERIFY_FULL));
 413 }
 414
 415 #endif
 416
 417 static int yaffs_SkipNANDVerification(yaffs_Device *dev)
 418 {
 419         return !(yaffs_traceMask & (YAFFS_TRACE_VERIFY_NAND));
 420 }
 421
 422 static const char * blockStateName[] = {
 423 "Unknown",
 424 "Needs scanning",
 425 "Scanning",
 426 "Empty",
 427 "Allocating",
 428 "Full",
 429 "Dirty",
 430 "Checkpoint",
 431 "Collecting",
 432 "Dead"
 433 };
 434
 435 static void yaffs_VerifyBlock(yaffs_Device *dev,yaffs_BlockInfo *bi,int n)
 436 {
 437         int actuallyUsed;
 438         int inUse;
 439
 440         if(yaffs_SkipVerification(dev))
 441                 return;
 442
 443         /* Report illegal runtime states */
 444         if(bi->blockState >= YAFFS_NUMBER_OF_BLOCK_STATES)
 445                 T(YAFFS_TRACE_VERIFY,(TSTR("Block %d has undefined state %d"TENDSTR),n,bi->blockState));
 446
 447         switch(bi->blockState){
 448          case YAFFS_BLOCK_STATE_UNKNOWN:
 449          case YAFFS_BLOCK_STATE_SCANNING:
 450          case YAFFS_BLOCK_STATE_NEEDS_SCANNING:
 451                 T(YAFFS_TRACE_VERIFY,(TSTR("Block %d has bad run-state %s"TENDSTR),
 452                 n,blockStateName[bi->blockState]));
 453         }
 454
 455         /* Check pages in use and soft deletions are legal */
 456
 457         actuallyUsed = bi->pagesInUse - bi->softDeletions;
 458
 459         if(bi->pagesInUse < 0 || bi->pagesInUse > dev->nChunksPerBlock ||
 460            bi->softDeletions < 0 || bi->softDeletions > dev->nChunksPerBlock ||
 461            actuallyUsed < 0 || actuallyUsed > dev->nChunksPerBlock)
 462                 T(YAFFS_TRACE_VERIFY,(TSTR("Block %d has illegal values pagesInUsed %d softDeletions %d"TENDSTR),
 463                 n,bi->pagesInUse,bi->softDeletions));
 464
 465
 466         /* Check chunk bitmap legal */
 467         inUse = yaffs_CountChunkBits(dev,n);
 468         if(inUse != bi->pagesInUse)
 469                 T(YAFFS_TRACE_VERIFY,(TSTR("Block %d has inconsistent values pagesInUse %d counted chunk bits %d"TENDSTR),
 470                         n,bi->pagesInUse,inUse));
 471
 472         /* Check that the sequence number is valid.
 473          * Ten million is legal, but is very unlikely
 474          */
 475         if(dev->isYaffs2 &&
 476            (bi->blockState == YAFFS_BLOCK_STATE_ALLOCATING || bi->blockState == YAFFS_BLOCK_STATE_FULL) &&
 477            (bi->sequenceNumber < YAFFS_LOWEST_SEQUENCE_NUMBER || bi->sequenceNumber > 10000000 ))
 478                 T(YAFFS_TRACE_VERIFY,(TSTR("Block %d has suspect sequence number of %d"TENDSTR),
 479                 n,bi->sequenceNumber));
 480
 481 }
 482
 483 static void yaffs_VerifyCollectedBlock(yaffs_Device *dev,yaffs_BlockInfo *bi,int n)
 484 {
 485         yaffs_VerifyBlock(dev,bi,n);
 486
 487         /* After collection the block should be in the erased state */
 488         /* TODO: This will need to change if we do partial gc */
 489
 490         if(bi->blockState != YAFFS_BLOCK_STATE_EMPTY){
 491                 T(YAFFS_TRACE_ERROR,(TSTR("Block %d is in state %d after gc, should be erased"TENDSTR),
 492                         n,bi->blockState));
 493         }
 494 }
 495
 496 static void yaffs_VerifyBlocks(yaffs_Device *dev)
 497 {
 498         int i;
 499         int nBlocksPerState[YAFFS_NUMBER_OF_BLOCK_STATES];
 500         int nIllegalBlockStates = 0;
 501
 502
 503         if(yaffs_SkipVerification(dev))
 504                 return;
 505
 506         memset(nBlocksPerState,0,sizeof(nBlocksPerState));
 507
 508
 509         for(i = dev->internalStartBlock; i <= dev->internalEndBlock; i++){
 510                 yaffs_BlockInfo *bi = yaffs_GetBlockInfo(dev,i);
 511                 yaffs_VerifyBlock(dev,bi,i);
 512
 513                 if(bi->blockState < YAFFS_NUMBER_OF_BLOCK_STATES)
 514                         nBlocksPerState[bi->blockState]++;
 515                 else
 516                         nIllegalBlockStates++;
 517
 518         }
 519
 520         T(YAFFS_TRACE_VERIFY,(TSTR(""TENDSTR)));
 521         T(YAFFS_TRACE_VERIFY,(TSTR("Block summary"TENDSTR)));
 522
 523         T(YAFFS_TRACE_VERIFY,(TSTR("%d blocks have illegal states"TENDSTR),nIllegalBlockStates));
 524         if(nBlocksPerState[YAFFS_BLOCK_STATE_ALLOCATING] > 1)
 525                 T(YAFFS_TRACE_VERIFY,(TSTR("Too many allocating blocks"TENDSTR)));
 526
 527         for(i = 0; i < YAFFS_NUMBER_OF_BLOCK_STATES; i++)
 528                 T(YAFFS_TRACE_VERIFY,
 529                   (TSTR("%s %d blocks"TENDSTR),
 530                   blockStateName[i],nBlocksPerState[i]));
 531
 532         if(dev->blocksInCheckpoint != nBlocksPerState[YAFFS_BLOCK_STATE_CHECKPOINT])
 533                 T(YAFFS_TRACE_VERIFY,
 534                  (TSTR("Checkpoint block count wrong dev %d count %d"TENDSTR),
 535                  dev->blocksInCheckpoint, nBlocksPerState[YAFFS_BLOCK_STATE_CHECKPOINT]));
 536
 537         if(dev->nErasedBlocks != nBlocksPerState[YAFFS_BLOCK_STATE_EMPTY])
 538                 T(YAFFS_TRACE_VERIFY,
 539                  (TSTR("Erased block count wrong dev %d count %d"TENDSTR),
 540                  dev->nErasedBlocks, nBlocksPerState[YAFFS_BLOCK_STATE_EMPTY]));
 541
 542         if(nBlocksPerState[YAFFS_BLOCK_STATE_COLLECTING] > 1)
 543                 T(YAFFS_TRACE_VERIFY,
 544                  (TSTR("Too many collecting blocks %d (max is 1)"TENDSTR),
 545                  nBlocksPerState[YAFFS_BLOCK_STATE_COLLECTING]));
 546
 547         T(YAFFS_TRACE_VERIFY,(TSTR(""TENDSTR)));
 548
 549 }
 550
 551 /*
 552  * Verify the object header. oh must be valid, but obj and tags may be NULL in which
 553  * case those tests will not be performed.
 554  */
 555 static void yaffs_VerifyObjectHeader(yaffs_Object *obj, yaffs_ObjectHeader *oh, yaffs_ExtendedTags *tags, int parentCheck)
 556 {
 557         if(obj && yaffs_SkipVerification(obj->myDev))
 558                 return;
 559
 560         if(!(tags && obj && oh)){
 561                 T(YAFFS_TRACE_VERIFY,
 562                                 (TSTR("Verifying object header tags %x obj %x oh %x"TENDSTR),
 563                                 (__u32)tags,(__u32)obj,(__u32)oh));
 564                 return;
 565         }
 566
 567         if(oh->type <= YAFFS_OBJECT_TYPE_UNKNOWN ||
 568            oh->type > YAFFS_OBJECT_TYPE_MAX)
 569                 T(YAFFS_TRACE_VERIFY,
 570                  (TSTR("Obj %d header type is illegal value 0x%x"TENDSTR),
 571                  tags->objectId, oh->type));
 572
 573         if(tags->objectId != obj->objectId)
 574                 T(YAFFS_TRACE_VERIFY,
 575                  (TSTR("Obj %d header mismatch objectId %d"TENDSTR),
 576                  tags->objectId, obj->objectId));
 577
 578
 579         /*
 580          * Check that the object's parent ids match if parentCheck requested.
 581          *
 582          * Tests do not apply to the root object.
 583          */
 584
 585         if(parentCheck && tags->objectId > 1 && !obj->parent)
 586                 T(YAFFS_TRACE_VERIFY,
 587                  (TSTR("Obj %d header mismatch parentId %d obj->parent is NULL"TENDSTR),
 588                  tags->objectId, oh->parentObjectId));
 589
 590
 591         if(parentCheck && obj->parent &&
 592            oh->parentObjectId != obj->parent->objectId &&
 593            (oh->parentObjectId != YAFFS_OBJECTID_UNLINKED ||
 594             obj->parent->objectId != YAFFS_OBJECTID_DELETED))
 595                 T(YAFFS_TRACE_VERIFY,
 596                  (TSTR("Obj %d header mismatch parentId %d parentObjectId %d"TENDSTR),
 597                  tags->objectId, oh->parentObjectId, obj->parent->objectId));
 598
 599
 600         if(tags->objectId > 1 && oh->name[0] == 0) /* Null name */
 601                 T(YAFFS_TRACE_VERIFY,
 602                 (TSTR("Obj %d header name is NULL"TENDSTR),
 603                  obj->objectId));
 604
 605         if(tags->objectId > 1 && ((__u8)(oh->name[0])) == 0xff) /* Trashed name */
 606                 T(YAFFS_TRACE_VERIFY,
 607                 (TSTR("Obj %d header name is 0xFF"TENDSTR),
 608                  obj->objectId));
 609 }
 610
 611
 612
 613 static int yaffs_VerifyTnodeWorker(yaffs_Object * obj, yaffs_Tnode * tn,
 614                                         __u32 level, int chunkOffset)
 615 {
 616         int i;
 617         yaffs_Device *dev = obj->myDev;
 618         int ok = 1;
 619
 620         if (tn) {
 621                 if (level > 0) {
 622
 623                         for (i = 0; i < YAFFS_NTNODES_INTERNAL && ok; i++){
 624                                 if (tn->internal[i]) {
 625                                         ok = yaffs_VerifyTnodeWorker(obj,
 626                                                         tn->internal[i],
 627                                                         level - 1,
 628                                                         (chunkOffset<<YAFFS_TNODES_INTERNAL_BITS) + i);
 629                                 }
 630                         }
 631                 } else if (level == 0) {
 632                         yaffs_ExtendedTags tags;
 633                         __u32 objectId = obj->objectId;
 634
 635                         chunkOffset <<=  YAFFS_TNODES_LEVEL0_BITS;
 636
 637                         for(i = 0; i < YAFFS_NTNODES_LEVEL0; i++){
 638                                 __u32 theChunk = yaffs_GetChunkGroupBase(dev,tn,i);
 639
 640                                 if(theChunk > 0){
 641                                         /* T(~0,(TSTR("verifying (%d:%d) %d"TENDSTR),tags.objectId,tags.chunkId,theChunk)); */
 642                                         yaffs_ReadChunkWithTagsFromNAND(dev,theChunk,NULL, &tags);
 643                                         if(tags.objectId != objectId || tags.chunkId != chunkOffset){
 644                                                 T(~0,(TSTR("Object %d chunkId %d NAND mismatch chunk %d tags (%d:%d)"TENDSTR),
 645                                                         objectId, chunkOffset, theChunk,
 646                                                         tags.objectId, tags.chunkId));
 647                                         }
 648                                 }
 649                                 chunkOffset++;
 650                         }
 651                 }
 652         }
 653
 654         return ok;
 655
 656 }
 657
 658
 659 static void yaffs_VerifyFile(yaffs_Object *obj)
 660 {
 661         int requiredTallness;
 662         int actualTallness;
 663         __u32 lastChunk;
 664         __u32 x;
 665         __u32 i;
 666         yaffs_Device *dev;
 667         yaffs_ExtendedTags tags;
 668         yaffs_Tnode *tn;
 669         __u32 objectId;
 670
 671         if(!obj)
 672                 return;
 673
 674         if(yaffs_SkipVerification(obj->myDev))
 675                 return;
 676
 677         dev = obj->myDev;
 678         objectId = obj->objectId;
 679
 680         /* Check file size is consistent with tnode depth */
 681         lastChunk =  obj->variant.fileVariant.fileSize / dev->nDataBytesPerChunk + 1;
 682         x = lastChunk >> YAFFS_TNODES_LEVEL0_BITS;
 683         requiredTallness = 0;
 684         while (x> 0) {
 685                 x >>= YAFFS_TNODES_INTERNAL_BITS;
 686                 requiredTallness++;
 687         }
 688
 689         actualTallness = obj->variant.fileVariant.topLevel;
 690
 691         if(requiredTallness > actualTallness )
 692                 T(YAFFS_TRACE_VERIFY,
 693                 (TSTR("Obj %d had tnode tallness %d, needs to be %d"TENDSTR),
 694                  obj->objectId,actualTallness, requiredTallness));
 695
 696
 697         /* Check that the chunks in the tnode tree are all correct.
 698          * We do this by scanning through the tnode tree and
 699          * checking the tags for every chunk match.
 700          */
 701
 702         if(yaffs_SkipNANDVerification(dev))
 703                 return;
 704
 705         for(i = 1; i <= lastChunk; i++){
 706                 tn = yaffs_FindLevel0Tnode(dev, &obj->variant.fileVariant,i);
 707
 708                 if (tn) {
 709                         __u32 theChunk = yaffs_GetChunkGroupBase(dev,tn,i);
 710                         if(theChunk > 0){
 711                                 /* T(~0,(TSTR("verifying (%d:%d) %d"TENDSTR),objectId,i,theChunk)); */
 712                                 yaffs_ReadChunkWithTagsFromNAND(dev,theChunk,NULL, &tags);
 713                                 if(tags.objectId != objectId || tags.chunkId != i){
 714                                         T(~0,(TSTR("Object %d chunkId %d NAND mismatch chunk %d tags (%d:%d)"TENDSTR),
 715                                                 objectId, i, theChunk,
 716                                                 tags.objectId, tags.chunkId));
 717                                 }
 718                         }
 719                 }
 720
 721         }
 722
 723 }
 724
 725
 726 static void yaffs_VerifyHardLink(yaffs_Object *obj)
 727 {
 728         if(obj && yaffs_SkipVerification(obj->myDev))
 729                 return;
 730
 731         /* Verify sane equivalent object */
 732 }
 733
 734 static void yaffs_VerifySymlink(yaffs_Object *obj)
 735 {
 736         if(obj && yaffs_SkipVerification(obj->myDev))
 737                 return;
 738
 739         /* Verify symlink string */
 740 }
 741
 742 static void yaffs_VerifySpecial(yaffs_Object *obj)
 743 {
 744         if(obj && yaffs_SkipVerification(obj->myDev))
 745                 return;
 746 }
 747
 748 static void yaffs_VerifyObject(yaffs_Object *obj)
 749 {
 750         yaffs_Device *dev;
 751
 752         __u32 chunkMin;
 753         __u32 chunkMax;
 754
 755         __u32 chunkIdOk;
 756         __u32 chunkIsLive;
 757
 758         if(!obj)
 759                 return;
 760
 761         dev = obj->myDev;
 762
 763         if(yaffs_SkipVerification(dev))
 764                 return;
 765
 766         /* Check sane object header chunk */
 767
 768         chunkMin = dev->internalStartBlock * dev->nChunksPerBlock;
 769         chunkMax = (dev->internalEndBlock+1) * dev->nChunksPerBlock - 1;
 770
 771         chunkIdOk = (((unsigned)(obj->hdrChunk)) >= chunkMin && ((unsigned)(obj->hdrChunk)) <= chunkMax);
 772         chunkIsLive = chunkIdOk &&
 773                         yaffs_CheckChunkBit(dev,
 774                                             obj->hdrChunk / dev->nChunksPerBlock,
 775                                             obj->hdrChunk % dev->nChunksPerBlock);
 776         if(!obj->fake &&
 777             (!chunkIdOk || !chunkIsLive)) {
 778            T(YAFFS_TRACE_VERIFY,
 779            (TSTR("Obj %d has chunkId %d %s %s"TENDSTR),
 780            obj->objectId,obj->hdrChunk,
 781            chunkIdOk ? "" : ",out of range",
 782            chunkIsLive || !chunkIdOk ? "" : ",marked as deleted"));
 783         }
 784
 785         if(chunkIdOk && chunkIsLive &&!yaffs_SkipNANDVerification(dev)) {
 786                 yaffs_ExtendedTags tags;
 787                 yaffs_ObjectHeader *oh;
 788                 __u8 *buffer = yaffs_GetTempBuffer(dev,__LINE__);
 789
 790                 oh = (yaffs_ObjectHeader *)buffer;
 791
 792                 yaffs_ReadChunkWithTagsFromNAND(dev, obj->hdrChunk,buffer, &tags);
 793
 794                 yaffs_VerifyObjectHeader(obj,oh,&tags,1);
 795
 796                 yaffs_ReleaseTempBuffer(dev,buffer,__LINE__);
 797         }
 798
 799         /* Verify it has a parent */
 800         if(obj && !obj->fake &&
 801            (!obj->parent || obj->parent->myDev != dev)){
 802            T(YAFFS_TRACE_VERIFY,
 803            (TSTR("Obj %d has parent pointer %p which does not look like an object"TENDSTR),
 804            obj->objectId,obj->parent));
 805         }
 806
 807         /* Verify parent is a directory */
 808         if(obj->parent && obj->parent->variantType != YAFFS_OBJECT_TYPE_DIRECTORY){
 809            T(YAFFS_TRACE_VERIFY,
 810            (TSTR("Obj %d's parent is not a directory (type %d)"TENDSTR),
 811            obj->objectId,obj->parent->variantType));
 812         }
 813
 814         switch(obj->variantType){
 815         case YAFFS_OBJECT_TYPE_FILE:
 816                 yaffs_VerifyFile(obj);
 817                 break;
 818         case YAFFS_OBJECT_TYPE_SYMLINK:
 819                 yaffs_VerifySymlink(obj);
 820                 break;
 821         case YAFFS_OBJECT_TYPE_DIRECTORY:
 822                 yaffs_VerifyDirectory(obj);
 823                 break;
 824         case YAFFS_OBJECT_TYPE_HARDLINK:
 825                 yaffs_VerifyHardLink(obj);
 826                 break;
 827         case YAFFS_OBJECT_TYPE_SPECIAL:
 828                 yaffs_VerifySpecial(obj);
 829                 break;
 830         case YAFFS_OBJECT_TYPE_UNKNOWN:
 831         default:
 832                 T(YAFFS_TRACE_VERIFY,
 833                 (TSTR("Obj %d has illegaltype %d"TENDSTR),
 834                 obj->objectId,obj->variantType));
 835                 break;
 836         }
 837
 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 /*
 865  *  Simple hash function. Needs to have a reasonable spread
 866  */
 867
 868 static Y_INLINE int yaffs_HashFunction(int n)
 869 {
 870         n = abs(n);
 871         return (n % YAFFS_NOBJECT_BUCKETS);
 872 }
 873
 874 /*
 875  * Access functions to useful fake objects.
 876  * Note that root might have a presence in NAND if permissions are set.
 877  */
 878
 879 yaffs_Object *yaffs_Root(yaffs_Device * dev)
 880 {
 881         return dev->rootDir;
 882 }
 883
 884 yaffs_Object *yaffs_LostNFound(yaffs_Device * dev)
 885 {
 886         return dev->lostNFoundDir;
 887 }
 888
 889
 890 /*
 891  *  Erased NAND checking functions
 892  */
 893
 894 int yaffs_CheckFF(__u8 * buffer, int nBytes)
 895 {
 896         /* Horrible, slow implementation */
 897         while (nBytes--) {
 898                 if (*buffer != 0xFF)
 899                         return 0;
 900                 buffer++;
 901         }
 902         return 1;
 903 }
 904
 905 static int yaffs_CheckChunkErased(struct yaffs_DeviceStruct *dev,
 906                                   int chunkInNAND)
 907 {
 908
 909         int retval = YAFFS_OK;
 910         __u8 *data = yaffs_GetTempBuffer(dev, __LINE__);
 911         yaffs_ExtendedTags tags;
 912         int result;
 913
 914         result = yaffs_ReadChunkWithTagsFromNAND(dev, chunkInNAND, data, &tags);
 915
 916         if(tags.eccResult > YAFFS_ECC_RESULT_NO_ERROR)
 917                 retval = YAFFS_FAIL;
 918
 919
 920         if (!yaffs_CheckFF(data, dev->nDataBytesPerChunk) || tags.chunkUsed) {
 921                 T(YAFFS_TRACE_NANDACCESS,
 922                   (TSTR("Chunk %d not erased" TENDSTR), chunkInNAND));
 923                 retval = YAFFS_FAIL;
 924         }
 925
 926         yaffs_ReleaseTempBuffer(dev, data, __LINE__);
 927
 928         return retval;
 929
 930 }
 931
 932 static int yaffs_WriteNewChunkWithTagsToNAND(struct yaffs_DeviceStruct *dev,
 933                                              const __u8 * data,
 934                                              yaffs_ExtendedTags * tags,
 935                                              int useReserve)
 936 {
 937         int attempts = 0;
 938         int writeOk = 0;
 939         int chunk;
 940
 941         yaffs_InvalidateCheckpoint(dev);
 942
 943         do {
 944                 yaffs_BlockInfo *bi = 0;
 945                 int erasedOk = 0;
 946
 947                 chunk = yaffs_AllocateChunk(dev, useReserve, &bi);
 948                 if (chunk < 0) {
 949                         /* no space */
 950                         break;
 951                 }
 952
 953                 /* First check this chunk is erased, if it needs
 954                  * checking.  The checking policy (unless forced
 955                  * always on) is as follows:
 956                  *
 957                  * Check the first page we try to write in a block.
 958                  * If the check passes then we don't need to check any
 959                  * more.        If the check fails, we check again...
 960                  * If the block has been erased, we don't need to check.
 961                  *
 962                  * However, if the block has been prioritised for gc,
 963                  * then we think there might be something odd about
 964                  * this block and stop using it.
 965                  *
 966                  * Rationale: We should only ever see chunks that have
 967                  * not been erased if there was a partially written
 968                  * chunk due to power loss.  This checking policy should
 969                  * catch that case with very few checks and thus save a
 970                  * lot of checks that are most likely not needed.
 971                  */
 972                 if (bi->gcPrioritise) {
 973                         yaffs_DeleteChunk(dev, chunk, 1, __LINE__);
 974                         /* try another chunk */
 975                         continue;
 976                 }
 977
 978                 /* let's give it a try */
 979                 attempts++;
 980
 981 #ifdef CONFIG_YAFFS_ALWAYS_CHECK_CHUNK_ERASED
 982                 bi->skipErasedCheck = 0;
 983 #endif
 984                 if (!bi->skipErasedCheck) {
 985                         erasedOk = yaffs_CheckChunkErased(dev, chunk);
 986                         if (erasedOk != YAFFS_OK) {
 987                                 T(YAFFS_TRACE_ERROR,
 988                                 (TSTR ("**>> yaffs chunk %d was not erased"
 989                                 TENDSTR), chunk));
 990
 991                                 /* try another chunk */
 992                                 continue;
 993                         }
 994                         bi->skipErasedCheck = 1;
 995                 }
 996
 997                 writeOk = yaffs_WriteChunkWithTagsToNAND(dev, chunk,
 998                                 data, tags);
 999                 if (writeOk != YAFFS_OK) {
1000                         yaffs_HandleWriteChunkError(dev, chunk, erasedOk);
1001                         /* try another chunk */
1002                         continue;
1003                 }
1004
1005                 /* Copy the data into the robustification buffer */
1006                 yaffs_HandleWriteChunkOk(dev, chunk, data, tags);
1007
1008         } while (writeOk != YAFFS_OK &&
1009                 (yaffs_wr_attempts <= 0 || attempts <= yaffs_wr_attempts));
1010
1011         if(!writeOk)
1012                 chunk = -1;
1013
1014         if (attempts > 1) {
1015                 T(YAFFS_TRACE_ERROR,
1016                         (TSTR("**>> yaffs write required %d attempts" TENDSTR),
1017                         attempts));
1018
1019                 dev->nRetriedWrites += (attempts - 1);
1020         }
1021
1022         return chunk;
1023 }
1024
1025 /*
1026  * Block retiring for handling a broken block.
1027  */
1028
1029 static void yaffs_RetireBlock(yaffs_Device * dev, int blockInNAND)
1030 {
1031         yaffs_BlockInfo *bi = yaffs_GetBlockInfo(dev, blockInNAND);
1032
1033         yaffs_InvalidateCheckpoint(dev);
1034
1035         yaffs_MarkBlockBad(dev, blockInNAND);
1036
1037         bi->blockState = YAFFS_BLOCK_STATE_DEAD;
1038         bi->gcPrioritise = 0;
1039         bi->needsRetiring = 0;
1040
1041         dev->nRetiredBlocks++;
1042 }
1043
1044 /*
1045  * Functions for robustisizing TODO
1046  *
1047  */
1048
1049 static void yaffs_HandleWriteChunkOk(yaffs_Device * dev, int chunkInNAND,
1050                                      const __u8 * data,
1051                                      const yaffs_ExtendedTags * tags)
1052 {
1053 }
1054
1055 static void yaffs_HandleUpdateChunk(yaffs_Device * dev, int chunkInNAND,
1056                                     const yaffs_ExtendedTags * tags)
1057 {
1058 }
1059
1060 void yaffs_HandleChunkError(yaffs_Device *dev, yaffs_BlockInfo *bi)
1061 {
1062         if(!bi->gcPrioritise){
1063                 bi->gcPrioritise = 1;
1064                 dev->hasPendingPrioritisedGCs = 1;
1065                 bi->chunkErrorStrikes ++;
1066
1067                 if(bi->chunkErrorStrikes > 3){
1068                         bi->needsRetiring = 1; /* Too many stikes, so retire this */
1069                         T(YAFFS_TRACE_ALWAYS, (TSTR("yaffs: Block struck out" TENDSTR)));
1070
1071                 }
1072
1073         }
1074 }
1075
1076 static void yaffs_HandleWriteChunkError(yaffs_Device * dev, int chunkInNAND, int erasedOk)
1077 {
1078
1079         int blockInNAND = chunkInNAND / dev->nChunksPerBlock;
1080         yaffs_BlockInfo *bi = yaffs_GetBlockInfo(dev, blockInNAND);
1081
1082         yaffs_HandleChunkError(dev,bi);
1083
1084
1085         if(erasedOk ) {
1086                 /* Was an actual write failure, so mark the block for retirement  */
1087                 bi->needsRetiring = 1;
1088                 T(YAFFS_TRACE_ERROR | YAFFS_TRACE_BAD_BLOCKS,
1089                   (TSTR("**>> Block %d needs retiring" TENDSTR), blockInNAND));
1090
1091
1092         }
1093
1094         /* Delete the chunk */
1095         yaffs_DeleteChunk(dev, chunkInNAND, 1, __LINE__);
1096 }
1097
1098
1099 /*---------------- Name handling functions ------------*/
1100
1101 static __u16 yaffs_CalcNameSum(const YCHAR * name)
1102 {
1103         __u16 sum = 0;
1104         __u16 i = 1;
1105
1106         const YUCHAR *bname = (const YUCHAR *) name;
1107         if (bname) {
1108                 while ((*bname) && (i < (YAFFS_MAX_NAME_LENGTH/2))) {
1109
1110 #ifdef CONFIG_YAFFS_CASE_INSENSITIVE
1111                         sum += yaffs_toupper(*bname) * i;
1112 #else
1113                         sum += (*bname) * i;
1114 #endif
1115                         i++;
1116                         bname++;
1117                 }
1118         }
1119
1120         return sum;
1121 }
1122
1123 static void yaffs_SetObjectName(yaffs_Object * obj, const YCHAR * name)
1124 {
1125 #ifdef CONFIG_YAFFS_SHORT_NAMES_IN_RAM
1126         memset(obj->shortName,0,sizeof (YCHAR) * (YAFFS_SHORT_NAME_LENGTH+1));
1127         if (name && yaffs_strlen(name) <= YAFFS_SHORT_NAME_LENGTH) {
1128                 yaffs_strcpy(obj->shortName, name);
1129         } else {
1130                 obj->shortName[0] = _Y('\0');
1131         }
1132 #endif
1133         obj->sum = yaffs_CalcNameSum(name);
1134 }
1135
1136 /*-------------------- TNODES -------------------
1137
1138  * List of spare tnodes
1139  * The list is hooked together using the first pointer
1140  * in the tnode.
1141  */
1142
1143 /* yaffs_CreateTnodes creates a bunch more tnodes and
1144  * adds them to the tnode free list.
1145  * Don't use this function directly
1146  */
1147
1148 static int yaffs_CreateTnodes(yaffs_Device * dev, int nTnodes)
1149 {
1150         int i;
1151         int tnodeSize;
1152         yaffs_Tnode *newTnodes;
1153         __u8 *mem;
1154         yaffs_Tnode *curr;
1155         yaffs_Tnode *next;
1156         yaffs_TnodeList *tnl;
1157
1158         if (nTnodes < 1)
1159                 return YAFFS_OK;
1160
1161         /* Calculate the tnode size in bytes for variable width tnode support.
1162          * Must be a multiple of 32-bits  */
1163         tnodeSize = (dev->tnodeWidth * YAFFS_NTNODES_LEVEL0)/8;
1164
1165         if(tnodeSize < sizeof(yaffs_Tnode))
1166                 tnodeSize = sizeof(yaffs_Tnode);
1167
1168
1169         /* make these things */
1170
1171         newTnodes = YMALLOC(nTnodes * tnodeSize);
1172         mem = (__u8 *)newTnodes;
1173
1174         if (!newTnodes) {
1175                 T(YAFFS_TRACE_ERROR,
1176                   (TSTR("yaffs: Could not allocate Tnodes" TENDSTR)));
1177                 return YAFFS_FAIL;
1178         }
1179
1180         /* Hook them into the free list */
1181 #if 0
1182         for (i = 0; i < nTnodes - 1; i++) {
1183                 newTnodes[i].internal[0] = &newTnodes[i + 1];
1184 #ifdef CONFIG_YAFFS_TNODE_LIST_DEBUG
1185                 newTnodes[i].internal[YAFFS_NTNODES_INTERNAL] = (void *)1;
1186 #endif
1187         }
1188
1189         newTnodes[nTnodes - 1].internal[0] = dev->freeTnodes;
1190 #ifdef CONFIG_YAFFS_TNODE_LIST_DEBUG
1191         newTnodes[nTnodes - 1].internal[YAFFS_NTNODES_INTERNAL] = (void *)1;
1192 #endif
1193         dev->freeTnodes = newTnodes;
1194 #else
1195         /* New hookup for wide tnodes */
1196         for(i = 0; i < nTnodes -1; i++) {
1197                 curr = (yaffs_Tnode *) &mem[i * tnodeSize];
1198                 next = (yaffs_Tnode *) &mem[(i+1) * tnodeSize];
1199                 curr->internal[0] = next;
1200         }
1201
1202         curr = (yaffs_Tnode *) &mem[(nTnodes - 1) * tnodeSize];
1203         curr->internal[0] = dev->freeTnodes;
1204         dev->freeTnodes = (yaffs_Tnode *)mem;
1205
1206 #endif
1207
1208
1209         dev->nFreeTnodes += nTnodes;
1210         dev->nTnodesCreated += nTnodes;
1211
1212         /* Now add this bunch of tnodes to a list for freeing up.
1213          * NB If we can't add this to the management list it isn't fatal
1214          * but it just means we can't free this bunch of tnodes later.
1215          */
1216
1217         tnl = YMALLOC(sizeof(yaffs_TnodeList));
1218         if (!tnl) {
1219                 T(YAFFS_TRACE_ERROR,
1220                   (TSTR
1221                    ("yaffs: Could not add tnodes to management list" TENDSTR)));
1222                    return YAFFS_FAIL;
1223
1224         } else {
1225                 tnl->tnodes = newTnodes;
1226                 tnl->next = dev->allocatedTnodeList;
1227                 dev->allocatedTnodeList = tnl;
1228         }
1229
1230         T(YAFFS_TRACE_ALLOCATE, (TSTR("yaffs: Tnodes added" TENDSTR)));
1231
1232         return YAFFS_OK;
1233 }
1234
1235 /* GetTnode gets us a clean tnode. Tries to make allocate more if we run out */
1236
1237 static yaffs_Tnode *yaffs_GetTnodeRaw(yaffs_Device * dev)
1238 {
1239         yaffs_Tnode *tn = NULL;
1240
1241         /* If there are none left make more */
1242         if (!dev->freeTnodes) {
1243                 yaffs_CreateTnodes(dev, YAFFS_ALLOCATION_NTNODES);
1244         }
1245
1246         if (dev->freeTnodes) {
1247                 tn = dev->freeTnodes;
1248 #ifdef CONFIG_YAFFS_TNODE_LIST_DEBUG
1249                 if (tn->internal[YAFFS_NTNODES_INTERNAL] != (void *)1) {
1250                         /* Hoosterman, this thing looks like it isn't in the list */
1251                         T(YAFFS_TRACE_ALWAYS,
1252                           (TSTR("yaffs: Tnode list bug 1" TENDSTR)));
1253                 }
1254 #endif
1255                 dev->freeTnodes = dev->freeTnodes->internal[0];
1256                 dev->nFreeTnodes--;
1257         }
1258
1259         dev->nCheckpointBlocksRequired = 0; /* force recalculation*/
1260
1261         return tn;
1262 }
1263
1264 static yaffs_Tnode *yaffs_GetTnode(yaffs_Device * dev)
1265 {
1266         yaffs_Tnode *tn = yaffs_GetTnodeRaw(dev);
1267         int tnodeSize = (dev->tnodeWidth * YAFFS_NTNODES_LEVEL0)/8;
1268
1269         if(tnodeSize < sizeof(yaffs_Tnode))
1270                 tnodeSize = sizeof(yaffs_Tnode);
1271
1272         if(tn)
1273                 memset(tn, 0, tnodeSize);
1274
1275         return tn;
1276 }
1277
1278 /* FreeTnode frees up a tnode and puts it back on the free list */
1279 static void yaffs_FreeTnode(yaffs_Device * dev, yaffs_Tnode * tn)
1280 {
1281         if (tn) {
1282 #ifdef CONFIG_YAFFS_TNODE_LIST_DEBUG
1283                 if (tn->internal[YAFFS_NTNODES_INTERNAL] != 0) {
1284                         /* Hoosterman, this thing looks like it is already in the list */
1285                         T(YAFFS_TRACE_ALWAYS,
1286                           (TSTR("yaffs: Tnode list bug 2" TENDSTR)));
1287                 }
1288                 tn->internal[YAFFS_NTNODES_INTERNAL] = (void *)1;
1289 #endif
1290                 tn->internal[0] = dev->freeTnodes;
1291                 dev->freeTnodes = tn;
1292                 dev->nFreeTnodes++;
1293         }
1294         dev->nCheckpointBlocksRequired = 0; /* force recalculation*/
1295
1296 }
1297
1298 static void yaffs_DeinitialiseTnodes(yaffs_Device * dev)
1299 {
1300         /* Free the list of allocated tnodes */
1301         yaffs_TnodeList *tmp;
1302
1303         while (dev->allocatedTnodeList) {
1304                 tmp = dev->allocatedTnodeList->next;
1305
1306                 YFREE(dev->allocatedTnodeList->tnodes);
1307                 YFREE(dev->allocatedTnodeList);
1308                 dev->allocatedTnodeList = tmp;
1309
1310         }
1311
1312         dev->freeTnodes = NULL;
1313         dev->nFreeTnodes = 0;
1314 }
1315
1316 static void yaffs_InitialiseTnodes(yaffs_Device * dev)
1317 {
1318         dev->allocatedTnodeList = NULL;
1319         dev->freeTnodes = NULL;
1320         dev->nFreeTnodes = 0;
1321         dev->nTnodesCreated = 0;
1322
1323 }
1324
1325
1326 void yaffs_PutLevel0Tnode(yaffs_Device *dev, yaffs_Tnode *tn, unsigned pos, unsigned val)
1327 {
1328   __u32 *map = (__u32 *)tn;
1329   __u32 bitInMap;
1330   __u32 bitInWord;
1331   __u32 wordInMap;
1332   __u32 mask;
1333
1334   pos &= YAFFS_TNODES_LEVEL0_MASK;
1335   val >>= dev->chunkGroupBits;
1336
1337   bitInMap = pos * dev->tnodeWidth;
1338   wordInMap = bitInMap /32;
1339   bitInWord = bitInMap & (32 -1);
1340
1341   mask = dev->tnodeMask << bitInWord;
1342
1343   map[wordInMap] &= ~mask;
1344   map[wordInMap] |= (mask & (val << bitInWord));
1345
1346   if(dev->tnodeWidth > (32-bitInWord)) {
1347     bitInWord = (32 - bitInWord);
1348     wordInMap++;;
1349     mask = dev->tnodeMask >> (/*dev->tnodeWidth -*/ bitInWord);
1350     map[wordInMap] &= ~mask;
1351     map[wordInMap] |= (mask & (val >> bitInWord));
1352   }
1353 }
1354
1355 static __u32 yaffs_GetChunkGroupBase(yaffs_Device *dev, yaffs_Tnode *tn, unsigned pos)
1356 {
1357   __u32 *map = (__u32 *)tn;
1358   __u32 bitInMap;
1359   __u32 bitInWord;
1360   __u32 wordInMap;
1361   __u32 val;
1362
1363   pos &= YAFFS_TNODES_LEVEL0_MASK;
1364
1365   bitInMap = pos * dev->tnodeWidth;
1366   wordInMap = bitInMap /32;
1367   bitInWord = bitInMap & (32 -1);
1368
1369   val = map[wordInMap] >> bitInWord;
1370
1371   if(dev->tnodeWidth > (32-bitInWord)) {
1372     bitInWord = (32 - bitInWord);
1373     wordInMap++;;
1374     val |= (map[wordInMap] << bitInWord);
1375   }
1376
1377   val &= dev->tnodeMask;
1378   val <<= dev->chunkGroupBits;
1379
1380   return val;
1381 }
1382
1383 /* ------------------- End of individual tnode manipulation -----------------*/
1384
1385 /* ---------Functions to manipulate the look-up tree (made up of tnodes) ------
1386  * The look up tree is represented by the top tnode and the number of topLevel
1387  * in the tree. 0 means only the level 0 tnode is in the tree.
1388  */
1389
1390 /* FindLevel0Tnode finds the level 0 tnode, if one exists. */
1391 static yaffs_Tnode *yaffs_FindLevel0Tnode(yaffs_Device * dev,
1392                                           yaffs_FileStructure * fStruct,
1393                                           __u32 chunkId)
1394 {
1395
1396         yaffs_Tnode *tn = fStruct->top;
1397         __u32 i;
1398         int requiredTallness;
1399         int level = fStruct->topLevel;
1400
1401         /* Check sane level and chunk Id */
1402         if (level < 0 || level > YAFFS_TNODES_MAX_LEVEL) {
1403                 return NULL;
1404         }
1405
1406         if (chunkId > YAFFS_MAX_CHUNK_ID) {
1407                 return NULL;
1408         }
1409
1410         /* First check we're tall enough (ie enough topLevel) */
1411
1412         i = chunkId >> YAFFS_TNODES_LEVEL0_BITS;
1413         requiredTallness = 0;
1414         while (i) {
1415                 i >>= YAFFS_TNODES_INTERNAL_BITS;
1416                 requiredTallness++;
1417         }
1418
1419         if (requiredTallness > fStruct->topLevel) {
1420                 /* Not tall enough, so we can't find it, return NULL. */
1421                 return NULL;
1422         }
1423
1424         /* Traverse down to level 0 */
1425         while (level > 0 && tn) {
1426                 tn = tn->
1427                     internal[(chunkId >>
1428                                ( YAFFS_TNODES_LEVEL0_BITS +
1429                                  (level - 1) *
1430                                  YAFFS_TNODES_INTERNAL_BITS)
1431                               ) &
1432                              YAFFS_TNODES_INTERNAL_MASK];
1433                 level--;
1434
1435         }
1436
1437         return tn;
1438 }
1439
1440 /* AddOrFindLevel0Tnode finds the level 0 tnode if it exists, otherwise first expands the tree.
1441  * This happens in two steps:
1442  *  1. If the tree isn't tall enough, then make it taller.
1443  *  2. Scan down the tree towards the level 0 tnode adding tnodes if required.
1444  *
1445  * Used when modifying the tree.
1446  *
1447  *  If the tn argument is NULL, then a fresh tnode will be added otherwise the specified tn will
1448  *  be plugged into the ttree.
1449  */
1450
1451 static yaffs_Tnode *yaffs_AddOrFindLevel0Tnode(yaffs_Device * dev,
1452                                                yaffs_FileStructure * fStruct,
1453                                                __u32 chunkId,
1454                                                yaffs_Tnode *passedTn)
1455 {
1456
1457         int requiredTallness;
1458         int i;
1459         int l;
1460         yaffs_Tnode *tn;
1461
1462         __u32 x;
1463
1464
1465         /* Check sane level and page Id */
1466         if (fStruct->topLevel < 0 || fStruct->topLevel > YAFFS_TNODES_MAX_LEVEL) {
1467                 return NULL;
1468         }
1469
1470         if (chunkId > YAFFS_MAX_CHUNK_ID) {
1471                 return NULL;
1472         }
1473
1474         /* First check we're tall enough (ie enough topLevel) */
1475
1476         x = chunkId >> YAFFS_TNODES_LEVEL0_BITS;
1477         requiredTallness = 0;
1478         while (x) {
1479                 x >>= YAFFS_TNODES_INTERNAL_BITS;
1480                 requiredTallness++;
1481         }
1482
1483
1484         if (requiredTallness > fStruct->topLevel) {
1485                 /* Not tall enough,gotta make the tree taller */
1486                 for (i = fStruct->topLevel; i < requiredTallness; i++) {
1487
1488                         tn = yaffs_GetTnode(dev);
1489
1490                         if (tn) {
1491                                 tn->internal[0] = fStruct->top;
1492                                 fStruct->top = tn;
1493                         } else {
1494                                 T(YAFFS_TRACE_ERROR,
1495                                   (TSTR("yaffs: no more tnodes" TENDSTR)));
1496                         }
1497                 }
1498
1499                 fStruct->topLevel = requiredTallness;
1500         }
1501
1502         /* Traverse down to level 0, adding anything we need */
1503
1504         l = fStruct->topLevel;
1505         tn = fStruct->top;
1506
1507         if(l > 0) {
1508                 while (l > 0 && tn) {
1509                         x = (chunkId >>
1510                              ( YAFFS_TNODES_LEVEL0_BITS +
1511                               (l - 1) * YAFFS_TNODES_INTERNAL_BITS)) &
1512                             YAFFS_TNODES_INTERNAL_MASK;
1513
1514
1515                         if((l>1) && !tn->internal[x]){
1516                                 /* Add missing non-level-zero tnode */
1517                                 tn->internal[x] = yaffs_GetTnode(dev);
1518
1519                         } else if(l == 1) {
1520                                 /* Looking from level 1 at level 0 */
1521                                 if (passedTn) {
1522                                         /* If we already have one, then release it.*/
1523                                         if(tn->internal[x])
1524                                                 yaffs_FreeTnode(dev,tn->internal[x]);
1525                                         tn->internal[x] = passedTn;
1526
1527                                 } else if(!tn->internal[x]) {
1528                                         /* Don't have one, none passed in */
1529                                         tn->internal[x] = yaffs_GetTnode(dev);
1530                                 }
1531                         }
1532
1533                         tn = tn->internal[x];
1534                         l--;
1535                 }
1536         } else {
1537                 /* top is level 0 */
1538                 if(passedTn) {
1539                         memcpy(tn,passedTn,(dev->tnodeWidth * YAFFS_NTNODES_LEVEL0)/8);
1540                         yaffs_FreeTnode(dev,passedTn);
1541                 }
1542         }
1543
1544         return tn;
1545 }
1546
1547 static int yaffs_FindChunkInGroup(yaffs_Device * dev, int theChunk,
1548                                   yaffs_ExtendedTags * tags, int objectId,
1549                                   int chunkInInode)
1550 {
1551         int j;
1552
1553         for (j = 0; theChunk && j < dev->chunkGroupSize; j++) {
1554                 if (yaffs_CheckChunkBit
1555                     (dev, theChunk / dev->nChunksPerBlock,
1556                      theChunk % dev->nChunksPerBlock)) {
1557                         yaffs_ReadChunkWithTagsFromNAND(dev, theChunk, NULL,
1558                                                         tags);
1559                         if (yaffs_TagsMatch(tags, objectId, chunkInInode)) {
1560                                 /* found it; */
1561                                 return theChunk;
1562
1563                         }
1564                 }
1565                 theChunk++;
1566         }
1567         return -1;
1568 }
1569
1570
1571 /* DeleteWorker scans backwards through the tnode tree and deletes all the
1572  * chunks and tnodes in the file
1573  * Returns 1 if the tree was deleted.
1574  * Returns 0 if it stopped early due to hitting the limit and the delete is incomplete.
1575  */
1576
1577 static int yaffs_DeleteWorker(yaffs_Object * in, yaffs_Tnode * tn, __u32 level,
1578                               int chunkOffset, int *limit)
1579 {
1580         int i;
1581         int chunkInInode;
1582         int theChunk;
1583         yaffs_ExtendedTags tags;
1584         int foundChunk;
1585         yaffs_Device *dev = in->myDev;
1586
1587         int allDone = 1;
1588
1589         if (tn) {
1590                 if (level > 0) {
1591
1592                         for (i = YAFFS_NTNODES_INTERNAL - 1; allDone && i >= 0;
1593                              i--) {
1594                                 if (tn->internal[i]) {
1595                                         if (limit && (*limit) < 0) {
1596                                                 allDone = 0;
1597                                         } else {
1598                                                 allDone =
1599                                                     yaffs_DeleteWorker(in,
1600                                                                        tn->
1601                                                                        internal
1602                                                                        [i],
1603                                                                        level -
1604                                                                        1,
1605                                                                        (chunkOffset
1606                                                                         <<
1607                                                                         YAFFS_TNODES_INTERNAL_BITS)
1608                                                                        + i,
1609                                                                        limit);
1610                                         }
1611                                         if (allDone) {
1612                                                 yaffs_FreeTnode(dev,
1613                                                                 tn->
1614                                                                 internal[i]);
1615                                                 tn->internal[i] = NULL;
1616                                         }
1617                                 }
1618
1619                         }
1620                         return (allDone) ? 1 : 0;
1621                 } else if (level == 0) {
1622                         int hitLimit = 0;
1623
1624                         for (i = YAFFS_NTNODES_LEVEL0 - 1; i >= 0 && !hitLimit;
1625                              i--) {
1626                                 theChunk = yaffs_GetChunkGroupBase(dev,tn,i);
1627                                 if (theChunk) {
1628
1629                                         chunkInInode =
1630                                             (chunkOffset <<
1631                                              YAFFS_TNODES_LEVEL0_BITS) + i;
1632
1633                                         foundChunk =
1634                                             yaffs_FindChunkInGroup(dev,
1635                                                                    theChunk,
1636                                                                    &tags,
1637                                                                    in->objectId,
1638                                                                    chunkInInode);
1639
1640                                         if (foundChunk > 0) {
1641                                                 yaffs_DeleteChunk(dev,
1642                                                                   foundChunk, 1,
1643                                                                   __LINE__);
1644                                                 in->nDataChunks--;
1645                                                 if (limit) {
1646                                                         *limit = *limit - 1;
1647                                                         if (*limit <= 0) {
1648                                                                 hitLimit = 1;
1649                                                         }
1650                                                 }
1651
1652                                         }
1653
1654                                         yaffs_PutLevel0Tnode(dev,tn,i,0);
1655                                 }
1656
1657                         }
1658                         return (i < 0) ? 1 : 0;
1659
1660                 }
1661
1662         }
1663
1664         return 1;
1665
1666 }
1667
1668 static void yaffs_SoftDeleteChunk(yaffs_Device * dev, int chunk)
1669 {
1670
1671         yaffs_BlockInfo *theBlock;
1672
1673         T(YAFFS_TRACE_DELETION, (TSTR("soft delete chunk %d" TENDSTR), chunk));
1674
1675         theBlock = yaffs_GetBlockInfo(dev, chunk / dev->nChunksPerBlock);
1676         if (theBlock) {
1677                 theBlock->softDeletions++;
1678                 dev->nFreeChunks++;
1679         }
1680 }
1681
1682 /* SoftDeleteWorker scans backwards through the tnode tree and soft deletes all the chunks in the file.
1683  * All soft deleting does is increment the block's softdelete count and pulls the chunk out
1684  * of the tnode.
1685  * Thus, essentially this is the same as DeleteWorker except that the chunks are soft deleted.
1686  */
1687
1688 static int yaffs_SoftDeleteWorker(yaffs_Object * in, yaffs_Tnode * tn,
1689                                   __u32 level, int chunkOffset)
1690 {
1691         int i;
1692         int theChunk;
1693         int allDone = 1;
1694         yaffs_Device *dev = in->myDev;
1695
1696         if (tn) {
1697                 if (level > 0) {
1698
1699                         for (i = YAFFS_NTNODES_INTERNAL - 1; allDone && i >= 0;
1700                              i--) {
1701                                 if (tn->internal[i]) {
1702                                         allDone =
1703                                             yaffs_SoftDeleteWorker(in,
1704                                                                    tn->
1705                                                                    internal[i],
1706                                                                    level - 1,
1707                                                                    (chunkOffset
1708                                                                     <<
1709                                                                     YAFFS_TNODES_INTERNAL_BITS)
1710                                                                    + i);
1711                                         if (allDone) {
1712                                                 yaffs_FreeTnode(dev,
1713                                                                 tn->
1714                                                                 internal[i]);
1715                                                 tn->internal[i] = NULL;
1716                                         } else {
1717                                                 /* Hoosterman... how could this happen? */
1718                                         }
1719                                 }
1720                         }
1721                         return (allDone) ? 1 : 0;
1722                 } else if (level == 0) {
1723
1724                         for (i = YAFFS_NTNODES_LEVEL0 - 1; i >= 0; i--) {
1725                                 theChunk = yaffs_GetChunkGroupBase(dev,tn,i);
1726                                 if (theChunk) {
1727                                         /* Note this does not find the real chunk, only the chunk group.
1728                                          * We make an assumption that a chunk group is not larger than
1729                                          * a block.
1730                                          */
1731                                         yaffs_SoftDeleteChunk(dev, theChunk);
1732                                         yaffs_PutLevel0Tnode(dev,tn,i,0);
1733                                 }
1734
1735                         }
1736                         return 1;
1737
1738                 }
1739
1740         }
1741
1742         return 1;
1743
1744 }
1745
1746 static void yaffs_SoftDeleteFile(yaffs_Object * obj)
1747 {
1748         if (obj->deleted &&
1749             obj->variantType == YAFFS_OBJECT_TYPE_FILE && !obj->softDeleted) {
1750                 if (obj->nDataChunks <= 0) {
1751                         /* Empty file with no duplicate object headers, just delete it immediately */
1752                         yaffs_FreeTnode(obj->myDev,
1753                                         obj->variant.fileVariant.top);
1754                         obj->variant.fileVariant.top = NULL;
1755                         T(YAFFS_TRACE_TRACING,
1756                           (TSTR("yaffs: Deleting empty file %d" TENDSTR),
1757                            obj->objectId));
1758                         yaffs_DoGenericObjectDeletion(obj);
1759                 } else {
1760                         yaffs_SoftDeleteWorker(obj,
1761                                                obj->variant.fileVariant.top,
1762                                                obj->variant.fileVariant.
1763                                                topLevel, 0);
1764                         obj->softDeleted = 1;
1765                 }
1766         }
1767 }
1768
1769 /* Pruning removes any part of the file structure tree that is beyond the
1770  * bounds of the file (ie that does not point to chunks).
1771  *
1772  * A file should only get pruned when its size is reduced.
1773  *
1774  * Before pruning, the chunks must be pulled from the tree and the
1775  * level 0 tnode entries must be zeroed out.
1776  * Could also use this for file deletion, but that's probably better handled
1777  * by a special case.
1778  */
1779
1780 static yaffs_Tnode *yaffs_PruneWorker(yaffs_Device * dev, yaffs_Tnode * tn,
1781                                       __u32 level, int del0)
1782 {
1783         int i;
1784         int hasData;
1785
1786         if (tn) {
1787                 hasData = 0;
1788
1789                 for (i = 0; i < YAFFS_NTNODES_INTERNAL; i++) {
1790                         if (tn->internal[i] && level > 0) {
1791                                 tn->internal[i] =
1792                                     yaffs_PruneWorker(dev, tn->internal[i],
1793                                                       level - 1,
1794                                                       (i == 0) ? del0 : 1);
1795                         }
1796
1797                         if (tn->internal[i]) {
1798                                 hasData++;
1799                         }
1800                 }
1801
1802                 if (hasData == 0 && del0) {
1803                         /* Free and return NULL */
1804
1805                         yaffs_FreeTnode(dev, tn);
1806                         tn = NULL;
1807                 }
1808
1809         }
1810
1811         return tn;
1812
1813 }
1814
1815 static int yaffs_PruneFileStructure(yaffs_Device * dev,
1816                                     yaffs_FileStructure * fStruct)
1817 {
1818         int i;
1819         int hasData;
1820         int done = 0;
1821         yaffs_Tnode *tn;
1822
1823         if (fStruct->topLevel > 0) {
1824                 fStruct->top =
1825                     yaffs_PruneWorker(dev, fStruct->top, fStruct->topLevel, 0);
1826
1827                 /* Now we have a tree with all the non-zero branches NULL but the height
1828                  * is the same as it was.
1829                  * Let's see if we can trim internal tnodes to shorten the tree.
1830                  * We can do this if only the 0th element in the tnode is in use
1831                  * (ie all the non-zero are NULL)
1832                  */
1833
1834                 while (fStruct->topLevel && !done) {
1835                         tn = fStruct->top;
1836
1837                         hasData = 0;
1838                         for (i = 1; i < YAFFS_NTNODES_INTERNAL; i++) {
1839                                 if (tn->internal[i]) {
1840                                         hasData++;
1841                                 }
1842                         }
1843
1844                         if (!hasData) {
1845                                 fStruct->top = tn->internal[0];
1846                                 fStruct->topLevel--;
1847                                 yaffs_FreeTnode(dev, tn);
1848                         } else {
1849                                 done = 1;
1850                         }
1851                 }
1852         }
1853
1854         return YAFFS_OK;
1855 }
1856
1857 /*-------------------- End of File Structure functions.-------------------*/
1858
1859 /* yaffs_CreateFreeObjects creates a bunch more objects and
1860  * adds them to the object free list.
1861  */
1862 static int yaffs_CreateFreeObjects(yaffs_Device * dev, int nObjects)
1863 {
1864         int i;
1865         yaffs_Object *newObjects;
1866         yaffs_ObjectList *list;
1867
1868         if (nObjects < 1)
1869                 return YAFFS_OK;
1870
1871         /* make these things */
1872         newObjects = YMALLOC(nObjects * sizeof(yaffs_Object));
1873         list = YMALLOC(sizeof(yaffs_ObjectList));
1874
1875         if (!newObjects || !list) {
1876                 if(newObjects)
1877                         YFREE(newObjects);
1878                 if(list)
1879                         YFREE(list);
1880                 T(YAFFS_TRACE_ALLOCATE,
1881                   (TSTR("yaffs: Could not allocate more objects" TENDSTR)));
1882                 return YAFFS_FAIL;
1883         }
1884
1885         /* Hook them into the free list */
1886         for (i = 0; i < nObjects - 1; i++) {
1887                 newObjects[i].siblings.next =
1888                     (struct ylist_head *)(&newObjects[i + 1]);
1889         }
1890
1891         newObjects[nObjects - 1].siblings.next = (void *)dev->freeObjects;
1892         dev->freeObjects = newObjects;
1893         dev->nFreeObjects += nObjects;
1894         dev->nObjectsCreated += nObjects;
1895
1896         /* Now add this bunch of Objects to a list for freeing up. */
1897
1898         list->objects = newObjects;
1899         list->next = dev->allocatedObjectList;
1900         dev->allocatedObjectList = list;
1901
1902         return YAFFS_OK;
1903 }
1904
1905
1906 /* AllocateEmptyObject gets us a clean Object. Tries to make allocate more if we run out */
1907 static yaffs_Object *yaffs_AllocateEmptyObject(yaffs_Device * dev)
1908 {
1909         yaffs_Object *tn = NULL;
1910
1911 #ifdef VALGRIND_TEST
1912         tn = YMALLOC(sizeof(yaffs_Object));
1913 #else
1914         /* If there are none left make more */
1915         if (!dev->freeObjects) {
1916                 yaffs_CreateFreeObjects(dev, YAFFS_ALLOCATION_NOBJECTS);
1917         }
1918
1919         if (dev->freeObjects) {
1920                 tn = dev->freeObjects;
1921                 dev->freeObjects =
1922                     (yaffs_Object *) (dev->freeObjects->siblings.next);
1923                 dev->nFreeObjects--;
1924         }
1925 #endif
1926         if(tn){
1927                 /* Now sweeten it up... */
1928
1929                 memset(tn, 0, sizeof(yaffs_Object));
1930                 tn->myDev = dev;
1931                 tn->hdrChunk = 0;
1932                 tn->variantType = YAFFS_OBJECT_TYPE_UNKNOWN;
1933                 YINIT_LIST_HEAD(&(tn->hardLinks));
1934                 YINIT_LIST_HEAD(&(tn->hashLink));
1935                 YINIT_LIST_HEAD(&tn->siblings);
1936
1937
1938                 /* Now make the directory sane */
1939                 if(dev->rootDir){
1940                         tn->parent = dev->rootDir;
1941                         ylist_add(&(tn->siblings),&dev->rootDir->variant.directoryVariant.children);
1942                 }
1943
1944                 /* Add it to the lost and found directory.
1945                  * NB Can't put root or lostNFound in lostNFound so
1946                  * check if lostNFound exists first
1947                  */
1948                 if (dev->lostNFoundDir) {
1949                         yaffs_AddObjectToDirectory(dev->lostNFoundDir, tn);
1950                 }
1951         }
1952
1953         dev->nCheckpointBlocksRequired = 0; /* force recalculation*/
1954
1955         return tn;
1956 }
1957
1958 static yaffs_Object *yaffs_CreateFakeDirectory(yaffs_Device * dev, int number,
1959                                                __u32 mode)
1960 {
1961
1962         yaffs_Object *obj =
1963             yaffs_CreateNewObject(dev, number, YAFFS_OBJECT_TYPE_DIRECTORY);
1964         if (obj) {
1965                 obj->fake = 1;          /* it is fake so it might have no NAND presence... */
1966                 obj->renameAllowed = 0; /* ... and we're not allowed to rename it... */
1967                 obj->unlinkAllowed = 0; /* ... or unlink it */
1968                 obj->deleted = 0;
1969                 obj->unlinked = 0;
1970                 obj->yst_mode = mode;
1971                 obj->myDev = dev;
1972                 obj->hdrChunk = 0;      /* Not a valid chunk. */
1973         }
1974
1975         return obj;
1976
1977 }
1978
1979 static void yaffs_UnhashObject(yaffs_Object * tn)
1980 {
1981         int bucket;
1982         yaffs_Device *dev = tn->myDev;
1983
1984         /* If it is still linked into the bucket list, free from the list */
1985         if (!ylist_empty(&tn->hashLink)) {
1986                 ylist_del_init(&tn->hashLink);
1987                 bucket = yaffs_HashFunction(tn->objectId);
1988                 dev->objectBucket[bucket].count--;
1989         }
1990
1991 }
1992
1993 /*  FreeObject frees up a Object and puts it back on the free list */
1994 static void yaffs_FreeObject(yaffs_Object * tn)
1995 {
1996
1997         yaffs_Device *dev = tn->myDev;
1998
1999
2000         if(tn->parent)
2001                 YBUG();
2002         if(!ylist_empty(&tn->siblings))
2003                 YBUG();
2004
2005
2006 #ifdef  __KERNEL__
2007         if (tn->myInode) {
2008                 /* We're still hooked up to a cached inode.
2009                  * Don't delete now, but mark for later deletion
2010                  */
2011                 tn->deferedFree = 1;
2012                 return;
2013         }
2014 #endif
2015
2016         yaffs_UnhashObject(tn);
2017
2018 #ifdef VALGRIND_TEST
2019         YFREE(tn);
2020 #else
2021         /* Link into the free list. */
2022         tn->siblings.next = (struct ylist_head *)(dev->freeObjects);
2023         dev->freeObjects = tn;
2024         dev->nFreeObjects++;
2025 #endif
2026         dev->nCheckpointBlocksRequired = 0; /* force recalculation*/
2027
2028 }
2029
2030 #ifdef __KERNEL__
2031
2032 void yaffs_HandleDeferedFree(yaffs_Object * obj)
2033 {
2034         if (obj->deferedFree) {
2035                 yaffs_FreeObject(obj);
2036         }
2037 }
2038
2039 #endif
2040
2041 static void yaffs_DeinitialiseObjects(yaffs_Device * dev)
2042 {
2043         /* Free the list of allocated Objects */
2044
2045         yaffs_ObjectList *tmp;
2046
2047         while (dev->allocatedObjectList) {
2048                 tmp = dev->allocatedObjectList->next;
2049                 YFREE(dev->allocatedObjectList->objects);
2050                 YFREE(dev->allocatedObjectList);
2051
2052                 dev->allocatedObjectList = tmp;
2053         }
2054
2055         dev->freeObjects = NULL;
2056         dev->nFreeObjects = 0;
2057 }
2058
2059 static void yaffs_InitialiseObjects(yaffs_Device * dev)
2060 {
2061         int i;
2062
2063         dev->allocatedObjectList = NULL;
2064         dev->freeObjects = NULL;
2065         dev->nFreeObjects = 0;
2066
2067         for (i = 0; i < YAFFS_NOBJECT_BUCKETS; i++) {
2068                 YINIT_LIST_HEAD(&dev->objectBucket[i].list);
2069                 dev->objectBucket[i].count = 0;
2070         }
2071
2072 }
2073
2074 static int yaffs_FindNiceObjectBucket(yaffs_Device * dev)
2075 {
2076         static int x = 0;
2077         int i;
2078         int l = 999;
2079         int lowest = 999999;
2080
2081         /* First let's see if we can find one that's empty. */
2082
2083         for (i = 0; i < 10 && lowest > 0; i++) {
2084                 x++;
2085                 x %= YAFFS_NOBJECT_BUCKETS;
2086                 if (dev->objectBucket[x].count < lowest) {
2087                         lowest = dev->objectBucket[x].count;
2088                         l = x;
2089                 }
2090
2091         }
2092
2093         /* If we didn't find an empty list, then try
2094          * looking a bit further for a short one
2095          */
2096
2097         for (i = 0; i < 10 && lowest > 3; i++) {
2098                 x++;
2099                 x %= YAFFS_NOBJECT_BUCKETS;
2100                 if (dev->objectBucket[x].count < lowest) {
2101                         lowest = dev->objectBucket[x].count;
2102                         l = x;
2103                 }
2104
2105         }
2106
2107         return l;
2108 }
2109
2110 static int yaffs_CreateNewObjectNumber(yaffs_Device * dev)
2111 {
2112         int bucket = yaffs_FindNiceObjectBucket(dev);
2113
2114         /* Now find an object value that has not already been taken
2115          * by scanning the list.
2116          */
2117
2118         int found = 0;
2119         struct ylist_head *i;
2120
2121         __u32 n = (__u32) bucket;
2122
2123         /* yaffs_CheckObjectHashSanity();  */
2124
2125         while (!found) {
2126                 found = 1;
2127                 n += YAFFS_NOBJECT_BUCKETS;
2128                 if (1 || dev->objectBucket[bucket].count > 0) {
2129                         ylist_for_each(i, &dev->objectBucket[bucket].list) {
2130                                 /* If there is already one in the list */
2131                                 if (i
2132                                     && ylist_entry(i, yaffs_Object,
2133                                                   hashLink)->objectId == n) {
2134                                         found = 0;
2135                                 }
2136                         }
2137                 }
2138         }
2139
2140
2141         return n;
2142 }
2143
2144 static void yaffs_HashObject(yaffs_Object * in)
2145 {
2146         int bucket = yaffs_HashFunction(in->objectId);
2147         yaffs_Device *dev = in->myDev;
2148
2149         ylist_add(&in->hashLink, &dev->objectBucket[bucket].list);
2150         dev->objectBucket[bucket].count++;
2151
2152 }
2153
2154 yaffs_Object *yaffs_FindObjectByNumber(yaffs_Device * dev, __u32 number)
2155 {
2156         int bucket = yaffs_HashFunction(number);
2157         struct ylist_head *i;
2158         yaffs_Object *in;
2159
2160         ylist_for_each(i, &dev->objectBucket[bucket].list) {
2161                 /* Look if it is in the list */
2162                 if (i) {
2163                         in = ylist_entry(i, yaffs_Object, hashLink);
2164                         if (in->objectId == number) {
2165 #ifdef __KERNEL__
2166                                 /* Don't tell the VFS about this one if it is defered free */
2167                                 if (in->deferedFree)
2168                                         return NULL;
2169 #endif
2170
2171                                 return in;
2172                         }
2173                 }
2174         }
2175
2176         return NULL;
2177 }
2178
2179 yaffs_Object *yaffs_CreateNewObject(yaffs_Device * dev, int number,
2180                                     yaffs_ObjectType type)
2181 {
2182
2183         yaffs_Object *theObject;
2184         yaffs_Tnode *tn = NULL;
2185
2186         if (number < 0) {
2187                 number = yaffs_CreateNewObjectNumber(dev);
2188         }
2189
2190         theObject = yaffs_AllocateEmptyObject(dev);
2191         if(!theObject)
2192                 return NULL;
2193
2194         if(type == YAFFS_OBJECT_TYPE_FILE){
2195                 tn = yaffs_GetTnode(dev);
2196                 if(!tn){
2197                         yaffs_FreeObject(theObject);
2198                         return NULL;
2199                 }
2200         }
2201
2202
2203
2204         if (theObject) {
2205                 theObject->fake = 0;
2206                 theObject->renameAllowed = 1;
2207                 theObject->unlinkAllowed = 1;
2208                 theObject->objectId = number;
2209                 yaffs_HashObject(theObject);
2210                 theObject->variantType = type;
2211 #ifdef CONFIG_YAFFS_WINCE
2212                 yfsd_WinFileTimeNow(theObject->win_atime);
2213                 theObject->win_ctime[0] = theObject->win_mtime[0] =
2214                     theObject->win_atime[0];
2215                 theObject->win_ctime[1] = theObject->win_mtime[1] =
2216                     theObject->win_atime[1];
2217
2218 #else
2219
2220                 theObject->yst_atime = theObject->yst_mtime =
2221                     theObject->yst_ctime = Y_CURRENT_TIME;
2222 #endif
2223
2224 #if 0
2225                 theObject->sum_prev = 12345;
2226                 theObject->sum_trailer = 6789;
2227 #endif
2228
2229                 switch (type) {
2230                 case YAFFS_OBJECT_TYPE_FILE:
2231                         theObject->variant.fileVariant.fileSize = 0;
2232                         theObject->variant.fileVariant.scannedFileSize = 0;
2233                         theObject->variant.fileVariant.shrinkSize = 0xFFFFFFFF; /* max __u32 */
2234                         theObject->variant.fileVariant.topLevel = 0;
2235                         theObject->variant.fileVariant.top = tn;
2236                         break;
2237                 case YAFFS_OBJECT_TYPE_DIRECTORY:
2238                         YINIT_LIST_HEAD(&theObject->variant.directoryVariant.
2239                                        children);
2240                         break;
2241                 case YAFFS_OBJECT_TYPE_SYMLINK:
2242                 case YAFFS_OBJECT_TYPE_HARDLINK:
2243                 case YAFFS_OBJECT_TYPE_SPECIAL:
2244                         /* No action required */
2245                         break;
2246                 case YAFFS_OBJECT_TYPE_UNKNOWN:
2247                         /* todo this should not happen */
2248                         break;
2249                 }
2250         }
2251
2252         return theObject;
2253 }
2254
2255 static yaffs_Object *yaffs_FindOrCreateObjectByNumber(yaffs_Device * dev,
2256                                                       int number,
2257                                                       yaffs_ObjectType type)
2258 {
2259         yaffs_Object *theObject = NULL;
2260
2261         if (number > 0) {
2262                 theObject = yaffs_FindObjectByNumber(dev, number);
2263         }
2264
2265         if (!theObject) {
2266                 theObject = yaffs_CreateNewObject(dev, number, type);
2267         }
2268
2269         return theObject;
2270
2271 }
2272
2273
2274 static YCHAR *yaffs_CloneString(const YCHAR * str)
2275 {
2276         YCHAR *newStr = NULL;
2277
2278         if (str && *str) {
2279                 newStr = YMALLOC((yaffs_strlen(str) + 1) * sizeof(YCHAR));
2280                 if(newStr)
2281                         yaffs_strcpy(newStr, str);
2282         }
2283
2284         return newStr;
2285
2286 }
2287
2288 /*
2289  * Mknod (create) a new object.
2290  * equivalentObject only has meaning for a hard link;
2291  * aliasString only has meaning for a sumlink.
2292  * rdev only has meaning for devices (a subset of special objects)
2293  */
2294
2295 static yaffs_Object *yaffs_MknodObject(yaffs_ObjectType type,
2296                                        yaffs_Object * parent,
2297                                        const YCHAR * name,
2298                                        __u32 mode,
2299                                        __u32 uid,
2300                                        __u32 gid,
2301                                        yaffs_Object * equivalentObject,
2302                                        const YCHAR * aliasString, __u32 rdev)
2303 {
2304         yaffs_Object *in;
2305         YCHAR *str = NULL;
2306
2307         yaffs_Device *dev = parent->myDev;
2308
2309         /* Check if the entry exists. If it does then fail the call since we don't want a dup.*/
2310         if (yaffs_FindObjectByName(parent, name)) {
2311                 return NULL;
2312         }
2313
2314         in = yaffs_CreateNewObject(dev, -1, type);
2315
2316         if(!in)
2317                 return YAFFS_FAIL;
2318
2319         if(type == YAFFS_OBJECT_TYPE_SYMLINK){
2320                 str = yaffs_CloneString(aliasString);
2321                 if(!str){
2322                         yaffs_FreeObject(in);
2323                         return NULL;
2324                 }
2325         }
2326
2327
2328
2329         if (in) {
2330                 in->hdrChunk = 0;
2331                 in->valid = 1;
2332                 in->variantType = type;
2333
2334                 in->yst_mode = mode;
2335
2336 #ifdef CONFIG_YAFFS_WINCE
2337                 yfsd_WinFileTimeNow(in->win_atime);
2338                 in->win_ctime[0] = in->win_mtime[0] = in->win_atime[0];
2339                 in->win_ctime[1] = in->win_mtime[1] = in->win_atime[1];
2340
2341 #else
2342                 in->yst_atime = in->yst_mtime = in->yst_ctime = Y_CURRENT_TIME;
2343
2344                 in->yst_rdev = rdev;
2345                 in->yst_uid = uid;
2346                 in->yst_gid = gid;
2347 #endif
2348                 in->nDataChunks = 0;
2349
2350                 yaffs_SetObjectName(in, name);
2351                 in->dirty = 1;
2352
2353                 yaffs_AddObjectToDirectory(parent, in);
2354
2355                 in->myDev = parent->myDev;
2356
2357                 switch (type) {
2358                 case YAFFS_OBJECT_TYPE_SYMLINK:
2359                         in->variant.symLinkVariant.alias = str;
2360                         break;
2361                 case YAFFS_OBJECT_TYPE_HARDLINK:
2362                         in->variant.hardLinkVariant.equivalentObject =
2363                             equivalentObject;
2364                         in->variant.hardLinkVariant.equivalentObjectId =
2365                             equivalentObject->objectId;
2366                         ylist_add(&in->hardLinks, &equivalentObject->hardLinks);
2367                         break;
2368                 case YAFFS_OBJECT_TYPE_FILE:
2369                 case YAFFS_OBJECT_TYPE_DIRECTORY:
2370                 case YAFFS_OBJECT_TYPE_SPECIAL:
2371                 case YAFFS_OBJECT_TYPE_UNKNOWN:
2372                         /* do nothing */
2373                         break;
2374                 }
2375
2376                 if (yaffs_UpdateObjectHeader(in, name, 0, 0, 0) < 0) {
2377                         /* Could not create the object header, fail the creation */
2378                         yaffs_DestroyObject(in);
2379                         in = NULL;
2380                 }
2381
2382         }
2383
2384         return in;
2385 }
2386
2387 yaffs_Object *yaffs_MknodFile(yaffs_Object * parent, const YCHAR * name,
2388                               __u32 mode, __u32 uid, __u32 gid)
2389 {
2390         return yaffs_MknodObject(YAFFS_OBJECT_TYPE_FILE, parent, name, mode,
2391                                  uid, gid, NULL, NULL, 0);
2392 }
2393
2394 yaffs_Object *yaffs_MknodDirectory(yaffs_Object * parent, const YCHAR * name,
2395                                    __u32 mode, __u32 uid, __u32 gid)
2396 {
2397         return yaffs_MknodObject(YAFFS_OBJECT_TYPE_DIRECTORY, parent, name,
2398                                  mode, uid, gid, NULL, NULL, 0);
2399 }
2400
2401 yaffs_Object *yaffs_MknodSpecial(yaffs_Object * parent, const YCHAR * name,
2402                                  __u32 mode, __u32 uid, __u32 gid, __u32 rdev)
2403 {
2404         return yaffs_MknodObject(YAFFS_OBJECT_TYPE_SPECIAL, parent, name, mode,
2405                                  uid, gid, NULL, NULL, rdev);
2406 }
2407
2408 yaffs_Object *yaffs_MknodSymLink(yaffs_Object * parent, const YCHAR * name,
2409                                  __u32 mode, __u32 uid, __u32 gid,
2410                                  const YCHAR * alias)
2411 {
2412         return yaffs_MknodObject(YAFFS_OBJECT_TYPE_SYMLINK, parent, name, mode,
2413                                  uid, gid, NULL, alias, 0);
2414 }
2415
2416 /* yaffs_Link returns the object id of the equivalent object.*/
2417 yaffs_Object *yaffs_Link(yaffs_Object * parent, const YCHAR * name,
2418                          yaffs_Object * equivalentObject)
2419 {
2420         /* Get the real object in case we were fed a hard link as an equivalent object */
2421         equivalentObject = yaffs_GetEquivalentObject(equivalentObject);
2422
2423         if (yaffs_MknodObject
2424             (YAFFS_OBJECT_TYPE_HARDLINK, parent, name, 0, 0, 0,
2425              equivalentObject, NULL, 0)) {
2426                 return equivalentObject;
2427         } else {
2428                 return NULL;
2429         }
2430
2431 }
2432
2433 static int yaffs_ChangeObjectName(yaffs_Object * obj, yaffs_Object * newDir,
2434                                   const YCHAR * newName, int force, int shadows)
2435 {
2436         int unlinkOp;
2437         int deleteOp;
2438
2439         yaffs_Object *existingTarget;
2440
2441         if (newDir == NULL) {
2442                 newDir = obj->parent;   /* use the old directory */
2443         }
2444
2445         if (newDir->variantType != YAFFS_OBJECT_TYPE_DIRECTORY) {
2446                 T(YAFFS_TRACE_ALWAYS,
2447                   (TSTR
2448                    ("tragedy: yaffs_ChangeObjectName: newDir is not a directory"
2449                     TENDSTR)));
2450                 YBUG();
2451         }
2452
2453         /* TODO: Do we need this different handling for YAFFS2 and YAFFS1?? */
2454         if (obj->myDev->isYaffs2) {
2455                 unlinkOp = (newDir == obj->myDev->unlinkedDir);
2456         } else {
2457                 unlinkOp = (newDir == obj->myDev->unlinkedDir
2458                             && obj->variantType == YAFFS_OBJECT_TYPE_FILE);
2459         }
2460
2461         deleteOp = (newDir == obj->myDev->deletedDir);
2462
2463         existingTarget = yaffs_FindObjectByName(newDir, newName);
2464
2465         /* If the object is a file going into the unlinked directory,
2466          *   then it is OK to just stuff it in since duplicate names are allowed.
2467          *   else only proceed if the new name does not exist and if we're putting
2468          *   it into a directory.
2469          */
2470         if ((unlinkOp ||
2471              deleteOp ||
2472              force ||
2473              (shadows > 0) ||
2474              !existingTarget) &&
2475             newDir->variantType == YAFFS_OBJECT_TYPE_DIRECTORY) {
2476                 yaffs_SetObjectName(obj, newName);
2477                 obj->dirty = 1;
2478
2479                 yaffs_AddObjectToDirectory(newDir, obj);
2480
2481                 if (unlinkOp)
2482                         obj->unlinked = 1;
2483
2484                 /* If it is a deletion then we mark it as a shrink for gc purposes. */
2485                 if (yaffs_UpdateObjectHeader(obj, newName, 0, deleteOp, shadows)>= 0)
2486                         return YAFFS_OK;
2487         }
2488
2489         return YAFFS_FAIL;
2490 }
2491
2492 int yaffs_RenameObject(yaffs_Object * oldDir, const YCHAR * oldName,
2493                        yaffs_Object * newDir, const YCHAR * newName)
2494 {
2495         yaffs_Object *obj=NULL;
2496         yaffs_Object *existingTarget=NULL;
2497         int force = 0;
2498
2499
2500         if(!oldDir || oldDir->variantType != YAFFS_OBJECT_TYPE_DIRECTORY)
2501                 YBUG();
2502         if(!newDir || newDir->variantType != YAFFS_OBJECT_TYPE_DIRECTORY)
2503                 YBUG();
2504
2505 #ifdef CONFIG_YAFFS_CASE_INSENSITIVE
2506         /* Special case for case insemsitive systems (eg. WinCE).
2507          * While look-up is case insensitive, the name isn't.
2508          * Therefore we might want to change x.txt to X.txt
2509         */
2510         if (oldDir == newDir && yaffs_strcmp(oldName, newName) == 0) {
2511                 force = 1;
2512         }
2513 #endif
2514
2515         else if (yaffs_strlen(newName) > YAFFS_MAX_NAME_LENGTH)
2516           /* ENAMETOOLONG */
2517           return YAFFS_FAIL;
2518
2519         obj = yaffs_FindObjectByName(oldDir, oldName);
2520
2521         if (obj && obj->renameAllowed) {
2522
2523                 /* Now do the handling for an existing target, if there is one */
2524
2525                 existingTarget = yaffs_FindObjectByName(newDir, newName);
2526                 if (existingTarget &&
2527                     existingTarget->variantType == YAFFS_OBJECT_TYPE_DIRECTORY &&
2528                     !ylist_empty(&existingTarget->variant.directoryVariant.children)) {
2529                         /* There is a target that is a non-empty directory, so we fail */
2530                         return YAFFS_FAIL;      /* EEXIST or ENOTEMPTY */
2531                 } else if (existingTarget && existingTarget != obj) {
2532                         /* Nuke the target first, using shadowing,
2533                          * but only if it isn't the same object
2534                          */
2535                         yaffs_ChangeObjectName(obj, newDir, newName, force,
2536                                                existingTarget->objectId);
2537                         yaffs_UnlinkObject(existingTarget);
2538                 }
2539
2540                 return yaffs_ChangeObjectName(obj, newDir, newName, 1, 0);
2541         }
2542         return YAFFS_FAIL;
2543 }
2544
2545 /*------------------------- Block Management and Page Allocation ----------------*/
2546
2547 static int yaffs_InitialiseBlocks(yaffs_Device * dev)
2548 {
2549         int nBlocks = dev->internalEndBlock - dev->internalStartBlock + 1;
2550
2551         dev->blockInfo = NULL;
2552         dev->chunkBits = NULL;
2553
2554         dev->allocationBlock = -1;      /* force it to get a new one */
2555
2556         /* If the first allocation strategy fails, thry the alternate one */
2557         dev->blockInfo = YMALLOC(nBlocks * sizeof(yaffs_BlockInfo));
2558         if(!dev->blockInfo){
2559                 dev->blockInfo = YMALLOC_ALT(nBlocks * sizeof(yaffs_BlockInfo));
2560                 dev->blockInfoAlt = 1;
2561         }
2562         else
2563                 dev->blockInfoAlt = 0;
2564
2565         if(dev->blockInfo){
2566
2567                 /* Set up dynamic blockinfo stuff. */
2568                 dev->chunkBitmapStride = (dev->nChunksPerBlock + 7) / 8; /* round up bytes */
2569                 dev->chunkBits = YMALLOC(dev->chunkBitmapStride * nBlocks);
2570                 if(!dev->chunkBits){
2571                         dev->chunkBits = YMALLOC_ALT(dev->chunkBitmapStride * nBlocks);
2572                         dev->chunkBitsAlt = 1;
2573                 }
2574                 else
2575                         dev->chunkBitsAlt = 0;
2576         }
2577
2578         if (dev->blockInfo && dev->chunkBits) {
2579                 memset(dev->blockInfo, 0, nBlocks * sizeof(yaffs_BlockInfo));
2580                 memset(dev->chunkBits, 0, dev->chunkBitmapStride * nBlocks);
2581                 return YAFFS_OK;
2582         }
2583
2584         return YAFFS_FAIL;
2585
2586 }
2587
2588 static void yaffs_DeinitialiseBlocks(yaffs_Device * dev)
2589 {
2590         if(dev->blockInfoAlt && dev->blockInfo)
2591                 YFREE_ALT(dev->blockInfo);
2592         else if(dev->blockInfo)
2593                 YFREE(dev->blockInfo);
2594
2595         dev->blockInfoAlt = 0;
2596
2597         dev->blockInfo = NULL;
2598
2599         if(dev->chunkBitsAlt && dev->chunkBits)
2600                 YFREE_ALT(dev->chunkBits);
2601         else if(dev->chunkBits)
2602                 YFREE(dev->chunkBits);
2603         dev->chunkBitsAlt = 0;
2604         dev->chunkBits = NULL;
2605 }
2606
2607 static int yaffs_BlockNotDisqualifiedFromGC(yaffs_Device * dev,
2608                                             yaffs_BlockInfo * bi)
2609 {
2610         int i;
2611         __u32 seq;
2612         yaffs_BlockInfo *b;
2613
2614         if (!dev->isYaffs2)
2615                 return 1;       /* disqualification only applies to yaffs2. */
2616
2617         if (!bi->hasShrinkHeader)
2618                 return 1;       /* can gc */
2619
2620         /* Find the oldest dirty sequence number if we don't know it and save it
2621          * so we don't have to keep recomputing it.
2622          */
2623         if (!dev->oldestDirtySequence) {
2624                 seq = dev->sequenceNumber;
2625
2626                 for (i = dev->internalStartBlock; i <= dev->internalEndBlock;
2627                      i++) {
2628                         b = yaffs_GetBlockInfo(dev, i);
2629                         if (b->blockState == YAFFS_BLOCK_STATE_FULL &&
2630                             (b->pagesInUse - b->softDeletions) <
2631                             dev->nChunksPerBlock && b->sequenceNumber < seq) {
2632                                 seq = b->sequenceNumber;
2633                         }
2634                 }
2635                 dev->oldestDirtySequence = seq;
2636         }
2637
2638         /* Can't do gc of this block if there are any blocks older than this one that have
2639          * discarded pages.
2640          */
2641         return (bi->sequenceNumber <= dev->oldestDirtySequence);
2642
2643 }
2644
2645 /* FindDiretiestBlock is used to select the dirtiest block (or close enough)
2646  * for garbage collection.
2647  */
2648
2649 static int yaffs_FindBlockForGarbageCollection(yaffs_Device * dev,
2650                                                int aggressive)
2651 {
2652
2653         int b = dev->currentDirtyChecker;
2654
2655         int i;
2656         int iterations;
2657         int dirtiest = -1;
2658         int pagesInUse = 0;
2659         int prioritised=0;
2660         yaffs_BlockInfo *bi;
2661         int pendingPrioritisedExist = 0;
2662
2663         /* First let's see if we need to grab a prioritised block */
2664         if(dev->hasPendingPrioritisedGCs){
2665                 for(i = dev->internalStartBlock; i < dev->internalEndBlock && !prioritised; i++){
2666
2667                         bi = yaffs_GetBlockInfo(dev, i);
2668                         //yaffs_VerifyBlock(dev,bi,i);
2669
2670                         if(bi->gcPrioritise) {
2671                                 pendingPrioritisedExist = 1;
2672                                 if(bi->blockState == YAFFS_BLOCK_STATE_FULL &&
2673                                    yaffs_BlockNotDisqualifiedFromGC(dev, bi)){
2674                                         pagesInUse = (bi->pagesInUse - bi->softDeletions);
2675                                         dirtiest = i;
2676                                         prioritised = 1;
2677                                         aggressive = 1; /* Fool the non-aggressive skip logiv below */
2678                                 }
2679                         }
2680                 }
2681
2682                 if(!pendingPrioritisedExist) /* None found, so we can clear this */
2683                         dev->hasPendingPrioritisedGCs = 0;
2684         }
2685
2686         /* If we're doing aggressive GC then we are happy to take a less-dirty block, and
2687          * search harder.
2688          * else (we're doing a leasurely gc), then we only bother to do this if the
2689          * block has only a few pages in use.
2690          */
2691
2692         dev->nonAggressiveSkip--;
2693
2694         if (!aggressive && (dev->nonAggressiveSkip > 0)) {
2695                 return -1;
2696         }
2697
2698         if(!prioritised)
2699                 pagesInUse =
2700                         (aggressive) ? dev->nChunksPerBlock : YAFFS_PASSIVE_GC_CHUNKS + 1;
2701
2702         if (aggressive) {
2703                 iterations =
2704                     dev->internalEndBlock - dev->internalStartBlock + 1;
2705         } else {
2706                 iterations =
2707                     dev->internalEndBlock - dev->internalStartBlock + 1;
2708                 iterations = iterations / 16;
2709                 if (iterations > 200) {
2710                         iterations = 200;
2711                 }
2712         }
2713
2714         for (i = 0; i <= iterations && pagesInUse > 0 && !prioritised; i++) {
2715                 b++;
2716                 if (b < dev->internalStartBlock || b > dev->internalEndBlock) {
2717                         b = dev->internalStartBlock;
2718                 }
2719
2720                 if (b < dev->internalStartBlock || b > dev->internalEndBlock) {
2721                         T(YAFFS_TRACE_ERROR,
2722                           (TSTR("**>> Block %d is not valid" TENDSTR), b));
2723                         YBUG();
2724                 }
2725
2726                 bi = yaffs_GetBlockInfo(dev, b);
2727
2728 #if 0
2729                 if (bi->blockState == YAFFS_BLOCK_STATE_CHECKPOINT) {
2730                         dirtiest = b;
2731                         pagesInUse = 0;
2732                 }
2733                 else
2734 #endif
2735
2736                 if (bi->blockState == YAFFS_BLOCK_STATE_FULL &&
2737                        (bi->pagesInUse - bi->softDeletions) < pagesInUse &&
2738                         yaffs_BlockNotDisqualifiedFromGC(dev, bi)) {
2739                         dirtiest = b;
2740                         pagesInUse = (bi->pagesInUse - bi->softDeletions);
2741                 }
2742         }
2743
2744         dev->currentDirtyChecker = b;
2745
2746         if (dirtiest > 0) {
2747                 T(YAFFS_TRACE_GC,
2748                   (TSTR("GC Selected block %d with %d free, prioritised:%d" TENDSTR), dirtiest,
2749                    dev->nChunksPerBlock - pagesInUse,prioritised));
2750         }
2751
2752         dev->oldestDirtySequence = 0;
2753
2754         if (dirtiest > 0) {
2755                 dev->nonAggressiveSkip = 4;
2756         }
2757
2758         return dirtiest;
2759 }
2760
2761 static void yaffs_BlockBecameDirty(yaffs_Device * dev, int blockNo)
2762 {
2763         yaffs_BlockInfo *bi = yaffs_GetBlockInfo(dev, blockNo);
2764
2765         int erasedOk = 0;
2766
2767         /* If the block is still healthy erase it and mark as clean.
2768          * If the block has had a data failure, then retire it.
2769          */
2770
2771         T(YAFFS_TRACE_GC | YAFFS_TRACE_ERASE,
2772                 (TSTR("yaffs_BlockBecameDirty block %d state %d %s"TENDSTR),
2773                 blockNo, bi->blockState, (bi->needsRetiring) ? "needs retiring" : ""));
2774
2775         bi->blockState = YAFFS_BLOCK_STATE_DIRTY;
2776
2777         if (!bi->needsRetiring) {
2778                 yaffs_InvalidateCheckpoint(dev);
2779                 erasedOk = yaffs_EraseBlockInNAND(dev, blockNo);
2780                 if (!erasedOk) {
2781                         dev->nErasureFailures++;
2782                         T(YAFFS_TRACE_ERROR | YAFFS_TRACE_BAD_BLOCKS,
2783                           (TSTR("**>> Erasure failed %d" TENDSTR), blockNo));
2784                 }
2785         }
2786
2787         if (erasedOk &&
2788             ((yaffs_traceMask & YAFFS_TRACE_ERASE) || !yaffs_SkipVerification(dev))) {
2789                 int i;
2790                 for (i = 0; i < dev->nChunksPerBlock; i++) {
2791                         if (!yaffs_CheckChunkErased
2792                             (dev, blockNo * dev->nChunksPerBlock + i)) {
2793                                 T(YAFFS_TRACE_ERROR,
2794                                   (TSTR
2795                                    (">>Block %d erasure supposedly OK, but chunk %d not erased"
2796                                     TENDSTR), blockNo, i));
2797                         }
2798                 }
2799         }
2800
2801         if (erasedOk) {
2802                 /* Clean it up... */
2803                 bi->blockState = YAFFS_BLOCK_STATE_EMPTY;
2804                 dev->nErasedBlocks++;
2805                 bi->pagesInUse = 0;
2806                 bi->softDeletions = 0;
2807                 bi->hasShrinkHeader = 0;
2808                 bi->skipErasedCheck = 1;  /* This is clean, so no need to check */
2809                 bi->gcPrioritise = 0;
2810                 yaffs_ClearChunkBits(dev, blockNo);
2811
2812                 T(YAFFS_TRACE_ERASE,
2813                   (TSTR("Erased block %d" TENDSTR), blockNo));
2814         } else {
2815                 dev->nFreeChunks -= dev->nChunksPerBlock;       /* We lost a block of free space */
2816
2817                 yaffs_RetireBlock(dev, blockNo);
2818                 T(YAFFS_TRACE_ERROR | YAFFS_TRACE_BAD_BLOCKS,
2819                   (TSTR("**>> Block %d retired" TENDSTR), blockNo));
2820         }
2821 }
2822
2823 static int yaffs_FindBlockForAllocation(yaffs_Device * dev)
2824 {
2825         int i;
2826
2827         yaffs_BlockInfo *bi;
2828
2829         if (dev->nErasedBlocks < 1) {
2830                 /* Hoosterman we've got a problem.
2831                  * Can't get space to gc
2832                  */
2833                 T(YAFFS_TRACE_ERROR,
2834                   (TSTR("yaffs tragedy: no more erased blocks" TENDSTR)));
2835
2836                 return -1;
2837         }
2838
2839         /* Find an empty block. */
2840
2841         for (i = dev->internalStartBlock; i <= dev->internalEndBlock; i++) {
2842                 dev->allocationBlockFinder++;
2843                 if (dev->allocationBlockFinder < dev->internalStartBlock
2844                     || dev->allocationBlockFinder > dev->internalEndBlock) {
2845                         dev->allocationBlockFinder = dev->internalStartBlock;
2846                 }
2847
2848                 bi = yaffs_GetBlockInfo(dev, dev->allocationBlockFinder);
2849
2850                 if (bi->blockState == YAFFS_BLOCK_STATE_EMPTY) {
2851                         bi->blockState = YAFFS_BLOCK_STATE_ALLOCATING;
2852                         dev->sequenceNumber++;
2853                         bi->sequenceNumber = dev->sequenceNumber;
2854                         dev->nErasedBlocks--;
2855                         T(YAFFS_TRACE_ALLOCATE,
2856                           (TSTR("Allocated block %d, seq  %d, %d left" TENDSTR),
2857                            dev->allocationBlockFinder, dev->sequenceNumber,
2858                            dev->nErasedBlocks));
2859                         return dev->allocationBlockFinder;
2860                 }
2861         }
2862
2863         T(YAFFS_TRACE_ALWAYS,
2864           (TSTR
2865            ("yaffs tragedy: no more erased blocks, but there should have been %d"
2866             TENDSTR), dev->nErasedBlocks));
2867
2868         return -1;
2869 }
2870
2871
2872
2873 static int yaffs_CalcCheckpointBlocksRequired(yaffs_Device *dev)
2874 {
2875         if(!dev->nCheckpointBlocksRequired &&
2876            dev->isYaffs2){
2877                 /* Not a valid value so recalculate */
2878                 int nBytes = 0;
2879                 int nBlocks;
2880                 int devBlocks = (dev->endBlock - dev->startBlock + 1);
2881                 int tnodeSize;
2882
2883                 tnodeSize = (dev->tnodeWidth * YAFFS_NTNODES_LEVEL0)/8;
2884
2885                 if(tnodeSize < sizeof(yaffs_Tnode))
2886                         tnodeSize = sizeof(yaffs_Tnode);
2887
2888                 nBytes += sizeof(yaffs_CheckpointValidity);
2889                 nBytes += sizeof(yaffs_CheckpointDevice);
2890                 nBytes += devBlocks * sizeof(yaffs_BlockInfo);
2891                 nBytes += devBlocks * dev->chunkBitmapStride;
2892                 nBytes += (sizeof(yaffs_CheckpointObject) + sizeof(__u32)) * (dev->nObjectsCreated - dev->nFreeObjects);
2893                 nBytes += (tnodeSize + sizeof(__u32)) * (dev->nTnodesCreated - dev->nFreeTnodes);
2894                 nBytes += sizeof(yaffs_CheckpointValidity);
2895                 nBytes += sizeof(__u32); /* checksum*/
2896
2897                 /* Round up and add 2 blocks to allow for some bad blocks, so add 3 */
2898
2899                 nBlocks = (nBytes/(dev->nDataBytesPerChunk * dev->nChunksPerBlock)) + 3;
2900
2901                 dev->nCheckpointBlocksRequired = nBlocks;
2902         }
2903
2904         return dev->nCheckpointBlocksRequired;
2905 }
2906
2907 // Check if there's space to allocate...
2908 // Thinks.... do we need top make this ths same as yaffs_GetFreeChunks()?
2909 static int yaffs_CheckSpaceForAllocation(yaffs_Device * dev)
2910 {
2911         int reservedChunks;
2912         int reservedBlocks = dev->nReservedBlocks;
2913         int checkpointBlocks;
2914
2915         if(dev->isYaffs2){
2916                 checkpointBlocks =  yaffs_CalcCheckpointBlocksRequired(dev) -
2917                                     dev->blocksInCheckpoint;
2918                 if(checkpointBlocks < 0)
2919                         checkpointBlocks = 0;
2920         } else {
2921                 checkpointBlocks =0;
2922         }
2923
2924         reservedChunks = ((reservedBlocks + checkpointBlocks) * dev->nChunksPerBlock);
2925
2926         return (dev->nFreeChunks > reservedChunks);
2927 }
2928
2929 static int yaffs_AllocateChunk(yaffs_Device * dev, int useReserve, yaffs_BlockInfo **blockUsedPtr)
2930 {
2931         int retVal;
2932         yaffs_BlockInfo *bi;
2933
2934         if (dev->allocationBlock < 0) {
2935                 /* Get next block to allocate off */
2936                 dev->allocationBlock = yaffs_FindBlockForAllocation(dev);
2937                 dev->allocationPage = 0;
2938         }
2939
2940         if (!useReserve && !yaffs_CheckSpaceForAllocation(dev)) {
2941                 /* Not enough space to allocate unless we're allowed to use the reserve. */
2942                 return -1;
2943         }
2944
2945         if (dev->nErasedBlocks < dev->nReservedBlocks
2946             && dev->allocationPage == 0) {
2947                 T(YAFFS_TRACE_ALLOCATE, (TSTR("Allocating reserve" TENDSTR)));
2948         }
2949
2950         /* Next page please.... */
2951         if (dev->allocationBlock >= 0) {
2952                 bi = yaffs_GetBlockInfo(dev, dev->allocationBlock);
2953
2954                 retVal = (dev->allocationBlock * dev->nChunksPerBlock) +
2955                     dev->allocationPage;
2956                 bi->pagesInUse++;
2957                 yaffs_SetChunkBit(dev, dev->allocationBlock,
2958                                   dev->allocationPage);
2959
2960                 dev->allocationPage++;
2961
2962                 dev->nFreeChunks--;
2963
2964                 /* If the block is full set the state to full */
2965                 if (dev->allocationPage >= dev->nChunksPerBlock) {
2966                         bi->blockState = YAFFS_BLOCK_STATE_FULL;
2967                         dev->allocationBlock = -1;
2968                 }
2969
2970                 if(blockUsedPtr)
2971                         *blockUsedPtr = bi;
2972
2973                 return retVal;
2974         }
2975
2976         T(YAFFS_TRACE_ERROR,
2977           (TSTR("!!!!!!!!! Allocator out !!!!!!!!!!!!!!!!!" TENDSTR)));
2978
2979         return -1;
2980 }
2981
2982 static int yaffs_GetErasedChunks(yaffs_Device * dev)
2983 {
2984         int n;
2985
2986         n = dev->nErasedBlocks * dev->nChunksPerBlock;
2987
2988         if (dev->allocationBlock > 0) {
2989                 n += (dev->nChunksPerBlock - dev->allocationPage);
2990         }
2991
2992         return n;
2993
2994 }
2995
2996 static int yaffs_GarbageCollectBlock(yaffs_Device * dev, int block)
2997 {
2998         int oldChunk;
2999         int newChunk;
3000         int chunkInBlock;
3001         int markNAND;
3002         int retVal = YAFFS_OK;
3003         int cleanups = 0;
3004         int i;
3005         int isCheckpointBlock;
3006         int matchingChunk;
3007
3008         int chunksBefore = yaffs_GetErasedChunks(dev);
3009         int chunksAfter;
3010
3011         yaffs_ExtendedTags tags;
3012
3013         yaffs_BlockInfo *bi = yaffs_GetBlockInfo(dev, block);
3014
3015         yaffs_Object *object;
3016
3017         isCheckpointBlock = (bi->blockState == YAFFS_BLOCK_STATE_CHECKPOINT);
3018
3019         bi->blockState = YAFFS_BLOCK_STATE_COLLECTING;
3020
3021         T(YAFFS_TRACE_TRACING,
3022           (TSTR("Collecting block %d, in use %d, shrink %d, " TENDSTR), block,
3023            bi->pagesInUse, bi->hasShrinkHeader));
3024
3025         /*yaffs_VerifyFreeChunks(dev); */
3026
3027         bi->hasShrinkHeader = 0;        /* clear the flag so that the block can erase */
3028
3029         /* Take off the number of soft deleted entries because
3030          * they're going to get really deleted during GC.
3031          */
3032         dev->nFreeChunks -= bi->softDeletions;
3033
3034         dev->isDoingGC = 1;
3035
3036         if (isCheckpointBlock ||
3037             !yaffs_StillSomeChunkBits(dev, block)) {
3038                 T(YAFFS_TRACE_TRACING,
3039                   (TSTR
3040                    ("Collecting block %d that has no chunks in use" TENDSTR),
3041                    block));
3042                 yaffs_BlockBecameDirty(dev, block);
3043         } else {
3044
3045                 __u8 *buffer = yaffs_GetTempBuffer(dev, __LINE__);
3046
3047                 yaffs_VerifyBlock(dev,bi,block);
3048
3049                 for (chunkInBlock = 0, oldChunk = block * dev->nChunksPerBlock;
3050                      retVal == YAFFS_OK &&
3051                      chunkInBlock < dev->nChunksPerBlock
3052                      && yaffs_StillSomeChunkBits(dev, block);
3053                      chunkInBlock++, oldChunk++) {
3054                         if (yaffs_CheckChunkBit(dev, block, chunkInBlock)) {
3055
3056                                 /* This page is in use and might need to be copied off */
3057
3058                                 markNAND = 1;
3059
3060                                 yaffs_InitialiseTags(&tags);
3061
3062                                 yaffs_ReadChunkWithTagsFromNAND(dev, oldChunk,
3063                                                                 buffer, &tags);
3064
3065                                 object =
3066                                     yaffs_FindObjectByNumber(dev,
3067                                                              tags.objectId);
3068
3069                                 T(YAFFS_TRACE_GC_DETAIL,
3070                                   (TSTR
3071                                    ("Collecting page %d, %d %d %d " TENDSTR),
3072                                    chunkInBlock, tags.objectId, tags.chunkId,
3073                                    tags.byteCount));
3074
3075                                 if(object && !yaffs_SkipVerification(dev)){
3076                                         if(tags.chunkId == 0)
3077                                                 matchingChunk = object->hdrChunk;
3078                                         else if(object->softDeleted)
3079                                                 matchingChunk = oldChunk; /* Defeat the test */
3080                                         else
3081                                                 matchingChunk = yaffs_FindChunkInFile(object,tags.chunkId,NULL);
3082
3083                                         if(oldChunk != matchingChunk)
3084                                                 T(YAFFS_TRACE_ERROR,
3085                                                   (TSTR("gc: page in gc mismatch: %d %d %d %d"TENDSTR),
3086                                                   oldChunk,matchingChunk,tags.objectId, tags.chunkId));
3087
3088                                 }
3089
3090                                 if (!object) {
3091                                         T(YAFFS_TRACE_ERROR,
3092                                           (TSTR
3093                                            ("page %d in gc has no object: %d %d %d "
3094                                             TENDSTR), oldChunk,
3095                                             tags.objectId, tags.chunkId, tags.byteCount));
3096                                 }
3097
3098                                 if (object &&
3099                                     object->deleted &&
3100                                     object->softDeleted &&
3101                                     tags.chunkId != 0) {
3102                                         /* Data chunk in a soft deleted file, throw it away
3103                                          * It's a soft deleted data chunk,
3104                                          * No need to copy this, just forget about it and
3105                                          * fix up the object.
3106                                          */
3107
3108                                         object->nDataChunks--;
3109
3110                                         if (object->nDataChunks <= 0) {
3111                                                 /* remeber to clean up the object */
3112                                                 dev->gcCleanupList[cleanups] =
3113                                                     tags.objectId;
3114                                                 cleanups++;
3115                                         }
3116                                         markNAND = 0;
3117                                 } else if (0
3118                                            /* Todo object && object->deleted && object->nDataChunks == 0 */
3119                                            ) {
3120                                         /* Deleted object header with no data chunks.
3121                                          * Can be discarded and the file deleted.
3122                                          */
3123                                         object->hdrChunk = 0;
3124                                         yaffs_FreeTnode(object->myDev,
3125                                                         object->variant.
3126                                                         fileVariant.top);
3127                                         object->variant.fileVariant.top = NULL;
3128                                         yaffs_DoGenericObjectDeletion(object);
3129
3130                                 } else if (object) {
3131                                         /* It's either a data chunk in a live file or
3132                                          * an ObjectHeader, so we're interested in it.
3133                                          * NB Need to keep the ObjectHeaders of deleted files
3134                                          * until the whole file has been deleted off
3135                                          */
3136                                         tags.serialNumber++;
3137
3138                                         dev->nGCCopies++;
3139
3140                                         if (tags.chunkId == 0) {
3141                                                 /* It is an object Id,
3142                                                  * We need to nuke the shrinkheader flags first
3143                                                  * We no longer want the shrinkHeader flag since its work is done
3144                                                  * and if it is left in place it will mess up scanning.
3145                                                  * Also, clear out any shadowing stuff
3146                                                  */
3147
3148                                                 yaffs_ObjectHeader *oh;
3149                                                 oh = (yaffs_ObjectHeader *)buffer;
3150                                                 oh->isShrink = 0;
3151                                                 tags.extraShadows = 0;
3152                                                 tags.extraIsShrinkHeader = 0;
3153
3154                                                 yaffs_VerifyObjectHeader(object,oh,&tags,1);
3155                                         }
3156
3157                                         newChunk =
3158                                             yaffs_WriteNewChunkWithTagsToNAND(dev, buffer, &tags, 1);
3159
3160                                         if (newChunk < 0) {
3161                                                 retVal = YAFFS_FAIL;
3162                                         } else {
3163
3164                                                 /* Ok, now fix up the Tnodes etc. */
3165
3166                                                 if (tags.chunkId == 0) {
3167                                                         /* It's a header */
3168                                                         object->hdrChunk =  newChunk;
3169                                                         object->serial =   tags.serialNumber;
3170                                                 } else {
3171                                                         /* It's a data chunk */
3172                                                         yaffs_PutChunkIntoFile
3173                                                             (object,
3174                                                              tags.chunkId,
3175                                                              newChunk, 0);
3176                                                 }
3177                                         }
3178                                 }
3179
3180                                 if(retVal == YAFFS_OK)
3181                                         yaffs_DeleteChunk(dev, oldChunk, markNAND, __LINE__);
3182
3183                         }
3184                 }
3185
3186                 yaffs_ReleaseTempBuffer(dev, buffer, __LINE__);
3187
3188
3189                 /* Do any required cleanups */
3190                 for (i = 0; i < cleanups; i++) {
3191                         /* Time to delete the file too */
3192                         object =
3193                             yaffs_FindObjectByNumber(dev,
3194                                                      dev->gcCleanupList[i]);
3195                         if (object) {
3196                                 yaffs_FreeTnode(dev,
3197                                                 object->variant.fileVariant.
3198                                                 top);
3199                                 object->variant.fileVariant.top = NULL;
3200                                 T(YAFFS_TRACE_GC,
3201                                   (TSTR
3202                                    ("yaffs: About to finally delete object %d"
3203                                     TENDSTR), object->objectId));
3204                                 yaffs_DoGenericObjectDeletion(object);
3205                                 object->myDev->nDeletedFiles--;
3206                         }
3207
3208                 }
3209
3210         }
3211
3212         yaffs_VerifyCollectedBlock(dev,bi,block);
3213
3214         if (chunksBefore >= (chunksAfter = yaffs_GetErasedChunks(dev))) {
3215                 T(YAFFS_TRACE_GC,
3216                   (TSTR
3217                    ("gc did not increase free chunks before %d after %d"
3218                     TENDSTR), chunksBefore, chunksAfter));
3219         }
3220
3221         dev->isDoingGC = 0;
3222
3223         return retVal;
3224 }
3225
3226 /* New garbage collector
3227  * If we're very low on erased blocks then we do aggressive garbage collection
3228  * otherwise we do "leasurely" garbage collection.
3229  * Aggressive gc looks further (whole array) and will accept less dirty blocks.
3230  * Passive gc only inspects smaller areas and will only accept more dirty blocks.
3231  *
3232  * The idea is to help clear out space in a more spread-out manner.
3233  * Dunno if it really does anything useful.
3234  */
3235 static int yaffs_CheckGarbageCollection(yaffs_Device * dev)
3236 {
3237         int block;
3238         int aggressive;
3239         int gcOk = YAFFS_OK;
3240         int maxTries = 0;
3241
3242         int checkpointBlockAdjust;
3243
3244         if (dev->isDoingGC) {
3245                 /* Bail out so we don't get recursive gc */
3246                 return YAFFS_OK;
3247         }
3248
3249         /* This loop should pass the first time.
3250          * We'll only see looping here if the erase of the collected block fails.
3251          */
3252
3253         do {
3254                 maxTries++;
3255
3256                 checkpointBlockAdjust = yaffs_CalcCheckpointBlocksRequired(dev) - dev->blocksInCheckpoint;
3257                 if(checkpointBlockAdjust < 0)
3258                         checkpointBlockAdjust = 0;
3259
3260                 if (dev->nErasedBlocks < (dev->nReservedBlocks + checkpointBlockAdjust + 2)) {
3261                         /* We need a block soon...*/
3262                         aggressive = 1;
3263                 } else {
3264                         /* We're in no hurry */
3265                         aggressive = 0;
3266                 }
3267
3268                 block = yaffs_FindBlockForGarbageCollection(dev, aggressive);
3269
3270                 if (block > 0) {
3271                         dev->garbageCollections++;
3272                         if (!aggressive) {
3273                                 dev->passiveGarbageCollections++;
3274                         }
3275
3276                         T(YAFFS_TRACE_GC,
3277                           (TSTR
3278                            ("yaffs: GC erasedBlocks %d aggressive %d" TENDSTR),
3279                            dev->nErasedBlocks, aggressive));
3280
3281                         gcOk = yaffs_GarbageCollectBlock(dev, block);
3282                 }
3283
3284                 if (dev->nErasedBlocks < (dev->nReservedBlocks) && block > 0) {
3285                         T(YAFFS_TRACE_GC,
3286                           (TSTR
3287                            ("yaffs: GC !!!no reclaim!!! erasedBlocks %d after try %d block %d"
3288                             TENDSTR), dev->nErasedBlocks, maxTries, block));
3289                 }
3290         } while ((dev->nErasedBlocks < dev->nReservedBlocks) && (block > 0)
3291                  && (maxTries < 2));
3292
3293         return aggressive ? gcOk : YAFFS_OK;
3294 }
3295
3296 /*-------------------------  TAGS --------------------------------*/
3297
3298 static int yaffs_TagsMatch(const yaffs_ExtendedTags * tags, int objectId,
3299                            int chunkInObject)
3300 {
3301         return (tags->chunkId == chunkInObject &&
3302                 tags->objectId == objectId && !tags->chunkDeleted) ? 1 : 0;
3303
3304 }
3305
3306
3307 /*-------------------- Data file manipulation -----------------*/
3308
3309 static int yaffs_FindChunkInFile(yaffs_Object * in, int chunkInInode,
3310                                  yaffs_ExtendedTags * tags)
3311 {
3312         /*Get the Tnode, then get the level 0 offset chunk offset */
3313         yaffs_Tnode *tn;
3314         int theChunk = -1;
3315         yaffs_ExtendedTags localTags;
3316         int retVal = -1;
3317
3318         yaffs_Device *dev = in->myDev;
3319
3320         if (!tags) {
3321                 /* Passed a NULL, so use our own tags space */
3322                 tags = &localTags;
3323         }
3324
3325         tn = yaffs_FindLevel0Tnode(dev, &in->variant.fileVariant, chunkInInode);
3326
3327         if (tn) {
3328                 theChunk = yaffs_GetChunkGroupBase(dev,tn,chunkInInode);
3329
3330                 retVal =
3331                     yaffs_FindChunkInGroup(dev, theChunk, tags, in->objectId,
3332                                            chunkInInode);
3333         }
3334         return retVal;
3335 }
3336
3337 static int yaffs_FindAndDeleteChunkInFile(yaffs_Object * in, int chunkInInode,
3338                                           yaffs_ExtendedTags * tags)
3339 {
3340         /* Get the Tnode, then get the level 0 offset chunk offset */
3341         yaffs_Tnode *tn;
3342         int theChunk = -1;
3343         yaffs_ExtendedTags localTags;
3344
3345         yaffs_Device *dev = in->myDev;
3346         int retVal = -1;
3347
3348         if (!tags) {
3349                 /* Passed a NULL, so use our own tags space */
3350                 tags = &localTags;
3351         }
3352
3353         tn = yaffs_FindLevel0Tnode(dev, &in->variant.fileVariant, chunkInInode);
3354
3355         if (tn) {
3356
3357                 theChunk = yaffs_GetChunkGroupBase(dev,tn,chunkInInode);
3358
3359                 retVal =
3360                     yaffs_FindChunkInGroup(dev, theChunk, tags, in->objectId,
3361                                            chunkInInode);
3362
3363                 /* Delete the entry in the filestructure (if found) */
3364                 if (retVal != -1) {
3365                         yaffs_PutLevel0Tnode(dev,tn,chunkInInode,0);
3366                 }
3367         } else {
3368                 /*T(("No level 0 found for %d\n", chunkInInode)); */
3369         }
3370
3371         if (retVal == -1) {
3372                 /* T(("Could not find %d to delete\n",chunkInInode)); */
3373         }
3374         return retVal;
3375 }
3376
3377 #ifdef YAFFS_PARANOID
3378
3379 static int yaffs_CheckFileSanity(yaffs_Object * in)
3380 {
3381         int chunk;
3382         int nChunks;
3383         int fSize;
3384         int failed = 0;
3385         int objId;
3386         yaffs_Tnode *tn;
3387         yaffs_Tags localTags;
3388         yaffs_Tags *tags = &localTags;
3389         int theChunk;
3390         int chunkDeleted;
3391
3392         if (in->variantType != YAFFS_OBJECT_TYPE_FILE) {
3393                 /* T(("Object not a file\n")); */
3394                 return YAFFS_FAIL;
3395         }
3396
3397         objId = in->objectId;
3398         fSize = in->variant.fileVariant.fileSize;
3399         nChunks =
3400             (fSize + in->myDev->nDataBytesPerChunk - 1) / in->myDev->nDataBytesPerChunk;
3401
3402         for (chunk = 1; chunk <= nChunks; chunk++) {
3403                 tn = yaffs_FindLevel0Tnode(in->myDev, &in->variant.fileVariant,
3404                                            chunk);
3405
3406                 if (tn) {
3407
3408                         theChunk = yaffs_GetChunkGroupBase(dev,tn,chunk);
3409
3410                         if (yaffs_CheckChunkBits
3411                             (dev, theChunk / dev->nChunksPerBlock,
3412                              theChunk % dev->nChunksPerBlock)) {
3413
3414                                 yaffs_ReadChunkTagsFromNAND(in->myDev, theChunk,
3415                                                             tags,
3416                                                             &chunkDeleted);
3417                                 if (yaffs_TagsMatch
3418                                     (tags, in->objectId, chunk, chunkDeleted)) {
3419                                         /* found it; */
3420
3421                                 }
3422                         } else {
3423
3424                                 failed = 1;
3425                         }
3426
3427                 } else {
3428                         /* T(("No level 0 found for %d\n", chunk)); */
3429                 }
3430         }
3431
3432         return failed ? YAFFS_FAIL : YAFFS_OK;
3433 }
3434
3435 #endif
3436
3437 static int yaffs_PutChunkIntoFile(yaffs_Object * in, int chunkInInode,
3438                                   int chunkInNAND, int inScan)
3439 {
3440         /* NB inScan is zero unless scanning.
3441          * For forward scanning, inScan is > 0;
3442          * for backward scanning inScan is < 0
3443          */
3444
3445         yaffs_Tnode *tn;
3446         yaffs_Device *dev = in->myDev;
3447         int existingChunk;
3448         yaffs_ExtendedTags existingTags;
3449         yaffs_ExtendedTags newTags;
3450         unsigned existingSerial, newSerial;
3451
3452         if (in->variantType != YAFFS_OBJECT_TYPE_FILE) {
3453                 /* Just ignore an attempt at putting a chunk into a non-file during scanning
3454                  * If it is not during Scanning then something went wrong!
3455                  */
3456                 if (!inScan) {
3457                         T(YAFFS_TRACE_ERROR,
3458                           (TSTR
3459                            ("yaffs tragedy:attempt to put data chunk into a non-file"
3460                             TENDSTR)));
3461                         YBUG();
3462                 }
3463
3464                 yaffs_DeleteChunk(dev, chunkInNAND, 1, __LINE__);
3465                 return YAFFS_OK;
3466         }
3467
3468         tn = yaffs_AddOrFindLevel0Tnode(dev,
3469                                         &in->variant.fileVariant,
3470                                         chunkInInode,
3471                                         NULL);
3472         if (!tn) {
3473                 return YAFFS_FAIL;
3474         }
3475
3476         existingChunk = yaffs_GetChunkGroupBase(dev,tn,chunkInInode);
3477
3478         if (inScan != 0) {
3479                 /* If we're scanning then we need to test for duplicates
3480                  * NB This does not need to be efficient since it should only ever
3481                  * happen when the power fails during a write, then only one
3482                  * chunk should ever be affected.
3483                  *
3484                  * Correction for YAFFS2: This could happen quite a lot and we need to think about efficiency! TODO
3485                  * Update: For backward scanning we don't need to re-read tags so this is quite cheap.
3486                  */
3487
3488                 if (existingChunk > 0) {
3489                         /* NB Right now existing chunk will not be real chunkId if the device >= 32MB
3490                          *    thus we have to do a FindChunkInFile to get the real chunk id.
3491                          *
3492                          * We have a duplicate now we need to decide which one to use:
3493                          *
3494                          * Backwards scanning YAFFS2: The old one is what we use, dump the new one.
3495                          * Forward scanning YAFFS2: The new one is what we use, dump the old one.
3496                          * YAFFS1: Get both sets of tags and compare serial numbers.
3497                          */
3498
3499                         if (inScan > 0) {
3500                                 /* Only do this for forward scanning */
3501                                 yaffs_ReadChunkWithTagsFromNAND(dev,
3502                                                                 chunkInNAND,
3503                                                                 NULL, &newTags);
3504
3505                                 /* Do a proper find */
3506                                 existingChunk =
3507                                     yaffs_FindChunkInFile(in, chunkInInode,
3508                                                           &existingTags);
3509                         }
3510
3511                         if (existingChunk <= 0) {
3512                                 /*Hoosterman - how did this happen? */
3513
3514                                 T(YAFFS_TRACE_ERROR,
3515                                   (TSTR
3516                                    ("yaffs tragedy: existing chunk < 0 in scan"
3517                                     TENDSTR)));
3518
3519                         }
3520
3521                         /* NB The deleted flags should be false, otherwise the chunks will
3522                          * not be loaded during a scan
3523                          */
3524
3525                         if(inScan > 0) {
3526                                 newSerial = newTags.serialNumber;
3527                                 existingSerial = existingTags.serialNumber;
3528                         }
3529
3530                         if ((inScan > 0) &&
3531                             (in->myDev->isYaffs2 ||
3532                              existingChunk <= 0 ||
3533                              ((existingSerial + 1) & 3) == newSerial)) {
3534                                 /* Forward scanning.
3535                                  * Use new
3536                                  * Delete the old one and drop through to update the tnode
3537                                  */
3538                                 yaffs_DeleteChunk(dev, existingChunk, 1,
3539                                                   __LINE__);
3540                         } else {
3541                                 /* Backward scanning or we want to use the existing one
3542                                  * Use existing.
3543                                  * Delete the new one and return early so that the tnode isn't changed
3544                                  */
3545                                 yaffs_DeleteChunk(dev, chunkInNAND, 1,
3546                                                   __LINE__);
3547                                 return YAFFS_OK;
3548                         }
3549                 }
3550
3551         }
3552
3553         if (existingChunk == 0) {
3554                 in->nDataChunks++;
3555         }
3556
3557         yaffs_PutLevel0Tnode(dev,tn,chunkInInode,chunkInNAND);
3558
3559         return YAFFS_OK;
3560 }
3561
3562 static int yaffs_ReadChunkDataFromObject(yaffs_Object * in, int chunkInInode,
3563                                          __u8 * buffer)
3564 {
3565         int chunkInNAND = yaffs_FindChunkInFile(in, chunkInInode, NULL);
3566
3567         if (chunkInNAND >= 0) {
3568                 return yaffs_ReadChunkWithTagsFromNAND(in->myDev, chunkInNAND,
3569                                                        buffer,NULL);
3570         } else {
3571                 T(YAFFS_TRACE_NANDACCESS,
3572                   (TSTR("Chunk %d not found zero instead" TENDSTR),
3573                    chunkInNAND));
3574                 /* get sane (zero) data if you read a hole */
3575                 memset(buffer, 0, in->myDev->nDataBytesPerChunk);
3576                 return 0;
3577         }
3578
3579 }
3580
3581 void yaffs_DeleteChunk(yaffs_Device * dev, int chunkId, int markNAND, int lyn)
3582 {
3583         int block;
3584         int page;
3585         yaffs_ExtendedTags tags;
3586         yaffs_BlockInfo *bi;
3587
3588         if (chunkId <= 0)
3589                 return;
3590
3591
3592         dev->nDeletions++;
3593         block = chunkId / dev->nChunksPerBlock;
3594         page = chunkId % dev->nChunksPerBlock;
3595
3596
3597         if(!yaffs_CheckChunkBit(dev,block,page))
3598                 T(YAFFS_TRACE_VERIFY,
3599                         (TSTR("Deleting invalid chunk %d"TENDSTR),
3600                          chunkId));
3601
3602         bi = yaffs_GetBlockInfo(dev, block);
3603
3604         T(YAFFS_TRACE_DELETION,
3605           (TSTR("line %d delete of chunk %d" TENDSTR), lyn, chunkId));
3606
3607         if (markNAND &&
3608             bi->blockState != YAFFS_BLOCK_STATE_COLLECTING && !dev->isYaffs2) {
3609
3610                 yaffs_InitialiseTags(&tags);
3611
3612                 tags.chunkDeleted = 1;
3613
3614                 yaffs_WriteChunkWithTagsToNAND(dev, chunkId, NULL, &tags);
3615                 yaffs_HandleUpdateChunk(dev, chunkId, &tags);
3616         } else {
3617                 dev->nUnmarkedDeletions++;
3618         }
3619
3620         /* Pull out of the management area.
3621          * If the whole block became dirty, this will kick off an erasure.
3622          */
3623         if (bi->blockState == YAFFS_BLOCK_STATE_ALLOCATING ||
3624             bi->blockState == YAFFS_BLOCK_STATE_FULL ||
3625             bi->blockState == YAFFS_BLOCK_STATE_NEEDS_SCANNING ||
3626             bi->blockState == YAFFS_BLOCK_STATE_COLLECTING) {
3627                 dev->nFreeChunks++;
3628
3629                 yaffs_ClearChunkBit(dev, block, page);
3630
3631                 bi->pagesInUse--;
3632
3633                 if (bi->pagesInUse == 0 &&
3634                     !bi->hasShrinkHeader &&
3635                     bi->blockState != YAFFS_BLOCK_STATE_ALLOCATING &&
3636                     bi->blockState != YAFFS_BLOCK_STATE_NEEDS_SCANNING) {
3637                         yaffs_BlockBecameDirty(dev, block);
3638                 }
3639
3640         } else {
3641                 /* T(("Bad news deleting chunk %d\n",chunkId)); */
3642         }
3643
3644 }
3645
3646 static int yaffs_WriteChunkDataToObject(yaffs_Object * in, int chunkInInode,
3647                                         const __u8 * buffer, int nBytes,
3648                                         int useReserve)
3649 {
3650         /* Find old chunk Need to do this to get serial number
3651          * Write new one and patch into tree.
3652          * Invalidate old tags.
3653          */
3654
3655         int prevChunkId;
3656         yaffs_ExtendedTags prevTags;
3657
3658         int newChunkId;
3659         yaffs_ExtendedTags newTags;
3660
3661         yaffs_Device *dev = in->myDev;
3662
3663         yaffs_CheckGarbageCollection(dev);
3664
3665         /* Get the previous chunk at this location in the file if it exists */
3666         prevChunkId = yaffs_FindChunkInFile(in, chunkInInode, &prevTags);
3667
3668         /* Set up new tags */
3669         yaffs_InitialiseTags(&newTags);
3670
3671         newTags.chunkId = chunkInInode;
3672         newTags.objectId = in->objectId;
3673         newTags.serialNumber =
3674             (prevChunkId >= 0) ? prevTags.serialNumber + 1 : 1;
3675         newTags.byteCount = nBytes;
3676
3677         if(nBytes < 1 || nBytes > dev->totalBytesPerChunk){
3678           T(YAFFS_TRACE_ERROR,
3679           (TSTR("Writing %d bytes to chunk!!!!!!!!!" TENDSTR), nBytes));
3680           while(1){}
3681         }
3682
3683
3684
3685         newChunkId =
3686             yaffs_WriteNewChunkWithTagsToNAND(dev, buffer, &newTags,
3687                                               useReserve);
3688
3689         if (newChunkId >= 0) {
3690                 yaffs_PutChunkIntoFile(in, chunkInInode, newChunkId, 0);
3691
3692                 if (prevChunkId >= 0) {
3693                         yaffs_DeleteChunk(dev, prevChunkId, 1, __LINE__);
3694
3695                 }
3696
3697                 yaffs_CheckFileSanity(in);
3698         }
3699         return newChunkId;
3700
3701 }
3702
3703 /* UpdateObjectHeader updates the header on NAND for an object.
3704  * If name is not NULL, then that new name is used.
3705  */
3706 int yaffs_UpdateObjectHeader(yaffs_Object * in, const YCHAR * name, int force,
3707                              int isShrink, int shadows)
3708 {
3709
3710         yaffs_BlockInfo *bi;
3711
3712         yaffs_Device *dev = in->myDev;
3713
3714         int prevChunkId;
3715         int retVal = 0;
3716         int result = 0;
3717
3718         int newChunkId;
3719         yaffs_ExtendedTags newTags;
3720         yaffs_ExtendedTags oldTags;
3721
3722         __u8 *buffer = NULL;
3723         YCHAR oldName[YAFFS_MAX_NAME_LENGTH + 1];
3724
3725         yaffs_ObjectHeader *oh = NULL;
3726
3727         yaffs_strcpy(oldName,_Y("silly old name"));
3728
3729
3730         if (!in->fake ||
3731             in == dev->rootDir || /* The rootDir should also be saved */
3732             force) {
3733
3734                 yaffs_CheckGarbageCollection(dev);
3735                 yaffs_CheckObjectDetailsLoaded(in);
3736
3737                 buffer = yaffs_GetTempBuffer(in->myDev, __LINE__);
3738                 oh = (yaffs_ObjectHeader *) buffer;
3739
3740                 prevChunkId = in->hdrChunk;
3741
3742                 if (prevChunkId > 0) {
3743                         result = yaffs_ReadChunkWithTagsFromNAND(dev, prevChunkId,
3744                                                         buffer, &oldTags);
3745
3746                         yaffs_VerifyObjectHeader(in,oh,&oldTags,0);
3747
3748                         memcpy(oldName, oh->name, sizeof(oh->name));
3749                 }
3750
3751                 memset(buffer, 0xFF, dev->nDataBytesPerChunk);
3752
3753                 oh->type = in->variantType;
3754                 oh->yst_mode = in->yst_mode;
3755                 oh->shadowsObject = oh->inbandShadowsObject = shadows;
3756
3757 #ifdef CONFIG_YAFFS_WINCE
3758                 oh->win_atime[0] = in->win_atime[0];
3759                 oh->win_ctime[0] = in->win_ctime[0];
3760                 oh->win_mtime[0] = in->win_mtime[0];
3761                 oh->win_atime[1] = in->win_atime[1];
3762                 oh->win_ctime[1] = in->win_ctime[1];
3763                 oh->win_mtime[1] = in->win_mtime[1];
3764 #else
3765                 oh->yst_uid = in->yst_uid;
3766                 oh->yst_gid = in->yst_gid;
3767                 oh->yst_atime = in->yst_atime;
3768                 oh->yst_mtime = in->yst_mtime;
3769                 oh->yst_ctime = in->yst_ctime;
3770                 oh->yst_rdev = in->yst_rdev;
3771 #endif
3772                 if (in->parent) {
3773                         oh->parentObjectId = in->parent->objectId;
3774                 } else {
3775                         oh->parentObjectId = 0;
3776                 }
3777
3778                 if (name && *name) {
3779                         memset(oh->name, 0, sizeof(oh->name));
3780                         yaffs_strncpy(oh->name, name, YAFFS_MAX_NAME_LENGTH);
3781                 } else if (prevChunkId>=0) {
3782                         memcpy(oh->name, oldName, sizeof(oh->name));
3783                 } else {
3784                         memset(oh->name, 0, sizeof(oh->name));
3785                 }
3786
3787                 oh->isShrink = isShrink;
3788
3789                 switch (in->variantType) {
3790                 case YAFFS_OBJECT_TYPE_UNKNOWN:
3791                         /* Should not happen */
3792                         break;
3793                 case YAFFS_OBJECT_TYPE_FILE:
3794                         oh->fileSize =
3795                             (oh->parentObjectId == YAFFS_OBJECTID_DELETED
3796                              || oh->parentObjectId ==
3797                              YAFFS_OBJECTID_UNLINKED) ? 0 : in->variant.
3798                             fileVariant.fileSize;
3799                         break;
3800                 case YAFFS_OBJECT_TYPE_HARDLINK:
3801                         oh->equivalentObjectId =
3802                             in->variant.hardLinkVariant.equivalentObjectId;
3803                         break;
3804                 case YAFFS_OBJECT_TYPE_SPECIAL:
3805                         /* Do nothing */
3806                         break;
3807                 case YAFFS_OBJECT_TYPE_DIRECTORY:
3808                         /* Do nothing */
3809                         break;
3810                 case YAFFS_OBJECT_TYPE_SYMLINK:
3811                         yaffs_strncpy(oh->alias,
3812                                       in->variant.symLinkVariant.alias,
3813                                       YAFFS_MAX_ALIAS_LENGTH);
3814                         oh->alias[YAFFS_MAX_ALIAS_LENGTH] = 0;
3815                         break;
3816                 }
3817
3818                 /* Tags */
3819                 yaffs_InitialiseTags(&newTags);
3820                 in->serial++;
3821                 newTags.chunkId = 0;
3822                 newTags.objectId = in->objectId;
3823                 newTags.serialNumber = in->serial;
3824
3825                 /* Add extra info for file header */
3826
3827                 newTags.extraHeaderInfoAvailable = 1;
3828                 newTags.extraParentObjectId = oh->parentObjectId;
3829                 newTags.extraFileLength = oh->fileSize;
3830                 newTags.extraIsShrinkHeader = oh->isShrink;
3831                 newTags.extraEquivalentObjectId = oh->equivalentObjectId;
3832                 newTags.extraShadows = (oh->shadowsObject > 0) ? 1 : 0;
3833                 newTags.extraObjectType = in->variantType;
3834
3835                 yaffs_VerifyObjectHeader(in,oh,&newTags,1);
3836
3837                 /* Create new chunk in NAND */
3838                 newChunkId =
3839                     yaffs_WriteNewChunkWithTagsToNAND(dev, buffer, &newTags,
3840                                                       (prevChunkId >= 0) ? 1 : 0);
3841
3842                 if (newChunkId >= 0) {
3843
3844                         in->hdrChunk = newChunkId;
3845
3846                         if (prevChunkId >= 0) {
3847                                 yaffs_DeleteChunk(dev, prevChunkId, 1,
3848                                                   __LINE__);
3849                         }
3850
3851                         if(!yaffs_ObjectHasCachedWriteData(in))
3852                                 in->dirty = 0;
3853
3854                         /* If this was a shrink, then mark the block that the chunk lives on */
3855                         if (isShrink) {
3856                                 bi = yaffs_GetBlockInfo(in->myDev,
3857                                                         newChunkId /in->myDev-> nChunksPerBlock);
3858                                 bi->hasShrinkHeader = 1;
3859                         }
3860
3861                 }
3862
3863                 retVal = newChunkId;
3864
3865         }
3866
3867         if (buffer)
3868                 yaffs_ReleaseTempBuffer(dev, buffer, __LINE__);
3869
3870         return retVal;
3871 }
3872
3873 /*------------------------ Short Operations Cache ----------------------------------------
3874  *   In many situations where there is no high level buffering (eg WinCE) a lot of
3875  *   reads might be short sequential reads, and a lot of writes may be short
3876  *   sequential writes. eg. scanning/writing a jpeg file.
3877  *   In these cases, a short read/write cache can provide a huge perfomance benefit
3878  *   with dumb-as-a-rock code.
3879  *   In Linux, the page cache provides read buffering aand the short op cache provides write
3880  *   buffering.
3881  *
3882  *   There are a limited number (~10) of cache chunks per device so that we don't
3883  *   need a very intelligent search.
3884  */
3885
3886 static int yaffs_ObjectHasCachedWriteData(yaffs_Object *obj)
3887 {
3888         yaffs_Device *dev = obj->myDev;
3889         int i;
3890         yaffs_ChunkCache *cache;
3891         int nCaches = obj->myDev->nShortOpCaches;
3892
3893         for(i = 0; i < nCaches; i++){
3894                 cache = &dev->srCache[i];
3895                 if (cache->object == obj &&
3896                     cache->dirty)
3897                         return 1;
3898         }
3899
3900         return 0;
3901 }
3902
3903
3904 static void yaffs_FlushFilesChunkCache(yaffs_Object * obj)
3905 {
3906         yaffs_Device *dev = obj->myDev;
3907         int lowest = -99;       /* Stop compiler whining. */
3908         int i;
3909         yaffs_ChunkCache *cache;
3910         int chunkWritten = 0;
3911         int nCaches = obj->myDev->nShortOpCaches;
3912
3913         if (nCaches > 0) {
3914                 do {
3915                         cache = NULL;
3916
3917                         /* Find the dirty cache for this object with the lowest chunk id. */
3918                         for (i = 0; i < nCaches; i++) {
3919                                 if (dev->srCache[i].object == obj &&
3920                                     dev->srCache[i].dirty) {
3921                                         if (!cache
3922                                             || dev->srCache[i].chunkId <
3923                                             lowest) {
3924                                                 cache = &dev->srCache[i];
3925                                                 lowest = cache->chunkId;
3926                                         }
3927                                 }
3928                         }
3929
3930                         if (cache && !cache->locked) {
3931                                 /* Write it out and free it up */
3932
3933                                 chunkWritten =
3934                                     yaffs_WriteChunkDataToObject(cache->object,
3935                                                                  cache->chunkId,
3936                                                                  cache->data,
3937                                                                  cache->nBytes,
3938                                                                  1);
3939                                 cache->dirty = 0;
3940                                 cache->object = NULL;
3941                         }
3942
3943                 } while (cache && chunkWritten > 0);
3944
3945                 if (cache) {
3946                         /* Hoosterman, disk full while writing cache out. */
3947                         T(YAFFS_TRACE_ERROR,
3948                           (TSTR("yaffs tragedy: no space during cache write" TENDSTR)));
3949
3950                 }
3951         }
3952
3953 }
3954
3955 /*yaffs_FlushEntireDeviceCache(dev)
3956  *
3957  *
3958  */
3959
3960 void yaffs_FlushEntireDeviceCache(yaffs_Device *dev)
3961 {
3962         yaffs_Object *obj;
3963         int nCaches = dev->nShortOpCaches;
3964         int i;
3965
3966         /* Find a dirty object in the cache and flush it...
3967          * until there are no further dirty objects.
3968          */
3969         do {
3970                 obj = NULL;
3971                 for( i = 0; i < nCaches && !obj; i++) {
3972                         if (dev->srCache[i].object &&
3973                             dev->srCache[i].dirty)
3974                                 obj = dev->srCache[i].object;
3975
3976                 }
3977                 if(obj)
3978                         yaffs_FlushFilesChunkCache(obj);
3979
3980         } while(obj);
3981
3982 }
3983
3984
3985 /* Grab us a cache chunk for use.
3986  * First look for an empty one.
3987  * Then look for the least recently used non-dirty one.
3988  * Then look for the least recently used dirty one...., flush and look again.
3989  */
3990 static yaffs_ChunkCache *yaffs_GrabChunkCacheWorker(yaffs_Device * dev)
3991 {
3992         int i;
3993
3994         if (dev->nShortOpCaches > 0) {
3995                 for (i = 0; i < dev->nShortOpCaches; i++) {
3996                         if (!dev->srCache[i].object)
3997                                 return &dev->srCache[i];
3998                 }
3999         }
4000
4001         return NULL;
4002 }
4003
4004 static yaffs_ChunkCache *yaffs_GrabChunkCache(yaffs_Device * dev)
4005 {
4006         yaffs_ChunkCache *cache;
4007         yaffs_Object *theObj;
4008         int usage;
4009         int i;
4010         int pushout;
4011
4012         if (dev->nShortOpCaches > 0) {
4013                 /* Try find a non-dirty one... */
4014
4015                 cache = yaffs_GrabChunkCacheWorker(dev);
4016
4017                 if (!cache) {
4018                         /* They were all dirty, find the last recently used object and flush
4019                          * its cache, then  find again.
4020                          * NB what's here is not very accurate, we actually flush the object
4021                          * the last recently used page.
4022                          */
4023
4024                         /* With locking we can't assume we can use entry zero */
4025
4026                         theObj = NULL;
4027                         usage = -1;
4028                         cache = NULL;
4029                         pushout = -1;
4030
4031                         for (i = 0; i < dev->nShortOpCaches; i++) {
4032                                 if (dev->srCache[i].object &&
4033                                     !dev->srCache[i].locked &&
4034                                     (dev->srCache[i].lastUse < usage || !cache))
4035                                 {
4036                                         usage = dev->srCache[i].lastUse;
4037                                         theObj = dev->srCache[i].object;
4038                                         cache = &dev->srCache[i];
4039                                         pushout = i;
4040                                 }
4041                         }
4042
4043                         if (!cache || cache->dirty) {
4044                                 /* Flush and try again */
4045                                 yaffs_FlushFilesChunkCache(theObj);
4046                                 cache = yaffs_GrabChunkCacheWorker(dev);
4047                         }
4048
4049                 }
4050                 return cache;
4051         } else
4052                 return NULL;
4053
4054 }
4055
4056 /* Find a cached chunk */
4057 static yaffs_ChunkCache *yaffs_FindChunkCache(const yaffs_Object * obj,
4058                                               int chunkId)
4059 {
4060         yaffs_Device *dev = obj->myDev;
4061         int i;
4062         if (dev->nShortOpCaches > 0) {
4063                 for (i = 0; i < dev->nShortOpCaches; i++) {
4064                         if (dev->srCache[i].object == obj &&
4065                             dev->srCache[i].chunkId == chunkId) {
4066                                 dev->cacheHits++;
4067
4068                                 return &dev->srCache[i];
4069                         }
4070                 }
4071         }
4072         return NULL;
4073 }
4074
4075 /* Mark the chunk for the least recently used algorithym */
4076 static void yaffs_UseChunkCache(yaffs_Device * dev, yaffs_ChunkCache * cache,
4077                                 int isAWrite)
4078 {
4079
4080         if (dev->nShortOpCaches > 0) {
4081                 if (dev->srLastUse < 0 || dev->srLastUse > 100000000) {
4082                         /* Reset the cache usages */
4083                         int i;
4084                         for (i = 1; i < dev->nShortOpCaches; i++) {
4085                                 dev->srCache[i].lastUse = 0;
4086                         }
4087                         dev->srLastUse = 0;
4088                 }
4089
4090                 dev->srLastUse++;
4091
4092                 cache->lastUse = dev->srLastUse;
4093
4094                 if (isAWrite) {
4095                         cache->dirty = 1;
4096                 }
4097         }
4098 }
4099
4100 /* Invalidate a single cache page.
4101  * Do this when a whole page gets written,
4102  * ie the short cache for this page is no longer valid.
4103  */
4104 static void yaffs_InvalidateChunkCache(yaffs_Object * object, int chunkId)
4105 {
4106         if (object->myDev->nShortOpCaches > 0) {
4107                 yaffs_ChunkCache *cache = yaffs_FindChunkCache(object, chunkId);
4108
4109                 if (cache) {
4110                         cache->object = NULL;
4111                 }
4112         }
4113 }
4114
4115 /* Invalidate all the cache pages associated with this object
4116  * Do this whenever ther file is deleted or resized.
4117  */
4118 static void yaffs_InvalidateWholeChunkCache(yaffs_Object * in)
4119 {
4120         int i;
4121         yaffs_Device *dev = in->myDev;
4122
4123         if (dev->nShortOpCaches > 0) {
4124                 /* Invalidate it. */
4125                 for (i = 0; i < dev->nShortOpCaches; i++) {
4126                         if (dev->srCache[i].object == in) {
4127                                 dev->srCache[i].object = NULL;
4128                         }
4129                 }
4130         }
4131 }
4132
4133 /*--------------------- Checkpointing --------------------*/
4134
4135
4136 static int yaffs_WriteCheckpointValidityMarker(yaffs_Device *dev,int head)
4137 {
4138         yaffs_CheckpointValidity cp;
4139
4140         memset(&cp,0,sizeof(cp));
4141
4142         cp.structType = sizeof(cp);
4143         cp.magic = YAFFS_MAGIC;
4144         cp.version = YAFFS_CHECKPOINT_VERSION;
4145         cp.head = (head) ? 1 : 0;
4146
4147         return (yaffs_CheckpointWrite(dev,&cp,sizeof(cp)) == sizeof(cp))?
4148                 1 : 0;
4149 }
4150
4151 static int yaffs_ReadCheckpointValidityMarker(yaffs_Device *dev, int head)
4152 {
4153         yaffs_CheckpointValidity cp;
4154         int ok;
4155
4156         ok = (yaffs_CheckpointRead(dev,&cp,sizeof(cp)) == sizeof(cp));
4157
4158         if(ok)
4159                 ok = (cp.structType == sizeof(cp)) &&
4160                      (cp.magic == YAFFS_MAGIC) &&
4161                      (cp.version == YAFFS_CHECKPOINT_VERSION) &&
4162                      (cp.head == ((head) ? 1 : 0));
4163         return ok ? 1 : 0;
4164 }
4165
4166 static void yaffs_DeviceToCheckpointDevice(yaffs_CheckpointDevice *cp,
4167                                            yaffs_Device *dev)
4168 {
4169         cp->nErasedBlocks = dev->nErasedBlocks;
4170         cp->allocationBlock = dev->allocationBlock;
4171         cp->allocationPage = dev->allocationPage;
4172         cp->nFreeChunks = dev->nFreeChunks;
4173
4174         cp->nDeletedFiles = dev->nDeletedFiles;
4175         cp->nUnlinkedFiles = dev->nUnlinkedFiles;
4176         cp->nBackgroundDeletions = dev->nBackgroundDeletions;
4177         cp->sequenceNumber = dev->sequenceNumber;
4178         cp->oldestDirtySequence = dev->oldestDirtySequence;
4179
4180 }
4181
4182 static void yaffs_CheckpointDeviceToDevice(yaffs_Device *dev,
4183                                            yaffs_CheckpointDevice *cp)
4184 {
4185         dev->nErasedBlocks = cp->nErasedBlocks;
4186         dev->allocationBlock = cp->allocationBlock;
4187         dev->allocationPage = cp->allocationPage;
4188         dev->nFreeChunks = cp->nFreeChunks;
4189
4190         dev->nDeletedFiles = cp->nDeletedFiles;
4191         dev->nUnlinkedFiles = cp->nUnlinkedFiles;
4192         dev->nBackgroundDeletions = cp->nBackgroundDeletions;
4193         dev->sequenceNumber = cp->sequenceNumber;
4194         dev->oldestDirtySequence = cp->oldestDirtySequence;
4195 }
4196
4197
4198 static int yaffs_WriteCheckpointDevice(yaffs_Device *dev)
4199 {
4200         yaffs_CheckpointDevice cp;
4201         __u32 nBytes;
4202         __u32 nBlocks = (dev->internalEndBlock - dev->internalStartBlock + 1);
4203
4204         int ok;
4205
4206         /* Write device runtime values*/
4207         yaffs_DeviceToCheckpointDevice(&cp,dev);
4208         cp.structType = sizeof(cp);
4209
4210         ok = (yaffs_CheckpointWrite(dev,&cp,sizeof(cp)) == sizeof(cp));
4211
4212         /* Write block info */
4213         if(ok) {
4214                 nBytes = nBlocks * sizeof(yaffs_BlockInfo);
4215                 ok = (yaffs_CheckpointWrite(dev,dev->blockInfo,nBytes) == nBytes);
4216         }
4217
4218         /* Write chunk bits */
4219         if(ok) {
4220                 nBytes = nBlocks * dev->chunkBitmapStride;
4221                 ok = (yaffs_CheckpointWrite(dev,dev->chunkBits,nBytes) == nBytes);
4222         }
4223         return   ok ? 1 : 0;
4224
4225 }
4226
4227 static int yaffs_ReadCheckpointDevice(yaffs_Device *dev)
4228 {
4229         yaffs_CheckpointDevice cp;
4230         __u32 nBytes;
4231         __u32 nBlocks = (dev->internalEndBlock - dev->internalStartBlock + 1);
4232
4233         int ok;
4234
4235         ok = (yaffs_CheckpointRead(dev,&cp,sizeof(cp)) == sizeof(cp));
4236         if(!ok)
4237                 return 0;
4238
4239         if(cp.structType != sizeof(cp))
4240                 return 0;
4241
4242
4243         yaffs_CheckpointDeviceToDevice(dev,&cp);
4244
4245         nBytes = nBlocks * sizeof(yaffs_BlockInfo);
4246
4247         ok = (yaffs_CheckpointRead(dev,dev->blockInfo,nBytes) == nBytes);
4248
4249         if(!ok)
4250                 return 0;
4251         nBytes = nBlocks * dev->chunkBitmapStride;
4252
4253         ok = (yaffs_CheckpointRead(dev,dev->chunkBits,nBytes) == nBytes);
4254
4255         return ok ? 1 : 0;
4256 }
4257
4258 static void yaffs_ObjectToCheckpointObject(yaffs_CheckpointObject *cp,
4259                                            yaffs_Object *obj)
4260 {
4261
4262         cp->objectId = obj->objectId;
4263         cp->parentId = (obj->parent) ? obj->parent->objectId : 0;
4264         cp->hdrChunk = obj->hdrChunk;
4265         cp->variantType = obj->variantType;
4266         cp->deleted = obj->deleted;
4267         cp->softDeleted = obj->softDeleted;
4268         cp->unlinked = obj->unlinked;
4269         cp->fake = obj->fake;
4270         cp->renameAllowed = obj->renameAllowed;
4271         cp->unlinkAllowed = obj->unlinkAllowed;
4272         cp->serial = obj->serial;
4273         cp->nDataChunks = obj->nDataChunks;
4274
4275         if(obj->variantType == YAFFS_OBJECT_TYPE_FILE)
4276                 cp->fileSizeOrEquivalentObjectId = obj->variant.fileVariant.fileSize;
4277         else if(obj->variantType == YAFFS_OBJECT_TYPE_HARDLINK)
4278                 cp->fileSizeOrEquivalentObjectId = obj->variant.hardLinkVariant.equivalentObjectId;
4279 }
4280
4281 static void yaffs_CheckpointObjectToObject( yaffs_Object *obj,yaffs_CheckpointObject *cp)
4282 {
4283
4284         yaffs_Object *parent;
4285
4286         obj->objectId = cp->objectId;
4287
4288         if(cp->parentId)
4289                 parent = yaffs_FindOrCreateObjectByNumber(
4290                                         obj->myDev,
4291                                         cp->parentId,
4292                                         YAFFS_OBJECT_TYPE_DIRECTORY);
4293         else
4294                 parent = NULL;
4295
4296         if(parent)
4297                 yaffs_AddObjectToDirectory(parent, obj);
4298
4299         obj->hdrChunk = cp->hdrChunk;
4300         obj->variantType = cp->variantType;
4301         obj->deleted = cp->deleted;
4302         obj->softDeleted = cp->softDeleted;
4303         obj->unlinked = cp->unlinked;
4304         obj->fake = cp->fake;
4305         obj->renameAllowed = cp->renameAllowed;
4306         obj->unlinkAllowed = cp->unlinkAllowed;
4307         obj->serial = cp->serial;
4308         obj->nDataChunks = cp->nDataChunks;
4309
4310         if(obj->variantType == YAFFS_OBJECT_TYPE_FILE)
4311                 obj->variant.fileVariant.fileSize = cp->fileSizeOrEquivalentObjectId;
4312         else if(obj->variantType == YAFFS_OBJECT_TYPE_HARDLINK)
4313                 obj->variant.hardLinkVariant.equivalentObjectId = cp->fileSizeOrEquivalentObjectId;
4314
4315         if(obj->hdrChunk > 0)
4316                 obj->lazyLoaded = 1;
4317 }
4318
4319
4320
4321 static int yaffs_CheckpointTnodeWorker(yaffs_Object * in, yaffs_Tnode * tn,
4322                                         __u32 level, int chunkOffset)
4323 {
4324         int i;
4325         yaffs_Device *dev = in->myDev;
4326         int ok = 1;
4327         int tnodeSize = (dev->tnodeWidth * YAFFS_NTNODES_LEVEL0)/8;
4328
4329         if(tnodeSize < sizeof(yaffs_Tnode))
4330                 tnodeSize = sizeof(yaffs_Tnode);
4331
4332
4333         if (tn) {
4334                 if (level > 0) {
4335
4336                         for (i = 0; i < YAFFS_NTNODES_INTERNAL && ok; i++){
4337                                 if (tn->internal[i]) {
4338                                         ok = yaffs_CheckpointTnodeWorker(in,
4339                                                         tn->internal[i],
4340                                                         level - 1,
4341                                                         (chunkOffset<<YAFFS_TNODES_INTERNAL_BITS) + i);
4342                                 }
4343                         }
4344                 } else if (level == 0) {
4345                         __u32 baseOffset = chunkOffset <<  YAFFS_TNODES_LEVEL0_BITS;
4346                         /* printf("write tnode at %d\n",baseOffset); */
4347                         ok = (yaffs_CheckpointWrite(dev,&baseOffset,sizeof(baseOffset)) == sizeof(baseOffset));
4348                         if(ok)
4349                                 ok = (yaffs_CheckpointWrite(dev,tn,tnodeSize) == tnodeSize);
4350                 }
4351         }
4352
4353         return ok;
4354
4355 }
4356
4357 static int yaffs_WriteCheckpointTnodes(yaffs_Object *obj)
4358 {
4359         __u32 endMarker = ~0;
4360         int ok = 1;
4361
4362         if(obj->variantType == YAFFS_OBJECT_TYPE_FILE){
4363                 ok = yaffs_CheckpointTnodeWorker(obj,
4364                                             obj->variant.fileVariant.top,
4365                                             obj->variant.fileVariant.topLevel,
4366                                             0);
4367                 if(ok)
4368                         ok = (yaffs_CheckpointWrite(obj->myDev,&endMarker,sizeof(endMarker)) ==
4369                                 sizeof(endMarker));
4370         }
4371
4372         return ok ? 1 : 0;
4373 }
4374
4375 static int yaffs_ReadCheckpointTnodes(yaffs_Object *obj)
4376 {
4377         __u32 baseChunk;
4378         int ok = 1;
4379         yaffs_Device *dev = obj->myDev;
4380         yaffs_FileStructure *fileStructPtr = &obj->variant.fileVariant;
4381         yaffs_Tnode *tn;
4382         int nread = 0;
4383         int tnodeSize = (dev->tnodeWidth * YAFFS_NTNODES_LEVEL0)/8;
4384
4385         if(tnodeSize < sizeof(yaffs_Tnode))
4386                 tnodeSize = sizeof(yaffs_Tnode);
4387
4388         ok = (yaffs_CheckpointRead(dev,&baseChunk,sizeof(baseChunk)) == sizeof(baseChunk));
4389
4390         while(ok && (~baseChunk)){
4391                 nread++;
4392                 /* Read level 0 tnode */
4393
4394
4395                 /* printf("read  tnode at %d\n",baseChunk); */
4396                 tn = yaffs_GetTnodeRaw(dev);
4397                 if(tn)
4398                         ok = (yaffs_CheckpointRead(dev,tn,tnodeSize) == tnodeSize);
4399                 else
4400                         ok = 0;
4401
4402                 if(tn && ok){
4403                         ok = yaffs_AddOrFindLevel0Tnode(dev,
4404                                                         fileStructPtr,
4405                                                         baseChunk,
4406                                                         tn) ? 1 : 0;
4407
4408                 }
4409
4410                 if(ok)
4411                         ok = (yaffs_CheckpointRead(dev,&baseChunk,sizeof(baseChunk)) == sizeof(baseChunk));
4412
4413         }
4414
4415         T(YAFFS_TRACE_CHECKPOINT,(
4416                 TSTR("Checkpoint read tnodes %d records, last %d. ok %d" TENDSTR),
4417                 nread,baseChunk,ok));
4418
4419         return ok ? 1 : 0;
4420 }
4421
4422
4423 static int yaffs_WriteCheckpointObjects(yaffs_Device *dev)
4424 {
4425         yaffs_Object *obj;
4426         yaffs_CheckpointObject cp;
4427         int i;
4428         int ok = 1;
4429         struct ylist_head *lh;
4430
4431
4432         /* Iterate through the objects in each hash entry,
4433          * dumping them to the checkpointing stream.
4434          */
4435
4436          for(i = 0; ok &&  i <  YAFFS_NOBJECT_BUCKETS; i++){
4437                 ylist_for_each(lh, &dev->objectBucket[i].list) {
4438                         if (lh) {
4439                                 obj = ylist_entry(lh, yaffs_Object, hashLink);
4440                                 if (!obj->deferedFree) {
4441                                         yaffs_ObjectToCheckpointObject(&cp,obj);
4442                                         cp.structType = sizeof(cp);
4443
4444                                         T(YAFFS_TRACE_CHECKPOINT,(
4445                                                 TSTR("Checkpoint write object %d parent %d type %d chunk %d obj addr %x" TENDSTR),
4446                                                 cp.objectId,cp.parentId,cp.variantType,cp.hdrChunk,(unsigned) obj));
4447
4448                                         ok = (yaffs_CheckpointWrite(dev,&cp,sizeof(cp)) == sizeof(cp));
4449
4450                                         if(ok && obj->variantType == YAFFS_OBJECT_TYPE_FILE){
4451                                                 ok = yaffs_WriteCheckpointTnodes(obj);
4452                                         }
4453                                 }
4454                         }
4455                 }
4456          }
4457
4458          /* Dump end of list */
4459         memset(&cp,0xFF,sizeof(yaffs_CheckpointObject));
4460         cp.structType = sizeof(cp);
4461
4462         if(ok)
4463                 ok = (yaffs_CheckpointWrite(dev,&cp,sizeof(cp)) == sizeof(cp));
4464
4465         return ok ? 1 : 0;
4466 }
4467
4468 static int yaffs_ReadCheckpointObjects(yaffs_Device *dev)
4469 {
4470         yaffs_Object *obj;
4471         yaffs_CheckpointObject cp;
4472         int ok = 1;
4473         int done = 0;
4474         yaffs_Object *hardList = NULL;
4475
4476         while(ok && !done) {
4477                 ok = (yaffs_CheckpointRead(dev,&cp,sizeof(cp)) == sizeof(cp));
4478                 if(cp.structType != sizeof(cp)) {
4479                         T(YAFFS_TRACE_CHECKPOINT,(TSTR("struct size %d instead of %d ok %d"TENDSTR),
4480                                 cp.structType,sizeof(cp),ok));
4481                         ok = 0;
4482                 }
4483
4484                 T(YAFFS_TRACE_CHECKPOINT,(TSTR("Checkpoint read object %d parent %d type %d chunk %d " TENDSTR),
4485                         cp.objectId,cp.parentId,cp.variantType,cp.hdrChunk));
4486
4487                 if(ok && cp.objectId == ~0)
4488                         done = 1;
4489                 else if(ok){
4490                         obj = yaffs_FindOrCreateObjectByNumber(dev,cp.objectId, cp.variantType);
4491                         if(obj) {
4492                                 yaffs_CheckpointObjectToObject(obj,&cp);
4493                                 if(obj->variantType == YAFFS_OBJECT_TYPE_FILE) {
4494                                         ok = yaffs_ReadCheckpointTnodes(obj);
4495                                 } else if(obj->variantType == YAFFS_OBJECT_TYPE_HARDLINK) {
4496                                         obj->hardLinks.next =
4497                                                     (struct ylist_head *)
4498                                                     hardList;
4499                                         hardList = obj;
4500                                 }
4501
4502                         }
4503                 }
4504         }
4505
4506         if(ok)
4507                 yaffs_HardlinkFixup(dev,hardList);
4508
4509         return ok ? 1 : 0;
4510 }
4511
4512 static int yaffs_WriteCheckpointSum(yaffs_Device *dev)
4513 {
4514         __u32 checkpointSum;
4515         int ok;
4516
4517         yaffs_GetCheckpointSum(dev,&checkpointSum);
4518
4519         ok = (yaffs_CheckpointWrite(dev,&checkpointSum,sizeof(checkpointSum)) == sizeof(checkpointSum));
4520
4521         if(!ok)
4522                 return 0;
4523
4524         return 1;
4525 }
4526
4527 static int yaffs_ReadCheckpointSum(yaffs_Device *dev)
4528 {
4529         __u32 checkpointSum0;
4530         __u32 checkpointSum1;
4531         int ok;
4532
4533         yaffs_GetCheckpointSum(dev,&checkpointSum0);
4534
4535         ok = (yaffs_CheckpointRead(dev,&checkpointSum1,sizeof(checkpointSum1)) == sizeof(checkpointSum1));
4536
4537         if(!ok)
4538                 return 0;
4539
4540         if(checkpointSum0 != checkpointSum1)
4541                 return 0;
4542
4543         return 1;
4544 }
4545
4546
4547 static int yaffs_WriteCheckpointData(yaffs_Device *dev)
4548 {
4549
4550         int ok = 1;
4551
4552         if(dev->skipCheckpointWrite || !dev->isYaffs2){
4553                 T(YAFFS_TRACE_CHECKPOINT,(TSTR("skipping checkpoint write" TENDSTR)));
4554                 ok = 0;
4555         }
4556
4557         if(ok)
4558                 ok = yaffs_CheckpointOpen(dev,1);
4559
4560         if(ok){
4561                 T(YAFFS_TRACE_CHECKPOINT,(TSTR("write checkpoint validity" TENDSTR)));
4562                 ok = yaffs_WriteCheckpointValidityMarker(dev,1);
4563         }
4564         if(ok){
4565                 T(YAFFS_TRACE_CHECKPOINT,(TSTR("write checkpoint device" TENDSTR)));
4566                 ok = yaffs_WriteCheckpointDevice(dev);
4567         }
4568         if(ok){
4569                 T(YAFFS_TRACE_CHECKPOINT,(TSTR("write checkpoint objects" TENDSTR)));
4570                 ok = yaffs_WriteCheckpointObjects(dev);
4571         }
4572         if(ok){
4573                 T(YAFFS_TRACE_CHECKPOINT,(TSTR("write checkpoint validity" TENDSTR)));
4574                 ok = yaffs_WriteCheckpointValidityMarker(dev,0);
4575         }
4576
4577         if(ok){
4578                 ok = yaffs_WriteCheckpointSum(dev);
4579         }
4580
4581
4582         if(!yaffs_CheckpointClose(dev))
4583                  ok = 0;
4584
4585         if(ok)
4586                 dev->isCheckpointed = 1;
4587          else
4588                 dev->isCheckpointed = 0;
4589
4590         return dev->isCheckpointed;
4591 }
4592
4593 static int yaffs_ReadCheckpointData(yaffs_Device *dev)
4594 {
4595         int ok = 1;
4596
4597         if(dev->skipCheckpointRead || !dev->isYaffs2){
4598                 T(YAFFS_TRACE_CHECKPOINT,(TSTR("skipping checkpoint read" TENDSTR)));
4599                 ok = 0;
4600         }
4601
4602         if(ok)
4603                 ok = yaffs_CheckpointOpen(dev,0); /* open for read */
4604
4605         if(ok){
4606                 T(YAFFS_TRACE_CHECKPOINT,(TSTR("read checkpoint validity" TENDSTR)));
4607                 ok = yaffs_ReadCheckpointValidityMarker(dev,1);
4608         }
4609         if(ok){
4610                 T(YAFFS_TRACE_CHECKPOINT,(TSTR("read checkpoint device" TENDSTR)));
4611                 ok = yaffs_ReadCheckpointDevice(dev);
4612         }
4613         if(ok){
4614                 T(YAFFS_TRACE_CHECKPOINT,(TSTR("read checkpoint objects" TENDSTR)));
4615                 ok = yaffs_ReadCheckpointObjects(dev);
4616         }
4617         if(ok){
4618                 T(YAFFS_TRACE_CHECKPOINT,(TSTR("read checkpoint validity" TENDSTR)));
4619                 ok = yaffs_ReadCheckpointValidityMarker(dev,0);
4620         }
4621
4622         if(ok){
4623                 ok = yaffs_ReadCheckpointSum(dev);
4624                 T(YAFFS_TRACE_CHECKPOINT,(TSTR("read checkpoint checksum %d" TENDSTR),ok));
4625         }
4626
4627         if(!yaffs_CheckpointClose(dev))
4628                 ok = 0;
4629
4630         if(ok)
4631                 dev->isCheckpointed = 1;
4632          else
4633                 dev->isCheckpointed = 0;
4634
4635         return ok ? 1 : 0;
4636
4637 }
4638
4639 static void yaffs_InvalidateCheckpoint(yaffs_Device *dev)
4640 {
4641         if(dev->isCheckpointed ||
4642            dev->blocksInCheckpoint > 0){
4643                 dev->isCheckpointed = 0;
4644                 yaffs_CheckpointInvalidateStream(dev);
4645                 if(dev->superBlock && dev->markSuperBlockDirty)
4646                         dev->markSuperBlockDirty(dev->superBlock);
4647         }
4648 }
4649
4650
4651 int yaffs_CheckpointSave(yaffs_Device *dev)
4652 {
4653
4654         T(YAFFS_TRACE_CHECKPOINT,(TSTR("save entry: isCheckpointed %d"TENDSTR),dev->isCheckpointed));
4655
4656         yaffs_VerifyObjects(dev);
4657         yaffs_VerifyBlocks(dev);
4658         yaffs_VerifyFreeChunks(dev);
4659
4660         if(!dev->isCheckpointed) {
4661                 yaffs_InvalidateCheckpoint(dev);
4662                 yaffs_WriteCheckpointData(dev);
4663         }
4664
4665         T(YAFFS_TRACE_ALWAYS,(TSTR("save exit: isCheckpointed %d"TENDSTR),dev->isCheckpointed));
4666
4667         return dev->isCheckpointed;
4668 }
4669
4670 int yaffs_CheckpointRestore(yaffs_Device *dev)
4671 {
4672         int retval;
4673         T(YAFFS_TRACE_CHECKPOINT,(TSTR("restore entry: isCheckpointed %d"TENDSTR),dev->isCheckpointed));
4674
4675         retval = yaffs_ReadCheckpointData(dev);
4676
4677         if(dev->isCheckpointed){
4678                 yaffs_VerifyObjects(dev);
4679                 yaffs_VerifyBlocks(dev);
4680                 yaffs_VerifyFreeChunks(dev);
4681         }
4682
4683         T(YAFFS_TRACE_CHECKPOINT,(TSTR("restore exit: isCheckpointed %d"TENDSTR),dev->isCheckpointed));
4684
4685         return retval;
4686 }
4687
4688 /*--------------------- File read/write ------------------------
4689  * Read and write have very similar structures.
4690  * In general the read/write has three parts to it
4691  * An incomplete chunk to start with (if the read/write is not chunk-aligned)
4692  * Some complete chunks
4693  * An incomplete chunk to end off with
4694  *
4695  * Curve-balls: the first chunk might also be the last chunk.
4696  */
4697
4698 int yaffs_ReadDataFromFile(yaffs_Object * in, __u8 * buffer, loff_t offset,
4699                            int nBytes)
4700 {
4701
4702         int chunk;
4703         __u32 start;
4704         int nToCopy;
4705         int n = nBytes;
4706         int nDone = 0;
4707         yaffs_ChunkCache *cache;
4708
4709         yaffs_Device *dev;
4710
4711         dev = in->myDev;
4712
4713         while (n > 0) {
4714                 //chunk = offset / dev->nDataBytesPerChunk + 1;
4715                 //start = offset % dev->nDataBytesPerChunk;
4716                 yaffs_AddrToChunk(dev,offset,&chunk,&start);
4717                 chunk++;
4718
4719                 /* OK now check for the curveball where the start and end are in
4720                  * the same chunk.
4721                  */
4722                 if ((start + n) < dev->nDataBytesPerChunk) {
4723                         nToCopy = n;
4724                 } else {
4725                         nToCopy = dev->nDataBytesPerChunk - start;
4726                 }
4727
4728                 cache = yaffs_FindChunkCache(in, chunk);
4729
4730                 /* If the chunk is already in the cache or it is less than a whole chunk
4731                  * or we're using inband tags then use the cache (if there is caching)
4732                  * else bypass the cache.
4733                  */
4734                 if (cache || nToCopy != dev->nDataBytesPerChunk || dev->inbandTags) {
4735                         if (dev->nShortOpCaches > 0) {
4736
4737                                 /* If we can't find the data in the cache, then load it up. */
4738
4739                                 if (!cache) {
4740                                         cache = yaffs_GrabChunkCache(in->myDev);
4741                                         cache->object = in;
4742                                         cache->chunkId = chunk;
4743                                         cache->dirty = 0;
4744                                         cache->locked = 0;
4745                                         yaffs_ReadChunkDataFromObject(in, chunk,
4746                                                                       cache->
4747                                                                       data);
4748                                         cache->nBytes = 0;
4749                                 }
4750
4751                                 yaffs_UseChunkCache(dev, cache, 0);
4752
4753                                 cache->locked = 1;
4754
4755 #ifdef CONFIG_YAFFS_WINCE
4756                                 yfsd_UnlockYAFFS(TRUE);
4757 #endif
4758                                 memcpy(buffer, &cache->data[start], nToCopy);
4759
4760 #ifdef CONFIG_YAFFS_WINCE
4761                                 yfsd_LockYAFFS(TRUE);
4762 #endif
4763                                 cache->locked = 0;
4764                         } else {
4765                                 /* Read into the local buffer then copy..*/
4766
4767                                 __u8 *localBuffer =
4768                                     yaffs_GetTempBuffer(dev, __LINE__);
4769                                 yaffs_ReadChunkDataFromObject(in, chunk,
4770                                                               localBuffer);
4771 #ifdef CONFIG_YAFFS_WINCE
4772                                 yfsd_UnlockYAFFS(TRUE);
4773 #endif
4774                                 memcpy(buffer, &localBuffer[start], nToCopy);
4775
4776 #ifdef CONFIG_YAFFS_WINCE
4777                                 yfsd_LockYAFFS(TRUE);
4778 #endif
4779                                 yaffs_ReleaseTempBuffer(dev, localBuffer,
4780                                                         __LINE__);
4781                         }
4782
4783                 } else {
4784 #ifdef CONFIG_YAFFS_WINCE
4785                         __u8 *localBuffer = yaffs_GetTempBuffer(dev, __LINE__);
4786
4787                         /* Under WinCE can't do direct transfer. Need to use a local buffer.
4788                          * This is because we otherwise screw up WinCE's memory mapper
4789                          */
4790                         yaffs_ReadChunkDataFromObject(in, chunk, localBuffer);
4791
4792 #ifdef CONFIG_YAFFS_WINCE
4793                         yfsd_UnlockYAFFS(TRUE);
4794 #endif
4795                         memcpy(buffer, localBuffer, dev->nDataBytesPerChunk);
4796
4797 #ifdef CONFIG_YAFFS_WINCE
4798                         yfsd_LockYAFFS(TRUE);
4799                         yaffs_ReleaseTempBuffer(dev, localBuffer, __LINE__);
4800 #endif
4801
4802 #else
4803                         /* A full chunk. Read directly into the supplied buffer. */
4804                         yaffs_ReadChunkDataFromObject(in, chunk, buffer);
4805 #endif
4806                 }
4807
4808                 n -= nToCopy;
4809                 offset += nToCopy;
4810                 buffer += nToCopy;
4811                 nDone += nToCopy;
4812
4813         }
4814
4815         return nDone;
4816 }
4817
4818 int yaffs_WriteDataToFile(yaffs_Object * in, const __u8 * buffer, loff_t offset,
4819                           int nBytes, int writeThrough)
4820 {
4821
4822         int chunk;
4823         __u32 start;
4824         int nToCopy;
4825         int n = nBytes;
4826         int nDone = 0;
4827         int nToWriteBack;
4828         int startOfWrite = offset;
4829         int chunkWritten = 0;
4830         int nBytesRead;
4831
4832         yaffs_Device *dev;
4833
4834         dev = in->myDev;
4835
4836         while (n > 0 && chunkWritten >= 0) {
4837                 //chunk = offset / dev->nDataBytesPerChunk + 1;
4838                 //start = offset % dev->nDataBytesPerChunk;
4839                 yaffs_AddrToChunk(dev,offset,&chunk,&start);
4840
4841                 if(chunk * dev->nDataBytesPerChunk + start != offset ||
4842                    start >= dev->nDataBytesPerChunk){
4843                    T(YAFFS_TRACE_ERROR,(TSTR("AddrToChunk of offset %d gives chunk %d start %d"TENDSTR),
4844                                         (int)offset, chunk,start));
4845                 }
4846                 chunk++;
4847
4848                 /* OK now check for the curveball where the start and end are in
4849                  * the same chunk.
4850                  */
4851
4852                 if ((start + n) < dev->nDataBytesPerChunk) {
4853                         nToCopy = n;
4854
4855                         /* Now folks, to calculate how many bytes to write back....
4856                          * If we're overwriting and not writing to then end of file then
4857                          * we need to write back as much as was there before.
4858                          */
4859
4860                         nBytesRead =
4861                             in->variant.fileVariant.fileSize -
4862                             ((chunk - 1) * dev->nDataBytesPerChunk);
4863
4864                         if (nBytesRead > dev->nDataBytesPerChunk) {
4865                                 nBytesRead = dev->nDataBytesPerChunk;
4866                         }
4867
4868                         nToWriteBack =
4869                             (nBytesRead >
4870                              ((int)start + n)) ? nBytesRead : (start + n);
4871
4872                 } else {
4873                         nToCopy = dev->nDataBytesPerChunk - start;
4874                         nToWriteBack = dev->nDataBytesPerChunk;
4875                 }
4876
4877                 if (nToCopy != dev->nDataBytesPerChunk || dev->inbandTags) {
4878                         /* An incomplete start or end chunk (or maybe both start and end chunk),
4879                          * or we're using inband tags, so we want to use the cache buffers.
4880                          */
4881                         if (dev->nShortOpCaches > 0) {
4882                                 yaffs_ChunkCache *cache;
4883                                 /* If we can't find the data in the cache, then load the cache */
4884                                 cache = yaffs_FindChunkCache(in, chunk);
4885
4886                                 if (!cache
4887                                     && yaffs_CheckSpaceForAllocation(in->
4888                                                                      myDev)) {
4889                                         cache = yaffs_GrabChunkCache(in->myDev);
4890                                         cache->object = in;
4891                                         cache->chunkId = chunk;
4892                                         cache->dirty = 0;
4893                                         cache->locked = 0;
4894                                         yaffs_ReadChunkDataFromObject(in, chunk,
4895                                                                       cache->
4896                                                                       data);
4897                                 }
4898                                 else if(cache &&
4899                                         !cache->dirty &&
4900                                         !yaffs_CheckSpaceForAllocation(in->myDev)){
4901                                         /* Drop the cache if it was a read cache item and
4902                                          * no space check has been made for it.
4903                                          */
4904                                          cache = NULL;
4905                                 }
4906
4907                                 if (cache) {
4908                                         yaffs_UseChunkCache(dev, cache, 1);
4909                                         cache->locked = 1;
4910 #ifdef CONFIG_YAFFS_WINCE
4911                                         yfsd_UnlockYAFFS(TRUE);
4912 #endif
4913
4914                                         memcpy(&cache->data[start], buffer,
4915                                                nToCopy);
4916
4917 #ifdef CONFIG_YAFFS_WINCE
4918                                         yfsd_LockYAFFS(TRUE);
4919 #endif
4920                                         cache->locked = 0;
4921                                         cache->nBytes = nToWriteBack;
4922
4923                                         if (writeThrough) {
4924                                                 chunkWritten =
4925                                                     yaffs_WriteChunkDataToObject
4926                                                     (cache->object,
4927                                                      cache->chunkId,
4928                                                      cache->data, cache->nBytes,
4929                                                      1);
4930                                                 cache->dirty = 0;
4931                                         }
4932
4933                                 } else {
4934                                         chunkWritten = -1;      /* fail the write */
4935                                 }
4936                         } else {
4937                                 /* An incomplete start or end chunk (or maybe both start and end chunk)
4938                                  * Read into the local buffer then copy, then copy over and write back.
4939                                  */
4940
4941                                 __u8 *localBuffer =
4942                                     yaffs_GetTempBuffer(dev, __LINE__);
4943
4944                                 yaffs_ReadChunkDataFromObject(in, chunk,
4945                                                               localBuffer);
4946
4947 #ifdef CONFIG_YAFFS_WINCE
4948                                 yfsd_UnlockYAFFS(TRUE);
4949 #endif
4950
4951                                 memcpy(&localBuffer[start], buffer, nToCopy);
4952
4953 #ifdef CONFIG_YAFFS_WINCE
4954                                 yfsd_LockYAFFS(TRUE);
4955 #endif
4956                                 chunkWritten =
4957                                     yaffs_WriteChunkDataToObject(in, chunk,
4958                                                                  localBuffer,
4959                                                                  nToWriteBack,
4960                                                                  0);
4961
4962                                 yaffs_ReleaseTempBuffer(dev, localBuffer,
4963                                                         __LINE__);
4964
4965                         }
4966
4967                 } else {
4968                         /* A full chunk. Write directly from the supplied buffer. */
4969
4970 #ifdef CONFIG_YAFFS_WINCE
4971                         /* Under WinCE can't do direct transfer. Need to use a local buffer.
4972                          * This is because we otherwise screw up WinCE's memory mapper
4973                          */
4974                         __u8 *localBuffer = yaffs_GetTempBuffer(dev, __LINE__);
4975 #ifdef CONFIG_YAFFS_WINCE
4976                         yfsd_UnlockYAFFS(TRUE);
4977 #endif
4978                         memcpy(localBuffer, buffer, dev->nDataBytesPerChunk);
4979 #ifdef CONFIG_YAFFS_WINCE
4980                         yfsd_LockYAFFS(TRUE);
4981 #endif
4982                         chunkWritten =
4983                             yaffs_WriteChunkDataToObject(in, chunk, localBuffer,
4984                                                          dev->nDataBytesPerChunk,
4985                                                          0);
4986                         yaffs_ReleaseTempBuffer(dev, localBuffer, __LINE__);
4987 #else
4988
4989                         chunkWritten =
4990                             yaffs_WriteChunkDataToObject(in, chunk, buffer,
4991                                                          dev->nDataBytesPerChunk,
4992                                                          0);
4993 #endif
4994                         /* Since we've overwritten the cached data, we better invalidate it. */
4995                         yaffs_InvalidateChunkCache(in, chunk);
4996                 }
4997
4998                 if (chunkWritten >= 0) {
4999                         n -= nToCopy;
5000                         offset += nToCopy;
5001                         buffer += nToCopy;
5002                         nDone += nToCopy;
5003                 }
5004
5005         }
5006
5007         /* Update file object */
5008
5009         if ((startOfWrite + nDone) > in->variant.fileVariant.fileSize) {
5010                 in->variant.fileVariant.fileSize = (startOfWrite + nDone);
5011         }
5012
5013         in->dirty = 1;
5014
5015         return nDone;
5016 }
5017
5018
5019 /* ---------------------- File resizing stuff ------------------ */
5020
5021 static void yaffs_PruneResizedChunks(yaffs_Object * in, int newSize)
5022 {
5023
5024         yaffs_Device *dev = in->myDev;
5025         int oldFileSize = in->variant.fileVariant.fileSize;
5026
5027         int lastDel = 1 + (oldFileSize - 1) / dev->nDataBytesPerChunk;
5028
5029         int startDel = 1 + (newSize + dev->nDataBytesPerChunk - 1) /
5030             dev->nDataBytesPerChunk;
5031         int i;
5032         int chunkId;
5033
5034         /* Delete backwards so that we don't end up with holes if
5035          * power is lost part-way through the operation.
5036          */
5037         for (i = lastDel; i >= startDel; i--) {
5038                 /* NB this could be optimised somewhat,
5039                  * eg. could retrieve the tags and write them without
5040                  * using yaffs_DeleteChunk
5041                  */
5042
5043                 chunkId = yaffs_FindAndDeleteChunkInFile(in, i, NULL);
5044                 if (chunkId > 0) {
5045                         if (chunkId <
5046                             (dev->internalStartBlock * dev->nChunksPerBlock)
5047                             || chunkId >=
5048                             ((dev->internalEndBlock +
5049                               1) * dev->nChunksPerBlock)) {
5050                                 T(YAFFS_TRACE_ALWAYS,
5051                                   (TSTR("Found daft chunkId %d for %d" TENDSTR),
5052                                    chunkId, i));
5053                         } else {
5054                                 in->nDataChunks--;
5055                                 yaffs_DeleteChunk(dev, chunkId, 1, __LINE__);
5056                         }
5057                 }
5058         }
5059
5060 }
5061
5062 int yaffs_ResizeFile(yaffs_Object * in, loff_t newSize)
5063 {
5064
5065         int oldFileSize = in->variant.fileVariant.fileSize;
5066         __u32 newSizeOfPartialChunk;
5067         int newFullChunks;
5068
5069         yaffs_Device *dev = in->myDev;
5070
5071         yaffs_AddrToChunk(dev, newSize, &newFullChunks, &newSizeOfPartialChunk);
5072
5073         yaffs_FlushFilesChunkCache(in);
5074         yaffs_InvalidateWholeChunkCache(in);
5075
5076         yaffs_CheckGarbageCollection(dev);
5077
5078         if (in->variantType != YAFFS_OBJECT_TYPE_FILE) {
5079                 return YAFFS_FAIL;
5080         }
5081
5082         if (newSize == oldFileSize) {
5083                 return YAFFS_OK;
5084         }
5085
5086         if (newSize < oldFileSize) {
5087
5088                 yaffs_PruneResizedChunks(in, newSize);
5089
5090                 if (newSizeOfPartialChunk != 0) {
5091                         int lastChunk = 1 + newFullChunks;
5092
5093                         __u8 *localBuffer = yaffs_GetTempBuffer(dev, __LINE__);
5094
5095                         /* Got to read and rewrite the last chunk with its new size and zero pad */
5096                         yaffs_ReadChunkDataFromObject(in, lastChunk,
5097                                                       localBuffer);
5098
5099                         memset(localBuffer + newSizeOfPartialChunk, 0,
5100                                dev->nDataBytesPerChunk - newSizeOfPartialChunk);
5101
5102                         yaffs_WriteChunkDataToObject(in, lastChunk, localBuffer,
5103                                                      newSizeOfPartialChunk, 1);
5104
5105                         yaffs_ReleaseTempBuffer(dev, localBuffer, __LINE__);
5106                 }
5107
5108                 in->variant.fileVariant.fileSize = newSize;
5109
5110                 yaffs_PruneFileStructure(dev, &in->variant.fileVariant);
5111         } else {
5112                 /* newsSize > oldFileSize */
5113                 in->variant.fileVariant.fileSize = newSize;
5114         }
5115
5116
5117
5118         /* Write a new object header.
5119          * show we've shrunk the file, if need be
5120          * Do this only if the file is not in the deleted directories.
5121          */
5122         if (in->parent &&
5123             in->parent->objectId != YAFFS_OBJECTID_UNLINKED &&
5124             in->parent->objectId != YAFFS_OBJECTID_DELETED) {
5125                 yaffs_UpdateObjectHeader(in, NULL, 0,
5126                                          (newSize < oldFileSize) ? 1 : 0, 0);
5127         }
5128
5129         return YAFFS_OK;
5130 }
5131
5132 loff_t yaffs_GetFileSize(yaffs_Object * obj)
5133 {
5134         obj = yaffs_GetEquivalentObject(obj);
5135
5136         switch (obj->variantType) {
5137         case YAFFS_OBJECT_TYPE_FILE:
5138                 return obj->variant.fileVariant.fileSize;
5139         case YAFFS_OBJECT_TYPE_SYMLINK:
5140                 return yaffs_strlen(obj->variant.symLinkVariant.alias);
5141         default:
5142                 return 0;
5143         }
5144 }
5145
5146
5147
5148 int yaffs_FlushFile(yaffs_Object * in, int updateTime)
5149 {
5150         int retVal;
5151         if (in->dirty) {
5152                 yaffs_FlushFilesChunkCache(in);
5153                 if (updateTime) {
5154 #ifdef CONFIG_YAFFS_WINCE
5155                         yfsd_WinFileTimeNow(in->win_mtime);
5156 #else
5157
5158                         in->yst_mtime = Y_CURRENT_TIME;
5159
5160 #endif
5161                 }
5162
5163                 retVal =
5164                     (yaffs_UpdateObjectHeader(in, NULL, 0, 0, 0) >=
5165                      0) ? YAFFS_OK : YAFFS_FAIL;
5166         } else {
5167                 retVal = YAFFS_OK;
5168         }
5169
5170         return retVal;
5171
5172 }
5173
5174 static int yaffs_DoGenericObjectDeletion(yaffs_Object * in)
5175 {
5176
5177         /* First off, invalidate the file's data in the cache, without flushing. */
5178         yaffs_InvalidateWholeChunkCache(in);
5179
5180         if (in->myDev->isYaffs2 && (in->parent != in->myDev->deletedDir)) {
5181                 /* Move to the unlinked directory so we have a record that it was deleted. */
5182                 yaffs_ChangeObjectName(in, in->myDev->deletedDir,_Y("deleted"), 0, 0);
5183
5184         }
5185
5186         yaffs_RemoveObjectFromDirectory(in);
5187         yaffs_DeleteChunk(in->myDev, in->hdrChunk, 1, __LINE__);
5188         in->hdrChunk = 0;
5189
5190         yaffs_FreeObject(in);
5191         return YAFFS_OK;
5192
5193 }
5194
5195 /* yaffs_DeleteFile deletes the whole file data
5196  * and the inode associated with the file.
5197  * It does not delete the links associated with the file.
5198  */
5199
5200 static int yaffs_UnlinkFile(yaffs_Object * in)
5201 {
5202
5203         int retVal;
5204         int immediateDeletion = 0;
5205
5206 #ifdef __KERNEL__
5207         if (!in->myInode) {
5208                 immediateDeletion = 1;
5209         }
5210 #else
5211         if (in->inUse <= 0) {
5212                 immediateDeletion = 1;
5213         }
5214 #endif
5215
5216         if (immediateDeletion) {
5217                 retVal =
5218                     yaffs_ChangeObjectName(in, in->myDev->deletedDir,
5219                                            _Y("deleted"), 0, 0);
5220                 T(YAFFS_TRACE_TRACING,
5221                   (TSTR("yaffs: immediate deletion of file %d" TENDSTR),
5222                    in->objectId));
5223                 in->deleted = 1;
5224                 in->myDev->nDeletedFiles++;
5225                 if (1 || in->myDev->isYaffs2) {
5226                         yaffs_ResizeFile(in, 0);
5227                 }
5228                 yaffs_SoftDeleteFile(in);
5229         } else {
5230                 retVal =
5231                     yaffs_ChangeObjectName(in, in->myDev->unlinkedDir,
5232                                            _Y("unlinked"), 0, 0);
5233         }
5234
5235
5236         return retVal;
5237 }
5238
5239 int yaffs_DeleteFile(yaffs_Object * in)
5240 {
5241         int retVal = YAFFS_OK;
5242         int deleted = in->deleted;
5243
5244         yaffs_ResizeFile(in,0);
5245
5246         if (in->nDataChunks > 0) {
5247                 /* Use soft deletion if there is data in the file.
5248                  * That won't be the case if it has been resized to zero.
5249                  */
5250                 if (!in->unlinked) {
5251                         retVal = yaffs_UnlinkFile(in);
5252                 }
5253                 if (retVal == YAFFS_OK && in->unlinked && !in->deleted) {
5254                         in->deleted = deleted = 1;
5255                         in->myDev->nDeletedFiles++;
5256                         yaffs_SoftDeleteFile(in);
5257                 }
5258                 return deleted ? YAFFS_OK : YAFFS_FAIL;
5259         } else {
5260                 /* The file has no data chunks so we toss it immediately */
5261                 yaffs_FreeTnode(in->myDev, in->variant.fileVariant.top);
5262                 in->variant.fileVariant.top = NULL;
5263                 yaffs_DoGenericObjectDeletion(in);
5264
5265                 return YAFFS_OK;
5266         }
5267 }
5268
5269 static int yaffs_DeleteDirectory(yaffs_Object * in)
5270 {
5271         /* First check that the directory is empty. */
5272         if (ylist_empty(&in->variant.directoryVariant.children)) {
5273                 return yaffs_DoGenericObjectDeletion(in);
5274         }
5275
5276         return YAFFS_FAIL;
5277
5278 }
5279
5280 static int yaffs_DeleteSymLink(yaffs_Object * in)
5281 {
5282         YFREE(in->variant.symLinkVariant.alias);
5283
5284         return yaffs_DoGenericObjectDeletion(in);
5285 }
5286
5287 static int yaffs_DeleteHardLink(yaffs_Object * in)
5288 {
5289         /* remove this hardlink from the list assocaited with the equivalent
5290          * object
5291          */
5292         ylist_del_init(&in->hardLinks);
5293         return yaffs_DoGenericObjectDeletion(in);
5294 }
5295
5296 static void yaffs_DestroyObject(yaffs_Object * obj)
5297 {
5298         switch (obj->variantType) {
5299         case YAFFS_OBJECT_TYPE_FILE:
5300                 yaffs_DeleteFile(obj);
5301                 break;
5302         case YAFFS_OBJECT_TYPE_DIRECTORY:
5303                 yaffs_DeleteDirectory(obj);
5304                 break;
5305         case YAFFS_OBJECT_TYPE_SYMLINK:
5306                 yaffs_DeleteSymLink(obj);
5307                 break;
5308         case YAFFS_OBJECT_TYPE_HARDLINK:
5309                 yaffs_DeleteHardLink(obj);
5310                 break;
5311         case YAFFS_OBJECT_TYPE_SPECIAL:
5312                 yaffs_DoGenericObjectDeletion(obj);
5313                 break;
5314         case YAFFS_OBJECT_TYPE_UNKNOWN:
5315                 break;          /* should not happen. */
5316         }
5317 }
5318
5319 static int yaffs_UnlinkWorker(yaffs_Object * obj)
5320 {
5321
5322         if (obj->variantType == YAFFS_OBJECT_TYPE_HARDLINK) {
5323                 return yaffs_DeleteHardLink(obj);
5324         } else if (!ylist_empty(&obj->hardLinks)) {
5325                 /* Curve ball: We're unlinking an object that has a hardlink.
5326                  *
5327                  * This problem arises because we are not strictly following
5328                  * The Linux link/inode model.
5329                  *
5330                  * We can't really delete the object.
5331                  * Instead, we do the following:
5332                  * - Select a hardlink.
5333                  * - Unhook it from the hard links
5334                  * - Unhook it from its parent directory (so that the rename can work)
5335                  * - Rename the object to the hardlink's name.
5336                  * - Delete the hardlink
5337                  */
5338
5339                 yaffs_Object *hl;
5340                 int retVal;
5341                 YCHAR name[YAFFS_MAX_NAME_LENGTH + 1];
5342
5343                 hl = ylist_entry(obj->hardLinks.next, yaffs_Object, hardLinks);
5344
5345                 ylist_del_init(&hl->hardLinks);
5346                 ylist_del_init(&hl->siblings);
5347
5348                 yaffs_GetObjectName(hl, name, YAFFS_MAX_NAME_LENGTH + 1);
5349
5350                 retVal = yaffs_ChangeObjectName(obj, hl->parent, name, 0, 0);
5351
5352                 if (retVal == YAFFS_OK) {
5353                         retVal = yaffs_DoGenericObjectDeletion(hl);
5354                 }
5355                 return retVal;
5356
5357         } else {
5358                 switch (obj->variantType) {
5359                 case YAFFS_OBJECT_TYPE_FILE:
5360                         return yaffs_UnlinkFile(obj);
5361                         break;
5362                 case YAFFS_OBJECT_TYPE_DIRECTORY:
5363                         return yaffs_DeleteDirectory(obj);
5364                         break;
5365                 case YAFFS_OBJECT_TYPE_SYMLINK:
5366                         return yaffs_DeleteSymLink(obj);
5367                         break;
5368                 case YAFFS_OBJECT_TYPE_SPECIAL:
5369                         return yaffs_DoGenericObjectDeletion(obj);
5370                         break;
5371                 case YAFFS_OBJECT_TYPE_HARDLINK:
5372                 case YAFFS_OBJECT_TYPE_UNKNOWN:
5373                 default:
5374                         return YAFFS_FAIL;
5375                 }
5376         }
5377 }
5378
5379
5380 static int yaffs_UnlinkObject( yaffs_Object *obj)
5381 {
5382
5383         if (obj && obj->unlinkAllowed) {
5384                 return yaffs_UnlinkWorker(obj);
5385         }
5386
5387         return YAFFS_FAIL;
5388
5389 }
5390 int yaffs_Unlink(yaffs_Object * dir, const YCHAR * name)
5391 {
5392         yaffs_Object *obj;
5393
5394         obj = yaffs_FindObjectByName(dir, name);
5395         return yaffs_UnlinkObject(obj);
5396 }
5397
5398 /*----------------------- Initialisation Scanning ---------------------- */
5399
5400 static void yaffs_HandleShadowedObject(yaffs_Device * dev, int objId,
5401                                        int backwardScanning)
5402 {
5403         yaffs_Object *obj;
5404
5405         if (!backwardScanning) {
5406                 /* Handle YAFFS1 forward scanning case
5407                  * For YAFFS1 we always do the deletion
5408                  */
5409
5410         } else {
5411                 /* Handle YAFFS2 case (backward scanning)
5412                  * If the shadowed object exists then ignore.
5413                  */
5414                 if (yaffs_FindObjectByNumber(dev, objId)) {
5415                         return;
5416                 }
5417         }
5418
5419         /* Let's create it (if it does not exist) assuming it is a file so that it can do shrinking etc.
5420          * We put it in unlinked dir to be cleaned up after the scanning
5421          */
5422         obj =
5423             yaffs_FindOrCreateObjectByNumber(dev, objId,
5424                                              YAFFS_OBJECT_TYPE_FILE);
5425         yaffs_AddObjectToDirectory(dev->unlinkedDir, obj);
5426         obj->variant.fileVariant.shrinkSize = 0;
5427         obj->valid = 1;         /* So that we don't read any other info for this file */
5428
5429 }
5430
5431 typedef struct {
5432         int seq;
5433         int block;
5434 } yaffs_BlockIndex;
5435
5436
5437 static void yaffs_HardlinkFixup(yaffs_Device *dev, yaffs_Object *hardList)
5438 {
5439         yaffs_Object *hl;
5440         yaffs_Object *in;
5441
5442         while (hardList) {
5443                 hl = hardList;
5444                 hardList = (yaffs_Object *) (hardList->hardLinks.next);
5445
5446                 in = yaffs_FindObjectByNumber(dev,
5447                                               hl->variant.hardLinkVariant.
5448                                               equivalentObjectId);
5449
5450                 if (in) {
5451                         /* Add the hardlink pointers */
5452                         hl->variant.hardLinkVariant.equivalentObject = in;
5453                         ylist_add(&hl->hardLinks, &in->hardLinks);
5454                 } else {
5455                         /* Todo Need to report/handle this better.
5456                          * Got a problem... hardlink to a non-existant object
5457                          */
5458                         hl->variant.hardLinkVariant.equivalentObject = NULL;
5459                         YINIT_LIST_HEAD(&hl->hardLinks);
5460
5461                 }
5462
5463         }
5464
5465 }
5466
5467
5468
5469
5470
5471 static int ybicmp(const void *a, const void *b){
5472     register int aseq = ((yaffs_BlockIndex *)a)->seq;
5473     register int bseq = ((yaffs_BlockIndex *)b)->seq;
5474     register int ablock = ((yaffs_BlockIndex *)a)->block;
5475     register int bblock = ((yaffs_BlockIndex *)b)->block;
5476     if( aseq == bseq )
5477         return ablock - bblock;
5478     else
5479         return aseq - bseq;
5480
5481 }
5482
5483
5484 struct yaffs_ShadowFixerStruct {
5485         int objectId;
5486         int shadowedId;
5487         struct yaffs_ShadowFixerStruct *next;
5488 };
5489
5490 static int yaffs_Scan(yaffs_Device * dev)
5491 {
5492         yaffs_ExtendedTags tags;
5493         int blk;
5494         int blockIterator;
5495         int startIterator;
5496         int endIterator;
5497         int result;
5498
5499         int chunk;
5500         int c;
5501         int deleted;
5502         yaffs_BlockState state;
5503         yaffs_Object *hardList = NULL;
5504         yaffs_BlockInfo *bi;
5505         __u32 sequenceNumber;
5506         yaffs_ObjectHeader *oh;
5507         yaffs_Object *in;
5508         yaffs_Object *parent;
5509
5510         int alloc_failed = 0;
5511
5512         struct yaffs_ShadowFixerStruct *shadowFixerList = NULL;
5513
5514
5515         __u8 *chunkData;
5516
5517
5518
5519         T(YAFFS_TRACE_SCAN,
5520           (TSTR("yaffs_Scan starts  intstartblk %d intendblk %d..." TENDSTR),
5521            dev->internalStartBlock, dev->internalEndBlock));
5522
5523         chunkData = yaffs_GetTempBuffer(dev, __LINE__);
5524
5525         dev->sequenceNumber = YAFFS_LOWEST_SEQUENCE_NUMBER;
5526
5527         /* Scan all the blocks to determine their state */
5528         for (blk = dev->internalStartBlock; blk <= dev->internalEndBlock; blk++) {
5529                 bi = yaffs_GetBlockInfo(dev, blk);
5530                 yaffs_ClearChunkBits(dev, blk);
5531                 bi->pagesInUse = 0;
5532                 bi->softDeletions = 0;
5533
5534                 yaffs_QueryInitialBlockState(dev, blk, &state, &sequenceNumber);
5535
5536                 bi->blockState = state;
5537                 bi->sequenceNumber = sequenceNumber;
5538
5539                 T(YAFFS_TRACE_SCAN_DEBUG,
5540                   (TSTR("Block scanning block %d state %d seq %d" TENDSTR), blk,
5541                    state, sequenceNumber));
5542
5543                 if (state == YAFFS_BLOCK_STATE_DEAD) {
5544                         T(YAFFS_TRACE_BAD_BLOCKS,
5545                           (TSTR("block %d is bad" TENDSTR), blk));
5546                 } else if (state == YAFFS_BLOCK_STATE_EMPTY) {
5547                         T(YAFFS_TRACE_SCAN_DEBUG,
5548                           (TSTR("Block empty " TENDSTR)));
5549                         dev->nErasedBlocks++;
5550                         dev->nFreeChunks += dev->nChunksPerBlock;
5551                 }
5552         }
5553
5554         startIterator = dev->internalStartBlock;
5555         endIterator = dev->internalEndBlock;
5556
5557         /* For each block.... */
5558         for (blockIterator = startIterator; !alloc_failed && blockIterator <= endIterator;
5559              blockIterator++) {
5560
5561                 YYIELD();
5562
5563                 YYIELD();
5564
5565                 blk = blockIterator;
5566
5567                 bi = yaffs_GetBlockInfo(dev, blk);
5568                 state = bi->blockState;
5569
5570                 deleted = 0;
5571
5572                 /* For each chunk in each block that needs scanning....*/
5573                 for (c = 0; !alloc_failed && c < dev->nChunksPerBlock &&
5574                      state == YAFFS_BLOCK_STATE_NEEDS_SCANNING; c++) {
5575                         /* Read the tags and decide what to do */
5576                         chunk = blk * dev->nChunksPerBlock + c;
5577
5578                         result = yaffs_ReadChunkWithTagsFromNAND(dev, chunk, NULL,
5579                                                         &tags);
5580
5581                         /* Let's have a good look at this chunk... */
5582
5583                         if (tags.eccResult == YAFFS_ECC_RESULT_UNFIXED || tags.chunkDeleted) {
5584                                 /* YAFFS1 only...
5585                                  * A deleted chunk
5586                                  */
5587                                 deleted++;
5588                                 dev->nFreeChunks++;
5589                                 /*T((" %d %d deleted\n",blk,c)); */
5590                         } else if (!tags.chunkUsed) {
5591                                 /* An unassigned chunk in the block
5592                                  * This means that either the block is empty or
5593                                  * this is the one being allocated from
5594                                  */
5595
5596                                 if (c == 0) {
5597                                         /* We're looking at the first chunk in the block so the block is unused */
5598                                         state = YAFFS_BLOCK_STATE_EMPTY;
5599                                         dev->nErasedBlocks++;
5600                                 } else {
5601                                         /* this is the block being allocated from */
5602                                         T(YAFFS_TRACE_SCAN,
5603                                           (TSTR
5604                                            (" Allocating from %d %d" TENDSTR),
5605                                            blk, c));
5606                                         state = YAFFS_BLOCK_STATE_ALLOCATING;
5607                                         dev->allocationBlock = blk;
5608                                         dev->allocationPage = c;
5609                                         dev->allocationBlockFinder = blk;
5610                                         /* Set it to here to encourage the allocator to go forth from here. */
5611
5612                                 }
5613
5614                                 dev->nFreeChunks += (dev->nChunksPerBlock - c);
5615                         } else if (tags.chunkId > 0) {
5616                                 /* chunkId > 0 so it is a data chunk... */
5617                                 unsigned int endpos;
5618
5619                                 yaffs_SetChunkBit(dev, blk, c);
5620                                 bi->pagesInUse++;
5621
5622                                 in = yaffs_FindOrCreateObjectByNumber(dev,
5623                                                                       tags.
5624                                                                       objectId,
5625                                                                       YAFFS_OBJECT_TYPE_FILE);
5626                                 /* PutChunkIntoFile checks for a clash (two data chunks with
5627                                  * the same chunkId).
5628                                  */
5629
5630                                 if(!in)
5631                                         alloc_failed = 1;
5632
5633                                 if(in){
5634                                         if(!yaffs_PutChunkIntoFile(in, tags.chunkId, chunk,1))
5635                                                 alloc_failed = 1;
5636                                 }
5637
5638                                 endpos =
5639                                     (tags.chunkId - 1) * dev->nDataBytesPerChunk +
5640                                     tags.byteCount;
5641                                 if (in &&
5642                                     in->variantType == YAFFS_OBJECT_TYPE_FILE
5643                                     && in->variant.fileVariant.scannedFileSize <
5644                                     endpos) {
5645                                         in->variant.fileVariant.
5646                                             scannedFileSize = endpos;
5647                                         if (!dev->useHeaderFileSize) {
5648                                                 in->variant.fileVariant.
5649                                                     fileSize =
5650                                                     in->variant.fileVariant.
5651                                                     scannedFileSize;
5652                                         }
5653
5654                                 }
5655                                 /* T((" %d %d data %d %d\n",blk,c,tags.objectId,tags.chunkId));   */
5656                         } else {
5657                                 /* chunkId == 0, so it is an ObjectHeader.
5658                                  * Thus, we read in the object header and make the object
5659                                  */
5660                                 yaffs_SetChunkBit(dev, blk, c);
5661                                 bi->pagesInUse++;
5662
5663                                 result = yaffs_ReadChunkWithTagsFromNAND(dev, chunk,
5664                                                                 chunkData,
5665                                                                 NULL);
5666
5667                                 oh = (yaffs_ObjectHeader *) chunkData;
5668
5669                                 in = yaffs_FindObjectByNumber(dev,
5670                                                               tags.objectId);
5671                                 if (in && in->variantType != oh->type) {
5672                                         /* This should not happen, but somehow
5673                                          * Wev'e ended up with an objectId that has been reused but not yet
5674                                          * deleted, and worse still it has changed type. Delete the old object.
5675                                          */
5676
5677                                         yaffs_DestroyObject(in);
5678
5679                                         in = 0;
5680                                 }
5681
5682                                 in = yaffs_FindOrCreateObjectByNumber(dev,
5683                                                                       tags.
5684                                                                       objectId,
5685                                                                       oh->type);
5686
5687                                 if(!in)
5688                                         alloc_failed = 1;
5689
5690                                 if (in && oh->shadowsObject > 0) {
5691
5692                                         struct yaffs_ShadowFixerStruct *fixer;
5693                                         fixer = YMALLOC(sizeof(struct yaffs_ShadowFixerStruct));
5694                                         if(fixer){
5695                                                 fixer-> next = shadowFixerList;
5696                                                 shadowFixerList = fixer;
5697                                                 fixer->objectId = tags.objectId;
5698                                                 fixer->shadowedId = oh->shadowsObject;
5699                                         }
5700
5701                                 }
5702
5703                                 if (in && in->valid) {
5704                                         /* We have already filled this one. We have a duplicate and need to resolve it. */
5705
5706                                         unsigned existingSerial = in->serial;
5707                                         unsigned newSerial = tags.serialNumber;
5708
5709                                         if (((existingSerial + 1) & 3) == newSerial) {
5710                                                 /* Use new one - destroy the exisiting one */
5711                                                 yaffs_DeleteChunk(dev,
5712                                                                   in->hdrChunk,
5713                                                                   1, __LINE__);
5714                                                 in->valid = 0;
5715                                         } else {
5716                                                 /* Use existing - destroy this one. */
5717                                                 yaffs_DeleteChunk(dev, chunk, 1,
5718                                                                   __LINE__);
5719                                         }
5720                                 }
5721
5722                                 if (in && !in->valid &&
5723                                     (tags.objectId == YAFFS_OBJECTID_ROOT ||
5724                                      tags.objectId == YAFFS_OBJECTID_LOSTNFOUND)) {
5725                                         /* We only load some info, don't fiddle with directory structure */
5726                                         in->valid = 1;
5727                                         in->variantType = oh->type;
5728
5729                                         in->yst_mode = oh->yst_mode;
5730 #ifdef CONFIG_YAFFS_WINCE
5731                                         in->win_atime[0] = oh->win_atime[0];
5732                                         in->win_ctime[0] = oh->win_ctime[0];
5733                                         in->win_mtime[0] = oh->win_mtime[0];
5734                                         in->win_atime[1] = oh->win_atime[1];
5735                                         in->win_ctime[1] = oh->win_ctime[1];
5736                                         in->win_mtime[1] = oh->win_mtime[1];
5737 #else
5738                                         in->yst_uid = oh->yst_uid;
5739                                         in->yst_gid = oh->yst_gid;
5740                                         in->yst_atime = oh->yst_atime;
5741                                         in->yst_mtime = oh->yst_mtime;
5742                                         in->yst_ctime = oh->yst_ctime;
5743                                         in->yst_rdev = oh->yst_rdev;
5744 #endif
5745                                         in->hdrChunk = chunk;
5746                                         in->serial = tags.serialNumber;
5747
5748                                 } else if (in && !in->valid) {
5749                                         /* we need to load this info */
5750
5751                                         in->valid = 1;
5752                                         in->variantType = oh->type;
5753
5754                                         in->yst_mode = oh->yst_mode;
5755 #ifdef CONFIG_YAFFS_WINCE
5756                                         in->win_atime[0] = oh->win_atime[0];
5757                                         in->win_ctime[0] = oh->win_ctime[0];
5758                                         in->win_mtime[0] = oh->win_mtime[0];
5759                                         in->win_atime[1] = oh->win_atime[1];
5760                                         in->win_ctime[1] = oh->win_ctime[1];
5761                                         in->win_mtime[1] = oh->win_mtime[1];
5762 #else
5763                                         in->yst_uid = oh->yst_uid;
5764                                         in->yst_gid = oh->yst_gid;
5765                                         in->yst_atime = oh->yst_atime;
5766                                         in->yst_mtime = oh->yst_mtime;
5767                                         in->yst_ctime = oh->yst_ctime;
5768                                         in->yst_rdev = oh->yst_rdev;
5769 #endif
5770                                         in->hdrChunk = chunk;
5771                                         in->serial = tags.serialNumber;
5772
5773                                         yaffs_SetObjectName(in, oh->name);
5774                                         in->dirty = 0;
5775
5776                                         /* directory stuff...
5777                                          * hook up to parent
5778                                          */
5779
5780                                         parent =
5781                                             yaffs_FindOrCreateObjectByNumber
5782                                             (dev, oh->parentObjectId,
5783                                              YAFFS_OBJECT_TYPE_DIRECTORY);
5784                                         if (parent->variantType ==
5785                                             YAFFS_OBJECT_TYPE_UNKNOWN) {
5786                                                 /* Set up as a directory */
5787                                                 parent->variantType =
5788                                                     YAFFS_OBJECT_TYPE_DIRECTORY;
5789                                                 YINIT_LIST_HEAD(&parent->variant.
5790                                                                directoryVariant.
5791                                                                children);
5792                                         } else if (parent->variantType !=
5793                                                    YAFFS_OBJECT_TYPE_DIRECTORY)
5794                                         {
5795                                                 /* Hoosterman, another problem....
5796                                                  * We're trying to use a non-directory as a directory
5797                                                  */
5798
5799                                                 T(YAFFS_TRACE_ERROR,
5800                                                   (TSTR
5801                                                    ("yaffs tragedy: attempting to use non-directory as a directory in scan. Put in lost+found."
5802                                                     TENDSTR)));
5803                                                 parent = dev->lostNFoundDir;
5804                                         }
5805
5806                                         yaffs_AddObjectToDirectory(parent, in);
5807
5808                                         if (0 && (parent == dev->deletedDir ||
5809                                                   parent == dev->unlinkedDir)) {
5810                                                 in->deleted = 1;        /* If it is unlinked at start up then it wants deleting */
5811                                                 dev->nDeletedFiles++;
5812                                         }
5813                                         /* Note re hardlinks.
5814                                          * Since we might scan a hardlink before its equivalent object is scanned
5815                                          * we put them all in a list.
5816                                          * After scanning is complete, we should have all the objects, so we run through this
5817                                          * list and fix up all the chains.
5818                                          */
5819
5820                                         switch (in->variantType) {
5821                                         case YAFFS_OBJECT_TYPE_UNKNOWN:
5822                                                 /* Todo got a problem */
5823                                                 break;
5824                                         case YAFFS_OBJECT_TYPE_FILE:
5825                                                 if (dev->useHeaderFileSize)
5826
5827                                                         in->variant.fileVariant.
5828                                                             fileSize =
5829                                                             oh->fileSize;
5830
5831                                                 break;
5832                                         case YAFFS_OBJECT_TYPE_HARDLINK:
5833                                                 in->variant.hardLinkVariant.
5834                                                     equivalentObjectId =
5835                                                     oh->equivalentObjectId;
5836                                                 in->hardLinks.next =
5837                                                     (struct ylist_head *)
5838                                                     hardList;
5839                                                 hardList = in;
5840                                                 break;
5841                                         case YAFFS_OBJECT_TYPE_DIRECTORY:
5842                                                 /* Do nothing */
5843                                                 break;
5844                                         case YAFFS_OBJECT_TYPE_SPECIAL:
5845                                                 /* Do nothing */
5846                                                 break;
5847                                         case YAFFS_OBJECT_TYPE_SYMLINK:
5848                                                 in->variant.symLinkVariant.alias =
5849                                                     yaffs_CloneString(oh->alias);
5850                                                 if(!in->variant.symLinkVariant.alias)
5851                                                         alloc_failed = 1;
5852                                                 break;
5853                                         }
5854
5855 /*
5856                                         if (parent == dev->deletedDir) {
5857                                                 yaffs_DestroyObject(in);
5858                                                 bi->hasShrinkHeader = 1;
5859                                         }
5860 */
5861                                 }
5862                         }
5863                 }
5864
5865                 if (state == YAFFS_BLOCK_STATE_NEEDS_SCANNING) {
5866                         /* If we got this far while scanning, then the block is fully allocated.*/
5867                         state = YAFFS_BLOCK_STATE_FULL;
5868                 }
5869
5870                 bi->blockState = state;
5871
5872                 /* Now let's see if it was dirty */
5873                 if (bi->pagesInUse == 0 &&
5874                     !bi->hasShrinkHeader &&
5875                     bi->blockState == YAFFS_BLOCK_STATE_FULL) {
5876                         yaffs_BlockBecameDirty(dev, blk);
5877                 }
5878
5879         }
5880
5881
5882         /* Ok, we've done all the scanning.
5883          * Fix up the hard link chains.
5884          * We should now have scanned all the objects, now it's time to add these
5885          * hardlinks.
5886          */
5887
5888         yaffs_HardlinkFixup(dev,hardList);
5889
5890         /* Handle the unlinked files. Since they were left in an unlinked state we should
5891          * just delete them.
5892          */
5893         {
5894                 struct ylist_head *i;
5895                 struct ylist_head *n;
5896
5897                 yaffs_Object *l;
5898                 /* Soft delete all the unlinked files */
5899                 ylist_for_each_safe(i, n,
5900                                    &dev->unlinkedDir->variant.directoryVariant.
5901                                    children) {
5902                         if (i) {
5903                                 l = ylist_entry(i, yaffs_Object, siblings);
5904                                 yaffs_DestroyObject(l);
5905                         }
5906                 }
5907         }
5908
5909         /* Fix up any shadowed objects */
5910         {
5911                 struct yaffs_ShadowFixerStruct *fixer;
5912                 yaffs_Object *obj;
5913
5914                 while(shadowFixerList){
5915                         fixer = shadowFixerList;
5916                         shadowFixerList = fixer->next;
5917                         /* Complete the rename transaction by deleting the shadowed object
5918                          * then setting the object header to unshadowed.
5919                          */
5920                         obj = yaffs_FindObjectByNumber(dev,fixer->shadowedId);
5921                         if(obj)
5922                                 yaffs_DestroyObject(obj);
5923
5924                         obj = yaffs_FindObjectByNumber(dev,fixer->objectId);
5925                         if(obj){
5926                                 yaffs_UpdateObjectHeader(obj,NULL,1,0,0);
5927                         }
5928
5929                         YFREE(fixer);
5930                 }
5931         }
5932
5933         yaffs_ReleaseTempBuffer(dev, chunkData, __LINE__);
5934
5935         if(alloc_failed){
5936                 return YAFFS_FAIL;
5937         }
5938
5939         T(YAFFS_TRACE_SCAN, (TSTR("yaffs_Scan ends" TENDSTR)));
5940
5941
5942         return YAFFS_OK;
5943 }
5944
5945 static void yaffs_CheckObjectDetailsLoaded(yaffs_Object *in)
5946 {
5947         __u8 *chunkData;
5948         yaffs_ObjectHeader *oh;
5949         yaffs_Device *dev;
5950         yaffs_ExtendedTags tags;
5951         int result;
5952         int alloc_failed = 0;
5953
5954         if(!in)
5955                 return;
5956
5957         dev = in->myDev;
5958
5959 #if 0
5960         T(YAFFS_TRACE_SCAN,(TSTR("details for object %d %s loaded" TENDSTR),
5961                 in->objectId,
5962                 in->lazyLoaded ? "not yet" : "already"));
5963 #endif
5964
5965         if(in->lazyLoaded && in->hdrChunk > 0){
5966                 in->lazyLoaded = 0;
5967                 chunkData = yaffs_GetTempBuffer(dev, __LINE__);
5968
5969                 result = yaffs_ReadChunkWithTagsFromNAND(dev,in->hdrChunk,chunkData,&tags);
5970                 oh = (yaffs_ObjectHeader *) chunkData;
5971
5972                 in->yst_mode = oh->yst_mode;
5973 #ifdef CONFIG_YAFFS_WINCE
5974                 in->win_atime[0] = oh->win_atime[0];
5975                 in->win_ctime[0] = oh->win_ctime[0];
5976                 in->win_mtime[0] = oh->win_mtime[0];
5977                 in->win_atime[1] = oh->win_atime[1];
5978                 in->win_ctime[1] = oh->win_ctime[1];
5979                 in->win_mtime[1] = oh->win_mtime[1];
5980 #else
5981                 in->yst_uid = oh->yst_uid;
5982                 in->yst_gid = oh->yst_gid;
5983                 in->yst_atime = oh->yst_atime;
5984                 in->yst_mtime = oh->yst_mtime;
5985                 in->yst_ctime = oh->yst_ctime;
5986                 in->yst_rdev = oh->yst_rdev;
5987
5988 #endif
5989                 yaffs_SetObjectName(in, oh->name);
5990
5991                 if(in->variantType == YAFFS_OBJECT_TYPE_SYMLINK){
5992                          in->variant.symLinkVariant.alias =
5993                                                     yaffs_CloneString(oh->alias);
5994                         if(!in->variant.symLinkVariant.alias)
5995                                 alloc_failed = 1; /* Not returned to caller */
5996                 }
5997
5998                 yaffs_ReleaseTempBuffer(dev,chunkData, __LINE__);
5999         }
6000 }
6001
6002 static int yaffs_ScanBackwards(yaffs_Device * dev)
6003 {
6004         yaffs_ExtendedTags tags;
6005         int blk;
6006         int blockIterator;
6007         int startIterator;
6008         int endIterator;
6009         int nBlocksToScan = 0;
6010
6011         int chunk;
6012         int result;
6013         int c;
6014         int deleted;
6015         yaffs_BlockState state;
6016         yaffs_Object *hardList = NULL;
6017         yaffs_BlockInfo *bi;
6018         __u32 sequenceNumber;
6019         yaffs_ObjectHeader *oh;
6020         yaffs_Object *in;
6021         yaffs_Object *parent;
6022         int nBlocks = dev->internalEndBlock - dev->internalStartBlock + 1;
6023         int itsUnlinked;
6024         __u8 *chunkData;
6025
6026         int fileSize;
6027         int isShrink;
6028         int foundChunksInBlock;
6029         int equivalentObjectId;
6030         int alloc_failed = 0;
6031
6032
6033         yaffs_BlockIndex *blockIndex = NULL;
6034         int altBlockIndex = 0;
6035
6036         if (!dev->isYaffs2) {
6037                 T(YAFFS_TRACE_SCAN,
6038                   (TSTR("yaffs_ScanBackwards is only for YAFFS2!" TENDSTR)));
6039                 return YAFFS_FAIL;
6040         }
6041
6042         T(YAFFS_TRACE_SCAN,
6043           (TSTR
6044            ("yaffs_ScanBackwards starts  intstartblk %d intendblk %d..."
6045             TENDSTR), dev->internalStartBlock, dev->internalEndBlock));
6046
6047
6048         dev->sequenceNumber = YAFFS_LOWEST_SEQUENCE_NUMBER;
6049
6050         blockIndex = YMALLOC(nBlocks * sizeof(yaffs_BlockIndex));
6051
6052         if(!blockIndex) {
6053                 blockIndex = YMALLOC_ALT(nBlocks * sizeof(yaffs_BlockIndex));
6054                 altBlockIndex = 1;
6055         }
6056
6057         if(!blockIndex) {
6058                 T(YAFFS_TRACE_SCAN,
6059                   (TSTR("yaffs_Scan() could not allocate block index!" TENDSTR)));
6060                 return YAFFS_FAIL;
6061         }
6062
6063         dev->blocksInCheckpoint = 0;
6064
6065         chunkData = yaffs_GetTempBuffer(dev, __LINE__);
6066
6067         /* Scan all the blocks to determine their state */
6068         for (blk = dev->internalStartBlock; blk <= dev->internalEndBlock; blk++) {
6069                 bi = yaffs_GetBlockInfo(dev, blk);
6070                 yaffs_ClearChunkBits(dev, blk);
6071                 bi->pagesInUse = 0;
6072                 bi->softDeletions = 0;
6073
6074                 yaffs_QueryInitialBlockState(dev, blk, &state, &sequenceNumber);
6075
6076                 bi->blockState = state;
6077                 bi->sequenceNumber = sequenceNumber;
6078
6079                 if(bi->sequenceNumber == YAFFS_SEQUENCE_CHECKPOINT_DATA)
6080                         bi->blockState = state = YAFFS_BLOCK_STATE_CHECKPOINT;
6081
6082                 T(YAFFS_TRACE_SCAN_DEBUG,
6083                   (TSTR("Block scanning block %d state %d seq %d" TENDSTR), blk,
6084                    state, sequenceNumber));
6085
6086
6087                 if(state == YAFFS_BLOCK_STATE_CHECKPOINT){
6088                         dev->blocksInCheckpoint++;
6089
6090                 } else if (state == YAFFS_BLOCK_STATE_DEAD) {
6091                         T(YAFFS_TRACE_BAD_BLOCKS,
6092                           (TSTR("block %d is bad" TENDSTR), blk));
6093                 } else if (state == YAFFS_BLOCK_STATE_EMPTY) {
6094                         T(YAFFS_TRACE_SCAN_DEBUG,
6095                           (TSTR("Block empty " TENDSTR)));
6096                         dev->nErasedBlocks++;
6097                         dev->nFreeChunks += dev->nChunksPerBlock;
6098                 } else if (state == YAFFS_BLOCK_STATE_NEEDS_SCANNING) {
6099
6100                         /* Determine the highest sequence number */
6101                         if (sequenceNumber >= YAFFS_LOWEST_SEQUENCE_NUMBER &&
6102                             sequenceNumber < YAFFS_HIGHEST_SEQUENCE_NUMBER) {
6103
6104                                 blockIndex[nBlocksToScan].seq = sequenceNumber;
6105                                 blockIndex[nBlocksToScan].block = blk;
6106
6107                                 nBlocksToScan++;
6108
6109                                 if (sequenceNumber >= dev->sequenceNumber) {
6110                                         dev->sequenceNumber = sequenceNumber;
6111                                 }
6112                         } else {
6113                                 /* TODO: Nasty sequence number! */
6114                                 T(YAFFS_TRACE_SCAN,
6115                                   (TSTR
6116                                    ("Block scanning block %d has bad sequence number %d"
6117                                     TENDSTR), blk, sequenceNumber));
6118
6119                         }
6120                 }
6121         }
6122
6123         T(YAFFS_TRACE_SCAN,
6124         (TSTR("%d blocks to be sorted..." TENDSTR), nBlocksToScan));
6125
6126
6127
6128         YYIELD();
6129
6130         /* Sort the blocks */
6131 #ifndef CONFIG_YAFFS_USE_OWN_SORT
6132         {
6133                 /* Use qsort now. */
6134                 yaffs_qsort(blockIndex, nBlocksToScan, sizeof(yaffs_BlockIndex), ybicmp);
6135         }
6136 #else
6137         {
6138                 /* Dungy old bubble sort... */
6139
6140                 yaffs_BlockIndex temp;
6141                 int i;
6142                 int j;
6143
6144                 for (i = 0; i < nBlocksToScan; i++)
6145                         for (j = i + 1; j < nBlocksToScan; j++)
6146                                 if (blockIndex[i].seq > blockIndex[j].seq) {
6147                                         temp = blockIndex[j];
6148                                         blockIndex[j] = blockIndex[i];
6149                                         blockIndex[i] = temp;
6150                                 }
6151         }
6152 #endif
6153
6154         YYIELD();
6155
6156         T(YAFFS_TRACE_SCAN, (TSTR("...done" TENDSTR)));
6157
6158         /* Now scan the blocks looking at the data. */
6159         startIterator = 0;
6160         endIterator = nBlocksToScan - 1;
6161         T(YAFFS_TRACE_SCAN_DEBUG,
6162           (TSTR("%d blocks to be scanned" TENDSTR), nBlocksToScan));
6163
6164         /* For each block.... backwards */
6165         for (blockIterator = endIterator; !alloc_failed && blockIterator >= startIterator;
6166              blockIterator--) {
6167                 /* Cooperative multitasking! This loop can run for so
6168                    long that watchdog timers expire. */
6169                 YYIELD();
6170
6171                 /* get the block to scan in the correct order */
6172                 blk = blockIndex[blockIterator].block;
6173
6174                 bi = yaffs_GetBlockInfo(dev, blk);
6175
6176
6177                 state = bi->blockState;
6178
6179                 deleted = 0;
6180
6181                 /* For each chunk in each block that needs scanning.... */
6182                 foundChunksInBlock = 0;
6183                 for (c = dev->nChunksPerBlock - 1;
6184                      !alloc_failed && c >= 0 &&
6185                      (state == YAFFS_BLOCK_STATE_NEEDS_SCANNING ||
6186                       state == YAFFS_BLOCK_STATE_ALLOCATING); c--) {
6187                         /* Scan backwards...
6188                          * Read the tags and decide what to do
6189                          */
6190
6191                         chunk = blk * dev->nChunksPerBlock + c;
6192
6193                         result = yaffs_ReadChunkWithTagsFromNAND(dev, chunk, NULL,
6194                                                         &tags);
6195
6196                         /* Let's have a good look at this chunk... */
6197
6198                         if (!tags.chunkUsed) {
6199                                 /* An unassigned chunk in the block.
6200                                  * If there are used chunks after this one, then
6201                                  * it is a chunk that was skipped due to failing the erased
6202                                  * check. Just skip it so that it can be deleted.
6203                                  * But, more typically, We get here when this is an unallocated
6204                                  * chunk and his means that either the block is empty or
6205                                  * this is the one being allocated from
6206                                  */
6207
6208                                 if(foundChunksInBlock)
6209                                 {
6210                                         /* This is a chunk that was skipped due to failing the erased check */
6211
6212                                 } else if (c == 0) {
6213                                         /* We're looking at the first chunk in the block so the block is unused */
6214                                         state = YAFFS_BLOCK_STATE_EMPTY;
6215                                         dev->nErasedBlocks++;
6216                                 } else {
6217                                         if (state == YAFFS_BLOCK_STATE_NEEDS_SCANNING ||
6218                                             state == YAFFS_BLOCK_STATE_ALLOCATING) {
6219                                                 if(dev->sequenceNumber == bi->sequenceNumber) {
6220                                                         /* this is the block being allocated from */
6221
6222                                                         T(YAFFS_TRACE_SCAN,
6223                                                           (TSTR
6224                                                            (" Allocating from %d %d"
6225                                                             TENDSTR), blk, c));
6226
6227                                                         state = YAFFS_BLOCK_STATE_ALLOCATING;
6228                                                         dev->allocationBlock = blk;
6229                                                         dev->allocationPage = c;
6230                                                         dev->allocationBlockFinder = blk;
6231                                                 }
6232                                                 else {
6233                                                         /* This is a partially written block that is not
6234                                                          * the current allocation block. This block must have
6235                                                          * had a write failure, so set up for retirement.
6236                                                          */
6237
6238                                                          /* bi->needsRetiring = 1; ??? TODO */
6239                                                          bi->gcPrioritise = 1;
6240
6241                                                          T(YAFFS_TRACE_ALWAYS,
6242                                                          (TSTR("Partially written block %d detected" TENDSTR),
6243                                                          blk));
6244                                                 }
6245
6246                                         }
6247
6248                                 }
6249
6250                                 dev->nFreeChunks++;
6251
6252                         } else if (tags.chunkId > 0) {
6253                                 /* chunkId > 0 so it is a data chunk... */
6254                                 unsigned int endpos;
6255                                 __u32 chunkBase =
6256                                     (tags.chunkId - 1) * dev->nDataBytesPerChunk;
6257
6258                                 foundChunksInBlock = 1;
6259
6260
6261                                 yaffs_SetChunkBit(dev, blk, c);
6262                                 bi->pagesInUse++;
6263
6264                                 in = yaffs_FindOrCreateObjectByNumber(dev,
6265                                                                       tags.
6266                                                                       objectId,
6267                                                                       YAFFS_OBJECT_TYPE_FILE);
6268                                 if(!in){
6269                                         /* Out of memory */
6270                                         alloc_failed = 1;
6271                                 }
6272
6273                                 if (in &&
6274                                     in->variantType == YAFFS_OBJECT_TYPE_FILE
6275                                     && chunkBase <
6276                                     in->variant.fileVariant.shrinkSize) {
6277                                         /* This has not been invalidated by a resize */
6278                                         if(!yaffs_PutChunkIntoFile(in, tags.chunkId,
6279                                                                chunk, -1)){
6280                                                 alloc_failed = 1;
6281                                         }
6282
6283                                         /* File size is calculated by looking at the data chunks if we have not
6284                                          * seen an object header yet. Stop this practice once we find an object header.
6285                                          */
6286                                         endpos =
6287                                             (tags.chunkId -
6288                                              1) * dev->nDataBytesPerChunk +
6289                                             tags.byteCount;
6290
6291                                         if (!in->valid &&       /* have not got an object header yet */
6292                                             in->variant.fileVariant.
6293                                             scannedFileSize < endpos) {
6294                                                 in->variant.fileVariant.
6295                                                     scannedFileSize = endpos;
6296                                                 in->variant.fileVariant.
6297                                                     fileSize =
6298                                                     in->variant.fileVariant.
6299                                                     scannedFileSize;
6300                                         }
6301
6302                                 } else if(in) {
6303                                         /* This chunk has been invalidated by a resize, so delete */
6304                                         yaffs_DeleteChunk(dev, chunk, 1, __LINE__);
6305
6306                                 }
6307                         } else {
6308                                 /* chunkId == 0, so it is an ObjectHeader.
6309                                  * Thus, we read in the object header and make the object
6310                                  */
6311                                 foundChunksInBlock = 1;
6312
6313                                 yaffs_SetChunkBit(dev, blk, c);
6314                                 bi->pagesInUse++;
6315
6316                                 oh = NULL;
6317                                 in = NULL;
6318
6319                                 if (tags.extraHeaderInfoAvailable) {
6320                                         in = yaffs_FindOrCreateObjectByNumber
6321                                             (dev, tags.objectId,
6322                                              tags.extraObjectType);
6323                                 }
6324
6325                                 if (!in ||
6326 #ifdef CONFIG_YAFFS_DISABLE_LAZY_LOAD
6327                                     !in->valid ||
6328 #endif
6329                                     tags.extraShadows ||
6330                                     (!in->valid &&
6331                                     (tags.objectId == YAFFS_OBJECTID_ROOT ||
6332                                      tags.objectId == YAFFS_OBJECTID_LOSTNFOUND))
6333                                     ) {
6334
6335                                         /* If we don't have  valid info then we need to read the chunk
6336                                          * TODO In future we can probably defer reading the chunk and
6337                                          * living with invalid data until needed.
6338                                          */
6339
6340                                         result = yaffs_ReadChunkWithTagsFromNAND(dev,
6341                                                                         chunk,
6342                                                                         chunkData,
6343                                                                         NULL);
6344
6345                                         oh = (yaffs_ObjectHeader *) chunkData;
6346
6347                                         if(dev->inbandTags){
6348                                                 /* Fix up the header if they got corrupted by inband tags */
6349                                                 oh->shadowsObject = oh->inbandShadowsObject;
6350                                                 oh->isShrink = oh->inbandIsShrink;
6351                                         }
6352
6353                                         if (!in)
6354                                                 in = yaffs_FindOrCreateObjectByNumber(dev, tags.objectId, oh->type);
6355
6356                                 }
6357
6358                                 if (!in) {
6359                                         /* TODO Hoosterman we have a problem! */
6360                                         T(YAFFS_TRACE_ERROR,
6361                                           (TSTR
6362                                            ("yaffs tragedy: Could not make object for object  %d at chunk %d during scan"
6363                                             TENDSTR), tags.objectId, chunk));
6364
6365                                 }
6366
6367                                 if (in->valid) {
6368                                         /* We have already filled this one.
6369                                          * We have a duplicate that will be discarded, but
6370                                          * we first have to suck out resize info if it is a file.
6371                                          */
6372
6373                                         if ((in->variantType == YAFFS_OBJECT_TYPE_FILE) &&
6374                                              ((oh &&
6375                                                oh-> type == YAFFS_OBJECT_TYPE_FILE)||
6376                                               (tags.extraHeaderInfoAvailable  &&
6377                                                tags.extraObjectType == YAFFS_OBJECT_TYPE_FILE))
6378                                             ) {
6379                                                 __u32 thisSize =
6380                                                     (oh) ? oh->fileSize : tags.
6381                                                     extraFileLength;
6382                                                 __u32 parentObjectId =
6383                                                     (oh) ? oh->
6384                                                     parentObjectId : tags.
6385                                                     extraParentObjectId;
6386
6387
6388                                                 isShrink =
6389                                                     (oh) ? oh->isShrink : tags.
6390                                                     extraIsShrinkHeader;
6391
6392                                                 /* If it is deleted (unlinked at start also means deleted)
6393                                                  * we treat the file size as being zeroed at this point.
6394                                                  */
6395                                                 if (parentObjectId ==
6396                                                     YAFFS_OBJECTID_DELETED
6397                                                     || parentObjectId ==
6398                                                     YAFFS_OBJECTID_UNLINKED) {
6399                                                         thisSize = 0;
6400                                                         isShrink = 1;
6401                                                 }
6402
6403                                                 if (isShrink &&
6404                                                     in->variant.fileVariant.
6405                                                     shrinkSize > thisSize) {
6406                                                         in->variant.fileVariant.
6407                                                             shrinkSize =
6408                                                             thisSize;
6409                                                 }
6410
6411                                                 if (isShrink) {
6412                                                         bi->hasShrinkHeader = 1;
6413                                                 }
6414
6415                                         }
6416                                         /* Use existing - destroy this one. */
6417                                         yaffs_DeleteChunk(dev, chunk, 1, __LINE__);
6418
6419                                 }
6420
6421                                 if (!in->valid &&
6422                                     (tags.objectId == YAFFS_OBJECTID_ROOT ||
6423                                      tags.objectId ==
6424                                      YAFFS_OBJECTID_LOSTNFOUND)) {
6425                                         /* We only load some info, don't fiddle with directory structure */
6426                                         in->valid = 1;
6427
6428                                         if(oh) {
6429                                                 in->variantType = oh->type;
6430
6431                                                 in->yst_mode = oh->yst_mode;
6432 #ifdef CONFIG_YAFFS_WINCE
6433                                                 in->win_atime[0] = oh->win_atime[0];
6434                                                 in->win_ctime[0] = oh->win_ctime[0];
6435                                                 in->win_mtime[0] = oh->win_mtime[0];
6436                                                 in->win_atime[1] = oh->win_atime[1];
6437                                                 in->win_ctime[1] = oh->win_ctime[1];
6438                                                 in->win_mtime[1] = oh->win_mtime[1];
6439 #else
6440                                                 in->yst_uid = oh->yst_uid;
6441                                                 in->yst_gid = oh->yst_gid;
6442                                                 in->yst_atime = oh->yst_atime;
6443                                                 in->yst_mtime = oh->yst_mtime;
6444                                                 in->yst_ctime = oh->yst_ctime;
6445                                                 in->yst_rdev = oh->yst_rdev;
6446
6447 #endif
6448                                         } else {
6449                                                 in->variantType = tags.extraObjectType;
6450                                                 in->lazyLoaded = 1;
6451                                         }
6452
6453                                         in->hdrChunk = chunk;
6454
6455                                 } else if (!in->valid) {
6456                                         /* we need to load this info */
6457
6458                                         in->valid = 1;
6459                                         in->hdrChunk = chunk;
6460
6461                                         if(oh) {
6462                                                 in->variantType = oh->type;
6463
6464                                                 in->yst_mode = oh->yst_mode;
6465 #ifdef CONFIG_YAFFS_WINCE
6466                                                 in->win_atime[0] = oh->win_atime[0];
6467                                                 in->win_ctime[0] = oh->win_ctime[0];
6468                                                 in->win_mtime[0] = oh->win_mtime[0];
6469                                                 in->win_atime[1] = oh->win_atime[1];
6470                                                 in->win_ctime[1] = oh->win_ctime[1];
6471                                                 in->win_mtime[1] = oh->win_mtime[1];
6472 #else
6473                                                 in->yst_uid = oh->yst_uid;
6474                                                 in->yst_gid = oh->yst_gid;
6475                                                 in->yst_atime = oh->yst_atime;
6476                                                 in->yst_mtime = oh->yst_mtime;
6477                                                 in->yst_ctime = oh->yst_ctime;
6478                                                 in->yst_rdev = oh->yst_rdev;
6479 #endif
6480
6481                                                 if (oh->shadowsObject > 0)
6482                                                         yaffs_HandleShadowedObject(dev,
6483                                                                            oh->
6484                                                                            shadowsObject,
6485                                                                            1);
6486
6487
6488                                                 yaffs_SetObjectName(in, oh->name);
6489                                                 parent =
6490                                                     yaffs_FindOrCreateObjectByNumber
6491                                                         (dev, oh->parentObjectId,
6492                                                          YAFFS_OBJECT_TYPE_DIRECTORY);
6493
6494                                                  fileSize = oh->fileSize;
6495                                                  isShrink = oh->isShrink;
6496                                                  equivalentObjectId = oh->equivalentObjectId;
6497
6498                                         }
6499                                         else {
6500                                                 in->variantType = tags.extraObjectType;
6501                                                 parent =
6502                                                     yaffs_FindOrCreateObjectByNumber
6503                                                         (dev, tags.extraParentObjectId,
6504                                                          YAFFS_OBJECT_TYPE_DIRECTORY);
6505                                                  fileSize = tags.extraFileLength;
6506                                                  isShrink = tags.extraIsShrinkHeader;
6507                                                  equivalentObjectId = tags.extraEquivalentObjectId;
6508                                                 in->lazyLoaded = 1;
6509
6510                                         }
6511                                         in->dirty = 0;
6512
6513                                         /* directory stuff...
6514                                          * hook up to parent
6515                                          */
6516
6517                                         if (parent->variantType ==
6518                                             YAFFS_OBJECT_TYPE_UNKNOWN) {
6519                                                 /* Set up as a directory */
6520                                                 parent->variantType =
6521                                                     YAFFS_OBJECT_TYPE_DIRECTORY;
6522                                                 YINIT_LIST_HEAD(&parent->variant.
6523                                                                directoryVariant.
6524                                                                children);
6525                                         } else if (parent->variantType !=
6526                                                    YAFFS_OBJECT_TYPE_DIRECTORY)
6527                                         {
6528                                                 /* Hoosterman, another problem....
6529                                                  * We're trying to use a non-directory as a directory
6530                                                  */
6531
6532                                                 T(YAFFS_TRACE_ERROR,
6533                                                   (TSTR
6534                                                    ("yaffs tragedy: attempting to use non-directory as a directory in scan. Put in lost+found."
6535                                                     TENDSTR)));
6536                                                 parent = dev->lostNFoundDir;
6537                                         }
6538
6539                                         yaffs_AddObjectToDirectory(parent, in);
6540
6541                                         itsUnlinked = (parent == dev->deletedDir) ||
6542                                                       (parent == dev->unlinkedDir);
6543
6544                                         if (isShrink) {
6545                                                 /* Mark the block as having a shrinkHeader */
6546                                                 bi->hasShrinkHeader = 1;
6547                                         }
6548
6549                                         /* Note re hardlinks.
6550                                          * Since we might scan a hardlink before its equivalent object is scanned
6551                                          * we put them all in a list.
6552                                          * After scanning is complete, we should have all the objects, so we run
6553                                          * through this list and fix up all the chains.
6554                                          */
6555
6556                                         switch (in->variantType) {
6557                                         case YAFFS_OBJECT_TYPE_UNKNOWN:
6558                                                 /* Todo got a problem */
6559                                                 break;
6560                                         case YAFFS_OBJECT_TYPE_FILE:
6561
6562                                                 if (in->variant.fileVariant.
6563                                                     scannedFileSize < fileSize) {
6564                                                         /* This covers the case where the file size is greater
6565                                                          * than where the data is
6566                                                          * This will happen if the file is resized to be larger
6567                                                          * than its current data extents.
6568                                                          */
6569                                                         in->variant.fileVariant.fileSize = fileSize;
6570                                                         in->variant.fileVariant.scannedFileSize =
6571                                                             in->variant.fileVariant.fileSize;
6572                                                 }
6573
6574                                                 if (isShrink &&
6575                                                     in->variant.fileVariant.shrinkSize > fileSize) {
6576                                                         in->variant.fileVariant.shrinkSize = fileSize;
6577                                                 }
6578
6579                                                 break;
6580                                         case YAFFS_OBJECT_TYPE_HARDLINK:
6581                                                 if(!itsUnlinked) {
6582                                                   in->variant.hardLinkVariant.equivalentObjectId =
6583                                                     equivalentObjectId;
6584                                                   in->hardLinks.next =
6585                                                     (struct ylist_head *) hardList;
6586                                                   hardList = in;
6587                                                 }
6588                                                 break;
6589                                         case YAFFS_OBJECT_TYPE_DIRECTORY:
6590                                                 /* Do nothing */
6591                                                 break;
6592                                         case YAFFS_OBJECT_TYPE_SPECIAL:
6593                                                 /* Do nothing */
6594                                                 break;
6595                                         case YAFFS_OBJECT_TYPE_SYMLINK:
6596                                                 if(oh){
6597                                                    in->variant.symLinkVariant.alias =
6598                                                     yaffs_CloneString(oh->
6599                                                                       alias);
6600                                                    if(!in->variant.symLinkVariant.alias)
6601                                                         alloc_failed = 1;
6602                                                 }
6603                                                 break;
6604                                         }
6605
6606                                 }
6607
6608                         }
6609
6610                 } /* End of scanning for each chunk */
6611
6612                 if (state == YAFFS_BLOCK_STATE_NEEDS_SCANNING) {
6613                         /* If we got this far while scanning, then the block is fully allocated. */
6614                         state = YAFFS_BLOCK_STATE_FULL;
6615                 }
6616
6617                 bi->blockState = state;
6618
6619                 /* Now let's see if it was dirty */
6620                 if (bi->pagesInUse == 0 &&
6621                     !bi->hasShrinkHeader &&
6622                     bi->blockState == YAFFS_BLOCK_STATE_FULL) {
6623                         yaffs_BlockBecameDirty(dev, blk);
6624                 }
6625
6626         }
6627
6628         if (altBlockIndex)
6629                 YFREE_ALT(blockIndex);
6630         else
6631                 YFREE(blockIndex);
6632
6633         /* Ok, we've done all the scanning.
6634          * Fix up the hard link chains.
6635          * We should now have scanned all the objects, now it's time to add these
6636          * hardlinks.
6637          */
6638         yaffs_HardlinkFixup(dev,hardList);
6639
6640
6641         /*
6642         *  Sort out state of unlinked and deleted objects.
6643         */
6644         {
6645                 struct ylist_head *i;
6646                 struct ylist_head *n;
6647
6648                 yaffs_Object *l;
6649
6650                 /* Soft delete all the unlinked files */
6651                 ylist_for_each_safe(i, n,
6652                                    &dev->unlinkedDir->variant.directoryVariant.
6653                                    children) {
6654                         if (i) {
6655                                 l = ylist_entry(i, yaffs_Object, siblings);
6656                                 yaffs_DestroyObject(l);
6657                         }
6658                 }
6659
6660                 /* Soft delete all the deletedDir files */
6661                 ylist_for_each_safe(i, n,
6662                                    &dev->deletedDir->variant.directoryVariant.
6663                                    children) {
6664                         if (i) {
6665                                 l = ylist_entry(i, yaffs_Object, siblings);
6666                                 yaffs_DestroyObject(l);
6667
6668                         }
6669                 }
6670         }
6671
6672         yaffs_ReleaseTempBuffer(dev, chunkData, __LINE__);
6673
6674         if(alloc_failed){
6675                 return YAFFS_FAIL;
6676         }
6677
6678         T(YAFFS_TRACE_SCAN, (TSTR("yaffs_ScanBackwards ends" TENDSTR)));
6679
6680         return YAFFS_OK;
6681 }
6682
6683 /*------------------------------  Directory Functions ----------------------------- */
6684
6685 static void yaffs_VerifyObjectInDirectory(yaffs_Object *obj)
6686 {
6687         struct ylist_head *lh;
6688         yaffs_Object *listObj;
6689
6690         int count = 0;
6691
6692         if(!obj)
6693                 YBUG();
6694
6695         if(yaffs_SkipVerification(obj->myDev))
6696                 return;
6697
6698         if(!obj->parent)
6699                 YBUG();
6700
6701         if(obj->parent->variantType != YAFFS_OBJECT_TYPE_DIRECTORY)
6702                 YBUG();
6703
6704         /* Iterate through the objects in each hash entry */
6705
6706         ylist_for_each(lh, &obj->parent->variant.directoryVariant.children) {
6707                 if (lh) {
6708                         listObj = ylist_entry(lh, yaffs_Object, siblings);
6709                         yaffs_VerifyObject(listObj);
6710                         if(obj == listObj)
6711                                 count ++;
6712                 }
6713          }
6714
6715          if(count != 1)
6716                 YBUG();
6717
6718
6719 }
6720
6721 static void yaffs_VerifyDirectory(yaffs_Object *directory)
6722 {
6723
6724         struct ylist_head *lh;
6725         yaffs_Object *listObj;
6726
6727         if(!directory)
6728                 YBUG();
6729
6730         if(yaffs_SkipVerification(directory->myDev))
6731                 return;
6732
6733
6734         if(directory->variantType != YAFFS_OBJECT_TYPE_DIRECTORY)
6735                 YBUG();
6736
6737         /* Iterate through the objects in each hash entry */
6738
6739         ylist_for_each(lh, &directory->variant.directoryVariant.children) {
6740                 if (lh) {
6741                         listObj = ylist_entry(lh, yaffs_Object, siblings);
6742                         if(listObj->parent != directory)
6743                                 YBUG();
6744                         yaffs_VerifyObjectInDirectory(listObj);
6745                 }
6746          }
6747
6748 }
6749
6750
6751 static void yaffs_RemoveObjectFromDirectory(yaffs_Object * obj)
6752 {
6753         yaffs_Device *dev = obj->myDev;
6754         yaffs_Object *parent;
6755
6756         yaffs_VerifyObjectInDirectory(obj);
6757         parent = obj->parent;
6758
6759         yaffs_VerifyDirectory(parent);
6760
6761         if(dev && dev->removeObjectCallback)
6762                 dev->removeObjectCallback(obj);
6763
6764
6765         ylist_del_init(&obj->siblings);
6766         obj->parent = NULL;
6767
6768         yaffs_VerifyDirectory(parent);
6769
6770 }
6771
6772
6773 static void yaffs_AddObjectToDirectory(yaffs_Object * directory,
6774                                        yaffs_Object * obj)
6775 {
6776
6777         if (!directory) {
6778                 T(YAFFS_TRACE_ALWAYS,
6779                   (TSTR
6780                    ("tragedy: Trying to add an object to a null pointer directory"
6781                     TENDSTR)));
6782                 YBUG();
6783         }
6784         if (directory->variantType != YAFFS_OBJECT_TYPE_DIRECTORY) {
6785                 T(YAFFS_TRACE_ALWAYS,
6786                   (TSTR
6787                    ("tragedy: Trying to add an object to a non-directory"
6788                     TENDSTR)));
6789                 YBUG();
6790         }
6791
6792         if (obj->siblings.prev == NULL) {
6793                 /* Not initialised */
6794                 YBUG();
6795
6796         } else if (ylist_empty(&obj->siblings)) {
6797                 YBUG();
6798         }
6799
6800
6801         yaffs_VerifyDirectory(directory);
6802
6803         yaffs_RemoveObjectFromDirectory(obj);
6804
6805
6806         /* Now add it */
6807         ylist_add(&obj->siblings, &directory->variant.directoryVariant.children);
6808         obj->parent = directory;
6809
6810         if (directory == obj->myDev->unlinkedDir
6811             || directory == obj->myDev->deletedDir) {
6812                 obj->unlinked = 1;
6813                 obj->myDev->nUnlinkedFiles++;
6814                 obj->renameAllowed = 0;
6815         }
6816
6817         yaffs_VerifyDirectory(directory);
6818         yaffs_VerifyObjectInDirectory(obj);
6819
6820
6821 }
6822
6823 yaffs_Object *yaffs_FindObjectByName(yaffs_Object * directory,
6824                                      const YCHAR * name)
6825 {
6826         int sum;
6827
6828         struct ylist_head *i;
6829         YCHAR buffer[YAFFS_MAX_NAME_LENGTH + 1];
6830
6831         yaffs_Object *l;
6832
6833         if (!name) {
6834                 return NULL;
6835         }
6836
6837         if (!directory) {
6838                 T(YAFFS_TRACE_ALWAYS,
6839                   (TSTR
6840                    ("tragedy: yaffs_FindObjectByName: null pointer directory"
6841                     TENDSTR)));
6842                 YBUG();
6843         }
6844         if (directory->variantType != YAFFS_OBJECT_TYPE_DIRECTORY) {
6845                 T(YAFFS_TRACE_ALWAYS,
6846                   (TSTR
6847                    ("tragedy: yaffs_FindObjectByName: non-directory" TENDSTR)));
6848                 YBUG();
6849         }
6850
6851         sum = yaffs_CalcNameSum(name);
6852
6853         ylist_for_each(i, &directory->variant.directoryVariant.children) {
6854                 if (i) {
6855                         l = ylist_entry(i, yaffs_Object, siblings);
6856
6857                         if(l->parent != directory)
6858                                 YBUG();
6859
6860                         yaffs_CheckObjectDetailsLoaded(l);
6861
6862                         /* Special case for lost-n-found */
6863                         if (l->objectId == YAFFS_OBJECTID_LOSTNFOUND) {
6864                                 if (yaffs_strcmp(name, YAFFS_LOSTNFOUND_NAME) == 0) {
6865                                         return l;
6866                                 }
6867                         } else if (yaffs_SumCompare(l->sum, sum) || l->hdrChunk <= 0){
6868                                 /* LostnFound chunk called Objxxx
6869                                  * Do a real check
6870                                  */
6871                                 yaffs_GetObjectName(l, buffer,
6872                                                     YAFFS_MAX_NAME_LENGTH);
6873                                 if (yaffs_strncmp(name, buffer,YAFFS_MAX_NAME_LENGTH) == 0) {
6874                                         return l;
6875                                 }
6876
6877                         }
6878                 }
6879         }
6880
6881         return NULL;
6882 }
6883
6884
6885 #if 0
6886 int yaffs_ApplyToDirectoryChildren(yaffs_Object * theDir,
6887                                    int (*fn) (yaffs_Object *))
6888 {
6889         struct ylist_head *i;
6890         yaffs_Object *l;
6891
6892         if (!theDir) {
6893                 T(YAFFS_TRACE_ALWAYS,
6894                   (TSTR
6895                    ("tragedy: yaffs_FindObjectByName: null pointer directory"
6896                     TENDSTR)));
6897                 YBUG();
6898         }
6899         if (theDir->variantType != YAFFS_OBJECT_TYPE_DIRECTORY) {
6900                 T(YAFFS_TRACE_ALWAYS,
6901                   (TSTR
6902                    ("tragedy: yaffs_FindObjectByName: non-directory" TENDSTR)));
6903                 YBUG();
6904         }
6905
6906         ylist_for_each(i, &theDir->variant.directoryVariant.children) {
6907                 if (i) {
6908                         l = ylist_entry(i, yaffs_Object, siblings);
6909                         if (l && !fn(l)) {
6910                                 return YAFFS_FAIL;
6911                         }
6912                 }
6913         }
6914
6915         return YAFFS_OK;
6916
6917 }
6918 #endif
6919
6920 /* GetEquivalentObject dereferences any hard links to get to the
6921  * actual object.
6922  */
6923
6924 yaffs_Object *yaffs_GetEquivalentObject(yaffs_Object * obj)
6925 {
6926         if (obj && obj->variantType == YAFFS_OBJECT_TYPE_HARDLINK) {
6927                 /* We want the object id of the equivalent object, not this one */
6928                 obj = obj->variant.hardLinkVariant.equivalentObject;
6929                 yaffs_CheckObjectDetailsLoaded(obj);
6930         }
6931         return obj;
6932
6933 }
6934
6935 int yaffs_GetObjectName(yaffs_Object * obj, YCHAR * name, int buffSize)
6936 {
6937         memset(name, 0, buffSize * sizeof(YCHAR));
6938
6939         yaffs_CheckObjectDetailsLoaded(obj);
6940
6941         if (obj->objectId == YAFFS_OBJECTID_LOSTNFOUND) {
6942                 yaffs_strncpy(name, YAFFS_LOSTNFOUND_NAME, buffSize - 1);
6943         } else if (obj->hdrChunk <= 0) {
6944                 YCHAR locName[20];
6945                 YCHAR numString[20];
6946                 YCHAR *x = &numString[19];
6947                 unsigned v = obj->objectId;
6948                 numString[19] = 0;
6949                 while(v>0){
6950                         x--;
6951                         *x = '0' + (v % 10);
6952                         v /= 10;
6953                 }
6954                 /* make up a name */
6955                 yaffs_strcpy(locName, YAFFS_LOSTNFOUND_PREFIX);
6956                 yaffs_strcat(locName,x);
6957                 yaffs_strncpy(name, locName, buffSize - 1);
6958
6959         }
6960 #ifdef CONFIG_YAFFS_SHORT_NAMES_IN_RAM
6961         else if (obj->shortName[0]) {
6962                 yaffs_strcpy(name, obj->shortName);
6963         }
6964 #endif
6965         else {
6966                 int result;
6967                 __u8 *buffer = yaffs_GetTempBuffer(obj->myDev, __LINE__);
6968
6969                 yaffs_ObjectHeader *oh = (yaffs_ObjectHeader *) buffer;
6970
6971                 memset(buffer, 0, obj->myDev->nDataBytesPerChunk);
6972
6973                 if (obj->hdrChunk > 0) {
6974                         result = yaffs_ReadChunkWithTagsFromNAND(obj->myDev,
6975                                                         obj->hdrChunk, buffer,
6976                                                         NULL);
6977                 }
6978                 yaffs_strncpy(name, oh->name, buffSize - 1);
6979
6980                 yaffs_ReleaseTempBuffer(obj->myDev, buffer, __LINE__);
6981         }
6982
6983         return yaffs_strlen(name);
6984 }
6985
6986 int yaffs_GetObjectFileLength(yaffs_Object * obj)
6987 {
6988
6989         /* Dereference any hard linking */
6990         obj = yaffs_GetEquivalentObject(obj);
6991
6992         if (obj->variantType == YAFFS_OBJECT_TYPE_FILE) {
6993                 return obj->variant.fileVariant.fileSize;
6994         }
6995         if (obj->variantType == YAFFS_OBJECT_TYPE_SYMLINK) {
6996                 return yaffs_strlen(obj->variant.symLinkVariant.alias);
6997         } else {
6998                 /* Only a directory should drop through to here */
6999                 return obj->myDev->nDataBytesPerChunk;
7000         }
7001 }
7002
7003 int yaffs_GetObjectLinkCount(yaffs_Object * obj)
7004 {
7005         int count = 0;
7006         struct ylist_head *i;
7007
7008         if (!obj->unlinked) {
7009                 count++;        /* the object itself */
7010         }
7011         ylist_for_each(i, &obj->hardLinks) {
7012                 count++;        /* add the hard links; */
7013         }
7014         return count;
7015
7016 }
7017
7018 int yaffs_GetObjectInode(yaffs_Object * obj)
7019 {
7020         obj = yaffs_GetEquivalentObject(obj);
7021
7022         return obj->objectId;
7023 }
7024
7025 unsigned yaffs_GetObjectType(yaffs_Object * obj)
7026 {
7027         obj = yaffs_GetEquivalentObject(obj);
7028
7029         switch (obj->variantType) {
7030         case YAFFS_OBJECT_TYPE_FILE:
7031                 return DT_REG;
7032                 break;
7033         case YAFFS_OBJECT_TYPE_DIRECTORY:
7034                 return DT_DIR;
7035                 break;
7036         case YAFFS_OBJECT_TYPE_SYMLINK:
7037                 return DT_LNK;
7038                 break;
7039         case YAFFS_OBJECT_TYPE_HARDLINK:
7040                 return DT_REG;
7041                 break;
7042         case YAFFS_OBJECT_TYPE_SPECIAL:
7043                 if (S_ISFIFO(obj->yst_mode))
7044                         return DT_FIFO;
7045                 if (S_ISCHR(obj->yst_mode))
7046                         return DT_CHR;
7047                 if (S_ISBLK(obj->yst_mode))
7048                         return DT_BLK;
7049                 if (S_ISSOCK(obj->yst_mode))
7050                         return DT_SOCK;
7051         default:
7052                 return DT_REG;
7053                 break;
7054         }
7055 }
7056
7057 YCHAR *yaffs_GetSymlinkAlias(yaffs_Object * obj)
7058 {
7059         obj = yaffs_GetEquivalentObject(obj);
7060         if (obj->variantType == YAFFS_OBJECT_TYPE_SYMLINK) {
7061                 return yaffs_CloneString(obj->variant.symLinkVariant.alias);
7062         } else {
7063                 return yaffs_CloneString(_Y(""));
7064         }
7065 }
7066
7067 #ifndef CONFIG_YAFFS_WINCE
7068
7069 int yaffs_SetAttributes(yaffs_Object * obj, struct iattr *attr)
7070 {
7071         unsigned int valid = attr->ia_valid;
7072
7073         if (valid & ATTR_MODE)
7074                 obj->yst_mode = attr->ia_mode;
7075         if (valid & ATTR_UID)
7076                 obj->yst_uid = attr->ia_uid;
7077         if (valid & ATTR_GID)
7078                 obj->yst_gid = attr->ia_gid;
7079
7080         if (valid & ATTR_ATIME)
7081                 obj->yst_atime = Y_TIME_CONVERT(attr->ia_atime);
7082         if (valid & ATTR_CTIME)
7083                 obj->yst_ctime = Y_TIME_CONVERT(attr->ia_ctime);
7084         if (valid & ATTR_MTIME)
7085                 obj->yst_mtime = Y_TIME_CONVERT(attr->ia_mtime);
7086
7087         if (valid & ATTR_SIZE)
7088                 yaffs_ResizeFile(obj, attr->ia_size);
7089
7090         yaffs_UpdateObjectHeader(obj, NULL, 1, 0, 0);
7091
7092         return YAFFS_OK;
7093
7094 }
7095 int yaffs_GetAttributes(yaffs_Object * obj, struct iattr *attr)
7096 {
7097         unsigned int valid = 0;
7098
7099         attr->ia_mode = obj->yst_mode;
7100         valid |= ATTR_MODE;
7101         attr->ia_uid = obj->yst_uid;
7102         valid |= ATTR_UID;
7103         attr->ia_gid = obj->yst_gid;
7104         valid |= ATTR_GID;
7105
7106         Y_TIME_CONVERT(attr->ia_atime) = obj->yst_atime;
7107         valid |= ATTR_ATIME;
7108         Y_TIME_CONVERT(attr->ia_ctime) = obj->yst_ctime;
7109         valid |= ATTR_CTIME;
7110         Y_TIME_CONVERT(attr->ia_mtime) = obj->yst_mtime;
7111         valid |= ATTR_MTIME;
7112
7113         attr->ia_size = yaffs_GetFileSize(obj);
7114         valid |= ATTR_SIZE;
7115
7116         attr->ia_valid = valid;
7117
7118         return YAFFS_OK;
7119
7120 }
7121
7122 #endif
7123
7124 #if 0
7125 int yaffs_DumpObject(yaffs_Object * obj)
7126 {
7127         YCHAR name[257];
7128
7129         yaffs_GetObjectName(obj, name, 256);
7130
7131         T(YAFFS_TRACE_ALWAYS,
7132           (TSTR
7133            ("Object %d, inode %d \"%s\"\n dirty %d valid %d serial %d sum %d"
7134             " chunk %d type %d size %d\n"
7135             TENDSTR), obj->objectId, yaffs_GetObjectInode(obj), name,
7136            obj->dirty, obj->valid, obj->serial, obj->sum, obj->hdrChunk,
7137            yaffs_GetObjectType(obj), yaffs_GetObjectFileLength(obj)));
7138
7139         return YAFFS_OK;
7140 }
7141 #endif
7142
7143 /*---------------------------- Initialisation code -------------------------------------- */
7144
7145 static int yaffs_CheckDevFunctions(const yaffs_Device * dev)
7146 {
7147
7148         /* Common functions, gotta have */
7149         if (!dev->eraseBlockInNAND || !dev->initialiseNAND)
7150                 return 0;
7151
7152 #ifdef CONFIG_YAFFS_YAFFS2
7153
7154         /* Can use the "with tags" style interface for yaffs1 or yaffs2 */
7155         if (dev->writeChunkWithTagsToNAND &&
7156             dev->readChunkWithTagsFromNAND &&
7157             !dev->writeChunkToNAND &&
7158             !dev->readChunkFromNAND &&
7159             dev->markNANDBlockBad && dev->queryNANDBlock)
7160                 return 1;
7161 #endif
7162
7163         /* Can use the "spare" style interface for yaffs1 */
7164         if (!dev->isYaffs2 &&
7165             !dev->writeChunkWithTagsToNAND &&
7166             !dev->readChunkWithTagsFromNAND &&
7167             dev->writeChunkToNAND &&
7168             dev->readChunkFromNAND &&
7169             !dev->markNANDBlockBad && !dev->queryNANDBlock)
7170                 return 1;
7171
7172         return 0;               /* bad */
7173 }
7174
7175
7176 static int yaffs_CreateInitialDirectories(yaffs_Device *dev)
7177 {
7178         /* Initialise the unlinked, deleted, root and lost and found directories */
7179
7180         dev->lostNFoundDir = dev->rootDir =  NULL;
7181         dev->unlinkedDir = dev->deletedDir = NULL;
7182
7183         dev->unlinkedDir =
7184             yaffs_CreateFakeDirectory(dev, YAFFS_OBJECTID_UNLINKED, S_IFDIR);
7185
7186         dev->deletedDir =
7187             yaffs_CreateFakeDirectory(dev, YAFFS_OBJECTID_DELETED, S_IFDIR);
7188
7189         dev->rootDir =
7190             yaffs_CreateFakeDirectory(dev, YAFFS_OBJECTID_ROOT,
7191                                       YAFFS_ROOT_MODE | S_IFDIR);
7192         dev->lostNFoundDir =
7193             yaffs_CreateFakeDirectory(dev, YAFFS_OBJECTID_LOSTNFOUND,
7194                                       YAFFS_LOSTNFOUND_MODE | S_IFDIR);
7195
7196         if(dev->lostNFoundDir && dev->rootDir && dev->unlinkedDir && dev->deletedDir){
7197                 yaffs_AddObjectToDirectory(dev->rootDir, dev->lostNFoundDir);
7198                 return YAFFS_OK;
7199         }
7200
7201         return YAFFS_FAIL;
7202 }
7203
7204 int yaffs_GutsInitialise(yaffs_Device * dev)
7205 {
7206         int init_failed = 0;
7207         unsigned x;
7208         int bits;
7209
7210         T(YAFFS_TRACE_TRACING, (TSTR("yaffs: yaffs_GutsInitialise()" TENDSTR)));
7211
7212         /* Check stuff that must be set */
7213
7214         if (!dev) {
7215                 T(YAFFS_TRACE_ALWAYS, (TSTR("yaffs: Need a device" TENDSTR)));
7216                 return YAFFS_FAIL;
7217         }
7218
7219         dev->internalStartBlock = dev->startBlock;
7220         dev->internalEndBlock = dev->endBlock;
7221         dev->blockOffset = 0;
7222         dev->chunkOffset = 0;
7223         dev->nFreeChunks = 0;
7224
7225         if (dev->startBlock == 0) {
7226                 dev->internalStartBlock = dev->startBlock + 1;
7227                 dev->internalEndBlock = dev->endBlock + 1;
7228                 dev->blockOffset = 1;
7229                 dev->chunkOffset = dev->nChunksPerBlock;
7230         }
7231
7232         /* Check geometry parameters. */
7233
7234         if ((!dev->inbandTags && dev->isYaffs2 && dev->totalBytesPerChunk < 1024) ||
7235             (!dev->isYaffs2 && dev->totalBytesPerChunk < 512) ||
7236             (dev->inbandTags && !dev->isYaffs2 ) ||
7237              dev->nChunksPerBlock < 2 ||
7238              dev->nReservedBlocks < 2 ||
7239              dev->internalStartBlock <= 0 ||
7240              dev->internalEndBlock <= 0 ||
7241              dev->internalEndBlock <= (dev->internalStartBlock + dev->nReservedBlocks + 2)      // otherwise it is too small
7242             ) {
7243                 T(YAFFS_TRACE_ALWAYS,
7244                   (TSTR
7245                    ("yaffs: NAND geometry problems: chunk size %d, type is yaffs%s, inbandTags %d "
7246                     TENDSTR), dev->totalBytesPerChunk, dev->isYaffs2 ? "2" : "", dev->inbandTags));
7247                 return YAFFS_FAIL;
7248         }
7249
7250         if (yaffs_InitialiseNAND(dev) != YAFFS_OK) {
7251                 T(YAFFS_TRACE_ALWAYS,
7252                   (TSTR("yaffs: InitialiseNAND failed" TENDSTR)));
7253                 return YAFFS_FAIL;
7254         }
7255
7256         /* Sort out space for inband tags, if required */
7257         if(dev->inbandTags)
7258                 dev->nDataBytesPerChunk = dev->totalBytesPerChunk - sizeof(yaffs_PackedTags2TagsPart);
7259         else
7260                 dev->nDataBytesPerChunk = dev->totalBytesPerChunk;
7261
7262         /* Got the right mix of functions? */
7263         if (!yaffs_CheckDevFunctions(dev)) {
7264                 /* Function missing */
7265                 T(YAFFS_TRACE_ALWAYS,
7266                   (TSTR
7267                    ("yaffs: device function(s) missing or wrong\n" TENDSTR)));
7268
7269                 return YAFFS_FAIL;
7270         }
7271
7272         /* This is really a compilation check. */
7273         if (!yaffs_CheckStructures()) {
7274                 T(YAFFS_TRACE_ALWAYS,
7275                   (TSTR("yaffs_CheckStructures failed\n" TENDSTR)));
7276                 return YAFFS_FAIL;
7277         }
7278
7279         if (dev->isMounted) {
7280                 T(YAFFS_TRACE_ALWAYS,
7281                   (TSTR("yaffs: device already mounted\n" TENDSTR)));
7282                 return YAFFS_FAIL;
7283         }
7284
7285         /* Finished with most checks. One or two more checks happen later on too. */
7286
7287         dev->isMounted = 1;
7288
7289         /* OK now calculate a few things for the device */
7290
7291         /*
7292          *  Calculate all the chunk size manipulation numbers:
7293          */
7294         x = dev->nDataBytesPerChunk;
7295         /* We always use dev->chunkShift and dev->chunkDiv */
7296         dev->chunkShift = Shifts(x);
7297         x >>= dev->chunkShift;
7298         dev->chunkDiv = x;
7299         /* We only use chunk mask if chunkDiv is 1 */
7300         dev->chunkMask = (1<<dev->chunkShift) - 1;
7301
7302         /*
7303          * Calculate chunkGroupBits.
7304          * We need to find the next power of 2 > than internalEndBlock
7305          */
7306
7307         x = dev->nChunksPerBlock * (dev->internalEndBlock + 1);
7308
7309         bits = ShiftsGE(x);
7310
7311         /* Set up tnode width if wide tnodes are enabled. */
7312         if(!dev->wideTnodesDisabled){
7313                 /* bits must be even so that we end up with 32-bit words */
7314                 if(bits & 1)
7315                         bits++;
7316                 if(bits < 16)
7317                         dev->tnodeWidth = 16;
7318                 else
7319                         dev->tnodeWidth = bits;
7320         }
7321         else
7322                 dev->tnodeWidth = 16;
7323
7324         dev->tnodeMask = (1<<dev->tnodeWidth)-1;
7325
7326         /* Level0 Tnodes are 16 bits or wider (if wide tnodes are enabled),
7327          * so if the bitwidth of the
7328          * chunk range we're using is greater than 16 we need
7329          * to figure out chunk shift and chunkGroupSize
7330          */
7331
7332         if (bits <= dev->tnodeWidth)
7333                 dev->chunkGroupBits = 0;
7334         else
7335                 dev->chunkGroupBits = bits - dev->tnodeWidth;
7336
7337
7338         dev->chunkGroupSize = 1 << dev->chunkGroupBits;
7339
7340         if (dev->nChunksPerBlock < dev->chunkGroupSize) {
7341                 /* We have a problem because the soft delete won't work if
7342                  * the chunk group size > chunks per block.
7343                  * This can be remedied by using larger "virtual blocks".
7344                  */
7345                 T(YAFFS_TRACE_ALWAYS,
7346                   (TSTR("yaffs: chunk group too large\n" TENDSTR)));
7347
7348                 return YAFFS_FAIL;
7349         }
7350
7351         /* OK, we've finished verifying the device, lets continue with initialisation */
7352
7353         /* More device initialisation */
7354         dev->garbageCollections = 0;
7355         dev->passiveGarbageCollections = 0;
7356         dev->currentDirtyChecker = 0;
7357         dev->bufferedBlock = -1;
7358         dev->doingBufferedBlockRewrite = 0;
7359         dev->nDeletedFiles = 0;
7360         dev->nBackgroundDeletions = 0;
7361         dev->nUnlinkedFiles = 0;
7362         dev->eccFixed = 0;
7363         dev->eccUnfixed = 0;
7364         dev->tagsEccFixed = 0;
7365         dev->tagsEccUnfixed = 0;
7366         dev->nErasureFailures = 0;
7367         dev->nErasedBlocks = 0;
7368         dev->isDoingGC = 0;
7369         dev->hasPendingPrioritisedGCs = 1; /* Assume the worst for now, will get fixed on first GC */
7370
7371         /* Initialise temporary buffers and caches. */
7372         if(!yaffs_InitialiseTempBuffers(dev))
7373                 init_failed = 1;
7374
7375         dev->srCache = NULL;
7376         dev->gcCleanupList = NULL;
7377
7378
7379         if (!init_failed &&
7380             dev->nShortOpCaches > 0) {
7381                 int i;
7382                 void *buf;
7383                 int srCacheBytes = dev->nShortOpCaches * sizeof(yaffs_ChunkCache);
7384
7385                 if (dev->nShortOpCaches > YAFFS_MAX_SHORT_OP_CACHES) {
7386                         dev->nShortOpCaches = YAFFS_MAX_SHORT_OP_CACHES;
7387                 }
7388
7389                 dev->srCache =  YMALLOC(srCacheBytes);
7390
7391                 buf = (__u8 *) dev->srCache;
7392
7393                 if(dev->srCache)
7394                         memset(dev->srCache,0,srCacheBytes);
7395
7396                 for (i = 0; i < dev->nShortOpCaches && buf; i++) {
7397                         dev->srCache[i].object = NULL;
7398                         dev->srCache[i].lastUse = 0;
7399                         dev->srCache[i].dirty = 0;
7400                         dev->srCache[i].data = buf = YMALLOC_DMA(dev->totalBytesPerChunk);
7401                 }
7402                 if(!buf)
7403                         init_failed = 1;
7404
7405                 dev->srLastUse = 0;
7406         }
7407
7408         dev->cacheHits = 0;
7409
7410         if(!init_failed){
7411                 dev->gcCleanupList = YMALLOC(dev->nChunksPerBlock * sizeof(__u32));
7412                 if(!dev->gcCleanupList)
7413                         init_failed = 1;
7414         }
7415
7416         if (dev->isYaffs2) {
7417                 dev->useHeaderFileSize = 1;
7418         }
7419         if(!init_failed && !yaffs_InitialiseBlocks(dev))
7420                 init_failed = 1;
7421
7422         yaffs_InitialiseTnodes(dev);
7423         yaffs_InitialiseObjects(dev);
7424
7425         if(!init_failed && !yaffs_CreateInitialDirectories(dev))
7426                 init_failed = 1;
7427
7428
7429         if(!init_failed){
7430                 /* Now scan the flash. */
7431                 if (dev->isYaffs2) {
7432                         if(yaffs_CheckpointRestore(dev)) {
7433                                 yaffs_CheckObjectDetailsLoaded(dev->rootDir);
7434                                 T(YAFFS_TRACE_ALWAYS,
7435                                   (TSTR("yaffs: restored from checkpoint" TENDSTR)));
7436                         } else {
7437
7438                                 /* Clean up the mess caused by an aborted checkpoint load
7439                                  * and scan backwards.
7440                                  */
7441                                 yaffs_DeinitialiseBlocks(dev);
7442                                 yaffs_DeinitialiseTnodes(dev);
7443                                 yaffs_DeinitialiseObjects(dev);
7444
7445
7446                                 dev->nErasedBlocks = 0;
7447                                 dev->nFreeChunks = 0;
7448                                 dev->allocationBlock = -1;
7449                                 dev->allocationPage = -1;
7450                                 dev->nDeletedFiles = 0;
7451                                 dev->nUnlinkedFiles = 0;
7452                                 dev->nBackgroundDeletions = 0;
7453                                 dev->oldestDirtySequence = 0;
7454
7455                                 if(!init_failed && !yaffs_InitialiseBlocks(dev))
7456                                         init_failed = 1;
7457
7458                                 yaffs_InitialiseTnodes(dev);
7459                                 yaffs_InitialiseObjects(dev);
7460
7461                                 if(!init_failed && !yaffs_CreateInitialDirectories(dev))
7462                                         init_failed = 1;
7463
7464                                 if(!init_failed && !yaffs_ScanBackwards(dev))
7465                                         init_failed = 1;
7466                         }
7467                 }else
7468                         if(!yaffs_Scan(dev))
7469                                 init_failed = 1;
7470         }
7471
7472         if(init_failed){
7473                 /* Clean up the mess */
7474                 T(YAFFS_TRACE_TRACING,
7475                   (TSTR("yaffs: yaffs_GutsInitialise() aborted.\n" TENDSTR)));
7476
7477                 yaffs_Deinitialise(dev);
7478                 return YAFFS_FAIL;
7479         }
7480
7481         /* Zero out stats */
7482         dev->nPageReads = 0;
7483         dev->nPageWrites = 0;
7484         dev->nBlockErasures = 0;
7485         dev->nGCCopies = 0;
7486         dev->nRetriedWrites = 0;
7487
7488         dev->nRetiredBlocks = 0;
7489
7490         yaffs_VerifyFreeChunks(dev);
7491         yaffs_VerifyBlocks(dev);
7492
7493
7494         T(YAFFS_TRACE_TRACING,
7495           (TSTR("yaffs: yaffs_GutsInitialise() done.\n" TENDSTR)));
7496         return YAFFS_OK;
7497
7498 }
7499
7500 void yaffs_Deinitialise(yaffs_Device * dev)
7501 {
7502         if (dev->isMounted) {
7503                 int i;
7504
7505                 yaffs_DeinitialiseBlocks(dev);
7506                 yaffs_DeinitialiseTnodes(dev);
7507                 yaffs_DeinitialiseObjects(dev);
7508                 if (dev->nShortOpCaches > 0 &&
7509                     dev->srCache) {
7510
7511                         for (i = 0; i < dev->nShortOpCaches; i++) {
7512                                 if(dev->srCache[i].data)
7513                                         YFREE(dev->srCache[i].data);
7514                                 dev->srCache[i].data = NULL;
7515                         }
7516
7517                         YFREE(dev->srCache);
7518                         dev->srCache = NULL;
7519                 }
7520
7521                 YFREE(dev->gcCleanupList);
7522
7523                 for (i = 0; i < YAFFS_N_TEMP_BUFFERS; i++) {
7524                         YFREE(dev->tempBuffer[i].buffer);
7525                 }
7526
7527
7528                 dev->isMounted = 0;
7529
7530                 if(dev->deinitialiseNAND)
7531                         dev->deinitialiseNAND(dev);
7532         }
7533
7534 }
7535
7536 static int yaffs_CountFreeChunks(yaffs_Device * dev)
7537 {
7538         int nFree;
7539         int b;
7540
7541         yaffs_BlockInfo *blk;
7542
7543         for (nFree = 0, b = dev->internalStartBlock; b <= dev->internalEndBlock;
7544              b++) {
7545                 blk = yaffs_GetBlockInfo(dev, b);
7546
7547                 switch (blk->blockState) {
7548                 case YAFFS_BLOCK_STATE_EMPTY:
7549                 case YAFFS_BLOCK_STATE_ALLOCATING:
7550                 case YAFFS_BLOCK_STATE_COLLECTING:
7551                 case YAFFS_BLOCK_STATE_FULL:
7552                         nFree +=
7553                             (dev->nChunksPerBlock - blk->pagesInUse +
7554                              blk->softDeletions);
7555                         break;
7556                 default:
7557                         break;
7558                 }
7559
7560         }
7561
7562         return nFree;
7563 }
7564
7565 int yaffs_GetNumberOfFreeChunks(yaffs_Device * dev)
7566 {
7567         /* This is what we report to the outside world */
7568
7569         int nFree;
7570         int nDirtyCacheChunks;
7571         int blocksForCheckpoint;
7572
7573 #if 1
7574         nFree = dev->nFreeChunks;
7575 #else
7576         nFree = yaffs_CountFreeChunks(dev);
7577 #endif
7578
7579         nFree += dev->nDeletedFiles;
7580
7581         /* Now count the number of dirty chunks in the cache and subtract those */
7582
7583         {
7584                 int i;
7585                 for (nDirtyCacheChunks = 0, i = 0; i < dev->nShortOpCaches; i++) {
7586                         if (dev->srCache[i].dirty)
7587                                 nDirtyCacheChunks++;
7588                 }
7589         }
7590
7591         nFree -= nDirtyCacheChunks;
7592
7593         nFree -= ((dev->nReservedBlocks + 1) * dev->nChunksPerBlock);
7594
7595         /* Now we figure out how much to reserve for the checkpoint and report that... */
7596         blocksForCheckpoint = yaffs_CalcCheckpointBlocksRequired(dev) - dev->blocksInCheckpoint;
7597         if(blocksForCheckpoint < 0)
7598                 blocksForCheckpoint = 0;
7599
7600         nFree -= (blocksForCheckpoint * dev->nChunksPerBlock);
7601
7602         if (nFree < 0)
7603                 nFree = 0;
7604
7605         return nFree;
7606
7607 }
7608
7609 static int yaffs_freeVerificationFailures;
7610
7611 static void yaffs_VerifyFreeChunks(yaffs_Device * dev)
7612 {
7613         int counted;
7614         int difference;
7615
7616         if(yaffs_SkipVerification(dev))
7617                 return;
7618
7619         counted = yaffs_CountFreeChunks(dev);
7620
7621         difference = dev->nFreeChunks - counted;
7622
7623         if (difference) {
7624                 T(YAFFS_TRACE_ALWAYS,
7625                   (TSTR("Freechunks verification failure %d %d %d" TENDSTR),
7626                    dev->nFreeChunks, counted, difference));
7627                 yaffs_freeVerificationFailures++;
7628         }
7629 }
7630
7631 /*---------------------------------------- YAFFS test code ----------------------*/
7632
7633 #define yaffs_CheckStruct(structure,syze, name) \
7634         do { \
7635            if(sizeof(structure) != syze) \
7636                { \
7637                  T(YAFFS_TRACE_ALWAYS,(TSTR("%s should be %d but is %d\n" TENDSTR),\
7638                  name,syze,sizeof(structure))); \
7639                  return YAFFS_FAIL; \
7640                 } \
7641         } while(0)
7642
7643 static int yaffs_CheckStructures(void)
7644 {
7645 /*      yaffs_CheckStruct(yaffs_Tags,8,"yaffs_Tags"); */
7646 /*      yaffs_CheckStruct(yaffs_TagsUnion,8,"yaffs_TagsUnion"); */
7647 /*      yaffs_CheckStruct(yaffs_Spare,16,"yaffs_Spare"); */
7648 #ifndef CONFIG_YAFFS_TNODE_LIST_DEBUG
7649         yaffs_CheckStruct(yaffs_Tnode, 2 * YAFFS_NTNODES_LEVEL0, "yaffs_Tnode");
7650 #endif
7651 #ifndef CONFIG_YAFFS_WINCE
7652                 yaffs_CheckStruct(yaffs_ObjectHeader, 512, "yaffs_ObjectHeader");
7653 #endif
7654             return YAFFS_OK;
7655 }