2 * linux/include/linux/nfs_fs.h
4 * Copyright (C) 1992 Rick Sladkey
6 * OS-specific nfs filesystem definitions and declarations
9 #ifndef _LINUX_NFS_FS_H
10 #define _LINUX_NFS_FS_H
12 #include <linux/magic.h>
14 /* Default timeout values */
15 #define NFS_DEF_UDP_TIMEO (11)
16 #define NFS_DEF_UDP_RETRANS (3)
17 #define NFS_DEF_TCP_TIMEO (600)
18 #define NFS_DEF_TCP_RETRANS (2)
20 #define NFS_MAX_UDP_TIMEOUT (60*HZ)
21 #define NFS_MAX_TCP_TIMEOUT (600*HZ)
23 #define NFS_DEF_ACREGMIN (3)
24 #define NFS_DEF_ACREGMAX (60)
25 #define NFS_DEF_ACDIRMIN (30)
26 #define NFS_DEF_ACDIRMAX (60)
29 * When flushing a cluster of dirty pages, there can be different
32 #define FLUSH_SYNC 1 /* file being synced, or contention */
33 #define FLUSH_STABLE 4 /* commit to stable storage */
34 #define FLUSH_LOWPRI 8 /* low priority background flush */
35 #define FLUSH_HIGHPRI 16 /* high priority memory reclaim flush */
36 #define FLUSH_COND_STABLE 32 /* conditional stable write - only stable
37 * if everything fits in one RPC */
42 * Enable dprintk() debugging support for nfs client.
44 #ifdef CONFIG_NFS_DEBUG
50 #include <linux/pagemap.h>
51 #include <linux/rbtree.h>
52 #include <linux/rwsem.h>
53 #include <linux/wait.h>
55 #include <linux/sunrpc/debug.h>
56 #include <linux/sunrpc/auth.h>
57 #include <linux/sunrpc/clnt.h>
59 #include <linux/nfs.h>
60 #include <linux/nfs2.h>
61 #include <linux/nfs3.h>
62 #include <linux/nfs4.h>
63 #include <linux/nfs_xdr.h>
64 #include <linux/nfs_fs_sb.h>
66 #include <linux/mempool.h>
69 * These are the default flags for swap requests
71 #define NFS_RPC_SWAPFLAGS (RPC_TASK_SWAPPER|RPC_TASK_ROOTCREDS)
74 * NFSv3/v4 Access mode cache entry
76 struct nfs_access_entry {
77 struct rb_node rb_node;
79 unsigned long jiffies;
80 struct rpc_cred * cred;
84 struct nfs_lockowner {
89 struct nfs_lock_context {
91 struct list_head list;
92 struct nfs_open_context *open_context;
93 struct nfs_lockowner lockowner;
97 struct nfs_open_context {
98 struct nfs_lock_context lock_context;
99 struct dentry *dentry;
100 struct rpc_cred *cred;
101 struct nfs4_state *state;
105 #define NFS_CONTEXT_ERROR_WRITE (0)
108 struct list_head list;
109 struct nfs4_threshold *mdsthreshold;
112 struct nfs_open_dir_context {
113 struct rpc_cred *cred;
114 unsigned long attr_gencount;
123 struct nfs_delegation;
128 * nfs fs inode data in memory
132 * The 64bit 'inode number'
144 unsigned long flags; /* atomic bit ops */
145 unsigned long cache_validity; /* bit mask */
148 * read_cache_jiffies is when we started read-caching this inode.
149 * attrtimeo is for how long the cached information is assumed
150 * to be valid. A successful attribute revalidation doubles
151 * attrtimeo (up to acregmax/acdirmax), a failure resets it to
154 * We need to revalidate the cached attrs for this inode if
156 * jiffies - read_cache_jiffies >= attrtimeo
158 * Please note the comparison is greater than or equal
159 * so that zero timeout values can be specified.
161 unsigned long read_cache_jiffies;
162 unsigned long attrtimeo;
163 unsigned long attrtimeo_timestamp;
165 unsigned long attr_gencount;
166 /* "Generation counter" for the attribute cache. This is
167 * bumped whenever we update the metadata on the
170 unsigned long cache_change_attribute;
172 struct rb_root access_cache;
173 struct list_head access_cache_entry_lru;
174 struct list_head access_cache_inode_lru;
175 #ifdef CONFIG_NFS_V3_ACL
176 struct posix_acl *acl_access;
177 struct posix_acl *acl_default;
181 * This is the cookie verifier used for NFSv3 readdir
184 __be32 cookieverf[2];
186 unsigned long npages;
187 struct nfs_mds_commit_info commit_info;
189 /* Open contexts for shared mmap writes */
190 struct list_head open_files;
192 /* Number of in-flight sillydelete RPC calls */
193 atomic_t silly_count;
194 /* List of deferred sillydelete requests */
195 struct hlist_head silly_list;
196 wait_queue_head_t waitqueue;
198 #if IS_ENABLED(CONFIG_NFS_V4)
199 struct nfs4_cached_acl *nfs4_acl;
201 struct list_head open_states;
202 struct nfs_delegation __rcu *delegation;
203 fmode_t delegation_state;
204 struct rw_semaphore rwsem;
206 /* pNFS layout information */
207 struct pnfs_layout_hdr *layout;
208 #endif /* CONFIG_NFS_V4*/
209 /* how many bytes have been written/read and how many bytes queued up */
212 #ifdef CONFIG_NFS_FSCACHE
213 struct fscache_cookie *fscache;
215 struct inode vfs_inode;
219 * Cache validity bit flags
221 #define NFS_INO_INVALID_ATTR 0x0001 /* cached attrs are invalid */
222 #define NFS_INO_INVALID_DATA 0x0002 /* cached data is invalid */
223 #define NFS_INO_INVALID_ATIME 0x0004 /* cached atime is invalid */
224 #define NFS_INO_INVALID_ACCESS 0x0008 /* cached access cred invalid */
225 #define NFS_INO_INVALID_ACL 0x0010 /* cached acls are invalid */
226 #define NFS_INO_REVAL_PAGECACHE 0x0020 /* must revalidate pagecache */
227 #define NFS_INO_REVAL_FORCED 0x0040 /* force revalidation ignoring a delegation */
230 * Bit offsets in flags field
232 #define NFS_INO_ADVISE_RDPLUS (0) /* advise readdirplus */
233 #define NFS_INO_STALE (1) /* possible stale inode */
234 #define NFS_INO_ACL_LRU_SET (2) /* Inode is on the LRU list */
235 #define NFS_INO_FLUSHING (4) /* inode is flushing out data */
236 #define NFS_INO_FSCACHE (5) /* inode can be cached by FS-Cache */
237 #define NFS_INO_FSCACHE_LOCK (6) /* FS-Cache cookie management lock */
238 #define NFS_INO_COMMIT (7) /* inode is committing unstable writes */
239 #define NFS_INO_LAYOUTCOMMIT (9) /* layoutcommit required */
240 #define NFS_INO_LAYOUTCOMMITTING (10) /* layoutcommit inflight */
242 static inline struct nfs_inode *NFS_I(const struct inode *inode)
244 return container_of(inode, struct nfs_inode, vfs_inode);
247 static inline struct nfs_server *NFS_SB(const struct super_block *s)
249 return (struct nfs_server *)(s->s_fs_info);
252 static inline struct nfs_fh *NFS_FH(const struct inode *inode)
254 return &NFS_I(inode)->fh;
257 static inline struct nfs_server *NFS_SERVER(const struct inode *inode)
259 return NFS_SB(inode->i_sb);
262 static inline struct rpc_clnt *NFS_CLIENT(const struct inode *inode)
264 return NFS_SERVER(inode)->client;
267 static inline const struct nfs_rpc_ops *NFS_PROTO(const struct inode *inode)
269 return NFS_SERVER(inode)->nfs_client->rpc_ops;
272 static inline unsigned NFS_MINATTRTIMEO(const struct inode *inode)
274 struct nfs_server *nfss = NFS_SERVER(inode);
275 return S_ISDIR(inode->i_mode) ? nfss->acdirmin : nfss->acregmin;
278 static inline unsigned NFS_MAXATTRTIMEO(const struct inode *inode)
280 struct nfs_server *nfss = NFS_SERVER(inode);
281 return S_ISDIR(inode->i_mode) ? nfss->acdirmax : nfss->acregmax;
284 static inline int NFS_STALE(const struct inode *inode)
286 return test_bit(NFS_INO_STALE, &NFS_I(inode)->flags);
289 static inline int NFS_FSCACHE(const struct inode *inode)
291 return test_bit(NFS_INO_FSCACHE, &NFS_I(inode)->flags);
294 static inline __u64 NFS_FILEID(const struct inode *inode)
296 return NFS_I(inode)->fileid;
299 static inline void set_nfs_fileid(struct inode *inode, __u64 fileid)
301 NFS_I(inode)->fileid = fileid;
304 static inline void nfs_mark_for_revalidate(struct inode *inode)
306 struct nfs_inode *nfsi = NFS_I(inode);
308 spin_lock(&inode->i_lock);
309 nfsi->cache_validity |= NFS_INO_INVALID_ATTR|NFS_INO_INVALID_ACCESS;
310 if (S_ISDIR(inode->i_mode))
311 nfsi->cache_validity |= NFS_INO_REVAL_PAGECACHE|NFS_INO_INVALID_DATA;
312 spin_unlock(&inode->i_lock);
315 static inline int nfs_server_capable(struct inode *inode, int cap)
317 return NFS_SERVER(inode)->caps & cap;
320 static inline void nfs_set_verifier(struct dentry * dentry, unsigned long verf)
322 dentry->d_time = verf;
326 * nfs_save_change_attribute - Returns the inode attribute change cookie
327 * @dir - pointer to parent directory inode
328 * The "change attribute" is updated every time we finish an operation
329 * that will result in a metadata change on the server.
331 static inline unsigned long nfs_save_change_attribute(struct inode *dir)
333 return NFS_I(dir)->cache_change_attribute;
337 * nfs_verify_change_attribute - Detects NFS remote directory changes
338 * @dir - pointer to parent directory inode
339 * @chattr - previously saved change attribute
340 * Return "false" if the verifiers doesn't match the change attribute.
341 * This would usually indicate that the directory contents have changed on
342 * the server, and that any dentries need revalidating.
344 static inline int nfs_verify_change_attribute(struct inode *dir, unsigned long chattr)
346 return chattr == NFS_I(dir)->cache_change_attribute;
350 * linux/fs/nfs/inode.c
352 extern int nfs_sync_mapping(struct address_space *mapping);
353 extern void nfs_zap_mapping(struct inode *inode, struct address_space *mapping);
354 extern void nfs_zap_caches(struct inode *);
355 extern void nfs_invalidate_atime(struct inode *);
356 extern struct inode *nfs_fhget(struct super_block *, struct nfs_fh *,
358 extern int nfs_refresh_inode(struct inode *, struct nfs_fattr *);
359 extern int nfs_post_op_update_inode(struct inode *inode, struct nfs_fattr *fattr);
360 extern int nfs_post_op_update_inode_force_wcc(struct inode *inode, struct nfs_fattr *fattr);
361 extern int nfs_getattr(struct vfsmount *, struct dentry *, struct kstat *);
362 extern int nfs_permission(struct inode *, int);
363 extern int nfs_open(struct inode *, struct file *);
364 extern int nfs_release(struct inode *, struct file *);
365 extern int nfs_attribute_timeout(struct inode *inode);
366 extern int nfs_revalidate_inode(struct nfs_server *server, struct inode *inode);
367 extern int __nfs_revalidate_inode(struct nfs_server *, struct inode *);
368 extern int nfs_revalidate_mapping(struct inode *inode, struct address_space *mapping);
369 extern int nfs_setattr(struct dentry *, struct iattr *);
370 extern void nfs_setattr_update_inode(struct inode *inode, struct iattr *attr);
371 extern struct nfs_open_context *get_nfs_open_context(struct nfs_open_context *ctx);
372 extern void put_nfs_open_context(struct nfs_open_context *ctx);
373 extern struct nfs_open_context *nfs_find_open_context(struct inode *inode, struct rpc_cred *cred, fmode_t mode);
374 extern struct nfs_open_context *alloc_nfs_open_context(struct dentry *dentry, fmode_t f_mode);
375 extern void nfs_file_set_open_context(struct file *filp, struct nfs_open_context *ctx);
376 extern struct nfs_lock_context *nfs_get_lock_context(struct nfs_open_context *ctx);
377 extern void nfs_put_lock_context(struct nfs_lock_context *l_ctx);
378 extern u64 nfs_compat_user_ino64(u64 fileid);
379 extern void nfs_fattr_init(struct nfs_fattr *fattr);
380 extern unsigned long nfs_inc_attr_generation_counter(void);
382 extern struct nfs_fattr *nfs_alloc_fattr(void);
384 static inline void nfs_free_fattr(const struct nfs_fattr *fattr)
389 extern struct nfs_fh *nfs_alloc_fhandle(void);
391 static inline void nfs_free_fhandle(const struct nfs_fh *fh)
397 extern u32 _nfs_display_fhandle_hash(const struct nfs_fh *fh);
398 static inline u32 nfs_display_fhandle_hash(const struct nfs_fh *fh)
400 return _nfs_display_fhandle_hash(fh);
402 extern void _nfs_display_fhandle(const struct nfs_fh *fh, const char *caption);
403 #define nfs_display_fhandle(fh, caption) \
405 if (unlikely(nfs_debug & NFSDBG_FACILITY)) \
406 _nfs_display_fhandle(fh, caption); \
409 static inline u32 nfs_display_fhandle_hash(const struct nfs_fh *fh)
413 static inline void nfs_display_fhandle(const struct nfs_fh *fh,
420 * linux/fs/nfs/nfsroot.c
422 extern int nfs_root_data(char **root_device, char **root_data); /*__init*/
423 /* linux/net/ipv4/ipconfig.c: trims ip addr off front of name, too. */
424 extern __be32 root_nfs_parse_addr(char *name); /*__init*/
427 * linux/fs/nfs/file.c
429 extern const struct file_operations nfs_file_operations;
430 #if IS_ENABLED(CONFIG_NFS_V4)
431 extern const struct file_operations nfs4_file_operations;
432 #endif /* CONFIG_NFS_V4 */
433 extern const struct address_space_operations nfs_file_aops;
434 extern const struct address_space_operations nfs_dir_aops;
436 static inline struct nfs_open_context *nfs_file_open_context(struct file *filp)
438 return filp->private_data;
441 static inline struct rpc_cred *nfs_file_cred(struct file *file)
444 struct nfs_open_context *ctx =
445 nfs_file_open_context(file);
453 * linux/fs/nfs/xattr.c
455 #ifdef CONFIG_NFS_V3_ACL
456 extern ssize_t nfs3_listxattr(struct dentry *, char *, size_t);
457 extern ssize_t nfs3_getxattr(struct dentry *, const char *, void *, size_t);
458 extern int nfs3_setxattr(struct dentry *, const char *,
459 const void *, size_t, int);
460 extern int nfs3_removexattr (struct dentry *, const char *name);
462 # define nfs3_listxattr NULL
463 # define nfs3_getxattr NULL
464 # define nfs3_setxattr NULL
465 # define nfs3_removexattr NULL
469 * linux/fs/nfs/direct.c
471 extern ssize_t nfs_direct_IO(int, struct kiocb *, const struct iovec *, loff_t,
473 extern ssize_t nfs_file_direct_read(struct kiocb *iocb,
474 const struct iovec *iov, unsigned long nr_segs,
475 loff_t pos, bool uio);
476 extern ssize_t nfs_file_direct_write(struct kiocb *iocb,
477 const struct iovec *iov, unsigned long nr_segs,
478 loff_t pos, bool uio);
483 extern const struct file_operations nfs_dir_operations;
484 extern const struct dentry_operations nfs_dentry_operations;
486 extern void nfs_force_lookup_revalidate(struct inode *dir);
487 extern int nfs_instantiate(struct dentry *dentry, struct nfs_fh *fh, struct nfs_fattr *fattr);
488 extern int nfs_may_open(struct inode *inode, struct rpc_cred *cred, int openflags);
489 extern void nfs_access_zap_cache(struct inode *inode);
492 * linux/fs/nfs/symlink.c
494 extern const struct inode_operations nfs_symlink_inode_operations;
497 * linux/fs/nfs/sysctl.c
500 extern int nfs_register_sysctl(void);
501 extern void nfs_unregister_sysctl(void);
503 #define nfs_register_sysctl() 0
504 #define nfs_unregister_sysctl() do { } while(0)
508 * linux/fs/nfs/namespace.c
510 extern const struct inode_operations nfs_mountpoint_inode_operations;
511 extern const struct inode_operations nfs_referral_inode_operations;
512 extern int nfs_mountpoint_expiry_timeout;
513 extern void nfs_release_automount_timer(void);
516 * linux/fs/nfs/unlink.c
518 extern void nfs_complete_unlink(struct dentry *dentry, struct inode *);
519 extern void nfs_block_sillyrename(struct dentry *dentry);
520 extern void nfs_unblock_sillyrename(struct dentry *dentry);
521 extern int nfs_sillyrename(struct inode *dir, struct dentry *dentry);
524 * linux/fs/nfs/write.c
526 extern int nfs_congestion_kb;
527 extern int nfs_writepage(struct page *page, struct writeback_control *wbc);
528 extern int nfs_writepages(struct address_space *, struct writeback_control *);
529 extern int nfs_flush_incompatible(struct file *file, struct page *page);
530 extern int nfs_updatepage(struct file *, struct page *, unsigned int, unsigned int);
531 extern void nfs_writeback_done(struct rpc_task *, struct nfs_write_data *);
534 * Try to write back everything synchronously (but check the
537 extern int nfs_wb_all(struct inode *inode);
538 extern int nfs_wb_page(struct inode *inode, struct page* page);
539 extern int nfs_wb_page_cancel(struct inode *inode, struct page* page);
540 #if IS_ENABLED(CONFIG_NFS_V3) || IS_ENABLED(CONFIG_NFS_V4)
541 extern int nfs_commit_inode(struct inode *, int);
542 extern struct nfs_commit_data *nfs_commitdata_alloc(void);
543 extern void nfs_commit_free(struct nfs_commit_data *data);
546 nfs_commit_inode(struct inode *inode, int how)
553 nfs_have_writebacks(struct inode *inode)
555 return NFS_I(inode)->npages != 0;
559 * linux/fs/nfs/read.c
561 extern int nfs_readpage(struct file *, struct page *);
562 extern int nfs_readpages(struct file *, struct address_space *,
563 struct list_head *, unsigned);
564 extern int nfs_readpage_result(struct rpc_task *, struct nfs_read_data *);
565 extern int nfs_readpage_async(struct nfs_open_context *, struct inode *,
569 * linux/fs/nfs3proc.c
571 #ifdef CONFIG_NFS_V3_ACL
572 extern struct posix_acl *nfs3_proc_getacl(struct inode *inode, int type);
573 extern int nfs3_proc_setacl(struct inode *inode, int type,
574 struct posix_acl *acl);
575 extern int nfs3_proc_set_default_acl(struct inode *dir, struct inode *inode,
577 extern void nfs3_forget_cached_acls(struct inode *inode);
579 static inline int nfs3_proc_set_default_acl(struct inode *dir,
586 static inline void nfs3_forget_cached_acls(struct inode *inode)
589 #endif /* CONFIG_NFS_V3_ACL */
595 static inline loff_t nfs_size_to_loff_t(__u64 size)
597 if (size > (__u64) OFFSET_MAX - 1)
598 return OFFSET_MAX - 1;
599 return (loff_t) size;
603 nfs_fileid_to_ino_t(u64 fileid)
605 ino_t ino = (ino_t) fileid;
606 if (sizeof(ino_t) < sizeof(u64))
607 ino ^= fileid >> (sizeof(u64)-sizeof(ino_t)) * 8;
611 #define NFS_JUKEBOX_RETRY_TIME (5 * HZ)
613 #endif /* __KERNEL__ */
618 #define NFSDBG_VFS 0x0001
619 #define NFSDBG_DIRCACHE 0x0002
620 #define NFSDBG_LOOKUPCACHE 0x0004
621 #define NFSDBG_PAGECACHE 0x0008
622 #define NFSDBG_PROC 0x0010
623 #define NFSDBG_XDR 0x0020
624 #define NFSDBG_FILE 0x0040
625 #define NFSDBG_ROOT 0x0080
626 #define NFSDBG_CALLBACK 0x0100
627 #define NFSDBG_CLIENT 0x0200
628 #define NFSDBG_MOUNT 0x0400
629 #define NFSDBG_FSCACHE 0x0800
630 #define NFSDBG_PNFS 0x1000
631 #define NFSDBG_PNFS_LD 0x2000
632 #define NFSDBG_STATE 0x4000
633 #define NFSDBG_ALL 0xFFFF
639 # define ifdebug(fac) if (unlikely(nfs_debug & NFSDBG_##fac))
640 # define NFS_IFDEBUG(x) x
642 # define ifdebug(fac) if (0)
643 # define NFS_IFDEBUG(x)
645 #endif /* __KERNEL */