[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_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);
	struct nfs_page * (*search_commit_reqs)(struct nfs_commit_info *cinfo,
						struct page *page);
	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_pgio_header *);
	enum pnfs_try_status (*write_pagelist)(struct nfs_pgio_header *, int);

	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;
	unsigned int  maxcount;	/* gdia_maxcount */
	struct page **pages;
	unsigned int  pgbase;
	unsigned int  pglen;	/* reply buffer length */
};

#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,
				   struct rpc_cred *cred);
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 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);
size_t 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_pgio_header *);
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_pgio_header *);
void pnfs_ld_read_done(struct nfs_pgio_header *);
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 nfs_pgio_header *);
int pnfs_write_done_resend_to_mds(struct nfs_pgio_header *);
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();
	}
	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);
}

static inline struct nfs_page *
pnfs_search_commit_reqs(struct inode *inode, struct nfs_commit_info *cinfo,
			struct page *page)
{
	struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;

	if (ld == NULL || ld->search_commit_reqs == NULL)
		return NULL;
	return ld->search_commit_reqs(cinfo, page);
}

/* 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 bool
pnfs_layoutcommit_outstanding(struct inode *inode)
{
	struct nfs_inode *nfsi = NFS_I(inode);

	return test_bit(NFS_INO_LAYOUTCOMMIT, &nfsi->flags) != 0 ||
		test_bit(NFS_INO_LAYOUTCOMMITTING, &nfsi->flags) != 0;
}

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 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 struct nfs_page *
pnfs_search_commit_reqs(struct inode *inode, struct nfs_commit_info *cinfo,
			struct page *page)
{
	return NULL;
}

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 bool
pnfs_layoutcommit_outstanding(struct inode *inode)
{
	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 */
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);
02d1426c WAA	107	struct nfs_page * (search_commit_reqs)(struct nfs_commit_info cinfo,
02d1426c WAA	108	struct page *page);
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	*/
d45f60c6 WAA	118	enum pnfs_try_status (read_pagelist)(struct nfs_pgio_header );
d45f60c6 WAA	119	enum pnfs_try_status (write_pagelist)(struct nfs_pgio_header , int);
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 */
fd9a8d71	137	struct list_head plh_bulk_destroy;
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;
f1c097be	154	unsigned int maxcount; /* gdia_maxcount */
b1f69b75	155	struct page **pages;
b1f69b75	156	unsigned int pgbase;
f1c097be	157	unsigned int pglen; /* reply buffer length */
b1f69b75 AA	158	};
b1f69b75 AA	159
7f11d8d3 AA	160	#define NFS4_PNFS_GETDEVLIST_MAXNUM 16
	161
	162	struct pnfs_devicelist {
	163	unsigned int eof;
	164	unsigned int num_devs;
	165	struct nfs4_deviceid dev_id[NFS4_PNFS_GETDEVLIST_MAXNUM];
	166	};
	167
02c35fca FI	168	extern int pnfs_register_layoutdriver(struct pnfs_layoutdriver_type *);
	169	extern void pnfs_unregister_layoutdriver(struct pnfs_layoutdriver_type *);
	170
b1f69b75	171	/* nfs4proc.c */
7f11d8d3 AA	172	extern int nfs4_proc_getdevicelist(struct nfs_server *server,
	173	const struct nfs_fh *fh,
	174	struct pnfs_devicelist *devlist);
