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