1 // SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0
2 /******************************************************************************
4 * Module Name: dswexec - Dispatcher method execution callbacks;
5 * dispatch to interpreter.
7 * Copyright (C) 2000 - 2020, Intel Corp.
9 *****************************************************************************/
11 #include <acpi/acpi.h>
20 #define _COMPONENT ACPI_DISPATCHER
21 ACPI_MODULE_NAME("dswexec")
24 * Dispatch table for opcode classes
26 static acpi_execute_op acpi_gbl_op_type_dispatch
[] = {
27 acpi_ex_opcode_0A_0T_1R
,
28 acpi_ex_opcode_1A_0T_0R
,
29 acpi_ex_opcode_1A_0T_1R
,
30 acpi_ex_opcode_1A_1T_0R
,
31 acpi_ex_opcode_1A_1T_1R
,
32 acpi_ex_opcode_2A_0T_0R
,
33 acpi_ex_opcode_2A_0T_1R
,
34 acpi_ex_opcode_2A_1T_1R
,
35 acpi_ex_opcode_2A_2T_1R
,
36 acpi_ex_opcode_3A_0T_0R
,
37 acpi_ex_opcode_3A_1T_1R
,
38 acpi_ex_opcode_6A_0T_1R
41 /*****************************************************************************
43 * FUNCTION: acpi_ds_get_predicate_value
45 * PARAMETERS: walk_state - Current state of the parse tree walk
46 * result_obj - if non-zero, pop result from result stack
50 * DESCRIPTION: Get the result of a predicate evaluation
52 ****************************************************************************/
55 acpi_ds_get_predicate_value(struct acpi_walk_state
*walk_state
,
56 union acpi_operand_object
*result_obj
)
58 acpi_status status
= AE_OK
;
59 union acpi_operand_object
*obj_desc
;
60 union acpi_operand_object
*local_obj_desc
= NULL
;
62 ACPI_FUNCTION_TRACE_PTR(ds_get_predicate_value
, walk_state
);
64 walk_state
->control_state
->common
.state
= 0;
67 status
= acpi_ds_result_pop(&obj_desc
, walk_state
);
68 if (ACPI_FAILURE(status
)) {
69 ACPI_EXCEPTION((AE_INFO
, status
,
70 "Could not get result from predicate evaluation"));
72 return_ACPI_STATUS(status
);
75 status
= acpi_ds_create_operand(walk_state
, walk_state
->op
, 0);
76 if (ACPI_FAILURE(status
)) {
77 return_ACPI_STATUS(status
);
81 acpi_ex_resolve_to_value(&walk_state
->operands
[0],
83 if (ACPI_FAILURE(status
)) {
84 return_ACPI_STATUS(status
);
87 obj_desc
= walk_state
->operands
[0];
92 "No predicate ObjDesc=%p State=%p",
93 obj_desc
, walk_state
));
95 return_ACPI_STATUS(AE_AML_NO_OPERAND
);
99 * Result of predicate evaluation must be an Integer
100 * object. Implicitly convert the argument if necessary.
102 status
= acpi_ex_convert_to_integer(obj_desc
, &local_obj_desc
,
103 ACPI_IMPLICIT_CONVERSION
);
104 if (ACPI_FAILURE(status
)) {
108 if (local_obj_desc
->common
.type
!= ACPI_TYPE_INTEGER
) {
110 "Bad predicate (not an integer) ObjDesc=%p State=%p Type=0x%X",
111 obj_desc
, walk_state
, obj_desc
->common
.type
));
113 status
= AE_AML_OPERAND_TYPE
;
117 /* Truncate the predicate to 32-bits if necessary */
119 (void)acpi_ex_truncate_for32bit_table(local_obj_desc
);
122 * Save the result of the predicate evaluation on
125 if (local_obj_desc
->integer
.value
) {
126 walk_state
->control_state
->common
.value
= TRUE
;
129 * Predicate is FALSE, we will just toss the
130 * rest of the package
132 walk_state
->control_state
->common
.value
= FALSE
;
133 status
= AE_CTRL_FALSE
;
136 /* Predicate can be used for an implicit return value */
138 (void)acpi_ds_do_implicit_return(local_obj_desc
, walk_state
, TRUE
);
142 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
,
143 "Completed a predicate eval=%X Op=%p\n",
144 walk_state
->control_state
->common
.value
,
147 /* Break to debugger to display result */
149 acpi_db_display_result_object(local_obj_desc
, walk_state
);
152 * Delete the predicate result object (we know that
153 * we don't need it anymore)
155 if (local_obj_desc
!= obj_desc
) {
156 acpi_ut_remove_reference(local_obj_desc
);
158 acpi_ut_remove_reference(obj_desc
);
160 walk_state
->control_state
->common
.state
= ACPI_CONTROL_NORMAL
;
161 return_ACPI_STATUS(status
);
164 /*****************************************************************************
166 * FUNCTION: acpi_ds_exec_begin_op
168 * PARAMETERS: walk_state - Current state of the parse tree walk
169 * out_op - Where to return op if a new one is created
173 * DESCRIPTION: Descending callback used during the execution of control
174 * methods. This is where most operators and operands are
175 * dispatched to the interpreter.
177 ****************************************************************************/
180 acpi_ds_exec_begin_op(struct acpi_walk_state
*walk_state
,
181 union acpi_parse_object
**out_op
)
183 union acpi_parse_object
*op
;
184 acpi_status status
= AE_OK
;
187 ACPI_FUNCTION_TRACE_PTR(ds_exec_begin_op
, walk_state
);
191 status
= acpi_ds_load2_begin_op(walk_state
, out_op
);
192 if (ACPI_FAILURE(status
)) {
198 walk_state
->opcode
= op
->common
.aml_opcode
;
199 walk_state
->op_info
=
200 acpi_ps_get_opcode_info(op
->common
.aml_opcode
);
202 if (acpi_ns_opens_scope(walk_state
->op_info
->object_type
)) {
203 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH
,
204 "(%s) Popping scope for Op %p\n",
205 acpi_ut_get_type_name(walk_state
->
210 status
= acpi_ds_scope_stack_pop(walk_state
);
211 if (ACPI_FAILURE(status
)) {
217 if (op
== walk_state
->origin
) {
222 return_ACPI_STATUS(AE_OK
);
226 * If the previous opcode was a conditional, this opcode
227 * must be the beginning of the associated predicate.
228 * Save this knowledge in the current scope descriptor
230 if ((walk_state
->control_state
) &&
231 (walk_state
->control_state
->common
.state
==
232 ACPI_CONTROL_CONDITIONAL_EXECUTING
)) {
233 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
,
234 "Exec predicate Op=%p State=%p\n",
237 walk_state
->control_state
->common
.state
=
238 ACPI_CONTROL_PREDICATE_EXECUTING
;
240 /* Save start of predicate */
242 walk_state
->control_state
->control
.predicate_op
= op
;
245 opcode_class
= walk_state
->op_info
->class;
247 /* We want to send namepaths to the load code */
249 if (op
->common
.aml_opcode
== AML_INT_NAMEPATH_OP
) {
250 opcode_class
= AML_CLASS_NAMED_OBJECT
;
254 * Handle the opcode based upon the opcode type
256 switch (opcode_class
) {
257 case AML_CLASS_CONTROL
:
259 status
= acpi_ds_exec_begin_control_op(walk_state
, op
);
262 case AML_CLASS_NAMED_OBJECT
:
264 if (walk_state
->walk_type
& ACPI_WALK_METHOD
) {
266 * Found a named object declaration during method execution;
267 * we must enter this object into the namespace. The created
268 * object is temporary and will be deleted upon completion of
269 * the execution of this method.
271 * Note 10/2010: Except for the Scope() op. This opcode does
272 * not actually create a new object, it refers to an existing
273 * object. However, for Scope(), we want to indeed open a
276 if (op
->common
.aml_opcode
!= AML_SCOPE_OP
) {
278 acpi_ds_load2_begin_op(walk_state
, NULL
);
281 acpi_ds_scope_stack_push(op
->named
.node
,
284 if (ACPI_FAILURE(status
)) {
285 return_ACPI_STATUS(status
);
291 case AML_CLASS_EXECUTE
:
292 case AML_CLASS_CREATE
:
301 /* Nothing to do here during method execution */
303 return_ACPI_STATUS(status
);
306 status
= acpi_ds_method_error(status
, walk_state
);
307 return_ACPI_STATUS(status
);
310 /*****************************************************************************
312 * FUNCTION: acpi_ds_exec_end_op
314 * PARAMETERS: walk_state - Current state of the parse tree walk
318 * DESCRIPTION: Ascending callback used during the execution of control
319 * methods. The only thing we really need to do here is to
320 * notice the beginning of IF, ELSE, and WHILE blocks.
322 ****************************************************************************/
324 acpi_status
acpi_ds_exec_end_op(struct acpi_walk_state
*walk_state
)
326 union acpi_parse_object
*op
;
327 acpi_status status
= AE_OK
;
330 union acpi_parse_object
*next_op
;
331 union acpi_parse_object
*first_arg
;
333 ACPI_FUNCTION_TRACE_PTR(ds_exec_end_op
, walk_state
);
336 op_type
= walk_state
->op_info
->type
;
337 op_class
= walk_state
->op_info
->class;
339 if (op_class
== AML_CLASS_UNKNOWN
) {
340 ACPI_ERROR((AE_INFO
, "Unknown opcode 0x%X",
341 op
->common
.aml_opcode
));
342 return_ACPI_STATUS(AE_NOT_IMPLEMENTED
);
345 first_arg
= op
->common
.value
.arg
;
347 /* Init the walk state */
349 walk_state
->num_operands
= 0;
350 walk_state
->operand_index
= 0;
351 walk_state
->return_desc
= NULL
;
352 walk_state
->result_obj
= NULL
;
354 /* Call debugger for single step support (DEBUG build only) */
356 status
= acpi_db_single_step(walk_state
, op
, op_class
);
357 if (ACPI_FAILURE(status
)) {
358 return_ACPI_STATUS(status
);
361 /* Decode the Opcode Class */
364 case AML_CLASS_ARGUMENT
: /* Constants, literals, etc. */
366 if (walk_state
->opcode
== AML_INT_NAMEPATH_OP
) {
367 status
= acpi_ds_evaluate_name_path(walk_state
);
368 if (ACPI_FAILURE(status
)) {
374 case AML_CLASS_EXECUTE
: /* Most operators with arguments */
376 /* Build resolved operand stack */
378 status
= acpi_ds_create_operands(walk_state
, first_arg
);
379 if (ACPI_FAILURE(status
)) {
384 * All opcodes require operand resolution, with the only exceptions
385 * being the object_type and size_of operators.
387 if (!(walk_state
->op_info
->flags
& AML_NO_OPERAND_RESOLVE
)) {
389 /* Resolve all operands */
391 status
= acpi_ex_resolve_operands(walk_state
->opcode
,
399 if (ACPI_SUCCESS(status
)) {
401 * Dispatch the request to the appropriate interpreter handler
402 * routine. There is one routine per opcode "type" based upon the
403 * number of opcode arguments and return type.
406 acpi_gbl_op_type_dispatch
[op_type
] (walk_state
);
409 * Treat constructs of the form "Store(LocalX,LocalX)" as noops when the
410 * Local is uninitialized.
412 if ((status
== AE_AML_UNINITIALIZED_LOCAL
) &&
413 (walk_state
->opcode
== AML_STORE_OP
) &&
414 (walk_state
->operands
[0]->common
.type
==
415 ACPI_TYPE_LOCAL_REFERENCE
)
416 && (walk_state
->operands
[1]->common
.type
==
417 ACPI_TYPE_LOCAL_REFERENCE
)
418 && (walk_state
->operands
[0]->reference
.class ==
419 walk_state
->operands
[1]->reference
.class)
420 && (walk_state
->operands
[0]->reference
.value
==
421 walk_state
->operands
[1]->reference
.value
)) {
424 ACPI_EXCEPTION((AE_INFO
, status
,
425 "While resolving operands for [%s]",
426 acpi_ps_get_opcode_name
427 (walk_state
->opcode
)));
431 /* Always delete the argument objects and clear the operand stack */
433 acpi_ds_clear_operands(walk_state
);
436 * If a result object was returned from above, push it on the
437 * current result stack
439 if (ACPI_SUCCESS(status
) && walk_state
->result_obj
) {
441 acpi_ds_result_push(walk_state
->result_obj
,
449 case AML_TYPE_CONTROL
: /* Type 1 opcode, IF/ELSE/WHILE/NOOP */
451 /* 1 Operand, 0 external_result, 0 internal_result */
453 status
= acpi_ds_exec_end_control_op(walk_state
, op
);
457 case AML_TYPE_METHOD_CALL
:
459 * If the method is referenced from within a package
460 * declaration, it is not a invocation of the method, just
463 if ((op
->asl
.parent
) &&
464 ((op
->asl
.parent
->asl
.aml_opcode
== AML_PACKAGE_OP
)
465 || (op
->asl
.parent
->asl
.aml_opcode
==
466 AML_VARIABLE_PACKAGE_OP
))) {
467 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH
,
468 "Method Reference in a Package, Op=%p\n",
471 op
->common
.node
= (struct acpi_namespace_node
*)
472 op
->asl
.value
.arg
->asl
.node
;
473 acpi_ut_add_reference(op
->asl
.value
.arg
->asl
.
475 return_ACPI_STATUS(AE_OK
);
478 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH
,
479 "Method invocation, Op=%p\n", op
));
482 * (AML_METHODCALL) Op->Asl.Value.Arg->Asl.Node contains
483 * the method Node pointer
485 /* next_op points to the op that holds the method name */
489 /* next_op points to first argument op */
491 next_op
= next_op
->common
.next
;
494 * Get the method's arguments and put them on the operand stack
496 status
= acpi_ds_create_operands(walk_state
, next_op
);
497 if (ACPI_FAILURE(status
)) {
502 * Since the operands will be passed to another control method,
503 * we must resolve all local references here (Local variables,
504 * arguments to *this* method, etc.)
506 status
= acpi_ds_resolve_operands(walk_state
);
507 if (ACPI_FAILURE(status
)) {
509 /* On error, clear all resolved operands */
511 acpi_ds_clear_operands(walk_state
);
516 * Tell the walk loop to preempt this running method and
517 * execute the new method
519 status
= AE_CTRL_TRANSFER
;
522 * Return now; we don't want to disturb anything,
523 * especially the operand count!
525 return_ACPI_STATUS(status
);
527 case AML_TYPE_CREATE_FIELD
:
529 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
,
530 "Executing CreateField Buffer/Index Op=%p\n",
533 status
= acpi_ds_load2_end_op(walk_state
);
534 if (ACPI_FAILURE(status
)) {
539 acpi_ds_eval_buffer_field_operands(walk_state
, op
);
542 case AML_TYPE_CREATE_OBJECT
:
544 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
,
545 "Executing CreateObject (Buffer/Package) Op=%p Child=%p ParentOpcode=%4.4X\n",
546 op
, op
->named
.value
.arg
,
547 op
->common
.parent
->common
.
550 switch (op
->common
.parent
->common
.aml_opcode
) {
553 * Put the Node on the object stack (Contains the ACPI Name
556 walk_state
->operands
[0] = (void *)
557 op
->common
.parent
->common
.node
;
558 walk_state
->num_operands
= 1;
560 status
= acpi_ds_create_node(walk_state
,
564 if (ACPI_FAILURE(status
)) {
569 /*lint -fallthrough */
571 case AML_INT_EVAL_SUBTREE_OP
:
574 acpi_ds_eval_data_object_operands
576 acpi_ns_get_attached_object(op
->common
.
584 acpi_ds_eval_data_object_operands
585 (walk_state
, op
, NULL
);
590 * If a result object was returned from above, push it on the
591 * current result stack
593 if (walk_state
->result_obj
) {
595 acpi_ds_result_push(walk_state
->result_obj
,
600 case AML_TYPE_NAMED_FIELD
:
601 case AML_TYPE_NAMED_COMPLEX
:
602 case AML_TYPE_NAMED_SIMPLE
:
603 case AML_TYPE_NAMED_NO_OBJ
:
605 status
= acpi_ds_load2_end_op(walk_state
);
606 if (ACPI_FAILURE(status
)) {
610 if (op
->common
.aml_opcode
== AML_REGION_OP
) {
611 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
,
612 "Executing OpRegion Address/Length Op=%p\n",
616 acpi_ds_eval_region_operands(walk_state
,
618 if (ACPI_FAILURE(status
)) {
621 } else if (op
->common
.aml_opcode
== AML_DATA_REGION_OP
) {
622 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
,
623 "Executing DataTableRegion Strings Op=%p\n",
627 acpi_ds_eval_table_region_operands
629 if (ACPI_FAILURE(status
)) {
632 } else if (op
->common
.aml_opcode
== AML_BANK_FIELD_OP
) {
633 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
,
634 "Executing BankField Op=%p\n",
638 acpi_ds_eval_bank_field_operands(walk_state
,
640 if (ACPI_FAILURE(status
)) {
646 case AML_TYPE_UNDEFINED
:
649 "Undefined opcode type Op=%p", op
));
650 return_ACPI_STATUS(AE_NOT_IMPLEMENTED
);
654 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH
,
655 "Internal opcode=%X type Op=%p\n",
656 walk_state
->opcode
, op
));
662 "Unimplemented opcode, class=0x%X "
663 "type=0x%X Opcode=0x%X Op=%p",
664 op_class
, op_type
, op
->common
.aml_opcode
,
667 status
= AE_NOT_IMPLEMENTED
;
673 * ACPI 2.0 support for 64-bit integers: Truncate numeric
674 * result value if we are executing from a 32-bit ACPI table
676 (void)acpi_ex_truncate_for32bit_table(walk_state
->result_obj
);
679 * Check if we just completed the evaluation of a
680 * conditional predicate
682 if ((ACPI_SUCCESS(status
)) &&
683 (walk_state
->control_state
) &&
684 (walk_state
->control_state
->common
.state
==
685 ACPI_CONTROL_PREDICATE_EXECUTING
) &&
686 (walk_state
->control_state
->control
.predicate_op
== op
)) {
688 acpi_ds_get_predicate_value(walk_state
,
689 walk_state
->result_obj
);
690 walk_state
->result_obj
= NULL
;
695 if (walk_state
->result_obj
) {
697 /* Break to debugger to display result */
699 acpi_db_display_result_object(walk_state
->result_obj
,
703 * Delete the result op if and only if:
704 * Parent will not use the result -- such as any
705 * non-nested type2 op in a method (parent will be method)
707 acpi_ds_delete_result_if_not_used(op
, walk_state
->result_obj
,
710 #ifdef _UNDER_DEVELOPMENT
712 if (walk_state
->parser_state
.aml
== walk_state
->parser_state
.aml_end
) {
713 acpi_db_method_end(walk_state
);
717 /* Invoke exception handler on error */
719 if (ACPI_FAILURE(status
)) {
720 status
= acpi_ds_method_error(status
, walk_state
);
723 /* Always clear the object stack */
725 walk_state
->num_operands
= 0;
726 return_ACPI_STATUS(status
);