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