sys/contrib/dev/acpica/dbxface.c

   1 /*******************************************************************************
   2  *
   3  * Module Name: dbxface - AML Debugger external interfaces
   4  *              $Revision: 38 $
   5  *
   6  ******************************************************************************/
   7
   8 /******************************************************************************
   9  *
  10  * 1. Copyright Notice
  11  *
  12  * Some or all of this work - Copyright (c) 1999, 2000, 2001, Intel Corp.
  13  * All rights reserved.
  14  *
  15  * 2. License
  16  *
  17  * 2.1. This is your license from Intel Corp. under its intellectual property
  18  * rights.  You may have additional license terms from the party that provided
  19  * you this software, covering your right to use that party's intellectual
  20  * property rights.
  21  *
  22  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  23  * copy of the source code appearing in this file ("Covered Code") an
  24  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  25  * base code distributed originally by Intel ("Original Intel Code") to copy,
  26  * make derivatives, distribute, use and display any portion of the Covered
  27  * Code in any form, with the right to sublicense such rights; and
  28  *
  29  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  30  * license (with the right to sublicense), under only those claims of Intel
  31  * patents that are infringed by the Original Intel Code, to make, use, sell,
  32  * offer to sell, and import the Covered Code and derivative works thereof
  33  * solely to the minimum extent necessary to exercise the above copyright
  34  * license, and in no event shall the patent license extend to any additions
  35  * to or modifications of the Original Intel Code.  No other license or right
  36  * is granted directly or by implication, estoppel or otherwise;
  37  *
  38  * The above copyright and patent license is granted only if the following
  39  * conditions are met:
  40  *
  41  * 3. Conditions
  42  *
  43  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  44  * Redistribution of source code of any substantial portion of the Covered
  45  * Code or modification with rights to further distribute source must include
  46  * the above Copyright Notice, the above License, this list of Conditions,
  47  * and the following Disclaimer and Export Compliance provision.  In addition,
  48  * Licensee must cause all Covered Code to which Licensee contributes to
  49  * contain a file documenting the changes Licensee made to create that Covered
  50  * Code and the date of any change.  Licensee must include in that file the
  51  * documentation of any changes made by any predecessor Licensee.  Licensee
  52  * must include a prominent statement that the modification is derived,
  53  * directly or indirectly, from Original Intel Code.
  54  *
  55  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  56  * Redistribution of source code of any substantial portion of the Covered
  57  * Code or modification without rights to further distribute source must
  58  * include the following Disclaimer and Export Compliance provision in the
  59  * documentation and/or other materials provided with distribution.  In
  60  * addition, Licensee may not authorize further sublicense of source of any
  61  * portion of the Covered Code, and must include terms to the effect that the
  62  * license from Licensee to its licensee is limited to the intellectual
  63  * property embodied in the software Licensee provides to its licensee, and
  64  * not to intellectual property embodied in modifications its licensee may
  65  * make.
  66  *
  67  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  68  * substantial portion of the Covered Code or modification must reproduce the
  69  * above Copyright Notice, and the following Disclaimer and Export Compliance
  70  * provision in the documentation and/or other materials provided with the
  71  * distribution.
  72  *
  73  * 3.4. Intel retains all right, title, and interest in and to the Original
  74  * Intel Code.
  75  *
  76  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  77  * Intel shall be used in advertising or otherwise to promote the sale, use or
  78  * other dealings in products derived from or relating to the Covered Code
  79  * without prior written authorization from Intel.
  80  *
  81  * 4. Disclaimer and Export Compliance
  82  *
  83  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  84  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  85  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
  86  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
  87  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
  88  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  89  * PARTICULAR PURPOSE.
  90  *
  91  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  92  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  93  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  94  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  95  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  96  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
  97  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  98  * LIMITED REMEDY.
  99  *
 100  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 101  * software or system incorporating such software without first obtaining any
 102  * required license or other approval from the U. S. Department of Commerce or
 103  * any other agency or department of the United States Government.  In the
 104  * event Licensee exports any such software from the United States or
 105  * re-exports any such software from a foreign destination, Licensee shall
 106  * ensure that the distribution and export/re-export of the software is in
 107  * compliance with all laws, regulations, orders, or other restrictions of the
 108  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 109  * any of its subsidiaries will export/re-export any technical data, process,
 110  * software, or service, directly or indirectly, to any country for which the
 111  * United States government or any agency thereof requires an export license,
 112  * other governmental approval, or letter of assurance, without first obtaining
 113  * such license, approval or letter.
 114  *
 115  *****************************************************************************/
 116
 117
 118 #include "acpi.h"
 119 #include "acparser.h"
 120 #include "amlcode.h"
 121 #include "acnamesp.h"
 122 #include "acparser.h"
 123 #include "acevents.h"
 124 #include "acinterp.h"
 125 #include "acdebug.h"
 126
 127
 128 #ifdef ENABLE_DEBUGGER
 129
 130 #define _COMPONENT          ACPI_DEBUGGER
 131         MODULE_NAME         ("dbxface")
 132
 133
 134 /*******************************************************************************
 135  *
 136  * FUNCTION:    AcpiDbSingleStep
 137  *
 138  * PARAMETERS:  WalkState       - Current walk
 139  *              Op              - Current executing op
 140  *              OpType          - Type of the current AML Opcode
 141  *
 142  * RETURN:      Status
 143  *
 144  * DESCRIPTION: Called just before execution of an AML opcode.
 145  *
 146  ******************************************************************************/
 147
 148 ACPI_STATUS
 149 AcpiDbSingleStep (
 150     ACPI_WALK_STATE         *WalkState,
 151     ACPI_PARSE_OBJECT       *Op,
 152     UINT8                   OpType)
 153 {
 154     ACPI_PARSE_OBJECT       *Next;
 155     ACPI_STATUS             Status = AE_OK;
 156     UINT32                  OriginalDebugLevel;
 157     ACPI_PARSE_OBJECT       *DisplayOp;
 158
 159
 160     /* Is there a breakpoint set? */
 161
 162     if (WalkState->MethodBreakpoint)
 163     {
 164         /* Check if the breakpoint has been reached or passed */
 165
 166         if (WalkState->MethodBreakpoint <= Op->AmlOffset)
 167         {
 168             /* Hit the breakpoint, resume single step, reset breakpoint */
 169
 170             AcpiOsPrintf ("***Break*** at AML offset %X\n", Op->AmlOffset);
 171             AcpiGbl_CmSingleStep = TRUE;
 172             AcpiGbl_StepToNextCall = FALSE;
 173             WalkState->MethodBreakpoint = 0;
 174         }
 175     }
 176
 177
 178     /*
 179      * Check if this is an opcode that we are interested in --
 180      * namely, opcodes that have arguments
 181      */
 182
 183     if (Op->Opcode == AML_INT_NAMEDFIELD_OP)
 184     {
 185         return (AE_OK);
 186     }
 187
 188     switch (OpType)
 189     {
 190     case OPTYPE_UNDEFINED:
 191     case OPTYPE_CONSTANT:           /* argument type only */
 192     case OPTYPE_LITERAL:            /* argument type only */
 193     case OPTYPE_DATA_TERM:          /* argument type only */
 194     case OPTYPE_LOCAL_VARIABLE:     /* argument type only */
 195     case OPTYPE_METHOD_ARGUMENT:    /* argument type only */
 196         return (AE_OK);
 197         break;
 198
 199     case OPTYPE_NAMED_OBJECT:
 200         switch (Op->Opcode)
 201         {
 202         case AML_INT_NAMEPATH_OP:
 203             return (AE_OK);
 204             break;
 205         }
 206     }
 207
 208
 209     /*
 210      * Under certain debug conditions, display this opcode and its operands
 211      */
 212
 213     if ((OutputToFile)                      ||
 214         (AcpiGbl_CmSingleStep)              ||
 215         (AcpiDbgLevel & ACPI_LV_PARSE))
 216     {
 217         if ((OutputToFile)                  ||
 218             (AcpiDbgLevel & ACPI_LV_PARSE))
 219         {
 220             AcpiOsPrintf ("\n[AmlDebug] Next AML Opcode to execute:\n");
 221         }
 222
 223         /*
 224          * Display this op (and only this op - zero out the NEXT field temporarily,
 225          * and disable parser trace output for the duration of the display because
 226          * we don't want the extraneous debug output)
 227          */
 228
 229         OriginalDebugLevel = AcpiDbgLevel;
 230         AcpiDbgLevel &= ~(ACPI_LV_PARSE | ACPI_LV_FUNCTIONS);
 231         Next = Op->Next;
 232         Op->Next = NULL;
 233
 234
 235         DisplayOp = Op;
 236         if (Op->Parent)
 237         {
 238             if ((Op->Parent->Opcode == AML_IF_OP) ||
 239                 (Op->Parent->Opcode == AML_WHILE_OP))
 240             {
 241                 DisplayOp = Op->Parent;
 242             }
 243         }
 244
 245         /* Now we can display it */
 246
 247         AcpiDbDisplayOp (WalkState, DisplayOp, ACPI_UINT32_MAX);
 248
 249         if ((Op->Opcode == AML_IF_OP) ||
 250             (Op->Opcode == AML_WHILE_OP))
 251         {
 252             if (WalkState->ControlState->Common.Value)
 253             {
 254                 AcpiOsPrintf ("Predicate was TRUE, executed block\n");
 255             }
 256             else
 257             {
 258                 AcpiOsPrintf ("Predicate is FALSE, skipping block\n");
 259             }
 260         }
 261
 262         else if (Op->Opcode == AML_ELSE_OP)
 263         {
 264             /* TBD */
 265         }
 266
 267
 268         /* Restore everything */
 269
 270         Op->Next = Next;
 271         AcpiOsPrintf ("\n");
 272         AcpiDbgLevel = OriginalDebugLevel;
 273    }
 274
 275
 276     /* If we are not single stepping, just continue executing the method */
 277
 278     if (!AcpiGbl_CmSingleStep)
 279     {
 280         return (AE_OK);
 281     }
 282
 283
 284     /*
 285      * If we are executing a step-to-call command,
 286      * Check if this is a method call.
 287      */
 288
 289     if (AcpiGbl_StepToNextCall)
 290     {
 291         if (Op->Opcode != AML_INT_METHODCALL_OP)
 292         {
 293             /* Not a method call, just keep executing */
 294
 295             return (AE_OK);
 296         }
 297
 298         /* Found a method call, stop executing */
 299
 300         AcpiGbl_StepToNextCall = FALSE;
 301     }
 302
 303
 304     /*
 305      * If the next opcode is a method call, we will "step over" it
 306      * by default.
 307      */
 308
 309     if (Op->Opcode == AML_INT_METHODCALL_OP)
 310     {
 311         AcpiGbl_CmSingleStep = FALSE;  /* No more single step while executing called method */
 312
 313         /* Set the breakpoint on the call, it will stop execution as soon as we return */
 314
 315         /* TBD: [Future] don't kill the user breakpoint! */
 316
 317         WalkState->MethodBreakpoint = /* Op->AmlOffset + */ 1;  /* Must be non-zero! */
 318     }
 319
 320
 321     /* TBD: [Investigate] what are the namespace locking issues here */
 322
 323     /* AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE); */
 324
 325     /* Go into the command loop and await next user command */
 326
 327     AcpiGbl_MethodExecuting = TRUE;
 328     Status = AE_CTRL_TRUE;
 329     while (Status == AE_CTRL_TRUE)
 330     {
 331         if (AcpiGbl_DebuggerConfiguration == DEBUGGER_MULTI_THREADED)
 332         {
 333             /* Handshake with the front-end that gets user command lines */
 334
 335             AcpiUtReleaseMutex (ACPI_MTX_DEBUG_CMD_COMPLETE);
 336             AcpiUtAcquireMutex (ACPI_MTX_DEBUG_CMD_READY);
 337         }
 338
 339         else
 340         {
 341             /* Single threaded, we must get a command line ourselves */
 342
 343             /* Force output to console until a command is entered */
 344
 345             AcpiDbSetOutputDestination (DB_CONSOLE_OUTPUT);
 346
 347             /* Different prompt if method is executing */
 348
 349             if (!AcpiGbl_MethodExecuting)
 350             {
 351                 AcpiOsPrintf ("%1c ", DB_COMMAND_PROMPT);
 352             }
 353             else
 354             {
 355                 AcpiOsPrintf ("%1c ", DB_EXECUTE_PROMPT);
 356             }
 357
 358             /* Get the user input line */
 359
 360             AcpiOsGetLine (LineBuf);
 361         }
 362
 363         Status = AcpiDbCommandDispatch (LineBuf, WalkState, Op);
 364     }
 365
 366     /* AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE); */
 367
 368
 369     /* User commands complete, continue execution of the interrupted method */
 370
 371     return (Status);
 372 }
 373
 374
 375 /*******************************************************************************
 376  *
 377  * FUNCTION:    AcpiDbInitialize
 378  *
 379  * PARAMETERS:  None
 380  *
 381  * RETURN:      Status
 382  *
 383  * DESCRIPTION: Init and start debugger
 384  *
 385  ******************************************************************************/
 386
 387 int
 388 AcpiDbInitialize (void)
 389 {
 390
 391
 392     /* Init globals */
 393
 394     Buffer = AcpiOsAllocate (BUFFER_SIZE);
 395
 396     /* Initial scope is the root */
 397
 398     ScopeBuf [0] = '\\';
 399     ScopeBuf [1] =  0;
 400
 401
 402     /*
 403      * If configured for multi-thread support, the debug executor runs in
 404      * a separate thread so that the front end can be in another address
 405      * space, environment, or even another machine.
 406      */
 407
 408     if (AcpiGbl_DebuggerConfiguration & DEBUGGER_MULTI_THREADED)
 409     {
 410         /* These were created with one unit, grab it */
 411
 412         AcpiUtAcquireMutex (ACPI_MTX_DEBUG_CMD_COMPLETE);
 413         AcpiUtAcquireMutex (ACPI_MTX_DEBUG_CMD_READY);
 414
 415         /* Create the debug execution thread to execute commands */
 416
 417         AcpiOsQueueForExecution (0, AcpiDbExecuteThread, NULL);
 418     }
 419
 420     if (!opt_verbose)
 421     {
 422         INDENT_STRING = "    ";
 423         opt_disasm = TRUE;
 424         opt_stats = FALSE;
 425     }
 426
 427
 428     return (0);
 429 }
 430
 431
 432 #endif /* ENABLE_DEBUGGER */