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
usage(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), \n");
92 fprintf(stderr, "\t\t %%dt (TB), or %%dp (PB)\n");
93 exit(1);
94 }
95
96 int
main(int argc,char ** argv)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 if (*p == 'p' || *p == 'P') {
221 mdio.md_mediasize <<= 30;
222 mdio.md_mediasize <<= 20;
223 } else
224 errx(1, "unknown suffix on -s argument");
225 break;
226 case 'u':
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;
231 uflag = optarg;
232 break;
233 case 'v':
234 vflag = OPT_VERBOSE;
235 break;
236 case 'x':
237 mdio.md_fwsectors = strtoul(optarg, &p, 0);
238 break;
239 case 'y':
240 mdio.md_fwheads = strtoul(optarg, &p, 0);
241 break;
242 default:
243 usage();
244 }
245 }
246
247 argc -= optind;
248 argv += optind;
249
250 if (action == UNSET)
251 action = ATTACH;
252
253 if (action == ATTACH) {
254 if (tflag == NULL) {
255 /*
256 * Try to infer the type based on other arguments.
257 */
258 if (fflag != NULL || argc > 0) {
259 /* Imply ``-t vnode'' */
260 mdio.md_type = MD_VNODE;
261 mdio.md_options |= MD_CLUSTER | MD_AUTOUNIT |
262 MD_COMPRESS;
263 } else if (sflag != NULL) {
264 /* Imply ``-t swap'' */
265 mdio.md_type = MD_SWAP;
266 mdio.md_options |= MD_CLUSTER | MD_AUTOUNIT |
267 MD_COMPRESS;
268 } else
269 errx(1, "unable to determine type");
270 }
271
272 if ((fflag != NULL || argc > 0) && mdio.md_type != MD_VNODE)
273 errx(1, "only -t vnode can be used with file name");
274
275 if (mdio.md_type == MD_VNODE) {
276 if (fflag != NULL) {
277 if (argc != 0)
278 usage();
279 md_set_file(fflag);
280 } else {
281 if (argc != 1)
282 usage();
283 md_set_file(*argv);
284 }
285
286 if ((mdio.md_options & MD_READONLY) == 0 &&
287 access(mdio.md_file, W_OK) < 0 &&
288 (errno == EACCES || errno == EPERM ||
289 errno == EROFS)) {
290 warnx("WARNING: opening backing store: %s "
291 "readonly", mdio.md_file);
292 mdio.md_options |= MD_READONLY;
293 }
294 }
295
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, "
299 "or -t null");
300 if (mdio.md_type == MD_VNODE && mdio.md_file[0] == '\0')
301 errx(1, "must specify -f for -t vnode");
302 } else {
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");
313 if (tflag != NULL)
314 errx(1, "-t can only be used with -a");
315 if (argc > 0)
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");
326 }
327
328 if (action == RESIZE && sflag == NULL)
329 errx(1, "must specify -s for -r");
330
331 if (action != LIST && vflag == OPT_VERBOSE)
332 errx(1, "-v can only be used with -l");
333
334 if (uflag != NULL) {
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;
339 }
340
341 mdio.md_version = MDIOVERSION;
342
343 if (!kld_isloaded("g_md") && kld_load("geom_md") == -1)
344 err(1, "failed to load geom_md module");
345
346 fd = open(_PATH_DEV MDCTL_NAME, O_RDWR, 0);
347 if (fd < 0)
348 err(1, "open(%s%s)", _PATH_DEV, MDCTL_NAME);
349
350 if (action == ATTACH) {
351 i = ioctl(fd, MDIOCATTACH, &mdio);
352 if (i < 0)
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);
360 if (i < 0)
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);
366 if (i < 0)
367 err(1, "ioctl(%s%s)", _PATH_DEV, MDCTL_NAME);
368 } else if (action == LIST) {
369 if (mdio.md_options & MD_AUTOUNIT) {
370 /*
371 * Listing all devices. This is why we pass NULL
372 * together with OPT_LIST.
373 */
374 return (md_list(NULL, OPT_LIST | vflag, fflag));
375 } else
376 return (md_query(uflag, vflag, fflag));
377 } else
378 usage();
379 close(fd);
380 return (0);
381 }
382
383 static void
md_set_file(const char * fn)384 md_set_file(const char *fn)
385 {
386 struct stat sb;
387 int fd;
388
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);
392 if (fd < 0)
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;
400 close(fd);
401 }
402
403 /*
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.
408 */
409 static int
md_list(const char * units,int opt,const char * fflag)410 md_list(const char *units, int opt, const char *fflag)
411 {
412 struct gmesh gm;
413 struct gprovider *pp;
414 struct gconf *gc;
415 struct gident *gid;
416 struct devstat *gsp;
417 struct ggeom *gg;
418 struct gclass *gcl;
419 void *sq;
420 int retcode, ffound, ufound;
421 char *type, *file, *length;
422
423 type = file = length = NULL;
424
425 retcode = geom_gettree(&gm);
426 if (retcode != 0)
427 return (-1);
428 retcode = geom_stats_open();
429 if (retcode != 0)
430 return (-1);
431 sq = geom_stats_snapshot_get();
432 if (sq == NULL)
433 return (-1);
434
435 ffound = ufound = 0;
436 while ((gsp = geom_stats_snapshot_next(sq)) != NULL) {
437 gid = geom_lookupid(&gm, gsp->id);
438 if (gid == NULL)
439 continue;
440 if (gid->lg_what == ISPROVIDER) {
441 pp = gid->lg_ptr;
442 gg = pp->lg_geom;
443 gcl = gg->lg_class;
444 if (strcmp(gcl->lg_name, CLASS_NAME_MD) != 0)
445 continue;
446 if ((opt & OPT_UNIT) && (units != NULL)) {
447 retcode = md_find(units, pp->lg_name);
448 if (retcode != 1)
449 continue;
450 else
451 ufound = 1;
452 }
453 gc = &pp->lg_config;
454 type = geom_config_get(gc, "type");
455 if (strcmp(type, "vnode") == 0) {
456 file = geom_config_get(gc, "file");
457 if (fflag != NULL &&
458 strcmp(fflag, file) != 0)
459 continue;
460 else
461 ffound = 1;
462 } else if (fflag != NULL)
463 continue;
464 if (nflag && strncmp(pp->lg_name, MD_NAME, 2) == 0)
465 printf("%s", pp->lg_name + 2);
466 else
467 printf("%s", pp->lg_name);
468
469 if (opt & OPT_VERBOSE ||
470 ((opt & OPT_UNIT) && fflag == NULL)) {
471 length = geom_config_get(gc, "length");
472 printf("\t%s\t", type);
473 if (length != NULL)
474 md_prthumanval(length);
475 if (file != NULL) {
476 printf("\t%s", file);
477 file = NULL;
478 }
479 }
480 opt |= OPT_DONE;
481 if ((opt & OPT_LIST) && !(opt & OPT_VERBOSE))
482 printf(" ");
483 else
484 printf("\n");
485 }
486 }
487 if ((opt & OPT_LIST) && (opt & OPT_DONE) && !(opt & OPT_VERBOSE))
488 printf("\n");
489 /* XXX: Check if it's enough to clean everything. */
490 geom_stats_snapshot_free(sq);
491 if (opt & OPT_UNIT) {
492 if (((fflag == NULL) && ufound) ||
493 ((fflag == NULL) && (units != NULL) && ufound) ||
494 ((fflag != NULL) && ffound) ||
495 ((fflag != NULL) && (units != NULL) && ufound && ffound))
496 return (0);
497 } else if (opt & OPT_LIST) {
498 if ((fflag == NULL) ||
499 ((fflag != NULL) && ffound))
500 return (0);
501 }
502 return (-1);
503 }
504
505 /*
506 * Returns value of 'name' from gconfig structure.
507 */
508 static char *
geom_config_get(struct gconf * g,const char * name)509 geom_config_get(struct gconf *g, const char *name)
510 {
511 struct gconfig *gce;
512
513 LIST_FOREACH(gce, g, lg_config) {
514 if (strcmp(gce->lg_name, name) == 0)
515 return (gce->lg_val);
516 }
517 return (NULL);
518 }
519
520 /*
521 * List is comma separated list of MD disks. name is a
522 * device name we look for. Returns 1 if found and 0
523 * otherwise.
524 */
525 static int
md_find(const char * list,const char * name)526 md_find(const char *list, const char *name)
527 {
528 int ret;
529 char num[PATH_MAX];
530 char *ptr, *p, *u;
531
532 ret = 0;
533 ptr = strdup(list);
534 if (ptr == NULL)
535 return (-1);
536 for (p = ptr; (u = strsep(&p, ",")) != NULL;) {
537 if (strncmp(u, _PATH_DEV, sizeof(_PATH_DEV) - 1) == 0)
538 u += sizeof(_PATH_DEV) - 1;
539 /* Just in case user specified number instead of full name */
540 snprintf(num, sizeof(num), "%s%s", MD_NAME, u);
541 if (strcmp(u, name) == 0 || strcmp(num, name) == 0) {
542 ret = 1;
543 break;
544 }
545 }
546 free(ptr);
547 return (ret);
548 }
549
550 static void
md_prthumanval(char * length)551 md_prthumanval(char *length)
552 {
553 char buf[6];
554 uintmax_t bytes;
555 char *endptr;
556
557 errno = 0;
558 bytes = strtoumax(length, &endptr, 10);
559 if (errno != 0 || *endptr != '\0' || bytes > INT64_MAX)
560 return;
561 humanize_number(buf, sizeof(buf), (int64_t)bytes, "",
562 HN_AUTOSCALE, HN_B | HN_NOSPACE | HN_DECIMAL);
563 (void)printf("%6s", buf);
564 }
565
566 static int
md_query(const char * name,const int opt,const char * fflag)567 md_query(const char *name, const int opt, const char *fflag)
568 {
569
570 return (md_list(name, opt | OPT_UNIT, fflag));
571 }
572