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