yaffs_guts.c

   1 /*
   2  * YAFFS: Yet Another Flash File System. A NAND-flash specific file system.
   3  *
   4  * Copyright (C) 2002-2010 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 #include "yportenv.h"
  14 #include "yaffs_trace.h"
  15
  16 #include "yaffsinterface.h"
  17 #include "yaffs_guts.h"
  18 #include "yaffs_tagsvalidity.h"
  19 #include "yaffs_getblockinfo.h"
  20
  21 #include "yaffs_tagscompat.h"
  22
  23 #include "yaffs_nand.h"
  24
  25 #include "yaffs_yaffs1.h"
  26 #include "yaffs_yaffs2.h"
  27 #include "yaffs_bitmap.h"
  28 #include "yaffs_verify.h"
  29
  30 #include "yaffs_nand.h"
  31 #include "yaffs_packedtags2.h"
  32
  33 #include "yaffs_nameval.h"
  34 #include "yaffs_allocator.h"
  35
  36 /* Note YAFFS_GC_GOOD_ENOUGH must be <= YAFFS_GC_PASSIVE_THRESHOLD */
  37 #define YAFFS_GC_GOOD_ENOUGH 2
  38 #define YAFFS_GC_PASSIVE_THRESHOLD 4
  39
  40 #include "yaffs_ecc.h"
  41
  42
  43
  44 /* Robustification (if it ever comes about...) */
  45 static void yaffs_RetireBlock(yaffs_Device *dev, int blockInNAND);
  46 static void yaffs_HandleWriteChunkError(yaffs_Device *dev, int chunkInNAND,
  47                 int erasedOk);
  48 static void yaffs_HandleWriteChunkOk(yaffs_Device *dev, int chunkInNAND,
  49                                 const __u8 *data,
  50                                 const yaffs_ExtendedTags *tags);
  51 static void yaffs_HandleUpdateChunk(yaffs_Device *dev, int chunkInNAND,
  52                                 const yaffs_ExtendedTags *tags);
  53
  54 /* Other local prototypes */
  55 static void yaffs_UpdateParent(yaffs_Object *obj);
  56 static int yaffs_UnlinkObject(yaffs_Object *obj);
  57 static int yaffs_ObjectHasCachedWriteData(yaffs_Object *obj);
  58
  59 static int yaffs_WriteNewChunkWithTagsToNAND(yaffs_Device *dev,
  60                                         const __u8 *buffer,
  61                                         yaffs_ExtendedTags *tags,
  62                                         int useReserve);
  63
  64
  65 static yaffs_Object *yaffs_CreateNewObject(yaffs_Device *dev, int number,
  66                                         yaffs_ObjectType type);
  67
  68
  69 static int yaffs_ApplyXMod(yaffs_Device *dev, char *buffer, yaffs_XAttrMod *xmod);
  70
  71 static void yaffs_RemoveObjectFromDirectory(yaffs_Object *obj);
  72 static int yaffs_CheckStructures(void);
  73 static int yaffs_DoGenericObjectDeletion(yaffs_Object *in);
  74
  75 static yaffs_BlockInfo *yaffs_GetBlockInfo(yaffs_Device *dev, int blockNo);
  76
  77
  78 static int yaffs_CheckChunkErased(struct yaffs_DeviceStruct *dev,
  79                                 int chunkInNAND);
  80
  81 static int yaffs_UnlinkWorker(yaffs_Object *obj);
  82
  83 static int yaffs_TagsMatch(const yaffs_ExtendedTags *tags, int objectId,
  84                         int chunkInObject);
  85
  86 static int yaffs_AllocateChunk(yaffs_Device *dev, int useReserve,
  87                                 yaffs_BlockInfo **blockUsedPtr);
  88
  89 static void yaffs_CheckObjectDetailsLoaded(yaffs_Object *in);
  90
  91 static void yaffs_InvalidateWholeChunkCache(yaffs_Object *in);
  92 static void yaffs_InvalidateChunkCache(yaffs_Object *object, int chunkId);
  93
  94 static int yaffs_FindChunkInFile(yaffs_Object *in, int chunkInInode,
  95                                 yaffs_ExtendedTags *tags);
  96
  97 static int yaffs_VerifyChunkWritten(yaffs_Device *dev,
  98                                         int chunkInNAND,
  99                                         const __u8 *data,
 100                                         yaffs_ExtendedTags *tags);
 101
 102
 103 static void yaffs_LoadNameFromObjectHeader(yaffs_Device *dev,YCHAR *name, const YCHAR *ohName, int bufferSize);
 104 static void yaffs_LoadObjectHeaderFromName(yaffs_Device *dev,YCHAR *ohName, const YCHAR *name);
 105
 106
 107 /* Function to calculate chunk and offset */
 108
 109 static void yaffs_AddrToChunk(yaffs_Device *dev, loff_t addr, int *chunkOut,
 110                 __u32 *offsetOut)
 111 {
 112         int chunk;
 113         __u32 offset;
 114
 115         chunk  = (__u32)(addr >> dev->chunkShift);
 116
 117         if (dev->chunkDiv == 1) {
 118                 /* easy power of 2 case */
 119                 offset = (__u32)(addr & dev->chunkMask);
 120         } else {
 121                 /* Non power-of-2 case */
 122
 123                 loff_t chunkBase;
 124
 125                 chunk /= dev->chunkDiv;
 126
 127                 chunkBase = ((loff_t)chunk) * dev->nDataBytesPerChunk;
 128                 offset = (__u32)(addr - chunkBase);
 129         }
 130
 131         *chunkOut = chunk;
 132         *offsetOut = offset;
 133 }
 134
 135 /* Function to return the number of shifts for a power of 2 greater than or
 136  * equal to the given number
 137  * Note we don't try to cater for all possible numbers and this does not have to
 138  * be hellishly efficient.
 139  */
 140
 141 static __u32 ShiftsGE(__u32 x)
 142 {
 143         int extraBits;
 144         int nShifts;
 145
 146         nShifts = extraBits = 0;
 147
 148         while (x > 1) {
 149                 if (x & 1)
 150                         extraBits++;
 151                 x >>= 1;
 152                 nShifts++;
 153         }
 154
 155         if (extraBits)
 156                 nShifts++;
 157
 158         return nShifts;
 159 }
 160
 161 /* Function to return the number of shifts to get a 1 in bit 0
 162  */
 163
 164 static __u32 Shifts(__u32 x)
 165 {
 166         __u32 nShifts;
 167
 168         nShifts =  0;
 169
 170         if (!x)
 171                 return 0;
 172
 173         while (!(x&1)) {
 174                 x >>= 1;
 175                 nShifts++;
 176         }
 177
 178         return nShifts;
 179 }
 180
 181
 182
 183 /*
 184  * Temporary buffer manipulations.
 185  */
 186
 187 static int yaffs_InitialiseTempBuffers(yaffs_Device *dev)
 188 {
 189         int i;
 190         __u8 *buf = (__u8 *)1;
 191
 192         memset(dev->tempBuffer, 0, sizeof(dev->tempBuffer));
 193
 194         for (i = 0; buf && i < YAFFS_N_TEMP_BUFFERS; i++) {
 195                 dev->tempBuffer[i].line = 0;    /* not in use */
 196                 dev->tempBuffer[i].buffer = buf =
 197                     YMALLOC_DMA(dev->param.totalBytesPerChunk);
 198         }
 199
 200         return buf ? YAFFS_OK : YAFFS_FAIL;
 201 }
 202
 203 __u8 *yaffs_GetTempBuffer(yaffs_Device *dev, int lineNo)
 204 {
 205         int i, j;
 206
 207         dev->tempInUse++;
 208         if (dev->tempInUse > dev->maxTemp)
 209                 dev->maxTemp = dev->tempInUse;
 210
 211         for (i = 0; i < YAFFS_N_TEMP_BUFFERS; i++) {
 212                 if (dev->tempBuffer[i].line == 0) {
 213                         dev->tempBuffer[i].line = lineNo;
 214                         if ((i + 1) > dev->maxTemp) {
 215                                 dev->maxTemp = i + 1;
 216                                 for (j = 0; j <= i; j++)
 217                                         dev->tempBuffer[j].maxLine =
 218                                             dev->tempBuffer[j].line;
 219                         }
 220
 221                         return dev->tempBuffer[i].buffer;
 222                 }
 223         }
 224
 225         T(YAFFS_TRACE_BUFFERS,
 226           (TSTR("Out of temp buffers at line %d, other held by lines:"),
 227            lineNo));
 228         for (i = 0; i < YAFFS_N_TEMP_BUFFERS; i++)
 229                 T(YAFFS_TRACE_BUFFERS, (TSTR(" %d "), dev->tempBuffer[i].line));
 230
 231         T(YAFFS_TRACE_BUFFERS, (TSTR(" " TENDSTR)));
 232
 233         /*
 234          * If we got here then we have to allocate an unmanaged one
 235          * This is not good.
 236          */
 237
 238         dev->unmanagedTempAllocations++;
 239         return YMALLOC(dev->nDataBytesPerChunk);
 240
 241 }
 242
 243 void yaffs_ReleaseTempBuffer(yaffs_Device *dev, __u8 *buffer,
 244                                     int lineNo)
 245 {
 246         int i;
 247
 248         dev->tempInUse--;
 249
 250         for (i = 0; i < YAFFS_N_TEMP_BUFFERS; i++) {
 251                 if (dev->tempBuffer[i].buffer == buffer) {
 252                         dev->tempBuffer[i].line = 0;
 253                         return;
 254                 }
 255         }
 256
 257         if (buffer) {
 258                 /* assume it is an unmanaged one. */
 259                 T(YAFFS_TRACE_BUFFERS,
 260                   (TSTR("Releasing unmanaged temp buffer in line %d" TENDSTR),
 261                    lineNo));
 262                 YFREE(buffer);
 263                 dev->unmanagedTempDeallocations++;
 264         }
 265
 266 }
 267
 268 /*
 269  * Determine if we have a managed buffer.
 270  */
 271 int yaffs_IsManagedTempBuffer(yaffs_Device *dev, const __u8 *buffer)
 272 {
 273         int i;
 274
 275         for (i = 0; i < YAFFS_N_TEMP_BUFFERS; i++) {
 276                 if (dev->tempBuffer[i].buffer == buffer)
 277                         return 1;
 278         }
 279
 280         for (i = 0; i < dev->param.nShortOpCaches; i++) {
 281                 if (dev->srCache[i].data == buffer)
 282                         return 1;
 283         }
 284
 285         if (buffer == dev->checkpointBuffer)
 286                 return 1;
 287
 288         T(YAFFS_TRACE_ALWAYS,
 289                 (TSTR("yaffs: unmaged buffer detected.\n" TENDSTR)));
 290         return 0;
 291 }
 292
 293 /*
 294  * Verification code
 295  */
 296
 297
 298
 299
 300 /*
 301  *  Simple hash function. Needs to have a reasonable spread
 302  */
 303
 304 static Y_INLINE int yaffs_HashFunction(int n)
 305 {
 306         n = abs(n);
 307         return n % YAFFS_NOBJECT_BUCKETS;
 308 }
 309
 310 /*
 311  * Access functions to useful fake objects.
 312  * Note that root might have a presence in NAND if permissions are set.
 313  */
 314
 315 yaffs_Object *yaffs_Root(yaffs_Device *dev)
 316 {
 317         return dev->rootDir;
 318 }
 319
 320 yaffs_Object *yaffs_LostNFound(yaffs_Device *dev)
 321 {
 322         return dev->lostNFoundDir;
 323 }
 324
 325
 326 /*
 327  *  Erased NAND checking functions
 328  */
 329
 330 int yaffs_CheckFF(__u8 *buffer, int nBytes)
 331 {
 332         /* Horrible, slow implementation */
 333         while (nBytes--) {
 334                 if (*buffer != 0xFF)
 335                         return 0;
 336                 buffer++;
 337         }
 338         return 1;
 339 }
 340
 341 static int yaffs_CheckChunkErased(struct yaffs_DeviceStruct *dev,
 342                                 int chunkInNAND)
 343 {
 344         int retval = YAFFS_OK;
 345         __u8 *data = yaffs_GetTempBuffer(dev, __LINE__);
 346         yaffs_ExtendedTags tags;
 347         int result;
 348
 349         result = yaffs_ReadChunkWithTagsFromNAND(dev, chunkInNAND, data, &tags);
 350
 351         if (tags.eccResult > YAFFS_ECC_RESULT_NO_ERROR)
 352                 retval = YAFFS_FAIL;
 353
 354         if (!yaffs_CheckFF(data, dev->nDataBytesPerChunk) || tags.chunkUsed) {
 355                 T(YAFFS_TRACE_NANDACCESS,
 356                   (TSTR("Chunk %d not erased" TENDSTR), chunkInNAND));
 357                 retval = YAFFS_FAIL;
 358         }
 359
 360         yaffs_ReleaseTempBuffer(dev, data, __LINE__);
 361
 362         return retval;
 363
 364 }
 365
 366
 367 static int yaffs_VerifyChunkWritten(yaffs_Device *dev,
 368                                         int chunkInNAND,
 369                                         const __u8 *data,
 370                                         yaffs_ExtendedTags *tags)
 371 {
 372         int retval = YAFFS_OK;
 373         yaffs_ExtendedTags tempTags;
 374         __u8 *buffer = yaffs_GetTempBuffer(dev,__LINE__);
 375         int result;
 376
 377         result = yaffs_ReadChunkWithTagsFromNAND(dev,chunkInNAND,buffer,&tempTags);
 378         if(memcmp(buffer,data,dev->nDataBytesPerChunk) ||
 379                 tempTags.objectId != tags->objectId ||
 380                 tempTags.chunkId  != tags->chunkId ||
 381                 tempTags.byteCount != tags->byteCount)
 382                 retval = YAFFS_FAIL;
 383
 384         yaffs_ReleaseTempBuffer(dev, buffer, __LINE__);
 385
 386         return retval;
 387 }
 388
 389 static int yaffs_WriteNewChunkWithTagsToNAND(struct yaffs_DeviceStruct *dev,
 390                                         const __u8 *data,
 391                                         yaffs_ExtendedTags *tags,
 392                                         int useReserve)
 393 {
 394         int attempts = 0;
 395         int writeOk = 0;
 396         int chunk;
 397
 398         yaffs2_InvalidateCheckpoint(dev);
 399
 400         do {
 401                 yaffs_BlockInfo *bi = 0;
 402                 int erasedOk = 0;
 403
 404                 chunk = yaffs_AllocateChunk(dev, useReserve, &bi);
 405                 if (chunk < 0) {
 406                         /* no space */
 407                         break;
 408                 }
 409
 410                 /* First check this chunk is erased, if it needs
 411                  * checking.  The checking policy (unless forced
 412                  * always on) is as follows:
 413                  *
 414                  * Check the first page we try to write in a block.
 415                  * If the check passes then we don't need to check any
 416                  * more.        If the check fails, we check again...
 417                  * If the block has been erased, we don't need to check.
 418                  *
 419                  * However, if the block has been prioritised for gc,
 420                  * then we think there might be something odd about
 421                  * this block and stop using it.
 422                  *
 423                  * Rationale: We should only ever see chunks that have
 424                  * not been erased if there was a partially written
 425                  * chunk due to power loss.  This checking policy should
 426                  * catch that case with very few checks and thus save a
 427                  * lot of checks that are most likely not needed.
 428                  *
 429                  * Mods to the above
 430                  * If an erase check fails or the write fails we skip the
 431                  * rest of the block.
 432                  */
 433
 434                 /* let's give it a try */
 435                 attempts++;
 436
 437 #ifdef CONFIG_YAFFS_ALWAYS_CHECK_CHUNK_ERASED
 438                 bi->skipErasedCheck = 0;
 439 #endif
 440                 if (!bi->skipErasedCheck) {
 441                         erasedOk = yaffs_CheckChunkErased(dev, chunk);
 442                         if (erasedOk != YAFFS_OK) {
 443                                 T(YAFFS_TRACE_ERROR,
 444                                 (TSTR("**>> yaffs chunk %d was not erased"
 445                                 TENDSTR), chunk));
 446
 447                                 /* If not erased, delete this one,
 448                                  * skip rest of block and
 449                                  * try another chunk */
 450                                  yaffs_DeleteChunk(dev,chunk,1,__LINE__);
 451                                  yaffs_SkipRestOfBlock(dev);
 452                                 continue;
 453                         }
 454                 }
 455
 456                 writeOk = yaffs_WriteChunkWithTagsToNAND(dev, chunk,
 457                                 data, tags);
 458
 459                 if(!bi->skipErasedCheck)
 460                         writeOk = yaffs_VerifyChunkWritten(dev, chunk, data, tags);
 461
 462                 if (writeOk != YAFFS_OK) {
 463                         /* Clean up aborted write, skip to next block and
 464                          * try another chunk */
 465                         yaffs_HandleWriteChunkError(dev, chunk, erasedOk);
 466                         continue;
 467                 }
 468
 469                 bi->skipErasedCheck = 1;
 470
 471                 /* Copy the data into the robustification buffer */
 472                 yaffs_HandleWriteChunkOk(dev, chunk, data, tags);
 473
 474         } while (writeOk != YAFFS_OK &&
 475                 (yaffs_wr_attempts <= 0 || attempts <= yaffs_wr_attempts));
 476
 477         if (!writeOk)
 478                 chunk = -1;
 479
 480         if (attempts > 1) {
 481                 T(YAFFS_TRACE_ERROR,
 482                         (TSTR("**>> yaffs write required %d attempts" TENDSTR),
 483                         attempts));
 484
 485                 dev->nRetriedWrites += (attempts - 1);
 486         }
 487
 488         return chunk;
 489 }
 490
 491
 492
 493 /*
 494  * Block retiring for handling a broken block.
 495  */
 496
 497 static void yaffs_RetireBlock(yaffs_Device *dev, int blockInNAND)
 498 {
 499         yaffs_BlockInfo *bi = yaffs_GetBlockInfo(dev, blockInNAND);
 500
 501         yaffs2_InvalidateCheckpoint(dev);
 502
 503         yaffs2_ClearOldestDirtySequence(dev,bi);
 504
 505         if (yaffs_MarkBlockBad(dev, blockInNAND) != YAFFS_OK) {
 506                 if (yaffs_EraseBlockInNAND(dev, blockInNAND) != YAFFS_OK) {
 507                         T(YAFFS_TRACE_ALWAYS, (TSTR(
 508                                 "yaffs: Failed to mark bad and erase block %d"
 509                                 TENDSTR), blockInNAND));
 510                 } else {
 511                         yaffs_ExtendedTags tags;
 512                         int chunkId = blockInNAND * dev->param.nChunksPerBlock;
 513
 514                         __u8 *buffer = yaffs_GetTempBuffer(dev, __LINE__);
 515
 516                         memset(buffer, 0xff, dev->nDataBytesPerChunk);
 517                         yaffs_InitialiseTags(&tags);
 518                         tags.sequenceNumber = YAFFS_SEQUENCE_BAD_BLOCK;
 519                         if (dev->param.writeChunkWithTagsToNAND(dev, chunkId -
 520                                 dev->chunkOffset, buffer, &tags) != YAFFS_OK)
 521                                 T(YAFFS_TRACE_ALWAYS, (TSTR("yaffs: Failed to "
 522                                         TCONT("write bad block marker to block %d")
 523                                         TENDSTR), blockInNAND));
 524
 525                         yaffs_ReleaseTempBuffer(dev, buffer, __LINE__);
 526                 }
 527         }
 528
 529         bi->blockState = YAFFS_BLOCK_STATE_DEAD;
 530         bi->gcPrioritise = 0;
 531         bi->needsRetiring = 0;
 532
 533         dev->nRetiredBlocks++;
 534 }
 535
 536 /*
 537  * Functions for robustisizing TODO
 538  *
 539  */
 540
 541 static void yaffs_HandleWriteChunkOk(yaffs_Device *dev, int chunkInNAND,
 542                                 const __u8 *data,
 543                                 const yaffs_ExtendedTags *tags)
 544 {
 545         dev=dev;
 546         chunkInNAND=chunkInNAND;
 547         data=data;
 548         tags=tags;
 549 }
 550
 551 static void yaffs_HandleUpdateChunk(yaffs_Device *dev, int chunkInNAND,
 552                                 const yaffs_ExtendedTags *tags)
 553 {
 554         dev=dev;
 555         chunkInNAND=chunkInNAND;
 556         tags=tags;
 557 }
 558
 559 void yaffs_HandleChunkError(yaffs_Device *dev, yaffs_BlockInfo *bi)
 560 {
 561         if (!bi->gcPrioritise) {
 562                 bi->gcPrioritise = 1;
 563                 dev->hasPendingPrioritisedGCs = 1;
 564                 bi->chunkErrorStrikes++;
 565
 566                 if (bi->chunkErrorStrikes > 3) {
 567                         bi->needsRetiring = 1; /* Too many stikes, so retire this */
 568                         T(YAFFS_TRACE_ALWAYS, (TSTR("yaffs: Block struck out" TENDSTR)));
 569
 570                 }
 571         }
 572 }
 573
 574 static void yaffs_HandleWriteChunkError(yaffs_Device *dev, int chunkInNAND,
 575                 int erasedOk)
 576 {
 577         int blockInNAND = chunkInNAND / dev->param.nChunksPerBlock;
 578         yaffs_BlockInfo *bi = yaffs_GetBlockInfo(dev, blockInNAND);
 579
 580         yaffs_HandleChunkError(dev, bi);
 581
 582         if (erasedOk) {
 583                 /* Was an actual write failure, so mark the block for retirement  */
 584                 bi->needsRetiring = 1;
 585                 T(YAFFS_TRACE_ERROR | YAFFS_TRACE_BAD_BLOCKS,
 586                   (TSTR("**>> Block %d needs retiring" TENDSTR), blockInNAND));
 587         }
 588
 589         /* Delete the chunk */
 590         yaffs_DeleteChunk(dev, chunkInNAND, 1, __LINE__);
 591         yaffs_SkipRestOfBlock(dev);
 592 }
 593
 594
 595 /*---------------- Name handling functions ------------*/
 596
 597 static __u16 yaffs_CalcNameSum(const YCHAR *name)
 598 {
 599         __u16 sum = 0;
 600         __u16 i = 1;
 601
 602         const YUCHAR *bname = (const YUCHAR *) name;
 603         if (bname) {
 604                 while ((*bname) && (i < (YAFFS_MAX_NAME_LENGTH/2))) {
 605
 606 #ifdef CONFIG_YAFFS_CASE_INSENSITIVE
 607                         sum += yaffs_toupper(*bname) * i;
 608 #else
 609                         sum += (*bname) * i;
 610 #endif
 611                         i++;
 612                         bname++;
 613                 }
 614         }
 615         return sum;
 616 }
 617
 618 void yaffs_SetObjectName(yaffs_Object *obj, const YCHAR *name)
 619 {
 620 #ifdef CONFIG_YAFFS_SHORT_NAMES_IN_RAM
 621         memset(obj->shortName, 0, sizeof(YCHAR) * (YAFFS_SHORT_NAME_LENGTH+1));
 622         if (name && yaffs_strnlen(name,YAFFS_SHORT_NAME_LENGTH+1) <= YAFFS_SHORT_NAME_LENGTH)
 623                 yaffs_strcpy(obj->shortName, name);
 624         else
 625                 obj->shortName[0] = _Y('\0');
 626 #endif
 627         obj->sum = yaffs_CalcNameSum(name);
 628 }
 629
 630 void yaffs_SetObjectNameFromOH(yaffs_Object *obj, const yaffs_ObjectHeader *oh)
 631 {
 632 #ifdef CONFIG_YAFFS_AUTO_UNICODE
 633         YCHAR tmpName[YAFFS_MAX_NAME_LENGTH+1];
 634         memset(tmpName,0,sizeof(tmpName));
 635         yaffs_LoadNameFromObjectHeader(obj->myDev,tmpName,oh->name,YAFFS_MAX_NAME_LENGTH+1);
 636         yaffs_SetObjectName(obj,tmpName);
 637 #else
 638         yaffs_SetObjectName(obj,oh->name);
 639 #endif
 640 }
 641
 642 /*-------------------- TNODES -------------------
 643
 644  * List of spare tnodes
 645  * The list is hooked together using the first pointer
 646  * in the tnode.
 647  */
 648
 649
 650 yaffs_Tnode *yaffs_GetTnode(yaffs_Device *dev)
 651 {
 652         yaffs_Tnode *tn = yaffs_AllocateRawTnode(dev);
 653         if (tn){
 654                 memset(tn, 0, dev->tnodeSize);
 655                 dev->nTnodes++;
 656         }
 657
 658         dev->nCheckpointBlocksRequired = 0; /* force recalculation*/
 659
 660         return tn;
 661 }
 662
 663 /* FreeTnode frees up a tnode and puts it back on the free list */
 664 static void yaffs_FreeTnode(yaffs_Device *dev, yaffs_Tnode *tn)
 665 {
 666         yaffs_FreeRawTnode(dev,tn);
 667         dev->nTnodes--;
 668         dev->nCheckpointBlocksRequired = 0; /* force recalculation*/
 669 }
 670
 671 static void yaffs_DeinitialiseTnodesAndObjects(yaffs_Device *dev)
 672 {
 673         yaffs_DeinitialiseRawTnodesAndObjects(dev);
 674         dev->nObjects = 0;
 675         dev->nTnodes = 0;
 676 }
 677
 678
 679 void yaffs_LoadLevel0Tnode(yaffs_Device *dev, yaffs_Tnode *tn, unsigned pos,
 680                 unsigned val)
 681 {
 682         __u32 *map = (__u32 *)tn;
 683         __u32 bitInMap;
 684         __u32 bitInWord;
 685         __u32 wordInMap;
 686         __u32 mask;
 687
 688         pos &= YAFFS_TNODES_LEVEL0_MASK;
 689         val >>= dev->chunkGroupBits;
 690
 691         bitInMap = pos * dev->tnodeWidth;
 692         wordInMap = bitInMap / 32;
 693         bitInWord = bitInMap & (32 - 1);
 694
 695         mask = dev->tnodeMask << bitInWord;
 696
 697         map[wordInMap] &= ~mask;
 698         map[wordInMap] |= (mask & (val << bitInWord));
 699
 700         if (dev->tnodeWidth > (32 - bitInWord)) {
 701                 bitInWord = (32 - bitInWord);
 702                 wordInMap++;;
 703                 mask = dev->tnodeMask >> (/*dev->tnodeWidth -*/ bitInWord);
 704                 map[wordInMap] &= ~mask;
 705                 map[wordInMap] |= (mask & (val >> bitInWord));
 706         }
 707 }
 708
 709 __u32 yaffs_GetChunkGroupBase(yaffs_Device *dev, yaffs_Tnode *tn,
 710                 unsigned pos)
 711 {
 712         __u32 *map = (__u32 *)tn;
 713         __u32 bitInMap;
 714         __u32 bitInWord;
 715         __u32 wordInMap;
 716         __u32 val;
 717
 718         pos &= YAFFS_TNODES_LEVEL0_MASK;
 719
 720         bitInMap = pos * dev->tnodeWidth;
 721         wordInMap = bitInMap / 32;
 722         bitInWord = bitInMap & (32 - 1);
 723
 724         val = map[wordInMap] >> bitInWord;
 725
 726         if      (dev->tnodeWidth > (32 - bitInWord)) {
 727                 bitInWord = (32 - bitInWord);
 728                 wordInMap++;;
 729                 val |= (map[wordInMap] << bitInWord);
 730         }
 731
 732         val &= dev->tnodeMask;
 733         val <<= dev->chunkGroupBits;
 734
 735         return val;
 736 }
 737
 738 /* ------------------- End of individual tnode manipulation -----------------*/
 739
 740 /* ---------Functions to manipulate the look-up tree (made up of tnodes) ------
 741  * The look up tree is represented by the top tnode and the number of topLevel
 742  * in the tree. 0 means only the level 0 tnode is in the tree.
 743  */
 744
 745 /* FindLevel0Tnode finds the level 0 tnode, if one exists. */
 746 yaffs_Tnode *yaffs_FindLevel0Tnode(yaffs_Device *dev,
 747                                         yaffs_FileStructure *fStruct,
 748                                         __u32 chunkId)
 749 {
 750         yaffs_Tnode *tn = fStruct->top;
 751         __u32 i;
 752         int requiredTallness;
 753         int level = fStruct->topLevel;
 754
 755         dev=dev;
 756
 757         /* Check sane level and chunk Id */
 758         if (level < 0 || level > YAFFS_TNODES_MAX_LEVEL)
 759                 return NULL;
 760
 761         if (chunkId > YAFFS_MAX_CHUNK_ID)
 762                 return NULL;
 763
 764         /* First check we're tall enough (ie enough topLevel) */
 765
 766         i = chunkId >> YAFFS_TNODES_LEVEL0_BITS;
 767         requiredTallness = 0;
 768         while (i) {
 769                 i >>= YAFFS_TNODES_INTERNAL_BITS;
 770                 requiredTallness++;
 771         }
 772
 773         if (requiredTallness > fStruct->topLevel)
 774                 return NULL; /* Not tall enough, so we can't find it */
 775
 776         /* Traverse down to level 0 */
 777         while (level > 0 && tn) {
 778                 tn = tn->internal[(chunkId >>
 779                         (YAFFS_TNODES_LEVEL0_BITS +
 780                                 (level - 1) *
 781                                 YAFFS_TNODES_INTERNAL_BITS)) &
 782                         YAFFS_TNODES_INTERNAL_MASK];
 783                 level--;
 784         }
 785
 786         return tn;
 787 }
 788
 789 /* AddOrFindLevel0Tnode finds the level 0 tnode if it exists, otherwise first expands the tree.
 790  * This happens in two steps:
 791  *  1. If the tree isn't tall enough, then make it taller.
 792  *  2. Scan down the tree towards the level 0 tnode adding tnodes if required.
 793  *
 794  * Used when modifying the tree.
 795  *
 796  *  If the tn argument is NULL, then a fresh tnode will be added otherwise the specified tn will
 797  *  be plugged into the ttree.
 798  */
 799
 800 yaffs_Tnode *yaffs_AddOrFindLevel0Tnode(yaffs_Device *dev,
 801                                         yaffs_FileStructure *fStruct,
 802                                         __u32 chunkId,
 803                                         yaffs_Tnode *passedTn)
 804 {
 805         int requiredTallness;
 806         int i;
 807         int l;
 808         yaffs_Tnode *tn;
 809
 810         __u32 x;
 811
 812
 813         /* Check sane level and page Id */
 814         if (fStruct->topLevel < 0 || fStruct->topLevel > YAFFS_TNODES_MAX_LEVEL)
 815                 return NULL;
 816
 817         if (chunkId > YAFFS_MAX_CHUNK_ID)
 818                 return NULL;
 819
 820         /* First check we're tall enough (ie enough topLevel) */
 821
 822         x = chunkId >> YAFFS_TNODES_LEVEL0_BITS;
 823         requiredTallness = 0;
 824         while (x) {
 825                 x >>= YAFFS_TNODES_INTERNAL_BITS;
 826                 requiredTallness++;
 827         }
 828
 829
 830         if (requiredTallness > fStruct->topLevel) {
 831                 /* Not tall enough, gotta make the tree taller */
 832                 for (i = fStruct->topLevel; i < requiredTallness; i++) {
 833
 834                         tn = yaffs_GetTnode(dev);
 835
 836                         if (tn) {
 837                                 tn->internal[0] = fStruct->top;
 838                                 fStruct->top = tn;
 839                                 fStruct->topLevel++;
 840                         } else {
 841                                 T(YAFFS_TRACE_ERROR,
 842                                         (TSTR("yaffs: no more tnodes" TENDSTR)));
 843                                 return NULL;
 844                         }
 845                 }
 846         }
 847
 848         /* Traverse down to level 0, adding anything we need */
 849
 850         l = fStruct->topLevel;
 851         tn = fStruct->top;
 852
 853         if (l > 0) {
 854                 while (l > 0 && tn) {
 855                         x = (chunkId >>
 856                              (YAFFS_TNODES_LEVEL0_BITS +
 857                               (l - 1) * YAFFS_TNODES_INTERNAL_BITS)) &
 858                             YAFFS_TNODES_INTERNAL_MASK;
 859
 860
 861                         if ((l > 1) && !tn->internal[x]) {
 862                                 /* Add missing non-level-zero tnode */
 863                                 tn->internal[x] = yaffs_GetTnode(dev);
 864                                 if(!tn->internal[x])
 865                                         return NULL;
 866                         } else if (l == 1) {
 867                                 /* Looking from level 1 at level 0 */
 868                                 if (passedTn) {
 869                                         /* If we already have one, then release it.*/
 870                                         if (tn->internal[x])
 871                                                 yaffs_FreeTnode(dev, tn->internal[x]);
 872                                         tn->internal[x] = passedTn;
 873
 874                                 } else if (!tn->internal[x]) {
 875                                         /* Don't have one, none passed in */
 876                                         tn->internal[x] = yaffs_GetTnode(dev);
 877                                         if(!tn->internal[x])
 878                                                 return NULL;
 879                                 }
 880                         }
 881
 882                         tn = tn->internal[x];
 883                         l--;
 884                 }
 885         } else {
 886                 /* top is level 0 */
 887                 if (passedTn) {
 888                         memcpy(tn, passedTn, (dev->tnodeWidth * YAFFS_NTNODES_LEVEL0)/8);
 889                         yaffs_FreeTnode(dev, passedTn);
 890                 }
 891         }
 892
 893         return tn;
 894 }
 895
 896 static int yaffs_FindChunkInGroup(yaffs_Device *dev, int theChunk,
 897                                 yaffs_ExtendedTags *tags, int objectId,
 898                                 int chunkInInode)
 899 {
 900         int j;
 901
 902         for (j = 0; theChunk && j < dev->chunkGroupSize; j++) {
 903                 if (yaffs_CheckChunkBit(dev, theChunk / dev->param.nChunksPerBlock,
 904                                 theChunk % dev->param.nChunksPerBlock)) {
 905
 906                         if(dev->chunkGroupSize == 1)
 907                                 return theChunk;
 908                         else {
 909                                 yaffs_ReadChunkWithTagsFromNAND(dev, theChunk, NULL,
 910                                                                 tags);
 911                                 if (yaffs_TagsMatch(tags, objectId, chunkInInode)) {
 912                                         /* found it; */
 913                                         return theChunk;
 914                                 }
 915                         }
 916                 }
 917                 theChunk++;
 918         }
 919         return -1;
 920 }
 921
 922 #if 0
 923 /* Experimental code not being used yet. Might speed up file deletion */
 924 /* DeleteWorker scans backwards through the tnode tree and deletes all the
 925  * chunks and tnodes in the file.
 926  * Returns 1 if the tree was deleted.
 927  * Returns 0 if it stopped early due to hitting the limit and the delete is incomplete.
 928  */
 929
 930 static int yaffs_DeleteWorker(yaffs_Object *in, yaffs_Tnode *tn, __u32 level,
 931                               int chunkOffset, int *limit)
 932 {
 933         int i;
 934         int chunkInInode;
 935         int theChunk;
 936         yaffs_ExtendedTags tags;
 937         int foundChunk;
 938         yaffs_Device *dev = in->myDev;
 939
 940         int allDone = 1;
 941
 942         if (tn) {
 943                 if (level > 0) {
 944                         for (i = YAFFS_NTNODES_INTERNAL - 1; allDone && i >= 0;
 945                              i--) {
 946                                 if (tn->internal[i]) {
 947                                         if (limit && (*limit) < 0) {
 948                                                 allDone = 0;
 949                                         } else {
 950                                                 allDone =
 951                                                         yaffs_DeleteWorker(in,
 952                                                                 tn->
 953                                                                 internal
 954                                                                 [i],
 955                                                                 level -
 956                                                                 1,
 957                                                                 (chunkOffset
 958                                                                         <<
 959                                                                         YAFFS_TNODES_INTERNAL_BITS)
 960                                                                 + i,
 961                                                                 limit);
 962                                         }
 963                                         if (allDone) {
 964                                                 yaffs_FreeTnode(dev,
 965                                                                 tn->
 966                                                                 internal[i]);
 967                                                 tn->internal[i] = NULL;
 968                                         }
 969                                 }
 970                         }
 971                         return (allDone) ? 1 : 0;
 972                 } else if (level == 0) {
 973                         int hitLimit = 0;
 974
 975                         for (i = YAFFS_NTNODES_LEVEL0 - 1; i >= 0 && !hitLimit;
 976                                         i--) {
 977                                 theChunk = yaffs_GetChunkGroupBase(dev, tn, i);
 978                                 if (theChunk) {
 979
 980                                         chunkInInode = (chunkOffset <<
 981                                                 YAFFS_TNODES_LEVEL0_BITS) + i;
 982
 983                                         foundChunk =
 984                                                 yaffs_FindChunkInGroup(dev,
 985                                                                 theChunk,
 986                                                                 &tags,
 987                                                                 in->objectId,
 988                                                                 chunkInInode);
 989
 990                                         if (foundChunk > 0) {
 991                                                 yaffs_DeleteChunk(dev,
 992                                                                   foundChunk, 1,
 993                                                                   __LINE__);
 994                                                 in->nDataChunks--;
 995                                                 if (limit) {
 996                                                         *limit = *limit - 1;
 997                                                         if (*limit <= 0)
 998                                                                 hitLimit = 1;
 999                                                 }
1000
1001                                         }
1002
1003                                         yaffs_LoadLevel0Tnode(dev, tn, i, 0);
1004                                 }
1005
1006                         }
1007                         return (i < 0) ? 1 : 0;
1008
1009                 }
1010
1011         }
1012
1013         return 1;
1014
1015 }
1016
1017 #endif
1018
1019 static void yaffs_SoftDeleteChunk(yaffs_Device *dev, int chunk)
1020 {
1021         yaffs_BlockInfo *theBlock;
1022         unsigned blockNo;
1023
1024         T(YAFFS_TRACE_DELETION, (TSTR("soft delete chunk %d" TENDSTR), chunk));
1025
1026         blockNo =  chunk / dev->param.nChunksPerBlock;
1027         theBlock = yaffs_GetBlockInfo(dev, blockNo);
1028         if (theBlock) {
1029                 theBlock->softDeletions++;
1030                 dev->nFreeChunks++;
1031                 yaffs2_UpdateOldestDirtySequence(dev, blockNo, theBlock);
1032         }
1033 }
1034
1035 /* SoftDeleteWorker scans backwards through the tnode tree and soft deletes all the chunks in the file.
1036  * All soft deleting does is increment the block's softdelete count and pulls the chunk out
1037  * of the tnode.
1038  * Thus, essentially this is the same as DeleteWorker except that the chunks are soft deleted.
1039  */
1040
1041 static int yaffs_SoftDeleteWorker(yaffs_Object *in, yaffs_Tnode *tn,
1042                                   __u32 level, int chunkOffset)
1043 {
1044         int i;
1045         int theChunk;
1046         int allDone = 1;
1047         yaffs_Device *dev = in->myDev;
1048
1049         if (tn) {
1050                 if (level > 0) {
1051
1052                         for (i = YAFFS_NTNODES_INTERNAL - 1; allDone && i >= 0;
1053                              i--) {
1054                                 if (tn->internal[i]) {
1055                                         allDone =
1056                                             yaffs_SoftDeleteWorker(in,
1057                                                                    tn->
1058                                                                    internal[i],
1059                                                                    level - 1,
1060                                                                    (chunkOffset
1061                                                                     <<
1062                                                                     YAFFS_TNODES_INTERNAL_BITS)
1063                                                                    + i);
1064                                         if (allDone) {
1065                                                 yaffs_FreeTnode(dev,
1066                                                                 tn->
1067                                                                 internal[i]);
1068                                                 tn->internal[i] = NULL;
1069                                         } else {
1070                                                 /* Hoosterman... how could this happen? */
1071                                         }
1072                                 }
1073                         }
1074                         return (allDone) ? 1 : 0;
1075                 } else if (level == 0) {
1076
1077                         for (i = YAFFS_NTNODES_LEVEL0 - 1; i >= 0; i--) {
1078                                 theChunk = yaffs_GetChunkGroupBase(dev, tn, i);
1079                                 if (theChunk) {
1080                                         /* Note this does not find the real chunk, only the chunk group.
1081                                          * We make an assumption that a chunk group is not larger than
1082                                          * a block.
1083                                          */
1084                                         yaffs_SoftDeleteChunk(dev, theChunk);
1085                                         yaffs_LoadLevel0Tnode(dev, tn, i, 0);
1086                                 }
1087
1088                         }
1089                         return 1;
1090
1091                 }
1092
1093         }
1094
1095         return 1;
1096
1097 }
1098
1099 static void yaffs_SoftDeleteFile(yaffs_Object *obj)
1100 {
1101         if (obj->deleted &&
1102             obj->variantType == YAFFS_OBJECT_TYPE_FILE && !obj->softDeleted) {
1103                 if (obj->nDataChunks <= 0) {
1104                         /* Empty file with no duplicate object headers, just delete it immediately */
1105                         yaffs_FreeTnode(obj->myDev,
1106                                         obj->variant.fileVariant.top);
1107                         obj->variant.fileVariant.top = NULL;
1108                         T(YAFFS_TRACE_TRACING,
1109                           (TSTR("yaffs: Deleting empty file %d" TENDSTR),
1110                            obj->objectId));
1111                         yaffs_DoGenericObjectDeletion(obj);
1112                 } else {
1113                         yaffs_SoftDeleteWorker(obj,
1114                                                obj->variant.fileVariant.top,
1115                                                obj->variant.fileVariant.
1116                                                topLevel, 0);
1117                         obj->softDeleted = 1;
1118                 }
1119         }
1120 }
1121
1122 /* Pruning removes any part of the file structure tree that is beyond the
1123  * bounds of the file (ie that does not point to chunks).
1124  *
1125  * A file should only get pruned when its size is reduced.
1126  *
1127  * Before pruning, the chunks must be pulled from the tree and the
1128  * level 0 tnode entries must be zeroed out.
1129  * Could also use this for file deletion, but that's probably better handled
1130  * by a special case.
1131  *
1132  * This function is recursive. For levels > 0 the function is called again on
1133  * any sub-tree. For level == 0 we just check if the sub-tree has data.
1134  * If there is no data in a subtree then it is pruned.
1135  */
1136
1137 static yaffs_Tnode *yaffs_PruneWorker(yaffs_Device *dev, yaffs_Tnode *tn,
1138                                 __u32 level, int del0)
1139 {
1140         int i;
1141         int hasData;
1142
1143         if (tn) {
1144                 hasData = 0;
1145
1146                 if(level > 0){
1147                         for (i = 0; i < YAFFS_NTNODES_INTERNAL; i++) {
1148                                 if (tn->internal[i]) {
1149                                         tn->internal[i] =
1150                                                 yaffs_PruneWorker(dev, tn->internal[i],
1151                                                         level - 1,
1152                                                         (i == 0) ? del0 : 1);
1153                                 }
1154
1155                                 if (tn->internal[i])
1156                                         hasData++;
1157                         }
1158                 } else {
1159                         int tnodeSize_u32 = dev->tnodeSize/sizeof(__u32);
1160                         __u32 *map = (__u32 *)tn;
1161
1162                         for(i = 0; !hasData && i < tnodeSize_u32; i++){
1163                                 if(map[i])
1164                                         hasData++;
1165                         }
1166                 }
1167
1168                 if (hasData == 0 && del0) {
1169                         /* Free and return NULL */
1170
1171                         yaffs_FreeTnode(dev, tn);
1172                         tn = NULL;
1173                 }
1174
1175         }
1176
1177         return tn;
1178
1179 }
1180
1181 static int yaffs_PruneFileStructure(yaffs_Device *dev,
1182                                 yaffs_FileStructure *fStruct)
1183 {
1184         int i;
1185         int hasData;
1186         int done = 0;
1187         yaffs_Tnode *tn;
1188
1189         if (fStruct->topLevel > 0) {
1190                 fStruct->top =
1191                     yaffs_PruneWorker(dev, fStruct->top, fStruct->topLevel, 0);
1192
1193                 /* Now we have a tree with all the non-zero branches NULL but the height
1194                  * is the same as it was.
1195                  * Let's see if we can trim internal tnodes to shorten the tree.
1196                  * We can do this if only the 0th element in the tnode is in use
1197                  * (ie all the non-zero are NULL)
1198                  */
1199
1200                 while (fStruct->topLevel && !done) {
1201                         tn = fStruct->top;
1202
1203                         hasData = 0;
1204                         for (i = 1; i < YAFFS_NTNODES_INTERNAL; i++) {
1205                                 if (tn->internal[i])
1206                                         hasData++;
1207                         }
1208
1209                         if (!hasData) {
1210                                 fStruct->top = tn->internal[0];
1211                                 fStruct->topLevel--;
1212                                 yaffs_FreeTnode(dev, tn);
1213                         } else {
1214                                 done = 1;
1215                         }
1216                 }
1217         }
1218
1219         return YAFFS_OK;
1220 }
1221
1222 /*-------------------- End of File Structure functions.-------------------*/
1223
1224
1225 /* AllocateEmptyObject gets us a clean Object. Tries to make allocate more if we run out */
1226 static yaffs_Object *yaffs_AllocateEmptyObject(yaffs_Device *dev)
1227 {
1228         yaffs_Object *obj = yaffs_AllocateRawObject(dev);
1229
1230         if (obj) {
1231                 dev->nObjects++;
1232
1233                 /* Now sweeten it up... */
1234
1235                 memset(obj, 0, sizeof(yaffs_Object));
1236                 obj->beingCreated = 1;
1237
1238                 obj->myDev = dev;
1239                 obj->hdrChunk = 0;
1240                 obj->variantType = YAFFS_OBJECT_TYPE_UNKNOWN;
1241                 YINIT_LIST_HEAD(&(obj->hardLinks));
1242                 YINIT_LIST_HEAD(&(obj->hashLink));
1243                 YINIT_LIST_HEAD(&obj->siblings);
1244
1245
1246                 /* Now make the directory sane */
1247                 if (dev->rootDir) {
1248                         obj->parent = dev->rootDir;
1249                         ylist_add(&(obj->siblings), &dev->rootDir->variant.directoryVariant.children);
1250                 }
1251
1252                 /* Add it to the lost and found directory.
1253                  * NB Can't put root or lostNFound in lostNFound so
1254                  * check if lostNFound exists first
1255                  */
1256                 if (dev->lostNFoundDir)
1257                         yaffs_AddObjectToDirectory(dev->lostNFoundDir, obj);
1258
1259                 obj->beingCreated = 0;
1260         }
1261
1262         dev->nCheckpointBlocksRequired = 0; /* force recalculation*/
1263
1264         return obj;
1265 }
1266
1267 static yaffs_Object *yaffs_CreateFakeDirectory(yaffs_Device *dev, int number,
1268                                                __u32 mode)
1269 {
1270
1271         yaffs_Object *obj =
1272             yaffs_CreateNewObject(dev, number, YAFFS_OBJECT_TYPE_DIRECTORY);
1273         if (obj) {
1274                 obj->fake = 1;          /* it is fake so it might have no NAND presence... */
1275                 obj->renameAllowed = 0; /* ... and we're not allowed to rename it... */
1276                 obj->unlinkAllowed = 0; /* ... or unlink it */
1277                 obj->deleted = 0;
1278                 obj->unlinked = 0;
1279                 obj->yst_mode = mode;
1280                 obj->myDev = dev;
1281                 obj->hdrChunk = 0;      /* Not a valid chunk. */
1282         }
1283
1284         return obj;
1285
1286 }
1287
1288 static void yaffs_UnhashObject(yaffs_Object *obj)
1289 {
1290         int bucket;
1291         yaffs_Device *dev = obj->myDev;
1292
1293         /* If it is still linked into the bucket list, free from the list */
1294         if (!ylist_empty(&obj->hashLink)) {
1295                 ylist_del_init(&obj->hashLink);
1296                 bucket = yaffs_HashFunction(obj->objectId);
1297                 dev->objectBucket[bucket].count--;
1298         }
1299 }
1300
1301 /*  FreeObject frees up a Object and puts it back on the free list */
1302 static void yaffs_FreeObject(yaffs_Object *obj)
1303 {
1304         yaffs_Device *dev = obj->myDev;
1305
1306         T(YAFFS_TRACE_OS, (TSTR("FreeObject %p inode %p"TENDSTR), obj, obj->myInode));
1307
1308         if (!obj)
1309                 YBUG();
1310         if (obj->parent)
1311                 YBUG();
1312         if (!ylist_empty(&obj->siblings))
1313                 YBUG();
1314
1315
1316         if (obj->myInode) {
1317                 /* We're still hooked up to a cached inode.
1318                  * Don't delete now, but mark for later deletion
1319                  */
1320                 obj->deferedFree = 1;
1321                 return;
1322         }
1323
1324         yaffs_UnhashObject(obj);
1325
1326         yaffs_FreeRawObject(dev,obj);
1327         dev->nObjects--;
1328         dev->nCheckpointBlocksRequired = 0; /* force recalculation*/
1329 }
1330
1331
1332 void yaffs_HandleDeferedFree(yaffs_Object *obj)
1333 {
1334         if (obj->deferedFree)
1335                 yaffs_FreeObject(obj);
1336 }
1337
1338 static void yaffs_InitialiseTnodesAndObjects(yaffs_Device *dev)
1339 {
1340         int i;
1341
1342         dev->nObjects = 0;
1343         dev->nTnodes = 0;
1344
1345         yaffs_InitialiseRawTnodesAndObjects(dev);
1346
1347         for (i = 0; i < YAFFS_NOBJECT_BUCKETS; i++) {
1348                 YINIT_LIST_HEAD(&dev->objectBucket[i].list);
1349                 dev->objectBucket[i].count = 0;
1350         }
1351 }
1352
1353 static int yaffs_FindNiceObjectBucket(yaffs_Device *dev)
1354 {
1355         int i;
1356         int l = 999;
1357         int lowest = 999999;
1358
1359
1360         /* Search for the shortest list or one that
1361          * isn't too long.
1362          */
1363
1364         for (i = 0; i < 10 && lowest > 4; i++) {
1365                 dev->bucketFinder++;
1366                 dev->bucketFinder %= YAFFS_NOBJECT_BUCKETS;
1367                 if (dev->objectBucket[dev->bucketFinder].count < lowest) {
1368                         lowest = dev->objectBucket[dev->bucketFinder].count;
1369                         l = dev->bucketFinder;
1370                 }
1371
1372         }
1373
1374         return l;
1375 }
1376
1377 static int yaffs_CreateNewObjectNumber(yaffs_Device *dev)
1378 {
1379         int bucket = yaffs_FindNiceObjectBucket(dev);
1380
1381         /* Now find an object value that has not already been taken
1382          * by scanning the list.
1383          */
1384
1385         int found = 0;
1386         struct ylist_head *i;
1387
1388         __u32 n = (__u32) bucket;
1389
1390         /* yaffs_CheckObjectHashSanity();  */
1391
1392         while (!found) {
1393                 found = 1;
1394                 n += YAFFS_NOBJECT_BUCKETS;
1395                 if (1 || dev->objectBucket[bucket].count > 0) {
1396                         ylist_for_each(i, &dev->objectBucket[bucket].list) {
1397                                 /* If there is already one in the list */
1398                                 if (i && ylist_entry(i, yaffs_Object,
1399                                                 hashLink)->objectId == n) {
1400                                         found = 0;
1401                                 }
1402                         }
1403                 }
1404         }
1405
1406         return n;
1407 }
1408
1409 static void yaffs_HashObject(yaffs_Object *in)
1410 {
1411         int bucket = yaffs_HashFunction(in->objectId);
1412         yaffs_Device *dev = in->myDev;
1413
1414         ylist_add(&in->hashLink, &dev->objectBucket[bucket].list);
1415         dev->objectBucket[bucket].count++;
1416 }
1417
1418 yaffs_Object *yaffs_FindObjectByNumber(yaffs_Device *dev, __u32 number)
1419 {
1420         int bucket = yaffs_HashFunction(number);
1421         struct ylist_head *i;
1422         yaffs_Object *in;
1423
1424         ylist_for_each(i, &dev->objectBucket[bucket].list) {
1425                 /* Look if it is in the list */
1426                 if (i) {
1427                         in = ylist_entry(i, yaffs_Object, hashLink);
1428                         if (in->objectId == number) {
1429
1430                                 /* Don't tell the VFS about this one if it is defered free */
1431                                 if (in->deferedFree)
1432                                         return NULL;
1433
1434                                 return in;
1435                         }
1436                 }
1437         }
1438
1439         return NULL;
1440 }
1441
1442 yaffs_Object *yaffs_CreateNewObject(yaffs_Device *dev, int number,
1443                                     yaffs_ObjectType type)
1444 {
1445         yaffs_Object *theObject=NULL;
1446         yaffs_Tnode *tn = NULL;
1447
1448         if (number < 0)
1449                 number = yaffs_CreateNewObjectNumber(dev);
1450
1451         if (type == YAFFS_OBJECT_TYPE_FILE) {
1452                 tn = yaffs_GetTnode(dev);
1453                 if (!tn)
1454                         return NULL;
1455         }
1456
1457         theObject = yaffs_AllocateEmptyObject(dev);
1458         if (!theObject){
1459                 if(tn)
1460                         yaffs_FreeTnode(dev,tn);
1461                 return NULL;
1462         }
1463
1464
1465         if (theObject) {
1466                 theObject->fake = 0;
1467                 theObject->renameAllowed = 1;
1468                 theObject->unlinkAllowed = 1;
1469                 theObject->objectId = number;
1470                 yaffs_HashObject(theObject);
1471                 theObject->variantType = type;
1472 #ifdef CONFIG_YAFFS_WINCE
1473                 yfsd_WinFileTimeNow(theObject->win_atime);
1474                 theObject->win_ctime[0] = theObject->win_mtime[0] =
1475                     theObject->win_atime[0];
1476                 theObject->win_ctime[1] = theObject->win_mtime[1] =
1477                     theObject->win_atime[1];
1478
1479 #else
1480
1481                 theObject->yst_atime = theObject->yst_mtime =
1482                     theObject->yst_ctime = Y_CURRENT_TIME;
1483 #endif
1484                 switch (type) {
1485                 case YAFFS_OBJECT_TYPE_FILE:
1486                         theObject->variant.fileVariant.fileSize = 0;
1487                         theObject->variant.fileVariant.scannedFileSize = 0;
1488                         theObject->variant.fileVariant.shrinkSize = 0xFFFFFFFF; /* max __u32 */
1489                         theObject->variant.fileVariant.topLevel = 0;
1490                         theObject->variant.fileVariant.top = tn;
1491                         break;
1492                 case YAFFS_OBJECT_TYPE_DIRECTORY:
1493                         YINIT_LIST_HEAD(&theObject->variant.directoryVariant.
1494                                         children);
1495                         YINIT_LIST_HEAD(&theObject->variant.directoryVariant.
1496                                         dirty);
1497                         break;
1498                 case YAFFS_OBJECT_TYPE_SYMLINK:
1499                 case YAFFS_OBJECT_TYPE_HARDLINK:
1500                 case YAFFS_OBJECT_TYPE_SPECIAL:
1501                         /* No action required */
1502                         break;
1503                 case YAFFS_OBJECT_TYPE_UNKNOWN:
1504                         /* todo this should not happen */
1505                         break;
1506                 }
1507         }
1508
1509         return theObject;
1510 }
1511
1512 yaffs_Object *yaffs_FindOrCreateObjectByNumber(yaffs_Device *dev,
1513                                                 int number,
1514                                                 yaffs_ObjectType type)
1515 {
1516         yaffs_Object *theObject = NULL;
1517
1518         if (number > 0)
1519                 theObject = yaffs_FindObjectByNumber(dev, number);
1520
1521         if (!theObject)
1522                 theObject = yaffs_CreateNewObject(dev, number, type);
1523
1524         return theObject;
1525
1526 }
1527
1528
1529 YCHAR *yaffs_CloneString(const YCHAR *str)
1530 {
1531         YCHAR *newStr = NULL;
1532         int len;
1533
1534         if (!str)
1535                 str = _Y("");
1536
1537         len = yaffs_strnlen(str,YAFFS_MAX_ALIAS_LENGTH);
1538         newStr = YMALLOC((len + 1) * sizeof(YCHAR));
1539         if (newStr){
1540                 yaffs_strncpy(newStr, str,len);
1541                 newStr[len] = 0;
1542         }
1543         return newStr;
1544
1545 }
1546
1547 /*
1548  * Mknod (create) a new object.
1549  * equivalentObject only has meaning for a hard link;
1550  * aliasString only has meaning for a symlink.
1551  * rdev only has meaning for devices (a subset of special objects)
1552  */
1553
1554 static yaffs_Object *yaffs_MknodObject(yaffs_ObjectType type,
1555                                        yaffs_Object *parent,
1556                                        const YCHAR *name,
1557                                        __u32 mode,
1558                                        __u32 uid,
1559                                        __u32 gid,
1560                                        yaffs_Object *equivalentObject,
1561                                        const YCHAR *aliasString, __u32 rdev)
1562 {
1563         yaffs_Object *in;
1564         YCHAR *str = NULL;
1565
1566         yaffs_Device *dev = parent->myDev;
1567
1568         /* Check if the entry exists. If it does then fail the call since we don't want a dup.*/
1569         if (yaffs_FindObjectByName(parent, name))
1570                 return NULL;
1571
1572         if (type == YAFFS_OBJECT_TYPE_SYMLINK) {
1573                 str = yaffs_CloneString(aliasString);
1574                 if (!str)
1575                         return NULL;
1576         }
1577
1578         in = yaffs_CreateNewObject(dev, -1, type);
1579
1580         if (!in){
1581                 if(str)
1582                         YFREE(str);
1583                 return NULL;
1584         }
1585
1586
1587
1588
1589
1590         if (in) {
1591                 in->hdrChunk = 0;
1592                 in->valid = 1;
1593                 in->variantType = type;
1594
1595                 in->yst_mode = mode;
1596
1597 #ifdef CONFIG_YAFFS_WINCE
1598                 yfsd_WinFileTimeNow(in->win_atime);
1599                 in->win_ctime[0] = in->win_mtime[0] = in->win_atime[0];
1600                 in->win_ctime[1] = in->win_mtime[1] = in->win_atime[1];
1601
1602 #else
1603                 in->yst_atime = in->yst_mtime = in->yst_ctime = Y_CURRENT_TIME;
1604
1605                 in->yst_rdev = rdev;
1606                 in->yst_uid = uid;
1607                 in->yst_gid = gid;
1608 #endif
1609                 in->nDataChunks = 0;
1610
1611                 yaffs_SetObjectName(in, name);
1612                 in->dirty = 1;
1613
1614                 yaffs_AddObjectToDirectory(parent, in);
1615
1616                 in->myDev = parent->myDev;
1617
1618                 switch (type) {
1619                 case YAFFS_OBJECT_TYPE_SYMLINK:
1620                         in->variant.symLinkVariant.alias = str;
1621                         break;
1622                 case YAFFS_OBJECT_TYPE_HARDLINK:
1623                         in->variant.hardLinkVariant.equivalentObject =
1624                                 equivalentObject;
1625                         in->variant.hardLinkVariant.equivalentObjectId =
1626                                 equivalentObject->objectId;
1627                         ylist_add(&in->hardLinks, &equivalentObject->hardLinks);
1628                         break;
1629                 case YAFFS_OBJECT_TYPE_FILE:
1630                 case YAFFS_OBJECT_TYPE_DIRECTORY:
1631                 case YAFFS_OBJECT_TYPE_SPECIAL:
1632                 case YAFFS_OBJECT_TYPE_UNKNOWN:
1633                         /* do nothing */
1634                         break;
1635                 }
1636
1637                 if (yaffs_UpdateObjectHeader(in, name, 0, 0, 0, NULL) < 0) {
1638                         /* Could not create the object header, fail the creation */
1639                         yaffs_DeleteObject(in);
1640                         in = NULL;
1641                 }
1642
1643                 yaffs_UpdateParent(parent);
1644         }
1645
1646         return in;
1647 }
1648
1649 yaffs_Object *yaffs_MknodFile(yaffs_Object *parent, const YCHAR *name,
1650                         __u32 mode, __u32 uid, __u32 gid)
1651 {
1652         return yaffs_MknodObject(YAFFS_OBJECT_TYPE_FILE, parent, name, mode,
1653                                 uid, gid, NULL, NULL, 0);
1654 }
1655
1656 yaffs_Object *yaffs_MknodDirectory(yaffs_Object *parent, const YCHAR *name,
1657                                 __u32 mode, __u32 uid, __u32 gid)
1658 {
1659         return yaffs_MknodObject(YAFFS_OBJECT_TYPE_DIRECTORY, parent, name,
1660                                  mode, uid, gid, NULL, NULL, 0);
1661 }
1662
1663 yaffs_Object *yaffs_MknodSpecial(yaffs_Object *parent, const YCHAR *name,
1664                                 __u32 mode, __u32 uid, __u32 gid, __u32 rdev)
1665 {
1666         return yaffs_MknodObject(YAFFS_OBJECT_TYPE_SPECIAL, parent, name, mode,
1667                                  uid, gid, NULL, NULL, rdev);
1668 }
1669
1670 yaffs_Object *yaffs_MknodSymLink(yaffs_Object *parent, const YCHAR *name,
1671                                 __u32 mode, __u32 uid, __u32 gid,
1672                                 const YCHAR *alias)
1673 {
1674         return yaffs_MknodObject(YAFFS_OBJECT_TYPE_SYMLINK, parent, name, mode,
1675                                 uid, gid, NULL, alias, 0);
1676 }
1677
1678 /* yaffs_Link returns the object id of the equivalent object.*/
1679 yaffs_Object *yaffs_Link(yaffs_Object *parent, const YCHAR *name,
1680                         yaffs_Object *equivalentObject)
1681 {
1682         /* Get the real object in case we were fed a hard link as an equivalent object */
1683         equivalentObject = yaffs_GetEquivalentObject(equivalentObject);
1684
1685         if (yaffs_MknodObject
1686             (YAFFS_OBJECT_TYPE_HARDLINK, parent, name, 0, 0, 0,
1687              equivalentObject, NULL, 0)) {
1688                 return equivalentObject;
1689         } else {
1690                 return NULL;
1691         }
1692
1693 }
1694
1695 static int yaffs_ChangeObjectName(yaffs_Object *obj, yaffs_Object *newDir,
1696                                 const YCHAR *newName, int force, int shadows)
1697 {
1698         int unlinkOp;
1699         int deleteOp;
1700
1701         yaffs_Object *existingTarget;
1702
1703         if (newDir == NULL)
1704                 newDir = obj->parent;   /* use the old directory */
1705
1706         if (newDir->variantType != YAFFS_OBJECT_TYPE_DIRECTORY) {
1707                 T(YAFFS_TRACE_ALWAYS,
1708                   (TSTR
1709                    ("tragedy: yaffs_ChangeObjectName: newDir is not a directory"
1710                     TENDSTR)));
1711                 YBUG();
1712         }
1713
1714         /* TODO: Do we need this different handling for YAFFS2 and YAFFS1?? */
1715         if (obj->myDev->param.isYaffs2)
1716                 unlinkOp = (newDir == obj->myDev->unlinkedDir);
1717         else
1718                 unlinkOp = (newDir == obj->myDev->unlinkedDir
1719                             && obj->variantType == YAFFS_OBJECT_TYPE_FILE);
1720
1721         deleteOp = (newDir == obj->myDev->deletedDir);
1722
1723         existingTarget = yaffs_FindObjectByName(newDir, newName);
1724
1725         /* If the object is a file going into the unlinked directory,
1726          *   then it is OK to just stuff it in since duplicate names are allowed.
1727          *   else only proceed if the new name does not exist and if we're putting
1728          *   it into a directory.
1729          */
1730         if ((unlinkOp ||
1731              deleteOp ||
1732              force ||
1733              (shadows > 0) ||
1734              !existingTarget) &&
1735             newDir->variantType == YAFFS_OBJECT_TYPE_DIRECTORY) {
1736                 yaffs_SetObjectName(obj, newName);
1737                 obj->dirty = 1;
1738
1739                 yaffs_AddObjectToDirectory(newDir, obj);
1740
1741                 if (unlinkOp)
1742                         obj->unlinked = 1;
1743
1744                 /* If it is a deletion then we mark it as a shrink for gc purposes. */
1745                 if (yaffs_UpdateObjectHeader(obj, newName, 0, deleteOp, shadows, NULL) >= 0)
1746                         return YAFFS_OK;
1747         }
1748
1749         return YAFFS_FAIL;
1750 }
1751
1752 int yaffs_RenameObject(yaffs_Object *oldDir, const YCHAR *oldName,
1753                 yaffs_Object *newDir, const YCHAR *newName)
1754 {
1755         yaffs_Object *obj = NULL;
1756         yaffs_Object *existingTarget = NULL;
1757         int force = 0;
1758         int result;
1759         yaffs_Device *dev;
1760
1761
1762         if (!oldDir || oldDir->variantType != YAFFS_OBJECT_TYPE_DIRECTORY)
1763                 YBUG();
1764         if (!newDir || newDir->variantType != YAFFS_OBJECT_TYPE_DIRECTORY)
1765                 YBUG();
1766
1767         dev = oldDir->myDev;
1768
1769 #ifdef CONFIG_YAFFS_CASE_INSENSITIVE
1770         /* Special case for case insemsitive systems (eg. WinCE).
1771          * While look-up is case insensitive, the name isn't.
1772          * Therefore we might want to change x.txt to X.txt
1773         */
1774         if (oldDir == newDir && yaffs_strcmp(oldName, newName) == 0)
1775                 force = 1;
1776 #endif
1777
1778         if(yaffs_strnlen(newName,YAFFS_MAX_NAME_LENGTH+1) > YAFFS_MAX_NAME_LENGTH)
1779                 /* ENAMETOOLONG */
1780                 return YAFFS_FAIL;
1781
1782         obj = yaffs_FindObjectByName(oldDir, oldName);
1783
1784         if (obj && obj->renameAllowed) {
1785
1786                 /* Now do the handling for an existing target, if there is one */
1787
1788                 existingTarget = yaffs_FindObjectByName(newDir, newName);
1789                 if (existingTarget &&
1790                         existingTarget->variantType == YAFFS_OBJECT_TYPE_DIRECTORY &&
1791                         !ylist_empty(&existingTarget->variant.directoryVariant.children)) {
1792                         /* There is a target that is a non-empty directory, so we fail */
1793                         return YAFFS_FAIL;      /* EEXIST or ENOTEMPTY */
1794                 } else if (existingTarget && existingTarget != obj) {
1795                         /* Nuke the target first, using shadowing,
1796                          * but only if it isn't the same object.
1797                          *
1798                          * Note we must disable gc otherwise it can mess up the shadowing.
1799                          *
1800                          */
1801                         dev->gcDisable=1;
1802                         yaffs_ChangeObjectName(obj, newDir, newName, force,
1803                                                 existingTarget->objectId);
1804                         existingTarget->isShadowed = 1;
1805                         yaffs_UnlinkObject(existingTarget);
1806                         dev->gcDisable=0;
1807                 }
1808
1809                 result = yaffs_ChangeObjectName(obj, newDir, newName, 1, 0);
1810
1811                 yaffs_UpdateParent(oldDir);
1812                 if(newDir != oldDir)
1813                         yaffs_UpdateParent(newDir);
1814
1815                 return result;
1816         }
1817         return YAFFS_FAIL;
1818 }
1819
1820 /*------------------------- Block Management and Page Allocation ----------------*/
1821
1822 static int yaffs_InitialiseBlocks(yaffs_Device *dev)
1823 {
1824         int nBlocks = dev->internalEndBlock - dev->internalStartBlock + 1;
1825
1826         dev->blockInfo = NULL;
1827         dev->chunkBits = NULL;
1828
1829         dev->allocationBlock = -1;      /* force it to get a new one */
1830
1831         /* If the first allocation strategy fails, thry the alternate one */
1832         dev->blockInfo = YMALLOC(nBlocks * sizeof(yaffs_BlockInfo));
1833         if (!dev->blockInfo) {
1834                 dev->blockInfo = YMALLOC_ALT(nBlocks * sizeof(yaffs_BlockInfo));
1835                 dev->blockInfoAlt = 1;
1836         } else
1837                 dev->blockInfoAlt = 0;
1838
1839         if (dev->blockInfo) {
1840                 /* Set up dynamic blockinfo stuff. */
1841                 dev->chunkBitmapStride = (dev->param.nChunksPerBlock + 7) / 8; /* round up bytes */
1842                 dev->chunkBits = YMALLOC(dev->chunkBitmapStride * nBlocks);
1843                 if (!dev->chunkBits) {
1844                         dev->chunkBits = YMALLOC_ALT(dev->chunkBitmapStride * nBlocks);
1845                         dev->chunkBitsAlt = 1;
1846                 } else
1847                         dev->chunkBitsAlt = 0;
1848         }
1849
1850         if (dev->blockInfo && dev->chunkBits) {
1851                 memset(dev->blockInfo, 0, nBlocks * sizeof(yaffs_BlockInfo));
1852                 memset(dev->chunkBits, 0, dev->chunkBitmapStride * nBlocks);
1853                 return YAFFS_OK;
1854         }
1855
1856         return YAFFS_FAIL;
1857 }
1858
1859 static void yaffs_DeinitialiseBlocks(yaffs_Device *dev)
1860 {
1861         if (dev->blockInfoAlt && dev->blockInfo)
1862                 YFREE_ALT(dev->blockInfo);
1863         else if (dev->blockInfo)
1864                 YFREE(dev->blockInfo);
1865
1866         dev->blockInfoAlt = 0;
1867
1868         dev->blockInfo = NULL;
1869
1870         if (dev->chunkBitsAlt && dev->chunkBits)
1871                 YFREE_ALT(dev->chunkBits);
1872         else if (dev->chunkBits)
1873                 YFREE(dev->chunkBits);
1874         dev->chunkBitsAlt = 0;
1875         dev->chunkBits = NULL;
1876 }
1877
1878 void yaffs_BlockBecameDirty(yaffs_Device *dev, int blockNo)
1879 {
1880         yaffs_BlockInfo *bi = yaffs_GetBlockInfo(dev, blockNo);
1881
1882         int erasedOk = 0;
1883
1884         /* If the block is still healthy erase it and mark as clean.
1885          * If the block has had a data failure, then retire it.
1886          */
1887
1888         T(YAFFS_TRACE_GC | YAFFS_TRACE_ERASE,
1889                 (TSTR("yaffs_BlockBecameDirty block %d state %d %s"TENDSTR),
1890                 blockNo, bi->blockState, (bi->needsRetiring) ? "needs retiring" : ""));
1891
1892         yaffs2_ClearOldestDirtySequence(dev,bi);
1893
1894         bi->blockState = YAFFS_BLOCK_STATE_DIRTY;
1895
1896         /* If this is the block being garbage collected then stop gc'ing this block */
1897         if(blockNo == dev->gcBlock)
1898                 dev->gcBlock = 0;
1899
1900         /* If this block is currently the best candidate for gc then drop as a candidate */
1901         if(blockNo == dev->gcDirtiest){
1902                 dev->gcDirtiest = 0;
1903                 dev->gcPagesInUse = 0;
1904         }
1905
1906         if (!bi->needsRetiring) {
1907                 yaffs2_InvalidateCheckpoint(dev);
1908                 erasedOk = yaffs_EraseBlockInNAND(dev, blockNo);
1909                 if (!erasedOk) {
1910                         dev->nErasureFailures++;
1911                         T(YAFFS_TRACE_ERROR | YAFFS_TRACE_BAD_BLOCKS,
1912                           (TSTR("**>> Erasure failed %d" TENDSTR), blockNo));
1913                 }
1914         }
1915
1916         if (erasedOk &&
1917             ((yaffs_traceMask & YAFFS_TRACE_ERASE) || !yaffs_SkipVerification(dev))) {
1918                 int i;
1919                 for (i = 0; i < dev->param.nChunksPerBlock; i++) {
1920                         if (!yaffs_CheckChunkErased
1921                             (dev, blockNo * dev->param.nChunksPerBlock + i)) {
1922                                 T(YAFFS_TRACE_ERROR,
1923                                   (TSTR
1924                                    (">>Block %d erasure supposedly OK, but chunk %d not erased"
1925                                     TENDSTR), blockNo, i));
1926                         }
1927                 }
1928         }
1929
1930         if (erasedOk) {
1931                 /* Clean it up... */
1932                 bi->blockState = YAFFS_BLOCK_STATE_EMPTY;
1933                 bi->sequenceNumber = 0;
1934                 dev->nErasedBlocks++;
1935                 bi->pagesInUse = 0;
1936                 bi->softDeletions = 0;
1937                 bi->hasShrinkHeader = 0;
1938                 bi->skipErasedCheck = 1;  /* This is clean, so no need to check */
1939                 bi->gcPrioritise = 0;
1940                 yaffs_ClearChunkBits(dev, blockNo);
1941
1942                 T(YAFFS_TRACE_ERASE,
1943                   (TSTR("Erased block %d" TENDSTR), blockNo));
1944         } else {
1945                 dev->nFreeChunks -= dev->param.nChunksPerBlock; /* We lost a block of free space */
1946
1947                 yaffs_RetireBlock(dev, blockNo);
1948                 T(YAFFS_TRACE_ERROR | YAFFS_TRACE_BAD_BLOCKS,
1949                   (TSTR("**>> Block %d retired" TENDSTR), blockNo));
1950         }
1951 }
1952
1953 static int yaffs_FindBlockForAllocation(yaffs_Device *dev)
1954 {
1955         int i;
1956
1957         yaffs_BlockInfo *bi;
1958
1959         if (dev->nErasedBlocks < 1) {
1960                 /* Hoosterman we've got a problem.
1961                  * Can't get space to gc
1962                  */
1963                 T(YAFFS_TRACE_ERROR,
1964                   (TSTR("yaffs tragedy: no more erased blocks" TENDSTR)));
1965
1966                 return -1;
1967         }
1968
1969         /* Find an empty block. */
1970
1971         for (i = dev->internalStartBlock; i <= dev->internalEndBlock; i++) {
1972                 dev->allocationBlockFinder++;
1973                 if (dev->allocationBlockFinder < dev->internalStartBlock
1974                     || dev->allocationBlockFinder > dev->internalEndBlock) {
1975                         dev->allocationBlockFinder = dev->internalStartBlock;
1976                 }
1977
1978                 bi = yaffs_GetBlockInfo(dev, dev->allocationBlockFinder);
1979
1980                 if (bi->blockState == YAFFS_BLOCK_STATE_EMPTY) {
1981                         bi->blockState = YAFFS_BLOCK_STATE_ALLOCATING;
1982                         dev->sequenceNumber++;
1983                         bi->sequenceNumber = dev->sequenceNumber;
1984                         dev->nErasedBlocks--;
1985                         T(YAFFS_TRACE_ALLOCATE,
1986                           (TSTR("Allocated block %d, seq  %d, %d left" TENDSTR),
1987                            dev->allocationBlockFinder, dev->sequenceNumber,
1988                            dev->nErasedBlocks));
1989                         return dev->allocationBlockFinder;
1990                 }
1991         }
1992
1993         T(YAFFS_TRACE_ALWAYS,
1994           (TSTR
1995            ("yaffs tragedy: no more erased blocks, but there should have been %d"
1996             TENDSTR), dev->nErasedBlocks));
1997
1998         return -1;
1999 }
2000
2001
2002 /*
2003  * Check if there's space to allocate...
2004  * Thinks.... do we need top make this ths same as yaffs_GetFreeChunks()?
2005  */
2006 int yaffs_CheckSpaceForAllocation(yaffs_Device *dev, int nChunks)
2007 {
2008         int reservedChunks;
2009         int reservedBlocks = dev->param.nReservedBlocks;
2010         int checkpointBlocks;
2011
2012         checkpointBlocks = yaffs2_CalcCheckpointBlocksRequired(dev);
2013
2014         reservedChunks = ((reservedBlocks + checkpointBlocks) * dev->param.nChunksPerBlock);
2015
2016         return (dev->nFreeChunks > (reservedChunks + nChunks));
2017 }
2018
2019 static int yaffs_AllocateChunk(yaffs_Device *dev, int useReserve,
2020                 yaffs_BlockInfo **blockUsedPtr)
2021 {
2022         int retVal;
2023         yaffs_BlockInfo *bi;
2024
2025         if (dev->allocationBlock < 0) {
2026                 /* Get next block to allocate off */
2027                 dev->allocationBlock = yaffs_FindBlockForAllocation(dev);
2028                 dev->allocationPage = 0;
2029         }
2030
2031         if (!useReserve && !yaffs_CheckSpaceForAllocation(dev, 1)) {
2032                 /* Not enough space to allocate unless we're allowed to use the reserve. */
2033                 return -1;
2034         }
2035
2036         if (dev->nErasedBlocks < dev->param.nReservedBlocks
2037                         && dev->allocationPage == 0) {
2038                 T(YAFFS_TRACE_ALLOCATE, (TSTR("Allocating reserve" TENDSTR)));
2039         }
2040
2041         /* Next page please.... */
2042         if (dev->allocationBlock >= 0) {
2043                 bi = yaffs_GetBlockInfo(dev, dev->allocationBlock);
2044
2045                 retVal = (dev->allocationBlock * dev->param.nChunksPerBlock) +
2046                         dev->allocationPage;
2047                 bi->pagesInUse++;
2048                 yaffs_SetChunkBit(dev, dev->allocationBlock,
2049                                 dev->allocationPage);
2050
2051                 dev->allocationPage++;
2052
2053                 dev->nFreeChunks--;
2054
2055                 /* If the block is full set the state to full */
2056                 if (dev->allocationPage >= dev->param.nChunksPerBlock) {
2057                         bi->blockState = YAFFS_BLOCK_STATE_FULL;
2058                         dev->allocationBlock = -1;
2059                 }
2060
2061                 if (blockUsedPtr)
2062                         *blockUsedPtr = bi;
2063
2064                 return retVal;
2065         }
2066
2067         T(YAFFS_TRACE_ERROR,
2068                         (TSTR("!!!!!!!!! Allocator out !!!!!!!!!!!!!!!!!" TENDSTR)));
2069
2070         return -1;
2071 }
2072
2073 static int yaffs_GetErasedChunks(yaffs_Device *dev)
2074 {
2075         int n;
2076
2077         n = dev->nErasedBlocks * dev->param.nChunksPerBlock;
2078
2079         if (dev->allocationBlock > 0)
2080                 n += (dev->param.nChunksPerBlock - dev->allocationPage);
2081
2082         return n;
2083
2084 }
2085
2086 /*
2087  * yaffs_SkipRestOfBlock() skips over the rest of the allocation block
2088  * if we don't want to write to it.
2089  */
2090 void yaffs_SkipRestOfBlock(yaffs_Device *dev)
2091 {
2092         if(dev->allocationBlock > 0){
2093                 yaffs_BlockInfo *bi = yaffs_GetBlockInfo(dev, dev->allocationBlock);
2094                 if(bi->blockState == YAFFS_BLOCK_STATE_ALLOCATING){
2095                         bi->blockState = YAFFS_BLOCK_STATE_FULL;
2096                         dev->allocationBlock = -1;
2097                 }
2098         }
2099 }
2100
2101
2102 static int yaffs_GarbageCollectBlock(yaffs_Device *dev, int block,
2103                 int wholeBlock)
2104 {
2105         int oldChunk;
2106         int newChunk;
2107         int markNAND;
2108         int retVal = YAFFS_OK;
2109         int i;
2110         int isCheckpointBlock;
2111         int matchingChunk;
2112         int maxCopies;
2113
2114         int chunksBefore = yaffs_GetErasedChunks(dev);
2115         int chunksAfter;
2116
2117         yaffs_ExtendedTags tags;
2118
2119         yaffs_BlockInfo *bi = yaffs_GetBlockInfo(dev, block);
2120
2121         yaffs_Object *object;
2122
2123         isCheckpointBlock = (bi->blockState == YAFFS_BLOCK_STATE_CHECKPOINT);
2124
2125
2126         T(YAFFS_TRACE_TRACING,
2127                         (TSTR("Collecting block %d, in use %d, shrink %d, wholeBlock %d" TENDSTR),
2128                          block,
2129                          bi->pagesInUse,
2130                          bi->hasShrinkHeader,
2131                          wholeBlock));
2132
2133         /*yaffs_VerifyFreeChunks(dev); */
2134
2135         if(bi->blockState == YAFFS_BLOCK_STATE_FULL)
2136                 bi->blockState = YAFFS_BLOCK_STATE_COLLECTING;
2137
2138         bi->hasShrinkHeader = 0;        /* clear the flag so that the block can erase */
2139
2140         dev->gcDisable = 1;
2141
2142         if (isCheckpointBlock ||
2143                         !yaffs_StillSomeChunkBits(dev, block)) {
2144                 T(YAFFS_TRACE_TRACING,
2145                                 (TSTR
2146                                  ("Collecting block %d that has no chunks in use" TENDSTR),
2147                                  block));
2148                 yaffs_BlockBecameDirty(dev, block);
2149         } else {
2150
2151                 __u8 *buffer = yaffs_GetTempBuffer(dev, __LINE__);
2152
2153                 yaffs_VerifyBlock(dev, bi, block);
2154
2155                 maxCopies = (wholeBlock) ? dev->param.nChunksPerBlock : 5;
2156                 oldChunk = block * dev->param.nChunksPerBlock + dev->gcChunk;
2157
2158                 for (/* init already done */;
2159                      retVal == YAFFS_OK &&
2160                      dev->gcChunk < dev->param.nChunksPerBlock &&
2161                      (bi->blockState == YAFFS_BLOCK_STATE_COLLECTING) &&
2162                      maxCopies > 0;
2163                      dev->gcChunk++, oldChunk++) {
2164                         if (yaffs_CheckChunkBit(dev, block, dev->gcChunk)) {
2165
2166                                 /* This page is in use and might need to be copied off */
2167
2168                                 maxCopies--;
2169
2170                                 markNAND = 1;
2171
2172                                 yaffs_InitialiseTags(&tags);
2173
2174                                 yaffs_ReadChunkWithTagsFromNAND(dev, oldChunk,
2175                                                                 buffer, &tags);
2176
2177                                 object =
2178                                     yaffs_FindObjectByNumber(dev,
2179                                                              tags.objectId);
2180
2181                                 T(YAFFS_TRACE_GC_DETAIL,
2182                                   (TSTR
2183                                    ("Collecting chunk in block %d, %d %d %d " TENDSTR),
2184                                    dev->gcChunk, tags.objectId, tags.chunkId,
2185                                    tags.byteCount));
2186
2187                                 if (object && !yaffs_SkipVerification(dev)) {
2188                                         if (tags.chunkId == 0)
2189                                                 matchingChunk = object->hdrChunk;
2190                                         else if (object->softDeleted)
2191                                                 matchingChunk = oldChunk; /* Defeat the test */
2192                                         else
2193                                                 matchingChunk = yaffs_FindChunkInFile(object, tags.chunkId, NULL);
2194
2195                                         if (oldChunk != matchingChunk)
2196                                                 T(YAFFS_TRACE_ERROR,
2197                                                   (TSTR("gc: page in gc mismatch: %d %d %d %d"TENDSTR),
2198                                                   oldChunk, matchingChunk, tags.objectId, tags.chunkId));
2199
2200                                 }
2201
2202                                 if (!object) {
2203                                         T(YAFFS_TRACE_ERROR,
2204                                           (TSTR
2205                                            ("page %d in gc has no object: %d %d %d "
2206                                             TENDSTR), oldChunk,
2207                                             tags.objectId, tags.chunkId, tags.byteCount));
2208                                 }
2209
2210                                 if (object &&
2211                                     object->deleted &&
2212                                     object->softDeleted &&
2213                                     tags.chunkId != 0) {
2214                                         /* Data chunk in a soft deleted file, throw it away
2215                                          * It's a soft deleted data chunk,
2216                                          * No need to copy this, just forget about it and
2217                                          * fix up the object.
2218                                          */
2219
2220                                         /* Free chunks already includes softdeleted chunks.
2221                                          * How ever this chunk is going to soon be really deleted
2222                                          * which will increment free chunks.
2223                                          * We have to decrement free chunks so this works out properly.
2224                                          */
2225                                         dev->nFreeChunks--;
2226                                         bi->softDeletions--;
2227
2228                                         object->nDataChunks--;
2229
2230                                         if (object->nDataChunks <= 0) {
2231                                                 /* remeber to clean up the object */
2232                                                 dev->gcCleanupList[dev->nCleanups] =
2233                                                     tags.objectId;
2234                                                 dev->nCleanups++;
2235                                         }
2236                                         markNAND = 0;
2237                                 } else if (0) {
2238                                         /* Todo object && object->deleted && object->nDataChunks == 0 */
2239                                         /* Deleted object header with no data chunks.
2240                                          * Can be discarded and the file deleted.
2241                                          */
2242                                         object->hdrChunk = 0;
2243                                         yaffs_FreeTnode(object->myDev,
2244                                                         object->variant.
2245                                                         fileVariant.top);
2246                                         object->variant.fileVariant.top = NULL;
2247                                         yaffs_DoGenericObjectDeletion(object);
2248
2249                                 } else if (object) {
2250                                         /* It's either a data chunk in a live file or
2251                                          * an ObjectHeader, so we're interested in it.
2252                                          * NB Need to keep the ObjectHeaders of deleted files
2253                                          * until the whole file has been deleted off
2254                                          */
2255                                         tags.serialNumber++;
2256
2257                                         dev->nGCCopies++;
2258
2259                                         if (tags.chunkId == 0) {
2260                                                 /* It is an object Id,
2261                                                  * We need to nuke the shrinkheader flags first
2262                                                  * Also need to clean up shadowing.
2263                                                  * We no longer want the shrinkHeader flag since its work is done
2264                                                  * and if it is left in place it will mess up scanning.
2265                                                  */
2266
2267                                                 yaffs_ObjectHeader *oh;
2268                                                 oh = (yaffs_ObjectHeader *)buffer;
2269
2270                                                 oh->isShrink = 0;
2271                                                 tags.extraIsShrinkHeader = 0;
2272
2273                                                 oh->shadowsObject = 0;
2274                                                 oh->inbandShadowsObject = 0;
2275                                                 tags.extraShadows = 0;
2276
2277                                                 /* Update file size */
2278                                                 if(object->variantType == YAFFS_OBJECT_TYPE_FILE){
2279                                                         oh->fileSize = object->variant.fileVariant.fileSize;
2280                                                         tags.extraFileLength = oh->fileSize;
2281                                                 }
2282
2283                                                 yaffs_VerifyObjectHeader(object, oh, &tags, 1);
2284                                                 newChunk =
2285                                                     yaffs_WriteNewChunkWithTagsToNAND(dev,(__u8 *) oh, &tags, 1);
2286                                         } else
2287                                                 newChunk =
2288                                                     yaffs_WriteNewChunkWithTagsToNAND(dev, buffer, &tags, 1);
2289
2290                                         if (newChunk < 0) {
2291                                                 retVal = YAFFS_FAIL;
2292                                         } else {
2293
2294                                                 /* Ok, now fix up the Tnodes etc. */
2295
2296                                                 if (tags.chunkId == 0) {
2297                                                         /* It's a header */
2298                                                         object->hdrChunk =  newChunk;
2299                                                         object->serial =   tags.serialNumber;
2300                                                 } else {
2301                                                         /* It's a data chunk */
2302                                                         int ok;
2303                                                         ok = yaffs_PutChunkIntoFile
2304                                                             (object,
2305                                                              tags.chunkId,
2306                                                              newChunk, 0);
2307                                                 }
2308                                         }
2309                                 }
2310
2311                                 if (retVal == YAFFS_OK)
2312                                         yaffs_DeleteChunk(dev, oldChunk, markNAND, __LINE__);
2313
2314                         }
2315                 }
2316
2317                 yaffs_ReleaseTempBuffer(dev, buffer, __LINE__);
2318
2319
2320
2321         }
2322
2323         yaffs_VerifyCollectedBlock(dev, bi, block);
2324
2325
2326
2327         if (bi->blockState == YAFFS_BLOCK_STATE_COLLECTING) {
2328                 /*
2329                  * The gc did not complete. Set block state back to FULL
2330                  * because checkpointing does not restore gc.
2331                  */
2332                 bi->blockState = YAFFS_BLOCK_STATE_FULL;
2333         } else {
2334                 /* The gc completed. */
2335                 /* Do any required cleanups */
2336                 for (i = 0; i < dev->nCleanups; i++) {
2337                         /* Time to delete the file too */
2338                         object =
2339                             yaffs_FindObjectByNumber(dev,
2340                                                      dev->gcCleanupList[i]);
2341                         if (object) {
2342                                 yaffs_FreeTnode(dev,
2343                                                 object->variant.fileVariant.
2344                                                 top);
2345                                 object->variant.fileVariant.top = NULL;
2346                                 T(YAFFS_TRACE_GC,
2347                                   (TSTR
2348                                    ("yaffs: About to finally delete object %d"
2349                                     TENDSTR), object->objectId));
2350                                 yaffs_DoGenericObjectDeletion(object);
2351                                 object->myDev->nDeletedFiles--;
2352                         }
2353
2354                 }
2355
2356
2357                 chunksAfter = yaffs_GetErasedChunks(dev);
2358                 if (chunksBefore >= chunksAfter) {
2359                         T(YAFFS_TRACE_GC,
2360                           (TSTR
2361                            ("gc did not increase free chunks before %d after %d"
2362                             TENDSTR), chunksBefore, chunksAfter));
2363                 }
2364                 dev->gcBlock = 0;
2365                 dev->gcChunk = 0;
2366                 dev->nCleanups = 0;
2367         }
2368
2369         dev->gcDisable = 0;
2370
2371         return retVal;
2372 }
2373
2374 /*
2375  * FindBlockForgarbageCollection is used to select the dirtiest block (or close enough)
2376  * for garbage collection.
2377  */
2378
2379 static unsigned yaffs_FindBlockForGarbageCollection(yaffs_Device *dev,
2380                                         int aggressive,
2381                                         int background)
2382 {
2383         int i;
2384         int iterations;
2385         unsigned selected = 0;
2386         int prioritised = 0;
2387         int prioritisedExists = 0;
2388         yaffs_BlockInfo *bi;
2389         int threshold;
2390
2391         /* First let's see if we need to grab a prioritised block */
2392         if (dev->hasPendingPrioritisedGCs && !aggressive) {
2393                 dev->gcDirtiest = 0;
2394                 bi = dev->blockInfo;
2395                 for (i = dev->internalStartBlock;
2396                         i <= dev->internalEndBlock && !selected;
2397                         i++) {
2398
2399                         if (bi->gcPrioritise) {
2400                                 prioritisedExists = 1;
2401                                 if (bi->blockState == YAFFS_BLOCK_STATE_FULL &&
2402                                    yaffs2_BlockNotDisqualifiedFromGC(dev, bi)) {
2403                                         selected = i;
2404                                         prioritised = 1;
2405                                 }
2406                         }
2407                         bi++;
2408                 }
2409
2410                 /*
2411                  * If there is a prioritised block and none was selected then
2412                  * this happened because there is at least one old dirty block gumming
2413                  * up the works. Let's gc the oldest dirty block.
2414                  */
2415
2416                 if(prioritisedExists &&
2417                         !selected &&
2418                         dev->oldestDirtyBlock > 0)
2419                         selected = dev->oldestDirtyBlock;
2420
2421                 if (!prioritisedExists) /* None found, so we can clear this */
2422                         dev->hasPendingPrioritisedGCs = 0;
2423         }
2424
2425         /* If we're doing aggressive GC then we are happy to take a less-dirty block, and
2426          * search harder.
2427          * else (we're doing a leasurely gc), then we only bother to do this if the
2428          * block has only a few pages in use.
2429          */
2430
2431         if (!selected){
2432                 int pagesUsed;
2433                 int nBlocks = dev->internalEndBlock - dev->internalStartBlock + 1;
2434                 if (aggressive){
2435                         threshold = dev->param.nChunksPerBlock;
2436                         iterations = nBlocks;
2437                 } else {
2438                         int maxThreshold = dev->param.nChunksPerBlock/2;
2439                         threshold = background ?
2440                                 (dev->gcNotDone + 2) * 2 : 0;
2441                         if(threshold <YAFFS_GC_PASSIVE_THRESHOLD)
2442                                 threshold = YAFFS_GC_PASSIVE_THRESHOLD;
2443                         if(threshold > maxThreshold)
2444                                 threshold = maxThreshold;
2445
2446                         iterations = nBlocks / 16 + 1;
2447                         if (iterations > 100)
2448                                 iterations = 100;
2449                 }
2450
2451                 for (i = 0;
2452                         i < iterations &&
2453                         (dev->gcDirtiest < 1 ||
2454                                 dev->gcPagesInUse > YAFFS_GC_GOOD_ENOUGH);
2455                         i++) {
2456                         dev->gcBlockFinder++;
2457                         if (dev->gcBlockFinder < dev->internalStartBlock ||
2458                                 dev->gcBlockFinder > dev->internalEndBlock)
2459                                 dev->gcBlockFinder = dev->internalStartBlock;
2460
2461                         bi = yaffs_GetBlockInfo(dev, dev->gcBlockFinder);
2462
2463                         pagesUsed = bi->pagesInUse - bi->softDeletions;
2464
2465                         if (bi->blockState == YAFFS_BLOCK_STATE_FULL &&
2466                                 pagesUsed < dev->param.nChunksPerBlock &&
2467                                 (dev->gcDirtiest < 1 || pagesUsed < dev->gcPagesInUse) &&
2468                                 yaffs2_BlockNotDisqualifiedFromGC(dev, bi)) {
2469                                 dev->gcDirtiest = dev->gcBlockFinder;
2470                                 dev->gcPagesInUse = pagesUsed;
2471                         }
2472                 }
2473
2474                 if(dev->gcDirtiest > 0 && dev->gcPagesInUse <= threshold)
2475                         selected = dev->gcDirtiest;
2476         }
2477
2478         /*
2479          * If nothing has been selected for a while, try selecting the oldest dirty
2480          * because that's gumming up the works.
2481          */
2482
2483         if(!selected && dev->param.isYaffs2 &&
2484                 dev->gcNotDone >= ( background ? 10 : 20)){
2485                 yaffs2_FindOldestDirtySequence(dev);
2486                 if(dev->oldestDirtyBlock > 0) {
2487                         selected = dev->oldestDirtyBlock;
2488                         dev->gcDirtiest = selected;
2489                         dev->oldestDirtyGCs++;
2490                         bi = yaffs_GetBlockInfo(dev, selected);
2491                         dev->gcPagesInUse =  bi->pagesInUse - bi->softDeletions;
2492                 } else
2493                         dev->gcNotDone = 0;
2494         }
2495
2496         if(selected){
2497                 T(YAFFS_TRACE_GC,
2498                   (TSTR("GC Selected block %d with %d free, prioritised:%d" TENDSTR),
2499                   selected,
2500                   dev->param.nChunksPerBlock - dev->gcPagesInUse,
2501                   prioritised));
2502
2503                 dev->nGCBlocks++;
2504                 if(background)
2505                         dev->backgroundGCs++;
2506
2507                 dev->gcDirtiest = 0;
2508                 dev->gcPagesInUse = 0;
2509                 dev->gcNotDone = 0;
2510                 if(dev->refreshSkip > 0)
2511                         dev->refreshSkip--;
2512         } else{
2513                 dev->gcNotDone++;
2514                 T(YAFFS_TRACE_GC,
2515                   (TSTR("GC none: finder %d skip %d threshold %d dirtiest %d using %d oldest %d%s" TENDSTR),
2516                   dev->gcBlockFinder, dev->gcNotDone,
2517                   threshold,
2518                   dev->gcDirtiest, dev->gcPagesInUse,
2519                   dev->oldestDirtyBlock,
2520                   background ? " bg" : ""));
2521         }
2522
2523         return selected;
2524 }
2525
2526 /* New garbage collector
2527  * If we're very low on erased blocks then we do aggressive garbage collection
2528  * otherwise we do "leasurely" garbage collection.
2529  * Aggressive gc looks further (whole array) and will accept less dirty blocks.
2530  * Passive gc only inspects smaller areas and will only accept more dirty blocks.
2531  *
2532  * The idea is to help clear out space in a more spread-out manner.
2533  * Dunno if it really does anything useful.
2534  */
2535 static int yaffs_CheckGarbageCollection(yaffs_Device *dev, int background)
2536 {
2537         int aggressive = 0;
2538         int gcOk = YAFFS_OK;
2539         int maxTries = 0;
2540
2541         int minErased;
2542         int erasedChunks;
2543
2544         int checkpointBlockAdjust;
2545
2546         if(dev->param.gcControl &&
2547                 (dev->param.gcControl(dev) & 1) == 0)
2548                 return YAFFS_OK;
2549
2550         if (dev->gcDisable) {
2551                 /* Bail out so we don't get recursive gc */
2552                 return YAFFS_OK;
2553         }
2554
2555         /* This loop should pass the first time.
2556          * We'll only see looping here if the collection does not increase space.
2557          */
2558
2559         do {
2560                 maxTries++;
2561
2562                 checkpointBlockAdjust = yaffs2_CalcCheckpointBlocksRequired(dev);
2563
2564                 minErased  = dev->param.nReservedBlocks + checkpointBlockAdjust + 1;
2565                 erasedChunks = dev->nErasedBlocks * dev->param.nChunksPerBlock;
2566
2567                 /* If we need a block soon then do aggressive gc.*/
2568                 if (dev->nErasedBlocks < minErased)
2569                         aggressive = 1;
2570                 else {
2571                         if(dev->gcSkip > 20)
2572                                 dev->gcSkip = 20;
2573                         if(erasedChunks < dev->nFreeChunks/2 ||
2574                                 dev->gcSkip < 1 ||
2575                                 background)
2576                                 aggressive = 0;
2577                         else {
2578                                 dev->gcSkip--;
2579                                 break;
2580                         }
2581                 }
2582
2583                 dev->gcSkip = 5;
2584
2585                 /* If we don't already have a block being gc'd then see if we should start another */
2586
2587                 if (dev->gcBlock < 1 && !aggressive) {
2588                         dev->gcBlock = yaffs2_FindRefreshBlock(dev);
2589                         dev->gcChunk = 0;
2590                         dev->nCleanups=0;
2591                 }
2592                 if (dev->gcBlock < 1) {
2593                         dev->gcBlock = yaffs_FindBlockForGarbageCollection(dev, aggressive, background);
2594                         dev->gcChunk = 0;
2595                         dev->nCleanups=0;
2596                 }
2597
2598                 if (dev->gcBlock > 0) {
2599                         dev->allGCs++;
2600                         if (!aggressive)
2601                                 dev->passiveGCs++;
2602
2603                         T(YAFFS_TRACE_GC,
2604                           (TSTR
2605                            ("yaffs: GC erasedBlocks %d aggressive %d" TENDSTR),
2606                            dev->nErasedBlocks, aggressive));
2607
2608                         gcOk = yaffs_GarbageCollectBlock(dev, dev->gcBlock, aggressive);
2609                 }
2610
2611                 if (dev->nErasedBlocks < (dev->param.nReservedBlocks) && dev->gcBlock > 0) {
2612                         T(YAFFS_TRACE_GC,
2613                           (TSTR
2614                            ("yaffs: GC !!!no reclaim!!! erasedBlocks %d after try %d block %d"
2615                             TENDSTR), dev->nErasedBlocks, maxTries, dev->gcBlock));
2616                 }
2617         } while ((dev->nErasedBlocks < dev->param.nReservedBlocks) &&
2618                  (dev->gcBlock > 0) &&
2619                  (maxTries < 2));
2620
2621         return aggressive ? gcOk : YAFFS_OK;
2622 }
2623
2624 /*
2625  * yaffs_BackgroundGarbageCollect()
2626  * Garbage collects. Intended to be called from a background thread.
2627  * Returns non-zero if at least half the free chunks are erased.
2628  */
2629 int yaffs_BackgroundGarbageCollect(yaffs_Device *dev, unsigned urgency)
2630 {
2631         int erasedChunks = dev->nErasedBlocks * dev->param.nChunksPerBlock;
2632
2633         T(YAFFS_TRACE_BACKGROUND, (TSTR("Background gc %u" TENDSTR),urgency));
2634
2635         yaffs_CheckGarbageCollection(dev, 1);
2636         return erasedChunks > dev->nFreeChunks/2;
2637 }
2638
2639 /*-------------------------  TAGS --------------------------------*/
2640
2641 static int yaffs_TagsMatch(const yaffs_ExtendedTags *tags, int objectId,
2642                            int chunkInObject)
2643 {
2644         return (tags->chunkId == chunkInObject &&
2645                 tags->objectId == objectId && !tags->chunkDeleted) ? 1 : 0;
2646
2647 }
2648
2649
2650 /*-------------------- Data file manipulation -----------------*/
2651
2652 static int yaffs_FindChunkInFile(yaffs_Object *in, int chunkInInode,
2653                                  yaffs_ExtendedTags *tags)
2654 {
2655         /*Get the Tnode, then get the level 0 offset chunk offset */
2656         yaffs_Tnode *tn;
2657         int theChunk = -1;
2658         yaffs_ExtendedTags localTags;
2659         int retVal = -1;
2660
2661         yaffs_Device *dev = in->myDev;
2662
2663         if (!tags) {
2664                 /* Passed a NULL, so use our own tags space */
2665                 tags = &localTags;
2666         }
2667
2668         tn = yaffs_FindLevel0Tnode(dev, &in->variant.fileVariant, chunkInInode);
2669
2670         if (tn) {
2671                 theChunk = yaffs_GetChunkGroupBase(dev, tn, chunkInInode);
2672
2673                 retVal =
2674                     yaffs_FindChunkInGroup(dev, theChunk, tags, in->objectId,
2675                                            chunkInInode);
2676         }
2677         return retVal;
2678 }
2679
2680 static int yaffs_FindAndDeleteChunkInFile(yaffs_Object *in, int chunkInInode,
2681                                           yaffs_ExtendedTags *tags)
2682 {
2683         /* Get the Tnode, then get the level 0 offset chunk offset */
2684         yaffs_Tnode *tn;
2685         int theChunk = -1;
2686         yaffs_ExtendedTags localTags;
2687
2688         yaffs_Device *dev = in->myDev;
2689         int retVal = -1;
2690
2691         if (!tags) {
2692                 /* Passed a NULL, so use our own tags space */
2693                 tags = &localTags;
2694         }
2695
2696         tn = yaffs_FindLevel0Tnode(dev, &in->variant.fileVariant, chunkInInode);
2697
2698         if (tn) {
2699
2700                 theChunk = yaffs_GetChunkGroupBase(dev, tn, chunkInInode);
2701
2702                 retVal =
2703                     yaffs_FindChunkInGroup(dev, theChunk, tags, in->objectId,
2704                                            chunkInInode);
2705
2706                 /* Delete the entry in the filestructure (if found) */
2707                 if (retVal != -1)
2708                         yaffs_LoadLevel0Tnode(dev, tn, chunkInInode, 0);
2709         }
2710
2711         return retVal;
2712 }
2713
2714
2715 int yaffs_PutChunkIntoFile(yaffs_Object *in, int chunkInInode,
2716                                 int chunkInNAND, int inScan)
2717 {
2718         /* NB inScan is zero unless scanning.
2719          * For forward scanning, inScan is > 0;
2720          * for backward scanning inScan is < 0
2721          *
2722          * chunkInNAND = 0 is a dummy insert to make sure the tnodes are there.
2723          */
2724
2725         yaffs_Tnode *tn;
2726         yaffs_Device *dev = in->myDev;
2727         int existingChunk;
2728         yaffs_ExtendedTags existingTags;
2729         yaffs_ExtendedTags newTags;
2730         unsigned existingSerial, newSerial;
2731
2732         if (in->variantType != YAFFS_OBJECT_TYPE_FILE) {
2733                 /* Just ignore an attempt at putting a chunk into a non-file during scanning
2734                  * If it is not during Scanning then something went wrong!
2735                  */
2736                 if (!inScan) {
2737                         T(YAFFS_TRACE_ERROR,
2738                           (TSTR
2739                            ("yaffs tragedy:attempt to put data chunk into a non-file"
2740                             TENDSTR)));
2741                         YBUG();
2742                 }
2743
2744                 yaffs_DeleteChunk(dev, chunkInNAND, 1, __LINE__);
2745                 return YAFFS_OK;
2746         }
2747
2748         tn = yaffs_AddOrFindLevel0Tnode(dev,
2749                                         &in->variant.fileVariant,
2750                                         chunkInInode,
2751                                         NULL);
2752         if (!tn)
2753                 return YAFFS_FAIL;
2754
2755         if(!chunkInNAND)
2756                 /* Dummy insert, bail now */
2757                 return YAFFS_OK;
2758
2759         existingChunk = yaffs_GetChunkGroupBase(dev, tn, chunkInInode);
2760
2761         if (inScan != 0) {
2762                 /* If we're scanning then we need to test for duplicates
2763                  * NB This does not need to be efficient since it should only ever
2764                  * happen when the power fails during a write, then only one
2765                  * chunk should ever be affected.
2766                  *
2767                  * Correction for YAFFS2: This could happen quite a lot and we need to think about efficiency! TODO
2768                  * Update: For backward scanning we don't need to re-read tags so this is quite cheap.
2769                  */
2770
2771                 if (existingChunk > 0) {
2772                         /* NB Right now existing chunk will not be real chunkId if the chunk group size > 1
2773                          *    thus we have to do a FindChunkInFile to get the real chunk id.
2774                          *
2775                          * We have a duplicate now we need to decide which one to use:
2776                          *
2777                          * Backwards scanning YAFFS2: The old one is what we use, dump the new one.
2778                          * Forward scanning YAFFS2: The new one is what we use, dump the old one.
2779                          * YAFFS1: Get both sets of tags and compare serial numbers.
2780                          */
2781
2782                         if (inScan > 0) {
2783                                 /* Only do this for forward scanning */
2784                                 yaffs_ReadChunkWithTagsFromNAND(dev,
2785                                                                 chunkInNAND,
2786                                                                 NULL, &newTags);
2787
2788                                 /* Do a proper find */
2789                                 existingChunk =
2790                                     yaffs_FindChunkInFile(in, chunkInInode,
2791                                                           &existingTags);
2792                         }
2793
2794                         if (existingChunk <= 0) {
2795                                 /*Hoosterman - how did this happen? */
2796
2797                                 T(YAFFS_TRACE_ERROR,
2798                                   (TSTR
2799                                    ("yaffs tragedy: existing chunk < 0 in scan"
2800                                     TENDSTR)));
2801
2802                         }
2803
2804                         /* NB The deleted flags should be false, otherwise the chunks will
2805                          * not be loaded during a scan
2806                          */
2807
2808                         if (inScan > 0) {
2809                                 newSerial = newTags.serialNumber;
2810                                 existingSerial = existingTags.serialNumber;
2811                         }
2812
2813                         if ((inScan > 0) &&
2814                             (existingChunk <= 0 ||
2815                              ((existingSerial + 1) & 3) == newSerial)) {
2816                                 /* Forward scanning.
2817                                  * Use new
2818                                  * Delete the old one and drop through to update the tnode
2819                                  */
2820                                 yaffs_DeleteChunk(dev, existingChunk, 1,
2821                                                   __LINE__);
2822                         } else {
2823                                 /* Backward scanning or we want to use the existing one
2824                                  * Use existing.
2825                                  * Delete the new one and return early so that the tnode isn't changed
2826                                  */
2827                                 yaffs_DeleteChunk(dev, chunkInNAND, 1,
2828                                                   __LINE__);
2829                                 return YAFFS_OK;
2830                         }
2831                 }
2832
2833         }
2834
2835         if (existingChunk == 0)
2836                 in->nDataChunks++;
2837
2838         yaffs_LoadLevel0Tnode(dev, tn, chunkInInode, chunkInNAND);
2839
2840         return YAFFS_OK;
2841 }
2842
2843 static int yaffs_ReadChunkDataFromObject(yaffs_Object *in, int chunkInInode,
2844                                         __u8 *buffer)
2845 {
2846         int chunkInNAND = yaffs_FindChunkInFile(in, chunkInInode, NULL);
2847
2848         if (chunkInNAND >= 0)
2849                 return yaffs_ReadChunkWithTagsFromNAND(in->myDev, chunkInNAND,
2850                                                 buffer, NULL);
2851         else {
2852                 T(YAFFS_TRACE_NANDACCESS,
2853                   (TSTR("Chunk %d not found zero instead" TENDSTR),
2854                    chunkInNAND));
2855                 /* get sane (zero) data if you read a hole */
2856                 memset(buffer, 0, in->myDev->nDataBytesPerChunk);
2857                 return 0;
2858         }
2859
2860 }
2861
2862 void yaffs_DeleteChunk(yaffs_Device *dev, int chunkId, int markNAND, int lyn)
2863 {
2864         int block;
2865         int page;
2866         yaffs_ExtendedTags tags;
2867         yaffs_BlockInfo *bi;
2868
2869         if (chunkId <= 0)
2870                 return;
2871
2872         dev->nDeletions++;
2873         block = chunkId / dev->param.nChunksPerBlock;
2874         page = chunkId % dev->param.nChunksPerBlock;
2875
2876
2877         if (!yaffs_CheckChunkBit(dev, block, page))
2878                 T(YAFFS_TRACE_VERIFY,
2879                         (TSTR("Deleting invalid chunk %d"TENDSTR),
2880                          chunkId));
2881
2882         bi = yaffs_GetBlockInfo(dev, block);
2883
2884         yaffs2_UpdateOldestDirtySequence(dev, block, bi);
2885
2886         T(YAFFS_TRACE_DELETION,
2887           (TSTR("line %d delete of chunk %d" TENDSTR), lyn, chunkId));
2888
2889         if (!dev->param.isYaffs2 && markNAND &&
2890             bi->blockState != YAFFS_BLOCK_STATE_COLLECTING) {
2891
2892                 yaffs_InitialiseTags(&tags);
2893
2894                 tags.chunkDeleted = 1;
2895
2896                 yaffs_WriteChunkWithTagsToNAND(dev, chunkId, NULL, &tags);
2897                 yaffs_HandleUpdateChunk(dev, chunkId, &tags);
2898         } else {
2899                 dev->nUnmarkedDeletions++;
2900         }
2901
2902         /* Pull out of the management area.
2903          * If the whole block became dirty, this will kick off an erasure.
2904          */
2905         if (bi->blockState == YAFFS_BLOCK_STATE_ALLOCATING ||
2906             bi->blockState == YAFFS_BLOCK_STATE_FULL ||
2907             bi->blockState == YAFFS_BLOCK_STATE_NEEDS_SCANNING ||
2908             bi->blockState == YAFFS_BLOCK_STATE_COLLECTING) {
2909                 dev->nFreeChunks++;
2910
2911                 yaffs_ClearChunkBit(dev, block, page);
2912
2913                 bi->pagesInUse--;
2914
2915                 if (bi->pagesInUse == 0 &&
2916                     !bi->hasShrinkHeader &&
2917                     bi->blockState != YAFFS_BLOCK_STATE_ALLOCATING &&
2918                     bi->blockState != YAFFS_BLOCK_STATE_NEEDS_SCANNING) {
2919                         yaffs_BlockBecameDirty(dev, block);
2920                 }
2921
2922         }
2923
2924 }
2925
2926 static int yaffs_WriteChunkDataToObject(yaffs_Object *in, int chunkInInode,
2927                                         const __u8 *buffer, int nBytes,
2928                                         int useReserve)
2929 {
2930         /* Find old chunk Need to do this to get serial number
2931          * Write new one and patch into tree.
2932          * Invalidate old tags.
2933          */
2934
2935         int prevChunkId;
2936         yaffs_ExtendedTags prevTags;
2937
2938         int newChunkId;
2939         yaffs_ExtendedTags newTags;
2940
2941         yaffs_Device *dev = in->myDev;
2942
2943         yaffs_CheckGarbageCollection(dev,0);
2944
2945         /* Get the previous chunk at this location in the file if it exists.
2946          * If it does not exist then put a zero into the tree. This creates
2947          * the tnode now, rather than later when it is harder to clean up.
2948          */
2949         prevChunkId = yaffs_FindChunkInFile(in, chunkInInode, &prevTags);
2950         if(prevChunkId < 1 &&
2951                 !yaffs_PutChunkIntoFile(in, chunkInInode, 0, 0))
2952                 return 0;
2953
2954         /* Set up new tags */
2955         yaffs_InitialiseTags(&newTags);
2956
2957         newTags.chunkId = chunkInInode;
2958         newTags.objectId = in->objectId;
2959         newTags.serialNumber =
2960             (prevChunkId > 0) ? prevTags.serialNumber + 1 : 1;
2961         newTags.byteCount = nBytes;
2962
2963         if (nBytes < 1 || nBytes > dev->param.totalBytesPerChunk) {
2964                 T(YAFFS_TRACE_ERROR,
2965                 (TSTR("Writing %d bytes to chunk!!!!!!!!!" TENDSTR), nBytes));
2966                 YBUG();
2967         }
2968
2969
2970         newChunkId =
2971             yaffs_WriteNewChunkWithTagsToNAND(dev, buffer, &newTags,
2972                                               useReserve);
2973
2974         if (newChunkId > 0) {
2975                 yaffs_PutChunkIntoFile(in, chunkInInode, newChunkId, 0);
2976
2977                 if (prevChunkId > 0)
2978                         yaffs_DeleteChunk(dev, prevChunkId, 1, __LINE__);
2979
2980                 yaffs_VerifyFileSanity(in);
2981         }
2982         return newChunkId;
2983
2984 }
2985
2986 /* UpdateObjectHeader updates the header on NAND for an object.
2987  * If name is not NULL, then that new name is used.
2988  */
2989 int yaffs_UpdateObjectHeader(yaffs_Object *in, const YCHAR *name, int force,
2990                              int isShrink, int shadows, yaffs_XAttrMod *xmod)
2991 {
2992
2993         yaffs_BlockInfo *bi;
2994
2995         yaffs_Device *dev = in->myDev;
2996
2997         int prevChunkId;
2998         int retVal = 0;
2999         int result = 0;
3000
3001         int newChunkId;
3002         yaffs_ExtendedTags newTags;
3003         yaffs_ExtendedTags oldTags;
3004         YCHAR *alias = NULL;
3005
3006         __u8 *buffer = NULL;
3007         YCHAR oldName[YAFFS_MAX_NAME_LENGTH + 1];
3008
3009         yaffs_ObjectHeader *oh = NULL;
3010
3011         yaffs_strcpy(oldName, _Y("silly old name"));
3012
3013
3014         if (!in->fake ||
3015                 in == dev->rootDir || /* The rootDir should also be saved */
3016                 force  || xmod) {
3017
3018                 yaffs_CheckGarbageCollection(dev,0);
3019                 yaffs_CheckObjectDetailsLoaded(in);
3020
3021                 buffer = yaffs_GetTempBuffer(in->myDev, __LINE__);
3022                 oh = (yaffs_ObjectHeader *) buffer;
3023
3024                 prevChunkId = in->hdrChunk;
3025
3026                 if (prevChunkId > 0) {
3027                         result = yaffs_ReadChunkWithTagsFromNAND(dev, prevChunkId,
3028                                                         buffer, &oldTags);
3029
3030                         yaffs_VerifyObjectHeader(in, oh, &oldTags, 0);
3031
3032                         memcpy(oldName, oh->name, sizeof(oh->name));
3033                         memset(buffer, 0xFF, sizeof(yaffs_ObjectHeader));
3034                 } else
3035                         memset(buffer, 0xFF, dev->nDataBytesPerChunk);
3036
3037                 oh->type = in->variantType;
3038                 oh->yst_mode = in->yst_mode;
3039                 oh->shadowsObject = oh->inbandShadowsObject = shadows;
3040
3041 #ifdef CONFIG_YAFFS_WINCE
3042                 oh->win_atime[0] = in->win_atime[0];
3043                 oh->win_ctime[0] = in->win_ctime[0];
3044                 oh->win_mtime[0] = in->win_mtime[0];
3045                 oh->win_atime[1] = in->win_atime[1];
3046                 oh->win_ctime[1] = in->win_ctime[1];
3047                 oh->win_mtime[1] = in->win_mtime[1];
3048 #else
3049                 oh->yst_uid = in->yst_uid;
3050                 oh->yst_gid = in->yst_gid;
3051                 oh->yst_atime = in->yst_atime;
3052                 oh->yst_mtime = in->yst_mtime;
3053                 oh->yst_ctime = in->yst_ctime;
3054                 oh->yst_rdev = in->yst_rdev;
3055 #endif
3056                 if (in->parent)
3057                         oh->parentObjectId = in->parent->objectId;
3058                 else
3059                         oh->parentObjectId = 0;
3060
3061                 if (name && *name) {
3062                         memset(oh->name, 0, sizeof(oh->name));
3063                         yaffs_LoadObjectHeaderFromName(dev,oh->name,name);
3064                 } else if (prevChunkId > 0)
3065                         memcpy(oh->name, oldName, sizeof(oh->name));
3066                 else
3067                         memset(oh->name, 0, sizeof(oh->name));
3068
3069                 oh->isShrink = isShrink;
3070
3071                 switch (in->variantType) {
3072                 case YAFFS_OBJECT_TYPE_UNKNOWN:
3073                         /* Should not happen */
3074                         break;
3075                 case YAFFS_OBJECT_TYPE_FILE:
3076                         oh->fileSize =
3077                             (oh->parentObjectId == YAFFS_OBJECTID_DELETED
3078                              || oh->parentObjectId ==
3079                              YAFFS_OBJECTID_UNLINKED) ? 0 : in->variant.
3080                             fileVariant.fileSize;
3081                         break;
3082                 case YAFFS_OBJECT_TYPE_HARDLINK:
3083                         oh->equivalentObjectId =
3084                             in->variant.hardLinkVariant.equivalentObjectId;
3085                         break;
3086                 case YAFFS_OBJECT_TYPE_SPECIAL:
3087                         /* Do nothing */
3088                         break;
3089                 case YAFFS_OBJECT_TYPE_DIRECTORY:
3090                         /* Do nothing */
3091                         break;
3092                 case YAFFS_OBJECT_TYPE_SYMLINK:
3093                         alias = in->variant.symLinkVariant.alias;
3094                         if(!alias)
3095                                 alias = _Y("no alias");
3096                         yaffs_strncpy(oh->alias,
3097                                         alias,
3098                                       YAFFS_MAX_ALIAS_LENGTH);
3099                         oh->alias[YAFFS_MAX_ALIAS_LENGTH] = 0;
3100                         break;
3101                 }
3102
3103                 /* process any xattrib modifications */
3104                 if(xmod)
3105                         yaffs_ApplyXMod(dev, (char *)buffer, xmod);
3106
3107
3108                 /* Tags */
3109                 yaffs_InitialiseTags(&newTags);
3110                 in->serial++;
3111                 newTags.chunkId = 0;
3112                 newTags.objectId = in->objectId;
3113                 newTags.serialNumber = in->serial;
3114
3115                 /* Add extra info for file header */
3116
3117                 newTags.extraHeaderInfoAvailable = 1;
3118                 newTags.extraParentObjectId = oh->parentObjectId;
3119                 newTags.extraFileLength = oh->fileSize;
3120                 newTags.extraIsShrinkHeader = oh->isShrink;
3121                 newTags.extraEquivalentObjectId = oh->equivalentObjectId;
3122                 newTags.extraShadows = (oh->shadowsObject > 0) ? 1 : 0;
3123                 newTags.extraObjectType = in->variantType;
3124
3125                 yaffs_VerifyObjectHeader(in, oh, &newTags, 1);
3126
3127                 /* Create new chunk in NAND */
3128                 newChunkId =
3129                     yaffs_WriteNewChunkWithTagsToNAND(dev, buffer, &newTags,
3130                                                       (prevChunkId > 0) ? 1 : 0);
3131
3132                 if (newChunkId >= 0) {
3133
3134                         in->hdrChunk = newChunkId;
3135
3136                         if (prevChunkId > 0) {
3137                                 yaffs_DeleteChunk(dev, prevChunkId, 1,
3138                                                   __LINE__);
3139                         }
3140
3141                         if (!yaffs_ObjectHasCachedWriteData(in))
3142                                 in->dirty = 0;
3143
3144                         /* If this was a shrink, then mark the block that the chunk lives on */
3145                         if (isShrink) {
3146                                 bi = yaffs_GetBlockInfo(in->myDev,
3147                                         newChunkId / in->myDev->param.nChunksPerBlock);
3148                                 bi->hasShrinkHeader = 1;
3149                         }
3150
3151                 }
3152
3153                 retVal = newChunkId;
3154
3155         }
3156
3157         if (buffer)
3158                 yaffs_ReleaseTempBuffer(dev, buffer, __LINE__);
3159
3160         return retVal;
3161 }
3162
3163 /*------------------------ Short Operations Cache ----------------------------------------
3164  *   In many situations where there is no high level buffering (eg WinCE) a lot of
3165  *   reads might be short sequential reads, and a lot of writes may be short
3166  *   sequential writes. eg. scanning/writing a jpeg file.
3167  *   In these cases, a short read/write cache can provide a huge perfomance benefit
3168  *   with dumb-as-a-rock code.
3169  *   In Linux, the page cache provides read buffering aand the short op cache provides write
3170  *   buffering.
3171  *
3172  *   There are a limited number (~10) of cache chunks per device so that we don't
3173  *   need a very intelligent search.
3174  */
3175
3176 static int yaffs_ObjectHasCachedWriteData(yaffs_Object *obj)
3177 {
3178         yaffs_Device *dev = obj->myDev;
3179         int i;
3180         yaffs_ChunkCache *cache;
3181         int nCaches = obj->myDev->param.nShortOpCaches;
3182
3183         for (i = 0; i < nCaches; i++) {
3184                 cache = &dev->srCache[i];
3185                 if (cache->object == obj &&
3186                     cache->dirty)
3187                         return 1;
3188         }
3189
3190         return 0;
3191 }
3192
3193
3194 static void yaffs_FlushFilesChunkCache(yaffs_Object *obj)
3195 {
3196         yaffs_Device *dev = obj->myDev;
3197         int lowest = -99;       /* Stop compiler whining. */
3198         int i;
3199         yaffs_ChunkCache *cache;
3200         int chunkWritten = 0;
3201         int nCaches = obj->myDev->param.nShortOpCaches;
3202
3203         if (nCaches > 0) {
3204                 do {
3205                         cache = NULL;
3206
3207                         /* Find the dirty cache for this object with the lowest chunk id. */
3208                         for (i = 0; i < nCaches; i++) {
3209                                 if (dev->srCache[i].object == obj &&
3210                                     dev->srCache[i].dirty) {
3211                                         if (!cache
3212                                             || dev->srCache[i].chunkId <
3213                                             lowest) {
3214                                                 cache = &dev->srCache[i];
3215                                                 lowest = cache->chunkId;
3216                                         }
3217                                 }
3218                         }
3219
3220                         if (cache && !cache->locked) {
3221                                 /* Write it out and free it up */
3222
3223                                 chunkWritten =
3224                                     yaffs_WriteChunkDataToObject(cache->object,
3225                                                                  cache->chunkId,
3226                                                                  cache->data,
3227                                                                  cache->nBytes,
3228                                                                  1);
3229                                 cache->dirty = 0;
3230                                 cache->object = NULL;
3231                         }
3232
3233                 } while (cache && chunkWritten > 0);
3234
3235                 if (cache) {
3236                         /* Hoosterman, disk full while writing cache out. */
3237                         T(YAFFS_TRACE_ERROR,
3238                           (TSTR("yaffs tragedy: no space during cache write" TENDSTR)));
3239
3240                 }
3241         }
3242
3243 }
3244
3245 /*yaffs_FlushEntireDeviceCache(dev)
3246  *
3247  *
3248  */
3249
3250 void yaffs_FlushEntireDeviceCache(yaffs_Device *dev)
3251 {
3252         yaffs_Object *obj;
3253         int nCaches = dev->param.nShortOpCaches;
3254         int i;
3255
3256         /* Find a dirty object in the cache and flush it...
3257          * until there are no further dirty objects.
3258          */
3259         do {
3260                 obj = NULL;
3261                 for (i = 0; i < nCaches && !obj; i++) {
3262                         if (dev->srCache[i].object &&
3263                             dev->srCache[i].dirty)
3264                                 obj = dev->srCache[i].object;
3265
3266                 }
3267                 if (obj)
3268                         yaffs_FlushFilesChunkCache(obj);
3269
3270         } while (obj);
3271
3272 }
3273
3274
3275 /* Grab us a cache chunk for use.
3276  * First look for an empty one.
3277  * Then look for the least recently used non-dirty one.
3278  * Then look for the least recently used dirty one...., flush and look again.
3279  */
3280 static yaffs_ChunkCache *yaffs_GrabChunkCacheWorker(yaffs_Device *dev)
3281 {
3282         int i;
3283
3284         if (dev->param.nShortOpCaches > 0) {
3285                 for (i = 0; i < dev->param.nShortOpCaches; i++) {
3286                         if (!dev->srCache[i].object)
3287                                 return &dev->srCache[i];
3288                 }
3289         }
3290
3291         return NULL;
3292 }
3293
3294 static yaffs_ChunkCache *yaffs_GrabChunkCache(yaffs_Device *dev)
3295 {
3296         yaffs_ChunkCache *cache;
3297         yaffs_Object *theObj;
3298         int usage;
3299         int i;
3300         int pushout;
3301
3302         if (dev->param.nShortOpCaches > 0) {
3303                 /* Try find a non-dirty one... */
3304
3305                 cache = yaffs_GrabChunkCacheWorker(dev);
3306
3307                 if (!cache) {
3308                         /* They were all dirty, find the last recently used object and flush
3309                          * its cache, then  find again.
3310                          * NB what's here is not very accurate, we actually flush the object
3311                          * the last recently used page.
3312                          */
3313
3314                         /* With locking we can't assume we can use entry zero */
3315
3316                         theObj = NULL;
3317                         usage = -1;
3318                         cache = NULL;
3319                         pushout = -1;
3320
3321                         for (i = 0; i < dev->param.nShortOpCaches; i++) {
3322                                 if (dev->srCache[i].object &&
3323                                     !dev->srCache[i].locked &&
3324                                     (dev->srCache[i].lastUse < usage || !cache)) {
3325                                         usage = dev->srCache[i].lastUse;
3326                                         theObj = dev->srCache[i].object;
3327                                         cache = &dev->srCache[i];
3328                                         pushout = i;
3329                                 }
3330                         }
3331
3332                         if (!cache || cache->dirty) {
3333                                 /* Flush and try again */
3334                                 yaffs_FlushFilesChunkCache(theObj);
3335                                 cache = yaffs_GrabChunkCacheWorker(dev);
3336                         }
3337
3338                 }
3339                 return cache;
3340         } else
3341                 return NULL;
3342
3343 }
3344
3345 /* Find a cached chunk */
3346 static yaffs_ChunkCache *yaffs_FindChunkCache(const yaffs_Object *obj,
3347                                               int chunkId)
3348 {
3349         yaffs_Device *dev = obj->myDev;
3350         int i;
3351         if (dev->param.nShortOpCaches > 0) {
3352                 for (i = 0; i < dev->param.nShortOpCaches; i++) {
3353                         if (dev->srCache[i].object == obj &&
3354                             dev->srCache[i].chunkId == chunkId) {
3355                                 dev->cacheHits++;
3356
3357                                 return &dev->srCache[i];
3358                         }
3359                 }
3360         }
3361         return NULL;
3362 }
3363
3364 /* Mark the chunk for the least recently used algorithym */
3365 static void yaffs_UseChunkCache(yaffs_Device *dev, yaffs_ChunkCache *cache,
3366                                 int isAWrite)
3367 {
3368
3369         if (dev->param.nShortOpCaches > 0) {
3370                 if (dev->srLastUse < 0 || dev->srLastUse > 100000000) {
3371                         /* Reset the cache usages */
3372                         int i;
3373                         for (i = 1; i < dev->param.nShortOpCaches; i++)
3374                                 dev->srCache[i].lastUse = 0;
3375
3376                         dev->srLastUse = 0;
3377                 }
3378
3379                 dev->srLastUse++;
3380
3381                 cache->lastUse = dev->srLastUse;
3382
3383                 if (isAWrite)
3384                         cache->dirty = 1;
3385         }
3386 }
3387
3388 /* Invalidate a single cache page.
3389  * Do this when a whole page gets written,
3390  * ie the short cache for this page is no longer valid.
3391  */
3392 static void yaffs_InvalidateChunkCache(yaffs_Object *object, int chunkId)
3393 {
3394         if (object->myDev->param.nShortOpCaches > 0) {
3395                 yaffs_ChunkCache *cache = yaffs_FindChunkCache(object, chunkId);
3396
3397                 if (cache)
3398                         cache->object = NULL;
3399         }
3400 }
3401
3402 /* Invalidate all the cache pages associated with this object
3403  * Do this whenever ther file is deleted or resized.
3404  */
3405 static void yaffs_InvalidateWholeChunkCache(yaffs_Object *in)
3406 {
3407         int i;
3408         yaffs_Device *dev = in->myDev;
3409
3410         if (dev->param.nShortOpCaches > 0) {
3411                 /* Invalidate it. */
3412                 for (i = 0; i < dev->param.nShortOpCaches; i++) {
3413                         if (dev->srCache[i].object == in)
3414                                 dev->srCache[i].object = NULL;
3415                 }
3416         }
3417 }
3418
3419
3420 /*--------------------- File read/write ------------------------
3421  * Read and write have very similar structures.
3422  * In general the read/write has three parts to it
3423  * An incomplete chunk to start with (if the read/write is not chunk-aligned)
3424  * Some complete chunks
3425  * An incomplete chunk to end off with
3426  *
3427  * Curve-balls: the first chunk might also be the last chunk.
3428  */
3429
3430 int yaffs_ReadDataFromFile(yaffs_Object *in, __u8 *buffer, loff_t offset,
3431                         int nBytes)
3432 {
3433
3434         int chunk;
3435         __u32 start;
3436         int nToCopy;
3437         int n = nBytes;
3438         int nDone = 0;
3439         yaffs_ChunkCache *cache;
3440
3441         yaffs_Device *dev;
3442
3443         dev = in->myDev;
3444
3445         while (n > 0) {
3446                 /* chunk = offset / dev->nDataBytesPerChunk + 1; */
3447                 /* start = offset % dev->nDataBytesPerChunk; */
3448                 yaffs_AddrToChunk(dev, offset, &chunk, &start);
3449                 chunk++;
3450
3451                 /* OK now check for the curveball where the start and end are in
3452                  * the same chunk.
3453                  */
3454                 if ((start + n) < dev->nDataBytesPerChunk)
3455                         nToCopy = n;
3456                 else
3457                         nToCopy = dev->nDataBytesPerChunk - start;
3458
3459                 cache = yaffs_FindChunkCache(in, chunk);
3460
3461                 /* If the chunk is already in the cache or it is less than a whole chunk
3462                  * or we're using inband tags then use the cache (if there is caching)
3463                  * else bypass the cache.
3464                  */
3465                 if (cache || nToCopy != dev->nDataBytesPerChunk || dev->param.inbandTags) {
3466                         if (dev->param.nShortOpCaches > 0) {
3467
3468                                 /* If we can't find the data in the cache, then load it up. */
3469
3470                                 if (!cache) {
3471                                         cache = yaffs_GrabChunkCache(in->myDev);
3472                                         cache->object = in;
3473                                         cache->chunkId = chunk;
3474                                         cache->dirty = 0;
3475                                         cache->locked = 0;
3476                                         yaffs_ReadChunkDataFromObject(in, chunk,
3477                                                                       cache->
3478                                                                       data);
3479                                         cache->nBytes = 0;
3480                                 }
3481
3482                                 yaffs_UseChunkCache(dev, cache, 0);
3483
3484                                 cache->locked = 1;
3485
3486
3487                                 memcpy(buffer, &cache->data[start], nToCopy);
3488
3489                                 cache->locked = 0;
3490                         } else {
3491                                 /* Read into the local buffer then copy..*/
3492
3493                                 __u8 *localBuffer =
3494                                     yaffs_GetTempBuffer(dev, __LINE__);
3495                                 yaffs_ReadChunkDataFromObject(in, chunk,
3496                                                               localBuffer);
3497
3498                                 memcpy(buffer, &localBuffer[start], nToCopy);
3499
3500
3501                                 yaffs_ReleaseTempBuffer(dev, localBuffer,
3502                                                         __LINE__);
3503                         }
3504
3505                 } else {
3506
3507                         /* A full chunk. Read directly into the supplied buffer. */
3508                         yaffs_ReadChunkDataFromObject(in, chunk, buffer);
3509
3510                 }
3511
3512                 n -= nToCopy;
3513                 offset += nToCopy;
3514                 buffer += nToCopy;
3515                 nDone += nToCopy;
3516
3517         }
3518
3519         return nDone;
3520 }
3521
3522 int yaffs_DoWriteDataToFile(yaffs_Object *in, const __u8 *buffer, loff_t offset,
3523                         int nBytes, int writeThrough)
3524 {
3525
3526         int chunk;
3527         __u32 start;
3528         int nToCopy;
3529         int n = nBytes;
3530         int nDone = 0;
3531         int nToWriteBack;
3532         int startOfWrite = offset;
3533         int chunkWritten = 0;
3534         __u32 nBytesRead;
3535         __u32 chunkStart;
3536
3537         yaffs_Device *dev;
3538
3539         dev = in->myDev;
3540
3541         while (n > 0 && chunkWritten >= 0) {
3542                 yaffs_AddrToChunk(dev, offset, &chunk, &start);
3543
3544                 if (chunk * dev->nDataBytesPerChunk + start != offset ||
3545                                 start >= dev->nDataBytesPerChunk) {
3546                         T(YAFFS_TRACE_ERROR, (
3547                            TSTR("AddrToChunk of offset %d gives chunk %d start %d"
3548                            TENDSTR),
3549                            (int)offset, chunk, start));
3550                 }
3551                 chunk++; /* File pos to chunk in file offset */
3552
3553                 /* OK now check for the curveball where the start and end are in
3554                  * the same chunk.
3555                  */
3556
3557                 if ((start + n) < dev->nDataBytesPerChunk) {
3558                         nToCopy = n;
3559
3560                         /* Now folks, to calculate how many bytes to write back....
3561                          * If we're overwriting and not writing to then end of file then
3562                          * we need to write back as much as was there before.
3563                          */
3564
3565                         chunkStart = ((chunk - 1) * dev->nDataBytesPerChunk);
3566
3567                         if (chunkStart > in->variant.fileVariant.fileSize)
3568                                 nBytesRead = 0; /* Past end of file */
3569                         else
3570                                 nBytesRead = in->variant.fileVariant.fileSize - chunkStart;
3571
3572                         if (nBytesRead > dev->nDataBytesPerChunk)
3573                                 nBytesRead = dev->nDataBytesPerChunk;
3574
3575                         nToWriteBack =
3576                             (nBytesRead >
3577                              (start + n)) ? nBytesRead : (start + n);
3578
3579                         if (nToWriteBack < 0 || nToWriteBack > dev->nDataBytesPerChunk)
3580                                 YBUG();
3581
3582                 } else {
3583                         nToCopy = dev->nDataBytesPerChunk - start;
3584                         nToWriteBack = dev->nDataBytesPerChunk;
3585                 }
3586
3587                 if (nToCopy != dev->nDataBytesPerChunk || dev->param.inbandTags) {
3588                         /* An incomplete start or end chunk (or maybe both start and end chunk),
3589                          * or we're using inband tags, so we want to use the cache buffers.
3590                          */
3591                         if (dev->param.nShortOpCaches > 0) {
3592                                 yaffs_ChunkCache *cache;
3593                                 /* If we can't find the data in the cache, then load the cache */
3594                                 cache = yaffs_FindChunkCache(in, chunk);
3595
3596                                 if (!cache
3597                                     && yaffs_CheckSpaceForAllocation(dev, 1)) {
3598                                         cache = yaffs_GrabChunkCache(dev);
3599                                         cache->object = in;
3600                                         cache->chunkId = chunk;
3601                                         cache->dirty = 0;
3602                                         cache->locked = 0;
3603                                         yaffs_ReadChunkDataFromObject(in, chunk,
3604                                                                       cache->data);
3605                                 } else if (cache &&
3606                                         !cache->dirty &&
3607                                         !yaffs_CheckSpaceForAllocation(dev, 1)) {
3608                                         /* Drop the cache if it was a read cache item and
3609                                          * no space check has been made for it.
3610                                          */
3611                                          cache = NULL;
3612                                 }
3613
3614                                 if (cache) {
3615                                         yaffs_UseChunkCache(dev, cache, 1);
3616                                         cache->locked = 1;
3617
3618
3619                                         memcpy(&cache->data[start], buffer,
3620                                                nToCopy);
3621
3622
3623                                         cache->locked = 0;
3624                                         cache->nBytes = nToWriteBack;
3625
3626                                         if (writeThrough) {
3627                                                 chunkWritten =
3628                                                     yaffs_WriteChunkDataToObject
3629                                                     (cache->object,
3630                                                      cache->chunkId,
3631                                                      cache->data, cache->nBytes,
3632                                                      1);
3633                                                 cache->dirty = 0;
3634                                         }
3635
3636                                 } else {
3637                                         chunkWritten = -1;      /* fail the write */
3638                                 }
3639                         } else {
3640                                 /* An incomplete start or end chunk (or maybe both start and end chunk)
3641                                  * Read into the local buffer then copy, then copy over and write back.
3642                                  */
3643
3644                                 __u8 *localBuffer =
3645                                     yaffs_GetTempBuffer(dev, __LINE__);
3646
3647                                 yaffs_ReadChunkDataFromObject(in, chunk,
3648                                                               localBuffer);
3649
3650
3651
3652                                 memcpy(&localBuffer[start], buffer, nToCopy);
3653
3654                                 chunkWritten =
3655                                     yaffs_WriteChunkDataToObject(in, chunk,
3656                                                                  localBuffer,
3657                                                                  nToWriteBack,
3658                                                                  0);
3659
3660                                 yaffs_ReleaseTempBuffer(dev, localBuffer,
3661                                                         __LINE__);
3662
3663                         }
3664
3665                 } else {
3666                         /* A full chunk. Write directly from the supplied buffer. */
3667
3668
3669
3670                         chunkWritten =
3671                             yaffs_WriteChunkDataToObject(in, chunk, buffer,
3672                                                          dev->nDataBytesPerChunk,
3673                                                          0);
3674
3675                         /* Since we've overwritten the cached data, we better invalidate it. */
3676                         yaffs_InvalidateChunkCache(in, chunk);
3677                 }
3678
3679                 if (chunkWritten >= 0) {
3680                         n -= nToCopy;
3681                         offset += nToCopy;
3682                         buffer += nToCopy;
3683                         nDone += nToCopy;
3684                 }
3685
3686         }
3687
3688         /* Update file object */
3689
3690         if ((startOfWrite + nDone) > in->variant.fileVariant.fileSize)
3691                 in->variant.fileVariant.fileSize = (startOfWrite + nDone);
3692
3693         in->dirty = 1;
3694
3695         return nDone;
3696 }
3697
3698 int yaffs_WriteDataToFile(yaffs_Object *in, const __u8 *buffer, loff_t offset,
3699                         int nBytes, int writeThrough)
3700 {
3701         yaffs2_HandleHole(in,offset);
3702         return yaffs_DoWriteDataToFile(in,buffer,offset,nBytes,writeThrough);
3703 }
3704
3705
3706
3707 /* ---------------------- File resizing stuff ------------------ */
3708
3709 static void yaffs_PruneResizedChunks(yaffs_Object *in, int newSize)
3710 {
3711
3712         yaffs_Device *dev = in->myDev;
3713         int oldFileSize = in->variant.fileVariant.fileSize;
3714
3715         int lastDel = 1 + (oldFileSize - 1) / dev->nDataBytesPerChunk;
3716
3717         int startDel = 1 + (newSize + dev->nDataBytesPerChunk - 1) /
3718             dev->nDataBytesPerChunk;
3719         int i;
3720         int chunkId;
3721
3722         /* Delete backwards so that we don't end up with holes if
3723          * power is lost part-way through the operation.
3724          */
3725         for (i = lastDel; i >= startDel; i--) {
3726                 /* NB this could be optimised somewhat,
3727                  * eg. could retrieve the tags and write them without
3728                  * using yaffs_DeleteChunk
3729                  */
3730
3731                 chunkId = yaffs_FindAndDeleteChunkInFile(in, i, NULL);
3732                 if (chunkId > 0) {
3733                         if (chunkId <
3734                             (dev->internalStartBlock * dev->param.nChunksPerBlock)
3735                             || chunkId >=
3736                             ((dev->internalEndBlock +
3737                               1) * dev->param.nChunksPerBlock)) {
3738                                 T(YAFFS_TRACE_ALWAYS,
3739                                   (TSTR("Found daft chunkId %d for %d" TENDSTR),
3740                                    chunkId, i));
3741                         } else {
3742                                 in->nDataChunks--;
3743                                 yaffs_DeleteChunk(dev, chunkId, 1, __LINE__);
3744                         }
3745                 }
3746         }
3747
3748 }
3749
3750
3751 void yaffs_ResizeDown( yaffs_Object *obj, loff_t newSize)
3752 {
3753         int newFullChunks;
3754         __u32 newSizeOfPartialChunk;
3755         yaffs_Device *dev = obj->myDev;
3756
3757         yaffs_AddrToChunk(dev, newSize, &newFullChunks, &newSizeOfPartialChunk);
3758
3759         yaffs_PruneResizedChunks(obj, newSize);
3760
3761         if (newSizeOfPartialChunk != 0) {
3762                 int lastChunk = 1 + newFullChunks;
3763                 __u8 *localBuffer = yaffs_GetTempBuffer(dev, __LINE__);
3764
3765                 /* Got to read and rewrite the last chunk with its new size and zero pad */
3766                 yaffs_ReadChunkDataFromObject(obj, lastChunk, localBuffer);
3767                 memset(localBuffer + newSizeOfPartialChunk, 0,
3768                         dev->nDataBytesPerChunk - newSizeOfPartialChunk);
3769
3770                 yaffs_WriteChunkDataToObject(obj, lastChunk, localBuffer,
3771                                              newSizeOfPartialChunk, 1);
3772
3773                 yaffs_ReleaseTempBuffer(dev, localBuffer, __LINE__);
3774         }
3775
3776         obj->variant.fileVariant.fileSize = newSize;
3777
3778         yaffs_PruneFileStructure(dev, &obj->variant.fileVariant);
3779 }
3780
3781
3782 int yaffs_ResizeFile(yaffs_Object *in, loff_t newSize)
3783 {
3784         yaffs_Device *dev = in->myDev;
3785         int oldFileSize = in->variant.fileVariant.fileSize;
3786
3787         yaffs_FlushFilesChunkCache(in);
3788         yaffs_InvalidateWholeChunkCache(in);
3789
3790         yaffs_CheckGarbageCollection(dev,0);
3791
3792         if (in->variantType != YAFFS_OBJECT_TYPE_FILE)
3793                 return YAFFS_FAIL;
3794
3795         if (newSize == oldFileSize)
3796                 return YAFFS_OK;
3797
3798         if(newSize > oldFileSize){
3799                 yaffs2_HandleHole(in,newSize);
3800                 in->variant.fileVariant.fileSize = newSize;
3801         } else {
3802                 /* newSize < oldFileSize */
3803                 yaffs_ResizeDown(in, newSize);
3804         }
3805
3806         /* Write a new object header to reflect the resize.
3807          * show we've shrunk the file, if need be
3808          * Do this only if the file is not in the deleted directories
3809          * and is not shadowed.
3810          */
3811         if (in->parent &&
3812             !in->isShadowed &&
3813             in->parent->objectId != YAFFS_OBJECTID_UNLINKED &&
3814             in->parent->objectId != YAFFS_OBJECTID_DELETED)
3815                 yaffs_UpdateObjectHeader(in, NULL, 0, 0, 0, NULL);
3816
3817
3818         return YAFFS_OK;
3819 }
3820
3821 loff_t yaffs_GetFileSize(yaffs_Object *obj)
3822 {
3823         YCHAR *alias = NULL;
3824         obj = yaffs_GetEquivalentObject(obj);
3825
3826         switch (obj->variantType) {
3827         case YAFFS_OBJECT_TYPE_FILE:
3828                 return obj->variant.fileVariant.fileSize;
3829         case YAFFS_OBJECT_TYPE_SYMLINK:
3830                 alias = obj->variant.symLinkVariant.alias;
3831                 if(!alias)
3832                         return 0;
3833                 return yaffs_strnlen(alias,YAFFS_MAX_ALIAS_LENGTH);
3834         default:
3835                 return 0;
3836         }
3837 }
3838
3839
3840
3841 int yaffs_FlushFile(yaffs_Object *in, int updateTime, int dataSync)
3842 {
3843         int retVal;
3844         if (in->dirty) {
3845                 yaffs_FlushFilesChunkCache(in);
3846                 if(dataSync) /* Only sync data */
3847                         retVal=YAFFS_OK;
3848                 else {
3849                         if (updateTime) {
3850 #ifdef CONFIG_YAFFS_WINCE
3851                                 yfsd_WinFileTimeNow(in->win_mtime);
3852 #else
3853
3854                                 in->yst_mtime = Y_CURRENT_TIME;
3855
3856 #endif
3857                         }
3858
3859                         retVal = (yaffs_UpdateObjectHeader(in, NULL, 0, 0, 0, NULL) >=
3860                                 0) ? YAFFS_OK : YAFFS_FAIL;
3861                 }
3862         } else {
3863                 retVal = YAFFS_OK;
3864         }
3865
3866         return retVal;
3867
3868 }
3869
3870 static int yaffs_DoGenericObjectDeletion(yaffs_Object *in)
3871 {
3872
3873         /* First off, invalidate the file's data in the cache, without flushing. */
3874         yaffs_InvalidateWholeChunkCache(in);
3875
3876         if (in->myDev->param.isYaffs2 && (in->parent != in->myDev->deletedDir)) {
3877                 /* Move to the unlinked directory so we have a record that it was deleted. */
3878                 yaffs_ChangeObjectName(in, in->myDev->deletedDir, _Y("deleted"), 0, 0);
3879
3880         }
3881
3882         yaffs_RemoveObjectFromDirectory(in);
3883         yaffs_DeleteChunk(in->myDev, in->hdrChunk, 1, __LINE__);
3884         in->hdrChunk = 0;
3885
3886         yaffs_FreeObject(in);
3887         return YAFFS_OK;
3888
3889 }
3890
3891 /* yaffs_DeleteFile deletes the whole file data
3892  * and the inode associated with the file.
3893  * It does not delete the links associated with the file.
3894  */
3895 static int yaffs_UnlinkFileIfNeeded(yaffs_Object *in)
3896 {
3897
3898         int retVal;
3899         int immediateDeletion = 0;
3900         yaffs_Device *dev = in->myDev;
3901
3902         if (!in->myInode)
3903                 immediateDeletion = 1;
3904
3905         if (immediateDeletion) {
3906                 retVal =
3907                     yaffs_ChangeObjectName(in, in->myDev->deletedDir,
3908                                            _Y("deleted"), 0, 0);
3909                 T(YAFFS_TRACE_TRACING,
3910                   (TSTR("yaffs: immediate deletion of file %d" TENDSTR),
3911                    in->objectId));
3912                 in->deleted = 1;
3913                 in->myDev->nDeletedFiles++;
3914                 if (dev->param.disableSoftDelete || dev->param.isYaffs2)
3915                         yaffs_ResizeFile(in, 0);
3916                 yaffs_SoftDeleteFile(in);
3917         } else {
3918                 retVal =
3919                     yaffs_ChangeObjectName(in, in->myDev->unlinkedDir,
3920                                            _Y("unlinked"), 0, 0);
3921         }
3922
3923
3924         return retVal;
3925 }
3926
3927 int yaffs_DeleteFile(yaffs_Object *in)
3928 {
3929         int retVal = YAFFS_OK;
3930         int deleted; /* Need to cache value on stack if in is freed */
3931         yaffs_Device *dev = in->myDev;
3932
3933         if (dev->param.disableSoftDelete || dev->param.isYaffs2)
3934                 yaffs_ResizeFile(in, 0);
3935
3936         if (in->nDataChunks > 0) {
3937                 /* Use soft deletion if there is data in the file.
3938                  * That won't be the case if it has been resized to zero.
3939                  */
3940                 if (!in->unlinked)
3941                         retVal = yaffs_UnlinkFileIfNeeded(in);
3942
3943                 deleted = in->deleted;
3944
3945                 if (retVal == YAFFS_OK && in->unlinked && !in->deleted) {
3946                         in->deleted = 1;
3947                         deleted = 1;
3948                         in->myDev->nDeletedFiles++;
3949                         yaffs_SoftDeleteFile(in);
3950                 }
3951                 return deleted ? YAFFS_OK : YAFFS_FAIL;
3952         } else {
3953                 /* The file has no data chunks so we toss it immediately */
3954                 yaffs_FreeTnode(in->myDev, in->variant.fileVariant.top);
3955                 in->variant.fileVariant.top = NULL;
3956                 yaffs_DoGenericObjectDeletion(in);
3957
3958                 return YAFFS_OK;
3959         }
3960 }
3961
3962 static int yaffs_IsNonEmptyDirectory(yaffs_Object *obj)
3963 {
3964         return (obj->variantType == YAFFS_OBJECT_TYPE_DIRECTORY) &&
3965                 !(ylist_empty(&obj->variant.directoryVariant.children));
3966 }
3967
3968 static int yaffs_DeleteDirectory(yaffs_Object *obj)
3969 {
3970         /* First check that the directory is empty. */
3971         if (yaffs_IsNonEmptyDirectory(obj))
3972                 return YAFFS_FAIL;
3973
3974         return yaffs_DoGenericObjectDeletion(obj);
3975 }
3976
3977 static int yaffs_DeleteSymLink(yaffs_Object *in)
3978 {
3979         if(in->variant.symLinkVariant.alias)
3980                 YFREE(in->variant.symLinkVariant.alias);
3981         in->variant.symLinkVariant.alias=NULL;
3982
3983         return yaffs_DoGenericObjectDeletion(in);
3984 }
3985
3986 static int yaffs_DeleteHardLink(yaffs_Object *in)
3987 {
3988         /* remove this hardlink from the list assocaited with the equivalent
3989          * object
3990          */
3991         ylist_del_init(&in->hardLinks);
3992         return yaffs_DoGenericObjectDeletion(in);
3993 }
3994
3995 int yaffs_DeleteObject(yaffs_Object *obj)
3996 {
3997 int retVal = -1;
3998         switch (obj->variantType) {
3999         case YAFFS_OBJECT_TYPE_FILE:
4000                 retVal = yaffs_DeleteFile(obj);
4001                 break;
4002         case YAFFS_OBJECT_TYPE_DIRECTORY:
4003                 if(!ylist_empty(&obj->variant.directoryVariant.dirty)){
4004                         T(YAFFS_TRACE_BACKGROUND, (TSTR("Remove object %d from dirty directories" TENDSTR),obj->objectId));
4005                         ylist_del_init(&obj->variant.directoryVariant.dirty);
4006                 }
4007                 return yaffs_DeleteDirectory(obj);
4008                 break;
4009         case YAFFS_OBJECT_TYPE_SYMLINK:
4010                 retVal = yaffs_DeleteSymLink(obj);
4011                 break;
4012         case YAFFS_OBJECT_TYPE_HARDLINK:
4013                 retVal = yaffs_DeleteHardLink(obj);
4014                 break;
4015         case YAFFS_OBJECT_TYPE_SPECIAL:
4016                 retVal = yaffs_DoGenericObjectDeletion(obj);
4017                 break;
4018         case YAFFS_OBJECT_TYPE_UNKNOWN:
4019                 retVal = 0;
4020                 break;          /* should not happen. */
4021         }
4022
4023         return retVal;
4024 }
4025
4026 static int yaffs_UnlinkWorker(yaffs_Object *obj)
4027 {
4028
4029         int immediateDeletion = 0;
4030
4031         if (!obj->myInode)
4032                 immediateDeletion = 1;
4033
4034         if(obj)
4035                 yaffs_UpdateParent(obj->parent);
4036
4037         if (obj->variantType == YAFFS_OBJECT_TYPE_HARDLINK) {
4038                 return yaffs_DeleteHardLink(obj);
4039         } else if (!ylist_empty(&obj->hardLinks)) {
4040                 /* Curve ball: We're unlinking an object that has a hardlink.
4041                  *
4042                  * This problem arises because we are not strictly following
4043                  * The Linux link/inode model.
4044                  *
4045                  * We can't really delete the object.
4046                  * Instead, we do the following:
4047                  * - Select a hardlink.
4048                  * - Unhook it from the hard links
4049                  * - Move it from its parent directory (so that the rename can work)
4050                  * - Rename the object to the hardlink's name.
4051                  * - Delete the hardlink
4052                  */
4053
4054                 yaffs_Object *hl;
4055                 yaffs_Object *parent;
4056                 int retVal;
4057                 YCHAR name[YAFFS_MAX_NAME_LENGTH + 1];
4058
4059                 hl = ylist_entry(obj->hardLinks.next, yaffs_Object, hardLinks);
4060
4061                 yaffs_GetObjectName(hl, name, YAFFS_MAX_NAME_LENGTH + 1);
4062                 parent = hl->parent;
4063
4064                 ylist_del_init(&hl->hardLinks);
4065
4066                 yaffs_AddObjectToDirectory(obj->myDev->unlinkedDir, hl);
4067
4068                 retVal = yaffs_ChangeObjectName(obj,parent, name, 0, 0);
4069
4070                 if (retVal == YAFFS_OK)
4071                         retVal = yaffs_DoGenericObjectDeletion(hl);
4072
4073                 return retVal;
4074
4075         } else if (immediateDeletion) {
4076                 switch (obj->variantType) {
4077                 case YAFFS_OBJECT_TYPE_FILE:
4078                         return yaffs_DeleteFile(obj);
4079                         break;
4080                 case YAFFS_OBJECT_TYPE_DIRECTORY:
4081                         ylist_del_init(&obj->variant.directoryVariant.dirty);
4082                         return yaffs_DeleteDirectory(obj);
4083                         break;
4084                 case YAFFS_OBJECT_TYPE_SYMLINK:
4085                         return yaffs_DeleteSymLink(obj);
4086                         break;
4087                 case YAFFS_OBJECT_TYPE_SPECIAL:
4088                         return yaffs_DoGenericObjectDeletion(obj);
4089                         break;
4090                 case YAFFS_OBJECT_TYPE_HARDLINK:
4091                 case YAFFS_OBJECT_TYPE_UNKNOWN:
4092                 default:
4093                         return YAFFS_FAIL;
4094                 }
4095         } else if(yaffs_IsNonEmptyDirectory(obj))
4096                 return YAFFS_FAIL;
4097         else
4098                 return yaffs_ChangeObjectName(obj, obj->myDev->unlinkedDir,
4099                                            _Y("unlinked"), 0, 0);
4100 }
4101
4102
4103 static int yaffs_UnlinkObject(yaffs_Object *obj)
4104 {
4105
4106         if (obj && obj->unlinkAllowed)
4107                 return yaffs_UnlinkWorker(obj);
4108
4109         return YAFFS_FAIL;
4110
4111 }
4112 int yaffs_Unlink(yaffs_Object *dir, const YCHAR *name)
4113 {
4114         yaffs_Object *obj;
4115
4116         obj = yaffs_FindObjectByName(dir, name);
4117         return yaffs_UnlinkObject(obj);
4118 }
4119
4120 /*----------------------- Initialisation Scanning ---------------------- */
4121
4122 void yaffs_HandleShadowedObject(yaffs_Device *dev, int objId,
4123                                 int backwardScanning)
4124 {
4125         yaffs_Object *obj;
4126
4127         if (!backwardScanning) {
4128                 /* Handle YAFFS1 forward scanning case
4129                  * For YAFFS1 we always do the deletion
4130                  */
4131
4132         } else {
4133                 /* Handle YAFFS2 case (backward scanning)
4134                  * If the shadowed object exists then ignore.
4135                  */
4136                 obj = yaffs_FindObjectByNumber(dev, objId);
4137                 if(obj)
4138                         return;
4139         }
4140
4141         /* Let's create it (if it does not exist) assuming it is a file so that it can do shrinking etc.
4142          * We put it in unlinked dir to be cleaned up after the scanning
4143          */
4144         obj =
4145             yaffs_FindOrCreateObjectByNumber(dev, objId,
4146                                              YAFFS_OBJECT_TYPE_FILE);
4147         if (!obj)
4148                 return;
4149         obj->isShadowed = 1;
4150         yaffs_AddObjectToDirectory(dev->unlinkedDir, obj);
4151         obj->variant.fileVariant.shrinkSize = 0;
4152         obj->valid = 1;         /* So that we don't read any other info for this file */
4153
4154 }
4155
4156
4157 void yaffs_HardlinkFixup(yaffs_Device *dev, yaffs_Object *hardList)
4158 {
4159         yaffs_Object *hl;
4160         yaffs_Object *in;
4161
4162         while (hardList) {
4163                 hl = hardList;
4164                 hardList = (yaffs_Object *) (hardList->hardLinks.next);
4165
4166                 in = yaffs_FindObjectByNumber(dev,
4167                                               hl->variant.hardLinkVariant.
4168                                               equivalentObjectId);
4169
4170                 if (in) {
4171                         /* Add the hardlink pointers */
4172                         hl->variant.hardLinkVariant.equivalentObject = in;
4173                         ylist_add(&hl->hardLinks, &in->hardLinks);
4174                 } else {
4175                         /* Todo Need to report/handle this better.
4176                          * Got a problem... hardlink to a non-existant object
4177                          */
4178                         hl->variant.hardLinkVariant.equivalentObject = NULL;
4179                         YINIT_LIST_HEAD(&hl->hardLinks);
4180
4181                 }
4182         }
4183 }
4184
4185
4186 static void yaffs_StripDeletedObjects(yaffs_Device *dev)
4187 {
4188         /*
4189         *  Sort out state of unlinked and deleted objects after scanning.
4190         */
4191         struct ylist_head *i;
4192         struct ylist_head *n;
4193         yaffs_Object *l;
4194
4195         if (dev->readOnly)
4196                 return;
4197
4198         /* Soft delete all the unlinked files */
4199         ylist_for_each_safe(i, n,
4200                 &dev->unlinkedDir->variant.directoryVariant.children) {
4201                 if (i) {
4202                         l = ylist_entry(i, yaffs_Object, siblings);
4203                         yaffs_DeleteObject(l);
4204                 }
4205         }
4206
4207         ylist_for_each_safe(i, n,
4208                 &dev->deletedDir->variant.directoryVariant.children) {
4209                 if (i) {
4210                         l = ylist_entry(i, yaffs_Object, siblings);
4211                         yaffs_DeleteObject(l);
4212                 }
4213         }
4214
4215 }
4216
4217 /*
4218  * This code iterates through all the objects making sure that they are rooted.
4219  * Any unrooted objects are re-rooted in lost+found.
4220  * An object needs to be in one of:
4221  * - Directly under deleted, unlinked
4222  * - Directly or indirectly under root.
4223  *
4224  * Note:
4225  *  This code assumes that we don't ever change the current relationships between
4226  *  directories:
4227  *   rootDir->parent == unlinkedDir->parent == deletedDir->parent == NULL
4228  *   lostNfound->parent == rootDir
4229  *
4230  * This fixes the problem where directories might have inadvertently been deleted
4231  * leaving the object "hanging" without being rooted in the directory tree.
4232  */
4233
4234 static int yaffs_HasNULLParent(yaffs_Device *dev, yaffs_Object *obj)
4235 {
4236         return (obj == dev->deletedDir ||
4237                 obj == dev->unlinkedDir||
4238                 obj == dev->rootDir);
4239 }
4240
4241 static void yaffs_FixHangingObjects(yaffs_Device *dev)
4242 {
4243         yaffs_Object *obj;
4244         yaffs_Object *parent;
4245         int i;
4246         struct ylist_head *lh;
4247         struct ylist_head *n;
4248         int depthLimit;
4249         int hanging;
4250
4251         if (dev->readOnly)
4252                 return;
4253
4254         /* Iterate through the objects in each hash entry,
4255          * looking at each object.
4256          * Make sure it is rooted.
4257          */
4258
4259         for (i = 0; i <  YAFFS_NOBJECT_BUCKETS; i++) {
4260                 ylist_for_each_safe(lh, n, &dev->objectBucket[i].list) {
4261                         if (lh) {
4262                                 obj = ylist_entry(lh, yaffs_Object, hashLink);
4263                                 parent= obj->parent;
4264
4265                                 if(yaffs_HasNULLParent(dev,obj)){
4266                                         /* These directories are not hanging */
4267                                         hanging = 0;
4268                                 }
4269                                 else if(!parent || parent->variantType != YAFFS_OBJECT_TYPE_DIRECTORY)
4270                                         hanging = 1;
4271                                 else if(yaffs_HasNULLParent(dev,parent))
4272                                         hanging = 0;
4273                                 else {
4274                                         /*
4275                                          * Need to follow the parent chain to see if it is hanging.
4276                                          */
4277                                         hanging = 0;
4278                                         depthLimit=100;
4279
4280                                         while(parent != dev->rootDir &&
4281                                                 parent->parent &&
4282                                                 parent->parent->variantType == YAFFS_OBJECT_TYPE_DIRECTORY &&
4283                                                 depthLimit > 0){
4284                                                 parent = parent->parent;
4285                                                 depthLimit--;
4286                                         }
4287                                         if(parent != dev->rootDir)
4288                                                 hanging = 1;
4289                                 }
4290                                 if(hanging){
4291                                         T(YAFFS_TRACE_SCAN,
4292                                           (TSTR("Hanging object %d moved to lost and found" TENDSTR),
4293                                                 obj->objectId));
4294                                         yaffs_AddObjectToDirectory(dev->lostNFoundDir,obj);
4295                                 }
4296                         }
4297                 }
4298         }
4299 }
4300
4301
4302 /*
4303  * Delete directory contents for cleaning up lost and found.
4304  */
4305 static void yaffs_DeleteDirectoryContents(yaffs_Object *dir)
4306 {
4307         yaffs_Object *obj;
4308         struct ylist_head *lh;
4309         struct ylist_head *n;
4310
4311         if(dir->variantType != YAFFS_OBJECT_TYPE_DIRECTORY)
4312                 YBUG();
4313
4314         ylist_for_each_safe(lh, n, &dir->variant.directoryVariant.children) {
4315                 if (lh) {
4316                         obj = ylist_entry(lh, yaffs_Object, siblings);
4317                         if(obj->variantType == YAFFS_OBJECT_TYPE_DIRECTORY)
4318                                 yaffs_DeleteDirectoryContents(obj);
4319
4320                         T(YAFFS_TRACE_SCAN,
4321                                 (TSTR("Deleting lost_found object %d" TENDSTR),
4322                                 obj->objectId));
4323
4324                         /* Need to use UnlinkObject since Delete would not handle
4325                          * hardlinked objects correctly.
4326                          */
4327                         yaffs_UnlinkObject(obj);
4328                 }
4329         }
4330
4331 }
4332
4333 static void yaffs_EmptyLostAndFound(yaffs_Device *dev)
4334 {
4335         yaffs_DeleteDirectoryContents(dev->lostNFoundDir);
4336 }
4337
4338 static void yaffs_CheckObjectDetailsLoaded(yaffs_Object *in)
4339 {
4340         __u8 *chunkData;
4341         yaffs_ObjectHeader *oh;
4342         yaffs_Device *dev;
4343         yaffs_ExtendedTags tags;
4344         int result;
4345         int alloc_failed = 0;
4346
4347         if (!in)
4348                 return;
4349
4350         dev = in->myDev;
4351
4352 #if 0
4353         T(YAFFS_TRACE_SCAN, (TSTR("details for object %d %s loaded" TENDSTR),
4354                 in->objectId,
4355                 in->lazyLoaded ? "not yet" : "already"));
4356 #endif
4357
4358         if (in->lazyLoaded && in->hdrChunk > 0) {
4359                 in->lazyLoaded = 0;
4360                 chunkData = yaffs_GetTempBuffer(dev, __LINE__);
4361
4362                 result = yaffs_ReadChunkWithTagsFromNAND(dev, in->hdrChunk, chunkData, &tags);
4363                 oh = (yaffs_ObjectHeader *) chunkData;
4364
4365                 in->yst_mode = oh->yst_mode;
4366 #ifdef CONFIG_YAFFS_WINCE
4367                 in->win_atime[0] = oh->win_atime[0];
4368                 in->win_ctime[0] = oh->win_ctime[0];
4369                 in->win_mtime[0] = oh->win_mtime[0];
4370                 in->win_atime[1] = oh->win_atime[1];
4371                 in->win_ctime[1] = oh->win_ctime[1];
4372                 in->win_mtime[1] = oh->win_mtime[1];
4373 #else
4374                 in->yst_uid = oh->yst_uid;
4375                 in->yst_gid = oh->yst_gid;
4376                 in->yst_atime = oh->yst_atime;
4377                 in->yst_mtime = oh->yst_mtime;
4378                 in->yst_ctime = oh->yst_ctime;
4379                 in->yst_rdev = oh->yst_rdev;
4380
4381 #endif
4382                 yaffs_SetObjectNameFromOH(in, oh);
4383
4384                 if (in->variantType == YAFFS_OBJECT_TYPE_SYMLINK) {
4385                         in->variant.symLinkVariant.alias =
4386                                                     yaffs_CloneString(oh->alias);
4387                         if (!in->variant.symLinkVariant.alias)
4388                                 alloc_failed = 1; /* Not returned to caller */
4389                 }
4390
4391                 yaffs_ReleaseTempBuffer(dev, chunkData, __LINE__);
4392         }
4393 }
4394
4395 /*------------------------------  Directory Functions ----------------------------- */
4396
4397 /*
4398  *yaffs_UpdateParent() handles fixing a directories mtime and ctime when a new
4399  * link (ie. name) is created or deleted in the directory.
4400  *
4401  * ie.
4402  *   create dir/a : update dir's mtime/ctime
4403  *   rm dir/a:   update dir's mtime/ctime
4404  *   modify dir/a: don't update dir's mtimme/ctime
4405  *
4406  * This can be handled immediately or defered. Defering helps reduce the number
4407  * of updates when many files in a directory are changed within a brief period.
4408  *
4409  * If the directory updating is defered then yaffs_UpdateDirtyDirecories must be
4410  * called periodically.
4411  */
4412
4413 static void yaffs_UpdateParent(yaffs_Object *obj)
4414 {
4415         yaffs_Device *dev;
4416         if(!obj)
4417                 return;
4418 #ifndef CONFIG_YAFFS_WINCE
4419
4420         dev = obj->myDev;
4421         obj->dirty = 1;
4422         obj->yst_mtime = obj->yst_ctime = Y_CURRENT_TIME;
4423         if(dev->param.deferDirectoryUpdate){
4424                 struct ylist_head *link = &obj->variant.directoryVariant.dirty;
4425
4426                 if(ylist_empty(link)){
4427                         ylist_add(link,&dev->dirtyDirectories);
4428                         T(YAFFS_TRACE_BACKGROUND, (TSTR("Added object %d to dirty directories" TENDSTR),obj->objectId));
4429                 }
4430
4431         } else
4432                 yaffs_UpdateObjectHeader(obj, NULL, 0, 0, 0, NULL);
4433 #endif
4434 }
4435
4436 void yaffs_UpdateDirtyDirectories(yaffs_Device *dev)
4437 {
4438         struct ylist_head *link;
4439         yaffs_Object *obj;
4440         yaffs_DirectoryStructure *dS;
4441         yaffs_ObjectVariant *oV;
4442
4443         T(YAFFS_TRACE_BACKGROUND, (TSTR("Update dirty directories" TENDSTR)));
4444
4445         while(!ylist_empty(&dev->dirtyDirectories)){
4446                 link = dev->dirtyDirectories.next;
4447                 ylist_del_init(link);
4448
4449                 dS=ylist_entry(link,yaffs_DirectoryStructure,dirty);
4450                 oV = ylist_entry(dS,yaffs_ObjectVariant,directoryVariant);
4451                 obj = ylist_entry(oV,yaffs_Object,variant);
4452
4453                 T(YAFFS_TRACE_BACKGROUND, (TSTR("Update directory %d" TENDSTR), obj->objectId));
4454
4455                 if(obj->dirty)
4456                         yaffs_UpdateObjectHeader(obj, NULL, 0, 0, 0, NULL);
4457         }
4458 }
4459
4460 static void yaffs_RemoveObjectFromDirectory(yaffs_Object *obj)
4461 {
4462         yaffs_Device *dev = obj->myDev;
4463         yaffs_Object *parent;
4464
4465         yaffs_VerifyObjectInDirectory(obj);
4466         parent = obj->parent;
4467
4468         yaffs_VerifyDirectory(parent);
4469
4470         if (dev && dev->param.removeObjectCallback)
4471                 dev->param.removeObjectCallback(obj);
4472
4473
4474         ylist_del_init(&obj->siblings);
4475         obj->parent = NULL;
4476
4477         yaffs_VerifyDirectory(parent);
4478 }
4479
4480 void yaffs_AddObjectToDirectory(yaffs_Object *directory,
4481                                         yaffs_Object *obj)
4482 {
4483         if (!directory) {
4484                 T(YAFFS_TRACE_ALWAYS,
4485                   (TSTR
4486                    ("tragedy: Trying to add an object to a null pointer directory"
4487                     TENDSTR)));
4488                 YBUG();
4489                 return;
4490         }
4491         if (directory->variantType != YAFFS_OBJECT_TYPE_DIRECTORY) {
4492                 T(YAFFS_TRACE_ALWAYS,
4493                   (TSTR
4494                    ("tragedy: Trying to add an object to a non-directory"
4495                     TENDSTR)));
4496                 YBUG();
4497         }
4498
4499         if (obj->siblings.prev == NULL) {
4500                 /* Not initialised */
4501                 YBUG();
4502         }
4503
4504
4505         yaffs_VerifyDirectory(directory);
4506
4507         yaffs_RemoveObjectFromDirectory(obj);
4508
4509
4510         /* Now add it */
4511         ylist_add(&obj->siblings, &directory->variant.directoryVariant.children);
4512         obj->parent = directory;
4513
4514         if (directory == obj->myDev->unlinkedDir
4515                         || directory == obj->myDev->deletedDir) {
4516                 obj->unlinked = 1;
4517                 obj->myDev->nUnlinkedFiles++;
4518                 obj->renameAllowed = 0;
4519         }
4520
4521         yaffs_VerifyDirectory(directory);
4522         yaffs_VerifyObjectInDirectory(obj);
4523 }
4524
4525 yaffs_Object *yaffs_FindObjectByName(yaffs_Object *directory,
4526                                      const YCHAR *name)
4527 {
4528         int sum;
4529
4530         struct ylist_head *i;
4531         YCHAR buffer[YAFFS_MAX_NAME_LENGTH + 1];
4532
4533         yaffs_Object *l;
4534
4535         if (!name)
4536                 return NULL;
4537
4538         if (!directory) {
4539                 T(YAFFS_TRACE_ALWAYS,
4540                   (TSTR
4541                    ("tragedy: yaffs_FindObjectByName: null pointer directory"
4542                     TENDSTR)));
4543                 YBUG();
4544                 return NULL;
4545         }
4546         if (directory->variantType != YAFFS_OBJECT_TYPE_DIRECTORY) {
4547                 T(YAFFS_TRACE_ALWAYS,
4548                   (TSTR
4549                    ("tragedy: yaffs_FindObjectByName: non-directory" TENDSTR)));
4550                 YBUG();
4551         }
4552
4553         sum = yaffs_CalcNameSum(name);
4554
4555         ylist_for_each(i, &directory->variant.directoryVariant.children) {
4556                 if (i) {
4557                         l = ylist_entry(i, yaffs_Object, siblings);
4558
4559                         if (l->parent != directory)
4560                                 YBUG();
4561
4562                         yaffs_CheckObjectDetailsLoaded(l);
4563
4564                         /* Special case for lost-n-found */
4565                         if (l->objectId == YAFFS_OBJECTID_LOSTNFOUND) {
4566                                 if (yaffs_strcmp(name, YAFFS_LOSTNFOUND_NAME) == 0)
4567                                         return l;
4568                         } else if (yaffs_SumCompare(l->sum, sum) || l->hdrChunk <= 0) {
4569                                 /* LostnFound chunk called Objxxx
4570                                  * Do a real check
4571                                  */
4572                                 yaffs_GetObjectName(l, buffer,
4573                                                     YAFFS_MAX_NAME_LENGTH + 1);
4574                                 if (yaffs_strncmp(name, buffer, YAFFS_MAX_NAME_LENGTH) == 0)
4575                                         return l;
4576                         }
4577                 }
4578         }
4579
4580         return NULL;
4581 }
4582
4583
4584 #if 0
4585 int yaffs_ApplyToDirectoryChildren(yaffs_Object *theDir,
4586                                         int (*fn) (yaffs_Object *))
4587 {
4588         struct ylist_head *i;
4589         yaffs_Object *l;
4590
4591         if (!theDir) {
4592                 T(YAFFS_TRACE_ALWAYS,
4593                   (TSTR
4594                    ("tragedy: yaffs_FindObjectByName: null pointer directory"
4595                     TENDSTR)));
4596                 YBUG();
4597                 return YAFFS_FAIL;
4598         }
4599         if (theDir->variantType != YAFFS_OBJECT_TYPE_DIRECTORY) {
4600                 T(YAFFS_TRACE_ALWAYS,
4601                   (TSTR
4602                    ("tragedy: yaffs_FindObjectByName: non-directory" TENDSTR)));
4603                 YBUG();
4604                 return YAFFS_FAIL;
4605         }
4606
4607         ylist_for_each(i, &theDir->variant.directoryVariant.children) {
4608                 if (i) {
4609                         l = ylist_entry(i, yaffs_Object, siblings);
4610                         if (l && !fn(l))
4611                                 return YAFFS_FAIL;
4612                 }
4613         }
4614
4615         return YAFFS_OK;
4616
4617 }
4618 #endif
4619
4620 /* GetEquivalentObject dereferences any hard links to get to the
4621  * actual object.
4622  */
4623
4624 yaffs_Object *yaffs_GetEquivalentObject(yaffs_Object *obj)
4625 {
4626         if (obj && obj->variantType == YAFFS_OBJECT_TYPE_HARDLINK) {
4627                 /* We want the object id of the equivalent object, not this one */
4628                 obj = obj->variant.hardLinkVariant.equivalentObject;
4629                 yaffs_CheckObjectDetailsLoaded(obj);
4630         }
4631         return obj;
4632 }
4633
4634 /*
4635  *  A note or two on object names.
4636  *  * If the object name is missing, we then make one up in the form objnnn
4637  *
4638  *  * ASCII names are stored in the object header's name field from byte zero
4639  *  * Unicode names are historically stored starting from byte zero.
4640  *
4641  * Then there are automatic Unicode names...
4642  * The purpose of these is to save names in a way that can be read as
4643  * ASCII or Unicode names as appropriate, thus allowing a Unicode and ASCII
4644  * system to share files.
4645  *
4646  * These automatic unicode are stored slightly differently...
4647  *  - If the name can fit in the ASCII character space then they are saved as
4648  *    ascii names as per above.
4649  *  - If the name needs Unicode then the name is saved in Unicode
4650  *    starting at oh->name[1].
4651
4652  */
4653 static void yaffs_FixNullName(yaffs_Object * obj,YCHAR * name, int buffSize)
4654 {
4655         /* Create an object name if we could not find one. */
4656         if(yaffs_strnlen(name,YAFFS_MAX_NAME_LENGTH) == 0){
4657                 YCHAR locName[20];
4658                 YCHAR numString[20];
4659                 YCHAR *x = &numString[19];
4660                 unsigned v = obj->objectId;
4661                 numString[19] = 0;
4662                 while(v>0){
4663                         x--;
4664                         *x = '0' + (v % 10);
4665                         v /= 10;
4666                 }
4667                 /* make up a name */
4668                 yaffs_strcpy(locName, YAFFS_LOSTNFOUND_PREFIX);
4669                 yaffs_strcat(locName,x);
4670                 yaffs_strncpy(name, locName, buffSize - 1);
4671         }
4672 }
4673
4674 static void yaffs_LoadNameFromObjectHeader(yaffs_Device *dev,YCHAR *name, const YCHAR *ohName, int bufferSize)
4675 {
4676 #ifdef CONFIG_YAFFS_AUTO_UNICODE
4677         if(dev->param.autoUnicode){
4678                 if(*ohName){
4679                         /* It is an ASCII name, so do an ASCII to unicode conversion */
4680                         const char *asciiOhName = (const char *)ohName;
4681                         int n = bufferSize - 1;
4682                         while(n > 0 && *asciiOhName){
4683                                 *name = *asciiOhName;
4684                                 name++;
4685                                 asciiOhName++;
4686                                 n--;
4687                         }
4688                 } else
4689                         yaffs_strncpy(name,ohName+1, bufferSize -1);
4690         } else
4691 #endif
4692                 yaffs_strncpy(name, ohName, bufferSize - 1);
4693 }
4694
4695
4696 static void yaffs_LoadObjectHeaderFromName(yaffs_Device *dev, YCHAR *ohName, const YCHAR *name)
4697 {
4698 #ifdef CONFIG_YAFFS_AUTO_UNICODE
4699
4700         int isAscii;
4701         YCHAR *w;
4702
4703         if(dev->param.autoUnicode){
4704
4705                 isAscii = 1;
4706                 w = name;
4707
4708                 /* Figure out if the name will fit in ascii character set */
4709                 while(isAscii && *w){
4710                         if((*w) & 0xff00)
4711                                 isAscii = 0;
4712                         w++;
4713                 }
4714
4715                 if(isAscii){
4716                         /* It is an ASCII name, so do a unicode to ascii conversion */
4717                         char *asciiOhName = (char *)ohName;
4718                         int n = YAFFS_MAX_NAME_LENGTH  - 1;
4719                         while(n > 0 && *name){
4720                                 *asciiOhName= *name;
4721                                 name++;
4722                                 asciiOhName++;
4723                                 n--;
4724                         }
4725                 } else{
4726                         /* It is a unicode name, so save starting at the second YCHAR */
4727                         *ohName = 0;
4728                         yaffs_strncpy(ohName+1,name, YAFFS_MAX_NAME_LENGTH -2);
4729                 }
4730         }
4731         else
4732 #endif
4733                 yaffs_strncpy(ohName,name, YAFFS_MAX_NAME_LENGTH - 1);
4734
4735 }
4736
4737 int yaffs_GetObjectName(yaffs_Object * obj, YCHAR * name, int buffSize)
4738 {
4739         memset(name, 0, buffSize * sizeof(YCHAR));
4740
4741         yaffs_CheckObjectDetailsLoaded(obj);
4742
4743         if (obj->objectId == YAFFS_OBJECTID_LOSTNFOUND) {
4744                 yaffs_strncpy(name, YAFFS_LOSTNFOUND_NAME, buffSize - 1);
4745         }
4746 #ifdef CONFIG_YAFFS_SHORT_NAMES_IN_RAM
4747         else if (obj->shortName[0]) {
4748                 yaffs_strcpy(name, obj->shortName);
4749         }
4750 #endif
4751         else if(obj->hdrChunk > 0) {
4752                 int result;
4753                 __u8 *buffer = yaffs_GetTempBuffer(obj->myDev, __LINE__);
4754
4755                 yaffs_ObjectHeader *oh = (yaffs_ObjectHeader *) buffer;
4756
4757                 memset(buffer, 0, obj->myDev->nDataBytesPerChunk);
4758
4759                 if (obj->hdrChunk > 0) {
4760                         result = yaffs_ReadChunkWithTagsFromNAND(obj->myDev,
4761                                                         obj->hdrChunk, buffer,
4762                                                         NULL);
4763                 }
4764                 yaffs_LoadNameFromObjectHeader(obj->myDev,name,oh->name,buffSize);
4765
4766                 yaffs_ReleaseTempBuffer(obj->myDev, buffer, __LINE__);
4767         }
4768
4769         yaffs_FixNullName(obj,name,buffSize);
4770
4771         return yaffs_strnlen(name,YAFFS_MAX_NAME_LENGTH);
4772 }
4773
4774
4775 int yaffs_GetObjectFileLength(yaffs_Object *obj)
4776 {
4777         /* Dereference any hard linking */
4778         obj = yaffs_GetEquivalentObject(obj);
4779
4780         if (obj->variantType == YAFFS_OBJECT_TYPE_FILE)
4781                 return obj->variant.fileVariant.fileSize;
4782         if (obj->variantType == YAFFS_OBJECT_TYPE_SYMLINK){
4783                 if(!obj->variant.symLinkVariant.alias)
4784                         return 0;
4785                 return yaffs_strnlen(obj->variant.symLinkVariant.alias,YAFFS_MAX_ALIAS_LENGTH);
4786         } else {
4787                 /* Only a directory should drop through to here */
4788                 return obj->myDev->nDataBytesPerChunk;
4789         }
4790 }
4791
4792 int yaffs_GetObjectLinkCount(yaffs_Object *obj)
4793 {
4794         int count = 0;
4795         struct ylist_head *i;
4796
4797         if (!obj->unlinked)
4798                 count++;                /* the object itself */
4799
4800         ylist_for_each(i, &obj->hardLinks)
4801                 count++;                /* add the hard links; */
4802
4803         return count;
4804 }
4805
4806 int yaffs_GetObjectInode(yaffs_Object *obj)
4807 {
4808         obj = yaffs_GetEquivalentObject(obj);
4809
4810         return obj->objectId;
4811 }
4812
4813 unsigned yaffs_GetObjectType(yaffs_Object *obj)
4814 {
4815         obj = yaffs_GetEquivalentObject(obj);
4816
4817         switch (obj->variantType) {
4818         case YAFFS_OBJECT_TYPE_FILE:
4819                 return DT_REG;
4820                 break;
4821         case YAFFS_OBJECT_TYPE_DIRECTORY:
4822                 return DT_DIR;
4823                 break;
4824         case YAFFS_OBJECT_TYPE_SYMLINK:
4825                 return DT_LNK;
4826                 break;
4827         case YAFFS_OBJECT_TYPE_HARDLINK:
4828                 return DT_REG;
4829                 break;
4830         case YAFFS_OBJECT_TYPE_SPECIAL:
4831                 if (S_ISFIFO(obj->yst_mode))
4832                         return DT_FIFO;
4833                 if (S_ISCHR(obj->yst_mode))
4834                         return DT_CHR;
4835                 if (S_ISBLK(obj->yst_mode))
4836                         return DT_BLK;
4837                 if (S_ISSOCK(obj->yst_mode))
4838                         return DT_SOCK;
4839         default:
4840                 return DT_REG;
4841                 break;
4842         }
4843 }
4844
4845 YCHAR *yaffs_GetSymlinkAlias(yaffs_Object *obj)
4846 {
4847         obj = yaffs_GetEquivalentObject(obj);
4848         if (obj->variantType == YAFFS_OBJECT_TYPE_SYMLINK)
4849                 return yaffs_CloneString(obj->variant.symLinkVariant.alias);
4850         else
4851                 return yaffs_CloneString(_Y(""));
4852 }
4853
4854 #ifndef CONFIG_YAFFS_WINCE
4855
4856 int yaffs_SetAttributes(yaffs_Object *obj, struct iattr *attr)
4857 {
4858         unsigned int valid = attr->ia_valid;
4859
4860         if (valid & ATTR_MODE)
4861                 obj->yst_mode = attr->ia_mode;
4862         if (valid & ATTR_UID)
4863                 obj->yst_uid = attr->ia_uid;
4864         if (valid & ATTR_GID)
4865                 obj->yst_gid = attr->ia_gid;
4866
4867         if (valid & ATTR_ATIME)
4868                 obj->yst_atime = Y_TIME_CONVERT(attr->ia_atime);
4869         if (valid & ATTR_CTIME)
4870                 obj->yst_ctime = Y_TIME_CONVERT(attr->ia_ctime);
4871         if (valid & ATTR_MTIME)
4872                 obj->yst_mtime = Y_TIME_CONVERT(attr->ia_mtime);
4873
4874         if (valid & ATTR_SIZE)
4875                 yaffs_ResizeFile(obj, attr->ia_size);
4876
4877         yaffs_UpdateObjectHeader(obj, NULL, 1, 0, 0, NULL);
4878
4879         return YAFFS_OK;
4880
4881 }
4882 int yaffs_GetAttributes(yaffs_Object *obj, struct iattr *attr)
4883 {
4884         unsigned int valid = 0;
4885
4886         attr->ia_mode = obj->yst_mode;
4887         valid |= ATTR_MODE;
4888         attr->ia_uid = obj->yst_uid;
4889         valid |= ATTR_UID;
4890         attr->ia_gid = obj->yst_gid;
4891         valid |= ATTR_GID;
4892
4893         Y_TIME_CONVERT(attr->ia_atime) = obj->yst_atime;
4894         valid |= ATTR_ATIME;
4895         Y_TIME_CONVERT(attr->ia_ctime) = obj->yst_ctime;
4896         valid |= ATTR_CTIME;
4897         Y_TIME_CONVERT(attr->ia_mtime) = obj->yst_mtime;
4898         valid |= ATTR_MTIME;
4899
4900         attr->ia_size = yaffs_GetFileSize(obj);
4901         valid |= ATTR_SIZE;
4902
4903         attr->ia_valid = valid;
4904
4905         return YAFFS_OK;
4906 }
4907
4908 #endif
4909
4910
4911 static int yaffs_DoXMod(yaffs_Object *obj, int set, const YCHAR *name, const void *value, int size, int flags)
4912 {
4913         yaffs_XAttrMod xmod;
4914
4915         int result;
4916
4917         xmod.set = set;
4918         xmod.name = name;
4919         xmod.data = value;
4920         xmod.size =  size;
4921         xmod.flags = flags;
4922         xmod.result = -ENOSPC;
4923
4924         result = yaffs_UpdateObjectHeader(obj, NULL, 0, 0, 0, &xmod);
4925
4926         if(result > 0)
4927                 return xmod.result;
4928         else
4929                 return -ENOSPC;
4930 }
4931
4932 static int yaffs_ApplyXMod(yaffs_Device *dev, char *buffer, yaffs_XAttrMod *xmod)
4933 {
4934         int retval = 0;
4935         int x_offs = sizeof(yaffs_ObjectHeader);
4936         int x_size = dev->nDataBytesPerChunk - sizeof(yaffs_ObjectHeader);
4937
4938         char * x_buffer = buffer + x_offs;
4939
4940         if(xmod->set)
4941                 retval = nval_set(x_buffer, x_size, xmod->name, xmod->data, xmod->size, xmod->flags);
4942         else
4943                 retval = nval_del(x_buffer, x_size, xmod->name);
4944
4945         xmod->result = retval;
4946
4947         return retval;
4948 }
4949
4950 static int yaffs_DoXFetch(yaffs_Object *obj, const YCHAR *name, void *value, int size)
4951 {
4952         char *buffer = NULL;
4953         int result;
4954         yaffs_ExtendedTags tags;
4955         yaffs_Device *dev = obj->myDev;
4956         int x_offs = sizeof(yaffs_ObjectHeader);
4957         int x_size = dev->nDataBytesPerChunk - sizeof(yaffs_ObjectHeader);
4958
4959         __u8 * x_buffer;
4960
4961         int retval = 0;
4962
4963         if(obj->hdrChunk < 1)
4964                 return -ENODATA;
4965
4966         buffer = yaffs_GetTempBuffer(dev, __LINE__);
4967         if(!buffer)
4968                 return -ENOMEM;
4969
4970         result = yaffs_ReadChunkWithTagsFromNAND(dev,obj->hdrChunk, buffer, &tags);
4971
4972         if(result != YAFFS_OK)
4973                 retval = -ENOENT;
4974         else{
4975                 x_buffer =  buffer + x_offs;
4976
4977                 if(name)
4978                         retval = nval_get(x_buffer, x_size, name, value, size);
4979                 else
4980                         retval = nval_list(x_buffer, x_size, value,size);
4981         }
4982         yaffs_ReleaseTempBuffer(dev,buffer,__LINE__);
4983         return retval;
4984 }
4985
4986 int yaffs_SetXAttribute(yaffs_Object *obj, const YCHAR *name, const void * value, int size, int flags)
4987 {
4988         return yaffs_DoXMod(obj, 1, name, value, size, flags);
4989 }
4990
4991 int yaffs_RemoveXAttribute(yaffs_Object *obj, const YCHAR *name)
4992 {
4993         return yaffs_DoXMod(obj, 0, name, NULL, 0, 0);
4994 }
4995
4996 int yaffs_GetXAttribute(yaffs_Object *obj, const YCHAR *name, void *value, int size)
4997 {
4998         return yaffs_DoXFetch(obj, name, value, size);
4999 }
5000
5001 int yaffs_ListXAttributes(yaffs_Object *obj, char *buffer, int size)
5002 {
5003         return yaffs_DoXFetch(obj, NULL, buffer,size);
5004 }
5005
5006
5007
5008 #if 0
5009 int yaffs_DumpObject(yaffs_Object *obj)
5010 {
5011         YCHAR name[257];
5012
5013         yaffs_GetObjectName(obj, name, YAFFS_MAX_NAME_LENGTH + 1);
5014
5015         T(YAFFS_TRACE_ALWAYS,
5016           (TSTR
5017            ("Object %d, inode %d \"%s\"\n dirty %d valid %d serial %d sum %d"
5018             " chunk %d type %d size %d\n"
5019             TENDSTR), obj->objectId, yaffs_GetObjectInode(obj), name,
5020            obj->dirty, obj->valid, obj->serial, obj->sum, obj->hdrChunk,
5021            yaffs_GetObjectType(obj), yaffs_GetObjectFileLength(obj)));
5022
5023         return YAFFS_OK;
5024 }
5025 #endif
5026
5027 /*---------------------------- Initialisation code -------------------------------------- */
5028
5029 static int yaffs_CheckDevFunctions(const yaffs_Device *dev)
5030 {
5031
5032         /* Common functions, gotta have */
5033         if (!dev->param.eraseBlockInNAND || !dev->param.initialiseNAND)
5034                 return 0;
5035
5036 #ifdef CONFIG_YAFFS_YAFFS2
5037
5038         /* Can use the "with tags" style interface for yaffs1 or yaffs2 */
5039         if (dev->param.writeChunkWithTagsToNAND &&
5040             dev->param.readChunkWithTagsFromNAND &&
5041             !dev->param.writeChunkToNAND &&
5042             !dev->param.readChunkFromNAND &&
5043             dev->param.markNANDBlockBad &&
5044             dev->param.queryNANDBlock)
5045                 return 1;
5046 #endif
5047
5048         /* Can use the "spare" style interface for yaffs1 */
5049         if (!dev->param.isYaffs2 &&
5050             !dev->param.writeChunkWithTagsToNAND &&
5051             !dev->param.readChunkWithTagsFromNAND &&
5052             dev->param.writeChunkToNAND &&
5053             dev->param.readChunkFromNAND &&
5054             !dev->param.markNANDBlockBad &&
5055             !dev->param.queryNANDBlock)
5056                 return 1;
5057
5058         return 0;       /* bad */
5059 }
5060
5061
5062 static int yaffs_CreateInitialDirectories(yaffs_Device *dev)
5063 {
5064         /* Initialise the unlinked, deleted, root and lost and found directories */
5065
5066         dev->lostNFoundDir = dev->rootDir =  NULL;
5067         dev->unlinkedDir = dev->deletedDir = NULL;
5068
5069         dev->unlinkedDir =
5070             yaffs_CreateFakeDirectory(dev, YAFFS_OBJECTID_UNLINKED, S_IFDIR);
5071
5072         dev->deletedDir =
5073             yaffs_CreateFakeDirectory(dev, YAFFS_OBJECTID_DELETED, S_IFDIR);
5074
5075         dev->rootDir =
5076             yaffs_CreateFakeDirectory(dev, YAFFS_OBJECTID_ROOT,
5077                                       YAFFS_ROOT_MODE | S_IFDIR);
5078         dev->lostNFoundDir =
5079             yaffs_CreateFakeDirectory(dev, YAFFS_OBJECTID_LOSTNFOUND,
5080                                       YAFFS_LOSTNFOUND_MODE | S_IFDIR);
5081
5082         if (dev->lostNFoundDir && dev->rootDir && dev->unlinkedDir && dev->deletedDir) {
5083                 yaffs_AddObjectToDirectory(dev->rootDir, dev->lostNFoundDir);
5084                 return YAFFS_OK;
5085         }
5086
5087         return YAFFS_FAIL;
5088 }
5089
5090 int yaffs_GutsInitialise(yaffs_Device *dev)
5091 {
5092         int init_failed = 0;
5093         unsigned x;
5094         int bits;
5095
5096         T(YAFFS_TRACE_TRACING, (TSTR("yaffs: yaffs_GutsInitialise()" TENDSTR)));
5097
5098         /* Check stuff that must be set */
5099
5100         if (!dev) {
5101                 T(YAFFS_TRACE_ALWAYS, (TSTR("yaffs: Need a device" TENDSTR)));
5102                 return YAFFS_FAIL;
5103         }
5104
5105         dev->internalStartBlock = dev->param.startBlock;
5106         dev->internalEndBlock = dev->param.endBlock;
5107         dev->blockOffset = 0;
5108         dev->chunkOffset = 0;
5109         dev->nFreeChunks = 0;
5110
5111         dev->gcBlock = 0;
5112
5113         if (dev->param.startBlock == 0) {
5114                 dev->internalStartBlock = dev->param.startBlock + 1;
5115                 dev->internalEndBlock = dev->param.endBlock + 1;
5116                 dev->blockOffset = 1;
5117                 dev->chunkOffset = dev->param.nChunksPerBlock;
5118         }
5119
5120         /* Check geometry parameters. */
5121
5122         if ((!dev->param.inbandTags && dev->param.isYaffs2 && dev->param.totalBytesPerChunk < 1024) ||
5123             (!dev->param.isYaffs2 && dev->param.totalBytesPerChunk < 512) ||
5124             (dev->param.inbandTags && !dev->param.isYaffs2) ||
5125              dev->param.nChunksPerBlock < 2 ||
5126              dev->param.nReservedBlocks < 2 ||
5127              dev->internalStartBlock <= 0 ||
5128              dev->internalEndBlock <= 0 ||
5129              dev->internalEndBlock <= (dev->internalStartBlock + dev->param.nReservedBlocks + 2)) {     /* otherwise it is too small */
5130                 T(YAFFS_TRACE_ALWAYS,
5131                   (TSTR
5132                    ("yaffs: NAND geometry problems: chunk size %d, type is yaffs%s, inbandTags %d "
5133                     TENDSTR), dev->param.totalBytesPerChunk, dev->param.isYaffs2 ? "2" : "", dev->param.inbandTags));
5134                 return YAFFS_FAIL;
5135         }
5136
5137         if (yaffs_InitialiseNAND(dev) != YAFFS_OK) {
5138                 T(YAFFS_TRACE_ALWAYS,
5139                   (TSTR("yaffs: InitialiseNAND failed" TENDSTR)));
5140                 return YAFFS_FAIL;
5141         }
5142
5143         /* Sort out space for inband tags, if required */
5144         if (dev->param.inbandTags)
5145                 dev->nDataBytesPerChunk = dev->param.totalBytesPerChunk - sizeof(yaffs_PackedTags2TagsPart);
5146         else
5147                 dev->nDataBytesPerChunk = dev->param.totalBytesPerChunk;
5148
5149         /* Got the right mix of functions? */
5150         if (!yaffs_CheckDevFunctions(dev)) {
5151                 /* Function missing */
5152                 T(YAFFS_TRACE_ALWAYS,
5153                   (TSTR
5154                    ("yaffs: device function(s) missing or wrong\n" TENDSTR)));
5155
5156                 return YAFFS_FAIL;
5157         }
5158
5159         /* This is really a compilation check. */
5160         if (!yaffs_CheckStructures()) {
5161                 T(YAFFS_TRACE_ALWAYS,
5162                   (TSTR("yaffs_CheckStructures failed\n" TENDSTR)));
5163                 return YAFFS_FAIL;
5164         }
5165
5166         if (dev->isMounted) {
5167                 T(YAFFS_TRACE_ALWAYS,
5168                   (TSTR("yaffs: device already mounted\n" TENDSTR)));
5169                 return YAFFS_FAIL;
5170         }
5171
5172         /* Finished with most checks. One or two more checks happen later on too. */
5173
5174         dev->isMounted = 1;
5175
5176         /* OK now calculate a few things for the device */
5177
5178         /*
5179          *  Calculate all the chunk size manipulation numbers:
5180          */
5181         x = dev->nDataBytesPerChunk;
5182         /* We always use dev->chunkShift and dev->chunkDiv */
5183         dev->chunkShift = Shifts(x);
5184         x >>= dev->chunkShift;
5185         dev->chunkDiv = x;
5186         /* We only use chunk mask if chunkDiv is 1 */
5187         dev->chunkMask = (1<<dev->chunkShift) - 1;
5188
5189         /*
5190          * Calculate chunkGroupBits.
5191          * We need to find the next power of 2 > than internalEndBlock
5192          */
5193
5194         x = dev->param.nChunksPerBlock * (dev->internalEndBlock + 1);
5195
5196         bits = ShiftsGE(x);
5197
5198         /* Set up tnode width if wide tnodes are enabled. */
5199         if (!dev->param.wideTnodesDisabled) {
5200                 /* bits must be even so that we end up with 32-bit words */
5201                 if (bits & 1)
5202                         bits++;
5203                 if (bits < 16)
5204                         dev->tnodeWidth = 16;
5205                 else
5206                         dev->tnodeWidth = bits;
5207         } else
5208                 dev->tnodeWidth = 16;
5209
5210         dev->tnodeMask = (1<<dev->tnodeWidth)-1;
5211
5212         /* Level0 Tnodes are 16 bits or wider (if wide tnodes are enabled),
5213          * so if the bitwidth of the
5214          * chunk range we're using is greater than 16 we need
5215          * to figure out chunk shift and chunkGroupSize
5216          */
5217
5218         if (bits <= dev->tnodeWidth)
5219                 dev->chunkGroupBits = 0;
5220         else
5221                 dev->chunkGroupBits = bits - dev->tnodeWidth;
5222
5223         dev->tnodeSize = (dev->tnodeWidth * YAFFS_NTNODES_LEVEL0)/8;
5224         if(dev->tnodeSize < sizeof(yaffs_Tnode))
5225                 dev->tnodeSize = sizeof(yaffs_Tnode);
5226
5227         dev->chunkGroupSize = 1 << dev->chunkGroupBits;
5228
5229         if (dev->param.nChunksPerBlock < dev->chunkGroupSize) {
5230                 /* We have a problem because the soft delete won't work if
5231                  * the chunk group size > chunks per block.
5232                  * This can be remedied by using larger "virtual blocks".
5233                  */
5234                 T(YAFFS_TRACE_ALWAYS,
5235                   (TSTR("yaffs: chunk group too large\n" TENDSTR)));
5236
5237                 return YAFFS_FAIL;
5238         }
5239
5240         /* OK, we've finished verifying the device, lets continue with initialisation */
5241
5242         /* More device initialisation */
5243         dev->allGCs = 0;
5244         dev->passiveGCs = 0;
5245         dev->oldestDirtyGCs = 0;
5246         dev->backgroundGCs = 0;
5247         dev->gcBlockFinder = 0;
5248         dev->bufferedBlock = -1;
5249         dev->doingBufferedBlockRewrite = 0;
5250         dev->nDeletedFiles = 0;
5251         dev->nBackgroundDeletions = 0;
5252         dev->nUnlinkedFiles = 0;
5253         dev->eccFixed = 0;
5254         dev->eccUnfixed = 0;
5255         dev->tagsEccFixed = 0;
5256         dev->tagsEccUnfixed = 0;
5257         dev->nErasureFailures = 0;
5258         dev->nErasedBlocks = 0;
5259         dev->gcDisable= 0;
5260         dev->hasPendingPrioritisedGCs = 1; /* Assume the worst for now, will get fixed on first GC */
5261         YINIT_LIST_HEAD(&dev->dirtyDirectories);
5262         dev->oldestDirtySequence = 0;
5263         dev->oldestDirtyBlock = 0;
5264
5265         /* Initialise temporary buffers and caches. */
5266         if (!yaffs_InitialiseTempBuffers(dev))
5267                 init_failed = 1;
5268
5269         dev->srCache = NULL;
5270         dev->gcCleanupList = NULL;
5271
5272
5273         if (!init_failed &&
5274             dev->param.nShortOpCaches > 0) {
5275                 int i;
5276                 void *buf;
5277                 int srCacheBytes = dev->param.nShortOpCaches * sizeof(yaffs_ChunkCache);
5278
5279                 if (dev->param.nShortOpCaches > YAFFS_MAX_SHORT_OP_CACHES)
5280                         dev->param.nShortOpCaches = YAFFS_MAX_SHORT_OP_CACHES;
5281
5282                 dev->srCache =  YMALLOC(srCacheBytes);
5283
5284                 buf = (__u8 *) dev->srCache;
5285
5286                 if (dev->srCache)
5287                         memset(dev->srCache, 0, srCacheBytes);
5288
5289                 for (i = 0; i < dev->param.nShortOpCaches && buf; i++) {
5290                         dev->srCache[i].object = NULL;
5291                         dev->srCache[i].lastUse = 0;
5292                         dev->srCache[i].dirty = 0;
5293                         dev->srCache[i].data = buf = YMALLOC_DMA(dev->param.totalBytesPerChunk);
5294                 }
5295                 if (!buf)
5296                         init_failed = 1;
5297
5298                 dev->srLastUse = 0;
5299         }
5300
5301         dev->cacheHits = 0;
5302
5303         if (!init_failed) {
5304                 dev->gcCleanupList = YMALLOC(dev->param.nChunksPerBlock * sizeof(__u32));
5305                 if (!dev->gcCleanupList)
5306                         init_failed = 1;
5307         }
5308
5309         if (dev->param.isYaffs2)
5310                 dev->param.useHeaderFileSize = 1;
5311
5312         if (!init_failed && !yaffs_InitialiseBlocks(dev))
5313                 init_failed = 1;
5314
5315         yaffs_InitialiseTnodesAndObjects(dev);
5316
5317         if (!init_failed && !yaffs_CreateInitialDirectories(dev))
5318                 init_failed = 1;
5319
5320
5321         if (!init_failed) {
5322                 /* Now scan the flash. */
5323                 if (dev->param.isYaffs2) {
5324                         if (yaffs2_CheckpointRestore(dev)) {
5325                                 yaffs_CheckObjectDetailsLoaded(dev->rootDir);
5326                                 T(YAFFS_TRACE_ALWAYS,
5327                                   (TSTR("yaffs: restored from checkpoint" TENDSTR)));
5328                         } else {
5329
5330                                 /* Clean up the mess caused by an aborted checkpoint load
5331                                  * and scan backwards.
5332                                  */
5333                                 yaffs_DeinitialiseBlocks(dev);
5334
5335                                 yaffs_DeinitialiseTnodesAndObjects(dev);
5336
5337                                 dev->nErasedBlocks = 0;
5338                                 dev->nFreeChunks = 0;
5339                                 dev->allocationBlock = -1;
5340                                 dev->allocationPage = -1;
5341                                 dev->nDeletedFiles = 0;
5342                                 dev->nUnlinkedFiles = 0;
5343                                 dev->nBackgroundDeletions = 0;
5344
5345                                 if (!init_failed && !yaffs_InitialiseBlocks(dev))
5346                                         init_failed = 1;
5347
5348                                 yaffs_InitialiseTnodesAndObjects(dev);
5349
5350                                 if (!init_failed && !yaffs_CreateInitialDirectories(dev))
5351                                         init_failed = 1;
5352
5353                                 if (!init_failed && !yaffs2_ScanBackwards(dev))
5354                                         init_failed = 1;
5355                         }
5356                 } else if (!yaffs1_Scan(dev))
5357                                 init_failed = 1;
5358
5359                 yaffs_StripDeletedObjects(dev);
5360                 yaffs_FixHangingObjects(dev);
5361                 if(dev->param.emptyLostAndFound)
5362                         yaffs_EmptyLostAndFound(dev);
5363         }
5364
5365         if (init_failed) {
5366                 /* Clean up the mess */
5367                 T(YAFFS_TRACE_TRACING,
5368                   (TSTR("yaffs: yaffs_GutsInitialise() aborted.\n" TENDSTR)));
5369
5370                 yaffs_Deinitialise(dev);
5371                 return YAFFS_FAIL;
5372         }
5373
5374         /* Zero out stats */
5375         dev->nPageReads = 0;
5376         dev->nPageWrites = 0;
5377         dev->nBlockErasures = 0;
5378         dev->nGCCopies = 0;
5379         dev->nRetriedWrites = 0;
5380
5381         dev->nRetiredBlocks = 0;
5382
5383         yaffs_VerifyFreeChunks(dev);
5384         yaffs_VerifyBlocks(dev);
5385
5386         /* Clean up any aborted checkpoint data */
5387         if(!dev->isCheckpointed && dev->blocksInCheckpoint > 0)
5388                 yaffs2_InvalidateCheckpoint(dev);
5389
5390         T(YAFFS_TRACE_TRACING,
5391           (TSTR("yaffs: yaffs_GutsInitialise() done.\n" TENDSTR)));
5392         return YAFFS_OK;
5393
5394 }
5395
5396 void yaffs_Deinitialise(yaffs_Device *dev)
5397 {
5398         if (dev->isMounted) {
5399                 int i;
5400
5401                 yaffs_DeinitialiseBlocks(dev);
5402                 yaffs_DeinitialiseTnodesAndObjects(dev);
5403                 if (dev->param.nShortOpCaches > 0 &&
5404                     dev->srCache) {
5405
5406                         for (i = 0; i < dev->param.nShortOpCaches; i++) {
5407                                 if (dev->srCache[i].data)
5408                                         YFREE(dev->srCache[i].data);
5409                                 dev->srCache[i].data = NULL;
5410                         }
5411
5412                         YFREE(dev->srCache);
5413                         dev->srCache = NULL;
5414                 }
5415
5416                 YFREE(dev->gcCleanupList);
5417
5418                 for (i = 0; i < YAFFS_N_TEMP_BUFFERS; i++)
5419                         YFREE(dev->tempBuffer[i].buffer);
5420
5421                 dev->isMounted = 0;
5422
5423                 if (dev->param.deinitialiseNAND)
5424                         dev->param.deinitialiseNAND(dev);
5425         }
5426 }
5427
5428 int yaffs_CountFreeChunks(yaffs_Device *dev)
5429 {
5430         int nFree=0;
5431         int b;
5432
5433         yaffs_BlockInfo *blk;
5434
5435         blk = dev->blockInfo;
5436         for (b = dev->internalStartBlock; b <= dev->internalEndBlock; b++) {
5437                 switch (blk->blockState) {
5438                 case YAFFS_BLOCK_STATE_EMPTY:
5439                 case YAFFS_BLOCK_STATE_ALLOCATING:
5440                 case YAFFS_BLOCK_STATE_COLLECTING:
5441                 case YAFFS_BLOCK_STATE_FULL:
5442                         nFree +=
5443                             (dev->param.nChunksPerBlock - blk->pagesInUse +
5444                              blk->softDeletions);
5445                         break;
5446                 default:
5447                         break;
5448                 }
5449                 blk++;
5450         }
5451
5452         return nFree;
5453 }
5454
5455 int yaffs_GetNumberOfFreeChunks(yaffs_Device *dev)
5456 {
5457         /* This is what we report to the outside world */
5458
5459         int nFree;
5460         int nDirtyCacheChunks;
5461         int blocksForCheckpoint;
5462         int i;
5463
5464 #if 1
5465         nFree = dev->nFreeChunks;
5466 #else
5467         nFree = yaffs_CountFreeChunks(dev);
5468 #endif
5469
5470         nFree += dev->nDeletedFiles;
5471
5472         /* Now count the number of dirty chunks in the cache and subtract those */
5473
5474         for (nDirtyCacheChunks = 0, i = 0; i < dev->param.nShortOpCaches; i++) {
5475                 if (dev->srCache[i].dirty)
5476                         nDirtyCacheChunks++;
5477         }
5478
5479         nFree -= nDirtyCacheChunks;
5480
5481         nFree -= ((dev->param.nReservedBlocks + 1) * dev->param.nChunksPerBlock);
5482
5483         /* Now we figure out how much to reserve for the checkpoint and report that... */
5484         blocksForCheckpoint = yaffs2_CalcCheckpointBlocksRequired(dev);
5485
5486         nFree -= (blocksForCheckpoint * dev->param.nChunksPerBlock);
5487
5488         if (nFree < 0)
5489                 nFree = 0;
5490
5491         return nFree;
5492
5493 }
5494
5495
5496 /*---------------------------------------- YAFFS test code ----------------------*/
5497
5498 #define yaffs_CheckStruct(structure, syze, name) \
5499         do { \
5500                 if (sizeof(structure) != syze) { \
5501                         T(YAFFS_TRACE_ALWAYS, (TSTR("%s should be %d but is %d\n" TENDSTR),\
5502                                 name, syze, (int) sizeof(structure))); \
5503                         return YAFFS_FAIL; \
5504                 } \
5505         } while (0)
5506
5507 static int yaffs_CheckStructures(void)
5508 {
5509 /*      yaffs_CheckStruct(yaffs_Tags,8,"yaffs_Tags"); */
5510 /*      yaffs_CheckStruct(yaffs_TagsUnion,8,"yaffs_TagsUnion"); */
5511 /*      yaffs_CheckStruct(yaffs_Spare,16,"yaffs_Spare"); */
5512 #ifndef CONFIG_YAFFS_TNODE_LIST_DEBUG
5513 /*      yaffs_CheckStruct(yaffs_Tnode, 2 * YAFFS_NTNODES_LEVEL0, "yaffs_Tnode"); */
5514 #endif
5515 #ifndef CONFIG_YAFFS_WINCE
5516         yaffs_CheckStruct(yaffs_ObjectHeader, 512, "yaffs_ObjectHeader");
5517 #endif
5518         return YAFFS_OK;
5519 }