2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 2002 Poul-Henning Kamp
5 * Copyright (c) 2002 Networks Associates Technology, Inc.
7 * Copyright (c) 2022 Alexander Motin <mav@FreeBSD.org>
9 * This software was developed for the FreeBSD Project by Poul-Henning Kamp
10 * and NAI Labs, the Security Research Division of Network Associates, Inc.
11 * under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the
12 * DARPA CHATS research program.
14 * Redistribution and use in source and binary forms, with or without
15 * modification, are permitted provided that the following conditions
17 * 1. Redistributions of source code must retain the above copyright
18 * notice, this list of conditions and the following disclaimer.
19 * 2. Redistributions in binary form must reproduce the above copyright
20 * notice, this list of conditions and the following disclaimer in the
21 * documentation and/or other materials provided with the distribution.
22 * 3. The names of the authors may not be used to endorse or promote
23 * products derived from this software without specific prior written
26 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
27 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
30 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
31 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
32 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
35 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
39 #include <sys/cdefs.h>
40 __FBSDID("$FreeBSD$");
42 #include <sys/param.h>
43 #include <sys/systm.h>
45 #include <sys/malloc.h>
49 #include <vm/vm_extern.h>
51 #include <geom/geom.h>
52 #include <geom/geom_int.h>
54 #include <geom/geom_ctl.h>
56 #include <machine/stdarg.h>
58 static d_ioctl_t g_ctl_ioctl;
60 static struct cdevsw g_ctl_cdevsw = {
61 .d_version = D_VERSION,
63 .d_ioctl = g_ctl_ioctl,
67 CTASSERT(GCTL_PARAM_RD == VM_PROT_READ);
68 CTASSERT(GCTL_PARAM_WR == VM_PROT_WRITE);
74 make_dev_credf(MAKEDEV_ETERNAL, &g_ctl_cdevsw, 0, NULL,
75 UID_ROOT, GID_OPERATOR, 0640, PATH_GEOM_CTL);
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)) {
95 printf("gctl_error: buffer closed, message discarded.\n");
100 req->nerror = EINVAL;
102 /* If this is the last of several messages, indent it on a new line */
103 if (sbuf_len(req->serror) > 0)
104 sbuf_cat(req->serror, "\n\t");
106 sbuf_vprintf(req->serror, fmt, ap);
108 gctl_post_messages(req);
109 return (req->nerror);
113 * The gctl_error() function will only report a single message.
114 * Commands that handle multiple devices may want to report a
115 * message for each of the devices. The gctl_msg() function
116 * can be called multiple times to post messages. When done
117 * the application must either call gctl_post_messages() or
118 * call gctl_error() to cause the messages to be reported to
119 * the calling process.
121 * The errno argument should be zero if it is an informational
122 * message or an errno value (EINVAL, EBUSY, etc) if it is an error.
123 * If any of the messages has a non-zero errno, the utility will
124 * EXIT_FAILURE. If only informational messages (with zero errno)
125 * are posted, the utility will EXIT_SUCCESS.
128 gctl_msg(struct gctl_req *req, int errno, const char *fmt, ...)
134 if (sbuf_done(req->serror)) {
136 printf("gctl_msg: buffer closed, message discarded.\n");
140 if (req->nerror == 0)
142 /* Put second and later messages indented on a new line */
143 if (sbuf_len(req->serror) > 0)
144 sbuf_cat(req->serror, "\n\t");
146 sbuf_vprintf(req->serror, fmt, ap);
151 * Post the messages to the user.
154 gctl_post_messages(struct gctl_req *req)
157 if (sbuf_done(req->serror)) {
159 printf("gctl_post_messages: message buffer already closed.\n");
163 sbuf_finish(req->serror);
164 if (g_debugflags & G_F_CTLDUMP)
165 printf("gctl %p message(s) \"%s\"\n", req,
166 sbuf_data(req->serror));
170 * Allocate space and copyin() something.
171 * XXX: this should really be a standard function in the kernel.
174 geom_alloc_copyin(struct gctl_req *req, void *uaddr, size_t len)
178 ptr = g_malloc(len, M_WAITOK);
179 req->nerror = copyin(uaddr, ptr, len);
187 gctl_copyin(struct gctl_req *req)
189 struct gctl_req_arg *ap;
193 if (req->narg > GEOM_CTL_ARG_MAX) {
194 gctl_error(req, "too many arguments");
199 ap = geom_alloc_copyin(req, req->arg, req->narg * sizeof(*ap));
201 gctl_error(req, "bad control request");
206 /* Nothing have been copyin()'ed yet */
207 for (i = 0; i < req->narg; i++) {
208 ap[i].flag &= ~(GCTL_PARAM_NAMEKERNEL|GCTL_PARAM_VALUEKERNEL);
209 ap[i].flag &= ~GCTL_PARAM_CHANGED;
213 for (i = 0; i < req->narg; i++) {
214 if (ap[i].nlen < 1 || ap[i].nlen > SPECNAMELEN) {
216 "wrong param name length %d: %d", i, ap[i].nlen);
219 p = geom_alloc_copyin(req, ap[i].name, ap[i].nlen);
222 if (p[ap[i].nlen - 1] != '\0') {
223 gctl_error(req, "unterminated param name");
228 ap[i].flag |= GCTL_PARAM_NAMEKERNEL;
229 if (ap[i].len <= 0) {
230 gctl_error(req, "negative param length");
233 if (ap[i].flag & GCTL_PARAM_RD) {
234 p = geom_alloc_copyin(req, ap[i].value, ap[i].len);
237 if ((ap[i].flag & GCTL_PARAM_ASCII) &&
238 p[ap[i].len - 1] != '\0') {
239 gctl_error(req, "unterminated param value");
244 p = g_malloc(ap[i].len, M_WAITOK | M_ZERO);
247 ap[i].flag |= GCTL_PARAM_VALUEKERNEL;
254 gctl_copyout(struct gctl_req *req)
257 struct gctl_req_arg *ap;
263 for (i = 0; i < req->narg; i++, ap++) {
264 if (!(ap->flag & GCTL_PARAM_CHANGED))
266 error = copyout(ap->kvalue, ap->value, ap->len);
276 gctl_free(struct gctl_req *req)
280 sbuf_delete(req->serror);
281 if (req->arg == NULL)
283 for (i = 0; i < req->narg; i++) {
284 if (req->arg[i].flag & GCTL_PARAM_NAMEKERNEL)
285 g_free(req->arg[i].name);
286 if ((req->arg[i].flag & GCTL_PARAM_VALUEKERNEL) &&
288 g_free(req->arg[i].kvalue);
294 gctl_dump(struct gctl_req *req, const char *what)
296 struct gctl_req_arg *ap;
300 printf("Dump of gctl %s at %p:\n", what, req);
301 if (req->nerror > 0) {
302 printf(" nerror:\t%d\n", req->nerror);
303 if (sbuf_len(req->serror) > 0)
304 printf(" error:\t\"%s\"\n", sbuf_data(req->serror));
306 if (req->arg == NULL)
308 for (i = 0; i < req->narg; i++) {
310 if (!(ap->flag & GCTL_PARAM_NAMEKERNEL))
311 printf(" param:\t%d@%p", ap->nlen, ap->name);
313 printf(" param:\t\"%s\"", ap->name);
314 printf(" [%s%s%d] = ",
315 ap->flag & GCTL_PARAM_RD ? "R" : "",
316 ap->flag & GCTL_PARAM_WR ? "W" : "",
318 if (!(ap->flag & GCTL_PARAM_VALUEKERNEL)) {
319 printf(" =@ %p", ap->value);
320 } else if (ap->flag & GCTL_PARAM_ASCII) {
321 printf("\"%s\"", (char *)ap->kvalue);
322 } else if (ap->len > 0) {
323 for (j = 0; j < ap->len && j < 512; j++)
324 printf(" %02x", ((u_char *)ap->kvalue)[j]);
326 printf(" = %p", ap->kvalue);
333 gctl_set_param(struct gctl_req *req, const char *param, void const *ptr,
337 struct gctl_req_arg *ap;
339 for (i = 0; i < req->narg; i++) {
341 if (strcmp(param, ap->name))
343 if (!(ap->flag & GCTL_PARAM_WR))
345 ap->flag |= GCTL_PARAM_CHANGED;
347 bcopy(ptr, ap->kvalue, ap->len);
350 bcopy(ptr, ap->kvalue, len);
357 gctl_set_param_err(struct gctl_req *req, const char *param, void const *ptr,
361 switch (gctl_set_param(req, param, ptr, len)) {
363 gctl_error(req, "No write access %s argument", param);
366 gctl_error(req, "Wrong length %s argument", param);
369 gctl_error(req, "Missing %s argument", param);
375 gctl_get_param_flags(struct gctl_req *req, const char *param, int flags, int *len)
379 struct gctl_req_arg *ap;
381 for (i = 0; i < req->narg; i++) {
383 if (strcmp(param, ap->name))
385 if ((ap->flag & flags) != flags)
396 gctl_get_param(struct gctl_req *req, const char *param, int *len)
399 return (gctl_get_param_flags(req, param, GCTL_PARAM_RD, len));
403 gctl_get_asciiparam(struct gctl_req *req, const char *param)
408 p = gctl_get_param_flags(req, param, GCTL_PARAM_RD, &len);
412 gctl_error(req, "Argument without length (%s)", param);
415 if (p[len - 1] != '\0') {
416 gctl_error(req, "Unterminated argument (%s)", param);
423 gctl_get_paraml_opt(struct gctl_req *req, const char *param, int len)
428 p = gctl_get_param(req, param, &i);
431 gctl_error(req, "Wrong length %s argument", param);
437 gctl_get_paraml(struct gctl_req *req, const char *param, int len)
441 p = gctl_get_paraml_opt(req, param, len);
443 gctl_error(req, "Missing %s argument", param);
448 gctl_get_class(struct gctl_req *req, char const *arg)
453 p = gctl_get_asciiparam(req, arg);
455 gctl_error(req, "Missing %s argument", arg);
458 LIST_FOREACH(cp, &g_classes, class) {
459 if (!strcmp(p, cp->name))
462 gctl_error(req, "Class not found: \"%s\"", p);
467 gctl_get_geom(struct gctl_req *req, struct g_class *mp, char const *arg)
473 p = gctl_get_asciiparam(req, arg);
475 gctl_error(req, "Missing %s argument", arg);
478 LIST_FOREACH(gp, &mp->geom, geom)
479 if (!strcmp(p, gp->name))
481 gctl_error(req, "Geom not found: \"%s\"", p);
486 gctl_get_provider(struct gctl_req *req, char const *arg)
489 struct g_provider *pp;
491 p = gctl_get_asciiparam(req, arg);
493 gctl_error(req, "Missing '%s' argument", arg);
496 pp = g_provider_by_name(p);
499 gctl_error(req, "Provider not found: \"%s\"", p);
504 g_ctl_getxml(struct gctl_req *req, struct g_class *mp)
509 int len, i = 0, n = 0, *parents;
510 struct g_geom *gp, **gps;
511 struct g_consumer *cp;
513 parents = gctl_get_paraml(req, "parents", sizeof(*parents));
516 name = gctl_get_asciiparam(req, "arg0");
518 LIST_FOREACH(gp, &mp->geom, geom) {
519 if (name && strcmp(gp->name, name) != 0)
523 LIST_FOREACH(cp, &gp->consumer, consumer)
527 gps = g_malloc((n + 1) * sizeof(*gps), M_WAITOK);
529 LIST_FOREACH(gp, &mp->geom, geom) {
530 if (name && strcmp(gp->name, name) != 0)
534 LIST_FOREACH(cp, &gp->consumer, consumer) {
535 if (cp->provider != NULL)
536 gps[i++] = cp->provider->geom;
540 KASSERT(i == n, ("different number of geoms found (%d != %d)",
544 buf = gctl_get_param_flags(req, "output", GCTL_PARAM_WR, &len);
546 gctl_error(req, "output parameter missing");
550 sb = sbuf_new(NULL, buf, len, SBUF_FIXEDLEN | SBUF_INCLUDENUL);
551 g_conf_specific(sb, gps);
552 gctl_set_param(req, "output", buf, 0);
554 gctl_error(req, "output buffer overflow");
560 g_ctl_req(void *arg, int flag __unused)
563 struct gctl_req *req;
568 mp = gctl_get_class(req, "class");
571 verb = gctl_get_param(req, "verb", NULL);
573 gctl_error(req, "Verb missing");
576 if (strcmp(verb, "getxml") == 0) {
577 g_ctl_getxml(req, mp);
578 } else if (mp->ctlreq == NULL) {
579 gctl_error(req, "Class takes no requests");
581 mp->ctlreq(req, mp, verb);
587 g_ctl_ioctl_ctl(struct cdev *dev, u_long cmd, caddr_t data, int fflag, struct thread *td)
589 struct gctl_req *req;
594 /* It is an error if we cannot return an error text */
597 if (!useracc(req->error, req->lerror, VM_PROT_WRITE))
600 req->serror = sbuf_new_auto();
601 /* Check the version */
602 if (req->version != GCTL_VERSION) {
603 gctl_error(req, "kernel and libgeom version mismatch.");
606 /* Get things on board */
609 if (g_debugflags & G_F_CTLDUMP)
610 gctl_dump(req, "request");
613 g_waitfor_event(g_ctl_req, req, M_WAITOK, NULL);
615 if (g_debugflags & G_F_CTLDUMP)
616 gctl_dump(req, "result");
621 if (sbuf_done(req->serror)) {
622 copyout(sbuf_data(req->serror), req->error,
623 imin(req->lerror, sbuf_len(req->serror) + 1));
626 nerror = req->nerror;
632 g_ctl_ioctl(struct cdev *dev, u_long cmd, caddr_t data, int fflag, struct thread *td)
638 error = g_ctl_ioctl_ctl(dev, cmd, data, fflag, td);