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