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_lock_context {
86 struct list_head list;
87 struct nfs_open_context *open_context;
93 struct nfs_open_context {
94 struct nfs_lock_context lock_context;
95 struct dentry *dentry;
96 struct rpc_cred *cred;
97 struct nfs4_state *state;
101 #define NFS_CONTEXT_ERROR_WRITE (0)
104 struct list_head list;
107 struct nfs_open_dir_context {
108 struct rpc_cred *cred;
109 unsigned long attr_gencount;
118 struct nfs_delegation;
123 * nfs fs inode data in memory
127 * The 64bit 'inode number'
139 unsigned long flags; /* atomic bit ops */
140 unsigned long cache_validity; /* bit mask */
143 * read_cache_jiffies is when we started read-caching this inode.
144 * attrtimeo is for how long the cached information is assumed
145 * to be valid. A successful attribute revalidation doubles
146 * attrtimeo (up to acregmax/acdirmax), a failure resets it to
149 * We need to revalidate the cached attrs for this inode if
151 * jiffies - read_cache_jiffies >= attrtimeo
153 * Please note the comparison is greater than or equal
154 * so that zero timeout values can be specified.
156 unsigned long read_cache_jiffies;
157 unsigned long attrtimeo;
158 unsigned long attrtimeo_timestamp;
160 unsigned long attr_gencount;
161 /* "Generation counter" for the attribute cache. This is
162 * bumped whenever we update the metadata on the
165 unsigned long cache_change_attribute;
167 struct rb_root access_cache;
168 struct list_head access_cache_entry_lru;
169 struct list_head access_cache_inode_lru;
170 #ifdef CONFIG_NFS_V3_ACL
171 struct posix_acl *acl_access;
172 struct posix_acl *acl_default;
176 * This is the cookie verifier used for NFSv3 readdir
179 __be32 cookieverf[2];
181 unsigned long npages;
182 unsigned long ncommit;
183 struct list_head commit_list;
185 /* Open contexts for shared mmap writes */
186 struct list_head open_files;
188 /* Number of in-flight sillydelete RPC calls */
189 atomic_t silly_count;
190 /* List of deferred sillydelete requests */
191 struct hlist_head silly_list;
192 wait_queue_head_t waitqueue;
195 struct nfs4_cached_acl *nfs4_acl;
197 struct list_head open_states;
198 struct nfs_delegation __rcu *delegation;
199 fmode_t delegation_state;
200 struct rw_semaphore rwsem;
202 /* pNFS layout information */
203 struct pnfs_layout_hdr *layout;
204 atomic_t commits_outstanding;
205 #endif /* CONFIG_NFS_V4*/
206 #ifdef CONFIG_NFS_FSCACHE
207 struct fscache_cookie *fscache;
209 struct inode vfs_inode;
213 * Cache validity bit flags
215 #define NFS_INO_INVALID_ATTR 0x0001 /* cached attrs are invalid */
216 #define NFS_INO_INVALID_DATA 0x0002 /* cached data is invalid */
217 #define NFS_INO_INVALID_ATIME 0x0004 /* cached atime is invalid */
218 #define NFS_INO_INVALID_ACCESS 0x0008 /* cached access cred invalid */
219 #define NFS_INO_INVALID_ACL 0x0010 /* cached acls are invalid */
220 #define NFS_INO_REVAL_PAGECACHE 0x0020 /* must revalidate pagecache */
221 #define NFS_INO_REVAL_FORCED 0x0040 /* force revalidation ignoring a delegation */
224 * Bit offsets in flags field
226 #define NFS_INO_ADVISE_RDPLUS (0) /* advise readdirplus */
227 #define NFS_INO_STALE (1) /* possible stale inode */
228 #define NFS_INO_ACL_LRU_SET (2) /* Inode is on the LRU list */
229 #define NFS_INO_FLUSHING (4) /* inode is flushing out data */
230 #define NFS_INO_FSCACHE (5) /* inode can be cached by FS-Cache */
231 #define NFS_INO_FSCACHE_LOCK (6) /* FS-Cache cookie management lock */
232 #define NFS_INO_COMMIT (7) /* inode is committing unstable writes */
233 #define NFS_INO_PNFS_COMMIT (8) /* use pnfs code for commit */
234 #define NFS_INO_LAYOUTCOMMIT (9) /* layoutcommit required */
235 #define NFS_INO_LAYOUTCOMMITTING (10) /* layoutcommit inflight */
236 #define NFS_INO_SEEN_GETATTR (11) /* flag to track if app is calling
237 * getattr in a directory during
241 static inline struct nfs_inode *NFS_I(const struct inode *inode)
243 return container_of(inode, struct nfs_inode, vfs_inode);
246 static inline struct nfs_server *NFS_SB(const struct super_block *s)
248 return (struct nfs_server *)(s->s_fs_info);
251 static inline struct nfs_fh *NFS_FH(const struct inode *inode)
253 return &NFS_I(inode)->fh;
256 static inline struct nfs_server *NFS_SERVER(const struct inode *inode)
258 return NFS_SB(inode->i_sb);
261 static inline struct rpc_clnt *NFS_CLIENT(const struct inode *inode)
263 return NFS_SERVER(inode)->client;
266 static inline const struct nfs_rpc_ops *NFS_PROTO(const struct inode *inode)
268 return NFS_SERVER(inode)->nfs_client->rpc_ops;
271 static inline __be32 *NFS_COOKIEVERF(const struct inode *inode)
273 return NFS_I(inode)->cookieverf;
276 static inline unsigned NFS_MINATTRTIMEO(const struct inode *inode)
278 struct nfs_server *nfss = NFS_SERVER(inode);
279 return S_ISDIR(inode->i_mode) ? nfss->acdirmin : nfss->acregmin;
282 static inline unsigned NFS_MAXATTRTIMEO(const struct inode *inode)
284 struct nfs_server *nfss = NFS_SERVER(inode);
285 return S_ISDIR(inode->i_mode) ? nfss->acdirmax : nfss->acregmax;
288 static inline int NFS_STALE(const struct inode *inode)
290 return test_bit(NFS_INO_STALE, &NFS_I(inode)->flags);
293 static inline int NFS_FSCACHE(const struct inode *inode)
295 return test_bit(NFS_INO_FSCACHE, &NFS_I(inode)->flags);
298 static inline __u64 NFS_FILEID(const struct inode *inode)
300 return NFS_I(inode)->fileid;
303 static inline void set_nfs_fileid(struct inode *inode, __u64 fileid)
305 NFS_I(inode)->fileid = fileid;
308 static inline void nfs_mark_for_revalidate(struct inode *inode)
310 struct nfs_inode *nfsi = NFS_I(inode);
312 spin_lock(&inode->i_lock);
313 nfsi->cache_validity |= NFS_INO_INVALID_ATTR|NFS_INO_INVALID_ACCESS;
314 if (S_ISDIR(inode->i_mode))
315 nfsi->cache_validity |= NFS_INO_REVAL_PAGECACHE|NFS_INO_INVALID_DATA;
316 spin_unlock(&inode->i_lock);
319 static inline int nfs_server_capable(struct inode *inode, int cap)
321 return NFS_SERVER(inode)->caps & cap;
324 static inline int NFS_USE_READDIRPLUS(struct inode *inode)
326 return test_bit(NFS_INO_ADVISE_RDPLUS, &NFS_I(inode)->flags);
329 static inline void nfs_set_verifier(struct dentry * dentry, unsigned long verf)
331 dentry->d_time = verf;
335 * nfs_save_change_attribute - Returns the inode attribute change cookie
336 * @dir - pointer to parent directory inode
337 * The "change attribute" is updated every time we finish an operation
338 * that will result in a metadata change on the server.
340 static inline unsigned long nfs_save_change_attribute(struct inode *dir)
342 return NFS_I(dir)->cache_change_attribute;
346 * nfs_verify_change_attribute - Detects NFS remote directory changes
347 * @dir - pointer to parent directory inode
348 * @chattr - previously saved change attribute
349 * Return "false" if the verifiers doesn't match the change attribute.
350 * This would usually indicate that the directory contents have changed on
351 * the server, and that any dentries need revalidating.
353 static inline int nfs_verify_change_attribute(struct inode *dir, unsigned long chattr)
355 return chattr == NFS_I(dir)->cache_change_attribute;
359 * linux/fs/nfs/inode.c
361 extern int nfs_sync_mapping(struct address_space *mapping);
362 extern void nfs_zap_mapping(struct inode *inode, struct address_space *mapping);
363 extern void nfs_zap_caches(struct inode *);
364 extern void nfs_invalidate_atime(struct inode *);
365 extern struct inode *nfs_fhget(struct super_block *, struct nfs_fh *,
367 extern int nfs_refresh_inode(struct inode *, struct nfs_fattr *);
368 extern int nfs_post_op_update_inode(struct inode *inode, struct nfs_fattr *fattr);
369 extern int nfs_post_op_update_inode_force_wcc(struct inode *inode, struct nfs_fattr *fattr);
370 extern int nfs_getattr(struct vfsmount *, struct dentry *, struct kstat *);
371 extern int nfs_permission(struct inode *, int);
372 extern int nfs_open(struct inode *, struct file *);
373 extern int nfs_release(struct inode *, struct file *);
374 extern int nfs_attribute_timeout(struct inode *inode);
375 extern int nfs_revalidate_inode(struct nfs_server *server, struct inode *inode);
376 extern int __nfs_revalidate_inode(struct nfs_server *, struct inode *);
377 extern int nfs_revalidate_mapping(struct inode *inode, struct address_space *mapping);
378 extern int nfs_setattr(struct dentry *, struct iattr *);
379 extern void nfs_setattr_update_inode(struct inode *inode, struct iattr *attr);
380 extern struct nfs_open_context *get_nfs_open_context(struct nfs_open_context *ctx);
381 extern void put_nfs_open_context(struct nfs_open_context *ctx);
382 extern struct nfs_open_context *nfs_find_open_context(struct inode *inode, struct rpc_cred *cred, fmode_t mode);
383 extern struct nfs_open_context *alloc_nfs_open_context(struct dentry *dentry, fmode_t f_mode);
384 extern void nfs_file_set_open_context(struct file *filp, struct nfs_open_context *ctx);
385 extern struct nfs_lock_context *nfs_get_lock_context(struct nfs_open_context *ctx);
386 extern void nfs_put_lock_context(struct nfs_lock_context *l_ctx);
387 extern u64 nfs_compat_user_ino64(u64 fileid);
388 extern void nfs_fattr_init(struct nfs_fattr *fattr);
389 extern unsigned long nfs_inc_attr_generation_counter(void);
391 extern struct nfs_fattr *nfs_alloc_fattr(void);
393 static inline void nfs_free_fattr(const struct nfs_fattr *fattr)
398 extern struct nfs_fh *nfs_alloc_fhandle(void);
400 static inline void nfs_free_fhandle(const struct nfs_fh *fh)
406 extern u32 _nfs_display_fhandle_hash(const struct nfs_fh *fh);
407 static inline u32 nfs_display_fhandle_hash(const struct nfs_fh *fh)
409 return _nfs_display_fhandle_hash(fh);
411 extern void _nfs_display_fhandle(const struct nfs_fh *fh, const char *caption);
412 #define nfs_display_fhandle(fh, caption) \
414 if (unlikely(nfs_debug & NFSDBG_FACILITY)) \
415 _nfs_display_fhandle(fh, caption); \
418 static inline u32 nfs_display_fhandle_hash(const struct nfs_fh *fh)
422 static inline void nfs_display_fhandle(const struct nfs_fh *fh,
429 * linux/fs/nfs/nfsroot.c
431 extern int nfs_root_data(char **root_device, char **root_data); /*__init*/
432 /* linux/net/ipv4/ipconfig.c: trims ip addr off front of name, too. */
433 extern __be32 root_nfs_parse_addr(char *name); /*__init*/
436 * linux/fs/nfs/file.c
438 extern const struct inode_operations nfs_file_inode_operations;
440 extern const struct inode_operations nfs3_file_inode_operations;
441 #endif /* CONFIG_NFS_V3 */
442 extern const struct file_operations nfs_file_operations;
444 extern const struct file_operations nfs4_file_operations;
445 #endif /* CONFIG_NFS_V4 */
446 extern const struct address_space_operations nfs_file_aops;
447 extern const struct address_space_operations nfs_dir_aops;
449 static inline struct nfs_open_context *nfs_file_open_context(struct file *filp)
451 return filp->private_data;
454 static inline struct rpc_cred *nfs_file_cred(struct file *file)
457 struct nfs_open_context *ctx =
458 nfs_file_open_context(file);
466 * linux/fs/nfs/xattr.c
468 #ifdef CONFIG_NFS_V3_ACL
469 extern ssize_t nfs3_listxattr(struct dentry *, char *, size_t);
470 extern ssize_t nfs3_getxattr(struct dentry *, const char *, void *, size_t);
471 extern int nfs3_setxattr(struct dentry *, const char *,
472 const void *, size_t, int);
473 extern int nfs3_removexattr (struct dentry *, const char *name);
475 # define nfs3_listxattr NULL
476 # define nfs3_getxattr NULL
477 # define nfs3_setxattr NULL
478 # define nfs3_removexattr NULL
482 * linux/fs/nfs/direct.c
484 extern ssize_t nfs_direct_IO(int, struct kiocb *, const struct iovec *, loff_t,
486 extern ssize_t nfs_file_direct_read(struct kiocb *iocb,
487 const struct iovec *iov, unsigned long nr_segs,
489 extern ssize_t nfs_file_direct_write(struct kiocb *iocb,
490 const struct iovec *iov, unsigned long nr_segs,
496 extern const struct inode_operations nfs_dir_inode_operations;
498 extern const struct inode_operations nfs3_dir_inode_operations;
499 #endif /* CONFIG_NFS_V3 */
500 extern const struct file_operations nfs_dir_operations;
501 extern const struct dentry_operations nfs_dentry_operations;
503 extern void nfs_force_lookup_revalidate(struct inode *dir);
504 extern int nfs_instantiate(struct dentry *dentry, struct nfs_fh *fh, struct nfs_fattr *fattr);
505 extern int nfs_may_open(struct inode *inode, struct rpc_cred *cred, int openflags);
506 extern void nfs_access_zap_cache(struct inode *inode);
509 * linux/fs/nfs/symlink.c
511 extern const struct inode_operations nfs_symlink_inode_operations;
514 * linux/fs/nfs/sysctl.c
517 extern int nfs_register_sysctl(void);
518 extern void nfs_unregister_sysctl(void);
520 #define nfs_register_sysctl() 0
521 #define nfs_unregister_sysctl() do { } while(0)
525 * linux/fs/nfs/namespace.c
527 extern const struct inode_operations nfs_mountpoint_inode_operations;
528 extern const struct inode_operations nfs_referral_inode_operations;
529 extern int nfs_mountpoint_expiry_timeout;
530 extern void nfs_release_automount_timer(void);
533 * linux/fs/nfs/unlink.c
535 extern void nfs_complete_unlink(struct dentry *dentry, struct inode *);
536 extern void nfs_block_sillyrename(struct dentry *dentry);
537 extern void nfs_unblock_sillyrename(struct dentry *dentry);
538 extern int nfs_sillyrename(struct inode *dir, struct dentry *dentry);
541 * linux/fs/nfs/write.c
543 extern int nfs_congestion_kb;
544 extern int nfs_writepage(struct page *page, struct writeback_control *wbc);
545 extern int nfs_writepages(struct address_space *, struct writeback_control *);
546 extern int nfs_flush_incompatible(struct file *file, struct page *page);
547 extern int nfs_updatepage(struct file *, struct page *, unsigned int, unsigned int);
548 extern void nfs_writeback_done(struct rpc_task *, struct nfs_write_data *);
551 * Try to write back everything synchronously (but check the
554 extern int nfs_wb_all(struct inode *inode);
555 extern int nfs_wb_page(struct inode *inode, struct page* page);
556 extern int nfs_wb_page_cancel(struct inode *inode, struct page* page);
557 #if defined(CONFIG_NFS_V3) || defined(CONFIG_NFS_V4)
558 extern int nfs_commit_inode(struct inode *, int);
559 extern struct nfs_write_data *nfs_commitdata_alloc(void);
560 extern void nfs_commit_free(struct nfs_write_data *wdata);
563 nfs_commit_inode(struct inode *inode, int how)
570 nfs_have_writebacks(struct inode *inode)
572 return NFS_I(inode)->npages != 0;
576 * Allocate nfs_write_data structures
578 extern struct nfs_write_data *nfs_writedata_alloc(unsigned int npages);
579 extern void nfs_writedata_free(struct nfs_write_data *);
582 * linux/fs/nfs/read.c
584 extern int nfs_readpage(struct file *, struct page *);
585 extern int nfs_readpages(struct file *, struct address_space *,
586 struct list_head *, unsigned);
587 extern int nfs_readpage_result(struct rpc_task *, struct nfs_read_data *);
588 extern int nfs_readpage_async(struct nfs_open_context *, struct inode *,
592 * Allocate nfs_read_data structures
594 extern struct nfs_read_data *nfs_readdata_alloc(unsigned int npages);
595 extern void nfs_readdata_free(struct nfs_read_data *);
598 * linux/fs/nfs3proc.c
600 #ifdef CONFIG_NFS_V3_ACL
601 extern struct posix_acl *nfs3_proc_getacl(struct inode *inode, int type);
602 extern int nfs3_proc_setacl(struct inode *inode, int type,
603 struct posix_acl *acl);
604 extern int nfs3_proc_set_default_acl(struct inode *dir, struct inode *inode,
606 extern void nfs3_forget_cached_acls(struct inode *inode);
608 static inline int nfs3_proc_set_default_acl(struct inode *dir,
615 static inline void nfs3_forget_cached_acls(struct inode *inode)
618 #endif /* CONFIG_NFS_V3_ACL */
624 static inline loff_t nfs_size_to_loff_t(__u64 size)
626 if (size > (__u64) OFFSET_MAX - 1)
627 return OFFSET_MAX - 1;
628 return (loff_t) size;
632 nfs_fileid_to_ino_t(u64 fileid)
634 ino_t ino = (ino_t) fileid;
635 if (sizeof(ino_t) < sizeof(u64))
636 ino ^= fileid >> (sizeof(u64)-sizeof(ino_t)) * 8;
640 #define NFS_JUKEBOX_RETRY_TIME (5 * HZ)
642 #endif /* __KERNEL__ */
647 #define NFSDBG_VFS 0x0001
648 #define NFSDBG_DIRCACHE 0x0002
649 #define NFSDBG_LOOKUPCACHE 0x0004
650 #define NFSDBG_PAGECACHE 0x0008
651 #define NFSDBG_PROC 0x0010
652 #define NFSDBG_XDR 0x0020
653 #define NFSDBG_FILE 0x0040
654 #define NFSDBG_ROOT 0x0080
655 #define NFSDBG_CALLBACK 0x0100
656 #define NFSDBG_CLIENT 0x0200
657 #define NFSDBG_MOUNT 0x0400
658 #define NFSDBG_FSCACHE 0x0800
659 #define NFSDBG_PNFS 0x1000
660 #define NFSDBG_PNFS_LD 0x2000
661 #define NFSDBG_ALL 0xFFFF
667 # define ifdebug(fac) if (unlikely(nfs_debug & NFSDBG_##fac))
668 # define NFS_IFDEBUG(x) x
670 # define ifdebug(fac) if (0)
671 # define NFS_IFDEBUG(x)
673 #endif /* __KERNEL */