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_orphan_t g_slice_orphan;
56 static g_access_t g_slice_access;
57 static g_start_t g_slice_start;
59 static struct g_slicer *
60 g_slice_alloc(unsigned nslice, unsigned scsize)
64 gsp = g_malloc(sizeof *gsp, M_WAITOK | M_ZERO);
66 gsp->softc = g_malloc(scsize, M_WAITOK | M_ZERO);
69 gsp->slices = g_malloc(nslice * sizeof(struct g_slice),
76 g_slice_free(struct g_slicer *gsp)
79 if (gsp == NULL) /* XXX: phk thinks about this */
82 if (gsp->hotspot != NULL)
84 if (gsp->softc != NULL)
90 g_slice_access(struct g_provider *pp, int dr, int dw, int de)
95 struct g_consumer *cp;
96 struct g_provider *pp2;
98 struct g_slice *gsl, *gsl2;
101 cp = LIST_FIRST(&gp->consumer);
102 KASSERT (cp != NULL, ("g_slice_access but no consumer"));
104 if (dr > 0 || dw > 0 || de > 0) {
105 gsl = &gsp->slices[pp->index];
106 for (u = 0; u < gsp->nslice; u++) {
107 gsl2 = &gsp->slices[u];
108 if (gsl2->length == 0)
112 if (gsl->offset + gsl->length <= gsl2->offset)
114 if (gsl2->offset + gsl2->length <= gsl->offset)
117 pp2 = gsl2->provider;
118 if ((pp->acw + dw) > 0 && pp2->ace > 0)
120 if ((pp->ace + de) > 0 && pp2->acw > 0)
124 /* On first open, grab an extra "exclusive" bit */
125 if (cp->acr == 0 && cp->acw == 0 && cp->ace == 0)
127 /* ... and let go of it on last close */
128 if ((cp->acr + dr) == 0 && (cp->acw + dw) == 0 && (cp->ace + de) == 1)
130 error = g_access(cp, dr, dw, de);
135 * XXX: It should be possible to specify here if we should finish all of the
136 * XXX: bio, or only the non-hot bits. This would get messy if there were
137 * XXX: two hot spots in the same bio, so for now we simply finish off the
138 * XXX: entire bio. Modifying hot data on the way to disk is frowned on
139 * XXX: so making that considerably harder is not a bad idea anyway.
142 g_slice_finish_hot(struct bio *bp)
146 struct g_consumer *cp;
147 struct g_slicer *gsp;
151 KASSERT(bp->bio_to != NULL,
152 ("NULL bio_to in g_slice_finish_hot(%p)", bp));
153 KASSERT(bp->bio_from != NULL,
154 ("NULL bio_from in g_slice_finish_hot(%p)", bp));
155 gp = bp->bio_to->geom;
157 cp = LIST_FIRST(&gp->consumer);
158 KASSERT(cp != NULL, ("NULL consumer in g_slice_finish_hot(%p)", bp));
159 idx = bp->bio_to->index;
160 gsl = &gsp->slices[idx];
162 bp2 = g_clone_bio(bp);
164 g_io_deliver(bp, ENOMEM);
167 if (bp2->bio_offset + bp2->bio_length > gsl->length)
168 bp2->bio_length = gsl->length - bp2->bio_offset;
169 bp2->bio_done = g_std_done;
170 bp2->bio_offset += gsl->offset;
171 g_io_request(bp2, cp);
176 g_slice_start(struct bio *bp)
179 struct g_provider *pp;
181 struct g_consumer *cp;
182 struct g_slicer *gsp;
184 struct g_slice_hot *ghp;
192 cp = LIST_FIRST(&gp->consumer);
194 gsl = &gsp->slices[idx];
195 switch(bp->bio_cmd) {
199 if (bp->bio_offset > gsl->length) {
200 g_io_deliver(bp, EINVAL); /* XXX: EWHAT ? */
204 * Check if we collide with any hot spaces, and call the
207 t = bp->bio_offset + gsl->offset;
208 for (m_index = 0; m_index < gsp->nhotspot; m_index++) {
209 ghp = &gsp->hotspot[m_index];
210 if (t >= ghp->offset + ghp->length)
212 if (t + bp->bio_length <= ghp->offset)
214 switch(bp->bio_cmd) {
215 case BIO_READ: idx = ghp->ract; break;
216 case BIO_WRITE: idx = ghp->wact; break;
217 case BIO_DELETE: idx = ghp->dact; break;
220 case G_SLICE_HOT_ALLOW:
221 /* Fall out and continue normal processing */
223 case G_SLICE_HOT_DENY:
224 g_io_deliver(bp, EROFS);
226 case G_SLICE_HOT_START:
227 error = gsp->start(bp);
228 if (error && error != EJUSTRETURN)
229 g_io_deliver(bp, error);
231 case G_SLICE_HOT_CALL:
232 error = g_post_event(gsp->hot, bp, M_NOWAIT,
235 g_io_deliver(bp, error);
240 bp2 = g_clone_bio(bp);
242 g_io_deliver(bp, ENOMEM);
245 if (bp2->bio_offset + bp2->bio_length > gsl->length)
246 bp2->bio_length = gsl->length - bp2->bio_offset;
247 bp2->bio_done = g_std_done;
248 bp2->bio_offset += gsl->offset;
249 g_io_request(bp2, cp);
252 /* Give the real method a chance to override */
253 if (gsp->start != NULL && gsp->start(bp))
255 if (!strcmp("GEOM::kerneldump", bp->bio_attribute)) {
256 struct g_kerneldump *gkd;
258 gkd = (struct g_kerneldump *)bp->bio_data;
259 gkd->offset += gsp->slices[idx].offset;
260 if (gkd->length > gsp->slices[idx].length)
261 gkd->length = gsp->slices[idx].length;
262 /* now, pass it on downwards... */
264 bp2 = g_clone_bio(bp);
266 g_io_deliver(bp, ENOMEM);
269 bp2->bio_done = g_std_done;
270 g_io_request(bp2, cp);
273 g_io_deliver(bp, EOPNOTSUPP);
279 g_slice_dumpconf(struct sbuf *sb, const char *indent, struct g_geom *gp, struct g_consumer *cp, struct g_provider *pp)
281 struct g_slicer *gsp;
284 if (indent == NULL) {
285 sbuf_printf(sb, " i %u", pp->index);
286 sbuf_printf(sb, " o %ju",
287 (uintmax_t)gsp->slices[pp->index].offset);
291 sbuf_printf(sb, "%s<index>%u</index>\n", indent, pp->index);
292 sbuf_printf(sb, "%s<length>%ju</length>\n",
293 indent, (uintmax_t)gsp->slices[pp->index].length);
294 sbuf_printf(sb, "%s<seclength>%ju</seclength>\n", indent,
295 (uintmax_t)gsp->slices[pp->index].length / 512);
296 sbuf_printf(sb, "%s<offset>%ju</offset>\n", indent,
297 (uintmax_t)gsp->slices[pp->index].offset);
298 sbuf_printf(sb, "%s<secoffset>%ju</secoffset>\n", indent,
299 (uintmax_t)gsp->slices[pp->index].offset / 512);
304 g_slice_config(struct g_geom *gp, u_int idx, int how, off_t offset, off_t length, u_int sectorsize, const char *fmt, ...)
306 struct g_provider *pp, *pp2;
307 struct g_slicer *gsp;
313 g_trace(G_T_TOPOLOGY, "g_slice_config(%s, %d, %d)",
317 if (idx >= gsp->nslice)
319 gsl = &gsp->slices[idx];
322 acc = pp->acr + pp->acw + pp->ace;
325 if (acc != 0 && how != G_SLICE_CONFIG_FORCE) {
326 if (length < gsl->length)
328 if (offset != gsl->offset)
331 /* XXX: check offset + length <= MEDIASIZE */
332 if (how == G_SLICE_CONFIG_CHECK)
334 gsl->length = length;
335 gsl->offset = offset;
336 gsl->sectorsize = sectorsize;
341 printf("GEOM: Deconfigure %s\n", pp->name);
342 g_orphan_provider(pp, ENXIO);
343 gsl->provider = NULL;
349 printf("GEOM: Reconfigure %s, start %jd length %jd end %jd\n",
350 pp->name, (intmax_t)offset, (intmax_t)length,
351 (intmax_t)(offset + length - 1));
352 pp->mediasize = gsl->length;
355 sb = sbuf_new(NULL, NULL, 0, SBUF_AUTOEXTEND);
357 sbuf_vprintf(sb, fmt, ap);
360 pp = g_new_providerf(gp, sbuf_data(sb));
361 pp2 = LIST_FIRST(&gp->consumer)->provider;
362 pp->flags = pp2->flags & G_PF_CANDELETE;
363 if (pp2->stripesize > 0) {
364 pp->stripesize = pp2->stripesize;
365 pp->stripeoffset = (pp2->stripeoffset + offset) % pp->stripesize;
367 if (0 && bootverbose)
368 printf("GEOM: Configure %s, start %jd length %jd end %jd\n",
369 pp->name, (intmax_t)offset, (intmax_t)length,
370 (intmax_t)(offset + length - 1));
372 pp->mediasize = gsl->length;
373 pp->sectorsize = gsl->sectorsize;
376 g_error_provider(pp, 0);
382 * Configure "hotspots". A hotspot is a piece of the parent device which
383 * this particular slicer cares about for some reason. Typically because
384 * it contains meta-data used to configure the slicer.
385 * A hotspot is identified by its index number. The offset and length are
386 * relative to the parent device, and the three "?act" fields specify
387 * what action to take on BIO_READ, BIO_DELETE and BIO_WRITE.
389 * XXX: There may be a race relative to g_slice_start() here, if an existing
390 * XXX: hotspot is changed wile I/O is happening. Should this become a problem
391 * XXX: we can protect the hotspot stuff with a mutex.
395 g_slice_conf_hot(struct g_geom *gp, u_int idx, off_t offset, off_t length, int ract, int dact, int wact)
397 struct g_slicer *gsp;
398 struct g_slice_hot *gsl, *gsl2;
400 g_trace(G_T_TOPOLOGY, "g_slice_conf_hot(%s, idx: %d, off: %jd, len: %jd)",
401 gp->name, idx, (intmax_t)offset, (intmax_t)length);
405 if(idx >= gsp->nhotspot) {
406 gsl2 = g_malloc((idx + 1) * sizeof *gsl2, M_WAITOK | M_ZERO);
407 if (gsp->hotspot != NULL)
408 bcopy(gsp->hotspot, gsl2, gsp->nhotspot * sizeof *gsl2);
410 if (gsp->hotspot != NULL)
413 gsp->nhotspot = idx + 1;
415 gsl[idx].offset = offset;
416 gsl[idx].length = length;
417 KASSERT(!((ract | dact | wact) & G_SLICE_HOT_START)
418 || gsp->start != NULL, ("G_SLICE_HOT_START but no slice->start"));
419 /* XXX: check that we _have_ a start function if HOT_START specified */
420 gsl[idx].ract = ract;
421 gsl[idx].dact = dact;
422 gsl[idx].wact = wact;
427 g_slice_spoiled(struct g_consumer *cp)
430 struct g_slicer *gsp;
434 g_trace(G_T_TOPOLOGY, "g_slice_spoiled(%p/%s)", cp, gp->name);
438 g_wither_geom(gp, ENXIO);
442 g_slice_destroy_geom(struct gctl_req *req, struct g_class *mp, struct g_geom *gp)
445 g_slice_spoiled(LIST_FIRST(&gp->consumer));
450 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)
453 struct g_slicer *gsp;
454 struct g_consumer *cp;
459 vp = (void **)extrap;
460 gp = g_new_geomf(mp, "%s", pp->name);
461 gsp = g_slice_alloc(slices, extra);
463 gp->access = g_slice_access;
464 gp->orphan = g_slice_orphan;
466 gp->start = g_slice_start;
467 gp->spoiled = g_slice_spoiled;
468 if (gp->dumpconf == NULL)
469 gp->dumpconf = g_slice_dumpconf;
470 if (gp->class->destroy_geom == NULL)
471 gp->class->destroy_geom = g_slice_destroy_geom;
472 cp = g_new_consumer(gp);
473 error = g_attach(cp, pp);
475 error = g_access(cp, 1, 0, 0);
477 g_wither_geom(gp, ENXIO);
487 g_slice_orphan(struct g_consumer *cp)
490 g_trace(G_T_TOPOLOGY, "g_slice_orphan(%p/%s)", cp, cp->provider->name);
492 KASSERT(cp->provider->error != 0,
493 ("g_slice_orphan with error == 0"));
495 /* XXX: Not good enough we leak the softc and its suballocations */
496 g_slice_free(cp->geom->softc);
497 g_wither_geom(cp->geom, cp->provider->error);