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/magic.h> 1647e4937aSGao Xiang #include <linux/slab.h> 1747e4937aSGao Xiang #include <linux/vmalloc.h> 18eadcd6b5SGao Xiang #include <linux/iomap.h> 1947e4937aSGao Xiang #include "erofs_fs.h" 2047e4937aSGao Xiang 2147e4937aSGao Xiang /* redefine pr_fmt "erofs: " */ 2247e4937aSGao Xiang #undef pr_fmt 2347e4937aSGao Xiang #define pr_fmt(fmt) "erofs: " fmt 2447e4937aSGao Xiang 254f761fa2SGao Xiang __printf(3, 4) void _erofs_err(struct super_block *sb, 264f761fa2SGao Xiang const char *function, const char *fmt, ...); 274f761fa2SGao Xiang #define erofs_err(sb, fmt, ...) \ 284f761fa2SGao Xiang _erofs_err(sb, __func__, fmt "\n", ##__VA_ARGS__) 294f761fa2SGao Xiang __printf(3, 4) void _erofs_info(struct super_block *sb, 304f761fa2SGao Xiang const char *function, const char *fmt, ...); 314f761fa2SGao Xiang #define erofs_info(sb, fmt, ...) \ 324f761fa2SGao Xiang _erofs_info(sb, __func__, fmt "\n", ##__VA_ARGS__) 3347e4937aSGao Xiang #ifdef CONFIG_EROFS_FS_DEBUG 344f761fa2SGao Xiang #define erofs_dbg(x, ...) pr_debug(x "\n", ##__VA_ARGS__) 3547e4937aSGao Xiang #define DBG_BUGON BUG_ON 3647e4937aSGao Xiang #else 374f761fa2SGao Xiang #define erofs_dbg(x, ...) ((void)0) 3847e4937aSGao Xiang #define DBG_BUGON(x) ((void)(x)) 3947e4937aSGao Xiang #endif /* !CONFIG_EROFS_FS_DEBUG */ 4047e4937aSGao Xiang 4147e4937aSGao Xiang /* EROFS_SUPER_MAGIC_V1 to represent the whole file system */ 4247e4937aSGao Xiang #define EROFS_SUPER_MAGIC EROFS_SUPER_MAGIC_V1 4347e4937aSGao Xiang 4447e4937aSGao Xiang typedef u64 erofs_nid_t; 4547e4937aSGao Xiang typedef u64 erofs_off_t; 4647e4937aSGao Xiang /* data type for filesystem-wide blocks number */ 4747e4937aSGao Xiang typedef u32 erofs_blk_t; 4847e4937aSGao Xiang 49dfeab2e9SGao Xiang struct erofs_device_info { 50dfeab2e9SGao Xiang char *path; 51955b478eSJeffle Xu struct erofs_fscache *fscache; 52dfeab2e9SGao Xiang struct block_device *bdev; 53dfeab2e9SGao Xiang struct dax_device *dax_dev; 54cd913c76SChristoph Hellwig u64 dax_part_off; 55dfeab2e9SGao Xiang 56dfeab2e9SGao Xiang u32 blocks; 57dfeab2e9SGao Xiang u32 mapped_blkaddr; 58dfeab2e9SGao Xiang }; 59dfeab2e9SGao Xiang 6040452ffcSHuang Jianan enum { 6140452ffcSHuang Jianan EROFS_SYNC_DECOMPRESS_AUTO, 6240452ffcSHuang Jianan EROFS_SYNC_DECOMPRESS_FORCE_ON, 6340452ffcSHuang Jianan EROFS_SYNC_DECOMPRESS_FORCE_OFF 6440452ffcSHuang Jianan }; 6540452ffcSHuang Jianan 66e6242465SGao Xiang struct erofs_mount_opts { 67f57a3fe4SChao Yu #ifdef CONFIG_EROFS_FS_ZIP 68f57a3fe4SChao Yu /* current strategy of how to use managed cache */ 69f57a3fe4SChao Yu unsigned char cache_strategy; 7040452ffcSHuang Jianan /* strategy of sync decompression (0 - auto, 1 - force on, 2 - force off) */ 7140452ffcSHuang Jianan unsigned int sync_decompress; 72f57a3fe4SChao Yu 73f57a3fe4SChao Yu /* threshold for decompression synchronously */ 74f57a3fe4SChao Yu unsigned int max_sync_decompress_pages; 75f57a3fe4SChao Yu #endif 76f57a3fe4SChao Yu unsigned int mount_opt; 77f57a3fe4SChao Yu }; 78f57a3fe4SChao Yu 79dfeab2e9SGao Xiang struct erofs_dev_context { 80dfeab2e9SGao Xiang struct idr tree; 81dfeab2e9SGao Xiang struct rw_semaphore rwsem; 82dfeab2e9SGao Xiang 83dfeab2e9SGao Xiang unsigned int extra_devices; 84dfeab2e9SGao Xiang }; 85dfeab2e9SGao Xiang 86e6242465SGao Xiang struct erofs_fs_context { 87e6242465SGao Xiang struct erofs_mount_opts opt; 88dfeab2e9SGao Xiang struct erofs_dev_context *devs; 8939bfcb81SJingbo Xu char *fsid; 9039bfcb81SJingbo Xu char *domain_id; 91e6242465SGao Xiang }; 92e6242465SGao Xiang 935d50538fSHuang Jianan /* all filesystem-wide lz4 configurations */ 945d50538fSHuang Jianan struct erofs_sb_lz4_info { 955d50538fSHuang Jianan /* # of pages needed for EROFS lz4 rolling decompression */ 965d50538fSHuang Jianan u16 max_distance_pages; 974fea63f7SGao Xiang /* maximum possible blocks for pclusters in the filesystem */ 984fea63f7SGao Xiang u16 max_pclusterblks; 995d50538fSHuang Jianan }; 1005d50538fSHuang Jianan 1018b7adf1dSJia Zhu struct erofs_domain { 1028b7adf1dSJia Zhu refcount_t ref; 1038b7adf1dSJia Zhu struct list_head list; 1048b7adf1dSJia Zhu struct fscache_volume *volume; 1058b7adf1dSJia Zhu char *domain_id; 1068b7adf1dSJia Zhu }; 1078b7adf1dSJia Zhu 108b02c602fSJeffle Xu struct erofs_fscache { 109b02c602fSJeffle Xu struct fscache_cookie *cookie; 1103c265d7dSJeffle Xu struct inode *inode; 1117d419637SJia Zhu struct inode *anon_inode; 112*2dfb8c3bSJingbo Xu 113*2dfb8c3bSJingbo Xu /* used for share domain mode */ 1147d419637SJia Zhu struct erofs_domain *domain; 115*2dfb8c3bSJingbo Xu struct list_head node; 116*2dfb8c3bSJingbo Xu refcount_t ref; 1177d419637SJia Zhu char *name; 118b02c602fSJeffle Xu }; 119b02c602fSJeffle Xu 12047e4937aSGao Xiang struct erofs_sb_info { 121e6242465SGao Xiang struct erofs_mount_opts opt; /* options */ 12247e4937aSGao Xiang #ifdef CONFIG_EROFS_FS_ZIP 12347e4937aSGao Xiang /* list for all registered superblocks, mainly for shrinker */ 12447e4937aSGao Xiang struct list_head list; 12547e4937aSGao Xiang struct mutex umount_mutex; 12647e4937aSGao Xiang 12764094a04SGao Xiang /* managed XArray arranged in physical block number */ 12864094a04SGao Xiang struct xarray managed_pslots; 12947e4937aSGao Xiang 13047e4937aSGao Xiang unsigned int shrinker_run_no; 13114373711SGao Xiang u16 available_compr_algs; 13247e4937aSGao Xiang 13347e4937aSGao Xiang /* pseudo inode to manage cached pages */ 13447e4937aSGao Xiang struct inode *managed_cache; 1355d50538fSHuang Jianan 1365d50538fSHuang Jianan struct erofs_sb_lz4_info lz4; 137b15b2e30SYue Hu struct inode *packed_inode; 13847e4937aSGao Xiang #endif /* CONFIG_EROFS_FS_ZIP */ 139dfeab2e9SGao Xiang struct erofs_dev_context *devs; 14006252e9cSGao Xiang struct dax_device *dax_dev; 141cd913c76SChristoph Hellwig u64 dax_part_off; 142dfeab2e9SGao Xiang u64 total_blocks; 143dfeab2e9SGao Xiang u32 primarydevice_blocks; 144dfeab2e9SGao Xiang 14547e4937aSGao Xiang u32 meta_blkaddr; 14647e4937aSGao Xiang #ifdef CONFIG_EROFS_FS_XATTR 14747e4937aSGao Xiang u32 xattr_blkaddr; 14847e4937aSGao Xiang #endif 149dfeab2e9SGao Xiang u16 device_id_mask; /* valid bits of device id to be used */ 15047e4937aSGao Xiang 15147e4937aSGao Xiang /* inode slot unit size in bit shift */ 15247e4937aSGao Xiang unsigned char islotbits; 15347e4937aSGao Xiang 15414373711SGao Xiang u32 sb_size; /* total superblock size */ 15547e4937aSGao Xiang u32 build_time_nsec; 15647e4937aSGao Xiang u64 build_time; 15747e4937aSGao Xiang 15847e4937aSGao Xiang /* what we really care is nid, rather than ino.. */ 15947e4937aSGao Xiang erofs_nid_t root_nid; 16047e4937aSGao Xiang /* used for statfs, f_files - f_favail */ 16147e4937aSGao Xiang u64 inos; 16247e4937aSGao Xiang 16347e4937aSGao Xiang u8 uuid[16]; /* 128-bit uuid for volume */ 16447e4937aSGao Xiang u8 volume_name[16]; /* volume name */ 165b858a484SPratik Shinde u32 feature_compat; 166426a9308SGao Xiang u32 feature_incompat; 167168e9a76SHuang Jianan 168168e9a76SHuang Jianan /* sysfs support */ 169168e9a76SHuang Jianan struct kobject s_kobj; /* /sys/fs/erofs/<devname> */ 170168e9a76SHuang Jianan struct completion s_kobj_unregister; 171c6be2bd0SJeffle Xu 172c6be2bd0SJeffle Xu /* fscache support */ 173c6be2bd0SJeffle Xu struct fscache_volume *volume; 17437c90c5fSJeffle Xu struct erofs_fscache *s_fscache; 1758b7adf1dSJia Zhu struct erofs_domain *domain; 17639bfcb81SJingbo Xu char *fsid; 17739bfcb81SJingbo Xu char *domain_id; 17847e4937aSGao Xiang }; 17947e4937aSGao Xiang 18047e4937aSGao Xiang #define EROFS_SB(sb) ((struct erofs_sb_info *)(sb)->s_fs_info) 18147e4937aSGao Xiang #define EROFS_I_SB(inode) ((struct erofs_sb_info *)(inode)->i_sb->s_fs_info) 18247e4937aSGao Xiang 18347e4937aSGao Xiang /* Mount flags set via mount options or defaults */ 18447e4937aSGao Xiang #define EROFS_MOUNT_XATTR_USER 0x00000010 18547e4937aSGao Xiang #define EROFS_MOUNT_POSIX_ACL 0x00000020 18606252e9cSGao Xiang #define EROFS_MOUNT_DAX_ALWAYS 0x00000040 18706252e9cSGao Xiang #define EROFS_MOUNT_DAX_NEVER 0x00000080 18847e4937aSGao Xiang 189e6242465SGao Xiang #define clear_opt(opt, option) ((opt)->mount_opt &= ~EROFS_MOUNT_##option) 190e6242465SGao Xiang #define set_opt(opt, option) ((opt)->mount_opt |= EROFS_MOUNT_##option) 191e6242465SGao Xiang #define test_opt(opt, option) ((opt)->mount_opt & EROFS_MOUNT_##option) 19247e4937aSGao Xiang 19393b856bbSJeffle Xu static inline bool erofs_is_fscache_mode(struct super_block *sb) 19493b856bbSJeffle Xu { 19593b856bbSJeffle Xu return IS_ENABLED(CONFIG_EROFS_FS_ONDEMAND) && !sb->s_bdev; 19693b856bbSJeffle Xu } 19793b856bbSJeffle Xu 19847e4937aSGao Xiang enum { 19947e4937aSGao Xiang EROFS_ZIP_CACHE_DISABLED, 20047e4937aSGao Xiang EROFS_ZIP_CACHE_READAHEAD, 20147e4937aSGao Xiang EROFS_ZIP_CACHE_READAROUND 20247e4937aSGao Xiang }; 20347e4937aSGao Xiang 20447e4937aSGao Xiang #define EROFS_LOCKED_MAGIC (INT_MIN | 0xE0F510CCL) 20547e4937aSGao Xiang 20647e4937aSGao Xiang /* basic unit of the workstation of a super_block */ 20747e4937aSGao Xiang struct erofs_workgroup { 20847e4937aSGao Xiang /* the workgroup index in the workstation */ 20947e4937aSGao Xiang pgoff_t index; 21047e4937aSGao Xiang 21147e4937aSGao Xiang /* overall workgroup reference count */ 21247e4937aSGao Xiang atomic_t refcount; 21347e4937aSGao Xiang }; 21447e4937aSGao Xiang 21547e4937aSGao Xiang static inline bool erofs_workgroup_try_to_freeze(struct erofs_workgroup *grp, 21647e4937aSGao Xiang int val) 21747e4937aSGao Xiang { 21847e4937aSGao Xiang preempt_disable(); 21947e4937aSGao Xiang if (val != atomic_cmpxchg(&grp->refcount, val, EROFS_LOCKED_MAGIC)) { 22047e4937aSGao Xiang preempt_enable(); 22147e4937aSGao Xiang return false; 22247e4937aSGao Xiang } 22347e4937aSGao Xiang return true; 22447e4937aSGao Xiang } 22547e4937aSGao Xiang 22647e4937aSGao Xiang static inline void erofs_workgroup_unfreeze(struct erofs_workgroup *grp, 22747e4937aSGao Xiang int orig_val) 22847e4937aSGao Xiang { 22947e4937aSGao Xiang /* 23047e4937aSGao Xiang * other observers should notice all modifications 23147e4937aSGao Xiang * in the freezing period. 23247e4937aSGao Xiang */ 23347e4937aSGao Xiang smp_mb(); 23447e4937aSGao Xiang atomic_set(&grp->refcount, orig_val); 23547e4937aSGao Xiang preempt_enable(); 23647e4937aSGao Xiang } 23747e4937aSGao Xiang 23847e4937aSGao Xiang static inline int erofs_wait_on_workgroup_freezed(struct erofs_workgroup *grp) 23947e4937aSGao Xiang { 24047e4937aSGao Xiang return atomic_cond_read_relaxed(&grp->refcount, 24147e4937aSGao Xiang VAL != EROFS_LOCKED_MAGIC); 24247e4937aSGao Xiang } 24347e4937aSGao Xiang 24447e4937aSGao Xiang /* we strictly follow PAGE_SIZE and no buffer head yet */ 24547e4937aSGao Xiang #define LOG_BLOCK_SIZE PAGE_SHIFT 24647e4937aSGao Xiang 24747e4937aSGao Xiang #undef LOG_SECTORS_PER_BLOCK 24847e4937aSGao Xiang #define LOG_SECTORS_PER_BLOCK (PAGE_SHIFT - 9) 24947e4937aSGao Xiang 25047e4937aSGao Xiang #undef SECTORS_PER_BLOCK 25147e4937aSGao Xiang #define SECTORS_PER_BLOCK (1 << SECTORS_PER_BLOCK) 25247e4937aSGao Xiang 25347e4937aSGao Xiang #define EROFS_BLKSIZ (1 << LOG_BLOCK_SIZE) 25447e4937aSGao Xiang 25547e4937aSGao Xiang #if (EROFS_BLKSIZ % 4096 || !EROFS_BLKSIZ) 25647e4937aSGao Xiang #error erofs cannot be used in this platform 25747e4937aSGao Xiang #endif 25847e4937aSGao Xiang 259fdf80a47SGao Xiang enum erofs_kmap_type { 260fdf80a47SGao Xiang EROFS_NO_KMAP, /* don't map the buffer */ 261927e5010SGao Xiang EROFS_KMAP, /* use kmap_local_page() to map the buffer */ 262fdf80a47SGao Xiang }; 263fdf80a47SGao Xiang 264fdf80a47SGao Xiang struct erofs_buf { 265fdf80a47SGao Xiang struct page *page; 266fdf80a47SGao Xiang void *base; 267fdf80a47SGao Xiang enum erofs_kmap_type kmap_type; 268fdf80a47SGao Xiang }; 269fdf80a47SGao Xiang #define __EROFS_BUF_INITIALIZER ((struct erofs_buf){ .page = NULL }) 270fdf80a47SGao Xiang 27147e4937aSGao Xiang #define ROOT_NID(sb) ((sb)->root_nid) 27247e4937aSGao Xiang 27347e4937aSGao Xiang #define erofs_blknr(addr) ((addr) / EROFS_BLKSIZ) 27447e4937aSGao Xiang #define erofs_blkoff(addr) ((addr) % EROFS_BLKSIZ) 27547e4937aSGao Xiang #define blknr_to_addr(nr) ((erofs_off_t)(nr) * EROFS_BLKSIZ) 27647e4937aSGao Xiang 277de06a6a3SGao Xiang #define EROFS_FEATURE_FUNCS(name, compat, feature) \ 278de06a6a3SGao Xiang static inline bool erofs_sb_has_##name(struct erofs_sb_info *sbi) \ 279de06a6a3SGao Xiang { \ 280de06a6a3SGao Xiang return sbi->feature_##compat & EROFS_FEATURE_##feature; \ 281de06a6a3SGao Xiang } 282de06a6a3SGao Xiang 2837e508f2cSHuang Jianan EROFS_FEATURE_FUNCS(zero_padding, incompat, INCOMPAT_ZERO_PADDING) 28414373711SGao Xiang EROFS_FEATURE_FUNCS(compr_cfgs, incompat, INCOMPAT_COMPR_CFGS) 2855404c330SGao Xiang EROFS_FEATURE_FUNCS(big_pcluster, incompat, INCOMPAT_BIG_PCLUSTER) 286168e9a76SHuang Jianan EROFS_FEATURE_FUNCS(chunked_file, incompat, INCOMPAT_CHUNKED_FILE) 287dfeab2e9SGao Xiang EROFS_FEATURE_FUNCS(device_table, incompat, INCOMPAT_DEVICE_TABLE) 288168e9a76SHuang Jianan EROFS_FEATURE_FUNCS(compr_head2, incompat, INCOMPAT_COMPR_HEAD2) 289ab92184fSYue Hu EROFS_FEATURE_FUNCS(ztailpacking, incompat, INCOMPAT_ZTAILPACKING) 290b15b2e30SYue Hu EROFS_FEATURE_FUNCS(fragments, incompat, INCOMPAT_FRAGMENTS) 2915c2a6425SGao Xiang EROFS_FEATURE_FUNCS(dedupe, incompat, INCOMPAT_DEDUPE) 292de06a6a3SGao Xiang EROFS_FEATURE_FUNCS(sb_chksum, compat, COMPAT_SB_CHKSUM) 293de06a6a3SGao Xiang 29447e4937aSGao Xiang /* atomic flag definitions */ 295a5876e24SGao Xiang #define EROFS_I_EA_INITED_BIT 0 296a5876e24SGao Xiang #define EROFS_I_Z_INITED_BIT 1 29747e4937aSGao Xiang 29847e4937aSGao Xiang /* bitlock definitions (arranged in reverse order) */ 299a5876e24SGao Xiang #define EROFS_I_BL_XATTR_BIT (BITS_PER_LONG - 1) 300a5876e24SGao Xiang #define EROFS_I_BL_Z_BIT (BITS_PER_LONG - 2) 30147e4937aSGao Xiang 302a5876e24SGao Xiang struct erofs_inode { 30347e4937aSGao Xiang erofs_nid_t nid; 30447e4937aSGao Xiang 30547e4937aSGao Xiang /* atomic flags (including bitlocks) */ 30647e4937aSGao Xiang unsigned long flags; 30747e4937aSGao Xiang 3088a765682SGao Xiang unsigned char datalayout; 30947e4937aSGao Xiang unsigned char inode_isize; 31047e4937aSGao Xiang unsigned short xattr_isize; 31147e4937aSGao Xiang 31247e4937aSGao Xiang unsigned int xattr_shared_count; 31347e4937aSGao Xiang unsigned int *xattr_shared_xattrs; 31447e4937aSGao Xiang 31547e4937aSGao Xiang union { 31647e4937aSGao Xiang erofs_blk_t raw_blkaddr; 317c5aa903aSGao Xiang struct { 318c5aa903aSGao Xiang unsigned short chunkformat; 319c5aa903aSGao Xiang unsigned char chunkbits; 320c5aa903aSGao Xiang }; 32147e4937aSGao Xiang #ifdef CONFIG_EROFS_FS_ZIP 32247e4937aSGao Xiang struct { 32347e4937aSGao Xiang unsigned short z_advise; 32447e4937aSGao Xiang unsigned char z_algorithmtype[2]; 32547e4937aSGao Xiang unsigned char z_logical_clusterbits; 326ab92184fSYue Hu unsigned long z_tailextent_headlcn; 327b15b2e30SYue Hu union { 328b15b2e30SYue Hu struct { 32922ba5e99SGao Xiang erofs_off_t z_idataoff; 330ab92184fSYue Hu unsigned short z_idata_size; 33147e4937aSGao Xiang }; 332b15b2e30SYue Hu erofs_off_t z_fragmentoff; 333b15b2e30SYue Hu }; 334b15b2e30SYue Hu }; 33547e4937aSGao Xiang #endif /* CONFIG_EROFS_FS_ZIP */ 33647e4937aSGao Xiang }; 33747e4937aSGao Xiang /* the corresponding vfs inode */ 33847e4937aSGao Xiang struct inode vfs_inode; 33947e4937aSGao Xiang }; 34047e4937aSGao Xiang 341b780d3fcSGao Xiang #define EROFS_I(ptr) container_of(ptr, struct erofs_inode, vfs_inode) 342b780d3fcSGao Xiang 343b780d3fcSGao Xiang static inline erofs_off_t erofs_iloc(struct inode *inode) 344b780d3fcSGao Xiang { 345b780d3fcSGao Xiang struct erofs_sb_info *sbi = EROFS_I_SB(inode); 346b780d3fcSGao Xiang 347b780d3fcSGao Xiang return blknr_to_addr(sbi->meta_blkaddr) + 348b780d3fcSGao Xiang (EROFS_I(inode)->nid << sbi->islotbits); 349b780d3fcSGao Xiang } 35047e4937aSGao Xiang 3518a765682SGao Xiang static inline unsigned int erofs_bitrange(unsigned int value, unsigned int bit, 3528a765682SGao Xiang unsigned int bits) 35347e4937aSGao Xiang { 3548a765682SGao Xiang 3558a765682SGao Xiang return (value >> bit) & ((1 << bits) - 1); 35647e4937aSGao Xiang } 35747e4937aSGao Xiang 3588a765682SGao Xiang 3598a765682SGao Xiang static inline unsigned int erofs_inode_version(unsigned int value) 36047e4937aSGao Xiang { 3618a765682SGao Xiang return erofs_bitrange(value, EROFS_I_VERSION_BIT, 3628a765682SGao Xiang EROFS_I_VERSION_BITS); 3638a765682SGao Xiang } 3648a765682SGao Xiang 3658a765682SGao Xiang static inline unsigned int erofs_inode_datalayout(unsigned int value) 3668a765682SGao Xiang { 3678a765682SGao Xiang return erofs_bitrange(value, EROFS_I_DATALAYOUT_BIT, 3688a765682SGao Xiang EROFS_I_DATALAYOUT_BITS); 36947e4937aSGao Xiang } 37047e4937aSGao Xiang 37138629291SGao Xiang /* 37238629291SGao Xiang * Different from grab_cache_page_nowait(), reclaiming is never triggered 37338629291SGao Xiang * when allocating new pages. 37438629291SGao Xiang */ 37538629291SGao Xiang static inline 37638629291SGao Xiang struct page *erofs_grab_cache_page_nowait(struct address_space *mapping, 37738629291SGao Xiang pgoff_t index) 37838629291SGao Xiang { 37938629291SGao Xiang return pagecache_get_page(mapping, index, 38038629291SGao Xiang FGP_LOCK|FGP_CREAT|FGP_NOFS|FGP_NOWAIT, 38138629291SGao Xiang readahead_gfp_mask(mapping) & ~__GFP_RECLAIM); 38238629291SGao Xiang } 38338629291SGao Xiang 38447e4937aSGao Xiang /* Has a disk mapping */ 385768bb10aSGao Xiang #define EROFS_MAP_MAPPED 0x0001 38647e4937aSGao Xiang /* Located in metadata (could be copied from bd_inode) */ 387768bb10aSGao Xiang #define EROFS_MAP_META 0x0002 3888f899262SGao Xiang /* The extent is encoded */ 389768bb10aSGao Xiang #define EROFS_MAP_ENCODED 0x0004 39047e4937aSGao Xiang /* The length of extent is full */ 391768bb10aSGao Xiang #define EROFS_MAP_FULL_MAPPED 0x0008 392b15b2e30SYue Hu /* Located in the special packed inode */ 393768bb10aSGao Xiang #define EROFS_MAP_FRAGMENT 0x0010 3945c2a6425SGao Xiang /* The extent refers to partial decompressed data */ 395768bb10aSGao Xiang #define EROFS_MAP_PARTIAL_REF 0x0020 39647e4937aSGao Xiang 39747e4937aSGao Xiang struct erofs_map_blocks { 39809c54379SGao Xiang struct erofs_buf buf; 39909c54379SGao Xiang 40047e4937aSGao Xiang erofs_off_t m_pa, m_la; 40147e4937aSGao Xiang u64 m_plen, m_llen; 40247e4937aSGao Xiang 403dfeab2e9SGao Xiang unsigned short m_deviceid; 4048f899262SGao Xiang char m_algorithmformat; 40547e4937aSGao Xiang unsigned int m_flags; 40647e4937aSGao Xiang }; 40747e4937aSGao Xiang 408d95ae5e2SGao Xiang /* 409d95ae5e2SGao Xiang * Used to get the exact decompressed length, e.g. fiemap (consider lookback 410d95ae5e2SGao Xiang * approach instead if possible since it's more metadata lightweight.) 411d95ae5e2SGao Xiang */ 4128b58f9f0SJingbo Xu #define EROFS_GET_BLOCKS_FIEMAP 0x0001 413622ceaddSGao Xiang /* Used to map the whole extent if non-negligible data is requested for LZMA */ 4148b58f9f0SJingbo Xu #define EROFS_GET_BLOCKS_READMORE 0x0002 415b15b2e30SYue Hu /* Used to map tail extent for tailpacking inline or fragment pcluster */ 4168b58f9f0SJingbo Xu #define EROFS_GET_BLOCKS_FINDTAIL 0x0004 41747e4937aSGao Xiang 4188f899262SGao Xiang enum { 4198f899262SGao Xiang Z_EROFS_COMPRESSION_SHIFTED = Z_EROFS_COMPRESSION_MAX, 420fdffc091SYue Hu Z_EROFS_COMPRESSION_INTERLACED, 4218f899262SGao Xiang Z_EROFS_COMPRESSION_RUNTIME_MAX 4228f899262SGao Xiang }; 4238f899262SGao Xiang 424dfeab2e9SGao Xiang struct erofs_map_dev { 425955b478eSJeffle Xu struct erofs_fscache *m_fscache; 426dfeab2e9SGao Xiang struct block_device *m_bdev; 427dfeab2e9SGao Xiang struct dax_device *m_daxdev; 428de205114SChristoph Hellwig u64 m_dax_part_off; 429dfeab2e9SGao Xiang 430dfeab2e9SGao Xiang erofs_off_t m_pa; 431dfeab2e9SGao Xiang unsigned int m_deviceid; 432dfeab2e9SGao Xiang }; 433dfeab2e9SGao Xiang 434557afdd9SGao Xiang extern struct file_system_type erofs_fs_type; 435557afdd9SGao Xiang extern const struct super_operations erofs_sops; 436557afdd9SGao Xiang 437557afdd9SGao Xiang extern const struct address_space_operations erofs_raw_access_aops; 438557afdd9SGao Xiang extern const struct address_space_operations z_erofs_aops; 439557afdd9SGao Xiang extern const struct address_space_operations erofs_fscache_access_aops; 440557afdd9SGao Xiang 441557afdd9SGao Xiang extern const struct inode_operations erofs_generic_iops; 442557afdd9SGao Xiang extern const struct inode_operations erofs_symlink_iops; 443557afdd9SGao Xiang extern const struct inode_operations erofs_fast_symlink_iops; 444557afdd9SGao Xiang extern const struct inode_operations erofs_dir_iops; 445557afdd9SGao Xiang 446a08e67a0SHuang Jianan extern const struct file_operations erofs_file_fops; 447557afdd9SGao Xiang extern const struct file_operations erofs_dir_fops; 448557afdd9SGao Xiang 449557afdd9SGao Xiang extern const struct iomap_ops z_erofs_iomap_report_ops; 450557afdd9SGao Xiang 451557afdd9SGao Xiang /* flags for erofs_fscache_register_cookie() */ 452557afdd9SGao Xiang #define EROFS_REG_COOKIE_NEED_INODE 1 453557afdd9SGao Xiang #define EROFS_REG_COOKIE_NEED_NOEXIST 2 454557afdd9SGao Xiang 45509c54379SGao Xiang void erofs_unmap_metabuf(struct erofs_buf *buf); 456c521e3adSGao Xiang void erofs_put_metabuf(struct erofs_buf *buf); 457fe5de585SGao Xiang void *erofs_bread(struct erofs_buf *buf, struct inode *inode, 458fe5de585SGao Xiang erofs_blk_t blkaddr, enum erofs_kmap_type type); 459c521e3adSGao Xiang void *erofs_read_metabuf(struct erofs_buf *buf, struct super_block *sb, 460c521e3adSGao Xiang erofs_blk_t blkaddr, enum erofs_kmap_type type); 461dfeab2e9SGao Xiang int erofs_map_dev(struct super_block *sb, struct erofs_map_dev *dev); 462eadcd6b5SGao Xiang int erofs_fiemap(struct inode *inode, struct fiemap_extent_info *fieinfo, 463eadcd6b5SGao Xiang u64 start, u64 len); 4648b58f9f0SJingbo Xu int erofs_map_blocks(struct inode *inode, struct erofs_map_blocks *map); 465312fe643SGao Xiang struct inode *erofs_iget(struct super_block *sb, erofs_nid_t nid); 466549c7297SChristian Brauner int erofs_getattr(struct user_namespace *mnt_userns, const struct path *path, 467549c7297SChristian Brauner struct kstat *stat, u32 request_mask, 468549c7297SChristian Brauner unsigned int query_flags); 4693e917cc3SHongnan Li int erofs_namei(struct inode *dir, const struct qstr *name, 47047e4937aSGao Xiang erofs_nid_t *nid, unsigned int *d_type); 47147e4937aSGao Xiang 472598162d0SGao Xiang static inline void *erofs_vm_map_ram(struct page **pages, unsigned int count) 473598162d0SGao Xiang { 474598162d0SGao Xiang int retried = 0; 475598162d0SGao Xiang 476598162d0SGao Xiang while (1) { 477598162d0SGao Xiang void *p = vm_map_ram(pages, count, -1); 478598162d0SGao Xiang 479598162d0SGao Xiang /* retry two more times (totally 3 times) */ 480598162d0SGao Xiang if (p || ++retried >= 3) 481598162d0SGao Xiang return p; 482598162d0SGao Xiang vm_unmap_aliases(); 483598162d0SGao Xiang } 484598162d0SGao Xiang return NULL; 485598162d0SGao Xiang } 486598162d0SGao Xiang 48752488734SGao Xiang void *erofs_get_pcpubuf(unsigned int requiredpages); 48852488734SGao Xiang void erofs_put_pcpubuf(void *ptr); 48952488734SGao Xiang int erofs_pcpubuf_growsize(unsigned int nrpages); 49052488734SGao Xiang void erofs_pcpubuf_init(void); 49152488734SGao Xiang void erofs_pcpubuf_exit(void); 49252488734SGao Xiang 493168e9a76SHuang Jianan int erofs_register_sysfs(struct super_block *sb); 494168e9a76SHuang Jianan void erofs_unregister_sysfs(struct super_block *sb); 495168e9a76SHuang Jianan int __init erofs_init_sysfs(void); 496168e9a76SHuang Jianan void erofs_exit_sysfs(void); 497168e9a76SHuang Jianan 498eaa9172aSGao Xiang struct page *erofs_allocpage(struct page **pagepool, gfp_t gfp); 499557afdd9SGao Xiang static inline void erofs_pagepool_add(struct page **pagepool, struct page *page) 500eaa9172aSGao Xiang { 501eaa9172aSGao Xiang set_page_private(page, (unsigned long)*pagepool); 502eaa9172aSGao Xiang *pagepool = page; 503eaa9172aSGao Xiang } 504eaa9172aSGao Xiang void erofs_release_pages(struct page **pagepool); 50547e4937aSGao Xiang 50647e4937aSGao Xiang #ifdef CONFIG_EROFS_FS_ZIP 50747e4937aSGao Xiang int erofs_workgroup_put(struct erofs_workgroup *grp); 50847e4937aSGao Xiang struct erofs_workgroup *erofs_find_workgroup(struct super_block *sb, 509997626d8SVladimir Zapolskiy pgoff_t index); 51064094a04SGao Xiang struct erofs_workgroup *erofs_insert_workgroup(struct super_block *sb, 511e5e9a432SVladimir Zapolskiy struct erofs_workgroup *grp); 51247e4937aSGao Xiang void erofs_workgroup_free_rcu(struct erofs_workgroup *grp); 51347e4937aSGao Xiang void erofs_shrinker_register(struct super_block *sb); 51447e4937aSGao Xiang void erofs_shrinker_unregister(struct super_block *sb); 51547e4937aSGao Xiang int __init erofs_init_shrinker(void); 51647e4937aSGao Xiang void erofs_exit_shrinker(void); 51747e4937aSGao Xiang int __init z_erofs_init_zip_subsystem(void); 51847e4937aSGao Xiang void z_erofs_exit_zip_subsystem(void); 51947e4937aSGao Xiang int erofs_try_to_free_all_cached_pages(struct erofs_sb_info *sbi, 52047e4937aSGao Xiang struct erofs_workgroup *egrp); 521d252ff3dSYue Hu int erofs_try_to_free_cached_page(struct page *page); 5225d50538fSHuang Jianan int z_erofs_load_lz4_config(struct super_block *sb, 52346249cdeSGao Xiang struct erofs_super_block *dsb, 52446249cdeSGao Xiang struct z_erofs_lz4_cfgs *lz4, int len); 525557afdd9SGao Xiang int z_erofs_fill_inode(struct inode *inode); 526557afdd9SGao Xiang int z_erofs_map_blocks_iter(struct inode *inode, struct erofs_map_blocks *map, 527557afdd9SGao Xiang int flags); 52847e4937aSGao Xiang #else 52947e4937aSGao Xiang static inline void erofs_shrinker_register(struct super_block *sb) {} 53047e4937aSGao Xiang static inline void erofs_shrinker_unregister(struct super_block *sb) {} 53147e4937aSGao Xiang static inline int erofs_init_shrinker(void) { return 0; } 53247e4937aSGao Xiang static inline void erofs_exit_shrinker(void) {} 53347e4937aSGao Xiang static inline int z_erofs_init_zip_subsystem(void) { return 0; } 53447e4937aSGao Xiang static inline void z_erofs_exit_zip_subsystem(void) {} 5355d50538fSHuang Jianan static inline int z_erofs_load_lz4_config(struct super_block *sb, 53646249cdeSGao Xiang struct erofs_super_block *dsb, 53746249cdeSGao Xiang struct z_erofs_lz4_cfgs *lz4, int len) 5385d50538fSHuang Jianan { 53914373711SGao Xiang if (lz4 || dsb->u1.lz4_max_distance) { 5405d50538fSHuang Jianan erofs_err(sb, "lz4 algorithm isn't enabled"); 5415d50538fSHuang Jianan return -EINVAL; 5425d50538fSHuang Jianan } 5435d50538fSHuang Jianan return 0; 5445d50538fSHuang Jianan } 545557afdd9SGao Xiang static inline int z_erofs_fill_inode(struct inode *inode) { return -EOPNOTSUPP; } 54647e4937aSGao Xiang #endif /* !CONFIG_EROFS_FS_ZIP */ 54747e4937aSGao Xiang 548622ceaddSGao Xiang #ifdef CONFIG_EROFS_FS_ZIP_LZMA 549622ceaddSGao Xiang int z_erofs_lzma_init(void); 550622ceaddSGao Xiang void z_erofs_lzma_exit(void); 551622ceaddSGao Xiang int z_erofs_load_lzma_config(struct super_block *sb, 552622ceaddSGao Xiang struct erofs_super_block *dsb, 553622ceaddSGao Xiang struct z_erofs_lzma_cfgs *lzma, int size); 554622ceaddSGao Xiang #else 555622ceaddSGao Xiang static inline int z_erofs_lzma_init(void) { return 0; } 556622ceaddSGao Xiang static inline int z_erofs_lzma_exit(void) { return 0; } 557622ceaddSGao Xiang static inline int z_erofs_load_lzma_config(struct super_block *sb, 558622ceaddSGao Xiang struct erofs_super_block *dsb, 559622ceaddSGao Xiang struct z_erofs_lzma_cfgs *lzma, int size) { 560622ceaddSGao Xiang if (lzma) { 561622ceaddSGao Xiang erofs_err(sb, "lzma algorithm isn't enabled"); 562622ceaddSGao Xiang return -EINVAL; 563622ceaddSGao Xiang } 564622ceaddSGao Xiang return 0; 565622ceaddSGao Xiang } 566557afdd9SGao Xiang #endif /* !CONFIG_EROFS_FS_ZIP_LZMA */ 567622ceaddSGao Xiang 568c6be2bd0SJeffle Xu #ifdef CONFIG_EROFS_FS_ONDEMAND 569c6be2bd0SJeffle Xu int erofs_fscache_register_fs(struct super_block *sb); 570c6be2bd0SJeffle Xu void erofs_fscache_unregister_fs(struct super_block *sb); 571b02c602fSJeffle Xu 572e1de2da0SJia Zhu struct erofs_fscache *erofs_fscache_register_cookie(struct super_block *sb, 573557afdd9SGao Xiang char *name, unsigned int flags); 574e1de2da0SJia Zhu void erofs_fscache_unregister_cookie(struct erofs_fscache *fscache); 575c6be2bd0SJeffle Xu #else 576c6be2bd0SJeffle Xu static inline int erofs_fscache_register_fs(struct super_block *sb) 577c6be2bd0SJeffle Xu { 578e1de2da0SJia Zhu return -EOPNOTSUPP; 579c6be2bd0SJeffle Xu } 580c6be2bd0SJeffle Xu static inline void erofs_fscache_unregister_fs(struct super_block *sb) {} 581b02c602fSJeffle Xu 582e1de2da0SJia Zhu static inline 583e1de2da0SJia Zhu struct erofs_fscache *erofs_fscache_register_cookie(struct super_block *sb, 584557afdd9SGao Xiang char *name, unsigned int flags) 585b02c602fSJeffle Xu { 586e1de2da0SJia Zhu return ERR_PTR(-EOPNOTSUPP); 587b02c602fSJeffle Xu } 588b02c602fSJeffle Xu 589e1de2da0SJia Zhu static inline void erofs_fscache_unregister_cookie(struct erofs_fscache *fscache) 590b02c602fSJeffle Xu { 591b02c602fSJeffle Xu } 592c6be2bd0SJeffle Xu #endif 593c6be2bd0SJeffle Xu 59447e4937aSGao Xiang #define EFSCORRUPTED EUCLEAN /* Filesystem is corrupted */ 59547e4937aSGao Xiang 59647e4937aSGao Xiang #endif /* __EROFS_INTERNAL_H */ 597