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