2 * Copyright (c) 2002 Poul-Henning Kamp
3 * Copyright (c) 2002 Networks Associates Technology, Inc.
6 * This software was developed for the FreeBSD Project by Poul-Henning Kamp
7 * and NAI Labs, the Security Research Division of Network Associates, Inc.
8 * under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the
9 * DARPA CHATS research program.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 * 3. The names of the authors may not be used to endorse or promote
20 * products derived from this software without specific prior written
23 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36 #include <sys/cdefs.h>
37 __FBSDID("$FreeBSD$");
39 #include <sys/param.h>
40 #include <sys/systm.h>
41 #include <sys/kernel.h>
42 #include <sys/malloc.h>
44 #include <sys/sysctl.h>
46 #include <sys/kthread.h>
48 #include <sys/mutex.h>
49 #include <sys/errno.h>
51 #include <geom/geom.h>
52 #include <geom/geom_slice.h>
53 #include <machine/stdarg.h>
55 static g_access_t g_slice_access;
56 static g_start_t g_slice_start;
58 static struct g_slicer *
59 g_slice_alloc(unsigned nslice, unsigned scsize)
63 gsp = g_malloc(sizeof *gsp, M_WAITOK | M_ZERO);
65 gsp->softc = g_malloc(scsize, M_WAITOK | M_ZERO);
68 gsp->slices = g_malloc(nslice * sizeof(struct g_slice),
75 g_slice_free(struct g_slicer *gsp)
78 if (gsp == NULL) /* XXX: phk thinks about this */
81 if (gsp->hotspot != NULL)
83 if (gsp->softc != NULL)
89 g_slice_access(struct g_provider *pp, int dr, int dw, int de)
94 struct g_consumer *cp;
95 struct g_provider *pp2;
97 struct g_slice *gsl, *gsl2;
100 cp = LIST_FIRST(&gp->consumer);
101 KASSERT (cp != NULL, ("g_slice_access but no consumer"));
103 if (dr > 0 || dw > 0 || de > 0) {
104 gsl = &gsp->slices[pp->index];
105 for (u = 0; u < gsp->nslice; u++) {
106 gsl2 = &gsp->slices[u];
107 if (gsl2->length == 0)
111 if (gsl->offset + gsl->length <= gsl2->offset)
113 if (gsl2->offset + gsl2->length <= gsl->offset)
116 pp2 = gsl2->provider;
117 if ((pp->acw + dw) > 0 && pp2->ace > 0)
119 if ((pp->ace + de) > 0 && pp2->acw > 0)
123 /* On first open, grab an extra "exclusive" bit */
124 if (cp->acr == 0 && cp->acw == 0 && cp->ace == 0)
126 /* ... and let go of it on last close */
127 if ((cp->acr + dr) == 0 && (cp->acw + dw) == 0 && (cp->ace + de) == 1)
129 error = g_access(cp, dr, dw, de);
134 * XXX: It should be possible to specify here if we should finish all of the
135 * XXX: bio, or only the non-hot bits. This would get messy if there were
136 * XXX: two hot spots in the same bio, so for now we simply finish off the
137 * XXX: entire bio. Modifying hot data on the way to disk is frowned on
138 * XXX: so making that considerably harder is not a bad idea anyway.
141 g_slice_finish_hot(struct bio *bp)
145 struct g_consumer *cp;
146 struct g_slicer *gsp;
150 KASSERT(bp->bio_to != NULL,
151 ("NULL bio_to in g_slice_finish_hot(%p)", bp));
152 KASSERT(bp->bio_from != NULL,
153 ("NULL bio_from in g_slice_finish_hot(%p)", bp));
154 gp = bp->bio_to->geom;
156 cp = LIST_FIRST(&gp->consumer);
157 KASSERT(cp != NULL, ("NULL consumer in g_slice_finish_hot(%p)", bp));
158 idx = bp->bio_to->index;
159 gsl = &gsp->slices[idx];
161 bp2 = g_clone_bio(bp);
163 g_io_deliver(bp, ENOMEM);
166 if (bp2->bio_offset + bp2->bio_length > gsl->length)
167 bp2->bio_length = gsl->length - bp2->bio_offset;
168 bp2->bio_done = g_std_done;
169 bp2->bio_offset += gsl->offset;
170 g_io_request(bp2, cp);
175 g_slice_done(struct bio *bp)
178 KASSERT(bp->bio_cmd == BIO_GETATTR &&
179 strcmp(bp->bio_attribute, "GEOM::ident") == 0,
180 ("bio_cmd=0x%x bio_attribute=%s", bp->bio_cmd, bp->bio_attribute));
182 if (bp->bio_error == 0 && bp->bio_data[0] != '\0') {
185 /* Add index to the ident received. */
186 snprintf(idx, sizeof(idx), "s%d",
187 bp->bio_parent->bio_to->index);
188 if (strlcat(bp->bio_data, idx, bp->bio_length) >=
190 bp->bio_error = EFAULT;
197 g_slice_start(struct bio *bp)
200 struct g_provider *pp;
202 struct g_consumer *cp;
203 struct g_slicer *gsp;
205 struct g_slice_hot *ghp;
213 cp = LIST_FIRST(&gp->consumer);
215 gsl = &gsp->slices[idx];
216 switch(bp->bio_cmd) {
220 if (bp->bio_offset > gsl->length) {
221 g_io_deliver(bp, EINVAL); /* XXX: EWHAT ? */
225 * Check if we collide with any hot spaces, and call the
228 t = bp->bio_offset + gsl->offset;
229 for (m_index = 0; m_index < gsp->nhotspot; m_index++) {
230 ghp = &gsp->hotspot[m_index];
231 if (t >= ghp->offset + ghp->length)
233 if (t + bp->bio_length <= ghp->offset)
235 switch(bp->bio_cmd) {
236 case BIO_READ: idx = ghp->ract; break;
237 case BIO_WRITE: idx = ghp->wact; break;
238 case BIO_DELETE: idx = ghp->dact; break;
241 case G_SLICE_HOT_ALLOW:
242 /* Fall out and continue normal processing */
244 case G_SLICE_HOT_DENY:
245 g_io_deliver(bp, EROFS);
247 case G_SLICE_HOT_START:
248 error = gsp->start(bp);
249 if (error && error != EJUSTRETURN)
250 g_io_deliver(bp, error);
252 case G_SLICE_HOT_CALL:
253 error = g_post_event(gsp->hot, bp, M_NOWAIT,
256 g_io_deliver(bp, error);
261 bp2 = g_clone_bio(bp);
263 g_io_deliver(bp, ENOMEM);
266 if (bp2->bio_offset + bp2->bio_length > gsl->length)
267 bp2->bio_length = gsl->length - bp2->bio_offset;
268 bp2->bio_done = g_std_done;
269 bp2->bio_offset += gsl->offset;
270 g_io_request(bp2, cp);
273 /* Give the real method a chance to override */
274 if (gsp->start != NULL && gsp->start(bp))
276 if (!strcmp("GEOM::ident", bp->bio_attribute)) {
277 bp2 = g_clone_bio(bp);
279 g_io_deliver(bp, ENOMEM);
282 bp2->bio_done = g_slice_done;
283 g_io_request(bp2, cp);
286 if (!strcmp("GEOM::kerneldump", bp->bio_attribute)) {
287 struct g_kerneldump *gkd;
289 gkd = (struct g_kerneldump *)bp->bio_data;
290 gkd->offset += gsp->slices[idx].offset;
291 if (gkd->length > gsp->slices[idx].length)
292 gkd->length = gsp->slices[idx].length;
293 /* now, pass it on downwards... */
297 bp2 = g_clone_bio(bp);
299 g_io_deliver(bp, ENOMEM);
302 bp2->bio_done = g_std_done;
303 g_io_request(bp2, cp);
306 g_io_deliver(bp, EOPNOTSUPP);
312 g_slice_dumpconf(struct sbuf *sb, const char *indent, struct g_geom *gp, struct g_consumer *cp, struct g_provider *pp)
314 struct g_slicer *gsp;
317 if (indent == NULL) {
318 sbuf_printf(sb, " i %u", pp->index);
319 sbuf_printf(sb, " o %ju",
320 (uintmax_t)gsp->slices[pp->index].offset);
324 sbuf_printf(sb, "%s<index>%u</index>\n", indent, pp->index);
325 sbuf_printf(sb, "%s<length>%ju</length>\n",
326 indent, (uintmax_t)gsp->slices[pp->index].length);
327 sbuf_printf(sb, "%s<seclength>%ju</seclength>\n", indent,
328 (uintmax_t)gsp->slices[pp->index].length / 512);
329 sbuf_printf(sb, "%s<offset>%ju</offset>\n", indent,
330 (uintmax_t)gsp->slices[pp->index].offset);
331 sbuf_printf(sb, "%s<secoffset>%ju</secoffset>\n", indent,
332 (uintmax_t)gsp->slices[pp->index].offset / 512);
337 g_slice_config(struct g_geom *gp, u_int idx, int how, off_t offset, off_t length, u_int sectorsize, const char *fmt, ...)
339 struct g_provider *pp, *pp2;
340 struct g_slicer *gsp;
346 g_trace(G_T_TOPOLOGY, "g_slice_config(%s, %d, %d)",
350 if (idx >= gsp->nslice)
352 gsl = &gsp->slices[idx];
355 acc = pp->acr + pp->acw + pp->ace;
358 if (acc != 0 && how != G_SLICE_CONFIG_FORCE) {
359 if (length < gsl->length)
361 if (offset != gsl->offset)
364 /* XXX: check offset + length <= MEDIASIZE */
365 if (how == G_SLICE_CONFIG_CHECK)
367 gsl->length = length;
368 gsl->offset = offset;
369 gsl->sectorsize = sectorsize;
374 printf("GEOM: Deconfigure %s\n", pp->name);
375 g_wither_provider(pp, ENXIO);
376 gsl->provider = NULL;
382 printf("GEOM: Reconfigure %s, start %jd length %jd end %jd\n",
383 pp->name, (intmax_t)offset, (intmax_t)length,
384 (intmax_t)(offset + length - 1));
385 pp->mediasize = gsl->length;
388 sb = sbuf_new_auto();
390 sbuf_vprintf(sb, fmt, ap);
393 pp = g_new_providerf(gp, sbuf_data(sb));
394 pp2 = LIST_FIRST(&gp->consumer)->provider;
395 pp->flags = pp2->flags & G_PF_CANDELETE;
396 pp->stripesize = pp2->stripesize;
397 pp->stripeoffset = pp2->stripeoffset + offset;
398 if (pp->stripesize > 0)
399 pp->stripeoffset %= pp->stripesize;
400 if (0 && bootverbose)
401 printf("GEOM: Configure %s, start %jd length %jd end %jd\n",
402 pp->name, (intmax_t)offset, (intmax_t)length,
403 (intmax_t)(offset + length - 1));
405 pp->mediasize = gsl->length;
406 pp->sectorsize = gsl->sectorsize;
409 g_error_provider(pp, 0);
415 * Configure "hotspots". A hotspot is a piece of the parent device which
416 * this particular slicer cares about for some reason. Typically because
417 * it contains meta-data used to configure the slicer.
418 * A hotspot is identified by its index number. The offset and length are
419 * relative to the parent device, and the three "?act" fields specify
420 * what action to take on BIO_READ, BIO_DELETE and BIO_WRITE.
422 * XXX: There may be a race relative to g_slice_start() here, if an existing
423 * XXX: hotspot is changed wile I/O is happening. Should this become a problem
424 * XXX: we can protect the hotspot stuff with a mutex.
428 g_slice_conf_hot(struct g_geom *gp, u_int idx, off_t offset, off_t length, int ract, int dact, int wact)
430 struct g_slicer *gsp;
431 struct g_slice_hot *gsl, *gsl2;
433 g_trace(G_T_TOPOLOGY, "g_slice_conf_hot(%s, idx: %d, off: %jd, len: %jd)",
434 gp->name, idx, (intmax_t)offset, (intmax_t)length);
438 if(idx >= gsp->nhotspot) {
439 gsl2 = g_malloc((idx + 1) * sizeof *gsl2, M_WAITOK | M_ZERO);
440 if (gsp->hotspot != NULL)
441 bcopy(gsp->hotspot, gsl2, gsp->nhotspot * sizeof *gsl2);
443 if (gsp->hotspot != NULL)
446 gsp->nhotspot = idx + 1;
448 gsl[idx].offset = offset;
449 gsl[idx].length = length;
450 KASSERT(!((ract | dact | wact) & G_SLICE_HOT_START)
451 || gsp->start != NULL, ("G_SLICE_HOT_START but no slice->start"));
452 /* XXX: check that we _have_ a start function if HOT_START specified */
453 gsl[idx].ract = ract;
454 gsl[idx].dact = dact;
455 gsl[idx].wact = wact;
460 g_slice_spoiled(struct g_consumer *cp)
463 struct g_slicer *gsp;
467 g_trace(G_T_TOPOLOGY, "g_slice_spoiled(%p/%s)", cp, gp->name);
471 g_wither_geom(gp, ENXIO);
475 g_slice_destroy_geom(struct gctl_req *req, struct g_class *mp, struct g_geom *gp)
478 g_slice_spoiled(LIST_FIRST(&gp->consumer));
483 g_slice_new(struct g_class *mp, u_int slices, struct g_provider *pp, struct g_consumer **cpp, void *extrap, int extra, g_slice_start_t *start)
486 struct g_slicer *gsp;
487 struct g_consumer *cp;
492 vp = (void **)extrap;
493 gp = g_new_geomf(mp, "%s", pp->name);
494 gsp = g_slice_alloc(slices, extra);
496 gp->access = g_slice_access;
497 gp->orphan = g_slice_orphan;
499 gp->start = g_slice_start;
500 gp->spoiled = g_slice_spoiled;
501 if (gp->dumpconf == NULL)
502 gp->dumpconf = g_slice_dumpconf;
503 if (gp->class->destroy_geom == NULL)
504 gp->class->destroy_geom = g_slice_destroy_geom;
505 cp = g_new_consumer(gp);
506 error = g_attach(cp, pp);
508 error = g_access(cp, 1, 0, 0);
510 g_wither_geom(gp, ENXIO);
520 g_slice_orphan(struct g_consumer *cp)
523 g_trace(G_T_TOPOLOGY, "g_slice_orphan(%p/%s)", cp, cp->provider->name);
525 KASSERT(cp->provider->error != 0,
526 ("g_slice_orphan with error == 0"));
528 /* XXX: Not good enough we leak the softc and its suballocations */
529 g_slice_free(cp->geom->softc);
530 g_wither_geom(cp->geom, cp->provider->error);