2 * Copyright (c) 2002 Poul-Henning Kamp
3 * Copyright (c) 2002 Networks Associates Technology, Inc.
6 * This software was developed for the FreeBSD Project by Poul-Henning Kamp
7 * and NAI Labs, the Security Research Division of Network Associates, Inc.
8 * under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the
9 * DARPA CHATS research program.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 * 3. The names of the authors may not be used to endorse or promote
20 * products derived from this software without specific prior written
23 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36 #include <sys/cdefs.h>
37 __FBSDID("$FreeBSD$");
41 #include <sys/param.h>
42 #include <sys/systm.h>
43 #include <sys/kernel.h>
44 #include <sys/sysctl.h>
48 #include <sys/malloc.h>
49 #include <sys/sysctl.h>
53 #include <sys/mutex.h>
56 #include <vm/vm_extern.h>
58 #include <geom/geom.h>
59 #include <geom/geom_int.h>
61 #include <geom/geom_ctl.h>
63 #include <machine/stdarg.h>
65 static d_ioctl_t g_ctl_ioctl;
67 static struct cdevsw g_ctl_cdevsw = {
68 .d_version = D_VERSION,
69 .d_flags = D_NEEDGIANT,
70 .d_ioctl = g_ctl_ioctl,
78 make_dev_credf(MAKEDEV_ETERNAL, &g_ctl_cdevsw, 0, NULL,
79 UID_ROOT, GID_OPERATOR, 0640, PATH_GEOM_CTL);
80 KASSERT(GCTL_PARAM_RD == VM_PROT_READ,
81 ("GCTL_PARAM_RD != VM_PROT_READ"));
82 KASSERT(GCTL_PARAM_WR == VM_PROT_WRITE,
83 ("GCTL_PARAM_WR != VM_PROT_WRITE"));
87 * Report an error back to the user in ascii format. Return nerror
88 * or EINVAL if nerror isn't specified.
91 gctl_error(struct gctl_req *req, const char *fmt, ...)
98 /* We only record the first error */
99 if (sbuf_done(req->serror)) {
101 req->nerror = EEXIST;
102 return (req->nerror);
105 req->nerror = EINVAL;
108 sbuf_vprintf(req->serror, fmt, ap);
110 sbuf_finish(req->serror);
111 if (g_debugflags & G_F_CTLDUMP)
112 printf("gctl %p error \"%s\"\n", req, sbuf_data(req->serror));
113 return (req->nerror);
117 * Allocate space and copyin() something.
118 * XXX: this should really be a standard function in the kernel.
121 geom_alloc_copyin(struct gctl_req *req, void *uaddr, size_t len)
125 ptr = g_malloc(len, M_WAITOK);
126 req->nerror = copyin(uaddr, ptr, len);
134 gctl_copyin(struct gctl_req *req)
136 struct gctl_req_arg *ap;
140 if (req->narg > GEOM_CTL_ARG_MAX) {
141 gctl_error(req, "too many arguments");
146 ap = geom_alloc_copyin(req, req->arg, req->narg * sizeof(*ap));
148 gctl_error(req, "bad control request");
153 /* Nothing have been copyin()'ed yet */
154 for (i = 0; i < req->narg; i++) {
155 ap[i].flag &= ~(GCTL_PARAM_NAMEKERNEL|GCTL_PARAM_VALUEKERNEL);
156 ap[i].flag &= ~GCTL_PARAM_CHANGED;
160 for (i = 0; i < req->narg; i++) {
161 if (ap[i].nlen < 1 || ap[i].nlen > SPECNAMELEN) {
163 "wrong param name length %d: %d", i, ap[i].nlen);
166 p = geom_alloc_copyin(req, ap[i].name, ap[i].nlen);
169 if (p[ap[i].nlen - 1] != '\0') {
170 gctl_error(req, "unterminated param name");
175 ap[i].flag |= GCTL_PARAM_NAMEKERNEL;
176 if (ap[i].len <= 0) {
177 gctl_error(req, "negative param length");
180 p = geom_alloc_copyin(req, ap[i].value, ap[i].len);
183 if ((ap[i].flag & GCTL_PARAM_ASCII) &&
184 p[ap[i].len - 1] != '\0') {
185 gctl_error(req, "unterminated param value");
190 ap[i].flag |= GCTL_PARAM_VALUEKERNEL;
197 gctl_copyout(struct gctl_req *req)
200 struct gctl_req_arg *ap;
206 for (i = 0; i < req->narg; i++, ap++) {
207 if (!(ap->flag & GCTL_PARAM_CHANGED))
209 error = copyout(ap->kvalue, ap->value, ap->len);
219 gctl_free(struct gctl_req *req)
223 sbuf_delete(req->serror);
224 if (req->arg == NULL)
226 for (i = 0; i < req->narg; i++) {
227 if (req->arg[i].flag & GCTL_PARAM_NAMEKERNEL)
228 g_free(req->arg[i].name);
229 if ((req->arg[i].flag & GCTL_PARAM_VALUEKERNEL) &&
231 g_free(req->arg[i].kvalue);
237 gctl_dump(struct gctl_req *req)
239 struct gctl_req_arg *ap;
243 printf("Dump of gctl request at %p:\n", req);
244 if (req->nerror > 0) {
245 printf(" nerror:\t%d\n", req->nerror);
246 if (sbuf_len(req->serror) > 0)
247 printf(" error:\t\"%s\"\n", sbuf_data(req->serror));
249 if (req->arg == NULL)
251 for (i = 0; i < req->narg; i++) {
253 if (!(ap->flag & GCTL_PARAM_NAMEKERNEL))
254 printf(" param:\t%d@%p", ap->nlen, ap->name);
256 printf(" param:\t\"%s\"", ap->name);
257 printf(" [%s%s%d] = ",
258 ap->flag & GCTL_PARAM_RD ? "R" : "",
259 ap->flag & GCTL_PARAM_WR ? "W" : "",
261 if (!(ap->flag & GCTL_PARAM_VALUEKERNEL)) {
262 printf(" =@ %p", ap->value);
263 } else if (ap->flag & GCTL_PARAM_ASCII) {
264 printf("\"%s\"", (char *)ap->kvalue);
265 } else if (ap->len > 0) {
266 for (j = 0; j < ap->len && j < 512; j++)
267 printf(" %02x", ((u_char *)ap->kvalue)[j]);
269 printf(" = %p", ap->kvalue);
276 gctl_set_param(struct gctl_req *req, const char *param, void const *ptr,
280 struct gctl_req_arg *ap;
282 for (i = 0; i < req->narg; i++) {
284 if (strcmp(param, ap->name))
286 if (!(ap->flag & GCTL_PARAM_WR))
288 ap->flag |= GCTL_PARAM_CHANGED;
290 bcopy(ptr, ap->kvalue, ap->len);
293 bcopy(ptr, ap->kvalue, len);
300 gctl_set_param_err(struct gctl_req *req, const char *param, void const *ptr,
304 switch (gctl_set_param(req, param, ptr, len)) {
306 gctl_error(req, "No write access %s argument", param);
309 gctl_error(req, "Wrong length %s argument", param);
312 gctl_error(req, "Missing %s argument", param);
318 gctl_get_param(struct gctl_req *req, const char *param, int *len)
322 struct gctl_req_arg *ap;
324 for (i = 0; i < req->narg; i++) {
326 if (strcmp(param, ap->name))
328 if (!(ap->flag & GCTL_PARAM_RD))
339 gctl_get_asciiparam(struct gctl_req *req, const char *param)
343 struct gctl_req_arg *ap;
345 for (i = 0; i < req->narg; i++) {
347 if (strcmp(param, ap->name))
349 if (!(ap->flag & GCTL_PARAM_RD))
353 gctl_error(req, "No length argument (%s)", param);
356 if (p[ap->len - 1] != '\0') {
357 gctl_error(req, "Unterminated argument (%s)", param);
366 gctl_get_paraml(struct gctl_req *req, const char *param, int len)
371 p = gctl_get_param(req, param, &i);
373 gctl_error(req, "Missing %s argument", param);
376 gctl_error(req, "Wrong length %s argument", param);
382 gctl_get_class(struct gctl_req *req, char const *arg)
387 p = gctl_get_asciiparam(req, arg);
390 LIST_FOREACH(cp, &g_classes, class) {
391 if (!strcmp(p, cp->name))
398 gctl_get_geom(struct gctl_req *req, struct g_class *mpr, char const *arg)
404 p = gctl_get_asciiparam(req, arg);
407 LIST_FOREACH(mp, &g_classes, class) {
408 if (mpr != NULL && mpr != mp)
410 LIST_FOREACH(gp, &mp->geom, geom) {
411 if (!strcmp(p, gp->name))
415 gctl_error(req, "Geom not found: \"%s\"", p);
420 gctl_get_provider(struct gctl_req *req, char const *arg)
423 struct g_provider *pp;
425 p = gctl_get_asciiparam(req, arg);
428 pp = g_provider_by_name(p);
431 gctl_error(req, "Provider not found: \"%s\"", p);
436 g_ctl_req(void *arg, int flag __unused)
439 struct gctl_req *req;
444 mp = gctl_get_class(req, "class");
446 gctl_error(req, "Class not found");
449 if (mp->ctlreq == NULL) {
450 gctl_error(req, "Class takes no requests");
453 verb = gctl_get_param(req, "verb", NULL);
455 gctl_error(req, "Verb missing");
458 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);