[deliverable/linux.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 */
};

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);
	void (*recover_commit_reqs) (struct list_head *list,
				     struct nfs_commit_info *cinfo);
	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_retry_timestamp;
	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 struct pnfs_layout_segment* nfs4_proc_layoutget(struct nfs4_layoutget *lgp, gfp_t gfp_flags);
extern int nfs4_proc_layoutreturn(struct nfs4_layoutreturn *lrp);

/* pnfs.c */
void pnfs_get_layout_hdr(struct pnfs_layout_hdr *lo);
void pnfs_put_lseg(struct pnfs_layout_segment *lseg);

void pnfs_pageio_init_read(struct nfs_pageio_descriptor *, struct inode *,
			   const struct nfs_pgio_completion_ops *);
void 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 *pgio,
			        struct nfs_page *req, u64 wb_size);
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);
struct pnfs_layout_segment *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 pnfs_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 pnfs_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, struct rpc_task *task);
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);
int pnfs_read_done_resend_to_mds(struct inode *inode, struct list_head *head,
			const struct nfs_pgio_completion_ops *compl_ops);
int pnfs_write_done_resend_to_mds(struct inode *inode, struct list_head *head,
			const struct nfs_pgio_completion_ops *compl_ops);
struct nfs4_threshold *pnfs_mdsthreshold_alloc(void);

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

