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

struct pnfs_layout_segment {
	struct list_head pls_list;
	struct pnfs_layout_range pls_range;
	atomic_t pls_refcount;
	unsigned long pls_flags;
	struct pnfs_layout_hdr *pls_layout;
	struct rpc_cred	*pls_lc_cred; /* LAYOUTCOMMIT credential */
	loff_t pls_end_pos; /* LAYOUTCOMMIT write end */
};

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,
};

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;

	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;

	/* Returns true if layoutdriver wants to divert this request to
	 * driver's commit routine.
	 */
	bool (*mark_pnfs_commit)(struct pnfs_layout_segment *lseg);
	struct list_head * (*choose_commit_list) (struct nfs_page *req);
	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 (*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;
	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;
};

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

/* nfs4proc.c */
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 *);
bool pnfs_pageio_init_write(struct nfs_pageio_descriptor *, struct inode *, int);

void set_pnfs_layoutdriver(struct nfs_server *, u32 id);
void unset_pnfs_layoutdriver(struct nfs_server *);
enum pnfs_try_status pnfs_try_to_write_data(struct nfs_write_data *,
					     const struct rpc_call_ops *, int);
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 *);
bool pnfs_generic_pg_test(struct nfs_pageio_descriptor *pgio, struct nfs_page *prev, struct nfs_page *req);
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);
int pnfs_layoutcommit_inode(struct inode *inode, bool sync);
int _pnfs_return_layout(struct inode *);
int pnfs_ld_write_done(struct nfs_write_data *);
int 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;
};

void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id);
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 void
pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg)
{
	if (lseg) {
		struct pnfs_layoutdriver_type *ld;

		ld = NFS_SERVER(req->wb_page->mapping->host)->pnfs_curr_ld;
		if (ld->mark_pnfs_commit && ld->mark_pnfs_commit(lseg)) {
			set_bit(PG_PNFS_COMMIT, &req->wb_flags);
			req->wb_commit_lseg = get_lseg(lseg);
		}
	}
}

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 struct list_head *
pnfs_choose_commit_list(struct nfs_page *req, struct list_head *mds)
{
	struct list_head *rv;

	if (test_and_clear_bit(PG_PNFS_COMMIT, &req->wb_flags)) {
		struct inode *inode = req->wb_commit_lseg->pls_layout->plh_inode;

		set_bit(NFS_INO_PNFS_COMMIT, &NFS_I(inode)->flags);
		rv = NFS_SERVER(inode)->pnfs_curr_ld->choose_commit_list(req);
		/* matched by ref taken when PG_PNFS_COMMIT is set */
		put_lseg(req->wb_commit_lseg);
	} else
		rv = mds;
	return rv;
}

static inline void pnfs_clear_request_commit(struct nfs_page *req)
{
	if (test_and_clear_bit(PG_PNFS_COMMIT, &req->wb_flags))
		put_lseg(req->wb_commit_lseg);
}

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

#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 enum pnfs_try_status
pnfs_try_to_write_data(struct nfs_write_data *data,
		       const struct rpc_call_ops *call_ops, int how)
{
	return PNFS_NOT_ATTEMPTED;
}

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, 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 void
pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg)
{
}

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

static inline struct list_head *
pnfs_choose_commit_list(struct nfs_page *req, struct list_head *mds)
{
	return mds;
}

static inline void pnfs_clear_request_commit(struct nfs_page *req)
{
}

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

static inline void nfs4_deviceid_purge_client(struct nfs_client *ncl)
{
}
#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 */
4541d16c FI	39	};
4541d16c FI	40
974cec8c	41	struct pnfs_layout_segment {
566052c5 FI	42	struct list_head pls_list;
566052c5 FI	43	struct pnfs_layout_range pls_range;
4541d16c FI	44	atomic_t pls_refcount;
4541d16c FI	45	unsigned long pls_flags;
566052c5	46	struct pnfs_layout_hdr *pls_layout;
863a3c6c AA	47	struct rpc_cred pls_lc_cred; / LAYOUTCOMMIT credential */
863a3c6c AA	48	loff_t pls_end_pos; /* LAYOUTCOMMIT write end */
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,
	71	};
	72
