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(const struct inode *inode)
200{
201 return container_of(inode, struct nfs_inode, vfs_inode);
202}
203
204static inline struct nfs_server *NFS_SB(const struct super_block *s)
205{
206 return (struct nfs_server *)(s->s_fs_info);
207}
208
209static inline struct nfs_fh *NFS_FH(const struct inode *inode)
210{
211 return &NFS_I(inode)->fh;
212}
213
214static inline struct nfs_server *NFS_SERVER(const struct inode *inode)
215{
216 return NFS_SB(inode->i_sb);
217}
218
219static inline struct rpc_clnt *NFS_CLIENT(const struct inode *inode)
220{
221 return NFS_SERVER(inode)->client;
222}
223
224static inline const struct nfs_rpc_ops *NFS_PROTO(const struct inode *inode)
225{
226 return NFS_SERVER(inode)->nfs_client->rpc_ops;
227}
228
229static inline __be32 *NFS_COOKIEVERF(const struct inode *inode)
230{
231 return NFS_I(inode)->cookieverf;
232}
233
234static inline unsigned NFS_MINATTRTIMEO(const struct inode *inode)
235{
236 struct nfs_server *nfss = NFS_SERVER(inode);
237 return S_ISDIR(inode->i_mode) ? nfss->acdirmin : nfss->acregmin;
238}
239
240static inline unsigned NFS_MAXATTRTIMEO(const struct inode *inode)
241{
242 struct nfs_server *nfss = NFS_SERVER(inode);
243 return S_ISDIR(inode->i_mode) ? nfss->acdirmax : nfss->acregmax;
244}
245
246static inline int NFS_STALE(const struct inode *inode)
247{
248 return test_bit(NFS_INO_STALE, &NFS_I(inode)->flags);
249}
250
251static inline __u64 NFS_FILEID(const struct inode *inode)
252{
253 return NFS_I(inode)->fileid;
254}
255
256static inline void set_nfs_fileid(struct inode *inode, __u64 fileid)
257{
258 NFS_I(inode)->fileid = fileid;
259}
260
261static inline void nfs_mark_for_revalidate(struct inode *inode)
262{
263 struct nfs_inode *nfsi = NFS_I(inode);
264
265 spin_lock(&inode->i_lock);
266 nfsi->cache_validity |= NFS_INO_INVALID_ATTR|NFS_INO_INVALID_ACCESS;
267 if (S_ISDIR(inode->i_mode))
268 nfsi->cache_validity |= NFS_INO_REVAL_PAGECACHE|NFS_INO_INVALID_DATA;
269 spin_unlock(&inode->i_lock);
270}
271
272static inline int nfs_server_capable(struct inode *inode, int cap)
273{
274 return NFS_SERVER(inode)->caps & cap;
275}
276
277static inline int NFS_USE_READDIRPLUS(struct inode *inode)
278{
279 return test_bit(NFS_INO_ADVISE_RDPLUS, &NFS_I(inode)->flags);
280}
281
282static inline void nfs_set_verifier(struct dentry * dentry, unsigned long verf)
283{
284 dentry->d_time = verf;
285}
286
287/**
288 * nfs_save_change_attribute - Returns the inode attribute change cookie
289 * @dir - pointer to parent directory inode
290 * The "change attribute" is updated every time we finish an operation
291 * that will result in a metadata change on the server.
292 */
293static inline unsigned long nfs_save_change_attribute(struct inode *dir)
294{
295 return NFS_I(dir)->cache_change_attribute;
296}
297
298/**
299 * nfs_verify_change_attribute - Detects NFS remote directory changes
300 * @dir - pointer to parent directory inode
301 * @chattr - previously saved change attribute
302 * Return "false" if the verifiers doesn't match the change attribute.
303 * This would usually indicate that the directory contents have changed on
304 * the server, and that any dentries need revalidating.
305 */
306static inline int nfs_verify_change_attribute(struct inode *dir, unsigned long chattr)
307{
308 return chattr == NFS_I(dir)->cache_change_attribute;
309}
310
311/*
312 * linux/fs/nfs/inode.c
313 */
314extern int nfs_sync_mapping(struct address_space *mapping);
315extern void nfs_zap_mapping(struct inode *inode, struct address_space *mapping);
316extern void nfs_zap_caches(struct inode *);
317extern void nfs_invalidate_atime(struct inode *);
318extern struct inode *nfs_fhget(struct super_block *, struct nfs_fh *,
319 struct nfs_fattr *);
320extern int nfs_refresh_inode(struct inode *, struct nfs_fattr *);
321extern int nfs_post_op_update_inode(struct inode *inode, struct nfs_fattr *fattr);
322extern int nfs_post_op_update_inode_force_wcc(struct inode *inode, struct nfs_fattr *fattr);
323extern int nfs_getattr(struct vfsmount *, struct dentry *, struct kstat *);
324extern int nfs_permission(struct inode *, int, struct nameidata *);
325extern int nfs_open(struct inode *, struct file *);
326extern int nfs_release(struct inode *, struct file *);
327extern int nfs_attribute_timeout(struct inode *inode);
328extern int nfs_revalidate_inode(struct nfs_server *server, struct inode *inode);
329extern int __nfs_revalidate_inode(struct nfs_server *, struct inode *);
330extern int nfs_revalidate_mapping(struct inode *inode, struct address_space *mapping);
331extern int nfs_revalidate_mapping_nolock(struct inode *inode, struct address_space *mapping);
332extern int nfs_setattr(struct dentry *, struct iattr *);
333extern void nfs_setattr_update_inode(struct inode *inode, struct iattr *attr);
334extern struct nfs_open_context *get_nfs_open_context(struct nfs_open_context *ctx);
335extern void put_nfs_open_context(struct nfs_open_context *ctx);
336extern struct nfs_open_context *nfs_find_open_context(struct inode *inode, struct rpc_cred *cred, int mode);
337extern u64 nfs_compat_user_ino64(u64 fileid);
338
339/* linux/net/ipv4/ipconfig.c: trims ip addr off front of name, too. */
340extern __be32 root_nfs_parse_addr(char *name); /*__init*/
341
342static inline void nfs_fattr_init(struct nfs_fattr *fattr)
343{
344 fattr->valid = 0;
345 fattr->time_start = jiffies;
346}
347
348/*
349 * linux/fs/nfs/file.c
350 */
351extern const struct inode_operations nfs_file_inode_operations;
352#ifdef CONFIG_NFS_V3
353extern const struct inode_operations nfs3_file_inode_operations;
354#endif /* CONFIG_NFS_V3 */
355extern const struct file_operations nfs_file_operations;
356extern const struct address_space_operations nfs_file_aops;
357
358static inline struct nfs_open_context *nfs_file_open_context(struct file *filp)
359{
360 return filp->private_data;
361}
362
363static inline struct rpc_cred *nfs_file_cred(struct file *file)
364{
365 if (file != NULL)
366 return nfs_file_open_context(file)->cred;
367 return NULL;
368}
369
370/*
371 * linux/fs/nfs/xattr.c
372 */
373#ifdef CONFIG_NFS_V3_ACL
374extern ssize_t nfs3_listxattr(struct dentry *, char *, size_t);
375extern ssize_t nfs3_getxattr(struct dentry *, const char *, void *, size_t);
376extern int nfs3_setxattr(struct dentry *, const char *,
377 const void *, size_t, int);
378extern int nfs3_removexattr (struct dentry *, const char *name);
379#else
380# define nfs3_listxattr NULL
381# define nfs3_getxattr NULL
382# define nfs3_setxattr NULL
383# define nfs3_removexattr NULL
384#endif
385
386/*
387 * linux/fs/nfs/direct.c
388 */
389extern ssize_t nfs_direct_IO(int, struct kiocb *, const struct iovec *, loff_t,
390 unsigned long);
391extern ssize_t nfs_file_direct_read(struct kiocb *iocb,
392 const struct iovec *iov, unsigned long nr_segs,
393 loff_t pos);
394extern ssize_t nfs_file_direct_write(struct kiocb *iocb,
395 const struct iovec *iov, unsigned long nr_segs,
396 loff_t pos);
397
398/*
399 * linux/fs/nfs/dir.c
400 */
401extern const struct inode_operations nfs_dir_inode_operations;
402#ifdef CONFIG_NFS_V3
403extern const struct inode_operations nfs3_dir_inode_operations;
404#endif /* CONFIG_NFS_V3 */
405extern const struct file_operations nfs_dir_operations;
406extern struct dentry_operations nfs_dentry_operations;
407
408extern void nfs_force_lookup_revalidate(struct inode *dir);
409extern int nfs_instantiate(struct dentry *dentry, struct nfs_fh *fh, struct nfs_fattr *fattr);
410extern int nfs_may_open(struct inode *inode, struct rpc_cred *cred, int openflags);
411extern void nfs_access_zap_cache(struct inode *inode);
412
413/*
414 * linux/fs/nfs/symlink.c
415 */
416extern const struct inode_operations nfs_symlink_inode_operations;
417
418/*
419 * linux/fs/nfs/sysctl.c
420 */
421#ifdef CONFIG_SYSCTL
422extern int nfs_register_sysctl(void);
423extern void nfs_unregister_sysctl(void);
424#else
425#define nfs_register_sysctl() 0
426#define nfs_unregister_sysctl() do { } while(0)
427#endif
428
429/*
430 * linux/fs/nfs/namespace.c
431 */
432extern struct list_head nfs_automount_list;
433extern const struct inode_operations nfs_mountpoint_inode_operations;
434extern const struct inode_operations nfs_referral_inode_operations;
435extern int nfs_mountpoint_expiry_timeout;
436extern void nfs_release_automount_timer(void);
437
438/*
439 * linux/fs/nfs/unlink.c
440 */
441extern int nfs_async_unlink(struct inode *dir, struct dentry *dentry);
442extern void nfs_complete_unlink(struct dentry *dentry, struct inode *);
443extern void nfs_block_sillyrename(struct dentry *dentry);
444extern void nfs_unblock_sillyrename(struct dentry *dentry);
445
446/*
447 * linux/fs/nfs/write.c
448 */
449extern int nfs_congestion_kb;
450extern int nfs_writepage(struct page *page, struct writeback_control *wbc);
451extern int nfs_writepages(struct address_space *, struct writeback_control *);
452extern int nfs_flush_incompatible(struct file *file, struct page *page);
453extern int nfs_updatepage(struct file *, struct page *, unsigned int, unsigned int);
454extern int nfs_writeback_done(struct rpc_task *, struct nfs_write_data *);
455extern void nfs_writedata_release(void *);
456
457/*
458 * Try to write back everything synchronously (but check the
459 * return value!)
460 */
461extern long nfs_sync_mapping_wait(struct address_space *, struct writeback_control *, int);
462extern int nfs_wb_all(struct inode *inode);
463extern int nfs_wb_nocommit(struct inode *inode);
464extern int nfs_wb_page(struct inode *inode, struct page* page);
465extern int nfs_wb_page_cancel(struct inode *inode, struct page* page);
466#if defined(CONFIG_NFS_V3) || defined(CONFIG_NFS_V4)
467extern int nfs_commit_inode(struct inode *, int);
468extern struct nfs_write_data *nfs_commit_alloc(void);
469extern void nfs_commit_free(struct nfs_write_data *wdata);
470extern void nfs_commit_release(void *wdata);
471#else
472static inline int
473nfs_commit_inode(struct inode *inode, int how)
474{
475 return 0;
476}
477#endif
478
479static inline int
480nfs_have_writebacks(struct inode *inode)
481{
482 return NFS_I(inode)->npages != 0;
483}
484
485/*
486 * Allocate nfs_write_data structures
487 */
488extern struct nfs_write_data *nfs_writedata_alloc(unsigned int npages);
489
490/*
491 * linux/fs/nfs/read.c
492 */
493extern int nfs_readpage(struct file *, struct page *);
494extern int nfs_readpages(struct file *, struct address_space *,
495 struct list_head *, unsigned);
496extern int nfs_readpage_result(struct rpc_task *, struct nfs_read_data *);
497extern void nfs_readdata_release(void *data);
498
499/*
500 * Allocate nfs_read_data structures
501 */
502extern struct nfs_read_data *nfs_readdata_alloc(unsigned int npages);
503
504/*
505 * linux/fs/nfs3proc.c
506 */
507#ifdef CONFIG_NFS_V3_ACL
508extern struct posix_acl *nfs3_proc_getacl(struct inode *inode, int type);
509extern int nfs3_proc_setacl(struct inode *inode, int type,
510 struct posix_acl *acl);
511extern int nfs3_proc_set_default_acl(struct inode *dir, struct inode *inode,
512 mode_t mode);
513extern void nfs3_forget_cached_acls(struct inode *inode);
514#else
515static inline int nfs3_proc_set_default_acl(struct inode *dir,
516 struct inode *inode,
517 mode_t mode)
518{
519 return 0;
520}
521
522static inline void nfs3_forget_cached_acls(struct inode *inode)
523{
524}
525#endif /* CONFIG_NFS_V3_ACL */
526
527/*
528 * linux/fs/mount_clnt.c
529 */
530extern int nfs_mount(struct sockaddr *, size_t, char *, char *,
531 int, int, struct nfs_fh *);
532
533/*
534 * inline functions
535 */
536
537static inline loff_t nfs_size_to_loff_t(__u64 size)
538{
539 if (size > (__u64) OFFSET_MAX - 1)
540 return OFFSET_MAX - 1;
541 return (loff_t) size;
542}
543
544static inline ino_t
545nfs_fileid_to_ino_t(u64 fileid)
546{
547 ino_t ino = (ino_t) fileid;
548 if (sizeof(ino_t) < sizeof(u64))
549 ino ^= fileid >> (sizeof(u64)-sizeof(ino_t)) * 8;
550 return ino;
551}
552
553/* NFS root */
554
555extern void * nfs_root_data(void);
556
557#define nfs_wait_event(clnt, wq, condition) \
558({ \
559 int __retval = wait_event_killable(wq, condition); \
560 __retval; \
561})
562
563#define NFS_JUKEBOX_RETRY_TIME (5 * HZ)
564
565#endif /* __KERNEL__ */
566
567/*
568 * NFS debug flags
569 */
570#define NFSDBG_VFS 0x0001
571#define NFSDBG_DIRCACHE 0x0002
572#define NFSDBG_LOOKUPCACHE 0x0004
573#define NFSDBG_PAGECACHE 0x0008
574#define NFSDBG_PROC 0x0010
575#define NFSDBG_XDR 0x0020
576#define NFSDBG_FILE 0x0040
577#define NFSDBG_ROOT 0x0080
578#define NFSDBG_CALLBACK 0x0100
579#define NFSDBG_CLIENT 0x0200
580#define NFSDBG_MOUNT 0x0400
581#define NFSDBG_ALL 0xFFFF
582
583#ifdef __KERNEL__
584
585/*
586 * Enable debugging support for nfs client.
587 * Requires RPC_DEBUG.
588 */
589#ifdef RPC_DEBUG
590# define NFS_DEBUG
591#endif
592
593# undef ifdebug
594# ifdef NFS_DEBUG
595# define ifdebug(fac) if (unlikely(nfs_debug & NFSDBG_##fac))
596# else
597# define ifdebug(fac) if (0)
598# endif
599#endif /* __KERNEL */
600
601#endif