2 * Copyright (c) 2005 Ivan Voras <ivoras@freebsd.org>
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
7 * 1. Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
13 * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
14 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
17 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 #include <sys/cdefs.h>
27 __FBSDID("$FreeBSD$");
29 #include <sys/param.h>
43 #include <core/geom.h>
44 #include <misc/subr.h>
46 #include <geom/virstor/g_virstor_md.h>
47 #include <geom/virstor/g_virstor.h>
49 uint32_t lib_version = G_LIB_VERSION;
50 uint32_t version = G_VIRSTOR_VERSION;
52 #define GVIRSTOR_CHUNK_SIZE "4M"
53 #define GVIRSTOR_VIR_SIZE "2T"
55 #if G_LIB_VERSION == 1
56 /* Support RELENG_6 */
57 #define G_TYPE_BOOL G_TYPE_NONE
61 * virstor_main gets called by the geom(8) utility
63 static void virstor_main(struct gctl_req *req, unsigned flags);
65 struct g_command class_commands[] = {
66 {"clear", G_FLAG_VERBOSE, virstor_main, G_NULL_OPTS, NULL,
69 {"dump", 0, virstor_main, G_NULL_OPTS, NULL,
72 {"label", G_FLAG_VERBOSE | G_FLAG_LOADKLD, virstor_main,
74 {'h', "hardcode", NULL, G_TYPE_BOOL},
75 {'m', "chunk_size", GVIRSTOR_CHUNK_SIZE, G_TYPE_NUMBER},
76 {'s', "vir_size", GVIRSTOR_VIR_SIZE, G_TYPE_NUMBER},
79 NULL, "[-h] [-v] [-m chunk_size] [-s vir_size] name provider0 [provider1 ...]"
81 {"destroy", G_FLAG_VERBOSE, NULL,
83 {'f', "force", NULL, G_TYPE_BOOL},
86 NULL, "[-fv] name ..."
88 {"stop", G_FLAG_VERBOSE, NULL,
90 {'f', "force", NULL, G_TYPE_BOOL},
93 NULL, "[-fv] name ... (alias for \"destroy\")"
95 {"add", G_FLAG_VERBOSE, NULL,
97 {'h', "hardcode", NULL, G_TYPE_BOOL},
100 NULL, "[-vh] name prov [prov ...]"
102 {"remove", G_FLAG_VERBOSE, NULL, G_NULL_OPTS, NULL,
108 static int verbose = 0;
110 /* Helper functions' declarations */
111 static void virstor_clear(struct gctl_req *req);
112 static void virstor_dump(struct gctl_req *req);
113 static void virstor_label(struct gctl_req *req);
115 /* Dispatcher function (no real work done here, only verbose flag recorder) */
117 virstor_main(struct gctl_req *req, unsigned flags)
121 if ((flags & G_FLAG_VERBOSE) != 0)
124 name = gctl_get_ascii(req, "verb");
126 gctl_error(req, "No '%s' argument.", "verb");
129 if (strcmp(name, "label") == 0)
131 else if (strcmp(name, "clear") == 0)
133 else if (strcmp(name, "dump") == 0)
136 gctl_error(req, "%s: Unknown command: %s.", __func__, name);
138 /* No CTASSERT in userland
139 CTASSERT(VIRSTOR_MAP_BLOCK_ENTRIES*VIRSTOR_MAP_ENTRY_SIZE == MAXPHYS);
144 pathgen(const char *name, char *path, size_t size)
147 if (strncmp(name, _PATH_DEV, strlen(_PATH_DEV)) != 0)
148 snprintf(path, size, "%s%s", _PATH_DEV, name);
150 strlcpy(path, name, size);
154 my_g_metadata_store(const char *name, u_char *md, size_t size)
156 char path[MAXPATHLEN];
162 pathgen(name, path, sizeof(path));
166 fd = open(path, O_RDWR);
169 mediasize = g_get_mediasize(name);
170 if (mediasize == 0) {
174 sectorsize = g_get_sectorsize(name);
175 if (sectorsize == 0) {
179 assert(sectorsize >= size);
180 sector = malloc(sectorsize);
181 if (sector == NULL) {
185 bcopy(md, sector, size);
186 if (pwrite(fd, sector, sectorsize, mediasize - sectorsize) !=
187 (ssize_t)sectorsize) {
199 * Labels a new geom Meaning: parses and checks the parameters, calculates &
200 * writes metadata to the relevant providers so when the next round of
201 * "tasting" comes (which will be just after the provider(s) are closed) geom
202 * can be instantiated with the tasted metadata.
205 virstor_label(struct gctl_req *req)
207 struct g_virstor_metadata md;
211 size_t ssize, secsize;
214 int hardcode, nargs, error;
215 struct virstor_map_entry *map;
216 size_t total_chunks; /* We'll run out of memory if
217 this needs to be bigger. */
218 unsigned int map_chunks; /* Chunks needed by the map (map size). */
219 size_t map_size; /* In bytes. */
223 nargs = gctl_get_int(req, "nargs");
225 gctl_error(req, "Too few arguments (%d): expecting: name "
226 "provider0 [provider1 ...]", nargs);
230 hardcode = gctl_get_int(req, "hardcode");
233 * Initialize constant parts of metadata: magic signature, version,
236 bzero(&md, sizeof(md));
237 strlcpy(md.md_magic, G_VIRSTOR_MAGIC, sizeof(md.md_magic));
238 md.md_version = G_VIRSTOR_VERSION;
239 name = gctl_get_ascii(req, "arg0");
241 gctl_error(req, "No 'arg%u' argument.", 0);
244 strlcpy(md.md_name, name, sizeof(md.md_name));
246 md.md_virsize = (off_t)gctl_get_intmax(req, "vir_size");
247 md.md_chunk_size = gctl_get_intmax(req, "chunk_size");
248 md.md_count = nargs - 1;
250 if (md.md_virsize == 0 || md.md_chunk_size == 0) {
251 gctl_error(req, "Virtual size and chunk size must be non-zero");
255 if (md.md_chunk_size % MAXPHYS != 0) {
256 /* XXX: This is not strictly needed, but it's convenient to
257 * impose some limitations on it, so why not MAXPHYS. */
258 size_t new_size = (md.md_chunk_size / MAXPHYS) * MAXPHYS;
259 if (new_size < md.md_chunk_size)
261 fprintf(stderr, "Resizing chunk size to be a multiple of "
262 "MAXPHYS (%d kB).\n", MAXPHYS / 1024);
263 fprintf(stderr, "New chunk size: %zu kB\n", new_size / 1024);
264 md.md_chunk_size = new_size;
267 if (md.md_virsize % md.md_chunk_size != 0) {
268 off_t chunk_count = md.md_virsize / md.md_chunk_size;
269 md.md_virsize = chunk_count * md.md_chunk_size;
270 fprintf(stderr, "Resizing virtual size to be a multiple of "
272 fprintf(stderr, "New virtual size: %zu MB\n",
273 (size_t)(md.md_virsize/(1024 * 1024)));
277 for (i = 1; i < (unsigned)nargs; i++) {
278 snprintf(param, sizeof(param), "arg%u", i);
279 name = gctl_get_ascii(req, param);
280 ssize = g_get_sectorsize(name);
282 fprintf(stderr, "%s for %s\n", strerror(errno), name);
283 msize += g_get_mediasize(name);
286 else if (secsize != ssize) {
287 gctl_error(req, "Devices need to have same sector size "
288 "(%u on %s needs to be %u).",
289 (u_int)ssize, name, (u_int)secsize);
295 gctl_error(req, "Device not specified");
299 if (md.md_chunk_size % secsize != 0) {
300 fprintf(stderr, "Error: chunk size is not a multiple of sector "
302 gctl_error(req, "Chunk size (in bytes) must be multiple of %u.",
303 (unsigned int)secsize);
307 total_chunks = md.md_virsize / md.md_chunk_size;
308 map_size = total_chunks * sizeof(*map);
309 assert(md.md_virsize % md.md_chunk_size == 0);
311 ssize = map_size % secsize;
313 size_t add_chunks = (secsize - ssize) / sizeof(*map);
314 total_chunks += add_chunks;
315 md.md_virsize = (off_t)total_chunks * (off_t)md.md_chunk_size;
316 map_size = total_chunks * sizeof(*map);
317 fprintf(stderr, "Resizing virtual size to fit virstor "
319 fprintf(stderr, "New virtual size: %ju MB (%zu new chunks)\n",
320 (uintmax_t)(md.md_virsize / (1024 * 1024)), add_chunks);
324 printf("Total virtual chunks: %zu (%zu MB each), %ju MB total "
326 total_chunks, (size_t)(md.md_chunk_size / (1024 * 1024)),
327 md.md_virsize/(1024 * 1024));
329 if ((off_t)md.md_virsize < msize)
330 fprintf(stderr, "WARNING: Virtual storage size < Physical "
331 "available storage (%ju < %ju)\n", md.md_virsize, msize);
333 /* Clear last sector first to spoil all components if device exists. */
335 printf("Clearing metadata on");
337 for (i = 1; i < (unsigned)nargs; i++) {
338 snprintf(param, sizeof(param), "arg%u", i);
339 name = gctl_get_ascii(req, param);
344 msize = g_get_mediasize(name);
345 ssize = g_get_sectorsize(name);
346 if (msize == 0 || ssize == 0) {
347 gctl_error(req, "Can't retrieve information about "
348 "%s: %s.", name, strerror(errno));
351 if (msize < (off_t) MAX(md.md_chunk_size*4, map_size))
352 gctl_error(req, "Device %s is too small", name);
353 error = g_metadata_clear(name, NULL);
355 gctl_error(req, "Can't clear metadata on %s: %s.", name,
362 /* Write allocation table to the first provider - this needs to be done
363 * before metadata is written because when kernel tastes it it's too
365 name = gctl_get_ascii(req, "arg1"); /* device with metadata */
367 printf(".\nWriting allocation table to %s...", name);
369 /* How many chunks does the map occupy? */
370 map_chunks = map_size/md.md_chunk_size;
371 if (map_size % md.md_chunk_size != 0)
374 printf(" (%zu MB, %d chunks) ", map_size/(1024*1024), map_chunks);
378 if (strncmp(name, _PATH_DEV, strlen(_PATH_DEV)) == 0)
379 fd = open(name, O_RDWR);
381 sprintf(param, "%s%s", _PATH_DEV, name);
382 fd = open(param, O_RDWR);
385 gctl_error(req, "Cannot open provider %s to write map", name);
387 /* Do it with calloc because there might be a need to set up chunk flags
389 map = calloc(total_chunks, sizeof(*map));
392 "Out of memory (need %zu bytes for allocation map)",
396 written = pwrite(fd, map, map_size, 0);
398 if ((size_t)written != map_size) {
400 fprintf(stderr, "\nTried to write %zu, written %zd (%s)\n",
401 map_size, written, strerror(errno));
403 gctl_error(req, "Error writing out allocation map!");
409 printf("\nStoring metadata on ");
412 * ID is randomly generated, unique for a geom. This is used to
413 * recognize all providers belonging to one geom.
415 md.md_id = arc4random();
417 /* Ok, store metadata. */
418 for (i = 1; i < (unsigned)nargs; i++) {
419 snprintf(param, sizeof(param), "arg%u", i);
420 name = gctl_get_ascii(req, param);
422 msize = g_get_mediasize(name);
423 ssize = g_get_sectorsize(name);
428 /* this provider's position/type in geom */
430 /* this provider's size */
432 /* chunk allocation info */
433 md.chunk_count = md.provsize / md.md_chunk_size;
435 printf("(%u chunks) ", md.chunk_count);
436 /* Check to make sure last sector is unused */
437 if ((off_t)(md.chunk_count * md.md_chunk_size) > msize-ssize)
441 md.chunk_reserved = 0;
444 md.chunk_reserved = map_chunks * 2;
445 md.flags = VIRSTOR_PROVIDER_ALLOCATED |
446 VIRSTOR_PROVIDER_CURRENT;
447 md.chunk_next = md.chunk_reserved;
449 printf("(%u reserved) ", md.chunk_reserved);
453 bzero(md.provider, sizeof(md.provider));
455 /* convert "/dev/something" to "something" */
456 if (strncmp(name, _PATH_DEV, strlen(_PATH_DEV)) == 0) {
457 strlcpy(md.provider, name + strlen(_PATH_DEV),
458 sizeof(md.provider));
460 strlcpy(md.provider, name, sizeof(md.provider));
462 sect = malloc(ssize);
465 err(1, "Cannot allocate sector of %zu bytes", ssize);
466 virstor_metadata_encode(&md, sect);
467 error = my_g_metadata_store(name, sect, ssize);
472 fprintf(stderr, "Can't store metadata on %s: %s.\n",
473 name, strerror(error));
475 "Not fully done (error storing metadata).");
485 /* Clears metadata on given provider(s) IF it's owned by us */
487 virstor_clear(struct gctl_req *req)
495 nargs = gctl_get_int(req, "nargs");
497 gctl_error(req, "Too few arguments.");
500 for (i = 0; i < (unsigned)nargs; i++) {
501 snprintf(param, sizeof(param), "arg%u", i);
502 name = gctl_get_ascii(req, param);
504 error = g_metadata_clear(name, G_VIRSTOR_MAGIC);
506 fprintf(stderr, "Can't clear metadata on %s: %s "
507 "(do I own it?)\n", name, strerror(error));
509 "Not fully done (can't clear metadata).");
512 if (strncmp(name, _PATH_DEV, strlen(_PATH_DEV)) == 0)
513 fd = open(name, O_RDWR);
515 sprintf(param, "%s%s", _PATH_DEV, name);
516 fd = open(param, O_RDWR);
519 gctl_error(req, "Cannot clear header sector for %s",
524 printf("Metadata cleared on %s.\n", name);
528 /* Print some metadata information */
530 virstor_metadata_dump(const struct g_virstor_metadata *md)
532 printf(" Magic string: %s\n", md->md_magic);
533 printf(" Metadata version: %u\n", (u_int) md->md_version);
534 printf(" Device name: %s\n", md->md_name);
535 printf(" Device ID: %u\n", (u_int) md->md_id);
536 printf(" Provider index: %u\n", (u_int) md->no);
537 printf(" Active providers: %u\n", (u_int) md->md_count);
538 printf(" Hardcoded provider: %s\n",
539 md->provider[0] != '\0' ? md->provider : "(not hardcoded)");
540 printf(" Virtual size: %u MB\n",
541 (unsigned int)(md->md_virsize/(1024 * 1024)));
542 printf(" Chunk size: %u kB\n", md->md_chunk_size / 1024);
543 printf(" Chunks on provider: %u\n", md->chunk_count);
544 printf(" Chunks free: %u\n", md->chunk_count - md->chunk_next);
545 printf(" Reserved chunks: %u\n", md->chunk_reserved);
548 /* Called by geom(8) via gvirstor_main() to dump metadata information */
550 virstor_dump(struct gctl_req *req)
552 struct g_virstor_metadata md;
553 u_char tmpmd[512]; /* temporary buffer */
558 assert(sizeof(tmpmd) >= sizeof(md));
560 nargs = gctl_get_int(req, "nargs");
562 gctl_error(req, "Too few arguments.");
565 for (i = 0; i < nargs; i++) {
566 snprintf(param, sizeof(param), "arg%u", i);
567 name = gctl_get_ascii(req, param);
569 error = g_metadata_read(name, (u_char *) & tmpmd, sizeof(tmpmd),
572 fprintf(stderr, "Can't read metadata from %s: %s.\n",
573 name, strerror(error));
575 "Not fully done (error reading metadata).");
578 virstor_metadata_decode((u_char *) & tmpmd, &md);
579 printf("Metadata on %s:\n", name);
580 virstor_metadata_dump(&md);