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