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 - 2022, Intel Corp.
9 *****************************************************************************/
11 #include <acpi/acpi.h>
23 #define _COMPONENT ACPI_DISPATCHER
24 ACPI_MODULE_NAME("dswexec")
27 * Dispatch table for opcode classes
29 static acpi_execute_op acpi_gbl_op_type_dispatch[] = {
30 acpi_ex_opcode_0A_0T_1R,
31 acpi_ex_opcode_1A_0T_0R,
32 acpi_ex_opcode_1A_0T_1R,
33 NULL, /* Was: acpi_ex_opcode_1A_0T_0R (Was for Load operator) */
34 acpi_ex_opcode_1A_1T_1R,
35 acpi_ex_opcode_2A_0T_0R,
36 acpi_ex_opcode_2A_0T_1R,
37 acpi_ex_opcode_2A_1T_1R,
38 acpi_ex_opcode_2A_2T_1R,
39 acpi_ex_opcode_3A_0T_0R,
40 acpi_ex_opcode_3A_1T_1R,
41 acpi_ex_opcode_6A_0T_1R
44 /*****************************************************************************
46 * FUNCTION: acpi_ds_get_predicate_value
48 * PARAMETERS: walk_state - Current state of the parse tree walk
49 * result_obj - if non-zero, pop result from result stack
53 * DESCRIPTION: Get the result of a predicate evaluation
55 ****************************************************************************/
58 acpi_ds_get_predicate_value(struct acpi_walk_state *walk_state,
59 union acpi_operand_object *result_obj)
61 acpi_status status = AE_OK;
62 union acpi_operand_object *obj_desc;
63 union acpi_operand_object *local_obj_desc = NULL;
65 ACPI_FUNCTION_TRACE_PTR(ds_get_predicate_value, walk_state);
67 walk_state->control_state->common.state = 0;
70 status = acpi_ds_result_pop(&obj_desc, walk_state);
71 if (ACPI_FAILURE(status)) {
72 ACPI_EXCEPTION((AE_INFO, status,
73 "Could not get result from predicate evaluation"));
75 return_ACPI_STATUS(status);
78 status = acpi_ds_create_operand(walk_state, walk_state->op, 0);
79 if (ACPI_FAILURE(status)) {
80 return_ACPI_STATUS(status);
84 acpi_ex_resolve_to_value(&walk_state->operands[0],
86 if (ACPI_FAILURE(status)) {
87 return_ACPI_STATUS(status);
90 obj_desc = walk_state->operands[0];
95 "No predicate ObjDesc=%p State=%p",
96 obj_desc, walk_state));
98 return_ACPI_STATUS(AE_AML_NO_OPERAND);
102 * Result of predicate evaluation must be an Integer
103 * object. Implicitly convert the argument if necessary.
105 status = acpi_ex_convert_to_integer(obj_desc, &local_obj_desc,
106 ACPI_IMPLICIT_CONVERSION);
107 if (ACPI_FAILURE(status)) {
111 if (local_obj_desc->common.type != ACPI_TYPE_INTEGER) {
113 "Bad predicate (not an integer) ObjDesc=%p State=%p Type=0x%X",
114 obj_desc, walk_state, obj_desc->common.type));
116 status = AE_AML_OPERAND_TYPE;
120 /* Truncate the predicate to 32-bits if necessary */
122 (void)acpi_ex_truncate_for32bit_table(local_obj_desc);
125 * Save the result of the predicate evaluation on
128 if (local_obj_desc->integer.value) {
129 walk_state->control_state->common.value = TRUE;
132 * Predicate is FALSE, we will just toss the
133 * rest of the package
135 walk_state->control_state->common.value = FALSE;
136 status = AE_CTRL_FALSE;
139 /* Predicate can be used for an implicit return value */
141 (void)acpi_ds_do_implicit_return(local_obj_desc, walk_state, TRUE);
145 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
146 "Completed a predicate eval=%X Op=%p\n",
147 walk_state->control_state->common.value,
150 /* Break to debugger to display result */
152 acpi_db_display_result_object(local_obj_desc, walk_state);
155 * Delete the predicate result object (we know that
156 * we don't need it anymore)
158 if (local_obj_desc != obj_desc) {
159 acpi_ut_remove_reference(local_obj_desc);
161 acpi_ut_remove_reference(obj_desc);
163 walk_state->control_state->common.state = ACPI_CONTROL_NORMAL;
164 return_ACPI_STATUS(status);
167 /*****************************************************************************
169 * FUNCTION: acpi_ds_exec_begin_op
171 * PARAMETERS: walk_state - Current state of the parse tree walk
172 * out_op - Where to return op if a new one is created
176 * DESCRIPTION: Descending callback used during the execution of control
177 * methods. This is where most operators and operands are
178 * dispatched to the interpreter.
180 ****************************************************************************/
183 acpi_ds_exec_begin_op(struct acpi_walk_state *walk_state,
184 union acpi_parse_object **out_op)
186 union acpi_parse_object *op;
187 acpi_status status = AE_OK;
190 ACPI_FUNCTION_TRACE_PTR(ds_exec_begin_op, walk_state);
194 status = acpi_ds_load2_begin_op(walk_state, out_op);
195 if (ACPI_FAILURE(status)) {
201 walk_state->opcode = op->common.aml_opcode;
202 walk_state->op_info =
203 acpi_ps_get_opcode_info(op->common.aml_opcode);
205 if (acpi_ns_opens_scope(walk_state->op_info->object_type)) {
206 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
207 "(%s) Popping scope for Op %p\n",
208 acpi_ut_get_type_name(walk_state->
213 status = acpi_ds_scope_stack_pop(walk_state);
214 if (ACPI_FAILURE(status)) {
220 if (op == walk_state->origin) {
225 return_ACPI_STATUS(AE_OK);
229 * If the previous opcode was a conditional, this opcode
230 * must be the beginning of the associated predicate.
231 * Save this knowledge in the current scope descriptor
233 if ((walk_state->control_state) &&
234 (walk_state->control_state->common.state ==
235 ACPI_CONTROL_CONDITIONAL_EXECUTING)) {
236 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
237 "Exec predicate Op=%p State=%p\n",
240 walk_state->control_state->common.state =
241 ACPI_CONTROL_PREDICATE_EXECUTING;
243 /* Save start of predicate */
245 walk_state->control_state->control.predicate_op = op;
248 opcode_class = walk_state->op_info->class;
250 /* We want to send namepaths to the load code */
252 if (op->common.aml_opcode == AML_INT_NAMEPATH_OP) {
253 opcode_class = AML_CLASS_NAMED_OBJECT;
257 * Handle the opcode based upon the opcode type
259 switch (opcode_class) {
260 case AML_CLASS_CONTROL:
262 status = acpi_ds_exec_begin_control_op(walk_state, op);
265 case AML_CLASS_NAMED_OBJECT:
267 if (walk_state->walk_type & ACPI_WALK_METHOD) {
269 * Found a named object declaration during method execution;
270 * we must enter this object into the namespace. The created
271 * object is temporary and will be deleted upon completion of
272 * the execution of this method.
274 * Note 10/2010: Except for the Scope() op. This opcode does
275 * not actually create a new object, it refers to an existing
276 * object. However, for Scope(), we want to indeed open a
279 if (op->common.aml_opcode != AML_SCOPE_OP) {
281 acpi_ds_load2_begin_op(walk_state, NULL);
284 acpi_ds_scope_stack_push(op->named.node,
287 if (ACPI_FAILURE(status)) {
288 return_ACPI_STATUS(status);
294 case AML_CLASS_EXECUTE:
295 case AML_CLASS_CREATE:
304 /* Nothing to do here during method execution */
306 return_ACPI_STATUS(status);
309 status = acpi_ds_method_error(status, walk_state);
310 return_ACPI_STATUS(status);
313 /*****************************************************************************
315 * FUNCTION: acpi_ds_exec_end_op
317 * PARAMETERS: walk_state - Current state of the parse tree walk
321 * DESCRIPTION: Ascending callback used during the execution of control
322 * methods. The only thing we really need to do here is to
323 * notice the beginning of IF, ELSE, and WHILE blocks.
325 ****************************************************************************/
327 acpi_status acpi_ds_exec_end_op(struct acpi_walk_state *walk_state)
329 union acpi_parse_object *op;
330 acpi_status status = AE_OK;
333 union acpi_parse_object *next_op;
334 union acpi_parse_object *first_arg;
337 union acpi_operand_object *obj_desc;
340 ACPI_FUNCTION_TRACE_PTR(ds_exec_end_op, walk_state);
343 op_type = walk_state->op_info->type;
344 op_class = walk_state->op_info->class;
346 if (op_class == AML_CLASS_UNKNOWN) {
347 ACPI_ERROR((AE_INFO, "Unknown opcode 0x%X",
348 op->common.aml_opcode));
349 return_ACPI_STATUS(AE_NOT_IMPLEMENTED);
352 first_arg = op->common.value.arg;
354 /* Init the walk state */
356 walk_state->num_operands = 0;
357 walk_state->operand_index = 0;
358 walk_state->return_desc = NULL;
359 walk_state->result_obj = NULL;
361 /* Call debugger for single step support (DEBUG build only) */
363 status = acpi_db_single_step(walk_state, op, op_class);
364 if (ACPI_FAILURE(status)) {
365 return_ACPI_STATUS(status);
368 /* Decode the Opcode Class */
371 case AML_CLASS_ARGUMENT: /* Constants, literals, etc. */
373 if (walk_state->opcode == AML_INT_NAMEPATH_OP) {
374 status = acpi_ds_evaluate_name_path(walk_state);
375 if (ACPI_FAILURE(status)) {
381 case AML_CLASS_EXECUTE: /* Most operators with arguments */
383 /* Build resolved operand stack */
385 status = acpi_ds_create_operands(walk_state, first_arg);
386 if (ACPI_FAILURE(status)) {
391 * All opcodes require operand resolution, with the only exceptions
392 * being the object_type and size_of operators.
394 if (!(walk_state->op_info->flags & AML_NO_OPERAND_RESOLVE)) {
396 /* Resolve all operands */
398 status = acpi_ex_resolve_operands(walk_state->opcode,
406 if (ACPI_SUCCESS(status)) {
408 * Dispatch the request to the appropriate interpreter handler
409 * routine. There is one routine per opcode "type" based upon the
410 * number of opcode arguments and return type.
413 acpi_gbl_op_type_dispatch[op_type] (walk_state);
416 * Treat constructs of the form "Store(LocalX,LocalX)" as noops when the
417 * Local is uninitialized.
419 if ((status == AE_AML_UNINITIALIZED_LOCAL) &&
420 (walk_state->opcode == AML_STORE_OP) &&
421 (walk_state->operands[0]->common.type ==
422 ACPI_TYPE_LOCAL_REFERENCE)
423 && (walk_state->operands[1]->common.type ==
424 ACPI_TYPE_LOCAL_REFERENCE)
425 && (walk_state->operands[0]->reference.class ==
426 walk_state->operands[1]->reference.class)
427 && (walk_state->operands[0]->reference.value ==
428 walk_state->operands[1]->reference.value)) {
431 ACPI_EXCEPTION((AE_INFO, status,
432 "While resolving operands for [%s]",
433 acpi_ps_get_opcode_name
434 (walk_state->opcode)));
438 /* Always delete the argument objects and clear the operand stack */
440 acpi_ds_clear_operands(walk_state);
443 * If a result object was returned from above, push it on the
444 * current result stack
446 if (ACPI_SUCCESS(status) && walk_state->result_obj) {
448 acpi_ds_result_push(walk_state->result_obj,
456 case AML_TYPE_CONTROL: /* Type 1 opcode, IF/ELSE/WHILE/NOOP */
458 /* 1 Operand, 0 external_result, 0 internal_result */
460 status = acpi_ds_exec_end_control_op(walk_state, op);
464 case AML_TYPE_METHOD_CALL:
466 * If the method is referenced from within a package
467 * declaration, it is not a invocation of the method, just
470 if ((op->asl.parent) &&
471 ((op->asl.parent->asl.aml_opcode == AML_PACKAGE_OP)
472 || (op->asl.parent->asl.aml_opcode ==
473 AML_VARIABLE_PACKAGE_OP))) {
474 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
475 "Method Reference in a Package, Op=%p\n",
478 op->common.node = (struct acpi_namespace_node *)
479 op->asl.value.arg->asl.node;
480 acpi_ut_add_reference(op->asl.value.arg->asl.
482 return_ACPI_STATUS(AE_OK);
485 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
486 "Method invocation, Op=%p\n", op));
489 * (AML_METHODCALL) Op->Asl.Value.Arg->Asl.Node contains
490 * the method Node pointer
492 /* next_op points to the op that holds the method name */
496 /* next_op points to first argument op */
498 next_op = next_op->common.next;
501 * Get the method's arguments and put them on the operand stack
503 status = acpi_ds_create_operands(walk_state, next_op);
504 if (ACPI_FAILURE(status)) {
509 * Since the operands will be passed to another control method,
510 * we must resolve all local references here (Local variables,
511 * arguments to *this* method, etc.)
513 status = acpi_ds_resolve_operands(walk_state);
514 if (ACPI_FAILURE(status)) {
516 /* On error, clear all resolved operands */
518 acpi_ds_clear_operands(walk_state);
523 * Tell the walk loop to preempt this running method and
524 * execute the new method
526 status = AE_CTRL_TRANSFER;
529 * Return now; we don't want to disturb anything,
530 * especially the operand count!
532 return_ACPI_STATUS(status);
534 case AML_TYPE_CREATE_FIELD:
536 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
537 "Executing CreateField Buffer/Index Op=%p\n",
540 status = acpi_ds_load2_end_op(walk_state);
541 if (ACPI_FAILURE(status)) {
546 acpi_ds_eval_buffer_field_operands(walk_state, op);
547 if (ACPI_FAILURE(status)) {
552 * acpi_exec support for namespace initialization file (initialize
553 * buffer_fields in this code.)
556 acpi_ns_get_external_pathname(op->common.node);
557 status = ae_lookup_init_file_entry(namepath, &obj_desc);
558 if (ACPI_SUCCESS(status)) {
560 acpi_ex_write_data_to_field(obj_desc,
564 if (ACPI_FAILURE(status)) {
565 ACPI_EXCEPTION((AE_INFO, status,
566 "While writing to buffer field"));
574 case AML_TYPE_CREATE_OBJECT:
576 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
577 "Executing CreateObject (Buffer/Package) Op=%p Child=%p ParentOpcode=%4.4X\n",
578 op, op->named.value.arg,
579 op->common.parent->common.
582 switch (op->common.parent->common.aml_opcode) {
585 * Put the Node on the object stack (Contains the ACPI Name
588 walk_state->operands[0] = (void *)
589 op->common.parent->common.node;
590 walk_state->num_operands = 1;
592 status = acpi_ds_create_node(walk_state,
596 if (ACPI_FAILURE(status)) {
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);