1 // SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0
2 /*******************************************************************************
4 * Module Name: dsutils - Dispatcher utilities
6 ******************************************************************************/
17 #define _COMPONENT ACPI_DISPATCHER
18 ACPI_MODULE_NAME("dsutils")
20 /*******************************************************************************
22 * FUNCTION: acpi_ds_clear_implicit_return
24 * PARAMETERS: walk_state - Current State
28 * DESCRIPTION: Clear and remove a reference on an implicit return value. Used
29 * to delete "stale" return values (if enabled, the return value
30 * from every operator is saved at least momentarily, in case the
31 * parent method exits.)
33 ******************************************************************************/
34 void acpi_ds_clear_implicit_return(struct acpi_walk_state *walk_state)
36 ACPI_FUNCTION_NAME(ds_clear_implicit_return);
39 * Slack must be enabled for this feature
41 if (!acpi_gbl_enable_interpreter_slack) {
45 if (walk_state->implicit_return_obj) {
47 * Delete any "stale" implicit return. However, in
48 * complex statements, the implicit return value can be
49 * bubbled up several levels.
51 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
52 "Removing reference on stale implicit return obj %p\n",
53 walk_state->implicit_return_obj));
55 acpi_ut_remove_reference(walk_state->implicit_return_obj);
56 walk_state->implicit_return_obj = NULL;
60 /*******************************************************************************
62 * FUNCTION: acpi_ds_do_implicit_return
64 * PARAMETERS: return_desc - The return value
65 * walk_state - Current State
66 * add_reference - True if a reference should be added to the
69 * RETURN: TRUE if implicit return enabled, FALSE otherwise
71 * DESCRIPTION: Implements the optional "implicit return". We save the result
72 * of every ASL operator and control method invocation in case the
73 * parent method exit. Before storing a new return value, we
74 * delete the previous return value.
76 ******************************************************************************/
79 acpi_ds_do_implicit_return(union acpi_operand_object *return_desc,
80 struct acpi_walk_state *walk_state, u8 add_reference)
82 ACPI_FUNCTION_NAME(ds_do_implicit_return);
85 * Slack must be enabled for this feature, and we must
86 * have a valid return object
88 if ((!acpi_gbl_enable_interpreter_slack) || (!return_desc)) {
92 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
93 "Result %p will be implicitly returned; Prev=%p\n",
94 return_desc, walk_state->implicit_return_obj));
97 * Delete any "stale" implicit return value first. However, in
98 * complex statements, the implicit return value can be
99 * bubbled up several levels, so we don't clear the value if it
100 * is the same as the return_desc.
102 if (walk_state->implicit_return_obj) {
103 if (walk_state->implicit_return_obj == return_desc) {
106 acpi_ds_clear_implicit_return(walk_state);
109 /* Save the implicit return value, add a reference if requested */
111 walk_state->implicit_return_obj = return_desc;
113 acpi_ut_add_reference(return_desc);
119 /*******************************************************************************
121 * FUNCTION: acpi_ds_is_result_used
123 * PARAMETERS: op - Current Op
124 * walk_state - Current State
126 * RETURN: TRUE if result is used, FALSE otherwise
128 * DESCRIPTION: Check if a result object will be used by the parent
130 ******************************************************************************/
133 acpi_ds_is_result_used(union acpi_parse_object * op,
134 struct acpi_walk_state * walk_state)
136 const struct acpi_opcode_info *parent_info;
138 ACPI_FUNCTION_TRACE_PTR(ds_is_result_used, op);
140 /* Must have both an Op and a Result Object */
143 ACPI_ERROR((AE_INFO, "Null Op"));
148 * We know that this operator is not a
149 * Return() operator (would not come here.) The following code is the
150 * optional support for a so-called "implicit return". Some AML code
151 * assumes that the last value of the method is "implicitly" returned
152 * to the caller. Just save the last result as the return value.
153 * NOTE: this is optional because the ASL language does not actually
154 * support this behavior.
156 (void)acpi_ds_do_implicit_return(walk_state->result_obj, walk_state,
160 * Now determine if the parent will use the result
162 * If there is no parent, or the parent is a scope_op, we are executing
163 * at the method level. An executing method typically has no parent,
164 * since each method is parsed separately. A method invoked externally
165 * via execute_control_method has a scope_op as the parent.
167 if ((!op->common.parent) ||
168 (op->common.parent->common.aml_opcode == AML_SCOPE_OP)) {
170 /* No parent, the return value cannot possibly be used */
172 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
173 "At Method level, result of [%s] not used\n",
174 acpi_ps_get_opcode_name(op->common.
179 /* Get info on the parent. The root_op is AML_SCOPE */
182 acpi_ps_get_opcode_info(op->common.parent->common.aml_opcode);
183 if (parent_info->class == AML_CLASS_UNKNOWN) {
184 ACPI_ERROR((AE_INFO, "Unknown parent opcode Op=%p", op));
189 * Decide what to do with the result based on the parent. If
190 * the parent opcode will not use the result, delete the object.
191 * Otherwise leave it as is, it will be deleted when it is used
192 * as an operand later.
194 switch (parent_info->class) {
195 case AML_CLASS_CONTROL:
197 switch (op->common.parent->common.aml_opcode) {
200 /* Never delete the return value associated with a return opcode */
207 * If we are executing the predicate AND this is the predicate op,
208 * we will use the return value
210 if ((walk_state->control_state->common.state ==
211 ACPI_CONTROL_PREDICATE_EXECUTING) &&
212 (walk_state->control_state->control.predicate_op ==
220 /* Ignore other control opcodes */
225 /* The general control opcode returns no result */
227 goto result_not_used;
229 case AML_CLASS_CREATE:
231 * These opcodes allow term_arg(s) as operands and therefore
232 * the operands can be method calls. The result is used.
236 case AML_CLASS_NAMED_OBJECT:
238 if ((op->common.parent->common.aml_opcode == AML_REGION_OP) ||
239 (op->common.parent->common.aml_opcode == AML_DATA_REGION_OP)
240 || (op->common.parent->common.aml_opcode == AML_PACKAGE_OP)
241 || (op->common.parent->common.aml_opcode == AML_BUFFER_OP)
242 || (op->common.parent->common.aml_opcode ==
243 AML_VARIABLE_PACKAGE_OP)
244 || (op->common.parent->common.aml_opcode ==
245 AML_INT_EVAL_SUBTREE_OP)
246 || (op->common.parent->common.aml_opcode ==
247 AML_BANK_FIELD_OP)) {
249 * These opcodes allow term_arg(s) as operands and therefore
250 * the operands can be method calls. The result is used.
255 goto result_not_used;
259 * In all other cases. the parent will actually use the return
260 * object, so keep it.
266 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
267 "Result of [%s] used by Parent [%s] Op=%p\n",
268 acpi_ps_get_opcode_name(op->common.aml_opcode),
269 acpi_ps_get_opcode_name(op->common.parent->common.
275 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
276 "Result of [%s] not used by Parent [%s] Op=%p\n",
277 acpi_ps_get_opcode_name(op->common.aml_opcode),
278 acpi_ps_get_opcode_name(op->common.parent->common.
284 /*******************************************************************************
286 * FUNCTION: acpi_ds_delete_result_if_not_used
288 * PARAMETERS: op - Current parse Op
289 * result_obj - Result of the operation
290 * walk_state - Current state
294 * DESCRIPTION: Used after interpretation of an opcode. If there is an internal
295 * result descriptor, check if the parent opcode will actually use
296 * this result. If not, delete the result now so that it will
297 * not become orphaned.
299 ******************************************************************************/
302 acpi_ds_delete_result_if_not_used(union acpi_parse_object *op,
303 union acpi_operand_object *result_obj,
304 struct acpi_walk_state *walk_state)
306 union acpi_operand_object *obj_desc;
309 ACPI_FUNCTION_TRACE_PTR(ds_delete_result_if_not_used, result_obj);
312 ACPI_ERROR((AE_INFO, "Null Op"));
320 if (!acpi_ds_is_result_used(op, walk_state)) {
322 /* Must pop the result stack (obj_desc should be equal to result_obj) */
324 status = acpi_ds_result_pop(&obj_desc, walk_state);
325 if (ACPI_SUCCESS(status)) {
326 acpi_ut_remove_reference(result_obj);
333 /*******************************************************************************
335 * FUNCTION: acpi_ds_resolve_operands
337 * PARAMETERS: walk_state - Current walk state with operands on stack
341 * DESCRIPTION: Resolve all operands to their values. Used to prepare
342 * arguments to a control method invocation (a call from one
343 * method to another.)
345 ******************************************************************************/
347 acpi_status acpi_ds_resolve_operands(struct acpi_walk_state *walk_state)
350 acpi_status status = AE_OK;
352 ACPI_FUNCTION_TRACE_PTR(ds_resolve_operands, walk_state);
355 * Attempt to resolve each of the valid operands
356 * Method arguments are passed by reference, not by value. This means
357 * that the actual objects are passed, not copies of the objects.
359 for (i = 0; i < walk_state->num_operands; i++) {
361 acpi_ex_resolve_to_value(&walk_state->operands[i],
363 if (ACPI_FAILURE(status)) {
368 return_ACPI_STATUS(status);
371 /*******************************************************************************
373 * FUNCTION: acpi_ds_clear_operands
375 * PARAMETERS: walk_state - Current walk state with operands on stack
379 * DESCRIPTION: Clear all operands on the current walk state operand stack.
381 ******************************************************************************/
383 void acpi_ds_clear_operands(struct acpi_walk_state *walk_state)
387 ACPI_FUNCTION_TRACE_PTR(ds_clear_operands, walk_state);
389 /* Remove a reference on each operand on the stack */
391 for (i = 0; i < walk_state->num_operands; i++) {
393 * Remove a reference to all operands, including both
394 * "Arguments" and "Targets".
396 acpi_ut_remove_reference(walk_state->operands[i]);
397 walk_state->operands[i] = NULL;
400 walk_state->num_operands = 0;
404 /*******************************************************************************
406 * FUNCTION: acpi_ds_create_operand
408 * PARAMETERS: walk_state - Current walk state
409 * arg - Parse object for the argument
410 * arg_index - Which argument (zero based)
414 * DESCRIPTION: Translate a parse tree object that is an argument to an AML
415 * opcode to the equivalent interpreter object. This may include
416 * looking up a name or entering a new name into the internal
419 ******************************************************************************/
422 acpi_ds_create_operand(struct acpi_walk_state *walk_state,
423 union acpi_parse_object *arg, u32 arg_index)
425 acpi_status status = AE_OK;
428 union acpi_operand_object *obj_desc;
429 union acpi_parse_object *parent_op;
431 acpi_interpreter_mode interpreter_mode;
432 const struct acpi_opcode_info *op_info;
434 ACPI_FUNCTION_TRACE_PTR(ds_create_operand, arg);
436 /* A valid name must be looked up in the namespace */
438 if ((arg->common.aml_opcode == AML_INT_NAMEPATH_OP) &&
439 (arg->common.value.string) &&
440 !(arg->common.flags & ACPI_PARSEOP_IN_STACK)) {
441 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH, "Getting a name: Arg=%p\n",
444 /* Get the entire name string from the AML stream */
446 status = acpi_ex_get_name_string(ACPI_TYPE_ANY,
447 arg->common.value.buffer,
448 &name_string, &name_length);
450 if (ACPI_FAILURE(status)) {
451 return_ACPI_STATUS(status);
454 /* All prefixes have been handled, and the name is in name_string */
457 * Special handling for buffer_field declarations. This is a deferred
458 * opcode that unfortunately defines the field name as the last
459 * parameter instead of the first. We get here when we are performing
460 * the deferred execution, so the actual name of the field is already
461 * in the namespace. We don't want to attempt to look it up again
462 * because we may be executing in a different scope than where the
463 * actual opcode exists.
465 if ((walk_state->deferred_node) &&
466 (walk_state->deferred_node->type == ACPI_TYPE_BUFFER_FIELD)
467 && (arg_index == (u32)
468 ((walk_state->opcode == AML_CREATE_FIELD_OP) ? 3 : 2))) {
470 ACPI_CAST_PTR(union acpi_operand_object,
471 walk_state->deferred_node);
473 } else { /* All other opcodes */
476 * Differentiate between a namespace "create" operation
477 * versus a "lookup" operation (IMODE_LOAD_PASS2 vs.
478 * IMODE_EXECUTE) in order to support the creation of
479 * namespace objects during the execution of control methods.
481 parent_op = arg->common.parent;
483 acpi_ps_get_opcode_info(parent_op->common.
486 if ((op_info->flags & AML_NSNODE) &&
487 (parent_op->common.aml_opcode !=
488 AML_INT_METHODCALL_OP)
489 && (parent_op->common.aml_opcode != AML_REGION_OP)
490 && (parent_op->common.aml_opcode !=
491 AML_INT_NAMEPATH_OP)) {
493 /* Enter name into namespace if not found */
495 interpreter_mode = ACPI_IMODE_LOAD_PASS2;
497 /* Return a failure if name not found */
499 interpreter_mode = ACPI_IMODE_EXECUTE;
503 acpi_ns_lookup(walk_state->scope_info, name_string,
504 ACPI_TYPE_ANY, interpreter_mode,
505 ACPI_NS_SEARCH_PARENT |
506 ACPI_NS_DONT_OPEN_SCOPE, walk_state,
507 ACPI_CAST_INDIRECT_PTR(struct
511 * The only case where we pass through (ignore) a NOT_FOUND
512 * error is for the cond_ref_of opcode.
514 if (status == AE_NOT_FOUND) {
515 if (parent_op->common.aml_opcode ==
516 AML_CONDITIONAL_REF_OF_OP) {
518 * For the Conditional Reference op, it's OK if
519 * the name is not found; We just need a way to
520 * indicate this to the interpreter, set the
528 } else if (parent_op->common.aml_opcode ==
531 * This opcode should never appear here. It is used only
532 * by AML disassemblers and is surrounded by an If(0)
533 * by the ASL compiler.
535 * Therefore, if we see it here, it is a serious error.
537 status = AE_AML_BAD_OPCODE;
540 * We just plain didn't find it -- which is a
541 * very serious error at this point
543 status = AE_AML_NAME_NOT_FOUND;
547 if (ACPI_FAILURE(status)) {
548 ACPI_ERROR_NAMESPACE(walk_state->scope_info,
549 name_string, status);
553 /* Free the namestring created above */
555 ACPI_FREE(name_string);
557 /* Check status from the lookup */
559 if (ACPI_FAILURE(status)) {
560 return_ACPI_STATUS(status);
563 /* Put the resulting object onto the current object stack */
565 status = acpi_ds_obj_stack_push(obj_desc, walk_state);
566 if (ACPI_FAILURE(status)) {
567 return_ACPI_STATUS(status);
570 acpi_db_display_argument_object(obj_desc, walk_state);
572 /* Check for null name case */
574 if ((arg->common.aml_opcode == AML_INT_NAMEPATH_OP) &&
575 !(arg->common.flags & ACPI_PARSEOP_IN_STACK)) {
577 * If the name is null, this means that this is an
578 * optional result parameter that was not specified
579 * in the original ASL. Create a Zero Constant for a
580 * placeholder. (Store to a constant is a Noop.)
582 opcode = AML_ZERO_OP; /* Has no arguments! */
584 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
585 "Null namepath: Arg=%p\n", arg));
587 opcode = arg->common.aml_opcode;
590 /* Get the object type of the argument */
592 op_info = acpi_ps_get_opcode_info(opcode);
593 if (op_info->object_type == ACPI_TYPE_INVALID) {
594 return_ACPI_STATUS(AE_NOT_IMPLEMENTED);
597 if ((op_info->flags & AML_HAS_RETVAL) ||
598 (arg->common.flags & ACPI_PARSEOP_IN_STACK)) {
600 * Use value that was already previously returned
601 * by the evaluation of this argument
603 status = acpi_ds_result_pop(&obj_desc, walk_state);
604 if (ACPI_FAILURE(status)) {
606 * Only error is underflow, and this indicates
607 * a missing or null operand!
609 ACPI_EXCEPTION((AE_INFO, status,
610 "Missing or null operand"));
611 return_ACPI_STATUS(status);
614 /* Create an ACPI_INTERNAL_OBJECT for the argument */
617 acpi_ut_create_internal_object(op_info->
620 return_ACPI_STATUS(AE_NO_MEMORY);
623 /* Initialize the new object */
626 acpi_ds_init_object_from_op(walk_state, arg, opcode,
628 if (ACPI_FAILURE(status)) {
629 acpi_ut_delete_object_desc(obj_desc);
630 return_ACPI_STATUS(status);
634 /* Put the operand object on the object stack */
636 status = acpi_ds_obj_stack_push(obj_desc, walk_state);
637 if (ACPI_FAILURE(status)) {
638 return_ACPI_STATUS(status);
641 acpi_db_display_argument_object(obj_desc, walk_state);
644 return_ACPI_STATUS(AE_OK);
647 /*******************************************************************************
649 * FUNCTION: acpi_ds_create_operands
651 * PARAMETERS: walk_state - Current state
652 * first_arg - First argument of a parser argument tree
656 * DESCRIPTION: Convert an operator's arguments from a parse tree format to
657 * namespace objects and place those argument object on the object
658 * stack in preparation for evaluation by the interpreter.
660 ******************************************************************************/
663 acpi_ds_create_operands(struct acpi_walk_state *walk_state,
664 union acpi_parse_object *first_arg)
666 acpi_status status = AE_OK;
667 union acpi_parse_object *arg;
668 union acpi_parse_object *arguments[ACPI_OBJ_NUM_OPERANDS];
670 u32 index = walk_state->num_operands;
673 ACPI_FUNCTION_TRACE_PTR(ds_create_operands, first_arg);
675 /* Get all arguments in the list */
679 if (index >= ACPI_OBJ_NUM_OPERANDS) {
680 return_ACPI_STATUS(AE_BAD_DATA);
683 arguments[index] = arg;
684 walk_state->operands[index] = NULL;
686 /* Move on to next argument, if any */
688 arg = arg->common.next;
693 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
694 "NumOperands %d, ArgCount %d, Index %d\n",
695 walk_state->num_operands, arg_count, index));
697 /* Create the interpreter arguments, in reverse order */
700 for (i = 0; i < arg_count; i++) {
701 arg = arguments[index];
702 walk_state->operand_index = (u8)index;
704 status = acpi_ds_create_operand(walk_state, arg, index);
705 if (ACPI_FAILURE(status)) {
709 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
710 "Created Arg #%u (%p) %u args total\n",
711 index, arg, arg_count));
715 return_ACPI_STATUS(status);
719 * We must undo everything done above; meaning that we must
720 * pop everything off of the operand stack and delete those
723 acpi_ds_obj_stack_pop_and_delete(arg_count, walk_state);
725 ACPI_EXCEPTION((AE_INFO, status, "While creating Arg %u", index));
726 return_ACPI_STATUS(status);
729 /*****************************************************************************
731 * FUNCTION: acpi_ds_evaluate_name_path
733 * PARAMETERS: walk_state - Current state of the parse tree walk,
734 * the opcode of current operation should be
735 * AML_INT_NAMEPATH_OP
739 * DESCRIPTION: Translate the -name_path- parse tree object to the equivalent
740 * interpreter object, convert it to value, if needed, duplicate
741 * it, if needed, and push it onto the current result stack.
743 ****************************************************************************/
745 acpi_status acpi_ds_evaluate_name_path(struct acpi_walk_state *walk_state)
747 acpi_status status = AE_OK;
748 union acpi_parse_object *op = walk_state->op;
749 union acpi_operand_object **operand = &walk_state->operands[0];
750 union acpi_operand_object *new_obj_desc;
753 ACPI_FUNCTION_TRACE_PTR(ds_evaluate_name_path, walk_state);
755 if (!op->common.parent) {
757 /* This happens after certain exception processing */
762 if ((op->common.parent->common.aml_opcode == AML_PACKAGE_OP) ||
763 (op->common.parent->common.aml_opcode == AML_VARIABLE_PACKAGE_OP) ||
764 (op->common.parent->common.aml_opcode == AML_REF_OF_OP)) {
766 /* TBD: Should we specify this feature as a bit of op_info->Flags of these opcodes? */
771 status = acpi_ds_create_operand(walk_state, op, 0);
772 if (ACPI_FAILURE(status)) {
776 if (op->common.flags & ACPI_PARSEOP_TARGET) {
777 new_obj_desc = *operand;
781 type = (*operand)->common.type;
783 status = acpi_ex_resolve_to_value(operand, walk_state);
784 if (ACPI_FAILURE(status)) {
788 if (type == ACPI_TYPE_INTEGER) {
790 /* It was incremented by acpi_ex_resolve_to_value */
792 acpi_ut_remove_reference(*operand);
795 acpi_ut_copy_iobject_to_iobject(*operand, &new_obj_desc,
797 if (ACPI_FAILURE(status)) {
802 * The object either was anew created or is
803 * a Namespace node - don't decrement it.
805 new_obj_desc = *operand;
808 /* Cleanup for name-path operand */
810 status = acpi_ds_obj_stack_pop(1, walk_state);
811 if (ACPI_FAILURE(status)) {
812 walk_state->result_obj = new_obj_desc;
818 walk_state->result_obj = new_obj_desc;
820 status = acpi_ds_result_push(walk_state->result_obj, walk_state);
821 if (ACPI_SUCCESS(status)) {
823 /* Force to take it from stack */
825 op->common.flags |= ACPI_PARSEOP_IN_STACK;
830 return_ACPI_STATUS(status);