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>
37 #include <sys/sysctl.h>
38 #include <sys/malloc.h>
39 #include <geom/geom.h>
40 #include <geom/nop/g_nop.h>
43 SYSCTL_DECL(_kern_geom);
44 SYSCTL_NODE(_kern_geom, OID_AUTO, nop, CTLFLAG_RW, 0, "GEOM_NOP stuff");
45 static u_int g_nop_debug = 0;
46 SYSCTL_UINT(_kern_geom_nop, OID_AUTO, debug, CTLFLAG_RW, &g_nop_debug, 0,
49 static int g_nop_destroy(struct g_geom *gp, boolean_t force);
50 static int g_nop_destroy_geom(struct gctl_req *req, struct g_class *mp,
52 static void g_nop_config(struct gctl_req *req, struct g_class *mp,
54 static void g_nop_dumpconf(struct sbuf *sb, const char *indent,
55 struct g_geom *gp, struct g_consumer *cp, struct g_provider *pp);
57 struct g_class g_nop_class = {
58 .name = G_NOP_CLASS_NAME,
60 .ctlreq = g_nop_config,
61 .destroy_geom = g_nop_destroy_geom
66 g_nop_orphan(struct g_consumer *cp)
70 g_nop_destroy(cp->geom, 1);
74 g_nop_start(struct bio *bp)
76 struct g_nop_softc *sc;
78 struct g_provider *pp;
82 gp = bp->bio_to->geom;
84 G_NOP_LOGREQ(bp, "Request received.");
85 switch (bp->bio_cmd) {
88 sc->sc_readbytes += bp->bio_length;
89 failprob = sc->sc_rfailprob;
93 sc->sc_wrotebytes += bp->bio_length;
94 failprob = sc->sc_wfailprob;
100 rval = arc4random() % 100;
101 if (rval < failprob) {
102 G_NOP_LOGREQ(bp, "Returning error=%d.", sc->sc_error);
103 g_io_deliver(bp, sc->sc_error);
107 cbp = g_clone_bio(bp);
109 g_io_deliver(bp, ENOMEM);
112 cbp->bio_done = g_std_done;
113 cbp->bio_offset = bp->bio_offset + sc->sc_offset;
114 cbp->bio_data = bp->bio_data;
115 cbp->bio_length = bp->bio_length;
116 pp = LIST_FIRST(&gp->provider);
117 KASSERT(pp != NULL, ("NULL pp"));
119 G_NOP_LOGREQ(cbp, "Sending request.");
120 g_io_request(cbp, LIST_FIRST(&gp->consumer));
124 g_nop_access(struct g_provider *pp, int dr, int dw, int de)
127 struct g_consumer *cp;
131 cp = LIST_FIRST(&gp->consumer);
132 error = g_access(cp, dr, dw, de);
138 g_nop_create(struct gctl_req *req, struct g_class *mp, struct g_provider *pp,
139 int ioerror, u_int rfailprob, u_int wfailprob, off_t offset, off_t size,
142 struct g_nop_softc *sc;
144 struct g_provider *newpp;
145 struct g_consumer *cp;
155 if ((offset % pp->sectorsize) != 0) {
156 gctl_error(req, "Invalid offset for provider %s.", pp->name);
159 if ((size % pp->sectorsize) != 0) {
160 gctl_error(req, "Invalid size for provider %s.", pp->name);
163 if (offset >= pp->mediasize) {
164 gctl_error(req, "Invalid offset for provider %s.", pp->name);
168 size = pp->mediasize - offset;
169 if (offset + size > pp->mediasize) {
170 gctl_error(req, "Invalid size for provider %s.", pp->name);
174 secsize = pp->sectorsize;
175 else if ((secsize % pp->sectorsize) != 0) {
176 gctl_error(req, "Invalid secsize for provider %s.", pp->name);
179 snprintf(name, sizeof(name), "%s%s", pp->name, G_NOP_SUFFIX);
180 LIST_FOREACH(gp, &mp->geom, geom) {
181 if (strcmp(gp->name, name) == 0) {
182 gctl_error(req, "Provider %s already exists.", name);
186 gp = g_new_geomf(mp, name);
188 gctl_error(req, "Cannot create geom %s.", name);
191 sc = g_malloc(sizeof(*sc), M_WAITOK);
192 sc->sc_offset = offset;
193 sc->sc_error = ioerror;
194 sc->sc_rfailprob = rfailprob;
195 sc->sc_wfailprob = wfailprob;
198 sc->sc_readbytes = 0;
199 sc->sc_wrotebytes = 0;
201 gp->start = g_nop_start;
202 gp->orphan = g_nop_orphan;
203 gp->access = g_nop_access;
204 gp->dumpconf = g_nop_dumpconf;
206 newpp = g_new_providerf(gp, gp->name);
208 gctl_error(req, "Cannot create provider %s.", name);
212 newpp->mediasize = size;
213 newpp->sectorsize = secsize;
215 cp = g_new_consumer(gp);
217 gctl_error(req, "Cannot create consumer for %s.", gp->name);
221 error = g_attach(cp, pp);
223 gctl_error(req, "Cannot attach to provider %s.", pp->name);
227 g_error_provider(newpp, 0);
228 G_NOP_DEBUG(0, "Device %s created.", gp->name);
232 if (cp->provider != NULL)
234 g_destroy_consumer(cp);
237 g_destroy_provider(newpp);
239 if (gp->softc != NULL)
247 g_nop_destroy(struct g_geom *gp, boolean_t force)
249 struct g_provider *pp;
252 if (gp->softc == NULL)
254 pp = LIST_FIRST(&gp->provider);
255 if (pp != NULL && (pp->acr != 0 || pp->acw != 0 || pp->ace != 0)) {
257 G_NOP_DEBUG(0, "Device %s is still open, so it "
258 "can't be definitely removed.", pp->name);
260 G_NOP_DEBUG(1, "Device %s is still open (r%dw%de%d).",
261 pp->name, pp->acr, pp->acw, pp->ace);
265 G_NOP_DEBUG(0, "Device %s removed.", gp->name);
269 g_wither_geom(gp, ENXIO);
275 g_nop_destroy_geom(struct gctl_req *req, struct g_class *mp, struct g_geom *gp)
278 return (g_nop_destroy(gp, 0));
282 g_nop_ctl_create(struct gctl_req *req, struct g_class *mp)
284 struct g_provider *pp;
285 intmax_t *error, *rfailprob, *wfailprob, *offset, *secsize, *size;
292 nargs = gctl_get_paraml(req, "nargs", sizeof(*nargs));
294 gctl_error(req, "No '%s' argument", "nargs");
298 gctl_error(req, "Missing device(s).");
301 error = gctl_get_paraml(req, "error", sizeof(*error));
303 gctl_error(req, "No '%s' argument", "error");
306 rfailprob = gctl_get_paraml(req, "rfailprob", sizeof(*rfailprob));
307 if (rfailprob == NULL) {
308 gctl_error(req, "No '%s' argument", "rfailprob");
311 if (*rfailprob < -1 || *rfailprob > 100) {
312 gctl_error(req, "Invalid '%s' argument", "rfailprob");
315 wfailprob = gctl_get_paraml(req, "wfailprob", sizeof(*wfailprob));
316 if (wfailprob == NULL) {
317 gctl_error(req, "No '%s' argument", "wfailprob");
320 if (*wfailprob < -1 || *wfailprob > 100) {
321 gctl_error(req, "Invalid '%s' argument", "wfailprob");
324 offset = gctl_get_paraml(req, "offset", sizeof(*offset));
325 if (offset == NULL) {
326 gctl_error(req, "No '%s' argument", "offset");
330 gctl_error(req, "Invalid '%s' argument", "offset");
333 size = gctl_get_paraml(req, "size", sizeof(*size));
335 gctl_error(req, "No '%s' argument", "size");
339 gctl_error(req, "Invalid '%s' argument", "size");
342 secsize = gctl_get_paraml(req, "secsize", sizeof(*secsize));
343 if (secsize == NULL) {
344 gctl_error(req, "No '%s' argument", "secsize");
348 gctl_error(req, "Invalid '%s' argument", "secsize");
352 for (i = 0; i < *nargs; i++) {
353 snprintf(param, sizeof(param), "arg%d", i);
354 name = gctl_get_asciiparam(req, param);
356 gctl_error(req, "No 'arg%d' argument", i);
359 if (strncmp(name, "/dev/", strlen("/dev/")) == 0)
360 name += strlen("/dev/");
361 pp = g_provider_by_name(name);
363 G_NOP_DEBUG(1, "Provider %s is invalid.", name);
364 gctl_error(req, "Provider %s is invalid.", name);
367 if (g_nop_create(req, mp, pp,
368 *error == -1 ? EIO : (int)*error,
369 *rfailprob == -1 ? 0 : (u_int)*rfailprob,
370 *wfailprob == -1 ? 0 : (u_int)*wfailprob,
371 (off_t)*offset, (off_t)*size, (u_int)*secsize) != 0) {
378 g_nop_ctl_configure(struct gctl_req *req, struct g_class *mp)
380 struct g_nop_softc *sc;
381 struct g_provider *pp;
382 intmax_t *error, *rfailprob, *wfailprob;
389 nargs = gctl_get_paraml(req, "nargs", sizeof(*nargs));
391 gctl_error(req, "No '%s' argument", "nargs");
395 gctl_error(req, "Missing device(s).");
398 error = gctl_get_paraml(req, "error", sizeof(*error));
400 gctl_error(req, "No '%s' argument", "error");
403 rfailprob = gctl_get_paraml(req, "rfailprob", sizeof(*rfailprob));
404 if (rfailprob == NULL) {
405 gctl_error(req, "No '%s' argument", "rfailprob");
408 if (*rfailprob < -1 || *rfailprob > 100) {
409 gctl_error(req, "Invalid '%s' argument", "rfailprob");
412 wfailprob = gctl_get_paraml(req, "wfailprob", sizeof(*wfailprob));
413 if (wfailprob == NULL) {
414 gctl_error(req, "No '%s' argument", "wfailprob");
417 if (*wfailprob < -1 || *wfailprob > 100) {
418 gctl_error(req, "Invalid '%s' argument", "wfailprob");
422 for (i = 0; i < *nargs; i++) {
423 snprintf(param, sizeof(param), "arg%d", i);
424 name = gctl_get_asciiparam(req, param);
426 gctl_error(req, "No 'arg%d' argument", i);
429 if (strncmp(name, "/dev/", strlen("/dev/")) == 0)
430 name += strlen("/dev/");
431 pp = g_provider_by_name(name);
432 if (pp == NULL || pp->geom->class != mp) {
433 G_NOP_DEBUG(1, "Provider %s is invalid.", name);
434 gctl_error(req, "Provider %s is invalid.", name);
437 sc = pp->geom->softc;
439 sc->sc_error = (int)*error;
440 if (*rfailprob != -1)
441 sc->sc_rfailprob = (u_int)*rfailprob;
442 if (*wfailprob != -1)
443 sc->sc_wfailprob = (u_int)*wfailprob;
447 static struct g_geom *
448 g_nop_find_geom(struct g_class *mp, const char *name)
452 LIST_FOREACH(gp, &mp->geom, geom) {
453 if (strcmp(gp->name, name) == 0)
460 g_nop_ctl_destroy(struct gctl_req *req, struct g_class *mp)
462 int *nargs, *force, error, i;
469 nargs = gctl_get_paraml(req, "nargs", sizeof(*nargs));
471 gctl_error(req, "No '%s' argument", "nargs");
475 gctl_error(req, "Missing device(s).");
478 force = gctl_get_paraml(req, "force", sizeof(*force));
480 gctl_error(req, "No 'force' argument");
484 for (i = 0; i < *nargs; i++) {
485 snprintf(param, sizeof(param), "arg%d", i);
486 name = gctl_get_asciiparam(req, param);
488 gctl_error(req, "No 'arg%d' argument", i);
491 if (strncmp(name, "/dev/", strlen("/dev/")) == 0)
492 name += strlen("/dev/");
493 gp = g_nop_find_geom(mp, name);
495 G_NOP_DEBUG(1, "Device %s is invalid.", name);
496 gctl_error(req, "Device %s is invalid.", name);
499 error = g_nop_destroy(gp, *force);
501 gctl_error(req, "Cannot destroy device %s (error=%d).",
509 g_nop_ctl_reset(struct gctl_req *req, struct g_class *mp)
511 struct g_nop_softc *sc;
512 struct g_provider *pp;
519 nargs = gctl_get_paraml(req, "nargs", sizeof(*nargs));
521 gctl_error(req, "No '%s' argument", "nargs");
525 gctl_error(req, "Missing device(s).");
529 for (i = 0; i < *nargs; i++) {
530 snprintf(param, sizeof(param), "arg%d", i);
531 name = gctl_get_asciiparam(req, param);
533 gctl_error(req, "No 'arg%d' argument", i);
536 if (strncmp(name, "/dev/", strlen("/dev/")) == 0)
537 name += strlen("/dev/");
538 pp = g_provider_by_name(name);
539 if (pp == NULL || pp->geom->class != mp) {
540 G_NOP_DEBUG(1, "Provider %s is invalid.", name);
541 gctl_error(req, "Provider %s is invalid.", name);
544 sc = pp->geom->softc;
547 sc->sc_readbytes = 0;
548 sc->sc_wrotebytes = 0;
553 g_nop_config(struct gctl_req *req, struct g_class *mp, const char *verb)
559 version = gctl_get_paraml(req, "version", sizeof(*version));
560 if (version == NULL) {
561 gctl_error(req, "No '%s' argument.", "version");
564 if (*version != G_NOP_VERSION) {
565 gctl_error(req, "Userland and kernel parts are out of sync.");
569 if (strcmp(verb, "create") == 0) {
570 g_nop_ctl_create(req, mp);
572 } else if (strcmp(verb, "configure") == 0) {
573 g_nop_ctl_configure(req, mp);
575 } else if (strcmp(verb, "destroy") == 0) {
576 g_nop_ctl_destroy(req, mp);
578 } else if (strcmp(verb, "reset") == 0) {
579 g_nop_ctl_reset(req, mp);
583 gctl_error(req, "Unknown verb.");
587 g_nop_dumpconf(struct sbuf *sb, const char *indent, struct g_geom *gp,
588 struct g_consumer *cp, struct g_provider *pp)
590 struct g_nop_softc *sc;
592 if (pp != NULL || cp != NULL)
595 sbuf_printf(sb, "%s<Offset>%jd</Offset>\n", indent,
596 (intmax_t)sc->sc_offset);
597 sbuf_printf(sb, "%s<ReadFailProb>%u</ReadFailProb>\n", indent,
599 sbuf_printf(sb, "%s<WriteFailProb>%u</WriteFailProb>\n", indent,
601 sbuf_printf(sb, "%s<Error>%d</Error>\n", indent, sc->sc_error);
602 sbuf_printf(sb, "%s<Reads>%ju</Reads>\n", indent, sc->sc_reads);
603 sbuf_printf(sb, "%s<Writes>%ju</Writes>\n", indent, sc->sc_writes);
604 sbuf_printf(sb, "%s<ReadBytes>%ju</ReadBytes>\n", indent,
606 sbuf_printf(sb, "%s<WroteBytes>%ju</WroteBytes>\n", indent,
610 DECLARE_GEOM_CLASS(g_nop_class, g_nop);