[mirror_ubuntu-bionic-kernel.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 */
	NFS_LAYOUT_RETURNED,		/* layout has already been returned */
};

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 *, 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);
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);
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 void
pnfs_mark_layout_returned(struct pnfs_layout_hdr *lo)
{
	set_bit(NFS_LAYOUT_RETURNED, &lo->plh_flags);
}

static inline void
pnfs_clear_layout_returned(struct pnfs_layout_hdr *lo)
{
	clear_bit(NFS_LAYOUT_RETURNED, &lo->plh_flags);
}

static inline bool
pnfs_test_layout_returned(struct pnfs_layout_hdr *lo)
{
	return test_bit(NFS_LAYOUT_RETURNED, &lo->plh_flags);
}

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