1775bc34 BH	73	struct nfs4_deviceid_node;
1775bc34 BH	74
85e174ba RL	75	/* Per-layout driver specific registration structure */
85e174ba RL	76	struct pnfs_layoutdriver_type {
02c35fca FI	77	struct list_head pnfs_tblid;
	78	const u32 id;
	79	const char *name;
	80	struct module *owner;
8a1636c4	81	unsigned flags;
636fb9c8 BH	82
	83	struct pnfs_layout_hdr * (alloc_layout_hdr) (struct inode inode, gfp_t gfp_flags);
	84	void (free_layout_hdr) (struct pnfs_layout_hdr );
	85
a75b9df9	86	struct pnfs_layout_segment * (alloc_lseg) (struct pnfs_layout_hdr layoutid, struct nfs4_layoutget_res *lgr, gfp_t gfp_flags);
b1f69b75	87	void (free_lseg) (struct pnfs_layout_segment lseg);
94ad1c80 FI	88
94ad1c80 FI	89	/* test for nfs page cache coalescing */
1751c363 TM	90	const struct nfs_pageio_ops *pg_read_ops;
1751c363 TM	91	const struct nfs_pageio_ops *pg_write_ops;
64419a9b	92
a861a1e1 FI	93	/* Returns true if layoutdriver wants to divert this request to
	94	* driver's commit routine.
	95	*/
	96	bool (mark_pnfs_commit)(struct pnfs_layout_segment lseg);
	97	struct list_head * (choose_commit_list) (struct nfs_page req);
	98	int (commit_pagelist)(struct inode inode, struct list_head *mds_pages, int how);
	99
64419a9b AA	100	/*
	101	* Return PNFS_ATTEMPTED to indicate the layout code has attempted
	102	* I/O, else return PNFS_NOT_ATTEMPTED to fall back to normal NFS
	103	*/
	104	enum pnfs_try_status (read_pagelist) (struct nfs_read_data nfs_data);
0382b744	105	enum pnfs_try_status (write_pagelist) (struct nfs_write_data nfs_data, int how);
1775bc34 BH	106
1775bc34 BH	107	void (free_deviceid_node) (struct nfs4_deviceid_node );
04a55549 AA	108
	109	void (encode_layoutreturn) (struct pnfs_layout_hdr layoutid,
	110	struct xdr_stream *xdr,
	111	const struct nfs4_layoutreturn_args *args);
ac7db726 BH	112
	113	void (encode_layoutcommit) (struct pnfs_layout_hdr layoutid,
	114	struct xdr_stream *xdr,
	115	const struct nfs4_layoutcommit_args *args);
85e174ba RL	116	};
85e174ba RL	117
e5e94017	118	struct pnfs_layout_hdr {
cc6e5340	119	atomic_t plh_refcount;
b7edfaa1	120	struct list_head plh_layouts; /* other client layouts */
43f1b3da	121	struct list_head plh_bulk_recall; /* clnt list of bulk recalls */
b7edfaa1	122	struct list_head plh_segs; /* layout segments list */
b7edfaa1	123	nfs4_stateid plh_stateid;
cf7d63f1	124	atomic_t plh_outstanding; /* number of RPCs out */
f7e8917a	125	unsigned long plh_block_lgets; /* block LAYOUTGET if >0 */
43f1b3da	126	u32 plh_barrier; /* ignore lower seqids */
566052c5	127	unsigned long plh_flags;
b7edfaa1	128	struct inode *plh_inode;
e5e94017 BH	129	};
e5e94017 BH	130
b1f69b75 AA	131	struct pnfs_device {
	132	struct nfs4_deviceid dev_id;
	133	unsigned int layout_type;
	134	unsigned int mincount;
	135	struct page **pages;
b1f69b75 AA	136	unsigned int pgbase;
	137	unsigned int pglen;
	138	};
	139
02c35fca FI	140	extern int pnfs_register_layoutdriver(struct pnfs_layoutdriver_type *);
	141	extern void pnfs_unregister_layoutdriver(struct pnfs_layoutdriver_type *);
	142
b1f69b75 AA	143	/* nfs4proc.c */
	144	extern int nfs4_proc_getdeviceinfo(struct nfs_server *server,
	145	struct pnfs_device *dev);
	146	extern int nfs4_proc_layoutget(struct nfs4_layoutget *lgp);
