[linux-2.6-block.git] / fs / nfs / pnfs.h

/*
 *  pNFS client data structures.
 *
 *  Copyright (c) 2002
 *  The Regents of the University of Michigan
 *  All Rights Reserved
 *
 *  Dean Hildebrand <dhildebz@umich.edu>
 *
 *  Permission is granted to use, copy, create derivative works, and
 *  redistribute this software and such derivative works for any purpose,
 *  so long as the name of the University of Michigan is not used in
 *  any advertising or publicity pertaining to the use or distribution
 *  of this software without specific, written prior authorization. If
 *  the above copyright notice or any other identification of the
 *  University of Michigan is included in any copy of any portion of
 *  this software, then the disclaimer below must also be included.
 *
 *  This software is provided as is, without representation or warranty
 *  of any kind either express or implied, including without limitation
 *  the implied warranties of merchantability, fitness for a particular
 *  purpose, or noninfringement.  The Regents of the University of
 *  Michigan shall not be liable for any damages, including special,
 *  indirect, incidental, or consequential damages, with respect to any
 *  claim arising out of or in connection with the use of the software,
 *  even if it has been or is hereafter advised of the possibility of
 *  such damages.
 */

#ifndef FS_NFS_PNFS_H
#define FS_NFS_PNFS_H

#include <linux/nfs_fs.h>
#include <linux/nfs_page.h>

enum {
	NFS_LSEG_VALID = 0,	/* cleared when lseg is recalled/returned */
	NFS_LSEG_ROC,		/* roc bit received from server */
	NFS_LSEG_LAYOUTCOMMIT,	/* layoutcommit bit set for layoutcommit */
};

struct pnfs_layout_segment {
	struct list_head pls_list;
	struct list_head pls_lc_list;
	struct pnfs_layout_range pls_range;
	atomic_t pls_refcount;
	unsigned long pls_flags;
	struct pnfs_layout_hdr *pls_layout;
};

enum pnfs_try_status {
	PNFS_ATTEMPTED     = 0,
	PNFS_NOT_ATTEMPTED = 1,
};

#ifdef CONFIG_NFS_V4_1

#define LAYOUT_NFSV4_1_MODULE_PREFIX "nfs-layouttype4"

enum {
	NFS_LAYOUT_RO_FAILED = 0,	/* get ro layout failed stop trying */
	NFS_LAYOUT_RW_FAILED,		/* get rw layout failed stop trying */
	NFS_LAYOUT_BULK_RECALL,		/* bulk recall affecting layout */
	NFS_LAYOUT_ROC,			/* some lseg had roc bit set */
	NFS_LAYOUT_DESTROYED,		/* no new use of layout allowed */
};

enum layoutdriver_policy_flags {
	/* Should the pNFS client commit and return the layout upon a setattr */
	PNFS_LAYOUTRET_ON_SETATTR	= 1 << 0,
	PNFS_LAYOUTRET_ON_ERROR		= 1 << 1,
};

struct nfs4_deviceid_node;

/* Per-layout driver specific registration structure */
struct pnfs_layoutdriver_type {
	struct list_head pnfs_tblid;
	const u32 id;
	const char *name;
	struct module *owner;
	unsigned flags;

	int (*set_layoutdriver) (struct nfs_server *, const struct nfs_fh *);
	int (*clear_layoutdriver) (struct nfs_server *);

	struct pnfs_layout_hdr * (*alloc_layout_hdr) (struct inode *inode, gfp_t gfp_flags);
	void (*free_layout_hdr) (struct pnfs_layout_hdr *);

	struct pnfs_layout_segment * (*alloc_lseg) (struct pnfs_layout_hdr *layoutid, struct nfs4_layoutget_res *lgr, gfp_t gfp_flags);
	void (*free_lseg) (struct pnfs_layout_segment *lseg);

	/* test for nfs page cache coalescing */
	const struct nfs_pageio_ops *pg_read_ops;
	const struct nfs_pageio_ops *pg_write_ops;

	struct pnfs_ds_commit_info *(*get_ds_info) (struct inode *inode);
	void (*mark_request_commit) (struct nfs_page *req,
				     struct pnfs_layout_segment *lseg,
				     struct nfs_commit_info *cinfo);
	void (*clear_request_commit) (struct nfs_page *req,
				      struct nfs_commit_info *cinfo);
	int (*scan_commit_lists) (struct nfs_commit_info *cinfo,
				  int max);
	int (*commit_pagelist)(struct inode *inode,
			       struct list_head *mds_pages,
			       int how,
			       struct nfs_commit_info *cinfo);

	/*
	 * Return PNFS_ATTEMPTED to indicate the layout code has attempted
	 * I/O, else return PNFS_NOT_ATTEMPTED to fall back to normal NFS
	 */
	enum pnfs_try_status (*read_pagelist) (struct nfs_read_data *nfs_data);
	enum pnfs_try_status (*write_pagelist) (struct nfs_write_data *nfs_data, int how);

	void (*free_deviceid_node) (struct nfs4_deviceid_node *);

	void (*encode_layoutreturn) (struct pnfs_layout_hdr *layoutid,
				     struct xdr_stream *xdr,
				     const struct nfs4_layoutreturn_args *args);

