Loading...
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 struct rcu_head rcu;
194};
195
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
204
205static inline struct hfsplus_sb_info *HFSPLUS_SB(struct super_block *sb)
206{
207 return sb->s_fs_info;
208}
209
210
211struct hfsplus_inode_info {
212 atomic_t opencnt;
213
214 /*
215 * Extent allocation information, protected by extents_lock.
216 */
217 u32 first_blocks;
218 u32 clump_blocks;
219 u32 alloc_blocks;
220 u32 cached_start;
221 u32 cached_blocks;
222 hfsplus_extent_rec first_extents;
223 hfsplus_extent_rec cached_extents;
224 unsigned int extent_state;
225 struct mutex extents_lock;
226
227 /*
228 * Immutable data.
229 */
230 struct inode *rsrc_inode;
231 __be32 create_date;
232
233 /*
234 * Protected by sbi->vh_mutex.
235 */
236 u32 linkid;
237
238 /*
239 * Accessed using atomic bitops.
240 */
241 unsigned long flags;
242
243 /*
244 * Protected by i_mutex.
245 */
246 sector_t fs_blocks;
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;
251 loff_t phys_size;
252
253 struct inode vfs_inode;
254};
255
256#define HFSPLUS_EXT_DIRTY 0x0001
257#define HFSPLUS_EXT_NEW 0x0002
258
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 */
264
265#define HFSPLUS_IS_RSRC(inode) \
266 test_bit(HFSPLUS_I_RSRC, &HFSPLUS_I(inode)->flags)
267
268static inline struct hfsplus_inode_info *HFSPLUS_I(struct inode *inode)
269{
270 return container_of(inode, struct hfsplus_inode_info, vfs_inode);
271}
272
273/*
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.
278 */
279static inline void hfsplus_mark_inode_dirty(struct inode *inode,
280 unsigned int flag)
281{
282 set_bit(flag, &HFSPLUS_I(inode)->flags);
283 mark_inode_dirty(inode);
284}
285
286struct hfs_find_data {
287 /* filled by caller */
288 hfsplus_btree_key *search_key;
289 hfsplus_btree_key *key;
290 /* filled by find */
291 struct hfs_btree *tree;
292 struct hfs_bnode *bnode;
293 /* filled by findrec */
294 int record;
295 int keyoffset, keylength;
296 int entryoffset, entrylength;
297};
298
299struct hfsplus_readdir_data {
300 struct list_head list;
301 struct file *file;
302 struct hfsplus_cat_key key;
303};
304
305/*
306 * Find minimum acceptible I/O size for an hfsplus sb.
307 */
308static inline unsigned short hfsplus_min_io_size(struct super_block *sb)
309{
310 return max_t(unsigned short, bdev_logical_block_size(sb->s_bdev),
311 HFSPLUS_SECTOR_SIZE);
312}
313
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
349
350/*
351 * hfs+-specific ioctl for making the filesystem bootable
352 */
353#define HFSPLUS_IOC_BLESS _IO('h', 0x80)
354
355typedef int (*search_strategy_t)(struct hfs_bnode *,
356 struct hfs_find_data *,
357 int *, int *, int *);
358
359/*
360 * Functions in any *.c used in other files
361 */
362
363/* attributes.c */
364int __init hfsplus_create_attr_tree_cache(void);
365void hfsplus_destroy_attr_tree_cache(void);
366int hfsplus_attr_bin_cmp_key(const hfsplus_btree_key *k1,
367 const hfsplus_btree_key *k2);
368int hfsplus_attr_build_key(struct super_block *sb, hfsplus_btree_key *key,
369 u32 cnid, const char *name);
370hfsplus_attr_entry *hfsplus_alloc_attr_entry(void);
371void hfsplus_destroy_attr_entry(hfsplus_attr_entry *entry);
372int hfsplus_find_attr(struct super_block *sb, u32 cnid, const char *name,
373 struct hfs_find_data *fd);
374int hfsplus_attr_exists(struct inode *inode, const char *name);
375int hfsplus_create_attr(struct inode *inode, const char *name,
376 const void *value, size_t size);
377int hfsplus_delete_attr(struct inode *inode, const char *name);
378int hfsplus_delete_all_attrs(struct inode *dir, u32 cnid);
379
380/* bitmap.c */
381int hfsplus_block_allocate(struct super_block *sb, u32 size, u32 offset,
382 u32 *max);
383int hfsplus_block_free(struct super_block *sb, u32 offset, u32 count);
384
385/* btree.c */
386u32 hfsplus_calc_btree_clump_size(u32 block_size, u32 node_size, u64 sectors,
387 int file_id);
388struct hfs_btree *hfs_btree_open(struct super_block *sb, u32 id);
389void hfs_btree_close(struct hfs_btree *tree);
390int hfs_btree_write(struct hfs_btree *tree);
391int hfs_bmap_reserve(struct hfs_btree *tree, int rsvd_nodes);
392struct hfs_bnode *hfs_bmap_alloc(struct hfs_btree *tree);
393void hfs_bmap_free(struct hfs_bnode *node);
394
395/* bnode.c */
396void hfs_bnode_read(struct hfs_bnode *node, void *buf, int off, int len);
397u16 hfs_bnode_read_u16(struct hfs_bnode *node, int off);
398u8 hfs_bnode_read_u8(struct hfs_bnode *node, int off);
399void hfs_bnode_read_key(struct hfs_bnode *node, void *key, int off);
400void hfs_bnode_write(struct hfs_bnode *node, void *buf, int off, int len);
401void hfs_bnode_write_u16(struct hfs_bnode *node, int off, u16 data);
402void hfs_bnode_clear(struct hfs_bnode *node, int off, int len);
403void hfs_bnode_copy(struct hfs_bnode *dst_node, int dst,
404 struct hfs_bnode *src_node, int src, int len);
405void hfs_bnode_move(struct hfs_bnode *node, int dst, int src, int len);
406void hfs_bnode_dump(struct hfs_bnode *node);
407void hfs_bnode_unlink(struct hfs_bnode *node);
408struct hfs_bnode *hfs_bnode_findhash(struct hfs_btree *tree, u32 cnid);
409void hfs_bnode_unhash(struct hfs_bnode *node);
410struct hfs_bnode *hfs_bnode_find(struct hfs_btree *tree, u32 num);
411void hfs_bnode_free(struct hfs_bnode *node);
412struct hfs_bnode *hfs_bnode_create(struct hfs_btree *tree, u32 num);
413void hfs_bnode_get(struct hfs_bnode *node);
414void hfs_bnode_put(struct hfs_bnode *node);
415bool hfs_bnode_need_zeroout(struct hfs_btree *tree);
416
417/* brec.c */
418u16 hfs_brec_lenoff(struct hfs_bnode *node, u16 rec, u16 *off);
419u16 hfs_brec_keylen(struct hfs_bnode *node, u16 rec);
420int hfs_brec_insert(struct hfs_find_data *fd, void *entry, int entry_len);
421int hfs_brec_remove(struct hfs_find_data *fd);
422
423/* bfind.c */
424int hfs_find_init(struct hfs_btree *tree, struct hfs_find_data *fd);
425void hfs_find_exit(struct hfs_find_data *fd);
426int hfs_find_1st_rec_by_cnid(struct hfs_bnode *bnode, struct hfs_find_data *fd,
427 int *begin, int *end, int *cur_rec);
428int hfs_find_rec_by_key(struct hfs_bnode *bnode, struct hfs_find_data *fd,
429 int *begin, int *end, int *cur_rec);
430int __hfs_brec_find(struct hfs_bnode *bnode, struct hfs_find_data *fd,
431 search_strategy_t rec_found);
432int hfs_brec_find(struct hfs_find_data *fd, search_strategy_t do_key_compare);
433int hfs_brec_read(struct hfs_find_data *fd, void *rec, int rec_len);
434int hfs_brec_goto(struct hfs_find_data *fd, int cnt);
435
436/* catalog.c */
437int hfsplus_cat_case_cmp_key(const hfsplus_btree_key *k1,
438 const hfsplus_btree_key *k2);
439int hfsplus_cat_bin_cmp_key(const hfsplus_btree_key *k1,
440 const hfsplus_btree_key *k2);
441int hfsplus_cat_build_key(struct super_block *sb, hfsplus_btree_key *key,
442 u32 parent, const struct qstr *str);
443void hfsplus_cat_build_key_with_cnid(struct super_block *sb,
444 hfsplus_btree_key *key, u32 parent);
445void hfsplus_cat_set_perms(struct inode *inode, struct hfsplus_perm *perms);
446int hfsplus_find_cat(struct super_block *sb, u32 cnid,
447 struct hfs_find_data *fd);
448int hfsplus_create_cat(u32 cnid, struct inode *dir, const struct qstr *str,
449 struct inode *inode);
450int hfsplus_delete_cat(u32 cnid, struct inode *dir, const struct qstr *str);
451int hfsplus_rename_cat(u32 cnid, struct inode *src_dir, const struct qstr *src_name,
452 struct inode *dst_dir, const struct qstr *dst_name);
453
454/* dir.c */
455extern const struct inode_operations hfsplus_dir_inode_operations;
456extern const struct file_operations hfsplus_dir_operations;
457
458/* extents.c */
459int hfsplus_ext_cmp_key(const hfsplus_btree_key *k1,
460 const hfsplus_btree_key *k2);
461int hfsplus_ext_write_extent(struct inode *inode);
462int hfsplus_get_block(struct inode *inode, sector_t iblock,
463 struct buffer_head *bh_result, int create);
464int hfsplus_free_fork(struct super_block *sb, u32 cnid,
465 struct hfsplus_fork_raw *fork, int type);
466int hfsplus_file_extend(struct inode *inode, bool zeroout);
467void hfsplus_file_truncate(struct inode *inode);
468
469/* inode.c */
470extern const struct address_space_operations hfsplus_aops;
471extern const struct address_space_operations hfsplus_btree_aops;
472extern const struct dentry_operations hfsplus_dentry_operations;
473
474int hfsplus_write_begin(struct file *file, struct address_space *mapping,
475 loff_t pos, unsigned len, struct page **pagep, void **fsdata);
476struct inode *hfsplus_new_inode(struct super_block *sb, struct inode *dir,
477 umode_t mode);
478void hfsplus_delete_inode(struct inode *inode);
479void hfsplus_inode_read_fork(struct inode *inode,
480 struct hfsplus_fork_raw *fork);
481void hfsplus_inode_write_fork(struct inode *inode,
482 struct hfsplus_fork_raw *fork);
483int hfsplus_cat_read_inode(struct inode *inode, struct hfs_find_data *fd);
484int hfsplus_cat_write_inode(struct inode *inode);
485int hfsplus_getattr(struct mnt_idmap *idmap, const struct path *path,
486 struct kstat *stat, u32 request_mask,
487 unsigned int query_flags);
488int hfsplus_file_fsync(struct file *file, loff_t start, loff_t end,
489 int datasync);
490int hfsplus_fileattr_get(struct dentry *dentry, struct fileattr *fa);
491int hfsplus_fileattr_set(struct mnt_idmap *idmap,
492 struct dentry *dentry, struct fileattr *fa);
493
494/* ioctl.c */
495long hfsplus_ioctl(struct file *filp, unsigned int cmd, unsigned long arg);
496
497/* options.c */
498void hfsplus_fill_defaults(struct hfsplus_sb_info *opts);
499int hfsplus_parse_options_remount(char *input, int *force);
500int hfsplus_parse_options(char *input, struct hfsplus_sb_info *sbi);
501int hfsplus_show_options(struct seq_file *seq, struct dentry *root);
502
503/* part_tbl.c */
504int hfs_part_find(struct super_block *sb, sector_t *part_start,
505 sector_t *part_size);
506
507/* super.c */
508struct inode *hfsplus_iget(struct super_block *sb, unsigned long ino);
509void hfsplus_mark_mdb_dirty(struct super_block *sb);
510
511/* tables.c */
512extern u16 hfsplus_case_fold_table[];
513extern u16 hfsplus_decompose_table[];
514extern u16 hfsplus_compose_table[];
515
516/* unicode.c */
517int hfsplus_strcasecmp(const struct hfsplus_unistr *s1,
518 const struct hfsplus_unistr *s2);
519int hfsplus_strcmp(const struct hfsplus_unistr *s1,
520 const struct hfsplus_unistr *s2);
521int hfsplus_uni2asc(struct super_block *sb, const struct hfsplus_unistr *ustr,
522 char *astr, int *len_p);
523int hfsplus_asc2uni(struct super_block *sb, struct hfsplus_unistr *ustr,
524 int max_unistr_len, const char *astr, int len);
525int hfsplus_hash_dentry(const struct dentry *dentry, struct qstr *str);
526int hfsplus_compare_dentry(const struct dentry *dentry, unsigned int len,
527 const char *str, const struct qstr *name);
528
529/* wrapper.c */
530int hfsplus_submit_bio(struct super_block *sb, sector_t sector, void *buf,
531 void **data, blk_opf_t opf);
532int hfsplus_read_wrapper(struct super_block *sb);
533
534/*
535 * time helpers: convert between 1904-base and 1970-base timestamps
536 *
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.
541 */
542#define HFSPLUS_UTC_OFFSET 2082844800U
543
544static inline time64_t __hfsp_mt2ut(__be32 mt)
545{
546 time64_t ut = (u32)(be32_to_cpu(mt) - HFSPLUS_UTC_OFFSET);
547
548 return ut;
549}
550
551static inline __be32 __hfsp_ut2mt(time64_t ut)
552{
553 return cpu_to_be32(lower_32_bits(ut) + HFSPLUS_UTC_OFFSET);
554}
555
556/* compatibility */
557#define hfsp_mt2ut(t) (struct timespec64){ .tv_sec = __hfsp_mt2ut(t) }
558#define hfsp_ut2mt(t) __hfsp_ut2mt((t).tv_sec)
559#define hfsp_now2mt() __hfsp_ut2mt(ktime_get_real_seconds())
560
561#endif
1/*
2 * linux/include/linux/hfsplus_fs.h
3 *
4 * Copyright (C) 1999
5 * Brad Boyer (flar@pants.nu)
6 * (C) 2003 Ardis Technologies <roman@ardistech.com>
7 *
8 */
9
10#ifndef _LINUX_HFSPLUS_FS_H
11#define _LINUX_HFSPLUS_FS_H
12
13#ifdef pr_fmt
14#undef pr_fmt
15#endif
16
17#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
18
19#include <linux/fs.h>
20#include <linux/mutex.h>
21#include <linux/buffer_head.h>
22#include <linux/blkdev.h>
23#include "hfsplus_raw.h"
24
25#define DBG_BNODE_REFS 0x00000001
26#define DBG_BNODE_MOD 0x00000002
27#define DBG_CAT_MOD 0x00000004
28#define DBG_INODE 0x00000008
29#define DBG_SUPER 0x00000010
30#define DBG_EXTENT 0x00000020
31#define DBG_BITMAP 0x00000040
32#define DBG_ATTR_MOD 0x00000080
33#define DBG_ACL_MOD 0x00000100
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[0];
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
202static inline struct hfsplus_sb_info *HFSPLUS_SB(struct super_block *sb)
203{
204 return sb->s_fs_info;
205}
206
207
208struct hfsplus_inode_info {
209 atomic_t opencnt;
210
211 /*
212 * Extent allocation information, protected by extents_lock.
213 */
214 u32 first_blocks;
215 u32 clump_blocks;
216 u32 alloc_blocks;
217 u32 cached_start;
218 u32 cached_blocks;
219 hfsplus_extent_rec first_extents;
220 hfsplus_extent_rec cached_extents;
221 unsigned int extent_state;
222 struct mutex extents_lock;
223
224 /*
225 * Immutable data.
226 */
227 struct inode *rsrc_inode;
228 __be32 create_date;
229
230 /*
231 * Protected by sbi->vh_mutex.
232 */
233 u32 linkid;
234
235 /*
236 * Accessed using atomic bitops.
237 */
238 unsigned long flags;
239
240 /*
241 * Protected by i_mutex.
242 */
243 sector_t fs_blocks;
244 u8 userflags; /* BSD user file flags */
245 u32 subfolders; /* Subfolder count (HFSX only) */
246 struct list_head open_dir_list;
247 loff_t phys_size;
248
249 struct inode vfs_inode;
250};
251
252#define HFSPLUS_EXT_DIRTY 0x0001
253#define HFSPLUS_EXT_NEW 0x0002
254
255#define HFSPLUS_I_RSRC 0 /* represents a resource fork */
256#define HFSPLUS_I_CAT_DIRTY 1 /* has changes in the catalog tree */
257#define HFSPLUS_I_EXT_DIRTY 2 /* has changes in the extent tree */
258#define HFSPLUS_I_ALLOC_DIRTY 3 /* has changes in the allocation file */
259#define HFSPLUS_I_ATTR_DIRTY 4 /* has changes in the attributes tree */
260
261#define HFSPLUS_IS_RSRC(inode) \
262 test_bit(HFSPLUS_I_RSRC, &HFSPLUS_I(inode)->flags)
263
264static inline struct hfsplus_inode_info *HFSPLUS_I(struct inode *inode)
265{
266 return list_entry(inode, struct hfsplus_inode_info, vfs_inode);
267}
268
269/*
270 * Mark an inode dirty, and also mark the btree in which the
271 * specific type of metadata is stored.
272 * For data or metadata that gets written back by into the catalog btree
273 * by hfsplus_write_inode a plain mark_inode_dirty call is enough.
274 */
275static inline void hfsplus_mark_inode_dirty(struct inode *inode,
276 unsigned int flag)
277{
278 set_bit(flag, &HFSPLUS_I(inode)->flags);
279 mark_inode_dirty(inode);
280}
281
282struct hfs_find_data {
283 /* filled by caller */
284 hfsplus_btree_key *search_key;
285 hfsplus_btree_key *key;
286 /* filled by find */
287 struct hfs_btree *tree;
288 struct hfs_bnode *bnode;
289 /* filled by findrec */
290 int record;
291 int keyoffset, keylength;
292 int entryoffset, entrylength;
293};
294
295struct hfsplus_readdir_data {
296 struct list_head list;
297 struct file *file;
298 struct hfsplus_cat_key key;
299};
300
301/*
302 * Find minimum acceptible I/O size for an hfsplus sb.
303 */
304static inline unsigned short hfsplus_min_io_size(struct super_block *sb)
305{
306 return max_t(unsigned short, bdev_logical_block_size(sb->s_bdev),
307 HFSPLUS_SECTOR_SIZE);
308}
309
310#define hfs_btree_open hfsplus_btree_open
311#define hfs_btree_close hfsplus_btree_close
312#define hfs_btree_write hfsplus_btree_write
313#define hfs_bmap_alloc hfsplus_bmap_alloc
314#define hfs_bmap_free hfsplus_bmap_free
315#define hfs_bnode_read hfsplus_bnode_read
316#define hfs_bnode_read_u16 hfsplus_bnode_read_u16
317#define hfs_bnode_read_u8 hfsplus_bnode_read_u8
318#define hfs_bnode_read_key hfsplus_bnode_read_key
319#define hfs_bnode_write hfsplus_bnode_write
320#define hfs_bnode_write_u16 hfsplus_bnode_write_u16
321#define hfs_bnode_clear hfsplus_bnode_clear
322#define hfs_bnode_copy hfsplus_bnode_copy
323#define hfs_bnode_move hfsplus_bnode_move
324#define hfs_bnode_dump hfsplus_bnode_dump
325#define hfs_bnode_unlink hfsplus_bnode_unlink
326#define hfs_bnode_findhash hfsplus_bnode_findhash
327#define hfs_bnode_find hfsplus_bnode_find
328#define hfs_bnode_unhash hfsplus_bnode_unhash
329#define hfs_bnode_free hfsplus_bnode_free
330#define hfs_bnode_create hfsplus_bnode_create
331#define hfs_bnode_get hfsplus_bnode_get
332#define hfs_bnode_put hfsplus_bnode_put
333#define hfs_brec_lenoff hfsplus_brec_lenoff
334#define hfs_brec_keylen hfsplus_brec_keylen
335#define hfs_brec_insert hfsplus_brec_insert
336#define hfs_brec_remove hfsplus_brec_remove
337#define hfs_find_init hfsplus_find_init
338#define hfs_find_exit hfsplus_find_exit
339#define __hfs_brec_find __hfsplus_brec_find
340#define hfs_brec_find hfsplus_brec_find
341#define hfs_brec_read hfsplus_brec_read
342#define hfs_brec_goto hfsplus_brec_goto
343#define hfs_part_find hfsplus_part_find
344
345/*
346 * definitions for ext2 flag ioctls (linux really needs a generic
347 * interface for this).
348 */
349
350/* ext2 ioctls (EXT2_IOC_GETFLAGS and EXT2_IOC_SETFLAGS) to support
351 * chattr/lsattr */
352#define HFSPLUS_IOC_EXT2_GETFLAGS FS_IOC_GETFLAGS
353#define HFSPLUS_IOC_EXT2_SETFLAGS FS_IOC_SETFLAGS
354
355
356/*
357 * hfs+-specific ioctl for making the filesystem bootable
358 */
359#define HFSPLUS_IOC_BLESS _IO('h', 0x80)
360
361typedef int (*search_strategy_t)(struct hfs_bnode *,
362 struct hfs_find_data *,
363 int *, int *, int *);
364
365/*
366 * Functions in any *.c used in other files
367 */
368
369/* attributes.c */
370int __init hfsplus_create_attr_tree_cache(void);
371void hfsplus_destroy_attr_tree_cache(void);
372hfsplus_attr_entry *hfsplus_alloc_attr_entry(void);
373void hfsplus_destroy_attr_entry(hfsplus_attr_entry *entry_p);
374int hfsplus_attr_bin_cmp_key(const hfsplus_btree_key *,
375 const hfsplus_btree_key *);
376int hfsplus_attr_build_key(struct super_block *, hfsplus_btree_key *,
377 u32, const char *);
378void hfsplus_attr_build_key_uni(hfsplus_btree_key *key,
379 u32 cnid,
380 struct hfsplus_attr_unistr *name);
381int hfsplus_find_attr(struct super_block *, u32,
382 const char *, struct hfs_find_data *);
383int hfsplus_attr_exists(struct inode *inode, const char *name);
384int hfsplus_create_attr(struct inode *, const char *, const void *, size_t);
385int hfsplus_delete_attr(struct inode *, const char *);
386int hfsplus_delete_all_attrs(struct inode *dir, u32 cnid);
387
388/* bitmap.c */
389int hfsplus_block_allocate(struct super_block *, u32, u32, u32 *);
390int hfsplus_block_free(struct super_block *, u32, u32);
391
392/* btree.c */
393u32 hfsplus_calc_btree_clump_size(u32, u32, u64, int);
394struct hfs_btree *hfs_btree_open(struct super_block *, u32);
395void hfs_btree_close(struct hfs_btree *);
396int hfs_btree_write(struct hfs_btree *);
397struct hfs_bnode *hfs_bmap_alloc(struct hfs_btree *);
398void hfs_bmap_free(struct hfs_bnode *);
399
400/* bnode.c */
401void hfs_bnode_read(struct hfs_bnode *, void *, int, int);
402u16 hfs_bnode_read_u16(struct hfs_bnode *, int);
403u8 hfs_bnode_read_u8(struct hfs_bnode *, int);
404void hfs_bnode_read_key(struct hfs_bnode *, void *, int);
405void hfs_bnode_write(struct hfs_bnode *, void *, int, int);
406void hfs_bnode_write_u16(struct hfs_bnode *, int, u16);
407void hfs_bnode_clear(struct hfs_bnode *, int, int);
408void hfs_bnode_copy(struct hfs_bnode *, int,
409 struct hfs_bnode *, int, int);
410void hfs_bnode_move(struct hfs_bnode *, int, int, int);
411void hfs_bnode_dump(struct hfs_bnode *);
412void hfs_bnode_unlink(struct hfs_bnode *);
413struct hfs_bnode *hfs_bnode_findhash(struct hfs_btree *, u32);
414struct hfs_bnode *hfs_bnode_find(struct hfs_btree *, u32);
415void hfs_bnode_unhash(struct hfs_bnode *);
416void hfs_bnode_free(struct hfs_bnode *);
417struct hfs_bnode *hfs_bnode_create(struct hfs_btree *, u32);
418void hfs_bnode_get(struct hfs_bnode *);
419void hfs_bnode_put(struct hfs_bnode *);
420
421/* brec.c */
422u16 hfs_brec_lenoff(struct hfs_bnode *, u16, u16 *);
423u16 hfs_brec_keylen(struct hfs_bnode *, u16);
424int hfs_brec_insert(struct hfs_find_data *, void *, int);
425int hfs_brec_remove(struct hfs_find_data *);
426
427/* bfind.c */
428int hfs_find_init(struct hfs_btree *, struct hfs_find_data *);
429void hfs_find_exit(struct hfs_find_data *);
430int hfs_find_1st_rec_by_cnid(struct hfs_bnode *,
431 struct hfs_find_data *,
432 int *, int *, int *);
433int hfs_find_rec_by_key(struct hfs_bnode *,
434 struct hfs_find_data *,
435 int *, int *, int *);
436int __hfs_brec_find(struct hfs_bnode *, struct hfs_find_data *,
437 search_strategy_t);
438int hfs_brec_find(struct hfs_find_data *, search_strategy_t);
439int hfs_brec_read(struct hfs_find_data *, void *, int);
440int hfs_brec_goto(struct hfs_find_data *, int);
441
442/* catalog.c */
443int hfsplus_cat_case_cmp_key(const hfsplus_btree_key *,
444 const hfsplus_btree_key *);
445int hfsplus_cat_bin_cmp_key(const hfsplus_btree_key *,
446 const hfsplus_btree_key *);
447void hfsplus_cat_build_key(struct super_block *sb,
448 hfsplus_btree_key *, u32, struct qstr *);
449int hfsplus_find_cat(struct super_block *, u32, struct hfs_find_data *);
450int hfsplus_create_cat(u32, struct inode *, struct qstr *, struct inode *);
451int hfsplus_delete_cat(u32, struct inode *, struct qstr *);
452int hfsplus_rename_cat(u32, struct inode *, struct qstr *,
453 struct inode *, struct qstr *);
454void hfsplus_cat_set_perms(struct inode *inode, struct hfsplus_perm *perms);
455
456/* dir.c */
457extern const struct inode_operations hfsplus_dir_inode_operations;
458extern const struct file_operations hfsplus_dir_operations;
459
460/* extents.c */
461int hfsplus_ext_cmp_key(const hfsplus_btree_key *, const hfsplus_btree_key *);
462int hfsplus_ext_write_extent(struct inode *);
463int hfsplus_get_block(struct inode *, sector_t, struct buffer_head *, int);
464int hfsplus_free_fork(struct super_block *, u32,
465 struct hfsplus_fork_raw *, int);
466int hfsplus_file_extend(struct inode *);
467void hfsplus_file_truncate(struct inode *);
468
469/* inode.c */
470extern const struct address_space_operations hfsplus_aops;
471extern const struct address_space_operations hfsplus_btree_aops;
472extern const struct dentry_operations hfsplus_dentry_operations;
473
474void hfsplus_inode_read_fork(struct inode *, struct hfsplus_fork_raw *);
475void hfsplus_inode_write_fork(struct inode *, struct hfsplus_fork_raw *);
476int hfsplus_cat_read_inode(struct inode *, struct hfs_find_data *);
477int hfsplus_cat_write_inode(struct inode *);
478struct inode *hfsplus_new_inode(struct super_block *, umode_t);
479void hfsplus_delete_inode(struct inode *);
480int hfsplus_file_fsync(struct file *file, loff_t start, loff_t end,
481 int datasync);
482
483/* ioctl.c */
484long hfsplus_ioctl(struct file *filp, unsigned int cmd, unsigned long arg);
485
486/* options.c */
487int hfsplus_parse_options(char *, struct hfsplus_sb_info *);
488int hfsplus_parse_options_remount(char *input, int *force);
489void hfsplus_fill_defaults(struct hfsplus_sb_info *);
490int hfsplus_show_options(struct seq_file *, struct dentry *);
491
492/* super.c */
493struct inode *hfsplus_iget(struct super_block *, unsigned long);
494void hfsplus_mark_mdb_dirty(struct super_block *sb);
495
496/* tables.c */
497extern u16 hfsplus_case_fold_table[];
498extern u16 hfsplus_decompose_table[];
499extern u16 hfsplus_compose_table[];
500
501/* unicode.c */
502int hfsplus_strcasecmp(const struct hfsplus_unistr *,
503 const struct hfsplus_unistr *);
504int hfsplus_strcmp(const struct hfsplus_unistr *,
505 const struct hfsplus_unistr *);
506int hfsplus_uni2asc(struct super_block *,
507 const struct hfsplus_unistr *, char *, int *);
508int hfsplus_asc2uni(struct super_block *,
509 struct hfsplus_unistr *, int, const char *, int);
510int hfsplus_hash_dentry(const struct dentry *dentry, struct qstr *str);
511int hfsplus_compare_dentry(const struct dentry *parent, const struct dentry *dentry,
512 unsigned int len, const char *str, const struct qstr *name);
513
514/* wrapper.c */
515int hfsplus_read_wrapper(struct super_block *);
516int hfs_part_find(struct super_block *, sector_t *, sector_t *);
517int hfsplus_submit_bio(struct super_block *sb, sector_t sector,
518 void *buf, void **data, int rw);
519
520/* time macros */
521#define __hfsp_mt2ut(t) (be32_to_cpu(t) - 2082844800U)
522#define __hfsp_ut2mt(t) (cpu_to_be32(t + 2082844800U))
523
524/* compatibility */
525#define hfsp_mt2ut(t) (struct timespec){ .tv_sec = __hfsp_mt2ut(t) }
526#define hfsp_ut2mt(t) __hfsp_ut2mt((t).tv_sec)
527#define hfsp_now2mt() __hfsp_ut2mt(get_seconds())
528
529#endif