xref: /freebsd/sbin/dmesg/dmesg.c (revision 6af83ee0d2941d18880b6aaa2b4facd1d30c6106)
1 /*-
2  * Copyright (c) 1991, 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  * 4. Neither the name of the University nor the names of its contributors
14  *    may be used to endorse or promote products derived from this software
15  *    without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  */
29 
30 #if 0
31 #ifndef lint
32 static const char copyright[] =
33 "@(#) Copyright (c) 1991, 1993\n\
34 	The Regents of the University of California.  All rights reserved.\n";
35 #endif /* not lint */
36 
37 #ifndef lint
38 static const char sccsid[] = "@(#)dmesg.c	8.1 (Berkeley) 6/5/93";
39 #endif /* not lint */
40 #endif
41 #include <sys/cdefs.h>
42 __FBSDID("$FreeBSD$");
43 
44 #include <sys/types.h>
45 #include <sys/msgbuf.h>
46 #include <sys/sysctl.h>
47 
48 #include <err.h>
49 #include <errno.h>
50 #include <fcntl.h>
51 #include <kvm.h>
52 #include <limits.h>
53 #include <locale.h>
54 #include <nlist.h>
55 #include <stdio.h>
56 #include <stdlib.h>
57 #include <string.h>
58 #include <unistd.h>
59 #include <vis.h>
60 #include <sys/syslog.h>
61 
62 char s_msgbufp[] = "_msgbufp";
63 
64 struct nlist nl[] = {
65 #define	X_MSGBUF	0
66 	{ s_msgbufp, 0, 0, 0, 0 },
67 	{ NULL, 0, 0, 0, 0 },
68 };
69 
70 void usage(void) __dead2;
71 
72 #define	KREAD(addr, var) \
73 	kvm_read(kd, addr, &var, sizeof(var)) != sizeof(var)
74 
75 int
76 main(int argc, char *argv[])
77 {
78 	struct msgbuf *bufp, cur;
79 	char *bp, *ep, *memf, *nextp, *nlistf, *p, *q, *visbp;
80 	kvm_t *kd;
81 	size_t buflen, bufpos;
82 	long pri;
83 	int all, ch;
84 
85 	all = 0;
86 	(void) setlocale(LC_CTYPE, "");
87 	memf = nlistf = NULL;
88 	while ((ch = getopt(argc, argv, "aM:N:")) != -1)
89 		switch(ch) {
90 		case 'a':
91 			all++;
92 			break;
93 		case 'M':
94 			memf = optarg;
95 			break;
96 		case 'N':
97 			nlistf = optarg;
98 			break;
99 		case '?':
100 		default:
101 			usage();
102 		}
103 	argc -= optind;
104 	if (argc != 0)
105 		usage();
106 
107 	if (memf == NULL) {
108 		/*
109 		 * Running kernel.  Use sysctl.  This gives an unwrapped
110 		 * buffer as a side effect.
111 		 */
112 		if (sysctlbyname("kern.msgbuf", NULL, &buflen, NULL, 0) == -1)
113 			err(1, "sysctl kern.msgbuf");
114 		if ((bp = malloc(buflen + 2)) == NULL)
115 			errx(1, "malloc failed");
116 		if (sysctlbyname("kern.msgbuf", bp, &buflen, NULL, 0) == -1)
117 			err(1, "sysctl kern.msgbuf");
118 	} else {
119 		/* Read in kernel message buffer and do sanity checks. */
120 		kd = kvm_open(nlistf, memf, NULL, O_RDONLY, "dmesg");
121 		if (kd == NULL)
122 			exit (1);
123 		if (kvm_nlist(kd, nl) == -1)
124 			errx(1, "kvm_nlist: %s", kvm_geterr(kd));
125 		if (nl[X_MSGBUF].n_type == 0)
126 			errx(1, "%s: msgbufp not found",
127 			    nlistf ? nlistf : "namelist");
128 		if (KREAD(nl[X_MSGBUF].n_value, bufp) || KREAD((long)bufp, cur))
129 			errx(1, "kvm_read: %s", kvm_geterr(kd));
130 		if (cur.msg_magic != MSG_MAGIC)
131 			errx(1, "kernel message buffer has different magic "
132 			    "number");
133 		if ((bp = malloc(cur.msg_size + 2)) == NULL)
134 			errx(1, "malloc failed");
135 
136 		/* Unwrap the circular buffer to start from the oldest data. */
137 		bufpos = MSGBUF_SEQ_TO_POS(&cur, cur.msg_wseq);
138 		if (kvm_read(kd, (long)&cur.msg_ptr[bufpos], bp,
139 		    cur.msg_size - bufpos) != (ssize_t)(cur.msg_size - bufpos))
140 			errx(1, "kvm_read: %s", kvm_geterr(kd));
141 		if (bufpos != 0 && kvm_read(kd, (long)cur.msg_ptr,
142 		    &bp[cur.msg_size - bufpos], bufpos) != (ssize_t)bufpos)
143 			errx(1, "kvm_read: %s", kvm_geterr(kd));
144 		kvm_close(kd);
145 		buflen = cur.msg_size;
146 	}
147 
148 	/*
149 	 * Ensure that the buffer ends with a newline and a \0 to avoid
150 	 * complications below.  We left space above.
151 	 */
152 	if (buflen == 0 || bp[buflen - 1] != '\n')
153 		bp[buflen++] = '\n';
154 	bp[buflen] = '\0';
155 
156 	if ((visbp = malloc(4 * buflen + 1)) == NULL)
157 		errx(1, "malloc failed");
158 
159 	/*
160 	 * The message buffer is circular, but has been unwrapped so that
161 	 * the oldest data comes first.  The data will be preceded by \0's
162 	 * if the message buffer was not full.
163 	 */
164 	p = bp;
165 	ep = &bp[buflen];
166 	if (*p == '\0') {
167 		/* Strip leading \0's */
168 		while (*p == '\0')
169 			p++;
170 	} else if (!all) {
171 		/* Skip the first line, since it is probably incomplete. */
172 		p = memchr(p, '\n', ep - p);
173 		p++;
174 	}
175 	for (; p < ep; p = nextp) {
176 		nextp = memchr(p, '\n', ep - p);
177 		nextp++;
178 
179 		/* Skip ^<[0-9]+> syslog sequences. */
180 		if (*p == '<') {
181 			errno = 0;
182 			pri = strtol(p + 1, &q, 10);
183 			if (*q == '>' && pri >= 0 && pri < INT_MAX &&
184 			    errno == 0) {
185 				if (LOG_FAC(pri) != LOG_KERN && !all)
186 					continue;
187 				p = q + 1;
188 			}
189 		}
190 
191 		(void)strvisx(visbp, p, nextp - p, 0);
192 		(void)printf("%s", visbp);
193 	}
194 	exit(0);
195 }
196 
197 void
198 usage(void)
199 {
200 	(void)fprintf(stderr, "usage: dmesg [-a] [-M core [-N system]]\n");
201 	exit(1);
202 }
203