	void (*cleanup_layoutcommit) (struct nfs4_layoutcommit_data *data);

	void (*encode_layoutcommit) (struct pnfs_layout_hdr *layoutid,
				     struct xdr_stream *xdr,
				     const struct nfs4_layoutcommit_args *args);
};

struct pnfs_layout_hdr {
	atomic_t		plh_refcount;
	struct list_head	plh_layouts;   /* other client layouts */
	struct list_head	plh_bulk_recall; /* clnt list of bulk recalls */
	struct list_head	plh_segs;      /* layout segments list */
	nfs4_stateid		plh_stateid;
	atomic_t		plh_outstanding; /* number of RPCs out */
	unsigned long		plh_block_lgets; /* block LAYOUTGET if >0 */
	u32			plh_barrier; /* ignore lower seqids */
	unsigned long		plh_flags;
	loff_t			plh_lwb; /* last write byte for layoutcommit */
	struct rpc_cred		*plh_lc_cred; /* layoutcommit cred */
	struct inode		*plh_inode;
};

struct pnfs_device {
	struct nfs4_deviceid dev_id;
	unsigned int  layout_type;
	unsigned int  mincount;
	struct page **pages;
	unsigned int  pgbase;
	unsigned int  pglen;
};

#define NFS4_PNFS_GETDEVLIST_MAXNUM 16

struct pnfs_devicelist {
	unsigned int		eof;
	unsigned int		num_devs;
	struct nfs4_deviceid	dev_id[NFS4_PNFS_GETDEVLIST_MAXNUM];
};

extern int pnfs_register_layoutdriver(struct pnfs_layoutdriver_type *);
extern void pnfs_unregister_layoutdriver(struct pnfs_layoutdriver_type *);

/* nfs4proc.c */
extern int nfs4_proc_getdevicelist(struct nfs_server *server,
				   const struct nfs_fh *fh,
				   struct pnfs_devicelist *devlist);
extern int nfs4_proc_getdeviceinfo(struct nfs_server *server,
				   struct pnfs_device *dev);
extern int nfs4_proc_layoutget(struct nfs4_layoutget *lgp);
extern int nfs4_proc_layoutreturn(struct nfs4_layoutreturn *lrp);

/* pnfs.c */
void get_layout_hdr(struct pnfs_layout_hdr *lo);
void put_lseg(struct pnfs_layout_segment *lseg);

bool pnfs_pageio_init_read(struct nfs_pageio_descriptor *, struct inode *,
			   const struct nfs_pgio_completion_ops *);
bool pnfs_pageio_init_write(struct nfs_pageio_descriptor *, struct inode *,
			    int, const struct nfs_pgio_completion_ops *);

void set_pnfs_layoutdriver(struct nfs_server *, const struct nfs_fh *, u32);
void unset_pnfs_layoutdriver(struct nfs_server *);
void pnfs_generic_pg_init_read(struct nfs_pageio_descriptor *, struct nfs_page *);
int pnfs_generic_pg_readpages(struct nfs_pageio_descriptor *desc);
void pnfs_generic_pg_init_write(struct nfs_pageio_descriptor *, struct nfs_page *);
int pnfs_generic_pg_writepages(struct nfs_pageio_descriptor *desc);
bool pnfs_generic_pg_test(struct nfs_pageio_descriptor *pgio, struct nfs_page *prev, struct nfs_page *req);
void pnfs_set_lo_fail(struct pnfs_layout_segment *lseg);
int pnfs_layout_process(struct nfs4_layoutget *lgp);
void pnfs_free_lseg_list(struct list_head *tmp_list);
void pnfs_destroy_layout(struct nfs_inode *);
void pnfs_destroy_all_layouts(struct nfs_client *);
void put_layout_hdr(struct pnfs_layout_hdr *lo);
void pnfs_set_layout_stateid(struct pnfs_layout_hdr *lo,
			     const nfs4_stateid *new,
			     bool update_barrier);
int pnfs_choose_layoutget_stateid(nfs4_stateid *dst,
				  struct pnfs_layout_hdr *lo,
				  struct nfs4_state *open_state);
int mark_matching_lsegs_invalid(struct pnfs_layout_hdr *lo,
				struct list_head *tmp_list,
				struct pnfs_layout_range *recall_range);
bool pnfs_roc(struct inode *ino);
void pnfs_roc_release(struct inode *ino);
void pnfs_roc_set_barrier(struct inode *ino, u32 barrier);
bool pnfs_roc_drain(struct inode *ino, u32 *barrier);
void pnfs_set_layoutcommit(struct nfs_write_data *wdata);
void pnfs_cleanup_layoutcommit(struct nfs4_layoutcommit_data *data);
int pnfs_layoutcommit_inode(struct inode *inode, bool sync);
int _pnfs_return_layout(struct inode *);
void pnfs_ld_write_done(struct nfs_write_data *);
void pnfs_ld_read_done(struct nfs_read_data *);
struct pnfs_layout_segment *pnfs_update_layout(struct inode *ino,
					       struct nfs_open_context *ctx,
					       loff_t pos,
					       u64 count,
					       enum pnfs_iomode iomode,
					       gfp_t gfp_flags);

