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