1 /******************************************************************************
3 * Module Name: extrace - Support for interpreter execution tracing
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2021, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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.
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 MERCHANTABILITY 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.
50 #define _COMPONENT ACPI_EXECUTER
51 ACPI_MODULE_NAME ("extrace")
54 static ACPI_OPERAND_OBJECT
*AcpiGbl_TraceMethodObject
= NULL
;
56 /* Local prototypes */
58 #ifdef ACPI_DEBUG_OUTPUT
60 AcpiExGetTraceEventName (
61 ACPI_TRACE_EVENT_TYPE Type
);
65 /*******************************************************************************
67 * FUNCTION: AcpiExInterpreterTraceEnabled
69 * PARAMETERS: Name - Whether method name should be matched,
70 * this should be checked before starting
73 * RETURN: TRUE if interpreter trace is enabled.
75 * DESCRIPTION: Check whether interpreter trace is enabled
77 ******************************************************************************/
80 AcpiExInterpreterTraceEnabled (
84 /* Check if tracing is enabled */
86 if (!(AcpiGbl_TraceFlags
& ACPI_TRACE_ENABLED
))
92 * Check if tracing is filtered:
94 * 1. If the tracer is started, AcpiGbl_TraceMethodObject should have
95 * been filled by the trace starter
96 * 2. If the tracer is not started, AcpiGbl_TraceMethodName should be
97 * matched if it is specified
98 * 3. If the tracer is oneshot style, AcpiGbl_TraceMethodName should
99 * not be cleared by the trace stopper during the first match
101 if (AcpiGbl_TraceMethodObject
)
107 (AcpiGbl_TraceMethodName
&&
108 strcmp (AcpiGbl_TraceMethodName
, Name
)))
113 if ((AcpiGbl_TraceFlags
& ACPI_TRACE_ONESHOT
) &&
114 !AcpiGbl_TraceMethodName
)
123 /*******************************************************************************
125 * FUNCTION: AcpiExGetTraceEventName
127 * PARAMETERS: Type - Trace event type
129 * RETURN: Trace event name.
131 * DESCRIPTION: Used to obtain the full trace event name.
133 ******************************************************************************/
135 #ifdef ACPI_DEBUG_OUTPUT
138 AcpiExGetTraceEventName (
139 ACPI_TRACE_EVENT_TYPE Type
)
144 case ACPI_TRACE_AML_METHOD
:
148 case ACPI_TRACE_AML_OPCODE
:
152 case ACPI_TRACE_AML_REGION
:
165 /*******************************************************************************
167 * FUNCTION: AcpiExTracePoint
169 * PARAMETERS: Type - Trace event type
170 * Begin - TRUE if before execution
171 * Aml - Executed AML address
172 * Pathname - Object path
176 * DESCRIPTION: Internal interpreter execution trace.
178 ******************************************************************************/
182 ACPI_TRACE_EVENT_TYPE Type
,
188 ACPI_FUNCTION_NAME (ExTracePoint
);
193 ACPI_DEBUG_PRINT ((ACPI_DB_TRACE_POINT
,
194 "%s %s [0x%p:%s] execution.\n",
195 AcpiExGetTraceEventName (Type
), Begin
? "Begin" : "End",
200 ACPI_DEBUG_PRINT ((ACPI_DB_TRACE_POINT
,
201 "%s %s [0x%p] execution.\n",
202 AcpiExGetTraceEventName (Type
), Begin
? "Begin" : "End",
208 /*******************************************************************************
210 * FUNCTION: AcpiExStartTraceMethod
212 * PARAMETERS: MethodNode - Node of the method
213 * ObjDesc - The method object
214 * WalkState - current state, NULL if not yet executing
219 * DESCRIPTION: Start control method execution trace
221 ******************************************************************************/
224 AcpiExStartTraceMethod (
225 ACPI_NAMESPACE_NODE
*MethodNode
,
226 ACPI_OPERAND_OBJECT
*ObjDesc
,
227 ACPI_WALK_STATE
*WalkState
)
229 char *Pathname
= NULL
;
230 BOOLEAN Enabled
= FALSE
;
233 ACPI_FUNCTION_NAME (ExStartTraceMethod
);
238 Pathname
= AcpiNsGetNormalizedPathname (MethodNode
, TRUE
);
241 Enabled
= AcpiExInterpreterTraceEnabled (Pathname
);
242 if (Enabled
&& !AcpiGbl_TraceMethodObject
)
244 AcpiGbl_TraceMethodObject
= ObjDesc
;
245 AcpiGbl_OriginalDbgLevel
= AcpiDbgLevel
;
246 AcpiGbl_OriginalDbgLayer
= AcpiDbgLayer
;
247 AcpiDbgLevel
= ACPI_TRACE_LEVEL_ALL
;
248 AcpiDbgLayer
= ACPI_TRACE_LAYER_ALL
;
250 if (AcpiGbl_TraceDbgLevel
)
252 AcpiDbgLevel
= AcpiGbl_TraceDbgLevel
;
255 if (AcpiGbl_TraceDbgLayer
)
257 AcpiDbgLayer
= AcpiGbl_TraceDbgLayer
;
263 ACPI_TRACE_POINT (ACPI_TRACE_AML_METHOD
, TRUE
,
264 ObjDesc
? ObjDesc
->Method
.AmlStart
: NULL
, Pathname
);
269 ACPI_FREE (Pathname
);
274 /*******************************************************************************
276 * FUNCTION: AcpiExStopTraceMethod
278 * PARAMETERS: MethodNode - Node of the method
279 * ObjDesc - The method object
280 * WalkState - current state, NULL if not yet executing
285 * DESCRIPTION: Stop control method execution trace
287 ******************************************************************************/
290 AcpiExStopTraceMethod (
291 ACPI_NAMESPACE_NODE
*MethodNode
,
292 ACPI_OPERAND_OBJECT
*ObjDesc
,
293 ACPI_WALK_STATE
*WalkState
)
295 char *Pathname
= NULL
;
299 ACPI_FUNCTION_NAME (ExStopTraceMethod
);
304 Pathname
= AcpiNsGetNormalizedPathname (MethodNode
, TRUE
);
307 Enabled
= AcpiExInterpreterTraceEnabled (NULL
);
311 ACPI_TRACE_POINT (ACPI_TRACE_AML_METHOD
, FALSE
,
312 ObjDesc
? ObjDesc
->Method
.AmlStart
: NULL
, Pathname
);
315 /* Check whether the tracer should be stopped */
317 if (AcpiGbl_TraceMethodObject
== ObjDesc
)
319 /* Disable further tracing if type is one-shot */
321 if (AcpiGbl_TraceFlags
& ACPI_TRACE_ONESHOT
)
323 AcpiGbl_TraceMethodName
= NULL
;
326 AcpiDbgLevel
= AcpiGbl_OriginalDbgLevel
;
327 AcpiDbgLayer
= AcpiGbl_OriginalDbgLayer
;
328 AcpiGbl_TraceMethodObject
= NULL
;
333 ACPI_FREE (Pathname
);
338 /*******************************************************************************
340 * FUNCTION: AcpiExStartTraceOpcode
342 * PARAMETERS: Op - The parser opcode object
343 * WalkState - current state, NULL if not yet executing
348 * DESCRIPTION: Start opcode execution trace
350 ******************************************************************************/
353 AcpiExStartTraceOpcode (
354 ACPI_PARSE_OBJECT
*Op
,
355 ACPI_WALK_STATE
*WalkState
)
358 ACPI_FUNCTION_NAME (ExStartTraceOpcode
);
361 if (AcpiExInterpreterTraceEnabled (NULL
) &&
362 (AcpiGbl_TraceFlags
& ACPI_TRACE_OPCODE
))
364 ACPI_TRACE_POINT (ACPI_TRACE_AML_OPCODE
, TRUE
,
365 Op
->Common
.Aml
, Op
->Common
.AmlOpName
);
370 /*******************************************************************************
372 * FUNCTION: AcpiExStopTraceOpcode
374 * PARAMETERS: Op - The parser opcode object
375 * WalkState - current state, NULL if not yet executing
380 * DESCRIPTION: Stop opcode execution trace
382 ******************************************************************************/
385 AcpiExStopTraceOpcode (
386 ACPI_PARSE_OBJECT
*Op
,
387 ACPI_WALK_STATE
*WalkState
)
390 ACPI_FUNCTION_NAME (ExStopTraceOpcode
);
393 if (AcpiExInterpreterTraceEnabled (NULL
) &&
394 (AcpiGbl_TraceFlags
& ACPI_TRACE_OPCODE
))
396 ACPI_TRACE_POINT (ACPI_TRACE_AML_OPCODE
, FALSE
,
397 Op
->Common
.Aml
, Op
->Common
.AmlOpName
);