1 /*- 2 * Copyright (c) 2000-2004 Poul-Henning Kamp <phk@FreeBSD.org> 3 * Copyright (c) 2012 The FreeBSD Foundation 4 * All rights reserved. 5 * 6 * Portions of this software were developed by Edward Tomasz Napierala 7 * under sponsorship from the FreeBSD Foundation. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 12 * 1. Redistributions of source code must retain the above copyright 13 * notice, this list of conditions and the following disclaimer. 14 * 2. Redistributions in binary form must reproduce the above copyright 15 * notice, this list of conditions and the following disclaimer in the 16 * documentation and/or other materials provided with the distribution. 17 * 18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 21 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 28 * SUCH DAMAGE. 29 * 30 * $FreeBSD$ 31 */ 32 33 #include <sys/param.h> 34 #include <sys/devicestat.h> 35 #include <sys/ioctl.h> 36 #include <sys/linker.h> 37 #include <sys/mdioctl.h> 38 #include <sys/module.h> 39 #include <sys/resource.h> 40 #include <sys/stat.h> 41 42 #include <assert.h> 43 #include <devstat.h> 44 #include <err.h> 45 #include <errno.h> 46 #include <fcntl.h> 47 #include <inttypes.h> 48 #include <libgeom.h> 49 #include <libutil.h> 50 #include <paths.h> 51 #include <stdarg.h> 52 #include <stdio.h> 53 #include <stdlib.h> 54 #include <string.h> 55 #include <unistd.h> 56 57 static struct md_ioctl mdio; 58 static enum {UNSET, ATTACH, DETACH, RESIZE, LIST} action = UNSET; 59 static int nflag; 60 61 static void usage(void); 62 static void md_set_file(const char *); 63 static int md_find(const char *, const char *); 64 static int md_query(const char *, const int, const char *); 65 static int md_list(const char *, int, const char *); 66 static char *geom_config_get(struct gconf *g, const char *name); 67 static void md_prthumanval(char *length); 68 69 #define OPT_VERBOSE 0x01 70 #define OPT_UNIT 0x02 71 #define OPT_DONE 0x04 72 #define OPT_LIST 0x10 73 74 #define CLASS_NAME_MD "MD" 75 76 static void 77 usage(void) 78 { 79 80 fprintf(stderr, 81 "usage: mdconfig -a -t type [-n] [-o [no]option] ... [-f file]\n" 82 " [-s size] [-S sectorsize] [-u unit]\n" 83 " [-x sectors/track] [-y heads/cylinder]\n" 84 " mdconfig -d -u unit [-o [no]force]\n" 85 " mdconfig -r -u unit -s size [-o [no]force]\n" 86 " mdconfig -l [-v] [-n] [-f file] [-u unit]\n" 87 " mdconfig file\n"); 88 fprintf(stderr, "\t\ttype = {malloc, vnode, swap}\n"); 89 fprintf(stderr, "\t\toption = {cluster, compress, reserve}\n"); 90 fprintf(stderr, "\t\tsize = %%d (512 byte blocks), %%db (B),\n"); 91 fprintf(stderr, "\t\t %%dk (kB), %%dm (MB), %%dg (GB) or\n"); 92 fprintf(stderr, "\t\t %%dt (TB)\n"); 93 exit(1); 94 } 95 96 int 97 main(int argc, char **argv) 98 { 99 int ch, fd, i, vflag; 100 char *p; 101 char *fflag = NULL, *sflag = NULL, *tflag = NULL, *uflag = NULL; 102 103 bzero(&mdio, sizeof(mdio)); 104 mdio.md_file = malloc(PATH_MAX); 105 if (mdio.md_file == NULL) 106 err(1, "could not allocate memory"); 107 vflag = 0; 108 bzero(mdio.md_file, PATH_MAX); 109 110 if (argc == 1) 111 usage(); 112 113 while ((ch = getopt(argc, argv, "ab:df:lno:rs:S:t:u:vx:y:")) != -1) { 114 switch (ch) { 115 case 'a': 116 if (action != UNSET && action != ATTACH) 117 errx(1, "-a is mutually exclusive " 118 "with -d, -r, and -l"); 119 action = ATTACH; 120 break; 121 case 'd': 122 if (action != UNSET && action != DETACH) 123 errx(1, "-d is mutually exclusive " 124 "with -a, -r, and -l"); 125 action = DETACH; 126 mdio.md_options |= MD_AUTOUNIT; 127 break; 128 case 'r': 129 if (action != UNSET && action != RESIZE) 130 errx(1, "-r is mutually exclusive " 131 "with -a, -d, and -l"); 132 action = RESIZE; 133 mdio.md_options |= MD_AUTOUNIT; 134 break; 135 case 'l': 136 if (action != UNSET && action != LIST) 137 errx(1, "-l is mutually exclusive " 138 "with -a, -r, and -d"); 139 action = LIST; 140 mdio.md_options |= MD_AUTOUNIT; 141 break; 142 case 'n': 143 nflag = 1; 144 break; 145 case 't': 146 if (tflag != NULL) 147 errx(1, "-t can be passed only once"); 148 tflag = optarg; 149 if (!strcmp(optarg, "malloc")) { 150 mdio.md_type = MD_MALLOC; 151 mdio.md_options |= MD_AUTOUNIT | MD_COMPRESS; 152 } else if (!strcmp(optarg, "vnode")) { 153 mdio.md_type = MD_VNODE; 154 mdio.md_options |= MD_CLUSTER | MD_AUTOUNIT | MD_COMPRESS; 155 } else if (!strcmp(optarg, "swap")) { 156 mdio.md_type = MD_SWAP; 157 mdio.md_options |= MD_CLUSTER | MD_AUTOUNIT | MD_COMPRESS; 158 } else 159 errx(1, "unknown type: %s", optarg); 160 break; 161 case 'f': 162 if (fflag != NULL) 163 errx(1, "-f can be passed only once"); 164 fflag = realpath(optarg, NULL); 165 if (fflag == NULL) 166 err(1, "realpath"); 167 break; 168 case 'o': 169 if (!strcmp(optarg, "async")) 170 mdio.md_options |= MD_ASYNC; 171 else if (!strcmp(optarg, "noasync")) 172 mdio.md_options &= ~MD_ASYNC; 173 else if (!strcmp(optarg, "cluster")) 174 mdio.md_options |= MD_CLUSTER; 175 else if (!strcmp(optarg, "nocluster")) 176 mdio.md_options &= ~MD_CLUSTER; 177 else if (!strcmp(optarg, "compress")) 178 mdio.md_options |= MD_COMPRESS; 179 else if (!strcmp(optarg, "nocompress")) 180 mdio.md_options &= ~MD_COMPRESS; 181 else if (!strcmp(optarg, "force")) 182 mdio.md_options |= MD_FORCE; 183 else if (!strcmp(optarg, "noforce")) 184 mdio.md_options &= ~MD_FORCE; 185 else if (!strcmp(optarg, "readonly")) 186 mdio.md_options |= MD_READONLY; 187 else if (!strcmp(optarg, "noreadonly")) 188 mdio.md_options &= ~MD_READONLY; 189 else if (!strcmp(optarg, "reserve")) 190 mdio.md_options |= MD_RESERVE; 191 else if (!strcmp(optarg, "noreserve")) 192 mdio.md_options &= ~MD_RESERVE; 193 else 194 errx(1, "unknown option: %s", optarg); 195 break; 196 case 'S': 197 mdio.md_sectorsize = strtoul(optarg, &p, 0); 198 break; 199 case 's': 200 if (sflag != NULL) 201 errx(1, "-s can be passed only once"); 202 sflag = optarg; 203 mdio.md_mediasize = (off_t)strtoumax(optarg, &p, 0); 204 if (p == NULL || *p == '\0') 205 mdio.md_mediasize *= DEV_BSIZE; 206 else if (*p == 'b' || *p == 'B') 207 ; /* do nothing */ 208 else if (*p == 'k' || *p == 'K') 209 mdio.md_mediasize <<= 10; 210 else if (*p == 'm' || *p == 'M') 211 mdio.md_mediasize <<= 20; 212 else if (*p == 'g' || *p == 'G') 213 mdio.md_mediasize <<= 30; 214 else if (*p == 't' || *p == 'T') { 215 mdio.md_mediasize <<= 30; 216 mdio.md_mediasize <<= 10; 217 } else 218 errx(1, "unknown suffix on -s argument"); 219 break; 220 case 'u': 221 if (!strncmp(optarg, _PATH_DEV, sizeof(_PATH_DEV) - 1)) 222 optarg += sizeof(_PATH_DEV) - 1; 223 if (!strncmp(optarg, MD_NAME, sizeof(MD_NAME) - 1)) 224 optarg += sizeof(MD_NAME) - 1; 225 uflag = optarg; 226 break; 227 case 'v': 228 vflag = OPT_VERBOSE; 229 break; 230 case 'x': 231 mdio.md_fwsectors = strtoul(optarg, &p, 0); 232 break; 233 case 'y': 234 mdio.md_fwheads = strtoul(optarg, &p, 0); 235 break; 236 default: 237 usage(); 238 } 239 } 240 241 argc -= optind; 242 argv += optind; 243 244 if (action == UNSET) 245 action = ATTACH; 246 247 if (action == ATTACH) { 248 if (tflag == NULL) { 249 /* 250 * Try to infer the type based on other arguments. 251 */ 252 if (fflag != NULL || argc > 0) { 253 /* Imply ``-t vnode'' */ 254 mdio.md_type = MD_VNODE; 255 mdio.md_options |= MD_CLUSTER | MD_AUTOUNIT | 256 MD_COMPRESS; 257 } else if (sflag != NULL) { 258 /* Imply ``-t swap'' */ 259 mdio.md_type = MD_SWAP; 260 mdio.md_options |= MD_CLUSTER | MD_AUTOUNIT | 261 MD_COMPRESS; 262 } else 263 errx(1, "unable to determine type"); 264 } 265 266 if ((fflag != NULL || argc > 0) && mdio.md_type != MD_VNODE) 267 errx(1, "only -t vnode can be used with file name"); 268 269 if (mdio.md_type == MD_VNODE) { 270 if (fflag != NULL) { 271 if (argc != 0) 272 usage(); 273 md_set_file(fflag); 274 } else { 275 if (argc != 1) 276 usage(); 277 md_set_file(*argv); 278 } 279 280 if ((mdio.md_options & MD_READONLY) == 0 && 281 access(mdio.md_file, W_OK) < 0 && 282 (errno == EACCES || errno == EPERM || 283 errno == EROFS)) { 284 warnx("WARNING: opening backing store: %s " 285 "readonly", mdio.md_file); 286 mdio.md_options |= MD_READONLY; 287 } 288 } 289 290 if ((mdio.md_type == MD_MALLOC || mdio.md_type == MD_SWAP) && 291 sflag == NULL) 292 errx(1, "must specify -s for -t malloc or -t swap"); 293 if (mdio.md_type == MD_VNODE && mdio.md_file[0] == '\0') 294 errx(1, "must specify -f for -t vnode"); 295 } else { 296 if (mdio.md_sectorsize != 0) 297 errx(1, "-S can only be used with -a"); 298 if (action != RESIZE && sflag != NULL) 299 errx(1, "-s can only be used with -a and -r"); 300 if (mdio.md_fwsectors != 0) 301 errx(1, "-x can only be used with -a"); 302 if (mdio.md_fwheads != 0) 303 errx(1, "-y can only be used with -a"); 304 if (fflag != NULL && action != LIST) 305 errx(1, "-f can only be used with -a and -l"); 306 if (tflag != NULL) 307 errx(1, "-t can only be used with -a"); 308 if (argc > 0) 309 errx(1, "file can only be used with -a"); 310 if ((action != DETACH && action != RESIZE) && 311 (mdio.md_options & ~MD_AUTOUNIT) != 0) 312 errx(1, "-o can only be used with -a, -d, and -r"); 313 if (action == DETACH && 314 (mdio.md_options & ~(MD_FORCE | MD_AUTOUNIT)) != 0) 315 errx(1, "only -o [no]force can be used with -d"); 316 if (action == RESIZE && 317 (mdio.md_options & ~(MD_FORCE | MD_RESERVE | MD_AUTOUNIT)) != 0) 318 errx(1, "only -o [no]force and -o [no]reserve can be used with -r"); 319 } 320 321 if (action == RESIZE && sflag == NULL) 322 errx(1, "must specify -s for -r"); 323 324 if (action != LIST && vflag == OPT_VERBOSE) 325 errx(1, "-v can only be used with -l"); 326 327 if (uflag != NULL) { 328 mdio.md_unit = strtoul(uflag, &p, 0); 329 if (mdio.md_unit == (unsigned)ULONG_MAX || *p != '\0') 330 errx(1, "bad unit: %s", uflag); 331 mdio.md_options &= ~MD_AUTOUNIT; 332 } 333 334 mdio.md_version = MDIOVERSION; 335 336 if (!kld_isloaded("g_md") && kld_load("geom_md") == -1) 337 err(1, "failed to load geom_md module"); 338 339 fd = open(_PATH_DEV MDCTL_NAME, O_RDWR, 0); 340 if (fd < 0) 341 err(1, "open(%s%s)", _PATH_DEV, MDCTL_NAME); 342 343 if (action == ATTACH) { 344 i = ioctl(fd, MDIOCATTACH, &mdio); 345 if (i < 0) 346 err(1, "ioctl(%s%s)", _PATH_DEV, MDCTL_NAME); 347 if (mdio.md_options & MD_AUTOUNIT) 348 printf("%s%d\n", nflag ? "" : MD_NAME, mdio.md_unit); 349 } else if (action == DETACH) { 350 if (mdio.md_options & MD_AUTOUNIT) 351 errx(1, "-d requires -u"); 352 i = ioctl(fd, MDIOCDETACH, &mdio); 353 if (i < 0) 354 err(1, "ioctl(%s%s)", _PATH_DEV, MDCTL_NAME); 355 } else if (action == RESIZE) { 356 if (mdio.md_options & MD_AUTOUNIT) 357 errx(1, "-r requires -u"); 358 i = ioctl(fd, MDIOCRESIZE, &mdio); 359 if (i < 0) 360 err(1, "ioctl(%s%s)", _PATH_DEV, MDCTL_NAME); 361 } else if (action == LIST) { 362 if (mdio.md_options & MD_AUTOUNIT) { 363 /* 364 * Listing all devices. This is why we pass NULL 365 * together with OPT_LIST. 366 */ 367 return (md_list(NULL, OPT_LIST | vflag, fflag)); 368 } else 369 return (md_query(uflag, vflag, fflag)); 370 } else 371 usage(); 372 close(fd); 373 return (0); 374 } 375 376 static void 377 md_set_file(const char *fn) 378 { 379 struct stat sb; 380 int fd; 381 382 if (realpath(fn, mdio.md_file) == NULL) 383 err(1, "could not find full path for %s", fn); 384 fd = open(mdio.md_file, O_RDONLY); 385 if (fd < 0) 386 err(1, "could not open %s", fn); 387 if (fstat(fd, &sb) == -1) 388 err(1, "could not stat %s", fn); 389 if (!S_ISREG(sb.st_mode)) 390 errx(1, "%s is not a regular file", fn); 391 if (mdio.md_mediasize == 0) 392 mdio.md_mediasize = sb.st_size; 393 close(fd); 394 } 395 396 /* 397 * Lists md(4) disks. Is used also as a query routine, since it handles XML 398 * interface. 'units' can be NULL for listing memory disks. It might be 399 * coma-separated string containing md(4) disk names. 'opt' distinguished 400 * between list and query mode. 401 */ 402 static int 403 md_list(const char *units, int opt, const char *fflag) 404 { 405 struct gmesh gm; 406 struct gprovider *pp; 407 struct gconf *gc; 408 struct gident *gid; 409 struct devstat *gsp; 410 struct ggeom *gg; 411 struct gclass *gcl; 412 void *sq; 413 int retcode, ffound, ufound; 414 char *type, *file, *length; 415 416 type = file = length = NULL; 417 418 retcode = geom_gettree(&gm); 419 if (retcode != 0) 420 return (-1); 421 retcode = geom_stats_open(); 422 if (retcode != 0) 423 return (-1); 424 sq = geom_stats_snapshot_get(); 425 if (sq == NULL) 426 return (-1); 427 428 ffound = ufound = 0; 429 while ((gsp = geom_stats_snapshot_next(sq)) != NULL) { 430 gid = geom_lookupid(&gm, gsp->id); 431 if (gid == NULL) 432 continue; 433 if (gid->lg_what == ISPROVIDER) { 434 pp = gid->lg_ptr; 435 gg = pp->lg_geom; 436 gcl = gg->lg_class; 437 if (strcmp(gcl->lg_name, CLASS_NAME_MD) != 0) 438 continue; 439 if ((opt & OPT_UNIT) && (units != NULL)) { 440 retcode = md_find(units, pp->lg_name); 441 if (retcode != 1) 442 continue; 443 else 444 ufound = 1; 445 } 446 gc = &pp->lg_config; 447 type = geom_config_get(gc, "type"); 448 if (strcmp(type, "vnode") == 0) { 449 file = geom_config_get(gc, "file"); 450 if (fflag != NULL && 451 strcmp(fflag, file) != 0) 452 continue; 453 else 454 ffound = 1; 455 } else if (fflag != NULL) 456 continue; 457 if (nflag && strncmp(pp->lg_name, MD_NAME, 2) == 0) 458 printf("%s", pp->lg_name + 2); 459 else 460 printf("%s", pp->lg_name); 461 462 if (opt & OPT_VERBOSE || 463 ((opt & OPT_UNIT) && fflag == NULL)) { 464 length = geom_config_get(gc, "length"); 465 printf("\t%s\t", type); 466 if (length != NULL) 467 md_prthumanval(length); 468 if (file != NULL) { 469 printf("\t%s", file); 470 file = NULL; 471 } 472 } 473 opt |= OPT_DONE; 474 if ((opt & OPT_LIST) && !(opt & OPT_VERBOSE)) 475 printf(" "); 476 else 477 printf("\n"); 478 } 479 } 480 if ((opt & OPT_LIST) && (opt & OPT_DONE) && !(opt & OPT_VERBOSE)) 481 printf("\n"); 482 /* XXX: Check if it's enough to clean everything. */ 483 geom_stats_snapshot_free(sq); 484 if (((opt & OPT_UNIT) && (fflag == NULL) && ufound) || 485 ((opt & OPT_UNIT) == 0 && (fflag != NULL) && ffound) || 486 ((opt & OPT_UNIT) && (fflag != NULL) && ufound && ffound)) 487 return (0); 488 else 489 return (-1); 490 } 491 492 /* 493 * Returns value of 'name' from gconfig structure. 494 */ 495 static char * 496 geom_config_get(struct gconf *g, const char *name) 497 { 498 struct gconfig *gce; 499 500 LIST_FOREACH(gce, g, lg_config) { 501 if (strcmp(gce->lg_name, name) == 0) 502 return (gce->lg_val); 503 } 504 return (NULL); 505 } 506 507 /* 508 * List is comma separated list of MD disks. name is a 509 * device name we look for. Returns 1 if found and 0 510 * otherwise. 511 */ 512 static int 513 md_find(const char *list, const char *name) 514 { 515 int ret; 516 char num[PATH_MAX]; 517 char *ptr, *p, *u; 518 519 ret = 0; 520 ptr = strdup(list); 521 if (ptr == NULL) 522 return (-1); 523 for (p = ptr; (u = strsep(&p, ",")) != NULL;) { 524 if (strncmp(u, _PATH_DEV, sizeof(_PATH_DEV) - 1) == 0) 525 u += sizeof(_PATH_DEV) - 1; 526 /* Just in case user specified number instead of full name */ 527 snprintf(num, sizeof(num), "%s%s", MD_NAME, u); 528 if (strcmp(u, name) == 0 || strcmp(num, name) == 0) { 529 ret = 1; 530 break; 531 } 532 } 533 free(ptr); 534 return (ret); 535 } 536 537 static void 538 md_prthumanval(char *length) 539 { 540 char buf[6]; 541 uintmax_t bytes; 542 char *endptr; 543 544 errno = 0; 545 bytes = strtoumax(length, &endptr, 10); 546 if (errno != 0 || *endptr != '\0' || bytes > INT64_MAX) 547 return; 548 humanize_number(buf, sizeof(buf), (int64_t)bytes, "", 549 HN_AUTOSCALE, HN_B | HN_NOSPACE | HN_DECIMAL); 550 (void)printf("%6s", buf); 551 } 552 553 static int 554 md_query(const char *name, const int opt, const char *fflag) 555 { 556 557 return (md_list(name, opt | OPT_UNIT, fflag)); 558 } 559