yaffs_guts.h

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