2 * Copyright (c) 2000-2004 Poul-Henning Kamp <phk@FreeBSD.org>
3 * Copyright (c) 2012 The FreeBSD Foundation
6 * Portions of this software were developed by Edward Tomasz Napierala
7 * under sponsorship from the FreeBSD Foundation.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
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.
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
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>
57 static struct md_ioctl mdio;
58 static enum {UNSET, ATTACH, DETACH, RESIZE, LIST} action = UNSET;
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);
69 #define OPT_VERBOSE 0x01
74 #define CLASS_NAME_MD "MD"
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"
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), \n");
92 fprintf(stderr, "\t\t %%dt (TB), or %%dp (PB)\n");
97 main(int argc, char **argv)
101 char *fflag = NULL, *sflag = NULL, *tflag = NULL, *uflag = NULL;
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");
108 bzero(mdio.md_file, PATH_MAX);
113 while ((ch = getopt(argc, argv, "ab:df:lno:rs:S:t:u:vx:y:")) != -1) {
116 if (action != UNSET && action != ATTACH)
117 errx(1, "-a is mutually exclusive "
118 "with -d, -r, and -l");
122 if (action != UNSET && action != DETACH)
123 errx(1, "-d is mutually exclusive "
124 "with -a, -r, and -l");
126 mdio.md_options |= MD_AUTOUNIT;
129 if (action != UNSET && action != RESIZE)
130 errx(1, "-r is mutually exclusive "
131 "with -a, -d, and -l");
133 mdio.md_options |= MD_AUTOUNIT;
136 if (action != UNSET && action != LIST)
137 errx(1, "-l is mutually exclusive "
138 "with -a, -r, and -d");
140 mdio.md_options |= MD_AUTOUNIT;
147 errx(1, "-t can be passed only once");
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;
162 errx(1, "unknown type: %s", optarg);
166 errx(1, "-f can be passed only once");
167 fflag = realpath(optarg, NULL);
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;
197 errx(1, "unknown option: %s", optarg);
200 mdio.md_sectorsize = strtoul(optarg, &p, 0);
204 errx(1, "-s can be passed only once");
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')
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 if (*p == 'p' || *p == 'P') {
221 mdio.md_mediasize <<= 30;
222 mdio.md_mediasize <<= 20;
224 errx(1, "unknown suffix on -s argument");
227 if (!strncmp(optarg, _PATH_DEV, sizeof(_PATH_DEV) - 1))
228 optarg += sizeof(_PATH_DEV) - 1;
229 if (!strncmp(optarg, MD_NAME, sizeof(MD_NAME) - 1))
230 optarg += sizeof(MD_NAME) - 1;
237 mdio.md_fwsectors = strtoul(optarg, &p, 0);
240 mdio.md_fwheads = strtoul(optarg, &p, 0);
253 if (action == ATTACH) {
256 * Try to infer the type based on other arguments.
258 if (fflag != NULL || argc > 0) {
259 /* Imply ``-t vnode'' */
260 mdio.md_type = MD_VNODE;
261 mdio.md_options |= MD_CLUSTER | MD_AUTOUNIT |
263 } else if (sflag != NULL) {
264 /* Imply ``-t swap'' */
265 mdio.md_type = MD_SWAP;
266 mdio.md_options |= MD_CLUSTER | MD_AUTOUNIT |
269 errx(1, "unable to determine type");
272 if ((fflag != NULL || argc > 0) && mdio.md_type != MD_VNODE)
273 errx(1, "only -t vnode can be used with file name");
275 if (mdio.md_type == MD_VNODE) {
286 if ((mdio.md_options & MD_READONLY) == 0 &&
287 access(mdio.md_file, W_OK) < 0 &&
288 (errno == EACCES || errno == EPERM ||
290 warnx("WARNING: opening backing store: %s "
291 "readonly", mdio.md_file);
292 mdio.md_options |= MD_READONLY;
296 if ((mdio.md_type == MD_MALLOC || mdio.md_type == MD_SWAP ||
297 mdio.md_type == MD_NULL) && sflag == NULL)
298 errx(1, "must specify -s for -t malloc, -t swap, "
300 if (mdio.md_type == MD_VNODE && mdio.md_file[0] == '\0')
301 errx(1, "must specify -f for -t vnode");
303 if (mdio.md_sectorsize != 0)
304 errx(1, "-S can only be used with -a");
305 if (action != RESIZE && sflag != NULL)
306 errx(1, "-s can only be used with -a and -r");
307 if (mdio.md_fwsectors != 0)
308 errx(1, "-x can only be used with -a");
309 if (mdio.md_fwheads != 0)
310 errx(1, "-y can only be used with -a");
311 if (fflag != NULL && action != LIST)
312 errx(1, "-f can only be used with -a and -l");
314 errx(1, "-t can only be used with -a");
316 errx(1, "file can only be used with -a");
317 if ((action != DETACH && action != RESIZE) &&
318 (mdio.md_options & ~MD_AUTOUNIT) != 0)
319 errx(1, "-o can only be used with -a, -d, and -r");
320 if (action == DETACH &&
321 (mdio.md_options & ~(MD_FORCE | MD_AUTOUNIT)) != 0)
322 errx(1, "only -o [no]force can be used with -d");
323 if (action == RESIZE &&
324 (mdio.md_options & ~(MD_FORCE | MD_RESERVE | MD_AUTOUNIT)) != 0)
325 errx(1, "only -o [no]force and -o [no]reserve can be used with -r");
328 if (action == RESIZE && sflag == NULL)
329 errx(1, "must specify -s for -r");
331 if (action != LIST && vflag == OPT_VERBOSE)
332 errx(1, "-v can only be used with -l");
335 mdio.md_unit = strtoul(uflag, &p, 0);
336 if (mdio.md_unit == (unsigned)ULONG_MAX || *p != '\0')
337 errx(1, "bad unit: %s", uflag);
338 mdio.md_options &= ~MD_AUTOUNIT;
341 mdio.md_version = MDIOVERSION;
343 if (!kld_isloaded("g_md") && kld_load("geom_md") == -1)
344 err(1, "failed to load geom_md module");
346 fd = open(_PATH_DEV MDCTL_NAME, O_RDWR, 0);
348 err(1, "open(%s%s)", _PATH_DEV, MDCTL_NAME);
350 if (action == ATTACH) {
351 i = ioctl(fd, MDIOCATTACH, &mdio);
353 err(1, "ioctl(%s%s)", _PATH_DEV, MDCTL_NAME);
354 if (mdio.md_options & MD_AUTOUNIT)
355 printf("%s%d\n", nflag ? "" : MD_NAME, mdio.md_unit);
356 } else if (action == DETACH) {
357 if (mdio.md_options & MD_AUTOUNIT)
358 errx(1, "-d requires -u");
359 i = ioctl(fd, MDIOCDETACH, &mdio);
361 err(1, "ioctl(%s%s)", _PATH_DEV, MDCTL_NAME);
362 } else if (action == RESIZE) {
363 if (mdio.md_options & MD_AUTOUNIT)
364 errx(1, "-r requires -u");
365 i = ioctl(fd, MDIOCRESIZE, &mdio);
367 err(1, "ioctl(%s%s)", _PATH_DEV, MDCTL_NAME);
368 } else if (action == LIST) {
369 if (mdio.md_options & MD_AUTOUNIT) {
371 * Listing all devices. This is why we pass NULL
372 * together with OPT_LIST.
374 return (md_list(NULL, OPT_LIST | vflag, fflag));
376 return (md_query(uflag, vflag, fflag));
384 md_set_file(const char *fn)
389 if (realpath(fn, mdio.md_file) == NULL)
390 err(1, "could not find full path for %s", fn);
391 fd = open(mdio.md_file, O_RDONLY);
393 err(1, "could not open %s", fn);
394 if (fstat(fd, &sb) == -1)
395 err(1, "could not stat %s", fn);
396 if (!S_ISREG(sb.st_mode))
397 errx(1, "%s is not a regular file", fn);
398 if (mdio.md_mediasize == 0)
399 mdio.md_mediasize = sb.st_size;
404 * Lists md(4) disks. Is used also as a query routine, since it handles XML
405 * interface. 'units' can be NULL for listing memory disks. It might be
406 * coma-separated string containing md(4) disk names. 'opt' distinguished
407 * between list and query mode.
410 md_list(const char *units, int opt, const char *fflag)
413 struct gprovider *pp;
420 int retcode, ffound, ufound;
421 char *type, *file, *length;
423 type = file = length = NULL;
425 retcode = geom_gettree(&gm);
428 retcode = geom_stats_open();
431 sq = geom_stats_snapshot_get();
436 while ((gsp = geom_stats_snapshot_next(sq)) != NULL) {
437 gid = geom_lookupid(&gm, gsp->id);
440 if (gid->lg_what == ISPROVIDER) {
444 if (strcmp(gcl->lg_name, CLASS_NAME_MD) != 0)
446 if ((opt & OPT_UNIT) && (units != NULL)) {
447 retcode = md_find(units, pp->lg_name);
454 type = geom_config_get(gc, "type");
455 if (type != NULL && (strcmp(type, "vnode") == 0 ||
456 strcmp(type, "preload") == 0)) {
457 file = geom_config_get(gc, "file");
459 strcmp(fflag, file) != 0)
463 } else if (fflag != NULL)
465 if (nflag && strncmp(pp->lg_name, MD_NAME, 2) == 0)
466 printf("%s", pp->lg_name + 2);
468 printf("%s", pp->lg_name);
470 if (opt & OPT_VERBOSE ||
471 ((opt & OPT_UNIT) && fflag == NULL)) {
472 length = geom_config_get(gc, "length");
473 printf("\t%s\t", type);
475 md_prthumanval(length);
477 printf("\t%s", file);
482 if ((opt & OPT_LIST) && !(opt & OPT_VERBOSE))
488 if ((opt & OPT_LIST) && (opt & OPT_DONE) && !(opt & OPT_VERBOSE))
490 /* XXX: Check if it's enough to clean everything. */
491 geom_stats_snapshot_free(sq);
492 if (opt & OPT_UNIT) {
493 if (((fflag == NULL) && ufound) ||
494 ((fflag == NULL) && (units != NULL) && ufound) ||
495 ((fflag != NULL) && ffound) ||
496 ((fflag != NULL) && (units != NULL) && ufound && ffound))
498 } else if (opt & OPT_LIST) {
499 if ((fflag == NULL) ||
500 ((fflag != NULL) && ffound))
507 * Returns value of 'name' from gconfig structure.
510 geom_config_get(struct gconf *g, const char *name)
514 LIST_FOREACH(gce, g, lg_config) {
515 if (strcmp(gce->lg_name, name) == 0)
516 return (gce->lg_val);
522 * List is comma separated list of MD disks. name is a
523 * device name we look for. Returns 1 if found and 0
527 md_find(const char *list, const char *name)
537 for (p = ptr; (u = strsep(&p, ",")) != NULL;) {
538 if (strncmp(u, _PATH_DEV, sizeof(_PATH_DEV) - 1) == 0)
539 u += sizeof(_PATH_DEV) - 1;
540 /* Just in case user specified number instead of full name */
541 snprintf(num, sizeof(num), "%s%s", MD_NAME, u);
542 if (strcmp(u, name) == 0 || strcmp(num, name) == 0) {
552 md_prthumanval(char *length)
559 bytes = strtoumax(length, &endptr, 10);
560 if (errno != 0 || *endptr != '\0' || bytes > INT64_MAX)
562 humanize_number(buf, sizeof(buf), (int64_t)bytes, "",
563 HN_AUTOSCALE, HN_B | HN_NOSPACE | HN_DECIMAL);
564 (void)printf("%6s", buf);
568 md_query(const char *name, const int opt, const char *fflag)
571 return (md_list(name, opt | OPT_UNIT, fflag));