[mirror_ubuntu-artful-kernel.git] / fs / exofs / exofs.h

/*
 * Copyright (C) 2005, 2006
 * Avishay Traeger (avishay@gmail.com)
 * Copyright (C) 2008, 2009
 * Boaz Harrosh <bharrosh@panasas.com>
 *
 * Copyrights for code taken from ext2:
 *     Copyright (C) 1992, 1993, 1994, 1995
 *     Remy Card (card@masi.ibp.fr)
 *     Laboratoire MASI - Institut Blaise Pascal
 *     Universite Pierre et Marie Curie (Paris VI)
 *     from
 *     linux/fs/minix/inode.c
 *     Copyright (C) 1991, 1992  Linus Torvalds
 *
 * This file is part of exofs.
 *
 * exofs is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation.  Since it is based on ext2, and the only
 * valid version of GPL for the Linux kernel is version 2, the only valid
 * version of GPL for exofs is version 2.
 *
 * exofs is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with exofs; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */
#ifndef __EXOFS_H__
#define __EXOFS_H__

#include <linux/fs.h>
#include <linux/time.h>
#include <linux/backing-dev.h>
#include <linux/pnfs_osd_xdr.h>
#include "common.h"

#define EXOFS_ERR(fmt, a...) printk(KERN_ERR "exofs: " fmt, ##a)

