dbexec.c revision 80062
1/******************************************************************************* 2 * 3 * Module Name: dbexec - debugger control method execution 4 * $Revision: 27 $ 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 "acdispat.h" 121#include "amlcode.h" 122#include "acnamesp.h" 123#include "acparser.h" 124#include "acevents.h" 125#include "acinterp.h" 126#include "acdebug.h" 127#include "actables.h" 128 129#ifdef ENABLE_DEBUGGER 130 131#define _COMPONENT ACPI_DEBUGGER 132 MODULE_NAME ("dbexec") 133 134 135DB_METHOD_INFO Info; 136 137 138/******************************************************************************* 139 * 140 * FUNCTION: AcpiDbExecuteMethod 141 * 142 * PARAMETERS: Info - Valid info segment 143 * ReturnObj - Where to put return object 144 * 145 * RETURN: Status 146 * 147 * DESCRIPTION: Execute a control method. 148 * 149 ******************************************************************************/ 150 151ACPI_STATUS 152AcpiDbExecuteMethod ( 153 DB_METHOD_INFO *Info, 154 ACPI_BUFFER *ReturnObj) 155{ 156 ACPI_STATUS Status; 157 ACPI_OBJECT_LIST ParamObjects; 158 ACPI_OBJECT Params[MTH_NUM_ARGS]; 159 UINT32 i; 160 161 162 if (OutputToFile && !AcpiDbgLevel) 163 { 164 AcpiOsPrintf ("Warning: debug output is not enabled!\n"); 165 } 166 167 /* Are there arguments to the method? */ 168 169 if (Info->Args && Info->Args[0]) 170 { 171 for (i = 0; Info->Args[i] && i < MTH_NUM_ARGS; i++) 172 { 173 Params[i].Type = ACPI_TYPE_INTEGER; 174 Params[i].Integer.Value = STRTOUL (Info->Args[i], NULL, 16); 175 } 176 177 ParamObjects.Pointer = Params; 178 ParamObjects.Count = i; 179 } 180 181 else 182 { 183 /* Setup default parameters */ 184 185 Params[0].Type = ACPI_TYPE_INTEGER; 186 Params[0].Integer.Value = 0x01020304; 187 188 Params[1].Type = ACPI_TYPE_STRING; 189 Params[1].String.Length = 12; 190 Params[1].String.Pointer = "AML Debugger"; 191 192 ParamObjects.Pointer = Params; 193 ParamObjects.Count = 2; 194 } 195 196 /* Prepare for a return object of arbitrary size */ 197 198 ReturnObj->Pointer = Buffer; 199 ReturnObj->Length = BUFFER_SIZE; 200 201 202 /* Do the actual method execution */ 203 204 Status = AcpiEvaluateObject (NULL, Info->Pathname, &ParamObjects, ReturnObj); 205 206 AcpiGbl_CmSingleStep = FALSE; 207 AcpiGbl_MethodExecuting = FALSE; 208 209 return (Status); 210} 211 212 213/******************************************************************************* 214 * 215 * FUNCTION: AcpiDbExecuteSetup 216 * 217 * PARAMETERS: Info - Valid method info 218 * 219 * RETURN: Status 220 * 221 * DESCRIPTION: Setup info segment prior to method execution 222 * 223 ******************************************************************************/ 224 225void 226AcpiDbExecuteSetup ( 227 DB_METHOD_INFO *Info) 228{ 229 230 /* Catenate the current scope to the supplied name */ 231 232 Info->Pathname[0] = 0; 233 if ((Info->Name[0] != '\\') && 234 (Info->Name[0] != '/')) 235 { 236 STRCAT (Info->Pathname, ScopeBuf); 237 } 238 239 STRCAT (Info->Pathname, Info->Name); 240 AcpiDbPrepNamestring (Info->Pathname); 241 242 AcpiDbSetOutputDestination (DB_DUPLICATE_OUTPUT); 243 AcpiOsPrintf ("Executing %s\n", Info->Pathname); 244 245 if (Info->Flags & EX_SINGLE_STEP) 246 { 247 AcpiGbl_CmSingleStep = TRUE; 248 AcpiDbSetOutputDestination (DB_CONSOLE_OUTPUT); 249 } 250 251 else 252 { 253 /* No single step, allow redirection to a file */ 254 255 AcpiDbSetOutputDestination (DB_REDIRECTABLE_OUTPUT); 256 } 257} 258 259 260/******************************************************************************* 261 * 262 * FUNCTION: AcpiDbExecute 263 * 264 * PARAMETERS: Name - Name of method to execute 265 * Args - Parameters to the method 266 * Flags - single step/no single step 267 * 268 * RETURN: Status 269 * 270 * DESCRIPTION: Execute a control method. Name is relative to the current 271 * scope. 272 * 273 ******************************************************************************/ 274 275void 276AcpiDbExecute ( 277 NATIVE_CHAR *Name, 278 NATIVE_CHAR **Args, 279 UINT32 Flags) 280{ 281 ACPI_STATUS Status; 282 ACPI_BUFFER ReturnObj; 283 284 285#ifdef ACPI_DEBUG 286 UINT32 PreviousAllocations; 287 UINT32 PreviousSize; 288 UINT32 Allocations; 289 UINT32 Size; 290 291 292 /* Memory allocation tracking */ 293 294 PreviousAllocations = AcpiGbl_CurrentAllocCount; 295 PreviousSize = AcpiGbl_CurrentAllocSize; 296#endif 297 298 Info.Name = Name; 299 Info.Args = Args; 300 Info.Flags = Flags; 301 302 AcpiDbExecuteSetup (&Info); 303 Status = AcpiDbExecuteMethod (&Info, &ReturnObj); 304 305 306#ifdef ACPI_DEBUG 307 308 /* Memory allocation tracking */ 309 310 Allocations = AcpiGbl_CurrentAllocCount - PreviousAllocations; 311 Size = AcpiGbl_CurrentAllocSize - PreviousSize; 312 313 AcpiDbSetOutputDestination (DB_DUPLICATE_OUTPUT); 314 315 if (Allocations > 0) 316 { 317 AcpiOsPrintf ("Outstanding: %ld allocations of total size %ld after execution\n", 318 Allocations, Size); 319 } 320#endif 321 322 if (ACPI_FAILURE (Status)) 323 { 324 AcpiOsPrintf ("Execution of %s failed with status %s\n", 325 Info.Pathname, AcpiFormatException (Status)); 326 } 327 328 else 329 { 330 /* Display a return object, if any */ 331 332 if (ReturnObj.Length) 333 { 334 AcpiOsPrintf ("Execution of %s returned object %p Buflen %X\n", 335 Info.Pathname, ReturnObj.Pointer, ReturnObj.Length); 336 AcpiDbDumpObject (ReturnObj.Pointer, 1); 337 } 338 } 339 340 AcpiDbSetOutputDestination (DB_CONSOLE_OUTPUT); 341} 342 343 344/******************************************************************************* 345 * 346 * FUNCTION: AcpiDbMethodThread 347 * 348 * PARAMETERS: Context - Execution info segment 349 * 350 * RETURN: None 351 * 352 * DESCRIPTION: Debugger execute thread. Waits for a command line, then 353 * simply dispatches it. 354 * 355 ******************************************************************************/ 356 357void 358AcpiDbMethodThread ( 359 void *Context) 360{ 361 ACPI_STATUS Status; 362 DB_METHOD_INFO *Info = Context; 363 UINT32 i; 364 ACPI_BUFFER ReturnObj; 365 366 367 for (i = 0; i < Info->NumLoops; i++) 368 { 369 Status = AcpiDbExecuteMethod (Info, &ReturnObj); 370 if (ACPI_SUCCESS (Status)) 371 { 372 if (ReturnObj.Length) 373 { 374 AcpiOsPrintf ("Execution of %s returned object %p Buflen %X\n", 375 Info->Pathname, ReturnObj.Pointer, ReturnObj.Length); 376 AcpiDbDumpObject (ReturnObj.Pointer, 1); 377 } 378 } 379 } 380 381 382 /* Signal our completion */ 383 384 AcpiOsSignalSemaphore (Info->ThreadGate, 1); 385} 386 387 388/******************************************************************************* 389 * 390 * FUNCTION: AcpiDbCreateExecutionThreads 391 * 392 * PARAMETERS: NumThreadsArg - Number of threads to create 393 * NumLoopsArg - Loop count for the thread(s) 394 * MethodNameArg - Control method to execute 395 * 396 * RETURN: None 397 * 398 * DESCRIPTION: Create threads to execute method(s) 399 * 400 ******************************************************************************/ 401 402void 403AcpiDbCreateExecutionThreads ( 404 NATIVE_CHAR *NumThreadsArg, 405 NATIVE_CHAR *NumLoopsArg, 406 NATIVE_CHAR *MethodNameArg) 407{ 408 ACPI_STATUS Status; 409 UINT32 NumThreads; 410 UINT32 NumLoops; 411 UINT32 i; 412 ACPI_HANDLE ThreadGate; 413 414 415 /* Get the arguments */ 416 417 NumThreads = STRTOUL (NumThreadsArg, NULL, 0); 418 NumLoops = STRTOUL (NumLoopsArg, NULL, 0); 419 420 if (!NumThreads || !NumLoops) 421 { 422 AcpiOsPrintf ("Bad argument: Threads %X, Loops %X\n", NumThreads, NumLoops); 423 return; 424 } 425 426 427 /* Create the synchronization semaphore */ 428 429 Status = AcpiOsCreateSemaphore (1, 0, &ThreadGate); 430 if (ACPI_FAILURE (Status)) 431 { 432 AcpiOsPrintf ("Could not create semaphore, %s\n", AcpiFormatException (Status)); 433 return; 434 } 435 436 /* Setup the context to be passed to each thread */ 437 438 Info.Name = MethodNameArg; 439 Info.Args = NULL; 440 Info.Flags = 0; 441 Info.NumLoops = NumLoops; 442 Info.ThreadGate = ThreadGate; 443 444 AcpiDbExecuteSetup (&Info); 445 446 447 /* Create the threads */ 448 449 AcpiOsPrintf ("Creating %X threads to execute %X times each\n", NumThreads, NumLoops); 450 451 for (i = 0; i < (NumThreads); i++) 452 { 453 AcpiOsQueueForExecution (OSD_PRIORITY_MED, AcpiDbMethodThread, &Info); 454 } 455 456 457 /* Wait for all threads to complete */ 458 459 i = NumThreads; 460 while (i) /* Brain damage for OSD implementations that only support wait of 1 unit */ 461 { 462 Status = AcpiOsWaitSemaphore (ThreadGate, 1, WAIT_FOREVER); 463 i--; 464 } 465 466 /* Cleanup and exit */ 467 468 AcpiOsDeleteSemaphore (ThreadGate); 469 470 AcpiDbSetOutputDestination (DB_DUPLICATE_OUTPUT); 471 AcpiOsPrintf ("All threads (%X) have completed\n", NumThreads); 472 AcpiDbSetOutputDestination (DB_CONSOLE_OUTPUT); 473} 474 475 476#endif /* ENABLE_DEBUGGER */ 477 478 479