Branch data     Line data    Source code

       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                 :            :  */
      16                 :            : struct 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                 :            :         refcount_t refcount;
      26                 :            :         spinlock_t lock;
      27                 :            :         struct rcu_head rcu;
      28                 :            : };
      29                 :            : 
      30                 :            : enum {
      31                 :            :         NFS_DELEGATION_NEED_RECLAIM = 0,
      32                 :            :         NFS_DELEGATION_RETURN,
      33                 :            :         NFS_DELEGATION_RETURN_IF_CLOSED,
      34                 :            :         NFS_DELEGATION_REFERENCED,
      35                 :            :         NFS_DELEGATION_RETURNING,
      36                 :            :         NFS_DELEGATION_REVOKED,
      37                 :            :         NFS_DELEGATION_TEST_EXPIRED,
      38                 :            :         NFS_DELEGATION_INODE_FREEING,
      39                 :            : };
      40                 :            : 
      41                 :            : int nfs_inode_set_delegation(struct inode *inode, const struct cred *cred,
      42                 :            :                 fmode_t type, const nfs4_stateid *stateid, unsigned long pagemod_limit);
      43                 :            : void nfs_inode_reclaim_delegation(struct inode *inode, const struct cred *cred,
      44                 :            :                 fmode_t type, const nfs4_stateid *stateid, unsigned long pagemod_limit);
      45                 :            : int nfs4_inode_return_delegation(struct inode *inode);
      46                 :            : void nfs4_inode_return_delegation_on_close(struct inode *inode);
      47                 :            : int nfs_async_inode_return_delegation(struct inode *inode, const nfs4_stateid *stateid);
      48                 :            : void nfs_inode_evict_delegation(struct inode *inode);
      49                 :            : 
      50                 :            : struct inode *nfs_delegation_find_inode(struct nfs_client *clp, const struct nfs_fh *fhandle);
      51                 :            : void nfs_server_return_all_delegations(struct nfs_server *);
      52                 :            : void nfs_expire_all_delegations(struct nfs_client *clp);
      53                 :            : void nfs_expire_unused_delegation_types(struct nfs_client *clp, fmode_t flags);
      54                 :            : void nfs_expire_unreferenced_delegations(struct nfs_client *clp);
      55                 :            : int nfs_client_return_marked_delegations(struct nfs_client *clp);
      56                 :            : int nfs_delegations_present(struct nfs_client *clp);
      57                 :            : void nfs_remove_bad_delegation(struct inode *inode, const nfs4_stateid *stateid);
      58                 :            : void nfs_delegation_mark_returned(struct inode *inode, const nfs4_stateid *stateid);
      59                 :            : 
      60                 :            : void nfs_delegation_mark_reclaim(struct nfs_client *clp);
      61                 :            : void nfs_delegation_reap_unclaimed(struct nfs_client *clp);
      62                 :            : 
      63                 :            : void nfs_mark_test_expired_all_delegations(struct nfs_client *clp);
      64                 :            : void nfs_test_expired_all_delegations(struct nfs_client *clp);
      65                 :            : void nfs_reap_expired_delegations(struct nfs_client *clp);
      66                 :            : 
      67                 :            : /* NFSv4 delegation-related procedures */
      68                 :            : int nfs4_proc_delegreturn(struct inode *inode, const struct cred *cred, const nfs4_stateid *stateid, int issync);
      69                 :            : int nfs4_open_delegation_recall(struct nfs_open_context *ctx, struct nfs4_state *state, const nfs4_stateid *stateid);
      70                 :            : int nfs4_lock_delegation_recall(struct file_lock *fl, struct nfs4_state *state, const nfs4_stateid *stateid);
      71                 :            : bool nfs4_copy_delegation_stateid(struct inode *inode, fmode_t flags, nfs4_stateid *dst, const struct cred **cred);
      72                 :            : bool nfs4_refresh_delegation_stateid(nfs4_stateid *dst, struct inode *inode);
      73                 :            : 
      74                 :            : struct nfs_delegation *nfs4_get_valid_delegation(const struct inode *inode);
      75                 :            : void nfs_mark_delegation_referenced(struct nfs_delegation *delegation);
      76                 :            : int nfs4_have_delegation(struct inode *inode, fmode_t flags);
      77                 :            : int nfs4_check_delegation(struct inode *inode, fmode_t flags);
      78                 :            : bool nfs4_delegation_flush_on_close(const struct inode *inode);
      79                 :            : void nfs_inode_find_delegation_state_and_recover(struct inode *inode,
      80                 :            :                 const nfs4_stateid *stateid);
      81                 :            : int nfs4_inode_make_writeable(struct inode *inode);
      82                 :            : 
      83                 :            : #endif
      84                 :            : 
      85                 :          0 : static inline int nfs_have_delegated_attributes(struct inode *inode)
      86                 :            : {
      87   [ #  #  #  # ]:          0 :         return NFS_PROTO(inode)->have_delegation(inode, FMODE_READ) &&
      88   [ #  #  #  # ]:          0 :                 !(NFS_I(inode)->cache_validity & NFS_INO_REVAL_FORCED);
      89                 :            : }
      90                 :            : 
      91                 :            : #endif