1 /*- 2 * SPDX-License-Identifier: BSD-3-Clause 3 * 4 * Copyright (c) 1986, 1988, 1991, 1993 5 * The Regents of the University of California. All rights reserved. 6 * (c) UNIX System Laboratories, Inc. 7 * All or some portions of this file are derived from material licensed 8 * to the University of California by American Telephone and Telegraph 9 * Co. or Unix System Laboratories, Inc. and are reproduced herein with 10 * the permission of UNIX System Laboratories, Inc. 11 * 12 * Redistribution and use in source and binary forms, with or without 13 * modification, are permitted provided that the following conditions 14 * are met: 15 * 1. Redistributions of source code must retain the above copyright 16 * notice, this list of conditions and the following disclaimer. 17 * 2. Redistributions in binary form must reproduce the above copyright 18 * notice, this list of conditions and the following disclaimer in the 19 * documentation and/or other materials provided with the distribution. 20 * 3. Neither the name of the University nor the names of its contributors 21 * may be used to endorse or promote products derived from this software 22 * without specific prior written permission. 23 * 24 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 27 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 34 * SUCH DAMAGE. 35 * 36 * @(#)subr_prf.c 8.3 (Berkeley) 1/21/94 37 */ 38 39 #include <sys/cdefs.h> 40 __FBSDID("$FreeBSD$"); 41 42 #ifdef _KERNEL 43 #include "opt_ddb.h" 44 #include "opt_printf.h" 45 #endif /* _KERNEL */ 46 47 #include <sys/param.h> 48 #ifdef _KERNEL 49 #include <sys/systm.h> 50 #include <sys/lock.h> 51 #include <sys/kdb.h> 52 #include <sys/mutex.h> 53 #include <sys/sx.h> 54 #include <sys/kernel.h> 55 #include <sys/msgbuf.h> 56 #include <sys/malloc.h> 57 #include <sys/priv.h> 58 #include <sys/proc.h> 59 #include <sys/stddef.h> 60 #include <sys/sysctl.h> 61 #include <sys/tty.h> 62 #include <sys/syslog.h> 63 #include <sys/cons.h> 64 #include <sys/uio.h> 65 #endif 66 #include <sys/ctype.h> 67 #include <sys/sbuf.h> 68 69 #ifdef DDB 70 #include <ddb/ddb.h> 71 #endif 72 73 /* 74 * Note that stdarg.h and the ANSI style va_start macro is used for both 75 * ANSI and traditional C compilers. 76 */ 77 #ifdef _KERNEL 78 #include <machine/stdarg.h> 79 #else 80 #include <stdarg.h> 81 #endif 82 83 /* 84 * This is needed for sbuf_putbuf() when compiled into userland. Due to the 85 * shared nature of this file, it's the only place to put it. 86 */ 87 #ifndef _KERNEL 88 #include <stdio.h> 89 #endif 90 91 #ifdef _KERNEL 92 93 #define TOCONS 0x01 94 #define TOTTY 0x02 95 #define TOLOG 0x04 96 97 /* Max number conversion buffer length: a u_quad_t in base 2, plus NUL byte. */ 98 #define MAXNBUF (sizeof(intmax_t) * NBBY + 1) 99 100 struct putchar_arg { 101 int flags; 102 int pri; 103 struct tty *tty; 104 char *p_bufr; 105 size_t n_bufr; 106 char *p_next; 107 size_t remain; 108 }; 109 110 struct snprintf_arg { 111 char *str; 112 size_t remain; 113 }; 114 115 extern int log_open; 116 117 static void msglogchar(int c, int pri); 118 static void msglogstr(char *str, int pri, int filter_cr); 119 static void putchar(int ch, void *arg); 120 static char *ksprintn(char *nbuf, uintmax_t num, int base, int *len, int upper); 121 static void snprintf_func(int ch, void *arg); 122 123 static int msgbufmapped; /* Set when safe to use msgbuf */ 124 int msgbuftrigger; 125 struct msgbuf *msgbufp; 126 127 static int log_console_output = 1; 128 SYSCTL_INT(_kern, OID_AUTO, log_console_output, CTLFLAG_RWTUN, 129 &log_console_output, 0, "Duplicate console output to the syslog"); 130 131 /* 132 * See the comment in log_console() below for more explanation of this. 133 */ 134 static int log_console_add_linefeed; 135 SYSCTL_INT(_kern, OID_AUTO, log_console_add_linefeed, CTLFLAG_RWTUN, 136 &log_console_add_linefeed, 0, "log_console() adds extra newlines"); 137 138 static int always_console_output; 139 SYSCTL_INT(_kern, OID_AUTO, always_console_output, CTLFLAG_RWTUN, 140 &always_console_output, 0, "Always output to console despite TIOCCONS"); 141 142 /* 143 * Warn that a system table is full. 144 */ 145 void 146 tablefull(const char *tab) 147 { 148 149 log(LOG_ERR, "%s: table is full\n", tab); 150 } 151 152 /* 153 * Uprintf prints to the controlling terminal for the current process. 154 */ 155 int 156 uprintf(const char *fmt, ...) 157 { 158 va_list ap; 159 struct putchar_arg pca; 160 struct proc *p; 161 struct thread *td; 162 int retval; 163 164 td = curthread; 165 if (TD_IS_IDLETHREAD(td)) 166 return (0); 167 168 sx_slock(&proctree_lock); 169 p = td->td_proc; 170 PROC_LOCK(p); 171 if ((p->p_flag & P_CONTROLT) == 0) { 172 PROC_UNLOCK(p); 173 sx_sunlock(&proctree_lock); 174 return (0); 175 } 176 SESS_LOCK(p->p_session); 177 pca.tty = p->p_session->s_ttyp; 178 SESS_UNLOCK(p->p_session); 179 PROC_UNLOCK(p); 180 if (pca.tty == NULL) { 181 sx_sunlock(&proctree_lock); 182 return (0); 183 } 184 pca.flags = TOTTY; 185 pca.p_bufr = NULL; 186 va_start(ap, fmt); 187 tty_lock(pca.tty); 188 sx_sunlock(&proctree_lock); 189 retval = kvprintf(fmt, putchar, &pca, 10, ap); 190 tty_unlock(pca.tty); 191 va_end(ap); 192 return (retval); 193 } 194 195 /* 196 * tprintf and vtprintf print on the controlling terminal associated with the 197 * given session, possibly to the log as well. 198 */ 199 void 200 tprintf(struct proc *p, int pri, const char *fmt, ...) 201 { 202 va_list ap; 203 204 va_start(ap, fmt); 205 vtprintf(p, pri, fmt, ap); 206 va_end(ap); 207 } 208 209 void 210 vtprintf(struct proc *p, int pri, const char *fmt, va_list ap) 211 { 212 struct tty *tp = NULL; 213 int flags = 0; 214 struct putchar_arg pca; 215 struct session *sess = NULL; 216 217 sx_slock(&proctree_lock); 218 if (pri != -1) 219 flags |= TOLOG; 220 if (p != NULL) { 221 PROC_LOCK(p); 222 if (p->p_flag & P_CONTROLT && p->p_session->s_ttyvp) { 223 sess = p->p_session; 224 sess_hold(sess); 225 PROC_UNLOCK(p); 226 tp = sess->s_ttyp; 227 if (tp != NULL && tty_checkoutq(tp)) 228 flags |= TOTTY; 229 else 230 tp = NULL; 231 } else 232 PROC_UNLOCK(p); 233 } 234 pca.pri = pri; 235 pca.tty = tp; 236 pca.flags = flags; 237 pca.p_bufr = NULL; 238 if (pca.tty != NULL) 239 tty_lock(pca.tty); 240 sx_sunlock(&proctree_lock); 241 kvprintf(fmt, putchar, &pca, 10, ap); 242 if (pca.tty != NULL) 243 tty_unlock(pca.tty); 244 if (sess != NULL) 245 sess_release(sess); 246 msgbuftrigger = 1; 247 } 248 249 /* 250 * Ttyprintf displays a message on a tty; it should be used only by 251 * the tty driver, or anything that knows the underlying tty will not 252 * be revoke(2)'d away. Other callers should use tprintf. 253 */ 254 int 255 ttyprintf(struct tty *tp, const char *fmt, ...) 256 { 257 va_list ap; 258 struct putchar_arg pca; 259 int retval; 260 261 va_start(ap, fmt); 262 pca.tty = tp; 263 pca.flags = TOTTY; 264 pca.p_bufr = NULL; 265 retval = kvprintf(fmt, putchar, &pca, 10, ap); 266 va_end(ap); 267 return (retval); 268 } 269 270 static int 271 _vprintf(int level, int flags, const char *fmt, va_list ap) 272 { 273 struct putchar_arg pca; 274 int retval; 275 #ifdef PRINTF_BUFR_SIZE 276 char bufr[PRINTF_BUFR_SIZE]; 277 #endif 278 279 TSENTER(); 280 pca.tty = NULL; 281 pca.pri = level; 282 pca.flags = flags; 283 #ifdef PRINTF_BUFR_SIZE 284 pca.p_bufr = bufr; 285 pca.p_next = pca.p_bufr; 286 pca.n_bufr = sizeof(bufr); 287 pca.remain = sizeof(bufr); 288 *pca.p_next = '\0'; 289 #else 290 /* Don't buffer console output. */ 291 pca.p_bufr = NULL; 292 #endif 293 294 retval = kvprintf(fmt, putchar, &pca, 10, ap); 295 296 #ifdef PRINTF_BUFR_SIZE 297 /* Write any buffered console/log output: */ 298 if (*pca.p_bufr != '\0') { 299 if (pca.flags & TOLOG) 300 msglogstr(pca.p_bufr, level, /*filter_cr*/1); 301 302 if (pca.flags & TOCONS) 303 cnputs(pca.p_bufr); 304 } 305 #endif 306 307 TSEXIT(); 308 return (retval); 309 } 310 311 /* 312 * Log writes to the log buffer, and guarantees not to sleep (so can be 313 * called by interrupt routines). If there is no process reading the 314 * log yet, it writes to the console also. 315 */ 316 void 317 log(int level, const char *fmt, ...) 318 { 319 va_list ap; 320 321 va_start(ap, fmt); 322 vlog(level, fmt, ap); 323 va_end(ap); 324 } 325 326 void 327 vlog(int level, const char *fmt, va_list ap) 328 { 329 330 (void)_vprintf(level, log_open ? TOLOG : TOCONS | TOLOG, fmt, ap); 331 msgbuftrigger = 1; 332 } 333 334 #define CONSCHUNK 128 335 336 void 337 log_console(struct uio *uio) 338 { 339 int c, error, nl; 340 char *consbuffer; 341 int pri; 342 343 if (!log_console_output) 344 return; 345 346 pri = LOG_INFO | LOG_CONSOLE; 347 uio = cloneuio(uio); 348 consbuffer = malloc(CONSCHUNK, M_TEMP, M_WAITOK); 349 350 nl = 0; 351 while (uio->uio_resid > 0) { 352 c = imin(uio->uio_resid, CONSCHUNK - 1); 353 error = uiomove(consbuffer, c, uio); 354 if (error != 0) 355 break; 356 /* Make sure we're NUL-terminated */ 357 consbuffer[c] = '\0'; 358 if (consbuffer[c - 1] == '\n') 359 nl = 1; 360 else 361 nl = 0; 362 msglogstr(consbuffer, pri, /*filter_cr*/ 1); 363 } 364 /* 365 * The previous behavior in log_console() is preserved when 366 * log_console_add_linefeed is non-zero. For that behavior, if an 367 * individual console write came in that was not terminated with a 368 * line feed, it would add a line feed. 369 * 370 * This results in different data in the message buffer than 371 * appears on the system console (which doesn't add extra line feed 372 * characters). 373 * 374 * A number of programs and rc scripts write a line feed, or a period 375 * and a line feed when they have completed their operation. On 376 * the console, this looks seamless, but when displayed with 377 * 'dmesg -a', you wind up with output that looks like this: 378 * 379 * Updating motd: 380 * . 381 * 382 * On the console, it looks like this: 383 * Updating motd:. 384 * 385 * We could add logic to detect that situation, or just not insert 386 * the extra newlines. Set the kern.log_console_add_linefeed 387 * sysctl/tunable variable to get the old behavior. 388 */ 389 if (!nl && log_console_add_linefeed) { 390 consbuffer[0] = '\n'; 391 consbuffer[1] = '\0'; 392 msglogstr(consbuffer, pri, /*filter_cr*/ 1); 393 } 394 msgbuftrigger = 1; 395 free(uio, M_IOV); 396 free(consbuffer, M_TEMP); 397 } 398 399 int 400 printf(const char *fmt, ...) 401 { 402 va_list ap; 403 int retval; 404 405 va_start(ap, fmt); 406 retval = vprintf(fmt, ap); 407 va_end(ap); 408 409 return (retval); 410 } 411 412 int 413 vprintf(const char *fmt, va_list ap) 414 { 415 int retval; 416 417 retval = _vprintf(-1, TOCONS | TOLOG, fmt, ap); 418 419 if (!panicstr) 420 msgbuftrigger = 1; 421 422 return (retval); 423 } 424 425 static void 426 prf_putbuf(char *bufr, int flags, int pri) 427 { 428 429 if (flags & TOLOG) 430 msglogstr(bufr, pri, /*filter_cr*/1); 431 432 if (flags & TOCONS) { 433 if ((panicstr == NULL) && (constty != NULL)) 434 msgbuf_addstr(&consmsgbuf, -1, 435 bufr, /*filter_cr*/ 0); 436 437 if ((constty == NULL) ||(always_console_output)) 438 cnputs(bufr); 439 } 440 } 441 442 static void 443 putbuf(int c, struct putchar_arg *ap) 444 { 445 /* Check if no console output buffer was provided. */ 446 if (ap->p_bufr == NULL) { 447 /* Output direct to the console. */ 448 if (ap->flags & TOCONS) 449 cnputc(c); 450 451 if (ap->flags & TOLOG) 452 msglogchar(c, ap->pri); 453 } else { 454 /* Buffer the character: */ 455 *ap->p_next++ = c; 456 ap->remain--; 457 458 /* Always leave the buffer zero terminated. */ 459 *ap->p_next = '\0'; 460 461 /* Check if the buffer needs to be flushed. */ 462 if (ap->remain == 2 || c == '\n') { 463 prf_putbuf(ap->p_bufr, ap->flags, ap->pri); 464 465 ap->p_next = ap->p_bufr; 466 ap->remain = ap->n_bufr; 467 *ap->p_next = '\0'; 468 } 469 470 /* 471 * Since we fill the buffer up one character at a time, 472 * this should not happen. We should always catch it when 473 * ap->remain == 2 (if not sooner due to a newline), flush 474 * the buffer and move on. One way this could happen is 475 * if someone sets PRINTF_BUFR_SIZE to 1 or something 476 * similarly silly. 477 */ 478 KASSERT(ap->remain > 2, ("Bad buffer logic, remain = %zd", 479 ap->remain)); 480 } 481 } 482 483 /* 484 * Print a character on console or users terminal. If destination is 485 * the console then the last bunch of characters are saved in msgbuf for 486 * inspection later. 487 */ 488 static void 489 putchar(int c, void *arg) 490 { 491 struct putchar_arg *ap = (struct putchar_arg*) arg; 492 struct tty *tp = ap->tty; 493 int flags = ap->flags; 494 495 /* Don't use the tty code after a panic or while in ddb. */ 496 if (kdb_active) { 497 if (c != '\0') 498 cnputc(c); 499 return; 500 } 501 502 if ((flags & TOTTY) && tp != NULL && panicstr == NULL) 503 tty_putchar(tp, c); 504 505 if ((flags & (TOCONS | TOLOG)) && c != '\0') 506 putbuf(c, ap); 507 } 508 509 /* 510 * Scaled down version of sprintf(3). 511 */ 512 int 513 sprintf(char *buf, const char *cfmt, ...) 514 { 515 int retval; 516 va_list ap; 517 518 va_start(ap, cfmt); 519 retval = kvprintf(cfmt, NULL, (void *)buf, 10, ap); 520 buf[retval] = '\0'; 521 va_end(ap); 522 return (retval); 523 } 524 525 /* 526 * Scaled down version of vsprintf(3). 527 */ 528 int 529 vsprintf(char *buf, const char *cfmt, va_list ap) 530 { 531 int retval; 532 533 retval = kvprintf(cfmt, NULL, (void *)buf, 10, ap); 534 buf[retval] = '\0'; 535 return (retval); 536 } 537 538 /* 539 * Scaled down version of snprintf(3). 540 */ 541 int 542 snprintf(char *str, size_t size, const char *format, ...) 543 { 544 int retval; 545 va_list ap; 546 547 va_start(ap, format); 548 retval = vsnprintf(str, size, format, ap); 549 va_end(ap); 550 return(retval); 551 } 552 553 /* 554 * Scaled down version of vsnprintf(3). 555 */ 556 int 557 vsnprintf(char *str, size_t size, const char *format, va_list ap) 558 { 559 struct snprintf_arg info; 560 int retval; 561 562 info.str = str; 563 info.remain = size; 564 retval = kvprintf(format, snprintf_func, &info, 10, ap); 565 if (info.remain >= 1) 566 *info.str++ = '\0'; 567 return (retval); 568 } 569 570 /* 571 * Kernel version which takes radix argument vsnprintf(3). 572 */ 573 int 574 vsnrprintf(char *str, size_t size, int radix, const char *format, va_list ap) 575 { 576 struct snprintf_arg info; 577 int retval; 578 579 info.str = str; 580 info.remain = size; 581 retval = kvprintf(format, snprintf_func, &info, radix, ap); 582 if (info.remain >= 1) 583 *info.str++ = '\0'; 584 return (retval); 585 } 586 587 static void 588 snprintf_func(int ch, void *arg) 589 { 590 struct snprintf_arg *const info = arg; 591 592 if (info->remain >= 2) { 593 *info->str++ = ch; 594 info->remain--; 595 } 596 } 597 598 /* 599 * Put a NUL-terminated ASCII number (base <= 36) in a buffer in reverse 600 * order; return an optional length and a pointer to the last character 601 * written in the buffer (i.e., the first character of the string). 602 * The buffer pointed to by `nbuf' must have length >= MAXNBUF. 603 */ 604 static char * 605 ksprintn(char *nbuf, uintmax_t num, int base, int *lenp, int upper) 606 { 607 char *p, c; 608 609 p = nbuf; 610 *p = '\0'; 611 do { 612 c = hex2ascii(num % base); 613 *++p = upper ? toupper(c) : c; 614 } while (num /= base); 615 if (lenp) 616 *lenp = p - nbuf; 617 return (p); 618 } 619 620 /* 621 * Scaled down version of printf(3). 622 * 623 * Two additional formats: 624 * 625 * The format %b is supported to decode error registers. 626 * Its usage is: 627 * 628 * printf("reg=%b\n", regval, "<base><arg>*"); 629 * 630 * where <base> is the output base expressed as a control character, e.g. 631 * \10 gives octal; \20 gives hex. Each arg is a sequence of characters, 632 * the first of which gives the bit number to be inspected (origin 1), and 633 * the next characters (up to a control character, i.e. a character <= 32), 634 * give the name of the register. Thus: 635 * 636 * kvprintf("reg=%b\n", 3, "\10\2BITTWO\1BITONE"); 637 * 638 * would produce output: 639 * 640 * reg=3<BITTWO,BITONE> 641 * 642 * XXX: %D -- Hexdump, takes pointer and separator string: 643 * ("%6D", ptr, ":") -> XX:XX:XX:XX:XX:XX 644 * ("%*D", len, ptr, " " -> XX XX XX XX ... 645 */ 646 int 647 kvprintf(char const *fmt, void (*func)(int, void*), void *arg, int radix, va_list ap) 648 { 649 #define PCHAR(c) {int cc=(c); if (func) (*func)(cc,arg); else *d++ = cc; retval++; } 650 char nbuf[MAXNBUF]; 651 char *d; 652 const char *p, *percent, *q; 653 u_char *up; 654 int ch, n; 655 uintmax_t num; 656 int base, lflag, qflag, tmp, width, ladjust, sharpflag, neg, sign, dot; 657 int cflag, hflag, jflag, tflag, zflag; 658 int bconv, dwidth, upper; 659 char padc; 660 int stop = 0, retval = 0; 661 662 num = 0; 663 q = NULL; 664 if (!func) 665 d = (char *) arg; 666 else 667 d = NULL; 668 669 if (fmt == NULL) 670 fmt = "(fmt null)\n"; 671 672 if (radix < 2 || radix > 36) 673 radix = 10; 674 675 for (;;) { 676 padc = ' '; 677 width = 0; 678 while ((ch = (u_char)*fmt++) != '%' || stop) { 679 if (ch == '\0') 680 return (retval); 681 PCHAR(ch); 682 } 683 percent = fmt - 1; 684 qflag = 0; lflag = 0; ladjust = 0; sharpflag = 0; neg = 0; 685 sign = 0; dot = 0; bconv = 0; dwidth = 0; upper = 0; 686 cflag = 0; hflag = 0; jflag = 0; tflag = 0; zflag = 0; 687 reswitch: switch (ch = (u_char)*fmt++) { 688 case '.': 689 dot = 1; 690 goto reswitch; 691 case '#': 692 sharpflag = 1; 693 goto reswitch; 694 case '+': 695 sign = 1; 696 goto reswitch; 697 case '-': 698 ladjust = 1; 699 goto reswitch; 700 case '%': 701 PCHAR(ch); 702 break; 703 case '*': 704 if (!dot) { 705 width = va_arg(ap, int); 706 if (width < 0) { 707 ladjust = !ladjust; 708 width = -width; 709 } 710 } else { 711 dwidth = va_arg(ap, int); 712 } 713 goto reswitch; 714 case '0': 715 if (!dot) { 716 padc = '0'; 717 goto reswitch; 718 } 719 case '1': case '2': case '3': case '4': 720 case '5': case '6': case '7': case '8': case '9': 721 for (n = 0;; ++fmt) { 722 n = n * 10 + ch - '0'; 723 ch = *fmt; 724 if (ch < '0' || ch > '9') 725 break; 726 } 727 if (dot) 728 dwidth = n; 729 else 730 width = n; 731 goto reswitch; 732 case 'b': 733 ladjust = 1; 734 bconv = 1; 735 goto handle_nosign; 736 case 'c': 737 width -= 1; 738 739 if (!ladjust && width > 0) 740 while (width--) 741 PCHAR(padc); 742 PCHAR(va_arg(ap, int)); 743 if (ladjust && width > 0) 744 while (width--) 745 PCHAR(padc); 746 break; 747 case 'D': 748 up = va_arg(ap, u_char *); 749 p = va_arg(ap, char *); 750 if (!width) 751 width = 16; 752 while(width--) { 753 PCHAR(hex2ascii(*up >> 4)); 754 PCHAR(hex2ascii(*up & 0x0f)); 755 up++; 756 if (width) 757 for (q=p;*q;q++) 758 PCHAR(*q); 759 } 760 break; 761 case 'd': 762 case 'i': 763 base = 10; 764 sign = 1; 765 goto handle_sign; 766 case 'h': 767 if (hflag) { 768 hflag = 0; 769 cflag = 1; 770 } else 771 hflag = 1; 772 goto reswitch; 773 case 'j': 774 jflag = 1; 775 goto reswitch; 776 case 'l': 777 if (lflag) { 778 lflag = 0; 779 qflag = 1; 780 } else 781 lflag = 1; 782 goto reswitch; 783 case 'n': 784 if (jflag) 785 *(va_arg(ap, intmax_t *)) = retval; 786 else if (qflag) 787 *(va_arg(ap, quad_t *)) = retval; 788 else if (lflag) 789 *(va_arg(ap, long *)) = retval; 790 else if (zflag) 791 *(va_arg(ap, size_t *)) = retval; 792 else if (hflag) 793 *(va_arg(ap, short *)) = retval; 794 else if (cflag) 795 *(va_arg(ap, char *)) = retval; 796 else 797 *(va_arg(ap, int *)) = retval; 798 break; 799 case 'o': 800 base = 8; 801 goto handle_nosign; 802 case 'p': 803 base = 16; 804 sharpflag = (width == 0); 805 sign = 0; 806 num = (uintptr_t)va_arg(ap, void *); 807 goto number; 808 case 'q': 809 qflag = 1; 810 goto reswitch; 811 case 'r': 812 base = radix; 813 if (sign) 814 goto handle_sign; 815 goto handle_nosign; 816 case 's': 817 p = va_arg(ap, char *); 818 if (p == NULL) 819 p = "(null)"; 820 if (!dot) 821 n = strlen (p); 822 else 823 for (n = 0; n < dwidth && p[n]; n++) 824 continue; 825 826 width -= n; 827 828 if (!ladjust && width > 0) 829 while (width--) 830 PCHAR(padc); 831 while (n--) 832 PCHAR(*p++); 833 if (ladjust && width > 0) 834 while (width--) 835 PCHAR(padc); 836 break; 837 case 't': 838 tflag = 1; 839 goto reswitch; 840 case 'u': 841 base = 10; 842 goto handle_nosign; 843 case 'X': 844 upper = 1; 845 case 'x': 846 base = 16; 847 goto handle_nosign; 848 case 'y': 849 base = 16; 850 sign = 1; 851 goto handle_sign; 852 case 'z': 853 zflag = 1; 854 goto reswitch; 855 handle_nosign: 856 sign = 0; 857 if (jflag) 858 num = va_arg(ap, uintmax_t); 859 else if (qflag) 860 num = va_arg(ap, u_quad_t); 861 else if (tflag) 862 num = va_arg(ap, ptrdiff_t); 863 else if (lflag) 864 num = va_arg(ap, u_long); 865 else if (zflag) 866 num = va_arg(ap, size_t); 867 else if (hflag) 868 num = (u_short)va_arg(ap, int); 869 else if (cflag) 870 num = (u_char)va_arg(ap, int); 871 else 872 num = va_arg(ap, u_int); 873 if (bconv) { 874 q = va_arg(ap, char *); 875 base = *q++; 876 } 877 goto number; 878 handle_sign: 879 if (jflag) 880 num = va_arg(ap, intmax_t); 881 else if (qflag) 882 num = va_arg(ap, quad_t); 883 else if (tflag) 884 num = va_arg(ap, ptrdiff_t); 885 else if (lflag) 886 num = va_arg(ap, long); 887 else if (zflag) 888 num = va_arg(ap, ssize_t); 889 else if (hflag) 890 num = (short)va_arg(ap, int); 891 else if (cflag) 892 num = (char)va_arg(ap, int); 893 else 894 num = va_arg(ap, int); 895 number: 896 if (sign && (intmax_t)num < 0) { 897 neg = 1; 898 num = -(intmax_t)num; 899 } 900 p = ksprintn(nbuf, num, base, &n, upper); 901 tmp = 0; 902 if (sharpflag && num != 0) { 903 if (base == 8) 904 tmp++; 905 else if (base == 16) 906 tmp += 2; 907 } 908 if (neg) 909 tmp++; 910 911 if (!ladjust && padc == '0') 912 dwidth = width - tmp; 913 width -= tmp + imax(dwidth, n); 914 dwidth -= n; 915 if (!ladjust) 916 while (width-- > 0) 917 PCHAR(' '); 918 if (neg) 919 PCHAR('-'); 920 if (sharpflag && num != 0) { 921 if (base == 8) { 922 PCHAR('0'); 923 } else if (base == 16) { 924 PCHAR('0'); 925 PCHAR('x'); 926 } 927 } 928 while (dwidth-- > 0) 929 PCHAR('0'); 930 931 while (*p) 932 PCHAR(*p--); 933 934 if (bconv && num != 0) { 935 /* %b conversion flag format. */ 936 tmp = retval; 937 while (*q) { 938 n = *q++; 939 if (num & (1 << (n - 1))) { 940 PCHAR(retval != tmp ? 941 ',' : '<'); 942 for (; (n = *q) > ' '; ++q) 943 PCHAR(n); 944 } else 945 for (; *q > ' '; ++q) 946 continue; 947 } 948 if (retval != tmp) { 949 PCHAR('>'); 950 width -= retval - tmp; 951 } 952 } 953 954 if (ladjust) 955 while (width-- > 0) 956 PCHAR(' '); 957 958 break; 959 default: 960 while (percent < fmt) 961 PCHAR(*percent++); 962 /* 963 * Since we ignore a formatting argument it is no 964 * longer safe to obey the remaining formatting 965 * arguments as the arguments will no longer match 966 * the format specs. 967 */ 968 stop = 1; 969 break; 970 } 971 } 972 #undef PCHAR 973 } 974 975 /* 976 * Put character in log buffer with a particular priority. 977 */ 978 static void 979 msglogchar(int c, int pri) 980 { 981 static int lastpri = -1; 982 static int dangling; 983 char nbuf[MAXNBUF]; 984 char *p; 985 986 if (!msgbufmapped) 987 return; 988 if (c == '\0' || c == '\r') 989 return; 990 if (pri != -1 && pri != lastpri) { 991 if (dangling) { 992 msgbuf_addchar(msgbufp, '\n'); 993 dangling = 0; 994 } 995 msgbuf_addchar(msgbufp, '<'); 996 for (p = ksprintn(nbuf, (uintmax_t)pri, 10, NULL, 0); *p;) 997 msgbuf_addchar(msgbufp, *p--); 998 msgbuf_addchar(msgbufp, '>'); 999 lastpri = pri; 1000 } 1001 msgbuf_addchar(msgbufp, c); 1002 if (c == '\n') { 1003 dangling = 0; 1004 lastpri = -1; 1005 } else { 1006 dangling = 1; 1007 } 1008 } 1009 1010 static void 1011 msglogstr(char *str, int pri, int filter_cr) 1012 { 1013 if (!msgbufmapped) 1014 return; 1015 1016 msgbuf_addstr(msgbufp, pri, str, filter_cr); 1017 } 1018 1019 void 1020 msgbufinit(void *ptr, int size) 1021 { 1022 char *cp; 1023 static struct msgbuf *oldp = NULL; 1024 1025 size -= sizeof(*msgbufp); 1026 cp = (char *)ptr; 1027 msgbufp = (struct msgbuf *)(cp + size); 1028 msgbuf_reinit(msgbufp, cp, size); 1029 if (msgbufmapped && oldp != msgbufp) 1030 msgbuf_copy(oldp, msgbufp); 1031 msgbufmapped = 1; 1032 oldp = msgbufp; 1033 } 1034 1035 static int unprivileged_read_msgbuf = 1; 1036 SYSCTL_INT(_security_bsd, OID_AUTO, unprivileged_read_msgbuf, 1037 CTLFLAG_RW, &unprivileged_read_msgbuf, 0, 1038 "Unprivileged processes may read the kernel message buffer"); 1039 1040 /* Sysctls for accessing/clearing the msgbuf */ 1041 static int 1042 sysctl_kern_msgbuf(SYSCTL_HANDLER_ARGS) 1043 { 1044 char buf[128]; 1045 u_int seq; 1046 int error, len; 1047 1048 if (!unprivileged_read_msgbuf) { 1049 error = priv_check(req->td, PRIV_MSGBUF); 1050 if (error) 1051 return (error); 1052 } 1053 1054 /* Read the whole buffer, one chunk at a time. */ 1055 mtx_lock(&msgbuf_lock); 1056 msgbuf_peekbytes(msgbufp, NULL, 0, &seq); 1057 for (;;) { 1058 len = msgbuf_peekbytes(msgbufp, buf, sizeof(buf), &seq); 1059 mtx_unlock(&msgbuf_lock); 1060 if (len == 0) 1061 return (SYSCTL_OUT(req, "", 1)); /* add nulterm */ 1062 1063 error = sysctl_handle_opaque(oidp, buf, len, req); 1064 if (error) 1065 return (error); 1066 1067 mtx_lock(&msgbuf_lock); 1068 } 1069 } 1070 1071 SYSCTL_PROC(_kern, OID_AUTO, msgbuf, 1072 CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_MPSAFE, 1073 NULL, 0, sysctl_kern_msgbuf, "A", "Contents of kernel message buffer"); 1074 1075 static int msgbuf_clearflag; 1076 1077 static int 1078 sysctl_kern_msgbuf_clear(SYSCTL_HANDLER_ARGS) 1079 { 1080 int error; 1081 error = sysctl_handle_int(oidp, oidp->oid_arg1, oidp->oid_arg2, req); 1082 if (!error && req->newptr) { 1083 mtx_lock(&msgbuf_lock); 1084 msgbuf_clear(msgbufp); 1085 mtx_unlock(&msgbuf_lock); 1086 msgbuf_clearflag = 0; 1087 } 1088 return (error); 1089 } 1090 1091 SYSCTL_PROC(_kern, OID_AUTO, msgbuf_clear, 1092 CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_SECURE | CTLFLAG_MPSAFE, 1093 &msgbuf_clearflag, 0, sysctl_kern_msgbuf_clear, "I", 1094 "Clear kernel message buffer"); 1095 1096 #ifdef DDB 1097 1098 DB_SHOW_COMMAND(msgbuf, db_show_msgbuf) 1099 { 1100 int i, j; 1101 1102 if (!msgbufmapped) { 1103 db_printf("msgbuf not mapped yet\n"); 1104 return; 1105 } 1106 db_printf("msgbufp = %p\n", msgbufp); 1107 db_printf("magic = %x, size = %d, r= %u, w = %u, ptr = %p, cksum= %u\n", 1108 msgbufp->msg_magic, msgbufp->msg_size, msgbufp->msg_rseq, 1109 msgbufp->msg_wseq, msgbufp->msg_ptr, msgbufp->msg_cksum); 1110 for (i = 0; i < msgbufp->msg_size && !db_pager_quit; i++) { 1111 j = MSGBUF_SEQ_TO_POS(msgbufp, i + msgbufp->msg_rseq); 1112 db_printf("%c", msgbufp->msg_ptr[j]); 1113 } 1114 db_printf("\n"); 1115 } 1116 1117 #endif /* DDB */ 1118 1119 void 1120 hexdump(const void *ptr, int length, const char *hdr, int flags) 1121 { 1122 int i, j, k; 1123 int cols; 1124 const unsigned char *cp; 1125 char delim; 1126 1127 if ((flags & HD_DELIM_MASK) != 0) 1128 delim = (flags & HD_DELIM_MASK) >> 8; 1129 else 1130 delim = ' '; 1131 1132 if ((flags & HD_COLUMN_MASK) != 0) 1133 cols = flags & HD_COLUMN_MASK; 1134 else 1135 cols = 16; 1136 1137 cp = ptr; 1138 for (i = 0; i < length; i+= cols) { 1139 if (hdr != NULL) 1140 printf("%s", hdr); 1141 1142 if ((flags & HD_OMIT_COUNT) == 0) 1143 printf("%04x ", i); 1144 1145 if ((flags & HD_OMIT_HEX) == 0) { 1146 for (j = 0; j < cols; j++) { 1147 k = i + j; 1148 if (k < length) 1149 printf("%c%02x", delim, cp[k]); 1150 else 1151 printf(" "); 1152 } 1153 } 1154 1155 if ((flags & HD_OMIT_CHARS) == 0) { 1156 printf(" |"); 1157 for (j = 0; j < cols; j++) { 1158 k = i + j; 1159 if (k >= length) 1160 printf(" "); 1161 else if (cp[k] >= ' ' && cp[k] <= '~') 1162 printf("%c", cp[k]); 1163 else 1164 printf("."); 1165 } 1166 printf("|"); 1167 } 1168 printf("\n"); 1169 } 1170 } 1171 #endif /* _KERNEL */ 1172 1173 void 1174 sbuf_hexdump(struct sbuf *sb, const void *ptr, int length, const char *hdr, 1175 int flags) 1176 { 1177 int i, j, k; 1178 int cols; 1179 const unsigned char *cp; 1180 char delim; 1181 1182 if ((flags & HD_DELIM_MASK) != 0) 1183 delim = (flags & HD_DELIM_MASK) >> 8; 1184 else 1185 delim = ' '; 1186 1187 if ((flags & HD_COLUMN_MASK) != 0) 1188 cols = flags & HD_COLUMN_MASK; 1189 else 1190 cols = 16; 1191 1192 cp = ptr; 1193 for (i = 0; i < length; i+= cols) { 1194 if (hdr != NULL) 1195 sbuf_printf(sb, "%s", hdr); 1196 1197 if ((flags & HD_OMIT_COUNT) == 0) 1198 sbuf_printf(sb, "%04x ", i); 1199 1200 if ((flags & HD_OMIT_HEX) == 0) { 1201 for (j = 0; j < cols; j++) { 1202 k = i + j; 1203 if (k < length) 1204 sbuf_printf(sb, "%c%02x", delim, cp[k]); 1205 else 1206 sbuf_printf(sb, " "); 1207 } 1208 } 1209 1210 if ((flags & HD_OMIT_CHARS) == 0) { 1211 sbuf_printf(sb, " |"); 1212 for (j = 0; j < cols; j++) { 1213 k = i + j; 1214 if (k >= length) 1215 sbuf_printf(sb, " "); 1216 else if (cp[k] >= ' ' && cp[k] <= '~') 1217 sbuf_printf(sb, "%c", cp[k]); 1218 else 1219 sbuf_printf(sb, "."); 1220 } 1221 sbuf_printf(sb, "|"); 1222 } 1223 sbuf_printf(sb, "\n"); 1224 } 1225 } 1226 1227 #ifdef _KERNEL 1228 void 1229 counted_warning(unsigned *counter, const char *msg) 1230 { 1231 struct thread *td; 1232 unsigned c; 1233 1234 for (;;) { 1235 c = *counter; 1236 if (c == 0) 1237 break; 1238 if (atomic_cmpset_int(counter, c, c - 1)) { 1239 td = curthread; 1240 log(LOG_INFO, "pid %d (%s) %s%s\n", 1241 td->td_proc->p_pid, td->td_name, msg, 1242 c > 1 ? "" : " - not logging anymore"); 1243 break; 1244 } 1245 } 1246 } 1247 #endif 1248 1249 #ifdef _KERNEL 1250 void 1251 sbuf_putbuf(struct sbuf *sb) 1252 { 1253 1254 prf_putbuf(sbuf_data(sb), TOLOG | TOCONS, -1); 1255 } 1256 #else 1257 void 1258 sbuf_putbuf(struct sbuf *sb) 1259 { 1260 1261 printf("%s", sbuf_data(sb)); 1262 } 1263 #endif 1264