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