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