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 */
16 struct nfs_delegation {
17 struct hlist_node hash;
18 struct list_head super_list;
19 const struct cred *cred;
20 struct inode *inode;
21 nfs4_stateid stateid;
22 fmode_t type;
23 unsigned long pagemod_limit;
24 __u64 change_attr;
25 unsigned long test_gen;
26 unsigned long flags;
27 refcount_t refcount;
28 spinlock_t lock;
29 struct list_head entry;
30 struct rcu_head rcu;
31 };
32
33 enum {
34 NFS_DELEGATION_NEED_RECLAIM = 0,
35 NFS_DELEGATION_RETURN_IF_CLOSED,
36 NFS_DELEGATION_REFERENCED,
37 NFS_DELEGATION_RETURNING,
38 NFS_DELEGATION_REVOKED,
39 NFS_DELEGATION_TEST_EXPIRED,
40 NFS_DELEGATION_DELEGTIME,
41 };
42
43 int nfs_inode_set_delegation(struct inode *inode, const struct cred *cred,
44 fmode_t type, const nfs4_stateid *stateid,
45 unsigned long pagemod_limit, u32 deleg_type);
46 void nfs_inode_reclaim_delegation(struct inode *inode, const struct cred *cred,
47 fmode_t type, const nfs4_stateid *stateid,
48 unsigned long pagemod_limit, u32 deleg_type);
49 void nfs4_inode_return_delegation(struct inode *inode);
50 void nfs4_inode_return_delegation_on_close(struct inode *inode);
51 void nfs4_inode_set_return_delegation_on_close(struct inode *inode);
52 int nfs_async_inode_return_delegation(struct inode *inode, const nfs4_stateid *stateid);
53 void nfs_inode_evict_delegation(struct inode *inode);
54
55 struct inode *nfs_delegation_find_inode(struct nfs_client *clp, const struct nfs_fh *fhandle);
56 void nfs_server_return_all_delegations(struct nfs_server *);
57 void nfs_expire_all_delegations(struct nfs_client *clp);
58 void nfs_expire_unused_delegation_types(struct nfs_client *clp, fmode_t flags);
59 void nfs_expire_unreferenced_delegations(struct nfs_client *clp);
60 int nfs_client_return_marked_delegations(struct nfs_client *clp);
61 int nfs_delegations_present(struct nfs_client *clp);
62 void nfs_remove_bad_delegation(struct inode *inode, const nfs4_stateid *stateid);
63 void nfs_delegation_mark_returned(struct inode *inode, const nfs4_stateid *stateid);
64
65 void nfs_delegation_mark_reclaim(struct nfs_client *clp);
66 void nfs_delegation_reap_unclaimed(struct nfs_client *clp);
67
68 void nfs_mark_test_expired_all_delegations(struct nfs_client *clp);
69 void nfs_test_expired_all_delegations(struct nfs_client *clp);
70 void nfs_reap_expired_delegations(struct nfs_client *clp);
71
72 /* NFSv4 delegation-related procedures */
73 int nfs4_proc_delegreturn(struct inode *inode, const struct cred *cred,
74 const nfs4_stateid *stateid,
75 struct nfs_delegation *delegation, int issync);
76 int nfs4_open_delegation_recall(struct nfs_open_context *ctx, struct nfs4_state *state, const nfs4_stateid *stateid);
77 int nfs4_lock_delegation_recall(struct file_lock *fl, struct nfs4_state *state, const nfs4_stateid *stateid);
78 bool nfs4_copy_delegation_stateid(struct inode *inode, fmode_t flags, nfs4_stateid *dst, const struct cred **cred);
79 bool nfs4_refresh_delegation_stateid(nfs4_stateid *dst, struct inode *inode);
80
81 struct nfs_delegation *nfs4_get_valid_delegation(const struct inode *inode);
82 void nfs_put_delegation(struct nfs_delegation *delegation);
83 void nfs_mark_delegation_referenced(struct nfs_delegation *delegation);
84 int nfs4_have_delegation(struct inode *inode, fmode_t type, int flags);
85 int nfs4_check_delegation(struct inode *inode, fmode_t type);
86 bool nfs4_delegation_flush_on_close(const struct inode *inode);
87 void nfs_inode_find_delegation_state_and_recover(struct inode *inode,
88 const nfs4_stateid *stateid);
89 void nfs4_inode_make_writeable(struct inode *inode);
90
91 #endif
92
93 #define NFS_DELEGATION_FLAG_TIME BIT(1)
94
95 void nfs_update_delegated_atime(struct inode *inode);
96 void nfs_update_delegated_mtime(struct inode *inode);
97 void nfs_update_delegated_mtime_locked(struct inode *inode);
98
nfs_have_read_or_write_delegation(struct inode * inode)99 static inline int nfs_have_read_or_write_delegation(struct inode *inode)
100 {
101 return NFS_PROTO(inode)->have_delegation(inode, FMODE_READ, 0);
102 }
103
nfs_have_write_delegation(struct inode * inode)104 static inline int nfs_have_write_delegation(struct inode *inode)
105 {
106 return NFS_PROTO(inode)->have_delegation(inode, FMODE_WRITE, 0);
107 }
108
nfs_have_delegated_attributes(struct inode * inode)109 static inline int nfs_have_delegated_attributes(struct inode *inode)
110 {
111 return NFS_PROTO(inode)->have_delegation(inode, FMODE_READ, 0);
112 }
113
nfs_have_delegated_atime(struct inode * inode)114 static inline int nfs_have_delegated_atime(struct inode *inode)
115 {
116 return NFS_PROTO(inode)->have_delegation(inode, FMODE_READ,
117 NFS_DELEGATION_FLAG_TIME);
118 }
119
nfs_have_delegated_mtime(struct inode * inode)120 static inline int nfs_have_delegated_mtime(struct inode *inode)
121 {
122 return NFS_PROTO(inode)->have_delegation(inode, FMODE_WRITE,
123 NFS_DELEGATION_FLAG_TIME);
124 }
125
126 extern bool directory_delegations;
127
nfs_request_directory_delegation(struct inode * inode)128 static inline void nfs_request_directory_delegation(struct inode *inode)
129 {
130 if (S_ISDIR(inode->i_mode))
131 set_bit(NFS_INO_REQ_DIR_DELEG, &NFS_I(inode)->flags);
132 }
133
nfs_have_directory_delegation(struct inode * inode)134 static inline bool nfs_have_directory_delegation(struct inode *inode)
135 {
136 return S_ISDIR(inode->i_mode) && nfs_have_delegated_attributes(inode);
137 }
138
139 int nfs4_delegation_hash_alloc(struct nfs_server *server);
140
141 #endif
142