sbin/mdconfig/mdconfig.c

   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 if (!strcmp(optarg, "null")) {
 159                                 mdio.md_type = MD_NULL;
 160                                 mdio.md_options |= MD_CLUSTER | MD_AUTOUNIT | MD_COMPRESS;
 161                         } else
 162                                 errx(1, "unknown type: %s", optarg);
 163                         break;
 164                 case 'f':
 165                         if (fflag != NULL)
 166                                 errx(1, "-f can be passed only once");
 167                         fflag = realpath(optarg, NULL);
 168                         if (fflag == NULL)
 169                                 err(1, "realpath");
 170                         break;
 171                 case 'o':
 172                         if (!strcmp(optarg, "async"))
 173                                 mdio.md_options |= MD_ASYNC;
 174                         else if (!strcmp(optarg, "noasync"))
 175                                 mdio.md_options &= ~MD_ASYNC;
 176                         else if (!strcmp(optarg, "cluster"))
 177                                 mdio.md_options |= MD_CLUSTER;
 178                         else if (!strcmp(optarg, "nocluster"))
 179                                 mdio.md_options &= ~MD_CLUSTER;
 180                         else if (!strcmp(optarg, "compress"))
 181                                 mdio.md_options |= MD_COMPRESS;
 182                         else if (!strcmp(optarg, "nocompress"))
 183                                 mdio.md_options &= ~MD_COMPRESS;
 184                         else if (!strcmp(optarg, "force"))
 185                                 mdio.md_options |= MD_FORCE;
 186                         else if (!strcmp(optarg, "noforce"))
 187                                 mdio.md_options &= ~MD_FORCE;
 188                         else if (!strcmp(optarg, "readonly"))
 189                                 mdio.md_options |= MD_READONLY;
 190                         else if (!strcmp(optarg, "noreadonly"))
 191                                 mdio.md_options &= ~MD_READONLY;
 192                         else if (!strcmp(optarg, "reserve"))
 193                                 mdio.md_options |= MD_RESERVE;
 194                         else if (!strcmp(optarg, "noreserve"))
 195                                 mdio.md_options &= ~MD_RESERVE;
 196                         else
 197                                 errx(1, "unknown option: %s", optarg);
 198                         break;
 199                 case 'S':
 200                         mdio.md_sectorsize = strtoul(optarg, &p, 0);
 201                         break;
 202                 case 's':
 203                         if (sflag != NULL)
 204                                 errx(1, "-s can be passed only once");
 205                         sflag = optarg;
 206                         mdio.md_mediasize = (off_t)strtoumax(optarg, &p, 0);
 207                         if (p == NULL || *p == '\0')
 208                                 mdio.md_mediasize *= DEV_BSIZE;
 209                         else if (*p == 'b' || *p == 'B')
 210                                 ; /* do nothing */
 211                         else if (*p == 'k' || *p == 'K')
 212                                 mdio.md_mediasize <<= 10;
 213                         else if (*p == 'm' || *p == 'M')
 214                                 mdio.md_mediasize <<= 20;
 215                         else if (*p == 'g' || *p == 'G')
 216                                 mdio.md_mediasize <<= 30;
 217                         else if (*p == 't' || *p == 'T') {
 218                                 mdio.md_mediasize <<= 30;
 219                                 mdio.md_mediasize <<= 10;
 220                         } else
 221                                 errx(1, "unknown suffix on -s argument");
 222                         break;
 223                 case 'u':
 224                         if (!strncmp(optarg, _PATH_DEV, sizeof(_PATH_DEV) - 1))
 225                                 optarg += sizeof(_PATH_DEV) - 1;
 226                         if (!strncmp(optarg, MD_NAME, sizeof(MD_NAME) - 1))
 227                                 optarg += sizeof(MD_NAME) - 1;
 228                         uflag = optarg;
 229                         break;
 230                 case 'v':
 231                         vflag = OPT_VERBOSE;
 232                         break;
 233                 case 'x':
 234                         mdio.md_fwsectors = strtoul(optarg, &p, 0);
 235                         break;
 236                 case 'y':
 237                         mdio.md_fwheads = strtoul(optarg, &p, 0);
 238                         break;
 239                 default:
 240                         usage();
 241                 }
 242         }
 243
 244         argc -= optind;
 245         argv += optind;
 246
 247         if (action == UNSET)
 248                 action = ATTACH;
 249
 250         if (action == ATTACH) {
 251                 if (tflag == NULL) {
 252                         /*
 253                          * Try to infer the type based on other arguments.
 254                          */
 255                         if (fflag != NULL || argc > 0) {
 256                                 /* Imply ``-t vnode'' */
 257                                 mdio.md_type = MD_VNODE;
 258                                 mdio.md_options |= MD_CLUSTER | MD_AUTOUNIT |
 259                                     MD_COMPRESS;
 260                         } else if (sflag != NULL) {
 261                                 /* Imply ``-t swap'' */
 262                                 mdio.md_type = MD_SWAP;
 263                                 mdio.md_options |= MD_CLUSTER | MD_AUTOUNIT |
 264                                     MD_COMPRESS;
 265                         } else
 266                                 errx(1, "unable to determine type");
 267                 }
 268
 269                 if ((fflag != NULL || argc > 0) && mdio.md_type != MD_VNODE)
 270                         errx(1, "only -t vnode can be used with file name");
 271
 272                 if (mdio.md_type == MD_VNODE) {
 273                         if (fflag != NULL) {
 274                                 if (argc != 0)
 275                                         usage();
 276                                 md_set_file(fflag);
 277                         } else {
 278                                 if (argc != 1)
 279                                         usage();
 280                                 md_set_file(*argv);
 281                         }
 282
 283                         if ((mdio.md_options & MD_READONLY) == 0 &&
 284                             access(mdio.md_file, W_OK) < 0 &&
 285                             (errno == EACCES || errno == EPERM ||
 286                              errno == EROFS)) {
 287                                 warnx("WARNING: opening backing store: %s "
 288                                     "readonly", mdio.md_file);
 289                                 mdio.md_options |= MD_READONLY;
 290                         }
 291                 }
 292
 293                 if ((mdio.md_type == MD_MALLOC || mdio.md_type == MD_SWAP ||
 294                     mdio.md_type == MD_NULL) && sflag == NULL)
 295                         errx(1, "must specify -s for -t malloc, -t swap, "
 296                             "or -t null");
 297                 if (mdio.md_type == MD_VNODE && mdio.md_file[0] == '\0')
 298                         errx(1, "must specify -f for -t vnode");
 299         } else {
 300                 if (mdio.md_sectorsize != 0)
 301                         errx(1, "-S can only be used with -a");
 302                 if (action != RESIZE && sflag != NULL)
 303                         errx(1, "-s can only be used with -a and -r");
 304                 if (mdio.md_fwsectors != 0)
 305                         errx(1, "-x can only be used with -a");
 306                 if (mdio.md_fwheads != 0)
 307                         errx(1, "-y can only be used with -a");
 308                 if (fflag != NULL && action != LIST)
 309                         errx(1, "-f can only be used with -a and -l");
 310                 if (tflag != NULL)
 311                         errx(1, "-t can only be used with -a");
 312                 if (argc > 0)
 313                         errx(1, "file can only be used with -a");
 314                 if ((action != DETACH && action != RESIZE) &&
 315                     (mdio.md_options & ~MD_AUTOUNIT) != 0)
 316                         errx(1, "-o can only be used with -a, -d, and -r");
 317                 if (action == DETACH &&
 318                     (mdio.md_options & ~(MD_FORCE | MD_AUTOUNIT)) != 0)
 319                         errx(1, "only -o [no]force can be used with -d");
 320                 if (action == RESIZE &&
 321                     (mdio.md_options & ~(MD_FORCE | MD_RESERVE | MD_AUTOUNIT)) != 0)
 322                         errx(1, "only -o [no]force and -o [no]reserve can be used with -r");
 323         }
 324
 325         if (action == RESIZE && sflag == NULL)
 326                 errx(1, "must specify -s for -r");
 327
 328         if (action != LIST && vflag == OPT_VERBOSE)
 329                 errx(1, "-v can only be used with -l");
 330
 331         if (uflag != NULL) {
 332                 mdio.md_unit = strtoul(uflag, &p, 0);
 333                 if (mdio.md_unit == (unsigned)ULONG_MAX || *p != '\0')
 334                         errx(1, "bad unit: %s", uflag);
 335                 mdio.md_options &= ~MD_AUTOUNIT;
 336         }
 337
 338         mdio.md_version = MDIOVERSION;
 339
 340         if (!kld_isloaded("g_md") && kld_load("geom_md") == -1)
 341                 err(1, "failed to load geom_md module");
 342
 343         fd = open(_PATH_DEV MDCTL_NAME, O_RDWR, 0);
 344         if (fd < 0)
 345                 err(1, "open(%s%s)", _PATH_DEV, MDCTL_NAME);
 346
 347         if (action == ATTACH) {
 348                 i = ioctl(fd, MDIOCATTACH, &mdio);
 349                 if (i < 0)
 350                         err(1, "ioctl(%s%s)", _PATH_DEV, MDCTL_NAME);
 351                 if (mdio.md_options & MD_AUTOUNIT)
 352                         printf("%s%d\n", nflag ? "" : MD_NAME, mdio.md_unit);
 353         } else if (action == DETACH) {
 354                 if (mdio.md_options & MD_AUTOUNIT)
 355                         errx(1, "-d requires -u");
 356                 i = ioctl(fd, MDIOCDETACH, &mdio);
 357                 if (i < 0)
 358                         err(1, "ioctl(%s%s)", _PATH_DEV, MDCTL_NAME);
 359         } else if (action == RESIZE) {
 360                 if (mdio.md_options & MD_AUTOUNIT)
 361                         errx(1, "-r requires -u");
 362                 i = ioctl(fd, MDIOCRESIZE, &mdio);
 363                 if (i < 0)
 364                         err(1, "ioctl(%s%s)", _PATH_DEV, MDCTL_NAME);
 365         } else if (action == LIST) {
 366                 if (mdio.md_options & MD_AUTOUNIT) {
 367                         /*
 368                          * Listing all devices. This is why we pass NULL
 369                          * together with OPT_LIST.
 370                          */
 371                         return (md_list(NULL, OPT_LIST | vflag, fflag));
 372                 } else
 373                         return (md_query(uflag, vflag, fflag));
 374         } else
 375                 usage();
 376         close(fd);
 377         return (0);
 378 }
 379
 380 static void
 381 md_set_file(const char *fn)
 382 {
 383         struct stat sb;
 384         int fd;
 385
 386         if (realpath(fn, mdio.md_file) == NULL)
 387                 err(1, "could not find full path for %s", fn);
 388         fd = open(mdio.md_file, O_RDONLY);
 389         if (fd < 0)
 390                 err(1, "could not open %s", fn);
 391         if (fstat(fd, &sb) == -1)
 392                 err(1, "could not stat %s", fn);
 393         if (!S_ISREG(sb.st_mode))
 394                 errx(1, "%s is not a regular file", fn);
 395         if (mdio.md_mediasize == 0)
 396                 mdio.md_mediasize = sb.st_size;
 397         close(fd);
 398 }
 399
 400 /*
 401  * Lists md(4) disks. Is used also as a query routine, since it handles XML
 402  * interface. 'units' can be NULL for listing memory disks. It might be
 403  * coma-separated string containing md(4) disk names. 'opt' distinguished
 404  * between list and query mode.
 405  */
 406 static int
 407 md_list(const char *units, int opt, const char *fflag)
 408 {
 409         struct gmesh gm;
 410         struct gprovider *pp;
 411         struct gconf *gc;
 412         struct gident *gid;
 413         struct devstat *gsp;
 414         struct ggeom *gg;
 415         struct gclass *gcl;
 416         void *sq;
 417         int retcode, ffound, ufound;
 418         char *type, *file, *length;
 419
 420         type = file = length = NULL;
 421
 422         retcode = geom_gettree(&gm);
 423         if (retcode != 0)
 424                 return (-1);
 425         retcode = geom_stats_open();
 426         if (retcode != 0)
 427                 return (-1);
 428         sq = geom_stats_snapshot_get();
 429         if (sq == NULL)
 430                 return (-1);
 431
 432         ffound = ufound = 0;
 433         while ((gsp = geom_stats_snapshot_next(sq)) != NULL) {
 434                 gid = geom_lookupid(&gm, gsp->id);
 435                 if (gid == NULL)
 436                         continue;
 437                 if (gid->lg_what == ISPROVIDER) {
 438                         pp = gid->lg_ptr;
 439                         gg = pp->lg_geom;
 440                         gcl = gg->lg_class;
 441                         if (strcmp(gcl->lg_name, CLASS_NAME_MD) != 0)
 442                                 continue;
 443                         if ((opt & OPT_UNIT) && (units != NULL)) {
 444                                 retcode = md_find(units, pp->lg_name);
 445                                 if (retcode != 1)
 446                                         continue;
 447                                 else
 448                                         ufound = 1;
 449                         }
 450                         gc = &pp->lg_config;
 451                         type = geom_config_get(gc, "type");
 452                         if (strcmp(type, "vnode") == 0) {
 453                                 file = geom_config_get(gc, "file");
 454                                 if (fflag != NULL &&
 455                                     strcmp(fflag, file) != 0)
 456                                         continue;
 457                                 else
 458                                         ffound = 1;
 459                         } else if (fflag != NULL)
 460                                         continue;
 461                         if (nflag && strncmp(pp->lg_name, MD_NAME, 2) == 0)
 462                                 printf("%s", pp->lg_name + 2);
 463                         else
 464                                 printf("%s", pp->lg_name);
 465
 466                         if (opt & OPT_VERBOSE ||
 467                             ((opt & OPT_UNIT) && fflag == NULL)) {
 468                                 length = geom_config_get(gc, "length");
 469                                 printf("\t%s\t", type);
 470                                 if (length != NULL)
 471                                         md_prthumanval(length);
 472                                 if (file != NULL) {
 473                                         printf("\t%s", file);
 474                                         file = NULL;
 475                                 }
 476                         }
 477                         opt |= OPT_DONE;
 478                         if ((opt & OPT_LIST) && !(opt & OPT_VERBOSE))
 479                                 printf(" ");
 480                         else
 481                                 printf("\n");
 482                 }
 483         }
 484         if ((opt & OPT_LIST) && (opt & OPT_DONE) && !(opt & OPT_VERBOSE))
 485                 printf("\n");
 486         /* XXX: Check if it's enough to clean everything. */
 487         geom_stats_snapshot_free(sq);
 488         if (opt & OPT_UNIT) {
 489                 if (((fflag == NULL) && ufound) ||
 490                     ((fflag == NULL) && (units != NULL) && ufound) ||
 491                     ((fflag != NULL) && ffound) ||
 492                     ((fflag != NULL) && (units != NULL) && ufound && ffound))
 493                         return (0);
 494         } else if (opt & OPT_LIST) {
 495                 if ((fflag == NULL) ||
 496                     ((fflag != NULL) && ffound))
 497                         return (0);
 498         }
 499         return (-1);
 500 }
 501
 502 /*
 503  * Returns value of 'name' from gconfig structure.
 504  */
 505 static char *
 506 geom_config_get(struct gconf *g, const char *name)
 507 {
 508         struct gconfig *gce;
 509
 510         LIST_FOREACH(gce, g, lg_config) {
 511                 if (strcmp(gce->lg_name, name) == 0)
 512                         return (gce->lg_val);
 513         }
 514         return (NULL);
 515 }
 516
 517 /*
 518  * List is comma separated list of MD disks. name is a
 519  * device name we look for.  Returns 1 if found and 0
 520  * otherwise.
 521  */
 522 static int
 523 md_find(const char *list, const char *name)
 524 {
 525         int ret;
 526         char num[PATH_MAX];
 527         char *ptr, *p, *u;
 528
 529         ret = 0;
 530         ptr = strdup(list);
 531         if (ptr == NULL)
 532                 return (-1);
 533         for (p = ptr; (u = strsep(&p, ",")) != NULL;) {
 534                 if (strncmp(u, _PATH_DEV, sizeof(_PATH_DEV) - 1) == 0)
 535                         u += sizeof(_PATH_DEV) - 1;
 536                 /* Just in case user specified number instead of full name */
 537                 snprintf(num, sizeof(num), "%s%s", MD_NAME, u);
 538                 if (strcmp(u, name) == 0 || strcmp(num, name) == 0) {
 539                         ret = 1;
 540                         break;
 541                 }
 542         }
 543         free(ptr);
 544         return (ret);
 545 }
 546
 547 static void
 548 md_prthumanval(char *length)
 549 {
 550         char buf[6];
 551         uintmax_t bytes;
 552         char *endptr;
 553
 554         errno = 0;
 555         bytes = strtoumax(length, &endptr, 10);
 556         if (errno != 0 || *endptr != '\0' || bytes > INT64_MAX)
 557                 return;
 558         humanize_number(buf, sizeof(buf), (int64_t)bytes, "",
 559             HN_AUTOSCALE, HN_B | HN_NOSPACE | HN_DECIMAL);
 560         (void)printf("%6s", buf);
 561 }
 562
 563 static int
 564 md_query(const char *name, const int opt, const char *fflag)
 565 {
 566
 567         return (md_list(name, opt | OPT_UNIT, fflag));
 568 }