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