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