b1f69b75	175	extern int nfs4_proc_getdeviceinfo(struct nfs_server *server,
cd5875fe TM	176	struct pnfs_device *dev,
cd5875fe TM	177	struct rpc_cred *cred);
a0b0a6e3	178	extern struct pnfs_layout_segment* nfs4_proc_layoutget(struct nfs4_layoutget *lgp, gfp_t gfp_flags);
cbe82603	179	extern int nfs4_proc_layoutreturn(struct nfs4_layoutreturn *lrp);
b1f69b75 AA	180
b1f69b75 AA	181	/* pnfs.c */
70c3bd2b	182	void pnfs_get_layout_hdr(struct pnfs_layout_hdr *lo);
9369a431	183	void pnfs_put_lseg(struct pnfs_layout_segment *lseg);
1751c363	184
738fd0f3	185	void set_pnfs_layoutdriver(struct nfs_server , const struct nfs_fh , u32);
85e174ba	186	void unset_pnfs_layoutdriver(struct nfs_server *);
d8007d4d	187	void pnfs_generic_pg_init_read(struct nfs_pageio_descriptor , struct nfs_page );
493292dd	188	int pnfs_generic_pg_readpages(struct nfs_pageio_descriptor *desc);
6296556f PT	189	void pnfs_generic_pg_init_write(struct nfs_pageio_descriptor *pgio,
6296556f PT	190	struct nfs_page *req, u64 wb_size);
dce81290	191	int pnfs_generic_pg_writepages(struct nfs_pageio_descriptor *desc);
b4fdac1a WAA	192	size_t pnfs_generic_pg_test(struct nfs_pageio_descriptor *pgio,
b4fdac1a WAA	193	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);
d45f60c6	218	void pnfs_set_layoutcommit(struct nfs_pgio_header *);
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 *);
d45f60c6 WAA	223	void pnfs_ld_write_done(struct nfs_pgio_header *);
d45f60c6 WAA	224	void pnfs_ld_read_done(struct nfs_pgio_header *);
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);
53113ad3 WAA	233	int pnfs_read_done_resend_to_mds(struct nfs_pgio_header *);
53113ad3 WAA	234	int pnfs_write_done_resend_to_mds(struct nfs_pgio_header *);
82be417a	235	struct nfs4_threshold *pnfs_mdsthreshold_alloc(void);
c47abcf8 AA	236
	237	/* nfs4_deviceid_flags */
	238	enum {
	239	NFS_DEVICEID_INVALID = 0, /* set when MDS clientid recalled */
1dfed273	240	NFS_DEVICEID_UNAVAILABLE, /* device temporarily unavailable */
c47abcf8 AA	241	};
c47abcf8 AA	242
a1eaecbc BH	243	/* pnfs_dev.c */
	244	struct nfs4_deviceid_node {
	245	struct hlist_node node;
9e3bd4e2	246	struct hlist_node tmpnode;
1775bc34	247	const struct pnfs_layoutdriver_type *ld;
a1eaecbc	248	const struct nfs_client *nfs_client;
c47abcf8	249	unsigned long flags;
1dfed273	250	unsigned long timestamp_unavailable;
a1eaecbc BH	251	struct nfs4_deviceid deviceid;
	252	atomic_t ref;
	253	};
	254
35c8bb54	255	struct nfs4_deviceid_node nfs4_find_get_deviceid(const struct pnfs_layoutdriver_type , const struct nfs_client , const struct nfs4_deviceid );
35c8bb54	256	void nfs4_delete_deviceid(const struct pnfs_layoutdriver_type , const struct nfs_client , const struct nfs4_deviceid *);
a1eaecbc	257	void nfs4_init_deviceid_node(struct nfs4_deviceid_node *,
1775bc34	258	const struct pnfs_layoutdriver_type *,
a1eaecbc BH	259	const struct nfs_client *,
	260	const struct nfs4_deviceid *);
	261	struct nfs4_deviceid_node nfs4_insert_deviceid_node(struct nfs4_deviceid_node );
	262	bool nfs4_put_deviceid_node(struct nfs4_deviceid_node *);
1dfed273 TM	263	void nfs4_mark_deviceid_unavailable(struct nfs4_deviceid_node *node);
1dfed273 TM	264	bool nfs4_test_deviceid_unavailable(struct nfs4_deviceid_node *node);
1775bc34	265	void nfs4_deviceid_purge_client(const struct nfs_client *);
a1eaecbc	266
d684d2ae	267	static inline struct pnfs_layout_segment *
9369a431	268	pnfs_get_lseg(struct pnfs_layout_segment *lseg)
d684d2ae FI	269	{
	270	if (lseg) {
	271	atomic_inc(&lseg->pls_refcount);
4e857c58	272	smp_mb__after_atomic();
d684d2ae FI	273	}
	274	return lseg;
	275	}
	276
e5e94017 BH	277	/* Return true if a layout driver is being used for this mountpoint */
	278	static inline int pnfs_enabled_sb(struct nfs_server *nfss)
	279	{
	280	return nfss->pnfs_curr_ld != NULL;
	281	}
