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;
55 struct rcu_head rcu_head;
58 struct nfs_lock_context {
60 struct list_head list;
61 struct nfs_open_context *open_context;
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;
76 #define NFS_CONTEXT_ERROR_WRITE (0)
77 #define NFS_CONTEXT_RESEND_WRITES (1)
78 #define NFS_CONTEXT_BAD (2)
79 #define NFS_CONTEXT_UNLOCK (3)
82 struct list_head list;
83 struct nfs4_threshold *mdsthreshold;
86 struct nfs_open_dir_context {
87 struct list_head list;
88 struct rpc_cred *cred;
89 unsigned long attr_gencount;
98 struct nfs_delegation;
103 * nfs fs inode data in memory
107 * The 64bit 'inode number'
119 unsigned long flags; /* atomic bit ops */
120 unsigned long cache_validity; /* bit mask */
123 * read_cache_jiffies is when we started read-caching this inode.
124 * attrtimeo is for how long the cached information is assumed
125 * to be valid. A successful attribute revalidation doubles
126 * attrtimeo (up to acregmax/acdirmax), a failure resets it to
129 * We need to revalidate the cached attrs for this inode if
131 * jiffies - read_cache_jiffies >= attrtimeo
133 * Please note the comparison is greater than or equal
134 * so that zero timeout values can be specified.
136 unsigned long read_cache_jiffies;
137 unsigned long attrtimeo;
138 unsigned long attrtimeo_timestamp;
140 unsigned long attr_gencount;
141 /* "Generation counter" for the attribute cache. This is
142 * bumped whenever we update the metadata on the
145 unsigned long cache_change_attribute;
147 struct rb_root access_cache;
148 struct list_head access_cache_entry_lru;
149 struct list_head access_cache_inode_lru;
152 * This is the cookie verifier used for NFSv3 readdir
155 __be32 cookieverf[2];
157 unsigned long nrequests;
158 struct nfs_mds_commit_info commit_info;
160 /* Open contexts for shared mmap writes */
161 struct list_head open_files;
163 /* Readers: in-flight sillydelete RPC calls */
165 struct rw_semaphore rmdir_sem;
167 #if IS_ENABLED(CONFIG_NFS_V4)
168 struct nfs4_cached_acl *nfs4_acl;
170 struct list_head open_states;
171 struct nfs_delegation __rcu *delegation;
172 struct rw_semaphore rwsem;
174 /* pNFS layout information */
175 struct pnfs_layout_hdr *layout;
176 #endif /* CONFIG_NFS_V4*/
177 /* how many bytes have been written/read and how many bytes queued up */
180 #ifdef CONFIG_NFS_FSCACHE
181 struct fscache_cookie *fscache;
183 struct inode vfs_inode;
187 * Cache validity bit flags
189 #define NFS_INO_INVALID_ATTR 0x0001 /* cached attrs are invalid */
190 #define NFS_INO_INVALID_DATA 0x0002 /* cached data is invalid */
191 #define NFS_INO_INVALID_ATIME 0x0004 /* cached atime is invalid */
192 #define NFS_INO_INVALID_ACCESS 0x0008 /* cached access cred invalid */
193 #define NFS_INO_INVALID_ACL 0x0010 /* cached acls are invalid */
194 #define NFS_INO_REVAL_PAGECACHE 0x0020 /* must revalidate pagecache */
195 #define NFS_INO_REVAL_FORCED 0x0040 /* force revalidation ignoring a delegation */
196 #define NFS_INO_INVALID_LABEL 0x0080 /* cached label is invalid */
199 * Bit offsets in flags field
201 #define NFS_INO_ADVISE_RDPLUS (0) /* advise readdirplus */
202 #define NFS_INO_STALE (1) /* possible stale inode */
203 #define NFS_INO_ACL_LRU_SET (2) /* Inode is on the LRU list */
204 #define NFS_INO_INVALIDATING (3) /* inode is being invalidated */
205 #define NFS_INO_FSCACHE (5) /* inode can be cached by FS-Cache */
206 #define NFS_INO_FSCACHE_LOCK (6) /* FS-Cache cookie management lock */
207 #define NFS_INO_LAYOUTCOMMIT (9) /* layoutcommit required */
208 #define NFS_INO_LAYOUTCOMMITTING (10) /* layoutcommit inflight */
209 #define NFS_INO_LAYOUTSTATS (11) /* layoutstats inflight */
210 #define NFS_INO_ODIRECT (12) /* I/O setting is O_DIRECT */
212 static inline struct nfs_inode *NFS_I(const struct inode *inode)
214 return container_of(inode, struct nfs_inode, vfs_inode);
217 static inline struct nfs_server *NFS_SB(const struct super_block *s)
219 return (struct nfs_server *)(s->s_fs_info);
222 static inline struct nfs_fh *NFS_FH(const struct inode *inode)
224 return &NFS_I(inode)->fh;
227 static inline struct nfs_server *NFS_SERVER(const struct inode *inode)
229 return NFS_SB(inode->i_sb);
232 static inline struct rpc_clnt *NFS_CLIENT(const struct inode *inode)
234 return NFS_SERVER(inode)->client;
237 static inline const struct nfs_rpc_ops *NFS_PROTO(const struct inode *inode)
239 return NFS_SERVER(inode)->nfs_client->rpc_ops;
242 static inline unsigned NFS_MINATTRTIMEO(const struct inode *inode)
244 struct nfs_server *nfss = NFS_SERVER(inode);
245 return S_ISDIR(inode->i_mode) ? nfss->acdirmin : nfss->acregmin;
248 static inline unsigned NFS_MAXATTRTIMEO(const struct inode *inode)
250 struct nfs_server *nfss = NFS_SERVER(inode);
251 return S_ISDIR(inode->i_mode) ? nfss->acdirmax : nfss->acregmax;
254 static inline int NFS_STALE(const struct inode *inode)
256 return test_bit(NFS_INO_STALE, &NFS_I(inode)->flags);
259 static inline struct fscache_cookie *nfs_i_fscache(struct inode *inode)
261 #ifdef CONFIG_NFS_FSCACHE
262 return NFS_I(inode)->fscache;
268 static inline __u64 NFS_FILEID(const struct inode *inode)
270 return NFS_I(inode)->fileid;
273 static inline void set_nfs_fileid(struct inode *inode, __u64 fileid)
275 NFS_I(inode)->fileid = fileid;
278 static inline void nfs_mark_for_revalidate(struct inode *inode)
280 struct nfs_inode *nfsi = NFS_I(inode);
282 spin_lock(&inode->i_lock);
283 nfsi->cache_validity |= NFS_INO_INVALID_ATTR |
284 NFS_INO_REVAL_PAGECACHE |
285 NFS_INO_INVALID_ACCESS |
287 if (S_ISDIR(inode->i_mode))
288 nfsi->cache_validity |= NFS_INO_INVALID_DATA;
289 spin_unlock(&inode->i_lock);
292 static inline int nfs_server_capable(struct inode *inode, int cap)
294 return NFS_SERVER(inode)->caps & cap;
297 static inline void nfs_set_verifier(struct dentry * dentry, unsigned long verf)
299 dentry->d_time = verf;
303 * nfs_save_change_attribute - Returns the inode attribute change cookie
304 * @dir - pointer to parent directory inode
305 * The "change attribute" is updated every time we finish an operation
306 * that will result in a metadata change on the server.
308 static inline unsigned long nfs_save_change_attribute(struct inode *dir)
310 return NFS_I(dir)->cache_change_attribute;
314 * nfs_verify_change_attribute - Detects NFS remote directory changes
315 * @dir - pointer to parent directory inode
316 * @chattr - previously saved change attribute
317 * Return "false" if the verifiers doesn't match the change attribute.
318 * This would usually indicate that the directory contents have changed on
319 * the server, and that any dentries need revalidating.
321 static inline int nfs_verify_change_attribute(struct inode *dir, unsigned long chattr)
323 return chattr == NFS_I(dir)->cache_change_attribute;
327 * linux/fs/nfs/inode.c
329 extern int nfs_sync_mapping(struct address_space *mapping);
330 extern void nfs_zap_mapping(struct inode *inode, struct address_space *mapping);
331 extern void nfs_zap_caches(struct inode *);
332 extern void nfs_invalidate_atime(struct inode *);
333 extern struct inode *nfs_fhget(struct super_block *, struct nfs_fh *,
334 struct nfs_fattr *, struct nfs4_label *);
335 extern int nfs_refresh_inode(struct inode *, struct nfs_fattr *);
336 extern int nfs_post_op_update_inode(struct inode *inode, struct nfs_fattr *fattr);
337 extern int nfs_post_op_update_inode_force_wcc(struct inode *inode, struct nfs_fattr *fattr);
338 extern int nfs_post_op_update_inode_force_wcc_locked(struct inode *inode, struct nfs_fattr *fattr);
339 extern int nfs_getattr(const struct path *, struct kstat *, u32, unsigned int);
340 extern void nfs_access_add_cache(struct inode *, struct nfs_access_entry *);
341 extern void nfs_access_set_mask(struct nfs_access_entry *, u32);
342 extern int nfs_permission(struct inode *, int);
343 extern int nfs_open(struct inode *, struct file *);
344 extern int nfs_attribute_cache_expired(struct inode *inode);
345 extern int nfs_revalidate_inode(struct nfs_server *server, struct inode *inode);
346 extern int __nfs_revalidate_inode(struct nfs_server *, struct inode *);
347 extern bool nfs_mapping_need_revalidate_inode(struct inode *inode);
348 extern int nfs_revalidate_mapping(struct inode *inode, struct address_space *mapping);
349 extern int nfs_revalidate_mapping_rcu(struct inode *inode);
350 extern int nfs_setattr(struct dentry *, struct iattr *);
351 extern void nfs_setattr_update_inode(struct inode *inode, struct iattr *attr, struct nfs_fattr *);
352 extern void nfs_setsecurity(struct inode *inode, struct nfs_fattr *fattr,
353 struct nfs4_label *label);
354 extern struct nfs_open_context *get_nfs_open_context(struct nfs_open_context *ctx);
355 extern void put_nfs_open_context(struct nfs_open_context *ctx);
356 extern struct nfs_open_context *nfs_find_open_context(struct inode *inode, struct rpc_cred *cred, fmode_t mode);
357 extern struct nfs_open_context *alloc_nfs_open_context(struct dentry *dentry, fmode_t f_mode, struct file *filp);
358 extern void nfs_inode_attach_open_context(struct nfs_open_context *ctx);
359 extern void nfs_file_set_open_context(struct file *filp, struct nfs_open_context *ctx);
360 extern void nfs_file_clear_open_context(struct file *flip);
361 extern struct nfs_lock_context *nfs_get_lock_context(struct nfs_open_context *ctx);
362 extern void nfs_put_lock_context(struct nfs_lock_context *l_ctx);
363 extern u64 nfs_compat_user_ino64(u64 fileid);
364 extern void nfs_fattr_init(struct nfs_fattr *fattr);
365 extern void nfs_fattr_set_barrier(struct nfs_fattr *fattr);
366 extern unsigned long nfs_inc_attr_generation_counter(void);
368 extern struct nfs_fattr *nfs_alloc_fattr(void);
370 static inline void nfs_free_fattr(const struct nfs_fattr *fattr)
375 extern struct nfs_fh *nfs_alloc_fhandle(void);
377 static inline void nfs_free_fhandle(const struct nfs_fh *fh)
383 extern u32 _nfs_display_fhandle_hash(const struct nfs_fh *fh);
384 static inline u32 nfs_display_fhandle_hash(const struct nfs_fh *fh)
386 return _nfs_display_fhandle_hash(fh);
388 extern void _nfs_display_fhandle(const struct nfs_fh *fh, const char *caption);
389 #define nfs_display_fhandle(fh, caption) \
391 if (unlikely(nfs_debug & NFSDBG_FACILITY)) \
392 _nfs_display_fhandle(fh, caption); \
395 static inline u32 nfs_display_fhandle_hash(const struct nfs_fh *fh)
399 static inline void nfs_display_fhandle(const struct nfs_fh *fh,
406 * linux/fs/nfs/nfsroot.c
408 extern int nfs_root_data(char **root_device, char **root_data); /*__init*/
409 /* linux/net/ipv4/ipconfig.c: trims ip addr off front of name, too. */
410 extern __be32 root_nfs_parse_addr(char *name); /*__init*/
413 * linux/fs/nfs/file.c
415 extern const struct file_operations nfs_file_operations;
416 #if IS_ENABLED(CONFIG_NFS_V4)
417 extern const struct file_operations nfs4_file_operations;
418 #endif /* CONFIG_NFS_V4 */
419 extern const struct address_space_operations nfs_file_aops;
420 extern const struct address_space_operations nfs_dir_aops;
422 static inline struct nfs_open_context *nfs_file_open_context(struct file *filp)
424 return filp->private_data;
427 static inline struct rpc_cred *nfs_file_cred(struct file *file)
430 struct nfs_open_context *ctx =
431 nfs_file_open_context(file);
439 * linux/fs/nfs/direct.c
441 extern ssize_t nfs_direct_IO(struct kiocb *, struct iov_iter *);
442 extern ssize_t nfs_file_direct_read(struct kiocb *iocb,
443 struct iov_iter *iter);
444 extern ssize_t nfs_file_direct_write(struct kiocb *iocb,
445 struct iov_iter *iter);
450 extern const struct file_operations nfs_dir_operations;
451 extern const struct dentry_operations nfs_dentry_operations;
453 extern void nfs_force_lookup_revalidate(struct inode *dir);
454 extern int nfs_instantiate(struct dentry *dentry, struct nfs_fh *fh,
455 struct nfs_fattr *fattr, struct nfs4_label *label);
456 extern int nfs_may_open(struct inode *inode, struct rpc_cred *cred, int openflags);
457 extern void nfs_access_zap_cache(struct inode *inode);
460 * linux/fs/nfs/symlink.c
462 extern const struct inode_operations nfs_symlink_inode_operations;
465 * linux/fs/nfs/sysctl.c
468 extern int nfs_register_sysctl(void);
469 extern void nfs_unregister_sysctl(void);
471 #define nfs_register_sysctl() 0
472 #define nfs_unregister_sysctl() do { } while(0)
476 * linux/fs/nfs/namespace.c
478 extern const struct inode_operations nfs_mountpoint_inode_operations;
479 extern const struct inode_operations nfs_referral_inode_operations;
480 extern int nfs_mountpoint_expiry_timeout;
481 extern void nfs_release_automount_timer(void);
484 * linux/fs/nfs/unlink.c
486 extern void nfs_complete_unlink(struct dentry *dentry, struct inode *);
489 * linux/fs/nfs/write.c
491 extern int nfs_congestion_kb;
492 extern int nfs_writepage(struct page *page, struct writeback_control *wbc);
493 extern int nfs_writepages(struct address_space *, struct writeback_control *);
494 extern int nfs_flush_incompatible(struct file *file, struct page *page);
495 extern int nfs_updatepage(struct file *, struct page *, unsigned int, unsigned int);
498 * Try to write back everything synchronously (but check the
501 extern int nfs_sync_inode(struct inode *inode);
502 extern int nfs_wb_all(struct inode *inode);
503 extern int nfs_wb_page(struct inode *inode, struct page *page);
504 extern int nfs_wb_page_cancel(struct inode *inode, struct page* page);
505 extern int nfs_commit_inode(struct inode *, int);
506 extern struct nfs_commit_data *nfs_commitdata_alloc(bool never_fail);
507 extern void nfs_commit_free(struct nfs_commit_data *data);
510 nfs_have_writebacks(struct inode *inode)
512 return NFS_I(inode)->nrequests != 0;
516 * linux/fs/nfs/read.c
518 extern int nfs_readpage(struct file *, struct page *);
519 extern int nfs_readpages(struct file *, struct address_space *,
520 struct list_head *, unsigned);
521 extern int nfs_readpage_async(struct nfs_open_context *, struct inode *,
528 static inline loff_t nfs_size_to_loff_t(__u64 size)
530 return min_t(u64, size, OFFSET_MAX);
534 nfs_fileid_to_ino_t(u64 fileid)
536 ino_t ino = (ino_t) fileid;
537 if (sizeof(ino_t) < sizeof(u64))
538 ino ^= fileid >> (sizeof(u64)-sizeof(ino_t)) * 8;
542 #define NFS_JUKEBOX_RETRY_TIME (5 * HZ)
547 # define ifdebug(fac) if (unlikely(nfs_debug & NFSDBG_##fac))
548 # define NFS_IFDEBUG(x) x
550 # define ifdebug(fac) if (0)
551 # define NFS_IFDEBUG(x)