/* 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;
	unsigned long			timestamp_unavailable;
	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_mark_deviceid_unavailable(struct nfs4_deviceid_node *node);
bool nfs4_test_deviceid_unavailable(struct nfs4_deviceid_node *node);
void nfs4_deviceid_purge_client(const struct nfs_client *);

static inline struct pnfs_layout_segment *
pnfs_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);
}

static inline void
pnfs_recover_commit_reqs(struct inode *inode, struct list_head *list,
			 struct nfs_commit_info *cinfo)
{
	if (cinfo->ds == NULL || cinfo->ds->nwritten == 0)
		return;
	NFS_SERVER(inode)->pnfs_curr_ld->recover_commit_reqs(list, cinfo);
}

/* 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;
}

static inline bool
pnfs_use_threshold(struct nfs4_threshold **dst, struct nfs4_threshold *src,
		   struct nfs_server *nfss)
{
	return (dst && src && src->bm != 0 && nfss->pnfs_curr_ld &&
					nfss->pnfs_curr_ld->id == src->l_type);
}

#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 *
pnfs_get_lseg(struct pnfs_layout_segment *lseg)
{
	return NULL;
}

static inline void pnfs_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, struct rpc_task *task)
{
	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 void pnfs_pageio_init_read(struct nfs_pageio_descriptor *pgio, struct inode *inode,
					 const struct nfs_pgio_completion_ops *compl_ops)
{
	nfs_pageio_init_read(pgio, inode, compl_ops);
}

static inline void pnfs_pageio_init_write(struct nfs_pageio_descriptor *pgio, struct inode *inode, int ioflags,
					  const struct nfs_pgio_completion_ops *compl_ops)
{
	nfs_pageio_init_write(pgio, inode, ioflags, compl_ops);
}

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 void
pnfs_recover_commit_reqs(struct inode *inode, struct list_head *list,
			 struct nfs_commit_info *cinfo)
{
}

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

static inline bool
pnfs_use_threshold(struct nfs4_threshold **dst, struct nfs4_threshold *src,
		   struct nfs_server *nfss)
{
	return false;
}

static inline struct nfs4_threshold *pnfs_mdsthreshold_alloc(void)
{
	return NULL;
}

#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 */
e5e94017 BH	65	};
e5e94017 BH	66
8a1636c4 BH	67	enum layoutdriver_policy_flags {
	68	/* Should the pNFS client commit and return the layout upon a setattr */
	69	PNFS_LAYOUTRET_ON_SETATTR = 1 << 0,
fe0fe835	70	PNFS_LAYOUTRET_ON_ERROR = 1 << 1,
8a1636c4 BH	71	};
8a1636c4 BH	72
1775bc34 BH	73	struct nfs4_deviceid_node;
1775bc34 BH	74
85e174ba RL	75	/* Per-layout driver specific registration structure */
85e174ba RL	76	struct pnfs_layoutdriver_type {
02c35fca FI	77	struct list_head pnfs_tblid;
	78	const u32 id;
	79	const char *name;
	80	struct module *owner;
8a1636c4	81	unsigned flags;
636fb9c8	82
738fd0f3 BH	83	int (set_layoutdriver) (struct nfs_server , const struct nfs_fh *);
	84	int (clear_layoutdriver) (struct nfs_server );
	85
636fb9c8 BH	86	struct pnfs_layout_hdr * (alloc_layout_hdr) (struct inode inode, gfp_t gfp_flags);
	87	void (free_layout_hdr) (struct pnfs_layout_hdr );
	88
a75b9df9	89	struct pnfs_layout_segment * (alloc_lseg) (struct pnfs_layout_hdr layoutid, struct nfs4_layoutget_res *lgr, gfp_t gfp_flags);
b1f69b75	90	void (free_lseg) (struct pnfs_layout_segment lseg);
94ad1c80 FI	91
94ad1c80 FI	92	/* test for nfs page cache coalescing */
1751c363 TM	93	const struct nfs_pageio_ops *pg_read_ops;
1751c363 TM	94	const struct nfs_pageio_ops *pg_write_ops;
64419a9b	95
ea2cf228	96	struct pnfs_ds_commit_info (get_ds_info) (struct inode *inode);
8dd37758	97	void (mark_request_commit) (struct nfs_page req,
ea2cf228 FI	98	struct pnfs_layout_segment *lseg,
	99	struct nfs_commit_info *cinfo);
	100	void (clear_request_commit) (struct nfs_page req,
	101	struct nfs_commit_info *cinfo);
	102	int (scan_commit_lists) (struct nfs_commit_info cinfo,
	103	int max);
1763da12 FI	104	void (recover_commit_reqs) (struct list_head list,
1763da12 FI	105	struct nfs_commit_info *cinfo);
ea2cf228 FI	106	int (commit_pagelist)(struct inode inode,
	107	struct list_head *mds_pages,
	108	int how,
	109	struct nfs_commit_info *cinfo);
a861a1e1	110
64419a9b AA	111	/*
	112	* Return PNFS_ATTEMPTED to indicate the layout code has attempted
	113	* I/O, else return PNFS_NOT_ATTEMPTED to fall back to normal NFS
	114	*/
	115	enum pnfs_try_status (read_pagelist) (struct nfs_read_data nfs_data);
0382b744	116	enum pnfs_try_status (write_pagelist) (struct nfs_write_data nfs_data, int how);
1775bc34 BH	117
1775bc34 BH	118	void (free_deviceid_node) (struct nfs4_deviceid_node );
04a55549 AA	119
	120	void (encode_layoutreturn) (struct pnfs_layout_hdr layoutid,
	121	struct xdr_stream *xdr,
	122	const struct nfs4_layoutreturn_args *args);
ac7db726	123
db29c089 AA	124	void (cleanup_layoutcommit) (struct nfs4_layoutcommit_data data);
db29c089 AA	125
ac7db726 BH	126	void (encode_layoutcommit) (struct pnfs_layout_hdr layoutid,
	127	struct xdr_stream *xdr,
	128	const struct nfs4_layoutcommit_args *args);
85e174ba RL	129	};
85e174ba RL	130
e5e94017	131	struct pnfs_layout_hdr {
cc6e5340	132	atomic_t plh_refcount;
b7edfaa1	133	struct list_head plh_layouts; /* other client layouts */
43f1b3da	134	struct list_head plh_bulk_recall; /* clnt list of bulk recalls */
b7edfaa1	135	struct list_head plh_segs; /* layout segments list */
b7edfaa1	136	nfs4_stateid plh_stateid;
cf7d63f1	137	atomic_t plh_outstanding; /* number of RPCs out */
f7e8917a	138	unsigned long plh_block_lgets; /* block LAYOUTGET if >0 */
43f1b3da	139	u32 plh_barrier; /* ignore lower seqids */
25c75333	140	unsigned long plh_retry_timestamp;
566052c5	141	unsigned long plh_flags;
acff5880	142	loff_t plh_lwb; /* last write byte for layoutcommit */
9fa40758	143	struct rpc_cred plh_lc_cred; / layoutcommit cred */
b7edfaa1	144	struct inode *plh_inode;
e5e94017 BH	145	};
e5e94017 BH	146
b1f69b75 AA	147	struct pnfs_device {
	148	struct nfs4_deviceid dev_id;
	149	unsigned int layout_type;
	150	unsigned int mincount;
	151	struct page **pages;
b1f69b75 AA	152	unsigned int pgbase;
	153	unsigned int pglen;
	154	};
	155
