11e51764aSArtem Bityutskiy /* 21e51764aSArtem Bityutskiy * This file is part of UBIFS. 31e51764aSArtem Bityutskiy * 41e51764aSArtem Bityutskiy * Copyright (C) 2006-2008 Nokia Corporation 51e51764aSArtem Bityutskiy * 61e51764aSArtem Bityutskiy * This program is free software; you can redistribute it and/or modify it 71e51764aSArtem Bityutskiy * under the terms of the GNU General Public License version 2 as published by 81e51764aSArtem Bityutskiy * the Free Software Foundation. 91e51764aSArtem Bityutskiy * 101e51764aSArtem Bityutskiy * This program is distributed in the hope that it will be useful, but WITHOUT 111e51764aSArtem Bityutskiy * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 121e51764aSArtem Bityutskiy * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for 131e51764aSArtem Bityutskiy * more details. 141e51764aSArtem Bityutskiy * 151e51764aSArtem Bityutskiy * You should have received a copy of the GNU General Public License along with 161e51764aSArtem Bityutskiy * this program; if not, write to the Free Software Foundation, Inc., 51 171e51764aSArtem Bityutskiy * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA 181e51764aSArtem Bityutskiy * 191e51764aSArtem Bityutskiy * Authors: Artem Bityutskiy (Битюцкий Артём) 201e51764aSArtem Bityutskiy * Adrian Hunter 211e51764aSArtem Bityutskiy */ 221e51764aSArtem Bityutskiy 231e51764aSArtem Bityutskiy #ifndef __UBIFS_H__ 241e51764aSArtem Bityutskiy #define __UBIFS_H__ 251e51764aSArtem Bityutskiy 261e51764aSArtem Bityutskiy #include <asm/div64.h> 271e51764aSArtem Bityutskiy #include <linux/statfs.h> 281e51764aSArtem Bityutskiy #include <linux/fs.h> 291e51764aSArtem Bityutskiy #include <linux/err.h> 301e51764aSArtem Bityutskiy #include <linux/sched.h> 315a0e3ad6STejun Heo #include <linux/slab.h> 321e51764aSArtem Bityutskiy #include <linux/vmalloc.h> 331e51764aSArtem Bityutskiy #include <linux/spinlock.h> 341e51764aSArtem Bityutskiy #include <linux/mutex.h> 351e51764aSArtem Bityutskiy #include <linux/rwsem.h> 361e51764aSArtem Bityutskiy #include <linux/mtd/ubi.h> 371e51764aSArtem Bityutskiy #include <linux/pagemap.h> 381e51764aSArtem Bityutskiy #include <linux/backing-dev.h> 39d7f0b70dSSubodh Nijsure #include <linux/security.h> 402b88fc21SAndreas Gruenbacher #include <linux/xattr.h> 41cc41a536SRichard Weinberger #include <linux/random.h> 42734f0d24SDave Chinner 43734f0d24SDave Chinner #define __FS_HAS_ENCRYPTION IS_ENABLED(CONFIG_UBIFS_FS_ENCRYPTION) 44734f0d24SDave Chinner #include <linux/fscrypt.h> 45734f0d24SDave Chinner 461e51764aSArtem Bityutskiy #include "ubifs-media.h" 471e51764aSArtem Bityutskiy 481e51764aSArtem Bityutskiy /* Version of this UBIFS implementation */ 491e51764aSArtem Bityutskiy #define UBIFS_VERSION 1 501e51764aSArtem Bityutskiy 511e51764aSArtem Bityutskiy /* UBIFS file system VFS magic number */ 521e51764aSArtem Bityutskiy #define UBIFS_SUPER_MAGIC 0x24051905 531e51764aSArtem Bityutskiy 541e51764aSArtem Bityutskiy /* Number of UBIFS blocks per VFS page */ 5509cbfeafSKirill A. Shutemov #define UBIFS_BLOCKS_PER_PAGE (PAGE_SIZE / UBIFS_BLOCK_SIZE) 5609cbfeafSKirill A. Shutemov #define UBIFS_BLOCKS_PER_PAGE_SHIFT (PAGE_SHIFT - UBIFS_BLOCK_SHIFT) 571e51764aSArtem Bityutskiy 581e51764aSArtem Bityutskiy /* "File system end of life" sequence number watermark */ 591e51764aSArtem Bityutskiy #define SQNUM_WARN_WATERMARK 0xFFFFFFFF00000000ULL 601e51764aSArtem Bityutskiy #define SQNUM_WATERMARK 0xFFFFFFFFFF000000ULL 611e51764aSArtem Bityutskiy 62af14a1adSArtem Bityutskiy /* 63af14a1adSArtem Bityutskiy * Minimum amount of LEBs reserved for the index. At present the index needs at 64af14a1adSArtem Bityutskiy * least 2 LEBs: one for the index head and one for in-the-gaps method (which 65af14a1adSArtem Bityutskiy * currently does not cater for the index head and so excludes it from 66af14a1adSArtem Bityutskiy * consideration). 67af14a1adSArtem Bityutskiy */ 68af14a1adSArtem Bityutskiy #define MIN_INDEX_LEBS 2 69af14a1adSArtem Bityutskiy 701e51764aSArtem Bityutskiy /* Minimum amount of data UBIFS writes to the flash */ 711e51764aSArtem Bityutskiy #define MIN_WRITE_SZ (UBIFS_DATA_NODE_SZ + 8) 721e51764aSArtem Bityutskiy 731e51764aSArtem Bityutskiy /* 741e51764aSArtem Bityutskiy * Currently we do not support inode number overlapping and re-using, so this 751e51764aSArtem Bityutskiy * watermark defines dangerous inode number level. This should be fixed later, 761e51764aSArtem Bityutskiy * although it is difficult to exceed current limit. Another option is to use 771e51764aSArtem Bityutskiy * 64-bit inode numbers, but this means more overhead. 781e51764aSArtem Bityutskiy */ 791e51764aSArtem Bityutskiy #define INUM_WARN_WATERMARK 0xFFF00000 801e51764aSArtem Bityutskiy #define INUM_WATERMARK 0xFFFFFF00 811e51764aSArtem Bityutskiy 821e51764aSArtem Bityutskiy /* Maximum number of entries in each LPT (LEB category) heap */ 831e51764aSArtem Bityutskiy #define LPT_HEAP_SZ 256 841e51764aSArtem Bityutskiy 851e51764aSArtem Bityutskiy /* 861e51764aSArtem Bityutskiy * Background thread name pattern. The numbers are UBI device and volume 871e51764aSArtem Bityutskiy * numbers. 881e51764aSArtem Bityutskiy */ 891e51764aSArtem Bityutskiy #define BGT_NAME_PATTERN "ubifs_bgt%d_%d" 901e51764aSArtem Bityutskiy 911e51764aSArtem Bityutskiy /* Maximum possible inode number (only 32-bit inodes are supported now) */ 921e51764aSArtem Bityutskiy #define MAX_INUM 0xFFFFFFFF 931e51764aSArtem Bityutskiy 941e51764aSArtem Bityutskiy /* Number of non-data journal heads */ 951e51764aSArtem Bityutskiy #define NONDATA_JHEADS_CNT 2 961e51764aSArtem Bityutskiy 97d6d14009SArtem Bityutskiy /* Shorter names for journal head numbers for internal usage */ 98d6d14009SArtem Bityutskiy #define GCHD UBIFS_GC_HEAD 99d6d14009SArtem Bityutskiy #define BASEHD UBIFS_BASE_HEAD 100d6d14009SArtem Bityutskiy #define DATAHD UBIFS_DATA_HEAD 1011e51764aSArtem Bityutskiy 1021e51764aSArtem Bityutskiy /* 'No change' value for 'ubifs_change_lp()' */ 1031e51764aSArtem Bityutskiy #define LPROPS_NC 0x80000001 1041e51764aSArtem Bityutskiy 1051e51764aSArtem Bityutskiy /* 1061e51764aSArtem Bityutskiy * There is no notion of truncation key because truncation nodes do not exist 1071e51764aSArtem Bityutskiy * in TNC. However, when replaying, it is handy to introduce fake "truncation" 1081e51764aSArtem Bityutskiy * keys for truncation nodes because the code becomes simpler. So we define 1091e51764aSArtem Bityutskiy * %UBIFS_TRUN_KEY type. 110ba2f48f7SArtem Bityutskiy * 111ba2f48f7SArtem Bityutskiy * But otherwise, out of the journal reply scope, the truncation keys are 112ba2f48f7SArtem Bityutskiy * invalid. 1131e51764aSArtem Bityutskiy */ 1141e51764aSArtem Bityutskiy #define UBIFS_TRUN_KEY UBIFS_KEY_TYPES_CNT 115ba2f48f7SArtem Bityutskiy #define UBIFS_INVALID_KEY UBIFS_KEY_TYPES_CNT 1161e51764aSArtem Bityutskiy 1171e51764aSArtem Bityutskiy /* 1181e51764aSArtem Bityutskiy * How much a directory entry/extended attribute entry adds to the parent/host 1191e51764aSArtem Bityutskiy * inode. 1201e51764aSArtem Bityutskiy */ 1211e51764aSArtem Bityutskiy #define CALC_DENT_SIZE(name_len) ALIGN(UBIFS_DENT_NODE_SZ + (name_len) + 1, 8) 1221e51764aSArtem Bityutskiy 1231e51764aSArtem Bityutskiy /* How much an extended attribute adds to the host inode */ 1241e51764aSArtem Bityutskiy #define CALC_XATTR_BYTES(data_len) ALIGN(UBIFS_INO_NODE_SZ + (data_len) + 1, 8) 1251e51764aSArtem Bityutskiy 1261e51764aSArtem Bityutskiy /* 1271e51764aSArtem Bityutskiy * Znodes which were not touched for 'OLD_ZNODE_AGE' seconds are considered 1281e51764aSArtem Bityutskiy * "old", and znode which were touched last 'YOUNG_ZNODE_AGE' seconds ago are 1291e51764aSArtem Bityutskiy * considered "young". This is used by shrinker when selecting znode to trim 1301e51764aSArtem Bityutskiy * off. 1311e51764aSArtem Bityutskiy */ 1321e51764aSArtem Bityutskiy #define OLD_ZNODE_AGE 20 1331e51764aSArtem Bityutskiy #define YOUNG_ZNODE_AGE 5 1341e51764aSArtem Bityutskiy 1351e51764aSArtem Bityutskiy /* 1361e51764aSArtem Bityutskiy * Some compressors, like LZO, may end up with more data then the input buffer. 1371e51764aSArtem Bityutskiy * So UBIFS always allocates larger output buffer, to be sure the compressor 1381e51764aSArtem Bityutskiy * will not corrupt memory in case of worst case compression. 1391e51764aSArtem Bityutskiy */ 1401e51764aSArtem Bityutskiy #define WORST_COMPR_FACTOR 2 1411e51764aSArtem Bityutskiy 1427799953bSRichard Weinberger #ifdef CONFIG_UBIFS_FS_ENCRYPTION 1437799953bSRichard Weinberger #define UBIFS_CIPHER_BLOCK_SIZE FS_CRYPTO_BLOCK_SIZE 1447799953bSRichard Weinberger #else 1457799953bSRichard Weinberger #define UBIFS_CIPHER_BLOCK_SIZE 0 1467799953bSRichard Weinberger #endif 1477799953bSRichard Weinberger 148d882962fSMatthew L. Creech /* 149d3f9db00SYannick Guerrini * How much memory is needed for a buffer where we compress a data node. 150d882962fSMatthew L. Creech */ 151d882962fSMatthew L. Creech #define COMPRESSED_DATA_NODE_BUF_SZ \ 152d882962fSMatthew L. Creech (UBIFS_DATA_NODE_SZ + UBIFS_BLOCK_SIZE * WORST_COMPR_FACTOR) 153d882962fSMatthew L. Creech 1541e51764aSArtem Bityutskiy /* Maximum expected tree height for use by bottom_up_buf */ 1551e51764aSArtem Bityutskiy #define BOTTOM_UP_HEIGHT 64 1561e51764aSArtem Bityutskiy 1574793e7c5SAdrian Hunter /* Maximum number of data nodes to bulk-read */ 1584793e7c5SAdrian Hunter #define UBIFS_MAX_BULK_READ 32 1594793e7c5SAdrian Hunter 1601e51764aSArtem Bityutskiy /* 1611e51764aSArtem Bityutskiy * Lockdep classes for UBIFS inode @ui_mutex. 1621e51764aSArtem Bityutskiy */ 1631e51764aSArtem Bityutskiy enum { 1641e51764aSArtem Bityutskiy WB_MUTEX_1 = 0, 1651e51764aSArtem Bityutskiy WB_MUTEX_2 = 1, 1661e51764aSArtem Bityutskiy WB_MUTEX_3 = 2, 1679e0a1fffSRichard Weinberger WB_MUTEX_4 = 3, 1681e51764aSArtem Bityutskiy }; 1691e51764aSArtem Bityutskiy 1701e51764aSArtem Bityutskiy /* 1711e51764aSArtem Bityutskiy * Znode flags (actually, bit numbers which store the flags). 1721e51764aSArtem Bityutskiy * 1731e51764aSArtem Bityutskiy * DIRTY_ZNODE: znode is dirty 1741e51764aSArtem Bityutskiy * COW_ZNODE: znode is being committed and a new instance of this znode has to 1751e51764aSArtem Bityutskiy * be created before changing this znode 1761e51764aSArtem Bityutskiy * OBSOLETE_ZNODE: znode is obsolete, which means it was deleted, but it is 1771e51764aSArtem Bityutskiy * still in the commit list and the ongoing commit operation 1781e51764aSArtem Bityutskiy * will commit it, and delete this znode after it is done 1791e51764aSArtem Bityutskiy */ 1801e51764aSArtem Bityutskiy enum { 1811e51764aSArtem Bityutskiy DIRTY_ZNODE = 0, 1821e51764aSArtem Bityutskiy COW_ZNODE = 1, 1831e51764aSArtem Bityutskiy OBSOLETE_ZNODE = 2, 1841e51764aSArtem Bityutskiy }; 1851e51764aSArtem Bityutskiy 1861e51764aSArtem Bityutskiy /* 1871e51764aSArtem Bityutskiy * Commit states. 1881e51764aSArtem Bityutskiy * 1891e51764aSArtem Bityutskiy * COMMIT_RESTING: commit is not wanted 1901e51764aSArtem Bityutskiy * COMMIT_BACKGROUND: background commit has been requested 1911e51764aSArtem Bityutskiy * COMMIT_REQUIRED: commit is required 1921e51764aSArtem Bityutskiy * COMMIT_RUNNING_BACKGROUND: background commit is running 1931e51764aSArtem Bityutskiy * COMMIT_RUNNING_REQUIRED: commit is running and it is required 1941e51764aSArtem Bityutskiy * COMMIT_BROKEN: commit failed 1951e51764aSArtem Bityutskiy */ 1961e51764aSArtem Bityutskiy enum { 1971e51764aSArtem Bityutskiy COMMIT_RESTING = 0, 1981e51764aSArtem Bityutskiy COMMIT_BACKGROUND, 1991e51764aSArtem Bityutskiy COMMIT_REQUIRED, 2001e51764aSArtem Bityutskiy COMMIT_RUNNING_BACKGROUND, 2011e51764aSArtem Bityutskiy COMMIT_RUNNING_REQUIRED, 2021e51764aSArtem Bityutskiy COMMIT_BROKEN, 2031e51764aSArtem Bityutskiy }; 2041e51764aSArtem Bityutskiy 2051e51764aSArtem Bityutskiy /* 2061e51764aSArtem Bityutskiy * 'ubifs_scan_a_node()' return values. 2071e51764aSArtem Bityutskiy * 2081e51764aSArtem Bityutskiy * SCANNED_GARBAGE: scanned garbage 2091e51764aSArtem Bityutskiy * SCANNED_EMPTY_SPACE: scanned empty space 2101e51764aSArtem Bityutskiy * SCANNED_A_NODE: scanned a valid node 2111e51764aSArtem Bityutskiy * SCANNED_A_CORRUPT_NODE: scanned a corrupted node 2121e51764aSArtem Bityutskiy * SCANNED_A_BAD_PAD_NODE: scanned a padding node with invalid pad length 2131e51764aSArtem Bityutskiy * 2141e51764aSArtem Bityutskiy * Greater than zero means: 'scanned that number of padding bytes' 2151e51764aSArtem Bityutskiy */ 2161e51764aSArtem Bityutskiy enum { 2171e51764aSArtem Bityutskiy SCANNED_GARBAGE = 0, 2181e51764aSArtem Bityutskiy SCANNED_EMPTY_SPACE = -1, 2191e51764aSArtem Bityutskiy SCANNED_A_NODE = -2, 2201e51764aSArtem Bityutskiy SCANNED_A_CORRUPT_NODE = -3, 2211e51764aSArtem Bityutskiy SCANNED_A_BAD_PAD_NODE = -4, 2221e51764aSArtem Bityutskiy }; 2231e51764aSArtem Bityutskiy 2241e51764aSArtem Bityutskiy /* 2251e51764aSArtem Bityutskiy * LPT cnode flag bits. 2261e51764aSArtem Bityutskiy * 2271e51764aSArtem Bityutskiy * DIRTY_CNODE: cnode is dirty 2281e51764aSArtem Bityutskiy * OBSOLETE_CNODE: cnode is being committed and has been copied (or deleted), 2291e51764aSArtem Bityutskiy * so it can (and must) be freed when the commit is finished 23037662447SArtem Bityutskiy * COW_CNODE: cnode is being committed and must be copied before writing 2311e51764aSArtem Bityutskiy */ 2321e51764aSArtem Bityutskiy enum { 2331e51764aSArtem Bityutskiy DIRTY_CNODE = 0, 23437662447SArtem Bityutskiy OBSOLETE_CNODE = 1, 23537662447SArtem Bityutskiy COW_CNODE = 2, 2361e51764aSArtem Bityutskiy }; 2371e51764aSArtem Bityutskiy 2381e51764aSArtem Bityutskiy /* 2391e51764aSArtem Bityutskiy * Dirty flag bits (lpt_drty_flgs) for LPT special nodes. 2401e51764aSArtem Bityutskiy * 2411e51764aSArtem Bityutskiy * LTAB_DIRTY: ltab node is dirty 2421e51764aSArtem Bityutskiy * LSAVE_DIRTY: lsave node is dirty 2431e51764aSArtem Bityutskiy */ 2441e51764aSArtem Bityutskiy enum { 2451e51764aSArtem Bityutskiy LTAB_DIRTY = 1, 2461e51764aSArtem Bityutskiy LSAVE_DIRTY = 2, 2471e51764aSArtem Bityutskiy }; 2481e51764aSArtem Bityutskiy 2491e51764aSArtem Bityutskiy /* 2501e51764aSArtem Bityutskiy * Return codes used by the garbage collector. 2511e51764aSArtem Bityutskiy * @LEB_FREED: the logical eraseblock was freed and is ready to use 2521e51764aSArtem Bityutskiy * @LEB_FREED_IDX: indexing LEB was freed and can be used only after the commit 2531e51764aSArtem Bityutskiy * @LEB_RETAINED: the logical eraseblock was freed and retained for GC purposes 2541e51764aSArtem Bityutskiy */ 2551e51764aSArtem Bityutskiy enum { 2561e51764aSArtem Bityutskiy LEB_FREED, 2571e51764aSArtem Bityutskiy LEB_FREED_IDX, 2581e51764aSArtem Bityutskiy LEB_RETAINED, 2591e51764aSArtem Bityutskiy }; 2601e51764aSArtem Bityutskiy 2611e51764aSArtem Bityutskiy /** 2621e51764aSArtem Bityutskiy * struct ubifs_old_idx - index node obsoleted since last commit start. 2631e51764aSArtem Bityutskiy * @rb: rb-tree node 2641e51764aSArtem Bityutskiy * @lnum: LEB number of obsoleted index node 2651e51764aSArtem Bityutskiy * @offs: offset of obsoleted index node 2661e51764aSArtem Bityutskiy */ 2671e51764aSArtem Bityutskiy struct ubifs_old_idx { 2681e51764aSArtem Bityutskiy struct rb_node rb; 2691e51764aSArtem Bityutskiy int lnum; 2701e51764aSArtem Bityutskiy int offs; 2711e51764aSArtem Bityutskiy }; 2721e51764aSArtem Bityutskiy 2731e51764aSArtem Bityutskiy /* The below union makes it easier to deal with keys */ 2741e51764aSArtem Bityutskiy union ubifs_key { 2757ca58badSArtem Bityutskiy uint8_t u8[UBIFS_SK_LEN]; 2767ca58badSArtem Bityutskiy uint32_t u32[UBIFS_SK_LEN/4]; 2777ca58badSArtem Bityutskiy uint64_t u64[UBIFS_SK_LEN/8]; 2787ca58badSArtem Bityutskiy __le32 j32[UBIFS_SK_LEN/4]; 2791e51764aSArtem Bityutskiy }; 2801e51764aSArtem Bityutskiy 2811e51764aSArtem Bityutskiy /** 2821e51764aSArtem Bityutskiy * struct ubifs_scan_node - UBIFS scanned node information. 2831e51764aSArtem Bityutskiy * @list: list of scanned nodes 2841e51764aSArtem Bityutskiy * @key: key of node scanned (if it has one) 2851e51764aSArtem Bityutskiy * @sqnum: sequence number 2861e51764aSArtem Bityutskiy * @type: type of node scanned 2871e51764aSArtem Bityutskiy * @offs: offset with LEB of node scanned 2881e51764aSArtem Bityutskiy * @len: length of node scanned 2891e51764aSArtem Bityutskiy * @node: raw node 2901e51764aSArtem Bityutskiy */ 2911e51764aSArtem Bityutskiy struct ubifs_scan_node { 2921e51764aSArtem Bityutskiy struct list_head list; 2931e51764aSArtem Bityutskiy union ubifs_key key; 2941e51764aSArtem Bityutskiy unsigned long long sqnum; 2951e51764aSArtem Bityutskiy int type; 2961e51764aSArtem Bityutskiy int offs; 2971e51764aSArtem Bityutskiy int len; 2981e51764aSArtem Bityutskiy void *node; 2991e51764aSArtem Bityutskiy }; 3001e51764aSArtem Bityutskiy 3011e51764aSArtem Bityutskiy /** 3021e51764aSArtem Bityutskiy * struct ubifs_scan_leb - UBIFS scanned LEB information. 3031e51764aSArtem Bityutskiy * @lnum: logical eraseblock number 3041e51764aSArtem Bityutskiy * @nodes_cnt: number of nodes scanned 3051e51764aSArtem Bityutskiy * @nodes: list of struct ubifs_scan_node 3061e51764aSArtem Bityutskiy * @endpt: end point (and therefore the start of empty space) 3071e51764aSArtem Bityutskiy * @buf: buffer containing entire LEB scanned 3081e51764aSArtem Bityutskiy */ 3091e51764aSArtem Bityutskiy struct ubifs_scan_leb { 3101e51764aSArtem Bityutskiy int lnum; 3111e51764aSArtem Bityutskiy int nodes_cnt; 3121e51764aSArtem Bityutskiy struct list_head nodes; 3131e51764aSArtem Bityutskiy int endpt; 3141e51764aSArtem Bityutskiy void *buf; 3151e51764aSArtem Bityutskiy }; 3161e51764aSArtem Bityutskiy 3171e51764aSArtem Bityutskiy /** 3181e51764aSArtem Bityutskiy * struct ubifs_gced_idx_leb - garbage-collected indexing LEB. 3191e51764aSArtem Bityutskiy * @list: list 3201e51764aSArtem Bityutskiy * @lnum: LEB number 3211e51764aSArtem Bityutskiy * @unmap: OK to unmap this LEB 3221e51764aSArtem Bityutskiy * 3231e51764aSArtem Bityutskiy * This data structure is used to temporary store garbage-collected indexing 3241e51764aSArtem Bityutskiy * LEBs - they are not released immediately, but only after the next commit. 3251e51764aSArtem Bityutskiy * This is needed to guarantee recoverability. 3261e51764aSArtem Bityutskiy */ 3271e51764aSArtem Bityutskiy struct ubifs_gced_idx_leb { 3281e51764aSArtem Bityutskiy struct list_head list; 3291e51764aSArtem Bityutskiy int lnum; 3301e51764aSArtem Bityutskiy int unmap; 3311e51764aSArtem Bityutskiy }; 3321e51764aSArtem Bityutskiy 3331e51764aSArtem Bityutskiy /** 3341e51764aSArtem Bityutskiy * struct ubifs_inode - UBIFS in-memory inode description. 3351e51764aSArtem Bityutskiy * @vfs_inode: VFS inode description object 3361e51764aSArtem Bityutskiy * @creat_sqnum: sequence number at time of creation 337de94eb55SArtem Bityutskiy * @del_cmtno: commit number corresponding to the time the inode was deleted, 338de94eb55SArtem Bityutskiy * protected by @c->commit_sem; 3391e51764aSArtem Bityutskiy * @xattr_size: summarized size of all extended attributes in bytes 3401e51764aSArtem Bityutskiy * @xattr_cnt: count of extended attributes this inode has 3411e51764aSArtem Bityutskiy * @xattr_names: sum of lengths of all extended attribute names belonging to 3421e51764aSArtem Bityutskiy * this inode 3431e51764aSArtem Bityutskiy * @dirty: non-zero if the inode is dirty 3441e51764aSArtem Bityutskiy * @xattr: non-zero if this is an extended attribute inode 345625bf371SArtem Bityutskiy * @bulk_read: non-zero if bulk-read should be used 3461e51764aSArtem Bityutskiy * @ui_mutex: serializes inode write-back with the rest of VFS operations, 3474793e7c5SAdrian Hunter * serializes "clean <-> dirty" state changes, serializes bulk-read, 348ba60ecabSArtem Bityutskiy * protects @dirty, @bulk_read, @ui_size, and @xattr_size 3491e51764aSArtem Bityutskiy * @ui_lock: protects @synced_i_size 3501e51764aSArtem Bityutskiy * @synced_i_size: synchronized size of inode, i.e. the value of inode size 3511e51764aSArtem Bityutskiy * currently stored on the flash; used only for regular file 3521e51764aSArtem Bityutskiy * inodes 3531e51764aSArtem Bityutskiy * @ui_size: inode size used by UBIFS when writing to flash 3541e51764aSArtem Bityutskiy * @flags: inode flags (@UBIFS_COMPR_FL, etc) 3551e51764aSArtem Bityutskiy * @compr_type: default compression type used for this inode 3564793e7c5SAdrian Hunter * @last_page_read: page number of last page read (for bulk read) 3574793e7c5SAdrian Hunter * @read_in_a_row: number of consecutive pages read in a row (for bulk read) 3581e51764aSArtem Bityutskiy * @data_len: length of the data attached to the inode 3591e51764aSArtem Bityutskiy * @data: inode's data 3601e51764aSArtem Bityutskiy * 3611e51764aSArtem Bityutskiy * @ui_mutex exists for two main reasons. At first it prevents inodes from 3621e51764aSArtem Bityutskiy * being written back while UBIFS changing them, being in the middle of an VFS 3631e51764aSArtem Bityutskiy * operation. This way UBIFS makes sure the inode fields are consistent. For 3641e51764aSArtem Bityutskiy * example, in 'ubifs_rename()' we change 3 inodes simultaneously, and 3651e51764aSArtem Bityutskiy * write-back must not write any of them before we have finished. 3661e51764aSArtem Bityutskiy * 3671e51764aSArtem Bityutskiy * The second reason is budgeting - UBIFS has to budget all operations. If an 3681e51764aSArtem Bityutskiy * operation is going to mark an inode dirty, it has to allocate budget for 3691e51764aSArtem Bityutskiy * this. It cannot just mark it dirty because there is no guarantee there will 3701e51764aSArtem Bityutskiy * be enough flash space to write the inode back later. This means UBIFS has 3711e51764aSArtem Bityutskiy * to have full control over inode "clean <-> dirty" transitions (and pages 3721e51764aSArtem Bityutskiy * actually). But unfortunately, VFS marks inodes dirty in many places, and it 3731e51764aSArtem Bityutskiy * does not ask the file-system if it is allowed to do so (there is a notifier, 3741e51764aSArtem Bityutskiy * but it is not enough), i.e., there is no mechanism to synchronize with this. 3751e51764aSArtem Bityutskiy * So UBIFS has its own inode dirty flag and its own mutex to serialize 3761e51764aSArtem Bityutskiy * "clean <-> dirty" transitions. 3771e51764aSArtem Bityutskiy * 3781e51764aSArtem Bityutskiy * The @synced_i_size field is used to make sure we never write pages which are 3791e51764aSArtem Bityutskiy * beyond last synchronized inode size. See 'ubifs_writepage()' for more 3801e51764aSArtem Bityutskiy * information. 3811e51764aSArtem Bityutskiy * 3821e51764aSArtem Bityutskiy * The @ui_size is a "shadow" variable for @inode->i_size and UBIFS uses 3831e51764aSArtem Bityutskiy * @ui_size instead of @inode->i_size. The reason for this is that UBIFS cannot 3841e51764aSArtem Bityutskiy * make sure @inode->i_size is always changed under @ui_mutex, because it 385c4361570SArtem Bityutskiy * cannot call 'truncate_setsize()' with @ui_mutex locked, because it would 386c4361570SArtem Bityutskiy * deadlock with 'ubifs_writepage()' (see file.c). All the other inode fields 387c4361570SArtem Bityutskiy * are changed under @ui_mutex, so they do not need "shadow" fields. Note, one 3881e51764aSArtem Bityutskiy * could consider to rework locking and base it on "shadow" fields. 3891e51764aSArtem Bityutskiy */ 3901e51764aSArtem Bityutskiy struct ubifs_inode { 3911e51764aSArtem Bityutskiy struct inode vfs_inode; 3921e51764aSArtem Bityutskiy unsigned long long creat_sqnum; 393de94eb55SArtem Bityutskiy unsigned long long del_cmtno; 3941e51764aSArtem Bityutskiy unsigned int xattr_size; 3951e51764aSArtem Bityutskiy unsigned int xattr_cnt; 3961e51764aSArtem Bityutskiy unsigned int xattr_names; 3971e51764aSArtem Bityutskiy unsigned int dirty:1; 3981e51764aSArtem Bityutskiy unsigned int xattr:1; 399625bf371SArtem Bityutskiy unsigned int bulk_read:1; 400a1dc080cSArtem Bityutskiy unsigned int compr_type:2; 4011e51764aSArtem Bityutskiy struct mutex ui_mutex; 4021e51764aSArtem Bityutskiy spinlock_t ui_lock; 4031e51764aSArtem Bityutskiy loff_t synced_i_size; 4041e51764aSArtem Bityutskiy loff_t ui_size; 4051e51764aSArtem Bityutskiy int flags; 4064793e7c5SAdrian Hunter pgoff_t last_page_read; 4074793e7c5SAdrian Hunter pgoff_t read_in_a_row; 4081e51764aSArtem Bityutskiy int data_len; 4091e51764aSArtem Bityutskiy void *data; 4101e51764aSArtem Bityutskiy }; 4111e51764aSArtem Bityutskiy 4121e51764aSArtem Bityutskiy /** 4131e51764aSArtem Bityutskiy * struct ubifs_unclean_leb - records a LEB recovered under read-only mode. 4141e51764aSArtem Bityutskiy * @list: list 4151e51764aSArtem Bityutskiy * @lnum: LEB number of recovered LEB 4161e51764aSArtem Bityutskiy * @endpt: offset where recovery ended 4171e51764aSArtem Bityutskiy * 4181e51764aSArtem Bityutskiy * This structure records a LEB identified during recovery that needs to be 4191e51764aSArtem Bityutskiy * cleaned but was not because UBIFS was mounted read-only. The information 4201e51764aSArtem Bityutskiy * is used to clean the LEB when remounting to read-write mode. 4211e51764aSArtem Bityutskiy */ 4221e51764aSArtem Bityutskiy struct ubifs_unclean_leb { 4231e51764aSArtem Bityutskiy struct list_head list; 4241e51764aSArtem Bityutskiy int lnum; 4251e51764aSArtem Bityutskiy int endpt; 4261e51764aSArtem Bityutskiy }; 4271e51764aSArtem Bityutskiy 4281e51764aSArtem Bityutskiy /* 4291e51764aSArtem Bityutskiy * LEB properties flags. 4301e51764aSArtem Bityutskiy * 4311e51764aSArtem Bityutskiy * LPROPS_UNCAT: not categorized 4327078202eSArtem Bityutskiy * LPROPS_DIRTY: dirty > free, dirty >= @c->dead_wm, not index 43321a60258SArtem Bityutskiy * LPROPS_DIRTY_IDX: dirty + free > @c->min_idx_node_sze and index 4347078202eSArtem Bityutskiy * LPROPS_FREE: free > 0, dirty < @c->dead_wm, not empty, not index 4351e51764aSArtem Bityutskiy * LPROPS_HEAP_CNT: number of heaps used for storing categorized LEBs 4361e51764aSArtem Bityutskiy * LPROPS_EMPTY: LEB is empty, not taken 4371e51764aSArtem Bityutskiy * LPROPS_FREEABLE: free + dirty == leb_size, not index, not taken 4381e51764aSArtem Bityutskiy * LPROPS_FRDI_IDX: free + dirty == leb_size and index, may be taken 4391e51764aSArtem Bityutskiy * LPROPS_CAT_MASK: mask for the LEB categories above 4401e51764aSArtem Bityutskiy * LPROPS_TAKEN: LEB was taken (this flag is not saved on the media) 4411e51764aSArtem Bityutskiy * LPROPS_INDEX: LEB contains indexing nodes (this flag also exists on flash) 4421e51764aSArtem Bityutskiy */ 4431e51764aSArtem Bityutskiy enum { 4441e51764aSArtem Bityutskiy LPROPS_UNCAT = 0, 4451e51764aSArtem Bityutskiy LPROPS_DIRTY = 1, 4461e51764aSArtem Bityutskiy LPROPS_DIRTY_IDX = 2, 4471e51764aSArtem Bityutskiy LPROPS_FREE = 3, 4481e51764aSArtem Bityutskiy LPROPS_HEAP_CNT = 3, 4491e51764aSArtem Bityutskiy LPROPS_EMPTY = 4, 4501e51764aSArtem Bityutskiy LPROPS_FREEABLE = 5, 4511e51764aSArtem Bityutskiy LPROPS_FRDI_IDX = 6, 4521e51764aSArtem Bityutskiy LPROPS_CAT_MASK = 15, 4531e51764aSArtem Bityutskiy LPROPS_TAKEN = 16, 4541e51764aSArtem Bityutskiy LPROPS_INDEX = 32, 4551e51764aSArtem Bityutskiy }; 4561e51764aSArtem Bityutskiy 4571e51764aSArtem Bityutskiy /** 4581e51764aSArtem Bityutskiy * struct ubifs_lprops - logical eraseblock properties. 4591e51764aSArtem Bityutskiy * @free: amount of free space in bytes 4601e51764aSArtem Bityutskiy * @dirty: amount of dirty space in bytes 4611e51764aSArtem Bityutskiy * @flags: LEB properties flags (see above) 4621e51764aSArtem Bityutskiy * @lnum: LEB number 4631e51764aSArtem Bityutskiy * @list: list of same-category lprops (for LPROPS_EMPTY and LPROPS_FREEABLE) 4641e51764aSArtem Bityutskiy * @hpos: heap position in heap of same-category lprops (other categories) 4651e51764aSArtem Bityutskiy */ 4661e51764aSArtem Bityutskiy struct ubifs_lprops { 4671e51764aSArtem Bityutskiy int free; 4681e51764aSArtem Bityutskiy int dirty; 4691e51764aSArtem Bityutskiy int flags; 4701e51764aSArtem Bityutskiy int lnum; 4711e51764aSArtem Bityutskiy union { 4721e51764aSArtem Bityutskiy struct list_head list; 4731e51764aSArtem Bityutskiy int hpos; 4741e51764aSArtem Bityutskiy }; 4751e51764aSArtem Bityutskiy }; 4761e51764aSArtem Bityutskiy 4771e51764aSArtem Bityutskiy /** 4781e51764aSArtem Bityutskiy * struct ubifs_lpt_lprops - LPT logical eraseblock properties. 4791e51764aSArtem Bityutskiy * @free: amount of free space in bytes 4801e51764aSArtem Bityutskiy * @dirty: amount of dirty space in bytes 4811e51764aSArtem Bityutskiy * @tgc: trivial GC flag (1 => unmap after commit end) 4821e51764aSArtem Bityutskiy * @cmt: commit flag (1 => reserved for commit) 4831e51764aSArtem Bityutskiy */ 4841e51764aSArtem Bityutskiy struct ubifs_lpt_lprops { 4851e51764aSArtem Bityutskiy int free; 4861e51764aSArtem Bityutskiy int dirty; 4871e51764aSArtem Bityutskiy unsigned tgc:1; 4881e51764aSArtem Bityutskiy unsigned cmt:1; 4891e51764aSArtem Bityutskiy }; 4901e51764aSArtem Bityutskiy 4911e51764aSArtem Bityutskiy /** 4921e51764aSArtem Bityutskiy * struct ubifs_lp_stats - statistics of eraseblocks in the main area. 4931e51764aSArtem Bityutskiy * @empty_lebs: number of empty LEBs 4941e51764aSArtem Bityutskiy * @taken_empty_lebs: number of taken LEBs 4951e51764aSArtem Bityutskiy * @idx_lebs: number of indexing LEBs 496d3cf502bSArtem Bityutskiy * @total_free: total free space in bytes (includes all LEBs) 497d3cf502bSArtem Bityutskiy * @total_dirty: total dirty space in bytes (includes all LEBs) 498d3cf502bSArtem Bityutskiy * @total_used: total used space in bytes (does not include index LEBs) 499d3cf502bSArtem Bityutskiy * @total_dead: total dead space in bytes (does not include index LEBs) 500d3cf502bSArtem Bityutskiy * @total_dark: total dark space in bytes (does not include index LEBs) 5011e51764aSArtem Bityutskiy * 502d3cf502bSArtem Bityutskiy * The @taken_empty_lebs field counts the LEBs that are in the transient state 503d3cf502bSArtem Bityutskiy * of having been "taken" for use but not yet written to. @taken_empty_lebs is 504d3cf502bSArtem Bityutskiy * needed to account correctly for @gc_lnum, otherwise @empty_lebs could be 505d3cf502bSArtem Bityutskiy * used by itself (in which case 'unused_lebs' would be a better name). In the 506d3cf502bSArtem Bityutskiy * case of @gc_lnum, it is "taken" at mount time or whenever a LEB is retained 507d3cf502bSArtem Bityutskiy * by GC, but unlike other empty LEBs that are "taken", it may not be written 508d3cf502bSArtem Bityutskiy * straight away (i.e. before the next commit start or unmount), so either 509d3cf502bSArtem Bityutskiy * @gc_lnum must be specially accounted for, or the current approach followed 510d3cf502bSArtem Bityutskiy * i.e. count it under @taken_empty_lebs. 5111e51764aSArtem Bityutskiy * 512d3cf502bSArtem Bityutskiy * @empty_lebs includes @taken_empty_lebs. 513d3cf502bSArtem Bityutskiy * 514d3cf502bSArtem Bityutskiy * @total_used, @total_dead and @total_dark fields do not account indexing 515d3cf502bSArtem Bityutskiy * LEBs. 5161e51764aSArtem Bityutskiy */ 5171e51764aSArtem Bityutskiy struct ubifs_lp_stats { 5181e51764aSArtem Bityutskiy int empty_lebs; 5191e51764aSArtem Bityutskiy int taken_empty_lebs; 5201e51764aSArtem Bityutskiy int idx_lebs; 5211e51764aSArtem Bityutskiy long long total_free; 5221e51764aSArtem Bityutskiy long long total_dirty; 5231e51764aSArtem Bityutskiy long long total_used; 5241e51764aSArtem Bityutskiy long long total_dead; 5251e51764aSArtem Bityutskiy long long total_dark; 5261e51764aSArtem Bityutskiy }; 5271e51764aSArtem Bityutskiy 5281e51764aSArtem Bityutskiy struct ubifs_nnode; 5291e51764aSArtem Bityutskiy 5301e51764aSArtem Bityutskiy /** 5311e51764aSArtem Bityutskiy * struct ubifs_cnode - LEB Properties Tree common node. 5321e51764aSArtem Bityutskiy * @parent: parent nnode 5331e51764aSArtem Bityutskiy * @cnext: next cnode to commit 5341e51764aSArtem Bityutskiy * @flags: flags (%DIRTY_LPT_NODE or %OBSOLETE_LPT_NODE) 5351e51764aSArtem Bityutskiy * @iip: index in parent 5361e51764aSArtem Bityutskiy * @level: level in the tree (zero for pnodes, greater than zero for nnodes) 5371e51764aSArtem Bityutskiy * @num: node number 5381e51764aSArtem Bityutskiy */ 5391e51764aSArtem Bityutskiy struct ubifs_cnode { 5401e51764aSArtem Bityutskiy struct ubifs_nnode *parent; 5411e51764aSArtem Bityutskiy struct ubifs_cnode *cnext; 5421e51764aSArtem Bityutskiy unsigned long flags; 5431e51764aSArtem Bityutskiy int iip; 5441e51764aSArtem Bityutskiy int level; 5451e51764aSArtem Bityutskiy int num; 5461e51764aSArtem Bityutskiy }; 5471e51764aSArtem Bityutskiy 5481e51764aSArtem Bityutskiy /** 5491e51764aSArtem Bityutskiy * struct ubifs_pnode - LEB Properties Tree leaf node. 5501e51764aSArtem Bityutskiy * @parent: parent nnode 5511e51764aSArtem Bityutskiy * @cnext: next cnode to commit 5521e51764aSArtem Bityutskiy * @flags: flags (%DIRTY_LPT_NODE or %OBSOLETE_LPT_NODE) 5531e51764aSArtem Bityutskiy * @iip: index in parent 5541e51764aSArtem Bityutskiy * @level: level in the tree (always zero for pnodes) 5551e51764aSArtem Bityutskiy * @num: node number 5561e51764aSArtem Bityutskiy * @lprops: LEB properties array 5571e51764aSArtem Bityutskiy */ 5581e51764aSArtem Bityutskiy struct ubifs_pnode { 5591e51764aSArtem Bityutskiy struct ubifs_nnode *parent; 5601e51764aSArtem Bityutskiy struct ubifs_cnode *cnext; 5611e51764aSArtem Bityutskiy unsigned long flags; 5621e51764aSArtem Bityutskiy int iip; 5631e51764aSArtem Bityutskiy int level; 5641e51764aSArtem Bityutskiy int num; 5651e51764aSArtem Bityutskiy struct ubifs_lprops lprops[UBIFS_LPT_FANOUT]; 5661e51764aSArtem Bityutskiy }; 5671e51764aSArtem Bityutskiy 5681e51764aSArtem Bityutskiy /** 5691e51764aSArtem Bityutskiy * struct ubifs_nbranch - LEB Properties Tree internal node branch. 5701e51764aSArtem Bityutskiy * @lnum: LEB number of child 5711e51764aSArtem Bityutskiy * @offs: offset of child 5721e51764aSArtem Bityutskiy * @nnode: nnode child 5731e51764aSArtem Bityutskiy * @pnode: pnode child 5741e51764aSArtem Bityutskiy * @cnode: cnode child 5751e51764aSArtem Bityutskiy */ 5761e51764aSArtem Bityutskiy struct ubifs_nbranch { 5771e51764aSArtem Bityutskiy int lnum; 5781e51764aSArtem Bityutskiy int offs; 5791e51764aSArtem Bityutskiy union { 5801e51764aSArtem Bityutskiy struct ubifs_nnode *nnode; 5811e51764aSArtem Bityutskiy struct ubifs_pnode *pnode; 5821e51764aSArtem Bityutskiy struct ubifs_cnode *cnode; 5831e51764aSArtem Bityutskiy }; 5841e51764aSArtem Bityutskiy }; 5851e51764aSArtem Bityutskiy 5861e51764aSArtem Bityutskiy /** 5871e51764aSArtem Bityutskiy * struct ubifs_nnode - LEB Properties Tree internal node. 5881e51764aSArtem Bityutskiy * @parent: parent nnode 5891e51764aSArtem Bityutskiy * @cnext: next cnode to commit 5901e51764aSArtem Bityutskiy * @flags: flags (%DIRTY_LPT_NODE or %OBSOLETE_LPT_NODE) 5911e51764aSArtem Bityutskiy * @iip: index in parent 5921e51764aSArtem Bityutskiy * @level: level in the tree (always greater than zero for nnodes) 5931e51764aSArtem Bityutskiy * @num: node number 5941e51764aSArtem Bityutskiy * @nbranch: branches to child nodes 5951e51764aSArtem Bityutskiy */ 5961e51764aSArtem Bityutskiy struct ubifs_nnode { 5971e51764aSArtem Bityutskiy struct ubifs_nnode *parent; 5981e51764aSArtem Bityutskiy struct ubifs_cnode *cnext; 5991e51764aSArtem Bityutskiy unsigned long flags; 6001e51764aSArtem Bityutskiy int iip; 6011e51764aSArtem Bityutskiy int level; 6021e51764aSArtem Bityutskiy int num; 6031e51764aSArtem Bityutskiy struct ubifs_nbranch nbranch[UBIFS_LPT_FANOUT]; 6041e51764aSArtem Bityutskiy }; 6051e51764aSArtem Bityutskiy 6061e51764aSArtem Bityutskiy /** 6071e51764aSArtem Bityutskiy * struct ubifs_lpt_heap - heap of categorized lprops. 6081e51764aSArtem Bityutskiy * @arr: heap array 6091e51764aSArtem Bityutskiy * @cnt: number in heap 6101e51764aSArtem Bityutskiy * @max_cnt: maximum number allowed in heap 6111e51764aSArtem Bityutskiy * 6121e51764aSArtem Bityutskiy * There are %LPROPS_HEAP_CNT heaps. 6131e51764aSArtem Bityutskiy */ 6141e51764aSArtem Bityutskiy struct ubifs_lpt_heap { 6151e51764aSArtem Bityutskiy struct ubifs_lprops **arr; 6161e51764aSArtem Bityutskiy int cnt; 6171e51764aSArtem Bityutskiy int max_cnt; 6181e51764aSArtem Bityutskiy }; 6191e51764aSArtem Bityutskiy 6201e51764aSArtem Bityutskiy /* 6211e51764aSArtem Bityutskiy * Return codes for LPT scan callback function. 6221e51764aSArtem Bityutskiy * 6231e51764aSArtem Bityutskiy * LPT_SCAN_CONTINUE: continue scanning 6241e51764aSArtem Bityutskiy * LPT_SCAN_ADD: add the LEB properties scanned to the tree in memory 6251e51764aSArtem Bityutskiy * LPT_SCAN_STOP: stop scanning 6261e51764aSArtem Bityutskiy */ 6271e51764aSArtem Bityutskiy enum { 6281e51764aSArtem Bityutskiy LPT_SCAN_CONTINUE = 0, 6291e51764aSArtem Bityutskiy LPT_SCAN_ADD = 1, 6301e51764aSArtem Bityutskiy LPT_SCAN_STOP = 2, 6311e51764aSArtem Bityutskiy }; 6321e51764aSArtem Bityutskiy 6331e51764aSArtem Bityutskiy struct ubifs_info; 6341e51764aSArtem Bityutskiy 6351e51764aSArtem Bityutskiy /* Callback used by the 'ubifs_lpt_scan_nolock()' function */ 6361e51764aSArtem Bityutskiy typedef int (*ubifs_lpt_scan_callback)(struct ubifs_info *c, 6371e51764aSArtem Bityutskiy const struct ubifs_lprops *lprops, 6381e51764aSArtem Bityutskiy int in_tree, void *data); 6391e51764aSArtem Bityutskiy 6401e51764aSArtem Bityutskiy /** 6411e51764aSArtem Bityutskiy * struct ubifs_wbuf - UBIFS write-buffer. 6421e51764aSArtem Bityutskiy * @c: UBIFS file-system description object 6431e51764aSArtem Bityutskiy * @buf: write-buffer (of min. flash I/O unit size) 6441e51764aSArtem Bityutskiy * @lnum: logical eraseblock number the write-buffer points to 6451e51764aSArtem Bityutskiy * @offs: write-buffer offset in this logical eraseblock 6461e51764aSArtem Bityutskiy * @avail: number of bytes available in the write-buffer 6471e51764aSArtem Bityutskiy * @used: number of used bytes in the write-buffer 6483c89f396SArtem Bityutskiy * @size: write-buffer size (in [@c->min_io_size, @c->max_write_size] range) 6491e51764aSArtem Bityutskiy * @jhead: journal head the mutex belongs to (note, needed only to shut lockdep 6501e51764aSArtem Bityutskiy * up by 'mutex_lock_nested()). 6511e51764aSArtem Bityutskiy * @sync_callback: write-buffer synchronization callback 6521e51764aSArtem Bityutskiy * @io_mutex: serializes write-buffer I/O 6531e51764aSArtem Bityutskiy * @lock: serializes @buf, @lnum, @offs, @avail, @used, @next_ino and @inodes 6541e51764aSArtem Bityutskiy * fields 6551e51764aSArtem Bityutskiy * @timer: write-buffer timer 656681947d2SAdrian Hunter * @no_timer: non-zero if this write-buffer does not have a timer 657681947d2SAdrian Hunter * @need_sync: non-zero if the timer expired and the wbuf needs sync'ing 6581e51764aSArtem Bityutskiy * @next_ino: points to the next position of the following inode number 6591e51764aSArtem Bityutskiy * @inodes: stores the inode numbers of the nodes which are in wbuf 6601e51764aSArtem Bityutskiy * 6611e51764aSArtem Bityutskiy * The write-buffer synchronization callback is called when the write-buffer is 6621e51764aSArtem Bityutskiy * synchronized in order to notify how much space was wasted due to 6631e51764aSArtem Bityutskiy * write-buffer padding and how much free space is left in the LEB. 6641e51764aSArtem Bityutskiy * 6651e51764aSArtem Bityutskiy * Note: the fields @buf, @lnum, @offs, @avail and @used can be read under 6661e51764aSArtem Bityutskiy * spin-lock or mutex because they are written under both mutex and spin-lock. 6671e51764aSArtem Bityutskiy * @buf is appended to under mutex but overwritten under both mutex and 6681e51764aSArtem Bityutskiy * spin-lock. Thus the data between @buf and @buf + @used can be read under 6691e51764aSArtem Bityutskiy * spinlock. 6701e51764aSArtem Bityutskiy */ 6711e51764aSArtem Bityutskiy struct ubifs_wbuf { 6721e51764aSArtem Bityutskiy struct ubifs_info *c; 6731e51764aSArtem Bityutskiy void *buf; 6741e51764aSArtem Bityutskiy int lnum; 6751e51764aSArtem Bityutskiy int offs; 6761e51764aSArtem Bityutskiy int avail; 6771e51764aSArtem Bityutskiy int used; 6783c89f396SArtem Bityutskiy int size; 6791e51764aSArtem Bityutskiy int jhead; 6801e51764aSArtem Bityutskiy int (*sync_callback)(struct ubifs_info *c, int lnum, int free, int pad); 6811e51764aSArtem Bityutskiy struct mutex io_mutex; 6821e51764aSArtem Bityutskiy spinlock_t lock; 683f2c5dbd7SArtem Bityutskiy struct hrtimer timer; 6840b335b9dSArtem Bityutskiy unsigned int no_timer:1; 6850b335b9dSArtem Bityutskiy unsigned int need_sync:1; 6861e51764aSArtem Bityutskiy int next_ino; 6871e51764aSArtem Bityutskiy ino_t *inodes; 6881e51764aSArtem Bityutskiy }; 6891e51764aSArtem Bityutskiy 6901e51764aSArtem Bityutskiy /** 6911e51764aSArtem Bityutskiy * struct ubifs_bud - bud logical eraseblock. 6921e51764aSArtem Bityutskiy * @lnum: logical eraseblock number 6931e51764aSArtem Bityutskiy * @start: where the (uncommitted) bud data starts 6941e51764aSArtem Bityutskiy * @jhead: journal head number this bud belongs to 6951e51764aSArtem Bityutskiy * @list: link in the list buds belonging to the same journal head 6961e51764aSArtem Bityutskiy * @rb: link in the tree of all buds 6971e51764aSArtem Bityutskiy */ 6981e51764aSArtem Bityutskiy struct ubifs_bud { 6991e51764aSArtem Bityutskiy int lnum; 7001e51764aSArtem Bityutskiy int start; 7011e51764aSArtem Bityutskiy int jhead; 7021e51764aSArtem Bityutskiy struct list_head list; 7031e51764aSArtem Bityutskiy struct rb_node rb; 7041e51764aSArtem Bityutskiy }; 7051e51764aSArtem Bityutskiy 7061e51764aSArtem Bityutskiy /** 7071e51764aSArtem Bityutskiy * struct ubifs_jhead - journal head. 7081e51764aSArtem Bityutskiy * @wbuf: head's write-buffer 7091e51764aSArtem Bityutskiy * @buds_list: list of bud LEBs belonging to this journal head 7101a0b0699SArtem Bityutskiy * @grouped: non-zero if UBIFS groups nodes when writing to this journal head 7111e51764aSArtem Bityutskiy * 7121e51764aSArtem Bityutskiy * Note, the @buds list is protected by the @c->buds_lock. 7131e51764aSArtem Bityutskiy */ 7141e51764aSArtem Bityutskiy struct ubifs_jhead { 7151e51764aSArtem Bityutskiy struct ubifs_wbuf wbuf; 7161e51764aSArtem Bityutskiy struct list_head buds_list; 7171a0b0699SArtem Bityutskiy unsigned int grouped:1; 7181e51764aSArtem Bityutskiy }; 7191e51764aSArtem Bityutskiy 7201e51764aSArtem Bityutskiy /** 7211e51764aSArtem Bityutskiy * struct ubifs_zbranch - key/coordinate/length branch stored in znodes. 7221e51764aSArtem Bityutskiy * @key: key 7231e51764aSArtem Bityutskiy * @znode: znode address in memory 724be61678bSArtem Bityutskiy * @lnum: LEB number of the target node (indexing node or data node) 725be61678bSArtem Bityutskiy * @offs: target node offset within @lnum 7261e51764aSArtem Bityutskiy * @len: target node length 7271e51764aSArtem Bityutskiy */ 7281e51764aSArtem Bityutskiy struct ubifs_zbranch { 7291e51764aSArtem Bityutskiy union ubifs_key key; 7301e51764aSArtem Bityutskiy union { 7311e51764aSArtem Bityutskiy struct ubifs_znode *znode; 7321e51764aSArtem Bityutskiy void *leaf; 7331e51764aSArtem Bityutskiy }; 7341e51764aSArtem Bityutskiy int lnum; 7351e51764aSArtem Bityutskiy int offs; 7361e51764aSArtem Bityutskiy int len; 7371e51764aSArtem Bityutskiy }; 7381e51764aSArtem Bityutskiy 7391e51764aSArtem Bityutskiy /** 7401e51764aSArtem Bityutskiy * struct ubifs_znode - in-memory representation of an indexing node. 7411e51764aSArtem Bityutskiy * @parent: parent znode or NULL if it is the root 7421e51764aSArtem Bityutskiy * @cnext: next znode to commit 7431e51764aSArtem Bityutskiy * @flags: znode flags (%DIRTY_ZNODE, %COW_ZNODE or %OBSOLETE_ZNODE) 7441e51764aSArtem Bityutskiy * @time: last access time (seconds) 7451e51764aSArtem Bityutskiy * @level: level of the entry in the TNC tree 7461e51764aSArtem Bityutskiy * @child_cnt: count of child znodes 7471e51764aSArtem Bityutskiy * @iip: index in parent's zbranch array 7481e51764aSArtem Bityutskiy * @alt: lower bound of key range has altered i.e. child inserted at slot 0 7491e51764aSArtem Bityutskiy * @lnum: LEB number of the corresponding indexing node 7501e51764aSArtem Bityutskiy * @offs: offset of the corresponding indexing node 7511e51764aSArtem Bityutskiy * @len: length of the corresponding indexing node 7521e51764aSArtem Bityutskiy * @zbranch: array of znode branches (@c->fanout elements) 753f70b7e52SArtem Bityutskiy * 754f70b7e52SArtem Bityutskiy * Note! The @lnum, @offs, and @len fields are not really needed - we have them 755f70b7e52SArtem Bityutskiy * only for internal consistency check. They could be removed to save some RAM. 7561e51764aSArtem Bityutskiy */ 7571e51764aSArtem Bityutskiy struct ubifs_znode { 7581e51764aSArtem Bityutskiy struct ubifs_znode *parent; 7591e51764aSArtem Bityutskiy struct ubifs_znode *cnext; 7601e51764aSArtem Bityutskiy unsigned long flags; 7616cff5732SArnd Bergmann time64_t time; 7621e51764aSArtem Bityutskiy int level; 7631e51764aSArtem Bityutskiy int child_cnt; 7641e51764aSArtem Bityutskiy int iip; 7651e51764aSArtem Bityutskiy int alt; 766f70b7e52SArtem Bityutskiy int lnum; 767f70b7e52SArtem Bityutskiy int offs; 768f70b7e52SArtem Bityutskiy int len; 7691e51764aSArtem Bityutskiy struct ubifs_zbranch zbranch[]; 7701e51764aSArtem Bityutskiy }; 7711e51764aSArtem Bityutskiy 7721e51764aSArtem Bityutskiy /** 77339ce81ceSArtem Bityutskiy * struct bu_info - bulk-read information. 7744793e7c5SAdrian Hunter * @key: first data node key 7754793e7c5SAdrian Hunter * @zbranch: zbranches of data nodes to bulk read 7764793e7c5SAdrian Hunter * @buf: buffer to read into 7774793e7c5SAdrian Hunter * @buf_len: buffer length 7784793e7c5SAdrian Hunter * @gc_seq: GC sequence number to detect races with GC 7794793e7c5SAdrian Hunter * @cnt: number of data nodes for bulk read 7804793e7c5SAdrian Hunter * @blk_cnt: number of data blocks including holes 7814793e7c5SAdrian Hunter * @oef: end of file reached 7824793e7c5SAdrian Hunter */ 7834793e7c5SAdrian Hunter struct bu_info { 7844793e7c5SAdrian Hunter union ubifs_key key; 7854793e7c5SAdrian Hunter struct ubifs_zbranch zbranch[UBIFS_MAX_BULK_READ]; 7864793e7c5SAdrian Hunter void *buf; 7874793e7c5SAdrian Hunter int buf_len; 7884793e7c5SAdrian Hunter int gc_seq; 7894793e7c5SAdrian Hunter int cnt; 7904793e7c5SAdrian Hunter int blk_cnt; 7914793e7c5SAdrian Hunter int eof; 7924793e7c5SAdrian Hunter }; 7934793e7c5SAdrian Hunter 7944793e7c5SAdrian Hunter /** 7951e51764aSArtem Bityutskiy * struct ubifs_node_range - node length range description data structure. 7961e51764aSArtem Bityutskiy * @len: fixed node length 7971e51764aSArtem Bityutskiy * @min_len: minimum possible node length 7981e51764aSArtem Bityutskiy * @max_len: maximum possible node length 7991e51764aSArtem Bityutskiy * 8001e51764aSArtem Bityutskiy * If @max_len is %0, the node has fixed length @len. 8011e51764aSArtem Bityutskiy */ 8021e51764aSArtem Bityutskiy struct ubifs_node_range { 8031e51764aSArtem Bityutskiy union { 8041e51764aSArtem Bityutskiy int len; 8051e51764aSArtem Bityutskiy int min_len; 8061e51764aSArtem Bityutskiy }; 8071e51764aSArtem Bityutskiy int max_len; 8081e51764aSArtem Bityutskiy }; 8091e51764aSArtem Bityutskiy 8101e51764aSArtem Bityutskiy /** 8111e51764aSArtem Bityutskiy * struct ubifs_compressor - UBIFS compressor description structure. 8121e51764aSArtem Bityutskiy * @compr_type: compressor type (%UBIFS_COMPR_LZO, etc) 8131e51764aSArtem Bityutskiy * @cc: cryptoapi compressor handle 8141e51764aSArtem Bityutskiy * @comp_mutex: mutex used during compression 8151e51764aSArtem Bityutskiy * @decomp_mutex: mutex used during decompression 8161e51764aSArtem Bityutskiy * @name: compressor name 8171e51764aSArtem Bityutskiy * @capi_name: cryptoapi compressor name 8181e51764aSArtem Bityutskiy */ 8191e51764aSArtem Bityutskiy struct ubifs_compressor { 8201e51764aSArtem Bityutskiy int compr_type; 8211e51764aSArtem Bityutskiy struct crypto_comp *cc; 8221e51764aSArtem Bityutskiy struct mutex *comp_mutex; 8231e51764aSArtem Bityutskiy struct mutex *decomp_mutex; 8241e51764aSArtem Bityutskiy const char *name; 8251e51764aSArtem Bityutskiy const char *capi_name; 8261e51764aSArtem Bityutskiy }; 8271e51764aSArtem Bityutskiy 8281e51764aSArtem Bityutskiy /** 8291e51764aSArtem Bityutskiy * struct ubifs_budget_req - budget requirements of an operation. 8301e51764aSArtem Bityutskiy * 831de94eb55SArtem Bityutskiy * @fast: non-zero if the budgeting should try to acquire budget quickly and 8321e51764aSArtem Bityutskiy * should not try to call write-back 8331e51764aSArtem Bityutskiy * @recalculate: non-zero if @idx_growth, @data_growth, and @dd_growth fields 8341e51764aSArtem Bityutskiy * have to be re-calculated 8351e51764aSArtem Bityutskiy * @new_page: non-zero if the operation adds a new page 8361e51764aSArtem Bityutskiy * @dirtied_page: non-zero if the operation makes a page dirty 8371e51764aSArtem Bityutskiy * @new_dent: non-zero if the operation adds a new directory entry 8381e51764aSArtem Bityutskiy * @mod_dent: non-zero if the operation removes or modifies an existing 8391e51764aSArtem Bityutskiy * directory entry 8401e51764aSArtem Bityutskiy * @new_ino: non-zero if the operation adds a new inode 8417d25b361SDongsheng Yang * @new_ino_d: how much data newly created inode contains 8421e51764aSArtem Bityutskiy * @dirtied_ino: how many inodes the operation makes dirty 8437d25b361SDongsheng Yang * @dirtied_ino_d: how much data dirtied inode contains 8441e51764aSArtem Bityutskiy * @idx_growth: how much the index will supposedly grow 8451e51764aSArtem Bityutskiy * @data_growth: how much new data the operation will supposedly add 8461e51764aSArtem Bityutskiy * @dd_growth: how much data that makes other data dirty the operation will 8471e51764aSArtem Bityutskiy * supposedly add 8481e51764aSArtem Bityutskiy * 8491e51764aSArtem Bityutskiy * @idx_growth, @data_growth and @dd_growth are not used in budget request. The 8501e51764aSArtem Bityutskiy * budgeting subsystem caches index and data growth values there to avoid 8511e51764aSArtem Bityutskiy * re-calculating them when the budget is released. However, if @idx_growth is 8521e51764aSArtem Bityutskiy * %-1, it is calculated by the release function using other fields. 8531e51764aSArtem Bityutskiy * 8541e51764aSArtem Bityutskiy * An inode may contain 4KiB of data at max., thus the widths of @new_ino_d 8551e51764aSArtem Bityutskiy * is 13 bits, and @dirtied_ino_d - 15, because up to 4 inodes may be made 8561e51764aSArtem Bityutskiy * dirty by the re-name operation. 857dab4b4d2SArtem Bityutskiy * 858dab4b4d2SArtem Bityutskiy * Note, UBIFS aligns node lengths to 8-bytes boundary, so the requester has to 859dab4b4d2SArtem Bityutskiy * make sure the amount of inode data which contribute to @new_ino_d and 860dab4b4d2SArtem Bityutskiy * @dirtied_ino_d fields are aligned. 8611e51764aSArtem Bityutskiy */ 8621e51764aSArtem Bityutskiy struct ubifs_budget_req { 8631e51764aSArtem Bityutskiy unsigned int fast:1; 8641e51764aSArtem Bityutskiy unsigned int recalculate:1; 865547000daSArtem Bityutskiy #ifndef UBIFS_DEBUG 8661e51764aSArtem Bityutskiy unsigned int new_page:1; 8671e51764aSArtem Bityutskiy unsigned int dirtied_page:1; 8681e51764aSArtem Bityutskiy unsigned int new_dent:1; 8691e51764aSArtem Bityutskiy unsigned int mod_dent:1; 8701e51764aSArtem Bityutskiy unsigned int new_ino:1; 8711e51764aSArtem Bityutskiy unsigned int new_ino_d:13; 8721e51764aSArtem Bityutskiy unsigned int dirtied_ino:4; 8731e51764aSArtem Bityutskiy unsigned int dirtied_ino_d:15; 8741e51764aSArtem Bityutskiy #else 8751e51764aSArtem Bityutskiy /* Not bit-fields to check for overflows */ 876547000daSArtem Bityutskiy unsigned int new_page; 877547000daSArtem Bityutskiy unsigned int dirtied_page; 878547000daSArtem Bityutskiy unsigned int new_dent; 879547000daSArtem Bityutskiy unsigned int mod_dent; 880547000daSArtem Bityutskiy unsigned int new_ino; 881547000daSArtem Bityutskiy unsigned int new_ino_d; 8821e51764aSArtem Bityutskiy unsigned int dirtied_ino; 8831e51764aSArtem Bityutskiy unsigned int dirtied_ino_d; 8841e51764aSArtem Bityutskiy #endif 8851e51764aSArtem Bityutskiy int idx_growth; 8861e51764aSArtem Bityutskiy int data_growth; 8871e51764aSArtem Bityutskiy int dd_growth; 8881e51764aSArtem Bityutskiy }; 8891e51764aSArtem Bityutskiy 8901e51764aSArtem Bityutskiy /** 8911e51764aSArtem Bityutskiy * struct ubifs_orphan - stores the inode number of an orphan. 8921e51764aSArtem Bityutskiy * @rb: rb-tree node of rb-tree of orphans sorted by inode number 8931e51764aSArtem Bityutskiy * @list: list head of list of orphans in order added 8941e51764aSArtem Bityutskiy * @new_list: list head of list of orphans added since the last commit 8951e51764aSArtem Bityutskiy * @cnext: next orphan to commit 8961e51764aSArtem Bityutskiy * @dnext: next orphan to delete 8971e51764aSArtem Bityutskiy * @inum: inode number 8981e51764aSArtem Bityutskiy * @new: %1 => added since the last commit, otherwise %0 8992928f0d0SAdam Thomas * @cmt: %1 => commit pending, otherwise %0 9008afd500cSAdam Thomas * @del: %1 => delete pending, otherwise %0 9011e51764aSArtem Bityutskiy */ 9021e51764aSArtem Bityutskiy struct ubifs_orphan { 9031e51764aSArtem Bityutskiy struct rb_node rb; 9041e51764aSArtem Bityutskiy struct list_head list; 9051e51764aSArtem Bityutskiy struct list_head new_list; 9061e51764aSArtem Bityutskiy struct ubifs_orphan *cnext; 9071e51764aSArtem Bityutskiy struct ubifs_orphan *dnext; 9081e51764aSArtem Bityutskiy ino_t inum; 9092928f0d0SAdam Thomas unsigned new:1; 9102928f0d0SAdam Thomas unsigned cmt:1; 9118afd500cSAdam Thomas unsigned del:1; 9121e51764aSArtem Bityutskiy }; 9131e51764aSArtem Bityutskiy 9141e51764aSArtem Bityutskiy /** 9151e51764aSArtem Bityutskiy * struct ubifs_mount_opts - UBIFS-specific mount options information. 9161e51764aSArtem Bityutskiy * @unmount_mode: selected unmount mode (%0 default, %1 normal, %2 fast) 917d3f9db00SYannick Guerrini * @bulk_read: enable/disable bulk-reads (%0 default, %1 disable, %2 enable) 918553dea4dSArtem Bityutskiy * @chk_data_crc: enable/disable CRC data checking when reading data nodes 919d3f9db00SYannick Guerrini * (%0 default, %1 disable, %2 enable) 920553dea4dSArtem Bityutskiy * @override_compr: override default compressor (%0 - do not override and use 921553dea4dSArtem Bityutskiy * superblock compressor, %1 - override and use compressor 922553dea4dSArtem Bityutskiy * specified in @compr_type) 923553dea4dSArtem Bityutskiy * @compr_type: compressor type to override the superblock compressor with 924553dea4dSArtem Bityutskiy * (%UBIFS_COMPR_NONE, etc) 9251e51764aSArtem Bityutskiy */ 9261e51764aSArtem Bityutskiy struct ubifs_mount_opts { 9271e51764aSArtem Bityutskiy unsigned int unmount_mode:2; 9284793e7c5SAdrian Hunter unsigned int bulk_read:2; 9292953e73fSAdrian Hunter unsigned int chk_data_crc:2; 930553dea4dSArtem Bityutskiy unsigned int override_compr:1; 931553dea4dSArtem Bityutskiy unsigned int compr_type:2; 9321e51764aSArtem Bityutskiy }; 9331e51764aSArtem Bityutskiy 934b137545cSArtem Bityutskiy /** 935b137545cSArtem Bityutskiy * struct ubifs_budg_info - UBIFS budgeting information. 936b137545cSArtem Bityutskiy * @idx_growth: amount of bytes budgeted for index growth 937b137545cSArtem Bityutskiy * @data_growth: amount of bytes budgeted for cached data 938b137545cSArtem Bityutskiy * @dd_growth: amount of bytes budgeted for cached data that will make 939b137545cSArtem Bityutskiy * other data dirty 940b137545cSArtem Bityutskiy * @uncommitted_idx: amount of bytes were budgeted for growth of the index, but 941b137545cSArtem Bityutskiy * which still have to be taken into account because the index 942b137545cSArtem Bityutskiy * has not been committed so far 943b137545cSArtem Bityutskiy * @old_idx_sz: size of index on flash 944b137545cSArtem Bityutskiy * @min_idx_lebs: minimum number of LEBs required for the index 945b137545cSArtem Bityutskiy * @nospace: non-zero if the file-system does not have flash space (used as 946b137545cSArtem Bityutskiy * optimization) 947b137545cSArtem Bityutskiy * @nospace_rp: the same as @nospace, but additionally means that even reserved 948b137545cSArtem Bityutskiy * pool is full 949d3f9db00SYannick Guerrini * @page_budget: budget for a page (constant, never changed after mount) 950d3f9db00SYannick Guerrini * @inode_budget: budget for an inode (constant, never changed after mount) 951d3f9db00SYannick Guerrini * @dent_budget: budget for a directory entry (constant, never changed after 952b137545cSArtem Bityutskiy * mount) 953b137545cSArtem Bityutskiy */ 954b137545cSArtem Bityutskiy struct ubifs_budg_info { 955b137545cSArtem Bityutskiy long long idx_growth; 956b137545cSArtem Bityutskiy long long data_growth; 957b137545cSArtem Bityutskiy long long dd_growth; 958b137545cSArtem Bityutskiy long long uncommitted_idx; 959b137545cSArtem Bityutskiy unsigned long long old_idx_sz; 960b137545cSArtem Bityutskiy int min_idx_lebs; 961b137545cSArtem Bityutskiy unsigned int nospace:1; 962b137545cSArtem Bityutskiy unsigned int nospace_rp:1; 963b137545cSArtem Bityutskiy int page_budget; 964b137545cSArtem Bityutskiy int inode_budget; 965b137545cSArtem Bityutskiy int dent_budget; 966b137545cSArtem Bityutskiy }; 967b137545cSArtem Bityutskiy 96817c2f9f8SArtem Bityutskiy struct ubifs_debug_info; 96917c2f9f8SArtem Bityutskiy 9701e51764aSArtem Bityutskiy /** 9711e51764aSArtem Bityutskiy * struct ubifs_info - UBIFS file-system description data structure 9721e51764aSArtem Bityutskiy * (per-superblock). 9731e51764aSArtem Bityutskiy * @vfs_sb: VFS @struct super_block object 9741e51764aSArtem Bityutskiy * 9751e51764aSArtem Bityutskiy * @highest_inum: highest used inode number 9761e51764aSArtem Bityutskiy * @max_sqnum: current global sequence number 977014eb04bSArtem Bityutskiy * @cmt_no: commit number of the last successfully completed commit, protected 978014eb04bSArtem Bityutskiy * by @commit_sem 97981ffa38eSAdrian Hunter * @cnt_lock: protects @highest_inum and @max_sqnum counters 9801e51764aSArtem Bityutskiy * @fmt_version: UBIFS on-flash format version 981963f0cf6SArtem Bityutskiy * @ro_compat_version: R/O compatibility version 9821e51764aSArtem Bityutskiy * @uuid: UUID from super block 9831e51764aSArtem Bityutskiy * 9841e51764aSArtem Bityutskiy * @lhead_lnum: log head logical eraseblock number 9851e51764aSArtem Bityutskiy * @lhead_offs: log head offset 9861e51764aSArtem Bityutskiy * @ltail_lnum: log tail logical eraseblock number (offset is always 0) 9871e51764aSArtem Bityutskiy * @log_mutex: protects the log, @lhead_lnum, @lhead_offs, @ltail_lnum, and 9881e51764aSArtem Bityutskiy * @bud_bytes 9891e51764aSArtem Bityutskiy * @min_log_bytes: minimum required number of bytes in the log 9901e51764aSArtem Bityutskiy * @cmt_bud_bytes: used during commit to temporarily amount of bytes in 9911e51764aSArtem Bityutskiy * committed buds 9921e51764aSArtem Bityutskiy * 9931e51764aSArtem Bityutskiy * @buds: tree of all buds indexed by bud LEB number 9941e51764aSArtem Bityutskiy * @bud_bytes: how many bytes of flash is used by buds 9951e51764aSArtem Bityutskiy * @buds_lock: protects the @buds tree, @bud_bytes, and per-journal head bud 9961e51764aSArtem Bityutskiy * lists 9971e51764aSArtem Bityutskiy * @jhead_cnt: count of journal heads 9981e51764aSArtem Bityutskiy * @jheads: journal heads (head zero is base head) 9991e51764aSArtem Bityutskiy * @max_bud_bytes: maximum number of bytes allowed in buds 10001e51764aSArtem Bityutskiy * @bg_bud_bytes: number of bud bytes when background commit is initiated 10011e51764aSArtem Bityutskiy * @old_buds: buds to be released after commit ends 10021e51764aSArtem Bityutskiy * @max_bud_cnt: maximum number of buds 10031e51764aSArtem Bityutskiy * 10041e51764aSArtem Bityutskiy * @commit_sem: synchronizes committer with other processes 10051e51764aSArtem Bityutskiy * @cmt_state: commit state 10061e51764aSArtem Bityutskiy * @cs_lock: commit state lock 10071e51764aSArtem Bityutskiy * @cmt_wq: wait queue to sleep on if the log is full and a commit is running 1008625bf371SArtem Bityutskiy * 10091e51764aSArtem Bityutskiy * @big_lpt: flag that LPT is too big to write whole during commit 10109f58d350SMatthew L. Creech * @space_fixup: flag indicating that free space in LEBs needs to be cleaned up 1011d63d61c1SRichard Weinberger * @double_hash: flag indicating that we can do lookups by hash 1012e021986eSRichard Weinberger * @encrypted: flag indicating that this file system contains encrypted files 1013625bf371SArtem Bityutskiy * @no_chk_data_crc: do not check CRCs when reading data nodes (except during 1014625bf371SArtem Bityutskiy * recovery) 1015625bf371SArtem Bityutskiy * @bulk_read: enable bulk-reads 1016a1dc080cSArtem Bityutskiy * @default_compr: default compression algorithm (%UBIFS_COMPR_LZO, etc) 1017963f0cf6SArtem Bityutskiy * @rw_incompat: the media is not R/W compatible 10181e51764aSArtem Bityutskiy * 10191e51764aSArtem Bityutskiy * @tnc_mutex: protects the Tree Node Cache (TNC), @zroot, @cnext, @enext, and 10201e51764aSArtem Bityutskiy * @calc_idx_sz 10211e51764aSArtem Bityutskiy * @zroot: zbranch which points to the root index node and znode 10221e51764aSArtem Bityutskiy * @cnext: next znode to commit 10231e51764aSArtem Bityutskiy * @enext: next znode to commit to empty space 10241e51764aSArtem Bityutskiy * @gap_lebs: array of LEBs used by the in-gaps commit method 10251e51764aSArtem Bityutskiy * @cbuf: commit buffer 10261e51764aSArtem Bityutskiy * @ileb_buf: buffer for commit in-the-gaps method 10271e51764aSArtem Bityutskiy * @ileb_len: length of data in ileb_buf 10281e51764aSArtem Bityutskiy * @ihead_lnum: LEB number of index head 10291e51764aSArtem Bityutskiy * @ihead_offs: offset of index head 10301e51764aSArtem Bityutskiy * @ilebs: pre-allocated index LEBs 10311e51764aSArtem Bityutskiy * @ileb_cnt: number of pre-allocated index LEBs 10321e51764aSArtem Bityutskiy * @ileb_nxt: next pre-allocated index LEBs 10331e51764aSArtem Bityutskiy * @old_idx: tree of index nodes obsoleted since the last commit start 10341e51764aSArtem Bityutskiy * @bottom_up_buf: a buffer which is used by 'dirty_cow_bottom_up()' in tnc.c 10351e51764aSArtem Bityutskiy * 10361e51764aSArtem Bityutskiy * @mst_node: master node 10371e51764aSArtem Bityutskiy * @mst_offs: offset of valid master node 10383477d204SArtem Bityutskiy * 10396c0c42cdSArtem Bityutskiy * @max_bu_buf_len: maximum bulk-read buffer length 10403477d204SArtem Bityutskiy * @bu_mutex: protects the pre-allocated bulk-read buffer and @c->bu 10413477d204SArtem Bityutskiy * @bu: pre-allocated bulk-read information 10421e51764aSArtem Bityutskiy * 1043d882962fSMatthew L. Creech * @write_reserve_mutex: protects @write_reserve_buf 1044d882962fSMatthew L. Creech * @write_reserve_buf: on the write path we allocate memory, which might 1045d882962fSMatthew L. Creech * sometimes be unavailable, in which case we use this 1046d882962fSMatthew L. Creech * write reserve buffer 1047d882962fSMatthew L. Creech * 10481e51764aSArtem Bityutskiy * @log_lebs: number of logical eraseblocks in the log 10491e51764aSArtem Bityutskiy * @log_bytes: log size in bytes 10501e51764aSArtem Bityutskiy * @log_last: last LEB of the log 10511e51764aSArtem Bityutskiy * @lpt_lebs: number of LEBs used for lprops table 10521e51764aSArtem Bityutskiy * @lpt_first: first LEB of the lprops table area 10531e51764aSArtem Bityutskiy * @lpt_last: last LEB of the lprops table area 10541e51764aSArtem Bityutskiy * @orph_lebs: number of LEBs used for the orphan area 10551e51764aSArtem Bityutskiy * @orph_first: first LEB of the orphan area 10561e51764aSArtem Bityutskiy * @orph_last: last LEB of the orphan area 10571e51764aSArtem Bityutskiy * @main_lebs: count of LEBs in the main area 10581e51764aSArtem Bityutskiy * @main_first: first LEB of the main area 10591e51764aSArtem Bityutskiy * @main_bytes: main area size in bytes 10601e51764aSArtem Bityutskiy * 10611e51764aSArtem Bityutskiy * @key_hash_type: type of the key hash 10621e51764aSArtem Bityutskiy * @key_hash: direntry key hash function 10631e51764aSArtem Bityutskiy * @key_fmt: key format 10641e51764aSArtem Bityutskiy * @key_len: key length 10651e51764aSArtem Bityutskiy * @fanout: fanout of the index tree (number of links per indexing node) 10661e51764aSArtem Bityutskiy * 10671e51764aSArtem Bityutskiy * @min_io_size: minimal input/output unit size 10681e51764aSArtem Bityutskiy * @min_io_shift: number of bits in @min_io_size minus one 10693e8e2e0cSArtem Bityutskiy * @max_write_size: maximum amount of bytes the underlying flash can write at a 10703e8e2e0cSArtem Bityutskiy * time (MTD write buffer size) 10713e8e2e0cSArtem Bityutskiy * @max_write_shift: number of bits in @max_write_size minus one 10721e51764aSArtem Bityutskiy * @leb_size: logical eraseblock size in bytes 1073ca2ec61dSArtem Bityutskiy * @leb_start: starting offset of logical eraseblocks within physical 1074ca2ec61dSArtem Bityutskiy * eraseblocks 10751e51764aSArtem Bityutskiy * @half_leb_size: half LEB size 1076fb1cd01aSArtem Bityutskiy * @idx_leb_size: how many bytes of an LEB are effectively available when it is 1077fb1cd01aSArtem Bityutskiy * used to store indexing nodes (@leb_size - @max_idx_node_sz) 10781e51764aSArtem Bityutskiy * @leb_cnt: count of logical eraseblocks 10791e51764aSArtem Bityutskiy * @max_leb_cnt: maximum count of logical eraseblocks 10801e51764aSArtem Bityutskiy * @old_leb_cnt: count of logical eraseblocks before re-size 10811e51764aSArtem Bityutskiy * @ro_media: the underlying UBI volume is read-only 10822ef13294SArtem Bityutskiy * @ro_mount: the file-system was mounted as read-only 10832680d722SArtem Bityutskiy * @ro_error: UBIFS switched to R/O mode because an error happened 10841e51764aSArtem Bityutskiy * 10851e51764aSArtem Bityutskiy * @dirty_pg_cnt: number of dirty pages (not used) 10861e51764aSArtem Bityutskiy * @dirty_zn_cnt: number of dirty znodes 10871e51764aSArtem Bityutskiy * @clean_zn_cnt: number of clean znodes 10881e51764aSArtem Bityutskiy * 1089b137545cSArtem Bityutskiy * @space_lock: protects @bi and @lst 1090b137545cSArtem Bityutskiy * @lst: lprops statistics 1091b137545cSArtem Bityutskiy * @bi: budgeting information 10921e51764aSArtem Bityutskiy * @calc_idx_sz: temporary variable which is used to calculate new index size 10931e51764aSArtem Bityutskiy * (contains accurate new index size at end of TNC commit start) 10941e51764aSArtem Bityutskiy * 10951e51764aSArtem Bityutskiy * @ref_node_alsz: size of the LEB reference node aligned to the min. flash 10961e51764aSArtem Bityutskiy * I/O unit 10971e51764aSArtem Bityutskiy * @mst_node_alsz: master node aligned size 10981e51764aSArtem Bityutskiy * @min_idx_node_sz: minimum indexing node aligned on 8-bytes boundary 10991e51764aSArtem Bityutskiy * @max_idx_node_sz: maximum indexing node aligned on 8-bytes boundary 11001e51764aSArtem Bityutskiy * @max_inode_sz: maximum possible inode size in bytes 11011e51764aSArtem Bityutskiy * @max_znode_sz: size of znode in bytes 11029bbb5726SArtem Bityutskiy * 11039bbb5726SArtem Bityutskiy * @leb_overhead: how many bytes are wasted in an LEB when it is filled with 11049bbb5726SArtem Bityutskiy * data nodes of maximum size - used in free space reporting 11051e51764aSArtem Bityutskiy * @dead_wm: LEB dead space watermark 11061e51764aSArtem Bityutskiy * @dark_wm: LEB dark space watermark 11071e51764aSArtem Bityutskiy * @block_cnt: count of 4KiB blocks on the FS 11081e51764aSArtem Bityutskiy * 11091e51764aSArtem Bityutskiy * @ranges: UBIFS node length ranges 11101e51764aSArtem Bityutskiy * @ubi: UBI volume descriptor 11111e51764aSArtem Bityutskiy * @di: UBI device information 11121e51764aSArtem Bityutskiy * @vi: UBI volume information 11131e51764aSArtem Bityutskiy * 11141e51764aSArtem Bityutskiy * @orph_tree: rb-tree of orphan inode numbers 11151e51764aSArtem Bityutskiy * @orph_list: list of orphan inode numbers in order added 11161e51764aSArtem Bityutskiy * @orph_new: list of orphan inode numbers added since last commit 11171e51764aSArtem Bityutskiy * @orph_cnext: next orphan to commit 11181e51764aSArtem Bityutskiy * @orph_dnext: next orphan to delete 11191e51764aSArtem Bityutskiy * @orphan_lock: lock for orph_tree and orph_new 11201e51764aSArtem Bityutskiy * @orph_buf: buffer for orphan nodes 11211e51764aSArtem Bityutskiy * @new_orphans: number of orphans since last commit 11221e51764aSArtem Bityutskiy * @cmt_orphans: number of orphans being committed 11231e51764aSArtem Bityutskiy * @tot_orphans: number of orphans in the rb_tree 11241e51764aSArtem Bityutskiy * @max_orphans: maximum number of orphans allowed 11251e51764aSArtem Bityutskiy * @ohead_lnum: orphan head LEB number 11261e51764aSArtem Bityutskiy * @ohead_offs: orphan head offset 11271e51764aSArtem Bityutskiy * @no_orphs: non-zero if there are no orphans 11281e51764aSArtem Bityutskiy * 11291e51764aSArtem Bityutskiy * @bgt: UBIFS background thread 11301e51764aSArtem Bityutskiy * @bgt_name: background thread name 11311e51764aSArtem Bityutskiy * @need_bgt: if background thread should run 11321e51764aSArtem Bityutskiy * @need_wbuf_sync: if write-buffers have to be synchronized 11331e51764aSArtem Bityutskiy * 11341e51764aSArtem Bityutskiy * @gc_lnum: LEB number used for garbage collection 11351e51764aSArtem Bityutskiy * @sbuf: a buffer of LEB size used by GC and replay for scanning 11361e51764aSArtem Bityutskiy * @idx_gc: list of index LEBs that have been garbage collected 11371e51764aSArtem Bityutskiy * @idx_gc_cnt: number of elements on the idx_gc list 1138601c0bc4SAdrian Hunter * @gc_seq: incremented for every non-index LEB garbage collected 1139601c0bc4SAdrian Hunter * @gced_lnum: last non-index LEB that was garbage collected 11401e51764aSArtem Bityutskiy * 11411e51764aSArtem Bityutskiy * @infos_list: links all 'ubifs_info' objects 11421e51764aSArtem Bityutskiy * @umount_mutex: serializes shrinker and un-mount 11431e51764aSArtem Bityutskiy * @shrinker_run_no: shrinker run number 11441e51764aSArtem Bityutskiy * 11451e51764aSArtem Bityutskiy * @space_bits: number of bits needed to record free or dirty space 11461e51764aSArtem Bityutskiy * @lpt_lnum_bits: number of bits needed to record a LEB number in the LPT 11471e51764aSArtem Bityutskiy * @lpt_offs_bits: number of bits needed to record an offset in the LPT 11481e51764aSArtem Bityutskiy * @lpt_spc_bits: number of bits needed to space in the LPT 11491e51764aSArtem Bityutskiy * @pcnt_bits: number of bits needed to record pnode or nnode number 11501e51764aSArtem Bityutskiy * @lnum_bits: number of bits needed to record LEB number 11511e51764aSArtem Bityutskiy * @nnode_sz: size of on-flash nnode 11521e51764aSArtem Bityutskiy * @pnode_sz: size of on-flash pnode 11531e51764aSArtem Bityutskiy * @ltab_sz: size of on-flash LPT lprops table 11541e51764aSArtem Bityutskiy * @lsave_sz: size of on-flash LPT save table 11551e51764aSArtem Bityutskiy * @pnode_cnt: number of pnodes 11561e51764aSArtem Bityutskiy * @nnode_cnt: number of nnodes 11571e51764aSArtem Bityutskiy * @lpt_hght: height of the LPT 11581e51764aSArtem Bityutskiy * @pnodes_have: number of pnodes in memory 11591e51764aSArtem Bityutskiy * 11601e51764aSArtem Bityutskiy * @lp_mutex: protects lprops table and all the other lprops-related fields 11611e51764aSArtem Bityutskiy * @lpt_lnum: LEB number of the root nnode of the LPT 11621e51764aSArtem Bityutskiy * @lpt_offs: offset of the root nnode of the LPT 11631e51764aSArtem Bityutskiy * @nhead_lnum: LEB number of LPT head 11641e51764aSArtem Bityutskiy * @nhead_offs: offset of LPT head 11651e51764aSArtem Bityutskiy * @lpt_drty_flgs: dirty flags for LPT special nodes e.g. ltab 11661e51764aSArtem Bityutskiy * @dirty_nn_cnt: number of dirty nnodes 11671e51764aSArtem Bityutskiy * @dirty_pn_cnt: number of dirty pnodes 116873944a6dSAdrian Hunter * @check_lpt_free: flag that indicates LPT GC may be needed 11691e51764aSArtem Bityutskiy * @lpt_sz: LPT size 11701e51764aSArtem Bityutskiy * @lpt_nod_buf: buffer for an on-flash nnode or pnode 11711e51764aSArtem Bityutskiy * @lpt_buf: buffer of LEB size used by LPT 11721e51764aSArtem Bityutskiy * @nroot: address in memory of the root nnode of the LPT 11731e51764aSArtem Bityutskiy * @lpt_cnext: next LPT node to commit 11741e51764aSArtem Bityutskiy * @lpt_heap: array of heaps of categorized lprops 11751e51764aSArtem Bityutskiy * @dirty_idx: a (reverse sorted) copy of the LPROPS_DIRTY_IDX heap as at 11761e51764aSArtem Bityutskiy * previous commit start 11771e51764aSArtem Bityutskiy * @uncat_list: list of un-categorized LEBs 11781e51764aSArtem Bityutskiy * @empty_list: list of empty LEBs 1179fb1cd01aSArtem Bityutskiy * @freeable_list: list of freeable non-index LEBs (free + dirty == @leb_size) 1180fb1cd01aSArtem Bityutskiy * @frdi_idx_list: list of freeable index LEBs (free + dirty == @leb_size) 11811e51764aSArtem Bityutskiy * @freeable_cnt: number of freeable LEBs in @freeable_list 118298a1eebdSArtem Bityutskiy * @in_a_category_cnt: count of lprops which are in a certain category, which 118398a1eebdSArtem Bityutskiy * basically meants that they were loaded from the flash 11841e51764aSArtem Bityutskiy * 11851e51764aSArtem Bityutskiy * @ltab_lnum: LEB number of LPT's own lprops table 11861e51764aSArtem Bityutskiy * @ltab_offs: offset of LPT's own lprops table 11871e51764aSArtem Bityutskiy * @ltab: LPT's own lprops table 11881e51764aSArtem Bityutskiy * @ltab_cmt: LPT's own lprops table (commit copy) 11891e51764aSArtem Bityutskiy * @lsave_cnt: number of LEB numbers in LPT's save table 11901e51764aSArtem Bityutskiy * @lsave_lnum: LEB number of LPT's save table 11911e51764aSArtem Bityutskiy * @lsave_offs: offset of LPT's save table 11921e51764aSArtem Bityutskiy * @lsave: LPT's save table 11931e51764aSArtem Bityutskiy * @lscan_lnum: LEB number of last LPT scan 11941e51764aSArtem Bityutskiy * 11951e51764aSArtem Bityutskiy * @rp_size: size of the reserved pool in bytes 11961e51764aSArtem Bityutskiy * @report_rp_size: size of the reserved pool reported to user-space 11971e51764aSArtem Bityutskiy * @rp_uid: reserved pool user ID 11981e51764aSArtem Bityutskiy * @rp_gid: reserved pool group ID 11991e51764aSArtem Bityutskiy * 1200d8cdda3eSArtem Bityutskiy * @empty: %1 if the UBI device is empty 1201d8cdda3eSArtem Bityutskiy * @need_recovery: %1 if the file-system needs recovery 1202d8cdda3eSArtem Bityutskiy * @replaying: %1 during journal replay 120318d1d7fbSArtem Bityutskiy * @mounting: %1 while mounting 12041751e8a6SLinus Torvalds * @probing: %1 while attempting to mount if SB_SILENT mount flag is set 1205d8cdda3eSArtem Bityutskiy * @remounting_rw: %1 while re-mounting from R/O mode to R/W mode 12061e51764aSArtem Bityutskiy * @replay_list: temporary list used during journal replay 12071e51764aSArtem Bityutskiy * @replay_buds: list of buds to replay 12081e51764aSArtem Bityutskiy * @cs_sqnum: sequence number of first node in the log (commit start node) 12092ef13294SArtem Bityutskiy * @unclean_leb_list: LEBs to recover when re-mounting R/O mounted FS to R/W 12102ef13294SArtem Bityutskiy * mode 12112ef13294SArtem Bityutskiy * @rcvrd_mst_node: recovered master node to write when re-mounting R/O mounted 12122ef13294SArtem Bityutskiy * FS to R/W mode 12131e51764aSArtem Bityutskiy * @size_tree: inode size information for recovery 12141e51764aSArtem Bityutskiy * @mount_opts: UBIFS-specific mount options 12151e51764aSArtem Bityutskiy * 121617c2f9f8SArtem Bityutskiy * @dbg: debugging-related information 12171e51764aSArtem Bityutskiy */ 12181e51764aSArtem Bityutskiy struct ubifs_info { 12191e51764aSArtem Bityutskiy struct super_block *vfs_sb; 12201e51764aSArtem Bityutskiy 12211e51764aSArtem Bityutskiy ino_t highest_inum; 12221e51764aSArtem Bityutskiy unsigned long long max_sqnum; 12231e51764aSArtem Bityutskiy unsigned long long cmt_no; 12241e51764aSArtem Bityutskiy spinlock_t cnt_lock; 12251e51764aSArtem Bityutskiy int fmt_version; 1226963f0cf6SArtem Bityutskiy int ro_compat_version; 12271e51764aSArtem Bityutskiy unsigned char uuid[16]; 12281e51764aSArtem Bityutskiy 12291e51764aSArtem Bityutskiy int lhead_lnum; 12301e51764aSArtem Bityutskiy int lhead_offs; 12311e51764aSArtem Bityutskiy int ltail_lnum; 12321e51764aSArtem Bityutskiy struct mutex log_mutex; 12331e51764aSArtem Bityutskiy int min_log_bytes; 12341e51764aSArtem Bityutskiy long long cmt_bud_bytes; 12351e51764aSArtem Bityutskiy 12361e51764aSArtem Bityutskiy struct rb_root buds; 12371e51764aSArtem Bityutskiy long long bud_bytes; 12381e51764aSArtem Bityutskiy spinlock_t buds_lock; 12391e51764aSArtem Bityutskiy int jhead_cnt; 12401e51764aSArtem Bityutskiy struct ubifs_jhead *jheads; 12411e51764aSArtem Bityutskiy long long max_bud_bytes; 12421e51764aSArtem Bityutskiy long long bg_bud_bytes; 12431e51764aSArtem Bityutskiy struct list_head old_buds; 12441e51764aSArtem Bityutskiy int max_bud_cnt; 12451e51764aSArtem Bityutskiy 12461e51764aSArtem Bityutskiy struct rw_semaphore commit_sem; 12471e51764aSArtem Bityutskiy int cmt_state; 12481e51764aSArtem Bityutskiy spinlock_t cs_lock; 12491e51764aSArtem Bityutskiy wait_queue_head_t cmt_wq; 1250625bf371SArtem Bityutskiy 12511e51764aSArtem Bityutskiy unsigned int big_lpt:1; 12529f58d350SMatthew L. Creech unsigned int space_fixup:1; 1253d63d61c1SRichard Weinberger unsigned int double_hash:1; 1254e021986eSRichard Weinberger unsigned int encrypted:1; 1255625bf371SArtem Bityutskiy unsigned int no_chk_data_crc:1; 1256625bf371SArtem Bityutskiy unsigned int bulk_read:1; 1257a1dc080cSArtem Bityutskiy unsigned int default_compr:2; 1258963f0cf6SArtem Bityutskiy unsigned int rw_incompat:1; 12591e51764aSArtem Bityutskiy 12601e51764aSArtem Bityutskiy struct mutex tnc_mutex; 12611e51764aSArtem Bityutskiy struct ubifs_zbranch zroot; 12621e51764aSArtem Bityutskiy struct ubifs_znode *cnext; 12631e51764aSArtem Bityutskiy struct ubifs_znode *enext; 12641e51764aSArtem Bityutskiy int *gap_lebs; 12651e51764aSArtem Bityutskiy void *cbuf; 12661e51764aSArtem Bityutskiy void *ileb_buf; 12671e51764aSArtem Bityutskiy int ileb_len; 12681e51764aSArtem Bityutskiy int ihead_lnum; 12691e51764aSArtem Bityutskiy int ihead_offs; 12701e51764aSArtem Bityutskiy int *ilebs; 12711e51764aSArtem Bityutskiy int ileb_cnt; 12721e51764aSArtem Bityutskiy int ileb_nxt; 12731e51764aSArtem Bityutskiy struct rb_root old_idx; 12741e51764aSArtem Bityutskiy int *bottom_up_buf; 12751e51764aSArtem Bityutskiy 12761e51764aSArtem Bityutskiy struct ubifs_mst_node *mst_node; 12771e51764aSArtem Bityutskiy int mst_offs; 12783477d204SArtem Bityutskiy 12796c0c42cdSArtem Bityutskiy int max_bu_buf_len; 12803477d204SArtem Bityutskiy struct mutex bu_mutex; 12813477d204SArtem Bityutskiy struct bu_info bu; 12821e51764aSArtem Bityutskiy 1283d882962fSMatthew L. Creech struct mutex write_reserve_mutex; 1284d882962fSMatthew L. Creech void *write_reserve_buf; 1285d882962fSMatthew L. Creech 12861e51764aSArtem Bityutskiy int log_lebs; 12871e51764aSArtem Bityutskiy long long log_bytes; 12881e51764aSArtem Bityutskiy int log_last; 12891e51764aSArtem Bityutskiy int lpt_lebs; 12901e51764aSArtem Bityutskiy int lpt_first; 12911e51764aSArtem Bityutskiy int lpt_last; 12921e51764aSArtem Bityutskiy int orph_lebs; 12931e51764aSArtem Bityutskiy int orph_first; 12941e51764aSArtem Bityutskiy int orph_last; 12951e51764aSArtem Bityutskiy int main_lebs; 12961e51764aSArtem Bityutskiy int main_first; 12971e51764aSArtem Bityutskiy long long main_bytes; 12981e51764aSArtem Bityutskiy 12991e51764aSArtem Bityutskiy uint8_t key_hash_type; 13001e51764aSArtem Bityutskiy uint32_t (*key_hash)(const char *str, int len); 13011e51764aSArtem Bityutskiy int key_fmt; 13021e51764aSArtem Bityutskiy int key_len; 13031e51764aSArtem Bityutskiy int fanout; 13041e51764aSArtem Bityutskiy 13051e51764aSArtem Bityutskiy int min_io_size; 13061e51764aSArtem Bityutskiy int min_io_shift; 13073e8e2e0cSArtem Bityutskiy int max_write_size; 13083e8e2e0cSArtem Bityutskiy int max_write_shift; 13091e51764aSArtem Bityutskiy int leb_size; 1310ca2ec61dSArtem Bityutskiy int leb_start; 13111e51764aSArtem Bityutskiy int half_leb_size; 1312fb1cd01aSArtem Bityutskiy int idx_leb_size; 13131e51764aSArtem Bityutskiy int leb_cnt; 13141e51764aSArtem Bityutskiy int max_leb_cnt; 13151e51764aSArtem Bityutskiy int old_leb_cnt; 13162680d722SArtem Bityutskiy unsigned int ro_media:1; 13172ef13294SArtem Bityutskiy unsigned int ro_mount:1; 13182680d722SArtem Bityutskiy unsigned int ro_error:1; 13191e51764aSArtem Bityutskiy 13201e51764aSArtem Bityutskiy atomic_long_t dirty_pg_cnt; 13211e51764aSArtem Bityutskiy atomic_long_t dirty_zn_cnt; 13221e51764aSArtem Bityutskiy atomic_long_t clean_zn_cnt; 13231e51764aSArtem Bityutskiy 13241e51764aSArtem Bityutskiy spinlock_t space_lock; 13251e51764aSArtem Bityutskiy struct ubifs_lp_stats lst; 1326b137545cSArtem Bityutskiy struct ubifs_budg_info bi; 1327b137545cSArtem Bityutskiy unsigned long long calc_idx_sz; 13281e51764aSArtem Bityutskiy 13291e51764aSArtem Bityutskiy int ref_node_alsz; 13301e51764aSArtem Bityutskiy int mst_node_alsz; 13311e51764aSArtem Bityutskiy int min_idx_node_sz; 13321e51764aSArtem Bityutskiy int max_idx_node_sz; 13331e51764aSArtem Bityutskiy long long max_inode_sz; 13341e51764aSArtem Bityutskiy int max_znode_sz; 13359bbb5726SArtem Bityutskiy 13369bbb5726SArtem Bityutskiy int leb_overhead; 13371e51764aSArtem Bityutskiy int dead_wm; 13381e51764aSArtem Bityutskiy int dark_wm; 13391e51764aSArtem Bityutskiy int block_cnt; 13401e51764aSArtem Bityutskiy 13411e51764aSArtem Bityutskiy struct ubifs_node_range ranges[UBIFS_NODE_TYPES_CNT]; 13421e51764aSArtem Bityutskiy struct ubi_volume_desc *ubi; 13431e51764aSArtem Bityutskiy struct ubi_device_info di; 13441e51764aSArtem Bityutskiy struct ubi_volume_info vi; 13451e51764aSArtem Bityutskiy 13461e51764aSArtem Bityutskiy struct rb_root orph_tree; 13471e51764aSArtem Bityutskiy struct list_head orph_list; 13481e51764aSArtem Bityutskiy struct list_head orph_new; 13491e51764aSArtem Bityutskiy struct ubifs_orphan *orph_cnext; 13501e51764aSArtem Bityutskiy struct ubifs_orphan *orph_dnext; 13511e51764aSArtem Bityutskiy spinlock_t orphan_lock; 13521e51764aSArtem Bityutskiy void *orph_buf; 13531e51764aSArtem Bityutskiy int new_orphans; 13541e51764aSArtem Bityutskiy int cmt_orphans; 13551e51764aSArtem Bityutskiy int tot_orphans; 13561e51764aSArtem Bityutskiy int max_orphans; 13571e51764aSArtem Bityutskiy int ohead_lnum; 13581e51764aSArtem Bityutskiy int ohead_offs; 13591e51764aSArtem Bityutskiy int no_orphs; 13601e51764aSArtem Bityutskiy 13611e51764aSArtem Bityutskiy struct task_struct *bgt; 13621e51764aSArtem Bityutskiy char bgt_name[sizeof(BGT_NAME_PATTERN) + 9]; 13631e51764aSArtem Bityutskiy int need_bgt; 13641e51764aSArtem Bityutskiy int need_wbuf_sync; 13651e51764aSArtem Bityutskiy 13661e51764aSArtem Bityutskiy int gc_lnum; 13671e51764aSArtem Bityutskiy void *sbuf; 13681e51764aSArtem Bityutskiy struct list_head idx_gc; 13691e51764aSArtem Bityutskiy int idx_gc_cnt; 1370f92b9826SArtem Bityutskiy int gc_seq; 1371f92b9826SArtem Bityutskiy int gced_lnum; 13721e51764aSArtem Bityutskiy 13731e51764aSArtem Bityutskiy struct list_head infos_list; 13741e51764aSArtem Bityutskiy struct mutex umount_mutex; 13751e51764aSArtem Bityutskiy unsigned int shrinker_run_no; 13761e51764aSArtem Bityutskiy 13771e51764aSArtem Bityutskiy int space_bits; 13781e51764aSArtem Bityutskiy int lpt_lnum_bits; 13791e51764aSArtem Bityutskiy int lpt_offs_bits; 13801e51764aSArtem Bityutskiy int lpt_spc_bits; 13811e51764aSArtem Bityutskiy int pcnt_bits; 13821e51764aSArtem Bityutskiy int lnum_bits; 13831e51764aSArtem Bityutskiy int nnode_sz; 13841e51764aSArtem Bityutskiy int pnode_sz; 13851e51764aSArtem Bityutskiy int ltab_sz; 13861e51764aSArtem Bityutskiy int lsave_sz; 13871e51764aSArtem Bityutskiy int pnode_cnt; 13881e51764aSArtem Bityutskiy int nnode_cnt; 13891e51764aSArtem Bityutskiy int lpt_hght; 13901e51764aSArtem Bityutskiy int pnodes_have; 13911e51764aSArtem Bityutskiy 13921e51764aSArtem Bityutskiy struct mutex lp_mutex; 13931e51764aSArtem Bityutskiy int lpt_lnum; 13941e51764aSArtem Bityutskiy int lpt_offs; 13951e51764aSArtem Bityutskiy int nhead_lnum; 13961e51764aSArtem Bityutskiy int nhead_offs; 13971e51764aSArtem Bityutskiy int lpt_drty_flgs; 13981e51764aSArtem Bityutskiy int dirty_nn_cnt; 13991e51764aSArtem Bityutskiy int dirty_pn_cnt; 140073944a6dSAdrian Hunter int check_lpt_free; 14011e51764aSArtem Bityutskiy long long lpt_sz; 14021e51764aSArtem Bityutskiy void *lpt_nod_buf; 14031e51764aSArtem Bityutskiy void *lpt_buf; 14041e51764aSArtem Bityutskiy struct ubifs_nnode *nroot; 14051e51764aSArtem Bityutskiy struct ubifs_cnode *lpt_cnext; 14061e51764aSArtem Bityutskiy struct ubifs_lpt_heap lpt_heap[LPROPS_HEAP_CNT]; 14071e51764aSArtem Bityutskiy struct ubifs_lpt_heap dirty_idx; 14081e51764aSArtem Bityutskiy struct list_head uncat_list; 14091e51764aSArtem Bityutskiy struct list_head empty_list; 14101e51764aSArtem Bityutskiy struct list_head freeable_list; 14111e51764aSArtem Bityutskiy struct list_head frdi_idx_list; 14121e51764aSArtem Bityutskiy int freeable_cnt; 141398a1eebdSArtem Bityutskiy int in_a_category_cnt; 14141e51764aSArtem Bityutskiy 14151e51764aSArtem Bityutskiy int ltab_lnum; 14161e51764aSArtem Bityutskiy int ltab_offs; 14171e51764aSArtem Bityutskiy struct ubifs_lpt_lprops *ltab; 14181e51764aSArtem Bityutskiy struct ubifs_lpt_lprops *ltab_cmt; 14191e51764aSArtem Bityutskiy int lsave_cnt; 14201e51764aSArtem Bityutskiy int lsave_lnum; 14211e51764aSArtem Bityutskiy int lsave_offs; 14221e51764aSArtem Bityutskiy int *lsave; 14231e51764aSArtem Bityutskiy int lscan_lnum; 14241e51764aSArtem Bityutskiy 14251e51764aSArtem Bityutskiy long long rp_size; 14261e51764aSArtem Bityutskiy long long report_rp_size; 142739241bebSEric W. Biederman kuid_t rp_uid; 142839241bebSEric W. Biederman kgid_t rp_gid; 14291e51764aSArtem Bityutskiy 14301e51764aSArtem Bityutskiy /* The below fields are used only during mounting and re-mounting */ 1431d8cdda3eSArtem Bityutskiy unsigned int empty:1; 1432d8cdda3eSArtem Bityutskiy unsigned int need_recovery:1; 1433d8cdda3eSArtem Bityutskiy unsigned int replaying:1; 143418d1d7fbSArtem Bityutskiy unsigned int mounting:1; 1435d8cdda3eSArtem Bityutskiy unsigned int remounting_rw:1; 143690bea5a3SDaniel Golle unsigned int probing:1; 14371e51764aSArtem Bityutskiy struct list_head replay_list; 14381e51764aSArtem Bityutskiy struct list_head replay_buds; 14391e51764aSArtem Bityutskiy unsigned long long cs_sqnum; 14401e51764aSArtem Bityutskiy struct list_head unclean_leb_list; 14411e51764aSArtem Bityutskiy struct ubifs_mst_node *rcvrd_mst_node; 14421e51764aSArtem Bityutskiy struct rb_root size_tree; 14431e51764aSArtem Bityutskiy struct ubifs_mount_opts mount_opts; 14441e51764aSArtem Bityutskiy 144517c2f9f8SArtem Bityutskiy struct ubifs_debug_info *dbg; 14461e51764aSArtem Bityutskiy }; 14471e51764aSArtem Bityutskiy 14481e51764aSArtem Bityutskiy extern struct list_head ubifs_infos; 14491e51764aSArtem Bityutskiy extern spinlock_t ubifs_infos_lock; 14501e51764aSArtem Bityutskiy extern atomic_long_t ubifs_clean_zn_cnt; 1451e8b81566SArtem Bityutskiy extern const struct super_operations ubifs_super_operations; 1452e8b81566SArtem Bityutskiy extern const struct address_space_operations ubifs_file_address_operations; 1453e8b81566SArtem Bityutskiy extern const struct file_operations ubifs_file_operations; 1454e8b81566SArtem Bityutskiy extern const struct inode_operations ubifs_file_inode_operations; 1455e8b81566SArtem Bityutskiy extern const struct file_operations ubifs_dir_operations; 1456e8b81566SArtem Bityutskiy extern const struct inode_operations ubifs_dir_inode_operations; 1457e8b81566SArtem Bityutskiy extern const struct inode_operations ubifs_symlink_inode_operations; 14581e51764aSArtem Bityutskiy extern struct ubifs_compressor *ubifs_compressors[UBIFS_COMPR_TYPES_CNT]; 14591e51764aSArtem Bityutskiy 14601e51764aSArtem Bityutskiy /* io.c */ 1461ff46d7b3SAdrian Hunter void ubifs_ro_mode(struct ubifs_info *c, int err); 146283cef708SArtem Bityutskiy int ubifs_leb_read(const struct ubifs_info *c, int lnum, void *buf, int offs, 146383cef708SArtem Bityutskiy int len, int even_ebadmsg); 146483cef708SArtem Bityutskiy int ubifs_leb_write(struct ubifs_info *c, int lnum, const void *buf, int offs, 1465b36a261eSRichard Weinberger int len); 1466b36a261eSRichard Weinberger int ubifs_leb_change(struct ubifs_info *c, int lnum, const void *buf, int len); 146783cef708SArtem Bityutskiy int ubifs_leb_unmap(struct ubifs_info *c, int lnum); 1468b36a261eSRichard Weinberger int ubifs_leb_map(struct ubifs_info *c, int lnum); 146983cef708SArtem Bityutskiy int ubifs_is_mapped(const struct ubifs_info *c, int lnum); 14701e51764aSArtem Bityutskiy int ubifs_wbuf_write_nolock(struct ubifs_wbuf *wbuf, void *buf, int len); 1471b36a261eSRichard Weinberger int ubifs_wbuf_seek_nolock(struct ubifs_wbuf *wbuf, int lnum, int offs); 14721e51764aSArtem Bityutskiy int ubifs_wbuf_init(struct ubifs_info *c, struct ubifs_wbuf *wbuf); 14731e51764aSArtem Bityutskiy int ubifs_read_node(const struct ubifs_info *c, void *buf, int type, int len, 14741e51764aSArtem Bityutskiy int lnum, int offs); 14751e51764aSArtem Bityutskiy int ubifs_read_node_wbuf(struct ubifs_wbuf *wbuf, void *buf, int type, int len, 14761e51764aSArtem Bityutskiy int lnum, int offs); 14771e51764aSArtem Bityutskiy int ubifs_write_node(struct ubifs_info *c, void *node, int len, int lnum, 1478b36a261eSRichard Weinberger int offs); 14791e51764aSArtem Bityutskiy int ubifs_check_node(const struct ubifs_info *c, const void *buf, int lnum, 14806f7ab6d4SArtem Bityutskiy int offs, int quiet, int must_chk_crc); 14811e51764aSArtem Bityutskiy void ubifs_prepare_node(struct ubifs_info *c, void *buf, int len, int pad); 14821e51764aSArtem Bityutskiy void ubifs_prep_grp_node(struct ubifs_info *c, void *node, int len, int last); 14831e51764aSArtem Bityutskiy int ubifs_io_init(struct ubifs_info *c); 14841e51764aSArtem Bityutskiy void ubifs_pad(const struct ubifs_info *c, void *buf, int pad); 14851e51764aSArtem Bityutskiy int ubifs_wbuf_sync_nolock(struct ubifs_wbuf *wbuf); 14861e51764aSArtem Bityutskiy int ubifs_bg_wbufs_sync(struct ubifs_info *c); 14871e51764aSArtem Bityutskiy void ubifs_wbuf_add_ino_nolock(struct ubifs_wbuf *wbuf, ino_t inum); 14881e51764aSArtem Bityutskiy int ubifs_sync_wbufs_by_inode(struct ubifs_info *c, struct inode *inode); 14891e51764aSArtem Bityutskiy 14901e51764aSArtem Bityutskiy /* scan.c */ 14911e51764aSArtem Bityutskiy struct ubifs_scan_leb *ubifs_scan(const struct ubifs_info *c, int lnum, 1492348709baSArtem Bityutskiy int offs, void *sbuf, int quiet); 14931e51764aSArtem Bityutskiy void ubifs_scan_destroy(struct ubifs_scan_leb *sleb); 14941e51764aSArtem Bityutskiy int ubifs_scan_a_node(const struct ubifs_info *c, void *buf, int len, int lnum, 14951e51764aSArtem Bityutskiy int offs, int quiet); 14961e51764aSArtem Bityutskiy struct ubifs_scan_leb *ubifs_start_scan(const struct ubifs_info *c, int lnum, 14971e51764aSArtem Bityutskiy int offs, void *sbuf); 14981e51764aSArtem Bityutskiy void ubifs_end_scan(const struct ubifs_info *c, struct ubifs_scan_leb *sleb, 14991e51764aSArtem Bityutskiy int lnum, int offs); 15001e51764aSArtem Bityutskiy int ubifs_add_snod(const struct ubifs_info *c, struct ubifs_scan_leb *sleb, 15011e51764aSArtem Bityutskiy void *buf, int offs); 15021e51764aSArtem Bityutskiy void ubifs_scanned_corruption(const struct ubifs_info *c, int lnum, int offs, 15031e51764aSArtem Bityutskiy void *buf); 15041e51764aSArtem Bityutskiy 15051e51764aSArtem Bityutskiy /* log.c */ 15061e51764aSArtem Bityutskiy void ubifs_add_bud(struct ubifs_info *c, struct ubifs_bud *bud); 15071e51764aSArtem Bityutskiy void ubifs_create_buds_lists(struct ubifs_info *c); 15081e51764aSArtem Bityutskiy int ubifs_add_bud_to_log(struct ubifs_info *c, int jhead, int lnum, int offs); 15091e51764aSArtem Bityutskiy struct ubifs_bud *ubifs_search_bud(struct ubifs_info *c, int lnum); 15101e51764aSArtem Bityutskiy struct ubifs_wbuf *ubifs_get_wbuf(struct ubifs_info *c, int lnum); 15111e51764aSArtem Bityutskiy int ubifs_log_start_commit(struct ubifs_info *c, int *ltail_lnum); 15121e51764aSArtem Bityutskiy int ubifs_log_end_commit(struct ubifs_info *c, int new_ltail_lnum); 15131e51764aSArtem Bityutskiy int ubifs_log_post_commit(struct ubifs_info *c, int old_ltail_lnum); 15141e51764aSArtem Bityutskiy int ubifs_consolidate_log(struct ubifs_info *c); 15151e51764aSArtem Bityutskiy 15161e51764aSArtem Bityutskiy /* journal.c */ 15171e51764aSArtem Bityutskiy int ubifs_jnl_update(struct ubifs_info *c, const struct inode *dir, 1518f4f61d2cSRichard Weinberger const struct fscrypt_name *nm, const struct inode *inode, 15191e51764aSArtem Bityutskiy int deletion, int xent); 15201e51764aSArtem Bityutskiy int ubifs_jnl_write_data(struct ubifs_info *c, const struct inode *inode, 15211e51764aSArtem Bityutskiy const union ubifs_key *key, const void *buf, int len); 15221f28681aSArtem Bityutskiy int ubifs_jnl_write_inode(struct ubifs_info *c, const struct inode *inode); 1523de94eb55SArtem Bityutskiy int ubifs_jnl_delete_inode(struct ubifs_info *c, const struct inode *inode); 15249ec64962SRichard Weinberger int ubifs_jnl_xrename(struct ubifs_info *c, const struct inode *fst_dir, 1525f4f61d2cSRichard Weinberger const struct inode *fst_inode, 1526f4f61d2cSRichard Weinberger const struct fscrypt_name *fst_nm, 15279ec64962SRichard Weinberger const struct inode *snd_dir, 1528f4f61d2cSRichard Weinberger const struct inode *snd_inode, 1529f4f61d2cSRichard Weinberger const struct fscrypt_name *snd_nm, int sync); 15301e51764aSArtem Bityutskiy int ubifs_jnl_rename(struct ubifs_info *c, const struct inode *old_dir, 1531f4f61d2cSRichard Weinberger const struct inode *old_inode, 1532f4f61d2cSRichard Weinberger const struct fscrypt_name *old_nm, 15331e51764aSArtem Bityutskiy const struct inode *new_dir, 1534f4f61d2cSRichard Weinberger const struct inode *new_inode, 1535f4f61d2cSRichard Weinberger const struct fscrypt_name *new_nm, 15369e0a1fffSRichard Weinberger const struct inode *whiteout, int sync); 15371e51764aSArtem Bityutskiy int ubifs_jnl_truncate(struct ubifs_info *c, const struct inode *inode, 15381e51764aSArtem Bityutskiy loff_t old_size, loff_t new_size); 15391e51764aSArtem Bityutskiy int ubifs_jnl_delete_xattr(struct ubifs_info *c, const struct inode *host, 1540f4f61d2cSRichard Weinberger const struct inode *inode, const struct fscrypt_name *nm); 15411e51764aSArtem Bityutskiy int ubifs_jnl_change_xattr(struct ubifs_info *c, const struct inode *inode1, 15421e51764aSArtem Bityutskiy const struct inode *inode2); 15431e51764aSArtem Bityutskiy 15441e51764aSArtem Bityutskiy /* budget.c */ 15451e51764aSArtem Bityutskiy int ubifs_budget_space(struct ubifs_info *c, struct ubifs_budget_req *req); 15461e51764aSArtem Bityutskiy void ubifs_release_budget(struct ubifs_info *c, struct ubifs_budget_req *req); 15471e51764aSArtem Bityutskiy void ubifs_release_dirty_inode_budget(struct ubifs_info *c, 15481e51764aSArtem Bityutskiy struct ubifs_inode *ui); 15491e51764aSArtem Bityutskiy int ubifs_budget_inode_op(struct ubifs_info *c, struct inode *inode, 15501e51764aSArtem Bityutskiy struct ubifs_budget_req *req); 15511e51764aSArtem Bityutskiy void ubifs_release_ino_dirty(struct ubifs_info *c, struct inode *inode, 15521e51764aSArtem Bityutskiy struct ubifs_budget_req *req); 15531e51764aSArtem Bityutskiy void ubifs_cancel_ino_op(struct ubifs_info *c, struct inode *inode, 15541e51764aSArtem Bityutskiy struct ubifs_budget_req *req); 15557dad181bSArtem Bityutskiy long long ubifs_get_free_space(struct ubifs_info *c); 155684abf972SArtem Bityutskiy long long ubifs_get_free_space_nolock(struct ubifs_info *c); 15571e51764aSArtem Bityutskiy int ubifs_calc_min_idx_lebs(struct ubifs_info *c); 15581e51764aSArtem Bityutskiy void ubifs_convert_page_budget(struct ubifs_info *c); 15594d61db4fSArtem Bityutskiy long long ubifs_reported_space(const struct ubifs_info *c, long long free); 15601e51764aSArtem Bityutskiy long long ubifs_calc_available(const struct ubifs_info *c, int min_idx_lebs); 15611e51764aSArtem Bityutskiy 15621e51764aSArtem Bityutskiy /* find.c */ 15633edaae7cSArtem Bityutskiy int ubifs_find_free_space(struct ubifs_info *c, int min_space, int *offs, 15641e51764aSArtem Bityutskiy int squeeze); 15651e51764aSArtem Bityutskiy int ubifs_find_free_leb_for_idx(struct ubifs_info *c); 15661e51764aSArtem Bityutskiy int ubifs_find_dirty_leb(struct ubifs_info *c, struct ubifs_lprops *ret_lp, 15671e51764aSArtem Bityutskiy int min_space, int pick_free); 15681e51764aSArtem Bityutskiy int ubifs_find_dirty_idx_leb(struct ubifs_info *c); 15691e51764aSArtem Bityutskiy int ubifs_save_dirty_idx_lnums(struct ubifs_info *c); 15701e51764aSArtem Bityutskiy 15711e51764aSArtem Bityutskiy /* tnc.c */ 15721e51764aSArtem Bityutskiy int ubifs_lookup_level0(struct ubifs_info *c, const union ubifs_key *key, 15731e51764aSArtem Bityutskiy struct ubifs_znode **zn, int *n); 15741e51764aSArtem Bityutskiy int ubifs_tnc_lookup_nm(struct ubifs_info *c, const union ubifs_key *key, 1575f4f61d2cSRichard Weinberger void *node, const struct fscrypt_name *nm); 1576528e3d17SRichard Weinberger int ubifs_tnc_lookup_dh(struct ubifs_info *c, const union ubifs_key *key, 1577528e3d17SRichard Weinberger void *node, uint32_t secondary_hash); 15781e51764aSArtem Bityutskiy int ubifs_tnc_locate(struct ubifs_info *c, const union ubifs_key *key, 15791e51764aSArtem Bityutskiy void *node, int *lnum, int *offs); 15801e51764aSArtem Bityutskiy int ubifs_tnc_add(struct ubifs_info *c, const union ubifs_key *key, int lnum, 15811e51764aSArtem Bityutskiy int offs, int len); 15821e51764aSArtem Bityutskiy int ubifs_tnc_replace(struct ubifs_info *c, const union ubifs_key *key, 15831e51764aSArtem Bityutskiy int old_lnum, int old_offs, int lnum, int offs, int len); 15841e51764aSArtem Bityutskiy int ubifs_tnc_add_nm(struct ubifs_info *c, const union ubifs_key *key, 1585f4f61d2cSRichard Weinberger int lnum, int offs, int len, const struct fscrypt_name *nm); 15861e51764aSArtem Bityutskiy int ubifs_tnc_remove(struct ubifs_info *c, const union ubifs_key *key); 15871e51764aSArtem Bityutskiy int ubifs_tnc_remove_nm(struct ubifs_info *c, const union ubifs_key *key, 1588f4f61d2cSRichard Weinberger const struct fscrypt_name *nm); 1589781f675eSRichard Weinberger int ubifs_tnc_remove_dh(struct ubifs_info *c, const union ubifs_key *key, 1590781f675eSRichard Weinberger uint32_t cookie); 15911e51764aSArtem Bityutskiy int ubifs_tnc_remove_range(struct ubifs_info *c, union ubifs_key *from_key, 15921e51764aSArtem Bityutskiy union ubifs_key *to_key); 15931e51764aSArtem Bityutskiy int ubifs_tnc_remove_ino(struct ubifs_info *c, ino_t inum); 15941e51764aSArtem Bityutskiy struct ubifs_dent_node *ubifs_tnc_next_ent(struct ubifs_info *c, 15951e51764aSArtem Bityutskiy union ubifs_key *key, 1596f4f61d2cSRichard Weinberger const struct fscrypt_name *nm); 15971e51764aSArtem Bityutskiy void ubifs_tnc_close(struct ubifs_info *c); 15981e51764aSArtem Bityutskiy int ubifs_tnc_has_node(struct ubifs_info *c, union ubifs_key *key, int level, 15991e51764aSArtem Bityutskiy int lnum, int offs, int is_idx); 16001e51764aSArtem Bityutskiy int ubifs_dirty_idx_node(struct ubifs_info *c, union ubifs_key *key, int level, 16011e51764aSArtem Bityutskiy int lnum, int offs); 16021e51764aSArtem Bityutskiy /* Shared by tnc.c for tnc_commit.c */ 16031e51764aSArtem Bityutskiy void destroy_old_idx(struct ubifs_info *c); 16041e51764aSArtem Bityutskiy int is_idx_node_in_tnc(struct ubifs_info *c, union ubifs_key *key, int level, 16051e51764aSArtem Bityutskiy int lnum, int offs); 16061e51764aSArtem Bityutskiy int insert_old_idx_znode(struct ubifs_info *c, struct ubifs_znode *znode); 16074793e7c5SAdrian Hunter int ubifs_tnc_get_bu_keys(struct ubifs_info *c, struct bu_info *bu); 16084793e7c5SAdrian Hunter int ubifs_tnc_bulk_read(struct ubifs_info *c, struct bu_info *bu); 16091e51764aSArtem Bityutskiy 16101e51764aSArtem Bityutskiy /* tnc_misc.c */ 16111e51764aSArtem Bityutskiy struct ubifs_znode *ubifs_tnc_levelorder_next(struct ubifs_znode *zr, 16121e51764aSArtem Bityutskiy struct ubifs_znode *znode); 16131e51764aSArtem Bityutskiy int ubifs_search_zbranch(const struct ubifs_info *c, 16141e51764aSArtem Bityutskiy const struct ubifs_znode *znode, 16151e51764aSArtem Bityutskiy const union ubifs_key *key, int *n); 16161e51764aSArtem Bityutskiy struct ubifs_znode *ubifs_tnc_postorder_first(struct ubifs_znode *znode); 16171e51764aSArtem Bityutskiy struct ubifs_znode *ubifs_tnc_postorder_next(struct ubifs_znode *znode); 16181e51764aSArtem Bityutskiy long ubifs_destroy_tnc_subtree(struct ubifs_znode *zr); 16191e51764aSArtem Bityutskiy struct ubifs_znode *ubifs_load_znode(struct ubifs_info *c, 16201e51764aSArtem Bityutskiy struct ubifs_zbranch *zbr, 16211e51764aSArtem Bityutskiy struct ubifs_znode *parent, int iip); 16221e51764aSArtem Bityutskiy int ubifs_tnc_read_node(struct ubifs_info *c, struct ubifs_zbranch *zbr, 16231e51764aSArtem Bityutskiy void *node); 16241e51764aSArtem Bityutskiy 16251e51764aSArtem Bityutskiy /* tnc_commit.c */ 16261e51764aSArtem Bityutskiy int ubifs_tnc_start_commit(struct ubifs_info *c, struct ubifs_zbranch *zroot); 16271e51764aSArtem Bityutskiy int ubifs_tnc_end_commit(struct ubifs_info *c); 16281e51764aSArtem Bityutskiy 16291e51764aSArtem Bityutskiy /* shrinker.c */ 16301ab6c499SDave Chinner unsigned long ubifs_shrink_scan(struct shrinker *shrink, 16311ab6c499SDave Chinner struct shrink_control *sc); 16321ab6c499SDave Chinner unsigned long ubifs_shrink_count(struct shrinker *shrink, 16331ab6c499SDave Chinner struct shrink_control *sc); 16341e51764aSArtem Bityutskiy 16351e51764aSArtem Bityutskiy /* commit.c */ 16361e51764aSArtem Bityutskiy int ubifs_bg_thread(void *info); 16371e51764aSArtem Bityutskiy void ubifs_commit_required(struct ubifs_info *c); 16381e51764aSArtem Bityutskiy void ubifs_request_bg_commit(struct ubifs_info *c); 16391e51764aSArtem Bityutskiy int ubifs_run_commit(struct ubifs_info *c); 16401e51764aSArtem Bityutskiy void ubifs_recovery_commit(struct ubifs_info *c); 16411e51764aSArtem Bityutskiy int ubifs_gc_should_commit(struct ubifs_info *c); 16421e51764aSArtem Bityutskiy void ubifs_wait_for_commit(struct ubifs_info *c); 16431e51764aSArtem Bityutskiy 16441e51764aSArtem Bityutskiy /* master.c */ 16451e51764aSArtem Bityutskiy int ubifs_read_master(struct ubifs_info *c); 16461e51764aSArtem Bityutskiy int ubifs_write_master(struct ubifs_info *c); 16471e51764aSArtem Bityutskiy 16481e51764aSArtem Bityutskiy /* sb.c */ 16491e51764aSArtem Bityutskiy int ubifs_read_superblock(struct ubifs_info *c); 16501e51764aSArtem Bityutskiy struct ubifs_sb_node *ubifs_read_sb_node(struct ubifs_info *c); 16511e51764aSArtem Bityutskiy int ubifs_write_sb_node(struct ubifs_info *c, struct ubifs_sb_node *sup); 16526554a657SMatthew L. Creech int ubifs_fixup_free_space(struct ubifs_info *c); 1653e021986eSRichard Weinberger int ubifs_enable_encryption(struct ubifs_info *c); 16541e51764aSArtem Bityutskiy 16551e51764aSArtem Bityutskiy /* replay.c */ 16561e51764aSArtem Bityutskiy int ubifs_validate_entry(struct ubifs_info *c, 16571e51764aSArtem Bityutskiy const struct ubifs_dent_node *dent); 16581e51764aSArtem Bityutskiy int ubifs_replay_journal(struct ubifs_info *c); 16591e51764aSArtem Bityutskiy 16601e51764aSArtem Bityutskiy /* gc.c */ 16611e51764aSArtem Bityutskiy int ubifs_garbage_collect(struct ubifs_info *c, int anyway); 16621e51764aSArtem Bityutskiy int ubifs_gc_start_commit(struct ubifs_info *c); 16631e51764aSArtem Bityutskiy int ubifs_gc_end_commit(struct ubifs_info *c); 1664b466f17dSAdrian Hunter void ubifs_destroy_idx_gc(struct ubifs_info *c); 16651e51764aSArtem Bityutskiy int ubifs_get_idx_gc_leb(struct ubifs_info *c); 16661e51764aSArtem Bityutskiy int ubifs_garbage_collect_leb(struct ubifs_info *c, struct ubifs_lprops *lp); 16671e51764aSArtem Bityutskiy 16681e51764aSArtem Bityutskiy /* orphan.c */ 16691e51764aSArtem Bityutskiy int ubifs_add_orphan(struct ubifs_info *c, ino_t inum); 16701e51764aSArtem Bityutskiy void ubifs_delete_orphan(struct ubifs_info *c, ino_t inum); 16711e51764aSArtem Bityutskiy int ubifs_orphan_start_commit(struct ubifs_info *c); 16721e51764aSArtem Bityutskiy int ubifs_orphan_end_commit(struct ubifs_info *c); 16731e51764aSArtem Bityutskiy int ubifs_mount_orphans(struct ubifs_info *c, int unclean, int read_only); 167449d128aaSAdrian Hunter int ubifs_clear_orphans(struct ubifs_info *c); 16751e51764aSArtem Bityutskiy 16761e51764aSArtem Bityutskiy /* lpt.c */ 16771e51764aSArtem Bityutskiy int ubifs_calc_lpt_geom(struct ubifs_info *c); 16781e51764aSArtem Bityutskiy int ubifs_create_dflt_lpt(struct ubifs_info *c, int *main_lebs, int lpt_first, 16791e51764aSArtem Bityutskiy int *lpt_lebs, int *big_lpt); 16801e51764aSArtem Bityutskiy int ubifs_lpt_init(struct ubifs_info *c, int rd, int wr); 16811e51764aSArtem Bityutskiy struct ubifs_lprops *ubifs_lpt_lookup(struct ubifs_info *c, int lnum); 16821e51764aSArtem Bityutskiy struct ubifs_lprops *ubifs_lpt_lookup_dirty(struct ubifs_info *c, int lnum); 16831e51764aSArtem Bityutskiy int ubifs_lpt_scan_nolock(struct ubifs_info *c, int start_lnum, int end_lnum, 16841e51764aSArtem Bityutskiy ubifs_lpt_scan_callback scan_cb, void *data); 16851e51764aSArtem Bityutskiy 16861e51764aSArtem Bityutskiy /* Shared by lpt.c for lpt_commit.c */ 16871e51764aSArtem Bityutskiy void ubifs_pack_lsave(struct ubifs_info *c, void *buf, int *lsave); 16881e51764aSArtem Bityutskiy void ubifs_pack_ltab(struct ubifs_info *c, void *buf, 16891e51764aSArtem Bityutskiy struct ubifs_lpt_lprops *ltab); 16901e51764aSArtem Bityutskiy void ubifs_pack_pnode(struct ubifs_info *c, void *buf, 16911e51764aSArtem Bityutskiy struct ubifs_pnode *pnode); 16921e51764aSArtem Bityutskiy void ubifs_pack_nnode(struct ubifs_info *c, void *buf, 16931e51764aSArtem Bityutskiy struct ubifs_nnode *nnode); 16941e51764aSArtem Bityutskiy struct ubifs_pnode *ubifs_get_pnode(struct ubifs_info *c, 16951e51764aSArtem Bityutskiy struct ubifs_nnode *parent, int iip); 16961e51764aSArtem Bityutskiy struct ubifs_nnode *ubifs_get_nnode(struct ubifs_info *c, 16971e51764aSArtem Bityutskiy struct ubifs_nnode *parent, int iip); 16981e51764aSArtem Bityutskiy int ubifs_read_nnode(struct ubifs_info *c, struct ubifs_nnode *parent, int iip); 16991e51764aSArtem Bityutskiy void ubifs_add_lpt_dirt(struct ubifs_info *c, int lnum, int dirty); 17001e51764aSArtem Bityutskiy void ubifs_add_nnode_dirt(struct ubifs_info *c, struct ubifs_nnode *nnode); 17011e51764aSArtem Bityutskiy uint32_t ubifs_unpack_bits(uint8_t **addr, int *pos, int nrbits); 17021e51764aSArtem Bityutskiy struct ubifs_nnode *ubifs_first_nnode(struct ubifs_info *c, int *hght); 17032ba5f7aeSArtem Bityutskiy /* Needed only in debugging code in lpt_commit.c */ 17042ba5f7aeSArtem Bityutskiy int ubifs_unpack_nnode(const struct ubifs_info *c, void *buf, 17052ba5f7aeSArtem Bityutskiy struct ubifs_nnode *nnode); 17061e51764aSArtem Bityutskiy 17071e51764aSArtem Bityutskiy /* lpt_commit.c */ 17081e51764aSArtem Bityutskiy int ubifs_lpt_start_commit(struct ubifs_info *c); 17091e51764aSArtem Bityutskiy int ubifs_lpt_end_commit(struct ubifs_info *c); 17101e51764aSArtem Bityutskiy int ubifs_lpt_post_commit(struct ubifs_info *c); 17111e51764aSArtem Bityutskiy void ubifs_lpt_free(struct ubifs_info *c, int wr_only); 17121e51764aSArtem Bityutskiy 17131e51764aSArtem Bityutskiy /* lprops.c */ 17141e51764aSArtem Bityutskiy const struct ubifs_lprops *ubifs_change_lp(struct ubifs_info *c, 17151e51764aSArtem Bityutskiy const struct ubifs_lprops *lp, 17161e51764aSArtem Bityutskiy int free, int dirty, int flags, 17171e51764aSArtem Bityutskiy int idx_gc_cnt); 171884abf972SArtem Bityutskiy void ubifs_get_lp_stats(struct ubifs_info *c, struct ubifs_lp_stats *lst); 17191e51764aSArtem Bityutskiy void ubifs_add_to_cat(struct ubifs_info *c, struct ubifs_lprops *lprops, 17201e51764aSArtem Bityutskiy int cat); 17211e51764aSArtem Bityutskiy void ubifs_replace_cat(struct ubifs_info *c, struct ubifs_lprops *old_lprops, 17221e51764aSArtem Bityutskiy struct ubifs_lprops *new_lprops); 17231e51764aSArtem Bityutskiy void ubifs_ensure_cat(struct ubifs_info *c, struct ubifs_lprops *lprops); 17241e51764aSArtem Bityutskiy int ubifs_categorize_lprops(const struct ubifs_info *c, 17251e51764aSArtem Bityutskiy const struct ubifs_lprops *lprops); 17261e51764aSArtem Bityutskiy int ubifs_change_one_lp(struct ubifs_info *c, int lnum, int free, int dirty, 17271e51764aSArtem Bityutskiy int flags_set, int flags_clean, int idx_gc_cnt); 17281e51764aSArtem Bityutskiy int ubifs_update_one_lp(struct ubifs_info *c, int lnum, int free, int dirty, 17291e51764aSArtem Bityutskiy int flags_set, int flags_clean); 17301e51764aSArtem Bityutskiy int ubifs_read_one_lp(struct ubifs_info *c, int lnum, struct ubifs_lprops *lp); 17311e51764aSArtem Bityutskiy const struct ubifs_lprops *ubifs_fast_find_free(struct ubifs_info *c); 17321e51764aSArtem Bityutskiy const struct ubifs_lprops *ubifs_fast_find_empty(struct ubifs_info *c); 17331e51764aSArtem Bityutskiy const struct ubifs_lprops *ubifs_fast_find_freeable(struct ubifs_info *c); 17341e51764aSArtem Bityutskiy const struct ubifs_lprops *ubifs_fast_find_frdi_idx(struct ubifs_info *c); 1735be9e62a7SArtem Bityutskiy int ubifs_calc_dark(const struct ubifs_info *c, int spc); 17361e51764aSArtem Bityutskiy 17371e51764aSArtem Bityutskiy /* file.c */ 173802c24a82SJosef Bacik int ubifs_fsync(struct file *file, loff_t start, loff_t end, int datasync); 17391e51764aSArtem Bityutskiy int ubifs_setattr(struct dentry *dentry, struct iattr *attr); 17408c1c5f26SDongsheng Yang #ifdef CONFIG_UBIFS_ATIME_SUPPORT 174195582b00SDeepa Dinamani int ubifs_update_time(struct inode *inode, struct timespec64 *time, int flags); 17428c1c5f26SDongsheng Yang #endif 17431e51764aSArtem Bityutskiy 17441e51764aSArtem Bityutskiy /* dir.c */ 1745d475a507SRichard Weinberger struct inode *ubifs_new_inode(struct ubifs_info *c, struct inode *dir, 1746ad44be5cSAl Viro umode_t mode); 1747a528d35eSDavid Howells int ubifs_getattr(const struct path *path, struct kstat *stat, 1748a528d35eSDavid Howells u32 request_mask, unsigned int flags); 1749f6337d84SRichard Weinberger int ubifs_check_dir_empty(struct inode *dir); 17501e51764aSArtem Bityutskiy 17511e51764aSArtem Bityutskiy /* xattr.c */ 17522b88fc21SAndreas Gruenbacher extern const struct xattr_handler *ubifs_xattr_handlers[]; 17531e51764aSArtem Bityutskiy ssize_t ubifs_listxattr(struct dentry *dentry, char *buffer, size_t size); 1754ade46c3aSRichard Weinberger int ubifs_xattr_set(struct inode *host, const char *name, const void *value, 1755d8db5b1cSXiaolei Li size_t size, int flags, bool check_lock); 1756ade46c3aSRichard Weinberger ssize_t ubifs_xattr_get(struct inode *host, const char *name, void *buf, 1757ade46c3aSRichard Weinberger size_t size); 1758272eda82SRichard Weinberger void ubifs_evict_xattr_inode(struct ubifs_info *c, ino_t xattr_inum); 17591e51764aSArtem Bityutskiy 17608326c1eeSHyunchul Lee #ifdef CONFIG_UBIFS_FS_SECURITY 17618326c1eeSHyunchul Lee extern int ubifs_init_security(struct inode *dentry, struct inode *inode, 17628326c1eeSHyunchul Lee const struct qstr *qstr); 17638326c1eeSHyunchul Lee #else 17648326c1eeSHyunchul Lee static inline int ubifs_init_security(struct inode *dentry, 17658326c1eeSHyunchul Lee struct inode *inode, const struct qstr *qstr) 17668326c1eeSHyunchul Lee { 17678326c1eeSHyunchul Lee return 0; 17688326c1eeSHyunchul Lee } 17698326c1eeSHyunchul Lee #endif 17708326c1eeSHyunchul Lee 17718326c1eeSHyunchul Lee 17721e51764aSArtem Bityutskiy /* super.c */ 17731e51764aSArtem Bityutskiy struct inode *ubifs_iget(struct super_block *sb, unsigned long inum); 17741e51764aSArtem Bityutskiy 17751e51764aSArtem Bityutskiy /* recovery.c */ 17761e51764aSArtem Bityutskiy int ubifs_recover_master_node(struct ubifs_info *c); 17771e51764aSArtem Bityutskiy int ubifs_write_rcvrd_mst_node(struct ubifs_info *c); 17781e51764aSArtem Bityutskiy struct ubifs_scan_leb *ubifs_recover_leb(struct ubifs_info *c, int lnum, 1779efcfde54SArtem Bityutskiy int offs, void *sbuf, int jhead); 17801e51764aSArtem Bityutskiy struct ubifs_scan_leb *ubifs_recover_log_leb(struct ubifs_info *c, int lnum, 17811e51764aSArtem Bityutskiy int offs, void *sbuf); 178283cef708SArtem Bityutskiy int ubifs_recover_inl_heads(struct ubifs_info *c, void *sbuf); 178383cef708SArtem Bityutskiy int ubifs_clean_lebs(struct ubifs_info *c, void *sbuf); 17841e51764aSArtem Bityutskiy int ubifs_rcvry_gc_commit(struct ubifs_info *c); 17851e51764aSArtem Bityutskiy int ubifs_recover_size_accum(struct ubifs_info *c, union ubifs_key *key, 17861e51764aSArtem Bityutskiy int deletion, loff_t new_size); 17871e51764aSArtem Bityutskiy int ubifs_recover_size(struct ubifs_info *c); 17881e51764aSArtem Bityutskiy void ubifs_destroy_size_tree(struct ubifs_info *c); 17891e51764aSArtem Bityutskiy 17901e51764aSArtem Bityutskiy /* ioctl.c */ 17911e51764aSArtem Bityutskiy long ubifs_ioctl(struct file *file, unsigned int cmd, unsigned long arg); 17921e51764aSArtem Bityutskiy void ubifs_set_inode_flags(struct inode *inode); 17931e51764aSArtem Bityutskiy #ifdef CONFIG_COMPAT 17941e51764aSArtem Bityutskiy long ubifs_compat_ioctl(struct file *file, unsigned int cmd, unsigned long arg); 17951e51764aSArtem Bityutskiy #endif 17961e51764aSArtem Bityutskiy 17971e51764aSArtem Bityutskiy /* compressor.c */ 17981e51764aSArtem Bityutskiy int __init ubifs_compressors_init(void); 1799995be045SAlexey Dobriyan void ubifs_compressors_exit(void); 1800235c362bSSheng Yong void ubifs_compress(const struct ubifs_info *c, const void *in_buf, int in_len, 1801235c362bSSheng Yong void *out_buf, int *out_len, int *compr_type); 1802235c362bSSheng Yong int ubifs_decompress(const struct ubifs_info *c, const void *buf, int len, 1803235c362bSSheng Yong void *out, int *out_len, int compr_type); 18041e51764aSArtem Bityutskiy 18051e51764aSArtem Bityutskiy #include "debug.h" 18061e51764aSArtem Bityutskiy #include "misc.h" 18071e51764aSArtem Bityutskiy #include "key.h" 18081e51764aSArtem Bityutskiy 1809d475a507SRichard Weinberger #ifndef CONFIG_UBIFS_FS_ENCRYPTION 18107799953bSRichard Weinberger static inline int ubifs_encrypt(const struct inode *inode, 18117799953bSRichard Weinberger struct ubifs_data_node *dn, 18127799953bSRichard Weinberger unsigned int in_len, unsigned int *out_len, 18137799953bSRichard Weinberger int block) 18147799953bSRichard Weinberger { 18157799953bSRichard Weinberger ubifs_assert(0); 18167799953bSRichard Weinberger return -EOPNOTSUPP; 18177799953bSRichard Weinberger } 18187799953bSRichard Weinberger static inline int ubifs_decrypt(const struct inode *inode, 18197799953bSRichard Weinberger struct ubifs_data_node *dn, 18207799953bSRichard Weinberger unsigned int *out_len, int block) 18217799953bSRichard Weinberger { 18227799953bSRichard Weinberger ubifs_assert(0); 18237799953bSRichard Weinberger return -EOPNOTSUPP; 18247799953bSRichard Weinberger } 18257799953bSRichard Weinberger #else 18267799953bSRichard Weinberger /* crypto.c */ 18277799953bSRichard Weinberger int ubifs_encrypt(const struct inode *inode, struct ubifs_data_node *dn, 18287799953bSRichard Weinberger unsigned int in_len, unsigned int *out_len, int block); 18297799953bSRichard Weinberger int ubifs_decrypt(const struct inode *inode, struct ubifs_data_node *dn, 18307799953bSRichard Weinberger unsigned int *out_len, int block); 1831d475a507SRichard Weinberger #endif 1832d475a507SRichard Weinberger 18336f69f0edSEric Biggers extern const struct fscrypt_operations ubifs_crypt_operations; 18347799953bSRichard Weinberger 18351ee77870SRichard Weinberger static inline bool ubifs_crypt_is_encrypted(const struct inode *inode) 18361ee77870SRichard Weinberger { 1837f7293e48SEric Biggers const struct ubifs_inode *ui = ubifs_inode(inode); 1838f7293e48SEric Biggers 1839f7293e48SEric Biggers return ui->flags & UBIFS_CRYPT_FL; 18401ee77870SRichard Weinberger } 18411ee77870SRichard Weinberger 18423e7f2c51SJoe Perches /* Normal UBIFS messages */ 18433e7f2c51SJoe Perches __printf(2, 3) 18443e7f2c51SJoe Perches void ubifs_msg(const struct ubifs_info *c, const char *fmt, ...); 18453e7f2c51SJoe Perches __printf(2, 3) 18463e7f2c51SJoe Perches void ubifs_err(const struct ubifs_info *c, const char *fmt, ...); 18473e7f2c51SJoe Perches __printf(2, 3) 18483e7f2c51SJoe Perches void ubifs_warn(const struct ubifs_info *c, const char *fmt, ...); 18493e7f2c51SJoe Perches /* 1850380bc8b7SDaniel Golle * A conditional variant of 'ubifs_err()' which doesn't output anything 18511751e8a6SLinus Torvalds * if probing (ie. SB_SILENT set). 18523e7f2c51SJoe Perches */ 18533e7f2c51SJoe Perches #define ubifs_errc(c, fmt, ...) \ 18543e7f2c51SJoe Perches do { \ 18553e7f2c51SJoe Perches if (!(c)->probing) \ 18563e7f2c51SJoe Perches ubifs_err(c, fmt, ##__VA_ARGS__); \ 18573e7f2c51SJoe Perches } while (0) 18583e7f2c51SJoe Perches 18591e51764aSArtem Bityutskiy #endif /* !__UBIFS_H__ */ 1860