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