1 /****************************************************************************** 2 * 3 * Module Name: dsdebug - Parser/Interpreter interface - debugging 4 * 5 *****************************************************************************/ 6 7 /****************************************************************************** 8 * 9 * 1. Copyright Notice 10 * 11 * Some or all of this work - Copyright (c) 1999 - 2023, 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/acdispat.h> 155 #include <contrib/dev/acpica/include/acnamesp.h> 156 #include <contrib/dev/acpica/include/acdisasm.h> 157 #include <contrib/dev/acpica/include/acinterp.h> 158 159 160 #define _COMPONENT ACPI_DISPATCHER 161 ACPI_MODULE_NAME ("dsdebug") 162 163 164 #if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER) 165 166 /* Local prototypes */ 167 168 static void 169 AcpiDsPrintNodePathname ( 170 ACPI_NAMESPACE_NODE *Node, 171 const char *Message); 172 173 174 /******************************************************************************* 175 * 176 * FUNCTION: AcpiDsPrintNodePathname 177 * 178 * PARAMETERS: Node - Object 179 * Message - Prefix message 180 * 181 * DESCRIPTION: Print an object's full namespace pathname 182 * Manages allocation/freeing of a pathname buffer 183 * 184 ******************************************************************************/ 185 186 static void 187 AcpiDsPrintNodePathname ( 188 ACPI_NAMESPACE_NODE *Node, 189 const char *Message) 190 { 191 ACPI_BUFFER Buffer; 192 ACPI_STATUS Status; 193 194 195 ACPI_FUNCTION_TRACE (DsPrintNodePathname); 196 197 if (!Node) 198 { 199 ACPI_DEBUG_PRINT_RAW ((ACPI_DB_DISPATCH, "[NULL NAME]")); 200 return_VOID; 201 } 202 203 /* Convert handle to full pathname and print it (with supplied message) */ 204 205 Buffer.Length = ACPI_ALLOCATE_LOCAL_BUFFER; 206 207 Status = AcpiNsHandleToPathname (Node, &Buffer, TRUE); 208 if (ACPI_SUCCESS (Status)) 209 { 210 if (Message) 211 { 212 ACPI_DEBUG_PRINT_RAW ((ACPI_DB_DISPATCH, "%s ", Message)); 213 } 214 215 ACPI_DEBUG_PRINT_RAW ((ACPI_DB_DISPATCH, "[%s] (Node %p)", 216 (char *) Buffer.Pointer, Node)); 217 ACPI_FREE (Buffer.Pointer); 218 } 219 220 return_VOID; 221 } 222 223 224 /******************************************************************************* 225 * 226 * FUNCTION: AcpiDsDumpMethodStack 227 * 228 * PARAMETERS: Status - Method execution status 229 * WalkState - Current state of the parse tree walk 230 * Op - Executing parse op 231 * 232 * RETURN: None 233 * 234 * DESCRIPTION: Called when a method has been aborted because of an error. 235 * Dumps the method execution stack. 236 * 237 ******************************************************************************/ 238 239 void 240 AcpiDsDumpMethodStack ( 241 ACPI_STATUS Status, 242 ACPI_WALK_STATE *WalkState, 243 ACPI_PARSE_OBJECT *Op) 244 { 245 ACPI_PARSE_OBJECT *Next; 246 ACPI_THREAD_STATE *Thread; 247 ACPI_WALK_STATE *NextWalkState; 248 ACPI_NAMESPACE_NODE *PreviousMethod = NULL; 249 ACPI_OPERAND_OBJECT *MethodDesc; 250 251 252 ACPI_FUNCTION_TRACE (DsDumpMethodStack); 253 254 255 /* Ignore control codes, they are not errors */ 256 257 if (ACPI_CNTL_EXCEPTION (Status)) 258 { 259 return_VOID; 260 } 261 262 /* We may be executing a deferred opcode */ 263 264 if (WalkState->DeferredNode) 265 { 266 ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH, 267 "Executing subtree for Buffer/Package/Region\n")); 268 return_VOID; 269 } 270 271 /* 272 * If there is no Thread, we are not actually executing a method. 273 * This can happen when the iASL compiler calls the interpreter 274 * to perform constant folding. 275 */ 276 Thread = WalkState->Thread; 277 if (!Thread) 278 { 279 return_VOID; 280 } 281 282 /* Display exception and method name */ 283 284 ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH, 285 "\n**** Exception %s during execution of method ", 286 AcpiFormatException (Status))); 287 288 AcpiDsPrintNodePathname (WalkState->MethodNode, NULL); 289 290 /* Display stack of executing methods */ 291 292 ACPI_DEBUG_PRINT_RAW ((ACPI_DB_DISPATCH, 293 "\n\nMethod Execution Stack:\n")); 294 NextWalkState = Thread->WalkStateList; 295 296 /* Walk list of linked walk states */ 297 298 while (NextWalkState) 299 { 300 MethodDesc = NextWalkState->MethodDesc; 301 if (MethodDesc) 302 { 303 AcpiExStopTraceMethod ( 304 (ACPI_NAMESPACE_NODE *) MethodDesc->Method.Node, 305 MethodDesc, WalkState); 306 } 307 308 ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH, 309 " Method [%4.4s] executing: ", 310 AcpiUtGetNodeName (NextWalkState->MethodNode))); 311 312 /* First method is the currently executing method */ 313 314 if (NextWalkState == WalkState) 315 { 316 if (Op) 317 { 318 /* Display currently executing ASL statement */ 319 320 Next = Op->Common.Next; 321 Op->Common.Next = NULL; 322 323 #ifdef ACPI_DISASSEMBLER 324 if (WalkState->MethodNode != AcpiGbl_RootNode) 325 { 326 /* More verbose if not module-level code */ 327 328 AcpiOsPrintf ("Failed at "); 329 AcpiDmDisassemble (NextWalkState, Op, ACPI_UINT32_MAX); 330 } 331 #endif 332 Op->Common.Next = Next; 333 } 334 } 335 else 336 { 337 /* 338 * This method has called another method 339 * NOTE: the method call parse subtree is already deleted at 340 * this point, so we cannot disassemble the method invocation. 341 */ 342 ACPI_DEBUG_PRINT_RAW ((ACPI_DB_DISPATCH, "Call to method ")); 343 AcpiDsPrintNodePathname (PreviousMethod, NULL); 344 } 345 346 PreviousMethod = NextWalkState->MethodNode; 347 NextWalkState = NextWalkState->Next; 348 ACPI_DEBUG_PRINT_RAW ((ACPI_DB_DISPATCH, "\n")); 349 } 350 351 return_VOID; 352 } 353 354 #else 355 356 void 357 AcpiDsDumpMethodStack ( 358 ACPI_STATUS Status, 359 ACPI_WALK_STATE *WalkState, 360 ACPI_PARSE_OBJECT *Op) 361 { 362 return; 363 } 364 365 #endif 366