1 /******************************************************************************
3 * Module Name: utdebug - Debug print/trace routines
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2014, Intel Corp.
12 * All rights reserved.
16 * 2.1. This is your license from Intel Corp. under its intellectual property
17 * rights. You may have additional license terms from the party that provided
18 * you this software, covering your right to use that party's intellectual
21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22 * copy of the source code appearing in this file ("Covered Code") an
23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24 * base code distributed originally by Intel ("Original Intel Code") to copy,
25 * make derivatives, distribute, use and display any portion of the Covered
26 * Code in any form, with the right to sublicense such rights; and
28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29 * license (with the right to sublicense), under only those claims of Intel
30 * patents that are infringed by the Original Intel Code, to make, use, sell,
31 * offer to sell, and import the Covered Code and derivative works thereof
32 * solely to the minimum extent necessary to exercise the above copyright
33 * license, and in no event shall the patent license extend to any additions
34 * to or modifications of the Original Intel Code. No other license or right
35 * is granted directly or by implication, estoppel or otherwise;
37 * The above copyright and patent license is granted only if the following
42 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43 * Redistribution of source code of any substantial portion of the Covered
44 * Code or modification with rights to further distribute source must include
45 * the above Copyright Notice, the above License, this list of Conditions,
46 * and the following Disclaimer and Export Compliance provision. In addition,
47 * Licensee must cause all Covered Code to which Licensee contributes to
48 * contain a file documenting the changes Licensee made to create that Covered
49 * Code and the date of any change. Licensee must include in that file the
50 * documentation of any changes made by any predecessor Licensee. Licensee
51 * must include a prominent statement that the modification is derived,
52 * directly or indirectly, from Original Intel Code.
54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55 * Redistribution of source code of any substantial portion of the Covered
56 * Code or modification without rights to further distribute source must
57 * include the following Disclaimer and Export Compliance provision in the
58 * documentation and/or other materials provided with distribution. In
59 * addition, Licensee may not authorize further sublicense of source of any
60 * portion of the Covered Code, and must include terms to the effect that the
61 * license from Licensee to its licensee is limited to the intellectual
62 * property embodied in the software Licensee provides to its licensee, and
63 * not to intellectual property embodied in modifications its licensee may
66 * 3.3. Redistribution of Executable. Redistribution in executable form of any
67 * substantial portion of the Covered Code or modification must reproduce the
68 * above Copyright Notice, and the following Disclaimer and Export Compliance
69 * provision in the documentation and/or other materials provided with the
72 * 3.4. Intel retains all right, title, and interest in and to the Original
75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76 * Intel shall be used in advertising or otherwise to promote the sale, use or
77 * other dealings in products derived from or relating to the Covered Code
78 * without prior written authorization from Intel.
80 * 4. Disclaimer and Export Compliance
82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
99 * 4.3. Licensee shall not export, either directly or indirectly, any of this
100 * software or system incorporating such software without first obtaining any
101 * required license or other approval from the U. S. Department of Commerce or
102 * any other agency or department of the United States Government. In the
103 * event Licensee exports any such software from the United States or
104 * re-exports any such software from a foreign destination, Licensee shall
105 * ensure that the distribution and export/re-export of the software is in
106 * compliance with all laws, regulations, orders, or other restrictions of the
107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108 * any of its subsidiaries will export/re-export any technical data, process,
109 * software, or service, directly or indirectly, to any country for which the
110 * United States government or any agency thereof requires an export license,
111 * other governmental approval, or letter of assurance, without first obtaining
112 * such license, approval or letter.
114 *****************************************************************************/
116 #define __UTDEBUG_C__
117 #define EXPORT_ACPI_INTERFACES
120 #include "accommon.h"
122 #define _COMPONENT ACPI_UTILITIES
123 ACPI_MODULE_NAME ("utdebug")
126 #ifdef ACPI_DEBUG_OUTPUT
128 static ACPI_THREAD_ID AcpiGbl_PrevThreadId
= (ACPI_THREAD_ID
) 0xFFFFFFFF;
129 static char *AcpiGbl_FnEntryStr
= "----Entry";
130 static char *AcpiGbl_FnExitStr
= "----Exit-";
132 /* Local prototypes */
135 AcpiUtTrimFunctionName (
136 const char *FunctionName
);
139 /*******************************************************************************
141 * FUNCTION: AcpiUtInitStackPtrTrace
147 * DESCRIPTION: Save the current CPU stack pointer at subsystem startup
149 ******************************************************************************/
152 AcpiUtInitStackPtrTrace (
158 AcpiGbl_EntryStackPointer
= &CurrentSp
;
162 /*******************************************************************************
164 * FUNCTION: AcpiUtTrackStackPtr
170 * DESCRIPTION: Save the current CPU stack pointer
172 ******************************************************************************/
175 AcpiUtTrackStackPtr (
181 if (&CurrentSp
< AcpiGbl_LowestStackPointer
)
183 AcpiGbl_LowestStackPointer
= &CurrentSp
;
186 if (AcpiGbl_NestingLevel
> AcpiGbl_DeepestNesting
)
188 AcpiGbl_DeepestNesting
= AcpiGbl_NestingLevel
;
193 /*******************************************************************************
195 * FUNCTION: AcpiUtTrimFunctionName
197 * PARAMETERS: FunctionName - Ascii string containing a procedure name
199 * RETURN: Updated pointer to the function name
201 * DESCRIPTION: Remove the "Acpi" prefix from the function name, if present.
202 * This allows compiler macros such as __FUNCTION__ to be used
203 * with no change to the debug output.
205 ******************************************************************************/
208 AcpiUtTrimFunctionName (
209 const char *FunctionName
)
212 /* All Function names are longer than 4 chars, check is safe */
214 if (*(ACPI_CAST_PTR (UINT32
, FunctionName
)) == ACPI_PREFIX_MIXED
)
216 /* This is the case where the original source has not been modified */
218 return (FunctionName
+ 4);
221 if (*(ACPI_CAST_PTR (UINT32
, FunctionName
)) == ACPI_PREFIX_LOWER
)
223 /* This is the case where the source has been 'linuxized' */
225 return (FunctionName
+ 5);
228 return (FunctionName
);
232 /*******************************************************************************
234 * FUNCTION: AcpiDebugPrint
236 * PARAMETERS: RequestedDebugLevel - Requested debug print level
237 * LineNumber - Caller's line number (for error output)
238 * FunctionName - Caller's procedure name
239 * ModuleName - Caller's module name
240 * ComponentId - Caller's component ID
241 * Format - Printf format field
242 * ... - Optional printf arguments
246 * DESCRIPTION: Print error message with prefix consisting of the module name,
247 * line number, and component ID.
249 ******************************************************************************/
251 void ACPI_INTERNAL_VAR_XFACE
253 UINT32 RequestedDebugLevel
,
255 const char *FunctionName
,
256 const char *ModuleName
,
261 ACPI_THREAD_ID ThreadId
;
265 /* Check if debug output enabled */
267 if (!ACPI_IS_DEBUG_ENABLED (RequestedDebugLevel
, ComponentId
))
273 * Thread tracking and context switch notification
275 ThreadId
= AcpiOsGetThreadId ();
276 if (ThreadId
!= AcpiGbl_PrevThreadId
)
278 if (ACPI_LV_THREADS
& AcpiDbgLevel
)
281 "\n**** Context Switch from TID %u to TID %u ****\n\n",
282 (UINT32
) AcpiGbl_PrevThreadId
, (UINT32
) ThreadId
);
285 AcpiGbl_PrevThreadId
= ThreadId
;
286 AcpiGbl_NestingLevel
= 0;
290 * Display the module name, current line number, thread ID (if requested),
291 * current procedure nesting level, and the current procedure name
293 AcpiOsPrintf ("%9s-%04ld ", ModuleName
, LineNumber
);
295 #ifdef ACPI_APPLICATION
297 * For AcpiExec/iASL only, emit the thread ID and nesting level.
298 * Note: nesting level is really only useful during a single-thread
299 * execution. Otherwise, multiple threads will keep resetting the
302 if (ACPI_LV_THREADS
& AcpiDbgLevel
)
304 AcpiOsPrintf ("[%u] ", (UINT32
) ThreadId
);
307 AcpiOsPrintf ("[%02ld] ", AcpiGbl_NestingLevel
);
310 AcpiOsPrintf ("%-22.22s: ", AcpiUtTrimFunctionName (FunctionName
));
312 va_start (args
, Format
);
313 AcpiOsVprintf (Format
, args
);
317 ACPI_EXPORT_SYMBOL (AcpiDebugPrint
)
320 /*******************************************************************************
322 * FUNCTION: AcpiDebugPrintRaw
324 * PARAMETERS: RequestedDebugLevel - Requested debug print level
325 * LineNumber - Caller's line number
326 * FunctionName - Caller's procedure name
327 * ModuleName - Caller's module name
328 * ComponentId - Caller's component ID
329 * Format - Printf format field
330 * ... - Optional printf arguments
334 * DESCRIPTION: Print message with no headers. Has same interface as
335 * DebugPrint so that the same macros can be used.
337 ******************************************************************************/
339 void ACPI_INTERNAL_VAR_XFACE
341 UINT32 RequestedDebugLevel
,
343 const char *FunctionName
,
344 const char *ModuleName
,
352 /* Check if debug output enabled */
354 if (!ACPI_IS_DEBUG_ENABLED (RequestedDebugLevel
, ComponentId
))
359 va_start (args
, Format
);
360 AcpiOsVprintf (Format
, args
);
364 ACPI_EXPORT_SYMBOL (AcpiDebugPrintRaw
)
367 /*******************************************************************************
369 * FUNCTION: AcpiUtTrace
371 * PARAMETERS: LineNumber - Caller's line number
372 * FunctionName - Caller's procedure name
373 * ModuleName - Caller's module name
374 * ComponentId - Caller's component ID
378 * DESCRIPTION: Function entry trace. Prints only if TRACE_FUNCTIONS bit is
381 ******************************************************************************/
386 const char *FunctionName
,
387 const char *ModuleName
,
391 AcpiGbl_NestingLevel
++;
392 AcpiUtTrackStackPtr ();
394 /* Check if enabled up-front for performance */
396 if (ACPI_IS_DEBUG_ENABLED (ACPI_LV_FUNCTIONS
, ComponentId
))
398 AcpiDebugPrint (ACPI_LV_FUNCTIONS
,
399 LineNumber
, FunctionName
, ModuleName
, ComponentId
,
400 "%s\n", AcpiGbl_FnEntryStr
);
404 ACPI_EXPORT_SYMBOL (AcpiUtTrace
)
407 /*******************************************************************************
409 * FUNCTION: AcpiUtTracePtr
411 * PARAMETERS: LineNumber - Caller's line number
412 * FunctionName - Caller's procedure name
413 * ModuleName - Caller's module name
414 * ComponentId - Caller's component ID
415 * Pointer - Pointer to display
419 * DESCRIPTION: Function entry trace. Prints only if TRACE_FUNCTIONS bit is
422 ******************************************************************************/
427 const char *FunctionName
,
428 const char *ModuleName
,
433 AcpiGbl_NestingLevel
++;
434 AcpiUtTrackStackPtr ();
436 /* Check if enabled up-front for performance */
438 if (ACPI_IS_DEBUG_ENABLED (ACPI_LV_FUNCTIONS
, ComponentId
))
440 AcpiDebugPrint (ACPI_LV_FUNCTIONS
,
441 LineNumber
, FunctionName
, ModuleName
, ComponentId
,
442 "%s %p\n", AcpiGbl_FnEntryStr
, Pointer
);
447 /*******************************************************************************
449 * FUNCTION: AcpiUtTraceStr
451 * PARAMETERS: LineNumber - Caller's line number
452 * FunctionName - Caller's procedure name
453 * ModuleName - Caller's module name
454 * ComponentId - Caller's component ID
455 * String - Additional string to display
459 * DESCRIPTION: Function entry trace. Prints only if TRACE_FUNCTIONS bit is
462 ******************************************************************************/
467 const char *FunctionName
,
468 const char *ModuleName
,
473 AcpiGbl_NestingLevel
++;
474 AcpiUtTrackStackPtr ();
476 /* Check if enabled up-front for performance */
478 if (ACPI_IS_DEBUG_ENABLED (ACPI_LV_FUNCTIONS
, ComponentId
))
480 AcpiDebugPrint (ACPI_LV_FUNCTIONS
,
481 LineNumber
, FunctionName
, ModuleName
, ComponentId
,
482 "%s %s\n", AcpiGbl_FnEntryStr
, String
);
487 /*******************************************************************************
489 * FUNCTION: AcpiUtTraceU32
491 * PARAMETERS: LineNumber - Caller's line number
492 * FunctionName - Caller's procedure name
493 * ModuleName - Caller's module name
494 * ComponentId - Caller's component ID
495 * Integer - Integer to display
499 * DESCRIPTION: Function entry trace. Prints only if TRACE_FUNCTIONS bit is
502 ******************************************************************************/
507 const char *FunctionName
,
508 const char *ModuleName
,
513 AcpiGbl_NestingLevel
++;
514 AcpiUtTrackStackPtr ();
516 /* Check if enabled up-front for performance */
518 if (ACPI_IS_DEBUG_ENABLED (ACPI_LV_FUNCTIONS
, ComponentId
))
520 AcpiDebugPrint (ACPI_LV_FUNCTIONS
,
521 LineNumber
, FunctionName
, ModuleName
, ComponentId
,
522 "%s %08X\n", AcpiGbl_FnEntryStr
, Integer
);
527 /*******************************************************************************
529 * FUNCTION: AcpiUtExit
531 * PARAMETERS: LineNumber - Caller's line number
532 * FunctionName - Caller's procedure name
533 * ModuleName - Caller's module name
534 * ComponentId - Caller's component ID
538 * DESCRIPTION: Function exit trace. Prints only if TRACE_FUNCTIONS bit is
541 ******************************************************************************/
546 const char *FunctionName
,
547 const char *ModuleName
,
551 /* Check if enabled up-front for performance */
553 if (ACPI_IS_DEBUG_ENABLED (ACPI_LV_FUNCTIONS
, ComponentId
))
555 AcpiDebugPrint (ACPI_LV_FUNCTIONS
,
556 LineNumber
, FunctionName
, ModuleName
, ComponentId
,
557 "%s\n", AcpiGbl_FnExitStr
);
560 if (AcpiGbl_NestingLevel
)
562 AcpiGbl_NestingLevel
--;
566 ACPI_EXPORT_SYMBOL (AcpiUtExit
)
569 /*******************************************************************************
571 * FUNCTION: AcpiUtStatusExit
573 * PARAMETERS: LineNumber - Caller's line number
574 * FunctionName - Caller's procedure name
575 * ModuleName - Caller's module name
576 * ComponentId - Caller's component ID
577 * Status - Exit status code
581 * DESCRIPTION: Function exit trace. Prints only if TRACE_FUNCTIONS bit is
582 * set in DebugLevel. Prints exit status also.
584 ******************************************************************************/
589 const char *FunctionName
,
590 const char *ModuleName
,
595 /* Check if enabled up-front for performance */
597 if (ACPI_IS_DEBUG_ENABLED (ACPI_LV_FUNCTIONS
, ComponentId
))
599 if (ACPI_SUCCESS (Status
))
601 AcpiDebugPrint (ACPI_LV_FUNCTIONS
,
602 LineNumber
, FunctionName
, ModuleName
, ComponentId
,
603 "%s %s\n", AcpiGbl_FnExitStr
,
604 AcpiFormatException (Status
));
608 AcpiDebugPrint (ACPI_LV_FUNCTIONS
,
609 LineNumber
, FunctionName
, ModuleName
, ComponentId
,
610 "%s ****Exception****: %s\n", AcpiGbl_FnExitStr
,
611 AcpiFormatException (Status
));
615 if (AcpiGbl_NestingLevel
)
617 AcpiGbl_NestingLevel
--;
621 ACPI_EXPORT_SYMBOL (AcpiUtStatusExit
)
624 /*******************************************************************************
626 * FUNCTION: AcpiUtValueExit
628 * PARAMETERS: LineNumber - Caller's line number
629 * FunctionName - Caller's procedure name
630 * ModuleName - Caller's module name
631 * ComponentId - Caller's component ID
632 * Value - Value to be printed with exit msg
636 * DESCRIPTION: Function exit trace. Prints only if TRACE_FUNCTIONS bit is
637 * set in DebugLevel. Prints exit value also.
639 ******************************************************************************/
644 const char *FunctionName
,
645 const char *ModuleName
,
650 /* Check if enabled up-front for performance */
652 if (ACPI_IS_DEBUG_ENABLED (ACPI_LV_FUNCTIONS
, ComponentId
))
654 AcpiDebugPrint (ACPI_LV_FUNCTIONS
,
655 LineNumber
, FunctionName
, ModuleName
, ComponentId
,
656 "%s %8.8X%8.8X\n", AcpiGbl_FnExitStr
,
657 ACPI_FORMAT_UINT64 (Value
));
660 if (AcpiGbl_NestingLevel
)
662 AcpiGbl_NestingLevel
--;
666 ACPI_EXPORT_SYMBOL (AcpiUtValueExit
)
669 /*******************************************************************************
671 * FUNCTION: AcpiUtPtrExit
673 * PARAMETERS: LineNumber - Caller's line number
674 * FunctionName - Caller's procedure name
675 * ModuleName - Caller's module name
676 * ComponentId - Caller's component ID
677 * Ptr - Pointer to display
681 * DESCRIPTION: Function exit trace. Prints only if TRACE_FUNCTIONS bit is
682 * set in DebugLevel. Prints exit value also.
684 ******************************************************************************/
689 const char *FunctionName
,
690 const char *ModuleName
,
695 /* Check if enabled up-front for performance */
697 if (ACPI_IS_DEBUG_ENABLED (ACPI_LV_FUNCTIONS
, ComponentId
))
699 AcpiDebugPrint (ACPI_LV_FUNCTIONS
,
700 LineNumber
, FunctionName
, ModuleName
, ComponentId
,
701 "%s %p\n", AcpiGbl_FnExitStr
, Ptr
);
704 if (AcpiGbl_NestingLevel
)
706 AcpiGbl_NestingLevel
--;