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_MAX_UDP_TIMEOUT (60*HZ)
16 #define NFS_MAX_TCP_TIMEOUT (600*HZ)
19 * When flushing a cluster of dirty pages, there can be different
22 #define FLUSH_SYNC 1 /* file being synced, or contention */
23 #define FLUSH_STABLE 4 /* commit to stable storage */
24 #define FLUSH_LOWPRI 8 /* low priority background flush */
25 #define FLUSH_HIGHPRI 16 /* high priority memory reclaim flush */
26 #define FLUSH_NOCOMMIT 32 /* Don't send the NFSv3/v4 COMMIT */
27 #define FLUSH_INVALIDATE 64 /* Invalidate the page cache */
28 #define FLUSH_NOWRITEPAGE 128 /* Don't call writepage() */
33 #include <linux/kref.h>
35 #include <linux/namei.h>
36 #include <linux/pagemap.h>
37 #include <linux/rbtree.h>
38 #include <linux/rwsem.h>
39 #include <linux/wait.h>
41 #include <linux/sunrpc/debug.h>
42 #include <linux/sunrpc/auth.h>
43 #include <linux/sunrpc/clnt.h>
45 #include <linux/nfs.h>
46 #include <linux/nfs2.h>
47 #include <linux/nfs3.h>
48 #include <linux/nfs4.h>
49 #include <linux/nfs_xdr.h>
51 #include <linux/nfs_fs_sb.h>
53 #include <linux/rwsem.h>
54 #include <linux/mempool.h>
57 * These are the default flags for swap requests
59 #define NFS_RPC_SWAPFLAGS (RPC_TASK_SWAPPER|RPC_TASK_ROOTCREDS)
62 * NFSv3/v4 Access mode cache entry
64 struct nfs_access_entry {
65 struct rb_node rb_node;
67 unsigned long jiffies;
68 struct rpc_cred * cred;
73 struct nfs_open_context {
76 struct rpc_cred *cred;
77 struct nfs4_state *state;
82 #define NFS_CONTEXT_ERROR_WRITE (0)
85 struct list_head list;
93 struct nfs_delegation;
98 * nfs fs inode data in memory
102 * The 64bit 'inode number'
114 unsigned long flags; /* atomic bit ops */
115 unsigned long cache_validity; /* bit mask */
118 * read_cache_jiffies is when we started read-caching this inode.
119 * attrtimeo is for how long the cached information is assumed
120 * to be valid. A successful attribute revalidation doubles
121 * attrtimeo (up to acregmax/acdirmax), a failure resets it to
124 * We need to revalidate the cached attrs for this inode if
126 * jiffies - read_cache_jiffies > attrtimeo
128 unsigned long read_cache_jiffies;
129 unsigned long attrtimeo;
130 unsigned long attrtimeo_timestamp;
131 __u64 change_attr; /* v4 only */
133 unsigned long last_updated;
134 /* "Generation counter" for the attribute cache. This is
135 * bumped whenever we update the metadata on the
138 unsigned long cache_change_attribute;
140 * Counter indicating the number of outstanding requests that
141 * will cause a file data update.
143 atomic_t data_updates;
145 struct rb_root access_cache;
146 struct list_head access_cache_entry_lru;
147 struct list_head access_cache_inode_lru;
148 #ifdef CONFIG_NFS_V3_ACL
149 struct posix_acl *acl_access;
150 struct posix_acl *acl_default;
154 * This is the cookie verifier used for NFSv3 readdir
157 __be32 cookieverf[2];
160 * This is the list of dirty unwritten pages.
162 struct radix_tree_root nfs_page_tree;
164 unsigned long ncommit,
167 /* Open contexts for shared mmap writes */
168 struct list_head open_files;
171 struct nfs4_cached_acl *nfs4_acl;
173 struct list_head open_states;
174 struct nfs_delegation *delegation;
175 int delegation_state;
176 struct rw_semaphore rwsem;
177 #endif /* CONFIG_NFS_V4*/
178 struct inode vfs_inode;
182 * Cache validity bit flags
184 #define NFS_INO_INVALID_ATTR 0x0001 /* cached attrs are invalid */
185 #define NFS_INO_INVALID_DATA 0x0002 /* cached data is invalid */
186 #define NFS_INO_INVALID_ATIME 0x0004 /* cached atime is invalid */
187 #define NFS_INO_INVALID_ACCESS 0x0008 /* cached access cred invalid */
188 #define NFS_INO_INVALID_ACL 0x0010 /* cached acls are invalid */
189 #define NFS_INO_REVAL_PAGECACHE 0x0020 /* must revalidate pagecache */
190 #define NFS_INO_REVAL_FORCED 0x0040 /* force revalidation ignoring a delegation */
193 * Bit offsets in flags field
195 #define NFS_INO_REVALIDATING (0) /* revalidating attrs */
196 #define NFS_INO_ADVISE_RDPLUS (1) /* advise readdirplus */
197 #define NFS_INO_STALE (2) /* possible stale inode */
198 #define NFS_INO_ACL_LRU_SET (3) /* Inode is on the LRU list */
200 static inline struct nfs_inode *NFS_I(struct inode *inode)
202 return container_of(inode, struct nfs_inode, vfs_inode);
204 #define NFS_SB(s) ((struct nfs_server *)(s->s_fs_info))
206 #define NFS_FH(inode) (&NFS_I(inode)->fh)
207 #define NFS_SERVER(inode) (NFS_SB(inode->i_sb))
208 #define NFS_CLIENT(inode) (NFS_SERVER(inode)->client)
209 #define NFS_PROTO(inode) (NFS_SERVER(inode)->nfs_client->rpc_ops)
210 #define NFS_COOKIEVERF(inode) (NFS_I(inode)->cookieverf)
211 #define NFS_READTIME(inode) (NFS_I(inode)->read_cache_jiffies)
212 #define NFS_CHANGE_ATTR(inode) (NFS_I(inode)->change_attr)
213 #define NFS_ATTRTIMEO(inode) (NFS_I(inode)->attrtimeo)
214 #define NFS_MINATTRTIMEO(inode) \
215 (S_ISDIR(inode->i_mode)? NFS_SERVER(inode)->acdirmin \
216 : NFS_SERVER(inode)->acregmin)
217 #define NFS_MAXATTRTIMEO(inode) \
218 (S_ISDIR(inode->i_mode)? NFS_SERVER(inode)->acdirmax \
219 : NFS_SERVER(inode)->acregmax)
220 #define NFS_ATTRTIMEO_UPDATE(inode) (NFS_I(inode)->attrtimeo_timestamp)
222 #define NFS_FLAGS(inode) (NFS_I(inode)->flags)
223 #define NFS_STALE(inode) (test_bit(NFS_INO_STALE, &NFS_FLAGS(inode)))
225 #define NFS_FILEID(inode) (NFS_I(inode)->fileid)
227 static inline int nfs_caches_unstable(struct inode *inode)
229 return atomic_read(&NFS_I(inode)->data_updates) != 0;
232 static inline void nfs_mark_for_revalidate(struct inode *inode)
234 struct nfs_inode *nfsi = NFS_I(inode);
236 spin_lock(&inode->i_lock);
237 nfsi->cache_validity |= NFS_INO_INVALID_ATTR|NFS_INO_INVALID_ACCESS;
238 if (S_ISDIR(inode->i_mode))
239 nfsi->cache_validity |= NFS_INO_REVAL_PAGECACHE|NFS_INO_INVALID_DATA;
240 spin_unlock(&inode->i_lock);
243 static inline void NFS_CACHEINV(struct inode *inode)
245 if (!nfs_caches_unstable(inode))
246 nfs_mark_for_revalidate(inode);
249 static inline int nfs_server_capable(struct inode *inode, int cap)
251 return NFS_SERVER(inode)->caps & cap;
254 static inline int NFS_USE_READDIRPLUS(struct inode *inode)
256 return test_bit(NFS_INO_ADVISE_RDPLUS, &NFS_FLAGS(inode));
260 * nfs_save_change_attribute - Returns the inode attribute change cookie
261 * @inode - pointer to inode
262 * The "change attribute" is updated every time we finish an operation
263 * that will result in a metadata change on the server.
265 static inline long nfs_save_change_attribute(struct inode *inode)
267 return NFS_I(inode)->cache_change_attribute;
271 * nfs_verify_change_attribute - Detects NFS inode cache updates
272 * @inode - pointer to inode
273 * @chattr - previously saved change attribute
274 * Return "false" if metadata has been updated (or is in the process of
275 * being updated) since the change attribute was saved.
277 static inline int nfs_verify_change_attribute(struct inode *inode, unsigned long chattr)
279 return !nfs_caches_unstable(inode)
280 && time_after_eq(chattr, NFS_I(inode)->cache_change_attribute);
284 * linux/fs/nfs/inode.c
286 extern int nfs_sync_mapping(struct address_space *mapping);
287 extern void nfs_zap_mapping(struct inode *inode, struct address_space *mapping);
288 extern void nfs_zap_caches(struct inode *);
289 extern struct inode *nfs_fhget(struct super_block *, struct nfs_fh *,
291 extern int nfs_refresh_inode(struct inode *, struct nfs_fattr *);
292 extern int nfs_post_op_update_inode(struct inode *inode, struct nfs_fattr *fattr);
293 extern int nfs_getattr(struct vfsmount *, struct dentry *, struct kstat *);
294 extern int nfs_permission(struct inode *, int, struct nameidata *);
295 extern int nfs_open(struct inode *, struct file *);
296 extern int nfs_release(struct inode *, struct file *);
297 extern int nfs_attribute_timeout(struct inode *inode);
298 extern int nfs_revalidate_inode(struct nfs_server *server, struct inode *inode);
299 extern int __nfs_revalidate_inode(struct nfs_server *, struct inode *);
300 extern int nfs_revalidate_mapping(struct inode *inode, struct address_space *mapping);
301 extern int nfs_revalidate_mapping_nolock(struct inode *inode, struct address_space *mapping);
302 extern int nfs_setattr(struct dentry *, struct iattr *);
303 extern void nfs_setattr_update_inode(struct inode *inode, struct iattr *attr);
304 extern void nfs_begin_attr_update(struct inode *);
305 extern void nfs_end_attr_update(struct inode *);
306 extern void nfs_begin_data_update(struct inode *);
307 extern void nfs_end_data_update(struct inode *);
308 extern struct nfs_open_context *get_nfs_open_context(struct nfs_open_context *ctx);
309 extern void put_nfs_open_context(struct nfs_open_context *ctx);
310 extern struct nfs_open_context *nfs_find_open_context(struct inode *inode, struct rpc_cred *cred, int mode);
312 /* linux/net/ipv4/ipconfig.c: trims ip addr off front of name, too. */
313 extern __be32 root_nfs_parse_addr(char *name); /*__init*/
315 static inline void nfs_fattr_init(struct nfs_fattr *fattr)
318 fattr->time_start = jiffies;
322 * linux/fs/nfs/file.c
324 extern const struct inode_operations nfs_file_inode_operations;
326 extern const struct inode_operations nfs3_file_inode_operations;
327 #endif /* CONFIG_NFS_V3 */
328 extern const struct file_operations nfs_file_operations;
329 extern const struct address_space_operations nfs_file_aops;
331 static inline struct nfs_open_context *nfs_file_open_context(struct file *filp)
333 return filp->private_data;
336 static inline struct rpc_cred *nfs_file_cred(struct file *file)
339 return nfs_file_open_context(file)->cred;
344 * linux/fs/nfs/xattr.c
346 #ifdef CONFIG_NFS_V3_ACL
347 extern ssize_t nfs3_listxattr(struct dentry *, char *, size_t);
348 extern ssize_t nfs3_getxattr(struct dentry *, const char *, void *, size_t);
349 extern int nfs3_setxattr(struct dentry *, const char *,
350 const void *, size_t, int);
351 extern int nfs3_removexattr (struct dentry *, const char *name);
353 # define nfs3_listxattr NULL
354 # define nfs3_getxattr NULL
355 # define nfs3_setxattr NULL
356 # define nfs3_removexattr NULL
360 * linux/fs/nfs/direct.c
362 extern ssize_t nfs_direct_IO(int, struct kiocb *, const struct iovec *, loff_t,
364 extern ssize_t nfs_file_direct_read(struct kiocb *iocb,
365 const struct iovec *iov, unsigned long nr_segs,
367 extern ssize_t nfs_file_direct_write(struct kiocb *iocb,
368 const struct iovec *iov, unsigned long nr_segs,
374 extern const struct inode_operations nfs_dir_inode_operations;
376 extern const struct inode_operations nfs3_dir_inode_operations;
377 #endif /* CONFIG_NFS_V3 */
378 extern const struct file_operations nfs_dir_operations;
379 extern struct dentry_operations nfs_dentry_operations;
381 extern int nfs_instantiate(struct dentry *dentry, struct nfs_fh *fh, struct nfs_fattr *fattr);
382 extern int nfs_may_open(struct inode *inode, struct rpc_cred *cred, int openflags);
383 extern void nfs_access_zap_cache(struct inode *inode);
386 * linux/fs/nfs/symlink.c
388 extern const struct inode_operations nfs_symlink_inode_operations;
391 * linux/fs/nfs/sysctl.c
394 extern int nfs_register_sysctl(void);
395 extern void nfs_unregister_sysctl(void);
397 #define nfs_register_sysctl() 0
398 #define nfs_unregister_sysctl() do { } while(0)
402 * linux/fs/nfs/namespace.c
404 extern struct list_head nfs_automount_list;
405 extern const struct inode_operations nfs_mountpoint_inode_operations;
406 extern const struct inode_operations nfs_referral_inode_operations;
407 extern int nfs_mountpoint_expiry_timeout;
408 extern void nfs_release_automount_timer(void);
411 * linux/fs/nfs/unlink.c
413 extern int nfs_async_unlink(struct inode *dir, struct dentry *dentry);
414 extern void nfs_complete_unlink(struct dentry *dentry, struct inode *);
417 * linux/fs/nfs/write.c
419 extern int nfs_congestion_kb;
420 extern int nfs_writepage(struct page *page, struct writeback_control *wbc);
421 extern int nfs_writepages(struct address_space *, struct writeback_control *);
422 extern int nfs_flush_incompatible(struct file *file, struct page *page);
423 extern int nfs_updatepage(struct file *, struct page *, unsigned int, unsigned int);
424 extern int nfs_writeback_done(struct rpc_task *, struct nfs_write_data *);
425 extern void nfs_writedata_release(void *);
428 * Try to write back everything synchronously (but check the
431 extern long nfs_sync_mapping_wait(struct address_space *, struct writeback_control *, int);
432 extern int nfs_wb_all(struct inode *inode);
433 extern int nfs_wb_nocommit(struct inode *inode);
434 extern int nfs_wb_page(struct inode *inode, struct page* page);
435 extern int nfs_wb_page_priority(struct inode *inode, struct page* page, int how);
436 extern int nfs_wb_page_cancel(struct inode *inode, struct page* page);
437 #if defined(CONFIG_NFS_V3) || defined(CONFIG_NFS_V4)
438 extern int nfs_commit_inode(struct inode *, int);
439 extern struct nfs_write_data *nfs_commit_alloc(void);
440 extern void nfs_commit_free(struct nfs_write_data *wdata);
441 extern void nfs_commit_release(void *wdata);
444 nfs_commit_inode(struct inode *inode, int how)
451 nfs_have_writebacks(struct inode *inode)
453 return NFS_I(inode)->npages != 0;
457 * Allocate nfs_write_data structures
459 extern struct nfs_write_data *nfs_writedata_alloc(unsigned int npages);
462 * linux/fs/nfs/read.c
464 extern int nfs_readpage(struct file *, struct page *);
465 extern int nfs_readpages(struct file *, struct address_space *,
466 struct list_head *, unsigned);
467 extern int nfs_readpage_result(struct rpc_task *, struct nfs_read_data *);
468 extern void nfs_readdata_release(void *data);
471 * Allocate nfs_read_data structures
473 extern struct nfs_read_data *nfs_readdata_alloc(unsigned int npages);
476 * linux/fs/nfs3proc.c
478 #ifdef CONFIG_NFS_V3_ACL
479 extern struct posix_acl *nfs3_proc_getacl(struct inode *inode, int type);
480 extern int nfs3_proc_setacl(struct inode *inode, int type,
481 struct posix_acl *acl);
482 extern int nfs3_proc_set_default_acl(struct inode *dir, struct inode *inode,
484 extern void nfs3_forget_cached_acls(struct inode *inode);
486 static inline int nfs3_proc_set_default_acl(struct inode *dir,
493 static inline void nfs3_forget_cached_acls(struct inode *inode)
496 #endif /* CONFIG_NFS_V3_ACL */
499 * linux/fs/mount_clnt.c
501 extern int nfs_mount(struct sockaddr *, size_t, char *, char *,
502 int, int, struct nfs_fh *);
508 static inline loff_t nfs_size_to_loff_t(__u64 size)
510 if (size > (__u64) OFFSET_MAX - 1)
511 return OFFSET_MAX - 1;
512 return (loff_t) size;
516 nfs_fileid_to_ino_t(u64 fileid)
518 ino_t ino = (ino_t) fileid;
519 if (sizeof(ino_t) < sizeof(u64))
520 ino ^= fileid >> (sizeof(u64)-sizeof(ino_t)) * 8;
526 extern void * nfs_root_data(void);
528 #define nfs_wait_event(clnt, wq, condition) \
531 if (clnt->cl_intr) { \
533 rpc_clnt_sigmask(clnt, &oldmask); \
534 __retval = wait_event_interruptible(wq, condition); \
535 rpc_clnt_sigunmask(clnt, &oldmask); \
537 wait_event(wq, condition); \
541 #define NFS_JUKEBOX_RETRY_TIME (5 * HZ)
543 #endif /* __KERNEL__ */
548 #define NFSDBG_VFS 0x0001
549 #define NFSDBG_DIRCACHE 0x0002
550 #define NFSDBG_LOOKUPCACHE 0x0004
551 #define NFSDBG_PAGECACHE 0x0008
552 #define NFSDBG_PROC 0x0010
553 #define NFSDBG_XDR 0x0020
554 #define NFSDBG_FILE 0x0040
555 #define NFSDBG_ROOT 0x0080
556 #define NFSDBG_CALLBACK 0x0100
557 #define NFSDBG_CLIENT 0x0200
558 #define NFSDBG_MOUNT 0x0400
559 #define NFSDBG_ALL 0xFFFF
564 * Enable debugging support for nfs client.
565 * Requires RPC_DEBUG.
573 # define ifdebug(fac) if (unlikely(nfs_debug & NFSDBG_##fac))
575 # define ifdebug(fac) if (0)
577 #endif /* __KERNEL */