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