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