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

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;

	void (*mark_request_commit) (struct nfs_page *req,
					struct pnfs_layout_segment *lseg);
	void (*clear_request_commit) (struct nfs_page *req);
	int (*scan_commit_lists) (struct inode *inode, int max, spinlock_t *lock);
	int (*commit_pagelist)(struct inode *inode, struct list_head *mds_pages, int how);

	/*
	 * Return PNFS_ATTEMPTED to indicate the layout code has attempted
	 * I/O, else return PNFS_NOT_ATTEMPTED to fall back to normal NFS
	 */
	enum pnfs_try_status (*read_pagelist) (struct nfs_read_data *nfs_data);
	enum pnfs_try_status (*write_pagelist) (struct nfs_write_data *nfs_data, int how);

	void (*free_deviceid_node) (struct nfs4_deviceid_node *);

	void (*encode_layoutreturn) (struct pnfs_layout_hdr *layoutid,
				     struct xdr_stream *xdr,
				     const struct nfs4_layoutreturn_args *args);

	void (*cleanup_layoutcommit) (struct nfs4_layoutcommit_data *data);

	void (*encode_layoutcommit) (struct pnfs_layout_hdr *layoutid,
				     struct xdr_stream *xdr,
				     const struct nfs4_layoutcommit_args *args);
};

struct pnfs_layout_hdr {
	atomic_t		plh_refcount;
	struct list_head	plh_layouts;   /* other client layouts */
	struct list_head	plh_bulk_recall; /* clnt list of bulk recalls */
	struct list_head	plh_segs;      /* layout segments list */
	nfs4_stateid		plh_stateid;
	atomic_t		plh_outstanding; /* number of RPCs out */
	unsigned long		plh_block_lgets; /* block LAYOUTGET if >0 */
	u32			plh_barrier; /* ignore lower seqids */
	unsigned long		plh_flags;
	loff_t			plh_lwb; /* last write byte for layoutcommit */
	struct rpc_cred		*plh_lc_cred; /* layoutcommit cred */
	struct inode		*plh_inode;
};

struct pnfs_device {
	struct nfs4_deviceid dev_id;
	unsigned int  layout_type;
	unsigned int  mincount;
	struct page **pages;
	unsigned int  pgbase;
	unsigned int  pglen;
};

#define NFS4_PNFS_GETDEVLIST_MAXNUM 16

struct pnfs_devicelist {
	unsigned int		eof;
	unsigned int		num_devs;
	struct nfs4_deviceid	dev_id[NFS4_PNFS_GETDEVLIST_MAXNUM];
};

extern int pnfs_register_layoutdriver(struct pnfs_layoutdriver_type *);
extern void pnfs_unregister_layoutdriver(struct pnfs_layoutdriver_type *);

/* nfs4proc.c */
extern int nfs4_proc_getdevicelist(struct nfs_server *server,
				   const struct nfs_fh *fh,
				   struct pnfs_devicelist *devlist);
extern int nfs4_proc_getdeviceinfo(struct nfs_server *server,
				   struct pnfs_device *dev);
extern int nfs4_proc_layoutget(struct nfs4_layoutget *lgp);
extern int nfs4_proc_layoutreturn(struct nfs4_layoutreturn *lrp);

/* pnfs.c */
void get_layout_hdr(struct pnfs_layout_hdr *lo);
void put_lseg(struct pnfs_layout_segment *lseg);

bool pnfs_pageio_init_read(struct nfs_pageio_descriptor *, struct inode *,
			   const struct nfs_pgio_completion_ops *);
bool pnfs_pageio_init_write(struct nfs_pageio_descriptor *, struct inode *,
			    int, const struct nfs_pgio_completion_ops *);