void nfs4_deviceid_mark_client_invalid(struct nfs_client *clp);

/* nfs4_deviceid_flags */
enum {
	NFS_DEVICEID_INVALID = 0,       /* set when MDS clientid recalled */
};

/* pnfs_dev.c */
struct nfs4_deviceid_node {
	struct hlist_node		node;
	struct hlist_node		tmpnode;
	const struct pnfs_layoutdriver_type *ld;
	const struct nfs_client		*nfs_client;
	unsigned long 			flags;
	struct nfs4_deviceid		deviceid;
	atomic_t			ref;
};

struct nfs4_deviceid_node *nfs4_find_get_deviceid(const struct pnfs_layoutdriver_type *, const struct nfs_client *, const struct nfs4_deviceid *);
void nfs4_delete_deviceid(const struct pnfs_layoutdriver_type *, const struct nfs_client *, const struct nfs4_deviceid *);
void nfs4_init_deviceid_node(struct nfs4_deviceid_node *,
			     const struct pnfs_layoutdriver_type *,
			     const struct nfs_client *,
			     const struct nfs4_deviceid *);
struct nfs4_deviceid_node *nfs4_insert_deviceid_node(struct nfs4_deviceid_node *);
bool nfs4_put_deviceid_node(struct nfs4_deviceid_node *);
void nfs4_deviceid_purge_client(const struct nfs_client *);

static inline int lo_fail_bit(u32 iomode)
{
	return iomode == IOMODE_RW ?
			 NFS_LAYOUT_RW_FAILED : NFS_LAYOUT_RO_FAILED;
}

static inline struct pnfs_layout_segment *
get_lseg(struct pnfs_layout_segment *lseg)
{
	if (lseg) {
		atomic_inc(&lseg->pls_refcount);
		smp_mb__after_atomic_inc();
	}
	return lseg;
}

/* Return true if a layout driver is being used for this mountpoint */
static inline int pnfs_enabled_sb(struct nfs_server *nfss)
{
	return nfss->pnfs_curr_ld != NULL;
}

static inline int
pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how,
		 struct nfs_commit_info *cinfo)
{
	if (cinfo->ds == NULL || cinfo->ds->ncommitting == 0)
		return PNFS_NOT_ATTEMPTED;
	return NFS_SERVER(inode)->pnfs_curr_ld->commit_pagelist(inode, mds_pages, how, cinfo);
}

static inline struct pnfs_ds_commit_info *
pnfs_get_ds_info(struct inode *inode)
{
	struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;

	if (ld == NULL || ld->get_ds_info == NULL)
		return NULL;
	return ld->get_ds_info(inode);
}

static inline bool
pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg,
			 struct nfs_commit_info *cinfo)
{
	struct inode *inode = req->wb_context->dentry->d_inode;
	struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;

	if (lseg == NULL || ld->mark_request_commit == NULL)
		return false;
	ld->mark_request_commit(req, lseg, cinfo);
	return true;
}

static inline bool
pnfs_clear_request_commit(struct nfs_page *req, struct nfs_commit_info *cinfo)
{
	struct inode *inode = req->wb_context->dentry->d_inode;
	struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;

	if (ld == NULL || ld->clear_request_commit == NULL)
		return false;
	ld->clear_request_commit(req, cinfo);
	return true;
}

static inline int
pnfs_scan_commit_lists(struct inode *inode, struct nfs_commit_info *cinfo,
		       int max)
{
	if (cinfo->ds == NULL || cinfo->ds->nwritten == 0)
		return 0;
	else
		return NFS_SERVER(inode)->pnfs_curr_ld->scan_commit_lists(cinfo, max);
}

/* Should the pNFS client commit and return the layout upon a setattr */
static inline bool
pnfs_ld_layoutret_on_setattr(struct inode *inode)
{
	if (!pnfs_enabled_sb(NFS_SERVER(inode)))
		return false;
	return NFS_SERVER(inode)->pnfs_curr_ld->flags &
		PNFS_LAYOUTRET_ON_SETATTR;
}

static inline int pnfs_return_layout(struct inode *ino)
{
	struct nfs_inode *nfsi = NFS_I(ino);
	struct nfs_server *nfss = NFS_SERVER(ino);

	if (pnfs_enabled_sb(nfss) && nfsi->layout)
		return _pnfs_return_layout(ino);

	return 0;
}

#ifdef NFS_DEBUG
void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id);
#else
static inline void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id)
{
}
#endif /* NFS_DEBUG */
#else  /* CONFIG_NFS_V4_1 */

static inline void pnfs_destroy_all_layouts(struct nfs_client *clp)
{
}

static inline void pnfs_destroy_layout(struct nfs_inode *nfsi)
{
}

static inline struct pnfs_layout_segment *
get_lseg(struct pnfs_layout_segment *lseg)
{
	return NULL;
}

static inline void put_lseg(struct pnfs_layout_segment *lseg)
{
}

static inline int pnfs_return_layout(struct inode *ino)
{
	return 0;
}

static inline bool
pnfs_ld_layoutret_on_setattr(struct inode *inode)
{
	return false;
}

