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_unlock_ip(struct file *file, char *buf, size_t size);
88 static ssize_t write_unlock_fs(struct file *file, char *buf, size_t size);
89 static ssize_t write_threads(struct file *file, char *buf, size_t size);
90 static ssize_t write_pool_threads(struct file *file, char *buf, size_t size);
91 static ssize_t write_versions(struct file *file, char *buf, size_t size);
92 static ssize_t write_ports(struct file *file, char *buf, size_t size);
93 static ssize_t write_maxblksize(struct file *file, char *buf, size_t size);
95 static ssize_t write_leasetime(struct file *file, char *buf, size_t size);
96 static ssize_t write_recoverydir(struct file *file, char *buf, size_t size);
99 static ssize_t (*write_op[])(struct file *, char *, size_t) = {
100 [NFSD_Svc] = write_svc,
101 [NFSD_Add] = write_add,
102 [NFSD_Del] = write_del,
103 [NFSD_Export] = write_export,
104 [NFSD_Unexport] = write_unexport,
105 [NFSD_Getfd] = write_getfd,
106 [NFSD_Getfs] = write_getfs,
107 [NFSD_Fh] = write_filehandle,
108 [NFSD_FO_UnlockIP] = write_unlock_ip,
109 [NFSD_FO_UnlockFS] = write_unlock_fs,
110 [NFSD_Threads] = write_threads,
111 [NFSD_Pool_Threads] = write_pool_threads,
112 [NFSD_Versions] = write_versions,
113 [NFSD_Ports] = write_ports,
114 [NFSD_MaxBlkSize] = write_maxblksize,
115 #ifdef CONFIG_NFSD_V4
116 [NFSD_Leasetime] = write_leasetime,
117 [NFSD_RecoveryDir] = write_recoverydir,
121 static ssize_t nfsctl_transaction_write(struct file *file, const char __user *buf, size_t size, loff_t *pos)
123 ino_t ino = file->f_path.dentry->d_inode->i_ino;
127 if (ino >= ARRAY_SIZE(write_op) || !write_op[ino])
130 data = simple_transaction_get(file, buf, size);
132 return PTR_ERR(data);
134 rv = write_op[ino](file, data, size);
136 simple_transaction_set(file, rv);
142 static ssize_t nfsctl_transaction_read(struct file *file, char __user *buf, size_t size, loff_t *pos)
144 if (! file->private_data) {
145 /* An attempt to read a transaction file without writing
146 * causes a 0-byte write so that the file can return
149 ssize_t rv = nfsctl_transaction_write(file, buf, 0, pos);
153 return simple_transaction_read(file, buf, size, pos);
156 static const struct file_operations transaction_ops = {
157 .write = nfsctl_transaction_write,
158 .read = nfsctl_transaction_read,
159 .release = simple_transaction_release,
162 static int exports_open(struct inode *inode, struct file *file)
164 return seq_open(file, &nfs_exports_op);
167 static const struct file_operations exports_operations = {
168 .open = exports_open,
171 .release = seq_release,
172 .owner = THIS_MODULE,
175 /*----------------------------------------------------------------------------*/
177 * payload - write methods
178 * If the method has a response, the response should be put in buf,
179 * and the length returned. Otherwise return 0 or and -error.
182 static ssize_t write_svc(struct file *file, char *buf, size_t size)
184 struct nfsctl_svc *data;
185 if (size < sizeof(*data))
187 data = (struct nfsctl_svc*) buf;
188 return nfsd_svc(data->svc_port, data->svc_nthreads);
191 static ssize_t write_add(struct file *file, char *buf, size_t size)
193 struct nfsctl_client *data;
194 if (size < sizeof(*data))
196 data = (struct nfsctl_client *)buf;
197 return exp_addclient(data);
200 static ssize_t write_del(struct file *file, char *buf, size_t size)
202 struct nfsctl_client *data;
203 if (size < sizeof(*data))
205 data = (struct nfsctl_client *)buf;
206 return exp_delclient(data);
209 static ssize_t write_export(struct file *file, char *buf, size_t size)
211 struct nfsctl_export *data;
212 if (size < sizeof(*data))
214 data = (struct nfsctl_export*)buf;
215 return exp_export(data);
218 static ssize_t write_unexport(struct file *file, char *buf, size_t size)
220 struct nfsctl_export *data;
222 if (size < sizeof(*data))
224 data = (struct nfsctl_export*)buf;
225 return exp_unexport(data);
228 static ssize_t write_getfs(struct file *file, char *buf, size_t size)
230 struct nfsctl_fsparm *data;
231 struct sockaddr_in *sin;
232 struct auth_domain *clp;
234 struct knfsd_fh *res;
237 if (size < sizeof(*data))
239 data = (struct nfsctl_fsparm*)buf;
240 err = -EPROTONOSUPPORT;
241 if (data->gd_addr.sa_family != AF_INET)
243 sin = (struct sockaddr_in *)&data->gd_addr;
244 if (data->gd_maxlen > NFS3_FHSIZE)
245 data->gd_maxlen = NFS3_FHSIZE;
247 res = (struct knfsd_fh*)buf;
251 ipv6_addr_set_v4mapped(sin->sin_addr.s_addr, &in6);
253 clp = auth_unix_lookup(&in6);
257 err = exp_rootfh(clp, data->gd_path, res, data->gd_maxlen);
258 auth_domain_put(clp);
262 err = res->fh_size + offsetof(struct knfsd_fh, fh_base);
267 static ssize_t write_getfd(struct file *file, char *buf, size_t size)
269 struct nfsctl_fdparm *data;
270 struct sockaddr_in *sin;
271 struct auth_domain *clp;
277 if (size < sizeof(*data))
279 data = (struct nfsctl_fdparm*)buf;
280 err = -EPROTONOSUPPORT;
281 if (data->gd_addr.sa_family != AF_INET)
284 if (data->gd_version < 2 || data->gd_version > NFSSVC_MAXVERS)
288 sin = (struct sockaddr_in *)&data->gd_addr;
291 ipv6_addr_set_v4mapped(sin->sin_addr.s_addr, &in6);
293 clp = auth_unix_lookup(&in6);
297 err = exp_rootfh(clp, data->gd_path, &fh, NFS_FHSIZE);
298 auth_domain_put(clp);
303 memset(res,0, NFS_FHSIZE);
304 memcpy(res, &fh.fh_base, fh.fh_size);
311 static ssize_t write_unlock_ip(struct file *file, char *buf, size_t size)
313 struct sockaddr_in sin = {
314 .sin_family = AF_INET,
324 if (buf[size-1] != '\n')
328 if (qword_get(&buf, fo_path, size) < 0)
331 /* get ipv4 address */
332 if (sscanf(fo_path, "%u.%u.%u.%u%c", &b1, &b2, &b3, &b4, &c) != 4)
334 if (b1 > 255 || b2 > 255 || b3 > 255 || b4 > 255)
336 sin.sin_addr.s_addr = htonl((b1 << 24) | (b2 << 16) | (b3 << 8) | b4);
338 return nlmsvc_unlock_all_by_ip((struct sockaddr *)&sin);
341 static ssize_t write_unlock_fs(struct file *file, char *buf, size_t size)
351 if (buf[size-1] != '\n')
355 if (qword_get(&buf, fo_path, size) < 0)
358 error = kern_path(fo_path, 0, &path);
362 error = nlmsvc_unlock_all_by_sb(path.mnt->mnt_sb);
368 static ssize_t write_filehandle(struct file *file, char *buf, size_t size)
371 * domain path maxsize
375 * qword quoting is used, so filehandle will be \x....
378 int uninitialized_var(maxsize);
381 struct auth_domain *dom;
387 if (buf[size-1] != '\n')
392 len = qword_get(&mesg, dname, size);
397 len = qword_get(&mesg, path, size);
401 len = get_int(&mesg, &maxsize);
405 if (maxsize < NFS_FHSIZE)
407 if (maxsize > NFS3_FHSIZE)
408 maxsize = NFS3_FHSIZE;
410 if (qword_get(&mesg, mesg, size)>0)
413 /* we have all the words, they are in buf.. */
414 dom = unix_domain_find(dname);
418 len = exp_rootfh(dom, path, &fh, maxsize);
419 auth_domain_put(dom);
424 len = SIMPLE_TRANSACTION_LIMIT;
425 qword_addhex(&mesg, &len, (char*)&fh.fh_base, fh.fh_size);
430 static ssize_t write_threads(struct file *file, char *buf, size_t size)
432 /* if size > 0, look for a number of threads and call nfsd_svc
433 * then write out number of threads as reply
439 rv = get_int(&mesg, &newthreads);
444 rv = nfsd_svc(2049, newthreads);
448 sprintf(buf, "%d\n", nfsd_nrthreads());
452 static ssize_t write_pool_threads(struct file *file, char *buf, size_t size)
454 /* if size > 0, look for an array of number of threads per node
455 * and apply them then write out number of threads per node as reply
464 mutex_lock(&nfsd_mutex);
465 npools = nfsd_nrpools();
468 * NFS is shut down. The admin can start it by
469 * writing to the threads file but NOT the pool_threads
470 * file, sorry. Report zero threads.
472 mutex_unlock(&nfsd_mutex);
477 nthreads = kcalloc(npools, sizeof(int), GFP_KERNEL);
479 if (nthreads == NULL)
483 for (i = 0; i < npools; i++) {
484 rv = get_int(&mesg, &nthreads[i]);
486 break; /* fewer numbers than pools */
488 goto out_free; /* syntax error */
493 rv = nfsd_set_nrthreads(i, nthreads);
498 rv = nfsd_get_nrthreads(npools, nthreads);
503 size = SIMPLE_TRANSACTION_LIMIT;
504 for (i = 0; i < npools && size > 0; i++) {
505 snprintf(mesg, size, "%d%c", nthreads[i], (i == npools-1 ? '\n' : ' '));
511 mutex_unlock(&nfsd_mutex);
516 mutex_unlock(&nfsd_mutex);
520 static ssize_t __write_versions(struct file *file, char *buf, size_t size)
524 * [-/+]vers [-/+]vers ...
534 /* Cannot change versions without updating
535 * nfsd_serv->sv_xdrsize, and reallocing
536 * rq_argp and rq_resp
539 if (buf[size-1] != '\n')
544 len = qword_get(&mesg, vers, size);
545 if (len <= 0) return -EINVAL;
548 if (sign == '+' || sign == '-')
549 num = simple_strtol((vers+1), NULL, 0);
551 num = simple_strtol(vers, NULL, 0);
556 nfsd_vers(num, sign == '-' ? NFSD_CLEAR : NFSD_SET);
563 } while ((len = qword_get(&mesg, vers, size)) > 0);
564 /* If all get turned off, turn them back on, as
565 * having no versions is BAD
567 nfsd_reset_versions();
569 /* Now write current state into reply buffer */
572 for (num=2 ; num <= 4 ; num++)
573 if (nfsd_vers(num, NFSD_AVAIL)) {
574 len += sprintf(buf+len, "%s%c%d", sep,
575 nfsd_vers(num, NFSD_TEST)?'+':'-',
579 len += sprintf(buf+len, "\n");
583 static ssize_t write_versions(struct file *file, char *buf, size_t size)
587 mutex_lock(&nfsd_mutex);
588 rv = __write_versions(file, buf, size);
589 mutex_unlock(&nfsd_mutex);
593 static ssize_t __write_ports(struct file *file, char *buf, size_t size)
599 len = svc_xprt_names(nfsd_serv, buf, 0);
602 /* Either a single 'fd' number is written, in which
603 * case it must be for a socket of a supported family/protocol,
604 * and we use it as an nfsd socket, or
605 * A '-' followed by the 'name' of a socket in which case
606 * we close the socket.
608 if (isdigit(buf[0])) {
612 err = get_int(&mesg, &fd);
617 err = nfsd_create_serv();
619 err = svc_addsock(nfsd_serv, fd, buf);
623 svc_sock_names(buf+strlen(buf)+1, nfsd_serv, buf);
625 /* Decrease the count, but don't shutdown the
628 nfsd_serv->sv_nrthreads--;
630 return err < 0 ? err : 0;
632 if (buf[0] == '-' && isdigit(buf[1])) {
633 char *toclose = kstrdup(buf+1, GFP_KERNEL);
638 len = svc_sock_names(buf, nfsd_serv, toclose);
645 * Add a transport listener by writing it's transport name
647 if (isalpha(buf[0])) {
651 if (sscanf(buf, "%15s %4d", transport, &port) == 2) {
652 err = nfsd_create_serv();
654 err = svc_create_xprt(nfsd_serv,
658 /* Give a reasonable perror msg for
659 * bad transport string */
660 err = -EPROTONOSUPPORT;
662 return err < 0 ? err : 0;
666 * Remove a transport by writing it's transport name and port number
668 if (buf[0] == '-' && isalpha(buf[1])) {
669 struct svc_xprt *xprt;
673 if (sscanf(&buf[1], "%15s %4d", transport, &port) == 2) {
677 xprt = svc_find_xprt(nfsd_serv, transport,
680 svc_close_xprt(xprt);
686 return err < 0 ? err : 0;
692 static ssize_t write_ports(struct file *file, char *buf, size_t size)
696 mutex_lock(&nfsd_mutex);
697 rv = __write_ports(file, buf, size);
698 mutex_unlock(&nfsd_mutex);
703 int nfsd_max_blksize;
705 static ssize_t write_maxblksize(struct file *file, char *buf, size_t size)
710 int rv = get_int(&mesg, &bsize);
713 /* force bsize into allowed range and
714 * required alignment.
718 if (bsize > NFSSVC_MAXBLKSIZE)
719 bsize = NFSSVC_MAXBLKSIZE;
721 mutex_lock(&nfsd_mutex);
722 if (nfsd_serv && nfsd_serv->sv_nrthreads) {
723 mutex_unlock(&nfsd_mutex);
726 nfsd_max_blksize = bsize;
727 mutex_unlock(&nfsd_mutex);
729 return sprintf(buf, "%d\n", nfsd_max_blksize);
732 #ifdef CONFIG_NFSD_V4
733 extern time_t nfs4_leasetime(void);
735 static ssize_t __write_leasetime(struct file *file, char *buf, size_t size)
737 /* if size > 10 seconds, call
738 * nfs4_reset_lease() then write out the new lease (seconds) as reply
746 rv = get_int(&mesg, &lease);
749 if (lease < 10 || lease > 3600)
751 nfs4_reset_lease(lease);
753 sprintf(buf, "%ld\n", nfs4_lease_time());
757 static ssize_t write_leasetime(struct file *file, char *buf, size_t size)
761 mutex_lock(&nfsd_mutex);
762 rv = __write_leasetime(file, buf, size);
763 mutex_unlock(&nfsd_mutex);
767 extern char *nfs4_recoverydir(void);
769 static ssize_t __write_recoverydir(struct file *file, char *buf, size_t size)
778 if (size > PATH_MAX || buf[size-1] != '\n')
783 len = qword_get(&mesg, recdir, size);
787 status = nfs4_reset_recoverydir(recdir);
789 sprintf(buf, "%s\n", nfs4_recoverydir());
793 static ssize_t write_recoverydir(struct file *file, char *buf, size_t size)
797 mutex_lock(&nfsd_mutex);
798 rv = __write_recoverydir(file, buf, size);
799 mutex_unlock(&nfsd_mutex);
805 /*----------------------------------------------------------------------------*/
807 * populating the filesystem.
810 static int nfsd_fill_super(struct super_block * sb, void * data, int silent)
812 static struct tree_descr nfsd_files[] = {
813 [NFSD_Svc] = {".svc", &transaction_ops, S_IWUSR},
814 [NFSD_Add] = {".add", &transaction_ops, S_IWUSR},
815 [NFSD_Del] = {".del", &transaction_ops, S_IWUSR},
816 [NFSD_Export] = {".export", &transaction_ops, S_IWUSR},
817 [NFSD_Unexport] = {".unexport", &transaction_ops, S_IWUSR},
818 [NFSD_Getfd] = {".getfd", &transaction_ops, S_IWUSR|S_IRUSR},
819 [NFSD_Getfs] = {".getfs", &transaction_ops, S_IWUSR|S_IRUSR},
820 [NFSD_List] = {"exports", &exports_operations, S_IRUGO},
821 [NFSD_FO_UnlockIP] = {"unlock_ip",
822 &transaction_ops, S_IWUSR|S_IRUSR},
823 [NFSD_FO_UnlockFS] = {"unlock_filesystem",
824 &transaction_ops, S_IWUSR|S_IRUSR},
825 [NFSD_Fh] = {"filehandle", &transaction_ops, S_IWUSR|S_IRUSR},
826 [NFSD_Threads] = {"threads", &transaction_ops, S_IWUSR|S_IRUSR},
827 [NFSD_Pool_Threads] = {"pool_threads", &transaction_ops, S_IWUSR|S_IRUSR},
828 [NFSD_Versions] = {"versions", &transaction_ops, S_IWUSR|S_IRUSR},
829 [NFSD_Ports] = {"portlist", &transaction_ops, S_IWUSR|S_IRUGO},
830 [NFSD_MaxBlkSize] = {"max_block_size", &transaction_ops, S_IWUSR|S_IRUGO},
831 #ifdef CONFIG_NFSD_V4
832 [NFSD_Leasetime] = {"nfsv4leasetime", &transaction_ops, S_IWUSR|S_IRUSR},
833 [NFSD_RecoveryDir] = {"nfsv4recoverydir", &transaction_ops, S_IWUSR|S_IRUSR},
837 return simple_fill_super(sb, 0x6e667364, nfsd_files);
840 static int nfsd_get_sb(struct file_system_type *fs_type,
841 int flags, const char *dev_name, void *data, struct vfsmount *mnt)
843 return get_sb_single(fs_type, flags, data, nfsd_fill_super, mnt);
846 static struct file_system_type nfsd_fs_type = {
847 .owner = THIS_MODULE,
849 .get_sb = nfsd_get_sb,
850 .kill_sb = kill_litter_super,
853 #ifdef CONFIG_PROC_FS
854 static int create_proc_exports_entry(void)
856 struct proc_dir_entry *entry;
858 entry = proc_mkdir("fs/nfs", NULL);
861 entry = proc_create("exports", 0, entry, &exports_operations);
866 #else /* CONFIG_PROC_FS */
867 static int create_proc_exports_entry(void)
873 static int __init init_nfsd(void)
876 printk(KERN_INFO "Installing knfsd (copyright (C) 1996 okir@monad.swb.de).\n");
878 retval = nfs4_state_init(); /* nfs4 locking state */
881 nfsd_stat_init(); /* Statistics */
882 retval = nfsd_reply_cache_init();
885 retval = nfsd_export_init();
888 nfsd_lockd_init(); /* lockd->nfsd callbacks */
889 retval = nfsd_idmap_init();
892 retval = create_proc_exports_entry();
895 retval = register_filesystem(&nfsd_fs_type);
900 remove_proc_entry("fs/nfs/exports", NULL);
901 remove_proc_entry("fs/nfs", NULL);
903 nfsd_idmap_shutdown();
905 nfsd_lockd_shutdown();
906 nfsd_export_shutdown();
908 nfsd_reply_cache_shutdown();
910 nfsd_stat_shutdown();
915 static void __exit exit_nfsd(void)
917 nfsd_export_shutdown();
918 nfsd_reply_cache_shutdown();
919 remove_proc_entry("fs/nfs/exports", NULL);
920 remove_proc_entry("fs/nfs", NULL);
921 nfsd_stat_shutdown();
922 nfsd_lockd_shutdown();
923 nfsd_idmap_shutdown();
925 unregister_filesystem(&nfsd_fs_type);
928 MODULE_AUTHOR("Olaf Kirch <okir@monad.swb.de>");
929 MODULE_LICENSE("GPL");
930 module_init(init_nfsd)
931 module_exit(exit_nfsd)