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