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