1/* SPDX-License-Identifier: GPL-2.0 */
2/*
3 * NFS internal definitions
4 */
5
6#include "nfs4_fs.h"
7#include <linux/fs_context.h>
8#include <linux/security.h>
9#include <linux/compiler_attributes.h>
10#include <linux/crc32.h>
11#include <linux/sunrpc/addr.h>
12#include <linux/nfs_page.h>
13#include <linux/nfslocalio.h>
14#include <linux/wait_bit.h>
15
16#define NFS_SB_MASK (SB_NOSUID|SB_NODEV|SB_NOEXEC|SB_SYNCHRONOUS)
17
18extern const struct export_operations nfs_export_ops;
19
20struct nfs_string;
21struct nfs_pageio_descriptor;
22
23static inline void nfs_attr_check_mountpoint(struct super_block *parent, struct nfs_fattr *fattr)
24{
25 if (!nfs_fsid_equal(a: &NFS_SB(s: parent)->fsid, b: &fattr->fsid))
26 fattr->valid |= NFS_ATTR_FATTR_MOUNTPOINT;
27}
28
29static inline int nfs_attr_use_mounted_on_fileid(struct nfs_fattr *fattr)
30{
31 if (((fattr->valid & NFS_ATTR_FATTR_MOUNTED_ON_FILEID) == 0) ||
32 (((fattr->valid & NFS_ATTR_FATTR_MOUNTPOINT) == 0) &&
33 ((fattr->valid & NFS_ATTR_FATTR_V4_REFERRAL) == 0)))
34 return 0;
35 return 1;
36}
37
38static inline bool nfs_lookup_is_soft_revalidate(const struct dentry *dentry)
39{
40 if (!(NFS_SB(s: dentry->d_sb)->flags & NFS_MOUNT_SOFTREVAL))
41 return false;
42 if (!d_is_positive(dentry) || !NFS_FH(inode: d_inode(dentry))->size)
43 return false;
44 return true;
45}
46
47static inline fmode_t flags_to_mode(int flags)
48{
49 fmode_t res = (__force fmode_t)flags & FMODE_EXEC;
50 if ((flags & O_ACCMODE) != O_WRONLY)
51 res |= FMODE_READ;
52 if ((flags & O_ACCMODE) != O_RDONLY)
53 res |= FMODE_WRITE;
54 return res;
55}
56
57/*
58 * Note: RFC 1813 doesn't limit the number of auth flavors that
59 * a server can return, so make something up.
60 */
61#define NFS_MAX_SECFLAVORS (12)
62
63/*
64 * Value used if the user did not specify a port value.
65 */
66#define NFS_UNSPEC_PORT (-1)
67
68#define NFS_UNSPEC_RETRANS (UINT_MAX)
69#define NFS_UNSPEC_TIMEO (UINT_MAX)
70
71struct nfs_client_initdata {
72 unsigned long init_flags;
73 const char *hostname; /* Hostname of the server */
74 const struct sockaddr_storage *addr; /* Address of the server */
75 const char *nodename; /* Hostname of the client */
76 const char *ip_addr; /* IP address of the client */
77 size_t addrlen;
78 struct nfs_subversion *nfs_mod;
79 int proto;
80 u32 minorversion;
81 unsigned int nconnect;
82 unsigned int max_connect;
83 struct net *net;
84 const struct rpc_timeout *timeparms;
85 const struct cred *cred;
86 struct xprtsec_parms xprtsec;
87 unsigned long connect_timeout;
88 unsigned long reconnect_timeout;
89};
90
91/*
92 * In-kernel mount arguments
93 */
94struct nfs_fs_context {
95 bool internal;
96 bool skip_reconfig_option_check;
97 bool need_mount;
98 bool sloppy;
99 unsigned int flags; /* NFS{,4}_MOUNT_* flags */
100 unsigned int rsize, wsize;
101 unsigned int timeo, retrans;
102 unsigned int acregmin, acregmax;
103 unsigned int acdirmin, acdirmax;
104 unsigned int namlen;
105 unsigned int options;
106 unsigned int bsize;
107 struct nfs_auth_info auth_info;
108 rpc_authflavor_t selected_flavor;
109 struct xprtsec_parms xprtsec;
110 char *client_address;
111 unsigned int version;
112 unsigned int minorversion;
113 char *fscache_uniq;
114 unsigned short protofamily;
115 unsigned short mountfamily;
116 bool has_sec_mnt_opts;
117 int lock_status;
118
119 struct {
120 union {
121 struct sockaddr address;
122 struct sockaddr_storage _address;
123 };
124 size_t addrlen;
125 char *hostname;
126 u32 version;
127 int port;
128 unsigned short protocol;
129 } mount_server;
130
131 struct {
132 union {
133 struct sockaddr address;
134 struct sockaddr_storage _address;
135 };
136 size_t addrlen;
137 char *hostname;
138 char *export_path;
139 int port;
140 unsigned short protocol;
141 unsigned short nconnect;
142 unsigned short max_connect;
143 unsigned short export_path_len;
144 } nfs_server;
145
146 struct nfs_fh *mntfh;
147 struct nfs_server *server;
148 struct nfs_subversion *nfs_mod;
149
150 /* Information for a cloned mount. */
151 struct nfs_clone_mount {
152 struct super_block *sb;
153 struct dentry *dentry;
154 struct nfs_fattr *fattr;
155 unsigned int inherited_bsize;
156 } clone_data;
157};
158
159enum nfs_lock_status {
160 NFS_LOCK_NOT_SET = 0,
161 NFS_LOCK_LOCK = 1,
162 NFS_LOCK_NOLOCK = 2,
163};
164
165#define nfs_errorf(fc, fmt, ...) ((fc)->log.log ? \
166 errorf(fc, fmt, ## __VA_ARGS__) : \
167 ({ dprintk(fmt "\n", ## __VA_ARGS__); }))
168
169#define nfs_ferrorf(fc, fac, fmt, ...) ((fc)->log.log ? \
170 errorf(fc, fmt, ## __VA_ARGS__) : \
171 ({ dfprintk(fac, fmt "\n", ## __VA_ARGS__); }))
172
173#define nfs_invalf(fc, fmt, ...) ((fc)->log.log ? \
174 invalf(fc, fmt, ## __VA_ARGS__) : \
175 ({ dprintk(fmt "\n", ## __VA_ARGS__); -EINVAL; }))
176
177#define nfs_finvalf(fc, fac, fmt, ...) ((fc)->log.log ? \
178 invalf(fc, fmt, ## __VA_ARGS__) : \
179 ({ dfprintk(fac, fmt "\n", ## __VA_ARGS__); -EINVAL; }))
180
181#define nfs_warnf(fc, fmt, ...) ((fc)->log.log ? \
182 warnf(fc, fmt, ## __VA_ARGS__) : \
183 ({ dprintk(fmt "\n", ## __VA_ARGS__); }))
184
185#define nfs_fwarnf(fc, fac, fmt, ...) ((fc)->log.log ? \
186 warnf(fc, fmt, ## __VA_ARGS__) : \
187 ({ dfprintk(fac, fmt "\n", ## __VA_ARGS__); }))
188
189static inline struct nfs_fs_context *nfs_fc2context(const struct fs_context *fc)
190{
191 return fc->fs_private;
192}
193
194/* mount_clnt.c */
195struct nfs_mount_request {
196 struct sockaddr_storage *sap;
197 size_t salen;
198 char *hostname;
199 char *dirpath;
200 u32 version;
201 unsigned short protocol;
202 struct nfs_fh *fh;
203 int noresvport;
204 unsigned int *auth_flav_len;
205 rpc_authflavor_t *auth_flavs;
206 struct net *net;
207};
208
209extern int nfs_mount(struct nfs_mount_request *info, int timeo, int retrans);
210extern void nfs_umount(const struct nfs_mount_request *info);
211
212/* client.c */
213extern const struct rpc_program nfs_program;
214extern void nfs_clients_init(struct net *net);
215extern void nfs_clients_exit(struct net *net);
216extern struct nfs_client *nfs_alloc_client(const struct nfs_client_initdata *);
217int nfs_create_rpc_client(struct nfs_client *, const struct nfs_client_initdata *, rpc_authflavor_t);
218struct nfs_client *nfs_get_client(const struct nfs_client_initdata *);
219int nfs_probe_server(struct nfs_server *, struct nfs_fh *);
220void nfs_server_insert_lists(struct nfs_server *);
221void nfs_server_remove_lists(struct nfs_server *);
222void nfs_init_timeout_values(struct rpc_timeout *to, int proto, int timeo, int retrans);
223int nfs_init_server_rpcclient(struct nfs_server *, const struct rpc_timeout *t,
224 rpc_authflavor_t);
225struct nfs_server *nfs_alloc_server(void);
226void nfs_server_copy_userdata(struct nfs_server *, struct nfs_server *);
227
228extern void nfs_put_client(struct nfs_client *);
229extern void nfs_free_client(struct nfs_client *);
230extern struct nfs_client *nfs4_find_client_ident(struct net *, int);
231extern struct nfs_client *
232nfs4_find_client_sessionid(struct net *, const struct sockaddr *,
233 struct nfs4_sessionid *, u32);
234extern struct nfs_server *nfs_create_server(struct fs_context *);
235extern void nfs4_server_set_init_caps(struct nfs_server *);
236extern struct nfs_server *nfs4_create_server(struct fs_context *);
237extern struct nfs_server *nfs4_create_referral_server(struct fs_context *);
238extern int nfs4_update_server(struct nfs_server *server, const char *hostname,
239 struct sockaddr_storage *sap, size_t salen,
240 struct net *net);
241extern void nfs_free_server(struct nfs_server *server);
242extern struct nfs_server *nfs_clone_server(struct nfs_server *,
243 struct nfs_fh *,
244 struct nfs_fattr *,
245 rpc_authflavor_t);
246extern bool nfs_client_init_is_complete(const struct nfs_client *clp);
247extern int nfs_client_init_status(const struct nfs_client *clp);
248extern int nfs_wait_client_init_complete(const struct nfs_client *clp);
249extern void nfs_mark_client_ready(struct nfs_client *clp, int state);
250extern struct nfs_client *nfs4_set_ds_client(struct nfs_server *mds_srv,
251 const struct sockaddr_storage *ds_addr,
252 int ds_addrlen, int ds_proto,
253 unsigned int ds_timeo,
254 unsigned int ds_retrans,
255 u32 minor_version);
256extern struct rpc_clnt *nfs4_find_or_create_ds_client(struct nfs_client *,
257 struct inode *);
258extern struct nfs_client *nfs3_set_ds_client(struct nfs_server *mds_srv,
259 const struct sockaddr_storage *ds_addr, int ds_addrlen,
260 int ds_proto, unsigned int ds_timeo,
261 unsigned int ds_retrans);
262#ifdef CONFIG_PROC_FS
263extern int __init nfs_fs_proc_init(void);
264extern void nfs_fs_proc_exit(void);
265extern int nfs_fs_proc_net_init(struct net *net);
266extern void nfs_fs_proc_net_exit(struct net *net);
267#else
268static inline int nfs_fs_proc_net_init(struct net *net)
269{
270 return 0;
271}
272static inline void nfs_fs_proc_net_exit(struct net *net)
273{
274}
275static inline int nfs_fs_proc_init(void)
276{
277 return 0;
278}
279static inline void nfs_fs_proc_exit(void)
280{
281}
282#endif
283
284/* callback_xdr.c */
285extern const struct svc_version nfs4_callback_version1;
286extern const struct svc_version nfs4_callback_version4;
287
288/* fs_context.c */
289extern struct file_system_type nfs_fs_type;
290
291/* pagelist.c */
292extern int __init nfs_init_nfspagecache(void);
293extern void nfs_destroy_nfspagecache(void);
294extern int __init nfs_init_readpagecache(void);
295extern void nfs_destroy_readpagecache(void);
296extern int __init nfs_init_writepagecache(void);
297extern void nfs_destroy_writepagecache(void);
298
299extern int __init nfs_init_directcache(void);
300extern void nfs_destroy_directcache(void);
301extern void nfs_pgheader_init(struct nfs_pageio_descriptor *desc,
302 struct nfs_pgio_header *hdr,
303 void (*release)(struct nfs_pgio_header *hdr));
304void nfs_set_pgio_error(struct nfs_pgio_header *hdr, int error, loff_t pos);
305int nfs_iocounter_wait(struct nfs_lock_context *l_ctx);
306
307extern const struct nfs_pageio_ops nfs_pgio_rw_ops;
308struct nfs_pgio_header *nfs_pgio_header_alloc(const struct nfs_rw_ops *);
309void nfs_pgio_header_free(struct nfs_pgio_header *);
310int nfs_generic_pgio(struct nfs_pageio_descriptor *, struct nfs_pgio_header *);
311int nfs_initiate_pgio(struct rpc_clnt *clnt, struct nfs_pgio_header *hdr,
312 const struct cred *cred, const struct nfs_rpc_ops *rpc_ops,
313 const struct rpc_call_ops *call_ops, int how, int flags,
314 struct nfsd_file *localio);
315void nfs_free_request(struct nfs_page *req);
316struct nfs_pgio_mirror *
317nfs_pgio_current_mirror(struct nfs_pageio_descriptor *desc);
318
319static inline bool nfs_match_open_context(const struct nfs_open_context *ctx1,
320 const struct nfs_open_context *ctx2)
321{
322 return cred_fscmp(ctx1->cred, ctx2->cred) == 0 && ctx1->state == ctx2->state;
323}
324
325/* nfs2xdr.c */
326extern const struct rpc_procinfo nfs_procedures[];
327extern int nfs2_decode_dirent(struct xdr_stream *,
328 struct nfs_entry *, bool);
329
330/* nfs3xdr.c */
331extern const struct rpc_procinfo nfs3_procedures[];
332extern int nfs3_decode_dirent(struct xdr_stream *,
333 struct nfs_entry *, bool);
334
335/* nfs4xdr.c */
336#if IS_ENABLED(CONFIG_NFS_V4)
337extern int nfs4_decode_dirent(struct xdr_stream *,
338 struct nfs_entry *, bool);
339#endif
340#ifdef CONFIG_NFS_V4_1
341extern const u32 nfs41_maxread_overhead;
342extern const u32 nfs41_maxwrite_overhead;
343extern const u32 nfs41_maxgetdevinfo_overhead;
344#endif
345
346/* nfs4proc.c */
347#if IS_ENABLED(CONFIG_NFS_V4)
348extern const struct rpc_procinfo nfs4_procedures[];
349#endif
350
351#ifdef CONFIG_NFS_V4_SECURITY_LABEL
352extern struct nfs4_label *nfs4_label_alloc(struct nfs_server *server, gfp_t flags);
353static inline struct nfs4_label *
354nfs4_label_copy(struct nfs4_label *dst, struct nfs4_label *src)
355{
356 if (!dst || !src)
357 return NULL;
358
359 if (src->len > NFS4_MAXLABELLEN)
360 return NULL;
361
362 dst->lfs = src->lfs;
363 dst->pi = src->pi;
364 dst->len = src->len;
365 memcpy(dst->label, src->label, src->len);
366
367 return dst;
368}
369
370static inline void nfs_zap_label_cache_locked(struct nfs_inode *nfsi)
371{
372 if (nfs_server_capable(inode: &nfsi->vfs_inode, NFS_CAP_SECURITY_LABEL))
373 nfsi->cache_validity |= NFS_INO_INVALID_LABEL;
374}
375#else
376static inline struct nfs4_label *nfs4_label_alloc(struct nfs_server *server, gfp_t flags) { return NULL; }
377static inline void nfs_zap_label_cache_locked(struct nfs_inode *nfsi)
378{
379}
380static inline struct nfs4_label *
381nfs4_label_copy(struct nfs4_label *dst, struct nfs4_label *src)
382{
383 return NULL;
384}
385#endif /* CONFIG_NFS_V4_SECURITY_LABEL */
386
387/* proc.c */
388void nfs_close_context(struct nfs_open_context *ctx, int is_sync);
389extern struct nfs_client *nfs_init_client(struct nfs_client *clp,
390 const struct nfs_client_initdata *);
391
392/* dir.c */
393extern void nfs_readdir_record_entry_cache_hit(struct inode *dir);
394extern void nfs_readdir_record_entry_cache_miss(struct inode *dir);
395extern unsigned long nfs_access_cache_count(struct shrinker *shrink,
396 struct shrink_control *sc);
397extern unsigned long nfs_access_cache_scan(struct shrinker *shrink,
398 struct shrink_control *sc);
399struct dentry *nfs_lookup(struct inode *, struct dentry *, unsigned int);
400void nfs_d_prune_case_insensitive_aliases(struct inode *inode);
401int nfs_create(struct mnt_idmap *, struct inode *, struct dentry *,
402 umode_t, bool);
403struct dentry *nfs_mkdir(struct mnt_idmap *, struct inode *, struct dentry *,
404 umode_t);
405int nfs_rmdir(struct inode *, struct dentry *);
406int nfs_unlink(struct inode *, struct dentry *);
407int nfs_symlink(struct mnt_idmap *, struct inode *, struct dentry *,
408 const char *);
409int nfs_link(struct dentry *, struct inode *, struct dentry *);
410int nfs_mknod(struct mnt_idmap *, struct inode *, struct dentry *, umode_t,
411 dev_t);
412int nfs_rename(struct mnt_idmap *, struct inode *, struct dentry *,
413 struct inode *, struct dentry *, unsigned int);
414
415#ifdef CONFIG_NFS_V4_2
416static inline __u32 nfs_access_xattr_mask(const struct nfs_server *server)
417{
418 if (!(server->caps & NFS_CAP_XATTR))
419 return 0;
420 return NFS4_ACCESS_XAREAD | NFS4_ACCESS_XAWRITE | NFS4_ACCESS_XALIST;
421}
422#else
423static inline __u32 nfs_access_xattr_mask(const struct nfs_server *server)
424{
425 return 0;
426}
427#endif
428
429/* file.c */
430int nfs_file_fsync(struct file *file, loff_t start, loff_t end, int datasync);
431loff_t nfs_file_llseek(struct file *, loff_t, int);
432ssize_t nfs_file_read(struct kiocb *, struct iov_iter *);
433ssize_t nfs_file_splice_read(struct file *in, loff_t *ppos, struct pipe_inode_info *pipe,
434 size_t len, unsigned int flags);
435int nfs_file_mmap(struct file *, struct vm_area_struct *);
436ssize_t nfs_file_write(struct kiocb *, struct iov_iter *);
437int nfs_file_release(struct inode *, struct file *);
438int nfs_lock(struct file *, int, struct file_lock *);
439int nfs_flock(struct file *, int, struct file_lock *);
440int nfs_check_flags(int);
441
442/* inode.c */
443extern struct workqueue_struct *nfsiod_workqueue;
444extern struct workqueue_struct *nfslocaliod_workqueue;
445extern struct inode *nfs_alloc_inode(struct super_block *sb);
446extern void nfs_free_inode(struct inode *);
447extern int nfs_write_inode(struct inode *, struct writeback_control *);
448extern int nfs_drop_inode(struct inode *);
449extern void nfs_clear_inode(struct inode *);
450extern void nfs_evict_inode(struct inode *);
451extern void nfs_zap_acl_cache(struct inode *inode);
452extern void nfs_set_cache_invalid(struct inode *inode, unsigned long flags);
453extern bool nfs_check_cache_invalid(struct inode *, unsigned long);
454extern int nfs_wait_bit_killable(struct wait_bit_key *key, int mode);
455
456#if IS_ENABLED(CONFIG_NFS_LOCALIO)
457/* localio.c */
458extern void nfs_local_probe_async(struct nfs_client *);
459extern void nfs_local_probe_async_work(struct work_struct *);
460extern struct nfsd_file *nfs_local_open_fh(struct nfs_client *,
461 const struct cred *,
462 struct nfs_fh *,
463 struct nfs_file_localio *,
464 const fmode_t);
465extern int nfs_local_doio(struct nfs_client *,
466 struct nfsd_file *,
467 struct nfs_pgio_header *,
468 const struct rpc_call_ops *);
469extern int nfs_local_commit(struct nfsd_file *,
470 struct nfs_commit_data *,
471 const struct rpc_call_ops *, int);
472extern bool nfs_server_is_local(const struct nfs_client *clp);
473
474#else /* CONFIG_NFS_LOCALIO */
475static inline void nfs_local_probe(struct nfs_client *clp) {}
476static inline void nfs_local_probe_async(struct nfs_client *clp) {}
477static inline struct nfsd_file *
478nfs_local_open_fh(struct nfs_client *clp, const struct cred *cred,
479 struct nfs_fh *fh, struct nfs_file_localio *nfl,
480 const fmode_t mode)
481{
482 return NULL;
483}
484static inline int nfs_local_doio(struct nfs_client *clp,
485 struct nfsd_file *localio,
486 struct nfs_pgio_header *hdr,
487 const struct rpc_call_ops *call_ops)
488{
489 return -EINVAL;
490}
491static inline int nfs_local_commit(struct nfsd_file *localio,
492 struct nfs_commit_data *data,
493 const struct rpc_call_ops *call_ops, int how)
494{
495 return -EINVAL;
496}
497static inline bool nfs_server_is_local(const struct nfs_client *clp)
498{
499 return false;
500}
501#endif /* CONFIG_NFS_LOCALIO */
502
503/* super.c */
504extern const struct super_operations nfs_sops;
505bool nfs_auth_info_match(const struct nfs_auth_info *, rpc_authflavor_t);
506int nfs_try_get_tree(struct fs_context *);
507int nfs_get_tree_common(struct fs_context *);
508void nfs_kill_super(struct super_block *);
509
510extern int __init register_nfs_fs(void);
511extern void __exit unregister_nfs_fs(void);
512extern bool nfs_sb_active(struct super_block *sb);
513extern void nfs_sb_deactive(struct super_block *sb);
514extern int nfs_client_for_each_server(struct nfs_client *clp,
515 int (*fn)(struct nfs_server *, void *),
516 void *data);
517#ifdef CONFIG_NFS_FSCACHE
518extern const struct netfs_request_ops nfs_netfs_ops;
519#endif
520
521/* io.c */
522extern __must_check int nfs_start_io_read(struct inode *inode);
523extern void nfs_end_io_read(struct inode *inode);
524extern __must_check int nfs_start_io_write(struct inode *inode);
525extern void nfs_end_io_write(struct inode *inode);
526extern __must_check int nfs_start_io_direct(struct inode *inode);
527extern void nfs_end_io_direct(struct inode *inode);
528
529static inline bool nfs_file_io_is_buffered(struct nfs_inode *nfsi)
530{
531 return test_bit(NFS_INO_ODIRECT, &nfsi->flags) == 0;
532}
533
534/* namespace.c */
535#define NFS_PATH_CANONICAL 1
536extern char *nfs_path(char **p, struct dentry *dentry,
537 char *buffer, ssize_t buflen, unsigned flags);
538extern struct vfsmount *nfs_d_automount(struct path *path);
539int nfs_submount(struct fs_context *, struct nfs_server *);
540int nfs_do_submount(struct fs_context *);
541
542/* getroot.c */
543extern int nfs_get_root(struct super_block *s, struct fs_context *fc);
544#if IS_ENABLED(CONFIG_NFS_V4)
545extern int nfs4_get_rootfh(struct nfs_server *server, struct nfs_fh *mntfh, bool);
546#endif
547
548struct nfs_pgio_completion_ops;
549/* read.c */
550extern const struct nfs_pgio_completion_ops nfs_async_read_completion_ops;
551extern void nfs_pageio_init_read(struct nfs_pageio_descriptor *pgio,
552 struct inode *inode, bool force_mds,
553 const struct nfs_pgio_completion_ops *compl_ops);
554extern bool nfs_read_alloc_scratch(struct nfs_pgio_header *hdr, size_t size);
555extern int nfs_read_add_folio(struct nfs_pageio_descriptor *pgio,
556 struct nfs_open_context *ctx,
557 struct folio *folio);
558extern void nfs_pageio_complete_read(struct nfs_pageio_descriptor *pgio);
559extern void nfs_pageio_reset_read_mds(struct nfs_pageio_descriptor *pgio);
560
561/* super.c */
562void nfs_umount_begin(struct super_block *);
563int nfs_statfs(struct dentry *, struct kstatfs *);
564int nfs_show_options(struct seq_file *, struct dentry *);
565int nfs_show_devname(struct seq_file *, struct dentry *);
566int nfs_show_path(struct seq_file *, struct dentry *);
567int nfs_show_stats(struct seq_file *, struct dentry *);
568int nfs_reconfigure(struct fs_context *);
569
570/* write.c */
571extern void nfs_pageio_init_write(struct nfs_pageio_descriptor *pgio,
572 struct inode *inode, int ioflags, bool force_mds,
573 const struct nfs_pgio_completion_ops *compl_ops);
574extern void nfs_pageio_reset_write_mds(struct nfs_pageio_descriptor *pgio);
575extern void nfs_commit_free(struct nfs_commit_data *p);
576extern void nfs_commit_prepare(struct rpc_task *task, void *calldata);
577extern int nfs_initiate_commit(struct rpc_clnt *clnt,
578 struct nfs_commit_data *data,
579 const struct nfs_rpc_ops *nfs_ops,
580 const struct rpc_call_ops *call_ops,
581 int how, int flags,
582 struct nfsd_file *localio);
583extern void nfs_init_commit(struct nfs_commit_data *data,
584 struct list_head *head,
585 struct pnfs_layout_segment *lseg,
586 struct nfs_commit_info *cinfo);
587int nfs_scan_commit_list(struct list_head *src, struct list_head *dst,
588 struct nfs_commit_info *cinfo, int max);
589unsigned long nfs_reqs_to_commit(struct nfs_commit_info *);
590int nfs_scan_commit(struct inode *inode, struct list_head *dst,
591 struct nfs_commit_info *cinfo);
592void nfs_mark_request_commit(struct nfs_page *req,
593 struct pnfs_layout_segment *lseg,
594 struct nfs_commit_info *cinfo,
595 u32 ds_commit_idx);
596int nfs_write_need_commit(struct nfs_pgio_header *);
597void nfs_writeback_update_inode(struct nfs_pgio_header *hdr);
598int nfs_generic_commit_list(struct inode *inode, struct list_head *head,
599 int how, struct nfs_commit_info *cinfo);
600void nfs_retry_commit(struct list_head *page_list,
601 struct pnfs_layout_segment *lseg,
602 struct nfs_commit_info *cinfo,
603 u32 ds_commit_idx);
604void nfs_commitdata_release(struct nfs_commit_data *data);
605void nfs_request_add_commit_list(struct nfs_page *req,
606 struct nfs_commit_info *cinfo);
607void nfs_request_add_commit_list_locked(struct nfs_page *req,
608 struct list_head *dst,
609 struct nfs_commit_info *cinfo);
610void nfs_request_remove_commit_list(struct nfs_page *req,
611 struct nfs_commit_info *cinfo);
612void nfs_init_cinfo(struct nfs_commit_info *cinfo,
613 struct inode *inode,
614 struct nfs_direct_req *dreq);
615int nfs_key_timeout_notify(struct file *filp, struct inode *inode);
616bool nfs_ctx_key_to_expire(struct nfs_open_context *ctx, struct inode *inode);
617void nfs_pageio_stop_mirroring(struct nfs_pageio_descriptor *pgio);
618
619int nfs_filemap_write_and_wait_range(struct address_space *mapping,
620 loff_t lstart, loff_t lend);
621
622#ifdef CONFIG_NFS_V4_1
623static inline void
624pnfs_bucket_clear_pnfs_ds_commit_verifiers(struct pnfs_commit_bucket *buckets,
625 unsigned int nbuckets)
626{
627 unsigned int i;
628
629 for (i = 0; i < nbuckets; i++)
630 buckets[i].direct_verf.committed = NFS_INVALID_STABLE_HOW;
631}
632static inline
633void nfs_clear_pnfs_ds_commit_verifiers(struct pnfs_ds_commit_info *cinfo)
634{
635 struct pnfs_commit_array *array;
636
637 rcu_read_lock();
638 list_for_each_entry_rcu(array, &cinfo->commits, cinfo_list)
639 pnfs_bucket_clear_pnfs_ds_commit_verifiers(buckets: array->buckets,
640 nbuckets: array->nbuckets);
641 rcu_read_unlock();
642}
643#else
644static inline
645void nfs_clear_pnfs_ds_commit_verifiers(struct pnfs_ds_commit_info *cinfo)
646{
647}
648#endif
649
650#ifdef CONFIG_MIGRATION
651int nfs_migrate_folio(struct address_space *, struct folio *dst,
652 struct folio *src, enum migrate_mode);
653#else
654#define nfs_migrate_folio NULL
655#endif
656
657static inline int
658nfs_write_verifier_cmp(const struct nfs_write_verifier *v1,
659 const struct nfs_write_verifier *v2)
660{
661 return memcmp(p: v1->data, q: v2->data, size: sizeof(v1->data));
662}
663
664static inline bool
665nfs_write_match_verf(const struct nfs_writeverf *verf,
666 struct nfs_page *req)
667{
668 return verf->committed > NFS_UNSTABLE &&
669 !nfs_write_verifier_cmp(v1: &req->wb_verf, v2: &verf->verifier);
670}
671
672static inline gfp_t nfs_io_gfp_mask(void)
673{
674 if (current->flags & PF_WQ_WORKER)
675 return GFP_KERNEL | __GFP_NORETRY | __GFP_NOWARN;
676 return GFP_KERNEL;
677}
678
679/*
680 * Special version of should_remove_suid() that ignores capabilities.
681 */
682static inline int nfs_should_remove_suid(const struct inode *inode)
683{
684 umode_t mode = inode->i_mode;
685 int kill = 0;
686
687 /* suid always must be killed */
688 if (unlikely(mode & S_ISUID))
689 kill = ATTR_KILL_SUID;
690
691 /*
692 * sgid without any exec bits is just a mandatory locking mark; leave
693 * it alone. If some exec bits are set, it's a real sgid; kill it.
694 */
695 if (unlikely((mode & S_ISGID) && (mode & S_IXGRP)))
696 kill |= ATTR_KILL_SGID;
697
698 if (unlikely(kill && S_ISREG(mode)))
699 return kill;
700
701 return 0;
702}
703
704/* unlink.c */
705extern struct rpc_task *
706nfs_async_rename(struct inode *old_dir, struct inode *new_dir,
707 struct dentry *old_dentry, struct dentry *new_dentry,
708 void (*complete)(struct rpc_task *, struct nfs_renamedata *));
709extern int nfs_sillyrename(struct inode *dir, struct dentry *dentry);
710
711/* direct.c */
712void nfs_init_cinfo_from_dreq(struct nfs_commit_info *cinfo,
713 struct nfs_direct_req *dreq);
714extern ssize_t nfs_dreq_bytes_left(struct nfs_direct_req *dreq, loff_t offset);
715
716/* nfs4proc.c */
717extern struct nfs_client *nfs4_init_client(struct nfs_client *clp,
718 const struct nfs_client_initdata *);
719extern int nfs40_walk_client_list(struct nfs_client *clp,
720 struct nfs_client **result,
721 const struct cred *cred);
722extern int nfs41_walk_client_list(struct nfs_client *clp,
723 struct nfs_client **result,
724 const struct cred *cred);
725extern void nfs4_test_session_trunk(struct rpc_clnt *clnt,
726 struct rpc_xprt *xprt,
727 void *data);
728
729static inline struct inode *nfs_igrab_and_active(struct inode *inode)
730{
731 struct super_block *sb = inode->i_sb;
732
733 if (sb && nfs_sb_active(sb)) {
734 if (igrab(inode))
735 return inode;
736 nfs_sb_deactive(sb);
737 }
738 return NULL;
739}
740
741static inline void nfs_iput_and_deactive(struct inode *inode)
742{
743 if (inode != NULL) {
744 struct super_block *sb = inode->i_sb;
745
746 iput(inode);
747 nfs_sb_deactive(sb);
748 }
749}
750
751/*
752 * Determine the device name as a string
753 */
754static inline char *nfs_devname(struct dentry *dentry,
755 char *buffer, ssize_t buflen)
756{
757 char *dummy;
758 return nfs_path(p: &dummy, dentry, buffer, buflen, NFS_PATH_CANONICAL);
759}
760
761/*
762 * Determine the actual block size (and log2 thereof)
763 */
764static inline
765unsigned long nfs_block_bits(unsigned long bsize, unsigned char *nrbitsp)
766{
767 /* make sure blocksize is a power of two */
768 if ((bsize & (bsize - 1)) || nrbitsp) {
769 unsigned char nrbits;
770
771 for (nrbits = 31; nrbits && !(bsize & (1UL << nrbits)); nrbits--)
772 ;
773 bsize = 1UL << nrbits;
774 if (nrbitsp)
775 *nrbitsp = nrbits;
776 }
777
778 return bsize;
779}
780
781/*
782 * Calculate the number of 512byte blocks used.
783 */
784static inline blkcnt_t nfs_calc_block_size(u64 tsize)
785{
786 blkcnt_t used = (tsize + 511) >> 9;
787 return (used > ULONG_MAX) ? ULONG_MAX : used;
788}
789
790/*
791 * Compute and set NFS server blocksize
792 */
793static inline
794unsigned long nfs_block_size(unsigned long bsize, unsigned char *nrbitsp)
795{
796 if (bsize < NFS_MIN_FILE_IO_SIZE)
797 bsize = NFS_DEF_FILE_IO_SIZE;
798 else if (bsize >= NFS_MAX_FILE_IO_SIZE)
799 bsize = NFS_MAX_FILE_IO_SIZE;
800
801 return nfs_block_bits(bsize, nrbitsp);
802}
803
804/*
805 * Compute and set NFS server rsize / wsize
806 */
807static inline
808unsigned long nfs_io_size(unsigned long iosize, enum xprt_transports proto)
809{
810 if (iosize < NFS_MIN_FILE_IO_SIZE)
811 iosize = NFS_DEF_FILE_IO_SIZE;
812 else if (iosize >= NFS_MAX_FILE_IO_SIZE)
813 iosize = NFS_MAX_FILE_IO_SIZE;
814
815 if (proto == XPRT_TRANSPORT_UDP || iosize < PAGE_SIZE)
816 return nfs_block_bits(bsize: iosize, NULL);
817 return iosize & PAGE_MASK;
818}
819
820/*
821 * Determine the maximum file size for a superblock
822 */
823static inline
824void nfs_super_set_maxbytes(struct super_block *sb, __u64 maxfilesize)
825{
826 sb->s_maxbytes = (loff_t)maxfilesize;
827 if (sb->s_maxbytes > MAX_LFS_FILESIZE || sb->s_maxbytes <= 0)
828 sb->s_maxbytes = MAX_LFS_FILESIZE;
829}
830
831/*
832 * Record the page as unstable (an extra writeback period) and mark its
833 * inode as dirty.
834 */
835static inline void nfs_folio_mark_unstable(struct folio *folio,
836 struct nfs_commit_info *cinfo)
837{
838 if (folio && !cinfo->dreq) {
839 struct inode *inode = folio->mapping->host;
840 long nr = folio_nr_pages(folio);
841
842 /* This page is really still in write-back - just that the
843 * writeback is happening on the server now.
844 */
845 node_stat_mod_folio(folio, item: NR_WRITEBACK, nr);
846 wb_stat_mod(wb: &inode_to_bdi(inode)->wb, item: WB_WRITEBACK, amount: nr);
847 __mark_inode_dirty(inode, I_DIRTY_DATASYNC);
848 }
849}
850
851/*
852 * Determine the number of bytes of data the page contains
853 */
854static inline size_t nfs_folio_length(struct folio *folio)
855{
856 loff_t i_size = i_size_read(inode: folio->mapping->host);
857
858 if (i_size > 0) {
859 pgoff_t index = folio->index >> folio_order(folio);
860 pgoff_t end_index = (i_size - 1) >> folio_shift(folio);
861 if (index < end_index)
862 return folio_size(folio);
863 if (index == end_index)
864 return offset_in_folio(folio, i_size - 1) + 1;
865 }
866 return 0;
867}
868
869/*
870 * Convert a umode to a dirent->d_type
871 */
872static inline
873unsigned char nfs_umode_to_dtype(umode_t mode)
874{
875 return (mode >> 12) & 15;
876}
877
878/*
879 * Determine the number of pages in an array of length 'len' and
880 * with a base offset of 'base'
881 */
882static inline unsigned int nfs_page_array_len(unsigned int base, size_t len)
883{
884 return ((unsigned long)len + (unsigned long)base + PAGE_SIZE - 1) >>
885 PAGE_SHIFT;
886}
887
888/*
889 * Convert a struct timespec64 into a 64-bit change attribute
890 *
891 * This does approximately the same thing as timespec64_to_ns(),
892 * but for calculation efficiency, we multiply the seconds by
893 * 1024*1024*1024.
894 */
895static inline
896u64 nfs_timespec_to_change_attr(const struct timespec64 *ts)
897{
898 return ((u64)ts->tv_sec << 30) + ts->tv_nsec;
899}
900
901static inline u32 nfs_stateid_hash(const nfs4_stateid *stateid)
902{
903 return ~crc32_le(crc: 0xFFFFFFFF, p: &stateid->other[0],
904 NFS4_STATEID_OTHER_SIZE);
905}
906
907static inline bool nfs_current_task_exiting(void)
908{
909 return (current->flags & PF_EXITING) != 0;
910}
911
912static inline bool nfs_error_is_fatal(int err)
913{
914 switch (err) {
915 case -ERESTARTSYS:
916 case -EINTR:
917 case -EACCES:
918 case -EDQUOT:
919 case -EFBIG:
920 case -EIO:
921 case -ENOSPC:
922 case -EROFS:
923 case -ESTALE:
924 case -E2BIG:
925 case -ENOMEM:
926 case -ETIMEDOUT:
927 return true;
928 default:
929 return false;
930 }
931}
932
933static inline bool nfs_error_is_fatal_on_server(int err)
934{
935 switch (err) {
936 case 0:
937 case -ERESTARTSYS:
938 case -EINTR:
939 case -ENOMEM:
940 return false;
941 }
942 return nfs_error_is_fatal(err);
943}
944
945/*
946 * Select between a default port value and a user-specified port value.
947 * If a zero value is set, then autobind will be used.
948 */
949static inline void nfs_set_port(struct sockaddr_storage *sap, int *port,
950 const unsigned short default_port)
951{
952 if (*port == NFS_UNSPEC_PORT)
953 *port = default_port;
954
955 rpc_set_port(sap: (struct sockaddr *)sap, port: *port);
956}
957
958struct nfs_direct_req {
959 struct kref kref; /* release manager */
960
961 /* I/O parameters */
962 struct nfs_open_context *ctx; /* file open context info */
963 struct nfs_lock_context *l_ctx; /* Lock context info */
964 struct kiocb * iocb; /* controlling i/o request */
965 struct inode * inode; /* target file of i/o */
966
967 /* completion state */
968 atomic_t io_count; /* i/os we're waiting for */
969 spinlock_t lock; /* protect completion state */
970
971 loff_t io_start; /* Start offset for I/O */
972 ssize_t count, /* bytes actually processed */
973 max_count, /* max expected count */
974 error; /* any reported error */
975 struct completion completion; /* wait for i/o completion */
976
977 /* commit state */
978 struct nfs_mds_commit_info mds_cinfo; /* Storage for cinfo */
979 struct pnfs_ds_commit_info ds_cinfo; /* Storage for cinfo */
980 struct work_struct work;
981 int flags;
982 /* for write */
983#define NFS_ODIRECT_DO_COMMIT (1) /* an unstable reply was received */
984#define NFS_ODIRECT_RESCHED_WRITES (2) /* write verification failed */
985 /* for read */
986#define NFS_ODIRECT_SHOULD_DIRTY (3) /* dirty user-space page after read */
987#define NFS_ODIRECT_DONE INT_MAX /* write verification failed */
988};
989

Provided by KDAB

Privacy Policy
Improve your Profiling and Debugging skills
Find out more

source code of linux/fs/nfs/internal.h