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