cbe82603	147	extern int nfs4_proc_layoutreturn(struct nfs4_layoutreturn *lrp);
b1f69b75 AA	148
b1f69b75 AA	149	/* pnfs.c */
43f1b3da	150	void get_layout_hdr(struct pnfs_layout_hdr *lo);
bae724ef	151	void put_lseg(struct pnfs_layout_segment *lseg);
1751c363 TM	152
	153	bool pnfs_pageio_init_read(struct nfs_pageio_descriptor , struct inode );
	154	bool pnfs_pageio_init_write(struct nfs_pageio_descriptor , struct inode , int);
	155
85e174ba RL	156	void set_pnfs_layoutdriver(struct nfs_server *, u32 id);
85e174ba RL	157	void unset_pnfs_layoutdriver(struct nfs_server *);
0382b744 AA	158	enum pnfs_try_status pnfs_try_to_write_data(struct nfs_write_data *,
0382b744 AA	159	const struct rpc_call_ops *, int);
d8007d4d	160	void pnfs_generic_pg_init_read(struct nfs_pageio_descriptor , struct nfs_page );
493292dd	161	int pnfs_generic_pg_readpages(struct nfs_pageio_descriptor *desc);
d8007d4d	162	void pnfs_generic_pg_init_write(struct nfs_pageio_descriptor , struct nfs_page );
18ad0a9f	163	bool pnfs_generic_pg_test(struct nfs_pageio_descriptor pgio, struct nfs_page prev, struct nfs_page *req);
b1f69b75	164	int pnfs_layout_process(struct nfs4_layoutget *lgp);
43f1b3da	165	void pnfs_free_lseg_list(struct list_head *tmp_list);
e5e94017	166	void pnfs_destroy_layout(struct nfs_inode *);
974cec8c	167	void pnfs_destroy_all_layouts(struct nfs_client *);
cc6e5340	168	void put_layout_hdr(struct pnfs_layout_hdr *lo);
43f1b3da FI	169	void pnfs_set_layout_stateid(struct pnfs_layout_hdr *lo,
	170	const nfs4_stateid *new,
	171	bool update_barrier);
fd6002e9 FI	172	int pnfs_choose_layoutget_stateid(nfs4_stateid *dst,
	173	struct pnfs_layout_hdr *lo,
	174	struct nfs4_state *open_state);
43f1b3da FI	175	int mark_matching_lsegs_invalid(struct pnfs_layout_hdr *lo,
43f1b3da FI	176	struct list_head *tmp_list,
778b5502	177	struct pnfs_layout_range *recall_range);
f7e8917a FI	178	bool pnfs_roc(struct inode *ino);
	179	void pnfs_roc_release(struct inode *ino);
	180	void pnfs_roc_set_barrier(struct inode *ino, u32 barrier);
	181	bool pnfs_roc_drain(struct inode ino, u32 barrier);
863a3c6c	182	void pnfs_set_layoutcommit(struct nfs_write_data *wdata);
ef311537	183	int pnfs_layoutcommit_inode(struct inode *inode, bool sync);
cbe82603	184	int _pnfs_return_layout(struct inode *);
d20581aa BH	185	int pnfs_ld_write_done(struct nfs_write_data *);
d20581aa BH	186	int pnfs_ld_read_done(struct nfs_read_data *);
7c24d948 AA	187	struct pnfs_layout_segment pnfs_update_layout(struct inode ino,
	188	struct nfs_open_context *ctx,
	189	loff_t pos,
	190	u64 count,
	191	enum pnfs_iomode iomode,
	192	gfp_t gfp_flags);
e5e94017	193
c47abcf8 AA	194	void nfs4_deviceid_mark_client_invalid(struct nfs_client *clp);
	195
	196	/* nfs4_deviceid_flags */
	197	enum {
	198	NFS_DEVICEID_INVALID = 0, /* set when MDS clientid recalled */
	199	};
	200
a1eaecbc BH	201	/* pnfs_dev.c */
	202	struct nfs4_deviceid_node {
	203	struct hlist_node node;
9e3bd4e2	204	struct hlist_node tmpnode;
1775bc34	205	const struct pnfs_layoutdriver_type *ld;
a1eaecbc	206	const struct nfs_client *nfs_client;
c47abcf8	207	unsigned long flags;
a1eaecbc BH	208	struct nfs4_deviceid deviceid;
	209	atomic_t ref;
	210	};
	211
	212	void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id);
