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