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);
395 printf(const char *fmt, ...)
401 retval = vprintf(fmt, ap);
408 vprintf(const char *fmt, va_list ap)
412 retval = _vprintf(-1, TOCONS | TOLOG, fmt, ap);
421 prf_putbuf(char *bufr, int flags, int pri)
425 msglogstr(bufr, pri, /*filter_cr*/1);
427 if (flags & TOCONS) {
428 if ((panicstr == NULL) && (constty != NULL))
429 msgbuf_addstr(&consmsgbuf, -1,
430 bufr, /*filter_cr*/ 0);
432 if ((constty == NULL) ||(always_console_output))
438 putbuf(int c, struct putchar_arg *ap)
440 /* Check if no console output buffer was provided. */
441 if (ap->p_bufr == NULL) {
442 /* Output direct to the console. */
443 if (ap->flags & TOCONS)
446 if (ap->flags & TOLOG)
447 msglogchar(c, ap->pri);
449 /* Buffer the character: */
453 /* Always leave the buffer zero terminated. */
456 /* Check if the buffer needs to be flushed. */
457 if (ap->remain == 2 || c == '\n') {
458 prf_putbuf(ap->p_bufr, ap->flags, ap->pri);
460 ap->p_next = ap->p_bufr;
461 ap->remain = ap->n_bufr;
466 * Since we fill the buffer up one character at a time,
467 * this should not happen. We should always catch it when
468 * ap->remain == 2 (if not sooner due to a newline), flush
469 * the buffer and move on. One way this could happen is
470 * if someone sets PRINTF_BUFR_SIZE to 1 or something
473 KASSERT(ap->remain > 2, ("Bad buffer logic, remain = %zd",
479 * Print a character on console or users terminal. If destination is
480 * the console then the last bunch of characters are saved in msgbuf for
484 putchar(int c, void *arg)
486 struct putchar_arg *ap = (struct putchar_arg*) arg;
487 struct tty *tp = ap->tty;
488 int flags = ap->flags;
490 /* Don't use the tty code after a panic or while in ddb. */
497 if ((flags & TOTTY) && tp != NULL && panicstr == NULL)
500 if ((flags & (TOCONS | TOLOG)) && c != '\0')
505 * Scaled down version of sprintf(3).
508 sprintf(char *buf, const char *cfmt, ...)
514 retval = kvprintf(cfmt, NULL, (void *)buf, 10, ap);
521 * Scaled down version of vsprintf(3).
524 vsprintf(char *buf, const char *cfmt, va_list ap)
528 retval = kvprintf(cfmt, NULL, (void *)buf, 10, ap);
534 * Scaled down version of snprintf(3).
537 snprintf(char *str, size_t size, const char *format, ...)
542 va_start(ap, format);
543 retval = vsnprintf(str, size, format, ap);
549 * Scaled down version of vsnprintf(3).
552 vsnprintf(char *str, size_t size, const char *format, va_list ap)
554 struct snprintf_arg info;
559 retval = kvprintf(format, snprintf_func, &info, 10, ap);
560 if (info.remain >= 1)
566 * Kernel version which takes radix argument vsnprintf(3).
569 vsnrprintf(char *str, size_t size, int radix, const char *format, va_list ap)
571 struct snprintf_arg info;
576 retval = kvprintf(format, snprintf_func, &info, radix, ap);
577 if (info.remain >= 1)
583 snprintf_func(int ch, void *arg)
585 struct snprintf_arg *const info = arg;
587 if (info->remain >= 2) {
594 * Put a NUL-terminated ASCII number (base <= 36) in a buffer in reverse
595 * order; return an optional length and a pointer to the last character
596 * written in the buffer (i.e., the first character of the string).
597 * The buffer pointed to by `nbuf' must have length >= MAXNBUF.
600 ksprintn(char *nbuf, uintmax_t num, int base, int *lenp, int upper)
607 c = hex2ascii(num % base);
608 *++p = upper ? toupper(c) : c;
609 } while (num /= base);
616 * Scaled down version of printf(3).
618 * Two additional formats:
620 * The format %b is supported to decode error registers.
623 * printf("reg=%b\n", regval, "<base><arg>*");
625 * where <base> is the output base expressed as a control character, e.g.
626 * \10 gives octal; \20 gives hex. Each arg is a sequence of characters,
627 * the first of which gives the bit number to be inspected (origin 1), and
628 * the next characters (up to a control character, i.e. a character <= 32),
629 * give the name of the register. Thus:
631 * kvprintf("reg=%b\n", 3, "\10\2BITTWO\1BITONE");
633 * would produce output:
635 * reg=3<BITTWO,BITONE>
637 * XXX: %D -- Hexdump, takes pointer and separator string:
638 * ("%6D", ptr, ":") -> XX:XX:XX:XX:XX:XX
639 * ("%*D", len, ptr, " " -> XX XX XX XX ...
642 kvprintf(char const *fmt, void (*func)(int, void*), void *arg, int radix, va_list ap)
644 #define PCHAR(c) {int cc=(c); if (func) (*func)(cc,arg); else *d++ = cc; retval++; }
647 const char *p, *percent, *q;
651 int base, lflag, qflag, tmp, width, ladjust, sharpflag, neg, sign, dot;
652 int cflag, hflag, jflag, tflag, zflag;
653 int bconv, dwidth, upper;
655 int stop = 0, retval = 0;
664 fmt = "(fmt null)\n";
666 if (radix < 2 || radix > 36)
672 while ((ch = (u_char)*fmt++) != '%' || stop) {
678 qflag = 0; lflag = 0; ladjust = 0; sharpflag = 0; neg = 0;
679 sign = 0; dot = 0; bconv = 0; dwidth = 0; upper = 0;
680 cflag = 0; hflag = 0; jflag = 0; tflag = 0; zflag = 0;
681 reswitch: switch (ch = (u_char)*fmt++) {
699 width = va_arg(ap, int);
705 dwidth = va_arg(ap, int);
713 case '1': case '2': case '3': case '4':
714 case '5': case '6': case '7': case '8': case '9':
715 for (n = 0;; ++fmt) {
716 n = n * 10 + ch - '0';
718 if (ch < '0' || ch > '9')
733 if (!ladjust && width > 0)
736 PCHAR(va_arg(ap, int));
737 if (ladjust && width > 0)
742 up = va_arg(ap, u_char *);
743 p = va_arg(ap, char *);
747 PCHAR(hex2ascii(*up >> 4));
748 PCHAR(hex2ascii(*up & 0x0f));
779 *(va_arg(ap, intmax_t *)) = retval;
781 *(va_arg(ap, quad_t *)) = retval;
783 *(va_arg(ap, long *)) = retval;
785 *(va_arg(ap, size_t *)) = retval;
787 *(va_arg(ap, short *)) = retval;
789 *(va_arg(ap, char *)) = retval;
791 *(va_arg(ap, int *)) = retval;
798 sharpflag = (width == 0);
800 num = (uintptr_t)va_arg(ap, void *);
811 p = va_arg(ap, char *);
817 for (n = 0; n < dwidth && p[n]; n++)
822 if (!ladjust && width > 0)
827 if (ladjust && width > 0)
852 num = va_arg(ap, uintmax_t);
854 num = va_arg(ap, u_quad_t);
856 num = va_arg(ap, ptrdiff_t);
858 num = va_arg(ap, u_long);
860 num = va_arg(ap, size_t);
862 num = (u_short)va_arg(ap, int);
864 num = (u_char)va_arg(ap, int);
866 num = va_arg(ap, u_int);
868 q = va_arg(ap, char *);
874 num = va_arg(ap, intmax_t);
876 num = va_arg(ap, quad_t);
878 num = va_arg(ap, ptrdiff_t);
880 num = va_arg(ap, long);
882 num = va_arg(ap, ssize_t);
884 num = (short)va_arg(ap, int);
886 num = (char)va_arg(ap, int);
888 num = va_arg(ap, int);
890 if (sign && (intmax_t)num < 0) {
892 num = -(intmax_t)num;
894 p = ksprintn(nbuf, num, base, &n, upper);
896 if (sharpflag && num != 0) {
905 if (!ladjust && padc == '0')
906 dwidth = width - tmp;
907 width -= tmp + imax(dwidth, n);
914 if (sharpflag && num != 0) {
917 } else if (base == 16) {
928 if (bconv && num != 0) {
929 /* %b conversion flag format. */
933 if (num & (1 << (n - 1))) {
934 PCHAR(retval != tmp ?
936 for (; (n = *q) > ' '; ++q)
939 for (; *q > ' '; ++q)
944 width -= retval - tmp;
954 while (percent < fmt)
957 * Since we ignore a formatting argument it is no
958 * longer safe to obey the remaining formatting
959 * arguments as the arguments will no longer match
970 * Put character in log buffer with a particular priority.
973 msglogchar(int c, int pri)
975 static int lastpri = -1;
982 if (c == '\0' || c == '\r')
984 if (pri != -1 && pri != lastpri) {
986 msgbuf_addchar(msgbufp, '\n');
989 msgbuf_addchar(msgbufp, '<');
990 for (p = ksprintn(nbuf, (uintmax_t)pri, 10, NULL, 0); *p;)
991 msgbuf_addchar(msgbufp, *p--);
992 msgbuf_addchar(msgbufp, '>');
995 msgbuf_addchar(msgbufp, c);
1005 msglogstr(char *str, int pri, int filter_cr)
1010 msgbuf_addstr(msgbufp, pri, str, filter_cr);
1014 msgbufinit(void *ptr, int size)
1017 static struct msgbuf *oldp = NULL;
1019 size -= sizeof(*msgbufp);
1021 msgbufp = (struct msgbuf *)(cp + size);
1022 msgbuf_reinit(msgbufp, cp, size);
1023 if (msgbufmapped && oldp != msgbufp)
1024 msgbuf_copy(oldp, msgbufp);
1029 static int unprivileged_read_msgbuf = 1;
1030 SYSCTL_INT(_security_bsd, OID_AUTO, unprivileged_read_msgbuf,
1031 CTLFLAG_RW, &unprivileged_read_msgbuf, 0,
1032 "Unprivileged processes may read the kernel message buffer");
1034 /* Sysctls for accessing/clearing the msgbuf */
1036 sysctl_kern_msgbuf(SYSCTL_HANDLER_ARGS)
1042 if (!unprivileged_read_msgbuf) {
1043 error = priv_check(req->td, PRIV_MSGBUF);
1048 /* Read the whole buffer, one chunk at a time. */
1049 mtx_lock(&msgbuf_lock);
1050 msgbuf_peekbytes(msgbufp, NULL, 0, &seq);
1052 len = msgbuf_peekbytes(msgbufp, buf, sizeof(buf), &seq);
1053 mtx_unlock(&msgbuf_lock);
1055 return (SYSCTL_OUT(req, "", 1)); /* add nulterm */
1057 error = sysctl_handle_opaque(oidp, buf, len, req);
1061 mtx_lock(&msgbuf_lock);
1065 SYSCTL_PROC(_kern, OID_AUTO, msgbuf,
1066 CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_MPSAFE,
1067 NULL, 0, sysctl_kern_msgbuf, "A", "Contents of kernel message buffer");
1069 static int msgbuf_clearflag;
1072 sysctl_kern_msgbuf_clear(SYSCTL_HANDLER_ARGS)
1075 error = sysctl_handle_int(oidp, oidp->oid_arg1, oidp->oid_arg2, req);
1076 if (!error && req->newptr) {
1077 mtx_lock(&msgbuf_lock);
1078 msgbuf_clear(msgbufp);
1079 mtx_unlock(&msgbuf_lock);
1080 msgbuf_clearflag = 0;
1085 SYSCTL_PROC(_kern, OID_AUTO, msgbuf_clear,
1086 CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_SECURE | CTLFLAG_MPSAFE,
1087 &msgbuf_clearflag, 0, sysctl_kern_msgbuf_clear, "I",
1088 "Clear kernel message buffer");
1092 DB_SHOW_COMMAND(msgbuf, db_show_msgbuf)
1096 if (!msgbufmapped) {
1097 db_printf("msgbuf not mapped yet\n");
1100 db_printf("msgbufp = %p\n", msgbufp);
1101 db_printf("magic = %x, size = %d, r= %u, w = %u, ptr = %p, cksum= %u\n",
1102 msgbufp->msg_magic, msgbufp->msg_size, msgbufp->msg_rseq,
1103 msgbufp->msg_wseq, msgbufp->msg_ptr, msgbufp->msg_cksum);
1104 for (i = 0; i < msgbufp->msg_size && !db_pager_quit; i++) {
1105 j = MSGBUF_SEQ_TO_POS(msgbufp, i + msgbufp->msg_rseq);
1106 db_printf("%c", msgbufp->msg_ptr[j]);
1114 hexdump(const void *ptr, int length, const char *hdr, int flags)
1118 const unsigned char *cp;
1121 if ((flags & HD_DELIM_MASK) != 0)
1122 delim = (flags & HD_DELIM_MASK) >> 8;
1126 if ((flags & HD_COLUMN_MASK) != 0)
1127 cols = flags & HD_COLUMN_MASK;
1132 for (i = 0; i < length; i+= cols) {
1136 if ((flags & HD_OMIT_COUNT) == 0)
1139 if ((flags & HD_OMIT_HEX) == 0) {
1140 for (j = 0; j < cols; j++) {
1143 printf("%c%02x", delim, cp[k]);
1149 if ((flags & HD_OMIT_CHARS) == 0) {
1151 for (j = 0; j < cols; j++) {
1155 else if (cp[k] >= ' ' && cp[k] <= '~')
1156 printf("%c", cp[k]);
1165 #endif /* _KERNEL */
1168 sbuf_hexdump(struct sbuf *sb, const void *ptr, int length, const char *hdr,
1173 const unsigned char *cp;
1176 if ((flags & HD_DELIM_MASK) != 0)
1177 delim = (flags & HD_DELIM_MASK) >> 8;
1181 if ((flags & HD_COLUMN_MASK) != 0)
1182 cols = flags & HD_COLUMN_MASK;
1187 for (i = 0; i < length; i+= cols) {
1189 sbuf_printf(sb, "%s", hdr);
1191 if ((flags & HD_OMIT_COUNT) == 0)
1192 sbuf_printf(sb, "%04x ", i);
1194 if ((flags & HD_OMIT_HEX) == 0) {
1195 for (j = 0; j < cols; j++) {
1198 sbuf_printf(sb, "%c%02x", delim, cp[k]);
1200 sbuf_printf(sb, " ");
1204 if ((flags & HD_OMIT_CHARS) == 0) {
1205 sbuf_printf(sb, " |");
1206 for (j = 0; j < cols; j++) {
1209 sbuf_printf(sb, " ");
1210 else if (cp[k] >= ' ' && cp[k] <= '~')
1211 sbuf_printf(sb, "%c", cp[k]);
1213 sbuf_printf(sb, ".");
1215 sbuf_printf(sb, "|");
1217 sbuf_printf(sb, "\n");
1223 counted_warning(unsigned *counter, const char *msg)
1232 if (atomic_cmpset_int(counter, c, c - 1)) {
1234 log(LOG_INFO, "pid %d (%s) %s%s\n",
1235 td->td_proc->p_pid, td->td_name, msg,
1236 c > 1 ? "" : " - not logging anymore");
1245 sbuf_putbuf(struct sbuf *sb)
1248 prf_putbuf(sbuf_data(sb), TOLOG | TOCONS, -1);
1252 sbuf_putbuf(struct sbuf *sb)
1255 printf("%s", sbuf_data(sb));