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