drivers/acpi/components/debugger/dbxface.c

   1 /*******************************************************************************
   2  *
   3  * Module Name: dbxface - AML Debugger external interfaces
   4  *
   5  ******************************************************************************/
   6
   7 /******************************************************************************
   8  *
   9  * 1. Copyright Notice
  10  *
  11  * Some or all of this work - Copyright (c) 1999 - 2015, 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 "amlcode.h"
 119 #include "acdebug.h"
 120 #include "acdisasm.h"
 121
 122
 123 #ifdef ACPI_DEBUGGER
 124
 125 #define _COMPONENT          ACPI_CA_DEBUGGER
 126         ACPI_MODULE_NAME    ("dbxface")
 127
 128
 129 /* Local prototypes */
 130
 131 static ACPI_STATUS
 132 AcpiDbStartCommand (
 133     ACPI_WALK_STATE         *WalkState,
 134     ACPI_PARSE_OBJECT       *Op);
 135
 136 #ifdef ACPI_OBSOLETE_FUNCTIONS
 137 void
 138 AcpiDbMethodEnd (
 139     ACPI_WALK_STATE         *WalkState);
 140 #endif
 141
 142
 143 /*******************************************************************************
 144  *
 145  * FUNCTION:    AcpiDbStartCommand
 146  *
 147  * PARAMETERS:  WalkState       - Current walk
 148  *              Op              - Current executing Op, from AML interpreter
 149  *
 150  * RETURN:      Status
 151  *
 152  * DESCRIPTION: Enter debugger command loop
 153  *
 154  ******************************************************************************/
 155
 156 static ACPI_STATUS
 157 AcpiDbStartCommand (
 158     ACPI_WALK_STATE         *WalkState,
 159     ACPI_PARSE_OBJECT       *Op)
 160 {
 161     ACPI_STATUS             Status;
 162
 163
 164     /* TBD: [Investigate] are there namespace locking issues here? */
 165
 166     /* AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE); */
 167
 168     /* Go into the command loop and await next user command */
 169
 170
 171     AcpiGbl_MethodExecuting = TRUE;
 172     Status = AE_CTRL_TRUE;
 173     while (Status == AE_CTRL_TRUE)
 174     {
 175         if (AcpiGbl_DebuggerConfiguration == DEBUGGER_MULTI_THREADED)
 176         {
 177             /* Handshake with the front-end that gets user command lines */
 178
 179             Status = AcpiUtReleaseMutex (ACPI_MTX_DEBUG_CMD_COMPLETE);
 180             if (ACPI_FAILURE (Status))
 181             {
 182                 return (Status);
 183             }
 184             Status = AcpiUtAcquireMutex (ACPI_MTX_DEBUG_CMD_READY);
 185             if (ACPI_FAILURE (Status))
 186             {
 187                 return (Status);
 188             }
 189         }
 190         else
 191         {
 192             /* Single threaded, we must get a command line ourselves */
 193
 194             /* Force output to console until a command is entered */
 195
 196             AcpiDbSetOutputDestination (ACPI_DB_CONSOLE_OUTPUT);
 197
 198             /* Different prompt if method is executing */
 199
 200             if (!AcpiGbl_MethodExecuting)
 201             {
 202                 AcpiOsPrintf ("%1c ", ACPI_DEBUGGER_COMMAND_PROMPT);
 203             }
 204             else
 205             {
 206                 AcpiOsPrintf ("%1c ", ACPI_DEBUGGER_EXECUTE_PROMPT);
 207             }
 208
 209             /* Get the user input line */
 210
 211             Status = AcpiOsGetLine (AcpiGbl_DbLineBuf,
 212                 ACPI_DB_LINE_BUFFER_SIZE, NULL);
 213             if (ACPI_FAILURE (Status))
 214             {
 215                 ACPI_EXCEPTION ((AE_INFO, Status, "While parsing command line"));
 216                 return (Status);
 217             }
 218         }
 219
 220         Status = AcpiDbCommandDispatch (AcpiGbl_DbLineBuf, WalkState, Op);
 221     }
 222
 223     /* AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE); */
 224
 225     return (Status);
 226 }
 227
 228
 229 /*******************************************************************************
 230  *
 231  * FUNCTION:    AcpiDbSingleStep
 232  *
 233  * PARAMETERS:  WalkState       - Current walk
 234  *              Op              - Current executing op (from aml interpreter)
 235  *              OpcodeClass     - Class of the current AML Opcode
 236  *
 237  * RETURN:      Status
 238  *
 239  * DESCRIPTION: Called just before execution of an AML opcode.
 240  *
 241  ******************************************************************************/
 242
 243 ACPI_STATUS
 244 AcpiDbSingleStep (
 245     ACPI_WALK_STATE         *WalkState,
 246     ACPI_PARSE_OBJECT       *Op,
 247     UINT32                  OpcodeClass)
 248 {
 249     ACPI_PARSE_OBJECT       *Next;
 250     ACPI_STATUS             Status = AE_OK;
 251     UINT32                  OriginalDebugLevel;
 252     ACPI_PARSE_OBJECT       *DisplayOp;
 253     ACPI_PARSE_OBJECT       *ParentOp;
 254
 255
 256     ACPI_FUNCTION_ENTRY ();
 257
 258
 259     /* Check the abort flag */
 260
 261     if (AcpiGbl_AbortMethod)
 262     {
 263         AcpiGbl_AbortMethod = FALSE;
 264         return (AE_ABORT_METHOD);
 265     }
 266
 267     /* Check for single-step breakpoint */
 268
 269     if (WalkState->MethodBreakpoint &&
 270        (WalkState->MethodBreakpoint <= Op->Common.AmlOffset))
 271     {
 272         /* Check if the breakpoint has been reached or passed */
 273         /* Hit the breakpoint, resume single step, reset breakpoint */
 274
 275         AcpiOsPrintf ("***Break*** at AML offset %X\n", Op->Common.AmlOffset);
 276         AcpiGbl_CmSingleStep = TRUE;
 277         AcpiGbl_StepToNextCall = FALSE;
 278         WalkState->MethodBreakpoint = 0;
 279     }
 280
 281     /* Check for user breakpoint (Must be on exact Aml offset) */
 282
 283     else if (WalkState->UserBreakpoint &&
 284             (WalkState->UserBreakpoint == Op->Common.AmlOffset))
 285     {
 286         AcpiOsPrintf ("***UserBreakpoint*** at AML offset %X\n",
 287             Op->Common.AmlOffset);
 288         AcpiGbl_CmSingleStep = TRUE;
 289         AcpiGbl_StepToNextCall = FALSE;
 290         WalkState->MethodBreakpoint = 0;
 291     }
 292
 293     /*
 294      * Check if this is an opcode that we are interested in --
 295      * namely, opcodes that have arguments
 296      */
 297     if (Op->Common.AmlOpcode == AML_INT_NAMEDFIELD_OP)
 298     {
 299         return (AE_OK);
 300     }
 301
 302     switch (OpcodeClass)
 303     {
 304     case AML_CLASS_UNKNOWN:
 305     case AML_CLASS_ARGUMENT:    /* constants, literals, etc. do nothing */
 306
 307         return (AE_OK);
 308
 309     default:
 310
 311         /* All other opcodes -- continue */
 312         break;
 313     }
 314
 315     /*
 316      * Under certain debug conditions, display this opcode and its operands
 317      */
 318     if ((AcpiGbl_DbOutputToFile)            ||
 319         (AcpiGbl_CmSingleStep)              ||
 320         (AcpiDbgLevel & ACPI_LV_PARSE))
 321     {
 322         if ((AcpiGbl_DbOutputToFile)        ||
 323             (AcpiDbgLevel & ACPI_LV_PARSE))
 324         {
 325             AcpiOsPrintf ("\n[AmlDebug] Next AML Opcode to execute:\n");
 326         }
 327
 328         /*
 329          * Display this op (and only this op - zero out the NEXT field
 330          * temporarily, and disable parser trace output for the duration of
 331          * the display because we don't want the extraneous debug output)
 332          */
 333         OriginalDebugLevel = AcpiDbgLevel;
 334         AcpiDbgLevel &= ~(ACPI_LV_PARSE | ACPI_LV_FUNCTIONS);
 335         Next = Op->Common.Next;
 336         Op->Common.Next = NULL;
 337
 338
 339         DisplayOp = Op;
 340         ParentOp = Op->Common.Parent;
 341         if (ParentOp)
 342         {
 343             if ((WalkState->ControlState) &&
 344                 (WalkState->ControlState->Common.State ==
 345                     ACPI_CONTROL_PREDICATE_EXECUTING))
 346             {
 347                 /*
 348                  * We are executing the predicate of an IF or WHILE statement
 349                  * Search upwards for the containing IF or WHILE so that the
 350                  * entire predicate can be displayed.
 351                  */
 352                 while (ParentOp)
 353                 {
 354                     if ((ParentOp->Common.AmlOpcode == AML_IF_OP) ||
 355                         (ParentOp->Common.AmlOpcode == AML_WHILE_OP))
 356                     {
 357                         DisplayOp = ParentOp;
 358                         break;
 359                     }
 360                     ParentOp = ParentOp->Common.Parent;
 361                 }
 362             }
 363             else
 364             {
 365                 while (ParentOp)
 366                 {
 367                     if ((ParentOp->Common.AmlOpcode == AML_IF_OP)     ||
 368                         (ParentOp->Common.AmlOpcode == AML_ELSE_OP)   ||
 369                         (ParentOp->Common.AmlOpcode == AML_SCOPE_OP)  ||
 370                         (ParentOp->Common.AmlOpcode == AML_METHOD_OP) ||
 371                         (ParentOp->Common.AmlOpcode == AML_WHILE_OP))
 372                     {
 373                         break;
 374                     }
 375                     DisplayOp = ParentOp;
 376                     ParentOp = ParentOp->Common.Parent;
 377                 }
 378             }
 379         }
 380
 381         /* Now we can display it */
 382
 383         AcpiDmDisassemble (WalkState, DisplayOp, ACPI_UINT32_MAX);
 384
 385         if ((Op->Common.AmlOpcode == AML_IF_OP) ||
 386             (Op->Common.AmlOpcode == AML_WHILE_OP))
 387         {
 388             if (WalkState->ControlState->Common.Value)
 389             {
 390                 AcpiOsPrintf ("Predicate = [True], IF block was executed\n");
 391             }
 392             else
 393             {
 394                 AcpiOsPrintf ("Predicate = [False], Skipping IF block\n");
 395             }
 396         }
 397         else if (Op->Common.AmlOpcode == AML_ELSE_OP)
 398         {
 399             AcpiOsPrintf ("Predicate = [False], ELSE block was executed\n");
 400         }
 401
 402         /* Restore everything */
 403
 404         Op->Common.Next = Next;
 405         AcpiOsPrintf ("\n");
 406         if ((AcpiGbl_DbOutputToFile)        ||
 407             (AcpiDbgLevel & ACPI_LV_PARSE))
 408         {
 409             AcpiOsPrintf ("\n");
 410         }
 411         AcpiDbgLevel = OriginalDebugLevel;
 412     }
 413
 414     /* If we are not single stepping, just continue executing the method */
 415
 416     if (!AcpiGbl_CmSingleStep)
 417     {
 418         return (AE_OK);
 419     }
 420
 421     /*
 422      * If we are executing a step-to-call command,
 423      * Check if this is a method call.
 424      */
 425     if (AcpiGbl_StepToNextCall)
 426     {
 427         if (Op->Common.AmlOpcode != AML_INT_METHODCALL_OP)
 428         {
 429             /* Not a method call, just keep executing */
 430
 431             return (AE_OK);
 432         }
 433
 434         /* Found a method call, stop executing */
 435
 436         AcpiGbl_StepToNextCall = FALSE;
 437     }
 438
 439     /*
 440      * If the next opcode is a method call, we will "step over" it
 441      * by default.
 442      */
 443     if (Op->Common.AmlOpcode == AML_INT_METHODCALL_OP)
 444     {
 445         /* Force no more single stepping while executing called method */
 446
 447         AcpiGbl_CmSingleStep = FALSE;
 448
 449         /*
 450          * Set the breakpoint on/before the call, it will stop execution
 451          * as soon as we return
 452          */
 453         WalkState->MethodBreakpoint = 1;  /* Must be non-zero! */
 454     }
 455
 456
 457     Status = AcpiDbStartCommand (WalkState, Op);
 458
 459     /* User commands complete, continue execution of the interrupted method */
 460
 461     return (Status);
 462 }
 463
 464
 465 /*******************************************************************************
 466  *
 467  * FUNCTION:    AcpiDbInitialize
 468  *
 469  * PARAMETERS:  None
 470  *
 471  * RETURN:      Status
 472  *
 473  * DESCRIPTION: Init and start debugger
 474  *
 475  ******************************************************************************/
 476
 477 ACPI_STATUS
 478 AcpiDbInitialize (
 479     void)
 480 {
 481     ACPI_STATUS             Status;
 482
 483
 484     ACPI_FUNCTION_TRACE (DbInitialize);
 485
 486
 487     /* Init globals */
 488
 489     AcpiGbl_DbBuffer            = NULL;
 490     AcpiGbl_DbFilename          = NULL;
 491     AcpiGbl_DbOutputToFile      = FALSE;
 492
 493     AcpiGbl_DbDebugLevel        = ACPI_LV_VERBOSITY2;
 494     AcpiGbl_DbConsoleDebugLevel = ACPI_NORMAL_DEFAULT | ACPI_LV_TABLES;
 495     AcpiGbl_DbOutputFlags       = ACPI_DB_CONSOLE_OUTPUT;
 496
 497     AcpiGbl_DbOpt_Disasm        = FALSE;
 498     AcpiGbl_DbOpt_Verbose       = TRUE;
 499     AcpiGbl_DbOpt_NoIniMethods  = FALSE;
 500
 501     AcpiGbl_DbBuffer = AcpiOsAllocate (ACPI_DEBUG_BUFFER_SIZE);
 502     if (!AcpiGbl_DbBuffer)
 503     {
 504         return_ACPI_STATUS (AE_NO_MEMORY);
 505     }
 506     ACPI_MEMSET (AcpiGbl_DbBuffer, 0, ACPI_DEBUG_BUFFER_SIZE);
 507
 508     /* Initial scope is the root */
 509
 510     AcpiGbl_DbScopeBuf [0] = AML_ROOT_PREFIX;
 511     AcpiGbl_DbScopeBuf [1] =  0;
 512     AcpiGbl_DbScopeNode = AcpiGbl_RootNode;
 513
 514     /*
 515      * If configured for multi-thread support, the debug executor runs in
 516      * a separate thread so that the front end can be in another address
 517      * space, environment, or even another machine.
 518      */
 519     if (AcpiGbl_DebuggerConfiguration & DEBUGGER_MULTI_THREADED)
 520     {
 521         /* These were created with one unit, grab it */
 522
 523         Status = AcpiUtAcquireMutex (ACPI_MTX_DEBUG_CMD_COMPLETE);
 524         if (ACPI_FAILURE (Status))
 525         {
 526             AcpiOsPrintf ("Could not get debugger mutex\n");
 527             return_ACPI_STATUS (Status);
 528         }
 529
 530         Status = AcpiUtAcquireMutex (ACPI_MTX_DEBUG_CMD_READY);
 531         if (ACPI_FAILURE (Status))
 532         {
 533             AcpiOsPrintf ("Could not get debugger mutex\n");
 534             return_ACPI_STATUS (Status);
 535         }
 536
 537         /* Create the debug execution thread to execute commands */
 538
 539         Status = AcpiOsExecute (OSL_DEBUGGER_THREAD, AcpiDbExecuteThread, NULL);
 540         if (ACPI_FAILURE (Status))
 541         {
 542             ACPI_EXCEPTION ((AE_INFO, Status, "Could not start debugger thread"));
 543             return_ACPI_STATUS (Status);
 544         }
 545     }
 546
 547     if (!AcpiGbl_DbOpt_Verbose)
 548     {
 549         AcpiGbl_DbOpt_Disasm = TRUE;
 550     }
 551
 552     return_ACPI_STATUS (AE_OK);
 553 }
 554
 555
 556 /*******************************************************************************
 557  *
 558  * FUNCTION:    AcpiDbTerminate
 559  *
 560  * PARAMETERS:  None
 561  *
 562  * RETURN:      None
 563  *
 564  * DESCRIPTION: Stop debugger
 565  *
 566  ******************************************************************************/
 567
 568 void
 569 AcpiDbTerminate (
 570     void)
 571 {
 572
 573     if (AcpiGbl_DbBuffer)
 574     {
 575         AcpiOsFree (AcpiGbl_DbBuffer);
 576         AcpiGbl_DbBuffer = NULL;
 577     }
 578
 579     /* Ensure that debug output is now disabled */
 580
 581     AcpiGbl_DbOutputFlags = ACPI_DB_DISABLE_OUTPUT;
 582 }
 583
 584
 585 #ifdef ACPI_OBSOLETE_FUNCTIONS
 586 /*******************************************************************************
 587  *
 588  * FUNCTION:    AcpiDbMethodEnd
 589  *
 590  * PARAMETERS:  WalkState       - Current walk
 591  *
 592  * RETURN:      Status
 593  *
 594  * DESCRIPTION: Called at method termination
 595  *
 596  ******************************************************************************/
 597
 598 void
 599 AcpiDbMethodEnd (
 600     ACPI_WALK_STATE         *WalkState)
 601 {
 602
 603     if (!AcpiGbl_CmSingleStep)
 604     {
 605         return;
 606     }
 607
 608     AcpiOsPrintf ("<Method Terminating>\n");
 609
 610     AcpiDbStartCommand (WalkState, NULL);
 611 }
 612 #endif
 613
 614 #endif /* ACPI_DEBUGGER */