Deleted Added
full compact
dsmethod.c (99679) dsmethod.c (100966)
1/******************************************************************************
2 *
3 * Module Name: dsmethod - Parser/Interpreter interface - control method parsing
1/******************************************************************************
2 *
3 * Module Name: dsmethod - Parser/Interpreter interface - control method parsing
4 * $Revision: 86 $
4 * $Revision: 87 $
5 *
6 *****************************************************************************/
7
8/******************************************************************************
9 *
10 * 1. Copyright Notice
11 *
12 * Some or all of this work - Copyright (c) 1999 - 2002, Intel Corp.
13 * All rights reserved.
14 *
15 * 2. License
16 *
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
20 * property rights.
21 *
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
28 *
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;
37 *
38 * The above copyright and patent license is granted only if the following
39 * conditions are met:
40 *
41 * 3. Conditions
42 *
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.
54 *
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
65 * make.
66 *
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
71 * distribution.
72 *
73 * 3.4. Intel retains all right, title, and interest in and to the Original
74 * Intel Code.
75 *
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.
80 *
81 * 4. Disclaimer and Export Compliance
82 *
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
89 * PARTICULAR PURPOSE.
90 *
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
98 * LIMITED REMEDY.
99 *
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.
114 *
115 *****************************************************************************/
116
117#define __DSMETHOD_C__
118
119#include "acpi.h"
120#include "acparser.h"
121#include "amlcode.h"
122#include "acdispat.h"
123#include "acinterp.h"
124#include "acnamesp.h"
125
126
127#define _COMPONENT ACPI_DISPATCHER
128 ACPI_MODULE_NAME ("dsmethod")
129
130
131/*******************************************************************************
132 *
133 * FUNCTION: AcpiDsParseMethod
134 *
135 * PARAMETERS: ObjHandle - Node of the method
136 * Level - Current nesting level
137 * Context - Points to a method counter
138 * ReturnValue - Not used
139 *
140 * RETURN: Status
141 *
142 * DESCRIPTION: Call the parser and parse the AML that is
143 * associated with the method.
144 *
145 * MUTEX: Assumes parser is locked
146 *
147 ******************************************************************************/
148
149ACPI_STATUS
150AcpiDsParseMethod (
151 ACPI_HANDLE ObjHandle)
152{
153 ACPI_STATUS Status;
154 ACPI_OPERAND_OBJECT *ObjDesc;
155 ACPI_PARSE_OBJECT *Op;
156 ACPI_NAMESPACE_NODE *Node;
157 ACPI_OWNER_ID OwnerId;
158 ACPI_WALK_STATE *WalkState;
159
160
161 ACPI_FUNCTION_TRACE_PTR ("DsParseMethod", ObjHandle);
162
163
164 /* Parameter Validation */
165
166 if (!ObjHandle)
167 {
168 return_ACPI_STATUS (AE_NULL_ENTRY);
169 }
170
171 ACPI_DEBUG_PRINT ((ACPI_DB_PARSE, "**** Parsing [%4.4s] **** NamedObj=%p\n",
172 ((ACPI_NAMESPACE_NODE *) ObjHandle)->Name.Ascii, ObjHandle));
173
174 /* Extract the method object from the method Node */
175
176 Node = (ACPI_NAMESPACE_NODE *) ObjHandle;
177 ObjDesc = AcpiNsGetAttachedObject (Node);
178 if (!ObjDesc)
179 {
180 return_ACPI_STATUS (AE_NULL_OBJECT);
181 }
182
183 /* Create a mutex for the method if there is a concurrency limit */
184
185 if ((ObjDesc->Method.Concurrency != INFINITE_CONCURRENCY) &&
186 (!ObjDesc->Method.Semaphore))
187 {
188 Status = AcpiOsCreateSemaphore (ObjDesc->Method.Concurrency,
189 ObjDesc->Method.Concurrency,
190 &ObjDesc->Method.Semaphore);
191 if (ACPI_FAILURE (Status))
192 {
193 return_ACPI_STATUS (Status);
194 }
195 }
196
197 /*
198 * Allocate a new parser op to be the root of the parsed
199 * method tree
200 */
201 Op = AcpiPsAllocOp (AML_METHOD_OP);
202 if (!Op)
203 {
204 return_ACPI_STATUS (AE_NO_MEMORY);
205 }
206
207 /* Init new op with the method name and pointer back to the Node */
208
209 AcpiPsSetName (Op, Node->Name.Integer);
210 Op->Common.Node = Node;
211
212 /*
213 * Get a new OwnerId for objects created by this method. Namespace
214 * objects (such as Operation Regions) can be created during the
215 * first pass parse.
216 */
217 OwnerId = AcpiUtAllocateOwnerId (ACPI_OWNER_TYPE_METHOD);
218 ObjDesc->Method.OwningId = OwnerId;
219
220 /* Create and initialize a new walk state */
221
222 WalkState = AcpiDsCreateWalkState (OwnerId, NULL, NULL, NULL);
223 if (!WalkState)
224 {
225 return_ACPI_STATUS (AE_NO_MEMORY);
226 }
227
228 Status = AcpiDsInitAmlWalk (WalkState, Op, Node, ObjDesc->Method.AmlStart,
229 ObjDesc->Method.AmlLength, NULL, NULL, 1);
230 if (ACPI_FAILURE (Status))
231 {
232 AcpiDsDeleteWalkState (WalkState);
233 return_ACPI_STATUS (Status);
234 }
235
236 /*
237 * Parse the method, first pass
238 *
239 * The first pass load is where newly declared named objects are
240 * added into the namespace. Actual evaluation of
241 * the named objects (what would be called a "second
242 * pass") happens during the actual execution of the
243 * method so that operands to the named objects can
244 * take on dynamic run-time values.
245 */
246 Status = AcpiPsParseAml (WalkState);
247 if (ACPI_FAILURE (Status))
248 {
249 return_ACPI_STATUS (Status);
250 }
251
252 ACPI_DEBUG_PRINT ((ACPI_DB_PARSE,
253 "**** [%4.4s] Parsed **** NamedObj=%p Op=%p\n",
254 ((ACPI_NAMESPACE_NODE *) ObjHandle)->Name.Ascii, ObjHandle, Op));
255
256 AcpiPsDeleteParseTree (Op);
257 return_ACPI_STATUS (Status);
258}
259
260
261/*******************************************************************************
262 *
263 * FUNCTION: AcpiDsBeginMethodExecution
264 *
265 * PARAMETERS: MethodNode - Node of the method
266 * ObjDesc - The method object
267 * CallingMethodNode - Caller of this method (if non-null)
268 *
269 * RETURN: Status
270 *
271 * DESCRIPTION: Prepare a method for execution. Parses the method if necessary,
272 * increments the thread count, and waits at the method semaphore
273 * for clearance to execute.
274 *
275 * MUTEX: Locks/unlocks parser.
276 *
277 ******************************************************************************/
278
279ACPI_STATUS
280AcpiDsBeginMethodExecution (
281 ACPI_NAMESPACE_NODE *MethodNode,
282 ACPI_OPERAND_OBJECT *ObjDesc,
283 ACPI_NAMESPACE_NODE *CallingMethodNode)
284{
285 ACPI_STATUS Status = AE_OK;
286
287
288 ACPI_FUNCTION_TRACE_PTR ("DsBeginMethodExecution", MethodNode);
289
290
291 if (!MethodNode)
292 {
293 return_ACPI_STATUS (AE_NULL_ENTRY);
294 }
295
296 /*
297 * If there is a concurrency limit on this method, we need to
298 * obtain a unit from the method semaphore.
299 */
300 if (ObjDesc->Method.Semaphore)
301 {
302 /*
303 * Allow recursive method calls, up to the reentrancy/concurrency
304 * limit imposed by the SERIALIZED rule and the SyncLevel method
305 * parameter.
306 *
307 * The point of this code is to avoid permanently blocking a
308 * thread that is making recursive method calls.
309 */
310 if (MethodNode == CallingMethodNode)
311 {
312 if (ObjDesc->Method.ThreadCount >= ObjDesc->Method.Concurrency)
313 {
314 return_ACPI_STATUS (AE_AML_METHOD_LIMIT);
315 }
316 }
317
318 /*
319 * Get a unit from the method semaphore. This releases the
320 * interpreter if we block
321 */
322 Status = AcpiExSystemWaitSemaphore (ObjDesc->Method.Semaphore,
323 WAIT_FOREVER);
324 }
325
326 /*
327 * Increment the method parse tree thread count since it has been
328 * reentered one more time (even if it is the same thread)
329 */
330 ObjDesc->Method.ThreadCount++;
331 return_ACPI_STATUS (Status);
332}
333
334
335/*******************************************************************************
336 *
337 * FUNCTION: AcpiDsCallControlMethod
338 *
339 * PARAMETERS: WalkState - Current state of the walk
340 * Op - Current Op to be walked
341 *
342 * RETURN: Status
343 *
344 * DESCRIPTION: Transfer execution to a called control method
345 *
346 ******************************************************************************/
347
348ACPI_STATUS
349AcpiDsCallControlMethod (
350 ACPI_THREAD_STATE *Thread,
351 ACPI_WALK_STATE *ThisWalkState,
352 ACPI_PARSE_OBJECT *Op)
353{
354 ACPI_STATUS Status;
355 ACPI_NAMESPACE_NODE *MethodNode;
356 ACPI_OPERAND_OBJECT *ObjDesc;
357 ACPI_WALK_STATE *NextWalkState;
358 UINT32 i;
359
360
361 ACPI_FUNCTION_TRACE_PTR ("DsCallControlMethod", ThisWalkState);
362
363 ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH, "Execute method %p, currentstate=%p\n",
364 ThisWalkState->PrevOp, ThisWalkState));
365
366 /*
367 * Get the namespace entry for the control method we are about to call
368 */
369 MethodNode = ThisWalkState->MethodCallNode;
370 if (!MethodNode)
371 {
372 return_ACPI_STATUS (AE_NULL_ENTRY);
373 }
374
375 ObjDesc = AcpiNsGetAttachedObject (MethodNode);
376 if (!ObjDesc)
377 {
378 return_ACPI_STATUS (AE_NULL_OBJECT);
379 }
380
381 /* Init for new method, wait on concurrency semaphore */
382
383 Status = AcpiDsBeginMethodExecution (MethodNode, ObjDesc,
384 ThisWalkState->MethodNode);
385 if (ACPI_FAILURE (Status))
386 {
387 return_ACPI_STATUS (Status);
388 }
389
390 /* 1) Parse: Create a new walk state for the preempting walk */
391
392 NextWalkState = AcpiDsCreateWalkState (ObjDesc->Method.OwningId,
393 Op, ObjDesc, NULL);
394 if (!NextWalkState)
395 {
396 return_ACPI_STATUS (AE_NO_MEMORY);
397 }
398
399 /* Create and init a Root Node */
400
5 *
6 *****************************************************************************/
7
8/******************************************************************************
9 *
10 * 1. Copyright Notice
11 *
12 * Some or all of this work - Copyright (c) 1999 - 2002, Intel Corp.
13 * All rights reserved.
14 *
15 * 2. License
16 *
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
20 * property rights.
21 *
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
28 *
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;
37 *
38 * The above copyright and patent license is granted only if the following
39 * conditions are met:
40 *
41 * 3. Conditions
42 *
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.
54 *
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
65 * make.
66 *
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
71 * distribution.
72 *
73 * 3.4. Intel retains all right, title, and interest in and to the Original
74 * Intel Code.
75 *
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.
80 *
81 * 4. Disclaimer and Export Compliance
82 *
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
89 * PARTICULAR PURPOSE.
90 *
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
98 * LIMITED REMEDY.
99 *
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.
114 *
115 *****************************************************************************/
116
117#define __DSMETHOD_C__
118
119#include "acpi.h"
120#include "acparser.h"
121#include "amlcode.h"
122#include "acdispat.h"
123#include "acinterp.h"
124#include "acnamesp.h"
125
126
127#define _COMPONENT ACPI_DISPATCHER
128 ACPI_MODULE_NAME ("dsmethod")
129
130
131/*******************************************************************************
132 *
133 * FUNCTION: AcpiDsParseMethod
134 *
135 * PARAMETERS: ObjHandle - Node of the method
136 * Level - Current nesting level
137 * Context - Points to a method counter
138 * ReturnValue - Not used
139 *
140 * RETURN: Status
141 *
142 * DESCRIPTION: Call the parser and parse the AML that is
143 * associated with the method.
144 *
145 * MUTEX: Assumes parser is locked
146 *
147 ******************************************************************************/
148
149ACPI_STATUS
150AcpiDsParseMethod (
151 ACPI_HANDLE ObjHandle)
152{
153 ACPI_STATUS Status;
154 ACPI_OPERAND_OBJECT *ObjDesc;
155 ACPI_PARSE_OBJECT *Op;
156 ACPI_NAMESPACE_NODE *Node;
157 ACPI_OWNER_ID OwnerId;
158 ACPI_WALK_STATE *WalkState;
159
160
161 ACPI_FUNCTION_TRACE_PTR ("DsParseMethod", ObjHandle);
162
163
164 /* Parameter Validation */
165
166 if (!ObjHandle)
167 {
168 return_ACPI_STATUS (AE_NULL_ENTRY);
169 }
170
171 ACPI_DEBUG_PRINT ((ACPI_DB_PARSE, "**** Parsing [%4.4s] **** NamedObj=%p\n",
172 ((ACPI_NAMESPACE_NODE *) ObjHandle)->Name.Ascii, ObjHandle));
173
174 /* Extract the method object from the method Node */
175
176 Node = (ACPI_NAMESPACE_NODE *) ObjHandle;
177 ObjDesc = AcpiNsGetAttachedObject (Node);
178 if (!ObjDesc)
179 {
180 return_ACPI_STATUS (AE_NULL_OBJECT);
181 }
182
183 /* Create a mutex for the method if there is a concurrency limit */
184
185 if ((ObjDesc->Method.Concurrency != INFINITE_CONCURRENCY) &&
186 (!ObjDesc->Method.Semaphore))
187 {
188 Status = AcpiOsCreateSemaphore (ObjDesc->Method.Concurrency,
189 ObjDesc->Method.Concurrency,
190 &ObjDesc->Method.Semaphore);
191 if (ACPI_FAILURE (Status))
192 {
193 return_ACPI_STATUS (Status);
194 }
195 }
196
197 /*
198 * Allocate a new parser op to be the root of the parsed
199 * method tree
200 */
201 Op = AcpiPsAllocOp (AML_METHOD_OP);
202 if (!Op)
203 {
204 return_ACPI_STATUS (AE_NO_MEMORY);
205 }
206
207 /* Init new op with the method name and pointer back to the Node */
208
209 AcpiPsSetName (Op, Node->Name.Integer);
210 Op->Common.Node = Node;
211
212 /*
213 * Get a new OwnerId for objects created by this method. Namespace
214 * objects (such as Operation Regions) can be created during the
215 * first pass parse.
216 */
217 OwnerId = AcpiUtAllocateOwnerId (ACPI_OWNER_TYPE_METHOD);
218 ObjDesc->Method.OwningId = OwnerId;
219
220 /* Create and initialize a new walk state */
221
222 WalkState = AcpiDsCreateWalkState (OwnerId, NULL, NULL, NULL);
223 if (!WalkState)
224 {
225 return_ACPI_STATUS (AE_NO_MEMORY);
226 }
227
228 Status = AcpiDsInitAmlWalk (WalkState, Op, Node, ObjDesc->Method.AmlStart,
229 ObjDesc->Method.AmlLength, NULL, NULL, 1);
230 if (ACPI_FAILURE (Status))
231 {
232 AcpiDsDeleteWalkState (WalkState);
233 return_ACPI_STATUS (Status);
234 }
235
236 /*
237 * Parse the method, first pass
238 *
239 * The first pass load is where newly declared named objects are
240 * added into the namespace. Actual evaluation of
241 * the named objects (what would be called a "second
242 * pass") happens during the actual execution of the
243 * method so that operands to the named objects can
244 * take on dynamic run-time values.
245 */
246 Status = AcpiPsParseAml (WalkState);
247 if (ACPI_FAILURE (Status))
248 {
249 return_ACPI_STATUS (Status);
250 }
251
252 ACPI_DEBUG_PRINT ((ACPI_DB_PARSE,
253 "**** [%4.4s] Parsed **** NamedObj=%p Op=%p\n",
254 ((ACPI_NAMESPACE_NODE *) ObjHandle)->Name.Ascii, ObjHandle, Op));
255
256 AcpiPsDeleteParseTree (Op);
257 return_ACPI_STATUS (Status);
258}
259
260
261/*******************************************************************************
262 *
263 * FUNCTION: AcpiDsBeginMethodExecution
264 *
265 * PARAMETERS: MethodNode - Node of the method
266 * ObjDesc - The method object
267 * CallingMethodNode - Caller of this method (if non-null)
268 *
269 * RETURN: Status
270 *
271 * DESCRIPTION: Prepare a method for execution. Parses the method if necessary,
272 * increments the thread count, and waits at the method semaphore
273 * for clearance to execute.
274 *
275 * MUTEX: Locks/unlocks parser.
276 *
277 ******************************************************************************/
278
279ACPI_STATUS
280AcpiDsBeginMethodExecution (
281 ACPI_NAMESPACE_NODE *MethodNode,
282 ACPI_OPERAND_OBJECT *ObjDesc,
283 ACPI_NAMESPACE_NODE *CallingMethodNode)
284{
285 ACPI_STATUS Status = AE_OK;
286
287
288 ACPI_FUNCTION_TRACE_PTR ("DsBeginMethodExecution", MethodNode);
289
290
291 if (!MethodNode)
292 {
293 return_ACPI_STATUS (AE_NULL_ENTRY);
294 }
295
296 /*
297 * If there is a concurrency limit on this method, we need to
298 * obtain a unit from the method semaphore.
299 */
300 if (ObjDesc->Method.Semaphore)
301 {
302 /*
303 * Allow recursive method calls, up to the reentrancy/concurrency
304 * limit imposed by the SERIALIZED rule and the SyncLevel method
305 * parameter.
306 *
307 * The point of this code is to avoid permanently blocking a
308 * thread that is making recursive method calls.
309 */
310 if (MethodNode == CallingMethodNode)
311 {
312 if (ObjDesc->Method.ThreadCount >= ObjDesc->Method.Concurrency)
313 {
314 return_ACPI_STATUS (AE_AML_METHOD_LIMIT);
315 }
316 }
317
318 /*
319 * Get a unit from the method semaphore. This releases the
320 * interpreter if we block
321 */
322 Status = AcpiExSystemWaitSemaphore (ObjDesc->Method.Semaphore,
323 WAIT_FOREVER);
324 }
325
326 /*
327 * Increment the method parse tree thread count since it has been
328 * reentered one more time (even if it is the same thread)
329 */
330 ObjDesc->Method.ThreadCount++;
331 return_ACPI_STATUS (Status);
332}
333
334
335/*******************************************************************************
336 *
337 * FUNCTION: AcpiDsCallControlMethod
338 *
339 * PARAMETERS: WalkState - Current state of the walk
340 * Op - Current Op to be walked
341 *
342 * RETURN: Status
343 *
344 * DESCRIPTION: Transfer execution to a called control method
345 *
346 ******************************************************************************/
347
348ACPI_STATUS
349AcpiDsCallControlMethod (
350 ACPI_THREAD_STATE *Thread,
351 ACPI_WALK_STATE *ThisWalkState,
352 ACPI_PARSE_OBJECT *Op)
353{
354 ACPI_STATUS Status;
355 ACPI_NAMESPACE_NODE *MethodNode;
356 ACPI_OPERAND_OBJECT *ObjDesc;
357 ACPI_WALK_STATE *NextWalkState;
358 UINT32 i;
359
360
361 ACPI_FUNCTION_TRACE_PTR ("DsCallControlMethod", ThisWalkState);
362
363 ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH, "Execute method %p, currentstate=%p\n",
364 ThisWalkState->PrevOp, ThisWalkState));
365
366 /*
367 * Get the namespace entry for the control method we are about to call
368 */
369 MethodNode = ThisWalkState->MethodCallNode;
370 if (!MethodNode)
371 {
372 return_ACPI_STATUS (AE_NULL_ENTRY);
373 }
374
375 ObjDesc = AcpiNsGetAttachedObject (MethodNode);
376 if (!ObjDesc)
377 {
378 return_ACPI_STATUS (AE_NULL_OBJECT);
379 }
380
381 /* Init for new method, wait on concurrency semaphore */
382
383 Status = AcpiDsBeginMethodExecution (MethodNode, ObjDesc,
384 ThisWalkState->MethodNode);
385 if (ACPI_FAILURE (Status))
386 {
387 return_ACPI_STATUS (Status);
388 }
389
390 /* 1) Parse: Create a new walk state for the preempting walk */
391
392 NextWalkState = AcpiDsCreateWalkState (ObjDesc->Method.OwningId,
393 Op, ObjDesc, NULL);
394 if (!NextWalkState)
395 {
396 return_ACPI_STATUS (AE_NO_MEMORY);
397 }
398
399 /* Create and init a Root Node */
400
401 Op = AcpiPsAllocOp (AML_SCOPE_OP);
401 Op = AcpiPsCreateScopeOp ();
402 if (!Op)
403 {
404 Status = AE_NO_MEMORY;
405 goto Cleanup;
406 }
407
408 Status = AcpiDsInitAmlWalk (NextWalkState, Op, MethodNode,
409 ObjDesc->Method.AmlStart, ObjDesc->Method.AmlLength,
410 NULL, NULL, 1);
411 if (ACPI_FAILURE (Status))
412 {
413 AcpiDsDeleteWalkState (NextWalkState);
414 goto Cleanup;
415 }
416
417 /* Begin AML parse */
418
419 Status = AcpiPsParseAml (NextWalkState);
420 AcpiPsDeleteParseTree (Op);
421
422 /* 2) Execute: Create a new state for the preempting walk */
423
424 NextWalkState = AcpiDsCreateWalkState (ObjDesc->Method.OwningId,
425 NULL, ObjDesc, Thread);
426 if (!NextWalkState)
427 {
428 Status = AE_NO_MEMORY;
429 goto Cleanup;
430 }
431
432 /*
433 * The resolved arguments were put on the previous walk state's operand
434 * stack. Operands on the previous walk state stack always
435 * start at index 0.
436 * Null terminate the list of arguments
437 */
438 ThisWalkState->Operands [ThisWalkState->NumOperands] = NULL;
439
440 Status = AcpiDsInitAmlWalk (NextWalkState, NULL, MethodNode,
441 ObjDesc->Method.AmlStart, ObjDesc->Method.AmlLength,
442 &ThisWalkState->Operands[0], NULL, 3);
443 if (ACPI_FAILURE (Status))
444 {
445 goto Cleanup;
446 }
447
448 /*
449 * Delete the operands on the previous walkstate operand stack
450 * (they were copied to new objects)
451 */
452 for (i = 0; i < ObjDesc->Method.ParamCount; i++)
453 {
454 AcpiUtRemoveReference (ThisWalkState->Operands [i]);
455 ThisWalkState->Operands [i] = NULL;
456 }
457
458 /* Clear the operand stack */
459
460 ThisWalkState->NumOperands = 0;
461
462 ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH,
463 "Starting nested execution, newstate=%p\n", NextWalkState));
464
465 return_ACPI_STATUS (AE_OK);
466
467
468 /* On error, we must delete the new walk state */
469
470Cleanup:
471 (void) AcpiDsTerminateControlMethod (NextWalkState);
472 AcpiDsDeleteWalkState (NextWalkState);
473 return_ACPI_STATUS (Status);
474
475}
476
477
478/*******************************************************************************
479 *
480 * FUNCTION: AcpiDsRestartControlMethod
481 *
482 * PARAMETERS: WalkState - State of the method when it was preempted
483 * Op - Pointer to new current op
484 *
485 * RETURN: Status
486 *
487 * DESCRIPTION: Restart a method that was preempted
488 *
489 ******************************************************************************/
490
491ACPI_STATUS
492AcpiDsRestartControlMethod (
493 ACPI_WALK_STATE *WalkState,
494 ACPI_OPERAND_OBJECT *ReturnDesc)
495{
496 ACPI_STATUS Status;
497
498
499 ACPI_FUNCTION_TRACE_PTR ("DsRestartControlMethod", WalkState);
500
501
502 if (ReturnDesc)
503 {
504 if (WalkState->ReturnUsed)
505 {
506 /*
507 * Get the return value (if any) from the previous method.
508 * NULL if no return value
509 */
510 Status = AcpiDsResultPush (ReturnDesc, WalkState);
511 if (ACPI_FAILURE (Status))
512 {
513 AcpiUtRemoveReference (ReturnDesc);
514 return_ACPI_STATUS (Status);
515 }
516 }
517 else
518 {
519 /*
520 * Delete the return value if it will not be used by the
521 * calling method
522 */
523 AcpiUtRemoveReference (ReturnDesc);
524 }
525 }
526
527 ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH,
528 "Method=%p Return=%p ReturnUsed?=%X ResStack=%p State=%p\n",
529 WalkState->MethodCallOp, ReturnDesc, WalkState->ReturnUsed,
530 WalkState->Results, WalkState));
531
532 return_ACPI_STATUS (AE_OK);
533}
534
535
536/*******************************************************************************
537 *
538 * FUNCTION: AcpiDsTerminateControlMethod
539 *
540 * PARAMETERS: WalkState - State of the method
541 *
542 * RETURN: Status
543 *
544 * DESCRIPTION: Terminate a control method. Delete everything that the method
545 * created, delete all locals and arguments, and delete the parse
546 * tree if requested.
547 *
548 ******************************************************************************/
549
550ACPI_STATUS
551AcpiDsTerminateControlMethod (
552 ACPI_WALK_STATE *WalkState)
553{
554 ACPI_OPERAND_OBJECT *ObjDesc;
555 ACPI_NAMESPACE_NODE *MethodNode;
556 ACPI_STATUS Status;
557
558
559 ACPI_FUNCTION_TRACE_PTR ("DsTerminateControlMethod", WalkState);
560
561
562 if (!WalkState)
563 {
564 return (AE_BAD_PARAMETER);
565 }
566
567 /* The current method object was saved in the walk state */
568
569 ObjDesc = WalkState->MethodDesc;
570 if (!ObjDesc)
571 {
572 return_ACPI_STATUS (AE_OK);
573 }
574
575 /* Delete all arguments and locals */
576
577 AcpiDsMethodDataDeleteAll (WalkState);
578
579 /*
580 * Lock the parser while we terminate this method.
581 * If this is the last thread executing the method,
582 * we have additional cleanup to perform
583 */
584 Status = AcpiUtAcquireMutex (ACPI_MTX_PARSER);
585 if (ACPI_FAILURE (Status))
586 {
587 return_ACPI_STATUS (Status);
588 }
589
590 /* Signal completion of the execution of this method if necessary */
591
592 if (WalkState->MethodDesc->Method.Semaphore)
593 {
594 Status = AcpiOsSignalSemaphore (
595 WalkState->MethodDesc->Method.Semaphore, 1);
596 if (ACPI_FAILURE (Status))
597 {
598 ACPI_REPORT_ERROR (("Could not signal method semaphore\n"));
599 Status = AE_OK;
600
601 /* Ignore error and continue cleanup */
602 }
603 }
604
605 /* Decrement the thread count on the method parse tree */
606
607 WalkState->MethodDesc->Method.ThreadCount--;
608 if (!WalkState->MethodDesc->Method.ThreadCount)
609 {
610 /*
611 * There are no more threads executing this method. Perform
612 * additional cleanup.
613 *
614 * The method Node is stored in the walk state
615 */
616 MethodNode = WalkState->MethodNode;
617
618 /*
619 * Delete any namespace entries created immediately underneath
620 * the method
621 */
622 Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
623 if (ACPI_FAILURE (Status))
624 {
625 return_ACPI_STATUS (Status);
626 }
627
628 if (MethodNode->Child)
629 {
630 AcpiNsDeleteNamespaceSubtree (MethodNode);
631 }
632
633 /*
634 * Delete any namespace entries created anywhere else within
635 * the namespace
636 */
637 AcpiNsDeleteNamespaceByOwner (WalkState->MethodDesc->Method.OwningId);
638 Status = AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
639 if (ACPI_FAILURE (Status))
640 {
641 return_ACPI_STATUS (Status);
642 }
643 }
644
645 Status = AcpiUtReleaseMutex (ACPI_MTX_PARSER);
646 return_ACPI_STATUS (Status);
647}
648
649
402 if (!Op)
403 {
404 Status = AE_NO_MEMORY;
405 goto Cleanup;
406 }
407
408 Status = AcpiDsInitAmlWalk (NextWalkState, Op, MethodNode,
409 ObjDesc->Method.AmlStart, ObjDesc->Method.AmlLength,
410 NULL, NULL, 1);
411 if (ACPI_FAILURE (Status))
412 {
413 AcpiDsDeleteWalkState (NextWalkState);
414 goto Cleanup;
415 }
416
417 /* Begin AML parse */
418
419 Status = AcpiPsParseAml (NextWalkState);
420 AcpiPsDeleteParseTree (Op);
421
422 /* 2) Execute: Create a new state for the preempting walk */
423
424 NextWalkState = AcpiDsCreateWalkState (ObjDesc->Method.OwningId,
425 NULL, ObjDesc, Thread);
426 if (!NextWalkState)
427 {
428 Status = AE_NO_MEMORY;
429 goto Cleanup;
430 }
431
432 /*
433 * The resolved arguments were put on the previous walk state's operand
434 * stack. Operands on the previous walk state stack always
435 * start at index 0.
436 * Null terminate the list of arguments
437 */
438 ThisWalkState->Operands [ThisWalkState->NumOperands] = NULL;
439
440 Status = AcpiDsInitAmlWalk (NextWalkState, NULL, MethodNode,
441 ObjDesc->Method.AmlStart, ObjDesc->Method.AmlLength,
442 &ThisWalkState->Operands[0], NULL, 3);
443 if (ACPI_FAILURE (Status))
444 {
445 goto Cleanup;
446 }
447
448 /*
449 * Delete the operands on the previous walkstate operand stack
450 * (they were copied to new objects)
451 */
452 for (i = 0; i < ObjDesc->Method.ParamCount; i++)
453 {
454 AcpiUtRemoveReference (ThisWalkState->Operands [i]);
455 ThisWalkState->Operands [i] = NULL;
456 }
457
458 /* Clear the operand stack */
459
460 ThisWalkState->NumOperands = 0;
461
462 ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH,
463 "Starting nested execution, newstate=%p\n", NextWalkState));
464
465 return_ACPI_STATUS (AE_OK);
466
467
468 /* On error, we must delete the new walk state */
469
470Cleanup:
471 (void) AcpiDsTerminateControlMethod (NextWalkState);
472 AcpiDsDeleteWalkState (NextWalkState);
473 return_ACPI_STATUS (Status);
474
475}
476
477
478/*******************************************************************************
479 *
480 * FUNCTION: AcpiDsRestartControlMethod
481 *
482 * PARAMETERS: WalkState - State of the method when it was preempted
483 * Op - Pointer to new current op
484 *
485 * RETURN: Status
486 *
487 * DESCRIPTION: Restart a method that was preempted
488 *
489 ******************************************************************************/
490
491ACPI_STATUS
492AcpiDsRestartControlMethod (
493 ACPI_WALK_STATE *WalkState,
494 ACPI_OPERAND_OBJECT *ReturnDesc)
495{
496 ACPI_STATUS Status;
497
498
499 ACPI_FUNCTION_TRACE_PTR ("DsRestartControlMethod", WalkState);
500
501
502 if (ReturnDesc)
503 {
504 if (WalkState->ReturnUsed)
505 {
506 /*
507 * Get the return value (if any) from the previous method.
508 * NULL if no return value
509 */
510 Status = AcpiDsResultPush (ReturnDesc, WalkState);
511 if (ACPI_FAILURE (Status))
512 {
513 AcpiUtRemoveReference (ReturnDesc);
514 return_ACPI_STATUS (Status);
515 }
516 }
517 else
518 {
519 /*
520 * Delete the return value if it will not be used by the
521 * calling method
522 */
523 AcpiUtRemoveReference (ReturnDesc);
524 }
525 }
526
527 ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH,
528 "Method=%p Return=%p ReturnUsed?=%X ResStack=%p State=%p\n",
529 WalkState->MethodCallOp, ReturnDesc, WalkState->ReturnUsed,
530 WalkState->Results, WalkState));
531
532 return_ACPI_STATUS (AE_OK);
533}
534
535
536/*******************************************************************************
537 *
538 * FUNCTION: AcpiDsTerminateControlMethod
539 *
540 * PARAMETERS: WalkState - State of the method
541 *
542 * RETURN: Status
543 *
544 * DESCRIPTION: Terminate a control method. Delete everything that the method
545 * created, delete all locals and arguments, and delete the parse
546 * tree if requested.
547 *
548 ******************************************************************************/
549
550ACPI_STATUS
551AcpiDsTerminateControlMethod (
552 ACPI_WALK_STATE *WalkState)
553{
554 ACPI_OPERAND_OBJECT *ObjDesc;
555 ACPI_NAMESPACE_NODE *MethodNode;
556 ACPI_STATUS Status;
557
558
559 ACPI_FUNCTION_TRACE_PTR ("DsTerminateControlMethod", WalkState);
560
561
562 if (!WalkState)
563 {
564 return (AE_BAD_PARAMETER);
565 }
566
567 /* The current method object was saved in the walk state */
568
569 ObjDesc = WalkState->MethodDesc;
570 if (!ObjDesc)
571 {
572 return_ACPI_STATUS (AE_OK);
573 }
574
575 /* Delete all arguments and locals */
576
577 AcpiDsMethodDataDeleteAll (WalkState);
578
579 /*
580 * Lock the parser while we terminate this method.
581 * If this is the last thread executing the method,
582 * we have additional cleanup to perform
583 */
584 Status = AcpiUtAcquireMutex (ACPI_MTX_PARSER);
585 if (ACPI_FAILURE (Status))
586 {
587 return_ACPI_STATUS (Status);
588 }
589
590 /* Signal completion of the execution of this method if necessary */
591
592 if (WalkState->MethodDesc->Method.Semaphore)
593 {
594 Status = AcpiOsSignalSemaphore (
595 WalkState->MethodDesc->Method.Semaphore, 1);
596 if (ACPI_FAILURE (Status))
597 {
598 ACPI_REPORT_ERROR (("Could not signal method semaphore\n"));
599 Status = AE_OK;
600
601 /* Ignore error and continue cleanup */
602 }
603 }
604
605 /* Decrement the thread count on the method parse tree */
606
607 WalkState->MethodDesc->Method.ThreadCount--;
608 if (!WalkState->MethodDesc->Method.ThreadCount)
609 {
610 /*
611 * There are no more threads executing this method. Perform
612 * additional cleanup.
613 *
614 * The method Node is stored in the walk state
615 */
616 MethodNode = WalkState->MethodNode;
617
618 /*
619 * Delete any namespace entries created immediately underneath
620 * the method
621 */
622 Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
623 if (ACPI_FAILURE (Status))
624 {
625 return_ACPI_STATUS (Status);
626 }
627
628 if (MethodNode->Child)
629 {
630 AcpiNsDeleteNamespaceSubtree (MethodNode);
631 }
632
633 /*
634 * Delete any namespace entries created anywhere else within
635 * the namespace
636 */
637 AcpiNsDeleteNamespaceByOwner (WalkState->MethodDesc->Method.OwningId);
638 Status = AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
639 if (ACPI_FAILURE (Status))
640 {
641 return_ACPI_STATUS (Status);
642 }
643 }
644
645 Status = AcpiUtReleaseMutex (ACPI_MTX_PARSER);
646 return_ACPI_STATUS (Status);
647}
648
649