/*-
 * SPDX-License-Identifier: BSD-3-Clause
 *
 * Copyright (c) 1986, 1988, 1991, 1993
 *      The Regents of the University of California.  All rights reserved.
 * (c) UNIX System Laboratories, Inc.
 * All or some portions of this file are derived from material licensed
 * to the University of California by American Telephone and Telegraph
 * Co. or Unix System Laboratories, Inc. and are reproduced herein with
 * the permission of UNIX System Laboratories, Inc.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */

#include <sys/cdefs.h>
#ifdef _KERNEL
#include "opt_ddb.h"
#include "opt_printf.h"
#endif  /* _KERNEL */

#include <sys/param.h>
#ifdef _KERNEL
#include <sys/systm.h>
#include <sys/lock.h>
#include <sys/kdb.h>
#include <sys/mutex.h>
#include <sys/sx.h>
#include <sys/kernel.h>
#include <sys/msgbuf.h>
#include <sys/malloc.h>
#include <sys/priv.h>
#include <sys/proc.h>
#include <sys/stddef.h>
#include <sys/sysctl.h>
#include <sys/tslog.h>
#include <sys/tty.h>
#include <sys/syslog.h>
#include <sys/cons.h>
#include <sys/uio.h>
#else /* !_KERNEL */
#include <errno.h>
#endif
#include <sys/ctype.h>
#include <sys/sbuf.h>

#ifdef DDB
#include <ddb/ddb.h>
#endif

#ifdef _KERNEL
#include <sys/stdarg.h>
#else
#include <stdarg.h>
#endif

/*
 * This is needed for sbuf_putbuf() when compiled into userland.  Due to the
 * shared nature of this file, it's the only place to put it.
 */
#ifndef _KERNEL
#include <stdio.h>
#endif

#ifdef _KERNEL

#define TOCONS  0x01
#define TOTTY   0x02
#define TOLOG   0x04

/* Max number conversion buffer length: a u_quad_t in base 2, plus NUL byte. */
#define MAXNBUF (sizeof(intmax_t) * NBBY + 1)

struct putchar_arg {
        int     flags;
        int     pri;
        struct  tty *tty;
        char    *p_bufr;
        size_t  n_bufr;
        char    *p_next;
        size_t  remain;
};

struct snprintf_arg {
        char    *str;
        size_t  remain;
};

extern  int log_open;
extern  int cn_mute;

static void  msglogchar(int c, int pri);
static void  msglogstr(char *str, int pri, int filter_cr);
static void  prf_putbuf(char *bufr, int flags, int pri);
static void  putchar(int ch, void *arg);
static char *ksprintn(char *nbuf, uintmax_t num, int base, int *len, int upper);
static void  snprintf_func(int ch, void *arg);

static bool msgbufmapped;               /* Set when safe to use msgbuf */
int msgbuftrigger;
struct msgbuf *msgbufp;

#ifndef BOOT_TAG_SZ
#define BOOT_TAG_SZ     32
#endif
#ifndef BOOT_TAG
/* Tag used to mark the start of a boot in dmesg */
#define BOOT_TAG        "---<<BOOT>>---"
#endif

static char current_boot_tag[BOOT_TAG_SZ + 1] = BOOT_TAG;
SYSCTL_STRING(_kern, OID_AUTO, boot_tag, CTLFLAG_RDTUN | CTLFLAG_NOFETCH,
    current_boot_tag, 0, "Tag added to dmesg at start of boot");

static int log_console_output = 1;
SYSCTL_INT(_kern, OID_AUTO, log_console_output, CTLFLAG_RWTUN,
    &log_console_output, 0, "Duplicate console output to the syslog");

/*
 * See the comment in log_console() below for more explanation of this.
 */
static int log_console_add_linefeed;
SYSCTL_INT(_kern, OID_AUTO, log_console_add_linefeed, CTLFLAG_RWTUN,
    &log_console_add_linefeed, 0, "log_console() adds extra newlines");

static int always_console_output;
SYSCTL_INT(_kern, OID_AUTO, always_console_output, CTLFLAG_RWTUN,
    &always_console_output, 0, "Always output to console despite TIOCCONS");

/*
 * Warn that a system table is full.
 */
void
tablefull(const char *tab)
{

        log(LOG_ERR, "%s: table is full\n", tab);
}

/*
 * Uprintf prints to the controlling terminal for the current process.
 */
