dbexec.c revision 151937
1/******************************************************************************* 2 * 3 * Module Name: dbexec - debugger control method execution 4 * $Revision: 1.70 $ 5 * 6 ******************************************************************************/ 7 8/****************************************************************************** 9 * 10 * 1. Copyright Notice 11 * 12 * Some or all of this work - Copyright (c) 1999 - 2005, 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 <contrib/dev/acpica/acpi.h> 119#include <contrib/dev/acpica/acdebug.h> 120#include <contrib/dev/acpica/acnamesp.h> 121 122#ifdef ACPI_DEBUGGER 123 124#define _COMPONENT ACPI_CA_DEBUGGER 125 ACPI_MODULE_NAME ("dbexec") 126 127 128static ACPI_DB_METHOD_INFO AcpiGbl_DbMethodInfo; 129 130/* Local prototypes */ 131 132static ACPI_STATUS 133AcpiDbExecuteMethod ( 134 ACPI_DB_METHOD_INFO *Info, 135 ACPI_BUFFER *ReturnObj); 136 137static void 138AcpiDbExecuteSetup ( 139 ACPI_DB_METHOD_INFO *Info); 140 141static UINT32 142AcpiDbGetOutstandingAllocations ( 143 void); 144 145static void ACPI_SYSTEM_XFACE 146AcpiDbMethodThread ( 147 void *Context); 148 149static ACPI_STATUS 150AcpiDbExecutionWalk ( 151 ACPI_HANDLE ObjHandle, 152 UINT32 NestingLevel, 153 void *Context, 154 void **ReturnValue); 155 156#ifdef ACPI_DBG_TRACK_ALLOCATIONS 157static UINT32 158AcpiDbGetCacheInfo ( 159 ACPI_MEMORY_LIST *Cache); 160#endif 161 162 163/******************************************************************************* 164 * 165 * FUNCTION: AcpiDbExecuteMethod 166 * 167 * PARAMETERS: Info - Valid info segment 168 * ReturnObj - Where to put return object 169 * 170 * RETURN: Status 171 * 172 * DESCRIPTION: Execute a control method. 173 * 174 ******************************************************************************/ 175 176static ACPI_STATUS 177AcpiDbExecuteMethod ( 178 ACPI_DB_METHOD_INFO *Info, 179 ACPI_BUFFER *ReturnObj) 180{ 181 ACPI_STATUS Status; 182 ACPI_OBJECT_LIST ParamObjects; 183 ACPI_OBJECT Params[ACPI_METHOD_NUM_ARGS]; 184 UINT32 i; 185 186 187 if (AcpiGbl_DbOutputToFile && !AcpiDbgLevel) 188 { 189 AcpiOsPrintf ("Warning: debug output is not enabled!\n"); 190 } 191 192 /* Are there arguments to the method? */ 193 194 if (Info->Args && Info->Args[0]) 195 { 196 for (i = 0; Info->Args[i] && i < ACPI_METHOD_NUM_ARGS; i++) 197 { 198 Params[i].Type = ACPI_TYPE_INTEGER; 199 Params[i].Integer.Value = ACPI_STRTOUL (Info->Args[i], NULL, 16); 200 } 201 202 ParamObjects.Pointer = Params; 203 ParamObjects.Count = i; 204 } 205 else 206 { 207 /* Setup default parameters */ 208 209 Params[0].Type = ACPI_TYPE_INTEGER; 210 Params[0].Integer.Value = 0x01020304; 211 212 Params[1].Type = ACPI_TYPE_STRING; 213 Params[1].String.Length = 12; 214 Params[1].String.Pointer = "AML Debugger"; 215 216 ParamObjects.Pointer = Params; 217 ParamObjects.Count = 2; 218 } 219 220 /* Prepare for a return object of arbitrary size */ 221 222 ReturnObj->Pointer = AcpiGbl_DbBuffer; 223 ReturnObj->Length = ACPI_DEBUG_BUFFER_SIZE; 224 225 /* Do the actual method execution */ 226 227 AcpiGbl_MethodExecuting = TRUE; 228 Status = AcpiEvaluateObject (NULL, 229 Info->Pathname, &ParamObjects, ReturnObj); 230 231 AcpiGbl_CmSingleStep = FALSE; 232 AcpiGbl_MethodExecuting = FALSE; 233 234 return (Status); 235} 236 237 238/******************************************************************************* 239 * 240 * FUNCTION: AcpiDbExecuteSetup 241 * 242 * PARAMETERS: Info - Valid method info 243 * 244 * RETURN: None 245 * 246 * DESCRIPTION: Setup info segment prior to method execution 247 * 248 ******************************************************************************/ 249 250static void 251AcpiDbExecuteSetup ( 252 ACPI_DB_METHOD_INFO *Info) 253{ 254 255 /* Catenate the current scope to the supplied name */ 256 257 Info->Pathname[0] = 0; 258 if ((Info->Name[0] != '\\') && 259 (Info->Name[0] != '/')) 260 { 261 ACPI_STRCAT (Info->Pathname, AcpiGbl_DbScopeBuf); 262 } 263 264 ACPI_STRCAT (Info->Pathname, Info->Name); 265 AcpiDbPrepNamestring (Info->Pathname); 266 267 AcpiDbSetOutputDestination (ACPI_DB_DUPLICATE_OUTPUT); 268 AcpiOsPrintf ("Executing %s\n", Info->Pathname); 269 270 if (Info->Flags & EX_SINGLE_STEP) 271 { 272 AcpiGbl_CmSingleStep = TRUE; 273 AcpiDbSetOutputDestination (ACPI_DB_CONSOLE_OUTPUT); 274 } 275 276 else 277 { 278 /* No single step, allow redirection to a file */ 279 280 AcpiDbSetOutputDestination (ACPI_DB_REDIRECTABLE_OUTPUT); 281 } 282} 283 284 285#ifdef ACPI_DBG_TRACK_ALLOCATIONS 286static UINT32 287AcpiDbGetCacheInfo ( 288 ACPI_MEMORY_LIST *Cache) 289{ 290 291 return (Cache->TotalAllocated - Cache->TotalFreed - Cache->CurrentDepth); 292} 293#endif 294 295/******************************************************************************* 296 * 297 * FUNCTION: AcpiDbGetOutstandingAllocations 298 * 299 * PARAMETERS: None 300 * 301 * RETURN: Current global allocation count minus cache entries 302 * 303 * DESCRIPTION: Determine the current number of "outstanding" allocations -- 304 * those allocations that have not been freed and also are not 305 * in one of the various object caches. 306 * 307 ******************************************************************************/ 308 309static UINT32 310AcpiDbGetOutstandingAllocations ( 311 void) 312{ 313 UINT32 Outstanding = 0; 314 315#ifdef ACPI_DBG_TRACK_ALLOCATIONS 316 317 Outstanding += AcpiDbGetCacheInfo (AcpiGbl_StateCache); 318 Outstanding += AcpiDbGetCacheInfo (AcpiGbl_PsNodeCache); 319 Outstanding += AcpiDbGetCacheInfo (AcpiGbl_PsNodeExtCache); 320 Outstanding += AcpiDbGetCacheInfo (AcpiGbl_OperandCache); 321#endif 322 323 return (Outstanding); 324} 325 326 327/******************************************************************************* 328 * 329 * FUNCTION: AcpiDbExecutionWalk 330 * 331 * PARAMETERS: WALK_CALLBACK 332 * 333 * RETURN: Status 334 * 335 * DESCRIPTION: Execute a control method. Name is relative to the current 336 * scope. 337 * 338 ******************************************************************************/ 339 340static ACPI_STATUS 341AcpiDbExecutionWalk ( 342 ACPI_HANDLE ObjHandle, 343 UINT32 NestingLevel, 344 void *Context, 345 void **ReturnValue) 346{ 347 ACPI_OPERAND_OBJECT *ObjDesc; 348 ACPI_NAMESPACE_NODE *Node = (ACPI_NAMESPACE_NODE *) ObjHandle; 349 ACPI_BUFFER ReturnObj; 350 ACPI_STATUS Status; 351 352 353 ObjDesc = AcpiNsGetAttachedObject (Node); 354 if (ObjDesc->Method.ParamCount) 355 { 356 return (AE_OK); 357 } 358 359 ReturnObj.Pointer = NULL; 360 ReturnObj.Length = ACPI_ALLOCATE_BUFFER; 361 362 AcpiNsPrintNodePathname (Node, "Execute"); 363 364 /* Do the actual method execution */ 365 366 AcpiOsPrintf ("\n"); 367 AcpiGbl_MethodExecuting = TRUE; 368 369 Status = AcpiEvaluateObject (Node, NULL, NULL, &ReturnObj); 370 371 AcpiOsPrintf ("[%4.4s] returned %s\n", AcpiUtGetNodeName (Node), 372 AcpiFormatException (Status)); 373 AcpiGbl_MethodExecuting = FALSE; 374 375 return (AE_OK); 376} 377 378 379/******************************************************************************* 380 * 381 * FUNCTION: AcpiDbExecute 382 * 383 * PARAMETERS: Name - Name of method to execute 384 * Args - Parameters to the method 385 * Flags - single step/no single step 386 * 387 * RETURN: None 388 * 389 * DESCRIPTION: Execute a control method. Name is relative to the current 390 * scope. 391 * 392 ******************************************************************************/ 393 394void 395AcpiDbExecute ( 396 char *Name, 397 char **Args, 398 UINT32 Flags) 399{ 400 ACPI_STATUS Status; 401 ACPI_BUFFER ReturnObj; 402 403 404#ifdef ACPI_DEBUG_OUTPUT 405 UINT32 PreviousAllocations; 406 UINT32 Allocations; 407 408 409 /* Memory allocation tracking */ 410 411 PreviousAllocations = AcpiDbGetOutstandingAllocations (); 412#endif 413 414 if (*Name == '*') 415 { 416 (void) AcpiWalkNamespace (ACPI_TYPE_METHOD, ACPI_ROOT_OBJECT, 417 ACPI_UINT32_MAX, AcpiDbExecutionWalk, NULL, NULL); 418 return; 419 } 420 else 421 { 422 AcpiUtStrupr (Name); 423 AcpiGbl_DbMethodInfo.Name = Name; 424 AcpiGbl_DbMethodInfo.Args = Args; 425 AcpiGbl_DbMethodInfo.Flags = Flags; 426 427 ReturnObj.Pointer = NULL; 428 ReturnObj.Length = ACPI_ALLOCATE_BUFFER; 429 430 AcpiDbExecuteSetup (&AcpiGbl_DbMethodInfo); 431 Status = AcpiDbExecuteMethod (&AcpiGbl_DbMethodInfo, &ReturnObj); 432 } 433 434 /* 435 * Allow any handlers in separate threads to complete. 436 * (Such as Notify handlers invoked from AML executed above). 437 */ 438 AcpiOsSleep ((ACPI_INTEGER) 10); 439 440 441#ifdef ACPI_DEBUG_OUTPUT 442 443 /* Memory allocation tracking */ 444 445 Allocations = AcpiDbGetOutstandingAllocations () - PreviousAllocations; 446 447 AcpiDbSetOutputDestination (ACPI_DB_DUPLICATE_OUTPUT); 448 449 if (Allocations > 0) 450 { 451 AcpiOsPrintf ("Outstanding: 0x%X allocations after execution\n", 452 Allocations); 453 } 454#endif 455 456 if (ACPI_FAILURE (Status)) 457 { 458 AcpiOsPrintf ("Execution of %s failed with status %s\n", 459 AcpiGbl_DbMethodInfo.Pathname, AcpiFormatException (Status)); 460 } 461 else 462 { 463 /* Display a return object, if any */ 464 465 if (ReturnObj.Length) 466 { 467 AcpiOsPrintf ("Execution of %s returned object %p Buflen %X\n", 468 AcpiGbl_DbMethodInfo.Pathname, ReturnObj.Pointer, 469 (UINT32) ReturnObj.Length); 470 AcpiDbDumpExternalObject (ReturnObj.Pointer, 1); 471 } 472 else 473 { 474 AcpiOsPrintf ("No return object from execution of %s\n", 475 AcpiGbl_DbMethodInfo.Pathname); 476 } 477 } 478 479 AcpiDbSetOutputDestination (ACPI_DB_CONSOLE_OUTPUT); 480} 481 482 483/******************************************************************************* 484 * 485 * FUNCTION: AcpiDbMethodThread 486 * 487 * PARAMETERS: Context - Execution info segment 488 * 489 * RETURN: None 490 * 491 * DESCRIPTION: Debugger execute thread. Waits for a command line, then 492 * simply dispatches it. 493 * 494 ******************************************************************************/ 495 496static void ACPI_SYSTEM_XFACE 497AcpiDbMethodThread ( 498 void *Context) 499{ 500 ACPI_STATUS Status; 501 ACPI_DB_METHOD_INFO *Info = Context; 502 UINT32 i; 503 ACPI_BUFFER ReturnObj; 504 505 506 for (i = 0; i < Info->NumLoops; i++) 507 { 508#if 0 509 if (i == 0xEFDC) 510 { 511 AcpiDbgLevel = 0x00FFFFFF; 512 } 513#endif 514 515 Status = AcpiDbExecuteMethod (Info, &ReturnObj); 516 if (ACPI_FAILURE (Status)) 517 { 518 AcpiOsPrintf ("%s During execution of %s at iteration %X\n", 519 AcpiFormatException (Status), Info->Pathname, i); 520 if (Status == AE_ABORT_METHOD) 521 { 522 break; 523 } 524 } 525 526 if ((i % 100) == 0) 527 { 528 AcpiOsPrintf ("%d executions\n", i); 529 } 530 531#if 0 532 if (ReturnObj.Length) 533 { 534 AcpiOsPrintf ("Execution of %s returned object %p Buflen %X\n", 535 Info->Pathname, ReturnObj.Pointer, (UINT32) ReturnObj.Length); 536 AcpiDbDumpExternalObject (ReturnObj.Pointer, 1); 537 } 538#endif 539 } 540 541 /* Signal our completion */ 542 543 Status = AcpiOsSignalSemaphore (Info->ThreadGate, 1); 544 if (ACPI_FAILURE (Status)) 545 { 546 AcpiOsPrintf ("Could not signal debugger semaphore\n"); 547 } 548} 549 550 551/******************************************************************************* 552 * 553 * FUNCTION: AcpiDbCreateExecutionThreads 554 * 555 * PARAMETERS: NumThreadsArg - Number of threads to create 556 * NumLoopsArg - Loop count for the thread(s) 557 * MethodNameArg - Control method to execute 558 * 559 * RETURN: None 560 * 561 * DESCRIPTION: Create threads to execute method(s) 562 * 563 ******************************************************************************/ 564 565void 566AcpiDbCreateExecutionThreads ( 567 char *NumThreadsArg, 568 char *NumLoopsArg, 569 char *MethodNameArg) 570{ 571 ACPI_STATUS Status; 572 UINT32 NumThreads; 573 UINT32 NumLoops; 574 UINT32 i; 575 ACPI_HANDLE ThreadGate; 576 577 578 /* Get the arguments */ 579 580 NumThreads = ACPI_STRTOUL (NumThreadsArg, NULL, 0); 581 NumLoops = ACPI_STRTOUL (NumLoopsArg, NULL, 0); 582 583 if (!NumThreads || !NumLoops) 584 { 585 AcpiOsPrintf ("Bad argument: Threads %X, Loops %X\n", 586 NumThreads, NumLoops); 587 return; 588 } 589 590 /* Create the synchronization semaphore */ 591 592 Status = AcpiOsCreateSemaphore (1, 0, &ThreadGate); 593 if (ACPI_FAILURE (Status)) 594 { 595 AcpiOsPrintf ("Could not create semaphore, %s\n", 596 AcpiFormatException (Status)); 597 return; 598 } 599 600 /* Setup the context to be passed to each thread */ 601 602 AcpiGbl_DbMethodInfo.Name = MethodNameArg; 603 AcpiGbl_DbMethodInfo.Args = NULL; 604 AcpiGbl_DbMethodInfo.Flags = 0; 605 AcpiGbl_DbMethodInfo.NumLoops = NumLoops; 606 AcpiGbl_DbMethodInfo.ThreadGate = ThreadGate; 607 608 AcpiDbExecuteSetup (&AcpiGbl_DbMethodInfo); 609 610 /* Create the threads */ 611 612 AcpiOsPrintf ("Creating %X threads to execute %X times each\n", 613 NumThreads, NumLoops); 614 615 for (i = 0; i < (NumThreads); i++) 616 { 617 Status = AcpiOsQueueForExecution (OSD_PRIORITY_MED, AcpiDbMethodThread, 618 &AcpiGbl_DbMethodInfo); 619 if (ACPI_FAILURE (Status)) 620 { 621 break; 622 } 623 } 624 625 /* Wait for all threads to complete */ 626 627 i = NumThreads; 628 while (i) /* Brain damage for host OSs that only support wait of 1 unit */ 629 { 630 Status = AcpiOsWaitSemaphore (ThreadGate, 1, ACPI_WAIT_FOREVER); 631 i--; 632 } 633 634 /* Cleanup and exit */ 635 636 (void) AcpiOsDeleteSemaphore (ThreadGate); 637 638 AcpiDbSetOutputDestination (ACPI_DB_DUPLICATE_OUTPUT); 639 AcpiOsPrintf ("All threads (%X) have completed\n", NumThreads); 640 AcpiDbSetOutputDestination (ACPI_DB_CONSOLE_OUTPUT); 641} 642 643#endif /* ACPI_DEBUGGER */ 644 645 646