| /****************************************************************************** |
| * |
| * Module Name: utdebug - Debug print/trace routines |
| * |
| *****************************************************************************/ |
| |
| /* |
| * Copyright (C) 2000 - 2016, Intel Corp. |
| * All rights reserved. |
| * |
| * Redistribution and use in source and binary forms, with or without |
| * modification, are permitted provided that the following conditions |
| * are met: |
| * 1. Redistributions of source code must retain the above copyright |
| * notice, this list of conditions, and the following disclaimer, |
| * without modification. |
| * 2. Redistributions in binary form must reproduce at minimum a disclaimer |
| * substantially similar to the "NO WARRANTY" disclaimer below |
| * ("Disclaimer") and any redistribution must be conditioned upon |
| * including a substantially similar Disclaimer requirement for further |
| * binary redistribution. |
| * 3. Neither the names of the above-listed copyright holders nor the names |
| * of any contributors may be used to endorse or promote products derived |
| * from this software without specific prior written permission. |
| * |
| * Alternatively, this software may be distributed under the terms of the |
| * GNU General Public License ("GPL") version 2 as published by the Free |
| * Software Foundation. |
| * |
| * NO WARRANTY |
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR |
| * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
| * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
| * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS |
| * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) |
| * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, |
| * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING |
| * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
| * POSSIBILITY OF SUCH DAMAGES. |
| */ |
| |
| #define EXPORT_ACPI_INTERFACES |
| |
| #include "acpi.h" |
| #include "accommon.h" |
| #include "acinterp.h" |
| |
| #define _COMPONENT ACPI_UTILITIES |
| ACPI_MODULE_NAME ("utdebug") |
| |
| |
| #ifdef ACPI_DEBUG_OUTPUT |
| |
| static ACPI_THREAD_ID AcpiGbl_PrevThreadId = (ACPI_THREAD_ID) 0xFFFFFFFF; |
| static char *AcpiGbl_FnEntryStr = "----Entry"; |
| static char *AcpiGbl_FnExitStr = "----Exit-"; |
| |
| /* Local prototypes */ |
| |
| static const char * |
| AcpiUtTrimFunctionName ( |
| const char *FunctionName); |
| |
| |
| /******************************************************************************* |
| * |
| * FUNCTION: AcpiUtInitStackPtrTrace |
| * |
| * PARAMETERS: None |
| * |
| * RETURN: None |
| * |
| * DESCRIPTION: Save the current CPU stack pointer at subsystem startup |
| * |
| ******************************************************************************/ |
| |
| void |
| AcpiUtInitStackPtrTrace ( |
| void) |
| { |
| ACPI_SIZE CurrentSp; |
| |
| |
| AcpiGbl_EntryStackPointer = &CurrentSp; |
| } |
| |
| |
| /******************************************************************************* |
| * |
| * FUNCTION: AcpiUtTrackStackPtr |
| * |
| * PARAMETERS: None |
| * |
| * RETURN: None |
| * |
| * DESCRIPTION: Save the current CPU stack pointer |
| * |
| ******************************************************************************/ |
| |
| void |
| AcpiUtTrackStackPtr ( |
| void) |
| { |
| ACPI_SIZE CurrentSp; |
| |
| |
| if (&CurrentSp < AcpiGbl_LowestStackPointer) |
| { |
| AcpiGbl_LowestStackPointer = &CurrentSp; |
| } |
| |
| if (AcpiGbl_NestingLevel > AcpiGbl_DeepestNesting) |
| { |
| AcpiGbl_DeepestNesting = AcpiGbl_NestingLevel; |
| } |
| } |
| |
| |
| /******************************************************************************* |
| * |
| * FUNCTION: AcpiUtTrimFunctionName |
| * |
| * PARAMETERS: FunctionName - Ascii string containing a procedure name |
| * |
| * RETURN: Updated pointer to the function name |
| * |
| * DESCRIPTION: Remove the "Acpi" prefix from the function name, if present. |
| * This allows compiler macros such as __FUNCTION__ to be used |
| * with no change to the debug output. |
| * |
| ******************************************************************************/ |
| |
| static const char * |
| AcpiUtTrimFunctionName ( |
| const char *FunctionName) |
| { |
| |
| /* All Function names are longer than 4 chars, check is safe */ |
| |
| if (*(ACPI_CAST_PTR (UINT32, FunctionName)) == ACPI_PREFIX_MIXED) |
| { |
| /* This is the case where the original source has not been modified */ |
| |
| return (FunctionName + 4); |
| } |
| |
| if (*(ACPI_CAST_PTR (UINT32, FunctionName)) == ACPI_PREFIX_LOWER) |
| { |
| /* This is the case where the source has been 'linuxized' */ |
| |
| return (FunctionName + 5); |
| } |
| |
| return (FunctionName); |
| } |
| |
| |
| /******************************************************************************* |
| * |
| * FUNCTION: AcpiDebugPrint |
| * |
| * PARAMETERS: RequestedDebugLevel - Requested debug print level |
| * LineNumber - Caller's line number (for error output) |
| * FunctionName - Caller's procedure name |
| * ModuleName - Caller's module name |
| * ComponentId - Caller's component ID |
| * Format - Printf format field |
| * ... - Optional printf arguments |
| * |
| * RETURN: None |
| * |
| * DESCRIPTION: Print error message with prefix consisting of the module name, |
| * line number, and component ID. |
| * |
| ******************************************************************************/ |
| |
| void ACPI_INTERNAL_VAR_XFACE |
| AcpiDebugPrint ( |
| UINT32 RequestedDebugLevel, |
| UINT32 LineNumber, |
| const char *FunctionName, |
| const char *ModuleName, |
| UINT32 ComponentId, |
| const char *Format, |
| ...) |
| { |
| ACPI_THREAD_ID ThreadId; |
| va_list args; |
| |
| |
| /* Check if debug output enabled */ |
| |
| if (!ACPI_IS_DEBUG_ENABLED (RequestedDebugLevel, ComponentId)) |
| { |
| return; |
| } |
| |
| /* |
| * Thread tracking and context switch notification |
| */ |
| ThreadId = AcpiOsGetThreadId (); |
| if (ThreadId != AcpiGbl_PrevThreadId) |
| { |
| if (ACPI_LV_THREADS & AcpiDbgLevel) |
| { |
| AcpiOsPrintf ( |
| "\n**** Context Switch from TID %u to TID %u ****\n\n", |
| (UINT32) AcpiGbl_PrevThreadId, (UINT32) ThreadId); |
| } |
| |
| AcpiGbl_PrevThreadId = ThreadId; |
| AcpiGbl_NestingLevel = 0; |
| } |
| |
| /* |
| * Display the module name, current line number, thread ID (if requested), |
| * current procedure nesting level, and the current procedure name |
| */ |
| AcpiOsPrintf ("%9s-%04ld ", ModuleName, LineNumber); |
| |
| #ifdef ACPI_APPLICATION |
| /* |
| * For AcpiExec/iASL only, emit the thread ID and nesting level. |
| * Note: nesting level is really only useful during a single-thread |
| * execution. Otherwise, multiple threads will keep resetting the |
| * level. |
| */ |
| if (ACPI_LV_THREADS & AcpiDbgLevel) |
| { |
| AcpiOsPrintf ("[%u] ", (UINT32) ThreadId); |
| } |
| |
| AcpiOsPrintf ("[%02ld] ", AcpiGbl_NestingLevel); |
| #endif |
| |
| AcpiOsPrintf ("%-22.22s: ", AcpiUtTrimFunctionName (FunctionName)); |
| |
| va_start (args, Format); |
| AcpiOsVprintf (Format, args); |
| va_end (args); |
| } |
| |
| ACPI_EXPORT_SYMBOL (AcpiDebugPrint) |
| |
| |
| /******************************************************************************* |
| * |
| * FUNCTION: AcpiDebugPrintRaw |
| * |
| * PARAMETERS: RequestedDebugLevel - Requested debug print level |
| * LineNumber - Caller's line number |
| * FunctionName - Caller's procedure name |
| * ModuleName - Caller's module name |
| * ComponentId - Caller's component ID |
| * Format - Printf format field |
| * ... - Optional printf arguments |
| * |
| * RETURN: None |
| * |
| * DESCRIPTION: Print message with no headers. Has same interface as |
| * DebugPrint so that the same macros can be used. |
| * |
| ******************************************************************************/ |
| |
| void ACPI_INTERNAL_VAR_XFACE |
| AcpiDebugPrintRaw ( |
| UINT32 RequestedDebugLevel, |
| UINT32 LineNumber, |
| const char *FunctionName, |
| const char *ModuleName, |
| UINT32 ComponentId, |
| const char *Format, |
| ...) |
| { |
| va_list args; |
| |
| |
| /* Check if debug output enabled */ |
| |
| if (!ACPI_IS_DEBUG_ENABLED (RequestedDebugLevel, ComponentId)) |
| { |
| return; |
| } |
| |
| va_start (args, Format); |
| AcpiOsVprintf (Format, args); |
| va_end (args); |
| } |
| |
| ACPI_EXPORT_SYMBOL (AcpiDebugPrintRaw) |
| |
| |
| /******************************************************************************* |
| * |
| * FUNCTION: AcpiUtTrace |
| * |
| * PARAMETERS: LineNumber - Caller's line number |
| * FunctionName - Caller's procedure name |
| * ModuleName - Caller's module name |
| * ComponentId - Caller's component ID |
| * |
| * RETURN: None |
| * |
| * DESCRIPTION: Function entry trace. Prints only if TRACE_FUNCTIONS bit is |
| * set in DebugLevel |
| * |
| ******************************************************************************/ |
| |
| void |
| AcpiUtTrace ( |
| UINT32 LineNumber, |
| const char *FunctionName, |
| const char *ModuleName, |
| UINT32 ComponentId) |
| { |
| |
| AcpiGbl_NestingLevel++; |
| AcpiUtTrackStackPtr (); |
| |
| /* Check if enabled up-front for performance */ |
| |
| if (ACPI_IS_DEBUG_ENABLED (ACPI_LV_FUNCTIONS, ComponentId)) |
| { |
| AcpiDebugPrint (ACPI_LV_FUNCTIONS, |
| LineNumber, FunctionName, ModuleName, ComponentId, |
| "%s\n", AcpiGbl_FnEntryStr); |
| } |
| } |
| |
| ACPI_EXPORT_SYMBOL (AcpiUtTrace) |
| |
| |
| /******************************************************************************* |
| * |
| * FUNCTION: AcpiUtTracePtr |
| * |
| * PARAMETERS: LineNumber - Caller's line number |
| * FunctionName - Caller's procedure name |
| * ModuleName - Caller's module name |
| * ComponentId - Caller's component ID |
| * Pointer - Pointer to display |
| * |
| * RETURN: None |
| * |
| * DESCRIPTION: Function entry trace. Prints only if TRACE_FUNCTIONS bit is |
| * set in DebugLevel |
| * |
| ******************************************************************************/ |
| |
| void |
| AcpiUtTracePtr ( |
| UINT32 LineNumber, |
| const char *FunctionName, |
| const char *ModuleName, |
| UINT32 ComponentId, |
| void *Pointer) |
| { |
| |
| AcpiGbl_NestingLevel++; |
| AcpiUtTrackStackPtr (); |
| |
| /* Check if enabled up-front for performance */ |
| |
| if (ACPI_IS_DEBUG_ENABLED (ACPI_LV_FUNCTIONS, ComponentId)) |
| { |
| AcpiDebugPrint (ACPI_LV_FUNCTIONS, |
| LineNumber, FunctionName, ModuleName, ComponentId, |
| "%s %p\n", AcpiGbl_FnEntryStr, Pointer); |
| } |
| } |
| |
| |
| /******************************************************************************* |
| * |
| * FUNCTION: AcpiUtTraceStr |
| * |
| * PARAMETERS: LineNumber - Caller's line number |
| * FunctionName - Caller's procedure name |
| * ModuleName - Caller's module name |
| * ComponentId - Caller's component ID |
| * String - Additional string to display |
| * |
| * RETURN: None |
| * |
| * DESCRIPTION: Function entry trace. Prints only if TRACE_FUNCTIONS bit is |
| * set in DebugLevel |
| * |
| ******************************************************************************/ |
| |
| void |
| AcpiUtTraceStr ( |
| UINT32 LineNumber, |
| const char *FunctionName, |
| const char *ModuleName, |
| UINT32 ComponentId, |
| char *String) |
| { |
| |
| AcpiGbl_NestingLevel++; |
| AcpiUtTrackStackPtr (); |
| |
| /* Check if enabled up-front for performance */ |
| |
| if (ACPI_IS_DEBUG_ENABLED (ACPI_LV_FUNCTIONS, ComponentId)) |
| { |
| AcpiDebugPrint (ACPI_LV_FUNCTIONS, |
| LineNumber, FunctionName, ModuleName, ComponentId, |
| "%s %s\n", AcpiGbl_FnEntryStr, String); |
| } |
| } |
| |
| |
| /******************************************************************************* |
| * |
| * FUNCTION: AcpiUtTraceU32 |
| * |
| * PARAMETERS: LineNumber - Caller's line number |
| * FunctionName - Caller's procedure name |
| * ModuleName - Caller's module name |
| * ComponentId - Caller's component ID |
| * Integer - Integer to display |
| * |
| * RETURN: None |
| * |
| * DESCRIPTION: Function entry trace. Prints only if TRACE_FUNCTIONS bit is |
| * set in DebugLevel |
| * |
| ******************************************************************************/ |
| |
| void |
| AcpiUtTraceU32 ( |
| UINT32 LineNumber, |
| const char *FunctionName, |
| const char *ModuleName, |
| UINT32 ComponentId, |
| UINT32 Integer) |
| { |
| |
| AcpiGbl_NestingLevel++; |
| AcpiUtTrackStackPtr (); |
| |
| /* Check if enabled up-front for performance */ |
| |
| if (ACPI_IS_DEBUG_ENABLED (ACPI_LV_FUNCTIONS, ComponentId)) |
| { |
| AcpiDebugPrint (ACPI_LV_FUNCTIONS, |
| LineNumber, FunctionName, ModuleName, ComponentId, |
| "%s %08X\n", AcpiGbl_FnEntryStr, Integer); |
| } |
| } |
| |
| |
| /******************************************************************************* |
| * |
| * FUNCTION: AcpiUtExit |
| * |
| * PARAMETERS: LineNumber - Caller's line number |
| * FunctionName - Caller's procedure name |
| * ModuleName - Caller's module name |
| * ComponentId - Caller's component ID |
| * |
| * RETURN: None |
| * |
| * DESCRIPTION: Function exit trace. Prints only if TRACE_FUNCTIONS bit is |
| * set in DebugLevel |
| * |
| ******************************************************************************/ |
| |
| void |
| AcpiUtExit ( |
| UINT32 LineNumber, |
| const char *FunctionName, |
| const char *ModuleName, |
| UINT32 ComponentId) |
| { |
| |
| /* Check if enabled up-front for performance */ |
| |
| if (ACPI_IS_DEBUG_ENABLED (ACPI_LV_FUNCTIONS, ComponentId)) |
| { |
| AcpiDebugPrint (ACPI_LV_FUNCTIONS, |
| LineNumber, FunctionName, ModuleName, ComponentId, |
| "%s\n", AcpiGbl_FnExitStr); |
| } |
| |
| if (AcpiGbl_NestingLevel) |
| { |
| AcpiGbl_NestingLevel--; |
| } |
| } |
| |
| ACPI_EXPORT_SYMBOL (AcpiUtExit) |
| |
| |
| /******************************************************************************* |
| * |
| * FUNCTION: AcpiUtStatusExit |
| * |
| * PARAMETERS: LineNumber - Caller's line number |
| * FunctionName - Caller's procedure name |
| * ModuleName - Caller's module name |
| * ComponentId - Caller's component ID |
| * Status - Exit status code |
| * |
| * RETURN: None |
| * |
| * DESCRIPTION: Function exit trace. Prints only if TRACE_FUNCTIONS bit is |
| * set in DebugLevel. Prints exit status also. |
| * |
| ******************************************************************************/ |
| |
| void |
| AcpiUtStatusExit ( |
| UINT32 LineNumber, |
| const char *FunctionName, |
| const char *ModuleName, |
| UINT32 ComponentId, |
| ACPI_STATUS Status) |
| { |
| |
| /* Check if enabled up-front for performance */ |
| |
| if (ACPI_IS_DEBUG_ENABLED (ACPI_LV_FUNCTIONS, ComponentId)) |
| { |
| if (ACPI_SUCCESS (Status)) |
| { |
| AcpiDebugPrint (ACPI_LV_FUNCTIONS, |
| LineNumber, FunctionName, ModuleName, ComponentId, |
| "%s %s\n", AcpiGbl_FnExitStr, |
| AcpiFormatException (Status)); |
| } |
| else |
| { |
| AcpiDebugPrint (ACPI_LV_FUNCTIONS, |
| LineNumber, FunctionName, ModuleName, ComponentId, |
| "%s ****Exception****: %s\n", AcpiGbl_FnExitStr, |
| AcpiFormatException (Status)); |
| } |
| } |
| |
| if (AcpiGbl_NestingLevel) |
| { |
| AcpiGbl_NestingLevel--; |
| } |
| } |
| |
| ACPI_EXPORT_SYMBOL (AcpiUtStatusExit) |
| |
| |
| /******************************************************************************* |
| * |
| * FUNCTION: AcpiUtValueExit |
| * |
| * PARAMETERS: LineNumber - Caller's line number |
| * FunctionName - Caller's procedure name |
| * ModuleName - Caller's module name |
| * ComponentId - Caller's component ID |
| * Value - Value to be printed with exit msg |
| * |
| * RETURN: None |
| * |
| * DESCRIPTION: Function exit trace. Prints only if TRACE_FUNCTIONS bit is |
| * set in DebugLevel. Prints exit value also. |
| * |
| ******************************************************************************/ |
| |
| void |
| AcpiUtValueExit ( |
| UINT32 LineNumber, |
| const char *FunctionName, |
| const char *ModuleName, |
| UINT32 ComponentId, |
| UINT64 Value) |
| { |
| |
| /* Check if enabled up-front for performance */ |
| |
| if (ACPI_IS_DEBUG_ENABLED (ACPI_LV_FUNCTIONS, ComponentId)) |
| { |
| AcpiDebugPrint (ACPI_LV_FUNCTIONS, |
| LineNumber, FunctionName, ModuleName, ComponentId, |
| "%s %8.8X%8.8X\n", AcpiGbl_FnExitStr, |
| ACPI_FORMAT_UINT64 (Value)); |
| } |
| |
| if (AcpiGbl_NestingLevel) |
| { |
| AcpiGbl_NestingLevel--; |
| } |
| } |
| |
| ACPI_EXPORT_SYMBOL (AcpiUtValueExit) |
| |
| |
| /******************************************************************************* |
| * |
| * FUNCTION: AcpiUtPtrExit |
| * |
| * PARAMETERS: LineNumber - Caller's line number |
| * FunctionName - Caller's procedure name |
| * ModuleName - Caller's module name |
| * ComponentId - Caller's component ID |
| * Ptr - Pointer to display |
| * |
| * RETURN: None |
| * |
| * DESCRIPTION: Function exit trace. Prints only if TRACE_FUNCTIONS bit is |
| * set in DebugLevel. Prints exit value also. |
| * |
| ******************************************************************************/ |
| |
| void |
| AcpiUtPtrExit ( |
| UINT32 LineNumber, |
| const char *FunctionName, |
| const char *ModuleName, |
| UINT32 ComponentId, |
| UINT8 *Ptr) |
| { |
| |
| /* Check if enabled up-front for performance */ |
| |
| if (ACPI_IS_DEBUG_ENABLED (ACPI_LV_FUNCTIONS, ComponentId)) |
| { |
| AcpiDebugPrint (ACPI_LV_FUNCTIONS, |
| LineNumber, FunctionName, ModuleName, ComponentId, |
| "%s %p\n", AcpiGbl_FnExitStr, Ptr); |
| } |
| |
| if (AcpiGbl_NestingLevel) |
| { |
| AcpiGbl_NestingLevel--; |
| } |
| } |
| |
| |
| /******************************************************************************* |
| * |
| * FUNCTION: AcpiTracePoint |
| * |
| * PARAMETERS: Type - Trace event type |
| * Begin - TRUE if before execution |
| * Aml - Executed AML address |
| * Pathname - Object path |
| * Pointer - Pointer to the related object |
| * |
| * RETURN: None |
| * |
| * DESCRIPTION: Interpreter execution trace. |
| * |
| ******************************************************************************/ |
| |
| void |
| AcpiTracePoint ( |
| ACPI_TRACE_EVENT_TYPE Type, |
| BOOLEAN Begin, |
| UINT8 *Aml, |
| char *Pathname) |
| { |
| |
| ACPI_FUNCTION_ENTRY (); |
| |
| AcpiExTracePoint (Type, Begin, Aml, Pathname); |
| |
| #ifdef ACPI_USE_SYSTEM_TRACER |
| AcpiOsTracePoint (Type, Begin, Aml, Pathname); |
| #endif |
| } |
| |
| ACPI_EXPORT_SYMBOL (AcpiTracePoint) |
| |
| #endif |
| |
| |
| #ifdef ACPI_APPLICATION |
| /******************************************************************************* |
| * |
| * FUNCTION: AcpiLogError |
| * |
| * PARAMETERS: Format - Printf format field |
| * ... - Optional printf arguments |
| * |
| * RETURN: None |
| * |
| * DESCRIPTION: Print error message to the console, used by applications. |
| * |
| ******************************************************************************/ |
| |
| void ACPI_INTERNAL_VAR_XFACE |
| AcpiLogError ( |
| const char *Format, |
| ...) |
| { |
| va_list Args; |
| |
| va_start (Args, Format); |
| (void) AcpiUtFileVprintf (ACPI_FILE_ERR, Format, Args); |
| va_end (Args); |
| } |
| |
| ACPI_EXPORT_SYMBOL (AcpiLogError) |
| #endif |
