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