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; // Currently unused, but sort of set aside to distinguish
  97                                   // unused - vs- used -vs- deleted chunks. We achieve this by
  98                                           // using the objectId tags.
  99     __u8  blockStatus;
 100     __u8  tagByte4;
 101     __u8  tagByte5;
 102     __u8  ecc1[3];
 103     __u8  tagByte6;
 104     __u8  tagByte7;
 105     __u8  ecc2[3];
 106 } yaffs_Spare;
 107
 108 // Block data in RAM
 109
 110 typedef enum {
 111         YAFFS_BLOCK_STATE_UNKNOWN       = 0,
 112
 113         YAFFS_BLOCK_STATE_EMPTY,                // This block is empty
 114
 115         YAFFS_BLOCK_STATE_ALLOCATING,   // This block is partially allocated.
 116                                                                         // This is the one currently being used for page
 117                                                                         // allocation. Should never be more than one of these
 118
 119
 120         YAFFS_BLOCK_STATE_FULL,                 // All the pages in this block have been allocated.
 121                                                                         // At least one page holds valid data.
 122
 123         YAFFS_BLOCK_STATE_DIRTY,                // All pages have been allocated and deleted.
 124                                                                         // Erase me, reuse me.
 125
 126         YAFFS_BLOCK_STATE_DEAD = 0x99   // This block has failed and is not in use
 127
 128 } yaffs_BlockState;
 129
 130
 131
 132
 133 typedef struct
 134 {
 135         __u32 pageBits;   // bitmap of pages in use
 136     __u8  blockState; // One of the above block states
 137     __u8  pagesInUse; // number of pages in use
 138 } yaffs_BlockInfo;
 139
 140
 141 //////////////////// Object structure ///////////////////////////
 142 // This is the object structure as stored on NAND
 143
 144 typedef enum
 145 {
 146         YAFFS_OBJECT_TYPE_UNKNOWN,
 147         YAFFS_OBJECT_TYPE_FILE,
 148         YAFFS_OBJECT_TYPE_SYMLINK,
 149         YAFFS_OBJECT_TYPE_DIRECTORY,
 150         YAFFS_OBJECT_TYPE_HARDLINK
 151 } yaffs_ObjectType;
 152
 153 typedef struct
 154 {
 155         yaffs_ObjectType type;
 156
 157         // Apply to everything
 158         int   parentObjectId;
 159         __u16 sum;      // checksum of name
 160         char  name[YAFFS_MAX_NAME_LENGTH + 1];
 161
 162         // Thes following apply to directories, files, symlinks - not hard links
 163         __u32 st_mode;  // protection
 164         __u32 st_uid;   // user ID of owner
 165         __u32 st_gid;    // group ID of owner
 166         __u32 st_atime; // time of last access
 167         __u32 st_mtime; // time of last modification
 168         __u32 st_ctime; // time of last change
 169
 170         // File size  applies to files only
 171         int fileSize;
 172
 173         // Equivalent object id applies to hard links only.
 174         int  equivalentObjectId;
 175         char alias[YAFFS_MAX_ALIAS_LENGTH + 1];
 176
 177
 178 } yaffs_ObjectHeader;
 179
 180
 181
 182 ////////////////////  Tnode ///////////////////////////
 183
 184 union yaffs_Tnode_union
 185 {
 186         union yaffs_Tnode_union *internal[YAFFS_NTNODES_INTERNAL];
 187         __u16 level0[YAFFS_NTNODES_LEVEL0];
 188
 189 };
 190
 191 typedef union yaffs_Tnode_union yaffs_Tnode;
 192
 193 struct yaffs_TnodeList_struct
 194 {
 195         struct yaffs_TnodeList_struct *next;
 196         yaffs_Tnode *tnodes;
 197 };
 198
 199 typedef struct yaffs_TnodeList_struct yaffs_TnodeList;
 200
 201
 202
 203 ///////////////////  Object ////////////////////////////////
 204 // An object can be one of:
 205 // - a directory (no data, has children links
 206 // - a regular file (data.... not prunes :->).
 207 // - a symlink [symbolic link] (the alias).
 208 // - a hard link
 209
 210
 211 typedef struct
 212 {
 213         __u32 fileSize;
 214         __u32 topLevel;
 215         yaffs_Tnode *top;
 216 } yaffs_FileStructure;
 217
 218 typedef struct
 219 {
 220         struct list_head children; // list of child links
 221 } yaffs_DirectoryStructure;
 222
 223 typedef struct
 224 {
 225         char *alias;
 226 } yaffs_SymLinkStructure;
 227
 228 typedef struct
 229 {
 230         struct yaffs_ObjectStruct *equivalentObject;
 231         __u32   equivalentObjectId;
 232 } yaffs_HardLinkStructure;
 233
 234 typedef union
 235 {
 236         yaffs_FileStructure fileVariant;
 237         yaffs_DirectoryStructure directoryVariant;
 238         yaffs_SymLinkStructure symLinkVariant;
 239         yaffs_HardLinkStructure hardLinkVariant;
 240 } yaffs_ObjectVariant;
 241
 242
 243 struct  yaffs_ObjectStruct
 244 {
 245         __u8 fake:1;                    // A fake object has no presence on NAND.
 246         __u8 renameAllowed:1;
 247         __u8 unlinkAllowed:1;
 248         __u8 dirty:1;                   // the object needs to be written to flash
 249         __u8 valid:1;                   // When the file system is being loaded up, this
 250                                                         // object might be created before the data
 251                                                         // is available (ie. file data records appear before the header).
 252         __u8 serial;                    // serial number of chunk in NAND. Store here so we don't have to
 253                                                         // read back the old one to update.
 254         __u16 sum;                              // sum of the name to speed searching
 255
 256         struct yaffs_DeviceStruct *myDev; // The device I'm on
 257
 258
 259         struct list_head hashLink;      // list of objects in this hash bucket
 260
 261
 262         struct list_head hardLinks; // all the equivalent hard linked objects
 263                                                                 // live on this list
 264         // directory structure stuff
 265         struct yaffs_ObjectStruct  *parent;     //my parent directory
 266         struct list_head siblings;      // siblings in a directory
 267                                                                 // also used for linking up the free list
 268
 269         // Where's my data in NAND?
 270         int chunkId;            // where it lives
 271
 272         __u32 objectId;         // the object id value
 273
 274
 275         __u32 st_mode;          // protection
 276         __u32 st_uid;           // user ID of owner
 277         __u32 st_gid;           // group ID of owner
 278         __u32 st_atime;         // time of last access
 279         __u32 st_mtime;         // time of last modification
 280         __u32 st_ctime;         // time of last change
 281
 282
 283         yaffs_ObjectType variantType;
 284
 285         yaffs_ObjectVariant variant;
 286
 287 };
 288
 289
 290
 291 typedef struct yaffs_ObjectStruct yaffs_Object;
 292
 293
 294 struct yaffs_ObjectList_struct
 295 {
 296         yaffs_Object *objects;
 297         struct yaffs_ObjectList_struct *next;
 298 };
 299
 300 typedef struct yaffs_ObjectList_struct yaffs_ObjectList;
 301
 302 typedef struct
 303 {
 304         struct list_head list;
 305         __u32 count;
 306 } yaffs_ObjectBucket;
 307
 308
 309 //////////////////// Device ////////////////////////////////
 310
 311 struct yaffs_DeviceStruct
 312 {
 313         // Entry parameters set up way early. Yaffs sets up the rest.
 314         __u32 nBlocks;          // Size of whole device in blocks
 315         __u32 startBlock;       // Start block we're allowed to use
 316         __u32 endBlock;         // End block we're allowed to use
 317         __u16 chunkGroupBits; // 0 for devices <= 32MB. else log2(nchunks) - 16
 318         __u16 chunkGroupSize; // == 2^^chunkGroupBits
 319
 320
 321         void *genericDevice; // Pointer to device context
 322                                                  // On an mtd this holds the mtd pointer.
 323
 324 #ifdef __KERNEL__
 325
 326         struct semaphore sem;// Semaphore for waiting on erasure.
 327
 328 #endif
 329
 330
 331         // NAND access functions (Must be set before calling YAFFS)
 332
 333         int (*writeChunkToNAND)(struct yaffs_DeviceStruct *dev,int chunkInNAND, const __u8 *data, yaffs_Spare *spare);
 334         int (*readChunkFromNAND)(struct yaffs_DeviceStruct *dev,int chunkInNAND, __u8 *data, yaffs_Spare *spare);
 335         int (*eraseBlockInNAND)(struct yaffs_DeviceStruct *dev,int blockInNAND);
 336         int (*initialiseNAND)(struct yaffs_DeviceStruct *dev);
 337
 338
 339
 340         // Runtime parameters.
 341         yaffs_BlockInfo *blockInfo;
 342         int   nErasedBlocks;
 343         int   allocationBlock;
 344         __u32 allocationPage;
 345
 346         // Runtime state
 347         int   nTnodesCreated;
 348         yaffs_Tnode *freeTnodes;
 349         int  nFreeTnodes;
 350         yaffs_TnodeList *allocatedTnodeList;
 351
 352
 353         int   nObjectsCreated;
 354         yaffs_Object *freeObjects;
 355         int   nFreeObjects;
 356
 357         yaffs_ObjectList *allocatedObjectList;
 358
 359         yaffs_ObjectBucket objectBucket[YAFFS_NOBJECT_BUCKETS];
 360
 361         int       nFreeChunks;
 362
 363         int   currentDirtyChecker;      // Used to find current dirtiest block
 364
 365         int   garbageCollectionRequired;
 366
 367         yaffs_Object *rootDir;
 368         yaffs_Object *lostNFoundDir;
 369
 370
 371 };
 372
 373  typedef struct yaffs_DeviceStruct yaffs_Device;
 374
 375
 376
 377 //////////// YAFFS Functions //////////////////
 378
 379 int yaffs_GutsInitialise(yaffs_Device *dev);
 380 void yaffs_Deinitialise(yaffs_Device *dev);
 381
 382 int yaffs_GetNumberOfFreeChunks(yaffs_Device *dev);
 383
 384
 385 // Rename
 386 int yaffs_RenameObject(yaffs_Object *oldDir, const char *oldName, yaffs_Object *newDir, const char *newName);
 387
 388 // generic Object functions
 389 int yaffs_Unlink(yaffs_Object *dir, const char *name);
 390
 391 // Object access functions.
 392 int yaffs_GetObjectName(yaffs_Object *obj,char *name,int buffSize);
 393 int yaffs_GetObjectFileLength(yaffs_Object *obj);
 394 int yaffs_GetObjectInode(yaffs_Object *obj);
 395 unsigned yaffs_GetObjectType(yaffs_Object *obj);
 396 int yaffs_GetObjectLinkCount(yaffs_Object *obj);
 397
 398 // Change inode attributes
 399 int yaffs_SetAttributes(yaffs_Object *obj, struct iattr *attr);
 400 int yaffs_GetAttributes(yaffs_Object *obj, struct iattr *attr);
 401
 402 // File operations
 403 int yaffs_ReadDataFromFile(yaffs_Object *obj, __u8 *buffer, __u32 offset, int nBytes);
 404 int yaffs_WriteDataToFile(yaffs_Object *obj, const __u8 *buffer, __u32 offset, int nBytes);
 405 int yaffs_ResizeFile(yaffs_Object *obj, int newSize);
 406
 407 yaffs_Object *yaffs_MknodFile(yaffs_Object *parent,const char *name, __u32 mode, __u32 uid, __u32 gid);
 408 int yaffs_FlushFile(yaffs_Object *obj);
 409
 410
 411 // Directory operations
 412 yaffs_Object *yaffs_MknodDirectory(yaffs_Object *parent,const char *name, __u32 mode, __u32 uid, __u32 gid);
 413 yaffs_Object *yaffs_FindObjectByName(yaffs_Object *theDir,const char *name);
 414 int yaffs_ApplyToDirectoryChildren(yaffs_Object *theDir,int (*fn)(yaffs_Object *));
 415
 416 yaffs_Object *yaffs_FindObjectByNumber(yaffs_Device *dev,int number);
 417
 418 // Link operations
 419 yaffs_Object *yaffs_Link(yaffs_Object *parent, const char *name, yaffs_Object *equivalentObject);
 420
 421 // Symlink operations
 422 yaffs_Object *yaffs_MknodSymLink(yaffs_Object *parent, const char *name, __u32 mode,  __u32 uid, __u32 gid, const char *alias);
 423 char *yaffs_GetSymlinkAlias(yaffs_Object *obj);
 424
 425
 426 // Special directories
 427 yaffs_Object *yaffs_Root(yaffs_Device *dev);
 428 yaffs_Object *yaffs_LostNFound(yaffs_Device *dev);
 429
 430
 431 // Debug dump
 432 int yaffs_DumpObject(yaffs_Object *obj);
 433
 434
 435 void yaffs_GutsTest(yaffs_Device *dev);
 436
 437
 438 #endif