]> bbs.cooldavid.org Git - net-next-2.6.git/blame - include/linux/nfs_fs.h
Merge /home/trondmy/scm/kernel/git/torvalds/linux-2.6
[net-next-2.6.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
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>
1da177e4
LT
18
19#include <linux/nfs_fs_sb.h>
20
21#include <linux/sunrpc/debug.h>
22#include <linux/sunrpc/auth.h>
23#include <linux/sunrpc/clnt.h>
24
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>
1da177e4
LT
31#include <linux/mempool.h>
32
33/*
34 * Enable debugging support for nfs client.
35 * Requires RPC_DEBUG.
36 */
37#ifdef RPC_DEBUG
38# define NFS_DEBUG
39#endif
40
41#define NFS_MAX_FILE_IO_BUFFER_SIZE 32768
42#define NFS_DEF_FILE_IO_BUFFER_SIZE 4096
43
03bf4b70
CL
44/* Default timeout values */
45#define NFS_MAX_UDP_TIMEOUT (60*HZ)
46#define NFS_MAX_TCP_TIMEOUT (600*HZ)
47
1da177e4
LT
48/*
49 * superblock magic number for NFS
50 */
51#define NFS_SUPER_MAGIC 0x6969
52
53/*
54 * These are the default flags for swap requests
55 */
56#define NFS_RPC_SWAPFLAGS (RPC_TASK_SWAPPER|RPC_TASK_ROOTCREDS)
57
1da177e4
LT
58/*
59 * When flushing a cluster of dirty pages, there can be different
60 * strategies:
61 */
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 */
68
69#ifdef __KERNEL__
70
71/*
72 * NFSv3/v4 Access mode cache entry
73 */
74struct nfs_access_entry {
75 unsigned long jiffies;
76 struct rpc_cred * cred;
77 int mask;
78};
79
80struct nfs4_state;
81struct nfs_open_context {
82 atomic_t count;
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 /*
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
128 * acregmin/acdirmin.
129 *
130 * We need to revalidate the cached attrs for this inode if
131 *
132 * jiffies - read_cache_jiffies > attrtimeo
133 *
134 * and invalidate any cached data/flush out any dirty pages if
135 * we find that
136 *
137 * mtime != read_cache_mtime
138 */
1da177e4
LT
139 unsigned long read_cache_jiffies;
140 unsigned long attrtimeo;
141 unsigned long attrtimeo_timestamp;
142 __u64 change_attr; /* v4 only */
143
144 /* "Generation counter" for the attribute cache. This is
145 * bumped whenever we update the metadata on the
146 * server.
147 */
148 unsigned long cache_change_attribute;
149 /*
150 * Counter indicating the number of outstanding requests that
151 * will cause a file data update.
152 */
153 atomic_t data_updates;
154
155 struct nfs_access_entry cache_access;
5c6a9f7d
AG
156#ifdef CONFIG_NFS_V3_ACL
157 struct posix_acl *acl_access;
158 struct posix_acl *acl_default;
159#endif
1da177e4
LT
160
161 /*
162 * This is the cookie verifier used for NFSv3 readdir
163 * operations
164 */
165 __u32 cookieverf[2];
166
167 /*
168 * This is the list of dirty unwritten pages.
169 */
170 spinlock_t req_lock;
171 struct list_head dirty;
172 struct list_head commit;
173 struct radix_tree_root nfs_page_tree;
174
175 unsigned int ndirty,
176 ncommit,
177 npages;
178
179 /* Open contexts for shared mmap writes */
180 struct list_head open_files;
181
1da177e4 182#ifdef CONFIG_NFS_V4
e50a1c2e 183 struct nfs4_cached_acl *nfs4_acl;
1da177e4
LT
184 /* NFSv4 state */
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*/
1da177e4
LT
190 struct inode vfs_inode;
191};
192
193/*
55296809 194 * Cache validity bit flags
1da177e4 195 */
55296809
CL
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 */
202
203/*
412d582e 204 * Bit offsets in flags field
55296809 205 */
412d582e
CL
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 */
1da177e4
LT
209
210static inline struct nfs_inode *NFS_I(struct inode *inode)
211{
212 return container_of(inode, struct nfs_inode, vfs_inode);
213}
214#define NFS_SB(s) ((struct nfs_server *)(s->s_fs_info))
215
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)
232
233#define NFS_FLAGS(inode) (NFS_I(inode)->flags)
412d582e 234#define NFS_STALE(inode) (test_bit(NFS_INO_STALE, &NFS_FLAGS(inode)))
1da177e4
LT
235
236#define NFS_FILEID(inode) (NFS_I(inode)->fileid)
237
238static inline int nfs_caches_unstable(struct inode *inode)
239{
240 return atomic_read(&NFS_I(inode)->data_updates) != 0;
241}
242
243static inline void NFS_CACHEINV(struct inode *inode)
244{
dc59250c
CL
245 if (!nfs_caches_unstable(inode)) {
246 spin_lock(&inode->i_lock);
55296809 247 NFS_I(inode)->cache_validity |= NFS_INO_INVALID_ATTR | NFS_INO_INVALID_ACCESS;
dc59250c
CL
248 spin_unlock(&inode->i_lock);
249 }
1da177e4
LT
250}
251
252static inline int nfs_server_capable(struct inode *inode, int cap)
253{
254 return NFS_SERVER(inode)->caps & cap;
255}
256
257static inline int NFS_USE_READDIRPLUS(struct inode *inode)
258{
412d582e 259 return test_bit(NFS_INO_ADVISE_RDPLUS, &NFS_FLAGS(inode));
1da177e4
LT
260}
261
262/**
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.
267 */
268static inline long nfs_save_change_attribute(struct inode *inode)
269{
270 return NFS_I(inode)->cache_change_attribute;
271}
272
273/**
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.
279 */
280static inline int nfs_verify_change_attribute(struct inode *inode, unsigned long chattr)
281{
282 return !nfs_caches_unstable(inode)
283 && chattr == NFS_I(inode)->cache_change_attribute;
284}
285
286/*
287 * linux/fs/nfs/inode.c
288 */
289extern void nfs_zap_caches(struct inode *);
290extern struct inode *nfs_fhget(struct super_block *, struct nfs_fh *,
291 struct nfs_fattr *);
292extern int nfs_refresh_inode(struct inode *, struct nfs_fattr *);
293extern int nfs_getattr(struct vfsmount *, struct dentry *, struct kstat *);
294extern int nfs_permission(struct inode *, int, struct nameidata *);
295extern int nfs_access_get_cached(struct inode *, struct rpc_cred *, struct nfs_access_entry *);
296extern void nfs_access_add_cache(struct inode *, struct nfs_access_entry *);
297extern int nfs_open(struct inode *, struct file *);
298extern int nfs_release(struct inode *, struct file *);
299extern int nfs_attribute_timeout(struct inode *inode);
300extern int nfs_revalidate_inode(struct nfs_server *server, struct inode *inode);
301extern int __nfs_revalidate_inode(struct nfs_server *, struct inode *);
7d52e862 302extern void nfs_revalidate_mapping(struct inode *inode, struct address_space *mapping);
1da177e4 303extern int nfs_setattr(struct dentry *, struct iattr *);
65e4308d 304extern void nfs_setattr_update_inode(struct inode *inode, struct iattr *attr);
1da177e4
LT
305extern void nfs_begin_attr_update(struct inode *);
306extern void nfs_end_attr_update(struct inode *);
307extern void nfs_begin_data_update(struct inode *);
308extern void nfs_end_data_update(struct inode *);
1da177e4
LT
309extern struct nfs_open_context *alloc_nfs_open_context(struct dentry *dentry, struct rpc_cred *cred);
310extern struct nfs_open_context *get_nfs_open_context(struct nfs_open_context *ctx);
311extern void put_nfs_open_context(struct nfs_open_context *ctx);
312extern void nfs_file_set_open_context(struct file *filp, struct nfs_open_context *ctx);
313extern struct nfs_open_context *nfs_find_open_context(struct inode *inode, int mode);
314extern void nfs_file_clear_open_context(struct file *filp);
315
316/* linux/net/ipv4/ipconfig.c: trims ip addr off front of name, too. */
317extern u32 root_nfs_parse_addr(char *name); /*__init*/
318
319/*
320 * linux/fs/nfs/file.c
321 */
322extern struct inode_operations nfs_file_inode_operations;
b7fa0554
AG
323#ifdef CONFIG_NFS_V3
324extern struct inode_operations nfs3_file_inode_operations;
325#endif /* CONFIG_NFS_V3 */
1da177e4
LT
326extern struct file_operations nfs_file_operations;
327extern struct address_space_operations nfs_file_aops;
328
329static inline struct rpc_cred *nfs_file_cred(struct file *file)
330{
331 if (file != NULL) {
332 struct nfs_open_context *ctx;
333
334 ctx = (struct nfs_open_context*)file->private_data;
335 return ctx->cred;
336 }
337 return NULL;
338}
339
b7fa0554
AG
340/*
341 * linux/fs/nfs/xattr.c
342 */
343#ifdef CONFIG_NFS_V3_ACL
344extern ssize_t nfs3_listxattr(struct dentry *, char *, size_t);
345extern ssize_t nfs3_getxattr(struct dentry *, const char *, void *, size_t);
346extern int nfs3_setxattr(struct dentry *, const char *,
347 const void *, size_t, int);
348extern int nfs3_removexattr (struct dentry *, const char *name);
349#else
350# define nfs3_listxattr NULL
351# define nfs3_getxattr NULL
352# define nfs3_setxattr NULL
353# define nfs3_removexattr NULL
354#endif
355
1da177e4
LT
356/*
357 * linux/fs/nfs/direct.c
358 */
359extern ssize_t nfs_direct_IO(int, struct kiocb *, const struct iovec *, loff_t,
360 unsigned long);
361extern ssize_t nfs_file_direct_read(struct kiocb *iocb, char __user *buf,
362 size_t count, loff_t pos);
363extern ssize_t nfs_file_direct_write(struct kiocb *iocb, const char __user *buf,
364 size_t count, loff_t pos);
365
366/*
367 * linux/fs/nfs/dir.c
368 */
369extern struct inode_operations nfs_dir_inode_operations;
b7fa0554
AG
370#ifdef CONFIG_NFS_V3
371extern struct inode_operations nfs3_dir_inode_operations;
372#endif /* CONFIG_NFS_V3 */
1da177e4
LT
373extern struct file_operations nfs_dir_operations;
374extern struct dentry_operations nfs_dentry_operations;
375
376extern int nfs_instantiate(struct dentry *dentry, struct nfs_fh *fh, struct nfs_fattr *fattr);
377
378/*
379 * linux/fs/nfs/symlink.c
380 */
381extern struct inode_operations nfs_symlink_inode_operations;
382
383/*
384 * linux/fs/nfs/unlink.c
385 */
386extern int nfs_async_unlink(struct dentry *);
387extern void nfs_complete_unlink(struct dentry *);
388
389/*
390 * linux/fs/nfs/write.c
391 */
392extern int nfs_writepage(struct page *page, struct writeback_control *wbc);
393extern int nfs_writepages(struct address_space *, struct writeback_control *);
394extern int nfs_flush_incompatible(struct file *file, struct page *page);
395extern int nfs_updatepage(struct file *, struct page *, unsigned int, unsigned int);
396extern void nfs_writeback_done(struct rpc_task *task);
397
398#if defined(CONFIG_NFS_V3) || defined(CONFIG_NFS_V4)
399extern void nfs_commit_done(struct rpc_task *);
400#endif
401
402/*
403 * Try to write back everything synchronously (but check the
404 * return value!)
405 */
406extern int nfs_sync_inode(struct inode *, unsigned long, unsigned int, int);
407#if defined(CONFIG_NFS_V3) || defined(CONFIG_NFS_V4)
3da28eb1 408extern int nfs_commit_inode(struct inode *, int);
1da177e4
LT
409#else
410static inline int
3da28eb1 411nfs_commit_inode(struct inode *inode, int how)
1da177e4
LT
412{
413 return 0;
414}
415#endif
416
417static inline int
418nfs_have_writebacks(struct inode *inode)
419{
420 return NFS_I(inode)->npages != 0;
421}
422
423static inline int
424nfs_wb_all(struct inode *inode)
425{
426 int error = nfs_sync_inode(inode, 0, 0, FLUSH_WAIT);
427 return (error < 0) ? error : 0;
428}
429
430/*
431 * Write back all requests on one page - we do this before reading it.
432 */
433static inline int nfs_wb_page_priority(struct inode *inode, struct page* page, int how)
434{
435 int error = nfs_sync_inode(inode, page->index, 1,
436 how | FLUSH_WAIT | FLUSH_STABLE);
437 return (error < 0) ? error : 0;
438}
439
440static inline int nfs_wb_page(struct inode *inode, struct page* page)
441{
442 return nfs_wb_page_priority(inode, page, 0);
443}
444
445/*
446 * Allocate and free nfs_write_data structures
447 */
448extern mempool_t *nfs_wdata_mempool;
449
450static inline struct nfs_write_data *nfs_writedata_alloc(void)
451{
452 struct nfs_write_data *p = mempool_alloc(nfs_wdata_mempool, SLAB_NOFS);
453 if (p) {
454 memset(p, 0, sizeof(*p));
455 INIT_LIST_HEAD(&p->pages);
456 }
457 return p;
458}
459
460static inline void nfs_writedata_free(struct nfs_write_data *p)
461{
462 mempool_free(p, nfs_wdata_mempool);
463}
464
1da177e4
LT
465/*
466 * linux/fs/nfs/read.c
467 */
468extern int nfs_readpage(struct file *, struct page *);
469extern int nfs_readpages(struct file *, struct address_space *,
470 struct list_head *, unsigned);
471extern void nfs_readpage_result(struct rpc_task *);
472
473/*
474 * Allocate and free nfs_read_data structures
475 */
476extern mempool_t *nfs_rdata_mempool;
477
478static inline struct nfs_read_data *nfs_readdata_alloc(void)
479{
480 struct nfs_read_data *p = mempool_alloc(nfs_rdata_mempool, SLAB_NOFS);
481 if (p)
482 memset(p, 0, sizeof(*p));
483 return p;
484}
485
486static inline void nfs_readdata_free(struct nfs_read_data *p)
487{
488 mempool_free(p, nfs_rdata_mempool);
489}
490
491extern void nfs_readdata_release(struct rpc_task *task);
492
b7fa0554
AG
493/*
494 * linux/fs/nfs3proc.c
495 */
496#ifdef CONFIG_NFS_V3_ACL
497extern struct posix_acl *nfs3_proc_getacl(struct inode *inode, int type);
498extern int nfs3_proc_setacl(struct inode *inode, int type,
499 struct posix_acl *acl);
055ffbea
AG
500extern int nfs3_proc_set_default_acl(struct inode *dir, struct inode *inode,
501 mode_t mode);
5c6a9f7d 502extern void nfs3_forget_cached_acls(struct inode *inode);
055ffbea
AG
503#else
504static inline int nfs3_proc_set_default_acl(struct inode *dir,
505 struct inode *inode,
506 mode_t mode)
507{
508 return 0;
509}
5c6a9f7d
AG
510
511static inline void nfs3_forget_cached_acls(struct inode *inode)
512{
513}
b7fa0554
AG
514#endif /* CONFIG_NFS_V3_ACL */
515
1da177e4
LT
516/*
517 * linux/fs/mount_clnt.c
518 * (Used only by nfsroot module)
519 */
520extern int nfsroot_mount(struct sockaddr_in *, char *, struct nfs_fh *,
521 int, int);
522
523/*
524 * inline functions
525 */
526
527static inline loff_t
528nfs_size_to_loff_t(__u64 size)
529{
530 loff_t maxsz = (((loff_t) ULONG_MAX) << PAGE_CACHE_SHIFT) + PAGE_CACHE_SIZE - 1;
531 if (size > maxsz)
532 return maxsz;
533 return (loff_t) size;
534}
535
536static inline ino_t
537nfs_fileid_to_ino_t(u64 fileid)
538{
539 ino_t ino = (ino_t) fileid;
540 if (sizeof(ino_t) < sizeof(u64))
541 ino ^= fileid >> (sizeof(u64)-sizeof(ino_t)) * 8;
542 return ino;
543}
544
545/* NFS root */
546
547extern void * nfs_root_data(void);
548
549#define nfs_wait_event(clnt, wq, condition) \
550({ \
551 int __retval = 0; \
552 if (clnt->cl_intr) { \
553 sigset_t oldmask; \
554 rpc_clnt_sigmask(clnt, &oldmask); \
555 __retval = wait_event_interruptible(wq, condition); \
556 rpc_clnt_sigunmask(clnt, &oldmask); \
557 } else \
558 wait_event(wq, condition); \
559 __retval; \
560})
561
562#define NFS_JUKEBOX_RETRY_TIME (5 * HZ)
563
1da177e4
LT
564#endif /* __KERNEL__ */
565
566/*
567 * NFS debug flags
568 */
569#define NFSDBG_VFS 0x0001
570#define NFSDBG_DIRCACHE 0x0002
571#define NFSDBG_LOOKUPCACHE 0x0004
572#define NFSDBG_PAGECACHE 0x0008
573#define NFSDBG_PROC 0x0010
574#define NFSDBG_XDR 0x0020
575#define NFSDBG_FILE 0x0040
576#define NFSDBG_ROOT 0x0080
577#define NFSDBG_CALLBACK 0x0100
578#define NFSDBG_ALL 0xFFFF
579
580#ifdef __KERNEL__
581# undef ifdebug
582# ifdef NFS_DEBUG
583# define ifdebug(fac) if (unlikely(nfs_debug & NFSDBG_##fac))
584# else
585# define ifdebug(fac) if (0)
586# endif
587#endif /* __KERNEL */
588
589#endif