#ifdef CONFIG_EXOFS_DEBUG
#define EXOFS_DBGMSG(fmt, a...) \
	printk(KERN_NOTICE "exofs @%s:%d: " fmt, __func__, __LINE__, ##a)
#else
#define EXOFS_DBGMSG(fmt, a...) \
	do { if (0) printk(fmt, ##a); } while (0)
#endif

/* u64 has problems with printk this will cast it to unsigned long long */
#define _LLU(x) (unsigned long long)(x)

struct exofs_layout {
	osd_id		s_pid;			/* partition ID of file system*/

	/* Our way of looking at the data_map */
	unsigned stripe_unit;
	unsigned mirrors_p1;

	unsigned group_width;
	u64	 group_depth;
	unsigned group_count;

	enum exofs_inode_layout_gen_functions lay_func;

	unsigned	s_numdevs;		/* Num of devices in array    */
	struct osd_dev	**s_ods;		/* osd_dev array              */
};

/*
 * our extension to the in-memory superblock
 */
struct exofs_sb_info {
	struct backing_dev_info bdi;		/* register our bdi with VFS  */
	struct exofs_sb_stats s_ess;		/* Written often, pre-allocate*/
	int		s_timeout;		/* timeout for OSD operations */
	uint64_t	s_nextid;		/* highest object ID used     */
	uint32_t	s_numfiles;		/* number of files on fs      */
	spinlock_t	s_next_gen_lock;	/* spinlock for gen # update  */
	u32		s_next_generation;	/* next gen # to use          */
	atomic_t	s_curr_pending;		/* number of pending commands */
	uint8_t		s_cred[OSD_CAP_LEN];	/* credential for the fscb    */

	struct pnfs_osd_data_map data_map;	/* Default raid to use
						 * FIXME: Needed ?
						 */
	struct exofs_layout	layout;		/* Default files layout       */
	struct osd_dev	*_min_one_dev[1];	/* Place holder for one dev   */
};

/*
 * our extension to the in-memory inode
 */
struct exofs_i_info {
	struct inode   vfs_inode;          /* normal in-memory inode          */
	wait_queue_head_t i_wq;            /* wait queue for inode            */
	unsigned long  i_flags;            /* various atomic flags            */
	uint32_t       i_data[EXOFS_IDATA];/*short symlink names and device #s*/
	uint32_t       i_dir_start_lookup; /* which page to start lookup      */
	uint64_t       i_commit_size;      /* the object's written length     */
	uint8_t        i_cred[OSD_CAP_LEN];/* all-powerful credential         */
};

static inline osd_id exofs_oi_objno(struct exofs_i_info *oi)
{
	return oi->vfs_inode.i_ino + EXOFS_OBJ_OFF;
}

struct exofs_io_state;
typedef void (*exofs_io_done_fn)(struct exofs_io_state *ios, void *private);

struct exofs_io_state {
	struct kref		kref;

	void			*private;
	exofs_io_done_fn	done;

	struct exofs_layout	*layout;
	struct osd_obj_id	obj;
	u8			*cred;

	/* Global read/write IO*/
	loff_t			offset;
	unsigned long		length;
	void			*kern_buff;

	struct page		**pages;
	unsigned		nr_pages;
	unsigned		pgbase;
	unsigned		pages_consumed;

	/* Attributes */
	unsigned		in_attr_len;
	struct osd_attr 	*in_attr;
	unsigned		out_attr_len;
	struct osd_attr 	*out_attr;

	bool			reading;

	/* Variable array of size numdevs */
	unsigned numdevs;
	struct exofs_per_dev_state {
		struct osd_request *or;
		struct bio *bio;
		loff_t offset;
		unsigned length;
		unsigned dev;
	} per_dev[];
};

static inline unsigned exofs_io_state_size(unsigned numdevs)
{
	return sizeof(struct exofs_io_state) +
		sizeof(struct exofs_per_dev_state) * numdevs;
}

/*
 * our inode flags
 */
#define OBJ_2BCREATED	0	/* object will be created soon*/
#define OBJ_CREATED	1	/* object has been created on the osd*/

static inline int obj_2bcreated(struct exofs_i_info *oi)
{
	return test_bit(OBJ_2BCREATED, &oi->i_flags);
}

static inline void set_obj_2bcreated(struct exofs_i_info *oi)
{
	set_bit(OBJ_2BCREATED, &oi->i_flags);
}

static inline int obj_created(struct exofs_i_info *oi)
{
	return test_bit(OBJ_CREATED, &oi->i_flags);
}

static inline void set_obj_created(struct exofs_i_info *oi)
{
	set_bit(OBJ_CREATED, &oi->i_flags);
}

int __exofs_wait_obj_created(struct exofs_i_info *oi);
static inline int wait_obj_created(struct exofs_i_info *oi)
{
	if (likely(obj_created(oi)))
		return 0;

	return __exofs_wait_obj_created(oi);
}

/*
 * get to our inode from the vfs inode
 */
static inline struct exofs_i_info *exofs_i(struct inode *inode)
{
	return container_of(inode, struct exofs_i_info, vfs_inode);
}

/*
 * Given a layout, object_number and stripe_index return the associated global
 * dev_index
 */
unsigned exofs_layout_od_id(struct exofs_layout *layout,
			    osd_id obj_no, unsigned layout_index);
/*
 * Maximum count of links to a file
 */
#define EXOFS_LINK_MAX           32000

/*************************
 * function declarations *
 *************************/

/* ios.c */
void exofs_make_credential(u8 cred_a[OSD_CAP_LEN],
			   const struct osd_obj_id *obj);
int exofs_read_kern(struct osd_dev *od, u8 *cred, struct osd_obj_id *obj,
		    u64 offset, void *p, unsigned length);

int  exofs_get_rw_state(struct exofs_layout *layout, bool is_reading,
			u64 offset, u64 length, struct exofs_io_state **ios);
int  exofs_get_io_state(struct exofs_layout *layout,
			struct exofs_io_state **ios);
void exofs_put_io_state(struct exofs_io_state *ios);

int exofs_check_io(struct exofs_io_state *ios, u64 *resid);

int exofs_sbi_create(struct exofs_io_state *ios);
int exofs_sbi_remove(struct exofs_io_state *ios);
int exofs_sbi_write(struct exofs_io_state *ios);
int exofs_sbi_read(struct exofs_io_state *ios);

int extract_attr_from_ios(struct exofs_io_state *ios, struct osd_attr *attr);

int exofs_oi_truncate(struct exofs_i_info *oi, u64 new_len);
static inline int exofs_oi_write(struct exofs_i_info *oi,
				 struct exofs_io_state *ios)
{
	ios->obj.id = exofs_oi_objno(oi);
	ios->cred = oi->i_cred;
	return exofs_sbi_write(ios);
}

static inline int exofs_oi_read(struct exofs_i_info *oi,
				struct exofs_io_state *ios)
{
	ios->obj.id = exofs_oi_objno(oi);
	ios->cred = oi->i_cred;
	return exofs_sbi_read(ios);
}

/* inode.c               */
unsigned exofs_max_io_pages(struct exofs_layout *layout,
			    unsigned expected_pages);
int exofs_setattr(struct dentry *, struct iattr *);
int exofs_write_begin(struct file *file, struct address_space *mapping,
		loff_t pos, unsigned len, unsigned flags,
		struct page **pagep, void **fsdata);
extern struct inode *exofs_iget(struct super_block *, unsigned long);
struct inode *exofs_new_inode(struct inode *, int);
extern int exofs_write_inode(struct inode *, struct writeback_control *wbc);
extern void exofs_evict_inode(struct inode *);

/* dir.c:                */
int exofs_add_link(struct dentry *, struct inode *);
ino_t exofs_inode_by_name(struct inode *, struct dentry *);
int exofs_delete_entry(struct exofs_dir_entry *, struct page *);
int exofs_make_empty(struct inode *, struct inode *);
struct exofs_dir_entry *exofs_find_entry(struct inode *, struct dentry *,
					 struct page **);
int exofs_empty_dir(struct inode *);
struct exofs_dir_entry *exofs_dotdot(struct inode *, struct page **);
ino_t exofs_parent_ino(struct dentry *child);
int exofs_set_link(struct inode *, struct exofs_dir_entry *, struct page *,
		    struct inode *);

/* super.c               */
int exofs_sbi_write_stats(struct exofs_sb_info *sbi);

/*********************
 * operation vectors *
 *********************/
/* dir.c:            */
extern const struct file_operations exofs_dir_operations;

/* file.c            */
extern const struct inode_operations exofs_file_inode_operations;
extern const struct file_operations exofs_file_operations;

/* inode.c           */
extern const struct address_space_operations exofs_aops;
extern const struct osd_attr g_attr_logical_length;

/* namei.c           */
extern const struct inode_operations exofs_dir_inode_operations;
extern const struct inode_operations exofs_special_inode_operations;

/* symlink.c         */
extern const struct inode_operations exofs_symlink_inode_operations;
extern const struct inode_operations exofs_fast_symlink_inode_operations;

#endif
Commit	Line	Data
b14f8ab2 BH	1	/*
b14f8ab2 BH	2	* Copyright (C) 2005, 2006
27d2e149	3	* Avishay Traeger (avishay@gmail.com)
b14f8ab2 BH	4	* Copyright (C) 2008, 2009
	5	* Boaz Harrosh <bharrosh@panasas.com>
	6	*
	7	* Copyrights for code taken from ext2:
	8	* Copyright (C) 1992, 1993, 1994, 1995
	9	* Remy Card (card@masi.ibp.fr)
	10	* Laboratoire MASI - Institut Blaise Pascal
	11	* Universite Pierre et Marie Curie (Paris VI)
	12	* from
	13	* linux/fs/minix/inode.c
	14	* Copyright (C) 1991, 1992 Linus Torvalds
	15	*
	16	* This file is part of exofs.
	17	*
	18	* exofs is free software; you can redistribute it and/or modify
	19	* it under the terms of the GNU General Public License as published by
	20	* the Free Software Foundation. Since it is based on ext2, and the only
	21	* valid version of GPL for the Linux kernel is version 2, the only valid
	22	* version of GPL for exofs is version 2.
	23	*
	24	* exofs is distributed in the hope that it will be useful,
	25	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	26	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	27	* GNU General Public License for more details.
	28	*
	29	* You should have received a copy of the GNU General Public License
	30	* along with exofs; if not, write to the Free Software
	31	* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
	32	*/
06886a5a BH	33	#ifndef __EXOFS_H__
06886a5a BH	34	#define __EXOFS_H__
b14f8ab2 BH	35
	36	#include <linux/fs.h>
	37	#include <linux/time.h>
b3d0ab7e	38	#include <linux/backing-dev.h>
26ae93c2	39	#include <linux/pnfs_osd_xdr.h>
b14f8ab2 BH	40	#include "common.h"
b14f8ab2 BH	41
b14f8ab2 BH	42	#define EXOFS_ERR(fmt, a...) printk(KERN_ERR "exofs: " fmt, ##a)
	43
	44	#ifdef CONFIG_EXOFS_DEBUG
	45	#define EXOFS_DBGMSG(fmt, a...) \
	46	printk(KERN_NOTICE "exofs @%s:%d: " fmt, __func__, __LINE__, ##a)
	47	#else
	48	#define EXOFS_DBGMSG(fmt, a...) \
	49	do { if (0) printk(fmt, ##a); } while (0)
	50	#endif
	51
	52	/* u64 has problems with printk this will cast it to unsigned long long */
	53	#define _LLU(x) (unsigned long long)(x)
	54
45d3abcb BH	55	struct exofs_layout {
	56	osd_id s_pid; /* partition ID of file system*/
	57
5d952b83 BH	58	/* Our way of looking at the data_map */
	59	unsigned stripe_unit;
	60	unsigned mirrors_p1;
	61
	62	unsigned group_width;
50a76fd3 BH	63	u64 group_depth;
50a76fd3 BH	64	unsigned group_count;
5d952b83 BH	65
	66	enum exofs_inode_layout_gen_functions lay_func;
	67
45d3abcb	68	unsigned s_numdevs; /* Num of devices in array */
6d4073e8	69	struct osd_dev *s_ods; / osd_dev array */
45d3abcb BH	70	};
45d3abcb BH	71
b14f8ab2 BH	72	/*
	73	* our extension to the in-memory superblock
	74	*/
	75	struct exofs_sb_info {
6d4073e8	76	struct backing_dev_info bdi; /* register our bdi with VFS */
1cea312a	77	struct exofs_sb_stats s_ess; /* Written often, pre-allocate*/
b14f8ab2 BH	78	int s_timeout; /* timeout for OSD operations */
	79	uint64_t s_nextid; /* highest object ID used */
	80	uint32_t s_numfiles; /* number of files on fs */
	81	spinlock_t s_next_gen_lock; /* spinlock for gen # update */
	82	u32 s_next_generation; /* next gen # to use */
	83	atomic_t s_curr_pending; /* number of pending commands */
04dc1e88 BH	84	uint8_t s_cred[OSD_CAP_LEN]; /* credential for the fscb */
04dc1e88 BH	85
45d3abcb BH	86	struct pnfs_osd_data_map data_map; /* Default raid to use
	87	* FIXME: Needed ?
	88	*/
6d4073e8	89	struct exofs_layout layout; /* Default files layout */
45d3abcb	90	struct osd_dev _min_one_dev[1]; / Place holder for one dev */
b14f8ab2 BH	91	};
	92
	93	/*
	94	* our extension to the in-memory inode
	95	*/
	96	struct exofs_i_info {
518f167a BH	97	struct inode vfs_inode; /* normal in-memory inode */
518f167a BH	98	wait_queue_head_t i_wq; /* wait queue for inode */
b14f8ab2 BH	99	unsigned long i_flags; /* various atomic flags */
	100	uint32_t i_data[EXOFS_IDATA];/short symlink names and device #s/
	101	uint32_t i_dir_start_lookup; /* which page to start lookup */
b14f8ab2 BH	102	uint64_t i_commit_size; /* the object's written length */
b14f8ab2 BH	103	uint8_t i_cred[OSD_CAP_LEN];/* all-powerful credential */
b14f8ab2 BH	104	};
b14f8ab2 BH	105
06886a5a BH	106	static inline osd_id exofs_oi_objno(struct exofs_i_info *oi)
	107	{
	108	return oi->vfs_inode.i_ino + EXOFS_OBJ_OFF;
	109	}
	110
	111	struct exofs_io_state;
e1042ba0	112	typedef void (exofs_io_done_fn)(struct exofs_io_state ios, void *private);
06886a5a BH	113
	114	struct exofs_io_state {
	115	struct kref kref;
	116
	117	void *private;
	118	exofs_io_done_fn done;
	119
45d3abcb	120	struct exofs_layout *layout;
06886a5a BH	121	struct osd_obj_id obj;
	122	u8 *cred;
	123
	124	/* Global read/write IO*/
	125	loff_t offset;
	126	unsigned long length;
	127	void *kern_buff;
86093aaf BH	128
	129	struct page **pages;
	130	unsigned nr_pages;
	131	unsigned pgbase;
50a76fd3	132	unsigned pages_consumed;
06886a5a BH	133
	134	/* Attributes */
	135	unsigned in_attr_len;
	136	struct osd_attr *in_attr;
	137	unsigned out_attr_len;
	138	struct osd_attr *out_attr;
	139
e1042ba0 BH	140	bool reading;
e1042ba0 BH	141
06886a5a BH	142	/* Variable array of size numdevs */
	143	unsigned numdevs;
	144	struct exofs_per_dev_state {
	145	struct osd_request *or;
	146	struct bio *bio;
5d952b83 BH	147	loff_t offset;
	148	unsigned length;
	149	unsigned dev;
06886a5a BH	150	} per_dev[];
	151	};
	152
	153	static inline unsigned exofs_io_state_size(unsigned numdevs)
	154	{
	155	return sizeof(struct exofs_io_state) +
	156	sizeof(struct exofs_per_dev_state) * numdevs;
	157	}
	158
b14f8ab2 BH	159	/*
	160	* our inode flags
	161	*/
	162	#define OBJ_2BCREATED 0 /* object will be created soon*/
	163	#define OBJ_CREATED 1 /* object has been created on the osd*/
	164
	165	static inline int obj_2bcreated(struct exofs_i_info *oi)
	166	{
	167	return test_bit(OBJ_2BCREATED, &oi->i_flags);
	168	}
	169
	170	static inline void set_obj_2bcreated(struct exofs_i_info *oi)
	171	{
	172	set_bit(OBJ_2BCREATED, &oi->i_flags);
	173	}
	174
	175	static inline int obj_created(struct exofs_i_info *oi)
	176	{
	177	return test_bit(OBJ_CREATED, &oi->i_flags);
	178	}
	179
	180	static inline void set_obj_created(struct exofs_i_info *oi)
	181	{
	182	set_bit(OBJ_CREATED, &oi->i_flags);
	183	}
	184
	185	int __exofs_wait_obj_created(struct exofs_i_info *oi);
	186	static inline int wait_obj_created(struct exofs_i_info *oi)
	187	{
	188	if (likely(obj_created(oi)))
	189	return 0;
	190
	191	return __exofs_wait_obj_created(oi);
	192	}
	193
	194	/*
	195	* get to our inode from the vfs inode
	196	*/
	197	static inline struct exofs_i_info exofs_i(struct inode inode)
	198	{
	199	return container_of(inode, struct exofs_i_info, vfs_inode);
	200	}
	201
d9c740d2 BH	202	/*
	203	* Given a layout, object_number and stripe_index return the associated global
	204	* dev_index
	205	*/
	206	unsigned exofs_layout_od_id(struct exofs_layout *layout,
	207	osd_id obj_no, unsigned layout_index);
e6af00f1 BH	208	/*
	209	* Maximum count of links to a file
	210	*/
	211	#define EXOFS_LINK_MAX 32000
	212
e8062719 BH	213	/*************************
	214	* function declarations *
	215	*************************/
06886a5a BH	216
	217	/* ios.c */
	218	void exofs_make_credential(u8 cred_a[OSD_CAP_LEN],
	219	const struct osd_obj_id *obj);
	220	int exofs_read_kern(struct osd_dev od, u8 cred, struct osd_obj_id *obj,
	221	u64 offset, void *p, unsigned length);
	222
e1042ba0 BH	223	int exofs_get_rw_state(struct exofs_layout *layout, bool is_reading,
e1042ba0 BH	224	u64 offset, u64 length, struct exofs_io_state **ios);
45d3abcb BH	225	int exofs_get_io_state(struct exofs_layout *layout,
45d3abcb BH	226	struct exofs_io_state **ios);
06886a5a BH	227	void exofs_put_io_state(struct exofs_io_state *ios);
	228
	229	int exofs_check_io(struct exofs_io_state ios, u64 resid);
	230
	231	int exofs_sbi_create(struct exofs_io_state *ios);
	232	int exofs_sbi_remove(struct exofs_io_state *ios);
	233	int exofs_sbi_write(struct exofs_io_state *ios);
	234	int exofs_sbi_read(struct exofs_io_state *ios);
	235
	236	int extract_attr_from_ios(struct exofs_io_state ios, struct osd_attr attr);
	237
	238	int exofs_oi_truncate(struct exofs_i_info *oi, u64 new_len);
	239	static inline int exofs_oi_write(struct exofs_i_info *oi,
	240	struct exofs_io_state *ios)
	241	{
	242	ios->obj.id = exofs_oi_objno(oi);
	243	ios->cred = oi->i_cred;
	244	return exofs_sbi_write(ios);
	245	}
	246
	247	static inline int exofs_oi_read(struct exofs_i_info *oi,
	248	struct exofs_io_state *ios)
	249	{
	250	ios->obj.id = exofs_oi_objno(oi);
	251	ios->cred = oi->i_cred;
	252	return exofs_sbi_read(ios);
	253	}
	254
e8062719	255	/* inode.c */
66cd6cad	256	unsigned exofs_max_io_pages(struct exofs_layout *layout,
66cd6cad	257	unsigned expected_pages);
e8062719	258	int exofs_setattr(struct dentry , struct iattr );
beaec07b BH	259	int exofs_write_begin(struct file file, struct address_space mapping,
	260	loff_t pos, unsigned len, unsigned flags,
	261	struct page pagep, void fsdata);
e6af00f1 BH	262	extern struct inode exofs_iget(struct super_block , unsigned long);
e6af00f1 BH	263	struct inode exofs_new_inode(struct inode , int);
a9185b41	264	extern int exofs_write_inode(struct inode , struct writeback_control wbc);
4ec70c9b	265	extern void exofs_evict_inode(struct inode *);
e6af00f1 BH	266
	267	/* dir.c: */
	268	int exofs_add_link(struct dentry , struct inode );
	269	ino_t exofs_inode_by_name(struct inode , struct dentry );
	270	int exofs_delete_entry(struct exofs_dir_entry , struct page );
	271	int exofs_make_empty(struct inode , struct inode );
	272	struct exofs_dir_entry exofs_find_entry(struct inode , struct dentry *,
	273	struct page **);
	274	int exofs_empty_dir(struct inode *);
	275	struct exofs_dir_entry exofs_dotdot(struct inode , struct page **);
8cf74b39	276	ino_t exofs_parent_ino(struct dentry *child);
e6af00f1 BH	277	int exofs_set_link(struct inode , struct exofs_dir_entry , struct page *,
e6af00f1 BH	278	struct inode *);
e8062719	279
baaf94cd	280	/* super.c */
1cea312a	281	int exofs_sbi_write_stats(struct exofs_sb_info *sbi);
baaf94cd	282
e8062719 BH	283	/*********************
	284	* operation vectors *
	285	*********************/
e6af00f1 BH	286	/* dir.c: */
	287	extern const struct file_operations exofs_dir_operations;
	288
e8062719 BH	289	/* file.c */
	290	extern const struct inode_operations exofs_file_inode_operations;
	291	extern const struct file_operations exofs_file_operations;
	292
beaec07b BH	293	/* inode.c */
beaec07b BH	294	extern const struct address_space_operations exofs_aops;
06886a5a	295	extern const struct osd_attr g_attr_logical_length;
beaec07b	296
e6af00f1 BH	297	/* namei.c */
	298	extern const struct inode_operations exofs_dir_inode_operations;
	299	extern const struct inode_operations exofs_special_inode_operations;
	300
982980d7 BH	301	/* symlink.c */
	302	extern const struct inode_operations exofs_symlink_inode_operations;
	303	extern const struct inode_operations exofs_fast_symlink_inode_operations;
	304
b14f8ab2	305	#endif