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