Mercurial > yaffs-ecoscentric
annotate yaffs_guts.h @ 184:14d97b52d375 pre_Ians_changes
Change blockState field from enum to unsigned because some compilers use ints for enums which would break here
| author | charles |
|---|---|
| date | Mon, 21 May 2007 01:36:17 +0100 |
| parents | ebfd69da1173 |
| children | fa4e74c5013d |
| rev | line source |
|---|---|
| 0 | 1 /* |
| 174 | 2 * YAFFS: Yet another Flash File System . A NAND-flash specific file system. |
| 0 | 3 * |
| 174 | 4 * Copyright (C) 2002-2007 Aleph One Ltd. |
| 0 | 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 "devextras.h" | |
| 20 #include "yportenv.h" | |
| 21 | |
| 22 #define YAFFS_OK 1 | |
| 23 #define YAFFS_FAIL 0 | |
| 24 | |
| 81 | 25 /* Give us a Y=0x59, |
| 26 * Give us an A=0x41, | |
| 27 * Give us an FF=0xFF | |
| 28 * Give us an S=0x53 | |
| 29 * And what have we got... | |
| 30 */ | |
| 77 | 31 #define YAFFS_MAGIC 0x5941FF53 |
| 0 | 32 |
| 33 #define YAFFS_NTNODES_LEVEL0 16 | |
| 34 #define YAFFS_TNODES_LEVEL0_BITS 4 | |
| 35 #define YAFFS_TNODES_LEVEL0_MASK 0xf | |
| 36 | |
| 37 #define YAFFS_NTNODES_INTERNAL (YAFFS_NTNODES_LEVEL0 / 2) | |
| 38 #define YAFFS_TNODES_INTERNAL_BITS (YAFFS_TNODES_LEVEL0_BITS - 1) | |
| 39 #define YAFFS_TNODES_INTERNAL_MASK 0x7 | |
| 40 #define YAFFS_TNODES_MAX_LEVEL 6 | |
| 41 | |
| 42 #ifndef CONFIG_YAFFS_NO_YAFFS1 | |
| 43 #define YAFFS_BYTES_PER_SPARE 16 | |
| 44 #define YAFFS_BYTES_PER_CHUNK 512 | |
| 45 #define YAFFS_CHUNK_SIZE_SHIFT 9 | |
| 46 #define YAFFS_CHUNKS_PER_BLOCK 32 | |
| 47 #define YAFFS_BYTES_PER_BLOCK (YAFFS_CHUNKS_PER_BLOCK*YAFFS_BYTES_PER_CHUNK) | |
| 48 #endif | |
| 49 | |
| 7 | 50 #define YAFFS_MIN_YAFFS2_CHUNK_SIZE 1024 |
| 51 #define YAFFS_MIN_YAFFS2_SPARE_SIZE 32 | |
| 52 | |
| 77 | 53 #define YAFFS_MAX_CHUNK_ID 0x000FFFFF |
| 0 | 54 |
| 55 #define YAFFS_UNUSED_OBJECT_ID 0x0003FFFF | |
| 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 | |
| 131 | 63 |
| 77 | 64 #define YAFFS_OBJECT_SPACE 0x40000 |
| 0 | 65 |
| 182 | 66 #define YAFFS_CHECKPOINT_VERSION 3 |
| 153 | 67 |
| 0 | 68 #ifdef CONFIG_YAFFS_UNICODE |
| 69 #define YAFFS_MAX_NAME_LENGTH 127 | |
| 70 #define YAFFS_MAX_ALIAS_LENGTH 79 | |
| 71 #else | |
| 72 #define YAFFS_MAX_NAME_LENGTH 255 | |
| 73 #define YAFFS_MAX_ALIAS_LENGTH 159 | |
| 74 #endif | |
| 75 | |
| 76 #define YAFFS_SHORT_NAME_LENGTH 15 | |
| 77 | |
| 131 | 78 /* Some special object ids for pseudo objects */ |
| 77 | 79 #define YAFFS_OBJECTID_ROOT 1 |
| 0 | 80 #define YAFFS_OBJECTID_LOSTNFOUND 2 |
| 81 #define YAFFS_OBJECTID_UNLINKED 3 | |
| 82 #define YAFFS_OBJECTID_DELETED 4 | |
| 83 | |
| 131 | 84 /* Sseudo object ids for checkpointing */ |
| 85 #define YAFFS_OBJECTID_SB_HEADER 0x10 | |
| 86 #define YAFFS_OBJECTID_CHECKPOINT_DATA 0x20 | |
| 134 | 87 #define YAFFS_SEQUENCE_CHECKPOINT_DATA 0x21 |
| 131 | 88 |
| 89 /* */ | |
| 90 | |
| 0 | 91 #define YAFFS_MAX_SHORT_OP_CACHES 20 |
| 92 | |
| 93 #define YAFFS_N_TEMP_BUFFERS 4 | |
| 94 | |
| 81 | 95 /* Sequence numbers are used in YAFFS2 to determine block allocation order. |
| 96 * The range is limited slightly to help distinguish bad numbers from good. | |
| 97 * This also allows us to perhaps in the future use special numbers for | |
| 98 * special purposes. | |
| 99 * EFFFFF00 allows the allocation of 8 blocks per second (~1Mbytes) for 15 years, | |
| 100 * and is a larger number than the lifetime of a 2GB device. | |
| 101 */ | |
| 0 | 102 #define YAFFS_LOWEST_SEQUENCE_NUMBER 0x00001000 |
| 103 #define YAFFS_HIGHEST_SEQUENCE_NUMBER 0xEFFFFF00 | |
| 104 | |
| 81 | 105 /* ChunkCache is used for short read/write operations.*/ |
| 77 | 106 typedef struct { |
| 0 | 107 struct yaffs_ObjectStruct *object; |
| 108 int chunkId; | |
| 109 int lastUse; | |
| 77 | 110 int dirty; |
| 81 | 111 int nBytes; /* Only valid if the cache is dirty */ |
| 112 int locked; /* Can't push out or flush while locked. */ | |
| 4 | 113 #ifdef CONFIG_YAFFS_YAFFS2 |
| 0 | 114 __u8 *data; |
| 115 #else | |
| 116 __u8 data[YAFFS_BYTES_PER_CHUNK]; | |
| 117 #endif | |
| 118 } yaffs_ChunkCache; | |
| 119 | |
| 81 | 120 |
| 121 | |
| 122 /* Tags structures in RAM | |
| 123 * NB This uses bitfield. Bitfields should not straddle a u32 boundary otherwise | |
| 124 * the structure size will get blown out. | |
| 125 */ | |
| 126 | |
| 0 | 127 #ifndef CONFIG_YAFFS_NO_YAFFS1 |
| 77 | 128 typedef struct { |
| 0 | 129 unsigned chunkId:20; |
| 77 | 130 unsigned serialNumber:2; |
| 131 unsigned byteCount:10; | |
| 132 unsigned objectId:18; | |
| 133 unsigned ecc:12; | |
| 134 unsigned unusedStuff:2; | |
| 0 | 135 |
| 136 } yaffs_Tags; | |
| 137 | |
| 77 | 138 typedef union { |
| 139 yaffs_Tags asTags; | |
| 140 __u8 asBytes[8]; | |
| 0 | 141 } yaffs_TagsUnion; |
| 142 | |
| 143 #endif | |
| 144 | |
| 81 | 145 /* Stuff used for extended tags in YAFFS2 */ |
| 146 | |
| 77 | 147 typedef enum { |
| 0 | 148 YAFFS_ECC_RESULT_UNKNOWN, |
| 149 YAFFS_ECC_RESULT_NO_ERROR, | |
| 150 YAFFS_ECC_RESULT_FIXED, | |
| 151 YAFFS_ECC_RESULT_UNFIXED | |
| 152 } yaffs_ECCResult; | |
| 153 | |
| 77 | 154 typedef enum { |
| 15 | 155 YAFFS_OBJECT_TYPE_UNKNOWN, |
| 156 YAFFS_OBJECT_TYPE_FILE, | |
| 157 YAFFS_OBJECT_TYPE_SYMLINK, | |
| 158 YAFFS_OBJECT_TYPE_DIRECTORY, | |
| 159 YAFFS_OBJECT_TYPE_HARDLINK, | |
| 160 YAFFS_OBJECT_TYPE_SPECIAL | |
| 161 } yaffs_ObjectType; | |
| 162 | |
| 182 | 163 #define YAFFS_OBJECT_TYPE_MAX YAFFS_OBJECT_TYPE_SPECIAL |
| 164 | |
| 77 | 165 typedef struct { |
| 0 | 166 |
| 167 unsigned validMarker0; | |
| 81 | 168 unsigned chunkUsed; /* Status of the chunk: used or unused */ |
| 169 unsigned objectId; /* If 0 then this is not part of an object (unused) */ | |
| 170 unsigned chunkId; /* If 0 then this is a header, else a data chunk */ | |
| 171 unsigned byteCount; /* Only valid for data chunks */ | |
| 77 | 172 |
| 81 | 173 /* The following stuff only has meaning when we read */ |
| 174 yaffs_ECCResult eccResult; | |
| 175 unsigned blockBad; | |
| 0 | 176 |
| 81 | 177 /* YAFFS 1 stuff */ |
| 178 unsigned chunkDeleted; /* The chunk is marked deleted */ | |
| 179 unsigned serialNumber; /* Yaffs1 2-bit serial number */ | |
| 77 | 180 |
| 81 | 181 /* YAFFS2 stuff */ |
| 182 unsigned sequenceNumber; /* The sequence number of this block */ | |
| 0 | 183 |
| 81 | 184 /* Extra info if this is an object header (YAFFS2 only) */ |
| 77 | 185 |
| 81 | 186 unsigned extraHeaderInfoAvailable; /* There is extra info available if this is not zero */ |
| 187 unsigned extraParentObjectId; /* The parent object */ | |
| 188 unsigned extraIsShrinkHeader; /* Is it a shrink header? */ | |
| 189 unsigned extraShadows; /* Does this shadow another object? */ | |
| 15 | 190 |
| 81 | 191 yaffs_ObjectType extraObjectType; /* What object type? */ |
| 15 | 192 |
| 81 | 193 unsigned extraFileLength; /* Length if it is a file */ |
| 194 unsigned extraEquivalentObjectId; /* Equivalent object Id if it is a hard link */ | |
| 77 | 195 |
| 196 unsigned validMarker1; | |
| 197 | |
| 0 | 198 } yaffs_ExtendedTags; |
| 199 | |
| 81 | 200 /* Spare structure for YAFFS1 */ |
| 77 | 201 typedef struct { |
| 202 __u8 tagByte0; | |
| 203 __u8 tagByte1; | |
| 204 __u8 tagByte2; | |
| 205 __u8 tagByte3; | |
| 81 | 206 __u8 pageStatus; /* set to 0 to delete the chunk */ |
| 77 | 207 __u8 blockStatus; |
| 208 __u8 tagByte4; | |
| 209 __u8 tagByte5; | |
| 210 __u8 ecc1[3]; | |
| 211 __u8 tagByte6; | |
| 212 __u8 tagByte7; | |
| 213 __u8 ecc2[3]; | |
| 0 | 214 } yaffs_Spare; |
| 215 | |
| 81 | 216 /*Special structure for passing through to mtd */ |
| 0 | 217 struct yaffs_NANDSpare { |
| 77 | 218 yaffs_Spare spare; |
| 219 int eccres1; | |
| 220 int eccres2; | |
| 0 | 221 }; |
| 222 | |
| 81 | 223 /* Block data in RAM */ |
| 0 | 224 |
| 225 typedef enum { | |
| 77 | 226 YAFFS_BLOCK_STATE_UNKNOWN = 0, |
| 4 | 227 |
| 0 | 228 YAFFS_BLOCK_STATE_SCANNING, |
| 77 | 229 YAFFS_BLOCK_STATE_NEEDS_SCANNING, |
| 81 | 230 /* The block might have something on it (ie it is allocating or full, perhaps empty) |
| 231 * but it needs to be scanned to determine its true state. | |
| 232 * This state is only valid during yaffs_Scan. | |
| 233 * NB We tolerate empty because the pre-scanner might be incapable of deciding | |
| 234 * However, if this state is returned on a YAFFS2 device, then we expect a sequence number | |
| 235 */ | |
| 77 | 236 |
| 237 YAFFS_BLOCK_STATE_EMPTY, | |
| 81 | 238 /* This block is empty */ |
| 0 | 239 |
| 77 | 240 YAFFS_BLOCK_STATE_ALLOCATING, |
| 81 | 241 /* This block is partially allocated. |
| 134 | 242 * At least one page holds valid data. |
| 81 | 243 * This is the one currently being used for page |
| 244 * allocation. Should never be more than one of these | |
| 245 */ | |
| 77 | 246 |
| 247 YAFFS_BLOCK_STATE_FULL, | |
| 81 | 248 /* All the pages in this block have been allocated. |
| 249 */ | |
| 0 | 250 |
| 77 | 251 YAFFS_BLOCK_STATE_DIRTY, |
| 81 | 252 /* All pages have been allocated and deleted. |
| 253 * Erase me, reuse me. | |
| 254 */ | |
| 77 | 255 |
| 134 | 256 YAFFS_BLOCK_STATE_CHECKPOINT, |
| 257 /* This block is assigned to holding checkpoint data. | |
| 258 */ | |
| 259 | |
| 77 | 260 YAFFS_BLOCK_STATE_COLLECTING, |
| 81 | 261 /* This block is being garbage collected */ |
| 77 | 262 |
| 263 YAFFS_BLOCK_STATE_DEAD | |
| 81 | 264 /* This block has failed and is not in use */ |
| 0 | 265 } yaffs_BlockState; |
| 266 | |
| 182 | 267 #define YAFFS_NUMBER_OF_BLOCK_STATES (YAFFS_BLOCK_STATE_DEAD + 1) |
| 268 | |
| 269 | |
| 77 | 270 typedef struct { |
| 0 | 271 |
| 153 | 272 int softDeletions:10; /* number of soft deleted pages */ |
| 273 int pagesInUse:10; /* number of pages in use */ | |
|
184
14d97b52d375
Change blockState field from enum to unsigned because some compilers use ints for enums which would break here
charles
parents:
182
diff
changeset
|
274 __u32 blockState:4; /* One of the above block states. NB use unsigned because enum is sometimes an int */ |
| 81 | 275 __u32 needsRetiring:1; /* Data has failed on this block, need to get valid data off */ |
| 276 /* and retire the block. */ | |
| 148 | 277 __u32 skipErasedCheck: 1; /* If this is set we can skip the erased check on this block */ |
| 182 | 278 __u32 gcPrioritise: 1; /* An ECC check or blank check has failed on this block. |
| 148 | 279 It should be prioritised for GC */ |
| 153 | 280 __u32 chunkErrorStrikes:3; /* How many times we've had ecc etc failures on this block and tried to reuse it */ |
| 148 | 281 |
| 4 | 282 #ifdef CONFIG_YAFFS_YAFFS2 |
| 81 | 283 __u32 hasShrinkHeader:1; /* This block has at least one shrink object header */ |
| 284 __u32 sequenceNumber; /* block sequence number for yaffs2 */ | |
| 0 | 285 #endif |
| 286 | |
| 287 } yaffs_BlockInfo; | |
| 288 | |
| 81 | 289 /* -------------------------- Object structure -------------------------------*/ |
| 290 /* This is the object structure as stored on NAND */ | |
| 0 | 291 |
| 77 | 292 typedef struct { |
| 0 | 293 yaffs_ObjectType type; |
| 294 | |
| 81 | 295 /* Apply to everything */ |
| 77 | 296 int parentObjectId; |
| 81 | 297 __u16 sum__NoLongerUsed; /* checksum of name. No longer used */ |
| 77 | 298 YCHAR name[YAFFS_MAX_NAME_LENGTH + 1]; |
| 0 | 299 |
| 81 | 300 /* Thes following apply to directories, files, symlinks - not hard links */ |
| 301 __u32 yst_mode; /* protection */ | |
| 0 | 302 |
| 303 #ifdef CONFIG_YAFFS_WINCE | |
| 304 __u32 notForWinCE[5]; | |
| 305 #else | |
| 81 | 306 __u32 yst_uid; |
| 307 __u32 yst_gid; | |
| 308 __u32 yst_atime; | |
| 309 __u32 yst_mtime; | |
| 310 __u32 yst_ctime; | |
| 0 | 311 #endif |
| 312 | |
| 81 | 313 /* File size applies to files only */ |
| 77 | 314 int fileSize; |
| 315 | |
| 81 | 316 /* Equivalent object id applies to hard links only. */ |
| 77 | 317 int equivalentObjectId; |
| 318 | |
| 81 | 319 /* Alias is for symlinks only. */ |
| 0 | 320 YCHAR alias[YAFFS_MAX_ALIAS_LENGTH + 1]; |
| 77 | 321 |
| 81 | 322 __u32 yst_rdev; /* device stuff for block and char devices (major/min) */ |
| 77 | 323 |
| 0 | 324 #ifdef CONFIG_YAFFS_WINCE |
| 325 __u32 win_ctime[2]; | |
| 326 __u32 win_atime[2]; | |
| 327 __u32 win_mtime[2]; | |
| 48 | 328 __u32 roomToGrow[4]; |
| 0 | 329 #else |
| 48 | 330 __u32 roomToGrow[10]; |
| 0 | 331 #endif |
| 332 | |
| 81 | 333 int shadowsObject; /* This object header shadows the specified object if > 0 */ |
| 48 | 334 |
| 81 | 335 /* isShrink applies to object headers written when we shrink the file (ie resize) */ |
| 0 | 336 __u32 isShrink; |
| 77 | 337 |
| 0 | 338 } yaffs_ObjectHeader; |
| 339 | |
| 81 | 340 /*--------------------------- Tnode -------------------------- */ |
| 0 | 341 |
| 77 | 342 union yaffs_Tnode_union { |
| 0 | 343 #ifdef CONFIG_YAFFS_TNODE_LIST_DEBUG |
| 77 | 344 union yaffs_Tnode_union *internal[YAFFS_NTNODES_INTERNAL + 1]; |
| 0 | 345 #else |
| 346 union yaffs_Tnode_union *internal[YAFFS_NTNODES_INTERNAL]; | |
| 347 #endif | |
| 105 | 348 /* __u16 level0[YAFFS_NTNODES_LEVEL0]; */ |
| 77 | 349 |
| 0 | 350 }; |
| 351 | |
| 352 typedef union yaffs_Tnode_union yaffs_Tnode; | |
| 353 | |
| 77 | 354 struct yaffs_TnodeList_struct { |
| 0 | 355 struct yaffs_TnodeList_struct *next; |
| 356 yaffs_Tnode *tnodes; | |
| 357 }; | |
| 358 | |
| 359 typedef struct yaffs_TnodeList_struct yaffs_TnodeList; | |
| 360 | |
| 81 | 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 */ | |
| 0 | 368 |
| 77 | 369 typedef struct { |
| 0 | 370 __u32 fileSize; |
| 371 __u32 scannedFileSize; | |
| 15 | 372 __u32 shrinkSize; |
| 77 | 373 int topLevel; |
| 0 | 374 yaffs_Tnode *top; |
| 375 } yaffs_FileStructure; | |
| 376 | |
| 77 | 377 typedef struct { |
| 81 | 378 struct list_head children; /* list of child links */ |
| 0 | 379 } yaffs_DirectoryStructure; |
| 380 | |
| 77 | 381 typedef struct { |
| 0 | 382 YCHAR *alias; |
| 383 } yaffs_SymLinkStructure; | |
| 384 | |
| 77 | 385 typedef struct { |
| 0 | 386 struct yaffs_ObjectStruct *equivalentObject; |
| 77 | 387 __u32 equivalentObjectId; |
| 0 | 388 } yaffs_HardLinkStructure; |
| 389 | |
| 77 | 390 typedef union { |
| 0 | 391 yaffs_FileStructure fileVariant; |
| 392 yaffs_DirectoryStructure directoryVariant; | |
| 393 yaffs_SymLinkStructure symLinkVariant; | |
| 394 yaffs_HardLinkStructure hardLinkVariant; | |
| 395 } yaffs_ObjectVariant; | |
| 396 | |
| 77 | 397 struct yaffs_ObjectStruct { |
| 81 | 398 __u8 deleted:1; /* This should only apply to unlinked files. */ |
| 399 __u8 softDeleted:1; /* it has also been soft deleted */ | |
| 400 __u8 unlinked:1; /* An unlinked file. The file should be in the unlinked directory.*/ | |
| 401 __u8 fake:1; /* A fake object has no presence on NAND. */ | |
| 402 __u8 renameAllowed:1; /* Some objects are not allowed to be renamed. */ | |
| 77 | 403 __u8 unlinkAllowed:1; |
| 81 | 404 __u8 dirty:1; /* the object needs to be written to flash */ |
| 405 __u8 valid:1; /* When the file system is being loaded up, this | |
| 406 * object might be created before the data | |
| 407 * is available (ie. file data records appear before the header). | |
| 408 */ | |
| 124 | 409 __u8 lazyLoaded:1; /* This object has been lazy loaded and is missing some detail */ |
| 0 | 410 |
| 81 | 411 __u8 deferedFree:1; /* For Linux kernel. Object is removed from NAND, but is |
| 412 * still in the inode cache. Free of object is defered. | |
| 413 * until the inode is released. | |
| 414 */ | |
| 4 | 415 |
| 124 | 416 __u8 serial; /* serial number of chunk in NAND. Cached here */ |
| 81 | 417 __u16 sum; /* sum of the name to speed searching */ |
| 418 | |
| 419 struct yaffs_DeviceStruct *myDev; /* The device I'm on */ | |
| 77 | 420 |
| 81 | 421 struct list_head hashLink; /* list of objects in this hash bucket */ |
| 4 | 422 |
| 81 | 423 struct list_head hardLinks; /* all the equivalent hard linked objects */ |
| 0 | 424 |
| 81 | 425 /* directory structure stuff */ |
| 426 /* also used for linking up the free list */ | |
| 427 struct yaffs_ObjectStruct *parent; | |
| 428 struct list_head siblings; | |
| 77 | 429 |
| 81 | 430 /* Where's my object header in NAND? */ |
| 431 int chunkId; | |
| 0 | 432 |
| 81 | 433 int nDataChunks; /* Number of data chunks attached to the file. */ |
| 77 | 434 |
| 81 | 435 __u32 objectId; /* the object id value */ |
| 77 | 436 |
| 81 | 437 __u32 yst_mode; |
| 0 | 438 |
| 439 #ifdef CONFIG_YAFFS_SHORT_NAMES_IN_RAM | |
| 77 | 440 YCHAR shortName[YAFFS_SHORT_NAME_LENGTH + 1]; |
| 0 | 441 #endif |
| 442 | |
| 443 #ifndef __KERNEL__ | |
| 444 __u32 inUse; | |
| 445 #endif | |
| 446 | |
| 447 #ifdef CONFIG_YAFFS_WINCE | |
| 448 __u32 win_ctime[2]; | |
| 449 __u32 win_mtime[2]; | |
| 450 __u32 win_atime[2]; | |
| 451 #else | |
| 81 | 452 __u32 yst_uid; |
| 453 __u32 yst_gid; | |
| 454 __u32 yst_atime; | |
| 455 __u32 yst_mtime; | |
| 456 __u32 yst_ctime; | |
| 0 | 457 #endif |
| 458 | |
| 81 | 459 __u32 yst_rdev; |
| 0 | 460 |
| 461 #ifdef __KERNEL__ | |
| 462 struct inode *myInode; | |
| 4 | 463 |
| 0 | 464 #endif |
| 465 | |
| 77 | 466 yaffs_ObjectType variantType; |
| 0 | 467 |
| 468 yaffs_ObjectVariant variant; | |
| 77 | 469 |
| 0 | 470 }; |
| 471 | |
| 472 typedef struct yaffs_ObjectStruct yaffs_Object; | |
| 473 | |
| 77 | 474 struct yaffs_ObjectList_struct { |
| 0 | 475 yaffs_Object *objects; |
| 476 struct yaffs_ObjectList_struct *next; | |
| 477 }; | |
| 478 | |
| 479 typedef struct yaffs_ObjectList_struct yaffs_ObjectList; | |
| 480 | |
| 77 | 481 typedef struct { |
| 0 | 482 struct list_head list; |
| 483 int count; | |
| 484 } yaffs_ObjectBucket; | |
| 485 | |
| 131 | 486 |
| 487 /* yaffs_CheckpointObject holds the definition of an object as dumped | |
| 488 * by checkpointing. | |
| 489 */ | |
| 490 | |
| 491 typedef struct { | |
| 492 int structType; | |
| 493 __u32 objectId; | |
| 494 __u32 parentId; | |
| 495 int chunkId; | |
| 496 | |
| 497 yaffs_ObjectType variantType:3; | |
| 498 __u8 deleted:1; | |
| 499 __u8 softDeleted:1; | |
| 500 __u8 unlinked:1; | |
| 501 __u8 fake:1; | |
| 502 __u8 renameAllowed:1; | |
| 503 __u8 unlinkAllowed:1; | |
| 504 __u8 serial; | |
| 505 | |
| 506 int nDataChunks; | |
| 507 __u32 fileSizeOrEquivalentObjectId; | |
| 508 | |
| 509 }yaffs_CheckpointObject; | |
| 510 | |
| 81 | 511 /*--------------------- Temporary buffers ---------------- |
| 512 * | |
| 513 * These are chunk-sized working buffers. Each device has a few | |
| 514 */ | |
| 0 | 515 |
| 516 typedef struct { | |
| 517 __u8 *buffer; | |
| 81 | 518 int line; /* track from whence this buffer was allocated */ |
| 0 | 519 int maxLine; |
| 520 } yaffs_TempBuffer; | |
| 521 | |
| 81 | 522 /*----------------- Device ---------------------------------*/ |
| 0 | 523 |
| 77 | 524 struct yaffs_DeviceStruct { |
| 29 | 525 struct list_head devList; |
| 526 const char *name; | |
| 527 | |
| 81 | 528 /* Entry parameters set up way early. Yaffs sets up the rest.*/ |
|
152
3bc7020d669c
Add large NAND support and improve retirement handling
charles
parents:
148
diff
changeset
|
529 int nDataBytesPerChunk; /* Should be a power of 2 >= 512 */ |
| 81 | 530 int nChunksPerBlock; /* does not need to be a power of 2 */ |
| 531 int nBytesPerSpare; /* spare area size */ | |
| 532 int startBlock; /* Start block we're allowed to use */ | |
| 533 int endBlock; /* End block we're allowed to use */ | |
| 534 int nReservedBlocks; /* We want this tuneable so that we can reduce */ | |
| 535 /* reserved blocks on NOR and RAM. */ | |
| 134 | 536 |
| 537 | |
| 538 /* Stuff used by the shared space checkpointing mechanism */ | |
| 539 /* If this value is zero, then this mechanism is disabled */ | |
| 540 | |
| 541 int nCheckpointReservedBlocks; /* Blocks to reserve for checkpoint data */ | |
| 131 | 542 |
| 543 | |
| 544 | |
| 0 | 545 |
| 81 | 546 int nShortOpCaches; /* If <= 0, then short op caching is disabled, else |
| 547 * the number of short op caches (don't use too many) | |
| 548 */ | |
| 77 | 549 |
| 81 | 550 int useHeaderFileSize; /* Flag to determine if we should use file sizes from the header */ |
| 77 | 551 |
| 81 | 552 int useNANDECC; /* Flag to decide whether or not to use NANDECC */ |
| 77 | 553 |
| 81 | 554 void *genericDevice; /* Pointer to device context |
| 555 * On an mtd this holds the mtd pointer. | |
| 556 */ | |
| 134 | 557 void *superBlock; |
| 558 | |
| 81 | 559 /* NAND access functions (Must be set before calling YAFFS)*/ |
| 4 | 560 |
| 77 | 561 int (*writeChunkToNAND) (struct yaffs_DeviceStruct * dev, |
| 562 int chunkInNAND, const __u8 * data, | |
| 563 const yaffs_Spare * spare); | |
| 564 int (*readChunkFromNAND) (struct yaffs_DeviceStruct * dev, | |
| 565 int chunkInNAND, __u8 * data, | |
| 566 yaffs_Spare * spare); | |
| 567 int (*eraseBlockInNAND) (struct yaffs_DeviceStruct * dev, | |
| 568 int blockInNAND); | |
| 569 int (*initialiseNAND) (struct yaffs_DeviceStruct * dev); | |
| 4 | 570 |
| 571 #ifdef CONFIG_YAFFS_YAFFS2 | |
| 77 | 572 int (*writeChunkWithTagsToNAND) (struct yaffs_DeviceStruct * dev, |
| 573 int chunkInNAND, const __u8 * data, | |
| 574 const yaffs_ExtendedTags * tags); | |
| 575 int (*readChunkWithTagsFromNAND) (struct yaffs_DeviceStruct * dev, | |
| 576 int chunkInNAND, __u8 * data, | |
| 577 yaffs_ExtendedTags * tags); | |
| 578 int (*markNANDBlockBad) (struct yaffs_DeviceStruct * dev, int blockNo); | |
| 579 int (*queryNANDBlock) (struct yaffs_DeviceStruct * dev, int blockNo, | |
| 580 yaffs_BlockState * state, int *sequenceNumber); | |
| 0 | 581 #endif |
| 582 | |
| 583 int isYaffs2; | |
| 84 | 584 |
| 585 /* The removeObjectCallback function must be supplied by OS flavours that | |
| 586 * need it. The Linux kernel does not use this, but yaffs direct does use | |
| 587 * it to implement the faster readdir | |
| 588 */ | |
| 589 void (*removeObjectCallback)(struct yaffs_ObjectStruct *obj); | |
| 590 | |
| 134 | 591 /* Callback to mark the superblock dirsty */ |
| 592 void (*markSuperBlockDirty)(void * superblock); | |
| 593 | |
| 105 | 594 int wideTnodesDisabled; /* Set to disable wide tnodes */ |
| 595 | |
| 0 | 596 |
| 81 | 597 /* End of stuff that must be set before initialisation. */ |
| 182 | 598 |
| 599 /* Checkpoint control. Can be set before or after initialisation */ | |
| 600 __u8 skipCheckpointRead; | |
| 601 __u8 skipCheckpointWrite; | |
| 77 | 602 |
| 81 | 603 /* Runtime parameters. Set up by YAFFS. */ |
| 77 | 604 |
| 81 | 605 __u16 chunkGroupBits; /* 0 for devices <= 32MB. else log2(nchunks) - 16 */ |
| 606 __u16 chunkGroupSize; /* == 2^^chunkGroupBits */ | |
| 105 | 607 |
| 608 /* Stuff to support wide tnodes */ | |
| 609 __u32 tnodeWidth; | |
| 610 __u32 tnodeMask; | |
| 611 | |
|
152
3bc7020d669c
Add large NAND support and improve retirement handling
charles
parents:
148
diff
changeset
|
612 /* Stuff to support various file offses to chunk/offset translations */ |
|
3bc7020d669c
Add large NAND support and improve retirement handling
charles
parents:
148
diff
changeset
|
613 /* "Crumbs" for nDataBytesPerChunk not being a power of 2 */ |
|
3bc7020d669c
Add large NAND support and improve retirement handling
charles
parents:
148
diff
changeset
|
614 __u32 crumbMask; |
|
3bc7020d669c
Add large NAND support and improve retirement handling
charles
parents:
148
diff
changeset
|
615 __u32 crumbShift; |
|
3bc7020d669c
Add large NAND support and improve retirement handling
charles
parents:
148
diff
changeset
|
616 __u32 crumbsPerChunk; |
|
3bc7020d669c
Add large NAND support and improve retirement handling
charles
parents:
148
diff
changeset
|
617 |
|
3bc7020d669c
Add large NAND support and improve retirement handling
charles
parents:
148
diff
changeset
|
618 /* Straight shifting for nDataBytesPerChunk being a power of 2 */ |
|
3bc7020d669c
Add large NAND support and improve retirement handling
charles
parents:
148
diff
changeset
|
619 __u32 chunkShift; |
|
3bc7020d669c
Add large NAND support and improve retirement handling
charles
parents:
148
diff
changeset
|
620 __u32 chunkMask; |
|
3bc7020d669c
Add large NAND support and improve retirement handling
charles
parents:
148
diff
changeset
|
621 |
| 77 | 622 |
| 0 | 623 #ifdef __KERNEL__ |
| 624 | |
| 81 | 625 struct semaphore sem; /* Semaphore for waiting on erasure.*/ |
| 626 struct semaphore grossLock; /* Gross locking semaphore */ | |
| 627 __u8 *spareBuffer; /* For mtdif2 use. Don't know the size of the buffer | |
| 628 * at compile time so we have to allocate it. | |
| 629 */ | |
| 77 | 630 void (*putSuperFunc) (struct super_block * sb); |
| 0 | 631 #endif |
| 632 | |
| 633 int isMounted; | |
| 131 | 634 |
| 635 int isCheckpointed; | |
| 77 | 636 |
|
152
3bc7020d669c
Add large NAND support and improve retirement handling
charles
parents:
148
diff
changeset
|
637 |
| 81 | 638 /* Stuff to support block offsetting to support start block zero */ |
| 21 | 639 int internalStartBlock; |
| 640 int internalEndBlock; | |
| 641 int blockOffset; | |
| 642 int chunkOffset; | |
| 131 | 643 |
| 77 | 644 |
| 131 | 645 /* Runtime checkpointing stuff */ |
| 134 | 646 int checkpointPageSequence; /* running sequence number of checkpoint pages */ |
| 131 | 647 int checkpointByteCount; |
| 648 int checkpointByteOffset; | |
| 649 __u8 *checkpointBuffer; | |
| 650 int checkpointOpenForWrite; | |
| 134 | 651 int blocksInCheckpoint; |
| 652 int checkpointCurrentChunk; | |
| 653 int checkpointCurrentBlock; | |
| 654 int checkpointNextBlock; | |
| 655 int *checkpointBlockList; | |
| 656 int checkpointMaxBlocks; | |
| 182 | 657 __u32 checkpointSum; |
| 658 __u32 checkpointXor; | |
| 131 | 659 |
| 81 | 660 /* Block Info */ |
| 0 | 661 yaffs_BlockInfo *blockInfo; |
| 81 | 662 __u8 *chunkBits; /* bitmap of chunks in use */ |
| 95 | 663 unsigned blockInfoAlt:1; /* was allocated using alternative strategy */ |
| 664 unsigned chunkBitsAlt:1; /* was allocated using alternative strategy */ | |
| 81 | 665 int chunkBitmapStride; /* Number of bytes of chunkBits per block. |
| 666 * Must be consistent with nChunksPerBlock. | |
| 667 */ | |
| 0 | 668 |
| 77 | 669 int nErasedBlocks; |
| 81 | 670 int allocationBlock; /* Current block being allocated off */ |
| 0 | 671 __u32 allocationPage; |
| 81 | 672 int allocationBlockFinder; /* Used to search for next allocation block */ |
| 77 | 673 |
| 81 | 674 /* Runtime state */ |
| 77 | 675 int nTnodesCreated; |
| 0 | 676 yaffs_Tnode *freeTnodes; |
| 77 | 677 int nFreeTnodes; |
| 0 | 678 yaffs_TnodeList *allocatedTnodeList; |
| 679 | |
| 77 | 680 int isDoingGC; |
| 0 | 681 |
| 77 | 682 int nObjectsCreated; |
| 0 | 683 yaffs_Object *freeObjects; |
| 77 | 684 int nFreeObjects; |
| 0 | 685 |
| 686 yaffs_ObjectList *allocatedObjectList; | |
| 687 | |
| 688 yaffs_ObjectBucket objectBucket[YAFFS_NOBJECT_BUCKETS]; | |
| 689 | |
| 77 | 690 int nFreeChunks; |
| 691 | |
| 81 | 692 int currentDirtyChecker; /* Used to find current dirtiest block */ |
| 77 | 693 |
| 81 | 694 __u32 *gcCleanupList; /* objects to delete at the end of a GC. */ |
| 77 | 695 |
| 81 | 696 /* Statistcs */ |
| 0 | 697 int nPageWrites; |
| 698 int nPageReads; | |
| 699 int nBlockErasures; | |
| 700 int nErasureFailures; | |
| 701 int nGCCopies; | |
| 702 int garbageCollections; | |
| 703 int passiveGarbageCollections; | |
| 704 int nRetriedWrites; | |
| 705 int nRetiredBlocks; | |
| 706 int eccFixed; | |
| 707 int eccUnfixed; | |
| 708 int tagsEccFixed; | |
| 709 int tagsEccUnfixed; | |
| 710 int nDeletions; | |
| 711 int nUnmarkedDeletions; | |
|
152
3bc7020d669c
Add large NAND support and improve retirement handling
charles
parents:
148
diff
changeset
|
712 |
|
3bc7020d669c
Add large NAND support and improve retirement handling
charles
parents:
148
diff
changeset
|
713 int hasPendingPrioritisedGCs; /* We think this device might have pending prioritised gcs */ |
| 77 | 714 |
| 81 | 715 /* Special directories */ |
| 0 | 716 yaffs_Object *rootDir; |
| 717 yaffs_Object *lostNFoundDir; | |
| 77 | 718 |
| 81 | 719 /* Buffer areas for storing data to recover from write failures TODO |
| 720 * __u8 bufferedData[YAFFS_CHUNKS_PER_BLOCK][YAFFS_BYTES_PER_CHUNK]; | |
| 721 * yaffs_Spare bufferedSpare[YAFFS_CHUNKS_PER_BLOCK]; | |
| 722 */ | |
| 0 | 723 |
| 81 | 724 int bufferedBlock; /* Which block is buffered here? */ |
| 0 | 725 int doingBufferedBlockRewrite; |
| 726 | |
| 727 yaffs_ChunkCache *srCache; | |
| 728 int srLastUse; | |
| 729 | |
| 730 int cacheHits; | |
| 731 | |
| 81 | 732 /* Stuff for background deletion and unlinked files.*/ |
| 733 yaffs_Object *unlinkedDir; /* Directory where unlinked and deleted files live. */ | |
| 734 yaffs_Object *deletedDir; /* Directory where deleted objects are sent to disappear. */ | |
| 735 yaffs_Object *unlinkedDeletion; /* Current file being background deleted.*/ | |
| 736 int nDeletedFiles; /* Count of files awaiting deletion;*/ | |
| 737 int nUnlinkedFiles; /* Count of unlinked files. */ | |
| 738 int nBackgroundDeletions; /* Count of background deletions. */ | |
| 77 | 739 |
| 740 | |
| 0 | 741 yaffs_TempBuffer tempBuffer[YAFFS_N_TEMP_BUFFERS]; |
| 742 int maxTemp; | |
| 743 int unmanagedTempAllocations; | |
| 744 int unmanagedTempDeallocations; | |
| 77 | 745 |
| 81 | 746 /* yaffs2 runtime stuff */ |
| 747 unsigned sequenceNumber; /* Sequence number of currently allocating block */ | |
| 0 | 748 unsigned oldestDirtySequence; |
| 77 | 749 |
| 0 | 750 }; |
| 751 | |
| 752 typedef struct yaffs_DeviceStruct yaffs_Device; | |
| 753 | |
| 131 | 754 /* The static layout of bllock usage etc is stored in the super block header */ |
| 755 typedef struct { | |
| 756 int StructType; | |
| 757 int version; | |
| 758 int checkpointStartBlock; | |
| 759 int checkpointEndBlock; | |
| 760 int startBlock; | |
| 761 int endBlock; | |
| 762 int rfu[100]; | |
| 763 } yaffs_SuperBlockHeader; | |
| 764 | |
| 765 /* The CheckpointDevice structure holds the device information that changes at runtime and | |
| 766 * must be preserved over unmount/mount cycles. | |
| 767 */ | |
| 768 typedef struct { | |
| 769 int structType; | |
| 770 int nErasedBlocks; | |
| 771 int allocationBlock; /* Current block being allocated off */ | |
| 772 __u32 allocationPage; | |
| 773 int nFreeChunks; | |
| 774 | |
| 775 int nDeletedFiles; /* Count of files awaiting deletion;*/ | |
| 776 int nUnlinkedFiles; /* Count of unlinked files. */ | |
| 777 int nBackgroundDeletions; /* Count of background deletions. */ | |
| 778 | |
| 779 /* yaffs2 runtime stuff */ | |
| 780 unsigned sequenceNumber; /* Sequence number of currently allocating block */ | |
| 781 unsigned oldestDirtySequence; | |
| 782 | |
| 783 } yaffs_CheckpointDevice; | |
| 784 | |
| 785 | |
| 786 typedef struct { | |
| 787 int structType; | |
| 788 __u32 magic; | |
| 789 __u32 version; | |
| 790 __u32 head; | |
| 791 } yaffs_CheckpointValidity; | |
| 792 | |
| 81 | 793 /* Function to manipulate block info */ |
| 77 | 794 static Y_INLINE yaffs_BlockInfo *yaffs_GetBlockInfo(yaffs_Device * dev, int blk) |
| 0 | 795 { |
| 77 | 796 if (blk < dev->internalStartBlock || blk > dev->internalEndBlock) { |
| 797 T(YAFFS_TRACE_ERROR, | |
| 798 (TSTR | |
| 799 ("**>> yaffs: getBlockInfo block %d is not valid" TENDSTR), | |
| 800 blk)); | |
| 0 | 801 YBUG(); |
| 802 } | |
| 22 | 803 return &dev->blockInfo[blk - dev->internalStartBlock]; |
| 0 | 804 } |
| 805 | |
| 81 | 806 /*----------------------- YAFFS Functions -----------------------*/ |
| 0 | 807 |
| 77 | 808 int yaffs_GutsInitialise(yaffs_Device * dev); |
| 809 void yaffs_Deinitialise(yaffs_Device * dev); | |
| 0 | 810 |
| 77 | 811 int yaffs_GetNumberOfFreeChunks(yaffs_Device * dev); |
| 0 | 812 |
| 77 | 813 int yaffs_RenameObject(yaffs_Object * oldDir, const YCHAR * oldName, |
| 814 yaffs_Object * newDir, const YCHAR * newName); | |
| 0 | 815 |
| 77 | 816 int yaffs_Unlink(yaffs_Object * dir, const YCHAR * name); |
| 817 int yaffs_DeleteFile(yaffs_Object * obj); | |
| 0 | 818 |
| 77 | 819 int yaffs_GetObjectName(yaffs_Object * obj, YCHAR * name, int buffSize); |
| 820 int yaffs_GetObjectFileLength(yaffs_Object * obj); | |
| 821 int yaffs_GetObjectInode(yaffs_Object * obj); | |
| 822 unsigned yaffs_GetObjectType(yaffs_Object * obj); | |
| 823 int yaffs_GetObjectLinkCount(yaffs_Object * obj); | |
| 0 | 824 |
| 77 | 825 int yaffs_SetAttributes(yaffs_Object * obj, struct iattr *attr); |
| 826 int yaffs_GetAttributes(yaffs_Object * obj, struct iattr *attr); | |
| 0 | 827 |
| 81 | 828 /* File operations */ |
|
152
3bc7020d669c
Add large NAND support and improve retirement handling
charles
parents:
148
diff
changeset
|
829 int yaffs_ReadDataFromFile(yaffs_Object * obj, __u8 * buffer, loff_t offset, |
| 77 | 830 int nBytes); |
|
152
3bc7020d669c
Add large NAND support and improve retirement handling
charles
parents:
148
diff
changeset
|
831 int yaffs_WriteDataToFile(yaffs_Object * obj, const __u8 * buffer, loff_t offset, |
| 77 | 832 int nBytes, int writeThrough); |
|
152
3bc7020d669c
Add large NAND support and improve retirement handling
charles
parents:
148
diff
changeset
|
833 int yaffs_ResizeFile(yaffs_Object * obj, loff_t newSize); |
| 0 | 834 |
| 77 | 835 yaffs_Object *yaffs_MknodFile(yaffs_Object * parent, const YCHAR * name, |
| 836 __u32 mode, __u32 uid, __u32 gid); | |
| 837 int yaffs_FlushFile(yaffs_Object * obj, int updateTime); | |
| 0 | 838 |
| 131 | 839 /* Flushing and checkpointing */ |
| 840 void yaffs_FlushEntireDeviceCache(yaffs_Device *dev); | |
| 841 | |
| 842 int yaffs_CheckpointSave(yaffs_Device *dev); | |
| 843 int yaffs_CheckpointRestore(yaffs_Device *dev); | |
| 844 | |
| 81 | 845 /* Directory operations */ |
| 77 | 846 yaffs_Object *yaffs_MknodDirectory(yaffs_Object * parent, const YCHAR * name, |
| 847 __u32 mode, __u32 uid, __u32 gid); | |
| 848 yaffs_Object *yaffs_FindObjectByName(yaffs_Object * theDir, const YCHAR * name); | |
| 849 int yaffs_ApplyToDirectoryChildren(yaffs_Object * theDir, | |
| 850 int (*fn) (yaffs_Object *)); | |
| 0 | 851 |
| 77 | 852 yaffs_Object *yaffs_FindObjectByNumber(yaffs_Device * dev, __u32 number); |
| 0 | 853 |
| 81 | 854 /* Link operations */ |
| 77 | 855 yaffs_Object *yaffs_Link(yaffs_Object * parent, const YCHAR * name, |
| 856 yaffs_Object * equivalentObject); | |
| 0 | 857 |
| 77 | 858 yaffs_Object *yaffs_GetEquivalentObject(yaffs_Object * obj); |
| 0 | 859 |
| 81 | 860 /* Symlink operations */ |
| 77 | 861 yaffs_Object *yaffs_MknodSymLink(yaffs_Object * parent, const YCHAR * name, |
| 862 __u32 mode, __u32 uid, __u32 gid, | |
| 863 const YCHAR * alias); | |
| 864 YCHAR *yaffs_GetSymlinkAlias(yaffs_Object * obj); | |
| 0 | 865 |
| 81 | 866 /* Special inodes (fifos, sockets and devices) */ |
| 77 | 867 yaffs_Object *yaffs_MknodSpecial(yaffs_Object * parent, const YCHAR * name, |
| 868 __u32 mode, __u32 uid, __u32 gid, __u32 rdev); | |
| 0 | 869 |
| 81 | 870 /* Special directories */ |
| 77 | 871 yaffs_Object *yaffs_Root(yaffs_Device * dev); |
| 872 yaffs_Object *yaffs_LostNFound(yaffs_Device * dev); | |
| 0 | 873 |
| 874 #ifdef CONFIG_YAFFS_WINCE | |
| 81 | 875 /* CONFIG_YAFFS_WINCE special stuff */ |
| 77 | 876 void yfsd_WinFileTimeNow(__u32 target[2]); |
| 0 | 877 #endif |
| 878 | |
| 4 | 879 #ifdef __KERNEL__ |
| 880 | |
| 77 | 881 void yaffs_HandleDeferedFree(yaffs_Object * obj); |
| 4 | 882 #endif |
| 883 | |
| 81 | 884 /* Debug dump */ |
| 77 | 885 int yaffs_DumpObject(yaffs_Object * obj); |
| 0 | 886 |
| 77 | 887 void yaffs_GutsTest(yaffs_Device * dev); |
| 0 | 888 |
| 84 | 889 /* A few useful functions */ |
| 77 | 890 void yaffs_InitialiseTags(yaffs_ExtendedTags * tags); |
| 891 void yaffs_DeleteChunk(yaffs_Device * dev, int chunkId, int markNAND, int lyn); | |
| 892 int yaffs_CheckFF(__u8 * buffer, int nBytes); | |
| 153 | 893 void yaffs_HandleChunkError(yaffs_Device *dev, yaffs_BlockInfo *bi); |
| 0 | 894 |
| 895 #endif |