static inline bool
pnfs_roc(struct inode *ino)
{
	return false;
}

static inline void
pnfs_roc_release(struct inode *ino)
{
}

static inline void
pnfs_roc_set_barrier(struct inode *ino, u32 barrier)
{
}

static inline bool
pnfs_roc_drain(struct inode *ino, u32 *barrier)
{
	return false;
}

static inline void set_pnfs_layoutdriver(struct nfs_server *s,
					 const struct nfs_fh *mntfh, u32 id)
{
}

static inline void unset_pnfs_layoutdriver(struct nfs_server *s)
{
}

static inline bool pnfs_pageio_init_read(struct nfs_pageio_descriptor *pgio, struct inode *inode)
{
	return false;
}

static inline bool pnfs_pageio_init_write(struct nfs_pageio_descriptor *pgio, struct inode *inode, int ioflags)
{
	return false;
}

static inline int
pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how,
		 struct nfs_commit_info *cinfo)
{
	return PNFS_NOT_ATTEMPTED;
}

static inline struct pnfs_ds_commit_info *
pnfs_get_ds_info(struct inode *inode)
{
	return NULL;
}

static inline bool
pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg,
			 struct nfs_commit_info *cinfo)
{
	return false;
}

static inline bool
pnfs_clear_request_commit(struct nfs_page *req, struct nfs_commit_info *cinfo)
{
	return false;
}

static inline int
pnfs_scan_commit_lists(struct inode *inode, struct nfs_commit_info *cinfo,
		       int max)
{
	return 0;
}

static inline int pnfs_layoutcommit_inode(struct inode *inode, bool sync)
{
	return 0;
}

#endif /* CONFIG_NFS_V4_1 */

#endif /* FS_NFS_PNFS_H */
Commit	Line	Data
85e174ba RL	1	/*
	2	* pNFS client data structures.
	3	*
	4	* Copyright (c) 2002
	5	* The Regents of the University of Michigan
	6	* All Rights Reserved
	7	*
	8	* Dean Hildebrand <dhildebz@umich.edu>
	9	*
	10	* Permission is granted to use, copy, create derivative works, and
	11	* redistribute this software and such derivative works for any purpose,
	12	* so long as the name of the University of Michigan is not used in
	13	* any advertising or publicity pertaining to the use or distribution
	14	* of this software without specific, written prior authorization. If
	15	* the above copyright notice or any other identification of the
	16	* University of Michigan is included in any copy of any portion of
	17	* this software, then the disclaimer below must also be included.
	18	*
	19	* This software is provided as is, without representation or warranty
	20	* of any kind either express or implied, including without limitation
	21	* the implied warranties of merchantability, fitness for a particular
	22	* purpose, or noninfringement. The Regents of the University of
	23	* Michigan shall not be liable for any damages, including special,
	24	* indirect, incidental, or consequential damages, with respect to any
	25	* claim arising out of or in connection with the use of the software,
	26	* even if it has been or is hereafter advised of the possibility of
	27	* such damages.
	28	*/
	29
	30	#ifndef FS_NFS_PNFS_H
	31	#define FS_NFS_PNFS_H
	32
45df3c8b	33	#include <linux/nfs_fs.h>
94ad1c80 FI	34	#include <linux/nfs_page.h>
94ad1c80 FI	35
4541d16c FI	36	enum {
4541d16c FI	37	NFS_LSEG_VALID = 0, /* cleared when lseg is recalled/returned */
f7e8917a	38	NFS_LSEG_ROC, /* roc bit received from server */
a9bae566	39	NFS_LSEG_LAYOUTCOMMIT, /* layoutcommit bit set for layoutcommit */
4541d16c FI	40	};
4541d16c FI	41
974cec8c	42	struct pnfs_layout_segment {
566052c5	43	struct list_head pls_list;
a9bae566	44	struct list_head pls_lc_list;
566052c5	45	struct pnfs_layout_range pls_range;
4541d16c FI	46	atomic_t pls_refcount;
4541d16c FI	47	unsigned long pls_flags;
566052c5	48	struct pnfs_layout_hdr *pls_layout;
974cec8c AA	49	};
974cec8c AA	50
64419a9b AA	51	enum pnfs_try_status {
	52	PNFS_ATTEMPTED = 0,
	53	PNFS_NOT_ATTEMPTED = 1,
	54	};
	55
85e174ba RL	56	#ifdef CONFIG_NFS_V4_1
	57
	58	#define LAYOUT_NFSV4_1_MODULE_PREFIX "nfs-layouttype4"
	59
