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