1 /* 2 * This file is part of UBIFS. 3 * 4 * Copyright (C) 2006-2008 Nokia Corporation 5 * 6 * (C) Copyright 2008-2009 7 * Stefan Roese, DENX Software Engineering, sr@denx.de. 8 * 9 * This program is free software; you can redistribute it and/or modify it 10 * under the terms of the GNU General Public License version 2 as published by 11 * the Free Software Foundation. 12 * 13 * This program is distributed in the hope that it will be useful, but WITHOUT 14 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 15 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for 16 * more details. 17 * 18 * You should have received a copy of the GNU General Public License along with 19 * this program; if not, write to the Free Software Foundation, Inc., 51 20 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA 21 * 22 * Authors: Artem Bityutskiy (Битюцкий Артём) 23 * Adrian Hunter 24 */ 25 26 #ifndef __UBIFS_H__ 27 #define __UBIFS_H__ 28 29 #if 0 /* Enable for debugging output */ 30 #define CONFIG_UBIFS_FS_DEBUG 31 #define CONFIG_UBIFS_FS_DEBUG_MSG_LVL 3 32 #endif 33 34 #include <ubi_uboot.h> 35 #include <linux/ctype.h> 36 #include <linux/time.h> 37 #include <linux/math64.h> 38 #include "ubifs-media.h" 39 40 struct dentry; 41 struct file; 42 struct iattr; 43 struct kstat; 44 struct vfsmount; 45 46 extern struct super_block *ubifs_sb; 47 48 extern unsigned int ubifs_msg_flags; 49 extern unsigned int ubifs_chk_flags; 50 extern unsigned int ubifs_tst_flags; 51 52 #define pgoff_t unsigned long 53 54 /* 55 * We "simulate" the Linux page struct much simpler here 56 */ 57 struct page { 58 pgoff_t index; 59 void *addr; 60 struct inode *inode; 61 }; 62 63 void iput(struct inode *inode); 64 65 /* 66 * The atomic operations are used for budgeting etc which is not 67 * needed for the read-only U-Boot implementation: 68 */ 69 #define atomic_long_inc(a) 70 #define atomic_long_dec(a) 71 #define atomic_long_sub(a, b) 72 73 /* linux/include/time.h */ 74 75 struct timespec { 76 time_t tv_sec; /* seconds */ 77 long tv_nsec; /* nanoseconds */ 78 }; 79 80 /* linux/include/dcache.h */ 81 82 /* 83 * "quick string" -- eases parameter passing, but more importantly 84 * saves "metadata" about the string (ie length and the hash). 85 * 86 * hash comes first so it snuggles against d_parent in the 87 * dentry. 88 */ 89 struct qstr { 90 unsigned int hash; 91 unsigned int len; 92 const char *name; 93 }; 94 95 struct inode { 96 struct hlist_node i_hash; 97 struct list_head i_list; 98 struct list_head i_sb_list; 99 struct list_head i_dentry; 100 unsigned long i_ino; 101 unsigned int i_nlink; 102 uid_t i_uid; 103 gid_t i_gid; 104 dev_t i_rdev; 105 u64 i_version; 106 loff_t i_size; 107 #ifdef __NEED_I_SIZE_ORDERED 108 seqcount_t i_size_seqcount; 109 #endif 110 struct timespec i_atime; 111 struct timespec i_mtime; 112 struct timespec i_ctime; 113 unsigned int i_blkbits; 114 unsigned short i_bytes; 115 umode_t i_mode; 116 spinlock_t i_lock; /* i_blocks, i_bytes, maybe i_size */ 117 struct mutex i_mutex; 118 struct rw_semaphore i_alloc_sem; 119 const struct inode_operations *i_op; 120 const struct file_operations *i_fop; /* former ->i_op->default_file_ops */ 121 struct super_block *i_sb; 122 struct file_lock *i_flock; 123 #ifdef CONFIG_QUOTA 124 struct dquot *i_dquot[MAXQUOTAS]; 125 #endif 126 struct list_head i_devices; 127 int i_cindex; 128 129 __u32 i_generation; 130 131 #ifdef CONFIG_DNOTIFY 132 unsigned long i_dnotify_mask; /* Directory notify events */ 133 struct dnotify_struct *i_dnotify; /* for directory notifications */ 134 #endif 135 136 #ifdef CONFIG_INOTIFY 137 struct list_head inotify_watches; /* watches on this inode */ 138 struct mutex inotify_mutex; /* protects the watches list */ 139 #endif 140 141 unsigned long i_state; 142 unsigned long dirtied_when; /* jiffies of first dirtying */ 143 144 unsigned int i_flags; 145 146 #ifdef CONFIG_SECURITY 147 void *i_security; 148 #endif 149 void *i_private; /* fs or device private pointer */ 150 }; 151 152 struct super_block { 153 struct list_head s_list; /* Keep this first */ 154 dev_t s_dev; /* search index; _not_ kdev_t */ 155 unsigned long s_blocksize; 156 unsigned char s_blocksize_bits; 157 unsigned char s_dirt; 158 unsigned long long s_maxbytes; /* Max file size */ 159 struct file_system_type *s_type; 160 const struct super_operations *s_op; 161 struct dquot_operations *dq_op; 162 struct quotactl_ops *s_qcop; 163 const struct export_operations *s_export_op; 164 unsigned long s_flags; 165 unsigned long s_magic; 166 struct dentry *s_root; 167 struct rw_semaphore s_umount; 168 struct mutex s_lock; 169 int s_count; 170 int s_syncing; 171 int s_need_sync_fs; 172 #ifdef CONFIG_SECURITY 173 void *s_security; 174 #endif 175 struct xattr_handler **s_xattr; 176 177 struct list_head s_inodes; /* all inodes */ 178 struct list_head s_dirty; /* dirty inodes */ 179 struct list_head s_io; /* parked for writeback */ 180 struct list_head s_more_io; /* parked for more writeback */ 181 struct hlist_head s_anon; /* anonymous dentries for (nfs) exporting */ 182 struct list_head s_files; 183 /* s_dentry_lru and s_nr_dentry_unused are protected by dcache_lock */ 184 struct list_head s_dentry_lru; /* unused dentry lru */ 185 int s_nr_dentry_unused; /* # of dentry on lru */ 186 187 struct block_device *s_bdev; 188 struct mtd_info *s_mtd; 189 struct list_head s_instances; 190 191 int s_frozen; 192 wait_queue_head_t s_wait_unfrozen; 193 194 char s_id[32]; /* Informational name */ 195 196 void *s_fs_info; /* Filesystem private info */ 197 198 /* 199 * The next field is for VFS *only*. No filesystems have any business 200 * even looking at it. You had been warned. 201 */ 202 struct mutex s_vfs_rename_mutex; /* Kludge */ 203 204 /* Granularity of c/m/atime in ns. 205 Cannot be worse than a second */ 206 u32 s_time_gran; 207 208 /* 209 * Filesystem subtype. If non-empty the filesystem type field 210 * in /proc/mounts will be "type.subtype" 211 */ 212 char *s_subtype; 213 214 /* 215 * Saved mount options for lazy filesystems using 216 * generic_show_options() 217 */ 218 char *s_options; 219 }; 220 221 struct file_system_type { 222 const char *name; 223 int fs_flags; 224 int (*get_sb) (struct file_system_type *, int, 225 const char *, void *, struct vfsmount *); 226 void (*kill_sb) (struct super_block *); 227 struct module *owner; 228 struct file_system_type * next; 229 struct list_head fs_supers; 230 }; 231 232 struct vfsmount { 233 struct list_head mnt_hash; 234 struct vfsmount *mnt_parent; /* fs we are mounted on */ 235 struct dentry *mnt_mountpoint; /* dentry of mountpoint */ 236 struct dentry *mnt_root; /* root of the mounted tree */ 237 struct super_block *mnt_sb; /* pointer to superblock */ 238 struct list_head mnt_mounts; /* list of children, anchored here */ 239 struct list_head mnt_child; /* and going through their mnt_child */ 240 int mnt_flags; 241 /* 4 bytes hole on 64bits arches */ 242 const char *mnt_devname; /* Name of device e.g. /dev/dsk/hda1 */ 243 struct list_head mnt_list; 244 struct list_head mnt_expire; /* link in fs-specific expiry list */ 245 struct list_head mnt_share; /* circular list of shared mounts */ 246 struct list_head mnt_slave_list;/* list of slave mounts */ 247 struct list_head mnt_slave; /* slave list entry */ 248 struct vfsmount *mnt_master; /* slave is on master->mnt_slave_list */ 249 struct mnt_namespace *mnt_ns; /* containing namespace */ 250 int mnt_id; /* mount identifier */ 251 int mnt_group_id; /* peer group identifier */ 252 /* 253 * We put mnt_count & mnt_expiry_mark at the end of struct vfsmount 254 * to let these frequently modified fields in a separate cache line 255 * (so that reads of mnt_flags wont ping-pong on SMP machines) 256 */ 257 int mnt_expiry_mark; /* true if marked for expiry */ 258 int mnt_pinned; 259 int mnt_ghosts; 260 /* 261 * This value is not stable unless all of the mnt_writers[] spinlocks 262 * are held, and all mnt_writer[]s on this mount have 0 as their ->count 263 */ 264 }; 265 266 struct path { 267 struct vfsmount *mnt; 268 struct dentry *dentry; 269 }; 270 271 struct file { 272 struct path f_path; 273 #define f_dentry f_path.dentry 274 #define f_vfsmnt f_path.mnt 275 const struct file_operations *f_op; 276 unsigned int f_flags; 277 loff_t f_pos; 278 unsigned int f_uid, f_gid; 279 280 u64 f_version; 281 #ifdef CONFIG_SECURITY 282 void *f_security; 283 #endif 284 /* needed for tty driver, and maybe others */ 285 void *private_data; 286 287 #ifdef CONFIG_EPOLL 288 /* Used by fs/eventpoll.c to link all the hooks to this file */ 289 struct list_head f_ep_links; 290 spinlock_t f_ep_lock; 291 #endif /* #ifdef CONFIG_EPOLL */ 292 #ifdef CONFIG_DEBUG_WRITECOUNT 293 unsigned long f_mnt_write_state; 294 #endif 295 }; 296 297 /* 298 * get_seconds() not really needed in the read-only implmentation 299 */ 300 #define get_seconds() 0 301 302 /* 4k page size */ 303 #define PAGE_CACHE_SHIFT 12 304 #define PAGE_CACHE_SIZE (1 << PAGE_CACHE_SHIFT) 305 306 /* Page cache limit. The filesystems should put that into their s_maxbytes 307 limits, otherwise bad things can happen in VM. */ 308 #if BITS_PER_LONG==32 309 #define MAX_LFS_FILESIZE (((u64)PAGE_CACHE_SIZE << (BITS_PER_LONG-1))-1) 310 #elif BITS_PER_LONG==64 311 #define MAX_LFS_FILESIZE 0x7fffffffffffffffUL 312 #endif 313 314 #define INT_MAX ((int)(~0U>>1)) 315 #define INT_MIN (-INT_MAX - 1) 316 #define LLONG_MAX ((long long)(~0ULL>>1)) 317 318 /* 319 * These are the fs-independent mount-flags: up to 32 flags are supported 320 */ 321 #define MS_RDONLY 1 /* Mount read-only */ 322 #define MS_NOSUID 2 /* Ignore suid and sgid bits */ 323 #define MS_NODEV 4 /* Disallow access to device special files */ 324 #define MS_NOEXEC 8 /* Disallow program execution */ 325 #define MS_SYNCHRONOUS 16 /* Writes are synced at once */ 326 #define MS_REMOUNT 32 /* Alter flags of a mounted FS */ 327 #define MS_MANDLOCK 64 /* Allow mandatory locks on an FS */ 328 #define MS_DIRSYNC 128 /* Directory modifications are synchronous */ 329 #define MS_NOATIME 1024 /* Do not update access times. */ 330 #define MS_NODIRATIME 2048 /* Do not update directory access times */ 331 #define MS_BIND 4096 332 #define MS_MOVE 8192 333 #define MS_REC 16384 334 #define MS_VERBOSE 32768 /* War is peace. Verbosity is silence. 335 MS_VERBOSE is deprecated. */ 336 #define MS_SILENT 32768 337 #define MS_POSIXACL (1<<16) /* VFS does not apply the umask */ 338 #define MS_UNBINDABLE (1<<17) /* change to unbindable */ 339 #define MS_PRIVATE (1<<18) /* change to private */ 340 #define MS_SLAVE (1<<19) /* change to slave */ 341 #define MS_SHARED (1<<20) /* change to shared */ 342 #define MS_RELATIME (1<<21) /* Update atime relative to mtime/ctime. */ 343 #define MS_KERNMOUNT (1<<22) /* this is a kern_mount call */ 344 #define MS_I_VERSION (1<<23) /* Update inode I_version field */ 345 #define MS_ACTIVE (1<<30) 346 #define MS_NOUSER (1<<31) 347 348 #define I_NEW 8 349 350 /* Inode flags - they have nothing to superblock flags now */ 351 352 #define S_SYNC 1 /* Writes are synced at once */ 353 #define S_NOATIME 2 /* Do not update access times */ 354 #define S_APPEND 4 /* Append-only file */ 355 #define S_IMMUTABLE 8 /* Immutable file */ 356 #define S_DEAD 16 /* removed, but still open directory */ 357 #define S_NOQUOTA 32 /* Inode is not counted to quota */ 358 #define S_DIRSYNC 64 /* Directory modifications are synchronous */ 359 #define S_NOCMTIME 128 /* Do not update file c/mtime */ 360 #define S_SWAPFILE 256 /* Do not truncate: swapon got its bmaps */ 361 #define S_PRIVATE 512 /* Inode is fs-internal */ 362 363 /* include/linux/stat.h */ 364 365 #define S_IFMT 00170000 366 #define S_IFSOCK 0140000 367 #define S_IFLNK 0120000 368 #define S_IFREG 0100000 369 #define S_IFBLK 0060000 370 #define S_IFDIR 0040000 371 #define S_IFCHR 0020000 372 #define S_IFIFO 0010000 373 #define S_ISUID 0004000 374 #define S_ISGID 0002000 375 #define S_ISVTX 0001000 376 377 /* include/linux/fs.h */ 378 379 /* 380 * File types 381 * 382 * NOTE! These match bits 12..15 of stat.st_mode 383 * (ie "(i_mode >> 12) & 15"). 384 */ 385 #define DT_UNKNOWN 0 386 #define DT_FIFO 1 387 #define DT_CHR 2 388 #define DT_DIR 4 389 #define DT_BLK 6 390 #define DT_REG 8 391 #define DT_LNK 10 392 #define DT_SOCK 12 393 #define DT_WHT 14 394 395 #define I_DIRTY_SYNC 1 396 #define I_DIRTY_DATASYNC 2 397 #define I_DIRTY_PAGES 4 398 #define I_NEW 8 399 #define I_WILL_FREE 16 400 #define I_FREEING 32 401 #define I_CLEAR 64 402 #define __I_LOCK 7 403 #define I_LOCK (1 << __I_LOCK) 404 #define __I_SYNC 8 405 #define I_SYNC (1 << __I_SYNC) 406 407 #define I_DIRTY (I_DIRTY_SYNC | I_DIRTY_DATASYNC | I_DIRTY_PAGES) 408 409 /* linux/include/dcache.h */ 410 411 #define DNAME_INLINE_LEN_MIN 36 412 413 struct dentry { 414 unsigned int d_flags; /* protected by d_lock */ 415 spinlock_t d_lock; /* per dentry lock */ 416 struct inode *d_inode; /* Where the name belongs to - NULL is 417 * negative */ 418 /* 419 * The next three fields are touched by __d_lookup. Place them here 420 * so they all fit in a cache line. 421 */ 422 struct hlist_node d_hash; /* lookup hash list */ 423 struct dentry *d_parent; /* parent directory */ 424 struct qstr d_name; 425 426 struct list_head d_lru; /* LRU list */ 427 /* 428 * d_child and d_rcu can share memory 429 */ 430 struct list_head d_subdirs; /* our children */ 431 struct list_head d_alias; /* inode alias list */ 432 unsigned long d_time; /* used by d_revalidate */ 433 struct super_block *d_sb; /* The root of the dentry tree */ 434 void *d_fsdata; /* fs-specific data */ 435 #ifdef CONFIG_PROFILING 436 struct dcookie_struct *d_cookie; /* cookie, if any */ 437 #endif 438 int d_mounted; 439 unsigned char d_iname[DNAME_INLINE_LEN_MIN]; /* small names */ 440 }; 441 442 static inline ino_t parent_ino(struct dentry *dentry) 443 { 444 ino_t res; 445 446 spin_lock(&dentry->d_lock); 447 res = dentry->d_parent->d_inode->i_ino; 448 spin_unlock(&dentry->d_lock); 449 return res; 450 } 451 452 /* debug.c */ 453 454 #define DEFINE_SPINLOCK(...) 455 #define module_param_named(...) 456 457 /* misc.h */ 458 #define mutex_lock_nested(...) 459 #define mutex_unlock_nested(...) 460 #define mutex_is_locked(...) 0 461 462 /* Version of this UBIFS implementation */ 463 #define UBIFS_VERSION 1 464 465 /* Normal UBIFS messages */ 466 #ifdef CONFIG_UBIFS_SILENCE_MSG 467 #define ubifs_msg(fmt, ...) 468 #else 469 #define ubifs_msg(fmt, ...) \ 470 printk(KERN_NOTICE "UBIFS: " fmt "\n", ##__VA_ARGS__) 471 #endif 472 /* UBIFS error messages */ 473 #define ubifs_err(fmt, ...) \ 474 printk(KERN_ERR "UBIFS error (pid %d): %s: " fmt "\n", 0, \ 475 __func__, ##__VA_ARGS__) 476 /* UBIFS warning messages */ 477 #define ubifs_warn(fmt, ...) \ 478 printk(KERN_WARNING "UBIFS warning (pid %d): %s: " fmt "\n", \ 479 0, __func__, ##__VA_ARGS__) 480 481 /* UBIFS file system VFS magic number */ 482 #define UBIFS_SUPER_MAGIC 0x24051905 483 484 /* Number of UBIFS blocks per VFS page */ 485 #define UBIFS_BLOCKS_PER_PAGE (PAGE_CACHE_SIZE / UBIFS_BLOCK_SIZE) 486 #define UBIFS_BLOCKS_PER_PAGE_SHIFT (PAGE_CACHE_SHIFT - UBIFS_BLOCK_SHIFT) 487 488 /* "File system end of life" sequence number watermark */ 489 #define SQNUM_WARN_WATERMARK 0xFFFFFFFF00000000ULL 490 #define SQNUM_WATERMARK 0xFFFFFFFFFF000000ULL 491 492 /* 493 * Minimum amount of LEBs reserved for the index. At present the index needs at 494 * least 2 LEBs: one for the index head and one for in-the-gaps method (which 495 * currently does not cater for the index head and so excludes it from 496 * consideration). 497 */ 498 #define MIN_INDEX_LEBS 2 499 500 /* Minimum amount of data UBIFS writes to the flash */ 501 #define MIN_WRITE_SZ (UBIFS_DATA_NODE_SZ + 8) 502 503 /* 504 * Currently we do not support inode number overlapping and re-using, so this 505 * watermark defines dangerous inode number level. This should be fixed later, 506 * although it is difficult to exceed current limit. Another option is to use 507 * 64-bit inode numbers, but this means more overhead. 508 */ 509 #define INUM_WARN_WATERMARK 0xFFF00000 510 #define INUM_WATERMARK 0xFFFFFF00 511 512 /* Largest key size supported in this implementation */ 513 #define CUR_MAX_KEY_LEN UBIFS_SK_LEN 514 515 /* Maximum number of entries in each LPT (LEB category) heap */ 516 #define LPT_HEAP_SZ 256 517 518 /* 519 * Background thread name pattern. The numbers are UBI device and volume 520 * numbers. 521 */ 522 #define BGT_NAME_PATTERN "ubifs_bgt%d_%d" 523 524 /* Default write-buffer synchronization timeout (5 secs) */ 525 #define DEFAULT_WBUF_TIMEOUT (5 * HZ) 526 527 /* Maximum possible inode number (only 32-bit inodes are supported now) */ 528 #define MAX_INUM 0xFFFFFFFF 529 530 /* Number of non-data journal heads */ 531 #define NONDATA_JHEADS_CNT 2 532 533 /* Garbage collector head */ 534 #define GCHD 0 535 /* Base journal head number */ 536 #define BASEHD 1 537 /* First "general purpose" journal head */ 538 #define DATAHD 2 539 540 /* 'No change' value for 'ubifs_change_lp()' */ 541 #define LPROPS_NC 0x80000001 542 543 /* 544 * There is no notion of truncation key because truncation nodes do not exist 545 * in TNC. However, when replaying, it is handy to introduce fake "truncation" 546 * keys for truncation nodes because the code becomes simpler. So we define 547 * %UBIFS_TRUN_KEY type. 548 */ 549 #define UBIFS_TRUN_KEY UBIFS_KEY_TYPES_CNT 550 551 /* 552 * How much a directory entry/extended attribute entry adds to the parent/host 553 * inode. 554 */ 555 #define CALC_DENT_SIZE(name_len) ALIGN(UBIFS_DENT_NODE_SZ + (name_len) + 1, 8) 556 557 /* How much an extended attribute adds to the host inode */ 558 #define CALC_XATTR_BYTES(data_len) ALIGN(UBIFS_INO_NODE_SZ + (data_len) + 1, 8) 559 560 /* 561 * Znodes which were not touched for 'OLD_ZNODE_AGE' seconds are considered 562 * "old", and znode which were touched last 'YOUNG_ZNODE_AGE' seconds ago are 563 * considered "young". This is used by shrinker when selecting znode to trim 564 * off. 565 */ 566 #define OLD_ZNODE_AGE 20 567 #define YOUNG_ZNODE_AGE 5 568 569 /* 570 * Some compressors, like LZO, may end up with more data then the input buffer. 571 * So UBIFS always allocates larger output buffer, to be sure the compressor 572 * will not corrupt memory in case of worst case compression. 573 */ 574 #define WORST_COMPR_FACTOR 2 575 576 /* Maximum expected tree height for use by bottom_up_buf */ 577 #define BOTTOM_UP_HEIGHT 64 578 579 /* Maximum number of data nodes to bulk-read */ 580 #define UBIFS_MAX_BULK_READ 32 581 582 /* 583 * Lockdep classes for UBIFS inode @ui_mutex. 584 */ 585 enum { 586 WB_MUTEX_1 = 0, 587 WB_MUTEX_2 = 1, 588 WB_MUTEX_3 = 2, 589 }; 590 591 /* 592 * Znode flags (actually, bit numbers which store the flags). 593 * 594 * DIRTY_ZNODE: znode is dirty 595 * COW_ZNODE: znode is being committed and a new instance of this znode has to 596 * be created before changing this znode 597 * OBSOLETE_ZNODE: znode is obsolete, which means it was deleted, but it is 598 * still in the commit list and the ongoing commit operation 599 * will commit it, and delete this znode after it is done 600 */ 601 enum { 602 DIRTY_ZNODE = 0, 603 COW_ZNODE = 1, 604 OBSOLETE_ZNODE = 2, 605 }; 606 607 /* 608 * Commit states. 609 * 610 * COMMIT_RESTING: commit is not wanted 611 * COMMIT_BACKGROUND: background commit has been requested 612 * COMMIT_REQUIRED: commit is required 613 * COMMIT_RUNNING_BACKGROUND: background commit is running 614 * COMMIT_RUNNING_REQUIRED: commit is running and it is required 615 * COMMIT_BROKEN: commit failed 616 */ 617 enum { 618 COMMIT_RESTING = 0, 619 COMMIT_BACKGROUND, 620 COMMIT_REQUIRED, 621 COMMIT_RUNNING_BACKGROUND, 622 COMMIT_RUNNING_REQUIRED, 623 COMMIT_BROKEN, 624 }; 625 626 /* 627 * 'ubifs_scan_a_node()' return values. 628 * 629 * SCANNED_GARBAGE: scanned garbage 630 * SCANNED_EMPTY_SPACE: scanned empty space 631 * SCANNED_A_NODE: scanned a valid node 632 * SCANNED_A_CORRUPT_NODE: scanned a corrupted node 633 * SCANNED_A_BAD_PAD_NODE: scanned a padding node with invalid pad length 634 * 635 * Greater than zero means: 'scanned that number of padding bytes' 636 */ 637 enum { 638 SCANNED_GARBAGE = 0, 639 SCANNED_EMPTY_SPACE = -1, 640 SCANNED_A_NODE = -2, 641 SCANNED_A_CORRUPT_NODE = -3, 642 SCANNED_A_BAD_PAD_NODE = -4, 643 }; 644 645 /* 646 * LPT cnode flag bits. 647 * 648 * DIRTY_CNODE: cnode is dirty 649 * COW_CNODE: cnode is being committed and must be copied before writing 650 * OBSOLETE_CNODE: cnode is being committed and has been copied (or deleted), 651 * so it can (and must) be freed when the commit is finished 652 */ 653 enum { 654 DIRTY_CNODE = 0, 655 COW_CNODE = 1, 656 OBSOLETE_CNODE = 2, 657 }; 658 659 /* 660 * Dirty flag bits (lpt_drty_flgs) for LPT special nodes. 661 * 662 * LTAB_DIRTY: ltab node is dirty 663 * LSAVE_DIRTY: lsave node is dirty 664 */ 665 enum { 666 LTAB_DIRTY = 1, 667 LSAVE_DIRTY = 2, 668 }; 669 670 /* 671 * Return codes used by the garbage collector. 672 * @LEB_FREED: the logical eraseblock was freed and is ready to use 673 * @LEB_FREED_IDX: indexing LEB was freed and can be used only after the commit 674 * @LEB_RETAINED: the logical eraseblock was freed and retained for GC purposes 675 */ 676 enum { 677 LEB_FREED, 678 LEB_FREED_IDX, 679 LEB_RETAINED, 680 }; 681 682 /** 683 * struct ubifs_old_idx - index node obsoleted since last commit start. 684 * @rb: rb-tree node 685 * @lnum: LEB number of obsoleted index node 686 * @offs: offset of obsoleted index node 687 */ 688 struct ubifs_old_idx { 689 struct rb_node rb; 690 int lnum; 691 int offs; 692 }; 693 694 /* The below union makes it easier to deal with keys */ 695 union ubifs_key { 696 uint8_t u8[CUR_MAX_KEY_LEN]; 697 uint32_t u32[CUR_MAX_KEY_LEN/4]; 698 uint64_t u64[CUR_MAX_KEY_LEN/8]; 699 __le32 j32[CUR_MAX_KEY_LEN/4]; 700 }; 701 702 /** 703 * struct ubifs_scan_node - UBIFS scanned node information. 704 * @list: list of scanned nodes 705 * @key: key of node scanned (if it has one) 706 * @sqnum: sequence number 707 * @type: type of node scanned 708 * @offs: offset with LEB of node scanned 709 * @len: length of node scanned 710 * @node: raw node 711 */ 712 struct ubifs_scan_node { 713 struct list_head list; 714 union ubifs_key key; 715 unsigned long long sqnum; 716 int type; 717 int offs; 718 int len; 719 void *node; 720 }; 721 722 /** 723 * struct ubifs_scan_leb - UBIFS scanned LEB information. 724 * @lnum: logical eraseblock number 725 * @nodes_cnt: number of nodes scanned 726 * @nodes: list of struct ubifs_scan_node 727 * @endpt: end point (and therefore the start of empty space) 728 * @ecc: read returned -EBADMSG 729 * @buf: buffer containing entire LEB scanned 730 */ 731 struct ubifs_scan_leb { 732 int lnum; 733 int nodes_cnt; 734 struct list_head nodes; 735 int endpt; 736 int ecc; 737 void *buf; 738 }; 739 740 /** 741 * struct ubifs_gced_idx_leb - garbage-collected indexing LEB. 742 * @list: list 743 * @lnum: LEB number 744 * @unmap: OK to unmap this LEB 745 * 746 * This data structure is used to temporary store garbage-collected indexing 747 * LEBs - they are not released immediately, but only after the next commit. 748 * This is needed to guarantee recoverability. 749 */ 750 struct ubifs_gced_idx_leb { 751 struct list_head list; 752 int lnum; 753 int unmap; 754 }; 755 756 /** 757 * struct ubifs_inode - UBIFS in-memory inode description. 758 * @vfs_inode: VFS inode description object 759 * @creat_sqnum: sequence number at time of creation 760 * @del_cmtno: commit number corresponding to the time the inode was deleted, 761 * protected by @c->commit_sem; 762 * @xattr_size: summarized size of all extended attributes in bytes 763 * @xattr_cnt: count of extended attributes this inode has 764 * @xattr_names: sum of lengths of all extended attribute names belonging to 765 * this inode 766 * @dirty: non-zero if the inode is dirty 767 * @xattr: non-zero if this is an extended attribute inode 768 * @bulk_read: non-zero if bulk-read should be used 769 * @ui_mutex: serializes inode write-back with the rest of VFS operations, 770 * serializes "clean <-> dirty" state changes, serializes bulk-read, 771 * protects @dirty, @bulk_read, @ui_size, and @xattr_size 772 * @ui_lock: protects @synced_i_size 773 * @synced_i_size: synchronized size of inode, i.e. the value of inode size 774 * currently stored on the flash; used only for regular file 775 * inodes 776 * @ui_size: inode size used by UBIFS when writing to flash 777 * @flags: inode flags (@UBIFS_COMPR_FL, etc) 778 * @compr_type: default compression type used for this inode 779 * @last_page_read: page number of last page read (for bulk read) 780 * @read_in_a_row: number of consecutive pages read in a row (for bulk read) 781 * @data_len: length of the data attached to the inode 782 * @data: inode's data 783 * 784 * @ui_mutex exists for two main reasons. At first it prevents inodes from 785 * being written back while UBIFS changing them, being in the middle of an VFS 786 * operation. This way UBIFS makes sure the inode fields are consistent. For 787 * example, in 'ubifs_rename()' we change 3 inodes simultaneously, and 788 * write-back must not write any of them before we have finished. 789 * 790 * The second reason is budgeting - UBIFS has to budget all operations. If an 791 * operation is going to mark an inode dirty, it has to allocate budget for 792 * this. It cannot just mark it dirty because there is no guarantee there will 793 * be enough flash space to write the inode back later. This means UBIFS has 794 * to have full control over inode "clean <-> dirty" transitions (and pages 795 * actually). But unfortunately, VFS marks inodes dirty in many places, and it 796 * does not ask the file-system if it is allowed to do so (there is a notifier, 797 * but it is not enough), i.e., there is no mechanism to synchronize with this. 798 * So UBIFS has its own inode dirty flag and its own mutex to serialize 799 * "clean <-> dirty" transitions. 800 * 801 * The @synced_i_size field is used to make sure we never write pages which are 802 * beyond last synchronized inode size. See 'ubifs_writepage()' for more 803 * information. 804 * 805 * The @ui_size is a "shadow" variable for @inode->i_size and UBIFS uses 806 * @ui_size instead of @inode->i_size. The reason for this is that UBIFS cannot 807 * make sure @inode->i_size is always changed under @ui_mutex, because it 808 * cannot call 'vmtruncate()' with @ui_mutex locked, because it would deadlock 809 * with 'ubifs_writepage()' (see file.c). All the other inode fields are 810 * changed under @ui_mutex, so they do not need "shadow" fields. Note, one 811 * could consider to rework locking and base it on "shadow" fields. 812 */ 813 struct ubifs_inode { 814 struct inode vfs_inode; 815 unsigned long long creat_sqnum; 816 unsigned long long del_cmtno; 817 unsigned int xattr_size; 818 unsigned int xattr_cnt; 819 unsigned int xattr_names; 820 unsigned int dirty:1; 821 unsigned int xattr:1; 822 unsigned int bulk_read:1; 823 unsigned int compr_type:2; 824 struct mutex ui_mutex; 825 spinlock_t ui_lock; 826 loff_t synced_i_size; 827 loff_t ui_size; 828 int flags; 829 pgoff_t last_page_read; 830 pgoff_t read_in_a_row; 831 int data_len; 832 void *data; 833 }; 834 835 /** 836 * struct ubifs_unclean_leb - records a LEB recovered under read-only mode. 837 * @list: list 838 * @lnum: LEB number of recovered LEB 839 * @endpt: offset where recovery ended 840 * 841 * This structure records a LEB identified during recovery that needs to be 842 * cleaned but was not because UBIFS was mounted read-only. The information 843 * is used to clean the LEB when remounting to read-write mode. 844 */ 845 struct ubifs_unclean_leb { 846 struct list_head list; 847 int lnum; 848 int endpt; 849 }; 850 851 /* 852 * LEB properties flags. 853 * 854 * LPROPS_UNCAT: not categorized 855 * LPROPS_DIRTY: dirty > free, dirty >= @c->dead_wm, not index 856 * LPROPS_DIRTY_IDX: dirty + free > @c->min_idx_node_sze and index 857 * LPROPS_FREE: free > 0, dirty < @c->dead_wm, not empty, not index 858 * LPROPS_HEAP_CNT: number of heaps used for storing categorized LEBs 859 * LPROPS_EMPTY: LEB is empty, not taken 860 * LPROPS_FREEABLE: free + dirty == leb_size, not index, not taken 861 * LPROPS_FRDI_IDX: free + dirty == leb_size and index, may be taken 862 * LPROPS_CAT_MASK: mask for the LEB categories above 863 * LPROPS_TAKEN: LEB was taken (this flag is not saved on the media) 864 * LPROPS_INDEX: LEB contains indexing nodes (this flag also exists on flash) 865 */ 866 enum { 867 LPROPS_UNCAT = 0, 868 LPROPS_DIRTY = 1, 869 LPROPS_DIRTY_IDX = 2, 870 LPROPS_FREE = 3, 871 LPROPS_HEAP_CNT = 3, 872 LPROPS_EMPTY = 4, 873 LPROPS_FREEABLE = 5, 874 LPROPS_FRDI_IDX = 6, 875 LPROPS_CAT_MASK = 15, 876 LPROPS_TAKEN = 16, 877 LPROPS_INDEX = 32, 878 }; 879 880 /** 881 * struct ubifs_lprops - logical eraseblock properties. 882 * @free: amount of free space in bytes 883 * @dirty: amount of dirty space in bytes 884 * @flags: LEB properties flags (see above) 885 * @lnum: LEB number 886 * @list: list of same-category lprops (for LPROPS_EMPTY and LPROPS_FREEABLE) 887 * @hpos: heap position in heap of same-category lprops (other categories) 888 */ 889 struct ubifs_lprops { 890 int free; 891 int dirty; 892 int flags; 893 int lnum; 894 union { 895 struct list_head list; 896 int hpos; 897 }; 898 }; 899 900 /** 901 * struct ubifs_lpt_lprops - LPT logical eraseblock properties. 902 * @free: amount of free space in bytes 903 * @dirty: amount of dirty space in bytes 904 * @tgc: trivial GC flag (1 => unmap after commit end) 905 * @cmt: commit flag (1 => reserved for commit) 906 */ 907 struct ubifs_lpt_lprops { 908 int free; 909 int dirty; 910 unsigned tgc:1; 911 unsigned cmt:1; 912 }; 913 914 /** 915 * struct ubifs_lp_stats - statistics of eraseblocks in the main area. 916 * @empty_lebs: number of empty LEBs 917 * @taken_empty_lebs: number of taken LEBs 918 * @idx_lebs: number of indexing LEBs 919 * @total_free: total free space in bytes (includes all LEBs) 920 * @total_dirty: total dirty space in bytes (includes all LEBs) 921 * @total_used: total used space in bytes (does not include index LEBs) 922 * @total_dead: total dead space in bytes (does not include index LEBs) 923 * @total_dark: total dark space in bytes (does not include index LEBs) 924 * 925 * The @taken_empty_lebs field counts the LEBs that are in the transient state 926 * of having been "taken" for use but not yet written to. @taken_empty_lebs is 927 * needed to account correctly for @gc_lnum, otherwise @empty_lebs could be 928 * used by itself (in which case 'unused_lebs' would be a better name). In the 929 * case of @gc_lnum, it is "taken" at mount time or whenever a LEB is retained 930 * by GC, but unlike other empty LEBs that are "taken", it may not be written 931 * straight away (i.e. before the next commit start or unmount), so either 932 * @gc_lnum must be specially accounted for, or the current approach followed 933 * i.e. count it under @taken_empty_lebs. 934 * 935 * @empty_lebs includes @taken_empty_lebs. 936 * 937 * @total_used, @total_dead and @total_dark fields do not account indexing 938 * LEBs. 939 */ 940 struct ubifs_lp_stats { 941 int empty_lebs; 942 int taken_empty_lebs; 943 int idx_lebs; 944 long long total_free; 945 long long total_dirty; 946 long long total_used; 947 long long total_dead; 948 long long total_dark; 949 }; 950 951 struct ubifs_nnode; 952 953 /** 954 * struct ubifs_cnode - LEB Properties Tree common node. 955 * @parent: parent nnode 956 * @cnext: next cnode to commit 957 * @flags: flags (%DIRTY_LPT_NODE or %OBSOLETE_LPT_NODE) 958 * @iip: index in parent 959 * @level: level in the tree (zero for pnodes, greater than zero for nnodes) 960 * @num: node number 961 */ 962 struct ubifs_cnode { 963 struct ubifs_nnode *parent; 964 struct ubifs_cnode *cnext; 965 unsigned long flags; 966 int iip; 967 int level; 968 int num; 969 }; 970 971 /** 972 * struct ubifs_pnode - LEB Properties Tree leaf node. 973 * @parent: parent nnode 974 * @cnext: next cnode to commit 975 * @flags: flags (%DIRTY_LPT_NODE or %OBSOLETE_LPT_NODE) 976 * @iip: index in parent 977 * @level: level in the tree (always zero for pnodes) 978 * @num: node number 979 * @lprops: LEB properties array 980 */ 981 struct ubifs_pnode { 982 struct ubifs_nnode *parent; 983 struct ubifs_cnode *cnext; 984 unsigned long flags; 985 int iip; 986 int level; 987 int num; 988 struct ubifs_lprops lprops[UBIFS_LPT_FANOUT]; 989 }; 990 991 /** 992 * struct ubifs_nbranch - LEB Properties Tree internal node branch. 993 * @lnum: LEB number of child 994 * @offs: offset of child 995 * @nnode: nnode child 996 * @pnode: pnode child 997 * @cnode: cnode child 998 */ 999 struct ubifs_nbranch { 1000 int lnum; 1001 int offs; 1002 union { 1003 struct ubifs_nnode *nnode; 1004 struct ubifs_pnode *pnode; 1005 struct ubifs_cnode *cnode; 1006 }; 1007 }; 1008 1009 /** 1010 * struct ubifs_nnode - LEB Properties Tree internal node. 1011 * @parent: parent nnode 1012 * @cnext: next cnode to commit 1013 * @flags: flags (%DIRTY_LPT_NODE or %OBSOLETE_LPT_NODE) 1014 * @iip: index in parent 1015 * @level: level in the tree (always greater than zero for nnodes) 1016 * @num: node number 1017 * @nbranch: branches to child nodes 1018 */ 1019 struct ubifs_nnode { 1020 struct ubifs_nnode *parent; 1021 struct ubifs_cnode *cnext; 1022 unsigned long flags; 1023 int iip; 1024 int level; 1025 int num; 1026 struct ubifs_nbranch nbranch[UBIFS_LPT_FANOUT]; 1027 }; 1028 1029 /** 1030 * struct ubifs_lpt_heap - heap of categorized lprops. 1031 * @arr: heap array 1032 * @cnt: number in heap 1033 * @max_cnt: maximum number allowed in heap 1034 * 1035 * There are %LPROPS_HEAP_CNT heaps. 1036 */ 1037 struct ubifs_lpt_heap { 1038 struct ubifs_lprops **arr; 1039 int cnt; 1040 int max_cnt; 1041 }; 1042 1043 /* 1044 * Return codes for LPT scan callback function. 1045 * 1046 * LPT_SCAN_CONTINUE: continue scanning 1047 * LPT_SCAN_ADD: add the LEB properties scanned to the tree in memory 1048 * LPT_SCAN_STOP: stop scanning 1049 */ 1050 enum { 1051 LPT_SCAN_CONTINUE = 0, 1052 LPT_SCAN_ADD = 1, 1053 LPT_SCAN_STOP = 2, 1054 }; 1055 1056 struct ubifs_info; 1057 1058 /* Callback used by the 'ubifs_lpt_scan_nolock()' function */ 1059 typedef int (*ubifs_lpt_scan_callback)(struct ubifs_info *c, 1060 const struct ubifs_lprops *lprops, 1061 int in_tree, void *data); 1062 1063 /** 1064 * struct ubifs_wbuf - UBIFS write-buffer. 1065 * @c: UBIFS file-system description object 1066 * @buf: write-buffer (of min. flash I/O unit size) 1067 * @lnum: logical eraseblock number the write-buffer points to 1068 * @offs: write-buffer offset in this logical eraseblock 1069 * @avail: number of bytes available in the write-buffer 1070 * @used: number of used bytes in the write-buffer 1071 * @dtype: type of data stored in this LEB (%UBI_LONGTERM, %UBI_SHORTTERM, 1072 * %UBI_UNKNOWN) 1073 * @jhead: journal head the mutex belongs to (note, needed only to shut lockdep 1074 * up by 'mutex_lock_nested()). 1075 * @sync_callback: write-buffer synchronization callback 1076 * @io_mutex: serializes write-buffer I/O 1077 * @lock: serializes @buf, @lnum, @offs, @avail, @used, @next_ino and @inodes 1078 * fields 1079 * @timer: write-buffer timer 1080 * @timeout: timer expire interval in jiffies 1081 * @need_sync: it is set if its timer expired and needs sync 1082 * @next_ino: points to the next position of the following inode number 1083 * @inodes: stores the inode numbers of the nodes which are in wbuf 1084 * 1085 * The write-buffer synchronization callback is called when the write-buffer is 1086 * synchronized in order to notify how much space was wasted due to 1087 * write-buffer padding and how much free space is left in the LEB. 1088 * 1089 * Note: the fields @buf, @lnum, @offs, @avail and @used can be read under 1090 * spin-lock or mutex because they are written under both mutex and spin-lock. 1091 * @buf is appended to under mutex but overwritten under both mutex and 1092 * spin-lock. Thus the data between @buf and @buf + @used can be read under 1093 * spinlock. 1094 */ 1095 struct ubifs_wbuf { 1096 struct ubifs_info *c; 1097 void *buf; 1098 int lnum; 1099 int offs; 1100 int avail; 1101 int used; 1102 int dtype; 1103 int jhead; 1104 int (*sync_callback)(struct ubifs_info *c, int lnum, int free, int pad); 1105 struct mutex io_mutex; 1106 spinlock_t lock; 1107 int timeout; 1108 int need_sync; 1109 int next_ino; 1110 ino_t *inodes; 1111 }; 1112 1113 /** 1114 * struct ubifs_bud - bud logical eraseblock. 1115 * @lnum: logical eraseblock number 1116 * @start: where the (uncommitted) bud data starts 1117 * @jhead: journal head number this bud belongs to 1118 * @list: link in the list buds belonging to the same journal head 1119 * @rb: link in the tree of all buds 1120 */ 1121 struct ubifs_bud { 1122 int lnum; 1123 int start; 1124 int jhead; 1125 struct list_head list; 1126 struct rb_node rb; 1127 }; 1128 1129 /** 1130 * struct ubifs_jhead - journal head. 1131 * @wbuf: head's write-buffer 1132 * @buds_list: list of bud LEBs belonging to this journal head 1133 * 1134 * Note, the @buds list is protected by the @c->buds_lock. 1135 */ 1136 struct ubifs_jhead { 1137 struct ubifs_wbuf wbuf; 1138 struct list_head buds_list; 1139 }; 1140 1141 /** 1142 * struct ubifs_zbranch - key/coordinate/length branch stored in znodes. 1143 * @key: key 1144 * @znode: znode address in memory 1145 * @lnum: LEB number of the target node (indexing node or data node) 1146 * @offs: target node offset within @lnum 1147 * @len: target node length 1148 */ 1149 struct ubifs_zbranch { 1150 union ubifs_key key; 1151 union { 1152 struct ubifs_znode *znode; 1153 void *leaf; 1154 }; 1155 int lnum; 1156 int offs; 1157 int len; 1158 }; 1159 1160 /** 1161 * struct ubifs_znode - in-memory representation of an indexing node. 1162 * @parent: parent znode or NULL if it is the root 1163 * @cnext: next znode to commit 1164 * @flags: znode flags (%DIRTY_ZNODE, %COW_ZNODE or %OBSOLETE_ZNODE) 1165 * @time: last access time (seconds) 1166 * @level: level of the entry in the TNC tree 1167 * @child_cnt: count of child znodes 1168 * @iip: index in parent's zbranch array 1169 * @alt: lower bound of key range has altered i.e. child inserted at slot 0 1170 * @lnum: LEB number of the corresponding indexing node 1171 * @offs: offset of the corresponding indexing node 1172 * @len: length of the corresponding indexing node 1173 * @zbranch: array of znode branches (@c->fanout elements) 1174 */ 1175 struct ubifs_znode { 1176 struct ubifs_znode *parent; 1177 struct ubifs_znode *cnext; 1178 unsigned long flags; 1179 unsigned long time; 1180 int level; 1181 int child_cnt; 1182 int iip; 1183 int alt; 1184 #ifdef CONFIG_UBIFS_FS_DEBUG 1185 int lnum, offs, len; 1186 #endif 1187 struct ubifs_zbranch zbranch[]; 1188 }; 1189 1190 /** 1191 * struct bu_info - bulk-read information. 1192 * @key: first data node key 1193 * @zbranch: zbranches of data nodes to bulk read 1194 * @buf: buffer to read into 1195 * @buf_len: buffer length 1196 * @gc_seq: GC sequence number to detect races with GC 1197 * @cnt: number of data nodes for bulk read 1198 * @blk_cnt: number of data blocks including holes 1199 * @oef: end of file reached 1200 */ 1201 struct bu_info { 1202 union ubifs_key key; 1203 struct ubifs_zbranch zbranch[UBIFS_MAX_BULK_READ]; 1204 void *buf; 1205 int buf_len; 1206 int gc_seq; 1207 int cnt; 1208 int blk_cnt; 1209 int eof; 1210 }; 1211 1212 /** 1213 * struct ubifs_node_range - node length range description data structure. 1214 * @len: fixed node length 1215 * @min_len: minimum possible node length 1216 * @max_len: maximum possible node length 1217 * 1218 * If @max_len is %0, the node has fixed length @len. 1219 */ 1220 struct ubifs_node_range { 1221 union { 1222 int len; 1223 int min_len; 1224 }; 1225 int max_len; 1226 }; 1227 1228 /** 1229 * struct ubifs_compressor - UBIFS compressor description structure. 1230 * @compr_type: compressor type (%UBIFS_COMPR_LZO, etc) 1231 * @cc: cryptoapi compressor handle 1232 * @comp_mutex: mutex used during compression 1233 * @decomp_mutex: mutex used during decompression 1234 * @name: compressor name 1235 * @capi_name: cryptoapi compressor name 1236 */ 1237 struct ubifs_compressor { 1238 int compr_type; 1239 char *name; 1240 char *capi_name; 1241 int (*decompress)(const unsigned char *in, size_t in_len, 1242 unsigned char *out, size_t *out_len); 1243 }; 1244 1245 /** 1246 * struct ubifs_budget_req - budget requirements of an operation. 1247 * 1248 * @fast: non-zero if the budgeting should try to acquire budget quickly and 1249 * should not try to call write-back 1250 * @recalculate: non-zero if @idx_growth, @data_growth, and @dd_growth fields 1251 * have to be re-calculated 1252 * @new_page: non-zero if the operation adds a new page 1253 * @dirtied_page: non-zero if the operation makes a page dirty 1254 * @new_dent: non-zero if the operation adds a new directory entry 1255 * @mod_dent: non-zero if the operation removes or modifies an existing 1256 * directory entry 1257 * @new_ino: non-zero if the operation adds a new inode 1258 * @new_ino_d: now much data newly created inode contains 1259 * @dirtied_ino: how many inodes the operation makes dirty 1260 * @dirtied_ino_d: now much data dirtied inode contains 1261 * @idx_growth: how much the index will supposedly grow 1262 * @data_growth: how much new data the operation will supposedly add 1263 * @dd_growth: how much data that makes other data dirty the operation will 1264 * supposedly add 1265 * 1266 * @idx_growth, @data_growth and @dd_growth are not used in budget request. The 1267 * budgeting subsystem caches index and data growth values there to avoid 1268 * re-calculating them when the budget is released. However, if @idx_growth is 1269 * %-1, it is calculated by the release function using other fields. 1270 * 1271 * An inode may contain 4KiB of data at max., thus the widths of @new_ino_d 1272 * is 13 bits, and @dirtied_ino_d - 15, because up to 4 inodes may be made 1273 * dirty by the re-name operation. 1274 * 1275 * Note, UBIFS aligns node lengths to 8-bytes boundary, so the requester has to 1276 * make sure the amount of inode data which contribute to @new_ino_d and 1277 * @dirtied_ino_d fields are aligned. 1278 */ 1279 struct ubifs_budget_req { 1280 unsigned int fast:1; 1281 unsigned int recalculate:1; 1282 #ifndef UBIFS_DEBUG 1283 unsigned int new_page:1; 1284 unsigned int dirtied_page:1; 1285 unsigned int new_dent:1; 1286 unsigned int mod_dent:1; 1287 unsigned int new_ino:1; 1288 unsigned int new_ino_d:13; 1289 unsigned int dirtied_ino:4; 1290 unsigned int dirtied_ino_d:15; 1291 #else 1292 /* Not bit-fields to check for overflows */ 1293 unsigned int new_page; 1294 unsigned int dirtied_page; 1295 unsigned int new_dent; 1296 unsigned int mod_dent; 1297 unsigned int new_ino; 1298 unsigned int new_ino_d; 1299 unsigned int dirtied_ino; 1300 unsigned int dirtied_ino_d; 1301 #endif 1302 int idx_growth; 1303 int data_growth; 1304 int dd_growth; 1305 }; 1306 1307 /** 1308 * struct ubifs_orphan - stores the inode number of an orphan. 1309 * @rb: rb-tree node of rb-tree of orphans sorted by inode number 1310 * @list: list head of list of orphans in order added 1311 * @new_list: list head of list of orphans added since the last commit 1312 * @cnext: next orphan to commit 1313 * @dnext: next orphan to delete 1314 * @inum: inode number 1315 * @new: %1 => added since the last commit, otherwise %0 1316 */ 1317 struct ubifs_orphan { 1318 struct rb_node rb; 1319 struct list_head list; 1320 struct list_head new_list; 1321 struct ubifs_orphan *cnext; 1322 struct ubifs_orphan *dnext; 1323 ino_t inum; 1324 int new; 1325 }; 1326 1327 /** 1328 * struct ubifs_mount_opts - UBIFS-specific mount options information. 1329 * @unmount_mode: selected unmount mode (%0 default, %1 normal, %2 fast) 1330 * @bulk_read: enable/disable bulk-reads (%0 default, %1 disabe, %2 enable) 1331 * @chk_data_crc: enable/disable CRC data checking when reading data nodes 1332 * (%0 default, %1 disabe, %2 enable) 1333 * @override_compr: override default compressor (%0 - do not override and use 1334 * superblock compressor, %1 - override and use compressor 1335 * specified in @compr_type) 1336 * @compr_type: compressor type to override the superblock compressor with 1337 * (%UBIFS_COMPR_NONE, etc) 1338 */ 1339 struct ubifs_mount_opts { 1340 unsigned int unmount_mode:2; 1341 unsigned int bulk_read:2; 1342 unsigned int chk_data_crc:2; 1343 unsigned int override_compr:1; 1344 unsigned int compr_type:2; 1345 }; 1346 1347 struct ubifs_debug_info; 1348 1349 /** 1350 * struct ubifs_info - UBIFS file-system description data structure 1351 * (per-superblock). 1352 * @vfs_sb: VFS @struct super_block object 1353 * @bdi: backing device info object to make VFS happy and disable read-ahead 1354 * 1355 * @highest_inum: highest used inode number 1356 * @max_sqnum: current global sequence number 1357 * @cmt_no: commit number of the last successfully completed commit, protected 1358 * by @commit_sem 1359 * @cnt_lock: protects @highest_inum and @max_sqnum counters 1360 * @fmt_version: UBIFS on-flash format version 1361 * @ro_compat_version: R/O compatibility version 1362 * @uuid: UUID from super block 1363 * 1364 * @lhead_lnum: log head logical eraseblock number 1365 * @lhead_offs: log head offset 1366 * @ltail_lnum: log tail logical eraseblock number (offset is always 0) 1367 * @log_mutex: protects the log, @lhead_lnum, @lhead_offs, @ltail_lnum, and 1368 * @bud_bytes 1369 * @min_log_bytes: minimum required number of bytes in the log 1370 * @cmt_bud_bytes: used during commit to temporarily amount of bytes in 1371 * committed buds 1372 * 1373 * @buds: tree of all buds indexed by bud LEB number 1374 * @bud_bytes: how many bytes of flash is used by buds 1375 * @buds_lock: protects the @buds tree, @bud_bytes, and per-journal head bud 1376 * lists 1377 * @jhead_cnt: count of journal heads 1378 * @jheads: journal heads (head zero is base head) 1379 * @max_bud_bytes: maximum number of bytes allowed in buds 1380 * @bg_bud_bytes: number of bud bytes when background commit is initiated 1381 * @old_buds: buds to be released after commit ends 1382 * @max_bud_cnt: maximum number of buds 1383 * 1384 * @commit_sem: synchronizes committer with other processes 1385 * @cmt_state: commit state 1386 * @cs_lock: commit state lock 1387 * @cmt_wq: wait queue to sleep on if the log is full and a commit is running 1388 * 1389 * @big_lpt: flag that LPT is too big to write whole during commit 1390 * @no_chk_data_crc: do not check CRCs when reading data nodes (except during 1391 * recovery) 1392 * @bulk_read: enable bulk-reads 1393 * @default_compr: default compression algorithm (%UBIFS_COMPR_LZO, etc) 1394 * @rw_incompat: the media is not R/W compatible 1395 * 1396 * @tnc_mutex: protects the Tree Node Cache (TNC), @zroot, @cnext, @enext, and 1397 * @calc_idx_sz 1398 * @zroot: zbranch which points to the root index node and znode 1399 * @cnext: next znode to commit 1400 * @enext: next znode to commit to empty space 1401 * @gap_lebs: array of LEBs used by the in-gaps commit method 1402 * @cbuf: commit buffer 1403 * @ileb_buf: buffer for commit in-the-gaps method 1404 * @ileb_len: length of data in ileb_buf 1405 * @ihead_lnum: LEB number of index head 1406 * @ihead_offs: offset of index head 1407 * @ilebs: pre-allocated index LEBs 1408 * @ileb_cnt: number of pre-allocated index LEBs 1409 * @ileb_nxt: next pre-allocated index LEBs 1410 * @old_idx: tree of index nodes obsoleted since the last commit start 1411 * @bottom_up_buf: a buffer which is used by 'dirty_cow_bottom_up()' in tnc.c 1412 * 1413 * @mst_node: master node 1414 * @mst_offs: offset of valid master node 1415 * @mst_mutex: protects the master node area, @mst_node, and @mst_offs 1416 * 1417 * @max_bu_buf_len: maximum bulk-read buffer length 1418 * @bu_mutex: protects the pre-allocated bulk-read buffer and @c->bu 1419 * @bu: pre-allocated bulk-read information 1420 * 1421 * @log_lebs: number of logical eraseblocks in the log 1422 * @log_bytes: log size in bytes 1423 * @log_last: last LEB of the log 1424 * @lpt_lebs: number of LEBs used for lprops table 1425 * @lpt_first: first LEB of the lprops table area 1426 * @lpt_last: last LEB of the lprops table area 1427 * @orph_lebs: number of LEBs used for the orphan area 1428 * @orph_first: first LEB of the orphan area 1429 * @orph_last: last LEB of the orphan area 1430 * @main_lebs: count of LEBs in the main area 1431 * @main_first: first LEB of the main area 1432 * @main_bytes: main area size in bytes 1433 * 1434 * @key_hash_type: type of the key hash 1435 * @key_hash: direntry key hash function 1436 * @key_fmt: key format 1437 * @key_len: key length 1438 * @fanout: fanout of the index tree (number of links per indexing node) 1439 * 1440 * @min_io_size: minimal input/output unit size 1441 * @min_io_shift: number of bits in @min_io_size minus one 1442 * @leb_size: logical eraseblock size in bytes 1443 * @half_leb_size: half LEB size 1444 * @leb_cnt: count of logical eraseblocks 1445 * @max_leb_cnt: maximum count of logical eraseblocks 1446 * @old_leb_cnt: count of logical eraseblocks before re-size 1447 * @ro_media: the underlying UBI volume is read-only 1448 * 1449 * @dirty_pg_cnt: number of dirty pages (not used) 1450 * @dirty_zn_cnt: number of dirty znodes 1451 * @clean_zn_cnt: number of clean znodes 1452 * 1453 * @budg_idx_growth: amount of bytes budgeted for index growth 1454 * @budg_data_growth: amount of bytes budgeted for cached data 1455 * @budg_dd_growth: amount of bytes budgeted for cached data that will make 1456 * other data dirty 1457 * @budg_uncommitted_idx: amount of bytes were budgeted for growth of the index, 1458 * but which still have to be taken into account because 1459 * the index has not been committed so far 1460 * @space_lock: protects @budg_idx_growth, @budg_data_growth, @budg_dd_growth, 1461 * @budg_uncommited_idx, @min_idx_lebs, @old_idx_sz, @lst, 1462 * @nospace, and @nospace_rp; 1463 * @min_idx_lebs: minimum number of LEBs required for the index 1464 * @old_idx_sz: size of index on flash 1465 * @calc_idx_sz: temporary variable which is used to calculate new index size 1466 * (contains accurate new index size at end of TNC commit start) 1467 * @lst: lprops statistics 1468 * @nospace: non-zero if the file-system does not have flash space (used as 1469 * optimization) 1470 * @nospace_rp: the same as @nospace, but additionally means that even reserved 1471 * pool is full 1472 * 1473 * @page_budget: budget for a page 1474 * @inode_budget: budget for an inode 1475 * @dent_budget: budget for a directory entry 1476 * 1477 * @ref_node_alsz: size of the LEB reference node aligned to the min. flash 1478 * I/O unit 1479 * @mst_node_alsz: master node aligned size 1480 * @min_idx_node_sz: minimum indexing node aligned on 8-bytes boundary 1481 * @max_idx_node_sz: maximum indexing node aligned on 8-bytes boundary 1482 * @max_inode_sz: maximum possible inode size in bytes 1483 * @max_znode_sz: size of znode in bytes 1484 * 1485 * @leb_overhead: how many bytes are wasted in an LEB when it is filled with 1486 * data nodes of maximum size - used in free space reporting 1487 * @dead_wm: LEB dead space watermark 1488 * @dark_wm: LEB dark space watermark 1489 * @block_cnt: count of 4KiB blocks on the FS 1490 * 1491 * @ranges: UBIFS node length ranges 1492 * @ubi: UBI volume descriptor 1493 * @di: UBI device information 1494 * @vi: UBI volume information 1495 * 1496 * @orph_tree: rb-tree of orphan inode numbers 1497 * @orph_list: list of orphan inode numbers in order added 1498 * @orph_new: list of orphan inode numbers added since last commit 1499 * @orph_cnext: next orphan to commit 1500 * @orph_dnext: next orphan to delete 1501 * @orphan_lock: lock for orph_tree and orph_new 1502 * @orph_buf: buffer for orphan nodes 1503 * @new_orphans: number of orphans since last commit 1504 * @cmt_orphans: number of orphans being committed 1505 * @tot_orphans: number of orphans in the rb_tree 1506 * @max_orphans: maximum number of orphans allowed 1507 * @ohead_lnum: orphan head LEB number 1508 * @ohead_offs: orphan head offset 1509 * @no_orphs: non-zero if there are no orphans 1510 * 1511 * @bgt: UBIFS background thread 1512 * @bgt_name: background thread name 1513 * @need_bgt: if background thread should run 1514 * @need_wbuf_sync: if write-buffers have to be synchronized 1515 * 1516 * @gc_lnum: LEB number used for garbage collection 1517 * @sbuf: a buffer of LEB size used by GC and replay for scanning 1518 * @idx_gc: list of index LEBs that have been garbage collected 1519 * @idx_gc_cnt: number of elements on the idx_gc list 1520 * @gc_seq: incremented for every non-index LEB garbage collected 1521 * @gced_lnum: last non-index LEB that was garbage collected 1522 * 1523 * @infos_list: links all 'ubifs_info' objects 1524 * @umount_mutex: serializes shrinker and un-mount 1525 * @shrinker_run_no: shrinker run number 1526 * 1527 * @space_bits: number of bits needed to record free or dirty space 1528 * @lpt_lnum_bits: number of bits needed to record a LEB number in the LPT 1529 * @lpt_offs_bits: number of bits needed to record an offset in the LPT 1530 * @lpt_spc_bits: number of bits needed to space in the LPT 1531 * @pcnt_bits: number of bits needed to record pnode or nnode number 1532 * @lnum_bits: number of bits needed to record LEB number 1533 * @nnode_sz: size of on-flash nnode 1534 * @pnode_sz: size of on-flash pnode 1535 * @ltab_sz: size of on-flash LPT lprops table 1536 * @lsave_sz: size of on-flash LPT save table 1537 * @pnode_cnt: number of pnodes 1538 * @nnode_cnt: number of nnodes 1539 * @lpt_hght: height of the LPT 1540 * @pnodes_have: number of pnodes in memory 1541 * 1542 * @lp_mutex: protects lprops table and all the other lprops-related fields 1543 * @lpt_lnum: LEB number of the root nnode of the LPT 1544 * @lpt_offs: offset of the root nnode of the LPT 1545 * @nhead_lnum: LEB number of LPT head 1546 * @nhead_offs: offset of LPT head 1547 * @lpt_drty_flgs: dirty flags for LPT special nodes e.g. ltab 1548 * @dirty_nn_cnt: number of dirty nnodes 1549 * @dirty_pn_cnt: number of dirty pnodes 1550 * @check_lpt_free: flag that indicates LPT GC may be needed 1551 * @lpt_sz: LPT size 1552 * @lpt_nod_buf: buffer for an on-flash nnode or pnode 1553 * @lpt_buf: buffer of LEB size used by LPT 1554 * @nroot: address in memory of the root nnode of the LPT 1555 * @lpt_cnext: next LPT node to commit 1556 * @lpt_heap: array of heaps of categorized lprops 1557 * @dirty_idx: a (reverse sorted) copy of the LPROPS_DIRTY_IDX heap as at 1558 * previous commit start 1559 * @uncat_list: list of un-categorized LEBs 1560 * @empty_list: list of empty LEBs 1561 * @freeable_list: list of freeable non-index LEBs (free + dirty == leb_size) 1562 * @frdi_idx_list: list of freeable index LEBs (free + dirty == leb_size) 1563 * @freeable_cnt: number of freeable LEBs in @freeable_list 1564 * 1565 * @ltab_lnum: LEB number of LPT's own lprops table 1566 * @ltab_offs: offset of LPT's own lprops table 1567 * @ltab: LPT's own lprops table 1568 * @ltab_cmt: LPT's own lprops table (commit copy) 1569 * @lsave_cnt: number of LEB numbers in LPT's save table 1570 * @lsave_lnum: LEB number of LPT's save table 1571 * @lsave_offs: offset of LPT's save table 1572 * @lsave: LPT's save table 1573 * @lscan_lnum: LEB number of last LPT scan 1574 * 1575 * @rp_size: size of the reserved pool in bytes 1576 * @report_rp_size: size of the reserved pool reported to user-space 1577 * @rp_uid: reserved pool user ID 1578 * @rp_gid: reserved pool group ID 1579 * 1580 * @empty: if the UBI device is empty 1581 * @replay_tree: temporary tree used during journal replay 1582 * @replay_list: temporary list used during journal replay 1583 * @replay_buds: list of buds to replay 1584 * @cs_sqnum: sequence number of first node in the log (commit start node) 1585 * @replay_sqnum: sequence number of node currently being replayed 1586 * @need_recovery: file-system needs recovery 1587 * @replaying: set to %1 during journal replay 1588 * @unclean_leb_list: LEBs to recover when mounting ro to rw 1589 * @rcvrd_mst_node: recovered master node to write when mounting ro to rw 1590 * @size_tree: inode size information for recovery 1591 * @remounting_rw: set while remounting from ro to rw (sb flags have MS_RDONLY) 1592 * @always_chk_crc: always check CRCs (while mounting and remounting rw) 1593 * @mount_opts: UBIFS-specific mount options 1594 * 1595 * @dbg: debugging-related information 1596 */ 1597 struct ubifs_info { 1598 struct super_block *vfs_sb; 1599 1600 ino_t highest_inum; 1601 unsigned long long max_sqnum; 1602 unsigned long long cmt_no; 1603 spinlock_t cnt_lock; 1604 int fmt_version; 1605 int ro_compat_version; 1606 unsigned char uuid[16]; 1607 1608 int lhead_lnum; 1609 int lhead_offs; 1610 int ltail_lnum; 1611 struct mutex log_mutex; 1612 int min_log_bytes; 1613 long long cmt_bud_bytes; 1614 1615 struct rb_root buds; 1616 long long bud_bytes; 1617 spinlock_t buds_lock; 1618 int jhead_cnt; 1619 struct ubifs_jhead *jheads; 1620 long long max_bud_bytes; 1621 long long bg_bud_bytes; 1622 struct list_head old_buds; 1623 int max_bud_cnt; 1624 1625 struct rw_semaphore commit_sem; 1626 int cmt_state; 1627 spinlock_t cs_lock; 1628 wait_queue_head_t cmt_wq; 1629 1630 unsigned int big_lpt:1; 1631 unsigned int no_chk_data_crc:1; 1632 unsigned int bulk_read:1; 1633 unsigned int default_compr:2; 1634 unsigned int rw_incompat:1; 1635 1636 struct mutex tnc_mutex; 1637 struct ubifs_zbranch zroot; 1638 struct ubifs_znode *cnext; 1639 struct ubifs_znode *enext; 1640 int *gap_lebs; 1641 void *cbuf; 1642 void *ileb_buf; 1643 int ileb_len; 1644 int ihead_lnum; 1645 int ihead_offs; 1646 int *ilebs; 1647 int ileb_cnt; 1648 int ileb_nxt; 1649 struct rb_root old_idx; 1650 int *bottom_up_buf; 1651 1652 struct ubifs_mst_node *mst_node; 1653 int mst_offs; 1654 struct mutex mst_mutex; 1655 1656 int max_bu_buf_len; 1657 struct mutex bu_mutex; 1658 struct bu_info bu; 1659 1660 int log_lebs; 1661 long long log_bytes; 1662 int log_last; 1663 int lpt_lebs; 1664 int lpt_first; 1665 int lpt_last; 1666 int orph_lebs; 1667 int orph_first; 1668 int orph_last; 1669 int main_lebs; 1670 int main_first; 1671 long long main_bytes; 1672 1673 uint8_t key_hash_type; 1674 uint32_t (*key_hash)(const char *str, int len); 1675 int key_fmt; 1676 int key_len; 1677 int fanout; 1678 1679 int min_io_size; 1680 int min_io_shift; 1681 int leb_size; 1682 int half_leb_size; 1683 int leb_cnt; 1684 int max_leb_cnt; 1685 int old_leb_cnt; 1686 int ro_media; 1687 1688 long long budg_idx_growth; 1689 long long budg_data_growth; 1690 long long budg_dd_growth; 1691 long long budg_uncommitted_idx; 1692 spinlock_t space_lock; 1693 int min_idx_lebs; 1694 unsigned long long old_idx_sz; 1695 unsigned long long calc_idx_sz; 1696 struct ubifs_lp_stats lst; 1697 unsigned int nospace:1; 1698 unsigned int nospace_rp:1; 1699 1700 int page_budget; 1701 int inode_budget; 1702 int dent_budget; 1703 1704 int ref_node_alsz; 1705 int mst_node_alsz; 1706 int min_idx_node_sz; 1707 int max_idx_node_sz; 1708 long long max_inode_sz; 1709 int max_znode_sz; 1710 1711 int leb_overhead; 1712 int dead_wm; 1713 int dark_wm; 1714 int block_cnt; 1715 1716 struct ubifs_node_range ranges[UBIFS_NODE_TYPES_CNT]; 1717 struct ubi_volume_desc *ubi; 1718 struct ubi_device_info di; 1719 struct ubi_volume_info vi; 1720 1721 struct rb_root orph_tree; 1722 struct list_head orph_list; 1723 struct list_head orph_new; 1724 struct ubifs_orphan *orph_cnext; 1725 struct ubifs_orphan *orph_dnext; 1726 spinlock_t orphan_lock; 1727 void *orph_buf; 1728 int new_orphans; 1729 int cmt_orphans; 1730 int tot_orphans; 1731 int max_orphans; 1732 int ohead_lnum; 1733 int ohead_offs; 1734 int no_orphs; 1735 1736 struct task_struct *bgt; 1737 char bgt_name[sizeof(BGT_NAME_PATTERN) + 9]; 1738 int need_bgt; 1739 int need_wbuf_sync; 1740 1741 int gc_lnum; 1742 void *sbuf; 1743 struct list_head idx_gc; 1744 int idx_gc_cnt; 1745 int gc_seq; 1746 int gced_lnum; 1747 1748 struct list_head infos_list; 1749 struct mutex umount_mutex; 1750 unsigned int shrinker_run_no; 1751 1752 int space_bits; 1753 int lpt_lnum_bits; 1754 int lpt_offs_bits; 1755 int lpt_spc_bits; 1756 int pcnt_bits; 1757 int lnum_bits; 1758 int nnode_sz; 1759 int pnode_sz; 1760 int ltab_sz; 1761 int lsave_sz; 1762 int pnode_cnt; 1763 int nnode_cnt; 1764 int lpt_hght; 1765 int pnodes_have; 1766 1767 struct mutex lp_mutex; 1768 int lpt_lnum; 1769 int lpt_offs; 1770 int nhead_lnum; 1771 int nhead_offs; 1772 int lpt_drty_flgs; 1773 int dirty_nn_cnt; 1774 int dirty_pn_cnt; 1775 int check_lpt_free; 1776 long long lpt_sz; 1777 void *lpt_nod_buf; 1778 void *lpt_buf; 1779 struct ubifs_nnode *nroot; 1780 struct ubifs_cnode *lpt_cnext; 1781 struct ubifs_lpt_heap lpt_heap[LPROPS_HEAP_CNT]; 1782 struct ubifs_lpt_heap dirty_idx; 1783 struct list_head uncat_list; 1784 struct list_head empty_list; 1785 struct list_head freeable_list; 1786 struct list_head frdi_idx_list; 1787 int freeable_cnt; 1788 1789 int ltab_lnum; 1790 int ltab_offs; 1791 struct ubifs_lpt_lprops *ltab; 1792 struct ubifs_lpt_lprops *ltab_cmt; 1793 int lsave_cnt; 1794 int lsave_lnum; 1795 int lsave_offs; 1796 int *lsave; 1797 int lscan_lnum; 1798 1799 long long rp_size; 1800 long long report_rp_size; 1801 uid_t rp_uid; 1802 gid_t rp_gid; 1803 1804 /* The below fields are used only during mounting and re-mounting */ 1805 int empty; 1806 struct rb_root replay_tree; 1807 struct list_head replay_list; 1808 struct list_head replay_buds; 1809 unsigned long long cs_sqnum; 1810 unsigned long long replay_sqnum; 1811 int need_recovery; 1812 int replaying; 1813 struct list_head unclean_leb_list; 1814 struct ubifs_mst_node *rcvrd_mst_node; 1815 struct rb_root size_tree; 1816 int remounting_rw; 1817 int always_chk_crc; 1818 struct ubifs_mount_opts mount_opts; 1819 1820 #ifdef CONFIG_UBIFS_FS_DEBUG 1821 struct ubifs_debug_info *dbg; 1822 #endif 1823 }; 1824 1825 extern spinlock_t ubifs_infos_lock; 1826 extern struct kmem_cache *ubifs_inode_slab; 1827 extern const struct super_operations ubifs_super_operations; 1828 extern const struct address_space_operations ubifs_file_address_operations; 1829 extern const struct file_operations ubifs_file_operations; 1830 extern const struct inode_operations ubifs_file_inode_operations; 1831 extern const struct file_operations ubifs_dir_operations; 1832 extern const struct inode_operations ubifs_dir_inode_operations; 1833 extern const struct inode_operations ubifs_symlink_inode_operations; 1834 extern struct backing_dev_info ubifs_backing_dev_info; 1835 extern struct ubifs_compressor *ubifs_compressors[UBIFS_COMPR_TYPES_CNT]; 1836 1837 /* io.c */ 1838 void ubifs_ro_mode(struct ubifs_info *c, int err); 1839 int ubifs_wbuf_write_nolock(struct ubifs_wbuf *wbuf, void *buf, int len); 1840 int ubifs_wbuf_seek_nolock(struct ubifs_wbuf *wbuf, int lnum, int offs, 1841 int dtype); 1842 int ubifs_wbuf_init(struct ubifs_info *c, struct ubifs_wbuf *wbuf); 1843 int ubifs_read_node(const struct ubifs_info *c, void *buf, int type, int len, 1844 int lnum, int offs); 1845 int ubifs_read_node_wbuf(struct ubifs_wbuf *wbuf, void *buf, int type, int len, 1846 int lnum, int offs); 1847 int ubifs_write_node(struct ubifs_info *c, void *node, int len, int lnum, 1848 int offs, int dtype); 1849 int ubifs_check_node(const struct ubifs_info *c, const void *buf, int lnum, 1850 int offs, int quiet, int must_chk_crc); 1851 void ubifs_prepare_node(struct ubifs_info *c, void *buf, int len, int pad); 1852 void ubifs_prep_grp_node(struct ubifs_info *c, void *node, int len, int last); 1853 int ubifs_io_init(struct ubifs_info *c); 1854 void ubifs_pad(const struct ubifs_info *c, void *buf, int pad); 1855 int ubifs_wbuf_sync_nolock(struct ubifs_wbuf *wbuf); 1856 int ubifs_bg_wbufs_sync(struct ubifs_info *c); 1857 void ubifs_wbuf_add_ino_nolock(struct ubifs_wbuf *wbuf, ino_t inum); 1858 int ubifs_sync_wbufs_by_inode(struct ubifs_info *c, struct inode *inode); 1859 1860 /* scan.c */ 1861 struct ubifs_scan_leb *ubifs_scan(const struct ubifs_info *c, int lnum, 1862 int offs, void *sbuf); 1863 void ubifs_scan_destroy(struct ubifs_scan_leb *sleb); 1864 int ubifs_scan_a_node(const struct ubifs_info *c, void *buf, int len, int lnum, 1865 int offs, int quiet); 1866 struct ubifs_scan_leb *ubifs_start_scan(const struct ubifs_info *c, int lnum, 1867 int offs, void *sbuf); 1868 void ubifs_end_scan(const struct ubifs_info *c, struct ubifs_scan_leb *sleb, 1869 int lnum, int offs); 1870 int ubifs_add_snod(const struct ubifs_info *c, struct ubifs_scan_leb *sleb, 1871 void *buf, int offs); 1872 void ubifs_scanned_corruption(const struct ubifs_info *c, int lnum, int offs, 1873 void *buf); 1874 1875 /* log.c */ 1876 void ubifs_add_bud(struct ubifs_info *c, struct ubifs_bud *bud); 1877 void ubifs_create_buds_lists(struct ubifs_info *c); 1878 int ubifs_add_bud_to_log(struct ubifs_info *c, int jhead, int lnum, int offs); 1879 struct ubifs_bud *ubifs_search_bud(struct ubifs_info *c, int lnum); 1880 struct ubifs_wbuf *ubifs_get_wbuf(struct ubifs_info *c, int lnum); 1881 int ubifs_log_start_commit(struct ubifs_info *c, int *ltail_lnum); 1882 int ubifs_log_end_commit(struct ubifs_info *c, int new_ltail_lnum); 1883 int ubifs_log_post_commit(struct ubifs_info *c, int old_ltail_lnum); 1884 int ubifs_consolidate_log(struct ubifs_info *c); 1885 1886 /* journal.c */ 1887 int ubifs_jnl_update(struct ubifs_info *c, const struct inode *dir, 1888 const struct qstr *nm, const struct inode *inode, 1889 int deletion, int xent); 1890 int ubifs_jnl_write_data(struct ubifs_info *c, const struct inode *inode, 1891 const union ubifs_key *key, const void *buf, int len); 1892 int ubifs_jnl_write_inode(struct ubifs_info *c, const struct inode *inode); 1893 int ubifs_jnl_delete_inode(struct ubifs_info *c, const struct inode *inode); 1894 int ubifs_jnl_rename(struct ubifs_info *c, const struct inode *old_dir, 1895 const struct dentry *old_dentry, 1896 const struct inode *new_dir, 1897 const struct dentry *new_dentry, int sync); 1898 int ubifs_jnl_truncate(struct ubifs_info *c, const struct inode *inode, 1899 loff_t old_size, loff_t new_size); 1900 int ubifs_jnl_delete_xattr(struct ubifs_info *c, const struct inode *host, 1901 const struct inode *inode, const struct qstr *nm); 1902 int ubifs_jnl_change_xattr(struct ubifs_info *c, const struct inode *inode1, 1903 const struct inode *inode2); 1904 1905 /* budget.c */ 1906 int ubifs_budget_space(struct ubifs_info *c, struct ubifs_budget_req *req); 1907 void ubifs_release_budget(struct ubifs_info *c, struct ubifs_budget_req *req); 1908 void ubifs_release_dirty_inode_budget(struct ubifs_info *c, 1909 struct ubifs_inode *ui); 1910 int ubifs_budget_inode_op(struct ubifs_info *c, struct inode *inode, 1911 struct ubifs_budget_req *req); 1912 void ubifs_release_ino_dirty(struct ubifs_info *c, struct inode *inode, 1913 struct ubifs_budget_req *req); 1914 void ubifs_cancel_ino_op(struct ubifs_info *c, struct inode *inode, 1915 struct ubifs_budget_req *req); 1916 long long ubifs_get_free_space(struct ubifs_info *c); 1917 long long ubifs_get_free_space_nolock(struct ubifs_info *c); 1918 int ubifs_calc_min_idx_lebs(struct ubifs_info *c); 1919 void ubifs_convert_page_budget(struct ubifs_info *c); 1920 long long ubifs_reported_space(const struct ubifs_info *c, long long free); 1921 long long ubifs_calc_available(const struct ubifs_info *c, int min_idx_lebs); 1922 1923 /* find.c */ 1924 int ubifs_find_free_space(struct ubifs_info *c, int min_space, int *free, 1925 int squeeze); 1926 int ubifs_find_free_leb_for_idx(struct ubifs_info *c); 1927 int ubifs_find_dirty_leb(struct ubifs_info *c, struct ubifs_lprops *ret_lp, 1928 int min_space, int pick_free); 1929 int ubifs_find_dirty_idx_leb(struct ubifs_info *c); 1930 int ubifs_save_dirty_idx_lnums(struct ubifs_info *c); 1931 1932 /* tnc.c */ 1933 int ubifs_lookup_level0(struct ubifs_info *c, const union ubifs_key *key, 1934 struct ubifs_znode **zn, int *n); 1935 int ubifs_tnc_lookup_nm(struct ubifs_info *c, const union ubifs_key *key, 1936 void *node, const struct qstr *nm); 1937 int ubifs_tnc_locate(struct ubifs_info *c, const union ubifs_key *key, 1938 void *node, int *lnum, int *offs); 1939 int ubifs_tnc_add(struct ubifs_info *c, const union ubifs_key *key, int lnum, 1940 int offs, int len); 1941 int ubifs_tnc_replace(struct ubifs_info *c, const union ubifs_key *key, 1942 int old_lnum, int old_offs, int lnum, int offs, int len); 1943 int ubifs_tnc_add_nm(struct ubifs_info *c, const union ubifs_key *key, 1944 int lnum, int offs, int len, const struct qstr *nm); 1945 int ubifs_tnc_remove(struct ubifs_info *c, const union ubifs_key *key); 1946 int ubifs_tnc_remove_nm(struct ubifs_info *c, const union ubifs_key *key, 1947 const struct qstr *nm); 1948 int ubifs_tnc_remove_range(struct ubifs_info *c, union ubifs_key *from_key, 1949 union ubifs_key *to_key); 1950 int ubifs_tnc_remove_ino(struct ubifs_info *c, ino_t inum); 1951 struct ubifs_dent_node *ubifs_tnc_next_ent(struct ubifs_info *c, 1952 union ubifs_key *key, 1953 const struct qstr *nm); 1954 void ubifs_tnc_close(struct ubifs_info *c); 1955 int ubifs_tnc_has_node(struct ubifs_info *c, union ubifs_key *key, int level, 1956 int lnum, int offs, int is_idx); 1957 int ubifs_dirty_idx_node(struct ubifs_info *c, union ubifs_key *key, int level, 1958 int lnum, int offs); 1959 /* Shared by tnc.c for tnc_commit.c */ 1960 void destroy_old_idx(struct ubifs_info *c); 1961 int is_idx_node_in_tnc(struct ubifs_info *c, union ubifs_key *key, int level, 1962 int lnum, int offs); 1963 int insert_old_idx_znode(struct ubifs_info *c, struct ubifs_znode *znode); 1964 int ubifs_tnc_get_bu_keys(struct ubifs_info *c, struct bu_info *bu); 1965 int ubifs_tnc_bulk_read(struct ubifs_info *c, struct bu_info *bu); 1966 1967 /* tnc_misc.c */ 1968 struct ubifs_znode *ubifs_tnc_levelorder_next(struct ubifs_znode *zr, 1969 struct ubifs_znode *znode); 1970 int ubifs_search_zbranch(const struct ubifs_info *c, 1971 const struct ubifs_znode *znode, 1972 const union ubifs_key *key, int *n); 1973 struct ubifs_znode *ubifs_tnc_postorder_first(struct ubifs_znode *znode); 1974 struct ubifs_znode *ubifs_tnc_postorder_next(struct ubifs_znode *znode); 1975 long ubifs_destroy_tnc_subtree(struct ubifs_znode *zr); 1976 struct ubifs_znode *ubifs_load_znode(struct ubifs_info *c, 1977 struct ubifs_zbranch *zbr, 1978 struct ubifs_znode *parent, int iip); 1979 int ubifs_tnc_read_node(struct ubifs_info *c, struct ubifs_zbranch *zbr, 1980 void *node); 1981 1982 /* tnc_commit.c */ 1983 int ubifs_tnc_start_commit(struct ubifs_info *c, struct ubifs_zbranch *zroot); 1984 int ubifs_tnc_end_commit(struct ubifs_info *c); 1985 1986 /* shrinker.c */ 1987 int ubifs_shrinker(int nr_to_scan, gfp_t gfp_mask); 1988 1989 /* commit.c */ 1990 int ubifs_bg_thread(void *info); 1991 void ubifs_commit_required(struct ubifs_info *c); 1992 void ubifs_request_bg_commit(struct ubifs_info *c); 1993 int ubifs_run_commit(struct ubifs_info *c); 1994 void ubifs_recovery_commit(struct ubifs_info *c); 1995 int ubifs_gc_should_commit(struct ubifs_info *c); 1996 void ubifs_wait_for_commit(struct ubifs_info *c); 1997 1998 /* master.c */ 1999 int ubifs_read_master(struct ubifs_info *c); 2000 int ubifs_write_master(struct ubifs_info *c); 2001 2002 /* sb.c */ 2003 int ubifs_read_superblock(struct ubifs_info *c); 2004 struct ubifs_sb_node *ubifs_read_sb_node(struct ubifs_info *c); 2005 int ubifs_write_sb_node(struct ubifs_info *c, struct ubifs_sb_node *sup); 2006 2007 /* replay.c */ 2008 int ubifs_validate_entry(struct ubifs_info *c, 2009 const struct ubifs_dent_node *dent); 2010 int ubifs_replay_journal(struct ubifs_info *c); 2011 2012 /* gc.c */ 2013 int ubifs_garbage_collect(struct ubifs_info *c, int anyway); 2014 int ubifs_gc_start_commit(struct ubifs_info *c); 2015 int ubifs_gc_end_commit(struct ubifs_info *c); 2016 void ubifs_destroy_idx_gc(struct ubifs_info *c); 2017 int ubifs_get_idx_gc_leb(struct ubifs_info *c); 2018 int ubifs_garbage_collect_leb(struct ubifs_info *c, struct ubifs_lprops *lp); 2019 2020 /* orphan.c */ 2021 int ubifs_add_orphan(struct ubifs_info *c, ino_t inum); 2022 void ubifs_delete_orphan(struct ubifs_info *c, ino_t inum); 2023 int ubifs_orphan_start_commit(struct ubifs_info *c); 2024 int ubifs_orphan_end_commit(struct ubifs_info *c); 2025 int ubifs_mount_orphans(struct ubifs_info *c, int unclean, int read_only); 2026 int ubifs_clear_orphans(struct ubifs_info *c); 2027 2028 /* lpt.c */ 2029 int ubifs_calc_lpt_geom(struct ubifs_info *c); 2030 int ubifs_create_dflt_lpt(struct ubifs_info *c, int *main_lebs, int lpt_first, 2031 int *lpt_lebs, int *big_lpt); 2032 int ubifs_lpt_init(struct ubifs_info *c, int rd, int wr); 2033 struct ubifs_lprops *ubifs_lpt_lookup(struct ubifs_info *c, int lnum); 2034 struct ubifs_lprops *ubifs_lpt_lookup_dirty(struct ubifs_info *c, int lnum); 2035 int ubifs_lpt_scan_nolock(struct ubifs_info *c, int start_lnum, int end_lnum, 2036 ubifs_lpt_scan_callback scan_cb, void *data); 2037 2038 /* Shared by lpt.c for lpt_commit.c */ 2039 void ubifs_pack_lsave(struct ubifs_info *c, void *buf, int *lsave); 2040 void ubifs_pack_ltab(struct ubifs_info *c, void *buf, 2041 struct ubifs_lpt_lprops *ltab); 2042 void ubifs_pack_pnode(struct ubifs_info *c, void *buf, 2043 struct ubifs_pnode *pnode); 2044 void ubifs_pack_nnode(struct ubifs_info *c, void *buf, 2045 struct ubifs_nnode *nnode); 2046 struct ubifs_pnode *ubifs_get_pnode(struct ubifs_info *c, 2047 struct ubifs_nnode *parent, int iip); 2048 struct ubifs_nnode *ubifs_get_nnode(struct ubifs_info *c, 2049 struct ubifs_nnode *parent, int iip); 2050 int ubifs_read_nnode(struct ubifs_info *c, struct ubifs_nnode *parent, int iip); 2051 void ubifs_add_lpt_dirt(struct ubifs_info *c, int lnum, int dirty); 2052 void ubifs_add_nnode_dirt(struct ubifs_info *c, struct ubifs_nnode *nnode); 2053 uint32_t ubifs_unpack_bits(uint8_t **addr, int *pos, int nrbits); 2054 struct ubifs_nnode *ubifs_first_nnode(struct ubifs_info *c, int *hght); 2055 /* Needed only in debugging code in lpt_commit.c */ 2056 int ubifs_unpack_nnode(const struct ubifs_info *c, void *buf, 2057 struct ubifs_nnode *nnode); 2058 2059 /* lpt_commit.c */ 2060 int ubifs_lpt_start_commit(struct ubifs_info *c); 2061 int ubifs_lpt_end_commit(struct ubifs_info *c); 2062 int ubifs_lpt_post_commit(struct ubifs_info *c); 2063 void ubifs_lpt_free(struct ubifs_info *c, int wr_only); 2064 2065 /* lprops.c */ 2066 const struct ubifs_lprops *ubifs_change_lp(struct ubifs_info *c, 2067 const struct ubifs_lprops *lp, 2068 int free, int dirty, int flags, 2069 int idx_gc_cnt); 2070 void ubifs_get_lp_stats(struct ubifs_info *c, struct ubifs_lp_stats *lst); 2071 void ubifs_add_to_cat(struct ubifs_info *c, struct ubifs_lprops *lprops, 2072 int cat); 2073 void ubifs_replace_cat(struct ubifs_info *c, struct ubifs_lprops *old_lprops, 2074 struct ubifs_lprops *new_lprops); 2075 void ubifs_ensure_cat(struct ubifs_info *c, struct ubifs_lprops *lprops); 2076 int ubifs_categorize_lprops(const struct ubifs_info *c, 2077 const struct ubifs_lprops *lprops); 2078 int ubifs_change_one_lp(struct ubifs_info *c, int lnum, int free, int dirty, 2079 int flags_set, int flags_clean, int idx_gc_cnt); 2080 int ubifs_update_one_lp(struct ubifs_info *c, int lnum, int free, int dirty, 2081 int flags_set, int flags_clean); 2082 int ubifs_read_one_lp(struct ubifs_info *c, int lnum, struct ubifs_lprops *lp); 2083 const struct ubifs_lprops *ubifs_fast_find_free(struct ubifs_info *c); 2084 const struct ubifs_lprops *ubifs_fast_find_empty(struct ubifs_info *c); 2085 const struct ubifs_lprops *ubifs_fast_find_freeable(struct ubifs_info *c); 2086 const struct ubifs_lprops *ubifs_fast_find_frdi_idx(struct ubifs_info *c); 2087 2088 /* file.c */ 2089 int ubifs_fsync(struct file *file, struct dentry *dentry, int datasync); 2090 int ubifs_setattr(struct dentry *dentry, struct iattr *attr); 2091 2092 /* dir.c */ 2093 struct inode *ubifs_new_inode(struct ubifs_info *c, const struct inode *dir, 2094 int mode); 2095 int ubifs_getattr(struct vfsmount *mnt, struct dentry *dentry, 2096 struct kstat *stat); 2097 2098 /* xattr.c */ 2099 int ubifs_setxattr(struct dentry *dentry, const char *name, 2100 const void *value, size_t size, int flags); 2101 ssize_t ubifs_getxattr(struct dentry *dentry, const char *name, void *buf, 2102 size_t size); 2103 ssize_t ubifs_listxattr(struct dentry *dentry, char *buffer, size_t size); 2104 int ubifs_removexattr(struct dentry *dentry, const char *name); 2105 2106 /* super.c */ 2107 struct inode *ubifs_iget(struct super_block *sb, unsigned long inum); 2108 int ubifs_iput(struct inode *inode); 2109 2110 /* recovery.c */ 2111 int ubifs_recover_master_node(struct ubifs_info *c); 2112 int ubifs_write_rcvrd_mst_node(struct ubifs_info *c); 2113 struct ubifs_scan_leb *ubifs_recover_leb(struct ubifs_info *c, int lnum, 2114 int offs, void *sbuf, int grouped); 2115 struct ubifs_scan_leb *ubifs_recover_log_leb(struct ubifs_info *c, int lnum, 2116 int offs, void *sbuf); 2117 int ubifs_recover_inl_heads(const struct ubifs_info *c, void *sbuf); 2118 int ubifs_clean_lebs(const struct ubifs_info *c, void *sbuf); 2119 int ubifs_rcvry_gc_commit(struct ubifs_info *c); 2120 int ubifs_recover_size_accum(struct ubifs_info *c, union ubifs_key *key, 2121 int deletion, loff_t new_size); 2122 int ubifs_recover_size(struct ubifs_info *c); 2123 void ubifs_destroy_size_tree(struct ubifs_info *c); 2124 2125 /* ioctl.c */ 2126 long ubifs_ioctl(struct file *file, unsigned int cmd, unsigned long arg); 2127 void ubifs_set_inode_flags(struct inode *inode); 2128 #ifdef CONFIG_COMPAT 2129 long ubifs_compat_ioctl(struct file *file, unsigned int cmd, unsigned long arg); 2130 #endif 2131 2132 /* compressor.c */ 2133 int __init ubifs_compressors_init(void); 2134 void __exit ubifs_compressors_exit(void); 2135 void ubifs_compress(const void *in_buf, int in_len, void *out_buf, int *out_len, 2136 int *compr_type); 2137 int ubifs_decompress(const void *buf, int len, void *out, int *out_len, 2138 int compr_type); 2139 2140 #include "debug.h" 2141 #include "misc.h" 2142 #include "key.h" 2143 2144 /* todo: Move these to a common U-Boot header */ 2145 int lzo1x_decompress_safe(const unsigned char *in, size_t in_len, 2146 unsigned char *out, size_t *out_len); 2147 #endif /* !__UBIFS_H__ */ 2148