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 Lesser General Public License version 2.1 as
  12  * published by the Free Software Foundation.
  13  *
  14  *
  15  * Note: Only YAFFS headers are LGPL, YAFFS C code is covered by GPL.
  16  *
  17  * $Id: yaffs_guts.h,v 1.14 2003-01-14 23:15:32 charles Exp $
  18  */
  19
  20 #ifndef __YAFFS_GUTS_H__
  21 #define __YAFFS_GUTS_H__
  22
  23 #include "devextras.h"
  24
  25
  26 #define YAFFS_OK        1
  27 #define YAFFS_FAIL  0
  28
  29 // Give us a Y=0x59,
  30 // Give us an A=0x41,
  31 // Give us an FF=0xFF
  32 // Give us an S=0x53
  33 // And what have we got...
  34 #define YAFFS_MAGIC                                     0x5941FF53
  35
  36 #define YAFFS_NTNODES_LEVEL0            16
  37 #define YAFFS_TNODES_LEVEL0_BITS        4
  38 #define YAFFS_TNODES_LEVEL0_MASK        0xf
  39
  40 #define YAFFS_NTNODES_INTERNAL          (YAFFS_NTNODES_LEVEL0 / 2)
  41 #define YAFFS_TNODES_INTERNAL_BITS      (YAFFS_TNODES_LEVEL0_BITS - 1)
  42 #define YAFFS_TNODES_INTERNAL_MASK      0x7
  43 #define YAFFS_TNODES_MAX_LEVEL          6
  44
  45 #define YAFFS_BYTES_PER_SPARE           16
  46
  47 #define YAFFS_BYTES_PER_CHUNK           512
  48 //#define YAFFS_CHUNK_SIZE_SHIFT                9
  49
  50
  51 #define YAFFS_CHUNKS_PER_BLOCK          32
  52 #define YAFFS_BYTES_PER_BLOCK           (YAFFS_CHUNKS_PER_BLOCK*YAFFS_BYTES_PER_CHUNK)
  53
  54 #define YAFFS_MAX_CHUNK_ID                      0x000FFFFF
  55
  56 #define YAFFS_UNUSED_OBJECT_ID          0x0003FFFF
  57
  58 #define YAFFS_ALLOCATION_NOBJECTS       100
  59 #define YAFFS_ALLOCATION_NTNODES        100
  60 #define YAFFS_ALLOCATION_NLINKS         100
  61
  62 #define YAFFS_NOBJECT_BUCKETS           256
  63
  64
  65 #define YAFFS_RESERVED_BLOCKS           8
  66
  67 #define YAFFS_OBJECT_SPACE                      0x40000
  68 #define YAFFS_MAX_NAME_LENGTH           255
  69 #define YAFFS_SHORT_NAME_LENGTH         15
  70
  71 #define YAFFS_MAX_ALIAS_LENGTH          159
  72
  73 #define YAFFS_OBJECTID_ROOT                     1
  74 #define YAFFS_OBJECTID_LOSTNFOUND       2
  75 #define YAFFS_OBJECTID_UNLINKED         3
  76
  77 #define YAFFS_MAX_SHORT_OP_CACHES       20
  78
  79
  80 // ChunkCache is used for short read/write operations.
  81 typedef struct
  82 {
  83         struct yaffs_ObjectStruct *object;
  84         int chunkId;
  85         int lastUse;
  86         int dirty;
  87         int nBytes;     // Only valid if the cache is dirty
  88         __u8 data[YAFFS_BYTES_PER_CHUNK];
  89 } yaffs_ChunkCache;
  90
  91 // Tags structures in RAM
  92 // NB This uses bitfield. Bitfields should not straddle a u32 boundary otherwise
  93 // the structure size will get blown out.
  94
  95 typedef struct
  96 {
  97     unsigned chunkId:20;
  98     unsigned serialNumber:2;
  99     unsigned byteCount:10;
 100     unsigned objectId:18;
 101     unsigned ecc:12;
 102     unsigned unusedStuff:2;
 103 } yaffs_Tags;
 104
 105 typedef union
 106 {
 107     yaffs_Tags asTags;
 108     __u8       asBytes[8];
 109 } yaffs_TagsUnion;
 110
 111
 112 // Spare structure
 113 typedef struct
 114 {
 115     __u8  tagByte0;
 116     __u8  tagByte1;
 117     __u8  tagByte2;
 118     __u8  tagByte3;
 119     __u8  pageStatus;   // set to 0 to delete the chunk
 120     __u8  blockStatus;
 121     __u8  tagByte4;
 122     __u8  tagByte5;
 123     __u8  ecc1[3];
 124     __u8  tagByte6;
 125     __u8  tagByte7;
 126     __u8  ecc2[3];
 127 } yaffs_Spare;
 128
 129 //Special structure for passing through to mtd
 130 struct yaffs_NANDSpare {
 131         yaffs_Spare     spare;
 132         int             eccres1;
 133         int             eccres2;
 134 };
 135
 136 // Block data in RAM
 137
 138 typedef enum {
 139         YAFFS_BLOCK_STATE_UNKNOWN       = 0,
 140         YAFFS_BLOCK_STATE_SCANNING,             // Used while the block is being scanned.
 141                                                                         // NB Don't erase blocks while they're being scanned
 142
 143         YAFFS_BLOCK_STATE_EMPTY,                // This block is empty
 144
 145         YAFFS_BLOCK_STATE_ALLOCATING,   // This block is partially allocated.
 146                                                                         // This is the one currently being used for page
 147                                                                         // allocation. Should never be more than one of these
 148
 149
 150         YAFFS_BLOCK_STATE_FULL,                 // All the pages in this block have been allocated.
 151                                                                         // At least one page holds valid data.
 152
 153         YAFFS_BLOCK_STATE_DIRTY,                // All pages have been allocated and deleted.
 154                                                                         // Erase me, reuse me.
 155
 156         YAFFS_BLOCK_STATE_DEAD                  // This block has failed and is not in use
 157
 158 } yaffs_BlockState;
 159
 160
 161
 162
 163 typedef struct
 164 {
 165 #ifndef CONFIG_YAFFS_NO_YAFFS2
 166         __u32 sequenceNumber;   // block sequence number for yaffs2
 167 #endif
 168         int   softDeletions:8;  // number of soft deleted pages
 169     int   pagesInUse:8;         // number of pages in use
 170     __u32 blockState:4;         // One of the above block states
 171     __u32 needsRetiring:1;      // Data has failed on this block, need to get valid data off
 172                                                 // and retire the block.
 173 } yaffs_BlockInfo;
 174
 175
 176 //////////////////// Object structure ///////////////////////////
 177 // This is the object structure as stored on NAND
 178
 179 typedef enum
 180 {
 181         YAFFS_OBJECT_TYPE_UNKNOWN,
 182         YAFFS_OBJECT_TYPE_FILE,
 183         YAFFS_OBJECT_TYPE_SYMLINK,
 184         YAFFS_OBJECT_TYPE_DIRECTORY,
 185         YAFFS_OBJECT_TYPE_HARDLINK,
 186         YAFFS_OBJECT_TYPE_SPECIAL
 187 } yaffs_ObjectType;
 188
 189 typedef struct
 190 {
 191         yaffs_ObjectType type;
 192
 193         // Apply to everything
 194         int   parentObjectId;
 195         __u16 sum__NoLongerUsed;        // checksum of name. Calc this off the name to prevent inconsistencies
 196         char  name[YAFFS_MAX_NAME_LENGTH + 1];
 197
 198         // Thes following apply to directories, files, symlinks - not hard links
 199         __u32 st_mode;  // protection
 200
 201 #ifdef CONFIG_YAFFS_WINCE
 202         __u32 notForWinCE[5];
 203 #else
 204         __u32 st_uid;   // user ID of owner
 205         __u32 st_gid;    // group ID of owner
 206         __u32 st_atime; // time of last access
 207         __u32 st_mtime; // time of last modification
 208         __u32 st_ctime; // time of last change
 209 #endif
 210
 211         // File size  applies to files only
 212         int fileSize;
 213
 214         // Equivalent object id applies to hard links only.
 215         int  equivalentObjectId;
 216
 217         // Alias is for symlinks only.
 218         char alias[YAFFS_MAX_ALIAS_LENGTH + 1];
 219
 220         __u32 st_rdev;  // device stuff for block and char devices (maj/min)
 221
 222 #ifdef CONFIG_YAFFS_WINCE
 223         __u32 win_ctime[2];
 224         __u32 win_atime[2];
 225         __u32 win_mtime[2];
 226         __u32 roomToGrow[6];
 227 #else
 228         __u32 roomToGrow[12];
 229 #endif
 230
 231 } yaffs_ObjectHeader;
 232
 233
 234
 235 ////////////////////  Tnode ///////////////////////////
 236
 237 union yaffs_Tnode_union
 238 {
 239 #ifdef CONFIG_YAFFS_TNODE_LIST_DEBUG
 240         union yaffs_Tnode_union *internal[YAFFS_NTNODES_INTERNAL+1];
 241 #else
 242         union yaffs_Tnode_union *internal[YAFFS_NTNODES_INTERNAL];
 243 #endif
 244         __u16 level0[YAFFS_NTNODES_LEVEL0];
 245
 246 };
 247
 248 typedef union yaffs_Tnode_union yaffs_Tnode;
 249
 250 struct yaffs_TnodeList_struct
 251 {
 252         struct yaffs_TnodeList_struct *next;
 253         yaffs_Tnode *tnodes;
 254 };
 255
 256 typedef struct yaffs_TnodeList_struct yaffs_TnodeList;
 257
 258
 259
 260 ///////////////////  Object ////////////////////////////////
 261 // An object can be one of:
 262 // - a directory (no data, has children links
 263 // - a regular file (data.... not prunes :->).
 264 // - a symlink [symbolic link] (the alias).
 265 // - a hard link
 266
 267
 268 typedef struct
 269 {
 270         __u32 fileSize;
 271         __u32 scannedFileSize;
 272         int   topLevel;
 273         yaffs_Tnode *top;
 274 } yaffs_FileStructure;
 275
 276 typedef struct
 277 {
 278         struct list_head children; // list of child links
 279 } yaffs_DirectoryStructure;
 280
 281 typedef struct
 282 {
 283         char *alias;
 284 } yaffs_SymLinkStructure;
 285
 286 typedef struct
 287 {
 288         struct yaffs_ObjectStruct *equivalentObject;
 289         __u32   equivalentObjectId;
 290 } yaffs_HardLinkStructure;
 291
 292 typedef union
 293 {
 294         yaffs_FileStructure fileVariant;
 295         yaffs_DirectoryStructure directoryVariant;
 296         yaffs_SymLinkStructure symLinkVariant;
 297         yaffs_HardLinkStructure hardLinkVariant;
 298 } yaffs_ObjectVariant;
 299
 300
 301 struct  yaffs_ObjectStruct
 302 {
 303         __u8 deleted: 1;                // This should only apply to unlinked files.
 304         __u8 softDeleted: 1;    // it has also been soft deleted
 305         __u8 unlinked: 1;               // An unlinked file. The file should be in the unlinked pseudo directory.
 306         __u8 fake:1;                    // A fake object has no presence on NAND.
 307         __u8 renameAllowed:1;
 308         __u8 unlinkAllowed:1;
 309         __u8 dirty:1;                   // the object needs to be written to flash
 310         __u8 valid:1;                   // When the file system is being loaded up, this
 311                                                         // object might be created before the data
 312                                                         // is available (ie. file data records appear before the header).
 313         __u8 serial;                    // serial number of chunk in NAND. Store here so we don't have to
 314                                                         // read back the old one to update.
 315         __u16 sum;                              // sum of the name to speed searching
 316
 317         struct yaffs_DeviceStruct *myDev; // The device I'm on
 318
 319
 320         struct list_head hashLink;      // list of objects in this hash bucket
 321
 322
 323         struct list_head hardLinks; // all the equivalent hard linked objects
 324                                                                 // live on this list
 325         // directory structure stuff
 326         struct yaffs_ObjectStruct  *parent;     //my parent directory
 327         struct list_head siblings;      // siblings in a directory
 328                                                                 // also used for linking up the free list
 329
 330         // Where's my data in NAND?
 331         int chunkId;            // where it lives
 332
 333         int nDataChunks;
 334
 335         __u32 objectId;         // the object id value
 336
 337
 338         __u32 st_mode;          // protection
 339
 340 #ifdef CONFIG_YAFFS_SHORT_NAMES_IN_RAM
 341         char shortName[YAFFS_SHORT_NAME_LENGTH+1];
 342 #endif
 343
 344 #ifndef __KERNEL__
 345         __u32 inUse;
 346 #endif
 347
 348 #ifdef CONFIG_YAFFS_WINCE
 349         __u32 win_ctime[2];
 350         __u32 win_mtime[2];
 351         __u32 win_atime[2];
 352 #else
 353         __u32 st_uid;           // user ID of owner
 354         __u32 st_gid;           // group ID of owner
 355         __u32 st_atime;         // time of last access
 356         __u32 st_mtime;         // time of last modification
 357         __u32 st_ctime;         // time of last change
 358 #endif
 359
 360         __u32 st_rdev;      // device stuff for block and char devices
 361
 362
 363
 364 #ifdef __KERNEL__
 365         struct inode *myInode;
 366 #endif
 367
 368
 369
 370         yaffs_ObjectType variantType;
 371
 372         yaffs_ObjectVariant variant;
 373
 374 };
 375
 376
 377
 378 typedef struct yaffs_ObjectStruct yaffs_Object;
 379
 380
 381 struct yaffs_ObjectList_struct
 382 {
 383         yaffs_Object *objects;
 384         struct yaffs_ObjectList_struct *next;
 385 };
 386
 387 typedef struct yaffs_ObjectList_struct yaffs_ObjectList;
 388
 389 typedef struct
 390 {
 391         struct list_head list;
 392         int count;
 393 } yaffs_ObjectBucket;
 394
 395
 396 //////////////////// Device ////////////////////////////////
 397
 398 struct yaffs_DeviceStruct
 399 {
 400         // Entry parameters set up way early. Yaffs sets up the rest.
 401         int   nBytesPerChunk;    // Should be a power of 2 >= 512
 402         int       nChunksPerBlock;
 403         int   startBlock;       // Start block we're allowed to use
 404         int   endBlock;         // End block we're allowed to use
 405
 406         int   useNANDECC;               // Flag to decide whether or not to use NANDECC
 407         int   nShortOpCaches;   // If <= 0, then short op caching is disabled, else
 408                                                         // the number of short op caches (don't use too many).
 409
 410
 411         void *genericDevice; // Pointer to device context
 412                                                  // On an mtd this holds the mtd pointer.
 413
 414         // NAND access functions (Must be set before calling YAFFS)
 415
 416         int (*writeChunkToNAND)(struct yaffs_DeviceStruct *dev,int chunkInNAND, const __u8 *data, yaffs_Spare *spare);
 417         int (*readChunkFromNAND)(struct yaffs_DeviceStruct *dev,int chunkInNAND, __u8 *data, yaffs_Spare *spare);
 418         int (*eraseBlockInNAND)(struct yaffs_DeviceStruct *dev,int blockInNAND);
 419         int (*initialiseNAND)(struct yaffs_DeviceStruct *dev);
 420
 421         // Runtime parameters. Set up by YAFFS.
 422
 423         __u16 chunkGroupBits; // 0 for devices <= 32MB. else log2(nchunks) - 16
 424         __u16 chunkGroupSize; // == 2^^chunkGroupBits
 425
 426 #ifdef __KERNEL__
 427
 428         struct semaphore sem;// Semaphore for waiting on erasure.
 429         struct semaphore grossLock; // Gross locking semaphore
 430
 431 #endif
 432 #ifdef __KERNEL__
 433         void (*putSuperFunc)(struct super_block *sb);
 434 #endif
 435
 436         int isMounted;
 437
 438         // Block Info
 439         yaffs_BlockInfo *blockInfo;
 440         __u8 *chunkBits;   // bitmap of chunks in use
 441         int   chunkBitmapStride; // Number of bytes of chunkBits per block.
 442                                                          //     Must be consistent with nChunksPerBlock.
 443
 444
 445         int   nErasedBlocks;
 446         int   allocationBlock;                  // Current block being allocated off
 447         __u32 allocationPage;
 448         int   allocationBlockFinder;    // Used to search for next allocation block
 449
 450         // Runtime state
 451         int   nTnodesCreated;
 452         yaffs_Tnode *freeTnodes;
 453         int  nFreeTnodes;
 454         yaffs_TnodeList *allocatedTnodeList;
 455
 456
 457         int   nObjectsCreated;
 458         yaffs_Object *freeObjects;
 459         int   nFreeObjects;
 460
 461         yaffs_ObjectList *allocatedObjectList;
 462
 463         yaffs_ObjectBucket objectBucket[YAFFS_NOBJECT_BUCKETS];
 464
 465         int       nFreeChunks;
 466
 467         int   currentDirtyChecker;      // Used to find current dirtiest block
 468
 469         int   garbageCollectionRequired;
 470
 471         // Operations since mount
 472         int nPageWrites;
 473         int nPageReads;
 474         int nBlockErasures;
 475         int nGCCopies;
 476         int garbageCollections;
 477         int nRetriedWrites;
 478         int nRetiredBlocks;
 479         int eccFixed;
 480         int eccUnfixed;
 481         int tagsEccFixed;
 482         int tagsEccUnfixed;
 483         int nDeletions;
 484         int nUnmarkedDeletions;
 485
 486         yaffs_Object *rootDir;
 487         yaffs_Object *lostNFoundDir;
 488
 489         // Buffer areas for storing data to recover from write failures
 490 //      __u8            bufferedData[YAFFS_CHUNKS_PER_BLOCK][YAFFS_BYTES_PER_CHUNK];
 491 //      yaffs_Spare bufferedSpare[YAFFS_CHUNKS_PER_BLOCK];
 492         int bufferedBlock;      // Which block is buffered here?
 493         int doingBufferedBlockRewrite;
 494
 495         int blockSelectedForGC;
 496
 497         yaffs_ChunkCache *srCache;
 498         int srLastUse;
 499
 500         int cacheHits;
 501
 502         // Stuff for background deletion and unlinked files.
 503         yaffs_Object *unlinkedDir;              // Directory where unlinked and deleted files live.
 504         yaffs_Object *unlinkedDeletion; // Current file being background deleted.
 505         int nDeletedFiles;                              // Count of files awaiting deletion;
 506         int nUnlinkedFiles;                             // Count of unlinked files.
 507         int nBackgroundDeletions;                       // Count of background deletions.
 508
 509         __u8 *localBuffer;
 510
 511 };
 512
 513 typedef struct yaffs_DeviceStruct yaffs_Device;
 514
 515
 516
 517 //////////// YAFFS Functions //////////////////
 518
 519 int yaffs_GutsInitialise(yaffs_Device *dev);
 520 void yaffs_Deinitialise(yaffs_Device *dev);
 521
 522 int yaffs_GetNumberOfFreeChunks(yaffs_Device *dev);
 523
 524
 525 // Rename
 526 int yaffs_RenameObject(yaffs_Object *oldDir, const char *oldName, yaffs_Object *newDir, const char *newName);
 527
 528 // generic Object functions
 529 int yaffs_Unlink(yaffs_Object *dir, const char *name);
 530 int yaffs_DeleteFile(yaffs_Object *obj);
 531
 532 // Object access functions.
 533 int yaffs_GetObjectName(yaffs_Object *obj,char *name,int buffSize);
 534 int yaffs_GetObjectFileLength(yaffs_Object *obj);
 535 int yaffs_GetObjectInode(yaffs_Object *obj);
 536 unsigned yaffs_GetObjectType(yaffs_Object *obj);
 537 int yaffs_GetObjectLinkCount(yaffs_Object *obj);
 538
 539 // Change inode attributes
 540 int yaffs_SetAttributes(yaffs_Object *obj, struct iattr *attr);
 541 int yaffs_GetAttributes(yaffs_Object *obj, struct iattr *attr);
 542
 543 // File operations
 544 int yaffs_ReadDataFromFile(yaffs_Object *obj, __u8 *buffer, __u32 offset, int nBytes);
 545 int yaffs_WriteDataToFile(yaffs_Object *obj, const __u8 *buffer, __u32 offset, int nBytes);
 546 int yaffs_ResizeFile(yaffs_Object *obj, int newSize);
 547
 548 yaffs_Object *yaffs_MknodFile(yaffs_Object *parent,const char *name, __u32 mode, __u32 uid, __u32 gid);
 549 int yaffs_FlushFile(yaffs_Object *obj,int updateTime);
 550
 551
 552 // Directory operations
 553 yaffs_Object *yaffs_MknodDirectory(yaffs_Object *parent,const char *name, __u32 mode, __u32 uid, __u32 gid);
 554 yaffs_Object *yaffs_FindObjectByName(yaffs_Object *theDir,const char *name);
 555 int yaffs_ApplyToDirectoryChildren(yaffs_Object *theDir,int (*fn)(yaffs_Object *));
 556
 557 yaffs_Object *yaffs_FindObjectByNumber(yaffs_Device *dev,__u32 number);
 558
 559 // Link operations
 560 yaffs_Object *yaffs_Link(yaffs_Object *parent, const char *name, yaffs_Object *equivalentObject);
 561
 562 yaffs_Object *yaffs_GetEquivalentObject(yaffs_Object *obj);
 563
 564 // Symlink operations
 565 yaffs_Object *yaffs_MknodSymLink(yaffs_Object *parent, const char *name, __u32 mode,  __u32 uid, __u32 gid, const char *alias);
 566 char *yaffs_GetSymlinkAlias(yaffs_Object *obj);
 567
 568 // Special inodes (fifos, sockets and devices)
 569 yaffs_Object *yaffs_MknodSpecial(yaffs_Object *parent,const char *name, __u32 mode, __u32 uid, __u32 gid,__u32 rdev);
 570
 571
 572 // Special directories
 573 yaffs_Object *yaffs_Root(yaffs_Device *dev);
 574 yaffs_Object *yaffs_LostNFound(yaffs_Device *dev);
 575
 576 #ifdef CONFIG_YAFFS_WINCE
 577 // CONFIG_YAFFS_WINCE special stuff
 578 void  yfsd_WinFileTimeNow(__u32 target[2]);
 579 #endif
 580
 581
 582 // Debug dump
 583 int yaffs_DumpObject(yaffs_Object *obj);
 584
 585
 586 void yaffs_GutsTest(yaffs_Device *dev);
 587
 588
 589 #endif
 590