[mirror_ubuntu-bionic-kernel.git] / fs / hfs / hfs_fs.h

/*
 *  linux/fs/hfs/hfs_fs.h
 *
 * Copyright (C) 1995-1997  Paul H. Hargrove
 * (C) 2003 Ardis Technologies <roman@ardistech.com>
 * This file may be distributed under the terms of the GNU General Public License.
 */

#ifndef _LINUX_HFS_FS_H
#define _LINUX_HFS_FS_H

#ifdef pr_fmt
#undef pr_fmt
#endif

#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt

#include <linux/slab.h>
#include <linux/types.h>
#include <linux/mutex.h>
#include <linux/buffer_head.h>
#include <linux/fs.h>
#include <linux/workqueue.h>

#include <asm/byteorder.h>
#include <linux/uaccess.h>

#include "hfs.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_MASK	(DBG_EXTENT|DBG_INODE|DBG_BNODE_MOD|DBG_CAT_MOD|DBG_BITMAP)
//#define DBG_MASK	(DBG_BNODE_MOD|DBG_CAT_MOD|DBG_INODE)
//#define DBG_MASK	(DBG_CAT_MOD|DBG_BNODE_REFS|DBG_INODE|DBG_EXTENT)
#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)


/*
 * struct hfs_inode_info
 *
 * The HFS-specific part of a Linux (struct inode)
 */
struct hfs_inode_info {
	atomic_t opencnt;

	unsigned int flags;

	/* to deal with localtime ugliness */
	int tz_secondswest;

	struct hfs_cat_key cat_key;

	struct list_head open_dir_list;
	spinlock_t open_dir_lock;
	struct inode *rsrc_inode;

	struct mutex extents_lock;

	u16 alloc_blocks, clump_blocks;
	sector_t fs_blocks;
	/* Allocation extents from catlog record or volume header */
	hfs_extent_rec first_extents;
	u16 first_blocks;
	hfs_extent_rec cached_extents;
	u16 cached_start, cached_blocks;

	loff_t phys_size;
	struct inode vfs_inode;
};

#define HFS_FLG_RSRC		0x0001
#define HFS_FLG_EXT_DIRTY	0x0002
#define HFS_FLG_EXT_NEW		0x0004

#define HFS_IS_RSRC(inode)	(HFS_I(inode)->flags & HFS_FLG_RSRC)

/*
 * struct hfs_sb_info
 *
 * The HFS-specific part of a Linux (struct super_block)
 */
struct hfs_sb_info {
	struct buffer_head *mdb_bh;		/* The hfs_buffer
						   holding the real
						   superblock (aka VIB
						   or MDB) */
	struct hfs_mdb *mdb;
	struct buffer_head *alt_mdb_bh;		/* The hfs_buffer holding
						   the alternate superblock */
	struct hfs_mdb *alt_mdb;
	__be32 *bitmap;				/* The page holding the
						   allocation bitmap */
	struct hfs_btree *ext_tree;			/* Information about
						   the extents b-tree */
	struct hfs_btree *cat_tree;			/* Information about
						   the catalog b-tree */
	u32 file_count;				/* The number of
						   regular files in
						   the filesystem */
	u32 folder_count;			/* The number of
						   directories in the
						   filesystem */
	u32 next_id;				/* The next available
						   file id number */
	u32 clumpablks;				/* The number of allocation
						   blocks to try to add when
						   extending a file */
	u32 fs_start;				/* The first 512-byte
						   block represented
						   in the bitmap */
	u32 part_start;
	u16 root_files;				/* The number of
						   regular
						   (non-directory)
						   files in the root
						   directory */
	u16 root_dirs;				/* The number of
						   directories in the
						   root directory */
	u16 fs_ablocks;				/* The number of
						   allocation blocks
						   in the filesystem */
	u16 free_ablocks;			/* the number of unused
						   allocation blocks
						   in the filesystem */
	u32 alloc_blksz;			/* The size of an
						   "allocation block" */
	int s_quiet;				/* Silent failure when
						   changing owner or mode? */
	__be32 s_type;				/* Type for new files */
	__be32 s_creator;			/* Creator for new files */
	umode_t s_file_umask;			/* The umask applied to the
						   permissions on all files */
	umode_t s_dir_umask;			/* The umask applied to the
						   permissions on all dirs */
	kuid_t s_uid;				/* The uid of all files */
	kgid_t s_gid;				/* The gid of all files */

