[PATCH] BLOCK: Move common FS-specific ioctls to linux/fs.h [try #6]
[linux-2.6.git] / fs / hfsplus / hfsplus_fs.h
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 #include <linux/fs.h>
14 #include <linux/buffer_head.h>
15 #include "hfsplus_raw.h"
16
17 #define DBG_BNODE_REFS  0x00000001
18 #define DBG_BNODE_MOD   0x00000002
19 #define DBG_CAT_MOD     0x00000004
20 #define DBG_INODE       0x00000008
21 #define DBG_SUPER       0x00000010
22 #define DBG_EXTENT      0x00000020
23 #define DBG_BITMAP      0x00000040
24
25 //#define DBG_MASK      (DBG_EXTENT|DBG_INODE|DBG_BNODE_MOD)
26 //#define DBG_MASK      (DBG_BNODE_MOD|DBG_CAT_MOD|DBG_INODE)
27 //#define DBG_MASK      (DBG_CAT_MOD|DBG_BNODE_REFS|DBG_INODE|DBG_EXTENT)
28 #define DBG_MASK        (0)
29
30 #define dprint(flg, fmt, args...) \
31         if (flg & DBG_MASK) printk(fmt , ## args)
32
33 /* Runtime config options */
34 #define HFSPLUS_DEF_CR_TYPE    0x3F3F3F3F  /* '????' */
35
36 #define HFSPLUS_TYPE_DATA 0x00
37 #define HFSPLUS_TYPE_RSRC 0xFF
38
39 typedef int (*btree_keycmp)(const hfsplus_btree_key *, const hfsplus_btree_key *);
40
41 #define NODE_HASH_SIZE  256
42
43 /* An HFS+ BTree held in memory */
44 struct hfs_btree {
45         struct super_block *sb;
46         struct inode *inode;
47         btree_keycmp keycmp;
48
49         u32 cnid;
50         u32 root;
51         u32 leaf_count;
52         u32 leaf_head;
53         u32 leaf_tail;
54         u32 node_count;
55         u32 free_nodes;
56         u32 attributes;
57
58         unsigned int node_size;
59         unsigned int node_size_shift;
60         unsigned int max_key_len;
61         unsigned int depth;
62
63         //unsigned int map1_size, map_size;
64         struct semaphore tree_lock;
65
66         unsigned int pages_per_bnode;
67         spinlock_t hash_lock;
68         struct hfs_bnode *node_hash[NODE_HASH_SIZE];
69         int node_hash_cnt;
70 };
71
72 struct page;
73
74 /* An HFS+ BTree node in memory */
75 struct hfs_bnode {
76         struct hfs_btree *tree;
77
78         u32 prev;
79         u32 this;
80         u32 next;
81         u32 parent;
82
83         u16 num_recs;
84         u8 type;
85         u8 height;
86
87         struct hfs_bnode *next_hash;
88         unsigned long flags;
89         wait_queue_head_t lock_wq;
90         atomic_t refcnt;
91         unsigned int page_offset;
92         struct page *page[0];
93 };
94
95 #define HFS_BNODE_LOCK          0
96 #define HFS_BNODE_ERROR         1
97 #define HFS_BNODE_NEW           2
98 #define HFS_BNODE_DIRTY         3
99 #define HFS_BNODE_DELETED       4
100
101 /*
102  * HFS+ superblock info (built from Volume Header on disk)
103  */
104
105 struct hfsplus_vh;
106 struct hfs_btree;
107
108 struct hfsplus_sb_info {
109         struct buffer_head *s_vhbh;
110         struct hfsplus_vh *s_vhdr;
111         struct hfs_btree *ext_tree;
112         struct hfs_btree *cat_tree;
113         struct hfs_btree *attr_tree;
114         struct inode *alloc_file;
115         struct inode *hidden_dir;
116         struct nls_table *nls;
117
118         /* Runtime variables */
119         u32 blockoffset;
120         u32 sect_count;
121         int fs_shift;
122
123         /* Stuff in host order from Vol Header */
124         u32 alloc_blksz;
125         int alloc_blksz_shift;
126         u32 total_blocks;
127         u32 free_blocks;
128         u32 next_alloc;
129         u32 next_cnid;
130         u32 file_count;
131         u32 folder_count;
132         u32 data_clump_blocks, rsrc_clump_blocks;
133
134         /* Config options */
135         u32 creator;
136         u32 type;
137
138         umode_t umask;
139         uid_t uid;
140         gid_t gid;
141
142         int part, session;
143
144         unsigned long flags;
145
146         struct hlist_head rsrc_inodes;
147 };
148
149 #define HFSPLUS_SB_WRITEBACKUP  0x0001
150 #define HFSPLUS_SB_NODECOMPOSE  0x0002
151 #define HFSPLUS_SB_FORCE        0x0004
152 #define HFSPLUS_SB_HFSX         0x0008
153
154
155 struct hfsplus_inode_info {
156         struct semaphore extents_lock;
157         u32 clump_blocks, alloc_blocks;
158         sector_t fs_blocks;
159         /* Allocation extents from catalog record or volume header */
160         hfsplus_extent_rec first_extents;
161         u32 first_blocks;
162         hfsplus_extent_rec cached_extents;
163         u32 cached_start, cached_blocks;
164         atomic_t opencnt;
165
166         struct inode *rsrc_inode;
167         unsigned long flags;
168
169         __be32 create_date;
170         /* Device number in hfsplus_permissions in catalog */
171         u32 dev;
172         /* BSD system and user file flags */
173         u8 rootflags;
174         u8 userflags;
175
176         struct list_head open_dir_list;
177         loff_t phys_size;
178         struct inode vfs_inode;
179 };
180
181 #define HFSPLUS_FLG_RSRC        0x0001
182 #define HFSPLUS_FLG_EXT_DIRTY   0x0002
183 #define HFSPLUS_FLG_EXT_NEW     0x0004
184
185 #define HFSPLUS_IS_DATA(inode)   (!(HFSPLUS_I(inode).flags & HFSPLUS_FLG_RSRC))
186 #define HFSPLUS_IS_RSRC(inode)   (HFSPLUS_I(inode).flags & HFSPLUS_FLG_RSRC)
187
188 struct hfs_find_data {
189         /* filled by caller */
190         hfsplus_btree_key *search_key;
191         hfsplus_btree_key *key;
192         /* filled by find */
193         struct hfs_btree *tree;
194         struct hfs_bnode *bnode;
195         /* filled by findrec */
196         int record;
197         int keyoffset, keylength;
198         int entryoffset, entrylength;
199 };
200
201 struct hfsplus_readdir_data {
202         struct list_head list;
203         struct file *file;
204         struct hfsplus_cat_key key;
205 };
206
207 #define hfs_btree_open hfsplus_btree_open
208 #define hfs_btree_close hfsplus_btree_close
209 #define hfs_btree_write hfsplus_btree_write
210 #define hfs_bmap_alloc hfsplus_bmap_alloc
211 #define hfs_bmap_free hfsplus_bmap_free
212 #define hfs_bnode_read hfsplus_bnode_read
213 #define hfs_bnode_read_u16 hfsplus_bnode_read_u16
214 #define hfs_bnode_read_u8 hfsplus_bnode_read_u8
215 #define hfs_bnode_read_key hfsplus_bnode_read_key
216 #define hfs_bnode_write hfsplus_bnode_write
217 #define hfs_bnode_write_u16 hfsplus_bnode_write_u16
218 #define hfs_bnode_clear hfsplus_bnode_clear
219 #define hfs_bnode_copy hfsplus_bnode_copy
220 #define hfs_bnode_move hfsplus_bnode_move
221 #define hfs_bnode_dump hfsplus_bnode_dump
222 #define hfs_bnode_unlink hfsplus_bnode_unlink
223 #define hfs_bnode_findhash hfsplus_bnode_findhash
224 #define hfs_bnode_find hfsplus_bnode_find
225 #define hfs_bnode_unhash hfsplus_bnode_unhash
226 #define hfs_bnode_free hfsplus_bnode_free
227 #define hfs_bnode_create hfsplus_bnode_create
228 #define hfs_bnode_get hfsplus_bnode_get
229 #define hfs_bnode_put hfsplus_bnode_put
230 #define hfs_brec_lenoff hfsplus_brec_lenoff
231 #define hfs_brec_keylen hfsplus_brec_keylen
232 #define hfs_brec_insert hfsplus_brec_insert
233 #define hfs_brec_remove hfsplus_brec_remove
234 #define hfs_find_init hfsplus_find_init
235 #define hfs_find_exit hfsplus_find_exit
236 #define __hfs_brec_find __hplusfs_brec_find
237 #define hfs_brec_find hfsplus_brec_find
238 #define hfs_brec_read hfsplus_brec_read
239 #define hfs_brec_goto hfsplus_brec_goto
240 #define hfs_part_find hfsplus_part_find
241
242 /*
243  * definitions for ext2 flag ioctls (linux really needs a generic
244  * interface for this).
245  */
246
247 /* ext2 ioctls (EXT2_IOC_GETFLAGS and EXT2_IOC_SETFLAGS) to support
248  * chattr/lsattr */
249 #define HFSPLUS_IOC_EXT2_GETFLAGS       FS_IOC_GETFLAGS
250 #define HFSPLUS_IOC_EXT2_SETFLAGS       FS_IOC_SETFLAGS
251
252
253 /*
254  * Functions in any *.c used in other files
255  */
256
257 /* bitmap.c */
258 int hfsplus_block_allocate(struct super_block *, u32, u32, u32 *);
259 int hfsplus_block_free(struct super_block *, u32, u32);
260
261 /* btree.c */
262 struct hfs_btree *hfs_btree_open(struct super_block *, u32);
263 void hfs_btree_close(struct hfs_btree *);
264 void hfs_btree_write(struct hfs_btree *);
265 struct hfs_bnode *hfs_bmap_alloc(struct hfs_btree *);
266 void hfs_bmap_free(struct hfs_bnode *);
267
268 /* bnode.c */
269 void hfs_bnode_read(struct hfs_bnode *, void *, int, int);
270 u16 hfs_bnode_read_u16(struct hfs_bnode *, int);
271 u8 hfs_bnode_read_u8(struct hfs_bnode *, int);
272 void hfs_bnode_read_key(struct hfs_bnode *, void *, int);
273 void hfs_bnode_write(struct hfs_bnode *, void *, int, int);
274 void hfs_bnode_write_u16(struct hfs_bnode *, int, u16);
275 void hfs_bnode_clear(struct hfs_bnode *, int, int);
276 void hfs_bnode_copy(struct hfs_bnode *, int,
277                     struct hfs_bnode *, int, int);
278 void hfs_bnode_move(struct hfs_bnode *, int, int, int);
279 void hfs_bnode_dump(struct hfs_bnode *);
280 void hfs_bnode_unlink(struct hfs_bnode *);
281 struct hfs_bnode *hfs_bnode_findhash(struct hfs_btree *, u32);
282 struct hfs_bnode *hfs_bnode_find(struct hfs_btree *, u32);
283 void hfs_bnode_unhash(struct hfs_bnode *);
284 void hfs_bnode_free(struct hfs_bnode *);
285 struct hfs_bnode *hfs_bnode_create(struct hfs_btree *, u32);
286 void hfs_bnode_get(struct hfs_bnode *);
287 void hfs_bnode_put(struct hfs_bnode *);
288
289 /* brec.c */
290 u16 hfs_brec_lenoff(struct hfs_bnode *, u16, u16 *);
291 u16 hfs_brec_keylen(struct hfs_bnode *, u16);
292 int hfs_brec_insert(struct hfs_find_data *, void *, int);
293 int hfs_brec_remove(struct hfs_find_data *);
294
295 /* bfind.c */
296 int hfs_find_init(struct hfs_btree *, struct hfs_find_data *);
297 void hfs_find_exit(struct hfs_find_data *);
298 int __hfs_brec_find(struct hfs_bnode *, struct hfs_find_data *);
299 int hfs_brec_find(struct hfs_find_data *);
300 int hfs_brec_read(struct hfs_find_data *, void *, int);
301 int hfs_brec_goto(struct hfs_find_data *, int);
302
303 /* catalog.c */
304 int hfsplus_cat_case_cmp_key(const hfsplus_btree_key *, const hfsplus_btree_key *);
305 int hfsplus_cat_bin_cmp_key(const hfsplus_btree_key *, const hfsplus_btree_key *);
306 void hfsplus_cat_build_key(struct super_block *sb, hfsplus_btree_key *, u32, struct qstr *);
307 int hfsplus_find_cat(struct super_block *, u32, struct hfs_find_data *);
308 int hfsplus_create_cat(u32, struct inode *, struct qstr *, struct inode *);
309 int hfsplus_delete_cat(u32, struct inode *, struct qstr *);
310 int hfsplus_rename_cat(u32, struct inode *, struct qstr *,
311                        struct inode *, struct qstr *);
312
313 /* extents.c */
314 int hfsplus_ext_cmp_key(const hfsplus_btree_key *, const hfsplus_btree_key *);
315 void hfsplus_ext_write_extent(struct inode *);
316 int hfsplus_get_block(struct inode *, sector_t, struct buffer_head *, int);
317 int hfsplus_free_fork(struct super_block *, u32, struct hfsplus_fork_raw *, int);
318 int hfsplus_file_extend(struct inode *);
319 void hfsplus_file_truncate(struct inode *);
320
321 /* inode.c */
322 extern const struct address_space_operations hfsplus_aops;
323 extern const struct address_space_operations hfsplus_btree_aops;
324
325 void hfsplus_inode_read_fork(struct inode *, struct hfsplus_fork_raw *);
326 void hfsplus_inode_write_fork(struct inode *, struct hfsplus_fork_raw *);
327 int hfsplus_cat_read_inode(struct inode *, struct hfs_find_data *);
328 int hfsplus_cat_write_inode(struct inode *);
329 struct inode *hfsplus_new_inode(struct super_block *, int);
330 void hfsplus_delete_inode(struct inode *);
331
332 /* ioctl.c */
333 int hfsplus_ioctl(struct inode *inode, struct file *filp, unsigned int cmd,
334                   unsigned long arg);
335 int hfsplus_setxattr(struct dentry *dentry, const char *name,
336                      const void *value, size_t size, int flags);
337 ssize_t hfsplus_getxattr(struct dentry *dentry, const char *name,
338                          void *value, size_t size);
339 ssize_t hfsplus_listxattr(struct dentry *dentry, char *buffer, size_t size);
340
341 /* options.c */
342 int hfsplus_parse_options(char *, struct hfsplus_sb_info *);
343 void hfsplus_fill_defaults(struct hfsplus_sb_info *);
344 int hfsplus_show_options(struct seq_file *, struct vfsmount *);
345
346 /* tables.c */
347 extern u16 hfsplus_case_fold_table[];
348 extern u16 hfsplus_decompose_table[];
349 extern u16 hfsplus_compose_table[];
350
351 /* unicode.c */
352 int hfsplus_strcasecmp(const struct hfsplus_unistr *, const struct hfsplus_unistr *);
353 int hfsplus_strcmp(const struct hfsplus_unistr *, const struct hfsplus_unistr *);
354 int hfsplus_uni2asc(struct super_block *, const struct hfsplus_unistr *, char *, int *);
355 int hfsplus_asc2uni(struct super_block *, struct hfsplus_unistr *, const char *, int);
356
357 /* wrapper.c */
358 int hfsplus_read_wrapper(struct super_block *);
359
360 int hfs_part_find(struct super_block *, sector_t *, sector_t *);
361
362 /* access macros */
363 /*
364 static inline struct hfsplus_sb_info *HFSPLUS_SB(struct super_block *sb)
365 {
366         return sb->s_fs_info;
367 }
368 static inline struct hfsplus_inode_info *HFSPLUS_I(struct inode *inode)
369 {
370         return list_entry(inode, struct hfsplus_inode_info, vfs_inode);
371 }
372 */
373 #define HFSPLUS_SB(super)       (*(struct hfsplus_sb_info *)(super)->s_fs_info)
374 #define HFSPLUS_I(inode)        (*list_entry(inode, struct hfsplus_inode_info, vfs_inode))
375
376 #if 1
377 #define hfsplus_kmap(p)         ({ struct page *__p = (p); kmap(__p); })
378 #define hfsplus_kunmap(p)       ({ struct page *__p = (p); kunmap(__p); __p; })
379 #else
380 #define hfsplus_kmap(p)         kmap(p)
381 #define hfsplus_kunmap(p)       kunmap(p)
382 #endif
383
384 #define sb_bread512(sb, sec, data) ({                   \
385         struct buffer_head *__bh;                       \
386         sector_t __block;                               \
387         loff_t __start;                                 \
388         int __offset;                                   \
389                                                         \
390         __start = (loff_t)(sec) << HFSPLUS_SECTOR_SHIFT;\
391         __block = __start >> (sb)->s_blocksize_bits;    \
392         __offset = __start & ((sb)->s_blocksize - 1);   \
393         __bh = sb_bread((sb), __block);                 \
394         if (likely(__bh != NULL))                       \
395                 data = (void *)(__bh->b_data + __offset);\
396         else                                            \
397                 data = NULL;                            \
398         __bh;                                           \
399 })
400
401 /* time macros */
402 #define __hfsp_mt2ut(t)         (be32_to_cpu(t) - 2082844800U)
403 #define __hfsp_ut2mt(t)         (cpu_to_be32(t + 2082844800U))
404
405 /* compatibility */
406 #define hfsp_mt2ut(t)           (struct timespec){ .tv_sec = __hfsp_mt2ut(t) }
407 #define hfsp_ut2mt(t)           __hfsp_ut2mt((t).tv_sec)
408 #define hfsp_now2mt()           __hfsp_ut2mt(get_seconds())
409
410 #define kdev_t_to_nr(x)         (x)
411
412 #endif