e5e94017 BH	60	enum {
	61	NFS_LAYOUT_RO_FAILED = 0, /* get ro layout failed stop trying */
	62	NFS_LAYOUT_RW_FAILED, /* get rw layout failed stop trying */
43f1b3da	63	NFS_LAYOUT_BULK_RECALL, /* bulk recall affecting layout */
f7e8917a	64	NFS_LAYOUT_ROC, /* some lseg had roc bit set */
4541d16c	65	NFS_LAYOUT_DESTROYED, /* no new use of layout allowed */
e5e94017 BH	66	};
e5e94017 BH	67
8a1636c4 BH	68	enum layoutdriver_policy_flags {
	69	/* Should the pNFS client commit and return the layout upon a setattr */
	70	PNFS_LAYOUTRET_ON_SETATTR = 1 << 0,
fe0fe835	71	PNFS_LAYOUTRET_ON_ERROR = 1 << 1,
8a1636c4 BH	72	};
8a1636c4 BH	73
1775bc34 BH	74	struct nfs4_deviceid_node;
1775bc34 BH	75
85e174ba RL	76	/* Per-layout driver specific registration structure */
85e174ba RL	77	struct pnfs_layoutdriver_type {
02c35fca FI	78	struct list_head pnfs_tblid;
	79	const u32 id;
	80	const char *name;
	81	struct module *owner;
8a1636c4	82	unsigned flags;
636fb9c8	83
738fd0f3 BH	84	int (set_layoutdriver) (struct nfs_server , const struct nfs_fh *);
	85	int (clear_layoutdriver) (struct nfs_server );
	86
636fb9c8 BH	87	struct pnfs_layout_hdr * (alloc_layout_hdr) (struct inode inode, gfp_t gfp_flags);
	88	void (free_layout_hdr) (struct pnfs_layout_hdr );
	89
a75b9df9	90	struct pnfs_layout_segment * (alloc_lseg) (struct pnfs_layout_hdr layoutid, struct nfs4_layoutget_res *lgr, gfp_t gfp_flags);
b1f69b75	91	void (free_lseg) (struct pnfs_layout_segment lseg);
94ad1c80 FI	92
94ad1c80 FI	93	/* test for nfs page cache coalescing */
1751c363 TM	94	const struct nfs_pageio_ops *pg_read_ops;
1751c363 TM	95	const struct nfs_pageio_ops *pg_write_ops;
64419a9b	96
ea2cf228	97	struct pnfs_ds_commit_info (get_ds_info) (struct inode *inode);
8dd37758	98	void (mark_request_commit) (struct nfs_page req,
ea2cf228 FI	99	struct pnfs_layout_segment *lseg,
	100	struct nfs_commit_info *cinfo);
	101	void (clear_request_commit) (struct nfs_page req,
	102	struct nfs_commit_info *cinfo);
	103	int (scan_commit_lists) (struct nfs_commit_info cinfo,
	104	int max);
	105	int (commit_pagelist)(struct inode inode,
	106	struct list_head *mds_pages,
	107	int how,
	108	struct nfs_commit_info *cinfo);
a861a1e1	109
64419a9b AA	110	/*
	111	* Return PNFS_ATTEMPTED to indicate the layout code has attempted
	112	* I/O, else return PNFS_NOT_ATTEMPTED to fall back to normal NFS
	113	*/
	114	enum pnfs_try_status (read_pagelist) (struct nfs_read_data nfs_data);
0382b744	115	enum pnfs_try_status (write_pagelist) (struct nfs_write_data nfs_data, int how);
1775bc34 BH	116
1775bc34 BH	117	void (free_deviceid_node) (struct nfs4_deviceid_node );
04a55549 AA	118
	119	void (encode_layoutreturn) (struct pnfs_layout_hdr layoutid,
	120	struct xdr_stream *xdr,
	121	const struct nfs4_layoutreturn_args *args);
ac7db726	122
db29c089 AA	123	void (cleanup_layoutcommit) (struct nfs4_layoutcommit_data data);
db29c089 AA	124
ac7db726 BH	125	void (encode_layoutcommit) (struct pnfs_layout_hdr layoutid,
	126	struct xdr_stream *xdr,
	127	const struct nfs4_layoutcommit_args *args);
85e174ba RL	128	};
85e174ba RL	129
e5e94017	130	struct pnfs_layout_hdr {
cc6e5340	131	atomic_t plh_refcount;
b7edfaa1	132	struct list_head plh_layouts; /* other client layouts */
43f1b3da	133	struct list_head plh_bulk_recall; /* clnt list of bulk recalls */
b7edfaa1	134	struct list_head plh_segs; /* layout segments list */
b7edfaa1	135	nfs4_stateid plh_stateid;
cf7d63f1	136	atomic_t plh_outstanding; /* number of RPCs out */
f7e8917a	137	unsigned long plh_block_lgets; /* block LAYOUTGET if >0 */
43f1b3da	138	u32 plh_barrier; /* ignore lower seqids */
566052c5	139	unsigned long plh_flags;
acff5880	140	loff_t plh_lwb; /* last write byte for layoutcommit */
9fa40758	141	struct rpc_cred plh_lc_cred; / layoutcommit cred */
b7edfaa1	142	struct inode *plh_inode;
e5e94017 BH	143	};
e5e94017 BH	144
b1f69b75 AA	145	struct pnfs_device {
	146	struct nfs4_deviceid dev_id;
	147	unsigned int layout_type;
	148	unsigned int mincount;
	149	struct page **pages;
b1f69b75 AA	150	unsigned int pgbase;
	151	unsigned int pglen;
	152	};
	153
