1 /*******************************************************************************
3 * Module Name: dbexec - debugger control method execution
6 ******************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2005, 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 *****************************************************************************/
120 #include "acnamesp.h"
124 #define _COMPONENT ACPI_CA_DEBUGGER
125 ACPI_MODULE_NAME ("dbexec")
128 static ACPI_DB_METHOD_INFO AcpiGbl_DbMethodInfo
;
131 /*******************************************************************************
133 * FUNCTION: AcpiDbExecuteMethod
135 * PARAMETERS: Info - Valid info segment
136 * ReturnObj - Where to put return object
140 * DESCRIPTION: Execute a control method.
142 ******************************************************************************/
145 AcpiDbExecuteMethod (
146 ACPI_DB_METHOD_INFO
*Info
,
147 ACPI_BUFFER
*ReturnObj
)
150 ACPI_OBJECT_LIST ParamObjects
;
151 ACPI_OBJECT Params
[ACPI_METHOD_NUM_ARGS
];
155 if (AcpiGbl_DbOutputToFile
&& !AcpiDbgLevel
)
157 AcpiOsPrintf ("Warning: debug output is not enabled!\n");
160 /* Are there arguments to the method? */
162 if (Info
->Args
&& Info
->Args
[0])
164 for (i
= 0; Info
->Args
[i
] && i
< ACPI_METHOD_NUM_ARGS
; i
++)
166 Params
[i
].Type
= ACPI_TYPE_INTEGER
;
167 Params
[i
].Integer
.Value
= ACPI_STRTOUL (Info
->Args
[i
], NULL
, 16);
170 ParamObjects
.Pointer
= Params
;
171 ParamObjects
.Count
= i
;
175 /* Setup default parameters */
177 Params
[0].Type
= ACPI_TYPE_INTEGER
;
178 Params
[0].Integer
.Value
= 0x01020304;
180 Params
[1].Type
= ACPI_TYPE_STRING
;
181 Params
[1].String
.Length
= 12;
182 Params
[1].String
.Pointer
= "AML Debugger";
184 ParamObjects
.Pointer
= Params
;
185 ParamObjects
.Count
= 2;
188 /* Prepare for a return object of arbitrary size */
190 ReturnObj
->Pointer
= AcpiGbl_DbBuffer
;
191 ReturnObj
->Length
= ACPI_DEBUG_BUFFER_SIZE
;
193 /* Do the actual method execution */
195 AcpiGbl_MethodExecuting
= TRUE
;
196 Status
= AcpiEvaluateObject (NULL
, Info
->Pathname
, &ParamObjects
, ReturnObj
);
198 AcpiGbl_CmSingleStep
= FALSE
;
199 AcpiGbl_MethodExecuting
= FALSE
;
205 /*******************************************************************************
207 * FUNCTION: AcpiDbExecuteSetup
209 * PARAMETERS: Info - Valid method info
213 * DESCRIPTION: Setup info segment prior to method execution
215 ******************************************************************************/
219 ACPI_DB_METHOD_INFO
*Info
)
222 /* Catenate the current scope to the supplied name */
224 Info
->Pathname
[0] = 0;
225 if ((Info
->Name
[0] != '\\') &&
226 (Info
->Name
[0] != '/'))
228 ACPI_STRCAT (Info
->Pathname
, AcpiGbl_DbScopeBuf
);
231 ACPI_STRCAT (Info
->Pathname
, Info
->Name
);
232 AcpiDbPrepNamestring (Info
->Pathname
);
234 AcpiDbSetOutputDestination (ACPI_DB_DUPLICATE_OUTPUT
);
235 AcpiOsPrintf ("Executing %s\n", Info
->Pathname
);
237 if (Info
->Flags
& EX_SINGLE_STEP
)
239 AcpiGbl_CmSingleStep
= TRUE
;
240 AcpiDbSetOutputDestination (ACPI_DB_CONSOLE_OUTPUT
);
245 /* No single step, allow redirection to a file */
247 AcpiDbSetOutputDestination (ACPI_DB_REDIRECTABLE_OUTPUT
);
252 /*******************************************************************************
254 * FUNCTION: AcpiDbGetOutstandingAllocations
258 * RETURN: Current global allocation count minus cache entries
260 * DESCRIPTION: Determine the current number of "outstanding" allocations --
261 * those allocations that have not been freed and also are not
262 * in one of the various object caches.
264 ******************************************************************************/
267 AcpiDbGetOutstandingAllocations (
270 UINT32 Outstanding
= 0;
272 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
276 for (i
= ACPI_MEM_LIST_FIRST_CACHE_LIST
; i
< ACPI_NUM_MEM_LISTS
; i
++)
278 Outstanding
+= (AcpiGbl_MemoryLists
[i
].TotalAllocated
-
279 AcpiGbl_MemoryLists
[i
].TotalFreed
-
280 AcpiGbl_MemoryLists
[i
].CacheDepth
);
284 return (Outstanding
);
288 /*******************************************************************************
290 * FUNCTION: AcpiDbExecutionWalk
292 * PARAMETERS: WALK_CALLBACK
296 * DESCRIPTION: Execute a control method. Name is relative to the current
299 ******************************************************************************/
302 AcpiDbExecutionWalk (
303 ACPI_HANDLE ObjHandle
,
308 ACPI_OPERAND_OBJECT
*ObjDesc
;
309 ACPI_NAMESPACE_NODE
*Node
= (ACPI_NAMESPACE_NODE
*) ObjHandle
;
310 ACPI_BUFFER ReturnObj
;
314 ObjDesc
= AcpiNsGetAttachedObject (Node
);
315 if (ObjDesc
->Method
.ParamCount
)
320 ReturnObj
.Pointer
= NULL
;
321 ReturnObj
.Length
= ACPI_ALLOCATE_BUFFER
;
323 AcpiNsPrintNodePathname (Node
, "Execute");
325 /* Do the actual method execution */
328 AcpiGbl_MethodExecuting
= TRUE
;
330 Status
= AcpiEvaluateObject (Node
, NULL
, NULL
, &ReturnObj
);
332 AcpiOsPrintf ("[%4.4s] returned %s\n", AcpiUtGetNodeName (Node
),
333 AcpiFormatException (Status
));
334 AcpiGbl_MethodExecuting
= FALSE
;
340 /*******************************************************************************
342 * FUNCTION: AcpiDbExecute
344 * PARAMETERS: Name - Name of method to execute
345 * Args - Parameters to the method
346 * Flags - single step/no single step
350 * DESCRIPTION: Execute a control method. Name is relative to the current
353 ******************************************************************************/
362 ACPI_BUFFER ReturnObj
;
365 #ifdef ACPI_DEBUG_OUTPUT
366 UINT32 PreviousAllocations
;
370 /* Memory allocation tracking */
372 PreviousAllocations
= AcpiDbGetOutstandingAllocations ();
377 (void) AcpiWalkNamespace (ACPI_TYPE_METHOD
, ACPI_ROOT_OBJECT
, ACPI_UINT32_MAX
,
378 AcpiDbExecutionWalk
, NULL
, NULL
);
383 AcpiGbl_DbMethodInfo
.Name
= Name
;
384 AcpiGbl_DbMethodInfo
.Args
= Args
;
385 AcpiGbl_DbMethodInfo
.Flags
= Flags
;
387 ReturnObj
.Pointer
= NULL
;
388 ReturnObj
.Length
= ACPI_ALLOCATE_BUFFER
;
390 AcpiDbExecuteSetup (&AcpiGbl_DbMethodInfo
);
391 Status
= AcpiDbExecuteMethod (&AcpiGbl_DbMethodInfo
, &ReturnObj
);
395 * Allow any handlers in separate threads to complete.
396 * (Such as Notify handlers invoked from AML executed above).
401 #ifdef ACPI_DEBUG_OUTPUT
403 /* Memory allocation tracking */
405 Allocations
= AcpiDbGetOutstandingAllocations () - PreviousAllocations
;
407 AcpiDbSetOutputDestination (ACPI_DB_DUPLICATE_OUTPUT
);
411 AcpiOsPrintf ("Outstanding: 0x%X allocations after execution\n",
416 if (ACPI_FAILURE (Status
))
418 AcpiOsPrintf ("Execution of %s failed with status %s\n",
419 AcpiGbl_DbMethodInfo
.Pathname
, AcpiFormatException (Status
));
424 /* Display a return object, if any */
426 if (ReturnObj
.Length
)
428 AcpiOsPrintf ("Execution of %s returned object %p Buflen %X\n",
429 AcpiGbl_DbMethodInfo
.Pathname
, ReturnObj
.Pointer
,
430 (UINT32
) ReturnObj
.Length
);
431 AcpiDbDumpObject (ReturnObj
.Pointer
, 1);
435 AcpiOsPrintf ("No return object from execution of %s\n",
436 AcpiGbl_DbMethodInfo
.Pathname
);
440 AcpiDbSetOutputDestination (ACPI_DB_CONSOLE_OUTPUT
);
444 /*******************************************************************************
446 * FUNCTION: AcpiDbMethodThread
448 * PARAMETERS: Context - Execution info segment
452 * DESCRIPTION: Debugger execute thread. Waits for a command line, then
453 * simply dispatches it.
455 ******************************************************************************/
457 void ACPI_SYSTEM_XFACE
462 ACPI_DB_METHOD_INFO
*Info
= Context
;
464 ACPI_BUFFER ReturnObj
;
467 for (i
= 0; i
< Info
->NumLoops
; i
++)
472 AcpiDbgLevel
= 0x00FFFFFF;
476 Status
= AcpiDbExecuteMethod (Info
, &ReturnObj
);
477 if (ACPI_FAILURE (Status
))
479 AcpiOsPrintf ("%s During execution of %s at iteration %X\n",
480 AcpiFormatException (Status
), Info
->Pathname
, i
);
481 if (Status
== AE_ABORT_METHOD
)
489 AcpiOsPrintf ("%d executions\n", i
);
493 if (ReturnObj
.Length
)
495 AcpiOsPrintf ("Execution of %s returned object %p Buflen %X\n",
496 Info
->Pathname
, ReturnObj
.Pointer
, (UINT32
) ReturnObj
.Length
);
497 AcpiDbDumpObject (ReturnObj
.Pointer
, 1);
502 /* Signal our completion */
504 Status
= AcpiOsSignalSemaphore (Info
->ThreadGate
, 1);
505 if (ACPI_FAILURE (Status
))
507 AcpiOsPrintf ("Could not signal debugger semaphore\n");
512 /*******************************************************************************
514 * FUNCTION: AcpiDbCreateExecutionThreads
516 * PARAMETERS: NumThreadsArg - Number of threads to create
517 * NumLoopsArg - Loop count for the thread(s)
518 * MethodNameArg - Control method to execute
522 * DESCRIPTION: Create threads to execute method(s)
524 ******************************************************************************/
527 AcpiDbCreateExecutionThreads (
536 ACPI_HANDLE ThreadGate
;
539 /* Get the arguments */
541 NumThreads
= ACPI_STRTOUL (NumThreadsArg
, NULL
, 0);
542 NumLoops
= ACPI_STRTOUL (NumLoopsArg
, NULL
, 0);
544 if (!NumThreads
|| !NumLoops
)
546 AcpiOsPrintf ("Bad argument: Threads %X, Loops %X\n", NumThreads
, NumLoops
);
550 /* Create the synchronization semaphore */
552 Status
= AcpiOsCreateSemaphore (1, 0, &ThreadGate
);
553 if (ACPI_FAILURE (Status
))
555 AcpiOsPrintf ("Could not create semaphore, %s\n", AcpiFormatException (Status
));
559 /* Setup the context to be passed to each thread */
561 AcpiGbl_DbMethodInfo
.Name
= MethodNameArg
;
562 AcpiGbl_DbMethodInfo
.Args
= NULL
;
563 AcpiGbl_DbMethodInfo
.Flags
= 0;
564 AcpiGbl_DbMethodInfo
.NumLoops
= NumLoops
;
565 AcpiGbl_DbMethodInfo
.ThreadGate
= ThreadGate
;
567 AcpiDbExecuteSetup (&AcpiGbl_DbMethodInfo
);
569 /* Create the threads */
571 AcpiOsPrintf ("Creating %X threads to execute %X times each\n", NumThreads
, NumLoops
);
573 for (i
= 0; i
< (NumThreads
); i
++)
575 Status
= AcpiOsQueueForExecution (OSD_PRIORITY_MED
, AcpiDbMethodThread
, &AcpiGbl_DbMethodInfo
);
576 if (ACPI_FAILURE (Status
))
582 /* Wait for all threads to complete */
585 while (i
) /* Brain damage for OSD implementations that only support wait of 1 unit */
587 Status
= AcpiOsWaitSemaphore (ThreadGate
, 1, ACPI_WAIT_FOREVER
);
591 /* Cleanup and exit */
593 (void) AcpiOsDeleteSemaphore (ThreadGate
);
595 AcpiDbSetOutputDestination (ACPI_DB_DUPLICATE_OUTPUT
);
596 AcpiOsPrintf ("All threads (%X) have completed\n", NumThreads
);
597 AcpiDbSetOutputDestination (ACPI_DB_CONSOLE_OUTPUT
);
601 #endif /* ACPI_DEBUGGER */