yaffs_guts.h

   1 /*
   2  * YAFFS: Yet another Flash File System . A NAND-flash specific file system.
   3  *
   4  * Copyright (C) 2002-2011 Aleph One Ltd.
   5  *   for Toby Churchill Ltd and Brightstar Engineering
   6  *
   7  * Created by Charles Manning <charles@aleph1.co.uk>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU Lesser General Public License version 2.1 as
  11  * published by the Free Software Foundation.
  12  *
  13  * Note: Only YAFFS headers are LGPL, YAFFS C code is covered by GPL.
  14  */
  15
  16 #ifndef __YAFFS_GUTS_H__
  17 #define __YAFFS_GUTS_H__
  18
  19 #include "yportenv.h"
  20
  21 #define YAFFS_OK        1
  22 #define YAFFS_FAIL  0
  23
  24 /* Give us a  Y=0x59,
  25  * Give us an A=0x41,
  26  * Give us an FF=0xff
  27  * Give us an S=0x53
  28  * And what have we got...
  29  */
  30 #define YAFFS_MAGIC                     0x5941ff53
  31
  32 /*
  33  * Tnodes form a tree with the tnodes in "levels"
  34  * Levels greater than 0 hold 8 slots which point to other tnodes.
  35  * Those at level 0 hold 16 slots which point to chunks in NAND.
  36  *
  37  * A maximum level of 8 thust supports files of size up to:
  38  *
  39  * 2^(3*MAX_LEVEL+4)
  40  *
  41  * Thus a max level of 8 supports files with up to 2^^28 chunks which gives
  42  * a maximum file size of arounf 51Gbytees with 2k chunks.
  43  */
  44 #define YAFFS_NTNODES_LEVEL0            16
  45 #define YAFFS_TNODES_LEVEL0_BITS        4
  46 #define YAFFS_TNODES_LEVEL0_MASK        0xf
  47
  48 #define YAFFS_NTNODES_INTERNAL          (YAFFS_NTNODES_LEVEL0 / 2)
  49 #define YAFFS_TNODES_INTERNAL_BITS      (YAFFS_TNODES_LEVEL0_BITS - 1)
  50 #define YAFFS_TNODES_INTERNAL_MASK      0x7
  51 #define YAFFS_TNODES_MAX_LEVEL          8
  52 #define YAFFS_TNODES_MAX_BITS           (YAFFS_TNODES_LEVEL0_BITS + \
  53                                         YAFFS_TNODES_INTERNAL_BITS * \
  54                                         YAFFS_TNODES_MAX_LEVEL)
  55 #define YAFFS_MAX_CHUNK_ID              ((1 << YAFFS_TNODES_MAX_BITS) - 1)
  56
  57 /* Constants for YAFFS1 mode */
  58 #define YAFFS_BYTES_PER_SPARE           16
  59 #define YAFFS_BYTES_PER_CHUNK           512
  60 #define YAFFS_CHUNK_SIZE_SHIFT          9
  61 #define YAFFS_CHUNKS_PER_BLOCK          32
  62 #define YAFFS_BYTES_PER_BLOCK   (YAFFS_CHUNKS_PER_BLOCK*YAFFS_BYTES_PER_CHUNK)
  63
  64 #define YAFFS_MIN_YAFFS2_CHUNK_SIZE     1024
  65 #define YAFFS_MIN_YAFFS2_SPARE_SIZE     32
  66
  67
  68
  69 #define YAFFS_ALLOCATION_NOBJECTS       100
  70 #define YAFFS_ALLOCATION_NTNODES        100
  71 #define YAFFS_ALLOCATION_NLINKS         100
  72
  73 #define YAFFS_NOBJECT_BUCKETS           256
  74
  75 #define YAFFS_OBJECT_SPACE              0x40000
  76 #define YAFFS_MAX_OBJECT_ID             (YAFFS_OBJECT_SPACE - 1)
  77
  78 #define YAFFS_CHECKPOINT_VERSION        5
  79
  80 #ifdef CONFIG_YAFFS_UNICODE
  81 #define YAFFS_MAX_NAME_LENGTH           127
  82 #define YAFFS_MAX_ALIAS_LENGTH          79
  83 #else
  84 #define YAFFS_MAX_NAME_LENGTH           255
  85 #define YAFFS_MAX_ALIAS_LENGTH          159
  86 #endif
  87
  88 #define YAFFS_SHORT_NAME_LENGTH         15
  89
  90 /* Some special object ids for pseudo objects */
  91 #define YAFFS_OBJECTID_ROOT             1
  92 #define YAFFS_OBJECTID_LOSTNFOUND       2
  93 #define YAFFS_OBJECTID_UNLINKED         3
  94 #define YAFFS_OBJECTID_DELETED          4
  95
  96 /* Fake object Id for summary data */
  97 #define YAFFS_OBJECTID_SUMMARY          0x10
  98
  99 /* Pseudo object ids for checkpointing */
 100 #define YAFFS_OBJECTID_CHECKPOINT_DATA  0x20
 101 #define YAFFS_SEQUENCE_CHECKPOINT_DATA  0x21
 102
 103 #define YAFFS_MAX_SHORT_OP_CACHES       20
 104
 105 #define YAFFS_N_TEMP_BUFFERS            6
 106
 107 /* We limit the number attempts at sucessfully saving a chunk of data.
 108  * Small-page devices have 32 pages per block; large-page devices have 64.
 109  * Default to something in the order of 5 to 10 blocks worth of chunks.
 110  */
 111 #define YAFFS_WR_ATTEMPTS               (5*64)
 112
 113 /* Sequence numbers are used in YAFFS2 to determine block allocation order.
 114  * The range is limited slightly to help distinguish bad numbers from good.
 115  * This also allows us to perhaps in the future use special numbers for
 116  * special purposes.
 117  * EFFFFF00 allows the allocation of 8 blocks/second (~1Mbytes) for 15 years,
 118  * and is a larger number than the lifetime of a 2GB device.
 119  */
 120 #define YAFFS_LOWEST_SEQUENCE_NUMBER    0x00001000
 121 #define YAFFS_HIGHEST_SEQUENCE_NUMBER   0xefffff00
 122
 123 /* Special sequence number for bad block that failed to be marked bad */
 124 #define YAFFS_SEQUENCE_BAD_BLOCK        0xffff0000
 125
 126 /* ChunkCache is used for short read/write operations.*/
 127 struct yaffs_cache {
 128         struct yaffs_obj *object;
 129         int chunk_id;
 130         int last_use;
 131         int dirty;
 132         int n_bytes;            /* Only valid if the cache is dirty */
 133         int locked;             /* Can't push out or flush while locked. */
 134         u8 *data;
 135 };
 136
 137 /* yaffs1 tags structures in RAM
 138  * NB This uses bitfield. Bitfields should not straddle a u32 boundary
 139  * otherwise the structure size will get blown out.
 140  */
 141
 142 struct yaffs_tags {
 143         unsigned chunk_id:20;
 144         unsigned serial_number:2;
 145         unsigned n_bytes_lsb:10;
 146         unsigned obj_id:18;
 147         unsigned ecc:12;
 148         unsigned n_bytes_msb:2;
 149 };
 150
 151 union yaffs_tags_union {
 152         struct yaffs_tags as_tags;
 153         u8 as_bytes[8];
 154 };
 155
 156
 157 /* Stuff used for extended tags in YAFFS2 */
 158
 159 enum yaffs_ecc_result {
 160         YAFFS_ECC_RESULT_UNKNOWN,
 161         YAFFS_ECC_RESULT_NO_ERROR,
 162         YAFFS_ECC_RESULT_FIXED,
 163         YAFFS_ECC_RESULT_UNFIXED
 164 };
 165
 166 enum yaffs_obj_type {
 167         YAFFS_OBJECT_TYPE_UNKNOWN,
 168         YAFFS_OBJECT_TYPE_FILE,
 169         YAFFS_OBJECT_TYPE_SYMLINK,
 170         YAFFS_OBJECT_TYPE_DIRECTORY,
 171         YAFFS_OBJECT_TYPE_HARDLINK,
 172         YAFFS_OBJECT_TYPE_SPECIAL
 173 };
 174
 175 #define YAFFS_OBJECT_TYPE_MAX YAFFS_OBJECT_TYPE_SPECIAL
 176
 177 struct yaffs_ext_tags {
 178         unsigned chunk_used;    /*  Status of the chunk: used or unused */
 179         unsigned obj_id;        /* If 0 this is not used */
 180         unsigned chunk_id;      /* If 0 this is a header, else a data chunk */
 181         unsigned n_bytes;       /* Only valid for data chunks */
 182
 183         /* The following stuff only has meaning when we read */
 184         enum yaffs_ecc_result ecc_result;
 185         unsigned block_bad;
 186
 187         /* YAFFS 1 stuff */
 188         unsigned is_deleted;    /* The chunk is marked deleted */
 189         unsigned serial_number; /* Yaffs1 2-bit serial number */
 190
 191         /* YAFFS2 stuff */
 192         unsigned seq_number;    /* The sequence number of this block */
 193
 194         /* Extra info if this is an object header (YAFFS2 only) */
 195
 196         unsigned extra_available;       /* Extra info available if not zero */
 197         unsigned extra_parent_id;       /* The parent object */
 198         unsigned extra_is_shrink;       /* Is it a shrink header? */
 199         unsigned extra_shadows; /* Does this shadow another object? */
 200
 201         enum yaffs_obj_type extra_obj_type;     /* What object type? */
 202
 203         loff_t extra_file_size;         /* Length if it is a file */
 204         unsigned extra_equiv_id;        /* Equivalent object for a hard link */
 205 };
 206
 207 /* Spare structure for YAFFS1 */
 208 struct yaffs_spare {
 209         u8 tb0;
 210         u8 tb1;
 211         u8 tb2;
 212         u8 tb3;
 213         u8 page_status;         /* set to 0 to delete the chunk */
 214         u8 block_status;
 215         u8 tb4;
 216         u8 tb5;
 217         u8 ecc1[3];
 218         u8 tb6;
 219         u8 tb7;
 220         u8 ecc2[3];
 221 };
 222
 223 /*Special structure for passing through to mtd */
 224 struct yaffs_nand_spare {
 225         struct yaffs_spare spare;
 226         int eccres1;
 227         int eccres2;
 228 };
 229
 230 /* Block data in RAM */
 231
 232 enum yaffs_block_state {
 233         YAFFS_BLOCK_STATE_UNKNOWN = 0,
 234
 235         YAFFS_BLOCK_STATE_SCANNING,
 236         /* Being scanned */
 237
 238         YAFFS_BLOCK_STATE_NEEDS_SCAN,
 239         /* The block might have something on it (ie it is allocating or full,
 240          * perhaps empty) but it needs to be scanned to determine its true
 241          * state.
 242          * This state is only valid during scanning.
 243          * NB We tolerate empty because the pre-scanner might be incapable of
 244          * deciding
 245          * However, if this state is returned on a YAFFS2 device,
 246          * then we expect a sequence number
 247          */
 248
 249         YAFFS_BLOCK_STATE_EMPTY,
 250         /* This block is empty */
 251
 252         YAFFS_BLOCK_STATE_ALLOCATING,
 253         /* This block is partially allocated.
 254          * At least one page holds valid data.
 255          * This is the one currently being used for page
 256          * allocation. Should never be more than one of these.
 257          * If a block is only partially allocated at mount it is treated as
 258          * full.
 259          */
 260
 261         YAFFS_BLOCK_STATE_FULL,
 262         /* All the pages in this block have been allocated.
 263          * If a block was only partially allocated when mounted we treat
 264          * it as fully allocated.
 265          */
 266
 267         YAFFS_BLOCK_STATE_DIRTY,
 268         /* The block was full and now all chunks have been deleted.
 269          * Erase me, reuse me.
 270          */
 271
 272         YAFFS_BLOCK_STATE_CHECKPOINT,
 273         /* This block is assigned to holding checkpoint data. */
 274
 275         YAFFS_BLOCK_STATE_COLLECTING,
 276         /* This block is being garbage collected */
 277
 278         YAFFS_BLOCK_STATE_DEAD
 279             /* This block has failed and is not in use */
 280 };
 281
 282 #define YAFFS_NUMBER_OF_BLOCK_STATES (YAFFS_BLOCK_STATE_DEAD + 1)
 283
 284 struct yaffs_block_info {
 285
 286         int soft_del_pages:10;  /* number of soft deleted pages */
 287         int pages_in_use:10;    /* number of pages in use */
 288         unsigned block_state:4; /* One of the above block states. */
 289                                 /* NB use unsigned because enum is sometimes
 290                                  * an int */
 291         u32 needs_retiring:1;   /* Data has failed on this block, */
 292                                 /*need to get valid data off and retire*/
 293         u32 skip_erased_check:1;/* Skip the erased check on this block */
 294         u32 gc_prioritise:1;    /* An ECC check or blank check has failed.
 295                                    Block should be prioritised for GC */
 296         u32 chunk_error_strikes:3;      /* How many times we've had ecc etc
 297                                 failures on this block and tried to reuse it */
 298         u32 has_summary:1;      /* The block has a summary */
 299
 300         u32 has_shrink_hdr:1;   /* This block has at least one shrink header */
 301         u32 seq_number;         /* block sequence number for yaffs2 */
 302
 303 };
 304
 305 /* -------------------------- Object structure -------------------------------*/
 306 /* This is the object structure as stored on NAND */
 307
 308 struct yaffs_obj_hdr {
 309         enum yaffs_obj_type type;
 310
 311         /* Apply to everything  */
 312         int parent_obj_id;
 313         u16 sum_no_longer_used; /* checksum of name. No longer used */
 314         YCHAR name[YAFFS_MAX_NAME_LENGTH + 1];
 315
 316         /* The following apply to all object types except for hard links */
 317         u32 yst_mode;           /* protection */
 318
 319         u32 yst_uid;
 320         u32 yst_gid;
 321         u32 yst_atime;
 322         u32 yst_mtime;
 323         u32 yst_ctime;
 324
 325         /* File size  applies to files only */
 326         u32 file_size_low;
 327
 328         /* Equivalent object id applies to hard links only. */
 329         int equiv_id;
 330
 331         /* Alias is for symlinks only. */
 332         YCHAR alias[YAFFS_MAX_ALIAS_LENGTH + 1];
 333
 334         u32 yst_rdev;   /* stuff for block and char devices (major/min) */
 335
 336         u32 win_ctime[2];
 337         u32 win_atime[2];
 338         u32 win_mtime[2];
 339
 340         u32 inband_shadowed_obj_id;
 341         u32 inband_is_shrink;
 342
 343         u32 file_size_high;
 344         u32 reserved[1];
 345         int shadows_obj;        /* This object header shadows the
 346                                 specified object if > 0 */
 347
 348         /* is_shrink applies to object headers written when wemake a hole. */
 349         u32 is_shrink;
 350
 351 };
 352
 353 /*--------------------------- Tnode -------------------------- */
 354
 355 struct yaffs_tnode {
 356         struct yaffs_tnode *internal[YAFFS_NTNODES_INTERNAL];
 357 };
 358
 359 /*------------------------  Object -----------------------------*/
 360 /* An object can be one of:
 361  * - a directory (no data, has children links
 362  * - a regular file (data.... not prunes :->).
 363  * - a symlink [symbolic link] (the alias).
 364  * - a hard link
 365  */
 366
 367 struct yaffs_file_var {
 368         loff_t file_size;
 369         loff_t scanned_size;
 370         loff_t shrink_size;
 371         int top_level;
 372         struct yaffs_tnode *top;
 373 };
 374
 375 struct yaffs_dir_var {
 376         struct list_head children;      /* list of child links */
 377         struct list_head dirty; /* Entry for list of dirty directories */
 378 };
 379
 380 struct yaffs_symlink_var {
 381         YCHAR *alias;
 382 };
 383
 384 struct yaffs_hardlink_var {
 385         struct yaffs_obj *equiv_obj;
 386         u32 equiv_id;
 387 };
 388
 389 union yaffs_obj_var {
 390         struct yaffs_file_var file_variant;
 391         struct yaffs_dir_var dir_variant;
 392         struct yaffs_symlink_var symlink_variant;
 393         struct yaffs_hardlink_var hardlink_variant;
 394 };
 395
 396 struct yaffs_obj {
 397         u8 deleted:1;           /* This should only apply to unlinked files. */
 398         u8 soft_del:1;          /* it has also been soft deleted */
 399         u8 unlinked:1;          /* An unlinked file.*/
 400         u8 fake:1;              /* A fake object has no presence on NAND. */
 401         u8 rename_allowed:1;    /* Some objects cannot be renamed. */
 402         u8 unlink_allowed:1;
 403         u8 dirty:1;             /* the object needs to be written to flash */
 404         u8 valid:1;             /* When the file system is being loaded up, this
 405                                  * object might be created before the data
 406                                  * is available
 407                                  * ie. file data chunks encountered before
 408                                 * the header.
 409                                  */
 410         u8 lazy_loaded:1;       /* This object has been lazy loaded and
 411                                  * is missing some detail */
 412
 413         u8 defered_free:1;      /* Object is removed from NAND, but is
 414                                  * still in the inode cache.
 415                                  * Free of object is defered.
 416                                  * until the inode is released.
 417                                  */
 418         u8 being_created:1;     /* This object is still being created
 419                                  * so skip some verification checks. */
 420         u8 is_shadowed:1;       /* This object is shadowed on the way
 421                                  * to being renamed. */
 422
 423         u8 xattr_known:1;       /* We know if this has object has xattribs
 424                                  * or not. */
 425         u8 has_xattr:1;         /* This object has xattribs.
 426                                  * Only valid if xattr_known. */
 427
 428         u8 serial;              /* serial number of chunk in NAND.*/
 429         u16 sum;                /* sum of the name to speed searching */
 430
 431         struct yaffs_dev *my_dev;       /* The device I'm on */
 432
 433         struct list_head hash_link;     /* list of objects in hash bucket */
 434
 435         struct list_head hard_links;    /* hard linked object chain*/
 436
 437         /* directory structure stuff */
 438         /* also used for linking up the free list */
 439         struct yaffs_obj *parent;
 440         struct list_head siblings;
 441
 442         /* Where's my object header in NAND? */
 443         int hdr_chunk;
 444
 445         int n_data_chunks;      /* Number of data chunks for this file. */
 446
 447         u32 obj_id;             /* the object id value */
 448
 449         u32 yst_mode;
 450
 451         YCHAR short_name[YAFFS_SHORT_NAME_LENGTH + 1];
 452
 453 #ifdef CONFIG_YAFFS_WINCE
 454         u32 win_ctime[2];
 455         u32 win_mtime[2];
 456         u32 win_atime[2];
 457 #else
 458         u32 yst_uid;
 459         u32 yst_gid;
 460         u32 yst_atime;
 461         u32 yst_mtime;
 462         u32 yst_ctime;
 463 #endif
 464
 465         u32 yst_rdev;
 466
 467         void *my_inode;
 468
 469         enum yaffs_obj_type variant_type;
 470
 471         union yaffs_obj_var variant;
 472
 473 };
 474
 475 struct yaffs_obj_bucket {
 476         struct list_head list;
 477         int count;
 478 };
 479
 480 /* yaffs_checkpt_obj holds the definition of an object as dumped
 481  * by checkpointing.
 482  */
 483
 484 struct yaffs_checkpt_obj {
 485         int struct_type;
 486         u32 obj_id;
 487         u32 parent_id;
 488         int hdr_chunk;
 489         enum yaffs_obj_type variant_type:3;
 490         u8 deleted:1;
 491         u8 soft_del:1;
 492         u8 unlinked:1;
 493         u8 fake:1;
 494         u8 rename_allowed:1;
 495         u8 unlink_allowed:1;
 496         u8 serial;
 497         int n_data_chunks;
 498         loff_t size_or_equiv_obj;
 499 };
 500
 501 /*--------------------- Temporary buffers ----------------
 502  *
 503  * These are chunk-sized working buffers. Each device has a few.
 504  */
 505
 506 struct yaffs_buffer {
 507         u8 *buffer;
 508         int in_use;
 509 };
 510
 511 /*----------------- Device ---------------------------------*/
 512
 513 struct yaffs_param {
 514         const YCHAR *name;
 515
 516         /*
 517          * Entry parameters set up way early. Yaffs sets up the rest.
 518          * The structure should be zeroed out before use so that unused
 519          * and defualt values are zero.
 520          */
 521
 522         int inband_tags;        /* Use unband tags */
 523         u32 total_bytes_per_chunk;      /* Should be >= 512, does not need to
 524                                          be a power of 2 */
 525         int chunks_per_block;   /* does not need to be a power of 2 */
 526         int spare_bytes_per_chunk;      /* spare area size */
 527         int start_block;        /* Start block we're allowed to use */
 528         int end_block;          /* End block we're allowed to use */
 529         int n_reserved_blocks;  /* Tuneable so that we can reduce
 530                                  * reserved blocks on NOR and RAM. */
 531
 532         int n_caches;           /* If <= 0, then short op caching is disabled,
 533                                  * else the number of short op caches.
 534                                  */
 535         int use_nand_ecc;       /* Flag to decide whether or not to use
 536                                  * NAND driver ECC on data (yaffs1) */
 537         int tags_9bytes;        /* Use 9 byte tags */
 538         int no_tags_ecc;        /* Flag to decide whether or not to do ECC
 539                                  * on packed tags (yaffs2) */
 540
 541         int is_yaffs2;          /* Use yaffs2 mode on this device */
 542
 543         int empty_lost_n_found; /* Auto-empty lost+found directory on mount */
 544
 545         int refresh_period;     /* How often to check for a block refresh */
 546
 547         /* Checkpoint control. Can be set before or after initialisation */
 548         u8 skip_checkpt_rd;
 549         u8 skip_checkpt_wr;
 550
 551         int enable_xattr;       /* Enable xattribs */
 552
 553         /* NAND access functions (Must be set before calling YAFFS) */
 554
 555         int (*write_chunk_fn) (struct yaffs_dev *dev,
 556                                int nand_chunk, const u8 *data,
 557                                const struct yaffs_spare *spare);
 558         int (*read_chunk_fn) (struct yaffs_dev *dev,
 559                               int nand_chunk, u8 *data,
 560                               struct yaffs_spare *spare);
 561         int (*erase_fn) (struct yaffs_dev *dev, int flash_block);
 562         int (*initialise_flash_fn) (struct yaffs_dev *dev);
 563         int (*deinitialise_flash_fn) (struct yaffs_dev *dev);
 564
 565         /* yaffs2 mode functions */
 566         int (*write_chunk_tags_fn) (struct yaffs_dev *dev,
 567                                     int nand_chunk, const u8 *data,
 568                                     const struct yaffs_ext_tags *tags);
 569         int (*read_chunk_tags_fn) (struct yaffs_dev *dev,
 570                                    int nand_chunk, u8 *data,
 571                                    struct yaffs_ext_tags *tags);
 572         int (*bad_block_fn) (struct yaffs_dev *dev, int block_no);
 573         int (*query_block_fn) (struct yaffs_dev *dev, int block_no,
 574                                enum yaffs_block_state *state,
 575                                u32 *seq_number);
 576
 577         /* The remove_obj_fn function must be supplied by OS flavours that
 578          * need it.
 579          * yaffs direct uses it to implement the faster readdir.
 580          * Linux uses it to protect the directory during unlocking.
 581          */
 582         void (*remove_obj_fn) (struct yaffs_obj *obj);
 583
 584         /* Callback to mark the superblock dirty */
 585         void (*sb_dirty_fn) (struct yaffs_dev *dev);
 586
 587         /*  Callback to control garbage collection. */
 588         unsigned (*gc_control) (struct yaffs_dev *dev);
 589
 590         /* Debug control flags. Don't use unless you know what you're doing */
 591         int use_header_file_size;       /* Flag to determine if we should use
 592                                          * file sizes from the header */
 593         int disable_lazy_load;  /* Disable lazy loading on this device */
 594         int wide_tnodes_disabled;       /* Set to disable wide tnodes */
 595         int disable_soft_del;   /* yaffs 1 only: Set to disable the use of
 596                                  * softdeletion. */
 597
 598         int defered_dir_update; /* Set to defer directory updates */
 599
 600 #ifdef CONFIG_YAFFS_AUTO_UNICODE
 601         int auto_unicode;
 602 #endif
 603         int always_check_erased;        /* Force chunk erased check always on */
 604
 605         int disable_summary;
 606
 607         int max_objects;        /*
 608                                  * Set to limit the number of objects created.
 609                                  * 0 = no limit.
 610                                 */
 611 };
 612
 613 struct yaffs_dev {
 614         struct yaffs_param param;
 615
 616         /* Context storage. Holds extra OS specific data for this device */
 617
 618         void *os_context;
 619         void *driver_context;
 620
 621         struct list_head dev_list;
 622
 623         /* Runtime parameters. Set up by YAFFS. */
 624         int data_bytes_per_chunk;
 625
 626         /* Non-wide tnode stuff */
 627         u16 chunk_grp_bits;     /* Number of bits that need to be resolved if
 628                                  * the tnodes are not wide enough.
 629                                  */
 630         u16 chunk_grp_size;     /* == 2^^chunk_grp_bits */
 631
 632         /* Stuff to support wide tnodes */
 633         u32 tnode_width;
 634         u32 tnode_mask;
 635         u32 tnode_size;
 636
 637         /* Stuff for figuring out file offset to chunk conversions */
 638         u32 chunk_shift;        /* Shift value */
 639         u32 chunk_div;          /* Divisor after shifting: 1 for 2^n sizes */
 640         u32 chunk_mask;         /* Mask to use for power-of-2 case */
 641
 642         int is_mounted;
 643         int read_only;
 644         int is_checkpointed;
 645
 646         /* Stuff to support block offsetting to support start block zero */
 647         int internal_start_block;
 648         int internal_end_block;
 649         int block_offset;
 650         int chunk_offset;
 651
 652         /* Runtime checkpointing stuff */
 653         int checkpt_page_seq;   /* running sequence number of checkpt pages */
 654         int checkpt_byte_count;
 655         int checkpt_byte_offs;
 656         u8 *checkpt_buffer;
 657         int checkpt_open_write;
 658         int blocks_in_checkpt;
 659         int checkpt_cur_chunk;
 660         int checkpt_cur_block;
 661         int checkpt_next_block;
 662         int *checkpt_block_list;
 663         int checkpt_max_blocks;
 664         u32 checkpt_sum;
 665         u32 checkpt_xor;
 666
 667         int checkpoint_blocks_required; /* Number of blocks needed to store
 668                                          * current checkpoint set */
 669
 670         /* Block Info */
 671         struct yaffs_block_info *block_info;
 672         u8 *chunk_bits;         /* bitmap of chunks in use */
 673         unsigned block_info_alt:1;      /* allocated using alternative alloc */
 674         unsigned chunk_bits_alt:1;      /* allocated using alternative alloc */
 675         int chunk_bit_stride;   /* Number of bytes of chunk_bits per block.
 676                                  * Must be consistent with chunks_per_block.
 677                                  */
 678
 679         int n_erased_blocks;
 680         int alloc_block;        /* Current block being allocated off */
 681         u32 alloc_page;
 682         int alloc_block_finder; /* Used to search for next allocation block */
 683
 684         /* Object and Tnode memory management */
 685         void *allocator;
 686         int n_obj;
 687         int n_tnodes;
 688
 689         int n_hardlinks;
 690
 691         struct yaffs_obj_bucket obj_bucket[YAFFS_NOBJECT_BUCKETS];
 692         u32 bucket_finder;
 693
 694         int n_free_chunks;
 695
 696         /* Garbage collection control */
 697         u32 *gc_cleanup_list;   /* objects to delete at the end of a GC. */
 698         u32 n_clean_ups;
 699
 700         unsigned has_pending_prioritised_gc;    /* We think this device might
 701                                                 have pending prioritised gcs */
 702         unsigned gc_disable;
 703         unsigned gc_block_finder;
 704         unsigned gc_dirtiest;
 705         unsigned gc_pages_in_use;
 706         unsigned gc_not_done;
 707         unsigned gc_block;
 708         unsigned gc_chunk;
 709         unsigned gc_skip;
 710         struct yaffs_summary_tags *gc_sum_tags;
 711
 712         /* Special directories */
 713         struct yaffs_obj *root_dir;
 714         struct yaffs_obj *lost_n_found;
 715
 716         int buffered_block;     /* Which block is buffered here? */
 717         int doing_buffered_block_rewrite;
 718
 719         struct yaffs_cache *cache;
 720         int cache_last_use;
 721
 722         /* Stuff for background deletion and unlinked files. */
 723         struct yaffs_obj *unlinked_dir; /* Directory where unlinked and deleted
 724                                          files live. */
 725         struct yaffs_obj *del_dir;      /* Directory where deleted objects are
 726                                         sent to disappear. */
 727         struct yaffs_obj *unlinked_deletion;    /* Current file being
 728                                                         background deleted. */
 729         int n_deleted_files;    /* Count of files awaiting deletion; */
 730         int n_unlinked_files;   /* Count of unlinked files. */
 731         int n_bg_deletions;     /* Count of background deletions. */
 732
 733         /* Temporary buffer management */
 734         struct yaffs_buffer temp_buffer[YAFFS_N_TEMP_BUFFERS];
 735         int max_temp;
 736         int temp_in_use;
 737         int unmanaged_buffer_allocs;
 738         int unmanaged_buffer_deallocs;
 739
 740         /* yaffs2 runtime stuff */
 741         unsigned seq_number;    /* Sequence number of currently
 742                                         allocating block */
 743         unsigned oldest_dirty_seq;
 744         unsigned oldest_dirty_block;
 745
 746         /* Block refreshing */
 747         int refresh_skip;       /* A skip down counter.
 748                                  * Refresh happens when this gets to zero. */
 749
 750         /* Dirty directory handling */
 751         struct list_head dirty_dirs;    /* List of dirty directories */
 752
 753         /* Summary */
 754         int chunks_per_summary;
 755         struct yaffs_summary_tags *sum_tags;
 756
 757         /* Statistics */
 758         u32 n_page_writes;
 759         u32 n_page_reads;
 760         u32 n_erasures;
 761         u32 n_erase_failures;
 762         u32 n_gc_copies;
 763         u32 all_gcs;
 764         u32 passive_gc_count;
 765         u32 oldest_dirty_gc_count;
 766         u32 n_gc_blocks;
 767         u32 bg_gcs;
 768         u32 n_retried_writes;
 769         u32 n_retired_blocks;
 770         u32 n_ecc_fixed;
 771         u32 n_ecc_unfixed;
 772         u32 n_tags_ecc_fixed;
 773         u32 n_tags_ecc_unfixed;
 774         u32 n_deletions;
 775         u32 n_unmarked_deletions;
 776         u32 refresh_count;
 777         u32 cache_hits;
 778         u32 tags_used;
 779         u32 summary_used;
 780
 781 };
 782
 783 /* The CheckpointDevice structure holds the device information that changes
 784  *at runtime and must be preserved over unmount/mount cycles.
 785  */
 786 struct yaffs_checkpt_dev {
 787         int struct_type;
 788         int n_erased_blocks;
 789         int alloc_block;        /* Current block being allocated off */
 790         u32 alloc_page;
 791         int n_free_chunks;
 792
 793         int n_deleted_files;    /* Count of files awaiting deletion; */
 794         int n_unlinked_files;   /* Count of unlinked files. */
 795         int n_bg_deletions;     /* Count of background deletions. */
 796
 797         /* yaffs2 runtime stuff */
 798         unsigned seq_number;    /* Sequence number of currently
 799                                  * allocating block */
 800
 801 };
 802
 803 struct yaffs_checkpt_validity {
 804         int struct_type;
 805         u32 magic;
 806         u32 version;
 807         u32 head;
 808 };
 809
 810 struct yaffs_shadow_fixer {
 811         int obj_id;
 812         int shadowed_id;
 813         struct yaffs_shadow_fixer *next;
 814 };
 815
 816 /* Structure for doing xattr modifications */
 817 struct yaffs_xattr_mod {
 818         int set;                /* If 0 then this is a deletion */
 819         const YCHAR *name;
 820         const void *data;
 821         int size;
 822         int flags;
 823         int result;
 824 };
 825
 826 /*----------------------- YAFFS Functions -----------------------*/
 827
 828 int yaffs_guts_initialise(struct yaffs_dev *dev);
 829 void yaffs_deinitialise(struct yaffs_dev *dev);
 830
 831 int yaffs_get_n_free_chunks(struct yaffs_dev *dev);
 832
 833 int yaffs_rename_obj(struct yaffs_obj *old_dir, const YCHAR * old_name,
 834                      struct yaffs_obj *new_dir, const YCHAR * new_name);
 835
 836 int yaffs_unlinker(struct yaffs_obj *dir, const YCHAR * name);
 837 int yaffs_del_obj(struct yaffs_obj *obj);
 838
 839 int yaffs_get_obj_name(struct yaffs_obj *obj, YCHAR * name, int buffer_size);
 840 loff_t yaffs_get_obj_length(struct yaffs_obj *obj);
 841 int yaffs_get_obj_inode(struct yaffs_obj *obj);
 842 unsigned yaffs_get_obj_type(struct yaffs_obj *obj);
 843 int yaffs_get_obj_link_count(struct yaffs_obj *obj);
 844
 845 /* File operations */
 846 int yaffs_file_rd(struct yaffs_obj *obj, u8 * buffer, loff_t offset,
 847                   int n_bytes);
 848 int yaffs_wr_file(struct yaffs_obj *obj, const u8 * buffer, loff_t offset,
 849                   int n_bytes, int write_trhrough);
 850 int yaffs_resize_file(struct yaffs_obj *obj, loff_t new_size);
 851
 852 struct yaffs_obj *yaffs_create_file(struct yaffs_obj *parent,
 853                                     const YCHAR *name, u32 mode, u32 uid,
 854                                     u32 gid);
 855
 856 int yaffs_flush_file(struct yaffs_obj *obj, int update_time, int data_sync);
 857
 858 /* Flushing and checkpointing */
 859 void yaffs_flush_whole_cache(struct yaffs_dev *dev);
 860
 861 int yaffs_checkpoint_save(struct yaffs_dev *dev);
 862 int yaffs_checkpoint_restore(struct yaffs_dev *dev);
 863
 864 /* Directory operations */
 865 struct yaffs_obj *yaffs_create_dir(struct yaffs_obj *parent, const YCHAR *name,
 866                                    u32 mode, u32 uid, u32 gid);
 867 struct yaffs_obj *yaffs_find_by_name(struct yaffs_obj *the_dir,
 868                                      const YCHAR *name);
 869 struct yaffs_obj *yaffs_find_by_number(struct yaffs_dev *dev, u32 number);
 870
 871 /* Link operations */
 872 struct yaffs_obj *yaffs_link_obj(struct yaffs_obj *parent, const YCHAR *name,
 873                                  struct yaffs_obj *equiv_obj);
 874
 875 struct yaffs_obj *yaffs_get_equivalent_obj(struct yaffs_obj *obj);
 876
 877 /* Symlink operations */
 878 struct yaffs_obj *yaffs_create_symlink(struct yaffs_obj *parent,
 879                                        const YCHAR *name, u32 mode, u32 uid,
 880                                        u32 gid, const YCHAR *alias);
 881 YCHAR *yaffs_get_symlink_alias(struct yaffs_obj *obj);
 882
 883 /* Special inodes (fifos, sockets and devices) */
 884 struct yaffs_obj *yaffs_create_special(struct yaffs_obj *parent,
 885                                        const YCHAR *name, u32 mode, u32 uid,
 886                                        u32 gid, u32 rdev);
 887
 888 int yaffs_set_xattrib(struct yaffs_obj *obj, const YCHAR *name,
 889                       const void *value, int size, int flags);
 890 int yaffs_get_xattrib(struct yaffs_obj *obj, const YCHAR *name, void *value,
 891                       int size);
 892 int yaffs_list_xattrib(struct yaffs_obj *obj, char *buffer, int size);
 893 int yaffs_remove_xattrib(struct yaffs_obj *obj, const YCHAR *name);
 894
 895 /* Special directories */
 896 struct yaffs_obj *yaffs_root(struct yaffs_dev *dev);
 897 struct yaffs_obj *yaffs_lost_n_found(struct yaffs_dev *dev);
 898
 899 void yaffs_handle_defered_free(struct yaffs_obj *obj);
 900
 901 void yaffs_update_dirty_dirs(struct yaffs_dev *dev);
 902
 903 int yaffs_bg_gc(struct yaffs_dev *dev, unsigned urgency);
 904
 905 /* Debug dump  */
 906 int yaffs_dump_obj(struct yaffs_obj *obj);
 907
 908 void yaffs_guts_test(struct yaffs_dev *dev);
 909
 910 /* A few useful functions to be used within the core files*/
 911 void yaffs_chunk_del(struct yaffs_dev *dev, int chunk_id, int mark_flash,
 912                      int lyn);
 913 int yaffs_check_ff(u8 *buffer, int n_bytes);
 914 void yaffs_handle_chunk_error(struct yaffs_dev *dev,
 915                               struct yaffs_block_info *bi);
 916
 917 u8 *yaffs_get_temp_buffer(struct yaffs_dev *dev);
 918 void yaffs_release_temp_buffer(struct yaffs_dev *dev, u8 *buffer);
 919
 920 struct yaffs_obj *yaffs_find_or_create_by_number(struct yaffs_dev *dev,
 921                                                  int number,
 922                                                  enum yaffs_obj_type type);
 923 int yaffs_put_chunk_in_file(struct yaffs_obj *in, int inode_chunk,
 924                             int nand_chunk, int in_scan);
 925 void yaffs_set_obj_name(struct yaffs_obj *obj, const YCHAR *name);
 926 void yaffs_set_obj_name_from_oh(struct yaffs_obj *obj,
 927                                 const struct yaffs_obj_hdr *oh);
 928 void yaffs_add_obj_to_dir(struct yaffs_obj *directory, struct yaffs_obj *obj);
 929 YCHAR *yaffs_clone_str(const YCHAR *str);
 930 void yaffs_link_fixup(struct yaffs_dev *dev, struct list_head *hard_list);
 931 void yaffs_block_became_dirty(struct yaffs_dev *dev, int block_no);
 932 int yaffs_update_oh(struct yaffs_obj *in, const YCHAR *name,
 933                     int force, int is_shrink, int shadows,
 934                     struct yaffs_xattr_mod *xop);
 935 void yaffs_handle_shadowed_obj(struct yaffs_dev *dev, int obj_id,
 936                                int backward_scanning);
 937 int yaffs_check_alloc_available(struct yaffs_dev *dev, int n_chunks);
 938 struct yaffs_tnode *yaffs_get_tnode(struct yaffs_dev *dev);
 939 struct yaffs_tnode *yaffs_add_find_tnode_0(struct yaffs_dev *dev,
 940                                            struct yaffs_file_var *file_struct,
 941                                            u32 chunk_id,
 942                                            struct yaffs_tnode *passed_tn);
 943
 944 int yaffs_do_file_wr(struct yaffs_obj *in, const u8 *buffer, loff_t offset,
 945                      int n_bytes, int write_trhrough);
 946 void yaffs_resize_file_down(struct yaffs_obj *obj, loff_t new_size);
 947 void yaffs_skip_rest_of_block(struct yaffs_dev *dev);
 948
 949 int yaffs_count_free_chunks(struct yaffs_dev *dev);
 950
 951 struct yaffs_tnode *yaffs_find_tnode_0(struct yaffs_dev *dev,
 952                                        struct yaffs_file_var *file_struct,
 953                                        u32 chunk_id);
 954
 955 u32 yaffs_get_group_base(struct yaffs_dev *dev, struct yaffs_tnode *tn,
 956                          unsigned pos);
 957
 958 int yaffs_is_non_empty_dir(struct yaffs_obj *obj);
 959
 960 void yaffs_addr_to_chunk(struct yaffs_dev *dev, loff_t addr,
 961                                 int *chunk_out, u32 *offset_out);
 962 /*
 963  * Marshalling functions to get loff_t file sizes into aand out of
 964  * object headers.
 965  */
 966 void yaffs_oh_size_load(struct yaffs_obj_hdr *oh, loff_t fsize);
 967 loff_t yaffs_oh_to_size(struct yaffs_obj_hdr *oh);
 968 loff_t yaffs_max_file_size(struct yaffs_dev *dev);
 969
 970
 971 #endif