jbd2: fix use after free in jbd2_journal_dirty_metadata()
[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/mutex.h>
15 #include <linux/buffer_head.h>
16 #include <linux/blkdev.h>
17 #include "hfsplus_raw.h"
18
19 #define DBG_BNODE_REFS  0x00000001
20 #define DBG_BNODE_MOD   0x00000002
21 #define DBG_CAT_MOD     0x00000004
22 #define DBG_INODE       0x00000008
23 #define DBG_SUPER       0x00000010
24 #define DBG_EXTENT      0x00000020
25 #define DBG_BITMAP      0x00000040
26
27 #if 0
28 #define DBG_MASK        (DBG_EXTENT|DBG_INODE|DBG_BNODE_MOD)
29 #define DBG_MASK        (DBG_BNODE_MOD|DBG_CAT_MOD|DBG_INODE)
30 #define DBG_MASK        (DBG_CAT_MOD|DBG_BNODE_REFS|DBG_INODE|DBG_EXTENT)
31 #endif
32 #define DBG_MASK        (0)
33
34 #define dprint(flg, fmt, args...) \
35         if (flg & DBG_MASK) \
36                 printk(fmt , ## args)
37
38 /* Runtime config options */
39 #define HFSPLUS_DEF_CR_TYPE    0x3F3F3F3F  /* '????' */
40
41 #define HFSPLUS_TYPE_DATA 0x00
42 #define HFSPLUS_TYPE_RSRC 0xFF
43
44 typedef int (*btree_keycmp)(const hfsplus_btree_key *,
45                 const hfsplus_btree_key *);
46
47 #define NODE_HASH_SIZE  256
48
49 /* An HFS+ BTree held in memory */
50 struct hfs_btree {
51         struct super_block *sb;
52         struct inode *inode;
53         btree_keycmp keycmp;
54
55         u32 cnid;
56         u32 root;
57         u32 leaf_count;
58         u32 leaf_head;
59         u32 leaf_tail;
60         u32 node_count;
61         u32 free_nodes;
62         u32 attributes;
63
64         unsigned int node_size;
65         unsigned int node_size_shift;
66         unsigned int max_key_len;
67         unsigned int depth;
68
69         struct mutex tree_lock;
70
71         unsigned int pages_per_bnode;
72         spinlock_t hash_lock;
73         struct hfs_bnode *node_hash[NODE_HASH_SIZE];
74         int node_hash_cnt;
75 };
76
77 struct page;
78
79 /* An HFS+ BTree node in memory */
80 struct hfs_bnode {
81         struct hfs_btree *tree;
82
83         u32 prev;
84         u32 this;
85         u32 next;
86         u32 parent;
87
88         u16 num_recs;
89         u8 type;
90         u8 height;
91
92         struct hfs_bnode *next_hash;
93         unsigned long flags;
94         wait_queue_head_t lock_wq;
95         atomic_t refcnt;
96         unsigned int page_offset;
97         struct page *page[0];
98 };
99
100 #define HFS_BNODE_LOCK          0
101 #define HFS_BNODE_ERROR         1
102 #define HFS_BNODE_NEW           2
103 #define HFS_BNODE_DIRTY         3
104 #define HFS_BNODE_DELETED       4
105
106 /*
107  * HFS+ superblock info (built from Volume Header on disk)
108  */
109
110 struct hfsplus_vh;
111 struct hfs_btree;
112
113 struct hfsplus_sb_info {
114         void *s_vhdr_buf;
115         struct hfsplus_vh *s_vhdr;
116         void *s_backup_vhdr_buf;
117         struct hfsplus_vh *s_backup_vhdr;
118         struct hfs_btree *ext_tree;
119         struct hfs_btree *cat_tree;
120         struct hfs_btree *attr_tree;
121         struct inode *alloc_file;
122         struct inode *hidden_dir;
123         struct nls_table *nls;
124
125         /* Runtime variables */
126         u32 blockoffset;
127         sector_t part_start;
128         sector_t sect_count;
129         int fs_shift;
130
131         /* immutable data from the volume header */
132         u32 alloc_blksz;
133         int alloc_blksz_shift;
134         u32 total_blocks;
135         u32 data_clump_blocks, rsrc_clump_blocks;
136
137         /* mutable data from the volume header, protected by alloc_mutex */
138         u32 free_blocks;
139         struct mutex alloc_mutex;
140
141         /* mutable data from the volume header, protected by vh_mutex */
142         u32 next_cnid;
143         u32 file_count;
144         u32 folder_count;
145         struct mutex vh_mutex;
146
147         /* Config options */
148         u32 creator;
149         u32 type;
150
151         umode_t umask;
152         uid_t uid;
153         gid_t gid;
154
155         int part, session;
156
157         unsigned long flags;
158 };
159
160 #define HFSPLUS_SB_WRITEBACKUP  0
161 #define HFSPLUS_SB_NODECOMPOSE  1
162 #define HFSPLUS_SB_FORCE        2
163 #define HFSPLUS_SB_HFSX         3
164 #define HFSPLUS_SB_CASEFOLD     4
165 #define HFSPLUS_SB_NOBARRIER    5
166
167 static inline struct hfsplus_sb_info *HFSPLUS_SB(struct super_block *sb)
168 {
169         return sb->s_fs_info;
170 }
171
172
173 struct hfsplus_inode_info {
174         atomic_t opencnt;
175
176         /*
177          * Extent allocation information, protected by extents_lock.
178          */
179         u32 first_blocks;
180         u32 clump_blocks;
181         u32 alloc_blocks;
182         u32 cached_start;
183         u32 cached_blocks;
184         hfsplus_extent_rec first_extents;
185         hfsplus_extent_rec cached_extents;
186         unsigned int extent_state;
187         struct mutex extents_lock;
188
189         /*
190          * Immutable data.
191          */
192         struct inode *rsrc_inode;
193         __be32 create_date;
194
195         /*
196          * Protected by sbi->vh_mutex.
197          */
198         u32 linkid;
199
200         /*
201          * Accessed using atomic bitops.
202          */
203         unsigned long flags;
204
205         /*
206          * Protected by i_mutex.
207          */
208         sector_t fs_blocks;
209         u8 userflags;           /* BSD user file flags */
210         struct list_head open_dir_list;
211         loff_t phys_size;
212
213         struct inode vfs_inode;
214 };
215
216 #define HFSPLUS_EXT_DIRTY       0x0001
217 #define HFSPLUS_EXT_NEW         0x0002
218
219 #define HFSPLUS_I_RSRC          0       /* represents a resource fork */
220 #define HFSPLUS_I_CAT_DIRTY     1       /* has changes in the catalog tree */
221 #define HFSPLUS_I_EXT_DIRTY     2       /* has changes in the extent tree */
222 #define HFSPLUS_I_ALLOC_DIRTY   3       /* has changes in the allocation file */
223
224 #define HFSPLUS_IS_RSRC(inode) \
225         test_bit(HFSPLUS_I_RSRC, &HFSPLUS_I(inode)->flags)
226
227 static inline struct hfsplus_inode_info *HFSPLUS_I(struct inode *inode)
228 {
229         return list_entry(inode, struct hfsplus_inode_info, vfs_inode);
230 }
231
232 /*
233  * Mark an inode dirty, and also mark the btree in which the
234  * specific type of metadata is stored.
235  * For data or metadata that gets written back by into the catalog btree
236  * by hfsplus_write_inode a plain mark_inode_dirty call is enough.
237  */
238 static inline void hfsplus_mark_inode_dirty(struct inode *inode,
239                 unsigned int flag)
240 {
241         set_bit(flag, &HFSPLUS_I(inode)->flags);
242         mark_inode_dirty(inode);
243 }
244
245 struct hfs_find_data {
246         /* filled by caller */
247         hfsplus_btree_key *search_key;
248         hfsplus_btree_key *key;
249         /* filled by find */
250         struct hfs_btree *tree;
251         struct hfs_bnode *bnode;
252         /* filled by findrec */
253         int record;
254         int keyoffset, keylength;
255         int entryoffset, entrylength;
256 };
257
258 struct hfsplus_readdir_data {
259         struct list_head list;
260         struct file *file;
261         struct hfsplus_cat_key key;
262 };
263
264 /*
265  * Find minimum acceptible I/O size for an hfsplus sb.
266  */
267 static inline unsigned short hfsplus_min_io_size(struct super_block *sb)
268 {
269         return max_t(unsigned short, bdev_logical_block_size(sb->s_bdev),
270                      HFSPLUS_SECTOR_SIZE);
271 }
272
273 #define hfs_btree_open hfsplus_btree_open
274 #define hfs_btree_close hfsplus_btree_close
275 #define hfs_btree_write hfsplus_btree_write
276 #define hfs_bmap_alloc hfsplus_bmap_alloc
277 #define hfs_bmap_free hfsplus_bmap_free
278 #define hfs_bnode_read hfsplus_bnode_read
279 #define hfs_bnode_read_u16 hfsplus_bnode_read_u16
280 #define hfs_bnode_read_u8 hfsplus_bnode_read_u8
281 #define hfs_bnode_read_key hfsplus_bnode_read_key
282 #define hfs_bnode_write hfsplus_bnode_write
283 #define hfs_bnode_write_u16 hfsplus_bnode_write_u16
284 #define hfs_bnode_clear hfsplus_bnode_clear
285 #define hfs_bnode_copy hfsplus_bnode_copy
286 #define hfs_bnode_move hfsplus_bnode_move
287 #define hfs_bnode_dump hfsplus_bnode_dump
288 #define hfs_bnode_unlink hfsplus_bnode_unlink
289 #define hfs_bnode_findhash hfsplus_bnode_findhash
290 #define hfs_bnode_find hfsplus_bnode_find
291 #define hfs_bnode_unhash hfsplus_bnode_unhash
292 #define hfs_bnode_free hfsplus_bnode_free
293 #define hfs_bnode_create hfsplus_bnode_create
294 #define hfs_bnode_get hfsplus_bnode_get
295 #define hfs_bnode_put hfsplus_bnode_put
296 #define hfs_brec_lenoff hfsplus_brec_lenoff
297 #define hfs_brec_keylen hfsplus_brec_keylen
298 #define hfs_brec_insert hfsplus_brec_insert
299 #define hfs_brec_remove hfsplus_brec_remove
300 #define hfs_find_init hfsplus_find_init
301 #define hfs_find_exit hfsplus_find_exit
302 #define __hfs_brec_find __hplusfs_brec_find
303 #define hfs_brec_find hfsplus_brec_find
304 #define hfs_brec_read hfsplus_brec_read
305 #define hfs_brec_goto hfsplus_brec_goto
306 #define hfs_part_find hfsplus_part_find
307
308 /*
309  * definitions for ext2 flag ioctls (linux really needs a generic
310  * interface for this).
311  */
312
313 /* ext2 ioctls (EXT2_IOC_GETFLAGS and EXT2_IOC_SETFLAGS) to support
314  * chattr/lsattr */
315 #define HFSPLUS_IOC_EXT2_GETFLAGS       FS_IOC_GETFLAGS
316 #define HFSPLUS_IOC_EXT2_SETFLAGS       FS_IOC_SETFLAGS
317
318
319 /*
320  * hfs+-specific ioctl for making the filesystem bootable
321  */
322 #define HFSPLUS_IOC_BLESS _IO('h', 0x80)
323
324 /*
325  * Functions in any *.c used in other files
326  */
327
328 /* bitmap.c */
329 int hfsplus_block_allocate(struct super_block *, u32, u32, u32 *);
330 int hfsplus_block_free(struct super_block *, u32, u32);
331
332 /* btree.c */
333 struct hfs_btree *hfs_btree_open(struct super_block *, u32);
334 void hfs_btree_close(struct hfs_btree *);
335 void hfs_btree_write(struct hfs_btree *);
336 struct hfs_bnode *hfs_bmap_alloc(struct hfs_btree *);
337 void hfs_bmap_free(struct hfs_bnode *);
338
339 /* bnode.c */
340 void hfs_bnode_read(struct hfs_bnode *, void *, int, int);
341 u16 hfs_bnode_read_u16(struct hfs_bnode *, int);
342 u8 hfs_bnode_read_u8(struct hfs_bnode *, int);
343 void hfs_bnode_read_key(struct hfs_bnode *, void *, int);
344 void hfs_bnode_write(struct hfs_bnode *, void *, int, int);
345 void hfs_bnode_write_u16(struct hfs_bnode *, int, u16);
346 void hfs_bnode_clear(struct hfs_bnode *, int, int);
347 void hfs_bnode_copy(struct hfs_bnode *, int,
348                     struct hfs_bnode *, int, int);
349 void hfs_bnode_move(struct hfs_bnode *, int, int, int);
350 void hfs_bnode_dump(struct hfs_bnode *);
351 void hfs_bnode_unlink(struct hfs_bnode *);
352 struct hfs_bnode *hfs_bnode_findhash(struct hfs_btree *, u32);
353 struct hfs_bnode *hfs_bnode_find(struct hfs_btree *, u32);
354 void hfs_bnode_unhash(struct hfs_bnode *);
355 void hfs_bnode_free(struct hfs_bnode *);
356 struct hfs_bnode *hfs_bnode_create(struct hfs_btree *, u32);
357 void hfs_bnode_get(struct hfs_bnode *);
358 void hfs_bnode_put(struct hfs_bnode *);
359
360 /* brec.c */
361 u16 hfs_brec_lenoff(struct hfs_bnode *, u16, u16 *);
362 u16 hfs_brec_keylen(struct hfs_bnode *, u16);
363 int hfs_brec_insert(struct hfs_find_data *, void *, int);
364 int hfs_brec_remove(struct hfs_find_data *);
365
366 /* bfind.c */
367 int hfs_find_init(struct hfs_btree *, struct hfs_find_data *);
368 void hfs_find_exit(struct hfs_find_data *);
369 int __hfs_brec_find(struct hfs_bnode *, struct hfs_find_data *);
370 int hfs_brec_find(struct hfs_find_data *);
371 int hfs_brec_read(struct hfs_find_data *, void *, int);
372 int hfs_brec_goto(struct hfs_find_data *, int);
373
374 /* catalog.c */
375 int hfsplus_cat_case_cmp_key(const hfsplus_btree_key *,
376                 const hfsplus_btree_key *);
377 int hfsplus_cat_bin_cmp_key(const hfsplus_btree_key *,
378                 const hfsplus_btree_key *);
379 void hfsplus_cat_build_key(struct super_block *sb,
380                 hfsplus_btree_key *, u32, struct qstr *);
381 int hfsplus_find_cat(struct super_block *, u32, struct hfs_find_data *);
382 int hfsplus_create_cat(u32, struct inode *, struct qstr *, struct inode *);
383 int hfsplus_delete_cat(u32, struct inode *, struct qstr *);
384 int hfsplus_rename_cat(u32, struct inode *, struct qstr *,
385                        struct inode *, struct qstr *);
386 void hfsplus_cat_set_perms(struct inode *inode, struct hfsplus_perm *perms);
387
388 /* dir.c */
389 extern const struct inode_operations hfsplus_dir_inode_operations;
390 extern const struct file_operations hfsplus_dir_operations;
391
392 /* extents.c */
393 int hfsplus_ext_cmp_key(const hfsplus_btree_key *, const hfsplus_btree_key *);
394 int hfsplus_ext_write_extent(struct inode *);
395 int hfsplus_get_block(struct inode *, sector_t, struct buffer_head *, int);
396 int hfsplus_free_fork(struct super_block *, u32,
397                 struct hfsplus_fork_raw *, int);
398 int hfsplus_file_extend(struct inode *);
399 void hfsplus_file_truncate(struct inode *);
400
401 /* inode.c */
402 extern const struct address_space_operations hfsplus_aops;
403 extern const struct address_space_operations hfsplus_btree_aops;
404 extern const struct dentry_operations hfsplus_dentry_operations;
405
406 void hfsplus_inode_read_fork(struct inode *, struct hfsplus_fork_raw *);
407 void hfsplus_inode_write_fork(struct inode *, struct hfsplus_fork_raw *);
408 int hfsplus_cat_read_inode(struct inode *, struct hfs_find_data *);
409 int hfsplus_cat_write_inode(struct inode *);
410 struct inode *hfsplus_new_inode(struct super_block *, umode_t);
411 void hfsplus_delete_inode(struct inode *);
412 int hfsplus_file_fsync(struct file *file, loff_t start, loff_t end,
413                        int datasync);
414
415 /* ioctl.c */
416 long hfsplus_ioctl(struct file *filp, unsigned int cmd, unsigned long arg);
417 int hfsplus_setxattr(struct dentry *dentry, const char *name,
418                      const void *value, size_t size, int flags);
419 ssize_t hfsplus_getxattr(struct dentry *dentry, const char *name,
420                          void *value, size_t size);
421 ssize_t hfsplus_listxattr(struct dentry *dentry, char *buffer, size_t size);
422
423 /* options.c */
424 int hfsplus_parse_options(char *, struct hfsplus_sb_info *);
425 int hfsplus_parse_options_remount(char *input, int *force);
426 void hfsplus_fill_defaults(struct hfsplus_sb_info *);
427 int hfsplus_show_options(struct seq_file *, struct dentry *);
428
429 /* super.c */
430 struct inode *hfsplus_iget(struct super_block *, unsigned long);
431 int hfsplus_sync_fs(struct super_block *sb, int wait);
432
433 /* tables.c */
434 extern u16 hfsplus_case_fold_table[];
435 extern u16 hfsplus_decompose_table[];
436 extern u16 hfsplus_compose_table[];
437
438 /* unicode.c */
439 int hfsplus_strcasecmp(const struct hfsplus_unistr *,
440                 const struct hfsplus_unistr *);
441 int hfsplus_strcmp(const struct hfsplus_unistr *,
442                 const struct hfsplus_unistr *);
443 int hfsplus_uni2asc(struct super_block *,
444                 const struct hfsplus_unistr *, char *, int *);
445 int hfsplus_asc2uni(struct super_block *,
446                 struct hfsplus_unistr *, const char *, int);
447 int hfsplus_hash_dentry(const struct dentry *dentry,
448                 const struct inode *inode, struct qstr *str);
449 int hfsplus_compare_dentry(const struct dentry *parent,
450                 const struct inode *pinode,
451                 const struct dentry *dentry, const struct inode *inode,
452                 unsigned int len, const char *str, const struct qstr *name);
453
454 /* wrapper.c */
455 int hfsplus_read_wrapper(struct super_block *);
456 int hfs_part_find(struct super_block *, sector_t *, sector_t *);
457 int hfsplus_submit_bio(struct super_block *sb, sector_t sector,
458                 void *buf, void **data, int rw);
459
460 /* time macros */
461 #define __hfsp_mt2ut(t)         (be32_to_cpu(t) - 2082844800U)
462 #define __hfsp_ut2mt(t)         (cpu_to_be32(t + 2082844800U))
463
464 /* compatibility */
465 #define hfsp_mt2ut(t)           (struct timespec){ .tv_sec = __hfsp_mt2ut(t) }
466 #define hfsp_ut2mt(t)           __hfsp_ut2mt((t).tv_sec)
467 #define hfsp_now2mt()           __hfsp_ut2mt(get_seconds())
468
469 #endif