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