1 /* SPDX-License-Identifier: GPL-2.0 */ 2 /* 3 * linux/include/linux/nfs_fs.h 4 * 5 * Copyright (C) 1992 Rick Sladkey 6 * 7 * OS-specific nfs filesystem definitions and declarations 8 */ 9 #ifndef _LINUX_NFS_FS_H 10 #define _LINUX_NFS_FS_H 11 12 #include <uapi/linux/nfs_fs.h> 13 14 15 /* 16 * Enable dprintk() debugging support for nfs client. 17 */ 18 #ifdef CONFIG_NFS_DEBUG 19 # define NFS_DEBUG 20 #endif 21 22 #include <linux/in.h> 23 #include <linux/mm.h> 24 #include <linux/pagemap.h> 25 #include <linux/rbtree.h> 26 #include <linux/refcount.h> 27 #include <linux/rwsem.h> 28 #include <linux/wait.h> 29 30 #include <linux/sunrpc/debug.h> 31 #include <linux/sunrpc/auth.h> 32 #include <linux/sunrpc/clnt.h> 33 34 #include <linux/nfs.h> 35 #include <linux/nfs2.h> 36 #include <linux/nfs3.h> 37 #include <linux/nfs4.h> 38 #include <linux/nfs_xdr.h> 39 #include <linux/nfs_fs_sb.h> 40 41 #include <linux/mempool.h> 42 43 /* 44 * These are the default flags for swap requests 45 */ 46 #define NFS_RPC_SWAPFLAGS (RPC_TASK_SWAPPER|RPC_TASK_ROOTCREDS) 47 48 /* 49 * Size of the NFS directory verifier 50 */ 51 #define NFS_DIR_VERIFIER_SIZE 2 52 53 /* 54 * NFSv3/v4 Access mode cache entry 55 */ 56 struct nfs_access_entry { 57 struct rb_node rb_node; 58 struct list_head lru; 59 const struct cred * cred; 60 __u32 mask; 61 struct rcu_head rcu_head; 62 }; 63 64 struct nfs_lock_context { 65 refcount_t count; 66 struct list_head list; 67 struct nfs_open_context *open_context; 68 fl_owner_t lockowner; 69 atomic_t io_count; 70 struct rcu_head rcu_head; 71 }; 72 73 struct nfs4_state; 74 struct nfs_open_context { 75 struct nfs_lock_context lock_context; 76 fl_owner_t flock_owner; 77 struct dentry *dentry; 78 const struct cred *cred; 79 struct rpc_cred *ll_cred; /* low-level cred - use to check for expiry */ 80 struct nfs4_state *state; 81 fmode_t mode; 82 83 unsigned long flags; 84 #define NFS_CONTEXT_RESEND_WRITES (1) 85 #define NFS_CONTEXT_BAD (2) 86 #define NFS_CONTEXT_UNLOCK (3) 87 #define NFS_CONTEXT_FILE_OPEN (4) 88 int error; 89 90 struct list_head list; 91 struct nfs4_threshold *mdsthreshold; 92 struct rcu_head rcu_head; 93 }; 94 95 struct nfs_open_dir_context { 96 struct list_head list; 97 unsigned long attr_gencount; 98 __be32 verf[NFS_DIR_VERIFIER_SIZE]; 99 __u64 dir_cookie; 100 __u64 dup_cookie; 101 signed char duped; 102 }; 103 104 /* 105 * NFSv4 delegation 106 */ 107 struct nfs_delegation; 108 109 struct posix_acl; 110 111 struct nfs4_xattr_cache; 112 113 /* 114 * nfs fs inode data in memory 115 */ 116 struct nfs_inode { 117 /* 118 * The 64bit 'inode number' 119 */ 120 __u64 fileid; 121 122 /* 123 * NFS file handle 124 */ 125 struct nfs_fh fh; 126 127 /* 128 * Various flags 129 */ 130 unsigned long flags; /* atomic bit ops */ 131 unsigned long cache_validity; /* bit mask */ 132 133 /* 134 * read_cache_jiffies is when we started read-caching this inode. 135 * attrtimeo is for how long the cached information is assumed 136 * to be valid. A successful attribute revalidation doubles 137 * attrtimeo (up to acregmax/acdirmax), a failure resets it to 138 * acregmin/acdirmin. 139 * 140 * We need to revalidate the cached attrs for this inode if 141 * 142 * jiffies - read_cache_jiffies >= attrtimeo 143 * 144 * Please note the comparison is greater than or equal 145 * so that zero timeout values can be specified. 146 */ 147 unsigned long read_cache_jiffies; 148 unsigned long attrtimeo; 149 unsigned long attrtimeo_timestamp; 150 151 unsigned long attr_gencount; 152 /* "Generation counter" for the attribute cache. This is 153 * bumped whenever we update the metadata on the 154 * server. 155 */ 156 unsigned long cache_change_attribute; 157 158 struct rb_root access_cache; 159 struct list_head access_cache_entry_lru; 160 struct list_head access_cache_inode_lru; 161 162 /* 163 * This is the cookie verifier used for NFSv3 readdir 164 * operations 165 */ 166 __be32 cookieverf[NFS_DIR_VERIFIER_SIZE]; 167 168 atomic_long_t nrequests; 169 struct nfs_mds_commit_info commit_info; 170 171 /* Open contexts for shared mmap writes */ 172 struct list_head open_files; 173 174 /* Readers: in-flight sillydelete RPC calls */ 175 /* Writers: rmdir */ 176 struct rw_semaphore rmdir_sem; 177 struct mutex commit_mutex; 178 179 /* track last access to cached pages */ 180 unsigned long page_index; 181 182 #if IS_ENABLED(CONFIG_NFS_V4) 183 struct nfs4_cached_acl *nfs4_acl; 184 /* NFSv4 state */ 185 struct list_head open_states; 186 struct nfs_delegation __rcu *delegation; 187 struct rw_semaphore rwsem; 188 189 /* pNFS layout information */ 190 struct pnfs_layout_hdr *layout; 191 #endif /* CONFIG_NFS_V4*/ 192 /* how many bytes have been written/read and how many bytes queued up */ 193 __u64 write_io; 194 __u64 read_io; 195 #ifdef CONFIG_NFS_FSCACHE 196 struct fscache_cookie *fscache; 197 #endif 198 struct inode vfs_inode; 199 200 #ifdef CONFIG_NFS_V4_2 201 struct nfs4_xattr_cache *xattr_cache; 202 #endif 203 }; 204 205 struct nfs4_copy_state { 206 struct list_head copies; 207 struct list_head src_copies; 208 nfs4_stateid stateid; 209 struct completion completion; 210 uint64_t count; 211 struct nfs_writeverf verf; 212 int error; 213 int flags; 214 struct nfs4_state *parent_src_state; 215 struct nfs4_state *parent_dst_state; 216 }; 217 218 /* 219 * Access bit flags 220 */ 221 #define NFS_ACCESS_READ 0x0001 222 #define NFS_ACCESS_LOOKUP 0x0002 223 #define NFS_ACCESS_MODIFY 0x0004 224 #define NFS_ACCESS_EXTEND 0x0008 225 #define NFS_ACCESS_DELETE 0x0010 226 #define NFS_ACCESS_EXECUTE 0x0020 227 #define NFS_ACCESS_XAREAD 0x0040 228 #define NFS_ACCESS_XAWRITE 0x0080 229 #define NFS_ACCESS_XALIST 0x0100 230 231 /* 232 * Cache validity bit flags 233 */ 234 #define NFS_INO_INVALID_DATA BIT(1) /* cached data is invalid */ 235 #define NFS_INO_INVALID_ATIME BIT(2) /* cached atime is invalid */ 236 #define NFS_INO_INVALID_ACCESS BIT(3) /* cached access cred invalid */ 237 #define NFS_INO_INVALID_ACL BIT(4) /* cached acls are invalid */ 238 #define NFS_INO_REVAL_PAGECACHE BIT(5) /* must revalidate pagecache */ 239 #define NFS_INO_REVAL_FORCED BIT(6) /* force revalidation ignoring a delegation */ 240 #define NFS_INO_INVALID_LABEL BIT(7) /* cached label is invalid */ 241 #define NFS_INO_INVALID_CHANGE BIT(8) /* cached change is invalid */ 242 #define NFS_INO_INVALID_CTIME BIT(9) /* cached ctime is invalid */ 243 #define NFS_INO_INVALID_MTIME BIT(10) /* cached mtime is invalid */ 244 #define NFS_INO_INVALID_SIZE BIT(11) /* cached size is invalid */ 245 #define NFS_INO_INVALID_OTHER BIT(12) /* other attrs are invalid */ 246 #define NFS_INO_DATA_INVAL_DEFER \ 247 BIT(13) /* Deferred cache invalidation */ 248 #define NFS_INO_INVALID_BLOCKS BIT(14) /* cached blocks are invalid */ 249 #define NFS_INO_INVALID_XATTR BIT(15) /* xattrs are invalid */ 250 #define NFS_INO_INVALID_NLINK BIT(16) /* cached nlinks is invalid */ 251 #define NFS_INO_INVALID_MODE BIT(17) /* cached mode is invalid */ 252 253 #define NFS_INO_INVALID_ATTR (NFS_INO_INVALID_CHANGE \ 254 | NFS_INO_INVALID_CTIME \ 255 | NFS_INO_INVALID_MTIME \ 256 | NFS_INO_INVALID_SIZE \ 257 | NFS_INO_INVALID_NLINK \ 258 | NFS_INO_INVALID_MODE \ 259 | NFS_INO_INVALID_OTHER) /* inode metadata is invalid */ 260 261 /* 262 * Bit offsets in flags field 263 */ 264 #define NFS_INO_ADVISE_RDPLUS (0) /* advise readdirplus */ 265 #define NFS_INO_STALE (1) /* possible stale inode */ 266 #define NFS_INO_ACL_LRU_SET (2) /* Inode is on the LRU list */ 267 #define NFS_INO_INVALIDATING (3) /* inode is being invalidated */ 268 #define NFS_INO_FSCACHE (5) /* inode can be cached by FS-Cache */ 269 #define NFS_INO_FSCACHE_LOCK (6) /* FS-Cache cookie management lock */ 270 #define NFS_INO_LAYOUTCOMMIT (9) /* layoutcommit required */ 271 #define NFS_INO_LAYOUTCOMMITTING (10) /* layoutcommit inflight */ 272 #define NFS_INO_LAYOUTSTATS (11) /* layoutstats inflight */ 273 #define NFS_INO_ODIRECT (12) /* I/O setting is O_DIRECT */ 274 275 static inline struct nfs_inode *NFS_I(const struct inode *inode) 276 { 277 return container_of(inode, struct nfs_inode, vfs_inode); 278 } 279 280 static inline struct nfs_server *NFS_SB(const struct super_block *s) 281 { 282 return (struct nfs_server *)(s->s_fs_info); 283 } 284 285 static inline struct nfs_fh *NFS_FH(const struct inode *inode) 286 { 287 return &NFS_I(inode)->fh; 288 } 289 290 static inline struct nfs_server *NFS_SERVER(const struct inode *inode) 291 { 292 return NFS_SB(inode->i_sb); 293 } 294 295 static inline struct rpc_clnt *NFS_CLIENT(const struct inode *inode) 296 { 297 return NFS_SERVER(inode)->client; 298 } 299 300 static inline const struct nfs_rpc_ops *NFS_PROTO(const struct inode *inode) 301 { 302 return NFS_SERVER(inode)->nfs_client->rpc_ops; 303 } 304 305 static inline unsigned NFS_MINATTRTIMEO(const struct inode *inode) 306 { 307 struct nfs_server *nfss = NFS_SERVER(inode); 308 return S_ISDIR(inode->i_mode) ? nfss->acdirmin : nfss->acregmin; 309 } 310 311 static inline unsigned NFS_MAXATTRTIMEO(const struct inode *inode) 312 { 313 struct nfs_server *nfss = NFS_SERVER(inode); 314 return S_ISDIR(inode->i_mode) ? nfss->acdirmax : nfss->acregmax; 315 } 316 317 static inline int NFS_STALE(const struct inode *inode) 318 { 319 return test_bit(NFS_INO_STALE, &NFS_I(inode)->flags); 320 } 321 322 static inline struct fscache_cookie *nfs_i_fscache(struct inode *inode) 323 { 324 #ifdef CONFIG_NFS_FSCACHE 325 return NFS_I(inode)->fscache; 326 #else 327 return NULL; 328 #endif 329 } 330 331 static inline __u64 NFS_FILEID(const struct inode *inode) 332 { 333 return NFS_I(inode)->fileid; 334 } 335 336 static inline void set_nfs_fileid(struct inode *inode, __u64 fileid) 337 { 338 NFS_I(inode)->fileid = fileid; 339 } 340 341 static inline void nfs_mark_for_revalidate(struct inode *inode) 342 { 343 struct nfs_inode *nfsi = NFS_I(inode); 344 345 spin_lock(&inode->i_lock); 346 nfsi->cache_validity |= NFS_INO_REVAL_PAGECACHE 347 | NFS_INO_INVALID_ACCESS 348 | NFS_INO_INVALID_ACL 349 | NFS_INO_INVALID_CHANGE 350 | NFS_INO_INVALID_CTIME; 351 if (S_ISDIR(inode->i_mode)) 352 nfsi->cache_validity |= NFS_INO_INVALID_DATA; 353 spin_unlock(&inode->i_lock); 354 } 355 356 static inline int nfs_server_capable(struct inode *inode, int cap) 357 { 358 return NFS_SERVER(inode)->caps & cap; 359 } 360 361 /** 362 * nfs_save_change_attribute - Returns the inode attribute change cookie 363 * @dir - pointer to parent directory inode 364 * The "cache change attribute" is updated when we need to revalidate 365 * our dentry cache after a directory was seen to change on the server. 366 */ 367 static inline unsigned long nfs_save_change_attribute(struct inode *dir) 368 { 369 return NFS_I(dir)->cache_change_attribute; 370 } 371 372 /* 373 * linux/fs/nfs/inode.c 374 */ 375 extern int nfs_sync_mapping(struct address_space *mapping); 376 extern void nfs_zap_mapping(struct inode *inode, struct address_space *mapping); 377 extern void nfs_zap_caches(struct inode *); 378 extern void nfs_set_inode_stale(struct inode *inode); 379 extern void nfs_invalidate_atime(struct inode *); 380 extern struct inode *nfs_fhget(struct super_block *, struct nfs_fh *, 381 struct nfs_fattr *, struct nfs4_label *); 382 struct inode *nfs_ilookup(struct super_block *sb, struct nfs_fattr *, struct nfs_fh *); 383 extern int nfs_refresh_inode(struct inode *, struct nfs_fattr *); 384 extern int nfs_post_op_update_inode(struct inode *inode, struct nfs_fattr *fattr); 385 extern int nfs_post_op_update_inode_force_wcc(struct inode *inode, struct nfs_fattr *fattr); 386 extern int nfs_post_op_update_inode_force_wcc_locked(struct inode *inode, struct nfs_fattr *fattr); 387 extern int nfs_getattr(struct user_namespace *, const struct path *, 388 struct kstat *, u32, unsigned int); 389 extern void nfs_access_add_cache(struct inode *, struct nfs_access_entry *); 390 extern void nfs_access_set_mask(struct nfs_access_entry *, u32); 391 extern int nfs_permission(struct user_namespace *, struct inode *, int); 392 extern int nfs_open(struct inode *, struct file *); 393 extern int nfs_attribute_cache_expired(struct inode *inode); 394 extern int nfs_revalidate_inode(struct inode *inode, unsigned long flags); 395 extern int __nfs_revalidate_inode(struct nfs_server *, struct inode *); 396 extern int nfs_clear_invalid_mapping(struct address_space *mapping); 397 extern bool nfs_mapping_need_revalidate_inode(struct inode *inode); 398 extern int nfs_revalidate_mapping(struct inode *inode, struct address_space *mapping); 399 extern int nfs_revalidate_mapping_rcu(struct inode *inode); 400 extern int nfs_setattr(struct user_namespace *, struct dentry *, struct iattr *); 401 extern void nfs_setattr_update_inode(struct inode *inode, struct iattr *attr, struct nfs_fattr *); 402 extern void nfs_setsecurity(struct inode *inode, struct nfs_fattr *fattr, 403 struct nfs4_label *label); 404 extern struct nfs_open_context *get_nfs_open_context(struct nfs_open_context *ctx); 405 extern void put_nfs_open_context(struct nfs_open_context *ctx); 406 extern struct nfs_open_context *nfs_find_open_context(struct inode *inode, const struct cred *cred, fmode_t mode); 407 extern struct nfs_open_context *alloc_nfs_open_context(struct dentry *dentry, fmode_t f_mode, struct file *filp); 408 extern void nfs_inode_attach_open_context(struct nfs_open_context *ctx); 409 extern void nfs_file_set_open_context(struct file *filp, struct nfs_open_context *ctx); 410 extern void nfs_file_clear_open_context(struct file *flip); 411 extern struct nfs_lock_context *nfs_get_lock_context(struct nfs_open_context *ctx); 412 extern void nfs_put_lock_context(struct nfs_lock_context *l_ctx); 413 extern u64 nfs_compat_user_ino64(u64 fileid); 414 extern void nfs_fattr_init(struct nfs_fattr *fattr); 415 extern void nfs_fattr_set_barrier(struct nfs_fattr *fattr); 416 extern unsigned long nfs_inc_attr_generation_counter(void); 417 418 extern struct nfs_fattr *nfs_alloc_fattr(void); 419 420 static inline void nfs_free_fattr(const struct nfs_fattr *fattr) 421 { 422 kfree(fattr); 423 } 424 425 extern struct nfs_fh *nfs_alloc_fhandle(void); 426 427 static inline void nfs_free_fhandle(const struct nfs_fh *fh) 428 { 429 kfree(fh); 430 } 431 432 #ifdef NFS_DEBUG 433 extern u32 _nfs_display_fhandle_hash(const struct nfs_fh *fh); 434 static inline u32 nfs_display_fhandle_hash(const struct nfs_fh *fh) 435 { 436 return _nfs_display_fhandle_hash(fh); 437 } 438 extern void _nfs_display_fhandle(const struct nfs_fh *fh, const char *caption); 439 #define nfs_display_fhandle(fh, caption) \ 440 do { \ 441 if (unlikely(nfs_debug & NFSDBG_FACILITY)) \ 442 _nfs_display_fhandle(fh, caption); \ 443 } while (0) 444 #else 445 static inline u32 nfs_display_fhandle_hash(const struct nfs_fh *fh) 446 { 447 return 0; 448 } 449 static inline void nfs_display_fhandle(const struct nfs_fh *fh, 450 const char *caption) 451 { 452 } 453 #endif 454 455 /* 456 * linux/fs/nfs/nfsroot.c 457 */ 458 extern int nfs_root_data(char **root_device, char **root_data); /*__init*/ 459 /* linux/net/ipv4/ipconfig.c: trims ip addr off front of name, too. */ 460 extern __be32 root_nfs_parse_addr(char *name); /*__init*/ 461 462 /* 463 * linux/fs/nfs/file.c 464 */ 465 extern const struct file_operations nfs_file_operations; 466 #if IS_ENABLED(CONFIG_NFS_V4) 467 extern const struct file_operations nfs4_file_operations; 468 #endif /* CONFIG_NFS_V4 */ 469 extern const struct address_space_operations nfs_file_aops; 470 extern const struct address_space_operations nfs_dir_aops; 471 472 static inline struct nfs_open_context *nfs_file_open_context(struct file *filp) 473 { 474 return filp->private_data; 475 } 476 477 static inline const struct cred *nfs_file_cred(struct file *file) 478 { 479 if (file != NULL) { 480 struct nfs_open_context *ctx = 481 nfs_file_open_context(file); 482 if (ctx) 483 return ctx->cred; 484 } 485 return NULL; 486 } 487 488 /* 489 * linux/fs/nfs/direct.c 490 */ 491 extern ssize_t nfs_direct_IO(struct kiocb *, struct iov_iter *); 492 extern ssize_t nfs_file_direct_read(struct kiocb *iocb, 493 struct iov_iter *iter); 494 extern ssize_t nfs_file_direct_write(struct kiocb *iocb, 495 struct iov_iter *iter); 496 497 /* 498 * linux/fs/nfs/dir.c 499 */ 500 extern const struct file_operations nfs_dir_operations; 501 extern const struct dentry_operations nfs_dentry_operations; 502 503 extern void nfs_force_lookup_revalidate(struct inode *dir); 504 extern void nfs_set_verifier(struct dentry * dentry, unsigned long verf); 505 #if IS_ENABLED(CONFIG_NFS_V4) 506 extern void nfs_clear_verifier_delegated(struct inode *inode); 507 #endif /* IS_ENABLED(CONFIG_NFS_V4) */ 508 extern struct dentry *nfs_add_or_obtain(struct dentry *dentry, 509 struct nfs_fh *fh, struct nfs_fattr *fattr, 510 struct nfs4_label *label); 511 extern int nfs_instantiate(struct dentry *dentry, struct nfs_fh *fh, 512 struct nfs_fattr *fattr, struct nfs4_label *label); 513 extern int nfs_may_open(struct inode *inode, const struct cred *cred, int openflags); 514 extern void nfs_access_zap_cache(struct inode *inode); 515 extern int nfs_access_get_cached(struct inode *inode, const struct cred *cred, struct nfs_access_entry *res, 516 bool may_block); 517 518 /* 519 * linux/fs/nfs/symlink.c 520 */ 521 extern const struct inode_operations nfs_symlink_inode_operations; 522 523 /* 524 * linux/fs/nfs/sysctl.c 525 */ 526 #ifdef CONFIG_SYSCTL 527 extern int nfs_register_sysctl(void); 528 extern void nfs_unregister_sysctl(void); 529 #else 530 #define nfs_register_sysctl() 0 531 #define nfs_unregister_sysctl() do { } while(0) 532 #endif 533 534 /* 535 * linux/fs/nfs/namespace.c 536 */ 537 extern const struct inode_operations nfs_mountpoint_inode_operations; 538 extern const struct inode_operations nfs_referral_inode_operations; 539 extern int nfs_mountpoint_expiry_timeout; 540 extern void nfs_release_automount_timer(void); 541 542 /* 543 * linux/fs/nfs/unlink.c 544 */ 545 extern void nfs_complete_unlink(struct dentry *dentry, struct inode *); 546 547 /* 548 * linux/fs/nfs/write.c 549 */ 550 extern int nfs_congestion_kb; 551 extern int nfs_writepage(struct page *page, struct writeback_control *wbc); 552 extern int nfs_writepages(struct address_space *, struct writeback_control *); 553 extern int nfs_flush_incompatible(struct file *file, struct page *page); 554 extern int nfs_updatepage(struct file *, struct page *, unsigned int, unsigned int); 555 556 /* 557 * Try to write back everything synchronously (but check the 558 * return value!) 559 */ 560 extern int nfs_sync_inode(struct inode *inode); 561 extern int nfs_wb_all(struct inode *inode); 562 extern int nfs_wb_page(struct inode *inode, struct page *page); 563 extern int nfs_wb_page_cancel(struct inode *inode, struct page* page); 564 extern int nfs_commit_inode(struct inode *, int); 565 extern struct nfs_commit_data *nfs_commitdata_alloc(bool never_fail); 566 extern void nfs_commit_free(struct nfs_commit_data *data); 567 568 static inline int 569 nfs_have_writebacks(struct inode *inode) 570 { 571 return atomic_long_read(&NFS_I(inode)->nrequests) != 0; 572 } 573 574 /* 575 * linux/fs/nfs/read.c 576 */ 577 extern int nfs_readpage(struct file *, struct page *); 578 extern int nfs_readpages(struct file *, struct address_space *, 579 struct list_head *, unsigned); 580 581 /* 582 * inline functions 583 */ 584 585 static inline loff_t nfs_size_to_loff_t(__u64 size) 586 { 587 return min_t(u64, size, OFFSET_MAX); 588 } 589 590 static inline ino_t 591 nfs_fileid_to_ino_t(u64 fileid) 592 { 593 ino_t ino = (ino_t) fileid; 594 if (sizeof(ino_t) < sizeof(u64)) 595 ino ^= fileid >> (sizeof(u64)-sizeof(ino_t)) * 8; 596 return ino; 597 } 598 599 #define NFS_JUKEBOX_RETRY_TIME (5 * HZ) 600 601 602 # undef ifdebug 603 # ifdef NFS_DEBUG 604 # define ifdebug(fac) if (unlikely(nfs_debug & NFSDBG_##fac)) 605 # define NFS_IFDEBUG(x) x 606 # else 607 # define ifdebug(fac) if (0) 608 # define NFS_IFDEBUG(x) 609 # endif 610 #endif 611