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