hfsplus: honor setgid flag on directories
[muen/linux.git] / fs / hfsplus / hfsplus_fs.h
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  *  linux/include/linux/hfsplus_fs.h
4  *
5  * Copyright (C) 1999
6  * Brad Boyer (flar@pants.nu)
7  * (C) 2003 Ardis Technologies <roman@ardistech.com>
8  *
9  */
10
11 #ifndef _LINUX_HFSPLUS_FS_H
12 #define _LINUX_HFSPLUS_FS_H
13
14 #ifdef pr_fmt
15 #undef pr_fmt
16 #endif
17
18 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
19
20 #include <linux/fs.h>
21 #include <linux/mutex.h>
22 #include <linux/buffer_head.h>
23 #include <linux/blkdev.h>
24 #include "hfsplus_raw.h"
25
26 #define DBG_BNODE_REFS  0x00000001
27 #define DBG_BNODE_MOD   0x00000002
28 #define DBG_CAT_MOD     0x00000004
29 #define DBG_INODE       0x00000008
30 #define DBG_SUPER       0x00000010
31 #define DBG_EXTENT      0x00000020
32 #define DBG_BITMAP      0x00000040
33 #define DBG_ATTR_MOD    0x00000080
34 #define DBG_ACL_MOD     0x00000100
35
36 #if 0
37 #define DBG_MASK        (DBG_EXTENT|DBG_INODE|DBG_BNODE_MOD)
38 #define DBG_MASK        (DBG_BNODE_MOD|DBG_CAT_MOD|DBG_INODE)
39 #define DBG_MASK        (DBG_CAT_MOD|DBG_BNODE_REFS|DBG_INODE|DBG_EXTENT)
40 #endif
41 #define DBG_MASK        (0)
42
43 #define hfs_dbg(flg, fmt, ...)                                  \
44 do {                                                            \
45         if (DBG_##flg & DBG_MASK)                               \
46                 printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__);  \
47 } while (0)
48
49 #define hfs_dbg_cont(flg, fmt, ...)                             \
50 do {                                                            \
51         if (DBG_##flg & DBG_MASK)                               \
52                 pr_cont(fmt, ##__VA_ARGS__);                    \
53 } while (0)
54
55 /* Runtime config options */
56 #define HFSPLUS_DEF_CR_TYPE    0x3F3F3F3F  /* '????' */
57
58 #define HFSPLUS_TYPE_DATA 0x00
59 #define HFSPLUS_TYPE_RSRC 0xFF
60
61 typedef int (*btree_keycmp)(const hfsplus_btree_key *,
62                 const hfsplus_btree_key *);
63
64 #define NODE_HASH_SIZE  256
65
66 /* B-tree mutex nested subclasses */
67 enum hfsplus_btree_mutex_classes {
68         CATALOG_BTREE_MUTEX,
69         EXTENTS_BTREE_MUTEX,
70         ATTR_BTREE_MUTEX,
71 };
72
73 /* An HFS+ BTree held in memory */
74 struct hfs_btree {
75         struct super_block *sb;
76         struct inode *inode;
77         btree_keycmp keycmp;
78
79         u32 cnid;
80         u32 root;
81         u32 leaf_count;
82         u32 leaf_head;
83         u32 leaf_tail;
84         u32 node_count;
85         u32 free_nodes;
86         u32 attributes;
87
88         unsigned int node_size;
89         unsigned int node_size_shift;
90         unsigned int max_key_len;
91         unsigned int depth;
92
93         struct mutex tree_lock;
94
95         unsigned int pages_per_bnode;
96         spinlock_t hash_lock;
97         struct hfs_bnode *node_hash[NODE_HASH_SIZE];
98         int node_hash_cnt;
99 };
100
101 struct page;
102
103 /* An HFS+ BTree node in memory */
104 struct hfs_bnode {
105         struct hfs_btree *tree;
106
107         u32 prev;
108         u32 this;
109         u32 next;
110         u32 parent;
111
112         u16 num_recs;
113         u8 type;
114         u8 height;
115
116         struct hfs_bnode *next_hash;
117         unsigned long flags;
118         wait_queue_head_t lock_wq;
119         atomic_t refcnt;
120         unsigned int page_offset;
121         struct page *page[0];
122 };
123
124 #define HFS_BNODE_LOCK          0
125 #define HFS_BNODE_ERROR         1
126 #define HFS_BNODE_NEW           2
127 #define HFS_BNODE_DIRTY         3
128 #define HFS_BNODE_DELETED       4
129
130 /*
131  * Attributes file states
132  */
133 #define HFSPLUS_EMPTY_ATTR_TREE         0
134 #define HFSPLUS_CREATING_ATTR_TREE      1
135 #define HFSPLUS_VALID_ATTR_TREE         2
136 #define HFSPLUS_FAILED_ATTR_TREE        3
137
138 /*
139  * HFS+ superblock info (built from Volume Header on disk)
140  */
141
142 struct hfsplus_vh;
143 struct hfs_btree;
144
145 struct hfsplus_sb_info {
146         void *s_vhdr_buf;
147         struct hfsplus_vh *s_vhdr;
148         void *s_backup_vhdr_buf;
149         struct hfsplus_vh *s_backup_vhdr;
150         struct hfs_btree *ext_tree;
151         struct hfs_btree *cat_tree;
152         struct hfs_btree *attr_tree;
153         atomic_t attr_tree_state;
154         struct inode *alloc_file;
155         struct inode *hidden_dir;
156         struct nls_table *nls;
157
158         /* Runtime variables */
159         u32 blockoffset;
160         sector_t part_start;
161         sector_t sect_count;
162         int fs_shift;
163
164         /* immutable data from the volume header */
165         u32 alloc_blksz;
166         int alloc_blksz_shift;
167         u32 total_blocks;
168         u32 data_clump_blocks, rsrc_clump_blocks;
169
170         /* mutable data from the volume header, protected by alloc_mutex */
171         u32 free_blocks;
172         struct mutex alloc_mutex;
173
174         /* mutable data from the volume header, protected by vh_mutex */
175         u32 next_cnid;
176         u32 file_count;
177         u32 folder_count;
178         struct mutex vh_mutex;
179
180         /* Config options */
181         u32 creator;
182         u32 type;
183
184         umode_t umask;
185         kuid_t uid;
186         kgid_t gid;
187
188         int part, session;
189         unsigned long flags;
190
191         int work_queued;               /* non-zero delayed work is queued */
192         struct delayed_work sync_work; /* FS sync delayed work */
193         spinlock_t work_lock;          /* protects sync_work and work_queued */
194 };
195
196 #define HFSPLUS_SB_WRITEBACKUP  0
197 #define HFSPLUS_SB_NODECOMPOSE  1
198 #define HFSPLUS_SB_FORCE        2
199 #define HFSPLUS_SB_HFSX         3
200 #define HFSPLUS_SB_CASEFOLD     4
201 #define HFSPLUS_SB_NOBARRIER    5
202
203 static inline struct hfsplus_sb_info *HFSPLUS_SB(struct super_block *sb)
204 {
205         return sb->s_fs_info;
206 }
207
208
209 struct hfsplus_inode_info {
210         atomic_t opencnt;
211
212         /*
213          * Extent allocation information, protected by extents_lock.
214          */
215         u32 first_blocks;
216         u32 clump_blocks;
217         u32 alloc_blocks;
218         u32 cached_start;
219         u32 cached_blocks;
220         hfsplus_extent_rec first_extents;
221         hfsplus_extent_rec cached_extents;
222         unsigned int extent_state;
223         struct mutex extents_lock;
224
225         /*
226          * Immutable data.
227          */
228         struct inode *rsrc_inode;
229         __be32 create_date;
230
231         /*
232          * Protected by sbi->vh_mutex.
233          */
234         u32 linkid;
235
236         /*
237          * Accessed using atomic bitops.
238          */
239         unsigned long flags;
240
241         /*
242          * Protected by i_mutex.
243          */
244         sector_t fs_blocks;
245         u8 userflags;           /* BSD user file flags */
246         u32 subfolders;         /* Subfolder count (HFSX only) */
247         struct list_head open_dir_list;
248         spinlock_t open_dir_lock;
249         loff_t phys_size;
250
251         struct inode vfs_inode;
252 };
253
254 #define HFSPLUS_EXT_DIRTY       0x0001
255 #define HFSPLUS_EXT_NEW         0x0002
256
257 #define HFSPLUS_I_RSRC          0       /* represents a resource fork */
258 #define HFSPLUS_I_CAT_DIRTY     1       /* has changes in the catalog tree */
259 #define HFSPLUS_I_EXT_DIRTY     2       /* has changes in the extent tree */
260 #define HFSPLUS_I_ALLOC_DIRTY   3       /* has changes in the allocation file */
261 #define HFSPLUS_I_ATTR_DIRTY    4       /* has changes in the attributes tree */
262
263 #define HFSPLUS_IS_RSRC(inode) \
264         test_bit(HFSPLUS_I_RSRC, &HFSPLUS_I(inode)->flags)
265
266 static inline struct hfsplus_inode_info *HFSPLUS_I(struct inode *inode)
267 {
268         return container_of(inode, struct hfsplus_inode_info, vfs_inode);
269 }
270
271 /*
272  * Mark an inode dirty, and also mark the btree in which the
273  * specific type of metadata is stored.
274  * For data or metadata that gets written back by into the catalog btree
275  * by hfsplus_write_inode a plain mark_inode_dirty call is enough.
276  */
277 static inline void hfsplus_mark_inode_dirty(struct inode *inode,
278                 unsigned int flag)
279 {
280         set_bit(flag, &HFSPLUS_I(inode)->flags);
281         mark_inode_dirty(inode);
282 }
283
284 struct hfs_find_data {
285         /* filled by caller */
286         hfsplus_btree_key *search_key;
287         hfsplus_btree_key *key;
288         /* filled by find */
289         struct hfs_btree *tree;
290         struct hfs_bnode *bnode;
291         /* filled by findrec */
292         int record;
293         int keyoffset, keylength;
294         int entryoffset, entrylength;
295 };
296
297 struct hfsplus_readdir_data {
298         struct list_head list;
299         struct file *file;
300         struct hfsplus_cat_key key;
301 };
302
303 /*
304  * Find minimum acceptible I/O size for an hfsplus sb.
305  */
306 static inline unsigned short hfsplus_min_io_size(struct super_block *sb)
307 {
308         return max_t(unsigned short, bdev_logical_block_size(sb->s_bdev),
309                      HFSPLUS_SECTOR_SIZE);
310 }
311
312 #define hfs_btree_open hfsplus_btree_open
313 #define hfs_btree_close hfsplus_btree_close
314 #define hfs_btree_write hfsplus_btree_write
315 #define hfs_bmap_alloc hfsplus_bmap_alloc
316 #define hfs_bmap_free hfsplus_bmap_free
317 #define hfs_bnode_read hfsplus_bnode_read
318 #define hfs_bnode_read_u16 hfsplus_bnode_read_u16
319 #define hfs_bnode_read_u8 hfsplus_bnode_read_u8
320 #define hfs_bnode_read_key hfsplus_bnode_read_key
321 #define hfs_bnode_write hfsplus_bnode_write
322 #define hfs_bnode_write_u16 hfsplus_bnode_write_u16
323 #define hfs_bnode_clear hfsplus_bnode_clear
324 #define hfs_bnode_copy hfsplus_bnode_copy
325 #define hfs_bnode_move hfsplus_bnode_move
326 #define hfs_bnode_dump hfsplus_bnode_dump
327 #define hfs_bnode_unlink hfsplus_bnode_unlink
328 #define hfs_bnode_findhash hfsplus_bnode_findhash
329 #define hfs_bnode_find hfsplus_bnode_find
330 #define hfs_bnode_unhash hfsplus_bnode_unhash
331 #define hfs_bnode_free hfsplus_bnode_free
332 #define hfs_bnode_create hfsplus_bnode_create
333 #define hfs_bnode_get hfsplus_bnode_get
334 #define hfs_bnode_put hfsplus_bnode_put
335 #define hfs_brec_lenoff hfsplus_brec_lenoff
336 #define hfs_brec_keylen hfsplus_brec_keylen
337 #define hfs_brec_insert hfsplus_brec_insert
338 #define hfs_brec_remove hfsplus_brec_remove
339 #define hfs_find_init hfsplus_find_init
340 #define hfs_find_exit hfsplus_find_exit
341 #define __hfs_brec_find __hfsplus_brec_find
342 #define hfs_brec_find hfsplus_brec_find
343 #define hfs_brec_read hfsplus_brec_read
344 #define hfs_brec_goto hfsplus_brec_goto
345 #define hfs_part_find hfsplus_part_find
346
347 /*
348  * definitions for ext2 flag ioctls (linux really needs a generic
349  * interface for this).
350  */
351
352 /* ext2 ioctls (EXT2_IOC_GETFLAGS and EXT2_IOC_SETFLAGS) to support
353  * chattr/lsattr */
354 #define HFSPLUS_IOC_EXT2_GETFLAGS       FS_IOC_GETFLAGS
355 #define HFSPLUS_IOC_EXT2_SETFLAGS       FS_IOC_SETFLAGS
356
357
358 /*
359  * hfs+-specific ioctl for making the filesystem bootable
360  */
361 #define HFSPLUS_IOC_BLESS _IO('h', 0x80)
362
363 typedef int (*search_strategy_t)(struct hfs_bnode *,
364                                 struct hfs_find_data *,
365                                 int *, int *, int *);
366
367 /*
368  * Functions in any *.c used in other files
369  */
370
371 /* attributes.c */
372 int __init hfsplus_create_attr_tree_cache(void);
373 void hfsplus_destroy_attr_tree_cache(void);
374 int hfsplus_attr_bin_cmp_key(const hfsplus_btree_key *k1,
375                              const hfsplus_btree_key *k2);
376 int hfsplus_attr_build_key(struct super_block *sb, hfsplus_btree_key *key,
377                            u32 cnid, const char *name);
378 hfsplus_attr_entry *hfsplus_alloc_attr_entry(void);
379 void hfsplus_destroy_attr_entry(hfsplus_attr_entry *entry);
380 int hfsplus_find_attr(struct super_block *sb, u32 cnid, const char *name,
381                       struct hfs_find_data *fd);
382 int hfsplus_attr_exists(struct inode *inode, const char *name);
383 int hfsplus_create_attr(struct inode *inode, const char *name,
384                         const void *value, size_t size);
385 int hfsplus_delete_attr(struct inode *inode, const char *name);
386 int hfsplus_delete_all_attrs(struct inode *dir, u32 cnid);
387
388 /* bitmap.c */
389 int hfsplus_block_allocate(struct super_block *sb, u32 size, u32 offset,
390                            u32 *max);
391 int hfsplus_block_free(struct super_block *sb, u32 offset, u32 count);
392
393 /* btree.c */
394 u32 hfsplus_calc_btree_clump_size(u32 block_size, u32 node_size, u64 sectors,
395                                   int file_id);
396 struct hfs_btree *hfs_btree_open(struct super_block *sb, u32 id);
397 void hfs_btree_close(struct hfs_btree *tree);
398 int hfs_btree_write(struct hfs_btree *tree);
399 struct hfs_bnode *hfs_bmap_alloc(struct hfs_btree *tree);
400 void hfs_bmap_free(struct hfs_bnode *node);
401
402 /* bnode.c */
403 void hfs_bnode_read(struct hfs_bnode *node, void *buf, int off, int len);
404 u16 hfs_bnode_read_u16(struct hfs_bnode *node, int off);
405 u8 hfs_bnode_read_u8(struct hfs_bnode *node, int off);
406 void hfs_bnode_read_key(struct hfs_bnode *node, void *key, int off);
407 void hfs_bnode_write(struct hfs_bnode *node, void *buf, int off, int len);
408 void hfs_bnode_write_u16(struct hfs_bnode *node, int off, u16 data);
409 void hfs_bnode_clear(struct hfs_bnode *node, int off, int len);
410 void hfs_bnode_copy(struct hfs_bnode *dst_node, int dst,
411                     struct hfs_bnode *src_node, int src, int len);
412 void hfs_bnode_move(struct hfs_bnode *node, int dst, int src, int len);
413 void hfs_bnode_dump(struct hfs_bnode *node);
414 void hfs_bnode_unlink(struct hfs_bnode *node);
415 struct hfs_bnode *hfs_bnode_findhash(struct hfs_btree *tree, u32 cnid);
416 void hfs_bnode_unhash(struct hfs_bnode *node);
417 struct hfs_bnode *hfs_bnode_find(struct hfs_btree *tree, u32 num);
418 void hfs_bnode_free(struct hfs_bnode *node);
419 struct hfs_bnode *hfs_bnode_create(struct hfs_btree *tree, u32 num);
420 void hfs_bnode_get(struct hfs_bnode *node);
421 void hfs_bnode_put(struct hfs_bnode *node);
422 bool hfs_bnode_need_zeroout(struct hfs_btree *tree);
423
424 /* brec.c */
425 u16 hfs_brec_lenoff(struct hfs_bnode *node, u16 rec, u16 *off);
426 u16 hfs_brec_keylen(struct hfs_bnode *node, u16 rec);
427 int hfs_brec_insert(struct hfs_find_data *fd, void *entry, int entry_len);
428 int hfs_brec_remove(struct hfs_find_data *fd);
429
430 /* bfind.c */
431 int hfs_find_init(struct hfs_btree *tree, struct hfs_find_data *fd);
432 void hfs_find_exit(struct hfs_find_data *fd);
433 int hfs_find_1st_rec_by_cnid(struct hfs_bnode *bnode, struct hfs_find_data *fd,
434                              int *begin, int *end, int *cur_rec);
435 int hfs_find_rec_by_key(struct hfs_bnode *bnode, struct hfs_find_data *fd,
436                         int *begin, int *end, int *cur_rec);
437 int __hfs_brec_find(struct hfs_bnode *bnode, struct hfs_find_data *fd,
438                     search_strategy_t rec_found);
439 int hfs_brec_find(struct hfs_find_data *fd, search_strategy_t do_key_compare);
440 int hfs_brec_read(struct hfs_find_data *fd, void *rec, int rec_len);
441 int hfs_brec_goto(struct hfs_find_data *fd, int cnt);
442
443 /* catalog.c */
444 int hfsplus_cat_case_cmp_key(const hfsplus_btree_key *k1,
445                              const hfsplus_btree_key *k2);
446 int hfsplus_cat_bin_cmp_key(const hfsplus_btree_key *k1,
447                             const hfsplus_btree_key *k2);
448 int hfsplus_cat_build_key(struct super_block *sb, hfsplus_btree_key *key,
449                            u32 parent, const struct qstr *str);
450 void hfsplus_cat_build_key_with_cnid(struct super_block *sb,
451                                      hfsplus_btree_key *key, u32 parent);
452 void hfsplus_cat_set_perms(struct inode *inode, struct hfsplus_perm *perms);
453 int hfsplus_find_cat(struct super_block *sb, u32 cnid,
454                      struct hfs_find_data *fd);
455 int hfsplus_create_cat(u32 cnid, struct inode *dir, const struct qstr *str,
456                        struct inode *inode);
457 int hfsplus_delete_cat(u32 cnid, struct inode *dir, const struct qstr *str);
458 int hfsplus_rename_cat(u32 cnid, struct inode *src_dir, const struct qstr *src_name,
459                        struct inode *dst_dir, const struct qstr *dst_name);
460
461 /* dir.c */
462 extern const struct inode_operations hfsplus_dir_inode_operations;
463 extern const struct file_operations hfsplus_dir_operations;
464
465 /* extents.c */
466 int hfsplus_ext_cmp_key(const hfsplus_btree_key *k1,
467                         const hfsplus_btree_key *k2);
468 int hfsplus_ext_write_extent(struct inode *inode);
469 int hfsplus_get_block(struct inode *inode, sector_t iblock,
470                       struct buffer_head *bh_result, int create);
471 int hfsplus_free_fork(struct super_block *sb, u32 cnid,
472                       struct hfsplus_fork_raw *fork, int type);
473 int hfsplus_file_extend(struct inode *inode, bool zeroout);
474 void hfsplus_file_truncate(struct inode *inode);
475
476 /* inode.c */
477 extern const struct address_space_operations hfsplus_aops;
478 extern const struct address_space_operations hfsplus_btree_aops;
479 extern const struct dentry_operations hfsplus_dentry_operations;
480
481 struct inode *hfsplus_new_inode(struct super_block *sb, struct inode *dir,
482                                 umode_t mode);
483 void hfsplus_delete_inode(struct inode *inode);
484 void hfsplus_inode_read_fork(struct inode *inode,
485                              struct hfsplus_fork_raw *fork);
486 void hfsplus_inode_write_fork(struct inode *inode,
487                               struct hfsplus_fork_raw *fork);
488 int hfsplus_cat_read_inode(struct inode *inode, struct hfs_find_data *fd);
489 int hfsplus_cat_write_inode(struct inode *inode);
490 int hfsplus_file_fsync(struct file *file, loff_t start, loff_t end,
491                        int datasync);
492
493 /* ioctl.c */
494 long hfsplus_ioctl(struct file *filp, unsigned int cmd, unsigned long arg);
495
496 /* options.c */
497 void hfsplus_fill_defaults(struct hfsplus_sb_info *opts);
498 int hfsplus_parse_options_remount(char *input, int *force);
499 int hfsplus_parse_options(char *input, struct hfsplus_sb_info *sbi);
500 int hfsplus_show_options(struct seq_file *seq, struct dentry *root);
501
502 /* part_tbl.c */
503 int hfs_part_find(struct super_block *sb, sector_t *part_start,
504                   sector_t *part_size);
505
506 /* super.c */
507 struct inode *hfsplus_iget(struct super_block *sb, unsigned long ino);
508 void hfsplus_mark_mdb_dirty(struct super_block *sb);
509
510 /* tables.c */
511 extern u16 hfsplus_case_fold_table[];
512 extern u16 hfsplus_decompose_table[];
513 extern u16 hfsplus_compose_table[];
514
515 /* unicode.c */
516 int hfsplus_strcasecmp(const struct hfsplus_unistr *s1,
517                        const struct hfsplus_unistr *s2);
518 int hfsplus_strcmp(const struct hfsplus_unistr *s1,
519                    const struct hfsplus_unistr *s2);
520 int hfsplus_uni2asc(struct super_block *sb, const struct hfsplus_unistr *ustr,
521                     char *astr, int *len_p);
522 int hfsplus_asc2uni(struct super_block *sb, struct hfsplus_unistr *ustr,
523                     int max_unistr_len, const char *astr, int len);
524 int hfsplus_hash_dentry(const struct dentry *dentry, struct qstr *str);
525 int hfsplus_compare_dentry(const struct dentry *dentry, unsigned int len,
526                            const char *str, const struct qstr *name);
527
528 /* wrapper.c */
529 int hfsplus_submit_bio(struct super_block *sb, sector_t sector, void *buf,
530                        void **data, int op, int op_flags);
531 int hfsplus_read_wrapper(struct super_block *sb);
532
533 /* time macros */
534 #define __hfsp_mt2ut(t)         (be32_to_cpu(t) - 2082844800U)
535 #define __hfsp_ut2mt(t)         (cpu_to_be32(t + 2082844800U))
536
537 /* compatibility */
538 #define hfsp_mt2ut(t)           (struct timespec){ .tv_sec = __hfsp_mt2ut(t) }
539 #define hfsp_ut2mt(t)           __hfsp_ut2mt((t).tv_sec)
540 #define hfsp_now2mt()           __hfsp_ut2mt(get_seconds())
541
542 #endif