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