[linux-2.6-block.git] / fs / adfs / adfs.h

#include <linux/fs.h>
#include <linux/adfs_fs.h>

/* Internal data structures for ADFS */

#define ADFS_FREE_FRAG		 0
#define ADFS_BAD_FRAG		 1
#define ADFS_ROOT_FRAG		 2

#define ADFS_NDA_OWNER_READ	(1 << 0)
#define ADFS_NDA_OWNER_WRITE	(1 << 1)
#define ADFS_NDA_LOCKED		(1 << 2)
#define ADFS_NDA_DIRECTORY	(1 << 3)
#define ADFS_NDA_EXECUTE	(1 << 4)
#define ADFS_NDA_PUBLIC_READ	(1 << 5)
#define ADFS_NDA_PUBLIC_WRITE	(1 << 6)

#include "dir_f.h"

struct buffer_head;

/*
 * adfs file system inode data in memory
 */
struct adfs_inode_info {
	loff_t		mmu_private;
	unsigned long	parent_id;	/* object id of parent		*/
	__u32		loadaddr;	/* RISC OS load address		*/
	__u32		execaddr;	/* RISC OS exec address		*/
	unsigned int	filetype;	/* RISC OS file type		*/
	unsigned int	attr;		/* RISC OS permissions		*/
	unsigned int	stamped:1;	/* RISC OS file has date/time	*/
	struct inode vfs_inode;
};

/*
 * Forward-declare this
 */
struct adfs_discmap;
struct adfs_dir_ops;

/*
 * ADFS file system superblock data in memory
 */
struct adfs_sb_info {
	union { struct {
		struct adfs_discmap *s_map;	/* bh list containing map	 */
		struct adfs_dir_ops *s_dir;	/* directory operations		 */
		};
		struct rcu_head rcu;		/* used only at shutdown time	 */
	};
	kuid_t		s_uid;		/* owner uid				 */
	kgid_t		s_gid;		/* owner gid				 */
	umode_t		s_owner_mask;	/* ADFS owner perm -> unix perm		 */
	umode_t		s_other_mask;	/* ADFS other perm -> unix perm		 */
	int		s_ftsuffix;	/* ,xyz hex filetype suffix option */

	__u32		s_ids_per_zone;	/* max. no ids in one zone		 */
	__u32		s_idlen;	/* length of ID in map			 */
	__u32		s_map_size;	/* sector size of a map			 */
	unsigned long	s_size;		/* total size (in blocks) of this fs	 */
	signed int	s_map2blk;	/* shift left by this for map->sector	 */
	unsigned int	s_log2sharesize;/* log2 share size			 */
	__le32		s_version;	/* disc format version			 */
	unsigned int	s_namelen;	/* maximum number of characters in name	 */
};

static inline struct adfs_sb_info *ADFS_SB(struct super_block *sb)
{
	return sb->s_fs_info;
}

static inline struct adfs_inode_info *ADFS_I(struct inode *inode)
{
	return container_of(inode, struct adfs_inode_info, vfs_inode);
}

/*
 * Directory handling
 */
struct adfs_dir {
	struct super_block	*sb;

	int			nr_buffers;
	struct buffer_head	*bh[4];

	/* big directories need allocated buffers */
	struct buffer_head	**bh_fplus;

	unsigned int		pos;
	unsigned int		parent_id;

	struct adfs_dirheader	dirhead;
	union  adfs_dirtail	dirtail;
};

/*
 * This is the overall maximum name length
 */
#define ADFS_MAX_NAME_LEN	(256 + 4) /* +4 for ,xyz hex filetype suffix */
struct object_info {
	__u32		parent_id;		/* parent object id	*/
	__u32		file_id;		/* object id		*/
	__u32		loadaddr;		/* load address		*/
	__u32		execaddr;		/* execution address	*/
	__u32		size;			/* size			*/
	__u8		attr;			/* RISC OS attributes	*/
	unsigned int	name_len;		/* name length		*/
	char		name[ADFS_MAX_NAME_LEN];/* file name		*/

	/* RISC OS file type (12-bit: derived from loadaddr) */
	__u16		filetype;
};