7f11d8d3 AA	154	#define NFS4_PNFS_GETDEVLIST_MAXNUM 16
	155
	156	struct pnfs_devicelist {
	157	unsigned int eof;
	158	unsigned int num_devs;
	159	struct nfs4_deviceid dev_id[NFS4_PNFS_GETDEVLIST_MAXNUM];
	160	};
	161
02c35fca FI	162	extern int pnfs_register_layoutdriver(struct pnfs_layoutdriver_type *);
	163	extern void pnfs_unregister_layoutdriver(struct pnfs_layoutdriver_type *);
	164
b1f69b75	165	/* nfs4proc.c */
7f11d8d3 AA	166	extern int nfs4_proc_getdevicelist(struct nfs_server *server,
	167	const struct nfs_fh *fh,
	168	struct pnfs_devicelist *devlist);
b1f69b75 AA	169	extern int nfs4_proc_getdeviceinfo(struct nfs_server *server,
	170	struct pnfs_device *dev);
	171	extern int nfs4_proc_layoutget(struct nfs4_layoutget *lgp);
cbe82603	172	extern int nfs4_proc_layoutreturn(struct nfs4_layoutreturn *lrp);
b1f69b75 AA	173
b1f69b75 AA	174	/* pnfs.c */
43f1b3da	175	void get_layout_hdr(struct pnfs_layout_hdr *lo);
bae724ef	176	void put_lseg(struct pnfs_layout_segment *lseg);
1751c363	177
061ae2ed FI	178	bool pnfs_pageio_init_read(struct nfs_pageio_descriptor , struct inode ,
	179	const struct nfs_pgio_completion_ops *);
	180	bool pnfs_pageio_init_write(struct nfs_pageio_descriptor , struct inode ,
	181	int, const struct nfs_pgio_completion_ops *);
1751c363	182
738fd0f3	183	void set_pnfs_layoutdriver(struct nfs_server , const struct nfs_fh , u32);
85e174ba	184	void unset_pnfs_layoutdriver(struct nfs_server *);
d8007d4d	185	void pnfs_generic_pg_init_read(struct nfs_pageio_descriptor , struct nfs_page );
493292dd	186	int pnfs_generic_pg_readpages(struct nfs_pageio_descriptor *desc);
d8007d4d	187	void pnfs_generic_pg_init_write(struct nfs_pageio_descriptor , struct nfs_page );
dce81290	188	int pnfs_generic_pg_writepages(struct nfs_pageio_descriptor *desc);
18ad0a9f	189	bool pnfs_generic_pg_test(struct nfs_pageio_descriptor pgio, struct nfs_page prev, struct nfs_page *req);
1b0ae068	190	void pnfs_set_lo_fail(struct pnfs_layout_segment *lseg);
b1f69b75	191	int pnfs_layout_process(struct nfs4_layoutget *lgp);
43f1b3da	192	void pnfs_free_lseg_list(struct list_head *tmp_list);
e5e94017	193	void pnfs_destroy_layout(struct nfs_inode *);
974cec8c	194	void pnfs_destroy_all_layouts(struct nfs_client *);
cc6e5340	195	void put_layout_hdr(struct pnfs_layout_hdr *lo);
43f1b3da FI	196	void pnfs_set_layout_stateid(struct pnfs_layout_hdr *lo,
	197	const nfs4_stateid *new,
	198	bool update_barrier);
fd6002e9 FI	199	int pnfs_choose_layoutget_stateid(nfs4_stateid *dst,
	200	struct pnfs_layout_hdr *lo,
	201	struct nfs4_state *open_state);
43f1b3da FI	202	int mark_matching_lsegs_invalid(struct pnfs_layout_hdr *lo,
43f1b3da FI	203	struct list_head *tmp_list,
778b5502	204	struct pnfs_layout_range *recall_range);
f7e8917a FI	205	bool pnfs_roc(struct inode *ino);
	206	void pnfs_roc_release(struct inode *ino);
	207	void pnfs_roc_set_barrier(struct inode *ino, u32 barrier);
	208	bool pnfs_roc_drain(struct inode ino, u32 barrier);
863a3c6c	209	void pnfs_set_layoutcommit(struct nfs_write_data *wdata);
db29c089	210	void pnfs_cleanup_layoutcommit(struct nfs4_layoutcommit_data *data);
ef311537	211	int pnfs_layoutcommit_inode(struct inode *inode, bool sync);
cbe82603	212	int _pnfs_return_layout(struct inode *);
8ce160c5	213	void pnfs_ld_write_done(struct nfs_write_data *);
9b7eecdc	214	void pnfs_ld_read_done(struct nfs_read_data *);
7c24d948 AA	215	struct pnfs_layout_segment pnfs_update_layout(struct inode ino,
	216	struct nfs_open_context *ctx,
	217	loff_t pos,
	218	u64 count,
	219	enum pnfs_iomode iomode,
	220	gfp_t gfp_flags);
e5e94017	221
c47abcf8 AA	222	void nfs4_deviceid_mark_client_invalid(struct nfs_client *clp);
	223
	224	/* nfs4_deviceid_flags */
	225	enum {
	226	NFS_DEVICEID_INVALID = 0, /* set when MDS clientid recalled */
	227	};
	228
