2 * linux/include/linux/nfs_fs.h
4 * Copyright (C) 1992 Rick Sladkey
6 * OS-specific nfs filesystem definitions and declarations
8 #ifndef _LINUX_NFS_FS_H
9 #define _LINUX_NFS_FS_H
11 #include <uapi/linux/nfs_fs.h>
15 * Enable dprintk() debugging support for nfs client.
17 #ifdef CONFIG_NFS_DEBUG
23 #include <linux/pagemap.h>
24 #include <linux/rbtree.h>
25 #include <linux/rwsem.h>
26 #include <linux/wait.h>
28 #include <linux/sunrpc/debug.h>
29 #include <linux/sunrpc/auth.h>
30 #include <linux/sunrpc/clnt.h>
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>
39 #include <linux/mempool.h>
42 * These are the default flags for swap requests
44 #define NFS_RPC_SWAPFLAGS (RPC_TASK_SWAPPER|RPC_TASK_ROOTCREDS)
47 * NFSv3/v4 Access mode cache entry
49 struct nfs_access_entry {
50 struct rb_node rb_node;
52 unsigned long jiffies;
53 struct rpc_cred * cred;
57 struct nfs_lockowner {
62 #define NFS_IO_INPROGRESS 0
63 struct nfs_io_counter {
68 struct nfs_lock_context {
70 struct list_head list;
71 struct nfs_open_context *open_context;
72 struct nfs_lockowner lockowner;
73 struct nfs_io_counter io_count;
77 struct nfs_open_context {
78 struct nfs_lock_context lock_context;
79 struct dentry *dentry;
80 struct rpc_cred *cred;
81 struct nfs4_state *state;
85 #define NFS_CONTEXT_ERROR_WRITE (0)
86 #define NFS_CONTEXT_RESEND_WRITES (1)
87 #define NFS_CONTEXT_BAD (2)
90 struct list_head list;
91 struct nfs4_threshold *mdsthreshold;
94 struct nfs_open_dir_context {
95 struct list_head list;
96 struct rpc_cred *cred;
97 unsigned long attr_gencount;
106 struct nfs_delegation;
111 * nfs fs inode data in memory
115 * The 64bit 'inode number'
127 unsigned long flags; /* atomic bit ops */
128 unsigned long cache_validity; /* bit mask */
131 * read_cache_jiffies is when we started read-caching this inode.
132 * attrtimeo is for how long the cached information is assumed
133 * to be valid. A successful attribute revalidation doubles
134 * attrtimeo (up to acregmax/acdirmax), a failure resets it to
137 * We need to revalidate the cached attrs for this inode if
139 * jiffies - read_cache_jiffies >= attrtimeo
141 * Please note the comparison is greater than or equal
142 * so that zero timeout values can be specified.
144 unsigned long read_cache_jiffies;
145 unsigned long attrtimeo;
146 unsigned long attrtimeo_timestamp;
148 unsigned long attr_gencount;
149 /* "Generation counter" for the attribute cache. This is
150 * bumped whenever we update the metadata on the
153 unsigned long cache_change_attribute;
155 struct rb_root access_cache;
156 struct list_head access_cache_entry_lru;
157 struct list_head access_cache_inode_lru;
160 * This is the cookie verifier used for NFSv3 readdir
163 __be32 cookieverf[2];
165 unsigned long npages;
166 struct nfs_mds_commit_info commit_info;
168 /* Open contexts for shared mmap writes */
169 struct list_head open_files;
171 /* Number of in-flight sillydelete RPC calls */
172 atomic_t silly_count;
173 /* List of deferred sillydelete requests */
174 struct hlist_head silly_list;
175 wait_queue_head_t waitqueue;
177 #if IS_ENABLED(CONFIG_NFS_V4)
178 struct nfs4_cached_acl *nfs4_acl;
180 struct list_head open_states;
181 struct nfs_delegation __rcu *delegation;
182 fmode_t delegation_state;
183 struct rw_semaphore rwsem;
185 /* pNFS layout information */
186 struct pnfs_layout_hdr *layout;
187 #endif /* CONFIG_NFS_V4*/
188 /* how many bytes have been written/read and how many bytes queued up */
191 #ifdef CONFIG_NFS_FSCACHE
192 struct fscache_cookie *fscache;
194 struct inode vfs_inode;
198 * Cache validity bit flags
200 #define NFS_INO_INVALID_ATTR 0x0001 /* cached attrs are invalid */
201 #define NFS_INO_INVALID_DATA 0x0002 /* cached data is invalid */
202 #define NFS_INO_INVALID_ATIME 0x0004 /* cached atime is invalid */
203 #define NFS_INO_INVALID_ACCESS 0x0008 /* cached access cred invalid */
204 #define NFS_INO_INVALID_ACL 0x0010 /* cached acls are invalid */
205 #define NFS_INO_REVAL_PAGECACHE 0x0020 /* must revalidate pagecache */
206 #define NFS_INO_REVAL_FORCED 0x0040 /* force revalidation ignoring a delegation */
207 #define NFS_INO_INVALID_LABEL 0x0080 /* cached label is invalid */
210 * Bit offsets in flags field
212 #define NFS_INO_ADVISE_RDPLUS (0) /* advise readdirplus */
213 #define NFS_INO_STALE (1) /* possible stale inode */
214 #define NFS_INO_ACL_LRU_SET (2) /* Inode is on the LRU list */
215 #define NFS_INO_INVALIDATING (3) /* inode is being invalidated */
216 #define NFS_INO_FLUSHING (4) /* inode is flushing out data */
217 #define NFS_INO_FSCACHE (5) /* inode can be cached by FS-Cache */
218 #define NFS_INO_FSCACHE_LOCK (6) /* FS-Cache cookie management lock */
219 #define NFS_INO_COMMIT (7) /* inode is committing unstable writes */
220 #define NFS_INO_LAYOUTCOMMIT (9) /* layoutcommit required */
221 #define NFS_INO_LAYOUTCOMMITTING (10) /* layoutcommit inflight */
223 static inline struct nfs_inode *NFS_I(const struct inode *inode)
225 return container_of(inode, struct nfs_inode, vfs_inode);
228 static inline struct nfs_server *NFS_SB(const struct super_block *s)
230 return (struct nfs_server *)(s->s_fs_info);
233 static inline struct nfs_fh *NFS_FH(const struct inode *inode)
235 return &NFS_I(inode)->fh;
238 static inline struct nfs_server *NFS_SERVER(const struct inode *inode)
240 return NFS_SB(inode->i_sb);
243 static inline struct rpc_clnt *NFS_CLIENT(const struct inode *inode)
245 return NFS_SERVER(inode)->client;
248 static inline const struct nfs_rpc_ops *NFS_PROTO(const struct inode *inode)
250 return NFS_SERVER(inode)->nfs_client->rpc_ops;
253 static inline unsigned NFS_MINATTRTIMEO(const struct inode *inode)
255 struct nfs_server *nfss = NFS_SERVER(inode);
256 return S_ISDIR(inode->i_mode) ? nfss->acdirmin : nfss->acregmin;
259 static inline unsigned NFS_MAXATTRTIMEO(const struct inode *inode)
261 struct nfs_server *nfss = NFS_SERVER(inode);
262 return S_ISDIR(inode->i_mode) ? nfss->acdirmax : nfss->acregmax;
265 static inline int NFS_STALE(const struct inode *inode)
267 return test_bit(NFS_INO_STALE, &NFS_I(inode)->flags);
270 static inline struct fscache_cookie *nfs_i_fscache(struct inode *inode)
272 #ifdef CONFIG_NFS_FSCACHE
273 return NFS_I(inode)->fscache;
279 static inline __u64 NFS_FILEID(const struct inode *inode)
281 return NFS_I(inode)->fileid;
284 static inline void set_nfs_fileid(struct inode *inode, __u64 fileid)
286 NFS_I(inode)->fileid = fileid;
289 static inline void nfs_mark_for_revalidate(struct inode *inode)
291 struct nfs_inode *nfsi = NFS_I(inode);
293 spin_lock(&inode->i_lock);
294 nfsi->cache_validity |= NFS_INO_INVALID_ATTR|NFS_INO_INVALID_ACCESS;
295 if (S_ISDIR(inode->i_mode))
296 nfsi->cache_validity |= NFS_INO_REVAL_PAGECACHE|NFS_INO_INVALID_DATA;
297 spin_unlock(&inode->i_lock);
300 static inline int nfs_server_capable(struct inode *inode, int cap)
302 return NFS_SERVER(inode)->caps & cap;
305 static inline void nfs_set_verifier(struct dentry * dentry, unsigned long verf)
307 dentry->d_time = verf;
311 * nfs_save_change_attribute - Returns the inode attribute change cookie
312 * @dir - pointer to parent directory inode
313 * The "change attribute" is updated every time we finish an operation
314 * that will result in a metadata change on the server.
316 static inline unsigned long nfs_save_change_attribute(struct inode *dir)
318 return NFS_I(dir)->cache_change_attribute;
322 * nfs_verify_change_attribute - Detects NFS remote directory changes
323 * @dir - pointer to parent directory inode
324 * @chattr - previously saved change attribute
325 * Return "false" if the verifiers doesn't match the change attribute.
326 * This would usually indicate that the directory contents have changed on
327 * the server, and that any dentries need revalidating.
329 static inline int nfs_verify_change_attribute(struct inode *dir, unsigned long chattr)
331 return chattr == NFS_I(dir)->cache_change_attribute;
335 * linux/fs/nfs/inode.c
337 extern int nfs_sync_mapping(struct address_space *mapping);
338 extern void nfs_zap_mapping(struct inode *inode, struct address_space *mapping);
339 extern void nfs_zap_caches(struct inode *);
340 extern void nfs_invalidate_atime(struct inode *);
341 extern struct inode *nfs_fhget(struct super_block *, struct nfs_fh *,
342 struct nfs_fattr *, struct nfs4_label *);
343 extern int nfs_refresh_inode(struct inode *, struct nfs_fattr *);
344 extern int nfs_post_op_update_inode(struct inode *inode, struct nfs_fattr *fattr);
345 extern int nfs_post_op_update_inode_force_wcc(struct inode *inode, struct nfs_fattr *fattr);
346 extern int nfs_getattr(struct vfsmount *, struct dentry *, struct kstat *);
347 extern void nfs_access_add_cache(struct inode *, struct nfs_access_entry *);
348 extern void nfs_access_set_mask(struct nfs_access_entry *, u32);
349 extern int nfs_permission(struct inode *, int);
350 extern int nfs_open(struct inode *, struct file *);
351 extern int nfs_release(struct inode *, struct file *);
352 extern int nfs_attribute_timeout(struct inode *inode);
353 extern int nfs_attribute_cache_expired(struct inode *inode);
354 extern int nfs_revalidate_inode(struct nfs_server *server, struct inode *inode);
355 extern int __nfs_revalidate_inode(struct nfs_server *, struct inode *);
356 extern int nfs_revalidate_mapping(struct inode *inode, struct address_space *mapping);
357 extern int nfs_setattr(struct dentry *, struct iattr *);
358 extern void nfs_setattr_update_inode(struct inode *inode, struct iattr *attr);
359 extern void nfs_setsecurity(struct inode *inode, struct nfs_fattr *fattr,
360 struct nfs4_label *label);
361 extern struct nfs_open_context *get_nfs_open_context(struct nfs_open_context *ctx);
362 extern void put_nfs_open_context(struct nfs_open_context *ctx);
363 extern struct nfs_open_context *nfs_find_open_context(struct inode *inode, struct rpc_cred *cred, fmode_t mode);
364 extern struct nfs_open_context *alloc_nfs_open_context(struct dentry *dentry, fmode_t f_mode);
365 extern void nfs_inode_attach_open_context(struct nfs_open_context *ctx);
366 extern void nfs_file_set_open_context(struct file *filp, struct nfs_open_context *ctx);
367 extern struct nfs_lock_context *nfs_get_lock_context(struct nfs_open_context *ctx);
368 extern void nfs_put_lock_context(struct nfs_lock_context *l_ctx);
369 extern u64 nfs_compat_user_ino64(u64 fileid);
370 extern void nfs_fattr_init(struct nfs_fattr *fattr);
371 extern unsigned long nfs_inc_attr_generation_counter(void);
373 extern struct nfs_fattr *nfs_alloc_fattr(void);
375 static inline void nfs_free_fattr(const struct nfs_fattr *fattr)
380 extern struct nfs_fh *nfs_alloc_fhandle(void);
382 static inline void nfs_free_fhandle(const struct nfs_fh *fh)
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)
391 return _nfs_display_fhandle_hash(fh);
393 extern void _nfs_display_fhandle(const struct nfs_fh *fh, const char *caption);
394 #define nfs_display_fhandle(fh, caption) \
396 if (unlikely(nfs_debug & NFSDBG_FACILITY)) \
397 _nfs_display_fhandle(fh, caption); \
400 static inline u32 nfs_display_fhandle_hash(const struct nfs_fh *fh)
404 static inline void nfs_display_fhandle(const struct nfs_fh *fh,
411 * linux/fs/nfs/nfsroot.c
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*/
418 * linux/fs/nfs/file.c
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;
427 static inline struct nfs_open_context *nfs_file_open_context(struct file *filp)
429 return filp->private_data;
432 static inline struct rpc_cred *nfs_file_cred(struct file *file)
435 struct nfs_open_context *ctx =
436 nfs_file_open_context(file);
444 * linux/fs/nfs/xattr.c
446 #ifdef CONFIG_NFS_V3_ACL
447 extern ssize_t nfs3_listxattr(struct dentry *, char *, size_t);
448 extern ssize_t nfs3_getxattr(struct dentry *, const char *, void *, size_t);
449 extern int nfs3_setxattr(struct dentry *, const char *,
450 const void *, size_t, int);
451 extern int nfs3_removexattr (struct dentry *, const char *name);
453 # define nfs3_listxattr NULL
454 # define nfs3_getxattr NULL
455 # define nfs3_setxattr NULL
456 # define nfs3_removexattr NULL
460 * linux/fs/nfs/direct.c
462 extern ssize_t nfs_direct_IO(int, struct kiocb *, struct iov_iter *, loff_t);
463 extern ssize_t nfs_file_direct_read(struct kiocb *iocb,
464 struct iov_iter *iter,
465 loff_t pos, bool uio);
466 extern ssize_t nfs_file_direct_write(struct kiocb *iocb,
467 struct iov_iter *iter,
468 loff_t pos, bool uio);
473 extern const struct file_operations nfs_dir_operations;
474 extern const struct dentry_operations nfs_dentry_operations;
476 extern void nfs_force_lookup_revalidate(struct inode *dir);
477 extern int nfs_instantiate(struct dentry *dentry, struct nfs_fh *fh,
478 struct nfs_fattr *fattr, struct nfs4_label *label);
479 extern int nfs_may_open(struct inode *inode, struct rpc_cred *cred, int openflags);
480 extern void nfs_access_zap_cache(struct inode *inode);
483 * linux/fs/nfs/symlink.c
485 extern const struct inode_operations nfs_symlink_inode_operations;
488 * linux/fs/nfs/sysctl.c
491 extern int nfs_register_sysctl(void);
492 extern void nfs_unregister_sysctl(void);
494 #define nfs_register_sysctl() 0
495 #define nfs_unregister_sysctl() do { } while(0)
499 * linux/fs/nfs/namespace.c
501 extern const struct inode_operations nfs_mountpoint_inode_operations;
502 extern const struct inode_operations nfs_referral_inode_operations;
503 extern int nfs_mountpoint_expiry_timeout;
504 extern void nfs_release_automount_timer(void);
507 * linux/fs/nfs/unlink.c
509 extern void nfs_complete_unlink(struct dentry *dentry, struct inode *);
510 extern void nfs_wait_on_sillyrename(struct dentry *dentry);
511 extern void nfs_block_sillyrename(struct dentry *dentry);
512 extern void nfs_unblock_sillyrename(struct dentry *dentry);
515 * linux/fs/nfs/write.c
517 extern int nfs_congestion_kb;
518 extern int nfs_writepage(struct page *page, struct writeback_control *wbc);
519 extern int nfs_writepages(struct address_space *, struct writeback_control *);
520 extern int nfs_flush_incompatible(struct file *file, struct page *page);
521 extern int nfs_updatepage(struct file *, struct page *, unsigned int, unsigned int);
524 * Try to write back everything synchronously (but check the
527 extern int nfs_wb_all(struct inode *inode);
528 extern int nfs_wb_page(struct inode *inode, struct page* page);
529 extern int nfs_wb_page_cancel(struct inode *inode, struct page* page);
530 #if IS_ENABLED(CONFIG_NFS_V3) || IS_ENABLED(CONFIG_NFS_V4)
531 extern int nfs_commit_inode(struct inode *, int);
532 extern struct nfs_commit_data *nfs_commitdata_alloc(void);
533 extern void nfs_commit_free(struct nfs_commit_data *data);
536 nfs_commit_inode(struct inode *inode, int how)
543 nfs_have_writebacks(struct inode *inode)
545 return NFS_I(inode)->npages != 0;
549 * linux/fs/nfs/read.c
551 extern int nfs_readpage(struct file *, struct page *);
552 extern int nfs_readpages(struct file *, struct address_space *,
553 struct list_head *, unsigned);
554 extern int nfs_readpage_async(struct nfs_open_context *, struct inode *,
558 * linux/fs/nfs3proc.c
560 #ifdef CONFIG_NFS_V3_ACL
561 extern struct posix_acl *nfs3_get_acl(struct inode *inode, int type);
562 extern int nfs3_set_acl(struct inode *inode, struct posix_acl *acl, int type);
563 extern int nfs3_proc_setacls(struct inode *inode, struct posix_acl *acl,
564 struct posix_acl *dfacl);
565 extern const struct xattr_handler *nfs3_xattr_handlers[];
567 static inline int nfs3_proc_setacls(struct inode *inode, struct posix_acl *acl,
568 struct posix_acl *dfacl)
572 #endif /* CONFIG_NFS_V3_ACL */
578 static inline loff_t nfs_size_to_loff_t(__u64 size)
580 if (size > (__u64) OFFSET_MAX - 1)
581 return OFFSET_MAX - 1;
582 return (loff_t) size;
586 nfs_fileid_to_ino_t(u64 fileid)
588 ino_t ino = (ino_t) fileid;
589 if (sizeof(ino_t) < sizeof(u64))
590 ino ^= fileid >> (sizeof(u64)-sizeof(ino_t)) * 8;
594 #define NFS_JUKEBOX_RETRY_TIME (5 * HZ)
599 # define ifdebug(fac) if (unlikely(nfs_debug & NFSDBG_##fac))
600 # define NFS_IFDEBUG(x) x
602 # define ifdebug(fac) if (0)
603 # define NFS_IFDEBUG(x)