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