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