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