/* $NetBSD: subr_prf.c,v 1.196.2.2 2023/08/11 14:35:25 martin Exp $ */ /*- * 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. * * @(#)subr_prf.c 8.4 (Berkeley) 5/4/95 */ #include __KERNEL_RCSID(0, "$NetBSD: subr_prf.c,v 1.196.2.2 2023/08/11 14:35:25 martin Exp $"); #ifdef _KERNEL_OPT #include "opt_ddb.h" #include "opt_kgdb.h" #include "opt_dump.h" #include "opt_rnd_printf.h" #endif #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include static kmutex_t kprintf_mtx; static bool kprintf_inited = false; #ifdef KGDB #include #endif #ifdef DDB #include /* db_panic */ #include /* db_printf, db_putchar prototypes */ #endif /* * defines */ #define KLOG_PRI 0x80000000 /* * local prototypes */ static void putchar(int, int, struct tty *); static void kprintf_internal(const char *, int, void *, char *, ...); /* * globals */ const char *panicstr; /* arg to first call to panic (used as a flag to indicate that panic has already been called). */ struct cpu_info *paniccpu; /* cpu that first panicked */ long panicstart, panicend; /* position in the msgbuf of the start and end of the formatted panicstr. */ int doing_shutdown; /* set to indicate shutdown in progress */ #ifdef RND_PRINTF static krndsource_t rnd_printf_source; #endif #ifndef DUMP_ON_PANIC #define DUMP_ON_PANIC 1 #endif int dumponpanic = DUMP_ON_PANIC; /* * v_putc: routine to putc on virtual console * * the v_putc pointer can be used to redirect the console cnputc elsewhere * [e.g. to a "virtual console"]. */ void (*v_putc)(int) = cnputc; /* start with cnputc (normal cons) */ void (*v_flush)(void) = cnflush; /* start with cnflush (normal cons) */ const char hexdigits[] = "0123456789abcdef"; const char HEXDIGITS[] = "0123456789ABCDEF"; /* * functions */ /* * Locking is inited fairly early in MI bootstrap. Before that * prints are done unlocked. But that doesn't really matter, * since nothing can preempt us before interrupts are enabled. */ void kprintf_init(void) { KASSERT(!kprintf_inited && cold); /* not foolproof, but ... */ mutex_init(&kprintf_mtx, MUTEX_DEFAULT, IPL_HIGH); #ifdef RND_PRINTF rnd_attach_source(&rnd_printf_source, "printf", RND_TYPE_UNKNOWN, RND_FLAG_COLLECT_TIME|RND_FLAG_COLLECT_VALUE); #endif kprintf_inited = true; } void kprintf_lock(void) { if (__predict_true(kprintf_inited)) mutex_enter(&kprintf_mtx); } void kprintf_unlock(void) { if (__predict_true(kprintf_inited)) { /* assert kprintf wasn't somehow inited while we were in */ KASSERT(mutex_owned(&kprintf_mtx)); mutex_exit(&kprintf_mtx); } } /* * twiddle: spin a little propellor on the console. */ void twiddle(void) { static const char twiddle_chars[] = "|/-\\"; static int pos; kprintf_lock(); putchar(twiddle_chars[pos++ & 3], TOCONS|NOTSTAMP, NULL); putchar('\b', TOCONS|NOTSTAMP, NULL); kprintf_unlock(); } /* * panic: handle an unresolvable fatal error * * prints "panic: " and reboots. if called twice (i.e. recursive * call) we avoid trying to dump and just reboot (to avoid recursive panics). */ void panic(const char *fmt, ...) { va_list ap; va_start(ap, fmt); vpanic(fmt, ap); va_end(ap); } void vpanic(const char *fmt, va_list ap) { CPU_INFO_ITERATOR cii; struct cpu_info *ci, *oci; int bootopt; static char scratchstr[384]; /* stores panic message */ spldebug_stop(); if (lwp0.l_cpu && curlwp) { /* * Disable preemption. If already panicking on another CPU, sit * here and spin until the system is rebooted. Allow the CPU that * first panicked to panic again. */ kpreempt_disable(); ci = curcpu(); oci = atomic_cas_ptr((void *)&paniccpu, NULL, ci); if (oci != NULL && oci != ci) { /* Give interrupts a chance to try and prevent deadlock. */ for (;;) { #ifndef _RUMPKERNEL /* XXXpooka: temporary build fix, see kern/40505 */ DELAY(10); #endif /* _RUMPKERNEL */ } } /* * Convert the current thread to a bound thread and prevent all * CPUs from scheduling unbound jobs. Do so without taking any * locks. */ curlwp->l_pflag |= LP_BOUND; for (CPU_INFO_FOREACH(cii, ci)) { ci->ci_schedstate.spc_flags |= SPCF_OFFLINE; } } bootopt = RB_AUTOBOOT | RB_NOSYNC; if (!doing_shutdown) { if (dumponpanic) bootopt |= RB_DUMP; } else printf("Skipping crash dump on recursive panic\n"); doing_shutdown = 1; if (logenabled(msgbufp)) panicstart = msgbufp->msg_bufx; kprintf_lock(); kprintf_internal("panic: ", TOLOG|TOCONS, NULL, NULL); if (panicstr == NULL) { /* first time in panic - store fmt first for precaution */ panicstr = fmt; vsnprintf(scratchstr, sizeof(scratchstr), fmt, ap); kprintf_internal("%s", TOLOG|TOCONS, NULL, NULL, scratchstr); panicstr = scratchstr; } else { kprintf(fmt, TOLOG|TOCONS, NULL, NULL, ap); } kprintf_internal("\n", TOLOG|TOCONS, NULL, NULL); kprintf_unlock(); if (logenabled(msgbufp)) panicend = msgbufp->msg_bufx; #ifdef KGDB kgdb_panic(); #endif #ifdef KADB if (boothowto & RB_KDB) kdbpanic(); #endif #ifdef DDB db_panic(); #endif kern_reboot(bootopt, NULL); } /* * kernel logging functions: log, logpri, addlog */ /* * log: write to the log buffer * * => will not sleep [so safe to call from interrupt] * => will log to console if /dev/klog isn't open */ void log(int level, const char *fmt, ...) { va_list ap; kprintf_lock(); klogpri(level); /* log the level first */ va_start(ap, fmt); kprintf(fmt, TOLOG, NULL, NULL, ap); va_end(ap); if (!log_open) { va_start(ap, fmt); kprintf(fmt, TOCONS, NULL, NULL, ap); va_end(ap); } kprintf_unlock(); logwakeup(); /* wake up anyone waiting for log msgs */ } /* * vlog: write to the log buffer [already have va_list] */ void vlog(int level, const char *fmt, va_list ap) { va_list cap; va_copy(cap, ap); kprintf_lock(); klogpri(level); /* log the level first */ kprintf(fmt, TOLOG, NULL, NULL, ap); if (!log_open) kprintf(fmt, TOCONS, NULL, NULL, cap); kprintf_unlock(); va_end(cap); logwakeup(); /* wake up anyone waiting for log msgs */ } /* * logpri: log the priority level to the klog */ void logpri(int level) { kprintf_lock(); klogpri(level); kprintf_unlock(); } /* * Note: we must be in the mutex here! */ void klogpri(int level) { KASSERT((level & KLOG_PRI) == 0); putchar(level | KLOG_PRI, TOLOG, NULL); } /* * addlog: add info to previous log message */ void addlog(const char *fmt, ...) { va_list ap; kprintf_lock(); va_start(ap, fmt); kprintf(fmt, TOLOG, NULL, NULL, ap); va_end(ap); if (!log_open) { va_start(ap, fmt); kprintf(fmt, TOCONS, NULL, NULL, ap); va_end(ap); } kprintf_unlock(); logwakeup(); } static void putone(int c, int flags, struct tty *tp) { struct tty *ctp; int s; bool do_ps = !cold; ctp = NULL; /* XXX gcc i386 -Os */ /* * Ensure whatever constty points to can't go away while we're * trying to use it. */ if (__predict_true(do_ps)) s = pserialize_read_enter(); if (panicstr) atomic_store_relaxed(&constty, NULL); if ((flags & TOCONS) && (ctp = atomic_load_consume(&constty)) != NULL && tp == NULL) { tp = ctp; flags |= TOTTY; } if ((flags & TOTTY) && tp && tputchar(c, flags, tp) < 0 && (flags & TOCONS)) atomic_cas_ptr(&constty, tp, NULL); if ((flags & TOLOG) && c != '\0' && c != '\r' && c != 0177) logputchar(c); if ((flags & TOCONS) && ctp == NULL && c != '\0') (*v_putc)(c); if (__predict_true(do_ps)) pserialize_read_exit(s); } static void putlogpri(int level) { char *p; char snbuf[KPRINTF_BUFSIZE]; putone('<', TOLOG, NULL); snprintf(snbuf, sizeof(snbuf), "%d", level); for (p = snbuf ; *p ; p++) putone(*p, TOLOG, NULL); putone('>', TOLOG, NULL); } #ifndef KLOG_NOTIMESTAMP static int needtstamp = 1; int log_ts_prec = 7; static void addtstamp(int flags, struct tty *tp) { char buf[64]; struct timespec ts; int n, prec; long fsec; prec = log_ts_prec; if (prec < 0) { prec = 0; log_ts_prec = prec; } else if (prec > 9) { prec = 9; log_ts_prec = prec; } getnanouptime(&ts); for (n = prec, fsec = ts.tv_nsec; n < 8; n++) fsec /= 10; if (n < 9) fsec = (fsec / 10) + ((fsec % 10) >= 5); n = snprintf(buf, sizeof(buf), "[% 4jd.%.*ld] ", (intmax_t)ts.tv_sec, prec, fsec); for (int i = 0; i < n; i++) putone(buf[i], flags, tp); } #endif /* * putchar: print a single character on console or user terminal. * * => if console, then the last MSGBUFS chars are saved in msgbuf * for inspection later (e.g. dmesg/syslog) * => we must already be in the mutex! */ static void putchar(int c, int flags, struct tty *tp) { if (c & KLOG_PRI) { putlogpri(c & ~KLOG_PRI); return; } #ifndef KLOG_NOTIMESTAMP if (c != '\0' && c != '\n' && needtstamp && (flags & NOTSTAMP) == 0) { addtstamp(flags, tp); needtstamp = 0; } if (c == '\n') needtstamp = 1; #endif putone(c, flags, tp); #ifdef DDB if (flags & TODDB) { db_putchar(c); return; } #endif #ifdef RND_PRINTF if (__predict_true(kprintf_inited)) { unsigned char ch = c; rnd_add_data_intr(&rnd_printf_source, &ch, 1, 0); } #endif } /* * tablefull: warn that a system table is full */ void tablefull(const char *tab, const char *hint) { if (hint) log(LOG_ERR, "%s: table is full - %s\n", tab, hint); else log(LOG_ERR, "%s: table is full\n", tab); } /* * uprintf: print to the controlling tty of the current process * * => we may block if the tty queue is full * => no message is printed if the queue doesn't clear in a reasonable * time */ void uprintf(const char *fmt, ...) { struct proc *p = curproc; va_list ap; /* mutex_enter(&proc_lock); XXXSMP */ if (p->p_lflag & PL_CONTROLT && p->p_session->s_ttyvp) { /* No mutex needed; going to process TTY. */ va_start(ap, fmt); kprintf(fmt, TOTTY, p->p_session->s_ttyp, NULL, ap); va_end(ap); } /* mutex_exit(&proc_lock); XXXSMP */ } void uprintf_locked(const char *fmt, ...) { struct proc *p = curproc; va_list ap; if (p->p_lflag & PL_CONTROLT && p->p_session->s_ttyvp) { /* No mutex needed; going to process TTY. */ va_start(ap, fmt); kprintf(fmt, TOTTY, p->p_session->s_ttyp, NULL, ap); va_end(ap); } } /* * tprintf functions: used to send messages to a specific process * * usage: * get a tpr_t handle on a process "p" by using "tprintf_open(p)" * use the handle when calling "tprintf" * when done, do a "tprintf_close" to drop the handle */ /* * tprintf_open: get a tprintf handle on a process "p" * * => returns NULL if process can't be printed to */ tpr_t tprintf_open(struct proc *p) { tpr_t cookie; cookie = NULL; mutex_enter(&proc_lock); if (p->p_lflag & PL_CONTROLT && p->p_session->s_ttyvp) { proc_sesshold(p->p_session); cookie = (tpr_t)p->p_session; } mutex_exit(&proc_lock); return cookie; } /* * tprintf_close: dispose of a tprintf handle obtained with tprintf_open */ void tprintf_close(tpr_t sess) { if (sess) { mutex_enter(&proc_lock); /* Releases proc_lock. */ proc_sessrele((struct session *)sess); } } /* * tprintf: given tprintf handle to a process [obtained with tprintf_open], * send a message to the controlling tty for that process. * * => also sends message to /dev/klog */ void tprintf(tpr_t tpr, const char *fmt, ...) { struct session *sess = (struct session *)tpr; struct tty *tp = NULL; int flags = TOLOG; va_list ap; /* mutex_enter(&proc_lock); XXXSMP */ if (sess && sess->s_ttyvp && ttycheckoutq(sess->s_ttyp, 0)) { flags |= TOTTY; tp = sess->s_ttyp; } kprintf_lock(); klogpri(LOG_INFO); va_start(ap, fmt); kprintf(fmt, flags, tp, NULL, ap); va_end(ap); kprintf_unlock(); /* mutex_exit(&proc_lock); XXXSMP */ logwakeup(); } /* * ttyprintf: send a message to a specific tty * * => should be used only by tty driver or anything that knows the * underlying tty will not be revoked(2)'d away. [otherwise, * use tprintf] */ void ttyprintf(struct tty *tp, const char *fmt, ...) { va_list ap; /* No mutex needed; going to process TTY. */ va_start(ap, fmt); kprintf(fmt, TOTTY, tp, NULL, ap); va_end(ap); } #ifdef DDB /* * db_printf: printf for DDB (via db_putchar) */ void db_printf(const char *fmt, ...) { va_list ap; /* No mutex needed; DDB pauses all processors. */ va_start(ap, fmt); kprintf(fmt, TODDB, NULL, NULL, ap); va_end(ap); if (db_tee_msgbuf) { va_start(ap, fmt); kprintf(fmt, TOLOG, NULL, NULL, ap); va_end(ap); } } void db_vprintf(const char *fmt, va_list ap) { va_list cap; va_copy(cap, ap); /* No mutex needed; DDB pauses all processors. */ kprintf(fmt, TODDB, NULL, NULL, ap); if (db_tee_msgbuf) kprintf(fmt, TOLOG, NULL, NULL, cap); va_end(cap); } #endif /* DDB */ static void kprintf_internal(const char *fmt, int oflags, void *vp, char *sbuf, ...) { va_list ap; va_start(ap, sbuf); (void)kprintf(fmt, oflags, vp, sbuf, ap); va_end(ap); } /* * Device autoconfiguration printf routines. These change their * behavior based on the AB_* flags in boothowto. If AB_SILENT * is set, messages never go to the console (but they still always * go to the log). AB_VERBOSE overrides AB_SILENT. */ /* * aprint_normal: Send to console unless AB_QUIET. Always goes * to the log. */ static void aprint_normal_internal(const char *prefix, const char *fmt, va_list ap) { int flags = TOLOG; if ((boothowto & (AB_SILENT|AB_QUIET)) == 0 || (boothowto & AB_VERBOSE) != 0) flags |= TOCONS; kprintf_lock(); if (prefix) kprintf_internal("%s: ", flags, NULL, NULL, prefix); kprintf(fmt, flags, NULL, NULL, ap); kprintf_unlock(); if (!panicstr) logwakeup(); } void aprint_normal(const char *fmt, ...) { va_list ap; va_start(ap, fmt); aprint_normal_internal(NULL, fmt, ap); va_end(ap); } void aprint_normal_dev(device_t dv, const char *fmt, ...) { va_list ap; KASSERT(dv != NULL); va_start(ap, fmt); aprint_normal_internal(device_xname(dv), fmt, ap); va_end(ap); } void aprint_normal_ifnet(struct ifnet *ifp, const char *fmt, ...) { va_list ap; KASSERT(ifp != NULL); va_start(ap, fmt); aprint_normal_internal(ifp->if_xname, fmt, ap); va_end(ap); } /* * aprint_error: Send to console unless AB_QUIET. Always goes * to the log. Also counts the number of times called so other * parts of the kernel can report the number of errors during a * given phase of system startup. */ static int aprint_error_count; int aprint_get_error_count(void) { int count; kprintf_lock(); count = aprint_error_count; aprint_error_count = 0; kprintf_unlock(); return (count); } static void aprint_error_internal(const char *prefix, const char *fmt, va_list ap) { int flags = TOLOG; if ((boothowto & (AB_SILENT|AB_QUIET)) == 0 || (boothowto & AB_VERBOSE) != 0) flags |= TOCONS; kprintf_lock(); aprint_error_count++; if (prefix) kprintf_internal("%s: ", flags, NULL, NULL, prefix); kprintf_internal("autoconfiguration error: ", TOLOG, NULL, NULL); kprintf(fmt, flags, NULL, NULL, ap); kprintf_unlock(); if (!panicstr) logwakeup(); } void aprint_error(const char *fmt, ...) { va_list ap; va_start(ap, fmt); aprint_error_internal(NULL, fmt, ap); va_end(ap); } void aprint_error_dev(device_t dv, const char *fmt, ...) { va_list ap; KASSERT(dv != NULL); va_start(ap, fmt); aprint_error_internal(device_xname(dv), fmt, ap); va_end(ap); } void aprint_error_ifnet(struct ifnet *ifp, const char *fmt, ...) { va_list ap; KASSERT(ifp != NULL); va_start(ap, fmt); aprint_error_internal(ifp->if_xname, fmt, ap); va_end(ap); } /* * aprint_naive: Send to console only if AB_QUIET. Never goes * to the log. */ static void aprint_naive_internal(const char *prefix, const char *fmt, va_list ap) { if ((boothowto & (AB_QUIET|AB_SILENT|AB_VERBOSE)) != AB_QUIET) return; kprintf_lock(); if (prefix) kprintf_internal("%s: ", TOCONS, NULL, NULL, prefix); kprintf(fmt, TOCONS, NULL, NULL, ap); kprintf_unlock(); } void aprint_naive(const char *fmt, ...) { va_list ap; va_start(ap, fmt); aprint_naive_internal(NULL, fmt, ap); va_end(ap); } void aprint_naive_dev(device_t dv, const char *fmt, ...) { va_list ap; KASSERT(dv != NULL); va_start(ap, fmt); aprint_naive_internal(device_xname(dv), fmt, ap); va_end(ap); } void aprint_naive_ifnet(struct ifnet *ifp, const char *fmt, ...) { va_list ap; KASSERT(ifp != NULL); va_start(ap, fmt); aprint_naive_internal(ifp->if_xname, fmt, ap); va_end(ap); } /* * aprint_verbose: Send to console only if AB_VERBOSE. Always * goes to the log. */ static void aprint_verbose_internal(const char *prefix, const char *fmt, va_list ap) { int flags = TOLOG; if (boothowto & AB_VERBOSE) flags |= TOCONS; kprintf_lock(); if (prefix) kprintf_internal("%s: ", flags, NULL, NULL, prefix); kprintf(fmt, flags, NULL, NULL, ap); kprintf_unlock(); if (!panicstr) logwakeup(); } void aprint_verbose(const char *fmt, ...) { va_list ap; va_start(ap, fmt); aprint_verbose_internal(NULL, fmt, ap); va_end(ap); } void aprint_verbose_dev(device_t dv, const char *fmt, ...) { va_list ap; KASSERT(dv != NULL); va_start(ap, fmt); aprint_verbose_internal(device_xname(dv), fmt, ap); va_end(ap); } void aprint_verbose_ifnet(struct ifnet *ifp, const char *fmt, ...) { va_list ap; KASSERT(ifp != NULL); va_start(ap, fmt); aprint_verbose_internal(ifp->if_xname, fmt, ap); va_end(ap); } /* * aprint_debug: Send to console and log only if AB_DEBUG. */ static void aprint_debug_internal(const char *prefix, const char *fmt, va_list ap) { if ((boothowto & AB_DEBUG) == 0) return; kprintf_lock(); if (prefix) kprintf_internal("%s: ", TOCONS | TOLOG, NULL, NULL, prefix); kprintf(fmt, TOCONS | TOLOG, NULL, NULL, ap); kprintf_unlock(); } void aprint_debug(const char *fmt, ...) { va_list ap; va_start(ap, fmt); aprint_debug_internal(NULL, fmt, ap); va_end(ap); } void aprint_debug_dev(device_t dv, const char *fmt, ...) { va_list ap; KASSERT(dv != NULL); va_start(ap, fmt); aprint_debug_internal(device_xname(dv), fmt, ap); va_end(ap); } void aprint_debug_ifnet(struct ifnet *ifp, const char *fmt, ...) { va_list ap; KASSERT(ifp != NULL); va_start(ap, fmt); aprint_debug_internal(ifp->if_xname, fmt, ap); va_end(ap); } void vprintf_flags(int flags, const char *fmt, va_list ap) { kprintf_lock(); kprintf(fmt, flags, NULL, NULL, ap); kprintf_unlock(); } void printf_flags(int flags, const char *fmt, ...) { va_list ap; va_start(ap, fmt); vprintf_flags(flags, fmt, ap); va_end(ap); } void printf_tolog(const char *fmt, ...) { va_list ap; va_start(ap, fmt); vprintf_flags(TOLOG, fmt, ap); va_end(ap); } /* * printf_nolog: Like printf(), but does not send message to the log. */ void printf_nolog(const char *fmt, ...) { va_list ap; va_start(ap, fmt); vprintf_flags(TOCONS, fmt, ap); va_end(ap); } /* * printf_nostamp: Like printf(), but does not prepend a timestamp. */ void printf_nostamp(const char *fmt, ...) { va_list ap; va_start(ap, fmt); vprintf_flags(TOCONS|NOTSTAMP, fmt, ap); va_end(ap); } /* * normal kernel printf functions: printf, vprintf, snprintf, vsnprintf */ /* * printf: print a message to the console and the log */ void printf(const char *fmt, ...) { va_list ap; va_start(ap, fmt); vprintf_flags(TOCONS | TOLOG, fmt, ap); va_end(ap); } /* * vprintf: print a message to the console and the log [already have * va_list] */ void vprintf(const char *fmt, va_list ap) { vprintf_flags(TOCONS | TOLOG, fmt, ap); if (!panicstr) logwakeup(); } /* * snprintf: print a message to a buffer */ int snprintf(char *bf, size_t size, const char *fmt, ...) { int retval; va_list ap; va_start(ap, fmt); retval = vsnprintf(bf, size, fmt, ap); va_end(ap); return retval; } /* * vsnprintf: print a message to a buffer [already have va_list] */ int vsnprintf(char *bf, size_t size, const char *fmt, va_list ap) { int retval; char *p; p = bf + size; retval = kprintf(fmt, TOBUFONLY, &p, bf, ap); if (bf && size > 0) { /* nul terminate */ if (size <= (size_t)retval) bf[size - 1] = '\0'; else bf[retval] = '\0'; } return retval; } int vasprintf(char **bf, const char *fmt, va_list ap) { int retval; va_list cap; va_copy(cap, ap); retval = kprintf(fmt, TOBUFONLY, NULL, NULL, cap) + 1; va_end(cap); *bf = kmem_alloc(retval, KM_SLEEP); return vsnprintf(*bf, retval, fmt, ap); } /* * kprintf: scaled down version of printf(3). * * this version based on vfprintf() from libc which was derived from * software contributed to Berkeley by Chris Torek. * * NOTE: The kprintf mutex must be held if we're going TOBUF or TOCONS! */ /* * macros for converting digits to letters and vice versa */ #define to_digit(c) ((c) - '0') #define is_digit(c) ((unsigned)to_digit(c) <= 9) #define to_char(n) ((n) + '0') /* * flags used during conversion. */ #define ALT 0x001 /* alternate form */ #define HEXPREFIX 0x002 /* add 0x or 0X prefix */ #define LADJUST 0x004 /* left adjustment */ #define LONGDBL 0x008 /* long double; unimplemented */ #define LONGINT 0x010 /* long integer */ #define QUADINT 0x020 /* quad integer */ #define SHORTINT 0x040 /* short integer */ #define MAXINT 0x080 /* intmax_t */ #define PTRINT 0x100 /* intptr_t */ #define SIZEINT 0x200 /* size_t */ #define ZEROPAD 0x400 /* zero (as opposed to blank) pad */ #define FPT 0x800 /* Floating point number */ /* * To extend shorts properly, we need both signed and unsigned * argument extraction methods. */ #define SARG() \ (flags&MAXINT ? va_arg(ap, intmax_t) : \ flags&PTRINT ? va_arg(ap, intptr_t) : \ flags&SIZEINT ? va_arg(ap, ssize_t) : /* XXX */ \ flags&QUADINT ? va_arg(ap, quad_t) : \ flags&LONGINT ? va_arg(ap, long) : \ flags&SHORTINT ? (long)(short)va_arg(ap, int) : \ (long)va_arg(ap, int)) #define UARG() \ (flags&MAXINT ? va_arg(ap, uintmax_t) : \ flags&PTRINT ? va_arg(ap, uintptr_t) : \ flags&SIZEINT ? va_arg(ap, size_t) : \ flags&QUADINT ? va_arg(ap, u_quad_t) : \ flags&LONGINT ? va_arg(ap, u_long) : \ flags&SHORTINT ? (u_long)(u_short)va_arg(ap, int) : \ (u_long)va_arg(ap, u_int)) #define KPRINTF_PUTCHAR(C) { \ if (oflags == TOBUFONLY) { \ if (sbuf && ((vp == NULL) || (sbuf < tailp))) \ *sbuf++ = (C); \ } else { \ putchar((C), oflags, vp); \ } \ } void device_printf(device_t dev, const char *fmt, ...) { va_list ap; va_start(ap, fmt); printf("%s: ", device_xname(dev)); vprintf(fmt, ap); va_end(ap); return; } /* * Guts of kernel printf. Note, we already expect to be in a mutex! */ int kprintf(const char *fmt0, int oflags, void *vp, char *sbuf, va_list ap) { const char *fmt; /* format string */ int ch; /* character from fmt */ int n; /* handy integer (short term usage) */ char *cp; /* handy char pointer (short term usage) */ int flags; /* flags as above */ int ret; /* return value accumulator */ int width; /* width from format (%8d), or 0 */ int prec; /* precision from format (%.3d), or -1 */ char sign; /* sign prefix (' ', '+', '-', or \0) */ u_quad_t _uquad; /* integer arguments %[diouxX] */ enum { OCT, DEC, HEX } base;/* base for [diouxX] conversion */ int dprec; /* a copy of prec if [diouxX], 0 otherwise */ int realsz; /* field size expanded by dprec */ int size; /* size of converted field or string */ const char *xdigs; /* digits for [xX] conversion */ char bf[KPRINTF_BUFSIZE]; /* space for %c, %[diouxX] */ char *tailp; /* tail pointer for snprintf */ if (oflags == TOBUFONLY && (vp != NULL)) tailp = *(char **)vp; else tailp = NULL; cp = NULL; /* XXX: shutup gcc */ size = 0; /* XXX: shutup gcc */ fmt = fmt0; ret = 0; xdigs = NULL; /* XXX: shut up gcc warning */ /* * Scan the format for conversions (`%' character). */ for (;;) { for (; *fmt != '%' && *fmt; fmt++) { ret++; KPRINTF_PUTCHAR(*fmt); } if (*fmt == 0) goto done; fmt++; /* skip over '%' */ flags = 0; dprec = 0; width = 0; prec = -1; sign = '\0'; rflag: ch = *fmt++; reswitch: switch (ch) { case ' ': /* * ``If the space and + flags both appear, the space * flag will be ignored.'' * -- ANSI X3J11 */ if (!sign) sign = ' '; goto rflag; case '#': flags |= ALT; goto rflag; case '*': /* * ``A negative field width argument is taken as a * - flag followed by a positive field width.'' * -- ANSI X3J11 * They don't exclude field widths read from args. */ if ((width = va_arg(ap, int)) >= 0) goto rflag; width = -width; /* FALLTHROUGH */ case '-': flags |= LADJUST; goto rflag; case '+': sign = '+'; goto rflag; case '.': if ((ch = *fmt++) == '*') { n = va_arg(ap, int); prec = n < 0 ? -1 : n; goto rflag; } n = 0; while (is_digit(ch)) { n = 10 * n + to_digit(ch); ch = *fmt++; } prec = n < 0 ? -1 : n; goto reswitch; case '0': /* * ``Note that 0 is taken as a flag, not as the * beginning of a field width.'' * -- ANSI X3J11 */ flags |= ZEROPAD; goto rflag; case '1': case '2': case '3': case '4': case '5': case '6': case '7': case '8': case '9': n = 0; do { n = 10 * n + to_digit(ch); ch = *fmt++; } while (is_digit(ch)); width = n; goto reswitch; case 'h': flags |= SHORTINT; goto rflag; case 'j': flags |= MAXINT; goto rflag; case 'l': if (*fmt == 'l') { fmt++; flags |= QUADINT; } else { flags |= LONGINT; } goto rflag; case 'q': flags |= QUADINT; goto rflag; case 't': flags |= PTRINT; goto rflag; case 'z': flags |= SIZEINT; goto rflag; case 'c': *(cp = bf) = va_arg(ap, int); size = 1; sign = '\0'; break; case 'D': flags |= LONGINT; /*FALLTHROUGH*/ case 'd': case 'i': _uquad = SARG(); if ((quad_t)_uquad < 0) { _uquad = -_uquad; sign = '-'; } base = DEC; goto number; case 'n': /* no %n support in the kernel, consume and skip */ if (flags & MAXINT) (void)va_arg(ap, intmax_t *); else if (flags & PTRINT) (void)va_arg(ap, intptr_t *); else if (flags & SIZEINT) (void)va_arg(ap, ssize_t *); else if (flags & QUADINT) (void)va_arg(ap, quad_t *); else if (flags & LONGINT) (void)va_arg(ap, long *); else if (flags & SHORTINT) (void)va_arg(ap, short *); else (void)va_arg(ap, int *); continue; /* no output */ case 'O': flags |= LONGINT; /*FALLTHROUGH*/ case 'o': _uquad = UARG(); base = OCT; goto nosign; case 'p': /* * ``The argument shall be a pointer to void. The * value of the pointer is converted to a sequence * of printable characters, in an implementation- * defined manner.'' * -- ANSI X3J11 */ /* NOSTRICT */ _uquad = (u_long)va_arg(ap, void *); base = HEX; xdigs = hexdigits; flags |= HEXPREFIX; ch = 'x'; goto nosign; case 's': if ((cp = va_arg(ap, char *)) == NULL) /*XXXUNCONST*/ cp = __UNCONST("(null)"); if (prec >= 0) { /* * can't use strlen; can only look for the * NUL in the first `prec' characters, and * strlen() will go further. */ char *p = memchr(cp, 0, prec); if (p != NULL) { size = p - cp; if (size > prec) size = prec; } else size = prec; } else size = strlen(cp); sign = '\0'; break; case 'U': flags |= LONGINT; /*FALLTHROUGH*/ case 'u': _uquad = UARG(); base = DEC; goto nosign; case 'X': xdigs = HEXDIGITS; goto hex; case 'x': xdigs = hexdigits; hex: _uquad = UARG(); base = HEX; /* leading 0x/X only if non-zero */ if (flags & ALT && _uquad != 0) flags |= HEXPREFIX; /* unsigned conversions */ nosign: sign = '\0'; /* * ``... diouXx conversions ... if a precision is * specified, the 0 flag will be ignored.'' * -- ANSI X3J11 */ number: if ((dprec = prec) >= 0) flags &= ~ZEROPAD; /* * ``The result of converting a zero value with an * explicit precision of zero is no characters.'' * -- ANSI X3J11 */ cp = bf + KPRINTF_BUFSIZE; if (_uquad != 0 || prec != 0) { /* * Unsigned mod is hard, and unsigned mod * by a constant is easier than that by * a variable; hence this switch. */ switch (base) { case OCT: do { *--cp = to_char(_uquad & 7); _uquad >>= 3; } while (_uquad); /* handle octal leading 0 */ if (flags & ALT && *cp != '0') *--cp = '0'; break; case DEC: /* many numbers are 1 digit */ while (_uquad >= 10) { *--cp = to_char(_uquad % 10); _uquad /= 10; } *--cp = to_char(_uquad); break; case HEX: do { *--cp = xdigs[_uquad & 15]; _uquad >>= 4; } while (_uquad); break; default: /*XXXUNCONST*/ cp = __UNCONST("bug in kprintf: bad base"); size = strlen(cp); goto skipsize; } } size = bf + KPRINTF_BUFSIZE - cp; skipsize: break; default: /* "%?" prints ?, unless ? is NUL */ if (ch == '\0') goto done; /* pretend it was %c with argument ch */ cp = bf; *cp = ch; size = 1; sign = '\0'; break; } /* * All reasonable formats wind up here. At this point, `cp' * points to a string which (if not flags&LADJUST) should be * padded out to `width' places. If flags&ZEROPAD, it should * first be prefixed by any sign or other prefix; otherwise, * it should be blank padded before the prefix is emitted. * After any left-hand padding and prefixing, emit zeroes * required by a decimal [diouxX] precision, then print the * string proper, then emit zeroes required by any leftover * floating precision; finally, if LADJUST, pad with blanks. * * Compute actual size, so we know how much to pad. * size excludes decimal prec; realsz includes it. */ realsz = dprec > size ? dprec : size; if (sign) realsz++; else if (flags & HEXPREFIX) realsz+= 2; /* adjust ret */ ret += width > realsz ? width : realsz; /* right-adjusting blank padding */ if ((flags & (LADJUST|ZEROPAD)) == 0) { n = width - realsz; while (n-- > 0) KPRINTF_PUTCHAR(' '); } /* prefix */ if (sign) { KPRINTF_PUTCHAR(sign); } else if (flags & HEXPREFIX) { KPRINTF_PUTCHAR('0'); KPRINTF_PUTCHAR(ch); } /* right-adjusting zero padding */ if ((flags & (LADJUST|ZEROPAD)) == ZEROPAD) { n = width - realsz; while (n-- > 0) KPRINTF_PUTCHAR('0'); } /* leading zeroes from decimal precision */ n = dprec - size; while (n-- > 0) KPRINTF_PUTCHAR('0'); /* the string or number proper */ for (; size--; cp++) KPRINTF_PUTCHAR(*cp); /* left-adjusting padding (always blank) */ if (flags & LADJUST) { n = width - realsz; while (n-- > 0) KPRINTF_PUTCHAR(' '); } } done: if ((oflags == TOBUFONLY) && (vp != NULL)) *(char **)vp = sbuf; (*v_flush)(); #ifdef RND_PRINTF if (__predict_true(kprintf_inited)) rnd_add_data_intr(&rnd_printf_source, NULL, 0, 0); #endif return ret; }