ccdconfig.c revision 48568 
1/*	$NetBSD: ccdconfig.c,v 1.2.2.1 1995/11/11 02:43:35 thorpej Exp $	*/
2
3/*
4 * Copyright (c) 1995 Jason R. Thorpe.
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 *    notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 *    notice, this list of conditions and the following disclaimer in the
14 *    documentation and/or other materials provided with the distribution.
15 * 3. All advertising materials mentioning features or use of this software
16 *    must display the following acknowledgement:
17 *	This product includes software developed for the NetBSD Project
18 *	by Jason R. Thorpe.
19 * 4. The name of the author may not be used to endorse or promote products
20 *    derived from this software without specific prior written permission.
21 *
22 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
23 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
24 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
25 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
26 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
29 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 * SUCH DAMAGE.
33 */
34
35#ifndef lint
36static const char rcsid[] =
37	"$Id: ccdconfig.c,v 1.12 1999/05/06 19:20:34 phk Exp $";
38#endif /* not lint */
39
40#include <sys/param.h>
41#include <sys/linker.h>
42#include <sys/disklabel.h>
43#include <sys/device.h>
44#include <sys/stat.h>
45#include <sys/module.h>
46#include <ctype.h>
47#include <err.h>
48#include <errno.h>
49#include <fcntl.h>
50#include <kvm.h>
51#include <limits.h>
52#include <stdio.h>
53#include <stdlib.h>
54#include <string.h>
55#include <unistd.h>
56
57#include <sys/devicestat.h>
58#include <sys/ccdvar.h>
59
60#include "pathnames.h"
61
62static	int lineno = 0;
63static	int verbose = 0;
64static	char *ccdconf = _PATH_CCDCONF;
65
66static	char *core = NULL;
67static	char *kernel = NULL;
68
69struct	flagval {
70	char	*fv_flag;
71	int	fv_val;
72} flagvaltab[] = {
73	{ "CCDF_SWAP",		CCDF_SWAP },
74	{ "CCDF_UNIFORM",	CCDF_UNIFORM },
75	{ "CCDF_MIRROR",	CCDF_MIRROR },
76	{ "CCDF_PARITY",	CCDF_PARITY },
77	{ NULL,			0 },
78};
79
80static	struct nlist nl[] = {
81	{ "_ccd_softc" },
82#define SYM_CCDSOFTC		0
83	{ "_numccd" },
84#define SYM_NUMCCD		1
85	{ NULL },
86};
87
88#define CCD_CONFIG		0	/* configure a device */
89#define CCD_CONFIGALL		1	/* configure all devices */
90#define CCD_UNCONFIG		2	/* unconfigure a device */
91#define CCD_UNCONFIGALL		3	/* unconfigure all devices */
92#define CCD_DUMP		4	/* dump a ccd's configuration */
93
94static	int checkdev __P((char *));
95static	int do_io __P((char *, u_long, struct ccd_ioctl *));
96static	int do_single __P((int, char **, int));
97static	int do_all __P((int));
98static	int dump_ccd __P((int, char **));
99static	int getmaxpartitions __P((void));
100static	int getrawpartition __P((void));
101static	int flags_to_val __P((char *));
102static	void print_ccd_info __P((struct ccd_softc *, kvm_t *));
103static	char *resolve_ccdname __P((char *));
104static	void usage __P((void));
105
106int
107main(argc, argv)
108	int argc;
109	char **argv;
110{
111	int ch, options = 0, action = CCD_CONFIG;
112
113	while ((ch = getopt(argc, argv, "cCf:gM:N:uUv")) != -1) {
114		switch (ch) {
115		case 'c':
116			action = CCD_CONFIG;
117			++options;
118			break;
119
120		case 'C':
121			action = CCD_CONFIGALL;
122			++options;
123			break;
124
125		case 'f':
126			ccdconf = optarg;
127			break;
128
129		case 'g':
130			action = CCD_DUMP;
131			break;
132
133		case 'M':
134			core = optarg;
135			break;
136
137		case 'N':
138			kernel = optarg;
139			break;
140
141		case 'u':
142			action = CCD_UNCONFIG;
143			++options;
144			break;
145
146		case 'U':
147			action = CCD_UNCONFIGALL;
148			++options;
149			break;
150
151		case 'v':
152			verbose = 1;
153			break;
154
155		default:
156			usage();
157		}
158	}
159	argc -= optind;
160	argv += optind;
161
162	if (options > 1)
163		usage();
164
165	/*
166	 * Discard setgid privileges if not the running kernel so that bad
167	 * guys can't print interesting stuff from kernel memory.
168	 */
169	if (core != NULL || kernel != NULL || action != CCD_DUMP) {
170		setegid(getgid());
171		setgid(getgid());
172	}
173
174	if (modfind("ccd") < 0) {
175		/* Not present in kernel, try loading it */
176		if (kldload("ccd") < 0 || modfind("ccd") < 0)
177			warn("ccd module not available!");
178	}
179
180	switch (action) {
181		case CCD_CONFIG:
182		case CCD_UNCONFIG:
183			exit(do_single(argc, argv, action));
184			/* NOTREACHED */
185
186		case CCD_CONFIGALL:
187		case CCD_UNCONFIGALL:
188			exit(do_all(action));
189			/* NOTREACHED */
190
191		case CCD_DUMP:
192			exit(dump_ccd(argc, argv));
193			/* NOTREACHED */
194	}
195	/* NOTREACHED */
196	return (0);
197}
198
199static int
200do_single(argc, argv, action)
201	int argc;
202	char **argv;
203	int action;
204{
205	struct ccd_ioctl ccio;
206	char *ccd, *cp, *cp2, **disks;
207	int noflags = 0, i, ileave, flags, j;
208
209	bzero(&ccio, sizeof(ccio));
210
211	/*
212	 * If unconfiguring, all arguments are treated as ccds.
213	 */
214	if (action == CCD_UNCONFIG || action == CCD_UNCONFIGALL) {
215		for (i = 0; argc != 0; ) {
216			cp = *argv++; --argc;
217			if ((ccd = resolve_ccdname(cp)) == NULL) {
218				warnx("invalid ccd name: %s", cp);
219				i = 1;
220				continue;
221			}
222			if (do_io(ccd, CCDIOCCLR, &ccio))
223				i = 1;
224			else
225				if (verbose)
226					printf("%s unconfigured\n", cp);
227		}
228		return (i);
229	}
230
231	/* Make sure there are enough arguments. */
232	if (argc < 4) {
233		if (argc == 3) {
234			/* Assume that no flags are specified. */
235			noflags = 1;
236		} else {
237			if (action == CCD_CONFIGALL) {
238				warnx("%s: bad line: %d", ccdconf, lineno);
239				return (1);
240			} else
241				usage();
242		}
243	}
244
245	/* First argument is the ccd to configure. */
246	cp = *argv++; --argc;
247	if ((ccd = resolve_ccdname(cp)) == NULL) {
248		warnx("invalid ccd name: %s", cp);
249		return (1);
250	}
251
252	/* Next argument is the interleave factor. */
253	cp = *argv++; --argc;
254	errno = 0;	/* to check for ERANGE */
255	ileave = (int)strtol(cp, &cp2, 10);
256	if ((errno == ERANGE) || (ileave < 0) || (*cp2 != '\0')) {
257		warnx("invalid interleave factor: %s", cp);
258		return (1);
259	}
260
261	if (noflags == 0) {
262		/* Next argument is the ccd configuration flags. */
263		cp = *argv++; --argc;
264		if ((flags = flags_to_val(cp)) < 0) {
265			warnx("invalid flags argument: %s", cp);
266			return (1);
267		}
268	}
269
270	/* Next is the list of disks to make the ccd from. */
271	disks = malloc(argc * sizeof(char *));
272	if (disks == NULL) {
273		warnx("no memory to configure ccd");
274		return (1);
275	}
276	for (i = 0; argc != 0; ) {
277		cp = *argv++; --argc;
278		if ((j = checkdev(cp)) == 0)
279			disks[i++] = cp;
280		else {
281			warnx("%s: %s", cp, strerror(j));
282			return (1);
283		}
284	}
285
286	/* Fill in the ccio. */
287	ccio.ccio_disks = disks;
288	ccio.ccio_ndisks = i;
289	ccio.ccio_ileave = ileave;
290	ccio.ccio_flags = flags;
291
292	if (do_io(ccd, CCDIOCSET, &ccio)) {
293		free(disks);
294		return (1);
295	}
296
297	if (verbose) {
298		printf("ccd%d: %d components ", ccio.ccio_unit,
299		    ccio.ccio_ndisks);
300		for (i = 0; i < ccio.ccio_ndisks; ++i) {
301			if ((cp2 = strrchr(disks[i], '/')) != NULL)
302				++cp2;
303			else
304				cp2 = disks[i];
305			printf("%c%s%c",
306			    i == 0 ? '(' : ' ', cp2,
307			    i == ccio.ccio_ndisks - 1 ? ')' : ',');
308		}
309		printf(", %lu blocks ", (u_long)ccio.ccio_size);
310		if (ccio.ccio_ileave != 0)
311			printf("interleaved at %d blocks\n", ccio.ccio_ileave);
312		else
313			printf("concatenated\n");
314	}
315
316	free(disks);
317	return (0);
318}
319
320static int
321do_all(action)
322	int action;
323{
324	FILE *f;
325	char line[_POSIX2_LINE_MAX];
326	char *cp, **argv;
327	int argc, rval;
328	gid_t egid;
329
330	egid = getegid();
331	setegid(getgid());
332	if ((f = fopen(ccdconf, "r")) == NULL) {
333		setegid(egid);
334		warn("fopen: %s", ccdconf);
335		return (1);
336	}
337	setegid(egid);
338
339	while (fgets(line, sizeof(line), f) != NULL) {
340		argc = 0;
341		argv = NULL;
342		++lineno;
343		if ((cp = strrchr(line, '\n')) != NULL)
344			*cp = '\0';
345
346		/* Break up the line and pass it's contents to do_single(). */
347		if (line[0] == '\0')
348			goto end_of_line;
349		for (cp = line; (cp = strtok(cp, " \t")) != NULL; cp = NULL) {
350			if (*cp == '#')
351				break;
352			if ((argv = realloc(argv,
353			    sizeof(char *) * ++argc)) == NULL) {
354				warnx("no memory to configure ccds");
355				return (1);
356			}
357			argv[argc - 1] = cp;
358			/*
359			 * If our action is to unconfigure all, then pass
360			 * just the first token to do_single() and ignore
361			 * the rest.  Since this will be encountered on
362			 * our first pass through the line, the Right
363			 * Thing will happen.
364			 */
365			if (action == CCD_UNCONFIGALL) {
366				if (do_single(argc, argv, action))
367					rval = 1;
368				goto end_of_line;
369			}
370		}
371		if (argc != 0)
372			if (do_single(argc, argv, action))
373				rval = 1;
374
375 end_of_line:
376		if (argv != NULL)
377			free(argv);
378	}
379
380	(void)fclose(f);
381	return (rval);
382}
383
384static int
385checkdev(path)
386	char *path;
387{
388	struct stat st;
389
390	if (stat(path, &st) != 0)
391		return (errno);
392
393	if (!S_ISBLK(st.st_mode) && !S_ISCHR(st.st_mode))
394		return (EINVAL);
395
396	return (0);
397}
398
399static int
400pathtounit(path, unitp)
401	char *path;
402	int *unitp;
403{
404	struct stat st;
405	int maxpartitions;
406
407	if (stat(path, &st) != 0)
408		return (errno);
409
410	if (!S_ISBLK(st.st_mode) && !S_ISCHR(st.st_mode))
411		return (EINVAL);
412
413	if ((maxpartitions = getmaxpartitions()) < 0)
414		return (errno);
415
416	*unitp = minor(st.st_rdev) / maxpartitions;
417
418	return (0);
419}
420
421static char *
422resolve_ccdname(name)
423	char *name;
424{
425	char c, *path;
426	size_t len, newlen;
427	int rawpart;
428
429	if (name[0] == '/' || name[0] == '.') {
430		/* Assume they gave the correct pathname. */
431		return (strdup(name));
432	}
433
434	len = strlen(name);
435	c = name[len - 1];
436
437	newlen = len + 8;
438	if ((path = malloc(newlen)) == NULL)
439		return (NULL);
440	bzero(path, newlen);
441
442	if (isdigit(c)) {
443		if ((rawpart = getrawpartition()) < 0) {
444			free(path);
445			return (NULL);
446		}
447		(void)sprintf(path, "/dev/%s%c", name, 'a' + rawpart);
448	} else
449		(void)sprintf(path, "/dev/%s", name);
450
451	return (path);
452}
453
454static int
455do_io(path, cmd, cciop)
456	char *path;
457	u_long cmd;
458	struct ccd_ioctl *cciop;
459{
460	int fd;
461	char *cp;
462
463	if ((fd = open(path, O_RDWR, 0640)) < 0) {
464		warn("open: %s", path);
465		return (1);
466	}
467
468	if (ioctl(fd, cmd, cciop) < 0) {
469		switch (cmd) {
470		case CCDIOCSET:
471			cp = "CCDIOCSET";
472			break;
473
474		case CCDIOCCLR:
475			cp = "CCDIOCCLR";
476			break;
477
478		default:
479			cp = "unknown";
480		}
481		warn("ioctl (%s): %s", cp, path);
482		return (1);
483	}
484
485	return (0);
486}
487
488#define KVM_ABORT(kd, str) {						\
489	(void)kvm_close((kd));						\
490	warnx((str));							\
491	warnx(kvm_geterr((kd)));					\
492	return (1);							\
493}
494
495static int
496dump_ccd(argc, argv)
497	int argc;
498	char **argv;
499{
500	char errbuf[_POSIX2_LINE_MAX], *ccd, *cp;
501	struct ccd_softc *cs, *kcs;
502	size_t readsize;
503	int i, error, numccd, numconfiged = 0;
504	kvm_t *kd;
505
506	bzero(errbuf, sizeof(errbuf));
507
508	if ((kd = kvm_openfiles(kernel, core, NULL, O_RDONLY,
509	    errbuf)) == NULL) {
510		warnx("can't open kvm: %s", errbuf);
511		return (1);
512	}
513
514	if (kvm_nlist(kd, nl))
515		KVM_ABORT(kd, "ccd-related symbols not available");
516
517	/* Check to see how many ccds are currently configured. */
518	if (kvm_read(kd, nl[SYM_NUMCCD].n_value, (char *)&numccd,
519	    sizeof(numccd)) != sizeof(numccd))
520		KVM_ABORT(kd, "can't determine number of configured ccds");
521
522	if (numccd == 0) {
523		printf("ccd driver in kernel, but is uninitialized\n");
524		goto done;
525	}
526
527	/* Allocate space for the configuration data. */
528	readsize = numccd * sizeof(struct ccd_softc);
529	if ((cs = malloc(readsize)) == NULL) {
530		warnx("no memory for configuration data");
531		goto bad;
532	}
533	bzero(cs, readsize);
534
535	/*
536	 * Read the ccd configuration data from the kernel and dump
537	 * it to stdout.
538	 */
539	if (kvm_read(kd, nl[SYM_CCDSOFTC].n_value, (char *)&kcs,
540	    sizeof(kcs)) != sizeof(kcs)) {
541		free(cs);
542		KVM_ABORT(kd, "can't find pointer to configuration data");
543	}
544	if (kvm_read(kd, (u_long)kcs, (char *)cs, readsize) != readsize) {
545		free(cs);
546		KVM_ABORT(kd, "can't read configuration data");
547	}
548
549	if (argc == 0) {
550		for (i = 0; i < numccd; ++i)
551			if (cs[i].sc_flags & CCDF_INITED) {
552				++numconfiged;
553				print_ccd_info(&cs[i], kd);
554			}
555
556		if (numconfiged == 0)
557			printf("no concatenated disks configured\n");
558	} else {
559		while (argc) {
560			cp = *argv++; --argc;
561			if ((ccd = resolve_ccdname(cp)) == NULL) {
562				warnx("invalid ccd name: %s", cp);
563				continue;
564			}
565			if ((error = pathtounit(ccd, &i)) != 0) {
566				warnx("%s: %s", ccd, strerror(error));
567				continue;
568			}
569			if (i >= numccd) {
570				warnx("ccd%d not configured", i);
571				continue;
572			}
573			if (cs[i].sc_flags & CCDF_INITED)
574				print_ccd_info(&cs[i], kd);
575			else
576				printf("ccd%d not configured\n", i);
577		}
578	}
579
580	free(cs);
581
582 done:
583	(void)kvm_close(kd);
584	return (0);
585
586 bad:
587	(void)kvm_close(kd);
588	return (1);
589}
590
591static void
592print_ccd_info(cs, kd)
593	struct ccd_softc *cs;
594	kvm_t *kd;
595{
596	static int header_printed = 0;
597	struct ccdcinfo *cip;
598	size_t readsize;
599	char path[MAXPATHLEN];
600	int i;
601
602	if (header_printed == 0 && verbose) {
603		printf("# ccd\t\tileave\tflags\tcompnent devices\n");
604		header_printed = 1;
605	}
606
607	readsize = cs->sc_nccdisks * sizeof(struct ccdcinfo);
608	if ((cip = malloc(readsize)) == NULL) {
609		warn("ccd%d: can't allocate memory for component info",
610		    cs->sc_unit);
611		return;
612	}
613	bzero(cip, readsize);
614
615	/* Dump out softc information. */
616	printf("ccd%d\t\t%d\t%d\t", cs->sc_unit, cs->sc_ileave,
617	    cs->sc_cflags & CCDF_USERMASK);
618	fflush(stdout);
619
620	/* Read in the component info. */
621	if (kvm_read(kd, (u_long)cs->sc_cinfo, (char *)cip,
622	    readsize) != readsize) {
623		printf("\n");
624		warnx("can't read component info");
625		warnx(kvm_geterr(kd));
626		goto done;
627	}
628
629	/* Read component pathname and display component info. */
630	for (i = 0; i < cs->sc_nccdisks; ++i) {
631		if (kvm_read(kd, (u_long)cip[i].ci_path, (char *)path,
632		    cip[i].ci_pathlen) != cip[i].ci_pathlen) {
633			printf("\n");
634			warnx("can't read component pathname");
635			warnx(kvm_geterr(kd));
636			goto done;
637		}
638		printf((i + 1 < cs->sc_nccdisks) ? "%s " : "%s\n", path);
639		fflush(stdout);
640	}
641
642 done:
643	free(cip);
644}
645
646static int
647getmaxpartitions()
648{
649    return (MAXPARTITIONS);
650}
651
652static int
653getrawpartition()
654{
655	return (RAW_PART);
656}
657
658static int
659flags_to_val(flags)
660	char *flags;
661{
662	char *cp, *tok;
663	int i, tmp, val = ~CCDF_USERMASK;
664	size_t flagslen;
665
666	/*
667	 * The most common case is that of NIL flags, so check for
668	 * those first.
669	 */
670	if (strcmp("none", flags) == 0 || strcmp("0x0", flags) == 0 ||
671	    strcmp("0", flags) == 0)
672		return (0);
673
674	flagslen = strlen(flags);
675
676	/* Check for values represented by strings. */
677	if ((cp = strdup(flags)) == NULL)
678		err(1, "no memory to parse flags");
679	tmp = 0;
680	for (tok = cp; (tok = strtok(tok, ",")) != NULL; tok = NULL) {
681		for (i = 0; flagvaltab[i].fv_flag != NULL; ++i)
682			if (strcmp(tok, flagvaltab[i].fv_flag) == 0)
683				break;
684		if (flagvaltab[i].fv_flag == NULL) {
685			free(cp);
686			goto bad_string;
687		}
688		tmp |= flagvaltab[i].fv_val;
689	}
690
691	/* If we get here, the string was ok. */
692	free(cp);
693	val = tmp;
694	goto out;
695
696 bad_string:
697
698	/* Check for values represented in hex. */
699	if (flagslen > 2 && flags[0] == '0' && flags[1] == 'x') {
700		errno = 0;	/* to check for ERANGE */
701		val = (int)strtol(&flags[2], &cp, 16);
702		if ((errno == ERANGE) || (*cp != '\0'))
703			return (-1);
704		goto out;
705	}
706
707	/* Check for values represented in decimal. */
708	errno = 0;	/* to check for ERANGE */
709	val = (int)strtol(flags, &cp, 10);
710	if ((errno == ERANGE) || (*cp != '\0'))
711		return (-1);
712
713 out:
714	return (((val & ~CCDF_USERMASK) == 0) ? val : -1);
715}
716
717static void
718usage()
719{
720	fprintf(stderr, "%s\n%s\n%s\n%s\n%s\n",
721		"usage: ccdconfig [-cv] ccd ileave [flags] dev [...]",
722		"       ccdconfig -C [-v] [-f config_file]",
723		"       ccdconfig -u [-v] ccd [...]",
724		"       ccdconfig -U [-v] [-f config_file]",
725		"       ccdconfig -g [-M core] [-N system] [ccd [...]]");
726	exit(1);
727}
728
729/* Local Variables: */
730/* c-argdecl-indent: 8 */
731/* c-indent-level: 8 */
732/* End: */
733