	int session, part;
	struct nls_table *nls_io, *nls_disk;
	struct mutex bitmap_lock;
	unsigned long flags;
	u16 blockoffset;
	int fs_div;
	struct super_block *sb;
	int work_queued;		/* non-zero delayed work is queued */
	struct delayed_work mdb_work;	/* MDB flush delayed work */
	spinlock_t work_lock;		/* protects mdb_work and work_queued */
};

#define HFS_FLG_BITMAP_DIRTY	0
#define HFS_FLG_MDB_DIRTY	1
#define HFS_FLG_ALT_MDB_DIRTY	2

/* bitmap.c */
extern u32 hfs_vbm_search_free(struct super_block *, u32, u32 *);
extern int hfs_clear_vbm_bits(struct super_block *, u16, u16);

/* catalog.c */
extern int hfs_cat_keycmp(const btree_key *, const btree_key *);
struct hfs_find_data;
extern int hfs_cat_find_brec(struct super_block *, u32, struct hfs_find_data *);
extern int hfs_cat_create(u32, struct inode *, const struct qstr *, struct inode *);
extern int hfs_cat_delete(u32, struct inode *, const struct qstr *);
extern int hfs_cat_move(u32, struct inode *, const struct qstr *,
			struct inode *, const struct qstr *);
extern void hfs_cat_build_key(struct super_block *, btree_key *, u32, const struct qstr *);

/* dir.c */
extern const struct file_operations hfs_dir_operations;
extern const struct inode_operations hfs_dir_inode_operations;

/* extent.c */
extern int hfs_ext_keycmp(const btree_key *, const btree_key *);
extern int hfs_free_fork(struct super_block *, struct hfs_cat_file *, int);
extern int hfs_ext_write_extent(struct inode *);
extern int hfs_extend_file(struct inode *);
extern void hfs_file_truncate(struct inode *);

extern int hfs_get_block(struct inode *, sector_t, struct buffer_head *, int);

/* inode.c */
extern const struct address_space_operations hfs_aops;
extern const struct address_space_operations hfs_btree_aops;

extern struct inode *hfs_new_inode(struct inode *, const struct qstr *, umode_t);
extern void hfs_inode_write_fork(struct inode *, struct hfs_extent *, __be32 *, __be32 *);
extern int hfs_write_inode(struct inode *, struct writeback_control *);
extern int hfs_inode_setattr(struct dentry *, struct iattr *);
extern void hfs_inode_read_fork(struct inode *inode, struct hfs_extent *ext,
			__be32 log_size, __be32 phys_size, u32 clump_size);
extern struct inode *hfs_iget(struct super_block *, struct hfs_cat_key *, hfs_cat_rec *);
extern void hfs_evict_inode(struct inode *);
extern void hfs_delete_inode(struct inode *);

/* attr.c */
extern const struct xattr_handler *hfs_xattr_handlers[];

/* mdb.c */
extern int hfs_mdb_get(struct super_block *);
extern void hfs_mdb_commit(struct super_block *);
extern void hfs_mdb_close(struct super_block *);
extern void hfs_mdb_put(struct super_block *);

/* part_tbl.c */
extern int hfs_part_find(struct super_block *, sector_t *, sector_t *);

/* string.c */
extern const struct dentry_operations hfs_dentry_operations;

extern int hfs_hash_dentry(const struct dentry *, struct qstr *);
extern int hfs_strcmp(const unsigned char *, unsigned int,
		      const unsigned char *, unsigned int);
extern int hfs_compare_dentry(const struct dentry *dentry,
		unsigned int len, const char *str, const struct qstr *name);

