sys/geom/virstor/g_virstor.c

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2006-2007 Ivan Voras <ivoras@freebsd.org>
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
  17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
  20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  */
  28
  29 /* Implementation notes:
  30  * - "Components" are wrappers around providers that make up the
  31  *   virtual storage (i.e. a virstor has "physical" components)
  32  */
  33
  34 #include <sys/cdefs.h>
  35 __FBSDID("$FreeBSD$");
  36
  37 #include <sys/param.h>
  38 #include <sys/systm.h>
  39 #include <sys/kernel.h>
  40 #include <sys/module.h>
  41 #include <sys/lock.h>
  42 #include <sys/mutex.h>
  43 #include <sys/sx.h>
  44 #include <sys/bio.h>
  45 #include <sys/sbuf.h>
  46 #include <sys/sysctl.h>
  47 #include <sys/malloc.h>
  48 #include <sys/time.h>
  49 #include <sys/proc.h>
  50 #include <sys/kthread.h>
  51 #include <sys/mutex.h>
  52 #include <vm/uma.h>
  53 #include <geom/geom.h>
  54 #include <geom/geom_dbg.h>
  55
  56 #include <geom/virstor/g_virstor.h>
  57 #include <geom/virstor/g_virstor_md.h>
  58
  59 FEATURE(g_virstor, "GEOM virtual storage support");
  60
  61 /* Declare malloc(9) label */
  62 static MALLOC_DEFINE(M_GVIRSTOR, "gvirstor", "GEOM_VIRSTOR Data");
  63
  64 /* GEOM class methods */
  65 static g_init_t g_virstor_init;
  66 static g_fini_t g_virstor_fini;
  67 static g_taste_t g_virstor_taste;
  68 static g_ctl_req_t g_virstor_config;
  69 static g_ctl_destroy_geom_t g_virstor_destroy_geom;
  70
  71 /* Declare & initialize class structure ("geom class") */
  72 struct g_class g_virstor_class = {
  73         .name =         G_VIRSTOR_CLASS_NAME,
  74         .version =      G_VERSION,
  75         .init =         g_virstor_init,
  76         .fini =         g_virstor_fini,
  77         .taste =        g_virstor_taste,
  78         .ctlreq =       g_virstor_config,
  79         .destroy_geom = g_virstor_destroy_geom
  80         /* The .dumpconf and the rest are only usable for a geom instance, so
  81          * they will be set when such instance is created. */
  82 };
  83
  84 /* Declare sysctl's and loader tunables */
  85 SYSCTL_DECL(_kern_geom);
  86 static SYSCTL_NODE(_kern_geom, OID_AUTO, virstor,
  87     CTLFLAG_RW | CTLFLAG_MPSAFE, 0,
  88     "GEOM_GVIRSTOR information");
  89
  90 static u_int g_virstor_debug = 2; /* XXX: lower to 2 when released to public */
  91 SYSCTL_UINT(_kern_geom_virstor, OID_AUTO, debug, CTLFLAG_RWTUN, &g_virstor_debug,
  92     0, "Debug level (2=production, 5=normal, 15=excessive)");
  93
  94 static u_int g_virstor_chunk_watermark = 100;
  95 SYSCTL_UINT(_kern_geom_virstor, OID_AUTO, chunk_watermark, CTLFLAG_RWTUN,
  96     &g_virstor_chunk_watermark, 0,
  97     "Minimum number of free chunks before issuing administrative warning");
  98
  99 static u_int g_virstor_component_watermark = 1;
 100 SYSCTL_UINT(_kern_geom_virstor, OID_AUTO, component_watermark, CTLFLAG_RWTUN,
 101     &g_virstor_component_watermark, 0,
 102     "Minimum number of free components before issuing administrative warning");
 103
 104 static int read_metadata(struct g_consumer *, struct g_virstor_metadata *);
 105 static void write_metadata(struct g_consumer *, struct g_virstor_metadata *);
 106 static int clear_metadata(struct g_virstor_component *);
 107 static int add_provider_to_geom(struct g_virstor_softc *, struct g_provider *,
 108     struct g_virstor_metadata *);
 109 static struct g_geom *create_virstor_geom(struct g_class *,
 110     struct g_virstor_metadata *);
 111 static void virstor_check_and_run(struct g_virstor_softc *);
 112 static u_int virstor_valid_components(struct g_virstor_softc *);
 113 static int virstor_geom_destroy(struct g_virstor_softc *, boolean_t,
 114     boolean_t);
 115 static void remove_component(struct g_virstor_softc *,
 116     struct g_virstor_component *, boolean_t);
 117 static void bioq_dismantle(struct bio_queue_head *);
 118 static int allocate_chunk(struct g_virstor_softc *,
 119     struct g_virstor_component **, u_int *, u_int *);
 120 static void delay_destroy_consumer(void *, int);
 121 static void dump_component(struct g_virstor_component *comp);
 122 #if 0
 123 static void dump_me(struct virstor_map_entry *me, unsigned int nr);
 124 #endif
 125
 126 static void virstor_ctl_stop(struct gctl_req *, struct g_class *);
 127 static void virstor_ctl_add(struct gctl_req *, struct g_class *);
 128 static void virstor_ctl_remove(struct gctl_req *, struct g_class *);
 129 static struct g_virstor_softc * virstor_find_geom(const struct g_class *,
 130     const char *);
 131 static void update_metadata(struct g_virstor_softc *);
 132 static void fill_metadata(struct g_virstor_softc *, struct g_virstor_metadata *,
 133     u_int, u_int);
 134
 135 static void g_virstor_orphan(struct g_consumer *);
 136 static int g_virstor_access(struct g_provider *, int, int, int);
 137 static void g_virstor_start(struct bio *);
 138 static void g_virstor_dumpconf(struct sbuf *, const char *, struct g_geom *,
 139     struct g_consumer *, struct g_provider *);
 140 static void g_virstor_done(struct bio *);
 141
 142 static void invalid_call(void);
 143 /*
 144  * Initialise GEOM class (per-class callback)
 145  */
 146 static void
 147 g_virstor_init(struct g_class *mp __unused)
 148 {
 149
 150         /* Catch map struct size mismatch at compile time; Map entries must
 151          * fit into maxphys exactly, with no wasted space. */
 152         MPASS(VIRSTOR_MAP_BLOCK_ENTRIES * VIRSTOR_MAP_ENTRY_SIZE == maxphys);
 153
 154         /* Init UMA zones, TAILQ's, other global vars */
 155 }
 156
 157 /*
 158  * Finalise GEOM class (per-class callback)
 159  */
 160 static void
 161 g_virstor_fini(struct g_class *mp __unused)
 162 {
 163
 164         /* Deinit UMA zones & global vars */
 165 }
 166
 167 /*
 168  * Config (per-class callback)
 169  */
 170 static void
 171 g_virstor_config(struct gctl_req *req, struct g_class *cp, char const *verb)
 172 {
 173         uint32_t *version;
 174
 175         g_topology_assert();
 176
 177         version = gctl_get_paraml(req, "version", sizeof(*version));
 178         if (version == NULL) {
 179                 gctl_error(req, "Failed to get 'version' argument");
 180                 return;
 181         }
 182         if (*version != G_VIRSTOR_VERSION) {
 183                 gctl_error(req, "Userland and kernel versions out of sync");
 184                 return;
 185         }
 186
 187         g_topology_unlock();
 188         if (strcmp(verb, "add") == 0)
 189                 virstor_ctl_add(req, cp);
 190         else if (strcmp(verb, "stop") == 0 || strcmp(verb, "destroy") == 0)
 191                 virstor_ctl_stop(req, cp);
 192         else if (strcmp(verb, "remove") == 0)
 193                 virstor_ctl_remove(req, cp);
 194         else
 195                 gctl_error(req, "unknown verb: '%s'", verb);
 196         g_topology_lock();
 197 }
 198
 199 /*
 200  * "stop" verb from userland
 201  */
 202 static void
 203 virstor_ctl_stop(struct gctl_req *req, struct g_class *cp)
 204 {
 205         int *force, *nargs;
 206         int i;
 207
 208         nargs = gctl_get_paraml(req, "nargs", sizeof *nargs);
 209         if (nargs == NULL) {
 210                 gctl_error(req, "Error fetching argument '%s'", "nargs");
 211                 return;
 212         }
 213         if (*nargs < 1) {
 214                 gctl_error(req, "Invalid number of arguments");
 215                 return;
 216         }
 217         force = gctl_get_paraml(req, "force", sizeof *force);
 218         if (force == NULL) {
 219                 gctl_error(req, "Error fetching argument '%s'", "force");
 220                 return;
 221         }
 222
 223         g_topology_lock();
 224         for (i = 0; i < *nargs; i++) {
 225                 char param[8];
 226                 const char *name;
 227                 struct g_virstor_softc *sc;
 228                 int error;
 229
 230                 snprintf(param, sizeof(param), "arg%d", i);
 231                 name = gctl_get_asciiparam(req, param);
 232                 if (name == NULL) {
 233                         gctl_error(req, "No 'arg%d' argument", i);
 234                         g_topology_unlock();
 235                         return;
 236                 }
 237                 sc = virstor_find_geom(cp, name);
 238                 if (sc == NULL) {
 239                         gctl_error(req, "Don't know anything about '%s'", name);
 240                         g_topology_unlock();
 241                         return;
 242                 }
 243
 244                 LOG_MSG(LVL_INFO, "Stopping %s by the userland command",
 245                     sc->geom->name);
 246                 update_metadata(sc);
 247                 if ((error = virstor_geom_destroy(sc, TRUE, TRUE)) != 0) {
 248                         LOG_MSG(LVL_ERROR, "Cannot destroy %s: %d",
 249                             sc->geom->name, error);
 250                 }
 251         }
 252         g_topology_unlock();
 253 }
 254
 255 /*
 256  * "add" verb from userland - add new component(s) to the structure.
 257  * This will be done all at once in here, without going through the
 258  * .taste function for new components.
 259  */
 260 static void
 261 virstor_ctl_add(struct gctl_req *req, struct g_class *cp)
 262 {
 263         /* Note: while this is going on, I/O is being done on
 264          * the g_up and g_down threads. The idea is to make changes
 265          * to softc members in a way that can atomically activate
 266          * them all at once. */
 267         struct g_virstor_softc *sc;
 268         int *hardcode, *nargs;
 269         const char *geom_name;  /* geom to add a component to */
 270         struct g_consumer *fcp;
 271         struct g_virstor_bio_q *bq;
 272         u_int added;
 273         int error;
 274         int i;
 275
 276         nargs = gctl_get_paraml(req, "nargs", sizeof(*nargs));
 277         if (nargs == NULL) {
 278                 gctl_error(req, "Error fetching argument '%s'", "nargs");
 279                 return;
 280         }
 281         if (*nargs < 2) {
 282                 gctl_error(req, "Invalid number of arguments");
 283                 return;
 284         }
 285         hardcode = gctl_get_paraml(req, "hardcode", sizeof(*hardcode));
 286         if (hardcode == NULL) {
 287                 gctl_error(req, "Error fetching argument '%s'", "hardcode");
 288                 return;
 289         }
 290
 291         /* Find "our" geom */
 292         geom_name = gctl_get_asciiparam(req, "arg0");
 293         if (geom_name == NULL) {
 294                 gctl_error(req, "Error fetching argument '%s'", "geom_name (arg0)");
 295                 return;
 296         }
 297         sc = virstor_find_geom(cp, geom_name);
 298         if (sc == NULL) {
 299                 gctl_error(req, "Don't know anything about '%s'", geom_name);
 300                 return;
 301         }
 302
 303         if (virstor_valid_components(sc) != sc->n_components) {
 304                 LOG_MSG(LVL_ERROR, "Cannot add components to incomplete "
 305                     "virstor %s", sc->geom->name);
 306                 gctl_error(req, "Virstor %s is incomplete", sc->geom->name);
 307                 return;
 308         }
 309
 310         fcp = sc->components[0].gcons;
 311         added = 0;
 312         g_topology_lock();
 313         for (i = 1; i < *nargs; i++) {
 314                 struct g_virstor_metadata md;
 315                 char aname[8];
 316                 struct g_provider *pp;
 317                 struct g_consumer *cp;
 318                 u_int nc;
 319                 u_int j;
 320
 321                 snprintf(aname, sizeof aname, "arg%d", i);
 322                 pp = gctl_get_provider(req, aname);
 323                 if (pp == NULL) {
 324                         /* This is the most common error so be verbose about it */
 325                         if (added != 0) {
 326                                 gctl_error(req, "Invalid provider. (added"
 327                                     " %u components)", added);
 328                                 update_metadata(sc);
 329                         }
 330                         g_topology_unlock();
 331                         return;
 332                 }
 333                 cp = g_new_consumer(sc->geom);
 334                 if (cp == NULL) {
 335                         gctl_error(req, "Cannot create consumer");
 336                         g_topology_unlock();
 337                         return;
 338                 }
 339                 error = g_attach(cp, pp);
 340                 if (error != 0) {
 341                         gctl_error(req, "Cannot attach a consumer to %s",
 342                             pp->name);
 343                         g_destroy_consumer(cp);
 344                         g_topology_unlock();
 345                         return;
 346                 }
 347                 if (fcp->acr != 0 || fcp->acw != 0 || fcp->ace != 0) {
 348                         error = g_access(cp, fcp->acr, fcp->acw, fcp->ace);
 349                         if (error != 0) {
 350                                 gctl_error(req, "Access request failed for %s",
 351                                     pp->name);
 352                                 g_destroy_consumer(cp);
 353                                 g_topology_unlock();
 354                                 return;
 355                         }
 356                 }
 357                 if (fcp->provider->sectorsize != pp->sectorsize) {
 358                         gctl_error(req, "Sector size doesn't fit for %s",
 359                             pp->name);
 360                         g_destroy_consumer(cp);
 361                         g_topology_unlock();
 362                         return;
 363                 }
 364                 for (j = 0; j < sc->n_components; j++) {
 365                         if (strcmp(sc->components[j].gcons->provider->name,
 366                             pp->name) == 0) {
 367                                 gctl_error(req, "Component %s already in %s",
 368                                     pp->name, sc->geom->name);
 369                                 g_destroy_consumer(cp);
 370                                 g_topology_unlock();
 371                                 return;
 372                         }
 373                 }
 374                 sc->components = realloc(sc->components,
 375                     sizeof(*sc->components) * (sc->n_components + 1),
 376                     M_GVIRSTOR, M_WAITOK);
 377
 378                 nc = sc->n_components;
 379                 sc->components[nc].gcons = cp;
 380                 sc->components[nc].sc = sc;
 381                 sc->components[nc].index = nc;
 382                 sc->components[nc].chunk_count = cp->provider->mediasize /
 383                     sc->chunk_size;
 384                 sc->components[nc].chunk_next = 0;
 385                 sc->components[nc].chunk_reserved = 0;
 386
 387                 if (sc->components[nc].chunk_count < 4) {
 388                         gctl_error(req, "Provider too small: %s",
 389                             cp->provider->name);
 390                         g_destroy_consumer(cp);
 391                         g_topology_unlock();
 392                         return;
 393                 }
 394                 fill_metadata(sc, &md, nc, *hardcode);
 395                 write_metadata(cp, &md);
 396                 /* The new component becomes visible when n_components is
 397                  * incremented */
 398                 sc->n_components++;
 399                 added++;
 400         }
 401         /* This call to update_metadata() is critical. In case there's a
 402          * power failure in the middle of it and some components are updated
 403          * while others are not, there will be trouble on next .taste() iff
 404          * a non-updated component is detected first */
 405         update_metadata(sc);
 406         g_topology_unlock();
 407         LOG_MSG(LVL_INFO, "Added %d component(s) to %s", added,
 408             sc->geom->name);
 409         /* Fire off BIOs previously queued because there wasn't any
 410          * physical space left. If the BIOs still can't be satisfied
 411          * they will again be added to the end of the queue (during
 412          * which the mutex will be recursed) */
 413         bq = malloc(sizeof(*bq), M_GVIRSTOR, M_WAITOK);
 414         bq->bio = NULL;
 415         mtx_lock(&sc->delayed_bio_q_mtx);
 416         /* First, insert a sentinel to the queue end, so we don't
 417          * end up in an infinite loop if there's still no free
 418          * space available. */
 419         STAILQ_INSERT_TAIL(&sc->delayed_bio_q, bq, linkage);
 420         while (!STAILQ_EMPTY(&sc->delayed_bio_q)) {
 421                 bq = STAILQ_FIRST(&sc->delayed_bio_q);
 422                 if (bq->bio != NULL) {
 423                         g_virstor_start(bq->bio);
 424                         STAILQ_REMOVE_HEAD(&sc->delayed_bio_q, linkage);
 425                         free(bq, M_GVIRSTOR);
 426                 } else {
 427                         STAILQ_REMOVE_HEAD(&sc->delayed_bio_q, linkage);
 428                         free(bq, M_GVIRSTOR);
 429                         break;
 430                 }
 431         }
 432         mtx_unlock(&sc->delayed_bio_q_mtx);
 433
 434 }
 435
 436 /*
 437  * Find a geom handled by the class
 438  */
 439 static struct g_virstor_softc *
 440 virstor_find_geom(const struct g_class *cp, const char *name)
 441 {
 442         struct g_geom *gp;
 443
 444         LIST_FOREACH(gp, &cp->geom, geom) {
 445                 if (strcmp(name, gp->name) == 0)
 446                         return (gp->softc);
 447         }
 448         return (NULL);
 449 }
 450
 451 /*
 452  * Update metadata on all components to reflect the current state
 453  * of these fields:
 454  *    - chunk_next
 455  *    - flags
 456  *    - md_count
 457  * Expects things to be set up so write_metadata() can work, i.e.
 458  * the topology lock must be held.
 459  */
 460 static void
 461 update_metadata(struct g_virstor_softc *sc)
 462 {
 463         struct g_virstor_metadata md;
 464         u_int n;
 465
 466         if (virstor_valid_components(sc) != sc->n_components)
 467                 return; /* Incomplete device */
 468         LOG_MSG(LVL_DEBUG, "Updating metadata on components for %s",
 469             sc->geom->name);
 470         /* Update metadata on components */
 471         g_trace(G_T_TOPOLOGY, "%s(%s, %s)", __func__,
 472             sc->geom->class->name, sc->geom->name);
 473         g_topology_assert();
 474         for (n = 0; n < sc->n_components; n++) {
 475                 read_metadata(sc->components[n].gcons, &md);
 476                 md.chunk_next = sc->components[n].chunk_next;
 477                 md.flags = sc->components[n].flags;
 478                 md.md_count = sc->n_components;
 479                 write_metadata(sc->components[n].gcons, &md);
 480         }
 481 }
 482
 483 /*
 484  * Fills metadata (struct md) from information stored in softc and the nc'th
 485  * component of virstor
 486  */
 487 static void
 488 fill_metadata(struct g_virstor_softc *sc, struct g_virstor_metadata *md,
 489     u_int nc, u_int hardcode)
 490 {
 491         struct g_virstor_component *c;
 492
 493         bzero(md, sizeof *md);
 494         c = &sc->components[nc];
 495
 496         strncpy(md->md_magic, G_VIRSTOR_MAGIC, sizeof md->md_magic);
 497         md->md_version = G_VIRSTOR_VERSION;
 498         strncpy(md->md_name, sc->geom->name, sizeof md->md_name);
 499         md->md_id = sc->id;
 500         md->md_virsize = sc->virsize;
 501         md->md_chunk_size = sc->chunk_size;
 502         md->md_count = sc->n_components;
 503
 504         if (hardcode) {
 505                 strncpy(md->provider, c->gcons->provider->name,
 506                     sizeof md->provider);
 507         }
 508         md->no = nc;
 509         md->provsize = c->gcons->provider->mediasize;
 510         md->chunk_count = c->chunk_count;
 511         md->chunk_next = c->chunk_next;
 512         md->chunk_reserved = c->chunk_reserved;
 513         md->flags = c->flags;
 514 }
 515
 516 /*
 517  * Remove a component from virstor device.
 518  * Can only be done if the component is unallocated.
 519  */
 520 static void
 521 virstor_ctl_remove(struct gctl_req *req, struct g_class *cp)
 522 {
 523         /* As this is executed in parallel to I/O, operations on virstor
 524          * structures must be as atomic as possible. */
 525         struct g_virstor_softc *sc;
 526         int *nargs;
 527         const char *geom_name;
 528         u_int removed;
 529         int i;
 530
 531         nargs = gctl_get_paraml(req, "nargs", sizeof(*nargs));
 532         if (nargs == NULL) {
 533                 gctl_error(req, "Error fetching argument '%s'", "nargs");
 534                 return;
 535         }
 536         if (*nargs < 2) {
 537                 gctl_error(req, "Invalid number of arguments");
 538                 return;
 539         }
 540         /* Find "our" geom */
 541         geom_name = gctl_get_asciiparam(req, "arg0");
 542         if (geom_name == NULL) {
 543                 gctl_error(req, "Error fetching argument '%s'",
 544                     "geom_name (arg0)");
 545                 return;
 546         }
 547         sc = virstor_find_geom(cp, geom_name);
 548         if (sc == NULL) {
 549                 gctl_error(req, "Don't know anything about '%s'", geom_name);
 550                 return;
 551         }
 552
 553         if (virstor_valid_components(sc) != sc->n_components) {
 554                 LOG_MSG(LVL_ERROR, "Cannot remove components from incomplete "
 555                     "virstor %s", sc->geom->name);
 556                 gctl_error(req, "Virstor %s is incomplete", sc->geom->name);
 557                 return;
 558         }
 559
 560         removed = 0;
 561         for (i = 1; i < *nargs; i++) {
 562                 char param[8];
 563                 const char *prov_name;
 564                 int j, found;
 565                 struct g_virstor_component *newcomp, *compbak;
 566
 567                 snprintf(param, sizeof(param), "arg%d", i);
 568                 prov_name = gctl_get_asciiparam(req, param);
 569                 if (prov_name == NULL) {
 570                         gctl_error(req, "Error fetching argument '%s'", param);
 571                         return;
 572                 }
 573                 if (strncmp(prov_name, _PATH_DEV, sizeof(_PATH_DEV) - 1) == 0)
 574                         prov_name += sizeof(_PATH_DEV) - 1;
 575
 576                 found = -1;
 577                 for (j = 0; j < sc->n_components; j++) {
 578                         if (strcmp(sc->components[j].gcons->provider->name,
 579                             prov_name) == 0) {
 580                                 found = j;
 581                                 break;
 582                         }
 583                 }
 584                 if (found == -1) {
 585                         LOG_MSG(LVL_ERROR, "No %s component in %s",
 586                             prov_name, sc->geom->name);
 587                         continue;
 588                 }
 589
 590                 compbak = sc->components;
 591                 newcomp = malloc(sc->n_components * sizeof(*sc->components),
 592                     M_GVIRSTOR, M_WAITOK | M_ZERO);
 593                 bcopy(sc->components, newcomp, found * sizeof(*sc->components));
 594                 bcopy(&sc->components[found + 1], newcomp + found,
 595                     found * sizeof(*sc->components));
 596                 if ((sc->components[j].flags & VIRSTOR_PROVIDER_ALLOCATED) != 0) {
 597                         LOG_MSG(LVL_ERROR, "Allocated provider %s cannot be "
 598                             "removed from %s",
 599                             prov_name, sc->geom->name);
 600                         free(newcomp, M_GVIRSTOR);
 601                         /* We'll consider this non-fatal error */
 602                         continue;
 603                 }
 604                 /* Renumerate unallocated components */
 605                 for (j = 0; j < sc->n_components-1; j++) {
 606                         if ((sc->components[j].flags &
 607                             VIRSTOR_PROVIDER_ALLOCATED) == 0) {
 608                                 sc->components[j].index = j;
 609                         }
 610                 }
 611                 /* This is the critical section. If a component allocation
 612                  * event happens while both variables are not yet set,
 613                  * there will be trouble. Something will panic on encountering
 614                  * NULL sc->components[x].gcomp member.
 615                  * Luckily, component allocation happens very rarely and
 616                  * removing components is an abnormal action in any case. */
 617                 sc->components = newcomp;
 618                 sc->n_components--;
 619                 /* End critical section */
 620
 621                 g_topology_lock();
 622                 if (clear_metadata(&compbak[found]) != 0) {
 623                         LOG_MSG(LVL_WARNING, "Trouble ahead: cannot clear "
 624                             "metadata on %s", prov_name);
 625                 }
 626                 g_detach(compbak[found].gcons);
 627                 g_destroy_consumer(compbak[found].gcons);
 628                 g_topology_unlock();
 629
 630                 free(compbak, M_GVIRSTOR);
 631
 632                 removed++;
 633         }
 634
 635         /* This call to update_metadata() is critical. In case there's a
 636          * power failure in the middle of it and some components are updated
 637          * while others are not, there will be trouble on next .taste() iff
 638          * a non-updated component is detected first */
 639         g_topology_lock();
 640         update_metadata(sc);
 641         g_topology_unlock();
 642         LOG_MSG(LVL_INFO, "Removed %d component(s) from %s", removed,
 643             sc->geom->name);
 644 }
 645
 646 /*
 647  * Clear metadata sector on component
 648  */
 649 static int
 650 clear_metadata(struct g_virstor_component *comp)
 651 {
 652         char *buf;
 653         int error;
 654
 655         LOG_MSG(LVL_INFO, "Clearing metadata on %s",
 656             comp->gcons->provider->name);
 657         g_topology_assert();
 658         error = g_access(comp->gcons, 0, 1, 0);
 659         if (error != 0)
 660                 return (error);
 661         buf = malloc(comp->gcons->provider->sectorsize, M_GVIRSTOR,
 662             M_WAITOK | M_ZERO);
 663         error = g_write_data(comp->gcons,
 664             comp->gcons->provider->mediasize -
 665             comp->gcons->provider->sectorsize,
 666             buf,
 667             comp->gcons->provider->sectorsize);
 668         free(buf, M_GVIRSTOR);
 669         g_access(comp->gcons, 0, -1, 0);
 670         return (error);
 671 }
 672
 673 /*
 674  * Destroy geom forcibly.
 675  */
 676 static int
 677 g_virstor_destroy_geom(struct gctl_req *req __unused, struct g_class *mp,
 678     struct g_geom *gp)
 679 {
 680         struct g_virstor_softc *sc;
 681         int exitval;
 682
 683         sc = gp->softc;
 684         KASSERT(sc != NULL, ("%s: NULL sc", __func__));
 685
 686         exitval = 0;
 687         LOG_MSG(LVL_DEBUG, "%s called for %s, sc=%p", __func__, gp->name,
 688             gp->softc);
 689
 690         if (sc != NULL) {
 691 #ifdef INVARIANTS
 692                 char *buf;
 693                 int error;
 694                 off_t off;
 695                 int isclean, count;
 696                 int n;
 697
 698                 LOG_MSG(LVL_INFO, "INVARIANTS detected");
 699                 LOG_MSG(LVL_INFO, "Verifying allocation "
 700                     "table for %s", sc->geom->name);
 701                 count = 0;
 702                 for (n = 0; n < sc->chunk_count; n++) {
 703                         if (sc->map[n].flags || VIRSTOR_MAP_ALLOCATED != 0)
 704                                 count++;
 705                 }
 706                 LOG_MSG(LVL_INFO, "Device %s has %d allocated chunks",
 707                     sc->geom->name, count);
 708                 n = off = count = 0;
 709                 isclean = 1;
 710                 if (virstor_valid_components(sc) != sc->n_components) {
 711                         /* This is a incomplete virstor device (not all
 712                          * components have been found) */
 713                         LOG_MSG(LVL_ERROR, "Device %s is incomplete",
 714                             sc->geom->name);
 715                         goto bailout;
 716                 }
 717                 error = g_access(sc->components[0].gcons, 1, 0, 0);
 718                 KASSERT(error == 0, ("%s: g_access failed (%d)", __func__,
 719                     error));
 720                 /* Compare the whole on-disk allocation table with what's
 721                  * currently in memory */
 722                 while (n < sc->chunk_count) {
 723                         buf = g_read_data(sc->components[0].gcons, off,
 724                             sc->sectorsize, &error);
 725                         KASSERT(buf != NULL, ("g_read_data returned NULL (%d) "
 726                             "for read at %jd", error, off));
 727                         if (bcmp(buf, &sc->map[n], sc->sectorsize) != 0) {
 728                                 LOG_MSG(LVL_ERROR, "ERROR in allocation table, "
 729                                     "entry %d, offset %jd", n, off);
 730                                 isclean = 0;
 731                                 count++;
 732                         }
 733                         n += sc->me_per_sector;
 734                         off += sc->sectorsize;
 735                         g_free(buf);
 736                 }
 737                 error = g_access(sc->components[0].gcons, -1, 0, 0);
 738                 KASSERT(error == 0, ("%s: g_access failed (%d) on exit",
 739                     __func__, error));
 740                 if (isclean != 1) {
 741                         LOG_MSG(LVL_ERROR, "ALLOCATION TABLE CORRUPTED FOR %s "
 742                             "(%d sectors don't match, max %zu allocations)",
 743                             sc->geom->name, count,
 744                             count * sc->me_per_sector);
 745                 } else {
 746                         LOG_MSG(LVL_INFO, "Allocation table ok for %s",
 747                             sc->geom->name);
 748                 }
 749 bailout:
 750 #endif
 751                 update_metadata(sc);
 752                 virstor_geom_destroy(sc, FALSE, FALSE);
 753                 exitval = EAGAIN;
 754         } else
 755                 exitval = 0;
 756         return (exitval);
 757 }
 758
 759 /*
 760  * Taste event (per-class callback)
 761  * Examines a provider and creates geom instances if needed
 762  */
 763 static struct g_geom *
 764 g_virstor_taste(struct g_class *mp, struct g_provider *pp, int flags)
 765 {
 766         struct g_virstor_metadata md;
 767         struct g_geom *gp;
 768         struct g_consumer *cp;
 769         struct g_virstor_softc *sc;
 770         int error;
 771
 772         g_trace(G_T_TOPOLOGY, "%s(%s, %s)", __func__, mp->name, pp->name);
 773         g_topology_assert();
 774         LOG_MSG(LVL_DEBUG, "Tasting %s", pp->name);
 775
 776         /* We need a dummy geom to attach a consumer to the given provider */
 777         gp = g_new_geomf(mp, "virstor:taste.helper");
 778         gp->start = (void *)invalid_call;       /* XXX: hacked up so the        */
 779         gp->access = (void *)invalid_call;      /* compiler doesn't complain.   */
 780         gp->orphan = (void *)invalid_call;      /* I really want these to fail. */
 781
 782         cp = g_new_consumer(gp);
 783         cp->flags |= G_CF_DIRECT_SEND | G_CF_DIRECT_RECEIVE;
 784         error = g_attach(cp, pp);
 785         if (error == 0) {
 786                 error = read_metadata(cp, &md);
 787                 g_detach(cp);
 788         }
 789         g_destroy_consumer(cp);
 790         g_destroy_geom(gp);
 791
 792         if (error != 0)
 793                 return (NULL);
 794
 795         if (strcmp(md.md_magic, G_VIRSTOR_MAGIC) != 0)
 796                 return (NULL);
 797         if (md.md_version != G_VIRSTOR_VERSION) {
 798                 LOG_MSG(LVL_ERROR, "Kernel module version invalid "
 799                     "to handle %s (%s) : %d should be %d",
 800                     md.md_name, pp->name, md.md_version, G_VIRSTOR_VERSION);
 801                 return (NULL);
 802         }
 803         if (md.provsize != pp->mediasize)
 804                 return (NULL);
 805
 806         /* If the provider name is hardcoded, use the offered provider only
 807          * if it's been offered with its proper name (the one used in
 808          * the label command). */
 809         if (md.provider[0] != '\0' &&
 810             !g_compare_names(md.provider, pp->name))
 811                 return (NULL);
 812
 813         /* Iterate all geoms this class already knows about to see if a new
 814          * geom instance of this class needs to be created (in case the provider
 815          * is first from a (possibly) multi-consumer geom) or it just needs
 816          * to be added to an existing instance. */
 817         sc = NULL;
 818         gp = NULL;
 819         LIST_FOREACH(gp, &mp->geom, geom) {
 820                 sc = gp->softc;
 821                 if (sc == NULL)
 822                         continue;
 823                 if (strcmp(md.md_name, sc->geom->name) != 0)
 824                         continue;
 825                 if (md.md_id != sc->id)
 826                         continue;
 827                 break;
 828         }
 829         if (gp != NULL) { /* We found an existing geom instance; add to it */
 830                 LOG_MSG(LVL_INFO, "Adding %s to %s", pp->name, md.md_name);
 831                 error = add_provider_to_geom(sc, pp, &md);
 832                 if (error != 0) {
 833                         LOG_MSG(LVL_ERROR, "Error adding %s to %s (error %d)",
 834                             pp->name, md.md_name, error);
 835                         return (NULL);
 836                 }
 837         } else { /* New geom instance needs to be created */
 838                 gp = create_virstor_geom(mp, &md);
 839                 if (gp == NULL) {
 840                         LOG_MSG(LVL_ERROR, "Error creating new instance of "
 841                             "class %s: %s", mp->name, md.md_name);
 842                         LOG_MSG(LVL_DEBUG, "Error creating %s at %s",
 843                             md.md_name, pp->name);
 844                         return (NULL);
 845                 }
 846                 sc = gp->softc;
 847                 LOG_MSG(LVL_INFO, "Adding %s to %s (first found)", pp->name,
 848                     md.md_name);
 849                 error = add_provider_to_geom(sc, pp, &md);
 850                 if (error != 0) {
 851                         LOG_MSG(LVL_ERROR, "Error adding %s to %s (error %d)",
 852                             pp->name, md.md_name, error);
 853                         virstor_geom_destroy(sc, TRUE, FALSE);
 854                         return (NULL);
 855                 }
 856         }
 857
 858         return (gp);
 859 }
 860
 861 /*
 862  * Destroyes consumer passed to it in arguments. Used as a callback
 863  * on g_event queue.
 864  */
 865 static void
 866 delay_destroy_consumer(void *arg, int flags __unused)
 867 {
 868         struct g_consumer *c = arg;
 869         KASSERT(c != NULL, ("%s: invalid consumer", __func__));
 870         LOG_MSG(LVL_DEBUG, "Consumer %s destroyed with delay",
 871             c->provider->name);
 872         g_detach(c);
 873         g_destroy_consumer(c);
 874 }
 875
 876 /*
 877  * Remove a component (consumer) from geom instance; If it's the first
 878  * component being removed, orphan the provider to announce geom's being
 879  * dismantled
 880  */
 881 static void
 882 remove_component(struct g_virstor_softc *sc, struct g_virstor_component *comp,
 883     boolean_t delay)
 884 {
 885         struct g_consumer *c;
 886
 887         KASSERT(comp->gcons != NULL, ("Component with no consumer in %s",
 888             sc->geom->name));
 889         c = comp->gcons;
 890
 891         comp->gcons = NULL;
 892         KASSERT(c->provider != NULL, ("%s: no provider", __func__));
 893         LOG_MSG(LVL_DEBUG, "Component %s removed from %s", c->provider->name,
 894             sc->geom->name);
 895         if (sc->provider != NULL) {
 896                 LOG_MSG(LVL_INFO, "Removing provider %s", sc->provider->name);
 897                 g_wither_provider(sc->provider, ENXIO);
 898                 sc->provider = NULL;
 899         }
 900
 901         if (c->acr > 0 || c->acw > 0 || c->ace > 0)
 902                 return;
 903         if (delay) {
 904                 /* Destroy consumer after it's tasted */
 905                 g_post_event(delay_destroy_consumer, c, M_WAITOK, NULL);
 906         } else {
 907                 g_detach(c);
 908                 g_destroy_consumer(c);
 909         }
 910 }
 911
 912 /*
 913  * Destroy geom - called internally
 914  * See g_virstor_destroy_geom for the other one
 915  */
 916 static int
 917 virstor_geom_destroy(struct g_virstor_softc *sc, boolean_t force,
 918     boolean_t delay)
 919 {
 920         struct g_provider *pp;
 921         struct g_geom *gp;
 922         u_int n;
 923
 924         g_topology_assert();
 925
 926         if (sc == NULL)
 927                 return (ENXIO);
 928
 929         pp = sc->provider;
 930         if (pp != NULL && (pp->acr != 0 || pp->acw != 0 || pp->ace != 0)) {
 931                 LOG_MSG(force ? LVL_WARNING : LVL_ERROR,
 932                     "Device %s is still open.", pp->name);
 933                 if (!force)
 934                         return (EBUSY);
 935         }
 936
 937         for (n = 0; n < sc->n_components; n++) {
 938                 if (sc->components[n].gcons != NULL)
 939                         remove_component(sc, &sc->components[n], delay);
 940         }
 941
 942         gp = sc->geom;
 943         gp->softc = NULL;
 944
 945         KASSERT(sc->provider == NULL, ("Provider still exists for %s",
 946             gp->name));
 947
 948         /* XXX: This might or might not work, since we're called with
 949          * the topology lock held. Also, it might panic the kernel if
 950          * the error'd BIO is in softupdates code. */
 951         mtx_lock(&sc->delayed_bio_q_mtx);
 952         while (!STAILQ_EMPTY(&sc->delayed_bio_q)) {
 953                 struct g_virstor_bio_q *bq;
 954                 bq = STAILQ_FIRST(&sc->delayed_bio_q);
 955                 bq->bio->bio_error = ENOSPC;
 956                 g_io_deliver(bq->bio, EIO);
 957                 STAILQ_REMOVE_HEAD(&sc->delayed_bio_q, linkage);
 958                 free(bq, M_GVIRSTOR);
 959         }
 960         mtx_unlock(&sc->delayed_bio_q_mtx);
 961         mtx_destroy(&sc->delayed_bio_q_mtx);
 962
 963         free(sc->map, M_GVIRSTOR);
 964         free(sc->components, M_GVIRSTOR);
 965         bzero(sc, sizeof *sc);
 966         free(sc, M_GVIRSTOR);
 967
 968         pp = LIST_FIRST(&gp->provider); /* We only offer one provider */
 969         if (pp == NULL || (pp->acr == 0 && pp->acw == 0 && pp->ace == 0))
 970                 LOG_MSG(LVL_DEBUG, "Device %s destroyed", gp->name);
 971
 972         g_wither_geom(gp, ENXIO);
 973
 974         return (0);
 975 }
 976
 977 /*
 978  * Utility function: read metadata & decode. Wants topology lock to be
 979  * held.
 980  */
 981 static int
 982 read_metadata(struct g_consumer *cp, struct g_virstor_metadata *md)
 983 {
 984         struct g_provider *pp;
 985         char *buf;
 986         int error;
 987
 988         g_topology_assert();
 989         error = g_access(cp, 1, 0, 0);
 990         if (error != 0)
 991                 return (error);
 992         pp = cp->provider;
 993         g_topology_unlock();
 994         buf = g_read_data(cp, pp->mediasize - pp->sectorsize, pp->sectorsize,
 995             &error);
 996         g_topology_lock();
 997         g_access(cp, -1, 0, 0);
 998         if (buf == NULL)
 999                 return (error);
1000
1001         virstor_metadata_decode(buf, md);
1002         g_free(buf);
1003
1004         return (0);
1005 }
1006
1007 /**
1008  * Utility function: encode & write metadata. Assumes topology lock is
1009  * held.
1010  *
1011  * There is no useful way of recovering from errors in this function,
1012  * not involving panicking the kernel. If the metadata cannot be written
1013  * the most we can do is notify the operator and hope he spots it and
1014  * replaces the broken drive.
1015  */
1016 static void
1017 write_metadata(struct g_consumer *cp, struct g_virstor_metadata *md)
1018 {
1019         struct g_provider *pp;
1020         char *buf;
1021         int error;
1022
1023         KASSERT(cp != NULL && md != NULL && cp->provider != NULL,
1024             ("Something's fishy in %s", __func__));
1025         LOG_MSG(LVL_DEBUG, "Writing metadata on %s", cp->provider->name);
1026         g_topology_assert();
1027         error = g_access(cp, 0, 1, 0);
1028         if (error != 0) {
1029                 LOG_MSG(LVL_ERROR, "g_access(0,1,0) failed for %s: %d",
1030                     cp->provider->name, error);
1031                 return;
1032         }
1033         pp = cp->provider;
1034
1035         buf = malloc(pp->sectorsize, M_GVIRSTOR, M_WAITOK);
1036         bzero(buf, pp->sectorsize);
1037         virstor_metadata_encode(md, buf);
1038         g_topology_unlock();
1039         error = g_write_data(cp, pp->mediasize - pp->sectorsize, buf,
1040             pp->sectorsize);
1041         g_topology_lock();
1042         g_access(cp, 0, -1, 0);
1043         free(buf, M_GVIRSTOR);
1044
1045         if (error != 0)
1046                 LOG_MSG(LVL_ERROR, "Error %d writing metadata to %s",
1047                     error, cp->provider->name);
1048 }
1049
1050 /*
1051  * Creates a new instance of this GEOM class, initialise softc
1052  */
1053 static struct g_geom *
1054 create_virstor_geom(struct g_class *mp, struct g_virstor_metadata *md)
1055 {
1056         struct g_geom *gp;
1057         struct g_virstor_softc *sc;
1058
1059         LOG_MSG(LVL_DEBUG, "Creating geom instance for %s (id=%u)",
1060             md->md_name, md->md_id);
1061
1062         if (md->md_count < 1 || md->md_chunk_size < 1 ||
1063             md->md_virsize < md->md_chunk_size) {
1064                 /* This is bogus configuration, and probably means data is
1065                  * somehow corrupted. Panic, maybe? */
1066                 LOG_MSG(LVL_ERROR, "Nonsensical metadata information for %s",
1067                     md->md_name);
1068                 return (NULL);
1069         }
1070
1071         /* Check if it's already created */
1072         LIST_FOREACH(gp, &mp->geom, geom) {
1073                 sc = gp->softc;
1074                 if (sc != NULL && strcmp(sc->geom->name, md->md_name) == 0) {
1075                         LOG_MSG(LVL_WARNING, "Geom %s already exists",
1076                             md->md_name);
1077                         if (sc->id != md->md_id) {
1078                                 LOG_MSG(LVL_ERROR,
1079                                     "Some stale or invalid components "
1080                                     "exist for virstor device named %s. "
1081                                     "You will need to <CLEAR> all stale "
1082                                     "components and maybe reconfigure "
1083                                     "the virstor device. Tune "
1084                                     "kern.geom.virstor.debug sysctl up "
1085                                     "for more information.",
1086                                     sc->geom->name);
1087                         }
1088                         return (NULL);
1089                 }
1090         }
1091         gp = g_new_geomf(mp, "%s", md->md_name);
1092         gp->softc = NULL; /* to circumevent races that test softc */
1093
1094         gp->start = g_virstor_start;
1095         gp->spoiled = g_virstor_orphan;
1096         gp->orphan = g_virstor_orphan;
1097         gp->access = g_virstor_access;
1098         gp->dumpconf = g_virstor_dumpconf;
1099
1100         sc = malloc(sizeof(*sc), M_GVIRSTOR, M_WAITOK | M_ZERO);
1101         sc->id = md->md_id;
1102         sc->n_components = md->md_count;
1103         sc->components = malloc(sizeof(struct g_virstor_component) * md->md_count,
1104             M_GVIRSTOR, M_WAITOK | M_ZERO);
1105         sc->chunk_size = md->md_chunk_size;
1106         sc->virsize = md->md_virsize;
1107         STAILQ_INIT(&sc->delayed_bio_q);
1108         mtx_init(&sc->delayed_bio_q_mtx, "gvirstor_delayed_bio_q_mtx",
1109             "gvirstor", MTX_DEF | MTX_RECURSE);
1110
1111         sc->geom = gp;
1112         sc->provider = NULL; /* virstor_check_and_run will create it */
1113         gp->softc = sc;
1114
1115         LOG_MSG(LVL_ANNOUNCE, "Device %s created", sc->geom->name);
1116
1117         return (gp);
1118 }
1119
1120 /*
1121  * Add provider to a GEOM class instance
1122  */
1123 static int
1124 add_provider_to_geom(struct g_virstor_softc *sc, struct g_provider *pp,
1125     struct g_virstor_metadata *md)
1126 {
1127         struct g_virstor_component *component;
1128         struct g_consumer *cp, *fcp;
1129         struct g_geom *gp;
1130         int error;
1131
1132         if (md->no >= sc->n_components)
1133                 return (EINVAL);
1134
1135         /* "Current" compontent */
1136         component = &(sc->components[md->no]);
1137         if (component->gcons != NULL)
1138                 return (EEXIST);
1139
1140         gp = sc->geom;
1141         fcp = LIST_FIRST(&gp->consumer);
1142
1143         cp = g_new_consumer(gp);
1144         error = g_attach(cp, pp);
1145
1146         if (error != 0) {
1147                 g_destroy_consumer(cp);
1148                 return (error);
1149         }
1150
1151         if (fcp != NULL) {
1152                 if (fcp->provider->sectorsize != pp->sectorsize) {
1153                         /* TODO: this can be made to work */
1154                         LOG_MSG(LVL_ERROR, "Provider %s of %s has invalid "
1155                             "sector size (%d)", pp->name, sc->geom->name,
1156                             pp->sectorsize);
1157                         return (EINVAL);
1158                 }
1159                 if (fcp->acr > 0 || fcp->acw || fcp->ace > 0) {
1160                         /* Replicate access permissions from first "live" consumer
1161                          * to the new one */
1162                         error = g_access(cp, fcp->acr, fcp->acw, fcp->ace);
1163                         if (error != 0) {
1164                                 g_detach(cp);
1165                                 g_destroy_consumer(cp);
1166                                 return (error);
1167                         }
1168                 }
1169         }
1170
1171         /* Bring up a new component */
1172         cp->private = component;
1173         component->gcons = cp;
1174         component->sc = sc;
1175         component->index = md->no;
1176         component->chunk_count = md->chunk_count;
1177         component->chunk_next = md->chunk_next;
1178         component->chunk_reserved = md->chunk_reserved;
1179         component->flags = md->flags;
1180
1181         LOG_MSG(LVL_DEBUG, "%s attached to %s", pp->name, sc->geom->name);
1182
1183         virstor_check_and_run(sc);
1184         return (0);
1185 }
1186
1187 /*
1188  * Check if everything's ready to create the geom provider & device entry,
1189  * create and start provider.
1190  * Called ultimately by .taste, from g_event thread
1191  */
1192 static void
1193 virstor_check_and_run(struct g_virstor_softc *sc)
1194 {
1195         off_t off;
1196         size_t n, count;
1197         int index;
1198         int error;
1199
1200         if (virstor_valid_components(sc) != sc->n_components)
1201                 return;
1202
1203         if (virstor_valid_components(sc) == 0) {
1204                 /* This is actually a candidate for panic() */
1205                 LOG_MSG(LVL_ERROR, "No valid components for %s?",
1206                     sc->provider->name);
1207                 return;
1208         }
1209
1210         sc->sectorsize = sc->components[0].gcons->provider->sectorsize;
1211
1212         /* Initialise allocation map from the first consumer */
1213         sc->chunk_count = sc->virsize / sc->chunk_size;
1214         if (sc->chunk_count * (off_t)sc->chunk_size != sc->virsize) {
1215                 LOG_MSG(LVL_WARNING, "Device %s truncated to %ju bytes",
1216                     sc->provider->name,
1217                     sc->chunk_count * (off_t)sc->chunk_size);
1218         }
1219         sc->map_size = sc->chunk_count * sizeof *(sc->map);
1220         /* The following allocation is in order of 4MB - 8MB */
1221         sc->map = malloc(sc->map_size, M_GVIRSTOR, M_WAITOK);
1222         KASSERT(sc->map != NULL, ("%s: Memory allocation error (%zu bytes) for %s",
1223             __func__, sc->map_size, sc->provider->name));
1224         sc->map_sectors = sc->map_size / sc->sectorsize;
1225
1226         count = 0;
1227         for (n = 0; n < sc->n_components; n++)
1228                 count += sc->components[n].chunk_count;
1229         LOG_MSG(LVL_INFO, "Device %s has %zu physical chunks and %zu virtual "
1230             "(%zu KB chunks)",
1231             sc->geom->name, count, sc->chunk_count, sc->chunk_size / 1024);
1232
1233         error = g_access(sc->components[0].gcons, 1, 0, 0);
1234         if (error != 0) {
1235                 LOG_MSG(LVL_ERROR, "Cannot acquire read access for %s to "
1236                     "read allocation map for %s",
1237                     sc->components[0].gcons->provider->name,
1238                     sc->geom->name);
1239                 return;
1240         }
1241         /* Read in the allocation map */
1242         LOG_MSG(LVL_DEBUG, "Reading map for %s from %s", sc->geom->name,
1243             sc->components[0].gcons->provider->name);
1244         off = count = n = 0;
1245         while (count < sc->map_size) {
1246                 struct g_virstor_map_entry *mapbuf;
1247                 size_t bs;
1248
1249                 bs = MIN(maxphys, sc->map_size - count);
1250                 if (bs % sc->sectorsize != 0) {
1251                         /* Check for alignment errors */
1252                         bs = rounddown(bs, sc->sectorsize);
1253                         if (bs == 0)
1254                                 break;
1255                         LOG_MSG(LVL_ERROR, "Trouble: map is not sector-aligned "
1256                             "for %s on %s", sc->geom->name,
1257                             sc->components[0].gcons->provider->name);
1258                 }
1259                 mapbuf = g_read_data(sc->components[0].gcons, off, bs, &error);
1260                 if (mapbuf == NULL) {
1261                         free(sc->map, M_GVIRSTOR);
1262                         LOG_MSG(LVL_ERROR, "Error reading allocation map "
1263                             "for %s from %s (offset %ju) (error %d)",
1264                             sc->geom->name,
1265                             sc->components[0].gcons->provider->name,
1266                             off, error);
1267                         return;
1268                 }
1269
1270                 bcopy(mapbuf, &sc->map[n], bs);
1271                 off += bs;
1272                 count += bs;
1273                 n += bs / sizeof *(sc->map);
1274                 g_free(mapbuf);
1275         }
1276         g_access(sc->components[0].gcons, -1, 0, 0);
1277         LOG_MSG(LVL_DEBUG, "Read map for %s", sc->geom->name);
1278
1279         /* find first component with allocatable chunks */
1280         index = -1;
1281         for (n = 0; n < sc->n_components; n++) {
1282                 if (sc->components[n].chunk_next <
1283                     sc->components[n].chunk_count) {
1284                         index = n;
1285                         break;
1286                 }
1287         }
1288         if (index == -1)
1289                 /* not found? set it to the last component and handle it
1290                  * later */
1291                 index = sc->n_components - 1;
1292
1293         if (index >= sc->n_components - g_virstor_component_watermark - 1) {
1294                 LOG_MSG(LVL_WARNING, "Device %s running out of components "
1295                     "(%d/%u: %s)", sc->geom->name,
1296                     index+1,
1297                     sc->n_components,
1298                     sc->components[index].gcons->provider->name);
1299         }
1300         sc->curr_component = index;
1301
1302         if (sc->components[index].chunk_next >=
1303             sc->components[index].chunk_count - g_virstor_chunk_watermark) {
1304                 LOG_MSG(LVL_WARNING,
1305                     "Component %s of %s is running out of free space "
1306                     "(%u chunks left)",
1307                     sc->components[index].gcons->provider->name,
1308                     sc->geom->name, sc->components[index].chunk_count -
1309                     sc->components[index].chunk_next);
1310         }
1311
1312         sc->me_per_sector = sc->sectorsize / sizeof *(sc->map);
1313         if (sc->sectorsize % sizeof *(sc->map) != 0) {
1314                 LOG_MSG(LVL_ERROR,
1315                     "%s: Map entries don't fit exactly in a sector (%s)",
1316                     __func__, sc->geom->name);
1317                 return;
1318         }
1319
1320         /* Recalculate allocated chunks in components & at the same time
1321          * verify map data is sane. We could trust metadata on this, but
1322          * we want to make sure. */
1323         for (n = 0; n < sc->n_components; n++)
1324                 sc->components[n].chunk_next = sc->components[n].chunk_reserved;
1325
1326         for (n = 0; n < sc->chunk_count; n++) {
1327                 if (sc->map[n].provider_no >= sc->n_components ||
1328                         sc->map[n].provider_chunk >=
1329                         sc->components[sc->map[n].provider_no].chunk_count) {
1330                         LOG_MSG(LVL_ERROR, "%s: Invalid entry %u in map for %s",
1331                             __func__, (u_int)n, sc->geom->name);
1332                         LOG_MSG(LVL_ERROR, "%s: provider_no: %u, n_components: %u"
1333                             " provider_chunk: %u, chunk_count: %u", __func__,
1334                             sc->map[n].provider_no, sc->n_components,
1335                             sc->map[n].provider_chunk,
1336                             sc->components[sc->map[n].provider_no].chunk_count);
1337                         return;
1338                 }
1339                 if (sc->map[n].flags & VIRSTOR_MAP_ALLOCATED)
1340                         sc->components[sc->map[n].provider_no].chunk_next++;
1341         }
1342
1343         sc->provider = g_new_providerf(sc->geom, "virstor/%s",
1344             sc->geom->name);
1345
1346         sc->provider->sectorsize = sc->sectorsize;
1347         sc->provider->mediasize = sc->virsize;
1348         g_error_provider(sc->provider, 0);
1349
1350         LOG_MSG(LVL_INFO, "%s activated", sc->provider->name);
1351         LOG_MSG(LVL_DEBUG, "%s starting with current component %u, starting "
1352             "chunk %u", sc->provider->name, sc->curr_component,
1353             sc->components[sc->curr_component].chunk_next);
1354 }
1355
1356 /*
1357  * Returns count of active providers in this geom instance
1358  */
1359 static u_int
1360 virstor_valid_components(struct g_virstor_softc *sc)
1361 {
1362         unsigned int nc, i;
1363
1364         nc = 0;
1365         KASSERT(sc != NULL, ("%s: softc is NULL", __func__));
1366         KASSERT(sc->components != NULL, ("%s: sc->components is NULL", __func__));
1367         for (i = 0; i < sc->n_components; i++)
1368                 if (sc->components[i].gcons != NULL)
1369                         nc++;
1370         return (nc);
1371 }
1372
1373 /*
1374  * Called when the consumer gets orphaned (?)
1375  */
1376 static void
1377 g_virstor_orphan(struct g_consumer *cp)
1378 {
1379         struct g_virstor_softc *sc;
1380         struct g_virstor_component *comp;
1381         struct g_geom *gp;
1382
1383         g_topology_assert();
1384         gp = cp->geom;
1385         sc = gp->softc;
1386         if (sc == NULL)
1387                 return;
1388
1389         comp = cp->private;
1390         KASSERT(comp != NULL, ("%s: No component in private part of consumer",
1391             __func__));
1392         remove_component(sc, comp, FALSE);
1393         if (LIST_EMPTY(&gp->consumer))
1394                 virstor_geom_destroy(sc, TRUE, FALSE);
1395 }
1396
1397 /*
1398  * Called to notify geom when it's been opened, and for what intent
1399  */
1400 static int
1401 g_virstor_access(struct g_provider *pp, int dr, int dw, int de)
1402 {
1403         struct g_consumer *c, *c2, *tmp;
1404         struct g_virstor_softc *sc;
1405         struct g_geom *gp;
1406         int error;
1407
1408         KASSERT(pp != NULL, ("%s: NULL provider", __func__));
1409         gp = pp->geom;
1410         KASSERT(gp != NULL, ("%s: NULL geom", __func__));
1411         sc = gp->softc;
1412
1413         /* Grab an exclusive bit to propagate on our consumers on first open */
1414         if (pp->acr == 0 && pp->acw == 0 && pp->ace == 0)
1415                 de++;
1416         /* ... drop it on close */
1417         if (pp->acr + dr == 0 && pp->acw + dw == 0 && pp->ace + de == 0) {
1418                 de--;
1419                 if (sc != NULL)
1420                         update_metadata(sc);
1421         }
1422
1423         error = ENXIO;
1424         LIST_FOREACH_SAFE(c, &gp->consumer, consumer, tmp) {
1425                 error = g_access(c, dr, dw, de);
1426                 if (error != 0)
1427                         goto fail;
1428                 if (c->acr == 0 && c->acw == 0 && c->ace == 0 &&
1429                     c->flags & G_CF_ORPHAN) {
1430                         g_detach(c);
1431                         g_destroy_consumer(c);
1432                 }
1433         }
1434
1435         if (sc != NULL && LIST_EMPTY(&gp->consumer))
1436                 virstor_geom_destroy(sc, TRUE, FALSE);
1437
1438         return (error);
1439
1440 fail:
1441         /* Backout earlier changes */
1442         LIST_FOREACH(c2, &gp->consumer, consumer) {
1443                 if (c2 == c)
1444                         break;
1445                 g_access(c2, -dr, -dw, -de);
1446         }
1447         return (error);
1448 }
1449
1450 /*
1451  * Generate XML dump of current state
1452  */
1453 static void
1454 g_virstor_dumpconf(struct sbuf *sb, const char *indent, struct g_geom *gp,
1455     struct g_consumer *cp, struct g_provider *pp)
1456 {
1457         struct g_virstor_softc *sc;
1458
1459         g_topology_assert();
1460         sc = gp->softc;
1461
1462         if (sc == NULL || pp != NULL)
1463                 return;
1464
1465         if (cp != NULL) {
1466                 /* For each component */
1467                 struct g_virstor_component *comp;
1468
1469                 comp = cp->private;
1470                 if (comp == NULL)
1471                         return;
1472                 sbuf_printf(sb, "%s<ComponentIndex>%u</ComponentIndex>\n",
1473                     indent, comp->index);
1474                 sbuf_printf(sb, "%s<ChunkCount>%u</ChunkCount>\n",
1475                     indent, comp->chunk_count);
1476                 sbuf_printf(sb, "%s<ChunksUsed>%u</ChunksUsed>\n",
1477                     indent, comp->chunk_next);
1478                 sbuf_printf(sb, "%s<ChunksReserved>%u</ChunksReserved>\n",
1479                     indent, comp->chunk_reserved);
1480                 sbuf_printf(sb, "%s<StorageFree>%u%%</StorageFree>\n",
1481                     indent,
1482                     comp->chunk_next > 0 ? 100 -
1483                     ((comp->chunk_next + comp->chunk_reserved) * 100) /
1484                     comp->chunk_count : 100);
1485         } else {
1486                 /* For the whole thing */
1487                 u_int count, used, i;
1488                 off_t size;
1489
1490                 count = used = size = 0;
1491                 for (i = 0; i < sc->n_components; i++) {
1492                         if (sc->components[i].gcons != NULL) {
1493                                 count += sc->components[i].chunk_count;
1494                                 used += sc->components[i].chunk_next +
1495                                     sc->components[i].chunk_reserved;
1496                                 size += sc->components[i].gcons->
1497                                     provider->mediasize;
1498                         }
1499                 }
1500
1501                 sbuf_printf(sb, "%s<Status>"
1502                     "Components=%u, Online=%u</Status>\n", indent,
1503                     sc->n_components, virstor_valid_components(sc));
1504                 sbuf_printf(sb, "%s<State>%u%% physical free</State>\n",
1505                     indent, 100-(used * 100) / count);
1506                 sbuf_printf(sb, "%s<ChunkSize>%zu</ChunkSize>\n", indent,
1507                     sc->chunk_size);
1508                 sbuf_printf(sb, "%s<PhysicalFree>%u%%</PhysicalFree>\n",
1509                     indent, used > 0 ? 100 - (used * 100) / count : 100);
1510                 sbuf_printf(sb, "%s<ChunkPhysicalCount>%u</ChunkPhysicalCount>\n",
1511                     indent, count);
1512                 sbuf_printf(sb, "%s<ChunkVirtualCount>%zu</ChunkVirtualCount>\n",
1513                     indent, sc->chunk_count);
1514                 sbuf_printf(sb, "%s<PhysicalBacking>%zu%%</PhysicalBacking>\n",
1515                     indent,
1516                     (count * 100) / sc->chunk_count);
1517                 sbuf_printf(sb, "%s<PhysicalBackingSize>%jd</PhysicalBackingSize>\n",
1518                     indent, size);
1519                 sbuf_printf(sb, "%s<VirtualSize>%jd</VirtualSize>\n", indent,
1520                     sc->virsize);
1521         }
1522 }
1523
1524 /*
1525  * GEOM .done handler
1526  * Can't use standard handler because one requested IO may
1527  * fork into additional data IOs
1528  */
1529 static void
1530 g_virstor_done(struct bio *b)
1531 {
1532         struct bio *parent_b;
1533
1534         parent_b = b->bio_parent;
1535
1536         if (b->bio_error != 0) {
1537                 LOG_MSG(LVL_ERROR, "Error %d for offset=%ju, length=%ju, %s",
1538                     b->bio_error, b->bio_offset, b->bio_length,
1539                     b->bio_to->name);
1540                 if (parent_b->bio_error == 0)
1541                         parent_b->bio_error = b->bio_error;
1542         }
1543
1544         parent_b->bio_inbed++;
1545         parent_b->bio_completed += b->bio_completed;
1546
1547         if (parent_b->bio_children == parent_b->bio_inbed) {
1548                 parent_b->bio_completed = parent_b->bio_length;
1549                 g_io_deliver(parent_b, parent_b->bio_error);
1550         }
1551         g_destroy_bio(b);
1552 }
1553
1554 /*
1555  * I/O starts here
1556  * Called in g_down thread
1557  */
1558 static void
1559 g_virstor_start(struct bio *b)
1560 {
1561         struct g_virstor_softc *sc;
1562         struct g_virstor_component *comp;
1563         struct bio *cb;
1564         struct g_provider *pp;
1565         char *addr;
1566         off_t offset, length;
1567         struct bio_queue_head bq;
1568         size_t chunk_size;      /* cached for convenience */
1569         u_int count;
1570
1571         pp = b->bio_to;
1572         sc = pp->geom->softc;
1573         KASSERT(sc != NULL, ("%s: no softc (error=%d, device=%s)", __func__,
1574             b->bio_to->error, b->bio_to->name));
1575
1576         LOG_REQ(LVL_MOREDEBUG, b, "%s", __func__);
1577
1578         switch (b->bio_cmd) {
1579         case BIO_READ:
1580         case BIO_WRITE:
1581         case BIO_DELETE:
1582                 break;
1583         default:
1584                 g_io_deliver(b, EOPNOTSUPP);
1585                 return;
1586         }
1587
1588         LOG_MSG(LVL_DEBUG2, "BIO arrived, size=%ju", b->bio_length);
1589         bioq_init(&bq);
1590
1591         chunk_size = sc->chunk_size;
1592         addr = b->bio_data;
1593         offset = b->bio_offset; /* virtual offset and length */
1594         length = b->bio_length;
1595
1596         while (length > 0) {
1597                 size_t chunk_index, in_chunk_offset, in_chunk_length;
1598                 struct virstor_map_entry *me;
1599
1600                 chunk_index = offset / chunk_size; /* round downwards */
1601                 in_chunk_offset = offset % chunk_size;
1602                 in_chunk_length = min(length, chunk_size - in_chunk_offset);
1603                 LOG_MSG(LVL_DEBUG, "Mapped %s(%ju, %ju) to (%zu,%zu,%zu)",
1604                     b->bio_cmd == BIO_READ ? "R" : "W",
1605                     offset, length,
1606                     chunk_index, in_chunk_offset, in_chunk_length);
1607                 me = &sc->map[chunk_index];
1608
1609                 if (b->bio_cmd == BIO_READ || b->bio_cmd == BIO_DELETE) {
1610                         if ((me->flags & VIRSTOR_MAP_ALLOCATED) == 0) {
1611                                 /* Reads from unallocated chunks return zeroed
1612                                  * buffers */
1613                                 if (b->bio_cmd == BIO_READ)
1614                                         bzero(addr, in_chunk_length);
1615                         } else {
1616                                 comp = &sc->components[me->provider_no];
1617
1618                                 cb = g_clone_bio(b);
1619                                 if (cb == NULL) {
1620                                         bioq_dismantle(&bq);
1621                                         if (b->bio_error == 0)
1622                                                 b->bio_error = ENOMEM;
1623                                         g_io_deliver(b, b->bio_error);
1624                                         return;
1625                                 }
1626                                 cb->bio_to = comp->gcons->provider;
1627                                 cb->bio_done = g_virstor_done;
1628                                 cb->bio_offset =
1629                                     (off_t)me->provider_chunk * (off_t)chunk_size
1630                                     + in_chunk_offset;
1631                                 cb->bio_length = in_chunk_length;
1632                                 cb->bio_data = addr;
1633                                 cb->bio_caller1 = comp;
1634                                 bioq_disksort(&bq, cb);
1635                         }
1636                 } else { /* handle BIO_WRITE */
1637                         KASSERT(b->bio_cmd == BIO_WRITE,
1638                             ("%s: Unknown command %d", __func__,
1639                             b->bio_cmd));
1640
1641                         if ((me->flags & VIRSTOR_MAP_ALLOCATED) == 0) {
1642                                 /* We have a virtual chunk, represented by
1643                                  * the "me" entry, but it's not yet allocated
1644                                  * (tied to) a physical chunk. So do it now. */
1645                                 struct virstor_map_entry *data_me;
1646                                 u_int phys_chunk, comp_no;
1647                                 off_t s_offset;
1648                                 int error;
1649
1650                                 error = allocate_chunk(sc, &comp, &comp_no,
1651                                     &phys_chunk);
1652                                 if (error != 0) {
1653                                         /* We cannot allocate a physical chunk
1654                                          * to satisfy this request, so we'll
1655                                          * delay it to when we can...
1656                                          * XXX: this will prevent the fs from
1657                                          * being umounted! */
1658                                         struct g_virstor_bio_q *biq;
1659                                         biq = malloc(sizeof *biq, M_GVIRSTOR,
1660                                             M_NOWAIT);
1661                                         if (biq == NULL) {
1662                                                 bioq_dismantle(&bq);
1663                                                 if (b->bio_error == 0)
1664                                                         b->bio_error = ENOMEM;
1665                                                 g_io_deliver(b, b->bio_error);
1666                                                 return;
1667                                         }
1668                                         biq->bio = b;
1669                                         mtx_lock(&sc->delayed_bio_q_mtx);
1670                                         STAILQ_INSERT_TAIL(&sc->delayed_bio_q,
1671                                             biq, linkage);
1672                                         mtx_unlock(&sc->delayed_bio_q_mtx);
1673                                         LOG_MSG(LVL_WARNING, "Delaying BIO "
1674                                             "(size=%ju) until free physical "
1675                                             "space can be found on %s",
1676                                             b->bio_length,
1677                                             sc->provider->name);
1678                                         return;
1679                                 }
1680                                 LOG_MSG(LVL_DEBUG, "Allocated chunk %u on %s "
1681                                     "for %s",
1682                                     phys_chunk,
1683                                     comp->gcons->provider->name,
1684                                     sc->provider->name);
1685
1686                                 me->provider_no = comp_no;
1687                                 me->provider_chunk = phys_chunk;
1688                                 me->flags |= VIRSTOR_MAP_ALLOCATED;
1689
1690                                 cb = g_clone_bio(b);
1691                                 if (cb == NULL) {
1692                                         me->flags &= ~VIRSTOR_MAP_ALLOCATED;
1693                                         me->provider_no = 0;
1694                                         me->provider_chunk = 0;
1695                                         bioq_dismantle(&bq);
1696                                         if (b->bio_error == 0)
1697                                                 b->bio_error = ENOMEM;
1698                                         g_io_deliver(b, b->bio_error);
1699                                         return;
1700                                 }
1701
1702                                 /* The allocation table is stored continuously
1703                                  * at the start of the drive. We need to
1704                                  * calculate the offset of the sector that holds
1705                                  * this map entry both on the drive and in the
1706                                  * map array.
1707                                  * sc_offset will end up pointing to the drive
1708                                  * sector. */
1709                                 s_offset = chunk_index * sizeof *me;
1710                                 s_offset = rounddown(s_offset, sc->sectorsize);
1711
1712                                 /* data_me points to map entry sector
1713                                  * in memory (analogous to offset) */
1714                                 data_me = &sc->map[rounddown(chunk_index,
1715                                     sc->me_per_sector)];
1716
1717                                 /* Commit sector with map entry to storage */
1718                                 cb->bio_to = sc->components[0].gcons->provider;
1719                                 cb->bio_done = g_virstor_done;
1720                                 cb->bio_offset = s_offset;
1721                                 cb->bio_data = (char *)data_me;
1722                                 cb->bio_length = sc->sectorsize;
1723                                 cb->bio_caller1 = &sc->components[0];
1724                                 bioq_disksort(&bq, cb);
1725                         }
1726
1727                         comp = &sc->components[me->provider_no];
1728                         cb = g_clone_bio(b);
1729                         if (cb == NULL) {
1730                                 bioq_dismantle(&bq);
1731                                 if (b->bio_error == 0)
1732                                         b->bio_error = ENOMEM;
1733                                 g_io_deliver(b, b->bio_error);
1734                                 return;
1735                         }
1736                         /* Finally, handle the data */
1737                         cb->bio_to = comp->gcons->provider;
1738                         cb->bio_done = g_virstor_done;
1739                         cb->bio_offset = (off_t)me->provider_chunk*(off_t)chunk_size +
1740                             in_chunk_offset;
1741                         cb->bio_length = in_chunk_length;
1742                         cb->bio_data = addr;
1743                         cb->bio_caller1 = comp;
1744                         bioq_disksort(&bq, cb);
1745                 }
1746                 addr += in_chunk_length;
1747                 length -= in_chunk_length;
1748                 offset += in_chunk_length;
1749         }
1750
1751         /* Fire off bio's here */
1752         count = 0;
1753         for (cb = bioq_first(&bq); cb != NULL; cb = bioq_first(&bq)) {
1754                 bioq_remove(&bq, cb);
1755                 LOG_REQ(LVL_MOREDEBUG, cb, "Firing request");
1756                 comp = cb->bio_caller1;
1757                 cb->bio_caller1 = NULL;
1758                 LOG_MSG(LVL_DEBUG, " firing bio, offset=%ju, length=%ju",
1759                     cb->bio_offset, cb->bio_length);
1760                 g_io_request(cb, comp->gcons);
1761                 count++;
1762         }
1763         if (count == 0) { /* We handled everything locally */
1764                 b->bio_completed = b->bio_length;
1765                 g_io_deliver(b, 0);
1766         }
1767
1768 }
1769
1770 /*
1771  * Allocate a chunk from a physical provider. Returns physical component,
1772  * chunk index relative to the component and the component's index.
1773  */
1774 static int
1775 allocate_chunk(struct g_virstor_softc *sc, struct g_virstor_component **comp,
1776     u_int *comp_no_p, u_int *chunk)
1777 {
1778         u_int comp_no;
1779
1780         KASSERT(sc->curr_component < sc->n_components,
1781             ("%s: Invalid curr_component: %u",  __func__, sc->curr_component));
1782
1783         comp_no = sc->curr_component;
1784         *comp = &sc->components[comp_no];
1785         dump_component(*comp);
1786         if ((*comp)->chunk_next >= (*comp)->chunk_count) {
1787                 /* This component is full. Allocate next component */
1788                 if (comp_no >= sc->n_components-1) {
1789                         LOG_MSG(LVL_ERROR, "All physical space allocated for %s",
1790                             sc->geom->name);
1791                         return (-1);
1792                 }
1793                 (*comp)->flags &= ~VIRSTOR_PROVIDER_CURRENT;
1794                 sc->curr_component = ++comp_no;
1795
1796                 *comp = &sc->components[comp_no];
1797                 if (comp_no >= sc->n_components - g_virstor_component_watermark-1)
1798                         LOG_MSG(LVL_WARNING, "Device %s running out of components "
1799                             "(switching to %u/%u: %s)", sc->geom->name,
1800                             comp_no+1, sc->n_components,
1801                             (*comp)->gcons->provider->name);
1802                 /* Take care not to overwrite reserved chunks */
1803                 if ( (*comp)->chunk_reserved > 0 &&
1804                     (*comp)->chunk_next < (*comp)->chunk_reserved)
1805                         (*comp)->chunk_next = (*comp)->chunk_reserved;
1806
1807                 (*comp)->flags |=
1808                     VIRSTOR_PROVIDER_ALLOCATED | VIRSTOR_PROVIDER_CURRENT;
1809                 dump_component(*comp);
1810                 *comp_no_p = comp_no;
1811                 *chunk = (*comp)->chunk_next++;
1812         } else {
1813                 *comp_no_p = comp_no;
1814                 *chunk = (*comp)->chunk_next++;
1815         }
1816         return (0);
1817 }
1818
1819 /* Dump a component */
1820 static void
1821 dump_component(struct g_virstor_component *comp)
1822 {
1823
1824         if (g_virstor_debug < LVL_DEBUG2)
1825                 return;
1826         printf("Component %d: %s\n", comp->index, comp->gcons->provider->name);
1827         printf("  chunk_count: %u\n", comp->chunk_count);
1828         printf("   chunk_next: %u\n", comp->chunk_next);
1829         printf("        flags: %u\n", comp->flags);
1830 }
1831
1832 #if 0
1833 /* Dump a map entry */
1834 static void
1835 dump_me(struct virstor_map_entry *me, unsigned int nr)
1836 {
1837         if (g_virstor_debug < LVL_DEBUG)
1838                 return;
1839         printf("VIRT. CHUNK #%d: ", nr);
1840         if ((me->flags & VIRSTOR_MAP_ALLOCATED) == 0)
1841                 printf("(unallocated)\n");
1842         else
1843                 printf("allocated at provider %u, provider_chunk %u\n",
1844                     me->provider_no, me->provider_chunk);
1845 }
1846 #endif
1847
1848 /*
1849  * Dismantle bio_queue and destroy its components
1850  */
1851 static void
1852 bioq_dismantle(struct bio_queue_head *bq)
1853 {
1854         struct bio *b;
1855
1856         for (b = bioq_first(bq); b != NULL; b = bioq_first(bq)) {
1857                 bioq_remove(bq, b);
1858                 g_destroy_bio(b);
1859         }
1860 }
1861
1862 /*
1863  * The function that shouldn't be called.
1864  * When this is called, the stack is already garbled because of
1865  * argument mismatch. There's nothing to do now but panic, which is
1866  * accidentally the whole purpose of this function.
1867  * Motivation: to guard from accidentally calling geom methods when
1868  * they shouldn't be called. (see g_..._taste)
1869  */
1870 static void
1871 invalid_call(void)
1872 {
1873         panic("invalid_call() has just been called. Something's fishy here.");
1874 }
1875
1876 DECLARE_GEOM_CLASS(g_virstor_class, g_virstor); /* Let there be light */
1877 MODULE_VERSION(geom_virstor, 0);