blob: d72565a3c646ddb6b4c819019da46b3320f19024 [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
106 op = acpi_ps_alloc_op(AML_METHOD_OP);
107 if (!op) {
108 return_ACPI_STATUS(AE_NO_MEMORY);
109 }
110
111 acpi_ps_set_name(op, node->name.integer);
112 op->common.node = node;
113
114 /* Create and initialize a new walk state */
115
116 walk_state =
117 acpi_ds_create_walk_state(node->owner_id, NULL, NULL, NULL);
118 if (!walk_state) {
119 return_ACPI_STATUS(AE_NO_MEMORY);
120 }
121
122 status =
123 acpi_ds_init_aml_walk(walk_state, op, node,
124 obj_desc->method.aml_start,
125 obj_desc->method.aml_length, NULL, 0);
126 if (ACPI_FAILURE(status)) {
127 acpi_ds_delete_walk_state(walk_state);
128 return_ACPI_STATUS(status);
129 }
130
131 walk_state->descending_callback = acpi_ds_detect_named_opcodes;
132
133 /* Parse the method, scan for creation of named objects */
134
135 status = acpi_ps_parse_aml(walk_state);
136 if (ACPI_FAILURE(status)) {
137 return_ACPI_STATUS(status);
138 }
139
140 acpi_ps_delete_parse_tree(op);
141 return_ACPI_STATUS(status);
142}
143
144/*******************************************************************************
145 *
146 * FUNCTION: acpi_ds_detect_named_opcodes
147 *
148 * PARAMETERS: walk_state - Current state of the parse tree walk
149 * out_op - Unused, required for parser interface
150 *
151 * RETURN: Status
152 *
153 * DESCRIPTION: Descending callback used during the loading of ACPI tables.
154 * Currently used to detect methods that must be marked serialized
155 * in order to avoid problems with the creation of named objects.
156 *
157 ******************************************************************************/
158
159static acpi_status
160acpi_ds_detect_named_opcodes(struct acpi_walk_state *walk_state,
161 union acpi_parse_object **out_op)
162{
163
164 ACPI_FUNCTION_NAME(acpi_ds_detect_named_opcodes);
165
Lv Zheng21bd7e62014-03-24 14:49:07 +0800166 /* We are only interested in opcodes that create a new name */
Bob Moore22b5afc2014-03-24 14:49:00 +0800167
Lv Zheng21bd7e62014-03-24 14:49:07 +0800168 if (!
169 (walk_state->op_info->
170 flags & (AML_NAMED | AML_CREATE | AML_FIELD))) {
Bob Moore22b5afc2014-03-24 14:49:00 +0800171 return (AE_OK);
172 }
173
174 /*
175 * At this point, we know we have a Named object opcode.
176 * Mark the method as serialized. Later code will create a mutex for
177 * this method to enforce serialization.
Bob Moored1825572014-03-24 14:49:13 +0800178 *
179 * Note, ACPI_METHOD_IGNORE_SYNC_LEVEL flag means that we will ignore the
180 * Sync Level mechanism for this method, even though it is now serialized.
181 * Otherwise, there can be conflicts with existing ASL code that actually
182 * uses sync levels.
Bob Moore22b5afc2014-03-24 14:49:00 +0800183 */
Bob Moored1825572014-03-24 14:49:13 +0800184 walk_state->method_desc->method.sync_level = 0;
185 walk_state->method_desc->method.info_flags |=
186 (ACPI_METHOD_SERIALIZED | ACPI_METHOD_IGNORE_SYNC_LEVEL);
Bob Moore22b5afc2014-03-24 14:49:00 +0800187
188 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
189 "Method serialized [%4.4s] %p - [%s] (%4.4X)\n",
190 walk_state->method_node->name.ascii,
191 walk_state->method_node, walk_state->op_info->name,
192 walk_state->opcode));
193
194 /* Abort the parse, no need to examine this method any further */
195
196 return (AE_CTRL_TERMINATE);
197}
198
199/*******************************************************************************
200 *
Bob Mooredefba1d2005-12-16 17:05:00 -0500201 * FUNCTION: acpi_ds_method_error
202 *
Bob Mooreba494be2012-07-12 09:40:10 +0800203 * PARAMETERS: status - Execution status
Bob Mooredefba1d2005-12-16 17:05:00 -0500204 * walk_state - Current state
205 *
206 * RETURN: Status
207 *
208 * DESCRIPTION: Called on method error. Invoke the global exception handler if
209 * present, dump the method data if the disassembler is configured
210 *
211 * Note: Allows the exception handler to change the status code
212 *
213 ******************************************************************************/
Bob Moore967440e32006-06-23 17:04:00 -0400214
Bob Mooredefba1d2005-12-16 17:05:00 -0500215acpi_status
Bob Moore22b5afc2014-03-24 14:49:00 +0800216acpi_ds_method_error(acpi_status status, struct acpi_walk_state * walk_state)
Bob Mooredefba1d2005-12-16 17:05:00 -0500217{
218 ACPI_FUNCTION_ENTRY();
219
220 /* Ignore AE_OK and control exception codes */
221
222 if (ACPI_SUCCESS(status) || (status & AE_CODE_CONTROL)) {
223 return (status);
224 }
225
226 /* Invoke the global exception handler */
227
228 if (acpi_gbl_exception_handler) {
Bob Moore52fc0b02006-10-02 00:00:00 -0400229
Bob Mooredefba1d2005-12-16 17:05:00 -0500230 /* Exit the interpreter, allow handler to execute methods */
231
232 acpi_ex_exit_interpreter();
233
234 /*
235 * Handler can map the exception code to anything it wants, including
236 * AE_OK, in which case the executing method will not be aborted.
237 */
238 status = acpi_gbl_exception_handler(status,
239 walk_state->method_node ?
240 walk_state->method_node->
241 name.integer : 0,
242 walk_state->opcode,
243 walk_state->aml_offset,
244 NULL);
Bob Mooreb7f9f042008-04-10 19:06:40 +0400245 acpi_ex_enter_interpreter();
Bob Mooredefba1d2005-12-16 17:05:00 -0500246 }
Lin Mingd8a0ec92008-09-27 11:50:24 +0800247
248 acpi_ds_clear_implicit_return(walk_state);
249
Bob Mooredefba1d2005-12-16 17:05:00 -0500250#ifdef ACPI_DISASSEMBLER
251 if (ACPI_FAILURE(status)) {
Bob Moore52fc0b02006-10-02 00:00:00 -0400252
Bob Mooredefba1d2005-12-16 17:05:00 -0500253 /* Display method locals/args if disassembler is present */
254
255 acpi_dm_dump_method_info(status, walk_state, walk_state->op);
256 }
257#endif
258
259 return (status);
260}
261
262/*******************************************************************************
263 *
Bob Moore967440e32006-06-23 17:04:00 -0400264 * FUNCTION: acpi_ds_create_method_mutex
265 *
266 * PARAMETERS: obj_desc - The method object
267 *
268 * RETURN: Status
269 *
270 * DESCRIPTION: Create a mutex object for a serialized control method
271 *
272 ******************************************************************************/
273
274static acpi_status
275acpi_ds_create_method_mutex(union acpi_operand_object *method_desc)
276{
277 union acpi_operand_object *mutex_desc;
278 acpi_status status;
279
Bob Mooref6dd9222006-07-07 20:44:38 -0400280 ACPI_FUNCTION_TRACE(ds_create_method_mutex);
Bob Moore967440e32006-06-23 17:04:00 -0400281
282 /* Create the new mutex object */
283
284 mutex_desc = acpi_ut_create_internal_object(ACPI_TYPE_MUTEX);
285 if (!mutex_desc) {
286 return_ACPI_STATUS(AE_NO_MEMORY);
287 }
288
289 /* Create the actual OS Mutex */
290
291 status = acpi_os_create_mutex(&mutex_desc->mutex.os_mutex);
292 if (ACPI_FAILURE(status)) {
Tim Gardner78d025e2012-12-31 00:06:56 +0000293 acpi_ut_delete_object_desc(mutex_desc);
Bob Moore967440e32006-06-23 17:04:00 -0400294 return_ACPI_STATUS(status);
295 }
296
297 mutex_desc->mutex.sync_level = method_desc->method.sync_level;
298 method_desc->method.mutex = mutex_desc;
299 return_ACPI_STATUS(AE_OK);
300}
301
302/*******************************************************************************
303 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304 * FUNCTION: acpi_ds_begin_method_execution
305 *
306 * PARAMETERS: method_node - Node of the method
307 * obj_desc - The method object
Bob Moore967440e32006-06-23 17:04:00 -0400308 * walk_state - current state, NULL if not yet executing
309 * a method.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310 *
311 * RETURN: Status
312 *
Bob Moore73a30902012-10-31 02:26:55 +0000313 * DESCRIPTION: Prepare a method for execution. Parses the method if necessary,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314 * increments the thread count, and waits at the method semaphore
315 * for clearance to execute.
316 *
317 ******************************************************************************/
Bob Mooredefba1d2005-12-16 17:05:00 -0500318
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319acpi_status
Bob Moore967440e32006-06-23 17:04:00 -0400320acpi_ds_begin_method_execution(struct acpi_namespace_node *method_node,
321 union acpi_operand_object *obj_desc,
322 struct acpi_walk_state *walk_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323{
Len Brown4be44fc2005-08-05 00:44:28 -0400324 acpi_status status = AE_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325
Bob Mooreb229cf92006-04-21 17:15:00 -0400326 ACPI_FUNCTION_TRACE_PTR(ds_begin_method_execution, method_node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327
328 if (!method_node) {
Len Brown4be44fc2005-08-05 00:44:28 -0400329 return_ACPI_STATUS(AE_NULL_ENTRY);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330 }
331
Robert Mooreaff8c272005-09-02 17:24:17 -0400332 /* Prevent wraparound of thread count */
333
334 if (obj_desc->method.thread_count == ACPI_UINT8_MAX) {
Bob Mooreb8e4d892006-01-27 16:43:00 -0500335 ACPI_ERROR((AE_INFO,
336 "Method reached maximum reentrancy limit (255)"));
Robert Mooreaff8c272005-09-02 17:24:17 -0400337 return_ACPI_STATUS(AE_AML_METHOD_LIMIT);
338 }
339
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340 /*
Bob Moore967440e32006-06-23 17:04:00 -0400341 * If this method is serialized, we need to acquire the method mutex.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342 */
Lin Ming26294842011-01-12 09:19:43 +0800343 if (obj_desc->method.info_flags & ACPI_METHOD_SERIALIZED) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344 /*
Bob Moore967440e32006-06-23 17:04:00 -0400345 * Create a mutex for the method if it is defined to be Serialized
346 * and a mutex has not already been created. We defer the mutex creation
347 * until a method is actually executed, to minimize the object count
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348 */
Bob Moore967440e32006-06-23 17:04:00 -0400349 if (!obj_desc->method.mutex) {
350 status = acpi_ds_create_method_mutex(obj_desc);
351 if (ACPI_FAILURE(status)) {
352 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353 }
354 }
355
356 /*
Bob Moore967440e32006-06-23 17:04:00 -0400357 * The current_sync_level (per-thread) must be less than or equal to
358 * the sync level of the method. This mechanism provides some
Bob Moored1825572014-03-24 14:49:13 +0800359 * deadlock prevention.
360 *
361 * If the method was auto-serialized, we just ignore the sync level
362 * mechanism, because auto-serialization of methods can interfere
363 * with ASL code that actually uses sync levels.
Bob Moore967440e32006-06-23 17:04:00 -0400364 *
365 * Top-level method invocation has no walk state at this point
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366 */
Bob Moore967440e32006-06-23 17:04:00 -0400367 if (walk_state &&
Bob Moored1825572014-03-24 14:49:13 +0800368 (!(obj_desc->method.
369 info_flags & ACPI_METHOD_IGNORE_SYNC_LEVEL))
370 && (walk_state->thread->current_sync_level >
371 obj_desc->method.mutex->mutex.sync_level)) {
Bob Moore967440e32006-06-23 17:04:00 -0400372 ACPI_ERROR((AE_INFO,
Bob Mooref6a22b02010-03-05 17:56:40 +0800373 "Cannot acquire Mutex for method [%4.4s], current SyncLevel is too large (%u)",
Bob Moore967440e32006-06-23 17:04:00 -0400374 acpi_ut_get_node_name(method_node),
375 walk_state->thread->current_sync_level));
376
377 return_ACPI_STATUS(AE_AML_MUTEX_ORDER);
Bob Mooreb229cf92006-04-21 17:15:00 -0400378 }
Bob Moore967440e32006-06-23 17:04:00 -0400379
380 /*
381 * Obtain the method mutex if necessary. Do not acquire mutex for a
382 * recursive call.
383 */
Len Brown262a7a22007-05-09 23:01:59 -0400384 if (!walk_state ||
Bob Mooreba886cd2008-04-10 19:06:37 +0400385 !obj_desc->method.mutex->mutex.thread_id ||
386 (walk_state->thread->thread_id !=
387 obj_desc->method.mutex->mutex.thread_id)) {
Bob Moore967440e32006-06-23 17:04:00 -0400388 /*
389 * Acquire the method mutex. This releases the interpreter if we
390 * block (and reacquires it before it returns)
391 */
392 status =
393 acpi_ex_system_wait_mutex(obj_desc->method.mutex->
394 mutex.os_mutex,
395 ACPI_WAIT_FOREVER);
396 if (ACPI_FAILURE(status)) {
397 return_ACPI_STATUS(status);
398 }
399
400 /* Update the mutex and walk info and save the original sync_level */
401
402 if (walk_state) {
403 obj_desc->method.mutex->mutex.
404 original_sync_level =
405 walk_state->thread->current_sync_level;
406
Bob Mooreba886cd2008-04-10 19:06:37 +0400407 obj_desc->method.mutex->mutex.thread_id =
408 walk_state->thread->thread_id;
Bob Moore967440e32006-06-23 17:04:00 -0400409 walk_state->thread->current_sync_level =
410 obj_desc->method.sync_level;
411 } else {
412 obj_desc->method.mutex->mutex.
413 original_sync_level =
414 obj_desc->method.mutex->mutex.sync_level;
415 }
416 }
417
418 /* Always increase acquisition depth */
419
420 obj_desc->method.mutex->mutex.acquisition_depth++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421 }
422
423 /*
Robert Mooreaff8c272005-09-02 17:24:17 -0400424 * Allocate an Owner ID for this method, only if this is the first thread
425 * to begin concurrent execution. We only need one owner_id, even if the
426 * method is invoked recursively.
427 */
428 if (!obj_desc->method.owner_id) {
429 status = acpi_ut_allocate_owner_id(&obj_desc->method.owner_id);
430 if (ACPI_FAILURE(status)) {
Bob Mooreb229cf92006-04-21 17:15:00 -0400431 goto cleanup;
Robert Mooreaff8c272005-09-02 17:24:17 -0400432 }
433 }
434
435 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436 * Increment the method parse tree thread count since it has been
437 * reentered one more time (even if it is the same thread)
438 */
439 obj_desc->method.thread_count++;
Lv Zheng9187a412013-10-31 09:30:28 +0800440 acpi_method_count++;
Len Brown4be44fc2005-08-05 00:44:28 -0400441 return_ACPI_STATUS(status);
Bob Mooreb229cf92006-04-21 17:15:00 -0400442
Lv Zheng10622bf2013-10-29 09:30:02 +0800443cleanup:
Bob Moore967440e32006-06-23 17:04:00 -0400444 /* On error, must release the method mutex (if present) */
Bob Mooreb229cf92006-04-21 17:15:00 -0400445
Bob Moore967440e32006-06-23 17:04:00 -0400446 if (obj_desc->method.mutex) {
447 acpi_os_release_mutex(obj_desc->method.mutex->mutex.os_mutex);
Bob Mooreb229cf92006-04-21 17:15:00 -0400448 }
449 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450}
451
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452/*******************************************************************************
453 *
454 * FUNCTION: acpi_ds_call_control_method
455 *
Bob Mooreba494be2012-07-12 09:40:10 +0800456 * PARAMETERS: thread - Info for this thread
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457 * this_walk_state - Current walk state
Bob Mooreba494be2012-07-12 09:40:10 +0800458 * op - Current Op to be walked
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459 *
460 * RETURN: Status
461 *
462 * DESCRIPTION: Transfer execution to a called control method
463 *
464 ******************************************************************************/
465
466acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400467acpi_ds_call_control_method(struct acpi_thread_state *thread,
468 struct acpi_walk_state *this_walk_state,
469 union acpi_parse_object *op)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470{
Len Brown4be44fc2005-08-05 00:44:28 -0400471 acpi_status status;
472 struct acpi_namespace_node *method_node;
473 struct acpi_walk_state *next_walk_state = NULL;
474 union acpi_operand_object *obj_desc;
Bob Moore41195322006-05-26 16:36:00 -0400475 struct acpi_evaluate_info *info;
Len Brown4be44fc2005-08-05 00:44:28 -0400476 u32 i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477
Bob Mooreb229cf92006-04-21 17:15:00 -0400478 ACPI_FUNCTION_TRACE_PTR(ds_call_control_method, this_walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479
Len Brown4be44fc2005-08-05 00:44:28 -0400480 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
Valery Podrezov9bc75cf2007-02-02 19:48:21 +0300481 "Calling method %p, currentstate=%p\n",
Len Brown4be44fc2005-08-05 00:44:28 -0400482 this_walk_state->prev_op, this_walk_state));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483
484 /*
485 * Get the namespace entry for the control method we are about to call
486 */
487 method_node = this_walk_state->method_call_node;
488 if (!method_node) {
Len Brown4be44fc2005-08-05 00:44:28 -0400489 return_ACPI_STATUS(AE_NULL_ENTRY);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490 }
491
Len Brown4be44fc2005-08-05 00:44:28 -0400492 obj_desc = acpi_ns_get_attached_object(method_node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700493 if (!obj_desc) {
Len Brown4be44fc2005-08-05 00:44:28 -0400494 return_ACPI_STATUS(AE_NULL_OBJECT);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495 }
496
Bob Moore967440e32006-06-23 17:04:00 -0400497 /* Init for new method, possibly wait on method mutex */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498
Len Brown4be44fc2005-08-05 00:44:28 -0400499 status = acpi_ds_begin_method_execution(method_node, obj_desc,
Bob Moore967440e32006-06-23 17:04:00 -0400500 this_walk_state);
Len Brown4be44fc2005-08-05 00:44:28 -0400501 if (ACPI_FAILURE(status)) {
Bob Mooreb229cf92006-04-21 17:15:00 -0400502 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503 }
504
Valery Podrezov9bc75cf2007-02-02 19:48:21 +0300505 /* Begin method parse/execution. Create a new walk state */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506
Len Brown4be44fc2005-08-05 00:44:28 -0400507 next_walk_state = acpi_ds_create_walk_state(obj_desc->method.owner_id,
508 NULL, obj_desc, thread);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509 if (!next_walk_state) {
510 status = AE_NO_MEMORY;
511 goto cleanup;
512 }
Bob Mooreb229cf92006-04-21 17:15:00 -0400513
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514 /*
515 * The resolved arguments were put on the previous walk state's operand
Robert Mooreaff8c272005-09-02 17:24:17 -0400516 * stack. Operands on the previous walk state stack always
517 * start at index 0. Also, null terminate the list of arguments
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518 */
Len Brown4be44fc2005-08-05 00:44:28 -0400519 this_walk_state->operands[this_walk_state->num_operands] = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520
Bob Moore41195322006-05-26 16:36:00 -0400521 /*
522 * Allocate and initialize the evaluation information block
523 * TBD: this is somewhat inefficient, should change interface to
524 * ds_init_aml_walk. For now, keeps this struct off the CPU stack
525 */
526 info = ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_evaluate_info));
527 if (!info) {
Jesper Juhl22715822012-12-19 05:37:47 +0000528 status = AE_NO_MEMORY;
529 goto cleanup;
Bob Moore41195322006-05-26 16:36:00 -0400530 }
531
532 info->parameters = &this_walk_state->operands[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533
Len Brown4be44fc2005-08-05 00:44:28 -0400534 status = acpi_ds_init_aml_walk(next_walk_state, NULL, method_node,
535 obj_desc->method.aml_start,
Bob Mooreec3153f2007-02-02 19:48:21 +0300536 obj_desc->method.aml_length, info,
537 ACPI_IMODE_EXECUTE);
Bob Moore41195322006-05-26 16:36:00 -0400538
539 ACPI_FREE(info);
Len Brown4be44fc2005-08-05 00:44:28 -0400540 if (ACPI_FAILURE(status)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541 goto cleanup;
542 }
543
544 /*
545 * Delete the operands on the previous walkstate operand stack
546 * (they were copied to new objects)
547 */
548 for (i = 0; i < obj_desc->method.param_count; i++) {
Len Brown4be44fc2005-08-05 00:44:28 -0400549 acpi_ut_remove_reference(this_walk_state->operands[i]);
550 this_walk_state->operands[i] = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551 }
552
553 /* Clear the operand stack */
554
555 this_walk_state->num_operands = 0;
556
Len Brown4be44fc2005-08-05 00:44:28 -0400557 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
Valery Podrezov9bc75cf2007-02-02 19:48:21 +0300558 "**** Begin nested execution of [%4.4s] **** WalkState=%p\n",
559 method_node->name.ascii, next_walk_state));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700560
Bob Mooreb229cf92006-04-21 17:15:00 -0400561 /* Invoke an internal method if necessary */
562
Lin Ming26294842011-01-12 09:19:43 +0800563 if (obj_desc->method.info_flags & ACPI_METHOD_INTERNAL_ONLY) {
564 status =
565 obj_desc->method.dispatch.implementation(next_walk_state);
Bob Moorea8fadc92008-11-13 09:45:35 +0800566 if (status == AE_OK) {
567 status = AE_CTRL_TERMINATE;
568 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569 }
570
Robert Mooreaff8c272005-09-02 17:24:17 -0400571 return_ACPI_STATUS(status);
572
Lv Zheng10622bf2013-10-29 09:30:02 +0800573cleanup:
Robert Mooreaff8c272005-09-02 17:24:17 -0400574
Bob Mooreb229cf92006-04-21 17:15:00 -0400575 /* On error, we must terminate the method properly */
576
577 acpi_ds_terminate_control_method(obj_desc, next_walk_state);
578 if (next_walk_state) {
579 acpi_ds_delete_walk_state(next_walk_state);
Robert Mooreaff8c272005-09-02 17:24:17 -0400580 }
Len Browna94f1882005-09-03 00:09:12 -0400581
Len Brown4be44fc2005-08-05 00:44:28 -0400582 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583}
584
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585/*******************************************************************************
586 *
587 * FUNCTION: acpi_ds_restart_control_method
588 *
589 * PARAMETERS: walk_state - State for preempted method (caller)
590 * return_desc - Return value from the called method
591 *
592 * RETURN: Status
593 *
594 * DESCRIPTION: Restart a method that was preempted by another (nested) method
Bob Moore73a30902012-10-31 02:26:55 +0000595 * invocation. Handle the return value (if any) from the callee.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596 *
597 ******************************************************************************/
598
599acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400600acpi_ds_restart_control_method(struct acpi_walk_state *walk_state,
601 union acpi_operand_object *return_desc)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602{
Len Brown4be44fc2005-08-05 00:44:28 -0400603 acpi_status status;
Bob Moore958dd242006-05-12 17:12:00 -0400604 int same_as_implicit_return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605
Bob Mooreb229cf92006-04-21 17:15:00 -0400606 ACPI_FUNCTION_TRACE_PTR(ds_restart_control_method, walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607
Len Brown4be44fc2005-08-05 00:44:28 -0400608 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
Bob Mooreb229cf92006-04-21 17:15:00 -0400609 "****Restart [%4.4s] Op %p ReturnValueFromCallee %p\n",
Bob Mooref6dd9222006-07-07 20:44:38 -0400610 acpi_ut_get_node_name(walk_state->method_node),
Len Brown4be44fc2005-08-05 00:44:28 -0400611 walk_state->method_call_op, return_desc));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612
Len Brown4be44fc2005-08-05 00:44:28 -0400613 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
Bob Mooreb229cf92006-04-21 17:15:00 -0400614 " ReturnFromThisMethodUsed?=%X ResStack %p Walk %p\n",
Len Brown4be44fc2005-08-05 00:44:28 -0400615 walk_state->return_used,
616 walk_state->results, walk_state));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617
618 /* Did the called method return a value? */
619
620 if (return_desc) {
Bob Moore52fc0b02006-10-02 00:00:00 -0400621
Bob Moore958dd242006-05-12 17:12:00 -0400622 /* Is the implicit return object the same as the return desc? */
623
624 same_as_implicit_return =
625 (walk_state->implicit_return_obj == return_desc);
626
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627 /* Are we actually going to use the return value? */
628
629 if (walk_state->return_used) {
Bob Moore52fc0b02006-10-02 00:00:00 -0400630
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631 /* Save the return value from the previous method */
632
Len Brown4be44fc2005-08-05 00:44:28 -0400633 status = acpi_ds_result_push(return_desc, walk_state);
634 if (ACPI_FAILURE(status)) {
635 acpi_ut_remove_reference(return_desc);
636 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637 }
638
639 /*
640 * Save as THIS method's return value in case it is returned
641 * immediately to yet another method
642 */
643 walk_state->return_desc = return_desc;
644 }
645
646 /*
Bob Moore958dd242006-05-12 17:12:00 -0400647 * The following code is the optional support for the so-called
648 * "implicit return". Some AML code assumes that the last value of the
649 * method is "implicitly" returned to the caller, in the absence of an
650 * explicit return value.
651 *
652 * Just save the last result of the method as the return value.
653 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654 * NOTE: this is optional because the ASL language does not actually
655 * support this behavior.
656 */
Len Brown4be44fc2005-08-05 00:44:28 -0400657 else if (!acpi_ds_do_implicit_return
Bob Moore958dd242006-05-12 17:12:00 -0400658 (return_desc, walk_state, FALSE)
659 || same_as_implicit_return) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660 /*
661 * Delete the return value if it will not be used by the
Bob Moore958dd242006-05-12 17:12:00 -0400662 * calling method or remove one reference if the explicit return
663 * is the same as the implicit return value.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664 */
Len Brown4be44fc2005-08-05 00:44:28 -0400665 acpi_ut_remove_reference(return_desc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666 }
667 }
668
Len Brown4be44fc2005-08-05 00:44:28 -0400669 return_ACPI_STATUS(AE_OK);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700670}
671
Linus Torvalds1da177e2005-04-16 15:20:36 -0700672/*******************************************************************************
673 *
674 * FUNCTION: acpi_ds_terminate_control_method
675 *
Bob Mooreb229cf92006-04-21 17:15:00 -0400676 * PARAMETERS: method_desc - Method object
677 * walk_state - State associated with the method
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678 *
Robert Mooreaff8c272005-09-02 17:24:17 -0400679 * RETURN: None
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680 *
Bob Moore73a30902012-10-31 02:26:55 +0000681 * DESCRIPTION: Terminate a control method. Delete everything that the method
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682 * created, delete all locals and arguments, and delete the parse
683 * tree if requested.
684 *
Bob Moore967440e32006-06-23 17:04:00 -0400685 * MUTEX: Interpreter is locked
686 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687 ******************************************************************************/
688
Bob Mooreb229cf92006-04-21 17:15:00 -0400689void
690acpi_ds_terminate_control_method(union acpi_operand_object *method_desc,
691 struct acpi_walk_state *walk_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700692{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700693
Bob Mooreb229cf92006-04-21 17:15:00 -0400694 ACPI_FUNCTION_TRACE_PTR(ds_terminate_control_method, walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695
Bob Mooreb229cf92006-04-21 17:15:00 -0400696 /* method_desc is required, walk_state is optional */
697
698 if (!method_desc) {
Robert Mooreaff8c272005-09-02 17:24:17 -0400699 return_VOID;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700 }
701
Bob Mooreb229cf92006-04-21 17:15:00 -0400702 if (walk_state) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700703
Bob Mooreb229cf92006-04-21 17:15:00 -0400704 /* Delete all arguments and locals */
705
706 acpi_ds_method_data_delete_all(walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700707
Bob Mooreb7f9f042008-04-10 19:06:40 +0400708 /*
709 * If method is serialized, release the mutex and restore the
710 * current sync level for this thread
711 */
712 if (method_desc->method.mutex) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713
Bob Mooreb7f9f042008-04-10 19:06:40 +0400714 /* Acquisition Depth handles recursive calls */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700715
Bob Mooreb7f9f042008-04-10 19:06:40 +0400716 method_desc->method.mutex->mutex.acquisition_depth--;
717 if (!method_desc->method.mutex->mutex.acquisition_depth) {
718 walk_state->thread->current_sync_level =
719 method_desc->method.mutex->mutex.
720 original_sync_level;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700721
Bob Mooreb7f9f042008-04-10 19:06:40 +0400722 acpi_os_release_mutex(method_desc->method.
723 mutex->mutex.os_mutex);
Lin Ming28eb3fc2010-09-15 13:55:13 +0800724 method_desc->method.mutex->mutex.thread_id = 0;
Bob Mooreb7f9f042008-04-10 19:06:40 +0400725 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727
Bob Mooreb229cf92006-04-21 17:15:00 -0400728 /*
Lin Ming7f0c8262009-08-13 14:03:15 +0800729 * Delete any namespace objects created anywhere within the
Lin Ming26294842011-01-12 09:19:43 +0800730 * namespace by the execution of this method. Unless:
731 * 1) This method is a module-level executable code method, in which
732 * case we want make the objects permanent.
733 * 2) There are other threads executing the method, in which case we
734 * will wait until the last thread has completed.
Bob Mooreb229cf92006-04-21 17:15:00 -0400735 */
Lin Ming26294842011-01-12 09:19:43 +0800736 if (!(method_desc->method.info_flags & ACPI_METHOD_MODULE_LEVEL)
737 && (method_desc->method.thread_count == 1)) {
Alexey Starikovskiya9fc0312010-05-26 13:59:51 +0800738
739 /* Delete any direct children of (created by) this method */
740
741 acpi_ns_delete_namespace_subtree(walk_state->
742 method_node);
743
744 /*
745 * Delete any objects that were created by this method
746 * elsewhere in the namespace (if any were created).
Lin Ming26294842011-01-12 09:19:43 +0800747 * Use of the ACPI_METHOD_MODIFIED_NAMESPACE optimizes the
748 * deletion such that we don't have to perform an entire
749 * namespace walk for every control method execution.
Alexey Starikovskiya9fc0312010-05-26 13:59:51 +0800750 */
751 if (method_desc->method.
Lin Ming26294842011-01-12 09:19:43 +0800752 info_flags & ACPI_METHOD_MODIFIED_NAMESPACE) {
Alexey Starikovskiya9fc0312010-05-26 13:59:51 +0800753 acpi_ns_delete_namespace_by_owner(method_desc->
754 method.
755 owner_id);
Lin Ming26294842011-01-12 09:19:43 +0800756 method_desc->method.info_flags &=
757 ~ACPI_METHOD_MODIFIED_NAMESPACE;
Alexey Starikovskiya9fc0312010-05-26 13:59:51 +0800758 }
Lin Ming7f0c8262009-08-13 14:03:15 +0800759 }
Bob Moore28f55eb2005-12-02 18:27:00 -0500760 }
761
Bob Mooreb229cf92006-04-21 17:15:00 -0400762 /* Decrement the thread count on the method */
Bob Moore28f55eb2005-12-02 18:27:00 -0500763
Bob Mooreb229cf92006-04-21 17:15:00 -0400764 if (method_desc->method.thread_count) {
765 method_desc->method.thread_count--;
766 } else {
767 ACPI_ERROR((AE_INFO, "Invalid zero thread count in method"));
768 }
Bob Moore28f55eb2005-12-02 18:27:00 -0500769
770 /* Are there any other threads currently executing this method? */
771
Bob Mooreb229cf92006-04-21 17:15:00 -0400772 if (method_desc->method.thread_count) {
Bob Moore28f55eb2005-12-02 18:27:00 -0500773 /*
774 * Additional threads. Do not release the owner_id in this case,
775 * we immediately reuse it for the next thread executing this method
776 */
Len Brown4be44fc2005-08-05 00:44:28 -0400777 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
Bob Mooreb27d6592010-05-26 11:47:13 +0800778 "*** Completed execution of one thread, %u threads remaining\n",
Bob Mooreb229cf92006-04-21 17:15:00 -0400779 method_desc->method.thread_count));
Bob Moore28f55eb2005-12-02 18:27:00 -0500780 } else {
781 /* This is the only executing thread for this method */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782
Linus Torvalds1da177e2005-04-16 15:20:36 -0700783 /*
784 * Support to dynamically change a method from not_serialized to
Bob Moore28f55eb2005-12-02 18:27:00 -0500785 * Serialized if it appears that the method is incorrectly written and
Bob Moore967440e32006-06-23 17:04:00 -0400786 * does not support multiple thread execution. The best example of this
787 * is if such a method creates namespace objects and blocks. A second
Lin Ming26294842011-01-12 09:19:43 +0800788 * thread will fail with an AE_ALREADY_EXISTS exception.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789 *
790 * This code is here because we must wait until the last thread exits
Lin Ming26294842011-01-12 09:19:43 +0800791 * before marking the method as serialized.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700792 */
Lin Ming26294842011-01-12 09:19:43 +0800793 if (method_desc->method.
794 info_flags & ACPI_METHOD_SERIALIZED_PENDING) {
795 if (walk_state) {
796 ACPI_INFO((AE_INFO,
797 "Marking method %4.4s as Serialized because of AE_ALREADY_EXISTS error",
798 walk_state->method_node->name.
799 ascii));
800 }
801
802 /*
803 * Method tried to create an object twice and was marked as
804 * "pending serialized". The probable cause is that the method
805 * cannot handle reentrancy.
806 *
807 * The method was created as not_serialized, but it tried to create
808 * a named object and then blocked, causing the second thread
809 * entrance to begin and then fail. Workaround this problem by
810 * marking the method permanently as Serialized when the last
811 * thread exits here.
812 */
813 method_desc->method.info_flags &=
814 ~ACPI_METHOD_SERIALIZED_PENDING;
815 method_desc->method.info_flags |=
Bob Moored1825572014-03-24 14:49:13 +0800816 (ACPI_METHOD_SERIALIZED |
817 ACPI_METHOD_IGNORE_SYNC_LEVEL);
Lin Ming26294842011-01-12 09:19:43 +0800818 method_desc->method.sync_level = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819 }
820
Bob Moore28f55eb2005-12-02 18:27:00 -0500821 /* No more threads, we can free the owner_id */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822
Lin Ming26294842011-01-12 09:19:43 +0800823 if (!
824 (method_desc->method.
825 info_flags & ACPI_METHOD_MODULE_LEVEL)) {
Lin Ming7f0c8262009-08-13 14:03:15 +0800826 acpi_ut_release_owner_id(&method_desc->method.owner_id);
827 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828 }
Len Browna94f1882005-09-03 00:09:12 -0400829
Robert Mooreaff8c272005-09-02 17:24:17 -0400830 return_VOID;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831}