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