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/config.h>
15 #include <linux/pagemap.h>
16 #include <linux/rwsem.h>
17 #include <linux/wait.h>
19 #include <linux/nfs_fs_sb.h>
21 #include <linux/sunrpc/debug.h>
22 #include <linux/sunrpc/auth.h>
23 #include <linux/sunrpc/clnt.h>
25 #include <linux/nfs.h>
26 #include <linux/nfs2.h>
27 #include <linux/nfs3.h>
28 #include <linux/nfs4.h>
29 #include <linux/nfs_xdr.h>
30 #include <linux/rwsem.h>
31 #include <linux/mempool.h>
34 * Enable debugging support for nfs client.
41 /* Default timeout values */
42 #define NFS_MAX_UDP_TIMEOUT (60*HZ)
43 #define NFS_MAX_TCP_TIMEOUT (600*HZ)
46 * superblock magic number for NFS
48 #define NFS_SUPER_MAGIC 0x6969
51 * These are the default flags for swap requests
53 #define NFS_RPC_SWAPFLAGS (RPC_TASK_SWAPPER|RPC_TASK_ROOTCREDS)
56 * When flushing a cluster of dirty pages, there can be different
59 #define FLUSH_AGING 0 /* only flush old buffers */
60 #define FLUSH_SYNC 1 /* file being synced, or contention */
61 #define FLUSH_WAIT 2 /* wait for completion */
62 #define FLUSH_STABLE 4 /* commit to stable storage */
63 #define FLUSH_LOWPRI 8 /* low priority background flush */
64 #define FLUSH_HIGHPRI 16 /* high priority memory reclaim flush */
69 * NFSv3/v4 Access mode cache entry
71 struct nfs_access_entry {
72 unsigned long jiffies;
73 struct rpc_cred * cred;
78 struct nfs_open_context {
80 struct dentry *dentry;
81 struct rpc_cred *cred;
82 struct nfs4_state *state;
87 struct list_head list;
95 struct nfs_delegation;
100 * nfs fs inode data in memory
104 * The 64bit 'inode number'
116 unsigned long flags; /* atomic bit ops */
117 unsigned long cache_validity; /* bit mask */
120 * read_cache_jiffies is when we started read-caching this inode,
121 * and read_cache_mtime is the mtime of the inode at that time.
122 * attrtimeo is for how long the cached information is assumed
123 * to be valid. A successful attribute revalidation doubles
124 * attrtimeo (up to acregmax/acdirmax), a failure resets it to
127 * We need to revalidate the cached attrs for this inode if
129 * jiffies - read_cache_jiffies > attrtimeo
131 * and invalidate any cached data/flush out any dirty pages if
134 * mtime != read_cache_mtime
136 unsigned long read_cache_jiffies;
137 unsigned long attrtimeo;
138 unsigned long attrtimeo_timestamp;
139 __u64 change_attr; /* v4 only */
141 unsigned long last_updated;
142 /* "Generation counter" for the attribute cache. This is
143 * bumped whenever we update the metadata on the
146 unsigned long cache_change_attribute;
148 * Counter indicating the number of outstanding requests that
149 * will cause a file data update.
151 atomic_t data_updates;
153 struct nfs_access_entry cache_access;
154 #ifdef CONFIG_NFS_V3_ACL
155 struct posix_acl *acl_access;
156 struct posix_acl *acl_default;
160 * This is the cookie verifier used for NFSv3 readdir
166 * This is the list of dirty unwritten pages.
169 struct list_head dirty;
170 struct list_head commit;
171 struct radix_tree_root nfs_page_tree;
177 /* Open contexts for shared mmap writes */
178 struct list_head open_files;
181 struct nfs4_cached_acl *nfs4_acl;
183 struct list_head open_states;
184 struct nfs_delegation *delegation;
185 int delegation_state;
186 struct rw_semaphore rwsem;
187 #endif /* CONFIG_NFS_V4*/
188 struct inode vfs_inode;
192 * Cache validity bit flags
194 #define NFS_INO_INVALID_ATTR 0x0001 /* cached attrs are invalid */
195 #define NFS_INO_INVALID_DATA 0x0002 /* cached data is invalid */
196 #define NFS_INO_INVALID_ATIME 0x0004 /* cached atime is invalid */
197 #define NFS_INO_INVALID_ACCESS 0x0008 /* cached access cred invalid */
198 #define NFS_INO_INVALID_ACL 0x0010 /* cached acls are invalid */
199 #define NFS_INO_REVAL_PAGECACHE 0x0020 /* must revalidate pagecache */
202 * Bit offsets in flags field
204 #define NFS_INO_REVALIDATING (0) /* revalidating attrs */
205 #define NFS_INO_ADVISE_RDPLUS (1) /* advise readdirplus */
206 #define NFS_INO_STALE (2) /* possible stale inode */
208 static inline struct nfs_inode *NFS_I(struct inode *inode)
210 return container_of(inode, struct nfs_inode, vfs_inode);
212 #define NFS_SB(s) ((struct nfs_server *)(s->s_fs_info))
214 #define NFS_FH(inode) (&NFS_I(inode)->fh)
215 #define NFS_SERVER(inode) (NFS_SB(inode->i_sb))
216 #define NFS_CLIENT(inode) (NFS_SERVER(inode)->client)
217 #define NFS_PROTO(inode) (NFS_SERVER(inode)->rpc_ops)
218 #define NFS_ADDR(inode) (RPC_PEERADDR(NFS_CLIENT(inode)))
219 #define NFS_COOKIEVERF(inode) (NFS_I(inode)->cookieverf)
220 #define NFS_READTIME(inode) (NFS_I(inode)->read_cache_jiffies)
221 #define NFS_CHANGE_ATTR(inode) (NFS_I(inode)->change_attr)
222 #define NFS_ATTRTIMEO(inode) (NFS_I(inode)->attrtimeo)
223 #define NFS_MINATTRTIMEO(inode) \
224 (S_ISDIR(inode->i_mode)? NFS_SERVER(inode)->acdirmin \
225 : NFS_SERVER(inode)->acregmin)
226 #define NFS_MAXATTRTIMEO(inode) \
227 (S_ISDIR(inode->i_mode)? NFS_SERVER(inode)->acdirmax \
228 : NFS_SERVER(inode)->acregmax)
229 #define NFS_ATTRTIMEO_UPDATE(inode) (NFS_I(inode)->attrtimeo_timestamp)
231 #define NFS_FLAGS(inode) (NFS_I(inode)->flags)
232 #define NFS_STALE(inode) (test_bit(NFS_INO_STALE, &NFS_FLAGS(inode)))
234 #define NFS_FILEID(inode) (NFS_I(inode)->fileid)
236 static inline int nfs_caches_unstable(struct inode *inode)
238 return atomic_read(&NFS_I(inode)->data_updates) != 0;
241 static inline void nfs_mark_for_revalidate(struct inode *inode)
243 spin_lock(&inode->i_lock);
244 NFS_I(inode)->cache_validity |= NFS_INO_INVALID_ATTR | NFS_INO_INVALID_ACCESS;
245 spin_unlock(&inode->i_lock);
248 static inline void NFS_CACHEINV(struct inode *inode)
250 if (!nfs_caches_unstable(inode))
251 nfs_mark_for_revalidate(inode);
254 static inline int nfs_server_capable(struct inode *inode, int cap)
256 return NFS_SERVER(inode)->caps & cap;
259 static inline int NFS_USE_READDIRPLUS(struct inode *inode)
261 return test_bit(NFS_INO_ADVISE_RDPLUS, &NFS_FLAGS(inode));
265 * nfs_save_change_attribute - Returns the inode attribute change cookie
266 * @inode - pointer to inode
267 * The "change attribute" is updated every time we finish an operation
268 * that will result in a metadata change on the server.
270 static inline long nfs_save_change_attribute(struct inode *inode)
272 return NFS_I(inode)->cache_change_attribute;
276 * nfs_verify_change_attribute - Detects NFS inode cache updates
277 * @inode - pointer to inode
278 * @chattr - previously saved change attribute
279 * Return "false" if metadata has been updated (or is in the process of
280 * being updated) since the change attribute was saved.
282 static inline int nfs_verify_change_attribute(struct inode *inode, unsigned long chattr)
284 return !nfs_caches_unstable(inode)
285 && time_after_eq(chattr, NFS_I(inode)->cache_change_attribute);
289 * linux/fs/nfs/inode.c
291 extern int nfs_sync_mapping(struct address_space *mapping);
292 extern void nfs_zap_caches(struct inode *);
293 extern struct inode *nfs_fhget(struct super_block *, struct nfs_fh *,
295 extern int nfs_refresh_inode(struct inode *, struct nfs_fattr *);
296 extern int nfs_post_op_update_inode(struct inode *inode, struct nfs_fattr *fattr);
297 extern int nfs_getattr(struct vfsmount *, struct dentry *, struct kstat *);
298 extern int nfs_permission(struct inode *, int, struct nameidata *);
299 extern int nfs_access_get_cached(struct inode *, struct rpc_cred *, struct nfs_access_entry *);
300 extern void nfs_access_add_cache(struct inode *, struct nfs_access_entry *);
301 extern int nfs_open(struct inode *, struct file *);
302 extern int nfs_release(struct inode *, struct file *);
303 extern int nfs_attribute_timeout(struct inode *inode);
304 extern int nfs_revalidate_inode(struct nfs_server *server, struct inode *inode);
305 extern int __nfs_revalidate_inode(struct nfs_server *, struct inode *);
306 extern void nfs_revalidate_mapping(struct inode *inode, struct address_space *mapping);
307 extern int nfs_setattr(struct dentry *, struct iattr *);
308 extern void nfs_setattr_update_inode(struct inode *inode, struct iattr *attr);
309 extern void nfs_begin_attr_update(struct inode *);
310 extern void nfs_end_attr_update(struct inode *);
311 extern void nfs_begin_data_update(struct inode *);
312 extern void nfs_end_data_update(struct inode *);
313 extern struct nfs_open_context *alloc_nfs_open_context(struct dentry *dentry, struct rpc_cred *cred);
314 extern struct nfs_open_context *get_nfs_open_context(struct nfs_open_context *ctx);
315 extern void put_nfs_open_context(struct nfs_open_context *ctx);
316 extern void nfs_file_set_open_context(struct file *filp, struct nfs_open_context *ctx);
317 extern struct nfs_open_context *nfs_find_open_context(struct inode *inode, struct rpc_cred *cred, int mode);
318 extern void nfs_file_clear_open_context(struct file *filp);
320 /* linux/net/ipv4/ipconfig.c: trims ip addr off front of name, too. */
321 extern u32 root_nfs_parse_addr(char *name); /*__init*/
323 static inline void nfs_fattr_init(struct nfs_fattr *fattr)
326 fattr->time_start = jiffies;
330 * linux/fs/nfs/file.c
332 extern struct inode_operations nfs_file_inode_operations;
334 extern struct inode_operations nfs3_file_inode_operations;
335 #endif /* CONFIG_NFS_V3 */
336 extern struct file_operations nfs_file_operations;
337 extern struct address_space_operations nfs_file_aops;
339 static inline struct rpc_cred *nfs_file_cred(struct file *file)
342 struct nfs_open_context *ctx;
344 ctx = (struct nfs_open_context*)file->private_data;
351 * linux/fs/nfs/xattr.c
353 #ifdef CONFIG_NFS_V3_ACL
354 extern ssize_t nfs3_listxattr(struct dentry *, char *, size_t);
355 extern ssize_t nfs3_getxattr(struct dentry *, const char *, void *, size_t);
356 extern int nfs3_setxattr(struct dentry *, const char *,
357 const void *, size_t, int);
358 extern int nfs3_removexattr (struct dentry *, const char *name);
360 # define nfs3_listxattr NULL
361 # define nfs3_getxattr NULL
362 # define nfs3_setxattr NULL
363 # define nfs3_removexattr NULL
367 * linux/fs/nfs/direct.c
369 extern ssize_t nfs_direct_IO(int, struct kiocb *, const struct iovec *, loff_t,
371 extern ssize_t nfs_file_direct_read(struct kiocb *iocb, char __user *buf,
372 size_t count, loff_t pos);
373 extern ssize_t nfs_file_direct_write(struct kiocb *iocb, const char __user *buf,
374 size_t count, loff_t pos);
379 extern struct inode_operations nfs_dir_inode_operations;
381 extern struct inode_operations nfs3_dir_inode_operations;
382 #endif /* CONFIG_NFS_V3 */
383 extern struct file_operations nfs_dir_operations;
384 extern struct dentry_operations nfs_dentry_operations;
386 extern int nfs_instantiate(struct dentry *dentry, struct nfs_fh *fh, struct nfs_fattr *fattr);
389 * linux/fs/nfs/symlink.c
391 extern struct inode_operations nfs_symlink_inode_operations;
394 * linux/fs/nfs/unlink.c
396 extern int nfs_async_unlink(struct dentry *);
397 extern void nfs_complete_unlink(struct dentry *);
400 * linux/fs/nfs/write.c
402 extern int nfs_writepage(struct page *page, struct writeback_control *wbc);
403 extern int nfs_writepages(struct address_space *, struct writeback_control *);
404 extern int nfs_flush_incompatible(struct file *file, struct page *page);
405 extern int nfs_updatepage(struct file *, struct page *, unsigned int, unsigned int);
406 extern void nfs_writeback_done(struct rpc_task *task, void *data);
407 extern void nfs_writedata_release(void *data);
409 #if defined(CONFIG_NFS_V3) || defined(CONFIG_NFS_V4)
410 extern void nfs_commit_done(struct rpc_task *, void *data);
411 extern void nfs_commit_release(void *data);
415 * Try to write back everything synchronously (but check the
418 extern int nfs_sync_inode(struct inode *, unsigned long, unsigned int, int);
419 #if defined(CONFIG_NFS_V3) || defined(CONFIG_NFS_V4)
420 extern int nfs_commit_inode(struct inode *, int);
423 nfs_commit_inode(struct inode *inode, int how)
430 nfs_have_writebacks(struct inode *inode)
432 return NFS_I(inode)->npages != 0;
436 nfs_wb_all(struct inode *inode)
438 int error = nfs_sync_inode(inode, 0, 0, FLUSH_WAIT);
439 return (error < 0) ? error : 0;
443 * Write back all requests on one page - we do this before reading it.
445 static inline int nfs_wb_page_priority(struct inode *inode, struct page* page, int how)
447 int error = nfs_sync_inode(inode, page->index, 1,
448 how | FLUSH_WAIT | FLUSH_STABLE);
449 return (error < 0) ? error : 0;
452 static inline int nfs_wb_page(struct inode *inode, struct page* page)
454 return nfs_wb_page_priority(inode, page, 0);
458 * Allocate and free nfs_write_data structures
460 extern mempool_t *nfs_wdata_mempool;
462 static inline struct nfs_write_data *nfs_writedata_alloc(unsigned int pagecount)
464 struct nfs_write_data *p = mempool_alloc(nfs_wdata_mempool, SLAB_NOFS);
467 memset(p, 0, sizeof(*p));
468 INIT_LIST_HEAD(&p->pages);
469 if (pagecount < NFS_PAGEVEC_SIZE)
470 p->pagevec = &p->page_array[0];
472 size_t size = ++pagecount * sizeof(struct page *);
473 p->pagevec = kmalloc(size, GFP_NOFS);
475 memset(p->pagevec, 0, size);
477 mempool_free(p, nfs_wdata_mempool);
485 static inline void nfs_writedata_free(struct nfs_write_data *p)
487 if (p && (p->pagevec != &p->page_array[0]))
489 mempool_free(p, nfs_wdata_mempool);
493 * linux/fs/nfs/read.c
495 extern int nfs_readpage(struct file *, struct page *);
496 extern int nfs_readpages(struct file *, struct address_space *,
497 struct list_head *, unsigned);
498 extern void nfs_readpage_result(struct rpc_task *, void *);
499 extern void nfs_readdata_release(void *data);
503 * Allocate and free nfs_read_data structures
505 extern mempool_t *nfs_rdata_mempool;
507 static inline struct nfs_read_data *nfs_readdata_alloc(unsigned int pagecount)
509 struct nfs_read_data *p = mempool_alloc(nfs_rdata_mempool, SLAB_NOFS);
512 memset(p, 0, sizeof(*p));
513 INIT_LIST_HEAD(&p->pages);
514 if (pagecount < NFS_PAGEVEC_SIZE)
515 p->pagevec = &p->page_array[0];
517 size_t size = ++pagecount * sizeof(struct page *);
518 p->pagevec = kmalloc(size, GFP_NOFS);
520 memset(p->pagevec, 0, size);
522 mempool_free(p, nfs_rdata_mempool);
530 static inline void nfs_readdata_free(struct nfs_read_data *p)
532 if (p && (p->pagevec != &p->page_array[0]))
534 mempool_free(p, nfs_rdata_mempool);
538 * linux/fs/nfs3proc.c
540 #ifdef CONFIG_NFS_V3_ACL
541 extern struct posix_acl *nfs3_proc_getacl(struct inode *inode, int type);
542 extern int nfs3_proc_setacl(struct inode *inode, int type,
543 struct posix_acl *acl);
544 extern int nfs3_proc_set_default_acl(struct inode *dir, struct inode *inode,
546 extern void nfs3_forget_cached_acls(struct inode *inode);
548 static inline int nfs3_proc_set_default_acl(struct inode *dir,
555 static inline void nfs3_forget_cached_acls(struct inode *inode)
558 #endif /* CONFIG_NFS_V3_ACL */
561 * linux/fs/mount_clnt.c
562 * (Used only by nfsroot module)
564 extern int nfsroot_mount(struct sockaddr_in *, char *, struct nfs_fh *,
572 nfs_size_to_loff_t(__u64 size)
574 loff_t maxsz = (((loff_t) ULONG_MAX) << PAGE_CACHE_SHIFT) + PAGE_CACHE_SIZE - 1;
577 return (loff_t) size;
581 nfs_fileid_to_ino_t(u64 fileid)
583 ino_t ino = (ino_t) fileid;
584 if (sizeof(ino_t) < sizeof(u64))
585 ino ^= fileid >> (sizeof(u64)-sizeof(ino_t)) * 8;
591 extern void * nfs_root_data(void);
593 #define nfs_wait_event(clnt, wq, condition) \
596 if (clnt->cl_intr) { \
598 rpc_clnt_sigmask(clnt, &oldmask); \
599 __retval = wait_event_interruptible(wq, condition); \
600 rpc_clnt_sigunmask(clnt, &oldmask); \
602 wait_event(wq, condition); \
606 #define NFS_JUKEBOX_RETRY_TIME (5 * HZ)
608 #endif /* __KERNEL__ */
613 #define NFSDBG_VFS 0x0001
614 #define NFSDBG_DIRCACHE 0x0002
615 #define NFSDBG_LOOKUPCACHE 0x0004
616 #define NFSDBG_PAGECACHE 0x0008
617 #define NFSDBG_PROC 0x0010
618 #define NFSDBG_XDR 0x0020
619 #define NFSDBG_FILE 0x0040
620 #define NFSDBG_ROOT 0x0080
621 #define NFSDBG_CALLBACK 0x0100
622 #define NFSDBG_ALL 0xFFFF
627 # define ifdebug(fac) if (unlikely(nfs_debug & NFSDBG_##fac))
629 # define ifdebug(fac) if (0)
631 #endif /* __KERNEL */