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