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; 52955b478eSJeffle Xu struct erofs_fscache *fscache; 53dfeab2e9SGao Xiang struct block_device *bdev; 54dfeab2e9SGao Xiang struct dax_device *dax_dev; 55cd913c76SChristoph Hellwig u64 dax_part_off; 56dfeab2e9SGao Xiang 57dfeab2e9SGao Xiang u32 blocks; 58dfeab2e9SGao Xiang u32 mapped_blkaddr; 59dfeab2e9SGao Xiang }; 60dfeab2e9SGao Xiang 6140452ffcSHuang Jianan enum { 6240452ffcSHuang Jianan EROFS_SYNC_DECOMPRESS_AUTO, 6340452ffcSHuang Jianan EROFS_SYNC_DECOMPRESS_FORCE_ON, 6440452ffcSHuang Jianan EROFS_SYNC_DECOMPRESS_FORCE_OFF 6540452ffcSHuang Jianan }; 6640452ffcSHuang Jianan 67e6242465SGao Xiang struct erofs_mount_opts { 68f57a3fe4SChao Yu #ifdef CONFIG_EROFS_FS_ZIP 69f57a3fe4SChao Yu /* current strategy of how to use managed cache */ 70f57a3fe4SChao Yu unsigned char cache_strategy; 7140452ffcSHuang Jianan /* strategy of sync decompression (0 - auto, 1 - force on, 2 - force off) */ 7240452ffcSHuang Jianan unsigned int sync_decompress; 73f57a3fe4SChao Yu 74f57a3fe4SChao Yu /* threshold for decompression synchronously */ 75f57a3fe4SChao Yu unsigned int max_sync_decompress_pages; 76f57a3fe4SChao Yu #endif 77f57a3fe4SChao Yu unsigned int mount_opt; 78c6be2bd0SJeffle Xu char *fsid; 798b7adf1dSJia Zhu char *domain_id; 80f57a3fe4SChao Yu }; 81f57a3fe4SChao Yu 82dfeab2e9SGao Xiang struct erofs_dev_context { 83dfeab2e9SGao Xiang struct idr tree; 84dfeab2e9SGao Xiang struct rw_semaphore rwsem; 85dfeab2e9SGao Xiang 86dfeab2e9SGao Xiang unsigned int extra_devices; 87dfeab2e9SGao Xiang }; 88dfeab2e9SGao Xiang 89e6242465SGao Xiang struct erofs_fs_context { 90e6242465SGao Xiang struct erofs_mount_opts opt; 91dfeab2e9SGao Xiang struct erofs_dev_context *devs; 92e6242465SGao Xiang }; 93e6242465SGao Xiang 945d50538fSHuang Jianan /* all filesystem-wide lz4 configurations */ 955d50538fSHuang Jianan struct erofs_sb_lz4_info { 965d50538fSHuang Jianan /* # of pages needed for EROFS lz4 rolling decompression */ 975d50538fSHuang Jianan u16 max_distance_pages; 984fea63f7SGao Xiang /* maximum possible blocks for pclusters in the filesystem */ 994fea63f7SGao Xiang u16 max_pclusterblks; 1005d50538fSHuang Jianan }; 1015d50538fSHuang Jianan 1028b7adf1dSJia Zhu struct erofs_domain { 1038b7adf1dSJia Zhu refcount_t ref; 1048b7adf1dSJia Zhu struct list_head list; 1058b7adf1dSJia Zhu struct fscache_volume *volume; 1068b7adf1dSJia Zhu char *domain_id; 1078b7adf1dSJia Zhu }; 1088b7adf1dSJia Zhu 109b02c602fSJeffle Xu struct erofs_fscache { 110b02c602fSJeffle Xu struct fscache_cookie *cookie; 1113c265d7dSJeffle Xu struct inode *inode; 1127d419637SJia Zhu struct inode *anon_inode; 1137d419637SJia Zhu struct erofs_domain *domain; 1147d419637SJia Zhu char *name; 115b02c602fSJeffle Xu }; 116b02c602fSJeffle Xu 11747e4937aSGao Xiang struct erofs_sb_info { 118e6242465SGao Xiang struct erofs_mount_opts opt; /* options */ 11947e4937aSGao Xiang #ifdef CONFIG_EROFS_FS_ZIP 12047e4937aSGao Xiang /* list for all registered superblocks, mainly for shrinker */ 12147e4937aSGao Xiang struct list_head list; 12247e4937aSGao Xiang struct mutex umount_mutex; 12347e4937aSGao Xiang 12464094a04SGao Xiang /* managed XArray arranged in physical block number */ 12564094a04SGao Xiang struct xarray managed_pslots; 12647e4937aSGao Xiang 12747e4937aSGao Xiang unsigned int shrinker_run_no; 12814373711SGao Xiang u16 available_compr_algs; 12947e4937aSGao Xiang 13047e4937aSGao Xiang /* pseudo inode to manage cached pages */ 13147e4937aSGao Xiang struct inode *managed_cache; 1325d50538fSHuang Jianan 1335d50538fSHuang Jianan struct erofs_sb_lz4_info lz4; 134b15b2e30SYue Hu struct inode *packed_inode; 13547e4937aSGao Xiang #endif /* CONFIG_EROFS_FS_ZIP */ 136dfeab2e9SGao Xiang struct erofs_dev_context *devs; 13706252e9cSGao Xiang struct dax_device *dax_dev; 138cd913c76SChristoph Hellwig u64 dax_part_off; 139dfeab2e9SGao Xiang u64 total_blocks; 140dfeab2e9SGao Xiang u32 primarydevice_blocks; 141dfeab2e9SGao Xiang 14247e4937aSGao Xiang u32 meta_blkaddr; 14347e4937aSGao Xiang #ifdef CONFIG_EROFS_FS_XATTR 14447e4937aSGao Xiang u32 xattr_blkaddr; 14547e4937aSGao Xiang #endif 146dfeab2e9SGao Xiang u16 device_id_mask; /* valid bits of device id to be used */ 14747e4937aSGao Xiang 14847e4937aSGao Xiang /* inode slot unit size in bit shift */ 14947e4937aSGao Xiang unsigned char islotbits; 15047e4937aSGao Xiang 15114373711SGao Xiang u32 sb_size; /* total superblock size */ 15247e4937aSGao Xiang u32 build_time_nsec; 15347e4937aSGao Xiang u64 build_time; 15447e4937aSGao Xiang 15547e4937aSGao Xiang /* what we really care is nid, rather than ino.. */ 15647e4937aSGao Xiang erofs_nid_t root_nid; 15747e4937aSGao Xiang /* used for statfs, f_files - f_favail */ 15847e4937aSGao Xiang u64 inos; 15947e4937aSGao Xiang 16047e4937aSGao Xiang u8 uuid[16]; /* 128-bit uuid for volume */ 16147e4937aSGao Xiang u8 volume_name[16]; /* volume name */ 162b858a484SPratik Shinde u32 feature_compat; 163426a9308SGao Xiang u32 feature_incompat; 164168e9a76SHuang Jianan 165168e9a76SHuang Jianan /* sysfs support */ 166168e9a76SHuang Jianan struct kobject s_kobj; /* /sys/fs/erofs/<devname> */ 167168e9a76SHuang Jianan struct completion s_kobj_unregister; 168c6be2bd0SJeffle Xu 169c6be2bd0SJeffle Xu /* fscache support */ 170c6be2bd0SJeffle Xu struct fscache_volume *volume; 17137c90c5fSJeffle Xu struct erofs_fscache *s_fscache; 1728b7adf1dSJia Zhu struct erofs_domain *domain; 17347e4937aSGao Xiang }; 17447e4937aSGao Xiang 17547e4937aSGao Xiang #define EROFS_SB(sb) ((struct erofs_sb_info *)(sb)->s_fs_info) 17647e4937aSGao Xiang #define EROFS_I_SB(inode) ((struct erofs_sb_info *)(inode)->i_sb->s_fs_info) 17747e4937aSGao Xiang 17847e4937aSGao Xiang /* Mount flags set via mount options or defaults */ 17947e4937aSGao Xiang #define EROFS_MOUNT_XATTR_USER 0x00000010 18047e4937aSGao Xiang #define EROFS_MOUNT_POSIX_ACL 0x00000020 18106252e9cSGao Xiang #define EROFS_MOUNT_DAX_ALWAYS 0x00000040 18206252e9cSGao Xiang #define EROFS_MOUNT_DAX_NEVER 0x00000080 18347e4937aSGao Xiang 184e6242465SGao Xiang #define clear_opt(opt, option) ((opt)->mount_opt &= ~EROFS_MOUNT_##option) 185e6242465SGao Xiang #define set_opt(opt, option) ((opt)->mount_opt |= EROFS_MOUNT_##option) 186e6242465SGao Xiang #define test_opt(opt, option) ((opt)->mount_opt & EROFS_MOUNT_##option) 18747e4937aSGao Xiang 18893b856bbSJeffle Xu static inline bool erofs_is_fscache_mode(struct super_block *sb) 18993b856bbSJeffle Xu { 19093b856bbSJeffle Xu return IS_ENABLED(CONFIG_EROFS_FS_ONDEMAND) && !sb->s_bdev; 19193b856bbSJeffle Xu } 19293b856bbSJeffle Xu 19347e4937aSGao Xiang enum { 19447e4937aSGao Xiang EROFS_ZIP_CACHE_DISABLED, 19547e4937aSGao Xiang EROFS_ZIP_CACHE_READAHEAD, 19647e4937aSGao Xiang EROFS_ZIP_CACHE_READAROUND 19747e4937aSGao Xiang }; 19847e4937aSGao Xiang 19947e4937aSGao Xiang #define EROFS_LOCKED_MAGIC (INT_MIN | 0xE0F510CCL) 20047e4937aSGao Xiang 20147e4937aSGao Xiang /* basic unit of the workstation of a super_block */ 20247e4937aSGao Xiang struct erofs_workgroup { 20347e4937aSGao Xiang /* the workgroup index in the workstation */ 20447e4937aSGao Xiang pgoff_t index; 20547e4937aSGao Xiang 20647e4937aSGao Xiang /* overall workgroup reference count */ 20747e4937aSGao Xiang atomic_t refcount; 20847e4937aSGao Xiang }; 20947e4937aSGao Xiang 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 if (val != atomic_cmpxchg(&grp->refcount, val, EROFS_LOCKED_MAGIC)) { 21547e4937aSGao Xiang preempt_enable(); 21647e4937aSGao Xiang return false; 21747e4937aSGao Xiang } 21847e4937aSGao Xiang return true; 21947e4937aSGao Xiang } 22047e4937aSGao Xiang 22147e4937aSGao Xiang static inline void erofs_workgroup_unfreeze(struct erofs_workgroup *grp, 22247e4937aSGao Xiang int orig_val) 22347e4937aSGao Xiang { 22447e4937aSGao Xiang /* 22547e4937aSGao Xiang * other observers should notice all modifications 22647e4937aSGao Xiang * in the freezing period. 22747e4937aSGao Xiang */ 22847e4937aSGao Xiang smp_mb(); 22947e4937aSGao Xiang atomic_set(&grp->refcount, orig_val); 23047e4937aSGao Xiang preempt_enable(); 23147e4937aSGao Xiang } 23247e4937aSGao Xiang 23347e4937aSGao Xiang static inline int erofs_wait_on_workgroup_freezed(struct erofs_workgroup *grp) 23447e4937aSGao Xiang { 23547e4937aSGao Xiang return atomic_cond_read_relaxed(&grp->refcount, 23647e4937aSGao Xiang VAL != EROFS_LOCKED_MAGIC); 23747e4937aSGao Xiang } 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) 291b15b2e30SYue Hu EROFS_FEATURE_FUNCS(fragments, incompat, INCOMPAT_FRAGMENTS) 2925c2a6425SGao Xiang EROFS_FEATURE_FUNCS(dedupe, incompat, INCOMPAT_DEDUPE) 293de06a6a3SGao Xiang EROFS_FEATURE_FUNCS(sb_chksum, compat, COMPAT_SB_CHKSUM) 294de06a6a3SGao Xiang 29547e4937aSGao Xiang /* atomic flag definitions */ 296a5876e24SGao Xiang #define EROFS_I_EA_INITED_BIT 0 297a5876e24SGao Xiang #define EROFS_I_Z_INITED_BIT 1 29847e4937aSGao Xiang 29947e4937aSGao Xiang /* bitlock definitions (arranged in reverse order) */ 300a5876e24SGao Xiang #define EROFS_I_BL_XATTR_BIT (BITS_PER_LONG - 1) 301a5876e24SGao Xiang #define EROFS_I_BL_Z_BIT (BITS_PER_LONG - 2) 30247e4937aSGao Xiang 303a5876e24SGao Xiang struct erofs_inode { 30447e4937aSGao Xiang erofs_nid_t nid; 30547e4937aSGao Xiang 30647e4937aSGao Xiang /* atomic flags (including bitlocks) */ 30747e4937aSGao Xiang unsigned long flags; 30847e4937aSGao Xiang 3098a765682SGao Xiang unsigned char datalayout; 31047e4937aSGao Xiang unsigned char inode_isize; 31147e4937aSGao Xiang unsigned short xattr_isize; 31247e4937aSGao Xiang 31347e4937aSGao Xiang unsigned int xattr_shared_count; 31447e4937aSGao Xiang unsigned int *xattr_shared_xattrs; 31547e4937aSGao Xiang 31647e4937aSGao Xiang union { 31747e4937aSGao Xiang erofs_blk_t raw_blkaddr; 318c5aa903aSGao Xiang struct { 319c5aa903aSGao Xiang unsigned short chunkformat; 320c5aa903aSGao Xiang unsigned char chunkbits; 321c5aa903aSGao Xiang }; 32247e4937aSGao Xiang #ifdef CONFIG_EROFS_FS_ZIP 32347e4937aSGao Xiang struct { 32447e4937aSGao Xiang unsigned short z_advise; 32547e4937aSGao Xiang unsigned char z_algorithmtype[2]; 32647e4937aSGao Xiang unsigned char z_logical_clusterbits; 327ab92184fSYue Hu unsigned long z_tailextent_headlcn; 328b15b2e30SYue Hu union { 329b15b2e30SYue Hu struct { 33022ba5e99SGao Xiang erofs_off_t z_idataoff; 331ab92184fSYue Hu unsigned short z_idata_size; 33247e4937aSGao Xiang }; 333b15b2e30SYue Hu erofs_off_t z_fragmentoff; 334b15b2e30SYue Hu }; 335b15b2e30SYue Hu }; 33647e4937aSGao Xiang #endif /* CONFIG_EROFS_FS_ZIP */ 33747e4937aSGao Xiang }; 33847e4937aSGao Xiang /* the corresponding vfs inode */ 33947e4937aSGao Xiang struct inode vfs_inode; 34047e4937aSGao Xiang }; 34147e4937aSGao Xiang 342a5876e24SGao Xiang #define EROFS_I(ptr) \ 343a5876e24SGao Xiang container_of(ptr, struct erofs_inode, vfs_inode) 34447e4937aSGao Xiang 34599634bf3SGao Xiang static inline unsigned long erofs_inode_datablocks(struct inode *inode) 34647e4937aSGao Xiang { 34747e4937aSGao Xiang /* since i_size cannot be changed */ 34847e4937aSGao Xiang return DIV_ROUND_UP(inode->i_size, EROFS_BLKSIZ); 34947e4937aSGao 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 extern const struct super_operations erofs_sops; 385a9849560SJia Zhu extern struct file_system_type erofs_fs_type; 38647e4937aSGao Xiang 38747e4937aSGao Xiang extern const struct address_space_operations erofs_raw_access_aops; 3880c638f70SGao Xiang extern const struct address_space_operations z_erofs_aops; 38947e4937aSGao Xiang 39047e4937aSGao Xiang enum { 3918f899262SGao Xiang BH_Encoded = BH_PrivateStart, 39247e4937aSGao Xiang BH_FullMapped, 393b15b2e30SYue Hu BH_Fragment, 3945c2a6425SGao Xiang BH_Partialref, 39547e4937aSGao Xiang }; 39647e4937aSGao Xiang 39747e4937aSGao Xiang /* Has a disk mapping */ 39847e4937aSGao Xiang #define EROFS_MAP_MAPPED (1 << BH_Mapped) 39947e4937aSGao Xiang /* Located in metadata (could be copied from bd_inode) */ 40047e4937aSGao Xiang #define EROFS_MAP_META (1 << BH_Meta) 4018f899262SGao Xiang /* The extent is encoded */ 4028f899262SGao Xiang #define EROFS_MAP_ENCODED (1 << BH_Encoded) 40347e4937aSGao Xiang /* The length of extent is full */ 40447e4937aSGao Xiang #define EROFS_MAP_FULL_MAPPED (1 << BH_FullMapped) 405b15b2e30SYue Hu /* Located in the special packed inode */ 406b15b2e30SYue Hu #define EROFS_MAP_FRAGMENT (1 << BH_Fragment) 4075c2a6425SGao Xiang /* The extent refers to partial decompressed data */ 4085c2a6425SGao Xiang #define EROFS_MAP_PARTIAL_REF (1 << BH_Partialref) 40947e4937aSGao Xiang 41047e4937aSGao Xiang struct erofs_map_blocks { 41109c54379SGao Xiang struct erofs_buf buf; 41209c54379SGao Xiang 41347e4937aSGao Xiang erofs_off_t m_pa, m_la; 41447e4937aSGao Xiang u64 m_plen, m_llen; 41547e4937aSGao Xiang 416dfeab2e9SGao Xiang unsigned short m_deviceid; 4178f899262SGao Xiang char m_algorithmformat; 41847e4937aSGao Xiang unsigned int m_flags; 41947e4937aSGao Xiang }; 42047e4937aSGao Xiang 4218137824eSYue Hu /* Flags used by erofs_map_blocks_flatmode() */ 42247e4937aSGao Xiang #define EROFS_GET_BLOCKS_RAW 0x0001 423d95ae5e2SGao Xiang /* 424d95ae5e2SGao Xiang * Used to get the exact decompressed length, e.g. fiemap (consider lookback 425d95ae5e2SGao Xiang * approach instead if possible since it's more metadata lightweight.) 426d95ae5e2SGao Xiang */ 427d95ae5e2SGao Xiang #define EROFS_GET_BLOCKS_FIEMAP 0x0002 428622ceaddSGao Xiang /* Used to map the whole extent if non-negligible data is requested for LZMA */ 429622ceaddSGao Xiang #define EROFS_GET_BLOCKS_READMORE 0x0004 430b15b2e30SYue Hu /* Used to map tail extent for tailpacking inline or fragment pcluster */ 431ab92184fSYue Hu #define EROFS_GET_BLOCKS_FINDTAIL 0x0008 43247e4937aSGao Xiang 4338f899262SGao Xiang enum { 4348f899262SGao Xiang Z_EROFS_COMPRESSION_SHIFTED = Z_EROFS_COMPRESSION_MAX, 435fdffc091SYue Hu Z_EROFS_COMPRESSION_INTERLACED, 4368f899262SGao Xiang Z_EROFS_COMPRESSION_RUNTIME_MAX 4378f899262SGao Xiang }; 4388f899262SGao Xiang 43947e4937aSGao Xiang /* zmap.c */ 440eadcd6b5SGao Xiang extern const struct iomap_ops z_erofs_iomap_report_ops; 441eadcd6b5SGao Xiang 44247e4937aSGao Xiang #ifdef CONFIG_EROFS_FS_ZIP 44347e4937aSGao Xiang int z_erofs_fill_inode(struct inode *inode); 44447e4937aSGao Xiang int z_erofs_map_blocks_iter(struct inode *inode, 44547e4937aSGao Xiang struct erofs_map_blocks *map, 44647e4937aSGao Xiang int flags); 44747e4937aSGao Xiang #else 44847e4937aSGao Xiang static inline int z_erofs_fill_inode(struct inode *inode) { return -EOPNOTSUPP; } 44947e4937aSGao Xiang static inline int z_erofs_map_blocks_iter(struct inode *inode, 45047e4937aSGao Xiang struct erofs_map_blocks *map, 45147e4937aSGao Xiang int flags) 45247e4937aSGao Xiang { 45347e4937aSGao Xiang return -EOPNOTSUPP; 45447e4937aSGao Xiang } 45547e4937aSGao Xiang #endif /* !CONFIG_EROFS_FS_ZIP */ 45647e4937aSGao Xiang 457dfeab2e9SGao Xiang struct erofs_map_dev { 458955b478eSJeffle Xu struct erofs_fscache *m_fscache; 459dfeab2e9SGao Xiang struct block_device *m_bdev; 460dfeab2e9SGao Xiang struct dax_device *m_daxdev; 461de205114SChristoph Hellwig u64 m_dax_part_off; 462dfeab2e9SGao Xiang 463dfeab2e9SGao Xiang erofs_off_t m_pa; 464dfeab2e9SGao Xiang unsigned int m_deviceid; 465dfeab2e9SGao Xiang }; 466dfeab2e9SGao Xiang 46747e4937aSGao Xiang /* data.c */ 468a08e67a0SHuang Jianan extern const struct file_operations erofs_file_fops; 46909c54379SGao Xiang void erofs_unmap_metabuf(struct erofs_buf *buf); 470c521e3adSGao Xiang void erofs_put_metabuf(struct erofs_buf *buf); 471fe5de585SGao Xiang void *erofs_bread(struct erofs_buf *buf, struct inode *inode, 472fe5de585SGao Xiang erofs_blk_t blkaddr, enum erofs_kmap_type type); 473c521e3adSGao Xiang void *erofs_read_metabuf(struct erofs_buf *buf, struct super_block *sb, 474c521e3adSGao Xiang erofs_blk_t blkaddr, enum erofs_kmap_type type); 475dfeab2e9SGao Xiang int erofs_map_dev(struct super_block *sb, struct erofs_map_dev *dev); 476eadcd6b5SGao Xiang int erofs_fiemap(struct inode *inode, struct fiemap_extent_info *fieinfo, 477eadcd6b5SGao Xiang u64 start, u64 len); 47894d78946SJeffle Xu int erofs_map_blocks(struct inode *inode, 47994d78946SJeffle Xu struct erofs_map_blocks *map, int flags); 48047e4937aSGao Xiang 48147e4937aSGao Xiang /* inode.c */ 48247e4937aSGao Xiang static inline unsigned long erofs_inode_hash(erofs_nid_t nid) 48347e4937aSGao Xiang { 48447e4937aSGao Xiang #if BITS_PER_LONG == 32 48547e4937aSGao Xiang return (nid >> 32) ^ (nid & 0xffffffff); 48647e4937aSGao Xiang #else 48747e4937aSGao Xiang return nid; 48847e4937aSGao Xiang #endif 48947e4937aSGao Xiang } 49047e4937aSGao Xiang 49147e4937aSGao Xiang extern const struct inode_operations erofs_generic_iops; 49247e4937aSGao Xiang extern const struct inode_operations erofs_symlink_iops; 49347e4937aSGao Xiang extern const struct inode_operations erofs_fast_symlink_iops; 49447e4937aSGao Xiang 495*312fe643SGao Xiang struct inode *erofs_iget(struct super_block *sb, erofs_nid_t nid); 496549c7297SChristian Brauner int erofs_getattr(struct user_namespace *mnt_userns, const struct path *path, 497549c7297SChristian Brauner struct kstat *stat, u32 request_mask, 498549c7297SChristian Brauner unsigned int query_flags); 49947e4937aSGao Xiang 50047e4937aSGao Xiang /* namei.c */ 50147e4937aSGao Xiang extern const struct inode_operations erofs_dir_iops; 50247e4937aSGao Xiang 5033e917cc3SHongnan Li int erofs_namei(struct inode *dir, const struct qstr *name, 50447e4937aSGao Xiang erofs_nid_t *nid, unsigned int *d_type); 50547e4937aSGao Xiang 50647e4937aSGao Xiang /* dir.c */ 50747e4937aSGao Xiang extern const struct file_operations erofs_dir_fops; 50847e4937aSGao Xiang 509598162d0SGao Xiang static inline void *erofs_vm_map_ram(struct page **pages, unsigned int count) 510598162d0SGao Xiang { 511598162d0SGao Xiang int retried = 0; 512598162d0SGao Xiang 513598162d0SGao Xiang while (1) { 514598162d0SGao Xiang void *p = vm_map_ram(pages, count, -1); 515598162d0SGao Xiang 516598162d0SGao Xiang /* retry two more times (totally 3 times) */ 517598162d0SGao Xiang if (p || ++retried >= 3) 518598162d0SGao Xiang return p; 519598162d0SGao Xiang vm_unmap_aliases(); 520598162d0SGao Xiang } 521598162d0SGao Xiang return NULL; 522598162d0SGao Xiang } 523598162d0SGao Xiang 52452488734SGao Xiang /* pcpubuf.c */ 52552488734SGao Xiang void *erofs_get_pcpubuf(unsigned int requiredpages); 52652488734SGao Xiang void erofs_put_pcpubuf(void *ptr); 52752488734SGao Xiang int erofs_pcpubuf_growsize(unsigned int nrpages); 52852488734SGao Xiang void erofs_pcpubuf_init(void); 52952488734SGao Xiang void erofs_pcpubuf_exit(void); 53052488734SGao Xiang 531168e9a76SHuang Jianan /* sysfs.c */ 532168e9a76SHuang Jianan int erofs_register_sysfs(struct super_block *sb); 533168e9a76SHuang Jianan void erofs_unregister_sysfs(struct super_block *sb); 534168e9a76SHuang Jianan int __init erofs_init_sysfs(void); 535168e9a76SHuang Jianan void erofs_exit_sysfs(void); 536168e9a76SHuang Jianan 53747e4937aSGao Xiang /* utils.c / zdata.c */ 538eaa9172aSGao Xiang struct page *erofs_allocpage(struct page **pagepool, gfp_t gfp); 539eaa9172aSGao Xiang static inline void erofs_pagepool_add(struct page **pagepool, 540eaa9172aSGao Xiang struct page *page) 541eaa9172aSGao Xiang { 542eaa9172aSGao Xiang set_page_private(page, (unsigned long)*pagepool); 543eaa9172aSGao Xiang *pagepool = page; 544eaa9172aSGao Xiang } 545eaa9172aSGao Xiang void erofs_release_pages(struct page **pagepool); 54647e4937aSGao Xiang 54747e4937aSGao Xiang #ifdef CONFIG_EROFS_FS_ZIP 54847e4937aSGao Xiang int erofs_workgroup_put(struct erofs_workgroup *grp); 54947e4937aSGao Xiang struct erofs_workgroup *erofs_find_workgroup(struct super_block *sb, 550997626d8SVladimir Zapolskiy pgoff_t index); 55164094a04SGao Xiang struct erofs_workgroup *erofs_insert_workgroup(struct super_block *sb, 552e5e9a432SVladimir Zapolskiy struct erofs_workgroup *grp); 55347e4937aSGao Xiang void erofs_workgroup_free_rcu(struct erofs_workgroup *grp); 55447e4937aSGao Xiang void erofs_shrinker_register(struct super_block *sb); 55547e4937aSGao Xiang void erofs_shrinker_unregister(struct super_block *sb); 55647e4937aSGao Xiang int __init erofs_init_shrinker(void); 55747e4937aSGao Xiang void erofs_exit_shrinker(void); 55847e4937aSGao Xiang int __init z_erofs_init_zip_subsystem(void); 55947e4937aSGao Xiang void z_erofs_exit_zip_subsystem(void); 56047e4937aSGao Xiang int erofs_try_to_free_all_cached_pages(struct erofs_sb_info *sbi, 56147e4937aSGao Xiang struct erofs_workgroup *egrp); 562d252ff3dSYue Hu int erofs_try_to_free_cached_page(struct page *page); 5635d50538fSHuang Jianan int z_erofs_load_lz4_config(struct super_block *sb, 56446249cdeSGao Xiang struct erofs_super_block *dsb, 56546249cdeSGao Xiang struct z_erofs_lz4_cfgs *lz4, int len); 56647e4937aSGao Xiang #else 56747e4937aSGao Xiang static inline void erofs_shrinker_register(struct super_block *sb) {} 56847e4937aSGao Xiang static inline void erofs_shrinker_unregister(struct super_block *sb) {} 56947e4937aSGao Xiang static inline int erofs_init_shrinker(void) { return 0; } 57047e4937aSGao Xiang static inline void erofs_exit_shrinker(void) {} 57147e4937aSGao Xiang static inline int z_erofs_init_zip_subsystem(void) { return 0; } 57247e4937aSGao Xiang static inline void z_erofs_exit_zip_subsystem(void) {} 5735d50538fSHuang Jianan static inline int z_erofs_load_lz4_config(struct super_block *sb, 57446249cdeSGao Xiang struct erofs_super_block *dsb, 57546249cdeSGao Xiang struct z_erofs_lz4_cfgs *lz4, int len) 5765d50538fSHuang Jianan { 57714373711SGao Xiang if (lz4 || dsb->u1.lz4_max_distance) { 5785d50538fSHuang Jianan erofs_err(sb, "lz4 algorithm isn't enabled"); 5795d50538fSHuang Jianan return -EINVAL; 5805d50538fSHuang Jianan } 5815d50538fSHuang Jianan return 0; 5825d50538fSHuang Jianan } 58347e4937aSGao Xiang #endif /* !CONFIG_EROFS_FS_ZIP */ 58447e4937aSGao Xiang 585622ceaddSGao Xiang #ifdef CONFIG_EROFS_FS_ZIP_LZMA 586622ceaddSGao Xiang int z_erofs_lzma_init(void); 587622ceaddSGao Xiang void z_erofs_lzma_exit(void); 588622ceaddSGao Xiang int z_erofs_load_lzma_config(struct super_block *sb, 589622ceaddSGao Xiang struct erofs_super_block *dsb, 590622ceaddSGao Xiang struct z_erofs_lzma_cfgs *lzma, int size); 591622ceaddSGao Xiang #else 592622ceaddSGao Xiang static inline int z_erofs_lzma_init(void) { return 0; } 593622ceaddSGao Xiang static inline int z_erofs_lzma_exit(void) { return 0; } 594622ceaddSGao Xiang static inline int z_erofs_load_lzma_config(struct super_block *sb, 595622ceaddSGao Xiang struct erofs_super_block *dsb, 596622ceaddSGao Xiang struct z_erofs_lzma_cfgs *lzma, int size) { 597622ceaddSGao Xiang if (lzma) { 598622ceaddSGao Xiang erofs_err(sb, "lzma algorithm isn't enabled"); 599622ceaddSGao Xiang return -EINVAL; 600622ceaddSGao Xiang } 601622ceaddSGao Xiang return 0; 602622ceaddSGao Xiang } 603622ceaddSGao Xiang #endif /* !CONFIG_EROFS_FS_ZIP */ 604622ceaddSGao Xiang 605c6be2bd0SJeffle Xu /* fscache.c */ 606c6be2bd0SJeffle Xu #ifdef CONFIG_EROFS_FS_ONDEMAND 607c6be2bd0SJeffle Xu int erofs_fscache_register_fs(struct super_block *sb); 608c6be2bd0SJeffle Xu void erofs_fscache_unregister_fs(struct super_block *sb); 609b02c602fSJeffle Xu 610e1de2da0SJia Zhu struct erofs_fscache *erofs_fscache_register_cookie(struct super_block *sb, 6113c265d7dSJeffle Xu char *name, bool need_inode); 612e1de2da0SJia Zhu void erofs_fscache_unregister_cookie(struct erofs_fscache *fscache); 6131442b02bSJeffle Xu 6141442b02bSJeffle Xu extern const struct address_space_operations erofs_fscache_access_aops; 615c6be2bd0SJeffle Xu #else 616c6be2bd0SJeffle Xu static inline int erofs_fscache_register_fs(struct super_block *sb) 617c6be2bd0SJeffle Xu { 618e1de2da0SJia Zhu return -EOPNOTSUPP; 619c6be2bd0SJeffle Xu } 620c6be2bd0SJeffle Xu static inline void erofs_fscache_unregister_fs(struct super_block *sb) {} 621b02c602fSJeffle Xu 622e1de2da0SJia Zhu static inline 623e1de2da0SJia Zhu struct erofs_fscache *erofs_fscache_register_cookie(struct super_block *sb, 6243c265d7dSJeffle Xu char *name, bool need_inode) 625b02c602fSJeffle Xu { 626e1de2da0SJia Zhu return ERR_PTR(-EOPNOTSUPP); 627b02c602fSJeffle Xu } 628b02c602fSJeffle Xu 629e1de2da0SJia Zhu static inline void erofs_fscache_unregister_cookie(struct erofs_fscache *fscache) 630b02c602fSJeffle Xu { 631b02c602fSJeffle Xu } 632c6be2bd0SJeffle Xu #endif 633c6be2bd0SJeffle Xu 63447e4937aSGao Xiang #define EFSCORRUPTED EUCLEAN /* Filesystem is corrupted */ 63547e4937aSGao Xiang 63647e4937aSGao Xiang #endif /* __EROFS_INTERNAL_H */ 637