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
44 /* Default timeout values */
45 #define NFS_MAX_UDP_TIMEOUT (60*HZ)
46 #define NFS_MAX_TCP_TIMEOUT (600*HZ)
49 * superblock magic number for NFS
51 #define NFS_SUPER_MAGIC 0x6969
54 * These are the default flags for swap requests
56 #define NFS_RPC_SWAPFLAGS (RPC_TASK_SWAPPER|RPC_TASK_ROOTCREDS)
59 * When flushing a cluster of dirty pages, there can be different
62 #define FLUSH_AGING 0 /* only flush old buffers */
63 #define FLUSH_SYNC 1 /* file being synced, or contention */
64 #define FLUSH_WAIT 2 /* wait for completion */
65 #define FLUSH_STABLE 4 /* commit to stable storage */
66 #define FLUSH_LOWPRI 8 /* low priority background flush */
67 #define FLUSH_HIGHPRI 16 /* high priority memory reclaim flush */
72 * NFSv3/v4 Access mode cache entry
74 struct nfs_access_entry {
75 unsigned long jiffies;
76 struct rpc_cred * cred;
81 struct nfs_open_context {
83 struct dentry *dentry;
84 struct rpc_cred *cred;
85 struct nfs4_state *state;
90 struct list_head list;
98 struct nfs_delegation;
103 * nfs fs inode data in memory
107 * The 64bit 'inode number'
119 unsigned long flags; /* atomic bit ops */
120 unsigned long cache_validity; /* bit mask */
123 * read_cache_jiffies is when we started read-caching this inode,
124 * and read_cache_mtime is the mtime of the inode at that time.
125 * attrtimeo is for how long the cached information is assumed
126 * to be valid. A successful attribute revalidation doubles
127 * attrtimeo (up to acregmax/acdirmax), a failure resets it to
130 * We need to revalidate the cached attrs for this inode if
132 * jiffies - read_cache_jiffies > attrtimeo
134 * and invalidate any cached data/flush out any dirty pages if
137 * mtime != read_cache_mtime
139 unsigned long read_cache_jiffies;
140 unsigned long attrtimeo;
141 unsigned long attrtimeo_timestamp;
142 __u64 change_attr; /* v4 only */
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_CACHEINV(struct inode *inode)
245 if (!nfs_caches_unstable(inode)) {
246 spin_lock(&inode->i_lock);
247 NFS_I(inode)->cache_validity |= NFS_INO_INVALID_ATTR | NFS_INO_INVALID_ACCESS;
248 spin_unlock(&inode->i_lock);
252 static inline int nfs_server_capable(struct inode *inode, int cap)
254 return NFS_SERVER(inode)->caps & cap;
257 static inline int NFS_USE_READDIRPLUS(struct inode *inode)
259 return test_bit(NFS_INO_ADVISE_RDPLUS, &NFS_FLAGS(inode));
263 * nfs_save_change_attribute - Returns the inode attribute change cookie
264 * @inode - pointer to inode
265 * The "change attribute" is updated every time we finish an operation
266 * that will result in a metadata change on the server.
268 static inline long nfs_save_change_attribute(struct inode *inode)
270 return NFS_I(inode)->cache_change_attribute;
274 * nfs_verify_change_attribute - Detects NFS inode cache updates
275 * @inode - pointer to inode
276 * @chattr - previously saved change attribute
277 * Return "false" if metadata has been updated (or is in the process of
278 * being updated) since the change attribute was saved.
280 static inline int nfs_verify_change_attribute(struct inode *inode, unsigned long chattr)
282 return !nfs_caches_unstable(inode)
283 && chattr == NFS_I(inode)->cache_change_attribute;
287 * linux/fs/nfs/inode.c
289 extern void nfs_zap_caches(struct inode *);
290 extern struct inode *nfs_fhget(struct super_block *, struct nfs_fh *,
292 extern int nfs_refresh_inode(struct inode *, struct nfs_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_access_get_cached(struct inode *, struct rpc_cred *, struct nfs_access_entry *);
296 extern void nfs_access_add_cache(struct inode *, struct nfs_access_entry *);
297 extern int nfs_open(struct inode *, struct file *);
298 extern int nfs_release(struct inode *, struct file *);
299 extern int nfs_attribute_timeout(struct inode *inode);
300 extern int nfs_revalidate_inode(struct nfs_server *server, struct inode *inode);
301 extern int __nfs_revalidate_inode(struct nfs_server *, struct inode *);
302 extern void nfs_revalidate_mapping(struct inode *inode, struct address_space *mapping);
303 extern int nfs_setattr(struct dentry *, struct iattr *);
304 extern void nfs_setattr_update_inode(struct inode *inode, struct iattr *attr);
305 extern void nfs_begin_attr_update(struct inode *);
306 extern void nfs_end_attr_update(struct inode *);
307 extern void nfs_begin_data_update(struct inode *);
308 extern void nfs_end_data_update(struct inode *);
309 extern struct nfs_open_context *alloc_nfs_open_context(struct dentry *dentry, struct rpc_cred *cred);
310 extern struct nfs_open_context *get_nfs_open_context(struct nfs_open_context *ctx);
311 extern void put_nfs_open_context(struct nfs_open_context *ctx);
312 extern void nfs_file_set_open_context(struct file *filp, struct nfs_open_context *ctx);
313 extern struct nfs_open_context *nfs_find_open_context(struct inode *inode, int mode);
314 extern void nfs_file_clear_open_context(struct file *filp);
316 /* linux/net/ipv4/ipconfig.c: trims ip addr off front of name, too. */
317 extern u32 root_nfs_parse_addr(char *name); /*__init*/
319 static inline void nfs_fattr_init(struct nfs_fattr *fattr)
325 * linux/fs/nfs/file.c
327 extern struct inode_operations nfs_file_inode_operations;
329 extern struct inode_operations nfs3_file_inode_operations;
330 #endif /* CONFIG_NFS_V3 */
331 extern struct file_operations nfs_file_operations;
332 extern struct address_space_operations nfs_file_aops;
334 static inline struct rpc_cred *nfs_file_cred(struct file *file)
337 struct nfs_open_context *ctx;
339 ctx = (struct nfs_open_context*)file->private_data;
346 * linux/fs/nfs/xattr.c
348 #ifdef CONFIG_NFS_V3_ACL
349 extern ssize_t nfs3_listxattr(struct dentry *, char *, size_t);
350 extern ssize_t nfs3_getxattr(struct dentry *, const char *, void *, size_t);
351 extern int nfs3_setxattr(struct dentry *, const char *,
352 const void *, size_t, int);
353 extern int nfs3_removexattr (struct dentry *, const char *name);
355 # define nfs3_listxattr NULL
356 # define nfs3_getxattr NULL
357 # define nfs3_setxattr NULL
358 # define nfs3_removexattr NULL
362 * linux/fs/nfs/direct.c
364 extern ssize_t nfs_direct_IO(int, struct kiocb *, const struct iovec *, loff_t,
366 extern ssize_t nfs_file_direct_read(struct kiocb *iocb, char __user *buf,
367 size_t count, loff_t pos);
368 extern ssize_t nfs_file_direct_write(struct kiocb *iocb, const char __user *buf,
369 size_t count, loff_t pos);
374 extern struct inode_operations nfs_dir_inode_operations;
376 extern struct inode_operations nfs3_dir_inode_operations;
377 #endif /* CONFIG_NFS_V3 */
378 extern 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);
384 * linux/fs/nfs/symlink.c
386 extern struct inode_operations nfs_symlink_inode_operations;
389 * linux/fs/nfs/unlink.c
391 extern int nfs_async_unlink(struct dentry *);
392 extern void nfs_complete_unlink(struct dentry *);
395 * linux/fs/nfs/write.c
397 extern int nfs_writepage(struct page *page, struct writeback_control *wbc);
398 extern int nfs_writepages(struct address_space *, struct writeback_control *);
399 extern int nfs_flush_incompatible(struct file *file, struct page *page);
400 extern int nfs_updatepage(struct file *, struct page *, unsigned int, unsigned int);
401 extern void nfs_writeback_done(struct rpc_task *task);
403 #if defined(CONFIG_NFS_V3) || defined(CONFIG_NFS_V4)
404 extern void nfs_commit_done(struct rpc_task *);
408 * Try to write back everything synchronously (but check the
411 extern int nfs_sync_inode(struct inode *, unsigned long, unsigned int, int);
412 #if defined(CONFIG_NFS_V3) || defined(CONFIG_NFS_V4)
413 extern int nfs_commit_inode(struct inode *, int);
416 nfs_commit_inode(struct inode *inode, int how)
423 nfs_have_writebacks(struct inode *inode)
425 return NFS_I(inode)->npages != 0;
429 nfs_wb_all(struct inode *inode)
431 int error = nfs_sync_inode(inode, 0, 0, FLUSH_WAIT);
432 return (error < 0) ? error : 0;
436 * Write back all requests on one page - we do this before reading it.
438 static inline int nfs_wb_page_priority(struct inode *inode, struct page* page, int how)
440 int error = nfs_sync_inode(inode, page->index, 1,
441 how | FLUSH_WAIT | FLUSH_STABLE);
442 return (error < 0) ? error : 0;
445 static inline int nfs_wb_page(struct inode *inode, struct page* page)
447 return nfs_wb_page_priority(inode, page, 0);
451 * Allocate and free nfs_write_data structures
453 extern mempool_t *nfs_wdata_mempool;
455 static inline struct nfs_write_data *nfs_writedata_alloc(void)
457 struct nfs_write_data *p = mempool_alloc(nfs_wdata_mempool, SLAB_NOFS);
459 memset(p, 0, sizeof(*p));
460 INIT_LIST_HEAD(&p->pages);
465 static inline void nfs_writedata_free(struct nfs_write_data *p)
467 mempool_free(p, nfs_wdata_mempool);
471 * linux/fs/nfs/read.c
473 extern int nfs_readpage(struct file *, struct page *);
474 extern int nfs_readpages(struct file *, struct address_space *,
475 struct list_head *, unsigned);
476 extern void nfs_readpage_result(struct rpc_task *);
479 * Allocate and free nfs_read_data structures
481 extern mempool_t *nfs_rdata_mempool;
483 static inline struct nfs_read_data *nfs_readdata_alloc(void)
485 struct nfs_read_data *p = mempool_alloc(nfs_rdata_mempool, SLAB_NOFS);
487 memset(p, 0, sizeof(*p));
491 static inline void nfs_readdata_free(struct nfs_read_data *p)
493 mempool_free(p, nfs_rdata_mempool);
496 extern void nfs_readdata_release(struct rpc_task *task);
499 * linux/fs/nfs3proc.c
501 #ifdef CONFIG_NFS_V3_ACL
502 extern struct posix_acl *nfs3_proc_getacl(struct inode *inode, int type);
503 extern int nfs3_proc_setacl(struct inode *inode, int type,
504 struct posix_acl *acl);
505 extern int nfs3_proc_set_default_acl(struct inode *dir, struct inode *inode,
507 extern void nfs3_forget_cached_acls(struct inode *inode);
509 static inline int nfs3_proc_set_default_acl(struct inode *dir,
516 static inline void nfs3_forget_cached_acls(struct inode *inode)
519 #endif /* CONFIG_NFS_V3_ACL */
522 * linux/fs/mount_clnt.c
523 * (Used only by nfsroot module)
525 extern int nfsroot_mount(struct sockaddr_in *, char *, struct nfs_fh *,
533 nfs_size_to_loff_t(__u64 size)
535 loff_t maxsz = (((loff_t) ULONG_MAX) << PAGE_CACHE_SHIFT) + PAGE_CACHE_SIZE - 1;
538 return (loff_t) size;
542 nfs_fileid_to_ino_t(u64 fileid)
544 ino_t ino = (ino_t) fileid;
545 if (sizeof(ino_t) < sizeof(u64))
546 ino ^= fileid >> (sizeof(u64)-sizeof(ino_t)) * 8;
552 extern void * nfs_root_data(void);
554 #define nfs_wait_event(clnt, wq, condition) \
557 if (clnt->cl_intr) { \
559 rpc_clnt_sigmask(clnt, &oldmask); \
560 __retval = wait_event_interruptible(wq, condition); \
561 rpc_clnt_sigunmask(clnt, &oldmask); \
563 wait_event(wq, condition); \
567 #define NFS_JUKEBOX_RETRY_TIME (5 * HZ)
569 #endif /* __KERNEL__ */
574 #define NFSDBG_VFS 0x0001
575 #define NFSDBG_DIRCACHE 0x0002
576 #define NFSDBG_LOOKUPCACHE 0x0004
577 #define NFSDBG_PAGECACHE 0x0008
578 #define NFSDBG_PROC 0x0010
579 #define NFSDBG_XDR 0x0020
580 #define NFSDBG_FILE 0x0040
581 #define NFSDBG_ROOT 0x0080
582 #define NFSDBG_CALLBACK 0x0100
583 #define NFSDBG_ALL 0xFFFF
588 # define ifdebug(fac) if (unlikely(nfs_debug & NFSDBG_##fac))
590 # define ifdebug(fac) if (0)
592 #endif /* __KERNEL */