[NET]: ipconfig and nfsroot annotations
[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 /*
15  * Enable debugging support for nfs client.
16  * Requires RPC_DEBUG.
17  */
18 #ifdef RPC_DEBUG
19 # define NFS_DEBUG
20 #endif
21
22 /* Default timeout values */
23 #define NFS_MAX_UDP_TIMEOUT     (60*HZ)
24 #define NFS_MAX_TCP_TIMEOUT     (600*HZ)
25
26 /*
27  * When flushing a cluster of dirty pages, there can be different
28  * strategies:
29  */
30 #define FLUSH_SYNC              1       /* file being synced, or contention */
31 #define FLUSH_STABLE            4       /* commit to stable storage */
32 #define FLUSH_LOWPRI            8       /* low priority background flush */
33 #define FLUSH_HIGHPRI           16      /* high priority memory reclaim flush */
34 #define FLUSH_NOCOMMIT          32      /* Don't send the NFSv3/v4 COMMIT */
35 #define FLUSH_INVALIDATE        64      /* Invalidate the page cache */
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
56 #include <linux/nfs_fs_sb.h>
57
58 #include <linux/rwsem.h>
59 #include <linux/mempool.h>
60
61 /*
62  * These are the default flags for swap requests
63  */
64 #define NFS_RPC_SWAPFLAGS               (RPC_TASK_SWAPPER|RPC_TASK_ROOTCREDS)
65
66 /*
67  * NFSv3/v4 Access mode cache entry
68  */
69 struct nfs_access_entry {
70         struct rb_node          rb_node;
71         struct list_head        lru;
72         unsigned long           jiffies;
73         struct rpc_cred *       cred;
74         int                     mask;
75 };
76
77 struct nfs4_state;
78 struct nfs_open_context {
79         atomic_t count;
80         struct vfsmount *vfsmnt;
81         struct dentry *dentry;
82         struct rpc_cred *cred;
83         struct nfs4_state *state;
84         fl_owner_t lockowner;
85         int mode;
86         int error;
87
88         struct list_head list;
89
90         __u64 dir_cookie;
91 };
92
93 /*
94  * NFSv4 delegation
95  */
96 struct nfs_delegation;
97
98 struct posix_acl;
99
100 /*
101  * nfs fs inode data in memory
102  */
103 struct nfs_inode {
104         /*
105          * The 64bit 'inode number'
106          */
107         __u64 fileid;
108
109         /*
110          * NFS file handle
111          */
112         struct nfs_fh           fh;
113
114         /*
115          * Various flags
116          */
117         unsigned long           flags;                  /* atomic bit ops */
118         unsigned long           cache_validity;         /* bit mask */
119
120         /*
121          * read_cache_jiffies is when we started read-caching this inode.
122          * attrtimeo is for how long the cached information is assumed
123          * to be valid. A successful attribute revalidation doubles
124          * attrtimeo (up to acregmax/acdirmax), a failure resets it to
125          * acregmin/acdirmin.
126          *
127          * We need to revalidate the cached attrs for this inode if
128          *
129          *      jiffies - read_cache_jiffies > attrtimeo
130          */
131         unsigned long           read_cache_jiffies;
132         unsigned long           attrtimeo;
133         unsigned long           attrtimeo_timestamp;
134         __u64                   change_attr;            /* v4 only */
135
136         unsigned long           last_updated;
137         /* "Generation counter" for the attribute cache. This is
138          * bumped whenever we update the metadata on the
139          * server.
140          */
141         unsigned long           cache_change_attribute;
142         /*
143          * Counter indicating the number of outstanding requests that
144          * will cause a file data update.
145          */
146         atomic_t                data_updates;
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         spinlock_t              req_lock;
166         struct list_head        dirty;
167         struct list_head        commit;
168         struct radix_tree_root  nfs_page_tree;
169
170         unsigned int            ndirty,
171                                 ncommit,
172                                 npages;
173
174         /* Open contexts for shared mmap writes */
175         struct list_head        open_files;
176
177 #ifdef CONFIG_NFS_V4
178         struct nfs4_cached_acl  *nfs4_acl;
179         /* NFSv4 state */
180         struct list_head        open_states;
181         struct nfs_delegation   *delegation;
182         int                      delegation_state;
183         struct rw_semaphore     rwsem;
184 #endif /* CONFIG_NFS_V4*/
185         struct inode            vfs_inode;
186 };
187
188 /*
189  * Cache validity bit flags
190  */
191 #define NFS_INO_INVALID_ATTR    0x0001          /* cached attrs are invalid */
192 #define NFS_INO_INVALID_DATA    0x0002          /* cached data is invalid */
193 #define NFS_INO_INVALID_ATIME   0x0004          /* cached atime is invalid */
194 #define NFS_INO_INVALID_ACCESS  0x0008          /* cached access cred invalid */
195 #define NFS_INO_INVALID_ACL     0x0010          /* cached acls are invalid */
196 #define NFS_INO_REVAL_PAGECACHE 0x0020          /* must revalidate pagecache */
197
198 /*
199  * Bit offsets in flags field
200  */
201 #define NFS_INO_REVALIDATING    (0)             /* revalidating attrs */
202 #define NFS_INO_ADVISE_RDPLUS   (1)             /* advise readdirplus */
203 #define NFS_INO_STALE           (2)             /* possible stale inode */
204 #define NFS_INO_ACL_LRU_SET     (3)             /* Inode is on the LRU list */
205
206 static inline struct nfs_inode *NFS_I(struct inode *inode)
207 {
208         return container_of(inode, struct nfs_inode, vfs_inode);
209 }
210 #define NFS_SB(s)               ((struct nfs_server *)(s->s_fs_info))
211
212 #define NFS_FH(inode)                   (&NFS_I(inode)->fh)
213 #define NFS_SERVER(inode)               (NFS_SB(inode->i_sb))
214 #define NFS_CLIENT(inode)               (NFS_SERVER(inode)->client)
215 #define NFS_PROTO(inode)                (NFS_SERVER(inode)->nfs_client->rpc_ops)
216 #define NFS_COOKIEVERF(inode)           (NFS_I(inode)->cookieverf)
217 #define NFS_READTIME(inode)             (NFS_I(inode)->read_cache_jiffies)
218 #define NFS_CHANGE_ATTR(inode)          (NFS_I(inode)->change_attr)
219 #define NFS_ATTRTIMEO(inode)            (NFS_I(inode)->attrtimeo)
220 #define NFS_MINATTRTIMEO(inode) \
221         (S_ISDIR(inode->i_mode)? NFS_SERVER(inode)->acdirmin \
222                                : NFS_SERVER(inode)->acregmin)
223 #define NFS_MAXATTRTIMEO(inode) \
224         (S_ISDIR(inode->i_mode)? NFS_SERVER(inode)->acdirmax \
225                                : NFS_SERVER(inode)->acregmax)
226 #define NFS_ATTRTIMEO_UPDATE(inode)     (NFS_I(inode)->attrtimeo_timestamp)
227
228 #define NFS_FLAGS(inode)                (NFS_I(inode)->flags)
229 #define NFS_STALE(inode)                (test_bit(NFS_INO_STALE, &NFS_FLAGS(inode)))
230
231 #define NFS_FILEID(inode)               (NFS_I(inode)->fileid)
232
233 static inline int nfs_caches_unstable(struct inode *inode)
234 {
235         return atomic_read(&NFS_I(inode)->data_updates) != 0;
236 }
237
238 static inline void nfs_mark_for_revalidate(struct inode *inode)
239 {
240         struct nfs_inode *nfsi = NFS_I(inode);
241
242         spin_lock(&inode->i_lock);
243         nfsi->cache_validity |= NFS_INO_INVALID_ATTR|NFS_INO_INVALID_ACCESS;
244         if (S_ISDIR(inode->i_mode))
245                 nfsi->cache_validity |= NFS_INO_REVAL_PAGECACHE|NFS_INO_INVALID_DATA;
246         spin_unlock(&inode->i_lock);
247 }
248
249 static inline void NFS_CACHEINV(struct inode *inode)
250 {
251         if (!nfs_caches_unstable(inode))
252                 nfs_mark_for_revalidate(inode);
253 }
254
255 static inline int nfs_server_capable(struct inode *inode, int cap)
256 {
257         return NFS_SERVER(inode)->caps & cap;
258 }
259
260 static inline int NFS_USE_READDIRPLUS(struct inode *inode)
261 {
262         return test_bit(NFS_INO_ADVISE_RDPLUS, &NFS_FLAGS(inode));
263 }
264
265 /**
266  * nfs_save_change_attribute - Returns the inode attribute change cookie
267  * @inode - pointer to inode
268  * The "change attribute" is updated every time we finish an operation
269  * that will result in a metadata change on the server.
270  */
271 static inline long nfs_save_change_attribute(struct inode *inode)
272 {
273         return NFS_I(inode)->cache_change_attribute;
274 }
275
276 /**
277  * nfs_verify_change_attribute - Detects NFS inode cache updates
278  * @inode - pointer to inode
279  * @chattr - previously saved change attribute
280  * Return "false" if metadata has been updated (or is in the process of
281  * being updated) since the change attribute was saved.
282  */
283 static inline int nfs_verify_change_attribute(struct inode *inode, unsigned long chattr)
284 {
285         return !nfs_caches_unstable(inode)
286                 && time_after_eq(chattr, NFS_I(inode)->cache_change_attribute);
287 }
288
289 /*
290  * linux/fs/nfs/inode.c
291  */
292 extern int nfs_sync_mapping(struct address_space *mapping);
293 extern void nfs_zap_mapping(struct inode *inode, struct address_space *mapping);
294 extern void nfs_zap_caches(struct inode *);
295 extern struct inode *nfs_fhget(struct super_block *, struct nfs_fh *,
296                                 struct nfs_fattr *);
297 extern int nfs_refresh_inode(struct inode *, struct nfs_fattr *);
298 extern int nfs_post_op_update_inode(struct inode *inode, struct nfs_fattr *fattr);
299 extern int nfs_getattr(struct vfsmount *, struct dentry *, struct kstat *);
300 extern int nfs_permission(struct inode *, int, struct nameidata *);
301 extern int nfs_access_get_cached(struct inode *, struct rpc_cred *, struct nfs_access_entry *);
302 extern void nfs_access_add_cache(struct inode *, struct nfs_access_entry *);
303 extern void nfs_access_zap_cache(struct inode *inode);
304 extern int nfs_open(struct inode *, struct file *);
305 extern int nfs_release(struct inode *, struct file *);
306 extern int nfs_attribute_timeout(struct inode *inode);
307 extern int nfs_revalidate_inode(struct nfs_server *server, struct inode *inode);
308 extern int __nfs_revalidate_inode(struct nfs_server *, struct inode *);
309 extern int nfs_revalidate_mapping(struct inode *inode, struct address_space *mapping);
310 extern int nfs_setattr(struct dentry *, struct iattr *);
311 extern void nfs_setattr_update_inode(struct inode *inode, struct iattr *attr);
312 extern void nfs_begin_attr_update(struct inode *);
313 extern void nfs_end_attr_update(struct inode *);
314 extern void nfs_begin_data_update(struct inode *);
315 extern void nfs_end_data_update(struct inode *);
316 extern struct nfs_open_context *get_nfs_open_context(struct nfs_open_context *ctx);
317 extern void put_nfs_open_context(struct nfs_open_context *ctx);
318 extern struct nfs_open_context *nfs_find_open_context(struct inode *inode, struct rpc_cred *cred, int mode);
319
320 /* linux/net/ipv4/ipconfig.c: trims ip addr off front of name, too. */
321 extern __be32 root_nfs_parse_addr(char *name); /*__init*/
322
323 static inline void nfs_fattr_init(struct nfs_fattr *fattr)
324 {
325         fattr->valid = 0;
326         fattr->time_start = jiffies;
327 }
328
329 /*
330  * linux/fs/nfs/file.c
331  */
332 extern struct inode_operations nfs_file_inode_operations;
333 #ifdef CONFIG_NFS_V3
334 extern struct inode_operations nfs3_file_inode_operations;
335 #endif /* CONFIG_NFS_V3 */
336 extern const struct file_operations nfs_file_operations;
337 extern const struct address_space_operations nfs_file_aops;
338
339 static inline struct rpc_cred *nfs_file_cred(struct file *file)
340 {
341         if (file != NULL) {
342                 struct nfs_open_context *ctx;
343
344                 ctx = (struct nfs_open_context*)file->private_data;
345                 return ctx->cred;
346         }
347         return NULL;
348 }
349
350 /*
351  * linux/fs/nfs/xattr.c
352  */
353 #ifdef CONFIG_NFS_V3_ACL
354 extern ssize_t nfs3_listxattr(struct dentry *, char *, size_t);
355 extern ssize_t nfs3_getxattr(struct dentry *, const char *, void *, size_t);
356 extern int nfs3_setxattr(struct dentry *, const char *,
357                         const void *, size_t, int);
358 extern int nfs3_removexattr (struct dentry *, const char *name);
359 #else
360 # define nfs3_listxattr NULL
361 # define nfs3_getxattr NULL
362 # define nfs3_setxattr NULL
363 # define nfs3_removexattr NULL
364 #endif
365
366 /*
367  * linux/fs/nfs/direct.c
368  */
369 extern ssize_t nfs_direct_IO(int, struct kiocb *, const struct iovec *, loff_t,
370                         unsigned long);
371 extern ssize_t nfs_file_direct_read(struct kiocb *iocb,
372                         const struct iovec *iov, unsigned long nr_segs,
373                         loff_t pos);
374 extern ssize_t nfs_file_direct_write(struct kiocb *iocb,
375                         const struct iovec *iov, unsigned long nr_segs,
376                         loff_t pos);
377
378 /*
379  * linux/fs/nfs/dir.c
380  */
381 extern struct inode_operations nfs_dir_inode_operations;
382 #ifdef CONFIG_NFS_V3
383 extern struct inode_operations nfs3_dir_inode_operations;
384 #endif /* CONFIG_NFS_V3 */
385 extern const struct file_operations nfs_dir_operations;
386 extern struct dentry_operations nfs_dentry_operations;
387
388 extern int nfs_instantiate(struct dentry *dentry, struct nfs_fh *fh, struct nfs_fattr *fattr);
389
390 /*
391  * linux/fs/nfs/symlink.c
392  */
393 extern struct inode_operations nfs_symlink_inode_operations;
394
395 /*
396  * linux/fs/nfs/sysctl.c
397  */
398 #ifdef CONFIG_SYSCTL
399 extern int nfs_register_sysctl(void);
400 extern void nfs_unregister_sysctl(void);
401 #else
402 #define nfs_register_sysctl() 0
403 #define nfs_unregister_sysctl() do { } while(0)
404 #endif
405
406 /*
407  * linux/fs/nfs/namespace.c
408  */
409 extern struct list_head nfs_automount_list;
410 extern struct inode_operations nfs_mountpoint_inode_operations;
411 extern struct inode_operations nfs_referral_inode_operations;
412 extern int nfs_mountpoint_expiry_timeout;
413 extern void nfs_release_automount_timer(void);
414
415 /*
416  * linux/fs/nfs/unlink.c
417  */
418 extern int  nfs_async_unlink(struct dentry *);
419 extern void nfs_complete_unlink(struct dentry *);
420
421 /*
422  * linux/fs/nfs/write.c
423  */
424 extern int  nfs_writepage(struct page *page, struct writeback_control *wbc);
425 extern int  nfs_writepages(struct address_space *, struct writeback_control *);
426 extern int  nfs_flush_incompatible(struct file *file, struct page *page);
427 extern int  nfs_updatepage(struct file *, struct page *, unsigned int, unsigned int);
428 extern int nfs_writeback_done(struct rpc_task *, struct nfs_write_data *);
429 extern void nfs_writedata_release(void *);
430
431 #if defined(CONFIG_NFS_V3) || defined(CONFIG_NFS_V4)
432 struct nfs_write_data *nfs_commit_alloc(void);
433 void nfs_commit_free(struct nfs_write_data *p);
434 #endif
435
436 /*
437  * Try to write back everything synchronously (but check the
438  * return value!)
439  */
440 extern int  nfs_sync_inode_wait(struct inode *, unsigned long, unsigned int, int);
441 #if defined(CONFIG_NFS_V3) || defined(CONFIG_NFS_V4)
442 extern int  nfs_commit_inode(struct inode *, int);
443 extern void nfs_commit_release(void *wdata);
444 #else
445 static inline int
446 nfs_commit_inode(struct inode *inode, int how)
447 {
448         return 0;
449 }
450 #endif
451
452 static inline int
453 nfs_have_writebacks(struct inode *inode)
454 {
455         return NFS_I(inode)->npages != 0;
456 }
457
458 static inline int
459 nfs_wb_all(struct inode *inode)
460 {
461         int error = nfs_sync_inode_wait(inode, 0, 0, 0);
462         return (error < 0) ? error : 0;
463 }
464
465 /*
466  * Write back all requests on one page - we do this before reading it.
467  */
468 static inline int nfs_wb_page_priority(struct inode *inode, struct page* page, int how)
469 {
470         int error = nfs_sync_inode_wait(inode, page->index, 1,
471                         how | FLUSH_STABLE);
472         return (error < 0) ? error : 0;
473 }
474
475 static inline int nfs_wb_page(struct inode *inode, struct page* page)
476 {
477         return nfs_wb_page_priority(inode, page, 0);
478 }
479
480 /*
481  * Allocate nfs_write_data structures
482  */
483 extern struct nfs_write_data *nfs_writedata_alloc(size_t len);
484
485 /*
486  * linux/fs/nfs/read.c
487  */
488 extern int  nfs_readpage(struct file *, struct page *);
489 extern int  nfs_readpages(struct file *, struct address_space *,
490                 struct list_head *, unsigned);
491 extern int  nfs_readpage_result(struct rpc_task *, struct nfs_read_data *);
492 extern void nfs_readdata_release(void *data);
493
494 /*
495  * Allocate nfs_read_data structures
496  */
497 extern struct nfs_read_data *nfs_readdata_alloc(size_t len);
498
499 /*
500  * linux/fs/nfs3proc.c
501  */
502 #ifdef CONFIG_NFS_V3_ACL
503 extern struct posix_acl *nfs3_proc_getacl(struct inode *inode, int type);
504 extern int nfs3_proc_setacl(struct inode *inode, int type,
505                             struct posix_acl *acl);
506 extern int nfs3_proc_set_default_acl(struct inode *dir, struct inode *inode,
507                 mode_t mode);
508 extern void nfs3_forget_cached_acls(struct inode *inode);
509 #else
510 static inline int nfs3_proc_set_default_acl(struct inode *dir,
511                                             struct inode *inode,
512                                             mode_t mode)
513 {
514         return 0;
515 }
516
517 static inline void nfs3_forget_cached_acls(struct inode *inode)
518 {
519 }
520 #endif /* CONFIG_NFS_V3_ACL */
521
522 /*
523  * linux/fs/mount_clnt.c
524  * (Used only by nfsroot module)
525  */
526 extern int  nfsroot_mount(struct sockaddr_in *, char *, struct nfs_fh *,
527                 int, int);
528
529 /*
530  * inline functions
531  */
532
533 static inline loff_t
534 nfs_size_to_loff_t(__u64 size)
535 {
536         loff_t maxsz = (((loff_t) ULONG_MAX) << PAGE_CACHE_SHIFT) + PAGE_CACHE_SIZE - 1;
537         if (size > maxsz)
538                 return maxsz;
539         return (loff_t) size;
540 }
541
542 static inline ino_t
543 nfs_fileid_to_ino_t(u64 fileid)
544 {
545         ino_t ino = (ino_t) fileid;
546         if (sizeof(ino_t) < sizeof(u64))
547                 ino ^= fileid >> (sizeof(u64)-sizeof(ino_t)) * 8;
548         return ino;
549 }
550
551 /* NFS root */
552
553 extern void * nfs_root_data(void);
554
555 #define nfs_wait_event(clnt, wq, condition)                             \
556 ({                                                                      \
557         int __retval = 0;                                               \
558         if (clnt->cl_intr) {                                            \
559                 sigset_t oldmask;                                       \
560                 rpc_clnt_sigmask(clnt, &oldmask);                       \
561                 __retval = wait_event_interruptible(wq, condition);     \
562                 rpc_clnt_sigunmask(clnt, &oldmask);                     \
563         } else                                                          \
564                 wait_event(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_ALL              0xFFFF
586
587 #ifdef __KERNEL__
588 # undef ifdebug
589 # ifdef NFS_DEBUG
590 #  define ifdebug(fac)          if (unlikely(nfs_debug & NFSDBG_##fac))
591 # else
592 #  define ifdebug(fac)          if (0)
593 # endif
594 #endif /* __KERNEL */
595
596 #endif