[mirror_ubuntu-artful-kernel.git] / fs / nfs / delegation.h

/*
 * linux/fs/nfs/delegation.h
 *
 * Copyright (c) Trond Myklebust
 *
 * Definitions pertaining to NFS delegated files
 */
#ifndef FS_NFS_DELEGATION_H
#define FS_NFS_DELEGATION_H

#if IS_ENABLED(CONFIG_NFS_V4)
/*
 * NFSv4 delegation
 */
struct nfs_delegation {
	struct list_head super_list;
	struct rpc_cred *cred;
	struct inode *inode;
	nfs4_stateid stateid;
	fmode_t type;
	unsigned long pagemod_limit;
	__u64 change_attr;
	unsigned long flags;
	spinlock_t lock;
	struct rcu_head rcu;
};

enum {
	NFS_DELEGATION_NEED_RECLAIM = 0,
	NFS_DELEGATION_RETURN,
	NFS_DELEGATION_RETURN_IF_CLOSED,
	NFS_DELEGATION_REFERENCED,
	NFS_DELEGATION_RETURNING,
	NFS_DELEGATION_REVOKED,
	NFS_DELEGATION_TEST_EXPIRED,
};

int nfs_inode_set_delegation(struct inode *inode, struct rpc_cred *cred, struct nfs_openres *res);
void nfs_inode_reclaim_delegation(struct inode *inode, struct rpc_cred *cred, struct nfs_openres *res);
int nfs4_inode_return_delegation(struct inode *inode);
int nfs_async_inode_return_delegation(struct inode *inode, const nfs4_stateid *stateid);
void nfs_inode_return_delegation_noreclaim(struct inode *inode);

struct inode *nfs_delegation_find_inode(struct nfs_client *clp, const struct nfs_fh *fhandle);
void nfs_server_return_all_delegations(struct nfs_server *);
void nfs_expire_all_delegations(struct nfs_client *clp);
void nfs_expire_unused_delegation_types(struct nfs_client *clp, fmode_t flags);
void nfs_expire_unreferenced_delegations(struct nfs_client *clp);
int nfs_client_return_marked_delegations(struct nfs_client *clp);
int nfs_delegations_present(struct nfs_client *clp);
void nfs_remove_bad_delegation(struct inode *inode, const nfs4_stateid *stateid);

void nfs_delegation_mark_reclaim(struct nfs_client *clp);
void nfs_delegation_reap_unclaimed(struct nfs_client *clp);

void nfs_mark_test_expired_all_delegations(struct nfs_client *clp);
void nfs_reap_expired_delegations(struct nfs_client *clp);

/* NFSv4 delegation-related procedures */
int nfs4_proc_delegreturn(struct inode *inode, struct rpc_cred *cred, const nfs4_stateid *stateid, int issync);
int nfs4_open_delegation_recall(struct nfs_open_context *ctx, struct nfs4_state *state, const nfs4_stateid *stateid, fmode_t type);
int nfs4_lock_delegation_recall(struct file_lock *fl, struct nfs4_state *state, const nfs4_stateid *stateid);
bool nfs4_copy_delegation_stateid(struct inode *inode, fmode_t flags, nfs4_stateid *dst, struct rpc_cred **cred);

void nfs_mark_delegation_referenced(struct nfs_delegation *delegation);
int nfs4_have_delegation(struct inode *inode, fmode_t flags);
int nfs4_check_delegation(struct inode *inode, fmode_t flags);
bool nfs4_delegation_flush_on_close(const struct inode *inode);
void nfs_inode_find_delegation_state_and_recover(struct inode *inode,
		const nfs4_stateid *stateid);

#endif

static inline int nfs_have_delegated_attributes(struct inode *inode)
{
	return NFS_PROTO(inode)->have_delegation(inode, FMODE_READ) &&
		!(NFS_I(inode)->cache_validity & NFS_INO_REVAL_FORCED);
}

#endif
Commit	Line	Data
1da177e4 LT	1	/*
	2	* linux/fs/nfs/delegation.h
	3	*
	4	* Copyright (c) Trond Myklebust
	5	*
	6	* Definitions pertaining to NFS delegated files
	7	*/
	8	#ifndef FS_NFS_DELEGATION_H
	9	#define FS_NFS_DELEGATION_H
	10
