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, ...)
130 struct thread *td = curthread;
131 struct proc *p = td->td_proc;
133 struct putchar_arg pca;
136 if (td == NULL || TD_IS_IDLETHREAD(td))
139 sx_slock(&proctree_lock);
142 if ((p->p_flag & P_CONTROLT) == 0) {
147 SESS_LOCK(p->p_session);
148 pca.tty = p->p_session->s_ttyp;
149 SESS_UNLOCK(p->p_session);
151 if (pca.tty == NULL) {
158 retval = kvprintf(fmt, putchar, &pca, 10, ap);
162 sx_sunlock(&proctree_lock);
167 * tprintf prints on the controlling terminal associated with the given
168 * session, possibly to the log as well.
171 tprintf(struct proc *p, int pri, const char *fmt, ...)
173 struct tty *tp = NULL;
176 struct putchar_arg pca;
177 struct session *sess = NULL;
179 sx_slock(&proctree_lock);
184 if (p->p_flag & P_CONTROLT && p->p_session->s_ttyvp) {
189 if (tp != NULL && tty_checkoutq(tp))
202 kvprintf(fmt, putchar, &pca, 10, ap);
209 sx_sunlock(&proctree_lock);
213 * Ttyprintf displays a message on a tty; it should be used only by
214 * the tty driver, or anything that knows the underlying tty will not
215 * be revoke(2)'d away. Other callers should use tprintf.
218 ttyprintf(struct tty *tp, const char *fmt, ...)
221 struct putchar_arg pca;
227 retval = kvprintf(fmt, putchar, &pca, 10, ap);
233 * Log writes to the log buffer, and guarantees not to sleep (so can be
234 * called by interrupt routines). If there is no process reading the
235 * log yet, it writes to the console also.
238 log(int level, const char *fmt, ...)
241 struct putchar_arg pca;
245 pca.flags = log_open ? TOLOG : TOCONS;
249 kvprintf(fmt, putchar, &pca, 10, ap);
255 #define CONSCHUNK 128
258 log_console(struct uio *uio)
264 if (!log_console_output)
267 pri = LOG_INFO | LOG_CONSOLE;
269 consbuffer = malloc(CONSCHUNK, M_TEMP, M_WAITOK);
272 while (uio->uio_resid > 0) {
273 c = imin(uio->uio_resid, CONSCHUNK);
274 error = uiomove(consbuffer, c, uio);
277 for (i = 0; i < c; i++) {
278 msglogchar(consbuffer[i], pri);
279 if (consbuffer[i] == '\n')
286 msglogchar('\n', pri);
289 free(consbuffer, M_TEMP);
294 printf(const char *fmt, ...)
297 struct putchar_arg pca;
299 #ifdef PRINTF_BUFR_SIZE
300 char bufr[PRINTF_BUFR_SIZE];
305 pca.flags = TOCONS | TOLOG;
307 #ifdef PRINTF_BUFR_SIZE
309 pca.p_next = pca.p_bufr;
310 pca.n_bufr = sizeof(bufr);
311 pca.remain = sizeof(bufr);
314 /* Don't buffer console output. */
318 retval = kvprintf(fmt, putchar, &pca, 10, ap);
321 #ifdef PRINTF_BUFR_SIZE
322 /* Write any buffered console output: */
323 if (*pca.p_bufr != '\0')
334 vprintf(const char *fmt, va_list ap)
336 struct putchar_arg pca;
338 #ifdef PRINTF_BUFR_SIZE
339 char bufr[PRINTF_BUFR_SIZE];
343 pca.flags = TOCONS | TOLOG;
345 #ifdef PRINTF_BUFR_SIZE
347 pca.p_next = pca.p_bufr;
348 pca.n_bufr = sizeof(bufr);
349 pca.remain = sizeof(bufr);
352 /* Don't buffer console output. */
356 retval = kvprintf(fmt, putchar, &pca, 10, ap);
358 #ifdef PRINTF_BUFR_SIZE
359 /* Write any buffered console output: */
360 if (*pca.p_bufr != '\0')
371 putcons(int c, struct putchar_arg *ap)
373 /* Check if no console output buffer was provided. */
374 if (ap->p_bufr == NULL)
375 /* Output direct to the console. */
378 /* Buffer the character: */
380 *ap->p_next++ = '\r';
386 /* Always leave the buffer zero terminated. */
389 /* Check if the buffer needs to be flushed. */
390 if (ap->remain < 3 || c == '\n') {
392 ap->p_next = ap->p_bufr;
393 ap->remain = ap->n_bufr;
400 * Print a character on console or users terminal. If destination is
401 * the console then the last bunch of characters are saved in msgbuf for
405 putchar(int c, void *arg)
407 struct putchar_arg *ap = (struct putchar_arg*) arg;
408 struct tty *tp = ap->tty;
409 int flags = ap->flags;
411 /* Don't use the tty code after a panic or while in ddb. */
415 } else if (panicstr || ((flags & TOCONS) && constty == NULL)) {
419 if ((flags & TOTTY) && tp != NULL)
421 if (flags & TOCONS) {
423 msgbuf_addchar(&consmsgbuf, c);
424 if (always_console_output && c != '\0')
429 msglogchar(c, ap->pri);
433 * Scaled down version of sprintf(3).
436 sprintf(char *buf, const char *cfmt, ...)
442 retval = kvprintf(cfmt, NULL, (void *)buf, 10, ap);
449 * Scaled down version of vsprintf(3).
452 vsprintf(char *buf, const char *cfmt, va_list ap)
456 retval = kvprintf(cfmt, NULL, (void *)buf, 10, ap);
462 * Scaled down version of snprintf(3).
465 snprintf(char *str, size_t size, const char *format, ...)
470 va_start(ap, format);
471 retval = vsnprintf(str, size, format, ap);
477 * Scaled down version of vsnprintf(3).
480 vsnprintf(char *str, size_t size, const char *format, va_list ap)
482 struct snprintf_arg info;
487 retval = kvprintf(format, snprintf_func, &info, 10, ap);
488 if (info.remain >= 1)
494 * Kernel version which takes radix argument vsnprintf(3).
497 vsnrprintf(char *str, size_t size, int radix, const char *format, va_list ap)
499 struct snprintf_arg info;
504 retval = kvprintf(format, snprintf_func, &info, radix, ap);
505 if (info.remain >= 1)
511 snprintf_func(int ch, void *arg)
513 struct snprintf_arg *const info = arg;
515 if (info->remain >= 2) {
522 * Put a NUL-terminated ASCII number (base <= 36) in a buffer in reverse
523 * order; return an optional length and a pointer to the last character
524 * written in the buffer (i.e., the first character of the string).
525 * The buffer pointed to by `nbuf' must have length >= MAXNBUF.
528 ksprintn(char *nbuf, uintmax_t num, int base, int *lenp, int upper)
535 c = hex2ascii(num % base);
536 *++p = upper ? toupper(c) : c;
537 } while (num /= base);
544 * Scaled down version of printf(3).
546 * Two additional formats:
548 * The format %b is supported to decode error registers.
551 * printf("reg=%b\n", regval, "<base><arg>*");
553 * where <base> is the output base expressed as a control character, e.g.
554 * \10 gives octal; \20 gives hex. Each arg is a sequence of characters,
555 * the first of which gives the bit number to be inspected (origin 1), and
556 * the next characters (up to a control character, i.e. a character <= 32),
557 * give the name of the register. Thus:
559 * kvprintf("reg=%b\n", 3, "\10\2BITTWO\1BITONE\n");
561 * would produce output:
563 * reg=3<BITTWO,BITONE>
565 * XXX: %D -- Hexdump, takes pointer and separator string:
566 * ("%6D", ptr, ":") -> XX:XX:XX:XX:XX:XX
567 * ("%*D", len, ptr, " " -> XX XX XX XX ...
570 kvprintf(char const *fmt, void (*func)(int, void*), void *arg, int radix, va_list ap)
572 #define PCHAR(c) {int cc=(c); if (func) (*func)(cc,arg); else *d++ = cc; retval++; }
575 const char *p, *percent, *q;
579 int base, lflag, qflag, tmp, width, ladjust, sharpflag, neg, sign, dot;
580 int cflag, hflag, jflag, tflag, zflag;
583 int stop = 0, retval = 0;
592 fmt = "(fmt null)\n";
594 if (radix < 2 || radix > 36)
600 while ((ch = (u_char)*fmt++) != '%' || stop) {
606 qflag = 0; lflag = 0; ladjust = 0; sharpflag = 0; neg = 0;
607 sign = 0; dot = 0; dwidth = 0; upper = 0;
608 cflag = 0; hflag = 0; jflag = 0; tflag = 0; zflag = 0;
609 reswitch: switch (ch = (u_char)*fmt++) {
627 width = va_arg(ap, int);
633 dwidth = va_arg(ap, int);
641 case '1': case '2': case '3': case '4':
642 case '5': case '6': case '7': case '8': case '9':
643 for (n = 0;; ++fmt) {
644 n = n * 10 + ch - '0';
646 if (ch < '0' || ch > '9')
655 num = (u_int)va_arg(ap, int);
656 p = va_arg(ap, char *);
657 for (q = ksprintn(nbuf, num, *p++, NULL, 0); *q;)
665 if (num & (1 << (n - 1))) {
666 PCHAR(tmp ? ',' : '<');
667 for (; (n = *p) > ' '; ++p)
671 for (; *p > ' '; ++p)
678 PCHAR(va_arg(ap, int));
681 up = va_arg(ap, u_char *);
682 p = va_arg(ap, char *);
686 PCHAR(hex2ascii(*up >> 4));
687 PCHAR(hex2ascii(*up & 0x0f));
718 *(va_arg(ap, intmax_t *)) = retval;
720 *(va_arg(ap, quad_t *)) = retval;
722 *(va_arg(ap, long *)) = retval;
724 *(va_arg(ap, size_t *)) = retval;
726 *(va_arg(ap, short *)) = retval;
728 *(va_arg(ap, char *)) = retval;
730 *(va_arg(ap, int *)) = retval;
737 sharpflag = (width == 0);
739 num = (uintptr_t)va_arg(ap, void *);
750 p = va_arg(ap, char *);
756 for (n = 0; n < dwidth && p[n]; n++)
761 if (!ladjust && width > 0)
766 if (ladjust && width > 0)
791 num = va_arg(ap, uintmax_t);
793 num = va_arg(ap, u_quad_t);
795 num = va_arg(ap, ptrdiff_t);
797 num = va_arg(ap, u_long);
799 num = va_arg(ap, size_t);
801 num = (u_short)va_arg(ap, int);
803 num = (u_char)va_arg(ap, int);
805 num = va_arg(ap, u_int);
809 num = va_arg(ap, intmax_t);
811 num = va_arg(ap, quad_t);
813 num = va_arg(ap, ptrdiff_t);
815 num = va_arg(ap, long);
817 num = va_arg(ap, size_t);
819 num = (short)va_arg(ap, int);
821 num = (char)va_arg(ap, int);
823 num = va_arg(ap, int);
825 if (sign && (intmax_t)num < 0) {
827 num = -(intmax_t)num;
829 p = ksprintn(nbuf, num, base, &tmp, upper);
830 if (sharpflag && num != 0) {
839 if (!ladjust && padc != '0' && width
840 && (width -= tmp) > 0)
845 if (sharpflag && num != 0) {
848 } else if (base == 16) {
853 if (!ladjust && width && (width -= tmp) > 0)
860 if (ladjust && width && (width -= tmp) > 0)
866 while (percent < fmt)
869 * Since we ignore an formatting argument it is no
870 * longer safe to obey the remaining formatting
871 * arguments as the arguments will no longer match
882 * Put character in log buffer with a particular priority.
885 msglogchar(int c, int pri)
887 static int lastpri = -1;
894 if (c == '\0' || c == '\r')
896 if (pri != -1 && pri != lastpri) {
898 msgbuf_addchar(msgbufp, '\n');
901 msgbuf_addchar(msgbufp, '<');
902 for (p = ksprintn(nbuf, (uintmax_t)pri, 10, NULL, 0); *p;)
903 msgbuf_addchar(msgbufp, *p--);
904 msgbuf_addchar(msgbufp, '>');
907 msgbuf_addchar(msgbufp, c);
917 msgbufinit(void *ptr, int size)
920 static struct msgbuf *oldp = NULL;
922 size -= sizeof(*msgbufp);
924 msgbufp = (struct msgbuf *)(cp + size);
925 msgbuf_reinit(msgbufp, cp, size);
926 if (msgbufmapped && oldp != msgbufp)
927 msgbuf_copy(oldp, msgbufp);
932 static int unprivileged_read_msgbuf = 1;
933 SYSCTL_INT(_security_bsd, OID_AUTO, unprivileged_read_msgbuf,
934 CTLFLAG_RW, &unprivileged_read_msgbuf, 0,
935 "Unprivileged processes may read the kernel message buffer");
937 /* Sysctls for accessing/clearing the msgbuf */
939 sysctl_kern_msgbuf(SYSCTL_HANDLER_ARGS)
945 if (!unprivileged_read_msgbuf) {
946 error = priv_check(req->td, PRIV_MSGBUF);
951 /* Read the whole buffer, one chunk at a time. */
952 msgbuf_peekbytes(msgbufp, NULL, 0, &seq);
953 while ((len = msgbuf_peekbytes(msgbufp, buf, sizeof(buf), &seq)) > 0) {
954 error = sysctl_handle_opaque(oidp, buf, len, req);
961 SYSCTL_PROC(_kern, OID_AUTO, msgbuf, CTLTYPE_STRING | CTLFLAG_RD,
962 0, 0, sysctl_kern_msgbuf, "A", "Contents of kernel message buffer");
964 static int msgbuf_clearflag;
967 sysctl_kern_msgbuf_clear(SYSCTL_HANDLER_ARGS)
970 error = sysctl_handle_int(oidp, oidp->oid_arg1, oidp->oid_arg2, req);
971 if (!error && req->newptr) {
972 msgbuf_clear(msgbufp);
973 msgbuf_clearflag = 0;
978 SYSCTL_PROC(_kern, OID_AUTO, msgbuf_clear,
979 CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_SECURE, &msgbuf_clearflag, 0,
980 sysctl_kern_msgbuf_clear, "I", "Clear kernel message buffer");
984 DB_SHOW_COMMAND(msgbuf, db_show_msgbuf)
989 db_printf("msgbuf not mapped yet\n");
992 db_printf("msgbufp = %p\n", msgbufp);
993 db_printf("magic = %x, size = %d, r= %u, w = %u, ptr = %p, cksum= %u\n",
994 msgbufp->msg_magic, msgbufp->msg_size, msgbufp->msg_rseq,
995 msgbufp->msg_wseq, msgbufp->msg_ptr, msgbufp->msg_cksum);
996 for (i = 0; i < msgbufp->msg_size && !db_pager_quit; i++) {
997 j = MSGBUF_SEQ_TO_POS(msgbufp, i + msgbufp->msg_rseq);
998 db_printf("%c", msgbufp->msg_ptr[j]);
1006 hexdump(const void *ptr, int length, const char *hdr, int flags)
1010 const unsigned char *cp;
1013 if ((flags & HD_DELIM_MASK) != 0)
1014 delim = (flags & HD_DELIM_MASK) >> 8;
1018 if ((flags & HD_COLUMN_MASK) != 0)
1019 cols = flags & HD_COLUMN_MASK;
1024 for (i = 0; i < length; i+= cols) {
1028 if ((flags & HD_OMIT_COUNT) == 0)
1031 if ((flags & HD_OMIT_HEX) == 0) {
1032 for (j = 0; j < cols; j++) {
1035 printf("%c%02x", delim, cp[k]);
1041 if ((flags & HD_OMIT_CHARS) == 0) {
1043 for (j = 0; j < cols; j++) {
1047 else if (cp[k] >= ' ' && cp[k] <= '~')
1048 printf("%c", cp[k]);