1 /* SPDX-License-Identifier: GPL-2.0-only */
3 * Copyright (C) 2017-2018 HUAWEI, Inc.
4 * https://www.huawei.com/
5 * Copyright (C) 2021, Alibaba Cloud
7 #ifndef __EROFS_INTERNAL_H
8 #define __EROFS_INTERNAL_H
11 #include <linux/dcache.h>
13 #include <linux/pagemap.h>
14 #include <linux/bio.h>
15 #include <linux/buffer_head.h>
16 #include <linux/magic.h>
17 #include <linux/slab.h>
18 #include <linux/vmalloc.h>
19 #include <linux/iomap.h>
22 /* redefine pr_fmt "erofs: " */
24 #define pr_fmt(fmt) "erofs: " fmt
26 __printf(3, 4) void _erofs_err(struct super_block *sb,
27 const char *function, const char *fmt, ...);
28 #define erofs_err(sb, fmt, ...) \
29 _erofs_err(sb, __func__, fmt "\n", ##__VA_ARGS__)
30 __printf(3, 4) void _erofs_info(struct super_block *sb,
31 const char *function, const char *fmt, ...);
32 #define erofs_info(sb, fmt, ...) \
33 _erofs_info(sb, __func__, fmt "\n", ##__VA_ARGS__)
34 #ifdef CONFIG_EROFS_FS_DEBUG
35 #define erofs_dbg(x, ...) pr_debug(x "\n", ##__VA_ARGS__)
36 #define DBG_BUGON BUG_ON
38 #define erofs_dbg(x, ...) ((void)0)
39 #define DBG_BUGON(x) ((void)(x))
40 #endif /* !CONFIG_EROFS_FS_DEBUG */
42 /* EROFS_SUPER_MAGIC_V1 to represent the whole file system */
43 #define EROFS_SUPER_MAGIC EROFS_SUPER_MAGIC_V1
45 typedef u64 erofs_nid_t;
46 typedef u64 erofs_off_t;
47 /* data type for filesystem-wide blocks number */
48 typedef u32 erofs_blk_t;
50 struct erofs_device_info {
52 struct block_device *bdev;
53 struct dax_device *dax_dev;
61 EROFS_SYNC_DECOMPRESS_AUTO,
62 EROFS_SYNC_DECOMPRESS_FORCE_ON,
63 EROFS_SYNC_DECOMPRESS_FORCE_OFF
66 struct erofs_mount_opts {
67 #ifdef CONFIG_EROFS_FS_ZIP
68 /* current strategy of how to use managed cache */
69 unsigned char cache_strategy;
70 /* strategy of sync decompression (0 - auto, 1 - force on, 2 - force off) */
71 unsigned int sync_decompress;
73 /* threshold for decompression synchronously */
74 unsigned int max_sync_decompress_pages;
76 unsigned int mount_opt;
79 struct erofs_dev_context {
81 struct rw_semaphore rwsem;
83 unsigned int extra_devices;
86 struct erofs_fs_context {
87 struct erofs_mount_opts opt;
88 struct erofs_dev_context *devs;
91 /* all filesystem-wide lz4 configurations */
92 struct erofs_sb_lz4_info {
93 /* # of pages needed for EROFS lz4 rolling decompression */
94 u16 max_distance_pages;
95 /* maximum possible blocks for pclusters in the filesystem */
99 struct erofs_sb_info {
100 struct erofs_mount_opts opt; /* options */
101 #ifdef CONFIG_EROFS_FS_ZIP
102 /* list for all registered superblocks, mainly for shrinker */
103 struct list_head list;
104 struct mutex umount_mutex;
106 /* managed XArray arranged in physical block number */
107 struct xarray managed_pslots;
109 unsigned int shrinker_run_no;
110 u16 available_compr_algs;
112 /* pseudo inode to manage cached pages */
113 struct inode *managed_cache;
115 struct erofs_sb_lz4_info lz4;
116 #endif /* CONFIG_EROFS_FS_ZIP */
117 struct erofs_dev_context *devs;
118 struct dax_device *dax_dev;
121 u32 primarydevice_blocks;
124 #ifdef CONFIG_EROFS_FS_XATTR
127 u16 device_id_mask; /* valid bits of device id to be used */
129 /* inode slot unit size in bit shift */
130 unsigned char islotbits;
132 u32 sb_size; /* total superblock size */
136 /* what we really care is nid, rather than ino.. */
137 erofs_nid_t root_nid;
138 /* used for statfs, f_files - f_favail */
141 u8 uuid[16]; /* 128-bit uuid for volume */
142 u8 volume_name[16]; /* volume name */
144 u32 feature_incompat;
147 struct kobject s_kobj; /* /sys/fs/erofs/<devname> */
148 struct completion s_kobj_unregister;
151 #define EROFS_SB(sb) ((struct erofs_sb_info *)(sb)->s_fs_info)
152 #define EROFS_I_SB(inode) ((struct erofs_sb_info *)(inode)->i_sb->s_fs_info)
154 /* Mount flags set via mount options or defaults */
155 #define EROFS_MOUNT_XATTR_USER 0x00000010
156 #define EROFS_MOUNT_POSIX_ACL 0x00000020
157 #define EROFS_MOUNT_DAX_ALWAYS 0x00000040
158 #define EROFS_MOUNT_DAX_NEVER 0x00000080
160 #define clear_opt(opt, option) ((opt)->mount_opt &= ~EROFS_MOUNT_##option)
161 #define set_opt(opt, option) ((opt)->mount_opt |= EROFS_MOUNT_##option)
162 #define test_opt(opt, option) ((opt)->mount_opt & EROFS_MOUNT_##option)
165 EROFS_ZIP_CACHE_DISABLED,
166 EROFS_ZIP_CACHE_READAHEAD,
167 EROFS_ZIP_CACHE_READAROUND
170 #ifdef CONFIG_EROFS_FS_ZIP
171 #define EROFS_LOCKED_MAGIC (INT_MIN | 0xE0F510CCL)
173 /* basic unit of the workstation of a super_block */
174 struct erofs_workgroup {
175 /* the workgroup index in the workstation */
178 /* overall workgroup reference count */
182 #if defined(CONFIG_SMP)
183 static inline bool erofs_workgroup_try_to_freeze(struct erofs_workgroup *grp,
187 if (val != atomic_cmpxchg(&grp->refcount, val, EROFS_LOCKED_MAGIC)) {
194 static inline void erofs_workgroup_unfreeze(struct erofs_workgroup *grp,
198 * other observers should notice all modifications
199 * in the freezing period.
202 atomic_set(&grp->refcount, orig_val);
206 static inline int erofs_wait_on_workgroup_freezed(struct erofs_workgroup *grp)
208 return atomic_cond_read_relaxed(&grp->refcount,
209 VAL != EROFS_LOCKED_MAGIC);
212 static inline bool erofs_workgroup_try_to_freeze(struct erofs_workgroup *grp,
216 /* no need to spin on UP platforms, let's just disable preemption. */
217 if (val != atomic_read(&grp->refcount)) {
224 static inline void erofs_workgroup_unfreeze(struct erofs_workgroup *grp,
230 static inline int erofs_wait_on_workgroup_freezed(struct erofs_workgroup *grp)
232 int v = atomic_read(&grp->refcount);
234 /* workgroup is never freezed on uniprocessor systems */
235 DBG_BUGON(v == EROFS_LOCKED_MAGIC);
238 #endif /* !CONFIG_SMP */
239 #endif /* !CONFIG_EROFS_FS_ZIP */
241 /* we strictly follow PAGE_SIZE and no buffer head yet */
242 #define LOG_BLOCK_SIZE PAGE_SHIFT
244 #undef LOG_SECTORS_PER_BLOCK
245 #define LOG_SECTORS_PER_BLOCK (PAGE_SHIFT - 9)
247 #undef SECTORS_PER_BLOCK
248 #define SECTORS_PER_BLOCK (1 << SECTORS_PER_BLOCK)
250 #define EROFS_BLKSIZ (1 << LOG_BLOCK_SIZE)
252 #if (EROFS_BLKSIZ % 4096 || !EROFS_BLKSIZ)
253 #error erofs cannot be used in this platform
256 enum erofs_kmap_type {
257 EROFS_NO_KMAP, /* don't map the buffer */
258 EROFS_KMAP, /* use kmap() to map the buffer */
259 EROFS_KMAP_ATOMIC, /* use kmap_atomic() to map the buffer */
265 enum erofs_kmap_type kmap_type;
267 #define __EROFS_BUF_INITIALIZER ((struct erofs_buf){ .page = NULL })
269 #define ROOT_NID(sb) ((sb)->root_nid)
271 #define erofs_blknr(addr) ((addr) / EROFS_BLKSIZ)
272 #define erofs_blkoff(addr) ((addr) % EROFS_BLKSIZ)
273 #define blknr_to_addr(nr) ((erofs_off_t)(nr) * EROFS_BLKSIZ)
275 static inline erofs_off_t iloc(struct erofs_sb_info *sbi, erofs_nid_t nid)
277 return blknr_to_addr(sbi->meta_blkaddr) + (nid << sbi->islotbits);
280 #define EROFS_FEATURE_FUNCS(name, compat, feature) \
281 static inline bool erofs_sb_has_##name(struct erofs_sb_info *sbi) \
283 return sbi->feature_##compat & EROFS_FEATURE_##feature; \
286 EROFS_FEATURE_FUNCS(zero_padding, incompat, INCOMPAT_ZERO_PADDING)
287 EROFS_FEATURE_FUNCS(compr_cfgs, incompat, INCOMPAT_COMPR_CFGS)
288 EROFS_FEATURE_FUNCS(big_pcluster, incompat, INCOMPAT_BIG_PCLUSTER)
289 EROFS_FEATURE_FUNCS(chunked_file, incompat, INCOMPAT_CHUNKED_FILE)
290 EROFS_FEATURE_FUNCS(device_table, incompat, INCOMPAT_DEVICE_TABLE)
291 EROFS_FEATURE_FUNCS(compr_head2, incompat, INCOMPAT_COMPR_HEAD2)
292 EROFS_FEATURE_FUNCS(ztailpacking, incompat, INCOMPAT_ZTAILPACKING)
293 EROFS_FEATURE_FUNCS(sb_chksum, compat, COMPAT_SB_CHKSUM)
295 /* atomic flag definitions */
296 #define EROFS_I_EA_INITED_BIT 0
297 #define EROFS_I_Z_INITED_BIT 1
299 /* bitlock definitions (arranged in reverse order) */
300 #define EROFS_I_BL_XATTR_BIT (BITS_PER_LONG - 1)
301 #define EROFS_I_BL_Z_BIT (BITS_PER_LONG - 2)
306 /* atomic flags (including bitlocks) */
309 unsigned char datalayout;
310 unsigned char inode_isize;
311 unsigned short xattr_isize;
313 unsigned int xattr_shared_count;
314 unsigned int *xattr_shared_xattrs;
317 erofs_blk_t raw_blkaddr;
319 unsigned short chunkformat;
320 unsigned char chunkbits;
322 #ifdef CONFIG_EROFS_FS_ZIP
324 unsigned short z_advise;
325 unsigned char z_algorithmtype[2];
326 unsigned char z_logical_clusterbits;
327 unsigned long z_tailextent_headlcn;
328 erofs_off_t z_idataoff;
329 unsigned short z_idata_size;
331 #endif /* CONFIG_EROFS_FS_ZIP */
333 /* the corresponding vfs inode */
334 struct inode vfs_inode;
337 #define EROFS_I(ptr) \
338 container_of(ptr, struct erofs_inode, vfs_inode)
340 static inline unsigned long erofs_inode_datablocks(struct inode *inode)
342 /* since i_size cannot be changed */
343 return DIV_ROUND_UP(inode->i_size, EROFS_BLKSIZ);
346 static inline unsigned int erofs_bitrange(unsigned int value, unsigned int bit,
350 return (value >> bit) & ((1 << bits) - 1);
354 static inline unsigned int erofs_inode_version(unsigned int value)
356 return erofs_bitrange(value, EROFS_I_VERSION_BIT,
357 EROFS_I_VERSION_BITS);
360 static inline unsigned int erofs_inode_datalayout(unsigned int value)
362 return erofs_bitrange(value, EROFS_I_DATALAYOUT_BIT,
363 EROFS_I_DATALAYOUT_BITS);
367 * Different from grab_cache_page_nowait(), reclaiming is never triggered
368 * when allocating new pages.
371 struct page *erofs_grab_cache_page_nowait(struct address_space *mapping,
374 return pagecache_get_page(mapping, index,
375 FGP_LOCK|FGP_CREAT|FGP_NOFS|FGP_NOWAIT,
376 readahead_gfp_mask(mapping) & ~__GFP_RECLAIM);
379 extern const struct super_operations erofs_sops;
381 extern const struct address_space_operations erofs_raw_access_aops;
382 extern const struct address_space_operations z_erofs_aops;
385 BH_Encoded = BH_PrivateStart,
389 /* Has a disk mapping */
390 #define EROFS_MAP_MAPPED (1 << BH_Mapped)
391 /* Located in metadata (could be copied from bd_inode) */
392 #define EROFS_MAP_META (1 << BH_Meta)
393 /* The extent is encoded */
394 #define EROFS_MAP_ENCODED (1 << BH_Encoded)
395 /* The length of extent is full */
396 #define EROFS_MAP_FULL_MAPPED (1 << BH_FullMapped)
398 struct erofs_map_blocks {
399 struct erofs_buf buf;
401 erofs_off_t m_pa, m_la;
404 unsigned short m_deviceid;
405 char m_algorithmformat;
406 unsigned int m_flags;
409 /* Flags used by erofs_map_blocks_flatmode() */
410 #define EROFS_GET_BLOCKS_RAW 0x0001
412 * Used to get the exact decompressed length, e.g. fiemap (consider lookback
413 * approach instead if possible since it's more metadata lightweight.)
415 #define EROFS_GET_BLOCKS_FIEMAP 0x0002
416 /* Used to map the whole extent if non-negligible data is requested for LZMA */
417 #define EROFS_GET_BLOCKS_READMORE 0x0004
418 /* Used to map tail extent for tailpacking inline pcluster */
419 #define EROFS_GET_BLOCKS_FINDTAIL 0x0008
422 Z_EROFS_COMPRESSION_SHIFTED = Z_EROFS_COMPRESSION_MAX,
423 Z_EROFS_COMPRESSION_RUNTIME_MAX
427 extern const struct iomap_ops z_erofs_iomap_report_ops;
429 #ifdef CONFIG_EROFS_FS_ZIP
430 int z_erofs_fill_inode(struct inode *inode);
431 int z_erofs_map_blocks_iter(struct inode *inode,
432 struct erofs_map_blocks *map,
435 static inline int z_erofs_fill_inode(struct inode *inode) { return -EOPNOTSUPP; }
436 static inline int z_erofs_map_blocks_iter(struct inode *inode,
437 struct erofs_map_blocks *map,
442 #endif /* !CONFIG_EROFS_FS_ZIP */
444 struct erofs_map_dev {
445 struct block_device *m_bdev;
446 struct dax_device *m_daxdev;
450 unsigned int m_deviceid;
454 extern const struct file_operations erofs_file_fops;
455 void erofs_unmap_metabuf(struct erofs_buf *buf);
456 void erofs_put_metabuf(struct erofs_buf *buf);
457 void *erofs_bread(struct erofs_buf *buf, struct inode *inode,
458 erofs_blk_t blkaddr, enum erofs_kmap_type type);
459 void *erofs_read_metabuf(struct erofs_buf *buf, struct super_block *sb,
460 erofs_blk_t blkaddr, enum erofs_kmap_type type);
461 int erofs_map_dev(struct super_block *sb, struct erofs_map_dev *dev);
462 int erofs_fiemap(struct inode *inode, struct fiemap_extent_info *fieinfo,
466 static inline unsigned long erofs_inode_hash(erofs_nid_t nid)
468 #if BITS_PER_LONG == 32
469 return (nid >> 32) ^ (nid & 0xffffffff);
475 extern const struct inode_operations erofs_generic_iops;
476 extern const struct inode_operations erofs_symlink_iops;
477 extern const struct inode_operations erofs_fast_symlink_iops;
479 struct inode *erofs_iget(struct super_block *sb, erofs_nid_t nid, bool dir);
480 int erofs_getattr(struct user_namespace *mnt_userns, const struct path *path,
481 struct kstat *stat, u32 request_mask,
482 unsigned int query_flags);
485 extern const struct inode_operations erofs_dir_iops;
487 int erofs_namei(struct inode *dir, const struct qstr *name,
488 erofs_nid_t *nid, unsigned int *d_type);
491 extern const struct file_operations erofs_dir_fops;
493 static inline void *erofs_vm_map_ram(struct page **pages, unsigned int count)
498 void *p = vm_map_ram(pages, count, -1);
500 /* retry two more times (totally 3 times) */
501 if (p || ++retried >= 3)
509 void *erofs_get_pcpubuf(unsigned int requiredpages);
510 void erofs_put_pcpubuf(void *ptr);
511 int erofs_pcpubuf_growsize(unsigned int nrpages);
512 void erofs_pcpubuf_init(void);
513 void erofs_pcpubuf_exit(void);
516 int erofs_register_sysfs(struct super_block *sb);
517 void erofs_unregister_sysfs(struct super_block *sb);
518 int __init erofs_init_sysfs(void);
519 void erofs_exit_sysfs(void);
521 /* utils.c / zdata.c */
522 struct page *erofs_allocpage(struct page **pagepool, gfp_t gfp);
523 static inline void erofs_pagepool_add(struct page **pagepool,
526 set_page_private(page, (unsigned long)*pagepool);
529 void erofs_release_pages(struct page **pagepool);
531 #ifdef CONFIG_EROFS_FS_ZIP
532 int erofs_workgroup_put(struct erofs_workgroup *grp);
533 struct erofs_workgroup *erofs_find_workgroup(struct super_block *sb,
535 struct erofs_workgroup *erofs_insert_workgroup(struct super_block *sb,
536 struct erofs_workgroup *grp);
537 void erofs_workgroup_free_rcu(struct erofs_workgroup *grp);
538 void erofs_shrinker_register(struct super_block *sb);
539 void erofs_shrinker_unregister(struct super_block *sb);
540 int __init erofs_init_shrinker(void);
541 void erofs_exit_shrinker(void);
542 int __init z_erofs_init_zip_subsystem(void);
543 void z_erofs_exit_zip_subsystem(void);
544 int erofs_try_to_free_all_cached_pages(struct erofs_sb_info *sbi,
545 struct erofs_workgroup *egrp);
546 int erofs_try_to_free_cached_page(struct page *page);
547 int z_erofs_load_lz4_config(struct super_block *sb,
548 struct erofs_super_block *dsb,
549 struct z_erofs_lz4_cfgs *lz4, int len);
551 static inline void erofs_shrinker_register(struct super_block *sb) {}
552 static inline void erofs_shrinker_unregister(struct super_block *sb) {}
553 static inline int erofs_init_shrinker(void) { return 0; }
554 static inline void erofs_exit_shrinker(void) {}
555 static inline int z_erofs_init_zip_subsystem(void) { return 0; }
556 static inline void z_erofs_exit_zip_subsystem(void) {}
557 static inline int z_erofs_load_lz4_config(struct super_block *sb,
558 struct erofs_super_block *dsb,
559 struct z_erofs_lz4_cfgs *lz4, int len)
561 if (lz4 || dsb->u1.lz4_max_distance) {
562 erofs_err(sb, "lz4 algorithm isn't enabled");
567 #endif /* !CONFIG_EROFS_FS_ZIP */
569 #ifdef CONFIG_EROFS_FS_ZIP_LZMA
570 int z_erofs_lzma_init(void);
571 void z_erofs_lzma_exit(void);
572 int z_erofs_load_lzma_config(struct super_block *sb,
573 struct erofs_super_block *dsb,
574 struct z_erofs_lzma_cfgs *lzma, int size);
576 static inline int z_erofs_lzma_init(void) { return 0; }
577 static inline int z_erofs_lzma_exit(void) { return 0; }
578 static inline int z_erofs_load_lzma_config(struct super_block *sb,
579 struct erofs_super_block *dsb,
580 struct z_erofs_lzma_cfgs *lzma, int size) {
582 erofs_err(sb, "lzma algorithm isn't enabled");
587 #endif /* !CONFIG_EROFS_FS_ZIP */
589 #define EFSCORRUPTED EUCLEAN /* Filesystem is corrupted */
591 #endif /* __EROFS_INTERNAL_H */