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$");
41 #include "opt_printf.h"
43 #include <sys/param.h>
44 #include <sys/systm.h>
47 #include <sys/mutex.h>
49 #include <sys/kernel.h>
50 #include <sys/msgbuf.h>
51 #include <sys/malloc.h>
54 #include <sys/stddef.h>
55 #include <sys/sysctl.h>
57 #include <sys/syslog.h>
60 #include <sys/ctype.h>
67 * Note that stdarg.h and the ANSI style va_start macro is used for both
68 * ANSI and traditional C compilers.
70 #include <machine/stdarg.h>
76 /* Max number conversion buffer length: a u_quad_t in base 2, plus NUL byte. */
77 #define MAXNBUF (sizeof(intmax_t) * NBBY + 1)
96 static void msglogchar(int c, int pri);
97 static void msglogstr(char *str, int pri, int filter_cr);
98 static void putchar(int ch, void *arg);
99 static char *ksprintn(char *nbuf, uintmax_t num, int base, int *len, int upper);
100 static void snprintf_func(int ch, void *arg);
102 static int msgbufmapped; /* Set when safe to use msgbuf */
105 static int log_console_output = 1;
106 TUNABLE_INT("kern.log_console_output", &log_console_output);
107 SYSCTL_INT(_kern, OID_AUTO, log_console_output, CTLFLAG_RW,
108 &log_console_output, 0, "Duplicate console output to the syslog.");
111 * See the comment in log_console() below for more explanation of this.
113 static int log_console_add_linefeed = 0;
114 TUNABLE_INT("kern.log_console_add_linefeed", &log_console_add_linefeed);
115 SYSCTL_INT(_kern, OID_AUTO, log_console_add_linefeed, CTLFLAG_RW,
116 &log_console_add_linefeed, 0, "log_console() adds extra newlines.");
118 static int always_console_output = 0;
119 TUNABLE_INT("kern.always_console_output", &always_console_output);
120 SYSCTL_INT(_kern, OID_AUTO, always_console_output, CTLFLAG_RW,
121 &always_console_output, 0, "Always output to console despite TIOCCONS.");
124 * Warn that a system table is full.
127 tablefull(const char *tab)
130 log(LOG_ERR, "%s: table is full\n", tab);
134 * Uprintf prints to the controlling terminal for the current process.
137 uprintf(const char *fmt, ...)
140 struct putchar_arg pca;
146 if (TD_IS_IDLETHREAD(td))
149 sx_slock(&proctree_lock);
152 if ((p->p_flag & P_CONTROLT) == 0) {
154 sx_sunlock(&proctree_lock);
157 SESS_LOCK(p->p_session);
158 pca.tty = p->p_session->s_ttyp;
159 SESS_UNLOCK(p->p_session);
161 if (pca.tty == NULL) {
162 sx_sunlock(&proctree_lock);
169 sx_sunlock(&proctree_lock);
170 retval = kvprintf(fmt, putchar, &pca, 10, ap);
177 * tprintf and vtprintf print on the controlling terminal associated with the
178 * given session, possibly to the log as well.
181 tprintf(struct proc *p, int pri, const char *fmt, ...)
186 vtprintf(p, pri, fmt, ap);
191 vtprintf(struct proc *p, int pri, const char *fmt, va_list ap)
193 struct tty *tp = NULL;
195 struct putchar_arg pca;
196 struct session *sess = NULL;
198 sx_slock(&proctree_lock);
203 if (p->p_flag & P_CONTROLT && p->p_session->s_ttyvp) {
208 if (tp != NULL && tty_checkoutq(tp))
221 sx_sunlock(&proctree_lock);
222 kvprintf(fmt, putchar, &pca, 10, ap);
231 * Ttyprintf displays a message on a tty; it should be used only by
232 * the tty driver, or anything that knows the underlying tty will not
233 * be revoke(2)'d away. Other callers should use tprintf.
236 ttyprintf(struct tty *tp, const char *fmt, ...)
239 struct putchar_arg pca;
246 retval = kvprintf(fmt, putchar, &pca, 10, ap);
252 _vprintf(int level, int flags, const char *fmt, va_list ap)
254 struct putchar_arg pca;
256 #ifdef PRINTF_BUFR_SIZE
257 char bufr[PRINTF_BUFR_SIZE];
263 #ifdef PRINTF_BUFR_SIZE
265 pca.p_next = pca.p_bufr;
266 pca.n_bufr = sizeof(bufr);
267 pca.remain = sizeof(bufr);
270 /* Don't buffer console output. */
274 retval = kvprintf(fmt, putchar, &pca, 10, ap);
276 #ifdef PRINTF_BUFR_SIZE
277 /* Write any buffered console/log output: */
278 if (*pca.p_bufr != '\0') {
279 if (pca.flags & TOLOG)
280 msglogstr(pca.p_bufr, level, /*filter_cr*/1);
282 if (pca.flags & TOCONS)
291 * Log writes to the log buffer, and guarantees not to sleep (so can be
292 * called by interrupt routines). If there is no process reading the
293 * log yet, it writes to the console also.
296 log(int level, const char *fmt, ...)
301 (void)_vprintf(level, log_open ? TOLOG : TOCONS, fmt, ap);
307 #define CONSCHUNK 128
310 log_console(struct uio *uio)
316 if (!log_console_output)
319 pri = LOG_INFO | LOG_CONSOLE;
321 consbuffer = malloc(CONSCHUNK, M_TEMP, M_WAITOK);
324 while (uio->uio_resid > 0) {
325 c = imin(uio->uio_resid, CONSCHUNK - 1);
326 error = uiomove(consbuffer, c, uio);
329 /* Make sure we're NUL-terminated */
330 consbuffer[c] = '\0';
331 if (consbuffer[c - 1] == '\n')
335 msglogstr(consbuffer, pri, /*filter_cr*/ 1);
338 * The previous behavior in log_console() is preserved when
339 * log_console_add_linefeed is non-zero. For that behavior, if an
340 * individual console write came in that was not terminated with a
341 * line feed, it would add a line feed.
343 * This results in different data in the message buffer than
344 * appears on the system console (which doesn't add extra line feed
347 * A number of programs and rc scripts write a line feed, or a period
348 * and a line feed when they have completed their operation. On
349 * the console, this looks seamless, but when displayed with
350 * 'dmesg -a', you wind up with output that looks like this:
355 * On the console, it looks like this:
358 * We could add logic to detect that situation, or just not insert
359 * the extra newlines. Set the kern.log_console_add_linefeed
360 * sysctl/tunable variable to get the old behavior.
362 if (!nl && log_console_add_linefeed) {
363 consbuffer[0] = '\n';
364 consbuffer[1] = '\0';
365 msglogstr(consbuffer, pri, /*filter_cr*/ 1);
369 free(consbuffer, M_TEMP);
374 printf(const char *fmt, ...)
380 retval = vprintf(fmt, ap);
387 vprintf(const char *fmt, va_list ap)
391 retval = _vprintf(-1, TOCONS | TOLOG, fmt, ap);
400 putbuf(int c, struct putchar_arg *ap)
402 /* Check if no console output buffer was provided. */
403 if (ap->p_bufr == NULL) {
404 /* Output direct to the console. */
405 if (ap->flags & TOCONS)
408 if (ap->flags & TOLOG)
409 msglogchar(c, ap->pri);
411 /* Buffer the character: */
415 /* Always leave the buffer zero terminated. */
418 /* Check if the buffer needs to be flushed. */
419 if (ap->remain == 2 || c == '\n') {
421 if (ap->flags & TOLOG)
422 msglogstr(ap->p_bufr, ap->pri, /*filter_cr*/1);
424 if (ap->flags & TOCONS) {
425 if ((panicstr == NULL) && (constty != NULL))
426 msgbuf_addstr(&consmsgbuf, -1,
427 ap->p_bufr, /*filter_cr*/ 0);
429 if ((constty == NULL) ||(always_console_output))
433 ap->p_next = ap->p_bufr;
434 ap->remain = ap->n_bufr;
439 * Since we fill the buffer up one character at a time,
440 * this should not happen. We should always catch it when
441 * ap->remain == 2 (if not sooner due to a newline), flush
442 * the buffer and move on. One way this could happen is
443 * if someone sets PRINTF_BUFR_SIZE to 1 or something
446 KASSERT(ap->remain > 2, ("Bad buffer logic, remain = %zd",
452 * Print a character on console or users terminal. If destination is
453 * the console then the last bunch of characters are saved in msgbuf for
457 putchar(int c, void *arg)
459 struct putchar_arg *ap = (struct putchar_arg*) arg;
460 struct tty *tp = ap->tty;
461 int flags = ap->flags;
463 /* Don't use the tty code after a panic or while in ddb. */
470 if ((flags & TOTTY) && tp != NULL && panicstr == NULL)
473 if ((flags & (TOCONS | TOLOG)) && c != '\0')
478 * Scaled down version of sprintf(3).
481 sprintf(char *buf, const char *cfmt, ...)
487 retval = kvprintf(cfmt, NULL, (void *)buf, 10, ap);
494 * Scaled down version of vsprintf(3).
497 vsprintf(char *buf, const char *cfmt, va_list ap)
501 retval = kvprintf(cfmt, NULL, (void *)buf, 10, ap);
507 * Scaled down version of snprintf(3).
510 snprintf(char *str, size_t size, const char *format, ...)
515 va_start(ap, format);
516 retval = vsnprintf(str, size, format, ap);
522 * Scaled down version of vsnprintf(3).
525 vsnprintf(char *str, size_t size, const char *format, va_list ap)
527 struct snprintf_arg info;
532 retval = kvprintf(format, snprintf_func, &info, 10, ap);
533 if (info.remain >= 1)
539 * Kernel version which takes radix argument vsnprintf(3).
542 vsnrprintf(char *str, size_t size, int radix, const char *format, va_list ap)
544 struct snprintf_arg info;
549 retval = kvprintf(format, snprintf_func, &info, radix, ap);
550 if (info.remain >= 1)
556 snprintf_func(int ch, void *arg)
558 struct snprintf_arg *const info = arg;
560 if (info->remain >= 2) {
567 * Put a NUL-terminated ASCII number (base <= 36) in a buffer in reverse
568 * order; return an optional length and a pointer to the last character
569 * written in the buffer (i.e., the first character of the string).
570 * The buffer pointed to by `nbuf' must have length >= MAXNBUF.
573 ksprintn(char *nbuf, uintmax_t num, int base, int *lenp, int upper)
580 c = hex2ascii(num % base);
581 *++p = upper ? toupper(c) : c;
582 } while (num /= base);
589 * Scaled down version of printf(3).
591 * Two additional formats:
593 * The format %b is supported to decode error registers.
596 * printf("reg=%b\n", regval, "<base><arg>*");
598 * where <base> is the output base expressed as a control character, e.g.
599 * \10 gives octal; \20 gives hex. Each arg is a sequence of characters,
600 * the first of which gives the bit number to be inspected (origin 1), and
601 * the next characters (up to a control character, i.e. a character <= 32),
602 * give the name of the register. Thus:
604 * kvprintf("reg=%b\n", 3, "\10\2BITTWO\1BITONE\n");
606 * would produce output:
608 * reg=3<BITTWO,BITONE>
610 * XXX: %D -- Hexdump, takes pointer and separator string:
611 * ("%6D", ptr, ":") -> XX:XX:XX:XX:XX:XX
612 * ("%*D", len, ptr, " " -> XX XX XX XX ...
615 kvprintf(char const *fmt, void (*func)(int, void*), void *arg, int radix, va_list ap)
617 #define PCHAR(c) {int cc=(c); if (func) (*func)(cc,arg); else *d++ = cc; retval++; }
620 const char *p, *percent, *q;
624 int base, lflag, qflag, tmp, width, ladjust, sharpflag, neg, sign, dot;
625 int cflag, hflag, jflag, tflag, zflag;
628 int stop = 0, retval = 0;
637 fmt = "(fmt null)\n";
639 if (radix < 2 || radix > 36)
645 while ((ch = (u_char)*fmt++) != '%' || stop) {
651 qflag = 0; lflag = 0; ladjust = 0; sharpflag = 0; neg = 0;
652 sign = 0; dot = 0; dwidth = 0; upper = 0;
653 cflag = 0; hflag = 0; jflag = 0; tflag = 0; zflag = 0;
654 reswitch: switch (ch = (u_char)*fmt++) {
672 width = va_arg(ap, int);
678 dwidth = va_arg(ap, int);
686 case '1': case '2': case '3': case '4':
687 case '5': case '6': case '7': case '8': case '9':
688 for (n = 0;; ++fmt) {
689 n = n * 10 + ch - '0';
691 if (ch < '0' || ch > '9')
700 num = (u_int)va_arg(ap, int);
701 p = va_arg(ap, char *);
702 for (q = ksprintn(nbuf, num, *p++, NULL, 0); *q;)
710 if (num & (1 << (n - 1))) {
711 PCHAR(tmp ? ',' : '<');
712 for (; (n = *p) > ' '; ++p)
716 for (; *p > ' '; ++p)
723 PCHAR(va_arg(ap, int));
726 up = va_arg(ap, u_char *);
727 p = va_arg(ap, char *);
731 PCHAR(hex2ascii(*up >> 4));
732 PCHAR(hex2ascii(*up & 0x0f));
763 *(va_arg(ap, intmax_t *)) = retval;
765 *(va_arg(ap, quad_t *)) = retval;
767 *(va_arg(ap, long *)) = retval;
769 *(va_arg(ap, size_t *)) = retval;
771 *(va_arg(ap, short *)) = retval;
773 *(va_arg(ap, char *)) = retval;
775 *(va_arg(ap, int *)) = retval;
782 sharpflag = (width == 0);
784 num = (uintptr_t)va_arg(ap, void *);
795 p = va_arg(ap, char *);
801 for (n = 0; n < dwidth && p[n]; n++)
806 if (!ladjust && width > 0)
811 if (ladjust && width > 0)
836 num = va_arg(ap, uintmax_t);
838 num = va_arg(ap, u_quad_t);
840 num = va_arg(ap, ptrdiff_t);
842 num = va_arg(ap, u_long);
844 num = va_arg(ap, size_t);
846 num = (u_short)va_arg(ap, int);
848 num = (u_char)va_arg(ap, int);
850 num = va_arg(ap, u_int);
854 num = va_arg(ap, intmax_t);
856 num = va_arg(ap, quad_t);
858 num = va_arg(ap, ptrdiff_t);
860 num = va_arg(ap, long);
862 num = va_arg(ap, ssize_t);
864 num = (short)va_arg(ap, int);
866 num = (char)va_arg(ap, int);
868 num = va_arg(ap, int);
870 if (sign && (intmax_t)num < 0) {
872 num = -(intmax_t)num;
874 p = ksprintn(nbuf, num, base, &n, upper);
876 if (sharpflag && num != 0) {
885 if (!ladjust && padc == '0')
886 dwidth = width - tmp;
887 width -= tmp + imax(dwidth, n);
894 if (sharpflag && num != 0) {
897 } else if (base == 16) {
914 while (percent < fmt)
917 * Since we ignore a formatting argument it is no
918 * longer safe to obey the remaining formatting
919 * arguments as the arguments will no longer match
930 * Put character in log buffer with a particular priority.
933 msglogchar(int c, int pri)
935 static int lastpri = -1;
942 if (c == '\0' || c == '\r')
944 if (pri != -1 && pri != lastpri) {
946 msgbuf_addchar(msgbufp, '\n');
949 msgbuf_addchar(msgbufp, '<');
950 for (p = ksprintn(nbuf, (uintmax_t)pri, 10, NULL, 0); *p;)
951 msgbuf_addchar(msgbufp, *p--);
952 msgbuf_addchar(msgbufp, '>');
955 msgbuf_addchar(msgbufp, c);
965 msglogstr(char *str, int pri, int filter_cr)
970 msgbuf_addstr(msgbufp, pri, str, filter_cr);
974 msgbufinit(void *ptr, int size)
977 static struct msgbuf *oldp = NULL;
979 size -= sizeof(*msgbufp);
981 msgbufp = (struct msgbuf *)(cp + size);
982 msgbuf_reinit(msgbufp, cp, size);
983 if (msgbufmapped && oldp != msgbufp)
984 msgbuf_copy(oldp, msgbufp);
989 static int unprivileged_read_msgbuf = 1;
990 SYSCTL_INT(_security_bsd, OID_AUTO, unprivileged_read_msgbuf,
991 CTLFLAG_RW, &unprivileged_read_msgbuf, 0,
992 "Unprivileged processes may read the kernel message buffer");
994 /* Sysctls for accessing/clearing the msgbuf */
996 sysctl_kern_msgbuf(SYSCTL_HANDLER_ARGS)
1002 if (!unprivileged_read_msgbuf) {
1003 error = priv_check(req->td, PRIV_MSGBUF);
1008 /* Read the whole buffer, one chunk at a time. */
1009 mtx_lock(&msgbuf_lock);
1010 msgbuf_peekbytes(msgbufp, NULL, 0, &seq);
1012 len = msgbuf_peekbytes(msgbufp, buf, sizeof(buf), &seq);
1013 mtx_unlock(&msgbuf_lock);
1017 error = sysctl_handle_opaque(oidp, buf, len, req);
1021 mtx_lock(&msgbuf_lock);
1025 SYSCTL_PROC(_kern, OID_AUTO, msgbuf,
1026 CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_MPSAFE,
1027 NULL, 0, sysctl_kern_msgbuf, "A", "Contents of kernel message buffer");
1029 static int msgbuf_clearflag;
1032 sysctl_kern_msgbuf_clear(SYSCTL_HANDLER_ARGS)
1035 error = sysctl_handle_int(oidp, oidp->oid_arg1, oidp->oid_arg2, req);
1036 if (!error && req->newptr) {
1037 mtx_lock(&msgbuf_lock);
1038 msgbuf_clear(msgbufp);
1039 mtx_unlock(&msgbuf_lock);
1040 msgbuf_clearflag = 0;
1045 SYSCTL_PROC(_kern, OID_AUTO, msgbuf_clear,
1046 CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_SECURE | CTLFLAG_MPSAFE,
1047 &msgbuf_clearflag, 0, sysctl_kern_msgbuf_clear, "I",
1048 "Clear kernel message buffer");
1052 DB_SHOW_COMMAND(msgbuf, db_show_msgbuf)
1056 if (!msgbufmapped) {
1057 db_printf("msgbuf not mapped yet\n");
1060 db_printf("msgbufp = %p\n", msgbufp);
1061 db_printf("magic = %x, size = %d, r= %u, w = %u, ptr = %p, cksum= %u\n",
1062 msgbufp->msg_magic, msgbufp->msg_size, msgbufp->msg_rseq,
1063 msgbufp->msg_wseq, msgbufp->msg_ptr, msgbufp->msg_cksum);
1064 for (i = 0; i < msgbufp->msg_size && !db_pager_quit; i++) {
1065 j = MSGBUF_SEQ_TO_POS(msgbufp, i + msgbufp->msg_rseq);
1066 db_printf("%c", msgbufp->msg_ptr[j]);
1074 hexdump(const void *ptr, int length, const char *hdr, int flags)
1078 const unsigned char *cp;
1081 if ((flags & HD_DELIM_MASK) != 0)
1082 delim = (flags & HD_DELIM_MASK) >> 8;
1086 if ((flags & HD_COLUMN_MASK) != 0)
1087 cols = flags & HD_COLUMN_MASK;
1092 for (i = 0; i < length; i+= cols) {
1096 if ((flags & HD_OMIT_COUNT) == 0)
1099 if ((flags & HD_OMIT_HEX) == 0) {
1100 for (j = 0; j < cols; j++) {
1103 printf("%c%02x", delim, cp[k]);
1109 if ((flags & HD_OMIT_CHARS) == 0) {
1111 for (j = 0; j < cols; j++) {
1115 else if (cp[k] >= ' ' && cp[k] <= '~')
1116 printf("%c", cp[k]);