2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2010 Edward Tomasz Napierala <trasz@FreeBSD.org>
5 * Copyright (c) 2004-2006 Pawel Jakub Dawidek <pjd@FreeBSD.org>
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 #include <sys/cdefs.h>
31 __FBSDID("$FreeBSD$");
33 #include <sys/param.h>
34 #include <sys/systm.h>
35 #include <sys/kernel.h>
36 #include <sys/module.h>
38 #include <sys/mutex.h>
43 #include <sys/sysctl.h>
44 #include <sys/malloc.h>
45 #include <sys/eventhandler.h>
46 #include <geom/geom.h>
47 #include <geom/geom_dbg.h>
48 #include <geom/mountver/g_mountver.h>
50 SYSCTL_DECL(_kern_geom);
51 static SYSCTL_NODE(_kern_geom, OID_AUTO, mountver, CTLFLAG_RW | CTLFLAG_MPSAFE,
52 0, "GEOM_MOUNTVER stuff");
53 static u_int g_mountver_debug = 0;
54 static u_int g_mountver_check_ident = 1;
55 SYSCTL_UINT(_kern_geom_mountver, OID_AUTO, debug, CTLFLAG_RW,
56 &g_mountver_debug, 0, "Debug level");
57 SYSCTL_UINT(_kern_geom_mountver, OID_AUTO, check_ident, CTLFLAG_RW,
58 &g_mountver_check_ident, 0, "Check disk ident when reattaching");
60 static eventhandler_tag g_mountver_pre_sync = NULL;
62 static void g_mountver_queue(struct bio *bp);
63 static void g_mountver_orphan(struct g_consumer *cp);
64 static void g_mountver_resize(struct g_consumer *cp);
65 static int g_mountver_destroy(struct g_geom *gp, boolean_t force);
66 static g_taste_t g_mountver_taste;
67 static int g_mountver_destroy_geom(struct gctl_req *req, struct g_class *mp,
69 static void g_mountver_config(struct gctl_req *req, struct g_class *mp,
71 static void g_mountver_dumpconf(struct sbuf *sb, const char *indent,
72 struct g_geom *gp, struct g_consumer *cp, struct g_provider *pp);
73 static void g_mountver_init(struct g_class *mp);
74 static void g_mountver_fini(struct g_class *mp);
76 struct g_class g_mountver_class = {
77 .name = G_MOUNTVER_CLASS_NAME,
79 .ctlreq = g_mountver_config,
80 .taste = g_mountver_taste,
81 .destroy_geom = g_mountver_destroy_geom,
82 .init = g_mountver_init,
83 .fini = g_mountver_fini
87 g_mountver_detach(void *arg, int flags __unused)
89 struct g_consumer *cp = arg;
92 if (cp->acr > 0 || cp->acw > 0 || cp->ace > 0)
93 g_access(cp, -cp->acr, -cp->acw, -cp->ace);
98 g_mountver_done(struct bio *bp)
100 struct g_mountver_softc *sc;
102 struct g_consumer *cp;
107 if (bp->bio_error != ENXIO) {
113 * When the device goes away, it's possible that few requests
114 * will be completed with ENXIO before g_mountver_orphan()
115 * gets called. To work around that, we have to queue requests
116 * that failed with ENXIO, in order to send them later.
118 pbp = bp->bio_parent;
119 KASSERT(pbp->bio_to == LIST_FIRST(&gp->provider),
120 ("parent request was for someone else"));
123 g_mountver_queue(pbp);
127 mtx_lock(&sc->sc_mtx);
128 if (--cp->index == 0 && sc->sc_orphaned)
129 g_post_event(g_mountver_detach, cp, M_NOWAIT, NULL);
130 mtx_unlock(&sc->sc_mtx);
134 * Send the BIO down. The function is called with sc_mtx held to cover
135 * the race with orphan, but drops it before external calls.
138 g_mountver_send(struct g_geom *gp, struct bio *bp)
140 struct g_mountver_softc *sc = gp->softc;
141 struct g_consumer *cp;
144 mtx_assert(&sc->sc_mtx, MA_OWNED);
145 cbp = g_clone_bio(bp);
147 mtx_unlock(&sc->sc_mtx);
148 g_io_deliver(bp, ENOMEM);
151 cp = LIST_FIRST(&gp->consumer);
153 mtx_unlock(&sc->sc_mtx);
155 cbp->bio_done = g_mountver_done;
156 g_io_request(cbp, cp);
160 g_mountver_queue(struct bio *bp)
162 struct g_mountver_softc *sc;
165 gp = bp->bio_to->geom;
168 mtx_lock(&sc->sc_mtx);
169 TAILQ_INSERT_TAIL(&sc->sc_queue, bp, bio_queue);
170 mtx_unlock(&sc->sc_mtx);
174 g_mountver_send_queued(struct g_geom *gp)
176 struct g_mountver_softc *sc;
181 mtx_lock(&sc->sc_mtx);
182 while ((bp = TAILQ_FIRST(&sc->sc_queue)) != NULL && !sc->sc_orphaned) {
183 TAILQ_REMOVE(&sc->sc_queue, bp, bio_queue);
184 G_MOUNTVER_LOGREQ(bp, "Sending queued request.");
185 /* sc_mtx is dropped inside */
186 g_mountver_send(gp, bp);
187 mtx_lock(&sc->sc_mtx);
189 mtx_unlock(&sc->sc_mtx);
193 g_mountver_discard_queued(struct g_geom *gp)
195 struct g_mountver_softc *sc;
200 mtx_lock(&sc->sc_mtx);
201 while ((bp = TAILQ_FIRST(&sc->sc_queue)) != NULL) {
202 TAILQ_REMOVE(&sc->sc_queue, bp, bio_queue);
203 mtx_unlock(&sc->sc_mtx);
204 G_MOUNTVER_LOGREQ(bp, "Discarding queued request.");
205 g_io_deliver(bp, ENXIO);
206 mtx_lock(&sc->sc_mtx);
208 mtx_unlock(&sc->sc_mtx);
212 g_mountver_start(struct bio *bp)
214 struct g_mountver_softc *sc;
217 gp = bp->bio_to->geom;
219 G_MOUNTVER_LOGREQ(bp, "Request received.");
222 * It is possible that some bios were returned with ENXIO, even though
223 * orphaning didn't happen yet. In that case, queue all subsequent
224 * requests in order to maintain ordering.
226 mtx_lock(&sc->sc_mtx);
227 if (sc->sc_orphaned || !TAILQ_EMPTY(&sc->sc_queue)) {
228 mtx_unlock(&sc->sc_mtx);
229 if (sc->sc_shutting_down) {
230 G_MOUNTVER_LOGREQ(bp, "Discarding request due to shutdown.");
231 g_io_deliver(bp, ENXIO);
234 G_MOUNTVER_LOGREQ(bp, "Queueing request.");
235 g_mountver_queue(bp);
236 if (!sc->sc_orphaned)
237 g_mountver_send_queued(gp);
239 G_MOUNTVER_LOGREQ(bp, "Sending request.");
240 /* sc_mtx is dropped inside */
241 g_mountver_send(gp, bp);
246 g_mountver_access(struct g_provider *pp, int dr, int dw, int de)
248 struct g_mountver_softc *sc;
250 struct g_consumer *cp;
255 cp = LIST_FIRST(&gp->consumer);
257 if (sc == NULL && dr <= 0 && dw <= 0 && de <= 0)
259 KASSERT(sc != NULL, ("Trying to access withered provider \"%s\".", pp->name));
261 sc->sc_access_r += dr;
262 sc->sc_access_w += dw;
263 sc->sc_access_e += de;
268 return (g_access(cp, dr, dw, de));
272 g_mountver_create(struct gctl_req *req, struct g_class *mp, struct g_provider *pp)
274 struct g_mountver_softc *sc;
276 struct g_provider *newpp;
277 struct g_consumer *cp;
278 struct g_geom_alias *gap;
281 int identsize = DISK_IDENT_SIZE;
289 snprintf(name, sizeof(name), "%s%s", pp->name, G_MOUNTVER_SUFFIX);
290 LIST_FOREACH(gp, &mp->geom, geom) {
291 if (strcmp(gp->name, name) == 0) {
292 gctl_error(req, "Provider %s already exists.", name);
296 gp = g_new_geomf(mp, "%s", name);
297 sc = g_malloc(sizeof(*sc), M_WAITOK | M_ZERO);
298 mtx_init(&sc->sc_mtx, "gmountver", NULL, MTX_DEF | MTX_RECURSE);
299 TAILQ_INIT(&sc->sc_queue);
300 sc->sc_provider_name = strdup(pp->name, M_GEOM);
302 gp->start = g_mountver_start;
303 gp->orphan = g_mountver_orphan;
304 gp->resize = g_mountver_resize;
305 gp->access = g_mountver_access;
306 gp->dumpconf = g_mountver_dumpconf;
308 newpp = g_new_providerf(gp, "%s", gp->name);
309 newpp->mediasize = pp->mediasize;
310 newpp->sectorsize = pp->sectorsize;
311 newpp->flags |= G_PF_DIRECT_SEND | G_PF_DIRECT_RECEIVE;
312 LIST_FOREACH(gap, &pp->aliases, ga_next)
313 g_provider_add_alias(newpp, "%s%s", gap->ga_alias, G_MOUNTVER_SUFFIX);
315 if ((pp->flags & G_PF_ACCEPT_UNMAPPED) != 0) {
316 G_MOUNTVER_DEBUG(0, "Unmapped supported for %s.", gp->name);
317 newpp->flags |= G_PF_ACCEPT_UNMAPPED;
319 G_MOUNTVER_DEBUG(0, "Unmapped unsupported for %s.", gp->name);
320 newpp->flags &= ~G_PF_ACCEPT_UNMAPPED;
323 cp = g_new_consumer(gp);
324 cp->flags |= G_CF_DIRECT_SEND | G_CF_DIRECT_RECEIVE;
325 error = g_attach(cp, pp);
327 gctl_error(req, "Cannot attach to provider %s.", pp->name);
330 error = g_access(cp, 1, 0, 0);
332 gctl_error(req, "Cannot access provider %s.", pp->name);
335 error = g_io_getattr("GEOM::ident", cp, &identsize, sc->sc_ident);
336 g_access(cp, -1, 0, 0);
338 if (g_mountver_check_ident) {
339 gctl_error(req, "Cannot get disk ident from %s; error = %d.", pp->name, error);
343 G_MOUNTVER_DEBUG(0, "Cannot get disk ident from %s; error = %d.", pp->name, error);
344 sc->sc_ident[0] = '\0';
347 g_error_provider(newpp, 0);
348 G_MOUNTVER_DEBUG(0, "Device %s created.", gp->name);
351 g_free(sc->sc_provider_name);
352 if (cp->provider != NULL)
354 g_destroy_consumer(cp);
355 g_destroy_provider(newpp);
362 g_mountver_destroy(struct g_geom *gp, boolean_t force)
364 struct g_mountver_softc *sc;
365 struct g_provider *pp;
368 if (gp->softc == NULL)
371 pp = LIST_FIRST(&gp->provider);
372 if (pp != NULL && (pp->acr != 0 || pp->acw != 0 || pp->ace != 0)) {
374 G_MOUNTVER_DEBUG(0, "Device %s is still open, so it "
375 "can't be definitely removed.", pp->name);
377 G_MOUNTVER_DEBUG(1, "Device %s is still open (r%dw%de%d).",
378 pp->name, pp->acr, pp->acw, pp->ace);
382 G_MOUNTVER_DEBUG(0, "Device %s removed.", gp->name);
385 g_wither_provider(pp, ENXIO);
386 g_mountver_discard_queued(gp);
387 g_free(sc->sc_provider_name);
390 g_wither_geom(gp, ENXIO);
396 g_mountver_destroy_geom(struct gctl_req *req, struct g_class *mp, struct g_geom *gp)
399 return (g_mountver_destroy(gp, 0));
403 g_mountver_ctl_create(struct gctl_req *req, struct g_class *mp)
405 struct g_provider *pp;
411 nargs = gctl_get_paraml(req, "nargs", sizeof(*nargs));
413 gctl_error(req, "No '%s' argument", "nargs");
417 gctl_error(req, "Missing device(s).");
420 for (i = 0; i < *nargs; i++) {
421 snprintf(param, sizeof(param), "arg%d", i);
422 pp = gctl_get_provider(req, param);
425 if (g_mountver_create(req, mp, pp) != 0)
430 static struct g_geom *
431 g_mountver_find_geom(struct g_class *mp, const char *name)
435 LIST_FOREACH(gp, &mp->geom, geom) {
436 if (strcmp(gp->name, name) == 0)
443 g_mountver_ctl_destroy(struct gctl_req *req, struct g_class *mp)
445 int *nargs, *force, error, i;
452 nargs = gctl_get_paraml(req, "nargs", sizeof(*nargs));
454 gctl_error(req, "No '%s' argument", "nargs");
458 gctl_error(req, "Missing device(s).");
461 force = gctl_get_paraml(req, "force", sizeof(*force));
463 gctl_error(req, "No 'force' argument");
467 for (i = 0; i < *nargs; i++) {
468 snprintf(param, sizeof(param), "arg%d", i);
469 name = gctl_get_asciiparam(req, param);
471 gctl_error(req, "No 'arg%d' argument", i);
474 if (strncmp(name, _PATH_DEV, strlen(_PATH_DEV)) == 0)
475 name += strlen(_PATH_DEV);
476 gp = g_mountver_find_geom(mp, name);
478 G_MOUNTVER_DEBUG(1, "Device %s is invalid.", name);
479 gctl_error(req, "Device %s is invalid.", name);
482 error = g_mountver_destroy(gp, *force);
484 gctl_error(req, "Cannot destroy device %s (error=%d).",
492 g_mountver_orphan(struct g_consumer *cp)
494 struct g_mountver_softc *sc;
499 sc = cp->geom->softc;
500 mtx_lock(&sc->sc_mtx);
502 done = (cp->index == 0);
503 mtx_unlock(&sc->sc_mtx);
505 g_mountver_detach(cp, 0);
506 G_MOUNTVER_DEBUG(0, "%s is offline. Mount verification in progress.", sc->sc_provider_name);
510 g_mountver_resize(struct g_consumer *cp)
513 struct g_provider *pp;
517 LIST_FOREACH(pp, &gp->provider, provider)
518 g_resize_provider(pp, cp->provider->mediasize);
522 g_mountver_ident_matches(struct g_geom *gp)
524 struct g_consumer *cp;
525 struct g_mountver_softc *sc;
526 char ident[DISK_IDENT_SIZE];
527 int error, identsize = DISK_IDENT_SIZE;
530 cp = LIST_FIRST(&gp->consumer);
532 if (g_mountver_check_ident == 0)
535 error = g_access(cp, 1, 0, 0);
537 G_MOUNTVER_DEBUG(0, "Cannot access %s; "
538 "not attaching; error = %d.", gp->name, error);
541 error = g_io_getattr("GEOM::ident", cp, &identsize, ident);
542 g_access(cp, -1, 0, 0);
544 G_MOUNTVER_DEBUG(0, "Cannot get disk ident for %s; "
545 "not attaching; error = %d.", gp->name, error);
548 if (strcmp(ident, sc->sc_ident) != 0) {
549 G_MOUNTVER_DEBUG(1, "Disk ident for %s (\"%s\") is different "
550 "from expected \"%s\", not attaching.", gp->name, ident,
558 static struct g_geom *
559 g_mountver_taste(struct g_class *mp, struct g_provider *pp, int flags __unused)
561 struct g_mountver_softc *sc;
562 struct g_consumer *cp;
567 g_trace(G_T_TOPOLOGY, "%s(%s, %s)", __func__, mp->name, pp->name);
568 G_MOUNTVER_DEBUG(2, "Tasting %s.", pp->name);
571 * Let's check if device already exists.
573 LIST_FOREACH(gp, &mp->geom, geom) {
578 /* Already attached? */
579 if (pp == LIST_FIRST(&gp->provider))
582 if (sc->sc_orphaned && strcmp(pp->name, sc->sc_provider_name) == 0)
588 cp = LIST_FIRST(&gp->consumer);
590 error = g_mountver_ident_matches(gp);
595 if (sc->sc_access_r > 0 || sc->sc_access_w > 0 || sc->sc_access_e > 0) {
596 error = g_access(cp, sc->sc_access_r, sc->sc_access_w, sc->sc_access_e);
598 G_MOUNTVER_DEBUG(0, "Cannot access %s; error = %d.", pp->name, error);
604 g_mountver_send_queued(gp);
605 G_MOUNTVER_DEBUG(0, "%s has completed mount verification.", sc->sc_provider_name);
611 g_mountver_config(struct gctl_req *req, struct g_class *mp, const char *verb)
617 version = gctl_get_paraml(req, "version", sizeof(*version));
618 if (version == NULL) {
619 gctl_error(req, "No '%s' argument.", "version");
622 if (*version != G_MOUNTVER_VERSION) {
623 gctl_error(req, "Userland and kernel parts are out of sync.");
627 if (strcmp(verb, "create") == 0) {
628 g_mountver_ctl_create(req, mp);
630 } else if (strcmp(verb, "destroy") == 0) {
631 g_mountver_ctl_destroy(req, mp);
635 gctl_error(req, "Unknown verb.");
639 g_mountver_dumpconf(struct sbuf *sb, const char *indent, struct g_geom *gp,
640 struct g_consumer *cp, struct g_provider *pp)
642 struct g_mountver_softc *sc;
644 if (pp != NULL || cp != NULL)
648 sbuf_printf(sb, "%s<State>%s</State>\n", indent,
649 sc->sc_orphaned ? "OFFLINE" : "ONLINE");
650 sbuf_printf(sb, "%s<Provider-Name>%s</Provider-Name>\n", indent, sc->sc_provider_name);
651 sbuf_printf(sb, "%s<Disk-Ident>%s</Disk-Ident>\n", indent, sc->sc_ident);
655 g_mountver_shutdown_pre_sync(void *arg, int howto)
657 struct g_mountver_softc *sc;
659 struct g_geom *gp, *gp2;
663 LIST_FOREACH_SAFE(gp, &mp->geom, geom, gp2) {
664 if (gp->softc == NULL)
667 sc->sc_shutting_down = 1;
669 g_mountver_destroy(gp, 1);
675 g_mountver_init(struct g_class *mp)
678 g_mountver_pre_sync = EVENTHANDLER_REGISTER(shutdown_pre_sync,
679 g_mountver_shutdown_pre_sync, mp, SHUTDOWN_PRI_FIRST);
680 if (g_mountver_pre_sync == NULL)
681 G_MOUNTVER_DEBUG(0, "Warning! Cannot register shutdown event.");
685 g_mountver_fini(struct g_class *mp)
688 if (g_mountver_pre_sync != NULL)
689 EVENTHANDLER_DEREGISTER(shutdown_pre_sync, g_mountver_pre_sync);
692 DECLARE_GEOM_CLASS(g_mountver_class, g_mountver);
693 MODULE_VERSION(geom_mountver, 0);