/* trans.c */
extern void hfs_asc2mac(struct super_block *, struct hfs_name *, const struct qstr *);
extern int hfs_mac2asc(struct super_block *, char *, const struct hfs_name *);

/* super.c */
extern void hfs_mark_mdb_dirty(struct super_block *sb);

/*
 * There are two time systems.  Both are based on seconds since
 * a particular time/date.
 *	Unix:	unsigned lil-endian since 00:00 GMT, Jan. 1, 1970
 *	mac:	unsigned big-endian since 00:00 GMT, Jan. 1, 1904
 *
 */
#define __hfs_u_to_mtime(sec)	cpu_to_be32(sec + 2082844800U - sys_tz.tz_minuteswest * 60)
#define __hfs_m_to_utime(sec)	(be32_to_cpu(sec) - 2082844800U  + sys_tz.tz_minuteswest * 60)

#define HFS_I(inode)	(container_of(inode, struct hfs_inode_info, vfs_inode))
#define HFS_SB(sb)	((struct hfs_sb_info *)(sb)->s_fs_info)

#define hfs_m_to_utime(time)	(struct timespec){ .tv_sec = __hfs_m_to_utime(time) }
#define hfs_u_to_mtime(time)	__hfs_u_to_mtime((time).tv_sec)
#define hfs_mtime()		__hfs_u_to_mtime(get_seconds())

static inline const char *hfs_mdb_name(struct super_block *sb)
{
	return sb->s_id;
}

static inline void hfs_bitmap_dirty(struct super_block *sb)
{
	set_bit(HFS_FLG_BITMAP_DIRTY, &HFS_SB(sb)->flags);
	hfs_mark_mdb_dirty(sb);
}

#define sb_bread512(sb, sec, data) ({			\
	struct buffer_head *__bh;			\
	sector_t __block;				\
	loff_t __start;					\
	int __offset;					\
							\
	__start = (loff_t)(sec) << HFS_SECTOR_SIZE_BITS;\
	__block = __start >> (sb)->s_blocksize_bits;	\
	__offset = __start & ((sb)->s_blocksize - 1);	\
	__bh = sb_bread((sb), __block);			\
	if (likely(__bh != NULL))			\
		data = (void *)(__bh->b_data + __offset);\
	else						\
		data = NULL;				\
	__bh;						\
})

#endif
Commit	Line	Data
1da177e4 LT	1	/*
	2	* linux/fs/hfs/hfs_fs.h
	3	*
	4	* Copyright (C) 1995-1997 Paul H. Hargrove
	5	* (C) 2003 Ardis Technologies <roman@ardistech.com>
	6	* This file may be distributed under the terms of the GNU General Public License.
	7	*/
	8
	9	#ifndef _LINUX_HFS_FS_H
	10	#define _LINUX_HFS_FS_H
	11
d6142673 JP	12	#ifdef pr_fmt
	13	#undef pr_fmt
	14	#endif
	15
	16	#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
	17
1da177e4 LT	18	#include <linux/slab.h>
1da177e4 LT	19	#include <linux/types.h>
3084b72d	20	#include <linux/mutex.h>
1da177e4 LT	21	#include <linux/buffer_head.h>
1da177e4 LT	22	#include <linux/fs.h>
5687b578	23	#include <linux/workqueue.h>
1da177e4 LT	24
1da177e4 LT	25	#include <asm/byteorder.h>
7c0f6ba6	26	#include <linux/uaccess.h>
1da177e4 LT	27
	28	#include "hfs.h"
	29
	30	#define DBG_BNODE_REFS 0x00000001
	31	#define DBG_BNODE_MOD 0x00000002
	32	#define DBG_CAT_MOD 0x00000004
	33	#define DBG_INODE 0x00000008
	34	#define DBG_SUPER 0x00000010
	35	#define DBG_EXTENT 0x00000020
	36	#define DBG_BITMAP 0x00000040
	37
	38	//#define DBG_MASK (DBG_EXTENT\|DBG_INODE\|DBG_BNODE_MOD\|DBG_CAT_MOD\|DBG_BITMAP)
	39	//#define DBG_MASK (DBG_BNODE_MOD\|DBG_CAT_MOD\|DBG_INODE)
	40	//#define DBG_MASK (DBG_CAT_MOD\|DBG_BNODE_REFS\|DBG_INODE\|DBG_EXTENT)
	41	#define DBG_MASK (0)
	42
