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