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. All advertising materials mentioning features or use of this software
19 * must display the following acknowledgement:
20 * This product includes software developed by the University of
21 * California, Berkeley and its contributors.
22 * 4. Neither the name of the University nor the names of its contributors
23 * may be used to endorse or promote products derived from this software
24 * without specific prior written permission.
26 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
27 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
30 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
31 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
32 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
35 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
38 * @(#)subr_prf.c 8.3 (Berkeley) 1/21/94
39 * $FreeBSD: src/sys/kern/subr_prf.c,v 1.61.2.5 2002/08/31 18:22:08 dwmalone Exp $
40 * $DragonFly: src/sys/kern/subr_prf.c,v 1.8 2004/09/13 16:22:36 dillon Exp $
43 #include <sys/param.h>
44 #include <sys/systm.h>
45 #include <sys/kernel.h>
46 #include <sys/msgbuf.h>
47 #include <sys/malloc.h>
50 #include <sys/tprintf.h>
51 #include <sys/syslog.h>
54 #include <sys/sysctl.h>
58 * Note that stdarg.h and the ANSI style va_start macro is used for both
59 * ANSI and traditional C compilers. We use the __ machine version to stay
60 * within the kernel header file set.
62 #include <machine/stdarg.h>
68 /* Max number conversion buffer length: a u_quad_t in base 2, plus NUL byte. */
69 #define MAXNBUF (sizeof(quad_t) * NBBY + 1)
84 struct tty *constty; /* pointer to console "window" tty */
86 static void (*v_putc)(int) = cnputc; /* routine to putc on virtual console */
87 static void msglogchar(int c, int pri);
88 static void msgaddchar(int c, void *dummy);
89 static void putchar (int ch, void *arg);
90 static char *ksprintn (char *nbuf, u_long num, int base, int *len);
91 static char *ksprintqn (char *nbuf, u_quad_t num, int base, int *len);
92 static void snprintf_func (int ch, void *arg);
94 static int consintr = 1; /* Ok to handle console interrupts? */
95 static int msgbufmapped; /* Set when safe to use msgbuf */
98 static int log_console_output = 1;
99 TUNABLE_INT("kern.log_console_output", &log_console_output);
100 SYSCTL_INT(_kern, OID_AUTO, log_console_output, CTLFLAG_RW,
101 &log_console_output, 0, "");
104 * Warn that a system table is full.
107 tablefull(const char *tab)
110 log(LOG_ERR, "%s: table is full\n", tab);
114 * Uprintf prints to the controlling terminal for the current process.
115 * It may block if the tty queue is overfull. No message is printed if
116 * the queue does not clear in a reasonable time.
119 uprintf(const char *fmt, ...)
121 struct proc *p = curproc;
123 struct putchar_arg pca;
126 if (p && p->p_flag & P_CONTROLT &&
127 p->p_session->s_ttyvp) {
129 pca.tty = p->p_session->s_ttyp;
132 retval = kvprintf(fmt, putchar, &pca, 10, ap);
139 tprintf_open(struct proc *p)
142 if ((p->p_flag & P_CONTROLT) && p->p_session->s_ttyvp) {
143 sess_hold(p->p_session);
144 return ((tpr_t) p->p_session);
146 return ((tpr_t) NULL);
150 tprintf_close(tpr_t sess)
153 sess_rele((struct session *) sess);
157 * tprintf prints on the controlling terminal associated
158 * with the given session.
161 tprintf(tpr_t tpr, const char *fmt, ...)
163 struct session *sess = (struct session *)tpr;
164 struct tty *tp = NULL;
167 struct putchar_arg pca;
170 if (sess && sess->s_ttyvp && ttycheckoutq(sess->s_ttyp, 0)) {
178 retval = kvprintf(fmt, putchar, &pca, 10, ap);
185 * Ttyprintf displays a message on a tty; it should be used only by
186 * the tty driver, or anything that knows the underlying tty will not
187 * be revoke(2)'d away. Other callers should use tprintf.
190 ttyprintf(struct tty *tp, const char *fmt, ...)
193 struct putchar_arg pca;
199 retval = kvprintf(fmt, putchar, &pca, 10, ap);
205 * Log writes to the log buffer, and guarantees not to sleep (so can be
206 * called by interrupt routines). If there is no process reading the
207 * log yet, it writes to the console also.
210 log(int level, const char *fmt, ...)
214 struct putchar_arg pca;
218 pca.flags = log_open ? TOLOG : TOCONS;
221 retval = kvprintf(fmt, putchar, &pca, 10, ap);
229 addlog(const char *fmt, ...)
233 struct putchar_arg pca;
237 pca.flags = log_open ? TOLOG : TOCONS;
240 retval = kvprintf(fmt, putchar, &pca, 10, ap);
247 #define CONSCHUNK 128
250 log_console(struct uio *uio)
252 int c, i, error, iovlen, nl;
254 struct iovec *miov = NULL;
258 if (!log_console_output)
261 pri = LOG_INFO | LOG_CONSOLE;
263 iovlen = uio->uio_iovcnt * sizeof (struct iovec);
264 MALLOC(miov, struct iovec *, iovlen, M_TEMP, M_WAITOK);
265 MALLOC(consbuffer, char *, CONSCHUNK, M_TEMP, M_WAITOK);
266 bcopy((caddr_t)muio.uio_iov, (caddr_t)miov, iovlen);
271 while (uio->uio_resid > 0) {
272 c = imin(uio->uio_resid, CONSCHUNK);
273 error = uiomove(consbuffer, c, uio);
276 for (i = 0; i < c; i++) {
277 msglogchar(consbuffer[i], pri);
278 if (consbuffer[i] == '\n')
285 msglogchar('\n', pri);
288 FREE(consbuffer, M_TEMP);
293 printf(const char *fmt, ...)
297 struct putchar_arg pca;
300 savintr = consintr; /* disable interrupts */
304 pca.flags = TOCONS | TOLOG;
307 retval = kvprintf(fmt, putchar, &pca, 10, ap);
312 consintr = savintr; /* reenable interrupts */
317 vprintf(const char *fmt, __va_list ap)
320 struct putchar_arg pca;
323 savintr = consintr; /* disable interrupts */
326 pca.flags = TOCONS | TOLOG;
329 retval = kvprintf(fmt, putchar, &pca, 10, ap);
333 consintr = savintr; /* reenable interrupts */
338 * Print a character on console or users terminal. If destination is
339 * the console then the last bunch of characters are saved in msgbuf for
343 putchar(int c, void *arg)
345 struct putchar_arg *ap = (struct putchar_arg*) arg;
346 int flags = ap->flags;
347 struct tty *tp = ap->tty;
350 if ((flags & TOCONS) && tp == NULL && constty) {
354 if ((flags & TOTTY) && tp && tputchar(c, tp) < 0 &&
355 (flags & TOCONS) && tp == constty)
358 msglogchar(c, ap->pri);
359 if ((flags & TOCONS) && constty == NULL && c != '\0')
364 * Scaled down version of sprintf(3).
367 sprintf(char *buf, const char *cfmt, ...)
372 __va_start(ap, cfmt);
373 retval = kvprintf(cfmt, NULL, (void *)buf, 10, ap);
380 * Scaled down version of vsprintf(3).
383 vsprintf(char *buf, const char *cfmt, __va_list ap)
387 retval = kvprintf(cfmt, NULL, (void *)buf, 10, ap);
393 * Scaled down version of snprintf(3).
396 snprintf(char *str, size_t size, const char *format, ...)
401 __va_start(ap, format);
402 retval = vsnprintf(str, size, format, ap);
408 * Scaled down version of vsnprintf(3).
411 vsnprintf(char *str, size_t size, const char *format, __va_list ap)
413 struct snprintf_arg info;
418 retval = kvprintf(format, snprintf_func, &info, 10, ap);
419 if (info.remain >= 1)
425 snprintf_func(int ch, void *arg)
427 struct snprintf_arg *const info = arg;
429 if (info->remain >= 2) {
436 * Put a NUL-terminated ASCII number (base <= 36) in a buffer in reverse
437 * order; return an optional length and a pointer to the last character
438 * written in the buffer (i.e., the first character of the string).
439 * The buffer pointed to by `nbuf' must have length >= MAXNBUF.
442 ksprintn(nbuf, ul, base, lenp)
452 *++p = hex2ascii(ul % base);
453 } while (ul /= base);
458 /* ksprintn, but for a quad_t. */
460 ksprintqn(nbuf, uq, base, lenp)
470 *++p = hex2ascii(uq % base);
471 } while (uq /= base);
478 * Scaled down version of printf(3).
480 * Two additional formats:
482 * The format %b is supported to decode error registers.
485 * printf("reg=%b\n", regval, "<base><arg>*");
487 * where <base> is the output base expressed as a control character, e.g.
488 * \10 gives octal; \20 gives hex. Each arg is a sequence of characters,
489 * the first of which gives the bit number to be inspected (origin 1), and
490 * the next characters (up to a control character, i.e. a character <= 32),
491 * give the name of the register. Thus:
493 * kvprintf("reg=%b\n", 3, "\10\2BITTWO\1BITONE\n");
495 * would produce output:
497 * reg=3<BITTWO,BITONE>
499 * XXX: %D -- Hexdump, takes pointer and separator string:
500 * ("%6D", ptr, ":") -> XX:XX:XX:XX:XX:XX
501 * ("%*D", len, ptr, " " -> XX XX XX XX ...
504 kvprintf(char const *fmt, void (*func)(int, void*), void *arg, int radix, __va_list ap)
506 #define PCHAR(c) {int cc=(c); if (func) (*func)(cc,arg); else *d++ = cc; retval++; }
513 int base, lflag, qflag, tmp, width, ladjust, sharpflag, neg, sign, dot;
526 fmt = "(fmt null)\n";
528 if (radix < 2 || radix > 36)
534 while ((ch = (u_char)*fmt++) != '%') {
539 qflag = 0; lflag = 0; ladjust = 0; sharpflag = 0; neg = 0;
540 sign = 0; dot = 0; dwidth = 0;
541 reswitch: switch (ch = (u_char)*fmt++) {
559 width = __va_arg(ap, int);
565 dwidth = __va_arg(ap, int);
573 case '1': case '2': case '3': case '4':
574 case '5': case '6': case '7': case '8': case '9':
575 for (n = 0;; ++fmt) {
576 n = n * 10 + ch - '0';
578 if (ch < '0' || ch > '9')
587 ul = __va_arg(ap, int);
588 p = __va_arg(ap, char *);
589 for (q = ksprintn(nbuf, ul, *p++, NULL); *q;)
597 if (ul & (1 << (n - 1))) {
598 PCHAR(tmp ? ',' : '<');
599 for (; (n = *p) > ' '; ++p)
603 for (; *p > ' '; ++p)
610 PCHAR(__va_arg(ap, int));
613 up = __va_arg(ap, u_char *);
614 p = __va_arg(ap, char *);
618 PCHAR(hex2ascii(*up >> 4));
619 PCHAR(hex2ascii(*up & 0x0f));
628 uq = __va_arg(ap, quad_t);
630 ul = __va_arg(ap, long);
632 ul = __va_arg(ap, int);
645 uq = __va_arg(ap, u_quad_t);
647 ul = __va_arg(ap, u_long);
649 ul = __va_arg(ap, u_int);
653 ul = (uintptr_t)__va_arg(ap, void *);
655 sharpflag = (width == 0);
663 uq = __va_arg(ap, u_quad_t);
665 ul = __va_arg(ap, u_long);
668 (u_long)__va_arg(ap, int) : __va_arg(ap, u_int);
672 p = __va_arg(ap, char *);
678 for (n = 0; n < dwidth && p[n]; n++)
683 if (!ladjust && width > 0)
688 if (ladjust && width > 0)
694 uq = __va_arg(ap, u_quad_t);
696 ul = __va_arg(ap, u_long);
698 ul = __va_arg(ap, u_int);
704 uq = __va_arg(ap, u_quad_t);
706 ul = __va_arg(ap, u_long);
708 ul = __va_arg(ap, u_int);
713 uq = __va_arg(ap, u_quad_t);
715 ul = __va_arg(ap, u_long);
718 (u_long)__va_arg(ap, int) : __va_arg(ap, u_int);
724 if (sign && (quad_t)uq < 0) {
728 p = ksprintqn(nbuf, uq, base, &tmp);
730 if (sign && (long)ul < 0) {
734 p = ksprintn(nbuf, ul, base, &tmp);
736 if (sharpflag && (qflag ? uq != 0 : ul != 0)) {
745 if (!ladjust && width && (width -= tmp) > 0)
750 if (sharpflag && (qflag ? uq != 0 : ul != 0)) {
753 } else if (base == 16) {
762 if (ladjust && width && (width -= tmp) > 0)
779 * Put character in log buffer with a particular priority.
782 msglogchar(int c, int pri)
784 static int lastpri = -1;
791 if (c == '\0' || c == '\r')
793 if (pri != -1 && pri != lastpri) {
795 msgaddchar('\n', NULL);
798 msgaddchar('<', NULL);
799 for (p = ksprintn(nbuf, (u_long)pri, 10, NULL); *p;)
800 msgaddchar(*p--, NULL);
801 msgaddchar('>', NULL);
814 * Put char in log buffer
817 msgaddchar(int c, void *dummy)
824 mbp->msg_ptr[mbp->msg_bufx++] = c;
825 if (mbp->msg_bufx >= mbp->msg_size)
827 /* If the buffer is full, keep the most recent data. */
828 if (mbp->msg_bufr == mbp->msg_bufx) {
829 if (++mbp->msg_bufr >= mbp->msg_size)
835 msgbufcopy(struct msgbuf *oldp)
839 pos = oldp->msg_bufr;
840 while (pos != oldp->msg_bufx) {
841 msglogchar(oldp->msg_ptr[pos], -1);
842 if (++pos >= oldp->msg_size)
848 msgbufinit(void *ptr, size_t size)
851 static struct msgbuf *oldp = NULL;
853 size -= sizeof(*msgbufp);
855 msgbufp = (struct msgbuf *) (cp + size);
856 if (msgbufp->msg_magic != MSG_MAGIC || msgbufp->msg_size != size ||
857 msgbufp->msg_bufx >= size || msgbufp->msg_bufr >= size) {
859 bzero(msgbufp, sizeof(*msgbufp));
860 msgbufp->msg_magic = MSG_MAGIC;
861 msgbufp->msg_size = (char *)msgbufp - cp;
863 msgbufp->msg_ptr = cp;
864 if (msgbufmapped && oldp != msgbufp)
870 /* Sysctls for accessing/clearing the msgbuf */
872 sysctl_kern_msgbuf(SYSCTL_HANDLER_ARGS)
877 * Unwind the buffer, so that it's linear (possibly starting with
878 * some initial nulls).
880 error = sysctl_handle_opaque(oidp, msgbufp->msg_ptr + msgbufp->msg_bufx,
881 msgbufp->msg_size - msgbufp->msg_bufx, req);
884 if (msgbufp->msg_bufx > 0) {
885 error = sysctl_handle_opaque(oidp, msgbufp->msg_ptr,
886 msgbufp->msg_bufx, req);
891 SYSCTL_PROC(_kern, OID_AUTO, msgbuf, CTLTYPE_STRING | CTLFLAG_RD,
892 0, 0, sysctl_kern_msgbuf, "A", "Contents of kernel message buffer");
894 static int msgbuf_clear;
897 sysctl_kern_msgbuf_clear(SYSCTL_HANDLER_ARGS)
900 error = sysctl_handle_int(oidp, oidp->oid_arg1, oidp->oid_arg2, req);
901 if (!error && req->newptr) {
902 /* Clear the buffer and reset write pointer */
903 bzero(msgbufp->msg_ptr, msgbufp->msg_size);
904 msgbufp->msg_bufr = msgbufp->msg_bufx = 0;
910 SYSCTL_PROC(_kern, OID_AUTO, msgbuf_clear,
911 CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_SECURE, &msgbuf_clear, 0,
912 sysctl_kern_msgbuf_clear, "I", "Clear kernel message buffer");
918 DB_SHOW_COMMAND(msgbuf, db_show_msgbuf)
923 db_printf("msgbuf not mapped yet\n");
926 db_printf("msgbufp = %p\n", msgbufp);
927 db_printf("magic = %x, size = %d, r= %d, w = %d, ptr = %p\n",
928 msgbufp->msg_magic, msgbufp->msg_size, msgbufp->msg_bufr,
929 msgbufp->msg_bufx, msgbufp->msg_ptr);
930 for (i = 0; i < msgbufp->msg_size; i++) {
931 j = (i + msgbufp->msg_bufr) % msgbufp->msg_size;
932 db_printf("%c", msgbufp->msg_ptr[j]);