1 /******************************************************************************
3 * Module Name: dsmethod - Parser/Interpreter interface - control method parsing
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2017, Intel Corp.
12 * All rights reserved.
16 * 2.1. This is your license from Intel Corp. under its intellectual property
17 * rights. You may have additional license terms from the party that provided
18 * you this software, covering your right to use that party's intellectual
21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22 * copy of the source code appearing in this file ("Covered Code") an
23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24 * base code distributed originally by Intel ("Original Intel Code") to copy,
25 * make derivatives, distribute, use and display any portion of the Covered
26 * Code in any form, with the right to sublicense such rights; and
28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29 * license (with the right to sublicense), under only those claims of Intel
30 * patents that are infringed by the Original Intel Code, to make, use, sell,
31 * offer to sell, and import the Covered Code and derivative works thereof
32 * solely to the minimum extent necessary to exercise the above copyright
33 * license, and in no event shall the patent license extend to any additions
34 * to or modifications of the Original Intel Code. No other license or right
35 * is granted directly or by implication, estoppel or otherwise;
37 * The above copyright and patent license is granted only if the following
42 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43 * Redistribution of source code of any substantial portion of the Covered
44 * Code or modification with rights to further distribute source must include
45 * the above Copyright Notice, the above License, this list of Conditions,
46 * and the following Disclaimer and Export Compliance provision. In addition,
47 * Licensee must cause all Covered Code to which Licensee contributes to
48 * contain a file documenting the changes Licensee made to create that Covered
49 * Code and the date of any change. Licensee must include in that file the
50 * documentation of any changes made by any predecessor Licensee. Licensee
51 * must include a prominent statement that the modification is derived,
52 * directly or indirectly, from Original Intel Code.
54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55 * Redistribution of source code of any substantial portion of the Covered
56 * Code or modification without rights to further distribute source must
57 * include the following Disclaimer and Export Compliance provision in the
58 * documentation and/or other materials provided with distribution. In
59 * addition, Licensee may not authorize further sublicense of source of any
60 * portion of the Covered Code, and must include terms to the effect that the
61 * license from Licensee to its licensee is limited to the intellectual
62 * property embodied in the software Licensee provides to its licensee, and
63 * not to intellectual property embodied in modifications its licensee may
66 * 3.3. Redistribution of Executable. Redistribution in executable form of any
67 * substantial portion of the Covered Code or modification must reproduce the
68 * above Copyright Notice, and the following Disclaimer and Export Compliance
69 * provision in the documentation and/or other materials provided with the
72 * 3.4. Intel retains all right, title, and interest in and to the Original
75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76 * Intel shall be used in advertising or otherwise to promote the sale, use or
77 * other dealings in products derived from or relating to the Covered Code
78 * without prior written authorization from Intel.
80 * 4. Disclaimer and Export Compliance
82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
99 * 4.3. Licensee shall not export, either directly or indirectly, any of this
100 * software or system incorporating such software without first obtaining any
101 * required license or other approval from the U. S. Department of Commerce or
102 * any other agency or department of the United States Government. In the
103 * event Licensee exports any such software from the United States or
104 * re-exports any such software from a foreign destination, Licensee shall
105 * ensure that the distribution and export/re-export of the software is in
106 * compliance with all laws, regulations, orders, or other restrictions of the
107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108 * any of its subsidiaries will export/re-export any technical data, process,
109 * software, or service, directly or indirectly, to any country for which the
110 * United States government or any agency thereof requires an export license,
111 * other governmental approval, or letter of assurance, without first obtaining
112 * such license, approval or letter.
114 *****************************************************************************
116 * Alternatively, you may choose to be licensed under the terms of the
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
122 * 1. Redistributions of source code must retain the above copyright
123 * notice, this list of conditions, and the following disclaimer,
124 * without modification.
125 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126 * substantially similar to the "NO WARRANTY" disclaimer below
127 * ("Disclaimer") and any redistribution must be conditioned upon
128 * including a substantially similar Disclaimer requirement for further
129 * binary redistribution.
130 * 3. Neither the names of the above-listed copyright holders nor the names
131 * of any contributors may be used to endorse or promote products derived
132 * from this software without specific prior written permission.
134 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
146 * Alternatively, you may choose to be licensed under the terms of the
147 * GNU General Public License ("GPL") version 2 as published by the Free
148 * Software Foundation.
150 *****************************************************************************/
152 #include <contrib/dev/acpica/include/acpi.h>
153 #include <contrib/dev/acpica/include/accommon.h>
154 #include <contrib/dev/acpica/include/acdispat.h>
155 #include <contrib/dev/acpica/include/acinterp.h>
156 #include <contrib/dev/acpica/include/acnamesp.h>
157 #include <contrib/dev/acpica/include/acparser.h>
158 #include <contrib/dev/acpica/include/amlcode.h>
159 #include <contrib/dev/acpica/include/acdebug.h>
162 #define _COMPONENT ACPI_DISPATCHER
163 ACPI_MODULE_NAME ("dsmethod")
165 /* Local prototypes */
168 AcpiDsDetectNamedOpcodes (
169 ACPI_WALK_STATE *WalkState,
170 ACPI_PARSE_OBJECT **OutOp);
173 AcpiDsCreateMethodMutex (
174 ACPI_OPERAND_OBJECT *MethodDesc);
177 /*******************************************************************************
179 * FUNCTION: AcpiDsAutoSerializeMethod
181 * PARAMETERS: Node - Namespace Node of the method
182 * ObjDesc - Method object attached to node
186 * DESCRIPTION: Parse a control method AML to scan for control methods that
187 * need serialization due to the creation of named objects.
189 * NOTE: It is a bit of overkill to mark all such methods serialized, since
190 * there is only a problem if the method actually blocks during execution.
191 * A blocking operation is, for example, a Sleep() operation, or any access
192 * to an operation region. However, it is probably not possible to easily
193 * detect whether a method will block or not, so we simply mark all suspicious
194 * methods as serialized.
196 * NOTE2: This code is essentially a generic routine for parsing a single
199 ******************************************************************************/
202 AcpiDsAutoSerializeMethod (
203 ACPI_NAMESPACE_NODE *Node,
204 ACPI_OPERAND_OBJECT *ObjDesc)
207 ACPI_PARSE_OBJECT *Op = NULL;
208 ACPI_WALK_STATE *WalkState;
211 ACPI_FUNCTION_TRACE_PTR (DsAutoSerializeMethod, Node);
214 ACPI_DEBUG_PRINT ((ACPI_DB_PARSE,
215 "Method auto-serialization parse [%4.4s] %p\n",
216 AcpiUtGetNodeName (Node), Node));
218 /* Create/Init a root op for the method parse tree */
220 Op = AcpiPsAllocOp (AML_METHOD_OP, ObjDesc->Method.AmlStart);
223 return_ACPI_STATUS (AE_NO_MEMORY);
226 AcpiPsSetName (Op, Node->Name.Integer);
227 Op->Common.Node = Node;
229 /* Create and initialize a new walk state */
231 WalkState = AcpiDsCreateWalkState (Node->OwnerId, NULL, NULL, NULL);
235 return_ACPI_STATUS (AE_NO_MEMORY);
238 Status = AcpiDsInitAmlWalk (WalkState, Op, Node,
239 ObjDesc->Method.AmlStart, ObjDesc->Method.AmlLength, NULL, 0);
240 if (ACPI_FAILURE (Status))
242 AcpiDsDeleteWalkState (WalkState);
244 return_ACPI_STATUS (Status);
247 WalkState->DescendingCallback = AcpiDsDetectNamedOpcodes;
249 /* Parse the method, scan for creation of named objects */
251 Status = AcpiPsParseAml (WalkState);
253 AcpiPsDeleteParseTree (Op);
254 return_ACPI_STATUS (Status);
258 /*******************************************************************************
260 * FUNCTION: AcpiDsDetectNamedOpcodes
262 * PARAMETERS: WalkState - Current state of the parse tree walk
263 * OutOp - Unused, required for parser interface
267 * DESCRIPTION: Descending callback used during the loading of ACPI tables.
268 * Currently used to detect methods that must be marked serialized
269 * in order to avoid problems with the creation of named objects.
271 ******************************************************************************/
274 AcpiDsDetectNamedOpcodes (
275 ACPI_WALK_STATE *WalkState,
276 ACPI_PARSE_OBJECT **OutOp)
279 ACPI_FUNCTION_NAME (AcpiDsDetectNamedOpcodes);
282 /* We are only interested in opcodes that create a new name */
284 if (!(WalkState->OpInfo->Flags & (AML_NAMED | AML_CREATE | AML_FIELD)))
290 * At this point, we know we have a Named object opcode.
291 * Mark the method as serialized. Later code will create a mutex for
292 * this method to enforce serialization.
294 * Note, ACPI_METHOD_IGNORE_SYNC_LEVEL flag means that we will ignore the
295 * Sync Level mechanism for this method, even though it is now serialized.
296 * Otherwise, there can be conflicts with existing ASL code that actually
299 WalkState->MethodDesc->Method.SyncLevel = 0;
300 WalkState->MethodDesc->Method.InfoFlags |=
301 (ACPI_METHOD_SERIALIZED | ACPI_METHOD_IGNORE_SYNC_LEVEL);
303 ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
304 "Method serialized [%4.4s] %p - [%s] (%4.4X)\n",
305 WalkState->MethodNode->Name.Ascii, WalkState->MethodNode,
306 WalkState->OpInfo->Name, WalkState->Opcode));
308 /* Abort the parse, no need to examine this method any further */
310 return (AE_CTRL_TERMINATE);
314 /*******************************************************************************
316 * FUNCTION: AcpiDsMethodError
318 * PARAMETERS: Status - Execution status
319 * WalkState - Current state
323 * DESCRIPTION: Called on method error. Invoke the global exception handler if
324 * present, dump the method data if the debugger is configured
326 * Note: Allows the exception handler to change the status code
328 ******************************************************************************/
333 ACPI_WALK_STATE *WalkState)
338 ACPI_FUNCTION_ENTRY ();
341 /* Ignore AE_OK and control exception codes */
343 if (ACPI_SUCCESS (Status) ||
344 (Status & AE_CODE_CONTROL))
349 /* Invoke the global exception handler */
351 if (AcpiGbl_ExceptionHandler)
353 /* Exit the interpreter, allow handler to execute methods */
355 AcpiExExitInterpreter ();
358 * Handler can map the exception code to anything it wants, including
359 * AE_OK, in which case the executing method will not be aborted.
361 AmlOffset = (UINT32) ACPI_PTR_DIFF (WalkState->Aml,
362 WalkState->ParserState.AmlStart);
364 Status = AcpiGbl_ExceptionHandler (Status,
365 WalkState->MethodNode ?
366 WalkState->MethodNode->Name.Integer : 0,
367 WalkState->Opcode, AmlOffset, NULL);
368 AcpiExEnterInterpreter ();
371 AcpiDsClearImplicitReturn (WalkState);
373 if (ACPI_FAILURE (Status))
375 AcpiDsDumpMethodStack (Status, WalkState, WalkState->Op);
377 /* Display method locals/args if debugger is present */
380 AcpiDbDumpMethodInfo (Status, WalkState);
388 /*******************************************************************************
390 * FUNCTION: AcpiDsCreateMethodMutex
392 * PARAMETERS: ObjDesc - The method object
396 * DESCRIPTION: Create a mutex object for a serialized control method
398 ******************************************************************************/
401 AcpiDsCreateMethodMutex (
402 ACPI_OPERAND_OBJECT *MethodDesc)
404 ACPI_OPERAND_OBJECT *MutexDesc;
408 ACPI_FUNCTION_TRACE (DsCreateMethodMutex);
411 /* Create the new mutex object */
413 MutexDesc = AcpiUtCreateInternalObject (ACPI_TYPE_MUTEX);
416 return_ACPI_STATUS (AE_NO_MEMORY);
419 /* Create the actual OS Mutex */
421 Status = AcpiOsCreateMutex (&MutexDesc->Mutex.OsMutex);
422 if (ACPI_FAILURE (Status))
424 AcpiUtDeleteObjectDesc (MutexDesc);
425 return_ACPI_STATUS (Status);
428 MutexDesc->Mutex.SyncLevel = MethodDesc->Method.SyncLevel;
429 MethodDesc->Method.Mutex = MutexDesc;
430 return_ACPI_STATUS (AE_OK);
434 /*******************************************************************************
436 * FUNCTION: AcpiDsBeginMethodExecution
438 * PARAMETERS: MethodNode - Node of the method
439 * ObjDesc - The method object
440 * WalkState - current state, NULL if not yet executing
445 * DESCRIPTION: Prepare a method for execution. Parses the method if necessary,
446 * increments the thread count, and waits at the method semaphore
447 * for clearance to execute.
449 ******************************************************************************/
452 AcpiDsBeginMethodExecution (
453 ACPI_NAMESPACE_NODE *MethodNode,
454 ACPI_OPERAND_OBJECT *ObjDesc,
455 ACPI_WALK_STATE *WalkState)
457 ACPI_STATUS Status = AE_OK;
460 ACPI_FUNCTION_TRACE_PTR (DsBeginMethodExecution, MethodNode);
465 return_ACPI_STATUS (AE_NULL_ENTRY);
468 AcpiExStartTraceMethod (MethodNode, ObjDesc, WalkState);
470 /* Prevent wraparound of thread count */
472 if (ObjDesc->Method.ThreadCount == ACPI_UINT8_MAX)
474 ACPI_ERROR ((AE_INFO,
475 "Method reached maximum reentrancy limit (255)"));
476 return_ACPI_STATUS (AE_AML_METHOD_LIMIT);
480 * If this method is serialized, we need to acquire the method mutex.
482 if (ObjDesc->Method.InfoFlags & ACPI_METHOD_SERIALIZED)
485 * Create a mutex for the method if it is defined to be Serialized
486 * and a mutex has not already been created. We defer the mutex creation
487 * until a method is actually executed, to minimize the object count
489 if (!ObjDesc->Method.Mutex)
491 Status = AcpiDsCreateMethodMutex (ObjDesc);
492 if (ACPI_FAILURE (Status))
494 return_ACPI_STATUS (Status);
499 * The CurrentSyncLevel (per-thread) must be less than or equal to
500 * the sync level of the method. This mechanism provides some
501 * deadlock prevention.
503 * If the method was auto-serialized, we just ignore the sync level
504 * mechanism, because auto-serialization of methods can interfere
505 * with ASL code that actually uses sync levels.
507 * Top-level method invocation has no walk state at this point
510 (!(ObjDesc->Method.InfoFlags & ACPI_METHOD_IGNORE_SYNC_LEVEL)) &&
511 (WalkState->Thread->CurrentSyncLevel >
512 ObjDesc->Method.Mutex->Mutex.SyncLevel))
514 ACPI_ERROR ((AE_INFO,
515 "Cannot acquire Mutex for method [%4.4s]"
516 ", current SyncLevel is too large (%u)",
517 AcpiUtGetNodeName (MethodNode),
518 WalkState->Thread->CurrentSyncLevel));
520 return_ACPI_STATUS (AE_AML_MUTEX_ORDER);
524 * Obtain the method mutex if necessary. Do not acquire mutex for a
528 !ObjDesc->Method.Mutex->Mutex.ThreadId ||
529 (WalkState->Thread->ThreadId !=
530 ObjDesc->Method.Mutex->Mutex.ThreadId))
533 * Acquire the method mutex. This releases the interpreter if we
534 * block (and reacquires it before it returns)
536 Status = AcpiExSystemWaitMutex (
537 ObjDesc->Method.Mutex->Mutex.OsMutex, ACPI_WAIT_FOREVER);
538 if (ACPI_FAILURE (Status))
540 return_ACPI_STATUS (Status);
543 /* Update the mutex and walk info and save the original SyncLevel */
547 ObjDesc->Method.Mutex->Mutex.OriginalSyncLevel =
548 WalkState->Thread->CurrentSyncLevel;
550 ObjDesc->Method.Mutex->Mutex.ThreadId =
551 WalkState->Thread->ThreadId;
554 * Update the current SyncLevel only if this is not an auto-
555 * serialized method. In the auto case, we have to ignore
556 * the sync level for the method mutex (created for the
557 * auto-serialization) because we have no idea of what the
558 * sync level should be. Therefore, just ignore it.
560 if (!(ObjDesc->Method.InfoFlags &
561 ACPI_METHOD_IGNORE_SYNC_LEVEL))
563 WalkState->Thread->CurrentSyncLevel =
564 ObjDesc->Method.SyncLevel;
569 ObjDesc->Method.Mutex->Mutex.OriginalSyncLevel =
570 ObjDesc->Method.Mutex->Mutex.SyncLevel;
572 ObjDesc->Method.Mutex->Mutex.ThreadId =
573 AcpiOsGetThreadId ();
577 /* Always increase acquisition depth */
579 ObjDesc->Method.Mutex->Mutex.AcquisitionDepth++;
583 * Allocate an Owner ID for this method, only if this is the first thread
584 * to begin concurrent execution. We only need one OwnerId, even if the
585 * method is invoked recursively.
587 if (!ObjDesc->Method.OwnerId)
589 Status = AcpiUtAllocateOwnerId (&ObjDesc->Method.OwnerId);
590 if (ACPI_FAILURE (Status))
597 * Increment the method parse tree thread count since it has been
598 * reentered one more time (even if it is the same thread)
600 ObjDesc->Method.ThreadCount++;
602 return_ACPI_STATUS (Status);
606 /* On error, must release the method mutex (if present) */
608 if (ObjDesc->Method.Mutex)
610 AcpiOsReleaseMutex (ObjDesc->Method.Mutex->Mutex.OsMutex);
612 return_ACPI_STATUS (Status);
616 /*******************************************************************************
618 * FUNCTION: AcpiDsCallControlMethod
620 * PARAMETERS: Thread - Info for this thread
621 * ThisWalkState - Current walk state
622 * Op - Current Op to be walked
626 * DESCRIPTION: Transfer execution to a called control method
628 ******************************************************************************/
631 AcpiDsCallControlMethod (
632 ACPI_THREAD_STATE *Thread,
633 ACPI_WALK_STATE *ThisWalkState,
634 ACPI_PARSE_OBJECT *Op)
637 ACPI_NAMESPACE_NODE *MethodNode;
638 ACPI_WALK_STATE *NextWalkState = NULL;
639 ACPI_OPERAND_OBJECT *ObjDesc;
640 ACPI_EVALUATE_INFO *Info;
644 ACPI_FUNCTION_TRACE_PTR (DsCallControlMethod, ThisWalkState);
646 ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH,
647 "Calling method %p, currentstate=%p\n",
648 ThisWalkState->PrevOp, ThisWalkState));
651 * Get the namespace entry for the control method we are about to call
653 MethodNode = ThisWalkState->MethodCallNode;
656 return_ACPI_STATUS (AE_NULL_ENTRY);
659 ObjDesc = AcpiNsGetAttachedObject (MethodNode);
662 return_ACPI_STATUS (AE_NULL_OBJECT);
665 /* Init for new method, possibly wait on method mutex */
667 Status = AcpiDsBeginMethodExecution (
668 MethodNode, ObjDesc, ThisWalkState);
669 if (ACPI_FAILURE (Status))
671 return_ACPI_STATUS (Status);
674 /* Begin method parse/execution. Create a new walk state */
676 NextWalkState = AcpiDsCreateWalkState (
677 ObjDesc->Method.OwnerId, NULL, ObjDesc, Thread);
680 Status = AE_NO_MEMORY;
685 * The resolved arguments were put on the previous walk state's operand
686 * stack. Operands on the previous walk state stack always
687 * start at index 0. Also, null terminate the list of arguments
689 ThisWalkState->Operands [ThisWalkState->NumOperands] = NULL;
692 * Allocate and initialize the evaluation information block
693 * TBD: this is somewhat inefficient, should change interface to
694 * DsInitAmlWalk. For now, keeps this struct off the CPU stack
696 Info = ACPI_ALLOCATE_ZEROED (sizeof (ACPI_EVALUATE_INFO));
699 Status = AE_NO_MEMORY;
703 Info->Parameters = &ThisWalkState->Operands[0];
705 Status = AcpiDsInitAmlWalk (NextWalkState, NULL, MethodNode,
706 ObjDesc->Method.AmlStart, ObjDesc->Method.AmlLength,
707 Info, ACPI_IMODE_EXECUTE);
710 if (ACPI_FAILURE (Status))
716 * Delete the operands on the previous walkstate operand stack
717 * (they were copied to new objects)
719 for (i = 0; i < ObjDesc->Method.ParamCount; i++)
721 AcpiUtRemoveReference (ThisWalkState->Operands [i]);
722 ThisWalkState->Operands [i] = NULL;
725 /* Clear the operand stack */
727 ThisWalkState->NumOperands = 0;
729 ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH,
730 "**** Begin nested execution of [%4.4s] **** WalkState=%p\n",
731 MethodNode->Name.Ascii, NextWalkState));
733 /* Invoke an internal method if necessary */
735 if (ObjDesc->Method.InfoFlags & ACPI_METHOD_INTERNAL_ONLY)
737 Status = ObjDesc->Method.Dispatch.Implementation (NextWalkState);
740 Status = AE_CTRL_TERMINATE;
744 return_ACPI_STATUS (Status);
749 /* On error, we must terminate the method properly */
751 AcpiDsTerminateControlMethod (ObjDesc, NextWalkState);
752 AcpiDsDeleteWalkState (NextWalkState);
754 return_ACPI_STATUS (Status);
758 /*******************************************************************************
760 * FUNCTION: AcpiDsRestartControlMethod
762 * PARAMETERS: WalkState - State for preempted method (caller)
763 * ReturnDesc - Return value from the called method
767 * DESCRIPTION: Restart a method that was preempted by another (nested) method
768 * invocation. Handle the return value (if any) from the callee.
770 ******************************************************************************/
773 AcpiDsRestartControlMethod (
774 ACPI_WALK_STATE *WalkState,
775 ACPI_OPERAND_OBJECT *ReturnDesc)
778 int SameAsImplicitReturn;
781 ACPI_FUNCTION_TRACE_PTR (DsRestartControlMethod, WalkState);
784 ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH,
785 "****Restart [%4.4s] Op %p ReturnValueFromCallee %p\n",
786 AcpiUtGetNodeName (WalkState->MethodNode),
787 WalkState->MethodCallOp, ReturnDesc));
789 ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH,
790 " ReturnFromThisMethodUsed?=%X ResStack %p Walk %p\n",
791 WalkState->ReturnUsed,
792 WalkState->Results, WalkState));
794 /* Did the called method return a value? */
798 /* Is the implicit return object the same as the return desc? */
800 SameAsImplicitReturn = (WalkState->ImplicitReturnObj == ReturnDesc);
802 /* Are we actually going to use the return value? */
804 if (WalkState->ReturnUsed)
806 /* Save the return value from the previous method */
808 Status = AcpiDsResultPush (ReturnDesc, WalkState);
809 if (ACPI_FAILURE (Status))
811 AcpiUtRemoveReference (ReturnDesc);
812 return_ACPI_STATUS (Status);
816 * Save as THIS method's return value in case it is returned
817 * immediately to yet another method
819 WalkState->ReturnDesc = ReturnDesc;
823 * The following code is the optional support for the so-called
824 * "implicit return". Some AML code assumes that the last value of the
825 * method is "implicitly" returned to the caller, in the absence of an
826 * explicit return value.
828 * Just save the last result of the method as the return value.
830 * NOTE: this is optional because the ASL language does not actually
831 * support this behavior.
833 else if (!AcpiDsDoImplicitReturn (ReturnDesc, WalkState, FALSE) ||
834 SameAsImplicitReturn)
837 * Delete the return value if it will not be used by the
838 * calling method or remove one reference if the explicit return
839 * is the same as the implicit return value.
841 AcpiUtRemoveReference (ReturnDesc);
845 return_ACPI_STATUS (AE_OK);
849 /*******************************************************************************
851 * FUNCTION: AcpiDsTerminateControlMethod
853 * PARAMETERS: MethodDesc - Method object
854 * WalkState - State associated with the method
858 * DESCRIPTION: Terminate a control method. Delete everything that the method
859 * created, delete all locals and arguments, and delete the parse
862 * MUTEX: Interpreter is locked
864 ******************************************************************************/
867 AcpiDsTerminateControlMethod (
868 ACPI_OPERAND_OBJECT *MethodDesc,
869 ACPI_WALK_STATE *WalkState)
872 ACPI_FUNCTION_TRACE_PTR (DsTerminateControlMethod, WalkState);
875 /* MethodDesc is required, WalkState is optional */
884 /* Delete all arguments and locals */
886 AcpiDsMethodDataDeleteAll (WalkState);
889 * Delete any namespace objects created anywhere within the
890 * namespace by the execution of this method. Unless:
891 * 1) This method is a module-level executable code method, in which
892 * case we want make the objects permanent.
893 * 2) There are other threads executing the method, in which case we
894 * will wait until the last thread has completed.
896 if (!(MethodDesc->Method.InfoFlags & ACPI_METHOD_MODULE_LEVEL) &&
897 (MethodDesc->Method.ThreadCount == 1))
899 /* Delete any direct children of (created by) this method */
901 (void) AcpiExExitInterpreter ();
902 AcpiNsDeleteNamespaceSubtree (WalkState->MethodNode);
903 (void) AcpiExEnterInterpreter ();
906 * Delete any objects that were created by this method
907 * elsewhere in the namespace (if any were created).
908 * Use of the ACPI_METHOD_MODIFIED_NAMESPACE optimizes the
909 * deletion such that we don't have to perform an entire
910 * namespace walk for every control method execution.
912 if (MethodDesc->Method.InfoFlags & ACPI_METHOD_MODIFIED_NAMESPACE)
914 (void) AcpiExExitInterpreter ();
915 AcpiNsDeleteNamespaceByOwner (MethodDesc->Method.OwnerId);
916 (void) AcpiExEnterInterpreter ();
917 MethodDesc->Method.InfoFlags &=
918 ~ACPI_METHOD_MODIFIED_NAMESPACE;
923 * If method is serialized, release the mutex and restore the
924 * current sync level for this thread
926 if (MethodDesc->Method.Mutex)
928 /* Acquisition Depth handles recursive calls */
930 MethodDesc->Method.Mutex->Mutex.AcquisitionDepth--;
931 if (!MethodDesc->Method.Mutex->Mutex.AcquisitionDepth)
933 WalkState->Thread->CurrentSyncLevel =
934 MethodDesc->Method.Mutex->Mutex.OriginalSyncLevel;
937 MethodDesc->Method.Mutex->Mutex.OsMutex);
938 MethodDesc->Method.Mutex->Mutex.ThreadId = 0;
943 /* Decrement the thread count on the method */
945 if (MethodDesc->Method.ThreadCount)
947 MethodDesc->Method.ThreadCount--;
951 ACPI_ERROR ((AE_INFO,
952 "Invalid zero thread count in method"));
955 /* Are there any other threads currently executing this method? */
957 if (MethodDesc->Method.ThreadCount)
960 * Additional threads. Do not release the OwnerId in this case,
961 * we immediately reuse it for the next thread executing this method
963 ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH,
964 "*** Completed execution of one thread, %u threads remaining\n",
965 MethodDesc->Method.ThreadCount));
969 /* This is the only executing thread for this method */
972 * Support to dynamically change a method from NotSerialized to
973 * Serialized if it appears that the method is incorrectly written and
974 * does not support multiple thread execution. The best example of this
975 * is if such a method creates namespace objects and blocks. A second
976 * thread will fail with an AE_ALREADY_EXISTS exception.
978 * This code is here because we must wait until the last thread exits
979 * before marking the method as serialized.
981 if (MethodDesc->Method.InfoFlags & ACPI_METHOD_SERIALIZED_PENDING)
986 "Marking method %4.4s as Serialized "
987 "because of AE_ALREADY_EXISTS error",
988 WalkState->MethodNode->Name.Ascii));
992 * Method tried to create an object twice and was marked as
993 * "pending serialized". The probable cause is that the method
994 * cannot handle reentrancy.
996 * The method was created as NotSerialized, but it tried to create
997 * a named object and then blocked, causing the second thread
998 * entrance to begin and then fail. Workaround this problem by
999 * marking the method permanently as Serialized when the last
1000 * thread exits here.
1002 MethodDesc->Method.InfoFlags &=
1003 ~ACPI_METHOD_SERIALIZED_PENDING;
1005 MethodDesc->Method.InfoFlags |=
1006 (ACPI_METHOD_SERIALIZED | ACPI_METHOD_IGNORE_SYNC_LEVEL);
1007 MethodDesc->Method.SyncLevel = 0;
1010 /* No more threads, we can free the OwnerId */
1012 if (!(MethodDesc->Method.InfoFlags & ACPI_METHOD_MODULE_LEVEL))
1014 AcpiUtReleaseOwnerId (&MethodDesc->Method.OwnerId);
1018 AcpiExStopTraceMethod ((ACPI_NAMESPACE_NODE *) MethodDesc->Method.Node,
1019 MethodDesc, WalkState);