12b27bdccSThomas Gleixner /* SPDX-License-Identifier: GPL-2.0-only */ 21e51764aSArtem Bityutskiy /* 31e51764aSArtem Bityutskiy * This file is part of UBIFS. 41e51764aSArtem Bityutskiy * 51e51764aSArtem Bityutskiy * Copyright (C) 2006-2008 Nokia Corporation 61e51764aSArtem Bityutskiy * 71e51764aSArtem Bityutskiy * Authors: Artem Bityutskiy (Битюцкий Артём) 81e51764aSArtem Bityutskiy * Adrian Hunter 91e51764aSArtem Bityutskiy */ 101e51764aSArtem Bityutskiy 111e51764aSArtem Bityutskiy #ifndef __UBIFS_H__ 121e51764aSArtem Bityutskiy #define __UBIFS_H__ 131e51764aSArtem Bityutskiy 141e51764aSArtem Bityutskiy #include <asm/div64.h> 151e51764aSArtem Bityutskiy #include <linux/statfs.h> 161e51764aSArtem Bityutskiy #include <linux/fs.h> 171e51764aSArtem Bityutskiy #include <linux/err.h> 181e51764aSArtem Bityutskiy #include <linux/sched.h> 195a0e3ad6STejun Heo #include <linux/slab.h> 201e51764aSArtem Bityutskiy #include <linux/vmalloc.h> 211e51764aSArtem Bityutskiy #include <linux/spinlock.h> 221e51764aSArtem Bityutskiy #include <linux/mutex.h> 231e51764aSArtem Bityutskiy #include <linux/rwsem.h> 241e51764aSArtem Bityutskiy #include <linux/mtd/ubi.h> 251e51764aSArtem Bityutskiy #include <linux/pagemap.h> 261e51764aSArtem Bityutskiy #include <linux/backing-dev.h> 27d7f0b70dSSubodh Nijsure #include <linux/security.h> 282b88fc21SAndreas Gruenbacher #include <linux/xattr.h> 29cc41a536SRichard Weinberger #include <linux/random.h> 3049525e5eSSascha Hauer #include <crypto/hash_info.h> 3149525e5eSSascha Hauer #include <crypto/hash.h> 3249525e5eSSascha Hauer #include <crypto/algapi.h> 33734f0d24SDave Chinner 34734f0d24SDave Chinner #include <linux/fscrypt.h> 35734f0d24SDave Chinner 361e51764aSArtem Bityutskiy #include "ubifs-media.h" 371e51764aSArtem Bityutskiy 381e51764aSArtem Bityutskiy /* Version of this UBIFS implementation */ 391e51764aSArtem Bityutskiy #define UBIFS_VERSION 1 401e51764aSArtem Bityutskiy 411e51764aSArtem Bityutskiy /* UBIFS file system VFS magic number */ 421e51764aSArtem Bityutskiy #define UBIFS_SUPER_MAGIC 0x24051905 431e51764aSArtem Bityutskiy 441e51764aSArtem Bityutskiy /* Number of UBIFS blocks per VFS page */ 4509cbfeafSKirill A. Shutemov #define UBIFS_BLOCKS_PER_PAGE (PAGE_SIZE / UBIFS_BLOCK_SIZE) 4609cbfeafSKirill A. Shutemov #define UBIFS_BLOCKS_PER_PAGE_SHIFT (PAGE_SHIFT - UBIFS_BLOCK_SHIFT) 471e51764aSArtem Bityutskiy 481e51764aSArtem Bityutskiy /* "File system end of life" sequence number watermark */ 491e51764aSArtem Bityutskiy #define SQNUM_WARN_WATERMARK 0xFFFFFFFF00000000ULL 501e51764aSArtem Bityutskiy #define SQNUM_WATERMARK 0xFFFFFFFFFF000000ULL 511e51764aSArtem Bityutskiy 52af14a1adSArtem Bityutskiy /* 53af14a1adSArtem Bityutskiy * Minimum amount of LEBs reserved for the index. At present the index needs at 54af14a1adSArtem Bityutskiy * least 2 LEBs: one for the index head and one for in-the-gaps method (which 55af14a1adSArtem Bityutskiy * currently does not cater for the index head and so excludes it from 56af14a1adSArtem Bityutskiy * consideration). 57af14a1adSArtem Bityutskiy */ 58af14a1adSArtem Bityutskiy #define MIN_INDEX_LEBS 2 59af14a1adSArtem Bityutskiy 601e51764aSArtem Bityutskiy /* Minimum amount of data UBIFS writes to the flash */ 611e51764aSArtem Bityutskiy #define MIN_WRITE_SZ (UBIFS_DATA_NODE_SZ + 8) 621e51764aSArtem Bityutskiy 631e51764aSArtem Bityutskiy /* 641e51764aSArtem Bityutskiy * Currently we do not support inode number overlapping and re-using, so this 651e51764aSArtem Bityutskiy * watermark defines dangerous inode number level. This should be fixed later, 661e51764aSArtem Bityutskiy * although it is difficult to exceed current limit. Another option is to use 671e51764aSArtem Bityutskiy * 64-bit inode numbers, but this means more overhead. 681e51764aSArtem Bityutskiy */ 691e51764aSArtem Bityutskiy #define INUM_WARN_WATERMARK 0xFFF00000 701e51764aSArtem Bityutskiy #define INUM_WATERMARK 0xFFFFFF00 711e51764aSArtem Bityutskiy 721e51764aSArtem Bityutskiy /* Maximum number of entries in each LPT (LEB category) heap */ 731e51764aSArtem Bityutskiy #define LPT_HEAP_SZ 256 741e51764aSArtem Bityutskiy 751e51764aSArtem Bityutskiy /* 761e51764aSArtem Bityutskiy * Background thread name pattern. The numbers are UBI device and volume 771e51764aSArtem Bityutskiy * numbers. 781e51764aSArtem Bityutskiy */ 791e51764aSArtem Bityutskiy #define BGT_NAME_PATTERN "ubifs_bgt%d_%d" 801e51764aSArtem Bityutskiy 811e51764aSArtem Bityutskiy /* Maximum possible inode number (only 32-bit inodes are supported now) */ 821e51764aSArtem Bityutskiy #define MAX_INUM 0xFFFFFFFF 831e51764aSArtem Bityutskiy 841e51764aSArtem Bityutskiy /* Number of non-data journal heads */ 851e51764aSArtem Bityutskiy #define NONDATA_JHEADS_CNT 2 861e51764aSArtem Bityutskiy 87d6d14009SArtem Bityutskiy /* Shorter names for journal head numbers for internal usage */ 88d6d14009SArtem Bityutskiy #define GCHD UBIFS_GC_HEAD 89d6d14009SArtem Bityutskiy #define BASEHD UBIFS_BASE_HEAD 90d6d14009SArtem Bityutskiy #define DATAHD UBIFS_DATA_HEAD 911e51764aSArtem Bityutskiy 921e51764aSArtem Bityutskiy /* 'No change' value for 'ubifs_change_lp()' */ 931e51764aSArtem Bityutskiy #define LPROPS_NC 0x80000001 941e51764aSArtem Bityutskiy 951e51764aSArtem Bityutskiy /* 961e51764aSArtem Bityutskiy * There is no notion of truncation key because truncation nodes do not exist 971e51764aSArtem Bityutskiy * in TNC. However, when replaying, it is handy to introduce fake "truncation" 981e51764aSArtem Bityutskiy * keys for truncation nodes because the code becomes simpler. So we define 991e51764aSArtem Bityutskiy * %UBIFS_TRUN_KEY type. 100ba2f48f7SArtem Bityutskiy * 101ba2f48f7SArtem Bityutskiy * But otherwise, out of the journal reply scope, the truncation keys are 102ba2f48f7SArtem Bityutskiy * invalid. 1031e51764aSArtem Bityutskiy */ 1041e51764aSArtem Bityutskiy #define UBIFS_TRUN_KEY UBIFS_KEY_TYPES_CNT 105ba2f48f7SArtem Bityutskiy #define UBIFS_INVALID_KEY UBIFS_KEY_TYPES_CNT 1061e51764aSArtem Bityutskiy 1071e51764aSArtem Bityutskiy /* 1081e51764aSArtem Bityutskiy * How much a directory entry/extended attribute entry adds to the parent/host 1091e51764aSArtem Bityutskiy * inode. 1101e51764aSArtem Bityutskiy */ 1111e51764aSArtem Bityutskiy #define CALC_DENT_SIZE(name_len) ALIGN(UBIFS_DENT_NODE_SZ + (name_len) + 1, 8) 1121e51764aSArtem Bityutskiy 1131e51764aSArtem Bityutskiy /* How much an extended attribute adds to the host inode */ 1141e51764aSArtem Bityutskiy #define CALC_XATTR_BYTES(data_len) ALIGN(UBIFS_INO_NODE_SZ + (data_len) + 1, 8) 1151e51764aSArtem Bityutskiy 1161e51764aSArtem Bityutskiy /* 1171e51764aSArtem Bityutskiy * Znodes which were not touched for 'OLD_ZNODE_AGE' seconds are considered 1181e51764aSArtem Bityutskiy * "old", and znode which were touched last 'YOUNG_ZNODE_AGE' seconds ago are 1191e51764aSArtem Bityutskiy * considered "young". This is used by shrinker when selecting znode to trim 1201e51764aSArtem Bityutskiy * off. 1211e51764aSArtem Bityutskiy */ 1221e51764aSArtem Bityutskiy #define OLD_ZNODE_AGE 20 1231e51764aSArtem Bityutskiy #define YOUNG_ZNODE_AGE 5 1241e51764aSArtem Bityutskiy 1251e51764aSArtem Bityutskiy /* 1261e51764aSArtem Bityutskiy * Some compressors, like LZO, may end up with more data then the input buffer. 1271e51764aSArtem Bityutskiy * So UBIFS always allocates larger output buffer, to be sure the compressor 1281e51764aSArtem Bityutskiy * will not corrupt memory in case of worst case compression. 1291e51764aSArtem Bityutskiy */ 1301e51764aSArtem Bityutskiy #define WORST_COMPR_FACTOR 2 1311e51764aSArtem Bityutskiy 132643fa961SChandan Rajendra #ifdef CONFIG_FS_ENCRYPTION 1337799953bSRichard Weinberger #define UBIFS_CIPHER_BLOCK_SIZE FS_CRYPTO_BLOCK_SIZE 1347799953bSRichard Weinberger #else 1357799953bSRichard Weinberger #define UBIFS_CIPHER_BLOCK_SIZE 0 1367799953bSRichard Weinberger #endif 1377799953bSRichard Weinberger 138d882962fSMatthew L. Creech /* 139d3f9db00SYannick Guerrini * How much memory is needed for a buffer where we compress a data node. 140d882962fSMatthew L. Creech */ 141d882962fSMatthew L. Creech #define COMPRESSED_DATA_NODE_BUF_SZ \ 142d882962fSMatthew L. Creech (UBIFS_DATA_NODE_SZ + UBIFS_BLOCK_SIZE * WORST_COMPR_FACTOR) 143d882962fSMatthew L. Creech 1441e51764aSArtem Bityutskiy /* Maximum expected tree height for use by bottom_up_buf */ 1451e51764aSArtem Bityutskiy #define BOTTOM_UP_HEIGHT 64 1461e51764aSArtem Bityutskiy 1474793e7c5SAdrian Hunter /* Maximum number of data nodes to bulk-read */ 1484793e7c5SAdrian Hunter #define UBIFS_MAX_BULK_READ 32 1494793e7c5SAdrian Hunter 15049525e5eSSascha Hauer #ifdef CONFIG_UBIFS_FS_AUTHENTICATION 15149525e5eSSascha Hauer #define UBIFS_HASH_ARR_SZ UBIFS_MAX_HASH_LEN 15249525e5eSSascha Hauer #define UBIFS_HMAC_ARR_SZ UBIFS_MAX_HMAC_LEN 15349525e5eSSascha Hauer #else 15449525e5eSSascha Hauer #define UBIFS_HASH_ARR_SZ 0 15549525e5eSSascha Hauer #define UBIFS_HMAC_ARR_SZ 0 15649525e5eSSascha Hauer #endif 15749525e5eSSascha Hauer 1581e51764aSArtem Bityutskiy /* 1591e51764aSArtem Bityutskiy * Lockdep classes for UBIFS inode @ui_mutex. 1601e51764aSArtem Bityutskiy */ 1611e51764aSArtem Bityutskiy enum { 1621e51764aSArtem Bityutskiy WB_MUTEX_1 = 0, 1631e51764aSArtem Bityutskiy WB_MUTEX_2 = 1, 1641e51764aSArtem Bityutskiy WB_MUTEX_3 = 2, 1659e0a1fffSRichard Weinberger WB_MUTEX_4 = 3, 1661e51764aSArtem Bityutskiy }; 1671e51764aSArtem Bityutskiy 1681e51764aSArtem Bityutskiy /* 1691e51764aSArtem Bityutskiy * Znode flags (actually, bit numbers which store the flags). 1701e51764aSArtem Bityutskiy * 1711e51764aSArtem Bityutskiy * DIRTY_ZNODE: znode is dirty 1721e51764aSArtem Bityutskiy * COW_ZNODE: znode is being committed and a new instance of this znode has to 1731e51764aSArtem Bityutskiy * be created before changing this znode 1741e51764aSArtem Bityutskiy * OBSOLETE_ZNODE: znode is obsolete, which means it was deleted, but it is 1751e51764aSArtem Bityutskiy * still in the commit list and the ongoing commit operation 1761e51764aSArtem Bityutskiy * will commit it, and delete this znode after it is done 1771e51764aSArtem Bityutskiy */ 1781e51764aSArtem Bityutskiy enum { 1791e51764aSArtem Bityutskiy DIRTY_ZNODE = 0, 1801e51764aSArtem Bityutskiy COW_ZNODE = 1, 1811e51764aSArtem Bityutskiy OBSOLETE_ZNODE = 2, 1821e51764aSArtem Bityutskiy }; 1831e51764aSArtem Bityutskiy 1841e51764aSArtem Bityutskiy /* 1851e51764aSArtem Bityutskiy * Commit states. 1861e51764aSArtem Bityutskiy * 1871e51764aSArtem Bityutskiy * COMMIT_RESTING: commit is not wanted 1881e51764aSArtem Bityutskiy * COMMIT_BACKGROUND: background commit has been requested 1891e51764aSArtem Bityutskiy * COMMIT_REQUIRED: commit is required 1901e51764aSArtem Bityutskiy * COMMIT_RUNNING_BACKGROUND: background commit is running 1911e51764aSArtem Bityutskiy * COMMIT_RUNNING_REQUIRED: commit is running and it is required 1921e51764aSArtem Bityutskiy * COMMIT_BROKEN: commit failed 1931e51764aSArtem Bityutskiy */ 1941e51764aSArtem Bityutskiy enum { 1951e51764aSArtem Bityutskiy COMMIT_RESTING = 0, 1961e51764aSArtem Bityutskiy COMMIT_BACKGROUND, 1971e51764aSArtem Bityutskiy COMMIT_REQUIRED, 1981e51764aSArtem Bityutskiy COMMIT_RUNNING_BACKGROUND, 1991e51764aSArtem Bityutskiy COMMIT_RUNNING_REQUIRED, 2001e51764aSArtem Bityutskiy COMMIT_BROKEN, 2011e51764aSArtem Bityutskiy }; 2021e51764aSArtem Bityutskiy 2031e51764aSArtem Bityutskiy /* 2041e51764aSArtem Bityutskiy * 'ubifs_scan_a_node()' return values. 2051e51764aSArtem Bityutskiy * 2061e51764aSArtem Bityutskiy * SCANNED_GARBAGE: scanned garbage 2071e51764aSArtem Bityutskiy * SCANNED_EMPTY_SPACE: scanned empty space 2081e51764aSArtem Bityutskiy * SCANNED_A_NODE: scanned a valid node 2091e51764aSArtem Bityutskiy * SCANNED_A_CORRUPT_NODE: scanned a corrupted node 2101e51764aSArtem Bityutskiy * SCANNED_A_BAD_PAD_NODE: scanned a padding node with invalid pad length 2111e51764aSArtem Bityutskiy * 2121e51764aSArtem Bityutskiy * Greater than zero means: 'scanned that number of padding bytes' 2131e51764aSArtem Bityutskiy */ 2141e51764aSArtem Bityutskiy enum { 2151e51764aSArtem Bityutskiy SCANNED_GARBAGE = 0, 2161e51764aSArtem Bityutskiy SCANNED_EMPTY_SPACE = -1, 2171e51764aSArtem Bityutskiy SCANNED_A_NODE = -2, 2181e51764aSArtem Bityutskiy SCANNED_A_CORRUPT_NODE = -3, 2191e51764aSArtem Bityutskiy SCANNED_A_BAD_PAD_NODE = -4, 2201e51764aSArtem Bityutskiy }; 2211e51764aSArtem Bityutskiy 2221e51764aSArtem Bityutskiy /* 2231e51764aSArtem Bityutskiy * LPT cnode flag bits. 2241e51764aSArtem Bityutskiy * 2251e51764aSArtem Bityutskiy * DIRTY_CNODE: cnode is dirty 2261e51764aSArtem Bityutskiy * OBSOLETE_CNODE: cnode is being committed and has been copied (or deleted), 2271e51764aSArtem Bityutskiy * so it can (and must) be freed when the commit is finished 22837662447SArtem Bityutskiy * COW_CNODE: cnode is being committed and must be copied before writing 2291e51764aSArtem Bityutskiy */ 2301e51764aSArtem Bityutskiy enum { 2311e51764aSArtem Bityutskiy DIRTY_CNODE = 0, 23237662447SArtem Bityutskiy OBSOLETE_CNODE = 1, 23337662447SArtem Bityutskiy COW_CNODE = 2, 2341e51764aSArtem Bityutskiy }; 2351e51764aSArtem Bityutskiy 2361e51764aSArtem Bityutskiy /* 2371e51764aSArtem Bityutskiy * Dirty flag bits (lpt_drty_flgs) for LPT special nodes. 2381e51764aSArtem Bityutskiy * 2391e51764aSArtem Bityutskiy * LTAB_DIRTY: ltab node is dirty 2401e51764aSArtem Bityutskiy * LSAVE_DIRTY: lsave node is dirty 2411e51764aSArtem Bityutskiy */ 2421e51764aSArtem Bityutskiy enum { 2431e51764aSArtem Bityutskiy LTAB_DIRTY = 1, 2441e51764aSArtem Bityutskiy LSAVE_DIRTY = 2, 2451e51764aSArtem Bityutskiy }; 2461e51764aSArtem Bityutskiy 2471e51764aSArtem Bityutskiy /* 2481e51764aSArtem Bityutskiy * Return codes used by the garbage collector. 2491e51764aSArtem Bityutskiy * @LEB_FREED: the logical eraseblock was freed and is ready to use 2501e51764aSArtem Bityutskiy * @LEB_FREED_IDX: indexing LEB was freed and can be used only after the commit 2511e51764aSArtem Bityutskiy * @LEB_RETAINED: the logical eraseblock was freed and retained for GC purposes 2521e51764aSArtem Bityutskiy */ 2531e51764aSArtem Bityutskiy enum { 2541e51764aSArtem Bityutskiy LEB_FREED, 2551e51764aSArtem Bityutskiy LEB_FREED_IDX, 2561e51764aSArtem Bityutskiy LEB_RETAINED, 2571e51764aSArtem Bityutskiy }; 2581e51764aSArtem Bityutskiy 2592e52eb74SRichard Weinberger /* 2602e52eb74SRichard Weinberger * Action taken upon a failed ubifs_assert(). 2612e52eb74SRichard Weinberger * @ASSACT_REPORT: just report the failed assertion 2622e52eb74SRichard Weinberger * @ASSACT_RO: switch to read-only mode 2632e52eb74SRichard Weinberger * @ASSACT_PANIC: call BUG() and possible panic the kernel 2642e52eb74SRichard Weinberger */ 2652e52eb74SRichard Weinberger enum { 2662e52eb74SRichard Weinberger ASSACT_REPORT = 0, 2672e52eb74SRichard Weinberger ASSACT_RO, 2682e52eb74SRichard Weinberger ASSACT_PANIC, 2692e52eb74SRichard Weinberger }; 2702e52eb74SRichard Weinberger 2711e51764aSArtem Bityutskiy /** 2721e51764aSArtem Bityutskiy * struct ubifs_old_idx - index node obsoleted since last commit start. 2731e51764aSArtem Bityutskiy * @rb: rb-tree node 2741e51764aSArtem Bityutskiy * @lnum: LEB number of obsoleted index node 2751e51764aSArtem Bityutskiy * @offs: offset of obsoleted index node 2761e51764aSArtem Bityutskiy */ 2771e51764aSArtem Bityutskiy struct ubifs_old_idx { 2781e51764aSArtem Bityutskiy struct rb_node rb; 2791e51764aSArtem Bityutskiy int lnum; 2801e51764aSArtem Bityutskiy int offs; 2811e51764aSArtem Bityutskiy }; 2821e51764aSArtem Bityutskiy 2831e51764aSArtem Bityutskiy /* The below union makes it easier to deal with keys */ 2841e51764aSArtem Bityutskiy union ubifs_key { 2857ca58badSArtem Bityutskiy uint8_t u8[UBIFS_SK_LEN]; 2867ca58badSArtem Bityutskiy uint32_t u32[UBIFS_SK_LEN/4]; 2877ca58badSArtem Bityutskiy uint64_t u64[UBIFS_SK_LEN/8]; 2887ca58badSArtem Bityutskiy __le32 j32[UBIFS_SK_LEN/4]; 2891e51764aSArtem Bityutskiy }; 2901e51764aSArtem Bityutskiy 2911e51764aSArtem Bityutskiy /** 2921e51764aSArtem Bityutskiy * struct ubifs_scan_node - UBIFS scanned node information. 2931e51764aSArtem Bityutskiy * @list: list of scanned nodes 2941e51764aSArtem Bityutskiy * @key: key of node scanned (if it has one) 2951e51764aSArtem Bityutskiy * @sqnum: sequence number 2961e51764aSArtem Bityutskiy * @type: type of node scanned 2971e51764aSArtem Bityutskiy * @offs: offset with LEB of node scanned 2981e51764aSArtem Bityutskiy * @len: length of node scanned 2991e51764aSArtem Bityutskiy * @node: raw node 3001e51764aSArtem Bityutskiy */ 3011e51764aSArtem Bityutskiy struct ubifs_scan_node { 3021e51764aSArtem Bityutskiy struct list_head list; 3031e51764aSArtem Bityutskiy union ubifs_key key; 3041e51764aSArtem Bityutskiy unsigned long long sqnum; 3051e51764aSArtem Bityutskiy int type; 3061e51764aSArtem Bityutskiy int offs; 3071e51764aSArtem Bityutskiy int len; 3081e51764aSArtem Bityutskiy void *node; 3091e51764aSArtem Bityutskiy }; 3101e51764aSArtem Bityutskiy 3111e51764aSArtem Bityutskiy /** 3121e51764aSArtem Bityutskiy * struct ubifs_scan_leb - UBIFS scanned LEB information. 3131e51764aSArtem Bityutskiy * @lnum: logical eraseblock number 3141e51764aSArtem Bityutskiy * @nodes_cnt: number of nodes scanned 3151e51764aSArtem Bityutskiy * @nodes: list of struct ubifs_scan_node 3161e51764aSArtem Bityutskiy * @endpt: end point (and therefore the start of empty space) 3171e51764aSArtem Bityutskiy * @buf: buffer containing entire LEB scanned 3181e51764aSArtem Bityutskiy */ 3191e51764aSArtem Bityutskiy struct ubifs_scan_leb { 3201e51764aSArtem Bityutskiy int lnum; 3211e51764aSArtem Bityutskiy int nodes_cnt; 3221e51764aSArtem Bityutskiy struct list_head nodes; 3231e51764aSArtem Bityutskiy int endpt; 3241e51764aSArtem Bityutskiy void *buf; 3251e51764aSArtem Bityutskiy }; 3261e51764aSArtem Bityutskiy 3271e51764aSArtem Bityutskiy /** 3281e51764aSArtem Bityutskiy * struct ubifs_gced_idx_leb - garbage-collected indexing LEB. 3291e51764aSArtem Bityutskiy * @list: list 3301e51764aSArtem Bityutskiy * @lnum: LEB number 3311e51764aSArtem Bityutskiy * @unmap: OK to unmap this LEB 3321e51764aSArtem Bityutskiy * 3331e51764aSArtem Bityutskiy * This data structure is used to temporary store garbage-collected indexing 3341e51764aSArtem Bityutskiy * LEBs - they are not released immediately, but only after the next commit. 3351e51764aSArtem Bityutskiy * This is needed to guarantee recoverability. 3361e51764aSArtem Bityutskiy */ 3371e51764aSArtem Bityutskiy struct ubifs_gced_idx_leb { 3381e51764aSArtem Bityutskiy struct list_head list; 3391e51764aSArtem Bityutskiy int lnum; 3401e51764aSArtem Bityutskiy int unmap; 3411e51764aSArtem Bityutskiy }; 3421e51764aSArtem Bityutskiy 3431e51764aSArtem Bityutskiy /** 3441e51764aSArtem Bityutskiy * struct ubifs_inode - UBIFS in-memory inode description. 3451e51764aSArtem Bityutskiy * @vfs_inode: VFS inode description object 3461e51764aSArtem Bityutskiy * @creat_sqnum: sequence number at time of creation 347de94eb55SArtem Bityutskiy * @del_cmtno: commit number corresponding to the time the inode was deleted, 348de94eb55SArtem Bityutskiy * protected by @c->commit_sem; 3491e51764aSArtem Bityutskiy * @xattr_size: summarized size of all extended attributes in bytes 3501e51764aSArtem Bityutskiy * @xattr_cnt: count of extended attributes this inode has 3511e51764aSArtem Bityutskiy * @xattr_names: sum of lengths of all extended attribute names belonging to 3521e51764aSArtem Bityutskiy * this inode 3531e51764aSArtem Bityutskiy * @dirty: non-zero if the inode is dirty 3541e51764aSArtem Bityutskiy * @xattr: non-zero if this is an extended attribute inode 355625bf371SArtem Bityutskiy * @bulk_read: non-zero if bulk-read should be used 3561e51764aSArtem Bityutskiy * @ui_mutex: serializes inode write-back with the rest of VFS operations, 3574793e7c5SAdrian Hunter * serializes "clean <-> dirty" state changes, serializes bulk-read, 358ba60ecabSArtem Bityutskiy * protects @dirty, @bulk_read, @ui_size, and @xattr_size 3591e51764aSArtem Bityutskiy * @ui_lock: protects @synced_i_size 3601e51764aSArtem Bityutskiy * @synced_i_size: synchronized size of inode, i.e. the value of inode size 3611e51764aSArtem Bityutskiy * currently stored on the flash; used only for regular file 3621e51764aSArtem Bityutskiy * inodes 3631e51764aSArtem Bityutskiy * @ui_size: inode size used by UBIFS when writing to flash 3641e51764aSArtem Bityutskiy * @flags: inode flags (@UBIFS_COMPR_FL, etc) 3651e51764aSArtem Bityutskiy * @compr_type: default compression type used for this inode 3664793e7c5SAdrian Hunter * @last_page_read: page number of last page read (for bulk read) 3674793e7c5SAdrian Hunter * @read_in_a_row: number of consecutive pages read in a row (for bulk read) 3681e51764aSArtem Bityutskiy * @data_len: length of the data attached to the inode 3691e51764aSArtem Bityutskiy * @data: inode's data 3701e51764aSArtem Bityutskiy * 3711e51764aSArtem Bityutskiy * @ui_mutex exists for two main reasons. At first it prevents inodes from 3721e51764aSArtem Bityutskiy * being written back while UBIFS changing them, being in the middle of an VFS 3731e51764aSArtem Bityutskiy * operation. This way UBIFS makes sure the inode fields are consistent. For 3741e51764aSArtem Bityutskiy * example, in 'ubifs_rename()' we change 3 inodes simultaneously, and 3751e51764aSArtem Bityutskiy * write-back must not write any of them before we have finished. 3761e51764aSArtem Bityutskiy * 3771e51764aSArtem Bityutskiy * The second reason is budgeting - UBIFS has to budget all operations. If an 3781e51764aSArtem Bityutskiy * operation is going to mark an inode dirty, it has to allocate budget for 3791e51764aSArtem Bityutskiy * this. It cannot just mark it dirty because there is no guarantee there will 3801e51764aSArtem Bityutskiy * be enough flash space to write the inode back later. This means UBIFS has 3811e51764aSArtem Bityutskiy * to have full control over inode "clean <-> dirty" transitions (and pages 3821e51764aSArtem Bityutskiy * actually). But unfortunately, VFS marks inodes dirty in many places, and it 3831e51764aSArtem Bityutskiy * does not ask the file-system if it is allowed to do so (there is a notifier, 3841e51764aSArtem Bityutskiy * but it is not enough), i.e., there is no mechanism to synchronize with this. 3851e51764aSArtem Bityutskiy * So UBIFS has its own inode dirty flag and its own mutex to serialize 3861e51764aSArtem Bityutskiy * "clean <-> dirty" transitions. 3871e51764aSArtem Bityutskiy * 3881e51764aSArtem Bityutskiy * The @synced_i_size field is used to make sure we never write pages which are 3891e51764aSArtem Bityutskiy * beyond last synchronized inode size. See 'ubifs_writepage()' for more 3901e51764aSArtem Bityutskiy * information. 3911e51764aSArtem Bityutskiy * 3921e51764aSArtem Bityutskiy * The @ui_size is a "shadow" variable for @inode->i_size and UBIFS uses 3931e51764aSArtem Bityutskiy * @ui_size instead of @inode->i_size. The reason for this is that UBIFS cannot 3941e51764aSArtem Bityutskiy * make sure @inode->i_size is always changed under @ui_mutex, because it 395c4361570SArtem Bityutskiy * cannot call 'truncate_setsize()' with @ui_mutex locked, because it would 396c4361570SArtem Bityutskiy * deadlock with 'ubifs_writepage()' (see file.c). All the other inode fields 397c4361570SArtem Bityutskiy * are changed under @ui_mutex, so they do not need "shadow" fields. Note, one 3981e51764aSArtem Bityutskiy * could consider to rework locking and base it on "shadow" fields. 3991e51764aSArtem Bityutskiy */ 4001e51764aSArtem Bityutskiy struct ubifs_inode { 4011e51764aSArtem Bityutskiy struct inode vfs_inode; 4021e51764aSArtem Bityutskiy unsigned long long creat_sqnum; 403de94eb55SArtem Bityutskiy unsigned long long del_cmtno; 4041e51764aSArtem Bityutskiy unsigned int xattr_size; 4051e51764aSArtem Bityutskiy unsigned int xattr_cnt; 4061e51764aSArtem Bityutskiy unsigned int xattr_names; 4071e51764aSArtem Bityutskiy unsigned int dirty:1; 4081e51764aSArtem Bityutskiy unsigned int xattr:1; 409625bf371SArtem Bityutskiy unsigned int bulk_read:1; 410a1dc080cSArtem Bityutskiy unsigned int compr_type:2; 4111e51764aSArtem Bityutskiy struct mutex ui_mutex; 4121e51764aSArtem Bityutskiy spinlock_t ui_lock; 4131e51764aSArtem Bityutskiy loff_t synced_i_size; 4141e51764aSArtem Bityutskiy loff_t ui_size; 4151e51764aSArtem Bityutskiy int flags; 4164793e7c5SAdrian Hunter pgoff_t last_page_read; 4174793e7c5SAdrian Hunter pgoff_t read_in_a_row; 4181e51764aSArtem Bityutskiy int data_len; 4191e51764aSArtem Bityutskiy void *data; 4201e51764aSArtem Bityutskiy }; 4211e51764aSArtem Bityutskiy 4221e51764aSArtem Bityutskiy /** 4231e51764aSArtem Bityutskiy * struct ubifs_unclean_leb - records a LEB recovered under read-only mode. 4241e51764aSArtem Bityutskiy * @list: list 4251e51764aSArtem Bityutskiy * @lnum: LEB number of recovered LEB 4261e51764aSArtem Bityutskiy * @endpt: offset where recovery ended 4271e51764aSArtem Bityutskiy * 4281e51764aSArtem Bityutskiy * This structure records a LEB identified during recovery that needs to be 4291e51764aSArtem Bityutskiy * cleaned but was not because UBIFS was mounted read-only. The information 4301e51764aSArtem Bityutskiy * is used to clean the LEB when remounting to read-write mode. 4311e51764aSArtem Bityutskiy */ 4321e51764aSArtem Bityutskiy struct ubifs_unclean_leb { 4331e51764aSArtem Bityutskiy struct list_head list; 4341e51764aSArtem Bityutskiy int lnum; 4351e51764aSArtem Bityutskiy int endpt; 4361e51764aSArtem Bityutskiy }; 4371e51764aSArtem Bityutskiy 4381e51764aSArtem Bityutskiy /* 4391e51764aSArtem Bityutskiy * LEB properties flags. 4401e51764aSArtem Bityutskiy * 4411e51764aSArtem Bityutskiy * LPROPS_UNCAT: not categorized 4427078202eSArtem Bityutskiy * LPROPS_DIRTY: dirty > free, dirty >= @c->dead_wm, not index 44321a60258SArtem Bityutskiy * LPROPS_DIRTY_IDX: dirty + free > @c->min_idx_node_sze and index 4447078202eSArtem Bityutskiy * LPROPS_FREE: free > 0, dirty < @c->dead_wm, not empty, not index 4451e51764aSArtem Bityutskiy * LPROPS_HEAP_CNT: number of heaps used for storing categorized LEBs 4461e51764aSArtem Bityutskiy * LPROPS_EMPTY: LEB is empty, not taken 4471e51764aSArtem Bityutskiy * LPROPS_FREEABLE: free + dirty == leb_size, not index, not taken 4481e51764aSArtem Bityutskiy * LPROPS_FRDI_IDX: free + dirty == leb_size and index, may be taken 4491e51764aSArtem Bityutskiy * LPROPS_CAT_MASK: mask for the LEB categories above 4501e51764aSArtem Bityutskiy * LPROPS_TAKEN: LEB was taken (this flag is not saved on the media) 4511e51764aSArtem Bityutskiy * LPROPS_INDEX: LEB contains indexing nodes (this flag also exists on flash) 4521e51764aSArtem Bityutskiy */ 4531e51764aSArtem Bityutskiy enum { 4541e51764aSArtem Bityutskiy LPROPS_UNCAT = 0, 4551e51764aSArtem Bityutskiy LPROPS_DIRTY = 1, 4561e51764aSArtem Bityutskiy LPROPS_DIRTY_IDX = 2, 4571e51764aSArtem Bityutskiy LPROPS_FREE = 3, 4581e51764aSArtem Bityutskiy LPROPS_HEAP_CNT = 3, 4591e51764aSArtem Bityutskiy LPROPS_EMPTY = 4, 4601e51764aSArtem Bityutskiy LPROPS_FREEABLE = 5, 4611e51764aSArtem Bityutskiy LPROPS_FRDI_IDX = 6, 4621e51764aSArtem Bityutskiy LPROPS_CAT_MASK = 15, 4631e51764aSArtem Bityutskiy LPROPS_TAKEN = 16, 4641e51764aSArtem Bityutskiy LPROPS_INDEX = 32, 4651e51764aSArtem Bityutskiy }; 4661e51764aSArtem Bityutskiy 4671e51764aSArtem Bityutskiy /** 4681e51764aSArtem Bityutskiy * struct ubifs_lprops - logical eraseblock properties. 4691e51764aSArtem Bityutskiy * @free: amount of free space in bytes 4701e51764aSArtem Bityutskiy * @dirty: amount of dirty space in bytes 4711e51764aSArtem Bityutskiy * @flags: LEB properties flags (see above) 4721e51764aSArtem Bityutskiy * @lnum: LEB number 4731e51764aSArtem Bityutskiy * @list: list of same-category lprops (for LPROPS_EMPTY and LPROPS_FREEABLE) 4741e51764aSArtem Bityutskiy * @hpos: heap position in heap of same-category lprops (other categories) 4751e51764aSArtem Bityutskiy */ 4761e51764aSArtem Bityutskiy struct ubifs_lprops { 4771e51764aSArtem Bityutskiy int free; 4781e51764aSArtem Bityutskiy int dirty; 4791e51764aSArtem Bityutskiy int flags; 4801e51764aSArtem Bityutskiy int lnum; 4811e51764aSArtem Bityutskiy union { 4821e51764aSArtem Bityutskiy struct list_head list; 4831e51764aSArtem Bityutskiy int hpos; 4841e51764aSArtem Bityutskiy }; 4851e51764aSArtem Bityutskiy }; 4861e51764aSArtem Bityutskiy 4871e51764aSArtem Bityutskiy /** 4881e51764aSArtem Bityutskiy * struct ubifs_lpt_lprops - LPT logical eraseblock properties. 4891e51764aSArtem Bityutskiy * @free: amount of free space in bytes 4901e51764aSArtem Bityutskiy * @dirty: amount of dirty space in bytes 4911e51764aSArtem Bityutskiy * @tgc: trivial GC flag (1 => unmap after commit end) 4921e51764aSArtem Bityutskiy * @cmt: commit flag (1 => reserved for commit) 4931e51764aSArtem Bityutskiy */ 4941e51764aSArtem Bityutskiy struct ubifs_lpt_lprops { 4951e51764aSArtem Bityutskiy int free; 4961e51764aSArtem Bityutskiy int dirty; 4971e51764aSArtem Bityutskiy unsigned tgc:1; 4981e51764aSArtem Bityutskiy unsigned cmt:1; 4991e51764aSArtem Bityutskiy }; 5001e51764aSArtem Bityutskiy 5011e51764aSArtem Bityutskiy /** 5021e51764aSArtem Bityutskiy * struct ubifs_lp_stats - statistics of eraseblocks in the main area. 5031e51764aSArtem Bityutskiy * @empty_lebs: number of empty LEBs 5041e51764aSArtem Bityutskiy * @taken_empty_lebs: number of taken LEBs 5051e51764aSArtem Bityutskiy * @idx_lebs: number of indexing LEBs 506d3cf502bSArtem Bityutskiy * @total_free: total free space in bytes (includes all LEBs) 507d3cf502bSArtem Bityutskiy * @total_dirty: total dirty space in bytes (includes all LEBs) 508d3cf502bSArtem Bityutskiy * @total_used: total used space in bytes (does not include index LEBs) 509d3cf502bSArtem Bityutskiy * @total_dead: total dead space in bytes (does not include index LEBs) 510d3cf502bSArtem Bityutskiy * @total_dark: total dark space in bytes (does not include index LEBs) 5111e51764aSArtem Bityutskiy * 512d3cf502bSArtem Bityutskiy * The @taken_empty_lebs field counts the LEBs that are in the transient state 513d3cf502bSArtem Bityutskiy * of having been "taken" for use but not yet written to. @taken_empty_lebs is 514d3cf502bSArtem Bityutskiy * needed to account correctly for @gc_lnum, otherwise @empty_lebs could be 515d3cf502bSArtem Bityutskiy * used by itself (in which case 'unused_lebs' would be a better name). In the 516d3cf502bSArtem Bityutskiy * case of @gc_lnum, it is "taken" at mount time or whenever a LEB is retained 517d3cf502bSArtem Bityutskiy * by GC, but unlike other empty LEBs that are "taken", it may not be written 518d3cf502bSArtem Bityutskiy * straight away (i.e. before the next commit start or unmount), so either 519d3cf502bSArtem Bityutskiy * @gc_lnum must be specially accounted for, or the current approach followed 520d3cf502bSArtem Bityutskiy * i.e. count it under @taken_empty_lebs. 5211e51764aSArtem Bityutskiy * 522d3cf502bSArtem Bityutskiy * @empty_lebs includes @taken_empty_lebs. 523d3cf502bSArtem Bityutskiy * 524d3cf502bSArtem Bityutskiy * @total_used, @total_dead and @total_dark fields do not account indexing 525d3cf502bSArtem Bityutskiy * LEBs. 5261e51764aSArtem Bityutskiy */ 5271e51764aSArtem Bityutskiy struct ubifs_lp_stats { 5281e51764aSArtem Bityutskiy int empty_lebs; 5291e51764aSArtem Bityutskiy int taken_empty_lebs; 5301e51764aSArtem Bityutskiy int idx_lebs; 5311e51764aSArtem Bityutskiy long long total_free; 5321e51764aSArtem Bityutskiy long long total_dirty; 5331e51764aSArtem Bityutskiy long long total_used; 5341e51764aSArtem Bityutskiy long long total_dead; 5351e51764aSArtem Bityutskiy long long total_dark; 5361e51764aSArtem Bityutskiy }; 5371e51764aSArtem Bityutskiy 5381e51764aSArtem Bityutskiy struct ubifs_nnode; 5391e51764aSArtem Bityutskiy 5401e51764aSArtem Bityutskiy /** 5411e51764aSArtem Bityutskiy * struct ubifs_cnode - LEB Properties Tree common node. 5421e51764aSArtem Bityutskiy * @parent: parent nnode 5431e51764aSArtem Bityutskiy * @cnext: next cnode to commit 5441e51764aSArtem Bityutskiy * @flags: flags (%DIRTY_LPT_NODE or %OBSOLETE_LPT_NODE) 5451e51764aSArtem Bityutskiy * @iip: index in parent 5461e51764aSArtem Bityutskiy * @level: level in the tree (zero for pnodes, greater than zero for nnodes) 5471e51764aSArtem Bityutskiy * @num: node number 5481e51764aSArtem Bityutskiy */ 5491e51764aSArtem Bityutskiy struct ubifs_cnode { 5501e51764aSArtem Bityutskiy struct ubifs_nnode *parent; 5511e51764aSArtem Bityutskiy struct ubifs_cnode *cnext; 5521e51764aSArtem Bityutskiy unsigned long flags; 5531e51764aSArtem Bityutskiy int iip; 5541e51764aSArtem Bityutskiy int level; 5551e51764aSArtem Bityutskiy int num; 5561e51764aSArtem Bityutskiy }; 5571e51764aSArtem Bityutskiy 5581e51764aSArtem Bityutskiy /** 5591e51764aSArtem Bityutskiy * struct ubifs_pnode - LEB Properties Tree leaf node. 5601e51764aSArtem Bityutskiy * @parent: parent nnode 5611e51764aSArtem Bityutskiy * @cnext: next cnode to commit 5621e51764aSArtem Bityutskiy * @flags: flags (%DIRTY_LPT_NODE or %OBSOLETE_LPT_NODE) 5631e51764aSArtem Bityutskiy * @iip: index in parent 5641e51764aSArtem Bityutskiy * @level: level in the tree (always zero for pnodes) 5651e51764aSArtem Bityutskiy * @num: node number 5661e51764aSArtem Bityutskiy * @lprops: LEB properties array 5671e51764aSArtem Bityutskiy */ 5681e51764aSArtem Bityutskiy struct ubifs_pnode { 5691e51764aSArtem Bityutskiy struct ubifs_nnode *parent; 5701e51764aSArtem Bityutskiy struct ubifs_cnode *cnext; 5711e51764aSArtem Bityutskiy unsigned long flags; 5721e51764aSArtem Bityutskiy int iip; 5731e51764aSArtem Bityutskiy int level; 5741e51764aSArtem Bityutskiy int num; 5751e51764aSArtem Bityutskiy struct ubifs_lprops lprops[UBIFS_LPT_FANOUT]; 5761e51764aSArtem Bityutskiy }; 5771e51764aSArtem Bityutskiy 5781e51764aSArtem Bityutskiy /** 5791e51764aSArtem Bityutskiy * struct ubifs_nbranch - LEB Properties Tree internal node branch. 5801e51764aSArtem Bityutskiy * @lnum: LEB number of child 5811e51764aSArtem Bityutskiy * @offs: offset of child 5821e51764aSArtem Bityutskiy * @nnode: nnode child 5831e51764aSArtem Bityutskiy * @pnode: pnode child 5841e51764aSArtem Bityutskiy * @cnode: cnode child 5851e51764aSArtem Bityutskiy */ 5861e51764aSArtem Bityutskiy struct ubifs_nbranch { 5871e51764aSArtem Bityutskiy int lnum; 5881e51764aSArtem Bityutskiy int offs; 5891e51764aSArtem Bityutskiy union { 5901e51764aSArtem Bityutskiy struct ubifs_nnode *nnode; 5911e51764aSArtem Bityutskiy struct ubifs_pnode *pnode; 5921e51764aSArtem Bityutskiy struct ubifs_cnode *cnode; 5931e51764aSArtem Bityutskiy }; 5941e51764aSArtem Bityutskiy }; 5951e51764aSArtem Bityutskiy 5961e51764aSArtem Bityutskiy /** 5971e51764aSArtem Bityutskiy * struct ubifs_nnode - LEB Properties Tree internal node. 5981e51764aSArtem Bityutskiy * @parent: parent nnode 5991e51764aSArtem Bityutskiy * @cnext: next cnode to commit 6001e51764aSArtem Bityutskiy * @flags: flags (%DIRTY_LPT_NODE or %OBSOLETE_LPT_NODE) 6011e51764aSArtem Bityutskiy * @iip: index in parent 6021e51764aSArtem Bityutskiy * @level: level in the tree (always greater than zero for nnodes) 6031e51764aSArtem Bityutskiy * @num: node number 6041e51764aSArtem Bityutskiy * @nbranch: branches to child nodes 6051e51764aSArtem Bityutskiy */ 6061e51764aSArtem Bityutskiy struct ubifs_nnode { 6071e51764aSArtem Bityutskiy struct ubifs_nnode *parent; 6081e51764aSArtem Bityutskiy struct ubifs_cnode *cnext; 6091e51764aSArtem Bityutskiy unsigned long flags; 6101e51764aSArtem Bityutskiy int iip; 6111e51764aSArtem Bityutskiy int level; 6121e51764aSArtem Bityutskiy int num; 6131e51764aSArtem Bityutskiy struct ubifs_nbranch nbranch[UBIFS_LPT_FANOUT]; 6141e51764aSArtem Bityutskiy }; 6151e51764aSArtem Bityutskiy 6161e51764aSArtem Bityutskiy /** 6171e51764aSArtem Bityutskiy * struct ubifs_lpt_heap - heap of categorized lprops. 6181e51764aSArtem Bityutskiy * @arr: heap array 6191e51764aSArtem Bityutskiy * @cnt: number in heap 6201e51764aSArtem Bityutskiy * @max_cnt: maximum number allowed in heap 6211e51764aSArtem Bityutskiy * 6221e51764aSArtem Bityutskiy * There are %LPROPS_HEAP_CNT heaps. 6231e51764aSArtem Bityutskiy */ 6241e51764aSArtem Bityutskiy struct ubifs_lpt_heap { 6251e51764aSArtem Bityutskiy struct ubifs_lprops **arr; 6261e51764aSArtem Bityutskiy int cnt; 6271e51764aSArtem Bityutskiy int max_cnt; 6281e51764aSArtem Bityutskiy }; 6291e51764aSArtem Bityutskiy 6301e51764aSArtem Bityutskiy /* 6311e51764aSArtem Bityutskiy * Return codes for LPT scan callback function. 6321e51764aSArtem Bityutskiy * 6331e51764aSArtem Bityutskiy * LPT_SCAN_CONTINUE: continue scanning 6341e51764aSArtem Bityutskiy * LPT_SCAN_ADD: add the LEB properties scanned to the tree in memory 6351e51764aSArtem Bityutskiy * LPT_SCAN_STOP: stop scanning 6361e51764aSArtem Bityutskiy */ 6371e51764aSArtem Bityutskiy enum { 6381e51764aSArtem Bityutskiy LPT_SCAN_CONTINUE = 0, 6391e51764aSArtem Bityutskiy LPT_SCAN_ADD = 1, 6401e51764aSArtem Bityutskiy LPT_SCAN_STOP = 2, 6411e51764aSArtem Bityutskiy }; 6421e51764aSArtem Bityutskiy 6431e51764aSArtem Bityutskiy struct ubifs_info; 6441e51764aSArtem Bityutskiy 6451e51764aSArtem Bityutskiy /* Callback used by the 'ubifs_lpt_scan_nolock()' function */ 6461e51764aSArtem Bityutskiy typedef int (*ubifs_lpt_scan_callback)(struct ubifs_info *c, 6471e51764aSArtem Bityutskiy const struct ubifs_lprops *lprops, 6481e51764aSArtem Bityutskiy int in_tree, void *data); 6491e51764aSArtem Bityutskiy 6501e51764aSArtem Bityutskiy /** 6511e51764aSArtem Bityutskiy * struct ubifs_wbuf - UBIFS write-buffer. 6521e51764aSArtem Bityutskiy * @c: UBIFS file-system description object 6531e51764aSArtem Bityutskiy * @buf: write-buffer (of min. flash I/O unit size) 6541e51764aSArtem Bityutskiy * @lnum: logical eraseblock number the write-buffer points to 6551e51764aSArtem Bityutskiy * @offs: write-buffer offset in this logical eraseblock 6561e51764aSArtem Bityutskiy * @avail: number of bytes available in the write-buffer 6571e51764aSArtem Bityutskiy * @used: number of used bytes in the write-buffer 6583c89f396SArtem Bityutskiy * @size: write-buffer size (in [@c->min_io_size, @c->max_write_size] range) 6591e51764aSArtem Bityutskiy * @jhead: journal head the mutex belongs to (note, needed only to shut lockdep 6601e51764aSArtem Bityutskiy * up by 'mutex_lock_nested()). 6611e51764aSArtem Bityutskiy * @sync_callback: write-buffer synchronization callback 6621e51764aSArtem Bityutskiy * @io_mutex: serializes write-buffer I/O 6631e51764aSArtem Bityutskiy * @lock: serializes @buf, @lnum, @offs, @avail, @used, @next_ino and @inodes 6641e51764aSArtem Bityutskiy * fields 6651e51764aSArtem Bityutskiy * @timer: write-buffer timer 666681947d2SAdrian Hunter * @no_timer: non-zero if this write-buffer does not have a timer 667681947d2SAdrian Hunter * @need_sync: non-zero if the timer expired and the wbuf needs sync'ing 6681e51764aSArtem Bityutskiy * @next_ino: points to the next position of the following inode number 6691e51764aSArtem Bityutskiy * @inodes: stores the inode numbers of the nodes which are in wbuf 6701e51764aSArtem Bityutskiy * 6711e51764aSArtem Bityutskiy * The write-buffer synchronization callback is called when the write-buffer is 6721e51764aSArtem Bityutskiy * synchronized in order to notify how much space was wasted due to 6731e51764aSArtem Bityutskiy * write-buffer padding and how much free space is left in the LEB. 6741e51764aSArtem Bityutskiy * 6751e51764aSArtem Bityutskiy * Note: the fields @buf, @lnum, @offs, @avail and @used can be read under 6761e51764aSArtem Bityutskiy * spin-lock or mutex because they are written under both mutex and spin-lock. 6771e51764aSArtem Bityutskiy * @buf is appended to under mutex but overwritten under both mutex and 6781e51764aSArtem Bityutskiy * spin-lock. Thus the data between @buf and @buf + @used can be read under 6791e51764aSArtem Bityutskiy * spinlock. 6801e51764aSArtem Bityutskiy */ 6811e51764aSArtem Bityutskiy struct ubifs_wbuf { 6821e51764aSArtem Bityutskiy struct ubifs_info *c; 6831e51764aSArtem Bityutskiy void *buf; 6841e51764aSArtem Bityutskiy int lnum; 6851e51764aSArtem Bityutskiy int offs; 6861e51764aSArtem Bityutskiy int avail; 6871e51764aSArtem Bityutskiy int used; 6883c89f396SArtem Bityutskiy int size; 6891e51764aSArtem Bityutskiy int jhead; 6901e51764aSArtem Bityutskiy int (*sync_callback)(struct ubifs_info *c, int lnum, int free, int pad); 6911e51764aSArtem Bityutskiy struct mutex io_mutex; 6921e51764aSArtem Bityutskiy spinlock_t lock; 693f2c5dbd7SArtem Bityutskiy struct hrtimer timer; 6940b335b9dSArtem Bityutskiy unsigned int no_timer:1; 6950b335b9dSArtem Bityutskiy unsigned int need_sync:1; 6961e51764aSArtem Bityutskiy int next_ino; 6971e51764aSArtem Bityutskiy ino_t *inodes; 6981e51764aSArtem Bityutskiy }; 6991e51764aSArtem Bityutskiy 7001e51764aSArtem Bityutskiy /** 7011e51764aSArtem Bityutskiy * struct ubifs_bud - bud logical eraseblock. 7021e51764aSArtem Bityutskiy * @lnum: logical eraseblock number 7031e51764aSArtem Bityutskiy * @start: where the (uncommitted) bud data starts 7041e51764aSArtem Bityutskiy * @jhead: journal head number this bud belongs to 7051e51764aSArtem Bityutskiy * @list: link in the list buds belonging to the same journal head 7061e51764aSArtem Bityutskiy * @rb: link in the tree of all buds 7076a98bc46SSascha Hauer * @log_hash: the log hash from the commit start node up to this bud 7081e51764aSArtem Bityutskiy */ 7091e51764aSArtem Bityutskiy struct ubifs_bud { 7101e51764aSArtem Bityutskiy int lnum; 7111e51764aSArtem Bityutskiy int start; 7121e51764aSArtem Bityutskiy int jhead; 7131e51764aSArtem Bityutskiy struct list_head list; 7141e51764aSArtem Bityutskiy struct rb_node rb; 7156a98bc46SSascha Hauer struct shash_desc *log_hash; 7161e51764aSArtem Bityutskiy }; 7171e51764aSArtem Bityutskiy 7181e51764aSArtem Bityutskiy /** 7191e51764aSArtem Bityutskiy * struct ubifs_jhead - journal head. 7201e51764aSArtem Bityutskiy * @wbuf: head's write-buffer 7211e51764aSArtem Bityutskiy * @buds_list: list of bud LEBs belonging to this journal head 7221a0b0699SArtem Bityutskiy * @grouped: non-zero if UBIFS groups nodes when writing to this journal head 7236a98bc46SSascha Hauer * @log_hash: the log hash from the commit start node up to this journal head 7241e51764aSArtem Bityutskiy * 7251e51764aSArtem Bityutskiy * Note, the @buds list is protected by the @c->buds_lock. 7261e51764aSArtem Bityutskiy */ 7271e51764aSArtem Bityutskiy struct ubifs_jhead { 7281e51764aSArtem Bityutskiy struct ubifs_wbuf wbuf; 7291e51764aSArtem Bityutskiy struct list_head buds_list; 7301a0b0699SArtem Bityutskiy unsigned int grouped:1; 7316a98bc46SSascha Hauer struct shash_desc *log_hash; 7321e51764aSArtem Bityutskiy }; 7331e51764aSArtem Bityutskiy 7341e51764aSArtem Bityutskiy /** 7351e51764aSArtem Bityutskiy * struct ubifs_zbranch - key/coordinate/length branch stored in znodes. 7361e51764aSArtem Bityutskiy * @key: key 7371e51764aSArtem Bityutskiy * @znode: znode address in memory 738be61678bSArtem Bityutskiy * @lnum: LEB number of the target node (indexing node or data node) 739be61678bSArtem Bityutskiy * @offs: target node offset within @lnum 7401e51764aSArtem Bityutskiy * @len: target node length 741823838a4SSascha Hauer * @hash: the hash of the target node 7421e51764aSArtem Bityutskiy */ 7431e51764aSArtem Bityutskiy struct ubifs_zbranch { 7441e51764aSArtem Bityutskiy union ubifs_key key; 7451e51764aSArtem Bityutskiy union { 7461e51764aSArtem Bityutskiy struct ubifs_znode *znode; 7471e51764aSArtem Bityutskiy void *leaf; 7481e51764aSArtem Bityutskiy }; 7491e51764aSArtem Bityutskiy int lnum; 7501e51764aSArtem Bityutskiy int offs; 7511e51764aSArtem Bityutskiy int len; 752823838a4SSascha Hauer u8 hash[UBIFS_HASH_ARR_SZ]; 7531e51764aSArtem Bityutskiy }; 7541e51764aSArtem Bityutskiy 7551e51764aSArtem Bityutskiy /** 7561e51764aSArtem Bityutskiy * struct ubifs_znode - in-memory representation of an indexing node. 7571e51764aSArtem Bityutskiy * @parent: parent znode or NULL if it is the root 7581e51764aSArtem Bityutskiy * @cnext: next znode to commit 75916a26b20SSascha Hauer * @cparent: parent node for this commit 76016a26b20SSascha Hauer * @ciip: index in cparent's zbranch array 7611e51764aSArtem Bityutskiy * @flags: znode flags (%DIRTY_ZNODE, %COW_ZNODE or %OBSOLETE_ZNODE) 7621e51764aSArtem Bityutskiy * @time: last access time (seconds) 7631e51764aSArtem Bityutskiy * @level: level of the entry in the TNC tree 7641e51764aSArtem Bityutskiy * @child_cnt: count of child znodes 7651e51764aSArtem Bityutskiy * @iip: index in parent's zbranch array 7661e51764aSArtem Bityutskiy * @alt: lower bound of key range has altered i.e. child inserted at slot 0 7671e51764aSArtem Bityutskiy * @lnum: LEB number of the corresponding indexing node 7681e51764aSArtem Bityutskiy * @offs: offset of the corresponding indexing node 7691e51764aSArtem Bityutskiy * @len: length of the corresponding indexing node 7701e51764aSArtem Bityutskiy * @zbranch: array of znode branches (@c->fanout elements) 771f70b7e52SArtem Bityutskiy * 772f70b7e52SArtem Bityutskiy * Note! The @lnum, @offs, and @len fields are not really needed - we have them 773f70b7e52SArtem Bityutskiy * only for internal consistency check. They could be removed to save some RAM. 7741e51764aSArtem Bityutskiy */ 7751e51764aSArtem Bityutskiy struct ubifs_znode { 7761e51764aSArtem Bityutskiy struct ubifs_znode *parent; 7771e51764aSArtem Bityutskiy struct ubifs_znode *cnext; 77816a26b20SSascha Hauer struct ubifs_znode *cparent; 77916a26b20SSascha Hauer int ciip; 7801e51764aSArtem Bityutskiy unsigned long flags; 7816cff5732SArnd Bergmann time64_t time; 7821e51764aSArtem Bityutskiy int level; 7831e51764aSArtem Bityutskiy int child_cnt; 7841e51764aSArtem Bityutskiy int iip; 7851e51764aSArtem Bityutskiy int alt; 786f70b7e52SArtem Bityutskiy int lnum; 787f70b7e52SArtem Bityutskiy int offs; 788f70b7e52SArtem Bityutskiy int len; 7891e51764aSArtem Bityutskiy struct ubifs_zbranch zbranch[]; 7901e51764aSArtem Bityutskiy }; 7911e51764aSArtem Bityutskiy 7921e51764aSArtem Bityutskiy /** 79339ce81ceSArtem Bityutskiy * struct bu_info - bulk-read information. 7944793e7c5SAdrian Hunter * @key: first data node key 7954793e7c5SAdrian Hunter * @zbranch: zbranches of data nodes to bulk read 7964793e7c5SAdrian Hunter * @buf: buffer to read into 7974793e7c5SAdrian Hunter * @buf_len: buffer length 7984793e7c5SAdrian Hunter * @gc_seq: GC sequence number to detect races with GC 7994793e7c5SAdrian Hunter * @cnt: number of data nodes for bulk read 8004793e7c5SAdrian Hunter * @blk_cnt: number of data blocks including holes 8014793e7c5SAdrian Hunter * @oef: end of file reached 8024793e7c5SAdrian Hunter */ 8034793e7c5SAdrian Hunter struct bu_info { 8044793e7c5SAdrian Hunter union ubifs_key key; 8054793e7c5SAdrian Hunter struct ubifs_zbranch zbranch[UBIFS_MAX_BULK_READ]; 8064793e7c5SAdrian Hunter void *buf; 8074793e7c5SAdrian Hunter int buf_len; 8084793e7c5SAdrian Hunter int gc_seq; 8094793e7c5SAdrian Hunter int cnt; 8104793e7c5SAdrian Hunter int blk_cnt; 8114793e7c5SAdrian Hunter int eof; 8124793e7c5SAdrian Hunter }; 8134793e7c5SAdrian Hunter 8144793e7c5SAdrian Hunter /** 8151e51764aSArtem Bityutskiy * struct ubifs_node_range - node length range description data structure. 8161e51764aSArtem Bityutskiy * @len: fixed node length 8171e51764aSArtem Bityutskiy * @min_len: minimum possible node length 8181e51764aSArtem Bityutskiy * @max_len: maximum possible node length 8191e51764aSArtem Bityutskiy * 8201e51764aSArtem Bityutskiy * If @max_len is %0, the node has fixed length @len. 8211e51764aSArtem Bityutskiy */ 8221e51764aSArtem Bityutskiy struct ubifs_node_range { 8231e51764aSArtem Bityutskiy union { 8241e51764aSArtem Bityutskiy int len; 8251e51764aSArtem Bityutskiy int min_len; 8261e51764aSArtem Bityutskiy }; 8271e51764aSArtem Bityutskiy int max_len; 8281e51764aSArtem Bityutskiy }; 8291e51764aSArtem Bityutskiy 8301e51764aSArtem Bityutskiy /** 8311e51764aSArtem Bityutskiy * struct ubifs_compressor - UBIFS compressor description structure. 8321e51764aSArtem Bityutskiy * @compr_type: compressor type (%UBIFS_COMPR_LZO, etc) 8331e51764aSArtem Bityutskiy * @cc: cryptoapi compressor handle 8341e51764aSArtem Bityutskiy * @comp_mutex: mutex used during compression 8351e51764aSArtem Bityutskiy * @decomp_mutex: mutex used during decompression 8361e51764aSArtem Bityutskiy * @name: compressor name 8371e51764aSArtem Bityutskiy * @capi_name: cryptoapi compressor name 8381e51764aSArtem Bityutskiy */ 8391e51764aSArtem Bityutskiy struct ubifs_compressor { 8401e51764aSArtem Bityutskiy int compr_type; 8411e51764aSArtem Bityutskiy struct crypto_comp *cc; 8421e51764aSArtem Bityutskiy struct mutex *comp_mutex; 8431e51764aSArtem Bityutskiy struct mutex *decomp_mutex; 8441e51764aSArtem Bityutskiy const char *name; 8451e51764aSArtem Bityutskiy const char *capi_name; 8461e51764aSArtem Bityutskiy }; 8471e51764aSArtem Bityutskiy 8481e51764aSArtem Bityutskiy /** 8491e51764aSArtem Bityutskiy * struct ubifs_budget_req - budget requirements of an operation. 8501e51764aSArtem Bityutskiy * 851de94eb55SArtem Bityutskiy * @fast: non-zero if the budgeting should try to acquire budget quickly and 8521e51764aSArtem Bityutskiy * should not try to call write-back 8531e51764aSArtem Bityutskiy * @recalculate: non-zero if @idx_growth, @data_growth, and @dd_growth fields 8541e51764aSArtem Bityutskiy * have to be re-calculated 8551e51764aSArtem Bityutskiy * @new_page: non-zero if the operation adds a new page 8561e51764aSArtem Bityutskiy * @dirtied_page: non-zero if the operation makes a page dirty 8571e51764aSArtem Bityutskiy * @new_dent: non-zero if the operation adds a new directory entry 8581e51764aSArtem Bityutskiy * @mod_dent: non-zero if the operation removes or modifies an existing 8591e51764aSArtem Bityutskiy * directory entry 8601e51764aSArtem Bityutskiy * @new_ino: non-zero if the operation adds a new inode 8617d25b361SDongsheng Yang * @new_ino_d: how much data newly created inode contains 8621e51764aSArtem Bityutskiy * @dirtied_ino: how many inodes the operation makes dirty 8637d25b361SDongsheng Yang * @dirtied_ino_d: how much data dirtied inode contains 8641e51764aSArtem Bityutskiy * @idx_growth: how much the index will supposedly grow 8651e51764aSArtem Bityutskiy * @data_growth: how much new data the operation will supposedly add 8661e51764aSArtem Bityutskiy * @dd_growth: how much data that makes other data dirty the operation will 8671e51764aSArtem Bityutskiy * supposedly add 8681e51764aSArtem Bityutskiy * 8691e51764aSArtem Bityutskiy * @idx_growth, @data_growth and @dd_growth are not used in budget request. The 8701e51764aSArtem Bityutskiy * budgeting subsystem caches index and data growth values there to avoid 8711e51764aSArtem Bityutskiy * re-calculating them when the budget is released. However, if @idx_growth is 8721e51764aSArtem Bityutskiy * %-1, it is calculated by the release function using other fields. 8731e51764aSArtem Bityutskiy * 8741e51764aSArtem Bityutskiy * An inode may contain 4KiB of data at max., thus the widths of @new_ino_d 8751e51764aSArtem Bityutskiy * is 13 bits, and @dirtied_ino_d - 15, because up to 4 inodes may be made 8761e51764aSArtem Bityutskiy * dirty by the re-name operation. 877dab4b4d2SArtem Bityutskiy * 878dab4b4d2SArtem Bityutskiy * Note, UBIFS aligns node lengths to 8-bytes boundary, so the requester has to 879dab4b4d2SArtem Bityutskiy * make sure the amount of inode data which contribute to @new_ino_d and 880dab4b4d2SArtem Bityutskiy * @dirtied_ino_d fields are aligned. 8811e51764aSArtem Bityutskiy */ 8821e51764aSArtem Bityutskiy struct ubifs_budget_req { 8831e51764aSArtem Bityutskiy unsigned int fast:1; 8841e51764aSArtem Bityutskiy unsigned int recalculate:1; 885547000daSArtem Bityutskiy #ifndef UBIFS_DEBUG 8861e51764aSArtem Bityutskiy unsigned int new_page:1; 8871e51764aSArtem Bityutskiy unsigned int dirtied_page:1; 8881e51764aSArtem Bityutskiy unsigned int new_dent:1; 8891e51764aSArtem Bityutskiy unsigned int mod_dent:1; 8901e51764aSArtem Bityutskiy unsigned int new_ino:1; 8911e51764aSArtem Bityutskiy unsigned int new_ino_d:13; 8921e51764aSArtem Bityutskiy unsigned int dirtied_ino:4; 8931e51764aSArtem Bityutskiy unsigned int dirtied_ino_d:15; 8941e51764aSArtem Bityutskiy #else 8951e51764aSArtem Bityutskiy /* Not bit-fields to check for overflows */ 896547000daSArtem Bityutskiy unsigned int new_page; 897547000daSArtem Bityutskiy unsigned int dirtied_page; 898547000daSArtem Bityutskiy unsigned int new_dent; 899547000daSArtem Bityutskiy unsigned int mod_dent; 900547000daSArtem Bityutskiy unsigned int new_ino; 901547000daSArtem Bityutskiy unsigned int new_ino_d; 9021e51764aSArtem Bityutskiy unsigned int dirtied_ino; 9031e51764aSArtem Bityutskiy unsigned int dirtied_ino_d; 9041e51764aSArtem Bityutskiy #endif 9051e51764aSArtem Bityutskiy int idx_growth; 9061e51764aSArtem Bityutskiy int data_growth; 9071e51764aSArtem Bityutskiy int dd_growth; 9081e51764aSArtem Bityutskiy }; 9091e51764aSArtem Bityutskiy 9101e51764aSArtem Bityutskiy /** 9111e51764aSArtem Bityutskiy * struct ubifs_orphan - stores the inode number of an orphan. 9121e51764aSArtem Bityutskiy * @rb: rb-tree node of rb-tree of orphans sorted by inode number 9131e51764aSArtem Bityutskiy * @list: list head of list of orphans in order added 9141e51764aSArtem Bityutskiy * @new_list: list head of list of orphans added since the last commit 915988bec41SRichard Weinberger * @child_list: list of xattr childs if this orphan hosts xattrs, list head 916988bec41SRichard Weinberger * if this orphan is a xattr, not used otherwise. 9171e51764aSArtem Bityutskiy * @cnext: next orphan to commit 9181e51764aSArtem Bityutskiy * @dnext: next orphan to delete 9191e51764aSArtem Bityutskiy * @inum: inode number 9201e51764aSArtem Bityutskiy * @new: %1 => added since the last commit, otherwise %0 9212928f0d0SAdam Thomas * @cmt: %1 => commit pending, otherwise %0 9228afd500cSAdam Thomas * @del: %1 => delete pending, otherwise %0 9231e51764aSArtem Bityutskiy */ 9241e51764aSArtem Bityutskiy struct ubifs_orphan { 9251e51764aSArtem Bityutskiy struct rb_node rb; 9261e51764aSArtem Bityutskiy struct list_head list; 9271e51764aSArtem Bityutskiy struct list_head new_list; 928988bec41SRichard Weinberger struct list_head child_list; 9291e51764aSArtem Bityutskiy struct ubifs_orphan *cnext; 9301e51764aSArtem Bityutskiy struct ubifs_orphan *dnext; 9311e51764aSArtem Bityutskiy ino_t inum; 9322928f0d0SAdam Thomas unsigned new:1; 9332928f0d0SAdam Thomas unsigned cmt:1; 9348afd500cSAdam Thomas unsigned del:1; 9351e51764aSArtem Bityutskiy }; 9361e51764aSArtem Bityutskiy 9371e51764aSArtem Bityutskiy /** 9381e51764aSArtem Bityutskiy * struct ubifs_mount_opts - UBIFS-specific mount options information. 9391e51764aSArtem Bityutskiy * @unmount_mode: selected unmount mode (%0 default, %1 normal, %2 fast) 940d3f9db00SYannick Guerrini * @bulk_read: enable/disable bulk-reads (%0 default, %1 disable, %2 enable) 941553dea4dSArtem Bityutskiy * @chk_data_crc: enable/disable CRC data checking when reading data nodes 942d3f9db00SYannick Guerrini * (%0 default, %1 disable, %2 enable) 943553dea4dSArtem Bityutskiy * @override_compr: override default compressor (%0 - do not override and use 944553dea4dSArtem Bityutskiy * superblock compressor, %1 - override and use compressor 945553dea4dSArtem Bityutskiy * specified in @compr_type) 946553dea4dSArtem Bityutskiy * @compr_type: compressor type to override the superblock compressor with 947553dea4dSArtem Bityutskiy * (%UBIFS_COMPR_NONE, etc) 9481e51764aSArtem Bityutskiy */ 9491e51764aSArtem Bityutskiy struct ubifs_mount_opts { 9501e51764aSArtem Bityutskiy unsigned int unmount_mode:2; 9514793e7c5SAdrian Hunter unsigned int bulk_read:2; 9522953e73fSAdrian Hunter unsigned int chk_data_crc:2; 953553dea4dSArtem Bityutskiy unsigned int override_compr:1; 954553dea4dSArtem Bityutskiy unsigned int compr_type:2; 9551e51764aSArtem Bityutskiy }; 9561e51764aSArtem Bityutskiy 957b137545cSArtem Bityutskiy /** 958b137545cSArtem Bityutskiy * struct ubifs_budg_info - UBIFS budgeting information. 959b137545cSArtem Bityutskiy * @idx_growth: amount of bytes budgeted for index growth 960b137545cSArtem Bityutskiy * @data_growth: amount of bytes budgeted for cached data 961b137545cSArtem Bityutskiy * @dd_growth: amount of bytes budgeted for cached data that will make 962b137545cSArtem Bityutskiy * other data dirty 963b137545cSArtem Bityutskiy * @uncommitted_idx: amount of bytes were budgeted for growth of the index, but 964b137545cSArtem Bityutskiy * which still have to be taken into account because the index 965b137545cSArtem Bityutskiy * has not been committed so far 966b137545cSArtem Bityutskiy * @old_idx_sz: size of index on flash 967b137545cSArtem Bityutskiy * @min_idx_lebs: minimum number of LEBs required for the index 968b137545cSArtem Bityutskiy * @nospace: non-zero if the file-system does not have flash space (used as 969b137545cSArtem Bityutskiy * optimization) 970b137545cSArtem Bityutskiy * @nospace_rp: the same as @nospace, but additionally means that even reserved 971b137545cSArtem Bityutskiy * pool is full 972d3f9db00SYannick Guerrini * @page_budget: budget for a page (constant, never changed after mount) 973d3f9db00SYannick Guerrini * @inode_budget: budget for an inode (constant, never changed after mount) 974d3f9db00SYannick Guerrini * @dent_budget: budget for a directory entry (constant, never changed after 975b137545cSArtem Bityutskiy * mount) 976b137545cSArtem Bityutskiy */ 977b137545cSArtem Bityutskiy struct ubifs_budg_info { 978b137545cSArtem Bityutskiy long long idx_growth; 979b137545cSArtem Bityutskiy long long data_growth; 980b137545cSArtem Bityutskiy long long dd_growth; 981b137545cSArtem Bityutskiy long long uncommitted_idx; 982b137545cSArtem Bityutskiy unsigned long long old_idx_sz; 983b137545cSArtem Bityutskiy int min_idx_lebs; 984b137545cSArtem Bityutskiy unsigned int nospace:1; 985b137545cSArtem Bityutskiy unsigned int nospace_rp:1; 986b137545cSArtem Bityutskiy int page_budget; 987b137545cSArtem Bityutskiy int inode_budget; 988b137545cSArtem Bityutskiy int dent_budget; 989b137545cSArtem Bityutskiy }; 990b137545cSArtem Bityutskiy 99117c2f9f8SArtem Bityutskiy struct ubifs_debug_info; 99217c2f9f8SArtem Bityutskiy 9931e51764aSArtem Bityutskiy /** 9941e51764aSArtem Bityutskiy * struct ubifs_info - UBIFS file-system description data structure 9951e51764aSArtem Bityutskiy * (per-superblock). 9961e51764aSArtem Bityutskiy * @vfs_sb: VFS @struct super_block object 997fd615005SSascha Hauer * @sup_node: The super block node as read from the device 9981e51764aSArtem Bityutskiy * 9991e51764aSArtem Bityutskiy * @highest_inum: highest used inode number 10001e51764aSArtem Bityutskiy * @max_sqnum: current global sequence number 1001014eb04bSArtem Bityutskiy * @cmt_no: commit number of the last successfully completed commit, protected 1002014eb04bSArtem Bityutskiy * by @commit_sem 100381ffa38eSAdrian Hunter * @cnt_lock: protects @highest_inum and @max_sqnum counters 10041e51764aSArtem Bityutskiy * @fmt_version: UBIFS on-flash format version 1005963f0cf6SArtem Bityutskiy * @ro_compat_version: R/O compatibility version 10061e51764aSArtem Bityutskiy * @uuid: UUID from super block 10071e51764aSArtem Bityutskiy * 10081e51764aSArtem Bityutskiy * @lhead_lnum: log head logical eraseblock number 10091e51764aSArtem Bityutskiy * @lhead_offs: log head offset 10101e51764aSArtem Bityutskiy * @ltail_lnum: log tail logical eraseblock number (offset is always 0) 10111e51764aSArtem Bityutskiy * @log_mutex: protects the log, @lhead_lnum, @lhead_offs, @ltail_lnum, and 10121e51764aSArtem Bityutskiy * @bud_bytes 10131e51764aSArtem Bityutskiy * @min_log_bytes: minimum required number of bytes in the log 10141e51764aSArtem Bityutskiy * @cmt_bud_bytes: used during commit to temporarily amount of bytes in 10151e51764aSArtem Bityutskiy * committed buds 10161e51764aSArtem Bityutskiy * 10171e51764aSArtem Bityutskiy * @buds: tree of all buds indexed by bud LEB number 10181e51764aSArtem Bityutskiy * @bud_bytes: how many bytes of flash is used by buds 10191e51764aSArtem Bityutskiy * @buds_lock: protects the @buds tree, @bud_bytes, and per-journal head bud 10201e51764aSArtem Bityutskiy * lists 10211e51764aSArtem Bityutskiy * @jhead_cnt: count of journal heads 10221e51764aSArtem Bityutskiy * @jheads: journal heads (head zero is base head) 10231e51764aSArtem Bityutskiy * @max_bud_bytes: maximum number of bytes allowed in buds 10241e51764aSArtem Bityutskiy * @bg_bud_bytes: number of bud bytes when background commit is initiated 10251e51764aSArtem Bityutskiy * @old_buds: buds to be released after commit ends 10261e51764aSArtem Bityutskiy * @max_bud_cnt: maximum number of buds 10271e51764aSArtem Bityutskiy * 10281e51764aSArtem Bityutskiy * @commit_sem: synchronizes committer with other processes 10291e51764aSArtem Bityutskiy * @cmt_state: commit state 10301e51764aSArtem Bityutskiy * @cs_lock: commit state lock 10311e51764aSArtem Bityutskiy * @cmt_wq: wait queue to sleep on if the log is full and a commit is running 1032625bf371SArtem Bityutskiy * 10331e51764aSArtem Bityutskiy * @big_lpt: flag that LPT is too big to write whole during commit 10349f58d350SMatthew L. Creech * @space_fixup: flag indicating that free space in LEBs needs to be cleaned up 1035d63d61c1SRichard Weinberger * @double_hash: flag indicating that we can do lookups by hash 1036e021986eSRichard Weinberger * @encrypted: flag indicating that this file system contains encrypted files 1037625bf371SArtem Bityutskiy * @no_chk_data_crc: do not check CRCs when reading data nodes (except during 1038625bf371SArtem Bityutskiy * recovery) 1039625bf371SArtem Bityutskiy * @bulk_read: enable bulk-reads 1040a1dc080cSArtem Bityutskiy * @default_compr: default compression algorithm (%UBIFS_COMPR_LZO, etc) 1041963f0cf6SArtem Bityutskiy * @rw_incompat: the media is not R/W compatible 10422e52eb74SRichard Weinberger * @assert_action: action to take when a ubifs_assert() fails 104349525e5eSSascha Hauer * @authenticated: flag indigating the FS is mounted in authenticated mode 10441e51764aSArtem Bityutskiy * 10451e51764aSArtem Bityutskiy * @tnc_mutex: protects the Tree Node Cache (TNC), @zroot, @cnext, @enext, and 10461e51764aSArtem Bityutskiy * @calc_idx_sz 10471e51764aSArtem Bityutskiy * @zroot: zbranch which points to the root index node and znode 10481e51764aSArtem Bityutskiy * @cnext: next znode to commit 10491e51764aSArtem Bityutskiy * @enext: next znode to commit to empty space 10501e51764aSArtem Bityutskiy * @gap_lebs: array of LEBs used by the in-gaps commit method 10511e51764aSArtem Bityutskiy * @cbuf: commit buffer 10521e51764aSArtem Bityutskiy * @ileb_buf: buffer for commit in-the-gaps method 10531e51764aSArtem Bityutskiy * @ileb_len: length of data in ileb_buf 10541e51764aSArtem Bityutskiy * @ihead_lnum: LEB number of index head 10551e51764aSArtem Bityutskiy * @ihead_offs: offset of index head 10561e51764aSArtem Bityutskiy * @ilebs: pre-allocated index LEBs 10571e51764aSArtem Bityutskiy * @ileb_cnt: number of pre-allocated index LEBs 10581e51764aSArtem Bityutskiy * @ileb_nxt: next pre-allocated index LEBs 10591e51764aSArtem Bityutskiy * @old_idx: tree of index nodes obsoleted since the last commit start 10601e51764aSArtem Bityutskiy * @bottom_up_buf: a buffer which is used by 'dirty_cow_bottom_up()' in tnc.c 10611e51764aSArtem Bityutskiy * 10621e51764aSArtem Bityutskiy * @mst_node: master node 10631e51764aSArtem Bityutskiy * @mst_offs: offset of valid master node 10643477d204SArtem Bityutskiy * 10656c0c42cdSArtem Bityutskiy * @max_bu_buf_len: maximum bulk-read buffer length 10663477d204SArtem Bityutskiy * @bu_mutex: protects the pre-allocated bulk-read buffer and @c->bu 10673477d204SArtem Bityutskiy * @bu: pre-allocated bulk-read information 10681e51764aSArtem Bityutskiy * 1069d882962fSMatthew L. Creech * @write_reserve_mutex: protects @write_reserve_buf 1070d882962fSMatthew L. Creech * @write_reserve_buf: on the write path we allocate memory, which might 1071d882962fSMatthew L. Creech * sometimes be unavailable, in which case we use this 1072d882962fSMatthew L. Creech * write reserve buffer 1073d882962fSMatthew L. Creech * 10741e51764aSArtem Bityutskiy * @log_lebs: number of logical eraseblocks in the log 10751e51764aSArtem Bityutskiy * @log_bytes: log size in bytes 10761e51764aSArtem Bityutskiy * @log_last: last LEB of the log 10771e51764aSArtem Bityutskiy * @lpt_lebs: number of LEBs used for lprops table 10781e51764aSArtem Bityutskiy * @lpt_first: first LEB of the lprops table area 10791e51764aSArtem Bityutskiy * @lpt_last: last LEB of the lprops table area 10801e51764aSArtem Bityutskiy * @orph_lebs: number of LEBs used for the orphan area 10811e51764aSArtem Bityutskiy * @orph_first: first LEB of the orphan area 10821e51764aSArtem Bityutskiy * @orph_last: last LEB of the orphan area 10831e51764aSArtem Bityutskiy * @main_lebs: count of LEBs in the main area 10841e51764aSArtem Bityutskiy * @main_first: first LEB of the main area 10851e51764aSArtem Bityutskiy * @main_bytes: main area size in bytes 10861e51764aSArtem Bityutskiy * 10871e51764aSArtem Bityutskiy * @key_hash_type: type of the key hash 10881e51764aSArtem Bityutskiy * @key_hash: direntry key hash function 10891e51764aSArtem Bityutskiy * @key_fmt: key format 10901e51764aSArtem Bityutskiy * @key_len: key length 109149525e5eSSascha Hauer * @hash_len: The length of the index node hashes 10921e51764aSArtem Bityutskiy * @fanout: fanout of the index tree (number of links per indexing node) 10931e51764aSArtem Bityutskiy * 10941e51764aSArtem Bityutskiy * @min_io_size: minimal input/output unit size 10951e51764aSArtem Bityutskiy * @min_io_shift: number of bits in @min_io_size minus one 10963e8e2e0cSArtem Bityutskiy * @max_write_size: maximum amount of bytes the underlying flash can write at a 10973e8e2e0cSArtem Bityutskiy * time (MTD write buffer size) 10983e8e2e0cSArtem Bityutskiy * @max_write_shift: number of bits in @max_write_size minus one 10991e51764aSArtem Bityutskiy * @leb_size: logical eraseblock size in bytes 1100ca2ec61dSArtem Bityutskiy * @leb_start: starting offset of logical eraseblocks within physical 1101ca2ec61dSArtem Bityutskiy * eraseblocks 11021e51764aSArtem Bityutskiy * @half_leb_size: half LEB size 1103fb1cd01aSArtem Bityutskiy * @idx_leb_size: how many bytes of an LEB are effectively available when it is 1104fb1cd01aSArtem Bityutskiy * used to store indexing nodes (@leb_size - @max_idx_node_sz) 11051e51764aSArtem Bityutskiy * @leb_cnt: count of logical eraseblocks 11061e51764aSArtem Bityutskiy * @max_leb_cnt: maximum count of logical eraseblocks 11071e51764aSArtem Bityutskiy * @ro_media: the underlying UBI volume is read-only 11082ef13294SArtem Bityutskiy * @ro_mount: the file-system was mounted as read-only 11092680d722SArtem Bityutskiy * @ro_error: UBIFS switched to R/O mode because an error happened 11101e51764aSArtem Bityutskiy * 11111e51764aSArtem Bityutskiy * @dirty_pg_cnt: number of dirty pages (not used) 11121e51764aSArtem Bityutskiy * @dirty_zn_cnt: number of dirty znodes 11131e51764aSArtem Bityutskiy * @clean_zn_cnt: number of clean znodes 11141e51764aSArtem Bityutskiy * 1115b137545cSArtem Bityutskiy * @space_lock: protects @bi and @lst 1116b137545cSArtem Bityutskiy * @lst: lprops statistics 1117b137545cSArtem Bityutskiy * @bi: budgeting information 11181e51764aSArtem Bityutskiy * @calc_idx_sz: temporary variable which is used to calculate new index size 11191e51764aSArtem Bityutskiy * (contains accurate new index size at end of TNC commit start) 11201e51764aSArtem Bityutskiy * 11211e51764aSArtem Bityutskiy * @ref_node_alsz: size of the LEB reference node aligned to the min. flash 11221e51764aSArtem Bityutskiy * I/O unit 11231e51764aSArtem Bityutskiy * @mst_node_alsz: master node aligned size 11241e51764aSArtem Bityutskiy * @min_idx_node_sz: minimum indexing node aligned on 8-bytes boundary 11251e51764aSArtem Bityutskiy * @max_idx_node_sz: maximum indexing node aligned on 8-bytes boundary 11261e51764aSArtem Bityutskiy * @max_inode_sz: maximum possible inode size in bytes 11271e51764aSArtem Bityutskiy * @max_znode_sz: size of znode in bytes 11289bbb5726SArtem Bityutskiy * 11299bbb5726SArtem Bityutskiy * @leb_overhead: how many bytes are wasted in an LEB when it is filled with 11309bbb5726SArtem Bityutskiy * data nodes of maximum size - used in free space reporting 11311e51764aSArtem Bityutskiy * @dead_wm: LEB dead space watermark 11321e51764aSArtem Bityutskiy * @dark_wm: LEB dark space watermark 11331e51764aSArtem Bityutskiy * @block_cnt: count of 4KiB blocks on the FS 11341e51764aSArtem Bityutskiy * 11351e51764aSArtem Bityutskiy * @ranges: UBIFS node length ranges 11361e51764aSArtem Bityutskiy * @ubi: UBI volume descriptor 11371e51764aSArtem Bityutskiy * @di: UBI device information 11381e51764aSArtem Bityutskiy * @vi: UBI volume information 11391e51764aSArtem Bityutskiy * 11401e51764aSArtem Bityutskiy * @orph_tree: rb-tree of orphan inode numbers 11411e51764aSArtem Bityutskiy * @orph_list: list of orphan inode numbers in order added 11421e51764aSArtem Bityutskiy * @orph_new: list of orphan inode numbers added since last commit 11431e51764aSArtem Bityutskiy * @orph_cnext: next orphan to commit 11441e51764aSArtem Bityutskiy * @orph_dnext: next orphan to delete 11451e51764aSArtem Bityutskiy * @orphan_lock: lock for orph_tree and orph_new 11461e51764aSArtem Bityutskiy * @orph_buf: buffer for orphan nodes 11471e51764aSArtem Bityutskiy * @new_orphans: number of orphans since last commit 11481e51764aSArtem Bityutskiy * @cmt_orphans: number of orphans being committed 11491e51764aSArtem Bityutskiy * @tot_orphans: number of orphans in the rb_tree 11501e51764aSArtem Bityutskiy * @max_orphans: maximum number of orphans allowed 11511e51764aSArtem Bityutskiy * @ohead_lnum: orphan head LEB number 11521e51764aSArtem Bityutskiy * @ohead_offs: orphan head offset 11531e51764aSArtem Bityutskiy * @no_orphs: non-zero if there are no orphans 11541e51764aSArtem Bityutskiy * 11551e51764aSArtem Bityutskiy * @bgt: UBIFS background thread 11561e51764aSArtem Bityutskiy * @bgt_name: background thread name 11571e51764aSArtem Bityutskiy * @need_bgt: if background thread should run 11581e51764aSArtem Bityutskiy * @need_wbuf_sync: if write-buffers have to be synchronized 11591e51764aSArtem Bityutskiy * 11601e51764aSArtem Bityutskiy * @gc_lnum: LEB number used for garbage collection 11611e51764aSArtem Bityutskiy * @sbuf: a buffer of LEB size used by GC and replay for scanning 11621e51764aSArtem Bityutskiy * @idx_gc: list of index LEBs that have been garbage collected 11631e51764aSArtem Bityutskiy * @idx_gc_cnt: number of elements on the idx_gc list 1164601c0bc4SAdrian Hunter * @gc_seq: incremented for every non-index LEB garbage collected 1165601c0bc4SAdrian Hunter * @gced_lnum: last non-index LEB that was garbage collected 11661e51764aSArtem Bityutskiy * 11671e51764aSArtem Bityutskiy * @infos_list: links all 'ubifs_info' objects 11681e51764aSArtem Bityutskiy * @umount_mutex: serializes shrinker and un-mount 11691e51764aSArtem Bityutskiy * @shrinker_run_no: shrinker run number 11701e51764aSArtem Bityutskiy * 11711e51764aSArtem Bityutskiy * @space_bits: number of bits needed to record free or dirty space 11721e51764aSArtem Bityutskiy * @lpt_lnum_bits: number of bits needed to record a LEB number in the LPT 11731e51764aSArtem Bityutskiy * @lpt_offs_bits: number of bits needed to record an offset in the LPT 11741e51764aSArtem Bityutskiy * @lpt_spc_bits: number of bits needed to space in the LPT 11751e51764aSArtem Bityutskiy * @pcnt_bits: number of bits needed to record pnode or nnode number 11761e51764aSArtem Bityutskiy * @lnum_bits: number of bits needed to record LEB number 11771e51764aSArtem Bityutskiy * @nnode_sz: size of on-flash nnode 11781e51764aSArtem Bityutskiy * @pnode_sz: size of on-flash pnode 11791e51764aSArtem Bityutskiy * @ltab_sz: size of on-flash LPT lprops table 11801e51764aSArtem Bityutskiy * @lsave_sz: size of on-flash LPT save table 11811e51764aSArtem Bityutskiy * @pnode_cnt: number of pnodes 11821e51764aSArtem Bityutskiy * @nnode_cnt: number of nnodes 11831e51764aSArtem Bityutskiy * @lpt_hght: height of the LPT 11841e51764aSArtem Bityutskiy * @pnodes_have: number of pnodes in memory 11851e51764aSArtem Bityutskiy * 11861e51764aSArtem Bityutskiy * @lp_mutex: protects lprops table and all the other lprops-related fields 11871e51764aSArtem Bityutskiy * @lpt_lnum: LEB number of the root nnode of the LPT 11881e51764aSArtem Bityutskiy * @lpt_offs: offset of the root nnode of the LPT 11891e51764aSArtem Bityutskiy * @nhead_lnum: LEB number of LPT head 11901e51764aSArtem Bityutskiy * @nhead_offs: offset of LPT head 11911e51764aSArtem Bityutskiy * @lpt_drty_flgs: dirty flags for LPT special nodes e.g. ltab 11921e51764aSArtem Bityutskiy * @dirty_nn_cnt: number of dirty nnodes 11931e51764aSArtem Bityutskiy * @dirty_pn_cnt: number of dirty pnodes 119473944a6dSAdrian Hunter * @check_lpt_free: flag that indicates LPT GC may be needed 11951e51764aSArtem Bityutskiy * @lpt_sz: LPT size 11961e51764aSArtem Bityutskiy * @lpt_nod_buf: buffer for an on-flash nnode or pnode 11971e51764aSArtem Bityutskiy * @lpt_buf: buffer of LEB size used by LPT 11981e51764aSArtem Bityutskiy * @nroot: address in memory of the root nnode of the LPT 11991e51764aSArtem Bityutskiy * @lpt_cnext: next LPT node to commit 12001e51764aSArtem Bityutskiy * @lpt_heap: array of heaps of categorized lprops 12011e51764aSArtem Bityutskiy * @dirty_idx: a (reverse sorted) copy of the LPROPS_DIRTY_IDX heap as at 12021e51764aSArtem Bityutskiy * previous commit start 12031e51764aSArtem Bityutskiy * @uncat_list: list of un-categorized LEBs 12041e51764aSArtem Bityutskiy * @empty_list: list of empty LEBs 1205fb1cd01aSArtem Bityutskiy * @freeable_list: list of freeable non-index LEBs (free + dirty == @leb_size) 1206fb1cd01aSArtem Bityutskiy * @frdi_idx_list: list of freeable index LEBs (free + dirty == @leb_size) 12071e51764aSArtem Bityutskiy * @freeable_cnt: number of freeable LEBs in @freeable_list 120898a1eebdSArtem Bityutskiy * @in_a_category_cnt: count of lprops which are in a certain category, which 120998a1eebdSArtem Bityutskiy * basically meants that they were loaded from the flash 12101e51764aSArtem Bityutskiy * 12111e51764aSArtem Bityutskiy * @ltab_lnum: LEB number of LPT's own lprops table 12121e51764aSArtem Bityutskiy * @ltab_offs: offset of LPT's own lprops table 12131e51764aSArtem Bityutskiy * @ltab: LPT's own lprops table 12141e51764aSArtem Bityutskiy * @ltab_cmt: LPT's own lprops table (commit copy) 12151e51764aSArtem Bityutskiy * @lsave_cnt: number of LEB numbers in LPT's save table 12161e51764aSArtem Bityutskiy * @lsave_lnum: LEB number of LPT's save table 12171e51764aSArtem Bityutskiy * @lsave_offs: offset of LPT's save table 12181e51764aSArtem Bityutskiy * @lsave: LPT's save table 12191e51764aSArtem Bityutskiy * @lscan_lnum: LEB number of last LPT scan 12201e51764aSArtem Bityutskiy * 12211e51764aSArtem Bityutskiy * @rp_size: size of the reserved pool in bytes 12221e51764aSArtem Bityutskiy * @report_rp_size: size of the reserved pool reported to user-space 12231e51764aSArtem Bityutskiy * @rp_uid: reserved pool user ID 12241e51764aSArtem Bityutskiy * @rp_gid: reserved pool group ID 12251e51764aSArtem Bityutskiy * 122649525e5eSSascha Hauer * @hash_tfm: the hash transformation used for hashing nodes 122749525e5eSSascha Hauer * @hmac_tfm: the HMAC transformation for this filesystem 122849525e5eSSascha Hauer * @hmac_desc_len: length of the HMAC used for authentication 122949525e5eSSascha Hauer * @auth_key_name: the authentication key name 123049525e5eSSascha Hauer * @auth_hash_name: the name of the hash algorithm used for authentication 123149525e5eSSascha Hauer * @auth_hash_algo: the authentication hash used for this fs 12326a98bc46SSascha Hauer * @log_hash: the log hash from the commit start node up to the latest reference 12336a98bc46SSascha Hauer * node. 123449525e5eSSascha Hauer * 1235d8cdda3eSArtem Bityutskiy * @empty: %1 if the UBI device is empty 1236d8cdda3eSArtem Bityutskiy * @need_recovery: %1 if the file-system needs recovery 1237d8cdda3eSArtem Bityutskiy * @replaying: %1 during journal replay 123818d1d7fbSArtem Bityutskiy * @mounting: %1 while mounting 12391751e8a6SLinus Torvalds * @probing: %1 while attempting to mount if SB_SILENT mount flag is set 1240d8cdda3eSArtem Bityutskiy * @remounting_rw: %1 while re-mounting from R/O mode to R/W mode 12411e51764aSArtem Bityutskiy * @replay_list: temporary list used during journal replay 12421e51764aSArtem Bityutskiy * @replay_buds: list of buds to replay 12431e51764aSArtem Bityutskiy * @cs_sqnum: sequence number of first node in the log (commit start node) 12442ef13294SArtem Bityutskiy * @unclean_leb_list: LEBs to recover when re-mounting R/O mounted FS to R/W 12452ef13294SArtem Bityutskiy * mode 12462ef13294SArtem Bityutskiy * @rcvrd_mst_node: recovered master node to write when re-mounting R/O mounted 12472ef13294SArtem Bityutskiy * FS to R/W mode 12481e51764aSArtem Bityutskiy * @size_tree: inode size information for recovery 12491e51764aSArtem Bityutskiy * @mount_opts: UBIFS-specific mount options 12501e51764aSArtem Bityutskiy * 125117c2f9f8SArtem Bityutskiy * @dbg: debugging-related information 12521e51764aSArtem Bityutskiy */ 12531e51764aSArtem Bityutskiy struct ubifs_info { 12541e51764aSArtem Bityutskiy struct super_block *vfs_sb; 1255fd615005SSascha Hauer struct ubifs_sb_node *sup_node; 12561e51764aSArtem Bityutskiy 12571e51764aSArtem Bityutskiy ino_t highest_inum; 12581e51764aSArtem Bityutskiy unsigned long long max_sqnum; 12591e51764aSArtem Bityutskiy unsigned long long cmt_no; 12601e51764aSArtem Bityutskiy spinlock_t cnt_lock; 12611e51764aSArtem Bityutskiy int fmt_version; 1262963f0cf6SArtem Bityutskiy int ro_compat_version; 12631e51764aSArtem Bityutskiy unsigned char uuid[16]; 12641e51764aSArtem Bityutskiy 12651e51764aSArtem Bityutskiy int lhead_lnum; 12661e51764aSArtem Bityutskiy int lhead_offs; 12671e51764aSArtem Bityutskiy int ltail_lnum; 12681e51764aSArtem Bityutskiy struct mutex log_mutex; 12691e51764aSArtem Bityutskiy int min_log_bytes; 12701e51764aSArtem Bityutskiy long long cmt_bud_bytes; 12711e51764aSArtem Bityutskiy 12721e51764aSArtem Bityutskiy struct rb_root buds; 12731e51764aSArtem Bityutskiy long long bud_bytes; 12741e51764aSArtem Bityutskiy spinlock_t buds_lock; 12751e51764aSArtem Bityutskiy int jhead_cnt; 12761e51764aSArtem Bityutskiy struct ubifs_jhead *jheads; 12771e51764aSArtem Bityutskiy long long max_bud_bytes; 12781e51764aSArtem Bityutskiy long long bg_bud_bytes; 12791e51764aSArtem Bityutskiy struct list_head old_buds; 12801e51764aSArtem Bityutskiy int max_bud_cnt; 12811e51764aSArtem Bityutskiy 12821e51764aSArtem Bityutskiy struct rw_semaphore commit_sem; 12831e51764aSArtem Bityutskiy int cmt_state; 12841e51764aSArtem Bityutskiy spinlock_t cs_lock; 12851e51764aSArtem Bityutskiy wait_queue_head_t cmt_wq; 1286625bf371SArtem Bityutskiy 12871e51764aSArtem Bityutskiy unsigned int big_lpt:1; 12889f58d350SMatthew L. Creech unsigned int space_fixup:1; 1289d63d61c1SRichard Weinberger unsigned int double_hash:1; 1290e021986eSRichard Weinberger unsigned int encrypted:1; 1291625bf371SArtem Bityutskiy unsigned int no_chk_data_crc:1; 1292625bf371SArtem Bityutskiy unsigned int bulk_read:1; 1293a1dc080cSArtem Bityutskiy unsigned int default_compr:2; 1294963f0cf6SArtem Bityutskiy unsigned int rw_incompat:1; 12952e52eb74SRichard Weinberger unsigned int assert_action:2; 129649525e5eSSascha Hauer unsigned int authenticated:1; 1297817aa094SSascha Hauer unsigned int superblock_need_write:1; 12981e51764aSArtem Bityutskiy 12991e51764aSArtem Bityutskiy struct mutex tnc_mutex; 13001e51764aSArtem Bityutskiy struct ubifs_zbranch zroot; 13011e51764aSArtem Bityutskiy struct ubifs_znode *cnext; 13021e51764aSArtem Bityutskiy struct ubifs_znode *enext; 13031e51764aSArtem Bityutskiy int *gap_lebs; 13041e51764aSArtem Bityutskiy void *cbuf; 13051e51764aSArtem Bityutskiy void *ileb_buf; 13061e51764aSArtem Bityutskiy int ileb_len; 13071e51764aSArtem Bityutskiy int ihead_lnum; 13081e51764aSArtem Bityutskiy int ihead_offs; 13091e51764aSArtem Bityutskiy int *ilebs; 13101e51764aSArtem Bityutskiy int ileb_cnt; 13111e51764aSArtem Bityutskiy int ileb_nxt; 13121e51764aSArtem Bityutskiy struct rb_root old_idx; 13131e51764aSArtem Bityutskiy int *bottom_up_buf; 13141e51764aSArtem Bityutskiy 13151e51764aSArtem Bityutskiy struct ubifs_mst_node *mst_node; 13161e51764aSArtem Bityutskiy int mst_offs; 13173477d204SArtem Bityutskiy 13186c0c42cdSArtem Bityutskiy int max_bu_buf_len; 13193477d204SArtem Bityutskiy struct mutex bu_mutex; 13203477d204SArtem Bityutskiy struct bu_info bu; 13211e51764aSArtem Bityutskiy 1322d882962fSMatthew L. Creech struct mutex write_reserve_mutex; 1323d882962fSMatthew L. Creech void *write_reserve_buf; 1324d882962fSMatthew L. Creech 13251e51764aSArtem Bityutskiy int log_lebs; 13261e51764aSArtem Bityutskiy long long log_bytes; 13271e51764aSArtem Bityutskiy int log_last; 13281e51764aSArtem Bityutskiy int lpt_lebs; 13291e51764aSArtem Bityutskiy int lpt_first; 13301e51764aSArtem Bityutskiy int lpt_last; 13311e51764aSArtem Bityutskiy int orph_lebs; 13321e51764aSArtem Bityutskiy int orph_first; 13331e51764aSArtem Bityutskiy int orph_last; 13341e51764aSArtem Bityutskiy int main_lebs; 13351e51764aSArtem Bityutskiy int main_first; 13361e51764aSArtem Bityutskiy long long main_bytes; 13371e51764aSArtem Bityutskiy 13381e51764aSArtem Bityutskiy uint8_t key_hash_type; 13391e51764aSArtem Bityutskiy uint32_t (*key_hash)(const char *str, int len); 13401e51764aSArtem Bityutskiy int key_fmt; 13411e51764aSArtem Bityutskiy int key_len; 134249525e5eSSascha Hauer int hash_len; 13431e51764aSArtem Bityutskiy int fanout; 13441e51764aSArtem Bityutskiy 13451e51764aSArtem Bityutskiy int min_io_size; 13461e51764aSArtem Bityutskiy int min_io_shift; 13473e8e2e0cSArtem Bityutskiy int max_write_size; 13483e8e2e0cSArtem Bityutskiy int max_write_shift; 13491e51764aSArtem Bityutskiy int leb_size; 1350ca2ec61dSArtem Bityutskiy int leb_start; 13511e51764aSArtem Bityutskiy int half_leb_size; 1352fb1cd01aSArtem Bityutskiy int idx_leb_size; 13531e51764aSArtem Bityutskiy int leb_cnt; 13541e51764aSArtem Bityutskiy int max_leb_cnt; 13552680d722SArtem Bityutskiy unsigned int ro_media:1; 13562ef13294SArtem Bityutskiy unsigned int ro_mount:1; 13572680d722SArtem Bityutskiy unsigned int ro_error:1; 13581e51764aSArtem Bityutskiy 13591e51764aSArtem Bityutskiy atomic_long_t dirty_pg_cnt; 13601e51764aSArtem Bityutskiy atomic_long_t dirty_zn_cnt; 13611e51764aSArtem Bityutskiy atomic_long_t clean_zn_cnt; 13621e51764aSArtem Bityutskiy 13631e51764aSArtem Bityutskiy spinlock_t space_lock; 13641e51764aSArtem Bityutskiy struct ubifs_lp_stats lst; 1365b137545cSArtem Bityutskiy struct ubifs_budg_info bi; 1366b137545cSArtem Bityutskiy unsigned long long calc_idx_sz; 13671e51764aSArtem Bityutskiy 13681e51764aSArtem Bityutskiy int ref_node_alsz; 13691e51764aSArtem Bityutskiy int mst_node_alsz; 13701e51764aSArtem Bityutskiy int min_idx_node_sz; 13711e51764aSArtem Bityutskiy int max_idx_node_sz; 13721e51764aSArtem Bityutskiy long long max_inode_sz; 13731e51764aSArtem Bityutskiy int max_znode_sz; 13749bbb5726SArtem Bityutskiy 13759bbb5726SArtem Bityutskiy int leb_overhead; 13761e51764aSArtem Bityutskiy int dead_wm; 13771e51764aSArtem Bityutskiy int dark_wm; 13781e51764aSArtem Bityutskiy int block_cnt; 13791e51764aSArtem Bityutskiy 13801e51764aSArtem Bityutskiy struct ubifs_node_range ranges[UBIFS_NODE_TYPES_CNT]; 13811e51764aSArtem Bityutskiy struct ubi_volume_desc *ubi; 13821e51764aSArtem Bityutskiy struct ubi_device_info di; 13831e51764aSArtem Bityutskiy struct ubi_volume_info vi; 13841e51764aSArtem Bityutskiy 13851e51764aSArtem Bityutskiy struct rb_root orph_tree; 13861e51764aSArtem Bityutskiy struct list_head orph_list; 13871e51764aSArtem Bityutskiy struct list_head orph_new; 13881e51764aSArtem Bityutskiy struct ubifs_orphan *orph_cnext; 13891e51764aSArtem Bityutskiy struct ubifs_orphan *orph_dnext; 13901e51764aSArtem Bityutskiy spinlock_t orphan_lock; 13911e51764aSArtem Bityutskiy void *orph_buf; 13921e51764aSArtem Bityutskiy int new_orphans; 13931e51764aSArtem Bityutskiy int cmt_orphans; 13941e51764aSArtem Bityutskiy int tot_orphans; 13951e51764aSArtem Bityutskiy int max_orphans; 13961e51764aSArtem Bityutskiy int ohead_lnum; 13971e51764aSArtem Bityutskiy int ohead_offs; 13981e51764aSArtem Bityutskiy int no_orphs; 13991e51764aSArtem Bityutskiy 14001e51764aSArtem Bityutskiy struct task_struct *bgt; 14011e51764aSArtem Bityutskiy char bgt_name[sizeof(BGT_NAME_PATTERN) + 9]; 14021e51764aSArtem Bityutskiy int need_bgt; 14031e51764aSArtem Bityutskiy int need_wbuf_sync; 14041e51764aSArtem Bityutskiy 14051e51764aSArtem Bityutskiy int gc_lnum; 14061e51764aSArtem Bityutskiy void *sbuf; 14071e51764aSArtem Bityutskiy struct list_head idx_gc; 14081e51764aSArtem Bityutskiy int idx_gc_cnt; 1409f92b9826SArtem Bityutskiy int gc_seq; 1410f92b9826SArtem Bityutskiy int gced_lnum; 14111e51764aSArtem Bityutskiy 14121e51764aSArtem Bityutskiy struct list_head infos_list; 14131e51764aSArtem Bityutskiy struct mutex umount_mutex; 14141e51764aSArtem Bityutskiy unsigned int shrinker_run_no; 14151e51764aSArtem Bityutskiy 14161e51764aSArtem Bityutskiy int space_bits; 14171e51764aSArtem Bityutskiy int lpt_lnum_bits; 14181e51764aSArtem Bityutskiy int lpt_offs_bits; 14191e51764aSArtem Bityutskiy int lpt_spc_bits; 14201e51764aSArtem Bityutskiy int pcnt_bits; 14211e51764aSArtem Bityutskiy int lnum_bits; 14221e51764aSArtem Bityutskiy int nnode_sz; 14231e51764aSArtem Bityutskiy int pnode_sz; 14241e51764aSArtem Bityutskiy int ltab_sz; 14251e51764aSArtem Bityutskiy int lsave_sz; 14261e51764aSArtem Bityutskiy int pnode_cnt; 14271e51764aSArtem Bityutskiy int nnode_cnt; 14281e51764aSArtem Bityutskiy int lpt_hght; 14291e51764aSArtem Bityutskiy int pnodes_have; 14301e51764aSArtem Bityutskiy 14311e51764aSArtem Bityutskiy struct mutex lp_mutex; 14321e51764aSArtem Bityutskiy int lpt_lnum; 14331e51764aSArtem Bityutskiy int lpt_offs; 14341e51764aSArtem Bityutskiy int nhead_lnum; 14351e51764aSArtem Bityutskiy int nhead_offs; 14361e51764aSArtem Bityutskiy int lpt_drty_flgs; 14371e51764aSArtem Bityutskiy int dirty_nn_cnt; 14381e51764aSArtem Bityutskiy int dirty_pn_cnt; 143973944a6dSAdrian Hunter int check_lpt_free; 14401e51764aSArtem Bityutskiy long long lpt_sz; 14411e51764aSArtem Bityutskiy void *lpt_nod_buf; 14421e51764aSArtem Bityutskiy void *lpt_buf; 14431e51764aSArtem Bityutskiy struct ubifs_nnode *nroot; 14441e51764aSArtem Bityutskiy struct ubifs_cnode *lpt_cnext; 14451e51764aSArtem Bityutskiy struct ubifs_lpt_heap lpt_heap[LPROPS_HEAP_CNT]; 14461e51764aSArtem Bityutskiy struct ubifs_lpt_heap dirty_idx; 14471e51764aSArtem Bityutskiy struct list_head uncat_list; 14481e51764aSArtem Bityutskiy struct list_head empty_list; 14491e51764aSArtem Bityutskiy struct list_head freeable_list; 14501e51764aSArtem Bityutskiy struct list_head frdi_idx_list; 14511e51764aSArtem Bityutskiy int freeable_cnt; 145298a1eebdSArtem Bityutskiy int in_a_category_cnt; 14531e51764aSArtem Bityutskiy 14541e51764aSArtem Bityutskiy int ltab_lnum; 14551e51764aSArtem Bityutskiy int ltab_offs; 14561e51764aSArtem Bityutskiy struct ubifs_lpt_lprops *ltab; 14571e51764aSArtem Bityutskiy struct ubifs_lpt_lprops *ltab_cmt; 14581e51764aSArtem Bityutskiy int lsave_cnt; 14591e51764aSArtem Bityutskiy int lsave_lnum; 14601e51764aSArtem Bityutskiy int lsave_offs; 14611e51764aSArtem Bityutskiy int *lsave; 14621e51764aSArtem Bityutskiy int lscan_lnum; 14631e51764aSArtem Bityutskiy 14641e51764aSArtem Bityutskiy long long rp_size; 14651e51764aSArtem Bityutskiy long long report_rp_size; 146639241bebSEric W. Biederman kuid_t rp_uid; 146739241bebSEric W. Biederman kgid_t rp_gid; 14681e51764aSArtem Bityutskiy 146949525e5eSSascha Hauer struct crypto_shash *hash_tfm; 147049525e5eSSascha Hauer struct crypto_shash *hmac_tfm; 147149525e5eSSascha Hauer int hmac_desc_len; 147249525e5eSSascha Hauer char *auth_key_name; 147349525e5eSSascha Hauer char *auth_hash_name; 147449525e5eSSascha Hauer enum hash_algo auth_hash_algo; 147549525e5eSSascha Hauer 14766a98bc46SSascha Hauer struct shash_desc *log_hash; 14776a98bc46SSascha Hauer 14781e51764aSArtem Bityutskiy /* The below fields are used only during mounting and re-mounting */ 1479d8cdda3eSArtem Bityutskiy unsigned int empty:1; 1480d8cdda3eSArtem Bityutskiy unsigned int need_recovery:1; 1481d8cdda3eSArtem Bityutskiy unsigned int replaying:1; 148218d1d7fbSArtem Bityutskiy unsigned int mounting:1; 1483d8cdda3eSArtem Bityutskiy unsigned int remounting_rw:1; 148490bea5a3SDaniel Golle unsigned int probing:1; 14851e51764aSArtem Bityutskiy struct list_head replay_list; 14861e51764aSArtem Bityutskiy struct list_head replay_buds; 14871e51764aSArtem Bityutskiy unsigned long long cs_sqnum; 14881e51764aSArtem Bityutskiy struct list_head unclean_leb_list; 14891e51764aSArtem Bityutskiy struct ubifs_mst_node *rcvrd_mst_node; 14901e51764aSArtem Bityutskiy struct rb_root size_tree; 14911e51764aSArtem Bityutskiy struct ubifs_mount_opts mount_opts; 14921e51764aSArtem Bityutskiy 149317c2f9f8SArtem Bityutskiy struct ubifs_debug_info *dbg; 14941e51764aSArtem Bityutskiy }; 14951e51764aSArtem Bityutskiy 14961e51764aSArtem Bityutskiy extern struct list_head ubifs_infos; 14971e51764aSArtem Bityutskiy extern spinlock_t ubifs_infos_lock; 14981e51764aSArtem Bityutskiy extern atomic_long_t ubifs_clean_zn_cnt; 1499e8b81566SArtem Bityutskiy extern const struct super_operations ubifs_super_operations; 1500e8b81566SArtem Bityutskiy extern const struct address_space_operations ubifs_file_address_operations; 1501e8b81566SArtem Bityutskiy extern const struct file_operations ubifs_file_operations; 1502e8b81566SArtem Bityutskiy extern const struct inode_operations ubifs_file_inode_operations; 1503e8b81566SArtem Bityutskiy extern const struct file_operations ubifs_dir_operations; 1504e8b81566SArtem Bityutskiy extern const struct inode_operations ubifs_dir_inode_operations; 1505e8b81566SArtem Bityutskiy extern const struct inode_operations ubifs_symlink_inode_operations; 15061e51764aSArtem Bityutskiy extern struct ubifs_compressor *ubifs_compressors[UBIFS_COMPR_TYPES_CNT]; 1507a7a8f4a1SMartin Kaistra extern int ubifs_default_version; 15081e51764aSArtem Bityutskiy 150949525e5eSSascha Hauer /* auth.c */ 151049525e5eSSascha Hauer static inline int ubifs_authenticated(const struct ubifs_info *c) 151149525e5eSSascha Hauer { 151249525e5eSSascha Hauer return (IS_ENABLED(CONFIG_UBIFS_FS_AUTHENTICATION)) && c->authenticated; 151349525e5eSSascha Hauer } 151449525e5eSSascha Hauer 151549525e5eSSascha Hauer struct shash_desc *__ubifs_hash_get_desc(const struct ubifs_info *c); 151649525e5eSSascha Hauer static inline struct shash_desc *ubifs_hash_get_desc(const struct ubifs_info *c) 151749525e5eSSascha Hauer { 151849525e5eSSascha Hauer return ubifs_authenticated(c) ? __ubifs_hash_get_desc(c) : NULL; 151949525e5eSSascha Hauer } 152049525e5eSSascha Hauer 152149525e5eSSascha Hauer static inline int ubifs_shash_init(const struct ubifs_info *c, 152249525e5eSSascha Hauer struct shash_desc *desc) 152349525e5eSSascha Hauer { 152449525e5eSSascha Hauer if (ubifs_authenticated(c)) 152549525e5eSSascha Hauer return crypto_shash_init(desc); 152649525e5eSSascha Hauer else 152749525e5eSSascha Hauer return 0; 152849525e5eSSascha Hauer } 152949525e5eSSascha Hauer 153049525e5eSSascha Hauer static inline int ubifs_shash_update(const struct ubifs_info *c, 153149525e5eSSascha Hauer struct shash_desc *desc, const void *buf, 153249525e5eSSascha Hauer unsigned int len) 153349525e5eSSascha Hauer { 153449525e5eSSascha Hauer int err = 0; 153549525e5eSSascha Hauer 153649525e5eSSascha Hauer if (ubifs_authenticated(c)) { 153749525e5eSSascha Hauer err = crypto_shash_update(desc, buf, len); 153849525e5eSSascha Hauer if (err < 0) 153949525e5eSSascha Hauer return err; 154049525e5eSSascha Hauer } 154149525e5eSSascha Hauer 154249525e5eSSascha Hauer return 0; 154349525e5eSSascha Hauer } 154449525e5eSSascha Hauer 154549525e5eSSascha Hauer static inline int ubifs_shash_final(const struct ubifs_info *c, 154649525e5eSSascha Hauer struct shash_desc *desc, u8 *out) 154749525e5eSSascha Hauer { 154849525e5eSSascha Hauer return ubifs_authenticated(c) ? crypto_shash_final(desc, out) : 0; 154949525e5eSSascha Hauer } 155049525e5eSSascha Hauer 155149525e5eSSascha Hauer int __ubifs_node_calc_hash(const struct ubifs_info *c, const void *buf, 155249525e5eSSascha Hauer u8 *hash); 155349525e5eSSascha Hauer static inline int ubifs_node_calc_hash(const struct ubifs_info *c, 155449525e5eSSascha Hauer const void *buf, u8 *hash) 155549525e5eSSascha Hauer { 155649525e5eSSascha Hauer if (ubifs_authenticated(c)) 155749525e5eSSascha Hauer return __ubifs_node_calc_hash(c, buf, hash); 155849525e5eSSascha Hauer else 155949525e5eSSascha Hauer return 0; 156049525e5eSSascha Hauer } 156149525e5eSSascha Hauer 156249525e5eSSascha Hauer int ubifs_prepare_auth_node(struct ubifs_info *c, void *node, 156349525e5eSSascha Hauer struct shash_desc *inhash); 156449525e5eSSascha Hauer 156549525e5eSSascha Hauer /** 156649525e5eSSascha Hauer * ubifs_check_hash - compare two hashes 156749525e5eSSascha Hauer * @c: UBIFS file-system description object 156849525e5eSSascha Hauer * @expected: first hash 156949525e5eSSascha Hauer * @got: second hash 157049525e5eSSascha Hauer * 157149525e5eSSascha Hauer * Compare two hashes @expected and @got. Returns 0 when they are equal, a 157249525e5eSSascha Hauer * negative error code otherwise. 157349525e5eSSascha Hauer */ 157449525e5eSSascha Hauer static inline int ubifs_check_hash(const struct ubifs_info *c, 157549525e5eSSascha Hauer const u8 *expected, const u8 *got) 157649525e5eSSascha Hauer { 157749525e5eSSascha Hauer return crypto_memneq(expected, got, c->hash_len); 157849525e5eSSascha Hauer } 157949525e5eSSascha Hauer 158049525e5eSSascha Hauer /** 158149525e5eSSascha Hauer * ubifs_check_hmac - compare two HMACs 158249525e5eSSascha Hauer * @c: UBIFS file-system description object 158349525e5eSSascha Hauer * @expected: first HMAC 158449525e5eSSascha Hauer * @got: second HMAC 158549525e5eSSascha Hauer * 158649525e5eSSascha Hauer * Compare two hashes @expected and @got. Returns 0 when they are equal, a 158749525e5eSSascha Hauer * negative error code otherwise. 158849525e5eSSascha Hauer */ 158949525e5eSSascha Hauer static inline int ubifs_check_hmac(const struct ubifs_info *c, 159049525e5eSSascha Hauer const u8 *expected, const u8 *got) 159149525e5eSSascha Hauer { 159249525e5eSSascha Hauer return crypto_memneq(expected, got, c->hmac_desc_len); 159349525e5eSSascha Hauer } 159449525e5eSSascha Hauer 159549525e5eSSascha Hauer void ubifs_bad_hash(const struct ubifs_info *c, const void *node, 159649525e5eSSascha Hauer const u8 *hash, int lnum, int offs); 159749525e5eSSascha Hauer 159849525e5eSSascha Hauer int __ubifs_node_check_hash(const struct ubifs_info *c, const void *buf, 159949525e5eSSascha Hauer const u8 *expected); 160049525e5eSSascha Hauer static inline int ubifs_node_check_hash(const struct ubifs_info *c, 160149525e5eSSascha Hauer const void *buf, const u8 *expected) 160249525e5eSSascha Hauer { 160349525e5eSSascha Hauer if (ubifs_authenticated(c)) 160449525e5eSSascha Hauer return __ubifs_node_check_hash(c, buf, expected); 160549525e5eSSascha Hauer else 160649525e5eSSascha Hauer return 0; 160749525e5eSSascha Hauer } 160849525e5eSSascha Hauer 160949525e5eSSascha Hauer int ubifs_init_authentication(struct ubifs_info *c); 161049525e5eSSascha Hauer void __ubifs_exit_authentication(struct ubifs_info *c); 161149525e5eSSascha Hauer static inline void ubifs_exit_authentication(struct ubifs_info *c) 161249525e5eSSascha Hauer { 161349525e5eSSascha Hauer if (ubifs_authenticated(c)) 161449525e5eSSascha Hauer __ubifs_exit_authentication(c); 161549525e5eSSascha Hauer } 161649525e5eSSascha Hauer 161749525e5eSSascha Hauer /** 161849525e5eSSascha Hauer * ubifs_branch_hash - returns a pointer to the hash of a branch 161949525e5eSSascha Hauer * @c: UBIFS file-system description object 162049525e5eSSascha Hauer * @br: branch to get the hash from 162149525e5eSSascha Hauer * 162249525e5eSSascha Hauer * This returns a pointer to the hash of a branch. Since the key already is a 162349525e5eSSascha Hauer * dynamically sized object we cannot use a struct member here. 162449525e5eSSascha Hauer */ 162549525e5eSSascha Hauer static inline u8 *ubifs_branch_hash(struct ubifs_info *c, 162649525e5eSSascha Hauer struct ubifs_branch *br) 162749525e5eSSascha Hauer { 162849525e5eSSascha Hauer return (void *)br + sizeof(*br) + c->key_len; 162949525e5eSSascha Hauer } 163049525e5eSSascha Hauer 163149525e5eSSascha Hauer /** 163249525e5eSSascha Hauer * ubifs_copy_hash - copy a hash 163349525e5eSSascha Hauer * @c: UBIFS file-system description object 163449525e5eSSascha Hauer * @from: source hash 163549525e5eSSascha Hauer * @to: destination hash 163649525e5eSSascha Hauer * 163749525e5eSSascha Hauer * With authentication this copies a hash, otherwise does nothing. 163849525e5eSSascha Hauer */ 163949525e5eSSascha Hauer static inline void ubifs_copy_hash(const struct ubifs_info *c, const u8 *from, 164049525e5eSSascha Hauer u8 *to) 164149525e5eSSascha Hauer { 164249525e5eSSascha Hauer if (ubifs_authenticated(c)) 164349525e5eSSascha Hauer memcpy(to, from, c->hash_len); 164449525e5eSSascha Hauer } 164549525e5eSSascha Hauer 164649525e5eSSascha Hauer int __ubifs_node_insert_hmac(const struct ubifs_info *c, void *buf, 164749525e5eSSascha Hauer int len, int ofs_hmac); 164849525e5eSSascha Hauer static inline int ubifs_node_insert_hmac(const struct ubifs_info *c, void *buf, 164949525e5eSSascha Hauer int len, int ofs_hmac) 165049525e5eSSascha Hauer { 165149525e5eSSascha Hauer if (ubifs_authenticated(c)) 165249525e5eSSascha Hauer return __ubifs_node_insert_hmac(c, buf, len, ofs_hmac); 165349525e5eSSascha Hauer else 165449525e5eSSascha Hauer return 0; 165549525e5eSSascha Hauer } 165649525e5eSSascha Hauer 165749525e5eSSascha Hauer int __ubifs_node_verify_hmac(const struct ubifs_info *c, const void *buf, 165849525e5eSSascha Hauer int len, int ofs_hmac); 165949525e5eSSascha Hauer static inline int ubifs_node_verify_hmac(const struct ubifs_info *c, 166049525e5eSSascha Hauer const void *buf, int len, int ofs_hmac) 166149525e5eSSascha Hauer { 166249525e5eSSascha Hauer if (ubifs_authenticated(c)) 166349525e5eSSascha Hauer return __ubifs_node_verify_hmac(c, buf, len, ofs_hmac); 166449525e5eSSascha Hauer else 166549525e5eSSascha Hauer return 0; 166649525e5eSSascha Hauer } 166749525e5eSSascha Hauer 166849525e5eSSascha Hauer /** 166949525e5eSSascha Hauer * ubifs_auth_node_sz - returns the size of an authentication node 167049525e5eSSascha Hauer * @c: UBIFS file-system description object 167149525e5eSSascha Hauer * 167249525e5eSSascha Hauer * This function returns the size of an authentication node which can 167349525e5eSSascha Hauer * be 0 for unauthenticated filesystems or the real size of an auth node 167449525e5eSSascha Hauer * authentication is enabled. 167549525e5eSSascha Hauer */ 167649525e5eSSascha Hauer static inline int ubifs_auth_node_sz(const struct ubifs_info *c) 167749525e5eSSascha Hauer { 167849525e5eSSascha Hauer if (ubifs_authenticated(c)) 167949525e5eSSascha Hauer return sizeof(struct ubifs_auth_node) + c->hmac_desc_len; 168049525e5eSSascha Hauer else 168149525e5eSSascha Hauer return 0; 168249525e5eSSascha Hauer } 1683817aa094SSascha Hauer int ubifs_sb_verify_signature(struct ubifs_info *c, 1684817aa094SSascha Hauer const struct ubifs_sb_node *sup); 1685817aa094SSascha Hauer bool ubifs_hmac_zero(struct ubifs_info *c, const u8 *hmac); 168649525e5eSSascha Hauer 168749525e5eSSascha Hauer int ubifs_hmac_wkm(struct ubifs_info *c, u8 *hmac); 168849525e5eSSascha Hauer 168949525e5eSSascha Hauer int __ubifs_shash_copy_state(const struct ubifs_info *c, struct shash_desc *src, 169049525e5eSSascha Hauer struct shash_desc *target); 169149525e5eSSascha Hauer static inline int ubifs_shash_copy_state(const struct ubifs_info *c, 169249525e5eSSascha Hauer struct shash_desc *src, 169349525e5eSSascha Hauer struct shash_desc *target) 169449525e5eSSascha Hauer { 169549525e5eSSascha Hauer if (ubifs_authenticated(c)) 169649525e5eSSascha Hauer return __ubifs_shash_copy_state(c, src, target); 169749525e5eSSascha Hauer else 169849525e5eSSascha Hauer return 0; 169949525e5eSSascha Hauer } 170049525e5eSSascha Hauer 17011e51764aSArtem Bityutskiy /* io.c */ 1702ff46d7b3SAdrian Hunter void ubifs_ro_mode(struct ubifs_info *c, int err); 170383cef708SArtem Bityutskiy int ubifs_leb_read(const struct ubifs_info *c, int lnum, void *buf, int offs, 170483cef708SArtem Bityutskiy int len, int even_ebadmsg); 170583cef708SArtem Bityutskiy int ubifs_leb_write(struct ubifs_info *c, int lnum, const void *buf, int offs, 1706b36a261eSRichard Weinberger int len); 1707b36a261eSRichard Weinberger int ubifs_leb_change(struct ubifs_info *c, int lnum, const void *buf, int len); 170883cef708SArtem Bityutskiy int ubifs_leb_unmap(struct ubifs_info *c, int lnum); 1709b36a261eSRichard Weinberger int ubifs_leb_map(struct ubifs_info *c, int lnum); 171083cef708SArtem Bityutskiy int ubifs_is_mapped(const struct ubifs_info *c, int lnum); 17111e51764aSArtem Bityutskiy int ubifs_wbuf_write_nolock(struct ubifs_wbuf *wbuf, void *buf, int len); 1712b36a261eSRichard Weinberger int ubifs_wbuf_seek_nolock(struct ubifs_wbuf *wbuf, int lnum, int offs); 17131e51764aSArtem Bityutskiy int ubifs_wbuf_init(struct ubifs_info *c, struct ubifs_wbuf *wbuf); 17141e51764aSArtem Bityutskiy int ubifs_read_node(const struct ubifs_info *c, void *buf, int type, int len, 17151e51764aSArtem Bityutskiy int lnum, int offs); 17161e51764aSArtem Bityutskiy int ubifs_read_node_wbuf(struct ubifs_wbuf *wbuf, void *buf, int type, int len, 17171e51764aSArtem Bityutskiy int lnum, int offs); 17181e51764aSArtem Bityutskiy int ubifs_write_node(struct ubifs_info *c, void *node, int len, int lnum, 1719b36a261eSRichard Weinberger int offs); 1720a384b47eSSascha Hauer int ubifs_write_node_hmac(struct ubifs_info *c, void *buf, int len, int lnum, 1721a384b47eSSascha Hauer int offs, int hmac_offs); 17221e51764aSArtem Bityutskiy int ubifs_check_node(const struct ubifs_info *c, const void *buf, int lnum, 17236f7ab6d4SArtem Bityutskiy int offs, int quiet, int must_chk_crc); 1724dead9726SSascha Hauer void ubifs_init_node(struct ubifs_info *c, void *buf, int len, int pad); 1725dead9726SSascha Hauer void ubifs_crc_node(struct ubifs_info *c, void *buf, int len); 17261e51764aSArtem Bityutskiy void ubifs_prepare_node(struct ubifs_info *c, void *buf, int len, int pad); 1727a384b47eSSascha Hauer int ubifs_prepare_node_hmac(struct ubifs_info *c, void *node, int len, 1728a384b47eSSascha Hauer int hmac_offs, int pad); 17291e51764aSArtem Bityutskiy void ubifs_prep_grp_node(struct ubifs_info *c, void *node, int len, int last); 17301e51764aSArtem Bityutskiy int ubifs_io_init(struct ubifs_info *c); 17311e51764aSArtem Bityutskiy void ubifs_pad(const struct ubifs_info *c, void *buf, int pad); 17321e51764aSArtem Bityutskiy int ubifs_wbuf_sync_nolock(struct ubifs_wbuf *wbuf); 17331e51764aSArtem Bityutskiy int ubifs_bg_wbufs_sync(struct ubifs_info *c); 17341e51764aSArtem Bityutskiy void ubifs_wbuf_add_ino_nolock(struct ubifs_wbuf *wbuf, ino_t inum); 17351e51764aSArtem Bityutskiy int ubifs_sync_wbufs_by_inode(struct ubifs_info *c, struct inode *inode); 17361e51764aSArtem Bityutskiy 17371e51764aSArtem Bityutskiy /* scan.c */ 17381e51764aSArtem Bityutskiy struct ubifs_scan_leb *ubifs_scan(const struct ubifs_info *c, int lnum, 1739348709baSArtem Bityutskiy int offs, void *sbuf, int quiet); 17401e51764aSArtem Bityutskiy void ubifs_scan_destroy(struct ubifs_scan_leb *sleb); 17411e51764aSArtem Bityutskiy int ubifs_scan_a_node(const struct ubifs_info *c, void *buf, int len, int lnum, 17421e51764aSArtem Bityutskiy int offs, int quiet); 17431e51764aSArtem Bityutskiy struct ubifs_scan_leb *ubifs_start_scan(const struct ubifs_info *c, int lnum, 17441e51764aSArtem Bityutskiy int offs, void *sbuf); 17451e51764aSArtem Bityutskiy void ubifs_end_scan(const struct ubifs_info *c, struct ubifs_scan_leb *sleb, 17461e51764aSArtem Bityutskiy int lnum, int offs); 17471e51764aSArtem Bityutskiy int ubifs_add_snod(const struct ubifs_info *c, struct ubifs_scan_leb *sleb, 17481e51764aSArtem Bityutskiy void *buf, int offs); 17491e51764aSArtem Bityutskiy void ubifs_scanned_corruption(const struct ubifs_info *c, int lnum, int offs, 17501e51764aSArtem Bityutskiy void *buf); 17511e51764aSArtem Bityutskiy 17521e51764aSArtem Bityutskiy /* log.c */ 17531e51764aSArtem Bityutskiy void ubifs_add_bud(struct ubifs_info *c, struct ubifs_bud *bud); 17541e51764aSArtem Bityutskiy void ubifs_create_buds_lists(struct ubifs_info *c); 17551e51764aSArtem Bityutskiy int ubifs_add_bud_to_log(struct ubifs_info *c, int jhead, int lnum, int offs); 17561e51764aSArtem Bityutskiy struct ubifs_bud *ubifs_search_bud(struct ubifs_info *c, int lnum); 17571e51764aSArtem Bityutskiy struct ubifs_wbuf *ubifs_get_wbuf(struct ubifs_info *c, int lnum); 17581e51764aSArtem Bityutskiy int ubifs_log_start_commit(struct ubifs_info *c, int *ltail_lnum); 17591e51764aSArtem Bityutskiy int ubifs_log_end_commit(struct ubifs_info *c, int new_ltail_lnum); 17601e51764aSArtem Bityutskiy int ubifs_log_post_commit(struct ubifs_info *c, int old_ltail_lnum); 17611e51764aSArtem Bityutskiy int ubifs_consolidate_log(struct ubifs_info *c); 17621e51764aSArtem Bityutskiy 17631e51764aSArtem Bityutskiy /* journal.c */ 17641e51764aSArtem Bityutskiy int ubifs_jnl_update(struct ubifs_info *c, const struct inode *dir, 1765f4f61d2cSRichard Weinberger const struct fscrypt_name *nm, const struct inode *inode, 17661e51764aSArtem Bityutskiy int deletion, int xent); 17671e51764aSArtem Bityutskiy int ubifs_jnl_write_data(struct ubifs_info *c, const struct inode *inode, 17681e51764aSArtem Bityutskiy const union ubifs_key *key, const void *buf, int len); 17691f28681aSArtem Bityutskiy int ubifs_jnl_write_inode(struct ubifs_info *c, const struct inode *inode); 1770de94eb55SArtem Bityutskiy int ubifs_jnl_delete_inode(struct ubifs_info *c, const struct inode *inode); 17719ec64962SRichard Weinberger int ubifs_jnl_xrename(struct ubifs_info *c, const struct inode *fst_dir, 1772f4f61d2cSRichard Weinberger const struct inode *fst_inode, 1773f4f61d2cSRichard Weinberger const struct fscrypt_name *fst_nm, 17749ec64962SRichard Weinberger const struct inode *snd_dir, 1775f4f61d2cSRichard Weinberger const struct inode *snd_inode, 1776f4f61d2cSRichard Weinberger const struct fscrypt_name *snd_nm, int sync); 17771e51764aSArtem Bityutskiy int ubifs_jnl_rename(struct ubifs_info *c, const struct inode *old_dir, 1778f4f61d2cSRichard Weinberger const struct inode *old_inode, 1779f4f61d2cSRichard Weinberger const struct fscrypt_name *old_nm, 17801e51764aSArtem Bityutskiy const struct inode *new_dir, 1781f4f61d2cSRichard Weinberger const struct inode *new_inode, 1782f4f61d2cSRichard Weinberger const struct fscrypt_name *new_nm, 17839e0a1fffSRichard Weinberger const struct inode *whiteout, int sync); 17841e51764aSArtem Bityutskiy int ubifs_jnl_truncate(struct ubifs_info *c, const struct inode *inode, 17851e51764aSArtem Bityutskiy loff_t old_size, loff_t new_size); 17861e51764aSArtem Bityutskiy int ubifs_jnl_delete_xattr(struct ubifs_info *c, const struct inode *host, 1787f4f61d2cSRichard Weinberger const struct inode *inode, const struct fscrypt_name *nm); 17881e51764aSArtem Bityutskiy int ubifs_jnl_change_xattr(struct ubifs_info *c, const struct inode *inode1, 17891e51764aSArtem Bityutskiy const struct inode *inode2); 17901e51764aSArtem Bityutskiy 17911e51764aSArtem Bityutskiy /* budget.c */ 17921e51764aSArtem Bityutskiy int ubifs_budget_space(struct ubifs_info *c, struct ubifs_budget_req *req); 17931e51764aSArtem Bityutskiy void ubifs_release_budget(struct ubifs_info *c, struct ubifs_budget_req *req); 17941e51764aSArtem Bityutskiy void ubifs_release_dirty_inode_budget(struct ubifs_info *c, 17951e51764aSArtem Bityutskiy struct ubifs_inode *ui); 17961e51764aSArtem Bityutskiy int ubifs_budget_inode_op(struct ubifs_info *c, struct inode *inode, 17971e51764aSArtem Bityutskiy struct ubifs_budget_req *req); 17981e51764aSArtem Bityutskiy void ubifs_release_ino_dirty(struct ubifs_info *c, struct inode *inode, 17991e51764aSArtem Bityutskiy struct ubifs_budget_req *req); 18001e51764aSArtem Bityutskiy void ubifs_cancel_ino_op(struct ubifs_info *c, struct inode *inode, 18011e51764aSArtem Bityutskiy struct ubifs_budget_req *req); 18027dad181bSArtem Bityutskiy long long ubifs_get_free_space(struct ubifs_info *c); 180384abf972SArtem Bityutskiy long long ubifs_get_free_space_nolock(struct ubifs_info *c); 18041e51764aSArtem Bityutskiy int ubifs_calc_min_idx_lebs(struct ubifs_info *c); 18051e51764aSArtem Bityutskiy void ubifs_convert_page_budget(struct ubifs_info *c); 18064d61db4fSArtem Bityutskiy long long ubifs_reported_space(const struct ubifs_info *c, long long free); 18071e51764aSArtem Bityutskiy long long ubifs_calc_available(const struct ubifs_info *c, int min_idx_lebs); 18081e51764aSArtem Bityutskiy 18091e51764aSArtem Bityutskiy /* find.c */ 18103edaae7cSArtem Bityutskiy int ubifs_find_free_space(struct ubifs_info *c, int min_space, int *offs, 18111e51764aSArtem Bityutskiy int squeeze); 18121e51764aSArtem Bityutskiy int ubifs_find_free_leb_for_idx(struct ubifs_info *c); 18131e51764aSArtem Bityutskiy int ubifs_find_dirty_leb(struct ubifs_info *c, struct ubifs_lprops *ret_lp, 18141e51764aSArtem Bityutskiy int min_space, int pick_free); 18151e51764aSArtem Bityutskiy int ubifs_find_dirty_idx_leb(struct ubifs_info *c); 18161e51764aSArtem Bityutskiy int ubifs_save_dirty_idx_lnums(struct ubifs_info *c); 18171e51764aSArtem Bityutskiy 18181e51764aSArtem Bityutskiy /* tnc.c */ 18191e51764aSArtem Bityutskiy int ubifs_lookup_level0(struct ubifs_info *c, const union ubifs_key *key, 18201e51764aSArtem Bityutskiy struct ubifs_znode **zn, int *n); 18211e51764aSArtem Bityutskiy int ubifs_tnc_lookup_nm(struct ubifs_info *c, const union ubifs_key *key, 1822f4f61d2cSRichard Weinberger void *node, const struct fscrypt_name *nm); 1823528e3d17SRichard Weinberger int ubifs_tnc_lookup_dh(struct ubifs_info *c, const union ubifs_key *key, 1824528e3d17SRichard Weinberger void *node, uint32_t secondary_hash); 18251e51764aSArtem Bityutskiy int ubifs_tnc_locate(struct ubifs_info *c, const union ubifs_key *key, 18261e51764aSArtem Bityutskiy void *node, int *lnum, int *offs); 18271e51764aSArtem Bityutskiy int ubifs_tnc_add(struct ubifs_info *c, const union ubifs_key *key, int lnum, 1828823838a4SSascha Hauer int offs, int len, const u8 *hash); 18291e51764aSArtem Bityutskiy int ubifs_tnc_replace(struct ubifs_info *c, const union ubifs_key *key, 18301e51764aSArtem Bityutskiy int old_lnum, int old_offs, int lnum, int offs, int len); 18311e51764aSArtem Bityutskiy int ubifs_tnc_add_nm(struct ubifs_info *c, const union ubifs_key *key, 1832823838a4SSascha Hauer int lnum, int offs, int len, const u8 *hash, 1833823838a4SSascha Hauer const struct fscrypt_name *nm); 18341e51764aSArtem Bityutskiy int ubifs_tnc_remove(struct ubifs_info *c, const union ubifs_key *key); 18351e51764aSArtem Bityutskiy int ubifs_tnc_remove_nm(struct ubifs_info *c, const union ubifs_key *key, 1836f4f61d2cSRichard Weinberger const struct fscrypt_name *nm); 1837781f675eSRichard Weinberger int ubifs_tnc_remove_dh(struct ubifs_info *c, const union ubifs_key *key, 1838781f675eSRichard Weinberger uint32_t cookie); 18391e51764aSArtem Bityutskiy int ubifs_tnc_remove_range(struct ubifs_info *c, union ubifs_key *from_key, 18401e51764aSArtem Bityutskiy union ubifs_key *to_key); 18411e51764aSArtem Bityutskiy int ubifs_tnc_remove_ino(struct ubifs_info *c, ino_t inum); 18421e51764aSArtem Bityutskiy struct ubifs_dent_node *ubifs_tnc_next_ent(struct ubifs_info *c, 18431e51764aSArtem Bityutskiy union ubifs_key *key, 1844f4f61d2cSRichard Weinberger const struct fscrypt_name *nm); 18451e51764aSArtem Bityutskiy void ubifs_tnc_close(struct ubifs_info *c); 18461e51764aSArtem Bityutskiy int ubifs_tnc_has_node(struct ubifs_info *c, union ubifs_key *key, int level, 18471e51764aSArtem Bityutskiy int lnum, int offs, int is_idx); 18481e51764aSArtem Bityutskiy int ubifs_dirty_idx_node(struct ubifs_info *c, union ubifs_key *key, int level, 18491e51764aSArtem Bityutskiy int lnum, int offs); 18501e51764aSArtem Bityutskiy /* Shared by tnc.c for tnc_commit.c */ 18511e51764aSArtem Bityutskiy void destroy_old_idx(struct ubifs_info *c); 18521e51764aSArtem Bityutskiy int is_idx_node_in_tnc(struct ubifs_info *c, union ubifs_key *key, int level, 18531e51764aSArtem Bityutskiy int lnum, int offs); 18541e51764aSArtem Bityutskiy int insert_old_idx_znode(struct ubifs_info *c, struct ubifs_znode *znode); 18554793e7c5SAdrian Hunter int ubifs_tnc_get_bu_keys(struct ubifs_info *c, struct bu_info *bu); 18564793e7c5SAdrian Hunter int ubifs_tnc_bulk_read(struct ubifs_info *c, struct bu_info *bu); 18571e51764aSArtem Bityutskiy 18581e51764aSArtem Bityutskiy /* tnc_misc.c */ 18596eb61d58SRichard Weinberger struct ubifs_znode *ubifs_tnc_levelorder_next(const struct ubifs_info *c, 18606eb61d58SRichard Weinberger struct ubifs_znode *zr, 18611e51764aSArtem Bityutskiy struct ubifs_znode *znode); 18621e51764aSArtem Bityutskiy int ubifs_search_zbranch(const struct ubifs_info *c, 18631e51764aSArtem Bityutskiy const struct ubifs_znode *znode, 18641e51764aSArtem Bityutskiy const union ubifs_key *key, int *n); 18651e51764aSArtem Bityutskiy struct ubifs_znode *ubifs_tnc_postorder_first(struct ubifs_znode *znode); 18666eb61d58SRichard Weinberger struct ubifs_znode *ubifs_tnc_postorder_next(const struct ubifs_info *c, 18676eb61d58SRichard Weinberger struct ubifs_znode *znode); 18686eb61d58SRichard Weinberger long ubifs_destroy_tnc_subtree(const struct ubifs_info *c, 18696eb61d58SRichard Weinberger struct ubifs_znode *zr); 18701e51764aSArtem Bityutskiy struct ubifs_znode *ubifs_load_znode(struct ubifs_info *c, 18711e51764aSArtem Bityutskiy struct ubifs_zbranch *zbr, 18721e51764aSArtem Bityutskiy struct ubifs_znode *parent, int iip); 18731e51764aSArtem Bityutskiy int ubifs_tnc_read_node(struct ubifs_info *c, struct ubifs_zbranch *zbr, 18741e51764aSArtem Bityutskiy void *node); 18751e51764aSArtem Bityutskiy 18761e51764aSArtem Bityutskiy /* tnc_commit.c */ 18771e51764aSArtem Bityutskiy int ubifs_tnc_start_commit(struct ubifs_info *c, struct ubifs_zbranch *zroot); 18781e51764aSArtem Bityutskiy int ubifs_tnc_end_commit(struct ubifs_info *c); 18791e51764aSArtem Bityutskiy 18801e51764aSArtem Bityutskiy /* shrinker.c */ 18811ab6c499SDave Chinner unsigned long ubifs_shrink_scan(struct shrinker *shrink, 18821ab6c499SDave Chinner struct shrink_control *sc); 18831ab6c499SDave Chinner unsigned long ubifs_shrink_count(struct shrinker *shrink, 18841ab6c499SDave Chinner struct shrink_control *sc); 18851e51764aSArtem Bityutskiy 18861e51764aSArtem Bityutskiy /* commit.c */ 18871e51764aSArtem Bityutskiy int ubifs_bg_thread(void *info); 18881e51764aSArtem Bityutskiy void ubifs_commit_required(struct ubifs_info *c); 18891e51764aSArtem Bityutskiy void ubifs_request_bg_commit(struct ubifs_info *c); 18901e51764aSArtem Bityutskiy int ubifs_run_commit(struct ubifs_info *c); 18911e51764aSArtem Bityutskiy void ubifs_recovery_commit(struct ubifs_info *c); 18921e51764aSArtem Bityutskiy int ubifs_gc_should_commit(struct ubifs_info *c); 18931e51764aSArtem Bityutskiy void ubifs_wait_for_commit(struct ubifs_info *c); 18941e51764aSArtem Bityutskiy 18951e51764aSArtem Bityutskiy /* master.c */ 1896625700ccSSascha Hauer int ubifs_compare_master_node(struct ubifs_info *c, void *m1, void *m2); 18971e51764aSArtem Bityutskiy int ubifs_read_master(struct ubifs_info *c); 18981e51764aSArtem Bityutskiy int ubifs_write_master(struct ubifs_info *c); 18991e51764aSArtem Bityutskiy 19001e51764aSArtem Bityutskiy /* sb.c */ 19011e51764aSArtem Bityutskiy int ubifs_read_superblock(struct ubifs_info *c); 19021e51764aSArtem Bityutskiy int ubifs_write_sb_node(struct ubifs_info *c, struct ubifs_sb_node *sup); 19036554a657SMatthew L. Creech int ubifs_fixup_free_space(struct ubifs_info *c); 1904e021986eSRichard Weinberger int ubifs_enable_encryption(struct ubifs_info *c); 19051e51764aSArtem Bityutskiy 19061e51764aSArtem Bityutskiy /* replay.c */ 19071e51764aSArtem Bityutskiy int ubifs_validate_entry(struct ubifs_info *c, 19081e51764aSArtem Bityutskiy const struct ubifs_dent_node *dent); 19091e51764aSArtem Bityutskiy int ubifs_replay_journal(struct ubifs_info *c); 19101e51764aSArtem Bityutskiy 19111e51764aSArtem Bityutskiy /* gc.c */ 19121e51764aSArtem Bityutskiy int ubifs_garbage_collect(struct ubifs_info *c, int anyway); 19131e51764aSArtem Bityutskiy int ubifs_gc_start_commit(struct ubifs_info *c); 19141e51764aSArtem Bityutskiy int ubifs_gc_end_commit(struct ubifs_info *c); 1915b466f17dSAdrian Hunter void ubifs_destroy_idx_gc(struct ubifs_info *c); 19161e51764aSArtem Bityutskiy int ubifs_get_idx_gc_leb(struct ubifs_info *c); 19171e51764aSArtem Bityutskiy int ubifs_garbage_collect_leb(struct ubifs_info *c, struct ubifs_lprops *lp); 19181e51764aSArtem Bityutskiy 19191e51764aSArtem Bityutskiy /* orphan.c */ 19201e51764aSArtem Bityutskiy int ubifs_add_orphan(struct ubifs_info *c, ino_t inum); 19211e51764aSArtem Bityutskiy void ubifs_delete_orphan(struct ubifs_info *c, ino_t inum); 19221e51764aSArtem Bityutskiy int ubifs_orphan_start_commit(struct ubifs_info *c); 19231e51764aSArtem Bityutskiy int ubifs_orphan_end_commit(struct ubifs_info *c); 19241e51764aSArtem Bityutskiy int ubifs_mount_orphans(struct ubifs_info *c, int unclean, int read_only); 192549d128aaSAdrian Hunter int ubifs_clear_orphans(struct ubifs_info *c); 19261e51764aSArtem Bityutskiy 19271e51764aSArtem Bityutskiy /* lpt.c */ 19281e51764aSArtem Bityutskiy int ubifs_calc_lpt_geom(struct ubifs_info *c); 19291e51764aSArtem Bityutskiy int ubifs_create_dflt_lpt(struct ubifs_info *c, int *main_lebs, int lpt_first, 1930b5b1f083SSascha Hauer int *lpt_lebs, int *big_lpt, u8 *hash); 19311e51764aSArtem Bityutskiy int ubifs_lpt_init(struct ubifs_info *c, int rd, int wr); 19321e51764aSArtem Bityutskiy struct ubifs_lprops *ubifs_lpt_lookup(struct ubifs_info *c, int lnum); 19331e51764aSArtem Bityutskiy struct ubifs_lprops *ubifs_lpt_lookup_dirty(struct ubifs_info *c, int lnum); 19341e51764aSArtem Bityutskiy int ubifs_lpt_scan_nolock(struct ubifs_info *c, int start_lnum, int end_lnum, 19351e51764aSArtem Bityutskiy ubifs_lpt_scan_callback scan_cb, void *data); 19361e51764aSArtem Bityutskiy 19371e51764aSArtem Bityutskiy /* Shared by lpt.c for lpt_commit.c */ 19381e51764aSArtem Bityutskiy void ubifs_pack_lsave(struct ubifs_info *c, void *buf, int *lsave); 19391e51764aSArtem Bityutskiy void ubifs_pack_ltab(struct ubifs_info *c, void *buf, 19401e51764aSArtem Bityutskiy struct ubifs_lpt_lprops *ltab); 19411e51764aSArtem Bityutskiy void ubifs_pack_pnode(struct ubifs_info *c, void *buf, 19421e51764aSArtem Bityutskiy struct ubifs_pnode *pnode); 19431e51764aSArtem Bityutskiy void ubifs_pack_nnode(struct ubifs_info *c, void *buf, 19441e51764aSArtem Bityutskiy struct ubifs_nnode *nnode); 19451e51764aSArtem Bityutskiy struct ubifs_pnode *ubifs_get_pnode(struct ubifs_info *c, 19461e51764aSArtem Bityutskiy struct ubifs_nnode *parent, int iip); 19471e51764aSArtem Bityutskiy struct ubifs_nnode *ubifs_get_nnode(struct ubifs_info *c, 19481e51764aSArtem Bityutskiy struct ubifs_nnode *parent, int iip); 19490e26b6e2SSascha Hauer struct ubifs_pnode *ubifs_pnode_lookup(struct ubifs_info *c, int i); 19501e51764aSArtem Bityutskiy int ubifs_read_nnode(struct ubifs_info *c, struct ubifs_nnode *parent, int iip); 19511e51764aSArtem Bityutskiy void ubifs_add_lpt_dirt(struct ubifs_info *c, int lnum, int dirty); 19521e51764aSArtem Bityutskiy void ubifs_add_nnode_dirt(struct ubifs_info *c, struct ubifs_nnode *nnode); 19536eb61d58SRichard Weinberger uint32_t ubifs_unpack_bits(const struct ubifs_info *c, uint8_t **addr, int *pos, int nrbits); 19541e51764aSArtem Bityutskiy struct ubifs_nnode *ubifs_first_nnode(struct ubifs_info *c, int *hght); 19552ba5f7aeSArtem Bityutskiy /* Needed only in debugging code in lpt_commit.c */ 19562ba5f7aeSArtem Bityutskiy int ubifs_unpack_nnode(const struct ubifs_info *c, void *buf, 19572ba5f7aeSArtem Bityutskiy struct ubifs_nnode *nnode); 1958a1dc5814SSascha Hauer int ubifs_lpt_calc_hash(struct ubifs_info *c, u8 *hash); 19591e51764aSArtem Bityutskiy 19601e51764aSArtem Bityutskiy /* lpt_commit.c */ 19611e51764aSArtem Bityutskiy int ubifs_lpt_start_commit(struct ubifs_info *c); 19621e51764aSArtem Bityutskiy int ubifs_lpt_end_commit(struct ubifs_info *c); 19631e51764aSArtem Bityutskiy int ubifs_lpt_post_commit(struct ubifs_info *c); 19641e51764aSArtem Bityutskiy void ubifs_lpt_free(struct ubifs_info *c, int wr_only); 19651e51764aSArtem Bityutskiy 19661e51764aSArtem Bityutskiy /* lprops.c */ 19671e51764aSArtem Bityutskiy const struct ubifs_lprops *ubifs_change_lp(struct ubifs_info *c, 19681e51764aSArtem Bityutskiy const struct ubifs_lprops *lp, 19691e51764aSArtem Bityutskiy int free, int dirty, int flags, 19701e51764aSArtem Bityutskiy int idx_gc_cnt); 197184abf972SArtem Bityutskiy void ubifs_get_lp_stats(struct ubifs_info *c, struct ubifs_lp_stats *lst); 19721e51764aSArtem Bityutskiy void ubifs_add_to_cat(struct ubifs_info *c, struct ubifs_lprops *lprops, 19731e51764aSArtem Bityutskiy int cat); 19741e51764aSArtem Bityutskiy void ubifs_replace_cat(struct ubifs_info *c, struct ubifs_lprops *old_lprops, 19751e51764aSArtem Bityutskiy struct ubifs_lprops *new_lprops); 19761e51764aSArtem Bityutskiy void ubifs_ensure_cat(struct ubifs_info *c, struct ubifs_lprops *lprops); 19771e51764aSArtem Bityutskiy int ubifs_categorize_lprops(const struct ubifs_info *c, 19781e51764aSArtem Bityutskiy const struct ubifs_lprops *lprops); 19791e51764aSArtem Bityutskiy int ubifs_change_one_lp(struct ubifs_info *c, int lnum, int free, int dirty, 19801e51764aSArtem Bityutskiy int flags_set, int flags_clean, int idx_gc_cnt); 19811e51764aSArtem Bityutskiy int ubifs_update_one_lp(struct ubifs_info *c, int lnum, int free, int dirty, 19821e51764aSArtem Bityutskiy int flags_set, int flags_clean); 19831e51764aSArtem Bityutskiy int ubifs_read_one_lp(struct ubifs_info *c, int lnum, struct ubifs_lprops *lp); 19841e51764aSArtem Bityutskiy const struct ubifs_lprops *ubifs_fast_find_free(struct ubifs_info *c); 19851e51764aSArtem Bityutskiy const struct ubifs_lprops *ubifs_fast_find_empty(struct ubifs_info *c); 19861e51764aSArtem Bityutskiy const struct ubifs_lprops *ubifs_fast_find_freeable(struct ubifs_info *c); 19871e51764aSArtem Bityutskiy const struct ubifs_lprops *ubifs_fast_find_frdi_idx(struct ubifs_info *c); 1988be9e62a7SArtem Bityutskiy int ubifs_calc_dark(const struct ubifs_info *c, int spc); 19891e51764aSArtem Bityutskiy 19901e51764aSArtem Bityutskiy /* file.c */ 199102c24a82SJosef Bacik int ubifs_fsync(struct file *file, loff_t start, loff_t end, int datasync); 19921e51764aSArtem Bityutskiy int ubifs_setattr(struct dentry *dentry, struct iattr *attr); 199395582b00SDeepa Dinamani int ubifs_update_time(struct inode *inode, struct timespec64 *time, int flags); 19941e51764aSArtem Bityutskiy 19951e51764aSArtem Bityutskiy /* dir.c */ 1996d475a507SRichard Weinberger struct inode *ubifs_new_inode(struct ubifs_info *c, struct inode *dir, 1997ad44be5cSAl Viro umode_t mode); 1998a528d35eSDavid Howells int ubifs_getattr(const struct path *path, struct kstat *stat, 1999a528d35eSDavid Howells u32 request_mask, unsigned int flags); 2000f6337d84SRichard Weinberger int ubifs_check_dir_empty(struct inode *dir); 20011e51764aSArtem Bityutskiy 20021e51764aSArtem Bityutskiy /* xattr.c */ 20032b88fc21SAndreas Gruenbacher extern const struct xattr_handler *ubifs_xattr_handlers[]; 20041e51764aSArtem Bityutskiy ssize_t ubifs_listxattr(struct dentry *dentry, char *buffer, size_t size); 2005ade46c3aSRichard Weinberger int ubifs_xattr_set(struct inode *host, const char *name, const void *value, 2006d8db5b1cSXiaolei Li size_t size, int flags, bool check_lock); 2007ade46c3aSRichard Weinberger ssize_t ubifs_xattr_get(struct inode *host, const char *name, void *buf, 2008ade46c3aSRichard Weinberger size_t size); 20097e5471ceSStefan Agner 20107e5471ceSStefan Agner #ifdef CONFIG_UBIFS_FS_XATTR 2011272eda82SRichard Weinberger void ubifs_evict_xattr_inode(struct ubifs_info *c, ino_t xattr_inum); 2012481a9b80SYueHaibing int ubifs_purge_xattrs(struct inode *host); 20137e5471ceSStefan Agner #else 20147e5471ceSStefan Agner static inline void ubifs_evict_xattr_inode(struct ubifs_info *c, 20157e5471ceSStefan Agner ino_t xattr_inum) { } 2016481a9b80SYueHaibing static inline int ubifs_purge_xattrs(struct inode *host) 2017481a9b80SYueHaibing { 2018481a9b80SYueHaibing return 0; 2019481a9b80SYueHaibing } 20207e5471ceSStefan Agner #endif 20211e51764aSArtem Bityutskiy 20228326c1eeSHyunchul Lee #ifdef CONFIG_UBIFS_FS_SECURITY 20238326c1eeSHyunchul Lee extern int ubifs_init_security(struct inode *dentry, struct inode *inode, 20248326c1eeSHyunchul Lee const struct qstr *qstr); 20258326c1eeSHyunchul Lee #else 20268326c1eeSHyunchul Lee static inline int ubifs_init_security(struct inode *dentry, 20278326c1eeSHyunchul Lee struct inode *inode, const struct qstr *qstr) 20288326c1eeSHyunchul Lee { 20298326c1eeSHyunchul Lee return 0; 20308326c1eeSHyunchul Lee } 20318326c1eeSHyunchul Lee #endif 20328326c1eeSHyunchul Lee 20338326c1eeSHyunchul Lee 20341e51764aSArtem Bityutskiy /* super.c */ 20351e51764aSArtem Bityutskiy struct inode *ubifs_iget(struct super_block *sb, unsigned long inum); 20361e51764aSArtem Bityutskiy 20371e51764aSArtem Bityutskiy /* recovery.c */ 20381e51764aSArtem Bityutskiy int ubifs_recover_master_node(struct ubifs_info *c); 20391e51764aSArtem Bityutskiy int ubifs_write_rcvrd_mst_node(struct ubifs_info *c); 20401e51764aSArtem Bityutskiy struct ubifs_scan_leb *ubifs_recover_leb(struct ubifs_info *c, int lnum, 2041efcfde54SArtem Bityutskiy int offs, void *sbuf, int jhead); 20421e51764aSArtem Bityutskiy struct ubifs_scan_leb *ubifs_recover_log_leb(struct ubifs_info *c, int lnum, 20431e51764aSArtem Bityutskiy int offs, void *sbuf); 204483cef708SArtem Bityutskiy int ubifs_recover_inl_heads(struct ubifs_info *c, void *sbuf); 204583cef708SArtem Bityutskiy int ubifs_clean_lebs(struct ubifs_info *c, void *sbuf); 20461e51764aSArtem Bityutskiy int ubifs_rcvry_gc_commit(struct ubifs_info *c); 20471e51764aSArtem Bityutskiy int ubifs_recover_size_accum(struct ubifs_info *c, union ubifs_key *key, 20481e51764aSArtem Bityutskiy int deletion, loff_t new_size); 20491e76592fSSascha Hauer int ubifs_recover_size(struct ubifs_info *c, bool in_place); 20501e51764aSArtem Bityutskiy void ubifs_destroy_size_tree(struct ubifs_info *c); 20511e51764aSArtem Bityutskiy 20521e51764aSArtem Bityutskiy /* ioctl.c */ 20531e51764aSArtem Bityutskiy long ubifs_ioctl(struct file *file, unsigned int cmd, unsigned long arg); 20541e51764aSArtem Bityutskiy void ubifs_set_inode_flags(struct inode *inode); 20551e51764aSArtem Bityutskiy #ifdef CONFIG_COMPAT 20561e51764aSArtem Bityutskiy long ubifs_compat_ioctl(struct file *file, unsigned int cmd, unsigned long arg); 20571e51764aSArtem Bityutskiy #endif 20581e51764aSArtem Bityutskiy 20591e51764aSArtem Bityutskiy /* compressor.c */ 20601e51764aSArtem Bityutskiy int __init ubifs_compressors_init(void); 2061995be045SAlexey Dobriyan void ubifs_compressors_exit(void); 2062235c362bSSheng Yong void ubifs_compress(const struct ubifs_info *c, const void *in_buf, int in_len, 2063235c362bSSheng Yong void *out_buf, int *out_len, int *compr_type); 2064235c362bSSheng Yong int ubifs_decompress(const struct ubifs_info *c, const void *buf, int len, 2065235c362bSSheng Yong void *out, int *out_len, int compr_type); 20661e51764aSArtem Bityutskiy 20671e51764aSArtem Bityutskiy #include "debug.h" 20681e51764aSArtem Bityutskiy #include "misc.h" 20691e51764aSArtem Bityutskiy #include "key.h" 20701e51764aSArtem Bityutskiy 2071643fa961SChandan Rajendra #ifndef CONFIG_FS_ENCRYPTION 20727799953bSRichard Weinberger static inline int ubifs_encrypt(const struct inode *inode, 20737799953bSRichard Weinberger struct ubifs_data_node *dn, 20747799953bSRichard Weinberger unsigned int in_len, unsigned int *out_len, 20757799953bSRichard Weinberger int block) 20767799953bSRichard Weinberger { 20776eb61d58SRichard Weinberger struct ubifs_info *c = inode->i_sb->s_fs_info; 20786eb61d58SRichard Weinberger ubifs_assert(c, 0); 20797799953bSRichard Weinberger return -EOPNOTSUPP; 20807799953bSRichard Weinberger } 20817799953bSRichard Weinberger static inline int ubifs_decrypt(const struct inode *inode, 20827799953bSRichard Weinberger struct ubifs_data_node *dn, 20837799953bSRichard Weinberger unsigned int *out_len, int block) 20847799953bSRichard Weinberger { 20856eb61d58SRichard Weinberger struct ubifs_info *c = inode->i_sb->s_fs_info; 20866eb61d58SRichard Weinberger ubifs_assert(c, 0); 20877799953bSRichard Weinberger return -EOPNOTSUPP; 20887799953bSRichard Weinberger } 20897799953bSRichard Weinberger #else 20907799953bSRichard Weinberger /* crypto.c */ 20917799953bSRichard Weinberger int ubifs_encrypt(const struct inode *inode, struct ubifs_data_node *dn, 20927799953bSRichard Weinberger unsigned int in_len, unsigned int *out_len, int block); 20937799953bSRichard Weinberger int ubifs_decrypt(const struct inode *inode, struct ubifs_data_node *dn, 20947799953bSRichard Weinberger unsigned int *out_len, int block); 2095d475a507SRichard Weinberger #endif 2096d475a507SRichard Weinberger 20976f69f0edSEric Biggers extern const struct fscrypt_operations ubifs_crypt_operations; 20987799953bSRichard Weinberger 20993e7f2c51SJoe Perches /* Normal UBIFS messages */ 21003e7f2c51SJoe Perches __printf(2, 3) 21013e7f2c51SJoe Perches void ubifs_msg(const struct ubifs_info *c, const char *fmt, ...); 21023e7f2c51SJoe Perches __printf(2, 3) 21033e7f2c51SJoe Perches void ubifs_err(const struct ubifs_info *c, const char *fmt, ...); 21043e7f2c51SJoe Perches __printf(2, 3) 21053e7f2c51SJoe Perches void ubifs_warn(const struct ubifs_info *c, const char *fmt, ...); 21063e7f2c51SJoe Perches /* 2107380bc8b7SDaniel Golle * A conditional variant of 'ubifs_err()' which doesn't output anything 21081751e8a6SLinus Torvalds * if probing (ie. SB_SILENT set). 21093e7f2c51SJoe Perches */ 21103e7f2c51SJoe Perches #define ubifs_errc(c, fmt, ...) \ 21113e7f2c51SJoe Perches do { \ 21123e7f2c51SJoe Perches if (!(c)->probing) \ 21133e7f2c51SJoe Perches ubifs_err(c, fmt, ##__VA_ARGS__); \ 21143e7f2c51SJoe Perches } while (0) 21153e7f2c51SJoe Perches 21161e51764aSArtem Bityutskiy #endif /* !__UBIFS_H__ */ 2117