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