89d77c8f	11	#if IS_ENABLED(CONFIG_NFS_V4)
1da177e4 LT	12	/*
	13	* NFSv4 delegation
	14	*/
	15	struct nfs_delegation {
	16	struct list_head super_list;
	17	struct rpc_cred *cred;
	18	struct inode *inode;
	19	nfs4_stateid stateid;
bd7bf9d5	20	fmode_t type;
7d160a6c	21	unsigned long pagemod_limit;
beb2a5ec	22	__u64 change_attr;
15c831bf	23	unsigned long flags;
34310430	24	spinlock_t lock;
8383e460	25	struct rcu_head rcu;
1da177e4 LT	26	};
1da177e4 LT	27
515d8611 TM	28	enum {
	29	NFS_DELEGATION_NEED_RECLAIM = 0,
	30	NFS_DELEGATION_RETURN,
b757144f	31	NFS_DELEGATION_RETURN_IF_CLOSED,
b7391f44	32	NFS_DELEGATION_REFERENCED,
d25be546	33	NFS_DELEGATION_RETURNING,
869f9dfa	34	NFS_DELEGATION_REVOKED,
45870d69	35	NFS_DELEGATION_TEST_EXPIRED,
515d8611 TM	36	};
515d8611 TM	37
1da177e4 LT	38	int nfs_inode_set_delegation(struct inode inode, struct rpc_cred cred, struct nfs_openres *res);
1da177e4 LT	39	void nfs_inode_reclaim_delegation(struct inode inode, struct rpc_cred cred, struct nfs_openres *res);
57ec14c5	40	int nfs4_inode_return_delegation(struct inode *inode);
e047a10c	41	int nfs_async_inode_return_delegation(struct inode inode, const nfs4_stateid stateid);
e6f81075	42	void nfs_inode_return_delegation_noreclaim(struct inode *inode);
1da177e4	43
adfa6f98	44	struct inode nfs_delegation_find_inode(struct nfs_client clp, const struct nfs_fh *fhandle);
eeebf916	45	void nfs_server_return_all_delegations(struct nfs_server *);
adfa6f98	46	void nfs_expire_all_delegations(struct nfs_client *clp);
826e0013	47	void nfs_expire_unused_delegation_types(struct nfs_client *clp, fmode_t flags);
b7391f44	48	void nfs_expire_unreferenced_delegations(struct nfs_client *clp);
d18cc1fd	49	int nfs_client_return_marked_delegations(struct nfs_client *clp);
d3978bb3	50	int nfs_delegations_present(struct nfs_client *clp);
41020b67	51	void nfs_remove_bad_delegation(struct inode inode, const nfs4_stateid stateid);
1da177e4	52
adfa6f98 DH	53	void nfs_delegation_mark_reclaim(struct nfs_client *clp);
adfa6f98 DH	54	void nfs_delegation_reap_unclaimed(struct nfs_client *clp);
1da177e4	55
45870d69 TM	56	void nfs_mark_test_expired_all_delegations(struct nfs_client *clp);
	57	void nfs_reap_expired_delegations(struct nfs_client *clp);
	58
1da177e4	59	/* NFSv4 delegation-related procedures */
e6f81075	60	int nfs4_proc_delegreturn(struct inode inode, struct rpc_cred cred, const nfs4_stateid *stateid, int issync);
24311f88	61	int nfs4_open_delegation_recall(struct nfs_open_context ctx, struct nfs4_state state, const nfs4_stateid *stateid, fmode_t type);
db4f2e63	62	int nfs4_lock_delegation_recall(struct file_lock fl, struct nfs4_state state, const nfs4_stateid *stateid);
abf4e13c	63	bool nfs4_copy_delegation_stateid(struct inode inode, fmode_t flags, nfs4_stateid dst, struct rpc_cred **cred);
1da177e4	64
b7391f44	65	void nfs_mark_delegation_referenced(struct nfs_delegation *delegation);
011e2a7f	66	int nfs4_have_delegation(struct inode *inode, fmode_t flags);
15bb3afe	67	int nfs4_check_delegation(struct inode *inode, fmode_t flags);
5445b1fb	68	bool nfs4_delegation_flush_on_close(const struct inode *inode);
6c2d8f8d TM	69	void nfs_inode_find_delegation_state_and_recover(struct inode *inode,
6c2d8f8d TM	70	const nfs4_stateid *stateid);
cae7a073	71
1da177e4 LT	72	#endif
1da177e4 LT	73
b4d2314b TM	74	static inline int nfs_have_delegated_attributes(struct inode *inode)
b4d2314b TM	75	{
011e2a7f	76	return NFS_PROTO(inode)->have_delegation(inode, FMODE_READ) &&
b4d2314b TM	77	!(NFS_I(inode)->cache_validity & NFS_INO_REVAL_FORCED);
	78	}
	79
1da177e4	80	#endif