1 /* SPDX-License-Identifier: GPL-2.0-only */ 2 /* 3 * Copyright (C) 2017-2018 HUAWEI, Inc. 4 * https://www.huawei.com/ 5 * Copyright (C) 2021, Alibaba Cloud 6 */ 7 #ifndef __EROFS_INTERNAL_H 8 #define __EROFS_INTERNAL_H 9 10 #include <linux/fs.h> 11 #include <linux/dax.h> 12 #include <linux/dcache.h> 13 #include <linux/mm.h> 14 #include <linux/module.h> 15 #include <linux/pagemap.h> 16 #include <linux/bio.h> 17 #include <linux/magic.h> 18 #include <linux/slab.h> 19 #include <linux/vmalloc.h> 20 #include <linux/iomap.h> 21 #include "erofs_fs.h" 22 23 __printf(2, 3) void _erofs_printk(struct super_block *sb, const char *fmt, ...); 24 #define erofs_err(sb, fmt, ...) \ 25 _erofs_printk(sb, KERN_ERR fmt "\n", ##__VA_ARGS__) 26 #define erofs_warn(sb, fmt, ...) \ 27 _erofs_printk(sb, KERN_WARNING fmt "\n", ##__VA_ARGS__) 28 #define erofs_info(sb, fmt, ...) \ 29 _erofs_printk(sb, KERN_INFO fmt "\n", ##__VA_ARGS__) 30 31 #ifdef CONFIG_EROFS_FS_DEBUG 32 #define DBG_BUGON BUG_ON 33 #else 34 #define DBG_BUGON(x) ((void)(x)) 35 #endif /* !CONFIG_EROFS_FS_DEBUG */ 36 37 /* EROFS_SUPER_MAGIC_V1 to represent the whole file system */ 38 #define EROFS_SUPER_MAGIC EROFS_SUPER_MAGIC_V1 39 40 typedef u64 erofs_nid_t; 41 typedef u64 erofs_off_t; 42 typedef u64 erofs_blk_t; 43 44 struct erofs_device_info { 45 char *path; 46 struct file *file; 47 struct dax_device *dax_dev; 48 u64 fsoff, dax_part_off; 49 50 erofs_blk_t blocks; 51 erofs_blk_t uniaddr; 52 }; 53 54 enum { 55 EROFS_SYNC_DECOMPRESS_AUTO, 56 EROFS_SYNC_DECOMPRESS_FORCE_ON, 57 EROFS_SYNC_DECOMPRESS_FORCE_OFF 58 }; 59 60 struct erofs_mount_opts { 61 /* current strategy of how to use managed cache */ 62 unsigned char cache_strategy; 63 unsigned int mount_opt; 64 }; 65 66 struct erofs_dev_context { 67 struct idr tree; 68 struct rw_semaphore rwsem; 69 70 unsigned int extra_devices; 71 bool flatdev; 72 }; 73 74 struct erofs_sb_lz4_info { 75 u16 max_pclusterblks; /* maximum physical blocks for LZ4 pclusters */ 76 }; 77 78 struct erofs_xattr_prefix_item { 79 struct erofs_xattr_long_prefix *prefix; 80 u8 infix_len; 81 }; 82 83 struct erofs_sb_info { 84 struct erofs_device_info dif0; 85 struct erofs_mount_opts opt; /* options */ 86 #ifdef CONFIG_EROFS_FS_ZIP 87 /* list for all registered superblocks, mainly for shrinker */ 88 struct list_head list; 89 struct mutex umount_mutex; 90 91 /* managed XArray arranged in physical block number */ 92 struct xarray managed_pslots; 93 94 unsigned int sync_decompress; /* strategy for sync decompression */ 95 unsigned int shrinker_run_no; 96 97 struct erofs_sb_lz4_info lz4; 98 #endif /* CONFIG_EROFS_FS_ZIP */ 99 struct inode *managed_cache; /* pseudo inode to cache physical data */ 100 struct inode *packed_inode; 101 struct inode *metabox_inode; 102 struct erofs_dev_context *devs; 103 u64 total_blocks; 104 105 u32 meta_blkaddr; 106 #ifdef CONFIG_EROFS_FS_XATTR 107 u32 xattr_blkaddr; 108 u32 xattr_prefix_start; 109 u8 xattr_prefix_count; 110 u8 ishare_xattr_prefix_id; 111 struct erofs_xattr_prefix_item *xattr_prefixes; 112 unsigned int xattr_filter_reserved; 113 #endif 114 u16 device_id_mask; /* valid bits of device id to be used */ 115 116 unsigned char islotbits; /* inode slot unit size in bit shift */ 117 unsigned char blkszbits; /* filesystem block size in bit shift */ 118 119 u32 sb_size; /* total superblock size */ 120 u32 fixed_nsec; 121 s64 epoch; 122 123 /* what we really care is nid, rather than ino.. */ 124 erofs_nid_t root_nid; 125 erofs_nid_t packed_nid; 126 erofs_nid_t metabox_nid; 127 /* used for statfs, f_files - f_favail */ 128 u64 inos; 129 130 char *volume_name; 131 u32 feature_compat; 132 u32 feature_incompat; 133 u16 available_compr_algs; 134 135 /* sysfs support */ 136 struct kobject s_kobj; /* /sys/fs/erofs/<devname> */ 137 struct completion s_kobj_unregister; 138 erofs_off_t dir_ra_bytes; 139 140 char *domain_id; 141 }; 142 143 #define EROFS_SB(sb) ((struct erofs_sb_info *)(sb)->s_fs_info) 144 #define EROFS_I_SB(inode) ((struct erofs_sb_info *)(inode)->i_sb->s_fs_info) 145 146 /* Mount flags set via mount options or defaults */ 147 #define EROFS_MOUNT_XATTR_USER 0x00000010 148 #define EROFS_MOUNT_POSIX_ACL 0x00000020 149 #define EROFS_MOUNT_DAX_ALWAYS 0x00000040 150 #define EROFS_MOUNT_DAX_NEVER 0x00000080 151 #define EROFS_MOUNT_DIRECT_IO 0x00000100 152 #define EROFS_MOUNT_INODE_SHARE 0x00000200 153 #define EROFS_MOUNT_SUPERBLOCK_SHARE 0x00000400 154 155 #define clear_opt(opt, option) ((opt)->mount_opt &= ~EROFS_MOUNT_##option) 156 #define set_opt(opt, option) ((opt)->mount_opt |= EROFS_MOUNT_##option) 157 #define test_opt(opt, option) ((opt)->mount_opt & EROFS_MOUNT_##option) 158 159 static inline bool erofs_is_fileio_mode(struct erofs_sb_info *sbi) 160 { 161 return IS_ENABLED(CONFIG_EROFS_FS_BACKED_BY_FILE) && sbi->dif0.file; 162 } 163 164 extern struct file_system_type erofs_anon_fs_type; 165 166 enum { 167 EROFS_ZIP_CACHE_DISABLED, 168 EROFS_ZIP_CACHE_READAHEAD, 169 EROFS_ZIP_CACHE_READAROUND 170 }; 171 172 struct erofs_buf { 173 struct address_space *mapping; 174 u64 off; 175 struct page *page; 176 void *base; 177 bool mc; 178 }; 179 #define __EROFS_BUF_INITIALIZER ((struct erofs_buf){ .page = NULL }) 180 181 #define erofs_blknr(sb, pos) ((erofs_blk_t)((pos) >> (sb)->s_blocksize_bits)) 182 #define erofs_blkoff(sb, pos) ((pos) & ((sb)->s_blocksize - 1)) 183 #define erofs_pos(sb, blk) ((erofs_off_t)(blk) << (sb)->s_blocksize_bits) 184 #define erofs_iblks(i) (round_up((i)->i_size, i_blocksize(i)) >> (i)->i_blkbits) 185 186 #define EROFS_FEATURE_FUNCS(name, compat, feature) \ 187 static inline bool erofs_sb_has_##name(struct erofs_sb_info *sbi) \ 188 { \ 189 return sbi->feature_##compat & EROFS_FEATURE_##feature; \ 190 } 191 192 EROFS_FEATURE_FUNCS(lz4_0padding, incompat, INCOMPAT_LZ4_0PADDING) 193 EROFS_FEATURE_FUNCS(compr_cfgs, incompat, INCOMPAT_COMPR_CFGS) 194 EROFS_FEATURE_FUNCS(big_pcluster, incompat, INCOMPAT_BIG_PCLUSTER) 195 EROFS_FEATURE_FUNCS(chunked_file, incompat, INCOMPAT_CHUNKED_FILE) 196 EROFS_FEATURE_FUNCS(device_table, incompat, INCOMPAT_DEVICE_TABLE) 197 EROFS_FEATURE_FUNCS(compr_head2, incompat, INCOMPAT_COMPR_HEAD2) 198 EROFS_FEATURE_FUNCS(ztailpacking, incompat, INCOMPAT_ZTAILPACKING) 199 EROFS_FEATURE_FUNCS(fragments, incompat, INCOMPAT_FRAGMENTS) 200 EROFS_FEATURE_FUNCS(dedupe, incompat, INCOMPAT_DEDUPE) 201 EROFS_FEATURE_FUNCS(xattr_prefixes, incompat, INCOMPAT_XATTR_PREFIXES) 202 EROFS_FEATURE_FUNCS(48bit, incompat, INCOMPAT_48BIT) 203 EROFS_FEATURE_FUNCS(metabox, incompat, INCOMPAT_METABOX) 204 EROFS_FEATURE_FUNCS(sb_chksum, compat, COMPAT_SB_CHKSUM) 205 EROFS_FEATURE_FUNCS(xattr_filter, compat, COMPAT_XATTR_FILTER) 206 EROFS_FEATURE_FUNCS(shared_ea_in_metabox, compat, COMPAT_SHARED_EA_IN_METABOX) 207 EROFS_FEATURE_FUNCS(plain_xattr_pfx, compat, COMPAT_PLAIN_XATTR_PFX) 208 EROFS_FEATURE_FUNCS(ishare_xattrs, compat, COMPAT_ISHARE_XATTRS) 209 210 static inline u64 erofs_nid_to_ino64(struct erofs_sb_info *sbi, erofs_nid_t nid) 211 { 212 if (!erofs_sb_has_metabox(sbi)) 213 return nid; 214 215 /* 216 * When metadata compression is enabled, avoid generating excessively 217 * large inode numbers for metadata-compressed inodes. Shift NIDs in 218 * the 31-62 bit range left by one and move the metabox flag to bit 31. 219 * 220 * Note: on-disk NIDs remain unchanged as they are primarily used for 221 * compatibility with non-LFS 32-bit applications. 222 */ 223 return ((nid << 1) & GENMASK_ULL(63, 32)) | (nid & GENMASK(30, 0)) | 224 ((nid >> EROFS_DIRENT_NID_METABOX_BIT) << 31); 225 } 226 227 /* atomic flag definitions */ 228 #define EROFS_I_EA_INITED_BIT 0 229 #define EROFS_I_Z_INITED_BIT 1 230 231 /* bitlock definitions (arranged in reverse order) */ 232 #define EROFS_I_BL_XATTR_BIT (BITS_PER_LONG - 1) 233 #define EROFS_I_BL_Z_BIT (BITS_PER_LONG - 2) 234 235 /* default readahead size of directories */ 236 #define EROFS_DIR_RA_BYTES 16384 237 238 struct erofs_inode_fingerprint { 239 u8 *opaque; 240 int size; 241 }; 242 243 struct erofs_inode { 244 erofs_nid_t nid; 245 246 /* atomic flags (including bitlocks) */ 247 unsigned long flags; 248 249 unsigned char datalayout; 250 unsigned char inode_isize; 251 bool dot_omitted; 252 unsigned int xattr_isize; 253 254 unsigned int xattr_name_filter; 255 unsigned int xattr_shared_count; 256 unsigned int *xattr_shared_xattrs; 257 258 union { 259 erofs_blk_t startblk; 260 struct { 261 unsigned short chunkformat; 262 unsigned char chunkbits; 263 }; 264 #ifdef CONFIG_EROFS_FS_ZIP 265 struct { 266 unsigned short z_advise; 267 unsigned char z_algofmt[2]; 268 unsigned char z_lclusterbits; 269 union { 270 u64 z_tailextent_headlcn; 271 u64 z_extents; 272 }; 273 erofs_off_t z_fragmentoff; 274 unsigned short z_idata_size; 275 }; 276 #endif /* CONFIG_EROFS_FS_ZIP */ 277 }; 278 #ifdef CONFIG_EROFS_FS_PAGE_CACHE_SHARE 279 struct list_head ishare_list; 280 union { 281 /* for each anon shared inode */ 282 struct { 283 struct erofs_inode_fingerprint fingerprint; 284 spinlock_t ishare_lock; 285 }; 286 /* for each real filesystem inode */ 287 struct dentry *sharedentry; 288 }; 289 #endif 290 /* the corresponding vfs inode */ 291 struct inode vfs_inode; 292 }; 293 294 #define EROFS_I(ptr) container_of(ptr, struct erofs_inode, vfs_inode) 295 296 static inline bool erofs_inode_in_metabox(struct inode *inode) 297 { 298 return EROFS_I(inode)->nid & BIT_ULL(EROFS_DIRENT_NID_METABOX_BIT); 299 } 300 301 static inline erofs_off_t erofs_iloc(struct inode *inode) 302 { 303 struct erofs_sb_info *sbi = EROFS_I_SB(inode); 304 erofs_nid_t nid_lo = EROFS_I(inode)->nid & EROFS_DIRENT_NID_MASK; 305 306 if (erofs_inode_in_metabox(inode)) 307 return nid_lo << sbi->islotbits; 308 return erofs_pos(inode->i_sb, sbi->meta_blkaddr) + 309 (nid_lo << sbi->islotbits); 310 } 311 312 static inline unsigned int erofs_inode_version(unsigned int ifmt) 313 { 314 return (ifmt >> EROFS_I_VERSION_BIT) & EROFS_I_VERSION_MASK; 315 } 316 317 static inline unsigned int erofs_inode_datalayout(unsigned int ifmt) 318 { 319 return (ifmt >> EROFS_I_DATALAYOUT_BIT) & EROFS_I_DATALAYOUT_MASK; 320 } 321 322 /* reclaiming is never triggered when allocating new folios. */ 323 static inline struct folio *erofs_grab_folio_nowait(struct address_space *as, 324 pgoff_t index) 325 { 326 return __filemap_get_folio(as, index, 327 FGP_LOCK|FGP_CREAT|FGP_NOFS|FGP_NOWAIT, 328 readahead_gfp_mask(as) & ~__GFP_RECLAIM); 329 } 330 331 /* Allocated on disk at @m_pa (e.g. NOT a fragment extent) */ 332 #define EROFS_MAP_MAPPED 0x0001 333 /* Located in metadata (could be copied from bd_inode) */ 334 #define EROFS_MAP_META 0x0002 335 /* @m_llen may be truncated by the runtime compared to the on-disk record */ 336 #define EROFS_MAP_PARTIAL_MAPPED 0x0004 337 /* The on-disk @m_llen may cover only part of the encoded data */ 338 #define EROFS_MAP_PARTIAL_REF 0x0008 339 /* Located in the special packed inode */ 340 #define EROFS_MAP_FRAGMENT 0x0010 341 /* The encoded on-disk data will be fully handled (decompressed) */ 342 #define EROFS_MAP_FULL(f) (!((f) & (EROFS_MAP_PARTIAL_MAPPED | \ 343 EROFS_MAP_PARTIAL_REF))) 344 345 struct erofs_map_blocks { 346 struct erofs_buf buf; 347 348 erofs_off_t m_pa, m_la; 349 u64 m_plen, m_llen; 350 351 unsigned short m_deviceid; 352 char m_algorithmformat; 353 unsigned int m_flags; 354 }; 355 356 /* 357 * Used to get the exact decompressed length, e.g. fiemap (consider lookback 358 * approach instead if possible since it's more metadata lightweight.) 359 */ 360 #define EROFS_GET_BLOCKS_FIEMAP 0x0001 361 /* Used to map the whole extent if non-negligible data is requested for LZMA */ 362 #define EROFS_GET_BLOCKS_READMORE 0x0002 363 /* Used to map tail extent for tailpacking inline or fragment pcluster */ 364 #define EROFS_GET_BLOCKS_FINDTAIL 0x0004 365 366 enum { 367 Z_EROFS_COMPRESSION_SHIFTED = Z_EROFS_COMPRESSION_MAX, 368 Z_EROFS_COMPRESSION_INTERLACED, 369 Z_EROFS_COMPRESSION_RUNTIME_MAX 370 }; 371 372 struct erofs_map_dev { 373 struct super_block *m_sb; 374 struct erofs_device_info *m_dif; 375 struct block_device *m_bdev; 376 377 erofs_off_t m_pa; 378 unsigned int m_deviceid; 379 }; 380 381 extern const struct super_operations erofs_sops; 382 extern const struct address_space_operations erofs_aops; 383 extern const struct address_space_operations z_erofs_aops; 384 385 extern const struct inode_operations erofs_generic_iops; 386 extern const struct inode_operations erofs_symlink_iops; 387 extern const struct inode_operations erofs_fast_symlink_iops; 388 extern const struct inode_operations erofs_dir_iops; 389 390 extern const struct file_operations erofs_file_fops; 391 extern const struct file_operations erofs_dir_fops; 392 extern const struct file_operations erofs_ishare_fops; 393 394 struct erofs_iomap_iter_ctx { 395 struct page *page; 396 void *base; 397 struct inode *realinode; 398 }; 399 400 extern const struct iomap_ops z_erofs_iomap_report_ops; 401 extern const struct iomap_read_ops erofs_fileio_iomap_read_ops; 402 403 int erofs_setup_managed_cache(struct super_block *sb); 404 #ifdef CONFIG_EROFS_FS_BACKED_BY_FILE 405 int erofs_read_meta_folio(struct file *file, struct folio *folio); 406 #else 407 #define erofs_read_meta_folio NULL 408 #endif 409 void *erofs_read_metadata(struct super_block *sb, struct erofs_buf *buf, 410 erofs_off_t *offset, int *lengthp); 411 void erofs_unmap_metabuf(struct erofs_buf *buf); 412 void erofs_put_metabuf(struct erofs_buf *buf); 413 void *erofs_bread(struct erofs_buf *buf, erofs_off_t offset, bool need_kmap); 414 int erofs_init_metabuf(struct erofs_buf *buf, struct super_block *sb, 415 bool in_metabox); 416 void *erofs_read_metabuf(struct erofs_buf *buf, struct super_block *sb, 417 erofs_off_t offset, bool in_metabox); 418 int erofs_map_dev(struct super_block *sb, struct erofs_map_dev *dev); 419 int erofs_fiemap(struct inode *inode, struct fiemap_extent_info *fieinfo, 420 u64 start, u64 len); 421 loff_t erofs_file_llseek(struct file *file, loff_t offset, int whence); 422 int erofs_map_blocks(struct inode *inode, struct erofs_map_blocks *map); 423 void erofs_onlinefolio_init(struct folio *folio); 424 void erofs_onlinefolio_split(struct folio *folio); 425 void erofs_onlinefolio_end(struct folio *folio, int err, bool dirty); 426 struct inode *erofs_iget(struct super_block *sb, erofs_nid_t nid); 427 int erofs_getattr(const struct mnt_idmap *idmap, const struct path *path, 428 struct kstat *stat, u32 request_mask, 429 unsigned int query_flags); 430 int erofs_namei(struct inode *dir, const struct qstr *name, 431 erofs_nid_t *nid, unsigned int *d_type); 432 433 static inline void *erofs_vm_map_ram(struct page **pages, unsigned int count) 434 { 435 int retried = 0; 436 437 while (1) { 438 void *p = vm_map_ram(pages, count, -1); 439 440 /* retry two more times (totally 3 times) */ 441 if (p || ++retried >= 3) 442 return p; 443 vm_unmap_aliases(); 444 } 445 return NULL; 446 } 447 448 static inline const struct address_space_operations * 449 erofs_get_aops(struct inode *realinode) 450 { 451 if (erofs_inode_is_data_compressed(EROFS_I(realinode)->datalayout)) { 452 if (!IS_ENABLED(CONFIG_EROFS_FS_ZIP)) 453 return ERR_PTR(-EOPNOTSUPP); 454 DO_ONCE_LITE_IF(realinode->i_blkbits != PAGE_SHIFT, 455 erofs_info, realinode->i_sb, 456 "EXPERIMENTAL EROFS subpage compressed block support in use. Use at your own risk!"); 457 return &z_erofs_aops; 458 } 459 return &erofs_aops; 460 } 461 462 int erofs_register_sysfs(struct super_block *sb); 463 void erofs_unregister_sysfs(struct super_block *sb); 464 int __init erofs_init_sysfs(void); 465 void erofs_exit_sysfs(void); 466 467 struct page *__erofs_allocpage(struct page **pagepool, gfp_t gfp, bool tryrsv); 468 static inline struct page *erofs_allocpage(struct page **pagepool, gfp_t gfp) 469 { 470 return __erofs_allocpage(pagepool, gfp, false); 471 } 472 static inline void erofs_pagepool_add(struct page **pagepool, struct page *page) 473 { 474 set_page_private(page, (unsigned long)*pagepool); 475 *pagepool = page; 476 } 477 void erofs_release_pages(struct page **pagepool); 478 479 #ifdef CONFIG_EROFS_FS_ZIP 480 #define MNGD_MAPPING(sbi) ((sbi)->managed_cache->i_mapping) 481 482 extern atomic_long_t erofs_global_shrink_cnt; 483 void erofs_shrinker_register(struct super_block *sb); 484 void erofs_shrinker_unregister(struct super_block *sb); 485 int __init erofs_init_shrinker(void); 486 void erofs_exit_shrinker(void); 487 int __init z_erofs_init_subsystem(void); 488 void z_erofs_exit_subsystem(void); 489 int z_erofs_init_super(struct super_block *sb); 490 unsigned long z_erofs_shrink_scan(struct erofs_sb_info *sbi, 491 unsigned long nr_shrink); 492 int z_erofs_map_blocks_iter(struct inode *inode, struct erofs_map_blocks *map, 493 int flags); 494 void *z_erofs_get_gbuf(unsigned int requiredpages); 495 void z_erofs_put_gbuf(void *ptr); 496 int z_erofs_gbuf_growsize(unsigned int nrpages); 497 int __init z_erofs_gbuf_init(void); 498 void z_erofs_gbuf_exit(void); 499 #else 500 static inline void erofs_shrinker_register(struct super_block *sb) {} 501 static inline void erofs_shrinker_unregister(struct super_block *sb) {} 502 static inline int erofs_init_shrinker(void) { return 0; } 503 static inline void erofs_exit_shrinker(void) {} 504 static inline int z_erofs_init_subsystem(void) { return 0; } 505 static inline void z_erofs_exit_subsystem(void) {} 506 static inline int z_erofs_init_super(struct super_block *sb) { return 0; } 507 #endif /* !CONFIG_EROFS_FS_ZIP */ 508 int z_erofs_parse_cfgs(struct super_block *sb, struct erofs_super_block *dsb); 509 510 #ifdef CONFIG_EROFS_FS_BACKED_BY_FILE 511 struct bio *erofs_fileio_bio_alloc(struct erofs_map_dev *mdev); 512 void erofs_fileio_submit_bio(struct bio *bio); 513 #else 514 static inline struct bio *erofs_fileio_bio_alloc(struct erofs_map_dev *mdev) { return NULL; } 515 static inline void erofs_fileio_submit_bio(struct bio *bio) {} 516 #endif 517 518 #ifdef CONFIG_EROFS_FS_PAGE_CACHE_SHARE 519 int __init erofs_init_ishare(void); 520 void erofs_exit_ishare(void); 521 bool erofs_ishare_fill_inode(struct inode *inode); 522 void erofs_ishare_free_inode(struct inode *inode); 523 struct inode *erofs_real_inode(struct inode *inode, bool *need_iput); 524 #else 525 static inline int erofs_init_ishare(void) { return 0; } 526 static inline void erofs_exit_ishare(void) {} 527 static inline bool erofs_ishare_fill_inode(struct inode *inode) { return false; } 528 static inline void erofs_ishare_free_inode(struct inode *inode) {} 529 static inline struct inode *erofs_real_inode(struct inode *inode, bool *need_iput) 530 { 531 *need_iput = false; 532 return inode; 533 } 534 #endif 535 536 long erofs_ioctl(struct file *filp, unsigned int cmd, unsigned long arg); 537 long erofs_compat_ioctl(struct file *filp, unsigned int cmd, 538 unsigned long arg); 539 540 #endif /* __EROFS_INTERNAL_H */ 541