blob: 97ed86aee0dc79e75218eb2f28642e80519c769b [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/******************************************************************************
2 *
3 * Module Name: dsmethod - Parser/Interpreter interface - control method parsing
4 *
5 *****************************************************************************/
6
7/*
Bob Moorefbb7a2d2014-02-08 09:42:25 +08008 * Copyright (C) 2000 - 2014, Intel Corp.
Linus Torvalds1da177e2005-04-16 15:20:36 -07009 * All rights reserved.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
25 *
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
29 *
30 * NO WARRANTY
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
42 */
43
Linus Torvalds1da177e2005-04-16 15:20:36 -070044#include <acpi/acpi.h>
Len Browne2f7a772009-01-09 00:30:03 -050045#include "accommon.h"
Len Browne2f7a772009-01-09 00:30:03 -050046#include "acdispat.h"
47#include "acinterp.h"
48#include "acnamesp.h"
Len Brown5b929aa2009-01-08 23:44:17 -050049#ifdef ACPI_DISASSEMBLER
Lv Zheng56324c12012-12-19 05:37:03 +000050#include "acdisasm.h"
Len Brown5b929aa2009-01-08 23:44:17 -050051#endif
Bob Moore22b5afc2014-03-24 14:49:00 +080052#include "acparser.h"
53#include "amlcode.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070054
Linus Torvalds1da177e2005-04-16 15:20:36 -070055#define _COMPONENT ACPI_DISPATCHER
Len Brown4be44fc2005-08-05 00:44:28 -040056ACPI_MODULE_NAME("dsmethod")
Linus Torvalds1da177e2005-04-16 15:20:36 -070057
Bob Moore967440e32006-06-23 17:04:00 -040058/* Local prototypes */
59static acpi_status
Bob Moore22b5afc2014-03-24 14:49:00 +080060acpi_ds_detect_named_opcodes(struct acpi_walk_state *walk_state,
61 union acpi_parse_object **out_op);
62
63static acpi_status
Bob Moore967440e32006-06-23 17:04:00 -040064acpi_ds_create_method_mutex(union acpi_operand_object *method_desc);
65
Linus Torvalds1da177e2005-04-16 15:20:36 -070066/*******************************************************************************
67 *
Bob Moore22b5afc2014-03-24 14:49:00 +080068 * FUNCTION: acpi_ds_auto_serialize_method
69 *
70 * PARAMETERS: node - Namespace Node of the method
71 * obj_desc - Method object attached to node
72 *
73 * RETURN: Status
74 *
75 * DESCRIPTION: Parse a control method AML to scan for control methods that
76 * need serialization due to the creation of named objects.
77 *
78 * NOTE: It is a bit of overkill to mark all such methods serialized, since
79 * there is only a problem if the method actually blocks during execution.
80 * A blocking operation is, for example, a Sleep() operation, or any access
81 * to an operation region. However, it is probably not possible to easily
82 * detect whether a method will block or not, so we simply mark all suspicious
83 * methods as serialized.
84 *
85 * NOTE2: This code is essentially a generic routine for parsing a single
86 * control method.
87 *
88 ******************************************************************************/
89
90acpi_status
91acpi_ds_auto_serialize_method(struct acpi_namespace_node *node,
92 union acpi_operand_object *obj_desc)
93{
94 acpi_status status;
95 union acpi_parse_object *op = NULL;
96 struct acpi_walk_state *walk_state;
97
98 ACPI_FUNCTION_TRACE_PTR(ds_auto_serialize_method, node);
99
100 ACPI_DEBUG_PRINT((ACPI_DB_PARSE,
101 "Method auto-serialization parse [%4.4s] %p\n",
102 acpi_ut_get_node_name(node), node));
103
104 /* Create/Init a root op for the method parse tree */
105
106 op = acpi_ps_alloc_op(AML_METHOD_OP);
107 if (!op) {
108 return_ACPI_STATUS(AE_NO_MEMORY);
109 }
110
111 acpi_ps_set_name(op, node->name.integer);
112 op->common.node = node;
113
114 /* Create and initialize a new walk state */
115
116 walk_state =
117 acpi_ds_create_walk_state(node->owner_id, NULL, NULL, NULL);
118 if (!walk_state) {
119 return_ACPI_STATUS(AE_NO_MEMORY);
120 }
121
122 status =
123 acpi_ds_init_aml_walk(walk_state, op, node,
124 obj_desc->method.aml_start,
125 obj_desc->method.aml_length, NULL, 0);
126 if (ACPI_FAILURE(status)) {
127 acpi_ds_delete_walk_state(walk_state);
128 return_ACPI_STATUS(status);
129 }
130
131 walk_state->descending_callback = acpi_ds_detect_named_opcodes;
132
133 /* Parse the method, scan for creation of named objects */
134
135 status = acpi_ps_parse_aml(walk_state);
136 if (ACPI_FAILURE(status)) {
137 return_ACPI_STATUS(status);
138 }
139
140 acpi_ps_delete_parse_tree(op);
141 return_ACPI_STATUS(status);
142}
143
144/*******************************************************************************
145 *
146 * FUNCTION: acpi_ds_detect_named_opcodes
147 *
148 * PARAMETERS: walk_state - Current state of the parse tree walk
149 * out_op - Unused, required for parser interface
150 *
151 * RETURN: Status
152 *
153 * DESCRIPTION: Descending callback used during the loading of ACPI tables.
154 * Currently used to detect methods that must be marked serialized
155 * in order to avoid problems with the creation of named objects.
156 *
157 ******************************************************************************/
158
159static acpi_status
160acpi_ds_detect_named_opcodes(struct acpi_walk_state *walk_state,
161 union acpi_parse_object **out_op)
162{
163
164 ACPI_FUNCTION_NAME(acpi_ds_detect_named_opcodes);
165
166 /* We are only interested in opcodes that have an associated name */
167
168 if (!(walk_state->op_info->flags & AML_NAMED)) {
169 return (AE_OK);
170 }
171
172 /*
173 * At this point, we know we have a Named object opcode.
174 * Mark the method as serialized. Later code will create a mutex for
175 * this method to enforce serialization.
176 */
177 walk_state->method_desc->method.info_flags |= ACPI_METHOD_SERIALIZED;
178
179 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
180 "Method serialized [%4.4s] %p - [%s] (%4.4X)\n",
181 walk_state->method_node->name.ascii,
182 walk_state->method_node, walk_state->op_info->name,
183 walk_state->opcode));
184
185 /* Abort the parse, no need to examine this method any further */
186
187 return (AE_CTRL_TERMINATE);
188}
189
190/*******************************************************************************
191 *
Bob Mooredefba1d2005-12-16 17:05:00 -0500192 * FUNCTION: acpi_ds_method_error
193 *
Bob Mooreba494be2012-07-12 09:40:10 +0800194 * PARAMETERS: status - Execution status
Bob Mooredefba1d2005-12-16 17:05:00 -0500195 * walk_state - Current state
196 *
197 * RETURN: Status
198 *
199 * DESCRIPTION: Called on method error. Invoke the global exception handler if
200 * present, dump the method data if the disassembler is configured
201 *
202 * Note: Allows the exception handler to change the status code
203 *
204 ******************************************************************************/
Bob Moore967440e32006-06-23 17:04:00 -0400205
Bob Mooredefba1d2005-12-16 17:05:00 -0500206acpi_status
Bob Moore22b5afc2014-03-24 14:49:00 +0800207acpi_ds_method_error(acpi_status status, struct acpi_walk_state * walk_state)
Bob Mooredefba1d2005-12-16 17:05:00 -0500208{
209 ACPI_FUNCTION_ENTRY();
210
211 /* Ignore AE_OK and control exception codes */
212
213 if (ACPI_SUCCESS(status) || (status & AE_CODE_CONTROL)) {
214 return (status);
215 }
216
217 /* Invoke the global exception handler */
218
219 if (acpi_gbl_exception_handler) {
Bob Moore52fc0b02006-10-02 00:00:00 -0400220
Bob Mooredefba1d2005-12-16 17:05:00 -0500221 /* Exit the interpreter, allow handler to execute methods */
222
223 acpi_ex_exit_interpreter();
224
225 /*
226 * Handler can map the exception code to anything it wants, including
227 * AE_OK, in which case the executing method will not be aborted.
228 */
229 status = acpi_gbl_exception_handler(status,
230 walk_state->method_node ?
231 walk_state->method_node->
232 name.integer : 0,
233 walk_state->opcode,
234 walk_state->aml_offset,
235 NULL);
Bob Mooreb7f9f042008-04-10 19:06:40 +0400236 acpi_ex_enter_interpreter();
Bob Mooredefba1d2005-12-16 17:05:00 -0500237 }
Lin Mingd8a0ec92008-09-27 11:50:24 +0800238
239 acpi_ds_clear_implicit_return(walk_state);
240
Bob Mooredefba1d2005-12-16 17:05:00 -0500241#ifdef ACPI_DISASSEMBLER
242 if (ACPI_FAILURE(status)) {
Bob Moore52fc0b02006-10-02 00:00:00 -0400243
Bob Mooredefba1d2005-12-16 17:05:00 -0500244 /* Display method locals/args if disassembler is present */
245
246 acpi_dm_dump_method_info(status, walk_state, walk_state->op);
247 }
248#endif
249
250 return (status);
251}
252
253/*******************************************************************************
254 *
Bob Moore967440e32006-06-23 17:04:00 -0400255 * FUNCTION: acpi_ds_create_method_mutex
256 *
257 * PARAMETERS: obj_desc - The method object
258 *
259 * RETURN: Status
260 *
261 * DESCRIPTION: Create a mutex object for a serialized control method
262 *
263 ******************************************************************************/
264
265static acpi_status
266acpi_ds_create_method_mutex(union acpi_operand_object *method_desc)
267{
268 union acpi_operand_object *mutex_desc;
269 acpi_status status;
270
Bob Mooref6dd9222006-07-07 20:44:38 -0400271 ACPI_FUNCTION_TRACE(ds_create_method_mutex);
Bob Moore967440e32006-06-23 17:04:00 -0400272
273 /* Create the new mutex object */
274
275 mutex_desc = acpi_ut_create_internal_object(ACPI_TYPE_MUTEX);
276 if (!mutex_desc) {
277 return_ACPI_STATUS(AE_NO_MEMORY);
278 }
279
280 /* Create the actual OS Mutex */
281
282 status = acpi_os_create_mutex(&mutex_desc->mutex.os_mutex);
283 if (ACPI_FAILURE(status)) {
Tim Gardner78d025e2012-12-31 00:06:56 +0000284 acpi_ut_delete_object_desc(mutex_desc);
Bob Moore967440e32006-06-23 17:04:00 -0400285 return_ACPI_STATUS(status);
286 }
287
288 mutex_desc->mutex.sync_level = method_desc->method.sync_level;
289 method_desc->method.mutex = mutex_desc;
290 return_ACPI_STATUS(AE_OK);
291}
292
293/*******************************************************************************
294 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295 * FUNCTION: acpi_ds_begin_method_execution
296 *
297 * PARAMETERS: method_node - Node of the method
298 * obj_desc - The method object
Bob Moore967440e32006-06-23 17:04:00 -0400299 * walk_state - current state, NULL if not yet executing
300 * a method.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301 *
302 * RETURN: Status
303 *
Bob Moore73a30902012-10-31 02:26:55 +0000304 * DESCRIPTION: Prepare a method for execution. Parses the method if necessary,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305 * increments the thread count, and waits at the method semaphore
306 * for clearance to execute.
307 *
308 ******************************************************************************/
Bob Mooredefba1d2005-12-16 17:05:00 -0500309
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310acpi_status
Bob Moore967440e32006-06-23 17:04:00 -0400311acpi_ds_begin_method_execution(struct acpi_namespace_node *method_node,
312 union acpi_operand_object *obj_desc,
313 struct acpi_walk_state *walk_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314{
Len Brown4be44fc2005-08-05 00:44:28 -0400315 acpi_status status = AE_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316
Bob Mooreb229cf92006-04-21 17:15:00 -0400317 ACPI_FUNCTION_TRACE_PTR(ds_begin_method_execution, method_node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318
319 if (!method_node) {
Len Brown4be44fc2005-08-05 00:44:28 -0400320 return_ACPI_STATUS(AE_NULL_ENTRY);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321 }
322
Robert Mooreaff8c272005-09-02 17:24:17 -0400323 /* Prevent wraparound of thread count */
324
325 if (obj_desc->method.thread_count == ACPI_UINT8_MAX) {
Bob Mooreb8e4d892006-01-27 16:43:00 -0500326 ACPI_ERROR((AE_INFO,
327 "Method reached maximum reentrancy limit (255)"));
Robert Mooreaff8c272005-09-02 17:24:17 -0400328 return_ACPI_STATUS(AE_AML_METHOD_LIMIT);
329 }
330
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331 /*
Bob Moore967440e32006-06-23 17:04:00 -0400332 * If this method is serialized, we need to acquire the method mutex.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333 */
Lin Ming26294842011-01-12 09:19:43 +0800334 if (obj_desc->method.info_flags & ACPI_METHOD_SERIALIZED) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335 /*
Bob Moore967440e32006-06-23 17:04:00 -0400336 * Create a mutex for the method if it is defined to be Serialized
337 * and a mutex has not already been created. We defer the mutex creation
338 * until a method is actually executed, to minimize the object count
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339 */
Bob Moore967440e32006-06-23 17:04:00 -0400340 if (!obj_desc->method.mutex) {
341 status = acpi_ds_create_method_mutex(obj_desc);
342 if (ACPI_FAILURE(status)) {
343 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344 }
345 }
346
347 /*
Bob Moore967440e32006-06-23 17:04:00 -0400348 * The current_sync_level (per-thread) must be less than or equal to
349 * the sync level of the method. This mechanism provides some
350 * deadlock prevention
351 *
352 * Top-level method invocation has no walk state at this point
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353 */
Bob Moore967440e32006-06-23 17:04:00 -0400354 if (walk_state &&
355 (walk_state->thread->current_sync_level >
356 obj_desc->method.mutex->mutex.sync_level)) {
357 ACPI_ERROR((AE_INFO,
Bob Mooref6a22b02010-03-05 17:56:40 +0800358 "Cannot acquire Mutex for method [%4.4s], current SyncLevel is too large (%u)",
Bob Moore967440e32006-06-23 17:04:00 -0400359 acpi_ut_get_node_name(method_node),
360 walk_state->thread->current_sync_level));
361
362 return_ACPI_STATUS(AE_AML_MUTEX_ORDER);
Bob Mooreb229cf92006-04-21 17:15:00 -0400363 }
Bob Moore967440e32006-06-23 17:04:00 -0400364
365 /*
366 * Obtain the method mutex if necessary. Do not acquire mutex for a
367 * recursive call.
368 */
Len Brown262a7a22007-05-09 23:01:59 -0400369 if (!walk_state ||
Bob Mooreba886cd2008-04-10 19:06:37 +0400370 !obj_desc->method.mutex->mutex.thread_id ||
371 (walk_state->thread->thread_id !=
372 obj_desc->method.mutex->mutex.thread_id)) {
Bob Moore967440e32006-06-23 17:04:00 -0400373 /*
374 * Acquire the method mutex. This releases the interpreter if we
375 * block (and reacquires it before it returns)
376 */
377 status =
378 acpi_ex_system_wait_mutex(obj_desc->method.mutex->
379 mutex.os_mutex,
380 ACPI_WAIT_FOREVER);
381 if (ACPI_FAILURE(status)) {
382 return_ACPI_STATUS(status);
383 }
384
385 /* Update the mutex and walk info and save the original sync_level */
386
387 if (walk_state) {
388 obj_desc->method.mutex->mutex.
389 original_sync_level =
390 walk_state->thread->current_sync_level;
391
Bob Mooreba886cd2008-04-10 19:06:37 +0400392 obj_desc->method.mutex->mutex.thread_id =
393 walk_state->thread->thread_id;
Bob Moore967440e32006-06-23 17:04:00 -0400394 walk_state->thread->current_sync_level =
395 obj_desc->method.sync_level;
396 } else {
397 obj_desc->method.mutex->mutex.
398 original_sync_level =
399 obj_desc->method.mutex->mutex.sync_level;
400 }
401 }
402
403 /* Always increase acquisition depth */
404
405 obj_desc->method.mutex->mutex.acquisition_depth++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406 }
407
408 /*
Robert Mooreaff8c272005-09-02 17:24:17 -0400409 * Allocate an Owner ID for this method, only if this is the first thread
410 * to begin concurrent execution. We only need one owner_id, even if the
411 * method is invoked recursively.
412 */
413 if (!obj_desc->method.owner_id) {
414 status = acpi_ut_allocate_owner_id(&obj_desc->method.owner_id);
415 if (ACPI_FAILURE(status)) {
Bob Mooreb229cf92006-04-21 17:15:00 -0400416 goto cleanup;
Robert Mooreaff8c272005-09-02 17:24:17 -0400417 }
418 }
419
420 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421 * Increment the method parse tree thread count since it has been
422 * reentered one more time (even if it is the same thread)
423 */
424 obj_desc->method.thread_count++;
Lv Zheng9187a412013-10-31 09:30:28 +0800425 acpi_method_count++;
Len Brown4be44fc2005-08-05 00:44:28 -0400426 return_ACPI_STATUS(status);
Bob Mooreb229cf92006-04-21 17:15:00 -0400427
Lv Zheng10622bf2013-10-29 09:30:02 +0800428cleanup:
Bob Moore967440e32006-06-23 17:04:00 -0400429 /* On error, must release the method mutex (if present) */
Bob Mooreb229cf92006-04-21 17:15:00 -0400430
Bob Moore967440e32006-06-23 17:04:00 -0400431 if (obj_desc->method.mutex) {
432 acpi_os_release_mutex(obj_desc->method.mutex->mutex.os_mutex);
Bob Mooreb229cf92006-04-21 17:15:00 -0400433 }
434 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435}
436
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437/*******************************************************************************
438 *
439 * FUNCTION: acpi_ds_call_control_method
440 *
Bob Mooreba494be2012-07-12 09:40:10 +0800441 * PARAMETERS: thread - Info for this thread
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442 * this_walk_state - Current walk state
Bob Mooreba494be2012-07-12 09:40:10 +0800443 * op - Current Op to be walked
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444 *
445 * RETURN: Status
446 *
447 * DESCRIPTION: Transfer execution to a called control method
448 *
449 ******************************************************************************/
450
451acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400452acpi_ds_call_control_method(struct acpi_thread_state *thread,
453 struct acpi_walk_state *this_walk_state,
454 union acpi_parse_object *op)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455{
Len Brown4be44fc2005-08-05 00:44:28 -0400456 acpi_status status;
457 struct acpi_namespace_node *method_node;
458 struct acpi_walk_state *next_walk_state = NULL;
459 union acpi_operand_object *obj_desc;
Bob Moore41195322006-05-26 16:36:00 -0400460 struct acpi_evaluate_info *info;
Len Brown4be44fc2005-08-05 00:44:28 -0400461 u32 i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462
Bob Mooreb229cf92006-04-21 17:15:00 -0400463 ACPI_FUNCTION_TRACE_PTR(ds_call_control_method, this_walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700464
Len Brown4be44fc2005-08-05 00:44:28 -0400465 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
Valery Podrezov9bc75cf2007-02-02 19:48:21 +0300466 "Calling method %p, currentstate=%p\n",
Len Brown4be44fc2005-08-05 00:44:28 -0400467 this_walk_state->prev_op, this_walk_state));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468
469 /*
470 * Get the namespace entry for the control method we are about to call
471 */
472 method_node = this_walk_state->method_call_node;
473 if (!method_node) {
Len Brown4be44fc2005-08-05 00:44:28 -0400474 return_ACPI_STATUS(AE_NULL_ENTRY);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475 }
476
Len Brown4be44fc2005-08-05 00:44:28 -0400477 obj_desc = acpi_ns_get_attached_object(method_node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478 if (!obj_desc) {
Len Brown4be44fc2005-08-05 00:44:28 -0400479 return_ACPI_STATUS(AE_NULL_OBJECT);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480 }
481
Bob Moore967440e32006-06-23 17:04:00 -0400482 /* Init for new method, possibly wait on method mutex */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483
Len Brown4be44fc2005-08-05 00:44:28 -0400484 status = acpi_ds_begin_method_execution(method_node, obj_desc,
Bob Moore967440e32006-06-23 17:04:00 -0400485 this_walk_state);
Len Brown4be44fc2005-08-05 00:44:28 -0400486 if (ACPI_FAILURE(status)) {
Bob Mooreb229cf92006-04-21 17:15:00 -0400487 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488 }
489
Valery Podrezov9bc75cf2007-02-02 19:48:21 +0300490 /* Begin method parse/execution. Create a new walk state */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491
Len Brown4be44fc2005-08-05 00:44:28 -0400492 next_walk_state = acpi_ds_create_walk_state(obj_desc->method.owner_id,
493 NULL, obj_desc, thread);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700494 if (!next_walk_state) {
495 status = AE_NO_MEMORY;
496 goto cleanup;
497 }
Bob Mooreb229cf92006-04-21 17:15:00 -0400498
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499 /*
500 * The resolved arguments were put on the previous walk state's operand
Robert Mooreaff8c272005-09-02 17:24:17 -0400501 * stack. Operands on the previous walk state stack always
502 * start at index 0. Also, null terminate the list of arguments
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503 */
Len Brown4be44fc2005-08-05 00:44:28 -0400504 this_walk_state->operands[this_walk_state->num_operands] = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505
Bob Moore41195322006-05-26 16:36:00 -0400506 /*
507 * Allocate and initialize the evaluation information block
508 * TBD: this is somewhat inefficient, should change interface to
509 * ds_init_aml_walk. For now, keeps this struct off the CPU stack
510 */
511 info = ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_evaluate_info));
512 if (!info) {
Jesper Juhl22715822012-12-19 05:37:47 +0000513 status = AE_NO_MEMORY;
514 goto cleanup;
Bob Moore41195322006-05-26 16:36:00 -0400515 }
516
517 info->parameters = &this_walk_state->operands[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518
Len Brown4be44fc2005-08-05 00:44:28 -0400519 status = acpi_ds_init_aml_walk(next_walk_state, NULL, method_node,
520 obj_desc->method.aml_start,
Bob Mooreec3153f2007-02-02 19:48:21 +0300521 obj_desc->method.aml_length, info,
522 ACPI_IMODE_EXECUTE);
Bob Moore41195322006-05-26 16:36:00 -0400523
524 ACPI_FREE(info);
Len Brown4be44fc2005-08-05 00:44:28 -0400525 if (ACPI_FAILURE(status)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526 goto cleanup;
527 }
528
529 /*
530 * Delete the operands on the previous walkstate operand stack
531 * (they were copied to new objects)
532 */
533 for (i = 0; i < obj_desc->method.param_count; i++) {
Len Brown4be44fc2005-08-05 00:44:28 -0400534 acpi_ut_remove_reference(this_walk_state->operands[i]);
535 this_walk_state->operands[i] = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536 }
537
538 /* Clear the operand stack */
539
540 this_walk_state->num_operands = 0;
541
Len Brown4be44fc2005-08-05 00:44:28 -0400542 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
Valery Podrezov9bc75cf2007-02-02 19:48:21 +0300543 "**** Begin nested execution of [%4.4s] **** WalkState=%p\n",
544 method_node->name.ascii, next_walk_state));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545
Bob Mooreb229cf92006-04-21 17:15:00 -0400546 /* Invoke an internal method if necessary */
547
Lin Ming26294842011-01-12 09:19:43 +0800548 if (obj_desc->method.info_flags & ACPI_METHOD_INTERNAL_ONLY) {
549 status =
550 obj_desc->method.dispatch.implementation(next_walk_state);
Bob Moorea8fadc92008-11-13 09:45:35 +0800551 if (status == AE_OK) {
552 status = AE_CTRL_TERMINATE;
553 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554 }
555
Robert Mooreaff8c272005-09-02 17:24:17 -0400556 return_ACPI_STATUS(status);
557
Lv Zheng10622bf2013-10-29 09:30:02 +0800558cleanup:
Robert Mooreaff8c272005-09-02 17:24:17 -0400559
Bob Mooreb229cf92006-04-21 17:15:00 -0400560 /* On error, we must terminate the method properly */
561
562 acpi_ds_terminate_control_method(obj_desc, next_walk_state);
563 if (next_walk_state) {
564 acpi_ds_delete_walk_state(next_walk_state);
Robert Mooreaff8c272005-09-02 17:24:17 -0400565 }
Len Browna94f1882005-09-03 00:09:12 -0400566
Len Brown4be44fc2005-08-05 00:44:28 -0400567 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568}
569
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570/*******************************************************************************
571 *
572 * FUNCTION: acpi_ds_restart_control_method
573 *
574 * PARAMETERS: walk_state - State for preempted method (caller)
575 * return_desc - Return value from the called method
576 *
577 * RETURN: Status
578 *
579 * DESCRIPTION: Restart a method that was preempted by another (nested) method
Bob Moore73a30902012-10-31 02:26:55 +0000580 * invocation. Handle the return value (if any) from the callee.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581 *
582 ******************************************************************************/
583
584acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400585acpi_ds_restart_control_method(struct acpi_walk_state *walk_state,
586 union acpi_operand_object *return_desc)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587{
Len Brown4be44fc2005-08-05 00:44:28 -0400588 acpi_status status;
Bob Moore958dd242006-05-12 17:12:00 -0400589 int same_as_implicit_return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590
Bob Mooreb229cf92006-04-21 17:15:00 -0400591 ACPI_FUNCTION_TRACE_PTR(ds_restart_control_method, walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592
Len Brown4be44fc2005-08-05 00:44:28 -0400593 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
Bob Mooreb229cf92006-04-21 17:15:00 -0400594 "****Restart [%4.4s] Op %p ReturnValueFromCallee %p\n",
Bob Mooref6dd9222006-07-07 20:44:38 -0400595 acpi_ut_get_node_name(walk_state->method_node),
Len Brown4be44fc2005-08-05 00:44:28 -0400596 walk_state->method_call_op, return_desc));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597
Len Brown4be44fc2005-08-05 00:44:28 -0400598 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
Bob Mooreb229cf92006-04-21 17:15:00 -0400599 " ReturnFromThisMethodUsed?=%X ResStack %p Walk %p\n",
Len Brown4be44fc2005-08-05 00:44:28 -0400600 walk_state->return_used,
601 walk_state->results, walk_state));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602
603 /* Did the called method return a value? */
604
605 if (return_desc) {
Bob Moore52fc0b02006-10-02 00:00:00 -0400606
Bob Moore958dd242006-05-12 17:12:00 -0400607 /* Is the implicit return object the same as the return desc? */
608
609 same_as_implicit_return =
610 (walk_state->implicit_return_obj == return_desc);
611
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612 /* Are we actually going to use the return value? */
613
614 if (walk_state->return_used) {
Bob Moore52fc0b02006-10-02 00:00:00 -0400615
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616 /* Save the return value from the previous method */
617
Len Brown4be44fc2005-08-05 00:44:28 -0400618 status = acpi_ds_result_push(return_desc, walk_state);
619 if (ACPI_FAILURE(status)) {
620 acpi_ut_remove_reference(return_desc);
621 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622 }
623
624 /*
625 * Save as THIS method's return value in case it is returned
626 * immediately to yet another method
627 */
628 walk_state->return_desc = return_desc;
629 }
630
631 /*
Bob Moore958dd242006-05-12 17:12:00 -0400632 * The following code is the optional support for the so-called
633 * "implicit return". Some AML code assumes that the last value of the
634 * method is "implicitly" returned to the caller, in the absence of an
635 * explicit return value.
636 *
637 * Just save the last result of the method as the return value.
638 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639 * NOTE: this is optional because the ASL language does not actually
640 * support this behavior.
641 */
Len Brown4be44fc2005-08-05 00:44:28 -0400642 else if (!acpi_ds_do_implicit_return
Bob Moore958dd242006-05-12 17:12:00 -0400643 (return_desc, walk_state, FALSE)
644 || same_as_implicit_return) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645 /*
646 * Delete the return value if it will not be used by the
Bob Moore958dd242006-05-12 17:12:00 -0400647 * calling method or remove one reference if the explicit return
648 * is the same as the implicit return value.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700649 */
Len Brown4be44fc2005-08-05 00:44:28 -0400650 acpi_ut_remove_reference(return_desc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651 }
652 }
653
Len Brown4be44fc2005-08-05 00:44:28 -0400654 return_ACPI_STATUS(AE_OK);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655}
656
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657/*******************************************************************************
658 *
659 * FUNCTION: acpi_ds_terminate_control_method
660 *
Bob Mooreb229cf92006-04-21 17:15:00 -0400661 * PARAMETERS: method_desc - Method object
662 * walk_state - State associated with the method
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663 *
Robert Mooreaff8c272005-09-02 17:24:17 -0400664 * RETURN: None
Linus Torvalds1da177e2005-04-16 15:20:36 -0700665 *
Bob Moore73a30902012-10-31 02:26:55 +0000666 * DESCRIPTION: Terminate a control method. Delete everything that the method
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667 * created, delete all locals and arguments, and delete the parse
668 * tree if requested.
669 *
Bob Moore967440e32006-06-23 17:04:00 -0400670 * MUTEX: Interpreter is locked
671 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700672 ******************************************************************************/
673
Bob Mooreb229cf92006-04-21 17:15:00 -0400674void
675acpi_ds_terminate_control_method(union acpi_operand_object *method_desc,
676 struct acpi_walk_state *walk_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678
Bob Mooreb229cf92006-04-21 17:15:00 -0400679 ACPI_FUNCTION_TRACE_PTR(ds_terminate_control_method, walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680
Bob Mooreb229cf92006-04-21 17:15:00 -0400681 /* method_desc is required, walk_state is optional */
682
683 if (!method_desc) {
Robert Mooreaff8c272005-09-02 17:24:17 -0400684 return_VOID;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700685 }
686
Bob Mooreb229cf92006-04-21 17:15:00 -0400687 if (walk_state) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700688
Bob Mooreb229cf92006-04-21 17:15:00 -0400689 /* Delete all arguments and locals */
690
691 acpi_ds_method_data_delete_all(walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700692
Bob Mooreb7f9f042008-04-10 19:06:40 +0400693 /*
694 * If method is serialized, release the mutex and restore the
695 * current sync level for this thread
696 */
697 if (method_desc->method.mutex) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700698
Bob Mooreb7f9f042008-04-10 19:06:40 +0400699 /* Acquisition Depth handles recursive calls */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700
Bob Mooreb7f9f042008-04-10 19:06:40 +0400701 method_desc->method.mutex->mutex.acquisition_depth--;
702 if (!method_desc->method.mutex->mutex.acquisition_depth) {
703 walk_state->thread->current_sync_level =
704 method_desc->method.mutex->mutex.
705 original_sync_level;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700706
Bob Mooreb7f9f042008-04-10 19:06:40 +0400707 acpi_os_release_mutex(method_desc->method.
708 mutex->mutex.os_mutex);
Lin Ming28eb3fc2010-09-15 13:55:13 +0800709 method_desc->method.mutex->mutex.thread_id = 0;
Bob Mooreb7f9f042008-04-10 19:06:40 +0400710 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700711 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712
Bob Mooreb229cf92006-04-21 17:15:00 -0400713 /*
Lin Ming7f0c8262009-08-13 14:03:15 +0800714 * Delete any namespace objects created anywhere within the
Lin Ming26294842011-01-12 09:19:43 +0800715 * namespace by the execution of this method. Unless:
716 * 1) This method is a module-level executable code method, in which
717 * case we want make the objects permanent.
718 * 2) There are other threads executing the method, in which case we
719 * will wait until the last thread has completed.
Bob Mooreb229cf92006-04-21 17:15:00 -0400720 */
Lin Ming26294842011-01-12 09:19:43 +0800721 if (!(method_desc->method.info_flags & ACPI_METHOD_MODULE_LEVEL)
722 && (method_desc->method.thread_count == 1)) {
Alexey Starikovskiya9fc0312010-05-26 13:59:51 +0800723
724 /* Delete any direct children of (created by) this method */
725
726 acpi_ns_delete_namespace_subtree(walk_state->
727 method_node);
728
729 /*
730 * Delete any objects that were created by this method
731 * elsewhere in the namespace (if any were created).
Lin Ming26294842011-01-12 09:19:43 +0800732 * Use of the ACPI_METHOD_MODIFIED_NAMESPACE optimizes the
733 * deletion such that we don't have to perform an entire
734 * namespace walk for every control method execution.
Alexey Starikovskiya9fc0312010-05-26 13:59:51 +0800735 */
736 if (method_desc->method.
Lin Ming26294842011-01-12 09:19:43 +0800737 info_flags & ACPI_METHOD_MODIFIED_NAMESPACE) {
Alexey Starikovskiya9fc0312010-05-26 13:59:51 +0800738 acpi_ns_delete_namespace_by_owner(method_desc->
739 method.
740 owner_id);
Lin Ming26294842011-01-12 09:19:43 +0800741 method_desc->method.info_flags &=
742 ~ACPI_METHOD_MODIFIED_NAMESPACE;
Alexey Starikovskiya9fc0312010-05-26 13:59:51 +0800743 }
Lin Ming7f0c8262009-08-13 14:03:15 +0800744 }
Bob Moore28f55eb2005-12-02 18:27:00 -0500745 }
746
Bob Mooreb229cf92006-04-21 17:15:00 -0400747 /* Decrement the thread count on the method */
Bob Moore28f55eb2005-12-02 18:27:00 -0500748
Bob Mooreb229cf92006-04-21 17:15:00 -0400749 if (method_desc->method.thread_count) {
750 method_desc->method.thread_count--;
751 } else {
752 ACPI_ERROR((AE_INFO, "Invalid zero thread count in method"));
753 }
Bob Moore28f55eb2005-12-02 18:27:00 -0500754
755 /* Are there any other threads currently executing this method? */
756
Bob Mooreb229cf92006-04-21 17:15:00 -0400757 if (method_desc->method.thread_count) {
Bob Moore28f55eb2005-12-02 18:27:00 -0500758 /*
759 * Additional threads. Do not release the owner_id in this case,
760 * we immediately reuse it for the next thread executing this method
761 */
Len Brown4be44fc2005-08-05 00:44:28 -0400762 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
Bob Mooreb27d6592010-05-26 11:47:13 +0800763 "*** Completed execution of one thread, %u threads remaining\n",
Bob Mooreb229cf92006-04-21 17:15:00 -0400764 method_desc->method.thread_count));
Bob Moore28f55eb2005-12-02 18:27:00 -0500765 } else {
766 /* This is the only executing thread for this method */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767
Linus Torvalds1da177e2005-04-16 15:20:36 -0700768 /*
769 * Support to dynamically change a method from not_serialized to
Bob Moore28f55eb2005-12-02 18:27:00 -0500770 * Serialized if it appears that the method is incorrectly written and
Bob Moore967440e32006-06-23 17:04:00 -0400771 * does not support multiple thread execution. The best example of this
772 * is if such a method creates namespace objects and blocks. A second
Lin Ming26294842011-01-12 09:19:43 +0800773 * thread will fail with an AE_ALREADY_EXISTS exception.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700774 *
775 * This code is here because we must wait until the last thread exits
Lin Ming26294842011-01-12 09:19:43 +0800776 * before marking the method as serialized.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777 */
Lin Ming26294842011-01-12 09:19:43 +0800778 if (method_desc->method.
779 info_flags & ACPI_METHOD_SERIALIZED_PENDING) {
780 if (walk_state) {
781 ACPI_INFO((AE_INFO,
782 "Marking method %4.4s as Serialized because of AE_ALREADY_EXISTS error",
783 walk_state->method_node->name.
784 ascii));
785 }
786
787 /*
788 * Method tried to create an object twice and was marked as
789 * "pending serialized". The probable cause is that the method
790 * cannot handle reentrancy.
791 *
792 * The method was created as not_serialized, but it tried to create
793 * a named object and then blocked, causing the second thread
794 * entrance to begin and then fail. Workaround this problem by
795 * marking the method permanently as Serialized when the last
796 * thread exits here.
797 */
798 method_desc->method.info_flags &=
799 ~ACPI_METHOD_SERIALIZED_PENDING;
800 method_desc->method.info_flags |=
801 ACPI_METHOD_SERIALIZED;
802 method_desc->method.sync_level = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803 }
804
Bob Moore28f55eb2005-12-02 18:27:00 -0500805 /* No more threads, we can free the owner_id */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700806
Lin Ming26294842011-01-12 09:19:43 +0800807 if (!
808 (method_desc->method.
809 info_flags & ACPI_METHOD_MODULE_LEVEL)) {
Lin Ming7f0c8262009-08-13 14:03:15 +0800810 acpi_ut_release_owner_id(&method_desc->method.owner_id);
811 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812 }
Len Browna94f1882005-09-03 00:09:12 -0400813
Robert Mooreaff8c272005-09-02 17:24:17 -0400814 return_VOID;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815}