1 /* SPDX-License-Identifier: GPL-2.0 */
3 * NFS internal definitions
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>
14 #define NFS_SB_MASK (SB_RDONLY|SB_NOSUID|SB_NODEV|SB_NOEXEC|SB_SYNCHRONOUS)
16 extern const struct export_operations nfs_export_ops;
19 struct nfs_pageio_descriptor;
21 static inline void nfs_attr_check_mountpoint(struct super_block *parent, struct nfs_fattr *fattr)
23 if (!nfs_fsid_equal(&NFS_SB(parent)->fsid, &fattr->fsid))
24 fattr->valid |= NFS_ATTR_FATTR_MOUNTPOINT;
27 static inline int nfs_attr_use_mounted_on_fileid(struct nfs_fattr *fattr)
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)))
36 static inline bool nfs_lookup_is_soft_revalidate(const struct dentry *dentry)
38 if (!(NFS_SB(dentry->d_sb)->flags & NFS_MOUNT_SOFTREVAL))
40 if (!d_is_positive(dentry) || !NFS_FH(d_inode(dentry))->size)
45 static inline fmode_t flags_to_mode(int flags)
47 fmode_t res = (__force fmode_t)flags & FMODE_EXEC;
48 if ((flags & O_ACCMODE) != O_WRONLY)
50 if ((flags & O_ACCMODE) != O_RDONLY)
56 * Note: RFC 1813 doesn't limit the number of auth flavors that
57 * a server can return, so make something up.
59 #define NFS_MAX_SECFLAVORS (12)
62 * Value used if the user did not specify a port value.
64 #define NFS_UNSPEC_PORT (-1)
66 #define NFS_UNSPEC_RETRANS (UINT_MAX)
67 #define NFS_UNSPEC_TIMEO (UINT_MAX)
69 struct 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 */
76 struct nfs_subversion *nfs_mod;
79 unsigned int nconnect;
80 unsigned int max_connect;
82 const struct rpc_timeout *timeparms;
83 const struct cred *cred;
87 * In-kernel mount arguments
89 struct nfs_fs_context {
91 bool skip_reconfig_option_check;
94 unsigned int flags; /* NFS{,4}_MOUNT_* flags */
95 unsigned int rsize, wsize;
96 unsigned int timeo, retrans;
97 unsigned int acregmin, acregmax;
98 unsigned int acdirmin, acdirmax;
100 unsigned int options;
102 struct nfs_auth_info auth_info;
103 rpc_authflavor_t selected_flavor;
104 char *client_address;
105 unsigned int version;
106 unsigned int minorversion;
108 unsigned short protofamily;
109 unsigned short mountfamily;
110 bool has_sec_mnt_opts;
114 struct sockaddr address;
115 struct sockaddr_storage _address;
121 unsigned short protocol;
126 struct sockaddr address;
127 struct sockaddr_storage _address;
133 unsigned short protocol;
134 unsigned short nconnect;
135 unsigned short max_connect;
136 unsigned short export_path_len;
139 struct nfs_fh *mntfh;
140 struct nfs_server *server;
141 struct nfs_subversion *nfs_mod;
143 /* Information for a cloned mount. */
144 struct nfs_clone_mount {
145 struct super_block *sb;
146 struct dentry *dentry;
147 struct nfs_fattr *fattr;
148 unsigned int inherited_bsize;
152 #define nfs_errorf(fc, fmt, ...) ((fc)->log.log ? \
153 errorf(fc, fmt, ## __VA_ARGS__) : \
154 ({ dprintk(fmt "\n", ## __VA_ARGS__); }))
156 #define nfs_ferrorf(fc, fac, fmt, ...) ((fc)->log.log ? \
157 errorf(fc, fmt, ## __VA_ARGS__) : \
158 ({ dfprintk(fac, fmt "\n", ## __VA_ARGS__); }))
160 #define nfs_invalf(fc, fmt, ...) ((fc)->log.log ? \
161 invalf(fc, fmt, ## __VA_ARGS__) : \
162 ({ dprintk(fmt "\n", ## __VA_ARGS__); -EINVAL; }))
164 #define nfs_finvalf(fc, fac, fmt, ...) ((fc)->log.log ? \
165 invalf(fc, fmt, ## __VA_ARGS__) : \
166 ({ dfprintk(fac, fmt "\n", ## __VA_ARGS__); -EINVAL; }))
168 #define nfs_warnf(fc, fmt, ...) ((fc)->log.log ? \
169 warnf(fc, fmt, ## __VA_ARGS__) : \
170 ({ dprintk(fmt "\n", ## __VA_ARGS__); }))
172 #define nfs_fwarnf(fc, fac, fmt, ...) ((fc)->log.log ? \
173 warnf(fc, fmt, ## __VA_ARGS__) : \
174 ({ dfprintk(fac, fmt "\n", ## __VA_ARGS__); }))
176 static inline struct nfs_fs_context *nfs_fc2context(const struct fs_context *fc)
178 return fc->fs_private;
182 struct nfs_mount_request {
183 struct sockaddr_storage *sap;
188 unsigned short protocol;
191 unsigned int *auth_flav_len;
192 rpc_authflavor_t *auth_flavs;
196 extern int nfs_mount(struct nfs_mount_request *info, int timeo, int retrans);
197 extern void nfs_umount(const struct nfs_mount_request *info);
200 extern const struct rpc_program nfs_program;
201 extern void nfs_clients_init(struct net *net);
202 extern void nfs_clients_exit(struct net *net);
203 extern struct nfs_client *nfs_alloc_client(const struct nfs_client_initdata *);
204 int nfs_create_rpc_client(struct nfs_client *, const struct nfs_client_initdata *, rpc_authflavor_t);
205 struct nfs_client *nfs_get_client(const struct nfs_client_initdata *);
206 int nfs_probe_server(struct nfs_server *, struct nfs_fh *);
207 void nfs_server_insert_lists(struct nfs_server *);
208 void nfs_server_remove_lists(struct nfs_server *);
209 void nfs_init_timeout_values(struct rpc_timeout *to, int proto, int timeo, int retrans);
210 int nfs_init_server_rpcclient(struct nfs_server *, const struct rpc_timeout *t,
212 struct nfs_server *nfs_alloc_server(void);
213 void nfs_server_copy_userdata(struct nfs_server *, struct nfs_server *);
215 extern void nfs_put_client(struct nfs_client *);
216 extern void nfs_free_client(struct nfs_client *);
217 extern struct nfs_client *nfs4_find_client_ident(struct net *, int);
218 extern struct nfs_client *
219 nfs4_find_client_sessionid(struct net *, const struct sockaddr *,
220 struct nfs4_sessionid *, u32);
221 extern struct nfs_server *nfs_create_server(struct fs_context *);
222 extern void nfs4_server_set_init_caps(struct nfs_server *);
223 extern struct nfs_server *nfs4_create_server(struct fs_context *);
224 extern struct nfs_server *nfs4_create_referral_server(struct fs_context *);
225 extern int nfs4_update_server(struct nfs_server *server, const char *hostname,
226 struct sockaddr_storage *sap, size_t salen,
228 extern void nfs_free_server(struct nfs_server *server);
229 extern struct nfs_server *nfs_clone_server(struct nfs_server *,
233 extern bool nfs_client_init_is_complete(const struct nfs_client *clp);
234 extern int nfs_client_init_status(const struct nfs_client *clp);
235 extern int nfs_wait_client_init_complete(const struct nfs_client *clp);
236 extern void nfs_mark_client_ready(struct nfs_client *clp, int state);
237 extern struct nfs_client *nfs4_set_ds_client(struct nfs_server *mds_srv,
238 const struct sockaddr_storage *ds_addr,
239 int ds_addrlen, int ds_proto,
240 unsigned int ds_timeo,
241 unsigned int ds_retrans,
243 extern struct rpc_clnt *nfs4_find_or_create_ds_client(struct nfs_client *,
245 extern struct nfs_client *nfs3_set_ds_client(struct nfs_server *mds_srv,
246 const struct sockaddr_storage *ds_addr, int ds_addrlen,
247 int ds_proto, unsigned int ds_timeo,
248 unsigned int ds_retrans);
249 #ifdef CONFIG_PROC_FS
250 extern int __init nfs_fs_proc_init(void);
251 extern void nfs_fs_proc_exit(void);
252 extern int nfs_fs_proc_net_init(struct net *net);
253 extern void nfs_fs_proc_net_exit(struct net *net);
255 static inline int nfs_fs_proc_net_init(struct net *net)
259 static inline void nfs_fs_proc_net_exit(struct net *net)
262 static inline int nfs_fs_proc_init(void)
266 static inline void nfs_fs_proc_exit(void)
272 extern const struct svc_version nfs4_callback_version1;
273 extern const struct svc_version nfs4_callback_version4;
276 extern struct file_system_type nfs_fs_type;
279 extern int __init nfs_init_nfspagecache(void);
280 extern void nfs_destroy_nfspagecache(void);
281 extern int __init nfs_init_readpagecache(void);
282 extern void nfs_destroy_readpagecache(void);
283 extern int __init nfs_init_writepagecache(void);
284 extern void nfs_destroy_writepagecache(void);
286 extern int __init nfs_init_directcache(void);
287 extern void nfs_destroy_directcache(void);
288 extern void nfs_pgheader_init(struct nfs_pageio_descriptor *desc,
289 struct nfs_pgio_header *hdr,
290 void (*release)(struct nfs_pgio_header *hdr));
291 void nfs_set_pgio_error(struct nfs_pgio_header *hdr, int error, loff_t pos);
292 int nfs_iocounter_wait(struct nfs_lock_context *l_ctx);
294 extern const struct nfs_pageio_ops nfs_pgio_rw_ops;
295 struct nfs_pgio_header *nfs_pgio_header_alloc(const struct nfs_rw_ops *);
296 void nfs_pgio_header_free(struct nfs_pgio_header *);
297 int nfs_generic_pgio(struct nfs_pageio_descriptor *, struct nfs_pgio_header *);
298 int nfs_initiate_pgio(struct rpc_clnt *clnt, struct nfs_pgio_header *hdr,
299 const struct cred *cred, const struct nfs_rpc_ops *rpc_ops,
300 const struct rpc_call_ops *call_ops, int how, int flags);
301 void nfs_free_request(struct nfs_page *req);
302 struct nfs_pgio_mirror *
303 nfs_pgio_current_mirror(struct nfs_pageio_descriptor *desc);
305 static inline bool nfs_match_open_context(const struct nfs_open_context *ctx1,
306 const struct nfs_open_context *ctx2)
308 return cred_fscmp(ctx1->cred, ctx2->cred) == 0 && ctx1->state == ctx2->state;
312 extern const struct rpc_procinfo nfs_procedures[];
313 extern int nfs2_decode_dirent(struct xdr_stream *,
314 struct nfs_entry *, bool);
317 extern const struct rpc_procinfo nfs3_procedures[];
318 extern int nfs3_decode_dirent(struct xdr_stream *,
319 struct nfs_entry *, bool);
322 #if IS_ENABLED(CONFIG_NFS_V4)
323 extern int nfs4_decode_dirent(struct xdr_stream *,
324 struct nfs_entry *, bool);
326 #ifdef CONFIG_NFS_V4_1
327 extern const u32 nfs41_maxread_overhead;
328 extern const u32 nfs41_maxwrite_overhead;
329 extern const u32 nfs41_maxgetdevinfo_overhead;
333 #if IS_ENABLED(CONFIG_NFS_V4)
334 extern const struct rpc_procinfo nfs4_procedures[];
337 #ifdef CONFIG_NFS_V4_SECURITY_LABEL
338 extern struct nfs4_label *nfs4_label_alloc(struct nfs_server *server, gfp_t flags);
339 static inline struct nfs4_label *
340 nfs4_label_copy(struct nfs4_label *dst, struct nfs4_label *src)
345 if (src->len > NFS4_MAXLABELLEN)
351 memcpy(dst->label, src->label, src->len);
356 static inline void nfs_zap_label_cache_locked(struct nfs_inode *nfsi)
358 if (nfs_server_capable(&nfsi->vfs_inode, NFS_CAP_SECURITY_LABEL))
359 nfsi->cache_validity |= NFS_INO_INVALID_LABEL;
362 static inline struct nfs4_label *nfs4_label_alloc(struct nfs_server *server, gfp_t flags) { return NULL; }
363 static inline void nfs_zap_label_cache_locked(struct nfs_inode *nfsi)
366 static inline struct nfs4_label *
367 nfs4_label_copy(struct nfs4_label *dst, struct nfs4_label *src)
371 #endif /* CONFIG_NFS_V4_SECURITY_LABEL */
374 void nfs_close_context(struct nfs_open_context *ctx, int is_sync);
375 extern struct nfs_client *nfs_init_client(struct nfs_client *clp,
376 const struct nfs_client_initdata *);
379 extern void nfs_readdir_record_entry_cache_hit(struct inode *dir);
380 extern void nfs_readdir_record_entry_cache_miss(struct inode *dir);
381 extern unsigned long nfs_access_cache_count(struct shrinker *shrink,
382 struct shrink_control *sc);
383 extern unsigned long nfs_access_cache_scan(struct shrinker *shrink,
384 struct shrink_control *sc);
385 struct dentry *nfs_lookup(struct inode *, struct dentry *, unsigned int);
386 void nfs_d_prune_case_insensitive_aliases(struct inode *inode);
387 int nfs_create(struct mnt_idmap *, struct inode *, struct dentry *,
389 int nfs_mkdir(struct mnt_idmap *, struct inode *, struct dentry *,
391 int nfs_rmdir(struct inode *, struct dentry *);
392 int nfs_unlink(struct inode *, struct dentry *);
393 int nfs_symlink(struct mnt_idmap *, struct inode *, struct dentry *,
395 int nfs_link(struct dentry *, struct inode *, struct dentry *);
396 int nfs_mknod(struct mnt_idmap *, struct inode *, struct dentry *, umode_t,
398 int nfs_rename(struct mnt_idmap *, struct inode *, struct dentry *,
399 struct inode *, struct dentry *, unsigned int);
401 #ifdef CONFIG_NFS_V4_2
402 static inline __u32 nfs_access_xattr_mask(const struct nfs_server *server)
404 if (!(server->caps & NFS_CAP_XATTR))
406 return NFS4_ACCESS_XAREAD | NFS4_ACCESS_XAWRITE | NFS4_ACCESS_XALIST;
409 static inline __u32 nfs_access_xattr_mask(const struct nfs_server *server)
416 int nfs_file_fsync(struct file *file, loff_t start, loff_t end, int datasync);
417 loff_t nfs_file_llseek(struct file *, loff_t, int);
418 ssize_t nfs_file_read(struct kiocb *, struct iov_iter *);
419 int nfs_file_mmap(struct file *, struct vm_area_struct *);
420 ssize_t nfs_file_write(struct kiocb *, struct iov_iter *);
421 int nfs_file_release(struct inode *, struct file *);
422 int nfs_lock(struct file *, int, struct file_lock *);
423 int nfs_flock(struct file *, int, struct file_lock *);
424 int nfs_check_flags(int);
427 extern struct workqueue_struct *nfsiod_workqueue;
428 extern struct inode *nfs_alloc_inode(struct super_block *sb);
429 extern void nfs_free_inode(struct inode *);
430 extern int nfs_write_inode(struct inode *, struct writeback_control *);
431 extern int nfs_drop_inode(struct inode *);
432 extern void nfs_clear_inode(struct inode *);
433 extern void nfs_evict_inode(struct inode *);
434 extern void nfs_zap_acl_cache(struct inode *inode);
435 extern void nfs_set_cache_invalid(struct inode *inode, unsigned long flags);
436 extern bool nfs_check_cache_invalid(struct inode *, unsigned long);
437 extern int nfs_wait_bit_killable(struct wait_bit_key *key, int mode);
440 extern const struct super_operations nfs_sops;
441 bool nfs_auth_info_match(const struct nfs_auth_info *, rpc_authflavor_t);
442 int nfs_try_get_tree(struct fs_context *);
443 int nfs_get_tree_common(struct fs_context *);
444 void nfs_kill_super(struct super_block *);
446 extern struct rpc_stat nfs_rpcstat;
448 extern int __init register_nfs_fs(void);
449 extern void __exit unregister_nfs_fs(void);
450 extern bool nfs_sb_active(struct super_block *sb);
451 extern void nfs_sb_deactive(struct super_block *sb);
452 extern int nfs_client_for_each_server(struct nfs_client *clp,
453 int (*fn)(struct nfs_server *, void *),
455 #ifdef CONFIG_NFS_FSCACHE
456 extern const struct netfs_request_ops nfs_netfs_ops;
460 extern void nfs_start_io_read(struct inode *inode);
461 extern void nfs_end_io_read(struct inode *inode);
462 extern void nfs_start_io_write(struct inode *inode);
463 extern void nfs_end_io_write(struct inode *inode);
464 extern void nfs_start_io_direct(struct inode *inode);
465 extern void nfs_end_io_direct(struct inode *inode);
467 static inline bool nfs_file_io_is_buffered(struct nfs_inode *nfsi)
469 return test_bit(NFS_INO_ODIRECT, &nfsi->flags) == 0;
473 #define NFS_PATH_CANONICAL 1
474 extern char *nfs_path(char **p, struct dentry *dentry,
475 char *buffer, ssize_t buflen, unsigned flags);
476 extern struct vfsmount *nfs_d_automount(struct path *path);
477 int nfs_submount(struct fs_context *, struct nfs_server *);
478 int nfs_do_submount(struct fs_context *);
481 extern int nfs_get_root(struct super_block *s, struct fs_context *fc);
482 #if IS_ENABLED(CONFIG_NFS_V4)
483 extern int nfs4_get_rootfh(struct nfs_server *server, struct nfs_fh *mntfh, bool);
486 struct nfs_pgio_completion_ops;
488 extern const struct nfs_pgio_completion_ops nfs_async_read_completion_ops;
489 extern void nfs_pageio_init_read(struct nfs_pageio_descriptor *pgio,
490 struct inode *inode, bool force_mds,
491 const struct nfs_pgio_completion_ops *compl_ops);
492 extern int nfs_read_add_folio(struct nfs_pageio_descriptor *pgio,
493 struct nfs_open_context *ctx,
494 struct folio *folio);
495 extern void nfs_pageio_complete_read(struct nfs_pageio_descriptor *pgio);
496 extern void nfs_read_prepare(struct rpc_task *task, void *calldata);
497 extern void nfs_pageio_reset_read_mds(struct nfs_pageio_descriptor *pgio);
500 void nfs_umount_begin(struct super_block *);
501 int nfs_statfs(struct dentry *, struct kstatfs *);
502 int nfs_show_options(struct seq_file *, struct dentry *);
503 int nfs_show_devname(struct seq_file *, struct dentry *);
504 int nfs_show_path(struct seq_file *, struct dentry *);
505 int nfs_show_stats(struct seq_file *, struct dentry *);
506 int nfs_reconfigure(struct fs_context *);
509 extern void nfs_pageio_init_write(struct nfs_pageio_descriptor *pgio,
510 struct inode *inode, int ioflags, bool force_mds,
511 const struct nfs_pgio_completion_ops *compl_ops);
512 extern void nfs_pageio_reset_write_mds(struct nfs_pageio_descriptor *pgio);
513 extern void nfs_commit_free(struct nfs_commit_data *p);
514 extern void nfs_commit_prepare(struct rpc_task *task, void *calldata);
515 extern int nfs_initiate_commit(struct rpc_clnt *clnt,
516 struct nfs_commit_data *data,
517 const struct nfs_rpc_ops *nfs_ops,
518 const struct rpc_call_ops *call_ops,
520 extern void nfs_init_commit(struct nfs_commit_data *data,
521 struct list_head *head,
522 struct pnfs_layout_segment *lseg,
523 struct nfs_commit_info *cinfo);
524 int nfs_scan_commit_list(struct list_head *src, struct list_head *dst,
525 struct nfs_commit_info *cinfo, int max);
526 unsigned long nfs_reqs_to_commit(struct nfs_commit_info *);
527 int nfs_scan_commit(struct inode *inode, struct list_head *dst,
528 struct nfs_commit_info *cinfo);
529 void nfs_mark_request_commit(struct nfs_page *req,
530 struct pnfs_layout_segment *lseg,
531 struct nfs_commit_info *cinfo,
533 int nfs_write_need_commit(struct nfs_pgio_header *);
534 void nfs_writeback_update_inode(struct nfs_pgio_header *hdr);
535 int nfs_generic_commit_list(struct inode *inode, struct list_head *head,
536 int how, struct nfs_commit_info *cinfo);
537 void nfs_retry_commit(struct list_head *page_list,
538 struct pnfs_layout_segment *lseg,
539 struct nfs_commit_info *cinfo,
541 void nfs_commitdata_release(struct nfs_commit_data *data);
542 void nfs_request_add_commit_list(struct nfs_page *req,
543 struct nfs_commit_info *cinfo);
544 void nfs_request_add_commit_list_locked(struct nfs_page *req,
545 struct list_head *dst,
546 struct nfs_commit_info *cinfo);
547 void nfs_request_remove_commit_list(struct nfs_page *req,
548 struct nfs_commit_info *cinfo);
549 void nfs_init_cinfo(struct nfs_commit_info *cinfo,
551 struct nfs_direct_req *dreq);
552 int nfs_key_timeout_notify(struct file *filp, struct inode *inode);
553 bool nfs_ctx_key_to_expire(struct nfs_open_context *ctx, struct inode *inode);
554 void nfs_pageio_stop_mirroring(struct nfs_pageio_descriptor *pgio);
556 int nfs_filemap_write_and_wait_range(struct address_space *mapping,
557 loff_t lstart, loff_t lend);
559 #ifdef CONFIG_NFS_V4_1
561 pnfs_bucket_clear_pnfs_ds_commit_verifiers(struct pnfs_commit_bucket *buckets,
562 unsigned int nbuckets)
566 for (i = 0; i < nbuckets; i++)
567 buckets[i].direct_verf.committed = NFS_INVALID_STABLE_HOW;
570 void nfs_clear_pnfs_ds_commit_verifiers(struct pnfs_ds_commit_info *cinfo)
572 struct pnfs_commit_array *array;
575 list_for_each_entry_rcu(array, &cinfo->commits, cinfo_list)
576 pnfs_bucket_clear_pnfs_ds_commit_verifiers(array->buckets,
582 void nfs_clear_pnfs_ds_commit_verifiers(struct pnfs_ds_commit_info *cinfo)
587 #ifdef CONFIG_MIGRATION
588 int nfs_migrate_folio(struct address_space *, struct folio *dst,
589 struct folio *src, enum migrate_mode);
591 #define nfs_migrate_folio NULL
595 nfs_write_verifier_cmp(const struct nfs_write_verifier *v1,
596 const struct nfs_write_verifier *v2)
598 return memcmp(v1->data, v2->data, sizeof(v1->data));
602 nfs_write_match_verf(const struct nfs_writeverf *verf,
603 struct nfs_page *req)
605 return verf->committed > NFS_UNSTABLE &&
606 !nfs_write_verifier_cmp(&req->wb_verf, &verf->verifier);
609 static inline gfp_t nfs_io_gfp_mask(void)
611 if (current->flags & PF_WQ_WORKER)
612 return GFP_KERNEL | __GFP_NORETRY | __GFP_NOWARN;
617 * Special version of should_remove_suid() that ignores capabilities.
619 static inline int nfs_should_remove_suid(const struct inode *inode)
621 umode_t mode = inode->i_mode;
624 /* suid always must be killed */
625 if (unlikely(mode & S_ISUID))
626 kill = ATTR_KILL_SUID;
629 * sgid without any exec bits is just a mandatory locking mark; leave
630 * it alone. If some exec bits are set, it's a real sgid; kill it.
632 if (unlikely((mode & S_ISGID) && (mode & S_IXGRP)))
633 kill |= ATTR_KILL_SGID;
635 if (unlikely(kill && S_ISREG(mode)))
642 extern struct rpc_task *
643 nfs_async_rename(struct inode *old_dir, struct inode *new_dir,
644 struct dentry *old_dentry, struct dentry *new_dentry,
645 void (*complete)(struct rpc_task *, struct nfs_renamedata *));
646 extern int nfs_sillyrename(struct inode *dir, struct dentry *dentry);
649 void nfs_init_cinfo_from_dreq(struct nfs_commit_info *cinfo,
650 struct nfs_direct_req *dreq);
651 extern ssize_t nfs_dreq_bytes_left(struct nfs_direct_req *dreq);
654 extern struct nfs_client *nfs4_init_client(struct nfs_client *clp,
655 const struct nfs_client_initdata *);
656 extern int nfs40_walk_client_list(struct nfs_client *clp,
657 struct nfs_client **result,
658 const struct cred *cred);
659 extern int nfs41_walk_client_list(struct nfs_client *clp,
660 struct nfs_client **result,
661 const struct cred *cred);
662 extern void nfs4_test_session_trunk(struct rpc_clnt *clnt,
663 struct rpc_xprt *xprt,
666 static inline struct inode *nfs_igrab_and_active(struct inode *inode)
668 struct super_block *sb = inode->i_sb;
670 if (sb && nfs_sb_active(sb)) {
678 static inline void nfs_iput_and_deactive(struct inode *inode)
681 struct super_block *sb = inode->i_sb;
689 * Determine the device name as a string
691 static inline char *nfs_devname(struct dentry *dentry,
692 char *buffer, ssize_t buflen)
695 return nfs_path(&dummy, dentry, buffer, buflen, NFS_PATH_CANONICAL);
699 * Determine the actual block size (and log2 thereof)
702 unsigned long nfs_block_bits(unsigned long bsize, unsigned char *nrbitsp)
704 /* make sure blocksize is a power of two */
705 if ((bsize & (bsize - 1)) || nrbitsp) {
706 unsigned char nrbits;
708 for (nrbits = 31; nrbits && !(bsize & (1 << nrbits)); nrbits--)
719 * Calculate the number of 512byte blocks used.
721 static inline blkcnt_t nfs_calc_block_size(u64 tsize)
723 blkcnt_t used = (tsize + 511) >> 9;
724 return (used > ULONG_MAX) ? ULONG_MAX : used;
728 * Compute and set NFS server blocksize
731 unsigned long nfs_block_size(unsigned long bsize, unsigned char *nrbitsp)
733 if (bsize < NFS_MIN_FILE_IO_SIZE)
734 bsize = NFS_DEF_FILE_IO_SIZE;
735 else if (bsize >= NFS_MAX_FILE_IO_SIZE)
736 bsize = NFS_MAX_FILE_IO_SIZE;
738 return nfs_block_bits(bsize, nrbitsp);
742 * Compute and set NFS server rsize / wsize
745 unsigned long nfs_io_size(unsigned long iosize, enum xprt_transports proto)
747 if (iosize < NFS_MIN_FILE_IO_SIZE)
748 iosize = NFS_DEF_FILE_IO_SIZE;
749 else if (iosize >= NFS_MAX_FILE_IO_SIZE)
750 iosize = NFS_MAX_FILE_IO_SIZE;
752 if (proto == XPRT_TRANSPORT_UDP || iosize < PAGE_SIZE)
753 return nfs_block_bits(iosize, NULL);
754 return iosize & PAGE_MASK;
758 * Determine the maximum file size for a superblock
761 void nfs_super_set_maxbytes(struct super_block *sb, __u64 maxfilesize)
763 sb->s_maxbytes = (loff_t)maxfilesize;
764 if (sb->s_maxbytes > MAX_LFS_FILESIZE || sb->s_maxbytes <= 0)
765 sb->s_maxbytes = MAX_LFS_FILESIZE;
769 * Record the page as unstable (an extra writeback period) and mark its
772 static inline void nfs_folio_mark_unstable(struct folio *folio,
773 struct nfs_commit_info *cinfo)
775 if (folio && !cinfo->dreq) {
776 struct inode *inode = folio_file_mapping(folio)->host;
777 long nr = folio_nr_pages(folio);
779 /* This page is really still in write-back - just that the
780 * writeback is happening on the server now.
782 node_stat_mod_folio(folio, NR_WRITEBACK, nr);
783 wb_stat_mod(&inode_to_bdi(inode)->wb, WB_WRITEBACK, nr);
784 __mark_inode_dirty(inode, I_DIRTY_DATASYNC);
789 * Determine the number of bytes of data the page contains
792 unsigned int nfs_page_length(struct page *page)
794 loff_t i_size = i_size_read(page_file_mapping(page)->host);
797 pgoff_t index = page_index(page);
798 pgoff_t end_index = (i_size - 1) >> PAGE_SHIFT;
799 if (index < end_index)
801 if (index == end_index)
802 return ((i_size - 1) & ~PAGE_MASK) + 1;
808 * Determine the number of bytes of data the page contains
810 static inline size_t nfs_folio_length(struct folio *folio)
812 loff_t i_size = i_size_read(folio_file_mapping(folio)->host);
815 pgoff_t index = folio_index(folio) >> folio_order(folio);
816 pgoff_t end_index = (i_size - 1) >> folio_shift(folio);
817 if (index < end_index)
818 return folio_size(folio);
819 if (index == end_index)
820 return offset_in_folio(folio, i_size - 1) + 1;
826 * Convert a umode to a dirent->d_type
829 unsigned char nfs_umode_to_dtype(umode_t mode)
831 return (mode >> 12) & 15;
835 * Determine the number of pages in an array of length 'len' and
836 * with a base offset of 'base'
838 static inline unsigned int nfs_page_array_len(unsigned int base, size_t len)
840 return ((unsigned long)len + (unsigned long)base + PAGE_SIZE - 1) >>
845 * Convert a struct timespec64 into a 64-bit change attribute
847 * This does approximately the same thing as timespec64_to_ns(),
848 * but for calculation efficiency, we multiply the seconds by
852 u64 nfs_timespec_to_change_attr(const struct timespec64 *ts)
854 return ((u64)ts->tv_sec << 30) + ts->tv_nsec;
858 static inline u32 nfs_stateid_hash(const nfs4_stateid *stateid)
860 return ~crc32_le(0xFFFFFFFF, &stateid->other[0],
861 NFS4_STATEID_OTHER_SIZE);
864 static inline u32 nfs_stateid_hash(nfs4_stateid *stateid)
870 static inline bool nfs_error_is_fatal(int err)
891 static inline bool nfs_error_is_fatal_on_server(int err)
900 return nfs_error_is_fatal(err);
904 * Select between a default port value and a user-specified port value.
905 * If a zero value is set, then autobind will be used.
907 static inline void nfs_set_port(struct sockaddr_storage *sap, int *port,
908 const unsigned short default_port)
910 if (*port == NFS_UNSPEC_PORT)
911 *port = default_port;
913 rpc_set_port((struct sockaddr *)sap, *port);
916 struct nfs_direct_req {
917 struct kref kref; /* release manager */
920 struct nfs_open_context *ctx; /* file open context info */
921 struct nfs_lock_context *l_ctx; /* Lock context info */
922 struct kiocb * iocb; /* controlling i/o request */
923 struct inode * inode; /* target file of i/o */
925 /* completion state */
926 atomic_t io_count; /* i/os we're waiting for */
927 spinlock_t lock; /* protect completion state */
929 loff_t io_start; /* Start offset for I/O */
930 ssize_t count, /* bytes actually processed */
931 max_count, /* max expected count */
932 bytes_left, /* bytes left to be sent */
933 error; /* any reported error */
934 struct completion completion; /* wait for i/o completion */
937 struct nfs_mds_commit_info mds_cinfo; /* Storage for cinfo */
938 struct pnfs_ds_commit_info ds_cinfo; /* Storage for cinfo */
939 struct work_struct work;
942 #define NFS_ODIRECT_DO_COMMIT (1) /* an unstable reply was received */
943 #define NFS_ODIRECT_RESCHED_WRITES (2) /* write verification failed */
945 #define NFS_ODIRECT_SHOULD_DIRTY (3) /* dirty user-space page after read */
946 #define NFS_ODIRECT_DONE INT_MAX /* write verification failed */