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