Change direct handle management to use an inode layer to make it consistent with...
[yaffs2.git] / yaffs_guts.h
index b9b2ea19481f3237509b4ad8419cc8a45bf2cf4d..48e55339bc047ed80c23d14df9c4ebef06535e59 100644 (file)
 #define YAFFS_LOWEST_SEQUENCE_NUMBER   0x00001000
 #define YAFFS_HIGHEST_SEQUENCE_NUMBER  0xEFFFFF00
 
+/* Special sequence number for bad block that failed to be marked bad */
+#define YAFFS_SEQUENCE_BAD_BLOCK       0xFFFF0000
+
 /* ChunkCache is used for short read/write operations.*/
 typedef struct {
        struct yaffs_ObjectStruct *object;
@@ -134,11 +137,10 @@ typedef struct {
 typedef struct {
        unsigned chunkId:20;
        unsigned serialNumber:2;
-       unsigned byteCount:10;
+       unsigned byteCountLSB:10;
        unsigned objectId:18;
        unsigned ecc:12;
-       unsigned unusedStuff:2;
-
+       unsigned byteCountMSB:2;
 } yaffs_Tags;
 
 typedef union {
@@ -279,11 +281,11 @@ typedef struct {
        int pagesInUse:10;      /* number of pages in use */
        unsigned blockState:4;  /* One of the above block states. NB use unsigned because enum is sometimes an int */
        __u32 needsRetiring:1;  /* Data has failed on this block, need to get valid data off */
-                               /* and retire the block. */
-       __u32 skipErasedCheck: 1; /* If this is set we can skip the erased check on this block */
-       __u32 gcPrioritise: 1;  /* An ECC check or blank check has failed on this block.
+                               /* and retire the block. */
+       __u32 skipErasedCheck:1; /* If this is set we can skip the erased check on this block */
+       __u32 gcPrioritise:1;   /* An ECC check or blank check has failed on this block.
                                   It should be prioritised for GC */
-        __u32 chunkErrorStrikes:3; /* How many times we've had ecc etc failures on this block and tried to reuse it */
+       __u32 chunkErrorStrikes:3; /* How many times we've had ecc etc failures on this block and tried to reuse it */
 
 #ifdef CONFIG_YAFFS_YAFFS2
        __u32 hasShrinkHeader:1; /* This block has at least one shrink object header */
@@ -300,11 +302,11 @@ typedef struct {
 
        /* Apply to everything  */
        int parentObjectId;
-       __u16 sum__NoLongerUsed;        /* checksum of name. No longer used */
+       __u16 sum__NoLongerUsed;        /* checksum of name. No longer used */
        YCHAR name[YAFFS_MAX_NAME_LENGTH + 1];
 
        /* The following apply to directories, files, symlinks - not hard links */
-       __u32 yst_mode;         /* protection */
+       __u32 yst_mode;         /* protection */
 
 #ifdef CONFIG_YAFFS_WINCE
        __u32 notForWinCE[5];
@@ -384,7 +386,7 @@ typedef struct {
 } yaffs_FileStructure;
 
 typedef struct {
-       struct ylist_head children;     /* list of child links */
+       struct ylist_head children;     /* list of child links */
 } yaffs_DirectoryStructure;
 
 typedef struct {
@@ -403,6 +405,8 @@ typedef union {
        yaffs_HardLinkStructure hardLinkVariant;
 } yaffs_ObjectVariant;
 
+
+
 struct yaffs_ObjectStruct {
        __u8 deleted:1;         /* This should only apply to unlinked files. */
        __u8 softDeleted:1;     /* it has also been soft deleted */
@@ -421,15 +425,17 @@ struct yaffs_ObjectStruct {
                                 * still in the inode cache. Free of object is defered.
                                 * until the inode is released.
                                 */
+       __u8 beingCreated:1;    /* This object is still being created so skip some checks. */
+       __u8 isShadowed:1;      /* This object is shadowed on the way to being renamed. */
 
        __u8 serial;            /* serial number of chunk in NAND. Cached here */
        __u16 sum;              /* sum of the name to speed searching */
 
-       struct yaffs_DeviceStruct *myDev;       /* The device I'm on */
+       struct yaffs_DeviceStruct *myDev;       /* The device I'm on */
 
-       struct ylist_head hashLink;     /* list of objects in this hash bucket */
+       struct ylist_head hashLink;     /* list of objects in this hash bucket */
 
-       struct ylist_head hardLinks;    /* all the equivalent hard linked objects */
+       struct ylist_head hardLinks;    /* all the equivalent hard linked objects */
 
        /* directory structure stuff */
        /* also used for linking up the free list */
@@ -437,7 +443,7 @@ struct yaffs_ObjectStruct {
        struct ylist_head siblings;
 
        /* Where's my object header in NAND? */
-       int chunkId;
+       int hdrChunk;
 
        int nDataChunks;        /* Number of data chunks attached to the file. */
 
@@ -449,10 +455,6 @@ struct yaffs_ObjectStruct {
        YCHAR shortName[YAFFS_SHORT_NAME_LENGTH + 1];
 #endif
 
-#ifndef __KERNEL__
-       __u32 inUse;
-#endif
-
 #ifdef CONFIG_YAFFS_WINCE
        __u32 win_ctime[2];
        __u32 win_mtime[2];
@@ -467,10 +469,7 @@ struct yaffs_ObjectStruct {
 
        __u32 yst_rdev;
 
-#ifdef __KERNEL__
-       struct inode *myInode;
-
-#endif
+       void *myInode;
 
        yaffs_ObjectType variantType;
 
@@ -498,11 +497,10 @@ typedef struct {
  */
 
 typedef struct {
-        int structType;
+       int structType;
        __u32 objectId;
        __u32 parentId;
-       int chunkId;
-
+       int hdrChunk;
        yaffs_ObjectType variantType:3;
        __u8 deleted:1;
        __u8 softDeleted:1;
@@ -514,8 +512,7 @@ typedef struct {
 
        int nDataChunks;
        __u32 fileSizeOrEquivalentObjectId;
-
-}yaffs_CheckpointObject;
+} yaffs_CheckpointObject;
 
 /*--------------------- Temporary buffers ----------------
  *
@@ -530,6 +527,7 @@ typedef struct {
 
 /*----------------- Device ---------------------------------*/
 
+
 struct yaffs_DeviceStruct {
        struct ylist_head devList;
        const char *name;
@@ -537,7 +535,7 @@ struct yaffs_DeviceStruct {
        /* Entry parameters set up way early. Yaffs sets up the rest.*/
        int nDataBytesPerChunk; /* Should be a power of 2 >= 512 */
        int nChunksPerBlock;    /* does not need to be a power of 2 */
-       int nBytesPerSpare;     /* spare area size */
+       int spareBytesPerChunk; /* spare area size */
        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 */
@@ -547,9 +545,7 @@ struct yaffs_DeviceStruct {
        /* Stuff used by the shared space checkpointing mechanism */
        /* If this value is zero, then this mechanism is disabled */
 
-//     int nCheckpointReservedBlocks; /* Blocks to reserve for checkpoint data */
-
-
+/*     int nCheckpointReservedBlocks; */ /* Blocks to reserve for checkpoint data */
 
 
        int nShortOpCaches;     /* If <= 0, then short op caching is disabled, else
@@ -558,52 +554,58 @@ struct yaffs_DeviceStruct {
 
        int useHeaderFileSize;  /* Flag to determine if we should use file sizes from the header */
 
-       int useNANDECC;         /* Flag to decide whether or not to use NANDECC */
+       int useNANDECC;         /* Flag to decide whether or not to use NANDECC on data (yaffs1) */
+       int noTagsECC;          /* Flag to decide whether or not to do ECC on packed tags (yaffs2) */ 
+       
+       int disableLazyLoad;    /* Disable lazy loading on this device */
 
        void *genericDevice;    /* Pointer to device context
                                 * On an mtd this holds the mtd pointer.
                                 */
-        void *superBlock;
+       void *superBlock;
 
        /* NAND access functions (Must be set before calling YAFFS)*/
 
-       int (*writeChunkToNAND) (struct yaffs_DeviceStruct * dev,
-                                int chunkInNAND, const __u8 * data,
-                                const yaffs_Spare * spare);
-       int (*readChunkFromNAND) (struct yaffs_DeviceStruct * dev,
-                                 int chunkInNAND, __u8 * data,
-                                 yaffs_Spare * spare);
-       int (*eraseBlockInNAND) (struct yaffs_DeviceStruct * dev,
-                                int blockInNAND);
-       int (*initialiseNAND) (struct yaffs_DeviceStruct * dev);
+       int (*writeChunkToNAND) (struct yaffs_DeviceStruct *dev,
+                                       int chunkInNAND, const __u8 *data,
+                                       const yaffs_Spare *spare);
+       int (*readChunkFromNAND) (struct yaffs_DeviceStruct *dev,
+                                       int chunkInNAND, __u8 *data,
+                                       yaffs_Spare *spare);
+       int (*eraseBlockInNAND) (struct yaffs_DeviceStruct *dev,
+                                       int blockInNAND);
+       int (*initialiseNAND) (struct yaffs_DeviceStruct *dev);
+       int (*deinitialiseNAND) (struct yaffs_DeviceStruct *dev);
 
 #ifdef CONFIG_YAFFS_YAFFS2
-       int (*writeChunkWithTagsToNAND) (struct yaffs_DeviceStruct * dev,
-                                        int chunkInNAND, const __u8 * data,
-                                        const yaffs_ExtendedTags * tags);
-       int (*readChunkWithTagsFromNAND) (struct yaffs_DeviceStruct * dev,
-                                         int chunkInNAND, __u8 * data,
-                                         yaffs_ExtendedTags * tags);
-       int (*markNANDBlockBad) (struct yaffs_DeviceStruct * dev, int blockNo);
-       int (*queryNANDBlock) (struct yaffs_DeviceStruct * dev, int blockNo,
-                              yaffs_BlockState * state, __u32 *sequenceNumber);
+       int (*writeChunkWithTagsToNAND) (struct yaffs_DeviceStruct *dev,
+                                        int chunkInNAND, const __u8 *data,
+                                        const yaffs_ExtendedTags *tags);
+       int (*readChunkWithTagsFromNAND) (struct yaffs_DeviceStruct *dev,
+                                         int chunkInNAND, __u8 *data,
+                                         yaffs_ExtendedTags *tags);
+       int (*markNANDBlockBad) (struct yaffs_DeviceStruct *dev, int blockNo);
+       int (*queryNANDBlock) (struct yaffs_DeviceStruct *dev, int blockNo,
+                              yaffs_BlockState *state, __u32 *sequenceNumber);
 #endif
 
        int isYaffs2;
 
        /* The removeObjectCallback function must be supplied by OS flavours that
-        * need it. The Linux kernel does not use this, but yaffs direct does use
-        * it to implement the faster readdir
+        * need it.
+         * yaffs direct uses it to implement the faster readdir.
+         * Linux uses it to protect the directory during unlocking.
         */
        void (*removeObjectCallback)(struct yaffs_ObjectStruct *obj);
 
        /* Callback to mark the superblock dirsty */
-       void (*markSuperBlockDirty)(void * superblock);
+       void (*markSuperBlockDirty)(void *superblock);
 
        int wideTnodesDisabled; /* Set to disable wide tnodes */
-       
+
        YCHAR *pathDividers;    /* String of legal path dividers */
 
+
        /* End of stuff that must be set before initialisation. */
 
        /* Checkpoint control. Can be set before or after initialisation */
@@ -632,10 +634,14 @@ struct yaffs_DeviceStruct {
 
        struct semaphore sem;   /* Semaphore for waiting on erasure.*/
        struct semaphore grossLock;     /* Gross locking semaphore */
+       struct rw_semaphore dirLock; /* Lock the directory structure */
        __u8 *spareBuffer;      /* For mtdif2 use. Don't know the size of the buffer
                                 * at compile time so we have to allocate it.
+
                                 */
-       void (*putSuperFunc) (struct super_block * sb);
+       void (*putSuperFunc) (struct super_block *sb);
+        struct ylist_head searchContexts;
+
 #endif
 
        int isMounted;
@@ -688,11 +694,15 @@ struct yaffs_DeviceStruct {
        yaffs_TnodeList *allocatedTnodeList;
 
        int isDoingGC;
+       int gcBlock;
+       int gcChunk;
 
        int nObjectsCreated;
        yaffs_Object *freeObjects;
        int nFreeObjects;
 
+       int nHardLinks;
+
        yaffs_ObjectList *allocatedObjectList;
 
        yaffs_ObjectBucket objectBucket[YAFFS_NOBJECT_BUCKETS];
@@ -748,7 +758,7 @@ struct yaffs_DeviceStruct {
        int nUnlinkedFiles;             /* Count of unlinked files. */
        int nBackgroundDeletions;       /* Count of background deletions. */
 
-       
+
        /* Temporary buffer management */
        yaffs_TempBuffer tempBuffer[YAFFS_N_TEMP_BUFFERS];
        int maxTemp;
@@ -759,14 +769,16 @@ struct yaffs_DeviceStruct {
        /* yaffs2 runtime stuff */
        unsigned sequenceNumber;        /* Sequence number of currently allocating block */
        unsigned oldestDirtySequence;
-
+       
+       /* Auto empty lost and found directory on mount */
+       int emptyLostAndFound;
 };
 
 typedef struct yaffs_DeviceStruct yaffs_Device;
 
 /* The static layout of block usage etc is stored in the super block header */
 typedef struct {
-        int StructType;
+       int StructType;
        int version;
        int checkpointStartBlock;
        int checkpointEndBlock;
@@ -779,7 +791,7 @@ typedef struct {
  * must be preserved over unmount/mount cycles.
  */
 typedef struct {
-        int structType;
+       int structType;
        int nErasedBlocks;
        int allocationBlock;    /* Current block being allocated off */
        __u32 allocationPage;
@@ -797,45 +809,46 @@ typedef struct {
 
 
 typedef struct {
-    int structType;
-    __u32 magic;
-    __u32 version;
-    __u32 head;
+       int structType;
+       __u32 magic;
+       __u32 version;
+       __u32 head;
 } yaffs_CheckpointValidity;
 
 
 /*----------------------- YAFFS Functions -----------------------*/
 
-int yaffs_GutsInitialise(yaffs_Device * dev);
-void yaffs_Deinitialise(yaffs_Device * dev);
+int yaffs_GutsInitialise(yaffs_Device *dev);
+void yaffs_Deinitialise(yaffs_Device *dev);
 
-int yaffs_GetNumberOfFreeChunks(yaffs_Device * dev);
+int yaffs_GetNumberOfFreeChunks(yaffs_Device *dev);
 
-int yaffs_RenameObject(yaffs_Object * oldDir, const YCHAR * oldName,
-                      yaffs_Object * newDir, const YCHAR * newName);
+int yaffs_RenameObject(yaffs_Object *oldDir, const YCHAR *oldName,
+                      yaffs_Object *newDir, const YCHAR *newName);
 
-int yaffs_Unlink(yaffs_Object * dir, const YCHAR * name);
-int yaffs_DeleteFile(yaffs_Object * obj);
+int yaffs_Unlink(yaffs_Object *dir, const YCHAR *name);
+int yaffs_DeleteObject(yaffs_Object *obj);
 
-int yaffs_GetObjectName(yaffs_Object * obj, YCHAR * name, int buffSize);
-int yaffs_GetObjectFileLength(yaffs_Object * obj);
-int yaffs_GetObjectInode(yaffs_Object * obj);
-unsigned yaffs_GetObjectType(yaffs_Object * obj);
-int yaffs_GetObjectLinkCount(yaffs_Object * obj);
+int yaffs_GetObjectName(yaffs_Object *obj, YCHAR *name, int buffSize);
+int yaffs_GetObjectFileLength(yaffs_Object *obj);
+int yaffs_GetObjectInode(yaffs_Object *obj);
+unsigned yaffs_GetObjectType(yaffs_Object *obj);
+int yaffs_GetObjectLinkCount(yaffs_Object *obj);
 
-int yaffs_SetAttributes(yaffs_Object * obj, struct iattr *attr);
-int yaffs_GetAttributes(yaffs_Object * obj, struct iattr *attr);
+int yaffs_SetAttributes(yaffs_Object *obj, struct iattr *attr);
+int yaffs_GetAttributes(yaffs_Object *obj, struct iattr *attr);
 
 /* File operations */
-int yaffs_ReadDataFromFile(yaffs_Object * obj, __u8 * buffer, loff_t offset,
-                          int nBytes);
-int yaffs_WriteDataToFile(yaffs_Object * obj, const __u8 * buffer, loff_t offset,
-                         int nBytes, int writeThrough);
-int yaffs_ResizeFile(yaffs_Object * obj, loff_t newSize);
+int yaffs_ReadDataFromFile(yaffs_Object *obj, __u8 *buffer, loff_t offset,
+                               int nBytes);
+int yaffs_WriteDataToFile(yaffs_Object *obj, const __u8 *buffer, loff_t offset,
+                               int nBytes, int writeThrough);
+int yaffs_ResizeFile(yaffs_Object *obj, loff_t newSize);
+
+yaffs_Object *yaffs_MknodFile(yaffs_Object *parent, const YCHAR *name,
+                               __u32 mode, __u32 uid, __u32 gid);
 
-yaffs_Object *yaffs_MknodFile(yaffs_Object * parent, const YCHAR * name,
-                             __u32 mode, __u32 uid, __u32 gid);
-int yaffs_FlushFile(yaffs_Object * obj, int updateTime);
+int yaffs_FlushFile(yaffs_Object *obj, int updateTime, int dataSync);
 
 /* Flushing and checkpointing */
 void yaffs_FlushEntireDeviceCache(yaffs_Device *dev);
@@ -844,33 +857,33 @@ int yaffs_CheckpointSave(yaffs_Device *dev);
 int yaffs_CheckpointRestore(yaffs_Device *dev);
 
 /* Directory operations */
-yaffs_Object *yaffs_MknodDirectory(yaffs_Object * parent, const YCHAR * name,
-                                  __u32 mode, __u32 uid, __u32 gid);
-yaffs_Object *yaffs_FindObjectByName(yaffs_Object * theDir, const YCHAR * name);
-int yaffs_ApplyToDirectoryChildren(yaffs_Object * theDir,
+yaffs_Object *yaffs_MknodDirectory(yaffs_Object *parent, const YCHAR *name,
+                               __u32 mode, __u32 uid, __u32 gid);
+yaffs_Object *yaffs_FindObjectByName(yaffs_Object *theDir, const YCHAR *name);
+int yaffs_ApplyToDirectoryChildren(yaffs_Object *theDir,
                                   int (*fn) (yaffs_Object *));
 
-yaffs_Object *yaffs_FindObjectByNumber(yaffs_Device * dev, __u32 number);
+yaffs_Object *yaffs_FindObjectByNumber(yaffs_Device *dev, __u32 number);
 
 /* Link operations */
-yaffs_Object *yaffs_Link(yaffs_Object * parent, const YCHAR * name,
-                        yaffs_Object * equivalentObject);
+yaffs_Object *yaffs_Link(yaffs_Object *parent, const YCHAR *name,
+                        yaffs_Object *equivalentObject);
 
-yaffs_Object *yaffs_GetEquivalentObject(yaffs_Object * obj);
+yaffs_Object *yaffs_GetEquivalentObject(yaffs_Object *obj);
 
 /* Symlink operations */
-yaffs_Object *yaffs_MknodSymLink(yaffs_Object * parent, const YCHAR * name,
+yaffs_Object *yaffs_MknodSymLink(yaffs_Object *parent, const YCHAR *name,
                                 __u32 mode, __u32 uid, __u32 gid,
-                                const YCHAR * alias);
-YCHAR *yaffs_GetSymlinkAlias(yaffs_Object * obj);
+                                const YCHAR *alias);
+YCHAR *yaffs_GetSymlinkAlias(yaffs_Object *obj);
 
 /* Special inodes (fifos, sockets and devices) */
-yaffs_Object *yaffs_MknodSpecial(yaffs_Object * parent, const YCHAR * name,
+yaffs_Object *yaffs_MknodSpecial(yaffs_Object *parent, const YCHAR *name,
                                 __u32 mode, __u32 uid, __u32 gid, __u32 rdev);
 
 /* Special directories */
-yaffs_Object *yaffs_Root(yaffs_Device * dev);
-yaffs_Object *yaffs_LostNFound(yaffs_Device * dev);
+yaffs_Object *yaffs_Root(yaffs_Device *dev);
+yaffs_Object *yaffs_LostNFound(yaffs_Device *dev);
 
 #ifdef CONFIG_YAFFS_WINCE
 /* CONFIG_YAFFS_WINCE special stuff */
@@ -879,21 +892,21 @@ void yfsd_WinFileTimeNow(__u32 target[2]);
 
 #ifdef __KERNEL__
 
-void yaffs_HandleDeferedFree(yaffs_Object * obj);
+void yaffs_HandleDeferedFree(yaffs_Object *obj);
 #endif
 
 /* Debug dump  */
-int yaffs_DumpObject(yaffs_Object * obj);
+int yaffs_DumpObject(yaffs_Object *obj);
 
-void yaffs_GutsTest(yaffs_Device * dev);
+void yaffs_GutsTest(yaffs_Device *dev);
 
 /* A few useful functions */
-void yaffs_InitialiseTags(yaffs_ExtendedTags * tags);
-void yaffs_DeleteChunk(yaffs_Device * dev, int chunkId, int markNAND, int lyn);
-int yaffs_CheckFF(__u8 * buffer, int nBytes);
+void yaffs_InitialiseTags(yaffs_ExtendedTags *tags);
+void yaffs_DeleteChunk(yaffs_Device *dev, int chunkId, int markNAND, int lyn);
+int yaffs_CheckFF(__u8 *buffer, int nBytes);
 void yaffs_HandleChunkError(yaffs_Device *dev, yaffs_BlockInfo *bi);
 
-__u8 *yaffs_GetTempBuffer(yaffs_Device * dev, int lineNo);
-void yaffs_ReleaseTempBuffer(yaffs_Device * dev, __u8 * buffer, int lineNo);
+__u8 *yaffs_GetTempBuffer(yaffs_Device *dev, int lineNo);
+void yaffs_ReleaseTempBuffer(yaffs_Device *dev, __u8 *buffer, int lineNo);
 
 #endif