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