WIP FPC-III support
[linux/fpc-iii.git] / fs / nfs / internal.h
blobb840d0a91c9d8f2d7f704eb2ab1b1eb311dc1539
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3 * NFS internal definitions
4 */
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>
14 #define NFS_SB_MASK (SB_RDONLY|SB_NOSUID|SB_NODEV|SB_NOEXEC|SB_SYNCHRONOUS)
16 extern const struct export_operations nfs_export_ops;
18 struct nfs_string;
19 struct nfs_pageio_descriptor;
21 static inline void nfs_attr_check_mountpoint(struct super_block *parent, struct nfs_fattr *fattr)
23 if (!nfs_fsid_equal(&NFS_SB(parent)->fsid, &fattr->fsid))
24 fattr->valid |= NFS_ATTR_FATTR_MOUNTPOINT;
27 static inline int nfs_attr_use_mounted_on_fileid(struct nfs_fattr *fattr)
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;
36 static inline bool nfs_lookup_is_soft_revalidate(const struct dentry *dentry)
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;
46 * Note: RFC 1813 doesn't limit the number of auth flavors that
47 * a server can return, so make something up.
49 #define NFS_MAX_SECFLAVORS (12)
52 * Value used if the user did not specify a port value.
54 #define NFS_UNSPEC_PORT (-1)
56 #define NFS_UNSPEC_RETRANS (UINT_MAX)
57 #define NFS_UNSPEC_TIMEO (UINT_MAX)
59 struct 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;
76 * In-kernel mount arguments
78 struct 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;
100 struct {
101 union {
102 struct sockaddr address;
103 struct sockaddr_storage _address;
105 size_t addrlen;
106 char *hostname;
107 u32 version;
108 int port;
109 unsigned short protocol;
110 } mount_server;
112 struct {
113 union {
114 struct sockaddr address;
115 struct sockaddr_storage _address;
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;
126 struct nfs_fh *mntfh;
127 struct nfs_server *server;
128 struct nfs_subversion *nfs_mod;
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;
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__)
143 static inline struct nfs_fs_context *nfs_fc2context(const struct fs_context *fc)
145 return fc->fs_private;
148 /* mount_clnt.c */
149 struct 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;
163 extern int nfs_mount(struct nfs_mount_request *info);
164 extern void nfs_umount(const struct nfs_mount_request *info);
166 /* client.c */
167 extern const struct rpc_program nfs_program;
168 extern void nfs_clients_init(struct net *net);
169 extern void nfs_clients_exit(struct net *net);
170 extern struct nfs_client *nfs_alloc_client(const struct nfs_client_initdata *);
171 int nfs_create_rpc_client(struct nfs_client *, const struct nfs_client_initdata *, rpc_authflavor_t);
172 struct nfs_client *nfs_get_client(const struct nfs_client_initdata *);
173 int nfs_probe_fsinfo(struct nfs_server *server, struct nfs_fh *, struct nfs_fattr *);
174 void nfs_server_insert_lists(struct nfs_server *);
175 void nfs_server_remove_lists(struct nfs_server *);
176 void nfs_init_timeout_values(struct rpc_timeout *to, int proto, int timeo, int retrans);
177 int nfs_init_server_rpcclient(struct nfs_server *, const struct rpc_timeout *t,
178 rpc_authflavor_t);
179 struct nfs_server *nfs_alloc_server(void);
180 void nfs_server_copy_userdata(struct nfs_server *, struct nfs_server *);
182 extern void nfs_put_client(struct nfs_client *);
183 extern void nfs_free_client(struct nfs_client *);
184 extern struct nfs_client *nfs4_find_client_ident(struct net *, int);
185 extern struct nfs_client *
186 nfs4_find_client_sessionid(struct net *, const struct sockaddr *,
187 struct nfs4_sessionid *, u32);
188 extern struct nfs_server *nfs_create_server(struct fs_context *);
189 extern struct nfs_server *nfs4_create_server(struct fs_context *);
190 extern struct nfs_server *nfs4_create_referral_server(struct fs_context *);
191 extern int nfs4_update_server(struct nfs_server *server, const char *hostname,
192 struct sockaddr *sap, size_t salen,
193 struct net *net);
194 extern void nfs_free_server(struct nfs_server *server);
195 extern struct nfs_server *nfs_clone_server(struct nfs_server *,
196 struct nfs_fh *,
197 struct nfs_fattr *,
198 rpc_authflavor_t);
199 extern bool nfs_client_init_is_complete(const struct nfs_client *clp);
200 extern int nfs_client_init_status(const struct nfs_client *clp);
201 extern int nfs_wait_client_init_complete(const struct nfs_client *clp);
202 extern void nfs_mark_client_ready(struct nfs_client *clp, int state);
203 extern 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);
209 extern struct rpc_clnt *nfs4_find_or_create_ds_client(struct nfs_client *,
210 struct inode *);
211 extern 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
216 extern int __init nfs_fs_proc_init(void);
217 extern void nfs_fs_proc_exit(void);
218 extern int nfs_fs_proc_net_init(struct net *net);
219 extern void nfs_fs_proc_net_exit(struct net *net);
220 #else
221 static inline int nfs_fs_proc_net_init(struct net *net)
223 return 0;
225 static inline void nfs_fs_proc_net_exit(struct net *net)
228 static inline int nfs_fs_proc_init(void)
230 return 0;
232 static inline void nfs_fs_proc_exit(void)
235 #endif
237 /* callback_xdr.c */
238 extern const struct svc_version nfs4_callback_version1;
239 extern const struct svc_version nfs4_callback_version4;
241 /* fs_context.c */
242 extern struct file_system_type nfs_fs_type;
244 /* pagelist.c */
245 extern int __init nfs_init_nfspagecache(void);
246 extern void nfs_destroy_nfspagecache(void);
247 extern int __init nfs_init_readpagecache(void);
248 extern void nfs_destroy_readpagecache(void);
249 extern int __init nfs_init_writepagecache(void);
250 extern void nfs_destroy_writepagecache(void);
252 extern int __init nfs_init_directcache(void);
253 extern void nfs_destroy_directcache(void);
254 extern void nfs_pgheader_init(struct nfs_pageio_descriptor *desc,
255 struct nfs_pgio_header *hdr,
256 void (*release)(struct nfs_pgio_header *hdr));
257 void nfs_set_pgio_error(struct nfs_pgio_header *hdr, int error, loff_t pos);
258 int nfs_iocounter_wait(struct nfs_lock_context *l_ctx);
260 extern const struct nfs_pageio_ops nfs_pgio_rw_ops;
261 struct nfs_pgio_header *nfs_pgio_header_alloc(const struct nfs_rw_ops *);
262 void nfs_pgio_header_free(struct nfs_pgio_header *);
263 int nfs_generic_pgio(struct nfs_pageio_descriptor *, struct nfs_pgio_header *);
264 int 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);
267 void nfs_free_request(struct nfs_page *req);
268 struct nfs_pgio_mirror *
269 nfs_pgio_current_mirror(struct nfs_pageio_descriptor *desc);
271 static inline bool nfs_match_open_context(const struct nfs_open_context *ctx1,
272 const struct nfs_open_context *ctx2)
274 return cred_fscmp(ctx1->cred, ctx2->cred) == 0 && ctx1->state == ctx2->state;
277 /* nfs2xdr.c */
278 extern const struct rpc_procinfo nfs_procedures[];
279 extern int nfs2_decode_dirent(struct xdr_stream *,
280 struct nfs_entry *, bool);
282 /* nfs3xdr.c */
283 extern const struct rpc_procinfo nfs3_procedures[];
284 extern int nfs3_decode_dirent(struct xdr_stream *,
285 struct nfs_entry *, bool);
287 /* nfs4xdr.c */
288 #if IS_ENABLED(CONFIG_NFS_V4)
289 extern int nfs4_decode_dirent(struct xdr_stream *,
290 struct nfs_entry *, bool);
291 #endif
292 #ifdef CONFIG_NFS_V4_1
293 extern const u32 nfs41_maxread_overhead;
294 extern const u32 nfs41_maxwrite_overhead;
295 extern const u32 nfs41_maxgetdevinfo_overhead;
296 #endif
298 /* nfs4proc.c */
299 #if IS_ENABLED(CONFIG_NFS_V4)
300 extern const struct rpc_procinfo nfs4_procedures[];
301 #endif
303 #ifdef CONFIG_NFS_V4_SECURITY_LABEL
304 extern struct nfs4_label *nfs4_label_alloc(struct nfs_server *server, gfp_t flags);
305 static inline struct nfs4_label *
306 nfs4_label_copy(struct nfs4_label *dst, struct nfs4_label *src)
308 if (!dst || !src)
309 return NULL;
311 if (src->len > NFS4_MAXLABELLEN)
312 return NULL;
314 dst->lfs = src->lfs;
315 dst->pi = src->pi;
316 dst->len = src->len;
317 memcpy(dst->label, src->label, src->len);
319 return dst;
321 static inline void nfs4_label_free(struct nfs4_label *label)
323 if (label) {
324 kfree(label->label);
325 kfree(label);
327 return;
330 static inline void nfs_zap_label_cache_locked(struct nfs_inode *nfsi)
332 if (nfs_server_capable(&nfsi->vfs_inode, NFS_CAP_SECURITY_LABEL))
333 nfsi->cache_validity |= NFS_INO_INVALID_LABEL;
335 #else
336 static inline struct nfs4_label *nfs4_label_alloc(struct nfs_server *server, gfp_t flags) { return NULL; }
337 static inline void nfs4_label_free(void *label) {}
338 static inline void nfs_zap_label_cache_locked(struct nfs_inode *nfsi)
341 static inline struct nfs4_label *
342 nfs4_label_copy(struct nfs4_label *dst, struct nfs4_label *src)
344 return NULL;
346 #endif /* CONFIG_NFS_V4_SECURITY_LABEL */
348 /* proc.c */
349 void nfs_close_context(struct nfs_open_context *ctx, int is_sync);
350 extern struct nfs_client *nfs_init_client(struct nfs_client *clp,
351 const struct nfs_client_initdata *);
353 /* dir.c */
354 extern void nfs_advise_use_readdirplus(struct inode *dir);
355 extern void nfs_force_use_readdirplus(struct inode *dir);
356 extern unsigned long nfs_access_cache_count(struct shrinker *shrink,
357 struct shrink_control *sc);
358 extern unsigned long nfs_access_cache_scan(struct shrinker *shrink,
359 struct shrink_control *sc);
360 struct dentry *nfs_lookup(struct inode *, struct dentry *, unsigned int);
361 int nfs_create(struct inode *, struct dentry *, umode_t, bool);
362 int nfs_mkdir(struct inode *, struct dentry *, umode_t);
363 int nfs_rmdir(struct inode *, struct dentry *);
364 int nfs_unlink(struct inode *, struct dentry *);
365 int nfs_symlink(struct inode *, struct dentry *, const char *);
366 int nfs_link(struct dentry *, struct inode *, struct dentry *);
367 int nfs_mknod(struct inode *, struct dentry *, umode_t, dev_t);
368 int nfs_rename(struct inode *, struct dentry *,
369 struct inode *, struct dentry *, unsigned int);
371 /* file.c */
372 int nfs_file_fsync(struct file *file, loff_t start, loff_t end, int datasync);
373 loff_t nfs_file_llseek(struct file *, loff_t, int);
374 ssize_t nfs_file_read(struct kiocb *, struct iov_iter *);
375 int nfs_file_mmap(struct file *, struct vm_area_struct *);
376 ssize_t nfs_file_write(struct kiocb *, struct iov_iter *);
377 int nfs_file_release(struct inode *, struct file *);
378 int nfs_lock(struct file *, int, struct file_lock *);
379 int nfs_flock(struct file *, int, struct file_lock *);
380 int nfs_check_flags(int);
382 /* inode.c */
383 extern struct workqueue_struct *nfsiod_workqueue;
384 extern struct inode *nfs_alloc_inode(struct super_block *sb);
385 extern void nfs_free_inode(struct inode *);
386 extern int nfs_write_inode(struct inode *, struct writeback_control *);
387 extern int nfs_drop_inode(struct inode *);
388 extern void nfs_clear_inode(struct inode *);
389 extern void nfs_evict_inode(struct inode *);
390 void nfs_zap_acl_cache(struct inode *inode);
391 extern bool nfs_check_cache_invalid(struct inode *, unsigned long);
392 extern int nfs_wait_bit_killable(struct wait_bit_key *key, int mode);
393 extern int nfs_wait_atomic_killable(atomic_t *p, unsigned int mode);
395 /* super.c */
396 extern const struct super_operations nfs_sops;
397 bool nfs_auth_info_match(const struct nfs_auth_info *, rpc_authflavor_t);
398 int nfs_try_get_tree(struct fs_context *);
399 int nfs_get_tree_common(struct fs_context *);
400 void nfs_kill_super(struct super_block *);
402 extern struct rpc_stat nfs_rpcstat;
404 extern int __init register_nfs_fs(void);
405 extern void __exit unregister_nfs_fs(void);
406 extern bool nfs_sb_active(struct super_block *sb);
407 extern void nfs_sb_deactive(struct super_block *sb);
408 extern int nfs_client_for_each_server(struct nfs_client *clp,
409 int (*fn)(struct nfs_server *, void *),
410 void *data);
411 /* io.c */
412 extern void nfs_start_io_read(struct inode *inode);
413 extern void nfs_end_io_read(struct inode *inode);
414 extern void nfs_start_io_write(struct inode *inode);
415 extern void nfs_end_io_write(struct inode *inode);
416 extern void nfs_start_io_direct(struct inode *inode);
417 extern void nfs_end_io_direct(struct inode *inode);
419 static inline bool nfs_file_io_is_buffered(struct nfs_inode *nfsi)
421 return test_bit(NFS_INO_ODIRECT, &nfsi->flags) == 0;
424 /* namespace.c */
425 #define NFS_PATH_CANONICAL 1
426 extern char *nfs_path(char **p, struct dentry *dentry,
427 char *buffer, ssize_t buflen, unsigned flags);
428 extern struct vfsmount *nfs_d_automount(struct path *path);
429 int nfs_submount(struct fs_context *, struct nfs_server *);
430 int nfs_do_submount(struct fs_context *);
432 /* getroot.c */
433 extern int nfs_get_root(struct super_block *s, struct fs_context *fc);
434 #if IS_ENABLED(CONFIG_NFS_V4)
435 extern int nfs4_get_rootfh(struct nfs_server *server, struct nfs_fh *mntfh, bool);
436 #endif
438 struct nfs_pgio_completion_ops;
439 /* read.c */
440 extern 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);
443 extern void nfs_read_prepare(struct rpc_task *task, void *calldata);
444 extern void nfs_pageio_reset_read_mds(struct nfs_pageio_descriptor *pgio);
446 /* super.c */
447 void nfs_umount_begin(struct super_block *);
448 int nfs_statfs(struct dentry *, struct kstatfs *);
449 int nfs_show_options(struct seq_file *, struct dentry *);
450 int nfs_show_devname(struct seq_file *, struct dentry *);
451 int nfs_show_path(struct seq_file *, struct dentry *);
452 int nfs_show_stats(struct seq_file *, struct dentry *);
453 int nfs_reconfigure(struct fs_context *);
455 /* write.c */
456 extern 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);
459 extern void nfs_pageio_reset_write_mds(struct nfs_pageio_descriptor *pgio);
460 extern void nfs_commit_free(struct nfs_commit_data *p);
461 extern void nfs_write_prepare(struct rpc_task *task, void *calldata);
462 extern void nfs_commit_prepare(struct rpc_task *task, void *calldata);
463 extern 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);
468 extern 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);
472 int nfs_scan_commit_list(struct list_head *src, struct list_head *dst,
473 struct nfs_commit_info *cinfo, int max);
474 unsigned long nfs_reqs_to_commit(struct nfs_commit_info *);
475 int nfs_scan_commit(struct inode *inode, struct list_head *dst,
476 struct nfs_commit_info *cinfo);
477 void 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);
481 int nfs_write_need_commit(struct nfs_pgio_header *);
482 void nfs_writeback_update_inode(struct nfs_pgio_header *hdr);
483 int nfs_generic_commit_list(struct inode *inode, struct list_head *head,
484 int how, struct nfs_commit_info *cinfo);
485 void 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);
489 void nfs_commitdata_release(struct nfs_commit_data *data);
490 void nfs_request_add_commit_list(struct nfs_page *req,
491 struct nfs_commit_info *cinfo);
492 void nfs_request_add_commit_list_locked(struct nfs_page *req,
493 struct list_head *dst,
494 struct nfs_commit_info *cinfo);
495 void nfs_request_remove_commit_list(struct nfs_page *req,
496 struct nfs_commit_info *cinfo);
497 void nfs_init_cinfo(struct nfs_commit_info *cinfo,
498 struct inode *inode,
499 struct nfs_direct_req *dreq);
500 int nfs_key_timeout_notify(struct file *filp, struct inode *inode);
501 bool nfs_ctx_key_to_expire(struct nfs_open_context *ctx, struct inode *inode);
502 void nfs_pageio_stop_mirroring(struct nfs_pageio_descriptor *pgio);
504 int nfs_filemap_write_and_wait_range(struct address_space *mapping,
505 loff_t lstart, loff_t lend);
507 #ifdef CONFIG_NFS_V4_1
508 static inline void
509 pnfs_bucket_clear_pnfs_ds_commit_verifiers(struct pnfs_commit_bucket *buckets,
510 unsigned int nbuckets)
512 unsigned int i;
514 for (i = 0; i < nbuckets; i++)
515 buckets[i].direct_verf.committed = NFS_INVALID_STABLE_HOW;
517 static inline
518 void nfs_clear_pnfs_ds_commit_verifiers(struct pnfs_ds_commit_info *cinfo)
520 struct pnfs_commit_array *array;
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();
528 #else
529 static inline
530 void nfs_clear_pnfs_ds_commit_verifiers(struct pnfs_ds_commit_info *cinfo)
533 #endif
535 #ifdef CONFIG_MIGRATION
536 extern int nfs_migrate_page(struct address_space *,
537 struct page *, struct page *, enum migrate_mode);
538 #endif
540 static inline int
541 nfs_write_verifier_cmp(const struct nfs_write_verifier *v1,
542 const struct nfs_write_verifier *v2)
544 return memcmp(v1->data, v2->data, sizeof(v1->data));
547 static inline bool
548 nfs_write_match_verf(const struct nfs_writeverf *verf,
549 struct nfs_page *req)
551 return verf->committed > NFS_UNSTABLE &&
552 !nfs_write_verifier_cmp(&req->wb_verf, &verf->verifier);
555 /* unlink.c */
556 extern struct rpc_task *
557 nfs_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 *));
560 extern int nfs_sillyrename(struct inode *dir, struct dentry *dentry);
562 /* direct.c */
563 void nfs_init_cinfo_from_dreq(struct nfs_commit_info *cinfo,
564 struct nfs_direct_req *dreq);
565 extern ssize_t nfs_dreq_bytes_left(struct nfs_direct_req *dreq);
567 /* nfs4proc.c */
568 extern struct nfs_client *nfs4_init_client(struct nfs_client *clp,
569 const struct nfs_client_initdata *);
570 extern int nfs40_walk_client_list(struct nfs_client *clp,
571 struct nfs_client **result,
572 const struct cred *cred);
573 extern int nfs41_walk_client_list(struct nfs_client *clp,
574 struct nfs_client **result,
575 const struct cred *cred);
576 extern void nfs4_test_session_trunk(struct rpc_clnt *clnt,
577 struct rpc_xprt *xprt,
578 void *data);
580 static inline struct inode *nfs_igrab_and_active(struct inode *inode)
582 inode = igrab(inode);
583 if (inode != NULL && !nfs_sb_active(inode->i_sb)) {
584 iput(inode);
585 inode = NULL;
587 return inode;
590 static inline void nfs_iput_and_deactive(struct inode *inode)
592 if (inode != NULL) {
593 struct super_block *sb = inode->i_sb;
595 iput(inode);
596 nfs_sb_deactive(sb);
601 * Determine the device name as a string
603 static inline char *nfs_devname(struct dentry *dentry,
604 char *buffer, ssize_t buflen)
606 char *dummy;
607 return nfs_path(&dummy, dentry, buffer, buflen, NFS_PATH_CANONICAL);
611 * Determine the actual block size (and log2 thereof)
613 static inline
614 unsigned long nfs_block_bits(unsigned long bsize, unsigned char *nrbitsp)
616 /* make sure blocksize is a power of two */
617 if ((bsize & (bsize - 1)) || nrbitsp) {
618 unsigned char nrbits;
620 for (nrbits = 31; nrbits && !(bsize & (1 << nrbits)); nrbits--)
622 bsize = 1 << nrbits;
623 if (nrbitsp)
624 *nrbitsp = nrbits;
627 return bsize;
631 * Calculate the number of 512byte blocks used.
633 static inline blkcnt_t nfs_calc_block_size(u64 tsize)
635 blkcnt_t used = (tsize + 511) >> 9;
636 return (used > ULONG_MAX) ? ULONG_MAX : used;
640 * Compute and set NFS server blocksize
642 static inline
643 unsigned long nfs_block_size(unsigned long bsize, unsigned char *nrbitsp)
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;
650 return nfs_block_bits(bsize, nrbitsp);
654 * Determine the maximum file size for a superblock
656 static inline
657 void nfs_super_set_maxbytes(struct super_block *sb, __u64 maxfilesize)
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;
665 * Record the page as unstable (an extra writeback period) and mark its
666 * inode as dirty.
668 static inline
669 void nfs_mark_page_unstable(struct page *page, struct nfs_commit_info *cinfo)
671 if (!cinfo->dreq) {
672 struct inode *inode = page_file_mapping(page)->host;
674 /* This page is really still in write-back - just that the
675 * writeback is happening on the server now.
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);
684 * Determine the number of bytes of data the page contains
686 static inline
687 unsigned int nfs_page_length(struct page *page)
689 loff_t i_size = i_size_read(page_file_mapping(page)->host);
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;
699 return 0;
703 * Convert a umode to a dirent->d_type
705 static inline
706 unsigned char nfs_umode_to_dtype(umode_t mode)
708 return (mode >> 12) & 15;
712 * Determine the number of pages in an array of length 'len' and
713 * with a base offset of 'base'
715 static inline
716 unsigned int nfs_page_array_len(unsigned int base, size_t len)
718 return ((unsigned long)len + (unsigned long)base +
719 PAGE_SIZE - 1) >> PAGE_SHIFT;
723 * Convert a struct timespec64 into a 64-bit change attribute
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.
729 static inline
730 u64 nfs_timespec_to_change_attr(const struct timespec64 *ts)
732 return ((u64)ts->tv_sec << 30) + ts->tv_nsec;
735 #ifdef CONFIG_CRC32
737 * nfs_fhandle_hash - calculate the crc32 hash for the filehandle
738 * @fh - pointer to filehandle
740 * returns a crc32 hash for the filehandle that is compatible with
741 * the one displayed by "wireshark".
743 static inline u32 nfs_fhandle_hash(const struct nfs_fh *fh)
745 return ~crc32_le(0xFFFFFFFF, &fh->data[0], fh->size);
747 static inline u32 nfs_stateid_hash(const nfs4_stateid *stateid)
749 return ~crc32_le(0xFFFFFFFF, &stateid->other[0],
750 NFS4_STATEID_OTHER_SIZE);
752 #else
753 static inline u32 nfs_fhandle_hash(const struct nfs_fh *fh)
755 return 0;
757 static inline u32 nfs_stateid_hash(nfs4_stateid *stateid)
759 return 0;
761 #endif
763 static inline bool nfs_error_is_fatal(int err)
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;
784 static inline bool nfs_error_is_fatal_on_server(int err)
786 switch (err) {
787 case 0:
788 case -ERESTARTSYS:
789 case -EINTR:
790 return false;
792 return nfs_error_is_fatal(err);
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.
799 static inline void nfs_set_port(struct sockaddr *sap, int *port,
800 const unsigned short default_port)
802 if (*port == NFS_UNSPEC_PORT)
803 *port = default_port;
805 rpc_set_port(sap, *port);