acpica/executer/extrace.c

0001 /******************************************************************************
0002  *
0003  * Module Name: extrace - Support for interpreter execution tracing
0004  *
0005  *****************************************************************************/
0006
0007 /******************************************************************************
0008  *
0009  * 1. Copyright Notice
0010  *
0011  * Some or all of this work - Copyright (c) 1999 - 2024, Intel Corp.
0012  * All rights reserved.
0013  *
0014  * 2. License
0015  *
0016  * 2.1. This is your license from Intel Corp. under its intellectual property
0017  * rights. You may have additional license terms from the party that provided
0018  * you this software, covering your right to use that party's intellectual
0019  * property rights.
0020  *
0021  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
0022  * copy of the source code appearing in this file ("Covered Code") an
0023  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
0024  * base code distributed originally by Intel ("Original Intel Code") to copy,
0025  * make derivatives, distribute, use and display any portion of the Covered
0026  * Code in any form, with the right to sublicense such rights; and
0027  *
0028  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
0029  * license (with the right to sublicense), under only those claims of Intel
0030  * patents that are infringed by the Original Intel Code, to make, use, sell,
0031  * offer to sell, and import the Covered Code and derivative works thereof
0032  * solely to the minimum extent necessary to exercise the above copyright
0033  * license, and in no event shall the patent license extend to any additions
0034  * to or modifications of the Original Intel Code. No other license or right
0035  * is granted directly or by implication, estoppel or otherwise;
0036  *
0037  * The above copyright and patent license is granted only if the following
0038  * conditions are met:
0039  *
0040  * 3. Conditions
0041  *
0042  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
0043  * Redistribution of source code of any substantial portion of the Covered
0044  * Code or modification with rights to further distribute source must include
0045  * the above Copyright Notice, the above License, this list of Conditions,
0046  * and the following Disclaimer and Export Compliance provision. In addition,
0047  * Licensee must cause all Covered Code to which Licensee contributes to
0048  * contain a file documenting the changes Licensee made to create that Covered
0049  * Code and the date of any change. Licensee must include in that file the
0050  * documentation of any changes made by any predecessor Licensee. Licensee
0051  * must include a prominent statement that the modification is derived,
0052  * directly or indirectly, from Original Intel Code.
0053  *
0054  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
0055  * Redistribution of source code of any substantial portion of the Covered
0056  * Code or modification without rights to further distribute source must
0057  * include the following Disclaimer and Export Compliance provision in the
0058  * documentation and/or other materials provided with distribution. In
0059  * addition, Licensee may not authorize further sublicense of source of any
0060  * portion of the Covered Code, and must include terms to the effect that the
0061  * license from Licensee to its licensee is limited to the intellectual
0062  * property embodied in the software Licensee provides to its licensee, and
0063  * not to intellectual property embodied in modifications its licensee may
0064  * make.
0065  *
0066  * 3.3. Redistribution of Executable. Redistribution in executable form of any
0067  * substantial portion of the Covered Code or modification must reproduce the
0068  * above Copyright Notice, and the following Disclaimer and Export Compliance
0069  * provision in the documentation and/or other materials provided with the
0070  * distribution.
0071  *
0072  * 3.4. Intel retains all right, title, and interest in and to the Original
0073  * Intel Code.
0074  *
0075  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
0076  * Intel shall be used in advertising or otherwise to promote the sale, use or
0077  * other dealings in products derived from or relating to the Covered Code
0078  * without prior written authorization from Intel.
0079  *
0080  * 4. Disclaimer and Export Compliance
0081  *
0082  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
0083  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
0084  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
0085  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
0086  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
0087  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
0088  * PARTICULAR PURPOSE.
0089  *
0090  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
0091  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
0092  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
0093  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
0094  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
0095  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
0096  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
0097  * LIMITED REMEDY.
0098  *
0099  * 4.3. Licensee shall not export, either directly or indirectly, any of this
0100  * software or system incorporating such software without first obtaining any
0101  * required license or other approval from the U. S. Department of Commerce or
0102  * any other agency or department of the United States Government. In the
0103  * event Licensee exports any such software from the United States or
0104  * re-exports any such software from a foreign destination, Licensee shall
0105  * ensure that the distribution and export/re-export of the software is in
0106  * compliance with all laws, regulations, orders, or other restrictions of the
0107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
0108  * any of its subsidiaries will export/re-export any technical data, process,
0109  * software, or service, directly or indirectly, to any country for which the
0110  * United States government or any agency thereof requires an export license,
0111  * other governmental approval, or letter of assurance, without first obtaining
0112  * such license, approval or letter.
0113  *
0114  *****************************************************************************
0115  *
0116  * Alternatively, you may choose to be licensed under the terms of the
0117  * following license:
0118  *
0119  * Redistribution and use in source and binary forms, with or without
0120  * modification, are permitted provided that the following conditions
0121  * are met:
0122  * 1. Redistributions of source code must retain the above copyright
0123  *    notice, this list of conditions, and the following disclaimer,
0124  *    without modification.
0125  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
0126  *    substantially similar to the "NO WARRANTY" disclaimer below
0127  *    ("Disclaimer") and any redistribution must be conditioned upon
0128  *    including a substantially similar Disclaimer requirement for further
0129  *    binary redistribution.
0130  * 3. Neither the names of the above-listed copyright holders nor the names
0131  *    of any contributors may be used to endorse or promote products derived
0132  *    from this software without specific prior written permission.
0133  *
0134  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
0135  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
0136  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
0137  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
0138  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
0139  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
0140  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
0141  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
0142  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
0143  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
0144  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
0145  *
0146  * Alternatively, you may choose to be licensed under the terms of the
0147  * GNU General Public License ("GPL") version 2 as published by the Free
0148  * Software Foundation.
0149  *
0150  *****************************************************************************/
0151
0152 #include "acpi.h"
0153 #include "accommon.h"
0154 #include "acnamesp.h"
0155 #include "acinterp.h"
0156
0157
0158 #define _COMPONENT          ACPI_EXECUTER
0159         ACPI_MODULE_NAME    ("extrace")
0160
0161
0162 static ACPI_OPERAND_OBJECT  *AcpiGbl_TraceMethodObject = NULL;
0163
0164 /* Local prototypes */
0165
0166 #ifdef ACPI_DEBUG_OUTPUT
0167 static const char *
0168 AcpiExGetTraceEventName (
0169     ACPI_TRACE_EVENT_TYPE   Type);
0170 #endif
0171
0172
0173 /*******************************************************************************
0174  *
0175  * FUNCTION:    AcpiExInterpreterTraceEnabled
0176  *
0177  * PARAMETERS:  Name                - Whether method name should be matched,
0178  *                                    this should be checked before starting
0179  *                                    the tracer
0180  *
0181  * RETURN:      TRUE if interpreter trace is enabled.
0182  *
0183  * DESCRIPTION: Check whether interpreter trace is enabled
0184  *
0185  ******************************************************************************/
0186
0187 static BOOLEAN
0188 AcpiExInterpreterTraceEnabled (
0189     char                    *Name)
0190 {
0191
0192     /* Check if tracing is enabled */
0193
0194     if (!(AcpiGbl_TraceFlags & ACPI_TRACE_ENABLED))
0195     {
0196         return (FALSE);
0197     }
0198
0199     /*
0200      * Check if tracing is filtered:
0201      *
0202      * 1. If the tracer is started, AcpiGbl_TraceMethodObject should have
0203      *    been filled by the trace starter
0204      * 2. If the tracer is not started, AcpiGbl_TraceMethodName should be
0205      *    matched if it is specified
0206      * 3. If the tracer is oneshot style, AcpiGbl_TraceMethodName should
0207      *    not be cleared by the trace stopper during the first match
0208      */
0209     if (AcpiGbl_TraceMethodObject)
0210     {
0211         return (TRUE);
0212     }
0213
0214     if (Name &&
0215         (AcpiGbl_TraceMethodName &&
0216          strcmp (AcpiGbl_TraceMethodName, Name)))
0217     {
0218         return (FALSE);
0219     }
0220
0221     if ((AcpiGbl_TraceFlags & ACPI_TRACE_ONESHOT) &&
0222         !AcpiGbl_TraceMethodName)
0223     {
0224         return (FALSE);
0225     }
0226
0227     return (TRUE);
0228 }
0229
0230
0231 /*******************************************************************************
0232  *
0233  * FUNCTION:    AcpiExGetTraceEventName
0234  *
0235  * PARAMETERS:  Type            - Trace event type
0236  *
0237  * RETURN:      Trace event name.
0238  *
0239  * DESCRIPTION: Used to obtain the full trace event name.
0240  *
0241  ******************************************************************************/
0242
0243 #ifdef ACPI_DEBUG_OUTPUT
0244
0245 static const char *
0246 AcpiExGetTraceEventName (
0247     ACPI_TRACE_EVENT_TYPE   Type)
0248 {
0249
0250     switch (Type)
0251     {
0252     case ACPI_TRACE_AML_METHOD:
0253
0254         return "Method";
0255
0256     case ACPI_TRACE_AML_OPCODE:
0257
0258         return "Opcode";
0259
0260     case ACPI_TRACE_AML_REGION:
0261
0262         return "Region";
0263
0264     default:
0265
0266         return "";
0267     }
0268 }
0269
0270 #endif
0271
0272
0273 /*******************************************************************************
0274  *
0275  * FUNCTION:    AcpiExTracePoint
0276  *
0277  * PARAMETERS:  Type                - Trace event type
0278  *              Begin               - TRUE if before execution
0279  *              Aml                 - Executed AML address
0280  *              Pathname            - Object path
0281  *
0282  * RETURN:      None
0283  *
0284  * DESCRIPTION: Internal interpreter execution trace.
0285  *
0286  ******************************************************************************/
0287
0288 void
0289 AcpiExTracePoint (
0290     ACPI_TRACE_EVENT_TYPE   Type,
0291     BOOLEAN                 Begin,
0292     UINT8                   *Aml,
0293     char                    *Pathname)
0294 {
0295
0296     ACPI_FUNCTION_NAME (ExTracePoint);
0297
0298
0299     if (Pathname)
0300     {
0301         ACPI_DEBUG_PRINT ((ACPI_DB_TRACE_POINT,
0302             "%s %s [0x%p:%s] execution.\n",
0303             AcpiExGetTraceEventName (Type), Begin ? "Begin" : "End",
0304             Aml, Pathname));
0305     }
0306     else
0307     {
0308         ACPI_DEBUG_PRINT ((ACPI_DB_TRACE_POINT,
0309             "%s %s [0x%p] execution.\n",
0310             AcpiExGetTraceEventName (Type), Begin ? "Begin" : "End",
0311             Aml));
0312     }
0313 }
0314
0315
0316 /*******************************************************************************
0317  *
0318  * FUNCTION:    AcpiExStartTraceMethod
0319  *
0320  * PARAMETERS:  MethodNode          - Node of the method
0321  *              ObjDesc             - The method object
0322  *              WalkState           - current state, NULL if not yet executing
0323  *                                    a method.
0324  *
0325  * RETURN:      None
0326  *
0327  * DESCRIPTION: Start control method execution trace
0328  *
0329  ******************************************************************************/
0330
0331 void
0332 AcpiExStartTraceMethod (
0333     ACPI_NAMESPACE_NODE     *MethodNode,
0334     ACPI_OPERAND_OBJECT     *ObjDesc,
0335     ACPI_WALK_STATE         *WalkState)
0336 {
0337     char                    *Pathname = NULL;
0338     BOOLEAN                 Enabled = FALSE;
0339
0340
0341     ACPI_FUNCTION_NAME (ExStartTraceMethod);
0342
0343
0344     if (MethodNode)
0345     {
0346         Pathname = AcpiNsGetNormalizedPathname (MethodNode, TRUE);
0347     }
0348
0349     Enabled = AcpiExInterpreterTraceEnabled (Pathname);
0350     if (Enabled && !AcpiGbl_TraceMethodObject)
0351     {
0352         AcpiGbl_TraceMethodObject = ObjDesc;
0353         AcpiGbl_OriginalDbgLevel = AcpiDbgLevel;
0354         AcpiGbl_OriginalDbgLayer = AcpiDbgLayer;
0355         AcpiDbgLevel = ACPI_TRACE_LEVEL_ALL;
0356         AcpiDbgLayer = ACPI_TRACE_LAYER_ALL;
0357
0358         if (AcpiGbl_TraceDbgLevel)
0359         {
0360             AcpiDbgLevel = AcpiGbl_TraceDbgLevel;
0361         }
0362
0363         if (AcpiGbl_TraceDbgLayer)
0364         {
0365             AcpiDbgLayer = AcpiGbl_TraceDbgLayer;
0366         }
0367     }
0368
0369     if (Enabled)
0370     {
0371         ACPI_TRACE_POINT (ACPI_TRACE_AML_METHOD, TRUE,
0372             ObjDesc ? ObjDesc->Method.AmlStart : NULL, Pathname);
0373     }
0374
0375     if (Pathname)
0376     {
0377         ACPI_FREE (Pathname);
0378     }
0379 }
0380
0381
0382 /*******************************************************************************
0383  *
0384  * FUNCTION:    AcpiExStopTraceMethod
0385  *
0386  * PARAMETERS:  MethodNode          - Node of the method
0387  *              ObjDesc             - The method object
0388  *              WalkState           - current state, NULL if not yet executing
0389  *                                    a method.
0390  *
0391  * RETURN:      None
0392  *
0393  * DESCRIPTION: Stop control method execution trace
0394  *
0395  ******************************************************************************/
0396
0397 void
0398 AcpiExStopTraceMethod (
0399     ACPI_NAMESPACE_NODE     *MethodNode,
0400     ACPI_OPERAND_OBJECT     *ObjDesc,
0401     ACPI_WALK_STATE         *WalkState)
0402 {
0403     char                    *Pathname = NULL;
0404     BOOLEAN                 Enabled;
0405
0406
0407     ACPI_FUNCTION_NAME (ExStopTraceMethod);
0408
0409
0410     if (MethodNode)
0411     {
0412         Pathname = AcpiNsGetNormalizedPathname (MethodNode, TRUE);
0413     }
0414
0415     Enabled = AcpiExInterpreterTraceEnabled (NULL);
0416
0417     if (Enabled)
0418     {
0419         ACPI_TRACE_POINT (ACPI_TRACE_AML_METHOD, FALSE,
0420             ObjDesc ? ObjDesc->Method.AmlStart : NULL, Pathname);
0421     }
0422
0423     /* Check whether the tracer should be stopped */
0424
0425     if (AcpiGbl_TraceMethodObject == ObjDesc)
0426     {
0427         /* Disable further tracing if type is one-shot */
0428
0429         if (AcpiGbl_TraceFlags & ACPI_TRACE_ONESHOT)
0430         {
0431             AcpiGbl_TraceMethodName = NULL;
0432         }
0433
0434         AcpiDbgLevel = AcpiGbl_OriginalDbgLevel;
0435         AcpiDbgLayer = AcpiGbl_OriginalDbgLayer;
0436         AcpiGbl_TraceMethodObject = NULL;
0437     }
0438
0439     if (Pathname)
0440     {
0441         ACPI_FREE (Pathname);
0442     }
0443 }
0444
0445
0446 /*******************************************************************************
0447  *
0448  * FUNCTION:    AcpiExStartTraceOpcode
0449  *
0450  * PARAMETERS:  Op                  - The parser opcode object
0451  *              WalkState           - current state, NULL if not yet executing
0452  *                                    a method.
0453  *
0454  * RETURN:      None
0455  *
0456  * DESCRIPTION: Start opcode execution trace
0457  *
0458  ******************************************************************************/
0459
0460 void
0461 AcpiExStartTraceOpcode (
0462     ACPI_PARSE_OBJECT       *Op,
0463     ACPI_WALK_STATE         *WalkState)
0464 {
0465
0466     ACPI_FUNCTION_NAME (ExStartTraceOpcode);
0467
0468
0469     if (AcpiExInterpreterTraceEnabled (NULL) &&
0470         (AcpiGbl_TraceFlags & ACPI_TRACE_OPCODE))
0471     {
0472         ACPI_TRACE_POINT (ACPI_TRACE_AML_OPCODE, TRUE,
0473             Op->Common.Aml, Op->Common.AmlOpName);
0474     }
0475 }
0476
0477
0478 /*******************************************************************************
0479  *
0480  * FUNCTION:    AcpiExStopTraceOpcode
0481  *
0482  * PARAMETERS:  Op                  - The parser opcode object
0483  *              WalkState           - current state, NULL if not yet executing
0484  *                                    a method.
0485  *
0486  * RETURN:      None
0487  *
0488  * DESCRIPTION: Stop opcode execution trace
0489  *
0490  ******************************************************************************/
0491
0492 void
0493 AcpiExStopTraceOpcode (
0494     ACPI_PARSE_OBJECT       *Op,
0495     ACPI_WALK_STATE         *WalkState)
0496 {
0497
0498     ACPI_FUNCTION_NAME (ExStopTraceOpcode);
0499
0500
0501     if (AcpiExInterpreterTraceEnabled (NULL) &&
0502         (AcpiGbl_TraceFlags & ACPI_TRACE_OPCODE))
0503     {
0504         ACPI_TRACE_POINT (ACPI_TRACE_AML_OPCODE, FALSE,
0505             Op->Common.Aml, Op->Common.AmlOpName);
0506     }
0507 }