blob: bc32f3194afe1675bdc767d9f1dbd26a2959b3aa [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/*
David E. Box82a80942015-02-05 15:20:45 +08008 * Copyright (C) 2000 - 2015, 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"
Bob Moore22b5afc2014-03-24 14:49:00 +080049#include "acparser.h"
50#include "amlcode.h"
Lv Zhengfdd8d832015-07-23 12:54:17 +080051#include "acdebug.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070052
Linus Torvalds1da177e2005-04-16 15:20:36 -070053#define _COMPONENT ACPI_DISPATCHER
Len Brown4be44fc2005-08-05 00:44:28 -040054ACPI_MODULE_NAME("dsmethod")
Linus Torvalds1da177e2005-04-16 15:20:36 -070055
Bob Moore967440e32006-06-23 17:04:00 -040056/* Local prototypes */
57static acpi_status
Bob Moore22b5afc2014-03-24 14:49:00 +080058acpi_ds_detect_named_opcodes(struct acpi_walk_state *walk_state,
59 union acpi_parse_object **out_op);
60
61static acpi_status
Bob Moore967440e32006-06-23 17:04:00 -040062acpi_ds_create_method_mutex(union acpi_operand_object *method_desc);
63
Linus Torvalds1da177e2005-04-16 15:20:36 -070064/*******************************************************************************
65 *
Bob Moore22b5afc2014-03-24 14:49:00 +080066 * FUNCTION: acpi_ds_auto_serialize_method
67 *
68 * PARAMETERS: node - Namespace Node of the method
69 * obj_desc - Method object attached to node
70 *
71 * RETURN: Status
72 *
73 * DESCRIPTION: Parse a control method AML to scan for control methods that
74 * need serialization due to the creation of named objects.
75 *
76 * NOTE: It is a bit of overkill to mark all such methods serialized, since
77 * there is only a problem if the method actually blocks during execution.
78 * A blocking operation is, for example, a Sleep() operation, or any access
79 * to an operation region. However, it is probably not possible to easily
80 * detect whether a method will block or not, so we simply mark all suspicious
81 * methods as serialized.
82 *
83 * NOTE2: This code is essentially a generic routine for parsing a single
84 * control method.
85 *
86 ******************************************************************************/
87
88acpi_status
89acpi_ds_auto_serialize_method(struct acpi_namespace_node *node,
90 union acpi_operand_object *obj_desc)
91{
92 acpi_status status;
93 union acpi_parse_object *op = NULL;
94 struct acpi_walk_state *walk_state;
95
96 ACPI_FUNCTION_TRACE_PTR(ds_auto_serialize_method, node);
97
98 ACPI_DEBUG_PRINT((ACPI_DB_PARSE,
99 "Method auto-serialization parse [%4.4s] %p\n",
100 acpi_ut_get_node_name(node), node));
101
102 /* Create/Init a root op for the method parse tree */
103
Lv Zheng62eb9352015-07-23 12:52:24 +0800104 op = acpi_ps_alloc_op(AML_METHOD_OP, obj_desc->method.aml_start);
Bob Moore22b5afc2014-03-24 14:49:00 +0800105 if (!op) {
106 return_ACPI_STATUS(AE_NO_MEMORY);
107 }
108
109 acpi_ps_set_name(op, node->name.integer);
110 op->common.node = node;
111
112 /* Create and initialize a new walk state */
113
114 walk_state =
115 acpi_ds_create_walk_state(node->owner_id, NULL, NULL, NULL);
116 if (!walk_state) {
Lv Zhengc8dec742015-05-21 10:31:06 +0800117 acpi_ps_free_op(op);
Bob Moore22b5afc2014-03-24 14:49:00 +0800118 return_ACPI_STATUS(AE_NO_MEMORY);
119 }
120
121 status =
122 acpi_ds_init_aml_walk(walk_state, op, node,
123 obj_desc->method.aml_start,
124 obj_desc->method.aml_length, NULL, 0);
125 if (ACPI_FAILURE(status)) {
126 acpi_ds_delete_walk_state(walk_state);
Lv Zhengc8dec742015-05-21 10:31:06 +0800127 acpi_ps_free_op(op);
Bob Moore22b5afc2014-03-24 14:49:00 +0800128 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);
Bob Moore22b5afc2014-03-24 14:49:00 +0800136
137 acpi_ps_delete_parse_tree(op);
138 return_ACPI_STATUS(status);
139}
140
141/*******************************************************************************
142 *
143 * FUNCTION: acpi_ds_detect_named_opcodes
144 *
145 * PARAMETERS: walk_state - Current state of the parse tree walk
146 * out_op - Unused, required for parser interface
147 *
148 * RETURN: Status
149 *
150 * DESCRIPTION: Descending callback used during the loading of ACPI tables.
151 * Currently used to detect methods that must be marked serialized
152 * in order to avoid problems with the creation of named objects.
153 *
154 ******************************************************************************/
155
156static acpi_status
157acpi_ds_detect_named_opcodes(struct acpi_walk_state *walk_state,
158 union acpi_parse_object **out_op)
159{
160
161 ACPI_FUNCTION_NAME(acpi_ds_detect_named_opcodes);
162
Lv Zheng21bd7e62014-03-24 14:49:07 +0800163 /* We are only interested in opcodes that create a new name */
Bob Moore22b5afc2014-03-24 14:49:00 +0800164
Lv Zheng21bd7e62014-03-24 14:49:07 +0800165 if (!
166 (walk_state->op_info->
167 flags & (AML_NAMED | AML_CREATE | AML_FIELD))) {
Bob Moore22b5afc2014-03-24 14:49:00 +0800168 return (AE_OK);
169 }
170
171 /*
172 * At this point, we know we have a Named object opcode.
173 * Mark the method as serialized. Later code will create a mutex for
174 * this method to enforce serialization.
Bob Moored1825572014-03-24 14:49:13 +0800175 *
176 * Note, ACPI_METHOD_IGNORE_SYNC_LEVEL flag means that we will ignore the
177 * Sync Level mechanism for this method, even though it is now serialized.
178 * Otherwise, there can be conflicts with existing ASL code that actually
179 * uses sync levels.
Bob Moore22b5afc2014-03-24 14:49:00 +0800180 */
Bob Moored1825572014-03-24 14:49:13 +0800181 walk_state->method_desc->method.sync_level = 0;
182 walk_state->method_desc->method.info_flags |=
183 (ACPI_METHOD_SERIALIZED | ACPI_METHOD_IGNORE_SYNC_LEVEL);
Bob Moore22b5afc2014-03-24 14:49:00 +0800184
185 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
186 "Method serialized [%4.4s] %p - [%s] (%4.4X)\n",
187 walk_state->method_node->name.ascii,
188 walk_state->method_node, walk_state->op_info->name,
189 walk_state->opcode));
190
191 /* Abort the parse, no need to examine this method any further */
192
193 return (AE_CTRL_TERMINATE);
194}
195
196/*******************************************************************************
197 *
Bob Mooredefba1d2005-12-16 17:05:00 -0500198 * FUNCTION: acpi_ds_method_error
199 *
Bob Mooreba494be2012-07-12 09:40:10 +0800200 * PARAMETERS: status - Execution status
Bob Mooredefba1d2005-12-16 17:05:00 -0500201 * walk_state - Current state
202 *
203 * RETURN: Status
204 *
205 * DESCRIPTION: Called on method error. Invoke the global exception handler if
Lv Zhengfdd8d832015-07-23 12:54:17 +0800206 * present, dump the method data if the debugger is configured
Bob Mooredefba1d2005-12-16 17:05:00 -0500207 *
208 * Note: Allows the exception handler to change the status code
209 *
210 ******************************************************************************/
Bob Moore967440e32006-06-23 17:04:00 -0400211
Bob Mooredefba1d2005-12-16 17:05:00 -0500212acpi_status
Bob Moore22b5afc2014-03-24 14:49:00 +0800213acpi_ds_method_error(acpi_status status, struct acpi_walk_state * walk_state)
Bob Mooredefba1d2005-12-16 17:05:00 -0500214{
Lv Zheng83482f72015-07-23 12:52:11 +0800215 u32 aml_offset;
216
Bob Mooredefba1d2005-12-16 17:05:00 -0500217 ACPI_FUNCTION_ENTRY();
218
219 /* Ignore AE_OK and control exception codes */
220
221 if (ACPI_SUCCESS(status) || (status & AE_CODE_CONTROL)) {
222 return (status);
223 }
224
225 /* Invoke the global exception handler */
226
227 if (acpi_gbl_exception_handler) {
Bob Moore52fc0b02006-10-02 00:00:00 -0400228
Bob Mooredefba1d2005-12-16 17:05:00 -0500229 /* Exit the interpreter, allow handler to execute methods */
230
231 acpi_ex_exit_interpreter();
232
233 /*
234 * Handler can map the exception code to anything it wants, including
235 * AE_OK, in which case the executing method will not be aborted.
236 */
Lv Zheng83482f72015-07-23 12:52:11 +0800237 aml_offset = (u32)ACPI_PTR_DIFF(walk_state->aml,
238 walk_state->parser_state.
239 aml_start);
240
Bob Mooredefba1d2005-12-16 17:05:00 -0500241 status = acpi_gbl_exception_handler(status,
242 walk_state->method_node ?
243 walk_state->method_node->
244 name.integer : 0,
245 walk_state->opcode,
Lv Zheng83482f72015-07-23 12:52:11 +0800246 aml_offset, NULL);
Bob Mooreb7f9f042008-04-10 19:06:40 +0400247 acpi_ex_enter_interpreter();
Bob Mooredefba1d2005-12-16 17:05:00 -0500248 }
Lin Mingd8a0ec92008-09-27 11:50:24 +0800249
250 acpi_ds_clear_implicit_return(walk_state);
251
Bob Mooredefba1d2005-12-16 17:05:00 -0500252 if (ACPI_FAILURE(status)) {
Lv Zheng0bac4292015-07-23 12:52:46 +0800253 acpi_ds_dump_method_stack(status, walk_state, walk_state->op);
Bob Moore52fc0b02006-10-02 00:00:00 -0400254
Lv Zhengfdd8d832015-07-23 12:54:17 +0800255 /* Display method locals/args if debugger is present */
Bob Mooredefba1d2005-12-16 17:05:00 -0500256
Lv Zhengfdd8d832015-07-23 12:54:17 +0800257#ifdef ACPI_DEBUGGER
258 acpi_db_dump_method_info(status, walk_state);
Bob Mooredefba1d2005-12-16 17:05:00 -0500259#endif
Lv Zheng0bac4292015-07-23 12:52:46 +0800260 }
Bob Mooredefba1d2005-12-16 17:05:00 -0500261
262 return (status);
263}
264
265/*******************************************************************************
266 *
Bob Moore967440e32006-06-23 17:04:00 -0400267 * FUNCTION: acpi_ds_create_method_mutex
268 *
269 * PARAMETERS: obj_desc - The method object
270 *
271 * RETURN: Status
272 *
273 * DESCRIPTION: Create a mutex object for a serialized control method
274 *
275 ******************************************************************************/
276
277static acpi_status
278acpi_ds_create_method_mutex(union acpi_operand_object *method_desc)
279{
280 union acpi_operand_object *mutex_desc;
281 acpi_status status;
282
Bob Mooref6dd9222006-07-07 20:44:38 -0400283 ACPI_FUNCTION_TRACE(ds_create_method_mutex);
Bob Moore967440e32006-06-23 17:04:00 -0400284
285 /* Create the new mutex object */
286
287 mutex_desc = acpi_ut_create_internal_object(ACPI_TYPE_MUTEX);
288 if (!mutex_desc) {
289 return_ACPI_STATUS(AE_NO_MEMORY);
290 }
291
292 /* Create the actual OS Mutex */
293
294 status = acpi_os_create_mutex(&mutex_desc->mutex.os_mutex);
295 if (ACPI_FAILURE(status)) {
Tim Gardner78d025e2012-12-31 00:06:56 +0000296 acpi_ut_delete_object_desc(mutex_desc);
Bob Moore967440e32006-06-23 17:04:00 -0400297 return_ACPI_STATUS(status);
298 }
299
300 mutex_desc->mutex.sync_level = method_desc->method.sync_level;
301 method_desc->method.mutex = mutex_desc;
302 return_ACPI_STATUS(AE_OK);
303}
304
305/*******************************************************************************
306 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700307 * FUNCTION: acpi_ds_begin_method_execution
308 *
309 * PARAMETERS: method_node - Node of the method
310 * obj_desc - The method object
Bob Moore967440e32006-06-23 17:04:00 -0400311 * walk_state - current state, NULL if not yet executing
312 * a method.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313 *
314 * RETURN: Status
315 *
Bob Moore73a30902012-10-31 02:26:55 +0000316 * DESCRIPTION: Prepare a method for execution. Parses the method if necessary,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317 * increments the thread count, and waits at the method semaphore
318 * for clearance to execute.
319 *
320 ******************************************************************************/
Bob Mooredefba1d2005-12-16 17:05:00 -0500321
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322acpi_status
Bob Moore967440e32006-06-23 17:04:00 -0400323acpi_ds_begin_method_execution(struct acpi_namespace_node *method_node,
324 union acpi_operand_object *obj_desc,
325 struct acpi_walk_state *walk_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326{
Len Brown4be44fc2005-08-05 00:44:28 -0400327 acpi_status status = AE_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328
Bob Mooreb229cf92006-04-21 17:15:00 -0400329 ACPI_FUNCTION_TRACE_PTR(ds_begin_method_execution, method_node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330
331 if (!method_node) {
Len Brown4be44fc2005-08-05 00:44:28 -0400332 return_ACPI_STATUS(AE_NULL_ENTRY);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333 }
334
Lv Zhengab6c5732015-07-23 12:52:59 +0800335 acpi_ex_start_trace_method(method_node, obj_desc, walk_state);
Lv Zhenga616dc22015-07-23 12:52:53 +0800336
Robert Mooreaff8c272005-09-02 17:24:17 -0400337 /* Prevent wraparound of thread count */
338
339 if (obj_desc->method.thread_count == ACPI_UINT8_MAX) {
Bob Mooreb8e4d892006-01-27 16:43:00 -0500340 ACPI_ERROR((AE_INFO,
341 "Method reached maximum reentrancy limit (255)"));
Robert Mooreaff8c272005-09-02 17:24:17 -0400342 return_ACPI_STATUS(AE_AML_METHOD_LIMIT);
343 }
344
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345 /*
Bob Moore967440e32006-06-23 17:04:00 -0400346 * If this method is serialized, we need to acquire the method mutex.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347 */
Lin Ming26294842011-01-12 09:19:43 +0800348 if (obj_desc->method.info_flags & ACPI_METHOD_SERIALIZED) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349 /*
Bob Moore967440e32006-06-23 17:04:00 -0400350 * Create a mutex for the method if it is defined to be Serialized
351 * and a mutex has not already been created. We defer the mutex creation
352 * until a method is actually executed, to minimize the object count
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353 */
Bob Moore967440e32006-06-23 17:04:00 -0400354 if (!obj_desc->method.mutex) {
355 status = acpi_ds_create_method_mutex(obj_desc);
356 if (ACPI_FAILURE(status)) {
357 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358 }
359 }
360
361 /*
Bob Moore967440e32006-06-23 17:04:00 -0400362 * The current_sync_level (per-thread) must be less than or equal to
363 * the sync level of the method. This mechanism provides some
Bob Moored1825572014-03-24 14:49:13 +0800364 * deadlock prevention.
365 *
366 * If the method was auto-serialized, we just ignore the sync level
367 * mechanism, because auto-serialization of methods can interfere
368 * with ASL code that actually uses sync levels.
Bob Moore967440e32006-06-23 17:04:00 -0400369 *
370 * Top-level method invocation has no walk state at this point
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371 */
Bob Moore967440e32006-06-23 17:04:00 -0400372 if (walk_state &&
Bob Moored1825572014-03-24 14:49:13 +0800373 (!(obj_desc->method.
374 info_flags & ACPI_METHOD_IGNORE_SYNC_LEVEL))
375 && (walk_state->thread->current_sync_level >
376 obj_desc->method.mutex->mutex.sync_level)) {
Bob Moore967440e32006-06-23 17:04:00 -0400377 ACPI_ERROR((AE_INFO,
Bob Mooref6a22b02010-03-05 17:56:40 +0800378 "Cannot acquire Mutex for method [%4.4s], current SyncLevel is too large (%u)",
Bob Moore967440e32006-06-23 17:04:00 -0400379 acpi_ut_get_node_name(method_node),
380 walk_state->thread->current_sync_level));
381
382 return_ACPI_STATUS(AE_AML_MUTEX_ORDER);
Bob Mooreb229cf92006-04-21 17:15:00 -0400383 }
Bob Moore967440e32006-06-23 17:04:00 -0400384
385 /*
386 * Obtain the method mutex if necessary. Do not acquire mutex for a
387 * recursive call.
388 */
Len Brown262a7a22007-05-09 23:01:59 -0400389 if (!walk_state ||
Bob Mooreba886cd2008-04-10 19:06:37 +0400390 !obj_desc->method.mutex->mutex.thread_id ||
391 (walk_state->thread->thread_id !=
392 obj_desc->method.mutex->mutex.thread_id)) {
Bob Moore967440e32006-06-23 17:04:00 -0400393 /*
394 * Acquire the method mutex. This releases the interpreter if we
395 * block (and reacquires it before it returns)
396 */
397 status =
398 acpi_ex_system_wait_mutex(obj_desc->method.mutex->
399 mutex.os_mutex,
400 ACPI_WAIT_FOREVER);
401 if (ACPI_FAILURE(status)) {
402 return_ACPI_STATUS(status);
403 }
404
405 /* Update the mutex and walk info and save the original sync_level */
406
407 if (walk_state) {
408 obj_desc->method.mutex->mutex.
409 original_sync_level =
410 walk_state->thread->current_sync_level;
411
Bob Mooreba886cd2008-04-10 19:06:37 +0400412 obj_desc->method.mutex->mutex.thread_id =
413 walk_state->thread->thread_id;
Bob Moore967440e32006-06-23 17:04:00 -0400414 walk_state->thread->current_sync_level =
415 obj_desc->method.sync_level;
416 } else {
417 obj_desc->method.mutex->mutex.
418 original_sync_level =
419 obj_desc->method.mutex->mutex.sync_level;
420 }
421 }
422
423 /* Always increase acquisition depth */
424
425 obj_desc->method.mutex->mutex.acquisition_depth++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426 }
427
428 /*
Robert Mooreaff8c272005-09-02 17:24:17 -0400429 * Allocate an Owner ID for this method, only if this is the first thread
430 * to begin concurrent execution. We only need one owner_id, even if the
431 * method is invoked recursively.
432 */
433 if (!obj_desc->method.owner_id) {
434 status = acpi_ut_allocate_owner_id(&obj_desc->method.owner_id);
435 if (ACPI_FAILURE(status)) {
Bob Mooreb229cf92006-04-21 17:15:00 -0400436 goto cleanup;
Robert Mooreaff8c272005-09-02 17:24:17 -0400437 }
438 }
439
440 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441 * Increment the method parse tree thread count since it has been
442 * reentered one more time (even if it is the same thread)
443 */
444 obj_desc->method.thread_count++;
Lv Zheng9187a412013-10-31 09:30:28 +0800445 acpi_method_count++;
Len Brown4be44fc2005-08-05 00:44:28 -0400446 return_ACPI_STATUS(status);
Bob Mooreb229cf92006-04-21 17:15:00 -0400447
Lv Zheng10622bf2013-10-29 09:30:02 +0800448cleanup:
Bob Moore967440e32006-06-23 17:04:00 -0400449 /* On error, must release the method mutex (if present) */
Bob Mooreb229cf92006-04-21 17:15:00 -0400450
Bob Moore967440e32006-06-23 17:04:00 -0400451 if (obj_desc->method.mutex) {
452 acpi_os_release_mutex(obj_desc->method.mutex->mutex.os_mutex);
Bob Mooreb229cf92006-04-21 17:15:00 -0400453 }
454 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455}
456
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457/*******************************************************************************
458 *
459 * FUNCTION: acpi_ds_call_control_method
460 *
Bob Mooreba494be2012-07-12 09:40:10 +0800461 * PARAMETERS: thread - Info for this thread
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462 * this_walk_state - Current walk state
Bob Mooreba494be2012-07-12 09:40:10 +0800463 * op - Current Op to be walked
Linus Torvalds1da177e2005-04-16 15:20:36 -0700464 *
465 * RETURN: Status
466 *
467 * DESCRIPTION: Transfer execution to a called control method
468 *
469 ******************************************************************************/
470
471acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400472acpi_ds_call_control_method(struct acpi_thread_state *thread,
473 struct acpi_walk_state *this_walk_state,
474 union acpi_parse_object *op)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475{
Len Brown4be44fc2005-08-05 00:44:28 -0400476 acpi_status status;
477 struct acpi_namespace_node *method_node;
478 struct acpi_walk_state *next_walk_state = NULL;
479 union acpi_operand_object *obj_desc;
Bob Moore41195322006-05-26 16:36:00 -0400480 struct acpi_evaluate_info *info;
Len Brown4be44fc2005-08-05 00:44:28 -0400481 u32 i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482
Bob Mooreb229cf92006-04-21 17:15:00 -0400483 ACPI_FUNCTION_TRACE_PTR(ds_call_control_method, this_walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484
Len Brown4be44fc2005-08-05 00:44:28 -0400485 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
Valery Podrezov9bc75cf2007-02-02 19:48:21 +0300486 "Calling method %p, currentstate=%p\n",
Len Brown4be44fc2005-08-05 00:44:28 -0400487 this_walk_state->prev_op, this_walk_state));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488
489 /*
490 * Get the namespace entry for the control method we are about to call
491 */
492 method_node = this_walk_state->method_call_node;
493 if (!method_node) {
Len Brown4be44fc2005-08-05 00:44:28 -0400494 return_ACPI_STATUS(AE_NULL_ENTRY);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495 }
496
Len Brown4be44fc2005-08-05 00:44:28 -0400497 obj_desc = acpi_ns_get_attached_object(method_node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498 if (!obj_desc) {
Len Brown4be44fc2005-08-05 00:44:28 -0400499 return_ACPI_STATUS(AE_NULL_OBJECT);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500 }
501
Bob Moore967440e32006-06-23 17:04:00 -0400502 /* Init for new method, possibly wait on method mutex */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503
Len Brown4be44fc2005-08-05 00:44:28 -0400504 status = acpi_ds_begin_method_execution(method_node, obj_desc,
Bob Moore967440e32006-06-23 17:04:00 -0400505 this_walk_state);
Len Brown4be44fc2005-08-05 00:44:28 -0400506 if (ACPI_FAILURE(status)) {
Bob Mooreb229cf92006-04-21 17:15:00 -0400507 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508 }
509
Valery Podrezov9bc75cf2007-02-02 19:48:21 +0300510 /* Begin method parse/execution. Create a new walk state */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511
Len Brown4be44fc2005-08-05 00:44:28 -0400512 next_walk_state = acpi_ds_create_walk_state(obj_desc->method.owner_id,
513 NULL, obj_desc, thread);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514 if (!next_walk_state) {
515 status = AE_NO_MEMORY;
516 goto cleanup;
517 }
Bob Mooreb229cf92006-04-21 17:15:00 -0400518
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519 /*
520 * The resolved arguments were put on the previous walk state's operand
Robert Mooreaff8c272005-09-02 17:24:17 -0400521 * stack. Operands on the previous walk state stack always
522 * start at index 0. Also, null terminate the list of arguments
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523 */
Len Brown4be44fc2005-08-05 00:44:28 -0400524 this_walk_state->operands[this_walk_state->num_operands] = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525
Bob Moore41195322006-05-26 16:36:00 -0400526 /*
527 * Allocate and initialize the evaluation information block
528 * TBD: this is somewhat inefficient, should change interface to
529 * ds_init_aml_walk. For now, keeps this struct off the CPU stack
530 */
531 info = ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_evaluate_info));
532 if (!info) {
Jesper Juhl22715822012-12-19 05:37:47 +0000533 status = AE_NO_MEMORY;
534 goto cleanup;
Bob Moore41195322006-05-26 16:36:00 -0400535 }
536
537 info->parameters = &this_walk_state->operands[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538
Len Brown4be44fc2005-08-05 00:44:28 -0400539 status = acpi_ds_init_aml_walk(next_walk_state, NULL, method_node,
540 obj_desc->method.aml_start,
Bob Mooreec3153f2007-02-02 19:48:21 +0300541 obj_desc->method.aml_length, info,
542 ACPI_IMODE_EXECUTE);
Bob Moore41195322006-05-26 16:36:00 -0400543
544 ACPI_FREE(info);
Len Brown4be44fc2005-08-05 00:44:28 -0400545 if (ACPI_FAILURE(status)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546 goto cleanup;
547 }
548
549 /*
550 * Delete the operands on the previous walkstate operand stack
551 * (they were copied to new objects)
552 */
553 for (i = 0; i < obj_desc->method.param_count; i++) {
Len Brown4be44fc2005-08-05 00:44:28 -0400554 acpi_ut_remove_reference(this_walk_state->operands[i]);
555 this_walk_state->operands[i] = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556 }
557
558 /* Clear the operand stack */
559
560 this_walk_state->num_operands = 0;
561
Len Brown4be44fc2005-08-05 00:44:28 -0400562 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
Valery Podrezov9bc75cf2007-02-02 19:48:21 +0300563 "**** Begin nested execution of [%4.4s] **** WalkState=%p\n",
564 method_node->name.ascii, next_walk_state));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565
Bob Mooreb229cf92006-04-21 17:15:00 -0400566 /* Invoke an internal method if necessary */
567
Lin Ming26294842011-01-12 09:19:43 +0800568 if (obj_desc->method.info_flags & ACPI_METHOD_INTERNAL_ONLY) {
569 status =
570 obj_desc->method.dispatch.implementation(next_walk_state);
Bob Moorea8fadc92008-11-13 09:45:35 +0800571 if (status == AE_OK) {
572 status = AE_CTRL_TERMINATE;
573 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574 }
575
Robert Mooreaff8c272005-09-02 17:24:17 -0400576 return_ACPI_STATUS(status);
577
Lv Zheng10622bf2013-10-29 09:30:02 +0800578cleanup:
Robert Mooreaff8c272005-09-02 17:24:17 -0400579
Bob Mooreb229cf92006-04-21 17:15:00 -0400580 /* On error, we must terminate the method properly */
581
582 acpi_ds_terminate_control_method(obj_desc, next_walk_state);
Markus Elfringdc67d0f2015-07-23 12:53:28 +0800583 acpi_ds_delete_walk_state(next_walk_state);
Len Browna94f1882005-09-03 00:09:12 -0400584
Len Brown4be44fc2005-08-05 00:44:28 -0400585 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586}
587
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588/*******************************************************************************
589 *
590 * FUNCTION: acpi_ds_restart_control_method
591 *
592 * PARAMETERS: walk_state - State for preempted method (caller)
593 * return_desc - Return value from the called method
594 *
595 * RETURN: Status
596 *
597 * DESCRIPTION: Restart a method that was preempted by another (nested) method
Bob Moore73a30902012-10-31 02:26:55 +0000598 * invocation. Handle the return value (if any) from the callee.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599 *
600 ******************************************************************************/
601
602acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400603acpi_ds_restart_control_method(struct acpi_walk_state *walk_state,
604 union acpi_operand_object *return_desc)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605{
Len Brown4be44fc2005-08-05 00:44:28 -0400606 acpi_status status;
Bob Moore958dd242006-05-12 17:12:00 -0400607 int same_as_implicit_return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608
Bob Mooreb229cf92006-04-21 17:15:00 -0400609 ACPI_FUNCTION_TRACE_PTR(ds_restart_control_method, walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610
Len Brown4be44fc2005-08-05 00:44:28 -0400611 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
Bob Mooreb229cf92006-04-21 17:15:00 -0400612 "****Restart [%4.4s] Op %p ReturnValueFromCallee %p\n",
Bob Mooref6dd9222006-07-07 20:44:38 -0400613 acpi_ut_get_node_name(walk_state->method_node),
Len Brown4be44fc2005-08-05 00:44:28 -0400614 walk_state->method_call_op, return_desc));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615
Len Brown4be44fc2005-08-05 00:44:28 -0400616 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
Bob Mooreb229cf92006-04-21 17:15:00 -0400617 " ReturnFromThisMethodUsed?=%X ResStack %p Walk %p\n",
Len Brown4be44fc2005-08-05 00:44:28 -0400618 walk_state->return_used,
619 walk_state->results, walk_state));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620
621 /* Did the called method return a value? */
622
623 if (return_desc) {
Bob Moore52fc0b02006-10-02 00:00:00 -0400624
Bob Moore958dd242006-05-12 17:12:00 -0400625 /* Is the implicit return object the same as the return desc? */
626
627 same_as_implicit_return =
628 (walk_state->implicit_return_obj == return_desc);
629
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630 /* Are we actually going to use the return value? */
631
632 if (walk_state->return_used) {
Bob Moore52fc0b02006-10-02 00:00:00 -0400633
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634 /* Save the return value from the previous method */
635
Len Brown4be44fc2005-08-05 00:44:28 -0400636 status = acpi_ds_result_push(return_desc, walk_state);
637 if (ACPI_FAILURE(status)) {
638 acpi_ut_remove_reference(return_desc);
639 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640 }
641
642 /*
643 * Save as THIS method's return value in case it is returned
644 * immediately to yet another method
645 */
646 walk_state->return_desc = return_desc;
647 }
648
649 /*
Bob Moore958dd242006-05-12 17:12:00 -0400650 * The following code is the optional support for the so-called
651 * "implicit return". Some AML code assumes that the last value of the
652 * method is "implicitly" returned to the caller, in the absence of an
653 * explicit return value.
654 *
655 * Just save the last result of the method as the return value.
656 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657 * NOTE: this is optional because the ASL language does not actually
658 * support this behavior.
659 */
Len Brown4be44fc2005-08-05 00:44:28 -0400660 else if (!acpi_ds_do_implicit_return
Bob Moore958dd242006-05-12 17:12:00 -0400661 (return_desc, walk_state, FALSE)
662 || same_as_implicit_return) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663 /*
664 * Delete the return value if it will not be used by the
Bob Moore958dd242006-05-12 17:12:00 -0400665 * calling method or remove one reference if the explicit return
666 * is the same as the implicit return value.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667 */
Len Brown4be44fc2005-08-05 00:44:28 -0400668 acpi_ut_remove_reference(return_desc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669 }
670 }
671
Len Brown4be44fc2005-08-05 00:44:28 -0400672 return_ACPI_STATUS(AE_OK);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700673}
674
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675/*******************************************************************************
676 *
677 * FUNCTION: acpi_ds_terminate_control_method
678 *
Bob Mooreb229cf92006-04-21 17:15:00 -0400679 * PARAMETERS: method_desc - Method object
680 * walk_state - State associated with the method
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681 *
Robert Mooreaff8c272005-09-02 17:24:17 -0400682 * RETURN: None
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683 *
Bob Moore73a30902012-10-31 02:26:55 +0000684 * DESCRIPTION: Terminate a control method. Delete everything that the method
Linus Torvalds1da177e2005-04-16 15:20:36 -0700685 * created, delete all locals and arguments, and delete the parse
686 * tree if requested.
687 *
Bob Moore967440e32006-06-23 17:04:00 -0400688 * MUTEX: Interpreter is locked
689 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700690 ******************************************************************************/
691
Bob Mooreb229cf92006-04-21 17:15:00 -0400692void
693acpi_ds_terminate_control_method(union acpi_operand_object *method_desc,
694 struct acpi_walk_state *walk_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700696
Bob Mooreb229cf92006-04-21 17:15:00 -0400697 ACPI_FUNCTION_TRACE_PTR(ds_terminate_control_method, walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700698
Bob Mooreb229cf92006-04-21 17:15:00 -0400699 /* method_desc is required, walk_state is optional */
700
701 if (!method_desc) {
Robert Mooreaff8c272005-09-02 17:24:17 -0400702 return_VOID;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700703 }
704
Bob Mooreb229cf92006-04-21 17:15:00 -0400705 if (walk_state) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700706
Bob Mooreb229cf92006-04-21 17:15:00 -0400707 /* Delete all arguments and locals */
708
709 acpi_ds_method_data_delete_all(walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700710
Bob Mooreb7f9f042008-04-10 19:06:40 +0400711 /*
712 * If method is serialized, release the mutex and restore the
713 * current sync level for this thread
714 */
715 if (method_desc->method.mutex) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700716
Bob Mooreb7f9f042008-04-10 19:06:40 +0400717 /* Acquisition Depth handles recursive calls */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718
Bob Mooreb7f9f042008-04-10 19:06:40 +0400719 method_desc->method.mutex->mutex.acquisition_depth--;
720 if (!method_desc->method.mutex->mutex.acquisition_depth) {
721 walk_state->thread->current_sync_level =
722 method_desc->method.mutex->mutex.
723 original_sync_level;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724
Bob Mooreb7f9f042008-04-10 19:06:40 +0400725 acpi_os_release_mutex(method_desc->method.
726 mutex->mutex.os_mutex);
Lin Ming28eb3fc2010-09-15 13:55:13 +0800727 method_desc->method.mutex->mutex.thread_id = 0;
Bob Mooreb7f9f042008-04-10 19:06:40 +0400728 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730
Bob Mooreb229cf92006-04-21 17:15:00 -0400731 /*
Lin Ming7f0c8262009-08-13 14:03:15 +0800732 * Delete any namespace objects created anywhere within the
Lin Ming26294842011-01-12 09:19:43 +0800733 * namespace by the execution of this method. Unless:
734 * 1) This method is a module-level executable code method, in which
735 * case we want make the objects permanent.
736 * 2) There are other threads executing the method, in which case we
737 * will wait until the last thread has completed.
Bob Mooreb229cf92006-04-21 17:15:00 -0400738 */
Lin Ming26294842011-01-12 09:19:43 +0800739 if (!(method_desc->method.info_flags & ACPI_METHOD_MODULE_LEVEL)
740 && (method_desc->method.thread_count == 1)) {
Alexey Starikovskiya9fc0312010-05-26 13:59:51 +0800741
742 /* Delete any direct children of (created by) this method */
743
744 acpi_ns_delete_namespace_subtree(walk_state->
745 method_node);
746
747 /*
748 * Delete any objects that were created by this method
749 * elsewhere in the namespace (if any were created).
Lin Ming26294842011-01-12 09:19:43 +0800750 * Use of the ACPI_METHOD_MODIFIED_NAMESPACE optimizes the
751 * deletion such that we don't have to perform an entire
752 * namespace walk for every control method execution.
Alexey Starikovskiya9fc0312010-05-26 13:59:51 +0800753 */
754 if (method_desc->method.
Lin Ming26294842011-01-12 09:19:43 +0800755 info_flags & ACPI_METHOD_MODIFIED_NAMESPACE) {
Alexey Starikovskiya9fc0312010-05-26 13:59:51 +0800756 acpi_ns_delete_namespace_by_owner(method_desc->
757 method.
758 owner_id);
Lin Ming26294842011-01-12 09:19:43 +0800759 method_desc->method.info_flags &=
760 ~ACPI_METHOD_MODIFIED_NAMESPACE;
Alexey Starikovskiya9fc0312010-05-26 13:59:51 +0800761 }
Lin Ming7f0c8262009-08-13 14:03:15 +0800762 }
Bob Moore28f55eb2005-12-02 18:27:00 -0500763 }
764
Bob Mooreb229cf92006-04-21 17:15:00 -0400765 /* Decrement the thread count on the method */
Bob Moore28f55eb2005-12-02 18:27:00 -0500766
Bob Mooreb229cf92006-04-21 17:15:00 -0400767 if (method_desc->method.thread_count) {
768 method_desc->method.thread_count--;
769 } else {
770 ACPI_ERROR((AE_INFO, "Invalid zero thread count in method"));
771 }
Bob Moore28f55eb2005-12-02 18:27:00 -0500772
773 /* Are there any other threads currently executing this method? */
774
Bob Mooreb229cf92006-04-21 17:15:00 -0400775 if (method_desc->method.thread_count) {
Bob Moore28f55eb2005-12-02 18:27:00 -0500776 /*
777 * Additional threads. Do not release the owner_id in this case,
778 * we immediately reuse it for the next thread executing this method
779 */
Len Brown4be44fc2005-08-05 00:44:28 -0400780 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
Bob Mooreb27d6592010-05-26 11:47:13 +0800781 "*** Completed execution of one thread, %u threads remaining\n",
Bob Mooreb229cf92006-04-21 17:15:00 -0400782 method_desc->method.thread_count));
Bob Moore28f55eb2005-12-02 18:27:00 -0500783 } else {
784 /* This is the only executing thread for this method */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700785
Linus Torvalds1da177e2005-04-16 15:20:36 -0700786 /*
787 * Support to dynamically change a method from not_serialized to
Bob Moore28f55eb2005-12-02 18:27:00 -0500788 * Serialized if it appears that the method is incorrectly written and
Bob Moore967440e32006-06-23 17:04:00 -0400789 * does not support multiple thread execution. The best example of this
790 * is if such a method creates namespace objects and blocks. A second
Lin Ming26294842011-01-12 09:19:43 +0800791 * thread will fail with an AE_ALREADY_EXISTS exception.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700792 *
793 * This code is here because we must wait until the last thread exits
Lin Ming26294842011-01-12 09:19:43 +0800794 * before marking the method as serialized.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795 */
Lin Ming26294842011-01-12 09:19:43 +0800796 if (method_desc->method.
797 info_flags & ACPI_METHOD_SERIALIZED_PENDING) {
798 if (walk_state) {
799 ACPI_INFO((AE_INFO,
800 "Marking method %4.4s as Serialized because of AE_ALREADY_EXISTS error",
801 walk_state->method_node->name.
802 ascii));
803 }
804
805 /*
806 * Method tried to create an object twice and was marked as
807 * "pending serialized". The probable cause is that the method
808 * cannot handle reentrancy.
809 *
810 * The method was created as not_serialized, but it tried to create
811 * a named object and then blocked, causing the second thread
812 * entrance to begin and then fail. Workaround this problem by
813 * marking the method permanently as Serialized when the last
814 * thread exits here.
815 */
816 method_desc->method.info_flags &=
817 ~ACPI_METHOD_SERIALIZED_PENDING;
818 method_desc->method.info_flags |=
Bob Moored1825572014-03-24 14:49:13 +0800819 (ACPI_METHOD_SERIALIZED |
820 ACPI_METHOD_IGNORE_SYNC_LEVEL);
Lin Ming26294842011-01-12 09:19:43 +0800821 method_desc->method.sync_level = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822 }
823
Bob Moore28f55eb2005-12-02 18:27:00 -0500824 /* No more threads, we can free the owner_id */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825
Lin Ming26294842011-01-12 09:19:43 +0800826 if (!
827 (method_desc->method.
828 info_flags & ACPI_METHOD_MODULE_LEVEL)) {
Lin Ming7f0c8262009-08-13 14:03:15 +0800829 acpi_ut_release_owner_id(&method_desc->method.owner_id);
830 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831 }
Len Browna94f1882005-09-03 00:09:12 -0400832
Lv Zhengab6c5732015-07-23 12:52:59 +0800833 acpi_ex_stop_trace_method((struct acpi_namespace_node *)method_desc->
834 method.node, method_desc, walk_state);
Lv Zhenga616dc22015-07-23 12:52:53 +0800835
Robert Mooreaff8c272005-09-02 17:24:17 -0400836 return_VOID;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837}