Back to home page

LXR

 
 

    


File indexing completed on 2025-05-11 08:24:02

0001 /******************************************************************************
0002  *
0003  * Module Name: dsdebug - Parser/Interpreter interface - debugging
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 "acdispat.h"
0155 #include "acnamesp.h"
0156 #include "acdisasm.h"
0157 #include "acinterp.h"
0158 
0159 
0160 #define _COMPONENT          ACPI_DISPATCHER
0161         ACPI_MODULE_NAME    ("dsdebug")
0162 
0163 
0164 #if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
0165 
0166 /* Local prototypes */
0167 
0168 static void
0169 AcpiDsPrintNodePathname (
0170     ACPI_NAMESPACE_NODE     *Node,
0171     const char              *Message);
0172 
0173 
0174 /*******************************************************************************
0175  *
0176  * FUNCTION:    AcpiDsPrintNodePathname
0177  *
0178  * PARAMETERS:  Node            - Object
0179  *              Message         - Prefix message
0180  *
0181  * DESCRIPTION: Print an object's full namespace pathname
0182  *              Manages allocation/freeing of a pathname buffer
0183  *
0184  ******************************************************************************/
0185 
0186 static void
0187 AcpiDsPrintNodePathname (
0188     ACPI_NAMESPACE_NODE     *Node,
0189     const char              *Message)
0190 {
0191     ACPI_BUFFER             Buffer;
0192     ACPI_STATUS             Status;
0193 
0194 
0195     ACPI_FUNCTION_TRACE (DsPrintNodePathname);
0196 
0197     if (!Node)
0198     {
0199         ACPI_DEBUG_PRINT_RAW ((ACPI_DB_DISPATCH, "[NULL NAME]"));
0200         return_VOID;
0201     }
0202 
0203     /* Convert handle to full pathname and print it (with supplied message) */
0204 
0205     Buffer.Length = ACPI_ALLOCATE_LOCAL_BUFFER;
0206 
0207     Status = AcpiNsHandleToPathname (Node, &Buffer, TRUE);
0208     if (ACPI_SUCCESS (Status))
0209     {
0210         if (Message)
0211         {
0212             ACPI_DEBUG_PRINT_RAW ((ACPI_DB_DISPATCH, "%s ", Message));
0213         }
0214 
0215         ACPI_DEBUG_PRINT_RAW ((ACPI_DB_DISPATCH, "[%s] (Node %p)",
0216             (char *) Buffer.Pointer, Node));
0217         ACPI_FREE (Buffer.Pointer);
0218     }
0219 
0220     return_VOID;
0221 }
0222 
0223 
0224 /*******************************************************************************
0225  *
0226  * FUNCTION:    AcpiDsDumpMethodStack
0227  *
0228  * PARAMETERS:  Status          - Method execution status
0229  *              WalkState       - Current state of the parse tree walk
0230  *              Op              - Executing parse op
0231  *
0232  * RETURN:      None
0233  *
0234  * DESCRIPTION: Called when a method has been aborted because of an error.
0235  *              Dumps the method execution stack.
0236  *
0237  ******************************************************************************/
0238 
0239 void
0240 AcpiDsDumpMethodStack (
0241     ACPI_STATUS             Status,
0242     ACPI_WALK_STATE         *WalkState,
0243     ACPI_PARSE_OBJECT       *Op)
0244 {
0245     ACPI_PARSE_OBJECT       *Next;
0246     ACPI_THREAD_STATE       *Thread;
0247     ACPI_WALK_STATE         *NextWalkState;
0248     ACPI_NAMESPACE_NODE     *PreviousMethod = NULL;
0249     ACPI_OPERAND_OBJECT     *MethodDesc;
0250 
0251 
0252     ACPI_FUNCTION_TRACE (DsDumpMethodStack);
0253 
0254 
0255     /* Ignore control codes, they are not errors */
0256 
0257     if (ACPI_CNTL_EXCEPTION (Status))
0258     {
0259         return_VOID;
0260     }
0261 
0262     /* We may be executing a deferred opcode */
0263 
0264     if (WalkState->DeferredNode)
0265     {
0266         ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH,
0267             "Executing subtree for Buffer/Package/Region\n"));
0268         return_VOID;
0269     }
0270 
0271     /*
0272      * If there is no Thread, we are not actually executing a method.
0273      * This can happen when the iASL compiler calls the interpreter
0274      * to perform constant folding.
0275      */
0276     Thread = WalkState->Thread;
0277     if (!Thread)
0278     {
0279         return_VOID;
0280     }
0281 
0282     /* Display exception and method name */
0283 
0284     ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH,
0285         "\n**** Exception %s during execution of method ",
0286         AcpiFormatException (Status)));
0287 
0288     AcpiDsPrintNodePathname (WalkState->MethodNode, NULL);
0289 
0290     /* Display stack of executing methods */
0291 
0292     ACPI_DEBUG_PRINT_RAW ((ACPI_DB_DISPATCH,
0293         "\n\nMethod Execution Stack:\n"));
0294     NextWalkState = Thread->WalkStateList;
0295 
0296     /* Walk list of linked walk states */
0297 
0298     while (NextWalkState)
0299     {
0300         MethodDesc = NextWalkState->MethodDesc;
0301         if (MethodDesc)
0302         {
0303             AcpiExStopTraceMethod (
0304                 (ACPI_NAMESPACE_NODE *) MethodDesc->Method.Node,
0305                 MethodDesc, WalkState);
0306         }
0307 
0308         ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH,
0309             "    Method [%4.4s] executing: ",
0310             AcpiUtGetNodeName (NextWalkState->MethodNode)));
0311 
0312         /* First method is the currently executing method */
0313 
0314         if (NextWalkState == WalkState)
0315         {
0316             if (Op)
0317             {
0318                 /* Display currently executing ASL statement */
0319 
0320                 Next = Op->Common.Next;
0321                 Op->Common.Next = NULL;
0322 
0323 #ifdef ACPI_DISASSEMBLER
0324                 if (WalkState->MethodNode != AcpiGbl_RootNode)
0325                 {
0326                     /* More verbose if not module-level code */
0327 
0328                     AcpiOsPrintf ("Failed at ");
0329                     AcpiDmDisassemble (NextWalkState, Op, ACPI_UINT32_MAX);
0330                 }
0331 #endif
0332                 Op->Common.Next = Next;
0333             }
0334         }
0335         else
0336         {
0337             /*
0338              * This method has called another method
0339              * NOTE: the method call parse subtree is already deleted at
0340              * this point, so we cannot disassemble the method invocation.
0341              */
0342             ACPI_DEBUG_PRINT_RAW ((ACPI_DB_DISPATCH, "Call to method "));
0343             AcpiDsPrintNodePathname (PreviousMethod, NULL);
0344         }
0345 
0346         PreviousMethod = NextWalkState->MethodNode;
0347         NextWalkState = NextWalkState->Next;
0348         ACPI_DEBUG_PRINT_RAW ((ACPI_DB_DISPATCH, "\n"));
0349     }
0350 
0351     return_VOID;
0352 }
0353 
0354 #else
0355 
0356 void
0357 AcpiDsDumpMethodStack (
0358     ACPI_STATUS             Status,
0359     ACPI_WALK_STATE         *WalkState,
0360     ACPI_PARSE_OBJECT       *Op)
0361 {
0362     return;
0363 }
0364 
0365 #endif