xref: /openbmc/linux/fs/hfsplus/hfsplus_fs.h (revision 87c2ce3b)
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)(hfsplus_btree_key *, 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 	atomic_t inode_cnt;
147 	u32 last_inode_cnt;
148 
149 	struct hlist_head rsrc_inodes;
150 };
151 
152 #define HFSPLUS_SB_WRITEBACKUP	0x0001
153 #define HFSPLUS_SB_NODECOMPOSE	0x0002
154 #define HFSPLUS_SB_FORCE	0x0004
155 
156 
157 struct hfsplus_inode_info {
158 	struct semaphore extents_lock;
159 	u32 clump_blocks, alloc_blocks;
160 	sector_t fs_blocks;
161 	/* Allocation extents from catalog record or volume header */
162 	hfsplus_extent_rec first_extents;
163 	u32 first_blocks;
164 	hfsplus_extent_rec cached_extents;
165 	u32 cached_start, cached_blocks;
166 	atomic_t opencnt;
167 
168 	struct inode *rsrc_inode;
169 	unsigned long flags;
170 
171 	/* Device number in hfsplus_permissions in catalog */
172 	u32 dev;
173 	/* BSD system and user file flags */
174 	u8 rootflags;
175 	u8 userflags;
176 
177 	struct list_head open_dir_list;
178 	loff_t phys_size;
179 	struct inode vfs_inode;
180 };
181 
182 #define HFSPLUS_FLG_RSRC	0x0001
183 #define HFSPLUS_FLG_EXT_DIRTY	0x0002
184 #define HFSPLUS_FLG_EXT_NEW	0x0004
185 
186 #define HFSPLUS_IS_DATA(inode)   (!(HFSPLUS_I(inode).flags & HFSPLUS_FLG_RSRC))
187 #define HFSPLUS_IS_RSRC(inode)   (HFSPLUS_I(inode).flags & HFSPLUS_FLG_RSRC)
188 
189 struct hfs_find_data {
190 	/* filled by caller */
191 	hfsplus_btree_key *search_key;
192 	hfsplus_btree_key *key;
193 	/* filled by find */
194 	struct hfs_btree *tree;
195 	struct hfs_bnode *bnode;
196 	/* filled by findrec */
197 	int record;
198 	int keyoffset, keylength;
199 	int entryoffset, entrylength;
200 };
201 
202 struct hfsplus_readdir_data {
203 	struct list_head list;
204 	struct file *file;
205 	struct hfsplus_cat_key key;
206 };
207 
208 #define hfs_btree_open hfsplus_btree_open
209 #define hfs_btree_close hfsplus_btree_close
210 #define hfs_btree_write hfsplus_btree_write
211 #define hfs_bmap_alloc hfsplus_bmap_alloc
212 #define hfs_bmap_free hfsplus_bmap_free
213 #define hfs_bnode_read hfsplus_bnode_read
214 #define hfs_bnode_read_u16 hfsplus_bnode_read_u16
215 #define hfs_bnode_read_u8 hfsplus_bnode_read_u8
216 #define hfs_bnode_read_key hfsplus_bnode_read_key
217 #define hfs_bnode_write hfsplus_bnode_write
218 #define hfs_bnode_write_u16 hfsplus_bnode_write_u16
219 #define hfs_bnode_clear hfsplus_bnode_clear
220 #define hfs_bnode_copy hfsplus_bnode_copy
221 #define hfs_bnode_move hfsplus_bnode_move
222 #define hfs_bnode_dump hfsplus_bnode_dump
223 #define hfs_bnode_unlink hfsplus_bnode_unlink
224 #define hfs_bnode_findhash hfsplus_bnode_findhash
225 #define hfs_bnode_find hfsplus_bnode_find
226 #define hfs_bnode_unhash hfsplus_bnode_unhash
227 #define hfs_bnode_free hfsplus_bnode_free
228 #define hfs_bnode_create hfsplus_bnode_create
229 #define hfs_bnode_get hfsplus_bnode_get
230 #define hfs_bnode_put hfsplus_bnode_put
231 #define hfs_brec_lenoff hfsplus_brec_lenoff
232 #define hfs_brec_keylen hfsplus_brec_keylen
233 #define hfs_brec_insert hfsplus_brec_insert
234 #define hfs_brec_remove hfsplus_brec_remove
235 #define hfs_find_init hfsplus_find_init
236 #define hfs_find_exit hfsplus_find_exit
237 #define __hfs_brec_find __hplusfs_brec_find
238 #define hfs_brec_find hfsplus_brec_find
239 #define hfs_brec_read hfsplus_brec_read
240 #define hfs_brec_goto hfsplus_brec_goto
241 #define hfs_part_find hfsplus_part_find
242 
243 /*
244  * definitions for ext2 flag ioctls (linux really needs a generic
245  * interface for this).
246  */
247 
248 /* ext2 ioctls (EXT2_IOC_GETFLAGS and EXT2_IOC_SETFLAGS) to support
249  * chattr/lsattr */
250 #define HFSPLUS_IOC_EXT2_GETFLAGS	_IOR('f', 1, long)
251 #define HFSPLUS_IOC_EXT2_SETFLAGS	_IOW('f', 2, long)
252 
253 #define EXT2_FLAG_IMMUTABLE		0x00000010 /* Immutable file */
254 #define EXT2_FLAG_APPEND		0x00000020 /* writes to file may only append */
255 #define EXT2_FLAG_NODUMP		0x00000040 /* do not dump file */
256 
257 
258 /*
259  * Functions in any *.c used in other files
260  */
261 
262 /* bitmap.c */
263 int hfsplus_block_allocate(struct super_block *, u32, u32, u32 *);
264 int hfsplus_block_free(struct super_block *, u32, u32);
265 
266 /* btree.c */
267 struct hfs_btree *hfs_btree_open(struct super_block *, u32);
268 void hfs_btree_close(struct hfs_btree *);
269 void hfs_btree_write(struct hfs_btree *);
270 struct hfs_bnode *hfs_bmap_alloc(struct hfs_btree *);
271 void hfs_bmap_free(struct hfs_bnode *);
272 
273 /* bnode.c */
274 void hfs_bnode_read(struct hfs_bnode *, void *, int, int);
275 u16 hfs_bnode_read_u16(struct hfs_bnode *, int);
276 u8 hfs_bnode_read_u8(struct hfs_bnode *, int);
277 void hfs_bnode_read_key(struct hfs_bnode *, void *, int);
278 void hfs_bnode_write(struct hfs_bnode *, void *, int, int);
279 void hfs_bnode_write_u16(struct hfs_bnode *, int, u16);
280 void hfs_bnode_clear(struct hfs_bnode *, int, int);
281 void hfs_bnode_copy(struct hfs_bnode *, int,
282 		    struct hfs_bnode *, int, int);
283 void hfs_bnode_move(struct hfs_bnode *, int, int, int);
284 void hfs_bnode_dump(struct hfs_bnode *);
285 void hfs_bnode_unlink(struct hfs_bnode *);
286 struct hfs_bnode *hfs_bnode_findhash(struct hfs_btree *, u32);
287 struct hfs_bnode *hfs_bnode_find(struct hfs_btree *, u32);
288 void hfs_bnode_unhash(struct hfs_bnode *);
289 void hfs_bnode_free(struct hfs_bnode *);
290 struct hfs_bnode *hfs_bnode_create(struct hfs_btree *, u32);
291 void hfs_bnode_get(struct hfs_bnode *);
292 void hfs_bnode_put(struct hfs_bnode *);
293 
294 /* brec.c */
295 u16 hfs_brec_lenoff(struct hfs_bnode *, u16, u16 *);
296 u16 hfs_brec_keylen(struct hfs_bnode *, u16);
297 int hfs_brec_insert(struct hfs_find_data *, void *, int);
298 int hfs_brec_remove(struct hfs_find_data *);
299 
300 /* bfind.c */
301 int hfs_find_init(struct hfs_btree *, struct hfs_find_data *);
302 void hfs_find_exit(struct hfs_find_data *);
303 int __hfs_brec_find(struct hfs_bnode *, struct hfs_find_data *);
304 int hfs_brec_find(struct hfs_find_data *);
305 int hfs_brec_read(struct hfs_find_data *, void *, int);
306 int hfs_brec_goto(struct hfs_find_data *, int);
307 
308 /* catalog.c */
309 int hfsplus_cat_cmp_key(hfsplus_btree_key *, hfsplus_btree_key *);
310 void hfsplus_cat_build_key(struct super_block *sb, hfsplus_btree_key *, u32, struct qstr *);
311 int hfsplus_find_cat(struct super_block *, u32, struct hfs_find_data *);
312 int hfsplus_create_cat(u32, struct inode *, struct qstr *, struct inode *);
313 int hfsplus_delete_cat(u32, struct inode *, struct qstr *);
314 int hfsplus_rename_cat(u32, struct inode *, struct qstr *,
315 		       struct inode *, struct qstr *);
316 
317 /* extents.c */
318 int hfsplus_ext_cmp_key(hfsplus_btree_key *, hfsplus_btree_key *);
319 void hfsplus_ext_write_extent(struct inode *);
320 int hfsplus_get_block(struct inode *, sector_t, struct buffer_head *, int);
321 int hfsplus_free_fork(struct super_block *, u32, struct hfsplus_fork_raw *, int);
322 int hfsplus_file_extend(struct inode *);
323 void hfsplus_file_truncate(struct inode *);
324 
325 /* inode.c */
326 extern struct address_space_operations hfsplus_aops;
327 extern struct address_space_operations hfsplus_btree_aops;
328 
329 void hfsplus_inode_read_fork(struct inode *, struct hfsplus_fork_raw *);
330 void hfsplus_inode_write_fork(struct inode *, struct hfsplus_fork_raw *);
331 int hfsplus_cat_read_inode(struct inode *, struct hfs_find_data *);
332 int hfsplus_cat_write_inode(struct inode *);
333 struct inode *hfsplus_new_inode(struct super_block *, int);
334 void hfsplus_delete_inode(struct inode *);
335 
336 /* ioctl.c */
337 int hfsplus_ioctl(struct inode *inode, struct file *filp, unsigned int cmd,
338 		  unsigned long arg);
339 int hfsplus_setxattr(struct dentry *dentry, const char *name,
340 		     const void *value, size_t size, int flags);
341 ssize_t hfsplus_getxattr(struct dentry *dentry, const char *name,
342 			 void *value, size_t size);
343 ssize_t hfsplus_listxattr(struct dentry *dentry, char *buffer, size_t size);
344 
345 /* options.c */
346 int hfsplus_parse_options(char *, struct hfsplus_sb_info *);
347 void hfsplus_fill_defaults(struct hfsplus_sb_info *);
348 int hfsplus_show_options(struct seq_file *, struct vfsmount *);
349 
350 /* tables.c */
351 extern u16 hfsplus_case_fold_table[];
352 extern u16 hfsplus_decompose_table[];
353 extern u16 hfsplus_compose_table[];
354 
355 /* unicode.c */
356 int hfsplus_unistrcmp(const struct hfsplus_unistr *, const struct hfsplus_unistr *);
357 int hfsplus_uni2asc(struct super_block *, const struct hfsplus_unistr *, char *, int *);
358 int hfsplus_asc2uni(struct super_block *, struct hfsplus_unistr *, const char *, int);
359 
360 /* wrapper.c */
361 int hfsplus_read_wrapper(struct super_block *);
362 
363 int hfs_part_find(struct super_block *, sector_t *, sector_t *);
364 
365 /* access macros */
366 /*
367 static inline struct hfsplus_sb_info *HFSPLUS_SB(struct super_block *sb)
368 {
369 	return sb->s_fs_info;
370 }
371 static inline struct hfsplus_inode_info *HFSPLUS_I(struct inode *inode)
372 {
373 	return list_entry(inode, struct hfsplus_inode_info, vfs_inode);
374 }
375 */
376 #define HFSPLUS_SB(super)	(*(struct hfsplus_sb_info *)(super)->s_fs_info)
377 #define HFSPLUS_I(inode)	(*list_entry(inode, struct hfsplus_inode_info, vfs_inode))
378 
379 #if 1
380 #define hfsplus_kmap(p)		({ struct page *__p = (p); kmap(__p); })
381 #define hfsplus_kunmap(p)	({ struct page *__p = (p); kunmap(__p); __p; })
382 #else
383 #define hfsplus_kmap(p)		kmap(p)
384 #define hfsplus_kunmap(p)	kunmap(p)
385 #endif
386 
387 #define sb_bread512(sb, sec, data) ({			\
388 	struct buffer_head *__bh;			\
389 	sector_t __block;				\
390 	loff_t __start;					\
391 	int __offset;					\
392 							\
393 	__start = (loff_t)(sec) << HFSPLUS_SECTOR_SHIFT;\
394 	__block = __start >> (sb)->s_blocksize_bits;	\
395 	__offset = __start & ((sb)->s_blocksize - 1);	\
396 	__bh = sb_bread((sb), __block);			\
397 	if (likely(__bh != NULL))			\
398 		data = (void *)(__bh->b_data + __offset);\
399 	else						\
400 		data = NULL;				\
401 	__bh;						\
402 })
403 
404 /* time macros */
405 #define __hfsp_mt2ut(t)		(be32_to_cpu(t) - 2082844800U)
406 #define __hfsp_ut2mt(t)		(cpu_to_be32(t + 2082844800U))
407 
408 /* compatibility */
409 #define hfsp_mt2ut(t)		(struct timespec){ .tv_sec = __hfsp_mt2ut(t) }
410 #define hfsp_ut2mt(t)		__hfsp_ut2mt((t).tv_sec)
411 #define hfsp_now2mt()		__hfsp_ut2mt(get_seconds())
412 
413 #define kdev_t_to_nr(x)		(x)
414 
415 #endif
416