2 * linux/fs/nfsd/nfsctl.c
4 * Syscall interface to knfsd.
6 * Copyright (C) 1995, 1996 Olaf Kirch <okir@monad.swb.de>
9 #include <linux/module.h>
11 #include <linux/linkage.h>
12 #include <linux/time.h>
13 #include <linux/errno.h>
15 #include <linux/namei.h>
16 #include <linux/fcntl.h>
17 #include <linux/net.h>
19 #include <linux/syscalls.h>
20 #include <linux/unistd.h>
21 #include <linux/slab.h>
22 #include <linux/proc_fs.h>
23 #include <linux/seq_file.h>
24 #include <linux/pagemap.h>
25 #include <linux/init.h>
26 #include <linux/inet.h>
27 #include <linux/string.h>
28 #include <linux/smp_lock.h>
29 #include <linux/ctype.h>
31 #include <linux/nfs.h>
32 #include <linux/nfsd_idmap.h>
33 #include <linux/lockd/bind.h>
34 #include <linux/sunrpc/svc.h>
35 #include <linux/sunrpc/svcsock.h>
36 #include <linux/nfsd/nfsd.h>
37 #include <linux/nfsd/cache.h>
38 #include <linux/nfsd/xdr.h>
39 #include <linux/nfsd/syscall.h>
40 #include <linux/lockd/lockd.h>
42 #include <asm/uaccess.h>
46 * We have a single directory with 9 nodes in it.
67 * The below MUST come last. Otherwise we leave a hole in nfsd_files[]
68 * with !CONFIG_NFSD_V4 and simple_fill_super() goes oops
77 * write() for these nodes.
79 static ssize_t
write_svc(struct file
*file
, char *buf
, size_t size
);
80 static ssize_t
write_add(struct file
*file
, char *buf
, size_t size
);
81 static ssize_t
write_del(struct file
*file
, char *buf
, size_t size
);
82 static ssize_t
write_export(struct file
*file
, char *buf
, size_t size
);
83 static ssize_t
write_unexport(struct file
*file
, char *buf
, size_t size
);
84 static ssize_t
write_getfd(struct file
*file
, char *buf
, size_t size
);
85 static ssize_t
write_getfs(struct file
*file
, char *buf
, size_t size
);
86 static ssize_t
write_filehandle(struct file
*file
, char *buf
, size_t size
);
87 static ssize_t
write_threads(struct file
*file
, char *buf
, size_t size
);
88 static ssize_t
write_pool_threads(struct file
*file
, char *buf
, size_t size
);
89 static ssize_t
write_versions(struct file
*file
, char *buf
, size_t size
);
90 static ssize_t
write_ports(struct file
*file
, char *buf
, size_t size
);
91 static ssize_t
write_maxblksize(struct file
*file
, char *buf
, size_t size
);
93 static ssize_t
write_leasetime(struct file
*file
, char *buf
, size_t size
);
94 static ssize_t
write_recoverydir(struct file
*file
, char *buf
, size_t size
);
97 static ssize_t
failover_unlock_ip(struct file
*file
, char *buf
, size_t size
);
98 static ssize_t
failover_unlock_fs(struct file
*file
, char *buf
, size_t size
);
100 static ssize_t (*write_op
[])(struct file
*, char *, size_t) = {
101 [NFSD_Svc
] = write_svc
,
102 [NFSD_Add
] = write_add
,
103 [NFSD_Del
] = write_del
,
104 [NFSD_Export
] = write_export
,
105 [NFSD_Unexport
] = write_unexport
,
106 [NFSD_Getfd
] = write_getfd
,
107 [NFSD_Getfs
] = write_getfs
,
108 [NFSD_Fh
] = write_filehandle
,
109 [NFSD_FO_UnlockIP
] = failover_unlock_ip
,
110 [NFSD_FO_UnlockFS
] = failover_unlock_fs
,
111 [NFSD_Threads
] = write_threads
,
112 [NFSD_Pool_Threads
] = write_pool_threads
,
113 [NFSD_Versions
] = write_versions
,
114 [NFSD_Ports
] = write_ports
,
115 [NFSD_MaxBlkSize
] = write_maxblksize
,
116 #ifdef CONFIG_NFSD_V4
117 [NFSD_Leasetime
] = write_leasetime
,
118 [NFSD_RecoveryDir
] = write_recoverydir
,
122 static ssize_t
nfsctl_transaction_write(struct file
*file
, const char __user
*buf
, size_t size
, loff_t
*pos
)
124 ino_t ino
= file
->f_path
.dentry
->d_inode
->i_ino
;
128 if (ino
>= ARRAY_SIZE(write_op
) || !write_op
[ino
])
131 data
= simple_transaction_get(file
, buf
, size
);
133 return PTR_ERR(data
);
135 rv
= write_op
[ino
](file
, data
, size
);
137 simple_transaction_set(file
, rv
);
143 static ssize_t
nfsctl_transaction_read(struct file
*file
, char __user
*buf
, size_t size
, loff_t
*pos
)
145 if (! file
->private_data
) {
146 /* An attempt to read a transaction file without writing
147 * causes a 0-byte write so that the file can return
150 ssize_t rv
= nfsctl_transaction_write(file
, buf
, 0, pos
);
154 return simple_transaction_read(file
, buf
, size
, pos
);
157 static const struct file_operations transaction_ops
= {
158 .write
= nfsctl_transaction_write
,
159 .read
= nfsctl_transaction_read
,
160 .release
= simple_transaction_release
,
163 static int exports_open(struct inode
*inode
, struct file
*file
)
165 return seq_open(file
, &nfs_exports_op
);
168 static const struct file_operations exports_operations
= {
169 .open
= exports_open
,
172 .release
= seq_release
,
173 .owner
= THIS_MODULE
,
176 /*----------------------------------------------------------------------------*/
178 * payload - write methods
179 * If the method has a response, the response should be put in buf,
180 * and the length returned. Otherwise return 0 or and -error.
183 static ssize_t
write_svc(struct file
*file
, char *buf
, size_t size
)
185 struct nfsctl_svc
*data
;
186 if (size
< sizeof(*data
))
188 data
= (struct nfsctl_svc
*) buf
;
189 return nfsd_svc(data
->svc_port
, data
->svc_nthreads
);
192 static ssize_t
write_add(struct file
*file
, char *buf
, size_t size
)
194 struct nfsctl_client
*data
;
195 if (size
< sizeof(*data
))
197 data
= (struct nfsctl_client
*)buf
;
198 return exp_addclient(data
);
201 static ssize_t
write_del(struct file
*file
, char *buf
, size_t size
)
203 struct nfsctl_client
*data
;
204 if (size
< sizeof(*data
))
206 data
= (struct nfsctl_client
*)buf
;
207 return exp_delclient(data
);
210 static ssize_t
write_export(struct file
*file
, char *buf
, size_t size
)
212 struct nfsctl_export
*data
;
213 if (size
< sizeof(*data
))
215 data
= (struct nfsctl_export
*)buf
;
216 return exp_export(data
);
219 static ssize_t
write_unexport(struct file
*file
, char *buf
, size_t size
)
221 struct nfsctl_export
*data
;
223 if (size
< sizeof(*data
))
225 data
= (struct nfsctl_export
*)buf
;
226 return exp_unexport(data
);
229 static ssize_t
write_getfs(struct file
*file
, char *buf
, size_t size
)
231 struct nfsctl_fsparm
*data
;
232 struct sockaddr_in
*sin
;
233 struct auth_domain
*clp
;
235 struct knfsd_fh
*res
;
238 if (size
< sizeof(*data
))
240 data
= (struct nfsctl_fsparm
*)buf
;
241 err
= -EPROTONOSUPPORT
;
242 if (data
->gd_addr
.sa_family
!= AF_INET
)
244 sin
= (struct sockaddr_in
*)&data
->gd_addr
;
245 if (data
->gd_maxlen
> NFS3_FHSIZE
)
246 data
->gd_maxlen
= NFS3_FHSIZE
;
248 res
= (struct knfsd_fh
*)buf
;
252 ipv6_addr_set_v4mapped(sin
->sin_addr
.s_addr
, &in6
);
254 clp
= auth_unix_lookup(&in6
);
258 err
= exp_rootfh(clp
, data
->gd_path
, res
, data
->gd_maxlen
);
259 auth_domain_put(clp
);
263 err
= res
->fh_size
+ offsetof(struct knfsd_fh
, fh_base
);
268 static ssize_t
write_getfd(struct file
*file
, char *buf
, size_t size
)
270 struct nfsctl_fdparm
*data
;
271 struct sockaddr_in
*sin
;
272 struct auth_domain
*clp
;
278 if (size
< sizeof(*data
))
280 data
= (struct nfsctl_fdparm
*)buf
;
281 err
= -EPROTONOSUPPORT
;
282 if (data
->gd_addr
.sa_family
!= AF_INET
)
285 if (data
->gd_version
< 2 || data
->gd_version
> NFSSVC_MAXVERS
)
289 sin
= (struct sockaddr_in
*)&data
->gd_addr
;
292 ipv6_addr_set_v4mapped(sin
->sin_addr
.s_addr
, &in6
);
294 clp
= auth_unix_lookup(&in6
);
298 err
= exp_rootfh(clp
, data
->gd_path
, &fh
, NFS_FHSIZE
);
299 auth_domain_put(clp
);
304 memset(res
,0, NFS_FHSIZE
);
305 memcpy(res
, &fh
.fh_base
, fh
.fh_size
);
312 static ssize_t
failover_unlock_ip(struct file
*file
, char *buf
, size_t size
)
314 struct sockaddr_in sin
= {
315 .sin_family
= AF_INET
,
325 if (buf
[size
-1] != '\n')
329 if (qword_get(&buf
, fo_path
, size
) < 0)
332 /* get ipv4 address */
333 if (sscanf(fo_path
, NIPQUAD_FMT
"%c", &b1
, &b2
, &b3
, &b4
, &c
) != 4)
335 if (b1
> 255 || b2
> 255 || b3
> 255 || b4
> 255)
337 sin
.sin_addr
.s_addr
= htonl((b1
<< 24) | (b2
<< 16) | (b3
<< 8) | b4
);
339 return nlmsvc_unlock_all_by_ip((struct sockaddr
*)&sin
);
342 static ssize_t
failover_unlock_fs(struct file
*file
, char *buf
, size_t size
)
352 if (buf
[size
-1] != '\n')
356 if (qword_get(&buf
, fo_path
, size
) < 0)
359 error
= path_lookup(fo_path
, 0, &nd
);
363 error
= nlmsvc_unlock_all_by_sb(nd
.path
.mnt
->mnt_sb
);
369 static ssize_t
write_filehandle(struct file
*file
, char *buf
, size_t size
)
372 * domain path maxsize
376 * qword quoting is used, so filehandle will be \x....
379 int uninitialized_var(maxsize
);
382 struct auth_domain
*dom
;
388 if (buf
[size
-1] != '\n')
393 len
= qword_get(&mesg
, dname
, size
);
394 if (len
<= 0) return -EINVAL
;
397 len
= qword_get(&mesg
, path
, size
);
398 if (len
<= 0) return -EINVAL
;
400 len
= get_int(&mesg
, &maxsize
);
404 if (maxsize
< NFS_FHSIZE
)
406 if (maxsize
> NFS3_FHSIZE
)
407 maxsize
= NFS3_FHSIZE
;
409 if (qword_get(&mesg
, mesg
, size
)>0)
412 /* we have all the words, they are in buf.. */
413 dom
= unix_domain_find(dname
);
417 len
= exp_rootfh(dom
, path
, &fh
, maxsize
);
418 auth_domain_put(dom
);
422 mesg
= buf
; len
= SIMPLE_TRANSACTION_LIMIT
;
423 qword_addhex(&mesg
, &len
, (char*)&fh
.fh_base
, fh
.fh_size
);
428 static ssize_t
write_threads(struct file
*file
, char *buf
, size_t size
)
430 /* if size > 0, look for a number of threads and call nfsd_svc
431 * then write out number of threads as reply
437 rv
= get_int(&mesg
, &newthreads
);
442 rv
= nfsd_svc(2049, newthreads
);
446 sprintf(buf
, "%d\n", nfsd_nrthreads());
450 static ssize_t
write_pool_threads(struct file
*file
, char *buf
, size_t size
)
452 /* if size > 0, look for an array of number of threads per node
453 * and apply them then write out number of threads per node as reply
462 mutex_lock(&nfsd_mutex
);
463 npools
= nfsd_nrpools();
466 * NFS is shut down. The admin can start it by
467 * writing to the threads file but NOT the pool_threads
468 * file, sorry. Report zero threads.
470 mutex_unlock(&nfsd_mutex
);
475 nthreads
= kcalloc(npools
, sizeof(int), GFP_KERNEL
);
477 if (nthreads
== NULL
)
481 for (i
= 0; i
< npools
; i
++) {
482 rv
= get_int(&mesg
, &nthreads
[i
]);
484 break; /* fewer numbers than pools */
486 goto out_free
; /* syntax error */
491 rv
= nfsd_set_nrthreads(i
, nthreads
);
496 rv
= nfsd_get_nrthreads(npools
, nthreads
);
501 size
= SIMPLE_TRANSACTION_LIMIT
;
502 for (i
= 0; i
< npools
&& size
> 0; i
++) {
503 snprintf(mesg
, size
, "%d%c", nthreads
[i
], (i
== npools
-1 ? '\n' : ' '));
509 mutex_unlock(&nfsd_mutex
);
514 mutex_unlock(&nfsd_mutex
);
518 static ssize_t
__write_versions(struct file
*file
, char *buf
, size_t size
)
522 * [-/+]vers [-/+]vers ...
532 /* Cannot change versions without updating
533 * nfsd_serv->sv_xdrsize, and reallocing
534 * rq_argp and rq_resp
537 if (buf
[size
-1] != '\n')
542 len
= qword_get(&mesg
, vers
, size
);
543 if (len
<= 0) return -EINVAL
;
546 if (sign
== '+' || sign
== '-')
547 num
= simple_strtol((vers
+1), NULL
, 0);
549 num
= simple_strtol(vers
, NULL
, 0);
554 nfsd_vers(num
, sign
== '-' ? NFSD_CLEAR
: NFSD_SET
);
561 } while ((len
= qword_get(&mesg
, vers
, size
)) > 0);
562 /* If all get turned off, turn them back on, as
563 * having no versions is BAD
565 nfsd_reset_versions();
567 /* Now write current state into reply buffer */
570 for (num
=2 ; num
<= 4 ; num
++)
571 if (nfsd_vers(num
, NFSD_AVAIL
)) {
572 len
+= sprintf(buf
+len
, "%s%c%d", sep
,
573 nfsd_vers(num
, NFSD_TEST
)?'+':'-',
577 len
+= sprintf(buf
+len
, "\n");
581 static ssize_t
write_versions(struct file
*file
, char *buf
, size_t size
)
585 mutex_lock(&nfsd_mutex
);
586 rv
= __write_versions(file
, buf
, size
);
587 mutex_unlock(&nfsd_mutex
);
591 static ssize_t
__write_ports(struct file
*file
, char *buf
, size_t size
)
597 len
= svc_xprt_names(nfsd_serv
, buf
, 0);
600 /* Either a single 'fd' number is written, in which
601 * case it must be for a socket of a supported family/protocol,
602 * and we use it as an nfsd socket, or
603 * A '-' followed by the 'name' of a socket in which case
604 * we close the socket.
606 if (isdigit(buf
[0])) {
610 err
= get_int(&mesg
, &fd
);
615 err
= nfsd_create_serv();
617 err
= svc_addsock(nfsd_serv
, fd
, buf
);
621 svc_sock_names(buf
+strlen(buf
)+1, nfsd_serv
, buf
);
623 /* Decrease the count, but don't shutdown the
626 nfsd_serv
->sv_nrthreads
--;
628 return err
< 0 ? err
: 0;
630 if (buf
[0] == '-' && isdigit(buf
[1])) {
631 char *toclose
= kstrdup(buf
+1, GFP_KERNEL
);
636 len
= svc_sock_names(buf
, nfsd_serv
, toclose
);
643 * Add a transport listener by writing it's transport name
645 if (isalpha(buf
[0])) {
649 if (sscanf(buf
, "%15s %4d", transport
, &port
) == 2) {
650 err
= nfsd_create_serv();
652 err
= svc_create_xprt(nfsd_serv
,
656 /* Give a reasonable perror msg for
657 * bad transport string */
658 err
= -EPROTONOSUPPORT
;
660 return err
< 0 ? err
: 0;
664 * Remove a transport by writing it's transport name and port number
666 if (buf
[0] == '-' && isalpha(buf
[1])) {
667 struct svc_xprt
*xprt
;
671 if (sscanf(&buf
[1], "%15s %4d", transport
, &port
) == 2) {
675 xprt
= svc_find_xprt(nfsd_serv
, transport
,
678 svc_close_xprt(xprt
);
684 return err
< 0 ? err
: 0;
690 static ssize_t
write_ports(struct file
*file
, char *buf
, size_t size
)
694 mutex_lock(&nfsd_mutex
);
695 rv
= __write_ports(file
, buf
, size
);
696 mutex_unlock(&nfsd_mutex
);
701 int nfsd_max_blksize
;
703 static ssize_t
write_maxblksize(struct file
*file
, char *buf
, size_t size
)
708 int rv
= get_int(&mesg
, &bsize
);
711 /* force bsize into allowed range and
712 * required alignment.
716 if (bsize
> NFSSVC_MAXBLKSIZE
)
717 bsize
= NFSSVC_MAXBLKSIZE
;
719 mutex_lock(&nfsd_mutex
);
720 if (nfsd_serv
&& nfsd_serv
->sv_nrthreads
) {
721 mutex_unlock(&nfsd_mutex
);
724 nfsd_max_blksize
= bsize
;
725 mutex_unlock(&nfsd_mutex
);
727 return sprintf(buf
, "%d\n", nfsd_max_blksize
);
730 #ifdef CONFIG_NFSD_V4
731 extern time_t nfs4_leasetime(void);
733 static ssize_t
__write_leasetime(struct file
*file
, char *buf
, size_t size
)
735 /* if size > 10 seconds, call
736 * nfs4_reset_lease() then write out the new lease (seconds) as reply
744 rv
= get_int(&mesg
, &lease
);
747 if (lease
< 10 || lease
> 3600)
749 nfs4_reset_lease(lease
);
751 sprintf(buf
, "%ld\n", nfs4_lease_time());
755 static ssize_t
write_leasetime(struct file
*file
, char *buf
, size_t size
)
759 mutex_lock(&nfsd_mutex
);
760 rv
= __write_leasetime(file
, buf
, size
);
761 mutex_unlock(&nfsd_mutex
);
765 extern char *nfs4_recoverydir(void);
767 static ssize_t
__write_recoverydir(struct file
*file
, char *buf
, size_t size
)
776 if (size
> PATH_MAX
|| buf
[size
-1] != '\n')
781 len
= qword_get(&mesg
, recdir
, size
);
785 status
= nfs4_reset_recoverydir(recdir
);
787 sprintf(buf
, "%s\n", nfs4_recoverydir());
791 static ssize_t
write_recoverydir(struct file
*file
, char *buf
, size_t size
)
795 mutex_lock(&nfsd_mutex
);
796 rv
= __write_recoverydir(file
, buf
, size
);
797 mutex_unlock(&nfsd_mutex
);
803 /*----------------------------------------------------------------------------*/
805 * populating the filesystem.
808 static int nfsd_fill_super(struct super_block
* sb
, void * data
, int silent
)
810 static struct tree_descr nfsd_files
[] = {
811 [NFSD_Svc
] = {".svc", &transaction_ops
, S_IWUSR
},
812 [NFSD_Add
] = {".add", &transaction_ops
, S_IWUSR
},
813 [NFSD_Del
] = {".del", &transaction_ops
, S_IWUSR
},
814 [NFSD_Export
] = {".export", &transaction_ops
, S_IWUSR
},
815 [NFSD_Unexport
] = {".unexport", &transaction_ops
, S_IWUSR
},
816 [NFSD_Getfd
] = {".getfd", &transaction_ops
, S_IWUSR
|S_IRUSR
},
817 [NFSD_Getfs
] = {".getfs", &transaction_ops
, S_IWUSR
|S_IRUSR
},
818 [NFSD_List
] = {"exports", &exports_operations
, S_IRUGO
},
819 [NFSD_FO_UnlockIP
] = {"unlock_ip",
820 &transaction_ops
, S_IWUSR
|S_IRUSR
},
821 [NFSD_FO_UnlockFS
] = {"unlock_filesystem",
822 &transaction_ops
, S_IWUSR
|S_IRUSR
},
823 [NFSD_Fh
] = {"filehandle", &transaction_ops
, S_IWUSR
|S_IRUSR
},
824 [NFSD_Threads
] = {"threads", &transaction_ops
, S_IWUSR
|S_IRUSR
},
825 [NFSD_Pool_Threads
] = {"pool_threads", &transaction_ops
, S_IWUSR
|S_IRUSR
},
826 [NFSD_Versions
] = {"versions", &transaction_ops
, S_IWUSR
|S_IRUSR
},
827 [NFSD_Ports
] = {"portlist", &transaction_ops
, S_IWUSR
|S_IRUGO
},
828 [NFSD_MaxBlkSize
] = {"max_block_size", &transaction_ops
, S_IWUSR
|S_IRUGO
},
829 #ifdef CONFIG_NFSD_V4
830 [NFSD_Leasetime
] = {"nfsv4leasetime", &transaction_ops
, S_IWUSR
|S_IRUSR
},
831 [NFSD_RecoveryDir
] = {"nfsv4recoverydir", &transaction_ops
, S_IWUSR
|S_IRUSR
},
835 return simple_fill_super(sb
, 0x6e667364, nfsd_files
);
838 static int nfsd_get_sb(struct file_system_type
*fs_type
,
839 int flags
, const char *dev_name
, void *data
, struct vfsmount
*mnt
)
841 return get_sb_single(fs_type
, flags
, data
, nfsd_fill_super
, mnt
);
844 static struct file_system_type nfsd_fs_type
= {
845 .owner
= THIS_MODULE
,
847 .get_sb
= nfsd_get_sb
,
848 .kill_sb
= kill_litter_super
,
851 #ifdef CONFIG_PROC_FS
852 static int create_proc_exports_entry(void)
854 struct proc_dir_entry
*entry
;
856 entry
= proc_mkdir("fs/nfs", NULL
);
859 entry
= proc_create("exports", 0, entry
, &exports_operations
);
864 #else /* CONFIG_PROC_FS */
865 static int create_proc_exports_entry(void)
871 static int __init
init_nfsd(void)
874 printk(KERN_INFO
"Installing knfsd (copyright (C) 1996 okir@monad.swb.de).\n");
876 retval
= nfs4_state_init(); /* nfs4 locking state */
879 nfsd_stat_init(); /* Statistics */
880 retval
= nfsd_reply_cache_init();
883 retval
= nfsd_export_init();
886 nfsd_lockd_init(); /* lockd->nfsd callbacks */
887 retval
= nfsd_idmap_init();
890 retval
= create_proc_exports_entry();
893 retval
= register_filesystem(&nfsd_fs_type
);
898 remove_proc_entry("fs/nfs/exports", NULL
);
899 remove_proc_entry("fs/nfs", NULL
);
901 nfsd_idmap_shutdown();
903 nfsd_lockd_shutdown();
904 nfsd_export_shutdown();
906 nfsd_reply_cache_shutdown();
908 nfsd_stat_shutdown();
913 static void __exit
exit_nfsd(void)
915 nfsd_export_shutdown();
916 nfsd_reply_cache_shutdown();
917 remove_proc_entry("fs/nfs/exports", NULL
);
918 remove_proc_entry("fs/nfs", NULL
);
919 nfsd_stat_shutdown();
920 nfsd_lockd_shutdown();
921 nfsd_idmap_shutdown();
923 unregister_filesystem(&nfsd_fs_type
);
926 MODULE_AUTHOR("Olaf Kirch <okir@monad.swb.de>");
927 MODULE_LICENSE("GPL");
928 module_init(init_nfsd
)
929 module_exit(exit_nfsd
)