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