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 for number of transports to different server IPs
46 #define NFS_MAX_TRANSPORTS 16
49 * These are the default flags for swap requests
51 #define NFS_RPC_SWAPFLAGS (RPC_TASK_SWAPPER|RPC_TASK_ROOTCREDS)
54 * Size of the NFS directory verifier
56 #define NFS_DIR_VERIFIER_SIZE 2
59 * NFSv3/v4 Access mode cache entry
61 struct nfs_access_entry {
62 struct rb_node rb_node;
66 struct group_info *group_info;
68 struct rcu_head rcu_head;
71 struct nfs_lock_context {
73 struct list_head list;
74 struct nfs_open_context *open_context;
77 struct rcu_head rcu_head;
81 struct nfs_open_context {
82 struct nfs_lock_context lock_context;
83 fl_owner_t flock_owner;
84 struct dentry *dentry;
85 const struct cred *cred;
86 struct rpc_cred __rcu *ll_cred; /* low-level cred - use to check for expiry */
87 struct nfs4_state *state;
91 #define NFS_CONTEXT_RESEND_WRITES (1)
92 #define NFS_CONTEXT_BAD (2)
93 #define NFS_CONTEXT_UNLOCK (3)
94 #define NFS_CONTEXT_FILE_OPEN (4)
97 struct list_head list;
98 struct nfs4_threshold *mdsthreshold;
99 struct rcu_head rcu_head;
102 struct nfs_open_dir_context {
103 struct list_head list;
105 atomic_t cache_misses;
106 unsigned long attr_gencount;
107 __be32 verf[NFS_DIR_VERIFIER_SIZE];
113 struct rcu_head rcu_head;
119 struct nfs_delegation;
123 struct nfs4_xattr_cache;
126 * nfs fs inode data in memory
130 * The 64bit 'inode number'
142 unsigned long flags; /* atomic bit ops */
143 unsigned long cache_validity; /* bit mask */
146 * read_cache_jiffies is when we started read-caching this inode.
147 * attrtimeo is for how long the cached information is assumed
148 * to be valid. A successful attribute revalidation doubles
149 * attrtimeo (up to acregmax/acdirmax), a failure resets it to
152 * We need to revalidate the cached attrs for this inode if
154 * jiffies - read_cache_jiffies >= attrtimeo
156 * Please note the comparison is greater than or equal
157 * so that zero timeout values can be specified.
159 unsigned long read_cache_jiffies;
160 unsigned long attrtimeo;
161 unsigned long attrtimeo_timestamp;
163 unsigned long attr_gencount;
165 struct rb_root access_cache;
166 struct list_head access_cache_entry_lru;
167 struct list_head access_cache_inode_lru;
172 /* "Generation counter" for the attribute cache.
173 * This is bumped whenever we update the metadata
176 unsigned long cache_change_attribute;
178 * This is the cookie verifier used for NFSv3 readdir
181 __be32 cookieverf[NFS_DIR_VERIFIER_SIZE];
182 /* Readers: in-flight sillydelete RPC calls */
184 struct rw_semaphore rmdir_sem;
188 atomic_long_t nrequests;
189 struct nfs_mds_commit_info commit_info;
190 struct mutex commit_mutex;
194 /* Open contexts for shared mmap writes */
195 struct list_head open_files;
197 #if IS_ENABLED(CONFIG_NFS_V4)
198 struct nfs4_cached_acl *nfs4_acl;
200 struct list_head open_states;
201 struct nfs_delegation __rcu *delegation;
202 struct rw_semaphore rwsem;
204 /* pNFS layout information */
205 struct pnfs_layout_hdr *layout;
206 #endif /* CONFIG_NFS_V4*/
207 /* how many bytes have been written/read and how many bytes queued up */
210 #ifdef CONFIG_NFS_FSCACHE
211 struct fscache_cookie *fscache;
213 struct inode vfs_inode;
215 #ifdef CONFIG_NFS_V4_2
216 struct nfs4_xattr_cache *xattr_cache;
220 struct nfs4_copy_state {
221 struct list_head copies;
222 struct list_head src_copies;
223 nfs4_stateid stateid;
224 struct completion completion;
226 struct nfs_writeverf verf;
229 struct nfs4_state *parent_src_state;
230 struct nfs4_state *parent_dst_state;
236 #define NFS_ACCESS_READ 0x0001
237 #define NFS_ACCESS_LOOKUP 0x0002
238 #define NFS_ACCESS_MODIFY 0x0004
239 #define NFS_ACCESS_EXTEND 0x0008
240 #define NFS_ACCESS_DELETE 0x0010
241 #define NFS_ACCESS_EXECUTE 0x0020
242 #define NFS_ACCESS_XAREAD 0x0040
243 #define NFS_ACCESS_XAWRITE 0x0080
244 #define NFS_ACCESS_XALIST 0x0100
247 * Cache validity bit flags
249 #define NFS_INO_INVALID_DATA BIT(1) /* cached data is invalid */
250 #define NFS_INO_INVALID_ATIME BIT(2) /* cached atime is invalid */
251 #define NFS_INO_INVALID_ACCESS BIT(3) /* cached access cred invalid */
252 #define NFS_INO_INVALID_ACL BIT(4) /* cached acls are invalid */
253 #define NFS_INO_REVAL_FORCED BIT(6) /* force revalidation ignoring a delegation */
254 #define NFS_INO_INVALID_LABEL BIT(7) /* cached label is invalid */
255 #define NFS_INO_INVALID_CHANGE BIT(8) /* cached change is invalid */
256 #define NFS_INO_INVALID_CTIME BIT(9) /* cached ctime is invalid */
257 #define NFS_INO_INVALID_MTIME BIT(10) /* cached mtime is invalid */
258 #define NFS_INO_INVALID_SIZE BIT(11) /* cached size is invalid */
259 #define NFS_INO_INVALID_OTHER BIT(12) /* other attrs are invalid */
260 #define NFS_INO_DATA_INVAL_DEFER \
261 BIT(13) /* Deferred cache invalidation */
262 #define NFS_INO_INVALID_BLOCKS BIT(14) /* cached blocks are invalid */
263 #define NFS_INO_INVALID_XATTR BIT(15) /* xattrs are invalid */
264 #define NFS_INO_INVALID_NLINK BIT(16) /* cached nlinks is invalid */
265 #define NFS_INO_INVALID_MODE BIT(17) /* cached mode is invalid */
267 #define NFS_INO_INVALID_ATTR (NFS_INO_INVALID_CHANGE \
268 | NFS_INO_INVALID_CTIME \
269 | NFS_INO_INVALID_MTIME \
270 | NFS_INO_INVALID_SIZE \
271 | NFS_INO_INVALID_NLINK \
272 | NFS_INO_INVALID_MODE \
273 | NFS_INO_INVALID_OTHER) /* inode metadata is invalid */
276 * Bit offsets in flags field
278 #define NFS_INO_STALE (1) /* possible stale inode */
279 #define NFS_INO_ACL_LRU_SET (2) /* Inode is on the LRU list */
280 #define NFS_INO_INVALIDATING (3) /* inode is being invalidated */
281 #define NFS_INO_PRESERVE_UNLINKED (4) /* preserve file if removed while open */
282 #define NFS_INO_FSCACHE (5) /* inode can be cached by FS-Cache */
283 #define NFS_INO_LAYOUTCOMMIT (9) /* layoutcommit required */
284 #define NFS_INO_LAYOUTCOMMITTING (10) /* layoutcommit inflight */
285 #define NFS_INO_LAYOUTSTATS (11) /* layoutstats inflight */
286 #define NFS_INO_ODIRECT (12) /* I/O setting is O_DIRECT */
288 static inline struct nfs_inode *NFS_I(const struct inode *inode)
290 return container_of(inode, struct nfs_inode, vfs_inode);
293 static inline struct nfs_server *NFS_SB(const struct super_block *s)
295 return (struct nfs_server *)(s->s_fs_info);
298 static inline struct nfs_fh *NFS_FH(const struct inode *inode)
300 return &NFS_I(inode)->fh;
303 static inline struct nfs_server *NFS_SERVER(const struct inode *inode)
305 return NFS_SB(inode->i_sb);
308 static inline struct rpc_clnt *NFS_CLIENT(const struct inode *inode)
310 return NFS_SERVER(inode)->client;
313 static inline const struct nfs_rpc_ops *NFS_PROTO(const struct inode *inode)
315 return NFS_SERVER(inode)->nfs_client->rpc_ops;
318 static inline unsigned NFS_MINATTRTIMEO(const struct inode *inode)
320 struct nfs_server *nfss = NFS_SERVER(inode);
321 return S_ISDIR(inode->i_mode) ? nfss->acdirmin : nfss->acregmin;
324 static inline unsigned NFS_MAXATTRTIMEO(const struct inode *inode)
326 struct nfs_server *nfss = NFS_SERVER(inode);
327 return S_ISDIR(inode->i_mode) ? nfss->acdirmax : nfss->acregmax;
330 static inline int NFS_STALE(const struct inode *inode)
332 return test_bit(NFS_INO_STALE, &NFS_I(inode)->flags);
335 static inline struct fscache_cookie *nfs_i_fscache(struct inode *inode)
337 #ifdef CONFIG_NFS_FSCACHE
338 return NFS_I(inode)->fscache;
344 static inline __u64 NFS_FILEID(const struct inode *inode)
346 return NFS_I(inode)->fileid;
349 static inline void set_nfs_fileid(struct inode *inode, __u64 fileid)
351 NFS_I(inode)->fileid = fileid;
354 static inline void nfs_mark_for_revalidate(struct inode *inode)
356 struct nfs_inode *nfsi = NFS_I(inode);
358 spin_lock(&inode->i_lock);
359 nfsi->cache_validity |= NFS_INO_INVALID_ACCESS | NFS_INO_INVALID_ACL |
360 NFS_INO_INVALID_CHANGE | NFS_INO_INVALID_CTIME |
361 NFS_INO_INVALID_SIZE;
362 if (S_ISDIR(inode->i_mode))
363 nfsi->cache_validity |= NFS_INO_INVALID_DATA;
364 spin_unlock(&inode->i_lock);
367 static inline int nfs_server_capable(const struct inode *inode, int cap)
369 return NFS_SERVER(inode)->caps & cap;
373 * nfs_save_change_attribute - Returns the inode attribute change cookie
374 * @dir - pointer to parent directory inode
375 * The "cache change attribute" is updated when we need to revalidate
376 * our dentry cache after a directory was seen to change on the server.
378 static inline unsigned long nfs_save_change_attribute(struct inode *dir)
380 return NFS_I(dir)->cache_change_attribute;
384 * linux/fs/nfs/inode.c
386 extern int nfs_sync_mapping(struct address_space *mapping);
387 extern void nfs_zap_mapping(struct inode *inode, struct address_space *mapping);
388 extern void nfs_zap_caches(struct inode *);
389 extern void nfs_set_inode_stale(struct inode *inode);
390 extern void nfs_invalidate_atime(struct inode *);
391 extern struct inode *nfs_fhget(struct super_block *, struct nfs_fh *,
393 struct inode *nfs_ilookup(struct super_block *sb, struct nfs_fattr *, struct nfs_fh *);
394 extern int nfs_refresh_inode(struct inode *, struct nfs_fattr *);
395 extern int nfs_post_op_update_inode(struct inode *inode, struct nfs_fattr *fattr);
396 extern int nfs_post_op_update_inode_force_wcc(struct inode *inode, struct nfs_fattr *fattr);
397 extern int nfs_post_op_update_inode_force_wcc_locked(struct inode *inode, struct nfs_fattr *fattr);
398 extern int nfs_getattr(struct user_namespace *, const struct path *,
399 struct kstat *, u32, unsigned int);
400 extern void nfs_access_add_cache(struct inode *, struct nfs_access_entry *, const struct cred *);
401 extern void nfs_access_set_mask(struct nfs_access_entry *, u32);
402 extern int nfs_permission(struct user_namespace *, struct inode *, int);
403 extern int nfs_open(struct inode *, struct file *);
404 extern int nfs_attribute_cache_expired(struct inode *inode);
405 extern int nfs_revalidate_inode(struct inode *inode, unsigned long flags);
406 extern int __nfs_revalidate_inode(struct nfs_server *, struct inode *);
407 extern int nfs_clear_invalid_mapping(struct address_space *mapping);
408 extern bool nfs_mapping_need_revalidate_inode(struct inode *inode);
409 extern int nfs_revalidate_mapping(struct inode *inode, struct address_space *mapping);
410 extern int nfs_revalidate_mapping_rcu(struct inode *inode);
411 extern int nfs_setattr(struct user_namespace *, struct dentry *, struct iattr *);
412 extern void nfs_setattr_update_inode(struct inode *inode, struct iattr *attr, struct nfs_fattr *);
413 extern void nfs_setsecurity(struct inode *inode, struct nfs_fattr *fattr);
414 extern struct nfs_open_context *get_nfs_open_context(struct nfs_open_context *ctx);
415 extern void put_nfs_open_context(struct nfs_open_context *ctx);
416 extern struct nfs_open_context *nfs_find_open_context(struct inode *inode, const struct cred *cred, fmode_t mode);
417 extern struct nfs_open_context *alloc_nfs_open_context(struct dentry *dentry, fmode_t f_mode, struct file *filp);
418 extern void nfs_inode_attach_open_context(struct nfs_open_context *ctx);
419 extern void nfs_file_set_open_context(struct file *filp, struct nfs_open_context *ctx);
420 extern void nfs_file_clear_open_context(struct file *flip);
421 extern struct nfs_lock_context *nfs_get_lock_context(struct nfs_open_context *ctx);
422 extern void nfs_put_lock_context(struct nfs_lock_context *l_ctx);
423 extern u64 nfs_compat_user_ino64(u64 fileid);
424 extern void nfs_fattr_init(struct nfs_fattr *fattr);
425 extern void nfs_fattr_set_barrier(struct nfs_fattr *fattr);
426 extern unsigned long nfs_inc_attr_generation_counter(void);
428 extern struct nfs_fattr *nfs_alloc_fattr(void);
429 extern struct nfs_fattr *nfs_alloc_fattr_with_label(struct nfs_server *server);
431 static inline void nfs4_label_free(struct nfs4_label *label)
433 #ifdef CONFIG_NFS_V4_SECURITY_LABEL
441 static inline void nfs_free_fattr(const struct nfs_fattr *fattr)
444 nfs4_label_free(fattr->label);
448 extern struct nfs_fh *nfs_alloc_fhandle(void);
450 static inline void nfs_free_fhandle(const struct nfs_fh *fh)
456 extern u32 _nfs_display_fhandle_hash(const struct nfs_fh *fh);
457 static inline u32 nfs_display_fhandle_hash(const struct nfs_fh *fh)
459 return _nfs_display_fhandle_hash(fh);
461 extern void _nfs_display_fhandle(const struct nfs_fh *fh, const char *caption);
462 #define nfs_display_fhandle(fh, caption) \
464 if (unlikely(nfs_debug & NFSDBG_FACILITY)) \
465 _nfs_display_fhandle(fh, caption); \
468 static inline u32 nfs_display_fhandle_hash(const struct nfs_fh *fh)
472 static inline void nfs_display_fhandle(const struct nfs_fh *fh,
479 * linux/fs/nfs/nfsroot.c
481 extern int nfs_root_data(char **root_device, char **root_data); /*__init*/
482 /* linux/net/ipv4/ipconfig.c: trims ip addr off front of name, too. */
483 extern __be32 root_nfs_parse_addr(char *name); /*__init*/
486 * linux/fs/nfs/file.c
488 extern const struct file_operations nfs_file_operations;
489 #if IS_ENABLED(CONFIG_NFS_V4)
490 extern const struct file_operations nfs4_file_operations;
491 #endif /* CONFIG_NFS_V4 */
492 extern const struct address_space_operations nfs_file_aops;
493 extern const struct address_space_operations nfs_dir_aops;
495 static inline struct nfs_open_context *nfs_file_open_context(struct file *filp)
497 return filp->private_data;
500 static inline const struct cred *nfs_file_cred(struct file *file)
503 struct nfs_open_context *ctx =
504 nfs_file_open_context(file);
512 * linux/fs/nfs/direct.c
514 extern ssize_t nfs_direct_IO(struct kiocb *, struct iov_iter *);
515 extern ssize_t nfs_file_direct_read(struct kiocb *iocb,
516 struct iov_iter *iter);
517 extern ssize_t nfs_file_direct_write(struct kiocb *iocb,
518 struct iov_iter *iter);
523 extern const struct file_operations nfs_dir_operations;
524 extern const struct dentry_operations nfs_dentry_operations;
526 extern void nfs_force_lookup_revalidate(struct inode *dir);
527 extern void nfs_set_verifier(struct dentry * dentry, unsigned long verf);
528 #if IS_ENABLED(CONFIG_NFS_V4)
529 extern void nfs_clear_verifier_delegated(struct inode *inode);
530 #endif /* IS_ENABLED(CONFIG_NFS_V4) */
531 extern struct dentry *nfs_add_or_obtain(struct dentry *dentry,
532 struct nfs_fh *fh, struct nfs_fattr *fattr);
533 extern int nfs_instantiate(struct dentry *dentry, struct nfs_fh *fh,
534 struct nfs_fattr *fattr);
535 extern int nfs_may_open(struct inode *inode, const struct cred *cred, int openflags);
536 extern void nfs_access_zap_cache(struct inode *inode);
537 extern int nfs_access_get_cached(struct inode *inode, const struct cred *cred,
538 u32 *mask, bool may_block);
541 * linux/fs/nfs/symlink.c
543 extern const struct inode_operations nfs_symlink_inode_operations;
546 * linux/fs/nfs/sysctl.c
549 extern int nfs_register_sysctl(void);
550 extern void nfs_unregister_sysctl(void);
552 #define nfs_register_sysctl() 0
553 #define nfs_unregister_sysctl() do { } while(0)
557 * linux/fs/nfs/namespace.c
559 extern const struct inode_operations nfs_mountpoint_inode_operations;
560 extern const struct inode_operations nfs_referral_inode_operations;
561 extern int nfs_mountpoint_expiry_timeout;
562 extern void nfs_release_automount_timer(void);
565 * linux/fs/nfs/unlink.c
567 extern void nfs_complete_unlink(struct dentry *dentry, struct inode *);
570 * linux/fs/nfs/write.c
572 extern int nfs_congestion_kb;
573 extern int nfs_writepage(struct page *page, struct writeback_control *wbc);
574 extern int nfs_writepages(struct address_space *, struct writeback_control *);
575 extern int nfs_flush_incompatible(struct file *file, struct page *page);
576 extern int nfs_updatepage(struct file *, struct page *, unsigned int, unsigned int);
579 * Try to write back everything synchronously (but check the
582 extern int nfs_sync_inode(struct inode *inode);
583 extern int nfs_wb_all(struct inode *inode);
584 extern int nfs_wb_page(struct inode *inode, struct page *page);
585 extern int nfs_wb_page_cancel(struct inode *inode, struct page* page);
586 extern int nfs_commit_inode(struct inode *, int);
587 extern struct nfs_commit_data *nfs_commitdata_alloc(bool never_fail);
588 extern void nfs_commit_free(struct nfs_commit_data *data);
589 bool nfs_commit_end(struct nfs_mds_commit_info *cinfo);
591 static inline bool nfs_have_writebacks(const struct inode *inode)
593 if (S_ISREG(inode->i_mode))
594 return atomic_long_read(&NFS_I(inode)->nrequests) != 0;
599 * linux/fs/nfs/read.c
601 extern int nfs_readpage(struct file *, struct page *);
602 void nfs_readahead(struct readahead_control *);
608 static inline loff_t nfs_size_to_loff_t(__u64 size)
610 return min_t(u64, size, OFFSET_MAX);
614 nfs_fileid_to_ino_t(u64 fileid)
616 ino_t ino = (ino_t) fileid;
617 if (sizeof(ino_t) < sizeof(u64))
618 ino ^= fileid >> (sizeof(u64)-sizeof(ino_t)) * 8;
622 #define NFS_JUKEBOX_RETRY_TIME (5 * HZ)
627 # define ifdebug(fac) if (unlikely(nfs_debug & NFSDBG_##fac))
628 # define NFS_IFDEBUG(x) x
630 # define ifdebug(fac) if (0)
631 # define NFS_IFDEBUG(x)