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