*** empty log message ***
[yaffs/.git] / yaffs_guts.h
index 855354296f944cd44a2e153dd06ccb2440e233fa..eb1d8b8ee4cf716391062f49e413f7275510941b 100644 (file)
  * it under the terms of the GNU Lesser General Public License version 2.1 as
  * published by the Free Software Foundation.
  *
+ *
+ * Note: Only YAFFS headers are LGPL, YAFFS C code is covered by GPL.
+ *
+ * $Id: yaffs_guts.h,v 1.18 2004-10-20 20:12:43 charles Exp $
  */
 
 #ifndef __YAFFS_GUTS_H__
 #define __YAFFS_GUTS_H__
 
-#include "devextras.h"
-
+#include "yportenv.h"
 
 #define YAFFS_OK       1
 #define YAFFS_FAIL  0
 #define YAFFS_TNODES_INTERNAL_MASK     0x7
 #define YAFFS_TNODES_MAX_LEVEL         6
                
+#define YAFFS_BYTES_PER_SPARE          16
+
 #define YAFFS_BYTES_PER_CHUNK          512
-#define YAFFS_CHUNK_SIZE_SHIFT         9
+//#define YAFFS_CHUNK_SIZE_SHIFT               9
 
-#define YAFFS_BYTES_PER_SPARE          16
 
 #define YAFFS_CHUNKS_PER_BLOCK         32
 #define YAFFS_BYTES_PER_BLOCK          (YAFFS_CHUNKS_PER_BLOCK*YAFFS_BYTES_PER_CHUNK)
 #define YAFFS_NOBJECT_BUCKETS          256
 
 
-#define YAFFS_RESERVED_BLOCKS          5
-
 #define YAFFS_OBJECT_SPACE                     0x40000
 #define YAFFS_MAX_NAME_LENGTH          255
+#define YAFFS_SHORT_NAME_LENGTH                15
 
 #define YAFFS_MAX_ALIAS_LENGTH         159
 
 #define YAFFS_OBJECTID_LOSTNFOUND      2
 #define YAFFS_OBJECTID_UNLINKED                3
 
-#define YAFFS_N_CACHE_CHUNKS           10
-
-#ifdef WIN32
-
-// Force the short operation cache on for WinCE
-
-#define CONFIG_YAFFS_SHORT_OP_CACHE
-#endif
+#define YAFFS_MAX_SHORT_OP_CACHES      20
 
 
 // ChunkCache is used for short read/write operations.
 typedef struct
 {
-       int objectId;
+       struct yaffs_ObjectStruct *object;
        int chunkId;
        int lastUse;
        int dirty;      
+       int nBytes;     // Only valid if the cache is dirty
        __u8 data[YAFFS_BYTES_PER_CHUNK];
 } yaffs_ChunkCache;
 
 // Tags structures in RAM
-// NB This uses bitfield. Bitfields should not stradle a u32 boundary otherwise
+// NB This uses bitfield. Bitfields should not straddle a u32 boundary otherwise
 // the structure size will get blown out.
 
 typedef struct
@@ -126,10 +123,17 @@ typedef struct
     __u8  ecc2[3];
 } yaffs_Spare;
 