/* RISC OS 12-bit filetype converts to ,xyz hex filename suffix */
static inline int append_filetype_suffix(char *buf, __u16 filetype)
{
	if (filetype == 0xffff)	/* no explicit 12-bit file type was set */
		return 0;

	*buf++ = ',';
	*buf++ = hex_asc_lo(filetype >> 8);
	*buf++ = hex_asc_lo(filetype >> 4);
	*buf++ = hex_asc_lo(filetype >> 0);
	return 4;
}

struct adfs_dir_ops {
	int	(*read)(struct super_block *sb, unsigned int id, unsigned int sz, struct adfs_dir *dir);
	int	(*setpos)(struct adfs_dir *dir, unsigned int fpos);
	int	(*getnext)(struct adfs_dir *dir, struct object_info *obj);
	int	(*update)(struct adfs_dir *dir, struct object_info *obj);
	int	(*create)(struct adfs_dir *dir, struct object_info *obj);
	int	(*remove)(struct adfs_dir *dir, struct object_info *obj);
	int	(*sync)(struct adfs_dir *dir);
	void	(*free)(struct adfs_dir *dir);
};

struct adfs_discmap {
	struct buffer_head	*dm_bh;
	__u32			dm_startblk;
	unsigned int		dm_startbit;
	unsigned int		dm_endbit;
};

/* Inode stuff */
struct inode *adfs_iget(struct super_block *sb, struct object_info *obj);
int adfs_write_inode(struct inode *inode, struct writeback_control *wbc);
int adfs_notify_change(struct dentry *dentry, struct iattr *attr);

/* map.c */
extern int adfs_map_lookup(struct super_block *sb, unsigned int frag_id, unsigned int offset);
extern unsigned int adfs_map_free(struct super_block *sb);

/* Misc */
__printf(3, 4)
void __adfs_error(struct super_block *sb, const char *function,
		  const char *fmt, ...);
#define adfs_error(sb, fmt...) __adfs_error(sb, __func__, fmt)

/* super.c */

/*
 * Inodes and file operations
 */

/* dir_*.c */
extern const struct inode_operations adfs_dir_inode_operations;
extern const struct file_operations adfs_dir_operations;
extern const struct dentry_operations adfs_dentry_operations;
extern struct adfs_dir_ops adfs_f_dir_ops;
extern struct adfs_dir_ops adfs_fplus_dir_ops;

extern int adfs_dir_update(struct super_block *sb, struct object_info *obj,
			   int wait);

/* file.c */
extern const struct inode_operations adfs_file_inode_operations;
extern const struct file_operations adfs_file_operations;

static inline __u32 signed_asl(__u32 val, signed int shift)
{
	if (shift >= 0)
		val <<= shift;
	else
		val >>= -shift;
	return val;
}

/*
 * Calculate the address of a block in an object given the block offset
 * and the object identity.
 *
 * The root directory ID should always be looked up in the map [3.4]
 */
static inline int
__adfs_block_map(struct super_block *sb, unsigned int object_id,
		 unsigned int block)
{
	if (object_id & 255) {
		unsigned int off;

		off = (object_id & 255) - 1;
		block += off << ADFS_SB(sb)->s_log2sharesize;
	}

	return adfs_map_lookup(sb, object_id >> 8, block);
}
Commit	Line	Data
608ba50b AV	1	#include <linux/fs.h>
	2	#include <linux/adfs_fs.h>
	3
1da177e4 LT	4	/* Internal data structures for ADFS */
	5
	6	#define ADFS_FREE_FRAG 0
	7	#define ADFS_BAD_FRAG 1
	8	#define ADFS_ROOT_FRAG 2
	9
	10	#define ADFS_NDA_OWNER_READ (1 << 0)
	11	#define ADFS_NDA_OWNER_WRITE (1 << 1)
	12	#define ADFS_NDA_LOCKED (1 << 2)
	13	#define ADFS_NDA_DIRECTORY (1 << 3)
	14	#define ADFS_NDA_EXECUTE (1 << 4)
	15	#define ADFS_NDA_PUBLIC_READ (1 << 5)
	16	#define ADFS_NDA_PUBLIC_WRITE (1 << 6)
	17
