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