2 * Copyright (c) 2004-2006 Pawel Jakub Dawidek <pjd@FreeBSD.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
30 #include <sys/param.h>
31 #include <sys/systm.h>
32 #include <sys/kernel.h>
33 #include <sys/module.h>
35 #include <sys/mutex.h>
38 #include <sys/sysctl.h>
39 #include <sys/malloc.h>
40 #include <geom/geom.h>
41 #include <geom/nop/g_nop.h>
44 SYSCTL_DECL(_kern_geom);
45 SYSCTL_NODE(_kern_geom, OID_AUTO, nop, CTLFLAG_RW, 0, "GEOM_NOP stuff");
46 static u_int g_nop_debug = 0;
47 SYSCTL_UINT(_kern_geom_nop, OID_AUTO, debug, CTLFLAG_RW, &g_nop_debug, 0,
50 static int g_nop_destroy(struct g_geom *gp, boolean_t force);
51 static int g_nop_destroy_geom(struct gctl_req *req, struct g_class *mp,
53 static void g_nop_config(struct gctl_req *req, struct g_class *mp,
55 static void g_nop_dumpconf(struct sbuf *sb, const char *indent,
56 struct g_geom *gp, struct g_consumer *cp, struct g_provider *pp);
58 struct g_class g_nop_class = {
59 .name = G_NOP_CLASS_NAME,
61 .ctlreq = g_nop_config,
62 .destroy_geom = g_nop_destroy_geom
67 g_nop_orphan(struct g_consumer *cp)
71 g_nop_destroy(cp->geom, 1);
75 g_nop_start(struct bio *bp)
77 struct g_nop_softc *sc;
79 struct g_provider *pp;
83 gp = bp->bio_to->geom;
85 G_NOP_LOGREQ(bp, "Request received.");
86 switch (bp->bio_cmd) {
89 sc->sc_readbytes += bp->bio_length;
90 failprob = sc->sc_rfailprob;
94 sc->sc_wrotebytes += bp->bio_length;
95 failprob = sc->sc_wfailprob;
101 rval = arc4random() % 100;
102 if (rval < failprob) {
103 G_NOP_LOGREQ(bp, "Returning error=%d.", sc->sc_error);
104 g_io_deliver(bp, sc->sc_error);
108 cbp = g_clone_bio(bp);
110 g_io_deliver(bp, ENOMEM);
113 cbp->bio_done = g_std_done;
114 cbp->bio_offset = bp->bio_offset + sc->sc_offset;
115 cbp->bio_data = bp->bio_data;
116 cbp->bio_length = bp->bio_length;
117 pp = LIST_FIRST(&gp->provider);
118 KASSERT(pp != NULL, ("NULL pp"));
120 G_NOP_LOGREQ(cbp, "Sending request.");
121 g_io_request(cbp, LIST_FIRST(&gp->consumer));
125 g_nop_access(struct g_provider *pp, int dr, int dw, int de)
128 struct g_consumer *cp;
132 cp = LIST_FIRST(&gp->consumer);
133 error = g_access(cp, dr, dw, de);
139 g_nop_create(struct gctl_req *req, struct g_class *mp, struct g_provider *pp,
140 int ioerror, u_int rfailprob, u_int wfailprob, off_t offset, off_t size,
143 struct g_nop_softc *sc;
145 struct g_provider *newpp;
146 struct g_consumer *cp;
156 if ((offset % pp->sectorsize) != 0) {
157 gctl_error(req, "Invalid offset for provider %s.", pp->name);
160 if ((size % pp->sectorsize) != 0) {
161 gctl_error(req, "Invalid size for provider %s.", pp->name);
164 if (offset >= pp->mediasize) {
165 gctl_error(req, "Invalid offset for provider %s.", pp->name);
169 size = pp->mediasize - offset;
170 if (offset + size > pp->mediasize) {
171 gctl_error(req, "Invalid size for provider %s.", pp->name);
175 secsize = pp->sectorsize;
176 else if ((secsize % pp->sectorsize) != 0) {
177 gctl_error(req, "Invalid secsize for provider %s.", pp->name);
180 if (secsize > MAXPHYS) {
181 gctl_error(req, "secsize is too big.");
184 size -= size % secsize;
185 snprintf(name, sizeof(name), "%s%s", pp->name, G_NOP_SUFFIX);
186 LIST_FOREACH(gp, &mp->geom, geom) {
187 if (strcmp(gp->name, name) == 0) {
188 gctl_error(req, "Provider %s already exists.", name);
192 gp = g_new_geomf(mp, name);
193 sc = g_malloc(sizeof(*sc), M_WAITOK);
194 sc->sc_offset = offset;
195 sc->sc_error = ioerror;
196 sc->sc_rfailprob = rfailprob;
197 sc->sc_wfailprob = wfailprob;
200 sc->sc_readbytes = 0;
201 sc->sc_wrotebytes = 0;
203 gp->start = g_nop_start;
204 gp->orphan = g_nop_orphan;
205 gp->access = g_nop_access;
206 gp->dumpconf = g_nop_dumpconf;
208 newpp = g_new_providerf(gp, gp->name);
209 newpp->mediasize = size;
210 newpp->sectorsize = secsize;
212 cp = g_new_consumer(gp);
213 error = g_attach(cp, pp);
215 gctl_error(req, "Cannot attach to provider %s.", pp->name);
219 g_error_provider(newpp, 0);
220 G_NOP_DEBUG(0, "Device %s created.", gp->name);
223 if (cp->provider != NULL)
225 g_destroy_consumer(cp);
226 g_destroy_provider(newpp);
233 g_nop_destroy(struct g_geom *gp, boolean_t force)
235 struct g_provider *pp;
238 if (gp->softc == NULL)
240 pp = LIST_FIRST(&gp->provider);
241 if (pp != NULL && (pp->acr != 0 || pp->acw != 0 || pp->ace != 0)) {
243 G_NOP_DEBUG(0, "Device %s is still open, so it "
244 "can't be definitely removed.", pp->name);
246 G_NOP_DEBUG(1, "Device %s is still open (r%dw%de%d).",
247 pp->name, pp->acr, pp->acw, pp->ace);
251 G_NOP_DEBUG(0, "Device %s removed.", gp->name);
255 g_wither_geom(gp, ENXIO);
261 g_nop_destroy_geom(struct gctl_req *req, struct g_class *mp, struct g_geom *gp)
264 return (g_nop_destroy(gp, 0));
268 g_nop_ctl_create(struct gctl_req *req, struct g_class *mp)
270 struct g_provider *pp;
271 intmax_t *error, *rfailprob, *wfailprob, *offset, *secsize, *size;
278 nargs = gctl_get_paraml(req, "nargs", sizeof(*nargs));
280 gctl_error(req, "No '%s' argument", "nargs");
284 gctl_error(req, "Missing device(s).");
287 error = gctl_get_paraml(req, "error", sizeof(*error));
289 gctl_error(req, "No '%s' argument", "error");
292 rfailprob = gctl_get_paraml(req, "rfailprob", sizeof(*rfailprob));
293 if (rfailprob == NULL) {
294 gctl_error(req, "No '%s' argument", "rfailprob");
297 if (*rfailprob < -1 || *rfailprob > 100) {
298 gctl_error(req, "Invalid '%s' argument", "rfailprob");
301 wfailprob = gctl_get_paraml(req, "wfailprob", sizeof(*wfailprob));
302 if (wfailprob == NULL) {
303 gctl_error(req, "No '%s' argument", "wfailprob");
306 if (*wfailprob < -1 || *wfailprob > 100) {
307 gctl_error(req, "Invalid '%s' argument", "wfailprob");
310 offset = gctl_get_paraml(req, "offset", sizeof(*offset));
311 if (offset == NULL) {
312 gctl_error(req, "No '%s' argument", "offset");
316 gctl_error(req, "Invalid '%s' argument", "offset");
319 size = gctl_get_paraml(req, "size", sizeof(*size));
321 gctl_error(req, "No '%s' argument", "size");
325 gctl_error(req, "Invalid '%s' argument", "size");
328 secsize = gctl_get_paraml(req, "secsize", sizeof(*secsize));
329 if (secsize == NULL) {
330 gctl_error(req, "No '%s' argument", "secsize");
334 gctl_error(req, "Invalid '%s' argument", "secsize");
338 for (i = 0; i < *nargs; i++) {
339 snprintf(param, sizeof(param), "arg%d", i);
340 name = gctl_get_asciiparam(req, param);
342 gctl_error(req, "No 'arg%d' argument", i);
345 if (strncmp(name, "/dev/", strlen("/dev/")) == 0)
346 name += strlen("/dev/");
347 pp = g_provider_by_name(name);
349 G_NOP_DEBUG(1, "Provider %s is invalid.", name);
350 gctl_error(req, "Provider %s is invalid.", name);
353 if (g_nop_create(req, mp, pp,
354 *error == -1 ? EIO : (int)*error,
355 *rfailprob == -1 ? 0 : (u_int)*rfailprob,
356 *wfailprob == -1 ? 0 : (u_int)*wfailprob,
357 (off_t)*offset, (off_t)*size, (u_int)*secsize) != 0) {
364 g_nop_ctl_configure(struct gctl_req *req, struct g_class *mp)
366 struct g_nop_softc *sc;
367 struct g_provider *pp;
368 intmax_t *error, *rfailprob, *wfailprob;
375 nargs = gctl_get_paraml(req, "nargs", sizeof(*nargs));
377 gctl_error(req, "No '%s' argument", "nargs");
381 gctl_error(req, "Missing device(s).");
384 error = gctl_get_paraml(req, "error", sizeof(*error));
386 gctl_error(req, "No '%s' argument", "error");
389 rfailprob = gctl_get_paraml(req, "rfailprob", sizeof(*rfailprob));
390 if (rfailprob == NULL) {
391 gctl_error(req, "No '%s' argument", "rfailprob");
394 if (*rfailprob < -1 || *rfailprob > 100) {
395 gctl_error(req, "Invalid '%s' argument", "rfailprob");
398 wfailprob = gctl_get_paraml(req, "wfailprob", sizeof(*wfailprob));
399 if (wfailprob == NULL) {
400 gctl_error(req, "No '%s' argument", "wfailprob");
403 if (*wfailprob < -1 || *wfailprob > 100) {
404 gctl_error(req, "Invalid '%s' argument", "wfailprob");
408 for (i = 0; i < *nargs; i++) {
409 snprintf(param, sizeof(param), "arg%d", i);
410 name = gctl_get_asciiparam(req, param);
412 gctl_error(req, "No 'arg%d' argument", i);
415 if (strncmp(name, "/dev/", strlen("/dev/")) == 0)
416 name += strlen("/dev/");
417 pp = g_provider_by_name(name);
418 if (pp == NULL || pp->geom->class != mp) {
419 G_NOP_DEBUG(1, "Provider %s is invalid.", name);
420 gctl_error(req, "Provider %s is invalid.", name);
423 sc = pp->geom->softc;
425 sc->sc_error = (int)*error;
426 if (*rfailprob != -1)
427 sc->sc_rfailprob = (u_int)*rfailprob;
428 if (*wfailprob != -1)
429 sc->sc_wfailprob = (u_int)*wfailprob;
433 static struct g_geom *
434 g_nop_find_geom(struct g_class *mp, const char *name)
438 LIST_FOREACH(gp, &mp->geom, geom) {
439 if (strcmp(gp->name, name) == 0)
446 g_nop_ctl_destroy(struct gctl_req *req, struct g_class *mp)
448 int *nargs, *force, error, i;
455 nargs = gctl_get_paraml(req, "nargs", sizeof(*nargs));
457 gctl_error(req, "No '%s' argument", "nargs");
461 gctl_error(req, "Missing device(s).");
464 force = gctl_get_paraml(req, "force", sizeof(*force));
466 gctl_error(req, "No 'force' argument");
470 for (i = 0; i < *nargs; i++) {
471 snprintf(param, sizeof(param), "arg%d", i);
472 name = gctl_get_asciiparam(req, param);
474 gctl_error(req, "No 'arg%d' argument", i);
477 if (strncmp(name, "/dev/", strlen("/dev/")) == 0)
478 name += strlen("/dev/");
479 gp = g_nop_find_geom(mp, name);
481 G_NOP_DEBUG(1, "Device %s is invalid.", name);
482 gctl_error(req, "Device %s is invalid.", name);
485 error = g_nop_destroy(gp, *force);
487 gctl_error(req, "Cannot destroy device %s (error=%d).",
495 g_nop_ctl_reset(struct gctl_req *req, struct g_class *mp)
497 struct g_nop_softc *sc;
498 struct g_provider *pp;
505 nargs = gctl_get_paraml(req, "nargs", sizeof(*nargs));
507 gctl_error(req, "No '%s' argument", "nargs");
511 gctl_error(req, "Missing device(s).");
515 for (i = 0; i < *nargs; i++) {
516 snprintf(param, sizeof(param), "arg%d", i);
517 name = gctl_get_asciiparam(req, param);
519 gctl_error(req, "No 'arg%d' argument", i);
522 if (strncmp(name, "/dev/", strlen("/dev/")) == 0)
523 name += strlen("/dev/");
524 pp = g_provider_by_name(name);
525 if (pp == NULL || pp->geom->class != mp) {
526 G_NOP_DEBUG(1, "Provider %s is invalid.", name);
527 gctl_error(req, "Provider %s is invalid.", name);
530 sc = pp->geom->softc;
533 sc->sc_readbytes = 0;
534 sc->sc_wrotebytes = 0;
539 g_nop_config(struct gctl_req *req, struct g_class *mp, const char *verb)
545 version = gctl_get_paraml(req, "version", sizeof(*version));
546 if (version == NULL) {
547 gctl_error(req, "No '%s' argument.", "version");
550 if (*version != G_NOP_VERSION) {
551 gctl_error(req, "Userland and kernel parts are out of sync.");
555 if (strcmp(verb, "create") == 0) {
556 g_nop_ctl_create(req, mp);
558 } else if (strcmp(verb, "configure") == 0) {
559 g_nop_ctl_configure(req, mp);
561 } else if (strcmp(verb, "destroy") == 0) {
562 g_nop_ctl_destroy(req, mp);
564 } else if (strcmp(verb, "reset") == 0) {
565 g_nop_ctl_reset(req, mp);
569 gctl_error(req, "Unknown verb.");
573 g_nop_dumpconf(struct sbuf *sb, const char *indent, struct g_geom *gp,
574 struct g_consumer *cp, struct g_provider *pp)
576 struct g_nop_softc *sc;
578 if (pp != NULL || cp != NULL)
581 sbuf_printf(sb, "%s<Offset>%jd</Offset>\n", indent,
582 (intmax_t)sc->sc_offset);
583 sbuf_printf(sb, "%s<ReadFailProb>%u</ReadFailProb>\n", indent,
585 sbuf_printf(sb, "%s<WriteFailProb>%u</WriteFailProb>\n", indent,
587 sbuf_printf(sb, "%s<Error>%d</Error>\n", indent, sc->sc_error);
588 sbuf_printf(sb, "%s<Reads>%ju</Reads>\n", indent, sc->sc_reads);
589 sbuf_printf(sb, "%s<Writes>%ju</Writes>\n", indent, sc->sc_writes);
590 sbuf_printf(sb, "%s<ReadBytes>%ju</ReadBytes>\n", indent,
592 sbuf_printf(sb, "%s<WroteBytes>%ju</WroteBytes>\n", indent,
596 DECLARE_GEOM_CLASS(g_nop_class, g_nop);