blob: 64724d252a7973074fcff861a31164c9df7415f9 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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
Bryan Schumaker89d77c82012-07-30 16:05:25 -040011#if IS_ENABLED(CONFIG_NFS_V4)
Linus Torvalds1da177e2005-04-16 15:20:36 -070012/*
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;
Trond Myklebustbd7bf9d2008-12-23 15:21:53 -050020 fmode_t type;
Trond Myklebust7d160a62015-09-05 19:06:57 -040021 unsigned long pagemod_limit;
Trond Myklebustbeb2a5e2006-01-03 09:55:37 +010022 __u64 change_attr;
Trond Myklebust15c831b2008-12-23 15:21:39 -050023 unsigned long flags;
Trond Myklebust34310432008-12-23 15:21:38 -050024 spinlock_t lock;
Trond Myklebust8383e462007-07-06 15:12:04 -040025 struct rcu_head rcu;
Linus Torvalds1da177e2005-04-16 15:20:36 -070026};
27
Trond Myklebust515d8612008-12-23 15:21:46 -050028enum {
29 NFS_DELEGATION_NEED_RECLAIM = 0,
30 NFS_DELEGATION_RETURN,
Trond Myklebustb7571442013-04-03 14:33:49 -040031 NFS_DELEGATION_RETURN_IF_CLOSED,
Trond Myklebustb7391f42008-12-23 15:21:52 -050032 NFS_DELEGATION_REFERENCED,
Trond Myklebustd25be542013-02-05 11:43:28 -050033 NFS_DELEGATION_RETURNING,
Trond Myklebust869f9df2014-11-10 18:43:56 -050034 NFS_DELEGATION_REVOKED,
Trond Myklebust515d8612008-12-23 15:21:46 -050035};
36
Linus Torvalds1da177e2005-04-16 15:20:36 -070037int 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);
Bryan Schumaker57ec14c2012-06-20 15:53:44 -040039int nfs4_inode_return_delegation(struct inode *inode);
Trond Myklebuste047a102010-06-16 09:52:27 -040040int nfs_async_inode_return_delegation(struct inode *inode, const nfs4_stateid *stateid);
Trond Myklebuste6f81072008-01-24 18:14:34 -050041void nfs_inode_return_delegation_noreclaim(struct inode *inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -070042
David Howellsadfa6f92006-08-22 20:06:08 -040043struct inode *nfs_delegation_find_inode(struct nfs_client *clp, const struct nfs_fh *fhandle);
Bryan Schumakereeebf912012-06-20 15:53:41 -040044void nfs_server_return_all_delegations(struct nfs_server *);
David Howellsadfa6f92006-08-22 20:06:08 -040045void nfs_expire_all_delegations(struct nfs_client *clp);
Trond Myklebust826e0012013-04-03 19:27:52 -040046void nfs_expire_unused_delegation_types(struct nfs_client *clp, fmode_t flags);
Trond Myklebustb7391f42008-12-23 15:21:52 -050047void nfs_expire_unreferenced_delegations(struct nfs_client *clp);
Trond Myklebustd18cc1f2009-12-03 08:10:17 -050048int nfs_client_return_marked_delegations(struct nfs_client *clp);
Chuck Leverd3978bb2010-12-24 01:33:04 +000049int nfs_delegations_present(struct nfs_client *clp);
Trond Myklebusta1d0b5e2012-03-05 19:56:44 -050050void nfs_remove_bad_delegation(struct inode *inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -070051
David Howellsadfa6f92006-08-22 20:06:08 -040052void nfs_delegation_mark_reclaim(struct nfs_client *clp);
53void nfs_delegation_reap_unclaimed(struct nfs_client *clp);
Linus Torvalds1da177e2005-04-16 15:20:36 -070054
55/* NFSv4 delegation-related procedures */
Trond Myklebuste6f81072008-01-24 18:14:34 -050056int nfs4_proc_delegreturn(struct inode *inode, struct rpc_cred *cred, const nfs4_stateid *stateid, int issync);
Trond Myklebust24311f82015-09-20 10:50:17 -040057int nfs4_open_delegation_recall(struct nfs_open_context *ctx, struct nfs4_state *state, const nfs4_stateid *stateid, fmode_t type);
Trond Myklebustdb4f2e632013-04-01 15:56:46 -040058int nfs4_lock_delegation_recall(struct file_lock *fl, struct nfs4_state *state, const nfs4_stateid *stateid);
Trond Myklebustabf4e132016-05-16 17:42:44 -040059bool nfs4_copy_delegation_stateid(struct inode *inode, fmode_t flags, nfs4_stateid *dst, struct rpc_cred **cred);
Linus Torvalds1da177e2005-04-16 15:20:36 -070060
Trond Myklebustb7391f42008-12-23 15:21:52 -050061void nfs_mark_delegation_referenced(struct nfs_delegation *delegation);
Bryan Schumaker011e2a72012-06-20 15:53:43 -040062int nfs4_have_delegation(struct inode *inode, fmode_t flags);
Peng Tao15bb3af2014-07-03 13:05:00 +080063int nfs4_check_delegation(struct inode *inode, fmode_t flags);
Trond Myklebust5445b1f2015-09-05 19:06:58 -040064bool nfs4_delegation_flush_on_close(const struct inode *inode);
Trond Myklebustcae7a072005-10-18 14:20:19 -070065
Linus Torvalds1da177e2005-04-16 15:20:36 -070066#endif
67
Trond Myklebustb4d23142010-03-10 15:21:44 -050068static inline int nfs_have_delegated_attributes(struct inode *inode)
69{
Bryan Schumaker011e2a72012-06-20 15:53:43 -040070 return NFS_PROTO(inode)->have_delegation(inode, FMODE_READ) &&
Trond Myklebustb4d23142010-03-10 15:21:44 -050071 !(NFS_I(inode)->cache_validity & NFS_INO_REVAL_FORCED);
72}
73
Linus Torvalds1da177e2005-04-16 15:20:36 -070074#endif