g_gate.c revision 238119
1/*- 2 * Copyright (c) 2004-2006 Pawel Jakub Dawidek <pjd@FreeBSD.org> 3 * Copyright (c) 2009-2010 The FreeBSD Foundation 4 * All rights reserved. 5 * 6 * Portions of this software were developed by Pawel Jakub Dawidek 7 * under sponsorship from the FreeBSD Foundation. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 12 * 1. Redistributions of source code must retain the above copyright 13 * notice, this list of conditions and the following disclaimer. 14 * 2. Redistributions in binary form must reproduce the above copyright 15 * notice, this list of conditions and the following disclaimer in the 16 * documentation and/or other materials provided with the distribution. 17 * 18 * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND 19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 21 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE 22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 28 * SUCH DAMAGE. 29 */ 30 31#include <sys/cdefs.h> 32__FBSDID("$FreeBSD: head/sys/geom/gate/g_gate.c 238119 2012-07-04 20:16:28Z pjd $"); 33 34#include <sys/param.h> 35#include <sys/systm.h> 36#include <sys/bio.h> 37#include <sys/conf.h> 38#include <sys/kernel.h> 39#include <sys/kthread.h> 40#include <sys/fcntl.h> 41#include <sys/linker.h> 42#include <sys/lock.h> 43#include <sys/malloc.h> 44#include <sys/mutex.h> 45#include <sys/proc.h> 46#include <sys/limits.h> 47#include <sys/queue.h> 48#include <sys/sbuf.h> 49#include <sys/sysctl.h> 50#include <sys/signalvar.h> 51#include <sys/time.h> 52#include <machine/atomic.h> 53 54#include <geom/geom.h> 55#include <geom/gate/g_gate.h> 56 57FEATURE(geom_gate, "GEOM Gate module"); 58 59static MALLOC_DEFINE(M_GATE, "gg_data", "GEOM Gate Data"); 60 61SYSCTL_DECL(_kern_geom); 62static SYSCTL_NODE(_kern_geom, OID_AUTO, gate, CTLFLAG_RW, 0, 63 "GEOM_GATE configuration"); 64static int g_gate_debug = 0; 65TUNABLE_INT("kern.geom.gate.debug", &g_gate_debug); 66SYSCTL_INT(_kern_geom_gate, OID_AUTO, debug, CTLFLAG_RW, &g_gate_debug, 0, 67 "Debug level"); 68static u_int g_gate_maxunits = 256; 69TUNABLE_INT("kern.geom.gate.maxunits", &g_gate_maxunits); 70SYSCTL_UINT(_kern_geom_gate, OID_AUTO, maxunits, CTLFLAG_RDTUN, 71 &g_gate_maxunits, 0, "Maximum number of ggate devices"); 72 73struct g_class g_gate_class = { 74 .name = G_GATE_CLASS_NAME, 75 .version = G_VERSION, 76}; 77 78static struct cdev *status_dev; 79static d_ioctl_t g_gate_ioctl; 80static struct cdevsw g_gate_cdevsw = { 81 .d_version = D_VERSION, 82 .d_ioctl = g_gate_ioctl, 83 .d_name = G_GATE_CTL_NAME 84}; 85 86 87static struct g_gate_softc **g_gate_units; 88static u_int g_gate_nunits; 89static struct mtx g_gate_units_lock; 90 91static int 92g_gate_destroy(struct g_gate_softc *sc, boolean_t force) 93{ 94 struct g_provider *pp; 95 struct g_consumer *cp; 96 struct g_geom *gp; 97 struct bio *bp; 98 99 g_topology_assert(); 100 mtx_assert(&g_gate_units_lock, MA_OWNED); 101 pp = sc->sc_provider; 102 if (!force && (pp->acr != 0 || pp->acw != 0 || pp->ace != 0)) { 103 mtx_unlock(&g_gate_units_lock); 104 return (EBUSY); 105 } 106 mtx_unlock(&g_gate_units_lock); 107 mtx_lock(&sc->sc_queue_mtx); 108 if ((sc->sc_flags & G_GATE_FLAG_DESTROY) == 0) 109 sc->sc_flags |= G_GATE_FLAG_DESTROY; 110 wakeup(sc); 111 mtx_unlock(&sc->sc_queue_mtx); 112 gp = pp->geom; 113 pp->flags |= G_PF_WITHER; 114 g_orphan_provider(pp, ENXIO); 115 callout_drain(&sc->sc_callout); 116 mtx_lock(&sc->sc_queue_mtx); 117 while ((bp = bioq_first(&sc->sc_inqueue)) != NULL) { 118 bioq_remove(&sc->sc_inqueue, bp); 119 sc->sc_queue_count--; 120 G_GATE_LOGREQ(1, bp, "Request canceled."); 121 g_io_deliver(bp, ENXIO); 122 } 123 while ((bp = bioq_first(&sc->sc_outqueue)) != NULL) { 124 bioq_remove(&sc->sc_outqueue, bp); 125 sc->sc_queue_count--; 126 G_GATE_LOGREQ(1, bp, "Request canceled."); 127 g_io_deliver(bp, ENXIO); 128 } 129 mtx_unlock(&sc->sc_queue_mtx); 130 g_topology_unlock(); 131 mtx_lock(&g_gate_units_lock); 132 /* One reference is ours. */ 133 sc->sc_ref--; 134 while (sc->sc_ref > 0) 135 msleep(&sc->sc_ref, &g_gate_units_lock, 0, "gg:destroy", 0); 136 g_gate_units[sc->sc_unit] = NULL; 137 KASSERT(g_gate_nunits > 0, ("negative g_gate_nunits?")); 138 g_gate_nunits--; 139 mtx_unlock(&g_gate_units_lock); 140 mtx_destroy(&sc->sc_queue_mtx); 141 g_topology_lock(); 142 if ((cp = sc->sc_readcons) != NULL) { 143 sc->sc_readcons = NULL; 144 (void)g_access(cp, -1, 0, 0); 145 g_detach(cp); 146 g_destroy_consumer(cp); 147 } 148 G_GATE_DEBUG(1, "Device %s destroyed.", gp->name); 149 gp->softc = NULL; 150 g_wither_geom(gp, ENXIO); 151 sc->sc_provider = NULL; 152 free(sc, M_GATE); 153 return (0); 154} 155 156static int 157g_gate_access(struct g_provider *pp, int dr, int dw, int de) 158{ 159 struct g_gate_softc *sc; 160 161 if (dr <= 0 && dw <= 0 && de <= 0) 162 return (0); 163 sc = pp->geom->softc; 164 if (sc == NULL || (sc->sc_flags & G_GATE_FLAG_DESTROY) != 0) 165 return (ENXIO); 166 /* XXX: Hack to allow read-only mounts. */ 167#if 0 168 if ((sc->sc_flags & G_GATE_FLAG_READONLY) != 0 && dw > 0) 169 return (EPERM); 170#endif 171 if ((sc->sc_flags & G_GATE_FLAG_WRITEONLY) != 0 && dr > 0) 172 return (EPERM); 173 return (0); 174} 175 176static void 177g_gate_queue_io(struct bio *bp) 178{ 179 struct g_gate_softc *sc; 180 181 sc = bp->bio_to->geom->softc; 182 if (sc == NULL || (sc->sc_flags & G_GATE_FLAG_DESTROY) != 0) { 183 g_io_deliver(bp, ENXIO); 184 return; 185 } 186 187 mtx_lock(&sc->sc_queue_mtx); 188 189 if (sc->sc_queue_size > 0 && sc->sc_queue_count > sc->sc_queue_size) { 190 mtx_unlock(&sc->sc_queue_mtx); 191 G_GATE_LOGREQ(1, bp, "Queue full, request canceled."); 192 g_io_deliver(bp, ENOMEM); 193 return; 194 } 195 196 bp->bio_driver1 = (void *)sc->sc_seq; 197 sc->sc_seq++; 198 sc->sc_queue_count++; 199 200 bioq_insert_tail(&sc->sc_inqueue, bp); 201 wakeup(sc); 202 203 mtx_unlock(&sc->sc_queue_mtx); 204} 205 206static void 207g_gate_done(struct bio *cbp) 208{ 209 struct bio *pbp; 210 211 pbp = cbp->bio_parent; 212 if (cbp->bio_error == 0) { 213 pbp->bio_completed = cbp->bio_completed; 214 g_destroy_bio(cbp); 215 pbp->bio_inbed++; 216 g_io_deliver(pbp, 0); 217 } else { 218 /* If direct read failed, pass it through userland daemon. */ 219 g_destroy_bio(cbp); 220 pbp->bio_children--; 221 g_gate_queue_io(pbp); 222 } 223} 224 225static void 226g_gate_start(struct bio *pbp) 227{ 228 struct g_gate_softc *sc; 229 230 sc = pbp->bio_to->geom->softc; 231 if (sc == NULL || (sc->sc_flags & G_GATE_FLAG_DESTROY) != 0) { 232 g_io_deliver(pbp, ENXIO); 233 return; 234 } 235 G_GATE_LOGREQ(2, pbp, "Request received."); 236 switch (pbp->bio_cmd) { 237 case BIO_READ: 238 if (sc->sc_readcons != NULL) { 239 struct bio *cbp; 240 241 cbp = g_clone_bio(pbp); 242 if (cbp == NULL) { 243 g_io_deliver(pbp, ENOMEM); 244 return; 245 } 246 cbp->bio_done = g_gate_done; 247 cbp->bio_offset = pbp->bio_offset + sc->sc_readoffset; 248 cbp->bio_data = pbp->bio_data; 249 cbp->bio_length = pbp->bio_length; 250 cbp->bio_to = sc->sc_readcons->provider; 251 g_io_request(cbp, sc->sc_readcons); 252 return; 253 } 254 break; 255 case BIO_DELETE: 256 case BIO_WRITE: 257 case BIO_FLUSH: 258 /* XXX: Hack to allow read-only mounts. */ 259 if ((sc->sc_flags & G_GATE_FLAG_READONLY) != 0) { 260 g_io_deliver(pbp, EPERM); 261 return; 262 } 263 break; 264 case BIO_GETATTR: 265 default: 266 G_GATE_LOGREQ(2, pbp, "Ignoring request."); 267 g_io_deliver(pbp, EOPNOTSUPP); 268 return; 269 } 270 271 g_gate_queue_io(pbp); 272} 273 274static struct g_gate_softc * 275g_gate_hold(int unit, const char *name) 276{ 277 struct g_gate_softc *sc = NULL; 278 279 mtx_lock(&g_gate_units_lock); 280 if (unit >= 0 && unit < g_gate_maxunits) 281 sc = g_gate_units[unit]; 282 else if (unit == G_GATE_NAME_GIVEN) { 283 KASSERT(name != NULL, ("name is NULL")); 284 for (unit = 0; unit < g_gate_maxunits; unit++) { 285 if (g_gate_units[unit] == NULL) 286 continue; 287 if (strcmp(name, 288 g_gate_units[unit]->sc_provider->name) != 0) { 289 continue; 290 } 291 sc = g_gate_units[unit]; 292 break; 293 } 294 } 295 if (sc != NULL) 296 sc->sc_ref++; 297 mtx_unlock(&g_gate_units_lock); 298 return (sc); 299} 300 301static void 302g_gate_release(struct g_gate_softc *sc) 303{ 304 305 g_topology_assert_not(); 306 mtx_lock(&g_gate_units_lock); 307 sc->sc_ref--; 308 KASSERT(sc->sc_ref >= 0, ("Negative sc_ref for %s.", sc->sc_name)); 309 if (sc->sc_ref == 0 && (sc->sc_flags & G_GATE_FLAG_DESTROY) != 0) 310 wakeup(&sc->sc_ref); 311 mtx_unlock(&g_gate_units_lock); 312} 313 314static int 315g_gate_getunit(int unit, int *errorp) 316{ 317 318 mtx_assert(&g_gate_units_lock, MA_OWNED); 319 if (unit >= 0) { 320 if (unit >= g_gate_maxunits) 321 *errorp = EINVAL; 322 else if (g_gate_units[unit] == NULL) 323 return (unit); 324 else 325 *errorp = EEXIST; 326 } else { 327 for (unit = 0; unit < g_gate_maxunits; unit++) { 328 if (g_gate_units[unit] == NULL) 329 return (unit); 330 } 331 *errorp = ENFILE; 332 } 333 return (-1); 334} 335 336static void 337g_gate_guard(void *arg) 338{ 339 struct g_gate_softc *sc; 340 struct bintime curtime; 341 struct bio *bp, *bp2; 342 343 sc = arg; 344 binuptime(&curtime); 345 g_gate_hold(sc->sc_unit, NULL); 346 mtx_lock(&sc->sc_queue_mtx); 347 TAILQ_FOREACH_SAFE(bp, &sc->sc_inqueue.queue, bio_queue, bp2) { 348 if (curtime.sec - bp->bio_t0.sec < 5) 349 continue; 350 bioq_remove(&sc->sc_inqueue, bp); 351 sc->sc_queue_count--; 352 G_GATE_LOGREQ(1, bp, "Request timeout."); 353 g_io_deliver(bp, EIO); 354 } 355 TAILQ_FOREACH_SAFE(bp, &sc->sc_outqueue.queue, bio_queue, bp2) { 356 if (curtime.sec - bp->bio_t0.sec < 5) 357 continue; 358 bioq_remove(&sc->sc_outqueue, bp); 359 sc->sc_queue_count--; 360 G_GATE_LOGREQ(1, bp, "Request timeout."); 361 g_io_deliver(bp, EIO); 362 } 363 mtx_unlock(&sc->sc_queue_mtx); 364 if ((sc->sc_flags & G_GATE_FLAG_DESTROY) == 0) { 365 callout_reset(&sc->sc_callout, sc->sc_timeout * hz, 366 g_gate_guard, sc); 367 } 368 g_gate_release(sc); 369} 370 371static void 372g_gate_orphan(struct g_consumer *cp) 373{ 374 struct g_gate_softc *sc; 375 struct g_geom *gp; 376 377 g_topology_assert(); 378 gp = cp->geom; 379 sc = gp->softc; 380 if (sc == NULL) 381 return; 382 KASSERT(cp == sc->sc_readcons, ("cp=%p sc_readcons=%p", cp, 383 sc->sc_readcons)); 384 sc->sc_readcons = NULL; 385 G_GATE_DEBUG(1, "Destroying read consumer on provider %s orphan.", 386 cp->provider->name); 387 (void)g_access(cp, -1, 0, 0); 388 g_detach(cp); 389 g_destroy_consumer(cp); 390} 391 392static void 393g_gate_dumpconf(struct sbuf *sb, const char *indent, struct g_geom *gp, 394 struct g_consumer *cp, struct g_provider *pp) 395{ 396 struct g_gate_softc *sc; 397 398 sc = gp->softc; 399 if (sc == NULL || pp != NULL || cp != NULL) 400 return; 401 g_gate_hold(sc->sc_unit, NULL); 402 if ((sc->sc_flags & G_GATE_FLAG_READONLY) != 0) { 403 sbuf_printf(sb, "%s<access>%s</access>\n", indent, "read-only"); 404 } else if ((sc->sc_flags & G_GATE_FLAG_WRITEONLY) != 0) { 405 sbuf_printf(sb, "%s<access>%s</access>\n", indent, 406 "write-only"); 407 } else { 408 sbuf_printf(sb, "%s<access>%s</access>\n", indent, 409 "read-write"); 410 } 411 if (sc->sc_readcons != NULL) { 412 sbuf_printf(sb, "%s<read_offset>%jd</read_offset>\n", 413 indent, (intmax_t)sc->sc_readoffset); 414 sbuf_printf(sb, "%s<read_provider>%s</read_provider>\n", 415 indent, sc->sc_readcons->provider->name); 416 } 417 sbuf_printf(sb, "%s<timeout>%u</timeout>\n", indent, sc->sc_timeout); 418 sbuf_printf(sb, "%s<info>%s</info>\n", indent, sc->sc_info); 419 sbuf_printf(sb, "%s<queue_count>%u</queue_count>\n", indent, 420 sc->sc_queue_count); 421 sbuf_printf(sb, "%s<queue_size>%u</queue_size>\n", indent, 422 sc->sc_queue_size); 423 sbuf_printf(sb, "%s<ref>%u</ref>\n", indent, sc->sc_ref); 424 sbuf_printf(sb, "%s<unit>%d</unit>\n", indent, sc->sc_unit); 425 g_topology_unlock(); 426 g_gate_release(sc); 427 g_topology_lock(); 428} 429 430static int 431g_gate_create(struct g_gate_ctl_create *ggio) 432{ 433 struct g_gate_softc *sc; 434 struct g_geom *gp; 435 struct g_provider *pp, *ropp; 436 struct g_consumer *cp; 437 char name[NAME_MAX]; 438 int error = 0, unit; 439 440 if (ggio->gctl_mediasize <= 0) { 441 G_GATE_DEBUG(1, "Invalid media size."); 442 return (EINVAL); 443 } 444 if (ggio->gctl_sectorsize <= 0) { 445 G_GATE_DEBUG(1, "Invalid sector size."); 446 return (EINVAL); 447 } 448 if (!powerof2(ggio->gctl_sectorsize)) { 449 G_GATE_DEBUG(1, "Invalid sector size."); 450 return (EINVAL); 451 } 452 if ((ggio->gctl_mediasize % ggio->gctl_sectorsize) != 0) { 453 G_GATE_DEBUG(1, "Invalid media size."); 454 return (EINVAL); 455 } 456 if ((ggio->gctl_flags & G_GATE_FLAG_READONLY) != 0 && 457 (ggio->gctl_flags & G_GATE_FLAG_WRITEONLY) != 0) { 458 G_GATE_DEBUG(1, "Invalid flags."); 459 return (EINVAL); 460 } 461 if (ggio->gctl_unit != G_GATE_UNIT_AUTO && 462 ggio->gctl_unit != G_GATE_NAME_GIVEN && 463 ggio->gctl_unit < 0) { 464 G_GATE_DEBUG(1, "Invalid unit number."); 465 return (EINVAL); 466 } 467 if (ggio->gctl_unit == G_GATE_NAME_GIVEN && 468 ggio->gctl_name[0] == '\0') { 469 G_GATE_DEBUG(1, "No device name."); 470 return (EINVAL); 471 } 472 473 g_topology_lock(); 474 475 if (ggio->gctl_readprov[0] == '\0') { 476 ropp = NULL; 477 } else { 478 ropp = g_provider_by_name(ggio->gctl_readprov); 479 if (ropp == NULL) { 480 g_topology_unlock(); 481 G_GATE_DEBUG(1, "Provider %s doesn't exist.", 482 ggio->gctl_readprov); 483 return (EINVAL); 484 } 485 if ((ggio->gctl_readoffset % ggio->gctl_sectorsize) != 0) { 486 g_topology_unlock(); 487 G_GATE_DEBUG(1, "Invalid read offset."); 488 return (EINVAL); 489 } 490 if (ggio->gctl_mediasize + ggio->gctl_readoffset > 491 ropp->mediasize) { 492 g_topology_unlock(); 493 G_GATE_DEBUG(1, "Invalid read offset or media size."); 494 return (EINVAL); 495 } 496 } 497 498 sc = malloc(sizeof(*sc), M_GATE, M_WAITOK | M_ZERO); 499 sc->sc_flags = (ggio->gctl_flags & G_GATE_USERFLAGS); 500 strlcpy(sc->sc_info, ggio->gctl_info, sizeof(sc->sc_info)); 501 sc->sc_seq = 1; 502 bioq_init(&sc->sc_inqueue); 503 bioq_init(&sc->sc_outqueue); 504 mtx_init(&sc->sc_queue_mtx, "gg:queue", NULL, MTX_DEF); 505 sc->sc_queue_count = 0; 506 sc->sc_queue_size = ggio->gctl_maxcount; 507 if (sc->sc_queue_size > G_GATE_MAX_QUEUE_SIZE) 508 sc->sc_queue_size = G_GATE_MAX_QUEUE_SIZE; 509 sc->sc_timeout = ggio->gctl_timeout; 510 callout_init(&sc->sc_callout, CALLOUT_MPSAFE); 511 512 gp = g_new_geomf(&g_gate_class, "%s", name); 513 gp->start = g_gate_start; 514 gp->access = g_gate_access; 515 gp->orphan = g_gate_orphan; 516 gp->dumpconf = g_gate_dumpconf; 517 gp->softc = sc; 518 519 if (ropp != NULL) { 520 cp = g_new_consumer(gp); 521 error = g_attach(cp, ropp); 522 if (error != 0) { 523 G_GATE_DEBUG(1, "Unable to attach to %s.", ropp->name); 524 } else { 525 error = g_access(cp, 1, 0, 0); 526 if (error != 0) { 527 G_GATE_DEBUG(1, "Unable to access %s.", 528 ropp->name); 529 g_detach(cp); 530 } 531 } 532 if (error != 0) { 533 g_destroy_consumer(cp); 534 g_destroy_geom(gp); 535 g_topology_unlock(); 536 mtx_destroy(&sc->sc_queue_mtx); 537 free(sc, M_GATE); 538 return (error); 539 } 540 sc->sc_readcons = cp; 541 sc->sc_readoffset = ggio->gctl_readoffset; 542 } 543 544 mtx_lock(&g_gate_units_lock); 545 sc->sc_unit = g_gate_getunit(ggio->gctl_unit, &error); 546 if (sc->sc_unit < 0) { 547 mtx_unlock(&g_gate_units_lock); 548 if (sc->sc_readcons != NULL) { 549 (void)g_access(sc->sc_readcons, -1, 0, 0); 550 g_detach(sc->sc_readcons); 551 g_destroy_consumer(sc->sc_readcons); 552 } 553 g_destroy_geom(gp); 554 g_topology_unlock(); 555 mtx_destroy(&sc->sc_queue_mtx); 556 free(sc, M_GATE); 557 return (error); 558 } 559 if (ggio->gctl_unit == G_GATE_NAME_GIVEN) 560 snprintf(name, sizeof(name), "%s", ggio->gctl_name); 561 else { 562 snprintf(name, sizeof(name), "%s%d", G_GATE_PROVIDER_NAME, 563 sc->sc_unit); 564 } 565 /* Check for name collision. */ 566 for (unit = 0; unit < g_gate_maxunits; unit++) { 567 if (g_gate_units[unit] == NULL) 568 continue; 569 if (strcmp(name, g_gate_units[unit]->sc_name) != 0) 570 continue; 571 mtx_unlock(&g_gate_units_lock); 572 if (sc->sc_readcons != NULL) { 573 (void)g_access(sc->sc_readcons, -1, 0, 0); 574 g_detach(sc->sc_readcons); 575 g_destroy_consumer(sc->sc_readcons); 576 } 577 g_destroy_geom(gp); 578 g_topology_unlock(); 579 mtx_destroy(&sc->sc_queue_mtx); 580 free(sc, M_GATE); 581 return (EEXIST); 582 } 583 sc->sc_name = name; 584 g_gate_units[sc->sc_unit] = sc; 585 g_gate_nunits++; 586 mtx_unlock(&g_gate_units_lock); 587 588 ggio->gctl_unit = sc->sc_unit; 589 590 pp = g_new_providerf(gp, "%s", name); 591 pp->mediasize = ggio->gctl_mediasize; 592 pp->sectorsize = ggio->gctl_sectorsize; 593 sc->sc_provider = pp; 594 g_error_provider(pp, 0); 595 596 g_topology_unlock(); 597 mtx_lock(&g_gate_units_lock); 598 sc->sc_name = sc->sc_provider->name; 599 mtx_unlock(&g_gate_units_lock); 600 G_GATE_DEBUG(1, "Device %s created.", gp->name); 601 602 if (sc->sc_timeout > 0) { 603 callout_reset(&sc->sc_callout, sc->sc_timeout * hz, 604 g_gate_guard, sc); 605 } 606 return (0); 607} 608 609static int 610g_gate_modify(struct g_gate_softc *sc, struct g_gate_ctl_modify *ggio) 611{ 612 struct g_provider *pp; 613 struct g_consumer *cp; 614 int error; 615 616 if ((ggio->gctl_modify & GG_MODIFY_MEDIASIZE) != 0) { 617 if (ggio->gctl_mediasize <= 0) { 618 G_GATE_DEBUG(1, "Invalid media size."); 619 return (EINVAL); 620 } 621 pp = sc->sc_provider; 622 if ((ggio->gctl_mediasize % pp->sectorsize) != 0) { 623 G_GATE_DEBUG(1, "Invalid media size."); 624 return (EINVAL); 625 } 626 /* TODO */ 627 return (EOPNOTSUPP); 628 } 629 630 if ((ggio->gctl_modify & GG_MODIFY_INFO) != 0) 631 (void)strlcpy(sc->sc_info, ggio->gctl_info, sizeof(sc->sc_info)); 632 633 cp = NULL; 634 635 if ((ggio->gctl_modify & GG_MODIFY_READPROV) != 0) { 636 g_topology_lock(); 637 if (sc->sc_readcons != NULL) { 638 cp = sc->sc_readcons; 639 sc->sc_readcons = NULL; 640 (void)g_access(cp, -1, 0, 0); 641 g_detach(cp); 642 g_destroy_consumer(cp); 643 } 644 if (ggio->gctl_readprov[0] != '\0') { 645 pp = g_provider_by_name(ggio->gctl_readprov); 646 if (pp == NULL) { 647 g_topology_unlock(); 648 G_GATE_DEBUG(1, "Provider %s doesn't exist.", 649 ggio->gctl_readprov); 650 return (EINVAL); 651 } 652 cp = g_new_consumer(sc->sc_provider->geom); 653 error = g_attach(cp, pp); 654 if (error != 0) { 655 G_GATE_DEBUG(1, "Unable to attach to %s.", 656 pp->name); 657 } else { 658 error = g_access(cp, 1, 0, 0); 659 if (error != 0) { 660 G_GATE_DEBUG(1, "Unable to access %s.", 661 pp->name); 662 g_detach(cp); 663 } 664 } 665 if (error != 0) { 666 g_destroy_consumer(cp); 667 g_topology_unlock(); 668 return (error); 669 } 670 } 671 } else { 672 cp = sc->sc_readcons; 673 } 674 675 if ((ggio->gctl_modify & GG_MODIFY_READOFFSET) != 0) { 676 if (cp == NULL) { 677 G_GATE_DEBUG(1, "No read provider."); 678 return (EINVAL); 679 } 680 pp = sc->sc_provider; 681 if ((ggio->gctl_readoffset % pp->sectorsize) != 0) { 682 G_GATE_DEBUG(1, "Invalid read offset."); 683 return (EINVAL); 684 } 685 if (pp->mediasize + ggio->gctl_readoffset > 686 cp->provider->mediasize) { 687 G_GATE_DEBUG(1, "Invalid read offset or media size."); 688 return (EINVAL); 689 } 690 sc->sc_readoffset = ggio->gctl_readoffset; 691 } 692 693 if ((ggio->gctl_modify & GG_MODIFY_READPROV) != 0) { 694 sc->sc_readcons = cp; 695 g_topology_unlock(); 696 } 697 698 return (0); 699} 700 701#define G_GATE_CHECK_VERSION(ggio) do { \ 702 if ((ggio)->gctl_version != G_GATE_VERSION) { \ 703 printf("Version mismatch %d != %d.\n", \ 704 ggio->gctl_version, G_GATE_VERSION); \ 705 return (EINVAL); \ 706 } \ 707} while (0) 708static int 709g_gate_ioctl(struct cdev *dev, u_long cmd, caddr_t addr, int flags, struct thread *td) 710{ 711 struct g_gate_softc *sc; 712 struct bio *bp; 713 int error = 0; 714 715 G_GATE_DEBUG(4, "ioctl(%s, %lx, %p, %x, %p)", devtoname(dev), cmd, addr, 716 flags, td); 717 718 switch (cmd) { 719 case G_GATE_CMD_CREATE: 720 { 721 struct g_gate_ctl_create *ggio = (void *)addr; 722 723 G_GATE_CHECK_VERSION(ggio); 724 error = g_gate_create(ggio); 725 /* 726 * Reset TDP_GEOM flag. 727 * There are pending events for sure, because we just created 728 * new provider and other classes want to taste it, but we 729 * cannot answer on I/O requests until we're here. 730 */ 731 td->td_pflags &= ~TDP_GEOM; 732 return (error); 733 } 734 case G_GATE_CMD_MODIFY: 735 { 736 struct g_gate_ctl_modify *ggio = (void *)addr; 737 738 G_GATE_CHECK_VERSION(ggio); 739 sc = g_gate_hold(ggio->gctl_unit, NULL); 740 if (sc == NULL) 741 return (ENXIO); 742 error = g_gate_modify(sc, ggio); 743 g_gate_release(sc); 744 return (error); 745 } 746 case G_GATE_CMD_DESTROY: 747 { 748 struct g_gate_ctl_destroy *ggio = (void *)addr; 749 750 G_GATE_CHECK_VERSION(ggio); 751 sc = g_gate_hold(ggio->gctl_unit, ggio->gctl_name); 752 if (sc == NULL) 753 return (ENXIO); 754 g_topology_lock(); 755 mtx_lock(&g_gate_units_lock); 756 error = g_gate_destroy(sc, ggio->gctl_force); 757 g_topology_unlock(); 758 if (error != 0) 759 g_gate_release(sc); 760 return (error); 761 } 762 case G_GATE_CMD_CANCEL: 763 { 764 struct g_gate_ctl_cancel *ggio = (void *)addr; 765 struct bio *tbp, *lbp; 766 767 G_GATE_CHECK_VERSION(ggio); 768 sc = g_gate_hold(ggio->gctl_unit, ggio->gctl_name); 769 if (sc == NULL) 770 return (ENXIO); 771 lbp = NULL; 772 mtx_lock(&sc->sc_queue_mtx); 773 TAILQ_FOREACH_SAFE(bp, &sc->sc_outqueue.queue, bio_queue, tbp) { 774 if (ggio->gctl_seq == 0 || 775 ggio->gctl_seq == (uintptr_t)bp->bio_driver1) { 776 G_GATE_LOGREQ(1, bp, "Request canceled."); 777 bioq_remove(&sc->sc_outqueue, bp); 778 /* 779 * Be sure to put requests back onto incoming 780 * queue in the proper order. 781 */ 782 if (lbp == NULL) 783 bioq_insert_head(&sc->sc_inqueue, bp); 784 else { 785 TAILQ_INSERT_AFTER(&sc->sc_inqueue.queue, 786 lbp, bp, bio_queue); 787 } 788 lbp = bp; 789 /* 790 * If only one request was canceled, leave now. 791 */ 792 if (ggio->gctl_seq != 0) 793 break; 794 } 795 } 796 if (ggio->gctl_unit == G_GATE_NAME_GIVEN) 797 ggio->gctl_unit = sc->sc_unit; 798 mtx_unlock(&sc->sc_queue_mtx); 799 g_gate_release(sc); 800 return (error); 801 } 802 case G_GATE_CMD_START: 803 { 804 struct g_gate_ctl_io *ggio = (void *)addr; 805 806 G_GATE_CHECK_VERSION(ggio); 807 sc = g_gate_hold(ggio->gctl_unit, NULL); 808 if (sc == NULL) 809 return (ENXIO); 810 error = 0; 811 for (;;) { 812 mtx_lock(&sc->sc_queue_mtx); 813 bp = bioq_first(&sc->sc_inqueue); 814 if (bp != NULL) 815 break; 816 if ((sc->sc_flags & G_GATE_FLAG_DESTROY) != 0) { 817 ggio->gctl_error = ECANCELED; 818 mtx_unlock(&sc->sc_queue_mtx); 819 goto start_end; 820 } 821 if (msleep(sc, &sc->sc_queue_mtx, 822 PPAUSE | PDROP | PCATCH, "ggwait", 0) != 0) { 823 ggio->gctl_error = ECANCELED; 824 goto start_end; 825 } 826 } 827 ggio->gctl_cmd = bp->bio_cmd; 828 if ((bp->bio_cmd == BIO_DELETE || bp->bio_cmd == BIO_WRITE) && 829 bp->bio_length > ggio->gctl_length) { 830 mtx_unlock(&sc->sc_queue_mtx); 831 ggio->gctl_length = bp->bio_length; 832 ggio->gctl_error = ENOMEM; 833 goto start_end; 834 } 835 bioq_remove(&sc->sc_inqueue, bp); 836 bioq_insert_tail(&sc->sc_outqueue, bp); 837 mtx_unlock(&sc->sc_queue_mtx); 838 839 ggio->gctl_seq = (uintptr_t)bp->bio_driver1; 840 ggio->gctl_offset = bp->bio_offset; 841 ggio->gctl_length = bp->bio_length; 842 843 switch (bp->bio_cmd) { 844 case BIO_READ: 845 case BIO_DELETE: 846 case BIO_FLUSH: 847 break; 848 case BIO_WRITE: 849 error = copyout(bp->bio_data, ggio->gctl_data, 850 bp->bio_length); 851 if (error != 0) { 852 mtx_lock(&sc->sc_queue_mtx); 853 bioq_remove(&sc->sc_outqueue, bp); 854 bioq_insert_head(&sc->sc_inqueue, bp); 855 mtx_unlock(&sc->sc_queue_mtx); 856 goto start_end; 857 } 858 break; 859 } 860start_end: 861 g_gate_release(sc); 862 return (error); 863 } 864 case G_GATE_CMD_DONE: 865 { 866 struct g_gate_ctl_io *ggio = (void *)addr; 867 868 G_GATE_CHECK_VERSION(ggio); 869 sc = g_gate_hold(ggio->gctl_unit, NULL); 870 if (sc == NULL) 871 return (ENOENT); 872 error = 0; 873 mtx_lock(&sc->sc_queue_mtx); 874 TAILQ_FOREACH(bp, &sc->sc_outqueue.queue, bio_queue) { 875 if (ggio->gctl_seq == (uintptr_t)bp->bio_driver1) 876 break; 877 } 878 if (bp != NULL) { 879 bioq_remove(&sc->sc_outqueue, bp); 880 sc->sc_queue_count--; 881 } 882 mtx_unlock(&sc->sc_queue_mtx); 883 if (bp == NULL) { 884 /* 885 * Request was probably canceled. 886 */ 887 goto done_end; 888 } 889 if (ggio->gctl_error == EAGAIN) { 890 bp->bio_error = 0; 891 G_GATE_LOGREQ(1, bp, "Request desisted."); 892 mtx_lock(&sc->sc_queue_mtx); 893 sc->sc_queue_count++; 894 bioq_insert_head(&sc->sc_inqueue, bp); 895 wakeup(sc); 896 mtx_unlock(&sc->sc_queue_mtx); 897 } else { 898 bp->bio_error = ggio->gctl_error; 899 if (bp->bio_error == 0) { 900 bp->bio_completed = bp->bio_length; 901 switch (bp->bio_cmd) { 902 case BIO_READ: 903 error = copyin(ggio->gctl_data, 904 bp->bio_data, bp->bio_length); 905 if (error != 0) 906 bp->bio_error = error; 907 break; 908 case BIO_DELETE: 909 case BIO_WRITE: 910 case BIO_FLUSH: 911 break; 912 } 913 } 914 G_GATE_LOGREQ(2, bp, "Request done."); 915 g_io_deliver(bp, bp->bio_error); 916 } 917done_end: 918 g_gate_release(sc); 919 return (error); 920 } 921 } 922 return (ENOIOCTL); 923} 924 925static void 926g_gate_device(void) 927{ 928 929 status_dev = make_dev(&g_gate_cdevsw, 0x0, UID_ROOT, GID_WHEEL, 0600, 930 G_GATE_CTL_NAME); 931} 932 933static int 934g_gate_modevent(module_t mod, int type, void *data) 935{ 936 int error = 0; 937 938 switch (type) { 939 case MOD_LOAD: 940 mtx_init(&g_gate_units_lock, "gg_units_lock", NULL, MTX_DEF); 941 g_gate_units = malloc(g_gate_maxunits * sizeof(g_gate_units[0]), 942 M_GATE, M_WAITOK | M_ZERO); 943 g_gate_nunits = 0; 944 g_gate_device(); 945 break; 946 case MOD_UNLOAD: 947 mtx_lock(&g_gate_units_lock); 948 if (g_gate_nunits > 0) { 949 mtx_unlock(&g_gate_units_lock); 950 error = EBUSY; 951 break; 952 } 953 mtx_unlock(&g_gate_units_lock); 954 mtx_destroy(&g_gate_units_lock); 955 if (status_dev != 0) 956 destroy_dev(status_dev); 957 free(g_gate_units, M_GATE); 958 break; 959 default: 960 return (EOPNOTSUPP); 961 break; 962 } 963 964 return (error); 965} 966static moduledata_t g_gate_module = { 967 G_GATE_MOD_NAME, 968 g_gate_modevent, 969 NULL 970}; 971DECLARE_MODULE(geom_gate, g_gate_module, SI_SUB_DRIVERS, SI_ORDER_MIDDLE); 972DECLARE_GEOM_CLASS(g_gate_class, g_gate); 973