1 /* SPDX-License-Identifier: GPL-2.0 */
3 * linux/include/linux/nfs_fs.h
5 * Copyright (C) 1992 Rick Sladkey
7 * OS-specific nfs filesystem definitions and declarations
9 #ifndef _LINUX_NFS_FS_H
10 #define _LINUX_NFS_FS_H
12 #include <uapi/linux/nfs_fs.h>
16 * Enable dprintk() debugging support for nfs client.
18 #ifdef CONFIG_NFS_DEBUG
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>
30 #include <linux/sunrpc/debug.h>
31 #include <linux/sunrpc/auth.h>
32 #include <linux/sunrpc/clnt.h>
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>
41 #include <linux/mempool.h>
44 * These are the default flags for swap requests
46 #define NFS_RPC_SWAPFLAGS (RPC_TASK_SWAPPER|RPC_TASK_ROOTCREDS)
49 * Size of the NFS directory verifier
51 #define NFS_DIR_VERIFIER_SIZE 2
54 * NFSv3/v4 Access mode cache entry
56 struct nfs_access_entry {
57 struct rb_node rb_node;
59 const struct cred * cred;
61 struct rcu_head rcu_head;
64 struct nfs_lock_context {
66 struct list_head list;
67 struct nfs_open_context *open_context;
70 struct rcu_head rcu_head;
74 struct nfs_open_context {
75 struct nfs_lock_context lock_context;
76 fl_owner_t flock_owner;
77 struct dentry *dentry;
78 const struct cred *cred;
79 struct rpc_cred *ll_cred; /* low-level cred - use to check for expiry */
80 struct nfs4_state *state;
84 #define NFS_CONTEXT_RESEND_WRITES (1)
85 #define NFS_CONTEXT_BAD (2)
86 #define NFS_CONTEXT_UNLOCK (3)
89 struct list_head list;
90 struct nfs4_threshold *mdsthreshold;
91 struct rcu_head rcu_head;
94 struct nfs_open_dir_context {
95 struct list_head list;
96 unsigned long attr_gencount;
97 __be32 verf[NFS_DIR_VERIFIER_SIZE];
106 struct nfs_delegation;
110 struct nfs4_xattr_cache;
113 * nfs fs inode data in memory
117 * The 64bit 'inode number'
129 unsigned long flags; /* atomic bit ops */
130 unsigned long cache_validity; /* bit mask */
133 * read_cache_jiffies is when we started read-caching this inode.
134 * attrtimeo is for how long the cached information is assumed
135 * to be valid. A successful attribute revalidation doubles
136 * attrtimeo (up to acregmax/acdirmax), a failure resets it to
139 * We need to revalidate the cached attrs for this inode if
141 * jiffies - read_cache_jiffies >= attrtimeo
143 * Please note the comparison is greater than or equal
144 * so that zero timeout values can be specified.
146 unsigned long read_cache_jiffies;
147 unsigned long attrtimeo;
148 unsigned long attrtimeo_timestamp;
150 unsigned long attr_gencount;
151 /* "Generation counter" for the attribute cache. This is
152 * bumped whenever we update the metadata on the
155 unsigned long cache_change_attribute;
157 struct rb_root access_cache;
158 struct list_head access_cache_entry_lru;
159 struct list_head access_cache_inode_lru;
162 * This is the cookie verifier used for NFSv3 readdir
165 __be32 cookieverf[NFS_DIR_VERIFIER_SIZE];
167 atomic_long_t nrequests;
168 struct nfs_mds_commit_info commit_info;
170 /* Open contexts for shared mmap writes */
171 struct list_head open_files;
173 /* Readers: in-flight sillydelete RPC calls */
175 struct rw_semaphore rmdir_sem;
176 struct mutex commit_mutex;
178 /* track last access to cached pages */
179 unsigned long page_index;
181 #if IS_ENABLED(CONFIG_NFS_V4)
182 struct nfs4_cached_acl *nfs4_acl;
184 struct list_head open_states;
185 struct nfs_delegation __rcu *delegation;
186 struct rw_semaphore rwsem;
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 */
194 #ifdef CONFIG_NFS_FSCACHE
195 struct fscache_cookie *fscache;
197 struct inode vfs_inode;
199 #ifdef CONFIG_NFS_V4_2
200 struct nfs4_xattr_cache *xattr_cache;
204 struct nfs4_copy_state {
205 struct list_head copies;
206 struct list_head src_copies;
207 nfs4_stateid stateid;
208 struct completion completion;
210 struct nfs_writeverf verf;
213 struct nfs4_state *parent_src_state;
214 struct nfs4_state *parent_dst_state;
220 #define NFS_ACCESS_READ 0x0001
221 #define NFS_ACCESS_LOOKUP 0x0002
222 #define NFS_ACCESS_MODIFY 0x0004
223 #define NFS_ACCESS_EXTEND 0x0008
224 #define NFS_ACCESS_DELETE 0x0010
225 #define NFS_ACCESS_EXECUTE 0x0020
226 #define NFS_ACCESS_XAREAD 0x0040
227 #define NFS_ACCESS_XAWRITE 0x0080
228 #define NFS_ACCESS_XALIST 0x0100
231 * Cache validity bit flags
233 #define NFS_INO_INVALID_DATA BIT(1) /* cached data is invalid */
234 #define NFS_INO_INVALID_ATIME BIT(2) /* cached atime is invalid */
235 #define NFS_INO_INVALID_ACCESS BIT(3) /* cached access cred invalid */
236 #define NFS_INO_INVALID_ACL BIT(4) /* cached acls are invalid */
237 #define NFS_INO_REVAL_PAGECACHE BIT(5) /* must revalidate pagecache */
238 #define NFS_INO_REVAL_FORCED BIT(6) /* force revalidation ignoring a delegation */
239 #define NFS_INO_INVALID_LABEL BIT(7) /* cached label is invalid */
240 #define NFS_INO_INVALID_CHANGE BIT(8) /* cached change is invalid */
241 #define NFS_INO_INVALID_CTIME BIT(9) /* cached ctime is invalid */
242 #define NFS_INO_INVALID_MTIME BIT(10) /* cached mtime is invalid */
243 #define NFS_INO_INVALID_SIZE BIT(11) /* cached size is invalid */
244 #define NFS_INO_INVALID_OTHER BIT(12) /* other attrs are invalid */
245 #define NFS_INO_DATA_INVAL_DEFER \
246 BIT(13) /* Deferred cache invalidation */
247 #define NFS_INO_INVALID_BLOCKS BIT(14) /* cached blocks are invalid */
248 #define NFS_INO_INVALID_XATTR BIT(15) /* xattrs are invalid */
249 #define NFS_INO_INVALID_NLINK BIT(16) /* cached nlinks is invalid */
250 #define NFS_INO_INVALID_MODE BIT(17) /* cached mode is invalid */
252 #define NFS_INO_INVALID_ATTR (NFS_INO_INVALID_CHANGE \
253 | NFS_INO_INVALID_CTIME \
254 | NFS_INO_INVALID_MTIME \
255 | NFS_INO_INVALID_SIZE \
256 | NFS_INO_INVALID_NLINK \
257 | NFS_INO_INVALID_MODE \
258 | NFS_INO_INVALID_OTHER) /* inode metadata is invalid */
261 * Bit offsets in flags field
263 #define NFS_INO_ADVISE_RDPLUS (0) /* advise readdirplus */
264 #define NFS_INO_STALE (1) /* possible stale inode */
265 #define NFS_INO_ACL_LRU_SET (2) /* Inode is on the LRU list */
266 #define NFS_INO_INVALIDATING (3) /* inode is being invalidated */
267 #define NFS_INO_FSCACHE (5) /* inode can be cached by FS-Cache */
268 #define NFS_INO_FSCACHE_LOCK (6) /* FS-Cache cookie management lock */
269 #define NFS_INO_LAYOUTCOMMIT (9) /* layoutcommit required */
270 #define NFS_INO_LAYOUTCOMMITTING (10) /* layoutcommit inflight */
271 #define NFS_INO_LAYOUTSTATS (11) /* layoutstats inflight */
272 #define NFS_INO_ODIRECT (12) /* I/O setting is O_DIRECT */
274 static inline struct nfs_inode *NFS_I(const struct inode *inode)
276 return container_of(inode, struct nfs_inode, vfs_inode);
279 static inline struct nfs_server *NFS_SB(const struct super_block *s)
281 return (struct nfs_server *)(s->s_fs_info);
284 static inline struct nfs_fh *NFS_FH(const struct inode *inode)
286 return &NFS_I(inode)->fh;
289 static inline struct nfs_server *NFS_SERVER(const struct inode *inode)
291 return NFS_SB(inode->i_sb);
294 static inline struct rpc_clnt *NFS_CLIENT(const struct inode *inode)
296 return NFS_SERVER(inode)->client;
299 static inline const struct nfs_rpc_ops *NFS_PROTO(const struct inode *inode)
301 return NFS_SERVER(inode)->nfs_client->rpc_ops;
304 static inline unsigned NFS_MINATTRTIMEO(const struct inode *inode)
306 struct nfs_server *nfss = NFS_SERVER(inode);
307 return S_ISDIR(inode->i_mode) ? nfss->acdirmin : nfss->acregmin;
310 static inline unsigned NFS_MAXATTRTIMEO(const struct inode *inode)
312 struct nfs_server *nfss = NFS_SERVER(inode);
313 return S_ISDIR(inode->i_mode) ? nfss->acdirmax : nfss->acregmax;
316 static inline int NFS_STALE(const struct inode *inode)
318 return test_bit(NFS_INO_STALE, &NFS_I(inode)->flags);
321 static inline struct fscache_cookie *nfs_i_fscache(struct inode *inode)
323 #ifdef CONFIG_NFS_FSCACHE
324 return NFS_I(inode)->fscache;
330 static inline __u64 NFS_FILEID(const struct inode *inode)
332 return NFS_I(inode)->fileid;
335 static inline void set_nfs_fileid(struct inode *inode, __u64 fileid)
337 NFS_I(inode)->fileid = fileid;
340 static inline void nfs_mark_for_revalidate(struct inode *inode)
342 struct nfs_inode *nfsi = NFS_I(inode);
344 spin_lock(&inode->i_lock);
345 nfsi->cache_validity |= NFS_INO_REVAL_PAGECACHE
346 | NFS_INO_INVALID_ACCESS
347 | NFS_INO_INVALID_ACL
348 | NFS_INO_INVALID_CHANGE
349 | NFS_INO_INVALID_CTIME;
350 if (S_ISDIR(inode->i_mode))
351 nfsi->cache_validity |= NFS_INO_INVALID_DATA;
352 spin_unlock(&inode->i_lock);
355 static inline int nfs_server_capable(struct inode *inode, int cap)
357 return NFS_SERVER(inode)->caps & cap;
361 * nfs_save_change_attribute - Returns the inode attribute change cookie
362 * @dir - pointer to parent directory inode
363 * The "cache change attribute" is updated when we need to revalidate
364 * our dentry cache after a directory was seen to change on the server.
366 static inline unsigned long nfs_save_change_attribute(struct inode *dir)
368 return NFS_I(dir)->cache_change_attribute;
372 * linux/fs/nfs/inode.c
374 extern int nfs_sync_mapping(struct address_space *mapping);
375 extern void nfs_zap_mapping(struct inode *inode, struct address_space *mapping);
376 extern void nfs_zap_caches(struct inode *);
377 extern void nfs_set_inode_stale(struct inode *inode);
378 extern void nfs_invalidate_atime(struct inode *);
379 extern struct inode *nfs_fhget(struct super_block *, struct nfs_fh *,
380 struct nfs_fattr *, struct nfs4_label *);
381 struct inode *nfs_ilookup(struct super_block *sb, struct nfs_fattr *, struct nfs_fh *);
382 extern int nfs_refresh_inode(struct inode *, struct nfs_fattr *);
383 extern int nfs_post_op_update_inode(struct inode *inode, struct nfs_fattr *fattr);
384 extern int nfs_post_op_update_inode_force_wcc(struct inode *inode, struct nfs_fattr *fattr);
385 extern int nfs_post_op_update_inode_force_wcc_locked(struct inode *inode, struct nfs_fattr *fattr);
386 extern int nfs_getattr(struct user_namespace *, const struct path *,
387 struct kstat *, u32, unsigned int);
388 extern void nfs_access_add_cache(struct inode *, struct nfs_access_entry *);
389 extern void nfs_access_set_mask(struct nfs_access_entry *, u32);
390 extern int nfs_permission(struct user_namespace *, struct inode *, int);
391 extern int nfs_open(struct inode *, struct file *);
392 extern int nfs_attribute_cache_expired(struct inode *inode);
393 extern int nfs_revalidate_inode(struct inode *inode, unsigned long flags);
394 extern int __nfs_revalidate_inode(struct nfs_server *, struct inode *);
395 extern int nfs_clear_invalid_mapping(struct address_space *mapping);
396 extern bool nfs_mapping_need_revalidate_inode(struct inode *inode);
397 extern int nfs_revalidate_mapping(struct inode *inode, struct address_space *mapping);
398 extern int nfs_revalidate_mapping_rcu(struct inode *inode);
399 extern int nfs_setattr(struct user_namespace *, struct dentry *, struct iattr *);
400 extern void nfs_setattr_update_inode(struct inode *inode, struct iattr *attr, struct nfs_fattr *);
401 extern void nfs_setsecurity(struct inode *inode, struct nfs_fattr *fattr,
402 struct nfs4_label *label);
403 extern struct nfs_open_context *get_nfs_open_context(struct nfs_open_context *ctx);
404 extern void put_nfs_open_context(struct nfs_open_context *ctx);
405 extern struct nfs_open_context *nfs_find_open_context(struct inode *inode, const struct cred *cred, fmode_t mode);
406 extern struct nfs_open_context *alloc_nfs_open_context(struct dentry *dentry, fmode_t f_mode, struct file *filp);
407 extern void nfs_inode_attach_open_context(struct nfs_open_context *ctx);
408 extern void nfs_file_set_open_context(struct file *filp, struct nfs_open_context *ctx);
409 extern void nfs_file_clear_open_context(struct file *flip);
410 extern struct nfs_lock_context *nfs_get_lock_context(struct nfs_open_context *ctx);
411 extern void nfs_put_lock_context(struct nfs_lock_context *l_ctx);
412 extern u64 nfs_compat_user_ino64(u64 fileid);
413 extern void nfs_fattr_init(struct nfs_fattr *fattr);
414 extern void nfs_fattr_set_barrier(struct nfs_fattr *fattr);
415 extern unsigned long nfs_inc_attr_generation_counter(void);
417 extern struct nfs_fattr *nfs_alloc_fattr(void);
419 static inline void nfs_free_fattr(const struct nfs_fattr *fattr)
424 extern struct nfs_fh *nfs_alloc_fhandle(void);
426 static inline void nfs_free_fhandle(const struct nfs_fh *fh)
432 extern u32 _nfs_display_fhandle_hash(const struct nfs_fh *fh);
433 static inline u32 nfs_display_fhandle_hash(const struct nfs_fh *fh)
435 return _nfs_display_fhandle_hash(fh);
437 extern void _nfs_display_fhandle(const struct nfs_fh *fh, const char *caption);
438 #define nfs_display_fhandle(fh, caption) \
440 if (unlikely(nfs_debug & NFSDBG_FACILITY)) \
441 _nfs_display_fhandle(fh, caption); \
444 static inline u32 nfs_display_fhandle_hash(const struct nfs_fh *fh)
448 static inline void nfs_display_fhandle(const struct nfs_fh *fh,
455 * linux/fs/nfs/nfsroot.c
457 extern int nfs_root_data(char **root_device, char **root_data); /*__init*/
458 /* linux/net/ipv4/ipconfig.c: trims ip addr off front of name, too. */
459 extern __be32 root_nfs_parse_addr(char *name); /*__init*/
462 * linux/fs/nfs/file.c
464 extern const struct file_operations nfs_file_operations;
465 #if IS_ENABLED(CONFIG_NFS_V4)
466 extern const struct file_operations nfs4_file_operations;
467 #endif /* CONFIG_NFS_V4 */
468 extern const struct address_space_operations nfs_file_aops;
469 extern const struct address_space_operations nfs_dir_aops;
471 static inline struct nfs_open_context *nfs_file_open_context(struct file *filp)
473 return filp->private_data;
476 static inline const struct cred *nfs_file_cred(struct file *file)
479 struct nfs_open_context *ctx =
480 nfs_file_open_context(file);
488 * linux/fs/nfs/direct.c
490 extern ssize_t nfs_direct_IO(struct kiocb *, struct iov_iter *);
491 extern ssize_t nfs_file_direct_read(struct kiocb *iocb,
492 struct iov_iter *iter);
493 extern ssize_t nfs_file_direct_write(struct kiocb *iocb,
494 struct iov_iter *iter);
499 extern const struct file_operations nfs_dir_operations;
500 extern const struct dentry_operations nfs_dentry_operations;
502 extern void nfs_force_lookup_revalidate(struct inode *dir);
503 extern void nfs_set_verifier(struct dentry * dentry, unsigned long verf);
504 #if IS_ENABLED(CONFIG_NFS_V4)
505 extern void nfs_clear_verifier_delegated(struct inode *inode);
506 #endif /* IS_ENABLED(CONFIG_NFS_V4) */
507 extern struct dentry *nfs_add_or_obtain(struct dentry *dentry,
508 struct nfs_fh *fh, struct nfs_fattr *fattr,
509 struct nfs4_label *label);
510 extern int nfs_instantiate(struct dentry *dentry, struct nfs_fh *fh,
511 struct nfs_fattr *fattr, struct nfs4_label *label);
512 extern int nfs_may_open(struct inode *inode, const struct cred *cred, int openflags);
513 extern void nfs_access_zap_cache(struct inode *inode);
514 extern int nfs_access_get_cached(struct inode *inode, const struct cred *cred, struct nfs_access_entry *res,
518 * linux/fs/nfs/symlink.c
520 extern const struct inode_operations nfs_symlink_inode_operations;
523 * linux/fs/nfs/sysctl.c
526 extern int nfs_register_sysctl(void);
527 extern void nfs_unregister_sysctl(void);
529 #define nfs_register_sysctl() 0
530 #define nfs_unregister_sysctl() do { } while(0)
534 * linux/fs/nfs/namespace.c
536 extern const struct inode_operations nfs_mountpoint_inode_operations;
537 extern const struct inode_operations nfs_referral_inode_operations;
538 extern int nfs_mountpoint_expiry_timeout;
539 extern void nfs_release_automount_timer(void);
542 * linux/fs/nfs/unlink.c
544 extern void nfs_complete_unlink(struct dentry *dentry, struct inode *);
547 * linux/fs/nfs/write.c
549 extern int nfs_congestion_kb;
550 extern int nfs_writepage(struct page *page, struct writeback_control *wbc);
551 extern int nfs_writepages(struct address_space *, struct writeback_control *);
552 extern int nfs_flush_incompatible(struct file *file, struct page *page);
553 extern int nfs_updatepage(struct file *, struct page *, unsigned int, unsigned int);
556 * Try to write back everything synchronously (but check the
559 extern int nfs_sync_inode(struct inode *inode);
560 extern int nfs_wb_all(struct inode *inode);
561 extern int nfs_wb_page(struct inode *inode, struct page *page);
562 extern int nfs_wb_page_cancel(struct inode *inode, struct page* page);
563 extern int nfs_commit_inode(struct inode *, int);
564 extern struct nfs_commit_data *nfs_commitdata_alloc(bool never_fail);
565 extern void nfs_commit_free(struct nfs_commit_data *data);
568 nfs_have_writebacks(struct inode *inode)
570 return atomic_long_read(&NFS_I(inode)->nrequests) != 0;
574 * linux/fs/nfs/read.c
576 extern int nfs_readpage(struct file *, struct page *);
577 extern int nfs_readpages(struct file *, struct address_space *,
578 struct list_head *, unsigned);
584 static inline loff_t nfs_size_to_loff_t(__u64 size)
586 return min_t(u64, size, OFFSET_MAX);
590 nfs_fileid_to_ino_t(u64 fileid)
592 ino_t ino = (ino_t) fileid;
593 if (sizeof(ino_t) < sizeof(u64))
594 ino ^= fileid >> (sizeof(u64)-sizeof(ino_t)) * 8;
598 #define NFS_JUKEBOX_RETRY_TIME (5 * HZ)
603 # define ifdebug(fac) if (unlikely(nfs_debug & NFSDBG_##fac))
604 # define NFS_IFDEBUG(x) x
606 # define ifdebug(fac) if (0)
607 # define NFS_IFDEBUG(x)