int
uprintf(const char *fmt, ...)
{
        va_list ap;
        struct putchar_arg pca;
        struct proc *p;
        struct thread *td;
        int retval;

        td = curthread;
        if (TD_IS_IDLETHREAD(td))
                return (0);

        if (td->td_proc == initproc) {
                /* Produce output when we fail to load /sbin/init: */
                va_start(ap, fmt);
                retval = vprintf(fmt, ap);
                va_end(ap);
                return (retval);
        }

        sx_slock(&proctree_lock);
        p = td->td_proc;
        PROC_LOCK(p);
        if ((p->p_flag & P_CONTROLT) == 0) {
                PROC_UNLOCK(p);
                sx_sunlock(&proctree_lock);
                return (0);
        }
        SESS_LOCK(p->p_session);
        pca.tty = p->p_session->s_ttyp;
        SESS_UNLOCK(p->p_session);
        PROC_UNLOCK(p);
        if (pca.tty == NULL) {
                sx_sunlock(&proctree_lock);
                return (0);
        }
        pca.flags = TOTTY;
        pca.p_bufr = NULL;
        va_start(ap, fmt);
        tty_lock(pca.tty);
        sx_sunlock(&proctree_lock);
        retval = kvprintf(fmt, putchar, &pca, 10, ap);
        tty_unlock(pca.tty);
        va_end(ap);
        return (retval);
}

/*
 * tprintf and vtprintf print on the controlling terminal associated with the
 * given session, possibly to the log as well.
 */
void
tprintf(struct proc *p, int pri, const char *fmt, ...)
{
        va_list ap;

        va_start(ap, fmt);
        vtprintf(p, pri, fmt, ap);
        va_end(ap);
}

void
vtprintf(struct proc *p, int pri, const char *fmt, va_list ap)
{
        struct tty *tp = NULL;
        int flags = 0;
        struct putchar_arg pca;
        struct session *sess = NULL;

        sx_slock(&proctree_lock);
        if (pri != -1)
                flags |= TOLOG;
        if (p != NULL) {
                PROC_LOCK(p);
                if (p->p_flag & P_CONTROLT && p->p_session->s_ttyvp) {
                        sess = p->p_session;
                        sess_hold(sess);
                        PROC_UNLOCK(p);
                        tp = sess->s_ttyp;
                        if (tp != NULL && tty_checkoutq(tp))
                                flags |= TOTTY;
                        else
                                tp = NULL;
                } else
                        PROC_UNLOCK(p);
        }
        pca.pri = pri;
        pca.tty = tp;
        pca.flags = flags;
        pca.p_bufr = NULL;
        if (pca.tty != NULL)
                tty_lock(pca.tty);
        sx_sunlock(&proctree_lock);
        kvprintf(fmt, putchar, &pca, 10, ap);
        if (pca.tty != NULL)
                tty_unlock(pca.tty);
        if (sess != NULL)
                sess_release(sess);
        msgbuftrigger = 1;
}

static int
_vprintf(int level, int flags, const char *fmt, va_list ap)
{
        struct putchar_arg pca;
        int retval;
#ifdef PRINTF_BUFR_SIZE
        char bufr[PRINTF_BUFR_SIZE];
#endif

        TSENTER();
        pca.tty = NULL;
        pca.pri = level;
        pca.flags = flags;
#ifdef PRINTF_BUFR_SIZE
        pca.p_bufr = bufr;
        pca.p_next = pca.p_bufr;
        pca.n_bufr = sizeof(bufr);
        pca.remain = sizeof(bufr);
        *pca.p_next = '\0';
#else
        /* Don't buffer console output. */
        pca.p_bufr = NULL;
#endif

        retval = kvprintf(fmt, putchar, &pca, 10, ap);

#ifdef PRINTF_BUFR_SIZE
        /* Write any buffered console/log output: */
        if (*pca.p_bufr != '\0')
                prf_putbuf(pca.p_bufr, flags, level);
#endif

        TSEXIT();
        return (retval);
}

/*
 * Log writes to the log buffer, and guarantees not to sleep (so can be
 * called by interrupt routines).  If there is no process reading the
 * log yet, it writes to the console also.
 */
void
log(int level, const char *fmt, ...)
{
        va_list ap;

        va_start(ap, fmt);
        vlog(level, fmt, ap);
        va_end(ap);
}

void
vlog(int level, const char *fmt, va_list ap)
{

        (void)_vprintf(level, log_open ? TOLOG : TOCONS | TOLOG, fmt, ap);
        msgbuftrigger = 1;
}

#define CONSCHUNK 128

