1 /* SPDX-License-Identifier: GPL-2.0 */
3 * linux/include/linux/hfsplus_fs.h
6 * Brad Boyer (flar@pants.nu)
7 * (C) 2003 Ardis Technologies <roman@ardistech.com>
11 #ifndef _LINUX_HFSPLUS_FS_H
12 #define _LINUX_HFSPLUS_FS_H
18 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
21 #include <linux/mutex.h>
22 #include <linux/buffer_head.h>
23 #include <linux/blkdev.h>
24 #include "hfsplus_raw.h"
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 #define DBG_ACL_MOD 0x00000100
37 #define DBG_MASK (DBG_EXTENT|DBG_INODE|DBG_BNODE_MOD)
38 #define DBG_MASK (DBG_BNODE_MOD|DBG_CAT_MOD|DBG_INODE)
39 #define DBG_MASK (DBG_CAT_MOD|DBG_BNODE_REFS|DBG_INODE|DBG_EXTENT)
43 #define hfs_dbg(flg, fmt, ...) \
45 if (DBG_##flg & DBG_MASK) \
46 printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__); \
49 #define hfs_dbg_cont(flg, fmt, ...) \
51 if (DBG_##flg & DBG_MASK) \
52 pr_cont(fmt, ##__VA_ARGS__); \
55 /* Runtime config options */
56 #define HFSPLUS_DEF_CR_TYPE 0x3F3F3F3F /* '????' */
58 #define HFSPLUS_TYPE_DATA 0x00
59 #define HFSPLUS_TYPE_RSRC 0xFF
61 typedef int (*btree_keycmp)(const hfsplus_btree_key *,
62 const hfsplus_btree_key *);
64 #define NODE_HASH_SIZE 256
66 /* B-tree mutex nested subclasses */
67 enum hfsplus_btree_mutex_classes {
73 /* An HFS+ BTree held in memory */
75 struct super_block *sb;
88 unsigned int node_size;
89 unsigned int node_size_shift;
90 unsigned int max_key_len;
93 struct mutex tree_lock;
95 unsigned int pages_per_bnode;
97 struct hfs_bnode *node_hash[NODE_HASH_SIZE];
103 /* An HFS+ BTree node in memory */
105 struct hfs_btree *tree;
116 struct hfs_bnode *next_hash;
118 wait_queue_head_t lock_wq;
120 unsigned int page_offset;
121 struct page *page[0];
124 #define HFS_BNODE_LOCK 0
125 #define HFS_BNODE_ERROR 1
126 #define HFS_BNODE_NEW 2
127 #define HFS_BNODE_DIRTY 3
128 #define HFS_BNODE_DELETED 4
131 * Attributes file states
133 #define HFSPLUS_EMPTY_ATTR_TREE 0
134 #define HFSPLUS_CREATING_ATTR_TREE 1
135 #define HFSPLUS_VALID_ATTR_TREE 2
136 #define HFSPLUS_FAILED_ATTR_TREE 3
139 * HFS+ superblock info (built from Volume Header on disk)
145 struct hfsplus_sb_info {
147 struct hfsplus_vh *s_vhdr;
148 void *s_backup_vhdr_buf;
149 struct hfsplus_vh *s_backup_vhdr;
150 struct hfs_btree *ext_tree;
151 struct hfs_btree *cat_tree;
152 struct hfs_btree *attr_tree;
153 atomic_t attr_tree_state;
154 struct inode *alloc_file;
155 struct inode *hidden_dir;
156 struct nls_table *nls;
158 /* Runtime variables */
164 /* immutable data from the volume header */
166 int alloc_blksz_shift;
168 u32 data_clump_blocks, rsrc_clump_blocks;
170 /* mutable data from the volume header, protected by alloc_mutex */
172 struct mutex alloc_mutex;
174 /* mutable data from the volume header, protected by vh_mutex */
178 struct mutex vh_mutex;
191 int work_queued; /* non-zero delayed work is queued */
192 struct delayed_work sync_work; /* FS sync delayed work */
193 spinlock_t work_lock; /* protects sync_work and work_queued */
196 #define HFSPLUS_SB_WRITEBACKUP 0
197 #define HFSPLUS_SB_NODECOMPOSE 1
198 #define HFSPLUS_SB_FORCE 2
199 #define HFSPLUS_SB_HFSX 3
200 #define HFSPLUS_SB_CASEFOLD 4
201 #define HFSPLUS_SB_NOBARRIER 5
202 #define HFSPLUS_SB_UID 6
203 #define HFSPLUS_SB_GID 7
205 static inline struct hfsplus_sb_info *HFSPLUS_SB(struct super_block *sb)
207 return sb->s_fs_info;
211 struct hfsplus_inode_info {
215 * Extent allocation information, protected by extents_lock.
222 hfsplus_extent_rec first_extents;
223 hfsplus_extent_rec cached_extents;
224 unsigned int extent_state;
225 struct mutex extents_lock;
230 struct inode *rsrc_inode;
234 * Protected by sbi->vh_mutex.
239 * Accessed using atomic bitops.
244 * Protected by i_mutex.
247 u8 userflags; /* BSD user file flags */
248 u32 subfolders; /* Subfolder count (HFSX only) */
249 struct list_head open_dir_list;
250 spinlock_t open_dir_lock;
253 struct inode vfs_inode;
256 #define HFSPLUS_EXT_DIRTY 0x0001
257 #define HFSPLUS_EXT_NEW 0x0002
259 #define HFSPLUS_I_RSRC 0 /* represents a resource fork */
260 #define HFSPLUS_I_CAT_DIRTY 1 /* has changes in the catalog tree */
261 #define HFSPLUS_I_EXT_DIRTY 2 /* has changes in the extent tree */
262 #define HFSPLUS_I_ALLOC_DIRTY 3 /* has changes in the allocation file */
263 #define HFSPLUS_I_ATTR_DIRTY 4 /* has changes in the attributes tree */
265 #define HFSPLUS_IS_RSRC(inode) \
266 test_bit(HFSPLUS_I_RSRC, &HFSPLUS_I(inode)->flags)
268 static inline struct hfsplus_inode_info *HFSPLUS_I(struct inode *inode)
270 return container_of(inode, struct hfsplus_inode_info, vfs_inode);
274 * Mark an inode dirty, and also mark the btree in which the
275 * specific type of metadata is stored.
276 * For data or metadata that gets written back by into the catalog btree
277 * by hfsplus_write_inode a plain mark_inode_dirty call is enough.
279 static inline void hfsplus_mark_inode_dirty(struct inode *inode,
282 set_bit(flag, &HFSPLUS_I(inode)->flags);
283 mark_inode_dirty(inode);
286 struct hfs_find_data {
287 /* filled by caller */
288 hfsplus_btree_key *search_key;
289 hfsplus_btree_key *key;
291 struct hfs_btree *tree;
292 struct hfs_bnode *bnode;
293 /* filled by findrec */
295 int keyoffset, keylength;
296 int entryoffset, entrylength;
299 struct hfsplus_readdir_data {
300 struct list_head list;
302 struct hfsplus_cat_key key;
306 * Find minimum acceptible I/O size for an hfsplus sb.
308 static inline unsigned short hfsplus_min_io_size(struct super_block *sb)
310 return max_t(unsigned short, bdev_logical_block_size(sb->s_bdev),
311 HFSPLUS_SECTOR_SIZE);
314 #define hfs_btree_open hfsplus_btree_open
315 #define hfs_btree_close hfsplus_btree_close
316 #define hfs_btree_write hfsplus_btree_write
317 #define hfs_bmap_reserve hfsplus_bmap_reserve
318 #define hfs_bmap_alloc hfsplus_bmap_alloc
319 #define hfs_bmap_free hfsplus_bmap_free
320 #define hfs_bnode_read hfsplus_bnode_read
321 #define hfs_bnode_read_u16 hfsplus_bnode_read_u16
322 #define hfs_bnode_read_u8 hfsplus_bnode_read_u8
323 #define hfs_bnode_read_key hfsplus_bnode_read_key
324 #define hfs_bnode_write hfsplus_bnode_write
325 #define hfs_bnode_write_u16 hfsplus_bnode_write_u16
326 #define hfs_bnode_clear hfsplus_bnode_clear
327 #define hfs_bnode_copy hfsplus_bnode_copy
328 #define hfs_bnode_move hfsplus_bnode_move
329 #define hfs_bnode_dump hfsplus_bnode_dump
330 #define hfs_bnode_unlink hfsplus_bnode_unlink
331 #define hfs_bnode_findhash hfsplus_bnode_findhash
332 #define hfs_bnode_find hfsplus_bnode_find
333 #define hfs_bnode_unhash hfsplus_bnode_unhash
334 #define hfs_bnode_free hfsplus_bnode_free
335 #define hfs_bnode_create hfsplus_bnode_create
336 #define hfs_bnode_get hfsplus_bnode_get
337 #define hfs_bnode_put hfsplus_bnode_put
338 #define hfs_brec_lenoff hfsplus_brec_lenoff
339 #define hfs_brec_keylen hfsplus_brec_keylen
340 #define hfs_brec_insert hfsplus_brec_insert
341 #define hfs_brec_remove hfsplus_brec_remove
342 #define hfs_find_init hfsplus_find_init
343 #define hfs_find_exit hfsplus_find_exit
344 #define __hfs_brec_find __hfsplus_brec_find
345 #define hfs_brec_find hfsplus_brec_find
346 #define hfs_brec_read hfsplus_brec_read
347 #define hfs_brec_goto hfsplus_brec_goto
348 #define hfs_part_find hfsplus_part_find
351 * definitions for ext2 flag ioctls (linux really needs a generic
352 * interface for this).
355 /* ext2 ioctls (EXT2_IOC_GETFLAGS and EXT2_IOC_SETFLAGS) to support
357 #define HFSPLUS_IOC_EXT2_GETFLAGS FS_IOC_GETFLAGS
358 #define HFSPLUS_IOC_EXT2_SETFLAGS FS_IOC_SETFLAGS
362 * hfs+-specific ioctl for making the filesystem bootable
364 #define HFSPLUS_IOC_BLESS _IO('h', 0x80)
366 typedef int (*search_strategy_t)(struct hfs_bnode *,
367 struct hfs_find_data *,
368 int *, int *, int *);
371 * Functions in any *.c used in other files
375 int __init hfsplus_create_attr_tree_cache(void);
376 void hfsplus_destroy_attr_tree_cache(void);
377 int hfsplus_attr_bin_cmp_key(const hfsplus_btree_key *k1,
378 const hfsplus_btree_key *k2);
379 int hfsplus_attr_build_key(struct super_block *sb, hfsplus_btree_key *key,
380 u32 cnid, const char *name);
381 hfsplus_attr_entry *hfsplus_alloc_attr_entry(void);
382 void hfsplus_destroy_attr_entry(hfsplus_attr_entry *entry);
383 int hfsplus_find_attr(struct super_block *sb, u32 cnid, const char *name,
384 struct hfs_find_data *fd);
385 int hfsplus_attr_exists(struct inode *inode, const char *name);
386 int hfsplus_create_attr(struct inode *inode, const char *name,
387 const void *value, size_t size);
388 int hfsplus_delete_attr(struct inode *inode, const char *name);
389 int hfsplus_delete_all_attrs(struct inode *dir, u32 cnid);
392 int hfsplus_block_allocate(struct super_block *sb, u32 size, u32 offset,
394 int hfsplus_block_free(struct super_block *sb, u32 offset, u32 count);
397 u32 hfsplus_calc_btree_clump_size(u32 block_size, u32 node_size, u64 sectors,
399 struct hfs_btree *hfs_btree_open(struct super_block *sb, u32 id);
400 void hfs_btree_close(struct hfs_btree *tree);
401 int hfs_btree_write(struct hfs_btree *tree);
402 int hfs_bmap_reserve(struct hfs_btree *tree, int rsvd_nodes);
403 struct hfs_bnode *hfs_bmap_alloc(struct hfs_btree *tree);
404 void hfs_bmap_free(struct hfs_bnode *node);
407 void hfs_bnode_read(struct hfs_bnode *node, void *buf, int off, int len);
408 u16 hfs_bnode_read_u16(struct hfs_bnode *node, int off);
409 u8 hfs_bnode_read_u8(struct hfs_bnode *node, int off);
410 void hfs_bnode_read_key(struct hfs_bnode *node, void *key, int off);
411 void hfs_bnode_write(struct hfs_bnode *node, void *buf, int off, int len);
412 void hfs_bnode_write_u16(struct hfs_bnode *node, int off, u16 data);
413 void hfs_bnode_clear(struct hfs_bnode *node, int off, int len);
414 void hfs_bnode_copy(struct hfs_bnode *dst_node, int dst,
415 struct hfs_bnode *src_node, int src, int len);
416 void hfs_bnode_move(struct hfs_bnode *node, int dst, int src, int len);
417 void hfs_bnode_dump(struct hfs_bnode *node);
418 void hfs_bnode_unlink(struct hfs_bnode *node);
419 struct hfs_bnode *hfs_bnode_findhash(struct hfs_btree *tree, u32 cnid);
420 void hfs_bnode_unhash(struct hfs_bnode *node);
421 struct hfs_bnode *hfs_bnode_find(struct hfs_btree *tree, u32 num);
422 void hfs_bnode_free(struct hfs_bnode *node);
423 struct hfs_bnode *hfs_bnode_create(struct hfs_btree *tree, u32 num);
424 void hfs_bnode_get(struct hfs_bnode *node);
425 void hfs_bnode_put(struct hfs_bnode *node);
426 bool hfs_bnode_need_zeroout(struct hfs_btree *tree);
429 u16 hfs_brec_lenoff(struct hfs_bnode *node, u16 rec, u16 *off);
430 u16 hfs_brec_keylen(struct hfs_bnode *node, u16 rec);
431 int hfs_brec_insert(struct hfs_find_data *fd, void *entry, int entry_len);
432 int hfs_brec_remove(struct hfs_find_data *fd);
435 int hfs_find_init(struct hfs_btree *tree, struct hfs_find_data *fd);
436 void hfs_find_exit(struct hfs_find_data *fd);
437 int hfs_find_1st_rec_by_cnid(struct hfs_bnode *bnode, struct hfs_find_data *fd,
438 int *begin, int *end, int *cur_rec);
439 int hfs_find_rec_by_key(struct hfs_bnode *bnode, struct hfs_find_data *fd,
440 int *begin, int *end, int *cur_rec);
441 int __hfs_brec_find(struct hfs_bnode *bnode, struct hfs_find_data *fd,
442 search_strategy_t rec_found);
443 int hfs_brec_find(struct hfs_find_data *fd, search_strategy_t do_key_compare);
444 int hfs_brec_read(struct hfs_find_data *fd, void *rec, int rec_len);
445 int hfs_brec_goto(struct hfs_find_data *fd, int cnt);
448 int hfsplus_cat_case_cmp_key(const hfsplus_btree_key *k1,
449 const hfsplus_btree_key *k2);
450 int hfsplus_cat_bin_cmp_key(const hfsplus_btree_key *k1,
451 const hfsplus_btree_key *k2);
452 int hfsplus_cat_build_key(struct super_block *sb, hfsplus_btree_key *key,
453 u32 parent, const struct qstr *str);
454 void hfsplus_cat_build_key_with_cnid(struct super_block *sb,
455 hfsplus_btree_key *key, u32 parent);
456 void hfsplus_cat_set_perms(struct inode *inode, struct hfsplus_perm *perms);
457 int hfsplus_find_cat(struct super_block *sb, u32 cnid,
458 struct hfs_find_data *fd);
459 int hfsplus_create_cat(u32 cnid, struct inode *dir, const struct qstr *str,
460 struct inode *inode);
461 int hfsplus_delete_cat(u32 cnid, struct inode *dir, const struct qstr *str);
462 int hfsplus_rename_cat(u32 cnid, struct inode *src_dir, const struct qstr *src_name,
463 struct inode *dst_dir, const struct qstr *dst_name);
466 extern const struct inode_operations hfsplus_dir_inode_operations;
467 extern const struct file_operations hfsplus_dir_operations;
470 int hfsplus_ext_cmp_key(const hfsplus_btree_key *k1,
471 const hfsplus_btree_key *k2);
472 int hfsplus_ext_write_extent(struct inode *inode);
473 int hfsplus_get_block(struct inode *inode, sector_t iblock,
474 struct buffer_head *bh_result, int create);
475 int hfsplus_free_fork(struct super_block *sb, u32 cnid,
476 struct hfsplus_fork_raw *fork, int type);
477 int hfsplus_file_extend(struct inode *inode, bool zeroout);
478 void hfsplus_file_truncate(struct inode *inode);
481 extern const struct address_space_operations hfsplus_aops;
482 extern const struct address_space_operations hfsplus_btree_aops;
483 extern const struct dentry_operations hfsplus_dentry_operations;
485 struct inode *hfsplus_new_inode(struct super_block *sb, umode_t mode);
486 void hfsplus_delete_inode(struct inode *inode);
487 void hfsplus_inode_read_fork(struct inode *inode,
488 struct hfsplus_fork_raw *fork);
489 void hfsplus_inode_write_fork(struct inode *inode,
490 struct hfsplus_fork_raw *fork);
491 int hfsplus_cat_read_inode(struct inode *inode, struct hfs_find_data *fd);
492 int hfsplus_cat_write_inode(struct inode *inode);
493 int hfsplus_file_fsync(struct file *file, loff_t start, loff_t end,
497 long hfsplus_ioctl(struct file *filp, unsigned int cmd, unsigned long arg);
500 void hfsplus_fill_defaults(struct hfsplus_sb_info *opts);
501 int hfsplus_parse_options_remount(char *input, int *force);
502 int hfsplus_parse_options(char *input, struct hfsplus_sb_info *sbi);
503 int hfsplus_show_options(struct seq_file *seq, struct dentry *root);
506 int hfs_part_find(struct super_block *sb, sector_t *part_start,
507 sector_t *part_size);
510 struct inode *hfsplus_iget(struct super_block *sb, unsigned long ino);
511 void hfsplus_mark_mdb_dirty(struct super_block *sb);
514 extern u16 hfsplus_case_fold_table[];
515 extern u16 hfsplus_decompose_table[];
516 extern u16 hfsplus_compose_table[];
519 int hfsplus_strcasecmp(const struct hfsplus_unistr *s1,
520 const struct hfsplus_unistr *s2);
521 int hfsplus_strcmp(const struct hfsplus_unistr *s1,
522 const struct hfsplus_unistr *s2);
523 int hfsplus_uni2asc(struct super_block *sb, const struct hfsplus_unistr *ustr,
524 char *astr, int *len_p);
525 int hfsplus_asc2uni(struct super_block *sb, struct hfsplus_unistr *ustr,
526 int max_unistr_len, const char *astr, int len);
527 int hfsplus_hash_dentry(const struct dentry *dentry, struct qstr *str);
528 int hfsplus_compare_dentry(const struct dentry *dentry, unsigned int len,
529 const char *str, const struct qstr *name);
532 int hfsplus_submit_bio(struct super_block *sb, sector_t sector, void *buf,
533 void **data, int op, int op_flags);
534 int hfsplus_read_wrapper(struct super_block *sb);
537 #define __hfsp_mt2ut(t) (be32_to_cpu(t) - 2082844800U)
538 #define __hfsp_ut2mt(t) (cpu_to_be32(t + 2082844800U))
541 #define hfsp_mt2ut(t) (struct timespec){ .tv_sec = __hfsp_mt2ut(t) }
542 #define hfsp_ut2mt(t) __hfsp_ut2mt((t).tv_sec)
543 #define hfsp_now2mt() __hfsp_ut2mt(get_seconds())