include/linux/nfs_fs.h

   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  */
  49 struct 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
  58 struct nfs_lockowner {
  59         fl_owner_t l_owner;
  60         pid_t l_pid;
  61 };
  62
  63 struct 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
  71 struct nfs4_state;
  72 struct 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
  89 struct 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  */
 101 struct nfs_delegation;
 102
 103 struct posix_acl;
 104
 105 /*
 106  * nfs fs inode data in memory
 107  */
 108 struct 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 #ifdef CONFIG_PREEMPT_RT_BASE
 169         struct semaphore        rmdir_sem;
 170 #else
 171         struct rw_semaphore     rmdir_sem;
 172 #endif
 173
 174 #if IS_ENABLED(CONFIG_NFS_V4)
 175         struct nfs4_cached_acl  *nfs4_acl;
 176         /* NFSv4 state */
 177         struct list_head        open_states;
 178         struct nfs_delegation __rcu *delegation;
 179         struct rw_semaphore     rwsem;
 180
 181         /* pNFS layout information */
 182         struct pnfs_layout_hdr *layout;
 183 #endif /* CONFIG_NFS_V4*/
 184         /* how many bytes have been written/read and how many bytes queued up */
 185         __u64 write_io;
 186         __u64 read_io;
 187 #ifdef CONFIG_NFS_FSCACHE
 188         struct fscache_cookie   *fscache;
 189 #endif
 190         struct inode            vfs_inode;
 191 };
 192
 193 /*
 194  * Cache validity bit flags
 195  */
 196 #define NFS_INO_INVALID_ATTR    0x0001          /* cached attrs are invalid */
 197 #define NFS_INO_INVALID_DATA    0x0002          /* cached data is invalid */
 198 #define NFS_INO_INVALID_ATIME   0x0004          /* cached atime is invalid */
 199 #define NFS_INO_INVALID_ACCESS  0x0008          /* cached access cred invalid */
 200 #define NFS_INO_INVALID_ACL     0x0010          /* cached acls are invalid */
 201 #define NFS_INO_REVAL_PAGECACHE 0x0020          /* must revalidate pagecache */
 202 #define NFS_INO_REVAL_FORCED    0x0040          /* force revalidation ignoring a delegation */
 203 #define NFS_INO_INVALID_LABEL   0x0080          /* cached label is invalid */
 204
 205 /*
 206  * Bit offsets in flags field
 207  */
 208 #define NFS_INO_ADVISE_RDPLUS   (0)             /* advise readdirplus */
 209 #define NFS_INO_STALE           (1)             /* possible stale inode */
 210 #define NFS_INO_ACL_LRU_SET     (2)             /* Inode is on the LRU list */
 211 #define NFS_INO_INVALIDATING    (3)             /* inode is being invalidated */
 212 #define NFS_INO_FSCACHE         (5)             /* inode can be cached by FS-Cache */
 213 #define NFS_INO_FSCACHE_LOCK    (6)             /* FS-Cache cookie management lock */
 214 #define NFS_INO_LAYOUTCOMMIT    (9)             /* layoutcommit required */
 215 #define NFS_INO_LAYOUTCOMMITTING (10)           /* layoutcommit inflight */
 216 #define NFS_INO_LAYOUTSTATS     (11)            /* layoutstats inflight */
 217 #define NFS_INO_ODIRECT         (12)            /* I/O setting is O_DIRECT */
 218
 219 static inline struct nfs_inode *NFS_I(const struct inode *inode)
 220 {
 221         return container_of(inode, struct nfs_inode, vfs_inode);
 222 }
 223
 224 static inline struct nfs_server *NFS_SB(const struct super_block *s)
 225 {
 226         return (struct nfs_server *)(s->s_fs_info);
 227 }
 228
 229 static inline struct nfs_fh *NFS_FH(const struct inode *inode)
 230 {
 231         return &NFS_I(inode)->fh;
 232 }
 233
 234 static inline struct nfs_server *NFS_SERVER(const struct inode *inode)
 235 {
 236         return NFS_SB(inode->i_sb);
 237 }
 238
 239 static inline struct rpc_clnt *NFS_CLIENT(const struct inode *inode)
 240 {
 241         return NFS_SERVER(inode)->client;
 242 }
 243
 244 static inline const struct nfs_rpc_ops *NFS_PROTO(const struct inode *inode)
 245 {
 246         return NFS_SERVER(inode)->nfs_client->rpc_ops;
 247 }
 248
 249 static inline unsigned NFS_MINATTRTIMEO(const struct inode *inode)
 250 {
 251         struct nfs_server *nfss = NFS_SERVER(inode);
 252         return S_ISDIR(inode->i_mode) ? nfss->acdirmin : nfss->acregmin;
 253 }
 254
 255 static inline unsigned NFS_MAXATTRTIMEO(const struct inode *inode)
 256 {
 257         struct nfs_server *nfss = NFS_SERVER(inode);
 258         return S_ISDIR(inode->i_mode) ? nfss->acdirmax : nfss->acregmax;
 259 }
 260
 261 static inline int NFS_STALE(const struct inode *inode)
 262 {
 263         return test_bit(NFS_INO_STALE, &NFS_I(inode)->flags);
 264 }
 265
 266 static inline struct fscache_cookie *nfs_i_fscache(struct inode *inode)
 267 {
 268 #ifdef CONFIG_NFS_FSCACHE
 269         return NFS_I(inode)->fscache;
 270 #else
 271         return NULL;
 272 #endif
 273 }
 274
 275 static inline __u64 NFS_FILEID(const struct inode *inode)
 276 {
 277         return NFS_I(inode)->fileid;
 278 }
 279
 280 static inline void set_nfs_fileid(struct inode *inode, __u64 fileid)
 281 {
 282         NFS_I(inode)->fileid = fileid;
 283 }
 284
 285 static inline void nfs_mark_for_revalidate(struct inode *inode)
 286 {
 287         struct nfs_inode *nfsi = NFS_I(inode);
 288
 289         spin_lock(&inode->i_lock);
 290         nfsi->cache_validity |= NFS_INO_INVALID_ATTR |
 291                                 NFS_INO_REVAL_PAGECACHE |
 292                                 NFS_INO_INVALID_ACCESS |
 293                                 NFS_INO_INVALID_ACL;
 294         if (S_ISDIR(inode->i_mode))
 295                 nfsi->cache_validity |= NFS_INO_INVALID_DATA;
 296         spin_unlock(&inode->i_lock);
 297 }
 298
 299 static inline int nfs_server_capable(struct inode *inode, int cap)
 300 {
 301         return NFS_SERVER(inode)->caps & cap;
 302 }
 303
 304 static inline void nfs_set_verifier(struct dentry * dentry, unsigned long verf)
 305 {
 306         dentry->d_time = verf;
 307 }
 308
 309 /**
 310  * nfs_save_change_attribute - Returns the inode attribute change cookie
 311  * @dir - pointer to parent directory inode
 312  * The "change attribute" is updated every time we finish an operation
 313  * that will result in a metadata change on the server.
 314  */
 315 static inline unsigned long nfs_save_change_attribute(struct inode *dir)
 316 {
 317         return NFS_I(dir)->cache_change_attribute;
 318 }
 319
 320 /**
 321  * nfs_verify_change_attribute - Detects NFS remote directory changes
 322  * @dir - pointer to parent directory inode
 323  * @chattr - previously saved change attribute
 324  * Return "false" if the verifiers doesn't match the change attribute.
 325  * This would usually indicate that the directory contents have changed on
 326  * the server, and that any dentries need revalidating.
 327  */
 328 static inline int nfs_verify_change_attribute(struct inode *dir, unsigned long chattr)
 329 {
 330         return chattr == NFS_I(dir)->cache_change_attribute;
 331 }
 332
 333 /*
 334  * linux/fs/nfs/inode.c
 335  */
 336 extern int nfs_sync_mapping(struct address_space *mapping);
 337 extern void nfs_zap_mapping(struct inode *inode, struct address_space *mapping);
 338 extern void nfs_zap_caches(struct inode *);
 339 extern void nfs_invalidate_atime(struct inode *);
 340 extern struct inode *nfs_fhget(struct super_block *, struct nfs_fh *,
 341                                 struct nfs_fattr *, struct nfs4_label *);
 342 extern int nfs_refresh_inode(struct inode *, struct nfs_fattr *);
 343 extern int nfs_post_op_update_inode(struct inode *inode, struct nfs_fattr *fattr);
 344 extern int nfs_post_op_update_inode_force_wcc(struct inode *inode, struct nfs_fattr *fattr);
 345 extern int nfs_post_op_update_inode_force_wcc_locked(struct inode *inode, struct nfs_fattr *fattr);
 346 extern int nfs_getattr(struct vfsmount *, struct dentry *, struct kstat *);
 347 extern void nfs_access_add_cache(struct inode *, struct nfs_access_entry *);
 348 extern void nfs_access_set_mask(struct nfs_access_entry *, u32);
 349 extern int nfs_permission(struct inode *, int);
 350 extern int nfs_open(struct inode *, struct file *);
 351 extern int nfs_attribute_timeout(struct inode *inode);
 352 extern int nfs_attribute_cache_expired(struct inode *inode);
 353 extern int nfs_revalidate_inode(struct nfs_server *server, struct inode *inode);
 354 extern int nfs_revalidate_inode_rcu(struct nfs_server *server, struct inode *inode);
 355 extern int __nfs_revalidate_inode(struct nfs_server *, struct inode *);
 356 extern int nfs_revalidate_mapping(struct inode *inode, struct address_space *mapping);
 357 extern int nfs_revalidate_mapping_rcu(struct inode *inode);
 358 extern int nfs_setattr(struct dentry *, struct iattr *);
 359 extern void nfs_setattr_update_inode(struct inode *inode, struct iattr *attr, struct nfs_fattr *);
 360 extern void nfs_setsecurity(struct inode *inode, struct nfs_fattr *fattr,
 361                                 struct nfs4_label *label);
 362 extern struct nfs_open_context *get_nfs_open_context(struct nfs_open_context *ctx);
 363 extern void put_nfs_open_context(struct nfs_open_context *ctx);
 364 extern struct nfs_open_context *nfs_find_open_context(struct inode *inode, struct rpc_cred *cred, fmode_t mode);
 365 extern struct nfs_open_context *alloc_nfs_open_context(struct dentry *dentry, fmode_t f_mode);
 366 extern void nfs_inode_attach_open_context(struct nfs_open_context *ctx);
 367 extern void nfs_file_set_open_context(struct file *filp, struct nfs_open_context *ctx);
 368 extern void nfs_file_clear_open_context(struct file *flip);
 369 extern struct nfs_lock_context *nfs_get_lock_context(struct nfs_open_context *ctx);
 370 extern void nfs_put_lock_context(struct nfs_lock_context *l_ctx);
 371 extern u64 nfs_compat_user_ino64(u64 fileid);
 372 extern void nfs_fattr_init(struct nfs_fattr *fattr);
 373 extern void nfs_fattr_set_barrier(struct nfs_fattr *fattr);
 374 extern unsigned long nfs_inc_attr_generation_counter(void);
 375
 376 extern struct nfs_fattr *nfs_alloc_fattr(void);
 377
 378 static inline void nfs_free_fattr(const struct nfs_fattr *fattr)
 379 {
 380         kfree(fattr);
 381 }
 382
 383 extern struct nfs_fh *nfs_alloc_fhandle(void);
 384
 385 static inline void nfs_free_fhandle(const struct nfs_fh *fh)
 386 {
 387         kfree(fh);
 388 }
 389
 390 #ifdef NFS_DEBUG
 391 extern u32 _nfs_display_fhandle_hash(const struct nfs_fh *fh);
 392 static inline u32 nfs_display_fhandle_hash(const struct nfs_fh *fh)
 393 {
 394         return _nfs_display_fhandle_hash(fh);
 395 }
 396 extern void _nfs_display_fhandle(const struct nfs_fh *fh, const char *caption);
 397 #define nfs_display_fhandle(fh, caption)                        \
 398         do {                                                    \
 399                 if (unlikely(nfs_debug & NFSDBG_FACILITY))      \
 400                         _nfs_display_fhandle(fh, caption);      \
 401         } while (0)
 402 #else
 403 static inline u32 nfs_display_fhandle_hash(const struct nfs_fh *fh)
 404 {
 405         return 0;
 406 }
 407 static inline void nfs_display_fhandle(const struct nfs_fh *fh,
 408                                        const char *caption)
 409 {
 410 }
 411 #endif
 412
 413 /*
 414  * linux/fs/nfs/nfsroot.c
 415  */
 416 extern int  nfs_root_data(char **root_device, char **root_data); /*__init*/
 417 /* linux/net/ipv4/ipconfig.c: trims ip addr off front of name, too. */
 418 extern __be32 root_nfs_parse_addr(char *name); /*__init*/
 419
 420 /*
 421  * linux/fs/nfs/file.c
 422  */
 423 extern const struct file_operations nfs_file_operations;
 424 #if IS_ENABLED(CONFIG_NFS_V4)
 425 extern const struct file_operations nfs4_file_operations;
 426 #endif /* CONFIG_NFS_V4 */
 427 extern const struct address_space_operations nfs_file_aops;
 428 extern const struct address_space_operations nfs_dir_aops;
 429
 430 static inline struct nfs_open_context *nfs_file_open_context(struct file *filp)
 431 {
 432         return filp->private_data;
 433 }
 434
 435 static inline struct rpc_cred *nfs_file_cred(struct file *file)
 436 {
 437         if (file != NULL) {
 438                 struct nfs_open_context *ctx =
 439                         nfs_file_open_context(file);
 440                 if (ctx)
 441                         return ctx->cred;
 442         }
 443         return NULL;
 444 }
 445
 446 /*
 447  * linux/fs/nfs/direct.c
 448  */
 449 extern ssize_t nfs_direct_IO(struct kiocb *, struct iov_iter *);
 450 extern ssize_t nfs_file_direct_read(struct kiocb *iocb,
 451                         struct iov_iter *iter);
 452 extern ssize_t nfs_file_direct_write(struct kiocb *iocb,
 453                         struct iov_iter *iter);
 454
 455 /*
 456  * linux/fs/nfs/dir.c
 457  */
 458 extern const struct file_operations nfs_dir_operations;
 459 extern const struct dentry_operations nfs_dentry_operations;
 460
 461 extern void nfs_force_lookup_revalidate(struct inode *dir);
 462 extern int nfs_instantiate(struct dentry *dentry, struct nfs_fh *fh,
 463                         struct nfs_fattr *fattr, struct nfs4_label *label);
 464 extern int nfs_may_open(struct inode *inode, struct rpc_cred *cred, int openflags);
 465 extern void nfs_access_zap_cache(struct inode *inode);
 466
 467 /*
 468  * linux/fs/nfs/symlink.c
 469  */
 470 extern const struct inode_operations nfs_symlink_inode_operations;
 471
 472 /*
 473  * linux/fs/nfs/sysctl.c
 474  */
 475 #ifdef CONFIG_SYSCTL
 476 extern int nfs_register_sysctl(void);
 477 extern 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  */
 486 extern const struct inode_operations nfs_mountpoint_inode_operations;
 487 extern const struct inode_operations nfs_referral_inode_operations;
 488 extern int nfs_mountpoint_expiry_timeout;
 489 extern void nfs_release_automount_timer(void);
 490
 491 /*
 492  * linux/fs/nfs/unlink.c
 493  */
 494 extern void nfs_complete_unlink(struct dentry *dentry, struct inode *);
 495
 496 /*
 497  * linux/fs/nfs/write.c
 498  */
 499 extern int  nfs_congestion_kb;
 500 extern int  nfs_writepage(struct page *page, struct writeback_control *wbc);
 501 extern int  nfs_writepages(struct address_space *, struct writeback_control *);
 502 extern int  nfs_flush_incompatible(struct file *file, struct page *page);
 503 extern int  nfs_updatepage(struct file *, struct page *, unsigned int, unsigned int);
 504
 505 /*
 506  * Try to write back everything synchronously (but check the
 507  * return value!)
 508  */
 509 extern int nfs_sync_inode(struct inode *inode);
 510 extern int nfs_wb_all(struct inode *inode);
 511 extern int nfs_wb_single_page(struct inode *inode, struct page *page, bool launder);
 512 extern int nfs_wb_page_cancel(struct inode *inode, struct page* page);
 513 extern int  nfs_commit_inode(struct inode *, int);
 514 extern struct nfs_commit_data *nfs_commitdata_alloc(void);
 515 extern void nfs_commit_free(struct nfs_commit_data *data);
 516
 517 static inline int
 518 nfs_wb_launder_page(struct inode *inode, struct page *page)
 519 {
 520         return nfs_wb_single_page(inode, page, true);
 521 }
 522
 523 static inline int
 524 nfs_wb_page(struct inode *inode, struct page *page)
 525 {
 526         return nfs_wb_single_page(inode, page, false);
 527 }
 528
 529 static inline int
 530 nfs_have_writebacks(struct inode *inode)
 531 {
 532         return NFS_I(inode)->nrequests != 0;
 533 }
 534
 535 /*
 536  * linux/fs/nfs/read.c
 537  */
 538 extern int  nfs_readpage(struct file *, struct page *);
 539 extern int  nfs_readpages(struct file *, struct address_space *,
 540                 struct list_head *, unsigned);
 541 extern int  nfs_readpage_async(struct nfs_open_context *, struct inode *,
 542                                struct page *);
 543
 544 /*
 545  * inline functions
 546  */
 547
 548 static inline loff_t nfs_size_to_loff_t(__u64 size)
 549 {
 550         return min_t(u64, size, OFFSET_MAX);
 551 }
 552
 553 static inline ino_t
 554 nfs_fileid_to_ino_t(u64 fileid)
 555 {
 556         ino_t ino = (ino_t) fileid;
 557         if (sizeof(ino_t) < sizeof(u64))
 558                 ino ^= fileid >> (sizeof(u64)-sizeof(ino_t)) * 8;
 559         return ino;
 560 }
 561
 562 #define NFS_JUKEBOX_RETRY_TIME (5 * HZ)
 563
 564
 565 # undef ifdebug
 566 # ifdef NFS_DEBUG
 567 #  define ifdebug(fac)          if (unlikely(nfs_debug & NFSDBG_##fac))
 568 #  define NFS_IFDEBUG(x)        x
 569 # else
 570 #  define ifdebug(fac)          if (0)
 571 #  define NFS_IFDEBUG(x)
 572 # endif
 573 #endif