void
log_console(struct uio *uio)
{
        int c, error, nl;
        char *consbuffer;
        int pri;

        if (!log_console_output)
                return;

        pri = LOG_INFO | LOG_CONSOLE;
        uio = cloneuio(uio);
        consbuffer = malloc(CONSCHUNK, M_TEMP, M_WAITOK);

        nl = 0;
        while (uio->uio_resid > 0) {
                c = imin(uio->uio_resid, CONSCHUNK - 1);
                error = uiomove(consbuffer, c, uio);
                if (error != 0)
                        break;
                /* Make sure we're NUL-terminated */
                consbuffer[c] = '\0';
                if (consbuffer[c - 1] == '\n')
                        nl = 1;
                else
                        nl = 0;
                msglogstr(consbuffer, pri, /*filter_cr*/ 1);
        }
        /*
         * The previous behavior in log_console() is preserved when
         * log_console_add_linefeed is non-zero.  For that behavior, if an
         * individual console write came in that was not terminated with a
         * line feed, it would add a line feed.
         *
         * This results in different data in the message buffer than
         * appears on the system console (which doesn't add extra line feed
         * characters).
         *
         * A number of programs and rc scripts write a line feed, or a period
         * and a line feed when they have completed their operation.  On
         * the console, this looks seamless, but when displayed with
         * 'dmesg -a', you wind up with output that looks like this:
         *
         * Updating motd:
         * .
         *
         * On the console, it looks like this:
         * Updating motd:.
         *
         * We could add logic to detect that situation, or just not insert
         * the extra newlines.  Set the kern.log_console_add_linefeed
         * sysctl/tunable variable to get the old behavior.
         */
        if (!nl && log_console_add_linefeed) {
                consbuffer[0] = '\n';
                consbuffer[1] = '\0';
                msglogstr(consbuffer, pri, /*filter_cr*/ 1);
        }
        msgbuftrigger = 1;
        freeuio(uio);
        free(consbuffer, M_TEMP);
}

int
printf(const char *fmt, ...)
{
        va_list ap;
        int retval;

        va_start(ap, fmt);
        retval = vprintf(fmt, ap);
        va_end(ap);

        return (retval);
}

int
vprintf(const char *fmt, va_list ap)
{
        int retval;

        retval = _vprintf(-1, TOCONS | TOLOG, fmt, ap);

        if (!KERNEL_PANICKED())
                msgbuftrigger = 1;

        return (retval);
}

static void
prf_putchar(int c, int flags, int pri)
{

        if (flags & TOLOG) {
                msglogchar(c, pri);
                msgbuftrigger = 1;
        }

        if ((flags & TOCONS) && !cn_mute) {
                if ((!KERNEL_PANICKED()) && (constty != NULL))
                        msgbuf_addchar(&consmsgbuf, c);

                if ((constty == NULL) || always_console_output)
                        cnputc(c);
        }
}

static void
prf_putbuf(char *bufr, int flags, int pri)
{

        if (flags & TOLOG) {
                msglogstr(bufr, pri, /*filter_cr*/1);
                msgbuftrigger = 1;
        }

        if ((flags & TOCONS) && !cn_mute) {
                if ((!KERNEL_PANICKED()) && (constty != NULL))
                        msgbuf_addstr(&consmsgbuf, -1,
                            bufr, /*filter_cr*/ 0);

                if ((constty == NULL) || always_console_output)
                        cnputs(bufr);
        }
}

static void
putbuf(int c, struct putchar_arg *ap)
{
        /* Check if no console output buffer was provided. */
        if (ap->p_bufr == NULL) {
                prf_putchar(c, ap->flags, ap->pri);
        } else {
                /* Buffer the character: */
                *ap->p_next++ = c;
                ap->remain--;

                /* Always leave the buffer zero terminated. */
                *ap->p_next = '\0';

                /* Check if the buffer needs to be flushed. */
                if (ap->remain == 2 || c == '\n') {
                        prf_putbuf(ap->p_bufr, ap->flags, ap->pri);

                        ap->p_next = ap->p_bufr;
                        ap->remain = ap->n_bufr;
                        *ap->p_next = '\0';
                }

                /*
                 * Since we fill the buffer up one character at a time,
                 * this should not happen.  We should always catch it when
                 * ap->remain == 2 (if not sooner due to a newline), flush
                 * the buffer and move on.  One way this could happen is
                 * if someone sets PRINTF_BUFR_SIZE to 1 or something
                 * similarly silly.
                 */
                KASSERT(ap->remain > 2, ("Bad buffer logic, remain = %zd",
                    ap->remain));
        }
}

/*
 * Print a character on console or users terminal.  If destination is
 * the console then the last bunch of characters are saved in msgbuf for
 * inspection later.
 */
static void
putchar(int c, void *arg)
{
        struct putchar_arg *ap = (struct putchar_arg*) arg;
        struct tty *tp = ap->tty;
        int flags = ap->flags;

        /* Don't use the tty code after a panic or while in ddb. */
        if (kdb_active) {
                if (c != '\0')
                        cnputc(c);
                return;
        }

        if ((flags & TOTTY) && tp != NULL && !KERNEL_PANICKED())
                tty_putchar(tp, c);

        if ((flags & TOCONS) && cn_mute) {
                flags &= ~TOCONS;
                ap->flags = flags;
        }

        if ((flags & (TOCONS | TOLOG)) && c != '\0')
                putbuf(c, ap);
}

