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
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)
42 #define hfs_dbg(flg, fmt, ...) \
44 if (DBG_##flg & DBG_MASK) \
45 printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__); \
48 #define hfs_dbg_cont(flg, fmt, ...) \
50 if (DBG_##flg & DBG_MASK) \
51 pr_cont(fmt, ##__VA_ARGS__); \
54 /* Runtime config options */
55 #define HFSPLUS_DEF_CR_TYPE 0x3F3F3F3F /* '????' */
57 #define HFSPLUS_TYPE_DATA 0x00
58 #define HFSPLUS_TYPE_RSRC 0xFF
60 typedef int (*btree_keycmp
)(const hfsplus_btree_key
*,
61 const hfsplus_btree_key
*);
63 #define NODE_HASH_SIZE 256
65 /* B-tree mutex nested subclasses */
66 enum hfsplus_btree_mutex_classes
{
72 /* An HFS+ BTree held in memory */
74 struct super_block
*sb
;
87 unsigned int node_size
;
88 unsigned int node_size_shift
;
89 unsigned int max_key_len
;
92 struct mutex tree_lock
;
94 unsigned int pages_per_bnode
;
96 struct hfs_bnode
*node_hash
[NODE_HASH_SIZE
];
102 /* An HFS+ BTree node in memory */
104 struct hfs_btree
*tree
;
115 struct hfs_bnode
*next_hash
;
117 wait_queue_head_t lock_wq
;
119 unsigned int page_offset
;
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
130 * Attributes file states
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
138 * HFS+ superblock info (built from Volume Header on disk)
144 struct hfsplus_sb_info
{
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
;
157 /* Runtime variables */
163 /* immutable data from the volume header */
165 int alloc_blksz_shift
;
167 u32 data_clump_blocks
, rsrc_clump_blocks
;
169 /* mutable data from the volume header, protected by alloc_mutex */
171 struct mutex alloc_mutex
;
173 /* mutable data from the volume header, protected by vh_mutex */
177 struct mutex vh_mutex
;
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 */
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 * hfs+-specific ioctl for making the filesystem bootable
353 #define HFSPLUS_IOC_BLESS _IO('h', 0x80)
355 typedef int (*search_strategy_t
)(struct hfs_bnode
*,
356 struct hfs_find_data
*,
357 int *, int *, int *);
360 * Functions in any *.c used in other files
364 int __init
hfsplus_create_attr_tree_cache(void);
365 void hfsplus_destroy_attr_tree_cache(void);
366 int hfsplus_attr_bin_cmp_key(const hfsplus_btree_key
*k1
,
367 const hfsplus_btree_key
*k2
);
368 int hfsplus_attr_build_key(struct super_block
*sb
, hfsplus_btree_key
*key
,
369 u32 cnid
, const char *name
);
370 hfsplus_attr_entry
*hfsplus_alloc_attr_entry(void);
371 void hfsplus_destroy_attr_entry(hfsplus_attr_entry
*entry
);
372 int hfsplus_find_attr(struct super_block
*sb
, u32 cnid
, const char *name
,
373 struct hfs_find_data
*fd
);
374 int hfsplus_attr_exists(struct inode
*inode
, const char *name
);
375 int hfsplus_create_attr(struct inode
*inode
, const char *name
,
376 const void *value
, size_t size
);
377 int hfsplus_delete_attr(struct inode
*inode
, const char *name
);
378 int hfsplus_delete_all_attrs(struct inode
*dir
, u32 cnid
);
381 int hfsplus_block_allocate(struct super_block
*sb
, u32 size
, u32 offset
,
383 int hfsplus_block_free(struct super_block
*sb
, u32 offset
, u32 count
);
386 u32
hfsplus_calc_btree_clump_size(u32 block_size
, u32 node_size
, u64 sectors
,
388 struct hfs_btree
*hfs_btree_open(struct super_block
*sb
, u32 id
);
389 void hfs_btree_close(struct hfs_btree
*tree
);
390 int hfs_btree_write(struct hfs_btree
*tree
);
391 int hfs_bmap_reserve(struct hfs_btree
*tree
, int rsvd_nodes
);
392 struct hfs_bnode
*hfs_bmap_alloc(struct hfs_btree
*tree
);
393 void hfs_bmap_free(struct hfs_bnode
*node
);
396 void hfs_bnode_read(struct hfs_bnode
*node
, void *buf
, int off
, int len
);
397 u16
hfs_bnode_read_u16(struct hfs_bnode
*node
, int off
);
398 u8
hfs_bnode_read_u8(struct hfs_bnode
*node
, int off
);
399 void hfs_bnode_read_key(struct hfs_bnode
*node
, void *key
, int off
);
400 void hfs_bnode_write(struct hfs_bnode
*node
, void *buf
, int off
, int len
);
401 void hfs_bnode_write_u16(struct hfs_bnode
*node
, int off
, u16 data
);
402 void hfs_bnode_clear(struct hfs_bnode
*node
, int off
, int len
);
403 void hfs_bnode_copy(struct hfs_bnode
*dst_node
, int dst
,
404 struct hfs_bnode
*src_node
, int src
, int len
);
405 void hfs_bnode_move(struct hfs_bnode
*node
, int dst
, int src
, int len
);
406 void hfs_bnode_dump(struct hfs_bnode
*node
);
407 void hfs_bnode_unlink(struct hfs_bnode
*node
);
408 struct hfs_bnode
*hfs_bnode_findhash(struct hfs_btree
*tree
, u32 cnid
);
409 void hfs_bnode_unhash(struct hfs_bnode
*node
);
410 struct hfs_bnode
*hfs_bnode_find(struct hfs_btree
*tree
, u32 num
);
411 void hfs_bnode_free(struct hfs_bnode
*node
);
412 struct hfs_bnode
*hfs_bnode_create(struct hfs_btree
*tree
, u32 num
);
413 void hfs_bnode_get(struct hfs_bnode
*node
);
414 void hfs_bnode_put(struct hfs_bnode
*node
);
415 bool hfs_bnode_need_zeroout(struct hfs_btree
*tree
);
418 u16
hfs_brec_lenoff(struct hfs_bnode
*node
, u16 rec
, u16
*off
);
419 u16
hfs_brec_keylen(struct hfs_bnode
*node
, u16 rec
);
420 int hfs_brec_insert(struct hfs_find_data
*fd
, void *entry
, int entry_len
);
421 int hfs_brec_remove(struct hfs_find_data
*fd
);
424 int hfs_find_init(struct hfs_btree
*tree
, struct hfs_find_data
*fd
);
425 void hfs_find_exit(struct hfs_find_data
*fd
);
426 int hfs_find_1st_rec_by_cnid(struct hfs_bnode
*bnode
, struct hfs_find_data
*fd
,
427 int *begin
, int *end
, int *cur_rec
);
428 int hfs_find_rec_by_key(struct hfs_bnode
*bnode
, struct hfs_find_data
*fd
,
429 int *begin
, int *end
, int *cur_rec
);
430 int __hfs_brec_find(struct hfs_bnode
*bnode
, struct hfs_find_data
*fd
,
431 search_strategy_t rec_found
);
432 int hfs_brec_find(struct hfs_find_data
*fd
, search_strategy_t do_key_compare
);
433 int hfs_brec_read(struct hfs_find_data
*fd
, void *rec
, int rec_len
);
434 int hfs_brec_goto(struct hfs_find_data
*fd
, int cnt
);
437 int hfsplus_cat_case_cmp_key(const hfsplus_btree_key
*k1
,
438 const hfsplus_btree_key
*k2
);
439 int hfsplus_cat_bin_cmp_key(const hfsplus_btree_key
*k1
,
440 const hfsplus_btree_key
*k2
);
441 int hfsplus_cat_build_key(struct super_block
*sb
, hfsplus_btree_key
*key
,
442 u32 parent
, const struct qstr
*str
);
443 void hfsplus_cat_build_key_with_cnid(struct super_block
*sb
,
444 hfsplus_btree_key
*key
, u32 parent
);
445 void hfsplus_cat_set_perms(struct inode
*inode
, struct hfsplus_perm
*perms
);
446 int hfsplus_find_cat(struct super_block
*sb
, u32 cnid
,
447 struct hfs_find_data
*fd
);
448 int hfsplus_create_cat(u32 cnid
, struct inode
*dir
, const struct qstr
*str
,
449 struct inode
*inode
);
450 int hfsplus_delete_cat(u32 cnid
, struct inode
*dir
, const struct qstr
*str
);
451 int hfsplus_rename_cat(u32 cnid
, struct inode
*src_dir
, const struct qstr
*src_name
,
452 struct inode
*dst_dir
, const struct qstr
*dst_name
);
455 extern const struct inode_operations hfsplus_dir_inode_operations
;
456 extern const struct file_operations hfsplus_dir_operations
;
459 int hfsplus_ext_cmp_key(const hfsplus_btree_key
*k1
,
460 const hfsplus_btree_key
*k2
);
461 int hfsplus_ext_write_extent(struct inode
*inode
);
462 int hfsplus_get_block(struct inode
*inode
, sector_t iblock
,
463 struct buffer_head
*bh_result
, int create
);
464 int hfsplus_free_fork(struct super_block
*sb
, u32 cnid
,
465 struct hfsplus_fork_raw
*fork
, int type
);
466 int hfsplus_file_extend(struct inode
*inode
, bool zeroout
);
467 void hfsplus_file_truncate(struct inode
*inode
);
470 extern const struct address_space_operations hfsplus_aops
;
471 extern const struct address_space_operations hfsplus_btree_aops
;
472 extern const struct dentry_operations hfsplus_dentry_operations
;
474 int hfsplus_write_begin(struct file
*file
, struct address_space
*mapping
,
475 loff_t pos
, unsigned len
, struct folio
**foliop
, void **fsdata
);
476 struct inode
*hfsplus_new_inode(struct super_block
*sb
, struct inode
*dir
,
478 void hfsplus_delete_inode(struct inode
*inode
);
479 void hfsplus_inode_read_fork(struct inode
*inode
,
480 struct hfsplus_fork_raw
*fork
);
481 void hfsplus_inode_write_fork(struct inode
*inode
,
482 struct hfsplus_fork_raw
*fork
);
483 int hfsplus_cat_read_inode(struct inode
*inode
, struct hfs_find_data
*fd
);
484 int hfsplus_cat_write_inode(struct inode
*inode
);
485 int hfsplus_getattr(struct mnt_idmap
*idmap
, const struct path
*path
,
486 struct kstat
*stat
, u32 request_mask
,
487 unsigned int query_flags
);
488 int hfsplus_file_fsync(struct file
*file
, loff_t start
, loff_t end
,
490 int hfsplus_fileattr_get(struct dentry
*dentry
, struct fileattr
*fa
);
491 int hfsplus_fileattr_set(struct mnt_idmap
*idmap
,
492 struct dentry
*dentry
, struct fileattr
*fa
);
495 long hfsplus_ioctl(struct file
*filp
, unsigned int cmd
, unsigned long arg
);
498 void hfsplus_fill_defaults(struct hfsplus_sb_info
*opts
);
499 int hfsplus_parse_options_remount(char *input
, int *force
);
500 int hfsplus_parse_options(char *input
, struct hfsplus_sb_info
*sbi
);
501 int hfsplus_show_options(struct seq_file
*seq
, struct dentry
*root
);
504 int hfs_part_find(struct super_block
*sb
, sector_t
*part_start
,
505 sector_t
*part_size
);
508 struct inode
*hfsplus_iget(struct super_block
*sb
, unsigned long ino
);
509 void hfsplus_mark_mdb_dirty(struct super_block
*sb
);
512 extern u16 hfsplus_case_fold_table
[];
513 extern u16 hfsplus_decompose_table
[];
514 extern u16 hfsplus_compose_table
[];
517 int hfsplus_strcasecmp(const struct hfsplus_unistr
*s1
,
518 const struct hfsplus_unistr
*s2
);
519 int hfsplus_strcmp(const struct hfsplus_unistr
*s1
,
520 const struct hfsplus_unistr
*s2
);
521 int hfsplus_uni2asc(struct super_block
*sb
, const struct hfsplus_unistr
*ustr
,
522 char *astr
, int *len_p
);
523 int hfsplus_asc2uni(struct super_block
*sb
, struct hfsplus_unistr
*ustr
,
524 int max_unistr_len
, const char *astr
, int len
);
525 int hfsplus_hash_dentry(const struct dentry
*dentry
, struct qstr
*str
);
526 int hfsplus_compare_dentry(const struct dentry
*dentry
, unsigned int len
,
527 const char *str
, const struct qstr
*name
);
530 int hfsplus_submit_bio(struct super_block
*sb
, sector_t sector
, void *buf
,
531 void **data
, blk_opf_t opf
);
532 int hfsplus_read_wrapper(struct super_block
*sb
);
535 * time helpers: convert between 1904-base and 1970-base timestamps
537 * HFS+ implementations are highly inconsistent, this one matches the
538 * traditional behavior of 64-bit Linux, giving the most useful
539 * time range between 1970 and 2106, by treating any on-disk timestamp
540 * under HFSPLUS_UTC_OFFSET (Jan 1 1970) as a time between 2040 and 2106.
542 #define HFSPLUS_UTC_OFFSET 2082844800U
544 static inline time64_t
__hfsp_mt2ut(__be32 mt
)
546 time64_t ut
= (u32
)(be32_to_cpu(mt
) - HFSPLUS_UTC_OFFSET
);
551 static inline __be32
__hfsp_ut2mt(time64_t ut
)
553 return cpu_to_be32(lower_32_bits(ut
) + HFSPLUS_UTC_OFFSET
);
556 static inline enum hfsplus_btree_mutex_classes
557 hfsplus_btree_lock_class(struct hfs_btree
*tree
)
559 enum hfsplus_btree_mutex_classes
class;
561 switch (tree
->cnid
) {
562 case HFSPLUS_CAT_CNID
:
563 class = CATALOG_BTREE_MUTEX
;
565 case HFSPLUS_EXT_CNID
:
566 class = EXTENTS_BTREE_MUTEX
;
568 case HFSPLUS_ATTR_CNID
:
569 class = ATTR_BTREE_MUTEX
;
578 #define hfsp_mt2ut(t) (struct timespec64){ .tv_sec = __hfsp_mt2ut(t) }
579 #define hfsp_ut2mt(t) __hfsp_ut2mt((t).tv_sec)
580 #define hfsp_now2mt() __hfsp_ut2mt(ktime_get_real_seconds())