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