1 /*******************************************************************************
3 * Module Name: dbexec - debugger control method execution
5 ******************************************************************************/
8 * Copyright (C) 2000 - 2014, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
44 #include <contrib/dev/acpica/include/acpi.h>
45 #include <contrib/dev/acpica/include/accommon.h>
46 #include <contrib/dev/acpica/include/acdebug.h>
47 #include <contrib/dev/acpica/include/acnamesp.h>
51 #define _COMPONENT ACPI_CA_DEBUGGER
52 ACPI_MODULE_NAME ("dbexec")
55 static ACPI_DB_METHOD_INFO AcpiGbl_DbMethodInfo;
57 /* Local prototypes */
61 ACPI_DB_METHOD_INFO *Info,
62 ACPI_BUFFER *ReturnObj);
66 ACPI_DB_METHOD_INFO *Info);
69 AcpiDbGetOutstandingAllocations (
72 static void ACPI_SYSTEM_XFACE
78 ACPI_HANDLE ObjHandle,
84 /*******************************************************************************
86 * FUNCTION: AcpiDbDeleteObjects
88 * PARAMETERS: Count - Count of objects in the list
89 * Objects - Array of ACPI_OBJECTs to be deleted
93 * DESCRIPTION: Delete a list of ACPI_OBJECTS. Handles packages and nested
94 * packages via recursion.
96 ******************************************************************************/
101 ACPI_OBJECT *Objects)
106 for (i = 0; i < Count; i++)
108 switch (Objects[i].Type)
110 case ACPI_TYPE_BUFFER:
112 ACPI_FREE (Objects[i].Buffer.Pointer);
115 case ACPI_TYPE_PACKAGE:
117 /* Recursive call to delete package elements */
119 AcpiDbDeleteObjects (Objects[i].Package.Count,
120 Objects[i].Package.Elements);
122 /* Free the elements array */
124 ACPI_FREE (Objects[i].Package.Elements);
135 /*******************************************************************************
137 * FUNCTION: AcpiDbExecuteMethod
139 * PARAMETERS: Info - Valid info segment
140 * ReturnObj - Where to put return object
144 * DESCRIPTION: Execute a control method.
146 ******************************************************************************/
149 AcpiDbExecuteMethod (
150 ACPI_DB_METHOD_INFO *Info,
151 ACPI_BUFFER *ReturnObj)
154 ACPI_OBJECT_LIST ParamObjects;
155 ACPI_OBJECT Params[ACPI_DEBUGGER_MAX_ARGS + 1];
159 ACPI_FUNCTION_TRACE (DbExecuteMethod);
162 if (AcpiGbl_DbOutputToFile && !AcpiDbgLevel)
164 AcpiOsPrintf ("Warning: debug output is not enabled!\n");
167 ParamObjects.Count = 0;
168 ParamObjects.Pointer = NULL;
170 /* Pass through any command-line arguments */
172 if (Info->Args && Info->Args[0])
174 /* Get arguments passed on the command line */
176 for (i = 0; (Info->Args[i] && *(Info->Args[i])); i++)
178 /* Convert input string (token) to an actual ACPI_OBJECT */
180 Status = AcpiDbConvertToObject (Info->Types[i],
181 Info->Args[i], &Params[i]);
182 if (ACPI_FAILURE (Status))
184 ACPI_EXCEPTION ((AE_INFO, Status,
185 "While parsing method arguments"));
190 ParamObjects.Count = i;
191 ParamObjects.Pointer = Params;
194 /* Prepare for a return object of arbitrary size */
196 ReturnObj->Pointer = AcpiGbl_DbBuffer;
197 ReturnObj->Length = ACPI_DEBUG_BUFFER_SIZE;
199 /* Do the actual method execution */
201 AcpiGbl_MethodExecuting = TRUE;
202 Status = AcpiEvaluateObject (NULL, Info->Pathname,
203 &ParamObjects, ReturnObj);
205 AcpiGbl_CmSingleStep = FALSE;
206 AcpiGbl_MethodExecuting = FALSE;
208 if (ACPI_FAILURE (Status))
210 ACPI_EXCEPTION ((AE_INFO, Status,
211 "while executing %s from debugger", Info->Pathname));
213 if (Status == AE_BUFFER_OVERFLOW)
215 ACPI_ERROR ((AE_INFO,
216 "Possible overflow of internal debugger buffer (size 0x%X needed 0x%X)",
217 ACPI_DEBUG_BUFFER_SIZE, (UINT32) ReturnObj->Length));
222 AcpiDbDeleteObjects (ParamObjects.Count, Params);
223 return_ACPI_STATUS (Status);
227 /*******************************************************************************
229 * FUNCTION: AcpiDbExecuteSetup
231 * PARAMETERS: Info - Valid method info
235 * DESCRIPTION: Setup info segment prior to method execution
237 ******************************************************************************/
241 ACPI_DB_METHOD_INFO *Info)
246 ACPI_FUNCTION_NAME (DbExecuteSetup);
249 /* Catenate the current scope to the supplied name */
251 Info->Pathname[0] = 0;
252 if ((Info->Name[0] != '\\') &&
253 (Info->Name[0] != '/'))
255 if (AcpiUtSafeStrcat (Info->Pathname, sizeof (Info->Pathname),
258 Status = AE_BUFFER_OVERFLOW;
263 if (AcpiUtSafeStrcat (Info->Pathname, sizeof (Info->Pathname),
266 Status = AE_BUFFER_OVERFLOW;
270 AcpiDbPrepNamestring (Info->Pathname);
272 AcpiDbSetOutputDestination (ACPI_DB_DUPLICATE_OUTPUT);
273 AcpiOsPrintf ("Evaluating %s\n", Info->Pathname);
275 if (Info->Flags & EX_SINGLE_STEP)
277 AcpiGbl_CmSingleStep = TRUE;
278 AcpiDbSetOutputDestination (ACPI_DB_CONSOLE_OUTPUT);
283 /* No single step, allow redirection to a file */
285 AcpiDbSetOutputDestination (ACPI_DB_REDIRECTABLE_OUTPUT);
292 ACPI_EXCEPTION ((AE_INFO, Status, "During setup for method execution"));
297 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
300 ACPI_MEMORY_LIST *Cache)
303 return (Cache->TotalAllocated - Cache->TotalFreed - Cache->CurrentDepth);
307 /*******************************************************************************
309 * FUNCTION: AcpiDbGetOutstandingAllocations
313 * RETURN: Current global allocation count minus cache entries
315 * DESCRIPTION: Determine the current number of "outstanding" allocations --
316 * those allocations that have not been freed and also are not
317 * in one of the various object caches.
319 ******************************************************************************/
322 AcpiDbGetOutstandingAllocations (
325 UINT32 Outstanding = 0;
327 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
329 Outstanding += AcpiDbGetCacheInfo (AcpiGbl_StateCache);
330 Outstanding += AcpiDbGetCacheInfo (AcpiGbl_PsNodeCache);
331 Outstanding += AcpiDbGetCacheInfo (AcpiGbl_PsNodeExtCache);
332 Outstanding += AcpiDbGetCacheInfo (AcpiGbl_OperandCache);
335 return (Outstanding);
339 /*******************************************************************************
341 * FUNCTION: AcpiDbExecutionWalk
343 * PARAMETERS: WALK_CALLBACK
347 * DESCRIPTION: Execute a control method. Name is relative to the current
350 ******************************************************************************/
353 AcpiDbExecutionWalk (
354 ACPI_HANDLE ObjHandle,
359 ACPI_OPERAND_OBJECT *ObjDesc;
360 ACPI_NAMESPACE_NODE *Node = (ACPI_NAMESPACE_NODE *) ObjHandle;
361 ACPI_BUFFER ReturnObj;
365 ObjDesc = AcpiNsGetAttachedObject (Node);
366 if (ObjDesc->Method.ParamCount)
371 ReturnObj.Pointer = NULL;
372 ReturnObj.Length = ACPI_ALLOCATE_BUFFER;
374 AcpiNsPrintNodePathname (Node, "Evaluating");
376 /* Do the actual method execution */
379 AcpiGbl_MethodExecuting = TRUE;
381 Status = AcpiEvaluateObject (Node, NULL, NULL, &ReturnObj);
383 AcpiOsPrintf ("Evaluation of [%4.4s] returned %s\n", AcpiUtGetNodeName (Node),
384 AcpiFormatException (Status));
385 AcpiGbl_MethodExecuting = FALSE;
391 /*******************************************************************************
393 * FUNCTION: AcpiDbExecute
395 * PARAMETERS: Name - Name of method to execute
396 * Args - Parameters to the method
397 * Flags - single step/no single step
401 * DESCRIPTION: Execute a control method. Name is relative to the current
404 ******************************************************************************/
410 ACPI_OBJECT_TYPE *Types,
414 ACPI_BUFFER ReturnObj;
418 #ifdef ACPI_DEBUG_OUTPUT
419 UINT32 PreviousAllocations;
423 /* Memory allocation tracking */
425 PreviousAllocations = AcpiDbGetOutstandingAllocations ();
430 (void) AcpiWalkNamespace (ACPI_TYPE_METHOD, ACPI_ROOT_OBJECT,
431 ACPI_UINT32_MAX, AcpiDbExecutionWalk, NULL, NULL, NULL);
436 NameString = ACPI_ALLOCATE (ACPI_STRLEN (Name) + 1);
442 ACPI_MEMSET (&AcpiGbl_DbMethodInfo, 0, sizeof (ACPI_DB_METHOD_INFO));
444 ACPI_STRCPY (NameString, Name);
445 AcpiUtStrupr (NameString);
446 AcpiGbl_DbMethodInfo.Name = NameString;
447 AcpiGbl_DbMethodInfo.Args = Args;
448 AcpiGbl_DbMethodInfo.Types = Types;
449 AcpiGbl_DbMethodInfo.Flags = Flags;
451 ReturnObj.Pointer = NULL;
452 ReturnObj.Length = ACPI_ALLOCATE_BUFFER;
454 Status = AcpiDbExecuteSetup (&AcpiGbl_DbMethodInfo);
455 if (ACPI_FAILURE (Status))
457 ACPI_FREE (NameString);
461 /* Get the NS node, determines existence also */
463 Status = AcpiGetHandle (NULL, AcpiGbl_DbMethodInfo.Pathname,
464 &AcpiGbl_DbMethodInfo.Method);
465 if (ACPI_SUCCESS (Status))
467 Status = AcpiDbExecuteMethod (&AcpiGbl_DbMethodInfo, &ReturnObj);
469 ACPI_FREE (NameString);
473 * Allow any handlers in separate threads to complete.
474 * (Such as Notify handlers invoked from AML executed above).
476 AcpiOsSleep ((UINT64) 10);
478 #ifdef ACPI_DEBUG_OUTPUT
480 /* Memory allocation tracking */
482 Allocations = AcpiDbGetOutstandingAllocations () - PreviousAllocations;
484 AcpiDbSetOutputDestination (ACPI_DB_DUPLICATE_OUTPUT);
488 AcpiOsPrintf ("0x%X Outstanding allocations after evaluation of %s\n",
489 Allocations, AcpiGbl_DbMethodInfo.Pathname);
493 if (ACPI_FAILURE (Status))
495 AcpiOsPrintf ("Evaluation of %s failed with status %s\n",
496 AcpiGbl_DbMethodInfo.Pathname, AcpiFormatException (Status));
500 /* Display a return object, if any */
502 if (ReturnObj.Length)
505 "Evaluation of %s returned object %p, external buffer length %X\n",
506 AcpiGbl_DbMethodInfo.Pathname, ReturnObj.Pointer,
507 (UINT32) ReturnObj.Length);
508 AcpiDbDumpExternalObject (ReturnObj.Pointer, 1);
510 /* Dump a _PLD buffer if present */
512 if (ACPI_COMPARE_NAME ((ACPI_CAST_PTR (ACPI_NAMESPACE_NODE,
513 AcpiGbl_DbMethodInfo.Method)->Name.Ascii), METHOD_NAME__PLD))
515 AcpiDbDumpPldBuffer (ReturnObj.Pointer);
520 AcpiOsPrintf ("No object was returned from evaluation of %s\n",
521 AcpiGbl_DbMethodInfo.Pathname);
525 AcpiDbSetOutputDestination (ACPI_DB_CONSOLE_OUTPUT);
529 /*******************************************************************************
531 * FUNCTION: AcpiDbMethodThread
533 * PARAMETERS: Context - Execution info segment
537 * DESCRIPTION: Debugger execute thread. Waits for a command line, then
538 * simply dispatches it.
540 ******************************************************************************/
542 static void ACPI_SYSTEM_XFACE
547 ACPI_DB_METHOD_INFO *Info = Context;
548 ACPI_DB_METHOD_INFO LocalInfo;
551 ACPI_BUFFER ReturnObj;
555 * AcpiGbl_DbMethodInfo.Arguments will be passed as method arguments.
556 * Prevent AcpiGbl_DbMethodInfo from being modified by multiple threads
559 * Note: The arguments we are passing are used by the ASL test suite
560 * (aslts). Do not change them without updating the tests.
562 (void) AcpiOsWaitSemaphore (Info->InfoGate, 1, ACPI_WAIT_FOREVER);
566 AcpiDbUint32ToHexString (Info->NumCreated, Info->IndexOfThreadStr);
567 AcpiDbUint32ToHexString ((UINT32) AcpiOsGetThreadId (), Info->IdOfThreadStr);
570 if (Info->Threads && (Info->NumCreated < Info->NumThreads))
572 Info->Threads[Info->NumCreated++] = AcpiOsGetThreadId();
576 LocalInfo.Args = LocalInfo.Arguments;
577 LocalInfo.Arguments[0] = LocalInfo.NumThreadsStr;
578 LocalInfo.Arguments[1] = LocalInfo.IdOfThreadStr;
579 LocalInfo.Arguments[2] = LocalInfo.IndexOfThreadStr;
580 LocalInfo.Arguments[3] = NULL;
582 LocalInfo.Types = LocalInfo.ArgTypes;
584 (void) AcpiOsSignalSemaphore (Info->InfoGate, 1);
586 for (i = 0; i < Info->NumLoops; i++)
588 Status = AcpiDbExecuteMethod (&LocalInfo, &ReturnObj);
589 if (ACPI_FAILURE (Status))
591 AcpiOsPrintf ("%s During evaluation of %s at iteration %X\n",
592 AcpiFormatException (Status), Info->Pathname, i);
593 if (Status == AE_ABORT_METHOD)
602 AcpiOsPrintf ("%u loops, Thread 0x%x\n", i, AcpiOsGetThreadId ());
605 if (ReturnObj.Length)
607 AcpiOsPrintf ("Evaluation of %s returned object %p Buflen %X\n",
608 Info->Pathname, ReturnObj.Pointer, (UINT32) ReturnObj.Length);
609 AcpiDbDumpExternalObject (ReturnObj.Pointer, 1);
614 /* Signal our completion */
617 (void) AcpiOsWaitSemaphore (Info->ThreadCompleteGate, 1, ACPI_WAIT_FOREVER);
618 Info->NumCompleted++;
620 if (Info->NumCompleted == Info->NumThreads)
622 /* Do signal for main thread once only */
626 (void) AcpiOsSignalSemaphore (Info->ThreadCompleteGate, 1);
630 Status = AcpiOsSignalSemaphore (Info->MainThreadGate, 1);
631 if (ACPI_FAILURE (Status))
633 AcpiOsPrintf ("Could not signal debugger thread sync semaphore, %s\n",
634 AcpiFormatException (Status));
640 /*******************************************************************************
642 * FUNCTION: AcpiDbCreateExecutionThreads
644 * PARAMETERS: NumThreadsArg - Number of threads to create
645 * NumLoopsArg - Loop count for the thread(s)
646 * MethodNameArg - Control method to execute
650 * DESCRIPTION: Create threads to execute method(s)
652 ******************************************************************************/
655 AcpiDbCreateExecutionThreads (
665 ACPI_MUTEX MainThreadGate;
666 ACPI_MUTEX ThreadCompleteGate;
670 /* Get the arguments */
672 NumThreads = ACPI_STRTOUL (NumThreadsArg, NULL, 0);
673 NumLoops = ACPI_STRTOUL (NumLoopsArg, NULL, 0);
675 if (!NumThreads || !NumLoops)
677 AcpiOsPrintf ("Bad argument: Threads %X, Loops %X\n",
678 NumThreads, NumLoops);
683 * Create the semaphore for synchronization of
684 * the created threads with the main thread.
686 Status = AcpiOsCreateSemaphore (1, 0, &MainThreadGate);
687 if (ACPI_FAILURE (Status))
689 AcpiOsPrintf ("Could not create semaphore for synchronization with the main thread, %s\n",
690 AcpiFormatException (Status));
695 * Create the semaphore for synchronization
696 * between the created threads.
698 Status = AcpiOsCreateSemaphore (1, 1, &ThreadCompleteGate);
699 if (ACPI_FAILURE (Status))
701 AcpiOsPrintf ("Could not create semaphore for synchronization between the created threads, %s\n",
702 AcpiFormatException (Status));
703 (void) AcpiOsDeleteSemaphore (MainThreadGate);
707 Status = AcpiOsCreateSemaphore (1, 1, &InfoGate);
708 if (ACPI_FAILURE (Status))
710 AcpiOsPrintf ("Could not create semaphore for synchronization of AcpiGbl_DbMethodInfo, %s\n",
711 AcpiFormatException (Status));
712 (void) AcpiOsDeleteSemaphore (ThreadCompleteGate);
713 (void) AcpiOsDeleteSemaphore (MainThreadGate);
717 ACPI_MEMSET (&AcpiGbl_DbMethodInfo, 0, sizeof (ACPI_DB_METHOD_INFO));
719 /* Array to store IDs of threads */
721 AcpiGbl_DbMethodInfo.NumThreads = NumThreads;
722 Size = sizeof (ACPI_THREAD_ID) * AcpiGbl_DbMethodInfo.NumThreads;
723 AcpiGbl_DbMethodInfo.Threads = AcpiOsAllocate (Size);
724 if (AcpiGbl_DbMethodInfo.Threads == NULL)
726 AcpiOsPrintf ("No memory for thread IDs array\n");
727 (void) AcpiOsDeleteSemaphore (MainThreadGate);
728 (void) AcpiOsDeleteSemaphore (ThreadCompleteGate);
729 (void) AcpiOsDeleteSemaphore (InfoGate);
732 ACPI_MEMSET (AcpiGbl_DbMethodInfo.Threads, 0, Size);
734 /* Setup the context to be passed to each thread */
736 AcpiGbl_DbMethodInfo.Name = MethodNameArg;
737 AcpiGbl_DbMethodInfo.Flags = 0;
738 AcpiGbl_DbMethodInfo.NumLoops = NumLoops;
739 AcpiGbl_DbMethodInfo.MainThreadGate = MainThreadGate;
740 AcpiGbl_DbMethodInfo.ThreadCompleteGate = ThreadCompleteGate;
741 AcpiGbl_DbMethodInfo.InfoGate = InfoGate;
743 /* Init arguments to be passed to method */
745 AcpiGbl_DbMethodInfo.InitArgs = 1;
746 AcpiGbl_DbMethodInfo.Args = AcpiGbl_DbMethodInfo.Arguments;
747 AcpiGbl_DbMethodInfo.Arguments[0] = AcpiGbl_DbMethodInfo.NumThreadsStr;
748 AcpiGbl_DbMethodInfo.Arguments[1] = AcpiGbl_DbMethodInfo.IdOfThreadStr;
749 AcpiGbl_DbMethodInfo.Arguments[2] = AcpiGbl_DbMethodInfo.IndexOfThreadStr;
750 AcpiGbl_DbMethodInfo.Arguments[3] = NULL;
752 AcpiGbl_DbMethodInfo.Types = AcpiGbl_DbMethodInfo.ArgTypes;
753 AcpiGbl_DbMethodInfo.ArgTypes[0] = ACPI_TYPE_INTEGER;
754 AcpiGbl_DbMethodInfo.ArgTypes[1] = ACPI_TYPE_INTEGER;
755 AcpiGbl_DbMethodInfo.ArgTypes[2] = ACPI_TYPE_INTEGER;
757 AcpiDbUint32ToHexString (NumThreads, AcpiGbl_DbMethodInfo.NumThreadsStr);
759 Status = AcpiDbExecuteSetup (&AcpiGbl_DbMethodInfo);
760 if (ACPI_FAILURE (Status))
765 /* Get the NS node, determines existence also */
767 Status = AcpiGetHandle (NULL, AcpiGbl_DbMethodInfo.Pathname,
768 &AcpiGbl_DbMethodInfo.Method);
769 if (ACPI_FAILURE (Status))
771 AcpiOsPrintf ("%s Could not get handle for %s\n",
772 AcpiFormatException (Status), AcpiGbl_DbMethodInfo.Pathname);
776 /* Create the threads */
778 AcpiOsPrintf ("Creating %X threads to execute %X times each\n",
779 NumThreads, NumLoops);
781 for (i = 0; i < (NumThreads); i++)
783 Status = AcpiOsExecute (OSL_DEBUGGER_THREAD, AcpiDbMethodThread,
784 &AcpiGbl_DbMethodInfo);
785 if (ACPI_FAILURE (Status))
791 /* Wait for all threads to complete */
793 (void) AcpiOsWaitSemaphore (MainThreadGate, 1, ACPI_WAIT_FOREVER);
795 AcpiDbSetOutputDestination (ACPI_DB_DUPLICATE_OUTPUT);
796 AcpiOsPrintf ("All threads (%X) have completed\n", NumThreads);
797 AcpiDbSetOutputDestination (ACPI_DB_CONSOLE_OUTPUT);
801 /* Cleanup and exit */
803 (void) AcpiOsDeleteSemaphore (MainThreadGate);
804 (void) AcpiOsDeleteSemaphore (ThreadCompleteGate);
805 (void) AcpiOsDeleteSemaphore (InfoGate);
807 AcpiOsFree (AcpiGbl_DbMethodInfo.Threads);
808 AcpiGbl_DbMethodInfo.Threads = NULL;
811 #endif /* ACPI_DEBUGGER */