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