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 */
65 #define FLUSH_NOCOMMIT 32 /* Don't send the NFSv3/v4 COMMIT */
70 * NFSv3/v4 Access mode cache entry
72 struct nfs_access_entry {
73 unsigned long jiffies;
74 struct rpc_cred * cred;
79 struct nfs_open_context {
81 struct vfsmount *vfsmnt;
82 struct dentry *dentry;
83 struct rpc_cred *cred;
84 struct nfs4_state *state;
89 struct list_head list;
97 struct nfs_delegation;
102 * nfs fs inode data in memory
106 * The 64bit 'inode number'
118 unsigned long flags; /* atomic bit ops */
119 unsigned long cache_validity; /* bit mask */
122 * read_cache_jiffies is when we started read-caching this inode,
123 * and read_cache_mtime is the mtime of the inode at that time.
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 * and invalidate any cached data/flush out any dirty pages if
136 * mtime != read_cache_mtime
138 unsigned long read_cache_jiffies;
139 unsigned long attrtimeo;
140 unsigned long attrtimeo_timestamp;
141 __u64 change_attr; /* v4 only */
143 unsigned long last_updated;
144 /* "Generation counter" for the attribute cache. This is
145 * bumped whenever we update the metadata on the
148 unsigned long cache_change_attribute;
150 * Counter indicating the number of outstanding requests that
151 * will cause a file data update.
153 atomic_t data_updates;
155 struct nfs_access_entry cache_access;
156 #ifdef CONFIG_NFS_V3_ACL
157 struct posix_acl *acl_access;
158 struct posix_acl *acl_default;
162 * This is the cookie verifier used for NFSv3 readdir
168 * This is the list of dirty unwritten pages.
171 struct list_head dirty;
172 struct list_head commit;
173 struct radix_tree_root nfs_page_tree;
179 /* Open contexts for shared mmap writes */
180 struct list_head open_files;
183 struct nfs4_cached_acl *nfs4_acl;
185 struct list_head open_states;
186 struct nfs_delegation *delegation;
187 int delegation_state;
188 struct rw_semaphore rwsem;
189 #endif /* CONFIG_NFS_V4*/
190 struct inode vfs_inode;
194 * Cache validity bit flags
196 #define NFS_INO_INVALID_ATTR 0x0001 /* cached attrs are invalid */
197 #define NFS_INO_INVALID_DATA 0x0002 /* cached data is invalid */
198 #define NFS_INO_INVALID_ATIME 0x0004 /* cached atime is invalid */
199 #define NFS_INO_INVALID_ACCESS 0x0008 /* cached access cred invalid */
200 #define NFS_INO_INVALID_ACL 0x0010 /* cached acls are invalid */
201 #define NFS_INO_REVAL_PAGECACHE 0x0020 /* must revalidate pagecache */
204 * Bit offsets in flags field
206 #define NFS_INO_REVALIDATING (0) /* revalidating attrs */
207 #define NFS_INO_ADVISE_RDPLUS (1) /* advise readdirplus */
208 #define NFS_INO_STALE (2) /* possible stale inode */
210 static inline struct nfs_inode *NFS_I(struct inode *inode)
212 return container_of(inode, struct nfs_inode, vfs_inode);
214 #define NFS_SB(s) ((struct nfs_server *)(s->s_fs_info))
216 #define NFS_FH(inode) (&NFS_I(inode)->fh)
217 #define NFS_SERVER(inode) (NFS_SB(inode->i_sb))
218 #define NFS_CLIENT(inode) (NFS_SERVER(inode)->client)
219 #define NFS_PROTO(inode) (NFS_SERVER(inode)->rpc_ops)
220 #define NFS_ADDR(inode) (RPC_PEERADDR(NFS_CLIENT(inode)))
221 #define NFS_COOKIEVERF(inode) (NFS_I(inode)->cookieverf)
222 #define NFS_READTIME(inode) (NFS_I(inode)->read_cache_jiffies)
223 #define NFS_CHANGE_ATTR(inode) (NFS_I(inode)->change_attr)
224 #define NFS_ATTRTIMEO(inode) (NFS_I(inode)->attrtimeo)
225 #define NFS_MINATTRTIMEO(inode) \
226 (S_ISDIR(inode->i_mode)? NFS_SERVER(inode)->acdirmin \
227 : NFS_SERVER(inode)->acregmin)
228 #define NFS_MAXATTRTIMEO(inode) \
229 (S_ISDIR(inode->i_mode)? NFS_SERVER(inode)->acdirmax \
230 : NFS_SERVER(inode)->acregmax)
231 #define NFS_ATTRTIMEO_UPDATE(inode) (NFS_I(inode)->attrtimeo_timestamp)
233 #define NFS_FLAGS(inode) (NFS_I(inode)->flags)
234 #define NFS_STALE(inode) (test_bit(NFS_INO_STALE, &NFS_FLAGS(inode)))
236 #define NFS_FILEID(inode) (NFS_I(inode)->fileid)
238 static inline int nfs_caches_unstable(struct inode *inode)
240 return atomic_read(&NFS_I(inode)->data_updates) != 0;
243 static inline void nfs_mark_for_revalidate(struct inode *inode)
245 spin_lock(&inode->i_lock);
246 NFS_I(inode)->cache_validity |= NFS_INO_INVALID_ATTR | NFS_INO_INVALID_ACCESS;
247 spin_unlock(&inode->i_lock);
250 static inline void NFS_CACHEINV(struct inode *inode)
252 if (!nfs_caches_unstable(inode))
253 nfs_mark_for_revalidate(inode);
256 static inline int nfs_server_capable(struct inode *inode, int cap)
258 return NFS_SERVER(inode)->caps & cap;
261 static inline int NFS_USE_READDIRPLUS(struct inode *inode)
263 return test_bit(NFS_INO_ADVISE_RDPLUS, &NFS_FLAGS(inode));
267 * nfs_save_change_attribute - Returns the inode attribute change cookie
268 * @inode - pointer to inode
269 * The "change attribute" is updated every time we finish an operation
270 * that will result in a metadata change on the server.
272 static inline long nfs_save_change_attribute(struct inode *inode)
274 return NFS_I(inode)->cache_change_attribute;
278 * nfs_verify_change_attribute - Detects NFS inode cache updates
279 * @inode - pointer to inode
280 * @chattr - previously saved change attribute
281 * Return "false" if metadata has been updated (or is in the process of
282 * being updated) since the change attribute was saved.
284 static inline int nfs_verify_change_attribute(struct inode *inode, unsigned long chattr)
286 return !nfs_caches_unstable(inode)
287 && time_after_eq(chattr, NFS_I(inode)->cache_change_attribute);
291 * linux/fs/nfs/inode.c
293 extern int nfs_sync_mapping(struct address_space *mapping);
294 extern void nfs_zap_caches(struct inode *);
295 extern struct inode *nfs_fhget(struct super_block *, struct nfs_fh *,
297 extern int nfs_refresh_inode(struct inode *, struct nfs_fattr *);
298 extern int nfs_post_op_update_inode(struct inode *inode, struct nfs_fattr *fattr);
299 extern int nfs_getattr(struct vfsmount *, struct dentry *, struct kstat *);
300 extern int nfs_permission(struct inode *, int, struct nameidata *);
301 extern int nfs_access_get_cached(struct inode *, struct rpc_cred *, struct nfs_access_entry *);
302 extern void nfs_access_add_cache(struct inode *, struct nfs_access_entry *);
303 extern int nfs_open(struct inode *, struct file *);
304 extern int nfs_release(struct inode *, struct file *);
305 extern int nfs_attribute_timeout(struct inode *inode);
306 extern int nfs_revalidate_inode(struct nfs_server *server, struct inode *inode);
307 extern int __nfs_revalidate_inode(struct nfs_server *, struct inode *);
308 extern void nfs_revalidate_mapping(struct inode *inode, struct address_space *mapping);
309 extern int nfs_setattr(struct dentry *, struct iattr *);
310 extern void nfs_setattr_update_inode(struct inode *inode, struct iattr *attr);
311 extern void nfs_begin_attr_update(struct inode *);
312 extern void nfs_end_attr_update(struct inode *);
313 extern void nfs_begin_data_update(struct inode *);
314 extern void nfs_end_data_update(struct inode *);
315 extern struct nfs_open_context *get_nfs_open_context(struct nfs_open_context *ctx);
316 extern void put_nfs_open_context(struct nfs_open_context *ctx);
317 extern struct nfs_open_context *nfs_find_open_context(struct inode *inode, struct rpc_cred *cred, int mode);
319 /* linux/net/ipv4/ipconfig.c: trims ip addr off front of name, too. */
320 extern u32 root_nfs_parse_addr(char *name); /*__init*/
322 static inline void nfs_fattr_init(struct nfs_fattr *fattr)
325 fattr->time_start = jiffies;
329 * linux/fs/nfs/file.c
331 extern struct inode_operations nfs_file_inode_operations;
333 extern struct inode_operations nfs3_file_inode_operations;
334 #endif /* CONFIG_NFS_V3 */
335 extern struct file_operations nfs_file_operations;
336 extern struct address_space_operations nfs_file_aops;
338 static inline struct rpc_cred *nfs_file_cred(struct file *file)
341 struct nfs_open_context *ctx;
343 ctx = (struct nfs_open_context*)file->private_data;
350 * linux/fs/nfs/xattr.c
352 #ifdef CONFIG_NFS_V3_ACL
353 extern ssize_t nfs3_listxattr(struct dentry *, char *, size_t);
354 extern ssize_t nfs3_getxattr(struct dentry *, const char *, void *, size_t);
355 extern int nfs3_setxattr(struct dentry *, const char *,
356 const void *, size_t, int);
357 extern int nfs3_removexattr (struct dentry *, const char *name);
359 # define nfs3_listxattr NULL
360 # define nfs3_getxattr NULL
361 # define nfs3_setxattr NULL
362 # define nfs3_removexattr NULL
366 * linux/fs/nfs/direct.c
368 extern ssize_t nfs_direct_IO(int, struct kiocb *, const struct iovec *, loff_t,
370 extern ssize_t nfs_file_direct_read(struct kiocb *iocb, char __user *buf,
371 size_t count, loff_t pos);
372 extern ssize_t nfs_file_direct_write(struct kiocb *iocb, const char __user *buf,
373 size_t count, loff_t pos);
378 extern struct inode_operations nfs_dir_inode_operations;
380 extern struct inode_operations nfs3_dir_inode_operations;
381 #endif /* CONFIG_NFS_V3 */
382 extern struct file_operations nfs_dir_operations;
383 extern struct dentry_operations nfs_dentry_operations;
385 extern int nfs_instantiate(struct dentry *dentry, struct nfs_fh *fh, struct nfs_fattr *fattr);
388 * linux/fs/nfs/symlink.c
390 extern struct inode_operations nfs_symlink_inode_operations;
393 * linux/fs/nfs/sysctl.c
396 extern int nfs_register_sysctl(void);
397 extern void nfs_unregister_sysctl(void);
399 #define nfs_register_sysctl() 0
400 #define nfs_unregister_sysctl() do { } while(0)
404 * linux/fs/nfs/unlink.c
406 extern int nfs_async_unlink(struct dentry *);
407 extern void nfs_complete_unlink(struct dentry *);
410 * linux/fs/nfs/write.c
412 extern int nfs_writepage(struct page *page, struct writeback_control *wbc);
413 extern int nfs_writepages(struct address_space *, struct writeback_control *);
414 extern int nfs_flush_incompatible(struct file *file, struct page *page);
415 extern int nfs_updatepage(struct file *, struct page *, unsigned int, unsigned int);
416 extern void nfs_writeback_done(struct rpc_task *task, void *data);
417 extern void nfs_writedata_release(void *data);
419 #if defined(CONFIG_NFS_V3) || defined(CONFIG_NFS_V4)
420 extern void nfs_commit_done(struct rpc_task *, void *data);
421 extern void nfs_commit_release(void *data);
425 * Try to write back everything synchronously (but check the
428 extern int nfs_sync_inode(struct inode *, unsigned long, unsigned int, int);
429 #if defined(CONFIG_NFS_V3) || defined(CONFIG_NFS_V4)
430 extern int nfs_commit_inode(struct inode *, int);
433 nfs_commit_inode(struct inode *inode, int how)
440 nfs_have_writebacks(struct inode *inode)
442 return NFS_I(inode)->npages != 0;
446 nfs_wb_all(struct inode *inode)
448 int error = nfs_sync_inode(inode, 0, 0, FLUSH_WAIT);
449 return (error < 0) ? error : 0;
453 * Write back all requests on one page - we do this before reading it.
455 static inline int nfs_wb_page_priority(struct inode *inode, struct page* page, int how)
457 int error = nfs_sync_inode(inode, page->index, 1,
458 how | FLUSH_WAIT | FLUSH_STABLE);
459 return (error < 0) ? error : 0;
462 static inline int nfs_wb_page(struct inode *inode, struct page* page)
464 return nfs_wb_page_priority(inode, page, 0);
468 * Allocate and free nfs_write_data structures
470 extern mempool_t *nfs_wdata_mempool;
472 static inline struct nfs_write_data *nfs_writedata_alloc(unsigned int pagecount)
474 struct nfs_write_data *p = mempool_alloc(nfs_wdata_mempool, SLAB_NOFS);
477 memset(p, 0, sizeof(*p));
478 INIT_LIST_HEAD(&p->pages);
479 if (pagecount < NFS_PAGEVEC_SIZE)
480 p->pagevec = &p->page_array[0];
482 size_t size = ++pagecount * sizeof(struct page *);
483 p->pagevec = kmalloc(size, GFP_NOFS);
485 memset(p->pagevec, 0, size);
487 mempool_free(p, nfs_wdata_mempool);
495 static inline void nfs_writedata_free(struct nfs_write_data *p)
497 if (p && (p->pagevec != &p->page_array[0]))
499 mempool_free(p, nfs_wdata_mempool);
503 * linux/fs/nfs/read.c
505 extern int nfs_readpage(struct file *, struct page *);
506 extern int nfs_readpages(struct file *, struct address_space *,
507 struct list_head *, unsigned);
508 extern void nfs_readpage_result(struct rpc_task *, void *);
509 extern void nfs_readdata_release(void *data);
513 * Allocate and free nfs_read_data structures
515 extern mempool_t *nfs_rdata_mempool;
517 static inline struct nfs_read_data *nfs_readdata_alloc(unsigned int pagecount)
519 struct nfs_read_data *p = mempool_alloc(nfs_rdata_mempool, SLAB_NOFS);
522 memset(p, 0, sizeof(*p));
523 INIT_LIST_HEAD(&p->pages);
524 if (pagecount < NFS_PAGEVEC_SIZE)
525 p->pagevec = &p->page_array[0];
527 size_t size = ++pagecount * sizeof(struct page *);
528 p->pagevec = kmalloc(size, GFP_NOFS);
530 memset(p->pagevec, 0, size);
532 mempool_free(p, nfs_rdata_mempool);
540 static inline void nfs_readdata_free(struct nfs_read_data *p)
542 if (p && (p->pagevec != &p->page_array[0]))
544 mempool_free(p, nfs_rdata_mempool);
548 * linux/fs/nfs3proc.c
550 #ifdef CONFIG_NFS_V3_ACL
551 extern struct posix_acl *nfs3_proc_getacl(struct inode *inode, int type);
552 extern int nfs3_proc_setacl(struct inode *inode, int type,
553 struct posix_acl *acl);
554 extern int nfs3_proc_set_default_acl(struct inode *dir, struct inode *inode,
556 extern void nfs3_forget_cached_acls(struct inode *inode);
558 static inline int nfs3_proc_set_default_acl(struct inode *dir,
565 static inline void nfs3_forget_cached_acls(struct inode *inode)
568 #endif /* CONFIG_NFS_V3_ACL */
571 * linux/fs/mount_clnt.c
572 * (Used only by nfsroot module)
574 extern int nfsroot_mount(struct sockaddr_in *, char *, struct nfs_fh *,
582 nfs_size_to_loff_t(__u64 size)
584 loff_t maxsz = (((loff_t) ULONG_MAX) << PAGE_CACHE_SHIFT) + PAGE_CACHE_SIZE - 1;
587 return (loff_t) size;
591 nfs_fileid_to_ino_t(u64 fileid)
593 ino_t ino = (ino_t) fileid;
594 if (sizeof(ino_t) < sizeof(u64))
595 ino ^= fileid >> (sizeof(u64)-sizeof(ino_t)) * 8;
601 extern void * nfs_root_data(void);
603 #define nfs_wait_event(clnt, wq, condition) \
606 if (clnt->cl_intr) { \
608 rpc_clnt_sigmask(clnt, &oldmask); \
609 __retval = wait_event_interruptible(wq, condition); \
610 rpc_clnt_sigunmask(clnt, &oldmask); \
612 wait_event(wq, condition); \
616 #define NFS_JUKEBOX_RETRY_TIME (5 * HZ)
618 #endif /* __KERNEL__ */
623 #define NFSDBG_VFS 0x0001
624 #define NFSDBG_DIRCACHE 0x0002
625 #define NFSDBG_LOOKUPCACHE 0x0004
626 #define NFSDBG_PAGECACHE 0x0008
627 #define NFSDBG_PROC 0x0010
628 #define NFSDBG_XDR 0x0020
629 #define NFSDBG_FILE 0x0040
630 #define NFSDBG_ROOT 0x0080
631 #define NFSDBG_CALLBACK 0x0100
632 #define NFSDBG_ALL 0xFFFF
637 # define ifdebug(fac) if (unlikely(nfs_debug & NFSDBG_##fac))
639 # define ifdebug(fac) if (0)
641 #endif /* __KERNEL */