yaffs_guts.h

   1 /*
   2  * YAFFS: Yet another FFS. A NAND-flash specific file system.
   3  * yaffs_guts.h: Configuration etc for yaffs_guts
   4  *
   5  * Copyright (C) 2002 Aleph One Ltd.
   6  *   for Toby Churchill Ltd and Brightstar Engineering
   7  *
   8  * Created by Charles Manning <charles@aleph1.co.uk>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License version 2 as
  12  * published by the Free Software Foundation.
  13  *
  14  */
  15
  16 #ifndef __YAFFS_GUTS_H__
  17 #define __YAFFS_GUTS_H__
  18
  19 #include "devextras.h"
  20
  21
  22 #define YAFFS_OK        1
  23 #define YAFFS_FAIL  0
  24
  25 // Y=0x59, A=0x41, S=0x53
  26 #define YAFFS_MAGIC                                     0x5941FF53
  27
  28 #define YAFFS_NTNODES_LEVEL0            16
  29 #define YAFFS_TNODES_LEVEL0_BITS        4
  30 #define YAFFS_TNODES_LEVEL0_MASK        0xf
  31
  32 #define YAFFS_NTNODES_INTERNAL          (YAFFS_NTNODES_LEVEL0 / 2)
  33 #define YAFFS_TNODES_INTERNAL_BITS      (YAFFS_TNODES_LEVEL0_BITS - 1)
  34 #define YAFFS_TNODES_INTERNAL_MASK      0x7
  35 #define YAFFS_TNODES_MAX_LEVEL          6
  36
  37 #define YAFFS_BYTES_PER_CHUNK           512
  38 #define YAFFS_CHUNK_SIZE_SHIFT          9
  39
  40 #define YAFFS_BYTES_PER_SPARE           16
  41
  42 #define YAFFS_CHUNKS_PER_BLOCK          32
  43 #define YAFFS_BYTES_PER_BLOCK           (YAFFS_CHUNKS_PER_BLOCK*YAFFS_BYTES_PER_CHUNK)
  44
  45 #define YAFFS_MAX_CHUNK_ID                      0x000FFFFF
  46
  47 #define YAFFS_UNUSED_OBJECT_ID          0x0003FFFF
  48
  49 #define YAFFS_ALLOCATION_NOBJECTS       100
  50 #define YAFFS_ALLOCATION_NTNODES        100
  51 #define YAFFS_ALLOCATION_NLINKS         100
  52
  53 #define YAFFS_NOBJECT_BUCKETS           256
  54
  55
  56 #define YAFFS_RESERVED_BLOCKS           5
  57
  58 #define YAFFS_OBJECT_SPACE                      0x40000
  59 #define YAFFS_MAX_NAME_LENGTH           255
  60
  61 #define YAFFS_MAX_ALIAS_LENGTH          211
  62
  63 #define YAFFS_OBJECTID_ROOT                     1
  64 #define YAFFS_ROOT_MODE                         0666
  65 #define YAFFS_OBJECTID_LOSTNFOUND       2
  66 #define YAFFS_LOSTNFOUND_NAME           "lost+found"
  67
  68 // Tags structures in RAM
  69 // NB This uses bitfield. Bitfields should not stradle a u32 boundary otherwise
  70 // the structure size will get blown out.
  71
  72 typedef struct
  73 {
  74     unsigned chunkId:20;
  75     unsigned serialNumber:2;
  76     unsigned byteCount:10;
  77     unsigned objectId:18;
  78     unsigned ecc:12;
  79     unsigned unusedStuff:2;
  80 } yaffs_Tags;
  81
  82 typedef union
  83 {
  84     yaffs_Tags asTags;
  85     __u8       asBytes[8];
  86 } yaffs_TagsUnion;
  87
  88
  89 // Spare structure
  90 typedef struct
  91 {
  92     __u8  tagByte0;
  93     __u8  tagByte1;
  94     __u8  tagByte2;
  95     __u8  tagByte3;
  96     __u8  pageStatus;
  97     __u8  blockStatus;
  98     __u8  tagByte4;
  99     __u8  tagByte5;
 100     __u8  ecc1[3];
 101     __u8  tagByte6;
 102     __u8  tagByte7;
 103     __u8  ecc2[3];
 104 } yaffs_Spare;
 105
 106 // Block data in RAM
 107
 108 typedef enum {
 109         YAFFS_BLOCK_STATE_UNKNOWN       = 0,
 110
 111         YAFFS_BLOCK_STATE_EMPTY,                // This block is empty
 112
 113         YAFFS_BLOCK_STATE_ALLOCATING,   // This block is partially allocated.
 114                                                                         // This is the one currently being used for page
 115                                                                         // allocation. Should never be more than one of these
 116
 117
 118         YAFFS_BLOCK_STATE_FULL,                 // All the pages in this block have been allocated.
 119                                                                         // At least one page holds valid data.
 120
 121         YAFFS_BLOCK_STATE_DIRTY,                // All pages have been allocated and deleted.
 122                                                                         // Erase me, reuse me.
 123
 124         YAFFS_BLOCK_STATE_DEAD = 0x99   // This block has failed and is not in use
 125
 126 } yaffs_BlockState;
 127
 128
 129
 130
 131 typedef struct
 132 {
 133         __u32 pageBits;   // bitmap of pages in use
 134     __u8  blockState; // One of the above block states
 135     __u8  pagesInUse; // number of pages in use
 136 } yaffs_BlockInfo;
 137
 138
 139 //////////////////// Object structure ///////////////////////////
 140 // This is the object structure as stored on NAND
 141
 142 typedef enum
 143 {
 144         YAFFS_OBJECT_TYPE_UNKNOWN,
 145         YAFFS_OBJECT_TYPE_FILE,
 146         YAFFS_OBJECT_TYPE_SYMLINK,
 147         YAFFS_OBJECT_TYPE_DIRECTORY,
 148         YAFFS_OBJECT_TYPE_HARDLINK
 149 } yaffs_ObjectType;
 150
 151 typedef struct
 152 {
 153         yaffs_ObjectType type;
 154
 155         // Apply to everything
 156         int   parentObjectId;
 157         __u16 sum;      // checksum of name
 158         char  name[YAFFS_MAX_NAME_LENGTH + 1];
 159
 160         // Thes following apply to directories, files, symlinks - not hard links
 161         __u32 st_mode;  // protection
 162         __u32 st_uid;   // user ID of owner
 163         __u32 st_gid;    // group ID of owner
 164         __u32 st_atime; // time of last access
 165         __u32 st_mtime; // time of last modification
 166         __u32 st_ctime; // time of last change
 167
 168         // File size  applies to files only
 169         int fileSize;
 170
 171         // Equivalent object id applies to hard links only.
 172         int  equivalentObjectId;
 173         char alias[YAFFS_MAX_ALIAS_LENGTH + 1];
 174
 175
 176 } yaffs_ObjectHeader;
 177
 178
 179
 180 ////////////////////  Tnode ///////////////////////////
 181
 182 union yaffs_Tnode_union
 183 {
 184         union yaffs_Tnode_union *internal[YAFFS_NTNODES_INTERNAL];
 185         __u16 level0[YAFFS_NTNODES_LEVEL0];
 186
 187 };
 188
 189 typedef union yaffs_Tnode_union yaffs_Tnode;
 190
 191 struct yaffs_TnodeList_struct
 192 {
 193         struct yaffs_TnodeList_struct *next;
 194         yaffs_Tnode *tnodes;
 195 };
 196
 197 typedef struct yaffs_TnodeList_struct yaffs_TnodeList;
 198
 199
 200
 201 ///////////////////  Object ////////////////////////////////
 202 // An object can be one of:
 203 // - a directory (no data, has children links
 204 // - a regular file (data.... not prunes :->).
 205 // - a symlink [symbolic link] (the alias).
 206 // - a hard link
 207
 208
 209 typedef struct
 210 {
 211         __u32 fileSize;
 212         __u32 topLevel;
 213         yaffs_Tnode *top;
 214 } yaffs_FileStructure;
 215
 216 typedef struct
 217 {
 218         struct list_head children; // list of child links
 219 } yaffs_DirectoryStructure;
 220
 221 typedef struct
 222 {
 223         char *alias;
 224 } yaffs_SymLinkStructure;
 225
 226 typedef struct
 227 {
 228         struct yaffs_ObjectStruct *equivalentObject;
 229         __u32   equivalentObjectId;
 230 } yaffs_HardLinkStructure;
 231
 232 typedef union
 233 {
 234         yaffs_FileStructure fileVariant;
 235         yaffs_DirectoryStructure directoryVariant;
 236         yaffs_SymLinkStructure symLinkVariant;
 237         yaffs_HardLinkStructure hardLinkVariant;
 238 } yaffs_ObjectVariant;
 239
 240
 241 struct  yaffs_ObjectStruct
 242 {
 243         __u8 fake:1;                    // A fake object has no presence on NAND.
 244         __u8 renameAllowed:1;
 245         __u8 unlinkAllowed:1;
 246         __u8 dirty:1;                   // the object needs to be written to flash
 247         __u8 valid:1;                   // When the file system is being loaded up, this
 248                                                         // object might be created before the data
 249                                                         // is available (ie. file data records appear before the header).
 250         __u8 serial;                    // serial number of chunk in NAND. Store here so we don't have to
 251                                                         // read back the old one to update.
 252         __u16 sum;                              // sum of the name to speed searching
 253
 254         struct yaffs_DeviceStruct *myDev; // The device I'm on
 255
 256
 257         struct list_head hashLink;      // list of objects in this hash bucket
 258
 259
 260         struct list_head hardLinks; // all the equivalent hard linked objects
 261                                                                 // live on this list
 262         // directory structure stuff
 263         struct yaffs_ObjectStruct  *parent;     //my parent directory
 264         struct list_head siblings;      // siblings in a directory
 265                                                                 // also used for linking up the free list
 266
 267         // Where's my data in NAND?
 268         int chunkId;            // where it lives
 269
 270         __u32 objectId;         // the object id value
 271
 272
 273         __u32 st_mode;          // protection
 274         __u32 st_uid;           // user ID of owner
 275         __u32 st_gid;           // group ID of owner
 276         __u32 st_atime;         // time of last access
 277         __u32 st_mtime;         // time of last modification
 278         __u32 st_ctime;         // time of last change
 279
 280
 281         yaffs_ObjectType variantType;
 282
 283         yaffs_ObjectVariant variant;
 284
 285 };
 286
 287
 288
 289 typedef struct yaffs_ObjectStruct yaffs_Object;
 290
 291
 292 struct yaffs_ObjectList_struct
 293 {
 294         yaffs_Object *objects;
 295         struct yaffs_ObjectList_struct *next;
 296 };
 297
 298 typedef struct yaffs_ObjectList_struct yaffs_ObjectList;
 299
 300 typedef struct
 301 {
 302         struct list_head list;
 303         __u32 count;
 304 } yaffs_ObjectBucket;
 305
 306
 307 //////////////////// Device ////////////////////////////////
 308
 309 struct yaffs_DeviceStruct
 310 {
 311         // Entry parameters set up way early. Yaffs sets up the rest.
 312         __u32 nBlocks;          // Size of whole device in blocks
 313         __u32 startBlock;       // Start block we're allowed to use
 314         __u32 endBlock;         // End block we're allowed to use
 315         __u16 chunkGroupBits; // 0 for devices <= 32MB. else log2(nchunks) - 16
 316         __u16 chunkGroupSize; // == 2^^chunkGroupBits
 317
 318
 319         void *genericDevice; // Pointer to device context
 320                                                  // On an mtd this holds the mtd pointer.
 321         struct semaphore sem;// Semaphore for waiting on erasure.
 322
 323
 324         // NAND access functions (Must be set before calling YAFFS)
 325
 326         int (*writeChunkToNAND)(struct yaffs_DeviceStruct *dev,int chunkInNAND, const __u8 *data, yaffs_Spare *spare);
 327         int (*readChunkFromNAND)(struct yaffs_DeviceStruct *dev,int chunkInNAND, __u8 *data, yaffs_Spare *spare);
 328         int (*eraseBlockInNAND)(struct yaffs_DeviceStruct *dev,int blockInNAND);
 329         int (*initialiseNAND)(struct yaffs_DeviceStruct *dev);
 330
 331
 332
 333         // Runtime parameters.
 334         yaffs_BlockInfo *blockInfo;
 335         int   nErasedBlocks;
 336         int   allocationBlock;
 337         __u32 allocationPage;
 338
 339         // Runtime state
 340         int   nTnodesCreated;
 341         yaffs_Tnode *freeTnodes;
 342         int  nFreeTnodes;
 343         yaffs_TnodeList *allocatedTnodeList;
 344
 345
 346         int   nObjectsCreated;
 347         yaffs_Object *freeObjects;
 348         int   nFreeObjects;
 349
 350         yaffs_ObjectList *allocatedObjectList;
 351
 352         yaffs_ObjectBucket objectBucket[YAFFS_NOBJECT_BUCKETS];
 353
 354         int       nFreeChunks;
 355
 356         int   currentDirtyChecker;      // Used to find current dirtiest block
 357
 358         int   garbageCollectionRequired;
 359
 360         yaffs_Object *rootDir;
 361         yaffs_Object *lostNFoundDir;
 362
 363
 364 };
 365
 366  typedef struct yaffs_DeviceStruct yaffs_Device;
 367
 368
 369
 370 //////////// YAFFS Functions //////////////////
 371
 372 int yaffs_GutsInitialise(yaffs_Device *dev);
 373 void yaffs_Deinitialise(yaffs_Device *dev);
 374
 375 int yaffs_GetNumberOfFreeChunks(yaffs_Device *dev);
 376
 377
 378 // Rename
 379 int yaffs_RenameObject(yaffs_Object *oldDir, const char *oldName, yaffs_Object *newDir, const char *newName);
 380
 381 // generic Object functions
 382 int yaffs_Unlink(yaffs_Object *dir, const char *name);
 383
 384 // Object access functions.
 385 int yaffs_GetObjectName(yaffs_Object *obj,char *name,int buffSize);
 386 int yaffs_GetObjectFileLength(yaffs_Object *obj);
 387 int yaffs_GetObjectInode(yaffs_Object *obj);
 388 unsigned yaffs_GetObjectType(yaffs_Object *obj);
 389 int yaffs_GetObjectLinkCount(yaffs_Object *obj);
 390
 391 // Change inode attributes
 392 int yaffs_SetAttributes(yaffs_Object *obj, struct iattr *attr);
 393 int yaffs_GetAttributes(yaffs_Object *obj, struct iattr *attr);
 394
 395 // File operations
 396 int yaffs_ReadDataFromFile(yaffs_Object *obj, __u8 *buffer, __u32 offset, int nBytes);
 397 int yaffs_WriteDataToFile(yaffs_Object *obj, const __u8 *buffer, __u32 offset, int nBytes);
 398 int yaffs_ResizeFile(yaffs_Object *obj, int newSize);
 399
 400 yaffs_Object *yaffs_MknodFile(yaffs_Object *parent,const char *name, __u32 mode, __u32 uid, __u32 gid);
 401 int yaffs_FlushFile(yaffs_Object *obj);
 402
 403
 404 // Directory operations
 405 yaffs_Object *yaffs_MknodDirectory(yaffs_Object *parent,const char *name, __u32 mode, __u32 uid, __u32 gid);
 406 yaffs_Object *yaffs_FindObjectByName(yaffs_Object *theDir,const char *name);
 407 int yaffs_ApplyToDirectoryChildren(yaffs_Object *theDir,int (*fn)(yaffs_Object *));
 408
 409 yaffs_Object *yaffs_FindObjectByNumber(yaffs_Device *dev,int number);
 410
 411 // Link operations
 412 yaffs_Object *yaffs_Link(yaffs_Object *parent, const char *name, yaffs_Object *equivalentObject);
 413
 414 // Symlink operations
 415 yaffs_Object *yaffs_MknodSymLink(yaffs_Object *parent, const char *name, __u32 mode,  __u32 uid, __u32 gid, const char *alias);
 416 char *yaffs_GetSymlinkAlias(yaffs_Object *obj);
 417
 418
 419 // Special directories
 420 yaffs_Object *yaffs_Root(yaffs_Device *dev);
 421 yaffs_Object *yaffs_LostNFound(yaffs_Device *dev);
 422
 423
 424 // Debug dump
 425 int yaffs_DumpObject(yaffs_Object *obj);
 426
 427
 428 void yaffs_GutsTest(yaffs_Device *dev);
 429
 430
 431 #endif