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