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