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