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