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