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