void set_pnfs_layoutdriver(struct nfs_server *, const struct nfs_fh *, u32);
void unset_pnfs_layoutdriver(struct nfs_server *);
void pnfs_generic_pg_init_read(struct nfs_pageio_descriptor *, struct nfs_page *);
int pnfs_generic_pg_readpages(struct nfs_pageio_descriptor *desc);
void pnfs_generic_pg_init_write(struct nfs_pageio_descriptor *, struct nfs_page *);
int pnfs_generic_pg_writepages(struct nfs_pageio_descriptor *desc);
bool pnfs_generic_pg_test(struct nfs_pageio_descriptor *pgio, struct nfs_page *prev, struct nfs_page *req);
void pnfs_set_lo_fail(struct pnfs_layout_segment *lseg);
int pnfs_layout_process(struct nfs4_layoutget *lgp);
void pnfs_free_lseg_list(struct list_head *tmp_list);
void pnfs_destroy_layout(struct nfs_inode *);
void pnfs_destroy_all_layouts(struct nfs_client *);
void put_layout_hdr(struct pnfs_layout_hdr *lo);
void pnfs_set_layout_stateid(struct pnfs_layout_hdr *lo,
			     const nfs4_stateid *new,
			     bool update_barrier);
int pnfs_choose_layoutget_stateid(nfs4_stateid *dst,
				  struct pnfs_layout_hdr *lo,
				  struct nfs4_state *open_state);
int mark_matching_lsegs_invalid(struct pnfs_layout_hdr *lo,
				struct list_head *tmp_list,
				struct pnfs_layout_range *recall_range);
bool pnfs_roc(struct inode *ino);
void pnfs_roc_release(struct inode *ino);
void pnfs_roc_set_barrier(struct inode *ino, u32 barrier);
bool pnfs_roc_drain(struct inode *ino, u32 *barrier);
void pnfs_set_layoutcommit(struct nfs_write_data *wdata);
void pnfs_cleanup_layoutcommit(struct nfs4_layoutcommit_data *data);
int pnfs_layoutcommit_inode(struct inode *inode, bool sync);
int _pnfs_return_layout(struct inode *);
void pnfs_ld_write_done(struct nfs_write_data *);
void pnfs_ld_read_done(struct nfs_read_data *);
struct pnfs_layout_segment *pnfs_update_layout(struct inode *ino,
					       struct nfs_open_context *ctx,
					       loff_t pos,
					       u64 count,
					       enum pnfs_iomode iomode,
					       gfp_t gfp_flags);

void nfs4_deviceid_mark_client_invalid(struct nfs_client *clp);

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

/* pnfs_dev.c */
struct nfs4_deviceid_node {
	struct hlist_node		node;
	struct hlist_node		tmpnode;
	const struct pnfs_layoutdriver_type *ld;
	const struct nfs_client		*nfs_client;
	unsigned long 			flags;
	struct nfs4_deviceid		deviceid;
	atomic_t			ref;
};

struct nfs4_deviceid_node *nfs4_find_get_deviceid(const struct pnfs_layoutdriver_type *, const struct nfs_client *, const struct nfs4_deviceid *);
void nfs4_delete_deviceid(const struct pnfs_layoutdriver_type *, const struct nfs_client *, const struct nfs4_deviceid *);
void nfs4_init_deviceid_node(struct nfs4_deviceid_node *,
			     const struct pnfs_layoutdriver_type *,
			     const struct nfs_client *,
			     const struct nfs4_deviceid *);
struct nfs4_deviceid_node *nfs4_insert_deviceid_node(struct nfs4_deviceid_node *);
bool nfs4_put_deviceid_node(struct nfs4_deviceid_node *);
void nfs4_deviceid_purge_client(const struct nfs_client *);

static inline int lo_fail_bit(u32 iomode)
{
	return iomode == IOMODE_RW ?
			 NFS_LAYOUT_RW_FAILED : NFS_LAYOUT_RO_FAILED;
}

static inline struct pnfs_layout_segment *
get_lseg(struct pnfs_layout_segment *lseg)
{
	if (lseg) {
		atomic_inc(&lseg->pls_refcount);
		smp_mb__after_atomic_inc();
	}
	return lseg;
}

/* Return true if a layout driver is being used for this mountpoint */
static inline int pnfs_enabled_sb(struct nfs_server *nfss)
{
	return nfss->pnfs_curr_ld != NULL;
}

