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 #define NFS_MAX_FILE_IO_BUFFER_SIZE 32768
42 #define NFS_DEF_FILE_IO_BUFFER_SIZE 4096
45 * superblock magic number for NFS
47 #define NFS_SUPER_MAGIC 0x6969
50 * These are the default flags for swap requests
52 #define NFS_RPC_SWAPFLAGS (RPC_TASK_SWAPPER|RPC_TASK_ROOTCREDS)
55 * When flushing a cluster of dirty pages, there can be different
58 #define FLUSH_AGING 0 /* only flush old buffers */
59 #define FLUSH_SYNC 1 /* file being synced, or contention */
60 #define FLUSH_WAIT 2 /* wait for completion */
61 #define FLUSH_STABLE 4 /* commit to stable storage */
62 #define FLUSH_LOWPRI 8 /* low priority background flush */
63 #define FLUSH_HIGHPRI 16 /* high priority memory reclaim flush */
68 * NFSv3/v4 Access mode cache entry
70 struct nfs_access_entry {
71 unsigned long jiffies;
72 struct rpc_cred * cred;
77 struct nfs_open_context {
79 struct dentry *dentry;
80 struct rpc_cred *cred;
81 struct nfs4_state *state;
86 struct list_head list;
92 struct nfs_delegation;
97 * nfs fs inode data in memory
101 * The 64bit 'inode number'
116 * read_cache_jiffies is when we started read-caching this inode,
117 * and read_cache_mtime is the mtime of the inode at that time.
118 * attrtimeo is for how long the cached information is assumed
119 * to be valid. A successful attribute revalidation doubles
120 * attrtimeo (up to acregmax/acdirmax), a failure resets it to
123 * We need to revalidate the cached attrs for this inode if
125 * jiffies - read_cache_jiffies > attrtimeo
127 * and invalidate any cached data/flush out any dirty pages if
130 * mtime != read_cache_mtime
132 unsigned long read_cache_jiffies;
133 unsigned long attrtimeo;
134 unsigned long attrtimeo_timestamp;
135 __u64 change_attr; /* v4 only */
137 /* "Generation counter" for the attribute cache. This is
138 * bumped whenever we update the metadata on the
141 unsigned long cache_change_attribute;
143 * Counter indicating the number of outstanding requests that
144 * will cause a file data update.
146 atomic_t data_updates;
148 struct nfs_access_entry cache_access;
149 #ifdef CONFIG_NFS_V3_ACL
150 struct posix_acl *acl_access;
151 struct posix_acl *acl_default;
155 * This is the cookie verifier used for NFSv3 readdir
161 * This is the list of dirty unwritten pages.
164 struct list_head dirty;
165 struct list_head commit;
166 struct radix_tree_root nfs_page_tree;
172 /* Open contexts for shared mmap writes */
173 struct list_head open_files;
175 wait_queue_head_t nfs_i_wait;
178 struct nfs4_cached_acl *nfs4_acl;
180 struct list_head open_states;
181 struct nfs_delegation *delegation;
182 int delegation_state;
183 struct rw_semaphore rwsem;
184 #endif /* CONFIG_NFS_V4*/
185 struct inode vfs_inode;
189 * Legal inode flag values
191 #define NFS_INO_STALE 0x0001 /* possible stale inode */
192 #define NFS_INO_ADVISE_RDPLUS 0x0002 /* advise readdirplus */
193 #define NFS_INO_REVALIDATING 0x0004 /* revalidating attrs */
194 #define NFS_INO_INVALID_ATTR 0x0008 /* cached attrs are invalid */
195 #define NFS_INO_INVALID_DATA 0x0010 /* cached data is invalid */
196 #define NFS_INO_INVALID_ATIME 0x0020 /* cached atime is invalid */
197 #define NFS_INO_INVALID_ACCESS 0x0040 /* cached access cred invalid */
198 #define NFS_INO_INVALID_ACL 0x0080 /* cached acls are invalid */
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)->rpc_ops)
210 #define NFS_ADDR(inode) (RPC_PEERADDR(NFS_CLIENT(inode)))
211 #define NFS_COOKIEVERF(inode) (NFS_I(inode)->cookieverf)
212 #define NFS_READTIME(inode) (NFS_I(inode)->read_cache_jiffies)
213 #define NFS_CHANGE_ATTR(inode) (NFS_I(inode)->change_attr)
214 #define NFS_ATTRTIMEO(inode) (NFS_I(inode)->attrtimeo)
215 #define NFS_MINATTRTIMEO(inode) \
216 (S_ISDIR(inode->i_mode)? NFS_SERVER(inode)->acdirmin \
217 : NFS_SERVER(inode)->acregmin)
218 #define NFS_MAXATTRTIMEO(inode) \
219 (S_ISDIR(inode->i_mode)? NFS_SERVER(inode)->acdirmax \
220 : NFS_SERVER(inode)->acregmax)
221 #define NFS_ATTRTIMEO_UPDATE(inode) (NFS_I(inode)->attrtimeo_timestamp)
223 #define NFS_FLAGS(inode) (NFS_I(inode)->flags)
224 #define NFS_REVALIDATING(inode) (NFS_FLAGS(inode) & NFS_INO_REVALIDATING)
225 #define NFS_STALE(inode) (NFS_FLAGS(inode) & NFS_INO_STALE)
227 #define NFS_FILEID(inode) (NFS_I(inode)->fileid)
229 static inline int nfs_caches_unstable(struct inode *inode)
231 return atomic_read(&NFS_I(inode)->data_updates) != 0;
234 static inline void NFS_CACHEINV(struct inode *inode)
236 if (!nfs_caches_unstable(inode))
237 NFS_FLAGS(inode) |= NFS_INO_INVALID_ATTR | NFS_INO_INVALID_ACCESS;
240 static inline int nfs_server_capable(struct inode *inode, int cap)
242 return NFS_SERVER(inode)->caps & cap;
245 static inline int NFS_USE_READDIRPLUS(struct inode *inode)
247 return NFS_FLAGS(inode) & NFS_INO_ADVISE_RDPLUS;
251 * nfs_save_change_attribute - Returns the inode attribute change cookie
252 * @inode - pointer to inode
253 * The "change attribute" is updated every time we finish an operation
254 * that will result in a metadata change on the server.
256 static inline long nfs_save_change_attribute(struct inode *inode)
258 return NFS_I(inode)->cache_change_attribute;
262 * nfs_verify_change_attribute - Detects NFS inode cache updates
263 * @inode - pointer to inode
264 * @chattr - previously saved change attribute
265 * Return "false" if metadata has been updated (or is in the process of
266 * being updated) since the change attribute was saved.
268 static inline int nfs_verify_change_attribute(struct inode *inode, unsigned long chattr)
270 return !nfs_caches_unstable(inode)
271 && chattr == NFS_I(inode)->cache_change_attribute;
275 * linux/fs/nfs/inode.c
277 extern void nfs_zap_caches(struct inode *);
278 extern struct inode *nfs_fhget(struct super_block *, struct nfs_fh *,
280 extern int nfs_refresh_inode(struct inode *, struct nfs_fattr *);
281 extern int nfs_getattr(struct vfsmount *, struct dentry *, struct kstat *);
282 extern int nfs_permission(struct inode *, int, struct nameidata *);
283 extern int nfs_access_get_cached(struct inode *, struct rpc_cred *, struct nfs_access_entry *);
284 extern void nfs_access_add_cache(struct inode *, struct nfs_access_entry *);
285 extern int nfs_open(struct inode *, struct file *);
286 extern int nfs_release(struct inode *, struct file *);
287 extern int nfs_attribute_timeout(struct inode *inode);
288 extern int nfs_revalidate_inode(struct nfs_server *server, struct inode *inode);
289 extern int __nfs_revalidate_inode(struct nfs_server *, struct inode *);
290 extern int nfs_setattr(struct dentry *, struct iattr *);
291 extern void nfs_begin_attr_update(struct inode *);
292 extern void nfs_end_attr_update(struct inode *);
293 extern void nfs_begin_data_update(struct inode *);
294 extern void nfs_end_data_update(struct inode *);
295 extern void nfs_end_data_update_defer(struct inode *);
296 extern struct nfs_open_context *alloc_nfs_open_context(struct dentry *dentry, struct rpc_cred *cred);
297 extern struct nfs_open_context *get_nfs_open_context(struct nfs_open_context *ctx);
298 extern void put_nfs_open_context(struct nfs_open_context *ctx);
299 extern void nfs_file_set_open_context(struct file *filp, struct nfs_open_context *ctx);
300 extern struct nfs_open_context *nfs_find_open_context(struct inode *inode, int mode);
301 extern void nfs_file_clear_open_context(struct file *filp);
303 /* linux/net/ipv4/ipconfig.c: trims ip addr off front of name, too. */
304 extern u32 root_nfs_parse_addr(char *name); /*__init*/
307 * linux/fs/nfs/file.c
309 extern struct inode_operations nfs_file_inode_operations;
311 extern struct inode_operations nfs3_file_inode_operations;
312 #endif /* CONFIG_NFS_V3 */
313 extern struct file_operations nfs_file_operations;
314 extern struct address_space_operations nfs_file_aops;
316 static inline struct rpc_cred *nfs_file_cred(struct file *file)
319 struct nfs_open_context *ctx;
321 ctx = (struct nfs_open_context*)file->private_data;
328 * linux/fs/nfs/xattr.c
330 #ifdef CONFIG_NFS_V3_ACL
331 extern ssize_t nfs3_listxattr(struct dentry *, char *, size_t);
332 extern ssize_t nfs3_getxattr(struct dentry *, const char *, void *, size_t);
333 extern int nfs3_setxattr(struct dentry *, const char *,
334 const void *, size_t, int);
335 extern int nfs3_removexattr (struct dentry *, const char *name);
337 # define nfs3_listxattr NULL
338 # define nfs3_getxattr NULL
339 # define nfs3_setxattr NULL
340 # define nfs3_removexattr NULL
344 * linux/fs/nfs/direct.c
346 extern ssize_t nfs_direct_IO(int, struct kiocb *, const struct iovec *, loff_t,
348 extern ssize_t nfs_file_direct_read(struct kiocb *iocb, char __user *buf,
349 size_t count, loff_t pos);
350 extern ssize_t nfs_file_direct_write(struct kiocb *iocb, const char __user *buf,
351 size_t count, loff_t pos);
356 extern struct inode_operations nfs_dir_inode_operations;
358 extern struct inode_operations nfs3_dir_inode_operations;
359 #endif /* CONFIG_NFS_V3 */
360 extern struct file_operations nfs_dir_operations;
361 extern struct dentry_operations nfs_dentry_operations;
363 extern int nfs_instantiate(struct dentry *dentry, struct nfs_fh *fh, struct nfs_fattr *fattr);
366 * linux/fs/nfs/symlink.c
368 extern struct inode_operations nfs_symlink_inode_operations;
371 * linux/fs/nfs/unlink.c
373 extern int nfs_async_unlink(struct dentry *);
374 extern void nfs_complete_unlink(struct dentry *);
377 * linux/fs/nfs/write.c
379 extern int nfs_writepage(struct page *page, struct writeback_control *wbc);
380 extern int nfs_writepages(struct address_space *, struct writeback_control *);
381 extern int nfs_flush_incompatible(struct file *file, struct page *page);
382 extern int nfs_updatepage(struct file *, struct page *, unsigned int, unsigned int);
383 extern void nfs_writeback_done(struct rpc_task *task);
385 #if defined(CONFIG_NFS_V3) || defined(CONFIG_NFS_V4)
386 extern void nfs_commit_done(struct rpc_task *);
390 * Try to write back everything synchronously (but check the
393 extern int nfs_sync_inode(struct inode *, unsigned long, unsigned int, int);
394 #if defined(CONFIG_NFS_V3) || defined(CONFIG_NFS_V4)
395 extern int nfs_commit_inode(struct inode *, unsigned long, unsigned int, int);
398 nfs_commit_inode(struct inode *inode, unsigned long idx_start, unsigned int npages, int how)
405 nfs_have_writebacks(struct inode *inode)
407 return NFS_I(inode)->npages != 0;
411 nfs_wb_all(struct inode *inode)
413 int error = nfs_sync_inode(inode, 0, 0, FLUSH_WAIT);
414 return (error < 0) ? error : 0;
418 * Write back all requests on one page - we do this before reading it.
420 static inline int nfs_wb_page_priority(struct inode *inode, struct page* page, int how)
422 int error = nfs_sync_inode(inode, page->index, 1,
423 how | FLUSH_WAIT | FLUSH_STABLE);
424 return (error < 0) ? error : 0;
427 static inline int nfs_wb_page(struct inode *inode, struct page* page)
429 return nfs_wb_page_priority(inode, page, 0);
433 * Allocate and free nfs_write_data structures
435 extern mempool_t *nfs_wdata_mempool;
437 static inline struct nfs_write_data *nfs_writedata_alloc(void)
439 struct nfs_write_data *p = mempool_alloc(nfs_wdata_mempool, SLAB_NOFS);
441 memset(p, 0, sizeof(*p));
442 INIT_LIST_HEAD(&p->pages);
447 static inline void nfs_writedata_free(struct nfs_write_data *p)
449 mempool_free(p, nfs_wdata_mempool);
453 * linux/fs/nfs/read.c
455 extern int nfs_readpage(struct file *, struct page *);
456 extern int nfs_readpages(struct file *, struct address_space *,
457 struct list_head *, unsigned);
458 extern void nfs_readpage_result(struct rpc_task *);
461 * Allocate and free nfs_read_data structures
463 extern mempool_t *nfs_rdata_mempool;
465 static inline struct nfs_read_data *nfs_readdata_alloc(void)
467 struct nfs_read_data *p = mempool_alloc(nfs_rdata_mempool, SLAB_NOFS);
469 memset(p, 0, sizeof(*p));
473 static inline void nfs_readdata_free(struct nfs_read_data *p)
475 mempool_free(p, nfs_rdata_mempool);
478 extern void nfs_readdata_release(struct rpc_task *task);
481 * linux/fs/nfs3proc.c
483 #ifdef CONFIG_NFS_V3_ACL
484 extern struct posix_acl *nfs3_proc_getacl(struct inode *inode, int type);
485 extern int nfs3_proc_setacl(struct inode *inode, int type,
486 struct posix_acl *acl);
487 extern int nfs3_proc_set_default_acl(struct inode *dir, struct inode *inode,
489 extern void nfs3_forget_cached_acls(struct inode *inode);
491 static inline int nfs3_proc_set_default_acl(struct inode *dir,
498 static inline void nfs3_forget_cached_acls(struct inode *inode)
501 #endif /* CONFIG_NFS_V3_ACL */
504 * linux/fs/mount_clnt.c
505 * (Used only by nfsroot module)
507 extern int nfsroot_mount(struct sockaddr_in *, char *, struct nfs_fh *,
515 nfs_size_to_loff_t(__u64 size)
517 loff_t maxsz = (((loff_t) ULONG_MAX) << PAGE_CACHE_SHIFT) + PAGE_CACHE_SIZE - 1;
520 return (loff_t) size;
524 nfs_fileid_to_ino_t(u64 fileid)
526 ino_t ino = (ino_t) fileid;
527 if (sizeof(ino_t) < sizeof(u64))
528 ino ^= fileid >> (sizeof(u64)-sizeof(ino_t)) * 8;
534 extern void * nfs_root_data(void);
536 #define nfs_wait_event(clnt, wq, condition) \
539 if (clnt->cl_intr) { \
541 rpc_clnt_sigmask(clnt, &oldmask); \
542 __retval = wait_event_interruptible(wq, condition); \
543 rpc_clnt_sigunmask(clnt, &oldmask); \
545 wait_event(wq, condition); \
549 #define NFS_JUKEBOX_RETRY_TIME (5 * HZ)
551 #endif /* __KERNEL__ */
556 #define NFSDBG_VFS 0x0001
557 #define NFSDBG_DIRCACHE 0x0002
558 #define NFSDBG_LOOKUPCACHE 0x0004
559 #define NFSDBG_PAGECACHE 0x0008
560 #define NFSDBG_PROC 0x0010
561 #define NFSDBG_XDR 0x0020
562 #define NFSDBG_FILE 0x0040
563 #define NFSDBG_ROOT 0x0080
564 #define NFSDBG_CALLBACK 0x0100
565 #define NFSDBG_ALL 0xFFFF
570 # define ifdebug(fac) if (unlikely(nfs_debug & NFSDBG_##fac))
572 # define ifdebug(fac) if (0)
574 #endif /* __KERNEL */