Loading...
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 struct rpc_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 flags;
25 spinlock_t lock;
26 struct rcu_head rcu;
27};
28
29enum {
30 NFS_DELEGATION_NEED_RECLAIM = 0,
31 NFS_DELEGATION_RETURN,
32 NFS_DELEGATION_RETURN_IF_CLOSED,
33 NFS_DELEGATION_REFERENCED,
34 NFS_DELEGATION_RETURNING,
35 NFS_DELEGATION_REVOKED,
36 NFS_DELEGATION_TEST_EXPIRED,
37};
38
39int nfs_inode_set_delegation(struct inode *inode, struct rpc_cred *cred,
40 fmode_t type, const nfs4_stateid *stateid, unsigned long pagemod_limit);
41void nfs_inode_reclaim_delegation(struct inode *inode, struct rpc_cred *cred,
42 fmode_t type, const nfs4_stateid *stateid, unsigned long pagemod_limit);
43int nfs4_inode_return_delegation(struct inode *inode);
44int nfs_async_inode_return_delegation(struct inode *inode, const nfs4_stateid *stateid);
45void nfs_inode_return_delegation_noreclaim(struct inode *inode);
46
47struct inode *nfs_delegation_find_inode(struct nfs_client *clp, const struct nfs_fh *fhandle);
48void nfs_server_return_all_delegations(struct nfs_server *);
49void nfs_expire_all_delegations(struct nfs_client *clp);
50void nfs_expire_unused_delegation_types(struct nfs_client *clp, fmode_t flags);
51void nfs_expire_unreferenced_delegations(struct nfs_client *clp);
52int nfs_client_return_marked_delegations(struct nfs_client *clp);
53int nfs_delegations_present(struct nfs_client *clp);
54void nfs_remove_bad_delegation(struct inode *inode, const nfs4_stateid *stateid);
55
56void nfs_delegation_mark_reclaim(struct nfs_client *clp);
57void nfs_delegation_reap_unclaimed(struct nfs_client *clp);
58
59void nfs_mark_test_expired_all_delegations(struct nfs_client *clp);
60void nfs_reap_expired_delegations(struct nfs_client *clp);
61
62/* NFSv4 delegation-related procedures */
63int nfs4_proc_delegreturn(struct inode *inode, struct rpc_cred *cred, const nfs4_stateid *stateid, int issync);
64int nfs4_open_delegation_recall(struct nfs_open_context *ctx, struct nfs4_state *state, const nfs4_stateid *stateid, fmode_t type);
65int nfs4_lock_delegation_recall(struct file_lock *fl, struct nfs4_state *state, const nfs4_stateid *stateid);
66bool nfs4_copy_delegation_stateid(struct inode *inode, fmode_t flags, nfs4_stateid *dst, struct rpc_cred **cred);
67bool nfs4_refresh_delegation_stateid(nfs4_stateid *dst, struct inode *inode);
68
69void nfs_mark_delegation_referenced(struct nfs_delegation *delegation);
70int nfs4_have_delegation(struct inode *inode, fmode_t flags);
71int nfs4_check_delegation(struct inode *inode, fmode_t flags);
72bool nfs4_delegation_flush_on_close(const struct inode *inode);
73void nfs_inode_find_delegation_state_and_recover(struct inode *inode,
74 const nfs4_stateid *stateid);
75int nfs4_inode_make_writeable(struct inode *inode);
76
77#endif
78
79static inline int nfs_have_delegated_attributes(struct inode *inode)
80{
81 return NFS_PROTO(inode)->have_delegation(inode, FMODE_READ) &&
82 !(NFS_I(inode)->cache_validity & NFS_INO_REVAL_FORCED);
83}
84
85#endif
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 NFS_DELEGATION_DELEGTIME,
42};
43
44int nfs_inode_set_delegation(struct inode *inode, const struct cred *cred,
45 fmode_t type, const nfs4_stateid *stateid,
46 unsigned long pagemod_limit, u32 deleg_type);
47void nfs_inode_reclaim_delegation(struct inode *inode, const struct cred *cred,
48 fmode_t type, const nfs4_stateid *stateid,
49 unsigned long pagemod_limit, u32 deleg_type);
50int nfs4_inode_return_delegation(struct inode *inode);
51void nfs4_inode_return_delegation_on_close(struct inode *inode);
52void nfs4_inode_set_return_delegation_on_close(struct inode *inode);
53int nfs_async_inode_return_delegation(struct inode *inode, const nfs4_stateid *stateid);
54void nfs_inode_evict_delegation(struct inode *inode);
55
56struct inode *nfs_delegation_find_inode(struct nfs_client *clp, const struct nfs_fh *fhandle);
57void nfs_server_return_all_delegations(struct nfs_server *);
58void nfs_expire_all_delegations(struct nfs_client *clp);
59void nfs_expire_unused_delegation_types(struct nfs_client *clp, fmode_t flags);
60void nfs_expire_unreferenced_delegations(struct nfs_client *clp);
61int nfs_client_return_marked_delegations(struct nfs_client *clp);
62int nfs_delegations_present(struct nfs_client *clp);
63void nfs_remove_bad_delegation(struct inode *inode, const nfs4_stateid *stateid);
64void nfs_delegation_mark_returned(struct inode *inode, const nfs4_stateid *stateid);
65
66void nfs_delegation_mark_reclaim(struct nfs_client *clp);
67void nfs_delegation_reap_unclaimed(struct nfs_client *clp);
68
69void nfs_mark_test_expired_all_delegations(struct nfs_client *clp);
70void nfs_test_expired_all_delegations(struct nfs_client *clp);
71void nfs_reap_expired_delegations(struct nfs_client *clp);
72
73/* NFSv4 delegation-related procedures */
74int nfs4_proc_delegreturn(struct inode *inode, const struct cred *cred,
75 const nfs4_stateid *stateid,
76 struct nfs_delegation *delegation, int issync);
77int nfs4_open_delegation_recall(struct nfs_open_context *ctx, struct nfs4_state *state, const nfs4_stateid *stateid);
78int nfs4_lock_delegation_recall(struct file_lock *fl, struct nfs4_state *state, const nfs4_stateid *stateid);
79bool nfs4_copy_delegation_stateid(struct inode *inode, fmode_t flags, nfs4_stateid *dst, const struct cred **cred);
80bool nfs4_refresh_delegation_stateid(nfs4_stateid *dst, struct inode *inode);
81
82struct nfs_delegation *nfs4_get_valid_delegation(const struct inode *inode);
83void nfs_mark_delegation_referenced(struct nfs_delegation *delegation);
84int nfs4_have_delegation(struct inode *inode, fmode_t type, int flags);
85int nfs4_check_delegation(struct inode *inode, fmode_t type);
86bool nfs4_delegation_flush_on_close(const struct inode *inode);
87void nfs_inode_find_delegation_state_and_recover(struct inode *inode,
88 const nfs4_stateid *stateid);
89int nfs4_inode_make_writeable(struct inode *inode);
90
91#endif
92
93#define NFS_DELEGATION_FLAG_TIME BIT(1)
94
95void nfs_update_delegated_atime(struct inode *inode);
96void nfs_update_delegated_mtime(struct inode *inode);
97void nfs_update_delegated_mtime_locked(struct inode *inode);
98
99static 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
104static inline int nfs_have_write_delegation(struct inode *inode)
105{
106 return NFS_PROTO(inode)->have_delegation(inode, FMODE_WRITE, 0);
107}
108
109static inline int nfs_have_delegated_attributes(struct inode *inode)
110{
111 return NFS_PROTO(inode)->have_delegation(inode, FMODE_READ, 0);
112}
113
114static 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
120static 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#endif