1 /*- 2 * Copyright (c) 2004 Pawel Jakub Dawidek <pjd@FreeBSD.org> 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 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. 13 * 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 24 * SUCH DAMAGE. 25 */ 26 27 #include <sys/cdefs.h> 28 __FBSDID("$FreeBSD$"); 29 30 #include <sys/param.h> 31 #include <sys/systm.h> 32 #include <sys/kernel.h> 33 #include <sys/module.h> 34 #include <sys/lock.h> 35 #include <sys/mutex.h> 36 #include <sys/bio.h> 37 #include <sys/sysctl.h> 38 #include <sys/malloc.h> 39 #include <geom/geom.h> 40 #include <geom/nop/g_nop.h> 41 42 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, 47 "Debug level"); 48 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, 51 struct g_geom *gp); 52 static void g_nop_config(struct gctl_req *req, struct g_class *mp, 53 const char *verb); 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); 56 57 struct g_class g_nop_class = { 58 .name = G_NOP_CLASS_NAME, 59 .version = G_VERSION, 60 .ctlreq = g_nop_config, 61 .destroy_geom = g_nop_destroy_geom 62 }; 63 64 65 static void 66 g_nop_orphan(struct g_consumer *cp) 67 { 68 69 g_topology_assert(); 70 g_nop_destroy(cp->geom, 1); 71 } 72 73 static void 74 g_nop_start(struct bio *bp) 75 { 76 struct g_nop_softc *sc; 77 struct g_geom *gp; 78 struct g_provider *pp; 79 struct bio *cbp; 80 81 gp = bp->bio_to->geom; 82 sc = gp->softc; 83 G_NOP_LOGREQ(bp, "Request received."); 84 cbp = g_clone_bio(bp); 85 if (cbp == NULL) { 86 g_io_deliver(bp, ENOMEM); 87 return; 88 } 89 switch (bp->bio_cmd) { 90 case BIO_READ: 91 sc->sc_reads++; 92 sc->sc_readbytes += bp->bio_length; 93 break; 94 case BIO_WRITE: 95 sc->sc_writes++; 96 sc->sc_wrotebytes += bp->bio_length; 97 break; 98 } 99 if (sc->sc_failprob > 0) { 100 u_int rval; 101 102 rval = arc4random() % 100; 103 if (rval < sc->sc_failprob) { 104 g_io_deliver(bp, EIO); 105 return; 106 } 107 } 108 cbp->bio_done = g_std_done; 109 cbp->bio_offset = bp->bio_offset + sc->sc_offset; 110 cbp->bio_data = bp->bio_data; 111 cbp->bio_length = bp->bio_length; 112 pp = LIST_FIRST(&gp->provider); 113 KASSERT(pp != NULL, ("NULL pp")); 114 cbp->bio_to = pp; 115 G_NOP_LOGREQ(cbp, "Sending request."); 116 g_io_request(cbp, LIST_FIRST(&gp->consumer)); 117 } 118 119 static int 120 g_nop_access(struct g_provider *pp, int dr, int dw, int de) 121 { 122 struct g_geom *gp; 123 struct g_consumer *cp; 124 int error; 125 126 gp = pp->geom; 127 cp = LIST_FIRST(&gp->consumer); 128 error = g_access(cp, dr, dw, de); 129 130 return (error); 131 } 132 133 static int 134 g_nop_create(struct gctl_req *req, struct g_class *mp, struct g_provider *pp, 135 u_int failprob, off_t offset, off_t size, u_int secsize) 136 { 137 struct g_nop_softc *sc; 138 struct g_geom *gp; 139 struct g_provider *newpp; 140 struct g_consumer *cp; 141 char name[64]; 142 int error; 143 144 g_topology_assert(); 145 146 gp = NULL; 147 newpp = NULL; 148 cp = NULL; 149 150 if ((offset % pp->sectorsize) != 0) { 151 gctl_error(req, "Invalid offset for provider %s.", pp->name); 152 return (EINVAL); 153 } 154 if ((size % pp->sectorsize) != 0) { 155 gctl_error(req, "Invalid size for provider %s.", pp->name); 156 return (EINVAL); 157 } 158 if (offset >= pp->mediasize) { 159 gctl_error(req, "Invalid offset for provider %s.", pp->name); 160 return (EINVAL); 161 } 162 if (size == 0) 163 size = pp->mediasize - offset; 164 if (offset + size > pp->mediasize) { 165 gctl_error(req, "Invalid size for provider %s.", pp->name); 166 return (EINVAL); 167 } 168 if (secsize == 0) 169 secsize = pp->sectorsize; 170 else if ((secsize % pp->sectorsize) != 0) { 171 gctl_error(req, "Invalid secsize for provider %s.", pp->name); 172 return (EINVAL); 173 } 174 snprintf(name, sizeof(name), "%s%s", pp->name, G_NOP_SUFFIX); 175 LIST_FOREACH(gp, &mp->geom, geom) { 176 if (strcmp(gp->name, name) == 0) { 177 gctl_error(req, "Provider %s already exists.", name); 178 return (EEXIST); 179 } 180 } 181 gp = g_new_geomf(mp, name); 182 if (gp == NULL) { 183 gctl_error(req, "Cannot create geom %s.", name); 184 return (ENOMEM); 185 } 186 sc = g_malloc(sizeof(*sc), M_WAITOK); 187 sc->sc_offset = offset; 188 sc->sc_failprob = failprob; 189 sc->sc_reads = 0; 190 sc->sc_writes = 0; 191 sc->sc_readbytes = 0; 192 sc->sc_wrotebytes = 0; 193 gp->softc = sc; 194 gp->start = g_nop_start; 195 gp->orphan = g_nop_orphan; 196 gp->access = g_nop_access; 197 gp->dumpconf = g_nop_dumpconf; 198 199 newpp = g_new_providerf(gp, gp->name); 200 if (newpp == NULL) { 201 gctl_error(req, "Cannot create provider %s.", name); 202 error = ENOMEM; 203 goto fail; 204 } 205 newpp->mediasize = size; 206 newpp->sectorsize = secsize; 207 208 cp = g_new_consumer(gp); 209 if (cp == NULL) { 210 gctl_error(req, "Cannot create consumer for %s.", gp->name); 211 error = ENOMEM; 212 goto fail; 213 } 214 error = g_attach(cp, pp); 215 if (error != 0) { 216 gctl_error(req, "Cannot attach to provider %s.", pp->name); 217 goto fail; 218 } 219 220 g_error_provider(newpp, 0); 221 G_NOP_DEBUG(0, "Device %s created.", gp->name); 222 return (0); 223 fail: 224 if (cp != NULL) { 225 if (cp->provider != NULL) 226 g_detach(cp); 227 g_destroy_consumer(cp); 228 } 229 if (newpp != NULL) 230 g_destroy_provider(newpp); 231 if (gp != NULL) { 232 if (gp->softc != NULL) 233 g_free(gp->softc); 234 g_destroy_geom(gp); 235 } 236 return (error); 237 } 238 239 static int 240 g_nop_destroy(struct g_geom *gp, boolean_t force) 241 { 242 struct g_provider *pp; 243 244 g_topology_assert(); 245 if (gp->softc == NULL) 246 return (ENXIO); 247 pp = LIST_FIRST(&gp->provider); 248 if (pp != NULL && (pp->acr != 0 || pp->acw != 0 || pp->ace != 0)) { 249 if (force) { 250 G_NOP_DEBUG(0, "Device %s is still open, so it " 251 "can't be definitely removed.", pp->name); 252 } else { 253 G_NOP_DEBUG(1, "Device %s is still open (r%dw%de%d).", 254 pp->name, pp->acr, pp->acw, pp->ace); 255 return (EBUSY); 256 } 257 } else { 258 G_NOP_DEBUG(0, "Device %s removed.", gp->name); 259 } 260 g_free(gp->softc); 261 gp->softc = NULL; 262 g_wither_geom(gp, ENXIO); 263 264 return (0); 265 } 266 267 static int 268 g_nop_destroy_geom(struct gctl_req *req, struct g_class *mp, struct g_geom *gp) 269 { 270 271 return (g_nop_destroy(gp, 0)); 272 } 273 274 static void 275 g_nop_ctl_create(struct gctl_req *req, struct g_class *mp) 276 { 277 struct g_provider *pp; 278 intmax_t *failprob, *offset, *secsize, *size; 279 const char *name; 280 char param[16]; 281 int i, *nargs; 282 283 g_topology_assert(); 284 285 nargs = gctl_get_paraml(req, "nargs", sizeof(*nargs)); 286 if (nargs == NULL) { 287 gctl_error(req, "No '%s' argument", "nargs"); 288 return; 289 } 290 if (*nargs <= 0) { 291 gctl_error(req, "Missing device(s)."); 292 return; 293 } 294 failprob = gctl_get_paraml(req, "failprob", sizeof(*failprob)); 295 if (failprob == NULL) { 296 gctl_error(req, "No '%s' argument", "failprob"); 297 return; 298 } 299 if (*failprob < 0 || *failprob > 100) { 300 gctl_error(req, "Invalid '%s' argument", "failprob"); 301 return; 302 } 303 offset = gctl_get_paraml(req, "offset", sizeof(*offset)); 304 if (offset == NULL) { 305 gctl_error(req, "No '%s' argument", "offset"); 306 return; 307 } 308 if (*offset < 0) { 309 gctl_error(req, "Invalid '%s' argument", "offset"); 310 return; 311 } 312 size = gctl_get_paraml(req, "size", sizeof(*size)); 313 if (size == NULL) { 314 gctl_error(req, "No '%s' argument", "size"); 315 return; 316 } 317 if (*size < 0) { 318 gctl_error(req, "Invalid '%s' argument", "size"); 319 return; 320 } 321 secsize = gctl_get_paraml(req, "secsize", sizeof(*secsize)); 322 if (secsize == NULL) { 323 gctl_error(req, "No '%s' argument", "secsize"); 324 return; 325 } 326 if (*secsize < 0) { 327 gctl_error(req, "Invalid '%s' argument", "secsize"); 328 return; 329 } 330 331 for (i = 0; i < *nargs; i++) { 332 snprintf(param, sizeof(param), "arg%d", i); 333 name = gctl_get_asciiparam(req, param); 334 if (name == NULL) { 335 gctl_error(req, "No 'arg%d' argument", i); 336 return; 337 } 338 if (strncmp(name, "/dev/", strlen("/dev/")) == 0) 339 name += strlen("/dev/"); 340 pp = g_provider_by_name(name); 341 if (pp == NULL) { 342 G_NOP_DEBUG(1, "Provider %s is invalid.", name); 343 gctl_error(req, "Provider %s is invalid.", name); 344 return; 345 } 346 if (g_nop_create(req, mp, pp, (u_int)*failprob, (off_t)*offset, 347 (off_t)*size, (u_int)*secsize) != 0) { 348 return; 349 } 350 } 351 } 352 353 static void 354 g_nop_ctl_configure(struct gctl_req *req, struct g_class *mp) 355 { 356 struct g_nop_softc *sc; 357 struct g_provider *pp; 358 intmax_t *failprob; 359 const char *name; 360 char param[16]; 361 int i, *nargs; 362 363 g_topology_assert(); 364 365 nargs = gctl_get_paraml(req, "nargs", sizeof(*nargs)); 366 if (nargs == NULL) { 367 gctl_error(req, "No '%s' argument", "nargs"); 368 return; 369 } 370 if (*nargs <= 0) { 371 gctl_error(req, "Missing device(s)."); 372 return; 373 } 374 failprob = gctl_get_paraml(req, "failprob", sizeof(*failprob)); 375 if (failprob == NULL) { 376 gctl_error(req, "No '%s' argument", "failprob"); 377 return; 378 } 379 if (*failprob < 0 || *failprob > 100) { 380 gctl_error(req, "Invalid '%s' argument", "failprob"); 381 return; 382 } 383 384 for (i = 0; i < *nargs; i++) { 385 snprintf(param, sizeof(param), "arg%d", i); 386 name = gctl_get_asciiparam(req, param); 387 if (name == NULL) { 388 gctl_error(req, "No 'arg%d' argument", i); 389 return; 390 } 391 if (strncmp(name, "/dev/", strlen("/dev/")) == 0) 392 name += strlen("/dev/"); 393 pp = g_provider_by_name(name); 394 if (pp == NULL || pp->geom->class != mp) { 395 G_NOP_DEBUG(1, "Provider %s is invalid.", name); 396 gctl_error(req, "Provider %s is invalid.", name); 397 return; 398 } 399 sc = pp->geom->softc; 400 sc->sc_failprob = (u_int)*failprob; 401 } 402 } 403 404 static struct g_geom * 405 g_nop_find_geom(struct g_class *mp, const char *name) 406 { 407 struct g_geom *gp; 408 409 LIST_FOREACH(gp, &mp->geom, geom) { 410 if (strcmp(gp->name, name) == 0) 411 return (gp); 412 } 413 return (NULL); 414 } 415 416 static void 417 g_nop_ctl_destroy(struct gctl_req *req, struct g_class *mp) 418 { 419 int *nargs, *force, error, i; 420 struct g_geom *gp; 421 const char *name; 422 char param[16]; 423 424 g_topology_assert(); 425 426 nargs = gctl_get_paraml(req, "nargs", sizeof(*nargs)); 427 if (nargs == NULL) { 428 gctl_error(req, "No '%s' argument", "nargs"); 429 return; 430 } 431 if (*nargs <= 0) { 432 gctl_error(req, "Missing device(s)."); 433 return; 434 } 435 force = gctl_get_paraml(req, "force", sizeof(*force)); 436 if (force == NULL) { 437 gctl_error(req, "No 'force' argument"); 438 return; 439 } 440 441 for (i = 0; i < *nargs; i++) { 442 snprintf(param, sizeof(param), "arg%d", i); 443 name = gctl_get_asciiparam(req, param); 444 if (name == NULL) { 445 gctl_error(req, "No 'arg%d' argument", i); 446 return; 447 } 448 if (strncmp(name, "/dev/", strlen("/dev/")) == 0) 449 name += strlen("/dev/"); 450 gp = g_nop_find_geom(mp, name); 451 if (gp == NULL) { 452 G_NOP_DEBUG(1, "Device %s is invalid.", name); 453 gctl_error(req, "Device %s is invalid.", name); 454 return; 455 } 456 error = g_nop_destroy(gp, *force); 457 if (error != 0) { 458 gctl_error(req, "Cannot destroy device %s (error=%d).", 459 gp->name, error); 460 return; 461 } 462 } 463 } 464 465 static void 466 g_nop_ctl_reset(struct gctl_req *req, struct g_class *mp) 467 { 468 struct g_nop_softc *sc; 469 struct g_provider *pp; 470 const char *name; 471 char param[16]; 472 int i, *nargs; 473 474 g_topology_assert(); 475 476 nargs = gctl_get_paraml(req, "nargs", sizeof(*nargs)); 477 if (nargs == NULL) { 478 gctl_error(req, "No '%s' argument", "nargs"); 479 return; 480 } 481 if (*nargs <= 0) { 482 gctl_error(req, "Missing device(s)."); 483 return; 484 } 485 486 for (i = 0; i < *nargs; i++) { 487 snprintf(param, sizeof(param), "arg%d", i); 488 name = gctl_get_asciiparam(req, param); 489 if (name == NULL) { 490 gctl_error(req, "No 'arg%d' argument", i); 491 return; 492 } 493 if (strncmp(name, "/dev/", strlen("/dev/")) == 0) 494 name += strlen("/dev/"); 495 pp = g_provider_by_name(name); 496 if (pp == NULL || pp->geom->class != mp) { 497 G_NOP_DEBUG(1, "Provider %s is invalid.", name); 498 gctl_error(req, "Provider %s is invalid.", name); 499 return; 500 } 501 sc = pp->geom->softc; 502 sc->sc_reads = 0; 503 sc->sc_writes = 0; 504 sc->sc_readbytes = 0; 505 sc->sc_wrotebytes = 0; 506 } 507 } 508 509 static void 510 g_nop_config(struct gctl_req *req, struct g_class *mp, const char *verb) 511 { 512 uint32_t *version; 513 514 g_topology_assert(); 515 516 version = gctl_get_paraml(req, "version", sizeof(*version)); 517 if (version == NULL) { 518 gctl_error(req, "No '%s' argument.", "version"); 519 return; 520 } 521 if (*version != G_NOP_VERSION) { 522 gctl_error(req, "Userland and kernel parts are out of sync."); 523 return; 524 } 525 526 if (strcmp(verb, "create") == 0) { 527 g_nop_ctl_create(req, mp); 528 return; 529 } else if (strcmp(verb, "configure") == 0) { 530 g_nop_ctl_configure(req, mp); 531 return; 532 } else if (strcmp(verb, "destroy") == 0) { 533 g_nop_ctl_destroy(req, mp); 534 return; 535 } else if (strcmp(verb, "reset") == 0) { 536 g_nop_ctl_reset(req, mp); 537 return; 538 } 539 540 gctl_error(req, "Unknown verb."); 541 } 542 543 static void 544 g_nop_dumpconf(struct sbuf *sb, const char *indent, struct g_geom *gp, 545 struct g_consumer *cp, struct g_provider *pp) 546 { 547 struct g_nop_softc *sc; 548 549 if (pp != NULL || cp != NULL) 550 return; 551 sc = gp->softc; 552 sbuf_printf(sb, "%s<Offset>%jd</Offset>\n", indent, 553 (intmax_t)sc->sc_offset); 554 sbuf_printf(sb, "%s<FailProb>%u</FailProb>\n", indent, sc->sc_failprob); 555 sbuf_printf(sb, "%s<Reads>%ju</Reads>\n", indent, sc->sc_reads); 556 sbuf_printf(sb, "%s<Writes>%ju</Writes>\n", indent, sc->sc_writes); 557 sbuf_printf(sb, "%s<ReadBytes>%ju</ReadBytess>\n", indent, 558 sc->sc_readbytes); 559 sbuf_printf(sb, "%s<WroteBytes>%ju</WroteBytes>\n", indent, 560 sc->sc_wrotebytes); 561 } 562 563 DECLARE_GEOM_CLASS(g_nop_class, g_nop); 564