[mirror_ubuntu-zesty-kernel.git] / fs / befs / befs.h

/*
 * befs.h
 *
 * Copyright (C) 2001-2002 Will Dyson <will_dyson@pobox.com>
 * Copyright (C) 1999 Makoto Kato (m_kato@ga2.so-net.ne.jp)
 */

#ifndef _LINUX_BEFS_H
#define _LINUX_BEFS_H

#include "befs_fs_types.h"

/* used in debug.c */
#define BEFS_VERSION "0.9.3"


typedef u64 befs_blocknr_t;
/*
 * BeFS in memory structures
 */

struct befs_mount_options {
	kgid_t gid;
	kuid_t uid;
	int use_gid;
	int use_uid;
	int debug;
	char *iocharset;
};

struct befs_sb_info {
	u32 magic1;
	u32 block_size;
	u32 block_shift;
	int byte_order;
	befs_off_t num_blocks;
	befs_off_t used_blocks;
	u32 inode_size;
	u32 magic2;

	/* Allocation group information */
	u32 blocks_per_ag;
	u32 ag_shift;
	u32 num_ags;

	/* jornal log entry */
	befs_block_run log_blocks;
	befs_off_t log_start;
	befs_off_t log_end;

	befs_inode_addr root_dir;
	befs_inode_addr indices;
	u32 magic3;

	struct befs_mount_options mount_opts;
	struct nls_table *nls;
};

struct befs_inode_info {
	u32 i_flags;
	u32 i_type;

	befs_inode_addr i_inode_num;
	befs_inode_addr i_parent;
	befs_inode_addr i_attribute;

	union {
		befs_data_stream ds;
		char symlink[BEFS_SYMLINK_LEN];
	} i_data;

	struct inode vfs_inode;
};

enum befs_err {
	BEFS_OK,
	BEFS_ERR,
	BEFS_BAD_INODE,
	BEFS_BT_END,
	BEFS_BT_EMPTY,
	BEFS_BT_MATCH,
	BEFS_BT_PARMATCH,
	BEFS_BT_NOT_FOUND
};


/****************************/
/* debug.c */
__printf(2, 3)
void befs_error(const struct super_block *sb, const char *fmt, ...);
__printf(2, 3)
void befs_warning(const struct super_block *sb, const char *fmt, ...);
__printf(2, 3)
void befs_debug(const struct super_block *sb, const char *fmt, ...);

void befs_dump_super_block(const struct super_block *sb, befs_super_block *);
void befs_dump_inode(const struct super_block *sb, befs_inode *);
void befs_dump_index_entry(const struct super_block *sb, befs_disk_btree_super *);
void befs_dump_index_node(const struct super_block *sb, befs_btree_nodehead *);
/****************************/


/* Gets a pointer to the private portion of the super_block
 * structure from the public part
 */
static inline struct befs_sb_info *
BEFS_SB(const struct super_block *super)
{
	return (struct befs_sb_info *) super->s_fs_info;
}

static inline struct befs_inode_info *
BEFS_I(const struct inode *inode)
{
	return container_of(inode, struct befs_inode_info, vfs_inode);
}

static inline befs_blocknr_t
iaddr2blockno(struct super_block *sb, const befs_inode_addr *iaddr)
{
	return ((iaddr->allocation_group << BEFS_SB(sb)->ag_shift) +
		iaddr->start);
}

static inline befs_inode_addr
blockno2iaddr(struct super_block *sb, befs_blocknr_t blockno)
{
	befs_inode_addr iaddr;
	iaddr.allocation_group = blockno >> BEFS_SB(sb)->ag_shift;
	iaddr.start =
	    blockno - (iaddr.allocation_group << BEFS_SB(sb)->ag_shift);
	iaddr.len = 1;

	return iaddr;
}

static inline unsigned int
befs_iaddrs_per_block(struct super_block *sb)
{
	return BEFS_SB(sb)->block_size / sizeof (befs_disk_inode_addr);
}

static inline int
befs_iaddr_is_empty(const befs_inode_addr *iaddr)
{
	return (!iaddr->allocation_group) && (!iaddr->start) && (!iaddr->len);
}

static inline size_t
befs_brun_size(struct super_block *sb, befs_block_run run)
{
	return BEFS_SB(sb)->block_size * run.len;
}

#include "endian.h"

#endif				/* _LINUX_BEFS_H */
Commit	Line	Data
1da177e4 LT	1	/*
	2	* befs.h
	3	*
	4	* Copyright (C) 2001-2002 Will Dyson <will_dyson@pobox.com>
	5	* Copyright (C) 1999 Makoto Kato (m_kato@ga2.so-net.ne.jp)
	6	*/
	7
	8	#ifndef _LINUX_BEFS_H
	9	#define _LINUX_BEFS_H
	10
	11	#include "befs_fs_types.h"
	12
	13	/* used in debug.c */
	14	#define BEFS_VERSION "0.9.3"
	15
	16
	17	typedef u64 befs_blocknr_t;
	18	/*
	19	* BeFS in memory structures
	20	*/
	21
