[PATCH] NFS: Remove unused NFS inode field readdir_timestamp.
[linux-2.6/x86.git] / include / linux / nfs_fs.h
blob68d5aae89972d6646a72a095943f61ad698f95f0
1 /*
2 * linux/include/linux/nfs_fs.h
4 * Copyright (C) 1992 Rick Sladkey
6 * OS-specific nfs filesystem definitions and declarations
7 */
9 #ifndef _LINUX_NFS_FS_H
10 #define _LINUX_NFS_FS_H
12 #include <linux/config.h>
13 #include <linux/in.h>
14 #include <linux/mm.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.
35 * Requires RPC_DEBUG.
37 #ifdef RPC_DEBUG
38 # define NFS_DEBUG
39 #endif
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
56 * strategies:
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 */
65 #ifdef __KERNEL__
68 * NFSv3/v4 Access mode cache entry
70 struct nfs_access_entry {
71 unsigned long jiffies;
72 struct rpc_cred * cred;
73 int mask;
76 struct nfs4_state;
77 struct nfs_open_context {
78 atomic_t count;
79 struct dentry *dentry;
80 struct rpc_cred *cred;
81 struct nfs4_state *state;
82 fl_owner_t lockowner;
83 int mode;
84 int error;
86 struct list_head list;
87 wait_queue_head_t waitq;
91 * NFSv4 delegation
93 struct nfs_delegation;
96 * nfs fs inode data in memory
98 struct nfs_inode {
100 * The 64bit 'inode number'
102 __u64 fileid;
105 * NFS file handle
107 struct nfs_fh fh;
110 * Various flags
112 unsigned int flags;
115 * read_cache_jiffies is when we started read-caching this inode,
116 * and read_cache_mtime is the mtime of the inode at that time.
117 * attrtimeo is for how long the cached information is assumed
118 * to be valid. A successful attribute revalidation doubles
119 * attrtimeo (up to acregmax/acdirmax), a failure resets it to
120 * acregmin/acdirmin.
122 * We need to revalidate the cached attrs for this inode if
124 * jiffies - read_cache_jiffies > attrtimeo
126 * and invalidate any cached data/flush out any dirty pages if
127 * we find that
129 * mtime != read_cache_mtime
131 unsigned long read_cache_jiffies;
132 unsigned long attrtimeo;
133 unsigned long attrtimeo_timestamp;
134 __u64 change_attr; /* v4 only */
136 /* "Generation counter" for the attribute cache. This is
137 * bumped whenever we update the metadata on the
138 * server.
140 unsigned long cache_change_attribute;
142 * Counter indicating the number of outstanding requests that
143 * will cause a file data update.
145 atomic_t data_updates;
147 struct nfs_access_entry cache_access;
150 * This is the cookie verifier used for NFSv3 readdir
151 * operations
153 __u32 cookieverf[2];
156 * This is the list of dirty unwritten pages.
158 spinlock_t req_lock;
159 struct list_head dirty;
160 struct list_head commit;
161 struct radix_tree_root nfs_page_tree;
163 unsigned int ndirty,
164 ncommit,
165 npages;
167 /* Open contexts for shared mmap writes */
168 struct list_head open_files;
170 wait_queue_head_t nfs_i_wait;
172 #ifdef CONFIG_NFS_V4
173 /* NFSv4 state */
174 struct list_head open_states;
175 struct nfs_delegation *delegation;
176 int delegation_state;
177 struct rw_semaphore rwsem;
178 #endif /* CONFIG_NFS_V4*/
180 struct inode vfs_inode;
184 * Legal inode flag values
186 #define NFS_INO_STALE 0x0001 /* possible stale inode */
187 #define NFS_INO_ADVISE_RDPLUS 0x0002 /* advise readdirplus */
188 #define NFS_INO_REVALIDATING 0x0004 /* revalidating attrs */
189 #define NFS_INO_INVALID_ATTR 0x0008 /* cached attrs are invalid */
190 #define NFS_INO_INVALID_DATA 0x0010 /* cached data is invalid */
191 #define NFS_INO_INVALID_ATIME 0x0020 /* cached atime is invalid */
192 #define NFS_INO_INVALID_ACCESS 0x0040 /* cached access cred invalid */
194 static inline struct nfs_inode *NFS_I(struct inode *inode)
196 return container_of(inode, struct nfs_inode, vfs_inode);
198 #define NFS_SB(s) ((struct nfs_server *)(s->s_fs_info))
200 #define NFS_FH(inode) (&NFS_I(inode)->fh)
201 #define NFS_SERVER(inode) (NFS_SB(inode->i_sb))
202 #define NFS_CLIENT(inode) (NFS_SERVER(inode)->client)
203 #define NFS_PROTO(inode) (NFS_SERVER(inode)->rpc_ops)
204 #define NFS_ADDR(inode) (RPC_PEERADDR(NFS_CLIENT(inode)))
205 #define NFS_COOKIEVERF(inode) (NFS_I(inode)->cookieverf)
206 #define NFS_READTIME(inode) (NFS_I(inode)->read_cache_jiffies)
207 #define NFS_CHANGE_ATTR(inode) (NFS_I(inode)->change_attr)
208 #define NFS_ATTRTIMEO(inode) (NFS_I(inode)->attrtimeo)
209 #define NFS_MINATTRTIMEO(inode) \
210 (S_ISDIR(inode->i_mode)? NFS_SERVER(inode)->acdirmin \
211 : NFS_SERVER(inode)->acregmin)
212 #define NFS_MAXATTRTIMEO(inode) \
213 (S_ISDIR(inode->i_mode)? NFS_SERVER(inode)->acdirmax \
214 : NFS_SERVER(inode)->acregmax)
215 #define NFS_ATTRTIMEO_UPDATE(inode) (NFS_I(inode)->attrtimeo_timestamp)
217 #define NFS_FLAGS(inode) (NFS_I(inode)->flags)
218 #define NFS_REVALIDATING(inode) (NFS_FLAGS(inode) & NFS_INO_REVALIDATING)
219 #define NFS_STALE(inode) (NFS_FLAGS(inode) & NFS_INO_STALE)
221 #define NFS_FILEID(inode) (NFS_I(inode)->fileid)
223 static inline int nfs_caches_unstable(struct inode *inode)
225 return atomic_read(&NFS_I(inode)->data_updates) != 0;
228 static inline void NFS_CACHEINV(struct inode *inode)
230 if (!nfs_caches_unstable(inode))
231 NFS_FLAGS(inode) |= NFS_INO_INVALID_ATTR | NFS_INO_INVALID_ACCESS;
234 static inline int nfs_server_capable(struct inode *inode, int cap)
236 return NFS_SERVER(inode)->caps & cap;
239 static inline int NFS_USE_READDIRPLUS(struct inode *inode)
241 return NFS_FLAGS(inode) & NFS_INO_ADVISE_RDPLUS;
245 * nfs_save_change_attribute - Returns the inode attribute change cookie
246 * @inode - pointer to inode
247 * The "change attribute" is updated every time we finish an operation
248 * that will result in a metadata change on the server.
250 static inline long nfs_save_change_attribute(struct inode *inode)
252 return NFS_I(inode)->cache_change_attribute;
256 * nfs_verify_change_attribute - Detects NFS inode cache updates
257 * @inode - pointer to inode
258 * @chattr - previously saved change attribute
259 * Return "false" if metadata has been updated (or is in the process of
260 * being updated) since the change attribute was saved.
262 static inline int nfs_verify_change_attribute(struct inode *inode, unsigned long chattr)
264 return !nfs_caches_unstable(inode)
265 && chattr == NFS_I(inode)->cache_change_attribute;
269 * linux/fs/nfs/inode.c
271 extern void nfs_zap_caches(struct inode *);
272 extern struct inode *nfs_fhget(struct super_block *, struct nfs_fh *,
273 struct nfs_fattr *);
274 extern int nfs_refresh_inode(struct inode *, struct nfs_fattr *);
275 extern int nfs_getattr(struct vfsmount *, struct dentry *, struct kstat *);
276 extern int nfs_permission(struct inode *, int, struct nameidata *);
277 extern int nfs_access_get_cached(struct inode *, struct rpc_cred *, struct nfs_access_entry *);
278 extern void nfs_access_add_cache(struct inode *, struct nfs_access_entry *);
279 extern int nfs_open(struct inode *, struct file *);
280 extern int nfs_release(struct inode *, struct file *);
281 extern int nfs_attribute_timeout(struct inode *inode);
282 extern int nfs_revalidate_inode(struct nfs_server *server, struct inode *inode);
283 extern int __nfs_revalidate_inode(struct nfs_server *, struct inode *);
284 extern int nfs_setattr(struct dentry *, struct iattr *);
285 extern void nfs_begin_attr_update(struct inode *);
286 extern void nfs_end_attr_update(struct inode *);
287 extern void nfs_begin_data_update(struct inode *);
288 extern void nfs_end_data_update(struct inode *);
289 extern void nfs_end_data_update_defer(struct inode *);
290 extern struct nfs_open_context *alloc_nfs_open_context(struct dentry *dentry, struct rpc_cred *cred);
291 extern struct nfs_open_context *get_nfs_open_context(struct nfs_open_context *ctx);
292 extern void put_nfs_open_context(struct nfs_open_context *ctx);
293 extern void nfs_file_set_open_context(struct file *filp, struct nfs_open_context *ctx);
294 extern struct nfs_open_context *nfs_find_open_context(struct inode *inode, int mode);
295 extern void nfs_file_clear_open_context(struct file *filp);
297 /* linux/net/ipv4/ipconfig.c: trims ip addr off front of name, too. */
298 extern u32 root_nfs_parse_addr(char *name); /*__init*/
301 * linux/fs/nfs/file.c
303 extern struct inode_operations nfs_file_inode_operations;
304 extern struct file_operations nfs_file_operations;
305 extern struct address_space_operations nfs_file_aops;
307 static inline struct rpc_cred *nfs_file_cred(struct file *file)
309 if (file != NULL) {
310 struct nfs_open_context *ctx;
312 ctx = (struct nfs_open_context*)file->private_data;
313 return ctx->cred;
315 return NULL;
319 * linux/fs/nfs/direct.c
321 extern ssize_t nfs_direct_IO(int, struct kiocb *, const struct iovec *, loff_t,
322 unsigned long);
323 extern ssize_t nfs_file_direct_read(struct kiocb *iocb, char __user *buf,
324 size_t count, loff_t pos);
325 extern ssize_t nfs_file_direct_write(struct kiocb *iocb, const char __user *buf,
326 size_t count, loff_t pos);
329 * linux/fs/nfs/dir.c
331 extern struct inode_operations nfs_dir_inode_operations;
332 extern struct file_operations nfs_dir_operations;
333 extern struct dentry_operations nfs_dentry_operations;
335 extern int nfs_instantiate(struct dentry *dentry, struct nfs_fh *fh, struct nfs_fattr *fattr);
338 * linux/fs/nfs/symlink.c
340 extern struct inode_operations nfs_symlink_inode_operations;
343 * linux/fs/nfs/unlink.c
345 extern int nfs_async_unlink(struct dentry *);
346 extern void nfs_complete_unlink(struct dentry *);
349 * linux/fs/nfs/write.c
351 extern int nfs_writepage(struct page *page, struct writeback_control *wbc);
352 extern int nfs_writepages(struct address_space *, struct writeback_control *);
353 extern int nfs_flush_incompatible(struct file *file, struct page *page);
354 extern int nfs_updatepage(struct file *, struct page *, unsigned int, unsigned int);
355 extern void nfs_writeback_done(struct rpc_task *task);
357 #if defined(CONFIG_NFS_V3) || defined(CONFIG_NFS_V4)
358 extern void nfs_commit_done(struct rpc_task *);
359 #endif
362 * Try to write back everything synchronously (but check the
363 * return value!)
365 extern int nfs_sync_inode(struct inode *, unsigned long, unsigned int, int);
366 #if defined(CONFIG_NFS_V3) || defined(CONFIG_NFS_V4)
367 extern int nfs_commit_inode(struct inode *, unsigned long, unsigned int, int);
368 #else
369 static inline int
370 nfs_commit_inode(struct inode *inode, unsigned long idx_start, unsigned int npages, int how)
372 return 0;
374 #endif
376 static inline int
377 nfs_have_writebacks(struct inode *inode)
379 return NFS_I(inode)->npages != 0;
382 static inline int
383 nfs_wb_all(struct inode *inode)
385 int error = nfs_sync_inode(inode, 0, 0, FLUSH_WAIT);
386 return (error < 0) ? error : 0;
390 * Write back all requests on one page - we do this before reading it.
392 static inline int nfs_wb_page_priority(struct inode *inode, struct page* page, int how)
394 int error = nfs_sync_inode(inode, page->index, 1,
395 how | FLUSH_WAIT | FLUSH_STABLE);
396 return (error < 0) ? error : 0;
399 static inline int nfs_wb_page(struct inode *inode, struct page* page)
401 return nfs_wb_page_priority(inode, page, 0);
405 * Allocate and free nfs_write_data structures
407 extern mempool_t *nfs_wdata_mempool;
409 static inline struct nfs_write_data *nfs_writedata_alloc(void)
411 struct nfs_write_data *p = mempool_alloc(nfs_wdata_mempool, SLAB_NOFS);
412 if (p) {
413 memset(p, 0, sizeof(*p));
414 INIT_LIST_HEAD(&p->pages);
416 return p;
419 static inline void nfs_writedata_free(struct nfs_write_data *p)
421 mempool_free(p, nfs_wdata_mempool);
425 * linux/fs/nfs/read.c
427 extern int nfs_readpage(struct file *, struct page *);
428 extern int nfs_readpages(struct file *, struct address_space *,
429 struct list_head *, unsigned);
430 extern void nfs_readpage_result(struct rpc_task *);
433 * Allocate and free nfs_read_data structures
435 extern mempool_t *nfs_rdata_mempool;
437 static inline struct nfs_read_data *nfs_readdata_alloc(void)
439 struct nfs_read_data *p = mempool_alloc(nfs_rdata_mempool, SLAB_NOFS);
440 if (p)
441 memset(p, 0, sizeof(*p));
442 return p;
445 static inline void nfs_readdata_free(struct nfs_read_data *p)
447 mempool_free(p, nfs_rdata_mempool);
450 extern void nfs_readdata_release(struct rpc_task *task);
453 * linux/fs/mount_clnt.c
454 * (Used only by nfsroot module)
456 extern int nfsroot_mount(struct sockaddr_in *, char *, struct nfs_fh *,
457 int, int);
460 * inline functions
463 static inline loff_t
464 nfs_size_to_loff_t(__u64 size)
466 loff_t maxsz = (((loff_t) ULONG_MAX) << PAGE_CACHE_SHIFT) + PAGE_CACHE_SIZE - 1;
467 if (size > maxsz)
468 return maxsz;
469 return (loff_t) size;
472 static inline ino_t
473 nfs_fileid_to_ino_t(u64 fileid)
475 ino_t ino = (ino_t) fileid;
476 if (sizeof(ino_t) < sizeof(u64))
477 ino ^= fileid >> (sizeof(u64)-sizeof(ino_t)) * 8;
478 return ino;
481 /* NFS root */
483 extern void * nfs_root_data(void);
485 #define nfs_wait_event(clnt, wq, condition) \
486 ({ \
487 int __retval = 0; \
488 if (clnt->cl_intr) { \
489 sigset_t oldmask; \
490 rpc_clnt_sigmask(clnt, &oldmask); \
491 __retval = wait_event_interruptible(wq, condition); \
492 rpc_clnt_sigunmask(clnt, &oldmask); \
493 } else \
494 wait_event(wq, condition); \
495 __retval; \
498 #define NFS_JUKEBOX_RETRY_TIME (5 * HZ)
500 #endif /* __KERNEL__ */
503 * NFS debug flags
505 #define NFSDBG_VFS 0x0001
506 #define NFSDBG_DIRCACHE 0x0002
507 #define NFSDBG_LOOKUPCACHE 0x0004
508 #define NFSDBG_PAGECACHE 0x0008
509 #define NFSDBG_PROC 0x0010
510 #define NFSDBG_XDR 0x0020
511 #define NFSDBG_FILE 0x0040
512 #define NFSDBG_ROOT 0x0080
513 #define NFSDBG_CALLBACK 0x0100
514 #define NFSDBG_ALL 0xFFFF
516 #ifdef __KERNEL__
517 # undef ifdebug
518 # ifdef NFS_DEBUG
519 # define ifdebug(fac) if (unlikely(nfs_debug & NFSDBG_##fac))
520 # else
521 # define ifdebug(fac) if (0)
522 # endif
523 #endif /* __KERNEL */
525 #endif