2 * Copyright (c) 2004 Max Khon
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
30 #include <sys/param.h>
32 #include <sys/endian.h>
33 #include <sys/errno.h>
34 #include <sys/kernel.h>
36 #include <sys/mutex.h>
37 #include <sys/malloc.h>
38 #include <sys/systm.h>
40 #include <geom/geom.h>
43 #undef GEOM_UZIP_DEBUG
44 #ifdef GEOM_UZIP_DEBUG
45 #define DPRINTF(a) printf a
50 MALLOC_DEFINE(M_GEOM_UZIP, "geom_uzip", "GEOM UZIP data structures");
52 #define UZIP_CLASS_NAME "UZIP"
55 * Maximum allowed valid block size (to prevent foot-shooting)
57 #define MAX_BLKSZ (MAXPHYS - MAXPHYS / 1000 - 12)
60 * Integer values (block size, number of blocks, offsets)
61 * are stored in big-endian (network) order on disk and struct cloop_header
62 * and in native order in struct g_uzip_softc
65 #define CLOOP_MAGIC_LEN 128
66 static char CLOOP_MAGIC_START[] = "#!/bin/sh\n";
69 char magic[CLOOP_MAGIC_LEN]; /* cloop magic */
70 uint32_t blksz; /* block size */
71 uint32_t nblocks; /* number of blocks */
75 uint32_t blksz; /* block size */
76 uint32_t nblocks; /* number of blocks */
80 uint32_t last_blk; /* last blk no */
81 char *last_buf; /* last blk data */
82 int req_total; /* total requests */
83 int req_cached; /* cached requests */
87 g_uzip_softc_free(struct g_uzip_softc *sc, struct g_geom *gp)
90 printf("%s: %d requests, %d cached\n",
91 gp->name, sc->req_total, sc->req_cached);
93 if (sc->offsets != NULL)
94 free(sc->offsets, M_GEOM_UZIP);
95 mtx_destroy(&sc->last_mtx);
96 free(sc->last_buf, M_GEOM_UZIP);
97 free(sc, M_GEOM_UZIP);
101 z_alloc(void *nil, u_int type, u_int size)
105 ptr = malloc(type * size, M_GEOM_UZIP, M_NOWAIT);
110 z_free(void *nil, void *ptr)
112 free(ptr, M_GEOM_UZIP);
116 g_uzip_done(struct bio *bp)
121 struct g_provider *pp, *pp2;
122 struct g_consumer *cp;
124 struct g_uzip_softc *sc;
126 uint32_t start_blk, i;
129 bp2 = bp->bio_parent;
132 cp = LIST_FIRST(&gp->consumer);
135 DPRINTF(("%s: done\n", gp->name));
137 bp2->bio_error = bp->bio_error;
138 if (bp2->bio_error != 0)
146 err = inflateInit(&zs);
148 bp2->bio_error = EIO;
151 start_blk = bp2->bio_offset / sc->blksz;
152 bsize = pp2->sectorsize;
153 pos = sc->offsets[start_blk] % bsize;
155 DPRINTF(("%s: done: start_blk %d, pos %lld, upos %lld (%lld, %d, %d)\n",
156 gp->name, start_blk, pos, upos,
157 bp2->bio_offset, sc->blksz, bsize));
158 for (i = start_blk; upos < bp2->bio_length; i++) {
159 off_t len, ulen, uoff;
161 uoff = i == start_blk ? bp2->bio_offset % sc->blksz : 0;
162 ulen = MIN(sc->blksz - uoff, bp2->bio_length - upos);
163 len = sc->offsets[i + 1] - sc->offsets[i];
166 /* All zero block: no cache update */
167 bzero(bp2->bio_data + upos, ulen);
169 bp2->bio_completed += ulen;
172 zs.next_in = bp->bio_data + pos;
174 zs.next_out = sc->last_buf;
175 zs.avail_out = sc->blksz;
176 mtx_lock(&sc->last_mtx);
177 err = inflate(&zs, Z_FINISH);
178 if (err != Z_STREAM_END) {
180 mtx_unlock(&sc->last_mtx);
181 DPRINTF(("%s: done: inflate failed (%lld + %lld -> %lld + %lld + %lld)\n",
182 gp->name, pos, len, uoff, upos, ulen));
184 bp2->bio_error = EIO;
188 DPRINTF(("%s: done: inflated %lld + %lld -> %lld + %lld + %lld\n",
192 memcpy(bp2->bio_data + upos, sc->last_buf + uoff, ulen);
193 mtx_unlock(&sc->last_mtx);
197 bp2->bio_completed += ulen;
198 err = inflateReset(&zs);
201 bp2->bio_error = EIO;
205 err = inflateEnd(&zs);
207 bp2->bio_error = EIO;
213 * Finish processing the request.
215 DPRINTF(("%s: done: (%d, %lld, %ld)\n",
216 gp->name, bp2->bio_error, bp2->bio_completed, bp2->bio_resid));
217 free(bp->bio_data, M_GEOM_UZIP);
219 g_io_deliver(bp2, bp2->bio_error);
223 g_uzip_start(struct bio *bp)
226 struct g_provider *pp, *pp2;
228 struct g_consumer *cp;
229 struct g_uzip_softc *sc;
230 uint32_t start_blk, end_blk;
235 DPRINTF(("%s: start (%d)\n", gp->name, bp->bio_cmd));
237 if (bp->bio_cmd != BIO_READ) {
238 g_io_deliver(bp, EOPNOTSUPP);
242 cp = LIST_FIRST(&gp->consumer);
246 start_blk = bp->bio_offset / sc->blksz;
247 end_blk = (bp->bio_offset + bp->bio_length + sc->blksz - 1) / sc->blksz;
248 KASSERT(start_blk < sc->nblocks,
249 ("start_blk out of range"));
250 KASSERT(end_blk <= sc->nblocks,
251 ("end_blk out of range"));
254 if (start_blk + 1 == end_blk) {
255 mtx_lock(&sc->last_mtx);
256 if (start_blk == sc->last_blk) {
259 uoff = bp->bio_offset % sc->blksz;
260 KASSERT(bp->bio_length <= sc->blksz - uoff,
261 ("cached data error"));
262 memcpy(bp->bio_data, sc->last_buf + uoff,
265 mtx_unlock(&sc->last_mtx);
267 DPRINTF(("%s: start: cached 0 + %lld, %lld + 0 + %lld\n",
268 gp->name, bp->bio_length, uoff, bp->bio_length));
269 bp->bio_completed = bp->bio_length;
273 mtx_unlock(&sc->last_mtx);
276 bp2 = g_clone_bio(bp);
278 g_io_deliver(bp, ENOMEM);
281 bp2->bio_done = g_uzip_done;
282 DPRINTF(("%s: start (%d..%d), %s: %d + %lld, %s: %d + %lld\n",
283 gp->name, start_blk, end_blk,
284 pp->name, pp->sectorsize, pp->mediasize,
285 pp2->name, pp2->sectorsize, pp2->mediasize));
286 bsize = pp2->sectorsize;
287 bp2->bio_offset = sc->offsets[start_blk] - sc->offsets[start_blk] % bsize;
288 bp2->bio_length = sc->offsets[end_blk] - bp2->bio_offset;
289 bp2->bio_length = (bp2->bio_length + bsize - 1) / bsize * bsize;
290 DPRINTF(("%s: start %lld + %lld -> %lld + %lld -> %lld + %lld\n",
292 bp->bio_offset, bp->bio_length,
293 sc->offsets[start_blk], sc->offsets[end_blk] - sc->offsets[start_blk],
294 bp2->bio_offset, bp2->bio_length));
295 bp2->bio_data = malloc(bp2->bio_length, M_GEOM_UZIP, M_NOWAIT);
296 if (bp2->bio_data == NULL) {
298 g_io_deliver(bp, ENOMEM);
302 g_io_request(bp2, cp);
303 DPRINTF(("%s: start ok\n", gp->name));
307 g_uzip_orphan(struct g_consumer *cp)
311 g_trace(G_T_TOPOLOGY, "g_uzip_orphan(%p/%s)", cp, cp->provider->name);
313 KASSERT(cp->provider->error != 0,
314 ("g_uzip_orphan with error == 0"));
317 g_uzip_softc_free(gp->softc, gp);
319 g_wither_geom(gp, cp->provider->error);
323 g_uzip_access(struct g_provider *pp, int dr, int dw, int de)
326 struct g_consumer *cp;
329 cp = LIST_FIRST(&gp->consumer);
330 KASSERT (cp != NULL, ("g_uzip_access but no consumer"));
332 if (cp->acw + dw > 0)
335 return (g_access(cp, dr, dw, de));
339 g_uzip_spoiled(struct g_consumer *cp)
344 g_trace(G_T_TOPOLOGY, "g_uzip_spoiled(%p/%s)", cp, gp->name);
347 g_uzip_softc_free(gp->softc, gp);
349 g_wither_geom(gp, ENXIO);
352 static struct g_geom *
353 g_uzip_taste(struct g_class *mp, struct g_provider *pp, int flags)
356 uint32_t i, total_offsets, offsets_read, blk;
358 struct cloop_header *header;
359 struct g_consumer *cp;
361 struct g_provider *pp2;
362 struct g_uzip_softc *sc;
364 g_trace(G_T_TOPOLOGY, "g_uzip_taste(%s,%s)", mp->name, pp->name);
369 * Create geom instance.
371 gp = g_new_geomf(mp, "%s.uzip", pp->name);
372 cp = g_new_consumer(gp);
373 error = g_attach(cp, pp);
375 error = g_access(cp, 1, 0, 0);
378 g_destroy_consumer(cp);
385 * Read cloop header, look for CLOOP magic, perform
386 * other validity checks.
388 DPRINTF(("%s: media sectorsize %u, mediasize %lld\n",
389 gp->name, pp->sectorsize, pp->mediasize));
390 buf = g_read_data(cp, 0, pp->sectorsize, NULL);
393 header = (struct cloop_header *) buf;
394 if (strncmp(header->magic, CLOOP_MAGIC_START,
395 sizeof(CLOOP_MAGIC_START) - 1) != 0) {
396 DPRINTF(("%s: no CLOOP magic\n", gp->name));
399 if (header->magic[0x0b] != 'V' || header->magic[0x0c] < '2') {
400 DPRINTF(("%s: image version too old\n", gp->name));
405 * Initialize softc and read offsets.
407 sc = malloc(sizeof(*sc), M_GEOM_UZIP, M_WAITOK | M_ZERO);
409 sc->blksz = ntohl(header->blksz);
410 sc->nblocks = ntohl(header->nblocks);
411 if (sc->blksz % 512 != 0) {
412 printf("%s: block size (%u) should be multiple of 512.\n",
413 gp->name, sc->blksz);
416 if (sc->blksz > MAX_BLKSZ) {
417 printf("%s: block size (%u) should not be larger than %d.\n",
418 gp->name, sc->blksz, MAX_BLKSZ);
420 total_offsets = sc->nblocks + 1;
421 if (sizeof(struct cloop_header) +
422 total_offsets * sizeof(uint64_t) > pp->mediasize) {
423 printf("%s: media too small for %u blocks\n",
424 gp->name, sc->nblocks);
427 sc->offsets = malloc(
428 total_offsets * sizeof(uint64_t), M_GEOM_UZIP, M_WAITOK);
429 offsets_read = MIN(total_offsets,
430 (pp->sectorsize - sizeof(*header)) / sizeof(uint64_t));
431 for (i = 0; i < offsets_read; i++)
432 sc->offsets[i] = be64toh(((uint64_t *) (header + 1))[i]);
433 DPRINTF(("%s: %u offsets in the first sector\n",
434 gp->name, offsets_read));
435 for (blk = 1; offsets_read < total_offsets; blk++) {
440 cp, blk * pp->sectorsize, pp->sectorsize, NULL);
443 nread = MIN(total_offsets - offsets_read,
444 pp->sectorsize / sizeof(uint64_t));
445 DPRINTF(("%s: %u offsets read from sector %d\n",
446 gp->name, nread, blk));
447 for (i = 0; i < nread; i++) {
448 sc->offsets[offsets_read + i] =
449 be64toh(((uint64_t *) buf)[i]);
451 offsets_read += nread;
453 DPRINTF(("%s: done reading offsets\n", gp->name));
454 mtx_init(&sc->last_mtx, "geom_uzip cache", NULL, MTX_DEF);
456 sc->last_buf = malloc(sc->blksz, M_GEOM_UZIP, M_WAITOK);
461 pp2 = g_new_providerf(gp, "%s", gp->name);
462 pp2->sectorsize = 512;
463 pp2->mediasize = (off_t)sc->nblocks * sc->blksz;
464 pp2->flags = pp->flags & G_PF_CANDELETE;
465 if (pp->stripesize > 0) {
466 pp2->stripesize = pp->stripesize;
467 pp2->stripeoffset = pp->stripeoffset;
469 g_error_provider(pp2, 0);
470 g_access(cp, -1, 0, 0);
472 DPRINTF(("%s: taste ok (%d, %lld), (%d, %d), %x\n",
474 pp2->sectorsize, pp2->mediasize,
475 pp2->stripeoffset, pp2->stripesize, pp2->flags));
476 printf("%s: %u x %u blocks\n",
477 gp->name, sc->nblocks, sc->blksz);
482 g_access(cp, -1, 0, 0);
485 if (gp->softc != NULL) {
486 g_uzip_softc_free(gp->softc, NULL);
490 g_destroy_consumer(cp);
496 g_uzip_destroy_geom(struct gctl_req *req, struct g_class *mp, struct g_geom *gp)
498 struct g_provider *pp;
500 g_trace(G_T_TOPOLOGY, "g_uzip_destroy_geom(%s, %s)", mp->name, gp->name);
503 if (gp->softc == NULL) {
504 printf("%s(%s): gp->softc == NULL\n", __func__, gp->name);
508 KASSERT(gp != NULL, ("NULL geom"));
509 pp = LIST_FIRST(&gp->provider);
510 KASSERT(pp != NULL, ("NULL provider"));
511 if (pp->acr > 0 || pp->acw > 0 || pp->ace > 0)
514 g_uzip_softc_free(gp->softc, gp);
516 g_wither_geom(gp, ENXIO);
520 static struct g_class g_uzip_class = {
521 .name = UZIP_CLASS_NAME,
522 .version = G_VERSION,
523 .taste = g_uzip_taste,
524 .destroy_geom = g_uzip_destroy_geom,
526 .start = g_uzip_start,
527 .orphan = g_uzip_orphan,
528 .access = g_uzip_access,
529 .spoiled = g_uzip_spoiled,
532 DECLARE_GEOM_CLASS(g_uzip_class, g_uzip);
533 MODULE_DEPEND(g_uzip, zlib, 1, 1, 1);