1 /******************************************************************************
2 *
3 * Module Name: extrace - Support for interpreter execution tracing
4 *
5 *****************************************************************************/
6
7 /******************************************************************************
8 *
9 * 1. Copyright Notice
10 *
11 * Some or all of this work - Copyright (c) 1999 - 2025, Intel Corp.
12 * All rights reserved.
13 *
14 * 2. License
15 *
16 * 2.1. This is your license from Intel Corp. under its intellectual property
17 * rights. You may have additional license terms from the party that provided
18 * you this software, covering your right to use that party's intellectual
19 * property rights.
20 *
21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22 * copy of the source code appearing in this file ("Covered Code") an
23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24 * base code distributed originally by Intel ("Original Intel Code") to copy,
25 * make derivatives, distribute, use and display any portion of the Covered
26 * Code in any form, with the right to sublicense such rights; and
27 *
28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29 * license (with the right to sublicense), under only those claims of Intel
30 * patents that are infringed by the Original Intel Code, to make, use, sell,
31 * offer to sell, and import the Covered Code and derivative works thereof
32 * solely to the minimum extent necessary to exercise the above copyright
33 * license, and in no event shall the patent license extend to any additions
34 * to or modifications of the Original Intel Code. No other license or right
35 * is granted directly or by implication, estoppel or otherwise;
36 *
37 * The above copyright and patent license is granted only if the following
38 * conditions are met:
39 *
40 * 3. Conditions
41 *
42 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43 * Redistribution of source code of any substantial portion of the Covered
44 * Code or modification with rights to further distribute source must include
45 * the above Copyright Notice, the above License, this list of Conditions,
46 * and the following Disclaimer and Export Compliance provision. In addition,
47 * Licensee must cause all Covered Code to which Licensee contributes to
48 * contain a file documenting the changes Licensee made to create that Covered
49 * Code and the date of any change. Licensee must include in that file the
50 * documentation of any changes made by any predecessor Licensee. Licensee
51 * must include a prominent statement that the modification is derived,
52 * directly or indirectly, from Original Intel Code.
53 *
54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55 * Redistribution of source code of any substantial portion of the Covered
56 * Code or modification without rights to further distribute source must
57 * include the following Disclaimer and Export Compliance provision in the
58 * documentation and/or other materials provided with distribution. In
59 * addition, Licensee may not authorize further sublicense of source of any
60 * portion of the Covered Code, and must include terms to the effect that the
61 * license from Licensee to its licensee is limited to the intellectual
62 * property embodied in the software Licensee provides to its licensee, and
63 * not to intellectual property embodied in modifications its licensee may
64 * make.
65 *
66 * 3.3. Redistribution of Executable. Redistribution in executable form of any
67 * substantial portion of the Covered Code or modification must reproduce the
68 * above Copyright Notice, and the following Disclaimer and Export Compliance
69 * provision in the documentation and/or other materials provided with the
70 * distribution.
71 *
72 * 3.4. Intel retains all right, title, and interest in and to the Original
73 * Intel Code.
74 *
75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76 * Intel shall be used in advertising or otherwise to promote the sale, use or
77 * other dealings in products derived from or relating to the Covered Code
78 * without prior written authorization from Intel.
79 *
80 * 4. Disclaimer and Export Compliance
81 *
82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
88 * PARTICULAR PURPOSE.
89 *
90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
97 * LIMITED REMEDY.
98 *
99 * 4.3. Licensee shall not export, either directly or indirectly, any of this
100 * software or system incorporating such software without first obtaining any
101 * required license or other approval from the U. S. Department of Commerce or
102 * any other agency or department of the United States Government. In the
103 * event Licensee exports any such software from the United States or
104 * re-exports any such software from a foreign destination, Licensee shall
105 * ensure that the distribution and export/re-export of the software is in
106 * compliance with all laws, regulations, orders, or other restrictions of the
107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108 * any of its subsidiaries will export/re-export any technical data, process,
109 * software, or service, directly or indirectly, to any country for which the
110 * United States government or any agency thereof requires an export license,
111 * other governmental approval, or letter of assurance, without first obtaining
112 * such license, approval or letter.
113 *
114 *****************************************************************************
115 *
116 * Alternatively, you may choose to be licensed under the terms of the
117 * following license:
118 *
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
121 * are met:
122 * 1. Redistributions of source code must retain the above copyright
123 * notice, this list of conditions, and the following disclaimer,
124 * without modification.
125 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126 * substantially similar to the "NO WARRANTY" disclaimer below
127 * ("Disclaimer") and any redistribution must be conditioned upon
128 * including a substantially similar Disclaimer requirement for further
129 * binary redistribution.
130 * 3. Neither the names of the above-listed copyright holders nor the names
131 * of any contributors may be used to endorse or promote products derived
132 * from this software without specific prior written permission.
133 *
134 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145 *
146 * Alternatively, you may choose to be licensed under the terms of the
147 * GNU General Public License ("GPL") version 2 as published by the Free
148 * Software Foundation.
149 *
150 *****************************************************************************/
151
152 #include <contrib/dev/acpica/include/acpi.h>
153 #include <contrib/dev/acpica/include/accommon.h>
154 #include <contrib/dev/acpica/include/acnamesp.h>
155 #include <contrib/dev/acpica/include/acinterp.h>
156
157
158 #define _COMPONENT ACPI_EXECUTER
159 ACPI_MODULE_NAME ("extrace")
160
161
162 static ACPI_OPERAND_OBJECT *AcpiGbl_TraceMethodObject = NULL;
163
164 /* Local prototypes */
165
166 #ifdef ACPI_DEBUG_OUTPUT
167 static const char *
168 AcpiExGetTraceEventName (
169 ACPI_TRACE_EVENT_TYPE Type);
170 #endif
171
172
173 /*******************************************************************************
174 *
175 * FUNCTION: AcpiExInterpreterTraceEnabled
176 *
177 * PARAMETERS: Name - Whether method name should be matched,
178 * this should be checked before starting
179 * the tracer
180 *
181 * RETURN: TRUE if interpreter trace is enabled.
182 *
183 * DESCRIPTION: Check whether interpreter trace is enabled
184 *
185 ******************************************************************************/
186
187 static BOOLEAN
AcpiExInterpreterTraceEnabled(char * Name)188 AcpiExInterpreterTraceEnabled (
189 char *Name)
190 {
191
192 /* Check if tracing is enabled */
193
194 if (!(AcpiGbl_TraceFlags & ACPI_TRACE_ENABLED))
195 {
196 return (FALSE);
197 }
198
199 /*
200 * Check if tracing is filtered:
201 *
202 * 1. If the tracer is started, AcpiGbl_TraceMethodObject should have
203 * been filled by the trace starter
204 * 2. If the tracer is not started, AcpiGbl_TraceMethodName should be
205 * matched if it is specified
206 * 3. If the tracer is oneshot style, AcpiGbl_TraceMethodName should
207 * not be cleared by the trace stopper during the first match
208 */
209 if (AcpiGbl_TraceMethodObject)
210 {
211 return (TRUE);
212 }
213
214 if (Name &&
215 (AcpiGbl_TraceMethodName &&
216 strcmp (AcpiGbl_TraceMethodName, Name)))
217 {
218 return (FALSE);
219 }
220
221 if ((AcpiGbl_TraceFlags & ACPI_TRACE_ONESHOT) &&
222 !AcpiGbl_TraceMethodName)
223 {
224 return (FALSE);
225 }
226
227 return (TRUE);
228 }
229
230
231 /*******************************************************************************
232 *
233 * FUNCTION: AcpiExGetTraceEventName
234 *
235 * PARAMETERS: Type - Trace event type
236 *
237 * RETURN: Trace event name.
238 *
239 * DESCRIPTION: Used to obtain the full trace event name.
240 *
241 ******************************************************************************/
242
243 #ifdef ACPI_DEBUG_OUTPUT
244
245 static const char *
AcpiExGetTraceEventName(ACPI_TRACE_EVENT_TYPE Type)246 AcpiExGetTraceEventName (
247 ACPI_TRACE_EVENT_TYPE Type)
248 {
249
250 switch (Type)
251 {
252 case ACPI_TRACE_AML_METHOD:
253
254 return "Method";
255
256 case ACPI_TRACE_AML_OPCODE:
257
258 return "Opcode";
259
260 case ACPI_TRACE_AML_REGION:
261
262 return "Region";
263
264 default:
265
266 return "";
267 }
268 }
269
270 #endif
271
272 /*******************************************************************************
273 *
274 * FUNCTION: AcpiExTraceArgs
275 *
276 * PARAMETERS: Params - AML method arguments
277 * Count - numer of method arguments
278 *
279 * RETURN: None
280 *
281 * DESCRIPTION: Trace any arguments
282 *
283 ******************************************************************************/
284
285 void
AcpiExTraceArgs(ACPI_OPERAND_OBJECT ** Params,UINT32 Count)286 AcpiExTraceArgs(ACPI_OPERAND_OBJECT **Params, UINT32 Count)
287 {
288 UINT32 i;
289
290 ACPI_FUNCTION_NAME(ExTraceArgs);
291
292 for (i = 0; i < Count; i++)
293 {
294 ACPI_OPERAND_OBJECT *obj_desc = Params[i];
295
296 if (!i)
297 {
298 ACPI_DEBUG_PRINT((ACPI_DB_TRACE_POINT, " "));
299 }
300
301 switch (obj_desc->Common.Type)
302 {
303 case ACPI_TYPE_INTEGER:
304 ACPI_DEBUG_PRINT_RAW((ACPI_DB_TRACE_POINT, "%jx", (uintmax_t)obj_desc->Integer.Value));
305 break;
306
307 case ACPI_TYPE_STRING:
308 if (!obj_desc->String.Length)
309 {
310 ACPI_DEBUG_PRINT_RAW((ACPI_DB_TRACE_POINT, "NULL"));
311 break;
312 }
313 if (ACPI_IS_DEBUG_ENABLED(ACPI_LV_TRACE_POINT, _COMPONENT))
314 {
315 AcpiUtPrintString(obj_desc->String.Pointer, ACPI_UINT8_MAX);
316 }
317 break;
318
319 default:
320 ACPI_DEBUG_PRINT_RAW((ACPI_DB_TRACE_POINT, "Unknown"));
321 break;
322 }
323
324 if ((i + 1) == Count)
325 {
326 ACPI_DEBUG_PRINT_RAW((ACPI_DB_TRACE_POINT, "\n"));
327 }
328 else
329 {
330 ACPI_DEBUG_PRINT_RAW((ACPI_DB_TRACE_POINT, ", "));
331 }
332 }
333 }
334
335 /*******************************************************************************
336 *
337 * FUNCTION: AcpiExTracePoint
338 *
339 * PARAMETERS: Type - Trace event type
340 * Begin - TRUE if before execution
341 * Aml - Executed AML address
342 * Pathname - Object path
343 *
344 * RETURN: None
345 *
346 * DESCRIPTION: Internal interpreter execution trace.
347 *
348 ******************************************************************************/
349
350 void
AcpiExTracePoint(ACPI_TRACE_EVENT_TYPE Type,BOOLEAN Begin,UINT8 * Aml,char * Pathname)351 AcpiExTracePoint (
352 ACPI_TRACE_EVENT_TYPE Type,
353 BOOLEAN Begin,
354 UINT8 *Aml,
355 char *Pathname)
356 {
357
358 ACPI_FUNCTION_NAME (ExTracePoint);
359
360
361 if (Pathname)
362 {
363 ACPI_DEBUG_PRINT ((ACPI_DB_TRACE_POINT,
364 "%s %s [%s] execution.\n",
365 AcpiExGetTraceEventName (Type), Begin ? "Begin" : "End",
366 Pathname));
367 }
368 else
369 {
370 ACPI_DEBUG_PRINT ((ACPI_DB_TRACE_POINT,
371 "%s %s [0x%p] execution.\n",
372 AcpiExGetTraceEventName (Type), Begin ? "Begin" : "End",
373 Aml));
374 }
375 }
376
377
378 /*******************************************************************************
379 *
380 * FUNCTION: AcpiExStartTraceMethod
381 *
382 * PARAMETERS: MethodNode - Node of the method
383 * ObjDesc - The method object
384 * WalkState - current state, NULL if not yet executing
385 * a method.
386 *
387 * RETURN: None
388 *
389 * DESCRIPTION: Start control method execution trace
390 *
391 ******************************************************************************/
392
393 void
AcpiExStartTraceMethod(ACPI_NAMESPACE_NODE * MethodNode,ACPI_OPERAND_OBJECT * ObjDesc,ACPI_WALK_STATE * WalkState)394 AcpiExStartTraceMethod (
395 ACPI_NAMESPACE_NODE *MethodNode,
396 ACPI_OPERAND_OBJECT *ObjDesc,
397 ACPI_WALK_STATE *WalkState)
398 {
399 char *Pathname = NULL;
400 BOOLEAN Enabled = FALSE;
401
402
403 ACPI_FUNCTION_NAME (ExStartTraceMethod);
404
405
406 if (MethodNode)
407 {
408 Pathname = AcpiNsGetNormalizedPathname (MethodNode, TRUE);
409 }
410
411 Enabled = AcpiExInterpreterTraceEnabled (Pathname);
412 if (Enabled && !AcpiGbl_TraceMethodObject)
413 {
414 AcpiGbl_TraceMethodObject = ObjDesc;
415 AcpiGbl_OriginalDbgLevel = AcpiDbgLevel;
416 AcpiGbl_OriginalDbgLayer = AcpiDbgLayer;
417 AcpiDbgLevel = ACPI_TRACE_LEVEL_ALL;
418 AcpiDbgLayer = ACPI_TRACE_LAYER_ALL;
419
420 if (AcpiGbl_TraceDbgLevel)
421 {
422 AcpiDbgLevel = AcpiGbl_TraceDbgLevel;
423 }
424
425 if (AcpiGbl_TraceDbgLayer)
426 {
427 AcpiDbgLayer = AcpiGbl_TraceDbgLayer;
428 }
429 }
430
431 if (Enabled)
432 {
433 ACPI_TRACE_POINT (ACPI_TRACE_AML_METHOD, TRUE,
434 ObjDesc ? ObjDesc->Method.AmlStart : NULL, Pathname);
435 }
436
437 if (Pathname)
438 {
439 ACPI_FREE (Pathname);
440 }
441 }
442
443
444 /*******************************************************************************
445 *
446 * FUNCTION: AcpiExStopTraceMethod
447 *
448 * PARAMETERS: MethodNode - Node of the method
449 * ObjDesc - The method object
450 * WalkState - current state, NULL if not yet executing
451 * a method.
452 *
453 * RETURN: None
454 *
455 * DESCRIPTION: Stop control method execution trace
456 *
457 ******************************************************************************/
458
459 void
AcpiExStopTraceMethod(ACPI_NAMESPACE_NODE * MethodNode,ACPI_OPERAND_OBJECT * ObjDesc,ACPI_WALK_STATE * WalkState)460 AcpiExStopTraceMethod (
461 ACPI_NAMESPACE_NODE *MethodNode,
462 ACPI_OPERAND_OBJECT *ObjDesc,
463 ACPI_WALK_STATE *WalkState)
464 {
465 char *Pathname = NULL;
466 BOOLEAN Enabled;
467
468
469 ACPI_FUNCTION_NAME (ExStopTraceMethod);
470
471
472 if (MethodNode)
473 {
474 Pathname = AcpiNsGetNormalizedPathname (MethodNode, TRUE);
475 }
476
477 Enabled = AcpiExInterpreterTraceEnabled (NULL);
478
479 if (Enabled)
480 {
481 ACPI_TRACE_POINT (ACPI_TRACE_AML_METHOD, FALSE,
482 ObjDesc ? ObjDesc->Method.AmlStart : NULL, Pathname);
483 }
484
485 /* Check whether the tracer should be stopped */
486
487 if (AcpiGbl_TraceMethodObject == ObjDesc)
488 {
489 /* Disable further tracing if type is one-shot */
490
491 if (AcpiGbl_TraceFlags & ACPI_TRACE_ONESHOT)
492 {
493 AcpiGbl_TraceMethodName = NULL;
494 }
495
496 AcpiDbgLevel = AcpiGbl_OriginalDbgLevel;
497 AcpiDbgLayer = AcpiGbl_OriginalDbgLayer;
498 AcpiGbl_TraceMethodObject = NULL;
499 }
500
501 if (Pathname)
502 {
503 ACPI_FREE (Pathname);
504 }
505 }
506
507
508 /*******************************************************************************
509 *
510 * FUNCTION: AcpiExStartTraceOpcode
511 *
512 * PARAMETERS: Op - The parser opcode object
513 * WalkState - current state, NULL if not yet executing
514 * a method.
515 *
516 * RETURN: None
517 *
518 * DESCRIPTION: Start opcode execution trace
519 *
520 ******************************************************************************/
521
522 void
AcpiExStartTraceOpcode(ACPI_PARSE_OBJECT * Op,ACPI_WALK_STATE * WalkState)523 AcpiExStartTraceOpcode (
524 ACPI_PARSE_OBJECT *Op,
525 ACPI_WALK_STATE *WalkState)
526 {
527
528 ACPI_FUNCTION_NAME (ExStartTraceOpcode);
529
530
531 if (AcpiExInterpreterTraceEnabled (NULL) &&
532 (AcpiGbl_TraceFlags & ACPI_TRACE_OPCODE))
533 {
534 ACPI_TRACE_POINT (ACPI_TRACE_AML_OPCODE, TRUE,
535 Op->Common.Aml, Op->Common.AmlOpName);
536 }
537 }
538
539
540 /*******************************************************************************
541 *
542 * FUNCTION: AcpiExStopTraceOpcode
543 *
544 * PARAMETERS: Op - The parser opcode object
545 * WalkState - current state, NULL if not yet executing
546 * a method.
547 *
548 * RETURN: None
549 *
550 * DESCRIPTION: Stop opcode execution trace
551 *
552 ******************************************************************************/
553
554 void
AcpiExStopTraceOpcode(ACPI_PARSE_OBJECT * Op,ACPI_WALK_STATE * WalkState)555 AcpiExStopTraceOpcode (
556 ACPI_PARSE_OBJECT *Op,
557 ACPI_WALK_STATE *WalkState)
558 {
559
560 ACPI_FUNCTION_NAME (ExStopTraceOpcode);
561
562
563 if (AcpiExInterpreterTraceEnabled (NULL) &&
564 (AcpiGbl_TraceFlags & ACPI_TRACE_OPCODE))
565 {
566 ACPI_TRACE_POINT (ACPI_TRACE_AML_OPCODE, FALSE,
567 Op->Common.Aml, Op->Common.AmlOpName);
568 }
569 }
570