2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 2002 Poul-Henning Kamp
5 * Copyright (c) 2002 Networks Associates Technology, Inc.
8 * This software was developed for the FreeBSD Project by Poul-Henning Kamp
9 * and NAI Labs, the Security Research Division of Network Associates, Inc.
10 * under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the
11 * DARPA CHATS research program.
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
16 * 1. Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 * 2. Redistributions in binary form must reproduce the above copyright
19 * notice, this list of conditions and the following disclaimer in the
20 * documentation and/or other materials provided with the distribution.
21 * 3. The names of the authors may not be used to endorse or promote
22 * products derived from this software without specific prior written
25 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
26 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
31 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
34 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
38 #include <sys/cdefs.h>
39 __FBSDID("$FreeBSD$");
41 #include <sys/param.h>
42 #include <sys/systm.h>
44 #include <sys/malloc.h>
48 #include <vm/vm_extern.h>
50 #include <geom/geom.h>
51 #include <geom/geom_int.h>
53 #include <geom/geom_ctl.h>
55 #include <machine/stdarg.h>
57 static d_ioctl_t g_ctl_ioctl;
59 static struct cdevsw g_ctl_cdevsw = {
60 .d_version = D_VERSION,
62 .d_ioctl = g_ctl_ioctl,
70 make_dev_credf(MAKEDEV_ETERNAL, &g_ctl_cdevsw, 0, NULL,
71 UID_ROOT, GID_OPERATOR, 0640, PATH_GEOM_CTL);
72 KASSERT(GCTL_PARAM_RD == VM_PROT_READ,
73 ("GCTL_PARAM_RD != VM_PROT_READ"));
74 KASSERT(GCTL_PARAM_WR == VM_PROT_WRITE,
75 ("GCTL_PARAM_WR != VM_PROT_WRITE"));
79 * Report an error back to the user in ascii format. Return nerror
80 * or EINVAL if nerror isn't specified.
83 gctl_error(struct gctl_req *req, const char *fmt, ...)
90 /* We only record the first error */
91 if (sbuf_done(req->serror)) {
100 sbuf_vprintf(req->serror, fmt, ap);
102 sbuf_finish(req->serror);
103 if (g_debugflags & G_F_CTLDUMP)
104 printf("gctl %p error \"%s\"\n", req, sbuf_data(req->serror));
105 return (req->nerror);
109 * Allocate space and copyin() something.
110 * XXX: this should really be a standard function in the kernel.
113 geom_alloc_copyin(struct gctl_req *req, void *uaddr, size_t len)
117 ptr = g_malloc(len, M_WAITOK);
118 req->nerror = copyin(uaddr, ptr, len);
126 gctl_copyin(struct gctl_req *req)
128 struct gctl_req_arg *ap;
132 if (req->narg > GEOM_CTL_ARG_MAX) {
133 gctl_error(req, "too many arguments");
138 ap = geom_alloc_copyin(req, req->arg, req->narg * sizeof(*ap));
140 gctl_error(req, "bad control request");
145 /* Nothing have been copyin()'ed yet */
146 for (i = 0; i < req->narg; i++) {
147 ap[i].flag &= ~(GCTL_PARAM_NAMEKERNEL|GCTL_PARAM_VALUEKERNEL);
148 ap[i].flag &= ~GCTL_PARAM_CHANGED;
152 for (i = 0; i < req->narg; i++) {
153 if (ap[i].nlen < 1 || ap[i].nlen > SPECNAMELEN) {
155 "wrong param name length %d: %d", i, ap[i].nlen);
158 p = geom_alloc_copyin(req, ap[i].name, ap[i].nlen);
161 if (p[ap[i].nlen - 1] != '\0') {
162 gctl_error(req, "unterminated param name");
167 ap[i].flag |= GCTL_PARAM_NAMEKERNEL;
168 if (ap[i].len <= 0) {
169 gctl_error(req, "negative param length");
172 p = geom_alloc_copyin(req, ap[i].value, ap[i].len);
175 if ((ap[i].flag & GCTL_PARAM_ASCII) &&
176 p[ap[i].len - 1] != '\0') {
177 gctl_error(req, "unterminated param value");
182 ap[i].flag |= GCTL_PARAM_VALUEKERNEL;
189 gctl_copyout(struct gctl_req *req)
192 struct gctl_req_arg *ap;
198 for (i = 0; i < req->narg; i++, ap++) {
199 if (!(ap->flag & GCTL_PARAM_CHANGED))
201 error = copyout(ap->kvalue, ap->value, ap->len);
211 gctl_free(struct gctl_req *req)
215 sbuf_delete(req->serror);
216 if (req->arg == NULL)
218 for (i = 0; i < req->narg; i++) {
219 if (req->arg[i].flag & GCTL_PARAM_NAMEKERNEL)
220 g_free(req->arg[i].name);
221 if ((req->arg[i].flag & GCTL_PARAM_VALUEKERNEL) &&
223 g_free(req->arg[i].kvalue);
229 gctl_dump(struct gctl_req *req)
231 struct gctl_req_arg *ap;
235 printf("Dump of gctl request at %p:\n", req);
236 if (req->nerror > 0) {
237 printf(" nerror:\t%d\n", req->nerror);
238 if (sbuf_len(req->serror) > 0)
239 printf(" error:\t\"%s\"\n", sbuf_data(req->serror));
241 if (req->arg == NULL)
243 for (i = 0; i < req->narg; i++) {
245 if (!(ap->flag & GCTL_PARAM_NAMEKERNEL))
246 printf(" param:\t%d@%p", ap->nlen, ap->name);
248 printf(" param:\t\"%s\"", ap->name);
249 printf(" [%s%s%d] = ",
250 ap->flag & GCTL_PARAM_RD ? "R" : "",
251 ap->flag & GCTL_PARAM_WR ? "W" : "",
253 if (!(ap->flag & GCTL_PARAM_VALUEKERNEL)) {
254 printf(" =@ %p", ap->value);
255 } else if (ap->flag & GCTL_PARAM_ASCII) {
256 printf("\"%s\"", (char *)ap->kvalue);
257 } else if (ap->len > 0) {
258 for (j = 0; j < ap->len && j < 512; j++)
259 printf(" %02x", ((u_char *)ap->kvalue)[j]);
261 printf(" = %p", ap->kvalue);
268 gctl_set_param(struct gctl_req *req, const char *param, void const *ptr,
272 struct gctl_req_arg *ap;
274 for (i = 0; i < req->narg; i++) {
276 if (strcmp(param, ap->name))
278 if (!(ap->flag & GCTL_PARAM_WR))
280 ap->flag |= GCTL_PARAM_CHANGED;
282 bcopy(ptr, ap->kvalue, ap->len);
285 bcopy(ptr, ap->kvalue, len);
292 gctl_set_param_err(struct gctl_req *req, const char *param, void const *ptr,
296 switch (gctl_set_param(req, param, ptr, len)) {
298 gctl_error(req, "No write access %s argument", param);
301 gctl_error(req, "Wrong length %s argument", param);
304 gctl_error(req, "Missing %s argument", param);
310 gctl_get_param(struct gctl_req *req, const char *param, int *len)
314 struct gctl_req_arg *ap;
316 for (i = 0; i < req->narg; i++) {
318 if (strcmp(param, ap->name))
320 if (!(ap->flag & GCTL_PARAM_RD))
331 gctl_get_asciiparam(struct gctl_req *req, const char *param)
335 struct gctl_req_arg *ap;
337 for (i = 0; i < req->narg; i++) {
339 if (strcmp(param, ap->name))
341 if (!(ap->flag & GCTL_PARAM_RD))
345 gctl_error(req, "No length argument (%s)", param);
348 if (p[ap->len - 1] != '\0') {
349 gctl_error(req, "Unterminated argument (%s)", param);
358 gctl_get_paraml_opt(struct gctl_req *req, const char *param, int len)
363 p = gctl_get_param(req, param, &i);
366 gctl_error(req, "Wrong length %s argument", param);
372 gctl_get_paraml(struct gctl_req *req, const char *param, int len)
376 p = gctl_get_paraml_opt(req, param, len);
378 gctl_error(req, "Missing %s argument", param);
383 gctl_get_class(struct gctl_req *req, char const *arg)
388 p = gctl_get_asciiparam(req, arg);
390 gctl_error(req, "Missing %s argument", arg);
393 LIST_FOREACH(cp, &g_classes, class) {
394 if (!strcmp(p, cp->name))
397 gctl_error(req, "Class not found: \"%s\"", p);
402 gctl_get_geom(struct gctl_req *req, struct g_class *mp, char const *arg)
408 p = gctl_get_asciiparam(req, arg);
410 gctl_error(req, "Missing %s argument", arg);
413 LIST_FOREACH(gp, &mp->geom, geom)
414 if (!strcmp(p, gp->name))
416 gctl_error(req, "Geom not found: \"%s\"", p);
421 gctl_get_provider(struct gctl_req *req, char const *arg)
424 struct g_provider *pp;
426 p = gctl_get_asciiparam(req, arg);
428 gctl_error(req, "Missing '%s' argument", arg);
431 pp = g_provider_by_name(p);
434 gctl_error(req, "Provider not found: \"%s\"", p);
439 g_ctl_req(void *arg, int flag __unused)
442 struct gctl_req *req;
447 mp = gctl_get_class(req, "class");
450 if (mp->ctlreq == NULL) {
451 gctl_error(req, "Class takes no requests");
454 verb = gctl_get_param(req, "verb", NULL);
456 gctl_error(req, "Verb missing");
459 mp->ctlreq(req, mp, verb);
464 g_ctl_ioctl_ctl(struct cdev *dev, u_long cmd, caddr_t data, int fflag, struct thread *td)
466 struct gctl_req *req;
471 /* It is an error if we cannot return an error text */
474 if (!useracc(req->error, req->lerror, VM_PROT_WRITE))
477 req->serror = sbuf_new_auto();
478 /* Check the version */
479 if (req->version != GCTL_VERSION) {
480 gctl_error(req, "kernel and libgeom version mismatch.");
483 /* Get things on board */
486 if (g_debugflags & G_F_CTLDUMP)
490 g_waitfor_event(g_ctl_req, req, M_WAITOK, NULL);
494 if (sbuf_done(req->serror)) {
495 copyout(sbuf_data(req->serror), req->error,
496 imin(req->lerror, sbuf_len(req->serror) + 1));
499 nerror = req->nerror;
505 g_ctl_ioctl(struct cdev *dev, u_long cmd, caddr_t data, int fflag, struct thread *td)
511 error = g_ctl_ioctl_ctl(dev, cmd, data, fflag, td);