Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /****************************************************************************** |
2 | * | |
3 | * Module Name: dsmethod - Parser/Interpreter interface - control method parsing | |
4 | * | |
5 | *****************************************************************************/ | |
6 | ||
7 | /* | |
82a80941 | 8 | * Copyright (C) 2000 - 2015, Intel Corp. |
1da177e4 LT |
9 | * 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 | ||
1da177e4 | 44 | #include <acpi/acpi.h> |
e2f7a777 | 45 | #include "accommon.h" |
e2f7a777 LB |
46 | #include "acdispat.h" |
47 | #include "acinterp.h" | |
48 | #include "acnamesp.h" | |
22b5afce BM |
49 | #include "acparser.h" |
50 | #include "amlcode.h" | |
fdd8d831 | 51 | #include "acdebug.h" |
1da177e4 | 52 | |
1da177e4 | 53 | #define _COMPONENT ACPI_DISPATCHER |
4be44fcd | 54 | ACPI_MODULE_NAME("dsmethod") |
1da177e4 | 55 | |
967440e3 | 56 | /* Local prototypes */ |
22b5afce BM |
57 | static acpi_status |
58 | acpi_ds_detect_named_opcodes(struct acpi_walk_state *walk_state, | |
59 | union acpi_parse_object **out_op); | |
60 | ||
967440e3 BM |
61 | static acpi_status |
62 | acpi_ds_create_method_mutex(union acpi_operand_object *method_desc); | |
63 | ||
22b5afce BM |
64 | /******************************************************************************* |
65 | * | |
66 | * 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 | ||
88 | acpi_status | |
89 | acpi_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 | ||
62eb935b | 104 | op = acpi_ps_alloc_op(AML_METHOD_OP, obj_desc->method.aml_start); |
22b5afce BM |
105 | 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) { | |
c8dec745 | 117 | acpi_ps_free_op(op); |
22b5afce BM |
118 | return_ACPI_STATUS(AE_NO_MEMORY); |
119 | } | |
120 | ||
121 | status = | |
122 | acpi_ds_init_aml_walk(walk_state, op, node, | |
123 | obj_desc->method.aml_start, | |
124 | obj_desc->method.aml_length, NULL, 0); | |
125 | if (ACPI_FAILURE(status)) { | |
126 | acpi_ds_delete_walk_state(walk_state); | |
c8dec745 | 127 | acpi_ps_free_op(op); |
22b5afce BM |
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); | |
22b5afce BM |
136 | |
137 | acpi_ps_delete_parse_tree(op); | |
138 | return_ACPI_STATUS(status); | |
139 | } | |
140 | ||
141 | /******************************************************************************* | |
142 | * | |
143 | * FUNCTION: acpi_ds_detect_named_opcodes | |
144 | * | |
145 | * PARAMETERS: walk_state - Current state of the parse tree walk | |
146 | * out_op - Unused, required for parser interface | |
147 | * | |
148 | * RETURN: Status | |
149 | * | |
150 | * DESCRIPTION: Descending callback used during the loading of ACPI tables. | |
151 | * Currently used to detect methods that must be marked serialized | |
152 | * in order to avoid problems with the creation of named objects. | |
153 | * | |
154 | ******************************************************************************/ | |
155 | ||
156 | static acpi_status | |
157 | acpi_ds_detect_named_opcodes(struct acpi_walk_state *walk_state, | |
158 | union acpi_parse_object **out_op) | |
159 | { | |
160 | ||
161 | ACPI_FUNCTION_NAME(acpi_ds_detect_named_opcodes); | |
162 | ||
21bd7e61 | 163 | /* We are only interested in opcodes that create a new name */ |
22b5afce | 164 | |
21bd7e61 LZ |
165 | if (! |
166 | (walk_state->op_info-> | |
167 | flags & (AML_NAMED | AML_CREATE | AML_FIELD))) { | |
22b5afce BM |
168 | return (AE_OK); |
169 | } | |
170 | ||
171 | /* | |
172 | * At this point, we know we have a Named object opcode. | |
173 | * Mark the method as serialized. Later code will create a mutex for | |
174 | * this method to enforce serialization. | |
d1825579 BM |
175 | * |
176 | * Note, ACPI_METHOD_IGNORE_SYNC_LEVEL flag means that we will ignore the | |
177 | * Sync Level mechanism for this method, even though it is now serialized. | |
178 | * Otherwise, there can be conflicts with existing ASL code that actually | |
179 | * uses sync levels. | |
22b5afce | 180 | */ |
d1825579 BM |
181 | walk_state->method_desc->method.sync_level = 0; |
182 | walk_state->method_desc->method.info_flags |= | |
183 | (ACPI_METHOD_SERIALIZED | ACPI_METHOD_IGNORE_SYNC_LEVEL); | |
22b5afce BM |
184 | |
185 | ACPI_DEBUG_PRINT((ACPI_DB_INFO, | |
186 | "Method serialized [%4.4s] %p - [%s] (%4.4X)\n", | |
187 | walk_state->method_node->name.ascii, | |
188 | walk_state->method_node, walk_state->op_info->name, | |
189 | walk_state->opcode)); | |
190 | ||
191 | /* Abort the parse, no need to examine this method any further */ | |
192 | ||
193 | return (AE_CTRL_TERMINATE); | |
194 | } | |
195 | ||
defba1d8 BM |
196 | /******************************************************************************* |
197 | * | |
198 | * FUNCTION: acpi_ds_method_error | |
199 | * | |
ba494bee | 200 | * PARAMETERS: status - Execution status |
defba1d8 BM |
201 | * walk_state - Current state |
202 | * | |
203 | * RETURN: Status | |
204 | * | |
205 | * DESCRIPTION: Called on method error. Invoke the global exception handler if | |
fdd8d831 | 206 | * present, dump the method data if the debugger is configured |
defba1d8 BM |
207 | * |
208 | * Note: Allows the exception handler to change the status code | |
209 | * | |
210 | ******************************************************************************/ | |
967440e3 | 211 | |
defba1d8 | 212 | acpi_status |
22b5afce | 213 | acpi_ds_method_error(acpi_status status, struct acpi_walk_state * walk_state) |
defba1d8 | 214 | { |
83482f75 LZ |
215 | u32 aml_offset; |
216 | ||
defba1d8 BM |
217 | ACPI_FUNCTION_ENTRY(); |
218 | ||
219 | /* Ignore AE_OK and control exception codes */ | |
220 | ||
221 | if (ACPI_SUCCESS(status) || (status & AE_CODE_CONTROL)) { | |
222 | return (status); | |
223 | } | |
224 | ||
225 | /* Invoke the global exception handler */ | |
226 | ||
227 | if (acpi_gbl_exception_handler) { | |
52fc0b02 | 228 | |
defba1d8 BM |
229 | /* Exit the interpreter, allow handler to execute methods */ |
230 | ||
231 | acpi_ex_exit_interpreter(); | |
232 | ||
233 | /* | |
234 | * Handler can map the exception code to anything it wants, including | |
235 | * AE_OK, in which case the executing method will not be aborted. | |
236 | */ | |
83482f75 LZ |
237 | aml_offset = (u32)ACPI_PTR_DIFF(walk_state->aml, |
238 | walk_state->parser_state. | |
239 | aml_start); | |
240 | ||
defba1d8 BM |
241 | status = acpi_gbl_exception_handler(status, |
242 | walk_state->method_node ? | |
243 | walk_state->method_node-> | |
244 | name.integer : 0, | |
245 | walk_state->opcode, | |
83482f75 | 246 | aml_offset, NULL); |
b7f9f042 | 247 | acpi_ex_enter_interpreter(); |
defba1d8 | 248 | } |
d8a0ec91 LM |
249 | |
250 | acpi_ds_clear_implicit_return(walk_state); | |
251 | ||
defba1d8 | 252 | if (ACPI_FAILURE(status)) { |
0bac4295 | 253 | acpi_ds_dump_method_stack(status, walk_state, walk_state->op); |
52fc0b02 | 254 | |
fdd8d831 | 255 | /* Display method locals/args if debugger is present */ |
defba1d8 | 256 | |
fdd8d831 LZ |
257 | #ifdef ACPI_DEBUGGER |
258 | acpi_db_dump_method_info(status, walk_state); | |
defba1d8 | 259 | #endif |
0bac4295 | 260 | } |
defba1d8 BM |
261 | |
262 | return (status); | |
263 | } | |
264 | ||
967440e3 BM |
265 | /******************************************************************************* |
266 | * | |
267 | * FUNCTION: acpi_ds_create_method_mutex | |
268 | * | |
269 | * PARAMETERS: obj_desc - The method object | |
270 | * | |
271 | * RETURN: Status | |
272 | * | |
273 | * DESCRIPTION: Create a mutex object for a serialized control method | |
274 | * | |
275 | ******************************************************************************/ | |
276 | ||
277 | static acpi_status | |
278 | acpi_ds_create_method_mutex(union acpi_operand_object *method_desc) | |
279 | { | |
280 | union acpi_operand_object *mutex_desc; | |
281 | acpi_status status; | |
282 | ||
f6dd9221 | 283 | ACPI_FUNCTION_TRACE(ds_create_method_mutex); |
967440e3 BM |
284 | |
285 | /* Create the new mutex object */ | |
286 | ||
287 | mutex_desc = acpi_ut_create_internal_object(ACPI_TYPE_MUTEX); | |
288 | if (!mutex_desc) { | |
289 | return_ACPI_STATUS(AE_NO_MEMORY); | |
290 | } | |
291 | ||
292 | /* Create the actual OS Mutex */ | |
293 | ||
294 | status = acpi_os_create_mutex(&mutex_desc->mutex.os_mutex); | |
295 | if (ACPI_FAILURE(status)) { | |
78d025e2 | 296 | acpi_ut_delete_object_desc(mutex_desc); |
967440e3 BM |
297 | return_ACPI_STATUS(status); |
298 | } | |
299 | ||
300 | mutex_desc->mutex.sync_level = method_desc->method.sync_level; | |
301 | method_desc->method.mutex = mutex_desc; | |
302 | return_ACPI_STATUS(AE_OK); | |
303 | } | |
304 | ||
1da177e4 LT |
305 | /******************************************************************************* |
306 | * | |
307 | * FUNCTION: acpi_ds_begin_method_execution | |
308 | * | |
309 | * PARAMETERS: method_node - Node of the method | |
310 | * obj_desc - The method object | |
967440e3 BM |
311 | * walk_state - current state, NULL if not yet executing |
312 | * a method. | |
1da177e4 LT |
313 | * |
314 | * RETURN: Status | |
315 | * | |
73a3090a | 316 | * DESCRIPTION: Prepare a method for execution. Parses the method if necessary, |
1da177e4 LT |
317 | * increments the thread count, and waits at the method semaphore |
318 | * for clearance to execute. | |
319 | * | |
320 | ******************************************************************************/ | |
defba1d8 | 321 | |
1da177e4 | 322 | acpi_status |
967440e3 BM |
323 | acpi_ds_begin_method_execution(struct acpi_namespace_node *method_node, |
324 | union acpi_operand_object *obj_desc, | |
325 | struct acpi_walk_state *walk_state) | |
1da177e4 | 326 | { |
4be44fcd | 327 | acpi_status status = AE_OK; |
1da177e4 | 328 | |
b229cf92 | 329 | ACPI_FUNCTION_TRACE_PTR(ds_begin_method_execution, method_node); |
1da177e4 LT |
330 | |
331 | if (!method_node) { | |
4be44fcd | 332 | return_ACPI_STATUS(AE_NULL_ENTRY); |
1da177e4 LT |
333 | } |
334 | ||
ab6c5733 | 335 | acpi_ex_start_trace_method(method_node, obj_desc, walk_state); |
a616dc2f | 336 | |
aff8c277 RM |
337 | /* Prevent wraparound of thread count */ |
338 | ||
339 | if (obj_desc->method.thread_count == ACPI_UINT8_MAX) { | |
b8e4d893 BM |
340 | ACPI_ERROR((AE_INFO, |
341 | "Method reached maximum reentrancy limit (255)")); | |
aff8c277 RM |
342 | return_ACPI_STATUS(AE_AML_METHOD_LIMIT); |
343 | } | |
344 | ||
1da177e4 | 345 | /* |
967440e3 | 346 | * If this method is serialized, we need to acquire the method mutex. |
1da177e4 | 347 | */ |
26294842 | 348 | if (obj_desc->method.info_flags & ACPI_METHOD_SERIALIZED) { |
1da177e4 | 349 | /* |
967440e3 BM |
350 | * Create a mutex for the method if it is defined to be Serialized |
351 | * and a mutex has not already been created. We defer the mutex creation | |
352 | * until a method is actually executed, to minimize the object count | |
1da177e4 | 353 | */ |
967440e3 BM |
354 | if (!obj_desc->method.mutex) { |
355 | status = acpi_ds_create_method_mutex(obj_desc); | |
356 | if (ACPI_FAILURE(status)) { | |
357 | return_ACPI_STATUS(status); | |
1da177e4 LT |
358 | } |
359 | } | |
360 | ||
361 | /* | |
967440e3 BM |
362 | * The current_sync_level (per-thread) must be less than or equal to |
363 | * the sync level of the method. This mechanism provides some | |
d1825579 BM |
364 | * deadlock prevention. |
365 | * | |
366 | * If the method was auto-serialized, we just ignore the sync level | |
367 | * mechanism, because auto-serialization of methods can interfere | |
368 | * with ASL code that actually uses sync levels. | |
967440e3 BM |
369 | * |
370 | * Top-level method invocation has no walk state at this point | |
1da177e4 | 371 | */ |
967440e3 | 372 | if (walk_state && |
d1825579 BM |
373 | (!(obj_desc->method. |
374 | info_flags & ACPI_METHOD_IGNORE_SYNC_LEVEL)) | |
375 | && (walk_state->thread->current_sync_level > | |
376 | obj_desc->method.mutex->mutex.sync_level)) { | |
967440e3 | 377 | ACPI_ERROR((AE_INFO, |
f6a22b0b | 378 | "Cannot acquire Mutex for method [%4.4s], current SyncLevel is too large (%u)", |
967440e3 BM |
379 | acpi_ut_get_node_name(method_node), |
380 | walk_state->thread->current_sync_level)); | |
381 | ||
382 | return_ACPI_STATUS(AE_AML_MUTEX_ORDER); | |
b229cf92 | 383 | } |
967440e3 BM |
384 | |
385 | /* | |
386 | * Obtain the method mutex if necessary. Do not acquire mutex for a | |
387 | * recursive call. | |
388 | */ | |
262a7a28 | 389 | if (!walk_state || |
ba886cd4 BM |
390 | !obj_desc->method.mutex->mutex.thread_id || |
391 | (walk_state->thread->thread_id != | |
392 | obj_desc->method.mutex->mutex.thread_id)) { | |
967440e3 BM |
393 | /* |
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 | ||
ba886cd4 BM |
412 | obj_desc->method.mutex->mutex.thread_id = |
413 | walk_state->thread->thread_id; | |
33d3a2ab DB |
414 | |
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 | } | |
967440e3 BM |
427 | } 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++; | |
1da177e4 LT |
437 | } |
438 | ||
aff8c277 RM |
439 | /* |
440 | * 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)) { | |
b229cf92 | 447 | goto cleanup; |
aff8c277 RM |
448 | } |
449 | } | |
450 | ||
1da177e4 LT |
451 | /* |
452 | * 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++; | |
9187a415 | 456 | acpi_method_count++; |
4be44fcd | 457 | return_ACPI_STATUS(status); |
b229cf92 | 458 | |
10622bf8 | 459 | cleanup: |
967440e3 | 460 | /* On error, must release the method mutex (if present) */ |
b229cf92 | 461 | |
967440e3 BM |
462 | if (obj_desc->method.mutex) { |
463 | acpi_os_release_mutex(obj_desc->method.mutex->mutex.os_mutex); | |
b229cf92 BM |
464 | } |
465 | return_ACPI_STATUS(status); | |
1da177e4 LT |
466 | } |
467 | ||
1da177e4 LT |
468 | /******************************************************************************* |
469 | * | |
470 | * FUNCTION: acpi_ds_call_control_method | |
471 | * | |
ba494bee | 472 | * PARAMETERS: thread - Info for this thread |
1da177e4 | 473 | * this_walk_state - Current walk state |
ba494bee | 474 | * op - Current Op to be walked |
1da177e4 LT |
475 | * |
476 | * RETURN: Status | |
477 | * | |
478 | * DESCRIPTION: Transfer execution to a called control method | |
479 | * | |
480 | ******************************************************************************/ | |
481 | ||
482 | acpi_status | |
4be44fcd LB |
483 | acpi_ds_call_control_method(struct acpi_thread_state *thread, |
484 | struct acpi_walk_state *this_walk_state, | |
485 | union acpi_parse_object *op) | |
1da177e4 | 486 | { |
4be44fcd LB |
487 | 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; | |
4119532c | 491 | struct acpi_evaluate_info *info; |
4be44fcd | 492 | u32 i; |
1da177e4 | 493 | |
b229cf92 | 494 | ACPI_FUNCTION_TRACE_PTR(ds_call_control_method, this_walk_state); |
1da177e4 | 495 | |
4be44fcd | 496 | ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH, |
9bc75cff | 497 | "Calling method %p, currentstate=%p\n", |
4be44fcd | 498 | this_walk_state->prev_op, this_walk_state)); |
1da177e4 LT |
499 | |
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) { | |
4be44fcd | 505 | return_ACPI_STATUS(AE_NULL_ENTRY); |
1da177e4 LT |
506 | } |
507 | ||
4be44fcd | 508 | obj_desc = acpi_ns_get_attached_object(method_node); |
1da177e4 | 509 | if (!obj_desc) { |
4be44fcd | 510 | return_ACPI_STATUS(AE_NULL_OBJECT); |
1da177e4 LT |
511 | } |
512 | ||
967440e3 | 513 | /* Init for new method, possibly wait on method mutex */ |
1da177e4 | 514 | |
4be44fcd | 515 | status = acpi_ds_begin_method_execution(method_node, obj_desc, |
967440e3 | 516 | this_walk_state); |
4be44fcd | 517 | if (ACPI_FAILURE(status)) { |
b229cf92 | 518 | return_ACPI_STATUS(status); |
1da177e4 LT |
519 | } |
520 | ||
9bc75cff | 521 | /* Begin method parse/execution. Create a new walk state */ |
1da177e4 | 522 | |
4be44fcd LB |
523 | next_walk_state = acpi_ds_create_walk_state(obj_desc->method.owner_id, |
524 | NULL, obj_desc, thread); | |
1da177e4 LT |
525 | if (!next_walk_state) { |
526 | status = AE_NO_MEMORY; | |
527 | goto cleanup; | |
528 | } | |
b229cf92 | 529 | |
1da177e4 LT |
530 | /* |
531 | * The resolved arguments were put on the previous walk state's operand | |
aff8c277 RM |
532 | * stack. Operands on the previous walk state stack always |
533 | * start at index 0. Also, null terminate the list of arguments | |
1da177e4 | 534 | */ |
4be44fcd | 535 | this_walk_state->operands[this_walk_state->num_operands] = NULL; |
1da177e4 | 536 | |
4119532c BM |
537 | /* |
538 | * Allocate and initialize the evaluation information block | |
539 | * TBD: this is somewhat inefficient, should change interface to | |
540 | * ds_init_aml_walk. For now, keeps this struct off the CPU stack | |
541 | */ | |
542 | info = ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_evaluate_info)); | |
543 | if (!info) { | |
22715821 JJ |
544 | status = AE_NO_MEMORY; |
545 | goto cleanup; | |
4119532c BM |
546 | } |
547 | ||
548 | info->parameters = &this_walk_state->operands[0]; | |
1da177e4 | 549 | |
4be44fcd LB |
550 | status = acpi_ds_init_aml_walk(next_walk_state, NULL, method_node, |
551 | obj_desc->method.aml_start, | |
ec3153fb BM |
552 | obj_desc->method.aml_length, info, |
553 | ACPI_IMODE_EXECUTE); | |
4119532c BM |
554 | |
555 | ACPI_FREE(info); | |
4be44fcd | 556 | if (ACPI_FAILURE(status)) { |
1da177e4 LT |
557 | goto cleanup; |
558 | } | |
559 | ||
560 | /* | |
561 | * Delete the operands on the previous walkstate operand stack | |
562 | * (they were copied to new objects) | |
563 | */ | |
564 | for (i = 0; i < obj_desc->method.param_count; i++) { | |
4be44fcd LB |
565 | acpi_ut_remove_reference(this_walk_state->operands[i]); |
566 | this_walk_state->operands[i] = NULL; | |
1da177e4 LT |
567 | } |
568 | ||
569 | /* Clear the operand stack */ | |
570 | ||
571 | this_walk_state->num_operands = 0; | |
572 | ||
4be44fcd | 573 | ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH, |
9bc75cff VP |
574 | "**** Begin nested execution of [%4.4s] **** WalkState=%p\n", |
575 | method_node->name.ascii, next_walk_state)); | |
1da177e4 | 576 | |
b229cf92 BM |
577 | /* Invoke an internal method if necessary */ |
578 | ||
26294842 LM |
579 | if (obj_desc->method.info_flags & ACPI_METHOD_INTERNAL_ONLY) { |
580 | status = | |
581 | obj_desc->method.dispatch.implementation(next_walk_state); | |
a8fadc92 BM |
582 | if (status == AE_OK) { |
583 | status = AE_CTRL_TERMINATE; | |
584 | } | |
1da177e4 LT |
585 | } |
586 | ||
aff8c277 | 587 | return_ACPI_STATUS(status); |
a94f1881 | 588 | |
10622bf8 | 589 | cleanup: |
a94f1881 | 590 | |
b229cf92 | 591 | /* On error, we must terminate the method properly */ |
aff8c277 | 592 | |
b229cf92 | 593 | acpi_ds_terminate_control_method(obj_desc, next_walk_state); |
dc67d0fa | 594 | acpi_ds_delete_walk_state(next_walk_state); |
aff8c277 | 595 | |
4be44fcd | 596 | return_ACPI_STATUS(status); |
1da177e4 LT |
597 | } |
598 | ||
1da177e4 LT |
599 | /******************************************************************************* |
600 | * | |
601 | * FUNCTION: acpi_ds_restart_control_method | |
602 | * | |
603 | * PARAMETERS: walk_state - State for preempted method (caller) | |
604 | * return_desc - Return value from the called method | |
605 | * | |
606 | * RETURN: Status | |
607 | * | |
608 | * DESCRIPTION: Restart a method that was preempted by another (nested) method | |
73a3090a | 609 | * invocation. Handle the return value (if any) from the callee. |
1da177e4 LT |
610 | * |
611 | ******************************************************************************/ | |
612 | ||
613 | acpi_status | |
4be44fcd LB |
614 | acpi_ds_restart_control_method(struct acpi_walk_state *walk_state, |
615 | union acpi_operand_object *return_desc) | |
1da177e4 | 616 | { |
4be44fcd | 617 | acpi_status status; |
958dd242 | 618 | int same_as_implicit_return; |
1da177e4 | 619 | |
b229cf92 | 620 | ACPI_FUNCTION_TRACE_PTR(ds_restart_control_method, walk_state); |
1da177e4 | 621 | |
4be44fcd | 622 | ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH, |
b229cf92 | 623 | "****Restart [%4.4s] Op %p ReturnValueFromCallee %p\n", |
f6dd9221 | 624 | acpi_ut_get_node_name(walk_state->method_node), |
4be44fcd | 625 | walk_state->method_call_op, return_desc)); |
1da177e4 | 626 | |
4be44fcd | 627 | ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH, |
b229cf92 | 628 | " ReturnFromThisMethodUsed?=%X ResStack %p Walk %p\n", |
4be44fcd LB |
629 | walk_state->return_used, |
630 | walk_state->results, walk_state)); | |
1da177e4 LT |
631 | |
632 | /* Did the called method return a value? */ | |
633 | ||
634 | if (return_desc) { | |
52fc0b02 | 635 | |
958dd242 BM |
636 | /* Is the implicit return object the same as the return desc? */ |
637 | ||
638 | same_as_implicit_return = | |
639 | (walk_state->implicit_return_obj == return_desc); | |
640 | ||
1da177e4 LT |
641 | /* Are we actually going to use the return value? */ |
642 | ||
643 | if (walk_state->return_used) { | |
52fc0b02 | 644 | |
1da177e4 LT |
645 | /* Save the return value from the previous method */ |
646 | ||
4be44fcd LB |
647 | status = acpi_ds_result_push(return_desc, walk_state); |
648 | if (ACPI_FAILURE(status)) { | |
649 | acpi_ut_remove_reference(return_desc); | |
650 | return_ACPI_STATUS(status); | |
1da177e4 LT |
651 | } |
652 | ||
653 | /* | |
654 | * Save as THIS method's return value in case it is returned | |
655 | * immediately to yet another method | |
656 | */ | |
657 | walk_state->return_desc = return_desc; | |
658 | } | |
659 | ||
660 | /* | |
958dd242 BM |
661 | * The following code is the optional support for the so-called |
662 | * "implicit return". Some AML code assumes that the last value of the | |
663 | * method is "implicitly" returned to the caller, in the absence of an | |
664 | * explicit return value. | |
665 | * | |
666 | * Just save the last result of the method as the return value. | |
667 | * | |
1da177e4 LT |
668 | * NOTE: this is optional because the ASL language does not actually |
669 | * support this behavior. | |
670 | */ | |
4be44fcd | 671 | else if (!acpi_ds_do_implicit_return |
958dd242 BM |
672 | (return_desc, walk_state, FALSE) |
673 | || same_as_implicit_return) { | |
1da177e4 LT |
674 | /* |
675 | * Delete the return value if it will not be used by the | |
958dd242 BM |
676 | * calling method or remove one reference if the explicit return |
677 | * is the same as the implicit return value. | |
1da177e4 | 678 | */ |
4be44fcd | 679 | acpi_ut_remove_reference(return_desc); |
1da177e4 LT |
680 | } |
681 | } | |
682 | ||
4be44fcd | 683 | return_ACPI_STATUS(AE_OK); |
1da177e4 LT |
684 | } |
685 | ||
1da177e4 LT |
686 | /******************************************************************************* |
687 | * | |
688 | * FUNCTION: acpi_ds_terminate_control_method | |
689 | * | |
b229cf92 BM |
690 | * PARAMETERS: method_desc - Method object |
691 | * walk_state - State associated with the method | |
1da177e4 | 692 | * |
aff8c277 | 693 | * RETURN: None |
1da177e4 | 694 | * |
73a3090a | 695 | * DESCRIPTION: Terminate a control method. Delete everything that the method |
1da177e4 LT |
696 | * created, delete all locals and arguments, and delete the parse |
697 | * tree if requested. | |
698 | * | |
967440e3 BM |
699 | * MUTEX: Interpreter is locked |
700 | * | |
1da177e4 LT |
701 | ******************************************************************************/ |
702 | ||
b229cf92 BM |
703 | void |
704 | acpi_ds_terminate_control_method(union acpi_operand_object *method_desc, | |
705 | struct acpi_walk_state *walk_state) | |
1da177e4 | 706 | { |
1da177e4 | 707 | |
b229cf92 | 708 | ACPI_FUNCTION_TRACE_PTR(ds_terminate_control_method, walk_state); |
1da177e4 | 709 | |
b229cf92 | 710 | /* method_desc is required, walk_state is optional */ |
1da177e4 | 711 | |
b229cf92 | 712 | if (!method_desc) { |
aff8c277 | 713 | return_VOID; |
1da177e4 LT |
714 | } |
715 | ||
b229cf92 | 716 | if (walk_state) { |
1da177e4 | 717 | |
b229cf92 BM |
718 | /* Delete all arguments and locals */ |
719 | ||
720 | acpi_ds_method_data_delete_all(walk_state); | |
1da177e4 | 721 | |
b7f9f042 BM |
722 | /* |
723 | * If method is serialized, release the mutex and restore the | |
724 | * current sync level for this thread | |
725 | */ | |
726 | if (method_desc->method.mutex) { | |
1da177e4 | 727 | |
b7f9f042 | 728 | /* Acquisition Depth handles recursive calls */ |
1da177e4 | 729 | |
b7f9f042 BM |
730 | method_desc->method.mutex->mutex.acquisition_depth--; |
731 | if (!method_desc->method.mutex->mutex.acquisition_depth) { | |
732 | walk_state->thread->current_sync_level = | |
733 | method_desc->method.mutex->mutex. | |
734 | original_sync_level; | |
b229cf92 | 735 | |
b7f9f042 BM |
736 | acpi_os_release_mutex(method_desc->method. |
737 | mutex->mutex.os_mutex); | |
28eb3fcf | 738 | method_desc->method.mutex->mutex.thread_id = 0; |
b7f9f042 | 739 | } |
1da177e4 | 740 | } |
1da177e4 | 741 | |
b229cf92 | 742 | /* |
7f0c826a | 743 | * Delete any namespace objects created anywhere within the |
26294842 LM |
744 | * namespace by the execution of this method. Unless: |
745 | * 1) This method is a module-level executable code method, in which | |
746 | * case we want make the objects permanent. | |
747 | * 2) There are other threads executing the method, in which case we | |
748 | * will wait until the last thread has completed. | |
b229cf92 | 749 | */ |
26294842 LM |
750 | if (!(method_desc->method.info_flags & ACPI_METHOD_MODULE_LEVEL) |
751 | && (method_desc->method.thread_count == 1)) { | |
a9fc0312 AS |
752 | |
753 | /* Delete any direct children of (created by) this method */ | |
754 | ||
755 | acpi_ns_delete_namespace_subtree(walk_state-> | |
756 | method_node); | |
757 | ||
758 | /* | |
759 | * Delete any objects that were created by this method | |
760 | * elsewhere in the namespace (if any were created). | |
26294842 LM |
761 | * Use of the ACPI_METHOD_MODIFIED_NAMESPACE optimizes the |
762 | * deletion such that we don't have to perform an entire | |
763 | * namespace walk for every control method execution. | |
a9fc0312 AS |
764 | */ |
765 | if (method_desc->method. | |
26294842 | 766 | info_flags & ACPI_METHOD_MODIFIED_NAMESPACE) { |
a9fc0312 AS |
767 | acpi_ns_delete_namespace_by_owner(method_desc-> |
768 | method. | |
769 | owner_id); | |
26294842 LM |
770 | method_desc->method.info_flags &= |
771 | ~ACPI_METHOD_MODIFIED_NAMESPACE; | |
a9fc0312 | 772 | } |
7f0c826a | 773 | } |
28f55ebc BM |
774 | } |
775 | ||
b229cf92 BM |
776 | /* Decrement the thread count on the method */ |
777 | ||
778 | if (method_desc->method.thread_count) { | |
779 | method_desc->method.thread_count--; | |
780 | } else { | |
781 | ACPI_ERROR((AE_INFO, "Invalid zero thread count in method")); | |
782 | } | |
28f55ebc BM |
783 | |
784 | /* Are there any other threads currently executing this method? */ | |
785 | ||
b229cf92 | 786 | if (method_desc->method.thread_count) { |
28f55ebc BM |
787 | /* |
788 | * Additional threads. Do not release the owner_id in this case, | |
789 | * we immediately reuse it for the next thread executing this method | |
790 | */ | |
4be44fcd | 791 | ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH, |
b27d6597 | 792 | "*** Completed execution of one thread, %u threads remaining\n", |
b229cf92 | 793 | method_desc->method.thread_count)); |
28f55ebc BM |
794 | } else { |
795 | /* This is the only executing thread for this method */ | |
1da177e4 | 796 | |
1da177e4 LT |
797 | /* |
798 | * Support to dynamically change a method from not_serialized to | |
28f55ebc | 799 | * Serialized if it appears that the method is incorrectly written and |
967440e3 BM |
800 | * does not support multiple thread execution. The best example of this |
801 | * is if such a method creates namespace objects and blocks. A second | |
26294842 | 802 | * thread will fail with an AE_ALREADY_EXISTS exception. |
1da177e4 LT |
803 | * |
804 | * This code is here because we must wait until the last thread exits | |
26294842 | 805 | * before marking the method as serialized. |
1da177e4 | 806 | */ |
26294842 LM |
807 | if (method_desc->method. |
808 | info_flags & ACPI_METHOD_SERIALIZED_PENDING) { | |
809 | if (walk_state) { | |
810 | ACPI_INFO((AE_INFO, | |
811 | "Marking method %4.4s as Serialized because of AE_ALREADY_EXISTS error", | |
812 | walk_state->method_node->name. | |
813 | ascii)); | |
814 | } | |
815 | ||
816 | /* | |
817 | * Method tried to create an object twice and was marked as | |
818 | * "pending serialized". The probable cause is that the method | |
819 | * cannot handle reentrancy. | |
820 | * | |
821 | * The method was created as not_serialized, but it tried to create | |
822 | * a named object and then blocked, causing the second thread | |
823 | * entrance to begin and then fail. Workaround this problem by | |
824 | * marking the method permanently as Serialized when the last | |
825 | * thread exits here. | |
826 | */ | |
827 | method_desc->method.info_flags &= | |
828 | ~ACPI_METHOD_SERIALIZED_PENDING; | |
829 | method_desc->method.info_flags |= | |
d1825579 BM |
830 | (ACPI_METHOD_SERIALIZED | |
831 | ACPI_METHOD_IGNORE_SYNC_LEVEL); | |
26294842 | 832 | method_desc->method.sync_level = 0; |
1da177e4 LT |
833 | } |
834 | ||
28f55ebc | 835 | /* No more threads, we can free the owner_id */ |
1da177e4 | 836 | |
26294842 LM |
837 | if (! |
838 | (method_desc->method. | |
839 | info_flags & ACPI_METHOD_MODULE_LEVEL)) { | |
7f0c826a LM |
840 | acpi_ut_release_owner_id(&method_desc->method.owner_id); |
841 | } | |
1da177e4 | 842 | } |
a94f1881 | 843 | |
ab6c5733 LZ |
844 | acpi_ex_stop_trace_method((struct acpi_namespace_node *)method_desc-> |
845 | method.node, method_desc, walk_state); | |
a616dc2f | 846 | |
aff8c277 | 847 | return_VOID; |
1da177e4 | 848 | } |