1da177e4 LT	18	#include "dir_f.h"
	19
	20	struct buffer_head;
	21
608ba50b AV	22	/*
	23	* adfs file system inode data in memory
	24	*/
	25	struct adfs_inode_info {
	26	loff_t mmu_private;
	27	unsigned long parent_id; /* object id of parent */
	28	__u32 loadaddr; /* RISC OS load address */
	29	__u32 execaddr; /* RISC OS exec address */
	30	unsigned int filetype; /* RISC OS file type */
	31	unsigned int attr; /* RISC OS permissions */
	32	unsigned int stamped:1; /* RISC OS file has date/time */
	33	struct inode vfs_inode;
	34	};
	35
	36	/*
	37	* Forward-declare this
	38	*/
	39	struct adfs_discmap;
	40	struct adfs_dir_ops;
	41
	42	/*
	43	* ADFS file system superblock data in memory
	44	*/
	45	struct adfs_sb_info {
2d1d9b5b AV	46	union { struct {
	47	struct adfs_discmap s_map; / bh list containing map */
	48	struct adfs_dir_ops s_dir; / directory operations */
	49	};
	50	struct rcu_head rcu; /* used only at shutdown time */
	51	};
c010d1ff EB	52	kuid_t s_uid; /* owner uid */
c010d1ff EB	53	kgid_t s_gid; /* owner gid */
608ba50b AV	54	umode_t s_owner_mask; /* ADFS owner perm -> unix perm */
608ba50b AV	55	umode_t s_other_mask; /* ADFS other perm -> unix perm */
da23ef05	56	int s_ftsuffix; /* ,xyz hex filetype suffix option */
608ba50b AV	57
	58	__u32 s_ids_per_zone; /* max. no ids in one zone */
	59	__u32 s_idlen; /* length of ID in map */
	60	__u32 s_map_size; /* sector size of a map */
	61	unsigned long s_size; /* total size (in blocks) of this fs */
	62	signed int s_map2blk; /* shift left by this for map->sector */
	63	unsigned int s_log2sharesize;/* log2 share size */
	64	__le32 s_version; /* disc format version */
	65	unsigned int s_namelen; /* maximum number of characters in name */
	66	};
	67
	68	static inline struct adfs_sb_info ADFS_SB(struct super_block sb)
	69	{
	70	return sb->s_fs_info;
	71	}
	72
	73	static inline struct adfs_inode_info ADFS_I(struct inode inode)
	74	{
	75	return container_of(inode, struct adfs_inode_info, vfs_inode);
	76	}
	77
1da177e4 LT	78	/*
	79	* Directory handling
	80	*/
	81	struct adfs_dir {
	82	struct super_block *sb;
	83
	84	int nr_buffers;
	85	struct buffer_head *bh[4];
2f09719a SS	86
	87	/* big directories need allocated buffers */
	88	struct buffer_head **bh_fplus;
	89
1da177e4 LT	90	unsigned int pos;
	91	unsigned int parent_id;
	92
	93	struct adfs_dirheader dirhead;
	94	union adfs_dirtail dirtail;
	95	};
	96
	97	/*
	98	* This is the overall maximum name length
	99	*/
da23ef05	100	#define ADFS_MAX_NAME_LEN (256 + 4) /* +4 for ,xyz hex filetype suffix */
1da177e4 LT	101	struct object_info {
	102	__u32 parent_id; /* parent object id */
	103	__u32 file_id; /* object id */
	104	__u32 loadaddr; /* load address */
	105	__u32 execaddr; /* execution address */
	106	__u32 size; /* size */
	107	__u8 attr; /* RISC OS attributes */
da23ef05	108	unsigned int name_len; /* name length */
1da177e4	109	char name[ADFS_MAX_NAME_LEN];/* file name */
da23ef05 SS	110
	111	/* RISC OS file type (12-bit: derived from loadaddr) */
	112	__u16 filetype;
1da177e4 LT	113	};
1da177e4 LT	114
da23ef05 SS	115	/* RISC OS 12-bit filetype converts to ,xyz hex filename suffix */
	116	static inline int append_filetype_suffix(char *buf, __u16 filetype)
	117	{
135a9fcf	118	if (filetype == 0xffff) /* no explicit 12-bit file type was set */
da23ef05 SS	119	return 0;
	120
	121	*buf++ = ',';
	122	*buf++ = hex_asc_lo(filetype >> 8);
	123	*buf++ = hex_asc_lo(filetype >> 4);
	124	*buf++ = hex_asc_lo(filetype >> 0);
	125	return 4;
	126	}
	127
