delegation.h

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