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