blob: 6585e8e37c8e015adb791d4a1f9b1e67bdd84172 [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
Bob Moore1fad8732015-12-29 13:54:36 +0800121 status = acpi_ds_init_aml_walk(walk_state, op, node,
122 obj_desc->method.aml_start,
123 obj_desc->method.aml_length, NULL, 0);
Bob Moore22b5afc2014-03-24 14:49:00 +0800124 if (ACPI_FAILURE(status)) {
125 acpi_ds_delete_walk_state(walk_state);
Lv Zhengc8dec742015-05-21 10:31:06 +0800126 acpi_ps_free_op(op);
Bob Moore22b5afc2014-03-24 14:49:00 +0800127 return_ACPI_STATUS(status);
128 }
129
130 walk_state->descending_callback = acpi_ds_detect_named_opcodes;
131
132 /* Parse the method, scan for creation of named objects */
133
134 status = acpi_ps_parse_aml(walk_state);
Bob Moore22b5afc2014-03-24 14:49:00 +0800135
136 acpi_ps_delete_parse_tree(op);
137 return_ACPI_STATUS(status);
138}
139
140/*******************************************************************************
141 *
142 * FUNCTION: acpi_ds_detect_named_opcodes
143 *
144 * PARAMETERS: walk_state - Current state of the parse tree walk
145 * out_op - Unused, required for parser interface
146 *
147 * RETURN: Status
148 *
149 * DESCRIPTION: Descending callback used during the loading of ACPI tables.
150 * Currently used to detect methods that must be marked serialized
151 * in order to avoid problems with the creation of named objects.
152 *
153 ******************************************************************************/
154
155static acpi_status
156acpi_ds_detect_named_opcodes(struct acpi_walk_state *walk_state,
157 union acpi_parse_object **out_op)
158{
159
160 ACPI_FUNCTION_NAME(acpi_ds_detect_named_opcodes);
161
Lv Zheng21bd7e62014-03-24 14:49:07 +0800162 /* We are only interested in opcodes that create a new name */
Bob Moore22b5afc2014-03-24 14:49:00 +0800163
Lv Zheng21bd7e62014-03-24 14:49:07 +0800164 if (!
165 (walk_state->op_info->
166 flags & (AML_NAMED | AML_CREATE | AML_FIELD))) {
Bob Moore22b5afc2014-03-24 14:49:00 +0800167 return (AE_OK);
168 }
169
170 /*
171 * At this point, we know we have a Named object opcode.
172 * Mark the method as serialized. Later code will create a mutex for
173 * this method to enforce serialization.
Bob Moored1825572014-03-24 14:49:13 +0800174 *
175 * Note, ACPI_METHOD_IGNORE_SYNC_LEVEL flag means that we will ignore the
176 * Sync Level mechanism for this method, even though it is now serialized.
177 * Otherwise, there can be conflicts with existing ASL code that actually
178 * uses sync levels.
Bob Moore22b5afc2014-03-24 14:49:00 +0800179 */
Bob Moored1825572014-03-24 14:49:13 +0800180 walk_state->method_desc->method.sync_level = 0;
181 walk_state->method_desc->method.info_flags |=
182 (ACPI_METHOD_SERIALIZED | ACPI_METHOD_IGNORE_SYNC_LEVEL);
Bob Moore22b5afc2014-03-24 14:49:00 +0800183
184 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
185 "Method serialized [%4.4s] %p - [%s] (%4.4X)\n",
186 walk_state->method_node->name.ascii,
187 walk_state->method_node, walk_state->op_info->name,
188 walk_state->opcode));
189
190 /* Abort the parse, no need to examine this method any further */
191
192 return (AE_CTRL_TERMINATE);
193}
194
195/*******************************************************************************
196 *
Bob Mooredefba1d2005-12-16 17:05:00 -0500197 * FUNCTION: acpi_ds_method_error
198 *
Bob Mooreba494be2012-07-12 09:40:10 +0800199 * PARAMETERS: status - Execution status
Bob Mooredefba1d2005-12-16 17:05:00 -0500200 * walk_state - Current state
201 *
202 * RETURN: Status
203 *
204 * DESCRIPTION: Called on method error. Invoke the global exception handler if
Lv Zhengfdd8d832015-07-23 12:54:17 +0800205 * present, dump the method data if the debugger is configured
Bob Mooredefba1d2005-12-16 17:05:00 -0500206 *
207 * Note: Allows the exception handler to change the status code
208 *
209 ******************************************************************************/
Bob Moore967440e32006-06-23 17:04:00 -0400210
Bob Mooredefba1d2005-12-16 17:05:00 -0500211acpi_status
Bob Moore22b5afc2014-03-24 14:49:00 +0800212acpi_ds_method_error(acpi_status status, struct acpi_walk_state * walk_state)
Bob Mooredefba1d2005-12-16 17:05:00 -0500213{
Lv Zheng83482f72015-07-23 12:52:11 +0800214 u32 aml_offset;
215
Bob Mooredefba1d2005-12-16 17:05:00 -0500216 ACPI_FUNCTION_ENTRY();
217
218 /* Ignore AE_OK and control exception codes */
219
220 if (ACPI_SUCCESS(status) || (status & AE_CODE_CONTROL)) {
221 return (status);
222 }
223
224 /* Invoke the global exception handler */
225
226 if (acpi_gbl_exception_handler) {
Bob Moore52fc0b02006-10-02 00:00:00 -0400227
Bob Mooredefba1d2005-12-16 17:05:00 -0500228 /* Exit the interpreter, allow handler to execute methods */
229
230 acpi_ex_exit_interpreter();
231
232 /*
233 * Handler can map the exception code to anything it wants, including
234 * AE_OK, in which case the executing method will not be aborted.
235 */
Lv Zheng83482f72015-07-23 12:52:11 +0800236 aml_offset = (u32)ACPI_PTR_DIFF(walk_state->aml,
237 walk_state->parser_state.
238 aml_start);
239
Bob Mooredefba1d2005-12-16 17:05:00 -0500240 status = acpi_gbl_exception_handler(status,
241 walk_state->method_node ?
242 walk_state->method_node->
243 name.integer : 0,
244 walk_state->opcode,
Lv Zheng83482f72015-07-23 12:52:11 +0800245 aml_offset, NULL);
Bob Mooreb7f9f042008-04-10 19:06:40 +0400246 acpi_ex_enter_interpreter();
Bob Mooredefba1d2005-12-16 17:05:00 -0500247 }
Lin Mingd8a0ec92008-09-27 11:50:24 +0800248
249 acpi_ds_clear_implicit_return(walk_state);
250
Bob Mooredefba1d2005-12-16 17:05:00 -0500251 if (ACPI_FAILURE(status)) {
Lv Zheng0bac4292015-07-23 12:52:46 +0800252 acpi_ds_dump_method_stack(status, walk_state, walk_state->op);
Bob Moore52fc0b02006-10-02 00:00:00 -0400253
Lv Zhengfdd8d832015-07-23 12:54:17 +0800254 /* Display method locals/args if debugger is present */
Bob Mooredefba1d2005-12-16 17:05:00 -0500255
Lv Zhengfdd8d832015-07-23 12:54:17 +0800256#ifdef ACPI_DEBUGGER
257 acpi_db_dump_method_info(status, walk_state);
Bob Mooredefba1d2005-12-16 17:05:00 -0500258#endif
Lv Zheng0bac4292015-07-23 12:52:46 +0800259 }
Bob Mooredefba1d2005-12-16 17:05:00 -0500260
261 return (status);
262}
263
264/*******************************************************************************
265 *
Bob Moore967440e32006-06-23 17:04:00 -0400266 * FUNCTION: acpi_ds_create_method_mutex
267 *
268 * PARAMETERS: obj_desc - The method object
269 *
270 * RETURN: Status
271 *
272 * DESCRIPTION: Create a mutex object for a serialized control method
273 *
274 ******************************************************************************/
275
276static acpi_status
277acpi_ds_create_method_mutex(union acpi_operand_object *method_desc)
278{
279 union acpi_operand_object *mutex_desc;
280 acpi_status status;
281
Bob Mooref6dd9222006-07-07 20:44:38 -0400282 ACPI_FUNCTION_TRACE(ds_create_method_mutex);
Bob Moore967440e32006-06-23 17:04:00 -0400283
284 /* Create the new mutex object */
285
286 mutex_desc = acpi_ut_create_internal_object(ACPI_TYPE_MUTEX);
287 if (!mutex_desc) {
288 return_ACPI_STATUS(AE_NO_MEMORY);
289 }
290
291 /* Create the actual OS Mutex */
292
293 status = acpi_os_create_mutex(&mutex_desc->mutex.os_mutex);
294 if (ACPI_FAILURE(status)) {
Tim Gardner78d025e2012-12-31 00:06:56 +0000295 acpi_ut_delete_object_desc(mutex_desc);
Bob Moore967440e32006-06-23 17:04:00 -0400296 return_ACPI_STATUS(status);
297 }
298
299 mutex_desc->mutex.sync_level = method_desc->method.sync_level;
300 method_desc->method.mutex = mutex_desc;
301 return_ACPI_STATUS(AE_OK);
302}
303
304/*******************************************************************************
305 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306 * FUNCTION: acpi_ds_begin_method_execution
307 *
308 * PARAMETERS: method_node - Node of the method
309 * obj_desc - The method object
Bob Moore967440e32006-06-23 17:04:00 -0400310 * walk_state - current state, NULL if not yet executing
311 * a method.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312 *
313 * RETURN: Status
314 *
Bob Moore73a30902012-10-31 02:26:55 +0000315 * DESCRIPTION: Prepare a method for execution. Parses the method if necessary,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316 * increments the thread count, and waits at the method semaphore
317 * for clearance to execute.
318 *
319 ******************************************************************************/
Bob Mooredefba1d2005-12-16 17:05:00 -0500320
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321acpi_status
Bob Moore967440e32006-06-23 17:04:00 -0400322acpi_ds_begin_method_execution(struct acpi_namespace_node *method_node,
323 union acpi_operand_object *obj_desc,
324 struct acpi_walk_state *walk_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325{
Len Brown4be44fc2005-08-05 00:44:28 -0400326 acpi_status status = AE_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327
Bob Mooreb229cf92006-04-21 17:15:00 -0400328 ACPI_FUNCTION_TRACE_PTR(ds_begin_method_execution, method_node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329
330 if (!method_node) {
Len Brown4be44fc2005-08-05 00:44:28 -0400331 return_ACPI_STATUS(AE_NULL_ENTRY);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700332 }
333
Lv Zhengab6c5732015-07-23 12:52:59 +0800334 acpi_ex_start_trace_method(method_node, obj_desc, walk_state);
Lv Zhenga616dc22015-07-23 12:52:53 +0800335
Robert Mooreaff8c272005-09-02 17:24:17 -0400336 /* Prevent wraparound of thread count */
337
338 if (obj_desc->method.thread_count == ACPI_UINT8_MAX) {
Bob Mooreb8e4d892006-01-27 16:43:00 -0500339 ACPI_ERROR((AE_INFO,
340 "Method reached maximum reentrancy limit (255)"));
Robert Mooreaff8c272005-09-02 17:24:17 -0400341 return_ACPI_STATUS(AE_AML_METHOD_LIMIT);
342 }
343
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344 /*
Bob Moore967440e32006-06-23 17:04:00 -0400345 * If this method is serialized, we need to acquire the method mutex.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346 */
Lin Ming26294842011-01-12 09:19:43 +0800347 if (obj_desc->method.info_flags & ACPI_METHOD_SERIALIZED) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348 /*
Bob Moore967440e32006-06-23 17:04:00 -0400349 * Create a mutex for the method if it is defined to be Serialized
350 * and a mutex has not already been created. We defer the mutex creation
351 * until a method is actually executed, to minimize the object count
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352 */
Bob Moore967440e32006-06-23 17:04:00 -0400353 if (!obj_desc->method.mutex) {
354 status = acpi_ds_create_method_mutex(obj_desc);
355 if (ACPI_FAILURE(status)) {
356 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357 }
358 }
359
360 /*
Bob Moore967440e32006-06-23 17:04:00 -0400361 * The current_sync_level (per-thread) must be less than or equal to
362 * the sync level of the method. This mechanism provides some
Bob Moored1825572014-03-24 14:49:13 +0800363 * deadlock prevention.
364 *
365 * If the method was auto-serialized, we just ignore the sync level
366 * mechanism, because auto-serialization of methods can interfere
367 * with ASL code that actually uses sync levels.
Bob Moore967440e32006-06-23 17:04:00 -0400368 *
369 * Top-level method invocation has no walk state at this point
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370 */
Bob Moore967440e32006-06-23 17:04:00 -0400371 if (walk_state &&
Bob Moored1825572014-03-24 14:49:13 +0800372 (!(obj_desc->method.
373 info_flags & ACPI_METHOD_IGNORE_SYNC_LEVEL))
374 && (walk_state->thread->current_sync_level >
375 obj_desc->method.mutex->mutex.sync_level)) {
Bob Moore967440e32006-06-23 17:04:00 -0400376 ACPI_ERROR((AE_INFO,
Bob Moore1fad8732015-12-29 13:54:36 +0800377 "Cannot acquire Mutex for method [%4.4s]"
378 ", 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;
David E. Box33d3a2a2015-12-29 13:53:57 +0800414
415 /*
416 * Update the current sync_level only if this is not an auto-
417 * serialized method. In the auto case, we have to ignore
418 * the sync level for the method mutex (created for the
419 * auto-serialization) because we have no idea of what the
420 * sync level should be. Therefore, just ignore it.
421 */
422 if (!(obj_desc->method.info_flags &
423 ACPI_METHOD_IGNORE_SYNC_LEVEL)) {
424 walk_state->thread->current_sync_level =
425 obj_desc->method.sync_level;
426 }
Bob Moore967440e32006-06-23 17:04:00 -0400427 } else {
428 obj_desc->method.mutex->mutex.
429 original_sync_level =
430 obj_desc->method.mutex->mutex.sync_level;
431 }
432 }
433
434 /* Always increase acquisition depth */
435
436 obj_desc->method.mutex->mutex.acquisition_depth++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437 }
438
439 /*
Robert Mooreaff8c272005-09-02 17:24:17 -0400440 * Allocate an Owner ID for this method, only if this is the first thread
441 * to begin concurrent execution. We only need one owner_id, even if the
442 * method is invoked recursively.
443 */
444 if (!obj_desc->method.owner_id) {
445 status = acpi_ut_allocate_owner_id(&obj_desc->method.owner_id);
446 if (ACPI_FAILURE(status)) {
Bob Mooreb229cf92006-04-21 17:15:00 -0400447 goto cleanup;
Robert Mooreaff8c272005-09-02 17:24:17 -0400448 }
449 }
450
451 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452 * Increment the method parse tree thread count since it has been
453 * reentered one more time (even if it is the same thread)
454 */
455 obj_desc->method.thread_count++;
Lv Zheng9187a412013-10-31 09:30:28 +0800456 acpi_method_count++;
Len Brown4be44fc2005-08-05 00:44:28 -0400457 return_ACPI_STATUS(status);
Bob Mooreb229cf92006-04-21 17:15:00 -0400458
Lv Zheng10622bf2013-10-29 09:30:02 +0800459cleanup:
Bob Moore967440e32006-06-23 17:04:00 -0400460 /* On error, must release the method mutex (if present) */
Bob Mooreb229cf92006-04-21 17:15:00 -0400461
Bob Moore967440e32006-06-23 17:04:00 -0400462 if (obj_desc->method.mutex) {
463 acpi_os_release_mutex(obj_desc->method.mutex->mutex.os_mutex);
Bob Mooreb229cf92006-04-21 17:15:00 -0400464 }
465 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466}
467
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468/*******************************************************************************
469 *
470 * FUNCTION: acpi_ds_call_control_method
471 *
Bob Mooreba494be2012-07-12 09:40:10 +0800472 * PARAMETERS: thread - Info for this thread
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473 * this_walk_state - Current walk state
Bob Mooreba494be2012-07-12 09:40:10 +0800474 * op - Current Op to be walked
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475 *
476 * RETURN: Status
477 *
478 * DESCRIPTION: Transfer execution to a called control method
479 *
480 ******************************************************************************/
481
482acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400483acpi_ds_call_control_method(struct acpi_thread_state *thread,
484 struct acpi_walk_state *this_walk_state,
485 union acpi_parse_object *op)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486{
Len Brown4be44fc2005-08-05 00:44:28 -0400487 acpi_status status;
488 struct acpi_namespace_node *method_node;
489 struct acpi_walk_state *next_walk_state = NULL;
490 union acpi_operand_object *obj_desc;
Bob Moore41195322006-05-26 16:36:00 -0400491 struct acpi_evaluate_info *info;
Len Brown4be44fc2005-08-05 00:44:28 -0400492 u32 i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700493
Bob Mooreb229cf92006-04-21 17:15:00 -0400494 ACPI_FUNCTION_TRACE_PTR(ds_call_control_method, this_walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495
Len Brown4be44fc2005-08-05 00:44:28 -0400496 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
Valery Podrezov9bc75cf2007-02-02 19:48:21 +0300497 "Calling method %p, currentstate=%p\n",
Len Brown4be44fc2005-08-05 00:44:28 -0400498 this_walk_state->prev_op, this_walk_state));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499
500 /*
501 * Get the namespace entry for the control method we are about to call
502 */
503 method_node = this_walk_state->method_call_node;
504 if (!method_node) {
Len Brown4be44fc2005-08-05 00:44:28 -0400505 return_ACPI_STATUS(AE_NULL_ENTRY);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506 }
507
Len Brown4be44fc2005-08-05 00:44:28 -0400508 obj_desc = acpi_ns_get_attached_object(method_node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509 if (!obj_desc) {
Len Brown4be44fc2005-08-05 00:44:28 -0400510 return_ACPI_STATUS(AE_NULL_OBJECT);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511 }
512
Bob Moore967440e32006-06-23 17:04:00 -0400513 /* Init for new method, possibly wait on method mutex */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514
Bob Moore1fad8732015-12-29 13:54:36 +0800515 status =
516 acpi_ds_begin_method_execution(method_node, obj_desc,
517 this_walk_state);
Len Brown4be44fc2005-08-05 00:44:28 -0400518 if (ACPI_FAILURE(status)) {
Bob Mooreb229cf92006-04-21 17:15:00 -0400519 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520 }
521
Valery Podrezov9bc75cf2007-02-02 19:48:21 +0300522 /* Begin method parse/execution. Create a new walk state */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523
Bob Moore1fad8732015-12-29 13:54:36 +0800524 next_walk_state =
525 acpi_ds_create_walk_state(obj_desc->method.owner_id, NULL, obj_desc,
526 thread);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527 if (!next_walk_state) {
528 status = AE_NO_MEMORY;
529 goto cleanup;
530 }
Bob Mooreb229cf92006-04-21 17:15:00 -0400531
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532 /*
533 * The resolved arguments were put on the previous walk state's operand
Robert Mooreaff8c272005-09-02 17:24:17 -0400534 * stack. Operands on the previous walk state stack always
535 * start at index 0. Also, null terminate the list of arguments
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536 */
Len Brown4be44fc2005-08-05 00:44:28 -0400537 this_walk_state->operands[this_walk_state->num_operands] = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538
Bob Moore41195322006-05-26 16:36:00 -0400539 /*
540 * Allocate and initialize the evaluation information block
541 * TBD: this is somewhat inefficient, should change interface to
542 * ds_init_aml_walk. For now, keeps this struct off the CPU stack
543 */
544 info = ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_evaluate_info));
545 if (!info) {
Jesper Juhl22715822012-12-19 05:37:47 +0000546 status = AE_NO_MEMORY;
547 goto cleanup;
Bob Moore41195322006-05-26 16:36:00 -0400548 }
549
550 info->parameters = &this_walk_state->operands[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551
Len Brown4be44fc2005-08-05 00:44:28 -0400552 status = acpi_ds_init_aml_walk(next_walk_state, NULL, method_node,
553 obj_desc->method.aml_start,
Bob Mooreec3153f2007-02-02 19:48:21 +0300554 obj_desc->method.aml_length, info,
555 ACPI_IMODE_EXECUTE);
Bob Moore41195322006-05-26 16:36:00 -0400556
557 ACPI_FREE(info);
Len Brown4be44fc2005-08-05 00:44:28 -0400558 if (ACPI_FAILURE(status)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559 goto cleanup;
560 }
561
562 /*
563 * Delete the operands on the previous walkstate operand stack
564 * (they were copied to new objects)
565 */
566 for (i = 0; i < obj_desc->method.param_count; i++) {
Len Brown4be44fc2005-08-05 00:44:28 -0400567 acpi_ut_remove_reference(this_walk_state->operands[i]);
568 this_walk_state->operands[i] = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569 }
570
571 /* Clear the operand stack */
572
573 this_walk_state->num_operands = 0;
574
Len Brown4be44fc2005-08-05 00:44:28 -0400575 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
Valery Podrezov9bc75cf2007-02-02 19:48:21 +0300576 "**** Begin nested execution of [%4.4s] **** WalkState=%p\n",
577 method_node->name.ascii, next_walk_state));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578
Bob Mooreb229cf92006-04-21 17:15:00 -0400579 /* Invoke an internal method if necessary */
580
Lin Ming26294842011-01-12 09:19:43 +0800581 if (obj_desc->method.info_flags & ACPI_METHOD_INTERNAL_ONLY) {
582 status =
583 obj_desc->method.dispatch.implementation(next_walk_state);
Bob Moorea8fadc92008-11-13 09:45:35 +0800584 if (status == AE_OK) {
585 status = AE_CTRL_TERMINATE;
586 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587 }
588
Robert Mooreaff8c272005-09-02 17:24:17 -0400589 return_ACPI_STATUS(status);
590
Lv Zheng10622bf2013-10-29 09:30:02 +0800591cleanup:
Robert Mooreaff8c272005-09-02 17:24:17 -0400592
Bob Mooreb229cf92006-04-21 17:15:00 -0400593 /* On error, we must terminate the method properly */
594
595 acpi_ds_terminate_control_method(obj_desc, next_walk_state);
Markus Elfringdc67d0f2015-07-23 12:53:28 +0800596 acpi_ds_delete_walk_state(next_walk_state);
Len Browna94f1882005-09-03 00:09:12 -0400597
Len Brown4be44fc2005-08-05 00:44:28 -0400598 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599}
600
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601/*******************************************************************************
602 *
603 * FUNCTION: acpi_ds_restart_control_method
604 *
605 * PARAMETERS: walk_state - State for preempted method (caller)
606 * return_desc - Return value from the called method
607 *
608 * RETURN: Status
609 *
610 * DESCRIPTION: Restart a method that was preempted by another (nested) method
Bob Moore73a30902012-10-31 02:26:55 +0000611 * invocation. Handle the return value (if any) from the callee.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612 *
613 ******************************************************************************/
614
615acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400616acpi_ds_restart_control_method(struct acpi_walk_state *walk_state,
617 union acpi_operand_object *return_desc)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618{
Len Brown4be44fc2005-08-05 00:44:28 -0400619 acpi_status status;
Bob Moore958dd242006-05-12 17:12:00 -0400620 int same_as_implicit_return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621
Bob Mooreb229cf92006-04-21 17:15:00 -0400622 ACPI_FUNCTION_TRACE_PTR(ds_restart_control_method, walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700623
Len Brown4be44fc2005-08-05 00:44:28 -0400624 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
Bob Mooreb229cf92006-04-21 17:15:00 -0400625 "****Restart [%4.4s] Op %p ReturnValueFromCallee %p\n",
Bob Mooref6dd9222006-07-07 20:44:38 -0400626 acpi_ut_get_node_name(walk_state->method_node),
Len Brown4be44fc2005-08-05 00:44:28 -0400627 walk_state->method_call_op, return_desc));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628
Len Brown4be44fc2005-08-05 00:44:28 -0400629 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
Bob Mooreb229cf92006-04-21 17:15:00 -0400630 " ReturnFromThisMethodUsed?=%X ResStack %p Walk %p\n",
Len Brown4be44fc2005-08-05 00:44:28 -0400631 walk_state->return_used,
632 walk_state->results, walk_state));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633
634 /* Did the called method return a value? */
635
636 if (return_desc) {
Bob Moore52fc0b02006-10-02 00:00:00 -0400637
Bob Moore958dd242006-05-12 17:12:00 -0400638 /* Is the implicit return object the same as the return desc? */
639
640 same_as_implicit_return =
641 (walk_state->implicit_return_obj == return_desc);
642
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643 /* Are we actually going to use the return value? */
644
645 if (walk_state->return_used) {
Bob Moore52fc0b02006-10-02 00:00:00 -0400646
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647 /* Save the return value from the previous method */
648
Len Brown4be44fc2005-08-05 00:44:28 -0400649 status = acpi_ds_result_push(return_desc, walk_state);
650 if (ACPI_FAILURE(status)) {
651 acpi_ut_remove_reference(return_desc);
652 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653 }
654
655 /*
656 * Save as THIS method's return value in case it is returned
657 * immediately to yet another method
658 */
659 walk_state->return_desc = return_desc;
660 }
661
662 /*
Bob Moore958dd242006-05-12 17:12:00 -0400663 * The following code is the optional support for the so-called
664 * "implicit return". Some AML code assumes that the last value of the
665 * method is "implicitly" returned to the caller, in the absence of an
666 * explicit return value.
667 *
668 * Just save the last result of the method as the return value.
669 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700670 * NOTE: this is optional because the ASL language does not actually
671 * support this behavior.
672 */
Len Brown4be44fc2005-08-05 00:44:28 -0400673 else if (!acpi_ds_do_implicit_return
Bob Moore958dd242006-05-12 17:12:00 -0400674 (return_desc, walk_state, FALSE)
675 || same_as_implicit_return) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700676 /*
677 * Delete the return value if it will not be used by the
Bob Moore958dd242006-05-12 17:12:00 -0400678 * calling method or remove one reference if the explicit return
679 * is the same as the implicit return value.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680 */
Len Brown4be44fc2005-08-05 00:44:28 -0400681 acpi_ut_remove_reference(return_desc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682 }
683 }
684
Len Brown4be44fc2005-08-05 00:44:28 -0400685 return_ACPI_STATUS(AE_OK);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686}
687
Linus Torvalds1da177e2005-04-16 15:20:36 -0700688/*******************************************************************************
689 *
690 * FUNCTION: acpi_ds_terminate_control_method
691 *
Bob Mooreb229cf92006-04-21 17:15:00 -0400692 * PARAMETERS: method_desc - Method object
693 * walk_state - State associated with the method
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694 *
Robert Mooreaff8c272005-09-02 17:24:17 -0400695 * RETURN: None
Linus Torvalds1da177e2005-04-16 15:20:36 -0700696 *
Bob Moore73a30902012-10-31 02:26:55 +0000697 * DESCRIPTION: Terminate a control method. Delete everything that the method
Linus Torvalds1da177e2005-04-16 15:20:36 -0700698 * created, delete all locals and arguments, and delete the parse
699 * tree if requested.
700 *
Bob Moore967440e32006-06-23 17:04:00 -0400701 * MUTEX: Interpreter is locked
702 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700703 ******************************************************************************/
704
Bob Mooreb229cf92006-04-21 17:15:00 -0400705void
706acpi_ds_terminate_control_method(union acpi_operand_object *method_desc,
707 struct acpi_walk_state *walk_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709
Bob Mooreb229cf92006-04-21 17:15:00 -0400710 ACPI_FUNCTION_TRACE_PTR(ds_terminate_control_method, walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700711
Bob Mooreb229cf92006-04-21 17:15:00 -0400712 /* method_desc is required, walk_state is optional */
713
714 if (!method_desc) {
Robert Mooreaff8c272005-09-02 17:24:17 -0400715 return_VOID;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700716 }
717
Bob Mooreb229cf92006-04-21 17:15:00 -0400718 if (walk_state) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700719
Bob Mooreb229cf92006-04-21 17:15:00 -0400720 /* Delete all arguments and locals */
721
722 acpi_ds_method_data_delete_all(walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723
Bob Mooreb7f9f042008-04-10 19:06:40 +0400724 /*
725 * If method is serialized, release the mutex and restore the
726 * current sync level for this thread
727 */
728 if (method_desc->method.mutex) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729
Bob Mooreb7f9f042008-04-10 19:06:40 +0400730 /* Acquisition Depth handles recursive calls */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731
Bob Mooreb7f9f042008-04-10 19:06:40 +0400732 method_desc->method.mutex->mutex.acquisition_depth--;
733 if (!method_desc->method.mutex->mutex.acquisition_depth) {
734 walk_state->thread->current_sync_level =
735 method_desc->method.mutex->mutex.
736 original_sync_level;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737
Bob Mooreb7f9f042008-04-10 19:06:40 +0400738 acpi_os_release_mutex(method_desc->method.
739 mutex->mutex.os_mutex);
Lin Ming28eb3fc2010-09-15 13:55:13 +0800740 method_desc->method.mutex->mutex.thread_id = 0;
Bob Mooreb7f9f042008-04-10 19:06:40 +0400741 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700742 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743
Bob Mooreb229cf92006-04-21 17:15:00 -0400744 /*
Lin Ming7f0c8262009-08-13 14:03:15 +0800745 * Delete any namespace objects created anywhere within the
Lin Ming26294842011-01-12 09:19:43 +0800746 * namespace by the execution of this method. Unless:
747 * 1) This method is a module-level executable code method, in which
748 * case we want make the objects permanent.
749 * 2) There are other threads executing the method, in which case we
750 * will wait until the last thread has completed.
Bob Mooreb229cf92006-04-21 17:15:00 -0400751 */
Lin Ming26294842011-01-12 09:19:43 +0800752 if (!(method_desc->method.info_flags & ACPI_METHOD_MODULE_LEVEL)
753 && (method_desc->method.thread_count == 1)) {
Alexey Starikovskiya9fc0312010-05-26 13:59:51 +0800754
755 /* Delete any direct children of (created by) this method */
756
757 acpi_ns_delete_namespace_subtree(walk_state->
758 method_node);
759
760 /*
761 * Delete any objects that were created by this method
762 * elsewhere in the namespace (if any were created).
Lin Ming26294842011-01-12 09:19:43 +0800763 * Use of the ACPI_METHOD_MODIFIED_NAMESPACE optimizes the
764 * deletion such that we don't have to perform an entire
765 * namespace walk for every control method execution.
Alexey Starikovskiya9fc0312010-05-26 13:59:51 +0800766 */
767 if (method_desc->method.
Lin Ming26294842011-01-12 09:19:43 +0800768 info_flags & ACPI_METHOD_MODIFIED_NAMESPACE) {
Alexey Starikovskiya9fc0312010-05-26 13:59:51 +0800769 acpi_ns_delete_namespace_by_owner(method_desc->
770 method.
771 owner_id);
Lin Ming26294842011-01-12 09:19:43 +0800772 method_desc->method.info_flags &=
773 ~ACPI_METHOD_MODIFIED_NAMESPACE;
Alexey Starikovskiya9fc0312010-05-26 13:59:51 +0800774 }
Lin Ming7f0c8262009-08-13 14:03:15 +0800775 }
Bob Moore28f55eb2005-12-02 18:27:00 -0500776 }
777
Bob Mooreb229cf92006-04-21 17:15:00 -0400778 /* Decrement the thread count on the method */
Bob Moore28f55eb2005-12-02 18:27:00 -0500779
Bob Mooreb229cf92006-04-21 17:15:00 -0400780 if (method_desc->method.thread_count) {
781 method_desc->method.thread_count--;
782 } else {
783 ACPI_ERROR((AE_INFO, "Invalid zero thread count in method"));
784 }
Bob Moore28f55eb2005-12-02 18:27:00 -0500785
786 /* Are there any other threads currently executing this method? */
787
Bob Mooreb229cf92006-04-21 17:15:00 -0400788 if (method_desc->method.thread_count) {
Bob Moore28f55eb2005-12-02 18:27:00 -0500789 /*
790 * Additional threads. Do not release the owner_id in this case,
791 * we immediately reuse it for the next thread executing this method
792 */
Len Brown4be44fc2005-08-05 00:44:28 -0400793 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
Bob Mooreb27d6592010-05-26 11:47:13 +0800794 "*** Completed execution of one thread, %u threads remaining\n",
Bob Mooreb229cf92006-04-21 17:15:00 -0400795 method_desc->method.thread_count));
Bob Moore28f55eb2005-12-02 18:27:00 -0500796 } else {
797 /* This is the only executing thread for this method */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799 /*
800 * Support to dynamically change a method from not_serialized to
Bob Moore28f55eb2005-12-02 18:27:00 -0500801 * Serialized if it appears that the method is incorrectly written and
Bob Moore967440e32006-06-23 17:04:00 -0400802 * does not support multiple thread execution. The best example of this
803 * is if such a method creates namespace objects and blocks. A second
Lin Ming26294842011-01-12 09:19:43 +0800804 * thread will fail with an AE_ALREADY_EXISTS exception.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805 *
806 * This code is here because we must wait until the last thread exits
Lin Ming26294842011-01-12 09:19:43 +0800807 * before marking the method as serialized.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808 */
Lin Ming26294842011-01-12 09:19:43 +0800809 if (method_desc->method.
810 info_flags & ACPI_METHOD_SERIALIZED_PENDING) {
811 if (walk_state) {
812 ACPI_INFO((AE_INFO,
Bob Moore1fad8732015-12-29 13:54:36 +0800813 "Marking method %4.4s as Serialized "
814 "because of AE_ALREADY_EXISTS error",
Lin Ming26294842011-01-12 09:19:43 +0800815 walk_state->method_node->name.
816 ascii));
817 }
818
819 /*
820 * Method tried to create an object twice and was marked as
821 * "pending serialized". The probable cause is that the method
822 * cannot handle reentrancy.
823 *
824 * The method was created as not_serialized, but it tried to create
825 * a named object and then blocked, causing the second thread
826 * entrance to begin and then fail. Workaround this problem by
827 * marking the method permanently as Serialized when the last
828 * thread exits here.
829 */
830 method_desc->method.info_flags &=
831 ~ACPI_METHOD_SERIALIZED_PENDING;
Bob Moore1fad8732015-12-29 13:54:36 +0800832
Lin Ming26294842011-01-12 09:19:43 +0800833 method_desc->method.info_flags |=
Bob Moored1825572014-03-24 14:49:13 +0800834 (ACPI_METHOD_SERIALIZED |
835 ACPI_METHOD_IGNORE_SYNC_LEVEL);
Lin Ming26294842011-01-12 09:19:43 +0800836 method_desc->method.sync_level = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837 }
838
Bob Moore28f55eb2005-12-02 18:27:00 -0500839 /* No more threads, we can free the owner_id */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700840
Lin Ming26294842011-01-12 09:19:43 +0800841 if (!
842 (method_desc->method.
843 info_flags & ACPI_METHOD_MODULE_LEVEL)) {
Lin Ming7f0c8262009-08-13 14:03:15 +0800844 acpi_ut_release_owner_id(&method_desc->method.owner_id);
845 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700846 }
Len Browna94f1882005-09-03 00:09:12 -0400847
Lv Zhengab6c5732015-07-23 12:52:59 +0800848 acpi_ex_stop_trace_method((struct acpi_namespace_node *)method_desc->
849 method.node, method_desc, walk_state);
Lv Zhenga616dc22015-07-23 12:52:53 +0800850
Robert Mooreaff8c272005-09-02 17:24:17 -0400851 return_VOID;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700852}