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