[mirror_ubuntu-artful-kernel.git] / fs / hfsplus / hfsplus_fs.h

/*
 *  linux/include/linux/hfsplus_fs.h
 *
 * Copyright (C) 1999
 * Brad Boyer (flar@pants.nu)
 * (C) 2003 Ardis Technologies <roman@ardistech.com>
 *
 */

#ifndef _LINUX_HFSPLUS_FS_H
#define _LINUX_HFSPLUS_FS_H

#ifdef pr_fmt
#undef pr_fmt
#endif

#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt

#include <linux/fs.h>
#include <linux/mutex.h>
#include <linux/buffer_head.h>
#include <linux/blkdev.h>
#include "hfsplus_raw.h"

#define DBG_BNODE_REFS	0x00000001
#define DBG_BNODE_MOD	0x00000002
#define DBG_CAT_MOD	0x00000004
#define DBG_INODE	0x00000008
#define DBG_SUPER	0x00000010
#define DBG_EXTENT	0x00000020
#define DBG_BITMAP	0x00000040
#define DBG_ATTR_MOD	0x00000080
#define DBG_ACL_MOD	0x00000100

#if 0
#define DBG_MASK	(DBG_EXTENT|DBG_INODE|DBG_BNODE_MOD)
#define DBG_MASK	(DBG_BNODE_MOD|DBG_CAT_MOD|DBG_INODE)
#define DBG_MASK	(DBG_CAT_MOD|DBG_BNODE_REFS|DBG_INODE|DBG_EXTENT)
#endif
#define DBG_MASK	(0)

#define hfs_dbg(flg, fmt, ...)					\
do {								\
	if (DBG_##flg & DBG_MASK)				\
		printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__);	\
} while (0)

