1 /******************************************************************************
3 * Module Name: utdebug - Debug print/trace routines
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2013, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
44 #define EXPORT_ACPI_INTERFACES
46 #include <acpi/acpi.h>
49 #define _COMPONENT ACPI_UTILITIES
50 ACPI_MODULE_NAME("utdebug")
52 #ifdef ACPI_DEBUG_OUTPUT
53 static acpi_thread_id acpi_gbl_prev_thread_id
= (acpi_thread_id
) 0xFFFFFFFF;
54 static char *acpi_gbl_fn_entry_str
= "----Entry";
55 static char *acpi_gbl_fn_exit_str
= "----Exit-";
57 /* Local prototypes */
59 static const char *acpi_ut_trim_function_name(const char *function_name
);
61 /*******************************************************************************
63 * FUNCTION: acpi_ut_init_stack_ptr_trace
69 * DESCRIPTION: Save the current CPU stack pointer at subsystem startup
71 ******************************************************************************/
73 void acpi_ut_init_stack_ptr_trace(void)
77 acpi_gbl_entry_stack_pointer
= ¤t_sp
;
80 /*******************************************************************************
82 * FUNCTION: acpi_ut_track_stack_ptr
88 * DESCRIPTION: Save the current CPU stack pointer
90 ******************************************************************************/
92 void acpi_ut_track_stack_ptr(void)
96 if (¤t_sp
< acpi_gbl_lowest_stack_pointer
) {
97 acpi_gbl_lowest_stack_pointer
= ¤t_sp
;
100 if (acpi_gbl_nesting_level
> acpi_gbl_deepest_nesting
) {
101 acpi_gbl_deepest_nesting
= acpi_gbl_nesting_level
;
105 /*******************************************************************************
107 * FUNCTION: acpi_ut_trim_function_name
109 * PARAMETERS: function_name - Ascii string containing a procedure name
111 * RETURN: Updated pointer to the function name
113 * DESCRIPTION: Remove the "Acpi" prefix from the function name, if present.
114 * This allows compiler macros such as __FUNCTION__ to be used
115 * with no change to the debug output.
117 ******************************************************************************/
119 static const char *acpi_ut_trim_function_name(const char *function_name
)
122 /* All Function names are longer than 4 chars, check is safe */
124 if (*(ACPI_CAST_PTR(u32
, function_name
)) == ACPI_PREFIX_MIXED
) {
126 /* This is the case where the original source has not been modified */
128 return (function_name
+ 4);
131 if (*(ACPI_CAST_PTR(u32
, function_name
)) == ACPI_PREFIX_LOWER
) {
133 /* This is the case where the source has been 'linuxized' */
135 return (function_name
+ 5);
138 return (function_name
);
141 /*******************************************************************************
143 * FUNCTION: acpi_debug_print
145 * PARAMETERS: requested_debug_level - Requested debug print level
146 * line_number - Caller's line number (for error output)
147 * function_name - Caller's procedure name
148 * module_name - Caller's module name
149 * component_id - Caller's component ID
150 * format - Printf format field
151 * ... - Optional printf arguments
155 * DESCRIPTION: Print error message with prefix consisting of the module name,
156 * line number, and component ID.
158 ******************************************************************************/
160 void ACPI_INTERNAL_VAR_XFACE
161 acpi_debug_print(u32 requested_debug_level
,
163 const char *function_name
,
164 const char *module_name
,
165 u32 component_id
, const char *format
, ...)
167 acpi_thread_id thread_id
;
170 /* Check if debug output enabled */
172 if (!ACPI_IS_DEBUG_ENABLED(requested_debug_level
, component_id
)) {
177 * Thread tracking and context switch notification
179 thread_id
= acpi_os_get_thread_id();
180 if (thread_id
!= acpi_gbl_prev_thread_id
) {
181 if (ACPI_LV_THREADS
& acpi_dbg_level
) {
183 ("\n**** Context Switch from TID %u to TID %u ****\n\n",
184 (u32
)acpi_gbl_prev_thread_id
, (u32
)thread_id
);
187 acpi_gbl_prev_thread_id
= thread_id
;
188 acpi_gbl_nesting_level
= 0;
192 * Display the module name, current line number, thread ID (if requested),
193 * current procedure nesting level, and the current procedure name
195 acpi_os_printf("%9s-%04ld ", module_name
, line_number
);
197 #ifdef ACPI_APPLICATION
199 * For acpi_exec/iASL only, emit the thread ID and nesting level.
200 * Note: nesting level is really only useful during a single-thread
201 * execution. Otherwise, multiple threads will keep resetting the
204 if (ACPI_LV_THREADS
& acpi_dbg_level
) {
205 acpi_os_printf("[%u] ", (u32
)thread_id
);
208 acpi_os_printf("[%02ld] ", acpi_gbl_nesting_level
);
211 acpi_os_printf("%-22.22s: ", acpi_ut_trim_function_name(function_name
));
213 va_start(args
, format
);
214 acpi_os_vprintf(format
, args
);
218 ACPI_EXPORT_SYMBOL(acpi_debug_print
)
220 /*******************************************************************************
222 * FUNCTION: acpi_debug_print_raw
224 * PARAMETERS: requested_debug_level - Requested debug print level
225 * line_number - Caller's line number
226 * function_name - Caller's procedure name
227 * module_name - Caller's module name
228 * component_id - Caller's component ID
229 * format - Printf format field
230 * ... - Optional printf arguments
234 * DESCRIPTION: Print message with no headers. Has same interface as
235 * debug_print so that the same macros can be used.
237 ******************************************************************************/
238 void ACPI_INTERNAL_VAR_XFACE
239 acpi_debug_print_raw(u32 requested_debug_level
,
241 const char *function_name
,
242 const char *module_name
,
243 u32 component_id
, const char *format
, ...)
247 /* Check if debug output enabled */
249 if (!ACPI_IS_DEBUG_ENABLED(requested_debug_level
, component_id
)) {
253 va_start(args
, format
);
254 acpi_os_vprintf(format
, args
);
258 ACPI_EXPORT_SYMBOL(acpi_debug_print_raw
)
260 /*******************************************************************************
262 * FUNCTION: acpi_ut_trace
264 * PARAMETERS: line_number - Caller's line number
265 * function_name - Caller's procedure name
266 * module_name - Caller's module name
267 * component_id - Caller's component ID
271 * DESCRIPTION: Function entry trace. Prints only if TRACE_FUNCTIONS bit is
274 ******************************************************************************/
276 acpi_ut_trace(u32 line_number
,
277 const char *function_name
,
278 const char *module_name
, u32 component_id
)
281 acpi_gbl_nesting_level
++;
282 acpi_ut_track_stack_ptr();
284 /* Check if enabled up-front for performance */
286 if (ACPI_IS_DEBUG_ENABLED(ACPI_LV_FUNCTIONS
, component_id
)) {
287 acpi_debug_print(ACPI_LV_FUNCTIONS
,
288 line_number
, function_name
, module_name
,
289 component_id
, "%s\n", acpi_gbl_fn_entry_str
);
293 ACPI_EXPORT_SYMBOL(acpi_ut_trace
)
295 /*******************************************************************************
297 * FUNCTION: acpi_ut_trace_ptr
299 * PARAMETERS: line_number - Caller's line number
300 * function_name - Caller's procedure name
301 * module_name - Caller's module name
302 * component_id - Caller's component ID
303 * pointer - Pointer to display
307 * DESCRIPTION: Function entry trace. Prints only if TRACE_FUNCTIONS bit is
310 ******************************************************************************/
312 acpi_ut_trace_ptr(u32 line_number
,
313 const char *function_name
,
314 const char *module_name
, u32 component_id
, void *pointer
)
317 acpi_gbl_nesting_level
++;
318 acpi_ut_track_stack_ptr();
320 /* Check if enabled up-front for performance */
322 if (ACPI_IS_DEBUG_ENABLED(ACPI_LV_FUNCTIONS
, component_id
)) {
323 acpi_debug_print(ACPI_LV_FUNCTIONS
,
324 line_number
, function_name
, module_name
,
325 component_id
, "%s %p\n", acpi_gbl_fn_entry_str
,
330 /*******************************************************************************
332 * FUNCTION: acpi_ut_trace_str
334 * PARAMETERS: line_number - Caller's line number
335 * function_name - Caller's procedure name
336 * module_name - Caller's module name
337 * component_id - Caller's component ID
338 * string - Additional string to display
342 * DESCRIPTION: Function entry trace. Prints only if TRACE_FUNCTIONS bit is
345 ******************************************************************************/
348 acpi_ut_trace_str(u32 line_number
,
349 const char *function_name
,
350 const char *module_name
, u32 component_id
, char *string
)
353 acpi_gbl_nesting_level
++;
354 acpi_ut_track_stack_ptr();
356 /* Check if enabled up-front for performance */
358 if (ACPI_IS_DEBUG_ENABLED(ACPI_LV_FUNCTIONS
, component_id
)) {
359 acpi_debug_print(ACPI_LV_FUNCTIONS
,
360 line_number
, function_name
, module_name
,
361 component_id
, "%s %s\n", acpi_gbl_fn_entry_str
,
366 /*******************************************************************************
368 * FUNCTION: acpi_ut_trace_u32
370 * PARAMETERS: line_number - Caller's line number
371 * function_name - Caller's procedure name
372 * module_name - Caller's module name
373 * component_id - Caller's component ID
374 * integer - Integer to display
378 * DESCRIPTION: Function entry trace. Prints only if TRACE_FUNCTIONS bit is
381 ******************************************************************************/
384 acpi_ut_trace_u32(u32 line_number
,
385 const char *function_name
,
386 const char *module_name
, u32 component_id
, u32 integer
)
389 acpi_gbl_nesting_level
++;
390 acpi_ut_track_stack_ptr();
392 /* Check if enabled up-front for performance */
394 if (ACPI_IS_DEBUG_ENABLED(ACPI_LV_FUNCTIONS
, component_id
)) {
395 acpi_debug_print(ACPI_LV_FUNCTIONS
,
396 line_number
, function_name
, module_name
,
397 component_id
, "%s %08X\n",
398 acpi_gbl_fn_entry_str
, integer
);
402 /*******************************************************************************
404 * FUNCTION: acpi_ut_exit
406 * PARAMETERS: line_number - Caller's line number
407 * function_name - Caller's procedure name
408 * module_name - Caller's module name
409 * component_id - Caller's component ID
413 * DESCRIPTION: Function exit trace. Prints only if TRACE_FUNCTIONS bit is
416 ******************************************************************************/
419 acpi_ut_exit(u32 line_number
,
420 const char *function_name
,
421 const char *module_name
, u32 component_id
)
424 /* Check if enabled up-front for performance */
426 if (ACPI_IS_DEBUG_ENABLED(ACPI_LV_FUNCTIONS
, component_id
)) {
427 acpi_debug_print(ACPI_LV_FUNCTIONS
,
428 line_number
, function_name
, module_name
,
429 component_id
, "%s\n", acpi_gbl_fn_exit_str
);
432 if (acpi_gbl_nesting_level
) {
433 acpi_gbl_nesting_level
--;
437 ACPI_EXPORT_SYMBOL(acpi_ut_exit
)
439 /*******************************************************************************
441 * FUNCTION: acpi_ut_status_exit
443 * PARAMETERS: line_number - Caller's line number
444 * function_name - Caller's procedure name
445 * module_name - Caller's module name
446 * component_id - Caller's component ID
447 * status - Exit status code
451 * DESCRIPTION: Function exit trace. Prints only if TRACE_FUNCTIONS bit is
452 * set in debug_level. Prints exit status also.
454 ******************************************************************************/
456 acpi_ut_status_exit(u32 line_number
,
457 const char *function_name
,
458 const char *module_name
,
459 u32 component_id
, acpi_status status
)
462 /* Check if enabled up-front for performance */
464 if (ACPI_IS_DEBUG_ENABLED(ACPI_LV_FUNCTIONS
, component_id
)) {
465 if (ACPI_SUCCESS(status
)) {
466 acpi_debug_print(ACPI_LV_FUNCTIONS
,
467 line_number
, function_name
,
468 module_name
, component_id
, "%s %s\n",
469 acpi_gbl_fn_exit_str
,
470 acpi_format_exception(status
));
472 acpi_debug_print(ACPI_LV_FUNCTIONS
,
473 line_number
, function_name
,
474 module_name
, component_id
,
475 "%s ****Exception****: %s\n",
476 acpi_gbl_fn_exit_str
,
477 acpi_format_exception(status
));
481 if (acpi_gbl_nesting_level
) {
482 acpi_gbl_nesting_level
--;
486 ACPI_EXPORT_SYMBOL(acpi_ut_status_exit
)
488 /*******************************************************************************
490 * FUNCTION: acpi_ut_value_exit
492 * PARAMETERS: line_number - Caller's line number
493 * function_name - Caller's procedure name
494 * module_name - Caller's module name
495 * component_id - Caller's component ID
496 * value - Value to be printed with exit msg
500 * DESCRIPTION: Function exit trace. Prints only if TRACE_FUNCTIONS bit is
501 * set in debug_level. Prints exit value also.
503 ******************************************************************************/
505 acpi_ut_value_exit(u32 line_number
,
506 const char *function_name
,
507 const char *module_name
, u32 component_id
, u64 value
)
510 /* Check if enabled up-front for performance */
512 if (ACPI_IS_DEBUG_ENABLED(ACPI_LV_FUNCTIONS
, component_id
)) {
513 acpi_debug_print(ACPI_LV_FUNCTIONS
,
514 line_number
, function_name
, module_name
,
515 component_id
, "%s %8.8X%8.8X\n",
516 acpi_gbl_fn_exit_str
,
517 ACPI_FORMAT_UINT64(value
));
520 if (acpi_gbl_nesting_level
) {
521 acpi_gbl_nesting_level
--;
525 ACPI_EXPORT_SYMBOL(acpi_ut_value_exit
)
527 /*******************************************************************************
529 * FUNCTION: acpi_ut_ptr_exit
531 * PARAMETERS: line_number - Caller's line number
532 * function_name - Caller's procedure name
533 * module_name - Caller's module name
534 * component_id - Caller's component ID
535 * ptr - Pointer to display
539 * DESCRIPTION: Function exit trace. Prints only if TRACE_FUNCTIONS bit is
540 * set in debug_level. Prints exit value also.
542 ******************************************************************************/
544 acpi_ut_ptr_exit(u32 line_number
,
545 const char *function_name
,
546 const char *module_name
, u32 component_id
, u8
*ptr
)
549 /* Check if enabled up-front for performance */
551 if (ACPI_IS_DEBUG_ENABLED(ACPI_LV_FUNCTIONS
, component_id
)) {
552 acpi_debug_print(ACPI_LV_FUNCTIONS
,
553 line_number
, function_name
, module_name
,
554 component_id
, "%s %p\n", acpi_gbl_fn_exit_str
,
558 if (acpi_gbl_nesting_level
) {
559 acpi_gbl_nesting_level
--;