xref: /freebsd/sys/contrib/dev/acpica/components/dispatcher/dsmethod.c (revision fe0f0bbb19f4f267df5c6249d1af4d6f665dfd52)
1a159c266SJung-uk Kim /******************************************************************************
2a159c266SJung-uk Kim  *
3a159c266SJung-uk Kim  * Module Name: dsmethod - Parser/Interpreter interface - control method parsing
4a159c266SJung-uk Kim  *
5a159c266SJung-uk Kim  *****************************************************************************/
6a159c266SJung-uk Kim 
7a159c266SJung-uk Kim /*
81c0e1b6dSJung-uk Kim  * Copyright (C) 2000 - 2015, Intel Corp.
9a159c266SJung-uk Kim  * All rights reserved.
10a159c266SJung-uk Kim  *
11a159c266SJung-uk Kim  * Redistribution and use in source and binary forms, with or without
12a159c266SJung-uk Kim  * modification, are permitted provided that the following conditions
13a159c266SJung-uk Kim  * are met:
14a159c266SJung-uk Kim  * 1. Redistributions of source code must retain the above copyright
15a159c266SJung-uk Kim  *    notice, this list of conditions, and the following disclaimer,
16a159c266SJung-uk Kim  *    without modification.
17a159c266SJung-uk Kim  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18a159c266SJung-uk Kim  *    substantially similar to the "NO WARRANTY" disclaimer below
19a159c266SJung-uk Kim  *    ("Disclaimer") and any redistribution must be conditioned upon
20a159c266SJung-uk Kim  *    including a substantially similar Disclaimer requirement for further
21a159c266SJung-uk Kim  *    binary redistribution.
22a159c266SJung-uk Kim  * 3. Neither the names of the above-listed copyright holders nor the names
23a159c266SJung-uk Kim  *    of any contributors may be used to endorse or promote products derived
24a159c266SJung-uk Kim  *    from this software without specific prior written permission.
25a159c266SJung-uk Kim  *
26a159c266SJung-uk Kim  * Alternatively, this software may be distributed under the terms of the
27a159c266SJung-uk Kim  * GNU General Public License ("GPL") version 2 as published by the Free
28a159c266SJung-uk Kim  * Software Foundation.
29a159c266SJung-uk Kim  *
30a159c266SJung-uk Kim  * NO WARRANTY
31a159c266SJung-uk Kim  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32a159c266SJung-uk Kim  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33a159c266SJung-uk Kim  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34a159c266SJung-uk Kim  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35a159c266SJung-uk Kim  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36a159c266SJung-uk Kim  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37a159c266SJung-uk Kim  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38a159c266SJung-uk Kim  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39a159c266SJung-uk Kim  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40a159c266SJung-uk Kim  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41a159c266SJung-uk Kim  * POSSIBILITY OF SUCH DAMAGES.
42a159c266SJung-uk Kim  */
43a159c266SJung-uk Kim 
44a159c266SJung-uk Kim #include <contrib/dev/acpica/include/acpi.h>
45a159c266SJung-uk Kim #include <contrib/dev/acpica/include/accommon.h>
46a159c266SJung-uk Kim #include <contrib/dev/acpica/include/acdispat.h>
47a159c266SJung-uk Kim #include <contrib/dev/acpica/include/acinterp.h>
48a159c266SJung-uk Kim #include <contrib/dev/acpica/include/acnamesp.h>
49313a0c13SJung-uk Kim #include <contrib/dev/acpica/include/acparser.h>
50313a0c13SJung-uk Kim #include <contrib/dev/acpica/include/amlcode.h>
51*fe0f0bbbSJung-uk Kim #include <contrib/dev/acpica/include/acdebug.h>
52a159c266SJung-uk Kim 
53a159c266SJung-uk Kim 
54a159c266SJung-uk Kim #define _COMPONENT          ACPI_DISPATCHER
55a159c266SJung-uk Kim         ACPI_MODULE_NAME    ("dsmethod")
56a159c266SJung-uk Kim 
57a159c266SJung-uk Kim /* Local prototypes */
58a159c266SJung-uk Kim 
59a159c266SJung-uk Kim static ACPI_STATUS
60313a0c13SJung-uk Kim AcpiDsDetectNamedOpcodes (
61313a0c13SJung-uk Kim     ACPI_WALK_STATE         *WalkState,
62313a0c13SJung-uk Kim     ACPI_PARSE_OBJECT       **OutOp);
63313a0c13SJung-uk Kim 
64313a0c13SJung-uk Kim static ACPI_STATUS
65a159c266SJung-uk Kim AcpiDsCreateMethodMutex (
66a159c266SJung-uk Kim     ACPI_OPERAND_OBJECT     *MethodDesc);
67a159c266SJung-uk Kim 
68a159c266SJung-uk Kim 
69a159c266SJung-uk Kim /*******************************************************************************
70a159c266SJung-uk Kim  *
71313a0c13SJung-uk Kim  * FUNCTION:    AcpiDsAutoSerializeMethod
72313a0c13SJung-uk Kim  *
73313a0c13SJung-uk Kim  * PARAMETERS:  Node                        - Namespace Node of the method
74313a0c13SJung-uk Kim  *              ObjDesc                     - Method object attached to node
75313a0c13SJung-uk Kim  *
76313a0c13SJung-uk Kim  * RETURN:      Status
77313a0c13SJung-uk Kim  *
78313a0c13SJung-uk Kim  * DESCRIPTION: Parse a control method AML to scan for control methods that
79313a0c13SJung-uk Kim  *              need serialization due to the creation of named objects.
80313a0c13SJung-uk Kim  *
81313a0c13SJung-uk Kim  * NOTE: It is a bit of overkill to mark all such methods serialized, since
82313a0c13SJung-uk Kim  * there is only a problem if the method actually blocks during execution.
83313a0c13SJung-uk Kim  * A blocking operation is, for example, a Sleep() operation, or any access
84313a0c13SJung-uk Kim  * to an operation region. However, it is probably not possible to easily
85313a0c13SJung-uk Kim  * detect whether a method will block or not, so we simply mark all suspicious
86313a0c13SJung-uk Kim  * methods as serialized.
87313a0c13SJung-uk Kim  *
88313a0c13SJung-uk Kim  * NOTE2: This code is essentially a generic routine for parsing a single
89313a0c13SJung-uk Kim  * control method.
90313a0c13SJung-uk Kim  *
91313a0c13SJung-uk Kim  ******************************************************************************/
92313a0c13SJung-uk Kim 
93313a0c13SJung-uk Kim ACPI_STATUS
94313a0c13SJung-uk Kim AcpiDsAutoSerializeMethod (
95313a0c13SJung-uk Kim     ACPI_NAMESPACE_NODE     *Node,
96313a0c13SJung-uk Kim     ACPI_OPERAND_OBJECT     *ObjDesc)
97313a0c13SJung-uk Kim {
98313a0c13SJung-uk Kim     ACPI_STATUS             Status;
99313a0c13SJung-uk Kim     ACPI_PARSE_OBJECT       *Op = NULL;
100313a0c13SJung-uk Kim     ACPI_WALK_STATE         *WalkState;
101313a0c13SJung-uk Kim 
102313a0c13SJung-uk Kim 
103313a0c13SJung-uk Kim     ACPI_FUNCTION_TRACE_PTR (DsAutoSerializeMethod, Node);
104313a0c13SJung-uk Kim 
105313a0c13SJung-uk Kim 
106313a0c13SJung-uk Kim     ACPI_DEBUG_PRINT ((ACPI_DB_PARSE,
107313a0c13SJung-uk Kim         "Method auto-serialization parse [%4.4s] %p\n",
108313a0c13SJung-uk Kim         AcpiUtGetNodeName (Node), Node));
109313a0c13SJung-uk Kim 
110313a0c13SJung-uk Kim     /* Create/Init a root op for the method parse tree */
111313a0c13SJung-uk Kim 
112*fe0f0bbbSJung-uk Kim     Op = AcpiPsAllocOp (AML_METHOD_OP, ObjDesc->Method.AmlStart);
113313a0c13SJung-uk Kim     if (!Op)
114313a0c13SJung-uk Kim     {
115313a0c13SJung-uk Kim         return_ACPI_STATUS (AE_NO_MEMORY);
116313a0c13SJung-uk Kim     }
117313a0c13SJung-uk Kim 
118313a0c13SJung-uk Kim     AcpiPsSetName (Op, Node->Name.Integer);
119313a0c13SJung-uk Kim     Op->Common.Node = Node;
120313a0c13SJung-uk Kim 
121313a0c13SJung-uk Kim     /* Create and initialize a new walk state */
122313a0c13SJung-uk Kim 
123313a0c13SJung-uk Kim     WalkState = AcpiDsCreateWalkState (Node->OwnerId, NULL, NULL, NULL);
124313a0c13SJung-uk Kim     if (!WalkState)
125313a0c13SJung-uk Kim     {
126a371a5fdSJung-uk Kim         AcpiPsFreeOp (Op);
127313a0c13SJung-uk Kim         return_ACPI_STATUS (AE_NO_MEMORY);
128313a0c13SJung-uk Kim     }
129313a0c13SJung-uk Kim 
130313a0c13SJung-uk Kim     Status = AcpiDsInitAmlWalk (WalkState, Op, Node, ObjDesc->Method.AmlStart,
131313a0c13SJung-uk Kim                 ObjDesc->Method.AmlLength, NULL, 0);
132313a0c13SJung-uk Kim     if (ACPI_FAILURE (Status))
133313a0c13SJung-uk Kim     {
134313a0c13SJung-uk Kim         AcpiDsDeleteWalkState (WalkState);
135a371a5fdSJung-uk Kim         AcpiPsFreeOp (Op);
136313a0c13SJung-uk Kim         return_ACPI_STATUS (Status);
137313a0c13SJung-uk Kim     }
138313a0c13SJung-uk Kim 
139313a0c13SJung-uk Kim     WalkState->DescendingCallback = AcpiDsDetectNamedOpcodes;
140313a0c13SJung-uk Kim 
141313a0c13SJung-uk Kim     /* Parse the method, scan for creation of named objects */
142313a0c13SJung-uk Kim 
143313a0c13SJung-uk Kim     Status = AcpiPsParseAml (WalkState);
144313a0c13SJung-uk Kim 
145313a0c13SJung-uk Kim     AcpiPsDeleteParseTree (Op);
146313a0c13SJung-uk Kim     return_ACPI_STATUS (Status);
147313a0c13SJung-uk Kim }
148313a0c13SJung-uk Kim 
149313a0c13SJung-uk Kim 
150313a0c13SJung-uk Kim /*******************************************************************************
151313a0c13SJung-uk Kim  *
152313a0c13SJung-uk Kim  * FUNCTION:    AcpiDsDetectNamedOpcodes
153313a0c13SJung-uk Kim  *
154313a0c13SJung-uk Kim  * PARAMETERS:  WalkState       - Current state of the parse tree walk
155313a0c13SJung-uk Kim  *              OutOp           - Unused, required for parser interface
156313a0c13SJung-uk Kim  *
157313a0c13SJung-uk Kim  * RETURN:      Status
158313a0c13SJung-uk Kim  *
159313a0c13SJung-uk Kim  * DESCRIPTION: Descending callback used during the loading of ACPI tables.
160313a0c13SJung-uk Kim  *              Currently used to detect methods that must be marked serialized
161313a0c13SJung-uk Kim  *              in order to avoid problems with the creation of named objects.
162313a0c13SJung-uk Kim  *
163313a0c13SJung-uk Kim  ******************************************************************************/
164313a0c13SJung-uk Kim 
165313a0c13SJung-uk Kim static ACPI_STATUS
166313a0c13SJung-uk Kim AcpiDsDetectNamedOpcodes (
167313a0c13SJung-uk Kim     ACPI_WALK_STATE         *WalkState,
168313a0c13SJung-uk Kim     ACPI_PARSE_OBJECT       **OutOp)
169313a0c13SJung-uk Kim {
170313a0c13SJung-uk Kim 
171313a0c13SJung-uk Kim     ACPI_FUNCTION_NAME (AcpiDsDetectNamedOpcodes);
172313a0c13SJung-uk Kim 
173313a0c13SJung-uk Kim 
174313a0c13SJung-uk Kim     /* We are only interested in opcodes that create a new name */
175313a0c13SJung-uk Kim 
176313a0c13SJung-uk Kim     if (!(WalkState->OpInfo->Flags & (AML_NAMED | AML_CREATE | AML_FIELD)))
177313a0c13SJung-uk Kim     {
178313a0c13SJung-uk Kim         return (AE_OK);
179313a0c13SJung-uk Kim     }
180313a0c13SJung-uk Kim 
181313a0c13SJung-uk Kim     /*
182313a0c13SJung-uk Kim      * At this point, we know we have a Named object opcode.
183313a0c13SJung-uk Kim      * Mark the method as serialized. Later code will create a mutex for
184313a0c13SJung-uk Kim      * this method to enforce serialization.
185313a0c13SJung-uk Kim      *
186313a0c13SJung-uk Kim      * Note, ACPI_METHOD_IGNORE_SYNC_LEVEL flag means that we will ignore the
187313a0c13SJung-uk Kim      * Sync Level mechanism for this method, even though it is now serialized.
188313a0c13SJung-uk Kim      * Otherwise, there can be conflicts with existing ASL code that actually
189313a0c13SJung-uk Kim      * uses sync levels.
190313a0c13SJung-uk Kim      */
191313a0c13SJung-uk Kim     WalkState->MethodDesc->Method.SyncLevel = 0;
192313a0c13SJung-uk Kim     WalkState->MethodDesc->Method.InfoFlags |=
193313a0c13SJung-uk Kim         (ACPI_METHOD_SERIALIZED | ACPI_METHOD_IGNORE_SYNC_LEVEL);
194313a0c13SJung-uk Kim 
195313a0c13SJung-uk Kim     ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
196313a0c13SJung-uk Kim         "Method serialized [%4.4s] %p - [%s] (%4.4X)\n",
197313a0c13SJung-uk Kim         WalkState->MethodNode->Name.Ascii, WalkState->MethodNode,
198313a0c13SJung-uk Kim         WalkState->OpInfo->Name, WalkState->Opcode));
199313a0c13SJung-uk Kim 
200313a0c13SJung-uk Kim     /* Abort the parse, no need to examine this method any further */
201313a0c13SJung-uk Kim 
202313a0c13SJung-uk Kim     return (AE_CTRL_TERMINATE);
203313a0c13SJung-uk Kim }
204313a0c13SJung-uk Kim 
205313a0c13SJung-uk Kim 
206313a0c13SJung-uk Kim /*******************************************************************************
207313a0c13SJung-uk Kim  *
208a159c266SJung-uk Kim  * FUNCTION:    AcpiDsMethodError
209a159c266SJung-uk Kim  *
210a159c266SJung-uk Kim  * PARAMETERS:  Status          - Execution status
211a159c266SJung-uk Kim  *              WalkState       - Current state
212a159c266SJung-uk Kim  *
213a159c266SJung-uk Kim  * RETURN:      Status
214a159c266SJung-uk Kim  *
215a159c266SJung-uk Kim  * DESCRIPTION: Called on method error. Invoke the global exception handler if
216*fe0f0bbbSJung-uk Kim  *              present, dump the method data if the debugger is configured
217a159c266SJung-uk Kim  *
218a159c266SJung-uk Kim  *              Note: Allows the exception handler to change the status code
219a159c266SJung-uk Kim  *
220a159c266SJung-uk Kim  ******************************************************************************/
221a159c266SJung-uk Kim 
222a159c266SJung-uk Kim ACPI_STATUS
223a159c266SJung-uk Kim AcpiDsMethodError (
224a159c266SJung-uk Kim     ACPI_STATUS             Status,
225a159c266SJung-uk Kim     ACPI_WALK_STATE         *WalkState)
226a159c266SJung-uk Kim {
227*fe0f0bbbSJung-uk Kim     UINT32                  AmlOffset;
228*fe0f0bbbSJung-uk Kim 
229*fe0f0bbbSJung-uk Kim 
230a159c266SJung-uk Kim     ACPI_FUNCTION_ENTRY ();
231a159c266SJung-uk Kim 
232a159c266SJung-uk Kim 
233a159c266SJung-uk Kim     /* Ignore AE_OK and control exception codes */
234a159c266SJung-uk Kim 
235a159c266SJung-uk Kim     if (ACPI_SUCCESS (Status) ||
236a159c266SJung-uk Kim         (Status & AE_CODE_CONTROL))
237a159c266SJung-uk Kim     {
238a159c266SJung-uk Kim         return (Status);
239a159c266SJung-uk Kim     }
240a159c266SJung-uk Kim 
241a159c266SJung-uk Kim     /* Invoke the global exception handler */
242a159c266SJung-uk Kim 
243a159c266SJung-uk Kim     if (AcpiGbl_ExceptionHandler)
244a159c266SJung-uk Kim     {
245a159c266SJung-uk Kim         /* Exit the interpreter, allow handler to execute methods */
246a159c266SJung-uk Kim 
247a159c266SJung-uk Kim         AcpiExExitInterpreter ();
248a159c266SJung-uk Kim 
249a159c266SJung-uk Kim         /*
250a159c266SJung-uk Kim          * Handler can map the exception code to anything it wants, including
251a159c266SJung-uk Kim          * AE_OK, in which case the executing method will not be aborted.
252a159c266SJung-uk Kim          */
253*fe0f0bbbSJung-uk Kim         AmlOffset = (UINT32) ACPI_PTR_DIFF (WalkState->Aml,
254*fe0f0bbbSJung-uk Kim                         WalkState->ParserState.AmlStart);
255*fe0f0bbbSJung-uk Kim 
256a159c266SJung-uk Kim         Status = AcpiGbl_ExceptionHandler (Status,
257a159c266SJung-uk Kim                     WalkState->MethodNode ?
258a159c266SJung-uk Kim                         WalkState->MethodNode->Name.Integer : 0,
259*fe0f0bbbSJung-uk Kim                     WalkState->Opcode, AmlOffset, NULL);
260a159c266SJung-uk Kim         AcpiExEnterInterpreter ();
261a159c266SJung-uk Kim     }
262a159c266SJung-uk Kim 
263a159c266SJung-uk Kim     AcpiDsClearImplicitReturn (WalkState);
264a159c266SJung-uk Kim 
265a159c266SJung-uk Kim     if (ACPI_FAILURE (Status))
266a159c266SJung-uk Kim     {
267*fe0f0bbbSJung-uk Kim         AcpiDsDumpMethodStack (Status, WalkState, WalkState->Op);
268a159c266SJung-uk Kim 
269*fe0f0bbbSJung-uk Kim         /* Display method locals/args if debugger is present */
270*fe0f0bbbSJung-uk Kim 
271*fe0f0bbbSJung-uk Kim #ifdef ACPI_DEBUGGER
272*fe0f0bbbSJung-uk Kim         AcpiDbDumpMethodInfo (Status, WalkState);
273a159c266SJung-uk Kim #endif
274*fe0f0bbbSJung-uk Kim     }
275a159c266SJung-uk Kim 
276a159c266SJung-uk Kim     return (Status);
277a159c266SJung-uk Kim }
278a159c266SJung-uk Kim 
279a159c266SJung-uk Kim 
280a159c266SJung-uk Kim /*******************************************************************************
281a159c266SJung-uk Kim  *
282a159c266SJung-uk Kim  * FUNCTION:    AcpiDsCreateMethodMutex
283a159c266SJung-uk Kim  *
284a159c266SJung-uk Kim  * PARAMETERS:  ObjDesc             - The method object
285a159c266SJung-uk Kim  *
286a159c266SJung-uk Kim  * RETURN:      Status
287a159c266SJung-uk Kim  *
288a159c266SJung-uk Kim  * DESCRIPTION: Create a mutex object for a serialized control method
289a159c266SJung-uk Kim  *
290a159c266SJung-uk Kim  ******************************************************************************/
291a159c266SJung-uk Kim 
292a159c266SJung-uk Kim static ACPI_STATUS
293a159c266SJung-uk Kim AcpiDsCreateMethodMutex (
294a159c266SJung-uk Kim     ACPI_OPERAND_OBJECT     *MethodDesc)
295a159c266SJung-uk Kim {
296a159c266SJung-uk Kim     ACPI_OPERAND_OBJECT     *MutexDesc;
297a159c266SJung-uk Kim     ACPI_STATUS             Status;
298a159c266SJung-uk Kim 
299a159c266SJung-uk Kim 
300a159c266SJung-uk Kim     ACPI_FUNCTION_TRACE (DsCreateMethodMutex);
301a159c266SJung-uk Kim 
302a159c266SJung-uk Kim 
303a159c266SJung-uk Kim     /* Create the new mutex object */
304a159c266SJung-uk Kim 
305a159c266SJung-uk Kim     MutexDesc = AcpiUtCreateInternalObject (ACPI_TYPE_MUTEX);
306a159c266SJung-uk Kim     if (!MutexDesc)
307a159c266SJung-uk Kim     {
308a159c266SJung-uk Kim         return_ACPI_STATUS (AE_NO_MEMORY);
309a159c266SJung-uk Kim     }
310a159c266SJung-uk Kim 
311a159c266SJung-uk Kim     /* Create the actual OS Mutex */
312a159c266SJung-uk Kim 
313a159c266SJung-uk Kim     Status = AcpiOsCreateMutex (&MutexDesc->Mutex.OsMutex);
314a159c266SJung-uk Kim     if (ACPI_FAILURE (Status))
315a159c266SJung-uk Kim     {
316efcc2a30SJung-uk Kim         AcpiUtDeleteObjectDesc (MutexDesc);
317a159c266SJung-uk Kim         return_ACPI_STATUS (Status);
318a159c266SJung-uk Kim     }
319a159c266SJung-uk Kim 
320a159c266SJung-uk Kim     MutexDesc->Mutex.SyncLevel = MethodDesc->Method.SyncLevel;
321a159c266SJung-uk Kim     MethodDesc->Method.Mutex = MutexDesc;
322a159c266SJung-uk Kim     return_ACPI_STATUS (AE_OK);
323a159c266SJung-uk Kim }
324a159c266SJung-uk Kim 
325a159c266SJung-uk Kim 
326a159c266SJung-uk Kim /*******************************************************************************
327a159c266SJung-uk Kim  *
328a159c266SJung-uk Kim  * FUNCTION:    AcpiDsBeginMethodExecution
329a159c266SJung-uk Kim  *
330a159c266SJung-uk Kim  * PARAMETERS:  MethodNode          - Node of the method
331a159c266SJung-uk Kim  *              ObjDesc             - The method object
332a159c266SJung-uk Kim  *              WalkState           - current state, NULL if not yet executing
333a159c266SJung-uk Kim  *                                    a method.
334a159c266SJung-uk Kim  *
335a159c266SJung-uk Kim  * RETURN:      Status
336a159c266SJung-uk Kim  *
337a159c266SJung-uk Kim  * DESCRIPTION: Prepare a method for execution. Parses the method if necessary,
338a159c266SJung-uk Kim  *              increments the thread count, and waits at the method semaphore
339a159c266SJung-uk Kim  *              for clearance to execute.
340a159c266SJung-uk Kim  *
341a159c266SJung-uk Kim  ******************************************************************************/
342a159c266SJung-uk Kim 
343a159c266SJung-uk Kim ACPI_STATUS
344a159c266SJung-uk Kim AcpiDsBeginMethodExecution (
345a159c266SJung-uk Kim     ACPI_NAMESPACE_NODE     *MethodNode,
346a159c266SJung-uk Kim     ACPI_OPERAND_OBJECT     *ObjDesc,
347a159c266SJung-uk Kim     ACPI_WALK_STATE         *WalkState)
348a159c266SJung-uk Kim {
349a159c266SJung-uk Kim     ACPI_STATUS             Status = AE_OK;
350a159c266SJung-uk Kim 
351a159c266SJung-uk Kim 
352a159c266SJung-uk Kim     ACPI_FUNCTION_TRACE_PTR (DsBeginMethodExecution, MethodNode);
353a159c266SJung-uk Kim 
354a159c266SJung-uk Kim 
355a159c266SJung-uk Kim     if (!MethodNode)
356a159c266SJung-uk Kim     {
357a159c266SJung-uk Kim         return_ACPI_STATUS (AE_NULL_ENTRY);
358a159c266SJung-uk Kim     }
359a159c266SJung-uk Kim 
360*fe0f0bbbSJung-uk Kim     AcpiExStartTraceMethod (MethodNode, ObjDesc, WalkState);
361*fe0f0bbbSJung-uk Kim 
362a159c266SJung-uk Kim     /* Prevent wraparound of thread count */
363a159c266SJung-uk Kim 
364a159c266SJung-uk Kim     if (ObjDesc->Method.ThreadCount == ACPI_UINT8_MAX)
365a159c266SJung-uk Kim     {
366a159c266SJung-uk Kim         ACPI_ERROR ((AE_INFO,
367a159c266SJung-uk Kim             "Method reached maximum reentrancy limit (255)"));
368a159c266SJung-uk Kim         return_ACPI_STATUS (AE_AML_METHOD_LIMIT);
369a159c266SJung-uk Kim     }
370a159c266SJung-uk Kim 
371a159c266SJung-uk Kim     /*
372a159c266SJung-uk Kim      * If this method is serialized, we need to acquire the method mutex.
373a159c266SJung-uk Kim      */
374a159c266SJung-uk Kim     if (ObjDesc->Method.InfoFlags & ACPI_METHOD_SERIALIZED)
375a159c266SJung-uk Kim     {
376a159c266SJung-uk Kim         /*
377a159c266SJung-uk Kim          * Create a mutex for the method if it is defined to be Serialized
378a159c266SJung-uk Kim          * and a mutex has not already been created. We defer the mutex creation
379a159c266SJung-uk Kim          * until a method is actually executed, to minimize the object count
380a159c266SJung-uk Kim          */
381a159c266SJung-uk Kim         if (!ObjDesc->Method.Mutex)
382a159c266SJung-uk Kim         {
383a159c266SJung-uk Kim             Status = AcpiDsCreateMethodMutex (ObjDesc);
384a159c266SJung-uk Kim             if (ACPI_FAILURE (Status))
385a159c266SJung-uk Kim             {
386a159c266SJung-uk Kim                 return_ACPI_STATUS (Status);
387a159c266SJung-uk Kim             }
388a159c266SJung-uk Kim         }
389a159c266SJung-uk Kim 
390a159c266SJung-uk Kim         /*
391a159c266SJung-uk Kim          * The CurrentSyncLevel (per-thread) must be less than or equal to
392a159c266SJung-uk Kim          * the sync level of the method. This mechanism provides some
393313a0c13SJung-uk Kim          * deadlock prevention.
394313a0c13SJung-uk Kim          *
395313a0c13SJung-uk Kim          * If the method was auto-serialized, we just ignore the sync level
396313a0c13SJung-uk Kim          * mechanism, because auto-serialization of methods can interfere
397313a0c13SJung-uk Kim          * with ASL code that actually uses sync levels.
398a159c266SJung-uk Kim          *
399a159c266SJung-uk Kim          * Top-level method invocation has no walk state at this point
400a159c266SJung-uk Kim          */
401a159c266SJung-uk Kim         if (WalkState &&
402313a0c13SJung-uk Kim             (!(ObjDesc->Method.InfoFlags & ACPI_METHOD_IGNORE_SYNC_LEVEL)) &&
403a159c266SJung-uk Kim             (WalkState->Thread->CurrentSyncLevel > ObjDesc->Method.Mutex->Mutex.SyncLevel))
404a159c266SJung-uk Kim         {
405a159c266SJung-uk Kim             ACPI_ERROR ((AE_INFO,
406a159c266SJung-uk Kim                 "Cannot acquire Mutex for method [%4.4s], current SyncLevel is too large (%u)",
407a159c266SJung-uk Kim                 AcpiUtGetNodeName (MethodNode),
408a159c266SJung-uk Kim                 WalkState->Thread->CurrentSyncLevel));
409a159c266SJung-uk Kim 
410a159c266SJung-uk Kim             return_ACPI_STATUS (AE_AML_MUTEX_ORDER);
411a159c266SJung-uk Kim         }
412a159c266SJung-uk Kim 
413a159c266SJung-uk Kim         /*
414a159c266SJung-uk Kim          * Obtain the method mutex if necessary. Do not acquire mutex for a
415a159c266SJung-uk Kim          * recursive call.
416a159c266SJung-uk Kim          */
417a159c266SJung-uk Kim         if (!WalkState ||
418a159c266SJung-uk Kim             !ObjDesc->Method.Mutex->Mutex.ThreadId ||
419a159c266SJung-uk Kim             (WalkState->Thread->ThreadId != ObjDesc->Method.Mutex->Mutex.ThreadId))
420a159c266SJung-uk Kim         {
421a159c266SJung-uk Kim             /*
422a159c266SJung-uk Kim              * Acquire the method mutex. This releases the interpreter if we
423a159c266SJung-uk Kim              * block (and reacquires it before it returns)
424a159c266SJung-uk Kim              */
425a159c266SJung-uk Kim             Status = AcpiExSystemWaitMutex (ObjDesc->Method.Mutex->Mutex.OsMutex,
426a159c266SJung-uk Kim                         ACPI_WAIT_FOREVER);
427a159c266SJung-uk Kim             if (ACPI_FAILURE (Status))
428a159c266SJung-uk Kim             {
429a159c266SJung-uk Kim                 return_ACPI_STATUS (Status);
430a159c266SJung-uk Kim             }
431a159c266SJung-uk Kim 
432a159c266SJung-uk Kim             /* Update the mutex and walk info and save the original SyncLevel */
433a159c266SJung-uk Kim 
434a159c266SJung-uk Kim             if (WalkState)
435a159c266SJung-uk Kim             {
436a159c266SJung-uk Kim                 ObjDesc->Method.Mutex->Mutex.OriginalSyncLevel =
437a159c266SJung-uk Kim                     WalkState->Thread->CurrentSyncLevel;
438a159c266SJung-uk Kim 
439a159c266SJung-uk Kim                 ObjDesc->Method.Mutex->Mutex.ThreadId = WalkState->Thread->ThreadId;
440a159c266SJung-uk Kim                 WalkState->Thread->CurrentSyncLevel = ObjDesc->Method.SyncLevel;
441a159c266SJung-uk Kim             }
442a159c266SJung-uk Kim             else
443a159c266SJung-uk Kim             {
444a159c266SJung-uk Kim                 ObjDesc->Method.Mutex->Mutex.OriginalSyncLevel =
445a159c266SJung-uk Kim                     ObjDesc->Method.Mutex->Mutex.SyncLevel;
446a159c266SJung-uk Kim             }
447a159c266SJung-uk Kim         }
448a159c266SJung-uk Kim 
449a159c266SJung-uk Kim         /* Always increase acquisition depth */
450a159c266SJung-uk Kim 
451a159c266SJung-uk Kim         ObjDesc->Method.Mutex->Mutex.AcquisitionDepth++;
452a159c266SJung-uk Kim     }
453a159c266SJung-uk Kim 
454a159c266SJung-uk Kim     /*
455a159c266SJung-uk Kim      * Allocate an Owner ID for this method, only if this is the first thread
456a159c266SJung-uk Kim      * to begin concurrent execution. We only need one OwnerId, even if the
457a159c266SJung-uk Kim      * method is invoked recursively.
458a159c266SJung-uk Kim      */
459a159c266SJung-uk Kim     if (!ObjDesc->Method.OwnerId)
460a159c266SJung-uk Kim     {
461a159c266SJung-uk Kim         Status = AcpiUtAllocateOwnerId (&ObjDesc->Method.OwnerId);
462a159c266SJung-uk Kim         if (ACPI_FAILURE (Status))
463a159c266SJung-uk Kim         {
464a159c266SJung-uk Kim             goto Cleanup;
465a159c266SJung-uk Kim         }
466a159c266SJung-uk Kim     }
467a159c266SJung-uk Kim 
468a159c266SJung-uk Kim     /*
469a159c266SJung-uk Kim      * Increment the method parse tree thread count since it has been
470a159c266SJung-uk Kim      * reentered one more time (even if it is the same thread)
471a159c266SJung-uk Kim      */
472a159c266SJung-uk Kim     ObjDesc->Method.ThreadCount++;
473a159c266SJung-uk Kim     AcpiMethodCount++;
474a159c266SJung-uk Kim     return_ACPI_STATUS (Status);
475a159c266SJung-uk Kim 
476a159c266SJung-uk Kim 
477a159c266SJung-uk Kim Cleanup:
478a159c266SJung-uk Kim     /* On error, must release the method mutex (if present) */
479a159c266SJung-uk Kim 
480a159c266SJung-uk Kim     if (ObjDesc->Method.Mutex)
481a159c266SJung-uk Kim     {
482a159c266SJung-uk Kim         AcpiOsReleaseMutex (ObjDesc->Method.Mutex->Mutex.OsMutex);
483a159c266SJung-uk Kim     }
484a159c266SJung-uk Kim     return_ACPI_STATUS (Status);
485a159c266SJung-uk Kim }
486a159c266SJung-uk Kim 
487a159c266SJung-uk Kim 
488a159c266SJung-uk Kim /*******************************************************************************
489a159c266SJung-uk Kim  *
490a159c266SJung-uk Kim  * FUNCTION:    AcpiDsCallControlMethod
491a159c266SJung-uk Kim  *
492a159c266SJung-uk Kim  * PARAMETERS:  Thread              - Info for this thread
493a159c266SJung-uk Kim  *              ThisWalkState       - Current walk state
494a159c266SJung-uk Kim  *              Op                  - Current Op to be walked
495a159c266SJung-uk Kim  *
496a159c266SJung-uk Kim  * RETURN:      Status
497a159c266SJung-uk Kim  *
498a159c266SJung-uk Kim  * DESCRIPTION: Transfer execution to a called control method
499a159c266SJung-uk Kim  *
500a159c266SJung-uk Kim  ******************************************************************************/
501a159c266SJung-uk Kim 
502a159c266SJung-uk Kim ACPI_STATUS
503a159c266SJung-uk Kim AcpiDsCallControlMethod (
504a159c266SJung-uk Kim     ACPI_THREAD_STATE       *Thread,
505a159c266SJung-uk Kim     ACPI_WALK_STATE         *ThisWalkState,
506a159c266SJung-uk Kim     ACPI_PARSE_OBJECT       *Op)
507a159c266SJung-uk Kim {
508a159c266SJung-uk Kim     ACPI_STATUS             Status;
509a159c266SJung-uk Kim     ACPI_NAMESPACE_NODE     *MethodNode;
510a159c266SJung-uk Kim     ACPI_WALK_STATE         *NextWalkState = NULL;
511a159c266SJung-uk Kim     ACPI_OPERAND_OBJECT     *ObjDesc;
512a159c266SJung-uk Kim     ACPI_EVALUATE_INFO      *Info;
513a159c266SJung-uk Kim     UINT32                  i;
514a159c266SJung-uk Kim 
515a159c266SJung-uk Kim 
516a159c266SJung-uk Kim     ACPI_FUNCTION_TRACE_PTR (DsCallControlMethod, ThisWalkState);
517a159c266SJung-uk Kim 
518a159c266SJung-uk Kim     ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH, "Calling method %p, currentstate=%p\n",
519a159c266SJung-uk Kim         ThisWalkState->PrevOp, ThisWalkState));
520a159c266SJung-uk Kim 
521a159c266SJung-uk Kim     /*
522a159c266SJung-uk Kim      * Get the namespace entry for the control method we are about to call
523a159c266SJung-uk Kim      */
524a159c266SJung-uk Kim     MethodNode = ThisWalkState->MethodCallNode;
525a159c266SJung-uk Kim     if (!MethodNode)
526a159c266SJung-uk Kim     {
527a159c266SJung-uk Kim         return_ACPI_STATUS (AE_NULL_ENTRY);
528a159c266SJung-uk Kim     }
529a159c266SJung-uk Kim 
530a159c266SJung-uk Kim     ObjDesc = AcpiNsGetAttachedObject (MethodNode);
531a159c266SJung-uk Kim     if (!ObjDesc)
532a159c266SJung-uk Kim     {
533a159c266SJung-uk Kim         return_ACPI_STATUS (AE_NULL_OBJECT);
534a159c266SJung-uk Kim     }
535a159c266SJung-uk Kim 
536a159c266SJung-uk Kim     /* Init for new method, possibly wait on method mutex */
537a159c266SJung-uk Kim 
538a159c266SJung-uk Kim     Status = AcpiDsBeginMethodExecution (MethodNode, ObjDesc,
539a159c266SJung-uk Kim                 ThisWalkState);
540a159c266SJung-uk Kim     if (ACPI_FAILURE (Status))
541a159c266SJung-uk Kim     {
542a159c266SJung-uk Kim         return_ACPI_STATUS (Status);
543a159c266SJung-uk Kim     }
544a159c266SJung-uk Kim 
545a159c266SJung-uk Kim     /* Begin method parse/execution. Create a new walk state */
546a159c266SJung-uk Kim 
547a159c266SJung-uk Kim     NextWalkState = AcpiDsCreateWalkState (ObjDesc->Method.OwnerId,
548a159c266SJung-uk Kim                         NULL, ObjDesc, Thread);
549a159c266SJung-uk Kim     if (!NextWalkState)
550a159c266SJung-uk Kim     {
551a159c266SJung-uk Kim         Status = AE_NO_MEMORY;
552a159c266SJung-uk Kim         goto Cleanup;
553a159c266SJung-uk Kim     }
554a159c266SJung-uk Kim 
555a159c266SJung-uk Kim     /*
556a159c266SJung-uk Kim      * The resolved arguments were put on the previous walk state's operand
557a159c266SJung-uk Kim      * stack. Operands on the previous walk state stack always
558a159c266SJung-uk Kim      * start at index 0. Also, null terminate the list of arguments
559a159c266SJung-uk Kim      */
560a159c266SJung-uk Kim     ThisWalkState->Operands [ThisWalkState->NumOperands] = NULL;
561a159c266SJung-uk Kim 
562a159c266SJung-uk Kim     /*
563a159c266SJung-uk Kim      * Allocate and initialize the evaluation information block
564a159c266SJung-uk Kim      * TBD: this is somewhat inefficient, should change interface to
565a159c266SJung-uk Kim      * DsInitAmlWalk. For now, keeps this struct off the CPU stack
566a159c266SJung-uk Kim      */
567a159c266SJung-uk Kim     Info = ACPI_ALLOCATE_ZEROED (sizeof (ACPI_EVALUATE_INFO));
568a159c266SJung-uk Kim     if (!Info)
569a159c266SJung-uk Kim     {
570ed17e06eSJung-uk Kim         Status = AE_NO_MEMORY;
571ed17e06eSJung-uk Kim         goto Cleanup;
572a159c266SJung-uk Kim     }
573a159c266SJung-uk Kim 
574a159c266SJung-uk Kim     Info->Parameters = &ThisWalkState->Operands[0];
575a159c266SJung-uk Kim 
576a159c266SJung-uk Kim     Status = AcpiDsInitAmlWalk (NextWalkState, NULL, MethodNode,
577a159c266SJung-uk Kim                 ObjDesc->Method.AmlStart, ObjDesc->Method.AmlLength,
578a159c266SJung-uk Kim                 Info, ACPI_IMODE_EXECUTE);
579a159c266SJung-uk Kim 
580a159c266SJung-uk Kim     ACPI_FREE (Info);
581a159c266SJung-uk Kim     if (ACPI_FAILURE (Status))
582a159c266SJung-uk Kim     {
583a159c266SJung-uk Kim         goto Cleanup;
584a159c266SJung-uk Kim     }
585a159c266SJung-uk Kim 
586a159c266SJung-uk Kim     /*
587a159c266SJung-uk Kim      * Delete the operands on the previous walkstate operand stack
588a159c266SJung-uk Kim      * (they were copied to new objects)
589a159c266SJung-uk Kim      */
590a159c266SJung-uk Kim     for (i = 0; i < ObjDesc->Method.ParamCount; i++)
591a159c266SJung-uk Kim     {
592a159c266SJung-uk Kim         AcpiUtRemoveReference (ThisWalkState->Operands [i]);
593a159c266SJung-uk Kim         ThisWalkState->Operands [i] = NULL;
594a159c266SJung-uk Kim     }
595a159c266SJung-uk Kim 
596a159c266SJung-uk Kim     /* Clear the operand stack */
597a159c266SJung-uk Kim 
598a159c266SJung-uk Kim     ThisWalkState->NumOperands = 0;
599a159c266SJung-uk Kim 
600a159c266SJung-uk Kim     ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH,
601a159c266SJung-uk Kim         "**** Begin nested execution of [%4.4s] **** WalkState=%p\n",
602a159c266SJung-uk Kim         MethodNode->Name.Ascii, NextWalkState));
603a159c266SJung-uk Kim 
604a159c266SJung-uk Kim     /* Invoke an internal method if necessary */
605a159c266SJung-uk Kim 
606a159c266SJung-uk Kim     if (ObjDesc->Method.InfoFlags & ACPI_METHOD_INTERNAL_ONLY)
607a159c266SJung-uk Kim     {
608a159c266SJung-uk Kim         Status = ObjDesc->Method.Dispatch.Implementation (NextWalkState);
609a159c266SJung-uk Kim         if (Status == AE_OK)
610a159c266SJung-uk Kim         {
611a159c266SJung-uk Kim             Status = AE_CTRL_TERMINATE;
612a159c266SJung-uk Kim         }
613a159c266SJung-uk Kim     }
614a159c266SJung-uk Kim 
615a159c266SJung-uk Kim     return_ACPI_STATUS (Status);
616a159c266SJung-uk Kim 
617a159c266SJung-uk Kim 
618a159c266SJung-uk Kim Cleanup:
619a159c266SJung-uk Kim 
620a159c266SJung-uk Kim     /* On error, we must terminate the method properly */
621a159c266SJung-uk Kim 
622a159c266SJung-uk Kim     AcpiDsTerminateControlMethod (ObjDesc, NextWalkState);
623a159c266SJung-uk Kim     AcpiDsDeleteWalkState (NextWalkState);
624a159c266SJung-uk Kim 
625a159c266SJung-uk Kim     return_ACPI_STATUS (Status);
626a159c266SJung-uk Kim }
627a159c266SJung-uk Kim 
628a159c266SJung-uk Kim 
629a159c266SJung-uk Kim /*******************************************************************************
630a159c266SJung-uk Kim  *
631a159c266SJung-uk Kim  * FUNCTION:    AcpiDsRestartControlMethod
632a159c266SJung-uk Kim  *
633a159c266SJung-uk Kim  * PARAMETERS:  WalkState           - State for preempted method (caller)
634a159c266SJung-uk Kim  *              ReturnDesc          - Return value from the called method
635a159c266SJung-uk Kim  *
636a159c266SJung-uk Kim  * RETURN:      Status
637a159c266SJung-uk Kim  *
638a159c266SJung-uk Kim  * DESCRIPTION: Restart a method that was preempted by another (nested) method
639a159c266SJung-uk Kim  *              invocation. Handle the return value (if any) from the callee.
640a159c266SJung-uk Kim  *
641a159c266SJung-uk Kim  ******************************************************************************/
642a159c266SJung-uk Kim 
643a159c266SJung-uk Kim ACPI_STATUS
644a159c266SJung-uk Kim AcpiDsRestartControlMethod (
645a159c266SJung-uk Kim     ACPI_WALK_STATE         *WalkState,
646a159c266SJung-uk Kim     ACPI_OPERAND_OBJECT     *ReturnDesc)
647a159c266SJung-uk Kim {
648a159c266SJung-uk Kim     ACPI_STATUS             Status;
649a159c266SJung-uk Kim     int                     SameAsImplicitReturn;
650a159c266SJung-uk Kim 
651a159c266SJung-uk Kim 
652a159c266SJung-uk Kim     ACPI_FUNCTION_TRACE_PTR (DsRestartControlMethod, WalkState);
653a159c266SJung-uk Kim 
654a159c266SJung-uk Kim 
655a159c266SJung-uk Kim     ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH,
656a159c266SJung-uk Kim         "****Restart [%4.4s] Op %p ReturnValueFromCallee %p\n",
657a159c266SJung-uk Kim         AcpiUtGetNodeName (WalkState->MethodNode),
658a159c266SJung-uk Kim         WalkState->MethodCallOp, ReturnDesc));
659a159c266SJung-uk Kim 
660a159c266SJung-uk Kim     ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH,
661a159c266SJung-uk Kim         "    ReturnFromThisMethodUsed?=%X ResStack %p Walk %p\n",
662a159c266SJung-uk Kim         WalkState->ReturnUsed,
663a159c266SJung-uk Kim         WalkState->Results, WalkState));
664a159c266SJung-uk Kim 
665a159c266SJung-uk Kim     /* Did the called method return a value? */
666a159c266SJung-uk Kim 
667a159c266SJung-uk Kim     if (ReturnDesc)
668a159c266SJung-uk Kim     {
669a159c266SJung-uk Kim         /* Is the implicit return object the same as the return desc? */
670a159c266SJung-uk Kim 
671a159c266SJung-uk Kim         SameAsImplicitReturn = (WalkState->ImplicitReturnObj == ReturnDesc);
672a159c266SJung-uk Kim 
673a159c266SJung-uk Kim         /* Are we actually going to use the return value? */
674a159c266SJung-uk Kim 
675a159c266SJung-uk Kim         if (WalkState->ReturnUsed)
676a159c266SJung-uk Kim         {
677a159c266SJung-uk Kim             /* Save the return value from the previous method */
678a159c266SJung-uk Kim 
679a159c266SJung-uk Kim             Status = AcpiDsResultPush (ReturnDesc, WalkState);
680a159c266SJung-uk Kim             if (ACPI_FAILURE (Status))
681a159c266SJung-uk Kim             {
682a159c266SJung-uk Kim                 AcpiUtRemoveReference (ReturnDesc);
683a159c266SJung-uk Kim                 return_ACPI_STATUS (Status);
684a159c266SJung-uk Kim             }
685a159c266SJung-uk Kim 
686a159c266SJung-uk Kim             /*
687a159c266SJung-uk Kim              * Save as THIS method's return value in case it is returned
688a159c266SJung-uk Kim              * immediately to yet another method
689a159c266SJung-uk Kim              */
690a159c266SJung-uk Kim             WalkState->ReturnDesc = ReturnDesc;
691a159c266SJung-uk Kim         }
692a159c266SJung-uk Kim 
693a159c266SJung-uk Kim         /*
694a159c266SJung-uk Kim          * The following code is the optional support for the so-called
695a159c266SJung-uk Kim          * "implicit return". Some AML code assumes that the last value of the
696a159c266SJung-uk Kim          * method is "implicitly" returned to the caller, in the absence of an
697a159c266SJung-uk Kim          * explicit return value.
698a159c266SJung-uk Kim          *
699a159c266SJung-uk Kim          * Just save the last result of the method as the return value.
700a159c266SJung-uk Kim          *
701a159c266SJung-uk Kim          * NOTE: this is optional because the ASL language does not actually
702a159c266SJung-uk Kim          * support this behavior.
703a159c266SJung-uk Kim          */
704a159c266SJung-uk Kim         else if (!AcpiDsDoImplicitReturn (ReturnDesc, WalkState, FALSE) ||
705a159c266SJung-uk Kim                  SameAsImplicitReturn)
706a159c266SJung-uk Kim         {
707a159c266SJung-uk Kim             /*
708a159c266SJung-uk Kim              * Delete the return value if it will not be used by the
709a159c266SJung-uk Kim              * calling method or remove one reference if the explicit return
710a159c266SJung-uk Kim              * is the same as the implicit return value.
711a159c266SJung-uk Kim              */
712a159c266SJung-uk Kim             AcpiUtRemoveReference (ReturnDesc);
713a159c266SJung-uk Kim         }
714a159c266SJung-uk Kim     }
715a159c266SJung-uk Kim 
716a159c266SJung-uk Kim     return_ACPI_STATUS (AE_OK);
717a159c266SJung-uk Kim }
718a159c266SJung-uk Kim 
719a159c266SJung-uk Kim 
720a159c266SJung-uk Kim /*******************************************************************************
721a159c266SJung-uk Kim  *
722a159c266SJung-uk Kim  * FUNCTION:    AcpiDsTerminateControlMethod
723a159c266SJung-uk Kim  *
724a159c266SJung-uk Kim  * PARAMETERS:  MethodDesc          - Method object
725a159c266SJung-uk Kim  *              WalkState           - State associated with the method
726a159c266SJung-uk Kim  *
727a159c266SJung-uk Kim  * RETURN:      None
728a159c266SJung-uk Kim  *
729a159c266SJung-uk Kim  * DESCRIPTION: Terminate a control method. Delete everything that the method
730a159c266SJung-uk Kim  *              created, delete all locals and arguments, and delete the parse
731a159c266SJung-uk Kim  *              tree if requested.
732a159c266SJung-uk Kim  *
733a159c266SJung-uk Kim  * MUTEX:       Interpreter is locked
734a159c266SJung-uk Kim  *
735a159c266SJung-uk Kim  ******************************************************************************/
736a159c266SJung-uk Kim 
737a159c266SJung-uk Kim void
738a159c266SJung-uk Kim AcpiDsTerminateControlMethod (
739a159c266SJung-uk Kim     ACPI_OPERAND_OBJECT     *MethodDesc,
740a159c266SJung-uk Kim     ACPI_WALK_STATE         *WalkState)
741a159c266SJung-uk Kim {
742a159c266SJung-uk Kim 
743a159c266SJung-uk Kim     ACPI_FUNCTION_TRACE_PTR (DsTerminateControlMethod, WalkState);
744a159c266SJung-uk Kim 
745a159c266SJung-uk Kim 
746a159c266SJung-uk Kim     /* MethodDesc is required, WalkState is optional */
747a159c266SJung-uk Kim 
748a159c266SJung-uk Kim     if (!MethodDesc)
749a159c266SJung-uk Kim     {
750a159c266SJung-uk Kim         return_VOID;
751a159c266SJung-uk Kim     }
752a159c266SJung-uk Kim 
753a159c266SJung-uk Kim     if (WalkState)
754a159c266SJung-uk Kim     {
755a159c266SJung-uk Kim         /* Delete all arguments and locals */
756a159c266SJung-uk Kim 
757a159c266SJung-uk Kim         AcpiDsMethodDataDeleteAll (WalkState);
758a159c266SJung-uk Kim 
759a159c266SJung-uk Kim         /*
760a159c266SJung-uk Kim          * If method is serialized, release the mutex and restore the
761a159c266SJung-uk Kim          * current sync level for this thread
762a159c266SJung-uk Kim          */
763a159c266SJung-uk Kim         if (MethodDesc->Method.Mutex)
764a159c266SJung-uk Kim         {
765a159c266SJung-uk Kim             /* Acquisition Depth handles recursive calls */
766a159c266SJung-uk Kim 
767a159c266SJung-uk Kim             MethodDesc->Method.Mutex->Mutex.AcquisitionDepth--;
768a159c266SJung-uk Kim             if (!MethodDesc->Method.Mutex->Mutex.AcquisitionDepth)
769a159c266SJung-uk Kim             {
770a159c266SJung-uk Kim                 WalkState->Thread->CurrentSyncLevel =
771a159c266SJung-uk Kim                     MethodDesc->Method.Mutex->Mutex.OriginalSyncLevel;
772a159c266SJung-uk Kim 
773a159c266SJung-uk Kim                 AcpiOsReleaseMutex (MethodDesc->Method.Mutex->Mutex.OsMutex);
774a159c266SJung-uk Kim                 MethodDesc->Method.Mutex->Mutex.ThreadId = 0;
775a159c266SJung-uk Kim             }
776a159c266SJung-uk Kim         }
777a159c266SJung-uk Kim 
778a159c266SJung-uk Kim         /*
779a159c266SJung-uk Kim          * Delete any namespace objects created anywhere within the
780a159c266SJung-uk Kim          * namespace by the execution of this method. Unless:
781a159c266SJung-uk Kim          * 1) This method is a module-level executable code method, in which
782a159c266SJung-uk Kim          *    case we want make the objects permanent.
783a159c266SJung-uk Kim          * 2) There are other threads executing the method, in which case we
784a159c266SJung-uk Kim          *    will wait until the last thread has completed.
785a159c266SJung-uk Kim          */
786a159c266SJung-uk Kim         if (!(MethodDesc->Method.InfoFlags & ACPI_METHOD_MODULE_LEVEL) &&
787a159c266SJung-uk Kim              (MethodDesc->Method.ThreadCount == 1))
788a159c266SJung-uk Kim         {
789a159c266SJung-uk Kim             /* Delete any direct children of (created by) this method */
790a159c266SJung-uk Kim 
791a159c266SJung-uk Kim             AcpiNsDeleteNamespaceSubtree (WalkState->MethodNode);
792a159c266SJung-uk Kim 
793a159c266SJung-uk Kim             /*
794a159c266SJung-uk Kim              * Delete any objects that were created by this method
795a159c266SJung-uk Kim              * elsewhere in the namespace (if any were created).
796a159c266SJung-uk Kim              * Use of the ACPI_METHOD_MODIFIED_NAMESPACE optimizes the
797a159c266SJung-uk Kim              * deletion such that we don't have to perform an entire
798a159c266SJung-uk Kim              * namespace walk for every control method execution.
799a159c266SJung-uk Kim              */
800a159c266SJung-uk Kim             if (MethodDesc->Method.InfoFlags & ACPI_METHOD_MODIFIED_NAMESPACE)
801a159c266SJung-uk Kim             {
802a159c266SJung-uk Kim                 AcpiNsDeleteNamespaceByOwner (MethodDesc->Method.OwnerId);
803a159c266SJung-uk Kim                 MethodDesc->Method.InfoFlags &= ~ACPI_METHOD_MODIFIED_NAMESPACE;
804a159c266SJung-uk Kim             }
805a159c266SJung-uk Kim         }
806a159c266SJung-uk Kim     }
807a159c266SJung-uk Kim 
808a159c266SJung-uk Kim     /* Decrement the thread count on the method */
809a159c266SJung-uk Kim 
810a159c266SJung-uk Kim     if (MethodDesc->Method.ThreadCount)
811a159c266SJung-uk Kim     {
812a159c266SJung-uk Kim         MethodDesc->Method.ThreadCount--;
813a159c266SJung-uk Kim     }
814a159c266SJung-uk Kim     else
815a159c266SJung-uk Kim     {
816a159c266SJung-uk Kim         ACPI_ERROR ((AE_INFO,
817a159c266SJung-uk Kim             "Invalid zero thread count in method"));
818a159c266SJung-uk Kim     }
819a159c266SJung-uk Kim 
820a159c266SJung-uk Kim     /* Are there any other threads currently executing this method? */
821a159c266SJung-uk Kim 
822a159c266SJung-uk Kim     if (MethodDesc->Method.ThreadCount)
823a159c266SJung-uk Kim     {
824a159c266SJung-uk Kim         /*
825a159c266SJung-uk Kim          * Additional threads. Do not release the OwnerId in this case,
826a159c266SJung-uk Kim          * we immediately reuse it for the next thread executing this method
827a159c266SJung-uk Kim          */
828a159c266SJung-uk Kim         ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH,
829a159c266SJung-uk Kim             "*** Completed execution of one thread, %u threads remaining\n",
830a159c266SJung-uk Kim             MethodDesc->Method.ThreadCount));
831a159c266SJung-uk Kim     }
832a159c266SJung-uk Kim     else
833a159c266SJung-uk Kim     {
834a159c266SJung-uk Kim         /* This is the only executing thread for this method */
835a159c266SJung-uk Kim 
836a159c266SJung-uk Kim         /*
837a159c266SJung-uk Kim          * Support to dynamically change a method from NotSerialized to
838a159c266SJung-uk Kim          * Serialized if it appears that the method is incorrectly written and
839a159c266SJung-uk Kim          * does not support multiple thread execution. The best example of this
840a159c266SJung-uk Kim          * is if such a method creates namespace objects and blocks. A second
841a159c266SJung-uk Kim          * thread will fail with an AE_ALREADY_EXISTS exception.
842a159c266SJung-uk Kim          *
843a159c266SJung-uk Kim          * This code is here because we must wait until the last thread exits
844a159c266SJung-uk Kim          * before marking the method as serialized.
845a159c266SJung-uk Kim          */
846a159c266SJung-uk Kim         if (MethodDesc->Method.InfoFlags & ACPI_METHOD_SERIALIZED_PENDING)
847a159c266SJung-uk Kim         {
848a159c266SJung-uk Kim             if (WalkState)
849a159c266SJung-uk Kim             {
850a159c266SJung-uk Kim                 ACPI_INFO ((AE_INFO,
851a159c266SJung-uk Kim                     "Marking method %4.4s as Serialized because of AE_ALREADY_EXISTS error",
852a159c266SJung-uk Kim                     WalkState->MethodNode->Name.Ascii));
853a159c266SJung-uk Kim             }
854a159c266SJung-uk Kim 
855a159c266SJung-uk Kim             /*
856a159c266SJung-uk Kim              * Method tried to create an object twice and was marked as
857a159c266SJung-uk Kim              * "pending serialized". The probable cause is that the method
858a159c266SJung-uk Kim              * cannot handle reentrancy.
859a159c266SJung-uk Kim              *
860a159c266SJung-uk Kim              * The method was created as NotSerialized, but it tried to create
861a159c266SJung-uk Kim              * a named object and then blocked, causing the second thread
862a159c266SJung-uk Kim              * entrance to begin and then fail. Workaround this problem by
863a159c266SJung-uk Kim              * marking the method permanently as Serialized when the last
864a159c266SJung-uk Kim              * thread exits here.
865a159c266SJung-uk Kim              */
866a159c266SJung-uk Kim             MethodDesc->Method.InfoFlags &= ~ACPI_METHOD_SERIALIZED_PENDING;
867313a0c13SJung-uk Kim             MethodDesc->Method.InfoFlags |=
868313a0c13SJung-uk Kim                 (ACPI_METHOD_SERIALIZED | ACPI_METHOD_IGNORE_SYNC_LEVEL);
869a159c266SJung-uk Kim             MethodDesc->Method.SyncLevel = 0;
870a159c266SJung-uk Kim         }
871a159c266SJung-uk Kim 
872a159c266SJung-uk Kim         /* No more threads, we can free the OwnerId */
873a159c266SJung-uk Kim 
874a159c266SJung-uk Kim         if (!(MethodDesc->Method.InfoFlags & ACPI_METHOD_MODULE_LEVEL))
875a159c266SJung-uk Kim         {
876a159c266SJung-uk Kim             AcpiUtReleaseOwnerId (&MethodDesc->Method.OwnerId);
877a159c266SJung-uk Kim         }
878a159c266SJung-uk Kim     }
879a159c266SJung-uk Kim 
880*fe0f0bbbSJung-uk Kim     AcpiExStopTraceMethod ((ACPI_NAMESPACE_NODE *) MethodDesc->Method.Node,
881*fe0f0bbbSJung-uk Kim             MethodDesc, WalkState);
882*fe0f0bbbSJung-uk Kim 
883a159c266SJung-uk Kim     return_VOID;
884a159c266SJung-uk Kim }
885