xref: /openbmc/linux/fs/nfs/internal.h (revision 78700c0a)
1 /*
2  * NFS internal definitions
3  */
4 
5 #include "nfs4_fs.h"
6 #include <linux/mount.h>
7 #include <linux/security.h>
8 #include <linux/crc32.h>
9 #include <linux/nfs_page.h>
10 
11 #define NFS_MS_MASK (MS_RDONLY|MS_NOSUID|MS_NODEV|MS_NOEXEC|MS_SYNCHRONOUS)
12 
13 struct nfs_string;
14 
15 /* Maximum number of readahead requests
16  * FIXME: this should really be a sysctl so that users may tune it to suit
17  *        their needs. People that do NFS over a slow network, might for
18  *        instance want to reduce it to something closer to 1 for improved
19  *        interactive response.
20  */
21 #define NFS_MAX_READAHEAD	(RPC_DEF_SLOT_TABLE - 1)
22 
23 static inline void nfs_attr_check_mountpoint(struct super_block *parent, struct nfs_fattr *fattr)
24 {
25 	if (!nfs_fsid_equal(&NFS_SB(parent)->fsid, &fattr->fsid))
26 		fattr->valid |= NFS_ATTR_FATTR_MOUNTPOINT;
27 }
28 
29 static inline int nfs_attr_use_mounted_on_fileid(struct nfs_fattr *fattr)
30 {
31 	if (((fattr->valid & NFS_ATTR_FATTR_MOUNTED_ON_FILEID) == 0) ||
32 	    (((fattr->valid & NFS_ATTR_FATTR_MOUNTPOINT) == 0) &&
33 	     ((fattr->valid & NFS_ATTR_FATTR_V4_REFERRAL) == 0)))
34 		return 0;
35 	return 1;
36 }
37 
38 struct nfs_clone_mount {
39 	const struct super_block *sb;
40 	const struct dentry *dentry;
41 	struct nfs_fh *fh;
42 	struct nfs_fattr *fattr;
43 	char *hostname;
44 	char *mnt_path;
45 	struct sockaddr *addr;
46 	size_t addrlen;
47 	rpc_authflavor_t authflavor;
48 };
49 
50 /*
51  * Note: RFC 1813 doesn't limit the number of auth flavors that
52  * a server can return, so make something up.
53  */
54 #define NFS_MAX_SECFLAVORS	(12)
55 
56 /*
57  * Value used if the user did not specify a port value.
58  */
59 #define NFS_UNSPEC_PORT		(-1)
60 
61 /*
62  * Maximum number of pages that readdir can use for creating
63  * a vmapped array of pages.
64  */
65 #define NFS_MAX_READDIR_PAGES 8
66 
67 struct nfs_client_initdata {
68 	unsigned long init_flags;
69 	const char *hostname;
70 	const struct sockaddr *addr;
71 	size_t addrlen;
72 	struct nfs_subversion *nfs_mod;
73 	int proto;
74 	u32 minorversion;
75 	struct net *net;
76 };
77 
78 /*
79  * In-kernel mount arguments
80  */
81 struct nfs_parsed_mount_data {
82 	int			flags;
83 	unsigned int		rsize, wsize;
84 	unsigned int		timeo, retrans;
85 	unsigned int		acregmin, acregmax,
86 				acdirmin, acdirmax;
87 	unsigned int		namlen;
88 	unsigned int		options;
89 	unsigned int		bsize;
90 	struct nfs_auth_info	auth_info;
91 	rpc_authflavor_t	selected_flavor;
92 	char			*client_address;
93 	unsigned int		version;
94 	unsigned int		minorversion;
95 	char			*fscache_uniq;
96 	bool			need_mount;
97 
98 	struct {
99 		struct sockaddr_storage	address;
100 		size_t			addrlen;
101 		char			*hostname;
102 		u32			version;
103 		int			port;
104 		unsigned short		protocol;
105 	} mount_server;
106 
107 	struct {
108 		struct sockaddr_storage	address;
109 		size_t			addrlen;
110 		char			*hostname;
111 		char			*export_path;
112 		int			port;
113 		unsigned short		protocol;
114 	} nfs_server;
115 
116 	struct security_mnt_opts lsm_opts;
117 	struct net		*net;
118 };
119 
120 /* mount_clnt.c */
121 struct nfs_mount_request {
122 	struct sockaddr		*sap;
123 	size_t			salen;
124 	char			*hostname;
125 	char			*dirpath;
126 	u32			version;
127 	unsigned short		protocol;
128 	struct nfs_fh		*fh;
129 	int			noresvport;
130 	unsigned int		*auth_flav_len;
131 	rpc_authflavor_t	*auth_flavs;
132 	struct net		*net;
133 };
134 
135 struct nfs_mount_info {
136 	void (*fill_super)(struct super_block *, struct nfs_mount_info *);
137 	int (*set_security)(struct super_block *, struct dentry *, struct nfs_mount_info *);
138 	struct nfs_parsed_mount_data *parsed;
139 	struct nfs_clone_mount *cloned;
140 	struct nfs_fh *mntfh;
141 };
142 
143 extern int nfs_mount(struct nfs_mount_request *info);
144 extern void nfs_umount(const struct nfs_mount_request *info);
145 
146 /* client.c */
147 extern const struct rpc_program nfs_program;
148 extern void nfs_clients_init(struct net *net);
149 extern struct nfs_client *nfs_alloc_client(const struct nfs_client_initdata *);
150 int nfs_create_rpc_client(struct nfs_client *, const struct rpc_timeout *, rpc_authflavor_t);
151 struct nfs_client *nfs_get_client(const struct nfs_client_initdata *,
152 				  const struct rpc_timeout *, const char *,
153 				  rpc_authflavor_t);
154 int nfs_probe_fsinfo(struct nfs_server *server, struct nfs_fh *, struct nfs_fattr *);
155 void nfs_server_insert_lists(struct nfs_server *);
156 void nfs_server_remove_lists(struct nfs_server *);
157 void nfs_init_timeout_values(struct rpc_timeout *, int, unsigned int, unsigned int);
158 int nfs_init_server_rpcclient(struct nfs_server *, const struct rpc_timeout *t,
159 		rpc_authflavor_t);
160 struct nfs_server *nfs_alloc_server(void);
161 void nfs_server_copy_userdata(struct nfs_server *, struct nfs_server *);
162 
163 extern void nfs_cleanup_cb_ident_idr(struct net *);
164 extern void nfs_put_client(struct nfs_client *);
165 extern void nfs_free_client(struct nfs_client *);
166 extern struct nfs_client *nfs4_find_client_ident(struct net *, int);
167 extern struct nfs_client *
168 nfs4_find_client_sessionid(struct net *, const struct sockaddr *,
169 				struct nfs4_sessionid *, u32);
170 extern struct nfs_server *nfs_create_server(struct nfs_mount_info *,
171 					struct nfs_subversion *);
172 extern struct nfs_server *nfs4_create_server(
173 					struct nfs_mount_info *,
174 					struct nfs_subversion *);
175 extern struct nfs_server *nfs4_create_referral_server(struct nfs_clone_mount *,
176 						      struct nfs_fh *);
177 extern int nfs4_update_server(struct nfs_server *server, const char *hostname,
178 					struct sockaddr *sap, size_t salen,
179 					struct net *net);
180 extern void nfs_free_server(struct nfs_server *server);
181 extern struct nfs_server *nfs_clone_server(struct nfs_server *,
182 					   struct nfs_fh *,
183 					   struct nfs_fattr *,
184 					   rpc_authflavor_t);
185 extern int nfs_wait_client_init_complete(const struct nfs_client *clp);
186 extern void nfs_mark_client_ready(struct nfs_client *clp, int state);
187 extern struct nfs_client *nfs4_set_ds_client(struct nfs_client* mds_clp,
188 					     const struct sockaddr *ds_addr,
189 					     int ds_addrlen, int ds_proto,
190 					     unsigned int ds_timeo,
191 					     unsigned int ds_retrans,
192 					     u32 minor_version,
193 					     rpc_authflavor_t au_flavor);
194 extern struct rpc_clnt *nfs4_find_or_create_ds_client(struct nfs_client *,
195 						struct inode *);
196 extern struct nfs_client *nfs3_set_ds_client(struct nfs_client *mds_clp,
197 			const struct sockaddr *ds_addr, int ds_addrlen,
198 			int ds_proto, unsigned int ds_timeo,
199 			unsigned int ds_retrans, rpc_authflavor_t au_flavor);
200 #ifdef CONFIG_PROC_FS
201 extern int __init nfs_fs_proc_init(void);
202 extern void nfs_fs_proc_exit(void);
203 extern int nfs_fs_proc_net_init(struct net *net);
204 extern void nfs_fs_proc_net_exit(struct net *net);
205 #else
206 static inline int nfs_fs_proc_net_init(struct net *net)
207 {
208 	return 0;
209 }
210 static inline void nfs_fs_proc_net_exit(struct net *net)
211 {
212 }
213 static inline int nfs_fs_proc_init(void)
214 {
215 	return 0;
216 }
217 static inline void nfs_fs_proc_exit(void)
218 {
219 }
220 #endif
221 
222 /* callback_xdr.c */
223 extern struct svc_version nfs4_callback_version1;
224 extern struct svc_version nfs4_callback_version4;
225 
226 struct nfs_pageio_descriptor;
227 /* pagelist.c */
228 extern int __init nfs_init_nfspagecache(void);
229 extern void nfs_destroy_nfspagecache(void);
230 extern int __init nfs_init_readpagecache(void);
231 extern void nfs_destroy_readpagecache(void);
232 extern int __init nfs_init_writepagecache(void);
233 extern void nfs_destroy_writepagecache(void);
234 
235 extern int __init nfs_init_directcache(void);
236 extern void nfs_destroy_directcache(void);
237 extern void nfs_pgheader_init(struct nfs_pageio_descriptor *desc,
238 			      struct nfs_pgio_header *hdr,
239 			      void (*release)(struct nfs_pgio_header *hdr));
240 void nfs_set_pgio_error(struct nfs_pgio_header *hdr, int error, loff_t pos);
241 int nfs_iocounter_wait(struct nfs_lock_context *l_ctx);
242 
243 extern const struct nfs_pageio_ops nfs_pgio_rw_ops;
244 struct nfs_pgio_header *nfs_pgio_header_alloc(const struct nfs_rw_ops *);
245 void nfs_pgio_header_free(struct nfs_pgio_header *);
246 void nfs_pgio_data_destroy(struct nfs_pgio_header *);
247 int nfs_generic_pgio(struct nfs_pageio_descriptor *, struct nfs_pgio_header *);
248 int nfs_initiate_pgio(struct rpc_clnt *clnt, struct nfs_pgio_header *hdr,
249 		      struct rpc_cred *cred, const struct nfs_rpc_ops *rpc_ops,
250 		      const struct rpc_call_ops *call_ops, int how, int flags);
251 void nfs_free_request(struct nfs_page *req);
252 struct nfs_pgio_mirror *
253 nfs_pgio_current_mirror(struct nfs_pageio_descriptor *desc);
254 
255 static inline bool nfs_pgio_has_mirroring(struct nfs_pageio_descriptor *desc)
256 {
257 	WARN_ON_ONCE(desc->pg_mirror_count < 1);
258 	return desc->pg_mirror_count > 1;
259 }
260 
261 static inline bool nfs_match_open_context(const struct nfs_open_context *ctx1,
262 		const struct nfs_open_context *ctx2)
263 {
264 	return ctx1->cred == ctx2->cred && ctx1->state == ctx2->state;
265 }
266 
267 /* nfs2xdr.c */
268 extern struct rpc_procinfo nfs_procedures[];
269 extern int nfs2_decode_dirent(struct xdr_stream *,
270 				struct nfs_entry *, int);
271 
272 /* nfs3xdr.c */
273 extern struct rpc_procinfo nfs3_procedures[];
274 extern int nfs3_decode_dirent(struct xdr_stream *,
275 				struct nfs_entry *, int);
276 
277 /* nfs4xdr.c */
278 #if IS_ENABLED(CONFIG_NFS_V4)
279 extern int nfs4_decode_dirent(struct xdr_stream *,
280 				struct nfs_entry *, int);
281 #endif
282 #ifdef CONFIG_NFS_V4_1
283 extern const u32 nfs41_maxread_overhead;
284 extern const u32 nfs41_maxwrite_overhead;
285 extern const u32 nfs41_maxgetdevinfo_overhead;
286 #endif
287 
288 /* nfs4proc.c */
289 #if IS_ENABLED(CONFIG_NFS_V4)
290 extern struct rpc_procinfo nfs4_procedures[];
291 #endif
292 
293 #ifdef CONFIG_NFS_V4_SECURITY_LABEL
294 extern struct nfs4_label *nfs4_label_alloc(struct nfs_server *server, gfp_t flags);
295 static inline struct nfs4_label *
296 nfs4_label_copy(struct nfs4_label *dst, struct nfs4_label *src)
297 {
298 	if (!dst || !src)
299 		return NULL;
300 
301 	if (src->len > NFS4_MAXLABELLEN)
302 		return NULL;
303 
304 	dst->lfs = src->lfs;
305 	dst->pi = src->pi;
306 	dst->len = src->len;
307 	memcpy(dst->label, src->label, src->len);
308 
309 	return dst;
310 }
311 static inline void nfs4_label_free(struct nfs4_label *label)
312 {
313 	if (label) {
314 		kfree(label->label);
315 		kfree(label);
316 	}
317 	return;
318 }
319 
320 static inline void nfs_zap_label_cache_locked(struct nfs_inode *nfsi)
321 {
322 	if (nfs_server_capable(&nfsi->vfs_inode, NFS_CAP_SECURITY_LABEL))
323 		nfsi->cache_validity |= NFS_INO_INVALID_LABEL;
324 }
325 #else
326 static inline struct nfs4_label *nfs4_label_alloc(struct nfs_server *server, gfp_t flags) { return NULL; }
327 static inline void nfs4_label_free(void *label) {}
328 static inline void nfs_zap_label_cache_locked(struct nfs_inode *nfsi)
329 {
330 }
331 static inline struct nfs4_label *
332 nfs4_label_copy(struct nfs4_label *dst, struct nfs4_label *src)
333 {
334 	return NULL;
335 }
336 #endif /* CONFIG_NFS_V4_SECURITY_LABEL */
337 
338 /* proc.c */
339 void nfs_close_context(struct nfs_open_context *ctx, int is_sync);
340 extern struct nfs_client *nfs_init_client(struct nfs_client *clp,
341 			   const struct rpc_timeout *timeparms,
342 			   const char *ip_addr);
343 
344 /* dir.c */
345 extern void nfs_force_use_readdirplus(struct inode *dir);
346 extern unsigned long nfs_access_cache_count(struct shrinker *shrink,
347 					    struct shrink_control *sc);
348 extern unsigned long nfs_access_cache_scan(struct shrinker *shrink,
349 					   struct shrink_control *sc);
350 struct dentry *nfs_lookup(struct inode *, struct dentry *, unsigned int);
351 int nfs_create(struct inode *, struct dentry *, umode_t, bool);
352 int nfs_mkdir(struct inode *, struct dentry *, umode_t);
353 int nfs_rmdir(struct inode *, struct dentry *);
354 int nfs_unlink(struct inode *, struct dentry *);
355 int nfs_symlink(struct inode *, struct dentry *, const char *);
356 int nfs_link(struct dentry *, struct inode *, struct dentry *);
357 int nfs_mknod(struct inode *, struct dentry *, umode_t, dev_t);
358 int nfs_rename(struct inode *, struct dentry *, struct inode *, struct dentry *);
359 
360 /* file.c */
361 int nfs_file_fsync(struct file *file, loff_t start, loff_t end, int datasync);
362 loff_t nfs_file_llseek(struct file *, loff_t, int);
363 ssize_t nfs_file_read(struct kiocb *, struct iov_iter *);
364 ssize_t nfs_file_splice_read(struct file *, loff_t *, struct pipe_inode_info *,
365 			     size_t, unsigned int);
366 int nfs_file_mmap(struct file *, struct vm_area_struct *);
367 ssize_t nfs_file_write(struct kiocb *, struct iov_iter *);
368 int nfs_file_release(struct inode *, struct file *);
369 int nfs_lock(struct file *, int, struct file_lock *);
370 int nfs_flock(struct file *, int, struct file_lock *);
371 int nfs_check_flags(int);
372 
373 /* inode.c */
374 extern struct workqueue_struct *nfsiod_workqueue;
375 extern struct inode *nfs_alloc_inode(struct super_block *sb);
376 extern void nfs_destroy_inode(struct inode *);
377 extern int nfs_write_inode(struct inode *, struct writeback_control *);
378 extern int nfs_drop_inode(struct inode *);
379 extern void nfs_clear_inode(struct inode *);
380 extern void nfs_evict_inode(struct inode *);
381 void nfs_zap_acl_cache(struct inode *inode);
382 extern int nfs_wait_bit_killable(struct wait_bit_key *key, int mode);
383 extern int nfs_wait_atomic_killable(atomic_t *p);
384 
385 /* super.c */
386 extern const struct super_operations nfs_sops;
387 extern struct file_system_type nfs_fs_type;
388 extern struct file_system_type nfs_xdev_fs_type;
389 #if IS_ENABLED(CONFIG_NFS_V4)
390 extern struct file_system_type nfs4_xdev_fs_type;
391 extern struct file_system_type nfs4_referral_fs_type;
392 #endif
393 bool nfs_auth_info_match(const struct nfs_auth_info *, rpc_authflavor_t);
394 struct dentry *nfs_try_mount(int, const char *, struct nfs_mount_info *,
395 			struct nfs_subversion *);
396 void nfs_initialise_sb(struct super_block *);
397 int nfs_set_sb_security(struct super_block *, struct dentry *, struct nfs_mount_info *);
398 int nfs_clone_sb_security(struct super_block *, struct dentry *, struct nfs_mount_info *);
399 struct dentry *nfs_fs_mount_common(struct nfs_server *, int, const char *,
400 				   struct nfs_mount_info *, struct nfs_subversion *);
401 struct dentry *nfs_fs_mount(struct file_system_type *, int, const char *, void *);
402 struct dentry * nfs_xdev_mount_common(struct file_system_type *, int,
403 		const char *, struct nfs_mount_info *);
404 void nfs_kill_super(struct super_block *);
405 void nfs_fill_super(struct super_block *, struct nfs_mount_info *);
406 
407 extern struct rpc_stat nfs_rpcstat;
408 
409 extern int __init register_nfs_fs(void);
410 extern void __exit unregister_nfs_fs(void);
411 extern bool nfs_sb_active(struct super_block *sb);
412 extern void nfs_sb_deactive(struct super_block *sb);
413 
414 /* namespace.c */
415 #define NFS_PATH_CANONICAL 1
416 extern char *nfs_path(char **p, struct dentry *dentry,
417 		      char *buffer, ssize_t buflen, unsigned flags);
418 extern struct vfsmount *nfs_d_automount(struct path *path);
419 struct vfsmount *nfs_submount(struct nfs_server *, struct dentry *,
420 			      struct nfs_fh *, struct nfs_fattr *);
421 struct vfsmount *nfs_do_submount(struct dentry *, struct nfs_fh *,
422 				 struct nfs_fattr *, rpc_authflavor_t);
423 
424 /* getroot.c */
425 extern struct dentry *nfs_get_root(struct super_block *, struct nfs_fh *,
426 				   const char *);
427 #if IS_ENABLED(CONFIG_NFS_V4)
428 extern struct dentry *nfs4_get_root(struct super_block *, struct nfs_fh *,
429 				    const char *);
430 
431 extern int nfs4_get_rootfh(struct nfs_server *server, struct nfs_fh *mntfh, bool);
432 #endif
433 
434 struct nfs_pgio_completion_ops;
435 /* read.c */
436 extern void nfs_pageio_init_read(struct nfs_pageio_descriptor *pgio,
437 			struct inode *inode, bool force_mds,
438 			const struct nfs_pgio_completion_ops *compl_ops);
439 extern void nfs_read_prepare(struct rpc_task *task, void *calldata);
440 extern void nfs_pageio_reset_read_mds(struct nfs_pageio_descriptor *pgio);
441 
442 /* super.c */
443 void nfs_clone_super(struct super_block *, struct nfs_mount_info *);
444 void nfs_umount_begin(struct super_block *);
445 int  nfs_statfs(struct dentry *, struct kstatfs *);
446 int  nfs_show_options(struct seq_file *, struct dentry *);
447 int  nfs_show_devname(struct seq_file *, struct dentry *);
448 int  nfs_show_path(struct seq_file *, struct dentry *);
449 int  nfs_show_stats(struct seq_file *, struct dentry *);
450 int nfs_remount(struct super_block *sb, int *flags, char *raw_data);
451 
452 /* write.c */
453 extern void nfs_pageio_init_write(struct nfs_pageio_descriptor *pgio,
454 			struct inode *inode, int ioflags, bool force_mds,
455 			const struct nfs_pgio_completion_ops *compl_ops);
456 extern void nfs_pageio_reset_write_mds(struct nfs_pageio_descriptor *pgio);
457 extern void nfs_commit_free(struct nfs_commit_data *p);
458 extern void nfs_write_prepare(struct rpc_task *task, void *calldata);
459 extern void nfs_commit_prepare(struct rpc_task *task, void *calldata);
460 extern int nfs_initiate_commit(struct rpc_clnt *clnt,
461 			       struct nfs_commit_data *data,
462 			       const struct nfs_rpc_ops *nfs_ops,
463 			       const struct rpc_call_ops *call_ops,
464 			       int how, int flags);
465 extern void nfs_init_commit(struct nfs_commit_data *data,
466 			    struct list_head *head,
467 			    struct pnfs_layout_segment *lseg,
468 			    struct nfs_commit_info *cinfo);
469 int nfs_scan_commit_list(struct list_head *src, struct list_head *dst,
470 			 struct nfs_commit_info *cinfo, int max);
471 unsigned long nfs_reqs_to_commit(struct nfs_commit_info *);
472 int nfs_scan_commit(struct inode *inode, struct list_head *dst,
473 		    struct nfs_commit_info *cinfo);
474 void nfs_mark_request_commit(struct nfs_page *req,
475 			     struct pnfs_layout_segment *lseg,
476 			     struct nfs_commit_info *cinfo,
477 			     u32 ds_commit_idx);
478 int nfs_write_need_commit(struct nfs_pgio_header *);
479 void nfs_writeback_update_inode(struct nfs_pgio_header *hdr);
480 int nfs_commit_file(struct file *file, struct nfs_write_verifier *verf);
481 int nfs_generic_commit_list(struct inode *inode, struct list_head *head,
482 			    int how, struct nfs_commit_info *cinfo);
483 void nfs_retry_commit(struct list_head *page_list,
484 		      struct pnfs_layout_segment *lseg,
485 		      struct nfs_commit_info *cinfo,
486 		      u32 ds_commit_idx);
487 void nfs_commitdata_release(struct nfs_commit_data *data);
488 void nfs_request_add_commit_list(struct nfs_page *req,
489 				 struct nfs_commit_info *cinfo);
490 void nfs_request_add_commit_list_locked(struct nfs_page *req,
491 		struct list_head *dst,
492 		struct nfs_commit_info *cinfo);
493 void nfs_request_remove_commit_list(struct nfs_page *req,
494 				    struct nfs_commit_info *cinfo);
495 void nfs_init_cinfo(struct nfs_commit_info *cinfo,
496 		    struct inode *inode,
497 		    struct nfs_direct_req *dreq);
498 int nfs_key_timeout_notify(struct file *filp, struct inode *inode);
499 bool nfs_ctx_key_to_expire(struct nfs_open_context *ctx);
500 void nfs_pageio_stop_mirroring(struct nfs_pageio_descriptor *pgio);
501 
502 #ifdef CONFIG_MIGRATION
503 extern int nfs_migrate_page(struct address_space *,
504 		struct page *, struct page *, enum migrate_mode);
505 #else
506 #define nfs_migrate_page NULL
507 #endif
508 
509 /* unlink.c */
510 extern struct rpc_task *
511 nfs_async_rename(struct inode *old_dir, struct inode *new_dir,
512 		 struct dentry *old_dentry, struct dentry *new_dentry,
513 		 void (*complete)(struct rpc_task *, struct nfs_renamedata *));
514 extern int nfs_sillyrename(struct inode *dir, struct dentry *dentry);
515 
516 /* direct.c */
517 void nfs_init_cinfo_from_dreq(struct nfs_commit_info *cinfo,
518 			      struct nfs_direct_req *dreq);
519 extern ssize_t nfs_dreq_bytes_left(struct nfs_direct_req *dreq);
520 
521 /* nfs4proc.c */
522 extern void __nfs4_read_done_cb(struct nfs_pgio_header *);
523 extern struct nfs_client *nfs4_init_client(struct nfs_client *clp,
524 			    const struct rpc_timeout *timeparms,
525 			    const char *ip_addr);
526 extern int nfs40_walk_client_list(struct nfs_client *clp,
527 				struct nfs_client **result,
528 				struct rpc_cred *cred);
529 extern int nfs41_walk_client_list(struct nfs_client *clp,
530 				struct nfs_client **result,
531 				struct rpc_cred *cred);
532 
533 static inline struct inode *nfs_igrab_and_active(struct inode *inode)
534 {
535 	inode = igrab(inode);
536 	if (inode != NULL && !nfs_sb_active(inode->i_sb)) {
537 		iput(inode);
538 		inode = NULL;
539 	}
540 	return inode;
541 }
542 
543 static inline void nfs_iput_and_deactive(struct inode *inode)
544 {
545 	if (inode != NULL) {
546 		struct super_block *sb = inode->i_sb;
547 
548 		iput(inode);
549 		nfs_sb_deactive(sb);
550 	}
551 }
552 
553 /*
554  * Determine the device name as a string
555  */
556 static inline char *nfs_devname(struct dentry *dentry,
557 				char *buffer, ssize_t buflen)
558 {
559 	char *dummy;
560 	return nfs_path(&dummy, dentry, buffer, buflen, NFS_PATH_CANONICAL);
561 }
562 
563 /*
564  * Determine the actual block size (and log2 thereof)
565  */
566 static inline
567 unsigned long nfs_block_bits(unsigned long bsize, unsigned char *nrbitsp)
568 {
569 	/* make sure blocksize is a power of two */
570 	if ((bsize & (bsize - 1)) || nrbitsp) {
571 		unsigned char	nrbits;
572 
573 		for (nrbits = 31; nrbits && !(bsize & (1 << nrbits)); nrbits--)
574 			;
575 		bsize = 1 << nrbits;
576 		if (nrbitsp)
577 			*nrbitsp = nrbits;
578 	}
579 
580 	return bsize;
581 }
582 
583 /*
584  * Calculate the number of 512byte blocks used.
585  */
586 static inline blkcnt_t nfs_calc_block_size(u64 tsize)
587 {
588 	blkcnt_t used = (tsize + 511) >> 9;
589 	return (used > ULONG_MAX) ? ULONG_MAX : used;
590 }
591 
592 /*
593  * Compute and set NFS server blocksize
594  */
595 static inline
596 unsigned long nfs_block_size(unsigned long bsize, unsigned char *nrbitsp)
597 {
598 	if (bsize < NFS_MIN_FILE_IO_SIZE)
599 		bsize = NFS_DEF_FILE_IO_SIZE;
600 	else if (bsize >= NFS_MAX_FILE_IO_SIZE)
601 		bsize = NFS_MAX_FILE_IO_SIZE;
602 
603 	return nfs_block_bits(bsize, nrbitsp);
604 }
605 
606 /*
607  * Determine the maximum file size for a superblock
608  */
609 static inline
610 void nfs_super_set_maxbytes(struct super_block *sb, __u64 maxfilesize)
611 {
612 	sb->s_maxbytes = (loff_t)maxfilesize;
613 	if (sb->s_maxbytes > MAX_LFS_FILESIZE || sb->s_maxbytes <= 0)
614 		sb->s_maxbytes = MAX_LFS_FILESIZE;
615 }
616 
617 /*
618  * Record the page as unstable and mark its inode as dirty.
619  */
620 static inline
621 void nfs_mark_page_unstable(struct page *page, struct nfs_commit_info *cinfo)
622 {
623 	if (!cinfo->dreq) {
624 		struct inode *inode = page_file_mapping(page)->host;
625 
626 		inc_zone_page_state(page, NR_UNSTABLE_NFS);
627 		inc_wb_stat(&inode_to_bdi(inode)->wb, WB_RECLAIMABLE);
628 		__mark_inode_dirty(inode, I_DIRTY_DATASYNC);
629 	}
630 }
631 
632 /*
633  * Determine the number of bytes of data the page contains
634  */
635 static inline
636 unsigned int nfs_page_length(struct page *page)
637 {
638 	loff_t i_size = i_size_read(page_file_mapping(page)->host);
639 
640 	if (i_size > 0) {
641 		pgoff_t page_index = page_file_index(page);
642 		pgoff_t end_index = (i_size - 1) >> PAGE_SHIFT;
643 		if (page_index < end_index)
644 			return PAGE_SIZE;
645 		if (page_index == end_index)
646 			return ((i_size - 1) & ~PAGE_MASK) + 1;
647 	}
648 	return 0;
649 }
650 
651 /*
652  * Convert a umode to a dirent->d_type
653  */
654 static inline
655 unsigned char nfs_umode_to_dtype(umode_t mode)
656 {
657 	return (mode >> 12) & 15;
658 }
659 
660 /*
661  * Determine the number of pages in an array of length 'len' and
662  * with a base offset of 'base'
663  */
664 static inline
665 unsigned int nfs_page_array_len(unsigned int base, size_t len)
666 {
667 	return ((unsigned long)len + (unsigned long)base +
668 		PAGE_SIZE - 1) >> PAGE_SHIFT;
669 }
670 
671 /*
672  * Convert a struct timespec into a 64-bit change attribute
673  *
674  * This does approximately the same thing as timespec_to_ns(),
675  * but for calculation efficiency, we multiply the seconds by
676  * 1024*1024*1024.
677  */
678 static inline
679 u64 nfs_timespec_to_change_attr(const struct timespec *ts)
680 {
681 	return ((u64)ts->tv_sec << 30) + ts->tv_nsec;
682 }
683 
684 #ifdef CONFIG_CRC32
685 /**
686  * nfs_fhandle_hash - calculate the crc32 hash for the filehandle
687  * @fh - pointer to filehandle
688  *
689  * returns a crc32 hash for the filehandle that is compatible with
690  * the one displayed by "wireshark".
691  */
692 static inline u32 nfs_fhandle_hash(const struct nfs_fh *fh)
693 {
694 	return ~crc32_le(0xFFFFFFFF, &fh->data[0], fh->size);
695 }
696 static inline u32 nfs_stateid_hash(const nfs4_stateid *stateid)
697 {
698 	return ~crc32_le(0xFFFFFFFF, &stateid->other[0],
699 				NFS4_STATEID_OTHER_SIZE);
700 }
701 #else
702 static inline u32 nfs_fhandle_hash(const struct nfs_fh *fh)
703 {
704 	return 0;
705 }
706 static inline u32 nfs_stateid_hash(nfs4_stateid *stateid)
707 {
708 	return 0;
709 }
710 #endif
711 
712 static inline bool nfs_error_is_fatal(int err)
713 {
714 	switch (err) {
715 	case -ERESTARTSYS:
716 	case -EIO:
717 	case -ENOSPC:
718 	case -EROFS:
719 	case -E2BIG:
720 		return true;
721 	default:
722 		return false;
723 	}
724 }
725