xref: /openbmc/linux/fs/nfs/delegation.h (revision 4f6cce39)
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 
11 #if IS_ENABLED(CONFIG_NFS_V4)
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;
20 	fmode_t type;
21 	unsigned long pagemod_limit;
22 	__u64 change_attr;
23 	unsigned long flags;
24 	spinlock_t lock;
25 	struct rcu_head rcu;
26 };
27 
28 enum {
29 	NFS_DELEGATION_NEED_RECLAIM = 0,
30 	NFS_DELEGATION_RETURN,
31 	NFS_DELEGATION_RETURN_IF_CLOSED,
32 	NFS_DELEGATION_REFERENCED,
33 	NFS_DELEGATION_RETURNING,
34 	NFS_DELEGATION_REVOKED,
35 	NFS_DELEGATION_TEST_EXPIRED,
36 };
37 
38 int nfs_inode_set_delegation(struct inode *inode, struct rpc_cred *cred, struct nfs_openres *res);
39 void nfs_inode_reclaim_delegation(struct inode *inode, struct rpc_cred *cred, struct nfs_openres *res);
40 int nfs4_inode_return_delegation(struct inode *inode);
41 int nfs_async_inode_return_delegation(struct inode *inode, const nfs4_stateid *stateid);
42 void nfs_inode_return_delegation_noreclaim(struct inode *inode);
43 
44 struct inode *nfs_delegation_find_inode(struct nfs_client *clp, const struct nfs_fh *fhandle);
45 void nfs_server_return_all_delegations(struct nfs_server *);
46 void nfs_expire_all_delegations(struct nfs_client *clp);
47 void nfs_expire_unused_delegation_types(struct nfs_client *clp, fmode_t flags);
48 void nfs_expire_unreferenced_delegations(struct nfs_client *clp);
49 int nfs_client_return_marked_delegations(struct nfs_client *clp);
50 int nfs_delegations_present(struct nfs_client *clp);
51 void nfs_remove_bad_delegation(struct inode *inode, const nfs4_stateid *stateid);
52 
53 void nfs_delegation_mark_reclaim(struct nfs_client *clp);
54 void nfs_delegation_reap_unclaimed(struct nfs_client *clp);
55 
56 void nfs_mark_test_expired_all_delegations(struct nfs_client *clp);
57 void nfs_reap_expired_delegations(struct nfs_client *clp);
58 
59 /* NFSv4 delegation-related procedures */
60 int nfs4_proc_delegreturn(struct inode *inode, struct rpc_cred *cred, const nfs4_stateid *stateid, int issync);
61 int nfs4_open_delegation_recall(struct nfs_open_context *ctx, struct nfs4_state *state, const nfs4_stateid *stateid, fmode_t type);
62 int nfs4_lock_delegation_recall(struct file_lock *fl, struct nfs4_state *state, const nfs4_stateid *stateid);
63 bool nfs4_copy_delegation_stateid(struct inode *inode, fmode_t flags, nfs4_stateid *dst, struct rpc_cred **cred);
64 
65 void nfs_mark_delegation_referenced(struct nfs_delegation *delegation);
66 int nfs4_have_delegation(struct inode *inode, fmode_t flags);
67 int nfs4_check_delegation(struct inode *inode, fmode_t flags);
68 bool nfs4_delegation_flush_on_close(const struct inode *inode);
69 void nfs_inode_find_delegation_state_and_recover(struct inode *inode,
70 		const nfs4_stateid *stateid);
71 
72 #endif
73 
74 static inline int nfs_have_delegated_attributes(struct inode *inode)
75 {
76 	return NFS_PROTO(inode)->have_delegation(inode, FMODE_READ) &&
77 		!(NFS_I(inode)->cache_validity & NFS_INO_REVAL_FORCED);
78 }
79 
80 #endif
81