blob: d6857523336d21412ec50bb0a8c8039526ab6adb [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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#include <linux/fs.h>
Matthias Kaehlcke895c23f2008-07-25 01:46:36 -070014#include <linux/mutex.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070015#include <linux/buffer_head.h>
16#include "hfsplus_raw.h"
17
18#define DBG_BNODE_REFS 0x00000001
19#define DBG_BNODE_MOD 0x00000002
20#define DBG_CAT_MOD 0x00000004
21#define DBG_INODE 0x00000008
22#define DBG_SUPER 0x00000010
23#define DBG_EXTENT 0x00000020
24#define DBG_BITMAP 0x00000040
25
Anton Salikhmetov21f22962010-12-16 18:08:39 +020026#if 0
27#define DBG_MASK (DBG_EXTENT|DBG_INODE|DBG_BNODE_MOD)
28#define DBG_MASK (DBG_BNODE_MOD|DBG_CAT_MOD|DBG_INODE)
29#define DBG_MASK (DBG_CAT_MOD|DBG_BNODE_REFS|DBG_INODE|DBG_EXTENT)
30#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -070031#define DBG_MASK (0)
32
33#define dprint(flg, fmt, args...) \
Anton Salikhmetovb2837fc2010-12-16 18:08:41 +020034 if (flg & DBG_MASK) \
35 printk(fmt , ## args)
Linus Torvalds1da177e2005-04-16 15:20:36 -070036
37/* Runtime config options */
38#define HFSPLUS_DEF_CR_TYPE 0x3F3F3F3F /* '????' */
39
40#define HFSPLUS_TYPE_DATA 0x00
41#define HFSPLUS_TYPE_RSRC 0xFF
42
Anton Salikhmetov2753cc22010-12-16 18:08:38 +020043typedef int (*btree_keycmp)(const hfsplus_btree_key *,
44 const hfsplus_btree_key *);
Linus Torvalds1da177e2005-04-16 15:20:36 -070045
46#define NODE_HASH_SIZE 256
47
48/* An HFS+ BTree held in memory */
49struct hfs_btree {
50 struct super_block *sb;
51 struct inode *inode;
52 btree_keycmp keycmp;
53
54 u32 cnid;
55 u32 root;
56 u32 leaf_count;
57 u32 leaf_head;
58 u32 leaf_tail;
59 u32 node_count;
60 u32 free_nodes;
61 u32 attributes;
62
63 unsigned int node_size;
64 unsigned int node_size_shift;
65 unsigned int max_key_len;
66 unsigned int depth;
67
Thomas Gleixner467c3d92010-10-01 05:46:52 +020068 struct mutex tree_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -070069
70 unsigned int pages_per_bnode;
71 spinlock_t hash_lock;
72 struct hfs_bnode *node_hash[NODE_HASH_SIZE];
73 int node_hash_cnt;
74};
75
76struct page;
77
78/* An HFS+ BTree node in memory */
79struct hfs_bnode {
80 struct hfs_btree *tree;
81
82 u32 prev;
83 u32 this;
84 u32 next;
85 u32 parent;
86
87 u16 num_recs;
88 u8 type;
89 u8 height;
90
91 struct hfs_bnode *next_hash;
92 unsigned long flags;
93 wait_queue_head_t lock_wq;
94 atomic_t refcnt;
95 unsigned int page_offset;
96 struct page *page[0];
97};
98
99#define HFS_BNODE_LOCK 0
100#define HFS_BNODE_ERROR 1
101#define HFS_BNODE_NEW 2
102#define HFS_BNODE_DIRTY 3
103#define HFS_BNODE_DELETED 4
104
105/*
106 * HFS+ superblock info (built from Volume Header on disk)
107 */
108
109struct hfsplus_vh;
110struct hfs_btree;
111
112struct hfsplus_sb_info {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113 struct hfsplus_vh *s_vhdr;
Christoph Hellwig52399b12010-11-23 14:37:47 +0100114 struct hfsplus_vh *s_backup_vhdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115 struct hfs_btree *ext_tree;
116 struct hfs_btree *cat_tree;
117 struct hfs_btree *attr_tree;
118 struct inode *alloc_file;
119 struct inode *hidden_dir;
120 struct nls_table *nls;
121
122 /* Runtime variables */
123 u32 blockoffset;
Christoph Hellwig52399b12010-11-23 14:37:47 +0100124 sector_t part_start;
125 sector_t sect_count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126 int fs_shift;
127
Christoph Hellwig7ac9fb92010-10-01 05:45:08 +0200128 /* immutable data from the volume header */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129 u32 alloc_blksz;
130 int alloc_blksz_shift;
131 u32 total_blocks;
Christoph Hellwig7ac9fb92010-10-01 05:45:08 +0200132 u32 data_clump_blocks, rsrc_clump_blocks;
133
134 /* mutable data from the volume header, protected by alloc_mutex */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135 u32 free_blocks;
Christoph Hellwig7ac9fb92010-10-01 05:45:08 +0200136 struct mutex alloc_mutex;
137
138 /* mutable data from the volume header, protected by vh_mutex */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139 u32 next_cnid;
140 u32 file_count;
141 u32 folder_count;
Christoph Hellwig7ac9fb92010-10-01 05:45:08 +0200142 struct mutex vh_mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143
144 /* Config options */
145 u32 creator;
146 u32 type;
147
148 umode_t umask;
149 uid_t uid;
150 gid_t gid;
151
152 int part, session;
153
154 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155};
156
Christoph Hellwig84adede2010-10-01 05:45:20 +0200157#define HFSPLUS_SB_WRITEBACKUP 0
158#define HFSPLUS_SB_NODECOMPOSE 1
159#define HFSPLUS_SB_FORCE 2
160#define HFSPLUS_SB_HFSX 3
161#define HFSPLUS_SB_CASEFOLD 4
Christoph Hellwig34a2d312010-11-23 14:38:21 +0100162#define HFSPLUS_SB_NOBARRIER 5
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163
Christoph Hellwige3494702010-11-23 14:38:15 +0100164static inline struct hfsplus_sb_info *HFSPLUS_SB(struct super_block *sb)
165{
166 return sb->s_fs_info;
167}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168
169
170struct hfsplus_inode_info {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171 atomic_t opencnt;
172
Christoph Hellwig7fcc99f2010-10-01 05:46:31 +0200173 /*
174 * Extent allocation information, protected by extents_lock.
175 */
176 u32 first_blocks;
177 u32 clump_blocks;
178 u32 alloc_blocks;
179 u32 cached_start;
180 u32 cached_blocks;
181 hfsplus_extent_rec first_extents;
182 hfsplus_extent_rec cached_extents;
Christoph Hellwigb33b7922010-11-23 14:38:13 +0100183 unsigned int extent_state;
Christoph Hellwig7fcc99f2010-10-01 05:46:31 +0200184 struct mutex extents_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185
Christoph Hellwig7fcc99f2010-10-01 05:46:31 +0200186 /*
187 * Immutable data.
188 */
189 struct inode *rsrc_inode;
Roman Zippel9a4cad92006-01-18 17:43:09 -0800190 __be32 create_date;
Christoph Hellwigf6089ff2010-10-14 09:54:28 -0400191
192 /*
193 * Protected by sbi->vh_mutex.
194 */
195 u32 linkid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196
Christoph Hellwig7fcc99f2010-10-01 05:46:31 +0200197 /*
Christoph Hellwigb33b7922010-11-23 14:38:13 +0100198 * Accessed using atomic bitops.
199 */
200 unsigned long flags;
201
202 /*
Christoph Hellwig7fcc99f2010-10-01 05:46:31 +0200203 * Protected by i_mutex.
204 */
205 sector_t fs_blocks;
Christoph Hellwig722c55d2010-10-14 09:54:33 -0400206 u8 userflags; /* BSD user file flags */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207 struct list_head open_dir_list;
208 loff_t phys_size;
Christoph Hellwig7fcc99f2010-10-01 05:46:31 +0200209
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210 struct inode vfs_inode;
211};
212
Christoph Hellwigb33b7922010-11-23 14:38:13 +0100213#define HFSPLUS_EXT_DIRTY 0x0001
214#define HFSPLUS_EXT_NEW 0x0002
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215
Christoph Hellwigb33b7922010-11-23 14:38:13 +0100216#define HFSPLUS_I_RSRC 0 /* represents a resource fork */
Christoph Hellwige3494702010-11-23 14:38:15 +0100217#define HFSPLUS_I_CAT_DIRTY 1 /* has changes in the catalog tree */
218#define HFSPLUS_I_EXT_DIRTY 2 /* has changes in the extent tree */
219#define HFSPLUS_I_ALLOC_DIRTY 3 /* has changes in the allocation file */
Christoph Hellwigb33b7922010-11-23 14:38:13 +0100220
221#define HFSPLUS_IS_RSRC(inode) \
222 test_bit(HFSPLUS_I_RSRC, &HFSPLUS_I(inode)->flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223
Christoph Hellwige3494702010-11-23 14:38:15 +0100224static inline struct hfsplus_inode_info *HFSPLUS_I(struct inode *inode)
225{
226 return list_entry(inode, struct hfsplus_inode_info, vfs_inode);
227}
228
229/*
230 * Mark an inode dirty, and also mark the btree in which the
231 * specific type of metadata is stored.
232 * For data or metadata that gets written back by into the catalog btree
233 * by hfsplus_write_inode a plain mark_inode_dirty call is enough.
234 */
235static inline void hfsplus_mark_inode_dirty(struct inode *inode,
236 unsigned int flag)
237{
238 set_bit(flag, &HFSPLUS_I(inode)->flags);
239 mark_inode_dirty(inode);
240}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241
242struct hfs_find_data {
243 /* filled by caller */
244 hfsplus_btree_key *search_key;
245 hfsplus_btree_key *key;
246 /* filled by find */
247 struct hfs_btree *tree;
248 struct hfs_bnode *bnode;
249 /* filled by findrec */
250 int record;
251 int keyoffset, keylength;
252 int entryoffset, entrylength;
253};
254
255struct hfsplus_readdir_data {
256 struct list_head list;
257 struct file *file;
258 struct hfsplus_cat_key key;
259};
260
261#define hfs_btree_open hfsplus_btree_open
262#define hfs_btree_close hfsplus_btree_close
263#define hfs_btree_write hfsplus_btree_write
264#define hfs_bmap_alloc hfsplus_bmap_alloc
265#define hfs_bmap_free hfsplus_bmap_free
266#define hfs_bnode_read hfsplus_bnode_read
267#define hfs_bnode_read_u16 hfsplus_bnode_read_u16
268#define hfs_bnode_read_u8 hfsplus_bnode_read_u8
269#define hfs_bnode_read_key hfsplus_bnode_read_key
270#define hfs_bnode_write hfsplus_bnode_write
271#define hfs_bnode_write_u16 hfsplus_bnode_write_u16
272#define hfs_bnode_clear hfsplus_bnode_clear
273#define hfs_bnode_copy hfsplus_bnode_copy
274#define hfs_bnode_move hfsplus_bnode_move
275#define hfs_bnode_dump hfsplus_bnode_dump
276#define hfs_bnode_unlink hfsplus_bnode_unlink
277#define hfs_bnode_findhash hfsplus_bnode_findhash
278#define hfs_bnode_find hfsplus_bnode_find
279#define hfs_bnode_unhash hfsplus_bnode_unhash
280#define hfs_bnode_free hfsplus_bnode_free
281#define hfs_bnode_create hfsplus_bnode_create
282#define hfs_bnode_get hfsplus_bnode_get
283#define hfs_bnode_put hfsplus_bnode_put
284#define hfs_brec_lenoff hfsplus_brec_lenoff
285#define hfs_brec_keylen hfsplus_brec_keylen
286#define hfs_brec_insert hfsplus_brec_insert
287#define hfs_brec_remove hfsplus_brec_remove
288#define hfs_find_init hfsplus_find_init
289#define hfs_find_exit hfsplus_find_exit
290#define __hfs_brec_find __hplusfs_brec_find
291#define hfs_brec_find hfsplus_brec_find
292#define hfs_brec_read hfsplus_brec_read
293#define hfs_brec_goto hfsplus_brec_goto
294#define hfs_part_find hfsplus_part_find
295
296/*
297 * definitions for ext2 flag ioctls (linux really needs a generic
298 * interface for this).
299 */
300
301/* ext2 ioctls (EXT2_IOC_GETFLAGS and EXT2_IOC_SETFLAGS) to support
302 * chattr/lsattr */
David Howells36695672006-08-29 19:06:16 +0100303#define HFSPLUS_IOC_EXT2_GETFLAGS FS_IOC_GETFLAGS
304#define HFSPLUS_IOC_EXT2_SETFLAGS FS_IOC_SETFLAGS
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305
306
307/*
308 * Functions in any *.c used in other files
309 */
310
311/* bitmap.c */
312int hfsplus_block_allocate(struct super_block *, u32, u32, u32 *);
313int hfsplus_block_free(struct super_block *, u32, u32);
314
315/* btree.c */
316struct hfs_btree *hfs_btree_open(struct super_block *, u32);
317void hfs_btree_close(struct hfs_btree *);
318void hfs_btree_write(struct hfs_btree *);
319struct hfs_bnode *hfs_bmap_alloc(struct hfs_btree *);
320void hfs_bmap_free(struct hfs_bnode *);
321
322/* bnode.c */
323void hfs_bnode_read(struct hfs_bnode *, void *, int, int);
324u16 hfs_bnode_read_u16(struct hfs_bnode *, int);
325u8 hfs_bnode_read_u8(struct hfs_bnode *, int);
326void hfs_bnode_read_key(struct hfs_bnode *, void *, int);
327void hfs_bnode_write(struct hfs_bnode *, void *, int, int);
328void hfs_bnode_write_u16(struct hfs_bnode *, int, u16);
329void hfs_bnode_clear(struct hfs_bnode *, int, int);
330void hfs_bnode_copy(struct hfs_bnode *, int,
331 struct hfs_bnode *, int, int);
332void hfs_bnode_move(struct hfs_bnode *, int, int, int);
333void hfs_bnode_dump(struct hfs_bnode *);
334void hfs_bnode_unlink(struct hfs_bnode *);
335struct hfs_bnode *hfs_bnode_findhash(struct hfs_btree *, u32);
336struct hfs_bnode *hfs_bnode_find(struct hfs_btree *, u32);
337void hfs_bnode_unhash(struct hfs_bnode *);
338void hfs_bnode_free(struct hfs_bnode *);
339struct hfs_bnode *hfs_bnode_create(struct hfs_btree *, u32);
340void hfs_bnode_get(struct hfs_bnode *);
341void hfs_bnode_put(struct hfs_bnode *);
342
343/* brec.c */
344u16 hfs_brec_lenoff(struct hfs_bnode *, u16, u16 *);
345u16 hfs_brec_keylen(struct hfs_bnode *, u16);
346int hfs_brec_insert(struct hfs_find_data *, void *, int);
347int hfs_brec_remove(struct hfs_find_data *);
348
349/* bfind.c */
350int hfs_find_init(struct hfs_btree *, struct hfs_find_data *);
351void hfs_find_exit(struct hfs_find_data *);
352int __hfs_brec_find(struct hfs_bnode *, struct hfs_find_data *);
353int hfs_brec_find(struct hfs_find_data *);
354int hfs_brec_read(struct hfs_find_data *, void *, int);
355int hfs_brec_goto(struct hfs_find_data *, int);
356
357/* catalog.c */
Anton Salikhmetov2753cc22010-12-16 18:08:38 +0200358int hfsplus_cat_case_cmp_key(const hfsplus_btree_key *,
359 const hfsplus_btree_key *);
360int hfsplus_cat_bin_cmp_key(const hfsplus_btree_key *,
361 const hfsplus_btree_key *);
362void hfsplus_cat_build_key(struct super_block *sb,
363 hfsplus_btree_key *, u32, struct qstr *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364int hfsplus_find_cat(struct super_block *, u32, struct hfs_find_data *);
365int hfsplus_create_cat(u32, struct inode *, struct qstr *, struct inode *);
366int hfsplus_delete_cat(u32, struct inode *, struct qstr *);
367int hfsplus_rename_cat(u32, struct inode *, struct qstr *,
368 struct inode *, struct qstr *);
Christoph Hellwig90e61692010-10-14 09:54:39 -0400369void hfsplus_cat_set_perms(struct inode *inode, struct hfsplus_perm *perms);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370
Adrian Bunk4b0a8da2008-04-29 00:58:52 -0700371/* dir.c */
372extern const struct inode_operations hfsplus_dir_inode_operations;
373extern const struct file_operations hfsplus_dir_operations;
374
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375/* extents.c */
David Elliott2179d372006-01-18 17:43:08 -0800376int hfsplus_ext_cmp_key(const hfsplus_btree_key *, const hfsplus_btree_key *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377void hfsplus_ext_write_extent(struct inode *);
378int hfsplus_get_block(struct inode *, sector_t, struct buffer_head *, int);
Anton Salikhmetov2753cc22010-12-16 18:08:38 +0200379int hfsplus_free_fork(struct super_block *, u32,
380 struct hfsplus_fork_raw *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381int hfsplus_file_extend(struct inode *);
382void hfsplus_file_truncate(struct inode *);
383
384/* inode.c */
Christoph Hellwigf5e54d62006-06-28 04:26:44 -0700385extern const struct address_space_operations hfsplus_aops;
386extern const struct address_space_operations hfsplus_btree_aops;
Al Viroe16404e2009-02-20 05:55:13 +0000387extern const struct dentry_operations hfsplus_dentry_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388
389void hfsplus_inode_read_fork(struct inode *, struct hfsplus_fork_raw *);
390void hfsplus_inode_write_fork(struct inode *, struct hfsplus_fork_raw *);
391int hfsplus_cat_read_inode(struct inode *, struct hfs_find_data *);
392int hfsplus_cat_write_inode(struct inode *);
393struct inode *hfsplus_new_inode(struct super_block *, int);
394void hfsplus_delete_inode(struct inode *);
Christoph Hellwigeb29d662010-11-23 14:38:10 +0100395int hfsplus_file_fsync(struct file *file, int datasync);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396
397/* ioctl.c */
Arnd Bergmann7cc4bcc2010-04-27 16:24:20 +0200398long hfsplus_ioctl(struct file *filp, unsigned int cmd, unsigned long arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399int hfsplus_setxattr(struct dentry *dentry, const char *name,
400 const void *value, size_t size, int flags);
401ssize_t hfsplus_getxattr(struct dentry *dentry, const char *name,
402 void *value, size_t size);
403ssize_t hfsplus_listxattr(struct dentry *dentry, char *buffer, size_t size);
404
405/* options.c */
Roman Zippel717dd802005-09-06 15:18:48 -0700406int hfsplus_parse_options(char *, struct hfsplus_sb_info *);
Christoph Hellwig6f80dfe2010-11-07 23:01:17 +0100407int hfsplus_parse_options_remount(char *input, int *force);
Roman Zippel717dd802005-09-06 15:18:48 -0700408void hfsplus_fill_defaults(struct hfsplus_sb_info *);
409int hfsplus_show_options(struct seq_file *, struct vfsmount *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410
David Howells63525392008-02-07 00:15:40 -0800411/* super.c */
412struct inode *hfsplus_iget(struct super_block *, unsigned long);
Al Virob5fc5102010-07-04 12:24:09 +0400413int hfsplus_sync_fs(struct super_block *sb, int wait);
David Howells63525392008-02-07 00:15:40 -0800414
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415/* tables.c */
416extern u16 hfsplus_case_fold_table[];
417extern u16 hfsplus_decompose_table[];
418extern u16 hfsplus_compose_table[];
419
420/* unicode.c */
Anton Salikhmetov2753cc22010-12-16 18:08:38 +0200421int hfsplus_strcasecmp(const struct hfsplus_unistr *,
422 const struct hfsplus_unistr *);
423int hfsplus_strcmp(const struct hfsplus_unistr *,
424 const struct hfsplus_unistr *);
425int hfsplus_uni2asc(struct super_block *,
426 const struct hfsplus_unistr *, char *, int *);
427int hfsplus_asc2uni(struct super_block *,
428 struct hfsplus_unistr *, const char *, int);
Linus Torvalds0c21e3a2011-01-07 17:16:27 -0800429int hfsplus_hash_dentry(const struct dentry *dentry,
430 const struct inode *inode, struct qstr *str);
Nick Piggin621e1552011-01-07 17:49:27 +1100431int hfsplus_compare_dentry(const struct dentry *parent,
432 const struct inode *pinode,
433 const struct dentry *dentry, const struct inode *inode,
434 unsigned int len, const char *str, const struct qstr *name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435
436/* wrapper.c */
437int hfsplus_read_wrapper(struct super_block *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438int hfs_part_find(struct super_block *, sector_t *, sector_t *);
Christoph Hellwig52399b12010-11-23 14:37:47 +0100439int hfsplus_submit_bio(struct block_device *bdev, sector_t sector,
440 void *data, int rw);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441
442/* time macros */
443#define __hfsp_mt2ut(t) (be32_to_cpu(t) - 2082844800U)
444#define __hfsp_ut2mt(t) (cpu_to_be32(t + 2082844800U))
445
446/* compatibility */
447#define hfsp_mt2ut(t) (struct timespec){ .tv_sec = __hfsp_mt2ut(t) }
448#define hfsp_ut2mt(t) __hfsp_ut2mt((t).tv_sec)
449#define hfsp_now2mt() __hfsp_ut2mt(get_seconds())
450
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451#endif