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