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