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         //these are always 64 bits
 486         u32 win_ctime[2];
 487         u32 win_mtime[2];
 488         u32 win_atime[2];
 489 #else
 490         //these can be 32 or 64 bits
 491         YTIME_T yst_uid;
 492         YTIME_T yst_gid;
 493         YTIME_T yst_atime;
 494         YTIME_T yst_mtime;
 495         YTIME_T yst_ctime;
 496 #endif
 497
 498         u32 yst_rdev;
 499
 500         void *my_inode;
 501
 502         u32 variant_type; /* enum yaffs_object_type */
 503
 504         union yaffs_obj_var variant;
 505
 506 };
 507
 508 struct yaffs_obj_bucket {
 509         struct list_head list;
 510         int count;
 511 };
 512
 513
 514 /*--------------------- Temporary buffers ----------------
 515  *
 516  * These are chunk-sized working buffers. Each device has a few.
 517  */
 518
 519 struct yaffs_buffer {
 520         u8 *buffer;
 521         int in_use;
 522 };
 523
 524 /*----------------- Device ---------------------------------*/
 525
 526 struct yaffs_param {
 527         const YCHAR *name;
 528
 529         /*
 530          * Entry parameters set up way early. Yaffs sets up the rest.
 531          * The structure should be zeroed out before use so that unused
 532          * and default values are zero.
 533          */
 534
 535         int inband_tags;        /* Use unband tags */
 536         u32 total_bytes_per_chunk;      /* Should be >= 512, does not need to
 537                                          be a power of 2 */
 538         u32 chunks_per_block;   /* does not need to be a power of 2 */
 539         u32 spare_bytes_per_chunk;      /* spare area size */
 540         u32 start_block;        /* Start block we're allowed to use */
 541         u32 end_block;          /* End block we're allowed to use */
 542         u32 n_reserved_blocks;  /* Tuneable so that we can reduce
 543                                  * reserved blocks on NOR and RAM. */
 544
 545         u32 n_caches;           /* If == 0, then short op caching is disabled,
 546                                  * else the number of short op caches.
 547                                  */
 548         int cache_bypass_aligned; /* If non-zero then bypass the cache for
 549                                    * aligned writes.
 550                                    */
 551
 552         int use_nand_ecc;       /* Flag to decide whether or not to use
 553                                  * NAND driver ECC on data (yaffs1) */
 554         int tags_9bytes;        /* Use 9 byte tags */
 555         int no_tags_ecc;        /* Flag to decide whether or not to do ECC
 556                                  * on packed tags (yaffs2) */
 557
 558         int is_yaffs2;          /* Use yaffs2 mode on this device */
 559
 560         int empty_lost_n_found; /* Auto-empty lost+found directory on mount */
 561
 562         int refresh_period;     /* How often to check for a block refresh */
 563
 564         /* Checkpoint control. Can be set before or after initialisation */
 565         u8 skip_checkpt_rd;
 566         u8 skip_checkpt_wr;
 567
 568         int enable_xattr;       /* Enable xattribs */
 569
 570         int max_objects;        /*
 571                                  * Set to limit the number of objects created.
 572                                  * 0 = no limit.
 573                                 */
 574
 575         int hide_lost_n_found;  /* Set non-zero to hide the lost-n-found dir. */
 576
 577         int stored_endian; /* 0=cpu endian, 1=little endian, 2=big endian */
 578
 579         /* The remove_obj_fn function must be supplied by OS flavours that
 580          * need it.
 581          * yaffs direct uses it to implement the faster readdir.
 582          * Linux uses it to protect the directory during unlocking.
 583          */
 584         void (*remove_obj_fn) (struct yaffs_obj *obj);
 585
 586         /* Callback to mark the superblock dirty */
 587         void (*sb_dirty_fn) (struct yaffs_dev *dev);
 588
 589         /*  Callback to control garbage collection. */
 590         unsigned (*gc_control_fn) (struct yaffs_dev *dev);
 591
 592         /* Debug control flags. Don't use unless you know what you're doing */
 593         int use_header_file_size;       /* Flag to determine if we should use
 594                                          * file sizes from the header */
 595         int disable_lazy_load;  /* Disable lazy loading on this device */
 596         int wide_tnodes_disabled;       /* Set to disable wide tnodes */
 597         int disable_soft_del;   /* yaffs 1 only: Set to disable the use of
 598                                  * softdeletion. */
 599
 600         int defered_dir_update; /* Set to defer directory updates */
 601
 602 #ifdef CONFIG_YAFFS_AUTO_UNICODE
 603         int auto_unicode;
 604 #endif
 605         int always_check_erased;        /* Force chunk erased check always on */
 606
 607         int disable_summary;
 608         int disable_bad_block_marking;
 609
 610 };
 611
 612 struct yaffs_driver {
 613         int (*drv_write_chunk_fn) (struct yaffs_dev *dev, int nand_chunk,
 614                                    const u8 *data, int data_len,
 615                                    const u8 *oob, int oob_len);
 616         int (*drv_read_chunk_fn) (struct yaffs_dev *dev, int nand_chunk,
 617                                    u8 *data, int data_len,
 618                                    u8 *oob, int oob_len,
 619                                    enum yaffs_ecc_result *ecc_result);
 620         int (*drv_erase_fn) (struct yaffs_dev *dev, int block_no);
 621         int (*drv_mark_bad_fn) (struct yaffs_dev *dev, int block_no);
 622         int (*drv_check_bad_fn) (struct yaffs_dev *dev, int block_no);
 623         int (*drv_initialise_fn) (struct yaffs_dev *dev);
 624         int (*drv_deinitialise_fn) (struct yaffs_dev *dev);
 625 };
 626
 627 struct yaffs_tags_handler {
 628         int (*write_chunk_tags_fn) (struct yaffs_dev *dev,
 629                                     int nand_chunk, const u8 *data,
 630                                     const struct yaffs_ext_tags *tags);
 631         int (*read_chunk_tags_fn) (struct yaffs_dev *dev,
 632                                    int nand_chunk, u8 *data,
 633                                    struct yaffs_ext_tags *tags);
 634
 635         int (*query_block_fn) (struct yaffs_dev *dev, int block_no,
 636                                enum yaffs_block_state *state,
 637                                u32 *seq_number);
 638         int (*mark_bad_fn) (struct yaffs_dev *dev, int block_no);
 639 };
 640
 641 struct yaffs_dev {
 642         struct yaffs_param param;
 643         struct yaffs_driver drv;
 644         struct yaffs_tags_handler tagger;
 645
 646         /* Context storage. Holds extra OS specific data for this device */
 647
 648         void *os_context;
 649         void *driver_context;
 650
 651         struct list_head dev_list;
 652
 653         int ll_init;
 654         /* Runtime parameters. Set up by YAFFS. */
 655         u32 data_bytes_per_chunk;
 656
 657         /* Non-wide tnode stuff */
 658         u16 chunk_grp_bits;     /* Number of bits that need to be resolved if
 659                                  * the tnodes are not wide enough.
 660                                  */
 661         u16 chunk_grp_size;     /* == 2^^chunk_grp_bits */
 662
 663         struct yaffs_tnode *tn_swap_buffer;
 664
 665         /* Stuff to support wide tnodes */
 666         u32 tnode_width;
 667         u32 tnode_mask;
 668         u32 tnode_size;
 669
 670         /* Stuff for figuring out file offset to chunk conversions */
 671         u32 chunk_shift;        /* Shift value */
 672         u32 chunk_div;          /* Divisor after shifting: 1 for 2^n sizes */
 673         u32 chunk_mask;         /* Mask to use for power-of-2 case */
 674
 675         int is_mounted;
 676         int read_only;
 677         int is_checkpointed;
 678         int swap_endian;        /* Stored endian needs endian swap. */
 679
 680         /* Stuff to support block offsetting to support start block zero */
 681         u32 internal_start_block;
 682         u32 internal_end_block;
 683         int block_offset;
 684         int chunk_offset;
 685
 686         /* Runtime checkpointing stuff */
 687         int checkpt_page_seq;   /* running sequence number of checkpt pages */
 688         int checkpt_byte_count;
 689         int checkpt_byte_offs;
 690         u8 *checkpt_buffer;
 691         int checkpt_open_write;
 692         u32 blocks_in_checkpt;
 693         int checkpt_cur_chunk;
 694         int checkpt_cur_block;
 695         int checkpt_next_block;
 696         int *checkpt_block_list;
 697         u32 checkpt_max_blocks;
 698         u32 checkpt_sum;
 699         u32 checkpt_xor;
 700
 701         int checkpoint_blocks_required; /* Number of blocks needed to store
 702                                          * current checkpoint set */
 703
 704         /* Block Info */
 705         struct yaffs_block_info *block_info;
 706         u8 *chunk_bits;         /* bitmap of chunks in use */
 707         u8 block_info_alt:1;    /* allocated using alternative alloc */
 708         u8 chunk_bits_alt:1;    /* allocated using alternative alloc */
 709         int chunk_bit_stride;   /* Number of bytes of chunk_bits per block.
 710                                  * Must be consistent with chunks_per_block.
 711                                  */
 712
 713         int n_erased_blocks;
 714         int alloc_block;        /* Current block being allocated off */
 715         u32 alloc_page;
 716         int alloc_block_finder; /* Used to search for next allocation block */
 717
 718         /* Object and Tnode memory management */
 719         void *allocator;
 720         int n_obj;
 721         int n_tnodes;
 722
 723         int n_hardlinks;
 724
 725         struct yaffs_obj_bucket obj_bucket[YAFFS_NOBJECT_BUCKETS];
 726         u32 bucket_finder;
 727
 728         int n_free_chunks;
 729
 730         /* Garbage collection control */
 731         u32 *gc_cleanup_list;   /* objects to delete at the end of a GC. */
 732         u32 n_clean_ups;
 733
 734         unsigned has_pending_prioritised_gc;    /* We think this device might
 735                                                 have pending prioritised gcs */
 736         unsigned gc_disable;
 737         unsigned gc_block_finder;
 738         unsigned gc_dirtiest;
 739         unsigned gc_pages_in_use;
 740         unsigned gc_not_done;
 741         unsigned gc_block;
 742         unsigned gc_chunk;
 743         unsigned gc_skip;
 744         struct yaffs_summary_tags *gc_sum_tags;
 745
 746         /* Special directories */
 747         struct yaffs_obj *root_dir;
 748         struct yaffs_obj *lost_n_found;
 749
 750         int buffered_block;     /* Which block is buffered here? */
 751         int doing_buffered_block_rewrite;
 752
 753         struct yaffs_cache_manager cache_mgr;
 754
 755         /* Stuff for background deletion and unlinked files. */
 756         struct yaffs_obj *unlinked_dir; /* Directory where unlinked and deleted
 757                                          files live. */
 758         struct yaffs_obj *del_dir;      /* Directory where deleted objects are
 759                                         sent to disappear. */
 760         struct yaffs_obj *unlinked_deletion;    /* Current file being
 761                                                         background deleted. */
 762         int n_deleted_files;    /* Count of files awaiting deletion; */
 763         int n_unlinked_files;   /* Count of unlinked files. */
 764         int n_bg_deletions;     /* Count of background deletions. */
 765
 766         /* Temporary buffer management */
 767         struct yaffs_buffer temp_buffer[YAFFS_N_TEMP_BUFFERS];
 768         int max_temp;
 769         int temp_in_use;
 770         int unmanaged_buffer_allocs;
 771         int unmanaged_buffer_deallocs;
 772
 773         /* yaffs2 runtime stuff */
 774         unsigned seq_number;    /* Sequence number of currently
 775                                         allocating block */
 776         unsigned oldest_dirty_seq;
 777         unsigned oldest_dirty_block;
 778
 779         /* Block refreshing */
 780         int refresh_skip;       /* A skip down counter.
 781                                  * Refresh happens when this gets to zero. */
 782
 783         /* Dirty directory handling */
 784         struct list_head dirty_dirs;    /* List of dirty directories */
 785
 786         /* Summary */
 787         int chunks_per_summary;
 788         struct yaffs_summary_tags *sum_tags;
 789
 790         /* Statistics */
 791         u32 n_page_writes;
 792         u32 n_page_reads;
 793         u32 n_erasures;
 794         u32 n_bad_queries;
 795         u32 n_bad_markings;
 796         u32 n_erase_failures;
 797         u32 n_gc_copies;
 798         u32 all_gcs;
 799         u32 passive_gc_count;
 800         u32 oldest_dirty_gc_count;
 801         u32 n_gc_blocks;
 802         u32 bg_gcs;
 803         u32 n_retried_writes;
 804         u32 n_retired_blocks;
 805         u32 n_ecc_fixed;
 806         u32 n_ecc_unfixed;
 807         u32 n_tags_ecc_fixed;
 808         u32 n_tags_ecc_unfixed;
 809         u32 n_deletions;
 810         u32 n_unmarked_deletions;
 811         u32 refresh_count;
 812         u32 cache_hits;
 813         u32 tags_used;
 814         u32 summary_used;
 815
 816 };
 817
 818 /*
 819  * Checkpointing definitions.
 820  */
 821
 822 #define YAFFS_CHECKPOINT_VERSION        8
 823
 824 /* yaffs_checkpt_obj holds the definition of an object as dumped
 825  * by checkpointing.
 826  */
 827
 828
 829 /*  Checkpint object bits in bitfield: offset, length */
 830 #define CHECKPOINT_VARIANT_BITS         0, 3
 831 #define CHECKPOINT_DELETED_BITS         3, 1
 832 #define CHECKPOINT_SOFT_DEL_BITS        4, 1
 833 #define CHECKPOINT_UNLINKED_BITS        5, 1
 834 #define CHECKPOINT_FAKE_BITS            6, 1
 835 #define CHECKPOINT_RENAME_ALLOWED_BITS  7, 1
 836 #define CHECKPOINT_UNLINK_ALLOWED_BITS  8, 1
 837 #define CHECKPOINT_SERIAL_BITS          9, 8
 838
 839 struct yaffs_checkpt_obj {
 840         int struct_type;
 841         u32 obj_id;
 842         u32 parent_id;
 843         int hdr_chunk;
 844         u32 bit_field;
 845         int n_data_chunks;
 846         loff_t size_or_equiv_obj;
 847 };
 848
 849 /* The CheckpointDevice structure holds the device information that changes
 850  *at runtime and must be preserved over unmount/mount cycles.
 851  */
 852 struct yaffs_checkpt_dev {
 853         int struct_type;
 854         int n_erased_blocks;
 855         int alloc_block;        /* Current block being allocated off */
 856         u32 alloc_page;
 857         int n_free_chunks;
 858
 859         int n_deleted_files;    /* Count of files awaiting deletion; */
 860         int n_unlinked_files;   /* Count of unlinked files. */
 861         int n_bg_deletions;     /* Count of background deletions. */
 862
 863         /* yaffs2 runtime stuff */
 864         unsigned seq_number;    /* Sequence number of currently
 865                                  * allocating block */
 866
 867 };
 868
 869 struct yaffs_checkpt_validity {
 870         int struct_type;
 871         u32 magic;
 872         u32 version;
 873         u32 head;
 874 };
 875
 876 struct yaffs_shadow_fixer {
 877         int obj_id;
 878         int shadowed_id;
 879         struct yaffs_shadow_fixer *next;
 880 };
 881
 882 /* Structure for doing xattr modifications */
 883 struct yaffs_xattr_mod {
 884         int set;                /* If 0 then this is a deletion */
 885         const YCHAR *name;
 886         const void *data;
 887         int size;
 888         int flags;
 889         int result;
 890 };
 891
 892 /*----------------------- YAFFS Functions -----------------------*/
 893
 894 int yaffs_guts_initialise(struct yaffs_dev *dev);
 895 void yaffs_deinitialise(struct yaffs_dev *dev);
 896 void yaffs_guts_cleanup(struct yaffs_dev *dev);
 897
 898 int yaffs_get_n_free_chunks(struct yaffs_dev *dev);
 899
 900 int yaffs_rename_obj(struct yaffs_obj *old_dir, const YCHAR * old_name,
 901                      struct yaffs_obj *new_dir, const YCHAR * new_name);
 902
 903 int yaffs_unlink_obj(struct yaffs_obj *obj);
 904
 905 int yaffs_unlinker(struct yaffs_obj *dir, const YCHAR * name);
 906 int yaffs_del_obj(struct yaffs_obj *obj);
 907 struct yaffs_obj *yaffs_retype_obj(struct yaffs_obj *obj,
 908                                    enum yaffs_obj_type type);
 909
 910
 911 int yaffs_get_obj_name(struct yaffs_obj *obj, YCHAR * name, int buffer_size);
 912 loff_t yaffs_get_obj_length(struct yaffs_obj *obj);
 913 int yaffs_get_obj_inode(struct yaffs_obj *obj);
 914 unsigned yaffs_get_obj_type(struct yaffs_obj *obj);
 915 int yaffs_get_obj_link_count(struct yaffs_obj *obj);
 916
 917 /* File operations */
 918 int yaffs_file_rd(struct yaffs_obj *obj, u8 * buffer, loff_t offset,
 919                   int n_bytes);
 920 int yaffs_wr_file(struct yaffs_obj *obj, const u8 * buffer, loff_t offset,
 921                   int n_bytes, int write_trhrough);
 922 int yaffs_resize_file(struct yaffs_obj *obj, loff_t new_size);
 923
 924 struct yaffs_obj *yaffs_create_file(struct yaffs_obj *parent,
 925                                     const YCHAR *name, u32 mode, u32 uid,
 926                                     u32 gid);
 927
 928 int yaffs_flush_file(struct yaffs_obj *in,
 929                      int update_time,
 930                      int data_sync,
 931                      int discard_cache);
 932
 933 /* Flushing and checkpointing */
 934 void yaffs_flush_whole_cache(struct yaffs_dev *dev, int discard);
 935
 936 int yaffs_checkpoint_save(struct yaffs_dev *dev);
 937 int yaffs_checkpoint_restore(struct yaffs_dev *dev);
 938
 939 /* Directory operations */
 940 struct yaffs_obj *yaffs_create_dir(struct yaffs_obj *parent, const YCHAR *name,
 941                                    u32 mode, u32 uid, u32 gid);
 942 struct yaffs_obj *yaffs_find_by_name(struct yaffs_obj *the_dir,
 943                                      const YCHAR *name);
 944 struct yaffs_obj *yaffs_find_by_number(struct yaffs_dev *dev, u32 number);
 945
 946 /* Link operations */
 947 struct yaffs_obj *yaffs_link_obj(struct yaffs_obj *parent, const YCHAR *name,
 948                                  struct yaffs_obj *equiv_obj);
 949
 950 struct yaffs_obj *yaffs_get_equivalent_obj(struct yaffs_obj *obj);
 951
 952 /* Symlink operations */
 953 struct yaffs_obj *yaffs_create_symlink(struct yaffs_obj *parent,
 954                                        const YCHAR *name, u32 mode, u32 uid,
 955                                        u32 gid, const YCHAR *alias);
 956 YCHAR *yaffs_get_symlink_alias(struct yaffs_obj *obj);
 957
 958 /* Special inodes (fifos, sockets and devices) */
 959 struct yaffs_obj *yaffs_create_special(struct yaffs_obj *parent,
 960                                        const YCHAR *name, u32 mode, u32 uid,
 961                                        u32 gid, u32 rdev);
 962
 963 int yaffs_set_xattrib(struct yaffs_obj *obj, const YCHAR *name,
 964                       const void *value, int size, int flags);
 965 int yaffs_get_xattrib(struct yaffs_obj *obj, const YCHAR *name, void *value,
 966                       int size);
 967 int yaffs_list_xattrib(struct yaffs_obj *obj, char *buffer, int size);
 968 int yaffs_remove_xattrib(struct yaffs_obj *obj, const YCHAR *name);
 969
 970 /* Special directories */
 971 struct yaffs_obj *yaffs_root(struct yaffs_dev *dev);
 972 struct yaffs_obj *yaffs_lost_n_found(struct yaffs_dev *dev);
 973
 974 void yaffs_handle_defered_free(struct yaffs_obj *obj);
 975
 976 void yaffs_update_dirty_dirs(struct yaffs_dev *dev);
 977
 978 int yaffs_bg_gc(struct yaffs_dev *dev, unsigned urgency);
 979
 980 /* Debug dump  */
 981 int yaffs_dump_obj(struct yaffs_obj *obj);
 982
 983 void yaffs_guts_test(struct yaffs_dev *dev);
 984 int yaffs_guts_ll_init(struct yaffs_dev *dev);
 985
 986
 987 /* A few useful functions to be used within the core files*/
 988 void yaffs_chunk_del(struct yaffs_dev *dev, int chunk_id, int mark_flash,
 989                      int lyn);
 990 int yaffs_check_ff(u8 *buffer, int n_bytes);
 991 void yaffs_handle_chunk_error(struct yaffs_dev *dev,
 992                               struct yaffs_block_info *bi);
 993
 994 u8 *yaffs_get_temp_buffer(struct yaffs_dev *dev);
 995 void yaffs_release_temp_buffer(struct yaffs_dev *dev, u8 *buffer);
 996
 997 struct yaffs_obj *yaffs_find_or_create_by_number(struct yaffs_dev *dev,
 998                                                  int number,
 999                                                  enum yaffs_obj_type type);
