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/fcntl.h>
16 #include <linux/net.h>
18 #include <linux/syscalls.h>
19 #include <linux/unistd.h>
20 #include <linux/slab.h>
21 #include <linux/proc_fs.h>
22 #include <linux/seq_file.h>
23 #include <linux/pagemap.h>
24 #include <linux/init.h>
25 #include <linux/inet.h>
26 #include <linux/string.h>
27 #include <linux/smp_lock.h>
28 #include <linux/ctype.h>
30 #include <linux/nfs.h>
31 #include <linux/nfsd_idmap.h>
32 #include <linux/lockd/bind.h>
33 #include <linux/sunrpc/svc.h>
34 #include <linux/sunrpc/svcsock.h>
35 #include <linux/nfsd/nfsd.h>
36 #include <linux/nfsd/cache.h>
37 #include <linux/nfsd/xdr.h>
38 #include <linux/nfsd/syscall.h>
39 #include <linux/lockd/lockd.h>
41 #include <asm/uaccess.h>
45 * We have a single directory with 9 nodes in it.
66 * The below MUST come last. Otherwise we leave a hole in nfsd_files[]
67 * with !CONFIG_NFSD_V4 and simple_fill_super() goes oops
76 * write() for these nodes.
78 static ssize_t write_svc(struct file *file, char *buf, size_t size);
79 static ssize_t write_add(struct file *file, char *buf, size_t size);
80 static ssize_t write_del(struct file *file, char *buf, size_t size);
81 static ssize_t write_export(struct file *file, char *buf, size_t size);
82 static ssize_t write_unexport(struct file *file, char *buf, size_t size);
83 static ssize_t write_getfd(struct file *file, char *buf, size_t size);
84 static ssize_t write_getfs(struct file *file, char *buf, size_t size);
85 static ssize_t write_filehandle(struct file *file, char *buf, size_t size);
86 static ssize_t write_threads(struct file *file, char *buf, size_t size);
87 static ssize_t write_pool_threads(struct file *file, char *buf, size_t size);
88 static ssize_t write_versions(struct file *file, char *buf, size_t size);
89 static ssize_t write_ports(struct file *file, char *buf, size_t size);
90 static ssize_t write_maxblksize(struct file *file, char *buf, size_t size);
92 static ssize_t write_leasetime(struct file *file, char *buf, size_t size);
93 static ssize_t write_recoverydir(struct file *file, char *buf, size_t size);
96 static ssize_t failover_unlock_ip(struct file *file, char *buf, size_t size);
97 static ssize_t failover_unlock_fs(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] = failover_unlock_ip,
109 [NFSD_FO_UnlockFS] = failover_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,
174 /*----------------------------------------------------------------------------*/
176 * payload - write methods
177 * If the method has a response, the response should be put in buf,
178 * and the length returned. Otherwise return 0 or and -error.
181 static ssize_t write_svc(struct file *file, char *buf, size_t size)
183 struct nfsctl_svc *data;
184 if (size < sizeof(*data))
186 data = (struct nfsctl_svc*) buf;
187 return nfsd_svc(data->svc_port, data->svc_nthreads);
190 static ssize_t write_add(struct file *file, char *buf, size_t size)
192 struct nfsctl_client *data;
193 if (size < sizeof(*data))
195 data = (struct nfsctl_client *)buf;
196 return exp_addclient(data);
199 static ssize_t write_del(struct file *file, char *buf, size_t size)
201 struct nfsctl_client *data;
202 if (size < sizeof(*data))
204 data = (struct nfsctl_client *)buf;
205 return exp_delclient(data);
208 static ssize_t write_export(struct file *file, char *buf, size_t size)
210 struct nfsctl_export *data;
211 if (size < sizeof(*data))
213 data = (struct nfsctl_export*)buf;
214 return exp_export(data);
217 static ssize_t write_unexport(struct file *file, char *buf, size_t size)
219 struct nfsctl_export *data;
221 if (size < sizeof(*data))
223 data = (struct nfsctl_export*)buf;
224 return exp_unexport(data);
227 static ssize_t write_getfs(struct file *file, char *buf, size_t size)
229 struct nfsctl_fsparm *data;
230 struct sockaddr_in *sin;
231 struct auth_domain *clp;
233 struct knfsd_fh *res;
236 if (size < sizeof(*data))
238 data = (struct nfsctl_fsparm*)buf;
239 err = -EPROTONOSUPPORT;
240 if (data->gd_addr.sa_family != AF_INET)
242 sin = (struct sockaddr_in *)&data->gd_addr;
243 if (data->gd_maxlen > NFS3_FHSIZE)
244 data->gd_maxlen = NFS3_FHSIZE;
246 res = (struct knfsd_fh*)buf;
250 ipv6_addr_set_v4mapped(sin->sin_addr.s_addr, &in6);
252 clp = auth_unix_lookup(&in6);
256 err = exp_rootfh(clp, data->gd_path, res, data->gd_maxlen);
257 auth_domain_put(clp);
261 err = res->fh_size + offsetof(struct knfsd_fh, fh_base);
266 static ssize_t write_getfd(struct file *file, char *buf, size_t size)
268 struct nfsctl_fdparm *data;
269 struct sockaddr_in *sin;
270 struct auth_domain *clp;
276 if (size < sizeof(*data))
278 data = (struct nfsctl_fdparm*)buf;
279 err = -EPROTONOSUPPORT;
280 if (data->gd_addr.sa_family != AF_INET)
283 if (data->gd_version < 2 || data->gd_version > NFSSVC_MAXVERS)
287 sin = (struct sockaddr_in *)&data->gd_addr;
290 ipv6_addr_set_v4mapped(sin->sin_addr.s_addr, &in6);
292 clp = auth_unix_lookup(&in6);
296 err = exp_rootfh(clp, data->gd_path, &fh, NFS_FHSIZE);
297 auth_domain_put(clp);
302 memset(res,0, NFS_FHSIZE);
303 memcpy(res, &fh.fh_base, fh.fh_size);
310 static ssize_t failover_unlock_ip(struct file *file, char *buf, size_t size)
320 if (buf[size-1] != '\n')
324 if (qword_get(&buf, fo_path, size) < 0)
327 /* get ipv4 address */
328 if (sscanf(fo_path, "%u.%u.%u.%u%c", &b1, &b2, &b3, &b4, &c) != 4)
330 server_ip = htonl((((((b1<<8)|b2)<<8)|b3)<<8)|b4);
332 return nlmsvc_unlock_all_by_ip(server_ip);
335 static ssize_t failover_unlock_fs(struct file *file, char *buf, size_t size)
345 if (buf[size-1] != '\n')
349 if (qword_get(&buf, fo_path, size) < 0)
352 error = path_lookup(fo_path, 0, &nd);
356 error = nlmsvc_unlock_all_by_sb(nd.path.mnt->mnt_sb);
362 static ssize_t write_filehandle(struct file *file, char *buf, size_t size)
365 * domain path maxsize
369 * qword quoting is used, so filehandle will be \x....
372 int uninitialized_var(maxsize);
375 struct auth_domain *dom;
381 if (buf[size-1] != '\n')
386 len = qword_get(&mesg, dname, size);
387 if (len <= 0) return -EINVAL;
390 len = qword_get(&mesg, path, size);
391 if (len <= 0) return -EINVAL;
393 len = get_int(&mesg, &maxsize);
397 if (maxsize < NFS_FHSIZE)
399 if (maxsize > NFS3_FHSIZE)
400 maxsize = NFS3_FHSIZE;
402 if (qword_get(&mesg, mesg, size)>0)
405 /* we have all the words, they are in buf.. */
406 dom = unix_domain_find(dname);
410 len = exp_rootfh(dom, path, &fh, maxsize);
411 auth_domain_put(dom);
415 mesg = buf; len = SIMPLE_TRANSACTION_LIMIT;
416 qword_addhex(&mesg, &len, (char*)&fh.fh_base, fh.fh_size);
421 static ssize_t write_threads(struct file *file, char *buf, size_t size)
423 /* if size > 0, look for a number of threads and call nfsd_svc
424 * then write out number of threads as reply
430 rv = get_int(&mesg, &newthreads);
435 rv = nfsd_svc(2049, newthreads);
439 sprintf(buf, "%d\n", nfsd_nrthreads());
443 static ssize_t write_pool_threads(struct file *file, char *buf, size_t size)
445 /* if size > 0, look for an array of number of threads per node
446 * and apply them then write out number of threads per node as reply
452 int npools = nfsd_nrpools();
457 * NFS is shut down. The admin can start it by
458 * writing to the threads file but NOT the pool_threads
459 * file, sorry. Report zero threads.
465 nthreads = kcalloc(npools, sizeof(int), GFP_KERNEL);
466 if (nthreads == NULL)
470 for (i = 0; i < npools; i++) {
471 rv = get_int(&mesg, &nthreads[i]);
473 break; /* fewer numbers than pools */
475 goto out_free; /* syntax error */
480 rv = nfsd_set_nrthreads(i, nthreads);
485 rv = nfsd_get_nrthreads(npools, nthreads);
490 size = SIMPLE_TRANSACTION_LIMIT;
491 for (i = 0; i < npools && size > 0; i++) {
492 snprintf(mesg, size, "%d%c", nthreads[i], (i == npools-1 ? '\n' : ' '));
505 static ssize_t write_versions(struct file *file, char *buf, size_t size)
509 * [-/+]vers [-/+]vers ...
519 /* Cannot change versions without updating
520 * nfsd_serv->sv_xdrsize, and reallocing
521 * rq_argp and rq_resp
524 if (buf[size-1] != '\n')
529 len = qword_get(&mesg, vers, size);
530 if (len <= 0) return -EINVAL;
533 if (sign == '+' || sign == '-')
534 num = simple_strtol((vers+1), NULL, 0);
536 num = simple_strtol(vers, NULL, 0);
541 nfsd_vers(num, sign == '-' ? NFSD_CLEAR : NFSD_SET);
548 } while ((len = qword_get(&mesg, vers, size)) > 0);
549 /* If all get turned off, turn them back on, as
550 * having no versions is BAD
552 nfsd_reset_versions();
554 /* Now write current state into reply buffer */
557 for (num=2 ; num <= 4 ; num++)
558 if (nfsd_vers(num, NFSD_AVAIL)) {
559 len += sprintf(buf+len, "%s%c%d", sep,
560 nfsd_vers(num, NFSD_TEST)?'+':'-',
564 len += sprintf(buf+len, "\n");
568 static ssize_t write_ports(struct file *file, char *buf, size_t size)
574 len = svc_xprt_names(nfsd_serv, buf, 0);
578 /* Either a single 'fd' number is written, in which
579 * case it must be for a socket of a supported family/protocol,
580 * and we use it as an nfsd socket, or
581 * A '-' followed by the 'name' of a socket in which case
582 * we close the socket.
584 if (isdigit(buf[0])) {
588 err = get_int(&mesg, &fd);
593 err = nfsd_create_serv();
596 err = svc_addsock(nfsd_serv, fd, buf, &proto);
598 err = lockd_up(proto);
600 svc_sock_names(buf+strlen(buf)+1, nfsd_serv, buf);
602 /* Decrease the count, but don't shutdown the
606 nfsd_serv->sv_nrthreads--;
609 return err < 0 ? err : 0;
611 if (buf[0] == '-' && isdigit(buf[1])) {
612 char *toclose = kstrdup(buf+1, GFP_KERNEL);
618 len = svc_sock_names(buf, nfsd_serv, toclose);
626 * Add a transport listener by writing it's transport name
628 if (isalpha(buf[0])) {
632 if (sscanf(buf, "%15s %4d", transport, &port) == 2) {
633 err = nfsd_create_serv();
635 err = svc_create_xprt(nfsd_serv,
639 /* Give a reasonable perror msg for
640 * bad transport string */
641 err = -EPROTONOSUPPORT;
643 return err < 0 ? err : 0;
647 * Remove a transport by writing it's transport name and port number
649 if (buf[0] == '-' && isalpha(buf[1])) {
650 struct svc_xprt *xprt;
654 if (sscanf(&buf[1], "%15s %4d", transport, &port) == 2) {
659 xprt = svc_find_xprt(nfsd_serv, transport,
662 svc_close_xprt(xprt);
669 return err < 0 ? err : 0;
675 int nfsd_max_blksize;
677 static ssize_t write_maxblksize(struct file *file, char *buf, size_t size)
682 int rv = get_int(&mesg, &bsize);
685 /* force bsize into allowed range and
686 * required alignment.
690 if (bsize > NFSSVC_MAXBLKSIZE)
691 bsize = NFSSVC_MAXBLKSIZE;
694 if (nfsd_serv && nfsd_serv->sv_nrthreads) {
698 nfsd_max_blksize = bsize;
701 return sprintf(buf, "%d\n", nfsd_max_blksize);
704 #ifdef CONFIG_NFSD_V4
705 extern time_t nfs4_leasetime(void);
707 static ssize_t write_leasetime(struct file *file, char *buf, size_t size)
709 /* if size > 10 seconds, call
710 * nfs4_reset_lease() then write out the new lease (seconds) as reply
717 rv = get_int(&mesg, &lease);
720 if (lease < 10 || lease > 3600)
722 nfs4_reset_lease(lease);
724 sprintf(buf, "%ld\n", nfs4_lease_time());
728 static ssize_t write_recoverydir(struct file *file, char *buf, size_t size)
734 if (size == 0 || size > PATH_MAX || buf[size-1] != '\n')
739 len = qword_get(&mesg, recdir, size);
743 status = nfs4_reset_recoverydir(recdir);
748 /*----------------------------------------------------------------------------*/
750 * populating the filesystem.
753 static int nfsd_fill_super(struct super_block * sb, void * data, int silent)
755 static struct tree_descr nfsd_files[] = {
756 [NFSD_Svc] = {".svc", &transaction_ops, S_IWUSR},
757 [NFSD_Add] = {".add", &transaction_ops, S_IWUSR},
758 [NFSD_Del] = {".del", &transaction_ops, S_IWUSR},
759 [NFSD_Export] = {".export", &transaction_ops, S_IWUSR},
760 [NFSD_Unexport] = {".unexport", &transaction_ops, S_IWUSR},
761 [NFSD_Getfd] = {".getfd", &transaction_ops, S_IWUSR|S_IRUSR},
762 [NFSD_Getfs] = {".getfs", &transaction_ops, S_IWUSR|S_IRUSR},
763 [NFSD_List] = {"exports", &exports_operations, S_IRUGO},
764 [NFSD_FO_UnlockIP] = {"unlock_ip",
765 &transaction_ops, S_IWUSR|S_IRUSR},
766 [NFSD_FO_UnlockFS] = {"unlock_filesystem",
767 &transaction_ops, S_IWUSR|S_IRUSR},
768 [NFSD_Fh] = {"filehandle", &transaction_ops, S_IWUSR|S_IRUSR},
769 [NFSD_Threads] = {"threads", &transaction_ops, S_IWUSR|S_IRUSR},
770 [NFSD_Pool_Threads] = {"pool_threads", &transaction_ops, S_IWUSR|S_IRUSR},
771 [NFSD_Versions] = {"versions", &transaction_ops, S_IWUSR|S_IRUSR},
772 [NFSD_Ports] = {"portlist", &transaction_ops, S_IWUSR|S_IRUGO},
773 [NFSD_MaxBlkSize] = {"max_block_size", &transaction_ops, S_IWUSR|S_IRUGO},
774 #ifdef CONFIG_NFSD_V4
775 [NFSD_Leasetime] = {"nfsv4leasetime", &transaction_ops, S_IWUSR|S_IRUSR},
776 [NFSD_RecoveryDir] = {"nfsv4recoverydir", &transaction_ops, S_IWUSR|S_IRUSR},
780 return simple_fill_super(sb, 0x6e667364, nfsd_files);
783 static int nfsd_get_sb(struct file_system_type *fs_type,
784 int flags, const char *dev_name, void *data, struct vfsmount *mnt)
786 return get_sb_single(fs_type, flags, data, nfsd_fill_super, mnt);
789 static struct file_system_type nfsd_fs_type = {
790 .owner = THIS_MODULE,
792 .get_sb = nfsd_get_sb,
793 .kill_sb = kill_litter_super,
796 #ifdef CONFIG_PROC_FS
797 static int create_proc_exports_entry(void)
799 struct proc_dir_entry *entry;
801 entry = proc_mkdir("fs/nfs", NULL);
804 entry = create_proc_entry("fs/nfs/exports", 0, NULL);
807 entry->proc_fops = &exports_operations;
810 #else /* CONFIG_PROC_FS */
811 static int create_proc_exports_entry(void)
817 static int __init init_nfsd(void)
820 printk(KERN_INFO "Installing knfsd (copyright (C) 1996 okir@monad.swb.de).\n");
822 retval = nfs4_state_init(); /* nfs4 locking state */
825 nfsd_stat_init(); /* Statistics */
826 retval = nfsd_reply_cache_init();
829 retval = nfsd_export_init();
832 nfsd_lockd_init(); /* lockd->nfsd callbacks */
833 retval = nfsd_idmap_init();
836 retval = create_proc_exports_entry();
839 retval = register_filesystem(&nfsd_fs_type);
844 remove_proc_entry("fs/nfs/exports", NULL);
845 remove_proc_entry("fs/nfs", NULL);
847 nfsd_idmap_shutdown();
849 nfsd_lockd_shutdown();
850 nfsd_export_shutdown();
852 nfsd_reply_cache_shutdown();
854 nfsd_stat_shutdown();
859 static void __exit exit_nfsd(void)
861 nfsd_export_shutdown();
862 nfsd_reply_cache_shutdown();
863 remove_proc_entry("fs/nfs/exports", NULL);
864 remove_proc_entry("fs/nfs", NULL);
865 nfsd_stat_shutdown();
866 nfsd_lockd_shutdown();
867 nfsd_idmap_shutdown();
869 unregister_filesystem(&nfsd_fs_type);
872 MODULE_AUTHOR("Olaf Kirch <okir@monad.swb.de>");
873 MODULE_LICENSE("GPL");
874 module_init(init_nfsd)
875 module_exit(exit_nfsd)