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.
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 TUNABLE_INT("kern.log_console_output", &log_console_output);
126 SYSCTL_INT(_kern, OID_AUTO, log_console_output, CTLFLAG_RW,
127 &log_console_output, 0, "Duplicate console output to the syslog.");
130 * See the comment in log_console() below for more explanation of this.
132 static int log_console_add_linefeed = 0;
133 TUNABLE_INT("kern.log_console_add_linefeed", &log_console_add_linefeed);
134 SYSCTL_INT(_kern, OID_AUTO, log_console_add_linefeed, CTLFLAG_RW,
135 &log_console_add_linefeed, 0, "log_console() adds extra newlines.");
137 static int always_console_output = 0;
138 TUNABLE_INT("kern.always_console_output", &always_console_output);
139 SYSCTL_INT(_kern, OID_AUTO, always_console_output, CTLFLAG_RW,
140 &always_console_output, 0, "Always output to console despite TIOCCONS.");
143 * Warn that a system table is full.
146 tablefull(const char *tab)
149 log(LOG_ERR, "%s: table is full\n", tab);
153 * Uprintf prints to the controlling terminal for the current process.
156 uprintf(const char *fmt, ...)
159 struct putchar_arg pca;
165 if (TD_IS_IDLETHREAD(td))
168 sx_slock(&proctree_lock);
171 if ((p->p_flag & P_CONTROLT) == 0) {
173 sx_sunlock(&proctree_lock);
176 SESS_LOCK(p->p_session);
177 pca.tty = p->p_session->s_ttyp;
178 SESS_UNLOCK(p->p_session);
180 if (pca.tty == NULL) {
181 sx_sunlock(&proctree_lock);
188 sx_sunlock(&proctree_lock);
189 retval = kvprintf(fmt, putchar, &pca, 10, ap);
196 * tprintf and vtprintf print on the controlling terminal associated with the
197 * given session, possibly to the log as well.
200 tprintf(struct proc *p, int pri, const char *fmt, ...)
205 vtprintf(p, pri, fmt, ap);
210 vtprintf(struct proc *p, int pri, const char *fmt, va_list ap)
212 struct tty *tp = NULL;
214 struct putchar_arg pca;
215 struct session *sess = NULL;
217 sx_slock(&proctree_lock);
222 if (p->p_flag & P_CONTROLT && p->p_session->s_ttyvp) {
227 if (tp != NULL && tty_checkoutq(tp))
240 sx_sunlock(&proctree_lock);
241 kvprintf(fmt, putchar, &pca, 10, ap);
250 * Ttyprintf displays a message on a tty; it should be used only by
251 * the tty driver, or anything that knows the underlying tty will not
252 * be revoke(2)'d away. Other callers should use tprintf.
255 ttyprintf(struct tty *tp, const char *fmt, ...)
258 struct putchar_arg pca;
265 retval = kvprintf(fmt, putchar, &pca, 10, ap);
271 _vprintf(int level, int flags, const char *fmt, va_list ap)
273 struct putchar_arg pca;
275 #ifdef PRINTF_BUFR_SIZE
276 char bufr[PRINTF_BUFR_SIZE];
282 #ifdef PRINTF_BUFR_SIZE
284 pca.p_next = pca.p_bufr;
285 pca.n_bufr = sizeof(bufr);
286 pca.remain = sizeof(bufr);
289 /* Don't buffer console output. */
293 retval = kvprintf(fmt, putchar, &pca, 10, ap);
295 #ifdef PRINTF_BUFR_SIZE
296 /* Write any buffered console/log output: */
297 if (*pca.p_bufr != '\0') {
298 if (pca.flags & TOLOG)
299 msglogstr(pca.p_bufr, level, /*filter_cr*/1);
301 if (pca.flags & TOCONS)
310 * Log writes to the log buffer, and guarantees not to sleep (so can be
311 * called by interrupt routines). If there is no process reading the
312 * log yet, it writes to the console also.
315 log(int level, const char *fmt, ...)
320 (void)_vprintf(level, log_open ? TOLOG : TOCONS | TOLOG, fmt, ap);
326 #define CONSCHUNK 128
329 log_console(struct uio *uio)
335 if (!log_console_output)
338 pri = LOG_INFO | LOG_CONSOLE;
340 consbuffer = malloc(CONSCHUNK, M_TEMP, M_WAITOK);
343 while (uio->uio_resid > 0) {
344 c = imin(uio->uio_resid, CONSCHUNK - 1);
345 error = uiomove(consbuffer, c, uio);
348 /* Make sure we're NUL-terminated */
349 consbuffer[c] = '\0';
350 if (consbuffer[c - 1] == '\n')
354 msglogstr(consbuffer, pri, /*filter_cr*/ 1);
357 * The previous behavior in log_console() is preserved when
358 * log_console_add_linefeed is non-zero. For that behavior, if an
359 * individual console write came in that was not terminated with a
360 * line feed, it would add a line feed.
362 * This results in different data in the message buffer than
363 * appears on the system console (which doesn't add extra line feed
366 * A number of programs and rc scripts write a line feed, or a period
367 * and a line feed when they have completed their operation. On
368 * the console, this looks seamless, but when displayed with
369 * 'dmesg -a', you wind up with output that looks like this:
374 * On the console, it looks like this:
377 * We could add logic to detect that situation, or just not insert
378 * the extra newlines. Set the kern.log_console_add_linefeed
379 * sysctl/tunable variable to get the old behavior.
381 if (!nl && log_console_add_linefeed) {
382 consbuffer[0] = '\n';
383 consbuffer[1] = '\0';
384 msglogstr(consbuffer, pri, /*filter_cr*/ 1);
388 free(consbuffer, M_TEMP);
392 printf(const char *fmt, ...)
398 retval = vprintf(fmt, ap);
405 vprintf(const char *fmt, va_list ap)
409 retval = _vprintf(-1, TOCONS | TOLOG, fmt, ap);
418 prf_putbuf(char *bufr, int flags, int pri)
422 msglogstr(bufr, pri, /*filter_cr*/1);
424 if (flags & TOCONS) {
425 if ((panicstr == NULL) && (constty != NULL))
426 msgbuf_addstr(&consmsgbuf, -1,
427 bufr, /*filter_cr*/ 0);
429 if ((constty == NULL) ||(always_console_output))
435 putbuf(int c, struct putchar_arg *ap)
437 /* Check if no console output buffer was provided. */
438 if (ap->p_bufr == NULL) {
439 /* Output direct to the console. */
440 if (ap->flags & TOCONS)
443 if (ap->flags & TOLOG)
444 msglogchar(c, ap->pri);
446 /* Buffer the character: */
450 /* Always leave the buffer zero terminated. */
453 /* Check if the buffer needs to be flushed. */
454 if (ap->remain == 2 || c == '\n') {
455 prf_putbuf(ap->p_bufr, ap->flags, ap->pri);
457 ap->p_next = ap->p_bufr;
458 ap->remain = ap->n_bufr;
463 * Since we fill the buffer up one character at a time,
464 * this should not happen. We should always catch it when
465 * ap->remain == 2 (if not sooner due to a newline), flush
466 * the buffer and move on. One way this could happen is
467 * if someone sets PRINTF_BUFR_SIZE to 1 or something
470 KASSERT(ap->remain > 2, ("Bad buffer logic, remain = %zd",
476 * Print a character on console or users terminal. If destination is
477 * the console then the last bunch of characters are saved in msgbuf for
481 putchar(int c, void *arg)
483 struct putchar_arg *ap = (struct putchar_arg*) arg;
484 struct tty *tp = ap->tty;
485 int flags = ap->flags;
487 /* Don't use the tty code after a panic or while in ddb. */
494 if ((flags & TOTTY) && tp != NULL && panicstr == NULL)
497 if ((flags & (TOCONS | TOLOG)) && c != '\0')
502 * Scaled down version of sprintf(3).
505 sprintf(char *buf, const char *cfmt, ...)
511 retval = kvprintf(cfmt, NULL, (void *)buf, 10, ap);
518 * Scaled down version of vsprintf(3).
521 vsprintf(char *buf, const char *cfmt, va_list ap)
525 retval = kvprintf(cfmt, NULL, (void *)buf, 10, ap);
531 * Scaled down version of snprintf(3).
534 snprintf(char *str, size_t size, const char *format, ...)
539 va_start(ap, format);
540 retval = vsnprintf(str, size, format, ap);
546 * Scaled down version of vsnprintf(3).
549 vsnprintf(char *str, size_t size, const char *format, va_list ap)
551 struct snprintf_arg info;
556 retval = kvprintf(format, snprintf_func, &info, 10, ap);
557 if (info.remain >= 1)
563 * Kernel version which takes radix argument vsnprintf(3).
566 vsnrprintf(char *str, size_t size, int radix, const char *format, va_list ap)
568 struct snprintf_arg info;
573 retval = kvprintf(format, snprintf_func, &info, radix, ap);
574 if (info.remain >= 1)
580 snprintf_func(int ch, void *arg)
582 struct snprintf_arg *const info = arg;
584 if (info->remain >= 2) {
591 * Put a NUL-terminated ASCII number (base <= 36) in a buffer in reverse
592 * order; return an optional length and a pointer to the last character
593 * written in the buffer (i.e., the first character of the string).
594 * The buffer pointed to by `nbuf' must have length >= MAXNBUF.
597 ksprintn(char *nbuf, uintmax_t num, int base, int *lenp, int upper)
604 c = hex2ascii(num % base);
605 *++p = upper ? toupper(c) : c;
606 } while (num /= base);
613 * Scaled down version of printf(3).
615 * Two additional formats:
617 * The format %b is supported to decode error registers.
620 * printf("reg=%b\n", regval, "<base><arg>*");
622 * where <base> is the output base expressed as a control character, e.g.
623 * \10 gives octal; \20 gives hex. Each arg is a sequence of characters,
624 * the first of which gives the bit number to be inspected (origin 1), and
625 * the next characters (up to a control character, i.e. a character <= 32),
626 * give the name of the register. Thus:
628 * kvprintf("reg=%b\n", 3, "\10\2BITTWO\1BITONE\n");
630 * would produce output:
632 * reg=3<BITTWO,BITONE>
634 * XXX: %D -- Hexdump, takes pointer and separator string:
635 * ("%6D", ptr, ":") -> XX:XX:XX:XX:XX:XX
636 * ("%*D", len, ptr, " " -> XX XX XX XX ...
639 kvprintf(char const *fmt, void (*func)(int, void*), void *arg, int radix, va_list ap)
641 #define PCHAR(c) {int cc=(c); if (func) (*func)(cc,arg); else *d++ = cc; retval++; }
644 const char *p, *percent, *q;
648 int base, lflag, qflag, tmp, width, ladjust, sharpflag, neg, sign, dot;
649 int cflag, hflag, jflag, tflag, zflag;
652 int stop = 0, retval = 0;
661 fmt = "(fmt null)\n";
663 if (radix < 2 || radix > 36)
669 while ((ch = (u_char)*fmt++) != '%' || stop) {
675 qflag = 0; lflag = 0; ladjust = 0; sharpflag = 0; neg = 0;
676 sign = 0; dot = 0; dwidth = 0; upper = 0;
677 cflag = 0; hflag = 0; jflag = 0; tflag = 0; zflag = 0;
678 reswitch: switch (ch = (u_char)*fmt++) {
696 width = va_arg(ap, int);
702 dwidth = va_arg(ap, int);
710 case '1': case '2': case '3': case '4':
711 case '5': case '6': case '7': case '8': case '9':
712 for (n = 0;; ++fmt) {
713 n = n * 10 + ch - '0';
715 if (ch < '0' || ch > '9')
724 num = (u_int)va_arg(ap, int);
725 p = va_arg(ap, char *);
726 for (q = ksprintn(nbuf, num, *p++, NULL, 0); *q;)
734 if (num & (1 << (n - 1))) {
735 PCHAR(tmp ? ',' : '<');
736 for (; (n = *p) > ' '; ++p)
740 for (; *p > ' '; ++p)
747 PCHAR(va_arg(ap, int));
750 up = va_arg(ap, u_char *);
751 p = va_arg(ap, char *);
755 PCHAR(hex2ascii(*up >> 4));
756 PCHAR(hex2ascii(*up & 0x0f));
787 *(va_arg(ap, intmax_t *)) = retval;
789 *(va_arg(ap, quad_t *)) = retval;
791 *(va_arg(ap, long *)) = retval;
793 *(va_arg(ap, size_t *)) = retval;
795 *(va_arg(ap, short *)) = retval;
797 *(va_arg(ap, char *)) = retval;
799 *(va_arg(ap, int *)) = retval;
806 sharpflag = (width == 0);
808 num = (uintptr_t)va_arg(ap, void *);
819 p = va_arg(ap, char *);
825 for (n = 0; n < dwidth && p[n]; n++)
830 if (!ladjust && width > 0)
835 if (ladjust && width > 0)
860 num = va_arg(ap, uintmax_t);
862 num = va_arg(ap, u_quad_t);
864 num = va_arg(ap, ptrdiff_t);
866 num = va_arg(ap, u_long);
868 num = va_arg(ap, size_t);
870 num = (u_short)va_arg(ap, int);
872 num = (u_char)va_arg(ap, int);
874 num = va_arg(ap, u_int);
878 num = va_arg(ap, intmax_t);
880 num = va_arg(ap, quad_t);
882 num = va_arg(ap, ptrdiff_t);
884 num = va_arg(ap, long);
886 num = va_arg(ap, ssize_t);
888 num = (short)va_arg(ap, int);
890 num = (char)va_arg(ap, int);
892 num = va_arg(ap, int);
894 if (sign && (intmax_t)num < 0) {
896 num = -(intmax_t)num;
898 p = ksprintn(nbuf, num, base, &n, upper);
900 if (sharpflag && num != 0) {
909 if (!ladjust && padc == '0')
910 dwidth = width - tmp;
911 width -= tmp + imax(dwidth, n);
918 if (sharpflag && num != 0) {
921 } else if (base == 16) {
938 while (percent < fmt)
941 * Since we ignore a formatting argument it is no
942 * longer safe to obey the remaining formatting
943 * arguments as the arguments will no longer match
954 * Put character in log buffer with a particular priority.
957 msglogchar(int c, int pri)
959 static int lastpri = -1;
966 if (c == '\0' || c == '\r')
968 if (pri != -1 && pri != lastpri) {
970 msgbuf_addchar(msgbufp, '\n');
973 msgbuf_addchar(msgbufp, '<');
974 for (p = ksprintn(nbuf, (uintmax_t)pri, 10, NULL, 0); *p;)
975 msgbuf_addchar(msgbufp, *p--);
976 msgbuf_addchar(msgbufp, '>');
979 msgbuf_addchar(msgbufp, c);
989 msglogstr(char *str, int pri, int filter_cr)
994 msgbuf_addstr(msgbufp, pri, str, filter_cr);
998 msgbufinit(void *ptr, int size)
1001 static struct msgbuf *oldp = NULL;
1003 size -= sizeof(*msgbufp);
1005 msgbufp = (struct msgbuf *)(cp + size);
1006 msgbuf_reinit(msgbufp, cp, size);
1007 if (msgbufmapped && oldp != msgbufp)
1008 msgbuf_copy(oldp, msgbufp);
1013 static int unprivileged_read_msgbuf = 1;
1014 SYSCTL_INT(_security_bsd, OID_AUTO, unprivileged_read_msgbuf,
1015 CTLFLAG_RW, &unprivileged_read_msgbuf, 0,
1016 "Unprivileged processes may read the kernel message buffer");
1018 /* Sysctls for accessing/clearing the msgbuf */
1020 sysctl_kern_msgbuf(SYSCTL_HANDLER_ARGS)
1026 if (!unprivileged_read_msgbuf) {
1027 error = priv_check(req->td, PRIV_MSGBUF);
1032 /* Read the whole buffer, one chunk at a time. */
1033 mtx_lock(&msgbuf_lock);
1034 msgbuf_peekbytes(msgbufp, NULL, 0, &seq);
1036 len = msgbuf_peekbytes(msgbufp, buf, sizeof(buf), &seq);
1037 mtx_unlock(&msgbuf_lock);
1041 error = sysctl_handle_opaque(oidp, buf, len, req);
1045 mtx_lock(&msgbuf_lock);
1049 SYSCTL_PROC(_kern, OID_AUTO, msgbuf,
1050 CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_MPSAFE,
1051 NULL, 0, sysctl_kern_msgbuf, "A", "Contents of kernel message buffer");
1053 static int msgbuf_clearflag;
1056 sysctl_kern_msgbuf_clear(SYSCTL_HANDLER_ARGS)
1059 error = sysctl_handle_int(oidp, oidp->oid_arg1, oidp->oid_arg2, req);
1060 if (!error && req->newptr) {
1061 mtx_lock(&msgbuf_lock);
1062 msgbuf_clear(msgbufp);
1063 mtx_unlock(&msgbuf_lock);
1064 msgbuf_clearflag = 0;
1069 SYSCTL_PROC(_kern, OID_AUTO, msgbuf_clear,
1070 CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_SECURE | CTLFLAG_MPSAFE,
1071 &msgbuf_clearflag, 0, sysctl_kern_msgbuf_clear, "I",
1072 "Clear kernel message buffer");
1076 DB_SHOW_COMMAND(msgbuf, db_show_msgbuf)
1080 if (!msgbufmapped) {
1081 db_printf("msgbuf not mapped yet\n");
1084 db_printf("msgbufp = %p\n", msgbufp);
1085 db_printf("magic = %x, size = %d, r= %u, w = %u, ptr = %p, cksum= %u\n",
1086 msgbufp->msg_magic, msgbufp->msg_size, msgbufp->msg_rseq,
1087 msgbufp->msg_wseq, msgbufp->msg_ptr, msgbufp->msg_cksum);
1088 for (i = 0; i < msgbufp->msg_size && !db_pager_quit; i++) {
1089 j = MSGBUF_SEQ_TO_POS(msgbufp, i + msgbufp->msg_rseq);
1090 db_printf("%c", msgbufp->msg_ptr[j]);
1098 hexdump(const void *ptr, int length, const char *hdr, int flags)
1102 const unsigned char *cp;
1105 if ((flags & HD_DELIM_MASK) != 0)
1106 delim = (flags & HD_DELIM_MASK) >> 8;
1110 if ((flags & HD_COLUMN_MASK) != 0)
1111 cols = flags & HD_COLUMN_MASK;
1116 for (i = 0; i < length; i+= cols) {
1120 if ((flags & HD_OMIT_COUNT) == 0)
1123 if ((flags & HD_OMIT_HEX) == 0) {
1124 for (j = 0; j < cols; j++) {
1127 printf("%c%02x", delim, cp[k]);
1133 if ((flags & HD_OMIT_CHARS) == 0) {
1135 for (j = 0; j < cols; j++) {
1139 else if (cp[k] >= ' ' && cp[k] <= '~')
1140 printf("%c", cp[k]);
1149 #endif /* _KERNEL */
1152 sbuf_hexdump(struct sbuf *sb, const void *ptr, int length, const char *hdr,
1157 const unsigned char *cp;
1160 if ((flags & HD_DELIM_MASK) != 0)
1161 delim = (flags & HD_DELIM_MASK) >> 8;
1165 if ((flags & HD_COLUMN_MASK) != 0)
1166 cols = flags & HD_COLUMN_MASK;
1171 for (i = 0; i < length; i+= cols) {
1173 sbuf_printf(sb, "%s", hdr);
1175 if ((flags & HD_OMIT_COUNT) == 0)
1176 sbuf_printf(sb, "%04x ", i);
1178 if ((flags & HD_OMIT_HEX) == 0) {
1179 for (j = 0; j < cols; j++) {
1182 sbuf_printf(sb, "%c%02x", delim, cp[k]);
1184 sbuf_printf(sb, " ");
1188 if ((flags & HD_OMIT_CHARS) == 0) {
1189 sbuf_printf(sb, " |");
1190 for (j = 0; j < cols; j++) {
1193 sbuf_printf(sb, " ");
1194 else if (cp[k] >= ' ' && cp[k] <= '~')
1195 sbuf_printf(sb, "%c", cp[k]);
1197 sbuf_printf(sb, ".");
1199 sbuf_printf(sb, "|");
1201 sbuf_printf(sb, "\n");
1207 counted_warning(unsigned *counter, const char *msg)
1216 if (atomic_cmpset_int(counter, c, c - 1)) {
1218 log(LOG_INFO, "pid %d (%s) %s%s\n",
1219 td->td_proc->p_pid, td->td_name, msg,
1220 c > 1 ? "" : " - not logging anymore");
1229 sbuf_putbuf(struct sbuf *sb)
1232 prf_putbuf(sbuf_data(sb), TOLOG | TOCONS, -1);
1236 sbuf_putbuf(struct sbuf *sb)
1239 printf("%s", sbuf_data(sb));