2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2006 Ruslan Ermilov <ru@FreeBSD.org>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
32 #include <sys/param.h>
33 #include <sys/systm.h>
34 #include <sys/kernel.h>
35 #include <sys/module.h>
37 #include <sys/mutex.h>
39 #include <sys/sysctl.h>
40 #include <sys/malloc.h>
41 #include <sys/queue.h>
45 #include <geom/geom.h>
46 #include <geom/geom_dbg.h>
47 #include <geom/cache/g_cache.h>
49 FEATURE(geom_cache, "GEOM cache module");
51 static MALLOC_DEFINE(M_GCACHE, "gcache_data", "GEOM_CACHE Data");
53 SYSCTL_DECL(_kern_geom);
54 static SYSCTL_NODE(_kern_geom, OID_AUTO, cache, CTLFLAG_RW, 0,
56 static u_int g_cache_debug = 0;
57 SYSCTL_UINT(_kern_geom_cache, OID_AUTO, debug, CTLFLAG_RW, &g_cache_debug, 0,
59 static u_int g_cache_enable = 1;
60 SYSCTL_UINT(_kern_geom_cache, OID_AUTO, enable, CTLFLAG_RW, &g_cache_enable, 0,
62 static u_int g_cache_timeout = 10;
63 SYSCTL_UINT(_kern_geom_cache, OID_AUTO, timeout, CTLFLAG_RW, &g_cache_timeout,
65 static u_int g_cache_idletime = 5;
66 SYSCTL_UINT(_kern_geom_cache, OID_AUTO, idletime, CTLFLAG_RW, &g_cache_idletime,
68 static u_int g_cache_used_lo = 5;
69 static u_int g_cache_used_hi = 20;
71 sysctl_handle_pct(SYSCTL_HANDLER_ARGS)
73 u_int val = *(u_int *)arg1;
76 error = sysctl_handle_int(oidp, &val, 0, req);
77 if (error || !req->newptr)
81 if ((arg1 == &g_cache_used_lo && val > g_cache_used_hi) ||
82 (arg1 == &g_cache_used_hi && g_cache_used_lo > val))
87 SYSCTL_PROC(_kern_geom_cache, OID_AUTO, used_lo, CTLTYPE_UINT|CTLFLAG_RW,
88 &g_cache_used_lo, 0, sysctl_handle_pct, "IU", "");
89 SYSCTL_PROC(_kern_geom_cache, OID_AUTO, used_hi, CTLTYPE_UINT|CTLFLAG_RW,
90 &g_cache_used_hi, 0, sysctl_handle_pct, "IU", "");
93 static int g_cache_destroy(struct g_cache_softc *sc, boolean_t force);
94 static g_ctl_destroy_geom_t g_cache_destroy_geom;
96 static g_taste_t g_cache_taste;
97 static g_ctl_req_t g_cache_config;
98 static g_dumpconf_t g_cache_dumpconf;
100 struct g_class g_cache_class = {
101 .name = G_CACHE_CLASS_NAME,
102 .version = G_VERSION,
103 .ctlreq = g_cache_config,
104 .taste = g_cache_taste,
105 .destroy_geom = g_cache_destroy_geom
108 #define OFF2BNO(off, sc) ((off) >> (sc)->sc_bshift)
109 #define BNO2OFF(bno, sc) ((bno) << (sc)->sc_bshift)
112 static struct g_cache_desc *
113 g_cache_alloc(struct g_cache_softc *sc)
115 struct g_cache_desc *dp;
117 mtx_assert(&sc->sc_mtx, MA_OWNED);
119 if (!TAILQ_EMPTY(&sc->sc_usedlist)) {
120 dp = TAILQ_FIRST(&sc->sc_usedlist);
121 TAILQ_REMOVE(&sc->sc_usedlist, dp, d_used);
124 LIST_REMOVE(dp, d_next);
127 if (sc->sc_nent > sc->sc_maxent) {
131 dp = malloc(sizeof(*dp), M_GCACHE, M_NOWAIT | M_ZERO);
134 dp->d_data = uma_zalloc(sc->sc_zone, M_NOWAIT);
135 if (dp->d_data == NULL) {
144 g_cache_free(struct g_cache_softc *sc, struct g_cache_desc *dp)
147 mtx_assert(&sc->sc_mtx, MA_OWNED);
149 uma_zfree(sc->sc_zone, dp->d_data);
155 g_cache_free_used(struct g_cache_softc *sc)
157 struct g_cache_desc *dp;
160 mtx_assert(&sc->sc_mtx, MA_OWNED);
162 n = g_cache_used_lo * sc->sc_maxent / 100;
163 while (sc->sc_nused > n) {
164 KASSERT(!TAILQ_EMPTY(&sc->sc_usedlist), ("used list empty"));
165 dp = TAILQ_FIRST(&sc->sc_usedlist);
166 TAILQ_REMOVE(&sc->sc_usedlist, dp, d_used);
168 LIST_REMOVE(dp, d_next);
169 g_cache_free(sc, dp);
174 g_cache_deliver(struct g_cache_softc *sc, struct bio *bp,
175 struct g_cache_desc *dp, int error)
177 off_t off1, off, len;
179 mtx_assert(&sc->sc_mtx, MA_OWNED);
180 KASSERT(OFF2BNO(bp->bio_offset, sc) <= dp->d_bno, ("wrong entry"));
181 KASSERT(OFF2BNO(bp->bio_offset + bp->bio_length - 1, sc) >=
182 dp->d_bno, ("wrong entry"));
184 off1 = BNO2OFF(dp->d_bno, sc);
185 off = MAX(bp->bio_offset, off1);
186 len = MIN(bp->bio_offset + bp->bio_length, off1 + sc->sc_bsize) - off;
188 if (bp->bio_error == 0)
189 bp->bio_error = error;
190 if (bp->bio_error == 0) {
191 bcopy(dp->d_data + (off - off1),
192 bp->bio_data + (off - bp->bio_offset), len);
194 bp->bio_completed += len;
195 KASSERT(bp->bio_completed <= bp->bio_length, ("extra data"));
196 if (bp->bio_completed == bp->bio_length) {
197 if (bp->bio_error != 0)
198 bp->bio_completed = 0;
199 g_io_deliver(bp, bp->bio_error);
202 if (dp->d_flags & D_FLAG_USED) {
203 TAILQ_REMOVE(&sc->sc_usedlist, dp, d_used);
204 TAILQ_INSERT_TAIL(&sc->sc_usedlist, dp, d_used);
205 } else if (OFF2BNO(off + len, sc) > dp->d_bno) {
206 TAILQ_INSERT_TAIL(&sc->sc_usedlist, dp, d_used);
208 dp->d_flags |= D_FLAG_USED;
210 dp->d_atime = time_uptime;
214 g_cache_done(struct bio *bp)
216 struct g_cache_softc *sc;
217 struct g_cache_desc *dp;
218 struct bio *bp2, *tmpbp;
220 sc = bp->bio_from->geom->softc;
221 KASSERT(G_CACHE_DESC1(bp) == sc, ("corrupt bio_caller in g_cache_done()"));
222 dp = G_CACHE_DESC2(bp);
223 mtx_lock(&sc->sc_mtx);
225 while (bp2 != NULL) {
226 KASSERT(G_CACHE_NEXT_BIO1(bp2) == sc, ("corrupt bio_driver in g_cache_done()"));
227 tmpbp = G_CACHE_NEXT_BIO2(bp2);
228 g_cache_deliver(sc, bp2, dp, bp->bio_error);
231 dp->d_biolist = NULL;
232 if (dp->d_flags & D_FLAG_INVALID) {
234 g_cache_free(sc, dp);
235 } else if (bp->bio_error) {
236 LIST_REMOVE(dp, d_next);
237 if (dp->d_flags & D_FLAG_USED) {
238 TAILQ_REMOVE(&sc->sc_usedlist, dp, d_used);
241 g_cache_free(sc, dp);
243 mtx_unlock(&sc->sc_mtx);
247 static struct g_cache_desc *
248 g_cache_lookup(struct g_cache_softc *sc, off_t bno)
250 struct g_cache_desc *dp;
252 mtx_assert(&sc->sc_mtx, MA_OWNED);
254 LIST_FOREACH(dp, &sc->sc_desclist[G_CACHE_BUCKET(bno)], d_next)
255 if (dp->d_bno == bno)
261 g_cache_read(struct g_cache_softc *sc, struct bio *bp)
264 struct g_cache_desc *dp;
266 mtx_lock(&sc->sc_mtx);
267 dp = g_cache_lookup(sc,
268 OFF2BNO(bp->bio_offset + bp->bio_completed, sc));
270 /* Add to waiters list or deliver. */
272 if (dp->d_biolist != NULL) {
273 G_CACHE_NEXT_BIO1(bp) = sc;
274 G_CACHE_NEXT_BIO2(bp) = dp->d_biolist;
277 g_cache_deliver(sc, bp, dp, 0);
278 mtx_unlock(&sc->sc_mtx);
282 /* Cache miss. Allocate entry and schedule bio. */
283 sc->sc_cachemisses++;
284 dp = g_cache_alloc(sc);
286 mtx_unlock(&sc->sc_mtx);
289 cbp = g_clone_bio(bp);
291 g_cache_free(sc, dp);
292 mtx_unlock(&sc->sc_mtx);
296 dp->d_bno = OFF2BNO(bp->bio_offset + bp->bio_completed, sc);
297 G_CACHE_NEXT_BIO1(bp) = sc;
298 G_CACHE_NEXT_BIO2(bp) = NULL;
300 LIST_INSERT_HEAD(&sc->sc_desclist[G_CACHE_BUCKET(dp->d_bno)],
302 mtx_unlock(&sc->sc_mtx);
304 G_CACHE_DESC1(cbp) = sc;
305 G_CACHE_DESC2(cbp) = dp;
306 cbp->bio_done = g_cache_done;
307 cbp->bio_offset = BNO2OFF(dp->d_bno, sc);
308 cbp->bio_data = dp->d_data;
309 cbp->bio_length = sc->sc_bsize;
310 g_io_request(cbp, LIST_FIRST(&bp->bio_to->geom->consumer));
315 g_cache_invalidate(struct g_cache_softc *sc, struct bio *bp)
317 struct g_cache_desc *dp;
320 mtx_lock(&sc->sc_mtx);
321 bno = OFF2BNO(bp->bio_offset, sc);
322 lim = OFF2BNO(bp->bio_offset + bp->bio_length - 1, sc);
324 if ((dp = g_cache_lookup(sc, bno)) != NULL) {
325 LIST_REMOVE(dp, d_next);
326 if (dp->d_flags & D_FLAG_USED) {
327 TAILQ_REMOVE(&sc->sc_usedlist, dp, d_used);
330 if (dp->d_biolist == NULL)
331 g_cache_free(sc, dp);
333 dp->d_flags = D_FLAG_INVALID;
338 } while (bno <= lim);
339 mtx_unlock(&sc->sc_mtx);
343 g_cache_start(struct bio *bp)
345 struct g_cache_softc *sc;
347 struct g_cache_desc *dp;
350 gp = bp->bio_to->geom;
352 G_CACHE_LOGREQ(bp, "Request received.");
353 switch (bp->bio_cmd) {
356 sc->sc_readbytes += bp->bio_length;
359 if (bp->bio_offset + bp->bio_length > sc->sc_tail)
361 if (OFF2BNO(bp->bio_offset, sc) ==
362 OFF2BNO(bp->bio_offset + bp->bio_length - 1, sc)) {
364 sc->sc_cachereadbytes += bp->bio_length;
365 if (g_cache_read(sc, bp) == 0)
368 sc->sc_cachereadbytes -= bp->bio_length;
370 } else if (OFF2BNO(bp->bio_offset, sc) + 1 ==
371 OFF2BNO(bp->bio_offset + bp->bio_length - 1, sc)) {
372 mtx_lock(&sc->sc_mtx);
373 dp = g_cache_lookup(sc, OFF2BNO(bp->bio_offset, sc));
374 if (dp == NULL || dp->d_biolist != NULL) {
375 mtx_unlock(&sc->sc_mtx);
379 sc->sc_cachereadbytes += bp->bio_length;
380 g_cache_deliver(sc, bp, dp, 0);
381 mtx_unlock(&sc->sc_mtx);
382 if (g_cache_read(sc, bp) == 0)
385 sc->sc_cachereadbytes -= bp->bio_length;
391 sc->sc_wrotebytes += bp->bio_length;
392 g_cache_invalidate(sc, bp);
395 cbp = g_clone_bio(bp);
397 g_io_deliver(bp, ENOMEM);
400 cbp->bio_done = g_std_done;
401 G_CACHE_LOGREQ(cbp, "Sending request.");
402 g_io_request(cbp, LIST_FIRST(&gp->consumer));
406 g_cache_go(void *arg)
408 struct g_cache_softc *sc = arg;
409 struct g_cache_desc *dp;
412 mtx_assert(&sc->sc_mtx, MA_OWNED);
414 /* Forcibly mark idle ready entries as used. */
415 for (i = 0; i < G_CACHE_BUCKETS; i++) {
416 LIST_FOREACH(dp, &sc->sc_desclist[i], d_next) {
417 if (dp->d_flags & D_FLAG_USED ||
418 dp->d_biolist != NULL ||
419 time_uptime - dp->d_atime < g_cache_idletime)
421 TAILQ_INSERT_TAIL(&sc->sc_usedlist, dp, d_used);
423 dp->d_flags |= D_FLAG_USED;
427 /* Keep the number of used entries low. */
428 if (sc->sc_nused > g_cache_used_hi * sc->sc_maxent / 100)
429 g_cache_free_used(sc);
431 callout_reset(&sc->sc_callout, g_cache_timeout * hz, g_cache_go, sc);
435 g_cache_access(struct g_provider *pp, int dr, int dw, int de)
438 struct g_consumer *cp;
442 cp = LIST_FIRST(&gp->consumer);
443 error = g_access(cp, dr, dw, de);
449 g_cache_orphan(struct g_consumer *cp)
453 g_cache_destroy(cp->geom->softc, 1);
456 static struct g_cache_softc *
457 g_cache_find_device(struct g_class *mp, const char *name)
461 LIST_FOREACH(gp, &mp->geom, geom) {
462 if (strcmp(gp->name, name) == 0)
468 static struct g_geom *
469 g_cache_create(struct g_class *mp, struct g_provider *pp,
470 const struct g_cache_metadata *md, u_int type)
472 struct g_cache_softc *sc;
474 struct g_provider *newpp;
475 struct g_consumer *cp;
485 G_CACHE_DEBUG(1, "Creating device %s.", md->md_name);
487 /* Cache size is minimum 100. */
488 if (md->md_size < 100) {
489 G_CACHE_DEBUG(0, "Invalid size for device %s.", md->md_name);
493 /* Block size restrictions. */
494 bshift = ffs(md->md_bsize) - 1;
495 if (md->md_bsize == 0 || md->md_bsize > MAXPHYS ||
496 md->md_bsize != 1 << bshift ||
497 (md->md_bsize % pp->sectorsize) != 0) {
498 G_CACHE_DEBUG(0, "Invalid blocksize for provider %s.", pp->name);
502 /* Check for duplicate unit. */
503 if (g_cache_find_device(mp, (const char *)&md->md_name) != NULL) {
504 G_CACHE_DEBUG(0, "Provider %s already exists.", md->md_name);
508 gp = g_new_geomf(mp, "%s", md->md_name);
509 sc = g_malloc(sizeof(*sc), M_WAITOK | M_ZERO);
511 sc->sc_bshift = bshift;
512 sc->sc_bsize = 1 << bshift;
513 sc->sc_zone = uma_zcreate("gcache", sc->sc_bsize, NULL, NULL, NULL, NULL,
515 mtx_init(&sc->sc_mtx, "GEOM CACHE mutex", NULL, MTX_DEF);
516 for (i = 0; i < G_CACHE_BUCKETS; i++)
517 LIST_INIT(&sc->sc_desclist[i]);
518 TAILQ_INIT(&sc->sc_usedlist);
519 sc->sc_maxent = md->md_size;
520 callout_init_mtx(&sc->sc_callout, &sc->sc_mtx, 0);
523 gp->start = g_cache_start;
524 gp->orphan = g_cache_orphan;
525 gp->access = g_cache_access;
526 gp->dumpconf = g_cache_dumpconf;
528 newpp = g_new_providerf(gp, "cache/%s", gp->name);
529 newpp->sectorsize = pp->sectorsize;
530 newpp->mediasize = pp->mediasize;
531 if (type == G_CACHE_TYPE_AUTOMATIC)
532 newpp->mediasize -= pp->sectorsize;
533 sc->sc_tail = BNO2OFF(OFF2BNO(newpp->mediasize, sc), sc);
535 cp = g_new_consumer(gp);
536 if (g_attach(cp, pp) != 0) {
537 G_CACHE_DEBUG(0, "Cannot attach to provider %s.", pp->name);
538 g_destroy_consumer(cp);
539 g_destroy_provider(newpp);
540 mtx_destroy(&sc->sc_mtx);
546 g_error_provider(newpp, 0);
547 G_CACHE_DEBUG(0, "Device %s created.", gp->name);
548 callout_reset(&sc->sc_callout, g_cache_timeout * hz, g_cache_go, sc);
553 g_cache_destroy(struct g_cache_softc *sc, boolean_t force)
556 struct g_provider *pp;
557 struct g_cache_desc *dp, *dp2;
564 pp = LIST_FIRST(&gp->provider);
565 if (pp != NULL && (pp->acr != 0 || pp->acw != 0 || pp->ace != 0)) {
567 G_CACHE_DEBUG(0, "Device %s is still open, so it "
568 "can't be definitely removed.", pp->name);
570 G_CACHE_DEBUG(1, "Device %s is still open (r%dw%de%d).",
571 pp->name, pp->acr, pp->acw, pp->ace);
575 G_CACHE_DEBUG(0, "Device %s removed.", gp->name);
577 callout_drain(&sc->sc_callout);
578 mtx_lock(&sc->sc_mtx);
579 for (i = 0; i < G_CACHE_BUCKETS; i++) {
580 dp = LIST_FIRST(&sc->sc_desclist[i]);
582 dp2 = LIST_NEXT(dp, d_next);
583 g_cache_free(sc, dp);
587 mtx_unlock(&sc->sc_mtx);
588 mtx_destroy(&sc->sc_mtx);
589 uma_zdestroy(sc->sc_zone);
592 g_wither_geom(gp, ENXIO);
598 g_cache_destroy_geom(struct gctl_req *req, struct g_class *mp, struct g_geom *gp)
601 return (g_cache_destroy(gp->softc, 0));
605 g_cache_read_metadata(struct g_consumer *cp, struct g_cache_metadata *md)
607 struct g_provider *pp;
613 error = g_access(cp, 1, 0, 0);
618 buf = g_read_data(cp, pp->mediasize - pp->sectorsize, pp->sectorsize,
621 g_access(cp, -1, 0, 0);
625 /* Decode metadata. */
626 cache_metadata_decode(buf, md);
633 g_cache_write_metadata(struct g_consumer *cp, struct g_cache_metadata *md)
635 struct g_provider *pp;
641 error = g_access(cp, 0, 1, 0);
645 buf = malloc((size_t)pp->sectorsize, M_GCACHE, M_WAITOK | M_ZERO);
646 cache_metadata_encode(md, buf);
648 error = g_write_data(cp, pp->mediasize - pp->sectorsize, buf, pp->sectorsize);
650 g_access(cp, 0, -1, 0);
656 static struct g_geom *
657 g_cache_taste(struct g_class *mp, struct g_provider *pp, int flags __unused)
659 struct g_cache_metadata md;
660 struct g_consumer *cp;
664 g_trace(G_T_TOPOLOGY, "%s(%s, %s)", __func__, mp->name, pp->name);
667 G_CACHE_DEBUG(3, "Tasting %s.", pp->name);
669 gp = g_new_geomf(mp, "cache:taste");
670 gp->start = g_cache_start;
671 gp->orphan = g_cache_orphan;
672 gp->access = g_cache_access;
673 cp = g_new_consumer(gp);
675 error = g_cache_read_metadata(cp, &md);
677 g_destroy_consumer(cp);
682 if (strcmp(md.md_magic, G_CACHE_MAGIC) != 0)
684 if (md.md_version > G_CACHE_VERSION) {
685 printf("geom_cache.ko module is too old to handle %s.\n",
689 if (md.md_provsize != pp->mediasize)
692 gp = g_cache_create(mp, pp, &md, G_CACHE_TYPE_AUTOMATIC);
694 G_CACHE_DEBUG(0, "Can't create %s.", md.md_name);
701 g_cache_ctl_create(struct gctl_req *req, struct g_class *mp)
703 struct g_cache_metadata md;
704 struct g_provider *pp;
706 intmax_t *bsize, *size;
712 nargs = gctl_get_paraml(req, "nargs", sizeof(*nargs));
714 gctl_error(req, "No '%s' argument", "nargs");
718 gctl_error(req, "Invalid number of arguments.");
722 strlcpy(md.md_magic, G_CACHE_MAGIC, sizeof(md.md_magic));
723 md.md_version = G_CACHE_VERSION;
724 name = gctl_get_asciiparam(req, "arg0");
726 gctl_error(req, "No 'arg0' argument");
729 strlcpy(md.md_name, name, sizeof(md.md_name));
731 size = gctl_get_paraml(req, "size", sizeof(*size));
733 gctl_error(req, "No '%s' argument", "size");
736 if ((u_int)*size < 100) {
737 gctl_error(req, "Invalid '%s' argument", "size");
740 md.md_size = (u_int)*size;
742 bsize = gctl_get_paraml(req, "blocksize", sizeof(*bsize));
744 gctl_error(req, "No '%s' argument", "blocksize");
748 gctl_error(req, "Invalid '%s' argument", "blocksize");
751 md.md_bsize = (u_int)*bsize;
753 /* This field is not important here. */
756 name = gctl_get_asciiparam(req, "arg1");
758 gctl_error(req, "No 'arg1' argument");
761 if (strncmp(name, "/dev/", strlen("/dev/")) == 0)
762 name += strlen("/dev/");
763 pp = g_provider_by_name(name);
765 G_CACHE_DEBUG(1, "Provider %s is invalid.", name);
766 gctl_error(req, "Provider %s is invalid.", name);
769 gp = g_cache_create(mp, pp, &md, G_CACHE_TYPE_MANUAL);
771 gctl_error(req, "Can't create %s.", md.md_name);
777 g_cache_ctl_configure(struct gctl_req *req, struct g_class *mp)
779 struct g_cache_metadata md;
780 struct g_cache_softc *sc;
781 struct g_consumer *cp;
782 intmax_t *bsize, *size;
788 nargs = gctl_get_paraml(req, "nargs", sizeof(*nargs));
790 gctl_error(req, "No '%s' argument", "nargs");
794 gctl_error(req, "Missing device.");
798 name = gctl_get_asciiparam(req, "arg0");
800 gctl_error(req, "No 'arg0' argument");
803 sc = g_cache_find_device(mp, name);
805 G_CACHE_DEBUG(1, "Device %s is invalid.", name);
806 gctl_error(req, "Device %s is invalid.", name);
810 size = gctl_get_paraml(req, "size", sizeof(*size));
812 gctl_error(req, "No '%s' argument", "size");
815 if ((u_int)*size != 0 && (u_int)*size < 100) {
816 gctl_error(req, "Invalid '%s' argument", "size");
819 if ((u_int)*size != 0)
820 sc->sc_maxent = (u_int)*size;
822 bsize = gctl_get_paraml(req, "blocksize", sizeof(*bsize));
824 gctl_error(req, "No '%s' argument", "blocksize");
828 gctl_error(req, "Invalid '%s' argument", "blocksize");
832 if (sc->sc_type != G_CACHE_TYPE_AUTOMATIC)
835 strlcpy(md.md_name, name, sizeof(md.md_name));
836 strlcpy(md.md_magic, G_CACHE_MAGIC, sizeof(md.md_magic));
837 md.md_version = G_CACHE_VERSION;
838 if ((u_int)*size != 0)
839 md.md_size = (u_int)*size;
841 md.md_size = sc->sc_maxent;
842 if ((u_int)*bsize != 0)
843 md.md_bsize = (u_int)*bsize;
845 md.md_bsize = sc->sc_bsize;
846 cp = LIST_FIRST(&sc->sc_geom->consumer);
847 md.md_provsize = cp->provider->mediasize;
848 error = g_cache_write_metadata(cp, &md);
850 G_CACHE_DEBUG(2, "Metadata on %s updated.", cp->provider->name);
852 G_CACHE_DEBUG(0, "Cannot update metadata on %s (error=%d).",
853 cp->provider->name, error);
857 g_cache_ctl_destroy(struct gctl_req *req, struct g_class *mp)
859 int *nargs, *force, error, i;
860 struct g_cache_softc *sc;
866 nargs = gctl_get_paraml(req, "nargs", sizeof(*nargs));
868 gctl_error(req, "No '%s' argument", "nargs");
872 gctl_error(req, "Missing device(s).");
875 force = gctl_get_paraml(req, "force", sizeof(*force));
877 gctl_error(req, "No 'force' argument");
881 for (i = 0; i < *nargs; i++) {
882 snprintf(param, sizeof(param), "arg%d", i);
883 name = gctl_get_asciiparam(req, param);
885 gctl_error(req, "No 'arg%d' argument", i);
888 sc = g_cache_find_device(mp, name);
890 G_CACHE_DEBUG(1, "Device %s is invalid.", name);
891 gctl_error(req, "Device %s is invalid.", name);
894 error = g_cache_destroy(sc, *force);
896 gctl_error(req, "Cannot destroy device %s (error=%d).",
904 g_cache_ctl_reset(struct gctl_req *req, struct g_class *mp)
906 struct g_cache_softc *sc;
913 nargs = gctl_get_paraml(req, "nargs", sizeof(*nargs));
915 gctl_error(req, "No '%s' argument", "nargs");
919 gctl_error(req, "Missing device(s).");
923 for (i = 0; i < *nargs; i++) {
924 snprintf(param, sizeof(param), "arg%d", i);
925 name = gctl_get_asciiparam(req, param);
927 gctl_error(req, "No 'arg%d' argument", i);
930 sc = g_cache_find_device(mp, name);
932 G_CACHE_DEBUG(1, "Device %s is invalid.", name);
933 gctl_error(req, "Device %s is invalid.", name);
937 sc->sc_readbytes = 0;
938 sc->sc_cachereads = 0;
939 sc->sc_cachereadbytes = 0;
940 sc->sc_cachehits = 0;
941 sc->sc_cachemisses = 0;
942 sc->sc_cachefull = 0;
944 sc->sc_wrotebytes = 0;
949 g_cache_config(struct gctl_req *req, struct g_class *mp, const char *verb)
955 version = gctl_get_paraml(req, "version", sizeof(*version));
956 if (version == NULL) {
957 gctl_error(req, "No '%s' argument.", "version");
960 if (*version != G_CACHE_VERSION) {
961 gctl_error(req, "Userland and kernel parts are out of sync.");
965 if (strcmp(verb, "create") == 0) {
966 g_cache_ctl_create(req, mp);
968 } else if (strcmp(verb, "configure") == 0) {
969 g_cache_ctl_configure(req, mp);
971 } else if (strcmp(verb, "destroy") == 0 ||
972 strcmp(verb, "stop") == 0) {
973 g_cache_ctl_destroy(req, mp);
975 } else if (strcmp(verb, "reset") == 0) {
976 g_cache_ctl_reset(req, mp);
980 gctl_error(req, "Unknown verb.");
984 g_cache_dumpconf(struct sbuf *sb, const char *indent, struct g_geom *gp,
985 struct g_consumer *cp, struct g_provider *pp)
987 struct g_cache_softc *sc;
989 if (pp != NULL || cp != NULL)
992 sbuf_printf(sb, "%s<Size>%u</Size>\n", indent, sc->sc_maxent);
993 sbuf_printf(sb, "%s<BlockSize>%u</BlockSize>\n", indent, sc->sc_bsize);
994 sbuf_printf(sb, "%s<TailOffset>%ju</TailOffset>\n", indent,
995 (uintmax_t)sc->sc_tail);
996 sbuf_printf(sb, "%s<Entries>%u</Entries>\n", indent, sc->sc_nent);
997 sbuf_printf(sb, "%s<UsedEntries>%u</UsedEntries>\n", indent,
999 sbuf_printf(sb, "%s<InvalidEntries>%u</InvalidEntries>\n", indent,
1001 sbuf_printf(sb, "%s<Reads>%ju</Reads>\n", indent, sc->sc_reads);
1002 sbuf_printf(sb, "%s<ReadBytes>%ju</ReadBytes>\n", indent,
1004 sbuf_printf(sb, "%s<CacheReads>%ju</CacheReads>\n", indent,
1006 sbuf_printf(sb, "%s<CacheReadBytes>%ju</CacheReadBytes>\n", indent,
1007 sc->sc_cachereadbytes);
1008 sbuf_printf(sb, "%s<CacheHits>%ju</CacheHits>\n", indent,
1010 sbuf_printf(sb, "%s<CacheMisses>%ju</CacheMisses>\n", indent,
1011 sc->sc_cachemisses);
1012 sbuf_printf(sb, "%s<CacheFull>%ju</CacheFull>\n", indent,
1014 sbuf_printf(sb, "%s<Writes>%ju</Writes>\n", indent, sc->sc_writes);
1015 sbuf_printf(sb, "%s<WroteBytes>%ju</WroteBytes>\n", indent,
1019 DECLARE_GEOM_CLASS(g_cache_class, g_cache);
1020 MODULE_VERSION(geom_cache, 0);