147e4937aSGao Xiang /* SPDX-License-Identifier: GPL-2.0-only */ 247e4937aSGao Xiang /* 347e4937aSGao Xiang * Copyright (C) 2017-2018 HUAWEI, Inc. 4592e7cd0SAlexander A. Klimov * https://www.huawei.com/ 5c5aa903aSGao Xiang * Copyright (C) 2021, Alibaba Cloud 647e4937aSGao Xiang */ 747e4937aSGao Xiang #ifndef __EROFS_INTERNAL_H 847e4937aSGao Xiang #define __EROFS_INTERNAL_H 947e4937aSGao Xiang 1047e4937aSGao Xiang #include <linux/fs.h> 1147e4937aSGao Xiang #include <linux/dcache.h> 1247e4937aSGao Xiang #include <linux/mm.h> 1347e4937aSGao Xiang #include <linux/pagemap.h> 1447e4937aSGao Xiang #include <linux/bio.h> 1547e4937aSGao Xiang #include <linux/buffer_head.h> 1647e4937aSGao Xiang #include <linux/magic.h> 1747e4937aSGao Xiang #include <linux/slab.h> 1847e4937aSGao Xiang #include <linux/vmalloc.h> 19eadcd6b5SGao Xiang #include <linux/iomap.h> 2047e4937aSGao Xiang #include "erofs_fs.h" 2147e4937aSGao Xiang 2247e4937aSGao Xiang /* redefine pr_fmt "erofs: " */ 2347e4937aSGao Xiang #undef pr_fmt 2447e4937aSGao Xiang #define pr_fmt(fmt) "erofs: " fmt 2547e4937aSGao Xiang 264f761fa2SGao Xiang __printf(3, 4) void _erofs_err(struct super_block *sb, 274f761fa2SGao Xiang const char *function, const char *fmt, ...); 284f761fa2SGao Xiang #define erofs_err(sb, fmt, ...) \ 294f761fa2SGao Xiang _erofs_err(sb, __func__, fmt "\n", ##__VA_ARGS__) 304f761fa2SGao Xiang __printf(3, 4) void _erofs_info(struct super_block *sb, 314f761fa2SGao Xiang const char *function, const char *fmt, ...); 324f761fa2SGao Xiang #define erofs_info(sb, fmt, ...) \ 334f761fa2SGao Xiang _erofs_info(sb, __func__, fmt "\n", ##__VA_ARGS__) 3447e4937aSGao Xiang #ifdef CONFIG_EROFS_FS_DEBUG 354f761fa2SGao Xiang #define erofs_dbg(x, ...) pr_debug(x "\n", ##__VA_ARGS__) 3647e4937aSGao Xiang #define DBG_BUGON BUG_ON 3747e4937aSGao Xiang #else 384f761fa2SGao Xiang #define erofs_dbg(x, ...) ((void)0) 3947e4937aSGao Xiang #define DBG_BUGON(x) ((void)(x)) 4047e4937aSGao Xiang #endif /* !CONFIG_EROFS_FS_DEBUG */ 4147e4937aSGao Xiang 4247e4937aSGao Xiang /* EROFS_SUPER_MAGIC_V1 to represent the whole file system */ 4347e4937aSGao Xiang #define EROFS_SUPER_MAGIC EROFS_SUPER_MAGIC_V1 4447e4937aSGao Xiang 4547e4937aSGao Xiang typedef u64 erofs_nid_t; 4647e4937aSGao Xiang typedef u64 erofs_off_t; 4747e4937aSGao Xiang /* data type for filesystem-wide blocks number */ 4847e4937aSGao Xiang typedef u32 erofs_blk_t; 4947e4937aSGao Xiang 50dfeab2e9SGao Xiang struct erofs_device_info { 51dfeab2e9SGao Xiang char *path; 52dfeab2e9SGao Xiang struct block_device *bdev; 53dfeab2e9SGao Xiang struct dax_device *dax_dev; 54dfeab2e9SGao Xiang 55dfeab2e9SGao Xiang u32 blocks; 56dfeab2e9SGao Xiang u32 mapped_blkaddr; 57dfeab2e9SGao Xiang }; 58dfeab2e9SGao Xiang 5940452ffcSHuang Jianan enum { 6040452ffcSHuang Jianan EROFS_SYNC_DECOMPRESS_AUTO, 6140452ffcSHuang Jianan EROFS_SYNC_DECOMPRESS_FORCE_ON, 6240452ffcSHuang Jianan EROFS_SYNC_DECOMPRESS_FORCE_OFF 6340452ffcSHuang Jianan }; 6440452ffcSHuang Jianan 65e6242465SGao Xiang struct erofs_mount_opts { 66f57a3fe4SChao Yu #ifdef CONFIG_EROFS_FS_ZIP 67f57a3fe4SChao Yu /* current strategy of how to use managed cache */ 68f57a3fe4SChao Yu unsigned char cache_strategy; 6940452ffcSHuang Jianan /* strategy of sync decompression (0 - auto, 1 - force on, 2 - force off) */ 7040452ffcSHuang Jianan unsigned int sync_decompress; 71f57a3fe4SChao Yu 72f57a3fe4SChao Yu /* threshold for decompression synchronously */ 73f57a3fe4SChao Yu unsigned int max_sync_decompress_pages; 74f57a3fe4SChao Yu #endif 75f57a3fe4SChao Yu unsigned int mount_opt; 76f57a3fe4SChao Yu }; 77f57a3fe4SChao Yu 78dfeab2e9SGao Xiang struct erofs_dev_context { 79dfeab2e9SGao Xiang struct idr tree; 80dfeab2e9SGao Xiang struct rw_semaphore rwsem; 81dfeab2e9SGao Xiang 82dfeab2e9SGao Xiang unsigned int extra_devices; 83dfeab2e9SGao Xiang }; 84dfeab2e9SGao Xiang 85e6242465SGao Xiang struct erofs_fs_context { 86e6242465SGao Xiang struct erofs_mount_opts opt; 87dfeab2e9SGao Xiang struct erofs_dev_context *devs; 88e6242465SGao Xiang }; 89e6242465SGao Xiang 905d50538fSHuang Jianan /* all filesystem-wide lz4 configurations */ 915d50538fSHuang Jianan struct erofs_sb_lz4_info { 925d50538fSHuang Jianan /* # of pages needed for EROFS lz4 rolling decompression */ 935d50538fSHuang Jianan u16 max_distance_pages; 944fea63f7SGao Xiang /* maximum possible blocks for pclusters in the filesystem */ 954fea63f7SGao Xiang u16 max_pclusterblks; 965d50538fSHuang Jianan }; 975d50538fSHuang Jianan 9847e4937aSGao Xiang struct erofs_sb_info { 99e6242465SGao Xiang struct erofs_mount_opts opt; /* options */ 10047e4937aSGao Xiang #ifdef CONFIG_EROFS_FS_ZIP 10147e4937aSGao Xiang /* list for all registered superblocks, mainly for shrinker */ 10247e4937aSGao Xiang struct list_head list; 10347e4937aSGao Xiang struct mutex umount_mutex; 10447e4937aSGao Xiang 10564094a04SGao Xiang /* managed XArray arranged in physical block number */ 10664094a04SGao Xiang struct xarray managed_pslots; 10747e4937aSGao Xiang 10847e4937aSGao Xiang unsigned int shrinker_run_no; 10914373711SGao Xiang u16 available_compr_algs; 11047e4937aSGao Xiang 11147e4937aSGao Xiang /* pseudo inode to manage cached pages */ 11247e4937aSGao Xiang struct inode *managed_cache; 1135d50538fSHuang Jianan 1145d50538fSHuang Jianan struct erofs_sb_lz4_info lz4; 11547e4937aSGao Xiang #endif /* CONFIG_EROFS_FS_ZIP */ 116dfeab2e9SGao Xiang struct erofs_dev_context *devs; 11706252e9cSGao Xiang struct dax_device *dax_dev; 118dfeab2e9SGao Xiang u64 total_blocks; 119dfeab2e9SGao Xiang u32 primarydevice_blocks; 120dfeab2e9SGao Xiang 12147e4937aSGao Xiang u32 meta_blkaddr; 12247e4937aSGao Xiang #ifdef CONFIG_EROFS_FS_XATTR 12347e4937aSGao Xiang u32 xattr_blkaddr; 12447e4937aSGao Xiang #endif 125dfeab2e9SGao Xiang u16 device_id_mask; /* valid bits of device id to be used */ 12647e4937aSGao Xiang 12747e4937aSGao Xiang /* inode slot unit size in bit shift */ 12847e4937aSGao Xiang unsigned char islotbits; 12947e4937aSGao Xiang 13014373711SGao Xiang u32 sb_size; /* total superblock size */ 13147e4937aSGao Xiang u32 build_time_nsec; 13247e4937aSGao Xiang u64 build_time; 13347e4937aSGao Xiang 13447e4937aSGao Xiang /* what we really care is nid, rather than ino.. */ 13547e4937aSGao Xiang erofs_nid_t root_nid; 13647e4937aSGao Xiang /* used for statfs, f_files - f_favail */ 13747e4937aSGao Xiang u64 inos; 13847e4937aSGao Xiang 13947e4937aSGao Xiang u8 uuid[16]; /* 128-bit uuid for volume */ 14047e4937aSGao Xiang u8 volume_name[16]; /* volume name */ 141b858a484SPratik Shinde u32 feature_compat; 142426a9308SGao Xiang u32 feature_incompat; 143168e9a76SHuang Jianan 144168e9a76SHuang Jianan /* sysfs support */ 145168e9a76SHuang Jianan struct kobject s_kobj; /* /sys/fs/erofs/<devname> */ 146168e9a76SHuang Jianan struct completion s_kobj_unregister; 14747e4937aSGao Xiang }; 14847e4937aSGao Xiang 14947e4937aSGao Xiang #define EROFS_SB(sb) ((struct erofs_sb_info *)(sb)->s_fs_info) 15047e4937aSGao Xiang #define EROFS_I_SB(inode) ((struct erofs_sb_info *)(inode)->i_sb->s_fs_info) 15147e4937aSGao Xiang 15247e4937aSGao Xiang /* Mount flags set via mount options or defaults */ 15347e4937aSGao Xiang #define EROFS_MOUNT_XATTR_USER 0x00000010 15447e4937aSGao Xiang #define EROFS_MOUNT_POSIX_ACL 0x00000020 15506252e9cSGao Xiang #define EROFS_MOUNT_DAX_ALWAYS 0x00000040 15606252e9cSGao Xiang #define EROFS_MOUNT_DAX_NEVER 0x00000080 15747e4937aSGao Xiang 158e6242465SGao Xiang #define clear_opt(opt, option) ((opt)->mount_opt &= ~EROFS_MOUNT_##option) 159e6242465SGao Xiang #define set_opt(opt, option) ((opt)->mount_opt |= EROFS_MOUNT_##option) 160e6242465SGao Xiang #define test_opt(opt, option) ((opt)->mount_opt & EROFS_MOUNT_##option) 16147e4937aSGao Xiang 16247e4937aSGao Xiang enum { 16347e4937aSGao Xiang EROFS_ZIP_CACHE_DISABLED, 16447e4937aSGao Xiang EROFS_ZIP_CACHE_READAHEAD, 16547e4937aSGao Xiang EROFS_ZIP_CACHE_READAROUND 16647e4937aSGao Xiang }; 16747e4937aSGao Xiang 168f57a3fe4SChao Yu #ifdef CONFIG_EROFS_FS_ZIP 16947e4937aSGao Xiang #define EROFS_LOCKED_MAGIC (INT_MIN | 0xE0F510CCL) 17047e4937aSGao Xiang 17147e4937aSGao Xiang /* basic unit of the workstation of a super_block */ 17247e4937aSGao Xiang struct erofs_workgroup { 17347e4937aSGao Xiang /* the workgroup index in the workstation */ 17447e4937aSGao Xiang pgoff_t index; 17547e4937aSGao Xiang 17647e4937aSGao Xiang /* overall workgroup reference count */ 17747e4937aSGao Xiang atomic_t refcount; 17847e4937aSGao Xiang }; 17947e4937aSGao Xiang 18047e4937aSGao Xiang #if defined(CONFIG_SMP) 18147e4937aSGao Xiang static inline bool erofs_workgroup_try_to_freeze(struct erofs_workgroup *grp, 18247e4937aSGao Xiang int val) 18347e4937aSGao Xiang { 18447e4937aSGao Xiang preempt_disable(); 18547e4937aSGao Xiang if (val != atomic_cmpxchg(&grp->refcount, val, EROFS_LOCKED_MAGIC)) { 18647e4937aSGao Xiang preempt_enable(); 18747e4937aSGao Xiang return false; 18847e4937aSGao Xiang } 18947e4937aSGao Xiang return true; 19047e4937aSGao Xiang } 19147e4937aSGao Xiang 19247e4937aSGao Xiang static inline void erofs_workgroup_unfreeze(struct erofs_workgroup *grp, 19347e4937aSGao Xiang int orig_val) 19447e4937aSGao Xiang { 19547e4937aSGao Xiang /* 19647e4937aSGao Xiang * other observers should notice all modifications 19747e4937aSGao Xiang * in the freezing period. 19847e4937aSGao Xiang */ 19947e4937aSGao Xiang smp_mb(); 20047e4937aSGao Xiang atomic_set(&grp->refcount, orig_val); 20147e4937aSGao Xiang preempt_enable(); 20247e4937aSGao Xiang } 20347e4937aSGao Xiang 20447e4937aSGao Xiang static inline int erofs_wait_on_workgroup_freezed(struct erofs_workgroup *grp) 20547e4937aSGao Xiang { 20647e4937aSGao Xiang return atomic_cond_read_relaxed(&grp->refcount, 20747e4937aSGao Xiang VAL != EROFS_LOCKED_MAGIC); 20847e4937aSGao Xiang } 20947e4937aSGao Xiang #else 21047e4937aSGao Xiang static inline bool erofs_workgroup_try_to_freeze(struct erofs_workgroup *grp, 21147e4937aSGao Xiang int val) 21247e4937aSGao Xiang { 21347e4937aSGao Xiang preempt_disable(); 21447e4937aSGao Xiang /* no need to spin on UP platforms, let's just disable preemption. */ 21547e4937aSGao Xiang if (val != atomic_read(&grp->refcount)) { 21647e4937aSGao Xiang preempt_enable(); 21747e4937aSGao Xiang return false; 21847e4937aSGao Xiang } 21947e4937aSGao Xiang return true; 22047e4937aSGao Xiang } 22147e4937aSGao Xiang 22247e4937aSGao Xiang static inline void erofs_workgroup_unfreeze(struct erofs_workgroup *grp, 22347e4937aSGao Xiang int orig_val) 22447e4937aSGao Xiang { 22547e4937aSGao Xiang preempt_enable(); 22647e4937aSGao Xiang } 22747e4937aSGao Xiang 22847e4937aSGao Xiang static inline int erofs_wait_on_workgroup_freezed(struct erofs_workgroup *grp) 22947e4937aSGao Xiang { 23047e4937aSGao Xiang int v = atomic_read(&grp->refcount); 23147e4937aSGao Xiang 23247e4937aSGao Xiang /* workgroup is never freezed on uniprocessor systems */ 23347e4937aSGao Xiang DBG_BUGON(v == EROFS_LOCKED_MAGIC); 23447e4937aSGao Xiang return v; 23547e4937aSGao Xiang } 23647e4937aSGao Xiang #endif /* !CONFIG_SMP */ 23747e4937aSGao Xiang #endif /* !CONFIG_EROFS_FS_ZIP */ 23847e4937aSGao Xiang 23947e4937aSGao Xiang /* we strictly follow PAGE_SIZE and no buffer head yet */ 24047e4937aSGao Xiang #define LOG_BLOCK_SIZE PAGE_SHIFT 24147e4937aSGao Xiang 24247e4937aSGao Xiang #undef LOG_SECTORS_PER_BLOCK 24347e4937aSGao Xiang #define LOG_SECTORS_PER_BLOCK (PAGE_SHIFT - 9) 24447e4937aSGao Xiang 24547e4937aSGao Xiang #undef SECTORS_PER_BLOCK 24647e4937aSGao Xiang #define SECTORS_PER_BLOCK (1 << SECTORS_PER_BLOCK) 24747e4937aSGao Xiang 24847e4937aSGao Xiang #define EROFS_BLKSIZ (1 << LOG_BLOCK_SIZE) 24947e4937aSGao Xiang 25047e4937aSGao Xiang #if (EROFS_BLKSIZ % 4096 || !EROFS_BLKSIZ) 25147e4937aSGao Xiang #error erofs cannot be used in this platform 25247e4937aSGao Xiang #endif 25347e4937aSGao Xiang 254fdf80a47SGao Xiang enum erofs_kmap_type { 255fdf80a47SGao Xiang EROFS_NO_KMAP, /* don't map the buffer */ 256fdf80a47SGao Xiang EROFS_KMAP, /* use kmap() to map the buffer */ 257fdf80a47SGao Xiang EROFS_KMAP_ATOMIC, /* use kmap_atomic() to map the buffer */ 258fdf80a47SGao Xiang }; 259fdf80a47SGao Xiang 260fdf80a47SGao Xiang struct erofs_buf { 261fdf80a47SGao Xiang struct page *page; 262fdf80a47SGao Xiang void *base; 263fdf80a47SGao Xiang enum erofs_kmap_type kmap_type; 264fdf80a47SGao Xiang }; 265fdf80a47SGao Xiang #define __EROFS_BUF_INITIALIZER ((struct erofs_buf){ .page = NULL }) 266fdf80a47SGao Xiang 26747e4937aSGao Xiang #define ROOT_NID(sb) ((sb)->root_nid) 26847e4937aSGao Xiang 26947e4937aSGao Xiang #define erofs_blknr(addr) ((addr) / EROFS_BLKSIZ) 27047e4937aSGao Xiang #define erofs_blkoff(addr) ((addr) % EROFS_BLKSIZ) 27147e4937aSGao Xiang #define blknr_to_addr(nr) ((erofs_off_t)(nr) * EROFS_BLKSIZ) 27247e4937aSGao Xiang 27347e4937aSGao Xiang static inline erofs_off_t iloc(struct erofs_sb_info *sbi, erofs_nid_t nid) 27447e4937aSGao Xiang { 27547e4937aSGao Xiang return blknr_to_addr(sbi->meta_blkaddr) + (nid << sbi->islotbits); 27647e4937aSGao Xiang } 27747e4937aSGao Xiang 278de06a6a3SGao Xiang #define EROFS_FEATURE_FUNCS(name, compat, feature) \ 279de06a6a3SGao Xiang static inline bool erofs_sb_has_##name(struct erofs_sb_info *sbi) \ 280de06a6a3SGao Xiang { \ 281de06a6a3SGao Xiang return sbi->feature_##compat & EROFS_FEATURE_##feature; \ 282de06a6a3SGao Xiang } 283de06a6a3SGao Xiang 2847e508f2cSHuang Jianan EROFS_FEATURE_FUNCS(zero_padding, incompat, INCOMPAT_ZERO_PADDING) 28514373711SGao Xiang EROFS_FEATURE_FUNCS(compr_cfgs, incompat, INCOMPAT_COMPR_CFGS) 2865404c330SGao Xiang EROFS_FEATURE_FUNCS(big_pcluster, incompat, INCOMPAT_BIG_PCLUSTER) 287168e9a76SHuang Jianan EROFS_FEATURE_FUNCS(chunked_file, incompat, INCOMPAT_CHUNKED_FILE) 288dfeab2e9SGao Xiang EROFS_FEATURE_FUNCS(device_table, incompat, INCOMPAT_DEVICE_TABLE) 289168e9a76SHuang Jianan EROFS_FEATURE_FUNCS(compr_head2, incompat, INCOMPAT_COMPR_HEAD2) 290ab92184fSYue Hu EROFS_FEATURE_FUNCS(ztailpacking, incompat, INCOMPAT_ZTAILPACKING) 291de06a6a3SGao Xiang EROFS_FEATURE_FUNCS(sb_chksum, compat, COMPAT_SB_CHKSUM) 292de06a6a3SGao Xiang 29347e4937aSGao Xiang /* atomic flag definitions */ 294a5876e24SGao Xiang #define EROFS_I_EA_INITED_BIT 0 295a5876e24SGao Xiang #define EROFS_I_Z_INITED_BIT 1 29647e4937aSGao Xiang 29747e4937aSGao Xiang /* bitlock definitions (arranged in reverse order) */ 298a5876e24SGao Xiang #define EROFS_I_BL_XATTR_BIT (BITS_PER_LONG - 1) 299a5876e24SGao Xiang #define EROFS_I_BL_Z_BIT (BITS_PER_LONG - 2) 30047e4937aSGao Xiang 301a5876e24SGao Xiang struct erofs_inode { 30247e4937aSGao Xiang erofs_nid_t nid; 30347e4937aSGao Xiang 30447e4937aSGao Xiang /* atomic flags (including bitlocks) */ 30547e4937aSGao Xiang unsigned long flags; 30647e4937aSGao Xiang 3078a765682SGao Xiang unsigned char datalayout; 30847e4937aSGao Xiang unsigned char inode_isize; 30947e4937aSGao Xiang unsigned short xattr_isize; 31047e4937aSGao Xiang 31147e4937aSGao Xiang unsigned int xattr_shared_count; 31247e4937aSGao Xiang unsigned int *xattr_shared_xattrs; 31347e4937aSGao Xiang 31447e4937aSGao Xiang union { 31547e4937aSGao Xiang erofs_blk_t raw_blkaddr; 316c5aa903aSGao Xiang struct { 317c5aa903aSGao Xiang unsigned short chunkformat; 318c5aa903aSGao Xiang unsigned char chunkbits; 319c5aa903aSGao Xiang }; 32047e4937aSGao Xiang #ifdef CONFIG_EROFS_FS_ZIP 32147e4937aSGao Xiang struct { 32247e4937aSGao Xiang unsigned short z_advise; 32347e4937aSGao Xiang unsigned char z_algorithmtype[2]; 32447e4937aSGao Xiang unsigned char z_logical_clusterbits; 325ab92184fSYue Hu unsigned long z_tailextent_headlcn; 326ab92184fSYue Hu unsigned int z_idataoff; 327ab92184fSYue Hu unsigned short z_idata_size; 32847e4937aSGao Xiang }; 32947e4937aSGao Xiang #endif /* CONFIG_EROFS_FS_ZIP */ 33047e4937aSGao Xiang }; 33147e4937aSGao Xiang /* the corresponding vfs inode */ 33247e4937aSGao Xiang struct inode vfs_inode; 33347e4937aSGao Xiang }; 33447e4937aSGao Xiang 335a5876e24SGao Xiang #define EROFS_I(ptr) \ 336a5876e24SGao Xiang container_of(ptr, struct erofs_inode, vfs_inode) 33747e4937aSGao Xiang 33899634bf3SGao Xiang static inline unsigned long erofs_inode_datablocks(struct inode *inode) 33947e4937aSGao Xiang { 34047e4937aSGao Xiang /* since i_size cannot be changed */ 34147e4937aSGao Xiang return DIV_ROUND_UP(inode->i_size, EROFS_BLKSIZ); 34247e4937aSGao Xiang } 34347e4937aSGao Xiang 3448a765682SGao Xiang static inline unsigned int erofs_bitrange(unsigned int value, unsigned int bit, 3458a765682SGao Xiang unsigned int bits) 34647e4937aSGao Xiang { 3478a765682SGao Xiang 3488a765682SGao Xiang return (value >> bit) & ((1 << bits) - 1); 34947e4937aSGao Xiang } 35047e4937aSGao Xiang 3518a765682SGao Xiang 3528a765682SGao Xiang static inline unsigned int erofs_inode_version(unsigned int value) 35347e4937aSGao Xiang { 3548a765682SGao Xiang return erofs_bitrange(value, EROFS_I_VERSION_BIT, 3558a765682SGao Xiang EROFS_I_VERSION_BITS); 3568a765682SGao Xiang } 3578a765682SGao Xiang 3588a765682SGao Xiang static inline unsigned int erofs_inode_datalayout(unsigned int value) 3598a765682SGao Xiang { 3608a765682SGao Xiang return erofs_bitrange(value, EROFS_I_DATALAYOUT_BIT, 3618a765682SGao Xiang EROFS_I_DATALAYOUT_BITS); 36247e4937aSGao Xiang } 36347e4937aSGao Xiang 36438629291SGao Xiang /* 36538629291SGao Xiang * Different from grab_cache_page_nowait(), reclaiming is never triggered 36638629291SGao Xiang * when allocating new pages. 36738629291SGao Xiang */ 36838629291SGao Xiang static inline 36938629291SGao Xiang struct page *erofs_grab_cache_page_nowait(struct address_space *mapping, 37038629291SGao Xiang pgoff_t index) 37138629291SGao Xiang { 37238629291SGao Xiang return pagecache_get_page(mapping, index, 37338629291SGao Xiang FGP_LOCK|FGP_CREAT|FGP_NOFS|FGP_NOWAIT, 37438629291SGao Xiang readahead_gfp_mask(mapping) & ~__GFP_RECLAIM); 37538629291SGao Xiang } 37638629291SGao Xiang 37747e4937aSGao Xiang extern const struct super_operations erofs_sops; 37847e4937aSGao Xiang 37947e4937aSGao Xiang extern const struct address_space_operations erofs_raw_access_aops; 3800c638f70SGao Xiang extern const struct address_space_operations z_erofs_aops; 38147e4937aSGao Xiang 38247e4937aSGao Xiang /* 3838137824eSYue Hu * Logical to physical block mapping 38447e4937aSGao Xiang * 38547e4937aSGao Xiang * Different with other file systems, it is used for 2 access modes: 38647e4937aSGao Xiang * 38747e4937aSGao Xiang * 1) RAW access mode: 38847e4937aSGao Xiang * 38947e4937aSGao Xiang * Users pass a valid (m_lblk, m_lofs -- usually 0) pair, 39047e4937aSGao Xiang * and get the valid m_pblk, m_pofs and the longest m_len(in bytes). 39147e4937aSGao Xiang * 39247e4937aSGao Xiang * Note that m_lblk in the RAW access mode refers to the number of 39347e4937aSGao Xiang * the compressed ondisk block rather than the uncompressed 39447e4937aSGao Xiang * in-memory block for the compressed file. 39547e4937aSGao Xiang * 39647e4937aSGao Xiang * m_pofs equals to m_lofs except for the inline data page. 39747e4937aSGao Xiang * 39847e4937aSGao Xiang * 2) Normal access mode: 39947e4937aSGao Xiang * 40047e4937aSGao Xiang * If the inode is not compressed, it has no difference with 40147e4937aSGao Xiang * the RAW access mode. However, if the inode is compressed, 40247e4937aSGao Xiang * users should pass a valid (m_lblk, m_lofs) pair, and get 40347e4937aSGao Xiang * the needed m_pblk, m_pofs, m_len to get the compressed data 40447e4937aSGao Xiang * and the updated m_lblk, m_lofs which indicates the start 40547e4937aSGao Xiang * of the corresponding uncompressed data in the file. 40647e4937aSGao Xiang */ 40747e4937aSGao Xiang enum { 4088f899262SGao Xiang BH_Encoded = BH_PrivateStart, 40947e4937aSGao Xiang BH_FullMapped, 41047e4937aSGao Xiang }; 41147e4937aSGao Xiang 41247e4937aSGao Xiang /* Has a disk mapping */ 41347e4937aSGao Xiang #define EROFS_MAP_MAPPED (1 << BH_Mapped) 41447e4937aSGao Xiang /* Located in metadata (could be copied from bd_inode) */ 41547e4937aSGao Xiang #define EROFS_MAP_META (1 << BH_Meta) 4168f899262SGao Xiang /* The extent is encoded */ 4178f899262SGao Xiang #define EROFS_MAP_ENCODED (1 << BH_Encoded) 41847e4937aSGao Xiang /* The length of extent is full */ 41947e4937aSGao Xiang #define EROFS_MAP_FULL_MAPPED (1 << BH_FullMapped) 42047e4937aSGao Xiang 42147e4937aSGao Xiang struct erofs_map_blocks { 42247e4937aSGao Xiang erofs_off_t m_pa, m_la; 42347e4937aSGao Xiang u64 m_plen, m_llen; 42447e4937aSGao Xiang 425dfeab2e9SGao Xiang unsigned short m_deviceid; 4268f899262SGao Xiang char m_algorithmformat; 42747e4937aSGao Xiang unsigned int m_flags; 42847e4937aSGao Xiang 42947e4937aSGao Xiang struct page *mpage; 43047e4937aSGao Xiang }; 43147e4937aSGao Xiang 4328137824eSYue Hu /* Flags used by erofs_map_blocks_flatmode() */ 43347e4937aSGao Xiang #define EROFS_GET_BLOCKS_RAW 0x0001 434d95ae5e2SGao Xiang /* 435d95ae5e2SGao Xiang * Used to get the exact decompressed length, e.g. fiemap (consider lookback 436d95ae5e2SGao Xiang * approach instead if possible since it's more metadata lightweight.) 437d95ae5e2SGao Xiang */ 438d95ae5e2SGao Xiang #define EROFS_GET_BLOCKS_FIEMAP 0x0002 439622ceaddSGao Xiang /* Used to map the whole extent if non-negligible data is requested for LZMA */ 440622ceaddSGao Xiang #define EROFS_GET_BLOCKS_READMORE 0x0004 441ab92184fSYue Hu /* Used to map tail extent for tailpacking inline pcluster */ 442ab92184fSYue Hu #define EROFS_GET_BLOCKS_FINDTAIL 0x0008 44347e4937aSGao Xiang 4448f899262SGao Xiang enum { 4458f899262SGao Xiang Z_EROFS_COMPRESSION_SHIFTED = Z_EROFS_COMPRESSION_MAX, 4468f899262SGao Xiang Z_EROFS_COMPRESSION_RUNTIME_MAX 4478f899262SGao Xiang }; 4488f899262SGao Xiang 44947e4937aSGao Xiang /* zmap.c */ 450eadcd6b5SGao Xiang extern const struct iomap_ops z_erofs_iomap_report_ops; 451eadcd6b5SGao Xiang 45247e4937aSGao Xiang #ifdef CONFIG_EROFS_FS_ZIP 45347e4937aSGao Xiang int z_erofs_fill_inode(struct inode *inode); 45447e4937aSGao Xiang int z_erofs_map_blocks_iter(struct inode *inode, 45547e4937aSGao Xiang struct erofs_map_blocks *map, 45647e4937aSGao Xiang int flags); 45747e4937aSGao Xiang #else 45847e4937aSGao Xiang static inline int z_erofs_fill_inode(struct inode *inode) { return -EOPNOTSUPP; } 45947e4937aSGao Xiang static inline int z_erofs_map_blocks_iter(struct inode *inode, 46047e4937aSGao Xiang struct erofs_map_blocks *map, 46147e4937aSGao Xiang int flags) 46247e4937aSGao Xiang { 46347e4937aSGao Xiang return -EOPNOTSUPP; 46447e4937aSGao Xiang } 46547e4937aSGao Xiang #endif /* !CONFIG_EROFS_FS_ZIP */ 46647e4937aSGao Xiang 467dfeab2e9SGao Xiang struct erofs_map_dev { 468dfeab2e9SGao Xiang struct block_device *m_bdev; 469dfeab2e9SGao Xiang struct dax_device *m_daxdev; 470dfeab2e9SGao Xiang 471dfeab2e9SGao Xiang erofs_off_t m_pa; 472dfeab2e9SGao Xiang unsigned int m_deviceid; 473dfeab2e9SGao Xiang }; 474dfeab2e9SGao Xiang 47547e4937aSGao Xiang /* data.c */ 476a08e67a0SHuang Jianan extern const struct file_operations erofs_file_fops; 477e655b5b3SGao Xiang struct page *erofs_get_meta_page(struct super_block *sb, erofs_blk_t blkaddr); 478*c521e3adSGao Xiang void erofs_put_metabuf(struct erofs_buf *buf); 479*c521e3adSGao Xiang void *erofs_read_metabuf(struct erofs_buf *buf, struct super_block *sb, 480*c521e3adSGao Xiang erofs_blk_t blkaddr, enum erofs_kmap_type type); 481dfeab2e9SGao Xiang int erofs_map_dev(struct super_block *sb, struct erofs_map_dev *dev); 482eadcd6b5SGao Xiang int erofs_fiemap(struct inode *inode, struct fiemap_extent_info *fieinfo, 483eadcd6b5SGao Xiang u64 start, u64 len); 48447e4937aSGao Xiang 48547e4937aSGao Xiang /* inode.c */ 48647e4937aSGao Xiang static inline unsigned long erofs_inode_hash(erofs_nid_t nid) 48747e4937aSGao Xiang { 48847e4937aSGao Xiang #if BITS_PER_LONG == 32 48947e4937aSGao Xiang return (nid >> 32) ^ (nid & 0xffffffff); 49047e4937aSGao Xiang #else 49147e4937aSGao Xiang return nid; 49247e4937aSGao Xiang #endif 49347e4937aSGao Xiang } 49447e4937aSGao Xiang 49547e4937aSGao Xiang extern const struct inode_operations erofs_generic_iops; 49647e4937aSGao Xiang extern const struct inode_operations erofs_symlink_iops; 49747e4937aSGao Xiang extern const struct inode_operations erofs_fast_symlink_iops; 49847e4937aSGao Xiang 49947e4937aSGao Xiang struct inode *erofs_iget(struct super_block *sb, erofs_nid_t nid, bool dir); 500549c7297SChristian Brauner int erofs_getattr(struct user_namespace *mnt_userns, const struct path *path, 501549c7297SChristian Brauner struct kstat *stat, u32 request_mask, 502549c7297SChristian Brauner unsigned int query_flags); 50347e4937aSGao Xiang 50447e4937aSGao Xiang /* namei.c */ 50547e4937aSGao Xiang extern const struct inode_operations erofs_dir_iops; 50647e4937aSGao Xiang 50747e4937aSGao Xiang int erofs_namei(struct inode *dir, struct qstr *name, 50847e4937aSGao Xiang erofs_nid_t *nid, unsigned int *d_type); 50947e4937aSGao Xiang 51047e4937aSGao Xiang /* dir.c */ 51147e4937aSGao Xiang extern const struct file_operations erofs_dir_fops; 51247e4937aSGao Xiang 513598162d0SGao Xiang static inline void *erofs_vm_map_ram(struct page **pages, unsigned int count) 514598162d0SGao Xiang { 515598162d0SGao Xiang int retried = 0; 516598162d0SGao Xiang 517598162d0SGao Xiang while (1) { 518598162d0SGao Xiang void *p = vm_map_ram(pages, count, -1); 519598162d0SGao Xiang 520598162d0SGao Xiang /* retry two more times (totally 3 times) */ 521598162d0SGao Xiang if (p || ++retried >= 3) 522598162d0SGao Xiang return p; 523598162d0SGao Xiang vm_unmap_aliases(); 524598162d0SGao Xiang } 525598162d0SGao Xiang return NULL; 526598162d0SGao Xiang } 527598162d0SGao Xiang 52852488734SGao Xiang /* pcpubuf.c */ 52952488734SGao Xiang void *erofs_get_pcpubuf(unsigned int requiredpages); 53052488734SGao Xiang void erofs_put_pcpubuf(void *ptr); 53152488734SGao Xiang int erofs_pcpubuf_growsize(unsigned int nrpages); 53252488734SGao Xiang void erofs_pcpubuf_init(void); 53352488734SGao Xiang void erofs_pcpubuf_exit(void); 53452488734SGao Xiang 535168e9a76SHuang Jianan /* sysfs.c */ 536168e9a76SHuang Jianan int erofs_register_sysfs(struct super_block *sb); 537168e9a76SHuang Jianan void erofs_unregister_sysfs(struct super_block *sb); 538168e9a76SHuang Jianan int __init erofs_init_sysfs(void); 539168e9a76SHuang Jianan void erofs_exit_sysfs(void); 540168e9a76SHuang Jianan 54147e4937aSGao Xiang /* utils.c / zdata.c */ 542eaa9172aSGao Xiang struct page *erofs_allocpage(struct page **pagepool, gfp_t gfp); 543eaa9172aSGao Xiang static inline void erofs_pagepool_add(struct page **pagepool, 544eaa9172aSGao Xiang struct page *page) 545eaa9172aSGao Xiang { 546eaa9172aSGao Xiang set_page_private(page, (unsigned long)*pagepool); 547eaa9172aSGao Xiang *pagepool = page; 548eaa9172aSGao Xiang } 549eaa9172aSGao Xiang void erofs_release_pages(struct page **pagepool); 55047e4937aSGao Xiang 55147e4937aSGao Xiang #ifdef CONFIG_EROFS_FS_ZIP 55247e4937aSGao Xiang int erofs_workgroup_put(struct erofs_workgroup *grp); 55347e4937aSGao Xiang struct erofs_workgroup *erofs_find_workgroup(struct super_block *sb, 554997626d8SVladimir Zapolskiy pgoff_t index); 55564094a04SGao Xiang struct erofs_workgroup *erofs_insert_workgroup(struct super_block *sb, 556e5e9a432SVladimir Zapolskiy struct erofs_workgroup *grp); 55747e4937aSGao Xiang void erofs_workgroup_free_rcu(struct erofs_workgroup *grp); 55847e4937aSGao Xiang void erofs_shrinker_register(struct super_block *sb); 55947e4937aSGao Xiang void erofs_shrinker_unregister(struct super_block *sb); 56047e4937aSGao Xiang int __init erofs_init_shrinker(void); 56147e4937aSGao Xiang void erofs_exit_shrinker(void); 56247e4937aSGao Xiang int __init z_erofs_init_zip_subsystem(void); 56347e4937aSGao Xiang void z_erofs_exit_zip_subsystem(void); 56447e4937aSGao Xiang int erofs_try_to_free_all_cached_pages(struct erofs_sb_info *sbi, 56547e4937aSGao Xiang struct erofs_workgroup *egrp); 566d252ff3dSYue Hu int erofs_try_to_free_cached_page(struct page *page); 5675d50538fSHuang Jianan int z_erofs_load_lz4_config(struct super_block *sb, 56846249cdeSGao Xiang struct erofs_super_block *dsb, 56946249cdeSGao Xiang struct z_erofs_lz4_cfgs *lz4, int len); 57047e4937aSGao Xiang #else 57147e4937aSGao Xiang static inline void erofs_shrinker_register(struct super_block *sb) {} 57247e4937aSGao Xiang static inline void erofs_shrinker_unregister(struct super_block *sb) {} 57347e4937aSGao Xiang static inline int erofs_init_shrinker(void) { return 0; } 57447e4937aSGao Xiang static inline void erofs_exit_shrinker(void) {} 57547e4937aSGao Xiang static inline int z_erofs_init_zip_subsystem(void) { return 0; } 57647e4937aSGao Xiang static inline void z_erofs_exit_zip_subsystem(void) {} 5775d50538fSHuang Jianan static inline int z_erofs_load_lz4_config(struct super_block *sb, 57846249cdeSGao Xiang struct erofs_super_block *dsb, 57946249cdeSGao Xiang struct z_erofs_lz4_cfgs *lz4, int len) 5805d50538fSHuang Jianan { 58114373711SGao Xiang if (lz4 || dsb->u1.lz4_max_distance) { 5825d50538fSHuang Jianan erofs_err(sb, "lz4 algorithm isn't enabled"); 5835d50538fSHuang Jianan return -EINVAL; 5845d50538fSHuang Jianan } 5855d50538fSHuang Jianan return 0; 5865d50538fSHuang Jianan } 58747e4937aSGao Xiang #endif /* !CONFIG_EROFS_FS_ZIP */ 58847e4937aSGao Xiang 589622ceaddSGao Xiang #ifdef CONFIG_EROFS_FS_ZIP_LZMA 590622ceaddSGao Xiang int z_erofs_lzma_init(void); 591622ceaddSGao Xiang void z_erofs_lzma_exit(void); 592622ceaddSGao Xiang int z_erofs_load_lzma_config(struct super_block *sb, 593622ceaddSGao Xiang struct erofs_super_block *dsb, 594622ceaddSGao Xiang struct z_erofs_lzma_cfgs *lzma, int size); 595622ceaddSGao Xiang #else 596622ceaddSGao Xiang static inline int z_erofs_lzma_init(void) { return 0; } 597622ceaddSGao Xiang static inline int z_erofs_lzma_exit(void) { return 0; } 598622ceaddSGao Xiang static inline int z_erofs_load_lzma_config(struct super_block *sb, 599622ceaddSGao Xiang struct erofs_super_block *dsb, 600622ceaddSGao Xiang struct z_erofs_lzma_cfgs *lzma, int size) { 601622ceaddSGao Xiang if (lzma) { 602622ceaddSGao Xiang erofs_err(sb, "lzma algorithm isn't enabled"); 603622ceaddSGao Xiang return -EINVAL; 604622ceaddSGao Xiang } 605622ceaddSGao Xiang return 0; 606622ceaddSGao Xiang } 607622ceaddSGao Xiang #endif /* !CONFIG_EROFS_FS_ZIP */ 608622ceaddSGao Xiang 60947e4937aSGao Xiang #define EFSCORRUPTED EUCLEAN /* Filesystem is corrupted */ 61047e4937aSGao Xiang 61147e4937aSGao Xiang #endif /* __EROFS_INTERNAL_H */ 612