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; 79f57a3fe4SChao Yu }; 80f57a3fe4SChao Yu 81dfeab2e9SGao Xiang struct erofs_dev_context { 82dfeab2e9SGao Xiang struct idr tree; 83dfeab2e9SGao Xiang struct rw_semaphore rwsem; 84dfeab2e9SGao Xiang 85dfeab2e9SGao Xiang unsigned int extra_devices; 86dfeab2e9SGao Xiang }; 87dfeab2e9SGao Xiang 88e6242465SGao Xiang struct erofs_fs_context { 89e6242465SGao Xiang struct erofs_mount_opts opt; 90dfeab2e9SGao Xiang struct erofs_dev_context *devs; 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 101b02c602fSJeffle Xu struct erofs_fscache { 102b02c602fSJeffle Xu struct fscache_cookie *cookie; 1033c265d7dSJeffle Xu struct inode *inode; 104b02c602fSJeffle Xu }; 105b02c602fSJeffle Xu 10647e4937aSGao Xiang struct erofs_sb_info { 107e6242465SGao Xiang struct erofs_mount_opts opt; /* options */ 10847e4937aSGao Xiang #ifdef CONFIG_EROFS_FS_ZIP 10947e4937aSGao Xiang /* list for all registered superblocks, mainly for shrinker */ 11047e4937aSGao Xiang struct list_head list; 11147e4937aSGao Xiang struct mutex umount_mutex; 11247e4937aSGao Xiang 11364094a04SGao Xiang /* managed XArray arranged in physical block number */ 11464094a04SGao Xiang struct xarray managed_pslots; 11547e4937aSGao Xiang 11647e4937aSGao Xiang unsigned int shrinker_run_no; 11714373711SGao Xiang u16 available_compr_algs; 11847e4937aSGao Xiang 11947e4937aSGao Xiang /* pseudo inode to manage cached pages */ 12047e4937aSGao Xiang struct inode *managed_cache; 1215d50538fSHuang Jianan 1225d50538fSHuang Jianan struct erofs_sb_lz4_info lz4; 12347e4937aSGao Xiang #endif /* CONFIG_EROFS_FS_ZIP */ 124dfeab2e9SGao Xiang struct erofs_dev_context *devs; 12506252e9cSGao Xiang struct dax_device *dax_dev; 126cd913c76SChristoph Hellwig u64 dax_part_off; 127dfeab2e9SGao Xiang u64 total_blocks; 128dfeab2e9SGao Xiang u32 primarydevice_blocks; 129dfeab2e9SGao Xiang 13047e4937aSGao Xiang u32 meta_blkaddr; 13147e4937aSGao Xiang #ifdef CONFIG_EROFS_FS_XATTR 13247e4937aSGao Xiang u32 xattr_blkaddr; 13347e4937aSGao Xiang #endif 134dfeab2e9SGao Xiang u16 device_id_mask; /* valid bits of device id to be used */ 13547e4937aSGao Xiang 13647e4937aSGao Xiang /* inode slot unit size in bit shift */ 13747e4937aSGao Xiang unsigned char islotbits; 13847e4937aSGao Xiang 13914373711SGao Xiang u32 sb_size; /* total superblock size */ 14047e4937aSGao Xiang u32 build_time_nsec; 14147e4937aSGao Xiang u64 build_time; 14247e4937aSGao Xiang 14347e4937aSGao Xiang /* what we really care is nid, rather than ino.. */ 14447e4937aSGao Xiang erofs_nid_t root_nid; 14547e4937aSGao Xiang /* used for statfs, f_files - f_favail */ 14647e4937aSGao Xiang u64 inos; 14747e4937aSGao Xiang 14847e4937aSGao Xiang u8 uuid[16]; /* 128-bit uuid for volume */ 14947e4937aSGao Xiang u8 volume_name[16]; /* volume name */ 150b858a484SPratik Shinde u32 feature_compat; 151426a9308SGao Xiang u32 feature_incompat; 152168e9a76SHuang Jianan 153168e9a76SHuang Jianan /* sysfs support */ 154168e9a76SHuang Jianan struct kobject s_kobj; /* /sys/fs/erofs/<devname> */ 155168e9a76SHuang Jianan struct completion s_kobj_unregister; 156c6be2bd0SJeffle Xu 157c6be2bd0SJeffle Xu /* fscache support */ 158c6be2bd0SJeffle Xu struct fscache_volume *volume; 15937c90c5fSJeffle Xu struct erofs_fscache *s_fscache; 16047e4937aSGao Xiang }; 16147e4937aSGao Xiang 16247e4937aSGao Xiang #define EROFS_SB(sb) ((struct erofs_sb_info *)(sb)->s_fs_info) 16347e4937aSGao Xiang #define EROFS_I_SB(inode) ((struct erofs_sb_info *)(inode)->i_sb->s_fs_info) 16447e4937aSGao Xiang 16547e4937aSGao Xiang /* Mount flags set via mount options or defaults */ 16647e4937aSGao Xiang #define EROFS_MOUNT_XATTR_USER 0x00000010 16747e4937aSGao Xiang #define EROFS_MOUNT_POSIX_ACL 0x00000020 16806252e9cSGao Xiang #define EROFS_MOUNT_DAX_ALWAYS 0x00000040 16906252e9cSGao Xiang #define EROFS_MOUNT_DAX_NEVER 0x00000080 17047e4937aSGao Xiang 171e6242465SGao Xiang #define clear_opt(opt, option) ((opt)->mount_opt &= ~EROFS_MOUNT_##option) 172e6242465SGao Xiang #define set_opt(opt, option) ((opt)->mount_opt |= EROFS_MOUNT_##option) 173e6242465SGao Xiang #define test_opt(opt, option) ((opt)->mount_opt & EROFS_MOUNT_##option) 17447e4937aSGao Xiang 17593b856bbSJeffle Xu static inline bool erofs_is_fscache_mode(struct super_block *sb) 17693b856bbSJeffle Xu { 17793b856bbSJeffle Xu return IS_ENABLED(CONFIG_EROFS_FS_ONDEMAND) && !sb->s_bdev; 17893b856bbSJeffle Xu } 17993b856bbSJeffle Xu 18047e4937aSGao Xiang enum { 18147e4937aSGao Xiang EROFS_ZIP_CACHE_DISABLED, 18247e4937aSGao Xiang EROFS_ZIP_CACHE_READAHEAD, 18347e4937aSGao Xiang EROFS_ZIP_CACHE_READAROUND 18447e4937aSGao Xiang }; 18547e4937aSGao Xiang 186f57a3fe4SChao Yu #ifdef CONFIG_EROFS_FS_ZIP 18747e4937aSGao Xiang #define EROFS_LOCKED_MAGIC (INT_MIN | 0xE0F510CCL) 18847e4937aSGao Xiang 18947e4937aSGao Xiang /* basic unit of the workstation of a super_block */ 19047e4937aSGao Xiang struct erofs_workgroup { 19147e4937aSGao Xiang /* the workgroup index in the workstation */ 19247e4937aSGao Xiang pgoff_t index; 19347e4937aSGao Xiang 19447e4937aSGao Xiang /* overall workgroup reference count */ 19547e4937aSGao Xiang atomic_t refcount; 19647e4937aSGao Xiang }; 19747e4937aSGao Xiang 19847e4937aSGao Xiang static inline bool erofs_workgroup_try_to_freeze(struct erofs_workgroup *grp, 19947e4937aSGao Xiang int val) 20047e4937aSGao Xiang { 20147e4937aSGao Xiang preempt_disable(); 20247e4937aSGao Xiang if (val != atomic_cmpxchg(&grp->refcount, val, EROFS_LOCKED_MAGIC)) { 20347e4937aSGao Xiang preempt_enable(); 20447e4937aSGao Xiang return false; 20547e4937aSGao Xiang } 20647e4937aSGao Xiang return true; 20747e4937aSGao Xiang } 20847e4937aSGao Xiang 20947e4937aSGao Xiang static inline void erofs_workgroup_unfreeze(struct erofs_workgroup *grp, 21047e4937aSGao Xiang int orig_val) 21147e4937aSGao Xiang { 21247e4937aSGao Xiang /* 21347e4937aSGao Xiang * other observers should notice all modifications 21447e4937aSGao Xiang * in the freezing period. 21547e4937aSGao Xiang */ 21647e4937aSGao Xiang smp_mb(); 21747e4937aSGao Xiang atomic_set(&grp->refcount, orig_val); 21847e4937aSGao Xiang preempt_enable(); 21947e4937aSGao Xiang } 22047e4937aSGao Xiang 22147e4937aSGao Xiang static inline int erofs_wait_on_workgroup_freezed(struct erofs_workgroup *grp) 22247e4937aSGao Xiang { 22347e4937aSGao Xiang return atomic_cond_read_relaxed(&grp->refcount, 22447e4937aSGao Xiang VAL != EROFS_LOCKED_MAGIC); 22547e4937aSGao Xiang } 22647e4937aSGao Xiang #endif /* !CONFIG_EROFS_FS_ZIP */ 22747e4937aSGao Xiang 22847e4937aSGao Xiang /* we strictly follow PAGE_SIZE and no buffer head yet */ 22947e4937aSGao Xiang #define LOG_BLOCK_SIZE PAGE_SHIFT 23047e4937aSGao Xiang 23147e4937aSGao Xiang #undef LOG_SECTORS_PER_BLOCK 23247e4937aSGao Xiang #define LOG_SECTORS_PER_BLOCK (PAGE_SHIFT - 9) 23347e4937aSGao Xiang 23447e4937aSGao Xiang #undef SECTORS_PER_BLOCK 23547e4937aSGao Xiang #define SECTORS_PER_BLOCK (1 << SECTORS_PER_BLOCK) 23647e4937aSGao Xiang 23747e4937aSGao Xiang #define EROFS_BLKSIZ (1 << LOG_BLOCK_SIZE) 23847e4937aSGao Xiang 23947e4937aSGao Xiang #if (EROFS_BLKSIZ % 4096 || !EROFS_BLKSIZ) 24047e4937aSGao Xiang #error erofs cannot be used in this platform 24147e4937aSGao Xiang #endif 24247e4937aSGao Xiang 243fdf80a47SGao Xiang enum erofs_kmap_type { 244fdf80a47SGao Xiang EROFS_NO_KMAP, /* don't map the buffer */ 245fdf80a47SGao Xiang EROFS_KMAP, /* use kmap() to map the buffer */ 246fdf80a47SGao Xiang EROFS_KMAP_ATOMIC, /* use kmap_atomic() to map the buffer */ 247fdf80a47SGao Xiang }; 248fdf80a47SGao Xiang 249fdf80a47SGao Xiang struct erofs_buf { 250fdf80a47SGao Xiang struct page *page; 251fdf80a47SGao Xiang void *base; 252fdf80a47SGao Xiang enum erofs_kmap_type kmap_type; 253fdf80a47SGao Xiang }; 254fdf80a47SGao Xiang #define __EROFS_BUF_INITIALIZER ((struct erofs_buf){ .page = NULL }) 255fdf80a47SGao Xiang 25647e4937aSGao Xiang #define ROOT_NID(sb) ((sb)->root_nid) 25747e4937aSGao Xiang 25847e4937aSGao Xiang #define erofs_blknr(addr) ((addr) / EROFS_BLKSIZ) 25947e4937aSGao Xiang #define erofs_blkoff(addr) ((addr) % EROFS_BLKSIZ) 26047e4937aSGao Xiang #define blknr_to_addr(nr) ((erofs_off_t)(nr) * EROFS_BLKSIZ) 26147e4937aSGao Xiang 26247e4937aSGao Xiang static inline erofs_off_t iloc(struct erofs_sb_info *sbi, erofs_nid_t nid) 26347e4937aSGao Xiang { 26447e4937aSGao Xiang return blknr_to_addr(sbi->meta_blkaddr) + (nid << sbi->islotbits); 26547e4937aSGao Xiang } 26647e4937aSGao Xiang 267de06a6a3SGao Xiang #define EROFS_FEATURE_FUNCS(name, compat, feature) \ 268de06a6a3SGao Xiang static inline bool erofs_sb_has_##name(struct erofs_sb_info *sbi) \ 269de06a6a3SGao Xiang { \ 270de06a6a3SGao Xiang return sbi->feature_##compat & EROFS_FEATURE_##feature; \ 271de06a6a3SGao Xiang } 272de06a6a3SGao Xiang 2737e508f2cSHuang Jianan EROFS_FEATURE_FUNCS(zero_padding, incompat, INCOMPAT_ZERO_PADDING) 27414373711SGao Xiang EROFS_FEATURE_FUNCS(compr_cfgs, incompat, INCOMPAT_COMPR_CFGS) 2755404c330SGao Xiang EROFS_FEATURE_FUNCS(big_pcluster, incompat, INCOMPAT_BIG_PCLUSTER) 276168e9a76SHuang Jianan EROFS_FEATURE_FUNCS(chunked_file, incompat, INCOMPAT_CHUNKED_FILE) 277dfeab2e9SGao Xiang EROFS_FEATURE_FUNCS(device_table, incompat, INCOMPAT_DEVICE_TABLE) 278168e9a76SHuang Jianan EROFS_FEATURE_FUNCS(compr_head2, incompat, INCOMPAT_COMPR_HEAD2) 279ab92184fSYue Hu EROFS_FEATURE_FUNCS(ztailpacking, incompat, INCOMPAT_ZTAILPACKING) 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; 31522ba5e99SGao Xiang erofs_off_t z_idataoff; 316ab92184fSYue Hu unsigned short z_idata_size; 31747e4937aSGao Xiang }; 31847e4937aSGao Xiang #endif /* CONFIG_EROFS_FS_ZIP */ 31947e4937aSGao Xiang }; 32047e4937aSGao Xiang /* the corresponding vfs inode */ 32147e4937aSGao Xiang struct inode vfs_inode; 32247e4937aSGao Xiang }; 32347e4937aSGao Xiang 324a5876e24SGao Xiang #define EROFS_I(ptr) \ 325a5876e24SGao Xiang container_of(ptr, struct erofs_inode, vfs_inode) 32647e4937aSGao Xiang 32799634bf3SGao Xiang static inline unsigned long erofs_inode_datablocks(struct inode *inode) 32847e4937aSGao Xiang { 32947e4937aSGao Xiang /* since i_size cannot be changed */ 33047e4937aSGao Xiang return DIV_ROUND_UP(inode->i_size, EROFS_BLKSIZ); 33147e4937aSGao Xiang } 33247e4937aSGao Xiang 3338a765682SGao Xiang static inline unsigned int erofs_bitrange(unsigned int value, unsigned int bit, 3348a765682SGao Xiang unsigned int bits) 33547e4937aSGao Xiang { 3368a765682SGao Xiang 3378a765682SGao Xiang return (value >> bit) & ((1 << bits) - 1); 33847e4937aSGao Xiang } 33947e4937aSGao Xiang 3408a765682SGao Xiang 3418a765682SGao Xiang static inline unsigned int erofs_inode_version(unsigned int value) 34247e4937aSGao Xiang { 3438a765682SGao Xiang return erofs_bitrange(value, EROFS_I_VERSION_BIT, 3448a765682SGao Xiang EROFS_I_VERSION_BITS); 3458a765682SGao Xiang } 3468a765682SGao Xiang 3478a765682SGao Xiang static inline unsigned int erofs_inode_datalayout(unsigned int value) 3488a765682SGao Xiang { 3498a765682SGao Xiang return erofs_bitrange(value, EROFS_I_DATALAYOUT_BIT, 3508a765682SGao Xiang EROFS_I_DATALAYOUT_BITS); 35147e4937aSGao Xiang } 35247e4937aSGao Xiang 35338629291SGao Xiang /* 35438629291SGao Xiang * Different from grab_cache_page_nowait(), reclaiming is never triggered 35538629291SGao Xiang * when allocating new pages. 35638629291SGao Xiang */ 35738629291SGao Xiang static inline 35838629291SGao Xiang struct page *erofs_grab_cache_page_nowait(struct address_space *mapping, 35938629291SGao Xiang pgoff_t index) 36038629291SGao Xiang { 36138629291SGao Xiang return pagecache_get_page(mapping, index, 36238629291SGao Xiang FGP_LOCK|FGP_CREAT|FGP_NOFS|FGP_NOWAIT, 36338629291SGao Xiang readahead_gfp_mask(mapping) & ~__GFP_RECLAIM); 36438629291SGao Xiang } 36538629291SGao Xiang 36647e4937aSGao Xiang extern const struct super_operations erofs_sops; 36747e4937aSGao Xiang 36847e4937aSGao Xiang extern const struct address_space_operations erofs_raw_access_aops; 3690c638f70SGao Xiang extern const struct address_space_operations z_erofs_aops; 37047e4937aSGao Xiang 37147e4937aSGao Xiang enum { 3728f899262SGao Xiang BH_Encoded = BH_PrivateStart, 37347e4937aSGao Xiang BH_FullMapped, 37447e4937aSGao Xiang }; 37547e4937aSGao Xiang 37647e4937aSGao Xiang /* Has a disk mapping */ 37747e4937aSGao Xiang #define EROFS_MAP_MAPPED (1 << BH_Mapped) 37847e4937aSGao Xiang /* Located in metadata (could be copied from bd_inode) */ 37947e4937aSGao Xiang #define EROFS_MAP_META (1 << BH_Meta) 3808f899262SGao Xiang /* The extent is encoded */ 3818f899262SGao Xiang #define EROFS_MAP_ENCODED (1 << BH_Encoded) 38247e4937aSGao Xiang /* The length of extent is full */ 38347e4937aSGao Xiang #define EROFS_MAP_FULL_MAPPED (1 << BH_FullMapped) 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 3968137824eSYue Hu /* Flags used by erofs_map_blocks_flatmode() */ 39747e4937aSGao Xiang #define EROFS_GET_BLOCKS_RAW 0x0001 398d95ae5e2SGao Xiang /* 399d95ae5e2SGao Xiang * Used to get the exact decompressed length, e.g. fiemap (consider lookback 400d95ae5e2SGao Xiang * approach instead if possible since it's more metadata lightweight.) 401d95ae5e2SGao Xiang */ 402d95ae5e2SGao Xiang #define EROFS_GET_BLOCKS_FIEMAP 0x0002 403622ceaddSGao Xiang /* Used to map the whole extent if non-negligible data is requested for LZMA */ 404622ceaddSGao Xiang #define EROFS_GET_BLOCKS_READMORE 0x0004 405ab92184fSYue Hu /* Used to map tail extent for tailpacking inline pcluster */ 406ab92184fSYue Hu #define EROFS_GET_BLOCKS_FINDTAIL 0x0008 40747e4937aSGao Xiang 4088f899262SGao Xiang enum { 4098f899262SGao Xiang Z_EROFS_COMPRESSION_SHIFTED = Z_EROFS_COMPRESSION_MAX, 4108f899262SGao Xiang Z_EROFS_COMPRESSION_RUNTIME_MAX 4118f899262SGao Xiang }; 4128f899262SGao Xiang 41347e4937aSGao Xiang /* zmap.c */ 414eadcd6b5SGao Xiang extern const struct iomap_ops z_erofs_iomap_report_ops; 415eadcd6b5SGao Xiang 41647e4937aSGao Xiang #ifdef CONFIG_EROFS_FS_ZIP 41747e4937aSGao Xiang int z_erofs_fill_inode(struct inode *inode); 41847e4937aSGao Xiang int z_erofs_map_blocks_iter(struct inode *inode, 41947e4937aSGao Xiang struct erofs_map_blocks *map, 42047e4937aSGao Xiang int flags); 42147e4937aSGao Xiang #else 42247e4937aSGao Xiang static inline int z_erofs_fill_inode(struct inode *inode) { return -EOPNOTSUPP; } 42347e4937aSGao Xiang static inline int z_erofs_map_blocks_iter(struct inode *inode, 42447e4937aSGao Xiang struct erofs_map_blocks *map, 42547e4937aSGao Xiang int flags) 42647e4937aSGao Xiang { 42747e4937aSGao Xiang return -EOPNOTSUPP; 42847e4937aSGao Xiang } 42947e4937aSGao Xiang #endif /* !CONFIG_EROFS_FS_ZIP */ 43047e4937aSGao Xiang 431dfeab2e9SGao Xiang struct erofs_map_dev { 432955b478eSJeffle Xu struct erofs_fscache *m_fscache; 433dfeab2e9SGao Xiang struct block_device *m_bdev; 434dfeab2e9SGao Xiang struct dax_device *m_daxdev; 435de205114SChristoph Hellwig u64 m_dax_part_off; 436dfeab2e9SGao Xiang 437dfeab2e9SGao Xiang erofs_off_t m_pa; 438dfeab2e9SGao Xiang unsigned int m_deviceid; 439dfeab2e9SGao Xiang }; 440dfeab2e9SGao Xiang 44147e4937aSGao Xiang /* data.c */ 442a08e67a0SHuang Jianan extern const struct file_operations erofs_file_fops; 44309c54379SGao Xiang void erofs_unmap_metabuf(struct erofs_buf *buf); 444c521e3adSGao Xiang void erofs_put_metabuf(struct erofs_buf *buf); 445fe5de585SGao Xiang void *erofs_bread(struct erofs_buf *buf, struct inode *inode, 446fe5de585SGao Xiang erofs_blk_t blkaddr, enum erofs_kmap_type type); 447c521e3adSGao Xiang void *erofs_read_metabuf(struct erofs_buf *buf, struct super_block *sb, 448c521e3adSGao Xiang erofs_blk_t blkaddr, enum erofs_kmap_type type); 449dfeab2e9SGao Xiang int erofs_map_dev(struct super_block *sb, struct erofs_map_dev *dev); 450eadcd6b5SGao Xiang int erofs_fiemap(struct inode *inode, struct fiemap_extent_info *fieinfo, 451eadcd6b5SGao Xiang u64 start, u64 len); 45294d78946SJeffle Xu int erofs_map_blocks(struct inode *inode, 45394d78946SJeffle Xu struct erofs_map_blocks *map, int flags); 45447e4937aSGao Xiang 45547e4937aSGao Xiang /* inode.c */ 45647e4937aSGao Xiang static inline unsigned long erofs_inode_hash(erofs_nid_t nid) 45747e4937aSGao Xiang { 45847e4937aSGao Xiang #if BITS_PER_LONG == 32 45947e4937aSGao Xiang return (nid >> 32) ^ (nid & 0xffffffff); 46047e4937aSGao Xiang #else 46147e4937aSGao Xiang return nid; 46247e4937aSGao Xiang #endif 46347e4937aSGao Xiang } 46447e4937aSGao Xiang 46547e4937aSGao Xiang extern const struct inode_operations erofs_generic_iops; 46647e4937aSGao Xiang extern const struct inode_operations erofs_symlink_iops; 46747e4937aSGao Xiang extern const struct inode_operations erofs_fast_symlink_iops; 46847e4937aSGao Xiang 46947e4937aSGao Xiang struct inode *erofs_iget(struct super_block *sb, erofs_nid_t nid, bool dir); 470549c7297SChristian Brauner int erofs_getattr(struct user_namespace *mnt_userns, const struct path *path, 471549c7297SChristian Brauner struct kstat *stat, u32 request_mask, 472549c7297SChristian Brauner unsigned int query_flags); 47347e4937aSGao Xiang 47447e4937aSGao Xiang /* namei.c */ 47547e4937aSGao Xiang extern const struct inode_operations erofs_dir_iops; 47647e4937aSGao Xiang 4773e917cc3SHongnan Li int erofs_namei(struct inode *dir, const struct qstr *name, 47847e4937aSGao Xiang erofs_nid_t *nid, unsigned int *d_type); 47947e4937aSGao Xiang 48047e4937aSGao Xiang /* dir.c */ 48147e4937aSGao Xiang extern const struct file_operations erofs_dir_fops; 48247e4937aSGao Xiang 483598162d0SGao Xiang static inline void *erofs_vm_map_ram(struct page **pages, unsigned int count) 484598162d0SGao Xiang { 485598162d0SGao Xiang int retried = 0; 486598162d0SGao Xiang 487598162d0SGao Xiang while (1) { 488598162d0SGao Xiang void *p = vm_map_ram(pages, count, -1); 489598162d0SGao Xiang 490598162d0SGao Xiang /* retry two more times (totally 3 times) */ 491598162d0SGao Xiang if (p || ++retried >= 3) 492598162d0SGao Xiang return p; 493598162d0SGao Xiang vm_unmap_aliases(); 494598162d0SGao Xiang } 495598162d0SGao Xiang return NULL; 496598162d0SGao Xiang } 497598162d0SGao Xiang 49852488734SGao Xiang /* pcpubuf.c */ 49952488734SGao Xiang void *erofs_get_pcpubuf(unsigned int requiredpages); 50052488734SGao Xiang void erofs_put_pcpubuf(void *ptr); 50152488734SGao Xiang int erofs_pcpubuf_growsize(unsigned int nrpages); 50252488734SGao Xiang void erofs_pcpubuf_init(void); 50352488734SGao Xiang void erofs_pcpubuf_exit(void); 50452488734SGao Xiang 505168e9a76SHuang Jianan /* sysfs.c */ 506168e9a76SHuang Jianan int erofs_register_sysfs(struct super_block *sb); 507168e9a76SHuang Jianan void erofs_unregister_sysfs(struct super_block *sb); 508168e9a76SHuang Jianan int __init erofs_init_sysfs(void); 509168e9a76SHuang Jianan void erofs_exit_sysfs(void); 510168e9a76SHuang Jianan 51147e4937aSGao Xiang /* utils.c / zdata.c */ 512eaa9172aSGao Xiang struct page *erofs_allocpage(struct page **pagepool, gfp_t gfp); 513eaa9172aSGao Xiang static inline void erofs_pagepool_add(struct page **pagepool, 514eaa9172aSGao Xiang struct page *page) 515eaa9172aSGao Xiang { 516eaa9172aSGao Xiang set_page_private(page, (unsigned long)*pagepool); 517eaa9172aSGao Xiang *pagepool = page; 518eaa9172aSGao Xiang } 519eaa9172aSGao Xiang void erofs_release_pages(struct page **pagepool); 52047e4937aSGao Xiang 52147e4937aSGao Xiang #ifdef CONFIG_EROFS_FS_ZIP 52247e4937aSGao Xiang int erofs_workgroup_put(struct erofs_workgroup *grp); 52347e4937aSGao Xiang struct erofs_workgroup *erofs_find_workgroup(struct super_block *sb, 524997626d8SVladimir Zapolskiy pgoff_t index); 52564094a04SGao Xiang struct erofs_workgroup *erofs_insert_workgroup(struct super_block *sb, 526e5e9a432SVladimir Zapolskiy struct erofs_workgroup *grp); 52747e4937aSGao Xiang void erofs_workgroup_free_rcu(struct erofs_workgroup *grp); 52847e4937aSGao Xiang void erofs_shrinker_register(struct super_block *sb); 52947e4937aSGao Xiang void erofs_shrinker_unregister(struct super_block *sb); 53047e4937aSGao Xiang int __init erofs_init_shrinker(void); 53147e4937aSGao Xiang void erofs_exit_shrinker(void); 53247e4937aSGao Xiang int __init z_erofs_init_zip_subsystem(void); 53347e4937aSGao Xiang void z_erofs_exit_zip_subsystem(void); 53447e4937aSGao Xiang int erofs_try_to_free_all_cached_pages(struct erofs_sb_info *sbi, 53547e4937aSGao Xiang struct erofs_workgroup *egrp); 536d252ff3dSYue Hu int erofs_try_to_free_cached_page(struct page *page); 5375d50538fSHuang Jianan int z_erofs_load_lz4_config(struct super_block *sb, 53846249cdeSGao Xiang struct erofs_super_block *dsb, 53946249cdeSGao Xiang struct z_erofs_lz4_cfgs *lz4, int len); 54047e4937aSGao Xiang #else 54147e4937aSGao Xiang static inline void erofs_shrinker_register(struct super_block *sb) {} 54247e4937aSGao Xiang static inline void erofs_shrinker_unregister(struct super_block *sb) {} 54347e4937aSGao Xiang static inline int erofs_init_shrinker(void) { return 0; } 54447e4937aSGao Xiang static inline void erofs_exit_shrinker(void) {} 54547e4937aSGao Xiang static inline int z_erofs_init_zip_subsystem(void) { return 0; } 54647e4937aSGao Xiang static inline void z_erofs_exit_zip_subsystem(void) {} 5475d50538fSHuang Jianan static inline int z_erofs_load_lz4_config(struct super_block *sb, 54846249cdeSGao Xiang struct erofs_super_block *dsb, 54946249cdeSGao Xiang struct z_erofs_lz4_cfgs *lz4, int len) 5505d50538fSHuang Jianan { 55114373711SGao Xiang if (lz4 || dsb->u1.lz4_max_distance) { 5525d50538fSHuang Jianan erofs_err(sb, "lz4 algorithm isn't enabled"); 5535d50538fSHuang Jianan return -EINVAL; 5545d50538fSHuang Jianan } 5555d50538fSHuang Jianan return 0; 5565d50538fSHuang Jianan } 55747e4937aSGao Xiang #endif /* !CONFIG_EROFS_FS_ZIP */ 55847e4937aSGao Xiang 559622ceaddSGao Xiang #ifdef CONFIG_EROFS_FS_ZIP_LZMA 560622ceaddSGao Xiang int z_erofs_lzma_init(void); 561622ceaddSGao Xiang void z_erofs_lzma_exit(void); 562622ceaddSGao Xiang int z_erofs_load_lzma_config(struct super_block *sb, 563622ceaddSGao Xiang struct erofs_super_block *dsb, 564622ceaddSGao Xiang struct z_erofs_lzma_cfgs *lzma, int size); 565622ceaddSGao Xiang #else 566622ceaddSGao Xiang static inline int z_erofs_lzma_init(void) { return 0; } 567622ceaddSGao Xiang static inline int z_erofs_lzma_exit(void) { return 0; } 568622ceaddSGao Xiang static inline int z_erofs_load_lzma_config(struct super_block *sb, 569622ceaddSGao Xiang struct erofs_super_block *dsb, 570622ceaddSGao Xiang struct z_erofs_lzma_cfgs *lzma, int size) { 571622ceaddSGao Xiang if (lzma) { 572622ceaddSGao Xiang erofs_err(sb, "lzma algorithm isn't enabled"); 573622ceaddSGao Xiang return -EINVAL; 574622ceaddSGao Xiang } 575622ceaddSGao Xiang return 0; 576622ceaddSGao Xiang } 577622ceaddSGao Xiang #endif /* !CONFIG_EROFS_FS_ZIP */ 578622ceaddSGao Xiang 579c6be2bd0SJeffle Xu /* fscache.c */ 580c6be2bd0SJeffle Xu #ifdef CONFIG_EROFS_FS_ONDEMAND 581c6be2bd0SJeffle Xu int erofs_fscache_register_fs(struct super_block *sb); 582c6be2bd0SJeffle Xu void erofs_fscache_unregister_fs(struct super_block *sb); 583b02c602fSJeffle Xu 584*e1de2da0SJia Zhu struct erofs_fscache *erofs_fscache_register_cookie(struct super_block *sb, 5853c265d7dSJeffle Xu char *name, bool need_inode); 586*e1de2da0SJia Zhu void erofs_fscache_unregister_cookie(struct erofs_fscache *fscache); 5871442b02bSJeffle Xu 5881442b02bSJeffle Xu extern const struct address_space_operations erofs_fscache_access_aops; 589c6be2bd0SJeffle Xu #else 590c6be2bd0SJeffle Xu static inline int erofs_fscache_register_fs(struct super_block *sb) 591c6be2bd0SJeffle Xu { 592*e1de2da0SJia Zhu return -EOPNOTSUPP; 593c6be2bd0SJeffle Xu } 594c6be2bd0SJeffle Xu static inline void erofs_fscache_unregister_fs(struct super_block *sb) {} 595b02c602fSJeffle Xu 596*e1de2da0SJia Zhu static inline 597*e1de2da0SJia Zhu struct erofs_fscache *erofs_fscache_register_cookie(struct super_block *sb, 5983c265d7dSJeffle Xu char *name, bool need_inode) 599b02c602fSJeffle Xu { 600*e1de2da0SJia Zhu return ERR_PTR(-EOPNOTSUPP); 601b02c602fSJeffle Xu } 602b02c602fSJeffle Xu 603*e1de2da0SJia Zhu static inline void erofs_fscache_unregister_cookie(struct erofs_fscache *fscache) 604b02c602fSJeffle Xu { 605b02c602fSJeffle Xu } 606c6be2bd0SJeffle Xu #endif 607c6be2bd0SJeffle Xu 60847e4937aSGao Xiang #define EFSCORRUPTED EUCLEAN /* Filesystem is corrupted */ 60947e4937aSGao Xiang 61047e4937aSGao Xiang #endif /* __EROFS_INTERNAL_H */ 611