NFS: Add a new ACCESS rpc call cache to the linux nfs client
[deliverable/linux.git] / include / linux / nfs_fs.h
CommitLineData
1da177e4
LT
1/*
2 * linux/include/linux/nfs_fs.h
3 *
4 * Copyright (C) 1992 Rick Sladkey
5 *
6 * OS-specific nfs filesystem definitions and declarations
7 */
8
9#ifndef _LINUX_NFS_FS_H
10#define _LINUX_NFS_FS_H
11
1da177e4
LT
12/*
13 * Enable debugging support for nfs client.
14 * Requires RPC_DEBUG.
15 */
16#ifdef RPC_DEBUG
17# define NFS_DEBUG
18#endif
19
03bf4b70
CL
20/* Default timeout values */
21#define NFS_MAX_UDP_TIMEOUT (60*HZ)
22#define NFS_MAX_TCP_TIMEOUT (600*HZ)
23
1da177e4
LT
24/*
25 * superblock magic number for NFS
26 */
27#define NFS_SUPER_MAGIC 0x6969
28
1da177e4
LT
29/*
30 * When flushing a cluster of dirty pages, there can be different
31 * strategies:
32 */
1da177e4 33#define FLUSH_SYNC 1 /* file being synced, or contention */
1da177e4
LT
34#define FLUSH_STABLE 4 /* commit to stable storage */
35#define FLUSH_LOWPRI 8 /* low priority background flush */
36#define FLUSH_HIGHPRI 16 /* high priority memory reclaim flush */
70b9ecbd 37#define FLUSH_NOCOMMIT 32 /* Don't send the NFSv3/v4 COMMIT */
d2ccddf0 38#define FLUSH_INVALIDATE 64 /* Invalidate the page cache */
1da177e4
LT
39
40#ifdef __KERNEL__
41
7f1cbe51
DW
42#include <linux/in.h>
43#include <linux/mm.h>
44#include <linux/pagemap.h>
1c3c07e9 45#include <linux/rbtree.h>
7f1cbe51
DW
46#include <linux/rwsem.h>
47#include <linux/wait.h>
48
49#include <linux/sunrpc/debug.h>
50#include <linux/sunrpc/auth.h>
51#include <linux/sunrpc/clnt.h>
52
53#include <linux/nfs.h>
54#include <linux/nfs2.h>
55#include <linux/nfs3.h>
56#include <linux/nfs4.h>
57#include <linux/nfs_xdr.h>
58
59#include <linux/nfs_fs_sb.h>
60
61#include <linux/rwsem.h>
62#include <linux/mempool.h>
63
64/*
65 * These are the default flags for swap requests
66 */
67#define NFS_RPC_SWAPFLAGS (RPC_TASK_SWAPPER|RPC_TASK_ROOTCREDS)
68
1da177e4
LT
69/*
70 * NFSv3/v4 Access mode cache entry
71 */
72struct nfs_access_entry {
1c3c07e9 73 struct rb_node rb_node;
1da177e4
LT
74 unsigned long jiffies;
75 struct rpc_cred * cred;
76 int mask;
77};
78
79struct nfs4_state;
80struct nfs_open_context {
81 atomic_t count;
b92dccf6 82 struct vfsmount *vfsmnt;
1da177e4
LT
83 struct dentry *dentry;
84 struct rpc_cred *cred;
85 struct nfs4_state *state;
86 fl_owner_t lockowner;
87 int mode;
88 int error;
89
90 struct list_head list;
00a92642 91
00a92642 92 __u64 dir_cookie;
1da177e4
LT
93};
94
95/*
96 * NFSv4 delegation
97 */
98struct nfs_delegation;
99
5c6a9f7d
AG
100struct posix_acl;
101
1da177e4
LT
102/*
103 * nfs fs inode data in memory
104 */
105struct nfs_inode {
106 /*
107 * The 64bit 'inode number'
108 */
109 __u64 fileid;
110
111 /*
112 * NFS file handle
113 */
114 struct nfs_fh fh;
115
116 /*
117 * Various flags
118 */
412d582e
CL
119 unsigned long flags; /* atomic bit ops */
120 unsigned long cache_validity; /* bit mask */
1da177e4
LT
121
122 /*
24bd68f4 123 * read_cache_jiffies is when we started read-caching this inode.
1da177e4
LT
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
127 * acregmin/acdirmin.
128 *
129 * We need to revalidate the cached attrs for this inode if
130 *
131 * jiffies - read_cache_jiffies > attrtimeo
1da177e4 132 */
1da177e4
LT
133 unsigned long read_cache_jiffies;
134 unsigned long attrtimeo;
135 unsigned long attrtimeo_timestamp;
136 __u64 change_attr; /* v4 only */
137
33801147 138 unsigned long last_updated;
1da177e4
LT
139 /* "Generation counter" for the attribute cache. This is
140 * bumped whenever we update the metadata on the
141 * server.
142 */
143 unsigned long cache_change_attribute;
144 /*
145 * Counter indicating the number of outstanding requests that
146 * will cause a file data update.
147 */
148 atomic_t data_updates;
149
1c3c07e9 150 struct rb_root access_cache;
5c6a9f7d
AG
151#ifdef CONFIG_NFS_V3_ACL
152 struct posix_acl *acl_access;
153 struct posix_acl *acl_default;
154#endif
1da177e4
LT
155
156 /*
157 * This is the cookie verifier used for NFSv3 readdir
158 * operations
159 */
160 __u32 cookieverf[2];
161
162 /*
163 * This is the list of dirty unwritten pages.
164 */
165 spinlock_t req_lock;
166 struct list_head dirty;
167 struct list_head commit;
168 struct radix_tree_root nfs_page_tree;
169
170 unsigned int ndirty,
171 ncommit,
172 npages;
173
174 /* Open contexts for shared mmap writes */
175 struct list_head open_files;
176
1da177e4 177#ifdef CONFIG_NFS_V4
e50a1c2e 178 struct nfs4_cached_acl *nfs4_acl;
1da177e4
LT
179 /* NFSv4 state */
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*/
1da177e4
LT
185 struct inode vfs_inode;
186};
187
188/*
55296809 189 * Cache validity bit flags
1da177e4 190 */
55296809
CL
191#define NFS_INO_INVALID_ATTR 0x0001 /* cached attrs are invalid */
192#define NFS_INO_INVALID_DATA 0x0002 /* cached data is invalid */
193#define NFS_INO_INVALID_ATIME 0x0004 /* cached atime is invalid */
194#define NFS_INO_INVALID_ACCESS 0x0008 /* cached access cred invalid */
195#define NFS_INO_INVALID_ACL 0x0010 /* cached acls are invalid */
196#define NFS_INO_REVAL_PAGECACHE 0x0020 /* must revalidate pagecache */
197
198/*
412d582e 199 * Bit offsets in flags field
55296809 200 */
412d582e
CL
201#define NFS_INO_REVALIDATING (0) /* revalidating attrs */
202#define NFS_INO_ADVISE_RDPLUS (1) /* advise readdirplus */
203#define NFS_INO_STALE (2) /* possible stale inode */
1da177e4
LT
204
205static inline struct nfs_inode *NFS_I(struct inode *inode)
206{
207 return container_of(inode, struct nfs_inode, vfs_inode);
208}
209#define NFS_SB(s) ((struct nfs_server *)(s->s_fs_info))
210
211#define NFS_FH(inode) (&NFS_I(inode)->fh)
212#define NFS_SERVER(inode) (NFS_SB(inode->i_sb))
213#define NFS_CLIENT(inode) (NFS_SERVER(inode)->client)
214#define NFS_PROTO(inode) (NFS_SERVER(inode)->rpc_ops)
215#define NFS_ADDR(inode) (RPC_PEERADDR(NFS_CLIENT(inode)))
216#define NFS_COOKIEVERF(inode) (NFS_I(inode)->cookieverf)
217#define NFS_READTIME(inode) (NFS_I(inode)->read_cache_jiffies)
218#define NFS_CHANGE_ATTR(inode) (NFS_I(inode)->change_attr)
219#define NFS_ATTRTIMEO(inode) (NFS_I(inode)->attrtimeo)
220#define NFS_MINATTRTIMEO(inode) \
221 (S_ISDIR(inode->i_mode)? NFS_SERVER(inode)->acdirmin \
222 : NFS_SERVER(inode)->acregmin)
223#define NFS_MAXATTRTIMEO(inode) \
224 (S_ISDIR(inode->i_mode)? NFS_SERVER(inode)->acdirmax \
225 : NFS_SERVER(inode)->acregmax)
226#define NFS_ATTRTIMEO_UPDATE(inode) (NFS_I(inode)->attrtimeo_timestamp)
227
228#define NFS_FLAGS(inode) (NFS_I(inode)->flags)
412d582e 229#define NFS_STALE(inode) (test_bit(NFS_INO_STALE, &NFS_FLAGS(inode)))
1da177e4
LT
230
231#define NFS_FILEID(inode) (NFS_I(inode)->fileid)
232
233static inline int nfs_caches_unstable(struct inode *inode)
234{
235 return atomic_read(&NFS_I(inode)->data_updates) != 0;
236}
237
decf491f
TM
238static inline void nfs_mark_for_revalidate(struct inode *inode)
239{
38478b24
TM
240 struct nfs_inode *nfsi = NFS_I(inode);
241
decf491f 242 spin_lock(&inode->i_lock);
38478b24
TM
243 nfsi->cache_validity |= NFS_INO_INVALID_ATTR|NFS_INO_INVALID_ACCESS;
244 if (S_ISDIR(inode->i_mode))
245 nfsi->cache_validity |= NFS_INO_REVAL_PAGECACHE|NFS_INO_INVALID_DATA;
decf491f
TM
246 spin_unlock(&inode->i_lock);
247}
248
1da177e4
LT
249static inline void NFS_CACHEINV(struct inode *inode)
250{
decf491f
TM
251 if (!nfs_caches_unstable(inode))
252 nfs_mark_for_revalidate(inode);
1da177e4
LT
253}
254
255static inline int nfs_server_capable(struct inode *inode, int cap)
256{
257 return NFS_SERVER(inode)->caps & cap;
258}
259
260static inline int NFS_USE_READDIRPLUS(struct inode *inode)
261{
412d582e 262 return test_bit(NFS_INO_ADVISE_RDPLUS, &NFS_FLAGS(inode));
1da177e4
LT
263}
264
265/**
266 * nfs_save_change_attribute - Returns the inode attribute change cookie
267 * @inode - pointer to inode
268 * The "change attribute" is updated every time we finish an operation
269 * that will result in a metadata change on the server.
270 */
271static inline long nfs_save_change_attribute(struct inode *inode)
272{
273 return NFS_I(inode)->cache_change_attribute;
274}
275
276/**
277 * nfs_verify_change_attribute - Detects NFS inode cache updates
278 * @inode - pointer to inode
279 * @chattr - previously saved change attribute
280 * Return "false" if metadata has been updated (or is in the process of
281 * being updated) since the change attribute was saved.
282 */
283static inline int nfs_verify_change_attribute(struct inode *inode, unsigned long chattr)
284{
285 return !nfs_caches_unstable(inode)
913a70fc 286 && time_after_eq(chattr, NFS_I(inode)->cache_change_attribute);
1da177e4
LT
287}
288
289/*
290 * linux/fs/nfs/inode.c
291 */
29884df0 292extern int nfs_sync_mapping(struct address_space *mapping);
1da177e4
LT
293extern void nfs_zap_caches(struct inode *);
294extern struct inode *nfs_fhget(struct super_block *, struct nfs_fh *,
295 struct nfs_fattr *);
296extern int nfs_refresh_inode(struct inode *, struct nfs_fattr *);
decf491f 297extern int nfs_post_op_update_inode(struct inode *inode, struct nfs_fattr *fattr);
1da177e4
LT
298extern int nfs_getattr(struct vfsmount *, struct dentry *, struct kstat *);
299extern int nfs_permission(struct inode *, int, struct nameidata *);
300extern int nfs_access_get_cached(struct inode *, struct rpc_cred *, struct nfs_access_entry *);
301extern void nfs_access_add_cache(struct inode *, struct nfs_access_entry *);
1c3c07e9 302extern void nfs_access_zap_cache(struct inode *inode);
1da177e4
LT
303extern int nfs_open(struct inode *, struct file *);
304extern int nfs_release(struct inode *, struct file *);
305extern int nfs_attribute_timeout(struct inode *inode);
306extern int nfs_revalidate_inode(struct nfs_server *server, struct inode *inode);
307extern int __nfs_revalidate_inode(struct nfs_server *, struct inode *);
44b11874 308extern int nfs_revalidate_mapping(struct inode *inode, struct address_space *mapping);
1da177e4 309extern int nfs_setattr(struct dentry *, struct iattr *);
65e4308d 310extern void nfs_setattr_update_inode(struct inode *inode, struct iattr *attr);
1da177e4
LT
311extern void nfs_begin_attr_update(struct inode *);
312extern void nfs_end_attr_update(struct inode *);
313extern void nfs_begin_data_update(struct inode *);
314extern void nfs_end_data_update(struct inode *);
1da177e4
LT
315extern struct nfs_open_context *get_nfs_open_context(struct nfs_open_context *ctx);
316extern void put_nfs_open_context(struct nfs_open_context *ctx);
d530838b 317extern struct nfs_open_context *nfs_find_open_context(struct inode *inode, struct rpc_cred *cred, int mode);
55a97593
TM
318extern struct vfsmount *nfs_do_submount(const struct vfsmount *mnt_parent,
319 const struct dentry *dentry,
320 struct nfs_fh *fh,
321 struct nfs_fattr *fattr);
1da177e4
LT
322
323/* linux/net/ipv4/ipconfig.c: trims ip addr off front of name, too. */
324extern u32 root_nfs_parse_addr(char *name); /*__init*/
325
0e574af1
TM
326static inline void nfs_fattr_init(struct nfs_fattr *fattr)
327{
328 fattr->valid = 0;
33801147 329 fattr->time_start = jiffies;
0e574af1
TM
330}
331
1da177e4
LT
332/*
333 * linux/fs/nfs/file.c
334 */
335extern struct inode_operations nfs_file_inode_operations;
b7fa0554
AG
336#ifdef CONFIG_NFS_V3
337extern struct inode_operations nfs3_file_inode_operations;
338#endif /* CONFIG_NFS_V3 */
4b6f5d20 339extern const struct file_operations nfs_file_operations;
f5e54d6e 340extern const struct address_space_operations nfs_file_aops;
1da177e4
LT
341
342static inline struct rpc_cred *nfs_file_cred(struct file *file)
343{
344 if (file != NULL) {
345 struct nfs_open_context *ctx;
346
347 ctx = (struct nfs_open_context*)file->private_data;
348 return ctx->cred;
349 }
350 return NULL;
351}
352
b7fa0554
AG
353/*
354 * linux/fs/nfs/xattr.c
355 */
356#ifdef CONFIG_NFS_V3_ACL
357extern ssize_t nfs3_listxattr(struct dentry *, char *, size_t);
358extern ssize_t nfs3_getxattr(struct dentry *, const char *, void *, size_t);
359extern int nfs3_setxattr(struct dentry *, const char *,
360 const void *, size_t, int);
361extern int nfs3_removexattr (struct dentry *, const char *name);
362#else
363# define nfs3_listxattr NULL
364# define nfs3_getxattr NULL
365# define nfs3_setxattr NULL
366# define nfs3_removexattr NULL
367#endif
368
1da177e4
LT
369/*
370 * linux/fs/nfs/direct.c
371 */
372extern ssize_t nfs_direct_IO(int, struct kiocb *, const struct iovec *, loff_t,
373 unsigned long);
374extern ssize_t nfs_file_direct_read(struct kiocb *iocb, char __user *buf,
375 size_t count, loff_t pos);
376extern ssize_t nfs_file_direct_write(struct kiocb *iocb, const char __user *buf,
377 size_t count, loff_t pos);
378
379/*
380 * linux/fs/nfs/dir.c
381 */
382extern struct inode_operations nfs_dir_inode_operations;
b7fa0554
AG
383#ifdef CONFIG_NFS_V3
384extern struct inode_operations nfs3_dir_inode_operations;
385#endif /* CONFIG_NFS_V3 */
4b6f5d20 386extern const struct file_operations nfs_dir_operations;
1da177e4
LT
387extern struct dentry_operations nfs_dentry_operations;
388
389extern int nfs_instantiate(struct dentry *dentry, struct nfs_fh *fh, struct nfs_fattr *fattr);
390
391/*
392 * linux/fs/nfs/symlink.c
393 */
394extern struct inode_operations nfs_symlink_inode_operations;
395
a72b4422
TM
396/*
397 * linux/fs/nfs/sysctl.c
398 */
399#ifdef CONFIG_SYSCTL
400extern int nfs_register_sysctl(void);
401extern void nfs_unregister_sysctl(void);
402#else
7fd105e7 403#define nfs_register_sysctl() 0
a72b4422
TM
404#define nfs_unregister_sysctl() do { } while(0)
405#endif
406
55a97593
TM
407/*
408 * linux/fs/nfs/namespace.c
409 */
51d8fa6a 410extern struct list_head nfs_automount_list;
55a97593 411extern struct inode_operations nfs_mountpoint_inode_operations;
6b97fd3d 412extern struct inode_operations nfs_referral_inode_operations;
51d8fa6a
TM
413extern int nfs_mountpoint_expiry_timeout;
414extern void nfs_release_automount_timer(void);
55a97593 415
1da177e4
LT
416/*
417 * linux/fs/nfs/unlink.c
418 */
419extern int nfs_async_unlink(struct dentry *);
420extern void nfs_complete_unlink(struct dentry *);
421
422/*
423 * linux/fs/nfs/write.c
424 */
425extern int nfs_writepage(struct page *page, struct writeback_control *wbc);
426extern int nfs_writepages(struct address_space *, struct writeback_control *);
427extern int nfs_flush_incompatible(struct file *file, struct page *page);
428extern int nfs_updatepage(struct file *, struct page *, unsigned int, unsigned int);
462d5b32
CL
429extern int nfs_writeback_done(struct rpc_task *, struct nfs_write_data *);
430extern void nfs_writedata_release(void *);
1da177e4 431
e17b1fc4 432#if defined(CONFIG_NFS_V3) || defined(CONFIG_NFS_V4)
e9f7bee1 433struct nfs_write_data *nfs_commit_alloc(void);
e17b1fc4
TM
434void nfs_commit_free(struct nfs_write_data *p);
435#endif
436
1da177e4
LT
437/*
438 * Try to write back everything synchronously (but check the
439 * return value!)
440 */
c42de9dd 441extern int nfs_sync_inode_wait(struct inode *, unsigned long, unsigned int, int);
1da177e4 442#if defined(CONFIG_NFS_V3) || defined(CONFIG_NFS_V4)
3da28eb1 443extern int nfs_commit_inode(struct inode *, int);
fad61490 444extern void nfs_commit_release(void *wdata);
1da177e4
LT
445#else
446static inline int
3da28eb1 447nfs_commit_inode(struct inode *inode, int how)
1da177e4
LT
448{
449 return 0;
450}
451#endif
452
453static inline int
454nfs_have_writebacks(struct inode *inode)
455{
456 return NFS_I(inode)->npages != 0;
457}
458
459static inline int
460nfs_wb_all(struct inode *inode)
461{
c42de9dd 462 int error = nfs_sync_inode_wait(inode, 0, 0, 0);
1da177e4
LT
463 return (error < 0) ? error : 0;
464}
465
466/*
467 * Write back all requests on one page - we do this before reading it.
468 */
469static inline int nfs_wb_page_priority(struct inode *inode, struct page* page, int how)
470{
c42de9dd
TM
471 int error = nfs_sync_inode_wait(inode, page->index, 1,
472 how | FLUSH_STABLE);
1da177e4
LT
473 return (error < 0) ? error : 0;
474}
475
476static inline int nfs_wb_page(struct inode *inode, struct page* page)
477{
478 return nfs_wb_page_priority(inode, page, 0);
479}
480
481/*
e4e20512 482 * Allocate nfs_write_data structures
1da177e4 483 */
e9f7bee1 484extern struct nfs_write_data *nfs_writedata_alloc(size_t len);
1da177e4 485
1da177e4
LT
486/*
487 * linux/fs/nfs/read.c
488 */
489extern int nfs_readpage(struct file *, struct page *);
490extern int nfs_readpages(struct file *, struct address_space *,
491 struct list_head *, unsigned);
ec06c096
TM
492extern int nfs_readpage_result(struct rpc_task *, struct nfs_read_data *);
493extern void nfs_readdata_release(void *data);
963d8fe5 494
1da177e4 495/*
e4e20512 496 * Allocate nfs_read_data structures
1da177e4 497 */
e9f7bee1 498extern struct nfs_read_data *nfs_readdata_alloc(size_t len);
1da177e4 499
b7fa0554
AG
500/*
501 * linux/fs/nfs3proc.c
502 */
503#ifdef CONFIG_NFS_V3_ACL
504extern struct posix_acl *nfs3_proc_getacl(struct inode *inode, int type);
505extern int nfs3_proc_setacl(struct inode *inode, int type,
506 struct posix_acl *acl);
055ffbea
AG
507extern int nfs3_proc_set_default_acl(struct inode *dir, struct inode *inode,
508 mode_t mode);
5c6a9f7d 509extern void nfs3_forget_cached_acls(struct inode *inode);
055ffbea
AG
510#else
511static inline int nfs3_proc_set_default_acl(struct inode *dir,
512 struct inode *inode,
513 mode_t mode)
514{
515 return 0;
516}
5c6a9f7d
AG
517
518static inline void nfs3_forget_cached_acls(struct inode *inode)
519{
520}
b7fa0554
AG
521#endif /* CONFIG_NFS_V3_ACL */
522
1da177e4
LT
523/*
524 * linux/fs/mount_clnt.c
525 * (Used only by nfsroot module)
526 */
527extern int nfsroot_mount(struct sockaddr_in *, char *, struct nfs_fh *,
528 int, int);
529
530/*
531 * inline functions
532 */
533
534static inline loff_t
535nfs_size_to_loff_t(__u64 size)
536{
537 loff_t maxsz = (((loff_t) ULONG_MAX) << PAGE_CACHE_SHIFT) + PAGE_CACHE_SIZE - 1;
538 if (size > maxsz)
539 return maxsz;
540 return (loff_t) size;
541}
542
543static inline ino_t
544nfs_fileid_to_ino_t(u64 fileid)
545{
546 ino_t ino = (ino_t) fileid;
547 if (sizeof(ino_t) < sizeof(u64))
548 ino ^= fileid >> (sizeof(u64)-sizeof(ino_t)) * 8;
549 return ino;
550}
551
552/* NFS root */
553
554extern void * nfs_root_data(void);
555
556#define nfs_wait_event(clnt, wq, condition) \
557({ \
558 int __retval = 0; \
559 if (clnt->cl_intr) { \
560 sigset_t oldmask; \
561 rpc_clnt_sigmask(clnt, &oldmask); \
562 __retval = wait_event_interruptible(wq, condition); \
563 rpc_clnt_sigunmask(clnt, &oldmask); \
564 } else \
565 wait_event(wq, condition); \
566 __retval; \
567})
568
569#define NFS_JUKEBOX_RETRY_TIME (5 * HZ)
570
1da177e4
LT
571#endif /* __KERNEL__ */
572
573/*
574 * NFS debug flags
575 */
576#define NFSDBG_VFS 0x0001
577#define NFSDBG_DIRCACHE 0x0002
578#define NFSDBG_LOOKUPCACHE 0x0004
579#define NFSDBG_PAGECACHE 0x0008
580#define NFSDBG_PROC 0x0010
581#define NFSDBG_XDR 0x0020
582#define NFSDBG_FILE 0x0040
583#define NFSDBG_ROOT 0x0080
584#define NFSDBG_CALLBACK 0x0100
585#define NFSDBG_ALL 0xFFFF
586
587#ifdef __KERNEL__
588# undef ifdebug
589# ifdef NFS_DEBUG
590# define ifdebug(fac) if (unlikely(nfs_debug & NFSDBG_##fac))
591# else
592# define ifdebug(fac) if (0)
593# endif
594#endif /* __KERNEL */
595
596#endif
This page took 0.245589 seconds and 5 git commands to generate.