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