2 * YAFFS: Yet another Flash File System . A NAND-flash specific file system.
4 * Copyright (C) 2002-2018 Aleph One Ltd.
6 * Created by Charles Manning <charles@aleph1.co.uk>
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.
12 * Note: Only YAFFS headers are LGPL, YAFFS C code is covered by GPL.
15 #ifndef __YAFFS_GUTS_H__
16 #define __YAFFS_GUTS_H__
27 * And what have we got...
29 #define YAFFS_MAGIC 0x5941ff53
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.
36 * A maximum level of 8 thust supports files of size up to:
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.
43 #define YAFFS_NTNODES_LEVEL0 16
44 #define YAFFS_TNODES_LEVEL0_BITS 4
45 #define YAFFS_TNODES_LEVEL0_MASK 0xf
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)
56 #define YAFFS_MAX_FILE_SIZE_32 0x7fffffff
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)
65 #define YAFFS_MIN_YAFFS2_CHUNK_SIZE 1024
66 #define YAFFS_MIN_YAFFS2_SPARE_SIZE 32
70 #define YAFFS_ALLOCATION_NOBJECTS 100
71 #define YAFFS_ALLOCATION_NTNODES 100
72 #define YAFFS_ALLOCATION_NLINKS 100
74 #define YAFFS_NOBJECT_BUCKETS 256
76 #define YAFFS_OBJECT_SPACE 0x40000
77 #define YAFFS_MAX_OBJECT_ID (YAFFS_OBJECT_SPACE - 1)
79 /* Binary data version stamps */
80 #define YAFFS_SUMMARY_VERSION 1
82 #ifdef CONFIG_YAFFS_UNICODE
83 #define YAFFS_MAX_NAME_LENGTH 127
84 #define YAFFS_MAX_ALIAS_LENGTH 79
86 #define YAFFS_MAX_NAME_LENGTH 255
87 #define YAFFS_MAX_ALIAS_LENGTH 159
90 #define YAFFS_SHORT_NAME_LENGTH 15
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
98 /* Fake object Id for summary data */
99 #define YAFFS_OBJECTID_SUMMARY 0x10
101 /* Pseudo object ids for checkpointing */
102 #define YAFFS_OBJECTID_CHECKPOINT_DATA 0x20
103 #define YAFFS_SEQUENCE_CHECKPOINT_DATA 0x21
105 #define YAFFS_MAX_SHORT_OP_CACHES 20
107 #define YAFFS_N_TEMP_BUFFERS 6
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.
113 #define YAFFS_WR_ATTEMPTS (5*64)
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
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.
122 #define YAFFS_LOWEST_SEQUENCE_NUMBER 0x00001000
123 #define YAFFS_HIGHEST_SEQUENCE_NUMBER 0xefffff00
125 /* Special sequence number for bad block that failed to be marked bad */
126 #define YAFFS_SEQUENCE_BAD_BLOCK 0xffff0000
128 /* Chunk cache is used for short read/write operations.*/
130 struct yaffs_obj *object;
134 int n_bytes; /* Only valid if the cache is dirty */
135 int locked; /* Can't push out or flush while locked. */
139 struct yaffs_cache_manager {
140 struct yaffs_cache *cache;
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.
160 union yaffs_tags_union {
161 struct yaffs_tags as_tags;
167 /* Stuff used for extended tags in YAFFS2 */
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
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.
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
191 #define YAFFS_OBJECT_TYPE_MAX YAFFS_OBJECT_TYPE_SPECIAL
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 */
199 /* The following stuff only has meaning when we read */
200 enum yaffs_ecc_result ecc_result;
204 unsigned is_deleted; /* The chunk is marked deleted */
205 unsigned serial_number; /* Yaffs1 2-bit serial number */
208 unsigned seq_number; /* The sequence number of this block */
210 /* Extra info if this is an object header (YAFFS2 only) */
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? */
217 enum yaffs_obj_type extra_obj_type; /* What object type? */
219 loff_t extra_file_size; /* Length if it is a file */
220 unsigned extra_equiv_id; /* Equivalent object for a hard link */
223 /* Spare structure for YAFFS1 */
229 u8 page_status; /* set to 0 to delete the chunk */
239 /*Special structure for passing through to mtd */
240 struct yaffs_nand_spare {
241 struct yaffs_spare spare;
246 /* Block data in RAM */
248 enum yaffs_block_state {
249 YAFFS_BLOCK_STATE_UNKNOWN = 0,
251 YAFFS_BLOCK_STATE_SCANNING,
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
258 * This state is only valid during scanning.
259 * NB We tolerate empty because the pre-scanner might be incapable of
261 * However, if this state is returned on a YAFFS2 device,
262 * then we expect a sequence number
265 YAFFS_BLOCK_STATE_EMPTY,
266 /* This block is empty */
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
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.
283 YAFFS_BLOCK_STATE_DIRTY,
284 /* The block was full and now all chunks have been deleted.
285 * Erase me, reuse me.
288 YAFFS_BLOCK_STATE_CHECKPOINT,
289 /* This block is assigned to holding checkpoint data. */
291 YAFFS_BLOCK_STATE_COLLECTING,
292 /* This block is being garbage collected */
294 YAFFS_BLOCK_STATE_DEAD
295 /* This block has failed and is not in use */
298 #define YAFFS_NUMBER_OF_BLOCK_STATES (YAFFS_BLOCK_STATE_DEAD + 1)
300 struct yaffs_block_info {
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
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 */
316 u32 has_shrink_hdr:1; /* This block has at least one shrink header */
317 u32 seq_number; /* block sequence number for yaffs2 */
321 union yaffs_block_info_union {
322 struct yaffs_block_info bi;
326 /* -------------------------- Object structure -------------------------------*/
327 /* This is the object structure as stored on NAND */
329 struct yaffs_obj_hdr {
330 u32 type; /* enum yaffs_obj_type */
332 /* Apply to everything */
334 u16 sum_no_longer_used; /* checksum of name. No longer used */
335 YCHAR name[YAFFS_MAX_NAME_LENGTH + 1];
337 /* The following apply to all object types except for hard links */
338 u32 yst_mode; /* protection */
346 /* File size applies to files only */
349 /* Equivalent object id applies to hard links only. */
352 /* Alias is for symlinks only. */
353 YCHAR alias[YAFFS_MAX_ALIAS_LENGTH + 1];
355 u32 yst_rdev; /* stuff for block and char devices (major/min) */
358 * WinCE times are no longer just used to store WinCE times.
359 * They are also used to store 64-bit times.
360 * We actually store and read the times in both places and use
367 u32 inband_shadowed_obj_id;
368 u32 inband_is_shrink;
372 int shadows_obj; /* This object header shadows the
373 specified object if > 0 */
375 /* is_shrink applies to object headers written when wemake a hole. */
380 /*--------------------------- Tnode -------------------------- */
383 struct yaffs_tnode *internal[YAFFS_NTNODES_INTERNAL];
386 /*------------------------ Object -----------------------------*/
387 /* An object can be one of:
388 * - a directory (no data, has children links
389 * - a regular file (data.... not prunes :->).
390 * - a symlink [symbolic link] (the alias).
394 /* The file variant has three file sizes:
395 * - file_size : size of file as written into Yaffs - including data in cache.
396 * - stored_size - size of file as stored on media.
397 * - shrink_size - size of file that has been shrunk back to.
399 * The stored_size and file_size might be different because the data written
400 * into the cache will increase the file_size but the stored_size will only
401 * change when the data is actually stored.
404 struct yaffs_file_var {
409 struct yaffs_tnode *top;
412 struct yaffs_dir_var {
413 struct list_head children; /* list of child links */
414 struct list_head dirty; /* Entry for list of dirty directories */
417 struct yaffs_symlink_var {
421 struct yaffs_hardlink_var {
422 struct yaffs_obj *equiv_obj;
426 union yaffs_obj_var {
427 struct yaffs_file_var file_variant;
428 struct yaffs_dir_var dir_variant;
429 struct yaffs_symlink_var symlink_variant;
430 struct yaffs_hardlink_var hardlink_variant;
434 u8 deleted:1; /* This should only apply to unlinked files. */
435 u8 soft_del:1; /* it has also been soft deleted */
436 u8 unlinked:1; /* An unlinked file.*/
437 u8 fake:1; /* A fake object has no presence on NAND. */
438 u8 rename_allowed:1; /* Some objects cannot be renamed. */
440 u8 dirty:1; /* the object needs to be written to flash */
441 u8 valid:1; /* When the file system is being loaded up, this
442 * object might be created before the data
444 * ie. file data chunks encountered before
447 u8 lazy_loaded:1; /* This object has been lazy loaded and
448 * is missing some detail */
450 u8 defered_free:1; /* Object is removed from NAND, but is
451 * still in the inode cache.
452 * Free of object is defered.
453 * until the inode is released.
455 u8 being_created:1; /* This object is still being created
456 * so skip some verification checks. */
457 u8 is_shadowed:1; /* This object is shadowed on the way
458 * to being renamed. */
460 u8 xattr_known:1; /* We know if this has object has xattribs
462 u8 has_xattr:1; /* This object has xattribs.
463 * Only valid if xattr_known. */
465 u8 serial; /* serial number of chunk in NAND.*/
466 u16 sum; /* sum of the name to speed searching */
468 struct yaffs_dev *my_dev; /* The device I'm on */
470 struct list_head hash_link; /* list of objects in hash bucket */
472 struct list_head hard_links; /* hard linked object chain*/
474 /* directory structure stuff */
475 /* also used for linking up the free list */
476 struct yaffs_obj *parent;
477 struct list_head siblings;
479 /* Where's my object header in NAND? */
482 int n_data_chunks; /* Number of data chunks for this file. */
484 u32 obj_id; /* the object id value */
488 YCHAR short_name[YAFFS_SHORT_NAME_LENGTH + 1];
490 #ifdef CONFIG_YAFFS_WINCE
491 //these are always 64 bits
496 //these can be 32 or 64 bits
508 u32 variant_type; /* enum yaffs_object_type */
510 union yaffs_obj_var variant;
514 struct yaffs_obj_bucket {
515 struct list_head list;
520 /*--------------------- Temporary buffers ----------------
522 * These are chunk-sized working buffers. Each device has a few.
525 struct yaffs_buffer {
530 /*----------------- Device ---------------------------------*/
536 * Entry parameters set up way early. Yaffs sets up the rest.
537 * The structure should be zeroed out before use so that unused
538 * and default values are zero.
541 int inband_tags; /* Use unband tags */
542 u32 total_bytes_per_chunk; /* Should be >= 512, does not need to
544 u32 chunks_per_block; /* does not need to be a power of 2 */
545 u32 spare_bytes_per_chunk; /* spare area size */
546 u32 start_block; /* Start block we're allowed to use */
547 u32 end_block; /* End block we're allowed to use */
548 u32 n_reserved_blocks; /* Tuneable so that we can reduce
549 * reserved blocks on NOR and RAM. */
551 u32 n_caches; /* If == 0, then short op caching is disabled,
552 * else the number of short op caches.
554 int cache_bypass_aligned; /* If non-zero then bypass the cache for
558 int use_nand_ecc; /* Flag to decide whether or not to use
559 * NAND driver ECC on data (yaffs1) */
560 int tags_9bytes; /* Use 9 byte tags */
561 int no_tags_ecc; /* Flag to decide whether or not to do ECC
562 * on packed tags (yaffs2) */
564 int is_yaffs2; /* Use yaffs2 mode on this device */
566 int empty_lost_n_found; /* Auto-empty lost+found directory on mount */
568 int refresh_period; /* How often to check for a block refresh */
570 /* Checkpoint control. Can be set before or after initialisation */
574 int enable_xattr; /* Enable xattribs */
577 * Set to limit the number of objects created.
581 int hide_lost_n_found; /* Set non-zero to hide the lost-n-found dir. */
583 int stored_endian; /* 0=cpu endian, 1=little endian, 2=big endian */
585 /* The remove_obj_fn function must be supplied by OS flavours that
587 * yaffs direct uses it to implement the faster readdir.
588 * Linux uses it to protect the directory during unlocking.
590 void (*remove_obj_fn) (struct yaffs_obj *obj);
592 /* Callback to mark the superblock dirty */
593 void (*sb_dirty_fn) (struct yaffs_dev *dev);
595 /* Callback to control garbage collection. */
596 unsigned (*gc_control_fn) (struct yaffs_dev *dev);
598 /* Debug control flags. Don't use unless you know what you're doing */
599 int use_header_file_size; /* Flag to determine if we should use
600 * file sizes from the header */
601 int disable_lazy_load; /* Disable lazy loading on this device */
602 int wide_tnodes_disabled; /* Set to disable wide tnodes */
603 int disable_soft_del; /* yaffs 1 only: Set to disable the use of
606 int defered_dir_update; /* Set to defer directory updates */
608 #ifdef CONFIG_YAFFS_AUTO_UNICODE
611 int always_check_erased; /* Force chunk erased check always on */
614 int disable_bad_block_marking;
618 struct yaffs_driver {
619 int (*drv_write_chunk_fn) (struct yaffs_dev *dev, int nand_chunk,
620 const u8 *data, int data_len,
621 const u8 *oob, int oob_len);
622 int (*drv_read_chunk_fn) (struct yaffs_dev *dev, int nand_chunk,
623 u8 *data, int data_len,
624 u8 *oob, int oob_len,
625 enum yaffs_ecc_result *ecc_result);
626 int (*drv_erase_fn) (struct yaffs_dev *dev, int block_no);
627 int (*drv_mark_bad_fn) (struct yaffs_dev *dev, int block_no);
628 int (*drv_check_bad_fn) (struct yaffs_dev *dev, int block_no);
629 int (*drv_initialise_fn) (struct yaffs_dev *dev);
630 int (*drv_deinitialise_fn) (struct yaffs_dev *dev);
633 struct yaffs_tags_handler {
634 int (*write_chunk_tags_fn) (struct yaffs_dev *dev,
635 int nand_chunk, const u8 *data,
636 const struct yaffs_ext_tags *tags);
637 int (*read_chunk_tags_fn) (struct yaffs_dev *dev,
638 int nand_chunk, u8 *data,
639 struct yaffs_ext_tags *tags);
641 int (*query_block_fn) (struct yaffs_dev *dev, int block_no,
642 enum yaffs_block_state *state,
644 int (*mark_bad_fn) (struct yaffs_dev *dev, int block_no);
648 struct yaffs_param param;
649 struct yaffs_driver drv;
650 struct yaffs_tags_handler tagger;
652 /* Context storage. Holds extra OS specific data for this device */
655 void *driver_context;
657 struct list_head dev_list;
660 /* Runtime parameters. Set up by YAFFS. */
661 u32 data_bytes_per_chunk;
663 /* Non-wide tnode stuff */
664 u16 chunk_grp_bits; /* Number of bits that need to be resolved if
665 * the tnodes are not wide enough.
667 u16 chunk_grp_size; /* == 2^^chunk_grp_bits */
669 struct yaffs_tnode *tn_swap_buffer;
671 /* Stuff to support wide tnodes */
676 /* Stuff for figuring out file offset to chunk conversions */
677 u32 chunk_shift; /* Shift value */
678 u32 chunk_div; /* Divisor after shifting: 1 for 2^n sizes */
679 u32 chunk_mask; /* Mask to use for power-of-2 case */
684 int swap_endian; /* Stored endian needs endian swap. */
686 /* Stuff to support block offsetting to support start block zero */
687 u32 internal_start_block;
688 u32 internal_end_block;
692 /* Runtime checkpointing stuff */
693 int checkpt_page_seq; /* running sequence number of checkpt pages */
694 int checkpt_byte_count;
695 int checkpt_byte_offs;
697 int checkpt_open_write;
698 u32 blocks_in_checkpt;
699 int checkpt_cur_chunk;
700 int checkpt_cur_block;
701 int checkpt_next_block;
702 int *checkpt_block_list;
703 u32 checkpt_max_blocks;
707 int checkpoint_blocks_required; /* Number of blocks needed to store
708 * current checkpoint set */
711 struct yaffs_block_info *block_info;
712 u8 *chunk_bits; /* bitmap of chunks in use */
713 u8 block_info_alt:1; /* allocated using alternative alloc */
714 u8 chunk_bits_alt:1; /* allocated using alternative alloc */
715 int chunk_bit_stride; /* Number of bytes of chunk_bits per block.
716 * Must be consistent with chunks_per_block.
720 int alloc_block; /* Current block being allocated off */
722 int alloc_block_finder; /* Used to search for next allocation block */
724 /* Object and Tnode memory management */
731 struct yaffs_obj_bucket obj_bucket[YAFFS_NOBJECT_BUCKETS];
736 /* Garbage collection control */
737 u32 *gc_cleanup_list; /* objects to delete at the end of a GC. */
740 unsigned has_pending_prioritised_gc; /* We think this device might
741 have pending prioritised gcs */
743 unsigned gc_block_finder;
744 unsigned gc_dirtiest;
745 unsigned gc_pages_in_use;
746 unsigned gc_not_done;
750 struct yaffs_summary_tags *gc_sum_tags;
752 /* Special directories */
753 struct yaffs_obj *root_dir;
754 struct yaffs_obj *lost_n_found;
756 int buffered_block; /* Which block is buffered here? */
757 int doing_buffered_block_rewrite;
759 struct yaffs_cache_manager cache_mgr;
761 /* Stuff for background deletion and unlinked files. */
762 struct yaffs_obj *unlinked_dir; /* Directory where unlinked and deleted
764 struct yaffs_obj *del_dir; /* Directory where deleted objects are
765 sent to disappear. */
766 struct yaffs_obj *unlinked_deletion; /* Current file being
767 background deleted. */
768 int n_deleted_files; /* Count of files awaiting deletion; */
769 int n_unlinked_files; /* Count of unlinked files. */
770 int n_bg_deletions; /* Count of background deletions. */
772 /* Temporary buffer management */
773 struct yaffs_buffer temp_buffer[YAFFS_N_TEMP_BUFFERS];
776 int unmanaged_buffer_allocs;
777 int unmanaged_buffer_deallocs;
779 /* yaffs2 runtime stuff */
780 unsigned seq_number; /* Sequence number of currently
782 unsigned oldest_dirty_seq;
783 unsigned oldest_dirty_block;
785 /* Block refreshing */
786 int refresh_skip; /* A skip down counter.
787 * Refresh happens when this gets to zero. */
789 /* Dirty directory handling */
790 struct list_head dirty_dirs; /* List of dirty directories */
793 int chunks_per_summary;
794 struct yaffs_summary_tags *sum_tags;
802 u32 n_erase_failures;
805 u32 passive_gc_count;
806 u32 oldest_dirty_gc_count;
809 u32 n_retried_writes;
810 u32 n_retired_blocks;
813 u32 n_tags_ecc_fixed;
814 u32 n_tags_ecc_unfixed;
816 u32 n_unmarked_deletions;
825 * Checkpointing definitions.
828 #define YAFFS_CHECKPOINT_VERSION 8
830 /* yaffs_checkpt_obj holds the definition of an object as dumped
835 /* Checkpint object bits in bitfield: offset, length */
836 #define CHECKPOINT_VARIANT_BITS 0, 3
837 #define CHECKPOINT_DELETED_BITS 3, 1
838 #define CHECKPOINT_SOFT_DEL_BITS 4, 1
839 #define CHECKPOINT_UNLINKED_BITS 5, 1
840 #define CHECKPOINT_FAKE_BITS 6, 1
841 #define CHECKPOINT_RENAME_ALLOWED_BITS 7, 1
842 #define CHECKPOINT_UNLINK_ALLOWED_BITS 8, 1
843 #define CHECKPOINT_SERIAL_BITS 9, 8
845 struct yaffs_checkpt_obj {
852 loff_t size_or_equiv_obj;
855 /* The CheckpointDevice structure holds the device information that changes
856 *at runtime and must be preserved over unmount/mount cycles.
858 struct yaffs_checkpt_dev {
861 int alloc_block; /* Current block being allocated off */
865 int n_deleted_files; /* Count of files awaiting deletion; */
866 int n_unlinked_files; /* Count of unlinked files. */
867 int n_bg_deletions; /* Count of background deletions. */
869 /* yaffs2 runtime stuff */
870 unsigned seq_number; /* Sequence number of currently
871 * allocating block */
875 struct yaffs_checkpt_validity {
882 struct yaffs_shadow_fixer {
885 struct yaffs_shadow_fixer *next;
888 /* Structure for doing xattr modifications */
889 struct yaffs_xattr_mod {
890 int set; /* If 0 then this is a deletion */
898 /*----------------------- YAFFS Functions -----------------------*/
900 int yaffs_guts_initialise(struct yaffs_dev *dev);
901 void yaffs_deinitialise(struct yaffs_dev *dev);
902 void yaffs_guts_cleanup(struct yaffs_dev *dev);
904 int yaffs_get_n_free_chunks(struct yaffs_dev *dev);
906 int yaffs_rename_obj(struct yaffs_obj *old_dir, const YCHAR * old_name,
907 struct yaffs_obj *new_dir, const YCHAR * new_name);
909 int yaffs_unlink_obj(struct yaffs_obj *obj);
911 int yaffs_unlinker(struct yaffs_obj *dir, const YCHAR * name);
912 int yaffs_del_obj(struct yaffs_obj *obj);
913 struct yaffs_obj *yaffs_retype_obj(struct yaffs_obj *obj,
914 enum yaffs_obj_type type);
917 int yaffs_get_obj_name(struct yaffs_obj *obj, YCHAR * name, int buffer_size);
918 loff_t yaffs_get_obj_length(struct yaffs_obj *obj);
919 int yaffs_get_obj_inode(struct yaffs_obj *obj);
920 unsigned yaffs_get_obj_type(struct yaffs_obj *obj);
921 int yaffs_get_obj_link_count(struct yaffs_obj *obj);
923 /* File operations */
924 int yaffs_file_rd(struct yaffs_obj *obj, u8 * buffer, loff_t offset,
926 int yaffs_wr_file(struct yaffs_obj *obj, const u8 * buffer, loff_t offset,
927 int n_bytes, int write_trhrough);
928 int yaffs_resize_file(struct yaffs_obj *obj, loff_t new_size);
930 struct yaffs_obj *yaffs_create_file(struct yaffs_obj *parent,
931 const YCHAR *name, u32 mode, u32 uid,
934 int yaffs_flush_file(struct yaffs_obj *in,
939 /* Flushing and checkpointing */
940 void yaffs_flush_whole_cache(struct yaffs_dev *dev, int discard);
942 int yaffs_checkpoint_save(struct yaffs_dev *dev);
943 int yaffs_checkpoint_restore(struct yaffs_dev *dev);
945 /* Directory operations */
946 struct yaffs_obj *yaffs_create_dir(struct yaffs_obj *parent, const YCHAR *name,
947 u32 mode, u32 uid, u32 gid);
948 struct yaffs_obj *yaffs_find_by_name(struct yaffs_obj *the_dir,
950 struct yaffs_obj *yaffs_find_by_number(struct yaffs_dev *dev, u32 number);
952 /* Link operations */
953 struct yaffs_obj *yaffs_link_obj(struct yaffs_obj *parent, const YCHAR *name,
954 struct yaffs_obj *equiv_obj);
956 struct yaffs_obj *yaffs_get_equivalent_obj(struct yaffs_obj *obj);
958 /* Symlink operations */
959 struct yaffs_obj *yaffs_create_symlink(struct yaffs_obj *parent,
960 const YCHAR *name, u32 mode, u32 uid,
961 u32 gid, const YCHAR *alias);
962 YCHAR *yaffs_get_symlink_alias(struct yaffs_obj *obj);
964 /* Special inodes (fifos, sockets and devices) */
965 struct yaffs_obj *yaffs_create_special(struct yaffs_obj *parent,
966 const YCHAR *name, u32 mode, u32 uid,
969 int yaffs_set_xattrib(struct yaffs_obj *obj, const YCHAR *name,
970 const void *value, int size, int flags);
971 int yaffs_get_xattrib(struct yaffs_obj *obj, const YCHAR *name, void *value,
973 int yaffs_list_xattrib(struct yaffs_obj *obj, char *buffer, int size);
974 int yaffs_remove_xattrib(struct yaffs_obj *obj, const YCHAR *name);
976 /* Special directories */
977 struct yaffs_obj *yaffs_root(struct yaffs_dev *dev);
978 struct yaffs_obj *yaffs_lost_n_found(struct yaffs_dev *dev);
980 void yaffs_handle_defered_free(struct yaffs_obj *obj);
982 void yaffs_update_dirty_dirs(struct yaffs_dev *dev);
984 int yaffs_bg_gc(struct yaffs_dev *dev, unsigned urgency);
987 int yaffs_dump_obj(struct yaffs_obj *obj);
989 void yaffs_guts_test(struct yaffs_dev *dev);
990 int yaffs_guts_ll_init(struct yaffs_dev *dev);
993 /* A few useful functions to be used within the core files*/
994 void yaffs_chunk_del(struct yaffs_dev *dev, int chunk_id, int mark_flash,
996 int yaffs_check_ff(u8 *buffer, int n_bytes);
997 void yaffs_handle_chunk_error(struct yaffs_dev *dev,
998 struct yaffs_block_info *bi);
1000 u8 *yaffs_get_temp_buffer(struct yaffs_dev *dev);
1001 void yaffs_release_temp_buffer(struct yaffs_dev *dev, u8 *buffer);
1003 struct yaffs_obj *yaffs_find_or_create_by_number(struct yaffs_dev *dev,
1005 enum yaffs_obj_type type);
1006 int yaffs_put_chunk_in_file(struct yaffs_obj *in, int inode_chunk,
1007 int nand_chunk, int in_scan);
1008 void yaffs_set_obj_name(struct yaffs_obj *obj, const YCHAR *name);
1009 void yaffs_set_obj_name_from_oh(struct yaffs_obj *obj,
1010 const struct yaffs_obj_hdr *oh);
1011 void yaffs_add_obj_to_dir(struct yaffs_obj *directory, struct yaffs_obj *obj);
1012 YCHAR *yaffs_clone_str(const YCHAR *str);
1013 void yaffs_link_fixup(struct yaffs_dev *dev, struct list_head *hard_list);
1014 void yaffs_block_became_dirty(struct yaffs_dev *dev, int block_no);
1015 int yaffs_update_oh(struct yaffs_obj *in, const YCHAR *name,
1016 int force, int is_shrink, int shadows,
1017 struct yaffs_xattr_mod *xop);
1018 void yaffs_handle_shadowed_obj(struct yaffs_dev *dev, int obj_id,
1019 int backward_scanning);
1020 int yaffs_check_alloc_available(struct yaffs_dev *dev, int n_chunks);
1021 struct yaffs_tnode *yaffs_get_tnode(struct yaffs_dev *dev);
1022 struct yaffs_tnode *yaffs_add_find_tnode_0(struct yaffs_dev *dev,
1023 struct yaffs_file_var *file_struct,
1025 struct yaffs_tnode *passed_tn);
1027 int yaffs_do_file_wr(struct yaffs_obj *in, const u8 *buffer, loff_t offset,
1028 int n_bytes, int write_trhrough);
1029 void yaffs_resize_file_down(struct yaffs_obj *obj, loff_t new_size);
1030 void yaffs_skip_rest_of_block(struct yaffs_dev *dev);
1032 int yaffs_count_free_chunks(struct yaffs_dev *dev);
1034 struct yaffs_tnode *yaffs_find_tnode_0(struct yaffs_dev *dev,
1035 struct yaffs_file_var *file_struct,
1038 u32 yaffs_get_group_base(struct yaffs_dev *dev, struct yaffs_tnode *tn,
1041 int yaffs_is_non_empty_dir(struct yaffs_obj *obj);
1043 int yaffs_guts_format_dev(struct yaffs_dev *dev);
1045 void yaffs_addr_to_chunk(struct yaffs_dev *dev, loff_t addr,
1046 int *chunk_out, u32 *offset_out);
1048 * Marshalling functions to get loff_t file sizes into and out of
1051 void yaffs_oh_size_load(struct yaffs_dev *dev, struct yaffs_obj_hdr *oh,
1052 loff_t fsize, int do_endian);
1053 loff_t yaffs_oh_to_size(struct yaffs_dev *dev, struct yaffs_obj_hdr *oh,
1055 loff_t yaffs_max_file_size(struct yaffs_dev *dev);
1058 /* yaffs_wr_data_obj needs to be exposed to allow the cache to access it. */
1059 int yaffs_wr_data_obj(struct yaffs_obj *in, int inode_chunk,
1060 const u8 *buffer, int n_bytes, int use_reserve);
1063 * Debug function to count number of blocks in each state
1064 * NB Needs to be called with correct number of integers
1067 void yaffs_count_blocks_by_state(struct yaffs_dev *dev, int bs[10]);
1069 int yaffs_find_chunk_in_file(struct yaffs_obj *in, int inode_chunk,
1070 struct yaffs_ext_tags *tags);
1073 *Time marshalling functions
1076 YTIME_T yaffs_oh_ctime_fetch(struct yaffs_obj_hdr *oh);
1077 YTIME_T yaffs_oh_mtime_fetch(struct yaffs_obj_hdr *oh);
1078 YTIME_T yaffs_oh_atime_fetch(struct yaffs_obj_hdr *oh);
1080 void yaffs_oh_ctime_load(struct yaffs_obj *obj, struct yaffs_obj_hdr *oh);
1081 void yaffs_oh_mtime_load(struct yaffs_obj *obj, struct yaffs_obj_hdr *oh);
1082 void yaffs_oh_atime_load(struct yaffs_obj *obj, struct yaffs_obj_hdr *oh);
1085 * Define LOFF_T_32_BIT if a 32-bit LOFF_T is being used.
1086 * Not serious if you get this wrong - you might just get some warnings.
1089 #ifdef LOFF_T_32_BIT
1090 #define FSIZE_LOW(fsize) (fsize)
1091 #define FSIZE_HIGH(fsize) 0
1092 #define FSIZE_COMBINE(high, low) (low)
1094 #define FSIZE_LOW(fsize) ((fsize) & 0xffffffff)
1095 #define FSIZE_HIGH(fsize)(((fsize) >> 32) & 0xffffffff)
1096 #define FSIZE_COMBINE(high, low) ((((loff_t) (high)) << 32) | \
1097 (((loff_t) (low)) & 0xFFFFFFFF))