[linux-2.6-block.git] / fs / nfs / delegation.h

/* SPDX-License-Identifier: GPL-2.0 */
/*
 * 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;
	const struct 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,
	NFS_DELEGATION_INODE_FREEING,
};

int nfs_inode_set_delegation(struct inode *inode, const struct cred *cred,
		fmode_t type, const nfs4_stateid *stateid, unsigned long pagemod_limit);
void nfs_inode_reclaim_delegation(struct inode *inode, const struct cred *cred,
		fmode_t type, const nfs4_stateid *stateid, unsigned long pagemod_limit);
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_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, const struct 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, const struct cred **cred);
bool nfs4_refresh_delegation_stateid(nfs4_stateid *dst, struct inode *inode);

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);
int nfs4_inode_make_writeable(struct inode *inode);

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