09ad0eae	22	struct befs_mount_options {
31aba059 EB	23	kgid_t gid;
31aba059 EB	24	kuid_t uid;
1da177e4 LT	25	int use_gid;
	26	int use_uid;
	27	int debug;
	28	char *iocharset;
09ad0eae	29	};
1da177e4	30
038428fc	31	struct befs_sb_info {
1da177e4 LT	32	u32 magic1;
	33	u32 block_size;
	34	u32 block_shift;
	35	int byte_order;
	36	befs_off_t num_blocks;
	37	befs_off_t used_blocks;
	38	u32 inode_size;
	39	u32 magic2;
	40
	41	/* Allocation group information */
	42	u32 blocks_per_ag;
	43	u32 ag_shift;
	44	u32 num_ags;
	45
	46	/* jornal log entry */
	47	befs_block_run log_blocks;
	48	befs_off_t log_start;
	49	befs_off_t log_end;
	50
	51	befs_inode_addr root_dir;
	52	befs_inode_addr indices;
	53	u32 magic3;
	54
09ad0eae	55	struct befs_mount_options mount_opts;
1da177e4	56	struct nls_table *nls;
038428fc	57	};
1da177e4	58
f8ccad21	59	struct befs_inode_info {
1da177e4 LT	60	u32 i_flags;
	61	u32 i_type;
	62
	63	befs_inode_addr i_inode_num;
	64	befs_inode_addr i_parent;
	65	befs_inode_addr i_attribute;
	66
	67	union {
	68	befs_data_stream ds;
	69	char symlink[BEFS_SYMLINK_LEN];
	70	} i_data;
	71
	72	struct inode vfs_inode;
f8ccad21	73	};
1da177e4 LT	74
	75	enum befs_err {
	76	BEFS_OK,
	77	BEFS_ERR,
	78	BEFS_BAD_INODE,
	79	BEFS_BT_END,
	80	BEFS_BT_EMPTY,
	81	BEFS_BT_MATCH,
	82	BEFS_BT_PARMATCH,
	83	BEFS_BT_NOT_FOUND
	84	};
	85
	86
	87	/****************************/
	88	/* debug.c */
dac52fc1	89	__printf(2, 3)
1da177e4	90	void befs_error(const struct super_block sb, const char fmt, ...);
dac52fc1	91	__printf(2, 3)
1da177e4	92	void befs_warning(const struct super_block sb, const char fmt, ...);
dac52fc1	93	__printf(2, 3)
1da177e4 LT	94	void befs_debug(const struct super_block sb, const char fmt, ...);
	95
	96	void befs_dump_super_block(const struct super_block sb, befs_super_block );
	97	void befs_dump_inode(const struct super_block sb, befs_inode );
a9721f31	98	void befs_dump_index_entry(const struct super_block sb, befs_disk_btree_super );
1da177e4 LT	99	void befs_dump_index_node(const struct super_block sb, befs_btree_nodehead );
	100	/****************************/
	101
	102
	103	/* Gets a pointer to the private portion of the super_block
	104	* structure from the public part
	105	*/
038428fc	106	static inline struct befs_sb_info *
1da177e4 LT	107	BEFS_SB(const struct super_block *super)
1da177e4 LT	108	{
038428fc	109	return (struct befs_sb_info *) super->s_fs_info;
1da177e4 LT	110	}
1da177e4 LT	111
f8ccad21	112	static inline struct befs_inode_info *
1da177e4 LT	113	BEFS_I(const struct inode *inode)
1da177e4 LT	114	{
db6172c4	115	return container_of(inode, struct befs_inode_info, vfs_inode);
1da177e4 LT	116	}
	117
	118	static inline befs_blocknr_t
22341d8f	119	iaddr2blockno(struct super_block sb, const befs_inode_addr iaddr)
1da177e4 LT	120	{
	121	return ((iaddr->allocation_group << BEFS_SB(sb)->ag_shift) +
	122	iaddr->start);
	123	}
	124
	125	static inline befs_inode_addr
	126	blockno2iaddr(struct super_block *sb, befs_blocknr_t blockno)
	127	{
	128	befs_inode_addr iaddr;
	129	iaddr.allocation_group = blockno >> BEFS_SB(sb)->ag_shift;
	130	iaddr.start =
	131	blockno - (iaddr.allocation_group << BEFS_SB(sb)->ag_shift);
	132	iaddr.len = 1;
	133
	134	return iaddr;
	135	}
	136
	137	static inline unsigned int
	138	befs_iaddrs_per_block(struct super_block *sb)
	139	{
a9721f31	140	return BEFS_SB(sb)->block_size / sizeof (befs_disk_inode_addr);
1da177e4 LT	141	}
	142
	143	static inline int
22341d8f	144	befs_iaddr_is_empty(const befs_inode_addr *iaddr)
1da177e4 LT	145	{
	146	return (!iaddr->allocation_group) && (!iaddr->start) && (!iaddr->len);
	147	}
	148
	149	static inline size_t
	150	befs_brun_size(struct super_block *sb, befs_block_run run)
	151	{
	152	return BEFS_SB(sb)->block_size * run.len;
	153	}
	154
af10b008 AV	155	#include "endian.h"
af10b008 AV	156
1da177e4	157	#endif /* _LINUX_BEFS_H */