static inline int
pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how)
{
	if (!test_and_clear_bit(NFS_INO_PNFS_COMMIT, &NFS_I(inode)->flags))
		return PNFS_NOT_ATTEMPTED;
	return NFS_SERVER(inode)->pnfs_curr_ld->commit_pagelist(inode, mds_pages, how);
}

static inline bool
pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg)
{
	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);
	return true;
}

static inline bool
pnfs_clear_request_commit(struct nfs_page *req)
{
	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);
	return true;
}

static inline int
pnfs_scan_commit_lists(struct inode *inode, int max, spinlock_t *lock)
{
	struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
	int ret;

	if (ld == NULL || ld->scan_commit_lists == NULL)
		return 0;
	ret = ld->scan_commit_lists(inode, max, lock);
	if (ret != 0)
		set_bit(NFS_INO_PNFS_COMMIT, &NFS_I(inode)->flags);
	return ret;
}

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

#ifdef NFS_DEBUG
void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id);
#else
static inline void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id)
{
}
#endif /* NFS_DEBUG */
#else  /* CONFIG_NFS_V4_1 */

static inline void pnfs_destroy_all_layouts(struct nfs_client *clp)
{
}

static inline void pnfs_destroy_layout(struct nfs_inode *nfsi)
{
}

static inline struct pnfs_layout_segment *
get_lseg(struct pnfs_layout_segment *lseg)
{
	return NULL;
}

static inline void put_lseg(struct pnfs_layout_segment *lseg)
{
}

static inline int pnfs_return_layout(struct inode *ino)
{
	return 0;
}

static inline bool
pnfs_ld_layoutret_on_setattr(struct inode *inode)
{
	return false;
}

static inline bool
pnfs_roc(struct inode *ino)
{
	return false;
}

static inline void
pnfs_roc_release(struct inode *ino)
{
}

static inline void
pnfs_roc_set_barrier(struct inode *ino, u32 barrier)
{
}

static inline bool
pnfs_roc_drain(struct inode *ino, u32 *barrier)
{
	return false;
}

static inline void set_pnfs_layoutdriver(struct nfs_server *s,
					 const struct nfs_fh *mntfh, u32 id)
{
}

static inline void unset_pnfs_layoutdriver(struct nfs_server *s)
{
}

static inline bool pnfs_pageio_init_read(struct nfs_pageio_descriptor *pgio, struct inode *inode)
{
	return false;
}

static inline bool pnfs_pageio_init_write(struct nfs_pageio_descriptor *pgio, struct inode *inode, int ioflags)
{
	return false;
}

static inline int
pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how)
{
	return PNFS_NOT_ATTEMPTED;
}

static inline bool
pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg)
{
	return false;
}

static inline bool
pnfs_clear_request_commit(struct nfs_page *req)
{
	return false;
}

static inline int
pnfs_scan_commit_lists(struct inode *inode, int max, spinlock_t *lock)
{
	return 0;
}

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

#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 */
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
8dd37758	97	void (mark_request_commit) (struct nfs_page req,
d6d6dc7c	98	struct pnfs_layout_segment *lseg);
8dd37758	99	void (clear_request_commit) (struct nfs_page req);
3b3be88d	100	int (scan_commit_lists) (struct inode inode, int max, spinlock_t *lock);
a861a1e1 FI	101	int (commit_pagelist)(struct inode inode, struct list_head *mds_pages, int how);
a861a1e1 FI	102
64419a9b AA	103	/*
	104	* Return PNFS_ATTEMPTED to indicate the layout code has attempted
	105	* I/O, else return PNFS_NOT_ATTEMPTED to fall back to normal NFS
	106	*/
	107	enum pnfs_try_status (read_pagelist) (struct nfs_read_data nfs_data);
0382b744	108	enum pnfs_try_status (write_pagelist) (struct nfs_write_data nfs_data, int how);
1775bc34 BH	109
1775bc34 BH	110	void (free_deviceid_node) (struct nfs4_deviceid_node );
04a55549 AA	111
	112	void (encode_layoutreturn) (struct pnfs_layout_hdr layoutid,
	113	struct xdr_stream *xdr,
	114	const struct nfs4_layoutreturn_args *args);