/*
 * Scaled down version of sprintf(3).
 */
int
sprintf(char *buf, const char *cfmt, ...)
{
        int retval;
        va_list ap;

        va_start(ap, cfmt);
        retval = kvprintf(cfmt, NULL, (void *)buf, 10, ap);
        buf[retval] = '\0';
        va_end(ap);
        return (retval);
}

/*
 * Scaled down version of vsprintf(3).
 */
int
vsprintf(char *buf, const char *cfmt, va_list ap)
{
        int retval;

        retval = kvprintf(cfmt, NULL, (void *)buf, 10, ap);
        buf[retval] = '\0';
        return (retval);
}

/*
 * Scaled down version of snprintf(3).
 */
int
snprintf(char *str, size_t size, const char *format, ...)
{
        int retval;
        va_list ap;

        va_start(ap, format);
        retval = vsnprintf(str, size, format, ap);
        va_end(ap);
        return(retval);
}

/*
 * Scaled down version of vsnprintf(3).
 */
int
vsnprintf(char *str, size_t size, const char *format, va_list ap)
{
        struct snprintf_arg info;
        int retval;

        info.str = str;
        info.remain = size;
        retval = kvprintf(format, snprintf_func, &info, 10, ap);
        if (info.remain >= 1)
                *info.str++ = '\0';
        return (retval);
}

/*
 * Kernel version which takes radix argument vsnprintf(3).
 */
int
vsnrprintf(char *str, size_t size, int radix, const char *format, va_list ap)
{
        struct snprintf_arg info;
        int retval;

        info.str = str;
        info.remain = size;
        retval = kvprintf(format, snprintf_func, &info, radix, ap);
        if (info.remain >= 1)
                *info.str++ = '\0';
        return (retval);
}

static void
snprintf_func(int ch, void *arg)
{
        struct snprintf_arg *const info = arg;

        if (info->remain >= 2) {
                *info->str++ = ch;
                info->remain--;
        }
}

/*
 * Put a NUL-terminated ASCII number (base <= 36) in a buffer in reverse
 * order; return an optional length and a pointer to the last character
 * written in the buffer (i.e., the first character of the string).
 * The buffer pointed to by `nbuf' must have length >= MAXNBUF.
 */
static char *
ksprintn(char *nbuf, uintmax_t num, int base, int *lenp, int upper)
{
        char *p, c;

        p = nbuf;
        *p = '\0';
        do {
                c = hex2ascii(num % base);
                *++p = upper ? toupper(c) : c;
        } while (num /= base);
        if (lenp)
                *lenp = p - nbuf;
        return (p);
}

static inline bool
isbitpos(char c)
{
        return (c != '\0' && (c <= ' ' || (c & 0x80) != 0));
}

static inline bool
isprintnospace(char c)
{
        return (isprint(c) && c != ' ');
}

/*
 * Scaled down version of printf(3).
 *
 * Two additional formats:
 *
 * The format %b is supported to decode error registers.
 * Its usage is:
 *
 *      printf("reg=%b\n", regval, "<base><arg>*");
 *
 * where <base> is the output base expressed as a control character, e.g.
 * \10 gives octal; \20 gives hex.  Each arg is a sequence of characters,
 * the first of which gives the bit number to be inspected and the next
 * characters (up to the bit number of the next argument or a final NUL
 * character), give the name of the register.
 * The bit number can be encoded as a character between 1 and 32 or as a
 * character between 128 and 255.
 * Thus:
 *
 *      kvprintf("reg=%b\n", 3, "\10\2BITTWO\1BITONE");
 *
 * would produce output:
 *
 *      reg=3<BITTWO,BITONE>
 *
 * The same output would be generated by using:
 *
 *      kvprintf("reg=%b\n", 3, "\10\201BITTWO\200BITONE");
 *
 * XXX:  %D  -- Hexdump, takes pointer and separator string:
 *              ("%6D", ptr, ":")   -> XX:XX:XX:XX:XX:XX
 *              ("%*D", len, ptr, " " -> XX XX XX XX ...
 */