a1eaecbc BH	229	/* pnfs_dev.c */
	230	struct nfs4_deviceid_node {
	231	struct hlist_node node;
9e3bd4e2	232	struct hlist_node tmpnode;
1775bc34	233	const struct pnfs_layoutdriver_type *ld;
a1eaecbc	234	const struct nfs_client *nfs_client;
c47abcf8	235	unsigned long flags;
a1eaecbc BH	236	struct nfs4_deviceid deviceid;
	237	atomic_t ref;
	238	};
	239
35c8bb54	240	struct nfs4_deviceid_node nfs4_find_get_deviceid(const struct pnfs_layoutdriver_type , const struct nfs_client , const struct nfs4_deviceid );
35c8bb54	241	void nfs4_delete_deviceid(const struct pnfs_layoutdriver_type , const struct nfs_client , const struct nfs4_deviceid *);
a1eaecbc	242	void nfs4_init_deviceid_node(struct nfs4_deviceid_node *,
1775bc34	243	const struct pnfs_layoutdriver_type *,
a1eaecbc BH	244	const struct nfs_client *,
	245	const struct nfs4_deviceid *);
	246	struct nfs4_deviceid_node nfs4_insert_deviceid_node(struct nfs4_deviceid_node );
	247	bool nfs4_put_deviceid_node(struct nfs4_deviceid_node *);
1775bc34	248	void nfs4_deviceid_purge_client(const struct nfs_client *);
a1eaecbc	249
e5e94017 BH	250	static inline int lo_fail_bit(u32 iomode)
	251	{
	252	return iomode == IOMODE_RW ?
	253	NFS_LAYOUT_RW_FAILED : NFS_LAYOUT_RO_FAILED;
	254	}
	255
d684d2ae FI	256	static inline struct pnfs_layout_segment *
	257	get_lseg(struct pnfs_layout_segment *lseg)
	258	{
	259	if (lseg) {
	260	atomic_inc(&lseg->pls_refcount);
	261	smp_mb__after_atomic_inc();
	262	}
	263	return lseg;
	264	}
	265
e5e94017 BH	266	/* Return true if a layout driver is being used for this mountpoint */
	267	static inline int pnfs_enabled_sb(struct nfs_server *nfss)
	268	{
	269	return nfss->pnfs_curr_ld != NULL;
	270	}
85e174ba	271
a861a1e1	272	static inline int
ea2cf228 FI	273	pnfs_commit_list(struct inode inode, struct list_head mds_pages, int how,
ea2cf228 FI	274	struct nfs_commit_info *cinfo)
a861a1e1	275	{
ea2cf228	276	if (cinfo->ds == NULL \|\| cinfo->ds->ncommitting == 0)
a861a1e1	277	return PNFS_NOT_ATTEMPTED;
ea2cf228 FI	278	return NFS_SERVER(inode)->pnfs_curr_ld->commit_pagelist(inode, mds_pages, how, cinfo);
	279	}
	280
	281	static inline struct pnfs_ds_commit_info *
	282	pnfs_get_ds_info(struct inode *inode)
	283	{
	284	struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
	285
	286	if (ld == NULL \|\| ld->get_ds_info == NULL)
	287	return NULL;
	288	return ld->get_ds_info(inode);
a861a1e1 FI	289	}
a861a1e1 FI	290
8dd37758	291	static inline bool
ea2cf228 FI	292	pnfs_mark_request_commit(struct nfs_page req, struct pnfs_layout_segment lseg,
ea2cf228 FI	293	struct nfs_commit_info *cinfo)
a861a1e1	294	{
d6d6dc7c	295	struct inode *inode = req->wb_context->dentry->d_inode;
8dd37758	296	struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
a861a1e1	297
8dd37758 TM	298	if (lseg == NULL \|\| ld->mark_request_commit == NULL)
8dd37758 TM	299	return false;
ea2cf228	300	ld->mark_request_commit(req, lseg, cinfo);
8dd37758	301	return true;
a861a1e1 FI	302	}
a861a1e1 FI	303
8dd37758	304	static inline bool
ea2cf228	305	pnfs_clear_request_commit(struct nfs_page req, struct nfs_commit_info cinfo)
a861a1e1	306	{
d6d6dc7c	307	struct inode *inode = req->wb_context->dentry->d_inode;
8dd37758	308	struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
d6d6dc7c	309
8dd37758 TM	310	if (ld == NULL \|\| ld->clear_request_commit == NULL)
8dd37758 TM	311	return false;
ea2cf228	312	ld->clear_request_commit(req, cinfo);
8dd37758	313	return true;
d6d6dc7c FI	314	}
	315
	316	static inline int
ea2cf228 FI	317	pnfs_scan_commit_lists(struct inode inode, struct nfs_commit_info cinfo,
ea2cf228 FI	318	int max)
d6d6dc7c	319	{
ea2cf228	320	if (cinfo->ds == NULL \|\| cinfo->ds->nwritten == 0)
d6d6dc7c	321	return 0;
ea2cf228 FI	322	else
ea2cf228 FI	323	return NFS_SERVER(inode)->pnfs_curr_ld->scan_commit_lists(cinfo, max);
a861a1e1 FI	324	}
a861a1e1 FI	325
8a1636c4 BH	326	/* Should the pNFS client commit and return the layout upon a setattr */
	327	static inline bool
	328	pnfs_ld_layoutret_on_setattr(struct inode *inode)
	329	{
	330	if (!pnfs_enabled_sb(NFS_SERVER(inode)))
	331	return false;
	332	return NFS_SERVER(inode)->pnfs_curr_ld->flags &
	333	PNFS_LAYOUTRET_ON_SETATTR;
	334	}
	335