ac7db726	115
db29c089 AA	116	void (cleanup_layoutcommit) (struct nfs4_layoutcommit_data data);
db29c089 AA	117
ac7db726 BH	118	void (encode_layoutcommit) (struct pnfs_layout_hdr layoutid,
	119	struct xdr_stream *xdr,
	120	const struct nfs4_layoutcommit_args *args);
85e174ba RL	121	};
85e174ba RL	122
e5e94017	123	struct pnfs_layout_hdr {
cc6e5340	124	atomic_t plh_refcount;
b7edfaa1	125	struct list_head plh_layouts; /* other client layouts */
43f1b3da	126	struct list_head plh_bulk_recall; /* clnt list of bulk recalls */
b7edfaa1	127	struct list_head plh_segs; /* layout segments list */
b7edfaa1	128	nfs4_stateid plh_stateid;
cf7d63f1	129	atomic_t plh_outstanding; /* number of RPCs out */
f7e8917a	130	unsigned long plh_block_lgets; /* block LAYOUTGET if >0 */
43f1b3da	131	u32 plh_barrier; /* ignore lower seqids */
566052c5	132	unsigned long plh_flags;
acff5880	133	loff_t plh_lwb; /* last write byte for layoutcommit */
9fa40758	134	struct rpc_cred plh_lc_cred; / layoutcommit cred */
b7edfaa1	135	struct inode *plh_inode;
e5e94017 BH	136	};
e5e94017 BH	137
b1f69b75 AA	138	struct pnfs_device {
	139	struct nfs4_deviceid dev_id;
	140	unsigned int layout_type;
	141	unsigned int mincount;
	142	struct page **pages;
b1f69b75 AA	143	unsigned int pgbase;
	144	unsigned int pglen;
	145	};
	146
7f11d8d3 AA	147	#define NFS4_PNFS_GETDEVLIST_MAXNUM 16
	148
	149	struct pnfs_devicelist {
	150	unsigned int eof;
	151	unsigned int num_devs;
	152	struct nfs4_deviceid dev_id[NFS4_PNFS_GETDEVLIST_MAXNUM];
	153	};
	154
02c35fca FI	155	extern int pnfs_register_layoutdriver(struct pnfs_layoutdriver_type *);
	156	extern void pnfs_unregister_layoutdriver(struct pnfs_layoutdriver_type *);
	157
b1f69b75	158	/* nfs4proc.c */
7f11d8d3 AA	159	extern int nfs4_proc_getdevicelist(struct nfs_server *server,
	160	const struct nfs_fh *fh,
	161	struct pnfs_devicelist *devlist);
b1f69b75 AA	162	extern int nfs4_proc_getdeviceinfo(struct nfs_server *server,
	163	struct pnfs_device *dev);
	164	extern int nfs4_proc_layoutget(struct nfs4_layoutget *lgp);
cbe82603	165	extern int nfs4_proc_layoutreturn(struct nfs4_layoutreturn *lrp);
b1f69b75 AA	166
b1f69b75 AA	167	/* pnfs.c */
43f1b3da	168	void get_layout_hdr(struct pnfs_layout_hdr *lo);
bae724ef	169	void put_lseg(struct pnfs_layout_segment *lseg);
1751c363	170
061ae2ed FI	171	bool pnfs_pageio_init_read(struct nfs_pageio_descriptor , struct inode ,
	172	const struct nfs_pgio_completion_ops *);
	173	bool pnfs_pageio_init_write(struct nfs_pageio_descriptor , struct inode ,
	174	int, const struct nfs_pgio_completion_ops *);