int
kvprintf(char const *fmt, void (*func)(int, void*), void *arg, int radix, va_list ap)
{
#define PCHAR(c) {int cc=(c); if (func) (*func)(cc,arg); else *d++ = cc; retval++; }
        char nbuf[MAXNBUF];
        char *d;
        const char *p, *percent, *q;
        u_char *up;
        int ch, n, sign;
        uintmax_t num;
        int base, lflag, qflag, tmp, width, ladjust, sharpflag, dot;
        int cflag, hflag, jflag, tflag, zflag;
        int bconv, dwidth, upper;
        char padc;
        int stop = 0, retval = 0;

        num = 0;
        q = NULL;
        if (!func)
                d = (char *) arg;
        else
                d = NULL;

        if (fmt == NULL)
                fmt = "(fmt null)\n";

        if (radix < 2 || radix > 36)
                radix = 10;

        for (;;) {
                padc = ' ';
                width = 0;
                while ((ch = (u_char)*fmt++) != '%' || stop) {
                        if (ch == '\0')
                                return (retval);
                        PCHAR(ch);
                }
                percent = fmt - 1;
                qflag = 0; lflag = 0; ladjust = 0; sharpflag = 0;
                sign = 0; dot = 0; bconv = 0; dwidth = 0; upper = 0;
                cflag = 0; hflag = 0; jflag = 0; tflag = 0; zflag = 0;
reswitch:       switch (ch = (u_char)*fmt++) {
                case '.':
                        dot = 1;
                        goto reswitch;
                case '#':
                        sharpflag = 1;
                        goto reswitch;
                case '+':
                        sign = '+';
                        goto reswitch;
                case '-':
                        ladjust = 1;
                        goto reswitch;
                case '%':
                        PCHAR(ch);
                        break;
                case '*':
                        if (!dot) {
                                width = va_arg(ap, int);
                                if (width < 0) {
                                        ladjust = !ladjust;
                                        width = -width;
                                }
                        } else {
                                dwidth = va_arg(ap, int);
                        }
                        goto reswitch;
                case '0':
                        if (!dot) {
                                padc = '0';
                                goto reswitch;
                        }
                        /* FALLTHROUGH */
                case '1': case '2': case '3': case '4':
                case '5': case '6': case '7': case '8': case '9':
                                for (n = 0;; ++fmt) {
                                        n = n * 10 + ch - '0';
                                        ch = *fmt;
                                        if (ch < '0' || ch > '9')
                                                break;
                                }
                        if (dot)
                                dwidth = n;
                        else
                                width = n;
                        goto reswitch;
                case 'b':
                        ladjust = 1;
                        bconv = 1;
                        goto handle_nosign;
                case 'c':
                        width -= 1;

                        if (!ladjust && width > 0)
                                while (width--)
                                        PCHAR(padc);
                        PCHAR(va_arg(ap, int));
                        if (ladjust && width > 0)
                                while (width--)
                                        PCHAR(padc);
                        break;
                case 'D':
                        up = va_arg(ap, u_char *);
                        p = va_arg(ap, char *);
                        if (!width)
                                width = 16;
                        while(width--) {
                                PCHAR(hex2ascii(*up >> 4));
                                PCHAR(hex2ascii(*up & 0x0f));
                                up++;
                                if (width)
                                        for (q = p; *q; q++)
                                                PCHAR(*q);
                        }
                        break;
                case 'd':
                case 'i':
                        base = 10;
                        goto handle_sign;
                case 'h':
                        if (hflag) {
                                hflag = 0;
                                cflag = 1;
                        } else
                                hflag = 1;
                        goto reswitch;
                case 'j':
                        jflag = 1;
                        goto reswitch;
                case 'l':
                        if (lflag) {
                                lflag = 0;
                                qflag = 1;
                        } else
                                lflag = 1;
                        goto reswitch;
                case 'n':
                        /*
                         * We do not support %n in kernel, but consume the
                         * argument.
                         */
                        if (jflag)
                                (void)va_arg(ap, intmax_t *);
                        else if (qflag)
                                (void)va_arg(ap, quad_t *);
                        else if (lflag)
                                (void)va_arg(ap, long *);
                        else if (zflag)
                                (void)va_arg(ap, size_t *);
                        else if (hflag)
                                (void)va_arg(ap, short *);
                        else if (cflag)
                                (void)va_arg(ap, char *);
                        else
                                (void)va_arg(ap, int *);
                        break;
                case 'o':
                        base = 8;
                        goto handle_nosign;
                case 'p':
                        base = 16;
                        sharpflag = (width == 0);
                        sign = 0;
                        num = (uintptr_t)va_arg(ap, void *);
                        goto number;
                case 'q':
                        qflag = 1;
                        goto reswitch;
                case 'r':
                        base = radix;
                        if (sign) {
                                sign = 0;
                                goto handle_sign;
                        }
                        goto handle_nosign;
                case 's':
                        p = va_arg(ap, char *);
                        if (p == NULL)
                                p = "(null)";
                        if (!dot)
                                n = strlen (p);
                        else
                                for (n = 0; n < dwidth && p[n]; n++)
                                        continue;

                        width -= n;

                        if (!ladjust && width > 0)
                                while (width--)
                                        PCHAR(padc);
                        while (n--)
                                PCHAR(*p++);
                        if (ladjust && width > 0)
                                while (width--)
                                        PCHAR(padc);
                        break;
                case 't':
                        tflag = 1;
                        goto reswitch;
                case 'u':
                        base = 10;
                        goto handle_nosign;
                case 'X':
                        upper = 1;
                        /* FALLTHROUGH */
                case 'x':
                        base = 16;
                        goto handle_nosign;
                case 'y':
                        base = 16;
                        goto handle_sign;
                case 'z':
                        zflag = 1;
                        goto reswitch;
handle_nosign:
                        if (jflag)
                                num = va_arg(ap, uintmax_t);
                        else if (qflag)
                                num = va_arg(ap, u_quad_t);
                        else if (tflag)
                                num = va_arg(ap, ptrdiff_t);
                        else if (lflag)
                                num = va_arg(ap, u_long);
                        else if (zflag)
                                num = va_arg(ap, size_t);
                        else if (hflag)
                                num = (u_short)va_arg(ap, int);
                        else if (cflag)
                                num = (u_char)va_arg(ap, int);
                        else
                                num = va_arg(ap, u_int);
                        if (bconv) {
                                q = va_arg(ap, char *);
                                base = *q++;
                        }
                        goto number;
handle_sign:
                        if (jflag)
                                num = va_arg(ap, intmax_t);
                        else if (qflag)
                                num = va_arg(ap, quad_t);
                        else if (tflag)
                                num = va_arg(ap, ptrdiff_t);
                        else if (lflag)
                                num = va_arg(ap, long);
                        else if (zflag)
                                num = va_arg(ap, ssize_t);
                        else if (hflag)
                                num = (short)va_arg(ap, int);
                        else if (cflag)
                                num = (signed char)va_arg(ap, int);
                        else
                                num = va_arg(ap, int);
                        if ((intmax_t)num < 0) {
                                sign = '-';
                                num = -(intmax_t)num;
                        }
number:
                        p = ksprintn(nbuf, num, base, &n, upper);
                        tmp = 0;
                        if (sharpflag && num != 0) {
                                if (base == 8)
                                        tmp++;
                                else if (base == 16)
                                        tmp += 2;
                        }
                        if (sign)
                                tmp++;

                        if (!ladjust && padc == '0')
                                dwidth = width - tmp;
                        width -= tmp + imax(dwidth, n);
                        dwidth -= n;
                        if (!ladjust)
                                while (width-- > 0)
                                        PCHAR(' ');
                        if (sign)
                                PCHAR(sign);
                        if (sharpflag && num != 0) {
                                if (base == 8) {
                                        PCHAR('0');
                                } else if (base == 16) {
                                        PCHAR('0');
                                        PCHAR('x');
                                }
                        }
                        while (dwidth-- > 0)
                                PCHAR('0');

                        while (*p)
                                PCHAR(*p--);

                        if (bconv && num != 0) {
                                /* %b conversion flag format. */
                                tmp = retval;
                                while (isbitpos(*q)) {
                                        if ((*q & 0x80) != 0)
                                                n = *q++ & 0x7f;
                                        else
                                                n = *q++ - 1;
                                        if (num & (1ULL << n)) {
                                                PCHAR(retval != tmp ?
                                                    ',' : '<');
                                                for (; isprintnospace(*q); ++q)
                                                        PCHAR(*q);
                                        } else
                                                for (; isprintnospace(*q); ++q)
                                                        continue;
                                }
                                if (retval != tmp) {
                                        PCHAR('>');
                                        width -= retval - tmp;
                                }
                        }

                        if (ladjust)
                                while (width-- > 0)
                                        PCHAR(' ');

                        break;
                default:
                        while (percent < fmt)
                                PCHAR(*percent++);
                        /*
                         * Since we ignore a formatting argument it is no
                         * longer safe to obey the remaining formatting
                         * arguments as the arguments will no longer match
                         * the format specs.
                         */
                        stop = 1;
                        break;
                }
        }
#undef PCHAR
}

