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