1751c363	175
738fd0f3	176	void set_pnfs_layoutdriver(struct nfs_server , const struct nfs_fh , u32);
85e174ba	177	void unset_pnfs_layoutdriver(struct nfs_server *);
d8007d4d	178	void pnfs_generic_pg_init_read(struct nfs_pageio_descriptor , struct nfs_page );
493292dd	179	int pnfs_generic_pg_readpages(struct nfs_pageio_descriptor *desc);
d8007d4d	180	void pnfs_generic_pg_init_write(struct nfs_pageio_descriptor , struct nfs_page );
dce81290	181	int pnfs_generic_pg_writepages(struct nfs_pageio_descriptor *desc);
18ad0a9f	182	bool pnfs_generic_pg_test(struct nfs_pageio_descriptor pgio, struct nfs_page prev, struct nfs_page *req);
1b0ae068	183	void pnfs_set_lo_fail(struct pnfs_layout_segment *lseg);
b1f69b75	184	int pnfs_layout_process(struct nfs4_layoutget *lgp);
43f1b3da	185	void pnfs_free_lseg_list(struct list_head *tmp_list);
e5e94017	186	void pnfs_destroy_layout(struct nfs_inode *);
974cec8c	187	void pnfs_destroy_all_layouts(struct nfs_client *);
cc6e5340	188	void put_layout_hdr(struct pnfs_layout_hdr *lo);
43f1b3da FI	189	void pnfs_set_layout_stateid(struct pnfs_layout_hdr *lo,
	190	const nfs4_stateid *new,
	191	bool update_barrier);
fd6002e9 FI	192	int pnfs_choose_layoutget_stateid(nfs4_stateid *dst,
	193	struct pnfs_layout_hdr *lo,
	194	struct nfs4_state *open_state);
43f1b3da FI	195	int mark_matching_lsegs_invalid(struct pnfs_layout_hdr *lo,
43f1b3da FI	196	struct list_head *tmp_list,
778b5502	197	struct pnfs_layout_range *recall_range);
f7e8917a FI	198	bool pnfs_roc(struct inode *ino);
	199	void pnfs_roc_release(struct inode *ino);
	200	void pnfs_roc_set_barrier(struct inode *ino, u32 barrier);
	201	bool pnfs_roc_drain(struct inode ino, u32 barrier);
863a3c6c	202	void pnfs_set_layoutcommit(struct nfs_write_data *wdata);
db29c089	203	void pnfs_cleanup_layoutcommit(struct nfs4_layoutcommit_data *data);
ef311537	204	int pnfs_layoutcommit_inode(struct inode *inode, bool sync);
cbe82603	205	int _pnfs_return_layout(struct inode *);
8ce160c5	206	void pnfs_ld_write_done(struct nfs_write_data *);
9b7eecdc	207	void pnfs_ld_read_done(struct nfs_read_data *);
7c24d948 AA	208	struct pnfs_layout_segment pnfs_update_layout(struct inode ino,
	209	struct nfs_open_context *ctx,
	210	loff_t pos,
	211	u64 count,
	212	enum pnfs_iomode iomode,
	213	gfp_t gfp_flags);
e5e94017	214
c47abcf8 AA	215	void nfs4_deviceid_mark_client_invalid(struct nfs_client *clp);
	216
	217	/* nfs4_deviceid_flags */
	218	enum {
	219	NFS_DEVICEID_INVALID = 0, /* set when MDS clientid recalled */
	220	};
	221
a1eaecbc BH	222	/* pnfs_dev.c */
	223	struct nfs4_deviceid_node {
	224	struct hlist_node node;
9e3bd4e2	225	struct hlist_node tmpnode;
1775bc34	226	const struct pnfs_layoutdriver_type *ld;
a1eaecbc	227	const struct nfs_client *nfs_client;
c47abcf8	228	unsigned long flags;
a1eaecbc BH	229	struct nfs4_deviceid deviceid;
	230	atomic_t ref;
	231	};
	232
35c8bb54	233	struct nfs4_deviceid_node nfs4_find_get_deviceid(const struct pnfs_layoutdriver_type , const struct nfs_client , const struct nfs4_deviceid );
35c8bb54	234	void nfs4_delete_deviceid(const struct pnfs_layoutdriver_type , const struct nfs_client , const struct nfs4_deviceid *);
a1eaecbc	235	void nfs4_init_deviceid_node(struct nfs4_deviceid_node *,
1775bc34	236	const struct pnfs_layoutdriver_type *,
a1eaecbc BH	237	const struct nfs_client *,
	238	const struct nfs4_deviceid *);
	239	struct nfs4_deviceid_node nfs4_insert_deviceid_node(struct nfs4_deviceid_node );
	240	bool nfs4_put_deviceid_node(struct nfs4_deviceid_node *);