/*
 * Put character in log buffer with a particular priority.
 */
static void
msglogchar(int c, int pri)
{
        static int lastpri = -1;
        static int dangling;
        char nbuf[MAXNBUF];
        char *p;

        if (!msgbufmapped)
                return;
        if (c == '\0' || c == '\r')
                return;
        if (pri != -1 && pri != lastpri) {
                if (dangling) {
                        msgbuf_addchar(msgbufp, '\n');
                        dangling = 0;
                }
                msgbuf_addchar(msgbufp, '<');
                for (p = ksprintn(nbuf, (uintmax_t)pri, 10, NULL, 0); *p;)
                        msgbuf_addchar(msgbufp, *p--);
                msgbuf_addchar(msgbufp, '>');
                lastpri = pri;
        }
        msgbuf_addchar(msgbufp, c);
        if (c == '\n') {
                dangling = 0;
                lastpri = -1;
        } else {
                dangling = 1;
        }
}

static void
msglogstr(char *str, int pri, int filter_cr)
{
        if (!msgbufmapped)
                return;

        msgbuf_addstr(msgbufp, pri, str, filter_cr);
}

void
msgbufinit(void *ptr, int size)
{
        char *cp;
        static struct msgbuf *oldp = NULL;
        bool print_boot_tag;

        TSENTER();
        size -= sizeof(*msgbufp);
        cp = (char *)ptr;
        print_boot_tag = !msgbufmapped;
        /* Attempt to fetch kern.boot_tag tunable on first mapping */
        if (!msgbufmapped)
                TUNABLE_STR_FETCH("kern.boot_tag", current_boot_tag,
                    sizeof(current_boot_tag));
        msgbufp = (struct msgbuf *)(cp + size);
        msgbuf_reinit(msgbufp, cp, size);
        if (msgbufmapped && oldp != msgbufp)
                msgbuf_copy(oldp, msgbufp);
        msgbufmapped = true;
        if (print_boot_tag && *current_boot_tag != '\0')
                printf("%s\n", current_boot_tag);
        oldp = msgbufp;
        TSEXIT();
}

