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