1 /******************************************************************************
3 * Module Name: dswexec - Dispatcher method execution callbacks;
4 * dispatch to interpreter.
6 *****************************************************************************/
9 * Copyright (C) 2000 - 2016, Intel Corp.
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>
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_EXCEPTION((AE_INFO
, status
,
104 "Could not get result from predicate evaluation"));
106 return_ACPI_STATUS(status
);
109 status
= acpi_ds_create_operand(walk_state
, walk_state
->op
, 0);
110 if (ACPI_FAILURE(status
)) {
111 return_ACPI_STATUS(status
);
115 acpi_ex_resolve_to_value(&walk_state
->operands
[0],
117 if (ACPI_FAILURE(status
)) {
118 return_ACPI_STATUS(status
);
121 obj_desc
= walk_state
->operands
[0];
126 "No predicate ObjDesc=%p State=%p",
127 obj_desc
, walk_state
));
129 return_ACPI_STATUS(AE_AML_NO_OPERAND
);
133 * Result of predicate evaluation must be an Integer
134 * object. Implicitly convert the argument if necessary.
136 status
= acpi_ex_convert_to_integer(obj_desc
, &local_obj_desc
, 16);
137 if (ACPI_FAILURE(status
)) {
141 if (local_obj_desc
->common
.type
!= ACPI_TYPE_INTEGER
) {
143 "Bad predicate (not an integer) ObjDesc=%p State=%p Type=0x%X",
144 obj_desc
, walk_state
, obj_desc
->common
.type
));
146 status
= AE_AML_OPERAND_TYPE
;
150 /* Truncate the predicate to 32-bits if necessary */
152 (void)acpi_ex_truncate_for32bit_table(local_obj_desc
);
155 * Save the result of the predicate evaluation on
158 if (local_obj_desc
->integer
.value
) {
159 walk_state
->control_state
->common
.value
= TRUE
;
162 * Predicate is FALSE, we will just toss the
163 * rest of the package
165 walk_state
->control_state
->common
.value
= FALSE
;
166 status
= AE_CTRL_FALSE
;
169 /* Predicate can be used for an implicit return value */
171 (void)acpi_ds_do_implicit_return(local_obj_desc
, walk_state
, TRUE
);
175 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
,
176 "Completed a predicate eval=%X Op=%p\n",
177 walk_state
->control_state
->common
.value
,
180 /* Break to debugger to display result */
182 acpi_db_display_result_object(local_obj_desc
, walk_state
);
185 * Delete the predicate result object (we know that
186 * we don't need it anymore)
188 if (local_obj_desc
!= obj_desc
) {
189 acpi_ut_remove_reference(local_obj_desc
);
191 acpi_ut_remove_reference(obj_desc
);
193 walk_state
->control_state
->common
.state
= ACPI_CONTROL_NORMAL
;
194 return_ACPI_STATUS(status
);
197 /*****************************************************************************
199 * FUNCTION: acpi_ds_exec_begin_op
201 * PARAMETERS: walk_state - Current state of the parse tree walk
202 * out_op - Where to return op if a new one is created
206 * DESCRIPTION: Descending callback used during the execution of control
207 * methods. This is where most operators and operands are
208 * dispatched to the interpreter.
210 ****************************************************************************/
213 acpi_ds_exec_begin_op(struct acpi_walk_state
*walk_state
,
214 union acpi_parse_object
**out_op
)
216 union acpi_parse_object
*op
;
217 acpi_status status
= AE_OK
;
220 ACPI_FUNCTION_TRACE_PTR(ds_exec_begin_op
, walk_state
);
224 status
= acpi_ds_load2_begin_op(walk_state
, out_op
);
225 if (ACPI_FAILURE(status
)) {
231 walk_state
->opcode
= op
->common
.aml_opcode
;
232 walk_state
->op_info
=
233 acpi_ps_get_opcode_info(op
->common
.aml_opcode
);
235 if (acpi_ns_opens_scope(walk_state
->op_info
->object_type
)) {
236 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH
,
237 "(%s) Popping scope for Op %p\n",
238 acpi_ut_get_type_name(walk_state
->
243 status
= acpi_ds_scope_stack_pop(walk_state
);
244 if (ACPI_FAILURE(status
)) {
250 if (op
== walk_state
->origin
) {
255 return_ACPI_STATUS(AE_OK
);
259 * If the previous opcode was a conditional, this opcode
260 * must be the beginning of the associated predicate.
261 * Save this knowledge in the current scope descriptor
263 if ((walk_state
->control_state
) &&
264 (walk_state
->control_state
->common
.state
==
265 ACPI_CONTROL_CONDITIONAL_EXECUTING
)) {
266 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
,
267 "Exec predicate Op=%p State=%p\n",
270 walk_state
->control_state
->common
.state
=
271 ACPI_CONTROL_PREDICATE_EXECUTING
;
273 /* Save start of predicate */
275 walk_state
->control_state
->control
.predicate_op
= op
;
278 opcode_class
= walk_state
->op_info
->class;
280 /* We want to send namepaths to the load code */
282 if (op
->common
.aml_opcode
== AML_INT_NAMEPATH_OP
) {
283 opcode_class
= AML_CLASS_NAMED_OBJECT
;
287 * Handle the opcode based upon the opcode type
289 switch (opcode_class
) {
290 case AML_CLASS_CONTROL
:
292 status
= acpi_ds_exec_begin_control_op(walk_state
, op
);
295 case AML_CLASS_NAMED_OBJECT
:
297 if (walk_state
->walk_type
& ACPI_WALK_METHOD
) {
299 * Found a named object declaration during method execution;
300 * we must enter this object into the namespace. The created
301 * object is temporary and will be deleted upon completion of
302 * the execution of this method.
304 * Note 10/2010: Except for the Scope() op. This opcode does
305 * not actually create a new object, it refers to an existing
306 * object. However, for Scope(), we want to indeed open a
309 if (op
->common
.aml_opcode
!= AML_SCOPE_OP
) {
311 acpi_ds_load2_begin_op(walk_state
, NULL
);
314 acpi_ds_scope_stack_push(op
->named
.node
,
317 if (ACPI_FAILURE(status
)) {
318 return_ACPI_STATUS(status
);
324 case AML_CLASS_EXECUTE
:
325 case AML_CLASS_CREATE
:
334 /* Nothing to do here during method execution */
336 return_ACPI_STATUS(status
);
339 status
= acpi_ds_method_error(status
, walk_state
);
340 return_ACPI_STATUS(status
);
343 /*****************************************************************************
345 * FUNCTION: acpi_ds_exec_end_op
347 * PARAMETERS: walk_state - Current state of the parse tree walk
351 * DESCRIPTION: Ascending callback used during the execution of control
352 * methods. The only thing we really need to do here is to
353 * notice the beginning of IF, ELSE, and WHILE blocks.
355 ****************************************************************************/
357 acpi_status
acpi_ds_exec_end_op(struct acpi_walk_state
*walk_state
)
359 union acpi_parse_object
*op
;
360 acpi_status status
= AE_OK
;
363 union acpi_parse_object
*next_op
;
364 union acpi_parse_object
*first_arg
;
366 ACPI_FUNCTION_TRACE_PTR(ds_exec_end_op
, walk_state
);
369 op_type
= walk_state
->op_info
->type
;
370 op_class
= walk_state
->op_info
->class;
372 if (op_class
== AML_CLASS_UNKNOWN
) {
373 ACPI_ERROR((AE_INFO
, "Unknown opcode 0x%X",
374 op
->common
.aml_opcode
));
375 return_ACPI_STATUS(AE_NOT_IMPLEMENTED
);
378 first_arg
= op
->common
.value
.arg
;
380 /* Init the walk state */
382 walk_state
->num_operands
= 0;
383 walk_state
->operand_index
= 0;
384 walk_state
->return_desc
= NULL
;
385 walk_state
->result_obj
= NULL
;
387 /* Call debugger for single step support (DEBUG build only) */
389 status
= acpi_db_single_step(walk_state
, op
, op_class
);
390 if (ACPI_FAILURE(status
)) {
391 return_ACPI_STATUS(status
);
394 /* Decode the Opcode Class */
397 case AML_CLASS_ARGUMENT
: /* Constants, literals, etc. */
399 if (walk_state
->opcode
== AML_INT_NAMEPATH_OP
) {
400 status
= acpi_ds_evaluate_name_path(walk_state
);
401 if (ACPI_FAILURE(status
)) {
407 case AML_CLASS_EXECUTE
: /* Most operators with arguments */
409 /* Build resolved operand stack */
411 status
= acpi_ds_create_operands(walk_state
, first_arg
);
412 if (ACPI_FAILURE(status
)) {
417 * All opcodes require operand resolution, with the only exceptions
418 * being the object_type and size_of operators.
420 if (!(walk_state
->op_info
->flags
& AML_NO_OPERAND_RESOLVE
)) {
422 /* Resolve all operands */
424 status
= acpi_ex_resolve_operands(walk_state
->opcode
,
432 if (ACPI_SUCCESS(status
)) {
434 * Dispatch the request to the appropriate interpreter handler
435 * routine. There is one routine per opcode "type" based upon the
436 * number of opcode arguments and return type.
439 acpi_gbl_op_type_dispatch
[op_type
] (walk_state
);
442 * Treat constructs of the form "Store(LocalX,LocalX)" as noops when the
443 * Local is uninitialized.
445 if ((status
== AE_AML_UNINITIALIZED_LOCAL
) &&
446 (walk_state
->opcode
== AML_STORE_OP
) &&
447 (walk_state
->operands
[0]->common
.type
==
448 ACPI_TYPE_LOCAL_REFERENCE
)
449 && (walk_state
->operands
[1]->common
.type
==
450 ACPI_TYPE_LOCAL_REFERENCE
)
451 && (walk_state
->operands
[0]->reference
.class ==
452 walk_state
->operands
[1]->reference
.class)
453 && (walk_state
->operands
[0]->reference
.value
==
454 walk_state
->operands
[1]->reference
.value
)) {
457 ACPI_EXCEPTION((AE_INFO
, status
,
458 "While resolving operands for [%s]",
459 acpi_ps_get_opcode_name
460 (walk_state
->opcode
)));
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
,
482 case AML_TYPE_CONTROL
: /* Type 1 opcode, IF/ELSE/WHILE/NOOP */
484 /* 1 Operand, 0 external_result, 0 internal_result */
486 status
= acpi_ds_exec_end_control_op(walk_state
, op
);
490 case AML_TYPE_METHOD_CALL
:
492 * If the method is referenced from within a package
493 * declaration, it is not a invocation of the method, just
496 if ((op
->asl
.parent
) &&
497 ((op
->asl
.parent
->asl
.aml_opcode
== AML_PACKAGE_OP
)
498 || (op
->asl
.parent
->asl
.aml_opcode
==
499 AML_VAR_PACKAGE_OP
))) {
500 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH
,
501 "Method Reference in a Package, Op=%p\n",
504 op
->common
.node
= (struct acpi_namespace_node
*)
505 op
->asl
.value
.arg
->asl
.node
;
506 acpi_ut_add_reference(op
->asl
.value
.arg
->asl
.
508 return_ACPI_STATUS(AE_OK
);
511 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH
,
512 "Method invocation, Op=%p\n", op
));
515 * (AML_METHODCALL) Op->Asl.Value.Arg->Asl.Node contains
516 * the method Node pointer
518 /* next_op points to the op that holds the method name */
522 /* next_op points to first argument op */
524 next_op
= next_op
->common
.next
;
527 * Get the method's arguments and put them on the operand stack
529 status
= acpi_ds_create_operands(walk_state
, next_op
);
530 if (ACPI_FAILURE(status
)) {
535 * Since the operands will be passed to another control method,
536 * we must resolve all local references here (Local variables,
537 * arguments to *this* method, etc.)
539 status
= acpi_ds_resolve_operands(walk_state
);
540 if (ACPI_FAILURE(status
)) {
542 /* On error, clear all resolved operands */
544 acpi_ds_clear_operands(walk_state
);
549 * Tell the walk loop to preempt this running method and
550 * execute the new method
552 status
= AE_CTRL_TRANSFER
;
555 * Return now; we don't want to disturb anything,
556 * especially the operand count!
558 return_ACPI_STATUS(status
);
560 case AML_TYPE_CREATE_FIELD
:
562 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
,
563 "Executing CreateField Buffer/Index Op=%p\n",
566 status
= acpi_ds_load2_end_op(walk_state
);
567 if (ACPI_FAILURE(status
)) {
572 acpi_ds_eval_buffer_field_operands(walk_state
, op
);
575 case AML_TYPE_CREATE_OBJECT
:
577 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
,
578 "Executing CreateObject (Buffer/Package) Op=%p\n",
581 switch (op
->common
.parent
->common
.aml_opcode
) {
584 * Put the Node on the object stack (Contains the ACPI Name
587 walk_state
->operands
[0] = (void *)
588 op
->common
.parent
->common
.node
;
589 walk_state
->num_operands
= 1;
591 status
= acpi_ds_create_node(walk_state
,
595 if (ACPI_FAILURE(status
)) {
600 /*lint -fallthrough */
602 case AML_INT_EVAL_SUBTREE_OP
:
605 acpi_ds_eval_data_object_operands
607 acpi_ns_get_attached_object(op
->common
.
615 acpi_ds_eval_data_object_operands
616 (walk_state
, op
, NULL
);
621 * If a result object was returned from above, push it on the
622 * current result stack
624 if (walk_state
->result_obj
) {
626 acpi_ds_result_push(walk_state
->result_obj
,
631 case AML_TYPE_NAMED_FIELD
:
632 case AML_TYPE_NAMED_COMPLEX
:
633 case AML_TYPE_NAMED_SIMPLE
:
634 case AML_TYPE_NAMED_NO_OBJ
:
636 status
= acpi_ds_load2_end_op(walk_state
);
637 if (ACPI_FAILURE(status
)) {
641 if (op
->common
.aml_opcode
== AML_REGION_OP
) {
642 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
,
643 "Executing OpRegion Address/Length Op=%p\n",
647 acpi_ds_eval_region_operands(walk_state
,
649 if (ACPI_FAILURE(status
)) {
652 } else if (op
->common
.aml_opcode
== AML_DATA_REGION_OP
) {
653 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
,
654 "Executing DataTableRegion Strings Op=%p\n",
658 acpi_ds_eval_table_region_operands
660 if (ACPI_FAILURE(status
)) {
663 } else if (op
->common
.aml_opcode
== AML_BANK_FIELD_OP
) {
664 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
,
665 "Executing BankField Op=%p\n",
669 acpi_ds_eval_bank_field_operands(walk_state
,
671 if (ACPI_FAILURE(status
)) {
677 case AML_TYPE_UNDEFINED
:
680 "Undefined opcode type Op=%p", 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
));
693 "Unimplemented opcode, class=0x%X "
694 "type=0x%X Opcode=0x%X Op=%p",
695 op_class
, op_type
, op
->common
.aml_opcode
,
698 status
= AE_NOT_IMPLEMENTED
;
704 * ACPI 2.0 support for 64-bit integers: Truncate numeric
705 * result value if we are executing from a 32-bit ACPI table
707 (void)acpi_ex_truncate_for32bit_table(walk_state
->result_obj
);
710 * Check if we just completed the evaluation of a
711 * 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 if (walk_state
->result_obj
) {
728 /* Break to debugger to display result */
730 acpi_db_display_result_object(walk_state
->result_obj
,
734 * Delete the result op if and only if:
735 * Parent will not use the result -- such as any
736 * non-nested type2 op in a method (parent will be method)
738 acpi_ds_delete_result_if_not_used(op
, walk_state
->result_obj
,
741 #ifdef _UNDER_DEVELOPMENT
743 if (walk_state
->parser_state
.aml
== walk_state
->parser_state
.aml_end
) {
744 acpi_db_method_end(walk_state
);
748 /* Invoke exception handler on error */
750 if (ACPI_FAILURE(status
)) {
751 status
= acpi_ds_method_error(status
, walk_state
);
754 /* Always clear the object stack */
756 walk_state
->num_operands
= 0;
757 return_ACPI_STATUS(status
);