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 putchar(int ch, void *arg);
98 static char *ksprintn(char *nbuf, uintmax_t num, int base, int *len, int upper);
99 static void snprintf_func(int ch, void *arg);
101 static int msgbufmapped; /* Set when safe to use msgbuf */
104 static int log_console_output = 1;
105 TUNABLE_INT("kern.log_console_output", &log_console_output);
106 SYSCTL_INT(_kern, OID_AUTO, log_console_output, CTLFLAG_RW,
107 &log_console_output, 0, "Duplicate console output to the syslog.");
109 static int always_console_output = 0;
110 TUNABLE_INT("kern.always_console_output", &always_console_output);
111 SYSCTL_INT(_kern, OID_AUTO, always_console_output, CTLFLAG_RW,
112 &always_console_output, 0, "Always output to console despite TIOCCONS.");
115 * Warn that a system table is full.
118 tablefull(const char *tab)
121 log(LOG_ERR, "%s: table is full\n", tab);
125 * Uprintf prints to the controlling terminal for the current process.
128 uprintf(const char *fmt, ...)
131 struct putchar_arg pca;
137 if (TD_IS_IDLETHREAD(td))
140 sx_slock(&proctree_lock);
143 if ((p->p_flag & P_CONTROLT) == 0) {
148 SESS_LOCK(p->p_session);
149 pca.tty = p->p_session->s_ttyp;
150 SESS_UNLOCK(p->p_session);
152 if (pca.tty == NULL) {
159 retval = kvprintf(fmt, putchar, &pca, 10, ap);
163 sx_sunlock(&proctree_lock);
168 * tprintf prints on the controlling terminal associated with the given
169 * session, possibly to the log as well.
172 tprintf(struct proc *p, int pri, const char *fmt, ...)
174 struct tty *tp = NULL;
177 struct putchar_arg pca;
178 struct session *sess = NULL;
180 sx_slock(&proctree_lock);
185 if (p->p_flag & P_CONTROLT && p->p_session->s_ttyvp) {
190 if (tp != NULL && tty_checkoutq(tp))
203 kvprintf(fmt, putchar, &pca, 10, ap);
210 sx_sunlock(&proctree_lock);
214 * Ttyprintf displays a message on a tty; it should be used only by
215 * the tty driver, or anything that knows the underlying tty will not
216 * be revoke(2)'d away. Other callers should use tprintf.
219 ttyprintf(struct tty *tp, const char *fmt, ...)
222 struct putchar_arg pca;
228 retval = kvprintf(fmt, putchar, &pca, 10, ap);
234 * Log writes to the log buffer, and guarantees not to sleep (so can be
235 * called by interrupt routines). If there is no process reading the
236 * log yet, it writes to the console also.
239 log(int level, const char *fmt, ...)
242 struct putchar_arg pca;
246 pca.flags = log_open ? TOLOG : TOCONS;
250 kvprintf(fmt, putchar, &pca, 10, ap);
256 #define CONSCHUNK 128
259 log_console(struct uio *uio)
265 if (!log_console_output)
268 pri = LOG_INFO | LOG_CONSOLE;
270 consbuffer = malloc(CONSCHUNK, M_TEMP, M_WAITOK);
273 while (uio->uio_resid > 0) {
274 c = imin(uio->uio_resid, CONSCHUNK);
275 error = uiomove(consbuffer, c, uio);
278 for (i = 0; i < c; i++) {
279 msglogchar(consbuffer[i], pri);
280 if (consbuffer[i] == '\n')
287 msglogchar('\n', pri);
290 free(consbuffer, M_TEMP);
295 printf(const char *fmt, ...)
301 retval = vprintf(fmt, ap);
308 vprintf(const char *fmt, va_list ap)
310 struct putchar_arg pca;
312 #ifdef PRINTF_BUFR_SIZE
313 char bufr[PRINTF_BUFR_SIZE];
317 pca.flags = TOCONS | TOLOG;
319 #ifdef PRINTF_BUFR_SIZE
321 pca.p_next = pca.p_bufr;
322 pca.n_bufr = sizeof(bufr);
323 pca.remain = sizeof(bufr);
326 /* Don't buffer console output. */
330 retval = kvprintf(fmt, putchar, &pca, 10, ap);
332 #ifdef PRINTF_BUFR_SIZE
333 /* Write any buffered console output: */
334 if (*pca.p_bufr != '\0')
345 putcons(int c, struct putchar_arg *ap)
347 /* Check if no console output buffer was provided. */
348 if (ap->p_bufr == NULL)
349 /* Output direct to the console. */
352 /* Buffer the character: */
354 *ap->p_next++ = '\r';
360 /* Always leave the buffer zero terminated. */
363 /* Check if the buffer needs to be flushed. */
364 if (ap->remain < 3 || c == '\n') {
366 ap->p_next = ap->p_bufr;
367 ap->remain = ap->n_bufr;
374 * Print a character on console or users terminal. If destination is
375 * the console then the last bunch of characters are saved in msgbuf for
379 putchar(int c, void *arg)
381 struct putchar_arg *ap = (struct putchar_arg*) arg;
382 struct tty *tp = ap->tty;
383 int flags = ap->flags;
385 /* Don't use the tty code after a panic or while in ddb. */
389 } else if (panicstr || ((flags & TOCONS) && constty == NULL)) {
393 if ((flags & TOTTY) && tp != NULL)
395 if (flags & TOCONS) {
397 msgbuf_addchar(&consmsgbuf, c);
398 if (always_console_output && c != '\0')
403 msglogchar(c, ap->pri);
407 * Scaled down version of sprintf(3).
410 sprintf(char *buf, const char *cfmt, ...)
416 retval = kvprintf(cfmt, NULL, (void *)buf, 10, ap);
423 * Scaled down version of vsprintf(3).
426 vsprintf(char *buf, const char *cfmt, va_list ap)
430 retval = kvprintf(cfmt, NULL, (void *)buf, 10, ap);
436 * Scaled down version of snprintf(3).
439 snprintf(char *str, size_t size, const char *format, ...)
444 va_start(ap, format);
445 retval = vsnprintf(str, size, format, ap);
451 * Scaled down version of vsnprintf(3).
454 vsnprintf(char *str, size_t size, const char *format, va_list ap)
456 struct snprintf_arg info;
461 retval = kvprintf(format, snprintf_func, &info, 10, ap);
462 if (info.remain >= 1)
468 * Kernel version which takes radix argument vsnprintf(3).
471 vsnrprintf(char *str, size_t size, int radix, const char *format, va_list ap)
473 struct snprintf_arg info;
478 retval = kvprintf(format, snprintf_func, &info, radix, ap);
479 if (info.remain >= 1)
485 snprintf_func(int ch, void *arg)
487 struct snprintf_arg *const info = arg;
489 if (info->remain >= 2) {
496 * Put a NUL-terminated ASCII number (base <= 36) in a buffer in reverse
497 * order; return an optional length and a pointer to the last character
498 * written in the buffer (i.e., the first character of the string).
499 * The buffer pointed to by `nbuf' must have length >= MAXNBUF.
502 ksprintn(char *nbuf, uintmax_t num, int base, int *lenp, int upper)
509 c = hex2ascii(num % base);
510 *++p = upper ? toupper(c) : c;
511 } while (num /= base);
518 * Scaled down version of printf(3).
520 * Two additional formats:
522 * The format %b is supported to decode error registers.
525 * printf("reg=%b\n", regval, "<base><arg>*");
527 * where <base> is the output base expressed as a control character, e.g.
528 * \10 gives octal; \20 gives hex. Each arg is a sequence of characters,
529 * the first of which gives the bit number to be inspected (origin 1), and
530 * the next characters (up to a control character, i.e. a character <= 32),
531 * give the name of the register. Thus:
533 * kvprintf("reg=%b\n", 3, "\10\2BITTWO\1BITONE\n");
535 * would produce output:
537 * reg=3<BITTWO,BITONE>
539 * XXX: %D -- Hexdump, takes pointer and separator string:
540 * ("%6D", ptr, ":") -> XX:XX:XX:XX:XX:XX
541 * ("%*D", len, ptr, " " -> XX XX XX XX ...
544 kvprintf(char const *fmt, void (*func)(int, void*), void *arg, int radix, va_list ap)
546 #define PCHAR(c) {int cc=(c); if (func) (*func)(cc,arg); else *d++ = cc; retval++; }
549 const char *p, *percent, *q;
553 int base, lflag, qflag, tmp, width, ladjust, sharpflag, neg, sign, dot;
554 int cflag, hflag, jflag, tflag, zflag;
557 int stop = 0, retval = 0;
566 fmt = "(fmt null)\n";
568 if (radix < 2 || radix > 36)
574 while ((ch = (u_char)*fmt++) != '%' || stop) {
580 qflag = 0; lflag = 0; ladjust = 0; sharpflag = 0; neg = 0;
581 sign = 0; dot = 0; dwidth = 0; upper = 0;
582 cflag = 0; hflag = 0; jflag = 0; tflag = 0; zflag = 0;
583 reswitch: switch (ch = (u_char)*fmt++) {
601 width = va_arg(ap, int);
607 dwidth = va_arg(ap, int);
615 case '1': case '2': case '3': case '4':
616 case '5': case '6': case '7': case '8': case '9':
617 for (n = 0;; ++fmt) {
618 n = n * 10 + ch - '0';
620 if (ch < '0' || ch > '9')
629 num = (u_int)va_arg(ap, int);
630 p = va_arg(ap, char *);
631 for (q = ksprintn(nbuf, num, *p++, NULL, 0); *q;)
639 if (num & (1 << (n - 1))) {
640 PCHAR(tmp ? ',' : '<');
641 for (; (n = *p) > ' '; ++p)
645 for (; *p > ' '; ++p)
652 PCHAR(va_arg(ap, int));
655 up = va_arg(ap, u_char *);
656 p = va_arg(ap, char *);
660 PCHAR(hex2ascii(*up >> 4));
661 PCHAR(hex2ascii(*up & 0x0f));
692 *(va_arg(ap, intmax_t *)) = retval;
694 *(va_arg(ap, quad_t *)) = retval;
696 *(va_arg(ap, long *)) = retval;
698 *(va_arg(ap, size_t *)) = retval;
700 *(va_arg(ap, short *)) = retval;
702 *(va_arg(ap, char *)) = retval;
704 *(va_arg(ap, int *)) = retval;
711 sharpflag = (width == 0);
713 num = (uintptr_t)va_arg(ap, void *);
724 p = va_arg(ap, char *);
730 for (n = 0; n < dwidth && p[n]; n++)
735 if (!ladjust && width > 0)
740 if (ladjust && width > 0)
765 num = va_arg(ap, uintmax_t);
767 num = va_arg(ap, u_quad_t);
769 num = va_arg(ap, ptrdiff_t);
771 num = va_arg(ap, u_long);
773 num = va_arg(ap, size_t);
775 num = (u_short)va_arg(ap, int);
777 num = (u_char)va_arg(ap, int);
779 num = va_arg(ap, u_int);
783 num = va_arg(ap, intmax_t);
785 num = va_arg(ap, quad_t);
787 num = va_arg(ap, ptrdiff_t);
789 num = va_arg(ap, long);
791 num = va_arg(ap, ssize_t);
793 num = (short)va_arg(ap, int);
795 num = (char)va_arg(ap, int);
797 num = va_arg(ap, int);
799 if (sign && (intmax_t)num < 0) {
801 num = -(intmax_t)num;
803 p = ksprintn(nbuf, num, base, &tmp, upper);
804 if (sharpflag && num != 0) {
813 if (!ladjust && padc != '0' && width
814 && (width -= tmp) > 0)
819 if (sharpflag && num != 0) {
822 } else if (base == 16) {
827 if (!ladjust && width && (width -= tmp) > 0)
834 if (ladjust && width && (width -= tmp) > 0)
840 while (percent < fmt)
843 * Since we ignore an formatting argument it is no
844 * longer safe to obey the remaining formatting
845 * arguments as the arguments will no longer match
856 * Put character in log buffer with a particular priority.
859 msglogchar(int c, int pri)
861 static int lastpri = -1;
868 if (c == '\0' || c == '\r')
870 if (pri != -1 && pri != lastpri) {
872 msgbuf_addchar(msgbufp, '\n');
875 msgbuf_addchar(msgbufp, '<');
876 for (p = ksprintn(nbuf, (uintmax_t)pri, 10, NULL, 0); *p;)
877 msgbuf_addchar(msgbufp, *p--);
878 msgbuf_addchar(msgbufp, '>');
881 msgbuf_addchar(msgbufp, c);
891 msgbufinit(void *ptr, int size)
894 static struct msgbuf *oldp = NULL;
896 size -= sizeof(*msgbufp);
898 msgbufp = (struct msgbuf *)(cp + size);
899 msgbuf_reinit(msgbufp, cp, size);
900 if (msgbufmapped && oldp != msgbufp)
901 msgbuf_copy(oldp, msgbufp);
906 static int unprivileged_read_msgbuf = 1;
907 SYSCTL_INT(_security_bsd, OID_AUTO, unprivileged_read_msgbuf,
908 CTLFLAG_RW, &unprivileged_read_msgbuf, 0,
909 "Unprivileged processes may read the kernel message buffer");
911 /* Sysctls for accessing/clearing the msgbuf */
913 sysctl_kern_msgbuf(SYSCTL_HANDLER_ARGS)
919 if (!unprivileged_read_msgbuf) {
920 error = priv_check(req->td, PRIV_MSGBUF);
925 /* Read the whole buffer, one chunk at a time. */
926 mtx_lock(&msgbuf_lock);
927 msgbuf_peekbytes(msgbufp, NULL, 0, &seq);
929 len = msgbuf_peekbytes(msgbufp, buf, sizeof(buf), &seq);
930 mtx_unlock(&msgbuf_lock);
934 error = sysctl_handle_opaque(oidp, buf, len, req);
938 mtx_lock(&msgbuf_lock);
942 SYSCTL_PROC(_kern, OID_AUTO, msgbuf,
943 CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_MPSAFE,
944 NULL, 0, sysctl_kern_msgbuf, "A", "Contents of kernel message buffer");
946 static int msgbuf_clearflag;
949 sysctl_kern_msgbuf_clear(SYSCTL_HANDLER_ARGS)
952 error = sysctl_handle_int(oidp, oidp->oid_arg1, oidp->oid_arg2, req);
953 if (!error && req->newptr) {
954 mtx_lock(&msgbuf_lock);
955 msgbuf_clear(msgbufp);
956 mtx_unlock(&msgbuf_lock);
957 msgbuf_clearflag = 0;
962 SYSCTL_PROC(_kern, OID_AUTO, msgbuf_clear,
963 CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_SECURE | CTLFLAG_MPSAFE,
964 &msgbuf_clearflag, 0, sysctl_kern_msgbuf_clear, "I",
965 "Clear kernel message buffer");
969 DB_SHOW_COMMAND(msgbuf, db_show_msgbuf)
974 db_printf("msgbuf not mapped yet\n");
977 db_printf("msgbufp = %p\n", msgbufp);
978 db_printf("magic = %x, size = %d, r= %u, w = %u, ptr = %p, cksum= %u\n",
979 msgbufp->msg_magic, msgbufp->msg_size, msgbufp->msg_rseq,
980 msgbufp->msg_wseq, msgbufp->msg_ptr, msgbufp->msg_cksum);
981 for (i = 0; i < msgbufp->msg_size && !db_pager_quit; i++) {
982 j = MSGBUF_SEQ_TO_POS(msgbufp, i + msgbufp->msg_rseq);
983 db_printf("%c", msgbufp->msg_ptr[j]);
991 hexdump(const void *ptr, int length, const char *hdr, int flags)
995 const unsigned char *cp;
998 if ((flags & HD_DELIM_MASK) != 0)
999 delim = (flags & HD_DELIM_MASK) >> 8;
1003 if ((flags & HD_COLUMN_MASK) != 0)
1004 cols = flags & HD_COLUMN_MASK;
1009 for (i = 0; i < length; i+= cols) {
1013 if ((flags & HD_OMIT_COUNT) == 0)
1016 if ((flags & HD_OMIT_HEX) == 0) {
1017 for (j = 0; j < cols; j++) {
1020 printf("%c%02x", delim, cp[k]);
1026 if ((flags & HD_OMIT_CHARS) == 0) {
1028 for (j = 0; j < cols; j++) {
1032 else if (cp[k] >= ' ' && cp[k] <= '~')
1033 printf("%c", cp[k]);