yaffs_guts.h

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