1 /*******************************************************************************
3 * Module Name: dbexec - debugger control method execution
6 ******************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2007, Intel Corp.
13 * All rights reserved.
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
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
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;
38 * The above copyright and patent license is granted only if the following
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.
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
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
73 * 3.4. Intel retains all right, title, and interest in and to the Original
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.
81 * 4. Disclaimer and Export Compliance
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
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
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.
115 *****************************************************************************/
118 #include <contrib/dev/acpica/acpi.h>
119 #include <contrib/dev/acpica/acdebug.h>
120 #include <contrib/dev/acpica/acnamesp.h>
124 #define _COMPONENT ACPI_CA_DEBUGGER
125 ACPI_MODULE_NAME ("dbexec")
128 static ACPI_DB_METHOD_INFO AcpiGbl_DbMethodInfo;
130 /* Local prototypes */
133 AcpiDbExecuteMethod (
134 ACPI_DB_METHOD_INFO *Info,
135 ACPI_BUFFER *ReturnObj);
139 ACPI_DB_METHOD_INFO *Info);
142 AcpiDbGetOutstandingAllocations (
145 static void ACPI_SYSTEM_XFACE
150 AcpiDbExecutionWalk (
151 ACPI_HANDLE ObjHandle,
157 /*******************************************************************************
159 * FUNCTION: AcpiDbExecuteMethod
161 * PARAMETERS: Info - Valid info segment
162 * ReturnObj - Where to put return object
166 * DESCRIPTION: Execute a control method.
168 ******************************************************************************/
171 AcpiDbExecuteMethod (
172 ACPI_DB_METHOD_INFO *Info,
173 ACPI_BUFFER *ReturnObj)
176 ACPI_OBJECT_LIST ParamObjects;
177 ACPI_OBJECT Params[ACPI_METHOD_NUM_ARGS];
181 if (AcpiGbl_DbOutputToFile && !AcpiDbgLevel)
183 AcpiOsPrintf ("Warning: debug output is not enabled!\n");
186 /* Are there arguments to the method? */
188 if (Info->Args && Info->Args[0])
190 for (i = 0; Info->Args[i] && i < ACPI_METHOD_NUM_ARGS; i++)
192 Params[i].Type = ACPI_TYPE_INTEGER;
193 Params[i].Integer.Value = ACPI_STRTOUL (Info->Args[i], NULL, 16);
196 ParamObjects.Pointer = Params;
197 ParamObjects.Count = i;
201 /* Setup default parameters */
203 Params[0].Type = ACPI_TYPE_INTEGER;
204 Params[0].Integer.Value = 0x01020304;
206 Params[1].Type = ACPI_TYPE_STRING;
207 Params[1].String.Length = 12;
208 Params[1].String.Pointer = "AML Debugger";
210 ParamObjects.Pointer = Params;
211 ParamObjects.Count = 2;
214 /* Prepare for a return object of arbitrary size */
216 ReturnObj->Pointer = AcpiGbl_DbBuffer;
217 ReturnObj->Length = ACPI_DEBUG_BUFFER_SIZE;
219 /* Do the actual method execution */
221 AcpiGbl_MethodExecuting = TRUE;
222 Status = AcpiEvaluateObject (NULL,
223 Info->Pathname, &ParamObjects, ReturnObj);
225 AcpiGbl_CmSingleStep = FALSE;
226 AcpiGbl_MethodExecuting = FALSE;
232 /*******************************************************************************
234 * FUNCTION: AcpiDbExecuteSetup
236 * PARAMETERS: Info - Valid method info
240 * DESCRIPTION: Setup info segment prior to method execution
242 ******************************************************************************/
246 ACPI_DB_METHOD_INFO *Info)
249 /* Catenate the current scope to the supplied name */
251 Info->Pathname[0] = 0;
252 if ((Info->Name[0] != '\\') &&
253 (Info->Name[0] != '/'))
255 ACPI_STRCAT (Info->Pathname, AcpiGbl_DbScopeBuf);
258 ACPI_STRCAT (Info->Pathname, Info->Name);
259 AcpiDbPrepNamestring (Info->Pathname);
261 AcpiDbSetOutputDestination (ACPI_DB_DUPLICATE_OUTPUT);
262 AcpiOsPrintf ("Executing %s\n", Info->Pathname);
264 if (Info->Flags & EX_SINGLE_STEP)
266 AcpiGbl_CmSingleStep = TRUE;
267 AcpiDbSetOutputDestination (ACPI_DB_CONSOLE_OUTPUT);
272 /* No single step, allow redirection to a file */
274 AcpiDbSetOutputDestination (ACPI_DB_REDIRECTABLE_OUTPUT);
279 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
282 ACPI_MEMORY_LIST *Cache)
285 return (Cache->TotalAllocated - Cache->TotalFreed - Cache->CurrentDepth);
289 /*******************************************************************************
291 * FUNCTION: AcpiDbGetOutstandingAllocations
295 * RETURN: Current global allocation count minus cache entries
297 * DESCRIPTION: Determine the current number of "outstanding" allocations --
298 * those allocations that have not been freed and also are not
299 * in one of the various object caches.
301 ******************************************************************************/
304 AcpiDbGetOutstandingAllocations (
307 UINT32 Outstanding = 0;
309 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
311 Outstanding += AcpiDbGetCacheInfo (AcpiGbl_StateCache);
312 Outstanding += AcpiDbGetCacheInfo (AcpiGbl_PsNodeCache);
313 Outstanding += AcpiDbGetCacheInfo (AcpiGbl_PsNodeExtCache);
314 Outstanding += AcpiDbGetCacheInfo (AcpiGbl_OperandCache);
317 return (Outstanding);
321 /*******************************************************************************
323 * FUNCTION: AcpiDbExecutionWalk
325 * PARAMETERS: WALK_CALLBACK
329 * DESCRIPTION: Execute a control method. Name is relative to the current
332 ******************************************************************************/
335 AcpiDbExecutionWalk (
336 ACPI_HANDLE ObjHandle,
341 ACPI_OPERAND_OBJECT *ObjDesc;
342 ACPI_NAMESPACE_NODE *Node = (ACPI_NAMESPACE_NODE *) ObjHandle;
343 ACPI_BUFFER ReturnObj;
347 ObjDesc = AcpiNsGetAttachedObject (Node);
348 if (ObjDesc->Method.ParamCount)
353 ReturnObj.Pointer = NULL;
354 ReturnObj.Length = ACPI_ALLOCATE_BUFFER;
356 AcpiNsPrintNodePathname (Node, "Execute");
358 /* Do the actual method execution */
361 AcpiGbl_MethodExecuting = TRUE;
363 Status = AcpiEvaluateObject (Node, NULL, NULL, &ReturnObj);
365 AcpiOsPrintf ("[%4.4s] returned %s\n", AcpiUtGetNodeName (Node),
366 AcpiFormatException (Status));
367 AcpiGbl_MethodExecuting = FALSE;
373 /*******************************************************************************
375 * FUNCTION: AcpiDbExecute
377 * PARAMETERS: Name - Name of method to execute
378 * Args - Parameters to the method
379 * Flags - single step/no single step
383 * DESCRIPTION: Execute a control method. Name is relative to the current
386 ******************************************************************************/
395 ACPI_BUFFER ReturnObj;
399 #ifdef ACPI_DEBUG_OUTPUT
400 UINT32 PreviousAllocations;
404 /* Memory allocation tracking */
406 PreviousAllocations = AcpiDbGetOutstandingAllocations ();
411 (void) AcpiWalkNamespace (ACPI_TYPE_METHOD, ACPI_ROOT_OBJECT,
412 ACPI_UINT32_MAX, AcpiDbExecutionWalk, NULL, NULL);
417 NameString = ACPI_ALLOCATE (ACPI_STRLEN (Name) + 1);
423 ACPI_MEMSET (&AcpiGbl_DbMethodInfo, 0, sizeof (ACPI_DB_METHOD_INFO));
425 ACPI_STRCPY (NameString, Name);
426 AcpiUtStrupr (NameString);
427 AcpiGbl_DbMethodInfo.Name = NameString;
428 AcpiGbl_DbMethodInfo.Args = Args;
429 AcpiGbl_DbMethodInfo.Flags = Flags;
431 ReturnObj.Pointer = NULL;
432 ReturnObj.Length = ACPI_ALLOCATE_BUFFER;
434 AcpiDbExecuteSetup (&AcpiGbl_DbMethodInfo);
435 Status = AcpiDbExecuteMethod (&AcpiGbl_DbMethodInfo, &ReturnObj);
436 ACPI_FREE (NameString);
440 * Allow any handlers in separate threads to complete.
441 * (Such as Notify handlers invoked from AML executed above).
443 AcpiOsSleep ((ACPI_INTEGER) 10);
446 #ifdef ACPI_DEBUG_OUTPUT
448 /* Memory allocation tracking */
450 Allocations = AcpiDbGetOutstandingAllocations () - PreviousAllocations;
452 AcpiDbSetOutputDestination (ACPI_DB_DUPLICATE_OUTPUT);
456 AcpiOsPrintf ("Outstanding: 0x%X allocations after execution\n",
461 if (ACPI_FAILURE (Status))
463 AcpiOsPrintf ("Execution of %s failed with status %s\n",
464 AcpiGbl_DbMethodInfo.Pathname, AcpiFormatException (Status));
468 /* Display a return object, if any */
470 if (ReturnObj.Length)
472 AcpiOsPrintf ("Execution of %s returned object %p Buflen %X\n",
473 AcpiGbl_DbMethodInfo.Pathname, ReturnObj.Pointer,
474 (UINT32) ReturnObj.Length);
475 AcpiDbDumpExternalObject (ReturnObj.Pointer, 1);
479 AcpiOsPrintf ("No return object from execution of %s\n",
480 AcpiGbl_DbMethodInfo.Pathname);
484 AcpiDbSetOutputDestination (ACPI_DB_CONSOLE_OUTPUT);
488 /*******************************************************************************
490 * FUNCTION: AcpiDbMethodThread
492 * PARAMETERS: Context - Execution info segment
496 * DESCRIPTION: Debugger execute thread. Waits for a command line, then
497 * simply dispatches it.
499 ******************************************************************************/
501 static void ACPI_SYSTEM_XFACE
506 ACPI_DB_METHOD_INFO *Info = Context;
509 ACPI_BUFFER ReturnObj;
514 AcpiDbUInt32ToHexString (Info->NumCreated, Info->IndexOfThreadStr);
515 AcpiDbUInt32ToHexString (AcpiOsGetThreadId (), Info->IdOfThreadStr);
518 if (Info->Threads && (Info->NumCreated < Info->NumThreads))
520 Info->Threads[Info->NumCreated++] = AcpiOsGetThreadId();
523 for (i = 0; i < Info->NumLoops; i++)
525 Status = AcpiDbExecuteMethod (Info, &ReturnObj);
526 if (ACPI_FAILURE (Status))
528 AcpiOsPrintf ("%s During execution of %s at iteration %X\n",
529 AcpiFormatException (Status), Info->Pathname, i);
530 if (Status == AE_ABORT_METHOD)
539 AcpiOsPrintf ("%d executions, Thread 0x%x\n", i, AcpiOsGetThreadId ());
542 if (ReturnObj.Length)
544 AcpiOsPrintf ("Execution of %s returned object %p Buflen %X\n",
545 Info->Pathname, ReturnObj.Pointer, (UINT32) ReturnObj.Length);
546 AcpiDbDumpExternalObject (ReturnObj.Pointer, 1);
551 /* Signal our completion */
554 AcpiOsWaitSemaphore (Info->ThreadCompleteGate, 1, ACPI_WAIT_FOREVER);
555 Info->NumCompleted++;
557 if (Info->NumCompleted == Info->NumThreads)
559 /* Do signal for main thread once only */
563 AcpiOsSignalSemaphore (Info->ThreadCompleteGate, 1);
567 Status = AcpiOsSignalSemaphore (Info->MainThreadGate, 1);
568 if (ACPI_FAILURE (Status))
570 AcpiOsPrintf ("Could not signal debugger thread sync semaphore, %s\n",
571 AcpiFormatException (Status));
577 /*******************************************************************************
579 * FUNCTION: AcpiDbCreateExecutionThreads
581 * PARAMETERS: NumThreadsArg - Number of threads to create
582 * NumLoopsArg - Loop count for the thread(s)
583 * MethodNameArg - Control method to execute
587 * DESCRIPTION: Create threads to execute method(s)
589 ******************************************************************************/
592 AcpiDbCreateExecutionThreads (
602 ACPI_MUTEX MainThreadGate;
603 ACPI_MUTEX ThreadCompleteGate;
605 /* Get the arguments */
607 NumThreads = ACPI_STRTOUL (NumThreadsArg, NULL, 0);
608 NumLoops = ACPI_STRTOUL (NumLoopsArg, NULL, 0);
610 if (!NumThreads || !NumLoops)
612 AcpiOsPrintf ("Bad argument: Threads %X, Loops %X\n",
613 NumThreads, NumLoops);
618 * Create the semaphore for synchronization of
619 * the created threads with the main thread.
621 Status = AcpiOsCreateSemaphore (1, 0, &MainThreadGate);
622 if (ACPI_FAILURE (Status))
624 AcpiOsPrintf ("Could not create semaphore for synchronization with the main thread, %s\n",
625 AcpiFormatException (Status));
630 * Create the semaphore for synchronization
631 * between the created threads.
633 Status = AcpiOsCreateSemaphore (1, 1, &ThreadCompleteGate);
634 if (ACPI_FAILURE (Status))
636 AcpiOsPrintf ("Could not create semaphore for synchronization between the created threads, %s\n",
637 AcpiFormatException (Status));
638 (void) AcpiOsDeleteSemaphore (MainThreadGate);
642 ACPI_MEMSET (&AcpiGbl_DbMethodInfo, 0, sizeof (ACPI_DB_METHOD_INFO));
644 /* Array to store IDs of threads */
646 AcpiGbl_DbMethodInfo.NumThreads = NumThreads;
647 Size = 4 * AcpiGbl_DbMethodInfo.NumThreads;
648 AcpiGbl_DbMethodInfo.Threads = (UINT32 *) AcpiOsAllocate (Size);
649 if (AcpiGbl_DbMethodInfo.Threads == NULL)
651 AcpiOsPrintf ("No memory for thread IDs array\n");
652 (void) AcpiOsDeleteSemaphore (MainThreadGate);
653 (void) AcpiOsDeleteSemaphore (ThreadCompleteGate);
656 ACPI_MEMSET (AcpiGbl_DbMethodInfo.Threads, 0, Size);
658 /* Setup the context to be passed to each thread */
660 AcpiGbl_DbMethodInfo.Name = MethodNameArg;
661 AcpiGbl_DbMethodInfo.Flags = 0;
662 AcpiGbl_DbMethodInfo.NumLoops = NumLoops;
663 AcpiGbl_DbMethodInfo.MainThreadGate = MainThreadGate;
664 AcpiGbl_DbMethodInfo.ThreadCompleteGate = ThreadCompleteGate;
666 /* Init arguments to be passed to method */
668 AcpiGbl_DbMethodInfo.InitArgs = 1;
669 AcpiGbl_DbMethodInfo.Args = AcpiGbl_DbMethodInfo.Arguments;
670 AcpiGbl_DbMethodInfo.Arguments[0] = AcpiGbl_DbMethodInfo.NumThreadsStr;
671 AcpiGbl_DbMethodInfo.Arguments[1] = AcpiGbl_DbMethodInfo.IdOfThreadStr;
672 AcpiGbl_DbMethodInfo.Arguments[2] = AcpiGbl_DbMethodInfo.IndexOfThreadStr;
673 AcpiGbl_DbMethodInfo.Arguments[3] = NULL;
674 AcpiDbUInt32ToHexString (NumThreads, AcpiGbl_DbMethodInfo.NumThreadsStr);
676 AcpiDbExecuteSetup (&AcpiGbl_DbMethodInfo);
678 /* Create the threads */
680 AcpiOsPrintf ("Creating %X threads to execute %X times each\n",
681 NumThreads, NumLoops);
683 for (i = 0; i < (NumThreads); i++)
685 Status = AcpiOsExecute (OSL_DEBUGGER_THREAD, AcpiDbMethodThread,
686 &AcpiGbl_DbMethodInfo);
687 if (ACPI_FAILURE (Status))
693 /* Wait for all threads to complete */
695 AcpiOsWaitSemaphore (MainThreadGate, 1, ACPI_WAIT_FOREVER);
697 AcpiDbSetOutputDestination (ACPI_DB_DUPLICATE_OUTPUT);
698 AcpiOsPrintf ("All threads (%X) have completed\n", NumThreads);
699 AcpiDbSetOutputDestination (ACPI_DB_CONSOLE_OUTPUT);
701 /* Cleanup and exit */
703 (void) AcpiOsDeleteSemaphore (MainThreadGate);
704 (void) AcpiOsDeleteSemaphore (ThreadCompleteGate);
706 AcpiOsFree (AcpiGbl_DbMethodInfo.Threads);
707 AcpiGbl_DbMethodInfo.Threads = NULL;
710 #endif /* ACPI_DEBUGGER */