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