7f11d8d3 AA	156	#define NFS4_PNFS_GETDEVLIST_MAXNUM 16
	157
	158	struct pnfs_devicelist {
	159	unsigned int eof;
	160	unsigned int num_devs;
	161	struct nfs4_deviceid dev_id[NFS4_PNFS_GETDEVLIST_MAXNUM];
	162	};
	163
02c35fca FI	164	extern int pnfs_register_layoutdriver(struct pnfs_layoutdriver_type *);
	165	extern void pnfs_unregister_layoutdriver(struct pnfs_layoutdriver_type *);
	166
b1f69b75	167	/* nfs4proc.c */
7f11d8d3 AA	168	extern int nfs4_proc_getdevicelist(struct nfs_server *server,
	169	const struct nfs_fh *fh,
	170	struct pnfs_devicelist *devlist);
b1f69b75 AA	171	extern int nfs4_proc_getdeviceinfo(struct nfs_server *server,
b1f69b75 AA	172	struct pnfs_device *dev);
a0b0a6e3	173	extern struct pnfs_layout_segment* nfs4_proc_layoutget(struct nfs4_layoutget *lgp, gfp_t gfp_flags);
cbe82603	174	extern int nfs4_proc_layoutreturn(struct nfs4_layoutreturn *lrp);
b1f69b75 AA	175
b1f69b75 AA	176	/* pnfs.c */
70c3bd2b	177	void pnfs_get_layout_hdr(struct pnfs_layout_hdr *lo);
9369a431	178	void pnfs_put_lseg(struct pnfs_layout_segment *lseg);
1751c363	179
1abb5088	180	void pnfs_pageio_init_read(struct nfs_pageio_descriptor , struct inode ,
061ae2ed	181	const struct nfs_pgio_completion_ops *);
57208fa7	182	void pnfs_pageio_init_write(struct nfs_pageio_descriptor , struct inode ,
061ae2ed	183	int, const struct nfs_pgio_completion_ops *);
1751c363	184
738fd0f3	185	void set_pnfs_layoutdriver(struct nfs_server , const struct nfs_fh , u32);
85e174ba	186	void unset_pnfs_layoutdriver(struct nfs_server *);
d8007d4d	187	void pnfs_generic_pg_init_read(struct nfs_pageio_descriptor , struct nfs_page );
493292dd	188	int pnfs_generic_pg_readpages(struct nfs_pageio_descriptor *desc);
6296556f PT	189	void pnfs_generic_pg_init_write(struct nfs_pageio_descriptor *pgio,
6296556f PT	190	struct nfs_page *req, u64 wb_size);
dce81290	191	int pnfs_generic_pg_writepages(struct nfs_pageio_descriptor *desc);
18ad0a9f	192	bool pnfs_generic_pg_test(struct nfs_pageio_descriptor pgio, struct nfs_page prev, struct nfs_page *req);
1b0ae068	193	void pnfs_set_lo_fail(struct pnfs_layout_segment *lseg);
a0b0a6e3	194	struct pnfs_layout_segment pnfs_layout_process(struct nfs4_layoutget lgp);
43f1b3da	195	void pnfs_free_lseg_list(struct list_head *tmp_list);
e5e94017	196	void pnfs_destroy_layout(struct nfs_inode *);
974cec8c	197	void pnfs_destroy_all_layouts(struct nfs_client *);
70c3bd2b	198	void pnfs_put_layout_hdr(struct pnfs_layout_hdr *lo);
43f1b3da FI	199	void pnfs_set_layout_stateid(struct pnfs_layout_hdr *lo,
	200	const nfs4_stateid *new,
	201	bool update_barrier);
