LXR linux/include/linux/nfs

   1/* SPDX-License-Identifier: GPL-2.0 */
   2/*
   3 *  linux/include/linux/nfs_fs.h
   4 *
   5 *  Copyright (C) 1992  Rick Sladkey
   6 *
   7 *  OS-specific nfs filesystem definitions and declarations
   8 */
   9#ifndef _LINUX_NFS_FS_H
  10#define _LINUX_NFS_FS_H
  11
  12#include <uapi/linux/nfs_fs.h>
  13
  14
  15/*
  16 * Enable dprintk() debugging support for nfs client.
  17 */
  18#ifdef CONFIG_NFS_DEBUG
  19# define NFS_DEBUG
  20#endif
  21
  22#include <linux/in.h>
  23#include <linux/mm.h>
  24#include <linux/pagemap.h>
  25#include <linux/rbtree.h>
  26#include <linux/rwsem.h>
  27#include <linux/wait.h>
  28
  29#include <linux/sunrpc/debug.h>
  30#include <linux/sunrpc/auth.h>
  31#include <linux/sunrpc/clnt.h>
  32
  33#include <linux/nfs.h>
  34#include <linux/nfs2.h>
  35#include <linux/nfs3.h>
  36#include <linux/nfs4.h>
  37#include <linux/nfs_xdr.h>
  38#include <linux/nfs_fs_sb.h>
  39
  40#include <linux/mempool.h>
  41
  42/*
  43 * These are the default flags for swap requests
  44 */
  45#define NFS_RPC_SWAPFLAGS               (RPC_TASK_SWAPPER|RPC_TASK_ROOTCREDS)
  46
  47/*
  48 * NFSv3/v4 Access mode cache entry
  49 */
  50struct nfs_access_entry {
  51        struct rb_node          rb_node;
  52        struct list_head        lru;
  53        struct rpc_cred *       cred;
  54        __u32                   mask;
  55        struct rcu_head         rcu_head;
  56};
  57
  58struct nfs_lock_context {
  59        atomic_t count;
  60        struct list_head list;
  61        struct nfs_open_context *open_context;
  62        fl_owner_t lockowner;
  63        atomic_t io_count;
  64};
  65
  66struct nfs4_state;
  67struct nfs_open_context {
  68        struct nfs_lock_context lock_context;
  69        fl_owner_t flock_owner;
  70        struct dentry *dentry;
  71        struct rpc_cred *cred;
  72        struct nfs4_state *state;
  73        fmode_t mode;
  74
  75        unsigned long flags;
  76#define NFS_CONTEXT_ERROR_WRITE         (0)
  77#define NFS_CONTEXT_RESEND_WRITES       (1)
  78#define NFS_CONTEXT_BAD                 (2)
  79#define NFS_CONTEXT_UNLOCK      (3)
  80        int error;
  81
  82        struct list_head list;
  83        struct nfs4_threshold   *mdsthreshold;
  84};
  85
  86struct nfs_open_dir_context {
  87        struct list_head list;
  88        struct rpc_cred *cred;
  89        unsigned long attr_gencount;
  90        __u64 dir_cookie;
  91        __u64 dup_cookie;
  92        signed char duped;
  93};
  94
  95/*
  96 * NFSv4 delegation
  97 */
  98struct nfs_delegation;
  99
 100struct posix_acl;
 101
 102/*
 103 * nfs fs inode data in memory
 104 */
 105struct nfs_inode {
 106        /*
 107         * The 64bit 'inode number'
 108         */
 109        __u64 fileid;
 110
 111        /*
 112         * NFS file handle
 113         */
 114        struct nfs_fh           fh;
 115
 116        /*
 117         * Various flags
 118         */
 119        unsigned long           flags;                  /* atomic bit ops */
 120        unsigned long           cache_validity;         /* bit mask */
 121
 122        /*
 123         * read_cache_jiffies is when we started read-caching this inode.
 124         * attrtimeo is for how long the cached information is assumed
 125         * to be valid. A successful attribute revalidation doubles
 126         * attrtimeo (up to acregmax/acdirmax), a failure resets it to
 127         * acregmin/acdirmin.
 128         *
 129         * We need to revalidate the cached attrs for this inode if
 130         *
 131         *      jiffies - read_cache_jiffies >= attrtimeo
 132         *
 133         * Please note the comparison is greater than or equal
 134         * so that zero timeout values can be specified.
 135         */
 136        unsigned long           read_cache_jiffies;
 137        unsigned long           attrtimeo;
 138        unsigned long           attrtimeo_timestamp;
 139
 140        unsigned long           attr_gencount;
 141        /* "Generation counter" for the attribute cache. This is
 142         * bumped whenever we update the metadata on the
 143         * server.
 144         */
 145        unsigned long           cache_change_attribute;
 146
 147        struct rb_root          access_cache;
 148        struct list_head        access_cache_entry_lru;
 149        struct list_head        access_cache_inode_lru;
 150
 151        /*
 152         * This is the cookie verifier used for NFSv3 readdir
 153         * operations
 154         */
 155        __be32                  cookieverf[2];
 156
 157        atomic_long_t           nrequests;
 158        struct nfs_mds_commit_info commit_info;
 159
 160        /* Open contexts for shared mmap writes */
 161        struct list_head        open_files;
 162
 163        /* Readers: in-flight sillydelete RPC calls */
 164        /* Writers: rmdir */
 165        struct rw_semaphore     rmdir_sem;
 166        struct mutex            commit_mutex;
 167
 168#if IS_ENABLED(CONFIG_NFS_V4)
 169        struct nfs4_cached_acl  *nfs4_acl;
 170        /* NFSv4 state */
 171        struct list_head        open_states;
 172        struct nfs_delegation __rcu *delegation;
 173        struct rw_semaphore     rwsem;
 174
 175        /* pNFS layout information */
 176        struct pnfs_layout_hdr *layout;
 177#endif /* CONFIG_NFS_V4*/
 178        /* how many bytes have been written/read and how many bytes queued up */
 179        __u64 write_io;
 180        __u64 read_io;
 181#ifdef CONFIG_NFS_FSCACHE
 182        struct fscache_cookie   *fscache;
 183#endif
 184        struct inode            vfs_inode;
 185};
 186
 187/*
 188 * Cache validity bit flags
 189 */
 190#define NFS_INO_INVALID_ATTR    0x0001          /* cached attrs are invalid */
 191#define NFS_INO_INVALID_DATA    0x0002          /* cached data is invalid */
 192#define NFS_INO_INVALID_ATIME   0x0004          /* cached atime is invalid */
 193#define NFS_INO_INVALID_ACCESS  0x0008          /* cached access cred invalid */
 194#define NFS_INO_INVALID_ACL     0x0010          /* cached acls are invalid */
 195#define NFS_INO_REVAL_PAGECACHE 0x0020          /* must revalidate pagecache */
 196#define NFS_INO_REVAL_FORCED    0x0040          /* force revalidation ignoring a delegation */
 197#define NFS_INO_INVALID_LABEL   0x0080          /* cached label is invalid */
 198
 199/*
 200 * Bit offsets in flags field
 201 */
 202#define NFS_INO_ADVISE_RDPLUS   (0)             /* advise readdirplus */
 203#define NFS_INO_STALE           (1)             /* possible stale inode */
 204#define NFS_INO_ACL_LRU_SET     (2)             /* Inode is on the LRU list */
 205#define NFS_INO_INVALIDATING    (3)             /* inode is being invalidated */
 206#define NFS_INO_FSCACHE         (5)             /* inode can be cached by FS-Cache */
 207#define NFS_INO_FSCACHE_LOCK    (6)             /* FS-Cache cookie management lock */
 208#define NFS_INO_LAYOUTCOMMIT    (9)             /* layoutcommit required */
 209#define NFS_INO_LAYOUTCOMMITTING (10)           /* layoutcommit inflight */
 210#define NFS_INO_LAYOUTSTATS     (11)            /* layoutstats inflight */
 211#define NFS_INO_ODIRECT         (12)            /* I/O setting is O_DIRECT */
 212
 213static inline struct nfs_inode *NFS_I(const struct inode *inode)
 214{
 215        return container_of(inode, struct nfs_inode, vfs_inode);
 216}
 217
 218static inline struct nfs_server *NFS_SB(const struct super_block *s)
 219{
 220        return (struct nfs_server *)(s->s_fs_info);
 221}
 222
 223static inline struct nfs_fh *NFS_FH(const struct inode *inode)
 224{
 225        return &NFS_I(inode)->fh;
 226}
 227
 228static inline struct nfs_server *NFS_SERVER(const struct inode *inode)
 229{
 230        return NFS_SB(inode->i_sb);
 231}
 232
 233static inline struct rpc_clnt *NFS_CLIENT(const struct inode *inode)
 234{
 235        return NFS_SERVER(inode)->client;
 236}
 237
 238static inline const struct nfs_rpc_ops *NFS_PROTO(const struct inode *inode)
 239{
 240        return NFS_SERVER(inode)->nfs_client->rpc_ops;
 241}
 242
 243static inline unsigned NFS_MINATTRTIMEO(const struct inode *inode)
 244{
 245        struct nfs_server *nfss = NFS_SERVER(inode);
 246        return S_ISDIR(inode->i_mode) ? nfss->acdirmin : nfss->acregmin;
 247}
 248
 249static inline unsigned NFS_MAXATTRTIMEO(const struct inode *inode)
 250{
 251        struct nfs_server *nfss = NFS_SERVER(inode);
 252        return S_ISDIR(inode->i_mode) ? nfss->acdirmax : nfss->acregmax;
 253}
 254
 255static inline int NFS_STALE(const struct inode *inode)
 256{
 257        return test_bit(NFS_INO_STALE, &NFS_I(inode)->flags);
 258}
 259
 260static inline struct fscache_cookie *nfs_i_fscache(struct inode *inode)
 261{
 262#ifdef CONFIG_NFS_FSCACHE
 263        return NFS_I(inode)->fscache;
 264#else
 265        return NULL;
 266#endif
 267}
 268
 269static inline __u64 NFS_FILEID(const struct inode *inode)
 270{
 271        return NFS_I(inode)->fileid;
 272}
 273
 274static inline void set_nfs_fileid(struct inode *inode, __u64 fileid)
 275{
 276        NFS_I(inode)->fileid = fileid;
 277}
 278
 279static inline void nfs_mark_for_revalidate(struct inode *inode)
 280{
 281        struct nfs_inode *nfsi = NFS_I(inode);
 282
 283        spin_lock(&inode->i_lock);
 284        nfsi->cache_validity |= NFS_INO_INVALID_ATTR |
 285                                NFS_INO_REVAL_PAGECACHE |
 286                                NFS_INO_INVALID_ACCESS |
 287                                NFS_INO_INVALID_ACL;
 288        if (S_ISDIR(inode->i_mode))
 289                nfsi->cache_validity |= NFS_INO_INVALID_DATA;
 290        spin_unlock(&inode->i_lock);
 291}
 292
 293static inline int nfs_server_capable(struct inode *inode, int cap)
 294{
 295        return NFS_SERVER(inode)->caps & cap;
 296}
 297
 298static inline void nfs_set_verifier(struct dentry * dentry, unsigned long verf)
 299{
 300        dentry->d_time = verf;
 301}
 302
 303/**
 304 * nfs_save_change_attribute - Returns the inode attribute change cookie
 305 * @dir - pointer to parent directory inode
 306 * The "change attribute" is updated every time we finish an operation
 307 * that will result in a metadata change on the server.
 308 */
 309static inline unsigned long nfs_save_change_attribute(struct inode *dir)
 310{
 311        return NFS_I(dir)->cache_change_attribute;
 312}
 313
 314/**
 315 * nfs_verify_change_attribute - Detects NFS remote directory changes
 316 * @dir - pointer to parent directory inode
 317 * @chattr - previously saved change attribute
 318 * Return "false" if the verifiers doesn't match the change attribute.
 319 * This would usually indicate that the directory contents have changed on
 320 * the server, and that any dentries need revalidating.
 321 */
 322static inline int nfs_verify_change_attribute(struct inode *dir, unsigned long chattr)
 323{
 324        return chattr == NFS_I(dir)->cache_change_attribute;
 325}
 326
 327/*
 328 * linux/fs/nfs/inode.c
 329 */
 330extern int nfs_sync_mapping(struct address_space *mapping);
 331extern void nfs_zap_mapping(struct inode *inode, struct address_space *mapping);
 332extern void nfs_zap_caches(struct inode *);
 333extern void nfs_invalidate_atime(struct inode *);
 334extern struct inode *nfs_fhget(struct super_block *, struct nfs_fh *,
 335                                struct nfs_fattr *, struct nfs4_label *);
 336struct inode *nfs_ilookup(struct super_block *sb, struct nfs_fattr *, struct nfs_fh *);
 337extern int nfs_refresh_inode(struct inode *, struct nfs_fattr *);
 338extern int nfs_post_op_update_inode(struct inode *inode, struct nfs_fattr *fattr);
 339extern int nfs_post_op_update_inode_force_wcc(struct inode *inode, struct nfs_fattr *fattr);
 340extern int nfs_post_op_update_inode_force_wcc_locked(struct inode *inode, struct nfs_fattr *fattr);
 341extern int nfs_getattr(const struct path *, struct kstat *, u32, unsigned int);
 342extern void nfs_access_add_cache(struct inode *, struct nfs_access_entry *);
 343extern void nfs_access_set_mask(struct nfs_access_entry *, u32);
 344extern int nfs_permission(struct inode *, int);
 345extern int nfs_open(struct inode *, struct file *);
 346extern int nfs_attribute_cache_expired(struct inode *inode);
 347extern int nfs_revalidate_inode(struct nfs_server *server, struct inode *inode);
 348extern int __nfs_revalidate_inode(struct nfs_server *, struct inode *);
 349extern bool nfs_mapping_need_revalidate_inode(struct inode *inode);
 350extern int nfs_revalidate_mapping(struct inode *inode, struct address_space *mapping);
 351extern int nfs_revalidate_mapping_rcu(struct inode *inode);
 352extern int nfs_setattr(struct dentry *, struct iattr *);
 353extern void nfs_setattr_update_inode(struct inode *inode, struct iattr *attr, struct nfs_fattr *);
 354extern void nfs_setsecurity(struct inode *inode, struct nfs_fattr *fattr,
 355                                struct nfs4_label *label);
 356extern struct nfs_open_context *get_nfs_open_context(struct nfs_open_context *ctx);
 357extern void put_nfs_open_context(struct nfs_open_context *ctx);
 358extern struct nfs_open_context *nfs_find_open_context(struct inode *inode, struct rpc_cred *cred, fmode_t mode);
 359extern struct nfs_open_context *alloc_nfs_open_context(struct dentry *dentry, fmode_t f_mode, struct file *filp);
 360extern void nfs_inode_attach_open_context(struct nfs_open_context *ctx);
 361extern void nfs_file_set_open_context(struct file *filp, struct nfs_open_context *ctx);
 362extern void nfs_file_clear_open_context(struct file *flip);
 363extern struct nfs_lock_context *nfs_get_lock_context(struct nfs_open_context *ctx);
 364extern void nfs_put_lock_context(struct nfs_lock_context *l_ctx);
 365extern u64 nfs_compat_user_ino64(u64 fileid);
 366extern void nfs_fattr_init(struct nfs_fattr *fattr);
 367extern void nfs_fattr_set_barrier(struct nfs_fattr *fattr);
 368extern unsigned long nfs_inc_attr_generation_counter(void);
 369
 370extern struct nfs_fattr *nfs_alloc_fattr(void);
 371
 372static inline void nfs_free_fattr(const struct nfs_fattr *fattr)
 373{
 374        kfree(fattr);
 375}
 376
 377extern struct nfs_fh *nfs_alloc_fhandle(void);
 378
 379static inline void nfs_free_fhandle(const struct nfs_fh *fh)
 380{
 381        kfree(fh);
 382}
 383
 384#ifdef NFS_DEBUG
 385extern u32 _nfs_display_fhandle_hash(const struct nfs_fh *fh);
 386static inline u32 nfs_display_fhandle_hash(const struct nfs_fh *fh)
 387{
 388        return _nfs_display_fhandle_hash(fh);
 389}
 390extern void _nfs_display_fhandle(const struct nfs_fh *fh, const char *caption);
 391#define nfs_display_fhandle(fh, caption)                        \
 392        do {                                                    \
 393                if (unlikely(nfs_debug & NFSDBG_FACILITY))      \
 394                        _nfs_display_fhandle(fh, caption);      \
 395        } while (0)
 396#else
 397static inline u32 nfs_display_fhandle_hash(const struct nfs_fh *fh)
 398{
 399        return 0;
 400}
 401static inline void nfs_display_fhandle(const struct nfs_fh *fh,
 402                                       const char *caption)
 403{
 404}
 405#endif
 406
 407/*
 408 * linux/fs/nfs/nfsroot.c
 409 */
 410extern int  nfs_root_data(char **root_device, char **root_data); /*__init*/
 411/* linux/net/ipv4/ipconfig.c: trims ip addr off front of name, too. */
 412extern __be32 root_nfs_parse_addr(char *name); /*__init*/
 413
 414/*
 415 * linux/fs/nfs/file.c
 416 */
 417extern const struct file_operations nfs_file_operations;
 418#if IS_ENABLED(CONFIG_NFS_V4)
 419extern const struct file_operations nfs4_file_operations;
 420#endif /* CONFIG_NFS_V4 */
 421extern const struct address_space_operations nfs_file_aops;
 422extern const struct address_space_operations nfs_dir_aops;
 423
 424static inline struct nfs_open_context *nfs_file_open_context(struct file *filp)
 425{
 426        return filp->private_data;
 427}
 428
 429static inline struct rpc_cred *nfs_file_cred(struct file *file)
 430{
 431        if (file != NULL) {
 432                struct nfs_open_context *ctx =
 433                        nfs_file_open_context(file);
 434                if (ctx)
 435                        return ctx->cred;
 436        }
 437        return NULL;
 438}
 439
 440/*
 441 * linux/fs/nfs/direct.c
 442 */
 443extern ssize_t nfs_direct_IO(struct kiocb *, struct iov_iter *);
 444extern ssize_t nfs_file_direct_read(struct kiocb *iocb,
 445                        struct iov_iter *iter);
 446extern ssize_t nfs_file_direct_write(struct kiocb *iocb,
 447                        struct iov_iter *iter);
 448
 449/*
 450 * linux/fs/nfs/dir.c
 451 */
 452extern const struct file_operations nfs_dir_operations;
 453extern const struct dentry_operations nfs_dentry_operations;
 454
 455extern void nfs_force_lookup_revalidate(struct inode *dir);
 456extern int nfs_instantiate(struct dentry *dentry, struct nfs_fh *fh,
 457                        struct nfs_fattr *fattr, struct nfs4_label *label);
 458extern int nfs_may_open(struct inode *inode, struct rpc_cred *cred, int openflags);
 459extern void nfs_access_zap_cache(struct inode *inode);
 460
 461/*
 462 * linux/fs/nfs/symlink.c
 463 */
 464extern const struct inode_operations nfs_symlink_inode_operations;
 465
 466/*
 467 * linux/fs/nfs/sysctl.c
 468 */
 469#ifdef CONFIG_SYSCTL
 470extern int nfs_register_sysctl(void);
 471extern void nfs_unregister_sysctl(void);
 472#else
 473#define nfs_register_sysctl() 0
 474#define nfs_unregister_sysctl() do { } while(0)
 475#endif
 476
 477/*
 478 * linux/fs/nfs/namespace.c
 479 */
 480extern const struct inode_operations nfs_mountpoint_inode_operations;
 481extern const struct inode_operations nfs_referral_inode_operations;
 482extern int nfs_mountpoint_expiry_timeout;
 483extern void nfs_release_automount_timer(void);
 484
 485/*
 486 * linux/fs/nfs/unlink.c
 487 */
 488extern void nfs_complete_unlink(struct dentry *dentry, struct inode *);
 489
 490/*
 491 * linux/fs/nfs/write.c
 492 */
 493extern int  nfs_congestion_kb;
 494extern int  nfs_writepage(struct page *page, struct writeback_control *wbc);
 495extern int  nfs_writepages(struct address_space *, struct writeback_control *);
 496extern int  nfs_flush_incompatible(struct file *file, struct page *page);
 497extern int  nfs_updatepage(struct file *, struct page *, unsigned int, unsigned int);
 498
 499/*
 500 * Try to write back everything synchronously (but check the
 501 * return value!)
 502 */
 503extern int nfs_sync_inode(struct inode *inode);
 504extern int nfs_wb_all(struct inode *inode);
 505extern int nfs_wb_page(struct inode *inode, struct page *page);
 506extern int nfs_wb_page_cancel(struct inode *inode, struct page* page);
 507extern int  nfs_commit_inode(struct inode *, int);
 508extern struct nfs_commit_data *nfs_commitdata_alloc(bool never_fail);
 509extern void nfs_commit_free(struct nfs_commit_data *data);
 510
 511static inline int
 512nfs_have_writebacks(struct inode *inode)
 513{
 514        return atomic_long_read(&NFS_I(inode)->nrequests) != 0;
 515}
 516
 517/*
 518 * linux/fs/nfs/read.c
 519 */
 520extern int  nfs_readpage(struct file *, struct page *);
 521extern int  nfs_readpages(struct file *, struct address_space *,
 522                struct list_head *, unsigned);
 523extern int  nfs_readpage_async(struct nfs_open_context *, struct inode *,
 524                               struct page *);
 525
 526/*
 527 * inline functions
 528 */
 529
 530static inline loff_t nfs_size_to_loff_t(__u64 size)
 531{
 532        return min_t(u64, size, OFFSET_MAX);
 533}
 534
 535static inline ino_t
 536nfs_fileid_to_ino_t(u64 fileid)
 537{
 538        ino_t ino = (ino_t) fileid;
 539        if (sizeof(ino_t) < sizeof(u64))
 540                ino ^= fileid >> (sizeof(u64)-sizeof(ino_t)) * 8;
 541        return ino;
 542}
 543
 544#define NFS_JUKEBOX_RETRY_TIME (5 * HZ)
 545
 546
 547# undef ifdebug
 548# ifdef NFS_DEBUG
 549#  define ifdebug(fac)          if (unlikely(nfs_debug & NFSDBG_##fac))
 550#  define NFS_IFDEBUG(x)        x
 551# else
 552#  define ifdebug(fac)          if (0)
 553#  define NFS_IFDEBUG(x)
 554# endif
 555#endif
 556