1/* SPDX-License-Identifier: GPL-2.0 */ 2/* 3 * linux/include/linux/hfsplus_fs.h 4 * 5 * Copyright (C) 1999 6 * Brad Boyer (flar@pants.nu) 7 * (C) 2003 Ardis Technologies <roman@ardistech.com> 8 * 9 */ 10 11#ifndef _LINUX_HFSPLUS_FS_H 12#define _LINUX_HFSPLUS_FS_H 13 14#ifdef pr_fmt 15#undef pr_fmt 16#endif 17 18#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt 19 20#include <linux/fs.h> 21#include <linux/mutex.h> 22#include <linux/buffer_head.h> 23#include <linux/blkdev.h> 24#include "hfsplus_raw.h" 25 26#define DBG_BNODE_REFS 0x00000001 27#define DBG_BNODE_MOD 0x00000002 28#define DBG_CAT_MOD 0x00000004 29#define DBG_INODE 0x00000008 30#define DBG_SUPER 0x00000010 31#define DBG_EXTENT 0x00000020 32#define DBG_BITMAP 0x00000040 33#define DBG_ATTR_MOD 0x00000080 34 35#if 0 36#define DBG_MASK (DBG_EXTENT|DBG_INODE|DBG_BNODE_MOD) 37#define DBG_MASK (DBG_BNODE_MOD|DBG_CAT_MOD|DBG_INODE) 38#define DBG_MASK (DBG_CAT_MOD|DBG_BNODE_REFS|DBG_INODE|DBG_EXTENT) 39#endif 40#define DBG_MASK (0) 41 42#define hfs_dbg(flg, fmt, ...) \ 43do { \ 44 if (DBG_##flg & DBG_MASK) \ 45 printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__); \ 46} while (0) 47 48#define hfs_dbg_cont(flg, fmt, ...) \ 49do { \ 50 if (DBG_##flg & DBG_MASK) \ 51 pr_cont(fmt, ##__VA_ARGS__); \ 52} while (0) 53 54/* Runtime config options */ 55#define HFSPLUS_DEF_CR_TYPE 0x3F3F3F3F /* '????' */ 56 57#define HFSPLUS_TYPE_DATA 0x00 58#define HFSPLUS_TYPE_RSRC 0xFF 59 60typedef int (*btree_keycmp)(const hfsplus_btree_key *, 61 const hfsplus_btree_key *); 62 63#define NODE_HASH_SIZE 256 64 65/* B-tree mutex nested subclasses */ 66enum hfsplus_btree_mutex_classes { 67 CATALOG_BTREE_MUTEX, 68 EXTENTS_BTREE_MUTEX, 69 ATTR_BTREE_MUTEX, 70}; 71 72/* An HFS+ BTree held in memory */ 73struct hfs_btree { 74 struct super_block *sb; 75 struct inode *inode; 76 btree_keycmp keycmp; 77 78 u32 cnid; 79 u32 root; 80 u32 leaf_count; 81 u32 leaf_head; 82 u32 leaf_tail; 83 u32 node_count; 84 u32 free_nodes; 85 u32 attributes; 86 87 unsigned int node_size; 88 unsigned int node_size_shift; 89 unsigned int max_key_len; 90 unsigned int depth; 91 92 struct mutex tree_lock; 93 94 unsigned int pages_per_bnode; 95 spinlock_t hash_lock; 96 struct hfs_bnode *node_hash[NODE_HASH_SIZE]; 97 int node_hash_cnt; 98}; 99 100struct page; 101 102/* An HFS+ BTree node in memory */ 103struct hfs_bnode { 104 struct hfs_btree *tree; 105 106 u32 prev; 107 u32 this; 108 u32 next; 109 u32 parent; 110 111 u16 num_recs; 112 u8 type; 113 u8 height; 114 115 struct hfs_bnode *next_hash; 116 unsigned long flags; 117 wait_queue_head_t lock_wq; 118 atomic_t refcnt; 119 unsigned int page_offset; 120 struct page *page[]; 121}; 122 123#define HFS_BNODE_LOCK 0 124#define HFS_BNODE_ERROR 1 125#define HFS_BNODE_NEW 2 126#define HFS_BNODE_DIRTY 3 127#define HFS_BNODE_DELETED 4 128 129/* 130 * Attributes file states 131 */ 132#define HFSPLUS_EMPTY_ATTR_TREE 0 133#define HFSPLUS_CREATING_ATTR_TREE 1 134#define HFSPLUS_VALID_ATTR_TREE 2 135#define HFSPLUS_FAILED_ATTR_TREE 3 136 137/* 138 * HFS+ superblock info (built from Volume Header on disk) 139 */ 140 141struct hfsplus_vh; 142struct hfs_btree; 143 144struct hfsplus_sb_info { 145 void *s_vhdr_buf; 146 struct hfsplus_vh *s_vhdr; 147 void *s_backup_vhdr_buf; 148 struct hfsplus_vh *s_backup_vhdr; 149 struct hfs_btree *ext_tree; 150 struct hfs_btree *cat_tree; 151 struct hfs_btree *attr_tree; 152 atomic_t attr_tree_state; 153 struct inode *alloc_file; 154 struct inode *hidden_dir; 155 struct nls_table *nls; 156 157 /* Runtime variables */ 158 u32 blockoffset; 159 sector_t part_start; 160 sector_t sect_count; 161 int fs_shift; 162 163 /* immutable data from the volume header */ 164 u32 alloc_blksz; 165 int alloc_blksz_shift; 166 u32 total_blocks; 167 u32 data_clump_blocks, rsrc_clump_blocks; 168 169 /* mutable data from the volume header, protected by alloc_mutex */ 170 u32 free_blocks; 171 struct mutex alloc_mutex; 172 173 /* mutable data from the volume header, protected by vh_mutex */ 174 u32 next_cnid; 175 u32 file_count; 176 u32 folder_count; 177 struct mutex vh_mutex; 178 179 /* Config options */ 180 u32 creator; 181 u32 type; 182 183 umode_t umask; 184 kuid_t uid; 185 kgid_t gid; 186 187 int part, session; 188 unsigned long flags; 189 190 int work_queued; /* non-zero delayed work is queued */ 191 struct delayed_work sync_work; /* FS sync delayed work */ 192 spinlock_t work_lock; /* protects sync_work and work_queued */ 193}; 194 195#define HFSPLUS_SB_WRITEBACKUP 0 196#define HFSPLUS_SB_NODECOMPOSE 1 197#define HFSPLUS_SB_FORCE 2 198#define HFSPLUS_SB_HFSX 3 199#define HFSPLUS_SB_CASEFOLD 4 200#define HFSPLUS_SB_NOBARRIER 5 201#define HFSPLUS_SB_UID 6 202#define HFSPLUS_SB_GID 7 203 204static inline struct hfsplus_sb_info *HFSPLUS_SB(struct super_block *sb) 205{ 206 return sb->s_fs_info; 207} 208 209 210struct hfsplus_inode_info { 211 atomic_t opencnt; 212 213 /* 214 * Extent allocation information, protected by extents_lock. 215 */ 216 u32 first_blocks; 217 u32 clump_blocks; 218 u32 alloc_blocks; 219 u32 cached_start; 220 u32 cached_blocks; 221 hfsplus_extent_rec first_extents; 222 hfsplus_extent_rec cached_extents; 223 unsigned int extent_state; 224 struct mutex extents_lock; 225 226 /* 227 * Immutable data. 228 */ 229 struct inode *rsrc_inode; 230 __be32 create_date; 231 232 /* 233 * Protected by sbi->vh_mutex. 234 */ 235 u32 linkid; 236 237 /* 238 * Accessed using atomic bitops. 239 */ 240 unsigned long flags; 241 242 /* 243 * Protected by i_mutex. 244 */ 245 sector_t fs_blocks; 246 u8 userflags; /* BSD user file flags */ 247 u32 subfolders; /* Subfolder count (HFSX only) */ 248 struct list_head open_dir_list; 249 spinlock_t open_dir_lock; 250 loff_t phys_size; 251 252 struct inode vfs_inode; 253}; 254 255#define HFSPLUS_EXT_DIRTY 0x0001 256#define HFSPLUS_EXT_NEW 0x0002 257 258#define HFSPLUS_I_RSRC 0 /* represents a resource fork */ 259#define HFSPLUS_I_CAT_DIRTY 1 /* has changes in the catalog tree */ 260#define HFSPLUS_I_EXT_DIRTY 2 /* has changes in the extent tree */ 261#define HFSPLUS_I_ALLOC_DIRTY 3 /* has changes in the allocation file */ 262#define HFSPLUS_I_ATTR_DIRTY 4 /* has changes in the attributes tree */ 263 264#define HFSPLUS_IS_RSRC(inode) \ 265 test_bit(HFSPLUS_I_RSRC, &HFSPLUS_I(inode)->flags) 266 267static inline struct hfsplus_inode_info *HFSPLUS_I(struct inode *inode) 268{ 269 return container_of(inode, struct hfsplus_inode_info, vfs_inode); 270} 271 272/* 273 * Mark an inode dirty, and also mark the btree in which the 274 * specific type of metadata is stored. 275 * For data or metadata that gets written back by into the catalog btree 276 * by hfsplus_write_inode a plain mark_inode_dirty call is enough. 277 */ 278static inline void hfsplus_mark_inode_dirty(struct inode *inode, 279 unsigned int flag) 280{ 281 set_bit(flag, &HFSPLUS_I(inode)->flags); 282 mark_inode_dirty(inode); 283} 284 285struct hfs_find_data { 286 /* filled by caller */ 287 hfsplus_btree_key *search_key; 288 hfsplus_btree_key *key; 289 /* filled by find */ 290 struct hfs_btree *tree; 291 struct hfs_bnode *bnode; 292 /* filled by findrec */ 293 int record; 294 int keyoffset, keylength; 295 int entryoffset, entrylength; 296}; 297 298struct hfsplus_readdir_data { 299 struct list_head list; 300 struct file *file; 301 struct hfsplus_cat_key key; 302}; 303 304/* 305 * Find minimum acceptible I/O size for an hfsplus sb. 306 */ 307static inline unsigned short hfsplus_min_io_size(struct super_block *sb) 308{ 309 return max_t(unsigned short, bdev_logical_block_size(sb->s_bdev), 310 HFSPLUS_SECTOR_SIZE); 311} 312 313#define hfs_btree_open hfsplus_btree_open 314#define hfs_btree_close hfsplus_btree_close 315#define hfs_btree_write hfsplus_btree_write 316#define hfs_bmap_reserve hfsplus_bmap_reserve 317#define hfs_bmap_alloc hfsplus_bmap_alloc 318#define hfs_bmap_free hfsplus_bmap_free 319#define hfs_bnode_read hfsplus_bnode_read 320#define hfs_bnode_read_u16 hfsplus_bnode_read_u16 321#define hfs_bnode_read_u8 hfsplus_bnode_read_u8 322#define hfs_bnode_read_key hfsplus_bnode_read_key 323#define hfs_bnode_write hfsplus_bnode_write 324#define hfs_bnode_write_u16 hfsplus_bnode_write_u16 325#define hfs_bnode_clear hfsplus_bnode_clear 326#define hfs_bnode_copy hfsplus_bnode_copy 327#define hfs_bnode_move hfsplus_bnode_move 328#define hfs_bnode_dump hfsplus_bnode_dump 329#define hfs_bnode_unlink hfsplus_bnode_unlink 330#define hfs_bnode_findhash hfsplus_bnode_findhash 331#define hfs_bnode_find hfsplus_bnode_find 332#define hfs_bnode_unhash hfsplus_bnode_unhash 333#define hfs_bnode_free hfsplus_bnode_free 334#define hfs_bnode_create hfsplus_bnode_create 335#define hfs_bnode_get hfsplus_bnode_get 336#define hfs_bnode_put hfsplus_bnode_put 337#define hfs_brec_lenoff hfsplus_brec_lenoff 338#define hfs_brec_keylen hfsplus_brec_keylen 339#define hfs_brec_insert hfsplus_brec_insert 340#define hfs_brec_remove hfsplus_brec_remove 341#define hfs_find_init hfsplus_find_init 342#define hfs_find_exit hfsplus_find_exit 343#define __hfs_brec_find __hfsplus_brec_find 344#define hfs_brec_find hfsplus_brec_find 345#define hfs_brec_read hfsplus_brec_read 346#define hfs_brec_goto hfsplus_brec_goto 347#define hfs_part_find hfsplus_part_find 348 349/* 350 * definitions for ext2 flag ioctls (linux really needs a generic 351 * interface for this). 352 */ 353 354/* ext2 ioctls (EXT2_IOC_GETFLAGS and EXT2_IOC_SETFLAGS) to support 355 * chattr/lsattr */ 356#define HFSPLUS_IOC_EXT2_GETFLAGS FS_IOC_GETFLAGS 357#define HFSPLUS_IOC_EXT2_SETFLAGS FS_IOC_SETFLAGS 358 359 360/* 361 * hfs+-specific ioctl for making the filesystem bootable 362 */ 363#define HFSPLUS_IOC_BLESS _IO('h', 0x80) 364 365typedef int (*search_strategy_t)(struct hfs_bnode *, 366 struct hfs_find_data *, 367 int *, int *, int *); 368 369/* 370 * Functions in any *.c used in other files 371 */ 372 373/* attributes.c */ 374int __init hfsplus_create_attr_tree_cache(void); 375void hfsplus_destroy_attr_tree_cache(void); 376int hfsplus_attr_bin_cmp_key(const hfsplus_btree_key *k1, 377 const hfsplus_btree_key *k2); 378int hfsplus_attr_build_key(struct super_block *sb, hfsplus_btree_key *key, 379 u32 cnid, const char *name); 380hfsplus_attr_entry *hfsplus_alloc_attr_entry(void); 381void hfsplus_destroy_attr_entry(hfsplus_attr_entry *entry); 382int hfsplus_find_attr(struct super_block *sb, u32 cnid, const char *name, 383 struct hfs_find_data *fd); 384int hfsplus_attr_exists(struct inode *inode, const char *name); 385int hfsplus_create_attr(struct inode *inode, const char *name, 386 const void *value, size_t size); 387int hfsplus_delete_attr(struct inode *inode, const char *name); 388int hfsplus_delete_all_attrs(struct inode *dir, u32 cnid); 389 390/* bitmap.c */ 391int hfsplus_block_allocate(struct super_block *sb, u32 size, u32 offset, 392 u32 *max); 393int hfsplus_block_free(struct super_block *sb, u32 offset, u32 count); 394 395/* btree.c */ 396u32 hfsplus_calc_btree_clump_size(u32 block_size, u32 node_size, u64 sectors, 397 int file_id); 398struct hfs_btree *hfs_btree_open(struct super_block *sb, u32 id); 399void hfs_btree_close(struct hfs_btree *tree); 400int hfs_btree_write(struct hfs_btree *tree); 401int hfs_bmap_reserve(struct hfs_btree *tree, int rsvd_nodes); 402struct hfs_bnode *hfs_bmap_alloc(struct hfs_btree *tree); 403void hfs_bmap_free(struct hfs_bnode *node); 404 405/* bnode.c */ 406void hfs_bnode_read(struct hfs_bnode *node, void *buf, int off, int len); 407u16 hfs_bnode_read_u16(struct hfs_bnode *node, int off); 408u8 hfs_bnode_read_u8(struct hfs_bnode *node, int off); 409void hfs_bnode_read_key(struct hfs_bnode *node, void *key, int off); 410void hfs_bnode_write(struct hfs_bnode *node, void *buf, int off, int len); 411void hfs_bnode_write_u16(struct hfs_bnode *node, int off, u16 data); 412void hfs_bnode_clear(struct hfs_bnode *node, int off, int len); 413void hfs_bnode_copy(struct hfs_bnode *dst_node, int dst, 414 struct hfs_bnode *src_node, int src, int len); 415void hfs_bnode_move(struct hfs_bnode *node, int dst, int src, int len); 416void hfs_bnode_dump(struct hfs_bnode *node); 417void hfs_bnode_unlink(struct hfs_bnode *node); 418struct hfs_bnode *hfs_bnode_findhash(struct hfs_btree *tree, u32 cnid); 419void hfs_bnode_unhash(struct hfs_bnode *node); 420struct hfs_bnode *hfs_bnode_find(struct hfs_btree *tree, u32 num); 421void hfs_bnode_free(struct hfs_bnode *node); 422struct hfs_bnode *hfs_bnode_create(struct hfs_btree *tree, u32 num); 423void hfs_bnode_get(struct hfs_bnode *node); 424void hfs_bnode_put(struct hfs_bnode *node); 425bool hfs_bnode_need_zeroout(struct hfs_btree *tree); 426 427/* brec.c */ 428u16 hfs_brec_lenoff(struct hfs_bnode *node, u16 rec, u16 *off); 429u16 hfs_brec_keylen(struct hfs_bnode *node, u16 rec); 430int hfs_brec_insert(struct hfs_find_data *fd, void *entry, int entry_len); 431int hfs_brec_remove(struct hfs_find_data *fd); 432 433/* bfind.c */ 434int hfs_find_init(struct hfs_btree *tree, struct hfs_find_data *fd); 435void hfs_find_exit(struct hfs_find_data *fd); 436int hfs_find_1st_rec_by_cnid(struct hfs_bnode *bnode, struct hfs_find_data *fd, 437 int *begin, int *end, int *cur_rec); 438int hfs_find_rec_by_key(struct hfs_bnode *bnode, struct hfs_find_data *fd, 439 int *begin, int *end, int *cur_rec); 440int __hfs_brec_find(struct hfs_bnode *bnode, struct hfs_find_data *fd, 441 search_strategy_t rec_found); 442int hfs_brec_find(struct hfs_find_data *fd, search_strategy_t do_key_compare); 443int hfs_brec_read(struct hfs_find_data *fd, void *rec, int rec_len); 444int hfs_brec_goto(struct hfs_find_data *fd, int cnt); 445 446/* catalog.c */ 447int hfsplus_cat_case_cmp_key(const hfsplus_btree_key *k1, 448 const hfsplus_btree_key *k2); 449int hfsplus_cat_bin_cmp_key(const hfsplus_btree_key *k1, 450 const hfsplus_btree_key *k2); 451int hfsplus_cat_build_key(struct super_block *sb, hfsplus_btree_key *key, 452 u32 parent, const struct qstr *str); 453void hfsplus_cat_build_key_with_cnid(struct super_block *sb, 454 hfsplus_btree_key *key, u32 parent); 455void hfsplus_cat_set_perms(struct inode *inode, struct hfsplus_perm *perms); 456int hfsplus_find_cat(struct super_block *sb, u32 cnid, 457 struct hfs_find_data *fd); 458int hfsplus_create_cat(u32 cnid, struct inode *dir, const struct qstr *str, 459 struct inode *inode); 460int hfsplus_delete_cat(u32 cnid, struct inode *dir, const struct qstr *str); 461int hfsplus_rename_cat(u32 cnid, struct inode *src_dir, const struct qstr *src_name, 462 struct inode *dst_dir, const struct qstr *dst_name); 463 464/* dir.c */ 465extern const struct inode_operations hfsplus_dir_inode_operations; 466extern const struct file_operations hfsplus_dir_operations; 467 468/* extents.c */ 469int hfsplus_ext_cmp_key(const hfsplus_btree_key *k1, 470 const hfsplus_btree_key *k2); 471int hfsplus_ext_write_extent(struct inode *inode); 472int hfsplus_get_block(struct inode *inode, sector_t iblock, 473 struct buffer_head *bh_result, int create); 474int hfsplus_free_fork(struct super_block *sb, u32 cnid, 475 struct hfsplus_fork_raw *fork, int type); 476int hfsplus_file_extend(struct inode *inode, bool zeroout); 477void hfsplus_file_truncate(struct inode *inode); 478 479/* inode.c */ 480extern const struct address_space_operations hfsplus_aops; 481extern const struct address_space_operations hfsplus_btree_aops; 482extern const struct dentry_operations hfsplus_dentry_operations; 483 484struct inode *hfsplus_new_inode(struct super_block *sb, struct inode *dir, 485 umode_t mode); 486void hfsplus_delete_inode(struct inode *inode); 487void hfsplus_inode_read_fork(struct inode *inode, 488 struct hfsplus_fork_raw *fork); 489void hfsplus_inode_write_fork(struct inode *inode, 490 struct hfsplus_fork_raw *fork); 491int hfsplus_cat_read_inode(struct inode *inode, struct hfs_find_data *fd); 492int hfsplus_cat_write_inode(struct inode *inode); 493int hfsplus_getattr(const struct path *path, struct kstat *stat, 494 u32 request_mask, unsigned int query_flags); 495int hfsplus_file_fsync(struct file *file, loff_t start, loff_t end, 496 int datasync); 497 498/* ioctl.c */ 499long hfsplus_ioctl(struct file *filp, unsigned int cmd, unsigned long arg); 500 501/* options.c */ 502void hfsplus_fill_defaults(struct hfsplus_sb_info *opts); 503int hfsplus_parse_options_remount(char *input, int *force); 504int hfsplus_parse_options(char *input, struct hfsplus_sb_info *sbi); 505int hfsplus_show_options(struct seq_file *seq, struct dentry *root); 506 507/* part_tbl.c */ 508int hfs_part_find(struct super_block *sb, sector_t *part_start, 509 sector_t *part_size); 510 511/* super.c */ 512struct inode *hfsplus_iget(struct super_block *sb, unsigned long ino); 513void hfsplus_mark_mdb_dirty(struct super_block *sb); 514 515/* tables.c */ 516extern u16 hfsplus_case_fold_table[]; 517extern u16 hfsplus_decompose_table[]; 518extern u16 hfsplus_compose_table[]; 519 520/* unicode.c */ 521int hfsplus_strcasecmp(const struct hfsplus_unistr *s1, 522 const struct hfsplus_unistr *s2); 523int hfsplus_strcmp(const struct hfsplus_unistr *s1, 524 const struct hfsplus_unistr *s2); 525int hfsplus_uni2asc(struct super_block *sb, const struct hfsplus_unistr *ustr, 526 char *astr, int *len_p); 527int hfsplus_asc2uni(struct super_block *sb, struct hfsplus_unistr *ustr, 528 int max_unistr_len, const char *astr, int len); 529int hfsplus_hash_dentry(const struct dentry *dentry, struct qstr *str); 530int hfsplus_compare_dentry(const struct dentry *dentry, unsigned int len, 531 const char *str, const struct qstr *name); 532 533/* wrapper.c */ 534int hfsplus_submit_bio(struct super_block *sb, sector_t sector, void *buf, 535 void **data, int op, int op_flags); 536int hfsplus_read_wrapper(struct super_block *sb); 537 538/* 539 * time helpers: convert between 1904-base and 1970-base timestamps 540 * 541 * HFS+ implementations are highly inconsistent, this one matches the 542 * traditional behavior of 64-bit Linux, giving the most useful 543 * time range between 1970 and 2106, by treating any on-disk timestamp 544 * under HFSPLUS_UTC_OFFSET (Jan 1 1970) as a time between 2040 and 2106. 545 */ 546#define HFSPLUS_UTC_OFFSET 2082844800U 547 548static inline time64_t __hfsp_mt2ut(__be32 mt) 549{ 550 time64_t ut = (u32)(be32_to_cpu(mt) - HFSPLUS_UTC_OFFSET); 551 552 return ut; 553} 554 555static inline __be32 __hfsp_ut2mt(time64_t ut) 556{ 557 return cpu_to_be32(lower_32_bits(ut) + HFSPLUS_UTC_OFFSET); 558} 559 560/* compatibility */ 561#define hfsp_mt2ut(t) (struct timespec64){ .tv_sec = __hfsp_mt2ut(t) } 562#define hfsp_ut2mt(t) __hfsp_ut2mt((t).tv_sec) 563#define hfsp_now2mt() __hfsp_ut2mt(ktime_get_real_seconds()) 564 565#endif 566