fd6002e9 FI	202	int pnfs_choose_layoutget_stateid(nfs4_stateid *dst,
	203	struct pnfs_layout_hdr *lo,
	204	struct nfs4_state *open_state);
49a85061	205	int pnfs_mark_matching_lsegs_invalid(struct pnfs_layout_hdr *lo,
43f1b3da	206	struct list_head *tmp_list,
778b5502	207	struct pnfs_layout_range *recall_range);
f7e8917a FI	208	bool pnfs_roc(struct inode *ino);
	209	void pnfs_roc_release(struct inode *ino);
	210	void pnfs_roc_set_barrier(struct inode *ino, u32 barrier);
7fdab069	211	bool pnfs_roc_drain(struct inode ino, u32 barrier, struct rpc_task *task);
863a3c6c	212	void pnfs_set_layoutcommit(struct nfs_write_data *wdata);
db29c089	213	void pnfs_cleanup_layoutcommit(struct nfs4_layoutcommit_data *data);
ef311537	214	int pnfs_layoutcommit_inode(struct inode *inode, bool sync);
cbe82603	215	int _pnfs_return_layout(struct inode *);
8ce160c5	216	void pnfs_ld_write_done(struct nfs_write_data *);
9b7eecdc	217	void pnfs_ld_read_done(struct nfs_read_data *);
7c24d948 AA	218	struct pnfs_layout_segment pnfs_update_layout(struct inode ino,
	219	struct nfs_open_context *ctx,
	220	loff_t pos,
	221	u64 count,
	222	enum pnfs_iomode iomode,
	223	gfp_t gfp_flags);
e5e94017	224
c47abcf8	225	void nfs4_deviceid_mark_client_invalid(struct nfs_client *clp);
e7dd79af AA	226	int pnfs_read_done_resend_to_mds(struct inode inode, struct list_head head,
	227	const struct nfs_pgio_completion_ops *compl_ops);
	228	int pnfs_write_done_resend_to_mds(struct inode inode, struct list_head head,
	229	const struct nfs_pgio_completion_ops *compl_ops);
82be417a	230	struct nfs4_threshold *pnfs_mdsthreshold_alloc(void);
c47abcf8 AA	231
	232	/* nfs4_deviceid_flags */
	233	enum {
	234	NFS_DEVICEID_INVALID = 0, /* set when MDS clientid recalled */
1dfed273	235	NFS_DEVICEID_UNAVAILABLE, /* device temporarily unavailable */
c47abcf8 AA	236	};
c47abcf8 AA	237
a1eaecbc BH	238	/* pnfs_dev.c */
	239	struct nfs4_deviceid_node {
	240	struct hlist_node node;
9e3bd4e2	241	struct hlist_node tmpnode;
1775bc34	242	const struct pnfs_layoutdriver_type *ld;
a1eaecbc	243	const struct nfs_client *nfs_client;
c47abcf8	244	unsigned long flags;
1dfed273	245	unsigned long timestamp_unavailable;
a1eaecbc BH	246	struct nfs4_deviceid deviceid;
	247	atomic_t ref;
	248	};
	249
