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$");
43 #include <sys/param.h>
44 #include <sys/systm.h>
45 #include <sys/kernel.h>
46 #include <sys/sysctl.h>
50 #include <sys/malloc.h>
51 #include <sys/sysctl.h>
55 #include <sys/mutex.h>
58 #include <vm/vm_extern.h>
60 #include <geom/geom.h>
61 #include <geom/geom_int.h>
63 #include <geom/geom_ctl.h>
65 #include <machine/stdarg.h>
67 static d_ioctl_t g_ctl_ioctl;
69 static struct cdevsw g_ctl_cdevsw = {
70 .d_version = D_VERSION,
71 .d_flags = D_NEEDGIANT,
72 .d_ioctl = g_ctl_ioctl,
80 make_dev_credf(MAKEDEV_ETERNAL, &g_ctl_cdevsw, 0, NULL,
81 UID_ROOT, GID_OPERATOR, 0640, PATH_GEOM_CTL);
82 KASSERT(GCTL_PARAM_RD == VM_PROT_READ,
83 ("GCTL_PARAM_RD != VM_PROT_READ"));
84 KASSERT(GCTL_PARAM_WR == VM_PROT_WRITE,
85 ("GCTL_PARAM_WR != VM_PROT_WRITE"));
89 * Report an error back to the user in ascii format. Return nerror
90 * or EINVAL if nerror isn't specified.
93 gctl_error(struct gctl_req *req, const char *fmt, ...)
100 /* We only record the first error */
101 if (sbuf_done(req->serror)) {
103 req->nerror = EEXIST;
104 return (req->nerror);
107 req->nerror = EINVAL;
110 sbuf_vprintf(req->serror, fmt, ap);
112 sbuf_finish(req->serror);
113 if (g_debugflags & G_F_CTLDUMP)
114 printf("gctl %p error \"%s\"\n", req, sbuf_data(req->serror));
115 return (req->nerror);
119 * Allocate space and copyin() something.
120 * XXX: this should really be a standard function in the kernel.
123 geom_alloc_copyin(struct gctl_req *req, void *uaddr, size_t len)
127 ptr = g_malloc(len, M_WAITOK);
128 req->nerror = copyin(uaddr, ptr, len);
136 gctl_copyin(struct gctl_req *req)
138 struct gctl_req_arg *ap;
142 ap = geom_alloc_copyin(req, req->arg, req->narg * sizeof(*ap));
144 gctl_error(req, "bad control request");
149 /* Nothing have been copyin()'ed yet */
150 for (i = 0; i < req->narg; i++) {
151 ap[i].flag &= ~(GCTL_PARAM_NAMEKERNEL|GCTL_PARAM_VALUEKERNEL);
152 ap[i].flag &= ~GCTL_PARAM_CHANGED;
156 for (i = 0; i < req->narg; i++) {
157 if (ap[i].nlen < 1 || ap[i].nlen > SPECNAMELEN) {
159 "wrong param name length %d: %d", i, ap[i].nlen);
162 p = geom_alloc_copyin(req, ap[i].name, ap[i].nlen);
165 if (p[ap[i].nlen - 1] != '\0') {
166 gctl_error(req, "unterminated param name");
171 ap[i].flag |= GCTL_PARAM_NAMEKERNEL;
172 if (ap[i].len <= 0) {
173 gctl_error(req, "negative param length");
176 p = geom_alloc_copyin(req, ap[i].value, ap[i].len);
179 if ((ap[i].flag & GCTL_PARAM_ASCII) &&
180 p[ap[i].len - 1] != '\0') {
181 gctl_error(req, "unterminated param value");
186 ap[i].flag |= GCTL_PARAM_VALUEKERNEL;
193 gctl_copyout(struct gctl_req *req)
196 struct gctl_req_arg *ap;
202 for (i = 0; i < req->narg; i++, ap++) {
203 if (!(ap->flag & GCTL_PARAM_CHANGED))
205 error = copyout(ap->kvalue, ap->value, ap->len);
215 gctl_free(struct gctl_req *req)
219 sbuf_delete(req->serror);
220 if (req->arg == NULL)
222 for (i = 0; i < req->narg; i++) {
223 if (req->arg[i].flag & GCTL_PARAM_NAMEKERNEL)
224 g_free(req->arg[i].name);
225 if ((req->arg[i].flag & GCTL_PARAM_VALUEKERNEL) &&
227 g_free(req->arg[i].kvalue);
233 gctl_dump(struct gctl_req *req)
235 struct gctl_req_arg *ap;
239 printf("Dump of gctl request at %p:\n", req);
240 if (req->nerror > 0) {
241 printf(" nerror:\t%d\n", req->nerror);
242 if (sbuf_len(req->serror) > 0)
243 printf(" error:\t\"%s\"\n", sbuf_data(req->serror));
245 if (req->arg == NULL)
247 for (i = 0; i < req->narg; i++) {
249 if (!(ap->flag & GCTL_PARAM_NAMEKERNEL))
250 printf(" param:\t%d@%p", ap->nlen, ap->name);
252 printf(" param:\t\"%s\"", ap->name);
253 printf(" [%s%s%d] = ",
254 ap->flag & GCTL_PARAM_RD ? "R" : "",
255 ap->flag & GCTL_PARAM_WR ? "W" : "",
257 if (!(ap->flag & GCTL_PARAM_VALUEKERNEL)) {
258 printf(" =@ %p", ap->value);
259 } else if (ap->flag & GCTL_PARAM_ASCII) {
260 printf("\"%s\"", (char *)ap->kvalue);
261 } else if (ap->len > 0) {
262 for (j = 0; j < ap->len && j < 512; j++)
263 printf(" %02x", ((u_char *)ap->kvalue)[j]);
265 printf(" = %p", ap->kvalue);
272 gctl_set_param(struct gctl_req *req, const char *param, void const *ptr,
276 struct gctl_req_arg *ap;
278 for (i = 0; i < req->narg; i++) {
280 if (strcmp(param, ap->name))
282 if (!(ap->flag & GCTL_PARAM_WR))
284 ap->flag |= GCTL_PARAM_CHANGED;
286 bcopy(ptr, ap->kvalue, ap->len);
289 bcopy(ptr, ap->kvalue, len);
296 gctl_set_param_err(struct gctl_req *req, const char *param, void const *ptr,
300 switch (gctl_set_param(req, param, ptr, len)) {
302 gctl_error(req, "No write access %s argument", param);
305 gctl_error(req, "Wrong length %s argument", param);
308 gctl_error(req, "Missing %s argument", param);
314 gctl_get_param(struct gctl_req *req, const char *param, int *len)
318 struct gctl_req_arg *ap;
320 for (i = 0; i < req->narg; i++) {
322 if (strcmp(param, ap->name))
324 if (!(ap->flag & GCTL_PARAM_RD))
335 gctl_get_asciiparam(struct gctl_req *req, const char *param)
339 struct gctl_req_arg *ap;
341 for (i = 0; i < req->narg; i++) {
343 if (strcmp(param, ap->name))
345 if (!(ap->flag & GCTL_PARAM_RD))
349 gctl_error(req, "No length argument (%s)", param);
352 if (p[ap->len - 1] != '\0') {
353 gctl_error(req, "Unterminated argument (%s)", param);
362 gctl_get_paraml(struct gctl_req *req, const char *param, int len)
367 p = gctl_get_param(req, param, &i);
369 gctl_error(req, "Missing %s argument", param);
372 gctl_error(req, "Wrong length %s argument", param);
378 gctl_get_class(struct gctl_req *req, char const *arg)
383 p = gctl_get_asciiparam(req, arg);
386 LIST_FOREACH(cp, &g_classes, class) {
387 if (!strcmp(p, cp->name))
394 gctl_get_geom(struct gctl_req *req, struct g_class *mpr, char const *arg)
400 p = gctl_get_asciiparam(req, arg);
403 LIST_FOREACH(mp, &g_classes, class) {
404 if (mpr != NULL && mpr != mp)
406 LIST_FOREACH(gp, &mp->geom, geom) {
407 if (!strcmp(p, gp->name))
411 gctl_error(req, "Geom not found: \"%s\"", p);
416 gctl_get_provider(struct gctl_req *req, char const *arg)
419 struct g_provider *pp;
421 p = gctl_get_asciiparam(req, arg);
424 pp = g_provider_by_name(p);
427 gctl_error(req, "Provider not found: \"%s\"", p);
432 g_ctl_req(void *arg, int flag __unused)
435 struct gctl_req *req;
440 mp = gctl_get_class(req, "class");
442 gctl_error(req, "Class not found");
445 if (mp->ctlreq == NULL) {
446 gctl_error(req, "Class takes no requests");
449 verb = gctl_get_param(req, "verb", NULL);
451 gctl_error(req, "Verb missing");
454 mp->ctlreq(req, mp, verb);
460 g_ctl_ioctl_ctl(struct cdev *dev, u_long cmd, caddr_t data, int fflag, struct thread *td)
462 struct gctl_req *req;
467 /* It is an error if we cannot return an error text */
470 if (!useracc(req->error, req->lerror, VM_PROT_WRITE))
473 req->serror = sbuf_new_auto();
474 /* Check the version */
475 if (req->version != GCTL_VERSION) {
476 gctl_error(req, "kernel and libgeom version mismatch.");
479 /* Get things on board */
482 if (g_debugflags & G_F_CTLDUMP)
486 g_waitfor_event(g_ctl_req, req, M_WAITOK, NULL);
490 if (sbuf_done(req->serror)) {
491 copyout(sbuf_data(req->serror), req->error,
492 imin(req->lerror, sbuf_len(req->serror) + 1));
495 nerror = req->nerror;
501 g_ctl_ioctl(struct cdev *dev, u_long cmd, caddr_t data, int fflag, struct thread *td)
507 error = g_ctl_ioctl_ctl(dev, cmd, data, fflag, td);