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