2 * Copyright (c) 1986, 1988, 1991, 1993
3 * The Regents of the University of California. All rights reserved.
4 * (c) UNIX System Laboratories, Inc.
5 * All or some portions of this file are derived from material licensed
6 * to the University of California by American Telephone and Telegraph
7 * Co. or Unix System Laboratories, Inc. and are reproduced herein with
8 * the permission of UNIX System Laboratories, Inc.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 3. Neither the name of the University nor the names of its contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, 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
34 * @(#)subr_prf.c 8.3 (Berkeley) 1/21/94
37 #include <sys/cdefs.h>
38 __FBSDID("$FreeBSD$");
42 #include "opt_printf.h"
45 #include <sys/param.h>
47 #include <sys/systm.h>
50 #include <sys/mutex.h>
52 #include <sys/kernel.h>
53 #include <sys/msgbuf.h>
54 #include <sys/malloc.h>
57 #include <sys/stddef.h>
58 #include <sys/sysctl.h>
60 #include <sys/syslog.h>
64 #include <sys/ctype.h>
72 * Note that stdarg.h and the ANSI style va_start macro is used for both
73 * ANSI and traditional C compilers.
76 #include <machine/stdarg.h>
82 * This is needed for sbuf_putbuf() when compiled into userland. Due to the
83 * shared nature of this file, it's the only place to put it.
95 /* Max number conversion buffer length: a u_quad_t in base 2, plus NUL byte. */
96 #define MAXNBUF (sizeof(intmax_t) * NBBY + 1)
108 struct snprintf_arg {
115 static void msglogchar(int c, int pri);
116 static void msglogstr(char *str, int pri, int filter_cr);
117 static void putchar(int ch, void *arg);
118 static char *ksprintn(char *nbuf, uintmax_t num, int base, int *len, int upper);
119 static void snprintf_func(int ch, void *arg);
121 static int msgbufmapped; /* Set when safe to use msgbuf */
124 static int log_console_output = 1;
125 SYSCTL_INT(_kern, OID_AUTO, log_console_output, CTLFLAG_RWTUN,
126 &log_console_output, 0, "Duplicate console output to the syslog");
129 * See the comment in log_console() below for more explanation of this.
131 static int log_console_add_linefeed;
132 SYSCTL_INT(_kern, OID_AUTO, log_console_add_linefeed, CTLFLAG_RWTUN,
133 &log_console_add_linefeed, 0, "log_console() adds extra newlines");
135 static int always_console_output;
136 SYSCTL_INT(_kern, OID_AUTO, always_console_output, CTLFLAG_RWTUN,
137 &always_console_output, 0, "Always output to console despite TIOCCONS");
140 * Warn that a system table is full.
143 tablefull(const char *tab)
146 log(LOG_ERR, "%s: table is full\n", tab);
150 * Uprintf prints to the controlling terminal for the current process.
153 uprintf(const char *fmt, ...)
156 struct putchar_arg pca;
162 if (TD_IS_IDLETHREAD(td))
165 sx_slock(&proctree_lock);
168 if ((p->p_flag & P_CONTROLT) == 0) {
170 sx_sunlock(&proctree_lock);
173 SESS_LOCK(p->p_session);
174 pca.tty = p->p_session->s_ttyp;
175 SESS_UNLOCK(p->p_session);
177 if (pca.tty == NULL) {
178 sx_sunlock(&proctree_lock);
185 sx_sunlock(&proctree_lock);
186 retval = kvprintf(fmt, putchar, &pca, 10, ap);
193 * tprintf and vtprintf print on the controlling terminal associated with the
194 * given session, possibly to the log as well.
197 tprintf(struct proc *p, int pri, const char *fmt, ...)
202 vtprintf(p, pri, fmt, ap);
207 vtprintf(struct proc *p, int pri, const char *fmt, va_list ap)
209 struct tty *tp = NULL;
211 struct putchar_arg pca;
212 struct session *sess = NULL;
214 sx_slock(&proctree_lock);
219 if (p->p_flag & P_CONTROLT && p->p_session->s_ttyvp) {
224 if (tp != NULL && tty_checkoutq(tp))
237 sx_sunlock(&proctree_lock);
238 kvprintf(fmt, putchar, &pca, 10, ap);
247 * Ttyprintf displays a message on a tty; it should be used only by
248 * the tty driver, or anything that knows the underlying tty will not
249 * be revoke(2)'d away. Other callers should use tprintf.
252 ttyprintf(struct tty *tp, const char *fmt, ...)
255 struct putchar_arg pca;
262 retval = kvprintf(fmt, putchar, &pca, 10, ap);
268 _vprintf(int level, int flags, const char *fmt, va_list ap)
270 struct putchar_arg pca;
272 #ifdef PRINTF_BUFR_SIZE
273 char bufr[PRINTF_BUFR_SIZE];
279 #ifdef PRINTF_BUFR_SIZE
281 pca.p_next = pca.p_bufr;
282 pca.n_bufr = sizeof(bufr);
283 pca.remain = sizeof(bufr);
286 /* Don't buffer console output. */
290 retval = kvprintf(fmt, putchar, &pca, 10, ap);
292 #ifdef PRINTF_BUFR_SIZE
293 /* Write any buffered console/log output: */
294 if (*pca.p_bufr != '\0') {
295 if (pca.flags & TOLOG)
296 msglogstr(pca.p_bufr, level, /*filter_cr*/1);
298 if (pca.flags & TOCONS)
307 * Log writes to the log buffer, and guarantees not to sleep (so can be
308 * called by interrupt routines). If there is no process reading the
309 * log yet, it writes to the console also.
312 log(int level, const char *fmt, ...)
317 vlog(level, fmt, ap);
322 vlog(int level, const char *fmt, va_list ap)
325 (void)_vprintf(level, log_open ? TOLOG : TOCONS | TOLOG, fmt, ap);
329 #define CONSCHUNK 128
332 log_console(struct uio *uio)
338 if (!log_console_output)
341 pri = LOG_INFO | LOG_CONSOLE;
343 consbuffer = malloc(CONSCHUNK, M_TEMP, M_WAITOK);
346 while (uio->uio_resid > 0) {
347 c = imin(uio->uio_resid, CONSCHUNK - 1);
348 error = uiomove(consbuffer, c, uio);
351 /* Make sure we're NUL-terminated */
352 consbuffer[c] = '\0';
353 if (consbuffer[c - 1] == '\n')
357 msglogstr(consbuffer, pri, /*filter_cr*/ 1);
360 * The previous behavior in log_console() is preserved when
361 * log_console_add_linefeed is non-zero. For that behavior, if an
362 * individual console write came in that was not terminated with a
363 * line feed, it would add a line feed.
365 * This results in different data in the message buffer than
366 * appears on the system console (which doesn't add extra line feed
369 * A number of programs and rc scripts write a line feed, or a period
370 * and a line feed when they have completed their operation. On
371 * the console, this looks seamless, but when displayed with
372 * 'dmesg -a', you wind up with output that looks like this:
377 * On the console, it looks like this:
380 * We could add logic to detect that situation, or just not insert
381 * the extra newlines. Set the kern.log_console_add_linefeed
382 * sysctl/tunable variable to get the old behavior.
384 if (!nl && log_console_add_linefeed) {
385 consbuffer[0] = '\n';
386 consbuffer[1] = '\0';
387 msglogstr(consbuffer, pri, /*filter_cr*/ 1);
391 free(consbuffer, M_TEMP);
396 printf(const char *fmt, ...)
402 retval = vprintf(fmt, ap);
409 vprintf(const char *fmt, va_list ap)
413 retval = _vprintf(-1, TOCONS | TOLOG, fmt, ap);
422 prf_putbuf(char *bufr, int flags, int pri)
426 msglogstr(bufr, pri, /*filter_cr*/1);
428 if (flags & TOCONS) {
429 if ((panicstr == NULL) && (constty != NULL))
430 msgbuf_addstr(&consmsgbuf, -1,
431 bufr, /*filter_cr*/ 0);
433 if ((constty == NULL) ||(always_console_output))
439 putbuf(int c, struct putchar_arg *ap)
441 /* Check if no console output buffer was provided. */
442 if (ap->p_bufr == NULL) {
443 /* Output direct to the console. */
444 if (ap->flags & TOCONS)
447 if (ap->flags & TOLOG)
448 msglogchar(c, ap->pri);
450 /* Buffer the character: */
454 /* Always leave the buffer zero terminated. */
457 /* Check if the buffer needs to be flushed. */
458 if (ap->remain == 2 || c == '\n') {
459 prf_putbuf(ap->p_bufr, ap->flags, ap->pri);
461 ap->p_next = ap->p_bufr;
462 ap->remain = ap->n_bufr;
467 * Since we fill the buffer up one character at a time,
468 * this should not happen. We should always catch it when
469 * ap->remain == 2 (if not sooner due to a newline), flush
470 * the buffer and move on. One way this could happen is
471 * if someone sets PRINTF_BUFR_SIZE to 1 or something
474 KASSERT(ap->remain > 2, ("Bad buffer logic, remain = %zd",
480 * Print a character on console or users terminal. If destination is
481 * the console then the last bunch of characters are saved in msgbuf for
485 putchar(int c, void *arg)
487 struct putchar_arg *ap = (struct putchar_arg*) arg;
488 struct tty *tp = ap->tty;
489 int flags = ap->flags;
491 /* Don't use the tty code after a panic or while in ddb. */
498 if ((flags & TOTTY) && tp != NULL && panicstr == NULL)
501 if ((flags & (TOCONS | TOLOG)) && c != '\0')
506 * Scaled down version of sprintf(3).
509 sprintf(char *buf, const char *cfmt, ...)
515 retval = kvprintf(cfmt, NULL, (void *)buf, 10, ap);
522 * Scaled down version of vsprintf(3).
525 vsprintf(char *buf, const char *cfmt, va_list ap)
529 retval = kvprintf(cfmt, NULL, (void *)buf, 10, ap);
535 * Scaled down version of snprintf(3).
538 snprintf(char *str, size_t size, const char *format, ...)
543 va_start(ap, format);
544 retval = vsnprintf(str, size, format, ap);
550 * Scaled down version of vsnprintf(3).
553 vsnprintf(char *str, size_t size, const char *format, va_list ap)
555 struct snprintf_arg info;
560 retval = kvprintf(format, snprintf_func, &info, 10, ap);
561 if (info.remain >= 1)
567 * Kernel version which takes radix argument vsnprintf(3).
570 vsnrprintf(char *str, size_t size, int radix, const char *format, va_list ap)
572 struct snprintf_arg info;
577 retval = kvprintf(format, snprintf_func, &info, radix, ap);
578 if (info.remain >= 1)
584 snprintf_func(int ch, void *arg)
586 struct snprintf_arg *const info = arg;
588 if (info->remain >= 2) {
595 * Put a NUL-terminated ASCII number (base <= 36) in a buffer in reverse
596 * order; return an optional length and a pointer to the last character
597 * written in the buffer (i.e., the first character of the string).
598 * The buffer pointed to by `nbuf' must have length >= MAXNBUF.
601 ksprintn(char *nbuf, uintmax_t num, int base, int *lenp, int upper)
608 c = hex2ascii(num % base);
609 *++p = upper ? toupper(c) : c;
610 } while (num /= base);
617 * Scaled down version of printf(3).
619 * Two additional formats:
621 * The format %b is supported to decode error registers.
624 * printf("reg=%b\n", regval, "<base><arg>*");
626 * where <base> is the output base expressed as a control character, e.g.
627 * \10 gives octal; \20 gives hex. Each arg is a sequence of characters,
628 * the first of which gives the bit number to be inspected (origin 1), and
629 * the next characters (up to a control character, i.e. a character <= 32),
630 * give the name of the register. Thus:
632 * kvprintf("reg=%b\n", 3, "\10\2BITTWO\1BITONE");
634 * would produce output:
636 * reg=3<BITTWO,BITONE>
638 * XXX: %D -- Hexdump, takes pointer and separator string:
639 * ("%6D", ptr, ":") -> XX:XX:XX:XX:XX:XX
640 * ("%*D", len, ptr, " " -> XX XX XX XX ...
643 kvprintf(char const *fmt, void (*func)(int, void*), void *arg, int radix, va_list ap)
645 #define PCHAR(c) {int cc=(c); if (func) (*func)(cc,arg); else *d++ = cc; retval++; }
648 const char *p, *percent, *q;
652 int base, lflag, qflag, tmp, width, ladjust, sharpflag, neg, sign, dot;
653 int cflag, hflag, jflag, tflag, zflag;
656 int stop = 0, retval = 0;
665 fmt = "(fmt null)\n";
667 if (radix < 2 || radix > 36)
673 while ((ch = (u_char)*fmt++) != '%' || stop) {
679 qflag = 0; lflag = 0; ladjust = 0; sharpflag = 0; neg = 0;
680 sign = 0; dot = 0; dwidth = 0; upper = 0;
681 cflag = 0; hflag = 0; jflag = 0; tflag = 0; zflag = 0;
682 reswitch: switch (ch = (u_char)*fmt++) {
700 width = va_arg(ap, int);
706 dwidth = va_arg(ap, int);
714 case '1': case '2': case '3': case '4':
715 case '5': case '6': case '7': case '8': case '9':
716 for (n = 0;; ++fmt) {
717 n = n * 10 + ch - '0';
719 if (ch < '0' || ch > '9')
728 num = (u_int)va_arg(ap, int);
729 p = va_arg(ap, char *);
730 for (q = ksprintn(nbuf, num, *p++, NULL, 0); *q;)
738 if (num & (1 << (n - 1))) {
739 PCHAR(tmp ? ',' : '<');
740 for (; (n = *p) > ' '; ++p)
744 for (; *p > ' '; ++p)
753 if (!ladjust && width > 0)
756 PCHAR(va_arg(ap, int));
757 if (ladjust && width > 0)
762 up = va_arg(ap, u_char *);
763 p = va_arg(ap, char *);
767 PCHAR(hex2ascii(*up >> 4));
768 PCHAR(hex2ascii(*up & 0x0f));
799 *(va_arg(ap, intmax_t *)) = retval;
801 *(va_arg(ap, quad_t *)) = retval;
803 *(va_arg(ap, long *)) = retval;
805 *(va_arg(ap, size_t *)) = retval;
807 *(va_arg(ap, short *)) = retval;
809 *(va_arg(ap, char *)) = retval;
811 *(va_arg(ap, int *)) = retval;
818 sharpflag = (width == 0);
820 num = (uintptr_t)va_arg(ap, void *);
831 p = va_arg(ap, char *);
837 for (n = 0; n < dwidth && p[n]; n++)
842 if (!ladjust && width > 0)
847 if (ladjust && width > 0)
872 num = va_arg(ap, uintmax_t);
874 num = va_arg(ap, u_quad_t);
876 num = va_arg(ap, ptrdiff_t);
878 num = va_arg(ap, u_long);
880 num = va_arg(ap, size_t);
882 num = (u_short)va_arg(ap, int);
884 num = (u_char)va_arg(ap, int);
886 num = va_arg(ap, u_int);
890 num = va_arg(ap, intmax_t);
892 num = va_arg(ap, quad_t);
894 num = va_arg(ap, ptrdiff_t);
896 num = va_arg(ap, long);
898 num = va_arg(ap, ssize_t);
900 num = (short)va_arg(ap, int);
902 num = (char)va_arg(ap, int);
904 num = va_arg(ap, int);
906 if (sign && (intmax_t)num < 0) {
908 num = -(intmax_t)num;
910 p = ksprintn(nbuf, num, base, &n, upper);
912 if (sharpflag && num != 0) {
921 if (!ladjust && padc == '0')
922 dwidth = width - tmp;
923 width -= tmp + imax(dwidth, n);
930 if (sharpflag && num != 0) {
933 } else if (base == 16) {
950 while (percent < fmt)
953 * Since we ignore a formatting argument it is no
954 * longer safe to obey the remaining formatting
955 * arguments as the arguments will no longer match
966 * Put character in log buffer with a particular priority.
969 msglogchar(int c, int pri)
971 static int lastpri = -1;
978 if (c == '\0' || c == '\r')
980 if (pri != -1 && pri != lastpri) {
982 msgbuf_addchar(msgbufp, '\n');
985 msgbuf_addchar(msgbufp, '<');
986 for (p = ksprintn(nbuf, (uintmax_t)pri, 10, NULL, 0); *p;)
987 msgbuf_addchar(msgbufp, *p--);
988 msgbuf_addchar(msgbufp, '>');
991 msgbuf_addchar(msgbufp, c);
1001 msglogstr(char *str, int pri, int filter_cr)
1006 msgbuf_addstr(msgbufp, pri, str, filter_cr);
1010 msgbufinit(void *ptr, int size)
1013 static struct msgbuf *oldp = NULL;
1015 size -= sizeof(*msgbufp);
1017 msgbufp = (struct msgbuf *)(cp + size);
1018 msgbuf_reinit(msgbufp, cp, size);
1019 if (msgbufmapped && oldp != msgbufp)
1020 msgbuf_copy(oldp, msgbufp);
1025 static int unprivileged_read_msgbuf = 1;
1026 SYSCTL_INT(_security_bsd, OID_AUTO, unprivileged_read_msgbuf,
1027 CTLFLAG_RW, &unprivileged_read_msgbuf, 0,
1028 "Unprivileged processes may read the kernel message buffer");
1030 /* Sysctls for accessing/clearing the msgbuf */
1032 sysctl_kern_msgbuf(SYSCTL_HANDLER_ARGS)
1038 if (!unprivileged_read_msgbuf) {
1039 error = priv_check(req->td, PRIV_MSGBUF);
1044 /* Read the whole buffer, one chunk at a time. */
1045 mtx_lock(&msgbuf_lock);
1046 msgbuf_peekbytes(msgbufp, NULL, 0, &seq);
1048 len = msgbuf_peekbytes(msgbufp, buf, sizeof(buf), &seq);
1049 mtx_unlock(&msgbuf_lock);
1051 return (SYSCTL_OUT(req, "", 1)); /* add nulterm */
1053 error = sysctl_handle_opaque(oidp, buf, len, req);
1057 mtx_lock(&msgbuf_lock);
1061 SYSCTL_PROC(_kern, OID_AUTO, msgbuf,
1062 CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_MPSAFE,
1063 NULL, 0, sysctl_kern_msgbuf, "A", "Contents of kernel message buffer");
1065 static int msgbuf_clearflag;
1068 sysctl_kern_msgbuf_clear(SYSCTL_HANDLER_ARGS)
1071 error = sysctl_handle_int(oidp, oidp->oid_arg1, oidp->oid_arg2, req);
1072 if (!error && req->newptr) {
1073 mtx_lock(&msgbuf_lock);
1074 msgbuf_clear(msgbufp);
1075 mtx_unlock(&msgbuf_lock);
1076 msgbuf_clearflag = 0;
1081 SYSCTL_PROC(_kern, OID_AUTO, msgbuf_clear,
1082 CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_SECURE | CTLFLAG_MPSAFE,
1083 &msgbuf_clearflag, 0, sysctl_kern_msgbuf_clear, "I",
1084 "Clear kernel message buffer");
1088 DB_SHOW_COMMAND(msgbuf, db_show_msgbuf)
1092 if (!msgbufmapped) {
1093 db_printf("msgbuf not mapped yet\n");
1096 db_printf("msgbufp = %p\n", msgbufp);
1097 db_printf("magic = %x, size = %d, r= %u, w = %u, ptr = %p, cksum= %u\n",
1098 msgbufp->msg_magic, msgbufp->msg_size, msgbufp->msg_rseq,
1099 msgbufp->msg_wseq, msgbufp->msg_ptr, msgbufp->msg_cksum);
1100 for (i = 0; i < msgbufp->msg_size && !db_pager_quit; i++) {
1101 j = MSGBUF_SEQ_TO_POS(msgbufp, i + msgbufp->msg_rseq);
1102 db_printf("%c", msgbufp->msg_ptr[j]);
1110 hexdump(const void *ptr, int length, const char *hdr, int flags)
1114 const unsigned char *cp;
1117 if ((flags & HD_DELIM_MASK) != 0)
1118 delim = (flags & HD_DELIM_MASK) >> 8;
1122 if ((flags & HD_COLUMN_MASK) != 0)
1123 cols = flags & HD_COLUMN_MASK;
1128 for (i = 0; i < length; i+= cols) {
1132 if ((flags & HD_OMIT_COUNT) == 0)
1135 if ((flags & HD_OMIT_HEX) == 0) {
1136 for (j = 0; j < cols; j++) {
1139 printf("%c%02x", delim, cp[k]);
1145 if ((flags & HD_OMIT_CHARS) == 0) {
1147 for (j = 0; j < cols; j++) {
1151 else if (cp[k] >= ' ' && cp[k] <= '~')
1152 printf("%c", cp[k]);
1161 #endif /* _KERNEL */
1164 sbuf_hexdump(struct sbuf *sb, const void *ptr, int length, const char *hdr,
1169 const unsigned char *cp;
1172 if ((flags & HD_DELIM_MASK) != 0)
1173 delim = (flags & HD_DELIM_MASK) >> 8;
1177 if ((flags & HD_COLUMN_MASK) != 0)
1178 cols = flags & HD_COLUMN_MASK;
1183 for (i = 0; i < length; i+= cols) {
1185 sbuf_printf(sb, "%s", hdr);
1187 if ((flags & HD_OMIT_COUNT) == 0)
1188 sbuf_printf(sb, "%04x ", i);
1190 if ((flags & HD_OMIT_HEX) == 0) {
1191 for (j = 0; j < cols; j++) {
1194 sbuf_printf(sb, "%c%02x", delim, cp[k]);
1196 sbuf_printf(sb, " ");
1200 if ((flags & HD_OMIT_CHARS) == 0) {
1201 sbuf_printf(sb, " |");
1202 for (j = 0; j < cols; j++) {
1205 sbuf_printf(sb, " ");
1206 else if (cp[k] >= ' ' && cp[k] <= '~')
1207 sbuf_printf(sb, "%c", cp[k]);
1209 sbuf_printf(sb, ".");
1211 sbuf_printf(sb, "|");
1213 sbuf_printf(sb, "\n");
1219 counted_warning(unsigned *counter, const char *msg)
1228 if (atomic_cmpset_int(counter, c, c - 1)) {
1230 log(LOG_INFO, "pid %d (%s) %s%s\n",
1231 td->td_proc->p_pid, td->td_name, msg,
1232 c > 1 ? "" : " - not logging anymore");
1241 sbuf_putbuf(struct sbuf *sb)
1244 prf_putbuf(sbuf_data(sb), TOLOG | TOCONS, -1);
1248 sbuf_putbuf(struct sbuf *sb)
1251 printf("%s", sbuf_data(sb));