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