LXR linux/include/linux/nfs

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