blob: ea2bdde1227ef65ab473fd816c8f39d559d7f135 [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"
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
Lv Zheng62eb9352015-07-23 12:52:24 +0800106 op = acpi_ps_alloc_op(AML_METHOD_OP, obj_desc->method.aml_start);
Bob Moore22b5afc2014-03-24 14:49:00 +0800107 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) {
Lv Zhengc8dec742015-05-21 10:31:06 +0800119 acpi_ps_free_op(op);
Bob Moore22b5afc2014-03-24 14:49:00 +0800120 return_ACPI_STATUS(AE_NO_MEMORY);
121 }
122
123 status =
124 acpi_ds_init_aml_walk(walk_state, op, node,
125 obj_desc->method.aml_start,
126 obj_desc->method.aml_length, NULL, 0);
127 if (ACPI_FAILURE(status)) {
128 acpi_ds_delete_walk_state(walk_state);
Lv Zhengc8dec742015-05-21 10:31:06 +0800129 acpi_ps_free_op(op);
Bob Moore22b5afc2014-03-24 14:49:00 +0800130 return_ACPI_STATUS(status);
131 }
132
133 walk_state->descending_callback = acpi_ds_detect_named_opcodes;
134
135 /* Parse the method, scan for creation of named objects */
136
137 status = acpi_ps_parse_aml(walk_state);
Bob Moore22b5afc2014-03-24 14:49:00 +0800138
139 acpi_ps_delete_parse_tree(op);
140 return_ACPI_STATUS(status);
141}
142
143/*******************************************************************************
144 *
145 * FUNCTION: acpi_ds_detect_named_opcodes
146 *
147 * PARAMETERS: walk_state - Current state of the parse tree walk
148 * out_op - Unused, required for parser interface
149 *
150 * RETURN: Status
151 *
152 * DESCRIPTION: Descending callback used during the loading of ACPI tables.
153 * Currently used to detect methods that must be marked serialized
154 * in order to avoid problems with the creation of named objects.
155 *
156 ******************************************************************************/
157
158static acpi_status
159acpi_ds_detect_named_opcodes(struct acpi_walk_state *walk_state,
160 union acpi_parse_object **out_op)
161{
162
163 ACPI_FUNCTION_NAME(acpi_ds_detect_named_opcodes);
164
Lv Zheng21bd7e62014-03-24 14:49:07 +0800165 /* We are only interested in opcodes that create a new name */
Bob Moore22b5afc2014-03-24 14:49:00 +0800166
Lv Zheng21bd7e62014-03-24 14:49:07 +0800167 if (!
168 (walk_state->op_info->
169 flags & (AML_NAMED | AML_CREATE | AML_FIELD))) {
Bob Moore22b5afc2014-03-24 14:49:00 +0800170 return (AE_OK);
171 }
172
173 /*
174 * At this point, we know we have a Named object opcode.
175 * Mark the method as serialized. Later code will create a mutex for
176 * this method to enforce serialization.
Bob Moored1825572014-03-24 14:49:13 +0800177 *
178 * Note, ACPI_METHOD_IGNORE_SYNC_LEVEL flag means that we will ignore the
179 * Sync Level mechanism for this method, even though it is now serialized.
180 * Otherwise, there can be conflicts with existing ASL code that actually
181 * uses sync levels.
Bob Moore22b5afc2014-03-24 14:49:00 +0800182 */
Bob Moored1825572014-03-24 14:49:13 +0800183 walk_state->method_desc->method.sync_level = 0;
184 walk_state->method_desc->method.info_flags |=
185 (ACPI_METHOD_SERIALIZED | ACPI_METHOD_IGNORE_SYNC_LEVEL);
Bob Moore22b5afc2014-03-24 14:49:00 +0800186
187 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
188 "Method serialized [%4.4s] %p - [%s] (%4.4X)\n",
189 walk_state->method_node->name.ascii,
190 walk_state->method_node, walk_state->op_info->name,
191 walk_state->opcode));
192
193 /* Abort the parse, no need to examine this method any further */
194
195 return (AE_CTRL_TERMINATE);
196}
197
198/*******************************************************************************
199 *
Bob Mooredefba1d2005-12-16 17:05:00 -0500200 * FUNCTION: acpi_ds_method_error
201 *
Bob Mooreba494be2012-07-12 09:40:10 +0800202 * PARAMETERS: status - Execution status
Bob Mooredefba1d2005-12-16 17:05:00 -0500203 * walk_state - Current state
204 *
205 * RETURN: Status
206 *
207 * DESCRIPTION: Called on method error. Invoke the global exception handler if
208 * present, dump the method data if the disassembler is configured
209 *
210 * Note: Allows the exception handler to change the status code
211 *
212 ******************************************************************************/
Bob Moore967440e32006-06-23 17:04:00 -0400213
Bob Mooredefba1d2005-12-16 17:05:00 -0500214acpi_status
Bob Moore22b5afc2014-03-24 14:49:00 +0800215acpi_ds_method_error(acpi_status status, struct acpi_walk_state * walk_state)
Bob Mooredefba1d2005-12-16 17:05:00 -0500216{
Lv Zheng83482f72015-07-23 12:52:11 +0800217 u32 aml_offset;
218
Bob Mooredefba1d2005-12-16 17:05:00 -0500219 ACPI_FUNCTION_ENTRY();
220
221 /* Ignore AE_OK and control exception codes */
222
223 if (ACPI_SUCCESS(status) || (status & AE_CODE_CONTROL)) {
224 return (status);
225 }
226
227 /* Invoke the global exception handler */
228
229 if (acpi_gbl_exception_handler) {
Bob Moore52fc0b02006-10-02 00:00:00 -0400230
Bob Mooredefba1d2005-12-16 17:05:00 -0500231 /* Exit the interpreter, allow handler to execute methods */
232
233 acpi_ex_exit_interpreter();
234
235 /*
236 * Handler can map the exception code to anything it wants, including
237 * AE_OK, in which case the executing method will not be aborted.
238 */
Lv Zheng83482f72015-07-23 12:52:11 +0800239 aml_offset = (u32)ACPI_PTR_DIFF(walk_state->aml,
240 walk_state->parser_state.
241 aml_start);
242
Bob Mooredefba1d2005-12-16 17:05:00 -0500243 status = acpi_gbl_exception_handler(status,
244 walk_state->method_node ?
245 walk_state->method_node->
246 name.integer : 0,
247 walk_state->opcode,
Lv Zheng83482f72015-07-23 12:52:11 +0800248 aml_offset, NULL);
Bob Mooreb7f9f042008-04-10 19:06:40 +0400249 acpi_ex_enter_interpreter();
Bob Mooredefba1d2005-12-16 17:05:00 -0500250 }
Lin Mingd8a0ec92008-09-27 11:50:24 +0800251
252 acpi_ds_clear_implicit_return(walk_state);
253
Bob Mooredefba1d2005-12-16 17:05:00 -0500254 if (ACPI_FAILURE(status)) {
Lv Zheng0bac4292015-07-23 12:52:46 +0800255 acpi_ds_dump_method_stack(status, walk_state, walk_state->op);
Bob Moore52fc0b02006-10-02 00:00:00 -0400256
Bob Mooredefba1d2005-12-16 17:05:00 -0500257 /* Display method locals/args if disassembler is present */
258
Lv Zheng0bac4292015-07-23 12:52:46 +0800259#ifdef ACPI_DISASSEMBLER
260 acpi_dm_dump_method_info(status, walk_state);
Bob Mooredefba1d2005-12-16 17:05:00 -0500261#endif
Lv Zheng0bac4292015-07-23 12:52:46 +0800262 }
Bob Mooredefba1d2005-12-16 17:05:00 -0500263
264 return (status);
265}
266
267/*******************************************************************************
268 *
Bob Moore967440e32006-06-23 17:04:00 -0400269 * FUNCTION: acpi_ds_create_method_mutex
270 *
271 * PARAMETERS: obj_desc - The method object
272 *
273 * RETURN: Status
274 *
275 * DESCRIPTION: Create a mutex object for a serialized control method
276 *
277 ******************************************************************************/
278
279static acpi_status
280acpi_ds_create_method_mutex(union acpi_operand_object *method_desc)
281{
282 union acpi_operand_object *mutex_desc;
283 acpi_status status;
284
Bob Mooref6dd9222006-07-07 20:44:38 -0400285 ACPI_FUNCTION_TRACE(ds_create_method_mutex);
Bob Moore967440e32006-06-23 17:04:00 -0400286
287 /* Create the new mutex object */
288
289 mutex_desc = acpi_ut_create_internal_object(ACPI_TYPE_MUTEX);
290 if (!mutex_desc) {
291 return_ACPI_STATUS(AE_NO_MEMORY);
292 }
293
294 /* Create the actual OS Mutex */
295
296 status = acpi_os_create_mutex(&mutex_desc->mutex.os_mutex);
297 if (ACPI_FAILURE(status)) {
Tim Gardner78d025e2012-12-31 00:06:56 +0000298 acpi_ut_delete_object_desc(mutex_desc);
Bob Moore967440e32006-06-23 17:04:00 -0400299 return_ACPI_STATUS(status);
300 }
301
302 mutex_desc->mutex.sync_level = method_desc->method.sync_level;
303 method_desc->method.mutex = mutex_desc;
304 return_ACPI_STATUS(AE_OK);
305}
306
307/*******************************************************************************
308 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309 * FUNCTION: acpi_ds_begin_method_execution
310 *
311 * PARAMETERS: method_node - Node of the method
312 * obj_desc - The method object
Bob Moore967440e32006-06-23 17:04:00 -0400313 * walk_state - current state, NULL if not yet executing
314 * a method.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315 *
316 * RETURN: Status
317 *
Bob Moore73a30902012-10-31 02:26:55 +0000318 * DESCRIPTION: Prepare a method for execution. Parses the method if necessary,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319 * increments the thread count, and waits at the method semaphore
320 * for clearance to execute.
321 *
322 ******************************************************************************/
Bob Mooredefba1d2005-12-16 17:05:00 -0500323
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324acpi_status
Bob Moore967440e32006-06-23 17:04:00 -0400325acpi_ds_begin_method_execution(struct acpi_namespace_node *method_node,
326 union acpi_operand_object *obj_desc,
327 struct acpi_walk_state *walk_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328{
Len Brown4be44fc2005-08-05 00:44:28 -0400329 acpi_status status = AE_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330
Bob Mooreb229cf92006-04-21 17:15:00 -0400331 ACPI_FUNCTION_TRACE_PTR(ds_begin_method_execution, method_node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700332
333 if (!method_node) {
Len Brown4be44fc2005-08-05 00:44:28 -0400334 return_ACPI_STATUS(AE_NULL_ENTRY);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335 }
336
Lv Zhengab6c5732015-07-23 12:52:59 +0800337 acpi_ex_start_trace_method(method_node, obj_desc, walk_state);
Lv Zhenga616dc22015-07-23 12:52:53 +0800338
Robert Mooreaff8c272005-09-02 17:24:17 -0400339 /* Prevent wraparound of thread count */
340
341 if (obj_desc->method.thread_count == ACPI_UINT8_MAX) {
Bob Mooreb8e4d892006-01-27 16:43:00 -0500342 ACPI_ERROR((AE_INFO,
343 "Method reached maximum reentrancy limit (255)"));
Robert Mooreaff8c272005-09-02 17:24:17 -0400344 return_ACPI_STATUS(AE_AML_METHOD_LIMIT);
345 }
346
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347 /*
Bob Moore967440e32006-06-23 17:04:00 -0400348 * If this method is serialized, we need to acquire the method mutex.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349 */
Lin Ming26294842011-01-12 09:19:43 +0800350 if (obj_desc->method.info_flags & ACPI_METHOD_SERIALIZED) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351 /*
Bob Moore967440e32006-06-23 17:04:00 -0400352 * Create a mutex for the method if it is defined to be Serialized
353 * and a mutex has not already been created. We defer the mutex creation
354 * until a method is actually executed, to minimize the object count
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355 */
Bob Moore967440e32006-06-23 17:04:00 -0400356 if (!obj_desc->method.mutex) {
357 status = acpi_ds_create_method_mutex(obj_desc);
358 if (ACPI_FAILURE(status)) {
359 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360 }
361 }
362
363 /*
Bob Moore967440e32006-06-23 17:04:00 -0400364 * The current_sync_level (per-thread) must be less than or equal to
365 * the sync level of the method. This mechanism provides some
Bob Moored1825572014-03-24 14:49:13 +0800366 * deadlock prevention.
367 *
368 * If the method was auto-serialized, we just ignore the sync level
369 * mechanism, because auto-serialization of methods can interfere
370 * with ASL code that actually uses sync levels.
Bob Moore967440e32006-06-23 17:04:00 -0400371 *
372 * Top-level method invocation has no walk state at this point
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373 */
Bob Moore967440e32006-06-23 17:04:00 -0400374 if (walk_state &&
Bob Moored1825572014-03-24 14:49:13 +0800375 (!(obj_desc->method.
376 info_flags & ACPI_METHOD_IGNORE_SYNC_LEVEL))
377 && (walk_state->thread->current_sync_level >
378 obj_desc->method.mutex->mutex.sync_level)) {
Bob Moore967440e32006-06-23 17:04:00 -0400379 ACPI_ERROR((AE_INFO,
Bob Mooref6a22b02010-03-05 17:56:40 +0800380 "Cannot acquire Mutex for method [%4.4s], current SyncLevel is too large (%u)",
Bob Moore967440e32006-06-23 17:04:00 -0400381 acpi_ut_get_node_name(method_node),
382 walk_state->thread->current_sync_level));
383
384 return_ACPI_STATUS(AE_AML_MUTEX_ORDER);
Bob Mooreb229cf92006-04-21 17:15:00 -0400385 }
Bob Moore967440e32006-06-23 17:04:00 -0400386
387 /*
388 * Obtain the method mutex if necessary. Do not acquire mutex for a
389 * recursive call.
390 */
Len Brown262a7a22007-05-09 23:01:59 -0400391 if (!walk_state ||
Bob Mooreba886cd2008-04-10 19:06:37 +0400392 !obj_desc->method.mutex->mutex.thread_id ||
393 (walk_state->thread->thread_id !=
394 obj_desc->method.mutex->mutex.thread_id)) {
Bob Moore967440e32006-06-23 17:04:00 -0400395 /*
396 * Acquire the method mutex. This releases the interpreter if we
397 * block (and reacquires it before it returns)
398 */
399 status =
400 acpi_ex_system_wait_mutex(obj_desc->method.mutex->
401 mutex.os_mutex,
402 ACPI_WAIT_FOREVER);
403 if (ACPI_FAILURE(status)) {
404 return_ACPI_STATUS(status);
405 }
406
407 /* Update the mutex and walk info and save the original sync_level */
408
409 if (walk_state) {
410 obj_desc->method.mutex->mutex.
411 original_sync_level =
412 walk_state->thread->current_sync_level;
413
Bob Mooreba886cd2008-04-10 19:06:37 +0400414 obj_desc->method.mutex->mutex.thread_id =
415 walk_state->thread->thread_id;
Bob Moore967440e32006-06-23 17:04:00 -0400416 walk_state->thread->current_sync_level =
417 obj_desc->method.sync_level;
418 } else {
419 obj_desc->method.mutex->mutex.
420 original_sync_level =
421 obj_desc->method.mutex->mutex.sync_level;
422 }
423 }
424
425 /* Always increase acquisition depth */
426
427 obj_desc->method.mutex->mutex.acquisition_depth++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428 }
429
430 /*
Robert Mooreaff8c272005-09-02 17:24:17 -0400431 * Allocate an Owner ID for this method, only if this is the first thread
432 * to begin concurrent execution. We only need one owner_id, even if the
433 * method is invoked recursively.
434 */
435 if (!obj_desc->method.owner_id) {
436 status = acpi_ut_allocate_owner_id(&obj_desc->method.owner_id);
437 if (ACPI_FAILURE(status)) {
Bob Mooreb229cf92006-04-21 17:15:00 -0400438 goto cleanup;
Robert Mooreaff8c272005-09-02 17:24:17 -0400439 }
440 }
441
442 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443 * Increment the method parse tree thread count since it has been
444 * reentered one more time (even if it is the same thread)
445 */
446 obj_desc->method.thread_count++;
Lv Zheng9187a412013-10-31 09:30:28 +0800447 acpi_method_count++;
Len Brown4be44fc2005-08-05 00:44:28 -0400448 return_ACPI_STATUS(status);
Bob Mooreb229cf92006-04-21 17:15:00 -0400449
Lv Zheng10622bf2013-10-29 09:30:02 +0800450cleanup:
Bob Moore967440e32006-06-23 17:04:00 -0400451 /* On error, must release the method mutex (if present) */
Bob Mooreb229cf92006-04-21 17:15:00 -0400452
Bob Moore967440e32006-06-23 17:04:00 -0400453 if (obj_desc->method.mutex) {
454 acpi_os_release_mutex(obj_desc->method.mutex->mutex.os_mutex);
Bob Mooreb229cf92006-04-21 17:15:00 -0400455 }
456 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457}
458
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459/*******************************************************************************
460 *
461 * FUNCTION: acpi_ds_call_control_method
462 *
Bob Mooreba494be2012-07-12 09:40:10 +0800463 * PARAMETERS: thread - Info for this thread
Linus Torvalds1da177e2005-04-16 15:20:36 -0700464 * this_walk_state - Current walk state
Bob Mooreba494be2012-07-12 09:40:10 +0800465 * op - Current Op to be walked
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466 *
467 * RETURN: Status
468 *
469 * DESCRIPTION: Transfer execution to a called control method
470 *
471 ******************************************************************************/
472
473acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400474acpi_ds_call_control_method(struct acpi_thread_state *thread,
475 struct acpi_walk_state *this_walk_state,
476 union acpi_parse_object *op)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477{
Len Brown4be44fc2005-08-05 00:44:28 -0400478 acpi_status status;
479 struct acpi_namespace_node *method_node;
480 struct acpi_walk_state *next_walk_state = NULL;
481 union acpi_operand_object *obj_desc;
Bob Moore41195322006-05-26 16:36:00 -0400482 struct acpi_evaluate_info *info;
Len Brown4be44fc2005-08-05 00:44:28 -0400483 u32 i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484
Bob Mooreb229cf92006-04-21 17:15:00 -0400485 ACPI_FUNCTION_TRACE_PTR(ds_call_control_method, this_walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486
Len Brown4be44fc2005-08-05 00:44:28 -0400487 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
Valery Podrezov9bc75cf2007-02-02 19:48:21 +0300488 "Calling method %p, currentstate=%p\n",
Len Brown4be44fc2005-08-05 00:44:28 -0400489 this_walk_state->prev_op, this_walk_state));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490
491 /*
492 * Get the namespace entry for the control method we are about to call
493 */
494 method_node = this_walk_state->method_call_node;
495 if (!method_node) {
Len Brown4be44fc2005-08-05 00:44:28 -0400496 return_ACPI_STATUS(AE_NULL_ENTRY);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497 }
498
Len Brown4be44fc2005-08-05 00:44:28 -0400499 obj_desc = acpi_ns_get_attached_object(method_node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500 if (!obj_desc) {
Len Brown4be44fc2005-08-05 00:44:28 -0400501 return_ACPI_STATUS(AE_NULL_OBJECT);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502 }
503
Bob Moore967440e32006-06-23 17:04:00 -0400504 /* Init for new method, possibly wait on method mutex */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505
Len Brown4be44fc2005-08-05 00:44:28 -0400506 status = acpi_ds_begin_method_execution(method_node, obj_desc,
Bob Moore967440e32006-06-23 17:04:00 -0400507 this_walk_state);
Len Brown4be44fc2005-08-05 00:44:28 -0400508 if (ACPI_FAILURE(status)) {
Bob Mooreb229cf92006-04-21 17:15:00 -0400509 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510 }
511
Valery Podrezov9bc75cf2007-02-02 19:48:21 +0300512 /* Begin method parse/execution. Create a new walk state */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513
Len Brown4be44fc2005-08-05 00:44:28 -0400514 next_walk_state = acpi_ds_create_walk_state(obj_desc->method.owner_id,
515 NULL, obj_desc, thread);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516 if (!next_walk_state) {
517 status = AE_NO_MEMORY;
518 goto cleanup;
519 }
Bob Mooreb229cf92006-04-21 17:15:00 -0400520
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521 /*
522 * The resolved arguments were put on the previous walk state's operand
Robert Mooreaff8c272005-09-02 17:24:17 -0400523 * stack. Operands on the previous walk state stack always
524 * start at index 0. Also, null terminate the list of arguments
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525 */
Len Brown4be44fc2005-08-05 00:44:28 -0400526 this_walk_state->operands[this_walk_state->num_operands] = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527
Bob Moore41195322006-05-26 16:36:00 -0400528 /*
529 * Allocate and initialize the evaluation information block
530 * TBD: this is somewhat inefficient, should change interface to
531 * ds_init_aml_walk. For now, keeps this struct off the CPU stack
532 */
533 info = ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_evaluate_info));
534 if (!info) {
Jesper Juhl22715822012-12-19 05:37:47 +0000535 status = AE_NO_MEMORY;
536 goto cleanup;
Bob Moore41195322006-05-26 16:36:00 -0400537 }
538
539 info->parameters = &this_walk_state->operands[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700540
Len Brown4be44fc2005-08-05 00:44:28 -0400541 status = acpi_ds_init_aml_walk(next_walk_state, NULL, method_node,
542 obj_desc->method.aml_start,
Bob Mooreec3153f2007-02-02 19:48:21 +0300543 obj_desc->method.aml_length, info,
544 ACPI_IMODE_EXECUTE);
Bob Moore41195322006-05-26 16:36:00 -0400545
546 ACPI_FREE(info);
Len Brown4be44fc2005-08-05 00:44:28 -0400547 if (ACPI_FAILURE(status)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548 goto cleanup;
549 }
550
551 /*
552 * Delete the operands on the previous walkstate operand stack
553 * (they were copied to new objects)
554 */
555 for (i = 0; i < obj_desc->method.param_count; i++) {
Len Brown4be44fc2005-08-05 00:44:28 -0400556 acpi_ut_remove_reference(this_walk_state->operands[i]);
557 this_walk_state->operands[i] = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558 }
559
560 /* Clear the operand stack */
561
562 this_walk_state->num_operands = 0;
563
Len Brown4be44fc2005-08-05 00:44:28 -0400564 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
Valery Podrezov9bc75cf2007-02-02 19:48:21 +0300565 "**** Begin nested execution of [%4.4s] **** WalkState=%p\n",
566 method_node->name.ascii, next_walk_state));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567
Bob Mooreb229cf92006-04-21 17:15:00 -0400568 /* Invoke an internal method if necessary */
569
Lin Ming26294842011-01-12 09:19:43 +0800570 if (obj_desc->method.info_flags & ACPI_METHOD_INTERNAL_ONLY) {
571 status =
572 obj_desc->method.dispatch.implementation(next_walk_state);
Bob Moorea8fadc92008-11-13 09:45:35 +0800573 if (status == AE_OK) {
574 status = AE_CTRL_TERMINATE;
575 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576 }
577
Robert Mooreaff8c272005-09-02 17:24:17 -0400578 return_ACPI_STATUS(status);
579
Lv Zheng10622bf2013-10-29 09:30:02 +0800580cleanup:
Robert Mooreaff8c272005-09-02 17:24:17 -0400581
Bob Mooreb229cf92006-04-21 17:15:00 -0400582 /* On error, we must terminate the method properly */
583
584 acpi_ds_terminate_control_method(obj_desc, next_walk_state);
585 if (next_walk_state) {
586 acpi_ds_delete_walk_state(next_walk_state);
Robert Mooreaff8c272005-09-02 17:24:17 -0400587 }
Len Browna94f1882005-09-03 00:09:12 -0400588
Len Brown4be44fc2005-08-05 00:44:28 -0400589 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590}
591
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592/*******************************************************************************
593 *
594 * FUNCTION: acpi_ds_restart_control_method
595 *
596 * PARAMETERS: walk_state - State for preempted method (caller)
597 * return_desc - Return value from the called method
598 *
599 * RETURN: Status
600 *
601 * DESCRIPTION: Restart a method that was preempted by another (nested) method
Bob Moore73a30902012-10-31 02:26:55 +0000602 * invocation. Handle the return value (if any) from the callee.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603 *
604 ******************************************************************************/
605
606acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400607acpi_ds_restart_control_method(struct acpi_walk_state *walk_state,
608 union acpi_operand_object *return_desc)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609{
Len Brown4be44fc2005-08-05 00:44:28 -0400610 acpi_status status;
Bob Moore958dd242006-05-12 17:12:00 -0400611 int same_as_implicit_return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612
Bob Mooreb229cf92006-04-21 17:15:00 -0400613 ACPI_FUNCTION_TRACE_PTR(ds_restart_control_method, walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614
Len Brown4be44fc2005-08-05 00:44:28 -0400615 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
Bob Mooreb229cf92006-04-21 17:15:00 -0400616 "****Restart [%4.4s] Op %p ReturnValueFromCallee %p\n",
Bob Mooref6dd9222006-07-07 20:44:38 -0400617 acpi_ut_get_node_name(walk_state->method_node),
Len Brown4be44fc2005-08-05 00:44:28 -0400618 walk_state->method_call_op, return_desc));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619
Len Brown4be44fc2005-08-05 00:44:28 -0400620 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
Bob Mooreb229cf92006-04-21 17:15:00 -0400621 " ReturnFromThisMethodUsed?=%X ResStack %p Walk %p\n",
Len Brown4be44fc2005-08-05 00:44:28 -0400622 walk_state->return_used,
623 walk_state->results, walk_state));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624
625 /* Did the called method return a value? */
626
627 if (return_desc) {
Bob Moore52fc0b02006-10-02 00:00:00 -0400628
Bob Moore958dd242006-05-12 17:12:00 -0400629 /* Is the implicit return object the same as the return desc? */
630
631 same_as_implicit_return =
632 (walk_state->implicit_return_obj == return_desc);
633
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634 /* Are we actually going to use the return value? */
635
636 if (walk_state->return_used) {
Bob Moore52fc0b02006-10-02 00:00:00 -0400637
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638 /* Save the return value from the previous method */
639
Len Brown4be44fc2005-08-05 00:44:28 -0400640 status = acpi_ds_result_push(return_desc, walk_state);
641 if (ACPI_FAILURE(status)) {
642 acpi_ut_remove_reference(return_desc);
643 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644 }
645
646 /*
647 * Save as THIS method's return value in case it is returned
648 * immediately to yet another method
649 */
650 walk_state->return_desc = return_desc;
651 }
652
653 /*
Bob Moore958dd242006-05-12 17:12:00 -0400654 * The following code is the optional support for the so-called
655 * "implicit return". Some AML code assumes that the last value of the
656 * method is "implicitly" returned to the caller, in the absence of an
657 * explicit return value.
658 *
659 * Just save the last result of the method as the return value.
660 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661 * NOTE: this is optional because the ASL language does not actually
662 * support this behavior.
663 */
Len Brown4be44fc2005-08-05 00:44:28 -0400664 else if (!acpi_ds_do_implicit_return
Bob Moore958dd242006-05-12 17:12:00 -0400665 (return_desc, walk_state, FALSE)
666 || same_as_implicit_return) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667 /*
668 * Delete the return value if it will not be used by the
Bob Moore958dd242006-05-12 17:12:00 -0400669 * calling method or remove one reference if the explicit return
670 * is the same as the implicit return value.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700671 */
Len Brown4be44fc2005-08-05 00:44:28 -0400672 acpi_ut_remove_reference(return_desc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700673 }
674 }
675
Len Brown4be44fc2005-08-05 00:44:28 -0400676 return_ACPI_STATUS(AE_OK);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677}
678
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679/*******************************************************************************
680 *
681 * FUNCTION: acpi_ds_terminate_control_method
682 *
Bob Mooreb229cf92006-04-21 17:15:00 -0400683 * PARAMETERS: method_desc - Method object
684 * walk_state - State associated with the method
Linus Torvalds1da177e2005-04-16 15:20:36 -0700685 *
Robert Mooreaff8c272005-09-02 17:24:17 -0400686 * RETURN: None
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687 *
Bob Moore73a30902012-10-31 02:26:55 +0000688 * DESCRIPTION: Terminate a control method. Delete everything that the method
Linus Torvalds1da177e2005-04-16 15:20:36 -0700689 * created, delete all locals and arguments, and delete the parse
690 * tree if requested.
691 *
Bob Moore967440e32006-06-23 17:04:00 -0400692 * MUTEX: Interpreter is locked
693 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694 ******************************************************************************/
695
Bob Mooreb229cf92006-04-21 17:15:00 -0400696void
697acpi_ds_terminate_control_method(union acpi_operand_object *method_desc,
698 struct acpi_walk_state *walk_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700
Bob Mooreb229cf92006-04-21 17:15:00 -0400701 ACPI_FUNCTION_TRACE_PTR(ds_terminate_control_method, walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700702
Bob Mooreb229cf92006-04-21 17:15:00 -0400703 /* method_desc is required, walk_state is optional */
704
705 if (!method_desc) {
Robert Mooreaff8c272005-09-02 17:24:17 -0400706 return_VOID;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700707 }
708
Bob Mooreb229cf92006-04-21 17:15:00 -0400709 if (walk_state) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700710
Bob Mooreb229cf92006-04-21 17:15:00 -0400711 /* Delete all arguments and locals */
712
713 acpi_ds_method_data_delete_all(walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714
Bob Mooreb7f9f042008-04-10 19:06:40 +0400715 /*
716 * If method is serialized, release the mutex and restore the
717 * current sync level for this thread
718 */
719 if (method_desc->method.mutex) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720
Bob Mooreb7f9f042008-04-10 19:06:40 +0400721 /* Acquisition Depth handles recursive calls */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722
Bob Mooreb7f9f042008-04-10 19:06:40 +0400723 method_desc->method.mutex->mutex.acquisition_depth--;
724 if (!method_desc->method.mutex->mutex.acquisition_depth) {
725 walk_state->thread->current_sync_level =
726 method_desc->method.mutex->mutex.
727 original_sync_level;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728
Bob Mooreb7f9f042008-04-10 19:06:40 +0400729 acpi_os_release_mutex(method_desc->method.
730 mutex->mutex.os_mutex);
Lin Ming28eb3fc2010-09-15 13:55:13 +0800731 method_desc->method.mutex->mutex.thread_id = 0;
Bob Mooreb7f9f042008-04-10 19:06:40 +0400732 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734
Bob Mooreb229cf92006-04-21 17:15:00 -0400735 /*
Lin Ming7f0c8262009-08-13 14:03:15 +0800736 * Delete any namespace objects created anywhere within the
Lin Ming26294842011-01-12 09:19:43 +0800737 * namespace by the execution of this method. Unless:
738 * 1) This method is a module-level executable code method, in which
739 * case we want make the objects permanent.
740 * 2) There are other threads executing the method, in which case we
741 * will wait until the last thread has completed.
Bob Mooreb229cf92006-04-21 17:15:00 -0400742 */
Lin Ming26294842011-01-12 09:19:43 +0800743 if (!(method_desc->method.info_flags & ACPI_METHOD_MODULE_LEVEL)
744 && (method_desc->method.thread_count == 1)) {
Alexey Starikovskiya9fc0312010-05-26 13:59:51 +0800745
746 /* Delete any direct children of (created by) this method */
747
748 acpi_ns_delete_namespace_subtree(walk_state->
749 method_node);
750
751 /*
752 * Delete any objects that were created by this method
753 * elsewhere in the namespace (if any were created).
Lin Ming26294842011-01-12 09:19:43 +0800754 * Use of the ACPI_METHOD_MODIFIED_NAMESPACE optimizes the
755 * deletion such that we don't have to perform an entire
756 * namespace walk for every control method execution.
Alexey Starikovskiya9fc0312010-05-26 13:59:51 +0800757 */
758 if (method_desc->method.
Lin Ming26294842011-01-12 09:19:43 +0800759 info_flags & ACPI_METHOD_MODIFIED_NAMESPACE) {
Alexey Starikovskiya9fc0312010-05-26 13:59:51 +0800760 acpi_ns_delete_namespace_by_owner(method_desc->
761 method.
762 owner_id);
Lin Ming26294842011-01-12 09:19:43 +0800763 method_desc->method.info_flags &=
764 ~ACPI_METHOD_MODIFIED_NAMESPACE;
Alexey Starikovskiya9fc0312010-05-26 13:59:51 +0800765 }
Lin Ming7f0c8262009-08-13 14:03:15 +0800766 }
Bob Moore28f55eb2005-12-02 18:27:00 -0500767 }
768
Bob Mooreb229cf92006-04-21 17:15:00 -0400769 /* Decrement the thread count on the method */
Bob Moore28f55eb2005-12-02 18:27:00 -0500770
Bob Mooreb229cf92006-04-21 17:15:00 -0400771 if (method_desc->method.thread_count) {
772 method_desc->method.thread_count--;
773 } else {
774 ACPI_ERROR((AE_INFO, "Invalid zero thread count in method"));
775 }
Bob Moore28f55eb2005-12-02 18:27:00 -0500776
777 /* Are there any other threads currently executing this method? */
778
Bob Mooreb229cf92006-04-21 17:15:00 -0400779 if (method_desc->method.thread_count) {
Bob Moore28f55eb2005-12-02 18:27:00 -0500780 /*
781 * Additional threads. Do not release the owner_id in this case,
782 * we immediately reuse it for the next thread executing this method
783 */
Len Brown4be44fc2005-08-05 00:44:28 -0400784 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
Bob Mooreb27d6592010-05-26 11:47:13 +0800785 "*** Completed execution of one thread, %u threads remaining\n",
Bob Mooreb229cf92006-04-21 17:15:00 -0400786 method_desc->method.thread_count));
Bob Moore28f55eb2005-12-02 18:27:00 -0500787 } else {
788 /* This is the only executing thread for this method */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789
Linus Torvalds1da177e2005-04-16 15:20:36 -0700790 /*
791 * Support to dynamically change a method from not_serialized to
Bob Moore28f55eb2005-12-02 18:27:00 -0500792 * Serialized if it appears that the method is incorrectly written and
Bob Moore967440e32006-06-23 17:04:00 -0400793 * does not support multiple thread execution. The best example of this
794 * is if such a method creates namespace objects and blocks. A second
Lin Ming26294842011-01-12 09:19:43 +0800795 * thread will fail with an AE_ALREADY_EXISTS exception.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700796 *
797 * This code is here because we must wait until the last thread exits
Lin Ming26294842011-01-12 09:19:43 +0800798 * before marking the method as serialized.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799 */
Lin Ming26294842011-01-12 09:19:43 +0800800 if (method_desc->method.
801 info_flags & ACPI_METHOD_SERIALIZED_PENDING) {
802 if (walk_state) {
803 ACPI_INFO((AE_INFO,
804 "Marking method %4.4s as Serialized because of AE_ALREADY_EXISTS error",
805 walk_state->method_node->name.
806 ascii));
807 }
808
809 /*
810 * Method tried to create an object twice and was marked as
811 * "pending serialized". The probable cause is that the method
812 * cannot handle reentrancy.
813 *
814 * The method was created as not_serialized, but it tried to create
815 * a named object and then blocked, causing the second thread
816 * entrance to begin and then fail. Workaround this problem by
817 * marking the method permanently as Serialized when the last
818 * thread exits here.
819 */
820 method_desc->method.info_flags &=
821 ~ACPI_METHOD_SERIALIZED_PENDING;
822 method_desc->method.info_flags |=
Bob Moored1825572014-03-24 14:49:13 +0800823 (ACPI_METHOD_SERIALIZED |
824 ACPI_METHOD_IGNORE_SYNC_LEVEL);
Lin Ming26294842011-01-12 09:19:43 +0800825 method_desc->method.sync_level = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826 }
827
Bob Moore28f55eb2005-12-02 18:27:00 -0500828 /* No more threads, we can free the owner_id */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700829
Lin Ming26294842011-01-12 09:19:43 +0800830 if (!
831 (method_desc->method.
832 info_flags & ACPI_METHOD_MODULE_LEVEL)) {
Lin Ming7f0c8262009-08-13 14:03:15 +0800833 acpi_ut_release_owner_id(&method_desc->method.owner_id);
834 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835 }
Len Browna94f1882005-09-03 00:09:12 -0400836
Lv Zhengab6c5732015-07-23 12:52:59 +0800837 acpi_ex_stop_trace_method((struct acpi_namespace_node *)method_desc->
838 method.node, method_desc, walk_state);
Lv Zhenga616dc22015-07-23 12:52:53 +0800839
Robert Mooreaff8c272005-09-02 17:24:17 -0400840 return_VOID;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841}