sbin/geom/class/cache/geom_cache.c

   1 /*-
   2  * Copyright (c) 2006 Ruslan Ermilov <ru@FreeBSD.org>
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   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.
  13  *
  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
  24  * SUCH DAMAGE.
  25  */
  26
  27 #include <sys/cdefs.h>
  28 __FBSDID("$FreeBSD$");
  29
  30 #include <errno.h>
  31 #include <stdio.h>
  32 #include <stdint.h>
  33 #include <string.h>
  34 #include <strings.h>
  35 #include <libgeom.h>
  36 #include <geom/cache/g_cache.h>
  37
  38 #include "core/geom.h"
  39 #include "misc/subr.h"
  40
  41
  42 uint32_t lib_version = G_LIB_VERSION;
  43 uint32_t version = G_CACHE_VERSION;
  44
  45 #define GCACHE_BLOCKSIZE        "65536"
  46 #define GCACHE_SIZE             "100"
  47
  48 static void cache_main(struct gctl_req *req, unsigned flags);
  49 static void cache_clear(struct gctl_req *req);
  50 static void cache_dump(struct gctl_req *req);
  51 static void cache_label(struct gctl_req *req);
  52
  53 struct g_command class_commands[] = {
  54         { "clear", G_FLAG_VERBOSE, cache_main, G_NULL_OPTS,
  55             "[-v] prov ..."
  56         },
  57         { "configure", G_FLAG_VERBOSE, NULL,
  58             {
  59                 { 'b', "blocksize", "0", G_TYPE_NUMBER },
  60                 { 's', "size", "0", G_TYPE_NUMBER },
  61                 G_OPT_SENTINEL
  62             },
  63             "[-v] [-b blocksize] [-s size] name"
  64         },
  65         { "create", G_FLAG_VERBOSE | G_FLAG_LOADKLD, NULL,
  66             {
  67                 { 'b', "blocksize", GCACHE_BLOCKSIZE, G_TYPE_NUMBER },
  68                 { 's', "size", GCACHE_SIZE, G_TYPE_NUMBER },
  69                 G_OPT_SENTINEL
  70             },
  71             "[-v] [-b blocksize] [-s size] name prov"
  72         },
  73         { "destroy", G_FLAG_VERBOSE, NULL,
  74             {
  75                 { 'f', "force", NULL, G_TYPE_BOOL },
  76                 G_OPT_SENTINEL
  77             },
  78             "[-fv] name ..."
  79         },
  80         { "dump", 0, cache_main, G_NULL_OPTS,
  81             "prov ..."
  82         },
  83         { "label", G_FLAG_VERBOSE | G_FLAG_LOADKLD, cache_main,
  84             {
  85                 { 'b', "blocksize", GCACHE_BLOCKSIZE, G_TYPE_NUMBER },
  86                 { 's', "size", GCACHE_SIZE, G_TYPE_NUMBER },
  87                 G_OPT_SENTINEL
  88             },
  89             "[-v] [-b blocksize] [-s size] name prov"
  90         },
  91         { "reset", G_FLAG_VERBOSE, NULL, G_NULL_OPTS,
  92             "[-v] name ..."
  93         },
  94         { "stop", G_FLAG_VERBOSE, NULL,
  95             {
  96                 { 'f', "force", NULL, G_TYPE_BOOL },
  97                 G_OPT_SENTINEL
  98             },
  99             "[-fv] name ..."
 100         },
 101         G_CMD_SENTINEL
 102 };
 103
 104 static int verbose = 0;
 105
 106 static void
 107 cache_main(struct gctl_req *req, unsigned flags)
 108 {
 109         const char *name;
 110
 111         if ((flags & G_FLAG_VERBOSE) != 0)
 112                 verbose = 1;
 113
 114         name = gctl_get_ascii(req, "verb");
 115         if (name == NULL) {
 116                 gctl_error(req, "No '%s' argument.", "verb");
 117                 return;
 118         }
 119         if (strcmp(name, "label") == 0)
 120                 cache_label(req);
 121         else if (strcmp(name, "clear") == 0)
 122                 cache_clear(req);
 123         else if (strcmp(name, "dump") == 0)
 124                 cache_dump(req);
 125         else
 126                 gctl_error(req, "Unknown command: %s.", name);
 127 }
 128
 129 static void
 130 cache_label(struct gctl_req *req)
 131 {
 132         struct g_cache_metadata md;
 133         u_char sector[512];
 134         const char *name;
 135         int error, nargs;
 136         intmax_t val;
 137
 138         nargs = gctl_get_int(req, "nargs");
 139         if (nargs != 2) {
 140                 gctl_error(req, "Invalid number of arguments.");
 141                 return;
 142         }
 143
 144         strlcpy(md.md_magic, G_CACHE_MAGIC, sizeof(md.md_magic));
 145         md.md_version = G_CACHE_VERSION;
 146         name = gctl_get_ascii(req, "arg0");
 147         strlcpy(md.md_name, name, sizeof(md.md_name));
 148         val = gctl_get_intmax(req, "blocksize");
 149         md.md_bsize = val;
 150         val = gctl_get_intmax(req, "size");
 151         md.md_size = val;
 152
 153         name = gctl_get_ascii(req, "arg1");
 154         md.md_provsize = g_get_mediasize(name);
 155         if (md.md_provsize == 0) {
 156                 fprintf(stderr, "Can't get mediasize of %s: %s.\n",
 157                     name, strerror(errno));
 158                 gctl_error(req, "Not fully done.");
 159                 return;
 160         }
 161         cache_metadata_encode(&md, sector);
 162         error = g_metadata_store(name, sector, sizeof(sector));
 163         if (error != 0) {
 164                 fprintf(stderr, "Can't store metadata on %s: %s.\n",
 165                     name, strerror(error));
 166                 gctl_error(req, "Not fully done.");
 167                 return;
 168         }
 169         if (verbose)
 170                 printf("Metadata value stored on %s.\n", name);
 171 }
 172
 173 static void
 174 cache_clear(struct gctl_req *req)
 175 {
 176         const char *name;
 177         int error, i, nargs;
 178
 179         nargs = gctl_get_int(req, "nargs");
 180         if (nargs < 1) {
 181                 gctl_error(req, "Too few arguments.");
 182                 return;
 183         }
 184
 185         for (i = 0; i < nargs; i++) {
 186                 name = gctl_get_ascii(req, "arg%d", i);
 187                 error = g_metadata_clear(name, G_CACHE_MAGIC);
 188                 if (error != 0) {
 189                         fprintf(stderr, "Can't clear metadata on %s: %s.\n",
 190                             name, strerror(error));
 191                         gctl_error(req, "Not fully done.");
 192                         continue;
 193                 }
 194                 if (verbose)
 195                         printf("Metadata cleared on %s.\n", name);
 196         }
 197 }
 198
 199 static void
 200 cache_metadata_dump(const struct g_cache_metadata *md)
 201 {
 202
 203         printf("         Magic string: %s\n", md->md_magic);
 204         printf("     Metadata version: %u\n", (u_int)md->md_version);
 205         printf("          Device name: %s\n", md->md_name);
 206         printf("           Block size: %u\n", (u_int)md->md_bsize);
 207         printf("           Cache size: %u\n", (u_int)md->md_size);
 208         printf("        Provider size: %ju\n", (uintmax_t)md->md_provsize);
 209 }
 210
 211 static void
 212 cache_dump(struct gctl_req *req)
 213 {
 214         struct g_cache_metadata md, tmpmd;
 215         const char *name;
 216         int error, i, nargs;
 217
 218         nargs = gctl_get_int(req, "nargs");
 219         if (nargs < 1) {
 220                 gctl_error(req, "Too few arguments.");
 221                 return;
 222         }
 223
 224         for (i = 0; i < nargs; i++) {
 225                 name = gctl_get_ascii(req, "arg%d", i);
 226                 error = g_metadata_read(name, (u_char *)&tmpmd, sizeof(tmpmd),
 227                     G_CACHE_MAGIC);
 228                 if (error != 0) {
 229                         fprintf(stderr, "Can't read metadata from %s: %s.\n",
 230                             name, strerror(error));
 231                         gctl_error(req, "Not fully done.");
 232                         continue;
 233                 }
 234                 cache_metadata_decode((u_char *)&tmpmd, &md);
 235                 printf("Metadata on %s:\n", name);
 236                 cache_metadata_dump(&md);
 237                 printf("\n");
 238         }
 239 }