acoutput.h revision 249663
1/****************************************************************************** 2 * 3 * Name: acoutput.h -- debug output 4 * 5 *****************************************************************************/ 6 7/* 8 * Copyright (C) 2000 - 2013, 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#ifndef __ACOUTPUT_H__ 45#define __ACOUTPUT_H__ 46 47/* 48 * Debug levels and component IDs. These are used to control the 49 * granularity of the output of the ACPI_DEBUG_PRINT macro -- on a 50 * per-component basis and a per-exception-type basis. 51 */ 52 53/* Component IDs are used in the global "DebugLayer" */ 54 55#define ACPI_UTILITIES 0x00000001 56#define ACPI_HARDWARE 0x00000002 57#define ACPI_EVENTS 0x00000004 58#define ACPI_TABLES 0x00000008 59#define ACPI_NAMESPACE 0x00000010 60#define ACPI_PARSER 0x00000020 61#define ACPI_DISPATCHER 0x00000040 62#define ACPI_EXECUTER 0x00000080 63#define ACPI_RESOURCES 0x00000100 64#define ACPI_CA_DEBUGGER 0x00000200 65#define ACPI_OS_SERVICES 0x00000400 66#define ACPI_CA_DISASSEMBLER 0x00000800 67 68/* Component IDs for ACPI tools and utilities */ 69 70#define ACPI_COMPILER 0x00001000 71#define ACPI_TOOLS 0x00002000 72#define ACPI_EXAMPLE 0x00004000 73#define ACPI_DRIVER 0x00008000 74#define DT_COMPILER 0x00010000 75#define ASL_PREPROCESSOR 0x00020000 76 77#define ACPI_ALL_COMPONENTS 0x0001FFFF 78#define ACPI_COMPONENT_DEFAULT (ACPI_ALL_COMPONENTS) 79 80/* Component IDs reserved for ACPI drivers */ 81 82#define ACPI_ALL_DRIVERS 0xFFFF0000 83 84 85/* 86 * Raw debug output levels, do not use these in the ACPI_DEBUG_PRINT macros 87 */ 88#define ACPI_LV_INIT 0x00000001 89#define ACPI_LV_DEBUG_OBJECT 0x00000002 90#define ACPI_LV_INFO 0x00000004 91#define ACPI_LV_REPAIR 0x00000008 92#define ACPI_LV_ALL_EXCEPTIONS 0x0000000F 93 94/* Trace verbosity level 1 [Standard Trace Level] */ 95 96#define ACPI_LV_INIT_NAMES 0x00000020 97#define ACPI_LV_PARSE 0x00000040 98#define ACPI_LV_LOAD 0x00000080 99#define ACPI_LV_DISPATCH 0x00000100 100#define ACPI_LV_EXEC 0x00000200 101#define ACPI_LV_NAMES 0x00000400 102#define ACPI_LV_OPREGION 0x00000800 103#define ACPI_LV_BFIELD 0x00001000 104#define ACPI_LV_TABLES 0x00002000 105#define ACPI_LV_VALUES 0x00004000 106#define ACPI_LV_OBJECTS 0x00008000 107#define ACPI_LV_RESOURCES 0x00010000 108#define ACPI_LV_USER_REQUESTS 0x00020000 109#define ACPI_LV_PACKAGE 0x00040000 110#define ACPI_LV_VERBOSITY1 0x0007FF40 | ACPI_LV_ALL_EXCEPTIONS 111 112/* Trace verbosity level 2 [Function tracing and memory allocation] */ 113 114#define ACPI_LV_ALLOCATIONS 0x00100000 115#define ACPI_LV_FUNCTIONS 0x00200000 116#define ACPI_LV_OPTIMIZATIONS 0x00400000 117#define ACPI_LV_VERBOSITY2 0x00700000 | ACPI_LV_VERBOSITY1 118#define ACPI_LV_ALL ACPI_LV_VERBOSITY2 119 120/* Trace verbosity level 3 [Threading, I/O, and Interrupts] */ 121 122#define ACPI_LV_MUTEX 0x01000000 123#define ACPI_LV_THREADS 0x02000000 124#define ACPI_LV_IO 0x04000000 125#define ACPI_LV_INTERRUPTS 0x08000000 126#define ACPI_LV_VERBOSITY3 0x0F000000 | ACPI_LV_VERBOSITY2 127 128/* Exceptionally verbose output -- also used in the global "DebugLevel" */ 129 130#define ACPI_LV_AML_DISASSEMBLE 0x10000000 131#define ACPI_LV_VERBOSE_INFO 0x20000000 132#define ACPI_LV_FULL_TABLES 0x40000000 133#define ACPI_LV_EVENTS 0x80000000 134#define ACPI_LV_VERBOSE 0xF0000000 135 136 137/* 138 * Debug level macros that are used in the DEBUG_PRINT macros 139 */ 140#define ACPI_DEBUG_LEVEL(dl) (UINT32) dl,ACPI_DEBUG_PARAMETERS 141 142/* 143 * Exception level -- used in the global "DebugLevel" 144 * 145 * Note: For errors, use the ACPI_ERROR or ACPI_EXCEPTION interfaces. 146 * For warnings, use ACPI_WARNING. 147 */ 148#define ACPI_DB_INIT ACPI_DEBUG_LEVEL (ACPI_LV_INIT) 149#define ACPI_DB_DEBUG_OBJECT ACPI_DEBUG_LEVEL (ACPI_LV_DEBUG_OBJECT) 150#define ACPI_DB_INFO ACPI_DEBUG_LEVEL (ACPI_LV_INFO) 151#define ACPI_DB_REPAIR ACPI_DEBUG_LEVEL (ACPI_LV_REPAIR) 152#define ACPI_DB_ALL_EXCEPTIONS ACPI_DEBUG_LEVEL (ACPI_LV_ALL_EXCEPTIONS) 153 154/* Trace level -- also used in the global "DebugLevel" */ 155 156#define ACPI_DB_INIT_NAMES ACPI_DEBUG_LEVEL (ACPI_LV_INIT_NAMES) 157#define ACPI_DB_THREADS ACPI_DEBUG_LEVEL (ACPI_LV_THREADS) 158#define ACPI_DB_PARSE ACPI_DEBUG_LEVEL (ACPI_LV_PARSE) 159#define ACPI_DB_DISPATCH ACPI_DEBUG_LEVEL (ACPI_LV_DISPATCH) 160#define ACPI_DB_LOAD ACPI_DEBUG_LEVEL (ACPI_LV_LOAD) 161#define ACPI_DB_EXEC ACPI_DEBUG_LEVEL (ACPI_LV_EXEC) 162#define ACPI_DB_NAMES ACPI_DEBUG_LEVEL (ACPI_LV_NAMES) 163#define ACPI_DB_OPREGION ACPI_DEBUG_LEVEL (ACPI_LV_OPREGION) 164#define ACPI_DB_BFIELD ACPI_DEBUG_LEVEL (ACPI_LV_BFIELD) 165#define ACPI_DB_TABLES ACPI_DEBUG_LEVEL (ACPI_LV_TABLES) 166#define ACPI_DB_FUNCTIONS ACPI_DEBUG_LEVEL (ACPI_LV_FUNCTIONS) 167#define ACPI_DB_OPTIMIZATIONS ACPI_DEBUG_LEVEL (ACPI_LV_OPTIMIZATIONS) 168#define ACPI_DB_VALUES ACPI_DEBUG_LEVEL (ACPI_LV_VALUES) 169#define ACPI_DB_OBJECTS ACPI_DEBUG_LEVEL (ACPI_LV_OBJECTS) 170#define ACPI_DB_ALLOCATIONS ACPI_DEBUG_LEVEL (ACPI_LV_ALLOCATIONS) 171#define ACPI_DB_RESOURCES ACPI_DEBUG_LEVEL (ACPI_LV_RESOURCES) 172#define ACPI_DB_IO ACPI_DEBUG_LEVEL (ACPI_LV_IO) 173#define ACPI_DB_INTERRUPTS ACPI_DEBUG_LEVEL (ACPI_LV_INTERRUPTS) 174#define ACPI_DB_USER_REQUESTS ACPI_DEBUG_LEVEL (ACPI_LV_USER_REQUESTS) 175#define ACPI_DB_PACKAGE ACPI_DEBUG_LEVEL (ACPI_LV_PACKAGE) 176#define ACPI_DB_MUTEX ACPI_DEBUG_LEVEL (ACPI_LV_MUTEX) 177#define ACPI_DB_EVENTS ACPI_DEBUG_LEVEL (ACPI_LV_EVENTS) 178 179#define ACPI_DB_ALL ACPI_DEBUG_LEVEL (ACPI_LV_ALL) 180 181/* Defaults for DebugLevel, debug and normal */ 182 183#define ACPI_DEBUG_DEFAULT (ACPI_LV_INIT | ACPI_LV_DEBUG_OBJECT | ACPI_LV_REPAIR) 184#define ACPI_NORMAL_DEFAULT (ACPI_LV_INIT | ACPI_LV_DEBUG_OBJECT | ACPI_LV_REPAIR) 185#define ACPI_DEBUG_ALL (ACPI_LV_AML_DISASSEMBLE | ACPI_LV_ALL_EXCEPTIONS | ACPI_LV_ALL) 186 187 188#if defined (ACPI_DEBUG_OUTPUT) || !defined (ACPI_NO_ERROR_MESSAGES) 189/* 190 * The module name is used primarily for error and debug messages. 191 * The __FILE__ macro is not very useful for this, because it 192 * usually includes the entire pathname to the module making the 193 * debug output difficult to read. 194 */ 195#define ACPI_MODULE_NAME(Name) static const char ACPI_UNUSED_VAR _AcpiModuleName[] = Name; 196#else 197/* 198 * For the no-debug and no-error-msg cases, we must at least define 199 * a null module name. 200 */ 201#define ACPI_MODULE_NAME(Name) 202#define _AcpiModuleName "" 203#endif 204 205/* 206 * Ascii error messages can be configured out 207 */ 208#ifndef ACPI_NO_ERROR_MESSAGES 209#define AE_INFO _AcpiModuleName, __LINE__ 210 211/* 212 * Error reporting. Callers module and line number are inserted by AE_INFO, 213 * the plist contains a set of parens to allow variable-length lists. 214 * These macros are used for both the debug and non-debug versions of the code. 215 */ 216#define ACPI_INFO(plist) AcpiInfo plist 217#define ACPI_WARNING(plist) AcpiWarning plist 218#define ACPI_EXCEPTION(plist) AcpiException plist 219#define ACPI_ERROR(plist) AcpiError plist 220#define ACPI_BIOS_WARNING(plist) AcpiBiosWarning plist 221#define ACPI_BIOS_ERROR(plist) AcpiBiosError plist 222#define ACPI_DEBUG_OBJECT(obj,l,i) AcpiExDoDebugObject(obj,l,i) 223 224#else 225 226/* No error messages */ 227 228#define ACPI_INFO(plist) 229#define ACPI_WARNING(plist) 230#define ACPI_EXCEPTION(plist) 231#define ACPI_ERROR(plist) 232#define ACPI_BIOS_WARNING(plist) 233#define ACPI_BIOS_ERROR(plist) 234#define ACPI_DEBUG_OBJECT(obj,l,i) 235 236#endif /* ACPI_NO_ERROR_MESSAGES */ 237 238 239/* 240 * Debug macros that are conditionally compiled 241 */ 242#ifdef ACPI_DEBUG_OUTPUT 243 244/* 245 * If ACPI_GET_FUNCTION_NAME was not defined in the compiler-dependent header, 246 * define it now. This is the case where there the compiler does not support 247 * a __FUNCTION__ macro or equivalent. 248 */ 249#ifndef ACPI_GET_FUNCTION_NAME 250#define ACPI_GET_FUNCTION_NAME _AcpiFunctionName 251 252/* 253 * The Name parameter should be the procedure name as a quoted string. 254 * The function name is also used by the function exit macros below. 255 * Note: (const char) is used to be compatible with the debug interfaces 256 * and macros such as __FUNCTION__. 257 */ 258#define ACPI_FUNCTION_NAME(Name) static const char _AcpiFunctionName[] = #Name; 259 260#else 261/* Compiler supports __FUNCTION__ (or equivalent) -- Ignore this macro */ 262 263#define ACPI_FUNCTION_NAME(Name) 264#endif /* ACPI_GET_FUNCTION_NAME */ 265 266/* 267 * Common parameters used for debug output functions: 268 * line number, function name, module(file) name, component ID 269 */ 270#define ACPI_DEBUG_PARAMETERS \ 271 __LINE__, ACPI_GET_FUNCTION_NAME, _AcpiModuleName, _COMPONENT 272 273/* Check if debug output is currently dynamically enabled */ 274 275#define ACPI_IS_DEBUG_ENABLED(Level, Component) \ 276 ((Level & AcpiDbgLevel) && (Component & AcpiDbgLayer)) 277 278/* 279 * Master debug print macros 280 * Print message if and only if: 281 * 1) Debug print for the current component is enabled 282 * 2) Debug error level or trace level for the print statement is enabled 283 * 284 * November 2012: Moved the runtime check for whether to actually emit the 285 * debug message outside of the print function itself. This improves overall 286 * performance at a relatively small code cost. Implementation involves the 287 * use of variadic macros supported by C99. 288 * 289 * Note: the ACPI_DO_WHILE0 macro is used to prevent some compilers from 290 * complaining about these constructs. On other compilers the do...while 291 * adds some extra code, so this feature is optional. 292 */ 293#ifdef ACPI_USE_DO_WHILE_0 294#define ACPI_DO_WHILE0(a) do a while(0) 295#else 296#define ACPI_DO_WHILE0(a) a 297#endif 298 299/* DEBUG_PRINT functions */ 300 301#define ACPI_DEBUG_PRINT(plist) ACPI_ACTUAL_DEBUG plist 302#define ACPI_DEBUG_PRINT_RAW(plist) ACPI_ACTUAL_DEBUG_RAW plist 303 304/* Helper macros for DEBUG_PRINT */ 305 306#define ACPI_DO_DEBUG_PRINT(Function, Level, Line, Filename, Modulename, Component, ...) \ 307 ACPI_DO_WHILE0 ({ \ 308 if (ACPI_IS_DEBUG_ENABLED (Level, Component)) \ 309 { \ 310 Function (Level, Line, Filename, Modulename, Component, __VA_ARGS__); \ 311 } \ 312 }) 313 314#define ACPI_ACTUAL_DEBUG(Level, Line, Filename, Modulename, Component, ...) \ 315 ACPI_DO_DEBUG_PRINT (AcpiDebugPrint, Level, Line, \ 316 Filename, Modulename, Component, __VA_ARGS__) 317 318#define ACPI_ACTUAL_DEBUG_RAW(Level, Line, Filename, Modulename, Component, ...) \ 319 ACPI_DO_DEBUG_PRINT (AcpiDebugPrintRaw, Level, Line, \ 320 Filename, Modulename, Component, __VA_ARGS__) 321 322 323/* 324 * Function entry tracing 325 * 326 * The name of the function is emitted as a local variable that is 327 * intended to be used by both the entry trace and the exit trace. 328 */ 329 330/* Helper macro */ 331 332#define ACPI_TRACE_ENTRY(Name, Function, Type, Param) \ 333 ACPI_FUNCTION_NAME (Name) \ 334 Function (ACPI_DEBUG_PARAMETERS, (Type) (Param)) 335 336/* The actual entry trace macros */ 337 338#define ACPI_FUNCTION_TRACE(Name) \ 339 ACPI_FUNCTION_NAME(Name) \ 340 AcpiUtTrace (ACPI_DEBUG_PARAMETERS) 341 342#define ACPI_FUNCTION_TRACE_PTR(Name, Pointer) \ 343 ACPI_TRACE_ENTRY (Name, AcpiUtTracePtr, void *, Pointer) 344 345#define ACPI_FUNCTION_TRACE_U32(Name, Value) \ 346 ACPI_TRACE_ENTRY (Name, AcpiUtTraceU32, UINT32, Value) 347 348#define ACPI_FUNCTION_TRACE_STR(Name, String) \ 349 ACPI_TRACE_ENTRY (Name, AcpiUtTraceStr, char *, String) 350 351#define ACPI_FUNCTION_ENTRY() \ 352 AcpiUtTrackStackPtr() 353 354 355/* 356 * Function exit tracing 357 * 358 * These macros include a return statement. This is usually considered 359 * bad form, but having a separate exit macro before the actual return 360 * is very ugly and difficult to maintain. 361 * 362 * One of the FUNCTION_TRACE macros above must be used in conjunction 363 * with these macros so that "_AcpiFunctionName" is defined. 364 * 365 * There are two versions of most of the return macros. The default version is 366 * safer, since it avoids side-effects by guaranteeing that the argument will 367 * not be evaluated twice. 368 * 369 * A less-safe version of the macros is provided for optional use if the 370 * compiler uses excessive CPU stack (for example, this may happen in the 371 * debug case if code optimzation is disabled.) 372 */ 373 374/* Exit trace helper macro */ 375 376#ifndef ACPI_SIMPLE_RETURN_MACROS 377 378#define ACPI_TRACE_EXIT(Function, Type, Param) \ 379 ACPI_DO_WHILE0 ({ \ 380 register Type _Param = (Type) (Param); \ 381 Function (ACPI_DEBUG_PARAMETERS, _Param); \ 382 return (_Param); \ 383 }) 384 385#else /* Use original less-safe macros */ 386 387#define ACPI_TRACE_EXIT(Function, Type, Param) \ 388 ACPI_DO_WHILE0 ({ \ 389 Function (ACPI_DEBUG_PARAMETERS, (Type) (Param)); \ 390 return (Param); \ 391 }) 392 393#endif /* ACPI_SIMPLE_RETURN_MACROS */ 394 395/* The actual exit macros */ 396 397#define return_VOID \ 398 ACPI_DO_WHILE0 ({ \ 399 AcpiUtExit (ACPI_DEBUG_PARAMETERS); \ 400 return; \ 401 }) 402 403#define return_ACPI_STATUS(Status) \ 404 ACPI_TRACE_EXIT (AcpiUtStatusExit, ACPI_STATUS, Status) 405 406#define return_PTR(Pointer) \ 407 ACPI_TRACE_EXIT (AcpiUtPtrExit, void *, Pointer) 408 409#define return_VALUE(Value) \ 410 ACPI_TRACE_EXIT (AcpiUtValueExit, UINT64, Value) 411 412#define return_UINT32(Value) \ 413 ACPI_TRACE_EXIT (AcpiUtValueExit, UINT32, Value) 414 415#define return_UINT8(Value) \ 416 ACPI_TRACE_EXIT (AcpiUtValueExit, UINT8, Value) 417 418/* Conditional execution */ 419 420#define ACPI_DEBUG_EXEC(a) a 421#define ACPI_DEBUG_ONLY_MEMBERS(a) a; 422#define _VERBOSE_STRUCTURES 423 424 425/* Various object display routines for debug */ 426 427#define ACPI_DUMP_STACK_ENTRY(a) AcpiExDumpOperand((a), 0) 428#define ACPI_DUMP_OPERANDS(a, b ,c) AcpiExDumpOperands(a, b, c) 429#define ACPI_DUMP_ENTRY(a, b) AcpiNsDumpEntry (a, b) 430#define ACPI_DUMP_PATHNAME(a, b, c, d) AcpiNsDumpPathname(a, b, c, d) 431#define ACPI_DUMP_BUFFER(a, b) AcpiUtDebugDumpBuffer((UINT8 *) a, b, DB_BYTE_DISPLAY, _COMPONENT) 432 433#else /* ACPI_DEBUG_OUTPUT */ 434/* 435 * This is the non-debug case -- make everything go away, 436 * leaving no executable debug code! 437 */ 438#define ACPI_DEBUG_PRINT(pl) 439#define ACPI_DEBUG_PRINT_RAW(pl) 440#define ACPI_DEBUG_EXEC(a) 441#define ACPI_DEBUG_ONLY_MEMBERS(a) 442#define ACPI_FUNCTION_NAME(a) 443#define ACPI_FUNCTION_TRACE(a) 444#define ACPI_FUNCTION_TRACE_PTR(a, b) 445#define ACPI_FUNCTION_TRACE_U32(a, b) 446#define ACPI_FUNCTION_TRACE_STR(a, b) 447#define ACPI_FUNCTION_ENTRY() 448#define ACPI_DUMP_STACK_ENTRY(a) 449#define ACPI_DUMP_OPERANDS(a, b, c) 450#define ACPI_DUMP_ENTRY(a, b) 451#define ACPI_DUMP_PATHNAME(a, b, c, d) 452#define ACPI_DUMP_BUFFER(a, b) 453#define ACPI_IS_DEBUG_ENABLED(Level, Component) 0 454 455/* Return macros must have a return statement at the minimum */ 456 457#define return_VOID return 458#define return_ACPI_STATUS(s) return(s) 459#define return_PTR(s) return(s) 460#define return_VALUE(s) return(s) 461#define return_UINT8(s) return(s) 462#define return_UINT32(s) return(s) 463 464#endif /* ACPI_DEBUG_OUTPUT */ 465 466 467#endif /* __ACOUTPUT_H__ */ 468