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 * 4. 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.
75 #include <machine/stdarg.h>
83 /* Max number conversion buffer length: a u_quad_t in base 2, plus NUL byte. */
84 #define MAXNBUF (sizeof(intmax_t) * NBBY + 1)
103 static void msglogchar(int c, int pri);
104 static void msglogstr(char *str, int pri, int filter_cr);
105 static void putchar(int ch, void *arg);
106 static char *ksprintn(char *nbuf, uintmax_t num, int base, int *len, int upper);
107 static void snprintf_func(int ch, void *arg);
109 static int msgbufmapped; /* Set when safe to use msgbuf */
112 static int log_console_output = 1;
113 TUNABLE_INT("kern.log_console_output", &log_console_output);
114 SYSCTL_INT(_kern, OID_AUTO, log_console_output, CTLFLAG_RW,
115 &log_console_output, 0, "Duplicate console output to the syslog.");
118 * See the comment in log_console() below for more explanation of this.
120 static int log_console_add_linefeed = 0;
121 TUNABLE_INT("kern.log_console_add_linefeed", &log_console_add_linefeed);
122 SYSCTL_INT(_kern, OID_AUTO, log_console_add_linefeed, CTLFLAG_RW,
123 &log_console_add_linefeed, 0, "log_console() adds extra newlines.");
125 static int always_console_output = 0;
126 TUNABLE_INT("kern.always_console_output", &always_console_output);
127 SYSCTL_INT(_kern, OID_AUTO, always_console_output, CTLFLAG_RW,
128 &always_console_output, 0, "Always output to console despite TIOCCONS.");
131 * Warn that a system table is full.
134 tablefull(const char *tab)
137 log(LOG_ERR, "%s: table is full\n", tab);
141 * Uprintf prints to the controlling terminal for the current process.
144 uprintf(const char *fmt, ...)
147 struct putchar_arg pca;
153 if (TD_IS_IDLETHREAD(td))
156 sx_slock(&proctree_lock);
159 if ((p->p_flag & P_CONTROLT) == 0) {
161 sx_sunlock(&proctree_lock);
164 SESS_LOCK(p->p_session);
165 pca.tty = p->p_session->s_ttyp;
166 SESS_UNLOCK(p->p_session);
168 if (pca.tty == NULL) {
169 sx_sunlock(&proctree_lock);
176 sx_sunlock(&proctree_lock);
177 retval = kvprintf(fmt, putchar, &pca, 10, ap);
184 * tprintf and vtprintf print on the controlling terminal associated with the
185 * given session, possibly to the log as well.
188 tprintf(struct proc *p, int pri, const char *fmt, ...)
193 vtprintf(p, pri, fmt, ap);
198 vtprintf(struct proc *p, int pri, const char *fmt, va_list ap)
200 struct tty *tp = NULL;
202 struct putchar_arg pca;
203 struct session *sess = NULL;
205 sx_slock(&proctree_lock);
210 if (p->p_flag & P_CONTROLT && p->p_session->s_ttyvp) {
215 if (tp != NULL && tty_checkoutq(tp))
228 sx_sunlock(&proctree_lock);
229 kvprintf(fmt, putchar, &pca, 10, ap);
238 * Ttyprintf displays a message on a tty; it should be used only by
239 * the tty driver, or anything that knows the underlying tty will not
240 * be revoke(2)'d away. Other callers should use tprintf.
243 ttyprintf(struct tty *tp, const char *fmt, ...)
246 struct putchar_arg pca;
253 retval = kvprintf(fmt, putchar, &pca, 10, ap);
259 _vprintf(int level, int flags, const char *fmt, va_list ap)
261 struct putchar_arg pca;
263 #ifdef PRINTF_BUFR_SIZE
264 char bufr[PRINTF_BUFR_SIZE];
270 #ifdef PRINTF_BUFR_SIZE
272 pca.p_next = pca.p_bufr;
273 pca.n_bufr = sizeof(bufr);
274 pca.remain = sizeof(bufr);
277 /* Don't buffer console output. */
281 retval = kvprintf(fmt, putchar, &pca, 10, ap);
283 #ifdef PRINTF_BUFR_SIZE
284 /* Write any buffered console/log output: */
285 if (*pca.p_bufr != '\0') {
286 if (pca.flags & TOLOG)
287 msglogstr(pca.p_bufr, level, /*filter_cr*/1);
289 if (pca.flags & TOCONS)
298 * Log writes to the log buffer, and guarantees not to sleep (so can be
299 * called by interrupt routines). If there is no process reading the
300 * log yet, it writes to the console also.
303 log(int level, const char *fmt, ...)
308 (void)_vprintf(level, log_open ? TOLOG : TOCONS, fmt, ap);
314 #define CONSCHUNK 128
317 log_console(struct uio *uio)
323 if (!log_console_output)
326 pri = LOG_INFO | LOG_CONSOLE;
328 consbuffer = malloc(CONSCHUNK, M_TEMP, M_WAITOK);
331 while (uio->uio_resid > 0) {
332 c = imin(uio->uio_resid, CONSCHUNK - 1);
333 error = uiomove(consbuffer, c, uio);
336 /* Make sure we're NUL-terminated */
337 consbuffer[c] = '\0';
338 if (consbuffer[c - 1] == '\n')
342 msglogstr(consbuffer, pri, /*filter_cr*/ 1);
345 * The previous behavior in log_console() is preserved when
346 * log_console_add_linefeed is non-zero. For that behavior, if an
347 * individual console write came in that was not terminated with a
348 * line feed, it would add a line feed.
350 * This results in different data in the message buffer than
351 * appears on the system console (which doesn't add extra line feed
354 * A number of programs and rc scripts write a line feed, or a period
355 * and a line feed when they have completed their operation. On
356 * the console, this looks seamless, but when displayed with
357 * 'dmesg -a', you wind up with output that looks like this:
362 * On the console, it looks like this:
365 * We could add logic to detect that situation, or just not insert
366 * the extra newlines. Set the kern.log_console_add_linefeed
367 * sysctl/tunable variable to get the old behavior.
369 if (!nl && log_console_add_linefeed) {
370 consbuffer[0] = '\n';
371 consbuffer[1] = '\0';
372 msglogstr(consbuffer, pri, /*filter_cr*/ 1);
376 free(consbuffer, M_TEMP);
381 printf(const char *fmt, ...)
387 retval = vprintf(fmt, ap);
394 vprintf(const char *fmt, va_list ap)
398 retval = _vprintf(-1, TOCONS | TOLOG, fmt, ap);
407 putbuf(int c, struct putchar_arg *ap)
409 /* Check if no console output buffer was provided. */
410 if (ap->p_bufr == NULL) {
411 /* Output direct to the console. */
412 if (ap->flags & TOCONS)
415 if (ap->flags & TOLOG)
416 msglogchar(c, ap->pri);
418 /* Buffer the character: */
422 /* Always leave the buffer zero terminated. */
425 /* Check if the buffer needs to be flushed. */
426 if (ap->remain == 2 || c == '\n') {
428 if (ap->flags & TOLOG)
429 msglogstr(ap->p_bufr, ap->pri, /*filter_cr*/1);
431 if (ap->flags & TOCONS) {
432 if ((panicstr == NULL) && (constty != NULL))
433 msgbuf_addstr(&consmsgbuf, -1,
434 ap->p_bufr, /*filter_cr*/ 0);
436 if ((constty == NULL) ||(always_console_output))
440 ap->p_next = ap->p_bufr;
441 ap->remain = ap->n_bufr;
446 * Since we fill the buffer up one character at a time,
447 * this should not happen. We should always catch it when
448 * ap->remain == 2 (if not sooner due to a newline), flush
449 * the buffer and move on. One way this could happen is
450 * if someone sets PRINTF_BUFR_SIZE to 1 or something
453 KASSERT(ap->remain > 2, ("Bad buffer logic, remain = %zd",
459 * Print a character on console or users terminal. If destination is
460 * the console then the last bunch of characters are saved in msgbuf for
464 putchar(int c, void *arg)
466 struct putchar_arg *ap = (struct putchar_arg*) arg;
467 struct tty *tp = ap->tty;
468 int flags = ap->flags;
470 /* Don't use the tty code after a panic or while in ddb. */
477 if ((flags & TOTTY) && tp != NULL && panicstr == NULL)
480 if ((flags & (TOCONS | TOLOG)) && c != '\0')
485 * Scaled down version of sprintf(3).
488 sprintf(char *buf, const char *cfmt, ...)
494 retval = kvprintf(cfmt, NULL, (void *)buf, 10, ap);
501 * Scaled down version of vsprintf(3).
504 vsprintf(char *buf, const char *cfmt, va_list ap)
508 retval = kvprintf(cfmt, NULL, (void *)buf, 10, ap);
514 * Scaled down version of snprintf(3).
517 snprintf(char *str, size_t size, const char *format, ...)
522 va_start(ap, format);
523 retval = vsnprintf(str, size, format, ap);
529 * Scaled down version of vsnprintf(3).
532 vsnprintf(char *str, size_t size, const char *format, va_list ap)
534 struct snprintf_arg info;
539 retval = kvprintf(format, snprintf_func, &info, 10, ap);
540 if (info.remain >= 1)
546 * Kernel version which takes radix argument vsnprintf(3).
549 vsnrprintf(char *str, size_t size, int radix, const char *format, va_list ap)
551 struct snprintf_arg info;
556 retval = kvprintf(format, snprintf_func, &info, radix, ap);
557 if (info.remain >= 1)
563 snprintf_func(int ch, void *arg)
565 struct snprintf_arg *const info = arg;
567 if (info->remain >= 2) {
574 * Put a NUL-terminated ASCII number (base <= 36) in a buffer in reverse
575 * order; return an optional length and a pointer to the last character
576 * written in the buffer (i.e., the first character of the string).
577 * The buffer pointed to by `nbuf' must have length >= MAXNBUF.
580 ksprintn(char *nbuf, uintmax_t num, int base, int *lenp, int upper)
587 c = hex2ascii(num % base);
588 *++p = upper ? toupper(c) : c;
589 } while (num /= base);
596 * Scaled down version of printf(3).
598 * Two additional formats:
600 * The format %b is supported to decode error registers.
603 * printf("reg=%b\n", regval, "<base><arg>*");
605 * where <base> is the output base expressed as a control character, e.g.
606 * \10 gives octal; \20 gives hex. Each arg is a sequence of characters,
607 * the first of which gives the bit number to be inspected (origin 1), and
608 * the next characters (up to a control character, i.e. a character <= 32),
609 * give the name of the register. Thus:
611 * kvprintf("reg=%b\n", 3, "\10\2BITTWO\1BITONE\n");
613 * would produce output:
615 * reg=3<BITTWO,BITONE>
617 * XXX: %D -- Hexdump, takes pointer and separator string:
618 * ("%6D", ptr, ":") -> XX:XX:XX:XX:XX:XX
619 * ("%*D", len, ptr, " " -> XX XX XX XX ...
622 kvprintf(char const *fmt, void (*func)(int, void*), void *arg, int radix, va_list ap)
624 #define PCHAR(c) {int cc=(c); if (func) (*func)(cc,arg); else *d++ = cc; retval++; }
627 const char *p, *percent, *q;
631 int base, lflag, qflag, tmp, width, ladjust, sharpflag, neg, sign, dot;
632 int cflag, hflag, jflag, tflag, zflag;
635 int stop = 0, retval = 0;
644 fmt = "(fmt null)\n";
646 if (radix < 2 || radix > 36)
652 while ((ch = (u_char)*fmt++) != '%' || stop) {
658 qflag = 0; lflag = 0; ladjust = 0; sharpflag = 0; neg = 0;
659 sign = 0; dot = 0; dwidth = 0; upper = 0;
660 cflag = 0; hflag = 0; jflag = 0; tflag = 0; zflag = 0;
661 reswitch: switch (ch = (u_char)*fmt++) {
679 width = va_arg(ap, int);
685 dwidth = va_arg(ap, int);
693 case '1': case '2': case '3': case '4':
694 case '5': case '6': case '7': case '8': case '9':
695 for (n = 0;; ++fmt) {
696 n = n * 10 + ch - '0';
698 if (ch < '0' || ch > '9')
707 num = (u_int)va_arg(ap, int);
708 p = va_arg(ap, char *);
709 for (q = ksprintn(nbuf, num, *p++, NULL, 0); *q;)
717 if (num & (1 << (n - 1))) {
718 PCHAR(tmp ? ',' : '<');
719 for (; (n = *p) > ' '; ++p)
723 for (; *p > ' '; ++p)
730 PCHAR(va_arg(ap, int));
733 up = va_arg(ap, u_char *);
734 p = va_arg(ap, char *);
738 PCHAR(hex2ascii(*up >> 4));
739 PCHAR(hex2ascii(*up & 0x0f));
770 *(va_arg(ap, intmax_t *)) = retval;
772 *(va_arg(ap, quad_t *)) = retval;
774 *(va_arg(ap, long *)) = retval;
776 *(va_arg(ap, size_t *)) = retval;
778 *(va_arg(ap, short *)) = retval;
780 *(va_arg(ap, char *)) = retval;
782 *(va_arg(ap, int *)) = retval;
789 sharpflag = (width == 0);
791 num = (uintptr_t)va_arg(ap, void *);
802 p = va_arg(ap, char *);
808 for (n = 0; n < dwidth && p[n]; n++)
813 if (!ladjust && width > 0)
818 if (ladjust && width > 0)
843 num = va_arg(ap, uintmax_t);
845 num = va_arg(ap, u_quad_t);
847 num = va_arg(ap, ptrdiff_t);
849 num = va_arg(ap, u_long);
851 num = va_arg(ap, size_t);
853 num = (u_short)va_arg(ap, int);
855 num = (u_char)va_arg(ap, int);
857 num = va_arg(ap, u_int);
861 num = va_arg(ap, intmax_t);
863 num = va_arg(ap, quad_t);
865 num = va_arg(ap, ptrdiff_t);
867 num = va_arg(ap, long);
869 num = va_arg(ap, ssize_t);
871 num = (short)va_arg(ap, int);
873 num = (char)va_arg(ap, int);
875 num = va_arg(ap, int);
877 if (sign && (intmax_t)num < 0) {
879 num = -(intmax_t)num;
881 p = ksprintn(nbuf, num, base, &n, upper);
883 if (sharpflag && num != 0) {
892 if (!ladjust && padc == '0')
893 dwidth = width - tmp;
894 width -= tmp + imax(dwidth, n);
901 if (sharpflag && num != 0) {
904 } else if (base == 16) {
921 while (percent < fmt)
924 * Since we ignore a formatting argument it is no
925 * longer safe to obey the remaining formatting
926 * arguments as the arguments will no longer match
937 * Put character in log buffer with a particular priority.
940 msglogchar(int c, int pri)
942 static int lastpri = -1;
949 if (c == '\0' || c == '\r')
951 if (pri != -1 && pri != lastpri) {
953 msgbuf_addchar(msgbufp, '\n');
956 msgbuf_addchar(msgbufp, '<');
957 for (p = ksprintn(nbuf, (uintmax_t)pri, 10, NULL, 0); *p;)
958 msgbuf_addchar(msgbufp, *p--);
959 msgbuf_addchar(msgbufp, '>');
962 msgbuf_addchar(msgbufp, c);
972 msglogstr(char *str, int pri, int filter_cr)
977 msgbuf_addstr(msgbufp, pri, str, filter_cr);
981 msgbufinit(void *ptr, int size)
984 static struct msgbuf *oldp = NULL;
986 size -= sizeof(*msgbufp);
988 msgbufp = (struct msgbuf *)(cp + size);
989 msgbuf_reinit(msgbufp, cp, size);
990 if (msgbufmapped && oldp != msgbufp)
991 msgbuf_copy(oldp, msgbufp);
996 static int unprivileged_read_msgbuf = 1;
997 SYSCTL_INT(_security_bsd, OID_AUTO, unprivileged_read_msgbuf,
998 CTLFLAG_RW, &unprivileged_read_msgbuf, 0,
999 "Unprivileged processes may read the kernel message buffer");
1001 /* Sysctls for accessing/clearing the msgbuf */
1003 sysctl_kern_msgbuf(SYSCTL_HANDLER_ARGS)
1009 if (!unprivileged_read_msgbuf) {
1010 error = priv_check(req->td, PRIV_MSGBUF);
1015 /* Read the whole buffer, one chunk at a time. */
1016 mtx_lock(&msgbuf_lock);
1017 msgbuf_peekbytes(msgbufp, NULL, 0, &seq);
1019 len = msgbuf_peekbytes(msgbufp, buf, sizeof(buf), &seq);
1020 mtx_unlock(&msgbuf_lock);
1024 error = sysctl_handle_opaque(oidp, buf, len, req);
1028 mtx_lock(&msgbuf_lock);
1032 SYSCTL_PROC(_kern, OID_AUTO, msgbuf,
1033 CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_MPSAFE,
1034 NULL, 0, sysctl_kern_msgbuf, "A", "Contents of kernel message buffer");
1036 static int msgbuf_clearflag;
1039 sysctl_kern_msgbuf_clear(SYSCTL_HANDLER_ARGS)
1042 error = sysctl_handle_int(oidp, oidp->oid_arg1, oidp->oid_arg2, req);
1043 if (!error && req->newptr) {
1044 mtx_lock(&msgbuf_lock);
1045 msgbuf_clear(msgbufp);
1046 mtx_unlock(&msgbuf_lock);
1047 msgbuf_clearflag = 0;
1052 SYSCTL_PROC(_kern, OID_AUTO, msgbuf_clear,
1053 CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_SECURE | CTLFLAG_MPSAFE,
1054 &msgbuf_clearflag, 0, sysctl_kern_msgbuf_clear, "I",
1055 "Clear kernel message buffer");
1059 DB_SHOW_COMMAND(msgbuf, db_show_msgbuf)
1063 if (!msgbufmapped) {
1064 db_printf("msgbuf not mapped yet\n");
1067 db_printf("msgbufp = %p\n", msgbufp);
1068 db_printf("magic = %x, size = %d, r= %u, w = %u, ptr = %p, cksum= %u\n",
1069 msgbufp->msg_magic, msgbufp->msg_size, msgbufp->msg_rseq,
1070 msgbufp->msg_wseq, msgbufp->msg_ptr, msgbufp->msg_cksum);
1071 for (i = 0; i < msgbufp->msg_size && !db_pager_quit; i++) {
1072 j = MSGBUF_SEQ_TO_POS(msgbufp, i + msgbufp->msg_rseq);
1073 db_printf("%c", msgbufp->msg_ptr[j]);
1081 hexdump(const void *ptr, int length, const char *hdr, int flags)
1085 const unsigned char *cp;
1088 if ((flags & HD_DELIM_MASK) != 0)
1089 delim = (flags & HD_DELIM_MASK) >> 8;
1093 if ((flags & HD_COLUMN_MASK) != 0)
1094 cols = flags & HD_COLUMN_MASK;
1099 for (i = 0; i < length; i+= cols) {
1103 if ((flags & HD_OMIT_COUNT) == 0)
1106 if ((flags & HD_OMIT_HEX) == 0) {
1107 for (j = 0; j < cols; j++) {
1110 printf("%c%02x", delim, cp[k]);
1116 if ((flags & HD_OMIT_CHARS) == 0) {
1118 for (j = 0; j < cols; j++) {
1122 else if (cp[k] >= ' ' && cp[k] <= '~')
1123 printf("%c", cp[k]);
1132 #endif /* _KERNEL */
1135 sbuf_hexdump(struct sbuf *sb, const void *ptr, int length, const char *hdr,
1140 const unsigned char *cp;
1143 if ((flags & HD_DELIM_MASK) != 0)
1144 delim = (flags & HD_DELIM_MASK) >> 8;
1148 if ((flags & HD_COLUMN_MASK) != 0)
1149 cols = flags & HD_COLUMN_MASK;
1154 for (i = 0; i < length; i+= cols) {
1156 sbuf_printf(sb, "%s", hdr);
1158 if ((flags & HD_OMIT_COUNT) == 0)
1159 sbuf_printf(sb, "%04x ", i);
1161 if ((flags & HD_OMIT_HEX) == 0) {
1162 for (j = 0; j < cols; j++) {
1165 sbuf_printf(sb, "%c%02x", delim, cp[k]);
1167 sbuf_printf(sb, " ");
1171 if ((flags & HD_OMIT_CHARS) == 0) {
1172 sbuf_printf(sb, " |");
1173 for (j = 0; j < cols; j++) {
1176 sbuf_printf(sb, " ");
1177 else if (cp[k] >= ' ' && cp[k] <= '~')
1178 sbuf_printf(sb, "%c", cp[k]);
1180 sbuf_printf(sb, ".");
1182 sbuf_printf(sb, "|");
1184 sbuf_printf(sb, "\n");