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; 848b465fecSJia Zhu bool flatdev; 85dfeab2e9SGao Xiang }; 86dfeab2e9SGao Xiang 87e6242465SGao Xiang struct erofs_fs_context { 88e6242465SGao Xiang struct erofs_mount_opts opt; 89dfeab2e9SGao Xiang struct erofs_dev_context *devs; 9039bfcb81SJingbo Xu char *fsid; 9139bfcb81SJingbo Xu char *domain_id; 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; 11161fef989SJingbo Xu struct inode *inode; /* anonymous inode for the blob */ 1122dfb8c3bSJingbo Xu 1132dfb8c3bSJingbo Xu /* used for share domain mode */ 1147d419637SJia Zhu struct erofs_domain *domain; 1152dfb8c3bSJingbo Xu struct list_head node; 1162dfb8c3bSJingbo 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; 13747e4937aSGao Xiang #endif /* CONFIG_EROFS_FS_ZIP */ 138*a97a218bSJingbo Xu struct inode *packed_inode; 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 1513acea5fcSJingbo Xu unsigned char islotbits; /* inode slot unit size in bit shift */ 152d3c4bdccSJingbo Xu unsigned char blkszbits; /* filesystem block size in bit shift */ 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; 160cb9bce79SJingbo Xu erofs_nid_t packed_nid; 16147e4937aSGao Xiang /* used for statfs, f_files - f_favail */ 16247e4937aSGao Xiang u64 inos; 16347e4937aSGao Xiang 16447e4937aSGao Xiang u8 uuid[16]; /* 128-bit uuid for volume */ 16547e4937aSGao Xiang u8 volume_name[16]; /* volume name */ 166b858a484SPratik Shinde u32 feature_compat; 167426a9308SGao Xiang u32 feature_incompat; 168168e9a76SHuang Jianan 169168e9a76SHuang Jianan /* sysfs support */ 170168e9a76SHuang Jianan struct kobject s_kobj; /* /sys/fs/erofs/<devname> */ 171168e9a76SHuang Jianan struct completion s_kobj_unregister; 172c6be2bd0SJeffle Xu 173c6be2bd0SJeffle Xu /* fscache support */ 174c6be2bd0SJeffle Xu struct fscache_volume *volume; 17537c90c5fSJeffle Xu struct erofs_fscache *s_fscache; 1768b7adf1dSJia Zhu struct erofs_domain *domain; 17739bfcb81SJingbo Xu char *fsid; 17839bfcb81SJingbo Xu char *domain_id; 17947e4937aSGao Xiang }; 18047e4937aSGao Xiang 18147e4937aSGao Xiang #define EROFS_SB(sb) ((struct erofs_sb_info *)(sb)->s_fs_info) 18247e4937aSGao Xiang #define EROFS_I_SB(inode) ((struct erofs_sb_info *)(inode)->i_sb->s_fs_info) 18347e4937aSGao Xiang 18447e4937aSGao Xiang /* Mount flags set via mount options or defaults */ 18547e4937aSGao Xiang #define EROFS_MOUNT_XATTR_USER 0x00000010 18647e4937aSGao Xiang #define EROFS_MOUNT_POSIX_ACL 0x00000020 18706252e9cSGao Xiang #define EROFS_MOUNT_DAX_ALWAYS 0x00000040 18806252e9cSGao Xiang #define EROFS_MOUNT_DAX_NEVER 0x00000080 18947e4937aSGao Xiang 190e6242465SGao Xiang #define clear_opt(opt, option) ((opt)->mount_opt &= ~EROFS_MOUNT_##option) 191e6242465SGao Xiang #define set_opt(opt, option) ((opt)->mount_opt |= EROFS_MOUNT_##option) 192e6242465SGao Xiang #define test_opt(opt, option) ((opt)->mount_opt & EROFS_MOUNT_##option) 19347e4937aSGao Xiang 19493b856bbSJeffle Xu static inline bool erofs_is_fscache_mode(struct super_block *sb) 19593b856bbSJeffle Xu { 19693b856bbSJeffle Xu return IS_ENABLED(CONFIG_EROFS_FS_ONDEMAND) && !sb->s_bdev; 19793b856bbSJeffle Xu } 19893b856bbSJeffle Xu 19947e4937aSGao Xiang enum { 20047e4937aSGao Xiang EROFS_ZIP_CACHE_DISABLED, 20147e4937aSGao Xiang EROFS_ZIP_CACHE_READAHEAD, 20247e4937aSGao Xiang EROFS_ZIP_CACHE_READAROUND 20347e4937aSGao Xiang }; 20447e4937aSGao Xiang 20547e4937aSGao Xiang #define EROFS_LOCKED_MAGIC (INT_MIN | 0xE0F510CCL) 20647e4937aSGao Xiang 20747e4937aSGao Xiang /* basic unit of the workstation of a super_block */ 20847e4937aSGao Xiang struct erofs_workgroup { 20947e4937aSGao Xiang /* the workgroup index in the workstation */ 21047e4937aSGao Xiang pgoff_t index; 21147e4937aSGao Xiang 21247e4937aSGao Xiang /* overall workgroup reference count */ 21347e4937aSGao Xiang atomic_t refcount; 21447e4937aSGao Xiang }; 21547e4937aSGao Xiang 21647e4937aSGao Xiang static inline bool erofs_workgroup_try_to_freeze(struct erofs_workgroup *grp, 21747e4937aSGao Xiang int val) 21847e4937aSGao Xiang { 21947e4937aSGao Xiang preempt_disable(); 22047e4937aSGao Xiang if (val != atomic_cmpxchg(&grp->refcount, val, EROFS_LOCKED_MAGIC)) { 22147e4937aSGao Xiang preempt_enable(); 22247e4937aSGao Xiang return false; 22347e4937aSGao Xiang } 22447e4937aSGao Xiang return true; 22547e4937aSGao Xiang } 22647e4937aSGao Xiang 22747e4937aSGao Xiang static inline void erofs_workgroup_unfreeze(struct erofs_workgroup *grp, 22847e4937aSGao Xiang int orig_val) 22947e4937aSGao Xiang { 23047e4937aSGao Xiang /* 23147e4937aSGao Xiang * other observers should notice all modifications 23247e4937aSGao Xiang * in the freezing period. 23347e4937aSGao Xiang */ 23447e4937aSGao Xiang smp_mb(); 23547e4937aSGao Xiang atomic_set(&grp->refcount, orig_val); 23647e4937aSGao Xiang preempt_enable(); 23747e4937aSGao Xiang } 23847e4937aSGao Xiang 23947e4937aSGao Xiang static inline int erofs_wait_on_workgroup_freezed(struct erofs_workgroup *grp) 24047e4937aSGao Xiang { 24147e4937aSGao Xiang return atomic_cond_read_relaxed(&grp->refcount, 24247e4937aSGao Xiang VAL != EROFS_LOCKED_MAGIC); 24347e4937aSGao Xiang } 24447e4937aSGao Xiang 245fdf80a47SGao Xiang enum erofs_kmap_type { 246fdf80a47SGao Xiang EROFS_NO_KMAP, /* don't map the buffer */ 247927e5010SGao Xiang EROFS_KMAP, /* use kmap_local_page() to map the buffer */ 248fdf80a47SGao Xiang }; 249fdf80a47SGao Xiang 250fdf80a47SGao Xiang struct erofs_buf { 251eb2c5e41SGao Xiang struct inode *inode; 252fdf80a47SGao Xiang struct page *page; 253fdf80a47SGao Xiang void *base; 254fdf80a47SGao Xiang enum erofs_kmap_type kmap_type; 255fdf80a47SGao Xiang }; 256fdf80a47SGao Xiang #define __EROFS_BUF_INITIALIZER ((struct erofs_buf){ .page = NULL }) 257fdf80a47SGao Xiang 25847e4937aSGao Xiang #define ROOT_NID(sb) ((sb)->root_nid) 25947e4937aSGao Xiang 2603acea5fcSJingbo Xu #define erofs_blknr(sb, addr) ((addr) >> (sb)->s_blocksize_bits) 2613acea5fcSJingbo Xu #define erofs_blkoff(sb, addr) ((addr) & ((sb)->s_blocksize - 1)) 2623acea5fcSJingbo Xu #define erofs_pos(sb, blk) ((erofs_off_t)(blk) << (sb)->s_blocksize_bits) 2633acea5fcSJingbo Xu #define erofs_iblks(i) (round_up((i)->i_size, i_blocksize(i)) >> (i)->i_blkbits) 26447e4937aSGao Xiang 265de06a6a3SGao Xiang #define EROFS_FEATURE_FUNCS(name, compat, feature) \ 266de06a6a3SGao Xiang static inline bool erofs_sb_has_##name(struct erofs_sb_info *sbi) \ 267de06a6a3SGao Xiang { \ 268de06a6a3SGao Xiang return sbi->feature_##compat & EROFS_FEATURE_##feature; \ 269de06a6a3SGao Xiang } 270de06a6a3SGao Xiang 2717e508f2cSHuang Jianan EROFS_FEATURE_FUNCS(zero_padding, incompat, INCOMPAT_ZERO_PADDING) 27214373711SGao Xiang EROFS_FEATURE_FUNCS(compr_cfgs, incompat, INCOMPAT_COMPR_CFGS) 2735404c330SGao Xiang EROFS_FEATURE_FUNCS(big_pcluster, incompat, INCOMPAT_BIG_PCLUSTER) 274168e9a76SHuang Jianan EROFS_FEATURE_FUNCS(chunked_file, incompat, INCOMPAT_CHUNKED_FILE) 275dfeab2e9SGao Xiang EROFS_FEATURE_FUNCS(device_table, incompat, INCOMPAT_DEVICE_TABLE) 276168e9a76SHuang Jianan EROFS_FEATURE_FUNCS(compr_head2, incompat, INCOMPAT_COMPR_HEAD2) 277ab92184fSYue Hu EROFS_FEATURE_FUNCS(ztailpacking, incompat, INCOMPAT_ZTAILPACKING) 278b15b2e30SYue Hu EROFS_FEATURE_FUNCS(fragments, incompat, INCOMPAT_FRAGMENTS) 2795c2a6425SGao Xiang EROFS_FEATURE_FUNCS(dedupe, incompat, INCOMPAT_DEDUPE) 280de06a6a3SGao Xiang EROFS_FEATURE_FUNCS(sb_chksum, compat, COMPAT_SB_CHKSUM) 281de06a6a3SGao Xiang 28247e4937aSGao Xiang /* atomic flag definitions */ 283a5876e24SGao Xiang #define EROFS_I_EA_INITED_BIT 0 284a5876e24SGao Xiang #define EROFS_I_Z_INITED_BIT 1 28547e4937aSGao Xiang 28647e4937aSGao Xiang /* bitlock definitions (arranged in reverse order) */ 287a5876e24SGao Xiang #define EROFS_I_BL_XATTR_BIT (BITS_PER_LONG - 1) 288a5876e24SGao Xiang #define EROFS_I_BL_Z_BIT (BITS_PER_LONG - 2) 28947e4937aSGao Xiang 290a5876e24SGao Xiang struct erofs_inode { 29147e4937aSGao Xiang erofs_nid_t nid; 29247e4937aSGao Xiang 29347e4937aSGao Xiang /* atomic flags (including bitlocks) */ 29447e4937aSGao Xiang unsigned long flags; 29547e4937aSGao Xiang 2968a765682SGao Xiang unsigned char datalayout; 29747e4937aSGao Xiang unsigned char inode_isize; 29847e4937aSGao Xiang unsigned short xattr_isize; 29947e4937aSGao Xiang 30047e4937aSGao Xiang unsigned int xattr_shared_count; 30147e4937aSGao Xiang unsigned int *xattr_shared_xattrs; 30247e4937aSGao Xiang 30347e4937aSGao Xiang union { 30447e4937aSGao Xiang erofs_blk_t raw_blkaddr; 305c5aa903aSGao Xiang struct { 306c5aa903aSGao Xiang unsigned short chunkformat; 307c5aa903aSGao Xiang unsigned char chunkbits; 308c5aa903aSGao Xiang }; 30947e4937aSGao Xiang #ifdef CONFIG_EROFS_FS_ZIP 31047e4937aSGao Xiang struct { 31147e4937aSGao Xiang unsigned short z_advise; 31247e4937aSGao Xiang unsigned char z_algorithmtype[2]; 31347e4937aSGao Xiang unsigned char z_logical_clusterbits; 314ab92184fSYue Hu unsigned long z_tailextent_headlcn; 315b15b2e30SYue Hu union { 316b15b2e30SYue Hu struct { 31722ba5e99SGao Xiang erofs_off_t z_idataoff; 318ab92184fSYue Hu unsigned short z_idata_size; 31947e4937aSGao Xiang }; 320b15b2e30SYue Hu erofs_off_t z_fragmentoff; 321b15b2e30SYue Hu }; 322b15b2e30SYue Hu }; 32347e4937aSGao Xiang #endif /* CONFIG_EROFS_FS_ZIP */ 32447e4937aSGao Xiang }; 32547e4937aSGao Xiang /* the corresponding vfs inode */ 32647e4937aSGao Xiang struct inode vfs_inode; 32747e4937aSGao Xiang }; 32847e4937aSGao Xiang 329b780d3fcSGao Xiang #define EROFS_I(ptr) container_of(ptr, struct erofs_inode, vfs_inode) 33047e4937aSGao Xiang 331b780d3fcSGao Xiang static inline erofs_off_t erofs_iloc(struct inode *inode) 33247e4937aSGao Xiang { 333b780d3fcSGao Xiang struct erofs_sb_info *sbi = EROFS_I_SB(inode); 334b780d3fcSGao Xiang 3353acea5fcSJingbo Xu return erofs_pos(inode->i_sb, sbi->meta_blkaddr) + 336b780d3fcSGao Xiang (EROFS_I(inode)->nid << sbi->islotbits); 33747e4937aSGao Xiang } 33847e4937aSGao Xiang 3398a765682SGao Xiang static inline unsigned int erofs_bitrange(unsigned int value, unsigned int bit, 3408a765682SGao Xiang unsigned int bits) 34147e4937aSGao Xiang { 3428a765682SGao Xiang 3438a765682SGao Xiang return (value >> bit) & ((1 << bits) - 1); 34447e4937aSGao Xiang } 34547e4937aSGao Xiang 3468a765682SGao Xiang 3478a765682SGao Xiang static inline unsigned int erofs_inode_version(unsigned int value) 34847e4937aSGao Xiang { 3498a765682SGao Xiang return erofs_bitrange(value, EROFS_I_VERSION_BIT, 3508a765682SGao Xiang EROFS_I_VERSION_BITS); 3518a765682SGao Xiang } 3528a765682SGao Xiang 3538a765682SGao Xiang static inline unsigned int erofs_inode_datalayout(unsigned int value) 3548a765682SGao Xiang { 3558a765682SGao Xiang return erofs_bitrange(value, EROFS_I_DATALAYOUT_BIT, 3568a765682SGao Xiang EROFS_I_DATALAYOUT_BITS); 35747e4937aSGao Xiang } 35847e4937aSGao Xiang 35938629291SGao Xiang /* 36038629291SGao Xiang * Different from grab_cache_page_nowait(), reclaiming is never triggered 36138629291SGao Xiang * when allocating new pages. 36238629291SGao Xiang */ 36338629291SGao Xiang static inline 36438629291SGao Xiang struct page *erofs_grab_cache_page_nowait(struct address_space *mapping, 36538629291SGao Xiang pgoff_t index) 36638629291SGao Xiang { 36738629291SGao Xiang return pagecache_get_page(mapping, index, 36838629291SGao Xiang FGP_LOCK|FGP_CREAT|FGP_NOFS|FGP_NOWAIT, 36938629291SGao Xiang readahead_gfp_mask(mapping) & ~__GFP_RECLAIM); 37038629291SGao Xiang } 37138629291SGao Xiang 37247e4937aSGao Xiang /* Has a disk mapping */ 373768bb10aSGao Xiang #define EROFS_MAP_MAPPED 0x0001 37447e4937aSGao Xiang /* Located in metadata (could be copied from bd_inode) */ 375768bb10aSGao Xiang #define EROFS_MAP_META 0x0002 3768f899262SGao Xiang /* The extent is encoded */ 377768bb10aSGao Xiang #define EROFS_MAP_ENCODED 0x0004 37847e4937aSGao Xiang /* The length of extent is full */ 379768bb10aSGao Xiang #define EROFS_MAP_FULL_MAPPED 0x0008 380b15b2e30SYue Hu /* Located in the special packed inode */ 381768bb10aSGao Xiang #define EROFS_MAP_FRAGMENT 0x0010 3825c2a6425SGao Xiang /* The extent refers to partial decompressed data */ 383768bb10aSGao Xiang #define EROFS_MAP_PARTIAL_REF 0x0020 38447e4937aSGao Xiang 38547e4937aSGao Xiang struct erofs_map_blocks { 38609c54379SGao Xiang struct erofs_buf buf; 38709c54379SGao Xiang 38847e4937aSGao Xiang erofs_off_t m_pa, m_la; 38947e4937aSGao Xiang u64 m_plen, m_llen; 39047e4937aSGao Xiang 391dfeab2e9SGao Xiang unsigned short m_deviceid; 3928f899262SGao Xiang char m_algorithmformat; 39347e4937aSGao Xiang unsigned int m_flags; 39447e4937aSGao Xiang }; 39547e4937aSGao Xiang 396d95ae5e2SGao Xiang /* 397d95ae5e2SGao Xiang * Used to get the exact decompressed length, e.g. fiemap (consider lookback 398d95ae5e2SGao Xiang * approach instead if possible since it's more metadata lightweight.) 399d95ae5e2SGao Xiang */ 4008b58f9f0SJingbo Xu #define EROFS_GET_BLOCKS_FIEMAP 0x0001 401622ceaddSGao Xiang /* Used to map the whole extent if non-negligible data is requested for LZMA */ 4028b58f9f0SJingbo Xu #define EROFS_GET_BLOCKS_READMORE 0x0002 403b15b2e30SYue Hu /* Used to map tail extent for tailpacking inline or fragment pcluster */ 4048b58f9f0SJingbo Xu #define EROFS_GET_BLOCKS_FINDTAIL 0x0004 40547e4937aSGao Xiang 4068f899262SGao Xiang enum { 4078f899262SGao Xiang Z_EROFS_COMPRESSION_SHIFTED = Z_EROFS_COMPRESSION_MAX, 408fdffc091SYue Hu Z_EROFS_COMPRESSION_INTERLACED, 4098f899262SGao Xiang Z_EROFS_COMPRESSION_RUNTIME_MAX 4108f899262SGao Xiang }; 4118f899262SGao Xiang 412dfeab2e9SGao Xiang struct erofs_map_dev { 413955b478eSJeffle Xu struct erofs_fscache *m_fscache; 414dfeab2e9SGao Xiang struct block_device *m_bdev; 415dfeab2e9SGao Xiang struct dax_device *m_daxdev; 416de205114SChristoph Hellwig u64 m_dax_part_off; 417dfeab2e9SGao Xiang 418dfeab2e9SGao Xiang erofs_off_t m_pa; 419dfeab2e9SGao Xiang unsigned int m_deviceid; 420dfeab2e9SGao Xiang }; 421dfeab2e9SGao Xiang 422557afdd9SGao Xiang extern struct file_system_type erofs_fs_type; 423557afdd9SGao Xiang extern const struct super_operations erofs_sops; 424557afdd9SGao Xiang 425557afdd9SGao Xiang extern const struct address_space_operations erofs_raw_access_aops; 426557afdd9SGao Xiang extern const struct address_space_operations z_erofs_aops; 427557afdd9SGao Xiang extern const struct address_space_operations erofs_fscache_access_aops; 428557afdd9SGao Xiang 429557afdd9SGao Xiang extern const struct inode_operations erofs_generic_iops; 430557afdd9SGao Xiang extern const struct inode_operations erofs_symlink_iops; 431557afdd9SGao Xiang extern const struct inode_operations erofs_fast_symlink_iops; 432557afdd9SGao Xiang extern const struct inode_operations erofs_dir_iops; 433557afdd9SGao Xiang 434a08e67a0SHuang Jianan extern const struct file_operations erofs_file_fops; 435557afdd9SGao Xiang extern const struct file_operations erofs_dir_fops; 436557afdd9SGao Xiang 437557afdd9SGao Xiang extern const struct iomap_ops z_erofs_iomap_report_ops; 438557afdd9SGao Xiang 439557afdd9SGao Xiang /* flags for erofs_fscache_register_cookie() */ 44061fef989SJingbo Xu #define EROFS_REG_COOKIE_SHARE 0x0001 44161fef989SJingbo Xu #define EROFS_REG_COOKIE_NEED_NOEXIST 0x0002 442557afdd9SGao Xiang 44309c54379SGao Xiang void erofs_unmap_metabuf(struct erofs_buf *buf); 444c521e3adSGao Xiang void erofs_put_metabuf(struct erofs_buf *buf); 445eb2c5e41SGao Xiang void *erofs_bread(struct erofs_buf *buf, erofs_blk_t blkaddr, 446eb2c5e41SGao Xiang enum erofs_kmap_type type); 447eb2c5e41SGao Xiang void erofs_init_metabuf(struct erofs_buf *buf, struct super_block *sb); 448c521e3adSGao Xiang void *erofs_read_metabuf(struct erofs_buf *buf, struct super_block *sb, 449c521e3adSGao Xiang erofs_blk_t blkaddr, enum erofs_kmap_type type); 450dfeab2e9SGao Xiang int erofs_map_dev(struct super_block *sb, struct erofs_map_dev *dev); 451eadcd6b5SGao Xiang int erofs_fiemap(struct inode *inode, struct fiemap_extent_info *fieinfo, 452eadcd6b5SGao Xiang u64 start, u64 len); 4538b58f9f0SJingbo Xu int erofs_map_blocks(struct inode *inode, struct erofs_map_blocks *map); 454312fe643SGao Xiang struct inode *erofs_iget(struct super_block *sb, erofs_nid_t nid); 455b74d24f7SChristian Brauner int erofs_getattr(struct mnt_idmap *idmap, const struct path *path, 456549c7297SChristian Brauner struct kstat *stat, u32 request_mask, 457549c7297SChristian Brauner unsigned int query_flags); 4583e917cc3SHongnan Li int erofs_namei(struct inode *dir, const struct qstr *name, 45947e4937aSGao Xiang erofs_nid_t *nid, unsigned int *d_type); 46047e4937aSGao Xiang 461598162d0SGao Xiang static inline void *erofs_vm_map_ram(struct page **pages, unsigned int count) 462598162d0SGao Xiang { 463598162d0SGao Xiang int retried = 0; 464598162d0SGao Xiang 465598162d0SGao Xiang while (1) { 466598162d0SGao Xiang void *p = vm_map_ram(pages, count, -1); 467598162d0SGao Xiang 468598162d0SGao Xiang /* retry two more times (totally 3 times) */ 469598162d0SGao Xiang if (p || ++retried >= 3) 470598162d0SGao Xiang return p; 471598162d0SGao Xiang vm_unmap_aliases(); 472598162d0SGao Xiang } 473598162d0SGao Xiang return NULL; 474598162d0SGao Xiang } 475598162d0SGao Xiang 47652488734SGao Xiang void *erofs_get_pcpubuf(unsigned int requiredpages); 47752488734SGao Xiang void erofs_put_pcpubuf(void *ptr); 47852488734SGao Xiang int erofs_pcpubuf_growsize(unsigned int nrpages); 479a279adedSYangtao Li void __init erofs_pcpubuf_init(void); 48052488734SGao Xiang void erofs_pcpubuf_exit(void); 48152488734SGao Xiang 482168e9a76SHuang Jianan int erofs_register_sysfs(struct super_block *sb); 483168e9a76SHuang Jianan void erofs_unregister_sysfs(struct super_block *sb); 484168e9a76SHuang Jianan int __init erofs_init_sysfs(void); 485168e9a76SHuang Jianan void erofs_exit_sysfs(void); 486168e9a76SHuang Jianan 487eaa9172aSGao Xiang struct page *erofs_allocpage(struct page **pagepool, gfp_t gfp); 488557afdd9SGao Xiang static inline void erofs_pagepool_add(struct page **pagepool, struct page *page) 489eaa9172aSGao Xiang { 490eaa9172aSGao Xiang set_page_private(page, (unsigned long)*pagepool); 491eaa9172aSGao Xiang *pagepool = page; 492eaa9172aSGao Xiang } 493eaa9172aSGao Xiang void erofs_release_pages(struct page **pagepool); 49447e4937aSGao Xiang 49547e4937aSGao Xiang #ifdef CONFIG_EROFS_FS_ZIP 49647e4937aSGao Xiang int erofs_workgroup_put(struct erofs_workgroup *grp); 49747e4937aSGao Xiang struct erofs_workgroup *erofs_find_workgroup(struct super_block *sb, 498997626d8SVladimir Zapolskiy pgoff_t index); 49964094a04SGao Xiang struct erofs_workgroup *erofs_insert_workgroup(struct super_block *sb, 500e5e9a432SVladimir Zapolskiy struct erofs_workgroup *grp); 50147e4937aSGao Xiang void erofs_workgroup_free_rcu(struct erofs_workgroup *grp); 50247e4937aSGao Xiang void erofs_shrinker_register(struct super_block *sb); 50347e4937aSGao Xiang void erofs_shrinker_unregister(struct super_block *sb); 50447e4937aSGao Xiang int __init erofs_init_shrinker(void); 50547e4937aSGao Xiang void erofs_exit_shrinker(void); 50647e4937aSGao Xiang int __init z_erofs_init_zip_subsystem(void); 50747e4937aSGao Xiang void z_erofs_exit_zip_subsystem(void); 50847e4937aSGao Xiang int erofs_try_to_free_all_cached_pages(struct erofs_sb_info *sbi, 50947e4937aSGao Xiang struct erofs_workgroup *egrp); 510d252ff3dSYue Hu int erofs_try_to_free_cached_page(struct page *page); 5115d50538fSHuang Jianan int z_erofs_load_lz4_config(struct super_block *sb, 51246249cdeSGao Xiang struct erofs_super_block *dsb, 51346249cdeSGao Xiang struct z_erofs_lz4_cfgs *lz4, int len); 514557afdd9SGao Xiang int z_erofs_fill_inode(struct inode *inode); 515557afdd9SGao Xiang int z_erofs_map_blocks_iter(struct inode *inode, struct erofs_map_blocks *map, 516557afdd9SGao Xiang int flags); 51747e4937aSGao Xiang #else 51847e4937aSGao Xiang static inline void erofs_shrinker_register(struct super_block *sb) {} 51947e4937aSGao Xiang static inline void erofs_shrinker_unregister(struct super_block *sb) {} 52047e4937aSGao Xiang static inline int erofs_init_shrinker(void) { return 0; } 52147e4937aSGao Xiang static inline void erofs_exit_shrinker(void) {} 52247e4937aSGao Xiang static inline int z_erofs_init_zip_subsystem(void) { return 0; } 52347e4937aSGao Xiang static inline void z_erofs_exit_zip_subsystem(void) {} 5245d50538fSHuang Jianan static inline int z_erofs_load_lz4_config(struct super_block *sb, 52546249cdeSGao Xiang struct erofs_super_block *dsb, 52646249cdeSGao Xiang struct z_erofs_lz4_cfgs *lz4, int len) 5275d50538fSHuang Jianan { 52814373711SGao Xiang if (lz4 || dsb->u1.lz4_max_distance) { 5295d50538fSHuang Jianan erofs_err(sb, "lz4 algorithm isn't enabled"); 5305d50538fSHuang Jianan return -EINVAL; 5315d50538fSHuang Jianan } 5325d50538fSHuang Jianan return 0; 5335d50538fSHuang Jianan } 534557afdd9SGao Xiang static inline int z_erofs_fill_inode(struct inode *inode) { return -EOPNOTSUPP; } 53547e4937aSGao Xiang #endif /* !CONFIG_EROFS_FS_ZIP */ 53647e4937aSGao Xiang 537622ceaddSGao Xiang #ifdef CONFIG_EROFS_FS_ZIP_LZMA 538a279adedSYangtao Li int __init z_erofs_lzma_init(void); 539622ceaddSGao Xiang void z_erofs_lzma_exit(void); 540622ceaddSGao Xiang int z_erofs_load_lzma_config(struct super_block *sb, 541622ceaddSGao Xiang struct erofs_super_block *dsb, 542622ceaddSGao Xiang struct z_erofs_lzma_cfgs *lzma, int size); 543622ceaddSGao Xiang #else 544622ceaddSGao Xiang static inline int z_erofs_lzma_init(void) { return 0; } 545622ceaddSGao Xiang static inline int z_erofs_lzma_exit(void) { return 0; } 546622ceaddSGao Xiang static inline int z_erofs_load_lzma_config(struct super_block *sb, 547622ceaddSGao Xiang struct erofs_super_block *dsb, 548622ceaddSGao Xiang struct z_erofs_lzma_cfgs *lzma, int size) { 549622ceaddSGao Xiang if (lzma) { 550622ceaddSGao Xiang erofs_err(sb, "lzma algorithm isn't enabled"); 551622ceaddSGao Xiang return -EINVAL; 552622ceaddSGao Xiang } 553622ceaddSGao Xiang return 0; 554622ceaddSGao Xiang } 555557afdd9SGao Xiang #endif /* !CONFIG_EROFS_FS_ZIP_LZMA */ 556622ceaddSGao Xiang 557c6be2bd0SJeffle Xu #ifdef CONFIG_EROFS_FS_ONDEMAND 558c6be2bd0SJeffle Xu int erofs_fscache_register_fs(struct super_block *sb); 559c6be2bd0SJeffle Xu void erofs_fscache_unregister_fs(struct super_block *sb); 560b02c602fSJeffle Xu 561e1de2da0SJia Zhu struct erofs_fscache *erofs_fscache_register_cookie(struct super_block *sb, 562557afdd9SGao Xiang char *name, unsigned int flags); 563e1de2da0SJia Zhu void erofs_fscache_unregister_cookie(struct erofs_fscache *fscache); 564c6be2bd0SJeffle Xu #else 565c6be2bd0SJeffle Xu static inline int erofs_fscache_register_fs(struct super_block *sb) 566c6be2bd0SJeffle Xu { 567e1de2da0SJia Zhu return -EOPNOTSUPP; 568c6be2bd0SJeffle Xu } 569c6be2bd0SJeffle Xu static inline void erofs_fscache_unregister_fs(struct super_block *sb) {} 570b02c602fSJeffle Xu 571e1de2da0SJia Zhu static inline 572e1de2da0SJia Zhu struct erofs_fscache *erofs_fscache_register_cookie(struct super_block *sb, 573557afdd9SGao Xiang char *name, unsigned int flags) 574b02c602fSJeffle Xu { 575e1de2da0SJia Zhu return ERR_PTR(-EOPNOTSUPP); 576b02c602fSJeffle Xu } 577b02c602fSJeffle Xu 578e1de2da0SJia Zhu static inline void erofs_fscache_unregister_cookie(struct erofs_fscache *fscache) 579b02c602fSJeffle Xu { 580b02c602fSJeffle Xu } 581c6be2bd0SJeffle Xu #endif 582c6be2bd0SJeffle Xu 58347e4937aSGao Xiang #define EFSCORRUPTED EUCLEAN /* Filesystem is corrupted */ 58447e4937aSGao Xiang 58547e4937aSGao Xiang #endif /* __EROFS_INTERNAL_H */ 586