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 - 2016, 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 #include "acpi.h" 117 #include "accommon.h" 118 #include "acnamesp.h" 119 #include "acinterp.h" 120 121 122 #define _COMPONENT ACPI_EXECUTER 123 ACPI_MODULE_NAME ("extrace") 124 125 126 static ACPI_OPERAND_OBJECT *AcpiGbl_TraceMethodObject = NULL; 127 128 /* Local prototypes */ 129 130 #ifdef ACPI_DEBUG_OUTPUT 131 static const char * 132 AcpiExGetTraceEventName ( 133 ACPI_TRACE_EVENT_TYPE Type); 134 #endif 135 136 137 /******************************************************************************* 138 * 139 * FUNCTION: AcpiExInterpreterTraceEnabled 140 * 141 * PARAMETERS: Name - Whether method name should be matched, 142 * this should be checked before starting 143 * the tracer 144 * 145 * RETURN: TRUE if interpreter trace is enabled. 146 * 147 * DESCRIPTION: Check whether interpreter trace is enabled 148 * 149 ******************************************************************************/ 150 151 static BOOLEAN 152 AcpiExInterpreterTraceEnabled ( 153 char *Name) 154 { 155 156 /* Check if tracing is enabled */ 157 158 if (!(AcpiGbl_TraceFlags & ACPI_TRACE_ENABLED)) 159 { 160 return (FALSE); 161 } 162 163 /* 164 * Check if tracing is filtered: 165 * 166 * 1. If the tracer is started, AcpiGbl_TraceMethodObject should have 167 * been filled by the trace starter 168 * 2. If the tracer is not started, AcpiGbl_TraceMethodName should be 169 * matched if it is specified 170 * 3. If the tracer is oneshot style, AcpiGbl_TraceMethodName should 171 * not be cleared by the trace stopper during the first match 172 */ 173 if (AcpiGbl_TraceMethodObject) 174 { 175 return (TRUE); 176 } 177 178 if (Name && 179 (AcpiGbl_TraceMethodName && 180 strcmp (AcpiGbl_TraceMethodName, Name))) 181 { 182 return (FALSE); 183 } 184 185 if ((AcpiGbl_TraceFlags & ACPI_TRACE_ONESHOT) && 186 !AcpiGbl_TraceMethodName) 187 { 188 return (FALSE); 189 } 190 191 return (TRUE); 192 } 193 194 195 /******************************************************************************* 196 * 197 * FUNCTION: AcpiExGetTraceEventName 198 * 199 * PARAMETERS: Type - Trace event type 200 * 201 * RETURN: Trace event name. 202 * 203 * DESCRIPTION: Used to obtain the full trace event name. 204 * 205 ******************************************************************************/ 206 207 #ifdef ACPI_DEBUG_OUTPUT 208 209 static const char * 210 AcpiExGetTraceEventName ( 211 ACPI_TRACE_EVENT_TYPE Type) 212 { 213 214 switch (Type) 215 { 216 case ACPI_TRACE_AML_METHOD: 217 218 return "Method"; 219 220 case ACPI_TRACE_AML_OPCODE: 221 222 return "Opcode"; 223 224 case ACPI_TRACE_AML_REGION: 225 226 return "Region"; 227 228 default: 229 230 return ""; 231 } 232 } 233 234 #endif 235 236 237 /******************************************************************************* 238 * 239 * FUNCTION: AcpiExTracePoint 240 * 241 * PARAMETERS: Type - Trace event type 242 * Begin - TRUE if before execution 243 * Aml - Executed AML address 244 * Pathname - Object path 245 * 246 * RETURN: None 247 * 248 * DESCRIPTION: Internal interpreter execution trace. 249 * 250 ******************************************************************************/ 251 252 void 253 AcpiExTracePoint ( 254 ACPI_TRACE_EVENT_TYPE Type, 255 BOOLEAN Begin, 256 UINT8 *Aml, 257 char *Pathname) 258 { 259 260 ACPI_FUNCTION_NAME (ExTracePoint); 261 262 263 if (Pathname) 264 { 265 ACPI_DEBUG_PRINT ((ACPI_DB_TRACE_POINT, 266 "%s %s [0x%p:%s] execution.\n", 267 AcpiExGetTraceEventName (Type), Begin ? "Begin" : "End", 268 Aml, Pathname)); 269 } 270 else 271 { 272 ACPI_DEBUG_PRINT ((ACPI_DB_TRACE_POINT, 273 "%s %s [0x%p] execution.\n", 274 AcpiExGetTraceEventName (Type), Begin ? "Begin" : "End", 275 Aml)); 276 } 277 } 278 279 280 /******************************************************************************* 281 * 282 * FUNCTION: AcpiExStartTraceMethod 283 * 284 * PARAMETERS: MethodNode - Node of the method 285 * ObjDesc - The method object 286 * WalkState - current state, NULL if not yet executing 287 * a method. 288 * 289 * RETURN: None 290 * 291 * DESCRIPTION: Start control method execution trace 292 * 293 ******************************************************************************/ 294 295 void 296 AcpiExStartTraceMethod ( 297 ACPI_NAMESPACE_NODE *MethodNode, 298 ACPI_OPERAND_OBJECT *ObjDesc, 299 ACPI_WALK_STATE *WalkState) 300 { 301 ACPI_STATUS Status; 302 char *Pathname = NULL; 303 BOOLEAN Enabled = FALSE; 304 305 306 ACPI_FUNCTION_NAME (ExStartTraceMethod); 307 308 309 if (MethodNode) 310 { 311 Pathname = AcpiNsGetNormalizedPathname (MethodNode, TRUE); 312 } 313 314 Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE); 315 if (ACPI_FAILURE (Status)) 316 { 317 goto Exit; 318 } 319 320 Enabled = AcpiExInterpreterTraceEnabled (Pathname); 321 if (Enabled && !AcpiGbl_TraceMethodObject) 322 { 323 AcpiGbl_TraceMethodObject = ObjDesc; 324 AcpiGbl_OriginalDbgLevel = AcpiDbgLevel; 325 AcpiGbl_OriginalDbgLayer = AcpiDbgLayer; 326 AcpiDbgLevel = ACPI_TRACE_LEVEL_ALL; 327 AcpiDbgLayer = ACPI_TRACE_LAYER_ALL; 328 329 if (AcpiGbl_TraceDbgLevel) 330 { 331 AcpiDbgLevel = AcpiGbl_TraceDbgLevel; 332 } 333 334 if (AcpiGbl_TraceDbgLayer) 335 { 336 AcpiDbgLayer = AcpiGbl_TraceDbgLayer; 337 } 338 } 339 340 (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE); 341 342 Exit: 343 if (Enabled) 344 { 345 ACPI_TRACE_POINT (ACPI_TRACE_AML_METHOD, TRUE, 346 ObjDesc ? ObjDesc->Method.AmlStart : NULL, Pathname); 347 } 348 349 if (Pathname) 350 { 351 ACPI_FREE (Pathname); 352 } 353 } 354 355 356 /******************************************************************************* 357 * 358 * FUNCTION: AcpiExStopTraceMethod 359 * 360 * PARAMETERS: MethodNode - Node of the method 361 * ObjDesc - The method object 362 * WalkState - current state, NULL if not yet executing 363 * a method. 364 * 365 * RETURN: None 366 * 367 * DESCRIPTION: Stop control method execution trace 368 * 369 ******************************************************************************/ 370 371 void 372 AcpiExStopTraceMethod ( 373 ACPI_NAMESPACE_NODE *MethodNode, 374 ACPI_OPERAND_OBJECT *ObjDesc, 375 ACPI_WALK_STATE *WalkState) 376 { 377 ACPI_STATUS Status; 378 char *Pathname = NULL; 379 BOOLEAN Enabled; 380 381 382 ACPI_FUNCTION_NAME (ExStopTraceMethod); 383 384 385 if (MethodNode) 386 { 387 Pathname = AcpiNsGetNormalizedPathname (MethodNode, TRUE); 388 } 389 390 Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE); 391 if (ACPI_FAILURE (Status)) 392 { 393 goto ExitPath; 394 } 395 396 Enabled = AcpiExInterpreterTraceEnabled (NULL); 397 398 (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE); 399 400 if (Enabled) 401 { 402 ACPI_TRACE_POINT (ACPI_TRACE_AML_METHOD, FALSE, 403 ObjDesc ? ObjDesc->Method.AmlStart : NULL, Pathname); 404 } 405 406 Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE); 407 if (ACPI_FAILURE (Status)) 408 { 409 goto ExitPath; 410 } 411 412 /* Check whether the tracer should be stopped */ 413 414 if (AcpiGbl_TraceMethodObject == ObjDesc) 415 { 416 /* Disable further tracing if type is one-shot */ 417 418 if (AcpiGbl_TraceFlags & ACPI_TRACE_ONESHOT) 419 { 420 AcpiGbl_TraceMethodName = NULL; 421 } 422 423 AcpiDbgLevel = AcpiGbl_OriginalDbgLevel; 424 AcpiDbgLayer = AcpiGbl_OriginalDbgLayer; 425 AcpiGbl_TraceMethodObject = NULL; 426 } 427 428 (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE); 429 430 ExitPath: 431 if (Pathname) 432 { 433 ACPI_FREE (Pathname); 434 } 435 } 436 437 438 /******************************************************************************* 439 * 440 * FUNCTION: AcpiExStartTraceOpcode 441 * 442 * PARAMETERS: Op - The parser opcode object 443 * WalkState - current state, NULL if not yet executing 444 * a method. 445 * 446 * RETURN: None 447 * 448 * DESCRIPTION: Start opcode execution trace 449 * 450 ******************************************************************************/ 451 452 void 453 AcpiExStartTraceOpcode ( 454 ACPI_PARSE_OBJECT *Op, 455 ACPI_WALK_STATE *WalkState) 456 { 457 458 ACPI_FUNCTION_NAME (ExStartTraceOpcode); 459 460 461 if (AcpiExInterpreterTraceEnabled (NULL) && 462 (AcpiGbl_TraceFlags & ACPI_TRACE_OPCODE)) 463 { 464 ACPI_TRACE_POINT (ACPI_TRACE_AML_OPCODE, TRUE, 465 Op->Common.Aml, Op->Common.AmlOpName); 466 } 467 } 468 469 470 /******************************************************************************* 471 * 472 * FUNCTION: AcpiExStopTraceOpcode 473 * 474 * PARAMETERS: Op - The parser opcode object 475 * WalkState - current state, NULL if not yet executing 476 * a method. 477 * 478 * RETURN: None 479 * 480 * DESCRIPTION: Stop opcode execution trace 481 * 482 ******************************************************************************/ 483 484 void 485 AcpiExStopTraceOpcode ( 486 ACPI_PARSE_OBJECT *Op, 487 ACPI_WALK_STATE *WalkState) 488 { 489 490 ACPI_FUNCTION_NAME (ExStopTraceOpcode); 491 492 493 if (AcpiExInterpreterTraceEnabled (NULL) && 494 (AcpiGbl_TraceFlags & ACPI_TRACE_OPCODE)) 495 { 496 ACPI_TRACE_POINT (ACPI_TRACE_AML_OPCODE, FALSE, 497 Op->Common.Aml, Op->Common.AmlOpName); 498 } 499 } 500