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