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