1da177e4 LT	128	struct adfs_dir_ops {
	129	int (read)(struct super_block sb, unsigned int id, unsigned int sz, struct adfs_dir *dir);
	130	int (setpos)(struct adfs_dir dir, unsigned int fpos);
	131	int (getnext)(struct adfs_dir dir, struct object_info *obj);
	132	int (update)(struct adfs_dir dir, struct object_info *obj);
	133	int (create)(struct adfs_dir dir, struct object_info *obj);
	134	int (remove)(struct adfs_dir dir, struct object_info *obj);
ffdc9064	135	int (sync)(struct adfs_dir dir);
1da177e4 LT	136	void (free)(struct adfs_dir dir);
	137	};
	138
	139	struct adfs_discmap {
	140	struct buffer_head *dm_bh;
	141	__u32 dm_startblk;
	142	unsigned int dm_startbit;
	143	unsigned int dm_endbit;
	144	};
	145
	146	/* Inode stuff */
	147	struct inode adfs_iget(struct super_block sb, struct object_info *obj);
a9185b41	148	int adfs_write_inode(struct inode inode, struct writeback_control wbc);
1da177e4 LT	149	int adfs_notify_change(struct dentry dentry, struct iattr attr);
	150
	151	/* map.c */
	152	extern int adfs_map_lookup(struct super_block *sb, unsigned int frag_id, unsigned int offset);
	153	extern unsigned int adfs_map_free(struct super_block *sb);
	154
	155	/* Misc */
19bdd41a	156	__printf(3, 4)
1da177e4 LT	157	void __adfs_error(struct super_block sb, const char function,
1da177e4 LT	158	const char *fmt, ...);
8e24eea7	159	#define adfs_error(sb, fmt...) __adfs_error(sb, __func__, fmt)
1da177e4 LT	160
	161	/* super.c */
	162
	163	/*
	164	* Inodes and file operations
	165	*/
	166
	167	/* dir_.c /
754661f1	168	extern const struct inode_operations adfs_dir_inode_operations;
4b6f5d20	169	extern const struct file_operations adfs_dir_operations;
e16404ed	170	extern const struct dentry_operations adfs_dentry_operations;
1da177e4 LT	171	extern struct adfs_dir_ops adfs_f_dir_ops;
	172	extern struct adfs_dir_ops adfs_fplus_dir_ops;
	173
ffdc9064 AV	174	extern int adfs_dir_update(struct super_block sb, struct object_info obj,
ffdc9064 AV	175	int wait);
1da177e4 LT	176
1da177e4 LT	177	/* file.c */
754661f1	178	extern const struct inode_operations adfs_file_inode_operations;
4b6f5d20	179	extern const struct file_operations adfs_file_operations;
1da177e4	180
e0c93142	181	static inline __u32 signed_asl(__u32 val, signed int shift)
1da177e4 LT	182	{
	183	if (shift >= 0)
	184	val <<= shift;
	185	else
	186	val >>= -shift;
	187	return val;
	188	}
	189
	190	/*
	191	* Calculate the address of a block in an object given the block offset
	192	* and the object identity.
	193	*
	194	* The root directory ID should always be looked up in the map [3.4]
	195	*/
e0c93142	196	static inline int
1da177e4 LT	197	__adfs_block_map(struct super_block *sb, unsigned int object_id,
	198	unsigned int block)
	199	{
	200	if (object_id & 255) {
	201	unsigned int off;
	202
	203	off = (object_id & 255) - 1;
	204	block += off << ADFS_SB(sb)->s_log2sharesize;
	205	}
	206
	207	return adfs_map_lookup(sb, object_id >> 8, block);
	208	}