block: submit_bio_wait() conversions
[linux-2.6-block.git] / fs / hfsplus / hfsplus_fs.h
CommitLineData
1da177e4
LT
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
d6142673
JP
13#ifdef pr_fmt
14#undef pr_fmt
15#endif
16
17#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
18
1da177e4 19#include <linux/fs.h>
895c23f8 20#include <linux/mutex.h>
1da177e4 21#include <linux/buffer_head.h>
6596528e 22#include <linux/blkdev.h>
1da177e4
LT
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
324ef39a 32#define DBG_ATTR_MOD 0x00000080
2c92057e 33#define DBG_ACL_MOD 0x00000100
1da177e4 34
21f2296a
AS
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
1da177e4
LT
40#define DBG_MASK (0)
41
d6142673
JP
42#define hfs_dbg(flg, fmt, ...) \
43do { \
44 if (DBG_##flg & DBG_MASK) \
45 printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__); \
c2b3e1f7
JP
46} while (0)
47
d6142673
JP
48#define hfs_dbg_cont(flg, fmt, ...) \
49do { \
50 if (DBG_##flg & DBG_MASK) \
51 pr_cont(fmt, ##__VA_ARGS__); \
c2b3e1f7 52} while (0)
1da177e4
LT
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
2753cc28
AS
60typedef int (*btree_keycmp)(const hfsplus_btree_key *,
61 const hfsplus_btree_key *);
1da177e4
LT
62
63#define NODE_HASH_SIZE 256
64
324ef39a
VD
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
1da177e4
LT
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
467c3d9c 92 struct mutex tree_lock;
1da177e4
LT
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
95e0d7db
VD
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
1da177e4
LT
137/*
138 * HFS+ superblock info (built from Volume Header on disk)
139 */
140
141struct hfsplus_vh;
142struct hfs_btree;
143
144struct hfsplus_sb_info {
6596528e 145 void *s_vhdr_buf;
1da177e4 146 struct hfsplus_vh *s_vhdr;
6596528e 147 void *s_backup_vhdr_buf;
52399b17 148 struct hfsplus_vh *s_backup_vhdr;
1da177e4
LT
149 struct hfs_btree *ext_tree;
150 struct hfs_btree *cat_tree;
151 struct hfs_btree *attr_tree;
95e0d7db 152 atomic_t attr_tree_state;
1da177e4
LT
153 struct inode *alloc_file;
154 struct inode *hidden_dir;
155 struct nls_table *nls;
156
157 /* Runtime variables */
158 u32 blockoffset;
52399b17
CH
159 sector_t part_start;
160 sector_t sect_count;
1da177e4
LT
161 int fs_shift;
162
7ac9fb9c 163 /* immutable data from the volume header */
1da177e4
LT
164 u32 alloc_blksz;
165 int alloc_blksz_shift;
166 u32 total_blocks;
7ac9fb9c
CH
167 u32 data_clump_blocks, rsrc_clump_blocks;
168
169 /* mutable data from the volume header, protected by alloc_mutex */
1da177e4 170 u32 free_blocks;
7ac9fb9c
CH
171 struct mutex alloc_mutex;
172
173 /* mutable data from the volume header, protected by vh_mutex */
1da177e4
LT
174 u32 next_cnid;
175 u32 file_count;
176 u32 folder_count;
7ac9fb9c 177 struct mutex vh_mutex;
1da177e4
LT
178
179 /* Config options */
180 u32 creator;
181 u32 type;
182
183 umode_t umask;
16525e3f
EB
184 kuid_t uid;
185 kgid_t gid;
1da177e4
LT
186
187 int part, session;
1da177e4 188 unsigned long flags;
9e6c5829
AB
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 */
1da177e4
LT
193};
194
84adede3
CH
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
34a2d313 200#define HFSPLUS_SB_NOBARRIER 5
1da177e4 201
e3494705
CH
202static inline struct hfsplus_sb_info *HFSPLUS_SB(struct super_block *sb)
203{
204 return sb->s_fs_info;
205}
1da177e4
LT
206
207
208struct hfsplus_inode_info {
1da177e4
LT
209 atomic_t opencnt;
210
7fcc99f4
CH
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;
b33b7921 221 unsigned int extent_state;
7fcc99f4 222 struct mutex extents_lock;
1da177e4 223
7fcc99f4
CH
224 /*
225 * Immutable data.
226 */
227 struct inode *rsrc_inode;
9a4cad95 228 __be32 create_date;
f6089ff8
CH
229
230 /*
231 * Protected by sbi->vh_mutex.
232 */
233 u32 linkid;
1da177e4 234
b33b7921
CH
235 /*
236 * Accessed using atomic bitops.
237 */
238 unsigned long flags;
239
7fcc99f4
CH
240 /*
241 * Protected by i_mutex.
242 */
243 sector_t fs_blocks;
722c55d1 244 u8 userflags; /* BSD user file flags */
1da177e4
LT
245 struct list_head open_dir_list;
246 loff_t phys_size;
7fcc99f4 247
1da177e4
LT
248 struct inode vfs_inode;
249};
250
b33b7921
CH
251#define HFSPLUS_EXT_DIRTY 0x0001
252#define HFSPLUS_EXT_NEW 0x0002
253
254#define HFSPLUS_I_RSRC 0 /* represents a resource fork */
e3494705
CH
255#define HFSPLUS_I_CAT_DIRTY 1 /* has changes in the catalog tree */
256#define HFSPLUS_I_EXT_DIRTY 2 /* has changes in the extent tree */
257#define HFSPLUS_I_ALLOC_DIRTY 3 /* has changes in the allocation file */
324ef39a 258#define HFSPLUS_I_ATTR_DIRTY 4 /* has changes in the attributes tree */
1da177e4 259
b33b7921
CH
260#define HFSPLUS_IS_RSRC(inode) \
261 test_bit(HFSPLUS_I_RSRC, &HFSPLUS_I(inode)->flags)
1da177e4 262
e3494705
CH
263static inline struct hfsplus_inode_info *HFSPLUS_I(struct inode *inode)
264{
265 return list_entry(inode, struct hfsplus_inode_info, vfs_inode);
266}
1da177e4 267
e3494705
CH
268/*
269 * Mark an inode dirty, and also mark the btree in which the
270 * specific type of metadata is stored.
271 * For data or metadata that gets written back by into the catalog btree
272 * by hfsplus_write_inode a plain mark_inode_dirty call is enough.
273 */
274static inline void hfsplus_mark_inode_dirty(struct inode *inode,
275 unsigned int flag)
276{
277 set_bit(flag, &HFSPLUS_I(inode)->flags);
278 mark_inode_dirty(inode);
279}
1da177e4
LT
280
281struct hfs_find_data {
282 /* filled by caller */
283 hfsplus_btree_key *search_key;
284 hfsplus_btree_key *key;
285 /* filled by find */
286 struct hfs_btree *tree;
287 struct hfs_bnode *bnode;
288 /* filled by findrec */
289 int record;
290 int keyoffset, keylength;
291 int entryoffset, entrylength;
292};
293
294struct hfsplus_readdir_data {
295 struct list_head list;
296 struct file *file;
297 struct hfsplus_cat_key key;
298};
299
6596528e
SF
300/*
301 * Find minimum acceptible I/O size for an hfsplus sb.
302 */
303static inline unsigned short hfsplus_min_io_size(struct super_block *sb)
304{
305 return max_t(unsigned short, bdev_logical_block_size(sb->s_bdev),
306 HFSPLUS_SECTOR_SIZE);
307}
308
1da177e4
LT
309#define hfs_btree_open hfsplus_btree_open
310#define hfs_btree_close hfsplus_btree_close
311#define hfs_btree_write hfsplus_btree_write
312#define hfs_bmap_alloc hfsplus_bmap_alloc
313#define hfs_bmap_free hfsplus_bmap_free
314#define hfs_bnode_read hfsplus_bnode_read
315#define hfs_bnode_read_u16 hfsplus_bnode_read_u16
316#define hfs_bnode_read_u8 hfsplus_bnode_read_u8
317#define hfs_bnode_read_key hfsplus_bnode_read_key
318#define hfs_bnode_write hfsplus_bnode_write
319#define hfs_bnode_write_u16 hfsplus_bnode_write_u16
320#define hfs_bnode_clear hfsplus_bnode_clear
321#define hfs_bnode_copy hfsplus_bnode_copy
322#define hfs_bnode_move hfsplus_bnode_move
323#define hfs_bnode_dump hfsplus_bnode_dump
324#define hfs_bnode_unlink hfsplus_bnode_unlink
325#define hfs_bnode_findhash hfsplus_bnode_findhash
326#define hfs_bnode_find hfsplus_bnode_find
327#define hfs_bnode_unhash hfsplus_bnode_unhash
328#define hfs_bnode_free hfsplus_bnode_free
329#define hfs_bnode_create hfsplus_bnode_create
330#define hfs_bnode_get hfsplus_bnode_get
331#define hfs_bnode_put hfsplus_bnode_put
332#define hfs_brec_lenoff hfsplus_brec_lenoff
333#define hfs_brec_keylen hfsplus_brec_keylen
334#define hfs_brec_insert hfsplus_brec_insert
335#define hfs_brec_remove hfsplus_brec_remove
336#define hfs_find_init hfsplus_find_init
337#define hfs_find_exit hfsplus_find_exit
324ef39a 338#define __hfs_brec_find __hfsplus_brec_find
1da177e4
LT
339#define hfs_brec_find hfsplus_brec_find
340#define hfs_brec_read hfsplus_brec_read
341#define hfs_brec_goto hfsplus_brec_goto
342#define hfs_part_find hfsplus_part_find
343
344/*
345 * definitions for ext2 flag ioctls (linux really needs a generic
346 * interface for this).
347 */
348
349/* ext2 ioctls (EXT2_IOC_GETFLAGS and EXT2_IOC_SETFLAGS) to support
350 * chattr/lsattr */
36695673
DH
351#define HFSPLUS_IOC_EXT2_GETFLAGS FS_IOC_GETFLAGS
352#define HFSPLUS_IOC_EXT2_SETFLAGS FS_IOC_SETFLAGS
1da177e4
LT
353
354
a051f71c
MG
355/*
356 * hfs+-specific ioctl for making the filesystem bootable
357 */
358#define HFSPLUS_IOC_BLESS _IO('h', 0x80)
359
324ef39a
VD
360typedef int (*search_strategy_t)(struct hfs_bnode *,
361 struct hfs_find_data *,
362 int *, int *, int *);
363
1da177e4
LT
364/*
365 * Functions in any *.c used in other files
366 */
367
324ef39a
VD
368/* attributes.c */
369int hfsplus_create_attr_tree_cache(void);
370void hfsplus_destroy_attr_tree_cache(void);
371hfsplus_attr_entry *hfsplus_alloc_attr_entry(void);
372void hfsplus_destroy_attr_entry(hfsplus_attr_entry *entry_p);
373int hfsplus_attr_bin_cmp_key(const hfsplus_btree_key *,
374 const hfsplus_btree_key *);
375int hfsplus_attr_build_key(struct super_block *, hfsplus_btree_key *,
376 u32, const char *);
377void hfsplus_attr_build_key_uni(hfsplus_btree_key *key,
378 u32 cnid,
379 struct hfsplus_attr_unistr *name);
380int hfsplus_find_attr(struct super_block *, u32,
381 const char *, struct hfs_find_data *);
382int hfsplus_attr_exists(struct inode *inode, const char *name);
383int hfsplus_create_attr(struct inode *, const char *, const void *, size_t);
384int hfsplus_delete_attr(struct inode *, const char *);
385int hfsplus_delete_all_attrs(struct inode *dir, u32 cnid);
386
1da177e4
LT
387/* bitmap.c */
388int hfsplus_block_allocate(struct super_block *, u32, u32, u32 *);
389int hfsplus_block_free(struct super_block *, u32, u32);
390
391/* btree.c */
b3b5b0f0 392u32 hfsplus_calc_btree_clump_size(u32, u32, u64, int);
1da177e4
LT
393struct hfs_btree *hfs_btree_open(struct super_block *, u32);
394void hfs_btree_close(struct hfs_btree *);
81cc7fad 395int hfs_btree_write(struct hfs_btree *);
1da177e4
LT
396struct hfs_bnode *hfs_bmap_alloc(struct hfs_btree *);
397void hfs_bmap_free(struct hfs_bnode *);
398
399/* bnode.c */
400void hfs_bnode_read(struct hfs_bnode *, void *, int, int);
401u16 hfs_bnode_read_u16(struct hfs_bnode *, int);
402u8 hfs_bnode_read_u8(struct hfs_bnode *, int);
403void hfs_bnode_read_key(struct hfs_bnode *, void *, int);
404void hfs_bnode_write(struct hfs_bnode *, void *, int, int);
405void hfs_bnode_write_u16(struct hfs_bnode *, int, u16);
406void hfs_bnode_clear(struct hfs_bnode *, int, int);
407void hfs_bnode_copy(struct hfs_bnode *, int,
408 struct hfs_bnode *, int, int);
409void hfs_bnode_move(struct hfs_bnode *, int, int, int);
410void hfs_bnode_dump(struct hfs_bnode *);
411void hfs_bnode_unlink(struct hfs_bnode *);
412struct hfs_bnode *hfs_bnode_findhash(struct hfs_btree *, u32);
413struct hfs_bnode *hfs_bnode_find(struct hfs_btree *, u32);
414void hfs_bnode_unhash(struct hfs_bnode *);
415void hfs_bnode_free(struct hfs_bnode *);
416struct hfs_bnode *hfs_bnode_create(struct hfs_btree *, u32);
417void hfs_bnode_get(struct hfs_bnode *);
418void hfs_bnode_put(struct hfs_bnode *);
419
420/* brec.c */
421u16 hfs_brec_lenoff(struct hfs_bnode *, u16, u16 *);
422u16 hfs_brec_keylen(struct hfs_bnode *, u16);
423int hfs_brec_insert(struct hfs_find_data *, void *, int);
424int hfs_brec_remove(struct hfs_find_data *);
425
426/* bfind.c */
427int hfs_find_init(struct hfs_btree *, struct hfs_find_data *);
428void hfs_find_exit(struct hfs_find_data *);
324ef39a
VD
429int hfs_find_1st_rec_by_cnid(struct hfs_bnode *,
430 struct hfs_find_data *,
431 int *, int *, int *);
432int hfs_find_rec_by_key(struct hfs_bnode *,
433 struct hfs_find_data *,
434 int *, int *, int *);
435int __hfs_brec_find(struct hfs_bnode *, struct hfs_find_data *,
436 search_strategy_t);
437int hfs_brec_find(struct hfs_find_data *, search_strategy_t);
1da177e4
LT
438int hfs_brec_read(struct hfs_find_data *, void *, int);
439int hfs_brec_goto(struct hfs_find_data *, int);
440
441/* catalog.c */
2753cc28
AS
442int hfsplus_cat_case_cmp_key(const hfsplus_btree_key *,
443 const hfsplus_btree_key *);
444int hfsplus_cat_bin_cmp_key(const hfsplus_btree_key *,
445 const hfsplus_btree_key *);
446void hfsplus_cat_build_key(struct super_block *sb,
447 hfsplus_btree_key *, u32, struct qstr *);
1da177e4
LT
448int hfsplus_find_cat(struct super_block *, u32, struct hfs_find_data *);
449int hfsplus_create_cat(u32, struct inode *, struct qstr *, struct inode *);
450int hfsplus_delete_cat(u32, struct inode *, struct qstr *);
451int hfsplus_rename_cat(u32, struct inode *, struct qstr *,
452 struct inode *, struct qstr *);
90e61690 453void hfsplus_cat_set_perms(struct inode *inode, struct hfsplus_perm *perms);
1da177e4 454
4b0a8da7
AB
455/* dir.c */
456extern const struct inode_operations hfsplus_dir_inode_operations;
457extern const struct file_operations hfsplus_dir_operations;
458
1da177e4 459/* extents.c */
2179d372 460int hfsplus_ext_cmp_key(const hfsplus_btree_key *, const hfsplus_btree_key *);
dd7f3d54 461int hfsplus_ext_write_extent(struct inode *);
1da177e4 462int hfsplus_get_block(struct inode *, sector_t, struct buffer_head *, int);
2753cc28
AS
463int hfsplus_free_fork(struct super_block *, u32,
464 struct hfsplus_fork_raw *, int);
1da177e4
LT
465int hfsplus_file_extend(struct inode *);
466void hfsplus_file_truncate(struct inode *);
467
468/* inode.c */
f5e54d6e
CH
469extern const struct address_space_operations hfsplus_aops;
470extern const struct address_space_operations hfsplus_btree_aops;
e16404ed 471extern const struct dentry_operations hfsplus_dentry_operations;
1da177e4
LT
472
473void hfsplus_inode_read_fork(struct inode *, struct hfsplus_fork_raw *);
474void hfsplus_inode_write_fork(struct inode *, struct hfsplus_fork_raw *);
475int hfsplus_cat_read_inode(struct inode *, struct hfs_find_data *);
476int hfsplus_cat_write_inode(struct inode *);
c47da798 477struct inode *hfsplus_new_inode(struct super_block *, umode_t);
1da177e4 478void hfsplus_delete_inode(struct inode *);
02c24a82
JB
479int hfsplus_file_fsync(struct file *file, loff_t start, loff_t end,
480 int datasync);
1da177e4
LT
481
482/* ioctl.c */
7cc4bcc6 483long hfsplus_ioctl(struct file *filp, unsigned int cmd, unsigned long arg);
1da177e4
LT
484
485/* options.c */
717dd80e 486int hfsplus_parse_options(char *, struct hfsplus_sb_info *);
6f80dfe5 487int hfsplus_parse_options_remount(char *input, int *force);
717dd80e 488void hfsplus_fill_defaults(struct hfsplus_sb_info *);
34c80b1d 489int hfsplus_show_options(struct seq_file *, struct dentry *);
1da177e4 490
63525391
DH
491/* super.c */
492struct inode *hfsplus_iget(struct super_block *, unsigned long);
9e6c5829 493void hfsplus_mark_mdb_dirty(struct super_block *sb);
63525391 494
1da177e4
LT
495/* tables.c */
496extern u16 hfsplus_case_fold_table[];
497extern u16 hfsplus_decompose_table[];
498extern u16 hfsplus_compose_table[];
499
500/* unicode.c */
2753cc28
AS
501int hfsplus_strcasecmp(const struct hfsplus_unistr *,
502 const struct hfsplus_unistr *);
503int hfsplus_strcmp(const struct hfsplus_unistr *,
504 const struct hfsplus_unistr *);
505int hfsplus_uni2asc(struct super_block *,
506 const struct hfsplus_unistr *, char *, int *);
507int hfsplus_asc2uni(struct super_block *,
324ef39a 508 struct hfsplus_unistr *, int, const char *, int);
da53be12
LT
509int hfsplus_hash_dentry(const struct dentry *dentry, struct qstr *str);
510int hfsplus_compare_dentry(const struct dentry *parent, const struct dentry *dentry,
621e155a 511 unsigned int len, const char *str, const struct qstr *name);
1da177e4
LT
512
513/* wrapper.c */
514int hfsplus_read_wrapper(struct super_block *);
1da177e4 515int hfs_part_find(struct super_block *, sector_t *, sector_t *);
6596528e
SF
516int hfsplus_submit_bio(struct super_block *sb, sector_t sector,
517 void *buf, void **data, int rw);
1da177e4
LT
518
519/* time macros */
520#define __hfsp_mt2ut(t) (be32_to_cpu(t) - 2082844800U)
521#define __hfsp_ut2mt(t) (cpu_to_be32(t + 2082844800U))
522
523/* compatibility */
524#define hfsp_mt2ut(t) (struct timespec){ .tv_sec = __hfsp_mt2ut(t) }
525#define hfsp_ut2mt(t) __hfsp_ut2mt((t).tv_sec)
526#define hfsp_now2mt() __hfsp_ut2mt(get_seconds())
527
1da177e4 528#endif