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 signed hexadecimal
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/sched_prim.h>
163 #include <kern/misc_protos.h>
166 #include <mach_assert.h>
168 #include <sys/msgbuf.h>
170 #include <console/serial_protos.h>
172 #define isdigit(d) ((d) >= '0' && (d) <= '9')
173 #define Ctod(c) ((c) - '0')
175 #define MAXBUF (sizeof(long long int) * 8) /* enough for binary */
176 static char digs
[] = "0123456789abcdef";
178 #if CONFIG_NO_PRINTF_STRINGS
179 /* Prevent CPP from breaking the definition below */
183 int _consume_printf_args(int a __unused
, ...)
187 void _consume_kprintf_args(int a __unused
, ...)
193 unsigned long long int u
, /* number to print */
195 void (*putc
)(int, void *),
198 char buf
[MAXBUF
]; /* build number here */
199 char * p
= &buf
[MAXBUF
-1];
203 *p
-- = digs
[u
% base
];
207 while (++p
!= &buf
[MAXBUF
]) {
215 boolean_t _doprnt_truncates
= FALSE
;
217 #if (DEVELOPMENT || DEBUG)
218 boolean_t doprnt_hide_pointers
= FALSE
;
220 boolean_t doprnt_hide_pointers
= TRUE
;
227 /* character output routine */
228 void (*putc
)(int, void *arg
),
230 int radix
, /* default radix - for '%r' */
238 unsigned long long u
;
241 boolean_t altfmt
, truncate
;
248 while ((c
= *fmt
) != '\0') {
294 length
= 10 * length
+ Ctod(c
);
299 length
= va_arg(argp
, int);
312 prec
= 10 * prec
+ Ctod(c
);
317 prec
= va_arg(argp
, int);
323 c
= *++fmt
; /* need it if sizeof(int) < sizeof(long) */
324 if (sizeof(int)<sizeof(long))
330 } else if (c
== 'q' || c
== 'L') {
336 capitals
=0; /* Assume lower case printing */
347 u
= va_arg(argp
, unsigned long long);
349 u
= va_arg(argp
, unsigned int);
351 p
= va_arg(argp
, char *);
353 nprinted
+= printnum(u
, base
, putc
, arg
);
359 while ((i
= *p
++) != '\0') {
377 for (; (c
= *p
) > 32; p
++) {
381 nprinted
+= printnum((unsigned)( (u
>>(j
-1)) & ((2<<(i
-j
))-1)),
384 else if (u
& (1<<(i
-1))) {
392 for (; (c
= *p
) > 32; p
++) {
410 c
= va_arg(argp
, int);
417 register const char *p
;
418 register const char *p2
;
421 prec
= 0x7fffffff; /* MAXINT */
423 p
= va_arg(argp
, char *);
428 if (length
> 0 && !ladjust
) {
432 for (; *p
!= '\0' && n
< prec
; p
++)
446 while ((n
< prec
) && (!(length
> 0 && n
>= length
))) {
455 if (n
< length
&& ladjust
) {
467 truncate
= _doprnt_truncates
;
476 up
= (unsigned char *)va_arg(argp
, unsigned char *);
477 p
= (char *)va_arg(argp
, char *);
481 (*putc
)(digs
[(*up
>> 4)], arg
);
482 (*putc
)(digs
[(*up
& 0x0f)], arg
);
496 truncate
= _doprnt_truncates
;
501 truncate
= _doprnt_truncates
;
508 if (sizeof(int)<sizeof(void *)) {
512 truncate
= _doprnt_truncates
;
518 capitals
=16; /* Print in upper case */
522 truncate
= _doprnt_truncates
;
528 capitals
=16; /* Print in upper case */
532 truncate
= _doprnt_truncates
;
538 truncate
= _doprnt_truncates
;
545 n
= va_arg(argp
, long long);
547 n
= va_arg(argp
, int);
551 sign_char
= plus_sign
;
561 u
= va_arg(argp
, unsigned long long);
563 u
= va_arg(argp
, unsigned int);
569 char buf
[MAXBUF
]; /* build number here */
570 register char * p
= &buf
[MAXBUF
-1];
571 static char digits
[] = "0123456789abcdef0123456789ABCDEF";
572 const char *prefix
= NULL
;
574 if (truncate
) u
= (long long)((int)(u
));
576 if (doprnt_hide_pointers
&& is_log
) {
577 const char str
[] = "<ptr>";
578 const char* strp
= str
;
579 int strl
= sizeof(str
) - 1;
581 if (u
>= VM_MIN_KERNEL_AND_KEXT_ADDRESS
&& u
<= VM_MAX_KERNEL_ADDRESS
) {
582 while(*strp
!= '\0') {
591 if (u
!= 0 && altfmt
) {
599 /* Print in the correct case */
600 *p
-- = digits
[(u
% base
)+capitals
];
604 length
-= (int)(&buf
[MAXBUF
-1] - p
);
608 length
-= (int)strlen(prefix
);
610 if (padc
== ' ' && !ladjust
) {
611 /* blank padding goes before prefix */
612 while (--length
>= 0) {
618 (*putc
)(sign_char
, arg
);
623 (*putc
)(*prefix
++, arg
);
628 /* zero padding goes after sign and prefix */
629 while (--length
>= 0) {
634 while (++p
!= &buf
[MAXBUF
]) {
640 while (--length
>= 0) {
663 dummy_putc(int ch
, void *arg
)
665 void (*real_putc
)(char) = arg
;
672 register const char *fmt
,
674 /* character output routine */
676 int radix
) /* default radix - for '%r' */
678 __doprnt(fmt
, *argp
, dummy_putc
, putc
, radix
, FALSE
);
683 register const char *fmt
,
685 /* character output routine */
687 int radix
) /* default radix - for '%r' */
689 __doprnt(fmt
, *argp
, dummy_putc
, putc
, radix
, TRUE
);
693 boolean_t new_printf_cpu_number
= FALSE
;
694 #endif /* MP_PRINTF */
697 decl_simple_lock_data(,printf_lock
)
698 decl_simple_lock_data(,bsd_log_spinlock
)
699 extern void bsd_log_init(void);
700 void bsd_log_lock(void);
701 void bsd_log_unlock(void);
707 * Lock is only really needed after the first thread is created.
709 simple_lock_init(&printf_lock
, 0);
710 simple_lock_init(&bsd_log_spinlock
, 0);
717 simple_lock(&bsd_log_spinlock
);
723 simple_unlock(&bsd_log_spinlock
);
726 /* derived from boot_gets */
734 char *strmax
= str
+ maxlen
- 1; /* allow space for trailing 0 */
762 if (c
>= ' ' && c
< '\177') {
768 printf("%c", '\007'); /* beep */
775 extern int disableConsoleOutput
;
781 if ((debug_mode
&& !disable_debug_output
) || !disableConsoleOutput
)
794 if ((debug_mode
&& !disable_debug_output
) || !disableConsoleOutput
)
799 printf(const char *fmt
, ...)
804 disable_preemption();
805 va_start(listp
, fmt
);
806 _doprnt_log(fmt
, &listp
, conslog_putc
, 16);
814 consdebug_putc(char c
)
816 if ((debug_mode
&& !disable_debug_output
) || !disableConsoleOutput
)
821 if (!console_is_serial())
822 if (!disable_serial_output
)
827 consdebug_putc_unbuffered(char c
)
829 if ((debug_mode
&& !disable_debug_output
) || !disableConsoleOutput
)
830 cnputc_unbuffered(c
);
834 if (!console_is_serial())
835 if (!disable_serial_output
)
840 consdebug_log(char c
)
846 kdb_printf(const char *fmt
, ...)
850 va_start(listp
, fmt
);
851 _doprnt_log(fmt
, &listp
, consdebug_putc
, 16);
857 kdb_log(const char *fmt
, ...)
861 va_start(listp
, fmt
);
862 _doprnt(fmt
, &listp
, consdebug_log
, 16);
868 kdb_printf_unbuffered(const char *fmt
, ...)
872 va_start(listp
, fmt
);
873 _doprnt(fmt
, &listp
, consdebug_putc_unbuffered
, 16);
880 copybyte(int c
, void *arg
)
883 * arg is a pointer (outside pointer) to the pointer
884 * (inside pointer) which points to the character.
885 * We pass a double pointer, so that we can increment
886 * the inside pointer.
888 char** p
= arg
; /* cast outside pointer */
889 **p
= c
; /* store character */
890 (*p
)++; /* increment inside pointer */
894 * Deprecation Warning:
895 * sprintf() is being deprecated. Please use snprintf() instead.
898 sprintf(char *buf
, const char *fmt
, ...)
903 va_start(listp
, fmt
);
905 __doprnt(fmt
, listp
, copybyte
, ©byte_str
, 16, FALSE
);
907 *copybyte_str
= '\0';
908 return (int)strlen(buf
);