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; 79*8b7adf1dSJia 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 102*8b7adf1dSJia Zhu struct erofs_domain { 103*8b7adf1dSJia Zhu refcount_t ref; 104*8b7adf1dSJia Zhu struct list_head list; 105*8b7adf1dSJia Zhu struct fscache_volume *volume; 106*8b7adf1dSJia Zhu char *domain_id; 107*8b7adf1dSJia Zhu }; 108*8b7adf1dSJia Zhu 109b02c602fSJeffle Xu struct erofs_fscache { 110b02c602fSJeffle Xu struct fscache_cookie *cookie; 1113c265d7dSJeffle Xu struct inode *inode; 112b02c602fSJeffle Xu }; 113b02c602fSJeffle Xu 11447e4937aSGao Xiang struct erofs_sb_info { 115e6242465SGao Xiang struct erofs_mount_opts opt; /* options */ 11647e4937aSGao Xiang #ifdef CONFIG_EROFS_FS_ZIP 11747e4937aSGao Xiang /* list for all registered superblocks, mainly for shrinker */ 11847e4937aSGao Xiang struct list_head list; 11947e4937aSGao Xiang struct mutex umount_mutex; 12047e4937aSGao Xiang 12164094a04SGao Xiang /* managed XArray arranged in physical block number */ 12264094a04SGao Xiang struct xarray managed_pslots; 12347e4937aSGao Xiang 12447e4937aSGao Xiang unsigned int shrinker_run_no; 12514373711SGao Xiang u16 available_compr_algs; 12647e4937aSGao Xiang 12747e4937aSGao Xiang /* pseudo inode to manage cached pages */ 12847e4937aSGao Xiang struct inode *managed_cache; 1295d50538fSHuang Jianan 1305d50538fSHuang Jianan struct erofs_sb_lz4_info lz4; 13147e4937aSGao Xiang #endif /* CONFIG_EROFS_FS_ZIP */ 132dfeab2e9SGao Xiang struct erofs_dev_context *devs; 13306252e9cSGao Xiang struct dax_device *dax_dev; 134cd913c76SChristoph Hellwig u64 dax_part_off; 135dfeab2e9SGao Xiang u64 total_blocks; 136dfeab2e9SGao Xiang u32 primarydevice_blocks; 137dfeab2e9SGao Xiang 13847e4937aSGao Xiang u32 meta_blkaddr; 13947e4937aSGao Xiang #ifdef CONFIG_EROFS_FS_XATTR 14047e4937aSGao Xiang u32 xattr_blkaddr; 14147e4937aSGao Xiang #endif 142dfeab2e9SGao Xiang u16 device_id_mask; /* valid bits of device id to be used */ 14347e4937aSGao Xiang 14447e4937aSGao Xiang /* inode slot unit size in bit shift */ 14547e4937aSGao Xiang unsigned char islotbits; 14647e4937aSGao Xiang 14714373711SGao Xiang u32 sb_size; /* total superblock size */ 14847e4937aSGao Xiang u32 build_time_nsec; 14947e4937aSGao Xiang u64 build_time; 15047e4937aSGao Xiang 15147e4937aSGao Xiang /* what we really care is nid, rather than ino.. */ 15247e4937aSGao Xiang erofs_nid_t root_nid; 15347e4937aSGao Xiang /* used for statfs, f_files - f_favail */ 15447e4937aSGao Xiang u64 inos; 15547e4937aSGao Xiang 15647e4937aSGao Xiang u8 uuid[16]; /* 128-bit uuid for volume */ 15747e4937aSGao Xiang u8 volume_name[16]; /* volume name */ 158b858a484SPratik Shinde u32 feature_compat; 159426a9308SGao Xiang u32 feature_incompat; 160168e9a76SHuang Jianan 161168e9a76SHuang Jianan /* sysfs support */ 162168e9a76SHuang Jianan struct kobject s_kobj; /* /sys/fs/erofs/<devname> */ 163168e9a76SHuang Jianan struct completion s_kobj_unregister; 164c6be2bd0SJeffle Xu 165c6be2bd0SJeffle Xu /* fscache support */ 166c6be2bd0SJeffle Xu struct fscache_volume *volume; 16737c90c5fSJeffle Xu struct erofs_fscache *s_fscache; 168*8b7adf1dSJia Zhu struct erofs_domain *domain; 16947e4937aSGao Xiang }; 17047e4937aSGao Xiang 17147e4937aSGao Xiang #define EROFS_SB(sb) ((struct erofs_sb_info *)(sb)->s_fs_info) 17247e4937aSGao Xiang #define EROFS_I_SB(inode) ((struct erofs_sb_info *)(inode)->i_sb->s_fs_info) 17347e4937aSGao Xiang 17447e4937aSGao Xiang /* Mount flags set via mount options or defaults */ 17547e4937aSGao Xiang #define EROFS_MOUNT_XATTR_USER 0x00000010 17647e4937aSGao Xiang #define EROFS_MOUNT_POSIX_ACL 0x00000020 17706252e9cSGao Xiang #define EROFS_MOUNT_DAX_ALWAYS 0x00000040 17806252e9cSGao Xiang #define EROFS_MOUNT_DAX_NEVER 0x00000080 17947e4937aSGao Xiang 180e6242465SGao Xiang #define clear_opt(opt, option) ((opt)->mount_opt &= ~EROFS_MOUNT_##option) 181e6242465SGao Xiang #define set_opt(opt, option) ((opt)->mount_opt |= EROFS_MOUNT_##option) 182e6242465SGao Xiang #define test_opt(opt, option) ((opt)->mount_opt & EROFS_MOUNT_##option) 18347e4937aSGao Xiang 18493b856bbSJeffle Xu static inline bool erofs_is_fscache_mode(struct super_block *sb) 18593b856bbSJeffle Xu { 18693b856bbSJeffle Xu return IS_ENABLED(CONFIG_EROFS_FS_ONDEMAND) && !sb->s_bdev; 18793b856bbSJeffle Xu } 18893b856bbSJeffle Xu 18947e4937aSGao Xiang enum { 19047e4937aSGao Xiang EROFS_ZIP_CACHE_DISABLED, 19147e4937aSGao Xiang EROFS_ZIP_CACHE_READAHEAD, 19247e4937aSGao Xiang EROFS_ZIP_CACHE_READAROUND 19347e4937aSGao Xiang }; 19447e4937aSGao Xiang 195f57a3fe4SChao Yu #ifdef CONFIG_EROFS_FS_ZIP 19647e4937aSGao Xiang #define EROFS_LOCKED_MAGIC (INT_MIN | 0xE0F510CCL) 19747e4937aSGao Xiang 19847e4937aSGao Xiang /* basic unit of the workstation of a super_block */ 19947e4937aSGao Xiang struct erofs_workgroup { 20047e4937aSGao Xiang /* the workgroup index in the workstation */ 20147e4937aSGao Xiang pgoff_t index; 20247e4937aSGao Xiang 20347e4937aSGao Xiang /* overall workgroup reference count */ 20447e4937aSGao Xiang atomic_t refcount; 20547e4937aSGao Xiang }; 20647e4937aSGao Xiang 20747e4937aSGao Xiang static inline bool erofs_workgroup_try_to_freeze(struct erofs_workgroup *grp, 20847e4937aSGao Xiang int val) 20947e4937aSGao Xiang { 21047e4937aSGao Xiang preempt_disable(); 21147e4937aSGao Xiang if (val != atomic_cmpxchg(&grp->refcount, val, EROFS_LOCKED_MAGIC)) { 21247e4937aSGao Xiang preempt_enable(); 21347e4937aSGao Xiang return false; 21447e4937aSGao Xiang } 21547e4937aSGao Xiang return true; 21647e4937aSGao Xiang } 21747e4937aSGao Xiang 21847e4937aSGao Xiang static inline void erofs_workgroup_unfreeze(struct erofs_workgroup *grp, 21947e4937aSGao Xiang int orig_val) 22047e4937aSGao Xiang { 22147e4937aSGao Xiang /* 22247e4937aSGao Xiang * other observers should notice all modifications 22347e4937aSGao Xiang * in the freezing period. 22447e4937aSGao Xiang */ 22547e4937aSGao Xiang smp_mb(); 22647e4937aSGao Xiang atomic_set(&grp->refcount, orig_val); 22747e4937aSGao Xiang preempt_enable(); 22847e4937aSGao Xiang } 22947e4937aSGao Xiang 23047e4937aSGao Xiang static inline int erofs_wait_on_workgroup_freezed(struct erofs_workgroup *grp) 23147e4937aSGao Xiang { 23247e4937aSGao Xiang return atomic_cond_read_relaxed(&grp->refcount, 23347e4937aSGao Xiang VAL != EROFS_LOCKED_MAGIC); 23447e4937aSGao Xiang } 23547e4937aSGao Xiang #endif /* !CONFIG_EROFS_FS_ZIP */ 23647e4937aSGao Xiang 23747e4937aSGao Xiang /* we strictly follow PAGE_SIZE and no buffer head yet */ 23847e4937aSGao Xiang #define LOG_BLOCK_SIZE PAGE_SHIFT 23947e4937aSGao Xiang 24047e4937aSGao Xiang #undef LOG_SECTORS_PER_BLOCK 24147e4937aSGao Xiang #define LOG_SECTORS_PER_BLOCK (PAGE_SHIFT - 9) 24247e4937aSGao Xiang 24347e4937aSGao Xiang #undef SECTORS_PER_BLOCK 24447e4937aSGao Xiang #define SECTORS_PER_BLOCK (1 << SECTORS_PER_BLOCK) 24547e4937aSGao Xiang 24647e4937aSGao Xiang #define EROFS_BLKSIZ (1 << LOG_BLOCK_SIZE) 24747e4937aSGao Xiang 24847e4937aSGao Xiang #if (EROFS_BLKSIZ % 4096 || !EROFS_BLKSIZ) 24947e4937aSGao Xiang #error erofs cannot be used in this platform 25047e4937aSGao Xiang #endif 25147e4937aSGao Xiang 252fdf80a47SGao Xiang enum erofs_kmap_type { 253fdf80a47SGao Xiang EROFS_NO_KMAP, /* don't map the buffer */ 254fdf80a47SGao Xiang EROFS_KMAP, /* use kmap() to map the buffer */ 255fdf80a47SGao Xiang EROFS_KMAP_ATOMIC, /* use kmap_atomic() to map the buffer */ 256fdf80a47SGao Xiang }; 257fdf80a47SGao Xiang 258fdf80a47SGao Xiang struct erofs_buf { 259fdf80a47SGao Xiang struct page *page; 260fdf80a47SGao Xiang void *base; 261fdf80a47SGao Xiang enum erofs_kmap_type kmap_type; 262fdf80a47SGao Xiang }; 263fdf80a47SGao Xiang #define __EROFS_BUF_INITIALIZER ((struct erofs_buf){ .page = NULL }) 264fdf80a47SGao Xiang 26547e4937aSGao Xiang #define ROOT_NID(sb) ((sb)->root_nid) 26647e4937aSGao Xiang 26747e4937aSGao Xiang #define erofs_blknr(addr) ((addr) / EROFS_BLKSIZ) 26847e4937aSGao Xiang #define erofs_blkoff(addr) ((addr) % EROFS_BLKSIZ) 26947e4937aSGao Xiang #define blknr_to_addr(nr) ((erofs_off_t)(nr) * EROFS_BLKSIZ) 27047e4937aSGao Xiang 27147e4937aSGao Xiang static inline erofs_off_t iloc(struct erofs_sb_info *sbi, erofs_nid_t nid) 27247e4937aSGao Xiang { 27347e4937aSGao Xiang return blknr_to_addr(sbi->meta_blkaddr) + (nid << sbi->islotbits); 27447e4937aSGao Xiang } 27547e4937aSGao Xiang 276de06a6a3SGao Xiang #define EROFS_FEATURE_FUNCS(name, compat, feature) \ 277de06a6a3SGao Xiang static inline bool erofs_sb_has_##name(struct erofs_sb_info *sbi) \ 278de06a6a3SGao Xiang { \ 279de06a6a3SGao Xiang return sbi->feature_##compat & EROFS_FEATURE_##feature; \ 280de06a6a3SGao Xiang } 281de06a6a3SGao Xiang 2827e508f2cSHuang Jianan EROFS_FEATURE_FUNCS(zero_padding, incompat, INCOMPAT_ZERO_PADDING) 28314373711SGao Xiang EROFS_FEATURE_FUNCS(compr_cfgs, incompat, INCOMPAT_COMPR_CFGS) 2845404c330SGao Xiang EROFS_FEATURE_FUNCS(big_pcluster, incompat, INCOMPAT_BIG_PCLUSTER) 285168e9a76SHuang Jianan EROFS_FEATURE_FUNCS(chunked_file, incompat, INCOMPAT_CHUNKED_FILE) 286dfeab2e9SGao Xiang EROFS_FEATURE_FUNCS(device_table, incompat, INCOMPAT_DEVICE_TABLE) 287168e9a76SHuang Jianan EROFS_FEATURE_FUNCS(compr_head2, incompat, INCOMPAT_COMPR_HEAD2) 288ab92184fSYue Hu EROFS_FEATURE_FUNCS(ztailpacking, incompat, INCOMPAT_ZTAILPACKING) 289de06a6a3SGao Xiang EROFS_FEATURE_FUNCS(sb_chksum, compat, COMPAT_SB_CHKSUM) 290de06a6a3SGao Xiang 29147e4937aSGao Xiang /* atomic flag definitions */ 292a5876e24SGao Xiang #define EROFS_I_EA_INITED_BIT 0 293a5876e24SGao Xiang #define EROFS_I_Z_INITED_BIT 1 29447e4937aSGao Xiang 29547e4937aSGao Xiang /* bitlock definitions (arranged in reverse order) */ 296a5876e24SGao Xiang #define EROFS_I_BL_XATTR_BIT (BITS_PER_LONG - 1) 297a5876e24SGao Xiang #define EROFS_I_BL_Z_BIT (BITS_PER_LONG - 2) 29847e4937aSGao Xiang 299a5876e24SGao Xiang struct erofs_inode { 30047e4937aSGao Xiang erofs_nid_t nid; 30147e4937aSGao Xiang 30247e4937aSGao Xiang /* atomic flags (including bitlocks) */ 30347e4937aSGao Xiang unsigned long flags; 30447e4937aSGao Xiang 3058a765682SGao Xiang unsigned char datalayout; 30647e4937aSGao Xiang unsigned char inode_isize; 30747e4937aSGao Xiang unsigned short xattr_isize; 30847e4937aSGao Xiang 30947e4937aSGao Xiang unsigned int xattr_shared_count; 31047e4937aSGao Xiang unsigned int *xattr_shared_xattrs; 31147e4937aSGao Xiang 31247e4937aSGao Xiang union { 31347e4937aSGao Xiang erofs_blk_t raw_blkaddr; 314c5aa903aSGao Xiang struct { 315c5aa903aSGao Xiang unsigned short chunkformat; 316c5aa903aSGao Xiang unsigned char chunkbits; 317c5aa903aSGao Xiang }; 31847e4937aSGao Xiang #ifdef CONFIG_EROFS_FS_ZIP 31947e4937aSGao Xiang struct { 32047e4937aSGao Xiang unsigned short z_advise; 32147e4937aSGao Xiang unsigned char z_algorithmtype[2]; 32247e4937aSGao Xiang unsigned char z_logical_clusterbits; 323ab92184fSYue Hu unsigned long z_tailextent_headlcn; 32422ba5e99SGao Xiang erofs_off_t z_idataoff; 325ab92184fSYue Hu unsigned short z_idata_size; 32647e4937aSGao Xiang }; 32747e4937aSGao Xiang #endif /* CONFIG_EROFS_FS_ZIP */ 32847e4937aSGao Xiang }; 32947e4937aSGao Xiang /* the corresponding vfs inode */ 33047e4937aSGao Xiang struct inode vfs_inode; 33147e4937aSGao Xiang }; 33247e4937aSGao Xiang 333a5876e24SGao Xiang #define EROFS_I(ptr) \ 334a5876e24SGao Xiang container_of(ptr, struct erofs_inode, vfs_inode) 33547e4937aSGao Xiang 33699634bf3SGao Xiang static inline unsigned long erofs_inode_datablocks(struct inode *inode) 33747e4937aSGao Xiang { 33847e4937aSGao Xiang /* since i_size cannot be changed */ 33947e4937aSGao Xiang return DIV_ROUND_UP(inode->i_size, EROFS_BLKSIZ); 34047e4937aSGao Xiang } 34147e4937aSGao Xiang 3428a765682SGao Xiang static inline unsigned int erofs_bitrange(unsigned int value, unsigned int bit, 3438a765682SGao Xiang unsigned int bits) 34447e4937aSGao Xiang { 3458a765682SGao Xiang 3468a765682SGao Xiang return (value >> bit) & ((1 << bits) - 1); 34747e4937aSGao Xiang } 34847e4937aSGao Xiang 3498a765682SGao Xiang 3508a765682SGao Xiang static inline unsigned int erofs_inode_version(unsigned int value) 35147e4937aSGao Xiang { 3528a765682SGao Xiang return erofs_bitrange(value, EROFS_I_VERSION_BIT, 3538a765682SGao Xiang EROFS_I_VERSION_BITS); 3548a765682SGao Xiang } 3558a765682SGao Xiang 3568a765682SGao Xiang static inline unsigned int erofs_inode_datalayout(unsigned int value) 3578a765682SGao Xiang { 3588a765682SGao Xiang return erofs_bitrange(value, EROFS_I_DATALAYOUT_BIT, 3598a765682SGao Xiang EROFS_I_DATALAYOUT_BITS); 36047e4937aSGao Xiang } 36147e4937aSGao Xiang 36238629291SGao Xiang /* 36338629291SGao Xiang * Different from grab_cache_page_nowait(), reclaiming is never triggered 36438629291SGao Xiang * when allocating new pages. 36538629291SGao Xiang */ 36638629291SGao Xiang static inline 36738629291SGao Xiang struct page *erofs_grab_cache_page_nowait(struct address_space *mapping, 36838629291SGao Xiang pgoff_t index) 36938629291SGao Xiang { 37038629291SGao Xiang return pagecache_get_page(mapping, index, 37138629291SGao Xiang FGP_LOCK|FGP_CREAT|FGP_NOFS|FGP_NOWAIT, 37238629291SGao Xiang readahead_gfp_mask(mapping) & ~__GFP_RECLAIM); 37338629291SGao Xiang } 37438629291SGao Xiang 37547e4937aSGao Xiang extern const struct super_operations erofs_sops; 37647e4937aSGao Xiang 37747e4937aSGao Xiang extern const struct address_space_operations erofs_raw_access_aops; 3780c638f70SGao Xiang extern const struct address_space_operations z_erofs_aops; 37947e4937aSGao Xiang 38047e4937aSGao Xiang enum { 3818f899262SGao Xiang BH_Encoded = BH_PrivateStart, 38247e4937aSGao Xiang BH_FullMapped, 38347e4937aSGao Xiang }; 38447e4937aSGao Xiang 38547e4937aSGao Xiang /* Has a disk mapping */ 38647e4937aSGao Xiang #define EROFS_MAP_MAPPED (1 << BH_Mapped) 38747e4937aSGao Xiang /* Located in metadata (could be copied from bd_inode) */ 38847e4937aSGao Xiang #define EROFS_MAP_META (1 << BH_Meta) 3898f899262SGao Xiang /* The extent is encoded */ 3908f899262SGao Xiang #define EROFS_MAP_ENCODED (1 << BH_Encoded) 39147e4937aSGao Xiang /* The length of extent is full */ 39247e4937aSGao Xiang #define EROFS_MAP_FULL_MAPPED (1 << BH_FullMapped) 39347e4937aSGao Xiang 39447e4937aSGao Xiang struct erofs_map_blocks { 39509c54379SGao Xiang struct erofs_buf buf; 39609c54379SGao Xiang 39747e4937aSGao Xiang erofs_off_t m_pa, m_la; 39847e4937aSGao Xiang u64 m_plen, m_llen; 39947e4937aSGao Xiang 400dfeab2e9SGao Xiang unsigned short m_deviceid; 4018f899262SGao Xiang char m_algorithmformat; 40247e4937aSGao Xiang unsigned int m_flags; 40347e4937aSGao Xiang }; 40447e4937aSGao Xiang 4058137824eSYue Hu /* Flags used by erofs_map_blocks_flatmode() */ 40647e4937aSGao Xiang #define EROFS_GET_BLOCKS_RAW 0x0001 407d95ae5e2SGao Xiang /* 408d95ae5e2SGao Xiang * Used to get the exact decompressed length, e.g. fiemap (consider lookback 409d95ae5e2SGao Xiang * approach instead if possible since it's more metadata lightweight.) 410d95ae5e2SGao Xiang */ 411d95ae5e2SGao Xiang #define EROFS_GET_BLOCKS_FIEMAP 0x0002 412622ceaddSGao Xiang /* Used to map the whole extent if non-negligible data is requested for LZMA */ 413622ceaddSGao Xiang #define EROFS_GET_BLOCKS_READMORE 0x0004 414ab92184fSYue Hu /* Used to map tail extent for tailpacking inline pcluster */ 415ab92184fSYue Hu #define EROFS_GET_BLOCKS_FINDTAIL 0x0008 41647e4937aSGao Xiang 4178f899262SGao Xiang enum { 4188f899262SGao Xiang Z_EROFS_COMPRESSION_SHIFTED = Z_EROFS_COMPRESSION_MAX, 4198f899262SGao Xiang Z_EROFS_COMPRESSION_RUNTIME_MAX 4208f899262SGao Xiang }; 4218f899262SGao Xiang 42247e4937aSGao Xiang /* zmap.c */ 423eadcd6b5SGao Xiang extern const struct iomap_ops z_erofs_iomap_report_ops; 424eadcd6b5SGao Xiang 42547e4937aSGao Xiang #ifdef CONFIG_EROFS_FS_ZIP 42647e4937aSGao Xiang int z_erofs_fill_inode(struct inode *inode); 42747e4937aSGao Xiang int z_erofs_map_blocks_iter(struct inode *inode, 42847e4937aSGao Xiang struct erofs_map_blocks *map, 42947e4937aSGao Xiang int flags); 43047e4937aSGao Xiang #else 43147e4937aSGao Xiang static inline int z_erofs_fill_inode(struct inode *inode) { return -EOPNOTSUPP; } 43247e4937aSGao Xiang static inline int z_erofs_map_blocks_iter(struct inode *inode, 43347e4937aSGao Xiang struct erofs_map_blocks *map, 43447e4937aSGao Xiang int flags) 43547e4937aSGao Xiang { 43647e4937aSGao Xiang return -EOPNOTSUPP; 43747e4937aSGao Xiang } 43847e4937aSGao Xiang #endif /* !CONFIG_EROFS_FS_ZIP */ 43947e4937aSGao Xiang 440dfeab2e9SGao Xiang struct erofs_map_dev { 441955b478eSJeffle Xu struct erofs_fscache *m_fscache; 442dfeab2e9SGao Xiang struct block_device *m_bdev; 443dfeab2e9SGao Xiang struct dax_device *m_daxdev; 444de205114SChristoph Hellwig u64 m_dax_part_off; 445dfeab2e9SGao Xiang 446dfeab2e9SGao Xiang erofs_off_t m_pa; 447dfeab2e9SGao Xiang unsigned int m_deviceid; 448dfeab2e9SGao Xiang }; 449dfeab2e9SGao Xiang 45047e4937aSGao Xiang /* data.c */ 451a08e67a0SHuang Jianan extern const struct file_operations erofs_file_fops; 45209c54379SGao Xiang void erofs_unmap_metabuf(struct erofs_buf *buf); 453c521e3adSGao Xiang void erofs_put_metabuf(struct erofs_buf *buf); 454fe5de585SGao Xiang void *erofs_bread(struct erofs_buf *buf, struct inode *inode, 455fe5de585SGao Xiang erofs_blk_t blkaddr, enum erofs_kmap_type type); 456c521e3adSGao Xiang void *erofs_read_metabuf(struct erofs_buf *buf, struct super_block *sb, 457c521e3adSGao Xiang erofs_blk_t blkaddr, enum erofs_kmap_type type); 458dfeab2e9SGao Xiang int erofs_map_dev(struct super_block *sb, struct erofs_map_dev *dev); 459eadcd6b5SGao Xiang int erofs_fiemap(struct inode *inode, struct fiemap_extent_info *fieinfo, 460eadcd6b5SGao Xiang u64 start, u64 len); 46194d78946SJeffle Xu int erofs_map_blocks(struct inode *inode, 46294d78946SJeffle Xu struct erofs_map_blocks *map, int flags); 46347e4937aSGao Xiang 46447e4937aSGao Xiang /* inode.c */ 46547e4937aSGao Xiang static inline unsigned long erofs_inode_hash(erofs_nid_t nid) 46647e4937aSGao Xiang { 46747e4937aSGao Xiang #if BITS_PER_LONG == 32 46847e4937aSGao Xiang return (nid >> 32) ^ (nid & 0xffffffff); 46947e4937aSGao Xiang #else 47047e4937aSGao Xiang return nid; 47147e4937aSGao Xiang #endif 47247e4937aSGao Xiang } 47347e4937aSGao Xiang 47447e4937aSGao Xiang extern const struct inode_operations erofs_generic_iops; 47547e4937aSGao Xiang extern const struct inode_operations erofs_symlink_iops; 47647e4937aSGao Xiang extern const struct inode_operations erofs_fast_symlink_iops; 47747e4937aSGao Xiang 47847e4937aSGao Xiang struct inode *erofs_iget(struct super_block *sb, erofs_nid_t nid, bool dir); 479549c7297SChristian Brauner int erofs_getattr(struct user_namespace *mnt_userns, const struct path *path, 480549c7297SChristian Brauner struct kstat *stat, u32 request_mask, 481549c7297SChristian Brauner unsigned int query_flags); 48247e4937aSGao Xiang 48347e4937aSGao Xiang /* namei.c */ 48447e4937aSGao Xiang extern const struct inode_operations erofs_dir_iops; 48547e4937aSGao Xiang 4863e917cc3SHongnan Li int erofs_namei(struct inode *dir, const struct qstr *name, 48747e4937aSGao Xiang erofs_nid_t *nid, unsigned int *d_type); 48847e4937aSGao Xiang 48947e4937aSGao Xiang /* dir.c */ 49047e4937aSGao Xiang extern const struct file_operations erofs_dir_fops; 49147e4937aSGao Xiang 492598162d0SGao Xiang static inline void *erofs_vm_map_ram(struct page **pages, unsigned int count) 493598162d0SGao Xiang { 494598162d0SGao Xiang int retried = 0; 495598162d0SGao Xiang 496598162d0SGao Xiang while (1) { 497598162d0SGao Xiang void *p = vm_map_ram(pages, count, -1); 498598162d0SGao Xiang 499598162d0SGao Xiang /* retry two more times (totally 3 times) */ 500598162d0SGao Xiang if (p || ++retried >= 3) 501598162d0SGao Xiang return p; 502598162d0SGao Xiang vm_unmap_aliases(); 503598162d0SGao Xiang } 504598162d0SGao Xiang return NULL; 505598162d0SGao Xiang } 506598162d0SGao Xiang 50752488734SGao Xiang /* pcpubuf.c */ 50852488734SGao Xiang void *erofs_get_pcpubuf(unsigned int requiredpages); 50952488734SGao Xiang void erofs_put_pcpubuf(void *ptr); 51052488734SGao Xiang int erofs_pcpubuf_growsize(unsigned int nrpages); 51152488734SGao Xiang void erofs_pcpubuf_init(void); 51252488734SGao Xiang void erofs_pcpubuf_exit(void); 51352488734SGao Xiang 514168e9a76SHuang Jianan /* sysfs.c */ 515168e9a76SHuang Jianan int erofs_register_sysfs(struct super_block *sb); 516168e9a76SHuang Jianan void erofs_unregister_sysfs(struct super_block *sb); 517168e9a76SHuang Jianan int __init erofs_init_sysfs(void); 518168e9a76SHuang Jianan void erofs_exit_sysfs(void); 519168e9a76SHuang Jianan 52047e4937aSGao Xiang /* utils.c / zdata.c */ 521eaa9172aSGao Xiang struct page *erofs_allocpage(struct page **pagepool, gfp_t gfp); 522eaa9172aSGao Xiang static inline void erofs_pagepool_add(struct page **pagepool, 523eaa9172aSGao Xiang struct page *page) 524eaa9172aSGao Xiang { 525eaa9172aSGao Xiang set_page_private(page, (unsigned long)*pagepool); 526eaa9172aSGao Xiang *pagepool = page; 527eaa9172aSGao Xiang } 528eaa9172aSGao Xiang void erofs_release_pages(struct page **pagepool); 52947e4937aSGao Xiang 53047e4937aSGao Xiang #ifdef CONFIG_EROFS_FS_ZIP 53147e4937aSGao Xiang int erofs_workgroup_put(struct erofs_workgroup *grp); 53247e4937aSGao Xiang struct erofs_workgroup *erofs_find_workgroup(struct super_block *sb, 533997626d8SVladimir Zapolskiy pgoff_t index); 53464094a04SGao Xiang struct erofs_workgroup *erofs_insert_workgroup(struct super_block *sb, 535e5e9a432SVladimir Zapolskiy struct erofs_workgroup *grp); 53647e4937aSGao Xiang void erofs_workgroup_free_rcu(struct erofs_workgroup *grp); 53747e4937aSGao Xiang void erofs_shrinker_register(struct super_block *sb); 53847e4937aSGao Xiang void erofs_shrinker_unregister(struct super_block *sb); 53947e4937aSGao Xiang int __init erofs_init_shrinker(void); 54047e4937aSGao Xiang void erofs_exit_shrinker(void); 54147e4937aSGao Xiang int __init z_erofs_init_zip_subsystem(void); 54247e4937aSGao Xiang void z_erofs_exit_zip_subsystem(void); 54347e4937aSGao Xiang int erofs_try_to_free_all_cached_pages(struct erofs_sb_info *sbi, 54447e4937aSGao Xiang struct erofs_workgroup *egrp); 545d252ff3dSYue Hu int erofs_try_to_free_cached_page(struct page *page); 5465d50538fSHuang Jianan int z_erofs_load_lz4_config(struct super_block *sb, 54746249cdeSGao Xiang struct erofs_super_block *dsb, 54846249cdeSGao Xiang struct z_erofs_lz4_cfgs *lz4, int len); 54947e4937aSGao Xiang #else 55047e4937aSGao Xiang static inline void erofs_shrinker_register(struct super_block *sb) {} 55147e4937aSGao Xiang static inline void erofs_shrinker_unregister(struct super_block *sb) {} 55247e4937aSGao Xiang static inline int erofs_init_shrinker(void) { return 0; } 55347e4937aSGao Xiang static inline void erofs_exit_shrinker(void) {} 55447e4937aSGao Xiang static inline int z_erofs_init_zip_subsystem(void) { return 0; } 55547e4937aSGao Xiang static inline void z_erofs_exit_zip_subsystem(void) {} 5565d50538fSHuang Jianan static inline int z_erofs_load_lz4_config(struct super_block *sb, 55746249cdeSGao Xiang struct erofs_super_block *dsb, 55846249cdeSGao Xiang struct z_erofs_lz4_cfgs *lz4, int len) 5595d50538fSHuang Jianan { 56014373711SGao Xiang if (lz4 || dsb->u1.lz4_max_distance) { 5615d50538fSHuang Jianan erofs_err(sb, "lz4 algorithm isn't enabled"); 5625d50538fSHuang Jianan return -EINVAL; 5635d50538fSHuang Jianan } 5645d50538fSHuang Jianan return 0; 5655d50538fSHuang Jianan } 56647e4937aSGao Xiang #endif /* !CONFIG_EROFS_FS_ZIP */ 56747e4937aSGao Xiang 568622ceaddSGao Xiang #ifdef CONFIG_EROFS_FS_ZIP_LZMA 569622ceaddSGao Xiang int z_erofs_lzma_init(void); 570622ceaddSGao Xiang void z_erofs_lzma_exit(void); 571622ceaddSGao Xiang int z_erofs_load_lzma_config(struct super_block *sb, 572622ceaddSGao Xiang struct erofs_super_block *dsb, 573622ceaddSGao Xiang struct z_erofs_lzma_cfgs *lzma, int size); 574622ceaddSGao Xiang #else 575622ceaddSGao Xiang static inline int z_erofs_lzma_init(void) { return 0; } 576622ceaddSGao Xiang static inline int z_erofs_lzma_exit(void) { return 0; } 577622ceaddSGao Xiang static inline int z_erofs_load_lzma_config(struct super_block *sb, 578622ceaddSGao Xiang struct erofs_super_block *dsb, 579622ceaddSGao Xiang struct z_erofs_lzma_cfgs *lzma, int size) { 580622ceaddSGao Xiang if (lzma) { 581622ceaddSGao Xiang erofs_err(sb, "lzma algorithm isn't enabled"); 582622ceaddSGao Xiang return -EINVAL; 583622ceaddSGao Xiang } 584622ceaddSGao Xiang return 0; 585622ceaddSGao Xiang } 586622ceaddSGao Xiang #endif /* !CONFIG_EROFS_FS_ZIP */ 587622ceaddSGao Xiang 588c6be2bd0SJeffle Xu /* fscache.c */ 589c6be2bd0SJeffle Xu #ifdef CONFIG_EROFS_FS_ONDEMAND 590c6be2bd0SJeffle Xu int erofs_fscache_register_fs(struct super_block *sb); 591c6be2bd0SJeffle Xu void erofs_fscache_unregister_fs(struct super_block *sb); 592b02c602fSJeffle Xu 593e1de2da0SJia Zhu struct erofs_fscache *erofs_fscache_register_cookie(struct super_block *sb, 5943c265d7dSJeffle Xu char *name, bool need_inode); 595e1de2da0SJia Zhu void erofs_fscache_unregister_cookie(struct erofs_fscache *fscache); 5961442b02bSJeffle Xu 5971442b02bSJeffle Xu extern const struct address_space_operations erofs_fscache_access_aops; 598c6be2bd0SJeffle Xu #else 599c6be2bd0SJeffle Xu static inline int erofs_fscache_register_fs(struct super_block *sb) 600c6be2bd0SJeffle Xu { 601e1de2da0SJia Zhu return -EOPNOTSUPP; 602c6be2bd0SJeffle Xu } 603c6be2bd0SJeffle Xu static inline void erofs_fscache_unregister_fs(struct super_block *sb) {} 604b02c602fSJeffle Xu 605e1de2da0SJia Zhu static inline 606e1de2da0SJia Zhu struct erofs_fscache *erofs_fscache_register_cookie(struct super_block *sb, 6073c265d7dSJeffle Xu char *name, bool need_inode) 608b02c602fSJeffle Xu { 609e1de2da0SJia Zhu return ERR_PTR(-EOPNOTSUPP); 610b02c602fSJeffle Xu } 611b02c602fSJeffle Xu 612e1de2da0SJia Zhu static inline void erofs_fscache_unregister_cookie(struct erofs_fscache *fscache) 613b02c602fSJeffle Xu { 614b02c602fSJeffle Xu } 615c6be2bd0SJeffle Xu #endif 616c6be2bd0SJeffle Xu 61747e4937aSGao Xiang #define EFSCORRUPTED EUCLEAN /* Filesystem is corrupted */ 61847e4937aSGao Xiang 61947e4937aSGao Xiang #endif /* __EROFS_INTERNAL_H */ 620