1000 int yaffs_put_chunk_in_file(struct yaffs_obj *in, int inode_chunk,
1001                             int nand_chunk, int in_scan);
1002 void yaffs_set_obj_name(struct yaffs_obj *obj, const YCHAR *name);
1003 void yaffs_set_obj_name_from_oh(struct yaffs_obj *obj,
1004                                 const struct yaffs_obj_hdr *oh);
1005 void yaffs_add_obj_to_dir(struct yaffs_obj *directory, struct yaffs_obj *obj);
1006 YCHAR *yaffs_clone_str(const YCHAR *str);
1007 void yaffs_link_fixup(struct yaffs_dev *dev, struct list_head *hard_list);
1008 void yaffs_block_became_dirty(struct yaffs_dev *dev, int block_no);
1009 int yaffs_update_oh(struct yaffs_obj *in, const YCHAR *name,
1010                     int force, int is_shrink, int shadows,
1011                     struct yaffs_xattr_mod *xop);
1012 void yaffs_handle_shadowed_obj(struct yaffs_dev *dev, int obj_id,
1013                                int backward_scanning);
1014 int yaffs_check_alloc_available(struct yaffs_dev *dev, int n_chunks);
1015 struct yaffs_tnode *yaffs_get_tnode(struct yaffs_dev *dev);
1016 struct yaffs_tnode *yaffs_add_find_tnode_0(struct yaffs_dev *dev,
1017                                            struct yaffs_file_var *file_struct,
1018                                            u32 chunk_id,
1019                                            struct yaffs_tnode *passed_tn);
1020
1021 int yaffs_do_file_wr(struct yaffs_obj *in, const u8 *buffer, loff_t offset,
1022                      int n_bytes, int write_trhrough);
1023 void yaffs_resize_file_down(struct yaffs_obj *obj, loff_t new_size);
1024 void yaffs_skip_rest_of_block(struct yaffs_dev *dev);
1025
1026 int yaffs_count_free_chunks(struct yaffs_dev *dev);
1027
1028 struct yaffs_tnode *yaffs_find_tnode_0(struct yaffs_dev *dev,
1029                                        struct yaffs_file_var *file_struct,
1030                                        u32 chunk_id);
1031
1032 u32 yaffs_get_group_base(struct yaffs_dev *dev, struct yaffs_tnode *tn,
1033                          unsigned pos);
1034
1035 int yaffs_is_non_empty_dir(struct yaffs_obj *obj);
1036
1037 int yaffs_guts_format_dev(struct yaffs_dev *dev);
1038
1039 void yaffs_addr_to_chunk(struct yaffs_dev *dev, loff_t addr,
1040                                 int *chunk_out, u32 *offset_out);
1041 /*
1042  * Marshalling functions to get loff_t file sizes into and out of
1043  * object headers.
1044  */
1045 void yaffs_oh_size_load(struct yaffs_dev *dev, struct yaffs_obj_hdr *oh,
1046                         loff_t fsize, int do_endian);
1047 loff_t yaffs_oh_to_size(struct yaffs_dev *dev, struct yaffs_obj_hdr *oh,
1048                         int do_endian);
1049 loff_t yaffs_max_file_size(struct yaffs_dev *dev);
1050
1051
1052 /* yaffs_wr_data_obj needs to be exposed to allow the cache to access it. */
1053 int yaffs_wr_data_obj(struct yaffs_obj *in, int inode_chunk,
1054                              const u8 *buffer, int n_bytes, int use_reserve);
1055
1056 /*
1057  * Debug function to count number of blocks in each state
1058  * NB Needs to be called with correct number of integers
1059  */
1060
1061 void yaffs_count_blocks_by_state(struct yaffs_dev *dev, int bs[10]);
1062
1063 int yaffs_find_chunk_in_file(struct yaffs_obj *in, int inode_chunk,
1064                                     struct yaffs_ext_tags *tags);
1065
1066 /*
1067  * Define LOFF_T_32_BIT if a 32-bit LOFF_T is being used.
1068  * Not serious if you get this wrong - you might just get some warnings.
1069 */
1070
1071 #ifdef  LOFF_T_32_BIT
1072 #define FSIZE_LOW(fsize) (fsize)
1073 #define FSIZE_HIGH(fsize) 0
1074 #define FSIZE_COMBINE(high, low) (low)
1075 #else
1076 #define FSIZE_LOW(fsize) ((fsize) & 0xffffffff)
1077 #define FSIZE_HIGH(fsize)(((fsize) >> 32) & 0xffffffff)
1078 #define FSIZE_COMBINE(high, low) ((((loff_t) (high)) << 32) | \
1079                                         (((loff_t) (low)) & 0xFFFFFFFF))
1080 #endif
1081
1082
1083 #endif