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