yaffs_guts.c

   1 /*
   2  * YAFFS: Yet another FFS. A NAND-flash specific file system.
   3  * yaffs_guts.c  The main guts of YAFFS
   4  *
   5  * Copyright (C) 2002 Aleph One Ltd.
   6  *   for Toby Churchill Ltd and Brightstar Engineering
   7  *
   8  * Created by Charles Manning <charles@aleph1.co.uk>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License version 2 as
  12  * published by the Free Software Foundation.
  13  *
  14  */
  15  //yaffs_guts.c
  16
  17 const char *yaffs_guts_c_version="$Id: yaffs_guts.c,v 1.34 2004-06-08 08:47:55 charles Exp $";
  18
  19 #include "yportenv.h"
  20
  21 #include "yaffsinterface.h"
  22 #include "yaffs_guts.h"
  23
  24 #define YAFFS_PASSIVE_GC_CHUNKS 2
  25
  26 #if 0
  27 // Use Steven Hill's ECC struff instead
  28 // External functions for ECC on data
  29 void nand_calculate_ecc (const u_char *dat, u_char *ecc_code);
  30 int nand_correct_data (u_char *dat, u_char *read_ecc, u_char *calc_ecc);
  31 #define yaffs_ECCCalculate(data,ecc) nand_calculate_ecc(data,ecc)
  32 #define yaffs_ECCCorrect(data,read_ecc,calc_ecc) nand_correct_ecc(data,read_ecc,calc_ecc)
  33 #else
  34 #include "yaffs_ecc.h"
  35 #endif
  36
  37 // countBits is a quick way of counting the number of bits in a byte.
  38 // ie. countBits[n] holds the number of 1 bits in a byte with the value n.
  39
  40 static const char yaffs_countBitsTable[256] =
  41 {
  42 0,1,1,2,1,2,2,3,1,2,2,3,2,3,3,4,
  43 1,2,2,3,2,3,3,4,2,3,3,4,3,4,4,5,
  44 1,2,2,3,2,3,3,4,2,3,3,4,3,4,4,5,
  45 2,3,3,4,3,4,4,5,3,4,4,5,4,5,5,6,
  46 1,2,2,3,2,3,3,4,2,3,3,4,3,4,4,5,
  47 2,3,3,4,3,4,4,5,3,4,4,5,4,5,5,6,
  48 2,3,3,4,3,4,4,5,3,4,4,5,4,5,5,6,
  49 3,4,4,5,4,5,5,6,4,5,5,6,5,6,6,7,
  50 1,2,2,3,2,3,3,4,2,3,3,4,3,4,4,5,
  51 2,3,3,4,3,4,4,5,3,4,4,5,4,5,5,6,
  52 2,3,3,4,3,4,4,5,3,4,4,5,4,5,5,6,
  53 3,4,4,5,4,5,5,6,4,5,5,6,5,6,6,7,
  54 2,3,3,4,3,4,4,5,3,4,4,5,4,5,5,6,
  55 3,4,4,5,4,5,5,6,4,5,5,6,5,6,6,7,
  56 3,4,4,5,4,5,5,6,4,5,5,6,5,6,6,7,
  57 4,5,5,6,5,6,6,7,5,6,6,7,6,7,7,8
  58 };
  59
  60 static int yaffs_CountBits(__u8 x)
  61 {
  62         int retVal;
  63         retVal = yaffs_countBitsTable[x];
  64         return retVal;
  65 }
  66
  67
  68
  69 // Local prototypes
  70 static int yaffs_CheckObjectHashSanity(yaffs_Device *dev);
  71 static void yaffs_LoadTagsIntoSpare(yaffs_Spare *sparePtr, yaffs_Tags *tagsPtr);
  72 static void yaffs_GetTagsFromSpare(yaffs_Device *dev, yaffs_Spare *sparePtr,yaffs_Tags *tagsPtr);
  73 static int yaffs_PutChunkIntoFile(yaffs_Object *in,int chunkInInode, int chunkInNAND, int inScan);
  74
  75 static yaffs_Object *yaffs_CreateNewObject(yaffs_Device *dev,int number,yaffs_ObjectType type);
  76 static void yaffs_AddObjectToDirectory(yaffs_Object *directory, yaffs_Object *obj);
  77 static int yaffs_UpdateObjectHeader(yaffs_Object *in,const char *name, int force);
  78 static void yaffs_DeleteChunk(yaffs_Device *dev,int chunkId,int markNAND);
  79 static void yaffs_RemoveObjectFromDirectory(yaffs_Object *obj);
  80 static int yaffs_CheckStructures(void);
  81 static int yaffs_DeleteWorker(yaffs_Object *in, yaffs_Tnode *tn, __u32 level, int chunkOffset,int *limit);
  82 static int yaffs_DoGenericObjectDeletion(yaffs_Object *in);
  83
  84 static yaffs_BlockInfo *yaffs_GetBlockInfo(yaffs_Device *dev,int blockNo);
  85
  86 // Robustification
  87 static void yaffs_RetireBlock(yaffs_Device *dev,int blockInNAND);
  88 static void yaffs_HandleReadDataError(yaffs_Device *dev,int chunkInNAND);
  89 static void yaffs_HandleWriteChunkError(yaffs_Device *dev,int chunkInNAND);
  90 static void yaffs_HandleWriteChunkOk(yaffs_Device *dev,int chunkInNAND,const __u8 *data, const yaffs_Spare *spare);
  91 static void yaffs_HandleUpdateChunk(yaffs_Device *dev,int chunkInNAND, const yaffs_Spare *spare);
  92
  93 static int  yaffs_CheckChunkErased(struct yaffs_DeviceStruct *dev,int chunkInNAND);
  94
  95 static int yaffs_UnlinkWorker(yaffs_Object *obj);
  96 static void yaffs_AbortHalfCreatedObject(yaffs_Object *obj);
  97
  98 static int yaffs_VerifyCompare(const __u8 *d0, const __u8 * d1, const yaffs_Spare *s0, const yaffs_Spare *s1);
  99
 100
 101
 102 loff_t yaffs_GetFileSize(yaffs_Object *obj);
 103
 104 static int yaffs_ReadChunkTagsFromNAND(yaffs_Device *dev,int chunkInNAND, yaffs_Tags *tags, int *chunkDeleted);
 105 static int yaffs_TagsMatch(const yaffs_Tags *tags, int objectId, int chunkInObject, int chunkDeleted);
 106
 107
 108 static int yaffs_AllocateChunk(yaffs_Device *dev,int useReserve);
 109
 110 #ifdef YAFFS_PARANOID
 111 static int yaffs_CheckFileSanity(yaffs_Object *in);
 112 #else
 113 #define yaffs_CheckFileSanity(in)
 114 #endif
 115
 116 static void yaffs_InvalidateWholeChunkCache(yaffs_Object *in);
 117 static void yaffs_InvalidateChunkCache(yaffs_Object *object, int chunkId);
 118
 119 // Chunk bitmap manipulations
 120
 121 static __inline __u8 *yaffs_BlockBits(yaffs_Device *dev, int blk)
 122 {
 123         if(blk < dev->startBlock || blk > dev->endBlock)
 124         {
 125                 T(YAFFS_TRACE_ERROR,(TSTR("**>> yaffs: BlockBits block %d is not valid" TENDSTR),blk));
 126                 YBUG();
 127         }
 128         return dev->chunkBits + (dev->chunkBitmapStride * (blk - dev->startBlock));
 129 }
 130
 131 static __inline__ void yaffs_ClearChunkBits(yaffs_Device *dev,int blk)
 132 {
 133         __u8 *blkBits = yaffs_BlockBits(dev,blk);
 134
 135          memset(blkBits,0,dev->chunkBitmapStride);
 136 }
 137
 138 static __inline__ void yaffs_ClearChunkBit(yaffs_Device *dev,int blk,int chunk)
 139 {
 140         __u8 *blkBits = yaffs_BlockBits(dev,blk);
 141
 142         blkBits[chunk/8] &=  ~ (1<<(chunk & 7));
 143 }
 144
 145 static __inline__ void yaffs_SetChunkBit(yaffs_Device *dev,int blk,int chunk)
 146 {
 147         __u8 *blkBits = yaffs_BlockBits(dev,blk);
 148
 149         blkBits[chunk/8] |=   (1<<(chunk & 7));
 150 }
 151
 152 static __inline__ int yaffs_CheckChunkBit(yaffs_Device *dev,int blk,int chunk)
 153 {
 154         __u8 *blkBits = yaffs_BlockBits(dev,blk);
 155         return (blkBits[chunk/8] &  (1<<(chunk & 7))) ? 1 :0;
 156 }
 157
 158 static __inline__ int yaffs_StillSomeChunkBits(yaffs_Device *dev,int blk)
 159 {
 160         __u8 *blkBits = yaffs_BlockBits(dev,blk);
 161         int i;
 162         for(i = 0; i < dev->chunkBitmapStride; i++)
 163         {
 164                 if(*blkBits) return 1;
 165                 blkBits++;
 166         }
 167         return 0;
 168 }
 169
 170 // Function to manipulate block info
 171 static  __inline__ yaffs_BlockInfo* yaffs_GetBlockInfo(yaffs_Device *dev, int blk)
 172 {
 173         if(blk < dev->startBlock || blk > dev->endBlock)
 174         {
 175                 T(YAFFS_TRACE_ERROR,(TSTR("**>> yaffs: getBlockInfo block %d is not valid" TENDSTR),blk));
 176                 YBUG();
 177         }
 178         return &dev->blockInfo[blk - dev->startBlock];
 179 }
 180
 181
 182 static  __inline__ int yaffs_HashFunction(int n)
 183 {
 184         return (n % YAFFS_NOBJECT_BUCKETS);
 185 }
 186
 187
 188 yaffs_Object *yaffs_Root(yaffs_Device *dev)
 189 {
 190         return dev->rootDir;
 191 }
 192
 193 yaffs_Object *yaffs_LostNFound(yaffs_Device *dev)
 194 {
 195         return dev->lostNFoundDir;
 196 }
 197
 198
 199 static int yaffs_WriteChunkToNAND(struct yaffs_DeviceStruct *dev,int chunkInNAND, const __u8 *data, yaffs_Spare *spare)
 200 {
 201         if(chunkInNAND < dev->startBlock * dev->nChunksPerBlock)
 202         {
 203                 T(YAFFS_TRACE_ERROR,(TSTR("**>> yaffs chunk %d is not valid" TENDSTR),chunkInNAND));
 204                 return YAFFS_FAIL;
 205         }
 206
 207         dev->nPageWrites++;
 208         return dev->writeChunkToNAND(dev,chunkInNAND,data,spare);
 209 }
 210
 211
 212
 213 int yaffs_ReadChunkFromNAND(struct yaffs_DeviceStruct *dev,
 214                                                         int chunkInNAND,
 215                                                         __u8 *data,
 216                                                         yaffs_Spare *spare,
 217                                                         int doErrorCorrection)
 218 {
 219         int retVal;
 220         yaffs_Spare localSpare;
 221
 222         dev->nPageReads++;
 223
 224
 225
 226
 227         if(!spare && data)
 228         {
 229                 // If we don't have a real spare, then we use a local one.
 230                 // Need this for the calculation of the ecc
 231                 spare = &localSpare;
 232         }
 233
 234
 235         if(!dev->useNANDECC)
 236         {
 237                 retVal  = dev->readChunkFromNAND(dev,chunkInNAND,data,spare);
 238                 if(data && doErrorCorrection)
 239                 {
 240                         // Do ECC correction
 241                         //Todo handle any errors
 242                 int eccResult1,eccResult2;
 243                 __u8 calcEcc[3];
 244
 245                         yaffs_ECCCalculate(data,calcEcc);
 246                         eccResult1 = yaffs_ECCCorrect (data,spare->ecc1, calcEcc);
 247                         yaffs_ECCCalculate(&data[256],calcEcc);
 248                         eccResult2 = yaffs_ECCCorrect(&data[256],spare->ecc2, calcEcc);
 249
 250                         if(eccResult1>0)
 251                         {
 252                                 T(YAFFS_TRACE_ERROR, (TSTR("**>>ecc error fix performed on chunk %d:0" TENDSTR),chunkInNAND));
 253                                 dev->eccFixed++;
 254                         }
 255                         else if(eccResult1<0)
 256                         {
 257                                 T(YAFFS_TRACE_ERROR,(TSTR("**>>ecc error unfixed on chunk %d:0" TENDSTR),chunkInNAND));
 258                                 dev->eccUnfixed++;
 259                         }
 260
 261                         if(eccResult2>0)
 262                         {
 263                                 T(YAFFS_TRACE_ERROR,(TSTR("**>>ecc error fix performed on chunk %d:1" TENDSTR),chunkInNAND));
 264                                 dev->eccFixed++;
 265                         }
 266                         else if(eccResult2<0)
 267                         {
 268                                 T(YAFFS_TRACE_ERROR,(TSTR("**>>ecc error unfixed on chunk %d:1" TENDSTR),chunkInNAND));
 269                                 dev->eccUnfixed++;
 270                         }
 271
 272                         if(eccResult1 || eccResult2)
 273                         {
 274                                 // Hoosterman, we had a data problem on this page
 275                                 yaffs_HandleReadDataError(dev,chunkInNAND);
 276                         }
 277                 }
 278         }
 279         else
 280         {
 281         // Must allocate enough memory for spare+2*sizeof(int) for ecc results from device.
 282         struct yaffs_NANDSpare nspare;
 283                 retVal  = dev->readChunkFromNAND(dev,chunkInNAND,data,(yaffs_Spare*)&nspare);
 284                 memcpy (spare, &nspare, sizeof(yaffs_Spare));
 285                 if(data && doErrorCorrection)
 286                 {
 287                         if(nspare.eccres1>0)
 288                         {
 289                                 T(YAFFS_TRACE_ERROR,(TSTR("**>>ecc error fix performed on chunk %d:0" TENDSTR),chunkInNAND));
 290                         }
 291                         else if(nspare.eccres1<0)
 292                         {
 293                                 T(YAFFS_TRACE_ERROR,(TSTR("**>>ecc error unfixed on chunk %d:0" TENDSTR),chunkInNAND));
 294                         }
 295
 296                         if(nspare.eccres2>0)
 297                         {
 298                                 T(YAFFS_TRACE_ERROR,(TSTR("**>>ecc error fix performed on chunk %d:1" TENDSTR),chunkInNAND));
 299                         }
 300                         else if(nspare.eccres2<0)
 301                         {
 302                                 T(YAFFS_TRACE_ERROR,(TSTR("**>>ecc error unfixed on chunk %d:1" TENDSTR),chunkInNAND));
 303                         }
 304
 305                         if(nspare.eccres1 || nspare.eccres2)
 306                         {
 307                                 // Hoosterman, we had a data problem on this page
 308                                 yaffs_HandleReadDataError(dev,chunkInNAND);
 309                         }
 310
 311                 }
 312         }
 313         return retVal;
 314 }
 315
 316
 317 static int yaffs_CheckChunkErased(struct yaffs_DeviceStruct *dev,int chunkInNAND)
 318 {
 319
 320         static int init = 0;
 321         static __u8 cmpbuf[YAFFS_BYTES_PER_CHUNK];
 322         static __u8 data[YAFFS_BYTES_PER_CHUNK];
 323     // Might as well always allocate the larger size for dev->useNANDECC == true;
 324         static __u8 spare[sizeof(struct yaffs_NANDSpare)];
 325
 326         dev->readChunkFromNAND(dev,chunkInNAND,data,(yaffs_Spare *)spare);
 327
 328         if(!init)
 329         {
 330                 memset(cmpbuf,0xff,YAFFS_BYTES_PER_CHUNK);
 331                 init = 1;
 332         }
 333
 334         if(memcmp(cmpbuf,data,YAFFS_BYTES_PER_CHUNK)) return  YAFFS_FAIL;
 335         if(memcmp(cmpbuf,spare,16)) return YAFFS_FAIL;
 336
 337
 338         return YAFFS_OK;
 339
 340 }
 341
 342
 343
 344 int yaffs_EraseBlockInNAND(struct yaffs_DeviceStruct *dev,int blockInNAND)
 345 {
 346         dev->nBlockErasures++;
 347         return dev->eraseBlockInNAND(dev,blockInNAND);
 348 }
 349
 350 int yaffs_InitialiseNAND(struct yaffs_DeviceStruct *dev)
 351 {
 352         return dev->initialiseNAND(dev);
 353 }
 354
 355 static int yaffs_WriteNewChunkToNAND(struct yaffs_DeviceStruct *dev, const __u8 *data, yaffs_Spare *spare,int useReserve)
 356 {
 357         int chunk;
 358
 359         int writeOk = 1;
 360         int attempts = 0;
 361
 362         unsigned char rbData[YAFFS_BYTES_PER_CHUNK];
 363         yaffs_Spare rbSpare;
 364
 365         do{
 366                 chunk = yaffs_AllocateChunk(dev,useReserve);
 367
 368                 if(chunk >= 0)
 369                 {
 370
 371                         // First check this chunk is erased...
 372 #ifndef CONFIG_YAFFS_DISABLE_CHUNK_ERASED_CHECK
 373                         writeOk = yaffs_CheckChunkErased(dev,chunk);
 374 #endif
 375                         if(!writeOk)
 376                         {
 377                                 T(YAFFS_TRACE_ERROR,(TSTR("**>> yaffs chunk %d was not erased" TENDSTR),chunk));
 378                         }
 379                         else
 380                         {
 381                                 writeOk =  yaffs_WriteChunkToNAND(dev,chunk,data,spare);
 382                         }
 383                         attempts++;
 384                         if(writeOk)
 385                         {
 386                                 // Readback & verify
 387                                 // If verify fails, then delete this chunk and try again
 388                                 // To verify we compare everything except the block and
 389                                 // page status bytes.
 390                                 // NB We check a raw read without ECC correction applied
 391                                 yaffs_ReadChunkFromNAND(dev,chunk,rbData,&rbSpare,0);
 392
 393 #ifndef CONFIG_YAFFS_DISABLE_WRITE_VERIFY
 394                                 if(!yaffs_VerifyCompare(data,rbData,spare,&rbSpare))
 395                                 {
 396                                         // Didn't verify
 397                                         T(YAFFS_TRACE_ERROR,(TSTR("**>> yaffs write verify failed on chunk %d" TENDSTR), chunk));
 398
 399                                         writeOk = 0;
 400                                 }
 401 #endif
 402
 403                         }
 404                         if(writeOk)
 405                         {
 406                                 // Copy the data into the write buffer.
 407                                 // NB We do this at the end to prevent duplicates in the case of a write error.
 408                                 //Todo
 409                                 yaffs_HandleWriteChunkOk(dev,chunk,data,spare);
 410                         }
 411                         else
 412                         {
 413                                 yaffs_HandleWriteChunkError(dev,chunk);
 414                         }
 415                 }
 416
 417         } while(chunk >= 0 && ! writeOk);
 418
 419         if(attempts > 1)
 420         {
 421                 T(YAFFS_TRACE_ERROR,(TSTR("**>> yaffs write required %d attempts" TENDSTR),attempts));
 422                 dev->nRetriedWrites+= (attempts - 1);
 423         }
 424
 425         return chunk;
 426 }
 427
 428 ///
 429 // Functions for robustisizing
 430 //
 431 //
 432
 433 static void yaffs_RetireBlock(yaffs_Device *dev,int blockInNAND)
 434 {
 435         // Ding the blockStatus in the first two pages of the block.
 436
 437         yaffs_Spare spare;
 438
 439         memset(&spare, 0xff,sizeof(yaffs_Spare));
 440
 441         spare.blockStatus = 0;
 442
 443         // TODO change this retirement marking for other NAND types
 444         yaffs_WriteChunkToNAND(dev, blockInNAND * dev->nChunksPerBlock, NULL , &spare);
 445         yaffs_WriteChunkToNAND(dev, blockInNAND * dev->nChunksPerBlock + 1, NULL , &spare);
 446
 447         yaffs_GetBlockInfo(dev,blockInNAND)->blockState = YAFFS_BLOCK_STATE_DEAD;
 448         dev->nRetiredBlocks++;
 449 }
 450
 451
 452
 453 static int yaffs_RewriteBufferedBlock(yaffs_Device *dev)
 454 {
 455         dev->doingBufferedBlockRewrite = 1;
 456         //
 457         //      Remove erased chunks
 458         //  Rewrite existing chunks to a new block
 459         //      Set current write block to the new block
 460
 461         dev->doingBufferedBlockRewrite = 0;
 462
 463         return 1;
 464 }
 465
 466
 467 static void yaffs_HandleReadDataError(yaffs_Device *dev,int chunkInNAND)
 468 {
 469         int blockInNAND = chunkInNAND/dev->nChunksPerBlock;
 470
 471         // Mark the block for retirement
 472         yaffs_GetBlockInfo(dev,blockInNAND)->needsRetiring = 1;
 473         T(YAFFS_TRACE_ERROR | YAFFS_TRACE_BAD_BLOCKS,(TSTR("**>>Block %d marked for retirement" TENDSTR),blockInNAND));
 474
 475
 476         //TODO
 477         // Just do a garbage collection on the affected block then retire the block
 478         // NB recursion
 479 }
 480
 481
 482 static void yaffs_CheckWrittenBlock(yaffs_Device *dev,int chunkInNAND)
 483 {
 484 }
 485
 486 static void yaffs_HandleWriteChunkOk(yaffs_Device *dev,int chunkInNAND,const __u8 *data, const yaffs_Spare *spare)
 487 {
 488 }
 489
 490 static void yaffs_HandleUpdateChunk(yaffs_Device *dev,int chunkInNAND, const yaffs_Spare *spare)
 491 {
 492 }
 493
 494 static void yaffs_HandleWriteChunkError(yaffs_Device *dev,int chunkInNAND)
 495 {
 496         int blockInNAND = chunkInNAND/dev->nChunksPerBlock;
 497
 498         // Mark the block for retirement
 499         yaffs_GetBlockInfo(dev,blockInNAND)->needsRetiring = 1;
 500         // Delete the chunk
 501         yaffs_DeleteChunk(dev,chunkInNAND,1);
 502 }
 503
 504
 505
 506
 507 static int yaffs_VerifyCompare(const __u8 *d0, const __u8 * d1, const yaffs_Spare *s0, const yaffs_Spare *s1)
 508 {
 509
 510
 511         if( memcmp(d0,d1,YAFFS_BYTES_PER_CHUNK) != 0 ||
 512                 s0->tagByte0 != s1->tagByte0 ||
 513                 s0->tagByte1 != s1->tagByte1 ||
 514                 s0->tagByte2 != s1->tagByte2 ||
 515                 s0->tagByte3 != s1->tagByte3 ||
 516                 s0->tagByte4 != s1->tagByte4 ||
 517                 s0->tagByte5 != s1->tagByte5 ||
 518                 s0->tagByte6 != s1->tagByte6 ||
 519                 s0->tagByte7 != s1->tagByte7 ||
 520                 s0->ecc1[0]  != s1->ecc1[0]  ||
 521                 s0->ecc1[1]  != s1->ecc1[1]  ||
 522                 s0->ecc1[2]  != s1->ecc1[2]  ||
 523                 s0->ecc2[0]  != s1->ecc2[0]  ||
 524                 s0->ecc2[1]  != s1->ecc2[1]  ||
 525                 s0->ecc2[2]  != s1->ecc2[2] )
 526                 {
 527                         return 0;
 528                 }
 529
 530         return 1;
 531 }
 532
 533
 534 ///////////////////////// Object management //////////////////
 535 // List of spare objects
 536 // The list is hooked together using the first pointer
 537 // in the object
 538
 539 // static yaffs_Object *yaffs_freeObjects = NULL;
 540
 541 // static int yaffs_nFreeObjects;
 542
 543 // static yaffs_ObjectList *yaffs_allocatedObjectList = NULL;
 544
 545 // static yaffs_ObjectBucket yaffs_objectBucket[YAFFS_NOBJECT_BUCKETS];
 546
 547
 548 static __u16 yaffs_CalcNameSum(const char *name)
 549 {
 550         __u16 sum = 0;
 551         __u16 i = 1;
 552
 553         __u8 *bname = (__u8 *)name;
 554         if(bname)
 555         {
 556                 while ((*bname) && (i <=YAFFS_MAX_NAME_LENGTH))
 557                 {
 558
 559 #ifdef CONFIG_YAFFS_CASE_INSENSITIVE
 560                         sum += toupper(*bname) * i;
 561 #else
 562                         sum += (*bname) * i;
 563 #endif
 564                         i++;
 565                         bname++;
 566                 }
 567         }
 568         return sum;
 569 }
 570
 571 void yaffs_SetObjectName(yaffs_Object *obj, const char *name)
 572 {
 573 #ifdef CONFIG_YAFFS_SHORT_NAMES_IN_RAM
 574                                         if(name && strlen(name) <= YAFFS_SHORT_NAME_LENGTH)
 575                                         {
 576                                                 strcpy(obj->shortName,name);
 577                                         }
 578                                         else
 579                                         {
 580                                                 obj->shortName[0]='\0';
 581                                         }
 582 #endif
 583                                         obj->sum = yaffs_CalcNameSum(name);
 584 }
 585
 586 void yaffs_CalcECC(const __u8 *data, yaffs_Spare *spare)
 587 {
 588         yaffs_ECCCalculate(data , spare->ecc1);
 589         yaffs_ECCCalculate(&data[256] , spare->ecc2);
 590 }
 591
 592 void yaffs_CalcTagsECC(yaffs_Tags *tags)
 593 {
 594         // Calculate an ecc
 595
 596         unsigned char *b = ((yaffs_TagsUnion *)tags)->asBytes;
 597         unsigned  i,j;
 598         unsigned  ecc = 0;
 599         unsigned bit = 0;
 600
 601         tags->ecc = 0;
 602
 603         for(i = 0; i < 8; i++)
 604         {
 605                 for(j = 1; j &0xff; j<<=1)
 606                 {
 607                         bit++;
 608                         if(b[i] & j)
 609                         {
 610                                 ecc ^= bit;
 611                         }
 612                 }
 613         }
 614
 615         tags->ecc = ecc;
 616
 617
 618 }
 619
 620 int  yaffs_CheckECCOnTags(yaffs_Tags *tags)
 621 {
 622         unsigned ecc = tags->ecc;
 623
 624         yaffs_CalcTagsECC(tags);
 625
 626         ecc ^= tags->ecc;
 627
 628         if(ecc && ecc <= 64)
 629         {
 630                 // TODO: Handle the failure better. Retire?
 631                 unsigned char *b = ((yaffs_TagsUnion *)tags)->asBytes;
 632
 633                 ecc--;
 634
 635                 b[ecc / 8] ^= (1 << (ecc & 7));
 636
 637                 // Now recvalc the ecc
 638                 yaffs_CalcTagsECC(tags);
 639
 640                 return 1; // recovered error
 641         }
 642         else if(ecc)
 643         {
 644                 // Wierd ecc failure value
 645                 // TODO Need to do somethiong here
 646                 return -1; //unrecovered error
 647         }
 648
 649         return 0;
 650 }
 651
 652
 653 ///////////////////////// TNODES ///////////////////////
 654
 655 // List of spare tnodes
 656 // The list is hooked together using the first pointer
 657 // in the tnode.
 658
 659 //static yaffs_Tnode *yaffs_freeTnodes = NULL;
 660
 661 // static int yaffs_nFreeTnodes;
 662
 663 //static yaffs_TnodeList *yaffs_allocatedTnodeList = NULL;
 664
 665
 666
 667 // yaffs_CreateTnodes creates a bunch more tnodes and
 668 // adds them to the tnode free list.
 669 // Don't use this function directly
 670
 671 static int yaffs_CreateTnodes(yaffs_Device *dev,int nTnodes)
 672 {
 673     int i;
 674     yaffs_Tnode *newTnodes;
 675     yaffs_TnodeList *tnl;
 676
 677     if(nTnodes < 1) return YAFFS_OK;
 678
 679         // make these things
 680
 681     newTnodes = YMALLOC(nTnodes * sizeof(yaffs_Tnode));
 682
 683     if (!newTnodes)
 684     {
 685                 T(YAFFS_TRACE_ERROR,(TSTR("yaffs: Could not allocate Tnodes"TENDSTR)));
 686                 return YAFFS_FAIL;
 687     }
 688
 689     // Hook them into the free list
 690     for(i = 0; i < nTnodes - 1; i++)
 691     {
 692         newTnodes[i].internal[0] = &newTnodes[i+1];
 693 #ifdef CONFIG_YAFFS_TNODE_LIST_DEBUG
 694         newTnodes[i].internal[YAFFS_NTNODES_INTERNAL] = 1;
 695 #endif
 696     }
 697
 698         newTnodes[nTnodes - 1].internal[0] = dev->freeTnodes;
 699 #ifdef CONFIG_YAFFS_TNODE_LIST_DEBUG
 700         newTnodes[nTnodes - 1].internal[YAFFS_NTNODES_INTERNAL] = 1;
 701 #endif
 702         dev->freeTnodes = newTnodes;
 703         dev->nFreeTnodes+= nTnodes;
 704         dev->nTnodesCreated += nTnodes;
 705
 706         // Now add this bunch of tnodes to a list for freeing up.
 707         // NB If we can't add this to the management list it isn't fatal
 708         // but it just means we can't free this bunch of tnodes later.
 709         tnl = YMALLOC(sizeof(yaffs_TnodeList));
 710         if(!tnl)
 711         {
 712                 T(YAFFS_TRACE_ERROR,(TSTR("yaffs: Could not add tnodes to management list" TENDSTR)));
 713
 714         }
 715         else
 716         {
 717                 tnl->tnodes = newTnodes;
 718                 tnl->next = dev->allocatedTnodeList;
 719                 dev->allocatedTnodeList = tnl;
 720         }
 721
 722
 723         T(YAFFS_TRACE_ALLOCATE,(TSTR("yaffs: Tnodes added" TENDSTR)));
 724
 725
 726         return YAFFS_OK;
 727 }
 728
 729
 730 // GetTnode gets us a clean tnode. Tries to make allocate more if we run out
 731 static yaffs_Tnode *yaffs_GetTnode(yaffs_Device *dev)
 732 {
 733         yaffs_Tnode *tn = NULL;
 734
 735         // If there are none left make more
 736         if(!dev->freeTnodes)
 737         {
 738                 yaffs_CreateTnodes(dev,YAFFS_ALLOCATION_NTNODES);
 739         }
 740
 741         if(dev->freeTnodes)
 742         {
 743                 tn = dev->freeTnodes;
 744 #ifdef CONFIG_YAFFS_TNODE_LIST_DEBUG
 745         if(tn->internal[YAFFS_NTNODES_INTERNAL] != 1)
 746                 {
 747                         // Hoosterman, this thing looks like it isn't in the list
 748                                 T(YAFFS_TRACE_ALWAYS,(TSTR("yaffs: Tnode list bug 1" TENDSTR)));
 749                 }
 750 #endif
 751                 dev->freeTnodes = dev->freeTnodes->internal[0];
 752                 dev->nFreeTnodes--;
 753                 // zero out
 754                 memset(tn,0,sizeof(yaffs_Tnode));
 755         }
 756
 757
 758         return tn;
 759 }
 760
 761
 762 // FreeTnode frees up a tnode and puts it back on the free list
 763 static void yaffs_FreeTnode(yaffs_Device*dev, yaffs_Tnode *tn)
 764 {
 765         if(tn)
 766         {
 767 #ifdef CONFIG_YAFFS_TNODE_LIST_DEBUG
 768         if(tn->internal[YAFFS_NTNODES_INTERNAL] != 0)
 769                 {
 770                         // Hoosterman, this thing looks like it is already in the list
 771                                 T(YAFFS_TRACE_ALWAYS,(TSTR("yaffs: Tnode list bug 2" TENDSTR)));
 772                 }
 773                 tn->internal[YAFFS_NTNODES_INTERNAL] = 1;
 774 #endif
 775                 tn->internal[0] = dev->freeTnodes;
 776                 dev->freeTnodes = tn;
 777                 dev->nFreeTnodes++;
 778         }
 779 }
 780
 781
 782 static void yaffs_DeinitialiseTnodes(yaffs_Device*dev)
 783 {
 784         // Free the list of allocated tnodes
 785         yaffs_TnodeList *tmp;
 786
 787         while(dev->allocatedTnodeList)
 788         {
 789                 tmp =  dev->allocatedTnodeList->next;
 790
 791                 YFREE(dev->allocatedTnodeList->tnodes);
 792                 YFREE(dev->allocatedTnodeList);
 793                 dev->allocatedTnodeList = tmp;
 794
 795         }
 796
 797         dev->freeTnodes = NULL;
 798         dev->nFreeTnodes = 0;
 799 }
 800
 801 static void yaffs_InitialiseTnodes(yaffs_Device*dev)
 802 {
 803         dev->allocatedTnodeList = NULL;
 804         dev->freeTnodes = NULL;
 805         dev->nFreeTnodes = 0;
 806         dev->nTnodesCreated = 0;
 807
 808 }
 809
 810 #if 0
 811 void yaffs_TnodeTest(yaffs_Device *dev)
 812 {
 813
 814         int i;
 815         int j;
 816         yaffs_Tnode *tn[1000];
 817
 818         YINFO("Testing TNodes");
 819
 820         for(j = 0; j < 50; j++)
 821         {
 822                 for(i = 0; i < 1000; i++)
 823                 {
 824                         tn[i] = yaffs_GetTnode(dev);
 825                         if(!tn[i])
 826                         {
 827                                 YALERT("Getting tnode failed");
 828                         }
 829                 }
 830                 for(i = 0; i < 1000; i+=3)
 831                 {
 832                         yaffs_FreeTnode(dev,tn[i]);
 833                         tn[i] = NULL;
 834                 }
 835
 836         }
 837 }
 838 #endif
 839
 840
 841 ////////////////// END OF TNODE MANIPULATION ///////////////////////////
 842
 843 /////////////// Functions to manipulate the look-up tree (made up of tnodes)
 844 // The look up tree is represented by the top tnode and the number of topLevel
 845 // in the tree. 0 means only the level 0 tnode is in the tree.
 846
 847
 848 // FindLevel0Tnode finds the level 0 tnode, if one exists.
 849 // Used when reading.....
 850 static yaffs_Tnode *yaffs_FindLevel0Tnode(yaffs_Device *dev,yaffs_FileStructure *fStruct, __u32 chunkId)
 851 {
 852
 853         yaffs_Tnode *tn = fStruct->top;
 854         __u32 i;
 855         int requiredTallness;
 856         int level = fStruct->topLevel;
 857
 858         // Check sane level and chunk Id
 859         if(level < 0 || level > YAFFS_TNODES_MAX_LEVEL)
 860         {
 861 //              char str[50];
 862 //              sprintf(str,"Bad level %d",level);
 863 //              YALERT(str);
 864                 return NULL;
 865         }
 866
 867         if(chunkId > YAFFS_MAX_CHUNK_ID)
 868         {
 869 //              char str[50];
 870 //              sprintf(str,"Bad chunkId %d",chunkId);
 871 //              YALERT(str);
 872                 return NULL;
 873         }
 874
 875         // First check we're tall enough (ie enough topLevel)
 876
 877         i = chunkId >> (/*dev->chunkGroupBits  + */YAFFS_TNODES_LEVEL0_BITS);
 878         requiredTallness = 0;
 879         while(i)
 880         {
 881                 i >>= YAFFS_TNODES_INTERNAL_BITS;
 882                 requiredTallness++;
 883         }
 884
 885
 886         if(requiredTallness > fStruct->topLevel)
 887         {
 888                 // Not tall enough, so we can't find it, return NULL.
 889                 return NULL;
 890         }
 891
 892
 893         // Traverse down to level 0
 894         while (level > 0 && tn)
 895         {
 896             tn = tn->internal[(chunkId >>(/* dev->chunkGroupBits + */ YAFFS_TNODES_LEVEL0_BITS + (level-1) * YAFFS_TNODES_INTERNAL_BITS)) &
 897                                YAFFS_TNODES_INTERNAL_MASK];
 898                 level--;
 899
 900         }
 901
 902         return tn;
 903 }
 904
 905 // AddOrFindLevel0Tnode finds the level 0 tnode if it exists, otherwise first expands the tree.
 906 // This happens in two steps:
 907 //  1. If the tree isn't tall enough, then make it taller.
 908 //  2. Scan down the tree towards the level 0 tnode adding tnodes if required.
 909 //
 910 // Used when modifying the tree.
 911 //
 912 static yaffs_Tnode *yaffs_AddOrFindLevel0Tnode(yaffs_Device *dev, yaffs_FileStructure *fStruct, __u32 chunkId)
 913 {
 914
 915         yaffs_Tnode *tn;
 916
 917         int requiredTallness;
 918         int i;
 919         int l;
 920
 921         __u32 x;
 922
 923
 924         //T((TSTR("AddOrFind topLevel=%d, chunk=%d"),fStruct->topLevel,chunkId));
 925
 926         // Check sane level and page Id
 927         if(fStruct->topLevel < 0 || fStruct->topLevel > YAFFS_TNODES_MAX_LEVEL)
 928         {
 929 //              char str[50];
 930 //              sprintf(str,"Bad level %d",fStruct->topLevel);
 931 //              YALERT(str);
 932                 return NULL;
 933         }
 934
 935         if(chunkId > YAFFS_MAX_CHUNK_ID)
 936         {
 937 //              char str[50];
 938 //              sprintf(str,"Bad chunkId %d",chunkId);
 939 //              YALERT(str);
 940                 return NULL;
 941         }
 942
 943         // First check we're tall enough (ie enough topLevel)
 944
 945         x = chunkId >> (/*dev->chunkGroupBits + */YAFFS_TNODES_LEVEL0_BITS);
 946         requiredTallness = 0;
 947         while(x)
 948         {
 949                 x >>= YAFFS_TNODES_INTERNAL_BITS;
 950                 requiredTallness++;
 951         }
 952
 953         //T((TSTR(" required=%d"),requiredTallness));
 954
 955
 956         if(requiredTallness > fStruct->topLevel)
 957         {
 958                 // Not tall enough,gotta make the tree taller
 959                 for(i = fStruct->topLevel; i < requiredTallness; i++)
 960                 {
 961                         //T((TSTR(" add new top")));
 962
 963                         tn = yaffs_GetTnode(dev);
 964
 965                         if(tn)
 966                         {
 967                                 tn->internal[0] = fStruct->top;
 968                                 fStruct->top = tn;
 969                         }
 970                         else
 971                         {
 972                                         T(YAFFS_TRACE_ERROR,(TSTR("yaffs: no more tnodes" TENDSTR)));
 973                         }
 974                 }
 975
 976                 fStruct->topLevel = requiredTallness;
 977         }
 978
 979
 980         // Traverse down to level 0, adding anything we need
 981
 982         l = fStruct->topLevel;
 983         tn = fStruct->top;
 984         while (l > 0 && tn)
 985         {
 986                 x = (chunkId >> (/*dev->chunkGroupBits + */YAFFS_TNODES_LEVEL0_BITS + (l-1) * YAFFS_TNODES_INTERNAL_BITS)) &
 987                                YAFFS_TNODES_INTERNAL_MASK;
 988
 989                 //T((TSTR(" [%d:%d]"),l,i));
 990
 991             if(!tn->internal[x])
 992             {
 993                 //T((TSTR(" added")));
 994
 995                 tn->internal[x] = yaffs_GetTnode(dev);
 996             }
 997
 998             tn =        tn->internal[x];
 999                 l--;
1000
1001         }
1002
1003         //TSTR(TENDSTR)));
1004
1005         return tn;
1006 }
1007
1008 // DeleteWorker scans backwards through the tnode tree and deletes all the
1009 // chunks and tnodes in the file
1010 // Returns 1 if the tree was deleted. Returns 0 if it stopped early due to hitting the limit and the delete is incomplete.
1011
1012 static int yaffs_DeleteWorker(yaffs_Object *in, yaffs_Tnode *tn, __u32 level, int chunkOffset,int *limit)
1013 {
1014         int i;
1015         int chunkInInode;
1016         int theChunk;
1017         yaffs_Tags tags;
1018         int found;
1019         int chunkDeleted;
1020         int allDone = 1;
1021
1022
1023         if(tn)
1024         {
1025                 if(level > 0)
1026                 {
1027
1028                         for(i = YAFFS_NTNODES_INTERNAL -1; allDone && i >= 0; i--)
1029                         {
1030                             if(tn->internal[i])
1031                         {
1032                                         if(limit && (*limit) < 0)
1033                                         {
1034                                                 allDone = 0;
1035                                         }
1036                                         else
1037                                         {
1038                                                 allDone = yaffs_DeleteWorker(in,tn->internal[i],level - 1,
1039                                                                                 (chunkOffset << YAFFS_TNODES_INTERNAL_BITS ) + i ,limit);
1040                                         }
1041                                         if(allDone)
1042                                         {
1043                                                 yaffs_FreeTnode(in->myDev,tn->internal[i]);
1044                                         tn->internal[i] = NULL;
1045                                         }
1046                             }
1047
1048                         }
1049                         return (allDone) ? 1 : 0;
1050                 }
1051                 else if(level == 0)
1052                 {
1053                         int hitLimit = 0;
1054
1055                         for(i = YAFFS_NTNODES_LEVEL0 -1; i >= 0 && !hitLimit; i--)
1056                         {
1057                             if(tn->level0[i])
1058                         {
1059                                         int j;
1060
1061                                         chunkInInode = (chunkOffset << YAFFS_TNODES_LEVEL0_BITS ) + i;
1062
1063                                         theChunk =  tn->level0[i] << in->myDev->chunkGroupBits;
1064
1065                                         // Now we need to search for it
1066                                         for(j = 0,found = 0; theChunk && j < in->myDev->chunkGroupSize && !found; j++)
1067                                         {
1068                                                 yaffs_ReadChunkTagsFromNAND(in->myDev,theChunk,&tags,&chunkDeleted);
1069                                                 if(yaffs_TagsMatch(&tags,in->objectId,chunkInInode,chunkDeleted))
1070                                                 {
1071                                                         // found it;
1072                                                         found = 1;
1073
1074                                                 }
1075                                                 else
1076                                                 {
1077                                                         theChunk++;
1078                                                 }
1079                                         }
1080
1081                                         if(found)
1082                                         {
1083                                                 yaffs_DeleteChunk(in->myDev,theChunk,1);
1084                                                 in->nDataChunks--;
1085                                                 if(limit)
1086                                                 {
1087                                                         *limit = *limit-1;
1088                                                         if(*limit <= 0)
1089                                                         {
1090                                                                 hitLimit = 1;
1091                                                         }
1092                                                 }
1093
1094                                         }
1095
1096                                 tn->level0[i] = 0;
1097                             }
1098
1099                         }
1100                         return (i < 0) ? 1 : 0;
1101
1102
1103                 }
1104
1105         }
1106
1107         return 1;
1108
1109 }
1110
1111 // SoftDeleteWorker scans backwards through the tnode tree and soft deletes all the chunks in the file.
1112 // All soft deleting does is increment the block's softdelete count and pulls the chunk out
1113 // of the tnode.
1114 // THus, essentially this is the same as DeleteWorker except that the chunks are soft deleted.
1115 //
1116 static int yaffs_SoftDeleteWorker(yaffs_Object *in, yaffs_Tnode *tn, __u32 level, int chunkOffset)
1117 {
1118         int i;
1119         int chunkInInode;
1120         int theChunk;
1121         yaffs_BlockInfo *theBlock;
1122         yaffs_Tags tags;
1123         int found;
1124         int chunkDeleted;
1125         int allDone = 1;
1126
1127
1128         if(tn)
1129         {
1130                 if(level > 0)
1131                 {
1132
1133                         for(i = YAFFS_NTNODES_INTERNAL -1; allDone && i >= 0; i--)
1134                         {
1135                             if(tn->internal[i])
1136                         {
1137                                                 allDone = yaffs_SoftDeleteWorker(in,tn->internal[i],level - 1,
1138                                                                                 (chunkOffset << YAFFS_TNODES_INTERNAL_BITS ) + i);
1139                                         if(allDone)
1140                                         {
1141                                                 yaffs_FreeTnode(in->myDev,tn->internal[i]);
1142                                         tn->internal[i] = NULL;
1143                                         }
1144                                         else
1145                                         {
1146                                                 //Hoosterman... how could this happen.
1147                                         }
1148                                 }
1149                         }
1150                         return (allDone) ? 1 : 0;
1151                 }
1152                 else if(level == 0)
1153                 {
1154
1155                         for(i = YAFFS_NTNODES_LEVEL0 -1; i >=0; i--)
1156                         {
1157                             if(tn->level0[i])
1158                         {
1159                                         // Note this does not find the real chunk, only the chunk group.
1160                                         // We make an assumption that a chunk group is niot larger than a block.
1161                                         theChunk =  (tn->level0[i] << in->myDev->chunkGroupBits);
1162                                         T(YAFFS_TRACE_SCAN,(TSTR("soft delete tch %d cgb %d chunk %d" TENDSTR),
1163                                                 tn->level0[i],in->myDev->chunkGroupBits,theChunk));
1164
1165                                         theBlock =      yaffs_GetBlockInfo(in->myDev,  theChunk/in->myDev->nChunksPerBlock);
1166                                         if(theBlock)
1167                                         {
1168                                                 theBlock->softDeletions++;
1169                                         }
1170                                 tn->level0[i] = 0;
1171                             }
1172
1173                         }
1174                         return 1;
1175
1176                 }
1177
1178         }
1179
1180         return 1;
1181
1182 }
1183
1184
1185
1186 static void yaffs_SoftDeleteFile(yaffs_Object *obj)
1187 {
1188         if(obj->deleted &&
1189            obj->variantType == YAFFS_OBJECT_TYPE_FILE &&
1190            !obj->softDeleted)
1191         {
1192                 if(obj->nDataChunks <= 0)
1193                 {
1194                                 // Empty file, just delete it immediately
1195                                 yaffs_FreeTnode(obj->myDev,obj->variant.fileVariant.top);
1196                                 obj->variant.fileVariant.top = NULL;
1197                                 T(YAFFS_TRACE_TRACING,(TSTR("yaffs: Deleting empty file %d" TENDSTR),obj->objectId));
1198                                 yaffs_DoGenericObjectDeletion(obj);
1199                 }
1200                 else
1201                 {
1202                         yaffs_SoftDeleteWorker(obj, obj->variant.fileVariant.top, obj->variant.fileVariant.topLevel, 0);
1203                         obj->softDeleted = 1;
1204                 }
1205         }
1206 }
1207
1208
1209
1210
1211
1212 // Pruning removes any part of the file structure tree that is beyond the
1213 // bounds of the file (ie that does not point to chunks).
1214 //
1215 // A file should only get pruned when its size is reduced.
1216 //
1217 // Before pruning, the chunks must be pulled from the tree and the
1218 // level 0 tnode entries must be zeroed out.
1219 // Could also use this for file deletion, but that's probably better handled
1220 // by a special case.
1221
1222 // yaffs_PruneWorker should only be called by yaffs_PruneFileStructure()
1223
1224 static yaffs_Tnode *yaffs_PruneWorker(yaffs_Device *dev, yaffs_Tnode *tn, __u32 level, int del0)
1225 {
1226         int i;
1227         int hasData;
1228
1229         if(tn)
1230         {
1231                 hasData = 0;
1232
1233                 for(i = 0; i < YAFFS_NTNODES_INTERNAL; i++)
1234                 {
1235                     if(tn->internal[i] && level > 0)
1236                     {
1237                         tn->internal[i] = yaffs_PruneWorker(dev,tn->internal[i],level - 1, ( i == 0) ? del0 : 1);
1238                     }
1239
1240                     if(tn->internal[i])
1241                     {
1242                         hasData++;
1243                         }
1244                 }
1245
1246                 if(hasData == 0 && del0)
1247                 {
1248                         // Free and return NULL
1249
1250                         yaffs_FreeTnode(dev,tn);
1251                         tn = NULL;
1252                 }
1253
1254         }
1255
1256         return tn;
1257
1258 }
1259
1260 static int yaffs_PruneFileStructure(yaffs_Device *dev, yaffs_FileStructure *fStruct)
1261 {
1262         int i;
1263         int hasData;
1264         int done = 0;
1265         yaffs_Tnode *tn;
1266
1267         if(fStruct->topLevel > 0)
1268         {
1269                 fStruct->top = yaffs_PruneWorker(dev,fStruct->top, fStruct->topLevel,0);
1270
1271                 // Now we have a tree with all the non-zero branches NULL but the height
1272                 // is the same as it was.
1273                 // Let's see if we can trim internal tnodes to shorten the tree.
1274                 // We can do this if only the 0th element in the tnode is in use
1275                 // (ie all the non-zero are NULL)
1276
1277                 while(fStruct->topLevel && !done)
1278                 {
1279                         tn = fStruct->top;
1280
1281                         hasData = 0;
1282                         for(i = 1; i <YAFFS_NTNODES_INTERNAL; i++)
1283                         {
1284                                 if(tn->internal[i])
1285                         {
1286                                 hasData++;
1287                                 }
1288                         }
1289
1290                         if(!hasData)
1291                         {
1292                                 fStruct->top = tn->internal[0];
1293                                 fStruct->topLevel--;
1294                                 yaffs_FreeTnode(dev,tn);
1295                         }
1296                         else
1297                         {
1298                                 done = 1;
1299                         }
1300                 }
1301         }
1302
1303         return YAFFS_OK;
1304 }
1305
1306
1307
1308
1309
1310 /////////////////////// End of File Structure functions. /////////////////
1311
1312 // yaffs_CreateFreeObjects creates a bunch more objects and
1313 // adds them to the object free list.
1314 static int yaffs_CreateFreeObjects(yaffs_Device *dev, int nObjects)
1315 {
1316     int i;
1317     yaffs_Object *newObjects;
1318     yaffs_ObjectList *list;
1319
1320     if(nObjects < 1) return YAFFS_OK;
1321
1322         // make these things
1323
1324     newObjects = YMALLOC(nObjects * sizeof(yaffs_Object));
1325
1326     if (!newObjects)
1327     {
1328                 T(YAFFS_TRACE_ALLOCATE,(TSTR("yaffs: Could not allocate more objects" TENDSTR)));
1329                 return YAFFS_FAIL;
1330     }
1331
1332     // Hook them into the free list
1333     for(i = 0; i < nObjects - 1; i++)
1334     {
1335         newObjects[i].siblings.next = (struct list_head *)(&newObjects[i+1]);
1336     }
1337
1338         newObjects[nObjects - 1].siblings.next = (void *)dev->freeObjects;
1339         dev->freeObjects = newObjects;
1340         dev->nFreeObjects+= nObjects;
1341         dev->nObjectsCreated+= nObjects;
1342
1343         // Now add this bunch of Objects to a list for freeing up.
1344
1345         list = YMALLOC(sizeof(yaffs_ObjectList));
1346         if(!list)
1347         {
1348                 T(YAFFS_TRACE_ALLOCATE,(TSTR("Could not add objects to management list" TENDSTR)));
1349         }
1350         else
1351         {
1352                 list->objects = newObjects;
1353                 list->next = dev->allocatedObjectList;
1354                 dev->allocatedObjectList = list;
1355         }
1356
1357
1358
1359         return YAFFS_OK;
1360 }
1361
1362
1363 // AllocateEmptyObject gets us a clean Object. Tries to make allocate more if we run out
1364 static yaffs_Object *yaffs_AllocateEmptyObject(yaffs_Device *dev)
1365 {
1366         yaffs_Object *tn = NULL;
1367
1368         // If there are none left make more
1369         if(!dev->freeObjects)
1370         {
1371                 yaffs_CreateFreeObjects(dev,YAFFS_ALLOCATION_NOBJECTS);
1372         }
1373
1374         if(dev->freeObjects)
1375         {
1376                 tn = dev->freeObjects;
1377                 dev->freeObjects = (yaffs_Object *)(dev->freeObjects->siblings.next);
1378                 dev->nFreeObjects--;
1379
1380                 // Now sweeten it up...
1381
1382                 memset(tn,0,sizeof(yaffs_Object));
1383                 tn->myDev = dev;
1384                 tn->chunkId = -1;
1385                 tn->variantType = YAFFS_OBJECT_TYPE_UNKNOWN;
1386                 INIT_LIST_HEAD(&(tn->hardLinks));
1387                 INIT_LIST_HEAD(&(tn->hashLink));
1388                 INIT_LIST_HEAD(&tn->siblings);
1389
1390                 // Add it to the lost and found directory.
1391                 // NB Can't put root or lostNFound in lostNFound so
1392                 // check if lostNFound exists first
1393                 if(dev->lostNFoundDir)
1394                 {
1395                         yaffs_AddObjectToDirectory(dev->lostNFoundDir,tn);
1396                 }
1397         }
1398
1399
1400         return tn;
1401 }
1402
1403 static yaffs_Object *yaffs_CreateFakeDirectory(yaffs_Device *dev,int number,__u32 mode)
1404 {
1405
1406         yaffs_Object *obj = yaffs_CreateNewObject(dev,number,YAFFS_OBJECT_TYPE_DIRECTORY);
1407         if(obj)
1408         {
1409                 obj->fake = 1;                  // it is fake so it has no NAND presence...
1410                 obj->renameAllowed= 0;  // ... and we're not allowed to rename it...
1411                 obj->unlinkAllowed= 0;  // ... or unlink it
1412                 obj->deleted = 0;
1413                 obj->unlinked = 0;
1414                 obj->st_mode = mode;
1415                 obj->myDev = dev;
1416                 obj->chunkId = 0; // Not a valid chunk.
1417         }
1418
1419         return obj;
1420
1421 }
1422
1423
1424 static void yaffs_UnhashObject(yaffs_Object *tn)
1425 {
1426         int bucket;
1427         yaffs_Device *dev = tn->myDev;
1428
1429
1430         // If it is still linked into the bucket list, free from the list
1431         if(!list_empty(&tn->hashLink))
1432         {
1433                 list_del_init(&tn->hashLink);
1434                 bucket =  yaffs_HashFunction(tn->objectId);
1435                 dev->objectBucket[bucket].count--;
1436         }
1437
1438 }
1439
1440
1441 // FreeObject frees up a Object and puts it back on the free list
1442 static void yaffs_FreeObject(yaffs_Object *tn)
1443 {
1444
1445         yaffs_Device *dev = tn->myDev;
1446
1447         yaffs_UnhashObject(tn);
1448
1449         // Link into the free list.
1450         tn->siblings.next = (struct list_head *)(dev->freeObjects);
1451         dev->freeObjects = tn;
1452         dev->nFreeObjects++;
1453 }
1454
1455
1456
1457
1458 static void yaffs_DeinitialiseObjects(yaffs_Device *dev)
1459 {
1460         // Free the list of allocated Objects
1461
1462         yaffs_ObjectList *tmp;
1463
1464         while( dev->allocatedObjectList)
1465         {
1466                 tmp =  dev->allocatedObjectList->next;
1467                 YFREE(dev->allocatedObjectList->objects);
1468                 YFREE(dev->allocatedObjectList);
1469
1470                 dev->allocatedObjectList =  tmp;
1471         }
1472
1473         dev->freeObjects = NULL;
1474         dev->nFreeObjects = 0;
1475 }
1476
1477 static void yaffs_InitialiseObjects(yaffs_Device *dev)
1478 {
1479         int i;
1480
1481         dev->allocatedObjectList = NULL;
1482         dev->freeObjects = NULL;
1483         dev->nFreeObjects = 0;
1484
1485         for(i = 0; i < YAFFS_NOBJECT_BUCKETS; i++)
1486         {
1487                 INIT_LIST_HEAD(&dev->objectBucket[i].list);
1488                 dev->objectBucket[i].count = 0;
1489         }
1490
1491 }
1492
1493
1494
1495
1496
1497
1498 int yaffs_FindNiceObjectBucket(yaffs_Device *dev)
1499 {
1500         static int x = 0;
1501         int i;
1502         int l = 999;
1503         int lowest = 999999;
1504
1505
1506         // First let's see if we can find one that's empty.
1507
1508         for(i = 0; i < 10 && lowest > 0; i++)
1509          {
1510                 x++;
1511                 x %=  YAFFS_NOBJECT_BUCKETS;
1512                 if(dev->objectBucket[x].count < lowest)
1513                 {
1514                         lowest = dev->objectBucket[x].count;
1515                         l = x;
1516                 }
1517
1518         }
1519
1520         // If we didn't find an empty list, then try
1521         // looking a bit further for a short one
1522
1523         for(i = 0; i < 10 && lowest > 3; i++)
1524          {
1525                 x++;
1526                 x %=  YAFFS_NOBJECT_BUCKETS;
1527                 if(dev->objectBucket[x].count < lowest)
1528                 {
1529                         lowest = dev->objectBucket[x].count;
1530                         l = x;
1531                 }
1532
1533         }
1534
1535         return l;
1536 }
1537
1538 static int yaffs_CreateNewObjectNumber(yaffs_Device *dev)
1539 {
1540         int bucket = yaffs_FindNiceObjectBucket(dev);
1541
1542         // Now find an object value that has not already been taken
1543         // by scanning the list.
1544
1545         int found = 0;
1546         struct list_head *i;
1547
1548         __u32 n = (__u32)bucket;
1549
1550         //yaffs_CheckObjectHashSanity();
1551
1552         while(!found)
1553         {
1554                 found = 1;
1555                 n +=  YAFFS_NOBJECT_BUCKETS;
1556                 if(1 ||dev->objectBucket[bucket].count > 0)
1557                 {
1558                         list_for_each(i,&dev->objectBucket[bucket].list)
1559                         {
1560                                 // If there is already one in the list
1561                                 if(i && list_entry(i, yaffs_Object,hashLink)->objectId == n)
1562                                 {
1563                                         found = 0;
1564                                 }
1565                         }
1566                 }
1567         }
1568
1569         //T(("bucket %d count %d inode %d\n",bucket,yaffs_objectBucket[bucket].count,n);
1570
1571         return n;
1572 }
1573
1574 void yaffs_HashObject(yaffs_Object *in)
1575 {
1576         int bucket = yaffs_HashFunction(in->objectId);
1577         yaffs_Device *dev = in->myDev;
1578
1579         if(!list_empty(&in->hashLink))
1580         {
1581                 //YINFO("!!!");
1582         }
1583
1584
1585         list_add(&in->hashLink,&dev->objectBucket[bucket].list);
1586         dev->objectBucket[bucket].count++;
1587
1588 }
1589
1590 yaffs_Object *yaffs_FindObjectByNumber(yaffs_Device *dev,__u32 number)
1591 {
1592         int bucket = yaffs_HashFunction(number);
1593         struct list_head *i;
1594         yaffs_Object *in;
1595
1596         list_for_each(i,&dev->objectBucket[bucket].list)
1597         {
1598                 // Look if it is in the list
1599                 if(i)
1600                 {
1601                         in = list_entry(i, yaffs_Object,hashLink);
1602                         if(in->objectId == number)
1603                         {
1604                                 return in;
1605                         }
1606                 }
1607         }
1608
1609         return NULL;
1610 }
1611
1612
1613
1614 yaffs_Object *yaffs_CreateNewObject(yaffs_Device *dev,int number,yaffs_ObjectType type)
1615 {
1616
1617         yaffs_Object *theObject;
1618
1619         if(number < 0)
1620         {
1621                 number = yaffs_CreateNewObjectNumber(dev);
1622         }
1623
1624         theObject = yaffs_AllocateEmptyObject(dev);
1625
1626         if(theObject)
1627         {
1628                 theObject->fake = 0;
1629                 theObject->renameAllowed = 1;
1630                 theObject->unlinkAllowed = 1;
1631                 theObject->objectId = number;
1632                 yaffs_HashObject(theObject);
1633                 theObject->variantType = type;
1634 #ifdef CONFIG_YAFFS_WINCE
1635                 yfsd_WinFileTimeNow(theObject->win_atime);
1636                 theObject->win_ctime[0] = theObject->win_mtime[0] = theObject->win_atime[0];
1637                 theObject->win_ctime[1] = theObject->win_mtime[1] = theObject->win_atime[1];
1638
1639 #else
1640
1641 #if defined(CONFIG_KERNEL_2_5)
1642                 theObject->st_atime = theObject->st_mtime =     theObject->st_ctime = CURRENT_TIME.tv_sec;
1643 #else
1644                 theObject->st_atime = theObject->st_mtime =     theObject->st_ctime = CURRENT_TIME;
1645 #endif
1646 #endif
1647                 switch(type)
1648                 {
1649                         case YAFFS_OBJECT_TYPE_FILE:
1650                                 theObject->variant.fileVariant.fileSize = 0;
1651                                 theObject->variant.fileVariant.scannedFileSize = 0;
1652                                 theObject->variant.fileVariant.topLevel = 0;
1653                                 theObject->variant.fileVariant.top  = yaffs_GetTnode(dev);
1654                                 break;
1655                         case YAFFS_OBJECT_TYPE_DIRECTORY:
1656                                 INIT_LIST_HEAD(&theObject->variant.directoryVariant.children);
1657                                 break;
1658                         case YAFFS_OBJECT_TYPE_SYMLINK:
1659                                 // No action required
1660                                 break;
1661                         case YAFFS_OBJECT_TYPE_HARDLINK:
1662                                 // No action required
1663                                 break;
1664                         case YAFFS_OBJECT_TYPE_SPECIAL:
1665                                 // No action required
1666                                 break;
1667                         case YAFFS_OBJECT_TYPE_UNKNOWN:
1668                                 // todo this should not happen
1669                                 break;
1670                 }
1671         }
1672
1673         return theObject;
1674 }
1675
1676 yaffs_Object *yaffs_FindOrCreateObjectByNumber(yaffs_Device *dev, int number,yaffs_ObjectType type)
1677 {
1678         yaffs_Object *theObject = NULL;
1679
1680         if(number > 0)
1681         {
1682                 theObject = yaffs_FindObjectByNumber(dev,number);
1683         }
1684
1685         if(!theObject)
1686         {
1687                 theObject = yaffs_CreateNewObject(dev,number,type);
1688         }
1689
1690         return theObject;
1691
1692 }
1693
1694 char *yaffs_CloneString(const char *str)
1695 {
1696         char *newStr = NULL;
1697
1698         if(str && *str)
1699         {
1700                 newStr = YMALLOC(strlen(str) + 1);
1701                 strcpy(newStr,str);
1702         }
1703
1704         return newStr;
1705
1706 }
1707
1708 //
1709 // Mknod (create) a new object.
1710 // equivalentObject only has meaning for a hard link;
1711 // aliasString only has meaning for a sumlink.
1712 // rdev only has meaning for devices (a subset of special objects)
1713 yaffs_Object *yaffs_MknodObject( yaffs_ObjectType type,
1714                                                                  yaffs_Object *parent,
1715                                                                  const char *name,
1716                                                                  __u32 mode,
1717                                                                  __u32 uid,
1718                                                                  __u32 gid,
1719                                                                  yaffs_Object *equivalentObject,
1720                                                                  const char *aliasString,
1721                                                                  __u32 rdev)
1722 {
1723         yaffs_Object *in;
1724
1725         yaffs_Device *dev = parent->myDev;
1726
1727         // Check if the entry exists. If it does then fail the call since we don't want a dup.
1728         if(yaffs_FindObjectByName(parent,name))
1729         {
1730                 return NULL;
1731         }
1732
1733         in = yaffs_CreateNewObject(dev,-1,type);
1734
1735         if(in)
1736         {
1737                 in->chunkId = -1;
1738                 in->valid = 1;
1739                 in->variantType = type;
1740
1741                 in->st_mode  = mode;
1742
1743 #ifdef CONFIG_YAFFS_WINCE
1744                 yfsd_WinFileTimeNow(in->win_atime);
1745                 in->win_ctime[0] = in->win_mtime[0] = in->win_atime[0];
1746                 in->win_ctime[1] = in->win_mtime[1] = in->win_atime[1];
1747
1748 #else
1749 #if defined(CONFIG_KERNEL_2_5)
1750                 in->st_atime = in->st_mtime = in->st_ctime = CURRENT_TIME.tv_sec;
1751 #else
1752                 in->st_atime = in->st_mtime = in->st_ctime = CURRENT_TIME;
1753 #endif
1754                 in->st_rdev  = rdev;
1755                 in->st_uid   = uid;
1756                 in->st_gid   = gid;
1757 #endif
1758                 in->nDataChunks = 0;
1759
1760                 yaffs_SetObjectName(in,name);
1761                 in->dirty = 1;
1762
1763                 yaffs_AddObjectToDirectory(parent,in);
1764
1765                 in->myDev = parent->myDev;
1766
1767
1768                 switch(type)
1769                 {
1770                         case YAFFS_OBJECT_TYPE_SYMLINK:
1771                                 in->variant.symLinkVariant.alias = yaffs_CloneString(aliasString);
1772                                 break;
1773                         case YAFFS_OBJECT_TYPE_HARDLINK:
1774                                 in->variant.hardLinkVariant.equivalentObject = equivalentObject;
1775                                 in->variant.hardLinkVariant.equivalentObjectId = equivalentObject->objectId;
1776                                 list_add(&in->hardLinks,&equivalentObject->hardLinks);
1777                                 break;
1778                         case YAFFS_OBJECT_TYPE_FILE: // do nothing
1779                         case YAFFS_OBJECT_TYPE_DIRECTORY: // do nothing
1780                         case YAFFS_OBJECT_TYPE_SPECIAL: // do nothing
1781                         case YAFFS_OBJECT_TYPE_UNKNOWN:
1782                                 break;
1783                 }
1784
1785                 if(/*yaffs_GetNumberOfFreeChunks(dev) <= 0 || */
1786                    yaffs_UpdateObjectHeader(in,name,0) < 0)
1787                 {
1788                         // Could not create the object header, fail the creation
1789                         yaffs_AbortHalfCreatedObject(in);
1790                         in = NULL;
1791                 }
1792
1793         }
1794
1795         return in;
1796 }
1797
1798 yaffs_Object *yaffs_MknodFile(yaffs_Object *parent,const char *name, __u32 mode, __u32 uid, __u32 gid)
1799 {
1800         return yaffs_MknodObject(YAFFS_OBJECT_TYPE_FILE,parent,name,mode,uid,gid,NULL,NULL,0);
1801 }
1802
1803 yaffs_Object *yaffs_MknodDirectory(yaffs_Object *parent,const char *name, __u32 mode, __u32 uid, __u32 gid)
1804 {
1805         return yaffs_MknodObject(YAFFS_OBJECT_TYPE_DIRECTORY,parent,name,mode,uid,gid,NULL,NULL,0);
1806 }
1807
1808 yaffs_Object *yaffs_MknodSpecial(yaffs_Object *parent,const char *name, __u32 mode, __u32 uid, __u32 gid, __u32 rdev)
1809 {
1810         return yaffs_MknodObject(YAFFS_OBJECT_TYPE_DIRECTORY,parent,name,mode,uid,gid,NULL,NULL,rdev);
1811 }
1812
1813 yaffs_Object *yaffs_MknodSymLink(yaffs_Object *parent,const char *name, __u32 mode, __u32 uid, __u32 gid,const char *alias)
1814 {
1815         return yaffs_MknodObject(YAFFS_OBJECT_TYPE_SYMLINK,parent,name,mode,uid,gid,NULL,alias,0);
1816 }
1817
1818 // NB yaffs_Link returns the object id of the equivalent object.
1819 yaffs_Object *yaffs_Link(yaffs_Object *parent, const char *name, yaffs_Object *equivalentObject)
1820 {
1821         // Get the real object in case we were fed a hard link as an equivalent object
1822         equivalentObject = yaffs_GetEquivalentObject(equivalentObject);
1823
1824         if(yaffs_MknodObject(YAFFS_OBJECT_TYPE_HARDLINK,parent,name,0,0,0,equivalentObject,NULL,0))
1825         {
1826                 return equivalentObject;
1827         }
1828         else
1829         {
1830                 return NULL;
1831         }
1832
1833 }
1834
1835
1836 static int yaffs_ChangeObjectName(yaffs_Object *obj, yaffs_Object *newDir, const char *newName,int force)
1837 {
1838         int unlinkOp;
1839
1840         if(newDir == NULL)
1841         {
1842                 newDir = obj->parent; // use the old directory
1843         }
1844
1845         unlinkOp = (newDir == obj->myDev->unlinkedDir && obj->variantType == YAFFS_OBJECT_TYPE_FILE);
1846
1847         // If the object is a file going into the unlinked directory, then it is OK to just stuff it in since
1848         // duplicate names are allowed.
1849         // Otherwise only proceed if the new name does not exist and if we're putting it into a directory.
1850         if( (unlinkOp||
1851                  force ||
1852                  !yaffs_FindObjectByName(newDir,newName))  &&
1853              newDir->variantType == YAFFS_OBJECT_TYPE_DIRECTORY)
1854         {
1855                 yaffs_SetObjectName(obj,newName);
1856                 obj->dirty = 1;
1857
1858                 yaffs_AddObjectToDirectory(newDir,obj);
1859
1860                 if(unlinkOp) obj->unlinked = 1;
1861
1862
1863                 if(yaffs_UpdateObjectHeader(obj,newName,0) >= 0)
1864                 {
1865                         return YAFFS_OK;
1866                 }
1867         }
1868
1869         return YAFFS_FAIL;
1870 }
1871
1872
1873
1874 int yaffs_RenameObject(yaffs_Object *oldDir, const char *oldName, yaffs_Object *newDir, const char *newName)
1875 {
1876         yaffs_Object *obj;
1877         int force = 0;
1878
1879 #ifdef CONFIG_YAFFS_CASE_INSENSITIVE
1880         // Special case for WinCE.
1881         // While look-up is case insensitive, the name isn't.
1882         // THerefore we might want to change x.txt to X.txt
1883         if(oldDir == newDir && _stricmp(oldName,newName) == 0)
1884         {
1885                 force = 1;
1886         }
1887 #endif
1888
1889         obj = yaffs_FindObjectByName(oldDir,oldName);
1890         if(obj && obj->renameAllowed)
1891         {
1892                 return yaffs_ChangeObjectName(obj,newDir,newName,force);
1893         }
1894         return YAFFS_FAIL;
1895 }
1896
1897
1898
1899 static int yaffs_CheckObjectHashSanity(yaffs_Device *dev)
1900 {
1901         // Scan the buckets and check that the lists
1902         // have as many members as the count says there are
1903         int bucket;
1904         int countEm;
1905         struct list_head *j;
1906         int ok = YAFFS_OK;
1907
1908         for(bucket = 0; bucket < YAFFS_NOBJECT_BUCKETS; bucket++)
1909         {
1910                 countEm = 0;
1911
1912                 list_for_each(j,&dev->objectBucket[bucket].list)
1913                 {
1914                         countEm++;
1915                 }
1916
1917                 if(countEm != dev->objectBucket[bucket].count)
1918                 {
1919                         T(YAFFS_TRACE_ERROR,(TSTR("Inode hash inconsistency" TENDSTR)));
1920                         ok = YAFFS_FAIL;
1921                 }
1922         }
1923
1924         return ok;
1925 }
1926
1927 #if 0
1928 void yaffs_ObjectTest(yaffs_Device *dev)
1929 {
1930         yaffs_Object *in[1000];
1931         int inNo[1000];
1932         yaffs_Object *inold[1000];
1933         int i;
1934         int j;
1935
1936         memset(in,0,1000*sizeof(yaffs_Object *));
1937         memset(inold,0,1000*sizeof(yaffs_Object *));
1938
1939         yaffs_CheckObjectHashSanity(dev);
1940
1941         for(j = 0; j < 10; j++)
1942         {
1943                 //T(("%d\n",j));
1944
1945                 for(i = 0; i < 1000; i++)
1946                 {
1947                         in[i] = yaffs_CreateNewObject(dev,-1,YAFFS_OBJECT_TYPE_FILE);
1948                         if(!in[i])
1949                         {
1950                                 YINFO("No more inodes");
1951                         }
1952                         else
1953                         {
1954                                 inNo[i] = in[i]->objectId;
1955                         }
1956                 }
1957
1958                 for(i = 0; i < 1000; i++)
1959                 {
1960                         if(yaffs_FindObjectByNumber(dev,inNo[i]) != in[i])
1961                         {
1962                                 //T(("Differnce in look up test\n"));
1963                         }
1964                         else
1965                         {
1966                                 // T(("Look up ok\n"));
1967                         }
1968                 }
1969
1970                 yaffs_CheckObjectHashSanity(dev);
1971
1972                 for(i = 0; i < 1000; i+=3)
1973                 {
1974                         yaffs_FreeObject(in[i]);
1975                         in[i] = NULL;
1976                 }
1977
1978
1979                 yaffs_CheckObjectHashSanity(dev);
1980         }
1981
1982 }
1983
1984 #endif
1985
1986 /////////////////////////// Block Management and Page Allocation ///////////////////
1987
1988
1989 static int yaffs_InitialiseBlocks(yaffs_Device *dev,int nBlocks)
1990 {
1991         dev->allocationBlock = -1; // force it to get a new one
1992         //Todo we're assuming the malloc will pass.
1993         dev->blockInfo = YMALLOC(nBlocks * sizeof(yaffs_BlockInfo));
1994         // Set up dynamic blockinfo stuff.
1995         dev->chunkBitmapStride = (dev->nChunksPerBlock+7)/8;
1996         dev->chunkBits = YMALLOC(dev->chunkBitmapStride * nBlocks);
1997         if(dev->blockInfo && dev->chunkBits)
1998         {
1999                 memset(dev->blockInfo,0,nBlocks * sizeof(yaffs_BlockInfo));
2000                 memset(dev->chunkBits,0,dev->chunkBitmapStride * nBlocks);
2001                 return YAFFS_OK;
2002         }
2003
2004         return YAFFS_FAIL;
2005
2006 }
2007
2008 static void yaffs_DeinitialiseBlocks(yaffs_Device *dev)
2009 {
2010         YFREE(dev->blockInfo);
2011         dev->blockInfo = NULL;
2012         YFREE(dev->chunkBits);
2013         dev->chunkBits = NULL;
2014 }
2015
2016 // FindDiretiestBlock is used to select the dirtiest block (or close enough)
2017 // for garbage collection.
2018
2019 static int yaffs_FindDirtiestBlock(yaffs_Device *dev,int aggressive)
2020 {
2021
2022         int b = dev->currentDirtyChecker;
2023
2024         int i;
2025         int iterations;
2026         int dirtiest = -1;
2027         int pagesInUse;
2028         yaffs_BlockInfo *bi;
2029
2030         // If we're doing aggressive GC then we are happy to take a less-dirty block, and
2031         // search further.
2032
2033         pagesInUse = (aggressive)? dev->nChunksPerBlock : YAFFS_PASSIVE_GC_CHUNKS + 1;
2034         if(aggressive)
2035         {
2036                 iterations = dev->endBlock - dev->startBlock + 1;
2037         }
2038         else
2039         {
2040                 iterations = dev->endBlock - dev->startBlock + 1;
2041                 iterations = iterations / 16;
2042                 if(iterations > 200)
2043                 {
2044                         iterations = 200;
2045                 }
2046         }
2047
2048         for(i = 0; i <= iterations && pagesInUse > 0 ; i++)
2049         {
2050                 b++;
2051                 if ( b < dev->startBlock || b > dev->endBlock)
2052                 {
2053                         b =  dev->startBlock;
2054                 }
2055
2056                 if(b < dev->startBlock || b > dev->endBlock)
2057                 {
2058                         T(YAFFS_TRACE_ERROR,(TSTR("**>> Block %d is not valid" TENDSTR),b));
2059                         YBUG();
2060                 }
2061
2062                 bi = yaffs_GetBlockInfo(dev,b);
2063
2064                 if(bi->blockState == YAFFS_BLOCK_STATE_FULL &&
2065                    (bi->pagesInUse - bi->softDeletions )< pagesInUse)
2066                 {
2067                         dirtiest = b;
2068                         pagesInUse = (bi->pagesInUse - bi->softDeletions);
2069                 }
2070         }
2071
2072         dev->currentDirtyChecker = b;
2073
2074         return dirtiest;
2075 }
2076
2077
2078 static void yaffs_BlockBecameDirty(yaffs_Device *dev,int blockNo)
2079 {
2080         yaffs_BlockInfo *bi = yaffs_GetBlockInfo(dev,blockNo);
2081
2082         int erasedOk = 0;
2083
2084         // If the block is still healthy erase it and mark as clean.
2085         // If the block has had a data failure, then retire it.
2086         bi->blockState = YAFFS_BLOCK_STATE_DIRTY;
2087
2088         if(!bi->needsRetiring)
2089         {
2090                 erasedOk = yaffs_EraseBlockInNAND(dev,blockNo);
2091                 if(!erasedOk)
2092                 {
2093                         T(YAFFS_TRACE_ERROR | YAFFS_TRACE_BAD_BLOCKS,(TSTR("**>> Erasure failed %d" TENDSTR),blockNo));
2094                 }
2095         }
2096
2097         if( erasedOk )
2098         {
2099                 // Clean it up...
2100                 bi->blockState = YAFFS_BLOCK_STATE_EMPTY;
2101                 dev->nErasedBlocks++;
2102                 bi->pagesInUse = 0;
2103                 bi->softDeletions = 0;
2104                 yaffs_ClearChunkBits(dev,blockNo);
2105
2106                 T(YAFFS_TRACE_ERASE,(TSTR("Erased block %d" TENDSTR),blockNo));
2107         }
2108         else
2109         {
2110                 yaffs_RetireBlock(dev,blockNo);
2111                 T(YAFFS_TRACE_ERROR | YAFFS_TRACE_BAD_BLOCKS,(TSTR("**>> Block %d retired" TENDSTR),blockNo));
2112         }
2113 }
2114
2115
2116 static int yaffs_FindBlockForAllocation(yaffs_Device *dev)
2117 {
2118         int i;
2119
2120         yaffs_BlockInfo *bi;
2121
2122         if(dev->nErasedBlocks < 1)
2123         {
2124                 // Hoosterman we've got a problem.
2125                 // Can't get space to gc
2126                 T(YAFFS_TRACE_ERROR, (TSTR("yaffs tragedy: no space during gc" TENDSTR)));
2127
2128                 return -1;
2129         }
2130
2131         // Find an empty block.
2132
2133         for(i = dev->startBlock; i <= dev->endBlock; i++)
2134         {
2135                 dev->allocationBlockFinder++;
2136                 if(dev->allocationBlockFinder <dev->startBlock || dev->allocationBlockFinder> dev->endBlock)
2137                 {
2138                         dev->allocationBlockFinder = dev->startBlock;
2139                 }
2140
2141                 bi = yaffs_GetBlockInfo(dev,dev->allocationBlockFinder);
2142
2143                 if(bi->blockState == YAFFS_BLOCK_STATE_EMPTY)
2144                 {
2145                         bi->blockState = YAFFS_BLOCK_STATE_ALLOCATING;
2146                         dev->nErasedBlocks--;
2147                         return dev->allocationBlockFinder;
2148                 }
2149         }
2150
2151         return -1;
2152 }
2153
2154
2155
2156 static int yaffs_AllocateChunk(yaffs_Device *dev,int useReserve)
2157 {
2158         int retVal;
2159         yaffs_BlockInfo *bi;
2160
2161         if(dev->allocationBlock < 0)
2162         {
2163                 // Get next block to allocate off
2164                 dev->allocationBlock = yaffs_FindBlockForAllocation(dev);
2165                 dev->allocationPage = 0;
2166         }
2167
2168         if(!useReserve &&  dev->nErasedBlocks <= dev->nReservedBlocks)
2169         {
2170                 // Not enough space to allocate unless we're allowed to use the reserve.
2171                 return -1;
2172         }
2173
2174         // Next page please....
2175         if(dev->allocationBlock >= 0)
2176         {
2177                 bi = yaffs_GetBlockInfo(dev,dev->allocationBlock);
2178
2179                 retVal = (dev->allocationBlock * dev->nChunksPerBlock) +
2180                                   dev->allocationPage;
2181                 bi->pagesInUse++;
2182                 yaffs_SetChunkBit(dev,dev->allocationBlock,dev->allocationPage);
2183
2184                 dev->allocationPage++;
2185
2186                 dev->nFreeChunks--;
2187
2188                 // If the block is full set the state to full
2189                 if(dev->allocationPage >= dev->nChunksPerBlock)
2190                 {
2191                         bi->blockState = YAFFS_BLOCK_STATE_FULL;
2192                         dev->allocationBlock = -1;
2193                 }
2194
2195
2196                 return retVal;
2197
2198         }
2199         T(YAFFS_TRACE_ERROR,(TSTR("!!!!!!!!! Allocator out !!!!!!!!!!!!!!!!!" TENDSTR)));
2200
2201         return -1;
2202 }
2203
2204 // To determine if we have enough space we just look at the
2205 // number of erased blocks.
2206 // The cache is allowed to use reserved blocks.
2207
2208 static int yaffs_CheckSpaceForChunkCache(yaffs_Device *dev)
2209 {
2210         return (dev->nErasedBlocks >= dev->nReservedBlocks);
2211 }
2212
2213
2214 static int  yaffs_GarbageCollectBlock(yaffs_Device *dev,int block)
2215 {
2216         int oldChunk;
2217         int newChunk;
2218         int chunkInBlock;
2219         int markNAND;
2220
2221
2222         yaffs_Spare spare;
2223         yaffs_Tags  tags;
2224         __u8  buffer[YAFFS_BYTES_PER_CHUNK];
2225
2226 //      yaffs_BlockInfo *bi = yaffs_GetBlockInfo(dev,block);
2227
2228         yaffs_Object *object;
2229
2230         //T(("Collecting block %d n %d bits %x\n",block, bi->pagesInUse, bi->pageBits));
2231
2232         for(chunkInBlock = 0,oldChunk = block * dev->nChunksPerBlock;
2233             chunkInBlock < dev->nChunksPerBlock && yaffs_StillSomeChunkBits(dev,block);
2234             chunkInBlock++, oldChunk++ )
2235         {
2236                 if(yaffs_CheckChunkBit(dev,block,chunkInBlock))
2237                 {
2238
2239                         // This page is in use and might need to be copied off
2240
2241                         markNAND = 1;
2242
2243                         //T(("copying page %x from %d to %d\n",mask,oldChunk,newChunk));
2244
2245                         yaffs_ReadChunkFromNAND(dev,oldChunk,buffer, &spare,1);
2246
2247                         yaffs_GetTagsFromSpare(dev,&spare,&tags);
2248
2249                         object = yaffs_FindObjectByNumber(dev,tags.objectId);
2250
2251                         if(object && object->deleted && tags.chunkId != 0)
2252                         {
2253                                 // Data chunk in a deleted file, throw it away
2254                                 // It's a deleted data chunk,
2255                                 // No need to copy this, just forget about it and fix up the
2256                                 // object.
2257
2258                                 //yaffs_PutChunkIntoFile(object, tags.chunkId, 0,0);
2259                                 object->nDataChunks--;
2260
2261                                 if(object->nDataChunks <= 0)
2262                                 {
2263                                         // Time to delete the file too
2264                                         yaffs_FreeTnode(object->myDev,object->variant.fileVariant.top);
2265                                         object->variant.fileVariant.top = NULL;
2266                                         T(YAFFS_TRACE_TRACING,(TSTR("yaffs: About to finally delete object %d" TENDSTR),object->objectId));
2267                                         yaffs_DoGenericObjectDeletion(object);
2268                                 }
2269                                 markNAND = 0;
2270                         }
2271                         else if( 0 /* Todo object && object->deleted && object->nDataChunks == 0 */)
2272                         {
2273                                 // Deleted object header with no data chunks.
2274                                 // Can be discarded and the file deleted.
2275                                 object->chunkId = 0;
2276                                 yaffs_FreeTnode(object->myDev,object->variant.fileVariant.top);
2277                                 object->variant.fileVariant.top = NULL;
2278                                 yaffs_DoGenericObjectDeletion(object);
2279
2280                         }
2281                         else if(object)
2282                         {
2283                                 // It's either a data chunk in a live file or
2284                                 // an ObjectHeader, so we're interested in it.
2285                                 // NB Need to keep the ObjectHeaders of deleted files
2286                                 // until the whole file has been deleted off
2287                                 tags.serialNumber++;
2288                                 yaffs_LoadTagsIntoSpare(&spare,&tags);
2289
2290                                 dev->nGCCopies++;
2291
2292                                 newChunk = yaffs_WriteNewChunkToNAND(dev, buffer, &spare,1);
2293
2294                                 if(newChunk < 0)
2295                                 {
2296                                         return YAFFS_FAIL;
2297                                 }
2298
2299                                 // Ok, now fix up the Tnodes etc.
2300
2301                                 if(tags.chunkId == 0)
2302                                 {
2303                                         // It's a header
2304                                         object->chunkId = newChunk;
2305                                         object->serial = tags.serialNumber;
2306                                 }
2307                                 else
2308                                 {
2309                                         // It's a data chunk
2310                                         yaffs_PutChunkIntoFile(object, tags.chunkId, newChunk,0);
2311                                 }
2312                         }
2313
2314                         yaffs_DeleteChunk(dev,oldChunk,markNAND);
2315
2316                 }
2317         }
2318
2319         return YAFFS_OK;
2320 }
2321
2322
2323 static yaffs_Object *yaffs_FindDeletedUnlinkedFile(yaffs_Device *dev)
2324 {
2325         // find a file to delete
2326         struct list_head *i;
2327         yaffs_Object *l;
2328
2329
2330         //Scan the unlinked files looking for one to delete
2331         list_for_each(i,&dev->unlinkedDir->variant.directoryVariant.children)
2332         {
2333                 if(i)
2334                 {
2335                         l = list_entry(i, yaffs_Object,siblings);
2336                         if(l->deleted)
2337                         {
2338                                 return l;
2339                         }
2340                 }
2341         }
2342         return NULL;
2343 }
2344
2345
2346 static void yaffs_DoUnlinkedFileDeletion(yaffs_Device *dev)
2347 {
2348         // This does background deletion on unlinked files.. only deleted ones.
2349         // If we don't have a file we're working on then find one
2350         if(!dev->unlinkedDeletion && dev->nDeletedFiles > 0)
2351         {
2352                 dev->unlinkedDeletion = yaffs_FindDeletedUnlinkedFile(dev);
2353         }
2354
2355         // OK, we're working on a file...
2356         if(dev->unlinkedDeletion)
2357         {
2358                 yaffs_Object *obj = dev->unlinkedDeletion;
2359                 int delresult;
2360                 int limit; // Number of chunks to delete in a file.
2361                                    // NB this can be exceeded, but not by much.
2362
2363                 limit = -1;
2364
2365                 delresult = yaffs_DeleteWorker(obj, obj->variant.fileVariant.top, obj->variant.fileVariant.topLevel, 0,&limit);
2366
2367                 if(obj->nDataChunks == 0)
2368                 {
2369                         // Done all the deleting of data chunks.
2370                         // Now dump the header and clean up
2371                         yaffs_FreeTnode(dev,obj->variant.fileVariant.top);
2372                         obj->variant.fileVariant.top = NULL;
2373                         yaffs_DoGenericObjectDeletion(obj);
2374                         dev->nDeletedFiles--;
2375                         dev->nUnlinkedFiles--;
2376                         dev->nBackgroundDeletions++;
2377                         dev->unlinkedDeletion = NULL;
2378                 }
2379         }
2380 }
2381
2382
2383 #if 0
2384 #define YAFFS_GARBAGE_COLLECT_LOW_WATER 2
2385 static int yaffs_CheckGarbageCollection(yaffs_Device *dev)
2386 {
2387         int block;
2388         int aggressive=0;
2389
2390         //yaffs_DoUnlinkedFileDeletion(dev);
2391
2392         if(dev->nErasedBlocks <= (dev->nReservedBlocks + YAFFS_GARBAGE_COLLECT_LOW_WATER))
2393         {
2394                 aggressive = 1;
2395         }
2396
2397         if(aggressive)
2398         {
2399                 block = yaffs_FindDirtiestBlock(dev,aggressive);
2400
2401                 if(block >= 0)
2402                 {
2403                         dev->garbageCollections++;
2404                         return yaffs_GarbageCollectBlock(dev,block);
2405                 }
2406                 else
2407                 {
2408                         return YAFFS_FAIL;
2409                 }
2410         }
2411
2412         return YAFFS_OK;
2413 }
2414 #endif
2415
2416 // New garbage collector
2417 // If we're very low on erased blocks then we do aggressive garbage collection
2418 // otherwise we do "passive" garbage collection.
2419 // Aggressive gc looks further (whole array) and will accept dirtier blocks.
2420 // Passive gc only inspects smaller areas and will only accept cleaner blocks.
2421 //
2422 // The idea is to help clear out space in a more spread-out manner.
2423 // Dunno if it really does anything useful.
2424 //
2425 static int yaffs_CheckGarbageCollection(yaffs_Device *dev)
2426 {
2427         int block;
2428         int aggressive=0;
2429
2430         //yaffs_DoUnlinkedFileDeletion(dev);
2431
2432         if(dev->nErasedBlocks <= (dev->nReservedBlocks + 1))
2433         {
2434                 aggressive = 1;
2435         }
2436
2437         block = yaffs_FindDirtiestBlock(dev,aggressive);
2438
2439         if(block >= 0)
2440         {
2441                 dev->garbageCollections++;
2442                 if(!aggressive)
2443                 {
2444                         dev->passiveGarbageCollections++;
2445                 }
2446
2447                 T(YAFFS_TRACE_GC,(TSTR("yaffs: GC erasedBlocks %d aggressive %d" TENDSTR),dev->nErasedBlocks,aggressive));
2448
2449                 return yaffs_GarbageCollectBlock(dev,block);
2450         }
2451
2452         return aggressive ? YAFFS_FAIL : YAFFS_OK;
2453 }
2454
2455
2456 //////////////////////////// TAGS ///////////////////////////////////////
2457
2458 static void yaffs_LoadTagsIntoSpare(yaffs_Spare *sparePtr, yaffs_Tags *tagsPtr)
2459 {
2460         yaffs_TagsUnion *tu = (yaffs_TagsUnion *)tagsPtr;
2461
2462         yaffs_CalcTagsECC(tagsPtr);
2463
2464         sparePtr->tagByte0 = tu->asBytes[0];
2465         sparePtr->tagByte1 = tu->asBytes[1];
2466         sparePtr->tagByte2 = tu->asBytes[2];
2467         sparePtr->tagByte3 = tu->asBytes[3];
2468         sparePtr->tagByte4 = tu->asBytes[4];
2469         sparePtr->tagByte5 = tu->asBytes[5];
2470         sparePtr->tagByte6 = tu->asBytes[6];
2471         sparePtr->tagByte7 = tu->asBytes[7];
2472 }
2473
2474 static void yaffs_GetTagsFromSpare(yaffs_Device *dev, yaffs_Spare *sparePtr,yaffs_Tags *tagsPtr)
2475 {
2476         yaffs_TagsUnion *tu = (yaffs_TagsUnion *)tagsPtr;
2477         int result;
2478
2479         tu->asBytes[0]= sparePtr->tagByte0;
2480         tu->asBytes[1]= sparePtr->tagByte1;
2481         tu->asBytes[2]= sparePtr->tagByte2;
2482         tu->asBytes[3]= sparePtr->tagByte3;
2483         tu->asBytes[4]= sparePtr->tagByte4;
2484         tu->asBytes[5]= sparePtr->tagByte5;
2485         tu->asBytes[6]= sparePtr->tagByte6;
2486         tu->asBytes[7]= sparePtr->tagByte7;
2487
2488         result =  yaffs_CheckECCOnTags(tagsPtr);
2489         if(result> 0)
2490         {
2491                 dev->tagsEccFixed++;
2492         }
2493         else if(result <0)
2494         {
2495                 dev->tagsEccUnfixed++;
2496         }
2497 }
2498
2499 static void yaffs_SpareInitialise(yaffs_Spare *spare)
2500 {
2501         memset(spare,0xFF,sizeof(yaffs_Spare));
2502 }
2503
2504 static int yaffs_ReadChunkTagsFromNAND(yaffs_Device *dev,int chunkInNAND, yaffs_Tags *tags, int *chunkDeleted)
2505 {
2506         if(tags)
2507         {
2508                 yaffs_Spare spare;
2509                 if(yaffs_ReadChunkFromNAND(dev,chunkInNAND,NULL,&spare,1) == YAFFS_OK)
2510                 {
2511                         *chunkDeleted = (yaffs_CountBits(spare.pageStatus) < 7) ? 1 : 0;
2512                         yaffs_GetTagsFromSpare(dev,&spare,tags);
2513                         return YAFFS_OK;
2514                 }
2515                 else
2516                 {
2517                         return YAFFS_FAIL;
2518                 }
2519         }
2520
2521         return YAFFS_OK;
2522 }
2523
2524 #if 0
2525 static int yaffs_WriteChunkWithTagsToNAND(yaffs_Device *dev,int chunkInNAND, const __u8 *buffer, yaffs_Tags *tags)
2526 {
2527         // NB There must be tags, data is optional
2528         // If there is data, then an ECC is calculated on it.
2529
2530         yaffs_Spare spare;
2531
2532         if(!tags)
2533         {
2534                 return YAFFS_FAIL;
2535         }
2536
2537         yaffs_SpareInitialise(&spare);
2538
2539         if(!dev->useNANDECC && buffer)
2540         {
2541                 yaffs_CalcECC(buffer,&spare);
2542         }
2543
2544         yaffs_LoadTagsIntoSpare(&spare,tags);
2545
2546         return yaffs_WriteChunkToNAND(dev,chunkInNAND,buffer,&spare);
2547
2548 }
2549 #endif
2550
2551
2552 static int yaffs_WriteNewChunkWithTagsToNAND(yaffs_Device *dev, const __u8 *buffer, yaffs_Tags *tags, int useReserve)
2553 {
2554         // NB There must be tags, data is optional
2555         // If there is data, then an ECC is calculated on it.
2556
2557         yaffs_Spare spare;
2558
2559         if(!tags)
2560         {
2561                 return YAFFS_FAIL;
2562         }
2563
2564         yaffs_SpareInitialise(&spare);
2565
2566         if(!dev->useNANDECC && buffer)
2567         {
2568                 yaffs_CalcECC(buffer,&spare);
2569         }
2570
2571         yaffs_LoadTagsIntoSpare(&spare,tags);
2572
2573         return yaffs_WriteNewChunkToNAND(dev,buffer,&spare,useReserve);
2574
2575 }
2576
2577 static int yaffs_TagsMatch(const yaffs_Tags *tags, int objectId, int chunkInObject, int chunkDeleted)
2578 {
2579         return  (  tags->chunkId == chunkInObject &&
2580                            tags->objectId == objectId &&
2581                            !chunkDeleted) ? 1 : 0;
2582
2583 }
2584
2585
2586
2587 int yaffs_FindChunkInFile(yaffs_Object *in,int chunkInInode,yaffs_Tags *tags)
2588 {
2589         //Get the Tnode, then get the level 0 offset chunk offset
2590     yaffs_Tnode *tn;
2591     int theChunk = -1;
2592     yaffs_Tags localTags;
2593     int i;
2594     int found = 0;
2595     int chunkDeleted;
2596
2597     yaffs_Device *dev = in->myDev;
2598
2599
2600     if(!tags)
2601     {
2602         // Passed a NULL, so use our own tags space
2603         tags = &localTags;
2604     }
2605
2606     tn = yaffs_FindLevel0Tnode(dev,&in->variant.fileVariant, chunkInInode);
2607
2608     if(tn)
2609     {
2610                 theChunk = tn->level0[chunkInInode & YAFFS_TNODES_LEVEL0_MASK] << dev->chunkGroupBits;
2611
2612                 // Now we need to do the shifting etc and search for it
2613                 for(i = 0,found = 0; theChunk && i < dev->chunkGroupSize && !found; i++)
2614                 {
2615                         yaffs_ReadChunkTagsFromNAND(dev,theChunk,tags,&chunkDeleted);
2616                         if(yaffs_TagsMatch(tags,in->objectId,chunkInInode,chunkDeleted))
2617                         {
2618                                 // found it;
2619                                 found = 1;
2620                         }
2621                         else
2622                         {
2623                                 theChunk++;
2624                         }
2625                 }
2626     }
2627     return found ? theChunk : -1;
2628 }
2629
2630 int yaffs_FindAndDeleteChunkInFile(yaffs_Object *in,int chunkInInode,yaffs_Tags *tags)
2631 {
2632         //Get the Tnode, then get the level 0 offset chunk offset
2633     yaffs_Tnode *tn;
2634     int theChunk = -1;
2635     yaffs_Tags localTags;
2636     int i;
2637     int found = 0;
2638     yaffs_Device *dev = in->myDev;
2639     int chunkDeleted;
2640
2641     if(!tags)
2642     {
2643         // Passed a NULL, so use our own tags space
2644         tags = &localTags;
2645     }
2646
2647     tn = yaffs_FindLevel0Tnode(dev,&in->variant.fileVariant, chunkInInode);
2648
2649     if(tn)
2650     {
2651
2652                 theChunk = tn->level0[chunkInInode & YAFFS_TNODES_LEVEL0_MASK] << dev->chunkGroupBits;
2653
2654                 // Now we need to do the shifting etc and search for it
2655                 for(i = 0,found = 0; theChunk && i < dev->chunkGroupSize && !found; i++)
2656                 {
2657                         yaffs_ReadChunkTagsFromNAND(dev,theChunk,tags,&chunkDeleted);
2658                         if(yaffs_TagsMatch(tags,in->objectId,chunkInInode,chunkDeleted))
2659                         {
2660                                 // found it;
2661                                 found = 1;
2662                         }
2663                         else
2664                         {
2665                                 theChunk++;
2666                         }
2667                 }
2668
2669                 // Delete the entry in the filestructure
2670                 if(found)
2671                 {
2672                         tn->level0[chunkInInode & YAFFS_TNODES_LEVEL0_MASK] = 0;
2673                 }
2674     }
2675     else
2676     {
2677         //T(("No level 0 found for %d\n", chunkInInode));
2678     }
2679
2680     if(!found)
2681     {
2682         //T(("Could not find %d to delete\n",chunkInInode));
2683     }
2684     return found ? theChunk : -1;
2685 }
2686
2687
2688 #ifdef YAFFS_PARANOID
2689
2690 static int yaffs_CheckFileSanity(yaffs_Object *in)
2691 {
2692         int chunk;
2693         int nChunks;
2694         int fSize;
2695         int failed = 0;
2696         int objId;
2697         yaffs_Tnode *tn;
2698     yaffs_Tags localTags;
2699     yaffs_Tags *tags = &localTags;
2700     int theChunk;
2701     int chunkDeleted;
2702
2703
2704         if(in->variantType != YAFFS_OBJECT_TYPE_FILE)
2705         {
2706                 //T(("Object not a file\n"));
2707                 return YAFFS_FAIL;
2708         }
2709
2710         objId = in->objectId;
2711         fSize  = in->variant.fileVariant.fileSize;
2712         nChunks = (fSize + in->myDev->nBytesPerChunk -1)/in->myDev->nBytesPerChunk;
2713
2714         for(chunk = 1; chunk <= nChunks; chunk++)
2715         {
2716                 tn = yaffs_FindLevel0Tnode(in->myDev,&in->variant.fileVariant, chunk);
2717
2718                 if(tn)
2719                 {
2720
2721                         theChunk = tn->level0[chunk & YAFFS_TNODES_LEVEL0_MASK] << in->myDev->chunkGroupBits;
2722
2723
2724                                 yaffs_ReadChunkTagsFromNAND(in->myDev,theChunk,tags,&chunkDeleted);
2725                                 if(yaffs_TagsMatch(tags,in->objectId,chunk,chunkDeleted))
2726                                 {
2727                                         // found it;
2728
2729                                 }
2730                                 else
2731                                 {
2732                                         //T(("File problem file [%d,%d] NAND %d  tags[%d,%d]\n",
2733                                         //              objId,chunk,theChunk,tags->chunkId,tags->objectId);
2734
2735                                         failed = 1;
2736
2737                                 }
2738
2739                 }
2740                 else
2741                 {
2742                         //T(("No level 0 found for %d\n", chunk));
2743                 }
2744         }
2745
2746         return failed ? YAFFS_FAIL : YAFFS_OK;
2747 }
2748
2749 #endif
2750
2751 static int yaffs_PutChunkIntoFile(yaffs_Object *in,int chunkInInode, int chunkInNAND, int inScan)
2752 {
2753         yaffs_Tnode *tn;
2754         yaffs_Device *dev = in->myDev;
2755         int existingChunk;
2756         yaffs_Tags existingTags;
2757         yaffs_Tags newTags;
2758         unsigned existingSerial, newSerial;
2759
2760         int newChunkDeleted;
2761
2762
2763         tn = yaffs_AddOrFindLevel0Tnode(dev,&in->variant.fileVariant, chunkInInode);
2764         if(!tn)
2765         {
2766                 return YAFFS_FAIL;
2767         }
2768
2769         existingChunk = tn->level0[chunkInInode & YAFFS_TNODES_LEVEL0_MASK];
2770
2771         if(inScan)
2772         {
2773                 // If we're scanning then we need to test for duplicates
2774                 // NB This does not need to be efficient since it should only ever
2775                 // happen when the power fails during a write, then only one
2776                 // chunk should ever be affected.
2777
2778
2779                 if(existingChunk != 0)
2780                 {
2781                         // NB Right now existing chunk will not be real chunkId if the device >= 32MB
2782                         //    thus we have to do a FindChunkInFile to get the real chunk id.
2783                         //
2784                         // We have a duplicate now we need to decide which one to use
2785                         // To do this we get both sets of tags and compare serial numbers.
2786                         yaffs_ReadChunkTagsFromNAND(dev,chunkInNAND, &newTags,&newChunkDeleted);
2787
2788
2789                         // Do a proper find
2790                         existingChunk = yaffs_FindChunkInFile(in,chunkInInode, &existingTags);
2791
2792                         if(existingChunk <=0)
2793                         {
2794                                 //Hoosterman - how did this happen?
2795
2796                                 T(YAFFS_TRACE_ERROR, (TSTR("yaffs tragedy: existing chunk < 0 in scan" TENDSTR)));
2797
2798                         }
2799
2800
2801                         // NB The deleted flags should be false, otherwise the chunks will
2802                         // not be loaded during a scan
2803
2804                         newSerial = newTags.serialNumber;
2805                         existingSerial = existingTags.serialNumber;
2806
2807                         if( existingChunk <= 0 ||
2808                             ((existingSerial+1) & 3) == newSerial)
2809                         {
2810                                 // Use new
2811                                 // Delete the old one and drop through to update the tnode
2812                                 yaffs_DeleteChunk(dev,existingChunk,1);
2813                         }
2814                         else
2815                         {
2816                                 // Use existing.
2817                                 // Delete the new one and return early so that the tnode isn't changed
2818                                 yaffs_DeleteChunk(dev,chunkInNAND,1);
2819                                 return YAFFS_OK;
2820                         }
2821                 }
2822
2823         }
2824
2825         if(existingChunk == 0)
2826         {
2827                 in->nDataChunks++;
2828         }
2829
2830         tn->level0[chunkInInode & YAFFS_TNODES_LEVEL0_MASK] = (chunkInNAND >> dev->chunkGroupBits);
2831
2832         return YAFFS_OK;
2833 }
2834
2835
2836
2837 int yaffs_ReadChunkDataFromObject(yaffs_Object *in,int chunkInInode, __u8 *buffer)
2838 {
2839     int chunkInNAND = yaffs_FindChunkInFile(in,chunkInInode,NULL);
2840
2841     if(chunkInNAND >= 0)
2842     {
2843                 return yaffs_ReadChunkFromNAND(in->myDev,chunkInNAND,buffer,NULL,1);
2844         }
2845         else
2846         {
2847                 memset(buffer,0,YAFFS_BYTES_PER_CHUNK);
2848                 return 0;
2849         }
2850
2851 }
2852
2853
2854 static void yaffs_DeleteChunk(yaffs_Device *dev,int chunkId,int markNAND)
2855 {
2856         int block;
2857         int page;
2858         yaffs_Spare spare;
2859         yaffs_BlockInfo *bi;
2860
2861         if(chunkId <= 0) return;
2862
2863         dev->nDeletions++;
2864         block = chunkId / dev->nChunksPerBlock;
2865         page = chunkId % dev->nChunksPerBlock;
2866
2867         if(markNAND)
2868         {
2869                 yaffs_SpareInitialise(&spare);
2870
2871 #ifdef CONFIG_MTD_NAND_VERIFY_WRITE
2872
2873                 //read data before write, to ensure correct ecc
2874                 //if we're using MTD verification under Linux
2875                 yaffs_ReadChunkFromNAND(dev,chunkId,NULL,&spare,0);
2876 #endif
2877
2878                 spare.pageStatus = 0; // To mark it as deleted.
2879
2880
2881                 yaffs_WriteChunkToNAND(dev,chunkId,NULL,&spare);
2882                 yaffs_HandleUpdateChunk(dev,chunkId,&spare);
2883         }
2884         else
2885         {
2886                         dev->nUnmarkedDeletions++;
2887         }
2888
2889         bi = yaffs_GetBlockInfo(dev,block);
2890
2891
2892         // Pull out of the management area.
2893         // If the whole block became dirty, this will kick off an erasure.
2894         if(     bi->blockState == YAFFS_BLOCK_STATE_ALLOCATING ||
2895             bi->blockState == YAFFS_BLOCK_STATE_FULL)
2896         {
2897                 dev->nFreeChunks++;
2898
2899                 yaffs_ClearChunkBit(dev,block,page);
2900                 bi->pagesInUse--;
2901
2902                 if(bi->pagesInUse == 0 &&
2903                bi->blockState == YAFFS_BLOCK_STATE_FULL)
2904             {
2905                 yaffs_BlockBecameDirty(dev,block);
2906             }
2907
2908         }
2909         else
2910         {
2911                 // T(("Bad news deleting chunk %d\n",chunkId));
2912         }
2913
2914 }
2915
2916
2917
2918
2919 int yaffs_WriteChunkDataToObject(yaffs_Object *in,int chunkInInode, const __u8 *buffer,int nBytes,int useReserve)
2920 {
2921         // Find old chunk Need to do this to get serial number
2922         // Write new one and patch into tree.
2923         // Invalidate old tags.
2924
2925     int prevChunkId;
2926     yaffs_Tags prevTags;
2927
2928     int newChunkId;
2929     yaffs_Tags newTags;
2930
2931     yaffs_Device *dev = in->myDev;
2932
2933         yaffs_CheckGarbageCollection(dev);
2934
2935         // Get the previous chunk at this location in the file if it exists
2936     prevChunkId  = yaffs_FindChunkInFile(in,chunkInInode,&prevTags);
2937
2938     // Set up new tags
2939         newTags.chunkId = chunkInInode;
2940         newTags.objectId = in->objectId;
2941         newTags.serialNumber = (prevChunkId >= 0) ? prevTags.serialNumber + 1 : 1;
2942         newTags.byteCount = nBytes;
2943         newTags.unusedStuff = 0xFFFFFFFF;
2944
2945         yaffs_CalcTagsECC(&newTags);
2946
2947         newChunkId = yaffs_WriteNewChunkWithTagsToNAND(dev,buffer,&newTags,useReserve);
2948         if(newChunkId >= 0)
2949         {
2950                 yaffs_PutChunkIntoFile(in,chunkInInode,newChunkId,0);
2951
2952
2953                 if(prevChunkId >= 0)
2954                 {
2955                         yaffs_DeleteChunk(dev,prevChunkId,1);
2956
2957                 }
2958
2959                 yaffs_CheckFileSanity(in);
2960         }
2961         return newChunkId;
2962
2963
2964
2965
2966
2967 }
2968
2969
2970 // UpdateObjectHeader updates the header on NAND for an object.
2971 // If name is not NULL, then that new name is used.
2972 //
2973 int yaffs_UpdateObjectHeader(yaffs_Object *in,const char *name, int force)
2974 {
2975
2976         yaffs_Device *dev = in->myDev;
2977
2978     int prevChunkId;
2979
2980     int newChunkId;
2981     yaffs_Tags newTags;
2982     __u8 bufferNew[YAFFS_BYTES_PER_CHUNK];
2983     __u8 bufferOld[YAFFS_BYTES_PER_CHUNK];
2984
2985     yaffs_ObjectHeader *oh = (yaffs_ObjectHeader *)bufferNew;
2986     yaffs_ObjectHeader *ohOld = (yaffs_ObjectHeader *)bufferOld;
2987
2988
2989     if(!in->fake || force)
2990     {
2991
2992                 yaffs_CheckGarbageCollection(dev);
2993
2994                 memset(bufferNew,0xFF,YAFFS_BYTES_PER_CHUNK);
2995
2996                 prevChunkId = in->chunkId;
2997
2998                 if(prevChunkId >= 0)
2999                 {
3000                         yaffs_ReadChunkFromNAND(dev,prevChunkId,bufferOld,NULL,1);
3001                 }
3002
3003                 // Header data
3004                 oh->type = in->variantType;
3005
3006                 oh->st_mode = in->st_mode;
3007
3008 #ifdef CONFIG_YAFFS_WINCE
3009                 oh->win_atime[0] = in->win_atime[0];
3010                 oh->win_ctime[0] = in->win_ctime[0];
3011                 oh->win_mtime[0] = in->win_mtime[0];
3012                 oh->win_atime[1] = in->win_atime[1];
3013                 oh->win_ctime[1] = in->win_ctime[1];
3014                 oh->win_mtime[1] = in->win_mtime[1];
3015 #else
3016                 oh->st_uid = in->st_uid;
3017                 oh->st_gid = in->st_gid;
3018                 oh->st_atime = in->st_atime;
3019                 oh->st_mtime = in->st_mtime;
3020                 oh->st_ctime = in->st_ctime;
3021                 oh->st_rdev = in->st_rdev;
3022 #endif
3023                 if(in->parent)
3024                 {
3025                         oh->parentObjectId = in->parent->objectId;
3026                 }
3027                 else
3028                 {
3029                         oh->parentObjectId = 0;
3030                 }
3031
3032                 //oh->sum = in->sum;
3033                 if(name && *name)
3034                 {
3035                         memset(oh->name,0,YAFFS_MAX_NAME_LENGTH + 1);
3036                         strncpy(oh->name,name,YAFFS_MAX_NAME_LENGTH);
3037                 }
3038                 else if(prevChunkId)
3039                 {
3040                         memcpy(oh->name, ohOld->name,YAFFS_MAX_NAME_LENGTH + 1);
3041                 }
3042                 else
3043                 {
3044                         memset(oh->name,0,YAFFS_MAX_NAME_LENGTH + 1);
3045                 }
3046
3047                 switch(in->variantType)
3048                 {
3049                         case YAFFS_OBJECT_TYPE_UNKNOWN:
3050                                 // Should not happen
3051                                 break;
3052                         case YAFFS_OBJECT_TYPE_FILE:
3053                                 oh->fileSize = in->variant.fileVariant.fileSize;
3054                                 break;
3055                         case YAFFS_OBJECT_TYPE_HARDLINK:
3056                                 oh->equivalentObjectId = in->variant.hardLinkVariant.equivalentObjectId;
3057                                 break;
3058                         case YAFFS_OBJECT_TYPE_SPECIAL:
3059                                 // Do nothing
3060                                 break;
3061                         case YAFFS_OBJECT_TYPE_DIRECTORY:
3062                                 // Do nothing
3063                                 break;
3064                         case YAFFS_OBJECT_TYPE_SYMLINK:
3065                                 strncpy(oh->alias,in->variant.symLinkVariant.alias,YAFFS_MAX_ALIAS_LENGTH);
3066                                 oh->alias[YAFFS_MAX_ALIAS_LENGTH] = 0;
3067                                 break;
3068                 }
3069
3070                 // Tags
3071                 in->serial++;
3072                 newTags.chunkId = 0;
3073                 newTags.objectId = in->objectId;
3074                 newTags.serialNumber = in->serial;
3075                 newTags.byteCount =   0xFFFFFFFF;
3076                 newTags.unusedStuff = 0xFFFFFFFF;
3077
3078                 yaffs_CalcTagsECC(&newTags);
3079
3080
3081                 // Create new chunk in NAND
3082                 newChunkId = yaffs_WriteNewChunkWithTagsToNAND(dev,bufferNew,&newTags, (prevChunkId >= 0) ? 1 : 0 );
3083
3084                 if(newChunkId >= 0)
3085                 {
3086
3087                         in->chunkId = newChunkId;
3088
3089                         if(prevChunkId >= 0)
3090                         {
3091                                 yaffs_DeleteChunk(dev,prevChunkId,1);
3092                         }
3093
3094                         in->dirty = 0;
3095                 }
3096
3097                 return newChunkId;
3098
3099     }
3100     return 0;
3101 }
3102
3103
3104 /////////////////////// Short Operations Cache ////////////////////////////////
3105 //      In many siturations where there is no high level buffering (eg WinCE) a lot of
3106 //      reads might be short sequential reads, and a lot of writes may be short
3107 //  sequential writes. eg. scanning/writing a jpeg file.
3108 //      In these cases, a short read/write cache can provide a huge perfomance benefit
3109 //  with dumb-as-a-rock code.
3110 //  There are a limited number (~10) of cache chunks per device so that we don't
3111 //  need a very intelligent search.
3112
3113
3114
3115
3116
3117 static void yaffs_FlushFilesChunkCache(yaffs_Object *obj)
3118 {
3119         yaffs_Device *dev = obj->myDev;
3120         int lowest;
3121         int i;
3122         yaffs_ChunkCache *cache;
3123         int chunkWritten;
3124         int nBytes;
3125         int nCaches = obj->myDev->nShortOpCaches;
3126
3127         if  (nCaches > 0)
3128         {
3129                 do{
3130                         cache = NULL;
3131
3132                         // Find the dirty cache for this object with the lowest chunk id.
3133                         for(i = 0; i < nCaches; i++)
3134                         {
3135                                 if(dev->srCache[i].object == obj &&
3136                                 dev->srCache[i].dirty)
3137                                 {
3138                                         if(!cache ||  dev->srCache[i].chunkId < lowest)
3139                                         {
3140                                                 cache = &dev->srCache[i];
3141                                                 lowest = cache->chunkId;
3142                                         }
3143                                 }
3144                         }
3145
3146                         if(cache)
3147                         {
3148                                 //Write it out
3149
3150 #if 0
3151                                 nBytes = cache->object->variant.fileVariant.fileSize - ((cache->chunkId -1) * YAFFS_BYTES_PER_CHUNK);
3152
3153                                 if(nBytes > YAFFS_BYTES_PER_CHUNK)
3154                                 {
3155                                         nBytes= YAFFS_BYTES_PER_CHUNK;
3156                                 }
3157 #endif
3158                                 chunkWritten = yaffs_WriteChunkDataToObject(cache->object,
3159                                                                                                                         cache->chunkId,
3160                                                                                                                         cache->data,
3161                                                                                                                         cache->nBytes,1);
3162
3163                                 cache->dirty = 0;
3164                                 cache->object = NULL;
3165                         }
3166
3167                 } while(cache && chunkWritten > 0);
3168
3169                 if(cache)
3170                 {
3171                         //Hoosterman, disk full while writing cache out.
3172                         T(YAFFS_TRACE_ERROR, (TSTR("yaffs tragedy: no space during cache write" TENDSTR)));
3173
3174                 }
3175         }
3176
3177 }
3178
3179
3180 // Grab us a chunk for use.
3181 // First look for an empty one.
3182 // Then look for the least recently used non-dirty one.
3183 // Then look for the least recently used dirty one...., flush and look again.
3184 static yaffs_ChunkCache *yaffs_GrabChunkCacheWorker(yaffs_Device *dev)
3185 {
3186         int i;
3187         int usage;
3188         int theOne;
3189
3190         if(dev->nShortOpCaches > 0)
3191         {
3192                 for(i = 0; i < dev->nShortOpCaches; i++)
3193                 {
3194                         if(!dev->srCache[i].object)
3195                         {
3196                                 //T(("Grabbing empty %d\n",i));
3197
3198                                 //printf("Grabbing empty %d\n",i);
3199
3200                                 return &dev->srCache[i];
3201                         }
3202                 }
3203
3204                 return NULL;
3205
3206                 theOne = -1;
3207                 usage = 0; // just to stop the compiler grizzling
3208
3209                 for(i = 0; i < dev->nShortOpCaches; i++)
3210                 {
3211                         if(!dev->srCache[i].dirty &&
3212                         ((dev->srCache[i].lastUse < usage  && theOne >= 0)||
3213                                 theOne < 0))
3214                         {
3215                                 usage = dev->srCache[i].lastUse;
3216                                 theOne = i;
3217                         }
3218                 }
3219
3220                 //T(("Grabbing non-empty %d\n",theOne));
3221
3222                 //if(theOne >= 0) printf("Grabbed non-empty cache %d\n",theOne);
3223
3224                 return  theOne >= 0 ?  &dev->srCache[theOne] : NULL;
3225         }
3226         else
3227         {
3228                 return NULL;
3229         }
3230
3231 }
3232
3233
3234 static yaffs_ChunkCache *yaffs_GrabChunkCache(yaffs_Device *dev)
3235 {
3236         yaffs_ChunkCache *cache;
3237         yaffs_Object *theObj;
3238         int usage;
3239         int i;
3240         int pushout;
3241
3242         if(dev->nShortOpCaches > 0)
3243         {
3244                 // Try find a non-dirty one...
3245
3246                 cache = yaffs_GrabChunkCacheWorker(dev);
3247
3248                 if(!cache)
3249                 {
3250                         // They were all dirty, find the last recently used object and flush
3251                         // its cache, then  find again.
3252                         // NB what's here is not very accurate, we actually flush the object
3253                         // the last recently used page.
3254
3255                         theObj = dev->srCache[0].object;
3256                         usage = dev->srCache[0].lastUse;
3257                         cache = &dev->srCache[0];
3258                         pushout = 0;
3259
3260                         for(i = 1; i < dev->nShortOpCaches; i++)
3261                         {
3262                                 if( dev->srCache[i].object &&
3263                                         dev->srCache[i].lastUse < usage)
3264                                 {
3265                                         usage  = dev->srCache[i].lastUse;
3266                                         theObj = dev->srCache[i].object;
3267                                         cache = &dev->srCache[i];
3268                                         pushout = i;
3269                                 }
3270                         }
3271
3272                         if(!cache || cache->dirty)
3273                         {
3274
3275                                 //printf("Dirty ");
3276                                 yaffs_FlushFilesChunkCache(theObj);
3277
3278                                 // Try again
3279                                 cache = yaffs_GrabChunkCacheWorker(dev);
3280                         }
3281                         else
3282                         {
3283                                 //printf(" pushout %d\n",pushout);
3284                         }
3285
3286                 }
3287
3288                 return cache;
3289         }
3290         else
3291                 return NULL;
3292
3293 }
3294
3295
3296 // Find a cached chunk
3297 static yaffs_ChunkCache *yaffs_FindChunkCache(const yaffs_Object *obj, int chunkId)
3298 {
3299         yaffs_Device *dev = obj->myDev;
3300         int i;
3301         if(dev->nShortOpCaches > 0)
3302         {
3303                 for(i = 0; i < dev->nShortOpCaches; i++)
3304                 {
3305                         if(dev->srCache[i].object == obj &&
3306                         dev->srCache[i].chunkId == chunkId)
3307                         {
3308                                 dev->cacheHits++;
3309
3310                                 return &dev->srCache[i];
3311                         }
3312                 }
3313         }
3314         return NULL;
3315 }
3316
3317 // Mark the chunk for the least recently used algorithym
3318 static void yaffs_UseChunkCache(yaffs_Device *dev, yaffs_ChunkCache *cache, int isAWrite)
3319 {
3320
3321         if(dev->nShortOpCaches > 0)
3322         {
3323                 if( dev->srLastUse < 0 ||
3324                         dev->srLastUse > 100000000)
3325                 {
3326                         // Reset the cache usages
3327                         int i;
3328                         for(i = 1; i < dev->nShortOpCaches; i++)
3329                         {
3330                                 dev->srCache[i].lastUse = 0;
3331                         }
3332                         dev->srLastUse = 0;
3333                 }
3334
3335                 dev->srLastUse++;
3336
3337                 cache->lastUse = dev->srLastUse;
3338
3339                 if(isAWrite)
3340                 {
3341                         cache->dirty = 1;
3342                 }
3343         }
3344 }
3345
3346 // Invalidate a single cache page.
3347 // Do this when a whole page gets written,
3348 // ie the short cache for this page is no longer valid.
3349 static void yaffs_InvalidateChunkCache(yaffs_Object *object, int chunkId)
3350 {
3351         if(object->myDev->nShortOpCaches > 0)
3352         {
3353                 yaffs_ChunkCache *cache = yaffs_FindChunkCache(object,chunkId);
3354
3355                 if(cache)
3356                 {
3357                         cache->object = NULL;
3358                 }
3359         }
3360 }
3361
3362
3363 // Invalidate all the cache pages associated with this object
3364 // Do this whenever ther file is deleted or resized.
3365 static void yaffs_InvalidateWholeChunkCache(yaffs_Object *in)
3366 {
3367         int i;
3368         yaffs_Device *dev = in->myDev;
3369
3370         if(dev->nShortOpCaches > 0)
3371         {
3372                 // Now invalidate it.
3373                 for(i = 0; i < dev->nShortOpCaches; i++)
3374                 {
3375                         if(dev->srCache[i].object == in)
3376                         {
3377                                 dev->srCache[i].object = NULL;
3378                         }
3379                 }
3380         }
3381 }
3382
3383
3384
3385
3386
3387 ///////////////////////// File read/write ///////////////////////////////
3388 // Read and write have very similar structures.
3389 // In general the read/write has three parts to it
3390 // * An incomplete chunk to start with (if the read/write is not chunk-aligned)
3391 // * Some complete chunks
3392 // * An incomplete chunk to end off with
3393 //
3394 // Curve-balls: the first chunk might also be the last chunk.
3395
3396 int yaffs_ReadDataFromFile(yaffs_Object *in, __u8 * buffer, __u32 offset, int nBytes)
3397 {
3398
3399
3400         int chunk;
3401         int start;
3402         int nToCopy;
3403         int n = nBytes;
3404         int nDone = 0;
3405         yaffs_ChunkCache *cache;
3406
3407         yaffs_Device *dev;
3408
3409         dev = in->myDev;
3410
3411         while(n > 0)
3412         {
3413                 chunk = offset / YAFFS_BYTES_PER_CHUNK + 1; // The first chunk is 1
3414                 start = offset % YAFFS_BYTES_PER_CHUNK;
3415
3416                 // OK now check for the curveball where the start and end are in
3417                 // the same chunk.
3418                 if(     (start + n) < YAFFS_BYTES_PER_CHUNK)
3419                 {
3420                         nToCopy = n;
3421                 }
3422                 else
3423                 {
3424                         nToCopy = YAFFS_BYTES_PER_CHUNK - start;
3425                 }
3426
3427                 cache = yaffs_FindChunkCache(in,chunk);
3428
3429                 // If the chunk is already in the cache or it is less than a whole chunk
3430                 // then use the cache (if there is caching)
3431                 // else bypass the cache.
3432                 if( cache || nToCopy != YAFFS_BYTES_PER_CHUNK)
3433                 {
3434                         if(dev->nShortOpCaches > 0)
3435                         {
3436
3437                                 // If we can't find the data in the cache, then load it up.
3438
3439                                 if(!cache)
3440                                 {
3441                                         cache = yaffs_GrabChunkCache(in->myDev);
3442                                         cache->object = in;
3443                                         cache->chunkId = chunk;
3444                                         cache->dirty = 0;
3445                                         yaffs_ReadChunkDataFromObject(in,chunk,cache->data);
3446                                         cache->nBytes = 0;
3447                                 }
3448
3449                                 yaffs_UseChunkCache(dev,cache,0);
3450
3451                                 memcpy(buffer,&cache->data[start],nToCopy);
3452                         }
3453                         else
3454                         {
3455                                 // Read into the local buffer then copy...
3456                                 yaffs_ReadChunkDataFromObject(in,chunk,dev->localBuffer);
3457                                 memcpy(buffer,&dev->localBuffer[start],nToCopy);
3458                         }
3459
3460                 }
3461                 else
3462                 {
3463 #ifdef CONFIG_YAFFS_WINCE
3464
3465                         // Under WinCE can't do direct transfer. Need to use a local buffer.
3466                         // This is because we otherwise screw up WinCE's memory mapper
3467                         yaffs_ReadChunkDataFromObject(in,chunk,dev->localBuffer);
3468                         memcpy(buffer,dev->localBuffer,YAFFS_BYTES_PER_CHUNK);
3469 #else
3470                         // A full chunk. Read directly into the supplied buffer.
3471                         yaffs_ReadChunkDataFromObject(in,chunk,buffer);
3472 #endif
3473                 }
3474
3475                 n -= nToCopy;
3476                 offset += nToCopy;
3477                 buffer += nToCopy;
3478                 nDone += nToCopy;
3479
3480         }
3481
3482         return nDone;
3483 }
3484
3485
3486
3487 int yaffs_WriteDataToFile(yaffs_Object *in,const __u8 * buffer, __u32 offset, int nBytes)
3488 {
3489
3490         int chunk;
3491         int start;
3492         int nToCopy;
3493         int n = nBytes;
3494         int nDone = 0;
3495         int nToWriteBack;
3496         int startOfWrite = offset;
3497         int chunkWritten = 0;
3498         int nBytesRead;
3499
3500         yaffs_Device *dev;
3501
3502         dev = in->myDev;
3503
3504
3505         while(n > 0 && chunkWritten >= 0)
3506         {
3507                 chunk = offset / YAFFS_BYTES_PER_CHUNK + 1;
3508                 start = offset % YAFFS_BYTES_PER_CHUNK;
3509
3510
3511                 // OK now check for the curveball where the start and end are in
3512                 // the same chunk.
3513
3514                 if(     (start + n) < YAFFS_BYTES_PER_CHUNK)
3515                 {
3516                         nToCopy = n;
3517
3518                         // Now folks, to calculate how many bytes to write back....
3519                         // If we're overwriting and not writing to then end of file then
3520                         // we need to write back as much as was there before.
3521
3522                         nBytesRead = in->variant.fileVariant.fileSize - ((chunk -1) * YAFFS_BYTES_PER_CHUNK);
3523
3524                         if(nBytesRead > YAFFS_BYTES_PER_CHUNK)
3525                         {
3526                                 nBytesRead = YAFFS_BYTES_PER_CHUNK;
3527                         }
3528
3529                         nToWriteBack = (nBytesRead > (start + n)) ? nBytesRead : (start +n);
3530
3531                 }
3532                 else
3533                 {
3534                         nToCopy = YAFFS_BYTES_PER_CHUNK - start;
3535                         nToWriteBack = YAFFS_BYTES_PER_CHUNK;
3536                 }
3537
3538                 if(nToCopy != YAFFS_BYTES_PER_CHUNK)
3539                 {
3540                         // An incomplete start or end chunk (or maybe both start and end chunk)
3541                         if(dev->nShortOpCaches > 0)
3542                         {
3543                                 yaffs_ChunkCache *cache;
3544                                 // If we can't find the data in the cache, then load it up.
3545                                 cache = yaffs_FindChunkCache(in,chunk);
3546                                 if(!cache && yaffs_CheckSpaceForChunkCache(in->myDev))
3547                                 {
3548                                         cache = yaffs_GrabChunkCache(in->myDev);
3549                                         cache->object = in;
3550                                         cache->chunkId = chunk;
3551                                         cache->dirty = 0;
3552                                         yaffs_ReadChunkDataFromObject(in,chunk,cache->data);
3553                                 }
3554
3555                                 if(cache)
3556                                 {
3557                                         yaffs_UseChunkCache(dev,cache,1);
3558                                         memcpy(&cache->data[start],buffer,nToCopy);
3559                                         cache->nBytes = nToWriteBack;
3560                                 }
3561                                 else
3562                                 {
3563                                         chunkWritten = -1; // fail the write
3564                                 }
3565                         }
3566                         else
3567                         {
3568                                 // An incomplete start or end chunk (or maybe both start and end chunk)
3569                                 // Read into the local buffer then copy, then copy over and write back.
3570
3571                                 yaffs_ReadChunkDataFromObject(in,chunk,dev->localBuffer);
3572
3573                                 memcpy(&dev->localBuffer[start],buffer,nToCopy);
3574
3575                                 chunkWritten = yaffs_WriteChunkDataToObject(in,chunk,dev->localBuffer,nToWriteBack,0);
3576
3577                                 //T(("Write with readback to chunk %d %d  start %d  copied %d wrote back %d\n",chunk,chunkWritten,start, nToCopy, nToWriteBack));
3578                         }
3579
3580                 }
3581                 else
3582                 {
3583
3584 #ifdef CONFIG_YAFFS_WINCE
3585                         // Under WinCE can't do direct transfer. Need to use a local buffer.
3586                         // This is because we otherwise screw up WinCE's memory mapper
3587                         memcpy(dev->localBuffer,buffer,YAFFS_BYTES_PER_CHUNK);
3588                         chunkWritten = yaffs_WriteChunkDataToObject(in,chunk,dev->localBuffer,YAFFS_BYTES_PER_CHUNK,0);
3589 #else
3590                         // A full chunk. Write directly from the supplied buffer.
3591                         chunkWritten = yaffs_WriteChunkDataToObject(in,chunk,buffer,YAFFS_BYTES_PER_CHUNK,0);
3592 #endif
3593                         // Since we've overwritten the cached data, we better invalidate it.
3594                         yaffs_InvalidateChunkCache(in,chunk);
3595                         //T(("Write to chunk %d %d\n",chunk,chunkWritten));
3596                 }
3597
3598                 if(chunkWritten >= 0)
3599                 {
3600                         n -= nToCopy;
3601                         offset += nToCopy;
3602                         buffer += nToCopy;
3603                         nDone += nToCopy;
3604                 }
3605
3606         }
3607
3608         // Update file object
3609
3610         if((startOfWrite + nDone) > in->variant.fileVariant.fileSize)
3611         {
3612                 in->variant.fileVariant.fileSize = (startOfWrite + nDone);
3613         }
3614
3615         in->dirty = 1;
3616
3617         return nDone;
3618 }
3619
3620
3621 int yaffs_ResizeFile(yaffs_Object *in, int newSize)
3622 {
3623         int i;
3624         int chunkId;
3625         int oldFileSize = in->variant.fileVariant.fileSize;
3626         int sizeOfPartialChunk = newSize % YAFFS_BYTES_PER_CHUNK;
3627
3628         yaffs_Device *dev = in->myDev;
3629
3630
3631         yaffs_FlushFilesChunkCache(in);
3632         yaffs_InvalidateWholeChunkCache(in);
3633
3634         if(in->variantType != YAFFS_OBJECT_TYPE_FILE)
3635         {
3636                 return yaffs_GetFileSize(in);
3637         }
3638
3639         if(newSize < oldFileSize)
3640         {
3641
3642                 int lastDel = 1 + (oldFileSize-1)/YAFFS_BYTES_PER_CHUNK;
3643
3644                 int startDel = 1 + (newSize + YAFFS_BYTES_PER_CHUNK - 1)/
3645                                                         YAFFS_BYTES_PER_CHUNK;
3646
3647                 // Delete backwards so that we don't end up with holes if
3648                 // power is lost part-way through the operation.
3649                 for(i = lastDel; i >= startDel; i--)
3650                 {
3651                         // NB this could be optimised somewhat,
3652                         // eg. could retrieve the tags and write them without
3653                         // using yaffs_DeleteChunk
3654
3655                         chunkId = yaffs_FindAndDeleteChunkInFile(in,i,NULL);
3656                         if(chunkId < (dev->startBlock * 32) || chunkId >= ((dev->endBlock+1) * 32))
3657                         {
3658                                 //T(("Found daft chunkId %d for %d\n",chunkId,i));
3659                         }
3660                         else
3661                         {
3662                                 in->nDataChunks--;
3663                                 yaffs_DeleteChunk(dev,chunkId,1);
3664                         }
3665                 }
3666
3667
3668                 if(sizeOfPartialChunk != 0)
3669                 {
3670                         int lastChunk = 1+ newSize/YAFFS_BYTES_PER_CHUNK;
3671
3672                         // Got to read and rewrite the last chunk with its new size.
3673                         // NB Got to zero pad to nuke old data
3674                         yaffs_ReadChunkDataFromObject(in,lastChunk,dev->localBuffer);
3675                         memset(dev->localBuffer + sizeOfPartialChunk,0, YAFFS_BYTES_PER_CHUNK - sizeOfPartialChunk);
3676
3677                         yaffs_WriteChunkDataToObject(in,lastChunk,dev->localBuffer,sizeOfPartialChunk,1);
3678
3679                 }
3680
3681                 in->variant.fileVariant.fileSize = newSize;
3682
3683                 yaffs_PruneFileStructure(dev,&in->variant.fileVariant);
3684
3685                 return newSize;
3686
3687         }
3688         else
3689         {
3690                 return oldFileSize;
3691         }
3692 }
3693
3694
3695 loff_t yaffs_GetFileSize(yaffs_Object *obj)
3696 {
3697         obj = yaffs_GetEquivalentObject(obj);
3698
3699         switch(obj->variantType)
3700         {
3701                 case YAFFS_OBJECT_TYPE_FILE:
3702                         return obj->variant.fileVariant.fileSize;
3703                 case YAFFS_OBJECT_TYPE_SYMLINK:
3704                         return strlen(obj->variant.symLinkVariant.alias);
3705                 default:
3706                         return 0;
3707         }
3708 }
3709
3710
3711
3712 // yaffs_FlushFile() updates the file's
3713 // objectId in NAND
3714
3715 int yaffs_FlushFile(yaffs_Object *in, int updateTime)
3716 {
3717         int retVal;
3718         if(in->dirty)
3719         {
3720                 //T(("flushing object header\n"));
3721
3722                 yaffs_FlushFilesChunkCache(in);
3723                 if(updateTime)
3724                 {
3725 #ifdef CONFIG_YAFFS_WINCE
3726                         yfsd_WinFileTimeNow(in->win_mtime);
3727 #else
3728 #if defined(CONFIG_KERNEL_2_5)
3729                         in->st_mtime = CURRENT_TIME.tv_sec;
3730 #else
3731                         in->st_mtime = CURRENT_TIME;
3732 #endif
3733 #endif
3734                 }
3735
3736                 retVal = (yaffs_UpdateObjectHeader(in,NULL,0) >= 0)? YAFFS_OK : YAFFS_FAIL;
3737         }
3738         else
3739         {
3740                 retVal = YAFFS_OK;
3741         }
3742
3743         return retVal;
3744
3745 }
3746
3747
3748 static int yaffs_DoGenericObjectDeletion(yaffs_Object *in)
3749 {
3750
3751         // First off, invalidate the file's data in the cache, without flushing.
3752         yaffs_InvalidateWholeChunkCache(in);
3753
3754         yaffs_RemoveObjectFromDirectory(in);
3755         yaffs_DeleteChunk(in->myDev,in->chunkId,1);
3756 #ifdef __KERNEL__
3757         if(in->myInode)
3758         {
3759                 in->myInode->u.generic_ip = NULL;
3760                 in->myInode = 0;
3761         }
3762 #endif
3763         yaffs_FreeObject(in);
3764         return YAFFS_OK;
3765
3766 }
3767
3768 // yaffs_DeleteFile deletes the whole file data
3769 // and the inode associated with the file.
3770 // It does not delete the links associated with the file.
3771 static int yaffs_UnlinkFile(yaffs_Object *in)
3772 {
3773
3774 #ifdef CONFIG_YAFFS_DISABLE_BACKGROUND_DELETION
3775
3776         // Delete the file data & tnodes
3777
3778          yaffs_DeleteWorker(in, in->variant.fileVariant.top, in->variant.fileVariant.topLevel, 0,NULL);
3779
3780
3781         yaffs_FreeTnode(in->myDev,in->variant.fileVariant.top);
3782
3783         return  yaffs_DoGenericObjectDeletion(in);
3784 #else
3785         int retVal;
3786         int immediateDeletion=0;
3787         retVal = yaffs_ChangeObjectName(in, in->myDev->unlinkedDir,NULL,0);
3788         if(1 || // Ignore the result of the change name. This will only fail
3789                         // if the disk was completely full (an error condition)
3790                         // We ignore the error so we can delete files to recover the disk
3791            retVal == YAFFS_OK)
3792         {
3793                 //in->unlinked = 1;
3794                 //in->myDev->nUnlinkedFiles++;
3795                 //in->renameAllowed = 0;
3796 #ifdef __KERNEL__
3797                 if(!in->myInode)
3798                 {
3799                         immediateDeletion = 1;
3800
3801                 }
3802 #else
3803                 if(in->inUse <= 0)
3804                 {
3805                         immediateDeletion = 1;
3806
3807                 }
3808 #endif
3809
3810                 if(immediateDeletion)
3811                 {
3812                         T(YAFFS_TRACE_TRACING,(TSTR("yaffs: immediate deletion of file %d" TENDSTR),in->objectId));
3813                         in->deleted=1;
3814                         in->myDev->nDeletedFiles++;
3815                         yaffs_SoftDeleteFile(in);
3816                 }
3817
3818         }
3819         return retVal;
3820
3821
3822 #endif
3823 }
3824
3825 int yaffs_DeleteFile(yaffs_Object *in)
3826 {
3827         int retVal = YAFFS_OK;
3828
3829         if(in->nDataChunks > 0)
3830         {
3831                 // Use soft deletion
3832                 if(!in->unlinked)
3833                 {
3834                         retVal = yaffs_UnlinkFile(in);
3835                 }
3836                 if(retVal == YAFFS_OK &&
3837                 in->unlinked &&
3838                 !in->deleted)
3839                 {
3840                         in->deleted = 1;
3841                         in->myDev->nDeletedFiles++;
3842                         yaffs_SoftDeleteFile(in);
3843                 }
3844                 return in->deleted ? YAFFS_OK : YAFFS_FAIL;
3845         }
3846         else
3847         {
3848                 // The file has no data chunks so we toss it immediately
3849                 yaffs_FreeTnode(in->myDev,in->variant.fileVariant.top);
3850                 in->variant.fileVariant.top = NULL;
3851                 yaffs_DoGenericObjectDeletion(in);
3852
3853                 return YAFFS_OK;
3854         }
3855 }
3856
3857 static int yaffs_DeleteDirectory(yaffs_Object *in)
3858 {
3859         //First check that the directory is empty.
3860         if(list_empty(&in->variant.directoryVariant.children))
3861         {
3862                 return  yaffs_DoGenericObjectDeletion(in);
3863         }
3864
3865         return YAFFS_FAIL;
3866
3867 }
3868
3869 static int yaffs_DeleteSymLink(yaffs_Object *in)
3870 {
3871         YFREE(in->variant.symLinkVariant.alias);
3872
3873         return  yaffs_DoGenericObjectDeletion(in);
3874 }
3875
3876 static int yaffs_DeleteHardLink(yaffs_Object *in)
3877 {
3878         // remove this hardlink from the list assocaited with the equivalent
3879         // object
3880         list_del(&in->hardLinks);
3881         return  yaffs_DoGenericObjectDeletion(in);
3882 }
3883
3884
3885 static void yaffs_AbortHalfCreatedObject(yaffs_Object *obj)
3886 {
3887         switch(obj->variantType)
3888         {
3889                 case YAFFS_OBJECT_TYPE_FILE: yaffs_DeleteFile(obj); break;
3890                 case YAFFS_OBJECT_TYPE_DIRECTORY: yaffs_DeleteDirectory(obj); break;
3891                 case YAFFS_OBJECT_TYPE_SYMLINK: yaffs_DeleteSymLink(obj); break;
3892                 case YAFFS_OBJECT_TYPE_HARDLINK: yaffs_DeleteHardLink(obj); break;
3893                 case YAFFS_OBJECT_TYPE_SPECIAL: yaffs_DoGenericObjectDeletion(obj); break;
3894                 case YAFFS_OBJECT_TYPE_UNKNOWN: break; // should not happen.
3895         }
3896 }
3897
3898
3899 static int yaffs_UnlinkWorker(yaffs_Object *obj)
3900 {
3901
3902
3903         if(obj->variantType == YAFFS_OBJECT_TYPE_HARDLINK)
3904         {
3905                 return  yaffs_DeleteHardLink(obj);
3906         }
3907         else if(!list_empty(&obj->hardLinks))
3908         {
3909                 // Curve ball: We're unlinking an object that has a hardlink.
3910                 //
3911                 //      This problem arises because we are not strictly following
3912                 //  The Linux link/inode model.
3913                 //
3914                 // We can't really delete the object.
3915                 // Instead, we do the following:
3916                 // - Select a hardlink.
3917                 // - Unhook it from the hard links
3918                 // - Unhook it from its parent directory (so that the rename can work)
3919                 // - Rename the object to the hardlink's name.
3920                 // - Delete the hardlink
3921
3922
3923                 yaffs_Object *hl;
3924                 int retVal;
3925                 char name[YAFFS_MAX_NAME_LENGTH+1];
3926
3927                 hl = list_entry(obj->hardLinks.next,yaffs_Object,hardLinks);
3928
3929                 list_del_init(&hl->hardLinks);
3930                 list_del_init(&hl->siblings);
3931
3932                 yaffs_GetObjectName(hl,name,YAFFS_MAX_NAME_LENGTH+1);
3933
3934                 retVal = yaffs_ChangeObjectName(obj, hl->parent, name,0);
3935
3936                 if(retVal == YAFFS_OK)
3937                 {
3938                         retVal = yaffs_DoGenericObjectDeletion(hl);
3939                 }
3940                 return retVal;
3941
3942         }
3943         else
3944         {
3945                 switch(obj->variantType)
3946                 {
3947                         case YAFFS_OBJECT_TYPE_FILE:
3948                                 return yaffs_UnlinkFile(obj);
3949                                 break;
3950                         case YAFFS_OBJECT_TYPE_DIRECTORY:
3951                                 return yaffs_DeleteDirectory(obj);
3952                                 break;
3953                         case YAFFS_OBJECT_TYPE_SYMLINK:
3954                                 return yaffs_DeleteSymLink(obj);
3955                                 break;
3956                         case YAFFS_OBJECT_TYPE_HARDLINK:
3957                         case YAFFS_OBJECT_TYPE_UNKNOWN:
3958                         default:
3959                                 return YAFFS_FAIL;
3960                 }
3961         }
3962 }
3963
3964 int yaffs_Unlink(yaffs_Object *dir, const char *name)
3965 {
3966         yaffs_Object *obj;
3967
3968          obj = yaffs_FindObjectByName(dir,name);
3969
3970          if(obj && obj->unlinkAllowed)
3971          {
3972                 return yaffs_UnlinkWorker(obj);
3973          }
3974
3975          return YAFFS_FAIL;
3976
3977 }
3978
3979 //////////////// Initialisation Scanning /////////////////
3980
3981
3982
3983 // For now we use the SmartMedia check.
3984 // We look at the blockStatus byte in the first two chunks
3985 // These must be 0xFF to pass as OK.
3986 // todo: this function needs to be modifyable foir different NAND types
3987 // and different chunk sizes.  Suggest make this into a per-device configurable
3988 // function.
3989 static int yaffs_IsBlockBad(yaffs_Device *dev, int blk)
3990 {
3991         yaffs_Spare spare;
3992
3993         yaffs_ReadChunkFromNAND(dev,blk * dev->nChunksPerBlock,NULL,&spare,1);
3994 #if 1
3995         if(yaffs_CountBits(spare.blockStatus) < 7)
3996         {
3997                 return 1;
3998         }
3999 #else
4000         if(spare.blockStatus != 0xFF)
4001         {
4002                 return 1;
4003         }
4004 #endif
4005         yaffs_ReadChunkFromNAND(dev,blk * dev->nChunksPerBlock + 1,NULL,&spare,1);
4006
4007 #if 1
4008         if(yaffs_CountBits(spare.blockStatus) < 7)
4009         {
4010                 return 1;
4011         }
4012 #else
4013         if(spare.blockStatus != 0xFF)
4014         {
4015                 return 1;
4016         }
4017 #endif
4018
4019         return 0;
4020
4021 }
4022
4023 static int yaffs_Scan(yaffs_Device *dev)
4024 {
4025         yaffs_Spare spare;
4026         yaffs_Tags tags;
4027         int blk;
4028         int chunk;
4029         int c;
4030         int deleted;
4031         yaffs_BlockState state;
4032         yaffs_Object *hardList = NULL;
4033         yaffs_Object *hl;
4034         yaffs_BlockInfo *bi;
4035
4036
4037         yaffs_ObjectHeader *oh;
4038         yaffs_Object *in;
4039         yaffs_Object *parent;
4040
4041         __u8 chunkData[YAFFS_BYTES_PER_CHUNK];
4042
4043
4044         // Scan all the blocks...
4045
4046         for(blk = dev->startBlock; blk <= dev->endBlock; blk++)
4047         {
4048                 deleted = 0;
4049                 bi = yaffs_GetBlockInfo(dev,blk);
4050                 yaffs_ClearChunkBits(dev,blk);
4051                 bi->pagesInUse = 0;
4052                 bi->softDeletions = 0;
4053                 state = YAFFS_BLOCK_STATE_SCANNING;
4054
4055
4056                 if(yaffs_IsBlockBad(dev,blk))
4057                 {
4058                         state = YAFFS_BLOCK_STATE_DEAD;
4059                         T(YAFFS_TRACE_BAD_BLOCKS,(TSTR("block %d is bad" TENDSTR),blk));
4060                 }
4061
4062                 // Read each chunk in the block.
4063
4064                 for(c = 0; c < dev->nChunksPerBlock &&
4065                                    state == YAFFS_BLOCK_STATE_SCANNING; c++)
4066                 {
4067                         // Read the spare area and decide what to do
4068                         chunk = blk * dev->nChunksPerBlock + c;
4069
4070                         yaffs_ReadChunkFromNAND(dev,chunk,NULL,&spare,1);
4071
4072
4073                         // This block looks ok, now what's in this chunk?
4074                         yaffs_GetTagsFromSpare(dev,&spare,&tags);
4075
4076                         if(yaffs_CountBits(spare.pageStatus) < 6)
4077                         {
4078                                 // A deleted chunk
4079                                 deleted++;
4080                                 dev->nFreeChunks ++;
4081                                 //T((" %d %d deleted\n",blk,c));
4082                         }
4083                         else if(tags.objectId == YAFFS_UNUSED_OBJECT_ID)
4084                         {
4085                                 // An unassigned chunk in the block
4086                                 // This means that either the block is empty or
4087                                 // this is the one being allocated from
4088
4089                                 if(c == 0)
4090                                 {
4091                                         // the block is unused
4092                                         state = YAFFS_BLOCK_STATE_EMPTY;
4093                                         dev->nErasedBlocks++;
4094                                 }
4095                                 else
4096                                 {
4097                                         // this is the block being allocated from
4098                                         T(YAFFS_TRACE_SCAN,(TSTR(" Allocating from %d %d" TENDSTR),blk,c));
4099                                         state = YAFFS_BLOCK_STATE_ALLOCATING;
4100                                         dev->allocationBlock = blk;
4101                                         dev->allocationPage = c;
4102                                 }
4103
4104                                 dev->nFreeChunks += (dev->nChunksPerBlock - c);
4105                         }
4106                         else if(tags.chunkId > 0)
4107                         {
4108                                 int endpos;
4109                                 // A data chunk.
4110                                 yaffs_SetChunkBit(dev,blk,c);
4111                                 bi->pagesInUse++;
4112
4113                                 in = yaffs_FindOrCreateObjectByNumber(dev,tags.objectId,YAFFS_OBJECT_TYPE_FILE);
4114                                 // PutChunkIntoFIle checks for a clash (two data chunks with
4115                                 // the same chunkId).
4116                                 yaffs_PutChunkIntoFile(in,tags.chunkId,chunk,1);
4117                                 endpos = (tags.chunkId - 1)* YAFFS_BYTES_PER_CHUNK + tags.byteCount;
4118                                 if(in->variant.fileVariant.scannedFileSize <endpos)
4119                                 {
4120                                         in->variant.fileVariant.scannedFileSize = endpos;
4121 #ifndef CONFIG_YAFFS_USE_HEADER_FILE_SIZE
4122                                                 in->variant.fileVariant.fileSize =
4123                                                         in->variant.fileVariant.scannedFileSize;
4124 #endif
4125
4126                                 }
4127                                 //T((" %d %d data %d %d\n",blk,c,tags.objectId,tags.chunkId));
4128                         }
4129                         else
4130                         {
4131                                 // chunkId == 0, so it is an ObjectHeader.
4132                                 // Thus, we read in the object header and make the object
4133                                 yaffs_SetChunkBit(dev,blk,c);
4134                                 bi->pagesInUse++;
4135
4136                                 yaffs_ReadChunkFromNAND(dev,chunk,chunkData,NULL,1);
4137
4138                                 oh = (yaffs_ObjectHeader *)chunkData;
4139
4140                                 in = yaffs_FindOrCreateObjectByNumber(dev,tags.objectId,oh->type);
4141
4142                                 if(in->valid)
4143                                 {
4144                                         // We have already filled this one. We have a duplicate and need to resolve it.
4145
4146                                         unsigned existingSerial = in->serial;
4147                                         unsigned newSerial = tags.serialNumber;
4148
4149                                         if(((existingSerial+1) & 3) == newSerial)
4150                                         {
4151                                                 // Use new one - destroy the exisiting one
4152                                                 yaffs_DeleteChunk(dev,in->chunkId,1);
4153                                                 in->valid = 0;
4154                                         }
4155                                         else
4156                                         {
4157                                                 // Use existing - destroy this one.
4158                                                 yaffs_DeleteChunk(dev,chunk,1);
4159                                         }
4160                                 }
4161
4162                                 if(!in->valid &&
4163                                    (tags.objectId == YAFFS_OBJECTID_ROOT ||
4164                                     tags.objectId == YAFFS_OBJECTID_LOSTNFOUND))
4165                                 {
4166                                         // We only load some info, don't fiddle with directory structure
4167                                         in->valid = 1;
4168                                         in->variantType = oh->type;
4169
4170                                         in->st_mode  = oh->st_mode;
4171 #ifdef CONFIG_YAFFS_WINCE
4172                                         in->win_atime[0] = oh->win_atime[0];
4173                                         in->win_ctime[0] = oh->win_ctime[0];
4174                                         in->win_mtime[0] = oh->win_mtime[0];
4175                                         in->win_atime[1] = oh->win_atime[1];
4176                                         in->win_ctime[1] = oh->win_ctime[1];
4177                                         in->win_mtime[1] = oh->win_mtime[1];
4178 #else
4179                                         in->st_uid   = oh->st_uid;
4180                                         in->st_gid   = oh->st_gid;
4181                                         in->st_atime = oh->st_atime;
4182                                         in->st_mtime = oh->st_mtime;
4183                                         in->st_ctime = oh->st_ctime;
4184                                         in->st_rdev = oh->st_rdev;
4185 #endif
4186                                         in->chunkId  = chunk;
4187
4188                                 }
4189                                 else if(!in->valid)
4190                                 {
4191                                         // we need to load this info
4192
4193                                         in->valid = 1;
4194                                         in->variantType = oh->type;
4195
4196                                         in->st_mode  = oh->st_mode;
4197 #ifdef CONFIG_YAFFS_WINCE
4198                                         in->win_atime[0] = oh->win_atime[0];
4199                                         in->win_ctime[0] = oh->win_ctime[0];
4200                                         in->win_mtime[0] = oh->win_mtime[0];
4201                                         in->win_atime[1] = oh->win_atime[1];
4202                                         in->win_ctime[1] = oh->win_ctime[1];
4203                                         in->win_mtime[1] = oh->win_mtime[1];
4204 #else
4205                                         in->st_uid   = oh->st_uid;
4206                                         in->st_gid   = oh->st_gid;
4207                                         in->st_atime = oh->st_atime;
4208                                         in->st_mtime = oh->st_mtime;
4209                                         in->st_ctime = oh->st_ctime;
4210                                         in->st_rdev = oh->st_rdev;
4211 #endif
4212                                         in->chunkId  = chunk;
4213
4214                                         yaffs_SetObjectName(in,oh->name);
4215                                         in->dirty = 0;
4216
4217                                         // directory stuff...
4218                                         // hook up to parent
4219
4220                                         parent = yaffs_FindOrCreateObjectByNumber(dev,oh->parentObjectId,YAFFS_OBJECT_TYPE_DIRECTORY);
4221                                         if(parent->variantType == YAFFS_OBJECT_TYPE_UNKNOWN)
4222                                         {
4223                                                 // Set up as a directory
4224                                                 parent->variantType = YAFFS_OBJECT_TYPE_DIRECTORY;
4225                                                 INIT_LIST_HEAD(&parent->variant.directoryVariant.children);
4226                                         }
4227                                         else if(parent->variantType != YAFFS_OBJECT_TYPE_DIRECTORY)
4228                                         {
4229                                                 // Hoosterman, another problem....
4230                                                 // We're trying to use a non-directory as a directory
4231
4232                                                 T(YAFFS_TRACE_ERROR, (TSTR("yaffs tragedy: attempting to use non-directory as a directory in scan. Put in lost+found." TENDSTR)));
4233                                                 parent = dev->lostNFoundDir;
4234
4235                                         }
4236
4237                                         yaffs_AddObjectToDirectory(parent,in);
4238                                         if(parent == dev->unlinkedDir)
4239                                         {
4240                                                 in->deleted = 1; // If it is unlinked at start up then it wants deleting
4241                                                 dev->nDeletedFiles++;
4242                                         }
4243
4244                                         // Note re hardlinks.
4245                                         // Since we might scan a hardlink before its equivalent object is scanned
4246                                         // we put them all in a list.
4247                                         // After scanning is complete, we should have all the objects, so we run through this
4248                                         // list and fix up all the chains.
4249
4250                                         switch(in->variantType)
4251                                         {
4252                                                 case YAFFS_OBJECT_TYPE_UNKNOWN:         // Todo got a problem
4253                                                         break;
4254                                                 case YAFFS_OBJECT_TYPE_FILE:
4255 #ifdef CONFIG_YAFFS_USE_HEADER_FILE_SIZE
4256                                                         in->variant.fileVariant.fileSize = oh->fileSize;
4257 #endif
4258                                                         break;
4259                                                 case YAFFS_OBJECT_TYPE_HARDLINK:
4260                                                         in->variant.hardLinkVariant.equivalentObjectId = oh->equivalentObjectId;
4261                                                         in->hardLinks.next = (struct list_head *)hardList;
4262                                                         hardList = in;
4263                                                         break;
4264                                                 case YAFFS_OBJECT_TYPE_DIRECTORY:       // Do nothing
4265                                                         break;
4266                                                 case YAFFS_OBJECT_TYPE_SPECIAL: // Do nothing
4267                                                         break;
4268                                                 case YAFFS_OBJECT_TYPE_SYMLINK:         // Do nothing
4269                                                         in->variant.symLinkVariant.alias = yaffs_CloneString(oh->alias);
4270                                                         break;
4271                                         }
4272                                         //T((" %d %d header %d \"%s\" type %d\n",blk,c,tags.objectId,oh->name,in->variantType));
4273                                 }
4274                         }
4275                 }
4276
4277                 if(state == YAFFS_BLOCK_STATE_SCANNING)
4278                 {
4279                         // If we got this far while scanning, then the block is fully allocated.
4280                         state = YAFFS_BLOCK_STATE_FULL;
4281                 }
4282
4283                 bi->blockState = state;
4284
4285                 // Now let's see if it was dirty
4286                 if(     bi->pagesInUse == 0 &&
4287                 bi->blockState == YAFFS_BLOCK_STATE_FULL)
4288             {
4289                 yaffs_BlockBecameDirty(dev,blk);
4290             }
4291
4292         }
4293
4294         // Fix up the hard link chains.
4295         // We should now have scanned all the objects, now it's time to add these
4296         // hardlinks.
4297         while(hardList)
4298         {
4299                 hl = hardList;
4300                 hardList = (yaffs_Object *)(hardList->hardLinks.next);
4301
4302                 in = yaffs_FindObjectByNumber(dev,hl->variant.hardLinkVariant.equivalentObjectId);
4303
4304                 if(in)
4305                 {
4306                         // Add the hardlink pointers
4307                         hl->variant.hardLinkVariant.equivalentObject=in;
4308                         list_add(&hl->hardLinks,&in->hardLinks);
4309                 }
4310                 else
4311                 {
4312                         //Todo Need to report/handle this better.
4313                         // Got a problem... hardlink to a non-existant object
4314                         hl->variant.hardLinkVariant.equivalentObject=NULL;
4315                         INIT_LIST_HEAD(&hl->hardLinks);
4316
4317                 }
4318
4319         }
4320
4321         {
4322                 struct list_head *i;
4323                 struct list_head *n;
4324
4325                 yaffs_Object *l;
4326                 // Soft delete all the unlinked files
4327                 list_for_each_safe(i,n,&dev->unlinkedDir->variant.directoryVariant.children)
4328                 {
4329                         if(i)
4330                         {
4331                                 l = list_entry(i, yaffs_Object,siblings);
4332                                 if(l->deleted)
4333                                 {
4334                                         yaffs_SoftDeleteFile(l);
4335                                 }
4336                         }
4337                 }
4338         }
4339
4340
4341         return YAFFS_OK;
4342 }
4343
4344
4345 ////////////////////////// Directory Functions /////////////////////////
4346
4347
4348 static void yaffs_AddObjectToDirectory(yaffs_Object *directory, yaffs_Object *obj)
4349 {
4350
4351         if(obj->siblings.prev == NULL)
4352         {
4353                 // Not initialised
4354                 INIT_LIST_HEAD(&obj->siblings);
4355
4356         }
4357         else if(!list_empty(&obj->siblings))
4358         {
4359                 // If it is holed up somewhere else, un hook it
4360                 list_del_init(&obj->siblings);
4361         }
4362         // Now add it
4363         list_add(&obj->siblings,&directory->variant.directoryVariant.children);
4364         obj->parent = directory;
4365
4366         if(directory == obj->myDev->unlinkedDir)
4367         {
4368                 obj->unlinked = 1;
4369                 obj->myDev->nUnlinkedFiles++;
4370                 obj->renameAllowed = 0;
4371         }
4372 }
4373
4374 static void yaffs_RemoveObjectFromDirectory(yaffs_Object *obj)
4375 {
4376         list_del_init(&obj->siblings);
4377         obj->parent = NULL;
4378 }
4379
4380 yaffs_Object *yaffs_FindObjectByName(yaffs_Object *directory,const char *name)
4381 {
4382         int sum;
4383
4384         struct list_head *i;
4385         char buffer[YAFFS_MAX_NAME_LENGTH+1];
4386
4387         yaffs_Object *l;
4388
4389         sum = yaffs_CalcNameSum(name);
4390
4391         list_for_each(i,&directory->variant.directoryVariant.children)
4392         {
4393                 if(i)
4394                 {
4395                         l = list_entry(i, yaffs_Object,siblings);
4396
4397                         // Special case for lost-n-found
4398                         if(l->objectId == YAFFS_OBJECTID_LOSTNFOUND)
4399                         {
4400                                 if(yaffs_strcmp(name,YAFFS_LOSTNFOUND_NAME) == 0)
4401                                 {
4402                                         return l;
4403                                 }
4404                         }
4405                         else if(yaffs_SumCompare(l->sum, sum))
4406                         {
4407                                 // Do a real check
4408                                 yaffs_GetObjectName(l,buffer,YAFFS_MAX_NAME_LENGTH);
4409                                 if(yaffs_strcmp(name,buffer) == 0)
4410                                 {
4411                                         return l;
4412                                 }
4413
4414                         }
4415                 }
4416         }
4417
4418         return NULL;
4419 }
4420
4421
4422 int yaffs_ApplyToDirectoryChildren(yaffs_Object *theDir,int (*fn)(yaffs_Object *))
4423 {
4424         struct list_head *i;
4425         yaffs_Object *l;
4426
4427
4428         list_for_each(i,&theDir->variant.directoryVariant.children)
4429         {
4430                 if(i)
4431                 {
4432                         l = list_entry(i, yaffs_Object,siblings);
4433                         if(l && !fn(l))
4434                         {
4435                                 return YAFFS_FAIL;
4436                         }
4437                 }
4438         }
4439
4440         return YAFFS_OK;
4441
4442 }
4443
4444
4445 // GetEquivalentObject dereferences any hard links to get to the
4446 // actual object.
4447
4448 yaffs_Object *yaffs_GetEquivalentObject(yaffs_Object *obj)
4449 {
4450         if(obj && obj->variantType == YAFFS_OBJECT_TYPE_HARDLINK)
4451         {
4452                 // We want the object id of the equivalent object, not this one
4453                 obj = obj->variant.hardLinkVariant.equivalentObject;
4454         }
4455         return obj;
4456
4457 }
4458
4459 int yaffs_GetObjectName(yaffs_Object *obj,char *name,int buffSize)
4460 {
4461         memset(name,0,buffSize);
4462
4463         if(obj->objectId == YAFFS_OBJECTID_LOSTNFOUND)
4464         {
4465                 strncpy(name,YAFFS_LOSTNFOUND_NAME,buffSize - 1);
4466         }
4467         else if(obj->chunkId <= 0)
4468         {
4469                 char locName[20];
4470                 // make up a name
4471                 sprintf(locName,"%s%d",YAFFS_LOSTNFOUND_PREFIX,obj->objectId);
4472                 strncpy(name,locName,buffSize - 1);
4473
4474         }
4475 #ifdef CONFIG_YAFFS_SHORT_NAMES_IN_RAM
4476         else if(obj->shortName[0])
4477         {
4478                 strcpy(name,obj->shortName);
4479         }
4480 #endif
4481         else
4482         {
4483                 __u8 buffer[YAFFS_BYTES_PER_CHUNK];
4484                 yaffs_ObjectHeader *oh = (yaffs_ObjectHeader *)buffer;
4485
4486                 memset(buffer,0,YAFFS_BYTES_PER_CHUNK);
4487
4488                 if(obj->chunkId >= 0)
4489                 {
4490                         yaffs_ReadChunkFromNAND(obj->myDev,obj->chunkId,buffer,NULL,1);
4491                 }
4492                 strncpy(name,oh->name,buffSize - 1);
4493         }
4494
4495         return strlen(name);
4496 }
4497
4498 int yaffs_GetObjectFileLength(yaffs_Object *obj)
4499 {
4500
4501         // Dereference any hard linking
4502         obj = yaffs_GetEquivalentObject(obj);
4503
4504         if(obj->variantType == YAFFS_OBJECT_TYPE_FILE)
4505         {
4506                 return obj->variant.fileVariant.fileSize;
4507         }
4508         if(obj->variantType == YAFFS_OBJECT_TYPE_SYMLINK)
4509         {
4510                 return strlen(obj->variant.symLinkVariant.alias);
4511         }
4512         else
4513         {
4514                 // Only a directory should drop through to here
4515                 return YAFFS_BYTES_PER_CHUNK;
4516         }
4517 }
4518
4519 int yaffs_GetObjectLinkCount(yaffs_Object *obj)
4520 {
4521         int count = 0;
4522         struct list_head *i;
4523
4524         if(!obj->unlinked)
4525         {
4526                 count++;        // the object itself
4527         }
4528         list_for_each(i,&obj->hardLinks)
4529         {
4530                 count++;        // add the hard links;
4531         }
4532         return count;
4533
4534 }
4535
4536
4537 int yaffs_GetObjectInode(yaffs_Object *obj)
4538 {
4539         obj = yaffs_GetEquivalentObject(obj);
4540
4541         return obj->objectId;
4542 }
4543
4544 unsigned yaffs_GetObjectType(yaffs_Object *obj)
4545 {
4546         obj = yaffs_GetEquivalentObject(obj);
4547
4548         switch(obj->variantType)
4549         {
4550                 case YAFFS_OBJECT_TYPE_FILE:            return DT_REG; break;
4551                 case YAFFS_OBJECT_TYPE_DIRECTORY:       return DT_DIR; break;
4552                 case YAFFS_OBJECT_TYPE_SYMLINK:         return DT_LNK; break;
4553                 case YAFFS_OBJECT_TYPE_HARDLINK:        return DT_REG; break;
4554                 case YAFFS_OBJECT_TYPE_SPECIAL:
4555                         if(S_ISFIFO(obj->st_mode)) return DT_FIFO;
4556                         if(S_ISCHR(obj->st_mode)) return DT_CHR;
4557                         if(S_ISBLK(obj->st_mode)) return DT_BLK;
4558                         if(S_ISSOCK(obj->st_mode)) return DT_SOCK;
4559                 default: return DT_REG; break;
4560         }
4561 }
4562
4563 char *yaffs_GetSymlinkAlias(yaffs_Object *obj)
4564 {
4565         obj = yaffs_GetEquivalentObject(obj);
4566         if(obj->variantType == YAFFS_OBJECT_TYPE_SYMLINK)
4567         {
4568                 return yaffs_CloneString(obj->variant.symLinkVariant.alias);
4569         }
4570         else
4571         {
4572                 return yaffs_CloneString("");
4573         }
4574 }
4575
4576 #ifndef CONFIG_YAFFS_WINCE
4577
4578 int yaffs_SetAttributes(yaffs_Object *obj, struct iattr *attr)
4579 {
4580         unsigned int valid = attr->ia_valid;
4581
4582         if(valid & ATTR_MODE) obj->st_mode = attr->ia_mode;
4583         if(valid & ATTR_UID) obj->st_uid = attr->ia_uid;
4584         if(valid & ATTR_GID) obj->st_gid = attr->ia_gid;
4585
4586 #if defined(CONFIG_KERNEL_2_5)
4587         if(valid & ATTR_ATIME) obj->st_atime = attr->ia_atime.tv_sec;
4588         if(valid & ATTR_CTIME) obj->st_ctime = attr->ia_ctime.tv_sec;
4589         if(valid & ATTR_MTIME) obj->st_mtime = attr->ia_mtime.tv_sec;
4590 #else
4591         if(valid & ATTR_ATIME) obj->st_atime = attr->ia_atime;
4592         if(valid & ATTR_CTIME) obj->st_ctime = attr->ia_ctime;
4593         if(valid & ATTR_MTIME) obj->st_mtime = attr->ia_mtime;
4594 #endif
4595
4596         if(valid & ATTR_SIZE) yaffs_ResizeFile(obj,attr->ia_size);
4597
4598         yaffs_UpdateObjectHeader(obj,NULL,1);
4599
4600         return YAFFS_OK;
4601
4602 }
4603 int yaffs_GetAttributes(yaffs_Object *obj, struct iattr *attr)
4604 {
4605         unsigned int valid = 0;
4606
4607         attr->ia_mode = obj->st_mode;   valid |= ATTR_MODE;
4608         attr->ia_uid = obj->st_uid;             valid |= ATTR_UID;
4609         attr->ia_gid = obj->st_gid;             valid |= ATTR_GID;
4610
4611 #if defined(CONFIG_KERNEL_2_5)
4612         attr->ia_atime.tv_sec = obj->st_atime;  valid |= ATTR_ATIME;
4613         attr->ia_ctime.tv_sec = obj->st_ctime;  valid |= ATTR_CTIME;
4614         attr->ia_mtime.tv_sec = obj->st_mtime;  valid |= ATTR_MTIME;
4615 #else
4616         attr->ia_atime = obj->st_atime; valid |= ATTR_ATIME;
4617         attr->ia_ctime = obj->st_ctime; valid |= ATTR_CTIME;
4618         attr->ia_mtime = obj->st_mtime; valid |= ATTR_MTIME;
4619 #endif
4620         attr->ia_size = yaffs_GetFileSize(obj); valid |= ATTR_SIZE;
4621
4622         attr->ia_valid = valid;
4623
4624         return YAFFS_OK;
4625
4626 }
4627
4628 #endif
4629
4630 int yaffs_DumpObject(yaffs_Object *obj)
4631 {
4632 //      __u8 buffer[YAFFS_BYTES_PER_CHUNK];
4633         char name[257];
4634 //      yaffs_ObjectHeader *oh = (yaffs_ObjectHeader *)buffer;
4635
4636 //      memset(buffer,0,YAFFS_BYTES_PER_CHUNK);
4637
4638 //      if(obj->chunkId >= 0)
4639 //      {
4640 //              yaffs_ReadChunkFromNAND(obj->myDev,obj->chunkId,buffer,NULL);
4641 //      }
4642
4643         yaffs_GetObjectName(obj,name,256);
4644
4645         T(YAFFS_TRACE_ALWAYS,(TSTR("Object %d, inode %d \"%s\"\n dirty %d valid %d serial %d sum %d chunk %d type %d size %d\n" TENDSTR),
4646                         obj->objectId,yaffs_GetObjectInode(obj), name, obj->dirty, obj->valid, obj->serial,
4647                         obj->sum, obj->chunkId, yaffs_GetObjectType(obj), yaffs_GetObjectFileLength(obj)));
4648
4649 #if 0
4650         YPRINTF(("Object %d \"%s\"\n dirty %d valid %d serial %d sum %d chunk %d\n",
4651                         obj->objectId, oh->name, obj->dirty, obj->valid, obj->serial,
4652                         obj->sum, obj->chunkId));
4653                 switch(obj->variantType)
4654         {
4655                 case YAFFS_OBJECT_TYPE_FILE:
4656                         YPRINTF((" FILE length %d\n",obj->variant.fileVariant.fileSize));
4657                         break;
4658                 case YAFFS_OBJECT_TYPE_DIRECTORY:
4659                         YPRINTF((" DIRECTORY\n"));
4660                         break;
4661                 case YAFFS_OBJECT_TYPE_HARDLINK: //todo
4662                 case YAFFS_OBJECT_TYPE_SYMLINK:
4663                 case YAFFS_OBJECT_TYPE_UNKNOWN:
4664                 default:
4665         }
4666 #endif
4667
4668         return YAFFS_OK;
4669 }
4670
4671
4672 ///////////////////////// Initialisation code ///////////////////////////
4673
4674
4675
4676 int yaffs_GutsInitialise(yaffs_Device *dev)
4677 {
4678         unsigned x;
4679         int bits;
4680         int extraBits;
4681         int nBlocks;
4682
4683         if(     dev->nBytesPerChunk != YAFFS_BYTES_PER_CHUNK ||
4684                 dev->nChunksPerBlock < 2 ||
4685                 dev->nReservedBlocks < 2 ||
4686                 dev->startBlock <= 0 ||
4687                 dev->endBlock <= 0 ||
4688                 dev->endBlock <= (dev->startBlock + dev->nReservedBlocks)
4689           )
4690         {
4691                 //these parameters must be set before stating yaffs
4692                 // Other parameters startBlock,
4693                 return YAFFS_FAIL;
4694         }
4695
4696
4697
4698         if(!yaffs_CheckStructures())
4699         {
4700                 T(YAFFS_TRACE_ALWAYS,(TSTR("yaffs_CheckStructures failed\n" TENDSTR)));
4701                 return YAFFS_FAIL;
4702         }
4703
4704         if(dev->isMounted)
4705         {
4706                 T(YAFFS_TRACE_ALWAYS,(TSTR("yaffs: device already mounted\n" TENDSTR)));
4707                 return YAFFS_FAIL;
4708         }
4709
4710         dev->isMounted = 1;
4711
4712         if(dev->startBlock <= 0 ||
4713            (dev->endBlock - dev->startBlock) < 10)
4714         {
4715                 T(YAFFS_TRACE_ALWAYS,(TSTR("startBlock %d or endBlock %d invalid\n" TENDSTR),
4716                                 dev->startBlock, dev->endBlock));
4717                 return YAFFS_FAIL;
4718         }
4719
4720         nBlocks = dev->endBlock - dev->startBlock + 1;
4721
4722
4723
4724         // OK now calculate a few things for the device
4725         // Calculate chunkGroupBits.
4726         // We need to find the next power of 2 > than endBlock
4727
4728         x = dev->nChunksPerBlock * (dev->endBlock+1);
4729
4730         for(bits = extraBits = 0; x > 1; bits++)
4731         {
4732                 if(x & 1) extraBits++;
4733                 x >>= 1;
4734         }
4735
4736         if(extraBits > 0) bits++;
4737
4738
4739         // Level0 Tnodes are 16 bits, so if the bitwidth of the
4740         // chunk range we're using is greater than 16 we need
4741         // to figure out chunk shift and chunkGroupSize
4742         if(bits <= 16)
4743         {
4744                 dev->chunkGroupBits = 0;
4745         }
4746         else
4747         {
4748                 dev->chunkGroupBits = bits - 16;
4749         }
4750
4751         dev->chunkGroupSize = 1 << dev->chunkGroupBits;
4752
4753         if(dev->nChunksPerBlock < dev->chunkGroupSize)
4754         {
4755                 // We have a problem because the soft delete won't work if
4756                 // the chunk group size > chunks per block.
4757                 // This can be remedied by using larger "virtual blocks".
4758
4759                 return YAFFS_FAIL;
4760         }
4761
4762
4763
4764
4765         // More device initialisation
4766         dev->garbageCollections = 0;
4767         dev->passiveGarbageCollections = 0;
4768         dev->currentDirtyChecker = 0;
4769         dev->bufferedBlock = -1;
4770         dev->doingBufferedBlockRewrite = 0;
4771         dev->nDeletedFiles = 0;
4772         dev->nBackgroundDeletions=0;
4773         dev->nUnlinkedFiles = 0;
4774         dev->eccFixed=0;
4775         dev->eccUnfixed=0;
4776         dev->tagsEccFixed=0;
4777         dev->tagsEccUnfixed=0;
4778
4779         dev->localBuffer = YMALLOC(dev->nBytesPerChunk);
4780
4781
4782
4783
4784         yaffs_InitialiseBlocks(dev,nBlocks);
4785
4786         yaffs_InitialiseTnodes(dev);
4787
4788         yaffs_InitialiseObjects(dev);
4789
4790         if(dev->nShortOpCaches > 0)
4791         {
4792                 int i;
4793
4794                 if(dev->nShortOpCaches >  YAFFS_MAX_SHORT_OP_CACHES)
4795                 {
4796                         dev->nShortOpCaches = YAFFS_MAX_SHORT_OP_CACHES;
4797                 }
4798
4799                 dev->srCache = YMALLOC( dev->nShortOpCaches * sizeof(yaffs_ChunkCache));
4800
4801                 for(i=0; i < dev->nShortOpCaches; i++)
4802                 {
4803                         dev->srCache[i].object = NULL;
4804                         dev->srCache[i].lastUse = 0;
4805                         dev->srCache[i].dirty = 0;
4806                 }
4807                 dev->srLastUse = 0;
4808         }
4809
4810         dev->cacheHits = 0;
4811
4812
4813         // Initialise the unlinked, root and lost and found directories
4814         dev->lostNFoundDir = dev->rootDir = dev->unlinkedDir = NULL;
4815
4816         dev->unlinkedDir = yaffs_CreateFakeDirectory(dev,YAFFS_OBJECTID_UNLINKED, S_IFDIR);
4817
4818         dev->rootDir = yaffs_CreateFakeDirectory(dev,YAFFS_OBJECTID_ROOT,YAFFS_ROOT_MODE | S_IFDIR);
4819         dev->lostNFoundDir = yaffs_CreateFakeDirectory(dev,YAFFS_OBJECTID_LOSTNFOUND,YAFFS_LOSTNFOUND_MODE | S_IFDIR);
4820         yaffs_AddObjectToDirectory(dev->rootDir,dev->lostNFoundDir);
4821
4822
4823         // Now scan the flash.
4824         yaffs_Scan(dev);
4825
4826         // Zero out stats
4827         dev->nPageReads = 0;
4828     dev->nPageWrites =  0;
4829         dev->nBlockErasures = 0;
4830         dev->nGCCopies = 0;
4831         dev->nRetriedWrites = 0;
4832         dev->nRetiredBlocks = 0;
4833
4834
4835         return YAFFS_OK;
4836
4837 }
4838
4839 void yaffs_Deinitialise(yaffs_Device *dev)
4840 {
4841         if(dev->isMounted)
4842         {
4843
4844                 yaffs_DeinitialiseBlocks(dev);
4845                 yaffs_DeinitialiseTnodes(dev);
4846                 yaffs_DeinitialiseObjects(dev);
4847                 if(dev->nShortOpCaches > 0)
4848                         YFREE(dev->srCache);
4849                 YFREE(dev->localBuffer);
4850         }
4851
4852 }
4853
4854 #if 0
4855
4856 int  yaffs_GetNumberOfFreeChunks(yaffs_Device *dev)
4857 {
4858         int nFree = dev->nFreeChunks - (dev->nChunksPerBlock * YAFFS_RESERVED_BLOCKS);
4859
4860         struct list_head *i;
4861         yaffs_Object *l;
4862
4863
4864         // To the free chunks add the chunks that are in the deleted unlinked files.
4865         list_for_each(i,&dev->unlinkedDir->variant.directoryVariant.children)
4866         {
4867                 l = list_entry(i, yaffs_Object,siblings);
4868                 if(l->deleted)
4869                 {
4870                         nFree++;
4871                         nFree += l->nDataChunks;
4872                 }
4873         }
4874
4875
4876         // printf("___________ nFreeChunks is %d nFree is %d\n",dev->nFreeChunks,nFree);
4877
4878         if(nFree < 0) nFree = 0;
4879
4880         return nFree;
4881
4882 }
4883
4884 #endif
4885
4886 int  yaffs_GetNumberOfFreeChunks(yaffs_Device *dev)
4887 {
4888         int nFree;
4889         int pending;
4890         int b;
4891         int nDirtyCacheChunks=0;
4892
4893         yaffs_BlockInfo *blk;
4894
4895         struct list_head *i;
4896         yaffs_Object *l;
4897
4898         for(nFree = 0, b = dev->startBlock; b <= dev->endBlock; b++)
4899         {
4900                 blk = yaffs_GetBlockInfo(dev,b);
4901
4902                 switch(blk->blockState)
4903                 {
4904                         case YAFFS_BLOCK_STATE_EMPTY:
4905                         case YAFFS_BLOCK_STATE_ALLOCATING:
4906                         case YAFFS_BLOCK_STATE_FULL: nFree += (dev->nChunksPerBlock - blk->pagesInUse); break;
4907                         default: break;
4908                 }
4909         }
4910
4911
4912         pending = 0;
4913
4914         // To the free chunks add the chunks that are in the deleted unlinked files.
4915         list_for_each(i,&dev->unlinkedDir->variant.directoryVariant.children)
4916         {
4917                 if(i)
4918                 {
4919                         l = list_entry(i, yaffs_Object,siblings);
4920                         if(l->deleted)
4921                         {
4922                                 pending++;
4923                                 pending += l->nDataChunks;
4924                         }
4925                 }
4926         }
4927
4928
4929
4930         //printf("___________ really free is %d, pending %d, nFree is %d\n",nFree,pending, nFree+pending);
4931
4932         if(nFree != dev->nFreeChunks)
4933         {
4934         //      printf("___________Different! really free is %d, nFreeChunks %d\n",nFree dev->nFreeChunks);
4935         }
4936
4937         nFree += pending;
4938
4939         // Now count the number of dirty chunks in the cache and subtract those
4940
4941         {
4942                 int i;
4943                 for(i = 0; i < dev->nShortOpCaches; i++)
4944                 {
4945                         if(dev->srCache[i].dirty) nDirtyCacheChunks++;
4946                 }
4947         }
4948
4949         nFree -= nDirtyCacheChunks;
4950
4951         nFree -= ((dev->nReservedBlocks + 1) * dev->nChunksPerBlock);
4952
4953         if(nFree < 0) nFree = 0;
4954
4955         return nFree;
4956
4957 }
4958
4959
4960
4961 /////////////////// YAFFS test code //////////////////////////////////
4962
4963 #define yaffs_CheckStruct(structure,syze, name) \
4964            if(sizeof(structure) != syze) \
4965                { \
4966                  T(YAFFS_TRACE_ALWAYS,(TSTR("%s should be %d but is %d\n" TENDSTR),name,syze,sizeof(structure))); \
4967                  return YAFFS_FAIL; \
4968                    }
4969
4970
4971 static int yaffs_CheckStructures(void)
4972 {
4973         yaffs_CheckStruct(yaffs_Tags,8,"yaffs_Tags")
4974         yaffs_CheckStruct(yaffs_TagsUnion,8,"yaffs_TagsUnion")
4975         yaffs_CheckStruct(yaffs_Spare,16,"yaffs_Spare")
4976 #ifndef CONFIG_YAFFS_TNODE_LIST_DEBUG
4977         yaffs_CheckStruct(yaffs_Tnode,2* YAFFS_NTNODES_LEVEL0,"yaffs_Tnode")
4978 #endif
4979         yaffs_CheckStruct(yaffs_ObjectHeader,512,"yaffs_ObjectHeader")
4980
4981
4982         return YAFFS_OK;
4983 }
4984
4985 #if 0
4986 void yaffs_GutsTest(yaffs_Device *dev)
4987 {
4988
4989         if(yaffs_CheckStructures() != YAFFS_OK)
4990         {
4991                 T(YAFFS_TRACE_ALWAYS,(TSTR("One or more structures malformed-- aborting\n" TENDSTR)));
4992                 return;
4993         }
4994
4995         yaffs_TnodeTest(dev);
4996         yaffs_ObjectTest(dev);
4997 }
4998 #endif
4999
5000
5001