xref: /dflybsd-src/sbin/sysctl/sysctl.c (revision 07caec20a93f40352fd28eec40bb9b40199edf40)
1 /*
2  * Copyright (c) 1993
3  *	The Regents of the University of California.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. All advertising materials mentioning features or use of this software
14  *    must display the following acknowledgement:
15  *	This product includes software developed by the University of
16  *	California, Berkeley and its contributors.
17  * 4. Neither the name of the University nor the names of its contributors
18  *    may be used to endorse or promote products derived from this software
19  *    without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  * @(#) Copyright (c) 1993 The Regents of the University of California.  All rights reserved.
34  * @(#)from: sysctl.c	8.1 (Berkeley) 6/6/93
35  * $FreeBSD: src/sbin/sysctl/sysctl.c,v 1.25.2.11 2003/05/01 22:48:08 trhodes Exp $
36  * $DragonFly: src/sbin/sysctl/sysctl.c,v 1.13 2006/09/21 16:16:07 dillon Exp $
37  */
38 
39 #ifdef __i386__
40 #include <sys/diskslice.h>	/* used for bootdev parsing */
41 #include <sys/reboot.h>		/* used for bootdev parsing */
42 #endif
43 #include <sys/types.h>
44 #include <sys/stat.h>
45 #include <sys/sysctl.h>
46 #include <sys/resource.h>
47 #include <sys/param.h>
48 
49 #include <machine/inttypes.h>
50 
51 #include <ctype.h>
52 #include <err.h>
53 #include <errno.h>
54 #include <stdio.h>
55 #include <stdlib.h>
56 #include <string.h>
57 #include <unistd.h>
58 
59 static int	aflag, bflag, dflag, eflag, Nflag, nflag, oflag, xflag;
60 
61 static int	oidfmt(int *, size_t, char *, u_int *);
62 static void	parse(const char *);
63 static int	show_var(int *, size_t);
64 static int	sysctl_all(int *, size_t);
65 static void	set_T_dev_t(const char *, void **, int *);
66 
67 static void
68 usage(void)
69 {
70 
71 	fprintf(stderr, "%s\n%s\n",
72 	    "usage: sysctl [-bdeNnox] variable[=value] ...",
73 	    "       sysctl [-bdeNnox] -a");
74 	exit(1);
75 }
76 
77 int
78 main(int argc, char **argv)
79 {
80 	int ch;
81 	setbuf(stdout,0);
82 	setbuf(stderr,0);
83 
84 	while ((ch = getopt(argc, argv, "AabdeNnowxX")) != -1) {
85 		switch (ch) {
86 		case 'A':
87 			/* compatibility */
88 			aflag = oflag = 1;
89 			break;
90 		case 'a':
91 			aflag = 1;
92 			break;
93 		case 'b':
94 			bflag = 1;
95 			break;
96 		case 'd':
97 			dflag = 1;
98 			break;
99 		case 'e':
100 			eflag = 1;
101 			break;
102 		case 'N':
103 			Nflag = 1;
104 			break;
105 		case 'n':
106 			nflag = 1;
107 			break;
108 		case 'o':
109 			oflag = 1;
110 			break;
111 		case 'w':
112 			/* compatibility */
113 			/* ignored */
114 			break;
115 		case 'X':
116 			/* compatibility */
117 			aflag = xflag = 1;
118 			break;
119 		case 'x':
120 			xflag = 1;
121 			break;
122 		default:
123 			usage();
124 		}
125 	}
126 	argc -= optind;
127 	argv += optind;
128 
129 	if (Nflag && nflag)
130 		usage();
131 	if (aflag && argc == 0)
132 		exit(sysctl_all(0, 0));
133 	if (argc == 0)
134 		usage();
135 	while (argc-- > 0)
136 		parse(*argv++);
137 	exit(0);
138 }
139 
140 /*
141  * Parse a name into a MIB entry.
142  * Lookup and print out the MIB entry if it exists.
143  * Set a new value if requested.
144  */
145 static void
146 parse(const char *string)
147 {
148 	size_t len;
149 	int i, j;
150 	void *newval = NULL;
151 	int intval;
152 	unsigned int uintval;
153 	long longval;
154 	unsigned long ulongval;
155 	size_t newsize = 0;
156 	quad_t quadval;
157 	u_quad_t uquadval;
158 	int mib[CTL_MAXNAME];
159 	char *cp, fmt[BUFSIZ];
160 	const char *name;
161 	char *name_allocated = NULL;
162 	u_int kind;
163 
164 	if ((cp = strchr(string, '=')) != NULL) {
165 		if ((name_allocated = malloc(cp - string + 1)) == NULL)
166 			err(1, "malloc failed");
167 		strlcpy(name_allocated, string, cp - string + 1);
168 		name = name_allocated;
169 
170 		while (isspace(*++cp))
171 			;
172 
173 		newval = cp;
174 		newsize = strlen(cp);
175 	} else {
176 		name = string;
177 	}
178 
179 	len = CTL_MAXNAME;
180 	if (sysctlnametomib(name, mib, &len) < 0) {
181 		if (errno == ENOENT) {
182 			errx(1, "unknown oid '%s'", name);
183 		} else {
184 			err(1, "sysctlnametomib(\"%s\")", name);
185 		}
186 	}
187 
188 	if (oidfmt(mib, len, fmt, &kind))
189 		err(1, "couldn't find format of oid '%s'", name);
190 
191 	if (newval == NULL) {
192 		if ((kind & CTLTYPE) == CTLTYPE_NODE) {
193 			sysctl_all(mib, len);
194 		} else {
195 			i = show_var(mib, len);
196 			if (!i && !bflag)
197 				putchar('\n');
198 		}
199 	} else {
200 		if ((kind & CTLTYPE) == CTLTYPE_NODE)
201 			errx(1, "oid '%s' isn't a leaf node", name);
202 
203 		if (!(kind&CTLFLAG_WR))
204 			errx(1, "oid '%s' is read only", name);
205 
206 		switch (kind & CTLTYPE) {
207 			case CTLTYPE_INT:
208 				intval = (int) strtol(newval, NULL, 0);
209 				newval = &intval;
210 				newsize = sizeof(intval);
211 				break;
212 			case CTLTYPE_UINT:
213 				uintval = (int) strtoul(newval, NULL, 0);
214 				newval = &uintval;
215 				newsize = sizeof uintval;
216 				break;
217 			case CTLTYPE_LONG:
218 				longval = strtol(newval, NULL, 0);
219 				newval = &longval;
220 				newsize = sizeof longval;
221 				break;
222 			case CTLTYPE_ULONG:
223 				ulongval = strtoul(newval, NULL, 0);
224 				newval = &ulongval;
225 				newsize = sizeof ulongval;
226 				break;
227 			case CTLTYPE_STRING:
228 				break;
229 			case CTLTYPE_QUAD:
230 				quadval = strtoq(newval, NULL, 0);
231 				newval = &quadval;
232 				newsize = sizeof(quadval);
233 				break;
234 			case CTLTYPE_UQUAD:
235 				uquadval = strtouq(newval, NULL, 0);
236 				newval = &quadval;
237 				newsize = sizeof(quadval);
238 				break;
239 			case CTLTYPE_OPAQUE:
240 				if (strcmp(fmt, "T,dev_t") == 0 ||
241 				    strcmp(fmt, "T,udev_t") == 0
242 				) {
243 					set_T_dev_t((char*)newval, &newval,
244 						    &newsize);
245 					break;
246 				}
247 				/* FALLTHROUGH */
248 			default:
249 				errx(1, "oid '%s' is type %d,"
250 					" cannot set that", name,
251 					kind & CTLTYPE);
252 		}
253 
254 		i = show_var(mib, len);
255 		if (sysctl(mib, len, 0, 0, newval, newsize) == -1) {
256 			if (!i && !bflag)
257 				putchar('\n');
258 			switch (errno) {
259 			case EOPNOTSUPP:
260 				errx(1, "%s: value is not available",
261 					string);
262 			case ENOTDIR:
263 				errx(1, "%s: specification is incomplete",
264 					string);
265 			case ENOMEM:
266 				errx(1, "%s: type is unknown to this program",
267 					string);
268 			default:
269 				warn("%s", string);
270 				return;
271 			}
272 		}
273 		if (!bflag)
274 			printf(" -> ");
275 		i = nflag;
276 		nflag = 1;
277 		j = show_var(mib, len);
278 		if (!j && !bflag)
279 			putchar('\n');
280 		nflag = i;
281 	}
282 
283 	if (name_allocated != NULL)
284 		free(name_allocated);
285 }
286 
287 /* These functions will dump out various interesting structures. */
288 
289 static int
290 S_clockinfo(int l2, void *p)
291 {
292 	struct clockinfo *ci = (struct clockinfo*)p;
293 	if (l2 != sizeof(*ci))
294 		err(1, "S_clockinfo %d != %d", l2, sizeof(*ci));
295 	printf("{ hz = %d, tick = %d, tickadj = %d, profhz = %d, stathz = %d }",
296 		ci->hz, ci->tick, ci->tickadj, ci->profhz, ci->stathz);
297 	return (0);
298 }
299 
300 static int
301 S_loadavg(int l2, void *p)
302 {
303 	struct loadavg *tv = (struct loadavg*)p;
304 
305 	if (l2 != sizeof(*tv))
306 		err(1, "S_loadavg %d != %d", l2, sizeof(*tv));
307 
308 	printf("{ %.2f %.2f %.2f }",
309 		(double)tv->ldavg[0]/(double)tv->fscale,
310 		(double)tv->ldavg[1]/(double)tv->fscale,
311 		(double)tv->ldavg[2]/(double)tv->fscale);
312 	return (0);
313 }
314 
315 static int
316 S_timeval(int l2, void *p)
317 {
318 	struct timeval *tv = (struct timeval*)p;
319 	time_t tv_sec;
320 	char *p1, *p2;
321 
322 	if (l2 != sizeof(*tv))
323 		err(1, "S_timeval %d != %d", l2, sizeof(*tv));
324 	printf("{ sec = %ld, usec = %ld } ",
325 		tv->tv_sec, tv->tv_usec);
326 	tv_sec = tv->tv_sec;
327 	p1 = strdup(ctime(&tv_sec));
328 	for (p2=p1; *p2 ; p2++)
329 		if (*p2 == '\n')
330 			*p2 = '\0';
331 	fputs(p1, stdout);
332 	return (0);
333 }
334 
335 static int
336 T_dev_t(int l2, void *p)
337 {
338 	dev_t *d = (dev_t *)p;
339 	if (l2 != sizeof(*d))
340 		err(1, "T_dev_T %d != %d", l2, sizeof(*d));
341 	if ((int)(*d) != -1) {
342 		if (minor(*d) > 255 || minor(*d) < 0)
343 			printf("{ major = %d, minor = 0x%x }",
344 				major(*d), minor(*d));
345 		else
346 			printf("{ major = %d, minor = %d }",
347 				major(*d), minor(*d));
348 	}
349 	return (0);
350 }
351 
352 static void
353 set_T_dev_t(const char *path, void **val, int *size)
354 {
355 	static struct stat statb;
356 
357 	if (strcmp(path, "none") && strcmp(path, "off")) {
358 		int rc = stat (path, &statb);
359 		if (rc) {
360 			err(1, "cannot stat %s", path);
361 		}
362 
363 		if (!S_ISCHR(statb.st_mode)) {
364 			errx(1, "must specify a device special file.");
365 		}
366 	} else {
367 		statb.st_rdev = NODEV;
368 	}
369 	*val = (char*) &statb.st_rdev;
370 	*size = sizeof statb.st_rdev;
371 }
372 
373 /*
374  * These functions uses a presently undocumented interface to the kernel
375  * to walk the tree and get the type so it can print the value.
376  * This interface is under work and consideration, and should probably
377  * be killed with a big axe by the first person who can find the time.
378  * (be aware though, that the proper interface isn't as obvious as it
379  * may seem, there are various conflicting requirements.
380  */
381 
382 static int
383 oidfmt(int *oid, size_t len, char *fmt, u_int *kind)
384 {
385 	int qoid[CTL_MAXNAME+2];
386 	u_char buf[BUFSIZ];
387 	int i;
388 	size_t j;
389 
390 	qoid[0] = 0;
391 	qoid[1] = 4;
392 	memcpy(qoid + 2, oid, len * sizeof(int));
393 
394 	j = sizeof(buf);
395 	i = sysctl(qoid, len + 2, buf, &j, 0, 0);
396 	if (i)
397 		err(1, "sysctl fmt %d %d %d", i, j, errno);
398 
399 	if (kind)
400 		*kind = *(u_int *)buf;
401 
402 	if (fmt)
403 		strcpy(fmt, (char *)(buf + sizeof(u_int)));
404 	return 0;
405 }
406 
407 #ifdef __i386__
408 /*
409  * Code to map a bootdev major number into a suitable device name.
410  * Major numbers are mapped into names as in boot2.c
411  */
412 struct _foo {
413 	int majdev;
414 	const char *name;
415 } maj2name[] = {
416 	{ 30,	"ad" },
417 	{ 0,	"wd" },
418 	{ 1,	"wfd" },
419 	{ 2,	"fd" },
420 	{ 4,	"da" },
421 	{ -1,	NULL }	/* terminator */
422 };
423 
424 static int
425 machdep_bootdev(u_long value)
426 {
427 	int majdev, unit, slice, part;
428 	struct _foo *p;
429 
430 	if ((value & B_MAGICMASK) != B_DEVMAGIC) {
431 		printf("invalid (0x%08lx)", value);
432 		return 0;
433 	}
434 	majdev = B_TYPE(value);
435 	unit = B_UNIT(value);
436 	slice = B_SLICE(value);
437 	part = B_PARTITION(value);
438 	if (majdev == 2) {	/* floppy, as known to the boot block... */
439 		printf("/dev/fd%d", unit);
440 		return 0;
441 	}
442 	for (p = maj2name; p->name != NULL && p->majdev != majdev ; p++) ;
443 	if (p->name != NULL) {	/* found */
444 		if (slice == WHOLE_DISK_SLICE)
445 			printf("/dev/%s%d%c", p->name, unit, part);
446 		else
447 			printf("/dev/%s%ds%d%c",
448 			    p->name, unit, slice - BASE_SLICE + 1, part + 'a');
449 	} else
450 		printf("unknown (major %d unit %d slice %d part %d)",
451 			majdev, unit, slice, part);
452 	return 0;
453 }
454 #endif
455 
456 /*
457  * This formats and outputs the value of one variable
458  *
459  * Returns zero if anything was actually output.
460  * Returns one if didn't know what to do with this.
461  * Return minus one if we had errors.
462  */
463 
464 static int
465 show_var(int *oid, size_t nlen)
466 {
467 	u_char buf[BUFSIZ], *val, *p, *nul;
468 	char name[BUFSIZ], *fmt;
469 	const char *sep, *spacer;
470 	int qoid[CTL_MAXNAME+2];
471 	int i;
472 	size_t j, len;
473 	u_int kind;
474 	int (*func)(int, void *);
475 
476 	qoid[0] = 0;
477 	memcpy(qoid + 2, oid, nlen * sizeof(int));
478 
479 	qoid[1] = 1;
480 	j = sizeof(name);
481 	i = sysctl(qoid, nlen + 2, name, &j, 0, 0);
482 	if (i || !j)
483 		err(1, "sysctl name %d %d %d", i, j, errno);
484 
485 	if (Nflag) {
486 		printf("%s", name);
487 		return (0);
488 	}
489 
490 	if (eflag)
491 		sep = "=";
492 	else
493 		sep = ": ";
494 
495 	if (dflag) {	/* just print description */
496 		qoid[1] = 5;
497 		j = sizeof(buf);
498 		i = sysctl(qoid, nlen + 2, buf, &j, 0, 0);
499 		if (!nflag)
500 			printf("%s%s", name, sep);
501 		printf("%s", buf);
502 		return(0);
503 	}
504 	/* find an estimate of how much we need for this var */
505 	j = 0;
506 	i = sysctl(oid, nlen, 0, &j, 0, 0);
507 	j += j; /* we want to be sure :-) */
508 
509 	val = alloca(j + 1);
510 	len = j;
511 	i = sysctl(oid, nlen, val, &len, 0, 0);
512 	if (i || !len)
513 		return (1);
514 
515 	if (bflag) {
516 		fwrite(val, 1, len, stdout);
517 		return (0);
518 	}
519 
520 	val[len] = '\0';
521 	fmt = buf;
522 	oidfmt(oid, nlen, fmt, &kind);
523 	p = val;
524 	switch (*fmt) {
525 	case 'A':
526 		if (!nflag)
527 			printf("%s%s", name, sep);
528 		nul = memchr(p, '\0', len);
529 		fwrite(p, nul == NULL ? len : nul - p, 1, stdout);
530 		return (0);
531 
532 	case 'I':
533 		if (!nflag)
534 			printf("%s%s", name, sep);
535 		fmt++;
536 		spacer = "";
537 		while (len >= sizeof(int)) {
538 			if(*fmt == 'U')
539 				printf("%s%u", spacer, *(unsigned int *)p);
540 			else
541 				printf("%s%d", spacer, *(int *)p);
542 			spacer = " ";
543 			len -= sizeof(int);
544 			p += sizeof(int);
545 		}
546 		return (0);
547 
548 	case 'L':
549 		if (!nflag)
550 			printf("%s%s", name, sep);
551 		fmt++;
552 #ifdef __i386__
553 		if (!strcmp(name, "machdep.guessed_bootdev"))
554 			return machdep_bootdev(*(unsigned long *)p);
555 #endif
556 		spacer = "";
557 		while (len >= sizeof(long)) {
558 			if(*fmt == 'U')
559 				printf("%s%lu", spacer, *(unsigned long *)p);
560 			else
561 				printf("%s%ld", spacer, *(long *)p);
562 			spacer = " ";
563 			len -= sizeof(long);
564 			p += sizeof(long);
565 		}
566 		return (0);
567 
568 	case 'P':
569 		if (!nflag)
570 			printf("%s%s", name, sep);
571 		printf("%p", *(void **)p);
572 		return (0);
573 
574 	case 'Q':
575 		if (!nflag)
576 			printf("%s%s", name, sep);
577 		fmt++;
578 		spacer = "";
579 		while (len >= sizeof(quad_t)) {
580 			if(*fmt == 'U')
581 				printf("%s%qu", spacer, *(u_quad_t *)p);
582 			else
583 				printf("%s%qd", spacer, *(quad_t *)p);
584 			spacer = " ";
585 			len -= sizeof(int64_t);
586 			p += sizeof(int64_t);
587 		}
588 		return (0);
589 
590 	case 'T':
591 	case 'S':
592 		if (!oflag && !xflag) {
593 			i = 0;
594 			if (strcmp(fmt, "S,clockinfo") == 0)
595 				func = S_clockinfo;
596 			else if (strcmp(fmt, "S,timeval") == 0)
597 				func = S_timeval;
598 			else if (strcmp(fmt, "S,loadavg") == 0)
599 				func = S_loadavg;
600 			else if (strcmp(fmt, "T,dev_t") == 0)
601 				func = T_dev_t;
602 			else if (strcmp(fmt, "T,udev_t") == 0)
603 				func = T_dev_t;
604 			else
605 				func = NULL;
606 			if (func) {
607 				if (!nflag)
608 					printf("%s%s", name, sep);
609 				return ((*func)(len, p));
610 			}
611 		}
612 		/* FALL THROUGH */
613 	default:
614 		if (!oflag && !xflag)
615 			return (1);
616 		if (!nflag)
617 			printf("%s%s", name, sep);
618 		printf("Format:%s Length:%d Dump:0x", fmt, len);
619 		while (len-- && (xflag || p < val + 16))
620 			printf("%02x", *p++);
621 		if (!xflag && len > 16)
622 			printf("...");
623 		return (0);
624 	}
625 	return (1);
626 }
627 
628 static int
629 sysctl_all(int *oid, size_t len)
630 {
631 	int name1[22], name2[22];
632 	int retval;
633 	size_t i, l1, l2;
634 
635 	name1[0] = 0;
636 	name1[1] = 2;
637 	l1 = 2;
638 	if (len) {
639 		memcpy(name1+2, oid, len * sizeof(int));
640 		l1 += len;
641 	} else {
642 		name1[2] = 1;
643 		l1++;
644 	}
645 	for (;;) {
646 		l2 = sizeof(name2);
647 		retval = sysctl(name1, l1, name2, &l2, 0, 0);
648 		if (retval < 0) {
649 			if (errno == ENOENT)
650 				return 0;
651 			else
652 				err(1, "sysctl(getnext) %d %d", retval, l2);
653 		}
654 
655 		l2 /= sizeof(int);
656 
657 		if (l2 < len)
658 			return 0;
659 
660 		for (i = 0; i < len; i++)
661 			if (name2[i] != oid[i])
662 				return 0;
663 
664 		retval = show_var(name2, l2);
665 		if (retval == 0 && !bflag)
666 			putchar('\n');
667 
668 		memcpy(name1+2, name2, l2 * sizeof(int));
669 		l1 = 2 + l2;
670 	}
671 }
672