/* Sysctls for accessing/clearing the msgbuf */
static int
sysctl_kern_msgbuf(SYSCTL_HANDLER_ARGS)
{
        char buf[128], *bp;
        u_int seq;
        int error, len;
        bool wrap;

        error = priv_check(req->td, PRIV_MSGBUF);
        if (error)
                return (error);

        /* Read the whole buffer, one chunk at a time. */
        mtx_lock(&msgbuf_lock);
        msgbuf_peekbytes(msgbufp, NULL, 0, &seq);
        wrap = (seq != 0);
        for (;;) {
                len = msgbuf_peekbytes(msgbufp, buf, sizeof(buf), &seq);
                mtx_unlock(&msgbuf_lock);
                if (len == 0)
                        return (SYSCTL_OUT(req, "", 1)); /* add nulterm */
                if (wrap) {
                        /* Skip the first line, as it is probably incomplete. */
                        bp = memchr(buf, '\n', len);
                        if (bp == NULL) {
                                mtx_lock(&msgbuf_lock);
                                continue;
                        }
                        wrap = false;
                        bp++;
                        len -= bp - buf;
                        if (len == 0) {
                                mtx_lock(&msgbuf_lock);
                                continue;
                        }
                } else
                        bp = buf;
                error = sysctl_handle_opaque(oidp, bp, len, req);
                if (error)
                        return (error);

                mtx_lock(&msgbuf_lock);
        }
}

SYSCTL_PROC(_kern, OID_AUTO, msgbuf,
    CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_MPSAFE,
    NULL, 0, sysctl_kern_msgbuf, "A", "Contents of kernel message buffer");

static int msgbuf_clearflag;

static int
sysctl_kern_msgbuf_clear(SYSCTL_HANDLER_ARGS)
{
        int error;
        error = sysctl_handle_int(oidp, oidp->oid_arg1, oidp->oid_arg2, req);
        if (!error && req->newptr) {
                mtx_lock(&msgbuf_lock);
                msgbuf_clear(msgbufp);
                mtx_unlock(&msgbuf_lock);
                msgbuf_clearflag = 0;
        }
        return (error);
}

SYSCTL_PROC(_kern, OID_AUTO, msgbuf_clear,
    CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_SECURE | CTLFLAG_MPSAFE,
    &msgbuf_clearflag, 0, sysctl_kern_msgbuf_clear, "I",
    "Clear kernel message buffer");

#ifdef DDB

DB_SHOW_COMMAND_FLAGS(msgbuf, db_show_msgbuf, DB_CMD_MEMSAFE)
{
        int i, j;

        if (!msgbufmapped) {
                db_printf("msgbuf not mapped yet\n");
                return;
        }
        db_printf("msgbufp = %p\n", msgbufp);
        db_printf("magic = %x, size = %d, r= %u, w = %u, ptr = %p, cksum= %u\n",
            msgbufp->msg_magic, msgbufp->msg_size, msgbufp->msg_rseq,
            msgbufp->msg_wseq, msgbufp->msg_ptr, msgbufp->msg_cksum);
        for (i = 0; i < msgbufp->msg_size && !db_pager_quit; i++) {
                j = MSGBUF_SEQ_TO_POS(msgbufp, i + msgbufp->msg_rseq);
                db_printf("%c", msgbufp->msg_ptr[j]);
        }
        db_printf("\n");
}

#endif /* DDB */

