1 /******************************************************************************
3 * Module Name: dswexec - Dispatcher method execution callbacks;
4 * dispatch to interpreter.
6 *****************************************************************************/
9 * Copyright (C) 2000 - 2005, R. Byron Moore
10 * All rights reserved.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions, and the following disclaimer,
17 * without modification.
18 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
19 * substantially similar to the "NO WARRANTY" disclaimer below
20 * ("Disclaimer") and any redistribution must be conditioned upon
21 * including a substantially similar Disclaimer requirement for further
22 * binary redistribution.
23 * 3. Neither the names of the above-listed copyright holders nor the names
24 * of any contributors may be used to endorse or promote products derived
25 * from this software without specific prior written permission.
27 * Alternatively, this software may be distributed under the terms of the
28 * GNU General Public License ("GPL") version 2 as published by the Free
29 * Software Foundation.
32 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
33 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
34 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
35 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
36 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
37 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
38 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
39 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
40 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
41 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
42 * POSSIBILITY OF SUCH DAMAGES.
45 #include <acpi/acpi.h>
46 #include <acpi/acparser.h>
47 #include <acpi/amlcode.h>
48 #include <acpi/acdispat.h>
49 #include <acpi/acinterp.h>
50 #include <acpi/acnamesp.h>
51 #include <acpi/acdebug.h>
52 #include <acpi/acdisasm.h>
54 #define _COMPONENT ACPI_DISPATCHER
55 ACPI_MODULE_NAME("dswexec")
58 * Dispatch table for opcode classes
60 static ACPI_EXECUTE_OP acpi_gbl_op_type_dispatch
[] = {
61 acpi_ex_opcode_0A_0T_1R
,
62 acpi_ex_opcode_1A_0T_0R
,
63 acpi_ex_opcode_1A_0T_1R
,
64 acpi_ex_opcode_1A_1T_0R
,
65 acpi_ex_opcode_1A_1T_1R
,
66 acpi_ex_opcode_2A_0T_0R
,
67 acpi_ex_opcode_2A_0T_1R
,
68 acpi_ex_opcode_2A_1T_1R
,
69 acpi_ex_opcode_2A_2T_1R
,
70 acpi_ex_opcode_3A_0T_0R
,
71 acpi_ex_opcode_3A_1T_1R
,
72 acpi_ex_opcode_6A_0T_1R
75 /*****************************************************************************
77 * FUNCTION: acpi_ds_get_predicate_value
79 * PARAMETERS: walk_state - Current state of the parse tree walk
80 * result_obj - if non-zero, pop result from result stack
84 * DESCRIPTION: Get the result of a predicate evaluation
86 ****************************************************************************/
89 acpi_ds_get_predicate_value(struct acpi_walk_state
*walk_state
,
90 union acpi_operand_object
*result_obj
)
92 acpi_status status
= AE_OK
;
93 union acpi_operand_object
*obj_desc
;
94 union acpi_operand_object
*local_obj_desc
= NULL
;
96 ACPI_FUNCTION_TRACE_PTR("ds_get_predicate_value", walk_state
);
98 walk_state
->control_state
->common
.state
= 0;
101 status
= acpi_ds_result_pop(&obj_desc
, walk_state
);
102 if (ACPI_FAILURE(status
)) {
103 ACPI_DEBUG_PRINT((ACPI_DB_ERROR
,
104 "Could not get result from predicate evaluation, %s\n",
105 acpi_format_exception(status
)));
107 return_ACPI_STATUS(status
);
110 status
= acpi_ds_create_operand(walk_state
, walk_state
->op
, 0);
111 if (ACPI_FAILURE(status
)) {
112 return_ACPI_STATUS(status
);
116 acpi_ex_resolve_to_value(&walk_state
->operands
[0],
118 if (ACPI_FAILURE(status
)) {
119 return_ACPI_STATUS(status
);
122 obj_desc
= walk_state
->operands
[0];
126 ACPI_DEBUG_PRINT((ACPI_DB_ERROR
,
127 "No predicate obj_desc=%p State=%p\n",
128 obj_desc
, walk_state
));
130 return_ACPI_STATUS(AE_AML_NO_OPERAND
);
134 * Result of predicate evaluation must be an Integer
135 * object. Implicitly convert the argument if necessary.
137 status
= acpi_ex_convert_to_integer(obj_desc
, &local_obj_desc
, 16);
138 if (ACPI_FAILURE(status
)) {
142 if (ACPI_GET_OBJECT_TYPE(local_obj_desc
) != ACPI_TYPE_INTEGER
) {
143 ACPI_DEBUG_PRINT((ACPI_DB_ERROR
,
144 "Bad predicate (not an integer) obj_desc=%p State=%p Type=%X\n",
145 obj_desc
, walk_state
,
146 ACPI_GET_OBJECT_TYPE(obj_desc
)));
148 status
= AE_AML_OPERAND_TYPE
;
152 /* Truncate the predicate to 32-bits if necessary */
154 acpi_ex_truncate_for32bit_table(local_obj_desc
);
157 * Save the result of the predicate evaluation on
160 if (local_obj_desc
->integer
.value
) {
161 walk_state
->control_state
->common
.value
= TRUE
;
164 * Predicate is FALSE, we will just toss the
165 * rest of the package
167 walk_state
->control_state
->common
.value
= FALSE
;
168 status
= AE_CTRL_FALSE
;
173 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
, "Completed a predicate eval=%X Op=%p\n",
174 walk_state
->control_state
->common
.value
,
177 /* Break to debugger to display result */
179 ACPI_DEBUGGER_EXEC(acpi_db_display_result_object
180 (local_obj_desc
, walk_state
));
183 * Delete the predicate result object (we know that
184 * we don't need it anymore)
186 if (local_obj_desc
!= obj_desc
) {
187 acpi_ut_remove_reference(local_obj_desc
);
189 acpi_ut_remove_reference(obj_desc
);
191 walk_state
->control_state
->common
.state
= ACPI_CONTROL_NORMAL
;
192 return_ACPI_STATUS(status
);
195 /*****************************************************************************
197 * FUNCTION: acpi_ds_exec_begin_op
199 * PARAMETERS: walk_state - Current state of the parse tree walk
200 * out_op - Where to return op if a new one is created
204 * DESCRIPTION: Descending callback used during the execution of control
205 * methods. This is where most operators and operands are
206 * dispatched to the interpreter.
208 ****************************************************************************/
211 acpi_ds_exec_begin_op(struct acpi_walk_state
*walk_state
,
212 union acpi_parse_object
**out_op
)
214 union acpi_parse_object
*op
;
215 acpi_status status
= AE_OK
;
218 ACPI_FUNCTION_TRACE_PTR("ds_exec_begin_op", walk_state
);
222 status
= acpi_ds_load2_begin_op(walk_state
, out_op
);
223 if (ACPI_FAILURE(status
)) {
224 return_ACPI_STATUS(status
);
229 walk_state
->opcode
= op
->common
.aml_opcode
;
230 walk_state
->op_info
=
231 acpi_ps_get_opcode_info(op
->common
.aml_opcode
);
233 if (acpi_ns_opens_scope(walk_state
->op_info
->object_type
)) {
234 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH
,
235 "(%s) Popping scope for Op %p\n",
236 acpi_ut_get_type_name(walk_state
->
241 status
= acpi_ds_scope_stack_pop(walk_state
);
242 if (ACPI_FAILURE(status
)) {
243 return_ACPI_STATUS(status
);
248 if (op
== walk_state
->origin
) {
253 return_ACPI_STATUS(AE_OK
);
257 * If the previous opcode was a conditional, this opcode
258 * must be the beginning of the associated predicate.
259 * Save this knowledge in the current scope descriptor
261 if ((walk_state
->control_state
) &&
262 (walk_state
->control_state
->common
.state
==
263 ACPI_CONTROL_CONDITIONAL_EXECUTING
)) {
264 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
,
265 "Exec predicate Op=%p State=%p\n", op
,
268 walk_state
->control_state
->common
.state
=
269 ACPI_CONTROL_PREDICATE_EXECUTING
;
271 /* Save start of predicate */
273 walk_state
->control_state
->control
.predicate_op
= op
;
276 opcode_class
= walk_state
->op_info
->class;
278 /* We want to send namepaths to the load code */
280 if (op
->common
.aml_opcode
== AML_INT_NAMEPATH_OP
) {
281 opcode_class
= AML_CLASS_NAMED_OBJECT
;
285 * Handle the opcode based upon the opcode type
287 switch (opcode_class
) {
288 case AML_CLASS_CONTROL
:
290 status
= acpi_ds_result_stack_push(walk_state
);
291 if (ACPI_FAILURE(status
)) {
292 return_ACPI_STATUS(status
);
295 status
= acpi_ds_exec_begin_control_op(walk_state
, op
);
298 case AML_CLASS_NAMED_OBJECT
:
300 if (walk_state
->walk_type
== ACPI_WALK_METHOD
) {
302 * Found a named object declaration during method execution;
303 * we must enter this object into the namespace. The created
304 * object is temporary and will be deleted upon completion of
305 * the execution of this method.
307 status
= acpi_ds_load2_begin_op(walk_state
, NULL
);
310 if (op
->common
.aml_opcode
== AML_REGION_OP
) {
311 status
= acpi_ds_result_stack_push(walk_state
);
315 case AML_CLASS_EXECUTE
:
316 case AML_CLASS_CREATE
:
319 * Most operators with arguments.
320 * Start a new result/operand state
322 status
= acpi_ds_result_stack_push(walk_state
);
329 /* Nothing to do here during method execution */
331 return_ACPI_STATUS(status
);
334 /*****************************************************************************
336 * FUNCTION: acpi_ds_exec_end_op
338 * PARAMETERS: walk_state - Current state of the parse tree walk
342 * DESCRIPTION: Ascending callback used during the execution of control
343 * methods. The only thing we really need to do here is to
344 * notice the beginning of IF, ELSE, and WHILE blocks.
346 ****************************************************************************/
348 acpi_status
acpi_ds_exec_end_op(struct acpi_walk_state
*walk_state
)
350 union acpi_parse_object
*op
;
351 acpi_status status
= AE_OK
;
354 union acpi_parse_object
*next_op
;
355 union acpi_parse_object
*first_arg
;
357 ACPI_FUNCTION_TRACE_PTR("ds_exec_end_op", walk_state
);
360 op_type
= walk_state
->op_info
->type
;
361 op_class
= walk_state
->op_info
->class;
363 if (op_class
== AML_CLASS_UNKNOWN
) {
364 ACPI_DEBUG_PRINT((ACPI_DB_ERROR
, "Unknown opcode %X\n",
365 op
->common
.aml_opcode
));
366 return_ACPI_STATUS(AE_NOT_IMPLEMENTED
);
369 first_arg
= op
->common
.value
.arg
;
371 /* Init the walk state */
373 walk_state
->num_operands
= 0;
374 walk_state
->return_desc
= NULL
;
375 walk_state
->result_obj
= NULL
;
377 /* Call debugger for single step support (DEBUG build only) */
379 ACPI_DEBUGGER_EXEC(status
=
380 acpi_db_single_step(walk_state
, op
, op_class
));
381 ACPI_DEBUGGER_EXEC(if (ACPI_FAILURE(status
)) {
382 return_ACPI_STATUS(status
);}
385 /* Decode the Opcode Class */
388 case AML_CLASS_ARGUMENT
: /* constants, literals, etc. - do nothing */
391 case AML_CLASS_EXECUTE
: /* most operators with arguments */
393 /* Build resolved operand stack */
395 status
= acpi_ds_create_operands(walk_state
, first_arg
);
396 if (ACPI_FAILURE(status
)) {
400 /* Done with this result state (Now that operand stack is built) */
402 status
= acpi_ds_result_stack_pop(walk_state
);
403 if (ACPI_FAILURE(status
)) {
408 * All opcodes require operand resolution, with the only exceptions
409 * being the object_type and size_of operators.
411 if (!(walk_state
->op_info
->flags
& AML_NO_OPERAND_RESOLVE
)) {
412 /* Resolve all operands */
414 status
= acpi_ex_resolve_operands(walk_state
->opcode
,
420 if (ACPI_SUCCESS(status
)) {
421 ACPI_DUMP_OPERANDS(ACPI_WALK_OPERANDS
,
423 acpi_ps_get_opcode_name
424 (walk_state
->opcode
),
425 walk_state
->num_operands
,
426 "after ex_resolve_operands");
430 if (ACPI_SUCCESS(status
)) {
432 * Dispatch the request to the appropriate interpreter handler
433 * routine. There is one routine per opcode "type" based upon the
434 * number of opcode arguments and return type.
437 acpi_gbl_op_type_dispatch
[op_type
] (walk_state
);
440 * Treat constructs of the form "Store(local_x,local_x)" as noops when the
441 * Local is uninitialized.
443 if ((status
== AE_AML_UNINITIALIZED_LOCAL
) &&
444 (walk_state
->opcode
== AML_STORE_OP
) &&
445 (walk_state
->operands
[0]->common
.type
==
446 ACPI_TYPE_LOCAL_REFERENCE
)
447 && (walk_state
->operands
[1]->common
.type
==
448 ACPI_TYPE_LOCAL_REFERENCE
)
449 && (walk_state
->operands
[0]->reference
.opcode
==
450 walk_state
->operands
[1]->reference
.opcode
)
451 && (walk_state
->operands
[0]->reference
.offset
==
452 walk_state
->operands
[1]->reference
.offset
)) {
455 ACPI_DEBUG_PRINT((ACPI_DB_ERROR
,
456 "[%s]: Could not resolve operands, %s\n",
457 acpi_ps_get_opcode_name
458 (walk_state
->opcode
),
459 acpi_format_exception
464 /* Always delete the argument objects and clear the operand stack */
466 acpi_ds_clear_operands(walk_state
);
469 * If a result object was returned from above, push it on the
470 * current result stack
472 if (ACPI_SUCCESS(status
) && walk_state
->result_obj
) {
474 acpi_ds_result_push(walk_state
->result_obj
,
483 case AML_TYPE_CONTROL
: /* Type 1 opcode, IF/ELSE/WHILE/NOOP */
485 /* 1 Operand, 0 external_result, 0 internal_result */
487 status
= acpi_ds_exec_end_control_op(walk_state
, op
);
489 /* Make sure to properly pop the result stack */
491 if (ACPI_SUCCESS(status
)) {
492 status
= acpi_ds_result_stack_pop(walk_state
);
493 } else if (status
== AE_CTRL_PENDING
) {
494 status
= acpi_ds_result_stack_pop(walk_state
);
495 if (ACPI_SUCCESS(status
)) {
496 status
= AE_CTRL_PENDING
;
501 case AML_TYPE_METHOD_CALL
:
504 * If the method is referenced from within a package
505 * declaration, it is not a invocation of the method, just
508 if ((op
->asl
.parent
) &&
509 ((op
->asl
.parent
->asl
.aml_opcode
== AML_PACKAGE_OP
)
510 || (op
->asl
.parent
->asl
.aml_opcode
==
511 AML_VAR_PACKAGE_OP
))) {
512 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH
,
513 "Method Reference in a Package, Op=%p\n",
516 (struct acpi_namespace_node
*)op
->asl
.value
.
517 arg
->asl
.node
->object
;
518 acpi_ut_add_reference(op
->asl
.value
.arg
->asl
.
520 return_ACPI_STATUS(AE_OK
);
523 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH
,
524 "Method invocation, Op=%p\n", op
));
527 * (AML_METHODCALL) Op->Asl.Value.Arg->Asl.Node contains
528 * the method Node pointer
530 /* next_op points to the op that holds the method name */
534 /* next_op points to first argument op */
536 next_op
= next_op
->common
.next
;
539 * Get the method's arguments and put them on the operand stack
541 status
= acpi_ds_create_operands(walk_state
, next_op
);
542 if (ACPI_FAILURE(status
)) {
547 * Since the operands will be passed to another control method,
548 * we must resolve all local references here (Local variables,
549 * arguments to *this* method, etc.)
551 status
= acpi_ds_resolve_operands(walk_state
);
552 if (ACPI_FAILURE(status
)) {
553 /* On error, clear all resolved operands */
555 acpi_ds_clear_operands(walk_state
);
560 * Tell the walk loop to preempt this running method and
561 * execute the new method
563 status
= AE_CTRL_TRANSFER
;
566 * Return now; we don't want to disturb anything,
567 * especially the operand count!
569 return_ACPI_STATUS(status
);
571 case AML_TYPE_CREATE_FIELD
:
573 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
,
574 "Executing create_field Buffer/Index Op=%p\n",
577 status
= acpi_ds_load2_end_op(walk_state
);
578 if (ACPI_FAILURE(status
)) {
583 acpi_ds_eval_buffer_field_operands(walk_state
, op
);
586 case AML_TYPE_CREATE_OBJECT
:
588 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
,
589 "Executing create_object (Buffer/Package) Op=%p\n",
592 switch (op
->common
.parent
->common
.aml_opcode
) {
596 * Put the Node on the object stack (Contains the ACPI Name
599 walk_state
->operands
[0] =
600 (void *)op
->common
.parent
->common
.node
;
601 walk_state
->num_operands
= 1;
603 status
= acpi_ds_create_node(walk_state
,
607 if (ACPI_FAILURE(status
)) {
612 /*lint -fallthrough */
614 case AML_INT_EVAL_SUBTREE_OP
:
617 acpi_ds_eval_data_object_operands
619 acpi_ns_get_attached_object(op
->common
.
627 acpi_ds_eval_data_object_operands
628 (walk_state
, op
, NULL
);
632 /* Done with result state (Now that operand stack is built) */
634 status
= acpi_ds_result_stack_pop(walk_state
);
635 if (ACPI_FAILURE(status
)) {
640 * If a result object was returned from above, push it on the
641 * current result stack
643 if (walk_state
->result_obj
) {
645 acpi_ds_result_push(walk_state
->result_obj
,
650 case AML_TYPE_NAMED_FIELD
:
651 case AML_TYPE_NAMED_COMPLEX
:
652 case AML_TYPE_NAMED_SIMPLE
:
653 case AML_TYPE_NAMED_NO_OBJ
:
655 status
= acpi_ds_load2_end_op(walk_state
);
656 if (ACPI_FAILURE(status
)) {
660 if (op
->common
.aml_opcode
== AML_REGION_OP
) {
661 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
,
662 "Executing op_region Address/Length Op=%p\n",
666 acpi_ds_eval_region_operands(walk_state
,
668 if (ACPI_FAILURE(status
)) {
672 status
= acpi_ds_result_stack_pop(walk_state
);
677 case AML_TYPE_UNDEFINED
:
679 ACPI_DEBUG_PRINT((ACPI_DB_ERROR
,
680 "Undefined opcode type Op=%p\n", op
));
681 return_ACPI_STATUS(AE_NOT_IMPLEMENTED
);
685 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH
,
686 "Internal opcode=%X type Op=%p\n",
687 walk_state
->opcode
, op
));
692 ACPI_DEBUG_PRINT((ACPI_DB_ERROR
,
693 "Unimplemented opcode, class=%X type=%X Opcode=%X Op=%p\n",
695 op
->common
.aml_opcode
, op
));
697 status
= AE_NOT_IMPLEMENTED
;
703 * ACPI 2.0 support for 64-bit integers: Truncate numeric
704 * result value if we are executing from a 32-bit ACPI table
706 acpi_ex_truncate_for32bit_table(walk_state
->result_obj
);
709 * Check if we just completed the evaluation of a
710 * conditional predicate
713 if ((ACPI_SUCCESS(status
)) &&
714 (walk_state
->control_state
) &&
715 (walk_state
->control_state
->common
.state
==
716 ACPI_CONTROL_PREDICATE_EXECUTING
) &&
717 (walk_state
->control_state
->control
.predicate_op
== op
)) {
719 acpi_ds_get_predicate_value(walk_state
,
720 walk_state
->result_obj
);
721 walk_state
->result_obj
= NULL
;
726 /* Invoke exception handler on error */
728 if (ACPI_FAILURE(status
) &&
729 acpi_gbl_exception_handler
&& !(status
& AE_CODE_CONTROL
)) {
730 acpi_ex_exit_interpreter();
731 status
= acpi_gbl_exception_handler(status
,
732 walk_state
->method_node
->
735 walk_state
->aml_offset
,
737 (void)acpi_ex_enter_interpreter();
740 if (walk_state
->result_obj
) {
741 /* Break to debugger to display result */
743 ACPI_DEBUGGER_EXEC(acpi_db_display_result_object
744 (walk_state
->result_obj
, walk_state
));
747 * Delete the result op if and only if:
748 * Parent will not use the result -- such as any
749 * non-nested type2 op in a method (parent will be method)
751 acpi_ds_delete_result_if_not_used(op
, walk_state
->result_obj
,
754 #ifdef _UNDER_DEVELOPMENT
756 if (walk_state
->parser_state
.aml
== walk_state
->parser_state
.aml_end
) {
757 acpi_db_method_end(walk_state
);
761 /* Always clear the object stack */
763 walk_state
->num_operands
= 0;
765 #ifdef ACPI_DISASSEMBLER
767 /* On error, display method locals/args */
769 if (ACPI_FAILURE(status
)) {
770 acpi_dm_dump_method_info(status
, walk_state
, op
);
774 return_ACPI_STATUS(status
);