35c8bb54	213	struct nfs4_deviceid_node nfs4_find_get_deviceid(const struct pnfs_layoutdriver_type , const struct nfs_client , const struct nfs4_deviceid );
35c8bb54	214	void nfs4_delete_deviceid(const struct pnfs_layoutdriver_type , const struct nfs_client , const struct nfs4_deviceid *);
a1eaecbc	215	void nfs4_init_deviceid_node(struct nfs4_deviceid_node *,
1775bc34	216	const struct pnfs_layoutdriver_type *,
a1eaecbc BH	217	const struct nfs_client *,
	218	const struct nfs4_deviceid *);
	219	struct nfs4_deviceid_node nfs4_insert_deviceid_node(struct nfs4_deviceid_node );
	220	bool nfs4_put_deviceid_node(struct nfs4_deviceid_node *);
1775bc34	221	void nfs4_deviceid_purge_client(const struct nfs_client *);
a1eaecbc	222
e5e94017 BH	223	static inline int lo_fail_bit(u32 iomode)
	224	{
	225	return iomode == IOMODE_RW ?
	226	NFS_LAYOUT_RW_FAILED : NFS_LAYOUT_RO_FAILED;
	227	}
	228
d684d2ae FI	229	static inline struct pnfs_layout_segment *
	230	get_lseg(struct pnfs_layout_segment *lseg)
	231	{
	232	if (lseg) {
	233	atomic_inc(&lseg->pls_refcount);
	234	smp_mb__after_atomic_inc();
	235	}
	236	return lseg;
	237	}
	238
e5e94017 BH	239	/* Return true if a layout driver is being used for this mountpoint */
	240	static inline int pnfs_enabled_sb(struct nfs_server *nfss)
	241	{
	242	return nfss->pnfs_curr_ld != NULL;
	243	}
85e174ba	244
a861a1e1 FI	245	static inline void
	246	pnfs_mark_request_commit(struct nfs_page req, struct pnfs_layout_segment lseg)
	247	{
	248	if (lseg) {
	249	struct pnfs_layoutdriver_type *ld;
	250
	251	ld = NFS_SERVER(req->wb_page->mapping->host)->pnfs_curr_ld;
	252	if (ld->mark_pnfs_commit && ld->mark_pnfs_commit(lseg)) {
	253	set_bit(PG_PNFS_COMMIT, &req->wb_flags);
	254	req->wb_commit_lseg = get_lseg(lseg);
	255	}
	256	}
	257	}
	258
	259	static inline int
	260	pnfs_commit_list(struct inode inode, struct list_head mds_pages, int how)
	261	{
	262	if (!test_and_clear_bit(NFS_INO_PNFS_COMMIT, &NFS_I(inode)->flags))
	263	return PNFS_NOT_ATTEMPTED;
	264	return NFS_SERVER(inode)->pnfs_curr_ld->commit_pagelist(inode, mds_pages, how);
	265	}
	266
	267	static inline struct list_head *
	268	pnfs_choose_commit_list(struct nfs_page req, struct list_head mds)
	269	{
	270	struct list_head *rv;
	271
	272	if (test_and_clear_bit(PG_PNFS_COMMIT, &req->wb_flags)) {
	273	struct inode *inode = req->wb_commit_lseg->pls_layout->plh_inode;
	274
	275	set_bit(NFS_INO_PNFS_COMMIT, &NFS_I(inode)->flags);
	276	rv = NFS_SERVER(inode)->pnfs_curr_ld->choose_commit_list(req);
	277	/* matched by ref taken when PG_PNFS_COMMIT is set */
	278	put_lseg(req->wb_commit_lseg);
	279	} else
	280	rv = mds;
	281	return rv;
	282	}
	283
	284	static inline void pnfs_clear_request_commit(struct nfs_page *req)
	285	{
	286	if (test_and_clear_bit(PG_PNFS_COMMIT, &req->wb_flags))
	287	put_lseg(req->wb_commit_lseg);
	288	}
	289
