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_kdb.h>
159 #include <mach_kdp.h>
160 #include <platforms.h>
161 #include <mach/boolean.h>
162 #include <kern/cpu_number.h>
163 #include <kern/lock.h>
164 #include <kern/thread.h>
165 #include <kern/sched_prim.h>
166 #include <kern/misc_protos.h>
169 #include <mach_assert.h>
171 #include <sys/msgbuf.h>
173 #include <console/serial_protos.h>
176 #include <ppc/Firmware.h>
179 #define isdigit(d) ((d) >= '0' && (d) <= '9')
180 #define Ctod(c) ((c) - '0')
182 #define MAXBUF (sizeof(long long int) * 8) /* enough for binary */
183 static char digs
[] = "0123456789abcdef";
186 #if CONFIG_NO_PRINTF_STRINGS
187 /* Prevent CPP from breaking the definition below */
191 int _consume_printf_args(int a __unused
, ...)
195 void _consume_kprintf_args(int a __unused
, ...)
201 unsigned long long int u
, /* number to print */
203 void (*putc
)(int, void *),
206 char buf
[MAXBUF
]; /* build number here */
207 char * p
= &buf
[MAXBUF
-1];
211 *p
-- = digs
[u
% base
];
215 while (++p
!= &buf
[MAXBUF
]) {
223 boolean_t _doprnt_truncates
= FALSE
;
229 /* character output routine */
230 void (*putc
)(int, void *arg
),
232 int radix
) /* default radix - for '%r' */
239 unsigned long long u
;
242 boolean_t altfmt
, truncate
;
249 while ((c
= *fmt
) != '\0') {
295 length
= 10 * length
+ Ctod(c
);
300 length
= va_arg(argp
, int);
313 prec
= 10 * prec
+ Ctod(c
);
318 prec
= va_arg(argp
, int);
324 c
= *++fmt
; /* need it if sizeof(int) < sizeof(long) */
325 if (sizeof(int)<sizeof(long))
331 } else if (c
== 'q' || c
== 'L') {
337 capitals
=0; /* Assume lower case printing */
348 u
= va_arg(argp
, unsigned long long);
350 u
= va_arg(argp
, unsigned int);
352 p
= va_arg(argp
, char *);
354 nprinted
+= printnum(u
, base
, putc
, arg
);
360 while ((i
= *p
++) != '\0') {
378 for (; (c
= *p
) > 32; p
++) {
382 nprinted
+= printnum((unsigned)( (u
>>(j
-1)) & ((2<<(i
-j
))-1)),
385 else if (u
& (1<<(i
-1))) {
393 for (; (c
= *p
) > 32; p
++) {
411 c
= va_arg(argp
, int);
418 register const char *p
;
419 register const char *p2
;
422 prec
= 0x7fffffff; /* MAXINT */
424 p
= va_arg(argp
, char *);
429 if (length
> 0 && !ladjust
) {
433 for (; *p
!= '\0' && n
< prec
; p
++)
447 while ((n
< prec
) && (!(length
> 0 && n
>= length
))) {
456 if (n
< length
&& ladjust
) {
468 truncate
= _doprnt_truncates
;
477 up
= (unsigned char *)va_arg(argp
, unsigned char *);
478 p
= (char *)va_arg(argp
, char *);
482 (*putc
)(digs
[(*up
>> 4)], arg
);
483 (*putc
)(digs
[(*up
& 0x0f)], arg
);
497 truncate
= _doprnt_truncates
;
502 truncate
= _doprnt_truncates
;
509 if (sizeof(int)<sizeof(void *)) {
513 truncate
= _doprnt_truncates
;
519 capitals
=16; /* Print in upper case */
523 truncate
= _doprnt_truncates
;
529 capitals
=16; /* Print in upper case */
533 truncate
= _doprnt_truncates
;
539 truncate
= _doprnt_truncates
;
546 n
= va_arg(argp
, long long);
548 n
= va_arg(argp
, int);
552 sign_char
= plus_sign
;
562 u
= va_arg(argp
, unsigned long long);
564 u
= va_arg(argp
, unsigned int);
570 char buf
[MAXBUF
]; /* build number here */
571 register char * p
= &buf
[MAXBUF
-1];
572 static char digits
[] = "0123456789abcdef0123456789ABCDEF";
573 const char *prefix
= NULL
;
575 if (truncate
) u
= (long long)((int)(u
));
577 if (u
!= 0 && altfmt
) {
585 /* Print in the correct case */
586 *p
-- = digits
[(u
% base
)+capitals
];
590 length
-= (int)(&buf
[MAXBUF
-1] - p
);
594 length
-= (int)strlen(prefix
);
596 if (padc
== ' ' && !ladjust
) {
597 /* blank padding goes before prefix */
598 while (--length
>= 0) {
604 (*putc
)(sign_char
, arg
);
609 (*putc
)(*prefix
++, arg
);
614 /* zero padding goes after sign and prefix */
615 while (--length
>= 0) {
620 while (++p
!= &buf
[MAXBUF
]) {
626 while (--length
>= 0) {
649 dummy_putc(int ch
, void *arg
)
651 void (*real_putc
)(char) = arg
;
658 register const char *fmt
,
660 /* character output routine */
662 int radix
) /* default radix - for '%r' */
664 __doprnt(fmt
, *argp
, dummy_putc
, putc
, radix
);
668 boolean_t new_printf_cpu_number
= FALSE
;
669 #endif /* MP_PRINTF */
672 decl_simple_lock_data(,printf_lock
)
673 decl_simple_lock_data(,bsd_log_spinlock
)
674 extern void bsd_log_init(void);
675 void bsd_log_lock(void);
676 void bsd_log_unlock(void);
682 * Lock is only really needed after the first thread is created.
684 simple_lock_init(&printf_lock
, 0);
685 simple_lock_init(&bsd_log_spinlock
, 0);
692 simple_lock(&bsd_log_spinlock
);
698 simple_unlock(&bsd_log_spinlock
);
701 /* derived from boot_gets */
709 char *strmax
= str
+ maxlen
- 1; /* allow space for trailing 0 */
737 if (c
>= ' ' && c
< '\177') {
743 printf("%c", '\007'); /* beep */
750 extern int disableConsoleOutput
;
756 if ((debug_mode
&& !disable_debug_output
) || !disableConsoleOutput
)
766 extern void db_putchar(char c
);
770 dbugprintf(__unused
const char *fmt
, ...)
776 va_start(listp
, fmt
);
777 _doprnt(fmt
, &listp
, db_putchar
, 16);
784 printf(const char *fmt
, ...)
789 disable_preemption();
790 va_start(listp
, fmt
);
791 _doprnt(fmt
, &listp
, conslog_putc
, 16);
799 consdebug_putc(char c
)
801 if ((debug_mode
&& !disable_debug_output
) || !disableConsoleOutput
)
806 if (!console_is_serial())
807 if (!disable_serial_output
)
812 consdebug_putc_unbuffered(char c
)
814 if ((debug_mode
&& !disable_debug_output
) || !disableConsoleOutput
)
815 cnputc_unbuffered(c
);
819 if (!console_is_serial())
820 if (!disable_serial_output
)
825 consdebug_log(char c
)
831 kdb_printf(const char *fmt
, ...)
835 va_start(listp
, fmt
);
836 _doprnt(fmt
, &listp
, consdebug_putc
, 16);
842 kdb_log(const char *fmt
, ...)
846 va_start(listp
, fmt
);
847 _doprnt(fmt
, &listp
, consdebug_log
, 16);
853 kdb_printf_unbuffered(const char *fmt
, ...)
857 va_start(listp
, fmt
);
858 _doprnt(fmt
, &listp
, consdebug_putc_unbuffered
, 16);
864 copybyte(int c
, void *arg
)
867 * arg is a pointer (outside pointer) to the pointer
868 * (inside pointer) which points to the character.
869 * We pass a double pointer, so that we can increment
870 * the inside pointer.
872 char** p
= arg
; /* cast outside pointer */
873 **p
= c
; /* store character */
874 (*p
)++; /* increment inside pointer */
878 * Deprecation Warning:
879 * sprintf() is being deprecated. Please use snprintf() instead.
882 sprintf(char *buf
, const char *fmt
, ...)
887 va_start(listp
, fmt
);
889 __doprnt(fmt
, listp
, copybyte
, ©byte_str
, 16);
891 *copybyte_str
= '\0';
892 return (int)strlen(buf
);