2 * Copyright (c) 2000-2006 Apple Computer, Inc. All rights reserved.
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. The rights granted to you under the License
10 * may not be used to create, or enable the creation or redistribution of,
11 * unlawful or unlicensed copies of an Apple operating system, or to
12 * circumvent, violate, or enable the circumvention or violation of, any
13 * terms of an Apple operating system software license agreement.
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
18 * The Original Code and all software distributed under the License are
19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23 * Please see the License for the specific language governing rights and
24 * limitations under the License.
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
33 * Mach Operating System
34 * Copyright (c) 1991,1990,1989,1988 Carnegie Mellon University
35 * All Rights Reserved.
37 * Permission to use, copy, modify and distribute this software and its
38 * documentation is hereby granted, provided that both the copyright
39 * notice and this permission notice appear in all copies of the
40 * software, derivative works or modified versions, and any portions
41 * thereof, and that both notices appear in supporting documentation.
43 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
44 * CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
45 * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
47 * Carnegie Mellon requests users of this software to return to
49 * Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
50 * School of Computer Science
51 * Carnegie Mellon University
52 * Pittsburgh PA 15213-3890
54 * any improvements or extensions that they make and grant Carnegie Mellon
55 * the rights to redistribute these changes.
59 * Common code for printf et al.
61 * The calling routine typically takes a variable number of arguments,
62 * and passes the address of the first one. This implementation
63 * assumes a straightforward, stack implementation, aligned to the
64 * machine's wordsize. Increasing addresses are assumed to point to
65 * successive arguments (left-to-right), as is the case for a machine
66 * with a downward-growing stack with arguments pushed right-to-left.
68 * To write, for example, fprintf() using this routine, the code
70 * fprintf(fd, format, args)
74 * _doprnt(format, &args, fd);
77 * would suffice. (This example does not handle the fprintf's "return
78 * value" correctly, but who looks at the return value of fprintf
81 * This version implements the following printf features:
83 * %d decimal conversion
84 * %u unsigned conversion
85 * %x hexadecimal conversion
86 * %X hexadecimal conversion with capital letters
87 * %D hexdump, ptr & separator string ("%6D", ptr, ":") -> XX:XX:XX:XX:XX:XX
88 * if you use, "%*D" then there's a length, the data ptr and then the separator
92 * %m.n field width, precision
93 * %-m.n left adjustment
95 * %*.* width and precision taken from arguments
97 * This version does not implement %f, %e, or %g.
99 * As mentioned, this version does not return any reasonable value.
101 * Permission is granted to use, modify, or propagate this code as
102 * long as this notice is incorporated.
104 * Steve Summit 3/25/87
106 * Tweaked for long long support and extended to support the hexdump %D
107 * specifier by dbg 05/02/02.
111 * Added formats for decoding device registers:
113 * printf("reg = %b", regval, "<base><arg>*")
115 * where <base> is the output base expressed as a control character:
116 * i.e. '\10' gives octal, '\20' gives hex. Each <arg> is a sequence of
117 * characters, the first of which gives the bit number to be inspected
118 * (origin 1), and the rest (up to a control character (<= 32)) give the
119 * name of the register. Thus
120 * printf("reg = %b\n", 3, "\10\2BITTWO\1BITONE")
122 * reg = 3<BITTWO,BITONE>
124 * If the second character in <arg> is also a control character, it
125 * indicates the last bit of a bit field. In this case, printf will extract
126 * bits <1> to <2> and print it. Characters following the second control
127 * character are printed before the bit field.
128 * printf("reg = %b\n", 0xb, "\10\4\3FIELD1=\2BITTWO\1BITONE")
130 * reg = b<FIELD1=2,BITONE>
132 * The %B format is like %b but the bits are numbered from the most
133 * significant (the bit weighted 31), which is called 1, to the least
134 * significant, called 32.
137 * Added for general use:
138 * # prefix for alternate format:
140 * leading 0 for octal
141 * + print '+' if positive
142 * blank print ' ' if positive
144 * z set length equal to size_t
146 * n unsigned, 'radix'
148 * D,U,O,Z same as corresponding lower-case versions
152 * Added support for print long long (64-bit) integers.
153 * Use %lld, %Ld or %qd to print a 64-bit int. Other
154 * output bases such as x, X, u, U, o, and O also work.
158 #include <mach_kdp.h>
159 #include <mach/boolean.h>
160 #include <kern/cpu_number.h>
161 #include <kern/thread.h>
162 #include <kern/debug.h>
163 #include <kern/sched_prim.h>
164 #include <kern/misc_protos.h>
167 #include <mach_assert.h>
169 #include <sys/msgbuf.h>
171 #include <console/serial_protos.h>
172 #include <os/log_private.h>
175 #include <i386/cpu_data.h>
176 #endif /* __x86_64__ */
178 #if __arm__ || __arm64__
179 #include <arm/cpu_data_internal.h>
183 #define isdigit(d) ((d) >= '0' && (d) <= '9')
184 #define Ctod(c) ((c) - '0')
186 #define MAXBUF (sizeof(long long int) * 8) /* enough for binary */
187 static char digs
[] = "0123456789abcdef";
189 #if CONFIG_NO_PRINTF_STRINGS
190 /* Prevent CPP from breaking the definition below */
195 _consume_printf_args(int a __unused
, ...)
200 _consume_kprintf_args(int a __unused
, ...)
206 unsigned long long int u
, /* number to print */
208 void (*putc
)(int, void *),
211 char buf
[MAXBUF
]; /* build number here */
212 char * p
= &buf
[MAXBUF
- 1];
216 *p
-- = digs
[u
% base
];
220 while (++p
!= &buf
[MAXBUF
]) {
228 boolean_t _doprnt_truncates
= FALSE
;
230 #if (DEVELOPMENT || DEBUG)
231 boolean_t doprnt_hide_pointers
= FALSE
;
233 boolean_t doprnt_hide_pointers
= TRUE
;
240 /* character output routine */
241 void (*putc
)(int, void *arg
),
243 int radix
, /* default radix - for '%r' */
251 unsigned long long u
;
254 boolean_t altfmt
, truncate
;
261 while ((c
= *fmt
) != '\0') {
284 } else if (c
== '-') {
286 } else if (c
== '+') {
288 } else if (c
== ' ') {
289 if (plus_sign
== 0) {
305 length
= 10 * length
+ Ctod(c
);
308 } else if (c
== '*') {
309 length
= va_arg(argp
, int);
322 prec
= 10 * prec
+ Ctod(c
);
325 } else if (c
== '*') {
326 prec
= va_arg(argp
, int);
332 c
= *++fmt
; /* need it if sizeof(int) < sizeof(long) */
333 if (sizeof(int) < sizeof(long)) {
340 } else if (c
== 'q' || c
== 'L') {
345 if (c
== 'z' || c
== 'Z') {
347 if (sizeof(size_t) == sizeof(unsigned long)) {
353 capitals
= 0; /* Assume lower case printing */
364 u
= va_arg(argp
, unsigned long long);
366 u
= va_arg(argp
, unsigned int);
368 p
= va_arg(argp
, char *);
370 nprinted
+= printnum(u
, base
, putc
, arg
);
377 while ((i
= *p
++) != '\0') {
397 for (; (c
= *p
) > 32; p
++) {
401 nprinted
+= printnum((unsigned)((u
>> (j
- 1)) & ((2 << (i
- j
)) - 1)),
403 } else if (u
& (1 << (i
- 1))) {
411 for (; (c
= *p
) > 32; p
++) {
416 for (; *p
> 32; p
++) {
429 c
= va_arg(argp
, int);
440 prec
= 0x7fffffff; /* MAXINT */
442 p
= va_arg(argp
, char *);
448 if (length
> 0 && !ladjust
) {
452 for (; *p
!= '\0' && n
< prec
; p
++) {
467 while ((n
< prec
) && (!(length
> 0 && n
>= length
))) {
476 if (n
< length
&& ladjust
) {
488 truncate
= _doprnt_truncates
;
497 up
= (unsigned char *)va_arg(argp
, unsigned char *);
498 p
= (char *)va_arg(argp
, char *);
503 (*putc
)(digs
[(*up
>> 4)], arg
);
504 (*putc
)(digs
[(*up
& 0x0f)], arg
);
508 for (q
= p
; *q
; q
++) {
518 truncate
= _doprnt_truncates
;
523 truncate
= _doprnt_truncates
;
530 if (sizeof(int) < sizeof(void *)) {
534 truncate
= _doprnt_truncates
;
540 capitals
= 16; /* Print in upper case */
544 truncate
= _doprnt_truncates
;
550 truncate
= _doprnt_truncates
;
557 n
= va_arg(argp
, long long);
559 n
= va_arg(argp
, int);
563 sign_char
= plus_sign
;
572 u
= va_arg(argp
, unsigned long long);
574 u
= va_arg(argp
, unsigned int);
580 char buf
[MAXBUF
];/* build number here */
581 char * p
= &buf
[MAXBUF
- 1];
582 static char digits
[] = "0123456789abcdef0123456789ABCDEF";
583 const char *prefix
= NULL
;
586 u
= (long long)((int)(u
));
589 if (doprnt_hide_pointers
&& is_log
) {
590 const char str
[] = "<ptr>";
591 const char* strp
= str
;
592 int strl
= sizeof(str
) - 1;
595 if (u
>= VM_MIN_KERNEL_AND_KEXT_ADDRESS
&& u
<= VM_MAX_KERNEL_ADDRESS
) {
596 while (*strp
!= '\0') {
605 if (u
!= 0 && altfmt
) {
608 } else if (base
== 16) {
614 /* Print in the correct case */
615 *p
-- = digits
[(u
% base
) + capitals
];
619 length
-= (int)(&buf
[MAXBUF
- 1] - p
);
624 length
-= (int)strlen(prefix
);
627 if (padc
== ' ' && !ladjust
) {
628 /* blank padding goes before prefix */
629 while (--length
>= 0) {
635 (*putc
)(sign_char
, arg
);
640 (*putc
)(*prefix
++, arg
);
645 /* zero padding goes after sign and prefix */
646 while (--length
>= 0) {
651 while (++p
!= &buf
[MAXBUF
]) {
657 while (--length
>= 0) {
680 dummy_putc(int ch
, void *arg
)
682 void (*real_putc
)(char) = arg
;
691 /* character output routine */
693 int radix
) /* default radix - for '%r' */
695 __doprnt(fmt
, *argp
, dummy_putc
, putc
, radix
, FALSE
);
702 /* character output routine */
704 int radix
) /* default radix - for '%r' */
706 __doprnt(fmt
, *argp
, dummy_putc
, putc
, radix
, TRUE
);
710 boolean_t new_printf_cpu_number
= FALSE
;
711 #endif /* MP_PRINTF */
713 decl_simple_lock_data(, printf_lock
)
714 decl_simple_lock_data(, bsd_log_spinlock
)
716 lck_grp_t oslog_stream_lock_grp
;
717 decl_lck_spin_data(, oslog_stream_lock
)
718 void oslog_lock_init(void);
720 extern void bsd_log_init(void);
721 void bsd_log_lock(void);
722 void bsd_log_unlock(void);
728 * Lock is only really needed after the first thread is created.
730 simple_lock_init(&printf_lock
, 0);
731 simple_lock_init(&bsd_log_spinlock
, 0);
738 simple_lock(&bsd_log_spinlock
, LCK_GRP_NULL
);
744 simple_unlock(&bsd_log_spinlock
);
748 oslog_lock_init(void)
750 lck_grp_init(&oslog_stream_lock_grp
, "oslog stream", LCK_GRP_ATTR_NULL
);
751 lck_spin_init(&oslog_stream_lock
, &oslog_stream_lock_grp
, LCK_ATTR_NULL
);
754 /* derived from boot_gets */
762 char *strmax
= str
+ maxlen
- 1; /* allow space for trailing 0 */
790 if (c
>= ' ' && c
< '\177') {
795 printf("%c", '\007'); /* beep */
802 extern int disableConsoleOutput
;
808 if (!disableConsoleOutput
) {
813 if (!kernel_debugger_entry_count
) {
823 if (!disableConsoleOutput
) {
829 vprintf_internal(const char *fmt
, va_list ap_in
, void *caller
)
831 cpu_data_t
* cpu_data_p
;
833 struct console_printbuf_state info_data
;
834 cpu_data_p
= current_cpu_datap();
839 * for early boot printf()s console may not be setup,
840 * fallback to good old cnputc
842 if (cpu_data_p
->cpu_console_buf
!= NULL
) {
843 console_printbuf_state_init(&info_data
, TRUE
, TRUE
);
844 __doprnt(fmt
, ap
, console_printbuf_putc
, &info_data
, 16, TRUE
);
845 console_printbuf_clear(&info_data
);
847 disable_preemption();
848 _doprnt_log(fmt
, &ap
, cons_putc_locked
, 16);
854 os_log_with_args(OS_LOG_DEFAULT
, OS_LOG_TYPE_DEFAULT
, fmt
, ap_in
, caller
);
859 __attribute__((noinline
, not_tail_called
))
861 printf(const char *fmt
, ...)
867 ret
= vprintf_internal(fmt
, ap
, __builtin_return_address(0));
873 __attribute__((noinline
, not_tail_called
))
875 vprintf(const char *fmt
, va_list ap
)
877 return vprintf_internal(fmt
, ap
, __builtin_return_address(0));
881 consdebug_putc(char c
)
883 if (!disableConsoleOutput
) {
889 if (!console_is_serial() && !disable_serial_output
) {
895 consdebug_putc_unbuffered(char c
)
897 if (!disableConsoleOutput
) {
898 cnputc_unbuffered(c
);
903 if (!console_is_serial() && !disable_serial_output
) {
909 consdebug_log(char c
)
915 * Append contents to the paniclog buffer but don't flush
916 * it. This is mainly used for writing the actual paniclog
917 * contents since flushing once for every line written
918 * would be prohibitively expensive for the paniclog
921 paniclog_append_noflush(const char *fmt
, ...)
925 va_start(listp
, fmt
);
926 _doprnt_log(fmt
, &listp
, consdebug_putc
, 16);
933 kdb_printf(const char *fmt
, ...)
937 va_start(listp
, fmt
);
938 _doprnt_log(fmt
, &listp
, consdebug_putc
, 16);
949 kdb_log(const char *fmt
, ...)
953 va_start(listp
, fmt
);
954 _doprnt(fmt
, &listp
, consdebug_log
, 16);
965 kdb_printf_unbuffered(const char *fmt
, ...)
969 va_start(listp
, fmt
);
970 _doprnt(fmt
, &listp
, consdebug_putc_unbuffered
, 16);
983 copybyte(int c
, void *arg
)
986 * arg is a pointer (outside pointer) to the pointer
987 * (inside pointer) which points to the character.
988 * We pass a double pointer, so that we can increment
989 * the inside pointer.
991 char** p
= arg
; /* cast outside pointer */
992 **p
= c
; /* store character */
993 (*p
)++; /* increment inside pointer */
997 * Deprecation Warning:
998 * sprintf() is being deprecated. Please use snprintf() instead.
1001 sprintf(char *buf
, const char *fmt
, ...)
1006 va_start(listp
, fmt
);
1008 __doprnt(fmt
, listp
, copybyte
, ©byte_str
, 16, FALSE
);
1010 *copybyte_str
= '\0';
1011 return (int)strlen(buf
);
1013 #endif /* !CONFIG_EMBEDDED */