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