yaffs_guts.c

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