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 SYSCTL_INT(_kern, OID_AUTO, log_console_output, CTLFLAG_RWTUN,
107 &log_console_output, 0, "Duplicate console output to the syslog");
110 * See the comment in log_console() below for more explanation of this.
112 static int log_console_add_linefeed;
113 SYSCTL_INT(_kern, OID_AUTO, log_console_add_linefeed, CTLFLAG_RWTUN,
114 &log_console_add_linefeed, 0, "log_console() adds extra newlines");
116 static int always_console_output;
117 SYSCTL_INT(_kern, OID_AUTO, always_console_output, CTLFLAG_RWTUN,
118 &always_console_output, 0, "Always output to console despite TIOCCONS");
121 * Warn that a system table is full.
124 tablefull(const char *tab)
127 log(LOG_ERR, "%s: table is full\n", tab);
131 * Uprintf prints to the controlling terminal for the current process.
134 uprintf(const char *fmt, ...)
137 struct putchar_arg pca;
143 if (TD_IS_IDLETHREAD(td))
146 sx_slock(&proctree_lock);
149 if ((p->p_flag & P_CONTROLT) == 0) {
151 sx_sunlock(&proctree_lock);
154 SESS_LOCK(p->p_session);
155 pca.tty = p->p_session->s_ttyp;
156 SESS_UNLOCK(p->p_session);
158 if (pca.tty == NULL) {
159 sx_sunlock(&proctree_lock);
166 sx_sunlock(&proctree_lock);
167 retval = kvprintf(fmt, putchar, &pca, 10, ap);
174 * tprintf and vtprintf print on the controlling terminal associated with the
175 * given session, possibly to the log as well.
178 tprintf(struct proc *p, int pri, const char *fmt, ...)
183 vtprintf(p, pri, fmt, ap);
188 vtprintf(struct proc *p, int pri, const char *fmt, va_list ap)
190 struct tty *tp = NULL;
192 struct putchar_arg pca;
193 struct session *sess = NULL;
195 sx_slock(&proctree_lock);
200 if (p->p_flag & P_CONTROLT && p->p_session->s_ttyvp) {
205 if (tp != NULL && tty_checkoutq(tp))
218 sx_sunlock(&proctree_lock);
219 kvprintf(fmt, putchar, &pca, 10, ap);
228 * Ttyprintf displays a message on a tty; it should be used only by
229 * the tty driver, or anything that knows the underlying tty will not
230 * be revoke(2)'d away. Other callers should use tprintf.
233 ttyprintf(struct tty *tp, const char *fmt, ...)
236 struct putchar_arg pca;
243 retval = kvprintf(fmt, putchar, &pca, 10, ap);
249 _vprintf(int level, int flags, const char *fmt, va_list ap)
251 struct putchar_arg pca;
253 #ifdef PRINTF_BUFR_SIZE
254 char bufr[PRINTF_BUFR_SIZE];
260 #ifdef PRINTF_BUFR_SIZE
262 pca.p_next = pca.p_bufr;
263 pca.n_bufr = sizeof(bufr);
264 pca.remain = sizeof(bufr);
267 /* Don't buffer console output. */
271 retval = kvprintf(fmt, putchar, &pca, 10, ap);
273 #ifdef PRINTF_BUFR_SIZE
274 /* Write any buffered console/log output: */
275 if (*pca.p_bufr != '\0') {
276 if (pca.flags & TOLOG)
277 msglogstr(pca.p_bufr, level, /*filter_cr*/1);
279 if (pca.flags & TOCONS)
288 * Log writes to the log buffer, and guarantees not to sleep (so can be
289 * called by interrupt routines). If there is no process reading the
290 * log yet, it writes to the console also.
293 log(int level, const char *fmt, ...)
298 (void)_vprintf(level, log_open ? TOLOG : TOCONS, fmt, ap);
304 #define CONSCHUNK 128
307 log_console(struct uio *uio)
313 if (!log_console_output)
316 pri = LOG_INFO | LOG_CONSOLE;
318 consbuffer = malloc(CONSCHUNK, M_TEMP, M_WAITOK);
321 while (uio->uio_resid > 0) {
322 c = imin(uio->uio_resid, CONSCHUNK - 1);
323 error = uiomove(consbuffer, c, uio);
326 /* Make sure we're NUL-terminated */
327 consbuffer[c] = '\0';
328 if (consbuffer[c - 1] == '\n')
332 msglogstr(consbuffer, pri, /*filter_cr*/ 1);
335 * The previous behavior in log_console() is preserved when
336 * log_console_add_linefeed is non-zero. For that behavior, if an
337 * individual console write came in that was not terminated with a
338 * line feed, it would add a line feed.
340 * This results in different data in the message buffer than
341 * appears on the system console (which doesn't add extra line feed
344 * A number of programs and rc scripts write a line feed, or a period
345 * and a line feed when they have completed their operation. On
346 * the console, this looks seamless, but when displayed with
347 * 'dmesg -a', you wind up with output that looks like this:
352 * On the console, it looks like this:
355 * We could add logic to detect that situation, or just not insert
356 * the extra newlines. Set the kern.log_console_add_linefeed
357 * sysctl/tunable variable to get the old behavior.
359 if (!nl && log_console_add_linefeed) {
360 consbuffer[0] = '\n';
361 consbuffer[1] = '\0';
362 msglogstr(consbuffer, pri, /*filter_cr*/ 1);
366 free(consbuffer, M_TEMP);
371 printf(const char *fmt, ...)
377 retval = vprintf(fmt, ap);
384 vprintf(const char *fmt, va_list ap)
388 retval = _vprintf(-1, TOCONS | TOLOG, fmt, ap);
397 putbuf(int c, struct putchar_arg *ap)
399 /* Check if no console output buffer was provided. */
400 if (ap->p_bufr == NULL) {
401 /* Output direct to the console. */
402 if (ap->flags & TOCONS)
405 if (ap->flags & TOLOG)
406 msglogchar(c, ap->pri);
408 /* Buffer the character: */
412 /* Always leave the buffer zero terminated. */
415 /* Check if the buffer needs to be flushed. */
416 if (ap->remain == 2 || c == '\n') {
418 if (ap->flags & TOLOG)
419 msglogstr(ap->p_bufr, ap->pri, /*filter_cr*/1);
421 if (ap->flags & TOCONS) {
422 if ((panicstr == NULL) && (constty != NULL))
423 msgbuf_addstr(&consmsgbuf, -1,
424 ap->p_bufr, /*filter_cr*/ 0);
426 if ((constty == NULL) ||(always_console_output))
430 ap->p_next = ap->p_bufr;
431 ap->remain = ap->n_bufr;
436 * Since we fill the buffer up one character at a time,
437 * this should not happen. We should always catch it when
438 * ap->remain == 2 (if not sooner due to a newline), flush
439 * the buffer and move on. One way this could happen is
440 * if someone sets PRINTF_BUFR_SIZE to 1 or something
443 KASSERT(ap->remain > 2, ("Bad buffer logic, remain = %zd",
449 * Print a character on console or users terminal. If destination is
450 * the console then the last bunch of characters are saved in msgbuf for
454 putchar(int c, void *arg)
456 struct putchar_arg *ap = (struct putchar_arg*) arg;
457 struct tty *tp = ap->tty;
458 int flags = ap->flags;
460 /* Don't use the tty code after a panic or while in ddb. */
467 if ((flags & TOTTY) && tp != NULL && panicstr == NULL)
470 if ((flags & (TOCONS | TOLOG)) && c != '\0')
475 * Scaled down version of sprintf(3).
478 sprintf(char *buf, const char *cfmt, ...)
484 retval = kvprintf(cfmt, NULL, (void *)buf, 10, ap);
491 * Scaled down version of vsprintf(3).
494 vsprintf(char *buf, const char *cfmt, va_list ap)
498 retval = kvprintf(cfmt, NULL, (void *)buf, 10, ap);
504 * Scaled down version of snprintf(3).
507 snprintf(char *str, size_t size, const char *format, ...)
512 va_start(ap, format);
513 retval = vsnprintf(str, size, format, ap);
519 * Scaled down version of vsnprintf(3).
522 vsnprintf(char *str, size_t size, const char *format, va_list ap)
524 struct snprintf_arg info;
529 retval = kvprintf(format, snprintf_func, &info, 10, ap);
530 if (info.remain >= 1)
536 * Kernel version which takes radix argument vsnprintf(3).
539 vsnrprintf(char *str, size_t size, int radix, const char *format, va_list ap)
541 struct snprintf_arg info;
546 retval = kvprintf(format, snprintf_func, &info, radix, ap);
547 if (info.remain >= 1)
553 snprintf_func(int ch, void *arg)
555 struct snprintf_arg *const info = arg;
557 if (info->remain >= 2) {
564 * Put a NUL-terminated ASCII number (base <= 36) in a buffer in reverse
565 * order; return an optional length and a pointer to the last character
566 * written in the buffer (i.e., the first character of the string).
567 * The buffer pointed to by `nbuf' must have length >= MAXNBUF.
570 ksprintn(char *nbuf, uintmax_t num, int base, int *lenp, int upper)
577 c = hex2ascii(num % base);
578 *++p = upper ? toupper(c) : c;
579 } while (num /= base);
586 * Scaled down version of printf(3).
588 * Two additional formats:
590 * The format %b is supported to decode error registers.
593 * printf("reg=%b\n", regval, "<base><arg>*");
595 * where <base> is the output base expressed as a control character, e.g.
596 * \10 gives octal; \20 gives hex. Each arg is a sequence of characters,
597 * the first of which gives the bit number to be inspected (origin 1), and
598 * the next characters (up to a control character, i.e. a character <= 32),
599 * give the name of the register. Thus:
601 * kvprintf("reg=%b\n", 3, "\10\2BITTWO\1BITONE\n");
603 * would produce output:
605 * reg=3<BITTWO,BITONE>
607 * XXX: %D -- Hexdump, takes pointer and separator string:
608 * ("%6D", ptr, ":") -> XX:XX:XX:XX:XX:XX
609 * ("%*D", len, ptr, " " -> XX XX XX XX ...
612 kvprintf(char const *fmt, void (*func)(int, void*), void *arg, int radix, va_list ap)
614 #define PCHAR(c) {int cc=(c); if (func) (*func)(cc,arg); else *d++ = cc; retval++; }
617 const char *p, *percent, *q;
621 int base, lflag, qflag, tmp, width, ladjust, sharpflag, neg, sign, dot;
622 int cflag, hflag, jflag, tflag, zflag;
625 int stop = 0, retval = 0;
634 fmt = "(fmt null)\n";
636 if (radix < 2 || radix > 36)
642 while ((ch = (u_char)*fmt++) != '%' || stop) {
648 qflag = 0; lflag = 0; ladjust = 0; sharpflag = 0; neg = 0;
649 sign = 0; dot = 0; dwidth = 0; upper = 0;
650 cflag = 0; hflag = 0; jflag = 0; tflag = 0; zflag = 0;
651 reswitch: switch (ch = (u_char)*fmt++) {
669 width = va_arg(ap, int);
675 dwidth = va_arg(ap, int);
683 case '1': case '2': case '3': case '4':
684 case '5': case '6': case '7': case '8': case '9':
685 for (n = 0;; ++fmt) {
686 n = n * 10 + ch - '0';
688 if (ch < '0' || ch > '9')
697 num = (u_int)va_arg(ap, int);
698 p = va_arg(ap, char *);
699 for (q = ksprintn(nbuf, num, *p++, NULL, 0); *q;)
707 if (num & (1 << (n - 1))) {
708 PCHAR(tmp ? ',' : '<');
709 for (; (n = *p) > ' '; ++p)
713 for (; *p > ' '; ++p)
720 PCHAR(va_arg(ap, int));
723 up = va_arg(ap, u_char *);
724 p = va_arg(ap, char *);
728 PCHAR(hex2ascii(*up >> 4));
729 PCHAR(hex2ascii(*up & 0x0f));
760 *(va_arg(ap, intmax_t *)) = retval;
762 *(va_arg(ap, quad_t *)) = retval;
764 *(va_arg(ap, long *)) = retval;
766 *(va_arg(ap, size_t *)) = retval;
768 *(va_arg(ap, short *)) = retval;
770 *(va_arg(ap, char *)) = retval;
772 *(va_arg(ap, int *)) = retval;
779 sharpflag = (width == 0);
781 num = (uintptr_t)va_arg(ap, void *);
792 p = va_arg(ap, char *);
798 for (n = 0; n < dwidth && p[n]; n++)
803 if (!ladjust && width > 0)
808 if (ladjust && width > 0)
833 num = va_arg(ap, uintmax_t);
835 num = va_arg(ap, u_quad_t);
837 num = va_arg(ap, ptrdiff_t);
839 num = va_arg(ap, u_long);
841 num = va_arg(ap, size_t);
843 num = (u_short)va_arg(ap, int);
845 num = (u_char)va_arg(ap, int);
847 num = va_arg(ap, u_int);
851 num = va_arg(ap, intmax_t);
853 num = va_arg(ap, quad_t);
855 num = va_arg(ap, ptrdiff_t);
857 num = va_arg(ap, long);
859 num = va_arg(ap, ssize_t);
861 num = (short)va_arg(ap, int);
863 num = (char)va_arg(ap, int);
865 num = va_arg(ap, int);
867 if (sign && (intmax_t)num < 0) {
869 num = -(intmax_t)num;
871 p = ksprintn(nbuf, num, base, &n, upper);
873 if (sharpflag && num != 0) {
882 if (!ladjust && padc == '0')
883 dwidth = width - tmp;
884 width -= tmp + imax(dwidth, n);
891 if (sharpflag && num != 0) {
894 } else if (base == 16) {
911 while (percent < fmt)
914 * Since we ignore a formatting argument it is no
915 * longer safe to obey the remaining formatting
916 * arguments as the arguments will no longer match
927 * Put character in log buffer with a particular priority.
930 msglogchar(int c, int pri)
932 static int lastpri = -1;
939 if (c == '\0' || c == '\r')
941 if (pri != -1 && pri != lastpri) {
943 msgbuf_addchar(msgbufp, '\n');
946 msgbuf_addchar(msgbufp, '<');
947 for (p = ksprintn(nbuf, (uintmax_t)pri, 10, NULL, 0); *p;)
948 msgbuf_addchar(msgbufp, *p--);
949 msgbuf_addchar(msgbufp, '>');
952 msgbuf_addchar(msgbufp, c);
962 msglogstr(char *str, int pri, int filter_cr)
967 msgbuf_addstr(msgbufp, pri, str, filter_cr);
971 msgbufinit(void *ptr, int size)
974 static struct msgbuf *oldp = NULL;
976 size -= sizeof(*msgbufp);
978 msgbufp = (struct msgbuf *)(cp + size);
979 msgbuf_reinit(msgbufp, cp, size);
980 if (msgbufmapped && oldp != msgbufp)
981 msgbuf_copy(oldp, msgbufp);
986 static int unprivileged_read_msgbuf = 1;
987 SYSCTL_INT(_security_bsd, OID_AUTO, unprivileged_read_msgbuf,
988 CTLFLAG_RW, &unprivileged_read_msgbuf, 0,
989 "Unprivileged processes may read the kernel message buffer");
991 /* Sysctls for accessing/clearing the msgbuf */
993 sysctl_kern_msgbuf(SYSCTL_HANDLER_ARGS)
999 if (!unprivileged_read_msgbuf) {
1000 error = priv_check(req->td, PRIV_MSGBUF);
1005 /* Read the whole buffer, one chunk at a time. */
1006 mtx_lock(&msgbuf_lock);
1007 msgbuf_peekbytes(msgbufp, NULL, 0, &seq);
1009 len = msgbuf_peekbytes(msgbufp, buf, sizeof(buf), &seq);
1010 mtx_unlock(&msgbuf_lock);
1014 error = sysctl_handle_opaque(oidp, buf, len, req);
1018 mtx_lock(&msgbuf_lock);
1022 SYSCTL_PROC(_kern, OID_AUTO, msgbuf,
1023 CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_MPSAFE,
1024 NULL, 0, sysctl_kern_msgbuf, "A", "Contents of kernel message buffer");
1026 static int msgbuf_clearflag;
1029 sysctl_kern_msgbuf_clear(SYSCTL_HANDLER_ARGS)
1032 error = sysctl_handle_int(oidp, oidp->oid_arg1, oidp->oid_arg2, req);
1033 if (!error && req->newptr) {
1034 mtx_lock(&msgbuf_lock);
1035 msgbuf_clear(msgbufp);
1036 mtx_unlock(&msgbuf_lock);
1037 msgbuf_clearflag = 0;
1042 SYSCTL_PROC(_kern, OID_AUTO, msgbuf_clear,
1043 CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_SECURE | CTLFLAG_MPSAFE,
1044 &msgbuf_clearflag, 0, sysctl_kern_msgbuf_clear, "I",
1045 "Clear kernel message buffer");
1049 DB_SHOW_COMMAND(msgbuf, db_show_msgbuf)
1053 if (!msgbufmapped) {
1054 db_printf("msgbuf not mapped yet\n");
1057 db_printf("msgbufp = %p\n", msgbufp);
1058 db_printf("magic = %x, size = %d, r= %u, w = %u, ptr = %p, cksum= %u\n",
1059 msgbufp->msg_magic, msgbufp->msg_size, msgbufp->msg_rseq,
1060 msgbufp->msg_wseq, msgbufp->msg_ptr, msgbufp->msg_cksum);
1061 for (i = 0; i < msgbufp->msg_size && !db_pager_quit; i++) {
1062 j = MSGBUF_SEQ_TO_POS(msgbufp, i + msgbufp->msg_rseq);
1063 db_printf("%c", msgbufp->msg_ptr[j]);
1071 hexdump(const void *ptr, int length, const char *hdr, int flags)
1075 const unsigned char *cp;
1078 if ((flags & HD_DELIM_MASK) != 0)
1079 delim = (flags & HD_DELIM_MASK) >> 8;
1083 if ((flags & HD_COLUMN_MASK) != 0)
1084 cols = flags & HD_COLUMN_MASK;
1089 for (i = 0; i < length; i+= cols) {
1093 if ((flags & HD_OMIT_COUNT) == 0)
1096 if ((flags & HD_OMIT_HEX) == 0) {
1097 for (j = 0; j < cols; j++) {
1100 printf("%c%02x", delim, cp[k]);
1106 if ((flags & HD_OMIT_CHARS) == 0) {
1108 for (j = 0; j < cols; j++) {
1112 else if (cp[k] >= ' ' && cp[k] <= '~')
1113 printf("%c", cp[k]);