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 */
15struct 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	loff_t maxsize;
22	__u64 change_attr;
23	unsigned long flags;
24	spinlock_t lock;
25	struct rcu_head rcu;
26};
27
28enum {
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};
36
37int nfs_inode_set_delegation(struct inode *inode, struct rpc_cred *cred, struct nfs_openres *res);
38void nfs_inode_reclaim_delegation(struct inode *inode, struct rpc_cred *cred, struct nfs_openres *res);
39int nfs4_inode_return_delegation(struct inode *inode);
40int nfs_async_inode_return_delegation(struct inode *inode, const nfs4_stateid *stateid);
41void nfs_inode_return_delegation_noreclaim(struct inode *inode);
42
43struct inode *nfs_delegation_find_inode(struct nfs_client *clp, const struct nfs_fh *fhandle);
44void nfs_server_return_all_delegations(struct nfs_server *);
45void nfs_expire_all_delegations(struct nfs_client *clp);
46void nfs_expire_unused_delegation_types(struct nfs_client *clp, fmode_t flags);
47void nfs_expire_unreferenced_delegations(struct nfs_client *clp);
48int nfs_client_return_marked_delegations(struct nfs_client *clp);
49int nfs_delegations_present(struct nfs_client *clp);
50void nfs_remove_bad_delegation(struct inode *inode);
51
52void nfs_delegation_mark_reclaim(struct nfs_client *clp);
53void nfs_delegation_reap_unclaimed(struct nfs_client *clp);
54
55/* NFSv4 delegation-related procedures */
56int nfs4_proc_delegreturn(struct inode *inode, struct rpc_cred *cred, const nfs4_stateid *stateid, int issync);
57int nfs4_open_delegation_recall(struct nfs_open_context *ctx, struct nfs4_state *state, const nfs4_stateid *stateid);
58int nfs4_lock_delegation_recall(struct file_lock *fl, struct nfs4_state *state, const nfs4_stateid *stateid);
59bool nfs4_copy_delegation_stateid(nfs4_stateid *dst, struct inode *inode, fmode_t flags);
60
61void nfs_mark_delegation_referenced(struct nfs_delegation *delegation);
62int nfs4_have_delegation(struct inode *inode, fmode_t flags);
63int nfs4_check_delegation(struct inode *inode, fmode_t flags);
64
65#endif
66
67static inline int nfs_have_delegated_attributes(struct inode *inode)
68{
69	return NFS_PROTO(inode)->have_delegation(inode, FMODE_READ) &&
70		!(NFS_I(inode)->cache_validity & NFS_INO_REVAL_FORCED);
71}
72
73#endif
74