[mirror_ubuntu-hirsute-kernel.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 {
	struct adfs_discmap *s_map;	/* bh list containing map		 */
	struct adfs_dir_ops *s_dir;	/* directory operations			 */

	uid_t		s_uid;		/* owner uid				 */
	gid_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		 */

	__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
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 char	name_len;		/* name length		*/
	char		name[ADFS_MAX_NAME_LEN];/* file name		*/
};

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 */
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 {
	46	struct adfs_discmap s_map; / bh list containing map */
	47	struct adfs_dir_ops s_dir; / directory operations */
	48
	49	uid_t s_uid; /* owner uid */
	50	gid_t s_gid; /* owner gid */
	51	umode_t s_owner_mask; /* ADFS owner perm -> unix perm */
	52	umode_t s_other_mask; /* ADFS other perm -> unix perm */
	53
	54	__u32 s_ids_per_zone; /* max. no ids in one zone */
	55	__u32 s_idlen; /* length of ID in map */
	56	__u32 s_map_size; /* sector size of a map */
	57	unsigned long s_size; /* total size (in blocks) of this fs */
	58	signed int s_map2blk; /* shift left by this for map->sector */
	59	unsigned int s_log2sharesize;/* log2 share size */
	60	__le32 s_version; /* disc format version */
	61	unsigned int s_namelen; /* maximum number of characters in name */
	62	};
	63
	64	static inline struct adfs_sb_info ADFS_SB(struct super_block sb)
	65	{
	66	return sb->s_fs_info;
	67	}
	68
	69	static inline struct adfs_inode_info ADFS_I(struct inode inode)
	70	{
	71	return container_of(inode, struct adfs_inode_info, vfs_inode);
	72	}
	73
1da177e4 LT	74	/*
	75	* Directory handling
	76	*/
	77	struct adfs_dir {
	78	struct super_block *sb;
	79
	80	int nr_buffers;
	81	struct buffer_head *bh[4];
2f09719a SS	82
	83	/* big directories need allocated buffers */
	84	struct buffer_head **bh_fplus;
	85
1da177e4 LT	86	unsigned int pos;
	87	unsigned int parent_id;
	88
	89	struct adfs_dirheader dirhead;
	90	union adfs_dirtail dirtail;
	91	};
	92
	93	/*
	94	* This is the overall maximum name length
	95	*/
	96	#define ADFS_MAX_NAME_LEN 256
	97	struct object_info {
	98	__u32 parent_id; /* parent object id */
	99	__u32 file_id; /* object id */
	100	__u32 loadaddr; /* load address */
	101	__u32 execaddr; /* execution address */
	102	__u32 size; /* size */
	103	__u8 attr; /* RISC OS attributes */
	104	unsigned char name_len; /* name length */
	105	char name[ADFS_MAX_NAME_LEN];/* file name */
	106	};
	107
	108	struct adfs_dir_ops {
	109	int (read)(struct super_block sb, unsigned int id, unsigned int sz, struct adfs_dir *dir);
	110	int (setpos)(struct adfs_dir dir, unsigned int fpos);
	111	int (getnext)(struct adfs_dir dir, struct object_info *obj);
	112	int (update)(struct adfs_dir dir, struct object_info *obj);
	113	int (create)(struct adfs_dir dir, struct object_info *obj);
	114	int (remove)(struct adfs_dir dir, struct object_info *obj);
ffdc9064	115	int (sync)(struct adfs_dir dir);
1da177e4 LT	116	void (free)(struct adfs_dir dir);
	117	};
	118
	119	struct adfs_discmap {
	120	struct buffer_head *dm_bh;
	121	__u32 dm_startblk;
	122	unsigned int dm_startbit;
	123	unsigned int dm_endbit;
	124	};
	125
	126	/* Inode stuff */
	127	struct inode adfs_iget(struct super_block sb, struct object_info *obj);
a9185b41	128	int adfs_write_inode(struct inode inode, struct writeback_control wbc);
1da177e4 LT	129	int adfs_notify_change(struct dentry dentry, struct iattr attr);
	130
	131	/* map.c */
	132	extern int adfs_map_lookup(struct super_block *sb, unsigned int frag_id, unsigned int offset);
	133	extern unsigned int adfs_map_free(struct super_block *sb);
	134
	135	/* Misc */
	136	void __adfs_error(struct super_block sb, const char function,
	137	const char *fmt, ...);
8e24eea7	138	#define adfs_error(sb, fmt...) __adfs_error(sb, __func__, fmt)
1da177e4 LT	139
	140	/* super.c */
	141
	142	/*
	143	* Inodes and file operations
	144	*/
	145
	146	/* dir_.c /
754661f1	147	extern const struct inode_operations adfs_dir_inode_operations;
4b6f5d20	148	extern const struct file_operations adfs_dir_operations;
e16404ed	149	extern const struct dentry_operations adfs_dentry_operations;
1da177e4 LT	150	extern struct adfs_dir_ops adfs_f_dir_ops;
	151	extern struct adfs_dir_ops adfs_fplus_dir_ops;
	152
ffdc9064 AV	153	extern int adfs_dir_update(struct super_block sb, struct object_info obj,
ffdc9064 AV	154	int wait);
1da177e4 LT	155
1da177e4 LT	156	/* file.c */
754661f1	157	extern const struct inode_operations adfs_file_inode_operations;
4b6f5d20	158	extern const struct file_operations adfs_file_operations;
1da177e4	159
e0c93142	160	static inline __u32 signed_asl(__u32 val, signed int shift)
1da177e4 LT	161	{
	162	if (shift >= 0)
	163	val <<= shift;
	164	else
	165	val >>= -shift;
	166	return val;
	167	}
	168
	169	/*
	170	* Calculate the address of a block in an object given the block offset
	171	* and the object identity.
	172	*
	173	* The root directory ID should always be looked up in the map [3.4]
	174	*/
e0c93142	175	static inline int
1da177e4 LT	176	__adfs_block_map(struct super_block *sb, unsigned int object_id,
	177	unsigned int block)
	178	{
	179	if (object_id & 255) {
	180	unsigned int off;
	181
	182	off = (object_id & 255) - 1;
	183	block += off << ADFS_SB(sb)->s_log2sharesize;
	184	}
	185
	186	return adfs_map_lookup(sb, object_id >> 8, block);
	187	}