geom_raid3.c revision 142727
1218887Sdim/*- 2218887Sdim * Copyright (c) 2004-2005 Pawel Jakub Dawidek <pjd@FreeBSD.org> 3218887Sdim * All rights reserved. 4218887Sdim * 5218887Sdim * Redistribution and use in source and binary forms, with or without 6218887Sdim * modification, are permitted provided that the following conditions 7218887Sdim * are met: 8218887Sdim * 1. Redistributions of source code must retain the above copyright 9218887Sdim * notice, this list of conditions and the following disclaimer. 10218887Sdim * 2. Redistributions in binary form must reproduce the above copyright 11218887Sdim * notice, this list of conditions and the following disclaimer in the 12218887Sdim * documentation and/or other materials provided with the distribution. 13218887Sdim * 14218887Sdim * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND 15252723Sdim * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16252723Sdim * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17218887Sdim * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE 18218887Sdim * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19235633Sdim * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20218887Sdim * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21263509Sdim * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22218887Sdim * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23218887Sdim * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24263509Sdim * SUCH DAMAGE. 25252723Sdim */ 26252723Sdim 27218887Sdim#include <sys/cdefs.h> 28252723Sdim__FBSDID("$FreeBSD: head/sbin/geom/class/raid3/geom_raid3.c 142727 2005-02-27 23:07:47Z pjd $"); 29218887Sdim 30252723Sdim#include <sys/param.h> 31218887Sdim#include <errno.h> 32252723Sdim#include <paths.h> 33252723Sdim#include <stdio.h> 34252723Sdim#include <stdlib.h> 35235633Sdim#include <stdint.h> 36252723Sdim#include <string.h> 37252723Sdim#include <strings.h> 38218887Sdim#include <assert.h> 39218887Sdim#include <libgeom.h> 40218887Sdim#include <geom/raid3/g_raid3.h> 41218887Sdim#include <core/geom.h> 42218887Sdim#include <misc/subr.h> 43252723Sdim 44252723Sdim 45252723Sdimuint32_t lib_version = G_LIB_VERSION; 46252723Sdimuint32_t version = G_RAID3_VERSION; 47252723Sdim 48252723Sdimstatic void raid3_main(struct gctl_req *req, unsigned f); 49218887Sdimstatic void raid3_clear(struct gctl_req *req); 50218887Sdimstatic void raid3_dump(struct gctl_req *req); 51235633Sdimstatic void raid3_label(struct gctl_req *req); 52235633Sdim 53218887Sdimstruct g_command class_commands[] = { 54218887Sdim { "clear", G_FLAG_VERBOSE, raid3_main, G_NULL_OPTS }, 55218887Sdim { "configure", G_FLAG_VERBOSE, NULL, 56218887Sdim { 57226890Sdim { 'a', "autosync", NULL, G_TYPE_NONE }, 58252723Sdim { 'd', "dynamic", NULL, G_TYPE_NONE }, 59252723Sdim { 'h', "hardcode", NULL, G_TYPE_NONE }, 60218887Sdim { 'n', "noautosync", NULL, G_TYPE_NONE }, 61218887Sdim { 'r', "round_robin", NULL, G_TYPE_NONE }, 62218887Sdim { 'R', "noround_robin", NULL, G_TYPE_NONE }, 63218887Sdim { 'w', "verify", NULL, G_TYPE_NONE }, 64218887Sdim { 'W', "noverify", NULL, G_TYPE_NONE }, 65218887Sdim G_OPT_SENTINEL 66226890Sdim } 67252723Sdim }, 68218887Sdim { "dump", 0, raid3_main, G_NULL_OPTS }, 69218887Sdim { "insert", G_FLAG_VERBOSE, NULL, 70218887Sdim { 71218887Sdim { 'h', "hardcode", NULL, G_TYPE_NONE }, 72218887Sdim { 'n', "number", NULL, G_TYPE_NUMBER }, 73218887Sdim G_OPT_SENTINEL 74235633Sdim } 75235633Sdim }, 76235633Sdim { "label", G_FLAG_VERBOSE, raid3_main, 77245431Sdim { 78245431Sdim { 'h', "hardcode", NULL, G_TYPE_NONE }, 79245431Sdim { 'n', "noautosync", NULL, G_TYPE_NONE }, 80245431Sdim { 'r', "round_robin", NULL, G_TYPE_NONE }, 81245431Sdim { 'w', "verify", NULL, G_TYPE_NONE }, 82245431Sdim G_OPT_SENTINEL 83245431Sdim } 84245431Sdim }, 85245431Sdim { "rebuild", G_FLAG_VERBOSE, NULL, G_NULL_OPTS }, 86245431Sdim { "remove", G_FLAG_VERBOSE, NULL, 87245431Sdim { 88245431Sdim { 'n', "number", NULL, G_TYPE_NUMBER }, 89245431Sdim G_OPT_SENTINEL 90245431Sdim } 91245431Sdim }, 92245431Sdim { "stop", G_FLAG_VERBOSE, NULL, 93245431Sdim { 94245431Sdim { 'f', "force", NULL, G_TYPE_NONE }, 95245431Sdim G_OPT_SENTINEL 96245431Sdim } 97245431Sdim }, 98245431Sdim G_CMD_SENTINEL 99245431Sdim}; 100245431Sdim 101245431Sdimstatic int verbose = 0; 102245431Sdim 103245431Sdimvoid usage(const char *); 104245431Sdimvoid 105245431Sdimusage(const char *comm) 106245431Sdim{ 107245431Sdim fprintf(stderr, 108245431Sdim "usage: %s label [-hnrvw] name prov prov prov ...\n" 109245431Sdim " %s clear [-v] prov ...\n" 110245431Sdim " %s dump prov ...\n" 111245431Sdim " %s configure [-adhnrRvwW] name\n" 112245431Sdim " %s rebuild [-v] name prov\n" 113245431Sdim " %s insert [-hv] <-n number> name prov\n" 114245431Sdim " %s remove [-v] <-n number> name\n" 115245431Sdim " %s stop [-fv] name ...\n", 116245431Sdim comm, comm, comm, comm, comm, comm, comm, comm); 117245431Sdim} 118245431Sdim 119245431Sdimstatic void 120245431Sdimraid3_main(struct gctl_req *req, unsigned flags) 121245431Sdim{ 122245431Sdim const char *name; 123245431Sdim 124245431Sdim if ((flags & G_FLAG_VERBOSE) != 0) 125245431Sdim verbose = 1; 126245431Sdim 127245431Sdim name = gctl_get_asciiparam(req, "verb"); 128245431Sdim if (name == NULL) { 129245431Sdim gctl_error(req, "No '%s' argument.", "verb"); 130245431Sdim return; 131245431Sdim } 132245431Sdim if (strcmp(name, "label") == 0) 133245431Sdim raid3_label(req); 134245431Sdim else if (strcmp(name, "clear") == 0) 135245431Sdim raid3_clear(req); 136245431Sdim else if (strcmp(name, "dump") == 0) 137245431Sdim raid3_dump(req); 138245431Sdim else 139245431Sdim gctl_error(req, "Unknown command: %s.", name); 140245431Sdim} 141245431Sdim 142245431Sdimstatic void 143245431Sdimraid3_label(struct gctl_req *req) 144245431Sdim{ 145245431Sdim struct g_raid3_metadata md; 146245431Sdim u_char sector[512]; 147245431Sdim const char *str; 148252723Sdim char param[16]; 149252723Sdim int *hardcode, *nargs, *noautosync, *round_robin, *verify; 150252723Sdim int error, i; 151252723Sdim unsigned sectorsize, ssize; 152252723Sdim off_t mediasize, msize; 153235633Sdim 154235633Sdim nargs = gctl_get_paraml(req, "nargs", sizeof(*nargs)); 155252723Sdim if (nargs == NULL) { 156252723Sdim gctl_error(req, "No '%s' argument.", "nargs"); 157252723Sdim return; 158235633Sdim } 159235633Sdim if (*nargs < 4) { 160235633Sdim gctl_error(req, "Too few arguments."); 161235633Sdim return; 162235633Sdim } 163235633Sdim#ifndef BITCOUNT 164235633Sdim#define BITCOUNT(x) (((BX_(x) + (BX_(x) >> 4)) & 0x0F0F0F0F) % 255) 165235633Sdim#define BX_(x) ((x) - (((x) >> 1) & 0x77777777) - \ 166235633Sdim (((x) >> 2) & 0x33333333) - (((x) >> 3) & 0x11111111)) 167235633Sdim#endif 168235633Sdim if (BITCOUNT(*nargs - 2) != 1) { 169235633Sdim gctl_error(req, "Invalid number of components."); 170245431Sdim return; 171252723Sdim } 172252723Sdim 173245431Sdim strlcpy(md.md_magic, G_RAID3_MAGIC, sizeof(md.md_magic)); 174245431Sdim md.md_version = G_RAID3_VERSION; 175245431Sdim str = gctl_get_asciiparam(req, "arg0"); 176252723Sdim if (str == NULL) { 177252723Sdim gctl_error(req, "No 'arg%u' argument.", 0); 178235633Sdim return; 179245431Sdim } 180235633Sdim strlcpy(md.md_name, str, sizeof(md.md_name)); 181235633Sdim md.md_all = *nargs - 1; 182235633Sdim md.md_mflags = 0; 183235633Sdim md.md_dflags = 0; 184235633Sdim md.md_genid = 0; 185252723Sdim md.md_syncid = 1; 186235633Sdim md.md_sync_offset = 0; 187235633Sdim noautosync = gctl_get_paraml(req, "noautosync", sizeof(*noautosync)); 188235633Sdim if (noautosync == NULL) { 189235633Sdim gctl_error(req, "No '%s' argument.", "noautosync"); 190235633Sdim return; 191235633Sdim } 192245431Sdim if (*noautosync) 193235633Sdim md.md_mflags |= G_RAID3_DEVICE_FLAG_NOAUTOSYNC; 194235633Sdim round_robin = gctl_get_paraml(req, "round_robin", sizeof(*round_robin)); 195245431Sdim if (round_robin == NULL) { 196235633Sdim gctl_error(req, "No '%s' argument.", "round_robin"); 197235633Sdim return; 198235633Sdim } 199235633Sdim if (*round_robin) 200235633Sdim md.md_mflags |= G_RAID3_DEVICE_FLAG_ROUND_ROBIN; 201235633Sdim verify = gctl_get_paraml(req, "verify", sizeof(*verify)); 202235633Sdim if (verify == NULL) { 203235633Sdim gctl_error(req, "No '%s' argument.", "verify"); 204235633Sdim return; 205235633Sdim } 206235633Sdim if (*verify) 207235633Sdim md.md_mflags |= G_RAID3_DEVICE_FLAG_VERIFY; 208263509Sdim if (*round_robin && *verify) { 209263509Sdim gctl_error(req, "Both '%c' and '%c' options given.", 'r', 'w'); 210263509Sdim return; 211263509Sdim } 212263509Sdim hardcode = gctl_get_paraml(req, "hardcode", sizeof(*hardcode)); 213263509Sdim if (hardcode == NULL) { 214263509Sdim gctl_error(req, "No '%s' argument.", "hardcode"); 215252723Sdim return; 216263509Sdim } 217252723Sdim 218252723Sdim /* 219252723Sdim * Calculate sectorsize by finding least common multiple from 220252723Sdim * sectorsizes of every disk and find the smallest mediasize. 221252723Sdim */ 222252723Sdim mediasize = 0; 223252723Sdim sectorsize = 0; 224252723Sdim for (i = 1; i < *nargs; i++) { 225252723Sdim snprintf(param, sizeof(param), "arg%u", i); 226252723Sdim str = gctl_get_asciiparam(req, param); 227252723Sdim 228263509Sdim msize = g_get_mediasize(str); 229263509Sdim ssize = g_get_sectorsize(str); 230252723Sdim if (msize == 0 || ssize == 0) { 231263509Sdim gctl_error(req, "Can't get informations about %s: %s.", 232252723Sdim str, strerror(errno)); 233252723Sdim return; 234252723Sdim } 235252723Sdim msize -= ssize; 236252723Sdim if (mediasize == 0 || (mediasize > 0 && msize < mediasize)) 237252723Sdim mediasize = msize; 238252723Sdim if (sectorsize == 0) 239263509Sdim sectorsize = ssize; 240252723Sdim else 241252723Sdim sectorsize = g_lcm(sectorsize, ssize); 242252723Sdim } 243252723Sdim md.md_mediasize = mediasize * (*nargs - 2); 244252723Sdim md.md_sectorsize = sectorsize * (*nargs - 2); 245252723Sdim 246252723Sdim /* 247252723Sdim * Clear last sector first, to spoil all components if device exists. 248252723Sdim */ 249263509Sdim for (i = 1; i < *nargs; i++) { 250263509Sdim snprintf(param, sizeof(param), "arg%u", i); 251263509Sdim str = gctl_get_asciiparam(req, param); 252263509Sdim 253263509Sdim error = g_metadata_clear(str, NULL); 254263509Sdim if (error != 0) { 255263509Sdim gctl_error(req, "Can't store metadata on %s: %s.", str, 256263509Sdim strerror(error)); 257263509Sdim return; 258263509Sdim } 259263509Sdim } 260263509Sdim 261263509Sdim /* 262263509Sdim * Ok, store metadata (use disk number as priority). 263263509Sdim */ 264263509Sdim for (i = 1; i < *nargs; i++) { 265263509Sdim snprintf(param, sizeof(param), "arg%u", i); 266263509Sdim str = gctl_get_asciiparam(req, param); 267263509Sdim 268263509Sdim msize = g_get_mediasize(str); 269263509Sdim ssize = g_get_sectorsize(str); 270263509Sdim if (mediasize < msize - ssize) { 271263509Sdim fprintf(stderr, 272263509Sdim "warning: %s: only %jd bytes from %jd bytes used.\n", 273263509Sdim str, (intmax_t)mediasize, (intmax_t)(msize - ssize)); 274263509Sdim } 275263509Sdim 276263509Sdim md.md_no = i - 1; 277263509Sdim md.md_provsize = msize; 278263509Sdim if (!*hardcode) 279263509Sdim bzero(md.md_provider, sizeof(md.md_provider)); 280263509Sdim else { 281263509Sdim if (strncmp(str, _PATH_DEV, strlen(_PATH_DEV)) == 0) 282263509Sdim str += strlen(_PATH_DEV); 283263509Sdim strlcpy(md.md_provider, str, sizeof(md.md_provider)); 284263509Sdim } 285263509Sdim if (*verify && md.md_no == md.md_all - 1) { 286263509Sdim /* 287263509Sdim * In "verify" mode, force synchronization of parity 288263509Sdim * component on start. 289263509Sdim */ 290263509Sdim md.md_syncid = 0; 291263509Sdim } 292263509Sdim raid3_metadata_encode(&md, sector); 293263509Sdim error = g_metadata_store(str, sector, sizeof(sector)); 294263509Sdim if (error != 0) { 295263509Sdim fprintf(stderr, "Can't store metadata on %s: %s.\n", 296263509Sdim str, strerror(error)); 297263509Sdim gctl_error(req, "Not fully done."); 298263509Sdim continue; 299263509Sdim } 300263509Sdim if (verbose) 301263509Sdim printf("Metadata value stored on %s.\n", str); 302263509Sdim } 303263509Sdim} 304235633Sdim 305218887Sdimstatic void 306218887Sdimraid3_clear(struct gctl_req *req) 307218887Sdim{ 308218887Sdim const char *name; 309218887Sdim char param[16]; 310252723Sdim int *nargs, error, i; 311218887Sdim 312252723Sdim nargs = gctl_get_paraml(req, "nargs", sizeof(*nargs)); 313218887Sdim if (nargs == NULL) { 314226890Sdim gctl_error(req, "No '%s' argument.", "nargs"); 315252723Sdim return; 316218887Sdim } 317218887Sdim if (*nargs < 1) { 318218887Sdim gctl_error(req, "Too few arguments."); 319218887Sdim return; 320218887Sdim } 321226890Sdim 322218887Sdim for (i = 0; i < *nargs; i++) { 323218887Sdim snprintf(param, sizeof(param), "arg%u", i); 324235633Sdim name = gctl_get_asciiparam(req, param); 325235633Sdim 326218887Sdim error = g_metadata_clear(name, G_RAID3_MAGIC); 327252723Sdim if (error != 0) { 328226890Sdim fprintf(stderr, "Can't clear metadata on %s: %s.\n", 329218887Sdim name, strerror(error)); 330235633Sdim gctl_error(req, "Not fully done."); 331235633Sdim continue; 332218887Sdim } 333226890Sdim if (verbose) 334218887Sdim printf("Metadata cleared on %s.\n", name); 335226890Sdim } 336226890Sdim} 337218887Sdim 338226890Sdimstatic void 339226890Sdimraid3_dump(struct gctl_req *req) 340218887Sdim{ 341235633Sdim struct g_raid3_metadata md, tmpmd; 342235633Sdim const char *name; 343218887Sdim char param[16]; 344218887Sdim int *nargs, error, i; 345218887Sdim 346218887Sdim nargs = gctl_get_paraml(req, "nargs", sizeof(*nargs)); 347218887Sdim if (nargs == NULL) { 348218887Sdim gctl_error(req, "No '%s' argument.", "nargs"); 349218887Sdim return; 350218887Sdim } 351218887Sdim if (*nargs < 1) { 352226890Sdim gctl_error(req, "Too few arguments."); 353226890Sdim return; 354218887Sdim } 355218887Sdim 356218887Sdim for (i = 0; i < *nargs; i++) { 357218887Sdim snprintf(param, sizeof(param), "arg%u", i); 358218887Sdim name = gctl_get_asciiparam(req, param); 359218887Sdim 360218887Sdim error = g_metadata_read(name, (u_char *)&tmpmd, sizeof(tmpmd), 361218887Sdim G_RAID3_MAGIC); 362218887Sdim if (error != 0) { 363226890Sdim fprintf(stderr, "Can't read metadata from %s: %s.\n", 364252723Sdim name, strerror(error)); 365235633Sdim gctl_error(req, "Not fully done."); 366218887Sdim continue; 367226890Sdim } 368226890Sdim if (raid3_metadata_decode((u_char *)&tmpmd, &md) != 0) { 369218887Sdim fprintf(stderr, "MD5 hash mismatch for %s, skipping.\n", 370218887Sdim name); 371218887Sdim gctl_error(req, "Not fully done."); 372226890Sdim continue; 373226890Sdim } 374218887Sdim printf("Metadata on %s:\n", name); 375218887Sdim raid3_metadata_dump(&md); 376218887Sdim printf("\n"); 377218887Sdim } 378218887Sdim} 379218887Sdim