[linux-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 */
	NFS_LAYOUT_INVALID,		/* layout is being destroyed */
};

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

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

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 *
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,
					 const struct nfs_pgio_completion_ops *compl_ops)
{
	return false;
}

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