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, 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 -l [-v] [-n] [-f file] [-u unit]\n"
87 fprintf(stderr, "\t\ttype = {malloc, vnode, swap}\n");
88 fprintf(stderr, "\t\toption = {cluster, compress, reserve}\n");
89 fprintf(stderr, "\t\tsize = %%d (512 byte blocks), %%db (B),\n");
90 fprintf(stderr, "\t\t %%dk (kB), %%dm (MB), %%dg (GB) or\n");
91 fprintf(stderr, "\t\t %%dt (TB)\n");
96 main(int argc, char **argv)
100 char *fflag = NULL, *tflag = NULL, *uflag = NULL;
102 bzero(&mdio, sizeof(mdio));
103 mdio.md_file = malloc(PATH_MAX);
104 if (mdio.md_file == NULL)
105 err(1, "could not allocate memory");
107 bzero(mdio.md_file, PATH_MAX);
112 while ((ch = getopt(argc, argv, "ab:df:lno:s:S:t:u:vx:y:")) != -1) {
115 if (action != UNSET && action != ATTACH)
117 "-a is mutually exclusive with -d and -l");
121 if (action != UNSET && action != DETACH)
123 "-d is mutually exclusive with -a and -l");
125 mdio.md_options |= MD_AUTOUNIT;
128 if (action != UNSET && action != LIST)
130 "-l is mutually exclusive with -a and -d");
132 mdio.md_options |= MD_AUTOUNIT;
139 errx(1, "-t can be passed only once");
141 if (!strcmp(optarg, "malloc")) {
142 mdio.md_type = MD_MALLOC;
143 mdio.md_options |= MD_AUTOUNIT | MD_COMPRESS;
144 } else if (!strcmp(optarg, "preload")) {
145 mdio.md_type = MD_PRELOAD;
146 } else if (!strcmp(optarg, "vnode")) {
147 mdio.md_type = MD_VNODE;
148 mdio.md_options |= MD_CLUSTER | MD_AUTOUNIT | MD_COMPRESS;
149 } else if (!strcmp(optarg, "swap")) {
150 mdio.md_type = MD_SWAP;
151 mdio.md_options |= MD_CLUSTER | MD_AUTOUNIT | MD_COMPRESS;
153 errx(1, "unknown type: %s", optarg);
157 errx(1, "-f can be passed only once");
161 if (!strcmp(optarg, "async"))
162 mdio.md_options |= MD_ASYNC;
163 else if (!strcmp(optarg, "noasync"))
164 mdio.md_options &= ~MD_ASYNC;
165 else if (!strcmp(optarg, "cluster"))
166 mdio.md_options |= MD_CLUSTER;
167 else if (!strcmp(optarg, "nocluster"))
168 mdio.md_options &= ~MD_CLUSTER;
169 else if (!strcmp(optarg, "compress"))
170 mdio.md_options |= MD_COMPRESS;
171 else if (!strcmp(optarg, "nocompress"))
172 mdio.md_options &= ~MD_COMPRESS;
173 else if (!strcmp(optarg, "force"))
174 mdio.md_options |= MD_FORCE;
175 else if (!strcmp(optarg, "noforce"))
176 mdio.md_options &= ~MD_FORCE;
177 else if (!strcmp(optarg, "readonly"))
178 mdio.md_options |= MD_READONLY;
179 else if (!strcmp(optarg, "noreadonly"))
180 mdio.md_options &= ~MD_READONLY;
181 else if (!strcmp(optarg, "reserve"))
182 mdio.md_options |= MD_RESERVE;
183 else if (!strcmp(optarg, "noreserve"))
184 mdio.md_options &= ~MD_RESERVE;
186 errx(1, "unknown option: %s", optarg);
189 mdio.md_sectorsize = strtoul(optarg, &p, 0);
192 mdio.md_mediasize = (off_t)strtoumax(optarg, &p, 0);
193 if (p == NULL || *p == '\0')
194 mdio.md_mediasize *= DEV_BSIZE;
195 else if (*p == 'b' || *p == 'B')
197 else if (*p == 'k' || *p == 'K')
198 mdio.md_mediasize <<= 10;
199 else if (*p == 'm' || *p == 'M')
200 mdio.md_mediasize <<= 20;
201 else if (*p == 'g' || *p == 'G')
202 mdio.md_mediasize <<= 30;
203 else if (*p == 't' || *p == 'T') {
204 mdio.md_mediasize <<= 30;
205 mdio.md_mediasize <<= 10;
207 errx(1, "unknown suffix on -s argument");
210 if (!strncmp(optarg, _PATH_DEV, sizeof(_PATH_DEV) - 1))
211 optarg += sizeof(_PATH_DEV) - 1;
212 if (!strncmp(optarg, MD_NAME, sizeof(MD_NAME) - 1))
213 optarg += sizeof(MD_NAME) - 1;
220 mdio.md_fwsectors = strtoul(optarg, &p, 0);
223 mdio.md_fwheads = strtoul(optarg, &p, 0);
236 if (action == ATTACH) {
239 * Try to infer the type based on other arguments.
241 if (fflag != NULL || argc > 0) {
242 /* Imply ``-t vnode'' */
243 mdio.md_type = MD_VNODE;
244 mdio.md_options |= MD_CLUSTER | MD_AUTOUNIT |
246 } else if (mdio.md_mediasize != 0) {
247 /* Imply ``-t swap'' */
248 mdio.md_type = MD_SWAP;
249 mdio.md_options |= MD_CLUSTER | MD_AUTOUNIT |
252 errx(1, "unable to determine type");
255 if ((fflag != NULL || argc > 0) && mdio.md_type != MD_VNODE)
256 errx(1, "only -t vnode can be used with file name");
258 if (mdio.md_type == MD_VNODE) {
269 if ((mdio.md_options & MD_READONLY) == 0 &&
270 access(mdio.md_file, W_OK) < 0 &&
271 (errno == EACCES || errno == EPERM ||
273 warnx("WARNING: opening backing store: %s "
274 "readonly", mdio.md_file);
275 mdio.md_options |= MD_READONLY;
279 if ((mdio.md_type == MD_MALLOC || mdio.md_type == MD_SWAP) &&
280 mdio.md_mediasize == 0)
281 errx(1, "must specify -s for -t malloc or -t swap");
282 if (mdio.md_type == MD_VNODE && mdio.md_file[0] == '\0')
283 errx(1, "must specify -f for -t vnode");
285 if (mdio.md_sectorsize != 0)
286 errx(1, "-S can only be used with -a");
287 if (mdio.md_mediasize != 0)
288 errx(1, "-s can only be used with -a");
289 if (mdio.md_fwsectors != 0)
290 errx(1, "-x can only be used with -a");
291 if (mdio.md_fwheads != 0)
292 errx(1, "-y can only be used with -a");
293 if (fflag != NULL && action != LIST)
294 errx(1, "-f can only be used with -a and -l");
296 errx(1, "-t can only be used with -a");
298 errx(1, "file can only be used with -a");
299 if (action != DETACH && (mdio.md_options & ~MD_AUTOUNIT) != 0)
300 errx(1, "-o can only be used with -a and -d");
301 if (action == DETACH &&
302 (mdio.md_options & ~(MD_FORCE | MD_AUTOUNIT)) != 0)
303 errx(1, "only -o [no]force can be used with -d");
306 if (action != LIST && vflag == OPT_VERBOSE)
307 errx(1, "-v can only be used with -l");
310 mdio.md_unit = strtoul(uflag, &p, 0);
311 if (mdio.md_unit == (unsigned)ULONG_MAX || *p != '\0')
312 errx(1, "bad unit: %s", uflag);
313 mdio.md_options &= ~MD_AUTOUNIT;
316 mdio.md_version = MDIOVERSION;
318 if (!kld_isloaded("g_md") && kld_load("geom_md") == -1)
319 err(1, "failed to load geom_md module");
321 fd = open(_PATH_DEV MDCTL_NAME, O_RDWR, 0);
323 err(1, "open(%s%s)", _PATH_DEV, MDCTL_NAME);
325 if (action == ATTACH) {
326 i = ioctl(fd, MDIOCATTACH, &mdio);
328 err(1, "ioctl(%s%s)", _PATH_DEV, MDCTL_NAME);
329 if (mdio.md_options & MD_AUTOUNIT)
330 printf("%s%d\n", nflag ? "" : MD_NAME, mdio.md_unit);
331 } else if (action == DETACH) {
332 if (mdio.md_options & MD_AUTOUNIT)
333 errx(1, "-d requires -u");
334 i = ioctl(fd, MDIOCDETACH, &mdio);
336 err(1, "ioctl(%s%s)", _PATH_DEV, MDCTL_NAME);
337 } else if (action == LIST) {
338 if (mdio.md_options & MD_AUTOUNIT) {
340 * Listing all devices. This is why we pass NULL
341 * together with OPT_LIST.
343 return (md_list(NULL, OPT_LIST | vflag, fflag));
345 return (md_query(uflag, vflag, fflag));
354 md_set_file(const char *fn)
359 if (realpath(fn, mdio.md_file) == NULL)
360 err(1, "could not find full path for %s", fn);
361 fd = open(mdio.md_file, O_RDONLY);
363 err(1, "could not open %s", fn);
364 if (fstat(fd, &sb) == -1)
365 err(1, "could not stat %s", fn);
366 if (!S_ISREG(sb.st_mode))
367 errx(1, "%s is not a regular file", fn);
368 if (mdio.md_mediasize == 0)
369 mdio.md_mediasize = sb.st_size;
374 * Lists md(4) disks. Is used also as a query routine, since it handles XML
375 * interface. 'units' can be NULL for listing memory disks. It might be
376 * coma-separated string containing md(4) disk names. 'opt' distinguished
377 * between list and query mode.
380 md_list(const char *units, int opt, const char *fflag)
383 struct gprovider *pp;
390 int retcode, ffound, ufound;
391 char *type, *file, *length;
393 type = file = length = NULL;
395 retcode = geom_gettree(&gm);
398 retcode = geom_stats_open();
401 sq = geom_stats_snapshot_get();
406 while ((gsp = geom_stats_snapshot_next(sq)) != NULL) {
407 gid = geom_lookupid(&gm, gsp->id);
410 if (gid->lg_what == ISPROVIDER) {
414 if (strcmp(gcl->lg_name, CLASS_NAME_MD) != 0)
416 if ((opt & OPT_UNIT) && (units != NULL)) {
417 retcode = md_find(units, pp->lg_name);
424 type = geom_config_get(gc, "type");
425 if (strcmp(type, "vnode") == 0) {
426 file = geom_config_get(gc, "file");
428 strcmp(fflag, file) != 0)
432 } else if (fflag != NULL)
434 if (nflag && strncmp(pp->lg_name, MD_NAME, 2) == 0)
435 printf("%s", pp->lg_name + 2);
437 printf("%s", pp->lg_name);
439 if (opt & OPT_VERBOSE ||
440 ((opt & OPT_UNIT) && fflag == NULL)) {
441 length = geom_config_get(gc, "length");
442 printf("\t%s\t", type);
444 md_prthumanval(length);
446 printf("\t%s", file);
451 if ((opt & OPT_LIST) && !(opt & OPT_VERBOSE))
457 if ((opt & OPT_LIST) && (opt & OPT_DONE) && !(opt & OPT_VERBOSE))
459 /* XXX: Check if it's enough to clean everything. */
460 geom_stats_snapshot_free(sq);
461 if (((opt & OPT_UNIT) && (fflag == NULL) && ufound) ||
462 ((opt & OPT_UNIT) == 0 && (fflag != NULL) && ffound) ||
463 ((opt & OPT_UNIT) && (fflag != NULL) && ufound && ffound))
470 * Returns value of 'name' from gconfig structure.
473 geom_config_get(struct gconf *g, const char *name)
477 LIST_FOREACH(gce, g, lg_config) {
478 if (strcmp(gce->lg_name, name) == 0)
479 return (gce->lg_val);
485 * List is comma separated list of MD disks. name is a
486 * device name we look for. Returns 1 if found and 0
490 md_find(const char *list, const char *name)
500 for (p = ptr; (u = strsep(&p, ",")) != NULL;) {
501 if (strncmp(u, _PATH_DEV, sizeof(_PATH_DEV) - 1) == 0)
502 u += sizeof(_PATH_DEV) - 1;
503 /* Just in case user specified number instead of full name */
504 snprintf(num, sizeof(num), "%s%s", MD_NAME, u);
505 if (strcmp(u, name) == 0 || strcmp(num, name) == 0) {
515 md_prthumanval(char *length)
522 bytes = strtoumax(length, &endptr, 10);
523 if (errno != 0 || *endptr != '\0' || bytes > INT64_MAX)
525 humanize_number(buf, sizeof(buf), (int64_t)bytes, "",
526 HN_AUTOSCALE, HN_B | HN_NOSPACE | HN_DECIMAL);
527 (void)printf("%6s", buf);
531 md_query(const char *name, const int opt, const char *fflag)
534 return (md_list(name, opt | OPT_UNIT, fflag));