35c8bb54	250	struct nfs4_deviceid_node nfs4_find_get_deviceid(const struct pnfs_layoutdriver_type , const struct nfs_client , const struct nfs4_deviceid );
35c8bb54	251	void nfs4_delete_deviceid(const struct pnfs_layoutdriver_type , const struct nfs_client , const struct nfs4_deviceid *);
a1eaecbc	252	void nfs4_init_deviceid_node(struct nfs4_deviceid_node *,
1775bc34	253	const struct pnfs_layoutdriver_type *,
a1eaecbc BH	254	const struct nfs_client *,
	255	const struct nfs4_deviceid *);
	256	struct nfs4_deviceid_node nfs4_insert_deviceid_node(struct nfs4_deviceid_node );
	257	bool nfs4_put_deviceid_node(struct nfs4_deviceid_node *);
1dfed273 TM	258	void nfs4_mark_deviceid_unavailable(struct nfs4_deviceid_node *node);
1dfed273 TM	259	bool nfs4_test_deviceid_unavailable(struct nfs4_deviceid_node *node);
1775bc34	260	void nfs4_deviceid_purge_client(const struct nfs_client *);
a1eaecbc	261
d684d2ae	262	static inline struct pnfs_layout_segment *
9369a431	263	pnfs_get_lseg(struct pnfs_layout_segment *lseg)
d684d2ae FI	264	{
	265	if (lseg) {
	266	atomic_inc(&lseg->pls_refcount);
	267	smp_mb__after_atomic_inc();
	268	}
	269	return lseg;
	270	}
	271
e5e94017 BH	272	/* Return true if a layout driver is being used for this mountpoint */
	273	static inline int pnfs_enabled_sb(struct nfs_server *nfss)
	274	{
	275	return nfss->pnfs_curr_ld != NULL;
	276	}
85e174ba	277
a861a1e1	278	static inline int
ea2cf228 FI	279	pnfs_commit_list(struct inode inode, struct list_head mds_pages, int how,
ea2cf228 FI	280	struct nfs_commit_info *cinfo)
a861a1e1	281	{
ea2cf228	282	if (cinfo->ds == NULL \|\| cinfo->ds->ncommitting == 0)
a861a1e1	283	return PNFS_NOT_ATTEMPTED;
ea2cf228 FI	284	return NFS_SERVER(inode)->pnfs_curr_ld->commit_pagelist(inode, mds_pages, how, cinfo);
	285	}
	286
	287	static inline struct pnfs_ds_commit_info *
	288	pnfs_get_ds_info(struct inode *inode)
	289	{
	290	struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
	291
	292	if (ld == NULL \|\| ld->get_ds_info == NULL)
	293	return NULL;
	294	return ld->get_ds_info(inode);
a861a1e1 FI	295	}
a861a1e1 FI	296
8dd37758	297	static inline bool
ea2cf228 FI	298	pnfs_mark_request_commit(struct nfs_page req, struct pnfs_layout_segment lseg,
ea2cf228 FI	299	struct nfs_commit_info *cinfo)
a861a1e1	300	{
d6d6dc7c	301	struct inode *inode = req->wb_context->dentry->d_inode;
8dd37758	302	struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
a861a1e1	303
8dd37758 TM	304	if (lseg == NULL \|\| ld->mark_request_commit == NULL)
8dd37758 TM	305	return false;
ea2cf228	306	ld->mark_request_commit(req, lseg, cinfo);
8dd37758	307	return true;
a861a1e1 FI	308	}
a861a1e1 FI	309
8dd37758	310	static inline bool
ea2cf228	311	pnfs_clear_request_commit(struct nfs_page req, struct nfs_commit_info cinfo)
a861a1e1	312	{
d6d6dc7c	313	struct inode *inode = req->wb_context->dentry->d_inode;
8dd37758	314	struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
d6d6dc7c	315
8dd37758 TM	316	if (ld == NULL \|\| ld->clear_request_commit == NULL)
8dd37758 TM	317	return false;
ea2cf228	318	ld->clear_request_commit(req, cinfo);
8dd37758	319	return true;
d6d6dc7c FI	320	}
	321
	322	static inline int
