![Lv Zheng](/assets/img/avatar_default.png)
Invocations like fprintf(stderr) and perror() are not portable, this patch introduces acpi_log_error() as a replacement, it is implemented using new portable API - acpi_ut_file_vprintf(). Note that though acpi_os_initialize() need to be invoked prior than using this new API, since no users are introduced in this patch, such invocations are not added for applications that link utprint.c in this patch. Futher patches that introduce users of acpi_log_error() should take care of this. This patch is only useful for ACPICA applications, most of which are not shipped in the Linux kernel. Note that follow-up commits will update acpidump to use this new API to improve portability. Lv Zheng. Signed-off-by: Lv Zheng <lv.zheng@intel.com> Signed-off-by: Bob Moore <robert.moore@intel.com> Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
590 lines
18 KiB
C
590 lines
18 KiB
C
/******************************************************************************
|
|
*
|
|
* Module Name: utdebug - Debug print/trace routines
|
|
*
|
|
*****************************************************************************/
|
|
|
|
/*
|
|
* Copyright (C) 2000 - 2014, 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/acpi.h>
|
|
#include "accommon.h"
|
|
|
|
#define _COMPONENT ACPI_UTILITIES
|
|
ACPI_MODULE_NAME("utdebug")
|
|
|
|
#ifdef ACPI_DEBUG_OUTPUT
|
|
static acpi_thread_id acpi_gbl_prev_thread_id = (acpi_thread_id) 0xFFFFFFFF;
|
|
static char *acpi_gbl_fn_entry_str = "----Entry";
|
|
static char *acpi_gbl_fn_exit_str = "----Exit-";
|
|
|
|
/* Local prototypes */
|
|
|
|
static const char *acpi_ut_trim_function_name(const char *function_name);
|
|
|
|
/*******************************************************************************
|
|
*
|
|
* FUNCTION: acpi_ut_init_stack_ptr_trace
|
|
*
|
|
* PARAMETERS: None
|
|
*
|
|
* RETURN: None
|
|
*
|
|
* DESCRIPTION: Save the current CPU stack pointer at subsystem startup
|
|
*
|
|
******************************************************************************/
|
|
|
|
void acpi_ut_init_stack_ptr_trace(void)
|
|
{
|
|
acpi_size current_sp;
|
|
|
|
acpi_gbl_entry_stack_pointer = ¤t_sp;
|
|
}
|
|
|
|
/*******************************************************************************
|
|
*
|
|
* FUNCTION: acpi_ut_track_stack_ptr
|
|
*
|
|
* PARAMETERS: None
|
|
*
|
|
* RETURN: None
|
|
*
|
|
* DESCRIPTION: Save the current CPU stack pointer
|
|
*
|
|
******************************************************************************/
|
|
|
|
void acpi_ut_track_stack_ptr(void)
|
|
{
|
|
acpi_size current_sp;
|
|
|
|
if (¤t_sp < acpi_gbl_lowest_stack_pointer) {
|
|
acpi_gbl_lowest_stack_pointer = ¤t_sp;
|
|
}
|
|
|
|
if (acpi_gbl_nesting_level > acpi_gbl_deepest_nesting) {
|
|
acpi_gbl_deepest_nesting = acpi_gbl_nesting_level;
|
|
}
|
|
}
|
|
|
|
/*******************************************************************************
|
|
*
|
|
* FUNCTION: acpi_ut_trim_function_name
|
|
*
|
|
* PARAMETERS: function_name - 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 *acpi_ut_trim_function_name(const char *function_name)
|
|
{
|
|
|
|
/* All Function names are longer than 4 chars, check is safe */
|
|
|
|
if (*(ACPI_CAST_PTR(u32, function_name)) == ACPI_PREFIX_MIXED) {
|
|
|
|
/* This is the case where the original source has not been modified */
|
|
|
|
return (function_name + 4);
|
|
}
|
|
|
|
if (*(ACPI_CAST_PTR(u32, function_name)) == ACPI_PREFIX_LOWER) {
|
|
|
|
/* This is the case where the source has been 'linuxized' */
|
|
|
|
return (function_name + 5);
|
|
}
|
|
|
|
return (function_name);
|
|
}
|
|
|
|
/*******************************************************************************
|
|
*
|
|
* FUNCTION: acpi_debug_print
|
|
*
|
|
* PARAMETERS: requested_debug_level - Requested debug print level
|
|
* line_number - Caller's line number (for error output)
|
|
* function_name - Caller's procedure name
|
|
* module_name - Caller's module name
|
|
* component_id - 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
|
|
acpi_debug_print(u32 requested_debug_level,
|
|
u32 line_number,
|
|
const char *function_name,
|
|
const char *module_name,
|
|
u32 component_id, const char *format, ...)
|
|
{
|
|
acpi_thread_id thread_id;
|
|
va_list args;
|
|
|
|
/* Check if debug output enabled */
|
|
|
|
if (!ACPI_IS_DEBUG_ENABLED(requested_debug_level, component_id)) {
|
|
return;
|
|
}
|
|
|
|
/*
|
|
* Thread tracking and context switch notification
|
|
*/
|
|
thread_id = acpi_os_get_thread_id();
|
|
if (thread_id != acpi_gbl_prev_thread_id) {
|
|
if (ACPI_LV_THREADS & acpi_dbg_level) {
|
|
acpi_os_printf
|
|
("\n**** Context Switch from TID %u to TID %u ****\n\n",
|
|
(u32)acpi_gbl_prev_thread_id, (u32)thread_id);
|
|
}
|
|
|
|
acpi_gbl_prev_thread_id = thread_id;
|
|
acpi_gbl_nesting_level = 0;
|
|
}
|
|
|
|
/*
|
|
* Display the module name, current line number, thread ID (if requested),
|
|
* current procedure nesting level, and the current procedure name
|
|
*/
|
|
acpi_os_printf("%9s-%04ld ", module_name, line_number);
|
|
|
|
#ifdef ACPI_APPLICATION
|
|
/*
|
|
* For acpi_exec/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 & acpi_dbg_level) {
|
|
acpi_os_printf("[%u] ", (u32)thread_id);
|
|
}
|
|
|
|
acpi_os_printf("[%02ld] ", acpi_gbl_nesting_level);
|
|
#endif
|
|
|
|
acpi_os_printf("%-22.22s: ", acpi_ut_trim_function_name(function_name));
|
|
|
|
va_start(args, format);
|
|
acpi_os_vprintf(format, args);
|
|
va_end(args);
|
|
}
|
|
|
|
ACPI_EXPORT_SYMBOL(acpi_debug_print)
|
|
|
|
/*******************************************************************************
|
|
*
|
|
* FUNCTION: acpi_debug_print_raw
|
|
*
|
|
* PARAMETERS: requested_debug_level - Requested debug print level
|
|
* line_number - Caller's line number
|
|
* function_name - Caller's procedure name
|
|
* module_name - Caller's module name
|
|
* component_id - Caller's component ID
|
|
* format - Printf format field
|
|
* ... - Optional printf arguments
|
|
*
|
|
* RETURN: None
|
|
*
|
|
* DESCRIPTION: Print message with no headers. Has same interface as
|
|
* debug_print so that the same macros can be used.
|
|
*
|
|
******************************************************************************/
|
|
void ACPI_INTERNAL_VAR_XFACE
|
|
acpi_debug_print_raw(u32 requested_debug_level,
|
|
u32 line_number,
|
|
const char *function_name,
|
|
const char *module_name,
|
|
u32 component_id, const char *format, ...)
|
|
{
|
|
va_list args;
|
|
|
|
/* Check if debug output enabled */
|
|
|
|
if (!ACPI_IS_DEBUG_ENABLED(requested_debug_level, component_id)) {
|
|
return;
|
|
}
|
|
|
|
va_start(args, format);
|
|
acpi_os_vprintf(format, args);
|
|
va_end(args);
|
|
}
|
|
|
|
ACPI_EXPORT_SYMBOL(acpi_debug_print_raw)
|
|
|
|
/*******************************************************************************
|
|
*
|
|
* FUNCTION: acpi_ut_trace
|
|
*
|
|
* PARAMETERS: line_number - Caller's line number
|
|
* function_name - Caller's procedure name
|
|
* module_name - Caller's module name
|
|
* component_id - Caller's component ID
|
|
*
|
|
* RETURN: None
|
|
*
|
|
* DESCRIPTION: Function entry trace. Prints only if TRACE_FUNCTIONS bit is
|
|
* set in debug_level
|
|
*
|
|
******************************************************************************/
|
|
void
|
|
acpi_ut_trace(u32 line_number,
|
|
const char *function_name,
|
|
const char *module_name, u32 component_id)
|
|
{
|
|
|
|
acpi_gbl_nesting_level++;
|
|
acpi_ut_track_stack_ptr();
|
|
|
|
/* Check if enabled up-front for performance */
|
|
|
|
if (ACPI_IS_DEBUG_ENABLED(ACPI_LV_FUNCTIONS, component_id)) {
|
|
acpi_debug_print(ACPI_LV_FUNCTIONS,
|
|
line_number, function_name, module_name,
|
|
component_id, "%s\n", acpi_gbl_fn_entry_str);
|
|
}
|
|
}
|
|
|
|
ACPI_EXPORT_SYMBOL(acpi_ut_trace)
|
|
|
|
/*******************************************************************************
|
|
*
|
|
* FUNCTION: acpi_ut_trace_ptr
|
|
*
|
|
* PARAMETERS: line_number - Caller's line number
|
|
* function_name - Caller's procedure name
|
|
* module_name - Caller's module name
|
|
* component_id - Caller's component ID
|
|
* pointer - Pointer to display
|
|
*
|
|
* RETURN: None
|
|
*
|
|
* DESCRIPTION: Function entry trace. Prints only if TRACE_FUNCTIONS bit is
|
|
* set in debug_level
|
|
*
|
|
******************************************************************************/
|
|
void
|
|
acpi_ut_trace_ptr(u32 line_number,
|
|
const char *function_name,
|
|
const char *module_name, u32 component_id, void *pointer)
|
|
{
|
|
|
|
acpi_gbl_nesting_level++;
|
|
acpi_ut_track_stack_ptr();
|
|
|
|
/* Check if enabled up-front for performance */
|
|
|
|
if (ACPI_IS_DEBUG_ENABLED(ACPI_LV_FUNCTIONS, component_id)) {
|
|
acpi_debug_print(ACPI_LV_FUNCTIONS,
|
|
line_number, function_name, module_name,
|
|
component_id, "%s %p\n", acpi_gbl_fn_entry_str,
|
|
pointer);
|
|
}
|
|
}
|
|
|
|
/*******************************************************************************
|
|
*
|
|
* FUNCTION: acpi_ut_trace_str
|
|
*
|
|
* PARAMETERS: line_number - Caller's line number
|
|
* function_name - Caller's procedure name
|
|
* module_name - Caller's module name
|
|
* component_id - Caller's component ID
|
|
* string - Additional string to display
|
|
*
|
|
* RETURN: None
|
|
*
|
|
* DESCRIPTION: Function entry trace. Prints only if TRACE_FUNCTIONS bit is
|
|
* set in debug_level
|
|
*
|
|
******************************************************************************/
|
|
|
|
void
|
|
acpi_ut_trace_str(u32 line_number,
|
|
const char *function_name,
|
|
const char *module_name, u32 component_id, char *string)
|
|
{
|
|
|
|
acpi_gbl_nesting_level++;
|
|
acpi_ut_track_stack_ptr();
|
|
|
|
/* Check if enabled up-front for performance */
|
|
|
|
if (ACPI_IS_DEBUG_ENABLED(ACPI_LV_FUNCTIONS, component_id)) {
|
|
acpi_debug_print(ACPI_LV_FUNCTIONS,
|
|
line_number, function_name, module_name,
|
|
component_id, "%s %s\n", acpi_gbl_fn_entry_str,
|
|
string);
|
|
}
|
|
}
|
|
|
|
/*******************************************************************************
|
|
*
|
|
* FUNCTION: acpi_ut_trace_u32
|
|
*
|
|
* PARAMETERS: line_number - Caller's line number
|
|
* function_name - Caller's procedure name
|
|
* module_name - Caller's module name
|
|
* component_id - Caller's component ID
|
|
* integer - Integer to display
|
|
*
|
|
* RETURN: None
|
|
*
|
|
* DESCRIPTION: Function entry trace. Prints only if TRACE_FUNCTIONS bit is
|
|
* set in debug_level
|
|
*
|
|
******************************************************************************/
|
|
|
|
void
|
|
acpi_ut_trace_u32(u32 line_number,
|
|
const char *function_name,
|
|
const char *module_name, u32 component_id, u32 integer)
|
|
{
|
|
|
|
acpi_gbl_nesting_level++;
|
|
acpi_ut_track_stack_ptr();
|
|
|
|
/* Check if enabled up-front for performance */
|
|
|
|
if (ACPI_IS_DEBUG_ENABLED(ACPI_LV_FUNCTIONS, component_id)) {
|
|
acpi_debug_print(ACPI_LV_FUNCTIONS,
|
|
line_number, function_name, module_name,
|
|
component_id, "%s %08X\n",
|
|
acpi_gbl_fn_entry_str, integer);
|
|
}
|
|
}
|
|
|
|
/*******************************************************************************
|
|
*
|
|
* FUNCTION: acpi_ut_exit
|
|
*
|
|
* PARAMETERS: line_number - Caller's line number
|
|
* function_name - Caller's procedure name
|
|
* module_name - Caller's module name
|
|
* component_id - Caller's component ID
|
|
*
|
|
* RETURN: None
|
|
*
|
|
* DESCRIPTION: Function exit trace. Prints only if TRACE_FUNCTIONS bit is
|
|
* set in debug_level
|
|
*
|
|
******************************************************************************/
|
|
|
|
void
|
|
acpi_ut_exit(u32 line_number,
|
|
const char *function_name,
|
|
const char *module_name, u32 component_id)
|
|
{
|
|
|
|
/* Check if enabled up-front for performance */
|
|
|
|
if (ACPI_IS_DEBUG_ENABLED(ACPI_LV_FUNCTIONS, component_id)) {
|
|
acpi_debug_print(ACPI_LV_FUNCTIONS,
|
|
line_number, function_name, module_name,
|
|
component_id, "%s\n", acpi_gbl_fn_exit_str);
|
|
}
|
|
|
|
if (acpi_gbl_nesting_level) {
|
|
acpi_gbl_nesting_level--;
|
|
}
|
|
}
|
|
|
|
ACPI_EXPORT_SYMBOL(acpi_ut_exit)
|
|
|
|
/*******************************************************************************
|
|
*
|
|
* FUNCTION: acpi_ut_status_exit
|
|
*
|
|
* PARAMETERS: line_number - Caller's line number
|
|
* function_name - Caller's procedure name
|
|
* module_name - Caller's module name
|
|
* component_id - Caller's component ID
|
|
* status - Exit status code
|
|
*
|
|
* RETURN: None
|
|
*
|
|
* DESCRIPTION: Function exit trace. Prints only if TRACE_FUNCTIONS bit is
|
|
* set in debug_level. Prints exit status also.
|
|
*
|
|
******************************************************************************/
|
|
void
|
|
acpi_ut_status_exit(u32 line_number,
|
|
const char *function_name,
|
|
const char *module_name,
|
|
u32 component_id, acpi_status status)
|
|
{
|
|
|
|
/* Check if enabled up-front for performance */
|
|
|
|
if (ACPI_IS_DEBUG_ENABLED(ACPI_LV_FUNCTIONS, component_id)) {
|
|
if (ACPI_SUCCESS(status)) {
|
|
acpi_debug_print(ACPI_LV_FUNCTIONS,
|
|
line_number, function_name,
|
|
module_name, component_id, "%s %s\n",
|
|
acpi_gbl_fn_exit_str,
|
|
acpi_format_exception(status));
|
|
} else {
|
|
acpi_debug_print(ACPI_LV_FUNCTIONS,
|
|
line_number, function_name,
|
|
module_name, component_id,
|
|
"%s ****Exception****: %s\n",
|
|
acpi_gbl_fn_exit_str,
|
|
acpi_format_exception(status));
|
|
}
|
|
}
|
|
|
|
if (acpi_gbl_nesting_level) {
|
|
acpi_gbl_nesting_level--;
|
|
}
|
|
}
|
|
|
|
ACPI_EXPORT_SYMBOL(acpi_ut_status_exit)
|
|
|
|
/*******************************************************************************
|
|
*
|
|
* FUNCTION: acpi_ut_value_exit
|
|
*
|
|
* PARAMETERS: line_number - Caller's line number
|
|
* function_name - Caller's procedure name
|
|
* module_name - Caller's module name
|
|
* component_id - 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 debug_level. Prints exit value also.
|
|
*
|
|
******************************************************************************/
|
|
void
|
|
acpi_ut_value_exit(u32 line_number,
|
|
const char *function_name,
|
|
const char *module_name, u32 component_id, u64 value)
|
|
{
|
|
|
|
/* Check if enabled up-front for performance */
|
|
|
|
if (ACPI_IS_DEBUG_ENABLED(ACPI_LV_FUNCTIONS, component_id)) {
|
|
acpi_debug_print(ACPI_LV_FUNCTIONS,
|
|
line_number, function_name, module_name,
|
|
component_id, "%s %8.8X%8.8X\n",
|
|
acpi_gbl_fn_exit_str,
|
|
ACPI_FORMAT_UINT64(value));
|
|
}
|
|
|
|
if (acpi_gbl_nesting_level) {
|
|
acpi_gbl_nesting_level--;
|
|
}
|
|
}
|
|
|
|
ACPI_EXPORT_SYMBOL(acpi_ut_value_exit)
|
|
|
|
/*******************************************************************************
|
|
*
|
|
* FUNCTION: acpi_ut_ptr_exit
|
|
*
|
|
* PARAMETERS: line_number - Caller's line number
|
|
* function_name - Caller's procedure name
|
|
* module_name - Caller's module name
|
|
* component_id - Caller's component ID
|
|
* ptr - Pointer to display
|
|
*
|
|
* RETURN: None
|
|
*
|
|
* DESCRIPTION: Function exit trace. Prints only if TRACE_FUNCTIONS bit is
|
|
* set in debug_level. Prints exit value also.
|
|
*
|
|
******************************************************************************/
|
|
void
|
|
acpi_ut_ptr_exit(u32 line_number,
|
|
const char *function_name,
|
|
const char *module_name, u32 component_id, u8 *ptr)
|
|
{
|
|
|
|
/* Check if enabled up-front for performance */
|
|
|
|
if (ACPI_IS_DEBUG_ENABLED(ACPI_LV_FUNCTIONS, component_id)) {
|
|
acpi_debug_print(ACPI_LV_FUNCTIONS,
|
|
line_number, function_name, module_name,
|
|
component_id, "%s %p\n", acpi_gbl_fn_exit_str,
|
|
ptr);
|
|
}
|
|
|
|
if (acpi_gbl_nesting_level) {
|
|
acpi_gbl_nesting_level--;
|
|
}
|
|
}
|
|
|
|
#endif
|
|
|
|
#ifdef ACPI_APPLICATION
|
|
/*******************************************************************************
|
|
*
|
|
* FUNCTION: acpi_log_error
|
|
*
|
|
* 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 acpi_log_error(const char *format, ...)
|
|
{
|
|
va_list args;
|
|
|
|
va_start(args, format);
|
|
(void)acpi_ut_file_vprintf(ACPI_FILE_ERR, format, args);
|
|
va_end(args);
|
|
}
|
|
|
|
ACPI_EXPORT_SYMBOL(acpi_log_error)
|
|
#endif
|