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