Loading...
1/******************************************************************************
2 *
3 * Module Name: utdebug - Debug print routines
4 *
5 *****************************************************************************/
6
7/*
8 * Copyright (C) 2000 - 2011, Intel Corp.
9 * All rights reserved.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
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.
25 *
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.
29 *
30 * NO WARRANTY
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.
42 */
43
44#include <acpi/acpi.h>
45#include "accommon.h"
46
47#define _COMPONENT ACPI_UTILITIES
48ACPI_MODULE_NAME("utdebug")
49#ifdef ACPI_DEBUG_OUTPUT
50static acpi_thread_id acpi_gbl_prev_thread_id;
51static char *acpi_gbl_fn_entry_str = "----Entry";
52static char *acpi_gbl_fn_exit_str = "----Exit-";
53
54/* Local prototypes */
55
56static const char *acpi_ut_trim_function_name(const char *function_name);
57
58/*******************************************************************************
59 *
60 * FUNCTION: acpi_ut_init_stack_ptr_trace
61 *
62 * PARAMETERS: None
63 *
64 * RETURN: None
65 *
66 * DESCRIPTION: Save the current CPU stack pointer at subsystem startup
67 *
68 ******************************************************************************/
69
70void acpi_ut_init_stack_ptr_trace(void)
71{
72 acpi_size current_sp;
73
74 acpi_gbl_entry_stack_pointer = ¤t_sp;
75}
76
77/*******************************************************************************
78 *
79 * FUNCTION: acpi_ut_track_stack_ptr
80 *
81 * PARAMETERS: None
82 *
83 * RETURN: None
84 *
85 * DESCRIPTION: Save the current CPU stack pointer
86 *
87 ******************************************************************************/
88
89void acpi_ut_track_stack_ptr(void)
90{
91 acpi_size current_sp;
92
93 if (¤t_sp < acpi_gbl_lowest_stack_pointer) {
94 acpi_gbl_lowest_stack_pointer = ¤t_sp;
95 }
96
97 if (acpi_gbl_nesting_level > acpi_gbl_deepest_nesting) {
98 acpi_gbl_deepest_nesting = acpi_gbl_nesting_level;
99 }
100}
101
102/*******************************************************************************
103 *
104 * FUNCTION: acpi_ut_trim_function_name
105 *
106 * PARAMETERS: function_name - Ascii string containing a procedure name
107 *
108 * RETURN: Updated pointer to the function name
109 *
110 * DESCRIPTION: Remove the "Acpi" prefix from the function name, if present.
111 * This allows compiler macros such as __func__ to be used
112 * with no change to the debug output.
113 *
114 ******************************************************************************/
115
116static const char *acpi_ut_trim_function_name(const char *function_name)
117{
118
119 /* All Function names are longer than 4 chars, check is safe */
120
121 if (*(ACPI_CAST_PTR(u32, function_name)) == ACPI_PREFIX_MIXED) {
122
123 /* This is the case where the original source has not been modified */
124
125 return (function_name + 4);
126 }
127
128 if (*(ACPI_CAST_PTR(u32, function_name)) == ACPI_PREFIX_LOWER) {
129
130 /* This is the case where the source has been 'linuxized' */
131
132 return (function_name + 5);
133 }
134
135 return (function_name);
136}
137
138/*******************************************************************************
139 *
140 * FUNCTION: acpi_debug_print
141 *
142 * PARAMETERS: requested_debug_level - Requested debug print level
143 * line_number - Caller's line number (for error output)
144 * function_name - Caller's procedure name
145 * module_name - Caller's module name
146 * component_id - Caller's component ID
147 * Format - Printf format field
148 * ... - Optional printf arguments
149 *
150 * RETURN: None
151 *
152 * DESCRIPTION: Print error message with prefix consisting of the module name,
153 * line number, and component ID.
154 *
155 ******************************************************************************/
156
157void ACPI_INTERNAL_VAR_XFACE
158acpi_debug_print(u32 requested_debug_level,
159 u32 line_number,
160 const char *function_name,
161 const char *module_name,
162 u32 component_id, const char *format, ...)
163{
164 acpi_thread_id thread_id;
165 va_list args;
166
167 /*
168 * Stay silent if the debug level or component ID is disabled
169 */
170 if (!(requested_debug_level & acpi_dbg_level) ||
171 !(component_id & acpi_dbg_layer)) {
172 return;
173 }
174
175 /*
176 * Thread tracking and context switch notification
177 */
178 thread_id = acpi_os_get_thread_id();
179 if (thread_id != acpi_gbl_prev_thread_id) {
180 if (ACPI_LV_THREADS & acpi_dbg_level) {
181 acpi_os_printf
182 ("\n**** Context Switch from TID %u to TID %u ****\n\n",
183 (u32)acpi_gbl_prev_thread_id, (u32)thread_id);
184 }
185
186 acpi_gbl_prev_thread_id = thread_id;
187 }
188
189 /*
190 * Display the module name, current line number, thread ID (if requested),
191 * current procedure nesting level, and the current procedure name
192 */
193 acpi_os_printf("%8s-%04ld ", module_name, line_number);
194
195 if (ACPI_LV_THREADS & acpi_dbg_level) {
196 acpi_os_printf("[%u] ", (u32)thread_id);
197 }
198
199 acpi_os_printf("[%02ld] %-22.22s: ",
200 acpi_gbl_nesting_level,
201 acpi_ut_trim_function_name(function_name));
202
203 va_start(args, format);
204 acpi_os_vprintf(format, args);
205 va_end(args);
206}
207
208ACPI_EXPORT_SYMBOL(acpi_debug_print)
209
210/*******************************************************************************
211 *
212 * FUNCTION: acpi_debug_print_raw
213 *
214 * PARAMETERS: requested_debug_level - Requested debug print level
215 * line_number - Caller's line number
216 * function_name - Caller's procedure name
217 * module_name - Caller's module name
218 * component_id - Caller's component ID
219 * Format - Printf format field
220 * ... - Optional printf arguments
221 *
222 * RETURN: None
223 *
224 * DESCRIPTION: Print message with no headers. Has same interface as
225 * debug_print so that the same macros can be used.
226 *
227 ******************************************************************************/
228void ACPI_INTERNAL_VAR_XFACE
229acpi_debug_print_raw(u32 requested_debug_level,
230 u32 line_number,
231 const char *function_name,
232 const char *module_name,
233 u32 component_id, const char *format, ...)
234{
235 va_list args;
236
237 if (!(requested_debug_level & acpi_dbg_level) ||
238 !(component_id & acpi_dbg_layer)) {
239 return;
240 }
241
242 va_start(args, format);
243 acpi_os_vprintf(format, args);
244 va_end(args);
245}
246
247ACPI_EXPORT_SYMBOL(acpi_debug_print_raw)
248
249/*******************************************************************************
250 *
251 * FUNCTION: acpi_ut_trace
252 *
253 * PARAMETERS: line_number - Caller's line number
254 * function_name - Caller's procedure name
255 * module_name - Caller's module name
256 * component_id - Caller's component ID
257 *
258 * RETURN: None
259 *
260 * DESCRIPTION: Function entry trace. Prints only if TRACE_FUNCTIONS bit is
261 * set in debug_level
262 *
263 ******************************************************************************/
264void
265acpi_ut_trace(u32 line_number,
266 const char *function_name,
267 const char *module_name, u32 component_id)
268{
269
270 acpi_gbl_nesting_level++;
271 acpi_ut_track_stack_ptr();
272
273 acpi_debug_print(ACPI_LV_FUNCTIONS,
274 line_number, function_name, module_name, component_id,
275 "%s\n", acpi_gbl_fn_entry_str);
276}
277
278ACPI_EXPORT_SYMBOL(acpi_ut_trace)
279
280/*******************************************************************************
281 *
282 * FUNCTION: acpi_ut_trace_ptr
283 *
284 * PARAMETERS: line_number - Caller's line number
285 * function_name - Caller's procedure name
286 * module_name - Caller's module name
287 * component_id - Caller's component ID
288 * Pointer - Pointer to display
289 *
290 * RETURN: None
291 *
292 * DESCRIPTION: Function entry trace. Prints only if TRACE_FUNCTIONS bit is
293 * set in debug_level
294 *
295 ******************************************************************************/
296void
297acpi_ut_trace_ptr(u32 line_number,
298 const char *function_name,
299 const char *module_name, u32 component_id, void *pointer)
300{
301 acpi_gbl_nesting_level++;
302 acpi_ut_track_stack_ptr();
303
304 acpi_debug_print(ACPI_LV_FUNCTIONS,
305 line_number, function_name, module_name, component_id,
306 "%s %p\n", acpi_gbl_fn_entry_str, pointer);
307}
308
309/*******************************************************************************
310 *
311 * FUNCTION: acpi_ut_trace_str
312 *
313 * PARAMETERS: line_number - Caller's line number
314 * function_name - Caller's procedure name
315 * module_name - Caller's module name
316 * component_id - Caller's component ID
317 * String - Additional string to display
318 *
319 * RETURN: None
320 *
321 * DESCRIPTION: Function entry trace. Prints only if TRACE_FUNCTIONS bit is
322 * set in debug_level
323 *
324 ******************************************************************************/
325
326void
327acpi_ut_trace_str(u32 line_number,
328 const char *function_name,
329 const char *module_name, u32 component_id, char *string)
330{
331
332 acpi_gbl_nesting_level++;
333 acpi_ut_track_stack_ptr();
334
335 acpi_debug_print(ACPI_LV_FUNCTIONS,
336 line_number, function_name, module_name, component_id,
337 "%s %s\n", acpi_gbl_fn_entry_str, string);
338}
339
340/*******************************************************************************
341 *
342 * FUNCTION: acpi_ut_trace_u32
343 *
344 * PARAMETERS: line_number - Caller's line number
345 * function_name - Caller's procedure name
346 * module_name - Caller's module name
347 * component_id - Caller's component ID
348 * Integer - Integer to display
349 *
350 * RETURN: None
351 *
352 * DESCRIPTION: Function entry trace. Prints only if TRACE_FUNCTIONS bit is
353 * set in debug_level
354 *
355 ******************************************************************************/
356
357void
358acpi_ut_trace_u32(u32 line_number,
359 const char *function_name,
360 const char *module_name, u32 component_id, u32 integer)
361{
362
363 acpi_gbl_nesting_level++;
364 acpi_ut_track_stack_ptr();
365
366 acpi_debug_print(ACPI_LV_FUNCTIONS,
367 line_number, function_name, module_name, component_id,
368 "%s %08X\n", acpi_gbl_fn_entry_str, integer);
369}
370
371/*******************************************************************************
372 *
373 * FUNCTION: acpi_ut_exit
374 *
375 * PARAMETERS: line_number - Caller's line number
376 * function_name - Caller's procedure name
377 * module_name - Caller's module name
378 * component_id - Caller's component ID
379 *
380 * RETURN: None
381 *
382 * DESCRIPTION: Function exit trace. Prints only if TRACE_FUNCTIONS bit is
383 * set in debug_level
384 *
385 ******************************************************************************/
386
387void
388acpi_ut_exit(u32 line_number,
389 const char *function_name,
390 const char *module_name, u32 component_id)
391{
392
393 acpi_debug_print(ACPI_LV_FUNCTIONS,
394 line_number, function_name, module_name, component_id,
395 "%s\n", acpi_gbl_fn_exit_str);
396
397 acpi_gbl_nesting_level--;
398}
399
400ACPI_EXPORT_SYMBOL(acpi_ut_exit)
401
402/*******************************************************************************
403 *
404 * FUNCTION: acpi_ut_status_exit
405 *
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
410 * Status - Exit status code
411 *
412 * RETURN: None
413 *
414 * DESCRIPTION: Function exit trace. Prints only if TRACE_FUNCTIONS bit is
415 * set in debug_level. Prints exit status also.
416 *
417 ******************************************************************************/
418void
419acpi_ut_status_exit(u32 line_number,
420 const char *function_name,
421 const char *module_name,
422 u32 component_id, acpi_status status)
423{
424
425 if (ACPI_SUCCESS(status)) {
426 acpi_debug_print(ACPI_LV_FUNCTIONS,
427 line_number, function_name, module_name,
428 component_id, "%s %s\n", acpi_gbl_fn_exit_str,
429 acpi_format_exception(status));
430 } else {
431 acpi_debug_print(ACPI_LV_FUNCTIONS,
432 line_number, function_name, module_name,
433 component_id, "%s ****Exception****: %s\n",
434 acpi_gbl_fn_exit_str,
435 acpi_format_exception(status));
436 }
437
438 acpi_gbl_nesting_level--;
439}
440
441ACPI_EXPORT_SYMBOL(acpi_ut_status_exit)
442
443/*******************************************************************************
444 *
445 * FUNCTION: acpi_ut_value_exit
446 *
447 * PARAMETERS: line_number - Caller's line number
448 * function_name - Caller's procedure name
449 * module_name - Caller's module name
450 * component_id - Caller's component ID
451 * Value - Value to be printed with exit msg
452 *
453 * RETURN: None
454 *
455 * DESCRIPTION: Function exit trace. Prints only if TRACE_FUNCTIONS bit is
456 * set in debug_level. Prints exit value also.
457 *
458 ******************************************************************************/
459void
460acpi_ut_value_exit(u32 line_number,
461 const char *function_name,
462 const char *module_name, u32 component_id, u64 value)
463{
464
465 acpi_debug_print(ACPI_LV_FUNCTIONS,
466 line_number, function_name, module_name, component_id,
467 "%s %8.8X%8.8X\n", acpi_gbl_fn_exit_str,
468 ACPI_FORMAT_UINT64(value));
469
470 acpi_gbl_nesting_level--;
471}
472
473ACPI_EXPORT_SYMBOL(acpi_ut_value_exit)
474
475/*******************************************************************************
476 *
477 * FUNCTION: acpi_ut_ptr_exit
478 *
479 * PARAMETERS: line_number - Caller's line number
480 * function_name - Caller's procedure name
481 * module_name - Caller's module name
482 * component_id - Caller's component ID
483 * Ptr - Pointer to display
484 *
485 * RETURN: None
486 *
487 * DESCRIPTION: Function exit trace. Prints only if TRACE_FUNCTIONS bit is
488 * set in debug_level. Prints exit value also.
489 *
490 ******************************************************************************/
491void
492acpi_ut_ptr_exit(u32 line_number,
493 const char *function_name,
494 const char *module_name, u32 component_id, u8 *ptr)
495{
496
497 acpi_debug_print(ACPI_LV_FUNCTIONS,
498 line_number, function_name, module_name, component_id,
499 "%s %p\n", acpi_gbl_fn_exit_str, ptr);
500
501 acpi_gbl_nesting_level--;
502}
503
504#endif
505
506/*******************************************************************************
507 *
508 * FUNCTION: acpi_ut_dump_buffer
509 *
510 * PARAMETERS: Buffer - Buffer to dump
511 * Count - Amount to dump, in bytes
512 * Display - BYTE, WORD, DWORD, or QWORD display
513 * component_iD - Caller's component ID
514 *
515 * RETURN: None
516 *
517 * DESCRIPTION: Generic dump buffer in both hex and ascii.
518 *
519 ******************************************************************************/
520
521void acpi_ut_dump_buffer2(u8 * buffer, u32 count, u32 display)
522{
523 u32 i = 0;
524 u32 j;
525 u32 temp32;
526 u8 buf_char;
527
528 if (!buffer) {
529 acpi_os_printf("Null Buffer Pointer in DumpBuffer!\n");
530 return;
531 }
532
533 if ((count < 4) || (count & 0x01)) {
534 display = DB_BYTE_DISPLAY;
535 }
536
537 /* Nasty little dump buffer routine! */
538
539 while (i < count) {
540
541 /* Print current offset */
542
543 acpi_os_printf("%6.4X: ", i);
544
545 /* Print 16 hex chars */
546
547 for (j = 0; j < 16;) {
548 if (i + j >= count) {
549
550 /* Dump fill spaces */
551
552 acpi_os_printf("%*s", ((display * 2) + 1), " ");
553 j += display;
554 continue;
555 }
556
557 switch (display) {
558 case DB_BYTE_DISPLAY:
559 default: /* Default is BYTE display */
560
561 acpi_os_printf("%02X ",
562 buffer[(acpi_size) i + j]);
563 break;
564
565 case DB_WORD_DISPLAY:
566
567 ACPI_MOVE_16_TO_32(&temp32,
568 &buffer[(acpi_size) i + j]);
569 acpi_os_printf("%04X ", temp32);
570 break;
571
572 case DB_DWORD_DISPLAY:
573
574 ACPI_MOVE_32_TO_32(&temp32,
575 &buffer[(acpi_size) i + j]);
576 acpi_os_printf("%08X ", temp32);
577 break;
578
579 case DB_QWORD_DISPLAY:
580
581 ACPI_MOVE_32_TO_32(&temp32,
582 &buffer[(acpi_size) i + j]);
583 acpi_os_printf("%08X", temp32);
584
585 ACPI_MOVE_32_TO_32(&temp32,
586 &buffer[(acpi_size) i + j +
587 4]);
588 acpi_os_printf("%08X ", temp32);
589 break;
590 }
591
592 j += display;
593 }
594
595 /*
596 * Print the ASCII equivalent characters but watch out for the bad
597 * unprintable ones (printable chars are 0x20 through 0x7E)
598 */
599 acpi_os_printf(" ");
600 for (j = 0; j < 16; j++) {
601 if (i + j >= count) {
602 acpi_os_printf("\n");
603 return;
604 }
605
606 buf_char = buffer[(acpi_size) i + j];
607 if (ACPI_IS_PRINT(buf_char)) {
608 acpi_os_printf("%c", buf_char);
609 } else {
610 acpi_os_printf(".");
611 }
612 }
613
614 /* Done with that line. */
615
616 acpi_os_printf("\n");
617 i += 16;
618 }
619
620 return;
621}
622
623/*******************************************************************************
624 *
625 * FUNCTION: acpi_ut_dump_buffer
626 *
627 * PARAMETERS: Buffer - Buffer to dump
628 * Count - Amount to dump, in bytes
629 * Display - BYTE, WORD, DWORD, or QWORD display
630 * component_iD - Caller's component ID
631 *
632 * RETURN: None
633 *
634 * DESCRIPTION: Generic dump buffer in both hex and ascii.
635 *
636 ******************************************************************************/
637
638void acpi_ut_dump_buffer(u8 * buffer, u32 count, u32 display, u32 component_id)
639{
640
641 /* Only dump the buffer if tracing is enabled */
642
643 if (!((ACPI_LV_TABLES & acpi_dbg_level) &&
644 (component_id & acpi_dbg_layer))) {
645 return;
646 }
647
648 acpi_ut_dump_buffer2(buffer, count, display);
649}
1// SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0
2/******************************************************************************
3 *
4 * Module Name: utdebug - Debug print/trace routines
5 *
6 * Copyright (C) 2000 - 2023, Intel Corp.
7 *
8 *****************************************************************************/
9
10#define EXPORT_ACPI_INTERFACES
11
12#include <acpi/acpi.h>
13#include "accommon.h"
14#include "acinterp.h"
15
16#define _COMPONENT ACPI_UTILITIES
17ACPI_MODULE_NAME("utdebug")
18
19#ifdef ACPI_DEBUG_OUTPUT
20static acpi_thread_id acpi_gbl_previous_thread_id = (acpi_thread_id) 0xFFFFFFFF;
21static const char *acpi_gbl_function_entry_prefix = "----Entry";
22static const char *acpi_gbl_function_exit_prefix = "----Exit-";
23
24/*******************************************************************************
25 *
26 * FUNCTION: acpi_ut_init_stack_ptr_trace
27 *
28 * PARAMETERS: None
29 *
30 * RETURN: None
31 *
32 * DESCRIPTION: Save the current CPU stack pointer at subsystem startup
33 *
34 ******************************************************************************/
35
36void acpi_ut_init_stack_ptr_trace(void)
37{
38 acpi_size current_sp;
39
40#pragma GCC diagnostic push
41#if defined(__GNUC__) && __GNUC__ >= 12
42#pragma GCC diagnostic ignored "-Wdangling-pointer="
43#endif
44 acpi_gbl_entry_stack_pointer = ¤t_sp;
45#pragma GCC diagnostic pop
46}
47
48/*******************************************************************************
49 *
50 * FUNCTION: acpi_ut_track_stack_ptr
51 *
52 * PARAMETERS: None
53 *
54 * RETURN: None
55 *
56 * DESCRIPTION: Save the current CPU stack pointer
57 *
58 ******************************************************************************/
59
60void acpi_ut_track_stack_ptr(void)
61{
62 acpi_size current_sp;
63
64 if (¤t_sp < acpi_gbl_lowest_stack_pointer) {
65#pragma GCC diagnostic push
66#if defined(__GNUC__) && __GNUC__ >= 12
67#pragma GCC diagnostic ignored "-Wdangling-pointer="
68#endif
69 acpi_gbl_lowest_stack_pointer = ¤t_sp;
70#pragma GCC diagnostic pop
71 }
72
73 if (acpi_gbl_nesting_level > acpi_gbl_deepest_nesting) {
74 acpi_gbl_deepest_nesting = acpi_gbl_nesting_level;
75 }
76}
77
78/*******************************************************************************
79 *
80 * FUNCTION: acpi_ut_trim_function_name
81 *
82 * PARAMETERS: function_name - Ascii string containing a procedure name
83 *
84 * RETURN: Updated pointer to the function name
85 *
86 * DESCRIPTION: Remove the "Acpi" prefix from the function name, if present.
87 * This allows compiler macros such as __func__ to be used
88 * with no change to the debug output.
89 *
90 ******************************************************************************/
91
92static const char *acpi_ut_trim_function_name(const char *function_name)
93{
94
95 /* All Function names are longer than 4 chars, check is safe */
96
97 if (*(ACPI_CAST_PTR(u32, function_name)) == ACPI_PREFIX_MIXED) {
98
99 /* This is the case where the original source has not been modified */
100
101 return (function_name + 4);
102 }
103
104 if (*(ACPI_CAST_PTR(u32, function_name)) == ACPI_PREFIX_LOWER) {
105
106 /* This is the case where the source has been 'linuxized' */
107
108 return (function_name + 5);
109 }
110
111 return (function_name);
112}
113
114/*******************************************************************************
115 *
116 * FUNCTION: acpi_debug_print
117 *
118 * PARAMETERS: requested_debug_level - Requested debug print level
119 * line_number - Caller's line number (for error output)
120 * function_name - Caller's procedure name
121 * module_name - Caller's module name
122 * component_id - Caller's component ID
123 * format - Printf format field
124 * ... - Optional printf arguments
125 *
126 * RETURN: None
127 *
128 * DESCRIPTION: Print error message with prefix consisting of the module name,
129 * line number, and component ID.
130 *
131 ******************************************************************************/
132
133void ACPI_INTERNAL_VAR_XFACE
134acpi_debug_print(u32 requested_debug_level,
135 u32 line_number,
136 const char *function_name,
137 const char *module_name,
138 u32 component_id, const char *format, ...)
139{
140 acpi_thread_id thread_id;
141 va_list args;
142#ifdef ACPI_APPLICATION
143 int fill_count;
144#endif
145
146 /* Check if debug output enabled */
147
148 if (!ACPI_IS_DEBUG_ENABLED(requested_debug_level, component_id)) {
149 return;
150 }
151
152 /*
153 * Thread tracking and context switch notification
154 */
155 thread_id = acpi_os_get_thread_id();
156 if (thread_id != acpi_gbl_previous_thread_id) {
157 if (ACPI_LV_THREADS & acpi_dbg_level) {
158 acpi_os_printf
159 ("\n**** Context Switch from TID %u to TID %u ****\n\n",
160 (u32)acpi_gbl_previous_thread_id, (u32)thread_id);
161 }
162
163 acpi_gbl_previous_thread_id = thread_id;
164 acpi_gbl_nesting_level = 0;
165 }
166
167 /*
168 * Display the module name, current line number, thread ID (if requested),
169 * current procedure nesting level, and the current procedure name
170 */
171 acpi_os_printf("%9s-%04d ", module_name, line_number);
172
173#ifdef ACPI_APPLICATION
174 /*
175 * For acpi_exec/iASL only, emit the thread ID and nesting level.
176 * Note: nesting level is really only useful during a single-thread
177 * execution. Otherwise, multiple threads will keep resetting the
178 * level.
179 */
180 if (ACPI_LV_THREADS & acpi_dbg_level) {
181 acpi_os_printf("[%u] ", (u32)thread_id);
182 }
183
184 fill_count = 48 - acpi_gbl_nesting_level -
185 strlen(acpi_ut_trim_function_name(function_name));
186 if (fill_count < 0) {
187 fill_count = 0;
188 }
189
190 acpi_os_printf("[%02d] %*s",
191 acpi_gbl_nesting_level, acpi_gbl_nesting_level + 1, " ");
192 acpi_os_printf("%s%*s: ",
193 acpi_ut_trim_function_name(function_name), fill_count,
194 " ");
195
196#else
197 acpi_os_printf("%-22.22s: ", acpi_ut_trim_function_name(function_name));
198#endif
199
200 va_start(args, format);
201 acpi_os_vprintf(format, args);
202 va_end(args);
203}
204
205ACPI_EXPORT_SYMBOL(acpi_debug_print)
206
207/*******************************************************************************
208 *
209 * FUNCTION: acpi_debug_print_raw
210 *
211 * PARAMETERS: requested_debug_level - Requested debug print level
212 * line_number - Caller's line number
213 * function_name - Caller's procedure name
214 * module_name - Caller's module name
215 * component_id - Caller's component ID
216 * format - Printf format field
217 * ... - Optional printf arguments
218 *
219 * RETURN: None
220 *
221 * DESCRIPTION: Print message with no headers. Has same interface as
222 * debug_print so that the same macros can be used.
223 *
224 ******************************************************************************/
225void ACPI_INTERNAL_VAR_XFACE
226acpi_debug_print_raw(u32 requested_debug_level,
227 u32 line_number,
228 const char *function_name,
229 const char *module_name,
230 u32 component_id, const char *format, ...)
231{
232 va_list args;
233
234 /* Check if debug output enabled */
235
236 if (!ACPI_IS_DEBUG_ENABLED(requested_debug_level, component_id)) {
237 return;
238 }
239
240 va_start(args, format);
241 acpi_os_vprintf(format, args);
242 va_end(args);
243}
244
245ACPI_EXPORT_SYMBOL(acpi_debug_print_raw)
246
247/*******************************************************************************
248 *
249 * FUNCTION: acpi_ut_trace
250 *
251 * PARAMETERS: line_number - Caller's line number
252 * function_name - Caller's procedure name
253 * module_name - Caller's module name
254 * component_id - Caller's component ID
255 *
256 * RETURN: None
257 *
258 * DESCRIPTION: Function entry trace. Prints only if TRACE_FUNCTIONS bit is
259 * set in debug_level
260 *
261 ******************************************************************************/
262void
263acpi_ut_trace(u32 line_number,
264 const char *function_name,
265 const char *module_name, u32 component_id)
266{
267
268 acpi_gbl_nesting_level++;
269 acpi_ut_track_stack_ptr();
270
271 /* Check if enabled up-front for performance */
272
273 if (ACPI_IS_DEBUG_ENABLED(ACPI_LV_FUNCTIONS, component_id)) {
274 acpi_debug_print(ACPI_LV_FUNCTIONS,
275 line_number, function_name, module_name,
276 component_id, "%s\n",
277 acpi_gbl_function_entry_prefix);
278 }
279}
280
281ACPI_EXPORT_SYMBOL(acpi_ut_trace)
282
283/*******************************************************************************
284 *
285 * FUNCTION: acpi_ut_trace_ptr
286 *
287 * PARAMETERS: line_number - Caller's line number
288 * function_name - Caller's procedure name
289 * module_name - Caller's module name
290 * component_id - Caller's component ID
291 * pointer - Pointer to display
292 *
293 * RETURN: None
294 *
295 * DESCRIPTION: Function entry trace. Prints only if TRACE_FUNCTIONS bit is
296 * set in debug_level
297 *
298 ******************************************************************************/
299void
300acpi_ut_trace_ptr(u32 line_number,
301 const char *function_name,
302 const char *module_name,
303 u32 component_id, const void *pointer)
304{
305
306 acpi_gbl_nesting_level++;
307 acpi_ut_track_stack_ptr();
308
309 /* Check if enabled up-front for performance */
310
311 if (ACPI_IS_DEBUG_ENABLED(ACPI_LV_FUNCTIONS, component_id)) {
312 acpi_debug_print(ACPI_LV_FUNCTIONS,
313 line_number, function_name, module_name,
314 component_id, "%s %p\n",
315 acpi_gbl_function_entry_prefix, pointer);
316 }
317}
318
319/*******************************************************************************
320 *
321 * FUNCTION: acpi_ut_trace_str
322 *
323 * PARAMETERS: line_number - Caller's line number
324 * function_name - Caller's procedure name
325 * module_name - Caller's module name
326 * component_id - Caller's component ID
327 * string - Additional string to display
328 *
329 * RETURN: None
330 *
331 * DESCRIPTION: Function entry trace. Prints only if TRACE_FUNCTIONS bit is
332 * set in debug_level
333 *
334 ******************************************************************************/
335
336void
337acpi_ut_trace_str(u32 line_number,
338 const char *function_name,
339 const char *module_name, u32 component_id, const char *string)
340{
341
342 acpi_gbl_nesting_level++;
343 acpi_ut_track_stack_ptr();
344
345 /* Check if enabled up-front for performance */
346
347 if (ACPI_IS_DEBUG_ENABLED(ACPI_LV_FUNCTIONS, component_id)) {
348 acpi_debug_print(ACPI_LV_FUNCTIONS,
349 line_number, function_name, module_name,
350 component_id, "%s %s\n",
351 acpi_gbl_function_entry_prefix, string);
352 }
353}
354
355/*******************************************************************************
356 *
357 * FUNCTION: acpi_ut_trace_u32
358 *
359 * PARAMETERS: line_number - Caller's line number
360 * function_name - Caller's procedure name
361 * module_name - Caller's module name
362 * component_id - Caller's component ID
363 * integer - Integer to display
364 *
365 * RETURN: None
366 *
367 * DESCRIPTION: Function entry trace. Prints only if TRACE_FUNCTIONS bit is
368 * set in debug_level
369 *
370 ******************************************************************************/
371
372void
373acpi_ut_trace_u32(u32 line_number,
374 const char *function_name,
375 const char *module_name, u32 component_id, u32 integer)
376{
377
378 acpi_gbl_nesting_level++;
379 acpi_ut_track_stack_ptr();
380
381 /* Check if enabled up-front for performance */
382
383 if (ACPI_IS_DEBUG_ENABLED(ACPI_LV_FUNCTIONS, component_id)) {
384 acpi_debug_print(ACPI_LV_FUNCTIONS,
385 line_number, function_name, module_name,
386 component_id, "%s %08X\n",
387 acpi_gbl_function_entry_prefix, integer);
388 }
389}
390
391/*******************************************************************************
392 *
393 * FUNCTION: acpi_ut_exit
394 *
395 * PARAMETERS: line_number - Caller's line number
396 * function_name - Caller's procedure name
397 * module_name - Caller's module name
398 * component_id - Caller's component ID
399 *
400 * RETURN: None
401 *
402 * DESCRIPTION: Function exit trace. Prints only if TRACE_FUNCTIONS bit is
403 * set in debug_level
404 *
405 ******************************************************************************/
406
407void
408acpi_ut_exit(u32 line_number,
409 const char *function_name,
410 const char *module_name, u32 component_id)
411{
412
413 /* Check if enabled up-front for performance */
414
415 if (ACPI_IS_DEBUG_ENABLED(ACPI_LV_FUNCTIONS, component_id)) {
416 acpi_debug_print(ACPI_LV_FUNCTIONS,
417 line_number, function_name, module_name,
418 component_id, "%s\n",
419 acpi_gbl_function_exit_prefix);
420 }
421
422 if (acpi_gbl_nesting_level) {
423 acpi_gbl_nesting_level--;
424 }
425}
426
427ACPI_EXPORT_SYMBOL(acpi_ut_exit)
428
429/*******************************************************************************
430 *
431 * FUNCTION: acpi_ut_status_exit
432 *
433 * PARAMETERS: line_number - Caller's line number
434 * function_name - Caller's procedure name
435 * module_name - Caller's module name
436 * component_id - Caller's component ID
437 * status - Exit status code
438 *
439 * RETURN: None
440 *
441 * DESCRIPTION: Function exit trace. Prints only if TRACE_FUNCTIONS bit is
442 * set in debug_level. Prints exit status also.
443 *
444 ******************************************************************************/
445void
446acpi_ut_status_exit(u32 line_number,
447 const char *function_name,
448 const char *module_name,
449 u32 component_id, acpi_status status)
450{
451
452 /* Check if enabled up-front for performance */
453
454 if (ACPI_IS_DEBUG_ENABLED(ACPI_LV_FUNCTIONS, component_id)) {
455 if (ACPI_SUCCESS(status)) {
456 acpi_debug_print(ACPI_LV_FUNCTIONS,
457 line_number, function_name,
458 module_name, component_id, "%s %s\n",
459 acpi_gbl_function_exit_prefix,
460 acpi_format_exception(status));
461 } else {
462 acpi_debug_print(ACPI_LV_FUNCTIONS,
463 line_number, function_name,
464 module_name, component_id,
465 "%s ****Exception****: %s\n",
466 acpi_gbl_function_exit_prefix,
467 acpi_format_exception(status));
468 }
469 }
470
471 if (acpi_gbl_nesting_level) {
472 acpi_gbl_nesting_level--;
473 }
474}
475
476ACPI_EXPORT_SYMBOL(acpi_ut_status_exit)
477
478/*******************************************************************************
479 *
480 * FUNCTION: acpi_ut_value_exit
481 *
482 * PARAMETERS: line_number - Caller's line number
483 * function_name - Caller's procedure name
484 * module_name - Caller's module name
485 * component_id - Caller's component ID
486 * value - Value to be printed with exit msg
487 *
488 * RETURN: None
489 *
490 * DESCRIPTION: Function exit trace. Prints only if TRACE_FUNCTIONS bit is
491 * set in debug_level. Prints exit value also.
492 *
493 ******************************************************************************/
494void
495acpi_ut_value_exit(u32 line_number,
496 const char *function_name,
497 const char *module_name, u32 component_id, u64 value)
498{
499
500 /* Check if enabled up-front for performance */
501
502 if (ACPI_IS_DEBUG_ENABLED(ACPI_LV_FUNCTIONS, component_id)) {
503 acpi_debug_print(ACPI_LV_FUNCTIONS,
504 line_number, function_name, module_name,
505 component_id, "%s %8.8X%8.8X\n",
506 acpi_gbl_function_exit_prefix,
507 ACPI_FORMAT_UINT64(value));
508 }
509
510 if (acpi_gbl_nesting_level) {
511 acpi_gbl_nesting_level--;
512 }
513}
514
515ACPI_EXPORT_SYMBOL(acpi_ut_value_exit)
516
517/*******************************************************************************
518 *
519 * FUNCTION: acpi_ut_ptr_exit
520 *
521 * PARAMETERS: line_number - Caller's line number
522 * function_name - Caller's procedure name
523 * module_name - Caller's module name
524 * component_id - Caller's component ID
525 * ptr - Pointer to display
526 *
527 * RETURN: None
528 *
529 * DESCRIPTION: Function exit trace. Prints only if TRACE_FUNCTIONS bit is
530 * set in debug_level. Prints exit value also.
531 *
532 ******************************************************************************/
533void
534acpi_ut_ptr_exit(u32 line_number,
535 const char *function_name,
536 const char *module_name, u32 component_id, u8 *ptr)
537{
538
539 /* Check if enabled up-front for performance */
540
541 if (ACPI_IS_DEBUG_ENABLED(ACPI_LV_FUNCTIONS, component_id)) {
542 acpi_debug_print(ACPI_LV_FUNCTIONS,
543 line_number, function_name, module_name,
544 component_id, "%s %p\n",
545 acpi_gbl_function_exit_prefix, ptr);
546 }
547
548 if (acpi_gbl_nesting_level) {
549 acpi_gbl_nesting_level--;
550 }
551}
552
553/*******************************************************************************
554 *
555 * FUNCTION: acpi_ut_str_exit
556 *
557 * PARAMETERS: line_number - Caller's line number
558 * function_name - Caller's procedure name
559 * module_name - Caller's module name
560 * component_id - Caller's component ID
561 * string - String to display
562 *
563 * RETURN: None
564 *
565 * DESCRIPTION: Function exit trace. Prints only if TRACE_FUNCTIONS bit is
566 * set in debug_level. Prints exit value also.
567 *
568 ******************************************************************************/
569
570void
571acpi_ut_str_exit(u32 line_number,
572 const char *function_name,
573 const char *module_name, u32 component_id, const char *string)
574{
575
576 /* Check if enabled up-front for performance */
577
578 if (ACPI_IS_DEBUG_ENABLED(ACPI_LV_FUNCTIONS, component_id)) {
579 acpi_debug_print(ACPI_LV_FUNCTIONS,
580 line_number, function_name, module_name,
581 component_id, "%s %s\n",
582 acpi_gbl_function_exit_prefix, string);
583 }
584
585 if (acpi_gbl_nesting_level) {
586 acpi_gbl_nesting_level--;
587 }
588}
589
590/*******************************************************************************
591 *
592 * FUNCTION: acpi_trace_point
593 *
594 * PARAMETERS: type - Trace event type
595 * begin - TRUE if before execution
596 * aml - Executed AML address
597 * pathname - Object path
598 * pointer - Pointer to the related object
599 *
600 * RETURN: None
601 *
602 * DESCRIPTION: Interpreter execution trace.
603 *
604 ******************************************************************************/
605
606void
607acpi_trace_point(acpi_trace_event_type type, u8 begin, u8 *aml, char *pathname)
608{
609
610 ACPI_FUNCTION_ENTRY();
611
612 acpi_ex_trace_point(type, begin, aml, pathname);
613
614#ifdef ACPI_USE_SYSTEM_TRACER
615 acpi_os_trace_point(type, begin, aml, pathname);
616#endif
617}
618
619ACPI_EXPORT_SYMBOL(acpi_trace_point)
620
621#endif