85e174ba	282
a861a1e1	283	static inline int
ea2cf228 FI	284	pnfs_commit_list(struct inode inode, struct list_head mds_pages, int how,
ea2cf228 FI	285	struct nfs_commit_info *cinfo)
a861a1e1	286	{
ea2cf228	287	if (cinfo->ds == NULL \|\| cinfo->ds->ncommitting == 0)
a861a1e1	288	return PNFS_NOT_ATTEMPTED;
ea2cf228 FI	289	return NFS_SERVER(inode)->pnfs_curr_ld->commit_pagelist(inode, mds_pages, how, cinfo);
	290	}
	291
	292	static inline struct pnfs_ds_commit_info *
	293	pnfs_get_ds_info(struct inode *inode)
	294	{
	295	struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
	296
	297	if (ld == NULL \|\| ld->get_ds_info == NULL)
	298	return NULL;
	299	return ld->get_ds_info(inode);
a861a1e1 FI	300	}
a861a1e1 FI	301
8dd37758	302	static inline bool
ea2cf228 FI	303	pnfs_mark_request_commit(struct nfs_page req, struct pnfs_layout_segment lseg,
ea2cf228 FI	304	struct nfs_commit_info *cinfo)
a861a1e1	305	{
d6d6dc7c	306	struct inode *inode = req->wb_context->dentry->d_inode;
8dd37758	307	struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
a861a1e1	308
8dd37758 TM	309	if (lseg == NULL \|\| ld->mark_request_commit == NULL)
8dd37758 TM	310	return false;
ea2cf228	311	ld->mark_request_commit(req, lseg, cinfo);
8dd37758	312	return true;
a861a1e1 FI	313	}
a861a1e1 FI	314
8dd37758	315	static inline bool
ea2cf228	316	pnfs_clear_request_commit(struct nfs_page req, struct nfs_commit_info cinfo)
a861a1e1	317	{
d6d6dc7c	318	struct inode *inode = req->wb_context->dentry->d_inode;
8dd37758	319	struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
d6d6dc7c	320
8dd37758 TM	321	if (ld == NULL \|\| ld->clear_request_commit == NULL)
8dd37758 TM	322	return false;
ea2cf228	323	ld->clear_request_commit(req, cinfo);
8dd37758	324	return true;
d6d6dc7c FI	325	}
	326
	327	static inline int
ea2cf228 FI	328	pnfs_scan_commit_lists(struct inode inode, struct nfs_commit_info cinfo,
ea2cf228 FI	329	int max)
d6d6dc7c	330	{
ea2cf228	331	if (cinfo->ds == NULL \|\| cinfo->ds->nwritten == 0)
d6d6dc7c	332	return 0;
ea2cf228 FI	333	else
ea2cf228 FI	334	return NFS_SERVER(inode)->pnfs_curr_ld->scan_commit_lists(cinfo, max);
a861a1e1 FI	335	}
a861a1e1 FI	336
1763da12 FI	337	static inline void
	338	pnfs_recover_commit_reqs(struct inode inode, struct list_head list,
	339	struct nfs_commit_info *cinfo)
	340	{
	341	if (cinfo->ds == NULL \|\| cinfo->ds->nwritten == 0)
	342	return;
	343	NFS_SERVER(inode)->pnfs_curr_ld->recover_commit_reqs(list, cinfo);
	344	}
	345
02d1426c WAA	346	static inline struct nfs_page *
	347	pnfs_search_commit_reqs(struct inode inode, struct nfs_commit_info cinfo,
	348	struct page *page)
	349	{
	350	struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
	351
	352	if (ld == NULL \|\| ld->search_commit_reqs == NULL)
	353	return NULL;
	354	return ld->search_commit_reqs(cinfo, page);
	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
d8c951c3 TM	367	static inline bool
	368	pnfs_layoutcommit_outstanding(struct inode *inode)
	369	{
	370	struct nfs_inode *nfsi = NFS_I(inode);
	371
	372	return test_bit(NFS_INO_LAYOUTCOMMIT, &nfsi->flags) != 0 \|\|
	373	test_bit(NFS_INO_LAYOUTCOMMITTING, &nfsi->flags) != 0;
	374	}
	375
cbe82603 BH	376	static inline int pnfs_return_layout(struct inode *ino)
	377	{
	378	struct nfs_inode *nfsi = NFS_I(ino);
	379	struct nfs_server *nfss = NFS_SERVER(ino);
	380
	381	if (pnfs_enabled_sb(nfss) && nfsi->layout)
	382	return _pnfs_return_layout(ino);
	383
	384	return 0;
	385	}
	386
82be417a AA	387	static inline bool
	388	pnfs_use_threshold(struct nfs4_threshold *dst, struct nfs4_threshold src,
	389	struct nfs_server *nfss)
	390	{
fb47ddc9	391	return (dst && src && src->bm != 0 && nfss->pnfs_curr_ld &&
82be417a AA	392	nfss->pnfs_curr_ld->id == src->l_type);
	393	}
	394
6f00866d TM	395	#ifdef NFS_DEBUG
	396	void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id);
	397	#else
	398	static inline void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id)
	399	{
	400	}
	401	#endif /* NFS_DEBUG */
85e174ba RL	402	#else /* CONFIG_NFS_V4_1 */
85e174ba RL	403
974cec8c AA	404	static inline void pnfs_destroy_all_layouts(struct nfs_client *clp)
	405	{
	406	}
	407