1775bc34	241	void nfs4_deviceid_purge_client(const struct nfs_client *);
a1eaecbc	242
e5e94017 BH	243	static inline int lo_fail_bit(u32 iomode)
	244	{
	245	return iomode == IOMODE_RW ?
	246	NFS_LAYOUT_RW_FAILED : NFS_LAYOUT_RO_FAILED;
	247	}
	248
d684d2ae FI	249	static inline struct pnfs_layout_segment *
	250	get_lseg(struct pnfs_layout_segment *lseg)
	251	{
	252	if (lseg) {
	253	atomic_inc(&lseg->pls_refcount);
	254	smp_mb__after_atomic_inc();
	255	}
	256	return lseg;
	257	}
	258
e5e94017 BH	259	/* Return true if a layout driver is being used for this mountpoint */
	260	static inline int pnfs_enabled_sb(struct nfs_server *nfss)
	261	{
	262	return nfss->pnfs_curr_ld != NULL;
	263	}
85e174ba	264
a861a1e1 FI	265	static inline int
	266	pnfs_commit_list(struct inode inode, struct list_head mds_pages, int how)
	267	{
	268	if (!test_and_clear_bit(NFS_INO_PNFS_COMMIT, &NFS_I(inode)->flags))
	269	return PNFS_NOT_ATTEMPTED;
	270	return NFS_SERVER(inode)->pnfs_curr_ld->commit_pagelist(inode, mds_pages, how);
	271	}
	272
8dd37758 TM	273	static inline bool
8dd37758 TM	274	pnfs_mark_request_commit(struct nfs_page req, struct pnfs_layout_segment lseg)
a861a1e1	275	{
d6d6dc7c	276	struct inode *inode = req->wb_context->dentry->d_inode;
8dd37758	277	struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
a861a1e1	278
8dd37758 TM	279	if (lseg == NULL \|\| ld->mark_request_commit == NULL)
	280	return false;
	281	ld->mark_request_commit(req, lseg);
	282	return true;
a861a1e1 FI	283	}
a861a1e1 FI	284
8dd37758	285	static inline bool
d6d6dc7c	286	pnfs_clear_request_commit(struct nfs_page *req)
a861a1e1	287	{
d6d6dc7c	288	struct inode *inode = req->wb_context->dentry->d_inode;
8dd37758	289	struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
d6d6dc7c	290
8dd37758 TM	291	if (ld == NULL \|\| ld->clear_request_commit == NULL)
	292	return false;
	293	ld->clear_request_commit(req);
	294	return true;
d6d6dc7c FI	295	}
	296
	297	static inline int
3b3be88d	298	pnfs_scan_commit_lists(struct inode inode, int max, spinlock_t lock)
d6d6dc7c	299	{
8dd37758 TM	300	struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
	301	int ret;
	302
	303	if (ld == NULL \|\| ld->scan_commit_lists == NULL)
d6d6dc7c	304	return 0;
3b3be88d	305	ret = ld->scan_commit_lists(inode, max, lock);
8dd37758 TM	306	if (ret != 0)
	307	set_bit(NFS_INO_PNFS_COMMIT, &NFS_I(inode)->flags);
	308	return ret;
a861a1e1 FI	309	}
a861a1e1 FI	310
8a1636c4 BH	311	/* Should the pNFS client commit and return the layout upon a setattr */
	312	static inline bool
	313	pnfs_ld_layoutret_on_setattr(struct inode *inode)
	314	{
	315	if (!pnfs_enabled_sb(NFS_SERVER(inode)))
	316	return false;
	317	return NFS_SERVER(inode)->pnfs_curr_ld->flags &
	318	PNFS_LAYOUTRET_ON_SETATTR;
	319	}
	320