8a1636c4 BH	290	/* Should the pNFS client commit and return the layout upon a setattr */
	291	static inline bool
	292	pnfs_ld_layoutret_on_setattr(struct inode *inode)
	293	{
	294	if (!pnfs_enabled_sb(NFS_SERVER(inode)))
	295	return false;
	296	return NFS_SERVER(inode)->pnfs_curr_ld->flags &
	297	PNFS_LAYOUTRET_ON_SETATTR;
	298	}
	299
cbe82603 BH	300	static inline int pnfs_return_layout(struct inode *ino)
	301	{
	302	struct nfs_inode *nfsi = NFS_I(ino);
	303	struct nfs_server *nfss = NFS_SERVER(ino);
	304
	305	if (pnfs_enabled_sb(nfss) && nfsi->layout)
	306	return _pnfs_return_layout(ino);
	307
	308	return 0;
	309	}
	310
85e174ba RL	311	#else /* CONFIG_NFS_V4_1 */
85e174ba RL	312
974cec8c AA	313	static inline void pnfs_destroy_all_layouts(struct nfs_client *clp)
	314	{
	315	}
	316
e5e94017 BH	317	static inline void pnfs_destroy_layout(struct nfs_inode *nfsi)
	318	{
	319	}
	320
d684d2ae FI	321	static inline struct pnfs_layout_segment *
	322	get_lseg(struct pnfs_layout_segment *lseg)
	323	{
	324	return NULL;
	325	}
	326
	327	static inline void put_lseg(struct pnfs_layout_segment *lseg)
	328	{
	329	}
	330
0382b744 AA	331	static inline enum pnfs_try_status
	332	pnfs_try_to_write_data(struct nfs_write_data *data,
	333	const struct rpc_call_ops *call_ops, int how)
	334	{
	335	return PNFS_NOT_ATTEMPTED;
	336	}
	337
cbe82603 BH	338	static inline int pnfs_return_layout(struct inode *ino)
	339	{
	340	return 0;
	341	}
	342
8a1636c4 BH	343	static inline bool
	344	pnfs_ld_layoutret_on_setattr(struct inode *inode)
	345	{
	346	return false;
	347	}
	348
f7e8917a FI	349	static inline bool
	350	pnfs_roc(struct inode *ino)
	351	{
	352	return false;
	353	}
	354
	355	static inline void
	356	pnfs_roc_release(struct inode *ino)
	357	{
	358	}
	359
	360	static inline void
	361	pnfs_roc_set_barrier(struct inode *ino, u32 barrier)
	362	{
	363	}
	364
	365	static inline bool
	366	pnfs_roc_drain(struct inode ino, u32 barrier)
	367	{
	368	return false;
	369	}
	370
85e174ba RL	371	static inline void set_pnfs_layoutdriver(struct nfs_server *s, u32 id)
	372	{
	373	}
	374
	375	static inline void unset_pnfs_layoutdriver(struct nfs_server *s)
	376	{
	377	}
	378
1751c363	379	static inline bool pnfs_pageio_init_read(struct nfs_pageio_descriptor pgio, struct inode inode)
44b83799	380	{
1751c363 TM	381	return false;
	382	}
	383
	384	static inline bool pnfs_pageio_init_write(struct nfs_pageio_descriptor pgio, struct inode inode, int ioflags)
	385	{
	386	return false;
44b83799 FI	387	}
44b83799 FI	388
a861a1e1 FI	389	static inline void
	390	pnfs_mark_request_commit(struct nfs_page req, struct pnfs_layout_segment lseg)
	391	{
	392	}
	393
	394	static inline int
	395	pnfs_commit_list(struct inode inode, struct list_head mds_pages, int how)
	396	{
	397	return PNFS_NOT_ATTEMPTED;
	398	}
	399
	400	static inline struct list_head *
	401	pnfs_choose_commit_list(struct nfs_page req, struct list_head mds)
	402	{
	403	return mds;
	404	}
	405
	406	static inline void pnfs_clear_request_commit(struct nfs_page *req)
	407	{
	408	}
	409
ef311537	410	static inline int pnfs_layoutcommit_inode(struct inode *inode, bool sync)
863a3c6c AA	411	{
	412	return 0;
	413	}
1775bc34 BH	414
	415	static inline void nfs4_deviceid_purge_client(struct nfs_client *ncl)
	416	{
	417	}
85e174ba RL	418	#endif /* CONFIG_NFS_V4_1 */
	419
	420	#endif /* FS_NFS_PNFS_H */