xref: /openbmc/linux/fs/ubifs/ubifs.h (revision 528e3d17)
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>
41d475a507SRichard Weinberger #include <linux/fscrypto.h>
421e51764aSArtem Bityutskiy #include "ubifs-media.h"
431e51764aSArtem Bityutskiy 
441e51764aSArtem Bityutskiy /* Version of this UBIFS implementation */
451e51764aSArtem Bityutskiy #define UBIFS_VERSION 1
461e51764aSArtem Bityutskiy 
471e51764aSArtem Bityutskiy /* UBIFS file system VFS magic number */
481e51764aSArtem Bityutskiy #define UBIFS_SUPER_MAGIC 0x24051905
491e51764aSArtem Bityutskiy 
501e51764aSArtem Bityutskiy /* Number of UBIFS blocks per VFS page */
5109cbfeafSKirill A. Shutemov #define UBIFS_BLOCKS_PER_PAGE (PAGE_SIZE / UBIFS_BLOCK_SIZE)
5209cbfeafSKirill A. Shutemov #define UBIFS_BLOCKS_PER_PAGE_SHIFT (PAGE_SHIFT - UBIFS_BLOCK_SHIFT)
531e51764aSArtem Bityutskiy 
541e51764aSArtem Bityutskiy /* "File system end of life" sequence number watermark */
551e51764aSArtem Bityutskiy #define SQNUM_WARN_WATERMARK 0xFFFFFFFF00000000ULL
561e51764aSArtem Bityutskiy #define SQNUM_WATERMARK      0xFFFFFFFFFF000000ULL
571e51764aSArtem Bityutskiy 
58af14a1adSArtem Bityutskiy /*
59af14a1adSArtem Bityutskiy  * Minimum amount of LEBs reserved for the index. At present the index needs at
60af14a1adSArtem Bityutskiy  * least 2 LEBs: one for the index head and one for in-the-gaps method (which
61af14a1adSArtem Bityutskiy  * currently does not cater for the index head and so excludes it from
62af14a1adSArtem Bityutskiy  * consideration).
63af14a1adSArtem Bityutskiy  */
64af14a1adSArtem Bityutskiy #define MIN_INDEX_LEBS 2
65af14a1adSArtem Bityutskiy 
661e51764aSArtem Bityutskiy /* Minimum amount of data UBIFS writes to the flash */
671e51764aSArtem Bityutskiy #define MIN_WRITE_SZ (UBIFS_DATA_NODE_SZ + 8)
681e51764aSArtem Bityutskiy 
691e51764aSArtem Bityutskiy /*
701e51764aSArtem Bityutskiy  * Currently we do not support inode number overlapping and re-using, so this
711e51764aSArtem Bityutskiy  * watermark defines dangerous inode number level. This should be fixed later,
721e51764aSArtem Bityutskiy  * although it is difficult to exceed current limit. Another option is to use
731e51764aSArtem Bityutskiy  * 64-bit inode numbers, but this means more overhead.
741e51764aSArtem Bityutskiy  */
751e51764aSArtem Bityutskiy #define INUM_WARN_WATERMARK 0xFFF00000
761e51764aSArtem Bityutskiy #define INUM_WATERMARK      0xFFFFFF00
771e51764aSArtem Bityutskiy 
781e51764aSArtem Bityutskiy /* Maximum number of entries in each LPT (LEB category) heap */
791e51764aSArtem Bityutskiy #define LPT_HEAP_SZ 256
801e51764aSArtem Bityutskiy 
811e51764aSArtem Bityutskiy /*
821e51764aSArtem Bityutskiy  * Background thread name pattern. The numbers are UBI device and volume
831e51764aSArtem Bityutskiy  * numbers.
841e51764aSArtem Bityutskiy  */
851e51764aSArtem Bityutskiy #define BGT_NAME_PATTERN "ubifs_bgt%d_%d"
861e51764aSArtem Bityutskiy 
871e51764aSArtem Bityutskiy /* Maximum possible inode number (only 32-bit inodes are supported now) */
881e51764aSArtem Bityutskiy #define MAX_INUM 0xFFFFFFFF
891e51764aSArtem Bityutskiy 
901e51764aSArtem Bityutskiy /* Number of non-data journal heads */
911e51764aSArtem Bityutskiy #define NONDATA_JHEADS_CNT 2
921e51764aSArtem Bityutskiy 
93d6d14009SArtem Bityutskiy /* Shorter names for journal head numbers for internal usage */
94d6d14009SArtem Bityutskiy #define GCHD   UBIFS_GC_HEAD
95d6d14009SArtem Bityutskiy #define BASEHD UBIFS_BASE_HEAD
96d6d14009SArtem Bityutskiy #define DATAHD UBIFS_DATA_HEAD
971e51764aSArtem Bityutskiy 
981e51764aSArtem Bityutskiy /* 'No change' value for 'ubifs_change_lp()' */
991e51764aSArtem Bityutskiy #define LPROPS_NC 0x80000001
1001e51764aSArtem Bityutskiy 
1011e51764aSArtem Bityutskiy /*
1021e51764aSArtem Bityutskiy  * There is no notion of truncation key because truncation nodes do not exist
1031e51764aSArtem Bityutskiy  * in TNC. However, when replaying, it is handy to introduce fake "truncation"
1041e51764aSArtem Bityutskiy  * keys for truncation nodes because the code becomes simpler. So we define
1051e51764aSArtem Bityutskiy  * %UBIFS_TRUN_KEY type.
106ba2f48f7SArtem Bityutskiy  *
107ba2f48f7SArtem Bityutskiy  * But otherwise, out of the journal reply scope, the truncation keys are
108ba2f48f7SArtem Bityutskiy  * invalid.
1091e51764aSArtem Bityutskiy  */
1101e51764aSArtem Bityutskiy #define UBIFS_TRUN_KEY    UBIFS_KEY_TYPES_CNT
111ba2f48f7SArtem Bityutskiy #define UBIFS_INVALID_KEY UBIFS_KEY_TYPES_CNT
1121e51764aSArtem Bityutskiy 
1131e51764aSArtem Bityutskiy /*
1141e51764aSArtem Bityutskiy  * How much a directory entry/extended attribute entry adds to the parent/host
1151e51764aSArtem Bityutskiy  * inode.
1161e51764aSArtem Bityutskiy  */
1171e51764aSArtem Bityutskiy #define CALC_DENT_SIZE(name_len) ALIGN(UBIFS_DENT_NODE_SZ + (name_len) + 1, 8)
1181e51764aSArtem Bityutskiy 
1191e51764aSArtem Bityutskiy /* How much an extended attribute adds to the host inode */
1201e51764aSArtem Bityutskiy #define CALC_XATTR_BYTES(data_len) ALIGN(UBIFS_INO_NODE_SZ + (data_len) + 1, 8)
1211e51764aSArtem Bityutskiy 
1221e51764aSArtem Bityutskiy /*
1231e51764aSArtem Bityutskiy  * Znodes which were not touched for 'OLD_ZNODE_AGE' seconds are considered
1241e51764aSArtem Bityutskiy  * "old", and znode which were touched last 'YOUNG_ZNODE_AGE' seconds ago are
1251e51764aSArtem Bityutskiy  * considered "young". This is used by shrinker when selecting znode to trim
1261e51764aSArtem Bityutskiy  * off.
1271e51764aSArtem Bityutskiy  */
1281e51764aSArtem Bityutskiy #define OLD_ZNODE_AGE 20
1291e51764aSArtem Bityutskiy #define YOUNG_ZNODE_AGE 5
1301e51764aSArtem Bityutskiy 
1311e51764aSArtem Bityutskiy /*
1321e51764aSArtem Bityutskiy  * Some compressors, like LZO, may end up with more data then the input buffer.
1331e51764aSArtem Bityutskiy  * So UBIFS always allocates larger output buffer, to be sure the compressor
1341e51764aSArtem Bityutskiy  * will not corrupt memory in case of worst case compression.
1351e51764aSArtem Bityutskiy  */
1361e51764aSArtem Bityutskiy #define WORST_COMPR_FACTOR 2
1371e51764aSArtem Bityutskiy 
1387799953bSRichard Weinberger #ifdef CONFIG_UBIFS_FS_ENCRYPTION
1397799953bSRichard Weinberger #define UBIFS_CIPHER_BLOCK_SIZE FS_CRYPTO_BLOCK_SIZE
1407799953bSRichard Weinberger #else
1417799953bSRichard Weinberger #define UBIFS_CIPHER_BLOCK_SIZE 0
1427799953bSRichard Weinberger #endif
1437799953bSRichard Weinberger 
144d882962fSMatthew L. Creech /*
145d3f9db00SYannick Guerrini  * How much memory is needed for a buffer where we compress a data node.
146d882962fSMatthew L. Creech  */
147d882962fSMatthew L. Creech #define COMPRESSED_DATA_NODE_BUF_SZ \
148d882962fSMatthew L. Creech 	(UBIFS_DATA_NODE_SZ + UBIFS_BLOCK_SIZE * WORST_COMPR_FACTOR)
149d882962fSMatthew L. Creech 
1501e51764aSArtem Bityutskiy /* Maximum expected tree height for use by bottom_up_buf */
1511e51764aSArtem Bityutskiy #define BOTTOM_UP_HEIGHT 64
1521e51764aSArtem Bityutskiy 
1534793e7c5SAdrian Hunter /* Maximum number of data nodes to bulk-read */
1544793e7c5SAdrian Hunter #define UBIFS_MAX_BULK_READ 32
1554793e7c5SAdrian Hunter 
1561e51764aSArtem Bityutskiy /*
1571e51764aSArtem Bityutskiy  * Lockdep classes for UBIFS inode @ui_mutex.
1581e51764aSArtem Bityutskiy  */
1591e51764aSArtem Bityutskiy enum {
1601e51764aSArtem Bityutskiy 	WB_MUTEX_1 = 0,
1611e51764aSArtem Bityutskiy 	WB_MUTEX_2 = 1,
1621e51764aSArtem Bityutskiy 	WB_MUTEX_3 = 2,
1639e0a1fffSRichard Weinberger 	WB_MUTEX_4 = 3,
1641e51764aSArtem Bityutskiy };
1651e51764aSArtem Bityutskiy 
1661e51764aSArtem Bityutskiy /*
1671e51764aSArtem Bityutskiy  * Znode flags (actually, bit numbers which store the flags).
1681e51764aSArtem Bityutskiy  *
1691e51764aSArtem Bityutskiy  * DIRTY_ZNODE: znode is dirty
1701e51764aSArtem Bityutskiy  * COW_ZNODE: znode is being committed and a new instance of this znode has to
1711e51764aSArtem Bityutskiy  *            be created before changing this znode
1721e51764aSArtem Bityutskiy  * OBSOLETE_ZNODE: znode is obsolete, which means it was deleted, but it is
1731e51764aSArtem Bityutskiy  *                 still in the commit list and the ongoing commit operation
1741e51764aSArtem Bityutskiy  *                 will commit it, and delete this znode after it is done
1751e51764aSArtem Bityutskiy  */
1761e51764aSArtem Bityutskiy enum {
1771e51764aSArtem Bityutskiy 	DIRTY_ZNODE    = 0,
1781e51764aSArtem Bityutskiy 	COW_ZNODE      = 1,
1791e51764aSArtem Bityutskiy 	OBSOLETE_ZNODE = 2,
1801e51764aSArtem Bityutskiy };
1811e51764aSArtem Bityutskiy 
1821e51764aSArtem Bityutskiy /*
1831e51764aSArtem Bityutskiy  * Commit states.
1841e51764aSArtem Bityutskiy  *
1851e51764aSArtem Bityutskiy  * COMMIT_RESTING: commit is not wanted
1861e51764aSArtem Bityutskiy  * COMMIT_BACKGROUND: background commit has been requested
1871e51764aSArtem Bityutskiy  * COMMIT_REQUIRED: commit is required
1881e51764aSArtem Bityutskiy  * COMMIT_RUNNING_BACKGROUND: background commit is running
1891e51764aSArtem Bityutskiy  * COMMIT_RUNNING_REQUIRED: commit is running and it is required
1901e51764aSArtem Bityutskiy  * COMMIT_BROKEN: commit failed
1911e51764aSArtem Bityutskiy  */
1921e51764aSArtem Bityutskiy enum {
1931e51764aSArtem Bityutskiy 	COMMIT_RESTING = 0,
1941e51764aSArtem Bityutskiy 	COMMIT_BACKGROUND,
1951e51764aSArtem Bityutskiy 	COMMIT_REQUIRED,
1961e51764aSArtem Bityutskiy 	COMMIT_RUNNING_BACKGROUND,
1971e51764aSArtem Bityutskiy 	COMMIT_RUNNING_REQUIRED,
1981e51764aSArtem Bityutskiy 	COMMIT_BROKEN,
1991e51764aSArtem Bityutskiy };
2001e51764aSArtem Bityutskiy 
2011e51764aSArtem Bityutskiy /*
2021e51764aSArtem Bityutskiy  * 'ubifs_scan_a_node()' return values.
2031e51764aSArtem Bityutskiy  *
2041e51764aSArtem Bityutskiy  * SCANNED_GARBAGE:  scanned garbage
2051e51764aSArtem Bityutskiy  * SCANNED_EMPTY_SPACE: scanned empty space
2061e51764aSArtem Bityutskiy  * SCANNED_A_NODE: scanned a valid node
2071e51764aSArtem Bityutskiy  * SCANNED_A_CORRUPT_NODE: scanned a corrupted node
2081e51764aSArtem Bityutskiy  * SCANNED_A_BAD_PAD_NODE: scanned a padding node with invalid pad length
2091e51764aSArtem Bityutskiy  *
2101e51764aSArtem Bityutskiy  * Greater than zero means: 'scanned that number of padding bytes'
2111e51764aSArtem Bityutskiy  */
2121e51764aSArtem Bityutskiy enum {
2131e51764aSArtem Bityutskiy 	SCANNED_GARBAGE        = 0,
2141e51764aSArtem Bityutskiy 	SCANNED_EMPTY_SPACE    = -1,
2151e51764aSArtem Bityutskiy 	SCANNED_A_NODE         = -2,
2161e51764aSArtem Bityutskiy 	SCANNED_A_CORRUPT_NODE = -3,
2171e51764aSArtem Bityutskiy 	SCANNED_A_BAD_PAD_NODE = -4,
2181e51764aSArtem Bityutskiy };
2191e51764aSArtem Bityutskiy 
2201e51764aSArtem Bityutskiy /*
2211e51764aSArtem Bityutskiy  * LPT cnode flag bits.
2221e51764aSArtem Bityutskiy  *
2231e51764aSArtem Bityutskiy  * DIRTY_CNODE: cnode is dirty
2241e51764aSArtem Bityutskiy  * OBSOLETE_CNODE: cnode is being committed and has been copied (or deleted),
2251e51764aSArtem Bityutskiy  *                 so it can (and must) be freed when the commit is finished
22637662447SArtem Bityutskiy  * COW_CNODE: cnode is being committed and must be copied before writing
2271e51764aSArtem Bityutskiy  */
2281e51764aSArtem Bityutskiy enum {
2291e51764aSArtem Bityutskiy 	DIRTY_CNODE    = 0,
23037662447SArtem Bityutskiy 	OBSOLETE_CNODE = 1,
23137662447SArtem Bityutskiy 	COW_CNODE      = 2,
2321e51764aSArtem Bityutskiy };
2331e51764aSArtem Bityutskiy 
2341e51764aSArtem Bityutskiy /*
2351e51764aSArtem Bityutskiy  * Dirty flag bits (lpt_drty_flgs) for LPT special nodes.
2361e51764aSArtem Bityutskiy  *
2371e51764aSArtem Bityutskiy  * LTAB_DIRTY: ltab node is dirty
2381e51764aSArtem Bityutskiy  * LSAVE_DIRTY: lsave node is dirty
2391e51764aSArtem Bityutskiy  */
2401e51764aSArtem Bityutskiy enum {
2411e51764aSArtem Bityutskiy 	LTAB_DIRTY  = 1,
2421e51764aSArtem Bityutskiy 	LSAVE_DIRTY = 2,
2431e51764aSArtem Bityutskiy };
2441e51764aSArtem Bityutskiy 
2451e51764aSArtem Bityutskiy /*
2461e51764aSArtem Bityutskiy  * Return codes used by the garbage collector.
2471e51764aSArtem Bityutskiy  * @LEB_FREED: the logical eraseblock was freed and is ready to use
2481e51764aSArtem Bityutskiy  * @LEB_FREED_IDX: indexing LEB was freed and can be used only after the commit
2491e51764aSArtem Bityutskiy  * @LEB_RETAINED: the logical eraseblock was freed and retained for GC purposes
2501e51764aSArtem Bityutskiy  */
2511e51764aSArtem Bityutskiy enum {
2521e51764aSArtem Bityutskiy 	LEB_FREED,
2531e51764aSArtem Bityutskiy 	LEB_FREED_IDX,
2541e51764aSArtem Bityutskiy 	LEB_RETAINED,
2551e51764aSArtem Bityutskiy };
2561e51764aSArtem Bityutskiy 
2571e51764aSArtem Bityutskiy /**
2581e51764aSArtem Bityutskiy  * struct ubifs_old_idx - index node obsoleted since last commit start.
2591e51764aSArtem Bityutskiy  * @rb: rb-tree node
2601e51764aSArtem Bityutskiy  * @lnum: LEB number of obsoleted index node
2611e51764aSArtem Bityutskiy  * @offs: offset of obsoleted index node
2621e51764aSArtem Bityutskiy  */
2631e51764aSArtem Bityutskiy struct ubifs_old_idx {
2641e51764aSArtem Bityutskiy 	struct rb_node rb;
2651e51764aSArtem Bityutskiy 	int lnum;
2661e51764aSArtem Bityutskiy 	int offs;
2671e51764aSArtem Bityutskiy };
2681e51764aSArtem Bityutskiy 
2691e51764aSArtem Bityutskiy /* The below union makes it easier to deal with keys */
2701e51764aSArtem Bityutskiy union ubifs_key {
2717ca58badSArtem Bityutskiy 	uint8_t u8[UBIFS_SK_LEN];
2727ca58badSArtem Bityutskiy 	uint32_t u32[UBIFS_SK_LEN/4];
2737ca58badSArtem Bityutskiy 	uint64_t u64[UBIFS_SK_LEN/8];
2747ca58badSArtem Bityutskiy 	__le32 j32[UBIFS_SK_LEN/4];
2751e51764aSArtem Bityutskiy };
2761e51764aSArtem Bityutskiy 
2771e51764aSArtem Bityutskiy /**
2781e51764aSArtem Bityutskiy  * struct ubifs_scan_node - UBIFS scanned node information.
2791e51764aSArtem Bityutskiy  * @list: list of scanned nodes
2801e51764aSArtem Bityutskiy  * @key: key of node scanned (if it has one)
2811e51764aSArtem Bityutskiy  * @sqnum: sequence number
2821e51764aSArtem Bityutskiy  * @type: type of node scanned
2831e51764aSArtem Bityutskiy  * @offs: offset with LEB of node scanned
2841e51764aSArtem Bityutskiy  * @len: length of node scanned
2851e51764aSArtem Bityutskiy  * @node: raw node
2861e51764aSArtem Bityutskiy  */
2871e51764aSArtem Bityutskiy struct ubifs_scan_node {
2881e51764aSArtem Bityutskiy 	struct list_head list;
2891e51764aSArtem Bityutskiy 	union ubifs_key key;
2901e51764aSArtem Bityutskiy 	unsigned long long sqnum;
2911e51764aSArtem Bityutskiy 	int type;
2921e51764aSArtem Bityutskiy 	int offs;
2931e51764aSArtem Bityutskiy 	int len;
2941e51764aSArtem Bityutskiy 	void *node;
2951e51764aSArtem Bityutskiy };
2961e51764aSArtem Bityutskiy 
2971e51764aSArtem Bityutskiy /**
2981e51764aSArtem Bityutskiy  * struct ubifs_scan_leb - UBIFS scanned LEB information.
2991e51764aSArtem Bityutskiy  * @lnum: logical eraseblock number
3001e51764aSArtem Bityutskiy  * @nodes_cnt: number of nodes scanned
3011e51764aSArtem Bityutskiy  * @nodes: list of struct ubifs_scan_node
3021e51764aSArtem Bityutskiy  * @endpt: end point (and therefore the start of empty space)
3031e51764aSArtem Bityutskiy  * @buf: buffer containing entire LEB scanned
3041e51764aSArtem Bityutskiy  */
3051e51764aSArtem Bityutskiy struct ubifs_scan_leb {
3061e51764aSArtem Bityutskiy 	int lnum;
3071e51764aSArtem Bityutskiy 	int nodes_cnt;
3081e51764aSArtem Bityutskiy 	struct list_head nodes;
3091e51764aSArtem Bityutskiy 	int endpt;
3101e51764aSArtem Bityutskiy 	void *buf;
3111e51764aSArtem Bityutskiy };
3121e51764aSArtem Bityutskiy 
3131e51764aSArtem Bityutskiy /**
3141e51764aSArtem Bityutskiy  * struct ubifs_gced_idx_leb - garbage-collected indexing LEB.
3151e51764aSArtem Bityutskiy  * @list: list
3161e51764aSArtem Bityutskiy  * @lnum: LEB number
3171e51764aSArtem Bityutskiy  * @unmap: OK to unmap this LEB
3181e51764aSArtem Bityutskiy  *
3191e51764aSArtem Bityutskiy  * This data structure is used to temporary store garbage-collected indexing
3201e51764aSArtem Bityutskiy  * LEBs - they are not released immediately, but only after the next commit.
3211e51764aSArtem Bityutskiy  * This is needed to guarantee recoverability.
3221e51764aSArtem Bityutskiy  */
3231e51764aSArtem Bityutskiy struct ubifs_gced_idx_leb {
3241e51764aSArtem Bityutskiy 	struct list_head list;
3251e51764aSArtem Bityutskiy 	int lnum;
3261e51764aSArtem Bityutskiy 	int unmap;
3271e51764aSArtem Bityutskiy };
3281e51764aSArtem Bityutskiy 
3291e51764aSArtem Bityutskiy /**
3301e51764aSArtem Bityutskiy  * struct ubifs_inode - UBIFS in-memory inode description.
3311e51764aSArtem Bityutskiy  * @vfs_inode: VFS inode description object
3321e51764aSArtem Bityutskiy  * @creat_sqnum: sequence number at time of creation
333de94eb55SArtem Bityutskiy  * @del_cmtno: commit number corresponding to the time the inode was deleted,
334de94eb55SArtem Bityutskiy  *             protected by @c->commit_sem;
3351e51764aSArtem Bityutskiy  * @xattr_size: summarized size of all extended attributes in bytes
3361e51764aSArtem Bityutskiy  * @xattr_cnt: count of extended attributes this inode has
3371e51764aSArtem Bityutskiy  * @xattr_names: sum of lengths of all extended attribute names belonging to
3381e51764aSArtem Bityutskiy  *               this inode
3391e51764aSArtem Bityutskiy  * @dirty: non-zero if the inode is dirty
3401e51764aSArtem Bityutskiy  * @xattr: non-zero if this is an extended attribute inode
341625bf371SArtem Bityutskiy  * @bulk_read: non-zero if bulk-read should be used
3421e51764aSArtem Bityutskiy  * @ui_mutex: serializes inode write-back with the rest of VFS operations,
3434793e7c5SAdrian Hunter  *            serializes "clean <-> dirty" state changes, serializes bulk-read,
344ba60ecabSArtem Bityutskiy  *            protects @dirty, @bulk_read, @ui_size, and @xattr_size
3451e51764aSArtem Bityutskiy  * @ui_lock: protects @synced_i_size
3461e51764aSArtem Bityutskiy  * @synced_i_size: synchronized size of inode, i.e. the value of inode size
3471e51764aSArtem Bityutskiy  *                 currently stored on the flash; used only for regular file
3481e51764aSArtem Bityutskiy  *                 inodes
3491e51764aSArtem Bityutskiy  * @ui_size: inode size used by UBIFS when writing to flash
3501e51764aSArtem Bityutskiy  * @flags: inode flags (@UBIFS_COMPR_FL, etc)
3511e51764aSArtem Bityutskiy  * @compr_type: default compression type used for this inode
3524793e7c5SAdrian Hunter  * @last_page_read: page number of last page read (for bulk read)
3534793e7c5SAdrian Hunter  * @read_in_a_row: number of consecutive pages read in a row (for bulk read)
3541e51764aSArtem Bityutskiy  * @data_len: length of the data attached to the inode
3551e51764aSArtem Bityutskiy  * @data: inode's data
3561e51764aSArtem Bityutskiy  *
3571e51764aSArtem Bityutskiy  * @ui_mutex exists for two main reasons. At first it prevents inodes from
3581e51764aSArtem Bityutskiy  * being written back while UBIFS changing them, being in the middle of an VFS
3591e51764aSArtem Bityutskiy  * operation. This way UBIFS makes sure the inode fields are consistent. For
3601e51764aSArtem Bityutskiy  * example, in 'ubifs_rename()' we change 3 inodes simultaneously, and
3611e51764aSArtem Bityutskiy  * write-back must not write any of them before we have finished.
3621e51764aSArtem Bityutskiy  *
3631e51764aSArtem Bityutskiy  * The second reason is budgeting - UBIFS has to budget all operations. If an
3641e51764aSArtem Bityutskiy  * operation is going to mark an inode dirty, it has to allocate budget for
3651e51764aSArtem Bityutskiy  * this. It cannot just mark it dirty because there is no guarantee there will
3661e51764aSArtem Bityutskiy  * be enough flash space to write the inode back later. This means UBIFS has
3671e51764aSArtem Bityutskiy  * to have full control over inode "clean <-> dirty" transitions (and pages
3681e51764aSArtem Bityutskiy  * actually). But unfortunately, VFS marks inodes dirty in many places, and it
3691e51764aSArtem Bityutskiy  * does not ask the file-system if it is allowed to do so (there is a notifier,
3701e51764aSArtem Bityutskiy  * but it is not enough), i.e., there is no mechanism to synchronize with this.
3711e51764aSArtem Bityutskiy  * So UBIFS has its own inode dirty flag and its own mutex to serialize
3721e51764aSArtem Bityutskiy  * "clean <-> dirty" transitions.
3731e51764aSArtem Bityutskiy  *
3741e51764aSArtem Bityutskiy  * The @synced_i_size field is used to make sure we never write pages which are
3751e51764aSArtem Bityutskiy  * beyond last synchronized inode size. See 'ubifs_writepage()' for more
3761e51764aSArtem Bityutskiy  * information.
3771e51764aSArtem Bityutskiy  *
3781e51764aSArtem Bityutskiy  * The @ui_size is a "shadow" variable for @inode->i_size and UBIFS uses
3791e51764aSArtem Bityutskiy  * @ui_size instead of @inode->i_size. The reason for this is that UBIFS cannot
3801e51764aSArtem Bityutskiy  * make sure @inode->i_size is always changed under @ui_mutex, because it
381c4361570SArtem Bityutskiy  * cannot call 'truncate_setsize()' with @ui_mutex locked, because it would
382c4361570SArtem Bityutskiy  * deadlock with 'ubifs_writepage()' (see file.c). All the other inode fields
383c4361570SArtem Bityutskiy  * are changed under @ui_mutex, so they do not need "shadow" fields. Note, one
3841e51764aSArtem Bityutskiy  * could consider to rework locking and base it on "shadow" fields.
3851e51764aSArtem Bityutskiy  */
3861e51764aSArtem Bityutskiy struct ubifs_inode {
3871e51764aSArtem Bityutskiy 	struct inode vfs_inode;
3881e51764aSArtem Bityutskiy 	unsigned long long creat_sqnum;
389de94eb55SArtem Bityutskiy 	unsigned long long del_cmtno;
3901e51764aSArtem Bityutskiy 	unsigned int xattr_size;
3911e51764aSArtem Bityutskiy 	unsigned int xattr_cnt;
3921e51764aSArtem Bityutskiy 	unsigned int xattr_names;
3931e51764aSArtem Bityutskiy 	unsigned int dirty:1;
3941e51764aSArtem Bityutskiy 	unsigned int xattr:1;
395625bf371SArtem Bityutskiy 	unsigned int bulk_read:1;
396a1dc080cSArtem Bityutskiy 	unsigned int compr_type:2;
3971e51764aSArtem Bityutskiy 	struct mutex ui_mutex;
3981e51764aSArtem Bityutskiy 	spinlock_t ui_lock;
3991e51764aSArtem Bityutskiy 	loff_t synced_i_size;
4001e51764aSArtem Bityutskiy 	loff_t ui_size;
4011e51764aSArtem Bityutskiy 	int flags;
4024793e7c5SAdrian Hunter 	pgoff_t last_page_read;
4034793e7c5SAdrian Hunter 	pgoff_t read_in_a_row;
4041e51764aSArtem Bityutskiy 	int data_len;
4051e51764aSArtem Bityutskiy 	void *data;
4061e51764aSArtem Bityutskiy };
4071e51764aSArtem Bityutskiy 
4081e51764aSArtem Bityutskiy /**
4091e51764aSArtem Bityutskiy  * struct ubifs_unclean_leb - records a LEB recovered under read-only mode.
4101e51764aSArtem Bityutskiy  * @list: list
4111e51764aSArtem Bityutskiy  * @lnum: LEB number of recovered LEB
4121e51764aSArtem Bityutskiy  * @endpt: offset where recovery ended
4131e51764aSArtem Bityutskiy  *
4141e51764aSArtem Bityutskiy  * This structure records a LEB identified during recovery that needs to be
4151e51764aSArtem Bityutskiy  * cleaned but was not because UBIFS was mounted read-only. The information
4161e51764aSArtem Bityutskiy  * is used to clean the LEB when remounting to read-write mode.
4171e51764aSArtem Bityutskiy  */
4181e51764aSArtem Bityutskiy struct ubifs_unclean_leb {
4191e51764aSArtem Bityutskiy 	struct list_head list;
4201e51764aSArtem Bityutskiy 	int lnum;
4211e51764aSArtem Bityutskiy 	int endpt;
4221e51764aSArtem Bityutskiy };
4231e51764aSArtem Bityutskiy 
4241e51764aSArtem Bityutskiy /*
4251e51764aSArtem Bityutskiy  * LEB properties flags.
4261e51764aSArtem Bityutskiy  *
4271e51764aSArtem Bityutskiy  * LPROPS_UNCAT: not categorized
4287078202eSArtem Bityutskiy  * LPROPS_DIRTY: dirty > free, dirty >= @c->dead_wm, not index
42921a60258SArtem Bityutskiy  * LPROPS_DIRTY_IDX: dirty + free > @c->min_idx_node_sze and index
4307078202eSArtem Bityutskiy  * LPROPS_FREE: free > 0, dirty < @c->dead_wm, not empty, not index
4311e51764aSArtem Bityutskiy  * LPROPS_HEAP_CNT: number of heaps used for storing categorized LEBs
4321e51764aSArtem Bityutskiy  * LPROPS_EMPTY: LEB is empty, not taken
4331e51764aSArtem Bityutskiy  * LPROPS_FREEABLE: free + dirty == leb_size, not index, not taken
4341e51764aSArtem Bityutskiy  * LPROPS_FRDI_IDX: free + dirty == leb_size and index, may be taken
4351e51764aSArtem Bityutskiy  * LPROPS_CAT_MASK: mask for the LEB categories above
4361e51764aSArtem Bityutskiy  * LPROPS_TAKEN: LEB was taken (this flag is not saved on the media)
4371e51764aSArtem Bityutskiy  * LPROPS_INDEX: LEB contains indexing nodes (this flag also exists on flash)
4381e51764aSArtem Bityutskiy  */
4391e51764aSArtem Bityutskiy enum {
4401e51764aSArtem Bityutskiy 	LPROPS_UNCAT     =  0,
4411e51764aSArtem Bityutskiy 	LPROPS_DIRTY     =  1,
4421e51764aSArtem Bityutskiy 	LPROPS_DIRTY_IDX =  2,
4431e51764aSArtem Bityutskiy 	LPROPS_FREE      =  3,
4441e51764aSArtem Bityutskiy 	LPROPS_HEAP_CNT  =  3,
4451e51764aSArtem Bityutskiy 	LPROPS_EMPTY     =  4,
4461e51764aSArtem Bityutskiy 	LPROPS_FREEABLE  =  5,
4471e51764aSArtem Bityutskiy 	LPROPS_FRDI_IDX  =  6,
4481e51764aSArtem Bityutskiy 	LPROPS_CAT_MASK  = 15,
4491e51764aSArtem Bityutskiy 	LPROPS_TAKEN     = 16,
4501e51764aSArtem Bityutskiy 	LPROPS_INDEX     = 32,
4511e51764aSArtem Bityutskiy };
4521e51764aSArtem Bityutskiy 
4531e51764aSArtem Bityutskiy /**
4541e51764aSArtem Bityutskiy  * struct ubifs_lprops - logical eraseblock properties.
4551e51764aSArtem Bityutskiy  * @free: amount of free space in bytes
4561e51764aSArtem Bityutskiy  * @dirty: amount of dirty space in bytes
4571e51764aSArtem Bityutskiy  * @flags: LEB properties flags (see above)
4581e51764aSArtem Bityutskiy  * @lnum: LEB number
4591e51764aSArtem Bityutskiy  * @list: list of same-category lprops (for LPROPS_EMPTY and LPROPS_FREEABLE)
4601e51764aSArtem Bityutskiy  * @hpos: heap position in heap of same-category lprops (other categories)
4611e51764aSArtem Bityutskiy  */
4621e51764aSArtem Bityutskiy struct ubifs_lprops {
4631e51764aSArtem Bityutskiy 	int free;
4641e51764aSArtem Bityutskiy 	int dirty;
4651e51764aSArtem Bityutskiy 	int flags;
4661e51764aSArtem Bityutskiy 	int lnum;
4671e51764aSArtem Bityutskiy 	union {
4681e51764aSArtem Bityutskiy 		struct list_head list;
4691e51764aSArtem Bityutskiy 		int hpos;
4701e51764aSArtem Bityutskiy 	};
4711e51764aSArtem Bityutskiy };
4721e51764aSArtem Bityutskiy 
4731e51764aSArtem Bityutskiy /**
4741e51764aSArtem Bityutskiy  * struct ubifs_lpt_lprops - LPT logical eraseblock properties.
4751e51764aSArtem Bityutskiy  * @free: amount of free space in bytes
4761e51764aSArtem Bityutskiy  * @dirty: amount of dirty space in bytes
4771e51764aSArtem Bityutskiy  * @tgc: trivial GC flag (1 => unmap after commit end)
4781e51764aSArtem Bityutskiy  * @cmt: commit flag (1 => reserved for commit)
4791e51764aSArtem Bityutskiy  */
4801e51764aSArtem Bityutskiy struct ubifs_lpt_lprops {
4811e51764aSArtem Bityutskiy 	int free;
4821e51764aSArtem Bityutskiy 	int dirty;
4831e51764aSArtem Bityutskiy 	unsigned tgc:1;
4841e51764aSArtem Bityutskiy 	unsigned cmt:1;
4851e51764aSArtem Bityutskiy };
4861e51764aSArtem Bityutskiy 
4871e51764aSArtem Bityutskiy /**
4881e51764aSArtem Bityutskiy  * struct ubifs_lp_stats - statistics of eraseblocks in the main area.
4891e51764aSArtem Bityutskiy  * @empty_lebs: number of empty LEBs
4901e51764aSArtem Bityutskiy  * @taken_empty_lebs: number of taken LEBs
4911e51764aSArtem Bityutskiy  * @idx_lebs: number of indexing LEBs
492d3cf502bSArtem Bityutskiy  * @total_free: total free space in bytes (includes all LEBs)
493d3cf502bSArtem Bityutskiy  * @total_dirty: total dirty space in bytes (includes all LEBs)
494d3cf502bSArtem Bityutskiy  * @total_used: total used space in bytes (does not include index LEBs)
495d3cf502bSArtem Bityutskiy  * @total_dead: total dead space in bytes (does not include index LEBs)
496d3cf502bSArtem Bityutskiy  * @total_dark: total dark space in bytes (does not include index LEBs)
4971e51764aSArtem Bityutskiy  *
498d3cf502bSArtem Bityutskiy  * The @taken_empty_lebs field counts the LEBs that are in the transient state
499d3cf502bSArtem Bityutskiy  * of having been "taken" for use but not yet written to. @taken_empty_lebs is
500d3cf502bSArtem Bityutskiy  * needed to account correctly for @gc_lnum, otherwise @empty_lebs could be
501d3cf502bSArtem Bityutskiy  * used by itself (in which case 'unused_lebs' would be a better name). In the
502d3cf502bSArtem Bityutskiy  * case of @gc_lnum, it is "taken" at mount time or whenever a LEB is retained
503d3cf502bSArtem Bityutskiy  * by GC, but unlike other empty LEBs that are "taken", it may not be written
504d3cf502bSArtem Bityutskiy  * straight away (i.e. before the next commit start or unmount), so either
505d3cf502bSArtem Bityutskiy  * @gc_lnum must be specially accounted for, or the current approach followed
506d3cf502bSArtem Bityutskiy  * i.e. count it under @taken_empty_lebs.
5071e51764aSArtem Bityutskiy  *
508d3cf502bSArtem Bityutskiy  * @empty_lebs includes @taken_empty_lebs.
509d3cf502bSArtem Bityutskiy  *
510d3cf502bSArtem Bityutskiy  * @total_used, @total_dead and @total_dark fields do not account indexing
511d3cf502bSArtem Bityutskiy  * LEBs.
5121e51764aSArtem Bityutskiy  */
5131e51764aSArtem Bityutskiy struct ubifs_lp_stats {
5141e51764aSArtem Bityutskiy 	int empty_lebs;
5151e51764aSArtem Bityutskiy 	int taken_empty_lebs;
5161e51764aSArtem Bityutskiy 	int idx_lebs;
5171e51764aSArtem Bityutskiy 	long long total_free;
5181e51764aSArtem Bityutskiy 	long long total_dirty;
5191e51764aSArtem Bityutskiy 	long long total_used;
5201e51764aSArtem Bityutskiy 	long long total_dead;
5211e51764aSArtem Bityutskiy 	long long total_dark;
5221e51764aSArtem Bityutskiy };
5231e51764aSArtem Bityutskiy 
5241e51764aSArtem Bityutskiy struct ubifs_nnode;
5251e51764aSArtem Bityutskiy 
5261e51764aSArtem Bityutskiy /**
5271e51764aSArtem Bityutskiy  * struct ubifs_cnode - LEB Properties Tree common node.
5281e51764aSArtem Bityutskiy  * @parent: parent nnode
5291e51764aSArtem Bityutskiy  * @cnext: next cnode to commit
5301e51764aSArtem Bityutskiy  * @flags: flags (%DIRTY_LPT_NODE or %OBSOLETE_LPT_NODE)
5311e51764aSArtem Bityutskiy  * @iip: index in parent
5321e51764aSArtem Bityutskiy  * @level: level in the tree (zero for pnodes, greater than zero for nnodes)
5331e51764aSArtem Bityutskiy  * @num: node number
5341e51764aSArtem Bityutskiy  */
5351e51764aSArtem Bityutskiy struct ubifs_cnode {
5361e51764aSArtem Bityutskiy 	struct ubifs_nnode *parent;
5371e51764aSArtem Bityutskiy 	struct ubifs_cnode *cnext;
5381e51764aSArtem Bityutskiy 	unsigned long flags;
5391e51764aSArtem Bityutskiy 	int iip;
5401e51764aSArtem Bityutskiy 	int level;
5411e51764aSArtem Bityutskiy 	int num;
5421e51764aSArtem Bityutskiy };
5431e51764aSArtem Bityutskiy 
5441e51764aSArtem Bityutskiy /**
5451e51764aSArtem Bityutskiy  * struct ubifs_pnode - LEB Properties Tree leaf node.
5461e51764aSArtem Bityutskiy  * @parent: parent nnode
5471e51764aSArtem Bityutskiy  * @cnext: next cnode to commit
5481e51764aSArtem Bityutskiy  * @flags: flags (%DIRTY_LPT_NODE or %OBSOLETE_LPT_NODE)
5491e51764aSArtem Bityutskiy  * @iip: index in parent
5501e51764aSArtem Bityutskiy  * @level: level in the tree (always zero for pnodes)
5511e51764aSArtem Bityutskiy  * @num: node number
5521e51764aSArtem Bityutskiy  * @lprops: LEB properties array
5531e51764aSArtem Bityutskiy  */
5541e51764aSArtem Bityutskiy struct ubifs_pnode {
5551e51764aSArtem Bityutskiy 	struct ubifs_nnode *parent;
5561e51764aSArtem Bityutskiy 	struct ubifs_cnode *cnext;
5571e51764aSArtem Bityutskiy 	unsigned long flags;
5581e51764aSArtem Bityutskiy 	int iip;
5591e51764aSArtem Bityutskiy 	int level;
5601e51764aSArtem Bityutskiy 	int num;
5611e51764aSArtem Bityutskiy 	struct ubifs_lprops lprops[UBIFS_LPT_FANOUT];
5621e51764aSArtem Bityutskiy };
5631e51764aSArtem Bityutskiy 
5641e51764aSArtem Bityutskiy /**
5651e51764aSArtem Bityutskiy  * struct ubifs_nbranch - LEB Properties Tree internal node branch.
5661e51764aSArtem Bityutskiy  * @lnum: LEB number of child
5671e51764aSArtem Bityutskiy  * @offs: offset of child
5681e51764aSArtem Bityutskiy  * @nnode: nnode child
5691e51764aSArtem Bityutskiy  * @pnode: pnode child
5701e51764aSArtem Bityutskiy  * @cnode: cnode child
5711e51764aSArtem Bityutskiy  */
5721e51764aSArtem Bityutskiy struct ubifs_nbranch {
5731e51764aSArtem Bityutskiy 	int lnum;
5741e51764aSArtem Bityutskiy 	int offs;
5751e51764aSArtem Bityutskiy 	union {
5761e51764aSArtem Bityutskiy 		struct ubifs_nnode *nnode;
5771e51764aSArtem Bityutskiy 		struct ubifs_pnode *pnode;
5781e51764aSArtem Bityutskiy 		struct ubifs_cnode *cnode;
5791e51764aSArtem Bityutskiy 	};
5801e51764aSArtem Bityutskiy };
5811e51764aSArtem Bityutskiy 
5821e51764aSArtem Bityutskiy /**
5831e51764aSArtem Bityutskiy  * struct ubifs_nnode - LEB Properties Tree internal node.
5841e51764aSArtem Bityutskiy  * @parent: parent nnode
5851e51764aSArtem Bityutskiy  * @cnext: next cnode to commit
5861e51764aSArtem Bityutskiy  * @flags: flags (%DIRTY_LPT_NODE or %OBSOLETE_LPT_NODE)
5871e51764aSArtem Bityutskiy  * @iip: index in parent
5881e51764aSArtem Bityutskiy  * @level: level in the tree (always greater than zero for nnodes)
5891e51764aSArtem Bityutskiy  * @num: node number
5901e51764aSArtem Bityutskiy  * @nbranch: branches to child nodes
5911e51764aSArtem Bityutskiy  */
5921e51764aSArtem Bityutskiy struct ubifs_nnode {
5931e51764aSArtem Bityutskiy 	struct ubifs_nnode *parent;
5941e51764aSArtem Bityutskiy 	struct ubifs_cnode *cnext;
5951e51764aSArtem Bityutskiy 	unsigned long flags;
5961e51764aSArtem Bityutskiy 	int iip;
5971e51764aSArtem Bityutskiy 	int level;
5981e51764aSArtem Bityutskiy 	int num;
5991e51764aSArtem Bityutskiy 	struct ubifs_nbranch nbranch[UBIFS_LPT_FANOUT];
6001e51764aSArtem Bityutskiy };
6011e51764aSArtem Bityutskiy 
6021e51764aSArtem Bityutskiy /**
6031e51764aSArtem Bityutskiy  * struct ubifs_lpt_heap - heap of categorized lprops.
6041e51764aSArtem Bityutskiy  * @arr: heap array
6051e51764aSArtem Bityutskiy  * @cnt: number in heap
6061e51764aSArtem Bityutskiy  * @max_cnt: maximum number allowed in heap
6071e51764aSArtem Bityutskiy  *
6081e51764aSArtem Bityutskiy  * There are %LPROPS_HEAP_CNT heaps.
6091e51764aSArtem Bityutskiy  */
6101e51764aSArtem Bityutskiy struct ubifs_lpt_heap {
6111e51764aSArtem Bityutskiy 	struct ubifs_lprops **arr;
6121e51764aSArtem Bityutskiy 	int cnt;
6131e51764aSArtem Bityutskiy 	int max_cnt;
6141e51764aSArtem Bityutskiy };
6151e51764aSArtem Bityutskiy 
6161e51764aSArtem Bityutskiy /*
6171e51764aSArtem Bityutskiy  * Return codes for LPT scan callback function.
6181e51764aSArtem Bityutskiy  *
6191e51764aSArtem Bityutskiy  * LPT_SCAN_CONTINUE: continue scanning
6201e51764aSArtem Bityutskiy  * LPT_SCAN_ADD: add the LEB properties scanned to the tree in memory
6211e51764aSArtem Bityutskiy  * LPT_SCAN_STOP: stop scanning
6221e51764aSArtem Bityutskiy  */
6231e51764aSArtem Bityutskiy enum {
6241e51764aSArtem Bityutskiy 	LPT_SCAN_CONTINUE = 0,
6251e51764aSArtem Bityutskiy 	LPT_SCAN_ADD = 1,
6261e51764aSArtem Bityutskiy 	LPT_SCAN_STOP = 2,
6271e51764aSArtem Bityutskiy };
6281e51764aSArtem Bityutskiy 
6291e51764aSArtem Bityutskiy struct ubifs_info;
6301e51764aSArtem Bityutskiy 
6311e51764aSArtem Bityutskiy /* Callback used by the 'ubifs_lpt_scan_nolock()' function */
6321e51764aSArtem Bityutskiy typedef int (*ubifs_lpt_scan_callback)(struct ubifs_info *c,
6331e51764aSArtem Bityutskiy 				       const struct ubifs_lprops *lprops,
6341e51764aSArtem Bityutskiy 				       int in_tree, void *data);
6351e51764aSArtem Bityutskiy 
6361e51764aSArtem Bityutskiy /**
6371e51764aSArtem Bityutskiy  * struct ubifs_wbuf - UBIFS write-buffer.
6381e51764aSArtem Bityutskiy  * @c: UBIFS file-system description object
6391e51764aSArtem Bityutskiy  * @buf: write-buffer (of min. flash I/O unit size)
6401e51764aSArtem Bityutskiy  * @lnum: logical eraseblock number the write-buffer points to
6411e51764aSArtem Bityutskiy  * @offs: write-buffer offset in this logical eraseblock
6421e51764aSArtem Bityutskiy  * @avail: number of bytes available in the write-buffer
6431e51764aSArtem Bityutskiy  * @used:  number of used bytes in the write-buffer
6443c89f396SArtem Bityutskiy  * @size: write-buffer size (in [@c->min_io_size, @c->max_write_size] range)
6451e51764aSArtem Bityutskiy  * @jhead: journal head the mutex belongs to (note, needed only to shut lockdep
6461e51764aSArtem Bityutskiy  *         up by 'mutex_lock_nested()).
6471e51764aSArtem Bityutskiy  * @sync_callback: write-buffer synchronization callback
6481e51764aSArtem Bityutskiy  * @io_mutex: serializes write-buffer I/O
6491e51764aSArtem Bityutskiy  * @lock: serializes @buf, @lnum, @offs, @avail, @used, @next_ino and @inodes
6501e51764aSArtem Bityutskiy  *        fields
6511e51764aSArtem Bityutskiy  * @timer: write-buffer timer
652681947d2SAdrian Hunter  * @no_timer: non-zero if this write-buffer does not have a timer
653681947d2SAdrian Hunter  * @need_sync: non-zero if the timer expired and the wbuf needs sync'ing
6541e51764aSArtem Bityutskiy  * @next_ino: points to the next position of the following inode number
6551e51764aSArtem Bityutskiy  * @inodes: stores the inode numbers of the nodes which are in wbuf
6561e51764aSArtem Bityutskiy  *
6571e51764aSArtem Bityutskiy  * The write-buffer synchronization callback is called when the write-buffer is
6581e51764aSArtem Bityutskiy  * synchronized in order to notify how much space was wasted due to
6591e51764aSArtem Bityutskiy  * write-buffer padding and how much free space is left in the LEB.
6601e51764aSArtem Bityutskiy  *
6611e51764aSArtem Bityutskiy  * Note: the fields @buf, @lnum, @offs, @avail and @used can be read under
6621e51764aSArtem Bityutskiy  * spin-lock or mutex because they are written under both mutex and spin-lock.
6631e51764aSArtem Bityutskiy  * @buf is appended to under mutex but overwritten under both mutex and
6641e51764aSArtem Bityutskiy  * spin-lock. Thus the data between @buf and @buf + @used can be read under
6651e51764aSArtem Bityutskiy  * spinlock.
6661e51764aSArtem Bityutskiy  */
6671e51764aSArtem Bityutskiy struct ubifs_wbuf {
6681e51764aSArtem Bityutskiy 	struct ubifs_info *c;
6691e51764aSArtem Bityutskiy 	void *buf;
6701e51764aSArtem Bityutskiy 	int lnum;
6711e51764aSArtem Bityutskiy 	int offs;
6721e51764aSArtem Bityutskiy 	int avail;
6731e51764aSArtem Bityutskiy 	int used;
6743c89f396SArtem Bityutskiy 	int size;
6751e51764aSArtem Bityutskiy 	int jhead;
6761e51764aSArtem Bityutskiy 	int (*sync_callback)(struct ubifs_info *c, int lnum, int free, int pad);
6771e51764aSArtem Bityutskiy 	struct mutex io_mutex;
6781e51764aSArtem Bityutskiy 	spinlock_t lock;
679f2c5dbd7SArtem Bityutskiy 	struct hrtimer timer;
6800b335b9dSArtem Bityutskiy 	unsigned int no_timer:1;
6810b335b9dSArtem Bityutskiy 	unsigned int need_sync:1;
6821e51764aSArtem Bityutskiy 	int next_ino;
6831e51764aSArtem Bityutskiy 	ino_t *inodes;
6841e51764aSArtem Bityutskiy };
6851e51764aSArtem Bityutskiy 
6861e51764aSArtem Bityutskiy /**
6871e51764aSArtem Bityutskiy  * struct ubifs_bud - bud logical eraseblock.
6881e51764aSArtem Bityutskiy  * @lnum: logical eraseblock number
6891e51764aSArtem Bityutskiy  * @start: where the (uncommitted) bud data starts
6901e51764aSArtem Bityutskiy  * @jhead: journal head number this bud belongs to
6911e51764aSArtem Bityutskiy  * @list: link in the list buds belonging to the same journal head
6921e51764aSArtem Bityutskiy  * @rb: link in the tree of all buds
6931e51764aSArtem Bityutskiy  */
6941e51764aSArtem Bityutskiy struct ubifs_bud {
6951e51764aSArtem Bityutskiy 	int lnum;
6961e51764aSArtem Bityutskiy 	int start;
6971e51764aSArtem Bityutskiy 	int jhead;
6981e51764aSArtem Bityutskiy 	struct list_head list;
6991e51764aSArtem Bityutskiy 	struct rb_node rb;
7001e51764aSArtem Bityutskiy };
7011e51764aSArtem Bityutskiy 
7021e51764aSArtem Bityutskiy /**
7031e51764aSArtem Bityutskiy  * struct ubifs_jhead - journal head.
7041e51764aSArtem Bityutskiy  * @wbuf: head's write-buffer
7051e51764aSArtem Bityutskiy  * @buds_list: list of bud LEBs belonging to this journal head
7061a0b0699SArtem Bityutskiy  * @grouped: non-zero if UBIFS groups nodes when writing to this journal head
7071e51764aSArtem Bityutskiy  *
7081e51764aSArtem Bityutskiy  * Note, the @buds list is protected by the @c->buds_lock.
7091e51764aSArtem Bityutskiy  */
7101e51764aSArtem Bityutskiy struct ubifs_jhead {
7111e51764aSArtem Bityutskiy 	struct ubifs_wbuf wbuf;
7121e51764aSArtem Bityutskiy 	struct list_head buds_list;
7131a0b0699SArtem Bityutskiy 	unsigned int grouped:1;
7141e51764aSArtem Bityutskiy };
7151e51764aSArtem Bityutskiy 
7161e51764aSArtem Bityutskiy /**
7171e51764aSArtem Bityutskiy  * struct ubifs_zbranch - key/coordinate/length branch stored in znodes.
7181e51764aSArtem Bityutskiy  * @key: key
7191e51764aSArtem Bityutskiy  * @znode: znode address in memory
720be61678bSArtem Bityutskiy  * @lnum: LEB number of the target node (indexing node or data node)
721be61678bSArtem Bityutskiy  * @offs: target node offset within @lnum
7221e51764aSArtem Bityutskiy  * @len: target node length
7231e51764aSArtem Bityutskiy  */
7241e51764aSArtem Bityutskiy struct ubifs_zbranch {
7251e51764aSArtem Bityutskiy 	union ubifs_key key;
7261e51764aSArtem Bityutskiy 	union {
7271e51764aSArtem Bityutskiy 		struct ubifs_znode *znode;
7281e51764aSArtem Bityutskiy 		void *leaf;
7291e51764aSArtem Bityutskiy 	};
7301e51764aSArtem Bityutskiy 	int lnum;
7311e51764aSArtem Bityutskiy 	int offs;
7321e51764aSArtem Bityutskiy 	int len;
7331e51764aSArtem Bityutskiy };
7341e51764aSArtem Bityutskiy 
7351e51764aSArtem Bityutskiy /**
7361e51764aSArtem Bityutskiy  * struct ubifs_znode - in-memory representation of an indexing node.
7371e51764aSArtem Bityutskiy  * @parent: parent znode or NULL if it is the root
7381e51764aSArtem Bityutskiy  * @cnext: next znode to commit
7391e51764aSArtem Bityutskiy  * @flags: znode flags (%DIRTY_ZNODE, %COW_ZNODE or %OBSOLETE_ZNODE)
7401e51764aSArtem Bityutskiy  * @time: last access time (seconds)
7411e51764aSArtem Bityutskiy  * @level: level of the entry in the TNC tree
7421e51764aSArtem Bityutskiy  * @child_cnt: count of child znodes
7431e51764aSArtem Bityutskiy  * @iip: index in parent's zbranch array
7441e51764aSArtem Bityutskiy  * @alt: lower bound of key range has altered i.e. child inserted at slot 0
7451e51764aSArtem Bityutskiy  * @lnum: LEB number of the corresponding indexing node
7461e51764aSArtem Bityutskiy  * @offs: offset of the corresponding indexing node
7471e51764aSArtem Bityutskiy  * @len: length  of the corresponding indexing node
7481e51764aSArtem Bityutskiy  * @zbranch: array of znode branches (@c->fanout elements)
749f70b7e52SArtem Bityutskiy  *
750f70b7e52SArtem Bityutskiy  * Note! The @lnum, @offs, and @len fields are not really needed - we have them
751f70b7e52SArtem Bityutskiy  * only for internal consistency check. They could be removed to save some RAM.
7521e51764aSArtem Bityutskiy  */
7531e51764aSArtem Bityutskiy struct ubifs_znode {
7541e51764aSArtem Bityutskiy 	struct ubifs_znode *parent;
7551e51764aSArtem Bityutskiy 	struct ubifs_znode *cnext;
7561e51764aSArtem Bityutskiy 	unsigned long flags;
7571e51764aSArtem Bityutskiy 	unsigned long time;
7581e51764aSArtem Bityutskiy 	int level;
7591e51764aSArtem Bityutskiy 	int child_cnt;
7601e51764aSArtem Bityutskiy 	int iip;
7611e51764aSArtem Bityutskiy 	int alt;
762f70b7e52SArtem Bityutskiy 	int lnum;
763f70b7e52SArtem Bityutskiy 	int offs;
764f70b7e52SArtem Bityutskiy 	int len;
7651e51764aSArtem Bityutskiy 	struct ubifs_zbranch zbranch[];
7661e51764aSArtem Bityutskiy };
7671e51764aSArtem Bityutskiy 
7681e51764aSArtem Bityutskiy /**
76939ce81ceSArtem Bityutskiy  * struct bu_info - bulk-read information.
7704793e7c5SAdrian Hunter  * @key: first data node key
7714793e7c5SAdrian Hunter  * @zbranch: zbranches of data nodes to bulk read
7724793e7c5SAdrian Hunter  * @buf: buffer to read into
7734793e7c5SAdrian Hunter  * @buf_len: buffer length
7744793e7c5SAdrian Hunter  * @gc_seq: GC sequence number to detect races with GC
7754793e7c5SAdrian Hunter  * @cnt: number of data nodes for bulk read
7764793e7c5SAdrian Hunter  * @blk_cnt: number of data blocks including holes
7774793e7c5SAdrian Hunter  * @oef: end of file reached
7784793e7c5SAdrian Hunter  */
7794793e7c5SAdrian Hunter struct bu_info {
7804793e7c5SAdrian Hunter 	union ubifs_key key;
7814793e7c5SAdrian Hunter 	struct ubifs_zbranch zbranch[UBIFS_MAX_BULK_READ];
7824793e7c5SAdrian Hunter 	void *buf;
7834793e7c5SAdrian Hunter 	int buf_len;
7844793e7c5SAdrian Hunter 	int gc_seq;
7854793e7c5SAdrian Hunter 	int cnt;
7864793e7c5SAdrian Hunter 	int blk_cnt;
7874793e7c5SAdrian Hunter 	int eof;
7884793e7c5SAdrian Hunter };
7894793e7c5SAdrian Hunter 
7904793e7c5SAdrian Hunter /**
7911e51764aSArtem Bityutskiy  * struct ubifs_node_range - node length range description data structure.
7921e51764aSArtem Bityutskiy  * @len: fixed node length
7931e51764aSArtem Bityutskiy  * @min_len: minimum possible node length
7941e51764aSArtem Bityutskiy  * @max_len: maximum possible node length
7951e51764aSArtem Bityutskiy  *
7961e51764aSArtem Bityutskiy  * If @max_len is %0, the node has fixed length @len.
7971e51764aSArtem Bityutskiy  */
7981e51764aSArtem Bityutskiy struct ubifs_node_range {
7991e51764aSArtem Bityutskiy 	union {
8001e51764aSArtem Bityutskiy 		int len;
8011e51764aSArtem Bityutskiy 		int min_len;
8021e51764aSArtem Bityutskiy 	};
8031e51764aSArtem Bityutskiy 	int max_len;
8041e51764aSArtem Bityutskiy };
8051e51764aSArtem Bityutskiy 
8061e51764aSArtem Bityutskiy /**
8071e51764aSArtem Bityutskiy  * struct ubifs_compressor - UBIFS compressor description structure.
8081e51764aSArtem Bityutskiy  * @compr_type: compressor type (%UBIFS_COMPR_LZO, etc)
8091e51764aSArtem Bityutskiy  * @cc: cryptoapi compressor handle
8101e51764aSArtem Bityutskiy  * @comp_mutex: mutex used during compression
8111e51764aSArtem Bityutskiy  * @decomp_mutex: mutex used during decompression
8121e51764aSArtem Bityutskiy  * @name: compressor name
8131e51764aSArtem Bityutskiy  * @capi_name: cryptoapi compressor name
8141e51764aSArtem Bityutskiy  */
8151e51764aSArtem Bityutskiy struct ubifs_compressor {
8161e51764aSArtem Bityutskiy 	int compr_type;
8171e51764aSArtem Bityutskiy 	struct crypto_comp *cc;
8181e51764aSArtem Bityutskiy 	struct mutex *comp_mutex;
8191e51764aSArtem Bityutskiy 	struct mutex *decomp_mutex;
8201e51764aSArtem Bityutskiy 	const char *name;
8211e51764aSArtem Bityutskiy 	const char *capi_name;
8221e51764aSArtem Bityutskiy };
8231e51764aSArtem Bityutskiy 
8241e51764aSArtem Bityutskiy /**
8251e51764aSArtem Bityutskiy  * struct ubifs_budget_req - budget requirements of an operation.
8261e51764aSArtem Bityutskiy  *
827de94eb55SArtem Bityutskiy  * @fast: non-zero if the budgeting should try to acquire budget quickly and
8281e51764aSArtem Bityutskiy  *        should not try to call write-back
8291e51764aSArtem Bityutskiy  * @recalculate: non-zero if @idx_growth, @data_growth, and @dd_growth fields
8301e51764aSArtem Bityutskiy  *               have to be re-calculated
8311e51764aSArtem Bityutskiy  * @new_page: non-zero if the operation adds a new page
8321e51764aSArtem Bityutskiy  * @dirtied_page: non-zero if the operation makes a page dirty
8331e51764aSArtem Bityutskiy  * @new_dent: non-zero if the operation adds a new directory entry
8341e51764aSArtem Bityutskiy  * @mod_dent: non-zero if the operation removes or modifies an existing
8351e51764aSArtem Bityutskiy  *            directory entry
8361e51764aSArtem Bityutskiy  * @new_ino: non-zero if the operation adds a new inode
8377d25b361SDongsheng Yang  * @new_ino_d: how much data newly created inode contains
8381e51764aSArtem Bityutskiy  * @dirtied_ino: how many inodes the operation makes dirty
8397d25b361SDongsheng Yang  * @dirtied_ino_d: how much data dirtied inode contains
8401e51764aSArtem Bityutskiy  * @idx_growth: how much the index will supposedly grow
8411e51764aSArtem Bityutskiy  * @data_growth: how much new data the operation will supposedly add
8421e51764aSArtem Bityutskiy  * @dd_growth: how much data that makes other data dirty the operation will
8431e51764aSArtem Bityutskiy  *             supposedly add
8441e51764aSArtem Bityutskiy  *
8451e51764aSArtem Bityutskiy  * @idx_growth, @data_growth and @dd_growth are not used in budget request. The
8461e51764aSArtem Bityutskiy  * budgeting subsystem caches index and data growth values there to avoid
8471e51764aSArtem Bityutskiy  * re-calculating them when the budget is released. However, if @idx_growth is
8481e51764aSArtem Bityutskiy  * %-1, it is calculated by the release function using other fields.
8491e51764aSArtem Bityutskiy  *
8501e51764aSArtem Bityutskiy  * An inode may contain 4KiB of data at max., thus the widths of @new_ino_d
8511e51764aSArtem Bityutskiy  * is 13 bits, and @dirtied_ino_d - 15, because up to 4 inodes may be made
8521e51764aSArtem Bityutskiy  * dirty by the re-name operation.
853dab4b4d2SArtem Bityutskiy  *
854dab4b4d2SArtem Bityutskiy  * Note, UBIFS aligns node lengths to 8-bytes boundary, so the requester has to
855dab4b4d2SArtem Bityutskiy  * make sure the amount of inode data which contribute to @new_ino_d and
856dab4b4d2SArtem Bityutskiy  * @dirtied_ino_d fields are aligned.
8571e51764aSArtem Bityutskiy  */
8581e51764aSArtem Bityutskiy struct ubifs_budget_req {
8591e51764aSArtem Bityutskiy 	unsigned int fast:1;
8601e51764aSArtem Bityutskiy 	unsigned int recalculate:1;
861547000daSArtem Bityutskiy #ifndef UBIFS_DEBUG
8621e51764aSArtem Bityutskiy 	unsigned int new_page:1;
8631e51764aSArtem Bityutskiy 	unsigned int dirtied_page:1;
8641e51764aSArtem Bityutskiy 	unsigned int new_dent:1;
8651e51764aSArtem Bityutskiy 	unsigned int mod_dent:1;
8661e51764aSArtem Bityutskiy 	unsigned int new_ino:1;
8671e51764aSArtem Bityutskiy 	unsigned int new_ino_d:13;
8681e51764aSArtem Bityutskiy 	unsigned int dirtied_ino:4;
8691e51764aSArtem Bityutskiy 	unsigned int dirtied_ino_d:15;
8701e51764aSArtem Bityutskiy #else
8711e51764aSArtem Bityutskiy 	/* Not bit-fields to check for overflows */
872547000daSArtem Bityutskiy 	unsigned int new_page;
873547000daSArtem Bityutskiy 	unsigned int dirtied_page;
874547000daSArtem Bityutskiy 	unsigned int new_dent;
875547000daSArtem Bityutskiy 	unsigned int mod_dent;
876547000daSArtem Bityutskiy 	unsigned int new_ino;
877547000daSArtem Bityutskiy 	unsigned int new_ino_d;
8781e51764aSArtem Bityutskiy 	unsigned int dirtied_ino;
8791e51764aSArtem Bityutskiy 	unsigned int dirtied_ino_d;
8801e51764aSArtem Bityutskiy #endif
8811e51764aSArtem Bityutskiy 	int idx_growth;
8821e51764aSArtem Bityutskiy 	int data_growth;
8831e51764aSArtem Bityutskiy 	int dd_growth;
8841e51764aSArtem Bityutskiy };
8851e51764aSArtem Bityutskiy 
8861e51764aSArtem Bityutskiy /**
8871e51764aSArtem Bityutskiy  * struct ubifs_orphan - stores the inode number of an orphan.
8881e51764aSArtem Bityutskiy  * @rb: rb-tree node of rb-tree of orphans sorted by inode number
8891e51764aSArtem Bityutskiy  * @list: list head of list of orphans in order added
8901e51764aSArtem Bityutskiy  * @new_list: list head of list of orphans added since the last commit
8911e51764aSArtem Bityutskiy  * @cnext: next orphan to commit
8921e51764aSArtem Bityutskiy  * @dnext: next orphan to delete
8931e51764aSArtem Bityutskiy  * @inum: inode number
8941e51764aSArtem Bityutskiy  * @new: %1 => added since the last commit, otherwise %0
8952928f0d0SAdam Thomas  * @cmt: %1 => commit pending, otherwise %0
8968afd500cSAdam Thomas  * @del: %1 => delete pending, otherwise %0
8971e51764aSArtem Bityutskiy  */
8981e51764aSArtem Bityutskiy struct ubifs_orphan {
8991e51764aSArtem Bityutskiy 	struct rb_node rb;
9001e51764aSArtem Bityutskiy 	struct list_head list;
9011e51764aSArtem Bityutskiy 	struct list_head new_list;
9021e51764aSArtem Bityutskiy 	struct ubifs_orphan *cnext;
9031e51764aSArtem Bityutskiy 	struct ubifs_orphan *dnext;
9041e51764aSArtem Bityutskiy 	ino_t inum;
9052928f0d0SAdam Thomas 	unsigned new:1;
9062928f0d0SAdam Thomas 	unsigned cmt:1;
9078afd500cSAdam Thomas 	unsigned del:1;
9081e51764aSArtem Bityutskiy };
9091e51764aSArtem Bityutskiy 
9101e51764aSArtem Bityutskiy /**
9111e51764aSArtem Bityutskiy  * struct ubifs_mount_opts - UBIFS-specific mount options information.
9121e51764aSArtem Bityutskiy  * @unmount_mode: selected unmount mode (%0 default, %1 normal, %2 fast)
913d3f9db00SYannick Guerrini  * @bulk_read: enable/disable bulk-reads (%0 default, %1 disable, %2 enable)
914553dea4dSArtem Bityutskiy  * @chk_data_crc: enable/disable CRC data checking when reading data nodes
915d3f9db00SYannick Guerrini  *                (%0 default, %1 disable, %2 enable)
916553dea4dSArtem Bityutskiy  * @override_compr: override default compressor (%0 - do not override and use
917553dea4dSArtem Bityutskiy  *                  superblock compressor, %1 - override and use compressor
918553dea4dSArtem Bityutskiy  *                  specified in @compr_type)
919553dea4dSArtem Bityutskiy  * @compr_type: compressor type to override the superblock compressor with
920553dea4dSArtem Bityutskiy  *              (%UBIFS_COMPR_NONE, etc)
9211e51764aSArtem Bityutskiy  */
9221e51764aSArtem Bityutskiy struct ubifs_mount_opts {
9231e51764aSArtem Bityutskiy 	unsigned int unmount_mode:2;
9244793e7c5SAdrian Hunter 	unsigned int bulk_read:2;
9252953e73fSAdrian Hunter 	unsigned int chk_data_crc:2;
926553dea4dSArtem Bityutskiy 	unsigned int override_compr:1;
927553dea4dSArtem Bityutskiy 	unsigned int compr_type:2;
9281e51764aSArtem Bityutskiy };
9291e51764aSArtem Bityutskiy 
930b137545cSArtem Bityutskiy /**
931b137545cSArtem Bityutskiy  * struct ubifs_budg_info - UBIFS budgeting information.
932b137545cSArtem Bityutskiy  * @idx_growth: amount of bytes budgeted for index growth
933b137545cSArtem Bityutskiy  * @data_growth: amount of bytes budgeted for cached data
934b137545cSArtem Bityutskiy  * @dd_growth: amount of bytes budgeted for cached data that will make
935b137545cSArtem Bityutskiy  *             other data dirty
936b137545cSArtem Bityutskiy  * @uncommitted_idx: amount of bytes were budgeted for growth of the index, but
937b137545cSArtem Bityutskiy  *                   which still have to be taken into account because the index
938b137545cSArtem Bityutskiy  *                   has not been committed so far
939b137545cSArtem Bityutskiy  * @old_idx_sz: size of index on flash
940b137545cSArtem Bityutskiy  * @min_idx_lebs: minimum number of LEBs required for the index
941b137545cSArtem Bityutskiy  * @nospace: non-zero if the file-system does not have flash space (used as
942b137545cSArtem Bityutskiy  *           optimization)
943b137545cSArtem Bityutskiy  * @nospace_rp: the same as @nospace, but additionally means that even reserved
944b137545cSArtem Bityutskiy  *              pool is full
945d3f9db00SYannick Guerrini  * @page_budget: budget for a page (constant, never changed after mount)
946d3f9db00SYannick Guerrini  * @inode_budget: budget for an inode (constant, never changed after mount)
947d3f9db00SYannick Guerrini  * @dent_budget: budget for a directory entry (constant, never changed after
948b137545cSArtem Bityutskiy  *               mount)
949b137545cSArtem Bityutskiy  */
950b137545cSArtem Bityutskiy struct ubifs_budg_info {
951b137545cSArtem Bityutskiy 	long long idx_growth;
952b137545cSArtem Bityutskiy 	long long data_growth;
953b137545cSArtem Bityutskiy 	long long dd_growth;
954b137545cSArtem Bityutskiy 	long long uncommitted_idx;
955b137545cSArtem Bityutskiy 	unsigned long long old_idx_sz;
956b137545cSArtem Bityutskiy 	int min_idx_lebs;
957b137545cSArtem Bityutskiy 	unsigned int nospace:1;
958b137545cSArtem Bityutskiy 	unsigned int nospace_rp:1;
959b137545cSArtem Bityutskiy 	int page_budget;
960b137545cSArtem Bityutskiy 	int inode_budget;
961b137545cSArtem Bityutskiy 	int dent_budget;
962b137545cSArtem Bityutskiy };
963b137545cSArtem Bityutskiy 
96417c2f9f8SArtem Bityutskiy struct ubifs_debug_info;
96517c2f9f8SArtem Bityutskiy 
9661e51764aSArtem Bityutskiy /**
9671e51764aSArtem Bityutskiy  * struct ubifs_info - UBIFS file-system description data structure
9681e51764aSArtem Bityutskiy  * (per-superblock).
9691e51764aSArtem Bityutskiy  * @vfs_sb: VFS @struct super_block object
970de94eb55SArtem Bityutskiy  * @bdi: backing device info object to make VFS happy and disable read-ahead
9711e51764aSArtem Bityutskiy  *
9721e51764aSArtem Bityutskiy  * @highest_inum: highest used inode number
9731e51764aSArtem Bityutskiy  * @max_sqnum: current global sequence number
974014eb04bSArtem Bityutskiy  * @cmt_no: commit number of the last successfully completed commit, protected
975014eb04bSArtem Bityutskiy  *          by @commit_sem
97681ffa38eSAdrian Hunter  * @cnt_lock: protects @highest_inum and @max_sqnum counters
9771e51764aSArtem Bityutskiy  * @fmt_version: UBIFS on-flash format version
978963f0cf6SArtem Bityutskiy  * @ro_compat_version: R/O compatibility version
9791e51764aSArtem Bityutskiy  * @uuid: UUID from super block
9801e51764aSArtem Bityutskiy  *
9811e51764aSArtem Bityutskiy  * @lhead_lnum: log head logical eraseblock number
9821e51764aSArtem Bityutskiy  * @lhead_offs: log head offset
9831e51764aSArtem Bityutskiy  * @ltail_lnum: log tail logical eraseblock number (offset is always 0)
9841e51764aSArtem Bityutskiy  * @log_mutex: protects the log, @lhead_lnum, @lhead_offs, @ltail_lnum, and
9851e51764aSArtem Bityutskiy  *             @bud_bytes
9861e51764aSArtem Bityutskiy  * @min_log_bytes: minimum required number of bytes in the log
9871e51764aSArtem Bityutskiy  * @cmt_bud_bytes: used during commit to temporarily amount of bytes in
9881e51764aSArtem Bityutskiy  *                 committed buds
9891e51764aSArtem Bityutskiy  *
9901e51764aSArtem Bityutskiy  * @buds: tree of all buds indexed by bud LEB number
9911e51764aSArtem Bityutskiy  * @bud_bytes: how many bytes of flash is used by buds
9921e51764aSArtem Bityutskiy  * @buds_lock: protects the @buds tree, @bud_bytes, and per-journal head bud
9931e51764aSArtem Bityutskiy  *             lists
9941e51764aSArtem Bityutskiy  * @jhead_cnt: count of journal heads
9951e51764aSArtem Bityutskiy  * @jheads: journal heads (head zero is base head)
9961e51764aSArtem Bityutskiy  * @max_bud_bytes: maximum number of bytes allowed in buds
9971e51764aSArtem Bityutskiy  * @bg_bud_bytes: number of bud bytes when background commit is initiated
9981e51764aSArtem Bityutskiy  * @old_buds: buds to be released after commit ends
9991e51764aSArtem Bityutskiy  * @max_bud_cnt: maximum number of buds
10001e51764aSArtem Bityutskiy  *
10011e51764aSArtem Bityutskiy  * @commit_sem: synchronizes committer with other processes
10021e51764aSArtem Bityutskiy  * @cmt_state: commit state
10031e51764aSArtem Bityutskiy  * @cs_lock: commit state lock
10041e51764aSArtem Bityutskiy  * @cmt_wq: wait queue to sleep on if the log is full and a commit is running
1005625bf371SArtem Bityutskiy  *
10061e51764aSArtem Bityutskiy  * @big_lpt: flag that LPT is too big to write whole during commit
10079f58d350SMatthew L. Creech  * @space_fixup: flag indicating that free space in LEBs needs to be cleaned up
1008625bf371SArtem Bityutskiy  * @no_chk_data_crc: do not check CRCs when reading data nodes (except during
1009625bf371SArtem Bityutskiy  *                   recovery)
1010625bf371SArtem Bityutskiy  * @bulk_read: enable bulk-reads
1011a1dc080cSArtem Bityutskiy  * @default_compr: default compression algorithm (%UBIFS_COMPR_LZO, etc)
1012963f0cf6SArtem Bityutskiy  * @rw_incompat: the media is not R/W compatible
10131e51764aSArtem Bityutskiy  *
10141e51764aSArtem Bityutskiy  * @tnc_mutex: protects the Tree Node Cache (TNC), @zroot, @cnext, @enext, and
10151e51764aSArtem Bityutskiy  *             @calc_idx_sz
10161e51764aSArtem Bityutskiy  * @zroot: zbranch which points to the root index node and znode
10171e51764aSArtem Bityutskiy  * @cnext: next znode to commit
10181e51764aSArtem Bityutskiy  * @enext: next znode to commit to empty space
10191e51764aSArtem Bityutskiy  * @gap_lebs: array of LEBs used by the in-gaps commit method
10201e51764aSArtem Bityutskiy  * @cbuf: commit buffer
10211e51764aSArtem Bityutskiy  * @ileb_buf: buffer for commit in-the-gaps method
10221e51764aSArtem Bityutskiy  * @ileb_len: length of data in ileb_buf
10231e51764aSArtem Bityutskiy  * @ihead_lnum: LEB number of index head
10241e51764aSArtem Bityutskiy  * @ihead_offs: offset of index head
10251e51764aSArtem Bityutskiy  * @ilebs: pre-allocated index LEBs
10261e51764aSArtem Bityutskiy  * @ileb_cnt: number of pre-allocated index LEBs
10271e51764aSArtem Bityutskiy  * @ileb_nxt: next pre-allocated index LEBs
10281e51764aSArtem Bityutskiy  * @old_idx: tree of index nodes obsoleted since the last commit start
10291e51764aSArtem Bityutskiy  * @bottom_up_buf: a buffer which is used by 'dirty_cow_bottom_up()' in tnc.c
10301e51764aSArtem Bityutskiy  *
10311e51764aSArtem Bityutskiy  * @mst_node: master node
10321e51764aSArtem Bityutskiy  * @mst_offs: offset of valid master node
10333477d204SArtem Bityutskiy  *
10346c0c42cdSArtem Bityutskiy  * @max_bu_buf_len: maximum bulk-read buffer length
10353477d204SArtem Bityutskiy  * @bu_mutex: protects the pre-allocated bulk-read buffer and @c->bu
10363477d204SArtem Bityutskiy  * @bu: pre-allocated bulk-read information
10371e51764aSArtem Bityutskiy  *
1038d882962fSMatthew L. Creech  * @write_reserve_mutex: protects @write_reserve_buf
1039d882962fSMatthew L. Creech  * @write_reserve_buf: on the write path we allocate memory, which might
1040d882962fSMatthew L. Creech  *                     sometimes be unavailable, in which case we use this
1041d882962fSMatthew L. Creech  *                     write reserve buffer
1042d882962fSMatthew L. Creech  *
10431e51764aSArtem Bityutskiy  * @log_lebs: number of logical eraseblocks in the log
10441e51764aSArtem Bityutskiy  * @log_bytes: log size in bytes
10451e51764aSArtem Bityutskiy  * @log_last: last LEB of the log
10461e51764aSArtem Bityutskiy  * @lpt_lebs: number of LEBs used for lprops table
10471e51764aSArtem Bityutskiy  * @lpt_first: first LEB of the lprops table area
10481e51764aSArtem Bityutskiy  * @lpt_last: last LEB of the lprops table area
10491e51764aSArtem Bityutskiy  * @orph_lebs: number of LEBs used for the orphan area
10501e51764aSArtem Bityutskiy  * @orph_first: first LEB of the orphan area
10511e51764aSArtem Bityutskiy  * @orph_last: last LEB of the orphan area
10521e51764aSArtem Bityutskiy  * @main_lebs: count of LEBs in the main area
10531e51764aSArtem Bityutskiy  * @main_first: first LEB of the main area
10541e51764aSArtem Bityutskiy  * @main_bytes: main area size in bytes
10551e51764aSArtem Bityutskiy  *
10561e51764aSArtem Bityutskiy  * @key_hash_type: type of the key hash
10571e51764aSArtem Bityutskiy  * @key_hash: direntry key hash function
10581e51764aSArtem Bityutskiy  * @key_fmt: key format
10591e51764aSArtem Bityutskiy  * @key_len: key length
10601e51764aSArtem Bityutskiy  * @fanout: fanout of the index tree (number of links per indexing node)
10611e51764aSArtem Bityutskiy  *
10621e51764aSArtem Bityutskiy  * @min_io_size: minimal input/output unit size
10631e51764aSArtem Bityutskiy  * @min_io_shift: number of bits in @min_io_size minus one
10643e8e2e0cSArtem Bityutskiy  * @max_write_size: maximum amount of bytes the underlying flash can write at a
10653e8e2e0cSArtem Bityutskiy  *                  time (MTD write buffer size)
10663e8e2e0cSArtem Bityutskiy  * @max_write_shift: number of bits in @max_write_size minus one
10671e51764aSArtem Bityutskiy  * @leb_size: logical eraseblock size in bytes
1068ca2ec61dSArtem Bityutskiy  * @leb_start: starting offset of logical eraseblocks within physical
1069ca2ec61dSArtem Bityutskiy  *             eraseblocks
10701e51764aSArtem Bityutskiy  * @half_leb_size: half LEB size
1071fb1cd01aSArtem Bityutskiy  * @idx_leb_size: how many bytes of an LEB are effectively available when it is
1072fb1cd01aSArtem Bityutskiy  *                used to store indexing nodes (@leb_size - @max_idx_node_sz)
10731e51764aSArtem Bityutskiy  * @leb_cnt: count of logical eraseblocks
10741e51764aSArtem Bityutskiy  * @max_leb_cnt: maximum count of logical eraseblocks
10751e51764aSArtem Bityutskiy  * @old_leb_cnt: count of logical eraseblocks before re-size
10761e51764aSArtem Bityutskiy  * @ro_media: the underlying UBI volume is read-only
10772ef13294SArtem Bityutskiy  * @ro_mount: the file-system was mounted as read-only
10782680d722SArtem Bityutskiy  * @ro_error: UBIFS switched to R/O mode because an error happened
10791e51764aSArtem Bityutskiy  *
10801e51764aSArtem Bityutskiy  * @dirty_pg_cnt: number of dirty pages (not used)
10811e51764aSArtem Bityutskiy  * @dirty_zn_cnt: number of dirty znodes
10821e51764aSArtem Bityutskiy  * @clean_zn_cnt: number of clean znodes
10831e51764aSArtem Bityutskiy  *
1084b137545cSArtem Bityutskiy  * @space_lock: protects @bi and @lst
1085b137545cSArtem Bityutskiy  * @lst: lprops statistics
1086b137545cSArtem Bityutskiy  * @bi: budgeting information
10871e51764aSArtem Bityutskiy  * @calc_idx_sz: temporary variable which is used to calculate new index size
10881e51764aSArtem Bityutskiy  *               (contains accurate new index size at end of TNC commit start)
10891e51764aSArtem Bityutskiy  *
10901e51764aSArtem Bityutskiy  * @ref_node_alsz: size of the LEB reference node aligned to the min. flash
10911e51764aSArtem Bityutskiy  *                 I/O unit
10921e51764aSArtem Bityutskiy  * @mst_node_alsz: master node aligned size
10931e51764aSArtem Bityutskiy  * @min_idx_node_sz: minimum indexing node aligned on 8-bytes boundary
10941e51764aSArtem Bityutskiy  * @max_idx_node_sz: maximum indexing node aligned on 8-bytes boundary
10951e51764aSArtem Bityutskiy  * @max_inode_sz: maximum possible inode size in bytes
10961e51764aSArtem Bityutskiy  * @max_znode_sz: size of znode in bytes
10979bbb5726SArtem Bityutskiy  *
10989bbb5726SArtem Bityutskiy  * @leb_overhead: how many bytes are wasted in an LEB when it is filled with
10999bbb5726SArtem Bityutskiy  *                data nodes of maximum size - used in free space reporting
11001e51764aSArtem Bityutskiy  * @dead_wm: LEB dead space watermark
11011e51764aSArtem Bityutskiy  * @dark_wm: LEB dark space watermark
11021e51764aSArtem Bityutskiy  * @block_cnt: count of 4KiB blocks on the FS
11031e51764aSArtem Bityutskiy  *
11041e51764aSArtem Bityutskiy  * @ranges: UBIFS node length ranges
11051e51764aSArtem Bityutskiy  * @ubi: UBI volume descriptor
11061e51764aSArtem Bityutskiy  * @di: UBI device information
11071e51764aSArtem Bityutskiy  * @vi: UBI volume information
11081e51764aSArtem Bityutskiy  *
11091e51764aSArtem Bityutskiy  * @orph_tree: rb-tree of orphan inode numbers
11101e51764aSArtem Bityutskiy  * @orph_list: list of orphan inode numbers in order added
11111e51764aSArtem Bityutskiy  * @orph_new: list of orphan inode numbers added since last commit
11121e51764aSArtem Bityutskiy  * @orph_cnext: next orphan to commit
11131e51764aSArtem Bityutskiy  * @orph_dnext: next orphan to delete
11141e51764aSArtem Bityutskiy  * @orphan_lock: lock for orph_tree and orph_new
11151e51764aSArtem Bityutskiy  * @orph_buf: buffer for orphan nodes
11161e51764aSArtem Bityutskiy  * @new_orphans: number of orphans since last commit
11171e51764aSArtem Bityutskiy  * @cmt_orphans: number of orphans being committed
11181e51764aSArtem Bityutskiy  * @tot_orphans: number of orphans in the rb_tree
11191e51764aSArtem Bityutskiy  * @max_orphans: maximum number of orphans allowed
11201e51764aSArtem Bityutskiy  * @ohead_lnum: orphan head LEB number
11211e51764aSArtem Bityutskiy  * @ohead_offs: orphan head offset
11221e51764aSArtem Bityutskiy  * @no_orphs: non-zero if there are no orphans
11231e51764aSArtem Bityutskiy  *
11241e51764aSArtem Bityutskiy  * @bgt: UBIFS background thread
11251e51764aSArtem Bityutskiy  * @bgt_name: background thread name
11261e51764aSArtem Bityutskiy  * @need_bgt: if background thread should run
11271e51764aSArtem Bityutskiy  * @need_wbuf_sync: if write-buffers have to be synchronized
11281e51764aSArtem Bityutskiy  *
11291e51764aSArtem Bityutskiy  * @gc_lnum: LEB number used for garbage collection
11301e51764aSArtem Bityutskiy  * @sbuf: a buffer of LEB size used by GC and replay for scanning
11311e51764aSArtem Bityutskiy  * @idx_gc: list of index LEBs that have been garbage collected
11321e51764aSArtem Bityutskiy  * @idx_gc_cnt: number of elements on the idx_gc list
1133601c0bc4SAdrian Hunter  * @gc_seq: incremented for every non-index LEB garbage collected
1134601c0bc4SAdrian Hunter  * @gced_lnum: last non-index LEB that was garbage collected
11351e51764aSArtem Bityutskiy  *
11361e51764aSArtem Bityutskiy  * @infos_list: links all 'ubifs_info' objects
11371e51764aSArtem Bityutskiy  * @umount_mutex: serializes shrinker and un-mount
11381e51764aSArtem Bityutskiy  * @shrinker_run_no: shrinker run number
11391e51764aSArtem Bityutskiy  *
11401e51764aSArtem Bityutskiy  * @space_bits: number of bits needed to record free or dirty space
11411e51764aSArtem Bityutskiy  * @lpt_lnum_bits: number of bits needed to record a LEB number in the LPT
11421e51764aSArtem Bityutskiy  * @lpt_offs_bits: number of bits needed to record an offset in the LPT
11431e51764aSArtem Bityutskiy  * @lpt_spc_bits: number of bits needed to space in the LPT
11441e51764aSArtem Bityutskiy  * @pcnt_bits: number of bits needed to record pnode or nnode number
11451e51764aSArtem Bityutskiy  * @lnum_bits: number of bits needed to record LEB number
11461e51764aSArtem Bityutskiy  * @nnode_sz: size of on-flash nnode
11471e51764aSArtem Bityutskiy  * @pnode_sz: size of on-flash pnode
11481e51764aSArtem Bityutskiy  * @ltab_sz: size of on-flash LPT lprops table
11491e51764aSArtem Bityutskiy  * @lsave_sz: size of on-flash LPT save table
11501e51764aSArtem Bityutskiy  * @pnode_cnt: number of pnodes
11511e51764aSArtem Bityutskiy  * @nnode_cnt: number of nnodes
11521e51764aSArtem Bityutskiy  * @lpt_hght: height of the LPT
11531e51764aSArtem Bityutskiy  * @pnodes_have: number of pnodes in memory
11541e51764aSArtem Bityutskiy  *
11551e51764aSArtem Bityutskiy  * @lp_mutex: protects lprops table and all the other lprops-related fields
11561e51764aSArtem Bityutskiy  * @lpt_lnum: LEB number of the root nnode of the LPT
11571e51764aSArtem Bityutskiy  * @lpt_offs: offset of the root nnode of the LPT
11581e51764aSArtem Bityutskiy  * @nhead_lnum: LEB number of LPT head
11591e51764aSArtem Bityutskiy  * @nhead_offs: offset of LPT head
11601e51764aSArtem Bityutskiy  * @lpt_drty_flgs: dirty flags for LPT special nodes e.g. ltab
11611e51764aSArtem Bityutskiy  * @dirty_nn_cnt: number of dirty nnodes
11621e51764aSArtem Bityutskiy  * @dirty_pn_cnt: number of dirty pnodes
116373944a6dSAdrian Hunter  * @check_lpt_free: flag that indicates LPT GC may be needed
11641e51764aSArtem Bityutskiy  * @lpt_sz: LPT size
11651e51764aSArtem Bityutskiy  * @lpt_nod_buf: buffer for an on-flash nnode or pnode
11661e51764aSArtem Bityutskiy  * @lpt_buf: buffer of LEB size used by LPT
11671e51764aSArtem Bityutskiy  * @nroot: address in memory of the root nnode of the LPT
11681e51764aSArtem Bityutskiy  * @lpt_cnext: next LPT node to commit
11691e51764aSArtem Bityutskiy  * @lpt_heap: array of heaps of categorized lprops
11701e51764aSArtem Bityutskiy  * @dirty_idx: a (reverse sorted) copy of the LPROPS_DIRTY_IDX heap as at
11711e51764aSArtem Bityutskiy  *             previous commit start
11721e51764aSArtem Bityutskiy  * @uncat_list: list of un-categorized LEBs
11731e51764aSArtem Bityutskiy  * @empty_list: list of empty LEBs
1174fb1cd01aSArtem Bityutskiy  * @freeable_list: list of freeable non-index LEBs (free + dirty == @leb_size)
1175fb1cd01aSArtem Bityutskiy  * @frdi_idx_list: list of freeable index LEBs (free + dirty == @leb_size)
11761e51764aSArtem Bityutskiy  * @freeable_cnt: number of freeable LEBs in @freeable_list
117798a1eebdSArtem Bityutskiy  * @in_a_category_cnt: count of lprops which are in a certain category, which
117898a1eebdSArtem Bityutskiy  *                     basically meants that they were loaded from the flash
11791e51764aSArtem Bityutskiy  *
11801e51764aSArtem Bityutskiy  * @ltab_lnum: LEB number of LPT's own lprops table
11811e51764aSArtem Bityutskiy  * @ltab_offs: offset of LPT's own lprops table
11821e51764aSArtem Bityutskiy  * @ltab: LPT's own lprops table
11831e51764aSArtem Bityutskiy  * @ltab_cmt: LPT's own lprops table (commit copy)
11841e51764aSArtem Bityutskiy  * @lsave_cnt: number of LEB numbers in LPT's save table
11851e51764aSArtem Bityutskiy  * @lsave_lnum: LEB number of LPT's save table
11861e51764aSArtem Bityutskiy  * @lsave_offs: offset of LPT's save table
11871e51764aSArtem Bityutskiy  * @lsave: LPT's save table
11881e51764aSArtem Bityutskiy  * @lscan_lnum: LEB number of last LPT scan
11891e51764aSArtem Bityutskiy  *
11901e51764aSArtem Bityutskiy  * @rp_size: size of the reserved pool in bytes
11911e51764aSArtem Bityutskiy  * @report_rp_size: size of the reserved pool reported to user-space
11921e51764aSArtem Bityutskiy  * @rp_uid: reserved pool user ID
11931e51764aSArtem Bityutskiy  * @rp_gid: reserved pool group ID
11941e51764aSArtem Bityutskiy  *
1195d8cdda3eSArtem Bityutskiy  * @empty: %1 if the UBI device is empty
1196d8cdda3eSArtem Bityutskiy  * @need_recovery: %1 if the file-system needs recovery
1197d8cdda3eSArtem Bityutskiy  * @replaying: %1 during journal replay
119818d1d7fbSArtem Bityutskiy  * @mounting: %1 while mounting
119990bea5a3SDaniel Golle  * @probing: %1 while attempting to mount if MS_SILENT mount flag is set
1200d8cdda3eSArtem Bityutskiy  * @remounting_rw: %1 while re-mounting from R/O mode to R/W mode
12011e51764aSArtem Bityutskiy  * @replay_list: temporary list used during journal replay
12021e51764aSArtem Bityutskiy  * @replay_buds: list of buds to replay
12031e51764aSArtem Bityutskiy  * @cs_sqnum: sequence number of first node in the log (commit start node)
12041e51764aSArtem Bityutskiy  * @replay_sqnum: sequence number of node currently being replayed
12052ef13294SArtem Bityutskiy  * @unclean_leb_list: LEBs to recover when re-mounting R/O mounted FS to R/W
12062ef13294SArtem Bityutskiy  *                    mode
12072ef13294SArtem Bityutskiy  * @rcvrd_mst_node: recovered master node to write when re-mounting R/O mounted
12082ef13294SArtem Bityutskiy  *                  FS to R/W mode
12091e51764aSArtem Bityutskiy  * @size_tree: inode size information for recovery
12101e51764aSArtem Bityutskiy  * @mount_opts: UBIFS-specific mount options
12111e51764aSArtem Bityutskiy  *
121217c2f9f8SArtem Bityutskiy  * @dbg: debugging-related information
12131e51764aSArtem Bityutskiy  */
12141e51764aSArtem Bityutskiy struct ubifs_info {
12151e51764aSArtem Bityutskiy 	struct super_block *vfs_sb;
12161e51764aSArtem Bityutskiy 	struct backing_dev_info bdi;
12171e51764aSArtem Bityutskiy 
12181e51764aSArtem Bityutskiy 	ino_t highest_inum;
12191e51764aSArtem Bityutskiy 	unsigned long long max_sqnum;
12201e51764aSArtem Bityutskiy 	unsigned long long cmt_no;
12211e51764aSArtem Bityutskiy 	spinlock_t cnt_lock;
12221e51764aSArtem Bityutskiy 	int fmt_version;
1223963f0cf6SArtem Bityutskiy 	int ro_compat_version;
12241e51764aSArtem Bityutskiy 	unsigned char uuid[16];
12251e51764aSArtem Bityutskiy 
12261e51764aSArtem Bityutskiy 	int lhead_lnum;
12271e51764aSArtem Bityutskiy 	int lhead_offs;
12281e51764aSArtem Bityutskiy 	int ltail_lnum;
12291e51764aSArtem Bityutskiy 	struct mutex log_mutex;
12301e51764aSArtem Bityutskiy 	int min_log_bytes;
12311e51764aSArtem Bityutskiy 	long long cmt_bud_bytes;
12321e51764aSArtem Bityutskiy 
12331e51764aSArtem Bityutskiy 	struct rb_root buds;
12341e51764aSArtem Bityutskiy 	long long bud_bytes;
12351e51764aSArtem Bityutskiy 	spinlock_t buds_lock;
12361e51764aSArtem Bityutskiy 	int jhead_cnt;
12371e51764aSArtem Bityutskiy 	struct ubifs_jhead *jheads;
12381e51764aSArtem Bityutskiy 	long long max_bud_bytes;
12391e51764aSArtem Bityutskiy 	long long bg_bud_bytes;
12401e51764aSArtem Bityutskiy 	struct list_head old_buds;
12411e51764aSArtem Bityutskiy 	int max_bud_cnt;
12421e51764aSArtem Bityutskiy 
12431e51764aSArtem Bityutskiy 	struct rw_semaphore commit_sem;
12441e51764aSArtem Bityutskiy 	int cmt_state;
12451e51764aSArtem Bityutskiy 	spinlock_t cs_lock;
12461e51764aSArtem Bityutskiy 	wait_queue_head_t cmt_wq;
1247625bf371SArtem Bityutskiy 
12481e51764aSArtem Bityutskiy 	unsigned int big_lpt:1;
12499f58d350SMatthew L. Creech 	unsigned int space_fixup:1;
1250625bf371SArtem Bityutskiy 	unsigned int no_chk_data_crc:1;
1251625bf371SArtem Bityutskiy 	unsigned int bulk_read:1;
1252a1dc080cSArtem Bityutskiy 	unsigned int default_compr:2;
1253963f0cf6SArtem Bityutskiy 	unsigned int rw_incompat:1;
12541e51764aSArtem Bityutskiy 
12551e51764aSArtem Bityutskiy 	struct mutex tnc_mutex;
12561e51764aSArtem Bityutskiy 	struct ubifs_zbranch zroot;
12571e51764aSArtem Bityutskiy 	struct ubifs_znode *cnext;
12581e51764aSArtem Bityutskiy 	struct ubifs_znode *enext;
12591e51764aSArtem Bityutskiy 	int *gap_lebs;
12601e51764aSArtem Bityutskiy 	void *cbuf;
12611e51764aSArtem Bityutskiy 	void *ileb_buf;
12621e51764aSArtem Bityutskiy 	int ileb_len;
12631e51764aSArtem Bityutskiy 	int ihead_lnum;
12641e51764aSArtem Bityutskiy 	int ihead_offs;
12651e51764aSArtem Bityutskiy 	int *ilebs;
12661e51764aSArtem Bityutskiy 	int ileb_cnt;
12671e51764aSArtem Bityutskiy 	int ileb_nxt;
12681e51764aSArtem Bityutskiy 	struct rb_root old_idx;
12691e51764aSArtem Bityutskiy 	int *bottom_up_buf;
12701e51764aSArtem Bityutskiy 
12711e51764aSArtem Bityutskiy 	struct ubifs_mst_node *mst_node;
12721e51764aSArtem Bityutskiy 	int mst_offs;
12733477d204SArtem Bityutskiy 
12746c0c42cdSArtem Bityutskiy 	int max_bu_buf_len;
12753477d204SArtem Bityutskiy 	struct mutex bu_mutex;
12763477d204SArtem Bityutskiy 	struct bu_info bu;
12771e51764aSArtem Bityutskiy 
1278d882962fSMatthew L. Creech 	struct mutex write_reserve_mutex;
1279d882962fSMatthew L. Creech 	void *write_reserve_buf;
1280d882962fSMatthew L. Creech 
12811e51764aSArtem Bityutskiy 	int log_lebs;
12821e51764aSArtem Bityutskiy 	long long log_bytes;
12831e51764aSArtem Bityutskiy 	int log_last;
12841e51764aSArtem Bityutskiy 	int lpt_lebs;
12851e51764aSArtem Bityutskiy 	int lpt_first;
12861e51764aSArtem Bityutskiy 	int lpt_last;
12871e51764aSArtem Bityutskiy 	int orph_lebs;
12881e51764aSArtem Bityutskiy 	int orph_first;
12891e51764aSArtem Bityutskiy 	int orph_last;
12901e51764aSArtem Bityutskiy 	int main_lebs;
12911e51764aSArtem Bityutskiy 	int main_first;
12921e51764aSArtem Bityutskiy 	long long main_bytes;
12931e51764aSArtem Bityutskiy 
12941e51764aSArtem Bityutskiy 	uint8_t key_hash_type;
12951e51764aSArtem Bityutskiy 	uint32_t (*key_hash)(const char *str, int len);
12961e51764aSArtem Bityutskiy 	int key_fmt;
12971e51764aSArtem Bityutskiy 	int key_len;
12981e51764aSArtem Bityutskiy 	int fanout;
12991e51764aSArtem Bityutskiy 
13001e51764aSArtem Bityutskiy 	int min_io_size;
13011e51764aSArtem Bityutskiy 	int min_io_shift;
13023e8e2e0cSArtem Bityutskiy 	int max_write_size;
13033e8e2e0cSArtem Bityutskiy 	int max_write_shift;
13041e51764aSArtem Bityutskiy 	int leb_size;
1305ca2ec61dSArtem Bityutskiy 	int leb_start;
13061e51764aSArtem Bityutskiy 	int half_leb_size;
1307fb1cd01aSArtem Bityutskiy 	int idx_leb_size;
13081e51764aSArtem Bityutskiy 	int leb_cnt;
13091e51764aSArtem Bityutskiy 	int max_leb_cnt;
13101e51764aSArtem Bityutskiy 	int old_leb_cnt;
13112680d722SArtem Bityutskiy 	unsigned int ro_media:1;
13122ef13294SArtem Bityutskiy 	unsigned int ro_mount:1;
13132680d722SArtem Bityutskiy 	unsigned int ro_error:1;
13141e51764aSArtem Bityutskiy 
13151e51764aSArtem Bityutskiy 	atomic_long_t dirty_pg_cnt;
13161e51764aSArtem Bityutskiy 	atomic_long_t dirty_zn_cnt;
13171e51764aSArtem Bityutskiy 	atomic_long_t clean_zn_cnt;
13181e51764aSArtem Bityutskiy 
13191e51764aSArtem Bityutskiy 	spinlock_t space_lock;
13201e51764aSArtem Bityutskiy 	struct ubifs_lp_stats lst;
1321b137545cSArtem Bityutskiy 	struct ubifs_budg_info bi;
1322b137545cSArtem Bityutskiy 	unsigned long long calc_idx_sz;
13231e51764aSArtem Bityutskiy 
13241e51764aSArtem Bityutskiy 	int ref_node_alsz;
13251e51764aSArtem Bityutskiy 	int mst_node_alsz;
13261e51764aSArtem Bityutskiy 	int min_idx_node_sz;
13271e51764aSArtem Bityutskiy 	int max_idx_node_sz;
13281e51764aSArtem Bityutskiy 	long long max_inode_sz;
13291e51764aSArtem Bityutskiy 	int max_znode_sz;
13309bbb5726SArtem Bityutskiy 
13319bbb5726SArtem Bityutskiy 	int leb_overhead;
13321e51764aSArtem Bityutskiy 	int dead_wm;
13331e51764aSArtem Bityutskiy 	int dark_wm;
13341e51764aSArtem Bityutskiy 	int block_cnt;
13351e51764aSArtem Bityutskiy 
13361e51764aSArtem Bityutskiy 	struct ubifs_node_range ranges[UBIFS_NODE_TYPES_CNT];
13371e51764aSArtem Bityutskiy 	struct ubi_volume_desc *ubi;
13381e51764aSArtem Bityutskiy 	struct ubi_device_info di;
13391e51764aSArtem Bityutskiy 	struct ubi_volume_info vi;
13401e51764aSArtem Bityutskiy 
13411e51764aSArtem Bityutskiy 	struct rb_root orph_tree;
13421e51764aSArtem Bityutskiy 	struct list_head orph_list;
13431e51764aSArtem Bityutskiy 	struct list_head orph_new;
13441e51764aSArtem Bityutskiy 	struct ubifs_orphan *orph_cnext;
13451e51764aSArtem Bityutskiy 	struct ubifs_orphan *orph_dnext;
13461e51764aSArtem Bityutskiy 	spinlock_t orphan_lock;
13471e51764aSArtem Bityutskiy 	void *orph_buf;
13481e51764aSArtem Bityutskiy 	int new_orphans;
13491e51764aSArtem Bityutskiy 	int cmt_orphans;
13501e51764aSArtem Bityutskiy 	int tot_orphans;
13511e51764aSArtem Bityutskiy 	int max_orphans;
13521e51764aSArtem Bityutskiy 	int ohead_lnum;
13531e51764aSArtem Bityutskiy 	int ohead_offs;
13541e51764aSArtem Bityutskiy 	int no_orphs;
13551e51764aSArtem Bityutskiy 
13561e51764aSArtem Bityutskiy 	struct task_struct *bgt;
13571e51764aSArtem Bityutskiy 	char bgt_name[sizeof(BGT_NAME_PATTERN) + 9];
13581e51764aSArtem Bityutskiy 	int need_bgt;
13591e51764aSArtem Bityutskiy 	int need_wbuf_sync;
13601e51764aSArtem Bityutskiy 
13611e51764aSArtem Bityutskiy 	int gc_lnum;
13621e51764aSArtem Bityutskiy 	void *sbuf;
13631e51764aSArtem Bityutskiy 	struct list_head idx_gc;
13641e51764aSArtem Bityutskiy 	int idx_gc_cnt;
1365f92b9826SArtem Bityutskiy 	int gc_seq;
1366f92b9826SArtem Bityutskiy 	int gced_lnum;
13671e51764aSArtem Bityutskiy 
13681e51764aSArtem Bityutskiy 	struct list_head infos_list;
13691e51764aSArtem Bityutskiy 	struct mutex umount_mutex;
13701e51764aSArtem Bityutskiy 	unsigned int shrinker_run_no;
13711e51764aSArtem Bityutskiy 
13721e51764aSArtem Bityutskiy 	int space_bits;
13731e51764aSArtem Bityutskiy 	int lpt_lnum_bits;
13741e51764aSArtem Bityutskiy 	int lpt_offs_bits;
13751e51764aSArtem Bityutskiy 	int lpt_spc_bits;
13761e51764aSArtem Bityutskiy 	int pcnt_bits;
13771e51764aSArtem Bityutskiy 	int lnum_bits;
13781e51764aSArtem Bityutskiy 	int nnode_sz;
13791e51764aSArtem Bityutskiy 	int pnode_sz;
13801e51764aSArtem Bityutskiy 	int ltab_sz;
13811e51764aSArtem Bityutskiy 	int lsave_sz;
13821e51764aSArtem Bityutskiy 	int pnode_cnt;
13831e51764aSArtem Bityutskiy 	int nnode_cnt;
13841e51764aSArtem Bityutskiy 	int lpt_hght;
13851e51764aSArtem Bityutskiy 	int pnodes_have;
13861e51764aSArtem Bityutskiy 
13871e51764aSArtem Bityutskiy 	struct mutex lp_mutex;
13881e51764aSArtem Bityutskiy 	int lpt_lnum;
13891e51764aSArtem Bityutskiy 	int lpt_offs;
13901e51764aSArtem Bityutskiy 	int nhead_lnum;
13911e51764aSArtem Bityutskiy 	int nhead_offs;
13921e51764aSArtem Bityutskiy 	int lpt_drty_flgs;
13931e51764aSArtem Bityutskiy 	int dirty_nn_cnt;
13941e51764aSArtem Bityutskiy 	int dirty_pn_cnt;
139573944a6dSAdrian Hunter 	int check_lpt_free;
13961e51764aSArtem Bityutskiy 	long long lpt_sz;
13971e51764aSArtem Bityutskiy 	void *lpt_nod_buf;
13981e51764aSArtem Bityutskiy 	void *lpt_buf;
13991e51764aSArtem Bityutskiy 	struct ubifs_nnode *nroot;
14001e51764aSArtem Bityutskiy 	struct ubifs_cnode *lpt_cnext;
14011e51764aSArtem Bityutskiy 	struct ubifs_lpt_heap lpt_heap[LPROPS_HEAP_CNT];
14021e51764aSArtem Bityutskiy 	struct ubifs_lpt_heap dirty_idx;
14031e51764aSArtem Bityutskiy 	struct list_head uncat_list;
14041e51764aSArtem Bityutskiy 	struct list_head empty_list;
14051e51764aSArtem Bityutskiy 	struct list_head freeable_list;
14061e51764aSArtem Bityutskiy 	struct list_head frdi_idx_list;
14071e51764aSArtem Bityutskiy 	int freeable_cnt;
140898a1eebdSArtem Bityutskiy 	int in_a_category_cnt;
14091e51764aSArtem Bityutskiy 
14101e51764aSArtem Bityutskiy 	int ltab_lnum;
14111e51764aSArtem Bityutskiy 	int ltab_offs;
14121e51764aSArtem Bityutskiy 	struct ubifs_lpt_lprops *ltab;
14131e51764aSArtem Bityutskiy 	struct ubifs_lpt_lprops *ltab_cmt;
14141e51764aSArtem Bityutskiy 	int lsave_cnt;
14151e51764aSArtem Bityutskiy 	int lsave_lnum;
14161e51764aSArtem Bityutskiy 	int lsave_offs;
14171e51764aSArtem Bityutskiy 	int *lsave;
14181e51764aSArtem Bityutskiy 	int lscan_lnum;
14191e51764aSArtem Bityutskiy 
14201e51764aSArtem Bityutskiy 	long long rp_size;
14211e51764aSArtem Bityutskiy 	long long report_rp_size;
142239241bebSEric W. Biederman 	kuid_t rp_uid;
142339241bebSEric W. Biederman 	kgid_t rp_gid;
14241e51764aSArtem Bityutskiy 
14251e51764aSArtem Bityutskiy 	/* The below fields are used only during mounting and re-mounting */
1426d8cdda3eSArtem Bityutskiy 	unsigned int empty:1;
1427d8cdda3eSArtem Bityutskiy 	unsigned int need_recovery:1;
1428d8cdda3eSArtem Bityutskiy 	unsigned int replaying:1;
142918d1d7fbSArtem Bityutskiy 	unsigned int mounting:1;
1430d8cdda3eSArtem Bityutskiy 	unsigned int remounting_rw:1;
143190bea5a3SDaniel Golle 	unsigned int probing:1;
14321e51764aSArtem Bityutskiy 	struct list_head replay_list;
14331e51764aSArtem Bityutskiy 	struct list_head replay_buds;
14341e51764aSArtem Bityutskiy 	unsigned long long cs_sqnum;
14351e51764aSArtem Bityutskiy 	unsigned long long replay_sqnum;
14361e51764aSArtem Bityutskiy 	struct list_head unclean_leb_list;
14371e51764aSArtem Bityutskiy 	struct ubifs_mst_node *rcvrd_mst_node;
14381e51764aSArtem Bityutskiy 	struct rb_root size_tree;
14391e51764aSArtem Bityutskiy 	struct ubifs_mount_opts mount_opts;
14401e51764aSArtem Bityutskiy 
144117c2f9f8SArtem Bityutskiy 	struct ubifs_debug_info *dbg;
14421e51764aSArtem Bityutskiy };
14431e51764aSArtem Bityutskiy 
14441e51764aSArtem Bityutskiy extern struct list_head ubifs_infos;
14451e51764aSArtem Bityutskiy extern spinlock_t ubifs_infos_lock;
14461e51764aSArtem Bityutskiy extern atomic_long_t ubifs_clean_zn_cnt;
14471e51764aSArtem Bityutskiy extern struct kmem_cache *ubifs_inode_slab;
1448e8b81566SArtem Bityutskiy extern const struct super_operations ubifs_super_operations;
1449e8b81566SArtem Bityutskiy extern const struct address_space_operations ubifs_file_address_operations;
1450e8b81566SArtem Bityutskiy extern const struct file_operations ubifs_file_operations;
1451e8b81566SArtem Bityutskiy extern const struct inode_operations ubifs_file_inode_operations;
1452e8b81566SArtem Bityutskiy extern const struct file_operations ubifs_dir_operations;
1453e8b81566SArtem Bityutskiy extern const struct inode_operations ubifs_dir_inode_operations;
1454e8b81566SArtem Bityutskiy extern const struct inode_operations ubifs_symlink_inode_operations;
14551e51764aSArtem Bityutskiy extern struct backing_dev_info ubifs_backing_dev_info;
14561e51764aSArtem Bityutskiy extern struct ubifs_compressor *ubifs_compressors[UBIFS_COMPR_TYPES_CNT];
14571e51764aSArtem Bityutskiy 
14581e51764aSArtem Bityutskiy /* io.c */
1459ff46d7b3SAdrian Hunter void ubifs_ro_mode(struct ubifs_info *c, int err);
146083cef708SArtem Bityutskiy int ubifs_leb_read(const struct ubifs_info *c, int lnum, void *buf, int offs,
146183cef708SArtem Bityutskiy 		   int len, int even_ebadmsg);
146283cef708SArtem Bityutskiy int ubifs_leb_write(struct ubifs_info *c, int lnum, const void *buf, int offs,
1463b36a261eSRichard Weinberger 		    int len);
1464b36a261eSRichard Weinberger int ubifs_leb_change(struct ubifs_info *c, int lnum, const void *buf, int len);
146583cef708SArtem Bityutskiy int ubifs_leb_unmap(struct ubifs_info *c, int lnum);
1466b36a261eSRichard Weinberger int ubifs_leb_map(struct ubifs_info *c, int lnum);
146783cef708SArtem Bityutskiy int ubifs_is_mapped(const struct ubifs_info *c, int lnum);
14681e51764aSArtem Bityutskiy int ubifs_wbuf_write_nolock(struct ubifs_wbuf *wbuf, void *buf, int len);
1469b36a261eSRichard Weinberger int ubifs_wbuf_seek_nolock(struct ubifs_wbuf *wbuf, int lnum, int offs);
14701e51764aSArtem Bityutskiy int ubifs_wbuf_init(struct ubifs_info *c, struct ubifs_wbuf *wbuf);
14711e51764aSArtem Bityutskiy int ubifs_read_node(const struct ubifs_info *c, void *buf, int type, int len,
14721e51764aSArtem Bityutskiy 		    int lnum, int offs);
14731e51764aSArtem Bityutskiy int ubifs_read_node_wbuf(struct ubifs_wbuf *wbuf, void *buf, int type, int len,
14741e51764aSArtem Bityutskiy 			 int lnum, int offs);
14751e51764aSArtem Bityutskiy int ubifs_write_node(struct ubifs_info *c, void *node, int len, int lnum,
1476b36a261eSRichard Weinberger 		     int offs);
14771e51764aSArtem Bityutskiy int ubifs_check_node(const struct ubifs_info *c, const void *buf, int lnum,
14786f7ab6d4SArtem Bityutskiy 		     int offs, int quiet, int must_chk_crc);
14791e51764aSArtem Bityutskiy void ubifs_prepare_node(struct ubifs_info *c, void *buf, int len, int pad);
14801e51764aSArtem Bityutskiy void ubifs_prep_grp_node(struct ubifs_info *c, void *node, int len, int last);
14811e51764aSArtem Bityutskiy int ubifs_io_init(struct ubifs_info *c);
14821e51764aSArtem Bityutskiy void ubifs_pad(const struct ubifs_info *c, void *buf, int pad);
14831e51764aSArtem Bityutskiy int ubifs_wbuf_sync_nolock(struct ubifs_wbuf *wbuf);
14841e51764aSArtem Bityutskiy int ubifs_bg_wbufs_sync(struct ubifs_info *c);
14851e51764aSArtem Bityutskiy void ubifs_wbuf_add_ino_nolock(struct ubifs_wbuf *wbuf, ino_t inum);
14861e51764aSArtem Bityutskiy int ubifs_sync_wbufs_by_inode(struct ubifs_info *c, struct inode *inode);
14871e51764aSArtem Bityutskiy 
14881e51764aSArtem Bityutskiy /* scan.c */
14891e51764aSArtem Bityutskiy struct ubifs_scan_leb *ubifs_scan(const struct ubifs_info *c, int lnum,
1490348709baSArtem Bityutskiy 				  int offs, void *sbuf, int quiet);
14911e51764aSArtem Bityutskiy void ubifs_scan_destroy(struct ubifs_scan_leb *sleb);
14921e51764aSArtem Bityutskiy int ubifs_scan_a_node(const struct ubifs_info *c, void *buf, int len, int lnum,
14931e51764aSArtem Bityutskiy 		      int offs, int quiet);
14941e51764aSArtem Bityutskiy struct ubifs_scan_leb *ubifs_start_scan(const struct ubifs_info *c, int lnum,
14951e51764aSArtem Bityutskiy 					int offs, void *sbuf);
14961e51764aSArtem Bityutskiy void ubifs_end_scan(const struct ubifs_info *c, struct ubifs_scan_leb *sleb,
14971e51764aSArtem Bityutskiy 		    int lnum, int offs);
14981e51764aSArtem Bityutskiy int ubifs_add_snod(const struct ubifs_info *c, struct ubifs_scan_leb *sleb,
14991e51764aSArtem Bityutskiy 		   void *buf, int offs);
15001e51764aSArtem Bityutskiy void ubifs_scanned_corruption(const struct ubifs_info *c, int lnum, int offs,
15011e51764aSArtem Bityutskiy 			      void *buf);
15021e51764aSArtem Bityutskiy 
15031e51764aSArtem Bityutskiy /* log.c */
15041e51764aSArtem Bityutskiy void ubifs_add_bud(struct ubifs_info *c, struct ubifs_bud *bud);
15051e51764aSArtem Bityutskiy void ubifs_create_buds_lists(struct ubifs_info *c);
15061e51764aSArtem Bityutskiy int ubifs_add_bud_to_log(struct ubifs_info *c, int jhead, int lnum, int offs);
15071e51764aSArtem Bityutskiy struct ubifs_bud *ubifs_search_bud(struct ubifs_info *c, int lnum);
15081e51764aSArtem Bityutskiy struct ubifs_wbuf *ubifs_get_wbuf(struct ubifs_info *c, int lnum);
15091e51764aSArtem Bityutskiy int ubifs_log_start_commit(struct ubifs_info *c, int *ltail_lnum);
15101e51764aSArtem Bityutskiy int ubifs_log_end_commit(struct ubifs_info *c, int new_ltail_lnum);
15111e51764aSArtem Bityutskiy int ubifs_log_post_commit(struct ubifs_info *c, int old_ltail_lnum);
15121e51764aSArtem Bityutskiy int ubifs_consolidate_log(struct ubifs_info *c);
15131e51764aSArtem Bityutskiy 
15141e51764aSArtem Bityutskiy /* journal.c */
15151e51764aSArtem Bityutskiy int ubifs_jnl_update(struct ubifs_info *c, const struct inode *dir,
1516f4f61d2cSRichard Weinberger 		     const struct fscrypt_name *nm, const struct inode *inode,
15171e51764aSArtem Bityutskiy 		     int deletion, int xent);
15181e51764aSArtem Bityutskiy int ubifs_jnl_write_data(struct ubifs_info *c, const struct inode *inode,
15191e51764aSArtem Bityutskiy 			 const union ubifs_key *key, const void *buf, int len);
15201f28681aSArtem Bityutskiy int ubifs_jnl_write_inode(struct ubifs_info *c, const struct inode *inode);
1521de94eb55SArtem Bityutskiy int ubifs_jnl_delete_inode(struct ubifs_info *c, const struct inode *inode);
15229ec64962SRichard Weinberger int ubifs_jnl_xrename(struct ubifs_info *c, const struct inode *fst_dir,
1523f4f61d2cSRichard Weinberger 		      const struct inode *fst_inode,
1524f4f61d2cSRichard Weinberger 		      const struct fscrypt_name *fst_nm,
15259ec64962SRichard Weinberger 		      const struct inode *snd_dir,
1526f4f61d2cSRichard Weinberger 		      const struct inode *snd_inode,
1527f4f61d2cSRichard Weinberger 		      const struct fscrypt_name *snd_nm, int sync);
15281e51764aSArtem Bityutskiy int ubifs_jnl_rename(struct ubifs_info *c, const struct inode *old_dir,
1529f4f61d2cSRichard Weinberger 		     const struct inode *old_inode,
1530f4f61d2cSRichard Weinberger 		     const struct fscrypt_name *old_nm,
15311e51764aSArtem Bityutskiy 		     const struct inode *new_dir,
1532f4f61d2cSRichard Weinberger 		     const struct inode *new_inode,
1533f4f61d2cSRichard Weinberger 		     const struct fscrypt_name *new_nm,
15349e0a1fffSRichard Weinberger 		     const struct inode *whiteout, int sync);
15351e51764aSArtem Bityutskiy int ubifs_jnl_truncate(struct ubifs_info *c, const struct inode *inode,
15361e51764aSArtem Bityutskiy 		       loff_t old_size, loff_t new_size);
15371e51764aSArtem Bityutskiy int ubifs_jnl_delete_xattr(struct ubifs_info *c, const struct inode *host,
1538f4f61d2cSRichard Weinberger 			   const struct inode *inode, const struct fscrypt_name *nm);
15391e51764aSArtem Bityutskiy int ubifs_jnl_change_xattr(struct ubifs_info *c, const struct inode *inode1,
15401e51764aSArtem Bityutskiy 			   const struct inode *inode2);
15411e51764aSArtem Bityutskiy 
15421e51764aSArtem Bityutskiy /* budget.c */
15431e51764aSArtem Bityutskiy int ubifs_budget_space(struct ubifs_info *c, struct ubifs_budget_req *req);
15441e51764aSArtem Bityutskiy void ubifs_release_budget(struct ubifs_info *c, struct ubifs_budget_req *req);
15451e51764aSArtem Bityutskiy void ubifs_release_dirty_inode_budget(struct ubifs_info *c,
15461e51764aSArtem Bityutskiy 				      struct ubifs_inode *ui);
15471e51764aSArtem Bityutskiy int ubifs_budget_inode_op(struct ubifs_info *c, struct inode *inode,
15481e51764aSArtem Bityutskiy 			  struct ubifs_budget_req *req);
15491e51764aSArtem Bityutskiy void ubifs_release_ino_dirty(struct ubifs_info *c, struct inode *inode,
15501e51764aSArtem Bityutskiy 				struct ubifs_budget_req *req);
15511e51764aSArtem Bityutskiy void ubifs_cancel_ino_op(struct ubifs_info *c, struct inode *inode,
15521e51764aSArtem Bityutskiy 			 struct ubifs_budget_req *req);
15537dad181bSArtem Bityutskiy long long ubifs_get_free_space(struct ubifs_info *c);
155484abf972SArtem Bityutskiy long long ubifs_get_free_space_nolock(struct ubifs_info *c);
15551e51764aSArtem Bityutskiy int ubifs_calc_min_idx_lebs(struct ubifs_info *c);
15561e51764aSArtem Bityutskiy void ubifs_convert_page_budget(struct ubifs_info *c);
15574d61db4fSArtem Bityutskiy long long ubifs_reported_space(const struct ubifs_info *c, long long free);
15581e51764aSArtem Bityutskiy long long ubifs_calc_available(const struct ubifs_info *c, int min_idx_lebs);
15591e51764aSArtem Bityutskiy 
15601e51764aSArtem Bityutskiy /* find.c */
15613edaae7cSArtem Bityutskiy int ubifs_find_free_space(struct ubifs_info *c, int min_space, int *offs,
15621e51764aSArtem Bityutskiy 			  int squeeze);
15631e51764aSArtem Bityutskiy int ubifs_find_free_leb_for_idx(struct ubifs_info *c);
15641e51764aSArtem Bityutskiy int ubifs_find_dirty_leb(struct ubifs_info *c, struct ubifs_lprops *ret_lp,
15651e51764aSArtem Bityutskiy 			 int min_space, int pick_free);
15661e51764aSArtem Bityutskiy int ubifs_find_dirty_idx_leb(struct ubifs_info *c);
15671e51764aSArtem Bityutskiy int ubifs_save_dirty_idx_lnums(struct ubifs_info *c);
15681e51764aSArtem Bityutskiy 
15691e51764aSArtem Bityutskiy /* tnc.c */
15701e51764aSArtem Bityutskiy int ubifs_lookup_level0(struct ubifs_info *c, const union ubifs_key *key,
15711e51764aSArtem Bityutskiy 			struct ubifs_znode **zn, int *n);
15721e51764aSArtem Bityutskiy int ubifs_tnc_lookup_nm(struct ubifs_info *c, const union ubifs_key *key,
1573f4f61d2cSRichard Weinberger 			void *node, const struct fscrypt_name *nm);
1574528e3d17SRichard Weinberger int ubifs_tnc_lookup_dh(struct ubifs_info *c, const union ubifs_key *key,
1575528e3d17SRichard Weinberger 			void *node, uint32_t secondary_hash);
15761e51764aSArtem Bityutskiy int ubifs_tnc_locate(struct ubifs_info *c, const union ubifs_key *key,
15771e51764aSArtem Bityutskiy 		     void *node, int *lnum, int *offs);
15781e51764aSArtem Bityutskiy int ubifs_tnc_add(struct ubifs_info *c, const union ubifs_key *key, int lnum,
15791e51764aSArtem Bityutskiy 		  int offs, int len);
15801e51764aSArtem Bityutskiy int ubifs_tnc_replace(struct ubifs_info *c, const union ubifs_key *key,
15811e51764aSArtem Bityutskiy 		      int old_lnum, int old_offs, int lnum, int offs, int len);
15821e51764aSArtem Bityutskiy int ubifs_tnc_add_nm(struct ubifs_info *c, const union ubifs_key *key,
1583f4f61d2cSRichard Weinberger 		     int lnum, int offs, int len, const struct fscrypt_name *nm);
15841e51764aSArtem Bityutskiy int ubifs_tnc_remove(struct ubifs_info *c, const union ubifs_key *key);
15851e51764aSArtem Bityutskiy int ubifs_tnc_remove_nm(struct ubifs_info *c, const union ubifs_key *key,
1586f4f61d2cSRichard Weinberger 			const struct fscrypt_name *nm);
15871e51764aSArtem Bityutskiy int ubifs_tnc_remove_range(struct ubifs_info *c, union ubifs_key *from_key,
15881e51764aSArtem Bityutskiy 			   union ubifs_key *to_key);
15891e51764aSArtem Bityutskiy int ubifs_tnc_remove_ino(struct ubifs_info *c, ino_t inum);
15901e51764aSArtem Bityutskiy struct ubifs_dent_node *ubifs_tnc_next_ent(struct ubifs_info *c,
15911e51764aSArtem Bityutskiy 					   union ubifs_key *key,
1592f4f61d2cSRichard Weinberger 					   const struct fscrypt_name *nm);
15931e51764aSArtem Bityutskiy void ubifs_tnc_close(struct ubifs_info *c);
15941e51764aSArtem Bityutskiy int ubifs_tnc_has_node(struct ubifs_info *c, union ubifs_key *key, int level,
15951e51764aSArtem Bityutskiy 		       int lnum, int offs, int is_idx);
15961e51764aSArtem Bityutskiy int ubifs_dirty_idx_node(struct ubifs_info *c, union ubifs_key *key, int level,
15971e51764aSArtem Bityutskiy 			 int lnum, int offs);
15981e51764aSArtem Bityutskiy /* Shared by tnc.c for tnc_commit.c */
15991e51764aSArtem Bityutskiy void destroy_old_idx(struct ubifs_info *c);
16001e51764aSArtem Bityutskiy int is_idx_node_in_tnc(struct ubifs_info *c, union ubifs_key *key, int level,
16011e51764aSArtem Bityutskiy 		       int lnum, int offs);
16021e51764aSArtem Bityutskiy int insert_old_idx_znode(struct ubifs_info *c, struct ubifs_znode *znode);
16034793e7c5SAdrian Hunter int ubifs_tnc_get_bu_keys(struct ubifs_info *c, struct bu_info *bu);
16044793e7c5SAdrian Hunter int ubifs_tnc_bulk_read(struct ubifs_info *c, struct bu_info *bu);
16051e51764aSArtem Bityutskiy 
16061e51764aSArtem Bityutskiy /* tnc_misc.c */
16071e51764aSArtem Bityutskiy struct ubifs_znode *ubifs_tnc_levelorder_next(struct ubifs_znode *zr,
16081e51764aSArtem Bityutskiy 					      struct ubifs_znode *znode);
16091e51764aSArtem Bityutskiy int ubifs_search_zbranch(const struct ubifs_info *c,
16101e51764aSArtem Bityutskiy 			 const struct ubifs_znode *znode,
16111e51764aSArtem Bityutskiy 			 const union ubifs_key *key, int *n);
16121e51764aSArtem Bityutskiy struct ubifs_znode *ubifs_tnc_postorder_first(struct ubifs_znode *znode);
16131e51764aSArtem Bityutskiy struct ubifs_znode *ubifs_tnc_postorder_next(struct ubifs_znode *znode);
16141e51764aSArtem Bityutskiy long ubifs_destroy_tnc_subtree(struct ubifs_znode *zr);
16151e51764aSArtem Bityutskiy struct ubifs_znode *ubifs_load_znode(struct ubifs_info *c,
16161e51764aSArtem Bityutskiy 				     struct ubifs_zbranch *zbr,
16171e51764aSArtem Bityutskiy 				     struct ubifs_znode *parent, int iip);
16181e51764aSArtem Bityutskiy int ubifs_tnc_read_node(struct ubifs_info *c, struct ubifs_zbranch *zbr,
16191e51764aSArtem Bityutskiy 			void *node);
16201e51764aSArtem Bityutskiy 
16211e51764aSArtem Bityutskiy /* tnc_commit.c */
16221e51764aSArtem Bityutskiy int ubifs_tnc_start_commit(struct ubifs_info *c, struct ubifs_zbranch *zroot);
16231e51764aSArtem Bityutskiy int ubifs_tnc_end_commit(struct ubifs_info *c);
16241e51764aSArtem Bityutskiy 
16251e51764aSArtem Bityutskiy /* shrinker.c */
16261ab6c499SDave Chinner unsigned long ubifs_shrink_scan(struct shrinker *shrink,
16271ab6c499SDave Chinner 				struct shrink_control *sc);
16281ab6c499SDave Chinner unsigned long ubifs_shrink_count(struct shrinker *shrink,
16291ab6c499SDave Chinner 				 struct shrink_control *sc);
16301e51764aSArtem Bityutskiy 
16311e51764aSArtem Bityutskiy /* commit.c */
16321e51764aSArtem Bityutskiy int ubifs_bg_thread(void *info);
16331e51764aSArtem Bityutskiy void ubifs_commit_required(struct ubifs_info *c);
16341e51764aSArtem Bityutskiy void ubifs_request_bg_commit(struct ubifs_info *c);
16351e51764aSArtem Bityutskiy int ubifs_run_commit(struct ubifs_info *c);
16361e51764aSArtem Bityutskiy void ubifs_recovery_commit(struct ubifs_info *c);
16371e51764aSArtem Bityutskiy int ubifs_gc_should_commit(struct ubifs_info *c);
16381e51764aSArtem Bityutskiy void ubifs_wait_for_commit(struct ubifs_info *c);
16391e51764aSArtem Bityutskiy 
16401e51764aSArtem Bityutskiy /* master.c */
16411e51764aSArtem Bityutskiy int ubifs_read_master(struct ubifs_info *c);
16421e51764aSArtem Bityutskiy int ubifs_write_master(struct ubifs_info *c);
16431e51764aSArtem Bityutskiy 
16441e51764aSArtem Bityutskiy /* sb.c */
16451e51764aSArtem Bityutskiy int ubifs_read_superblock(struct ubifs_info *c);
16461e51764aSArtem Bityutskiy struct ubifs_sb_node *ubifs_read_sb_node(struct ubifs_info *c);
16471e51764aSArtem Bityutskiy int ubifs_write_sb_node(struct ubifs_info *c, struct ubifs_sb_node *sup);
16486554a657SMatthew L. Creech int ubifs_fixup_free_space(struct ubifs_info *c);
16491e51764aSArtem Bityutskiy 
16501e51764aSArtem Bityutskiy /* replay.c */
16511e51764aSArtem Bityutskiy int ubifs_validate_entry(struct ubifs_info *c,
16521e51764aSArtem Bityutskiy 			 const struct ubifs_dent_node *dent);
16531e51764aSArtem Bityutskiy int ubifs_replay_journal(struct ubifs_info *c);
16541e51764aSArtem Bityutskiy 
16551e51764aSArtem Bityutskiy /* gc.c */
16561e51764aSArtem Bityutskiy int ubifs_garbage_collect(struct ubifs_info *c, int anyway);
16571e51764aSArtem Bityutskiy int ubifs_gc_start_commit(struct ubifs_info *c);
16581e51764aSArtem Bityutskiy int ubifs_gc_end_commit(struct ubifs_info *c);
1659b466f17dSAdrian Hunter void ubifs_destroy_idx_gc(struct ubifs_info *c);
16601e51764aSArtem Bityutskiy int ubifs_get_idx_gc_leb(struct ubifs_info *c);
16611e51764aSArtem Bityutskiy int ubifs_garbage_collect_leb(struct ubifs_info *c, struct ubifs_lprops *lp);
16621e51764aSArtem Bityutskiy 
16631e51764aSArtem Bityutskiy /* orphan.c */
16641e51764aSArtem Bityutskiy int ubifs_add_orphan(struct ubifs_info *c, ino_t inum);
16651e51764aSArtem Bityutskiy void ubifs_delete_orphan(struct ubifs_info *c, ino_t inum);
16661e51764aSArtem Bityutskiy int ubifs_orphan_start_commit(struct ubifs_info *c);
16671e51764aSArtem Bityutskiy int ubifs_orphan_end_commit(struct ubifs_info *c);
16681e51764aSArtem Bityutskiy int ubifs_mount_orphans(struct ubifs_info *c, int unclean, int read_only);
166949d128aaSAdrian Hunter int ubifs_clear_orphans(struct ubifs_info *c);
16701e51764aSArtem Bityutskiy 
16711e51764aSArtem Bityutskiy /* lpt.c */
16721e51764aSArtem Bityutskiy int ubifs_calc_lpt_geom(struct ubifs_info *c);
16731e51764aSArtem Bityutskiy int ubifs_create_dflt_lpt(struct ubifs_info *c, int *main_lebs, int lpt_first,
16741e51764aSArtem Bityutskiy 			  int *lpt_lebs, int *big_lpt);
16751e51764aSArtem Bityutskiy int ubifs_lpt_init(struct ubifs_info *c, int rd, int wr);
16761e51764aSArtem Bityutskiy struct ubifs_lprops *ubifs_lpt_lookup(struct ubifs_info *c, int lnum);
16771e51764aSArtem Bityutskiy struct ubifs_lprops *ubifs_lpt_lookup_dirty(struct ubifs_info *c, int lnum);
16781e51764aSArtem Bityutskiy int ubifs_lpt_scan_nolock(struct ubifs_info *c, int start_lnum, int end_lnum,
16791e51764aSArtem Bityutskiy 			  ubifs_lpt_scan_callback scan_cb, void *data);
16801e51764aSArtem Bityutskiy 
16811e51764aSArtem Bityutskiy /* Shared by lpt.c for lpt_commit.c */
16821e51764aSArtem Bityutskiy void ubifs_pack_lsave(struct ubifs_info *c, void *buf, int *lsave);
16831e51764aSArtem Bityutskiy void ubifs_pack_ltab(struct ubifs_info *c, void *buf,
16841e51764aSArtem Bityutskiy 		     struct ubifs_lpt_lprops *ltab);
16851e51764aSArtem Bityutskiy void ubifs_pack_pnode(struct ubifs_info *c, void *buf,
16861e51764aSArtem Bityutskiy 		      struct ubifs_pnode *pnode);
16871e51764aSArtem Bityutskiy void ubifs_pack_nnode(struct ubifs_info *c, void *buf,
16881e51764aSArtem Bityutskiy 		      struct ubifs_nnode *nnode);
16891e51764aSArtem Bityutskiy struct ubifs_pnode *ubifs_get_pnode(struct ubifs_info *c,
16901e51764aSArtem Bityutskiy 				    struct ubifs_nnode *parent, int iip);
16911e51764aSArtem Bityutskiy struct ubifs_nnode *ubifs_get_nnode(struct ubifs_info *c,
16921e51764aSArtem Bityutskiy 				    struct ubifs_nnode *parent, int iip);
16931e51764aSArtem Bityutskiy int ubifs_read_nnode(struct ubifs_info *c, struct ubifs_nnode *parent, int iip);
16941e51764aSArtem Bityutskiy void ubifs_add_lpt_dirt(struct ubifs_info *c, int lnum, int dirty);
16951e51764aSArtem Bityutskiy void ubifs_add_nnode_dirt(struct ubifs_info *c, struct ubifs_nnode *nnode);
16961e51764aSArtem Bityutskiy uint32_t ubifs_unpack_bits(uint8_t **addr, int *pos, int nrbits);
16971e51764aSArtem Bityutskiy struct ubifs_nnode *ubifs_first_nnode(struct ubifs_info *c, int *hght);
16982ba5f7aeSArtem Bityutskiy /* Needed only in debugging code in lpt_commit.c */
16992ba5f7aeSArtem Bityutskiy int ubifs_unpack_nnode(const struct ubifs_info *c, void *buf,
17002ba5f7aeSArtem Bityutskiy 		       struct ubifs_nnode *nnode);
17011e51764aSArtem Bityutskiy 
17021e51764aSArtem Bityutskiy /* lpt_commit.c */
17031e51764aSArtem Bityutskiy int ubifs_lpt_start_commit(struct ubifs_info *c);
17041e51764aSArtem Bityutskiy int ubifs_lpt_end_commit(struct ubifs_info *c);
17051e51764aSArtem Bityutskiy int ubifs_lpt_post_commit(struct ubifs_info *c);
17061e51764aSArtem Bityutskiy void ubifs_lpt_free(struct ubifs_info *c, int wr_only);
17071e51764aSArtem Bityutskiy 
17081e51764aSArtem Bityutskiy /* lprops.c */
17091e51764aSArtem Bityutskiy const struct ubifs_lprops *ubifs_change_lp(struct ubifs_info *c,
17101e51764aSArtem Bityutskiy 					   const struct ubifs_lprops *lp,
17111e51764aSArtem Bityutskiy 					   int free, int dirty, int flags,
17121e51764aSArtem Bityutskiy 					   int idx_gc_cnt);
171384abf972SArtem Bityutskiy void ubifs_get_lp_stats(struct ubifs_info *c, struct ubifs_lp_stats *lst);
17141e51764aSArtem Bityutskiy void ubifs_add_to_cat(struct ubifs_info *c, struct ubifs_lprops *lprops,
17151e51764aSArtem Bityutskiy 		      int cat);
17161e51764aSArtem Bityutskiy void ubifs_replace_cat(struct ubifs_info *c, struct ubifs_lprops *old_lprops,
17171e51764aSArtem Bityutskiy 		       struct ubifs_lprops *new_lprops);
17181e51764aSArtem Bityutskiy void ubifs_ensure_cat(struct ubifs_info *c, struct ubifs_lprops *lprops);
17191e51764aSArtem Bityutskiy int ubifs_categorize_lprops(const struct ubifs_info *c,
17201e51764aSArtem Bityutskiy 			    const struct ubifs_lprops *lprops);
17211e51764aSArtem Bityutskiy int ubifs_change_one_lp(struct ubifs_info *c, int lnum, int free, int dirty,
17221e51764aSArtem Bityutskiy 			int flags_set, int flags_clean, int idx_gc_cnt);
17231e51764aSArtem Bityutskiy int ubifs_update_one_lp(struct ubifs_info *c, int lnum, int free, int dirty,
17241e51764aSArtem Bityutskiy 			int flags_set, int flags_clean);
17251e51764aSArtem Bityutskiy int ubifs_read_one_lp(struct ubifs_info *c, int lnum, struct ubifs_lprops *lp);
17261e51764aSArtem Bityutskiy const struct ubifs_lprops *ubifs_fast_find_free(struct ubifs_info *c);
17271e51764aSArtem Bityutskiy const struct ubifs_lprops *ubifs_fast_find_empty(struct ubifs_info *c);
17281e51764aSArtem Bityutskiy const struct ubifs_lprops *ubifs_fast_find_freeable(struct ubifs_info *c);
17291e51764aSArtem Bityutskiy const struct ubifs_lprops *ubifs_fast_find_frdi_idx(struct ubifs_info *c);
1730be9e62a7SArtem Bityutskiy int ubifs_calc_dark(const struct ubifs_info *c, int spc);
17311e51764aSArtem Bityutskiy 
17321e51764aSArtem Bityutskiy /* file.c */
173302c24a82SJosef Bacik int ubifs_fsync(struct file *file, loff_t start, loff_t end, int datasync);
17341e51764aSArtem Bityutskiy int ubifs_setattr(struct dentry *dentry, struct iattr *attr);
17358c1c5f26SDongsheng Yang #ifdef CONFIG_UBIFS_ATIME_SUPPORT
17368c1c5f26SDongsheng Yang int ubifs_update_time(struct inode *inode, struct timespec *time, int flags);
17378c1c5f26SDongsheng Yang #endif
17381e51764aSArtem Bityutskiy 
17391e51764aSArtem Bityutskiy /* dir.c */
1740d475a507SRichard Weinberger struct inode *ubifs_new_inode(struct ubifs_info *c, struct inode *dir,
1741ad44be5cSAl Viro 			      umode_t mode);
17421e51764aSArtem Bityutskiy int ubifs_getattr(struct vfsmount *mnt, struct dentry *dentry,
17431e51764aSArtem Bityutskiy 		  struct kstat *stat);
1744f6337d84SRichard Weinberger int ubifs_check_dir_empty(struct inode *dir);
17451e51764aSArtem Bityutskiy 
17461e51764aSArtem Bityutskiy /* xattr.c */
17472b88fc21SAndreas Gruenbacher extern const struct xattr_handler *ubifs_xattr_handlers[];
17481e51764aSArtem Bityutskiy ssize_t ubifs_listxattr(struct dentry *dentry, char *buffer, size_t size);
1749d7f0b70dSSubodh Nijsure int ubifs_init_security(struct inode *dentry, struct inode *inode,
1750d7f0b70dSSubodh Nijsure 			const struct qstr *qstr);
1751ade46c3aSRichard Weinberger int ubifs_xattr_set(struct inode *host, const char *name, const void *value,
1752ade46c3aSRichard Weinberger 		    size_t size, int flags);
1753ade46c3aSRichard Weinberger ssize_t ubifs_xattr_get(struct inode *host, const char *name, void *buf,
1754ade46c3aSRichard Weinberger 			size_t size);
17551e51764aSArtem Bityutskiy 
17561e51764aSArtem Bityutskiy /* super.c */
17571e51764aSArtem Bityutskiy struct inode *ubifs_iget(struct super_block *sb, unsigned long inum);
17581e51764aSArtem Bityutskiy 
17591e51764aSArtem Bityutskiy /* recovery.c */
17601e51764aSArtem Bityutskiy int ubifs_recover_master_node(struct ubifs_info *c);
17611e51764aSArtem Bityutskiy int ubifs_write_rcvrd_mst_node(struct ubifs_info *c);
17621e51764aSArtem Bityutskiy struct ubifs_scan_leb *ubifs_recover_leb(struct ubifs_info *c, int lnum,
1763efcfde54SArtem Bityutskiy 					 int offs, void *sbuf, int jhead);
17641e51764aSArtem Bityutskiy struct ubifs_scan_leb *ubifs_recover_log_leb(struct ubifs_info *c, int lnum,
17651e51764aSArtem Bityutskiy 					     int offs, void *sbuf);
176683cef708SArtem Bityutskiy int ubifs_recover_inl_heads(struct ubifs_info *c, void *sbuf);
176783cef708SArtem Bityutskiy int ubifs_clean_lebs(struct ubifs_info *c, void *sbuf);
17681e51764aSArtem Bityutskiy int ubifs_rcvry_gc_commit(struct ubifs_info *c);
17691e51764aSArtem Bityutskiy int ubifs_recover_size_accum(struct ubifs_info *c, union ubifs_key *key,
17701e51764aSArtem Bityutskiy 			     int deletion, loff_t new_size);
17711e51764aSArtem Bityutskiy int ubifs_recover_size(struct ubifs_info *c);
17721e51764aSArtem Bityutskiy void ubifs_destroy_size_tree(struct ubifs_info *c);
17731e51764aSArtem Bityutskiy 
17741e51764aSArtem Bityutskiy /* ioctl.c */
17751e51764aSArtem Bityutskiy long ubifs_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
17761e51764aSArtem Bityutskiy void ubifs_set_inode_flags(struct inode *inode);
17771e51764aSArtem Bityutskiy #ifdef CONFIG_COMPAT
17781e51764aSArtem Bityutskiy long ubifs_compat_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
17791e51764aSArtem Bityutskiy #endif
17801e51764aSArtem Bityutskiy 
17811e51764aSArtem Bityutskiy /* compressor.c */
17821e51764aSArtem Bityutskiy int __init ubifs_compressors_init(void);
1783995be045SAlexey Dobriyan void ubifs_compressors_exit(void);
1784235c362bSSheng Yong void ubifs_compress(const struct ubifs_info *c, const void *in_buf, int in_len,
1785235c362bSSheng Yong 		    void *out_buf, int *out_len, int *compr_type);
1786235c362bSSheng Yong int ubifs_decompress(const struct ubifs_info *c, const void *buf, int len,
1787235c362bSSheng Yong 		     void *out, int *out_len, int compr_type);
17881e51764aSArtem Bityutskiy 
17891e51764aSArtem Bityutskiy #include "debug.h"
17901e51764aSArtem Bityutskiy #include "misc.h"
17911e51764aSArtem Bityutskiy #include "key.h"
17921e51764aSArtem Bityutskiy 
1793d475a507SRichard Weinberger #ifndef CONFIG_UBIFS_FS_ENCRYPTION
1794d475a507SRichard Weinberger #define fscrypt_set_d_op(i)
1795d475a507SRichard Weinberger #define fscrypt_get_ctx                 fscrypt_notsupp_get_ctx
1796d475a507SRichard Weinberger #define fscrypt_release_ctx             fscrypt_notsupp_release_ctx
1797d475a507SRichard Weinberger #define fscrypt_encrypt_page            fscrypt_notsupp_encrypt_page
1798d475a507SRichard Weinberger #define fscrypt_decrypt_page            fscrypt_notsupp_decrypt_page
1799d475a507SRichard Weinberger #define fscrypt_decrypt_bio_pages       fscrypt_notsupp_decrypt_bio_pages
1800d475a507SRichard Weinberger #define fscrypt_pullback_bio_page       fscrypt_notsupp_pullback_bio_page
1801d475a507SRichard Weinberger #define fscrypt_restore_control_page    fscrypt_notsupp_restore_control_page
1802d475a507SRichard Weinberger #define fscrypt_zeroout_range           fscrypt_notsupp_zeroout_range
1803d475a507SRichard Weinberger #define fscrypt_process_policy          fscrypt_notsupp_process_policy
1804d475a507SRichard Weinberger #define fscrypt_get_policy              fscrypt_notsupp_get_policy
1805d475a507SRichard Weinberger #define fscrypt_has_permitted_context   fscrypt_notsupp_has_permitted_context
1806d475a507SRichard Weinberger #define fscrypt_inherit_context         fscrypt_notsupp_inherit_context
1807d475a507SRichard Weinberger #define fscrypt_get_encryption_info     fscrypt_notsupp_get_encryption_info
1808d475a507SRichard Weinberger #define fscrypt_put_encryption_info     fscrypt_notsupp_put_encryption_info
1809d475a507SRichard Weinberger #define fscrypt_setup_filename          fscrypt_notsupp_setup_filename
1810d475a507SRichard Weinberger #define fscrypt_free_filename           fscrypt_notsupp_free_filename
1811d475a507SRichard Weinberger #define fscrypt_fname_encrypted_size    fscrypt_notsupp_fname_encrypted_size
1812d475a507SRichard Weinberger #define fscrypt_fname_alloc_buffer      fscrypt_notsupp_fname_alloc_buffer
1813d475a507SRichard Weinberger #define fscrypt_fname_free_buffer       fscrypt_notsupp_fname_free_buffer
1814d475a507SRichard Weinberger #define fscrypt_fname_disk_to_usr       fscrypt_notsupp_fname_disk_to_usr
1815d475a507SRichard Weinberger #define fscrypt_fname_usr_to_disk       fscrypt_notsupp_fname_usr_to_disk
18167799953bSRichard Weinberger static inline int ubifs_encrypt(const struct inode *inode,
18177799953bSRichard Weinberger 				struct ubifs_data_node *dn,
18187799953bSRichard Weinberger 				unsigned int in_len, unsigned int *out_len,
18197799953bSRichard Weinberger 				int block)
18207799953bSRichard Weinberger {
18217799953bSRichard Weinberger 	ubifs_assert(0);
18227799953bSRichard Weinberger 	return -EOPNOTSUPP;
18237799953bSRichard Weinberger }
18247799953bSRichard Weinberger static inline int ubifs_decrypt(const struct inode *inode,
18257799953bSRichard Weinberger 				struct ubifs_data_node *dn,
18267799953bSRichard Weinberger 				unsigned int *out_len, int block)
18277799953bSRichard Weinberger {
18287799953bSRichard Weinberger 	ubifs_assert(0);
18297799953bSRichard Weinberger 	return -EOPNOTSUPP;
18307799953bSRichard Weinberger }
18317799953bSRichard Weinberger #else
18327799953bSRichard Weinberger /* crypto.c */
18337799953bSRichard Weinberger int ubifs_encrypt(const struct inode *inode, struct ubifs_data_node *dn,
18347799953bSRichard Weinberger 		  unsigned int in_len, unsigned int *out_len, int block);
18357799953bSRichard Weinberger int ubifs_decrypt(const struct inode *inode, struct ubifs_data_node *dn,
18367799953bSRichard Weinberger 		  unsigned int *out_len, int block);
1837d475a507SRichard Weinberger #endif
1838d475a507SRichard Weinberger 
18397799953bSRichard Weinberger extern struct fscrypt_operations ubifs_crypt_operations;
18407799953bSRichard Weinberger 
18411ee77870SRichard Weinberger static inline bool __ubifs_crypt_is_encrypted(struct inode *inode)
1842d475a507SRichard Weinberger {
1843d475a507SRichard Weinberger 	struct ubifs_inode *ui = ubifs_inode(inode);
1844d475a507SRichard Weinberger 
1845d475a507SRichard Weinberger 	return ui->flags & UBIFS_CRYPT_FL;
1846d475a507SRichard Weinberger }
1847d475a507SRichard Weinberger 
18481ee77870SRichard Weinberger static inline bool ubifs_crypt_is_encrypted(const struct inode *inode)
18491ee77870SRichard Weinberger {
18501ee77870SRichard Weinberger 	return __ubifs_crypt_is_encrypted((struct inode *)inode);
18511ee77870SRichard Weinberger }
18521ee77870SRichard Weinberger 
18533e7f2c51SJoe Perches /* Normal UBIFS messages */
18543e7f2c51SJoe Perches __printf(2, 3)
18553e7f2c51SJoe Perches void ubifs_msg(const struct ubifs_info *c, const char *fmt, ...);
18563e7f2c51SJoe Perches __printf(2, 3)
18573e7f2c51SJoe Perches void ubifs_err(const struct ubifs_info *c, const char *fmt, ...);
18583e7f2c51SJoe Perches __printf(2, 3)
18593e7f2c51SJoe Perches void ubifs_warn(const struct ubifs_info *c, const char *fmt, ...);
18603e7f2c51SJoe Perches /*
1861380bc8b7SDaniel Golle  * A conditional variant of 'ubifs_err()' which doesn't output anything
1862380bc8b7SDaniel Golle  * if probing (ie. MS_SILENT set).
18633e7f2c51SJoe Perches  */
18643e7f2c51SJoe Perches #define ubifs_errc(c, fmt, ...)						\
18653e7f2c51SJoe Perches do {									\
18663e7f2c51SJoe Perches 	if (!(c)->probing)						\
18673e7f2c51SJoe Perches 		ubifs_err(c, fmt, ##__VA_ARGS__);			\
18683e7f2c51SJoe Perches } while (0)
18693e7f2c51SJoe Perches 
18701e51764aSArtem Bityutskiy #endif /* !__UBIFS_H__ */
1871