Merge branch 'devel' into for-linus
[linux-2.6.git] / include / linux / nfs_fs.h
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/magic.h>
13
14 /* Default timeout values */
15 #define NFS_DEF_UDP_TIMEO       (11)
16 #define NFS_DEF_UDP_RETRANS     (3)
17 #define NFS_DEF_TCP_TIMEO       (600)
18 #define NFS_DEF_TCP_RETRANS     (2)
19
20 #define NFS_MAX_UDP_TIMEOUT     (60*HZ)
21 #define NFS_MAX_TCP_TIMEOUT     (600*HZ)
22
23 #define NFS_DEF_ACREGMIN        (3)
24 #define NFS_DEF_ACREGMAX        (60)
25 #define NFS_DEF_ACDIRMIN        (30)
26 #define NFS_DEF_ACDIRMAX        (60)
27
28 /*
29  * When flushing a cluster of dirty pages, there can be different
30  * strategies:
31  */
32 #define FLUSH_SYNC              1       /* file being synced, or contention */
33 #define FLUSH_STABLE            4       /* commit to stable storage */
34 #define FLUSH_LOWPRI            8       /* low priority background flush */
35 #define FLUSH_HIGHPRI           16      /* high priority memory reclaim flush */
36 #define FLUSH_NOCOMMIT          32      /* Don't send the NFSv3/v4 COMMIT */
37 #define FLUSH_INVALIDATE        64      /* Invalidate the page cache */
38 #define FLUSH_NOWRITEPAGE       128     /* Don't call writepage() */
39
40 #ifdef __KERNEL__
41
42 #include <linux/in.h>
43 #include <linux/kref.h>
44 #include <linux/mm.h>
45 #include <linux/pagemap.h>
46 #include <linux/rbtree.h>
47 #include <linux/rwsem.h>
48 #include <linux/wait.h>
49
50 #include <linux/sunrpc/debug.h>
51 #include <linux/sunrpc/auth.h>
52 #include <linux/sunrpc/clnt.h>
53
54 #include <linux/nfs.h>
55 #include <linux/nfs2.h>
56 #include <linux/nfs3.h>
57 #include <linux/nfs4.h>
58 #include <linux/nfs_xdr.h>
59 #include <linux/nfs_fs_sb.h>
60
61 #include <linux/mempool.h>
62
63 /*
64  * These are the default flags for swap requests
65  */
66 #define NFS_RPC_SWAPFLAGS               (RPC_TASK_SWAPPER|RPC_TASK_ROOTCREDS)
67
68 /*
69  * NFSv3/v4 Access mode cache entry
70  */
71 struct nfs_access_entry {
72         struct rb_node          rb_node;
73         struct list_head        lru;
74         unsigned long           jiffies;
75         struct rpc_cred *       cred;
76         int                     mask;
77 };
78
79 struct nfs4_state;
80 struct nfs_open_context {
81         atomic_t count;
82         struct path path;
83         struct rpc_cred *cred;
84         struct nfs4_state *state;
85         fl_owner_t lockowner;
86         fmode_t mode;
87
88         unsigned long flags;
89 #define NFS_CONTEXT_ERROR_WRITE         (0)
90         int error;
91
92         struct list_head list;
93
94         __u64 dir_cookie;
95 };
96
97 /*
98  * NFSv4 delegation
99  */
100 struct nfs_delegation;
101
102 struct posix_acl;
103
104 /*
105  * nfs fs inode data in memory
106  */
107 struct nfs_inode {
108         /*
109          * The 64bit 'inode number'
110          */
111         __u64 fileid;
112
113         /*
114          * NFS file handle
115          */
116         struct nfs_fh           fh;
117
118         /*
119          * Various flags
120          */
121         unsigned long           flags;                  /* atomic bit ops */
122         unsigned long           cache_validity;         /* bit mask */
123
124         /*
125          * read_cache_jiffies is when we started read-caching this inode.
126          * attrtimeo is for how long the cached information is assumed
127          * to be valid. A successful attribute revalidation doubles
128          * attrtimeo (up to acregmax/acdirmax), a failure resets it to
129          * acregmin/acdirmin.
130          *
131          * We need to revalidate the cached attrs for this inode if
132          *
133          *      jiffies - read_cache_jiffies >= attrtimeo
134          *
135          * Please note the comparison is greater than or equal
136          * so that zero timeout values can be specified.
137          */
138         unsigned long           read_cache_jiffies;
139         unsigned long           attrtimeo;
140         unsigned long           attrtimeo_timestamp;
141         __u64                   change_attr;            /* v4 only */
142
143         unsigned long           attr_gencount;
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         struct rb_root          access_cache;
151         struct list_head        access_cache_entry_lru;
152         struct list_head        access_cache_inode_lru;
153 #ifdef CONFIG_NFS_V3_ACL
154         struct posix_acl        *acl_access;
155         struct posix_acl        *acl_default;
156 #endif
157
158         /*
159          * This is the cookie verifier used for NFSv3 readdir
160          * operations
161          */
162         __be32                  cookieverf[2];
163
164         /*
165          * This is the list of dirty unwritten pages.
166          */
167         struct radix_tree_root  nfs_page_tree;
168
169         unsigned long           npages;
170
171         /* Open contexts for shared mmap writes */
172         struct list_head        open_files;
173
174         /* Number of in-flight sillydelete RPC calls */
175         atomic_t                silly_count;
176         /* List of deferred sillydelete requests */
177         struct hlist_head       silly_list;
178         wait_queue_head_t       waitqueue;
179
180 #ifdef CONFIG_NFS_V4
181         struct nfs4_cached_acl  *nfs4_acl;
182         /* NFSv4 state */
183         struct list_head        open_states;
184         struct nfs_delegation   *delegation;
185         fmode_t                  delegation_state;
186         struct rw_semaphore     rwsem;
187 #endif /* CONFIG_NFS_V4*/
188         struct inode            vfs_inode;
189 };
190
191 /*
192  * Cache validity bit flags
193  */
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 #define NFS_INO_REVAL_FORCED    0x0040          /* force revalidation ignoring a delegation */
201
202 /*
203  * Bit offsets in flags field
204  */
205 #define NFS_INO_ADVISE_RDPLUS   (0)             /* advise readdirplus */
206 #define NFS_INO_STALE           (1)             /* possible stale inode */
207 #define NFS_INO_ACL_LRU_SET     (2)             /* Inode is on the LRU list */
208 #define NFS_INO_MOUNTPOINT      (3)             /* inode is remote mountpoint */
209 #define NFS_INO_FLUSHING        (4)             /* inode is flushing out data */
210
211 static inline struct nfs_inode *NFS_I(const struct inode *inode)
212 {
213         return container_of(inode, struct nfs_inode, vfs_inode);
214 }
215
216 static inline struct nfs_server *NFS_SB(const struct super_block *s)
217 {
218         return (struct nfs_server *)(s->s_fs_info);
219 }
220
221 static inline struct nfs_fh *NFS_FH(const struct inode *inode)
222 {
223         return &NFS_I(inode)->fh;
224 }
225
226 static inline struct nfs_server *NFS_SERVER(const struct inode *inode)
227 {
228         return NFS_SB(inode->i_sb);
229 }
230
231 static inline struct rpc_clnt *NFS_CLIENT(const struct inode *inode)
232 {
233         return NFS_SERVER(inode)->client;
234 }
235
236 static inline const struct nfs_rpc_ops *NFS_PROTO(const struct inode *inode)
237 {
238         return NFS_SERVER(inode)->nfs_client->rpc_ops;
239 }
240
241 static inline __be32 *NFS_COOKIEVERF(const struct inode *inode)
242 {
243         return NFS_I(inode)->cookieverf;
244 }
245
246 static inline unsigned NFS_MINATTRTIMEO(const struct inode *inode)
247 {
248         struct nfs_server *nfss = NFS_SERVER(inode);
249         return S_ISDIR(inode->i_mode) ? nfss->acdirmin : nfss->acregmin;
250 }
251
252 static inline unsigned NFS_MAXATTRTIMEO(const struct inode *inode)
253 {
254         struct nfs_server *nfss = NFS_SERVER(inode);
255         return S_ISDIR(inode->i_mode) ? nfss->acdirmax : nfss->acregmax;
256 }
257
258 static inline int NFS_STALE(const struct inode *inode)
259 {
260         return test_bit(NFS_INO_STALE, &NFS_I(inode)->flags);
261 }
262
263 static inline __u64 NFS_FILEID(const struct inode *inode)
264 {
265         return NFS_I(inode)->fileid;
266 }
267
268 static inline void set_nfs_fileid(struct inode *inode, __u64 fileid)
269 {
270         NFS_I(inode)->fileid = fileid;
271 }
272
273 static inline void nfs_mark_for_revalidate(struct inode *inode)
274 {
275         struct nfs_inode *nfsi = NFS_I(inode);
276
277         spin_lock(&inode->i_lock);
278         nfsi->cache_validity |= NFS_INO_INVALID_ATTR|NFS_INO_INVALID_ACCESS;
279         if (S_ISDIR(inode->i_mode))
280                 nfsi->cache_validity |= NFS_INO_REVAL_PAGECACHE|NFS_INO_INVALID_DATA;
281         spin_unlock(&inode->i_lock);
282 }
283
284 static inline int nfs_server_capable(struct inode *inode, int cap)
285 {
286         return NFS_SERVER(inode)->caps & cap;
287 }
288
289 static inline int NFS_USE_READDIRPLUS(struct inode *inode)
290 {
291         return test_bit(NFS_INO_ADVISE_RDPLUS, &NFS_I(inode)->flags);
292 }
293
294 static inline void nfs_set_verifier(struct dentry * dentry, unsigned long verf)
295 {
296         dentry->d_time = verf;
297 }
298
299 /**
300  * nfs_save_change_attribute - Returns the inode attribute change cookie
301  * @dir - pointer to parent directory inode
302  * The "change attribute" is updated every time we finish an operation
303  * that will result in a metadata change on the server.
304  */
305 static inline unsigned long nfs_save_change_attribute(struct inode *dir)
306 {
307         return NFS_I(dir)->cache_change_attribute;
308 }
309
310 /**
311  * nfs_verify_change_attribute - Detects NFS remote directory changes
312  * @dir - pointer to parent directory inode
313  * @chattr - previously saved change attribute
314  * Return "false" if the verifiers doesn't match the change attribute.
315  * This would usually indicate that the directory contents have changed on
316  * the server, and that any dentries need revalidating.
317  */
318 static inline int nfs_verify_change_attribute(struct inode *dir, unsigned long chattr)
319 {
320         return chattr == NFS_I(dir)->cache_change_attribute;
321 }
322
323 /*
324  * linux/fs/nfs/inode.c
325  */
326 extern int nfs_sync_mapping(struct address_space *mapping);
327 extern void nfs_zap_mapping(struct inode *inode, struct address_space *mapping);
328 extern void nfs_zap_caches(struct inode *);
329 extern void nfs_invalidate_atime(struct inode *);
330 extern struct inode *nfs_fhget(struct super_block *, struct nfs_fh *,
331                                 struct nfs_fattr *);
332 extern int nfs_refresh_inode(struct inode *, struct nfs_fattr *);
333 extern int nfs_post_op_update_inode(struct inode *inode, struct nfs_fattr *fattr);
334 extern int nfs_post_op_update_inode_force_wcc(struct inode *inode, struct nfs_fattr *fattr);
335 extern int nfs_getattr(struct vfsmount *, struct dentry *, struct kstat *);
336 extern int nfs_permission(struct inode *, int);
337 extern int nfs_open(struct inode *, struct file *);
338 extern int nfs_release(struct inode *, struct file *);
339 extern int nfs_attribute_timeout(struct inode *inode);
340 extern int nfs_revalidate_inode(struct nfs_server *server, struct inode *inode);
341 extern int __nfs_revalidate_inode(struct nfs_server *, struct inode *);
342 extern int nfs_revalidate_mapping(struct inode *inode, struct address_space *mapping);
343 extern int nfs_revalidate_mapping_nolock(struct inode *inode, struct address_space *mapping);
344 extern int nfs_setattr(struct dentry *, struct iattr *);
345 extern void nfs_setattr_update_inode(struct inode *inode, struct iattr *attr);
346 extern struct nfs_open_context *get_nfs_open_context(struct nfs_open_context *ctx);
347 extern void put_nfs_open_context(struct nfs_open_context *ctx);
348 extern struct nfs_open_context *nfs_find_open_context(struct inode *inode, struct rpc_cred *cred, fmode_t mode);
349 extern u64 nfs_compat_user_ino64(u64 fileid);
350 extern void nfs_fattr_init(struct nfs_fattr *fattr);
351
352 /* linux/net/ipv4/ipconfig.c: trims ip addr off front of name, too. */
353 extern __be32 root_nfs_parse_addr(char *name); /*__init*/
354 extern unsigned long nfs_inc_attr_generation_counter(void);
355
356 /*
357  * linux/fs/nfs/file.c
358  */
359 extern const struct inode_operations nfs_file_inode_operations;
360 #ifdef CONFIG_NFS_V3
361 extern const struct inode_operations nfs3_file_inode_operations;
362 #endif /* CONFIG_NFS_V3 */
363 extern const struct file_operations nfs_file_operations;
364 extern const struct address_space_operations nfs_file_aops;
365
366 static inline struct nfs_open_context *nfs_file_open_context(struct file *filp)
367 {
368         return filp->private_data;
369 }
370
371 static inline struct rpc_cred *nfs_file_cred(struct file *file)
372 {
373         if (file != NULL) {
374                 struct nfs_open_context *ctx =
375                         nfs_file_open_context(file);
376                 if (ctx)
377                         return ctx->cred;
378         }
379         return NULL;
380 }
381
382 /*
383  * linux/fs/nfs/xattr.c
384  */
385 #ifdef CONFIG_NFS_V3_ACL
386 extern ssize_t nfs3_listxattr(struct dentry *, char *, size_t);
387 extern ssize_t nfs3_getxattr(struct dentry *, const char *, void *, size_t);
388 extern int nfs3_setxattr(struct dentry *, const char *,
389                         const void *, size_t, int);
390 extern int nfs3_removexattr (struct dentry *, const char *name);
391 #else
392 # define nfs3_listxattr NULL
393 # define nfs3_getxattr NULL
394 # define nfs3_setxattr NULL
395 # define nfs3_removexattr NULL
396 #endif
397
398 /*
399  * linux/fs/nfs/direct.c
400  */
401 extern ssize_t nfs_direct_IO(int, struct kiocb *, const struct iovec *, loff_t,
402                         unsigned long);
403 extern ssize_t nfs_file_direct_read(struct kiocb *iocb,
404                         const struct iovec *iov, unsigned long nr_segs,
405                         loff_t pos);
406 extern ssize_t nfs_file_direct_write(struct kiocb *iocb,
407                         const struct iovec *iov, unsigned long nr_segs,
408                         loff_t pos);
409
410 /*
411  * linux/fs/nfs/dir.c
412  */
413 extern const struct inode_operations nfs_dir_inode_operations;
414 #ifdef CONFIG_NFS_V3
415 extern const struct inode_operations nfs3_dir_inode_operations;
416 #endif /* CONFIG_NFS_V3 */
417 extern const struct file_operations nfs_dir_operations;
418 extern const struct dentry_operations nfs_dentry_operations;
419
420 extern void nfs_force_lookup_revalidate(struct inode *dir);
421 extern int nfs_instantiate(struct dentry *dentry, struct nfs_fh *fh, struct nfs_fattr *fattr);
422 extern int nfs_may_open(struct inode *inode, struct rpc_cred *cred, int openflags);
423 extern void nfs_access_zap_cache(struct inode *inode);
424
425 /*
426  * linux/fs/nfs/symlink.c
427  */
428 extern const struct inode_operations nfs_symlink_inode_operations;
429
430 /*
431  * linux/fs/nfs/sysctl.c
432  */
433 #ifdef CONFIG_SYSCTL
434 extern int nfs_register_sysctl(void);
435 extern void nfs_unregister_sysctl(void);
436 #else
437 #define nfs_register_sysctl() 0
438 #define nfs_unregister_sysctl() do { } while(0)
439 #endif
440
441 /*
442  * linux/fs/nfs/namespace.c
443  */
444 extern const struct inode_operations nfs_mountpoint_inode_operations;
445 extern const struct inode_operations nfs_referral_inode_operations;
446 extern int nfs_mountpoint_expiry_timeout;
447 extern void nfs_release_automount_timer(void);
448
449 /*
450  * linux/fs/nfs/unlink.c
451  */
452 extern int  nfs_async_unlink(struct inode *dir, struct dentry *dentry);
453 extern void nfs_complete_unlink(struct dentry *dentry, struct inode *);
454 extern void nfs_block_sillyrename(struct dentry *dentry);
455 extern void nfs_unblock_sillyrename(struct dentry *dentry);
456
457 /*
458  * linux/fs/nfs/write.c
459  */
460 extern int  nfs_congestion_kb;
461 extern int  nfs_writepage(struct page *page, struct writeback_control *wbc);
462 extern int  nfs_writepages(struct address_space *, struct writeback_control *);
463 extern int  nfs_flush_incompatible(struct file *file, struct page *page);
464 extern int  nfs_updatepage(struct file *, struct page *, unsigned int, unsigned int);
465 extern int nfs_writeback_done(struct rpc_task *, struct nfs_write_data *);
466 extern void nfs_writedata_release(void *);
467
468 /*
469  * Try to write back everything synchronously (but check the
470  * return value!)
471  */
472 extern long nfs_sync_mapping_wait(struct address_space *, struct writeback_control *, int);
473 extern int nfs_wb_all(struct inode *inode);
474 extern int nfs_wb_nocommit(struct inode *inode);
475 extern int nfs_wb_page(struct inode *inode, struct page* page);
476 extern int nfs_wb_page_cancel(struct inode *inode, struct page* page);
477 #if defined(CONFIG_NFS_V3) || defined(CONFIG_NFS_V4)
478 extern int  nfs_commit_inode(struct inode *, int);
479 extern struct nfs_write_data *nfs_commitdata_alloc(void);
480 extern void nfs_commit_free(struct nfs_write_data *wdata);
481 extern void nfs_commitdata_release(void *wdata);
482 #else
483 static inline int
484 nfs_commit_inode(struct inode *inode, int how)
485 {
486         return 0;
487 }
488 #endif
489
490 static inline int
491 nfs_have_writebacks(struct inode *inode)
492 {
493         return NFS_I(inode)->npages != 0;
494 }
495
496 /*
497  * Allocate nfs_write_data structures
498  */
499 extern struct nfs_write_data *nfs_writedata_alloc(unsigned int npages);
500
501 /*
502  * linux/fs/nfs/read.c
503  */
504 extern int  nfs_readpage(struct file *, struct page *);
505 extern int  nfs_readpages(struct file *, struct address_space *,
506                 struct list_head *, unsigned);
507 extern int  nfs_readpage_result(struct rpc_task *, struct nfs_read_data *);
508 extern void nfs_readdata_release(void *data);
509
510 /*
511  * Allocate nfs_read_data structures
512  */
513 extern struct nfs_read_data *nfs_readdata_alloc(unsigned int npages);
514
515 /*
516  * linux/fs/nfs3proc.c
517  */
518 #ifdef CONFIG_NFS_V3_ACL
519 extern struct posix_acl *nfs3_proc_getacl(struct inode *inode, int type);
520 extern int nfs3_proc_setacl(struct inode *inode, int type,
521                             struct posix_acl *acl);
522 extern int nfs3_proc_set_default_acl(struct inode *dir, struct inode *inode,
523                 mode_t mode);
524 extern void nfs3_forget_cached_acls(struct inode *inode);
525 #else
526 static inline int nfs3_proc_set_default_acl(struct inode *dir,
527                                             struct inode *inode,
528                                             mode_t mode)
529 {
530         return 0;
531 }
532
533 static inline void nfs3_forget_cached_acls(struct inode *inode)
534 {
535 }
536 #endif /* CONFIG_NFS_V3_ACL */
537
538 /*
539  * inline functions
540  */
541
542 static inline loff_t nfs_size_to_loff_t(__u64 size)
543 {
544         if (size > (__u64) OFFSET_MAX - 1)
545                 return OFFSET_MAX - 1;
546         return (loff_t) size;
547 }
548
549 static inline ino_t
550 nfs_fileid_to_ino_t(u64 fileid)
551 {
552         ino_t ino = (ino_t) fileid;
553         if (sizeof(ino_t) < sizeof(u64))
554                 ino ^= fileid >> (sizeof(u64)-sizeof(ino_t)) * 8;
555         return ino;
556 }
557
558 /* NFS root */
559
560 extern void * nfs_root_data(void);
561
562 #define nfs_wait_event(clnt, wq, condition)                             \
563 ({                                                                      \
564         int __retval = wait_event_killable(wq, condition);              \
565         __retval;                                                       \
566 })
567
568 #define NFS_JUKEBOX_RETRY_TIME (5 * HZ)
569
570 #endif /* __KERNEL__ */
571
572 /*
573  * NFS debug flags
574  */
575 #define NFSDBG_VFS              0x0001
576 #define NFSDBG_DIRCACHE         0x0002
577 #define NFSDBG_LOOKUPCACHE      0x0004
578 #define NFSDBG_PAGECACHE        0x0008
579 #define NFSDBG_PROC             0x0010
580 #define NFSDBG_XDR              0x0020
581 #define NFSDBG_FILE             0x0040
582 #define NFSDBG_ROOT             0x0080
583 #define NFSDBG_CALLBACK         0x0100
584 #define NFSDBG_CLIENT           0x0200
585 #define NFSDBG_MOUNT            0x0400
586 #define NFSDBG_ALL              0xFFFF
587
588 #ifdef __KERNEL__
589
590 /*
591  * Enable debugging support for nfs client.
592  * Requires RPC_DEBUG.
593  */
594 #ifdef RPC_DEBUG
595 # define NFS_DEBUG
596 #endif
597
598 # undef ifdebug
599 # ifdef NFS_DEBUG
600 #  define ifdebug(fac)          if (unlikely(nfs_debug & NFSDBG_##fac))
601 # else
602 #  define ifdebug(fac)          if (0)
603 # endif
604 #endif /* __KERNEL */
605
606 #endif