ea2cf228 FI	323	pnfs_scan_commit_lists(struct inode inode, struct nfs_commit_info cinfo,
ea2cf228 FI	324	int max)
d6d6dc7c	325	{
ea2cf228	326	if (cinfo->ds == NULL \|\| cinfo->ds->nwritten == 0)
d6d6dc7c	327	return 0;
ea2cf228 FI	328	else
ea2cf228 FI	329	return NFS_SERVER(inode)->pnfs_curr_ld->scan_commit_lists(cinfo, max);
a861a1e1 FI	330	}
a861a1e1 FI	331
1763da12 FI	332	static inline void
	333	pnfs_recover_commit_reqs(struct inode inode, struct list_head list,
	334	struct nfs_commit_info *cinfo)
	335	{
	336	if (cinfo->ds == NULL \|\| cinfo->ds->nwritten == 0)
	337	return;
	338	NFS_SERVER(inode)->pnfs_curr_ld->recover_commit_reqs(list, cinfo);
	339	}
	340
8a1636c4 BH	341	/* Should the pNFS client commit and return the layout upon a setattr */
	342	static inline bool
	343	pnfs_ld_layoutret_on_setattr(struct inode *inode)
	344	{
	345	if (!pnfs_enabled_sb(NFS_SERVER(inode)))
	346	return false;
	347	return NFS_SERVER(inode)->pnfs_curr_ld->flags &
	348	PNFS_LAYOUTRET_ON_SETATTR;
	349	}
	350
cbe82603 BH	351	static inline int pnfs_return_layout(struct inode *ino)
	352	{
	353	struct nfs_inode *nfsi = NFS_I(ino);
	354	struct nfs_server *nfss = NFS_SERVER(ino);
	355
	356	if (pnfs_enabled_sb(nfss) && nfsi->layout)
	357	return _pnfs_return_layout(ino);
	358
	359	return 0;
	360	}
	361
82be417a AA	362	static inline bool
	363	pnfs_use_threshold(struct nfs4_threshold *dst, struct nfs4_threshold src,
	364	struct nfs_server *nfss)
	365	{
fb47ddc9	366	return (dst && src && src->bm != 0 && nfss->pnfs_curr_ld &&
82be417a AA	367	nfss->pnfs_curr_ld->id == src->l_type);
	368	}
	369
6f00866d TM	370	#ifdef NFS_DEBUG
	371	void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id);
	372	#else
	373	static inline void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id)
	374	{
	375	}
	376	#endif /* NFS_DEBUG */
85e174ba RL	377	#else /* CONFIG_NFS_V4_1 */
85e174ba RL	378
974cec8c AA	379	static inline void pnfs_destroy_all_layouts(struct nfs_client *clp)
	380	{
	381	}
	382
e5e94017 BH	383	static inline void pnfs_destroy_layout(struct nfs_inode *nfsi)
	384	{
	385	}
	386
d684d2ae	387	static inline struct pnfs_layout_segment *
9369a431	388	pnfs_get_lseg(struct pnfs_layout_segment *lseg)
d684d2ae FI	389	{
	390	return NULL;
	391	}
	392
9369a431	393	static inline void pnfs_put_lseg(struct pnfs_layout_segment *lseg)
d684d2ae FI	394	{
	395	}
	396
cbe82603 BH	397	static inline int pnfs_return_layout(struct inode *ino)
	398	{
	399	return 0;
	400	}
	401
8a1636c4 BH	402	static inline bool
	403	pnfs_ld_layoutret_on_setattr(struct inode *inode)
	404	{
	405	return false;
	406	}
	407