#define hfs_dbg_cont(flg, fmt, ...)				\
do {								\
	if (DBG_##flg & DBG_MASK)				\
		pr_cont(fmt, ##__VA_ARGS__);			\
} while (0)

/* Runtime config options */
#define HFSPLUS_DEF_CR_TYPE    0x3F3F3F3F  /* '????' */

#define HFSPLUS_TYPE_DATA 0x00
#define HFSPLUS_TYPE_RSRC 0xFF

typedef int (*btree_keycmp)(const hfsplus_btree_key *,
		const hfsplus_btree_key *);

#define NODE_HASH_SIZE	256

/* B-tree mutex nested subclasses */
enum hfsplus_btree_mutex_classes {
	CATALOG_BTREE_MUTEX,
	EXTENTS_BTREE_MUTEX,
	ATTR_BTREE_MUTEX,
};

/* An HFS+ BTree held in memory */
struct hfs_btree {
	struct super_block *sb;
	struct inode *inode;
	btree_keycmp keycmp;

	u32 cnid;
	u32 root;
	u32 leaf_count;
	u32 leaf_head;
	u32 leaf_tail;
	u32 node_count;
	u32 free_nodes;
	u32 attributes;

	unsigned int node_size;
	unsigned int node_size_shift;
	unsigned int max_key_len;
	unsigned int depth;

	struct mutex tree_lock;

	unsigned int pages_per_bnode;
	spinlock_t hash_lock;
	struct hfs_bnode *node_hash[NODE_HASH_SIZE];
	int node_hash_cnt;
};

struct page;

/* An HFS+ BTree node in memory */
struct hfs_bnode {
	struct hfs_btree *tree;

	u32 prev;
	u32 this;
	u32 next;
	u32 parent;

	u16 num_recs;
	u8 type;
	u8 height;

	struct hfs_bnode *next_hash;
	unsigned long flags;
	wait_queue_head_t lock_wq;
	atomic_t refcnt;
	unsigned int page_offset;
	struct page *page[0];
};

#define HFS_BNODE_LOCK		0
#define HFS_BNODE_ERROR		1
#define HFS_BNODE_NEW		2
#define HFS_BNODE_DIRTY		3
#define HFS_BNODE_DELETED	4

/*
 * Attributes file states
 */
#define HFSPLUS_EMPTY_ATTR_TREE		0
#define HFSPLUS_CREATING_ATTR_TREE	1
#define HFSPLUS_VALID_ATTR_TREE		2
#define HFSPLUS_FAILED_ATTR_TREE	3

/*
 * HFS+ superblock info (built from Volume Header on disk)
 */

struct hfsplus_vh;
struct hfs_btree;

struct hfsplus_sb_info {
	void *s_vhdr_buf;
	struct hfsplus_vh *s_vhdr;
	void *s_backup_vhdr_buf;
	struct hfsplus_vh *s_backup_vhdr;
	struct hfs_btree *ext_tree;
	struct hfs_btree *cat_tree;
	struct hfs_btree *attr_tree;
	atomic_t attr_tree_state;
	struct inode *alloc_file;
	struct inode *hidden_dir;
	struct nls_table *nls;

	/* Runtime variables */
	u32 blockoffset;
	sector_t part_start;
	sector_t sect_count;
	int fs_shift;

	/* immutable data from the volume header */
	u32 alloc_blksz;
	int alloc_blksz_shift;
	u32 total_blocks;
	u32 data_clump_blocks, rsrc_clump_blocks;

	/* mutable data from the volume header, protected by alloc_mutex */
	u32 free_blocks;
	struct mutex alloc_mutex;

	/* mutable data from the volume header, protected by vh_mutex */
	u32 next_cnid;
	u32 file_count;
	u32 folder_count;
	struct mutex vh_mutex;

	/* Config options */
	u32 creator;
	u32 type;

	umode_t umask;
	kuid_t uid;
	kgid_t gid;

	int part, session;
	unsigned long flags;

	int work_queued;               /* non-zero delayed work is queued */
	struct delayed_work sync_work; /* FS sync delayed work */
	spinlock_t work_lock;          /* protects sync_work and work_queued */
};

#define HFSPLUS_SB_WRITEBACKUP	0
#define HFSPLUS_SB_NODECOMPOSE	1
#define HFSPLUS_SB_FORCE	2
#define HFSPLUS_SB_HFSX		3
#define HFSPLUS_SB_CASEFOLD	4
#define HFSPLUS_SB_NOBARRIER	5

static inline struct hfsplus_sb_info *HFSPLUS_SB(struct super_block *sb)
{
	return sb->s_fs_info;
}


struct hfsplus_inode_info {
	atomic_t opencnt;

	/*
	 * Extent allocation information, protected by extents_lock.
	 */
	u32 first_blocks;
	u32 clump_blocks;
	u32 alloc_blocks;
	u32 cached_start;
	u32 cached_blocks;
	hfsplus_extent_rec first_extents;
	hfsplus_extent_rec cached_extents;
	unsigned int extent_state;
	struct mutex extents_lock;

	/*
	 * Immutable data.
	 */
	struct inode *rsrc_inode;
	__be32 create_date;

	/*
	 * Protected by sbi->vh_mutex.
	 */
	u32 linkid;

	/*
	 * Accessed using atomic bitops.
	 */
	unsigned long flags;

	/*
	 * Protected by i_mutex.
	 */
	sector_t fs_blocks;
	u8 userflags;		/* BSD user file flags */
	u32 subfolders;		/* Subfolder count (HFSX only) */
	struct list_head open_dir_list;
	spinlock_t open_dir_lock;
	loff_t phys_size;

	struct inode vfs_inode;
};

#define HFSPLUS_EXT_DIRTY	0x0001
#define HFSPLUS_EXT_NEW		0x0002

#define HFSPLUS_I_RSRC		0	/* represents a resource fork */
#define HFSPLUS_I_CAT_DIRTY	1	/* has changes in the catalog tree */
#define HFSPLUS_I_EXT_DIRTY	2	/* has changes in the extent tree */
#define HFSPLUS_I_ALLOC_DIRTY	3	/* has changes in the allocation file */
#define HFSPLUS_I_ATTR_DIRTY	4	/* has changes in the attributes tree */

#define HFSPLUS_IS_RSRC(inode) \
	test_bit(HFSPLUS_I_RSRC, &HFSPLUS_I(inode)->flags)

static inline struct hfsplus_inode_info *HFSPLUS_I(struct inode *inode)
{
	return container_of(inode, struct hfsplus_inode_info, vfs_inode);
}

/*
 * Mark an inode dirty, and also mark the btree in which the
 * specific type of metadata is stored.
 * For data or metadata that gets written back by into the catalog btree
 * by hfsplus_write_inode a plain mark_inode_dirty call is enough.
 */
static inline void hfsplus_mark_inode_dirty(struct inode *inode,
		unsigned int flag)
{
	set_bit(flag, &HFSPLUS_I(inode)->flags);
	mark_inode_dirty(inode);
}

struct hfs_find_data {
	/* filled by caller */
	hfsplus_btree_key *search_key;
	hfsplus_btree_key *key;
	/* filled by find */
	struct hfs_btree *tree;
	struct hfs_bnode *bnode;
	/* filled by findrec */
	int record;
	int keyoffset, keylength;
	int entryoffset, entrylength;
};

struct hfsplus_readdir_data {
	struct list_head list;
	struct file *file;
	struct hfsplus_cat_key key;
};

/*
 * Find minimum acceptible I/O size for an hfsplus sb.
 */
static inline unsigned short hfsplus_min_io_size(struct super_block *sb)
{
	return max_t(unsigned short, bdev_logical_block_size(sb->s_bdev),
		     HFSPLUS_SECTOR_SIZE);
}

#define hfs_btree_open hfsplus_btree_open
#define hfs_btree_close hfsplus_btree_close
#define hfs_btree_write hfsplus_btree_write
#define hfs_bmap_alloc hfsplus_bmap_alloc
#define hfs_bmap_free hfsplus_bmap_free
#define hfs_bnode_read hfsplus_bnode_read
#define hfs_bnode_read_u16 hfsplus_bnode_read_u16
#define hfs_bnode_read_u8 hfsplus_bnode_read_u8
#define hfs_bnode_read_key hfsplus_bnode_read_key
#define hfs_bnode_write hfsplus_bnode_write
#define hfs_bnode_write_u16 hfsplus_bnode_write_u16
#define hfs_bnode_clear hfsplus_bnode_clear
#define hfs_bnode_copy hfsplus_bnode_copy
#define hfs_bnode_move hfsplus_bnode_move
#define hfs_bnode_dump hfsplus_bnode_dump
#define hfs_bnode_unlink hfsplus_bnode_unlink
#define hfs_bnode_findhash hfsplus_bnode_findhash
#define hfs_bnode_find hfsplus_bnode_find
#define hfs_bnode_unhash hfsplus_bnode_unhash
#define hfs_bnode_free hfsplus_bnode_free
#define hfs_bnode_create hfsplus_bnode_create
#define hfs_bnode_get hfsplus_bnode_get
#define hfs_bnode_put hfsplus_bnode_put
#define hfs_brec_lenoff hfsplus_brec_lenoff
#define hfs_brec_keylen hfsplus_brec_keylen
#define hfs_brec_insert hfsplus_brec_insert
#define hfs_brec_remove hfsplus_brec_remove
#define hfs_find_init hfsplus_find_init
#define hfs_find_exit hfsplus_find_exit
#define __hfs_brec_find __hfsplus_brec_find
#define hfs_brec_find hfsplus_brec_find
#define hfs_brec_read hfsplus_brec_read
#define hfs_brec_goto hfsplus_brec_goto
#define hfs_part_find hfsplus_part_find

/*
 * definitions for ext2 flag ioctls (linux really needs a generic
 * interface for this).
 */

/* ext2 ioctls (EXT2_IOC_GETFLAGS and EXT2_IOC_SETFLAGS) to support
 * chattr/lsattr */
#define HFSPLUS_IOC_EXT2_GETFLAGS	FS_IOC_GETFLAGS
#define HFSPLUS_IOC_EXT2_SETFLAGS	FS_IOC_SETFLAGS


/*
 * hfs+-specific ioctl for making the filesystem bootable
 */
#define HFSPLUS_IOC_BLESS _IO('h', 0x80)

typedef int (*search_strategy_t)(struct hfs_bnode *,
				struct hfs_find_data *,
				int *, int *, int *);

/*
 * Functions in any *.c used in other files
 */

/* attributes.c */
int __init hfsplus_create_attr_tree_cache(void);
void hfsplus_destroy_attr_tree_cache(void);
int hfsplus_attr_bin_cmp_key(const hfsplus_btree_key *k1,
			     const hfsplus_btree_key *k2);
int hfsplus_attr_build_key(struct super_block *sb, hfsplus_btree_key *key,
			   u32 cnid, const char *name);
hfsplus_attr_entry *hfsplus_alloc_attr_entry(void);
void hfsplus_destroy_attr_entry(hfsplus_attr_entry *entry);
int hfsplus_find_attr(struct super_block *sb, u32 cnid, const char *name,
		      struct hfs_find_data *fd);
int hfsplus_attr_exists(struct inode *inode, const char *name);
int hfsplus_create_attr(struct inode *inode, const char *name,
			const void *value, size_t size);
int hfsplus_delete_attr(struct inode *inode, const char *name);
int hfsplus_delete_all_attrs(struct inode *dir, u32 cnid);

/* bitmap.c */
int hfsplus_block_allocate(struct super_block *sb, u32 size, u32 offset,
			   u32 *max);
int hfsplus_block_free(struct super_block *sb, u32 offset, u32 count);

/* btree.c */
u32 hfsplus_calc_btree_clump_size(u32 block_size, u32 node_size, u64 sectors,
				  int file_id);
struct hfs_btree *hfs_btree_open(struct super_block *sb, u32 id);
void hfs_btree_close(struct hfs_btree *tree);
int hfs_btree_write(struct hfs_btree *tree);
struct hfs_bnode *hfs_bmap_alloc(struct hfs_btree *tree);
void hfs_bmap_free(struct hfs_bnode *node);

/* bnode.c */
void hfs_bnode_read(struct hfs_bnode *node, void *buf, int off, int len);
u16 hfs_bnode_read_u16(struct hfs_bnode *node, int off);
u8 hfs_bnode_read_u8(struct hfs_bnode *node, int off);
void hfs_bnode_read_key(struct hfs_bnode *node, void *key, int off);
void hfs_bnode_write(struct hfs_bnode *node, void *buf, int off, int len);
void hfs_bnode_write_u16(struct hfs_bnode *node, int off, u16 data);
void hfs_bnode_clear(struct hfs_bnode *node, int off, int len);
void hfs_bnode_copy(struct hfs_bnode *dst_node, int dst,
		    struct hfs_bnode *src_node, int src, int len);
void hfs_bnode_move(struct hfs_bnode *node, int dst, int src, int len);
void hfs_bnode_dump(struct hfs_bnode *node);
void hfs_bnode_unlink(struct hfs_bnode *node);
struct hfs_bnode *hfs_bnode_findhash(struct hfs_btree *tree, u32 cnid);
void hfs_bnode_unhash(struct hfs_bnode *node);
struct hfs_bnode *hfs_bnode_find(struct hfs_btree *tree, u32 num);
void hfs_bnode_free(struct hfs_bnode *node);
struct hfs_bnode *hfs_bnode_create(struct hfs_btree *tree, u32 num);
void hfs_bnode_get(struct hfs_bnode *node);
void hfs_bnode_put(struct hfs_bnode *node);
bool hfs_bnode_need_zeroout(struct hfs_btree *tree);

/* brec.c */
u16 hfs_brec_lenoff(struct hfs_bnode *node, u16 rec, u16 *off);
u16 hfs_brec_keylen(struct hfs_bnode *node, u16 rec);
int hfs_brec_insert(struct hfs_find_data *fd, void *entry, int entry_len);
int hfs_brec_remove(struct hfs_find_data *fd);

/* bfind.c */
int hfs_find_init(struct hfs_btree *tree, struct hfs_find_data *fd);
void hfs_find_exit(struct hfs_find_data *fd);
int hfs_find_1st_rec_by_cnid(struct hfs_bnode *bnode, struct hfs_find_data *fd,
			     int *begin, int *end, int *cur_rec);
int hfs_find_rec_by_key(struct hfs_bnode *bnode, struct hfs_find_data *fd,
			int *begin, int *end, int *cur_rec);
int __hfs_brec_find(struct hfs_bnode *bnode, struct hfs_find_data *fd,
		    search_strategy_t rec_found);
int hfs_brec_find(struct hfs_find_data *fd, search_strategy_t do_key_compare);
int hfs_brec_read(struct hfs_find_data *fd, void *rec, int rec_len);
int hfs_brec_goto(struct hfs_find_data *fd, int cnt);

/* catalog.c */
int hfsplus_cat_case_cmp_key(const hfsplus_btree_key *k1,
			     const hfsplus_btree_key *k2);
int hfsplus_cat_bin_cmp_key(const hfsplus_btree_key *k1,
			    const hfsplus_btree_key *k2);
int hfsplus_cat_build_key(struct super_block *sb, hfsplus_btree_key *key,
			   u32 parent, const struct qstr *str);
void hfsplus_cat_build_key_with_cnid(struct super_block *sb,
				     hfsplus_btree_key *key, u32 parent);
void hfsplus_cat_set_perms(struct inode *inode, struct hfsplus_perm *perms);
int hfsplus_find_cat(struct super_block *sb, u32 cnid,
		     struct hfs_find_data *fd);
int hfsplus_create_cat(u32 cnid, struct inode *dir, const struct qstr *str,
		       struct inode *inode);
int hfsplus_delete_cat(u32 cnid, struct inode *dir, const struct qstr *str);
int hfsplus_rename_cat(u32 cnid, struct inode *src_dir, const struct qstr *src_name,
		       struct inode *dst_dir, const struct qstr *dst_name);

/* dir.c */
extern const struct inode_operations hfsplus_dir_inode_operations;
extern const struct file_operations hfsplus_dir_operations;

/* extents.c */
int hfsplus_ext_cmp_key(const hfsplus_btree_key *k1,
			const hfsplus_btree_key *k2);
int hfsplus_ext_write_extent(struct inode *inode);
int hfsplus_get_block(struct inode *inode, sector_t iblock,
		      struct buffer_head *bh_result, int create);
int hfsplus_free_fork(struct super_block *sb, u32 cnid,
		      struct hfsplus_fork_raw *fork, int type);
int hfsplus_file_extend(struct inode *inode, bool zeroout);
void hfsplus_file_truncate(struct inode *inode);

/* inode.c */
extern const struct address_space_operations hfsplus_aops;
extern const struct address_space_operations hfsplus_btree_aops;
extern const struct dentry_operations hfsplus_dentry_operations;

struct inode *hfsplus_new_inode(struct super_block *sb, umode_t mode);
void hfsplus_delete_inode(struct inode *inode);
void hfsplus_inode_read_fork(struct inode *inode,
			     struct hfsplus_fork_raw *fork);
void hfsplus_inode_write_fork(struct inode *inode,
			      struct hfsplus_fork_raw *fork);
int hfsplus_cat_read_inode(struct inode *inode, struct hfs_find_data *fd);
int hfsplus_cat_write_inode(struct inode *inode);
int hfsplus_file_fsync(struct file *file, loff_t start, loff_t end,
		       int datasync);

/* ioctl.c */
long hfsplus_ioctl(struct file *filp, unsigned int cmd, unsigned long arg);

/* options.c */
void hfsplus_fill_defaults(struct hfsplus_sb_info *opts);
int hfsplus_parse_options_remount(char *input, int *force);
int hfsplus_parse_options(char *input, struct hfsplus_sb_info *sbi);
int hfsplus_show_options(struct seq_file *seq, struct dentry *root);

/* part_tbl.c */
int hfs_part_find(struct super_block *sb, sector_t *part_start,
		  sector_t *part_size);

/* super.c */
struct inode *hfsplus_iget(struct super_block *sb, unsigned long ino);
void hfsplus_mark_mdb_dirty(struct super_block *sb);

/* tables.c */
extern u16 hfsplus_case_fold_table[];
extern u16 hfsplus_decompose_table[];
extern u16 hfsplus_compose_table[];

/* unicode.c */
int hfsplus_strcasecmp(const struct hfsplus_unistr *s1,
		       const struct hfsplus_unistr *s2);
int hfsplus_strcmp(const struct hfsplus_unistr *s1,
		   const struct hfsplus_unistr *s2);
int hfsplus_uni2asc(struct super_block *sb, const struct hfsplus_unistr *ustr,
		    char *astr, int *len_p);
int hfsplus_asc2uni(struct super_block *sb, struct hfsplus_unistr *ustr,
		    int max_unistr_len, const char *astr, int len);
int hfsplus_hash_dentry(const struct dentry *dentry, struct qstr *str);
int hfsplus_compare_dentry(const struct dentry *dentry, unsigned int len,
			   const char *str, const struct qstr *name);

/* wrapper.c */
int hfsplus_submit_bio(struct super_block *sb, sector_t sector, void *buf,
		       void **data, int op, int op_flags);
int hfsplus_read_wrapper(struct super_block *sb);

/* time macros */
#define __hfsp_mt2ut(t)		(be32_to_cpu(t) - 2082844800U)
#define __hfsp_ut2mt(t)		(cpu_to_be32(t + 2082844800U))

/* compatibility */
#define hfsp_mt2ut(t)		(struct timespec){ .tv_sec = __hfsp_mt2ut(t) }
#define hfsp_ut2mt(t)		__hfsp_ut2mt((t).tv_sec)
#define hfsp_now2mt()		__hfsp_ut2mt(get_seconds())

#endif
Commit	Line	Data
1da177e4 LT	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
d6142673 JP	13	#ifdef pr_fmt
	14	#undef pr_fmt
	15	#endif
	16
	17	#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
	18
1da177e4	19	#include <linux/fs.h>
895c23f8	20	#include <linux/mutex.h>
1da177e4	21	#include <linux/buffer_head.h>
6596528e	22	#include <linux/blkdev.h>
1da177e4 LT	23	#include "hfsplus_raw.h"
	24
	25	#define DBG_BNODE_REFS 0x00000001
	26	#define DBG_BNODE_MOD 0x00000002
	27	#define DBG_CAT_MOD 0x00000004
	28	#define DBG_INODE 0x00000008
	29	#define DBG_SUPER 0x00000010
	30	#define DBG_EXTENT 0x00000020
	31	#define DBG_BITMAP 0x00000040
324ef39a	32	#define DBG_ATTR_MOD 0x00000080
2c92057e	33	#define DBG_ACL_MOD 0x00000100
1da177e4	34
21f2296a AS	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
1da177e4 LT	40	#define DBG_MASK (0)
1da177e4 LT	41
d6142673 JP	42	#define hfs_dbg(flg, fmt, ...) \
	43	do { \
	44	if (DBG_##flg & DBG_MASK) \
	45	printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__); \
c2b3e1f7 JP	46	} while (0)
c2b3e1f7 JP	47
d6142673 JP	48	#define hfs_dbg_cont(flg, fmt, ...) \
	49	do { \
	50	if (DBG_##flg & DBG_MASK) \
	51	pr_cont(fmt, ##__VA_ARGS__); \
c2b3e1f7	52	} while (0)
1da177e4 LT	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
2753cc28 AS	60	typedef int (btree_keycmp)(const hfsplus_btree_key ,
2753cc28 AS	61	const hfsplus_btree_key *);
1da177e4 LT	62
	63	#define NODE_HASH_SIZE 256
	64
324ef39a VD	65	/* B-tree mutex nested subclasses */
	66	enum hfsplus_btree_mutex_classes {
	67	CATALOG_BTREE_MUTEX,
	68	EXTENTS_BTREE_MUTEX,
	69	ATTR_BTREE_MUTEX,
	70	};
	71
1da177e4 LT	72	/* An HFS+ BTree held in memory */
	73	struct 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
467c3d9c	92	struct mutex tree_lock;
1da177e4 LT	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
	100	struct page;
	101
	102	/* An HFS+ BTree node in memory */
	103	struct 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
95e0d7db VD	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
1da177e4 LT	137	/*
	138	* HFS+ superblock info (built from Volume Header on disk)
	139	*/
	140
	141	struct hfsplus_vh;
	142	struct hfs_btree;
	143
	144	struct hfsplus_sb_info {
6596528e	145	void *s_vhdr_buf;
1da177e4	146	struct hfsplus_vh *s_vhdr;
6596528e	147	void *s_backup_vhdr_buf;
52399b17	148	struct hfsplus_vh *s_backup_vhdr;
1da177e4 LT	149	struct hfs_btree *ext_tree;
	150	struct hfs_btree *cat_tree;
	151	struct hfs_btree *attr_tree;
95e0d7db	152	atomic_t attr_tree_state;
1da177e4 LT	153	struct inode *alloc_file;
	154	struct inode *hidden_dir;
	155	struct nls_table *nls;
	156
	157	/* Runtime variables */
	158	u32 blockoffset;
52399b17 CH	159	sector_t part_start;
52399b17 CH	160	sector_t sect_count;
1da177e4 LT	161	int fs_shift;
1da177e4 LT	162
7ac9fb9c	163	/* immutable data from the volume header */
1da177e4 LT	164	u32 alloc_blksz;
	165	int alloc_blksz_shift;
	166	u32 total_blocks;
7ac9fb9c CH	167	u32 data_clump_blocks, rsrc_clump_blocks;
	168
	169	/* mutable data from the volume header, protected by alloc_mutex */
1da177e4	170	u32 free_blocks;
7ac9fb9c CH	171	struct mutex alloc_mutex;
	172
	173	/* mutable data from the volume header, protected by vh_mutex */
1da177e4 LT	174	u32 next_cnid;
	175	u32 file_count;
	176	u32 folder_count;
7ac9fb9c	177	struct mutex vh_mutex;
1da177e4 LT	178
	179	/* Config options */
	180	u32 creator;
	181	u32 type;
	182
	183	umode_t umask;
16525e3f EB	184	kuid_t uid;
16525e3f EB	185	kgid_t gid;
1da177e4 LT	186
1da177e4 LT	187	int part, session;
1da177e4	188	unsigned long flags;
9e6c5829 AB	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 */
1da177e4 LT	193	};
1da177e4 LT	194
84adede3 CH	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
34a2d313	200	#define HFSPLUS_SB_NOBARRIER 5
1da177e4	201
e3494705 CH	202	static inline struct hfsplus_sb_info HFSPLUS_SB(struct super_block sb)
	203	{
	204	return sb->s_fs_info;
	205	}
1da177e4 LT	206
	207
	208	struct hfsplus_inode_info {
1da177e4 LT	209	atomic_t opencnt;
1da177e4 LT	210
7fcc99f4 CH	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;
b33b7921	221	unsigned int extent_state;
7fcc99f4	222	struct mutex extents_lock;
1da177e4	223
7fcc99f4 CH	224	/*
	225	* Immutable data.
	226	*/
	227	struct inode *rsrc_inode;
9a4cad95	228	__be32 create_date;
f6089ff8 CH	229
	230	/*
	231	* Protected by sbi->vh_mutex.
	232	*/
	233	u32 linkid;
1da177e4	234
b33b7921 CH	235	/*
	236	* Accessed using atomic bitops.
	237	*/
	238	unsigned long flags;
	239
7fcc99f4 CH	240	/*
	241	* Protected by i_mutex.
	242	*/
	243	sector_t fs_blocks;
722c55d1	244	u8 userflags; /* BSD user file flags */
d7d673a5	245	u32 subfolders; /* Subfolder count (HFSX only) */
1da177e4	246	struct list_head open_dir_list;
323ee8fc	247	spinlock_t open_dir_lock;
1da177e4	248	loff_t phys_size;
7fcc99f4	249
1da177e4 LT	250	struct inode vfs_inode;
	251	};
	252
b33b7921 CH	253	#define HFSPLUS_EXT_DIRTY 0x0001
	254	#define HFSPLUS_EXT_NEW 0x0002
	255
	256	#define HFSPLUS_I_RSRC 0 /* represents a resource fork */
e3494705 CH	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 */
324ef39a	260	#define HFSPLUS_I_ATTR_DIRTY 4 /* has changes in the attributes tree */
1da177e4	261
b33b7921 CH	262	#define HFSPLUS_IS_RSRC(inode) \
b33b7921 CH	263	test_bit(HFSPLUS_I_RSRC, &HFSPLUS_I(inode)->flags)
1da177e4	264
e3494705 CH	265	static inline struct hfsplus_inode_info HFSPLUS_I(struct inode inode)
e3494705 CH	266	{
db6172c4	267	return container_of(inode, struct hfsplus_inode_info, vfs_inode);
e3494705	268	}
1da177e4	269
e3494705 CH	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	*/
	276	static 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	}
1da177e4 LT	282
	283	struct 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
	296	struct hfsplus_readdir_data {
	297	struct list_head list;
	298	struct file *file;
	299	struct hfsplus_cat_key key;
	300	};
	301
6596528e SF	302	/*
	303	* Find minimum acceptible I/O size for an hfsplus sb.
	304	*/
	305	static 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
1da177e4 LT	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_alloc hfsplus_bmap_alloc
	315	#define hfs_bmap_free hfsplus_bmap_free
	316	#define hfs_bnode_read hfsplus_bnode_read
	317	#define hfs_bnode_read_u16 hfsplus_bnode_read_u16
	318	#define hfs_bnode_read_u8 hfsplus_bnode_read_u8
	319	#define hfs_bnode_read_key hfsplus_bnode_read_key
	320	#define hfs_bnode_write hfsplus_bnode_write
	321	#define hfs_bnode_write_u16 hfsplus_bnode_write_u16
	322	#define hfs_bnode_clear hfsplus_bnode_clear
	323	#define hfs_bnode_copy hfsplus_bnode_copy
	324	#define hfs_bnode_move hfsplus_bnode_move
	325	#define hfs_bnode_dump hfsplus_bnode_dump
	326	#define hfs_bnode_unlink hfsplus_bnode_unlink
	327	#define hfs_bnode_findhash hfsplus_bnode_findhash
	328	#define hfs_bnode_find hfsplus_bnode_find
	329	#define hfs_bnode_unhash hfsplus_bnode_unhash
	330	#define hfs_bnode_free hfsplus_bnode_free
	331	#define hfs_bnode_create hfsplus_bnode_create
	332	#define hfs_bnode_get hfsplus_bnode_get
	333	#define hfs_bnode_put hfsplus_bnode_put
	334	#define hfs_brec_lenoff hfsplus_brec_lenoff
	335	#define hfs_brec_keylen hfsplus_brec_keylen
	336	#define hfs_brec_insert hfsplus_brec_insert
	337	#define hfs_brec_remove hfsplus_brec_remove
	338	#define hfs_find_init hfsplus_find_init
	339	#define hfs_find_exit hfsplus_find_exit
324ef39a	340	#define __hfs_brec_find __hfsplus_brec_find
1da177e4 LT	341	#define hfs_brec_find hfsplus_brec_find
	342	#define hfs_brec_read hfsplus_brec_read
	343	#define hfs_brec_goto hfsplus_brec_goto
	344	#define hfs_part_find hfsplus_part_find
	345
	346	/*
	347	* definitions for ext2 flag ioctls (linux really needs a generic
	348	* interface for this).
	349	*/
	350
	351	/* ext2 ioctls (EXT2_IOC_GETFLAGS and EXT2_IOC_SETFLAGS) to support
	352	* chattr/lsattr */
36695673 DH	353	#define HFSPLUS_IOC_EXT2_GETFLAGS FS_IOC_GETFLAGS
36695673 DH	354	#define HFSPLUS_IOC_EXT2_SETFLAGS FS_IOC_SETFLAGS
1da177e4 LT	355
1da177e4 LT	356
a051f71c MG	357	/*
	358	* hfs+-specific ioctl for making the filesystem bootable
	359	*/
	360	#define HFSPLUS_IOC_BLESS _IO('h', 0x80)
	361
324ef39a VD	362	typedef int (search_strategy_t)(struct hfs_bnode ,
	363	struct hfs_find_data *,
	364	int , int , int *);
	365
1da177e4 LT	366	/*
	367	* Functions in any *.c used in other files
	368	*/
	369
324ef39a	370	/* attributes.c */
c11e614d	371	int __init hfsplus_create_attr_tree_cache(void);
324ef39a	372	void hfsplus_destroy_attr_tree_cache(void);
ffbc0671 SA	373	int hfsplus_attr_bin_cmp_key(const hfsplus_btree_key *k1,
	374	const hfsplus_btree_key *k2);
	375	int hfsplus_attr_build_key(struct super_block sb, hfsplus_btree_key key,
	376	u32 cnid, const char *name);
324ef39a	377	hfsplus_attr_entry *hfsplus_alloc_attr_entry(void);
ffbc0671 SA	378	void hfsplus_destroy_attr_entry(hfsplus_attr_entry *entry);
	379	int hfsplus_find_attr(struct super_block sb, u32 cnid, const char name,
	380	struct hfs_find_data *fd);
324ef39a	381	int hfsplus_attr_exists(struct inode inode, const char name);
ffbc0671 SA	382	int hfsplus_create_attr(struct inode inode, const char name,
	383	const void *value, size_t size);
	384	int hfsplus_delete_attr(struct inode inode, const char name);
324ef39a VD	385	int hfsplus_delete_all_attrs(struct inode *dir, u32 cnid);
324ef39a VD	386
1da177e4	387	/* bitmap.c */
ffbc0671 SA	388	int hfsplus_block_allocate(struct super_block *sb, u32 size, u32 offset,
	389	u32 *max);
	390	int hfsplus_block_free(struct super_block *sb, u32 offset, u32 count);
1da177e4 LT	391
1da177e4 LT	392	/* btree.c */
ffbc0671 SA	393	u32 hfsplus_calc_btree_clump_size(u32 block_size, u32 node_size, u64 sectors,
	394	int file_id);
	395	struct hfs_btree hfs_btree_open(struct super_block sb, u32 id);
	396	void hfs_btree_close(struct hfs_btree *tree);
	397	int hfs_btree_write(struct hfs_btree *tree);
	398	struct hfs_bnode hfs_bmap_alloc(struct hfs_btree tree);
	399	void hfs_bmap_free(struct hfs_bnode *node);
1da177e4 LT	400
1da177e4 LT	401	/* bnode.c */
ffbc0671 SA	402	void hfs_bnode_read(struct hfs_bnode node, void buf, int off, int len);
	403	u16 hfs_bnode_read_u16(struct hfs_bnode *node, int off);
	404	u8 hfs_bnode_read_u8(struct hfs_bnode *node, int off);
	405	void hfs_bnode_read_key(struct hfs_bnode node, void key, int off);
	406	void hfs_bnode_write(struct hfs_bnode node, void buf, int off, int len);
	407	void hfs_bnode_write_u16(struct hfs_bnode *node, int off, u16 data);
	408	void hfs_bnode_clear(struct hfs_bnode *node, int off, int len);
	409	void hfs_bnode_copy(struct hfs_bnode *dst_node, int dst,
	410	struct hfs_bnode *src_node, int src, int len);
	411	void hfs_bnode_move(struct hfs_bnode *node, int dst, int src, int len);
	412	void hfs_bnode_dump(struct hfs_bnode *node);
	413	void hfs_bnode_unlink(struct hfs_bnode *node);
	414	struct hfs_bnode hfs_bnode_findhash(struct hfs_btree tree, u32 cnid);
	415	void hfs_bnode_unhash(struct hfs_bnode *node);
	416	struct hfs_bnode hfs_bnode_find(struct hfs_btree tree, u32 num);
	417	void hfs_bnode_free(struct hfs_bnode *node);
	418	struct hfs_bnode hfs_bnode_create(struct hfs_btree tree, u32 num);
	419	void hfs_bnode_get(struct hfs_bnode *node);
	420	void hfs_bnode_put(struct hfs_bnode *node);
	421	bool hfs_bnode_need_zeroout(struct hfs_btree *tree);
1da177e4 LT	422
1da177e4 LT	423	/* brec.c */
ffbc0671 SA	424	u16 hfs_brec_lenoff(struct hfs_bnode node, u16 rec, u16 off);
	425	u16 hfs_brec_keylen(struct hfs_bnode *node, u16 rec);
	426	int hfs_brec_insert(struct hfs_find_data fd, void entry, int entry_len);
	427	int hfs_brec_remove(struct hfs_find_data *fd);
1da177e4 LT	428
1da177e4 LT	429	/* bfind.c */
ffbc0671 SA	430	int hfs_find_init(struct hfs_btree tree, struct hfs_find_data fd);
	431	void hfs_find_exit(struct hfs_find_data *fd);
	432	int hfs_find_1st_rec_by_cnid(struct hfs_bnode bnode, struct hfs_find_data fd,
	433	int begin, int end, int *cur_rec);
	434	int hfs_find_rec_by_key(struct hfs_bnode bnode, struct hfs_find_data fd,
	435	int begin, int end, int *cur_rec);
	436	int __hfs_brec_find(struct hfs_bnode bnode, struct hfs_find_data fd,
	437	search_strategy_t rec_found);
	438	int hfs_brec_find(struct hfs_find_data *fd, search_strategy_t do_key_compare);
	439	int hfs_brec_read(struct hfs_find_data fd, void rec, int rec_len);
	440	int hfs_brec_goto(struct hfs_find_data *fd, int cnt);
1da177e4 LT	441
1da177e4 LT	442	/* catalog.c */
ffbc0671 SA	443	int hfsplus_cat_case_cmp_key(const hfsplus_btree_key *k1,
	444	const hfsplus_btree_key *k2);
	445	int hfsplus_cat_bin_cmp_key(const hfsplus_btree_key *k1,
	446	const hfsplus_btree_key *k2);
89ac9b4d	447	int hfsplus_cat_build_key(struct super_block sb, hfsplus_btree_key key,
b5cce521	448	u32 parent, const struct qstr *str);
89ac9b4d SS	449	void hfsplus_cat_build_key_with_cnid(struct super_block *sb,
89ac9b4d SS	450	hfsplus_btree_key *key, u32 parent);
90e61690	451	void hfsplus_cat_set_perms(struct inode inode, struct hfsplus_perm perms);
ffbc0671 SA	452	int hfsplus_find_cat(struct super_block *sb, u32 cnid,
ffbc0671 SA	453	struct hfs_find_data *fd);
b5cce521	454	int hfsplus_create_cat(u32 cnid, struct inode dir, const struct qstr str,
ffbc0671	455	struct inode *inode);
b5cce521 AV	456	int hfsplus_delete_cat(u32 cnid, struct inode dir, const struct qstr str);
	457	int hfsplus_rename_cat(u32 cnid, struct inode src_dir, const struct qstr src_name,
	458	struct inode dst_dir, const struct qstr dst_name);
1da177e4	459
4b0a8da7 AB	460	/* dir.c */
	461	extern const struct inode_operations hfsplus_dir_inode_operations;
	462	extern const struct file_operations hfsplus_dir_operations;
	463
1da177e4	464	/* extents.c */
ffbc0671 SA	465	int hfsplus_ext_cmp_key(const hfsplus_btree_key *k1,
	466	const hfsplus_btree_key *k2);
	467	int hfsplus_ext_write_extent(struct inode *inode);
	468	int hfsplus_get_block(struct inode *inode, sector_t iblock,
	469	struct buffer_head *bh_result, int create);
	470	int hfsplus_free_fork(struct super_block *sb, u32 cnid,
	471	struct hfsplus_fork_raw *fork, int type);
	472	int hfsplus_file_extend(struct inode *inode, bool zeroout);
	473	void hfsplus_file_truncate(struct inode *inode);
1da177e4 LT	474
1da177e4 LT	475	/* inode.c */
f5e54d6e CH	476	extern const struct address_space_operations hfsplus_aops;
f5e54d6e CH	477	extern const struct address_space_operations hfsplus_btree_aops;
e16404ed	478	extern const struct dentry_operations hfsplus_dentry_operations;
1da177e4	479
ffbc0671 SA	480	struct inode hfsplus_new_inode(struct super_block sb, umode_t mode);
	481	void hfsplus_delete_inode(struct inode *inode);
	482	void hfsplus_inode_read_fork(struct inode *inode,
	483	struct hfsplus_fork_raw *fork);
	484	void hfsplus_inode_write_fork(struct inode *inode,
	485	struct hfsplus_fork_raw *fork);
	486	int hfsplus_cat_read_inode(struct inode inode, struct hfs_find_data fd);
	487	int hfsplus_cat_write_inode(struct inode *inode);
02c24a82 JB	488	int hfsplus_file_fsync(struct file *file, loff_t start, loff_t end,
02c24a82 JB	489	int datasync);
1da177e4 LT	490
1da177e4 LT	491	/* ioctl.c */
7cc4bcc6	492	long hfsplus_ioctl(struct file *filp, unsigned int cmd, unsigned long arg);
1da177e4 LT	493
1da177e4 LT	494	/* options.c */
ffbc0671	495	void hfsplus_fill_defaults(struct hfsplus_sb_info *opts);
6f80dfe5	496	int hfsplus_parse_options_remount(char input, int force);
ffbc0671 SA	497	int hfsplus_parse_options(char input, struct hfsplus_sb_info sbi);
	498	int hfsplus_show_options(struct seq_file seq, struct dentry root);
	499
	500	/* part_tbl.c */
	501	int hfs_part_find(struct super_block sb, sector_t part_start,
	502	sector_t *part_size);
1da177e4	503
63525391	504	/* super.c */
ffbc0671	505	struct inode hfsplus_iget(struct super_block sb, unsigned long ino);
9e6c5829	506	void hfsplus_mark_mdb_dirty(struct super_block *sb);
63525391	507
1da177e4 LT	508	/* tables.c */
	509	extern u16 hfsplus_case_fold_table[];
	510	extern u16 hfsplus_decompose_table[];
	511	extern u16 hfsplus_compose_table[];
	512
	513	/* unicode.c */
ffbc0671 SA	514	int hfsplus_strcasecmp(const struct hfsplus_unistr *s1,
	515	const struct hfsplus_unistr *s2);
	516	int hfsplus_strcmp(const struct hfsplus_unistr *s1,
	517	const struct hfsplus_unistr *s2);
	518	int hfsplus_uni2asc(struct super_block sb, const struct hfsplus_unistr ustr,
	519	char astr, int len_p);
	520	int hfsplus_asc2uni(struct super_block sb, struct hfsplus_unistr ustr,
	521	int max_unistr_len, const char *astr, int len);
da53be12	522	int hfsplus_hash_dentry(const struct dentry dentry, struct qstr str);
6fa67e70	523	int hfsplus_compare_dentry(const struct dentry *dentry, unsigned int len,
ffbc0671	524	const char str, const struct qstr name);
1da177e4 LT	525
1da177e4 LT	526	/* wrapper.c */
ffbc0671	527	int hfsplus_submit_bio(struct super_block sb, sector_t sector, void buf,
67ed2596	528	void **data, int op, int op_flags);
ffbc0671	529	int hfsplus_read_wrapper(struct super_block *sb);
1da177e4 LT	530
	531	/* time macros */
	532	#define __hfsp_mt2ut(t) (be32_to_cpu(t) - 2082844800U)
	533	#define __hfsp_ut2mt(t) (cpu_to_be32(t + 2082844800U))
	534
	535	/* compatibility */
	536	#define hfsp_mt2ut(t) (struct timespec){ .tv_sec = __hfsp_mt2ut(t) }
	537	#define hfsp_ut2mt(t) __hfsp_ut2mt((t).tv_sec)
	538	#define hfsp_now2mt() __hfsp_ut2mt(get_seconds())
	539
1da177e4	540	#endif