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/compiler_attributes.h>
10 #include <linux/crc32.h>
11 #include <linux/sunrpc/addr.h>
12 #include <linux/nfs_page.h>
13 #include <linux/nfslocalio.h>
14 #include <linux/wait_bit.h>
15
16 #define NFS_SB_MASK (SB_RDONLY|SB_NOSUID|SB_NODEV|SB_NOEXEC|SB_SYNCHRONOUS)
17
18 extern const struct export_operations nfs_export_ops;
19
20 struct nfs_string;
21 struct nfs_pageio_descriptor;
22
nfs_attr_check_mountpoint(struct super_block * parent,struct nfs_fattr * fattr)23 static 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
nfs_attr_use_mounted_on_fileid(struct nfs_fattr * fattr)29 static 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
nfs_lookup_is_soft_revalidate(const struct dentry * dentry)38 static inline bool nfs_lookup_is_soft_revalidate(const struct dentry *dentry)
39 {
40 if (!(NFS_SB(dentry->d_sb)->flags & NFS_MOUNT_SOFTREVAL))
41 return false;
42 if (!d_is_positive(dentry) || !NFS_FH(d_inode(dentry))->size)
43 return false;
44 return true;
45 }
46
flags_to_mode(int flags)47 static inline fmode_t flags_to_mode(int flags)
48 {
49 fmode_t res = (__force fmode_t)flags & FMODE_EXEC;
50 if ((flags & O_ACCMODE) != O_WRONLY)
51 res |= FMODE_READ;
52 if ((flags & O_ACCMODE) != O_RDONLY)
53 res |= FMODE_WRITE;
54 return res;
55 }
56
57 /*
58 * Note: RFC 1813 doesn't limit the number of auth flavors that
59 * a server can return, so make something up.
60 */
61 #define NFS_MAX_SECFLAVORS (12)
62
63 /*
64 * Value used if the user did not specify a port value.
65 */
66 #define NFS_UNSPEC_PORT (-1)
67
68 #define NFS_UNSPEC_RETRANS (UINT_MAX)
69 #define NFS_UNSPEC_TIMEO (UINT_MAX)
70
71 struct nfs_client_initdata {
72 unsigned long init_flags;
73 const char *hostname; /* Hostname of the server */
74 const struct sockaddr_storage *addr; /* Address of the server */
75 const char *nodename; /* Hostname of the client */
76 const char *ip_addr; /* IP address of the client */
77 size_t addrlen;
78 struct nfs_subversion *nfs_mod;
79 int proto;
80 u32 minorversion;
81 unsigned int nconnect;
82 unsigned int max_connect;
83 struct net *net;
84 const struct rpc_timeout *timeparms;
85 const struct cred *cred;
86 struct xprtsec_parms xprtsec;
87 unsigned long connect_timeout;
88 unsigned long reconnect_timeout;
89 };
90
91 /*
92 * In-kernel mount arguments
93 */
94 struct nfs_fs_context {
95 bool internal;
96 bool skip_reconfig_option_check;
97 bool need_mount;
98 bool sloppy;
99 unsigned int flags; /* NFS{,4}_MOUNT_* flags */
100 unsigned int rsize, wsize;
101 unsigned int timeo, retrans;
102 unsigned int acregmin, acregmax;
103 unsigned int acdirmin, acdirmax;
104 unsigned int namlen;
105 unsigned int options;
106 unsigned int bsize;
107 struct nfs_auth_info auth_info;
108 rpc_authflavor_t selected_flavor;
109 struct xprtsec_parms xprtsec;
110 char *client_address;
111 unsigned int version;
112 unsigned int minorversion;
113 char *fscache_uniq;
114 unsigned short protofamily;
115 unsigned short mountfamily;
116 bool has_sec_mnt_opts;
117 int lock_status;
118
119 struct {
120 union {
121 struct sockaddr address;
122 struct sockaddr_storage _address;
123 };
124 size_t addrlen;
125 char *hostname;
126 u32 version;
127 int port;
128 unsigned short protocol;
129 } mount_server;
130
131 struct {
132 union {
133 struct sockaddr address;
134 struct sockaddr_storage _address;
135 };
136 size_t addrlen;
137 char *hostname;
138 char *export_path;
139 int port;
140 unsigned short protocol;
141 unsigned short nconnect;
142 unsigned short max_connect;
143 unsigned short export_path_len;
144 } nfs_server;
145
146 struct nfs_fh *mntfh;
147 struct nfs_server *server;
148 struct nfs_subversion *nfs_mod;
149
150 /* Information for a cloned mount. */
151 struct nfs_clone_mount {
152 struct super_block *sb;
153 struct dentry *dentry;
154 struct nfs_fattr *fattr;
155 } clone_data;
156 };
157
158 enum nfs_lock_status {
159 NFS_LOCK_NOT_SET = 0,
160 NFS_LOCK_LOCK = 1,
161 NFS_LOCK_NOLOCK = 2,
162 };
163
164 #define nfs_errorf(fc, fmt, ...) ((fc)->log.log ? \
165 errorf(fc, fmt, ## __VA_ARGS__) : \
166 ({ dprintk(fmt "\n", ## __VA_ARGS__); }))
167
168 #define nfs_ferrorf(fc, fac, fmt, ...) ((fc)->log.log ? \
169 errorf(fc, fmt, ## __VA_ARGS__) : \
170 ({ dfprintk(fac, fmt "\n", ## __VA_ARGS__); }))
171
172 #define nfs_invalf(fc, fmt, ...) ((fc)->log.log ? \
173 invalf(fc, fmt, ## __VA_ARGS__) : \
174 ({ dprintk(fmt "\n", ## __VA_ARGS__); -EINVAL; }))
175
176 #define nfs_finvalf(fc, fac, fmt, ...) ((fc)->log.log ? \
177 invalf(fc, fmt, ## __VA_ARGS__) : \
178 ({ dfprintk(fac, fmt "\n", ## __VA_ARGS__); -EINVAL; }))
179
180 #define nfs_warnf(fc, fmt, ...) ((fc)->log.log ? \
181 warnf(fc, fmt, ## __VA_ARGS__) : \
182 ({ dprintk(fmt "\n", ## __VA_ARGS__); }))
183
184 #define nfs_fwarnf(fc, fac, fmt, ...) ((fc)->log.log ? \
185 warnf(fc, fmt, ## __VA_ARGS__) : \
186 ({ dfprintk(fac, fmt "\n", ## __VA_ARGS__); }))
187
nfs_fc2context(const struct fs_context * fc)188 static inline struct nfs_fs_context *nfs_fc2context(const struct fs_context *fc)
189 {
190 return fc->fs_private;
191 }
192
193 /* mount_clnt.c */
194 struct nfs_mount_request {
195 struct sockaddr_storage *sap;
196 size_t salen;
197 char *hostname;
198 char *dirpath;
199 u32 version;
200 unsigned short protocol;
201 struct nfs_fh *fh;
202 int noresvport;
203 unsigned int *auth_flav_len;
204 rpc_authflavor_t *auth_flavs;
205 struct net *net;
206 };
207
208 extern int nfs_mount(struct nfs_mount_request *info, int timeo, int retrans);
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 nfs_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
nfs_fs_proc_net_init(struct net * net)266 static inline int nfs_fs_proc_net_init(struct net *net)
267 {
268 return 0;
269 }
nfs_fs_proc_net_exit(struct net * net)270 static inline void nfs_fs_proc_net_exit(struct net *net)
271 {
272 }
nfs_fs_proc_init(void)273 static inline int nfs_fs_proc_init(void)
274 {
275 return 0;
276 }
nfs_fs_proc_exit(void)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 struct nfsd_file *localio);
313 void nfs_free_request(struct nfs_page *req);
314 struct nfs_pgio_mirror *
315 nfs_pgio_current_mirror(struct nfs_pageio_descriptor *desc);
316
nfs_match_open_context(const struct nfs_open_context * ctx1,const struct nfs_open_context * ctx2)317 static inline bool nfs_match_open_context(const struct nfs_open_context *ctx1,
318 const struct nfs_open_context *ctx2)
319 {
320 return cred_fscmp(ctx1->cred, ctx2->cred) == 0 && ctx1->state == ctx2->state;
321 }
322
323 /* nfs2xdr.c */
324 extern const struct rpc_procinfo nfs_procedures[];
325 extern int nfs2_decode_dirent(struct xdr_stream *,
326 struct nfs_entry *, bool);
327
328 /* nfs3xdr.c */
329 extern const struct rpc_procinfo nfs3_procedures[];
330 extern int nfs3_decode_dirent(struct xdr_stream *,
331 struct nfs_entry *, bool);
332
333 /* nfs4xdr.c */
334 #if IS_ENABLED(CONFIG_NFS_V4)
335 extern int nfs4_decode_dirent(struct xdr_stream *,
336 struct nfs_entry *, bool);
337 extern const u32 nfs41_maxread_overhead;
338 extern const u32 nfs41_maxwrite_overhead;
339 extern const u32 nfs41_maxgetdevinfo_overhead;
340
341 /* nfs4proc.c */
342 extern const struct rpc_procinfo nfs4_procedures[];
343 #endif /* CONFIG_NFS_V4 */
344
345 #ifdef CONFIG_NFS_V4_SECURITY_LABEL
346 extern struct nfs4_label *nfs4_label_alloc(struct nfs_server *server, gfp_t flags);
347 static inline struct nfs4_label *
nfs4_label_copy(struct nfs4_label * dst,struct nfs4_label * src)348 nfs4_label_copy(struct nfs4_label *dst, struct nfs4_label *src)
349 {
350 if (!dst || !src)
351 return NULL;
352
353 if (src->len > NFS4_MAXLABELLEN)
354 return NULL;
355
356 dst->lfs = src->lfs;
357 dst->pi = src->pi;
358 dst->len = src->len;
359 memcpy(dst->label, src->label, src->len);
360
361 return dst;
362 }
363
nfs_zap_label_cache_locked(struct nfs_inode * nfsi)364 static inline void nfs_zap_label_cache_locked(struct nfs_inode *nfsi)
365 {
366 if (nfs_server_capable(&nfsi->vfs_inode, NFS_CAP_SECURITY_LABEL))
367 nfsi->cache_validity |= NFS_INO_INVALID_LABEL;
368 }
369 #else
nfs4_label_alloc(struct nfs_server * server,gfp_t flags)370 static inline struct nfs4_label *nfs4_label_alloc(struct nfs_server *server, gfp_t flags) { return NULL; }
nfs_zap_label_cache_locked(struct nfs_inode * nfsi)371 static inline void nfs_zap_label_cache_locked(struct nfs_inode *nfsi)
372 {
373 }
374 static inline struct nfs4_label *
nfs4_label_copy(struct nfs4_label * dst,struct nfs4_label * src)375 nfs4_label_copy(struct nfs4_label *dst, struct nfs4_label *src)
376 {
377 return NULL;
378 }
379 #endif /* CONFIG_NFS_V4_SECURITY_LABEL */
380
381 /* proc.c */
382 void nfs_close_context(struct nfs_open_context *ctx, int is_sync);
383 extern struct nfs_client *nfs_init_client(struct nfs_client *clp,
384 const struct nfs_client_initdata *);
385
386 /* dir.c */
387 extern void nfs_readdir_record_entry_cache_hit(struct inode *dir);
388 extern void nfs_readdir_record_entry_cache_miss(struct inode *dir);
389 extern unsigned long nfs_access_cache_count(struct shrinker *shrink,
390 struct shrink_control *sc);
391 extern unsigned long nfs_access_cache_scan(struct shrinker *shrink,
392 struct shrink_control *sc);
393 struct dentry *nfs_lookup(struct inode *, struct dentry *, unsigned int);
394 void nfs_d_prune_case_insensitive_aliases(struct inode *inode);
395 int nfs_create(struct mnt_idmap *, struct inode *, struct dentry *,
396 umode_t, bool);
397 struct dentry *nfs_mkdir(struct mnt_idmap *, struct inode *, struct dentry *,
398 umode_t);
399 int nfs_rmdir(struct inode *, struct dentry *);
400 int nfs_unlink(struct inode *, struct dentry *);
401 int nfs_symlink(struct mnt_idmap *, struct inode *, struct dentry *,
402 const char *);
403 int nfs_link(struct dentry *, struct inode *, struct dentry *);
404 int nfs_mknod(struct mnt_idmap *, struct inode *, struct dentry *, umode_t,
405 dev_t);
406 int nfs_rename(struct mnt_idmap *, struct inode *, struct dentry *,
407 struct inode *, struct dentry *, unsigned int);
408
409 #ifdef CONFIG_NFS_V4_2
nfs_access_xattr_mask(const struct nfs_server * server)410 static inline __u32 nfs_access_xattr_mask(const struct nfs_server *server)
411 {
412 if (!(server->caps & NFS_CAP_XATTR))
413 return 0;
414 return NFS4_ACCESS_XAREAD | NFS4_ACCESS_XAWRITE | NFS4_ACCESS_XALIST;
415 }
416 #else
nfs_access_xattr_mask(const struct nfs_server * server)417 static inline __u32 nfs_access_xattr_mask(const struct nfs_server *server)
418 {
419 return 0;
420 }
421 #endif
422
423 /* file.c */
424 int nfs_file_fsync(struct file *file, loff_t start, loff_t end, int datasync);
425 loff_t nfs_file_llseek(struct file *, loff_t, int);
426 ssize_t nfs_file_read(struct kiocb *, struct iov_iter *);
427 ssize_t nfs_file_splice_read(struct file *in, loff_t *ppos, struct pipe_inode_info *pipe,
428 size_t len, unsigned int flags);
429 int nfs_file_mmap_prepare(struct vm_area_desc *);
430 ssize_t nfs_file_write(struct kiocb *, struct iov_iter *);
431 int nfs_file_release(struct inode *, struct file *);
432 int nfs_lock(struct file *, int, struct file_lock *);
433 int nfs_flock(struct file *, int, struct file_lock *);
434 int nfs_check_flags(int);
435 void nfs_truncate_last_folio(struct address_space *mapping, loff_t from,
436 loff_t to);
437
438 /* inode.c */
439 extern struct workqueue_struct *nfsiod_workqueue;
440 extern struct workqueue_struct *nfslocaliod_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 #if IS_ENABLED(CONFIG_NFS_LOCALIO)
453 /* localio.c */
454 struct nfs_local_dio {
455 u32 mem_align;
456 u32 offset_align;
457 loff_t middle_offset;
458 loff_t end_offset;
459 ssize_t start_len; /* Length for misaligned first extent */
460 ssize_t middle_len; /* Length for DIO-aligned middle extent */
461 ssize_t end_len; /* Length for misaligned last extent */
462 };
463
464 extern void nfs_local_probe_async(struct nfs_client *);
465 extern void nfs_local_probe_async_work(struct work_struct *);
466 extern struct nfsd_file *nfs_local_open_fh(struct nfs_client *,
467 const struct cred *,
468 struct nfs_fh *,
469 struct nfs_file_localio *,
470 const fmode_t);
471 extern int nfs_local_doio(struct nfs_client *,
472 struct nfsd_file *,
473 struct nfs_pgio_header *,
474 const struct rpc_call_ops *);
475 extern int nfs_local_commit(struct nfsd_file *,
476 struct nfs_commit_data *,
477 const struct rpc_call_ops *, int);
478 extern bool nfs_server_is_local(const struct nfs_client *clp);
479
480 #else /* CONFIG_NFS_LOCALIO */
nfs_local_probe(struct nfs_client * clp)481 static inline void nfs_local_probe(struct nfs_client *clp) {}
nfs_local_probe_async(struct nfs_client * clp)482 static inline void nfs_local_probe_async(struct nfs_client *clp) {}
483 static inline struct nfsd_file *
nfs_local_open_fh(struct nfs_client * clp,const struct cred * cred,struct nfs_fh * fh,struct nfs_file_localio * nfl,const fmode_t mode)484 nfs_local_open_fh(struct nfs_client *clp, const struct cred *cred,
485 struct nfs_fh *fh, struct nfs_file_localio *nfl,
486 const fmode_t mode)
487 {
488 return NULL;
489 }
nfs_local_doio(struct nfs_client * clp,struct nfsd_file * localio,struct nfs_pgio_header * hdr,const struct rpc_call_ops * call_ops)490 static inline int nfs_local_doio(struct nfs_client *clp,
491 struct nfsd_file *localio,
492 struct nfs_pgio_header *hdr,
493 const struct rpc_call_ops *call_ops)
494 {
495 return -EINVAL;
496 }
nfs_local_commit(struct nfsd_file * localio,struct nfs_commit_data * data,const struct rpc_call_ops * call_ops,int how)497 static inline int nfs_local_commit(struct nfsd_file *localio,
498 struct nfs_commit_data *data,
499 const struct rpc_call_ops *call_ops, int how)
500 {
501 return -EINVAL;
502 }
nfs_server_is_local(const struct nfs_client * clp)503 static inline bool nfs_server_is_local(const struct nfs_client *clp)
504 {
505 return false;
506 }
507 #endif /* CONFIG_NFS_LOCALIO */
508
509 /* super.c */
510 extern const struct super_operations nfs_sops;
511 bool nfs_auth_info_match(const struct nfs_auth_info *, rpc_authflavor_t);
512 int nfs_try_get_tree(struct fs_context *);
513 int nfs_get_tree_common(struct fs_context *);
514 void nfs_kill_super(struct super_block *);
515
516 extern int __init register_nfs_fs(void);
517 extern void __exit unregister_nfs_fs(void);
518 extern bool nfs_sb_active(struct super_block *sb);
519 extern void nfs_sb_deactive(struct super_block *sb);
520 extern int nfs_client_for_each_server(struct nfs_client *clp,
521 int (*fn)(struct nfs_server *, void *),
522 void *data);
523 #ifdef CONFIG_NFS_FSCACHE
524 extern const struct netfs_request_ops nfs_netfs_ops;
525 #endif
526
527 /* io.c */
528 extern __must_check int nfs_start_io_read(struct inode *inode);
529 extern void nfs_end_io_read(struct inode *inode);
530 extern __must_check int nfs_start_io_write(struct inode *inode);
531 extern void nfs_end_io_write(struct inode *inode);
532 extern __must_check int nfs_start_io_direct(struct inode *inode);
533 extern void nfs_end_io_direct(struct inode *inode);
534
nfs_file_io_is_buffered(struct nfs_inode * nfsi)535 static inline bool nfs_file_io_is_buffered(struct nfs_inode *nfsi)
536 {
537 return test_bit(NFS_INO_ODIRECT, &nfsi->flags) == 0;
538 }
539
540 /* Must be called with exclusively locked inode->i_rwsem */
nfs_file_block_o_direct(struct nfs_inode * nfsi)541 static inline void nfs_file_block_o_direct(struct nfs_inode *nfsi)
542 {
543 if (test_bit(NFS_INO_ODIRECT, &nfsi->flags)) {
544 clear_bit(NFS_INO_ODIRECT, &nfsi->flags);
545 inode_dio_wait(&nfsi->vfs_inode);
546 }
547 }
548
549
550 /* namespace.c */
551 #define NFS_PATH_CANONICAL 1
552 extern char *nfs_path(char **p, struct dentry *dentry,
553 char *buffer, ssize_t buflen, unsigned flags);
554 extern struct vfsmount *nfs_d_automount(struct path *path);
555 int nfs_submount(struct fs_context *, struct nfs_server *);
556 int nfs_do_submount(struct fs_context *);
557
558 /* getroot.c */
559 extern int nfs_get_root(struct super_block *s, struct fs_context *fc);
560 #if IS_ENABLED(CONFIG_NFS_V4)
561 extern int nfs4_get_rootfh(struct nfs_server *server, struct nfs_fh *mntfh, bool);
562 #endif
563
564 struct nfs_pgio_completion_ops;
565 /* read.c */
566 extern const struct nfs_pgio_completion_ops nfs_async_read_completion_ops;
567 extern void nfs_pageio_init_read(struct nfs_pageio_descriptor *pgio,
568 struct inode *inode, bool force_mds,
569 const struct nfs_pgio_completion_ops *compl_ops);
570 extern bool nfs_read_alloc_scratch(struct nfs_pgio_header *hdr, size_t size);
571 extern int nfs_read_add_folio(struct nfs_pageio_descriptor *pgio,
572 struct nfs_open_context *ctx,
573 struct folio *folio);
574 extern void nfs_pageio_complete_read(struct nfs_pageio_descriptor *pgio);
575 extern void nfs_pageio_reset_read_mds(struct nfs_pageio_descriptor *pgio);
576
577 /* super.c */
578 void nfs_umount_begin(struct super_block *);
579 int nfs_statfs(struct dentry *, struct kstatfs *);
580 int nfs_show_options(struct seq_file *, struct dentry *);
581 int nfs_show_devname(struct seq_file *, struct dentry *);
582 int nfs_show_path(struct seq_file *, struct dentry *);
583 int nfs_show_stats(struct seq_file *, struct dentry *);
584 int nfs_reconfigure(struct fs_context *);
585
586 /* write.c */
587 extern void nfs_pageio_init_write(struct nfs_pageio_descriptor *pgio,
588 struct inode *inode, int ioflags, bool force_mds,
589 const struct nfs_pgio_completion_ops *compl_ops);
590 extern void nfs_pageio_reset_write_mds(struct nfs_pageio_descriptor *pgio);
591 extern void nfs_commit_free(struct nfs_commit_data *p);
592 extern void nfs_commit_prepare(struct rpc_task *task, void *calldata);
593 extern int nfs_initiate_commit(struct rpc_clnt *clnt,
594 struct nfs_commit_data *data,
595 const struct nfs_rpc_ops *nfs_ops,
596 const struct rpc_call_ops *call_ops,
597 int how, int flags,
598 struct nfsd_file *localio);
599 extern void nfs_init_commit(struct nfs_commit_data *data,
600 struct list_head *head,
601 struct pnfs_layout_segment *lseg,
602 struct nfs_commit_info *cinfo);
603 int nfs_scan_commit_list(struct list_head *src, struct list_head *dst,
604 struct nfs_commit_info *cinfo, int max);
605 unsigned long nfs_reqs_to_commit(struct nfs_commit_info *);
606 int nfs_scan_commit(struct inode *inode, struct list_head *dst,
607 struct nfs_commit_info *cinfo);
608 void nfs_mark_request_commit(struct nfs_page *req,
609 struct pnfs_layout_segment *lseg,
610 struct nfs_commit_info *cinfo,
611 u32 ds_commit_idx);
612 int nfs_write_need_commit(struct nfs_pgio_header *);
613 void nfs_writeback_update_inode(struct nfs_pgio_header *hdr);
614 int nfs_generic_commit_list(struct inode *inode, struct list_head *head,
615 int how, struct nfs_commit_info *cinfo);
616 void nfs_retry_commit(struct list_head *page_list,
617 struct pnfs_layout_segment *lseg,
618 struct nfs_commit_info *cinfo,
619 u32 ds_commit_idx);
620 void nfs_commitdata_release(struct nfs_commit_data *data);
621 void nfs_request_add_commit_list(struct nfs_page *req,
622 struct nfs_commit_info *cinfo);
623 void nfs_request_add_commit_list_locked(struct nfs_page *req,
624 struct list_head *dst,
625 struct nfs_commit_info *cinfo);
626 void nfs_request_remove_commit_list(struct nfs_page *req,
627 struct nfs_commit_info *cinfo);
628 void nfs_init_cinfo(struct nfs_commit_info *cinfo,
629 struct inode *inode,
630 struct nfs_direct_req *dreq);
631 int nfs_key_timeout_notify(struct file *filp, struct inode *inode);
632 bool nfs_ctx_key_to_expire(struct nfs_open_context *ctx, struct inode *inode);
633 void nfs_pageio_stop_mirroring(struct nfs_pageio_descriptor *pgio);
634
635 int nfs_filemap_write_and_wait_range(struct address_space *mapping,
636 loff_t lstart, loff_t lend);
637
638 #ifdef CONFIG_NFS_V4
639 static inline void
pnfs_bucket_clear_pnfs_ds_commit_verifiers(struct pnfs_commit_bucket * buckets,unsigned int nbuckets)640 pnfs_bucket_clear_pnfs_ds_commit_verifiers(struct pnfs_commit_bucket *buckets,
641 unsigned int nbuckets)
642 {
643 unsigned int i;
644
645 for (i = 0; i < nbuckets; i++)
646 buckets[i].direct_verf.committed = NFS_INVALID_STABLE_HOW;
647 }
648 static inline
nfs_clear_pnfs_ds_commit_verifiers(struct pnfs_ds_commit_info * cinfo)649 void nfs_clear_pnfs_ds_commit_verifiers(struct pnfs_ds_commit_info *cinfo)
650 {
651 struct pnfs_commit_array *array;
652
653 rcu_read_lock();
654 list_for_each_entry_rcu(array, &cinfo->commits, cinfo_list)
655 pnfs_bucket_clear_pnfs_ds_commit_verifiers(array->buckets,
656 array->nbuckets);
657 rcu_read_unlock();
658 }
659 #else /* CONFIG_NFS_V4 */
660 static inline
nfs_clear_pnfs_ds_commit_verifiers(struct pnfs_ds_commit_info * cinfo)661 void nfs_clear_pnfs_ds_commit_verifiers(struct pnfs_ds_commit_info *cinfo)
662 {
663 }
664 #endif /* CONFIG_NFS_V4 */
665
666 #ifdef CONFIG_MIGRATION
667 int nfs_migrate_folio(struct address_space *, struct folio *dst,
668 struct folio *src, enum migrate_mode);
669 #else
670 #define nfs_migrate_folio NULL
671 #endif
672
673 static inline int
nfs_write_verifier_cmp(const struct nfs_write_verifier * v1,const struct nfs_write_verifier * v2)674 nfs_write_verifier_cmp(const struct nfs_write_verifier *v1,
675 const struct nfs_write_verifier *v2)
676 {
677 return memcmp(v1->data, v2->data, sizeof(v1->data));
678 }
679
680 static inline bool
nfs_write_match_verf(const struct nfs_writeverf * verf,struct nfs_page * req)681 nfs_write_match_verf(const struct nfs_writeverf *verf,
682 struct nfs_page *req)
683 {
684 return verf->committed > NFS_UNSTABLE &&
685 !nfs_write_verifier_cmp(&req->wb_verf, &verf->verifier);
686 }
687
nfs_io_gfp_mask(void)688 static inline gfp_t nfs_io_gfp_mask(void)
689 {
690 gfp_t ret = current_gfp_context(GFP_KERNEL);
691
692 /* For workers __GFP_NORETRY only with __GFP_IO or __GFP_FS */
693 if ((current->flags & PF_WQ_WORKER) && ret == GFP_KERNEL)
694 ret |= __GFP_NORETRY | __GFP_NOWARN;
695 return ret;
696 }
697
698 /*
699 * Special version of should_remove_suid() that ignores capabilities.
700 */
nfs_should_remove_suid(const struct inode * inode)701 static inline int nfs_should_remove_suid(const struct inode *inode)
702 {
703 umode_t mode = inode->i_mode;
704 int kill = 0;
705
706 /* suid always must be killed */
707 if (unlikely(mode & S_ISUID))
708 kill = ATTR_KILL_SUID;
709
710 /*
711 * sgid without any exec bits is just a mandatory locking mark; leave
712 * it alone. If some exec bits are set, it's a real sgid; kill it.
713 */
714 if (unlikely((mode & S_ISGID) && (mode & S_IXGRP)))
715 kill |= ATTR_KILL_SGID;
716
717 if (unlikely(kill && S_ISREG(mode)))
718 return kill;
719
720 return 0;
721 }
722
723 /* unlink.c */
724 extern struct rpc_task *
725 nfs_async_rename(struct inode *old_dir, struct inode *new_dir,
726 struct dentry *old_dentry, struct dentry *new_dentry,
727 void (*complete)(struct rpc_task *, struct nfs_renamedata *));
728 extern int nfs_sillyrename(struct inode *dir, struct dentry *dentry);
729
730 /* direct.c */
731 void nfs_init_cinfo_from_dreq(struct nfs_commit_info *cinfo,
732 struct nfs_direct_req *dreq);
733 extern ssize_t nfs_dreq_bytes_left(struct nfs_direct_req *dreq, loff_t offset);
734
735 /* nfs4proc.c */
736 extern struct nfs_client *nfs4_init_client(struct nfs_client *clp,
737 const struct nfs_client_initdata *);
738 extern int nfs41_walk_client_list(struct nfs_client *clp,
739 struct nfs_client **result,
740 const struct cred *cred);
741 extern void nfs4_test_session_trunk(struct rpc_clnt *clnt,
742 struct rpc_xprt *xprt,
743 void *data);
744
nfs_igrab_and_active(struct inode * inode)745 static inline struct inode *nfs_igrab_and_active(struct inode *inode)
746 {
747 struct super_block *sb = inode->i_sb;
748
749 if (sb && nfs_sb_active(sb)) {
750 if (igrab(inode))
751 return inode;
752 nfs_sb_deactive(sb);
753 }
754 return NULL;
755 }
756
nfs_iput_and_deactive(struct inode * inode)757 static inline void nfs_iput_and_deactive(struct inode *inode)
758 {
759 if (inode != NULL) {
760 struct super_block *sb = inode->i_sb;
761
762 iput(inode);
763 nfs_sb_deactive(sb);
764 }
765 }
766
767 /*
768 * Determine the device name as a string
769 */
nfs_devname(struct dentry * dentry,char * buffer,ssize_t buflen)770 static inline char *nfs_devname(struct dentry *dentry,
771 char *buffer, ssize_t buflen)
772 {
773 char *dummy;
774 return nfs_path(&dummy, dentry, buffer, buflen, NFS_PATH_CANONICAL);
775 }
776
777 /*
778 * Determine the actual block size (and log2 thereof)
779 */
780 static inline
nfs_block_bits(unsigned long bsize,unsigned char * nrbitsp)781 unsigned long nfs_block_bits(unsigned long bsize, unsigned char *nrbitsp)
782 {
783 /* make sure blocksize is a power of two */
784 if ((bsize & (bsize - 1)) || nrbitsp) {
785 unsigned char nrbits;
786
787 for (nrbits = 31; nrbits && !(bsize & (1UL << nrbits)); nrbits--)
788 ;
789 bsize = 1UL << nrbits;
790 if (nrbitsp)
791 *nrbitsp = nrbits;
792 }
793
794 return bsize;
795 }
796
797 /*
798 * Calculate the number of 512byte blocks used.
799 */
nfs_calc_block_size(u64 tsize)800 static inline blkcnt_t nfs_calc_block_size(u64 tsize)
801 {
802 blkcnt_t used = (tsize + 511) >> 9;
803 return (used > ULONG_MAX) ? ULONG_MAX : used;
804 }
805
806 /*
807 * Compute and set NFS server blocksize
808 */
809 static inline
nfs_block_size(unsigned long bsize,unsigned char * nrbitsp)810 unsigned long nfs_block_size(unsigned long bsize, unsigned char *nrbitsp)
811 {
812 if (bsize < NFS_MIN_FILE_IO_SIZE)
813 bsize = NFS_DEF_FILE_IO_SIZE;
814 else if (bsize >= NFS_MAX_FILE_IO_SIZE)
815 bsize = NFS_MAX_FILE_IO_SIZE;
816
817 return nfs_block_bits(bsize, nrbitsp);
818 }
819
820 /*
821 * Compute and set NFS server rsize / wsize
822 */
823 static inline
nfs_io_size(unsigned long iosize,enum xprt_transports proto)824 unsigned long nfs_io_size(unsigned long iosize, enum xprt_transports proto)
825 {
826 if (iosize < NFS_MIN_FILE_IO_SIZE)
827 iosize = NFS_DEF_FILE_IO_SIZE;
828 else if (iosize >= NFS_MAX_FILE_IO_SIZE)
829 iosize = NFS_MAX_FILE_IO_SIZE;
830
831 if (proto == XPRT_TRANSPORT_UDP || iosize < PAGE_SIZE)
832 return nfs_block_bits(iosize, NULL);
833 return iosize & PAGE_MASK;
834 }
835
836 /*
837 * Determine the maximum file size for a superblock
838 */
839 static inline
nfs_super_set_maxbytes(struct super_block * sb,__u64 maxfilesize)840 void nfs_super_set_maxbytes(struct super_block *sb, __u64 maxfilesize)
841 {
842 sb->s_maxbytes = (loff_t)maxfilesize;
843 if (sb->s_maxbytes > MAX_LFS_FILESIZE || sb->s_maxbytes <= 0)
844 sb->s_maxbytes = MAX_LFS_FILESIZE;
845 }
846
847 /*
848 * Record the page as unstable (an extra writeback period) and mark its
849 * inode as dirty.
850 */
nfs_folio_mark_unstable(struct folio * folio,struct nfs_commit_info * cinfo)851 static inline void nfs_folio_mark_unstable(struct folio *folio,
852 struct nfs_commit_info *cinfo)
853 {
854 if (folio && !cinfo->dreq) {
855 struct inode *inode = folio->mapping->host;
856 long nr = folio_nr_pages(folio);
857
858 /* This page is really still in write-back - just that the
859 * writeback is happening on the server now.
860 */
861 node_stat_mod_folio(folio, NR_WRITEBACK, nr);
862 wb_stat_mod(&inode_to_bdi(inode)->wb, WB_WRITEBACK, nr);
863 __mark_inode_dirty(inode, I_DIRTY_DATASYNC);
864 }
865 }
866
867 /*
868 * Determine the number of bytes of data the page contains
869 */
nfs_folio_length(struct folio * folio)870 static inline size_t nfs_folio_length(struct folio *folio)
871 {
872 loff_t i_size = i_size_read(folio->mapping->host);
873
874 if (i_size > 0) {
875 pgoff_t index = folio->index >> folio_order(folio);
876 pgoff_t end_index = (i_size - 1) >> folio_shift(folio);
877 if (index < end_index)
878 return folio_size(folio);
879 if (index == end_index)
880 return offset_in_folio(folio, i_size - 1) + 1;
881 }
882 return 0;
883 }
884
885 /*
886 * Convert a umode to a dirent->d_type
887 */
888 static inline
nfs_umode_to_dtype(umode_t mode)889 unsigned char nfs_umode_to_dtype(umode_t mode)
890 {
891 return (mode >> 12) & 15;
892 }
893
894 /*
895 * Determine the number of pages in an array of length 'len' and
896 * with a base offset of 'base'
897 */
nfs_page_array_len(unsigned int base,size_t len)898 static inline unsigned int nfs_page_array_len(unsigned int base, size_t len)
899 {
900 return ((unsigned long)len + (unsigned long)base + PAGE_SIZE - 1) >>
901 PAGE_SHIFT;
902 }
903
904 /*
905 * Convert a struct timespec64 into a 64-bit change attribute
906 *
907 * This does approximately the same thing as timespec64_to_ns(),
908 * but for calculation efficiency, we multiply the seconds by
909 * 1024*1024*1024.
910 */
911 static inline
nfs_timespec_to_change_attr(const struct timespec64 * ts)912 u64 nfs_timespec_to_change_attr(const struct timespec64 *ts)
913 {
914 return ((u64)ts->tv_sec << 30) + ts->tv_nsec;
915 }
916
nfs_stateid_hash(const nfs4_stateid * stateid)917 static inline u32 nfs_stateid_hash(const nfs4_stateid *stateid)
918 {
919 return ~crc32_le(0xFFFFFFFF, &stateid->other[0],
920 NFS4_STATEID_OTHER_SIZE);
921 }
922
nfs_current_task_exiting(void)923 static inline bool nfs_current_task_exiting(void)
924 {
925 return (current->flags & PF_EXITING) != 0;
926 }
927
nfs_error_is_fatal(int err)928 static inline bool nfs_error_is_fatal(int err)
929 {
930 switch (err) {
931 case -ERESTARTSYS:
932 case -EINTR:
933 case -EACCES:
934 case -EDQUOT:
935 case -EFBIG:
936 case -EIO:
937 case -ENOSPC:
938 case -EROFS:
939 case -ESTALE:
940 case -E2BIG:
941 case -ENOMEM:
942 case -ETIMEDOUT:
943 return true;
944 default:
945 return false;
946 }
947 }
948
nfs_error_is_fatal_on_server(int err)949 static inline bool nfs_error_is_fatal_on_server(int err)
950 {
951 switch (err) {
952 case 0:
953 case -ERESTARTSYS:
954 case -EINTR:
955 case -ENOMEM:
956 return false;
957 }
958 return nfs_error_is_fatal(err);
959 }
960
961 /*
962 * Select between a default port value and a user-specified port value.
963 * If a zero value is set, then autobind will be used.
964 */
nfs_set_port(struct sockaddr_storage * sap,int * port,const unsigned short default_port)965 static inline void nfs_set_port(struct sockaddr_storage *sap, int *port,
966 const unsigned short default_port)
967 {
968 if (*port == NFS_UNSPEC_PORT)
969 *port = default_port;
970
971 rpc_set_port((struct sockaddr *)sap, *port);
972 }
973
974 struct nfs_direct_req {
975 struct kref kref; /* release manager */
976
977 /* I/O parameters */
978 struct nfs_open_context *ctx; /* file open context info */
979 struct nfs_lock_context *l_ctx; /* Lock context info */
980 struct kiocb * iocb; /* controlling i/o request */
981 struct inode * inode; /* target file of i/o */
982
983 /* completion state */
984 atomic_t io_count; /* i/os we're waiting for */
985 spinlock_t lock; /* protect completion state */
986
987 loff_t io_start; /* Start offset for I/O */
988 ssize_t count, /* bytes actually processed */
989 max_count, /* max expected count */
990 error; /* any reported error */
991 struct completion completion; /* wait for i/o completion */
992
993 /* commit state */
994 struct nfs_mds_commit_info mds_cinfo; /* Storage for cinfo */
995 struct pnfs_ds_commit_info ds_cinfo; /* Storage for cinfo */
996 struct work_struct work;
997 int flags;
998 /* for write */
999 #define NFS_ODIRECT_DO_COMMIT (1) /* an unstable reply was received */
1000 #define NFS_ODIRECT_RESCHED_WRITES (2) /* write verification failed */
1001 /* for read */
1002 #define NFS_ODIRECT_SHOULD_DIRTY (3) /* dirty user-space page after read */
1003 #define NFS_ODIRECT_DONE INT_MAX /* write verification failed */
1004 };
1005