[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 <[email protected]>
 *
 *  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_RETURN,		/* Return this layout ASAP */
};

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