+//Special structure for passing through to mtd
+struct yaffs_NANDSpare {
+       yaffs_Spare     spare;
+       int             eccres1;
+       int             eccres2;
+};
+
 // Block data in RAM
 
 typedef enum {
-       YAFFS_BLOCK_STATE_UddNKNOWN     = 0,
+       YAFFS_BLOCK_STATE_UNKNOWN       = 0,
        YAFFS_BLOCK_STATE_SCANNING,             // Used while the block is being scanned.
                                                                        // NB Don't erase blocks while they're being scanned
        
@@ -146,7 +150,7 @@ typedef enum {
        YAFFS_BLOCK_STATE_DIRTY,                // All pages have been allocated and deleted. 
                                                                        // Erase me, reuse me.
                                                        
-       YAFFS_BLOCK_STATE_DEAD = 0x77   // This block has failed and is not in use
+       YAFFS_BLOCK_STATE_DEAD                  // This block has failed and is not in use
 
 } yaffs_BlockState;
 
@@ -155,10 +159,13 @@ typedef enum {
 
 typedef struct
 {
-       __u32 pageBits;   // bitmap of pages in use
-    __u8  blockState; // One of the above block states
-    __u8  pagesInUse; // number of pages in use
-    __u8  needsRetiring:1;     // Data has failed on this block, need to get valid data off
+#ifndef CONFIG_YAFFS_NO_YAFFS2
+       __u32 sequenceNumber;   // block sequence number for yaffs2
+#endif
+       int   softDeletions:8;  // number of soft deleted pages
+    int   pagesInUse:8;                // number of pages in use
+    __u32 blockState:4;        // One of the above block states
+    __u32 needsRetiring:1;     // Data has failed on this block, need to get valid data off
                                                // and retire the block.
 } yaffs_BlockInfo;
 
@@ -182,17 +189,22 @@ typedef struct
 
        // Apply to everything  
        int   parentObjectId;
-       __u16 sum;      // checksum of name
+       __u16 sum__NoLongerUsed;        // checksum of name. Calc this off the name to prevent inconsistencies
        char  name[YAFFS_MAX_NAME_LENGTH + 1];
 
        // Thes following apply to directories, files, symlinks - not hard links
        __u32 st_mode;  // protection
+
+#ifdef CONFIG_YAFFS_WINCE
+       __u32 notForWinCE[5];
+#else
        __u32 st_uid;   // user ID of owner
        __u32 st_gid;    // group ID of owner 
        __u32 st_atime; // time of last access
        __u32 st_mtime; // time of last modification
        __u32 st_ctime; // time of last change
-       
+#endif
+
        // File size  applies to files only
        int fileSize; 
                
@@ -203,8 +215,15 @@ typedef struct
        char alias[YAFFS_MAX_ALIAS_LENGTH + 1];
        
        __u32 st_rdev;  // device stuff for block and char devices (maj/min)
-       // Roowm to grow...
+       
+#ifdef CONFIG_YAFFS_WINCE
+       __u32 win_ctime[2];
+       __u32 win_atime[2];
+       __u32 win_mtime[2];
+       __u32 roomToGrow[6];
+#else
        __u32 roomToGrow[12];
+#endif
        
 } yaffs_ObjectHeader;
 
@@ -214,7 +233,11 @@ typedef struct
 
 union yaffs_Tnode_union
 {
+#ifdef CONFIG_YAFFS_TNODE_LIST_DEBUG
+       union yaffs_Tnode_union *internal[YAFFS_NTNODES_INTERNAL+1];
+#else
        union yaffs_Tnode_union *internal[YAFFS_NTNODES_INTERNAL];
+#endif
        __u16 level0[YAFFS_NTNODES_LEVEL0];
        
 };
@@ -243,7 +266,7 @@ typedef struct
 {
        __u32 fileSize;
        __u32 scannedFileSize;
-       __u32 topLevel;
+       int   topLevel;
        yaffs_Tnode *top;
 } yaffs_FileStructure;
 
@@ -275,6 +298,7 @@ typedef union
 struct  yaffs_ObjectStruct
 {
        __u8 deleted: 1;                // This should only apply to unlinked files.
+       __u8 softDeleted: 1;    // it has also been soft deleted
        __u8 unlinked: 1;               // An unlinked file. The file should be in the unlinked pseudo directory.
        __u8 fake:1;                    // A fake object has no presence on NAND.
        __u8 renameAllowed:1;
@@ -309,19 +333,35 @@ struct  yaffs_ObjectStruct
        
        
        __u32 st_mode;          // protection
+
+#ifdef CONFIG_YAFFS_SHORT_NAMES_IN_RAM
+       char shortName[YAFFS_SHORT_NAME_LENGTH+1];
+#endif
+
+#ifndef __KERNEL__
+       __u32 inUse;
+#endif
+
+#ifdef CONFIG_YAFFS_WINCE
+       __u32 win_ctime[2];
+       __u32 win_mtime[2];
+       __u32 win_atime[2];
+#else
        __u32 st_uid;           // user ID of owner
        __u32 st_gid;           // group ID of owner 
        __u32 st_atime;         // time of last access
        __u32 st_mtime;         // time of last modification
        __u32 st_ctime;         // time of last change
+#endif
+
        __u32 st_rdev;      // device stuff for block and char devices
 
-#ifdef WIN32
-       __u32 inUse;
-#endif
+
 
 #ifdef __KERNEL__
        struct inode *myInode;
+       __u8  deferedFree;   // YAFFS has removed the object from NAND, but it is being kept
+                            // Alive until the inode is cleared to prevent inode inconsistencies.
 #endif
 
 
@@ -348,7 +388,7 @@ typedef struct yaffs_ObjectList_struct yaffs_ObjectList;
 typedef struct
 {
        struct list_head list;
-       __u32 count;
+       int count;
 } yaffs_ObjectBucket;
 
 
@@ -357,24 +397,21 @@ typedef struct
 struct yaffs_DeviceStruct
 {
        // Entry parameters set up way early. Yaffs sets up the rest.
-       //      __u32 nBlocks;          // Size of whole device in blocks
-       __u32 startBlock;       // Start block we're allowed to use
-       __u32 endBlock;         // End block we're allowed to use
-       __u16 chunkGroupBits; // 0 for devices <= 32MB. else log2(nchunks) - 16
-       __u16 chunkGroupSize; // == 2^^chunkGroupBits
+       int   nBytesPerChunk;    // Should be a power of 2 >= 512
+       int       nChunksPerBlock;       // does not need to be a power of 2
+       int   startBlock;                // Start block we're allowed to use
+       int   endBlock;                  // End block we're allowed to use
+       int   nReservedBlocks;   // We want this tuneable so that we can reduce
+                                                        // reserved blocks on NOR and RAM.
+       
+       int   useNANDECC;               // Flag to decide whether or not to use NANDECC
+       int   nShortOpCaches;   // If <= 0, then short op caching is disabled, else
+                                                       // the number of short op caches (don't use too many).
        
        
        void *genericDevice; // Pointer to device context
                                                 // On an mtd this holds the mtd pointer.
-       
-#ifdef __KERNEL__
-
-       struct semaphore sem;// Semaphore for waiting on erasure.
-       struct semaphore grossLock; // Gross locking semaphore
 
-#endif
-       
-       
        // NAND access functions (Must be set before calling YAFFS)
        
        int (*writeChunkToNAND)(struct yaffs_DeviceStruct *dev,int chunkInNAND, const __u8 *data, yaffs_Spare *spare);
@@ -382,15 +419,34 @@ struct yaffs_DeviceStruct
        int (*eraseBlockInNAND)(struct yaffs_DeviceStruct *dev,int blockInNAND);        
        int (*initialiseNAND)(struct yaffs_DeviceStruct *dev);
 
+       // Runtime parameters. Set up by YAFFS.
+       
+       __u16 chunkGroupBits; // 0 for devices <= 32MB. else log2(nchunks) - 16
+       __u16 chunkGroupSize; // == 2^^chunkGroupBits
+       
+#ifdef __KERNEL__
+
+       struct semaphore sem;// Semaphore for waiting on erasure.
+       struct semaphore grossLock; // Gross locking semaphore
+
+#endif 
 #ifdef __KERNEL__
        void (*putSuperFunc)(struct super_block *sb);
 #endif
 
-       // Runtime parameters.
+       int isMounted;
+       
+       // Block Info
        yaffs_BlockInfo *blockInfo;
+       __u8 *chunkBits;   // bitmap of chunks in use
+       int   chunkBitmapStride; // Number of bytes of chunkBits per block. 
+                                                        //     Must be consistent with nChunksPerBlock.
+
+
        int   nErasedBlocks;
-       int   allocationBlock;
+       int   allocationBlock;                  // Current block being allocated off
        __u32 allocationPage;
+       int   allocationBlockFinder;    // Used to search for next allocation block
        
        // Runtime state
        int   nTnodesCreated;   
@@ -411,7 +467,6 @@ struct yaffs_DeviceStruct
                
        int   currentDirtyChecker;      // Used to find current dirtiest block
        
-       int   garbageCollectionRequired;
        
        // Operations since mount
        int nPageWrites;
@@ -419,31 +474,38 @@ struct yaffs_DeviceStruct
        int nBlockErasures;
        int nGCCopies;
        int garbageCollections;
+       int passiveGarbageCollections;
        int nRetriedWrites;
        int nRetiredBlocks;
+       int eccFixed;
+       int eccUnfixed;
+       int tagsEccFixed;
+       int tagsEccUnfixed;
+       int nDeletions;
+       int nUnmarkedDeletions;
        
        yaffs_Object *rootDir;
        yaffs_Object *lostNFoundDir;
        
        // Buffer areas for storing data to recover from write failures
-       __u8            bufferedData[YAFFS_CHUNKS_PER_BLOCK][YAFFS_BYTES_PER_CHUNK];
-       yaffs_Spare bufferedSpare[YAFFS_CHUNKS_PER_BLOCK];
+//     __u8            bufferedData[YAFFS_CHUNKS_PER_BLOCK][YAFFS_BYTES_PER_CHUNK];
+//     yaffs_Spare bufferedSpare[YAFFS_CHUNKS_PER_BLOCK];
        int bufferedBlock;      // Which block is buffered here?
        int doingBufferedBlockRewrite;
-       
-       int blockSelectedForGC;
 
-#ifdef CONFIG_YAFFS_SHORT_OP_CACHE
-       yaffs_ChunkCache srCache[YAFFS_N_CACHE_CHUNKS];
+       yaffs_ChunkCache *srCache;
        int srLastUse;
-#endif
+
        int cacheHits;
 
        // Stuff for background deletion and unlinked files.
        yaffs_Object *unlinkedDir;              // Directory where unlinked and deleted files live.
        yaffs_Object *unlinkedDeletion; // Current file being background deleted.
-       int  nDeletedFiles;                             // Count of files awaiting deletion;
+       int nDeletedFiles;                              // Count of files awaiting deletion;
+       int nUnlinkedFiles;                             // Count of unlinked files. 
+       int nBackgroundDeletions;                       // Count of background deletions.       
        
+       __u8 *localBuffer;
        
 };
 
@@ -483,7 +545,7 @@ int yaffs_WriteDataToFile(yaffs_Object *obj, const __u8 *buffer, __u32 offset, i
 int yaffs_ResizeFile(yaffs_Object *obj, int newSize);
 
 yaffs_Object *yaffs_MknodFile(yaffs_Object *parent,const char *name, __u32 mode, __u32 uid, __u32 gid);
-int yaffs_FlushFile(yaffs_Object *obj);
+int yaffs_FlushFile(yaffs_Object *obj,int updateTime);
 
 
 // Directory operations
@@ -491,7 +553,7 @@ yaffs_Object *yaffs_MknodDirectory(yaffs_Object *parent,const char *name, __u32
 yaffs_Object *yaffs_FindObjectByName(yaffs_Object *theDir,const char *name);
 int yaffs_ApplyToDirectoryChildren(yaffs_Object *theDir,int (*fn)(yaffs_Object *));
 
-yaffs_Object *yaffs_FindObjectByNumber(yaffs_Device *dev,int number);
+yaffs_Object *yaffs_FindObjectByNumber(yaffs_Device *dev,__u32 number);
 
 // Link operations
 yaffs_Object *yaffs_Link(yaffs_Object *parent, const char *name, yaffs_Object *equivalentObject);
@@ -510,6 +572,14 @@ yaffs_Object *yaffs_MknodSpecial(yaffs_Object *parent,const char *name, __u32 mo
 yaffs_Object *yaffs_Root(yaffs_Device *dev);
 yaffs_Object *yaffs_LostNFound(yaffs_Device *dev);
 
+#ifdef CONFIG_YAFFS_WINCE
+// CONFIG_YAFFS_WINCE special stuff
+void  yfsd_WinFileTimeNow(__u32 target[2]);
+#endif
+
+#ifdef __KERNEL__
+void yaffs_HandleDeferedFree(yaffs_Object *obj);
+#endif
 
 // Debug dump 
 int yaffs_DumpObject(yaffs_Object *obj);
@@ -519,3 +589,5 @@ void yaffs_GutsTest(yaffs_Device *dev);
 
 
 #endif
+
+