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/version.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)(hfsplus_btree_key *, hfsplus_btree_key *);
  41
  42 #define NODE_HASH_SIZE  256
  43
  44 /* An HFS+ BTree held in memory */
  45 struct hfs_btree {
  46         struct super_block *sb;
  47         struct inode *inode;
  48         btree_keycmp keycmp;
  49
  50         u32 cnid;
  51         u32 root;
  52         u32 leaf_count;
  53         u32 leaf_head;
  54         u32 leaf_tail;
  55         u32 node_count;
  56         u32 free_nodes;
  57         u32 attributes;
  58
  59         unsigned int node_size;
  60         unsigned int node_size_shift;
  61         unsigned int max_key_len;
  62         unsigned int depth;
  63
  64         //unsigned int map1_size, map_size;
  65         struct semaphore tree_lock;
  66
  67         unsigned int pages_per_bnode;
  68         spinlock_t hash_lock;
  69         struct hfs_bnode *node_hash[NODE_HASH_SIZE];
  70         int node_hash_cnt;
  71 };
  72
  73 struct page;
  74
  75 /* An HFS+ BTree node in memory */
  76 struct hfs_bnode {
  77         struct hfs_btree *tree;
  78
  79         u32 prev;
  80         u32 this;
  81         u32 next;
  82         u32 parent;
  83
  84         u16 num_recs;
  85         u8 type;
  86         u8 height;
  87
  88         struct hfs_bnode *next_hash;
  89         unsigned long flags;
  90         wait_queue_head_t lock_wq;
  91         atomic_t refcnt;
  92         unsigned int page_offset;
  93         struct page *page[0];
  94 };
  95
  96 #define HFS_BNODE_LOCK          0
  97 #define HFS_BNODE_ERROR         1
  98 #define HFS_BNODE_NEW           2
  99 #define HFS_BNODE_DIRTY         3
 100 #define HFS_BNODE_DELETED       4
 101
 102 /*
 103  * HFS+ superblock info (built from Volume Header on disk)
 104  */
 105
 106 struct hfsplus_vh;
 107 struct hfs_btree;
 108
 109 struct hfsplus_sb_info {
 110         struct buffer_head *s_vhbh;
 111         struct hfsplus_vh *s_vhdr;
 112         struct hfs_btree *ext_tree;
 113         struct hfs_btree *cat_tree;
 114         struct hfs_btree *attr_tree;
 115         struct inode *alloc_file;
 116         struct inode *hidden_dir;
 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
 154
 155 struct hfsplus_inode_info {
 156         struct semaphore extents_lock;
 157         u32 clump_blocks, alloc_blocks;
 158         sector_t fs_blocks;
 159         /* Allocation extents from catalog record or volume header */
 160         hfsplus_extent_rec first_extents;
 161         u32 first_blocks;
 162         hfsplus_extent_rec cached_extents;
 163         u32 cached_start, cached_blocks;
 164         atomic_t opencnt;
 165
 166         struct inode *rsrc_inode;
 167         unsigned long flags;
 168
 169         /* Device number in hfsplus_permissions in catalog */
 170         u32 dev;
 171         /* BSD system and user file flags */
 172         u8 rootflags;
 173         u8 userflags;
 174
 175         struct list_head open_dir_list;
 176         loff_t phys_size;
 177         struct inode vfs_inode;
 178 };
 179
 180 #define HFSPLUS_FLG_RSRC        0x0001
 181 #define HFSPLUS_FLG_EXT_DIRTY   0x0002
 182 #define HFSPLUS_FLG_EXT_NEW     0x0004
 183
 184 #define HFSPLUS_IS_DATA(inode)   (!(HFSPLUS_I(inode).flags & HFSPLUS_FLG_RSRC))
 185 #define HFSPLUS_IS_RSRC(inode)   (HFSPLUS_I(inode).flags & HFSPLUS_FLG_RSRC)
 186
 187 struct hfs_find_data {
 188         /* filled by caller */
 189         hfsplus_btree_key *search_key;
 190         hfsplus_btree_key *key;
 191         /* filled by find */
 192         struct hfs_btree *tree;
 193         struct hfs_bnode *bnode;
 194         /* filled by findrec */
 195         int record;
 196         int keyoffset, keylength;
 197         int entryoffset, entrylength;
 198 };
 199
 200 struct hfsplus_readdir_data {
 201         struct list_head list;
 202         struct file *file;
 203         struct hfsplus_cat_key key;
 204 };
 205
 206 #define hfs_btree_open hfsplus_btree_open
 207 #define hfs_btree_close hfsplus_btree_close
 208 #define hfs_btree_write hfsplus_btree_write
 209 #define hfs_bmap_alloc hfsplus_bmap_alloc
 210 #define hfs_bmap_free hfsplus_bmap_free
 211 #define hfs_bnode_read hfsplus_bnode_read
 212 #define hfs_bnode_read_u16 hfsplus_bnode_read_u16
 213 #define hfs_bnode_read_u8 hfsplus_bnode_read_u8
 214 #define hfs_bnode_read_key hfsplus_bnode_read_key
 215 #define hfs_bnode_write hfsplus_bnode_write
 216 #define hfs_bnode_write_u16 hfsplus_bnode_write_u16
 217 #define hfs_bnode_clear hfsplus_bnode_clear
 218 #define hfs_bnode_copy hfsplus_bnode_copy
 219 #define hfs_bnode_move hfsplus_bnode_move
 220 #define hfs_bnode_dump hfsplus_bnode_dump
 221 #define hfs_bnode_unlink hfsplus_bnode_unlink
 222 #define hfs_bnode_findhash hfsplus_bnode_findhash
 223 #define hfs_bnode_find hfsplus_bnode_find
 224 #define hfs_bnode_unhash hfsplus_bnode_unhash
 225 #define hfs_bnode_free hfsplus_bnode_free
 226 #define hfs_bnode_create hfsplus_bnode_create
 227 #define hfs_bnode_get hfsplus_bnode_get
 228 #define hfs_bnode_put hfsplus_bnode_put
 229 #define hfs_brec_lenoff hfsplus_brec_lenoff
 230 #define hfs_brec_keylen hfsplus_brec_keylen
 231 #define hfs_brec_insert hfsplus_brec_insert
 232 #define hfs_brec_remove hfsplus_brec_remove
 233 #define hfs_bnode_split hfsplus_bnode_split
 234 #define hfs_brec_update_parent hfsplus_brec_update_parent
 235 #define hfs_btree_inc_height hfsplus_btree_inc_height
 236 #define hfs_find_init hfsplus_find_init
 237 #define hfs_find_exit hfsplus_find_exit
 238 #define __hfs_brec_find __hplusfs_brec_find
 239 #define hfs_brec_find hfsplus_brec_find
 240 #define hfs_brec_read hfsplus_brec_read
 241 #define hfs_brec_goto hfsplus_brec_goto
 242 #define hfs_part_find hfsplus_part_find
 243
 244 /*
 245  * definitions for ext2 flag ioctls (linux really needs a generic
 246  * interface for this).
 247  */
 248
 249 /* ext2 ioctls (EXT2_IOC_GETFLAGS and EXT2_IOC_SETFLAGS) to support
 250  * chattr/lsattr */
 251 #define HFSPLUS_IOC_EXT2_GETFLAGS       _IOR('f', 1, long)
 252 #define HFSPLUS_IOC_EXT2_SETFLAGS       _IOW('f', 2, long)
 253
 254 #define EXT2_FLAG_IMMUTABLE             0x00000010 /* Immutable file */
 255 #define EXT2_FLAG_APPEND                0x00000020 /* writes to file may only append */
 256 #define EXT2_FLAG_NODUMP                0x00000040 /* do not dump file */
 257
 258
 259 /*
 260  * Functions in any *.c used in other files
 261  */
 262
 263 /* bitmap.c */
 264 int hfsplus_block_allocate(struct super_block *, u32, u32, u32 *);
 265 int hfsplus_block_free(struct super_block *, u32, u32);
 266
 267 /* btree.c */
 268 struct hfs_btree *hfs_btree_open(struct super_block *, u32);
 269 void hfs_btree_close(struct hfs_btree *);
 270 void hfs_btree_write(struct hfs_btree *);
 271 struct hfs_bnode *hfs_bmap_alloc(struct hfs_btree *);
 272 void hfs_bmap_free(struct hfs_bnode *);
 273
 274 /* bnode.c */
 275 void hfs_bnode_read(struct hfs_bnode *, void *, int, int);
 276 u16 hfs_bnode_read_u16(struct hfs_bnode *, int);
 277 u8 hfs_bnode_read_u8(struct hfs_bnode *, int);
 278 void hfs_bnode_read_key(struct hfs_bnode *, void *, int);
 279 void hfs_bnode_write(struct hfs_bnode *, void *, int, int);
 280 void hfs_bnode_write_u16(struct hfs_bnode *, int, u16);
 281 void hfs_bnode_clear(struct hfs_bnode *, int, int);
 282 void hfs_bnode_copy(struct hfs_bnode *, int,
 283                     struct hfs_bnode *, int, int);
 284 void hfs_bnode_move(struct hfs_bnode *, int, int, int);
 285 void hfs_bnode_dump(struct hfs_bnode *);
 286 void hfs_bnode_unlink(struct hfs_bnode *);
 287 struct hfs_bnode *hfs_bnode_findhash(struct hfs_btree *, u32);
 288 struct hfs_bnode *hfs_bnode_find(struct hfs_btree *, u32);
 289 void hfs_bnode_unhash(struct hfs_bnode *);
 290 void hfs_bnode_free(struct hfs_bnode *);
 291 struct hfs_bnode *hfs_bnode_create(struct hfs_btree *, u32);
 292 void hfs_bnode_get(struct hfs_bnode *);
 293 void hfs_bnode_put(struct hfs_bnode *);
 294
 295 /* brec.c */
 296 u16 hfs_brec_lenoff(struct hfs_bnode *, u16, u16 *);
 297 u16 hfs_brec_keylen(struct hfs_bnode *, u16);
 298 int hfs_brec_insert(struct hfs_find_data *, void *, int);
 299 int hfs_brec_remove(struct hfs_find_data *);
 300 struct hfs_bnode *hfs_bnode_split(struct hfs_find_data *);
 301 int hfs_brec_update_parent(struct hfs_find_data *);
 302 int hfs_btree_inc_height(struct hfs_btree *);
 303
 304 /* bfind.c */
 305 int hfs_find_init(struct hfs_btree *, struct hfs_find_data *);
 306 void hfs_find_exit(struct hfs_find_data *);
 307 int __hfs_brec_find(struct hfs_bnode *, struct hfs_find_data *);
 308 int hfs_brec_find(struct hfs_find_data *);
 309 int hfs_brec_read(struct hfs_find_data *, void *, int);
 310 int hfs_brec_goto(struct hfs_find_data *, int);
 311
 312 /* catalog.c */
 313 int hfsplus_cat_cmp_key(hfsplus_btree_key *, hfsplus_btree_key *);
 314 void hfsplus_cat_build_key(hfsplus_btree_key *, u32, struct qstr *);
 315 int hfsplus_find_cat(struct super_block *, u32, struct hfs_find_data *);
 316 int hfsplus_create_cat(u32, struct inode *, struct qstr *, struct inode *);
 317 int hfsplus_delete_cat(u32, struct inode *, struct qstr *);
 318 int hfsplus_rename_cat(u32, struct inode *, struct qstr *,
 319                        struct inode *, struct qstr *);
 320
 321 /* extents.c */
 322 int hfsplus_ext_cmp_key(hfsplus_btree_key *, hfsplus_btree_key *);
 323 void hfsplus_ext_build_key(hfsplus_btree_key *, u32, u32, u8);
 324 void hfsplus_ext_write_extent(struct inode *);
 325 int hfsplus_get_block(struct inode *, sector_t, struct buffer_head *, int);
 326 int hfsplus_free_fork(struct super_block *, u32, struct hfsplus_fork_raw *, int);
 327 int hfsplus_file_extend(struct inode *);
 328 void hfsplus_file_truncate(struct inode *);
 329
 330 /* inode.c */
 331 extern struct address_space_operations hfsplus_aops;
 332 extern struct address_space_operations hfsplus_btree_aops;
 333
 334 void hfsplus_inode_read_fork(struct inode *, struct hfsplus_fork_raw *);
 335 void hfsplus_inode_write_fork(struct inode *, struct hfsplus_fork_raw *);
 336 int hfsplus_cat_read_inode(struct inode *, struct hfs_find_data *);
 337 int hfsplus_cat_write_inode(struct inode *);
 338 struct inode *hfsplus_new_inode(struct super_block *, int);
 339 void hfsplus_delete_inode(struct inode *);
 340
 341 /* ioctl.c */
 342 int hfsplus_ioctl(struct inode *inode, struct file *filp, unsigned int cmd,
 343                   unsigned long arg);
 344 int hfsplus_setxattr(struct dentry *dentry, const char *name,
 345                      const void *value, size_t size, int flags);
 346 ssize_t hfsplus_getxattr(struct dentry *dentry, const char *name,
 347                          void *value, size_t size);
 348 ssize_t hfsplus_listxattr(struct dentry *dentry, char *buffer, size_t size);
 349
 350 /* options.c */
 351 int parse_options(char *, struct hfsplus_sb_info *);
 352 void fill_defaults(struct hfsplus_sb_info *);
 353
 354 /* tables.c */
 355 extern u16 case_fold_table[];
 356
 357 /* unicode.c */
 358 int hfsplus_unistrcmp(const struct hfsplus_unistr *, const struct hfsplus_unistr *);
 359 int hfsplus_uni2asc(const struct hfsplus_unistr *, char *, int *);
 360 int hfsplus_asc2uni(struct hfsplus_unistr *, const char *, int);
 361
 362 /* wrapper.c */
 363 int hfsplus_read_wrapper(struct super_block *);
 364
 365 int hfs_part_find(struct super_block *, sector_t *, sector_t *);
 366
 367 /* access macros */
 368 /*
 369 static inline struct hfsplus_sb_info *HFSPLUS_SB(struct super_block *sb)
 370 {
 371         return sb->s_fs_info;
 372 }
 373 static inline struct hfsplus_inode_info *HFSPLUS_I(struct inode *inode)
 374 {
 375         return list_entry(inode, struct hfsplus_inode_info, vfs_inode);
 376 }
 377 */
 378 #define HFSPLUS_SB(super)       (*(struct hfsplus_sb_info *)(super)->s_fs_info)
 379 #define HFSPLUS_I(inode)        (*list_entry(inode, struct hfsplus_inode_info, vfs_inode))
 380
 381 #if 1
 382 #define hfsplus_kmap(p)         ({ struct page *__p = (p); kmap(__p); })
 383 #define hfsplus_kunmap(p)       ({ struct page *__p = (p); kunmap(__p); __p; })
 384 #else
 385 #define hfsplus_kmap(p)         kmap(p)
 386 #define hfsplus_kunmap(p)       kunmap(p)
 387 #endif
 388
 389 #define sb_bread512(sb, sec, data) ({                   \
 390         struct buffer_head *__bh;                       \
 391         sector_t __block;                               \
 392         loff_t __start;                                 \
 393         int __offset;                                   \
 394                                                         \
 395         __start = (loff_t)(sec) << HFSPLUS_SECTOR_SHIFT;\
 396         __block = __start >> (sb)->s_blocksize_bits;    \
 397         __offset = __start & ((sb)->s_blocksize - 1);   \
 398         __bh = sb_bread((sb), __block);                 \
 399         if (likely(__bh != NULL))                       \
 400                 data = (void *)(__bh->b_data + __offset);\
 401         else                                            \
 402                 data = NULL;                            \
 403         __bh;                                           \
 404 })
 405
 406 /* time macros */
 407 #define __hfsp_mt2ut(t)         (be32_to_cpu(t) - 2082844800U)
 408 #define __hfsp_ut2mt(t)         (cpu_to_be32(t + 2082844800U))
 409
 410 /* compatibility */
 411 #define hfsp_mt2ut(t)           (struct timespec){ .tv_sec = __hfsp_mt2ut(t) }
 412 #define hfsp_ut2mt(t)           __hfsp_ut2mt((t).tv_sec)
 413 #define hfsp_now2mt()           __hfsp_ut2mt(get_seconds())
 414
 415 #define kdev_t_to_nr(x)         (x)
 416
 417 #endif