linux/fs/hfsplus/hfsplus_fs.h
<<
>>
Prefs
   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
  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
  40#define DBG_MASK        (0)
  41
  42#define hfs_dbg(flg, fmt, ...)                                  \
  43do {                                                            \
  44        if (DBG_##flg & DBG_MASK)                               \
  45                printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__);  \
  46} while (0)
  47
  48#define hfs_dbg_cont(flg, fmt, ...)                             \
  49do {                                                            \
  50        if (DBG_##flg & DBG_MASK)                               \
  51                pr_cont(fmt, ##__VA_ARGS__);                    \
  52} while (0)
  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
  60typedef int (*btree_keycmp)(const hfsplus_btree_key *,
  61                const hfsplus_btree_key *);
  62
  63#define NODE_HASH_SIZE  256
  64
  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
  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
  92        struct mutex tree_lock;
  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
 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
 137/*
 138 * HFS+ superblock info (built from Volume Header on disk)
 139 */
 140
 141struct hfsplus_vh;
 142struct hfs_btree;
 143
 144struct hfsplus_sb_info {
 145        void *s_vhdr_buf;
 146        struct hfsplus_vh *s_vhdr;
 147        void *s_backup_vhdr_buf;
 148        struct hfsplus_vh *s_backup_vhdr;
 149        struct hfs_btree *ext_tree;
 150        struct hfs_btree *cat_tree;
 151        struct hfs_btree *attr_tree;
 152        atomic_t attr_tree_state;
 153        struct inode *alloc_file;
 154        struct inode *hidden_dir;
 155        struct nls_table *nls;
 156
 157        /* Runtime variables */
 158        u32 blockoffset;
 159        sector_t part_start;
 160        sector_t sect_count;
 161        int fs_shift;
 162
 163        /* immutable data from the volume header */
 164        u32 alloc_blksz;
 165        int alloc_blksz_shift;
 166        u32 total_blocks;
 167        u32 data_clump_blocks, rsrc_clump_blocks;
 168
 169        /* mutable data from the volume header, protected by alloc_mutex */
 170        u32 free_blocks;
 171        struct mutex alloc_mutex;
 172
 173        /* mutable data from the volume header, protected by vh_mutex */
 174        u32 next_cnid;
 175        u32 file_count;
 176        u32 folder_count;
 177        struct mutex vh_mutex;
 178
 179        /* Config options */
 180        u32 creator;
 181        u32 type;
 182
 183        umode_t umask;
 184        kuid_t uid;
 185        kgid_t gid;
 186
 187        int part, session;
 188        unsigned long flags;
 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 */
 193};
 194
 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
 200#define HFSPLUS_SB_NOBARRIER    5
 201
 202static inline struct hfsplus_sb_info *HFSPLUS_SB(struct super_block *sb)
 203{
 204        return sb->s_fs_info;
 205}
 206
 207
 208struct hfsplus_inode_info {
 209        atomic_t opencnt;
 210
 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;
 221        unsigned int extent_state;
 222        struct mutex extents_lock;
 223
 224        /*
 225         * Immutable data.
 226         */
 227        struct inode *rsrc_inode;
 228        __be32 create_date;
 229
 230        /*
 231         * Protected by sbi->vh_mutex.
 232         */
 233        u32 linkid;
 234
 235        /*
 236         * Accessed using atomic bitops.
 237         */
 238        unsigned long flags;
 239
 240        /*
 241         * Protected by i_mutex.
 242         */
 243        sector_t fs_blocks;
 244        u8 userflags;           /* BSD user file flags */
 245        u32 subfolders;         /* Subfolder count (HFSX only) */
 246        struct list_head open_dir_list;
 247        spinlock_t open_dir_lock;
 248        loff_t phys_size;
 249
 250        struct inode vfs_inode;
 251};
 252
 253#define HFSPLUS_EXT_DIRTY       0x0001
 254#define HFSPLUS_EXT_NEW         0x0002
 255
 256#define HFSPLUS_I_RSRC          0       /* represents a resource fork */
 257#define HFSPLUS_I_CAT_DIRTY     1       /* has changes in the catalog tree */
 258#define HFSPLUS_I_EXT_DIRTY     2       /* has changes in the extent tree */
 259#define HFSPLUS_I_ALLOC_DIRTY   3       /* has changes in the allocation file */
 260#define HFSPLUS_I_ATTR_DIRTY    4       /* has changes in the attributes tree */
 261
 262#define HFSPLUS_IS_RSRC(inode) \
 263        test_bit(HFSPLUS_I_RSRC, &HFSPLUS_I(inode)->flags)
 264
 265static inline struct hfsplus_inode_info *HFSPLUS_I(struct inode *inode)
 266{
 267        return container_of(inode, struct hfsplus_inode_info, vfs_inode);
 268}
 269
 270/*
 271 * Mark an inode dirty, and also mark the btree in which the
 272 * specific type of metadata is stored.
 273 * For data or metadata that gets written back by into the catalog btree
 274 * by hfsplus_write_inode a plain mark_inode_dirty call is enough.
 275 */
 276static inline void hfsplus_mark_inode_dirty(struct inode *inode,
 277                unsigned int flag)
 278{
 279        set_bit(flag, &HFSPLUS_I(inode)->flags);
 280        mark_inode_dirty(inode);
 281}
 282
 283struct hfs_find_data {
 284        /* filled by caller */
 285        hfsplus_btree_key *search_key;
 286        hfsplus_btree_key *key;
 287        /* filled by find */
 288        struct hfs_btree *tree;
 289        struct hfs_bnode *bnode;
 290        /* filled by findrec */
 291        int record;
 292        int keyoffset, keylength;
 293        int entryoffset, entrylength;
 294};
 295
 296struct hfsplus_readdir_data {
 297        struct list_head list;
 298        struct file *file;
 299        struct hfsplus_cat_key key;
 300};
 301
 302/*
 303 * Find minimum acceptible I/O size for an hfsplus sb.
 304 */
 305static inline unsigned short hfsplus_min_io_size(struct super_block *sb)
 306{
 307        return max_t(unsigned short, bdev_logical_block_size(sb->s_bdev),
 308                     HFSPLUS_SECTOR_SIZE);
 309}
 310
 311#define hfs_btree_open hfsplus_btree_open
 312#define hfs_btree_close hfsplus_btree_close
 313#define hfs_btree_write hfsplus_btree_write
 314#define hfs_bmap_reserve hfsplus_bmap_reserve
 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
 363typedef 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 */
 372int __init hfsplus_create_attr_tree_cache(void);
 373void hfsplus_destroy_attr_tree_cache(void);
 374int hfsplus_attr_bin_cmp_key(const hfsplus_btree_key *k1,
 375                             const hfsplus_btree_key *k2);
 376int hfsplus_attr_build_key(struct super_block *sb, hfsplus_btree_key *key,
 377                           u32 cnid, const char *name);
 378hfsplus_attr_entry *hfsplus_alloc_attr_entry(void);
 379void hfsplus_destroy_attr_entry(hfsplus_attr_entry *entry);
 380int hfsplus_find_attr(struct super_block *sb, u32 cnid, const char *name,
 381                      struct hfs_find_data *fd);
 382int hfsplus_attr_exists(struct inode *inode, const char *name);
 383int hfsplus_create_attr(struct inode *inode, const char *name,
 384                        const void *value, size_t size);
 385int hfsplus_delete_attr(struct inode *inode, const char *name);
 386int hfsplus_delete_all_attrs(struct inode *dir, u32 cnid);
 387
 388/* bitmap.c */
 389int hfsplus_block_allocate(struct super_block *sb, u32 size, u32 offset,
 390                           u32 *max);
 391int hfsplus_block_free(struct super_block *sb, u32 offset, u32 count);
 392
 393/* btree.c */
 394u32 hfsplus_calc_btree_clump_size(u32 block_size, u32 node_size, u64 sectors,
 395                                  int file_id);
 396struct hfs_btree *hfs_btree_open(struct super_block *sb, u32 id);
 397void hfs_btree_close(struct hfs_btree *tree);
 398int hfs_btree_write(struct hfs_btree *tree);
 399int hfs_bmap_reserve(struct hfs_btree *tree, int rsvd_nodes);
 400struct hfs_bnode *hfs_bmap_alloc(struct hfs_btree *tree);
 401void hfs_bmap_free(struct hfs_bnode *node);
 402
 403/* bnode.c */
 404void hfs_bnode_read(struct hfs_bnode *node, void *buf, int off, int len);
 405u16 hfs_bnode_read_u16(struct hfs_bnode *node, int off);
 406u8 hfs_bnode_read_u8(struct hfs_bnode *node, int off);
 407void hfs_bnode_read_key(struct hfs_bnode *node, void *key, int off);
 408void hfs_bnode_write(struct hfs_bnode *node, void *buf, int off, int len);
 409void hfs_bnode_write_u16(struct hfs_bnode *node, int off, u16 data);
 410void hfs_bnode_clear(struct hfs_bnode *node, int off, int len);
 411void hfs_bnode_copy(struct hfs_bnode *dst_node, int dst,
 412                    struct hfs_bnode *src_node, int src, int len);
 413void hfs_bnode_move(struct hfs_bnode *node, int dst, int src, int len);
 414void hfs_bnode_dump(struct hfs_bnode *node);
 415void hfs_bnode_unlink(struct hfs_bnode *node);
 416struct hfs_bnode *hfs_bnode_findhash(struct hfs_btree *tree, u32 cnid);
 417void hfs_bnode_unhash(struct hfs_bnode *node);
 418struct hfs_bnode *hfs_bnode_find(struct hfs_btree *tree, u32 num);
 419void hfs_bnode_free(struct hfs_bnode *node);
 420struct hfs_bnode *hfs_bnode_create(struct hfs_btree *tree, u32 num);
 421void hfs_bnode_get(struct hfs_bnode *node);
 422void hfs_bnode_put(struct hfs_bnode *node);
 423bool hfs_bnode_need_zeroout(struct hfs_btree *tree);
 424
 425/* brec.c */
 426u16 hfs_brec_lenoff(struct hfs_bnode *node, u16 rec, u16 *off);
 427u16 hfs_brec_keylen(struct hfs_bnode *node, u16 rec);
 428int hfs_brec_insert(struct hfs_find_data *fd, void *entry, int entry_len);
 429int hfs_brec_remove(struct hfs_find_data *fd);
 430
 431/* bfind.c */
 432int hfs_find_init(struct hfs_btree *tree, struct hfs_find_data *fd);
 433void hfs_find_exit(struct hfs_find_data *fd);
 434int hfs_find_1st_rec_by_cnid(struct hfs_bnode *bnode, struct hfs_find_data *fd,
 435                             int *begin, int *end, int *cur_rec);
 436int hfs_find_rec_by_key(struct hfs_bnode *bnode, struct hfs_find_data *fd,
 437                        int *begin, int *end, int *cur_rec);
 438int __hfs_brec_find(struct hfs_bnode *bnode, struct hfs_find_data *fd,
 439                    search_strategy_t rec_found);
 440int hfs_brec_find(struct hfs_find_data *fd, search_strategy_t do_key_compare);
 441int hfs_brec_read(struct hfs_find_data *fd, void *rec, int rec_len);
 442int hfs_brec_goto(struct hfs_find_data *fd, int cnt);
 443
 444/* catalog.c */
 445int hfsplus_cat_case_cmp_key(const hfsplus_btree_key *k1,
 446                             const hfsplus_btree_key *k2);
 447int hfsplus_cat_bin_cmp_key(const hfsplus_btree_key *k1,
 448                            const hfsplus_btree_key *k2);
 449int hfsplus_cat_build_key(struct super_block *sb, hfsplus_btree_key *key,
 450                           u32 parent, const struct qstr *str);
 451void hfsplus_cat_build_key_with_cnid(struct super_block *sb,
 452                                     hfsplus_btree_key *key, u32 parent);
 453void hfsplus_cat_set_perms(struct inode *inode, struct hfsplus_perm *perms);
 454int hfsplus_find_cat(struct super_block *sb, u32 cnid,
 455                     struct hfs_find_data *fd);
 456int hfsplus_create_cat(u32 cnid, struct inode *dir, const struct qstr *str,
 457                       struct inode *inode);
 458int hfsplus_delete_cat(u32 cnid, struct inode *dir, const struct qstr *str);
 459int hfsplus_rename_cat(u32 cnid, struct inode *src_dir, const struct qstr *src_name,
 460                       struct inode *dst_dir, const struct qstr *dst_name);
 461
 462/* dir.c */
 463extern const struct inode_operations hfsplus_dir_inode_operations;
 464extern const struct file_operations hfsplus_dir_operations;
 465
 466/* extents.c */
 467int hfsplus_ext_cmp_key(const hfsplus_btree_key *k1,
 468                        const hfsplus_btree_key *k2);
 469int hfsplus_ext_write_extent(struct inode *inode);
 470int hfsplus_get_block(struct inode *inode, sector_t iblock,
 471                      struct buffer_head *bh_result, int create);
 472int hfsplus_free_fork(struct super_block *sb, u32 cnid,
 473                      struct hfsplus_fork_raw *fork, int type);
 474int hfsplus_file_extend(struct inode *inode, bool zeroout);
 475void hfsplus_file_truncate(struct inode *inode);
 476
 477/* inode.c */
 478extern const struct address_space_operations hfsplus_aops;
 479extern const struct address_space_operations hfsplus_btree_aops;
 480extern const struct dentry_operations hfsplus_dentry_operations;
 481
 482struct inode *hfsplus_new_inode(struct super_block *sb, struct inode *dir,
 483                                umode_t mode);
 484void hfsplus_delete_inode(struct inode *inode);
 485void hfsplus_inode_read_fork(struct inode *inode,
 486                             struct hfsplus_fork_raw *fork);
 487void hfsplus_inode_write_fork(struct inode *inode,
 488                              struct hfsplus_fork_raw *fork);
 489int hfsplus_cat_read_inode(struct inode *inode, struct hfs_find_data *fd);
 490int hfsplus_cat_write_inode(struct inode *inode);
 491int hfsplus_getattr(const struct path *path, struct kstat *stat,
 492                    u32 request_mask, unsigned int query_flags);
 493int hfsplus_file_fsync(struct file *file, loff_t start, loff_t end,
 494                       int datasync);
 495
 496/* ioctl.c */
 497long hfsplus_ioctl(struct file *filp, unsigned int cmd, unsigned long arg);
 498
 499/* options.c */
 500void hfsplus_fill_defaults(struct hfsplus_sb_info *opts);
 501int hfsplus_parse_options_remount(char *input, int *force);
 502int hfsplus_parse_options(char *input, struct hfsplus_sb_info *sbi);
 503int hfsplus_show_options(struct seq_file *seq, struct dentry *root);
 504
 505/* part_tbl.c */
 506int hfs_part_find(struct super_block *sb, sector_t *part_start,
 507                  sector_t *part_size);
 508
 509/* super.c */
 510struct inode *hfsplus_iget(struct super_block *sb, unsigned long ino);
 511void hfsplus_mark_mdb_dirty(struct super_block *sb);
 512
 513/* tables.c */
 514extern u16 hfsplus_case_fold_table[];
 515extern u16 hfsplus_decompose_table[];
 516extern u16 hfsplus_compose_table[];
 517
 518/* unicode.c */
 519int hfsplus_strcasecmp(const struct hfsplus_unistr *s1,
 520                       const struct hfsplus_unistr *s2);
 521int hfsplus_strcmp(const struct hfsplus_unistr *s1,
 522                   const struct hfsplus_unistr *s2);
 523int hfsplus_uni2asc(struct super_block *sb, const struct hfsplus_unistr *ustr,
 524                    char *astr, int *len_p);
 525int hfsplus_asc2uni(struct super_block *sb, struct hfsplus_unistr *ustr,
 526                    int max_unistr_len, const char *astr, int len);
 527int hfsplus_hash_dentry(const struct dentry *dentry, struct qstr *str);
 528int hfsplus_compare_dentry(const struct dentry *dentry, unsigned int len,
 529                           const char *str, const struct qstr *name);
 530
 531/* wrapper.c */
 532int hfsplus_submit_bio(struct super_block *sb, sector_t sector, void *buf,
 533                       void **data, int op, int op_flags);
 534int hfsplus_read_wrapper(struct super_block *sb);
 535
 536/* time macros */
 537#define __hfsp_mt2ut(t)         (be32_to_cpu(t) - 2082844800U)
 538#define __hfsp_ut2mt(t)         (cpu_to_be32(t + 2082844800U))
 539
 540/* compatibility */
 541#define hfsp_mt2ut(t)           (struct timespec){ .tv_sec = __hfsp_mt2ut(t) }
 542#define hfsp_ut2mt(t)           __hfsp_ut2mt((t).tv_sec)
 543#define hfsp_now2mt()           __hfsp_ut2mt(get_seconds())
 544
 545#endif
 546