1 /* 2 * This file is part of UBIFS. 3 * 4 * Copyright (C) 2006-2008 Nokia Corporation 5 * 6 * This program is free software; you can redistribute it and/or modify it 7 * under the terms of the GNU General Public License version 2 as published by 8 * the Free Software Foundation. 9 * 10 * This program is distributed in the hope that it will be useful, but WITHOUT 11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for 13 * more details. 14 * 15 * You should have received a copy of the GNU General Public License along with 16 * this program; if not, write to the Free Software Foundation, Inc., 51 17 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA 18 * 19 * Authors: Artem Bityutskiy (Битюцкий Артём) 20 * Adrian Hunter 21 */ 22 23 /* Implementation version 0.7 */ 24 25 #ifndef __UBIFS_H__ 26 #define __UBIFS_H__ 27 28 #include <asm/div64.h> 29 #include <linux/statfs.h> 30 #include <linux/fs.h> 31 #include <linux/err.h> 32 #include <linux/sched.h> 33 #include <linux/vmalloc.h> 34 #include <linux/spinlock.h> 35 #include <linux/mutex.h> 36 #include <linux/rwsem.h> 37 #include <linux/mtd/ubi.h> 38 #include <linux/pagemap.h> 39 #include <linux/backing-dev.h> 40 #include "ubifs-media.h" 41 42 /* Version of this UBIFS implementation */ 43 #define UBIFS_VERSION 1 44 45 /* Normal UBIFS messages */ 46 #define ubifs_msg(fmt, ...) \ 47 printk(KERN_NOTICE "UBIFS: " fmt "\n", ##__VA_ARGS__) 48 /* UBIFS error messages */ 49 #define ubifs_err(fmt, ...) \ 50 printk(KERN_ERR "UBIFS error (pid %d): %s: " fmt "\n", current->pid, \ 51 __func__, ##__VA_ARGS__) 52 /* UBIFS warning messages */ 53 #define ubifs_warn(fmt, ...) \ 54 printk(KERN_WARNING "UBIFS warning (pid %d): %s: " fmt "\n", \ 55 current->pid, __func__, ##__VA_ARGS__) 56 57 /* UBIFS file system VFS magic number */ 58 #define UBIFS_SUPER_MAGIC 0x24051905 59 60 /* Number of UBIFS blocks per VFS page */ 61 #define UBIFS_BLOCKS_PER_PAGE (PAGE_CACHE_SIZE / UBIFS_BLOCK_SIZE) 62 #define UBIFS_BLOCKS_PER_PAGE_SHIFT (PAGE_CACHE_SHIFT - UBIFS_BLOCK_SHIFT) 63 64 /* "File system end of life" sequence number watermark */ 65 #define SQNUM_WARN_WATERMARK 0xFFFFFFFF00000000ULL 66 #define SQNUM_WATERMARK 0xFFFFFFFFFF000000ULL 67 68 /* Minimum amount of data UBIFS writes to the flash */ 69 #define MIN_WRITE_SZ (UBIFS_DATA_NODE_SZ + 8) 70 71 /* 72 * Currently we do not support inode number overlapping and re-using, so this 73 * watermark defines dangerous inode number level. This should be fixed later, 74 * although it is difficult to exceed current limit. Another option is to use 75 * 64-bit inode numbers, but this means more overhead. 76 */ 77 #define INUM_WARN_WATERMARK 0xFFF00000 78 #define INUM_WATERMARK 0xFFFFFF00 79 80 /* Largest key size supported in this implementation */ 81 #define CUR_MAX_KEY_LEN UBIFS_SK_LEN 82 83 /* Maximum number of entries in each LPT (LEB category) heap */ 84 #define LPT_HEAP_SZ 256 85 86 /* 87 * Background thread name pattern. The numbers are UBI device and volume 88 * numbers. 89 */ 90 #define BGT_NAME_PATTERN "ubifs_bgt%d_%d" 91 92 /* Default write-buffer synchronization timeout (5 secs) */ 93 #define DEFAULT_WBUF_TIMEOUT (5 * HZ) 94 95 /* Maximum possible inode number (only 32-bit inodes are supported now) */ 96 #define MAX_INUM 0xFFFFFFFF 97 98 /* Number of non-data journal heads */ 99 #define NONDATA_JHEADS_CNT 2 100 101 /* Garbage collector head */ 102 #define GCHD 0 103 /* Base journal head number */ 104 #define BASEHD 1 105 /* First "general purpose" journal head */ 106 #define DATAHD 2 107 108 /* 'No change' value for 'ubifs_change_lp()' */ 109 #define LPROPS_NC 0x80000001 110 111 /* 112 * There is no notion of truncation key because truncation nodes do not exist 113 * in TNC. However, when replaying, it is handy to introduce fake "truncation" 114 * keys for truncation nodes because the code becomes simpler. So we define 115 * %UBIFS_TRUN_KEY type. 116 */ 117 #define UBIFS_TRUN_KEY UBIFS_KEY_TYPES_CNT 118 119 /* 120 * How much a directory entry/extended attribute entry adds to the parent/host 121 * inode. 122 */ 123 #define CALC_DENT_SIZE(name_len) ALIGN(UBIFS_DENT_NODE_SZ + (name_len) + 1, 8) 124 125 /* How much an extended attribute adds to the host inode */ 126 #define CALC_XATTR_BYTES(data_len) ALIGN(UBIFS_INO_NODE_SZ + (data_len) + 1, 8) 127 128 /* 129 * Znodes which were not touched for 'OLD_ZNODE_AGE' seconds are considered 130 * "old", and znode which were touched last 'YOUNG_ZNODE_AGE' seconds ago are 131 * considered "young". This is used by shrinker when selecting znode to trim 132 * off. 133 */ 134 #define OLD_ZNODE_AGE 20 135 #define YOUNG_ZNODE_AGE 5 136 137 /* 138 * Some compressors, like LZO, may end up with more data then the input buffer. 139 * So UBIFS always allocates larger output buffer, to be sure the compressor 140 * will not corrupt memory in case of worst case compression. 141 */ 142 #define WORST_COMPR_FACTOR 2 143 144 /* Maximum expected tree height for use by bottom_up_buf */ 145 #define BOTTOM_UP_HEIGHT 64 146 147 /* 148 * Lockdep classes for UBIFS inode @ui_mutex. 149 */ 150 enum { 151 WB_MUTEX_1 = 0, 152 WB_MUTEX_2 = 1, 153 WB_MUTEX_3 = 2, 154 }; 155 156 /* 157 * Znode flags (actually, bit numbers which store the flags). 158 * 159 * DIRTY_ZNODE: znode is dirty 160 * COW_ZNODE: znode is being committed and a new instance of this znode has to 161 * be created before changing this znode 162 * OBSOLETE_ZNODE: znode is obsolete, which means it was deleted, but it is 163 * still in the commit list and the ongoing commit operation 164 * will commit it, and delete this znode after it is done 165 */ 166 enum { 167 DIRTY_ZNODE = 0, 168 COW_ZNODE = 1, 169 OBSOLETE_ZNODE = 2, 170 }; 171 172 /* 173 * Commit states. 174 * 175 * COMMIT_RESTING: commit is not wanted 176 * COMMIT_BACKGROUND: background commit has been requested 177 * COMMIT_REQUIRED: commit is required 178 * COMMIT_RUNNING_BACKGROUND: background commit is running 179 * COMMIT_RUNNING_REQUIRED: commit is running and it is required 180 * COMMIT_BROKEN: commit failed 181 */ 182 enum { 183 COMMIT_RESTING = 0, 184 COMMIT_BACKGROUND, 185 COMMIT_REQUIRED, 186 COMMIT_RUNNING_BACKGROUND, 187 COMMIT_RUNNING_REQUIRED, 188 COMMIT_BROKEN, 189 }; 190 191 /* 192 * 'ubifs_scan_a_node()' return values. 193 * 194 * SCANNED_GARBAGE: scanned garbage 195 * SCANNED_EMPTY_SPACE: scanned empty space 196 * SCANNED_A_NODE: scanned a valid node 197 * SCANNED_A_CORRUPT_NODE: scanned a corrupted node 198 * SCANNED_A_BAD_PAD_NODE: scanned a padding node with invalid pad length 199 * 200 * Greater than zero means: 'scanned that number of padding bytes' 201 */ 202 enum { 203 SCANNED_GARBAGE = 0, 204 SCANNED_EMPTY_SPACE = -1, 205 SCANNED_A_NODE = -2, 206 SCANNED_A_CORRUPT_NODE = -3, 207 SCANNED_A_BAD_PAD_NODE = -4, 208 }; 209 210 /* 211 * LPT cnode flag bits. 212 * 213 * DIRTY_CNODE: cnode is dirty 214 * COW_CNODE: cnode is being committed and must be copied before writing 215 * OBSOLETE_CNODE: cnode is being committed and has been copied (or deleted), 216 * so it can (and must) be freed when the commit is finished 217 */ 218 enum { 219 DIRTY_CNODE = 0, 220 COW_CNODE = 1, 221 OBSOLETE_CNODE = 2, 222 }; 223 224 /* 225 * Dirty flag bits (lpt_drty_flgs) for LPT special nodes. 226 * 227 * LTAB_DIRTY: ltab node is dirty 228 * LSAVE_DIRTY: lsave node is dirty 229 */ 230 enum { 231 LTAB_DIRTY = 1, 232 LSAVE_DIRTY = 2, 233 }; 234 235 /* 236 * Return codes used by the garbage collector. 237 * @LEB_FREED: the logical eraseblock was freed and is ready to use 238 * @LEB_FREED_IDX: indexing LEB was freed and can be used only after the commit 239 * @LEB_RETAINED: the logical eraseblock was freed and retained for GC purposes 240 */ 241 enum { 242 LEB_FREED, 243 LEB_FREED_IDX, 244 LEB_RETAINED, 245 }; 246 247 /** 248 * struct ubifs_old_idx - index node obsoleted since last commit start. 249 * @rb: rb-tree node 250 * @lnum: LEB number of obsoleted index node 251 * @offs: offset of obsoleted index node 252 */ 253 struct ubifs_old_idx { 254 struct rb_node rb; 255 int lnum; 256 int offs; 257 }; 258 259 /* The below union makes it easier to deal with keys */ 260 union ubifs_key { 261 uint8_t u8[CUR_MAX_KEY_LEN]; 262 uint32_t u32[CUR_MAX_KEY_LEN/4]; 263 uint64_t u64[CUR_MAX_KEY_LEN/8]; 264 __le32 j32[CUR_MAX_KEY_LEN/4]; 265 }; 266 267 /** 268 * struct ubifs_scan_node - UBIFS scanned node information. 269 * @list: list of scanned nodes 270 * @key: key of node scanned (if it has one) 271 * @sqnum: sequence number 272 * @type: type of node scanned 273 * @offs: offset with LEB of node scanned 274 * @len: length of node scanned 275 * @node: raw node 276 */ 277 struct ubifs_scan_node { 278 struct list_head list; 279 union ubifs_key key; 280 unsigned long long sqnum; 281 int type; 282 int offs; 283 int len; 284 void *node; 285 }; 286 287 /** 288 * struct ubifs_scan_leb - UBIFS scanned LEB information. 289 * @lnum: logical eraseblock number 290 * @nodes_cnt: number of nodes scanned 291 * @nodes: list of struct ubifs_scan_node 292 * @endpt: end point (and therefore the start of empty space) 293 * @ecc: read returned -EBADMSG 294 * @buf: buffer containing entire LEB scanned 295 */ 296 struct ubifs_scan_leb { 297 int lnum; 298 int nodes_cnt; 299 struct list_head nodes; 300 int endpt; 301 int ecc; 302 void *buf; 303 }; 304 305 /** 306 * struct ubifs_gced_idx_leb - garbage-collected indexing LEB. 307 * @list: list 308 * @lnum: LEB number 309 * @unmap: OK to unmap this LEB 310 * 311 * This data structure is used to temporary store garbage-collected indexing 312 * LEBs - they are not released immediately, but only after the next commit. 313 * This is needed to guarantee recoverability. 314 */ 315 struct ubifs_gced_idx_leb { 316 struct list_head list; 317 int lnum; 318 int unmap; 319 }; 320 321 /** 322 * struct ubifs_inode - UBIFS in-memory inode description. 323 * @vfs_inode: VFS inode description object 324 * @creat_sqnum: sequence number at time of creation 325 * @xattr_size: summarized size of all extended attributes in bytes 326 * @xattr_cnt: count of extended attributes this inode has 327 * @xattr_names: sum of lengths of all extended attribute names belonging to 328 * this inode 329 * @dirty: non-zero if the inode is dirty 330 * @xattr: non-zero if this is an extended attribute inode 331 * @ui_mutex: serializes inode write-back with the rest of VFS operations, 332 * serializes "clean <-> dirty" state changes, protects @dirty, 333 * @ui_size, and @xattr_size 334 * @ui_lock: protects @synced_i_size 335 * @synced_i_size: synchronized size of inode, i.e. the value of inode size 336 * currently stored on the flash; used only for regular file 337 * inodes 338 * @ui_size: inode size used by UBIFS when writing to flash 339 * @flags: inode flags (@UBIFS_COMPR_FL, etc) 340 * @compr_type: default compression type used for this inode 341 * @data_len: length of the data attached to the inode 342 * @data: inode's data 343 * 344 * @ui_mutex exists for two main reasons. At first it prevents inodes from 345 * being written back while UBIFS changing them, being in the middle of an VFS 346 * operation. This way UBIFS makes sure the inode fields are consistent. For 347 * example, in 'ubifs_rename()' we change 3 inodes simultaneously, and 348 * write-back must not write any of them before we have finished. 349 * 350 * The second reason is budgeting - UBIFS has to budget all operations. If an 351 * operation is going to mark an inode dirty, it has to allocate budget for 352 * this. It cannot just mark it dirty because there is no guarantee there will 353 * be enough flash space to write the inode back later. This means UBIFS has 354 * to have full control over inode "clean <-> dirty" transitions (and pages 355 * actually). But unfortunately, VFS marks inodes dirty in many places, and it 356 * does not ask the file-system if it is allowed to do so (there is a notifier, 357 * but it is not enough), i.e., there is no mechanism to synchronize with this. 358 * So UBIFS has its own inode dirty flag and its own mutex to serialize 359 * "clean <-> dirty" transitions. 360 * 361 * The @synced_i_size field is used to make sure we never write pages which are 362 * beyond last synchronized inode size. See 'ubifs_writepage()' for more 363 * information. 364 * 365 * The @ui_size is a "shadow" variable for @inode->i_size and UBIFS uses 366 * @ui_size instead of @inode->i_size. The reason for this is that UBIFS cannot 367 * make sure @inode->i_size is always changed under @ui_mutex, because it 368 * cannot call 'vmtruncate()' with @ui_mutex locked, because it would deadlock 369 * with 'ubifs_writepage()' (see file.c). All the other inode fields are 370 * changed under @ui_mutex, so they do not need "shadow" fields. Note, one 371 * could consider to rework locking and base it on "shadow" fields. 372 */ 373 struct ubifs_inode { 374 struct inode vfs_inode; 375 unsigned long long creat_sqnum; 376 unsigned int xattr_size; 377 unsigned int xattr_cnt; 378 unsigned int xattr_names; 379 unsigned int dirty:1; 380 unsigned int xattr:1; 381 struct mutex ui_mutex; 382 spinlock_t ui_lock; 383 loff_t synced_i_size; 384 loff_t ui_size; 385 int flags; 386 int compr_type; 387 int data_len; 388 void *data; 389 }; 390 391 /** 392 * struct ubifs_unclean_leb - records a LEB recovered under read-only mode. 393 * @list: list 394 * @lnum: LEB number of recovered LEB 395 * @endpt: offset where recovery ended 396 * 397 * This structure records a LEB identified during recovery that needs to be 398 * cleaned but was not because UBIFS was mounted read-only. The information 399 * is used to clean the LEB when remounting to read-write mode. 400 */ 401 struct ubifs_unclean_leb { 402 struct list_head list; 403 int lnum; 404 int endpt; 405 }; 406 407 /* 408 * LEB properties flags. 409 * 410 * LPROPS_UNCAT: not categorized 411 * LPROPS_DIRTY: dirty > 0, not index 412 * LPROPS_DIRTY_IDX: dirty + free > UBIFS_CH_SZ and index 413 * LPROPS_FREE: free > 0, not empty, not index 414 * LPROPS_HEAP_CNT: number of heaps used for storing categorized LEBs 415 * LPROPS_EMPTY: LEB is empty, not taken 416 * LPROPS_FREEABLE: free + dirty == leb_size, not index, not taken 417 * LPROPS_FRDI_IDX: free + dirty == leb_size and index, may be taken 418 * LPROPS_CAT_MASK: mask for the LEB categories above 419 * LPROPS_TAKEN: LEB was taken (this flag is not saved on the media) 420 * LPROPS_INDEX: LEB contains indexing nodes (this flag also exists on flash) 421 */ 422 enum { 423 LPROPS_UNCAT = 0, 424 LPROPS_DIRTY = 1, 425 LPROPS_DIRTY_IDX = 2, 426 LPROPS_FREE = 3, 427 LPROPS_HEAP_CNT = 3, 428 LPROPS_EMPTY = 4, 429 LPROPS_FREEABLE = 5, 430 LPROPS_FRDI_IDX = 6, 431 LPROPS_CAT_MASK = 15, 432 LPROPS_TAKEN = 16, 433 LPROPS_INDEX = 32, 434 }; 435 436 /** 437 * struct ubifs_lprops - logical eraseblock properties. 438 * @free: amount of free space in bytes 439 * @dirty: amount of dirty space in bytes 440 * @flags: LEB properties flags (see above) 441 * @lnum: LEB number 442 * @list: list of same-category lprops (for LPROPS_EMPTY and LPROPS_FREEABLE) 443 * @hpos: heap position in heap of same-category lprops (other categories) 444 */ 445 struct ubifs_lprops { 446 int free; 447 int dirty; 448 int flags; 449 int lnum; 450 union { 451 struct list_head list; 452 int hpos; 453 }; 454 }; 455 456 /** 457 * struct ubifs_lpt_lprops - LPT logical eraseblock properties. 458 * @free: amount of free space in bytes 459 * @dirty: amount of dirty space in bytes 460 * @tgc: trivial GC flag (1 => unmap after commit end) 461 * @cmt: commit flag (1 => reserved for commit) 462 */ 463 struct ubifs_lpt_lprops { 464 int free; 465 int dirty; 466 unsigned tgc : 1; 467 unsigned cmt : 1; 468 }; 469 470 /** 471 * struct ubifs_lp_stats - statistics of eraseblocks in the main area. 472 * @empty_lebs: number of empty LEBs 473 * @taken_empty_lebs: number of taken LEBs 474 * @idx_lebs: number of indexing LEBs 475 * @total_free: total free space in bytes 476 * @total_dirty: total dirty space in bytes 477 * @total_used: total used space in bytes (includes only data LEBs) 478 * @total_dead: total dead space in bytes (includes only data LEBs) 479 * @total_dark: total dark space in bytes (includes only data LEBs) 480 * 481 * N.B. total_dirty and total_used are different to other total_* fields, 482 * because they account _all_ LEBs, not just data LEBs. 483 * 484 * 'taken_empty_lebs' counts the LEBs that are in the transient state of having 485 * been 'taken' for use but not yet written to. 'taken_empty_lebs' is needed 486 * to account correctly for gc_lnum, otherwise 'empty_lebs' could be used 487 * by itself (in which case 'unused_lebs' would be a better name). In the case 488 * of gc_lnum, it is 'taken' at mount time or whenever a LEB is retained by GC, 489 * but unlike other empty LEBs that are 'taken', it may not be written straight 490 * away (i.e. before the next commit start or unmount), so either gc_lnum must 491 * be specially accounted for, or the current approach followed i.e. count it 492 * under 'taken_empty_lebs'. 493 */ 494 struct ubifs_lp_stats { 495 int empty_lebs; 496 int taken_empty_lebs; 497 int idx_lebs; 498 long long total_free; 499 long long total_dirty; 500 long long total_used; 501 long long total_dead; 502 long long total_dark; 503 }; 504 505 struct ubifs_nnode; 506 507 /** 508 * struct ubifs_cnode - LEB Properties Tree common node. 509 * @parent: parent nnode 510 * @cnext: next cnode to commit 511 * @flags: flags (%DIRTY_LPT_NODE or %OBSOLETE_LPT_NODE) 512 * @iip: index in parent 513 * @level: level in the tree (zero for pnodes, greater than zero for nnodes) 514 * @num: node number 515 */ 516 struct ubifs_cnode { 517 struct ubifs_nnode *parent; 518 struct ubifs_cnode *cnext; 519 unsigned long flags; 520 int iip; 521 int level; 522 int num; 523 }; 524 525 /** 526 * struct ubifs_pnode - LEB Properties Tree leaf node. 527 * @parent: parent nnode 528 * @cnext: next cnode to commit 529 * @flags: flags (%DIRTY_LPT_NODE or %OBSOLETE_LPT_NODE) 530 * @iip: index in parent 531 * @level: level in the tree (always zero for pnodes) 532 * @num: node number 533 * @lprops: LEB properties array 534 */ 535 struct ubifs_pnode { 536 struct ubifs_nnode *parent; 537 struct ubifs_cnode *cnext; 538 unsigned long flags; 539 int iip; 540 int level; 541 int num; 542 struct ubifs_lprops lprops[UBIFS_LPT_FANOUT]; 543 }; 544 545 /** 546 * struct ubifs_nbranch - LEB Properties Tree internal node branch. 547 * @lnum: LEB number of child 548 * @offs: offset of child 549 * @nnode: nnode child 550 * @pnode: pnode child 551 * @cnode: cnode child 552 */ 553 struct ubifs_nbranch { 554 int lnum; 555 int offs; 556 union { 557 struct ubifs_nnode *nnode; 558 struct ubifs_pnode *pnode; 559 struct ubifs_cnode *cnode; 560 }; 561 }; 562 563 /** 564 * struct ubifs_nnode - LEB Properties Tree internal node. 565 * @parent: parent nnode 566 * @cnext: next cnode to commit 567 * @flags: flags (%DIRTY_LPT_NODE or %OBSOLETE_LPT_NODE) 568 * @iip: index in parent 569 * @level: level in the tree (always greater than zero for nnodes) 570 * @num: node number 571 * @nbranch: branches to child nodes 572 */ 573 struct ubifs_nnode { 574 struct ubifs_nnode *parent; 575 struct ubifs_cnode *cnext; 576 unsigned long flags; 577 int iip; 578 int level; 579 int num; 580 struct ubifs_nbranch nbranch[UBIFS_LPT_FANOUT]; 581 }; 582 583 /** 584 * struct ubifs_lpt_heap - heap of categorized lprops. 585 * @arr: heap array 586 * @cnt: number in heap 587 * @max_cnt: maximum number allowed in heap 588 * 589 * There are %LPROPS_HEAP_CNT heaps. 590 */ 591 struct ubifs_lpt_heap { 592 struct ubifs_lprops **arr; 593 int cnt; 594 int max_cnt; 595 }; 596 597 /* 598 * Return codes for LPT scan callback function. 599 * 600 * LPT_SCAN_CONTINUE: continue scanning 601 * LPT_SCAN_ADD: add the LEB properties scanned to the tree in memory 602 * LPT_SCAN_STOP: stop scanning 603 */ 604 enum { 605 LPT_SCAN_CONTINUE = 0, 606 LPT_SCAN_ADD = 1, 607 LPT_SCAN_STOP = 2, 608 }; 609 610 struct ubifs_info; 611 612 /* Callback used by the 'ubifs_lpt_scan_nolock()' function */ 613 typedef int (*ubifs_lpt_scan_callback)(struct ubifs_info *c, 614 const struct ubifs_lprops *lprops, 615 int in_tree, void *data); 616 617 /** 618 * struct ubifs_wbuf - UBIFS write-buffer. 619 * @c: UBIFS file-system description object 620 * @buf: write-buffer (of min. flash I/O unit size) 621 * @lnum: logical eraseblock number the write-buffer points to 622 * @offs: write-buffer offset in this logical eraseblock 623 * @avail: number of bytes available in the write-buffer 624 * @used: number of used bytes in the write-buffer 625 * @dtype: type of data stored in this LEB (%UBI_LONGTERM, %UBI_SHORTTERM, 626 * %UBI_UNKNOWN) 627 * @jhead: journal head the mutex belongs to (note, needed only to shut lockdep 628 * up by 'mutex_lock_nested()). 629 * @sync_callback: write-buffer synchronization callback 630 * @io_mutex: serializes write-buffer I/O 631 * @lock: serializes @buf, @lnum, @offs, @avail, @used, @next_ino and @inodes 632 * fields 633 * @timer: write-buffer timer 634 * @timeout: timer expire interval in jiffies 635 * @need_sync: it is set if its timer expired and needs sync 636 * @next_ino: points to the next position of the following inode number 637 * @inodes: stores the inode numbers of the nodes which are in wbuf 638 * 639 * The write-buffer synchronization callback is called when the write-buffer is 640 * synchronized in order to notify how much space was wasted due to 641 * write-buffer padding and how much free space is left in the LEB. 642 * 643 * Note: the fields @buf, @lnum, @offs, @avail and @used can be read under 644 * spin-lock or mutex because they are written under both mutex and spin-lock. 645 * @buf is appended to under mutex but overwritten under both mutex and 646 * spin-lock. Thus the data between @buf and @buf + @used can be read under 647 * spinlock. 648 */ 649 struct ubifs_wbuf { 650 struct ubifs_info *c; 651 void *buf; 652 int lnum; 653 int offs; 654 int avail; 655 int used; 656 int dtype; 657 int jhead; 658 int (*sync_callback)(struct ubifs_info *c, int lnum, int free, int pad); 659 struct mutex io_mutex; 660 spinlock_t lock; 661 struct timer_list timer; 662 int timeout; 663 int need_sync; 664 int next_ino; 665 ino_t *inodes; 666 }; 667 668 /** 669 * struct ubifs_bud - bud logical eraseblock. 670 * @lnum: logical eraseblock number 671 * @start: where the (uncommitted) bud data starts 672 * @jhead: journal head number this bud belongs to 673 * @list: link in the list buds belonging to the same journal head 674 * @rb: link in the tree of all buds 675 */ 676 struct ubifs_bud { 677 int lnum; 678 int start; 679 int jhead; 680 struct list_head list; 681 struct rb_node rb; 682 }; 683 684 /** 685 * struct ubifs_jhead - journal head. 686 * @wbuf: head's write-buffer 687 * @buds_list: list of bud LEBs belonging to this journal head 688 * 689 * Note, the @buds list is protected by the @c->buds_lock. 690 */ 691 struct ubifs_jhead { 692 struct ubifs_wbuf wbuf; 693 struct list_head buds_list; 694 }; 695 696 /** 697 * struct ubifs_zbranch - key/coordinate/length branch stored in znodes. 698 * @key: key 699 * @znode: znode address in memory 700 * @lnum: LEB number of the indexing node 701 * @offs: offset of the indexing node within @lnum 702 * @len: target node length 703 */ 704 struct ubifs_zbranch { 705 union ubifs_key key; 706 union { 707 struct ubifs_znode *znode; 708 void *leaf; 709 }; 710 int lnum; 711 int offs; 712 int len; 713 }; 714 715 /** 716 * struct ubifs_znode - in-memory representation of an indexing node. 717 * @parent: parent znode or NULL if it is the root 718 * @cnext: next znode to commit 719 * @flags: znode flags (%DIRTY_ZNODE, %COW_ZNODE or %OBSOLETE_ZNODE) 720 * @time: last access time (seconds) 721 * @level: level of the entry in the TNC tree 722 * @child_cnt: count of child znodes 723 * @iip: index in parent's zbranch array 724 * @alt: lower bound of key range has altered i.e. child inserted at slot 0 725 * @lnum: LEB number of the corresponding indexing node 726 * @offs: offset of the corresponding indexing node 727 * @len: length of the corresponding indexing node 728 * @zbranch: array of znode branches (@c->fanout elements) 729 */ 730 struct ubifs_znode { 731 struct ubifs_znode *parent; 732 struct ubifs_znode *cnext; 733 unsigned long flags; 734 unsigned long time; 735 int level; 736 int child_cnt; 737 int iip; 738 int alt; 739 #ifdef CONFIG_UBIFS_FS_DEBUG 740 int lnum, offs, len; 741 #endif 742 struct ubifs_zbranch zbranch[]; 743 }; 744 745 /** 746 * struct ubifs_node_range - node length range description data structure. 747 * @len: fixed node length 748 * @min_len: minimum possible node length 749 * @max_len: maximum possible node length 750 * 751 * If @max_len is %0, the node has fixed length @len. 752 */ 753 struct ubifs_node_range { 754 union { 755 int len; 756 int min_len; 757 }; 758 int max_len; 759 }; 760 761 /** 762 * struct ubifs_compressor - UBIFS compressor description structure. 763 * @compr_type: compressor type (%UBIFS_COMPR_LZO, etc) 764 * @cc: cryptoapi compressor handle 765 * @comp_mutex: mutex used during compression 766 * @decomp_mutex: mutex used during decompression 767 * @name: compressor name 768 * @capi_name: cryptoapi compressor name 769 */ 770 struct ubifs_compressor { 771 int compr_type; 772 struct crypto_comp *cc; 773 struct mutex *comp_mutex; 774 struct mutex *decomp_mutex; 775 const char *name; 776 const char *capi_name; 777 }; 778 779 /** 780 * struct ubifs_budget_req - budget requirements of an operation. 781 * 782 * @fast: non-zero if the budgeting should try to aquire budget quickly and 783 * should not try to call write-back 784 * @recalculate: non-zero if @idx_growth, @data_growth, and @dd_growth fields 785 * have to be re-calculated 786 * @new_page: non-zero if the operation adds a new page 787 * @dirtied_page: non-zero if the operation makes a page dirty 788 * @new_dent: non-zero if the operation adds a new directory entry 789 * @mod_dent: non-zero if the operation removes or modifies an existing 790 * directory entry 791 * @new_ino: non-zero if the operation adds a new inode 792 * @new_ino_d: now much data newly created inode contains 793 * @dirtied_ino: how many inodes the operation makes dirty 794 * @dirtied_ino_d: now much data dirtied inode contains 795 * @idx_growth: how much the index will supposedly grow 796 * @data_growth: how much new data the operation will supposedly add 797 * @dd_growth: how much data that makes other data dirty the operation will 798 * supposedly add 799 * 800 * @idx_growth, @data_growth and @dd_growth are not used in budget request. The 801 * budgeting subsystem caches index and data growth values there to avoid 802 * re-calculating them when the budget is released. However, if @idx_growth is 803 * %-1, it is calculated by the release function using other fields. 804 * 805 * An inode may contain 4KiB of data at max., thus the widths of @new_ino_d 806 * is 13 bits, and @dirtied_ino_d - 15, because up to 4 inodes may be made 807 * dirty by the re-name operation. 808 */ 809 struct ubifs_budget_req { 810 unsigned int fast:1; 811 unsigned int recalculate:1; 812 unsigned int new_page:1; 813 unsigned int dirtied_page:1; 814 unsigned int new_dent:1; 815 unsigned int mod_dent:1; 816 unsigned int new_ino:1; 817 unsigned int new_ino_d:13; 818 #ifndef UBIFS_DEBUG 819 unsigned int dirtied_ino:4; 820 unsigned int dirtied_ino_d:15; 821 #else 822 /* Not bit-fields to check for overflows */ 823 unsigned int dirtied_ino; 824 unsigned int dirtied_ino_d; 825 #endif 826 int idx_growth; 827 int data_growth; 828 int dd_growth; 829 }; 830 831 /** 832 * struct ubifs_orphan - stores the inode number of an orphan. 833 * @rb: rb-tree node of rb-tree of orphans sorted by inode number 834 * @list: list head of list of orphans in order added 835 * @new_list: list head of list of orphans added since the last commit 836 * @cnext: next orphan to commit 837 * @dnext: next orphan to delete 838 * @inum: inode number 839 * @new: %1 => added since the last commit, otherwise %0 840 */ 841 struct ubifs_orphan { 842 struct rb_node rb; 843 struct list_head list; 844 struct list_head new_list; 845 struct ubifs_orphan *cnext; 846 struct ubifs_orphan *dnext; 847 ino_t inum; 848 int new; 849 }; 850 851 /** 852 * struct ubifs_mount_opts - UBIFS-specific mount options information. 853 * @unmount_mode: selected unmount mode (%0 default, %1 normal, %2 fast) 854 */ 855 struct ubifs_mount_opts { 856 unsigned int unmount_mode:2; 857 }; 858 859 /** 860 * struct ubifs_info - UBIFS file-system description data structure 861 * (per-superblock). 862 * @vfs_sb: VFS @struct super_block object 863 * @bdi: backing device info object to make VFS happy and disable readahead 864 * 865 * @highest_inum: highest used inode number 866 * @vfs_gen: VFS inode generation counter 867 * @max_sqnum: current global sequence number 868 * @cmt_no: commit number (last successfully completed commit) 869 * @cnt_lock: protects @highest_inum, @vfs_gen, and @max_sqnum counters 870 * @fmt_version: UBIFS on-flash format version 871 * @uuid: UUID from super block 872 * 873 * @lhead_lnum: log head logical eraseblock number 874 * @lhead_offs: log head offset 875 * @ltail_lnum: log tail logical eraseblock number (offset is always 0) 876 * @log_mutex: protects the log, @lhead_lnum, @lhead_offs, @ltail_lnum, and 877 * @bud_bytes 878 * @min_log_bytes: minimum required number of bytes in the log 879 * @cmt_bud_bytes: used during commit to temporarily amount of bytes in 880 * committed buds 881 * 882 * @buds: tree of all buds indexed by bud LEB number 883 * @bud_bytes: how many bytes of flash is used by buds 884 * @buds_lock: protects the @buds tree, @bud_bytes, and per-journal head bud 885 * lists 886 * @jhead_cnt: count of journal heads 887 * @jheads: journal heads (head zero is base head) 888 * @max_bud_bytes: maximum number of bytes allowed in buds 889 * @bg_bud_bytes: number of bud bytes when background commit is initiated 890 * @old_buds: buds to be released after commit ends 891 * @max_bud_cnt: maximum number of buds 892 * 893 * @commit_sem: synchronizes committer with other processes 894 * @cmt_state: commit state 895 * @cs_lock: commit state lock 896 * @cmt_wq: wait queue to sleep on if the log is full and a commit is running 897 * @fast_unmount: do not run journal commit before un-mounting 898 * @big_lpt: flag that LPT is too big to write whole during commit 899 * @check_lpt_free: flag that indicates LPT GC may be needed 900 * @nospace: non-zero if the file-system does not have flash space (used as 901 * optimization) 902 * @nospace_rp: the same as @nospace, but additionally means that even reserved 903 * pool is full 904 * 905 * @tnc_mutex: protects the Tree Node Cache (TNC), @zroot, @cnext, @enext, and 906 * @calc_idx_sz 907 * @zroot: zbranch which points to the root index node and znode 908 * @cnext: next znode to commit 909 * @enext: next znode to commit to empty space 910 * @gap_lebs: array of LEBs used by the in-gaps commit method 911 * @cbuf: commit buffer 912 * @ileb_buf: buffer for commit in-the-gaps method 913 * @ileb_len: length of data in ileb_buf 914 * @ihead_lnum: LEB number of index head 915 * @ihead_offs: offset of index head 916 * @ilebs: pre-allocated index LEBs 917 * @ileb_cnt: number of pre-allocated index LEBs 918 * @ileb_nxt: next pre-allocated index LEBs 919 * @old_idx: tree of index nodes obsoleted since the last commit start 920 * @bottom_up_buf: a buffer which is used by 'dirty_cow_bottom_up()' in tnc.c 921 * @new_ihead_lnum: used by debugging to check ihead_lnum 922 * @new_ihead_offs: used by debugging to check ihead_offs 923 * 924 * @mst_node: master node 925 * @mst_offs: offset of valid master node 926 * @mst_mutex: protects the master node area, @mst_node, and @mst_offs 927 * 928 * @log_lebs: number of logical eraseblocks in the log 929 * @log_bytes: log size in bytes 930 * @log_last: last LEB of the log 931 * @lpt_lebs: number of LEBs used for lprops table 932 * @lpt_first: first LEB of the lprops table area 933 * @lpt_last: last LEB of the lprops table area 934 * @orph_lebs: number of LEBs used for the orphan area 935 * @orph_first: first LEB of the orphan area 936 * @orph_last: last LEB of the orphan area 937 * @main_lebs: count of LEBs in the main area 938 * @main_first: first LEB of the main area 939 * @main_bytes: main area size in bytes 940 * @default_compr: default compression algorithm (%UBIFS_COMPR_LZO, etc) 941 * 942 * @key_hash_type: type of the key hash 943 * @key_hash: direntry key hash function 944 * @key_fmt: key format 945 * @key_len: key length 946 * @fanout: fanout of the index tree (number of links per indexing node) 947 * 948 * @min_io_size: minimal input/output unit size 949 * @min_io_shift: number of bits in @min_io_size minus one 950 * @leb_size: logical eraseblock size in bytes 951 * @half_leb_size: half LEB size 952 * @leb_cnt: count of logical eraseblocks 953 * @max_leb_cnt: maximum count of logical eraseblocks 954 * @old_leb_cnt: count of logical eraseblocks before re-size 955 * @ro_media: the underlying UBI volume is read-only 956 * 957 * @dirty_pg_cnt: number of dirty pages (not used) 958 * @dirty_zn_cnt: number of dirty znodes 959 * @clean_zn_cnt: number of clean znodes 960 * 961 * @budg_idx_growth: amount of bytes budgeted for index growth 962 * @budg_data_growth: amount of bytes budgeted for cached data 963 * @budg_dd_growth: amount of bytes budgeted for cached data that will make 964 * other data dirty 965 * @budg_uncommitted_idx: amount of bytes were budgeted for growth of the index, 966 * but which still have to be taken into account because 967 * the index has not been committed so far 968 * @space_lock: protects @budg_idx_growth, @budg_data_growth, @budg_dd_growth, 969 * @budg_uncommited_idx, @min_idx_lebs, @old_idx_sz, and @lst; 970 * @min_idx_lebs: minimum number of LEBs required for the index 971 * @old_idx_sz: size of index on flash 972 * @calc_idx_sz: temporary variable which is used to calculate new index size 973 * (contains accurate new index size at end of TNC commit start) 974 * @lst: lprops statistics 975 * 976 * @page_budget: budget for a page 977 * @inode_budget: budget for an inode 978 * @dent_budget: budget for a directory entry 979 * 980 * @ref_node_alsz: size of the LEB reference node aligned to the min. flash 981 * I/O unit 982 * @mst_node_alsz: master node aligned size 983 * @min_idx_node_sz: minimum indexing node aligned on 8-bytes boundary 984 * @max_idx_node_sz: maximum indexing node aligned on 8-bytes boundary 985 * @max_inode_sz: maximum possible inode size in bytes 986 * @max_znode_sz: size of znode in bytes 987 * @dead_wm: LEB dead space watermark 988 * @dark_wm: LEB dark space watermark 989 * @block_cnt: count of 4KiB blocks on the FS 990 * 991 * @ranges: UBIFS node length ranges 992 * @ubi: UBI volume descriptor 993 * @di: UBI device information 994 * @vi: UBI volume information 995 * 996 * @orph_tree: rb-tree of orphan inode numbers 997 * @orph_list: list of orphan inode numbers in order added 998 * @orph_new: list of orphan inode numbers added since last commit 999 * @orph_cnext: next orphan to commit 1000 * @orph_dnext: next orphan to delete 1001 * @orphan_lock: lock for orph_tree and orph_new 1002 * @orph_buf: buffer for orphan nodes 1003 * @new_orphans: number of orphans since last commit 1004 * @cmt_orphans: number of orphans being committed 1005 * @tot_orphans: number of orphans in the rb_tree 1006 * @max_orphans: maximum number of orphans allowed 1007 * @ohead_lnum: orphan head LEB number 1008 * @ohead_offs: orphan head offset 1009 * @no_orphs: non-zero if there are no orphans 1010 * 1011 * @bgt: UBIFS background thread 1012 * @bgt_name: background thread name 1013 * @need_bgt: if background thread should run 1014 * @need_wbuf_sync: if write-buffers have to be synchronized 1015 * 1016 * @gc_lnum: LEB number used for garbage collection 1017 * @sbuf: a buffer of LEB size used by GC and replay for scanning 1018 * @idx_gc: list of index LEBs that have been garbage collected 1019 * @idx_gc_cnt: number of elements on the idx_gc list 1020 * 1021 * @infos_list: links all 'ubifs_info' objects 1022 * @umount_mutex: serializes shrinker and un-mount 1023 * @shrinker_run_no: shrinker run number 1024 * 1025 * @space_bits: number of bits needed to record free or dirty space 1026 * @lpt_lnum_bits: number of bits needed to record a LEB number in the LPT 1027 * @lpt_offs_bits: number of bits needed to record an offset in the LPT 1028 * @lpt_spc_bits: number of bits needed to space in the LPT 1029 * @pcnt_bits: number of bits needed to record pnode or nnode number 1030 * @lnum_bits: number of bits needed to record LEB number 1031 * @nnode_sz: size of on-flash nnode 1032 * @pnode_sz: size of on-flash pnode 1033 * @ltab_sz: size of on-flash LPT lprops table 1034 * @lsave_sz: size of on-flash LPT save table 1035 * @pnode_cnt: number of pnodes 1036 * @nnode_cnt: number of nnodes 1037 * @lpt_hght: height of the LPT 1038 * @pnodes_have: number of pnodes in memory 1039 * 1040 * @lp_mutex: protects lprops table and all the other lprops-related fields 1041 * @lpt_lnum: LEB number of the root nnode of the LPT 1042 * @lpt_offs: offset of the root nnode of the LPT 1043 * @nhead_lnum: LEB number of LPT head 1044 * @nhead_offs: offset of LPT head 1045 * @lpt_drty_flgs: dirty flags for LPT special nodes e.g. ltab 1046 * @dirty_nn_cnt: number of dirty nnodes 1047 * @dirty_pn_cnt: number of dirty pnodes 1048 * @lpt_sz: LPT size 1049 * @lpt_nod_buf: buffer for an on-flash nnode or pnode 1050 * @lpt_buf: buffer of LEB size used by LPT 1051 * @nroot: address in memory of the root nnode of the LPT 1052 * @lpt_cnext: next LPT node to commit 1053 * @lpt_heap: array of heaps of categorized lprops 1054 * @dirty_idx: a (reverse sorted) copy of the LPROPS_DIRTY_IDX heap as at 1055 * previous commit start 1056 * @uncat_list: list of un-categorized LEBs 1057 * @empty_list: list of empty LEBs 1058 * @freeable_list: list of freeable non-index LEBs (free + dirty == leb_size) 1059 * @frdi_idx_list: list of freeable index LEBs (free + dirty == leb_size) 1060 * @freeable_cnt: number of freeable LEBs in @freeable_list 1061 * 1062 * @ltab_lnum: LEB number of LPT's own lprops table 1063 * @ltab_offs: offset of LPT's own lprops table 1064 * @ltab: LPT's own lprops table 1065 * @ltab_cmt: LPT's own lprops table (commit copy) 1066 * @lsave_cnt: number of LEB numbers in LPT's save table 1067 * @lsave_lnum: LEB number of LPT's save table 1068 * @lsave_offs: offset of LPT's save table 1069 * @lsave: LPT's save table 1070 * @lscan_lnum: LEB number of last LPT scan 1071 * 1072 * @rp_size: size of the reserved pool in bytes 1073 * @report_rp_size: size of the reserved pool reported to user-space 1074 * @rp_uid: reserved pool user ID 1075 * @rp_gid: reserved pool group ID 1076 * 1077 * @empty: if the UBI device is empty 1078 * @replay_tree: temporary tree used during journal replay 1079 * @replay_list: temporary list used during journal replay 1080 * @replay_buds: list of buds to replay 1081 * @cs_sqnum: sequence number of first node in the log (commit start node) 1082 * @replay_sqnum: sequence number of node currently being replayed 1083 * @need_recovery: file-system needs recovery 1084 * @replaying: set to %1 during journal replay 1085 * @unclean_leb_list: LEBs to recover when mounting ro to rw 1086 * @rcvrd_mst_node: recovered master node to write when mounting ro to rw 1087 * @size_tree: inode size information for recovery 1088 * @remounting_rw: set while remounting from ro to rw (sb flags have MS_RDONLY) 1089 * @mount_opts: UBIFS-specific mount options 1090 * 1091 * @dbg_buf: a buffer of LEB size used for debugging purposes 1092 * @old_zroot: old index root - used by 'dbg_check_old_index()' 1093 * @old_zroot_level: old index root level - used by 'dbg_check_old_index()' 1094 * @old_zroot_sqnum: old index root sqnum - used by 'dbg_check_old_index()' 1095 * @failure_mode: failure mode for recovery testing 1096 * @fail_delay: 0=>don't delay, 1=>delay a time, 2=>delay a number of calls 1097 * @fail_timeout: time in jiffies when delay of failure mode expires 1098 * @fail_cnt: current number of calls to failure mode I/O functions 1099 * @fail_cnt_max: number of calls by which to delay failure mode 1100 */ 1101 struct ubifs_info { 1102 struct super_block *vfs_sb; 1103 struct backing_dev_info bdi; 1104 1105 ino_t highest_inum; 1106 unsigned int vfs_gen; 1107 unsigned long long max_sqnum; 1108 unsigned long long cmt_no; 1109 spinlock_t cnt_lock; 1110 int fmt_version; 1111 unsigned char uuid[16]; 1112 1113 int lhead_lnum; 1114 int lhead_offs; 1115 int ltail_lnum; 1116 struct mutex log_mutex; 1117 int min_log_bytes; 1118 long long cmt_bud_bytes; 1119 1120 struct rb_root buds; 1121 long long bud_bytes; 1122 spinlock_t buds_lock; 1123 int jhead_cnt; 1124 struct ubifs_jhead *jheads; 1125 long long max_bud_bytes; 1126 long long bg_bud_bytes; 1127 struct list_head old_buds; 1128 int max_bud_cnt; 1129 1130 struct rw_semaphore commit_sem; 1131 int cmt_state; 1132 spinlock_t cs_lock; 1133 wait_queue_head_t cmt_wq; 1134 unsigned int fast_unmount:1; 1135 unsigned int big_lpt:1; 1136 unsigned int check_lpt_free:1; 1137 unsigned int nospace:1; 1138 unsigned int nospace_rp:1; 1139 1140 struct mutex tnc_mutex; 1141 struct ubifs_zbranch zroot; 1142 struct ubifs_znode *cnext; 1143 struct ubifs_znode *enext; 1144 int *gap_lebs; 1145 void *cbuf; 1146 void *ileb_buf; 1147 int ileb_len; 1148 int ihead_lnum; 1149 int ihead_offs; 1150 int *ilebs; 1151 int ileb_cnt; 1152 int ileb_nxt; 1153 struct rb_root old_idx; 1154 int *bottom_up_buf; 1155 #ifdef CONFIG_UBIFS_FS_DEBUG 1156 int new_ihead_lnum; 1157 int new_ihead_offs; 1158 #endif 1159 1160 struct ubifs_mst_node *mst_node; 1161 int mst_offs; 1162 struct mutex mst_mutex; 1163 1164 int log_lebs; 1165 long long log_bytes; 1166 int log_last; 1167 int lpt_lebs; 1168 int lpt_first; 1169 int lpt_last; 1170 int orph_lebs; 1171 int orph_first; 1172 int orph_last; 1173 int main_lebs; 1174 int main_first; 1175 long long main_bytes; 1176 int default_compr; 1177 1178 uint8_t key_hash_type; 1179 uint32_t (*key_hash)(const char *str, int len); 1180 int key_fmt; 1181 int key_len; 1182 int fanout; 1183 1184 int min_io_size; 1185 int min_io_shift; 1186 int leb_size; 1187 int half_leb_size; 1188 int leb_cnt; 1189 int max_leb_cnt; 1190 int old_leb_cnt; 1191 int ro_media; 1192 1193 atomic_long_t dirty_pg_cnt; 1194 atomic_long_t dirty_zn_cnt; 1195 atomic_long_t clean_zn_cnt; 1196 1197 long long budg_idx_growth; 1198 long long budg_data_growth; 1199 long long budg_dd_growth; 1200 long long budg_uncommitted_idx; 1201 spinlock_t space_lock; 1202 int min_idx_lebs; 1203 unsigned long long old_idx_sz; 1204 unsigned long long calc_idx_sz; 1205 struct ubifs_lp_stats lst; 1206 1207 int page_budget; 1208 int inode_budget; 1209 int dent_budget; 1210 1211 int ref_node_alsz; 1212 int mst_node_alsz; 1213 int min_idx_node_sz; 1214 int max_idx_node_sz; 1215 long long max_inode_sz; 1216 int max_znode_sz; 1217 int dead_wm; 1218 int dark_wm; 1219 int block_cnt; 1220 1221 struct ubifs_node_range ranges[UBIFS_NODE_TYPES_CNT]; 1222 struct ubi_volume_desc *ubi; 1223 struct ubi_device_info di; 1224 struct ubi_volume_info vi; 1225 1226 struct rb_root orph_tree; 1227 struct list_head orph_list; 1228 struct list_head orph_new; 1229 struct ubifs_orphan *orph_cnext; 1230 struct ubifs_orphan *orph_dnext; 1231 spinlock_t orphan_lock; 1232 void *orph_buf; 1233 int new_orphans; 1234 int cmt_orphans; 1235 int tot_orphans; 1236 int max_orphans; 1237 int ohead_lnum; 1238 int ohead_offs; 1239 int no_orphs; 1240 1241 struct task_struct *bgt; 1242 char bgt_name[sizeof(BGT_NAME_PATTERN) + 9]; 1243 int need_bgt; 1244 int need_wbuf_sync; 1245 1246 int gc_lnum; 1247 void *sbuf; 1248 struct list_head idx_gc; 1249 int idx_gc_cnt; 1250 1251 struct list_head infos_list; 1252 struct mutex umount_mutex; 1253 unsigned int shrinker_run_no; 1254 1255 int space_bits; 1256 int lpt_lnum_bits; 1257 int lpt_offs_bits; 1258 int lpt_spc_bits; 1259 int pcnt_bits; 1260 int lnum_bits; 1261 int nnode_sz; 1262 int pnode_sz; 1263 int ltab_sz; 1264 int lsave_sz; 1265 int pnode_cnt; 1266 int nnode_cnt; 1267 int lpt_hght; 1268 int pnodes_have; 1269 1270 struct mutex lp_mutex; 1271 int lpt_lnum; 1272 int lpt_offs; 1273 int nhead_lnum; 1274 int nhead_offs; 1275 int lpt_drty_flgs; 1276 int dirty_nn_cnt; 1277 int dirty_pn_cnt; 1278 long long lpt_sz; 1279 void *lpt_nod_buf; 1280 void *lpt_buf; 1281 struct ubifs_nnode *nroot; 1282 struct ubifs_cnode *lpt_cnext; 1283 struct ubifs_lpt_heap lpt_heap[LPROPS_HEAP_CNT]; 1284 struct ubifs_lpt_heap dirty_idx; 1285 struct list_head uncat_list; 1286 struct list_head empty_list; 1287 struct list_head freeable_list; 1288 struct list_head frdi_idx_list; 1289 int freeable_cnt; 1290 1291 int ltab_lnum; 1292 int ltab_offs; 1293 struct ubifs_lpt_lprops *ltab; 1294 struct ubifs_lpt_lprops *ltab_cmt; 1295 int lsave_cnt; 1296 int lsave_lnum; 1297 int lsave_offs; 1298 int *lsave; 1299 int lscan_lnum; 1300 1301 long long rp_size; 1302 long long report_rp_size; 1303 uid_t rp_uid; 1304 gid_t rp_gid; 1305 1306 /* The below fields are used only during mounting and re-mounting */ 1307 int empty; 1308 struct rb_root replay_tree; 1309 struct list_head replay_list; 1310 struct list_head replay_buds; 1311 unsigned long long cs_sqnum; 1312 unsigned long long replay_sqnum; 1313 int need_recovery; 1314 int replaying; 1315 struct list_head unclean_leb_list; 1316 struct ubifs_mst_node *rcvrd_mst_node; 1317 struct rb_root size_tree; 1318 int remounting_rw; 1319 struct ubifs_mount_opts mount_opts; 1320 1321 #ifdef CONFIG_UBIFS_FS_DEBUG 1322 void *dbg_buf; 1323 struct ubifs_zbranch old_zroot; 1324 int old_zroot_level; 1325 unsigned long long old_zroot_sqnum; 1326 int failure_mode; 1327 int fail_delay; 1328 unsigned long fail_timeout; 1329 unsigned int fail_cnt; 1330 unsigned int fail_cnt_max; 1331 #endif 1332 }; 1333 1334 extern struct list_head ubifs_infos; 1335 extern spinlock_t ubifs_infos_lock; 1336 extern atomic_long_t ubifs_clean_zn_cnt; 1337 extern struct kmem_cache *ubifs_inode_slab; 1338 extern struct super_operations ubifs_super_operations; 1339 extern struct address_space_operations ubifs_file_address_operations; 1340 extern struct file_operations ubifs_file_operations; 1341 extern struct inode_operations ubifs_file_inode_operations; 1342 extern struct file_operations ubifs_dir_operations; 1343 extern struct inode_operations ubifs_dir_inode_operations; 1344 extern struct inode_operations ubifs_symlink_inode_operations; 1345 extern struct backing_dev_info ubifs_backing_dev_info; 1346 extern struct ubifs_compressor *ubifs_compressors[UBIFS_COMPR_TYPES_CNT]; 1347 1348 /* io.c */ 1349 int ubifs_wbuf_write_nolock(struct ubifs_wbuf *wbuf, void *buf, int len); 1350 int ubifs_wbuf_seek_nolock(struct ubifs_wbuf *wbuf, int lnum, int offs, 1351 int dtype); 1352 int ubifs_wbuf_init(struct ubifs_info *c, struct ubifs_wbuf *wbuf); 1353 int ubifs_read_node(const struct ubifs_info *c, void *buf, int type, int len, 1354 int lnum, int offs); 1355 int ubifs_read_node_wbuf(struct ubifs_wbuf *wbuf, void *buf, int type, int len, 1356 int lnum, int offs); 1357 int ubifs_write_node(struct ubifs_info *c, void *node, int len, int lnum, 1358 int offs, int dtype); 1359 int ubifs_check_node(const struct ubifs_info *c, const void *buf, int lnum, 1360 int offs, int quiet); 1361 void ubifs_prepare_node(struct ubifs_info *c, void *buf, int len, int pad); 1362 void ubifs_prep_grp_node(struct ubifs_info *c, void *node, int len, int last); 1363 int ubifs_io_init(struct ubifs_info *c); 1364 void ubifs_pad(const struct ubifs_info *c, void *buf, int pad); 1365 int ubifs_wbuf_sync_nolock(struct ubifs_wbuf *wbuf); 1366 int ubifs_bg_wbufs_sync(struct ubifs_info *c); 1367 void ubifs_wbuf_add_ino_nolock(struct ubifs_wbuf *wbuf, ino_t inum); 1368 int ubifs_sync_wbufs_by_inode(struct ubifs_info *c, struct inode *inode); 1369 1370 /* scan.c */ 1371 struct ubifs_scan_leb *ubifs_scan(const struct ubifs_info *c, int lnum, 1372 int offs, void *sbuf); 1373 void ubifs_scan_destroy(struct ubifs_scan_leb *sleb); 1374 int ubifs_scan_a_node(const struct ubifs_info *c, void *buf, int len, int lnum, 1375 int offs, int quiet); 1376 struct ubifs_scan_leb *ubifs_start_scan(const struct ubifs_info *c, int lnum, 1377 int offs, void *sbuf); 1378 void ubifs_end_scan(const struct ubifs_info *c, struct ubifs_scan_leb *sleb, 1379 int lnum, int offs); 1380 int ubifs_add_snod(const struct ubifs_info *c, struct ubifs_scan_leb *sleb, 1381 void *buf, int offs); 1382 void ubifs_scanned_corruption(const struct ubifs_info *c, int lnum, int offs, 1383 void *buf); 1384 1385 /* log.c */ 1386 void ubifs_add_bud(struct ubifs_info *c, struct ubifs_bud *bud); 1387 void ubifs_create_buds_lists(struct ubifs_info *c); 1388 int ubifs_add_bud_to_log(struct ubifs_info *c, int jhead, int lnum, int offs); 1389 struct ubifs_bud *ubifs_search_bud(struct ubifs_info *c, int lnum); 1390 struct ubifs_wbuf *ubifs_get_wbuf(struct ubifs_info *c, int lnum); 1391 int ubifs_log_start_commit(struct ubifs_info *c, int *ltail_lnum); 1392 int ubifs_log_end_commit(struct ubifs_info *c, int new_ltail_lnum); 1393 int ubifs_log_post_commit(struct ubifs_info *c, int old_ltail_lnum); 1394 int ubifs_consolidate_log(struct ubifs_info *c); 1395 1396 /* journal.c */ 1397 int ubifs_jnl_update(struct ubifs_info *c, const struct inode *dir, 1398 const struct qstr *nm, const struct inode *inode, 1399 int deletion, int xent); 1400 int ubifs_jnl_write_data(struct ubifs_info *c, const struct inode *inode, 1401 const union ubifs_key *key, const void *buf, int len); 1402 int ubifs_jnl_write_inode(struct ubifs_info *c, const struct inode *inode, 1403 int last_reference); 1404 int ubifs_jnl_rename(struct ubifs_info *c, const struct inode *old_dir, 1405 const struct dentry *old_dentry, 1406 const struct inode *new_dir, 1407 const struct dentry *new_dentry, int sync); 1408 int ubifs_jnl_truncate(struct ubifs_info *c, const struct inode *inode, 1409 loff_t old_size, loff_t new_size); 1410 int ubifs_jnl_delete_xattr(struct ubifs_info *c, const struct inode *host, 1411 const struct inode *inode, const struct qstr *nm); 1412 int ubifs_jnl_change_xattr(struct ubifs_info *c, const struct inode *inode1, 1413 const struct inode *inode2); 1414 1415 /* budget.c */ 1416 int ubifs_budget_space(struct ubifs_info *c, struct ubifs_budget_req *req); 1417 void ubifs_release_budget(struct ubifs_info *c, struct ubifs_budget_req *req); 1418 void ubifs_release_dirty_inode_budget(struct ubifs_info *c, 1419 struct ubifs_inode *ui); 1420 int ubifs_budget_inode_op(struct ubifs_info *c, struct inode *inode, 1421 struct ubifs_budget_req *req); 1422 void ubifs_release_ino_dirty(struct ubifs_info *c, struct inode *inode, 1423 struct ubifs_budget_req *req); 1424 void ubifs_cancel_ino_op(struct ubifs_info *c, struct inode *inode, 1425 struct ubifs_budget_req *req); 1426 long long ubifs_budg_get_free_space(struct ubifs_info *c); 1427 int ubifs_calc_min_idx_lebs(struct ubifs_info *c); 1428 void ubifs_convert_page_budget(struct ubifs_info *c); 1429 long long ubifs_calc_available(const struct ubifs_info *c, int min_idx_lebs); 1430 1431 /* find.c */ 1432 int ubifs_find_free_space(struct ubifs_info *c, int min_space, int *free, 1433 int squeeze); 1434 int ubifs_find_free_leb_for_idx(struct ubifs_info *c); 1435 int ubifs_find_dirty_leb(struct ubifs_info *c, struct ubifs_lprops *ret_lp, 1436 int min_space, int pick_free); 1437 int ubifs_find_dirty_idx_leb(struct ubifs_info *c); 1438 int ubifs_save_dirty_idx_lnums(struct ubifs_info *c); 1439 1440 /* tnc.c */ 1441 int ubifs_lookup_level0(struct ubifs_info *c, const union ubifs_key *key, 1442 struct ubifs_znode **zn, int *n); 1443 int ubifs_tnc_lookup(struct ubifs_info *c, const union ubifs_key *key, 1444 void *node); 1445 int ubifs_tnc_lookup_nm(struct ubifs_info *c, const union ubifs_key *key, 1446 void *node, const struct qstr *nm); 1447 int ubifs_tnc_locate(struct ubifs_info *c, const union ubifs_key *key, 1448 void *node, int *lnum, int *offs); 1449 int ubifs_tnc_add(struct ubifs_info *c, const union ubifs_key *key, int lnum, 1450 int offs, int len); 1451 int ubifs_tnc_replace(struct ubifs_info *c, const union ubifs_key *key, 1452 int old_lnum, int old_offs, int lnum, int offs, int len); 1453 int ubifs_tnc_add_nm(struct ubifs_info *c, const union ubifs_key *key, 1454 int lnum, int offs, int len, const struct qstr *nm); 1455 int ubifs_tnc_remove(struct ubifs_info *c, const union ubifs_key *key); 1456 int ubifs_tnc_remove_nm(struct ubifs_info *c, const union ubifs_key *key, 1457 const struct qstr *nm); 1458 int ubifs_tnc_remove_range(struct ubifs_info *c, union ubifs_key *from_key, 1459 union ubifs_key *to_key); 1460 int ubifs_tnc_remove_ino(struct ubifs_info *c, ino_t inum); 1461 struct ubifs_dent_node *ubifs_tnc_next_ent(struct ubifs_info *c, 1462 union ubifs_key *key, 1463 const struct qstr *nm); 1464 void ubifs_tnc_close(struct ubifs_info *c); 1465 int ubifs_tnc_has_node(struct ubifs_info *c, union ubifs_key *key, int level, 1466 int lnum, int offs, int is_idx); 1467 int ubifs_dirty_idx_node(struct ubifs_info *c, union ubifs_key *key, int level, 1468 int lnum, int offs); 1469 /* Shared by tnc.c for tnc_commit.c */ 1470 void destroy_old_idx(struct ubifs_info *c); 1471 int is_idx_node_in_tnc(struct ubifs_info *c, union ubifs_key *key, int level, 1472 int lnum, int offs); 1473 int insert_old_idx_znode(struct ubifs_info *c, struct ubifs_znode *znode); 1474 1475 /* tnc_misc.c */ 1476 struct ubifs_znode *ubifs_tnc_levelorder_next(struct ubifs_znode *zr, 1477 struct ubifs_znode *znode); 1478 int ubifs_search_zbranch(const struct ubifs_info *c, 1479 const struct ubifs_znode *znode, 1480 const union ubifs_key *key, int *n); 1481 struct ubifs_znode *ubifs_tnc_postorder_first(struct ubifs_znode *znode); 1482 struct ubifs_znode *ubifs_tnc_postorder_next(struct ubifs_znode *znode); 1483 long ubifs_destroy_tnc_subtree(struct ubifs_znode *zr); 1484 struct ubifs_znode *ubifs_load_znode(struct ubifs_info *c, 1485 struct ubifs_zbranch *zbr, 1486 struct ubifs_znode *parent, int iip); 1487 int ubifs_tnc_read_node(struct ubifs_info *c, struct ubifs_zbranch *zbr, 1488 void *node); 1489 1490 /* tnc_commit.c */ 1491 int ubifs_tnc_start_commit(struct ubifs_info *c, struct ubifs_zbranch *zroot); 1492 int ubifs_tnc_end_commit(struct ubifs_info *c); 1493 1494 /* shrinker.c */ 1495 int ubifs_shrinker(int nr_to_scan, gfp_t gfp_mask); 1496 1497 /* commit.c */ 1498 int ubifs_bg_thread(void *info); 1499 void ubifs_commit_required(struct ubifs_info *c); 1500 void ubifs_request_bg_commit(struct ubifs_info *c); 1501 int ubifs_run_commit(struct ubifs_info *c); 1502 void ubifs_recovery_commit(struct ubifs_info *c); 1503 int ubifs_gc_should_commit(struct ubifs_info *c); 1504 void ubifs_wait_for_commit(struct ubifs_info *c); 1505 1506 /* master.c */ 1507 int ubifs_read_master(struct ubifs_info *c); 1508 int ubifs_write_master(struct ubifs_info *c); 1509 1510 /* sb.c */ 1511 int ubifs_read_superblock(struct ubifs_info *c); 1512 struct ubifs_sb_node *ubifs_read_sb_node(struct ubifs_info *c); 1513 int ubifs_write_sb_node(struct ubifs_info *c, struct ubifs_sb_node *sup); 1514 1515 /* replay.c */ 1516 int ubifs_validate_entry(struct ubifs_info *c, 1517 const struct ubifs_dent_node *dent); 1518 int ubifs_replay_journal(struct ubifs_info *c); 1519 1520 /* gc.c */ 1521 int ubifs_garbage_collect(struct ubifs_info *c, int anyway); 1522 int ubifs_gc_start_commit(struct ubifs_info *c); 1523 int ubifs_gc_end_commit(struct ubifs_info *c); 1524 void ubifs_destroy_idx_gc(struct ubifs_info *c); 1525 int ubifs_get_idx_gc_leb(struct ubifs_info *c); 1526 int ubifs_garbage_collect_leb(struct ubifs_info *c, struct ubifs_lprops *lp); 1527 1528 /* orphan.c */ 1529 int ubifs_add_orphan(struct ubifs_info *c, ino_t inum); 1530 void ubifs_delete_orphan(struct ubifs_info *c, ino_t inum); 1531 int ubifs_orphan_start_commit(struct ubifs_info *c); 1532 int ubifs_orphan_end_commit(struct ubifs_info *c); 1533 int ubifs_mount_orphans(struct ubifs_info *c, int unclean, int read_only); 1534 1535 /* lpt.c */ 1536 int ubifs_calc_lpt_geom(struct ubifs_info *c); 1537 int ubifs_create_dflt_lpt(struct ubifs_info *c, int *main_lebs, int lpt_first, 1538 int *lpt_lebs, int *big_lpt); 1539 int ubifs_lpt_init(struct ubifs_info *c, int rd, int wr); 1540 struct ubifs_lprops *ubifs_lpt_lookup(struct ubifs_info *c, int lnum); 1541 struct ubifs_lprops *ubifs_lpt_lookup_dirty(struct ubifs_info *c, int lnum); 1542 int ubifs_lpt_scan_nolock(struct ubifs_info *c, int start_lnum, int end_lnum, 1543 ubifs_lpt_scan_callback scan_cb, void *data); 1544 1545 /* Shared by lpt.c for lpt_commit.c */ 1546 void ubifs_pack_lsave(struct ubifs_info *c, void *buf, int *lsave); 1547 void ubifs_pack_ltab(struct ubifs_info *c, void *buf, 1548 struct ubifs_lpt_lprops *ltab); 1549 void ubifs_pack_pnode(struct ubifs_info *c, void *buf, 1550 struct ubifs_pnode *pnode); 1551 void ubifs_pack_nnode(struct ubifs_info *c, void *buf, 1552 struct ubifs_nnode *nnode); 1553 struct ubifs_pnode *ubifs_get_pnode(struct ubifs_info *c, 1554 struct ubifs_nnode *parent, int iip); 1555 struct ubifs_nnode *ubifs_get_nnode(struct ubifs_info *c, 1556 struct ubifs_nnode *parent, int iip); 1557 int ubifs_read_nnode(struct ubifs_info *c, struct ubifs_nnode *parent, int iip); 1558 void ubifs_add_lpt_dirt(struct ubifs_info *c, int lnum, int dirty); 1559 void ubifs_add_nnode_dirt(struct ubifs_info *c, struct ubifs_nnode *nnode); 1560 uint32_t ubifs_unpack_bits(uint8_t **addr, int *pos, int nrbits); 1561 struct ubifs_nnode *ubifs_first_nnode(struct ubifs_info *c, int *hght); 1562 1563 /* lpt_commit.c */ 1564 int ubifs_lpt_start_commit(struct ubifs_info *c); 1565 int ubifs_lpt_end_commit(struct ubifs_info *c); 1566 int ubifs_lpt_post_commit(struct ubifs_info *c); 1567 void ubifs_lpt_free(struct ubifs_info *c, int wr_only); 1568 1569 /* lprops.c */ 1570 void ubifs_get_lprops(struct ubifs_info *c); 1571 const struct ubifs_lprops *ubifs_change_lp(struct ubifs_info *c, 1572 const struct ubifs_lprops *lp, 1573 int free, int dirty, int flags, 1574 int idx_gc_cnt); 1575 void ubifs_release_lprops(struct ubifs_info *c); 1576 void ubifs_get_lp_stats(struct ubifs_info *c, struct ubifs_lp_stats *stats); 1577 void ubifs_add_to_cat(struct ubifs_info *c, struct ubifs_lprops *lprops, 1578 int cat); 1579 void ubifs_replace_cat(struct ubifs_info *c, struct ubifs_lprops *old_lprops, 1580 struct ubifs_lprops *new_lprops); 1581 void ubifs_ensure_cat(struct ubifs_info *c, struct ubifs_lprops *lprops); 1582 int ubifs_categorize_lprops(const struct ubifs_info *c, 1583 const struct ubifs_lprops *lprops); 1584 int ubifs_change_one_lp(struct ubifs_info *c, int lnum, int free, int dirty, 1585 int flags_set, int flags_clean, int idx_gc_cnt); 1586 int ubifs_update_one_lp(struct ubifs_info *c, int lnum, int free, int dirty, 1587 int flags_set, int flags_clean); 1588 int ubifs_read_one_lp(struct ubifs_info *c, int lnum, struct ubifs_lprops *lp); 1589 const struct ubifs_lprops *ubifs_fast_find_free(struct ubifs_info *c); 1590 const struct ubifs_lprops *ubifs_fast_find_empty(struct ubifs_info *c); 1591 const struct ubifs_lprops *ubifs_fast_find_freeable(struct ubifs_info *c); 1592 const struct ubifs_lprops *ubifs_fast_find_frdi_idx(struct ubifs_info *c); 1593 1594 /* file.c */ 1595 int ubifs_fsync(struct file *file, struct dentry *dentry, int datasync); 1596 int ubifs_setattr(struct dentry *dentry, struct iattr *attr); 1597 1598 /* dir.c */ 1599 struct inode *ubifs_new_inode(struct ubifs_info *c, const struct inode *dir, 1600 int mode); 1601 int ubifs_getattr(struct vfsmount *mnt, struct dentry *dentry, 1602 struct kstat *stat); 1603 1604 /* xattr.c */ 1605 int ubifs_setxattr(struct dentry *dentry, const char *name, 1606 const void *value, size_t size, int flags); 1607 ssize_t ubifs_getxattr(struct dentry *dentry, const char *name, void *buf, 1608 size_t size); 1609 ssize_t ubifs_listxattr(struct dentry *dentry, char *buffer, size_t size); 1610 int ubifs_removexattr(struct dentry *dentry, const char *name); 1611 1612 /* super.c */ 1613 struct inode *ubifs_iget(struct super_block *sb, unsigned long inum); 1614 1615 /* recovery.c */ 1616 int ubifs_recover_master_node(struct ubifs_info *c); 1617 int ubifs_write_rcvrd_mst_node(struct ubifs_info *c); 1618 struct ubifs_scan_leb *ubifs_recover_leb(struct ubifs_info *c, int lnum, 1619 int offs, void *sbuf, int grouped); 1620 struct ubifs_scan_leb *ubifs_recover_log_leb(struct ubifs_info *c, int lnum, 1621 int offs, void *sbuf); 1622 int ubifs_recover_inl_heads(const struct ubifs_info *c, void *sbuf); 1623 int ubifs_clean_lebs(const struct ubifs_info *c, void *sbuf); 1624 int ubifs_rcvry_gc_commit(struct ubifs_info *c); 1625 int ubifs_recover_size_accum(struct ubifs_info *c, union ubifs_key *key, 1626 int deletion, loff_t new_size); 1627 int ubifs_recover_size(struct ubifs_info *c); 1628 void ubifs_destroy_size_tree(struct ubifs_info *c); 1629 1630 /* ioctl.c */ 1631 long ubifs_ioctl(struct file *file, unsigned int cmd, unsigned long arg); 1632 void ubifs_set_inode_flags(struct inode *inode); 1633 #ifdef CONFIG_COMPAT 1634 long ubifs_compat_ioctl(struct file *file, unsigned int cmd, unsigned long arg); 1635 #endif 1636 1637 /* compressor.c */ 1638 int __init ubifs_compressors_init(void); 1639 void __exit ubifs_compressors_exit(void); 1640 void ubifs_compress(const void *in_buf, int in_len, void *out_buf, int *out_len, 1641 int *compr_type); 1642 int ubifs_decompress(const void *buf, int len, void *out, int *out_len, 1643 int compr_type); 1644 1645 #include "debug.h" 1646 #include "misc.h" 1647 #include "key.h" 1648 1649 #endif /* !__UBIFS_H__ */ 1650