d6142673 JP	43	#define hfs_dbg(flg, fmt, ...) \
	44	do { \
	45	if (DBG_##flg & DBG_MASK) \
	46	printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__); \
c2b3e1f7 JP	47	} while (0)
c2b3e1f7 JP	48
d6142673 JP	49	#define hfs_dbg_cont(flg, fmt, ...) \
	50	do { \
	51	if (DBG_##flg & DBG_MASK) \
	52	pr_cont(fmt, ##__VA_ARGS__); \
c2b3e1f7 JP	53	} while (0)
c2b3e1f7 JP	54
1da177e4	55
1da177e4 LT	56	/*
	57	* struct hfs_inode_info
	58	*
	59	* The HFS-specific part of a Linux (struct inode)
	60	*/
	61	struct hfs_inode_info {
	62	atomic_t opencnt;
	63
	64	unsigned int flags;
	65
	66	/* to deal with localtime ugliness */
	67	int tz_secondswest;
	68
	69	struct hfs_cat_key cat_key;
	70
	71	struct list_head open_dir_list;
9717a91b	72	spinlock_t open_dir_lock;
1da177e4 LT	73	struct inode *rsrc_inode;
1da177e4 LT	74
39f8d472	75	struct mutex extents_lock;
1da177e4 LT	76
	77	u16 alloc_blocks, clump_blocks;
	78	sector_t fs_blocks;
	79	/* Allocation extents from catlog record or volume header */
	80	hfs_extent_rec first_extents;
	81	u16 first_blocks;
	82	hfs_extent_rec cached_extents;
	83	u16 cached_start, cached_blocks;
	84
	85	loff_t phys_size;
	86	struct inode vfs_inode;
	87	};
	88
	89	#define HFS_FLG_RSRC 0x0001
	90	#define HFS_FLG_EXT_DIRTY 0x0002
	91	#define HFS_FLG_EXT_NEW 0x0004
	92
	93	#define HFS_IS_RSRC(inode) (HFS_I(inode)->flags & HFS_FLG_RSRC)
	94
	95	/*
	96	* struct hfs_sb_info
	97	*
	98	* The HFS-specific part of a Linux (struct super_block)
	99	*/
	100	struct hfs_sb_info {
	101	struct buffer_head mdb_bh; / The hfs_buffer
	102	holding the real
	103	superblock (aka VIB
	104	or MDB) */
	105	struct hfs_mdb *mdb;
	106	struct buffer_head alt_mdb_bh; / The hfs_buffer holding
	107	the alternate superblock */
	108	struct hfs_mdb *alt_mdb;
	109	__be32 bitmap; / The page holding the
	110	allocation bitmap */
	111	struct hfs_btree ext_tree; / Information about
	112	the extents b-tree */
	113	struct hfs_btree cat_tree; / Information about
	114	the catalog b-tree */
	115	u32 file_count; /* The number of
	116	regular files in
	117	the filesystem */
	118	u32 folder_count; /* The number of
	119	directories in the
	120	filesystem */
	121	u32 next_id; /* The next available
	122	file id number */
	123	u32 clumpablks; /* The number of allocation
	124	blocks to try to add when
	125	extending a file */
	126	u32 fs_start; /* The first 512-byte
	127	block represented
	128	in the bitmap */
	129	u32 part_start;
	130	u16 root_files; /* The number of
	131	regular
	132	(non-directory)
	133	files in the root
	134	directory */
	135	u16 root_dirs; /* The number of
	136	directories in the
	137	root directory */
	138	u16 fs_ablocks; /* The number of
	139	allocation blocks
140	in the filesystem */
141	u16 free_ablocks; /* the number of unused
142	allocation blocks
143	in the filesystem */
144	u32 alloc_blksz; /* The size of an
145	"allocation block" */
146	int s_quiet; /* Silent failure when
147	changing owner or mode? */
148	__be32 s_type; /* Type for new files */
149	__be32 s_creator; /* Creator for new files */
150	umode_t s_file_umask; /* The umask applied to the
151	permissions on all files */
152	umode_t s_dir_umask; /* The umask applied to the
153	permissions on all dirs */
43b5e4cc EB	154	kuid_t s_uid; /* The uid of all files */
43b5e4cc EB	155	kgid_t s_gid; /* The gid of all files */
1da177e4 LT	156
1da177e4 LT	157	int session, part;
328b9227	158	struct nls_table nls_io, nls_disk;
3084b72d	159	struct mutex bitmap_lock;
1da177e4	160	unsigned long flags;
1da177e4	161	u16 blockoffset;
1da177e4	162	int fs_div;
b16ca626	163	struct super_block *sb;
5687b578 AB	164	int work_queued; /* non-zero delayed work is queued */
	165	struct delayed_work mdb_work; /* MDB flush delayed work */
	166	spinlock_t work_lock; /* protects mdb_work and work_queued */
1da177e4 LT	167	};
	168
	169	#define HFS_FLG_BITMAP_DIRTY 0
	170	#define HFS_FLG_MDB_DIRTY 1
	171	#define HFS_FLG_ALT_MDB_DIRTY 2
	172
	173	/* bitmap.c */
	174	extern u32 hfs_vbm_search_free(struct super_block , u32, u32 );
	175	extern int hfs_clear_vbm_bits(struct super_block *, u16, u16);
	176
	177	/* catalog.c */
	178	extern int hfs_cat_keycmp(const btree_key , const btree_key );
	179	struct hfs_find_data;
	180	extern int hfs_cat_find_brec(struct super_block , u32, struct hfs_find_data );
71e93963 AV	181	extern int hfs_cat_create(u32, struct inode , const struct qstr , struct inode *);
	182	extern int hfs_cat_delete(u32, struct inode , const struct qstr );
	183	extern int hfs_cat_move(u32, struct inode , const struct qstr ,
	184	struct inode , const struct qstr );
	185	extern void hfs_cat_build_key(struct super_block , btree_key , u32, const struct qstr *);
1da177e4 LT	186
1da177e4 LT	187	/* dir.c */
4b6f5d20	188	extern const struct file_operations hfs_dir_operations;
92e1d5be	189	extern const struct inode_operations hfs_dir_inode_operations;
1da177e4 LT	190
	191	/* extent.c */
	192	extern int hfs_ext_keycmp(const btree_key , const btree_key );
	193	extern int hfs_free_fork(struct super_block , struct hfs_cat_file , int);
9509f178	194	extern int hfs_ext_write_extent(struct inode *);
1da177e4 LT	195	extern int hfs_extend_file(struct inode *);
	196	extern void hfs_file_truncate(struct inode *);
	197
	198	extern int hfs_get_block(struct inode , sector_t, struct buffer_head , int);
	199
	200	/* inode.c */
f5e54d6e CH	201	extern const struct address_space_operations hfs_aops;
f5e54d6e CH	202	extern const struct address_space_operations hfs_btree_aops;
1da177e4	203
71e93963	204	extern struct inode hfs_new_inode(struct inode , const struct qstr *, umode_t);
1da177e4	205	extern void hfs_inode_write_fork(struct inode , struct hfs_extent , __be32 , __be32 );
a9185b41	206	extern int hfs_write_inode(struct inode , struct writeback_control );
1da177e4 LT	207	extern int hfs_inode_setattr(struct dentry , struct iattr );
	208	extern void hfs_inode_read_fork(struct inode inode, struct hfs_extent ext,
	209	__be32 log_size, __be32 phys_size, u32 clump_size);
	210	extern struct inode hfs_iget(struct super_block , struct hfs_cat_key , hfs_cat_rec );
b57922d9	211	extern void hfs_evict_inode(struct inode *);
1da177e4 LT	212	extern void hfs_delete_inode(struct inode *);
	213
	214	/* attr.c */
b8020eff	215	extern const struct xattr_handler *hfs_xattr_handlers[];
1da177e4 LT	216
	217	/* mdb.c */
	218	extern int hfs_mdb_get(struct super_block *);
	219	extern void hfs_mdb_commit(struct super_block *);
	220	extern void hfs_mdb_close(struct super_block *);
	221	extern void hfs_mdb_put(struct super_block *);
	222
	223	/* part_tbl.c */
	224	extern int hfs_part_find(struct super_block , sector_t , sector_t *);
	225
	226	/* string.c */
e16404ed	227	extern const struct dentry_operations hfs_dentry_operations;
1da177e4	228
da53be12	229	extern int hfs_hash_dentry(const struct dentry , struct qstr );
1da177e4 LT	230	extern int hfs_strcmp(const unsigned char *, unsigned int,
1da177e4 LT	231	const unsigned char *, unsigned int);
6fa67e70	232	extern int hfs_compare_dentry(const struct dentry *dentry,
621e155a	233	unsigned int len, const char str, const struct qstr name);
1da177e4 LT	234
1da177e4 LT	235	/* trans.c */
71e93963	236	extern void hfs_asc2mac(struct super_block , struct hfs_name , const struct qstr *);
328b9227	237	extern int hfs_mac2asc(struct super_block , char , const struct hfs_name *);
1da177e4	238
5687b578 AB	239	/* super.c */
	240	extern void hfs_mark_mdb_dirty(struct super_block *sb);
	241
1da177e4 LT	242	/*
	243	* There are two time systems. Both are based on seconds since
	244	* a particular time/date.
	245	* Unix: unsigned lil-endian since 00:00 GMT, Jan. 1, 1970
	246	* mac: unsigned big-endian since 00:00 GMT, Jan. 1, 1904
	247	*
	248	*/
	249	#define __hfs_u_to_mtime(sec) cpu_to_be32(sec + 2082844800U - sys_tz.tz_minuteswest * 60)
	250	#define __hfs_m_to_utime(sec) (be32_to_cpu(sec) - 2082844800U + sys_tz.tz_minuteswest * 60)
	251
db6172c4	252	#define HFS_I(inode) (container_of(inode, struct hfs_inode_info, vfs_inode))
1da177e4 LT	253	#define HFS_SB(sb) ((struct hfs_sb_info *)(sb)->s_fs_info)
	254
	255	#define hfs_m_to_utime(time) (struct timespec){ .tv_sec = __hfs_m_to_utime(time) }
	256	#define hfs_u_to_mtime(time) __hfs_u_to_mtime((time).tv_sec)
	257	#define hfs_mtime() __hfs_u_to_mtime(get_seconds())
	258
	259	static inline const char hfs_mdb_name(struct super_block sb)
	260	{
	261	return sb->s_id;
	262	}
	263
	264	static inline void hfs_bitmap_dirty(struct super_block *sb)
	265	{
	266	set_bit(HFS_FLG_BITMAP_DIRTY, &HFS_SB(sb)->flags);
5687b578	267	hfs_mark_mdb_dirty(sb);
1da177e4 LT	268	}
1da177e4 LT	269
1da177e4 LT	270	#define sb_bread512(sb, sec, data) ({ \
	271	struct buffer_head *__bh; \
	272	sector_t __block; \
	273	loff_t __start; \
	274	int __offset; \
	275	\
	276	__start = (loff_t)(sec) << HFS_SECTOR_SIZE_BITS;\
	277	__block = __start >> (sb)->s_blocksize_bits; \
	278	__offset = __start & ((sb)->s_blocksize - 1); \
	279	__bh = sb_bread((sb), __block); \
	280	if (likely(__bh != NULL)) \
	281	data = (void *)(__bh->b_data + __offset);\
	282	else \
	283	data = NULL; \
	284	__bh; \
	285	})
	286
	287	#endif