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