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