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