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