cbe82603 BH	321	static inline int pnfs_return_layout(struct inode *ino)
	322	{
	323	struct nfs_inode *nfsi = NFS_I(ino);
	324	struct nfs_server *nfss = NFS_SERVER(ino);
	325
	326	if (pnfs_enabled_sb(nfss) && nfsi->layout)
	327	return _pnfs_return_layout(ino);
	328
	329	return 0;
	330	}
	331
6f00866d TM	332	#ifdef NFS_DEBUG
	333	void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id);
	334	#else
	335	static inline void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id)
	336	{
	337	}
	338	#endif /* NFS_DEBUG */
85e174ba RL	339	#else /* CONFIG_NFS_V4_1 */
85e174ba RL	340
974cec8c AA	341	static inline void pnfs_destroy_all_layouts(struct nfs_client *clp)
	342	{
	343	}
	344
e5e94017 BH	345	static inline void pnfs_destroy_layout(struct nfs_inode *nfsi)
	346	{
	347	}
	348
d684d2ae FI	349	static inline struct pnfs_layout_segment *
	350	get_lseg(struct pnfs_layout_segment *lseg)
	351	{
	352	return NULL;
	353	}
	354
	355	static inline void put_lseg(struct pnfs_layout_segment *lseg)
	356	{
	357	}
	358
cbe82603 BH	359	static inline int pnfs_return_layout(struct inode *ino)
	360	{
	361	return 0;
	362	}
	363
8a1636c4 BH	364	static inline bool
	365	pnfs_ld_layoutret_on_setattr(struct inode *inode)
	366	{
	367	return false;
	368	}
	369
f7e8917a FI	370	static inline bool
	371	pnfs_roc(struct inode *ino)
	372	{
	373	return false;
	374	}
	375
	376	static inline void
	377	pnfs_roc_release(struct inode *ino)
	378	{
	379	}
	380
	381	static inline void
	382	pnfs_roc_set_barrier(struct inode *ino, u32 barrier)
	383	{
	384	}
	385
	386	static inline bool
	387	pnfs_roc_drain(struct inode ino, u32 barrier)
	388	{
	389	return false;
	390	}
	391
738fd0f3	392	static inline void set_pnfs_layoutdriver(struct nfs_server *s,
a00ed25c	393	const struct nfs_fh *mntfh, u32 id)
85e174ba RL	394	{
	395	}
	396
	397	static inline void unset_pnfs_layoutdriver(struct nfs_server *s)
	398	{
	399	}
	400
1751c363	401	static inline bool pnfs_pageio_init_read(struct nfs_pageio_descriptor pgio, struct inode inode)
44b83799	402	{
1751c363 TM	403	return false;
	404	}
	405
	406	static inline bool pnfs_pageio_init_write(struct nfs_pageio_descriptor pgio, struct inode inode, int ioflags)
	407	{
	408	return false;
44b83799 FI	409	}
44b83799 FI	410
a861a1e1 FI	411	static inline int
	412	pnfs_commit_list(struct inode inode, struct list_head mds_pages, int how)
	413	{
	414	return PNFS_NOT_ATTEMPTED;
	415	}
	416
8dd37758 TM	417	static inline bool
8dd37758 TM	418	pnfs_mark_request_commit(struct nfs_page req, struct pnfs_layout_segment lseg)
a861a1e1	419	{
8dd37758	420	return false;
a861a1e1 FI	421	}
a861a1e1 FI	422
8dd37758	423	static inline bool
d6d6dc7c	424	pnfs_clear_request_commit(struct nfs_page *req)
a861a1e1	425	{
8dd37758	426	return false;
d6d6dc7c FI	427	}
	428
	429	static inline int
3b3be88d	430	pnfs_scan_commit_lists(struct inode inode, int max, spinlock_t lock)
d6d6dc7c FI	431	{
d6d6dc7c FI	432	return 0;
a861a1e1 FI	433	}
a861a1e1 FI	434
ef311537	435	static inline int pnfs_layoutcommit_inode(struct inode *inode, bool sync)
863a3c6c AA	436	{
	437	return 0;
	438	}
1775bc34	439
85e174ba RL	440	#endif /* CONFIG_NFS_V4_1 */
	441
	442	#endif /* FS_NFS_PNFS_H */