[mirror_ubuntu-bionic-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

#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

/*
 * 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;
	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 */
	struct list_head open_dir_list;
	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 list_entry(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 hfsplus_create_attr_tree_cache(void);
void hfsplus_destroy_attr_tree_cache(void);
hfsplus_attr_entry *hfsplus_alloc_attr_entry(void);
void hfsplus_destroy_attr_entry(hfsplus_attr_entry *entry_p);
int hfsplus_attr_bin_cmp_key(const hfsplus_btree_key *,
		const hfsplus_btree_key *);
int hfsplus_attr_build_key(struct super_block *, hfsplus_btree_key *,
			u32, const char *);
void hfsplus_attr_build_key_uni(hfsplus_btree_key *key,
					u32 cnid,
					struct hfsplus_attr_unistr *name);
int hfsplus_find_attr(struct super_block *, u32,
			const char *, struct hfs_find_data *);
int hfsplus_attr_exists(struct inode *inode, const char *name);
int hfsplus_create_attr(struct inode *, const char *, const void *, size_t);
int hfsplus_delete_attr(struct inode *, const char *);
int hfsplus_delete_all_attrs(struct inode *dir, u32 cnid);

/* bitmap.c */
int hfsplus_block_allocate(struct super_block *, u32, u32, u32 *);
int hfsplus_block_free(struct super_block *, u32, u32);

/* btree.c */
struct hfs_btree *hfs_btree_open(struct super_block *, u32);
void hfs_btree_close(struct hfs_btree *);
int hfs_btree_write(struct hfs_btree *);
struct hfs_bnode *hfs_bmap_alloc(struct hfs_btree *);
void hfs_bmap_free(struct hfs_bnode *);

/* bnode.c */
void hfs_bnode_read(struct hfs_bnode *, void *, int, int);
u16 hfs_bnode_read_u16(struct hfs_bnode *, int);
u8 hfs_bnode_read_u8(struct hfs_bnode *, int);
void hfs_bnode_read_key(struct hfs_bnode *, void *, int);
void hfs_bnode_write(struct hfs_bnode *, void *, int, int);
void hfs_bnode_write_u16(struct hfs_bnode *, int, u16);
void hfs_bnode_clear(struct hfs_bnode *, int, int);
void hfs_bnode_copy(struct hfs_bnode *, int,
		    struct hfs_bnode *, int, int);
void hfs_bnode_move(struct hfs_bnode *, int, int, int);
void hfs_bnode_dump(struct hfs_bnode *);
void hfs_bnode_unlink(struct hfs_bnode *);
struct hfs_bnode *hfs_bnode_findhash(struct hfs_btree *, u32);
struct hfs_bnode *hfs_bnode_find(struct hfs_btree *, u32);
void hfs_bnode_unhash(struct hfs_bnode *);
void hfs_bnode_free(struct hfs_bnode *);
struct hfs_bnode *hfs_bnode_create(struct hfs_btree *, u32);
void hfs_bnode_get(struct hfs_bnode *);
void hfs_bnode_put(struct hfs_bnode *);

/* brec.c */
u16 hfs_brec_lenoff(struct hfs_bnode *, u16, u16 *);
u16 hfs_brec_keylen(struct hfs_bnode *, u16);
int hfs_brec_insert(struct hfs_find_data *, void *, int);
int hfs_brec_remove(struct hfs_find_data *);

/* bfind.c */
int hfs_find_init(struct hfs_btree *, struct hfs_find_data *);
void hfs_find_exit(struct hfs_find_data *);
int hfs_find_1st_rec_by_cnid(struct hfs_bnode *,
				struct hfs_find_data *,
				int *, int *, int *);
int hfs_find_rec_by_key(struct hfs_bnode *,
				struct hfs_find_data *,
				int *, int *, int *);
int __hfs_brec_find(struct hfs_bnode *, struct hfs_find_data *,
				search_strategy_t);
int hfs_brec_find(struct hfs_find_data *, search_strategy_t);
int hfs_brec_read(struct hfs_find_data *, void *, int);
int hfs_brec_goto(struct hfs_find_data *, int);

/* catalog.c */
int hfsplus_cat_case_cmp_key(const hfsplus_btree_key *,
		const hfsplus_btree_key *);
int hfsplus_cat_bin_cmp_key(const hfsplus_btree_key *,
		const hfsplus_btree_key *);
void hfsplus_cat_build_key(struct super_block *sb,
		hfsplus_btree_key *, u32, struct qstr *);
int hfsplus_find_cat(struct super_block *, u32, struct hfs_find_data *);
int hfsplus_create_cat(u32, struct inode *, struct qstr *, struct inode *);
int hfsplus_delete_cat(u32, struct inode *, struct qstr *);
int hfsplus_rename_cat(u32, struct inode *, struct qstr *,
		       struct inode *, struct qstr *);
void hfsplus_cat_set_perms(struct inode *inode, struct hfsplus_perm *perms);

/* 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 *, const hfsplus_btree_key *);
int hfsplus_ext_write_extent(struct inode *);
int hfsplus_get_block(struct inode *, sector_t, struct buffer_head *, int);
int hfsplus_free_fork(struct super_block *, u32,
		struct hfsplus_fork_raw *, int);
int hfsplus_file_extend(struct inode *);
void hfsplus_file_truncate(struct 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;

void hfsplus_inode_read_fork(struct inode *, struct hfsplus_fork_raw *);
void hfsplus_inode_write_fork(struct inode *, struct hfsplus_fork_raw *);
int hfsplus_cat_read_inode(struct inode *, struct hfs_find_data *);
int hfsplus_cat_write_inode(struct inode *);
struct inode *hfsplus_new_inode(struct super_block *, umode_t);
void hfsplus_delete_inode(struct 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 */
int hfsplus_parse_options(char *, struct hfsplus_sb_info *);
int hfsplus_parse_options_remount(char *input, int *force);
void hfsplus_fill_defaults(struct hfsplus_sb_info *);
int hfsplus_show_options(struct seq_file *, struct dentry *);

/* super.c */
struct inode *hfsplus_iget(struct super_block *, unsigned long);
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 *,
		const struct hfsplus_unistr *);
int hfsplus_strcmp(const struct hfsplus_unistr *,
		const struct hfsplus_unistr *);
int hfsplus_uni2asc(struct super_block *,
		const struct hfsplus_unistr *, char *, int *);
int hfsplus_asc2uni(struct super_block *,
		struct hfsplus_unistr *, int, const char *, int);
int hfsplus_hash_dentry(const struct dentry *dentry,
		const struct inode *inode, struct qstr *str);
int hfsplus_compare_dentry(const struct dentry *parent,
		const struct inode *pinode,
		const struct dentry *dentry, const struct inode *inode,
		unsigned int len, const char *str, const struct qstr *name);

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

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