void
hexdump(const void *ptr, int length, const char *hdr, int flags)
{
        int i, j, k;
        int cols;
        const unsigned char *cp;
        char delim;

        if ((flags & HD_DELIM_MASK) != 0)
                delim = (flags & HD_DELIM_MASK) >> 8;
        else
                delim = ' ';

        if ((flags & HD_COLUMN_MASK) != 0)
                cols = flags & HD_COLUMN_MASK;
        else
                cols = 16;

        cp = ptr;
        for (i = 0; i < length; i+= cols) {
                if (hdr != NULL)
                        printf("%s", hdr);

                if ((flags & HD_OMIT_COUNT) == 0)
                        printf("%04x  ", i);

                if ((flags & HD_OMIT_HEX) == 0) {
                        for (j = 0; j < cols; j++) {
                                k = i + j;
                                if (k < length)
                                        printf("%c%02x", delim, cp[k]);
                                else
                                        printf("   ");
                        }
                }

                if ((flags & HD_OMIT_CHARS) == 0) {
                        printf("  |");
                        for (j = 0; j < cols; j++) {
                                k = i + j;
                                if (k >= length)
                                        printf(" ");
                                else if (cp[k] >= ' ' && cp[k] <= '~')
                                        printf("%c", cp[k]);
                                else
                                        printf(".");
                        }
                        printf("|");
                }
                printf("\n");
        }
}
#endif /* _KERNEL */

void
sbuf_hexdump(struct sbuf *sb, const void *ptr, int length, const char *hdr,
             int flags)
{
        int i, j, k;
        int cols;
        const unsigned char *cp;
        char delim;

        if ((flags & HD_DELIM_MASK) != 0)
                delim = (flags & HD_DELIM_MASK) >> 8;
        else
                delim = ' ';

        if ((flags & HD_COLUMN_MASK) != 0)
                cols = flags & HD_COLUMN_MASK;
        else
                cols = 16;

        cp = ptr;
        for (i = 0; i < length; i+= cols) {
                if (hdr != NULL)
                        sbuf_printf(sb, "%s", hdr);

                if ((flags & HD_OMIT_COUNT) == 0)
                        sbuf_printf(sb, "%04x  ", i);

                if ((flags & HD_OMIT_HEX) == 0) {
                        for (j = 0; j < cols; j++) {
                                k = i + j;
                                if (k < length)
                                        sbuf_printf(sb, "%c%02x", delim, cp[k]);
                                else
                                        sbuf_cat(sb, "   ");
                        }
                }

                if ((flags & HD_OMIT_CHARS) == 0) {
                        sbuf_cat(sb, "  |");
                        for (j = 0; j < cols; j++) {
                                k = i + j;
                                if (k >= length)
                                        sbuf_putc(sb, ' ');
                                else if (cp[k] >= ' ' && cp[k] <= '~')
                                        sbuf_putc(sb, cp[k]);
                                else
                                        sbuf_putc(sb, '.');
                        }
                        sbuf_putc(sb, '|');
                }
                sbuf_putc(sb, '\n');
        }
}

#ifdef _KERNEL
void
counted_warning(unsigned *counter, const char *msg)
{
        struct thread *td;
        unsigned c;

        for (;;) {
                c = *counter;
                if (c == 0)
                        break;
                if (atomic_cmpset_int(counter, c, c - 1)) {
                        td = curthread;
                        log(LOG_INFO, "pid %d (%s) %s%s\n",
                            td->td_proc->p_pid, td->td_name, msg,
                            c > 1 ? "" : " - not logging anymore");
                        break;
                }
        }
}
#endif

#ifdef _KERNEL
void
sbuf_putbuf(struct sbuf *sb)
{

        prf_putbuf(sbuf_data(sb), TOLOG | TOCONS, -1);
}
#else
void
sbuf_putbuf(struct sbuf *sb)
{

        printf("%s", sbuf_data(sb));
}
#endif

int
sbuf_printf_drain(void *arg, const char *data, int len)
{
        size_t *retvalptr;
        int r;
#ifdef _KERNEL
        char *dataptr;
        char oldchr;

        /*
         * This is allowed as an extra byte is always resvered for
         * terminating NUL byte.  Save and restore the byte because
         * we might be flushing a record, and there may be valid
         * data after the buffer.
         */
        oldchr = data[len];
        dataptr = __DECONST(char *, data);
        dataptr[len] = '\0';

        prf_putbuf(dataptr, TOLOG | TOCONS, -1);
        r = len;

        dataptr[len] = oldchr;

#else /* !_KERNEL */

        r = printf("%.*s", len, data);
        if (r < 0)
                return (-errno);

#endif

        retvalptr = arg;
        if (retvalptr != NULL)
                *retvalptr += r;

        return (r);
}