cbe82603 BH	336	static inline int pnfs_return_layout(struct inode *ino)
	337	{
	338	struct nfs_inode *nfsi = NFS_I(ino);
	339	struct nfs_server *nfss = NFS_SERVER(ino);
	340
	341	if (pnfs_enabled_sb(nfss) && nfsi->layout)
	342	return _pnfs_return_layout(ino);
	343
	344	return 0;
	345	}
	346
6f00866d TM	347	#ifdef NFS_DEBUG
	348	void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id);
	349	#else
	350	static inline void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id)
	351	{
	352	}
	353	#endif /* NFS_DEBUG */
85e174ba RL	354	#else /* CONFIG_NFS_V4_1 */
85e174ba RL	355
974cec8c AA	356	static inline void pnfs_destroy_all_layouts(struct nfs_client *clp)
	357	{
	358	}
	359
e5e94017 BH	360	static inline void pnfs_destroy_layout(struct nfs_inode *nfsi)
	361	{
	362	}
	363
d684d2ae FI	364	static inline struct pnfs_layout_segment *
	365	get_lseg(struct pnfs_layout_segment *lseg)
	366	{
	367	return NULL;
	368	}
	369
	370	static inline void put_lseg(struct pnfs_layout_segment *lseg)
	371	{
	372	}
	373
cbe82603 BH	374	static inline int pnfs_return_layout(struct inode *ino)
	375	{
	376	return 0;
	377	}
	378
8a1636c4 BH	379	static inline bool
	380	pnfs_ld_layoutret_on_setattr(struct inode *inode)
	381	{
	382	return false;
	383	}
	384
f7e8917a FI	385	static inline bool
	386	pnfs_roc(struct inode *ino)
	387	{
	388	return false;
	389	}
	390
	391	static inline void
	392	pnfs_roc_release(struct inode *ino)
	393	{
	394	}
	395
	396	static inline void
	397	pnfs_roc_set_barrier(struct inode *ino, u32 barrier)
	398	{
	399	}
	400
	401	static inline bool
	402	pnfs_roc_drain(struct inode ino, u32 barrier)
	403	{
	404	return false;
	405	}
	406
738fd0f3	407	static inline void set_pnfs_layoutdriver(struct nfs_server *s,
a00ed25c	408	const struct nfs_fh *mntfh, u32 id)
85e174ba RL	409	{
	410	}
	411
	412	static inline void unset_pnfs_layoutdriver(struct nfs_server *s)
	413	{
	414	}
	415
1751c363	416	static inline bool pnfs_pageio_init_read(struct nfs_pageio_descriptor pgio, struct inode inode)
44b83799	417	{
1751c363 TM	418	return false;
	419	}
	420
	421	static inline bool pnfs_pageio_init_write(struct nfs_pageio_descriptor pgio, struct inode inode, int ioflags)
	422	{
	423	return false;
44b83799 FI	424	}
44b83799 FI	425
a861a1e1	426	static inline int
ea2cf228 FI	427	pnfs_commit_list(struct inode inode, struct list_head mds_pages, int how,
ea2cf228 FI	428	struct nfs_commit_info *cinfo)
a861a1e1 FI	429	{
	430	return PNFS_NOT_ATTEMPTED;
	431	}
	432
ea2cf228 FI	433	static inline struct pnfs_ds_commit_info *
	434	pnfs_get_ds_info(struct inode *inode)
	435	{
	436	return NULL;
	437	}
	438
8dd37758	439	static inline bool
ea2cf228 FI	440	pnfs_mark_request_commit(struct nfs_page req, struct pnfs_layout_segment lseg,
ea2cf228 FI	441	struct nfs_commit_info *cinfo)
a861a1e1	442	{
8dd37758	443	return false;
a861a1e1 FI	444	}
a861a1e1 FI	445
8dd37758	446	static inline bool
ea2cf228	447	pnfs_clear_request_commit(struct nfs_page req, struct nfs_commit_info cinfo)
a861a1e1	448	{
8dd37758	449	return false;
d6d6dc7c FI	450	}
	451
	452	static inline int
ea2cf228 FI	453	pnfs_scan_commit_lists(struct inode inode, struct nfs_commit_info cinfo,
ea2cf228 FI	454	int max)
d6d6dc7c FI	455	{
d6d6dc7c FI	456	return 0;
a861a1e1 FI	457	}
a861a1e1 FI	458
ef311537	459	static inline int pnfs_layoutcommit_inode(struct inode *inode, bool sync)
863a3c6c AA	460	{
	461	return 0;
	462	}
1775bc34	463
85e174ba RL	464	#endif /* CONFIG_NFS_V4_1 */
	465
	466	#endif /* FS_NFS_PNFS_H */