e5e94017 BH	408	static inline void pnfs_destroy_layout(struct nfs_inode *nfsi)
	409	{
	410	}
	411
d684d2ae	412	static inline struct pnfs_layout_segment *
9369a431	413	pnfs_get_lseg(struct pnfs_layout_segment *lseg)
d684d2ae FI	414	{
	415	return NULL;
	416	}
	417
9369a431	418	static inline void pnfs_put_lseg(struct pnfs_layout_segment *lseg)
d684d2ae FI	419	{
	420	}
	421
cbe82603 BH	422	static inline int pnfs_return_layout(struct inode *ino)
	423	{
	424	return 0;
	425	}
	426
24028672 TM	427	static inline int pnfs_commit_and_return_layout(struct inode *inode)
	428	{
	429	return 0;
	430	}
	431
8a1636c4 BH	432	static inline bool
	433	pnfs_ld_layoutret_on_setattr(struct inode *inode)
	434	{
	435	return false;
	436	}
	437
f7e8917a FI	438	static inline bool
	439	pnfs_roc(struct inode *ino)
	440	{
	441	return false;
	442	}
	443
	444	static inline void
	445	pnfs_roc_release(struct inode *ino)
	446	{
	447	}
	448
	449	static inline void
	450	pnfs_roc_set_barrier(struct inode *ino, u32 barrier)
	451	{
	452	}
	453
	454	static inline bool
7fdab069	455	pnfs_roc_drain(struct inode ino, u32 barrier, struct rpc_task *task)
f7e8917a FI	456	{
	457	return false;
	458	}
	459
738fd0f3	460	static inline void set_pnfs_layoutdriver(struct nfs_server *s,
a00ed25c	461	const struct nfs_fh *mntfh, u32 id)
85e174ba RL	462	{
	463	}
	464
	465	static inline void unset_pnfs_layoutdriver(struct nfs_server *s)
	466	{
	467	}
	468
a861a1e1	469	static inline int
ea2cf228 FI	470	pnfs_commit_list(struct inode inode, struct list_head mds_pages, int how,
ea2cf228 FI	471	struct nfs_commit_info *cinfo)
a861a1e1 FI	472	{
	473	return PNFS_NOT_ATTEMPTED;
	474	}
	475
ea2cf228 FI	476	static inline struct pnfs_ds_commit_info *
	477	pnfs_get_ds_info(struct inode *inode)
	478	{
	479	return NULL;
	480	}
	481
8dd37758	482	static inline bool
ea2cf228 FI	483	pnfs_mark_request_commit(struct nfs_page req, struct pnfs_layout_segment lseg,
ea2cf228 FI	484	struct nfs_commit_info *cinfo)
a861a1e1	485	{
8dd37758	486	return false;
a861a1e1 FI	487	}
a861a1e1 FI	488
8dd37758	489	static inline bool
ea2cf228	490	pnfs_clear_request_commit(struct nfs_page req, struct nfs_commit_info cinfo)
a861a1e1	491	{
8dd37758	492	return false;
d6d6dc7c FI	493	}
	494
	495	static inline int
ea2cf228 FI	496	pnfs_scan_commit_lists(struct inode inode, struct nfs_commit_info cinfo,
ea2cf228 FI	497	int max)
d6d6dc7c FI	498	{
d6d6dc7c FI	499	return 0;
a861a1e1 FI	500	}
a861a1e1 FI	501
1763da12 FI	502	static inline void
	503	pnfs_recover_commit_reqs(struct inode inode, struct list_head list,
	504	struct nfs_commit_info *cinfo)
	505	{
	506	}
	507
02d1426c WAA	508	static inline struct nfs_page *
	509	pnfs_search_commit_reqs(struct inode inode, struct nfs_commit_info cinfo,
	510	struct page *page)
	511	{
	512	return NULL;
	513	}
	514
ef311537	515	static inline int pnfs_layoutcommit_inode(struct inode *inode, bool sync)
863a3c6c AA	516	{
	517	return 0;
	518	}
1775bc34	519
82be417a AA	520	static inline bool
	521	pnfs_use_threshold(struct nfs4_threshold *dst, struct nfs4_threshold src,
	522	struct nfs_server *nfss)
	523	{
	524	return false;
	525	}
	526
d8c951c3 TM	527	static inline bool
	528	pnfs_layoutcommit_outstanding(struct inode *inode)
	529	{
	530	return false;
	531	}
	532
	533
82be417a AA	534	static inline struct nfs4_threshold *pnfs_mdsthreshold_alloc(void)
	535	{
	536	return NULL;
	537	}
	538
85e174ba RL	539	#endif /* CONFIG_NFS_V4_1 */
	540
	541	#endif /* FS_NFS_PNFS_H */