LXR linux/fs/nfs/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 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 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        NFS_DELEGATION_INODE_FREEING,
  38};
  39
  40int nfs_inode_set_delegation(struct inode *inode, const struct cred *cred,
  41                fmode_t type, const nfs4_stateid *stateid, unsigned long pagemod_limit);
  42void nfs_inode_reclaim_delegation(struct inode *inode, const struct cred *cred,
  43                fmode_t type, const nfs4_stateid *stateid, unsigned long pagemod_limit);
  44int nfs4_inode_return_delegation(struct inode *inode);
  45int nfs_async_inode_return_delegation(struct inode *inode, const nfs4_stateid *stateid);
  46void nfs_inode_return_delegation_noreclaim(struct inode *inode);
  47
  48struct inode *nfs_delegation_find_inode(struct nfs_client *clp, const struct nfs_fh *fhandle);
  49void nfs_server_return_all_delegations(struct nfs_server *);
  50void nfs_expire_all_delegations(struct nfs_client *clp);
  51void nfs_expire_unused_delegation_types(struct nfs_client *clp, fmode_t flags);
  52void nfs_expire_unreferenced_delegations(struct nfs_client *clp);
  53int nfs_client_return_marked_delegations(struct nfs_client *clp);
  54int nfs_delegations_present(struct nfs_client *clp);
  55void nfs_remove_bad_delegation(struct inode *inode, const nfs4_stateid *stateid);
  56
  57void nfs_delegation_mark_reclaim(struct nfs_client *clp);
  58void nfs_delegation_reap_unclaimed(struct nfs_client *clp);
  59
  60void nfs_mark_test_expired_all_delegations(struct nfs_client *clp);
  61void nfs_test_expired_all_delegations(struct nfs_client *clp);
  62void nfs_reap_expired_delegations(struct nfs_client *clp);
  63
  64/* NFSv4 delegation-related procedures */
  65int nfs4_proc_delegreturn(struct inode *inode, const struct cred *cred, const nfs4_stateid *stateid, int issync);
  66int nfs4_open_delegation_recall(struct nfs_open_context *ctx, struct nfs4_state *state, const nfs4_stateid *stateid);
  67int nfs4_lock_delegation_recall(struct file_lock *fl, struct nfs4_state *state, const nfs4_stateid *stateid);
  68bool nfs4_copy_delegation_stateid(struct inode *inode, fmode_t flags, nfs4_stateid *dst, const struct cred **cred);
  69bool nfs4_refresh_delegation_stateid(nfs4_stateid *dst, struct inode *inode);
  70
  71void nfs_mark_delegation_referenced(struct nfs_delegation *delegation);
  72int nfs4_have_delegation(struct inode *inode, fmode_t flags);
  73int nfs4_check_delegation(struct inode *inode, fmode_t flags);
  74bool nfs4_delegation_flush_on_close(const struct inode *inode);
  75void nfs_inode_find_delegation_state_and_recover(struct inode *inode,
  76                const nfs4_stateid *stateid);
  77int nfs4_inode_make_writeable(struct inode *inode);
  78
  79#endif
  80
  81static inline int nfs_have_delegated_attributes(struct inode *inode)
  82{
  83        return NFS_PROTO(inode)->have_delegation(inode, FMODE_READ) &&
  84                !(NFS_I(inode)->cache_validity & NFS_INO_REVAL_FORCED);
  85}
  86
  87#endif
  88