f7e8917a FI	408	static inline bool
	409	pnfs_roc(struct inode *ino)
	410	{
	411	return false;
	412	}
	413
	414	static inline void
	415	pnfs_roc_release(struct inode *ino)
	416	{
	417	}
	418
	419	static inline void
	420	pnfs_roc_set_barrier(struct inode *ino, u32 barrier)
	421	{
	422	}
	423
	424	static inline bool
7fdab069	425	pnfs_roc_drain(struct inode ino, u32 barrier, struct rpc_task *task)
f7e8917a FI	426	{
	427	return false;
	428	}
	429
738fd0f3	430	static inline void set_pnfs_layoutdriver(struct nfs_server *s,
a00ed25c	431	const struct nfs_fh *mntfh, u32 id)
85e174ba RL	432	{
	433	}
	434
	435	static inline void unset_pnfs_layoutdriver(struct nfs_server *s)
	436	{
	437	}
	438
1abb5088	439	static inline void pnfs_pageio_init_read(struct nfs_pageio_descriptor pgio, struct inode inode,
b58fee21	440	const struct nfs_pgio_completion_ops *compl_ops)
44b83799	441	{
1abb5088	442	nfs_pageio_init_read(pgio, inode, compl_ops);
1751c363 TM	443	}
1751c363 TM	444
57208fa7	445	static inline void pnfs_pageio_init_write(struct nfs_pageio_descriptor pgio, struct inode inode, int ioflags,
b58fee21	446	const struct nfs_pgio_completion_ops *compl_ops)
1751c363	447	{
57208fa7	448	nfs_pageio_init_write(pgio, inode, ioflags, compl_ops);
44b83799 FI	449	}
44b83799 FI	450
a861a1e1	451	static inline int
ea2cf228 FI	452	pnfs_commit_list(struct inode inode, struct list_head mds_pages, int how,
ea2cf228 FI	453	struct nfs_commit_info *cinfo)
a861a1e1 FI	454	{
	455	return PNFS_NOT_ATTEMPTED;
	456	}
	457
ea2cf228 FI	458	static inline struct pnfs_ds_commit_info *
	459	pnfs_get_ds_info(struct inode *inode)
	460	{
	461	return NULL;
	462	}
	463
8dd37758	464	static inline bool
ea2cf228 FI	465	pnfs_mark_request_commit(struct nfs_page req, struct pnfs_layout_segment lseg,
ea2cf228 FI	466	struct nfs_commit_info *cinfo)
a861a1e1	467	{
8dd37758	468	return false;
a861a1e1 FI	469	}
a861a1e1 FI	470
8dd37758	471	static inline bool
ea2cf228	472	pnfs_clear_request_commit(struct nfs_page req, struct nfs_commit_info cinfo)
a861a1e1	473	{
8dd37758	474	return false;
d6d6dc7c FI	475	}
	476
	477	static inline int
ea2cf228 FI	478	pnfs_scan_commit_lists(struct inode inode, struct nfs_commit_info cinfo,
ea2cf228 FI	479	int max)
d6d6dc7c FI	480	{
d6d6dc7c FI	481	return 0;
a861a1e1 FI	482	}
a861a1e1 FI	483
1763da12 FI	484	static inline void
	485	pnfs_recover_commit_reqs(struct inode inode, struct list_head list,
	486	struct nfs_commit_info *cinfo)
	487	{
	488	}
	489
ef311537	490	static inline int pnfs_layoutcommit_inode(struct inode *inode, bool sync)
863a3c6c AA	491	{
	492	return 0;
	493	}
1775bc34	494
82be417a AA	495	static inline bool
	496	pnfs_use_threshold(struct nfs4_threshold *dst, struct nfs4_threshold src,
	497	struct nfs_server *nfss)
	498	{
	499	return false;
	500	}
	501
	502	static inline struct nfs4_threshold *pnfs_mdsthreshold_alloc(void)
	503	{
	504	return NULL;
	505	}
	506
85e174ba RL	507	#endif /* CONFIG_NFS_V4_1 */
	508
	509	#endif /* FS_NFS_PNFS_H */