Fix negative hash problem
[yaffs2.git] / yaffs_guts.c
1 /*
2  * YAFFS: Yet another FFS. A NAND-flash specific file system. 
3  *
4  * Copyright (C) 2002 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
15 const char *yaffs_guts_c_version =
16     "$Id: yaffs_guts.c,v 1.28 2006-02-02 22:14:44 charles Exp $";
17
18 #include "yportenv.h"
19
20 #include "yaffsinterface.h"
21 #include "yaffs_guts.h"
22 #include "yaffs_tagsvalidity.h"
23
24 #include "yaffs_tagscompat.h"
25
26 #ifdef CONFIG_YAFFS_WINCE
27 void yfsd_LockYAFFS(BOOL fsLockOnly);
28 void yfsd_UnlockYAFFS(BOOL fsLockOnly);
29 #endif
30
31 #define YAFFS_PASSIVE_GC_CHUNKS 2
32
33 #include "yaffs_ecc.h"
34
35 /* NAND access */
36
37 static Y_INLINE int yaffs_ReadChunkWithTagsFromNAND(yaffs_Device * dev,
38                                                     int chunkInNAND,
39                                                     __u8 * buffer,
40                                                     yaffs_ExtendedTags * tags);
41 static Y_INLINE int yaffs_WriteChunkWithTagsToNAND(yaffs_Device * dev,
42                                                    int chunkInNAND,
43                                                    const __u8 * data,
44                                                    yaffs_ExtendedTags * tags);
45 static Y_INLINE int yaffs_MarkBlockBad(yaffs_Device * dev, int blockNo);
46 static Y_INLINE int yaffs_QueryInitialBlockState(yaffs_Device * dev,
47                                                  int blockNo,
48                                                  yaffs_BlockState * state,
49                                                  unsigned *sequenceNumber);
50 /* Robustification (if it ever comes about...) */
51 static void yaffs_RetireBlock(yaffs_Device * dev, int blockInNAND);
52 static void yaffs_HandleWriteChunkError(yaffs_Device * dev, int chunkInNAND);
53 static void yaffs_HandleWriteChunkOk(yaffs_Device * dev, int chunkInNAND,
54                                      const __u8 * data,
55                                      const yaffs_ExtendedTags * tags);
56 static void yaffs_HandleUpdateChunk(yaffs_Device * dev, int chunkInNAND,
57                                     const yaffs_ExtendedTags * tags);
58
59 /* Other local prototypes */
60 static int yaffs_UnlinkObject( yaffs_Object *obj);
61
62 static int yaffs_WriteNewChunkWithTagsToNAND(yaffs_Device * dev,
63                                              const __u8 * buffer,
64                                              yaffs_ExtendedTags * tags,
65                                              int useReserve);
66 static int yaffs_PutChunkIntoFile(yaffs_Object * in, int chunkInInode,
67                                   int chunkInNAND, int inScan);
68
69 static yaffs_Object *yaffs_CreateNewObject(yaffs_Device * dev, int number,
70                                            yaffs_ObjectType type);
71 static void yaffs_AddObjectToDirectory(yaffs_Object * directory,
72                                        yaffs_Object * obj);
73 static int yaffs_UpdateObjectHeader(yaffs_Object * in, const YCHAR * name,
74                                     int force, int isShrink, int shadows);
75 static void yaffs_RemoveObjectFromDirectory(yaffs_Object * obj);
76 static int yaffs_CheckStructures(void);
77 static int yaffs_DeleteWorker(yaffs_Object * in, yaffs_Tnode * tn, __u32 level,
78                               int chunkOffset, int *limit);
79 static int yaffs_DoGenericObjectDeletion(yaffs_Object * in);
80
81 static yaffs_BlockInfo *yaffs_GetBlockInfo(yaffs_Device * dev, int blockNo);
82
83 static __u8 *yaffs_GetTempBuffer(yaffs_Device * dev, int lineNo);
84 static void yaffs_ReleaseTempBuffer(yaffs_Device * dev, __u8 * buffer,
85                                     int lineNo);
86
87 static int yaffs_CheckChunkErased(struct yaffs_DeviceStruct *dev,
88                                   int chunkInNAND);
89
90 static int yaffs_UnlinkWorker(yaffs_Object * obj);
91 static void yaffs_DestroyObject(yaffs_Object * obj);
92
93 static int yaffs_TagsMatch(const yaffs_ExtendedTags * tags, int objectId,
94                            int chunkInObject);
95
96 loff_t yaffs_GetFileSize(yaffs_Object * obj);
97
98 static int yaffs_AllocateChunk(yaffs_Device * dev, int useReserve);
99
100 static void yaffs_VerifyFreeChunks(yaffs_Device * dev);
101
102 #ifdef YAFFS_PARANOID
103 static int yaffs_CheckFileSanity(yaffs_Object * in);
104 #else
105 #define yaffs_CheckFileSanity(in)
106 #endif
107
108 static void yaffs_InvalidateWholeChunkCache(yaffs_Object * in);
109 static void yaffs_InvalidateChunkCache(yaffs_Object * object, int chunkId);
110
111
112 /*
113  *   Start of real code.
114  */
115
116 /*
117  * NAND access layer
118  */
119  
120
121
122 static int yaffs_ReadChunkWithTagsFromNAND(yaffs_Device * dev, int chunkInNAND,
123                                            __u8 * buffer,
124                                            yaffs_ExtendedTags * tags)
125 {
126         chunkInNAND -= dev->chunkOffset;
127
128         if (dev->readChunkWithTagsFromNAND)
129                 return dev->readChunkWithTagsFromNAND(dev, chunkInNAND, buffer,
130                                                       tags);
131         else
132                 return yaffs_TagsCompatabilityReadChunkWithTagsFromNAND(dev,
133                                                                         chunkInNAND,
134                                                                         buffer,
135                                                                         tags);
136 }
137
138 static Y_INLINE int yaffs_WriteChunkWithTagsToNAND(yaffs_Device * dev,
139                                                    int chunkInNAND,
140                                                    const __u8 * buffer,
141                                                    yaffs_ExtendedTags * tags)
142 {
143         chunkInNAND -= dev->chunkOffset;
144
145         if (tags) {
146                 tags->sequenceNumber = dev->sequenceNumber;
147                 tags->chunkUsed = 1;
148                 if (!yaffs_ValidateTags(tags)) {
149                         T(YAFFS_TRACE_ERROR,
150                           (TSTR("Writing uninitialised tags" TENDSTR)));
151                         YBUG();
152                 }
153                 T(YAFFS_TRACE_WRITE,
154                   (TSTR("Writing chunk %d tags %d %d" TENDSTR), chunkInNAND,
155                    tags->objectId, tags->chunkId));
156         } else {
157                 T(YAFFS_TRACE_ERROR, (TSTR("Writing with no tags" TENDSTR)));
158                 YBUG();
159         }
160
161         if (dev->writeChunkWithTagsToNAND)
162                 return dev->writeChunkWithTagsToNAND(dev, chunkInNAND, buffer,
163                                                      tags);
164         else
165                 return yaffs_TagsCompatabilityWriteChunkWithTagsToNAND(dev,
166                                                                        chunkInNAND,
167                                                                        buffer,
168                                                                        tags);
169 }
170
171 static Y_INLINE int yaffs_MarkBlockBad(yaffs_Device * dev, int blockNo)
172 {
173         blockNo -= dev->blockOffset;
174
175         if (dev->markNANDBlockBad)
176                 return dev->markNANDBlockBad(dev, blockNo);
177         else
178                 return yaffs_TagsCompatabilityMarkNANDBlockBad(dev, blockNo);
179 }
180 static Y_INLINE int yaffs_QueryInitialBlockState(yaffs_Device * dev,
181                                                  int blockNo,
182                                                  yaffs_BlockState * state,
183                                                  unsigned *sequenceNumber)
184 {
185         blockNo -= dev->blockOffset;
186
187         if (dev->queryNANDBlock)
188                 return dev->queryNANDBlock(dev, blockNo, state, sequenceNumber);
189         else
190                 return yaffs_TagsCompatabilityQueryNANDBlock(dev, blockNo,
191                                                              state,
192                                                              sequenceNumber);
193 }
194
195 static int yaffs_EraseBlockInNAND(struct yaffs_DeviceStruct *dev,
196                                   int blockInNAND)
197 {
198         int result;
199
200         blockInNAND -= dev->blockOffset;
201
202         dev->nBlockErasures++;
203         result = dev->eraseBlockInNAND(dev, blockInNAND);
204
205         /* If at first we don't succeed, try again *once*.*/
206         if (!result)
207                 result = dev->eraseBlockInNAND(dev, blockInNAND);       
208         return result;
209 }
210
211 static int yaffs_InitialiseNAND(struct yaffs_DeviceStruct *dev)
212 {
213         return dev->initialiseNAND(dev);
214 }
215
216 /* 
217  * Temporary buffer manipulations.
218  */
219
220 static __u8 *yaffs_GetTempBuffer(yaffs_Device * dev, int lineNo)
221 {
222         int i, j;
223         for (i = 0; i < YAFFS_N_TEMP_BUFFERS; i++) {
224                 if (dev->tempBuffer[i].line == 0) {
225                         dev->tempBuffer[i].line = lineNo;
226                         if ((i + 1) > dev->maxTemp) {
227                                 dev->maxTemp = i + 1;
228                                 for (j = 0; j <= i; j++)
229                                         dev->tempBuffer[j].maxLine =
230                                             dev->tempBuffer[j].line;
231                         }
232
233                         return dev->tempBuffer[i].buffer;
234                 }
235         }
236
237         T(YAFFS_TRACE_BUFFERS,
238           (TSTR("Out of temp buffers at line %d, other held by lines:"),
239            lineNo));
240         for (i = 0; i < YAFFS_N_TEMP_BUFFERS; i++) {
241                 T(YAFFS_TRACE_BUFFERS, (TSTR(" %d "), dev->tempBuffer[i].line));
242         }
243         T(YAFFS_TRACE_BUFFERS, (TSTR(" " TENDSTR)));
244
245         /*
246          * If we got here then we have to allocate an unmanaged one
247          * This is not good.
248          */
249
250         dev->unmanagedTempAllocations++;
251         return YMALLOC(dev->nBytesPerChunk);
252
253 }
254
255 static void yaffs_ReleaseTempBuffer(yaffs_Device * dev, __u8 * buffer,
256                                     int lineNo)
257 {
258         int i;
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  * Chunk bitmap manipulations
279  */
280
281 static Y_INLINE __u8 *yaffs_BlockBits(yaffs_Device * dev, int blk)
282 {
283         if (blk < dev->internalStartBlock || blk > dev->internalEndBlock) {
284                 T(YAFFS_TRACE_ERROR,
285                   (TSTR("**>> yaffs: BlockBits block %d is not valid" TENDSTR),
286                    blk));
287                 YBUG();
288         }
289         return dev->chunkBits +
290             (dev->chunkBitmapStride * (blk - dev->internalStartBlock));
291 }
292
293 static Y_INLINE void yaffs_ClearChunkBits(yaffs_Device * dev, int blk)
294 {
295         __u8 *blkBits = yaffs_BlockBits(dev, blk);
296
297         memset(blkBits, 0, dev->chunkBitmapStride);
298 }
299
300 static Y_INLINE void yaffs_ClearChunkBit(yaffs_Device * dev, int blk, int chunk)
301 {
302         __u8 *blkBits = yaffs_BlockBits(dev, blk);
303
304         blkBits[chunk / 8] &= ~(1 << (chunk & 7));
305 }
306
307 static Y_INLINE void yaffs_SetChunkBit(yaffs_Device * dev, int blk, int chunk)
308 {
309         __u8 *blkBits = yaffs_BlockBits(dev, blk);
310
311         blkBits[chunk / 8] |= (1 << (chunk & 7));
312 }
313
314 static Y_INLINE int yaffs_CheckChunkBit(yaffs_Device * dev, int blk, int chunk)
315 {
316         __u8 *blkBits = yaffs_BlockBits(dev, blk);
317         return (blkBits[chunk / 8] & (1 << (chunk & 7))) ? 1 : 0;
318 }
319
320 static Y_INLINE int yaffs_StillSomeChunkBits(yaffs_Device * dev, int blk)
321 {
322         __u8 *blkBits = yaffs_BlockBits(dev, blk);
323         int i;
324         for (i = 0; i < dev->chunkBitmapStride; i++) {
325                 if (*blkBits)
326                         return 1;
327                 blkBits++;
328         }
329         return 0;
330 }
331
332 /*
333  *  Simple hash function. Needs to have a reasonable spread
334  */
335  
336 static Y_INLINE int yaffs_HashFunction(int n)
337 {
338         n = abs(n);
339         return (n % YAFFS_NOBJECT_BUCKETS);
340 }
341
342 /*
343  * Access functions to useful fake objects
344  */
345  
346 yaffs_Object *yaffs_Root(yaffs_Device * dev)
347 {
348         return dev->rootDir;
349 }
350
351 yaffs_Object *yaffs_LostNFound(yaffs_Device * dev)
352 {
353         return dev->lostNFoundDir;
354 }
355
356
357 /*
358  *  Erased NAND checking functions
359  */
360  
361 int yaffs_CheckFF(__u8 * buffer, int nBytes)
362 {
363         /* Horrible, slow implementation */
364         while (nBytes--) {
365                 if (*buffer != 0xFF)
366                         return 0;
367                 buffer++;
368         }
369         return 1;
370 }
371
372 static int yaffs_CheckChunkErased(struct yaffs_DeviceStruct *dev,
373                                   int chunkInNAND)
374 {
375
376         int retval = YAFFS_OK;
377         __u8 *data = yaffs_GetTempBuffer(dev, __LINE__);
378         yaffs_ExtendedTags tags;
379
380         yaffs_ReadChunkWithTagsFromNAND(dev, chunkInNAND, data, &tags);
381
382         if (!yaffs_CheckFF(data, dev->nBytesPerChunk) || tags.chunkUsed) {
383                 T(YAFFS_TRACE_NANDACCESS,
384                   (TSTR("Chunk %d not erased" TENDSTR), chunkInNAND));
385                 retval = YAFFS_FAIL;
386         }
387
388         yaffs_ReleaseTempBuffer(dev, data, __LINE__);
389
390         return retval;
391
392 }
393
394 static int yaffs_WriteNewChunkWithTagsToNAND(struct yaffs_DeviceStruct *dev,
395                                              const __u8 * data,
396                                              yaffs_ExtendedTags * tags,
397                                              int useReserve)
398 {
399         int chunk;
400
401         int writeOk = 1;
402         int attempts = 0;
403
404         do {
405                 chunk = yaffs_AllocateChunk(dev, useReserve);
406
407                 if (chunk >= 0) {
408
409                         /* First check this chunk is erased... */
410 #ifndef CONFIG_YAFFS_DISABLE_CHUNK_ERASED_CHECK
411                         writeOk = yaffs_CheckChunkErased(dev, chunk);
412 #endif
413                         if (!writeOk) {
414                                 T(YAFFS_TRACE_ERROR,
415                                   (TSTR
416                                    ("**>> yaffs chunk %d was not erased"
417                                     TENDSTR), chunk));
418                         } else {
419                                 writeOk =
420                                     yaffs_WriteChunkWithTagsToNAND(dev, chunk,
421                                                                    data, tags);
422                         }
423                         attempts++;
424
425                         if (writeOk) {
426                                 /*
427                                  *  Copy the data into the robustification buffer.
428                                  *  NB We do this at the end to prevent duplicates in the case of a write error.
429                                  *  Todo
430                                  */
431                                 yaffs_HandleWriteChunkOk(dev, chunk, data,
432                                                          tags);
433                         } else {
434                                 yaffs_HandleWriteChunkError(dev, chunk);
435                         }
436                 }
437
438         } while (chunk >= 0 && !writeOk);
439
440         if (attempts > 1) {
441                 T(YAFFS_TRACE_ERROR,
442                   (TSTR("**>> yaffs write required %d attempts" TENDSTR),
443                    attempts));
444                 dev->nRetriedWrites += (attempts - 1);
445         }
446
447         return chunk;
448 }
449
450 /*
451  * Block retiring for handling a broken block.
452  */
453  
454 static void yaffs_RetireBlock(yaffs_Device * dev, int blockInNAND)
455 {
456
457         yaffs_MarkBlockBad(dev, blockInNAND);
458
459         yaffs_GetBlockInfo(dev, blockInNAND)->blockState =
460             YAFFS_BLOCK_STATE_DEAD;
461
462         dev->nRetiredBlocks++;
463 }
464
465 /*
466  * Functions for robustisizing TODO
467  *
468  */
469  
470 static void yaffs_HandleWriteChunkOk(yaffs_Device * dev, int chunkInNAND,
471                                      const __u8 * data,
472                                      const yaffs_ExtendedTags * tags)
473 {
474 }
475
476 static void yaffs_HandleUpdateChunk(yaffs_Device * dev, int chunkInNAND,
477                                     const yaffs_ExtendedTags * tags)
478 {
479 }
480
481 static void yaffs_HandleWriteChunkError(yaffs_Device * dev, int chunkInNAND)
482 {
483         int blockInNAND = chunkInNAND / dev->nChunksPerBlock;
484
485         /* Mark the block for retirement */
486         yaffs_GetBlockInfo(dev, blockInNAND)->needsRetiring = 1;
487         /* Delete the chunk */
488         yaffs_DeleteChunk(dev, chunkInNAND, 1, __LINE__);
489 }
490
491
492 /*---------------- Name handling functions ------------*/ 
493
494 static __u16 yaffs_CalcNameSum(const YCHAR * name)
495 {
496         __u16 sum = 0;
497         __u16 i = 1;
498
499         YUCHAR *bname = (YUCHAR *) name;
500         if (bname) {
501                 while ((*bname) && (i <= YAFFS_MAX_NAME_LENGTH)) {
502
503 #ifdef CONFIG_YAFFS_CASE_INSENSITIVE
504                         sum += yaffs_toupper(*bname) * i;
505 #else
506                         sum += (*bname) * i;
507 #endif
508                         i++;
509                         bname++;
510                 }
511         }
512         return sum;
513 }
514
515 static void yaffs_SetObjectName(yaffs_Object * obj, const YCHAR * name)
516 {
517 #ifdef CONFIG_YAFFS_SHORT_NAMES_IN_RAM
518         if (name && yaffs_strlen(name) <= YAFFS_SHORT_NAME_LENGTH) {
519                 yaffs_strcpy(obj->shortName, name);
520         } else {
521                 obj->shortName[0] = _Y('\0');
522         }
523 #endif
524         obj->sum = yaffs_CalcNameSum(name);
525 }
526
527 /*-------------------- TNODES -------------------
528
529  * List of spare tnodes
530  * The list is hooked together using the first pointer
531  * in the tnode.
532  */
533  
534 /* yaffs_CreateTnodes creates a bunch more tnodes and
535  * adds them to the tnode free list.
536  * Don't use this function directly
537  */
538
539 static int yaffs_CreateTnodes(yaffs_Device * dev, int nTnodes)
540 {
541         int i;
542         int tnodeSize;
543         yaffs_Tnode *newTnodes;
544         __u8 *mem;
545         yaffs_Tnode *curr;
546         yaffs_Tnode *next;
547         yaffs_TnodeList *tnl;
548
549         if (nTnodes < 1)
550                 return YAFFS_OK;
551                 
552         /* Calculate the tnode size in bytes for variable width tnode support.
553          * Must be a multiple of 32-bits  */
554         tnodeSize = (dev->tnodeWidth * YAFFS_NTNODES_LEVEL0)/8;
555
556         /* make these things */
557
558         newTnodes = YMALLOC(nTnodes * tnodeSize);
559         mem = (__u8 *)newTnodes;
560
561         if (!newTnodes) {
562                 T(YAFFS_TRACE_ERROR,
563                   (TSTR("yaffs: Could not allocate Tnodes" TENDSTR)));
564                 return YAFFS_FAIL;
565         }
566
567         /* Hook them into the free list */
568 #if 0
569         for (i = 0; i < nTnodes - 1; i++) {
570                 newTnodes[i].internal[0] = &newTnodes[i + 1];
571 #ifdef CONFIG_YAFFS_TNODE_LIST_DEBUG
572                 newTnodes[i].internal[YAFFS_NTNODES_INTERNAL] = (void *)1;
573 #endif
574         }
575
576         newTnodes[nTnodes - 1].internal[0] = dev->freeTnodes;
577 #ifdef CONFIG_YAFFS_TNODE_LIST_DEBUG
578         newTnodes[nTnodes - 1].internal[YAFFS_NTNODES_INTERNAL] = (void *)1;
579 #endif
580         dev->freeTnodes = newTnodes;
581 #else
582         /* New hookup for wide tnodes */
583         for(i = 0; i < nTnodes -1; i++) {
584                 curr = (yaffs_Tnode *) &mem[i * tnodeSize];
585                 next = (yaffs_Tnode *) &mem[(i+1) * tnodeSize];
586                 curr->internal[0] = next;
587         }
588         
589         curr = (yaffs_Tnode *) &mem[(nTnodes - 1) * tnodeSize];
590         curr->internal[0] = dev->freeTnodes;
591         dev->freeTnodes = (yaffs_Tnode *)mem;
592
593 #endif
594
595
596         dev->nFreeTnodes += nTnodes;
597         dev->nTnodesCreated += nTnodes;
598
599         /* Now add this bunch of tnodes to a list for freeing up.
600          * NB If we can't add this to the management list it isn't fatal
601          * but it just means we can't free this bunch of tnodes later.
602          */
603          
604         tnl = YMALLOC(sizeof(yaffs_TnodeList));
605         if (!tnl) {
606                 T(YAFFS_TRACE_ERROR,
607                   (TSTR
608                    ("yaffs: Could not add tnodes to management list" TENDSTR)));
609
610         } else {
611                 tnl->tnodes = newTnodes;
612                 tnl->next = dev->allocatedTnodeList;
613                 dev->allocatedTnodeList = tnl;
614         }
615
616         T(YAFFS_TRACE_ALLOCATE, (TSTR("yaffs: Tnodes added" TENDSTR)));
617
618         return YAFFS_OK;
619 }
620
621 /* GetTnode gets us a clean tnode. Tries to make allocate more if we run out */
622
623 static yaffs_Tnode *yaffs_GetTnode(yaffs_Device * dev)
624 {
625         yaffs_Tnode *tn = NULL;
626
627         /* If there are none left make more */
628         if (!dev->freeTnodes) {
629                 yaffs_CreateTnodes(dev, YAFFS_ALLOCATION_NTNODES);
630         }
631
632         if (dev->freeTnodes) {
633                 tn = dev->freeTnodes;
634 #ifdef CONFIG_YAFFS_TNODE_LIST_DEBUG
635                 if (tn->internal[YAFFS_NTNODES_INTERNAL] != (void *)1) {
636                         /* Hoosterman, this thing looks like it isn't in the list */
637                         T(YAFFS_TRACE_ALWAYS,
638                           (TSTR("yaffs: Tnode list bug 1" TENDSTR)));
639                 }
640 #endif
641                 dev->freeTnodes = dev->freeTnodes->internal[0];
642                 dev->nFreeTnodes--;
643                 /* zero out */
644                 memset(tn, 0, (dev->tnodeWidth * YAFFS_NTNODES_LEVEL0)/8);
645         }
646
647         return tn;
648 }
649
650 /* FreeTnode frees up a tnode and puts it back on the free list */
651 static void yaffs_FreeTnode(yaffs_Device * dev, yaffs_Tnode * tn)
652 {
653         if (tn) {
654 #ifdef CONFIG_YAFFS_TNODE_LIST_DEBUG
655                 if (tn->internal[YAFFS_NTNODES_INTERNAL] != 0) {
656                         /* Hoosterman, this thing looks like it is already in the list */
657                         T(YAFFS_TRACE_ALWAYS,
658                           (TSTR("yaffs: Tnode list bug 2" TENDSTR)));
659                 }
660                 tn->internal[YAFFS_NTNODES_INTERNAL] = (void *)1;
661 #endif
662                 tn->internal[0] = dev->freeTnodes;
663                 dev->freeTnodes = tn;
664                 dev->nFreeTnodes++;
665         }
666 }
667
668 static void yaffs_DeinitialiseTnodes(yaffs_Device * dev)
669 {
670         /* Free the list of allocated tnodes */
671         yaffs_TnodeList *tmp;
672
673         while (dev->allocatedTnodeList) {
674                 tmp = dev->allocatedTnodeList->next;
675
676                 YFREE(dev->allocatedTnodeList->tnodes);
677                 YFREE(dev->allocatedTnodeList);
678                 dev->allocatedTnodeList = tmp;
679
680         }
681
682         dev->freeTnodes = NULL;
683         dev->nFreeTnodes = 0;
684 }
685
686 static void yaffs_InitialiseTnodes(yaffs_Device * dev)
687 {
688         dev->allocatedTnodeList = NULL;
689         dev->freeTnodes = NULL;
690         dev->nFreeTnodes = 0;
691         dev->nTnodesCreated = 0;
692
693 }
694
695
696 void yaffs_PutLevel0Tnode(yaffs_Device *dev, yaffs_Tnode *tn, unsigned pos, unsigned val)
697 {
698   __u32 *map = (__u32 *)tn;
699   __u32 bitInMap;
700   __u32 bitInWord;
701   __u32 wordInMap;
702   __u32 mask;
703   
704   pos &= YAFFS_TNODES_LEVEL0_MASK;
705   val >>= dev->chunkGroupBits;
706   
707   bitInMap = pos * dev->tnodeWidth;
708   wordInMap = bitInMap /32;
709   bitInWord = bitInMap & (32 -1);
710   
711   mask = dev->tnodeMask << bitInWord;
712   
713   map[wordInMap] &= ~mask;
714   map[wordInMap] |= (mask & (val << bitInWord));
715   
716   if(dev->tnodeWidth > (32-bitInWord)) {
717     bitInWord = (32 - bitInWord);
718     wordInMap++;;
719     mask = dev->tnodeMask >> (/*dev->tnodeWidth -*/ bitInWord);
720     map[wordInMap] &= ~mask;
721     map[wordInMap] |= (mask & (val >> bitInWord));
722   }
723 }
724
725 __u32 yaffs_GetChunkGroupBase(yaffs_Device *dev, yaffs_Tnode *tn, unsigned pos)
726 {
727   __u32 *map = (__u32 *)tn;
728   __u32 bitInMap;
729   __u32 bitInWord;
730   __u32 wordInMap;
731   __u32 val;
732   
733   pos &= YAFFS_TNODES_LEVEL0_MASK;
734   
735   bitInMap = pos * dev->tnodeWidth;
736   wordInMap = bitInMap /32;
737   bitInWord = bitInMap & (32 -1);
738   
739   val = map[wordInMap] >> bitInWord;
740   
741   if(dev->tnodeWidth > (32-bitInWord)) {
742     bitInWord = (32 - bitInWord);
743     wordInMap++;;
744     val |= (map[wordInMap] << bitInWord);
745   }
746   
747   val &= dev->tnodeMask;
748   val <<= dev->chunkGroupBits;
749   
750   return val;
751 }
752
753 /* ------------------- End of individual tnode manipulation -----------------*/
754
755 /* ---------Functions to manipulate the look-up tree (made up of tnodes) ------
756  * The look up tree is represented by the top tnode and the number of topLevel
757  * in the tree. 0 means only the level 0 tnode is in the tree.
758  */
759
760 /* FindLevel0Tnode finds the level 0 tnode, if one exists. */
761 static yaffs_Tnode *yaffs_FindLevel0Tnode(yaffs_Device * dev,
762                                           yaffs_FileStructure * fStruct,
763                                           __u32 chunkId)
764 {
765
766         yaffs_Tnode *tn = fStruct->top;
767         __u32 i;
768         int requiredTallness;
769         int level = fStruct->topLevel;
770
771         /* Check sane level and chunk Id */
772         if (level < 0 || level > YAFFS_TNODES_MAX_LEVEL) {
773                 return NULL;
774         }
775
776         if (chunkId > YAFFS_MAX_CHUNK_ID) {
777                 return NULL;
778         }
779
780         /* First check we're tall enough (ie enough topLevel) */
781
782         i = chunkId >> YAFFS_TNODES_LEVEL0_BITS;
783         requiredTallness = 0;
784         while (i) {
785                 i >>= YAFFS_TNODES_INTERNAL_BITS;
786                 requiredTallness++;
787         }
788
789         if (requiredTallness > fStruct->topLevel) {
790                 /* Not tall enough, so we can't find it, return NULL. */
791                 return NULL;
792         }
793
794         /* Traverse down to level 0 */
795         while (level > 0 && tn) {
796                 tn = tn->
797                     internal[(chunkId >>
798                                ( YAFFS_TNODES_LEVEL0_BITS + 
799                                  (level - 1) *
800                                  YAFFS_TNODES_INTERNAL_BITS)
801                               ) &
802                              YAFFS_TNODES_INTERNAL_MASK];
803                 level--;
804
805         }
806
807         return tn;
808 }
809
810 /* AddOrFindLevel0Tnode finds the level 0 tnode if it exists, otherwise first expands the tree.
811  * This happens in two steps:
812  *  1. If the tree isn't tall enough, then make it taller.
813  *  2. Scan down the tree towards the level 0 tnode adding tnodes if required.
814  *
815  * Used when modifying the tree.
816  */
817  
818 static yaffs_Tnode *yaffs_AddOrFindLevel0Tnode(yaffs_Device * dev,
819                                                yaffs_FileStructure * fStruct,
820                                                __u32 chunkId)
821 {
822
823         yaffs_Tnode *tn;
824
825         int requiredTallness;
826         int i;
827         int l;
828
829         __u32 x;
830
831
832         /* Check sane level and page Id */
833         if (fStruct->topLevel < 0 || fStruct->topLevel > YAFFS_TNODES_MAX_LEVEL) {
834                 return NULL;
835         }
836
837         if (chunkId > YAFFS_MAX_CHUNK_ID) {
838                 return NULL;
839         }
840
841         /* First check we're tall enough (ie enough topLevel) */
842
843         x = chunkId >> YAFFS_TNODES_LEVEL0_BITS;
844         requiredTallness = 0;
845         while (x) {
846                 x >>= YAFFS_TNODES_INTERNAL_BITS;
847                 requiredTallness++;
848         }
849
850
851         if (requiredTallness > fStruct->topLevel) {
852                 /* Not tall enough,gotta make the tree taller */
853                 for (i = fStruct->topLevel; i < requiredTallness; i++) {
854                 
855                         tn = yaffs_GetTnode(dev);
856
857                         if (tn) {
858                                 tn->internal[0] = fStruct->top;
859                                 fStruct->top = tn;
860                         } else {
861                                 T(YAFFS_TRACE_ERROR,
862                                   (TSTR("yaffs: no more tnodes" TENDSTR)));
863                         }
864                 }
865
866                 fStruct->topLevel = requiredTallness;
867         }
868
869         /* Traverse down to level 0, adding anything we need */
870
871         l = fStruct->topLevel;
872         tn = fStruct->top;
873         while (l > 0 && tn) {
874                 x = (chunkId >>
875                      ( YAFFS_TNODES_LEVEL0_BITS +
876                       (l - 1) * YAFFS_TNODES_INTERNAL_BITS)) &
877                     YAFFS_TNODES_INTERNAL_MASK;
878
879
880                 if (!tn->internal[x])
881                         tn->internal[x] = yaffs_GetTnode(dev);
882
883                 tn = tn->internal[x];
884                 l--;
885
886         }
887
888         return tn;
889 }
890
891 static int yaffs_FindChunkInGroup(yaffs_Device * dev, int theChunk,
892                                   yaffs_ExtendedTags * tags, int objectId,
893                                   int chunkInInode)
894 {
895         int j;
896
897         for (j = 0; theChunk && j < dev->chunkGroupSize; j++) {
898                 if (yaffs_CheckChunkBit
899                     (dev, theChunk / dev->nChunksPerBlock,
900                      theChunk % dev->nChunksPerBlock)) {
901                         yaffs_ReadChunkWithTagsFromNAND(dev, theChunk, NULL,
902                                                         tags);
903                         if (yaffs_TagsMatch(tags, objectId, chunkInInode)) {
904                                 /* found it; */
905                                 return theChunk;
906
907                         }
908                 }
909                 theChunk++;
910         }
911         return -1;
912 }
913
914
915 /* DeleteWorker scans backwards through the tnode tree and deletes all the
916  * chunks and tnodes in the file
917  * Returns 1 if the tree was deleted. 
918  * Returns 0 if it stopped early due to hitting the limit and the delete is incomplete.
919  */
920
921 static int yaffs_DeleteWorker(yaffs_Object * in, yaffs_Tnode * tn, __u32 level,
922                               int chunkOffset, int *limit)
923 {
924         int i;
925         int chunkInInode;
926         int theChunk;
927         yaffs_ExtendedTags tags;
928         int foundChunk;
929         yaffs_Device *dev = in->myDev;
930
931         int allDone = 1;
932
933         if (tn) {
934                 if (level > 0) {
935
936                         for (i = YAFFS_NTNODES_INTERNAL - 1; allDone && i >= 0;
937                              i--) {
938                                 if (tn->internal[i]) {
939                                         if (limit && (*limit) < 0) {
940                                                 allDone = 0;
941                                         } else {
942                                                 allDone =
943                                                     yaffs_DeleteWorker(in,
944                                                                        tn->
945                                                                        internal
946                                                                        [i],
947                                                                        level -
948                                                                        1,
949                                                                        (chunkOffset
950                                                                         <<
951                                                                         YAFFS_TNODES_INTERNAL_BITS)
952                                                                        + i,
953                                                                        limit);
954                                         }
955                                         if (allDone) {
956                                                 yaffs_FreeTnode(dev,
957                                                                 tn->
958                                                                 internal[i]);
959                                                 tn->internal[i] = NULL;
960                                         }
961                                 }
962
963                         }
964                         return (allDone) ? 1 : 0;
965                 } else if (level == 0) {
966                         int hitLimit = 0;
967
968                         for (i = YAFFS_NTNODES_LEVEL0 - 1; i >= 0 && !hitLimit;
969                              i--) {
970                                 theChunk = yaffs_GetChunkGroupBase(dev,tn,i);
971                                 if (theChunk) {
972
973                                         chunkInInode =
974                                             (chunkOffset <<
975                                              YAFFS_TNODES_LEVEL0_BITS) + i;
976
977                                         foundChunk =
978                                             yaffs_FindChunkInGroup(dev,
979                                                                    theChunk,
980                                                                    &tags,
981                                                                    in->objectId,
982                                                                    chunkInInode);
983
984                                         if (foundChunk > 0) {
985                                                 yaffs_DeleteChunk(dev,
986                                                                   foundChunk, 1,
987                                                                   __LINE__);
988                                                 in->nDataChunks--;
989                                                 if (limit) {
990                                                         *limit = *limit - 1;
991                                                         if (*limit <= 0) {
992                                                                 hitLimit = 1;
993                                                         }
994                                                 }
995
996                                         }
997
998                                         yaffs_PutLevel0Tnode(dev,tn,i,0);
999                                 }
1000
1001                         }
1002                         return (i < 0) ? 1 : 0;
1003
1004                 }
1005
1006         }
1007
1008         return 1;
1009
1010 }
1011
1012 static void yaffs_SoftDeleteChunk(yaffs_Device * dev, int chunk)
1013 {
1014
1015         yaffs_BlockInfo *theBlock;
1016
1017         T(YAFFS_TRACE_DELETION, (TSTR("soft delete chunk %d" TENDSTR), chunk));
1018
1019         theBlock = yaffs_GetBlockInfo(dev, chunk / dev->nChunksPerBlock);
1020         if (theBlock) {
1021                 theBlock->softDeletions++;
1022                 dev->nFreeChunks++;
1023         }
1024 }
1025
1026 /* SoftDeleteWorker scans backwards through the tnode tree and soft deletes all the chunks in the file.
1027  * All soft deleting does is increment the block's softdelete count and pulls the chunk out
1028  * of the tnode.
1029  * Thus, essentially this is the same as DeleteWorker except that the chunks are soft deleted.
1030  */
1031  
1032 static int yaffs_SoftDeleteWorker(yaffs_Object * in, yaffs_Tnode * tn,
1033                                   __u32 level, int chunkOffset)
1034 {
1035         int i;
1036         int theChunk;
1037         int allDone = 1;
1038         yaffs_Device *dev = in->myDev;
1039
1040         if (tn) {
1041                 if (level > 0) {
1042
1043                         for (i = YAFFS_NTNODES_INTERNAL - 1; allDone && i >= 0;
1044                              i--) {
1045                                 if (tn->internal[i]) {
1046                                         allDone =
1047                                             yaffs_SoftDeleteWorker(in,
1048                                                                    tn->
1049                                                                    internal[i],
1050                                                                    level - 1,
1051                                                                    (chunkOffset
1052                                                                     <<
1053                                                                     YAFFS_TNODES_INTERNAL_BITS)
1054                                                                    + i);
1055                                         if (allDone) {
1056                                                 yaffs_FreeTnode(dev,
1057                                                                 tn->
1058                                                                 internal[i]);
1059                                                 tn->internal[i] = NULL;
1060                                         } else {
1061                                                 /* Hoosterman... how could this happen? */
1062                                         }
1063                                 }
1064                         }
1065                         return (allDone) ? 1 : 0;
1066                 } else if (level == 0) {
1067
1068                         for (i = YAFFS_NTNODES_LEVEL0 - 1; i >= 0; i--) {
1069                                 theChunk = yaffs_GetChunkGroupBase(dev,tn,i);
1070                                 if (theChunk) {
1071                                         /* Note this does not find the real chunk, only the chunk group.
1072                                          * We make an assumption that a chunk group is not larger than 
1073                                          * a block.
1074                                          */
1075                                         yaffs_SoftDeleteChunk(dev, theChunk);
1076                                         yaffs_PutLevel0Tnode(dev,tn,i,0);
1077                                 }
1078
1079                         }
1080                         return 1;
1081
1082                 }
1083
1084         }
1085
1086         return 1;
1087
1088 }
1089
1090 static void yaffs_SoftDeleteFile(yaffs_Object * obj)
1091 {
1092         if (obj->deleted &&
1093             obj->variantType == YAFFS_OBJECT_TYPE_FILE && !obj->softDeleted) {
1094                 if (obj->nDataChunks <= 0) {
1095                         /* Empty file with no duplicate object headers, just delete it immediately */
1096                         yaffs_FreeTnode(obj->myDev,
1097                                         obj->variant.fileVariant.top);
1098                         obj->variant.fileVariant.top = NULL;
1099                         T(YAFFS_TRACE_TRACING,
1100                           (TSTR("yaffs: Deleting empty file %d" TENDSTR),
1101                            obj->objectId));
1102                         yaffs_DoGenericObjectDeletion(obj);
1103                 } else {
1104                         yaffs_SoftDeleteWorker(obj,
1105                                                obj->variant.fileVariant.top,
1106                                                obj->variant.fileVariant.
1107                                                topLevel, 0);
1108                         obj->softDeleted = 1;
1109                 }
1110         }
1111 }
1112
1113 /* Pruning removes any part of the file structure tree that is beyond the
1114  * bounds of the file (ie that does not point to chunks).
1115  *
1116  * A file should only get pruned when its size is reduced.
1117  *
1118  * Before pruning, the chunks must be pulled from the tree and the
1119  * level 0 tnode entries must be zeroed out.
1120  * Could also use this for file deletion, but that's probably better handled
1121  * by a special case.
1122  */
1123
1124 static yaffs_Tnode *yaffs_PruneWorker(yaffs_Device * dev, yaffs_Tnode * tn,
1125                                       __u32 level, int del0)
1126 {
1127         int i;
1128         int hasData;
1129
1130         if (tn) {
1131                 hasData = 0;
1132
1133                 for (i = 0; i < YAFFS_NTNODES_INTERNAL; i++) {
1134                         if (tn->internal[i] && level > 0) {
1135                                 tn->internal[i] =
1136                                     yaffs_PruneWorker(dev, tn->internal[i],
1137                                                       level - 1,
1138                                                       (i == 0) ? del0 : 1);
1139                         }
1140
1141                         if (tn->internal[i]) {
1142                                 hasData++;
1143                         }
1144                 }
1145
1146                 if (hasData == 0 && del0) {
1147                         /* Free and return NULL */
1148
1149                         yaffs_FreeTnode(dev, tn);
1150                         tn = NULL;
1151                 }
1152
1153         }
1154
1155         return tn;
1156
1157 }
1158
1159 static int yaffs_PruneFileStructure(yaffs_Device * dev,
1160                                     yaffs_FileStructure * fStruct)
1161 {
1162         int i;
1163         int hasData;
1164         int done = 0;
1165         yaffs_Tnode *tn;
1166
1167         if (fStruct->topLevel > 0) {
1168                 fStruct->top =
1169                     yaffs_PruneWorker(dev, fStruct->top, fStruct->topLevel, 0);
1170
1171                 /* Now we have a tree with all the non-zero branches NULL but the height
1172                  * is the same as it was.
1173                  * Let's see if we can trim internal tnodes to shorten the tree.
1174                  * We can do this if only the 0th element in the tnode is in use 
1175                  * (ie all the non-zero are NULL)
1176                  */
1177
1178                 while (fStruct->topLevel && !done) {
1179                         tn = fStruct->top;
1180
1181                         hasData = 0;
1182                         for (i = 1; i < YAFFS_NTNODES_INTERNAL; i++) {
1183                                 if (tn->internal[i]) {
1184                                         hasData++;
1185                                 }
1186                         }
1187
1188                         if (!hasData) {
1189                                 fStruct->top = tn->internal[0];
1190                                 fStruct->topLevel--;
1191                                 yaffs_FreeTnode(dev, tn);
1192                         } else {
1193                                 done = 1;
1194                         }
1195                 }
1196         }
1197
1198         return YAFFS_OK;
1199 }
1200
1201 /*-------------------- End of File Structure functions.-------------------*/
1202
1203 /* yaffs_CreateFreeObjects creates a bunch more objects and
1204  * adds them to the object free list.
1205  */
1206 static int yaffs_CreateFreeObjects(yaffs_Device * dev, int nObjects)
1207 {
1208         int i;
1209         yaffs_Object *newObjects;
1210         yaffs_ObjectList *list;
1211
1212         if (nObjects < 1)
1213                 return YAFFS_OK;
1214
1215         /* make these things */
1216         newObjects = YMALLOC(nObjects * sizeof(yaffs_Object));
1217
1218         if (!newObjects) {
1219                 T(YAFFS_TRACE_ALLOCATE,
1220                   (TSTR("yaffs: Could not allocate more objects" TENDSTR)));
1221                 return YAFFS_FAIL;
1222         }
1223         
1224         /* Hook them into the free list */
1225         for (i = 0; i < nObjects - 1; i++) {
1226                 newObjects[i].siblings.next =
1227                     (struct list_head *)(&newObjects[i + 1]);
1228         }
1229
1230         newObjects[nObjects - 1].siblings.next = (void *)dev->freeObjects;
1231         dev->freeObjects = newObjects;
1232         dev->nFreeObjects += nObjects;
1233         dev->nObjectsCreated += nObjects;
1234
1235         /* Now add this bunch of Objects to a list for freeing up. */
1236
1237         list = YMALLOC(sizeof(yaffs_ObjectList));
1238         if (!list) {
1239                 T(YAFFS_TRACE_ALLOCATE,
1240                   (TSTR("Could not add objects to management list" TENDSTR)));
1241         } else {
1242                 list->objects = newObjects;
1243                 list->next = dev->allocatedObjectList;
1244                 dev->allocatedObjectList = list;
1245         }
1246
1247         return YAFFS_OK;
1248 }
1249
1250
1251 /* AllocateEmptyObject gets us a clean Object. Tries to make allocate more if we run out */
1252 static yaffs_Object *yaffs_AllocateEmptyObject(yaffs_Device * dev)
1253 {
1254         yaffs_Object *tn = NULL;
1255
1256         /* If there are none left make more */
1257         if (!dev->freeObjects) {
1258                 yaffs_CreateFreeObjects(dev, YAFFS_ALLOCATION_NOBJECTS);
1259         }
1260
1261         if (dev->freeObjects) {
1262                 tn = dev->freeObjects;
1263                 dev->freeObjects =
1264                     (yaffs_Object *) (dev->freeObjects->siblings.next);
1265                 dev->nFreeObjects--;
1266
1267                 /* Now sweeten it up... */
1268
1269                 memset(tn, 0, sizeof(yaffs_Object));
1270                 tn->myDev = dev;
1271                 tn->chunkId = -1;
1272                 tn->variantType = YAFFS_OBJECT_TYPE_UNKNOWN;
1273                 INIT_LIST_HEAD(&(tn->hardLinks));
1274                 INIT_LIST_HEAD(&(tn->hashLink));
1275                 INIT_LIST_HEAD(&tn->siblings);
1276
1277                 /* Add it to the lost and found directory.
1278                  * NB Can't put root or lostNFound in lostNFound so
1279                  * check if lostNFound exists first
1280                  */
1281                 if (dev->lostNFoundDir) {
1282                         yaffs_AddObjectToDirectory(dev->lostNFoundDir, tn);
1283                 }
1284         }
1285
1286         return tn;
1287 }
1288
1289 static yaffs_Object *yaffs_CreateFakeDirectory(yaffs_Device * dev, int number,
1290                                                __u32 mode)
1291 {
1292
1293         yaffs_Object *obj =
1294             yaffs_CreateNewObject(dev, number, YAFFS_OBJECT_TYPE_DIRECTORY);
1295         if (obj) {
1296                 obj->fake = 1;          /* it is fake so it has no NAND presence... */
1297                 obj->renameAllowed = 0; /* ... and we're not allowed to rename it... */
1298                 obj->unlinkAllowed = 0; /* ... or unlink it */
1299                 obj->deleted = 0;
1300                 obj->unlinked = 0;
1301                 obj->yst_mode = mode;
1302                 obj->myDev = dev;
1303                 obj->chunkId = 0;       /* Not a valid chunk. */
1304         }
1305
1306         return obj;
1307
1308 }
1309
1310 static void yaffs_UnhashObject(yaffs_Object * tn)
1311 {
1312         int bucket;
1313         yaffs_Device *dev = tn->myDev;
1314
1315         /* If it is still linked into the bucket list, free from the list */
1316         if (!list_empty(&tn->hashLink)) {
1317                 list_del_init(&tn->hashLink);
1318                 bucket = yaffs_HashFunction(tn->objectId);
1319                 dev->objectBucket[bucket].count--;
1320         }
1321
1322 }
1323
1324 /*  FreeObject frees up a Object and puts it back on the free list */
1325 static void yaffs_FreeObject(yaffs_Object * tn)
1326 {
1327
1328         yaffs_Device *dev = tn->myDev;
1329
1330 #ifdef  __KERNEL__
1331         if (tn->myInode) {
1332                 /* We're still hooked up to a cached inode.
1333                  * Don't delete now, but mark for later deletion
1334                  */
1335                 tn->deferedFree = 1;
1336                 return;
1337         }
1338 #endif
1339
1340         yaffs_UnhashObject(tn);
1341
1342         /* Link into the free list. */
1343         tn->siblings.next = (struct list_head *)(dev->freeObjects);
1344         dev->freeObjects = tn;
1345         dev->nFreeObjects++;
1346 }
1347
1348 #ifdef __KERNEL__
1349
1350 void yaffs_HandleDeferedFree(yaffs_Object * obj)
1351 {
1352         if (obj->deferedFree) {
1353                 yaffs_FreeObject(obj);
1354         }
1355 }
1356
1357 #endif
1358
1359 static void yaffs_DeinitialiseObjects(yaffs_Device * dev)
1360 {
1361         /* Free the list of allocated Objects */
1362
1363         yaffs_ObjectList *tmp;
1364
1365         while (dev->allocatedObjectList) {
1366                 tmp = dev->allocatedObjectList->next;
1367                 YFREE(dev->allocatedObjectList->objects);
1368                 YFREE(dev->allocatedObjectList);
1369
1370                 dev->allocatedObjectList = tmp;
1371         }
1372
1373         dev->freeObjects = NULL;
1374         dev->nFreeObjects = 0;
1375 }
1376
1377 static void yaffs_InitialiseObjects(yaffs_Device * dev)
1378 {
1379         int i;
1380
1381         dev->allocatedObjectList = NULL;
1382         dev->freeObjects = NULL;
1383         dev->nFreeObjects = 0;
1384
1385         for (i = 0; i < YAFFS_NOBJECT_BUCKETS; i++) {
1386                 INIT_LIST_HEAD(&dev->objectBucket[i].list);
1387                 dev->objectBucket[i].count = 0;
1388         }
1389
1390 }
1391
1392 static int yaffs_FindNiceObjectBucket(yaffs_Device * dev)
1393 {
1394         static int x = 0;
1395         int i;
1396         int l = 999;
1397         int lowest = 999999;
1398
1399         /* First let's see if we can find one that's empty. */
1400
1401         for (i = 0; i < 10 && lowest > 0; i++) {
1402                 x++;
1403                 x %= YAFFS_NOBJECT_BUCKETS;
1404                 if (dev->objectBucket[x].count < lowest) {
1405                         lowest = dev->objectBucket[x].count;
1406                         l = x;
1407                 }
1408
1409         }
1410
1411         /* If we didn't find an empty list, then try
1412          * looking a bit further for a short one
1413          */
1414
1415         for (i = 0; i < 10 && lowest > 3; i++) {
1416                 x++;
1417                 x %= YAFFS_NOBJECT_BUCKETS;
1418                 if (dev->objectBucket[x].count < lowest) {
1419                         lowest = dev->objectBucket[x].count;
1420                         l = x;
1421                 }
1422
1423         }
1424
1425         return l;
1426 }
1427
1428 static int yaffs_CreateNewObjectNumber(yaffs_Device * dev)
1429 {
1430         int bucket = yaffs_FindNiceObjectBucket(dev);
1431
1432         /* Now find an object value that has not already been taken
1433          * by scanning the list.
1434          */
1435
1436         int found = 0;
1437         struct list_head *i;
1438
1439         __u32 n = (__u32) bucket;
1440
1441         /* yaffs_CheckObjectHashSanity();  */
1442
1443         while (!found) {
1444                 found = 1;
1445                 n += YAFFS_NOBJECT_BUCKETS;
1446                 if (1 || dev->objectBucket[bucket].count > 0) {
1447                         list_for_each(i, &dev->objectBucket[bucket].list) {
1448                                 /* If there is already one in the list */
1449                                 if (i
1450                                     && list_entry(i, yaffs_Object,
1451                                                   hashLink)->objectId == n) {
1452                                         found = 0;
1453                                 }
1454                         }
1455                 }
1456         }
1457
1458
1459         return n;
1460 }
1461
1462 static void yaffs_HashObject(yaffs_Object * in)
1463 {
1464         int bucket = yaffs_HashFunction(in->objectId);
1465         yaffs_Device *dev = in->myDev;
1466
1467         list_add(&in->hashLink, &dev->objectBucket[bucket].list);
1468         dev->objectBucket[bucket].count++;
1469
1470 }
1471
1472 yaffs_Object *yaffs_FindObjectByNumber(yaffs_Device * dev, __u32 number)
1473 {
1474         int bucket = yaffs_HashFunction(number);
1475         struct list_head *i;
1476         yaffs_Object *in;
1477
1478         list_for_each(i, &dev->objectBucket[bucket].list) {
1479                 /* Look if it is in the list */
1480                 if (i) {
1481                         in = list_entry(i, yaffs_Object, hashLink);
1482                         if (in->objectId == number) {
1483 #ifdef __KERNEL__
1484                                 /* Don't tell the VFS about this one if it is defered free */
1485                                 if (in->deferedFree)
1486                                         return NULL;
1487 #endif
1488
1489                                 return in;
1490                         }
1491                 }
1492         }
1493
1494         return NULL;
1495 }
1496
1497 yaffs_Object *yaffs_CreateNewObject(yaffs_Device * dev, int number,
1498                                     yaffs_ObjectType type)
1499 {
1500
1501         yaffs_Object *theObject;
1502
1503         if (number < 0) {
1504                 number = yaffs_CreateNewObjectNumber(dev);
1505         }
1506
1507         theObject = yaffs_AllocateEmptyObject(dev);
1508
1509         if (theObject) {
1510                 theObject->fake = 0;
1511                 theObject->renameAllowed = 1;
1512                 theObject->unlinkAllowed = 1;
1513                 theObject->objectId = number;
1514                 yaffs_HashObject(theObject);
1515                 theObject->variantType = type;
1516 #ifdef CONFIG_YAFFS_WINCE
1517                 yfsd_WinFileTimeNow(theObject->win_atime);
1518                 theObject->win_ctime[0] = theObject->win_mtime[0] =
1519                     theObject->win_atime[0];
1520                 theObject->win_ctime[1] = theObject->win_mtime[1] =
1521                     theObject->win_atime[1];
1522
1523 #else
1524
1525                 theObject->yst_atime = theObject->yst_mtime =
1526                     theObject->yst_ctime = Y_CURRENT_TIME;
1527 #endif
1528                 switch (type) {
1529                 case YAFFS_OBJECT_TYPE_FILE:
1530                         theObject->variant.fileVariant.fileSize = 0;
1531                         theObject->variant.fileVariant.scannedFileSize = 0;
1532                         theObject->variant.fileVariant.shrinkSize = 0xFFFFFFFF; /* max __u32 */
1533                         theObject->variant.fileVariant.topLevel = 0;
1534                         theObject->variant.fileVariant.top =
1535                             yaffs_GetTnode(dev);
1536                         break;
1537                 case YAFFS_OBJECT_TYPE_DIRECTORY:
1538                         INIT_LIST_HEAD(&theObject->variant.directoryVariant.
1539                                        children);
1540                         break;
1541                 case YAFFS_OBJECT_TYPE_SYMLINK:
1542                 case YAFFS_OBJECT_TYPE_HARDLINK:
1543                 case YAFFS_OBJECT_TYPE_SPECIAL:
1544                         /* No action required */
1545                         break;
1546                 case YAFFS_OBJECT_TYPE_UNKNOWN:
1547                         /* todo this should not happen */
1548                         break;
1549                 }
1550         }
1551
1552         return theObject;
1553 }
1554
1555 static yaffs_Object *yaffs_FindOrCreateObjectByNumber(yaffs_Device * dev,
1556                                                       int number,
1557                                                       yaffs_ObjectType type)
1558 {
1559         yaffs_Object *theObject = NULL;
1560
1561         if (number > 0) {
1562                 theObject = yaffs_FindObjectByNumber(dev, number);
1563         }
1564
1565         if (!theObject) {
1566                 theObject = yaffs_CreateNewObject(dev, number, type);
1567         }
1568
1569         return theObject;
1570
1571 }
1572
1573 static YCHAR *yaffs_CloneString(const YCHAR * str)
1574 {
1575         YCHAR *newStr = NULL;
1576
1577         if (str && *str) {
1578                 newStr = YMALLOC((yaffs_strlen(str) + 1) * sizeof(YCHAR));
1579                 yaffs_strcpy(newStr, str);
1580         }
1581
1582         return newStr;
1583
1584 }
1585
1586 /*
1587  * Mknod (create) a new object.
1588  * equivalentObject only has meaning for a hard link;
1589  * aliasString only has meaning for a sumlink.
1590  * rdev only has meaning for devices (a subset of special objects)
1591  */
1592  
1593 static yaffs_Object *yaffs_MknodObject(yaffs_ObjectType type,
1594                                        yaffs_Object * parent,
1595                                        const YCHAR * name,
1596                                        __u32 mode,
1597                                        __u32 uid,
1598                                        __u32 gid,
1599                                        yaffs_Object * equivalentObject,
1600                                        const YCHAR * aliasString, __u32 rdev)
1601 {
1602         yaffs_Object *in;
1603
1604         yaffs_Device *dev = parent->myDev;
1605
1606         /* Check if the entry exists. If it does then fail the call since we don't want a dup.*/
1607         if (yaffs_FindObjectByName(parent, name)) {
1608                 return NULL;
1609         }
1610
1611         in = yaffs_CreateNewObject(dev, -1, type);
1612
1613         if (in) {
1614                 in->chunkId = -1;
1615                 in->valid = 1;
1616                 in->variantType = type;
1617
1618                 in->yst_mode = mode;
1619
1620 #ifdef CONFIG_YAFFS_WINCE
1621                 yfsd_WinFileTimeNow(in->win_atime);
1622                 in->win_ctime[0] = in->win_mtime[0] = in->win_atime[0];
1623                 in->win_ctime[1] = in->win_mtime[1] = in->win_atime[1];
1624
1625 #else
1626                 in->yst_atime = in->yst_mtime = in->yst_ctime = Y_CURRENT_TIME;
1627
1628                 in->yst_rdev = rdev;
1629                 in->yst_uid = uid;
1630                 in->yst_gid = gid;
1631 #endif
1632                 in->nDataChunks = 0;
1633
1634                 yaffs_SetObjectName(in, name);
1635                 in->dirty = 1;
1636
1637                 yaffs_AddObjectToDirectory(parent, in);
1638
1639                 in->myDev = parent->myDev;
1640
1641                 switch (type) {
1642                 case YAFFS_OBJECT_TYPE_SYMLINK:
1643                         in->variant.symLinkVariant.alias =
1644                             yaffs_CloneString(aliasString);
1645                         break;
1646                 case YAFFS_OBJECT_TYPE_HARDLINK:
1647                         in->variant.hardLinkVariant.equivalentObject =
1648                             equivalentObject;
1649                         in->variant.hardLinkVariant.equivalentObjectId =
1650                             equivalentObject->objectId;
1651                         list_add(&in->hardLinks, &equivalentObject->hardLinks);
1652                         break;
1653                 case YAFFS_OBJECT_TYPE_FILE:    
1654                 case YAFFS_OBJECT_TYPE_DIRECTORY:
1655                 case YAFFS_OBJECT_TYPE_SPECIAL:
1656                 case YAFFS_OBJECT_TYPE_UNKNOWN:
1657                         /* do nothing */
1658                         break;
1659                 }
1660
1661                 if (yaffs_UpdateObjectHeader(in, name, 0, 0, 0) < 0) {
1662                         /* Could not create the object header, fail the creation */
1663                         yaffs_DestroyObject(in);
1664                         in = NULL;
1665                 }
1666
1667         }
1668
1669         return in;
1670 }
1671
1672 yaffs_Object *yaffs_MknodFile(yaffs_Object * parent, const YCHAR * name,
1673                               __u32 mode, __u32 uid, __u32 gid)
1674 {
1675         return yaffs_MknodObject(YAFFS_OBJECT_TYPE_FILE, parent, name, mode,
1676                                  uid, gid, NULL, NULL, 0);
1677 }
1678
1679 yaffs_Object *yaffs_MknodDirectory(yaffs_Object * parent, const YCHAR * name,
1680                                    __u32 mode, __u32 uid, __u32 gid)
1681 {
1682         return yaffs_MknodObject(YAFFS_OBJECT_TYPE_DIRECTORY, parent, name,
1683                                  mode, uid, gid, NULL, NULL, 0);
1684 }
1685
1686 yaffs_Object *yaffs_MknodSpecial(yaffs_Object * parent, const YCHAR * name,
1687                                  __u32 mode, __u32 uid, __u32 gid, __u32 rdev)
1688 {
1689         return yaffs_MknodObject(YAFFS_OBJECT_TYPE_SPECIAL, parent, name, mode,
1690                                  uid, gid, NULL, NULL, rdev);
1691 }
1692
1693 yaffs_Object *yaffs_MknodSymLink(yaffs_Object * parent, const YCHAR * name,
1694                                  __u32 mode, __u32 uid, __u32 gid,
1695                                  const YCHAR * alias)
1696 {
1697         return yaffs_MknodObject(YAFFS_OBJECT_TYPE_SYMLINK, parent, name, mode,
1698                                  uid, gid, NULL, alias, 0);
1699 }
1700
1701 /* yaffs_Link returns the object id of the equivalent object.*/
1702 yaffs_Object *yaffs_Link(yaffs_Object * parent, const YCHAR * name,
1703                          yaffs_Object * equivalentObject)
1704 {
1705         /* Get the real object in case we were fed a hard link as an equivalent object */
1706         equivalentObject = yaffs_GetEquivalentObject(equivalentObject);
1707
1708         if (yaffs_MknodObject
1709             (YAFFS_OBJECT_TYPE_HARDLINK, parent, name, 0, 0, 0,
1710              equivalentObject, NULL, 0)) {
1711                 return equivalentObject;
1712         } else {
1713                 return NULL;
1714         }
1715
1716 }
1717
1718 static int yaffs_ChangeObjectName(yaffs_Object * obj, yaffs_Object * newDir,
1719                                   const YCHAR * newName, int force, int shadows)
1720 {
1721         int unlinkOp;
1722         int deleteOp;
1723
1724         yaffs_Object *existingTarget;
1725
1726         if (newDir == NULL) {
1727                 newDir = obj->parent;   /* use the old directory */
1728         }
1729
1730         if (newDir->variantType != YAFFS_OBJECT_TYPE_DIRECTORY) {
1731                 T(YAFFS_TRACE_ALWAYS,
1732                   (TSTR
1733                    ("tragendy: yaffs_ChangeObjectName: newDir is not a directory"
1734                     TENDSTR)));
1735                 YBUG();
1736         }
1737         
1738         /* TODO: Do we need this different handling for YAFFS2 and YAFFS1?? */
1739         if (obj->myDev->isYaffs2) {
1740                 unlinkOp = (newDir == obj->myDev->unlinkedDir);
1741         } else {
1742                 unlinkOp = (newDir == obj->myDev->unlinkedDir
1743                             && obj->variantType == YAFFS_OBJECT_TYPE_FILE);
1744         }
1745
1746         deleteOp = (newDir == obj->myDev->deletedDir);
1747
1748         existingTarget = yaffs_FindObjectByName(newDir, newName);
1749
1750         /* If the object is a file going into the unlinked directory, 
1751          *   then it is OK to just stuff it in since duplicate names are allowed.
1752          *   else only proceed if the new name does not exist and if we're putting 
1753          *   it into a directory.
1754          */
1755         if ((unlinkOp ||
1756              deleteOp ||
1757              force ||
1758              (shadows > 0) ||
1759              !existingTarget) &&
1760             newDir->variantType == YAFFS_OBJECT_TYPE_DIRECTORY) {
1761                 yaffs_SetObjectName(obj, newName);
1762                 obj->dirty = 1;
1763
1764                 yaffs_AddObjectToDirectory(newDir, obj);
1765
1766                 if (unlinkOp)
1767                         obj->unlinked = 1;
1768
1769                 /* If it is a deletion then we mark it as a shrink for gc purposes. */
1770                 if (yaffs_UpdateObjectHeader(obj, newName, 0, deleteOp, shadows)>= 0)
1771                         return YAFFS_OK;
1772         }
1773
1774         return YAFFS_FAIL;
1775 }
1776
1777 int yaffs_RenameObject(yaffs_Object * oldDir, const YCHAR * oldName,
1778                        yaffs_Object * newDir, const YCHAR * newName)
1779 {
1780         yaffs_Object *obj;
1781         yaffs_Object *existingTarget;
1782         int force = 0;
1783
1784 #ifdef CONFIG_YAFFS_CASE_INSENSITIVE
1785         /* Special case for case insemsitive systems (eg. WinCE).
1786          * While look-up is case insensitive, the name isn't.
1787          * Therefore we might want to change x.txt to X.txt
1788         */
1789         if (oldDir == newDir && yaffs_strcmp(oldName, newName) == 0) {
1790                 force = 1;
1791         }
1792 #endif
1793
1794         obj = yaffs_FindObjectByName(oldDir, oldName);
1795
1796         if (obj && obj->renameAllowed) {
1797
1798                 /* Now do the handling for an existing target, if there is one */
1799
1800                 existingTarget = yaffs_FindObjectByName(newDir, newName);
1801                 if (existingTarget &&
1802                     existingTarget->variantType == YAFFS_OBJECT_TYPE_DIRECTORY &&
1803                     !list_empty(&existingTarget->variant.directoryVariant.children)) {
1804                         /* There is a target that is a non-empty directory, so we fail */
1805                         return YAFFS_FAIL;      /* EEXIST or ENOTEMPTY */
1806                 } else if (existingTarget && existingTarget != obj) {
1807                         /* Nuke the target first, using shadowing, 
1808                          * but only if it isn't the same object
1809                          */
1810                         yaffs_ChangeObjectName(obj, newDir, newName, force,
1811                                                existingTarget->objectId);
1812                         yaffs_UnlinkObject(existingTarget);
1813                 }
1814
1815                 return yaffs_ChangeObjectName(obj, newDir, newName, 1, 0);
1816         }
1817         return YAFFS_FAIL;
1818 }
1819
1820 /*------------------------- Block Management and Page Allocation ----------------*/
1821
1822 static int yaffs_InitialiseBlocks(yaffs_Device * dev, int nBlocks)
1823 {
1824         dev->allocationBlock = -1;      /* force it to get a new one */
1825
1826         /* Todo we're assuming the malloc will pass. */
1827         dev->blockInfo = YMALLOC(nBlocks * sizeof(yaffs_BlockInfo));
1828         if(!dev->blockInfo){
1829                 dev->blockInfo = YMALLOC_ALT(nBlocks * sizeof(yaffs_BlockInfo));
1830                 dev->blockInfoAlt = 1;
1831         }
1832         else
1833                 dev->blockInfoAlt = 0;
1834         
1835         /* Set up dynamic blockinfo stuff. */
1836         dev->chunkBitmapStride = (dev->nChunksPerBlock + 7) / 8;
1837         dev->chunkBits = YMALLOC(dev->chunkBitmapStride * nBlocks);
1838         if(!dev->chunkBits){
1839                 dev->chunkBits = YMALLOC_ALT(dev->chunkBitmapStride * nBlocks);
1840                 dev->chunkBitsAlt = 1;
1841         }
1842         else
1843                 dev->chunkBitsAlt = 0;
1844         
1845         if (dev->blockInfo && dev->chunkBits) {
1846                 memset(dev->blockInfo, 0, nBlocks * sizeof(yaffs_BlockInfo));
1847                 memset(dev->chunkBits, 0, dev->chunkBitmapStride * nBlocks);
1848                 return YAFFS_OK;
1849         }
1850
1851         return YAFFS_FAIL;
1852
1853 }
1854
1855 static void yaffs_DeinitialiseBlocks(yaffs_Device * dev)
1856 {
1857         if(dev->blockInfoAlt)
1858                 YFREE_ALT(dev->blockInfo);
1859         else
1860                 YFREE(dev->blockInfo);
1861         dev->blockInfoAlt = 0;
1862
1863         dev->blockInfo = NULL;
1864         
1865         if(dev->chunkBitsAlt)
1866                 YFREE_ALT(dev->chunkBits);
1867         else
1868                 YFREE(dev->chunkBits);
1869         dev->chunkBitsAlt = 0;
1870         dev->chunkBits = NULL;
1871 }
1872
1873 static int yaffs_BlockNotDisqualifiedFromGC(yaffs_Device * dev,
1874                                             yaffs_BlockInfo * bi)
1875 {
1876         int i;
1877         __u32 seq;
1878         yaffs_BlockInfo *b;
1879
1880         if (!dev->isYaffs2)
1881                 return 1;       /* disqualification only applies to yaffs2. */
1882
1883         if (!bi->hasShrinkHeader)
1884                 return 1;       /* can gc */
1885
1886         /* Find the oldest dirty sequence number if we don't know it and save it
1887          * so we don't have to keep recomputing it.
1888          */
1889         if (!dev->oldestDirtySequence) {
1890                 seq = dev->sequenceNumber;
1891
1892                 for (i = dev->internalStartBlock; i <= dev->internalEndBlock;
1893                      i++) {
1894                         b = yaffs_GetBlockInfo(dev, i);
1895                         if (b->blockState == YAFFS_BLOCK_STATE_FULL &&
1896                             (b->pagesInUse - b->softDeletions) <
1897                             dev->nChunksPerBlock && b->sequenceNumber < seq) {
1898                                 seq = b->sequenceNumber;
1899                         }
1900                 }
1901                 dev->oldestDirtySequence = seq;
1902         }
1903
1904         /* Can't do gc of this block if there are any blocks older than this one that have
1905          * discarded pages.
1906          */
1907         return (bi->sequenceNumber <= dev->oldestDirtySequence);
1908
1909         return 1;
1910
1911 }
1912
1913 /* FindDiretiestBlock is used to select the dirtiest block (or close enough)
1914  * for garbage collection.
1915  */
1916
1917 static int yaffs_FindBlockForGarbageCollection(yaffs_Device * dev,
1918                                                int aggressive)
1919 {
1920
1921         int b = dev->currentDirtyChecker;
1922
1923         int i;
1924         int iterations;
1925         int dirtiest = -1;
1926         int pagesInUse;
1927         yaffs_BlockInfo *bi;
1928         static int nonAggressiveSkip = 0;
1929
1930         /* If we're doing aggressive GC then we are happy to take a less-dirty block, and
1931          * search harder.
1932          * else (we're doing a leasurely gc), then we only bother to do this if the
1933          * block has only a few pages in use.
1934          */
1935
1936         nonAggressiveSkip--;
1937
1938         if (!aggressive && (nonAggressiveSkip > 0)) {
1939                 return -1;
1940         }
1941
1942         pagesInUse =
1943             (aggressive) ? dev->nChunksPerBlock : YAFFS_PASSIVE_GC_CHUNKS + 1;
1944
1945         if (aggressive) {
1946                 iterations =
1947                     dev->internalEndBlock - dev->internalStartBlock + 1;
1948         } else {
1949                 iterations =
1950                     dev->internalEndBlock - dev->internalStartBlock + 1;
1951                 iterations = iterations / 16;
1952                 if (iterations > 200) {
1953                         iterations = 200;
1954                 }
1955         }
1956
1957         for (i = 0; i <= iterations && pagesInUse > 0; i++) {
1958                 b++;
1959                 if (b < dev->internalStartBlock || b > dev->internalEndBlock) {
1960                         b = dev->internalStartBlock;
1961                 }
1962
1963                 if (b < dev->internalStartBlock || b > dev->internalEndBlock) {
1964                         T(YAFFS_TRACE_ERROR,
1965                           (TSTR("**>> Block %d is not valid" TENDSTR), b));
1966                         YBUG();
1967                 }
1968
1969                 bi = yaffs_GetBlockInfo(dev, b);
1970
1971                 if (bi->blockState == YAFFS_BLOCK_STATE_FULL &&
1972                     (bi->pagesInUse - bi->softDeletions) < pagesInUse &&
1973                     yaffs_BlockNotDisqualifiedFromGC(dev, bi)) {
1974                         dirtiest = b;
1975                         pagesInUse = (bi->pagesInUse - bi->softDeletions);
1976                 }
1977         }
1978
1979         dev->currentDirtyChecker = b;
1980
1981         if (dirtiest > 0) {
1982                 T(YAFFS_TRACE_GC,
1983                   (TSTR("GC Selected block %d with %d free" TENDSTR), dirtiest,
1984                    dev->nChunksPerBlock - pagesInUse));
1985         }
1986
1987         dev->oldestDirtySequence = 0;
1988
1989         if (dirtiest > 0) {
1990                 nonAggressiveSkip = 4;
1991         }
1992
1993         return dirtiest;
1994 }
1995
1996 static void yaffs_BlockBecameDirty(yaffs_Device * dev, int blockNo)
1997 {
1998         yaffs_BlockInfo *bi = yaffs_GetBlockInfo(dev, blockNo);
1999
2000         int erasedOk = 0;
2001
2002         /* If the block is still healthy erase it and mark as clean.
2003          * If the block has had a data failure, then retire it.
2004          */
2005         bi->blockState = YAFFS_BLOCK_STATE_DIRTY;
2006
2007         if (!bi->needsRetiring) {
2008                 erasedOk = yaffs_EraseBlockInNAND(dev, blockNo);
2009                 if (!erasedOk) {
2010                         dev->nErasureFailures++;
2011                         T(YAFFS_TRACE_ERROR | YAFFS_TRACE_BAD_BLOCKS,
2012                           (TSTR("**>> Erasure failed %d" TENDSTR), blockNo));
2013                 }
2014         }
2015
2016         if (erasedOk && (yaffs_traceMask & YAFFS_TRACE_ERASE)) {
2017                 int i;
2018                 for (i = 0; i < dev->nChunksPerBlock; i++) {
2019                         if (!yaffs_CheckChunkErased
2020                             (dev, blockNo * dev->nChunksPerBlock + i)) {
2021                                 T(YAFFS_TRACE_ERROR,
2022                                   (TSTR
2023                                    (">>Block %d erasure supposedly OK, but chunk %d not erased"
2024                                     TENDSTR), blockNo, i));
2025                         }
2026                 }
2027         }
2028
2029         if (erasedOk) {
2030                 /* Clean it up... */
2031                 bi->blockState = YAFFS_BLOCK_STATE_EMPTY;
2032                 dev->nErasedBlocks++;
2033                 bi->pagesInUse = 0;
2034                 bi->softDeletions = 0;
2035                 bi->hasShrinkHeader = 0;
2036                 yaffs_ClearChunkBits(dev, blockNo);
2037
2038                 T(YAFFS_TRACE_ERASE,
2039                   (TSTR("Erased block %d" TENDSTR), blockNo));
2040         } else {
2041                 dev->nFreeChunks -= dev->nChunksPerBlock;       /* We lost a block of free space */
2042
2043                 yaffs_RetireBlock(dev, blockNo);
2044                 T(YAFFS_TRACE_ERROR | YAFFS_TRACE_BAD_BLOCKS,
2045                   (TSTR("**>> Block %d retired" TENDSTR), blockNo));
2046         }
2047 }
2048
2049 static int yaffs_FindBlockForAllocation(yaffs_Device * dev)
2050 {
2051         int i;
2052
2053         yaffs_BlockInfo *bi;
2054
2055         if (dev->nErasedBlocks < 1) {
2056                 /* Hoosterman we've got a problem.
2057                  * Can't get space to gc
2058                  */
2059                 T(YAFFS_TRACE_ERROR,
2060                   (TSTR("yaffs tragedy: no more eraased blocks" TENDSTR)));
2061
2062                 return -1;
2063         }
2064         
2065         /* Find an empty block. */
2066
2067         for (i = dev->internalStartBlock; i <= dev->internalEndBlock; i++) {
2068                 dev->allocationBlockFinder++;
2069                 if (dev->allocationBlockFinder < dev->internalStartBlock
2070                     || dev->allocationBlockFinder > dev->internalEndBlock) {
2071                         dev->allocationBlockFinder = dev->internalStartBlock;
2072                 }
2073
2074                 bi = yaffs_GetBlockInfo(dev, dev->allocationBlockFinder);
2075
2076                 if (bi->blockState == YAFFS_BLOCK_STATE_EMPTY) {
2077                         bi->blockState = YAFFS_BLOCK_STATE_ALLOCATING;
2078                         dev->sequenceNumber++;
2079                         bi->sequenceNumber = dev->sequenceNumber;
2080                         dev->nErasedBlocks--;
2081                         T(YAFFS_TRACE_ALLOCATE,
2082                           (TSTR("Allocated block %d, seq  %d, %d left" TENDSTR),
2083                            dev->allocationBlockFinder, dev->sequenceNumber,
2084                            dev->nErasedBlocks));
2085                         return dev->allocationBlockFinder;
2086                 }
2087         }
2088
2089         T(YAFFS_TRACE_ALWAYS,
2090           (TSTR
2091            ("yaffs tragedy: no more eraased blocks, but there should have been %d"
2092             TENDSTR), dev->nErasedBlocks));
2093
2094         return -1;
2095 }
2096
2097
2098
2099 static int yaffs_CheckSpaceForAllocation(yaffs_Device * dev)
2100 {
2101         int reservedChunks = (dev->nReservedBlocks * dev->nChunksPerBlock);
2102         return (dev->nFreeChunks > reservedChunks);
2103 }
2104
2105 static int yaffs_AllocateChunk(yaffs_Device * dev, int useReserve)
2106 {
2107         int retVal;
2108         yaffs_BlockInfo *bi;
2109
2110         if (dev->allocationBlock < 0) {
2111                 /* Get next block to allocate off */
2112                 dev->allocationBlock = yaffs_FindBlockForAllocation(dev);
2113                 dev->allocationPage = 0;
2114         }
2115
2116         if (!useReserve && !yaffs_CheckSpaceForAllocation(dev)) {
2117                 /* Not enough space to allocate unless we're allowed to use the reserve. */
2118                 return -1;
2119         }
2120
2121         if (dev->nErasedBlocks < dev->nReservedBlocks
2122             && dev->allocationPage == 0) {
2123                 T(YAFFS_TRACE_ALLOCATE, (TSTR("Allocating reserve" TENDSTR)));
2124         }
2125
2126         /* Next page please.... */
2127         if (dev->allocationBlock >= 0) {
2128                 bi = yaffs_GetBlockInfo(dev, dev->allocationBlock);
2129
2130                 retVal = (dev->allocationBlock * dev->nChunksPerBlock) +
2131                     dev->allocationPage;
2132                 bi->pagesInUse++;
2133                 yaffs_SetChunkBit(dev, dev->allocationBlock,
2134                                   dev->allocationPage);
2135
2136                 dev->allocationPage++;
2137
2138                 dev->nFreeChunks--;
2139
2140                 /* If the block is full set the state to full */
2141                 if (dev->allocationPage >= dev->nChunksPerBlock) {
2142                         bi->blockState = YAFFS_BLOCK_STATE_FULL;
2143                         dev->allocationBlock = -1;
2144                 }
2145
2146                 return retVal;
2147         }
2148         
2149         T(YAFFS_TRACE_ERROR,
2150           (TSTR("!!!!!!!!! Allocator out !!!!!!!!!!!!!!!!!" TENDSTR)));
2151
2152         return -1;
2153 }
2154
2155 static int yaffs_GetErasedChunks(yaffs_Device * dev)
2156 {
2157         int n;
2158
2159         n = dev->nErasedBlocks * dev->nChunksPerBlock;
2160
2161         if (dev->allocationBlock > 0) {
2162                 n += (dev->nChunksPerBlock - dev->allocationPage);
2163         }
2164
2165         return n;
2166
2167 }
2168
2169 static int yaffs_GarbageCollectBlock(yaffs_Device * dev, int block)
2170 {
2171         int oldChunk;
2172         int newChunk;
2173         int chunkInBlock;
2174         int markNAND;
2175         int retVal = YAFFS_OK;
2176         int cleanups = 0;
2177         int i;
2178
2179         int chunksBefore = yaffs_GetErasedChunks(dev);
2180         int chunksAfter;
2181
2182         yaffs_ExtendedTags tags;
2183
2184         yaffs_BlockInfo *bi = yaffs_GetBlockInfo(dev, block);
2185
2186         yaffs_Object *object;
2187
2188         bi->blockState = YAFFS_BLOCK_STATE_COLLECTING;
2189
2190         T(YAFFS_TRACE_TRACING,
2191           (TSTR("Collecting block %d, in use %d, shrink %d, " TENDSTR), block,
2192            bi->pagesInUse, bi->hasShrinkHeader));
2193
2194         /*yaffs_VerifyFreeChunks(dev); */
2195
2196         bi->hasShrinkHeader = 0;        /* clear the flag so that the block can erase */
2197
2198         /* Take off the number of soft deleted entries because
2199          * they're going to get really deleted during GC.
2200          */
2201         dev->nFreeChunks -= bi->softDeletions;
2202
2203         dev->isDoingGC = 1;
2204
2205         if (!yaffs_StillSomeChunkBits(dev, block)) {
2206                 T(YAFFS_TRACE_TRACING,
2207                   (TSTR
2208                    ("Collecting block %d that has no chunks in use" TENDSTR),
2209                    block));
2210                 yaffs_BlockBecameDirty(dev, block);
2211         } else {
2212
2213                 __u8 *buffer = yaffs_GetTempBuffer(dev, __LINE__);
2214
2215                 for (chunkInBlock = 0, oldChunk = block * dev->nChunksPerBlock;
2216                      chunkInBlock < dev->nChunksPerBlock
2217                      && yaffs_StillSomeChunkBits(dev, block);
2218                      chunkInBlock++, oldChunk++) {
2219                         if (yaffs_CheckChunkBit(dev, block, chunkInBlock)) {
2220
2221                                 /* This page is in use and might need to be copied off */
2222
2223                                 markNAND = 1;
2224
2225                                 yaffs_InitialiseTags(&tags);
2226
2227                                 yaffs_ReadChunkWithTagsFromNAND(dev, oldChunk,
2228                                                                 buffer, &tags);
2229
2230                                 object =
2231                                     yaffs_FindObjectByNumber(dev,
2232                                                              tags.objectId);
2233
2234                                 T(YAFFS_TRACE_GC_DETAIL,
2235                                   (TSTR
2236                                    ("Collecting page %d, %d %d %d " TENDSTR),
2237                                    chunkInBlock, tags.objectId, tags.chunkId,
2238                                    tags.byteCount));
2239
2240                                 if (!object) {
2241                                         T(YAFFS_TRACE_ERROR,
2242                                           (TSTR
2243                                            ("page %d in gc has no object "
2244                                             TENDSTR), oldChunk));
2245                                 }
2246
2247                                 if (object && object->deleted
2248                                     && tags.chunkId != 0) {
2249                                         /* Data chunk in a deleted file, throw it away
2250                                          * It's a soft deleted data chunk,
2251                                          * No need to copy this, just forget about it and 
2252                                          * fix up the object.
2253                                          */
2254
2255                                         object->nDataChunks--;
2256
2257                                         if (object->nDataChunks <= 0) {
2258                                                 /* remeber to clean up the object */
2259                                                 dev->gcCleanupList[cleanups] =
2260                                                     tags.objectId;
2261                                                 cleanups++;
2262                                         }
2263                                         markNAND = 0;
2264                                 } else if (0
2265                                            /* Todo object && object->deleted && object->nDataChunks == 0 */
2266                                            ) {
2267                                         /* Deleted object header with no data chunks.
2268                                          * Can be discarded and the file deleted.
2269                                          */
2270                                         object->chunkId = 0;
2271                                         yaffs_FreeTnode(object->myDev,
2272                                                         object->variant.
2273                                                         fileVariant.top);
2274                                         object->variant.fileVariant.top = NULL;
2275                                         yaffs_DoGenericObjectDeletion(object);
2276
2277                                 } else if (object) {
2278                                         /* It's either a data chunk in a live file or
2279                                          * an ObjectHeader, so we're interested in it.
2280                                          * NB Need to keep the ObjectHeaders of deleted files
2281                                          * until the whole file has been deleted off
2282                                          */
2283                                         tags.serialNumber++;
2284
2285                                         dev->nGCCopies++;
2286
2287                                         if (tags.chunkId == 0) {
2288                                                 /* It is an object Id,
2289                                                  * We need to nuke the shrinkheader flags first
2290                                                  * We no longer want the shrinkHeader flag since its work is done
2291                                                  * and if it is left in place it will mess up scanning.
2292                                                  * Also, clear out any shadowing stuff
2293                                                  */
2294
2295                                                 yaffs_ObjectHeader *oh;
2296                                                 oh = (yaffs_ObjectHeader *)buffer;
2297                                                 oh->isShrink = 0;
2298                                                 oh->shadowsObject = -1;
2299                                                 tags.extraShadows = 0;
2300                                                 tags.extraIsShrinkHeader = 0;
2301                                         }
2302
2303                                         newChunk =
2304                                             yaffs_WriteNewChunkWithTagsToNAND(dev, buffer, &tags, 1);
2305
2306                                         if (newChunk < 0) {
2307                                                 retVal = YAFFS_FAIL;
2308                                         } else {
2309
2310                                                 /* Ok, now fix up the Tnodes etc. */
2311
2312                                                 if (tags.chunkId == 0) {
2313                                                         /* It's a header */
2314                                                         object->chunkId =  newChunk;
2315                                                         object->serial =   tags.serialNumber;
2316                                                 } else {
2317                                                         /* It's a data chunk */
2318                                                         yaffs_PutChunkIntoFile
2319                                                             (object,
2320                                                              tags.chunkId,
2321                                                              newChunk, 0);
2322                                                 }
2323                                         }
2324                                 }
2325
2326                                 yaffs_DeleteChunk(dev, oldChunk, markNAND, __LINE__);
2327
2328                         }
2329                 }
2330
2331                 yaffs_ReleaseTempBuffer(dev, buffer, __LINE__);
2332
2333
2334                 /* Do any required cleanups */
2335                 for (i = 0; i < cleanups; i++) {
2336                         /* Time to delete the file too */
2337                         object =
2338                             yaffs_FindObjectByNumber(dev,
2339                                                      dev->gcCleanupList[i]);
2340                         if (object) {
2341                                 yaffs_FreeTnode(dev,
2342                                                 object->variant.fileVariant.
2343                                                 top);
2344                                 object->variant.fileVariant.top = NULL;
2345                                 T(YAFFS_TRACE_GC,
2346                                   (TSTR
2347                                    ("yaffs: About to finally delete object %d"
2348                                     TENDSTR), object->objectId));
2349                                 yaffs_DoGenericObjectDeletion(object);
2350                         }
2351
2352                 }
2353
2354         }
2355
2356         if (chunksBefore >= (chunksAfter = yaffs_GetErasedChunks(dev))) {
2357                 T(YAFFS_TRACE_GC,
2358                   (TSTR
2359                    ("gc did not increase free chunks before %d after %d"
2360                     TENDSTR), chunksBefore, chunksAfter));
2361         }
2362
2363         dev->isDoingGC = 0;
2364
2365         return YAFFS_OK;
2366 }
2367
2368 /* New garbage collector
2369  * If we're very low on erased blocks then we do aggressive garbage collection
2370  * otherwise we do "leasurely" garbage collection.
2371  * Aggressive gc looks further (whole array) and will accept less dirty blocks.
2372  * Passive gc only inspects smaller areas and will only accept more dirty blocks.
2373  *
2374  * The idea is to help clear out space in a more spread-out manner.
2375  * Dunno if it really does anything useful.
2376  */
2377 static int yaffs_CheckGarbageCollection(yaffs_Device * dev)
2378 {
2379         int block;
2380         int aggressive;
2381         int gcOk = YAFFS_OK;
2382         int maxTries = 0;
2383
2384         if (dev->isDoingGC) {
2385                 /* Bail out so we don't get recursive gc */
2386                 return YAFFS_OK;
2387         }
2388         
2389         /* This loop should pass the first time.
2390          * We'll only see looping here if the erase of the collected block fails.
2391          */
2392
2393         do {
2394                 maxTries++;
2395                 if (dev->nErasedBlocks < dev->nReservedBlocks) {
2396                         /* We need a block soon...*/
2397                         aggressive = 1;
2398                 } else {
2399                         /* We're in no hurry */
2400                         aggressive = 0;
2401                 }
2402
2403                 block = yaffs_FindBlockForGarbageCollection(dev, aggressive);
2404
2405                 if (block > 0) {
2406                         dev->garbageCollections++;
2407                         if (!aggressive) {
2408                                 dev->passiveGarbageCollections++;
2409                         }
2410
2411                         T(YAFFS_TRACE_GC,
2412                           (TSTR
2413                            ("yaffs: GC erasedBlocks %d aggressive %d" TENDSTR),
2414                            dev->nErasedBlocks, aggressive));
2415
2416                         gcOk = yaffs_GarbageCollectBlock(dev, block);
2417                 }
2418
2419                 if (dev->nErasedBlocks < (dev->nReservedBlocks) && block > 0) {
2420                         T(YAFFS_TRACE_GC,
2421                           (TSTR
2422                            ("yaffs: GC !!!no reclaim!!! erasedBlocks %d after try %d block %d"
2423                             TENDSTR), dev->nErasedBlocks, maxTries, block));
2424                 }
2425         } while ((dev->nErasedBlocks < dev->nReservedBlocks) && (block > 0)
2426                  && (maxTries < 2));
2427
2428         return aggressive ? gcOk : YAFFS_OK;
2429 }
2430
2431 /*-------------------------  TAGS --------------------------------*/
2432
2433 static int yaffs_TagsMatch(const yaffs_ExtendedTags * tags, int objectId,
2434                            int chunkInObject)
2435 {
2436         return (tags->chunkId == chunkInObject &&
2437                 tags->objectId == objectId && !tags->chunkDeleted) ? 1 : 0;
2438
2439 }
2440
2441
2442 /*-------------------- Data file manipulation -----------------*/
2443
2444 static int yaffs_FindChunkInFile(yaffs_Object * in, int chunkInInode,
2445                                  yaffs_ExtendedTags * tags)
2446 {
2447         /*Get the Tnode, then get the level 0 offset chunk offset */
2448         yaffs_Tnode *tn;
2449         int theChunk = -1;
2450         yaffs_ExtendedTags localTags;
2451         int retVal = -1;
2452
2453         yaffs_Device *dev = in->myDev;
2454
2455         if (!tags) {
2456                 /* Passed a NULL, so use our own tags space */
2457                 tags = &localTags;
2458         }
2459
2460         tn = yaffs_FindLevel0Tnode(dev, &in->variant.fileVariant, chunkInInode);
2461
2462         if (tn) {
2463                 theChunk = yaffs_GetChunkGroupBase(dev,tn,chunkInInode);
2464
2465                 retVal =
2466                     yaffs_FindChunkInGroup(dev, theChunk, tags, in->objectId,
2467                                            chunkInInode);
2468         }
2469         return retVal;
2470 }
2471
2472 static int yaffs_FindAndDeleteChunkInFile(yaffs_Object * in, int chunkInInode,
2473                                           yaffs_ExtendedTags * tags)
2474 {
2475         /* Get the Tnode, then get the level 0 offset chunk offset */
2476         yaffs_Tnode *tn;
2477         int theChunk = -1;
2478         yaffs_ExtendedTags localTags;
2479
2480         yaffs_Device *dev = in->myDev;
2481         int retVal = -1;
2482
2483         if (!tags) {
2484                 /* Passed a NULL, so use our own tags space */
2485                 tags = &localTags;
2486         }
2487
2488         tn = yaffs_FindLevel0Tnode(dev, &in->variant.fileVariant, chunkInInode);
2489
2490         if (tn) {
2491
2492                 theChunk = yaffs_GetChunkGroupBase(dev,tn,chunkInInode);
2493
2494                 retVal =
2495                     yaffs_FindChunkInGroup(dev, theChunk, tags, in->objectId,
2496                                            chunkInInode);
2497
2498                 /* Delete the entry in the filestructure (if found) */
2499                 if (retVal != -1) {
2500                         yaffs_PutLevel0Tnode(dev,tn,chunkInInode,0);
2501                 }
2502         } else {
2503                 /*T(("No level 0 found for %d\n", chunkInInode)); */
2504         }
2505
2506         if (retVal == -1) {
2507                 /* T(("Could not find %d to delete\n",chunkInInode)); */
2508         }
2509         return retVal;
2510 }
2511
2512 #ifdef YAFFS_PARANOID
2513
2514 static int yaffs_CheckFileSanity(yaffs_Object * in)
2515 {
2516         int chunk;
2517         int nChunks;
2518         int fSize;
2519         int failed = 0;
2520         int objId;
2521         yaffs_Tnode *tn;
2522         yaffs_Tags localTags;
2523         yaffs_Tags *tags = &localTags;
2524         int theChunk;
2525         int chunkDeleted;
2526
2527         if (in->variantType != YAFFS_OBJECT_TYPE_FILE) {
2528                 /* T(("Object not a file\n")); */
2529                 return YAFFS_FAIL;
2530         }
2531
2532         objId = in->objectId;
2533         fSize = in->variant.fileVariant.fileSize;
2534         nChunks =
2535             (fSize + in->myDev->nBytesPerChunk - 1) / in->myDev->nBytesPerChunk;
2536
2537         for (chunk = 1; chunk <= nChunks; chunk++) {
2538                 tn = yaffs_FindLevel0Tnode(in->myDev, &in->variant.fileVariant,
2539                                            chunk);
2540
2541                 if (tn) {
2542
2543                         theChunk = yaffs_GetChunkGroupBase(dev,tn,chunk);
2544
2545                         if (yaffs_CheckChunkBits
2546                             (dev, theChunk / dev->nChunksPerBlock,
2547                              theChunk % dev->nChunksPerBlock)) {
2548
2549                                 yaffs_ReadChunkTagsFromNAND(in->myDev, theChunk,
2550                                                             tags,
2551                                                             &chunkDeleted);
2552                                 if (yaffs_TagsMatch
2553                                     (tags, in->objectId, chunk, chunkDeleted)) {
2554                                         /* found it; */
2555
2556                                 }
2557                         } else {
2558
2559                                 failed = 1;
2560                         }
2561
2562                 } else {
2563                         /* T(("No level 0 found for %d\n", chunk)); */
2564                 }
2565         }
2566
2567         return failed ? YAFFS_FAIL : YAFFS_OK;
2568 }
2569
2570 #endif
2571
2572 static int yaffs_PutChunkIntoFile(yaffs_Object * in, int chunkInInode,
2573                                   int chunkInNAND, int inScan)
2574 {
2575         /* NB inScan is zero unless scanning. 
2576          * For forward scanning, inScan is > 0; 
2577          * for backward scanning inScan is < 0
2578          */
2579          
2580         yaffs_Tnode *tn;
2581         yaffs_Device *dev = in->myDev;
2582         int existingChunk;
2583         yaffs_ExtendedTags existingTags;
2584         yaffs_ExtendedTags newTags;
2585         unsigned existingSerial, newSerial;
2586
2587         if (in->variantType != YAFFS_OBJECT_TYPE_FILE) {
2588                 /* Just ignore an attempt at putting a chunk into a non-file during scanning
2589                  * If it is not during Scanning then something went wrong!
2590                  */
2591                 if (!inScan) {
2592                         T(YAFFS_TRACE_ERROR,
2593                           (TSTR
2594                            ("yaffs tragedy:attempt to put data chunk into a non-file"
2595                             TENDSTR)));
2596                         YBUG();
2597                 }
2598
2599                 yaffs_DeleteChunk(dev, chunkInNAND, 1, __LINE__);
2600                 return YAFFS_OK;
2601         }
2602
2603         tn = yaffs_AddOrFindLevel0Tnode(dev, &in->variant.fileVariant,
2604                                         chunkInInode);
2605         if (!tn) {
2606                 return YAFFS_FAIL;
2607         }
2608
2609         existingChunk = yaffs_GetChunkGroupBase(dev,tn,chunkInInode);
2610
2611         if (inScan != 0) {
2612                 /* If we're scanning then we need to test for duplicates
2613                  * NB This does not need to be efficient since it should only ever 
2614                  * happen when the power fails during a write, then only one
2615                  * chunk should ever be affected.
2616                  *
2617                  * Correction for YAFFS2: This could happen quite a lot and we need to think about efficiency! TODO
2618                  * Update: For backward scanning we don't need to re-read tags so this is quite cheap.
2619                  */
2620
2621                 if (existingChunk != 0) {
2622                         /* NB Right now existing chunk will not be real chunkId if the device >= 32MB
2623                          *    thus we have to do a FindChunkInFile to get the real chunk id.
2624                          *
2625                          * We have a duplicate now we need to decide which one to use:
2626                          *
2627                          * Backwards scanning YAFFS2: The old one is what we use, dump the new one.
2628                          * Forward scanning YAFFS2: The new one is what we use, dump the old one.
2629                          * YAFFS1: Get both sets of tags and compare serial numbers.
2630                          */
2631
2632                         if (inScan > 0) {
2633                                 /* Only do this for forward scanning */
2634                                 yaffs_ReadChunkWithTagsFromNAND(dev,
2635                                                                 chunkInNAND,
2636                                                                 NULL, &newTags);
2637
2638                                 /* Do a proper find */
2639                                 existingChunk =
2640                                     yaffs_FindChunkInFile(in, chunkInInode,
2641                                                           &existingTags);
2642                         }
2643
2644                         if (existingChunk <= 0) {
2645                                 /*Hoosterman - how did this happen? */
2646
2647                                 T(YAFFS_TRACE_ERROR,
2648                                   (TSTR
2649                                    ("yaffs tragedy: existing chunk < 0 in scan"
2650                                     TENDSTR)));
2651
2652                         }
2653
2654                         /* NB The deleted flags should be false, otherwise the chunks will 
2655                          * not be loaded during a scan
2656                          */
2657
2658                         newSerial = newTags.serialNumber;
2659                         existingSerial = existingTags.serialNumber;
2660
2661                         if ((inScan > 0) &&
2662                             (in->myDev->isYaffs2 ||
2663                              existingChunk <= 0 ||
2664                              ((existingSerial + 1) & 3) == newSerial)) {
2665                                 /* Forward scanning.                            
2666                                  * Use new
2667                                  * Delete the old one and drop through to update the tnode
2668                                  */
2669                                 yaffs_DeleteChunk(dev, existingChunk, 1,
2670                                                   __LINE__);
2671                         } else {
2672                                 /* Backward scanning or we want to use the existing one
2673                                  * Use existing.
2674                                  * Delete the new one and return early so that the tnode isn't changed
2675                                  */
2676                                 yaffs_DeleteChunk(dev, chunkInNAND, 1,
2677                                                   __LINE__);
2678                                 return YAFFS_OK;
2679                         }
2680                 }
2681
2682         }
2683
2684         if (existingChunk == 0) {
2685                 in->nDataChunks++;
2686         }
2687
2688         yaffs_PutLevel0Tnode(dev,tn,chunkInInode,chunkInNAND);
2689
2690         return YAFFS_OK;
2691 }
2692
2693 static int yaffs_ReadChunkDataFromObject(yaffs_Object * in, int chunkInInode,
2694                                          __u8 * buffer)
2695 {
2696         int chunkInNAND = yaffs_FindChunkInFile(in, chunkInInode, NULL);
2697
2698         if (chunkInNAND >= 0) {
2699                 return yaffs_ReadChunkWithTagsFromNAND(in->myDev, chunkInNAND,
2700                                                        buffer, NULL);
2701         } else {
2702                 T(YAFFS_TRACE_NANDACCESS,
2703                   (TSTR("Chunk %d not found zero instead" TENDSTR),
2704                    chunkInNAND));
2705                 /* get sane (zero) data if you read a hole */
2706                 memset(buffer, 0, in->myDev->nBytesPerChunk);   
2707                 return 0;
2708         }
2709
2710 }
2711
2712 void yaffs_DeleteChunk(yaffs_Device * dev, int chunkId, int markNAND, int lyn)
2713 {
2714         int block;
2715         int page;
2716         yaffs_ExtendedTags tags;
2717         yaffs_BlockInfo *bi;
2718
2719         if (chunkId <= 0)
2720                 return;
2721
2722         dev->nDeletions++;
2723         block = chunkId / dev->nChunksPerBlock;
2724         page = chunkId % dev->nChunksPerBlock;
2725
2726         bi = yaffs_GetBlockInfo(dev, block);
2727
2728         T(YAFFS_TRACE_DELETION,
2729           (TSTR("line %d delete of chunk %d" TENDSTR), lyn, chunkId));
2730
2731         if (markNAND &&
2732             bi->blockState != YAFFS_BLOCK_STATE_COLLECTING && !dev->isYaffs2) {
2733
2734                 yaffs_InitialiseTags(&tags);
2735
2736                 tags.chunkDeleted = 1;
2737
2738                 yaffs_WriteChunkWithTagsToNAND(dev, chunkId, NULL, &tags);
2739                 yaffs_HandleUpdateChunk(dev, chunkId, &tags);
2740         } else {
2741                 dev->nUnmarkedDeletions++;
2742         }
2743
2744         /* Pull out of the management area.
2745          * If the whole block became dirty, this will kick off an erasure.
2746          */
2747         if (bi->blockState == YAFFS_BLOCK_STATE_ALLOCATING ||
2748             bi->blockState == YAFFS_BLOCK_STATE_FULL ||
2749             bi->blockState == YAFFS_BLOCK_STATE_NEEDS_SCANNING ||
2750             bi->blockState == YAFFS_BLOCK_STATE_COLLECTING) {
2751                 dev->nFreeChunks++;
2752
2753                 yaffs_ClearChunkBit(dev, block, page);
2754
2755                 bi->pagesInUse--;
2756
2757                 if (bi->pagesInUse == 0 &&
2758                     !bi->hasShrinkHeader &&
2759                     bi->blockState != YAFFS_BLOCK_STATE_ALLOCATING &&
2760                     bi->blockState != YAFFS_BLOCK_STATE_NEEDS_SCANNING) {
2761                         yaffs_BlockBecameDirty(dev, block);
2762                 }
2763
2764         } else {
2765                 /* T(("Bad news deleting chunk %d\n",chunkId)); */
2766         }
2767
2768 }
2769
2770 static int yaffs_WriteChunkDataToObject(yaffs_Object * in, int chunkInInode,
2771                                         const __u8 * buffer, int nBytes,
2772                                         int useReserve)
2773 {
2774         /* Find old chunk Need to do this to get serial number
2775          * Write new one and patch into tree.
2776          * Invalidate old tags.
2777          */
2778
2779         int prevChunkId;
2780         yaffs_ExtendedTags prevTags;
2781
2782         int newChunkId;
2783         yaffs_ExtendedTags newTags;
2784
2785         yaffs_Device *dev = in->myDev;
2786
2787         yaffs_CheckGarbageCollection(dev);
2788
2789         /* Get the previous chunk at this location in the file if it exists */
2790         prevChunkId = yaffs_FindChunkInFile(in, chunkInInode, &prevTags);
2791
2792         /* Set up new tags */
2793         yaffs_InitialiseTags(&newTags);
2794
2795         newTags.chunkId = chunkInInode;
2796         newTags.objectId = in->objectId;
2797         newTags.serialNumber =
2798             (prevChunkId >= 0) ? prevTags.serialNumber + 1 : 1;
2799         newTags.byteCount = nBytes;
2800
2801         newChunkId =
2802             yaffs_WriteNewChunkWithTagsToNAND(dev, buffer, &newTags,
2803                                               useReserve);
2804
2805         if (newChunkId >= 0) {
2806                 yaffs_PutChunkIntoFile(in, chunkInInode, newChunkId, 0);
2807
2808                 if (prevChunkId >= 0) {
2809                         yaffs_DeleteChunk(dev, prevChunkId, 1, __LINE__);
2810
2811                 }
2812
2813                 yaffs_CheckFileSanity(in);
2814         }
2815         return newChunkId;
2816
2817 }
2818
2819 /* UpdateObjectHeader updates the header on NAND for an object.
2820  * If name is not NULL, then that new name is used.
2821  */
2822 int yaffs_UpdateObjectHeader(yaffs_Object * in, const YCHAR * name, int force,
2823                              int isShrink, int shadows)
2824 {
2825
2826         yaffs_BlockInfo *bi;
2827
2828         yaffs_Device *dev = in->myDev;
2829
2830         int prevChunkId;
2831         int retVal = 0;
2832
2833         int newChunkId;
2834         yaffs_ExtendedTags newTags;
2835
2836         __u8 *buffer = NULL;
2837         YCHAR oldName[YAFFS_MAX_NAME_LENGTH + 1];
2838
2839         yaffs_ObjectHeader *oh = NULL;
2840
2841         if (!in->fake || force) {
2842
2843                 yaffs_CheckGarbageCollection(dev);
2844
2845                 buffer = yaffs_GetTempBuffer(in->myDev, __LINE__);
2846                 oh = (yaffs_ObjectHeader *) buffer;
2847
2848                 prevChunkId = in->chunkId;
2849
2850                 if (prevChunkId >= 0) {
2851                         yaffs_ReadChunkWithTagsFromNAND(dev, prevChunkId,
2852                                                         buffer, NULL);
2853                         memcpy(oldName, oh->name, sizeof(oh->name));
2854                 }
2855
2856                 memset(buffer, 0xFF, dev->nBytesPerChunk);
2857
2858                 oh->type = in->variantType;
2859                 oh->yst_mode = in->yst_mode;
2860                 oh->shadowsObject = shadows;
2861
2862 #ifdef CONFIG_YAFFS_WINCE
2863                 oh->win_atime[0] = in->win_atime[0];
2864                 oh->win_ctime[0] = in->win_ctime[0];
2865                 oh->win_mtime[0] = in->win_mtime[0];
2866                 oh->win_atime[1] = in->win_atime[1];
2867                 oh->win_ctime[1] = in->win_ctime[1];
2868                 oh->win_mtime[1] = in->win_mtime[1];
2869 #else
2870                 oh->yst_uid = in->yst_uid;
2871                 oh->yst_gid = in->yst_gid;
2872                 oh->yst_atime = in->yst_atime;
2873                 oh->yst_mtime = in->yst_mtime;
2874                 oh->yst_ctime = in->yst_ctime;
2875                 oh->yst_rdev = in->yst_rdev;
2876 #endif
2877                 if (in->parent) {
2878                         oh->parentObjectId = in->parent->objectId;
2879                 } else {
2880                         oh->parentObjectId = 0;
2881                 }
2882
2883                 if (name && *name) {
2884                         memset(oh->name, 0, sizeof(oh->name));
2885                         yaffs_strncpy(oh->name, name, YAFFS_MAX_NAME_LENGTH);
2886                 } else if (prevChunkId) {
2887                         memcpy(oh->name, oldName, sizeof(oh->name));
2888                 } else {
2889                         memset(oh->name, 0, sizeof(oh->name));
2890                 }
2891
2892                 oh->isShrink = isShrink;
2893
2894                 switch (in->variantType) {
2895                 case YAFFS_OBJECT_TYPE_UNKNOWN:
2896                         /* Should not happen */
2897                         break;
2898                 case YAFFS_OBJECT_TYPE_FILE:
2899                         oh->fileSize =
2900                             (oh->parentObjectId == YAFFS_OBJECTID_DELETED
2901                              || oh->parentObjectId ==
2902                              YAFFS_OBJECTID_UNLINKED) ? 0 : in->variant.
2903                             fileVariant.fileSize;
2904                         break;
2905                 case YAFFS_OBJECT_TYPE_HARDLINK:
2906                         oh->equivalentObjectId =
2907                             in->variant.hardLinkVariant.equivalentObjectId;
2908                         break;
2909                 case YAFFS_OBJECT_TYPE_SPECIAL:
2910                         /* Do nothing */
2911                         break;
2912                 case YAFFS_OBJECT_TYPE_DIRECTORY:
2913                         /* Do nothing */
2914                         break;
2915                 case YAFFS_OBJECT_TYPE_SYMLINK:
2916                         yaffs_strncpy(oh->alias,
2917                                       in->variant.symLinkVariant.alias,
2918                                       YAFFS_MAX_ALIAS_LENGTH);
2919                         oh->alias[YAFFS_MAX_ALIAS_LENGTH] = 0;
2920                         break;
2921                 }
2922
2923                 /* Tags */
2924                 yaffs_InitialiseTags(&newTags);
2925                 in->serial++;
2926                 newTags.chunkId = 0;
2927                 newTags.objectId = in->objectId;
2928                 newTags.serialNumber = in->serial;
2929
2930                 /* Add extra info for file header */
2931
2932                 newTags.extraHeaderInfoAvailable = 1;
2933                 newTags.extraParentObjectId = oh->parentObjectId;
2934                 newTags.extraFileLength = oh->fileSize;
2935                 newTags.extraIsShrinkHeader = oh->isShrink;
2936                 newTags.extraEquivalentObjectId = oh->equivalentObjectId;
2937                 newTags.extraShadows = (oh->shadowsObject > 0) ? 1 : 0;
2938                 newTags.extraObjectType = in->variantType;
2939
2940                 /* Create new chunk in NAND */
2941                 newChunkId =
2942                     yaffs_WriteNewChunkWithTagsToNAND(dev, buffer, &newTags,
2943                                                       (prevChunkId >= 0) ? 1 : 0);
2944
2945                 if (newChunkId >= 0) {
2946
2947                         in->chunkId = newChunkId;
2948
2949                         if (prevChunkId >= 0) {
2950                                 yaffs_DeleteChunk(dev, prevChunkId, 1,
2951                                                   __LINE__);
2952                         }
2953
2954                         in->dirty = 0;
2955
2956                         /* If this was a shrink, then mark the block that the chunk lives on */
2957                         if (isShrink) {
2958                                 bi = yaffs_GetBlockInfo(in->myDev,
2959                                                         newChunkId /in->myDev-> nChunksPerBlock);
2960                                 bi->hasShrinkHeader = 1;
2961                         }
2962
2963                 }
2964
2965                 retVal = newChunkId;
2966
2967         }
2968
2969         if (buffer)
2970                 yaffs_ReleaseTempBuffer(dev, buffer, __LINE__);
2971
2972         return retVal;
2973 }
2974
2975 /*------------------------ Short Operations Cache ----------------------------------------
2976  *   In many situations where there is no high level buffering (eg WinCE) a lot of
2977  *   reads might be short sequential reads, and a lot of writes may be short 
2978  *   sequential writes. eg. scanning/writing a jpeg file.
2979  *   In these cases, a short read/write cache can provide a huge perfomance benefit 
2980  *   with dumb-as-a-rock code.
2981  *   In Linux, the page cache provides read buffering aand the short op cache provides write 
2982  *   buffering.
2983  *
2984  *   There are a limited number (~10) of cache chunks per device so that we don't
2985  *   need a very intelligent search.
2986  */
2987
2988 static void yaffs_FlushFilesChunkCache(yaffs_Object * obj)
2989 {
2990         yaffs_Device *dev = obj->myDev;
2991         int lowest = -99;       /* Stop compiler whining. */
2992         int i;
2993         yaffs_ChunkCache *cache;
2994         int chunkWritten = 0;
2995         int nCaches = obj->myDev->nShortOpCaches;
2996
2997         if (nCaches > 0) {
2998                 do {
2999                         cache = NULL;
3000
3001                         /* Find the dirty cache for this object with the lowest chunk id. */
3002                         for (i = 0; i < nCaches; i++) {
3003                                 if (dev->srCache[i].object == obj &&
3004                                     dev->srCache[i].dirty) {
3005                                         if (!cache
3006                                             || dev->srCache[i].chunkId <
3007                                             lowest) {
3008                                                 cache = &dev->srCache[i];
3009                                                 lowest = cache->chunkId;
3010                                         }
3011                                 }
3012                         }
3013
3014                         if (cache && !cache->locked) {
3015                                 /* Write it out and free it up */
3016
3017                                 chunkWritten =
3018                                     yaffs_WriteChunkDataToObject(cache->object,
3019                                                                  cache->chunkId,
3020                                                                  cache->data,
3021                                                                  cache->nBytes,
3022                                                                  1);
3023                                 cache->dirty = 0;
3024                                 cache->object = NULL;
3025                         }
3026
3027                 } while (cache && chunkWritten > 0);
3028
3029                 if (cache) {
3030                         /* Hoosterman, disk full while writing cache out. */
3031                         T(YAFFS_TRACE_ERROR,
3032                           (TSTR("yaffs tragedy: no space during cache write" TENDSTR)));
3033
3034                 }
3035         }
3036
3037 }
3038
3039 /* Grab us a cache chunk for use.
3040  * First look for an empty one. 
3041  * Then look for the least recently used non-dirty one.
3042  * Then look for the least recently used dirty one...., flush and look again.
3043  */
3044 static yaffs_ChunkCache *yaffs_GrabChunkCacheWorker(yaffs_Device * dev)
3045 {
3046         int i;
3047         int usage;
3048         int theOne;
3049
3050         if (dev->nShortOpCaches > 0) {
3051                 for (i = 0; i < dev->nShortOpCaches; i++) {
3052                         if (!dev->srCache[i].object) 
3053                                 return &dev->srCache[i];
3054                 }
3055
3056                 return NULL;
3057
3058                 theOne = -1;
3059                 usage = 0;      /* just to stop the compiler grizzling */
3060
3061                 for (i = 0; i < dev->nShortOpCaches; i++) {
3062                         if (!dev->srCache[i].dirty &&
3063                             ((dev->srCache[i].lastUse < usage && theOne >= 0) ||
3064                              theOne < 0)) {
3065                                 usage = dev->srCache[i].lastUse;
3066                                 theOne = i;
3067                         }
3068                 }
3069
3070
3071                 return theOne >= 0 ? &dev->srCache[theOne] : NULL;
3072         } else {
3073                 return NULL;
3074         }
3075
3076 }
3077
3078 static yaffs_ChunkCache *yaffs_GrabChunkCache(yaffs_Device * dev)
3079 {
3080         yaffs_ChunkCache *cache;
3081         yaffs_Object *theObj;
3082         int usage;
3083         int i;
3084         int pushout;
3085
3086         if (dev->nShortOpCaches > 0) {
3087                 /* Try find a non-dirty one... */
3088
3089                 cache = yaffs_GrabChunkCacheWorker(dev);
3090
3091                 if (!cache) {
3092                         /* They were all dirty, find the last recently used object and flush
3093                          * its cache, then  find again.
3094                          * NB what's here is not very accurate, we actually flush the object
3095                          * the last recently used page.
3096                          */
3097
3098                         /* With locking we can't assume we can use entry zero */
3099
3100                         theObj = NULL;
3101                         usage = -1;
3102                         cache = NULL;
3103                         pushout = -1;
3104
3105                         for (i = 0; i < dev->nShortOpCaches; i++) {
3106                                 if (dev->srCache[i].object &&
3107                                     !dev->srCache[i].locked &&
3108                                     (dev->srCache[i].lastUse < usage || !cache))
3109                                 {
3110                                         usage = dev->srCache[i].lastUse;
3111                                         theObj = dev->srCache[i].object;
3112                                         cache = &dev->srCache[i];
3113                                         pushout = i;
3114                                 }
3115                         }
3116
3117                         if (!cache || cache->dirty) {
3118                                 /* Flush and try again */
3119                                 yaffs_FlushFilesChunkCache(theObj);
3120                                 cache = yaffs_GrabChunkCacheWorker(dev);
3121                         }
3122
3123                 }
3124                 return cache;
3125         } else
3126                 return NULL;
3127
3128 }
3129
3130 /* Find a cached chunk */
3131 static yaffs_ChunkCache *yaffs_FindChunkCache(const yaffs_Object * obj,
3132                                               int chunkId)
3133 {
3134         yaffs_Device *dev = obj->myDev;
3135         int i;
3136         if (dev->nShortOpCaches > 0) {
3137                 for (i = 0; i < dev->nShortOpCaches; i++) {
3138                         if (dev->srCache[i].object == obj &&
3139                             dev->srCache[i].chunkId == chunkId) {
3140                                 dev->cacheHits++;
3141
3142                                 return &dev->srCache[i];
3143                         }
3144                 }
3145         }
3146         return NULL;
3147 }
3148
3149 /* Mark the chunk for the least recently used algorithym */
3150 static void yaffs_UseChunkCache(yaffs_Device * dev, yaffs_ChunkCache * cache,
3151                                 int isAWrite)
3152 {
3153
3154         if (dev->nShortOpCaches > 0) {
3155                 if (dev->srLastUse < 0 || dev->srLastUse > 100000000) {
3156                         /* Reset the cache usages */
3157                         int i;
3158                         for (i = 1; i < dev->nShortOpCaches; i++) {
3159                                 dev->srCache[i].lastUse = 0;
3160                         }
3161                         dev->srLastUse = 0;
3162                 }
3163
3164                 dev->srLastUse++;
3165
3166                 cache->lastUse = dev->srLastUse;
3167
3168                 if (isAWrite) {
3169                         cache->dirty = 1;
3170                 }
3171         }
3172 }
3173
3174 /* Invalidate a single cache page.
3175  * Do this when a whole page gets written,
3176  * ie the short cache for this page is no longer valid.
3177  */
3178 static void yaffs_InvalidateChunkCache(yaffs_Object * object, int chunkId)
3179 {
3180         if (object->myDev->nShortOpCaches > 0) {
3181                 yaffs_ChunkCache *cache = yaffs_FindChunkCache(object, chunkId);
3182
3183                 if (cache) {
3184                         cache->object = NULL;
3185                 }
3186         }
3187 }
3188
3189 /* Invalidate all the cache pages associated with this object
3190  * Do this whenever ther file is deleted or resized.
3191  */
3192 static void yaffs_InvalidateWholeChunkCache(yaffs_Object * in)
3193 {
3194         int i;
3195         yaffs_Device *dev = in->myDev;
3196
3197         if (dev->nShortOpCaches > 0) {
3198                 /* Invalidate it. */
3199                 for (i = 0; i < dev->nShortOpCaches; i++) {
3200                         if (dev->srCache[i].object == in) {
3201                                 dev->srCache[i].object = NULL;
3202                         }
3203                 }
3204         }
3205 }
3206
3207 /*--------------------- File read/write ------------------------
3208  * Read and write have very similar structures.
3209  * In general the read/write has three parts to it
3210  * An incomplete chunk to start with (if the read/write is not chunk-aligned)
3211  * Some complete chunks
3212  * An incomplete chunk to end off with
3213  *
3214  * Curve-balls: the first chunk might also be the last chunk.
3215  */
3216
3217 int yaffs_ReadDataFromFile(yaffs_Object * in, __u8 * buffer, __u32 offset,
3218                            int nBytes)
3219 {
3220
3221         int chunk;
3222         int start;
3223         int nToCopy;
3224         int n = nBytes;
3225         int nDone = 0;
3226         yaffs_ChunkCache *cache;
3227
3228         yaffs_Device *dev;
3229
3230         dev = in->myDev;
3231
3232         while (n > 0) {
3233                 chunk = offset / dev->nBytesPerChunk + 1;   /* The first chunk is 1 */
3234                 start = offset % dev->nBytesPerChunk;
3235
3236                 /* OK now check for the curveball where the start and end are in
3237                  * the same chunk.      
3238                  */
3239                 if ((start + n) < dev->nBytesPerChunk) {
3240                         nToCopy = n;
3241                 } else {
3242                         nToCopy = dev->nBytesPerChunk - start;
3243                 }
3244
3245                 cache = yaffs_FindChunkCache(in, chunk);
3246
3247                 /* If the chunk is already in the cache or it is less than a whole chunk
3248                  * then use the cache (if there is caching)
3249                  * else bypass the cache.
3250                  */
3251                 if (cache || nToCopy != dev->nBytesPerChunk) {
3252                         if (dev->nShortOpCaches > 0) {
3253
3254                                 /* If we can't find the data in the cache, then load it up. */
3255
3256                                 if (!cache) {
3257                                         cache = yaffs_GrabChunkCache(in->myDev);
3258                                         cache->object = in;
3259                                         cache->chunkId = chunk;
3260                                         cache->dirty = 0;
3261                                         cache->locked = 0;
3262                                         yaffs_ReadChunkDataFromObject(in, chunk,
3263                                                                       cache->
3264                                                                       data);
3265                                         cache->nBytes = 0;
3266                                 }
3267
3268                                 yaffs_UseChunkCache(dev, cache, 0);
3269
3270                                 cache->locked = 1;
3271
3272 #ifdef CONFIG_YAFFS_WINCE
3273                                 yfsd_UnlockYAFFS(TRUE);
3274 #endif
3275                                 memcpy(buffer, &cache->data[start], nToCopy);
3276
3277 #ifdef CONFIG_YAFFS_WINCE
3278                                 yfsd_LockYAFFS(TRUE);
3279 #endif
3280                                 cache->locked = 0;
3281                         } else {
3282                                 /* Read into the local buffer then copy..*/
3283
3284                                 __u8 *localBuffer =
3285                                     yaffs_GetTempBuffer(dev, __LINE__);
3286                                 yaffs_ReadChunkDataFromObject(in, chunk,
3287                                                               localBuffer);
3288 #ifdef CONFIG_YAFFS_WINCE
3289                                 yfsd_UnlockYAFFS(TRUE);
3290 #endif
3291                                 memcpy(buffer, &localBuffer[start], nToCopy);
3292
3293 #ifdef CONFIG_YAFFS_WINCE
3294                                 yfsd_LockYAFFS(TRUE);
3295 #endif
3296                                 yaffs_ReleaseTempBuffer(dev, localBuffer,
3297                                                         __LINE__);
3298                         }
3299
3300                 } else {
3301 #ifdef CONFIG_YAFFS_WINCE
3302                         __u8 *localBuffer = yaffs_GetTempBuffer(dev, __LINE__);
3303
3304                         /* Under WinCE can't do direct transfer. Need to use a local buffer.
3305                          * This is because we otherwise screw up WinCE's memory mapper
3306                          */
3307                         yaffs_ReadChunkDataFromObject(in, chunk, localBuffer);
3308