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 | CTLFLAG_MPSAFE, 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,
88 CTLTYPE_UINT | CTLFLAG_RW | CTLFLAG_NEEDGIANT, &g_cache_used_lo, 0,
89 sysctl_handle_pct, "IU",
91 SYSCTL_PROC(_kern_geom_cache, OID_AUTO, used_hi,
92 CTLTYPE_UINT | CTLFLAG_RW | CTLFLAG_NEEDGIANT, &g_cache_used_hi, 0,
93 sysctl_handle_pct, "IU",
96 static int g_cache_destroy(struct g_cache_softc *sc, boolean_t force);
97 static g_ctl_destroy_geom_t g_cache_destroy_geom;
99 static g_taste_t g_cache_taste;
100 static g_ctl_req_t g_cache_config;
101 static g_dumpconf_t g_cache_dumpconf;
103 struct g_class g_cache_class = {
104 .name = G_CACHE_CLASS_NAME,
105 .version = G_VERSION,
106 .ctlreq = g_cache_config,
107 .taste = g_cache_taste,
108 .destroy_geom = g_cache_destroy_geom
111 #define OFF2BNO(off, sc) ((off) >> (sc)->sc_bshift)
112 #define BNO2OFF(bno, sc) ((bno) << (sc)->sc_bshift)
114 static struct g_cache_desc *
115 g_cache_alloc(struct g_cache_softc *sc)
117 struct g_cache_desc *dp;
119 mtx_assert(&sc->sc_mtx, MA_OWNED);
121 if (!TAILQ_EMPTY(&sc->sc_usedlist)) {
122 dp = TAILQ_FIRST(&sc->sc_usedlist);
123 TAILQ_REMOVE(&sc->sc_usedlist, dp, d_used);
126 LIST_REMOVE(dp, d_next);
129 if (sc->sc_nent > sc->sc_maxent) {
133 dp = malloc(sizeof(*dp), M_GCACHE, M_NOWAIT | M_ZERO);
136 dp->d_data = uma_zalloc(sc->sc_zone, M_NOWAIT);
137 if (dp->d_data == NULL) {
146 g_cache_free(struct g_cache_softc *sc, struct g_cache_desc *dp)
149 mtx_assert(&sc->sc_mtx, MA_OWNED);
151 uma_zfree(sc->sc_zone, dp->d_data);
157 g_cache_free_used(struct g_cache_softc *sc)
159 struct g_cache_desc *dp;
162 mtx_assert(&sc->sc_mtx, MA_OWNED);
164 n = g_cache_used_lo * sc->sc_maxent / 100;
165 while (sc->sc_nused > n) {
166 KASSERT(!TAILQ_EMPTY(&sc->sc_usedlist), ("used list empty"));
167 dp = TAILQ_FIRST(&sc->sc_usedlist);
168 TAILQ_REMOVE(&sc->sc_usedlist, dp, d_used);
170 LIST_REMOVE(dp, d_next);
171 g_cache_free(sc, dp);
176 g_cache_deliver(struct g_cache_softc *sc, struct bio *bp,
177 struct g_cache_desc *dp, int error)
179 off_t off1, off, len;
181 mtx_assert(&sc->sc_mtx, MA_OWNED);
182 KASSERT(OFF2BNO(bp->bio_offset, sc) <= dp->d_bno, ("wrong entry"));
183 KASSERT(OFF2BNO(bp->bio_offset + bp->bio_length - 1, sc) >=
184 dp->d_bno, ("wrong entry"));
186 off1 = BNO2OFF(dp->d_bno, sc);
187 off = MAX(bp->bio_offset, off1);
188 len = MIN(bp->bio_offset + bp->bio_length, off1 + sc->sc_bsize) - off;
190 if (bp->bio_error == 0)
191 bp->bio_error = error;
192 if (bp->bio_error == 0) {
193 bcopy(dp->d_data + (off - off1),
194 bp->bio_data + (off - bp->bio_offset), len);
196 bp->bio_completed += len;
197 KASSERT(bp->bio_completed <= bp->bio_length, ("extra data"));
198 if (bp->bio_completed == bp->bio_length) {
199 if (bp->bio_error != 0)
200 bp->bio_completed = 0;
201 g_io_deliver(bp, bp->bio_error);
204 if (dp->d_flags & D_FLAG_USED) {
205 TAILQ_REMOVE(&sc->sc_usedlist, dp, d_used);
206 TAILQ_INSERT_TAIL(&sc->sc_usedlist, dp, d_used);
207 } else if (OFF2BNO(off + len, sc) > dp->d_bno) {
208 TAILQ_INSERT_TAIL(&sc->sc_usedlist, dp, d_used);
210 dp->d_flags |= D_FLAG_USED;
212 dp->d_atime = time_uptime;
216 g_cache_done(struct bio *bp)
218 struct g_cache_softc *sc;
219 struct g_cache_desc *dp;
220 struct bio *bp2, *tmpbp;
222 sc = bp->bio_from->geom->softc;
223 KASSERT(G_CACHE_DESC1(bp) == sc, ("corrupt bio_caller in g_cache_done()"));
224 dp = G_CACHE_DESC2(bp);
225 mtx_lock(&sc->sc_mtx);
227 while (bp2 != NULL) {
228 KASSERT(G_CACHE_NEXT_BIO1(bp2) == sc, ("corrupt bio_driver in g_cache_done()"));
229 tmpbp = G_CACHE_NEXT_BIO2(bp2);
230 g_cache_deliver(sc, bp2, dp, bp->bio_error);
233 dp->d_biolist = NULL;
234 if (dp->d_flags & D_FLAG_INVALID) {
236 g_cache_free(sc, dp);
237 } else if (bp->bio_error) {
238 LIST_REMOVE(dp, d_next);
239 if (dp->d_flags & D_FLAG_USED) {
240 TAILQ_REMOVE(&sc->sc_usedlist, dp, d_used);
243 g_cache_free(sc, dp);
245 mtx_unlock(&sc->sc_mtx);
249 static struct g_cache_desc *
250 g_cache_lookup(struct g_cache_softc *sc, off_t bno)
252 struct g_cache_desc *dp;
254 mtx_assert(&sc->sc_mtx, MA_OWNED);
256 LIST_FOREACH(dp, &sc->sc_desclist[G_CACHE_BUCKET(bno)], d_next)
257 if (dp->d_bno == bno)
263 g_cache_read(struct g_cache_softc *sc, struct bio *bp)
266 struct g_cache_desc *dp;
268 mtx_lock(&sc->sc_mtx);
269 dp = g_cache_lookup(sc,
270 OFF2BNO(bp->bio_offset + bp->bio_completed, sc));
272 /* Add to waiters list or deliver. */
274 if (dp->d_biolist != NULL) {
275 G_CACHE_NEXT_BIO1(bp) = sc;
276 G_CACHE_NEXT_BIO2(bp) = dp->d_biolist;
279 g_cache_deliver(sc, bp, dp, 0);
280 mtx_unlock(&sc->sc_mtx);
284 /* Cache miss. Allocate entry and schedule bio. */
285 sc->sc_cachemisses++;
286 dp = g_cache_alloc(sc);
288 mtx_unlock(&sc->sc_mtx);
291 cbp = g_clone_bio(bp);
293 g_cache_free(sc, dp);
294 mtx_unlock(&sc->sc_mtx);
298 dp->d_bno = OFF2BNO(bp->bio_offset + bp->bio_completed, sc);
299 G_CACHE_NEXT_BIO1(bp) = sc;
300 G_CACHE_NEXT_BIO2(bp) = NULL;
302 LIST_INSERT_HEAD(&sc->sc_desclist[G_CACHE_BUCKET(dp->d_bno)],
304 mtx_unlock(&sc->sc_mtx);
306 G_CACHE_DESC1(cbp) = sc;
307 G_CACHE_DESC2(cbp) = dp;
308 cbp->bio_done = g_cache_done;
309 cbp->bio_offset = BNO2OFF(dp->d_bno, sc);
310 cbp->bio_data = dp->d_data;
311 cbp->bio_length = sc->sc_bsize;
312 g_io_request(cbp, LIST_FIRST(&bp->bio_to->geom->consumer));
317 g_cache_invalidate(struct g_cache_softc *sc, struct bio *bp)
319 struct g_cache_desc *dp;
322 mtx_lock(&sc->sc_mtx);
323 bno = OFF2BNO(bp->bio_offset, sc);
324 lim = OFF2BNO(bp->bio_offset + bp->bio_length - 1, sc);
326 if ((dp = g_cache_lookup(sc, bno)) != NULL) {
327 LIST_REMOVE(dp, d_next);
328 if (dp->d_flags & D_FLAG_USED) {
329 TAILQ_REMOVE(&sc->sc_usedlist, dp, d_used);
332 if (dp->d_biolist == NULL)
333 g_cache_free(sc, dp);
335 dp->d_flags = D_FLAG_INVALID;
340 } while (bno <= lim);
341 mtx_unlock(&sc->sc_mtx);
345 g_cache_start(struct bio *bp)
347 struct g_cache_softc *sc;
349 struct g_cache_desc *dp;
352 gp = bp->bio_to->geom;
354 G_CACHE_LOGREQ(bp, "Request received.");
355 switch (bp->bio_cmd) {
358 sc->sc_readbytes += bp->bio_length;
361 if (bp->bio_offset + bp->bio_length > sc->sc_tail)
363 if (OFF2BNO(bp->bio_offset, sc) ==
364 OFF2BNO(bp->bio_offset + bp->bio_length - 1, sc)) {
366 sc->sc_cachereadbytes += bp->bio_length;
367 if (g_cache_read(sc, bp) == 0)
370 sc->sc_cachereadbytes -= bp->bio_length;
372 } else if (OFF2BNO(bp->bio_offset, sc) + 1 ==
373 OFF2BNO(bp->bio_offset + bp->bio_length - 1, sc)) {
374 mtx_lock(&sc->sc_mtx);
375 dp = g_cache_lookup(sc, OFF2BNO(bp->bio_offset, sc));
376 if (dp == NULL || dp->d_biolist != NULL) {
377 mtx_unlock(&sc->sc_mtx);
381 sc->sc_cachereadbytes += bp->bio_length;
382 g_cache_deliver(sc, bp, dp, 0);
383 mtx_unlock(&sc->sc_mtx);
384 if (g_cache_read(sc, bp) == 0)
387 sc->sc_cachereadbytes -= bp->bio_length;
393 sc->sc_wrotebytes += bp->bio_length;
394 g_cache_invalidate(sc, bp);
397 cbp = g_clone_bio(bp);
399 g_io_deliver(bp, ENOMEM);
402 cbp->bio_done = g_std_done;
403 G_CACHE_LOGREQ(cbp, "Sending request.");
404 g_io_request(cbp, LIST_FIRST(&gp->consumer));
408 g_cache_go(void *arg)
410 struct g_cache_softc *sc = arg;
411 struct g_cache_desc *dp;
414 mtx_assert(&sc->sc_mtx, MA_OWNED);
416 /* Forcibly mark idle ready entries as used. */
417 for (i = 0; i < G_CACHE_BUCKETS; i++) {
418 LIST_FOREACH(dp, &sc->sc_desclist[i], d_next) {
419 if (dp->d_flags & D_FLAG_USED ||
420 dp->d_biolist != NULL ||
421 time_uptime - dp->d_atime < g_cache_idletime)
423 TAILQ_INSERT_TAIL(&sc->sc_usedlist, dp, d_used);
425 dp->d_flags |= D_FLAG_USED;
429 /* Keep the number of used entries low. */
430 if (sc->sc_nused > g_cache_used_hi * sc->sc_maxent / 100)
431 g_cache_free_used(sc);
433 callout_reset(&sc->sc_callout, g_cache_timeout * hz, g_cache_go, sc);
437 g_cache_access(struct g_provider *pp, int dr, int dw, int de)
440 struct g_consumer *cp;
444 cp = LIST_FIRST(&gp->consumer);
445 error = g_access(cp, dr, dw, de);
451 g_cache_orphan(struct g_consumer *cp)
455 g_cache_destroy(cp->geom->softc, 1);
458 static struct g_cache_softc *
459 g_cache_find_device(struct g_class *mp, const char *name)
463 LIST_FOREACH(gp, &mp->geom, geom) {
464 if (strcmp(gp->name, name) == 0)
470 static struct g_geom *
471 g_cache_create(struct g_class *mp, struct g_provider *pp,
472 const struct g_cache_metadata *md, u_int type)
474 struct g_cache_softc *sc;
476 struct g_provider *newpp;
477 struct g_consumer *cp;
487 G_CACHE_DEBUG(1, "Creating device %s.", md->md_name);
489 /* Cache size is minimum 100. */
490 if (md->md_size < 100) {
491 G_CACHE_DEBUG(0, "Invalid size for device %s.", md->md_name);
495 /* Block size restrictions. */
496 bshift = ffs(md->md_bsize) - 1;
497 if (md->md_bsize == 0 || md->md_bsize > maxphys ||
498 md->md_bsize != 1 << bshift ||
499 (md->md_bsize % pp->sectorsize) != 0) {
500 G_CACHE_DEBUG(0, "Invalid blocksize for provider %s.", pp->name);
504 /* Check for duplicate unit. */
505 if (g_cache_find_device(mp, (const char *)&md->md_name) != NULL) {
506 G_CACHE_DEBUG(0, "Provider %s already exists.", md->md_name);
510 gp = g_new_geomf(mp, "%s", md->md_name);
511 sc = g_malloc(sizeof(*sc), M_WAITOK | M_ZERO);
513 sc->sc_bshift = bshift;
514 sc->sc_bsize = 1 << bshift;
515 sc->sc_zone = uma_zcreate("gcache", sc->sc_bsize, NULL, NULL, NULL, NULL,
517 mtx_init(&sc->sc_mtx, "GEOM CACHE mutex", NULL, MTX_DEF);
518 for (i = 0; i < G_CACHE_BUCKETS; i++)
519 LIST_INIT(&sc->sc_desclist[i]);
520 TAILQ_INIT(&sc->sc_usedlist);
521 sc->sc_maxent = md->md_size;
522 callout_init_mtx(&sc->sc_callout, &sc->sc_mtx, 0);
525 gp->start = g_cache_start;
526 gp->orphan = g_cache_orphan;
527 gp->access = g_cache_access;
528 gp->dumpconf = g_cache_dumpconf;
530 newpp = g_new_providerf(gp, "cache/%s", gp->name);
531 newpp->sectorsize = pp->sectorsize;
532 newpp->mediasize = pp->mediasize;
533 if (type == G_CACHE_TYPE_AUTOMATIC)
534 newpp->mediasize -= pp->sectorsize;
535 sc->sc_tail = BNO2OFF(OFF2BNO(newpp->mediasize, sc), sc);
537 cp = g_new_consumer(gp);
538 if (g_attach(cp, pp) != 0) {
539 G_CACHE_DEBUG(0, "Cannot attach to provider %s.", pp->name);
540 g_destroy_consumer(cp);
541 g_destroy_provider(newpp);
542 mtx_destroy(&sc->sc_mtx);
548 g_error_provider(newpp, 0);
549 G_CACHE_DEBUG(0, "Device %s created.", gp->name);
550 callout_reset(&sc->sc_callout, g_cache_timeout * hz, g_cache_go, sc);
555 g_cache_destroy(struct g_cache_softc *sc, boolean_t force)
558 struct g_provider *pp;
559 struct g_cache_desc *dp, *dp2;
566 pp = LIST_FIRST(&gp->provider);
567 if (pp != NULL && (pp->acr != 0 || pp->acw != 0 || pp->ace != 0)) {
569 G_CACHE_DEBUG(0, "Device %s is still open, so it "
570 "can't be definitely removed.", pp->name);
572 G_CACHE_DEBUG(1, "Device %s is still open (r%dw%de%d).",
573 pp->name, pp->acr, pp->acw, pp->ace);
577 G_CACHE_DEBUG(0, "Device %s removed.", gp->name);
579 callout_drain(&sc->sc_callout);
580 mtx_lock(&sc->sc_mtx);
581 for (i = 0; i < G_CACHE_BUCKETS; i++) {
582 dp = LIST_FIRST(&sc->sc_desclist[i]);
584 dp2 = LIST_NEXT(dp, d_next);
585 g_cache_free(sc, dp);
589 mtx_unlock(&sc->sc_mtx);
590 mtx_destroy(&sc->sc_mtx);
591 uma_zdestroy(sc->sc_zone);
594 g_wither_geom(gp, ENXIO);
600 g_cache_destroy_geom(struct gctl_req *req, struct g_class *mp, struct g_geom *gp)
603 return (g_cache_destroy(gp->softc, 0));
607 g_cache_read_metadata(struct g_consumer *cp, struct g_cache_metadata *md)
609 struct g_provider *pp;
615 error = g_access(cp, 1, 0, 0);
620 buf = g_read_data(cp, pp->mediasize - pp->sectorsize, pp->sectorsize,
623 g_access(cp, -1, 0, 0);
627 /* Decode metadata. */
628 cache_metadata_decode(buf, md);
635 g_cache_write_metadata(struct g_consumer *cp, struct g_cache_metadata *md)
637 struct g_provider *pp;
643 error = g_access(cp, 0, 1, 0);
647 buf = malloc((size_t)pp->sectorsize, M_GCACHE, M_WAITOK | M_ZERO);
648 cache_metadata_encode(md, buf);
650 error = g_write_data(cp, pp->mediasize - pp->sectorsize, buf, pp->sectorsize);
652 g_access(cp, 0, -1, 0);
658 static struct g_geom *
659 g_cache_taste(struct g_class *mp, struct g_provider *pp, int flags __unused)
661 struct g_cache_metadata md;
662 struct g_consumer *cp;
666 g_trace(G_T_TOPOLOGY, "%s(%s, %s)", __func__, mp->name, pp->name);
669 G_CACHE_DEBUG(3, "Tasting %s.", pp->name);
671 gp = g_new_geomf(mp, "cache:taste");
672 gp->start = g_cache_start;
673 gp->orphan = g_cache_orphan;
674 gp->access = g_cache_access;
675 cp = g_new_consumer(gp);
676 error = g_attach(cp, pp);
678 error = g_cache_read_metadata(cp, &md);
681 g_destroy_consumer(cp);
686 if (strcmp(md.md_magic, G_CACHE_MAGIC) != 0)
688 if (md.md_version > G_CACHE_VERSION) {
689 printf("geom_cache.ko module is too old to handle %s.\n",
693 if (md.md_provsize != pp->mediasize)
696 gp = g_cache_create(mp, pp, &md, G_CACHE_TYPE_AUTOMATIC);
698 G_CACHE_DEBUG(0, "Can't create %s.", md.md_name);
705 g_cache_ctl_create(struct gctl_req *req, struct g_class *mp)
707 struct g_cache_metadata md;
708 struct g_provider *pp;
710 intmax_t *bsize, *size;
716 nargs = gctl_get_paraml(req, "nargs", sizeof(*nargs));
718 gctl_error(req, "No '%s' argument", "nargs");
722 gctl_error(req, "Invalid number of arguments.");
726 strlcpy(md.md_magic, G_CACHE_MAGIC, sizeof(md.md_magic));
727 md.md_version = G_CACHE_VERSION;
728 name = gctl_get_asciiparam(req, "arg0");
730 gctl_error(req, "No 'arg0' argument");
733 strlcpy(md.md_name, name, sizeof(md.md_name));
735 size = gctl_get_paraml(req, "size", sizeof(*size));
737 gctl_error(req, "No '%s' argument", "size");
740 if ((u_int)*size < 100) {
741 gctl_error(req, "Invalid '%s' argument", "size");
744 md.md_size = (u_int)*size;
746 bsize = gctl_get_paraml(req, "blocksize", sizeof(*bsize));
748 gctl_error(req, "No '%s' argument", "blocksize");
752 gctl_error(req, "Invalid '%s' argument", "blocksize");
755 md.md_bsize = (u_int)*bsize;
757 /* This field is not important here. */
760 pp = gctl_get_provider(req, "arg1");
763 gp = g_cache_create(mp, pp, &md, G_CACHE_TYPE_MANUAL);
765 gctl_error(req, "Can't create %s.", md.md_name);
771 g_cache_ctl_configure(struct gctl_req *req, struct g_class *mp)
773 struct g_cache_metadata md;
774 struct g_cache_softc *sc;
775 struct g_consumer *cp;
776 intmax_t *bsize, *size;
782 nargs = gctl_get_paraml(req, "nargs", sizeof(*nargs));
784 gctl_error(req, "No '%s' argument", "nargs");
788 gctl_error(req, "Missing device.");
792 name = gctl_get_asciiparam(req, "arg0");
794 gctl_error(req, "No 'arg0' argument");
797 sc = g_cache_find_device(mp, name);
799 G_CACHE_DEBUG(1, "Device %s is invalid.", name);
800 gctl_error(req, "Device %s is invalid.", name);
804 size = gctl_get_paraml(req, "size", sizeof(*size));
806 gctl_error(req, "No '%s' argument", "size");
809 if ((u_int)*size != 0 && (u_int)*size < 100) {
810 gctl_error(req, "Invalid '%s' argument", "size");
813 if ((u_int)*size != 0)
814 sc->sc_maxent = (u_int)*size;
816 bsize = gctl_get_paraml(req, "blocksize", sizeof(*bsize));
818 gctl_error(req, "No '%s' argument", "blocksize");
822 gctl_error(req, "Invalid '%s' argument", "blocksize");
826 if (sc->sc_type != G_CACHE_TYPE_AUTOMATIC)
829 strlcpy(md.md_name, name, sizeof(md.md_name));
830 strlcpy(md.md_magic, G_CACHE_MAGIC, sizeof(md.md_magic));
831 md.md_version = G_CACHE_VERSION;
832 if ((u_int)*size != 0)
833 md.md_size = (u_int)*size;
835 md.md_size = sc->sc_maxent;
836 if ((u_int)*bsize != 0)
837 md.md_bsize = (u_int)*bsize;
839 md.md_bsize = sc->sc_bsize;
840 cp = LIST_FIRST(&sc->sc_geom->consumer);
841 md.md_provsize = cp->provider->mediasize;
842 error = g_cache_write_metadata(cp, &md);
844 G_CACHE_DEBUG(2, "Metadata on %s updated.", cp->provider->name);
846 G_CACHE_DEBUG(0, "Cannot update metadata on %s (error=%d).",
847 cp->provider->name, error);
851 g_cache_ctl_destroy(struct gctl_req *req, struct g_class *mp)
853 int *nargs, *force, error, i;
854 struct g_cache_softc *sc;
860 nargs = gctl_get_paraml(req, "nargs", sizeof(*nargs));
862 gctl_error(req, "No '%s' argument", "nargs");
866 gctl_error(req, "Missing device(s).");
869 force = gctl_get_paraml(req, "force", sizeof(*force));
871 gctl_error(req, "No 'force' argument");
875 for (i = 0; i < *nargs; i++) {
876 snprintf(param, sizeof(param), "arg%d", i);
877 name = gctl_get_asciiparam(req, param);
879 gctl_error(req, "No 'arg%d' argument", i);
882 sc = g_cache_find_device(mp, name);
884 G_CACHE_DEBUG(1, "Device %s is invalid.", name);
885 gctl_error(req, "Device %s is invalid.", name);
888 error = g_cache_destroy(sc, *force);
890 gctl_error(req, "Cannot destroy device %s (error=%d).",
898 g_cache_ctl_reset(struct gctl_req *req, struct g_class *mp)
900 struct g_cache_softc *sc;
907 nargs = gctl_get_paraml(req, "nargs", sizeof(*nargs));
909 gctl_error(req, "No '%s' argument", "nargs");
913 gctl_error(req, "Missing device(s).");
917 for (i = 0; i < *nargs; i++) {
918 snprintf(param, sizeof(param), "arg%d", i);
919 name = gctl_get_asciiparam(req, param);
921 gctl_error(req, "No 'arg%d' argument", i);
924 sc = g_cache_find_device(mp, name);
926 G_CACHE_DEBUG(1, "Device %s is invalid.", name);
927 gctl_error(req, "Device %s is invalid.", name);
931 sc->sc_readbytes = 0;
932 sc->sc_cachereads = 0;
933 sc->sc_cachereadbytes = 0;
934 sc->sc_cachehits = 0;
935 sc->sc_cachemisses = 0;
936 sc->sc_cachefull = 0;
938 sc->sc_wrotebytes = 0;
943 g_cache_config(struct gctl_req *req, struct g_class *mp, const char *verb)
949 version = gctl_get_paraml(req, "version", sizeof(*version));
950 if (version == NULL) {
951 gctl_error(req, "No '%s' argument.", "version");
954 if (*version != G_CACHE_VERSION) {
955 gctl_error(req, "Userland and kernel parts are out of sync.");
959 if (strcmp(verb, "create") == 0) {
960 g_cache_ctl_create(req, mp);
962 } else if (strcmp(verb, "configure") == 0) {
963 g_cache_ctl_configure(req, mp);
965 } else if (strcmp(verb, "destroy") == 0 ||
966 strcmp(verb, "stop") == 0) {
967 g_cache_ctl_destroy(req, mp);
969 } else if (strcmp(verb, "reset") == 0) {
970 g_cache_ctl_reset(req, mp);
974 gctl_error(req, "Unknown verb.");
978 g_cache_dumpconf(struct sbuf *sb, const char *indent, struct g_geom *gp,
979 struct g_consumer *cp, struct g_provider *pp)
981 struct g_cache_softc *sc;
983 if (pp != NULL || cp != NULL)
986 sbuf_printf(sb, "%s<Size>%u</Size>\n", indent, sc->sc_maxent);
987 sbuf_printf(sb, "%s<BlockSize>%u</BlockSize>\n", indent, sc->sc_bsize);
988 sbuf_printf(sb, "%s<TailOffset>%ju</TailOffset>\n", indent,
989 (uintmax_t)sc->sc_tail);
990 sbuf_printf(sb, "%s<Entries>%u</Entries>\n", indent, sc->sc_nent);
991 sbuf_printf(sb, "%s<UsedEntries>%u</UsedEntries>\n", indent,
993 sbuf_printf(sb, "%s<InvalidEntries>%u</InvalidEntries>\n", indent,
995 sbuf_printf(sb, "%s<Reads>%ju</Reads>\n", indent, sc->sc_reads);
996 sbuf_printf(sb, "%s<ReadBytes>%ju</ReadBytes>\n", indent,
998 sbuf_printf(sb, "%s<CacheReads>%ju</CacheReads>\n", indent,
1000 sbuf_printf(sb, "%s<CacheReadBytes>%ju</CacheReadBytes>\n", indent,
1001 sc->sc_cachereadbytes);
1002 sbuf_printf(sb, "%s<CacheHits>%ju</CacheHits>\n", indent,
1004 sbuf_printf(sb, "%s<CacheMisses>%ju</CacheMisses>\n", indent,
1005 sc->sc_cachemisses);
1006 sbuf_printf(sb, "%s<CacheFull>%ju</CacheFull>\n", indent,
1008 sbuf_printf(sb, "%s<Writes>%ju</Writes>\n", indent, sc->sc_writes);
1009 sbuf_printf(sb, "%s<WroteBytes>%ju</WroteBytes>\n", indent,
1013 DECLARE_GEOM_CLASS(g_cache_class, g_cache);
1014 MODULE_VERSION(geom_cache, 0);