1/* SPDX-License-Identifier: GPL-2.0 */
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
12#if IS_ENABLED(CONFIG_NFS_V4)
13/*
14 * NFSv4 delegation
15 */
16struct nfs_delegation {
17	struct list_head super_list;
18	const struct cred *cred;
19	struct inode *inode;
20	nfs4_stateid stateid;
21	fmode_t type;
22	unsigned long pagemod_limit;
23	__u64 change_attr;
24	unsigned long test_gen;
25	unsigned long flags;
26	refcount_t refcount;
27	spinlock_t lock;
28	struct rcu_head rcu;
29};
30
31enum {
32	NFS_DELEGATION_NEED_RECLAIM = 0,
33	NFS_DELEGATION_RETURN,
34	NFS_DELEGATION_RETURN_IF_CLOSED,
35	NFS_DELEGATION_REFERENCED,
36	NFS_DELEGATION_RETURNING,
37	NFS_DELEGATION_REVOKED,
38	NFS_DELEGATION_TEST_EXPIRED,
39	NFS_DELEGATION_INODE_FREEING,
40	NFS_DELEGATION_RETURN_DELAYED,
41};
42
43int nfs_inode_set_delegation(struct inode *inode, const struct cred *cred,
44		fmode_t type, const nfs4_stateid *stateid, unsigned long pagemod_limit);
45void nfs_inode_reclaim_delegation(struct inode *inode, const struct cred *cred,
46		fmode_t type, const nfs4_stateid *stateid, unsigned long pagemod_limit);
47int nfs4_inode_return_delegation(struct inode *inode);
48void nfs4_inode_return_delegation_on_close(struct inode *inode);
49int nfs_async_inode_return_delegation(struct inode *inode, const nfs4_stateid *stateid);
50void nfs_inode_evict_delegation(struct inode *inode);
51
52struct inode *nfs_delegation_find_inode(struct nfs_client *clp, const struct nfs_fh *fhandle);
53void nfs_server_return_all_delegations(struct nfs_server *);
54void nfs_expire_all_delegations(struct nfs_client *clp);
55void nfs_expire_unused_delegation_types(struct nfs_client *clp, fmode_t flags);
56void nfs_expire_unreferenced_delegations(struct nfs_client *clp);
57int nfs_client_return_marked_delegations(struct nfs_client *clp);
58int nfs_delegations_present(struct nfs_client *clp);
59void nfs_remove_bad_delegation(struct inode *inode, const nfs4_stateid *stateid);
60void nfs_delegation_mark_returned(struct inode *inode, const nfs4_stateid *stateid);
61
62void nfs_delegation_mark_reclaim(struct nfs_client *clp);
63void nfs_delegation_reap_unclaimed(struct nfs_client *clp);
64
65void nfs_mark_test_expired_all_delegations(struct nfs_client *clp);
66void nfs_test_expired_all_delegations(struct nfs_client *clp);
67void nfs_reap_expired_delegations(struct nfs_client *clp);
68
69/* NFSv4 delegation-related procedures */
70int nfs4_proc_delegreturn(struct inode *inode, const struct cred *cred, const nfs4_stateid *stateid, int issync);
71int nfs4_open_delegation_recall(struct nfs_open_context *ctx, struct nfs4_state *state, const nfs4_stateid *stateid);
72int nfs4_lock_delegation_recall(struct file_lock *fl, struct nfs4_state *state, const nfs4_stateid *stateid);
73bool nfs4_copy_delegation_stateid(struct inode *inode, fmode_t flags, nfs4_stateid *dst, const struct cred **cred);
74bool nfs4_refresh_delegation_stateid(nfs4_stateid *dst, struct inode *inode);
75
76struct nfs_delegation *nfs4_get_valid_delegation(const struct inode *inode);
77void nfs_mark_delegation_referenced(struct nfs_delegation *delegation);
78int nfs4_have_delegation(struct inode *inode, fmode_t flags);
79int nfs4_check_delegation(struct inode *inode, fmode_t flags);
80bool nfs4_delegation_flush_on_close(const struct inode *inode);
81void nfs_inode_find_delegation_state_and_recover(struct inode *inode,
82		const nfs4_stateid *stateid);
83int nfs4_inode_make_writeable(struct inode *inode);
84
85#endif
86
87static inline int nfs_have_delegated_attributes(struct inode *inode)
88{
89	return NFS_PROTO(inode)->have_delegation(inode, FMODE_READ);
90}
91
92#endif
93