1 /*******************************************************************************
3 * Module Name: dsutils - Dispatcher utilities
5 ******************************************************************************/
8 * Copyright (C) 2000 - 2011, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
44 #include <acpi/acpi.h>
53 #define _COMPONENT ACPI_DISPATCHER
54 ACPI_MODULE_NAME("dsutils")
56 /*******************************************************************************
58 * FUNCTION: acpi_ds_clear_implicit_return
60 * PARAMETERS: walk_state - Current State
64 * DESCRIPTION: Clear and remove a reference on an implicit return value. Used
65 * to delete "stale" return values (if enabled, the return value
66 * from every operator is saved at least momentarily, in case the
67 * parent method exits.)
69 ******************************************************************************/
70 void acpi_ds_clear_implicit_return(struct acpi_walk_state *walk_state)
72 ACPI_FUNCTION_NAME(ds_clear_implicit_return);
75 * Slack must be enabled for this feature
77 if (!acpi_gbl_enable_interpreter_slack) {
81 if (walk_state->implicit_return_obj) {
83 * Delete any "stale" implicit return. However, in
84 * complex statements, the implicit return value can be
85 * bubbled up several levels.
87 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
88 "Removing reference on stale implicit return obj %p\n",
89 walk_state->implicit_return_obj));
91 acpi_ut_remove_reference(walk_state->implicit_return_obj);
92 walk_state->implicit_return_obj = NULL;
96 #ifndef ACPI_NO_METHOD_EXECUTION
97 /*******************************************************************************
99 * FUNCTION: acpi_ds_do_implicit_return
101 * PARAMETERS: return_desc - The return value
102 * walk_state - Current State
103 * add_reference - True if a reference should be added to the
106 * RETURN: TRUE if implicit return enabled, FALSE otherwise
108 * DESCRIPTION: Implements the optional "implicit return". We save the result
109 * of every ASL operator and control method invocation in case the
110 * parent method exit. Before storing a new return value, we
111 * delete the previous return value.
113 ******************************************************************************/
116 acpi_ds_do_implicit_return(union acpi_operand_object *return_desc,
117 struct acpi_walk_state *walk_state, u8 add_reference)
119 ACPI_FUNCTION_NAME(ds_do_implicit_return);
122 * Slack must be enabled for this feature, and we must
123 * have a valid return object
125 if ((!acpi_gbl_enable_interpreter_slack) || (!return_desc)) {
129 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
130 "Result %p will be implicitly returned; Prev=%p\n",
131 return_desc, walk_state->implicit_return_obj));
134 * Delete any "stale" implicit return value first. However, in
135 * complex statements, the implicit return value can be
136 * bubbled up several levels, so we don't clear the value if it
137 * is the same as the return_desc.
139 if (walk_state->implicit_return_obj) {
140 if (walk_state->implicit_return_obj == return_desc) {
143 acpi_ds_clear_implicit_return(walk_state);
146 /* Save the implicit return value, add a reference if requested */
148 walk_state->implicit_return_obj = return_desc;
150 acpi_ut_add_reference(return_desc);
156 /*******************************************************************************
158 * FUNCTION: acpi_ds_is_result_used
160 * PARAMETERS: Op - Current Op
161 * walk_state - Current State
163 * RETURN: TRUE if result is used, FALSE otherwise
165 * DESCRIPTION: Check if a result object will be used by the parent
167 ******************************************************************************/
170 acpi_ds_is_result_used(union acpi_parse_object * op,
171 struct acpi_walk_state * walk_state)
173 const struct acpi_opcode_info *parent_info;
175 ACPI_FUNCTION_TRACE_PTR(ds_is_result_used, op);
177 /* Must have both an Op and a Result Object */
180 ACPI_ERROR((AE_INFO, "Null Op"));
185 * We know that this operator is not a
186 * Return() operator (would not come here.) The following code is the
187 * optional support for a so-called "implicit return". Some AML code
188 * assumes that the last value of the method is "implicitly" returned
189 * to the caller. Just save the last result as the return value.
190 * NOTE: this is optional because the ASL language does not actually
191 * support this behavior.
193 (void)acpi_ds_do_implicit_return(walk_state->result_obj, walk_state,
197 * Now determine if the parent will use the result
199 * If there is no parent, or the parent is a scope_op, we are executing
200 * at the method level. An executing method typically has no parent,
201 * since each method is parsed separately. A method invoked externally
202 * via execute_control_method has a scope_op as the parent.
204 if ((!op->common.parent) ||
205 (op->common.parent->common.aml_opcode == AML_SCOPE_OP)) {
207 /* No parent, the return value cannot possibly be used */
209 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
210 "At Method level, result of [%s] not used\n",
211 acpi_ps_get_opcode_name(op->common.
216 /* Get info on the parent. The root_op is AML_SCOPE */
219 acpi_ps_get_opcode_info(op->common.parent->common.aml_opcode);
220 if (parent_info->class == AML_CLASS_UNKNOWN) {
221 ACPI_ERROR((AE_INFO, "Unknown parent opcode Op=%p", op));
226 * Decide what to do with the result based on the parent. If
227 * the parent opcode will not use the result, delete the object.
228 * Otherwise leave it as is, it will be deleted when it is used
229 * as an operand later.
231 switch (parent_info->class) {
232 case AML_CLASS_CONTROL:
234 switch (op->common.parent->common.aml_opcode) {
237 /* Never delete the return value associated with a return opcode */
245 * If we are executing the predicate AND this is the predicate op,
246 * we will use the return value
248 if ((walk_state->control_state->common.state ==
249 ACPI_CONTROL_PREDICATE_EXECUTING)
250 && (walk_state->control_state->control.
251 predicate_op == op)) {
257 /* Ignore other control opcodes */
261 /* The general control opcode returns no result */
263 goto result_not_used;
265 case AML_CLASS_CREATE:
268 * These opcodes allow term_arg(s) as operands and therefore
269 * the operands can be method calls. The result is used.
273 case AML_CLASS_NAMED_OBJECT:
275 if ((op->common.parent->common.aml_opcode == AML_REGION_OP) ||
276 (op->common.parent->common.aml_opcode == AML_DATA_REGION_OP)
277 || (op->common.parent->common.aml_opcode == AML_PACKAGE_OP)
278 || (op->common.parent->common.aml_opcode ==
280 || (op->common.parent->common.aml_opcode == AML_BUFFER_OP)
281 || (op->common.parent->common.aml_opcode ==
282 AML_INT_EVAL_SUBTREE_OP)
283 || (op->common.parent->common.aml_opcode ==
284 AML_BANK_FIELD_OP)) {
286 * These opcodes allow term_arg(s) as operands and therefore
287 * the operands can be method calls. The result is used.
292 goto result_not_used;
297 * In all other cases. the parent will actually use the return
298 * object, so keep it.
304 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
305 "Result of [%s] used by Parent [%s] Op=%p\n",
306 acpi_ps_get_opcode_name(op->common.aml_opcode),
307 acpi_ps_get_opcode_name(op->common.parent->common.
313 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
314 "Result of [%s] not used by Parent [%s] Op=%p\n",
315 acpi_ps_get_opcode_name(op->common.aml_opcode),
316 acpi_ps_get_opcode_name(op->common.parent->common.
322 /*******************************************************************************
324 * FUNCTION: acpi_ds_delete_result_if_not_used
326 * PARAMETERS: Op - Current parse Op
327 * result_obj - Result of the operation
328 * walk_state - Current state
332 * DESCRIPTION: Used after interpretation of an opcode. If there is an internal
333 * result descriptor, check if the parent opcode will actually use
334 * this result. If not, delete the result now so that it will
335 * not become orphaned.
337 ******************************************************************************/
340 acpi_ds_delete_result_if_not_used(union acpi_parse_object *op,
341 union acpi_operand_object *result_obj,
342 struct acpi_walk_state *walk_state)
344 union acpi_operand_object *obj_desc;
347 ACPI_FUNCTION_TRACE_PTR(ds_delete_result_if_not_used, result_obj);
350 ACPI_ERROR((AE_INFO, "Null Op"));
358 if (!acpi_ds_is_result_used(op, walk_state)) {
360 /* Must pop the result stack (obj_desc should be equal to result_obj) */
362 status = acpi_ds_result_pop(&obj_desc, walk_state);
363 if (ACPI_SUCCESS(status)) {
364 acpi_ut_remove_reference(result_obj);
371 /*******************************************************************************
373 * FUNCTION: acpi_ds_resolve_operands
375 * PARAMETERS: walk_state - Current walk state with operands on stack
379 * DESCRIPTION: Resolve all operands to their values. Used to prepare
380 * arguments to a control method invocation (a call from one
381 * method to another.)
383 ******************************************************************************/
385 acpi_status acpi_ds_resolve_operands(struct acpi_walk_state *walk_state)
388 acpi_status status = AE_OK;
390 ACPI_FUNCTION_TRACE_PTR(ds_resolve_operands, walk_state);
393 * Attempt to resolve each of the valid operands
394 * Method arguments are passed by reference, not by value. This means
395 * that the actual objects are passed, not copies of the objects.
397 for (i = 0; i < walk_state->num_operands; i++) {
399 acpi_ex_resolve_to_value(&walk_state->operands[i],
401 if (ACPI_FAILURE(status)) {
406 return_ACPI_STATUS(status);
409 /*******************************************************************************
411 * FUNCTION: acpi_ds_clear_operands
413 * PARAMETERS: walk_state - Current walk state with operands on stack
417 * DESCRIPTION: Clear all operands on the current walk state operand stack.
419 ******************************************************************************/
421 void acpi_ds_clear_operands(struct acpi_walk_state *walk_state)
425 ACPI_FUNCTION_TRACE_PTR(ds_clear_operands, walk_state);
427 /* Remove a reference on each operand on the stack */
429 for (i = 0; i < walk_state->num_operands; i++) {
431 * Remove a reference to all operands, including both
432 * "Arguments" and "Targets".
434 acpi_ut_remove_reference(walk_state->operands[i]);
435 walk_state->operands[i] = NULL;
438 walk_state->num_operands = 0;
443 /*******************************************************************************
445 * FUNCTION: acpi_ds_create_operand
447 * PARAMETERS: walk_state - Current walk state
448 * Arg - Parse object for the argument
449 * arg_index - Which argument (zero based)
453 * DESCRIPTION: Translate a parse tree object that is an argument to an AML
454 * opcode to the equivalent interpreter object. This may include
455 * looking up a name or entering a new name into the internal
458 ******************************************************************************/
461 acpi_ds_create_operand(struct acpi_walk_state *walk_state,
462 union acpi_parse_object *arg, u32 arg_index)
464 acpi_status status = AE_OK;
467 union acpi_operand_object *obj_desc;
468 union acpi_parse_object *parent_op;
470 acpi_interpreter_mode interpreter_mode;
471 const struct acpi_opcode_info *op_info;
473 ACPI_FUNCTION_TRACE_PTR(ds_create_operand, arg);
475 /* A valid name must be looked up in the namespace */
477 if ((arg->common.aml_opcode == AML_INT_NAMEPATH_OP) &&
478 (arg->common.value.string) &&
479 !(arg->common.flags & ACPI_PARSEOP_IN_STACK)) {
480 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH, "Getting a name: Arg=%p\n",
483 /* Get the entire name string from the AML stream */
486 acpi_ex_get_name_string(ACPI_TYPE_ANY,
487 arg->common.value.buffer,
488 &name_string, &name_length);
490 if (ACPI_FAILURE(status)) {
491 return_ACPI_STATUS(status);
494 /* All prefixes have been handled, and the name is in name_string */
497 * Special handling for buffer_field declarations. This is a deferred
498 * opcode that unfortunately defines the field name as the last
499 * parameter instead of the first. We get here when we are performing
500 * the deferred execution, so the actual name of the field is already
501 * in the namespace. We don't want to attempt to look it up again
502 * because we may be executing in a different scope than where the
503 * actual opcode exists.
505 if ((walk_state->deferred_node) &&
506 (walk_state->deferred_node->type == ACPI_TYPE_BUFFER_FIELD)
508 (u32) ((walk_state->opcode ==
509 AML_CREATE_FIELD_OP) ? 3 : 2))) {
511 ACPI_CAST_PTR(union acpi_operand_object,
512 walk_state->deferred_node);
514 } else { /* All other opcodes */
517 * Differentiate between a namespace "create" operation
518 * versus a "lookup" operation (IMODE_LOAD_PASS2 vs.
519 * IMODE_EXECUTE) in order to support the creation of
520 * namespace objects during the execution of control methods.
522 parent_op = arg->common.parent;
524 acpi_ps_get_opcode_info(parent_op->common.
526 if ((op_info->flags & AML_NSNODE)
527 && (parent_op->common.aml_opcode !=
528 AML_INT_METHODCALL_OP)
529 && (parent_op->common.aml_opcode != AML_REGION_OP)
530 && (parent_op->common.aml_opcode !=
531 AML_INT_NAMEPATH_OP)) {
533 /* Enter name into namespace if not found */
535 interpreter_mode = ACPI_IMODE_LOAD_PASS2;
537 /* Return a failure if name not found */
539 interpreter_mode = ACPI_IMODE_EXECUTE;
543 acpi_ns_lookup(walk_state->scope_info, name_string,
544 ACPI_TYPE_ANY, interpreter_mode,
545 ACPI_NS_SEARCH_PARENT |
546 ACPI_NS_DONT_OPEN_SCOPE, walk_state,
547 ACPI_CAST_INDIRECT_PTR(struct
551 * The only case where we pass through (ignore) a NOT_FOUND
552 * error is for the cond_ref_of opcode.
554 if (status == AE_NOT_FOUND) {
555 if (parent_op->common.aml_opcode ==
556 AML_COND_REF_OF_OP) {
558 * For the Conditional Reference op, it's OK if
559 * the name is not found; We just need a way to
560 * indicate this to the interpreter, set the
563 obj_desc = ACPI_CAST_PTR(union
569 * We just plain didn't find it -- which is a
570 * very serious error at this point
572 status = AE_AML_NAME_NOT_FOUND;
576 if (ACPI_FAILURE(status)) {
577 ACPI_ERROR_NAMESPACE(name_string, status);
581 /* Free the namestring created above */
583 ACPI_FREE(name_string);
585 /* Check status from the lookup */
587 if (ACPI_FAILURE(status)) {
588 return_ACPI_STATUS(status);
591 /* Put the resulting object onto the current object stack */
593 status = acpi_ds_obj_stack_push(obj_desc, walk_state);
594 if (ACPI_FAILURE(status)) {
595 return_ACPI_STATUS(status);
597 ACPI_DEBUGGER_EXEC(acpi_db_display_argument_object
598 (obj_desc, walk_state));
600 /* Check for null name case */
602 if ((arg->common.aml_opcode == AML_INT_NAMEPATH_OP) &&
603 !(arg->common.flags & ACPI_PARSEOP_IN_STACK)) {
605 * If the name is null, this means that this is an
606 * optional result parameter that was not specified
607 * in the original ASL. Create a Zero Constant for a
608 * placeholder. (Store to a constant is a Noop.)
610 opcode = AML_ZERO_OP; /* Has no arguments! */
612 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
613 "Null namepath: Arg=%p\n", arg));
615 opcode = arg->common.aml_opcode;
618 /* Get the object type of the argument */
620 op_info = acpi_ps_get_opcode_info(opcode);
621 if (op_info->object_type == ACPI_TYPE_INVALID) {
622 return_ACPI_STATUS(AE_NOT_IMPLEMENTED);
625 if ((op_info->flags & AML_HAS_RETVAL)
626 || (arg->common.flags & ACPI_PARSEOP_IN_STACK)) {
627 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
628 "Argument previously created, already stacked\n"));
630 ACPI_DEBUGGER_EXEC(acpi_db_display_argument_object
632 operands[walk_state->num_operands -
636 * Use value that was already previously returned
637 * by the evaluation of this argument
639 status = acpi_ds_result_pop(&obj_desc, walk_state);
640 if (ACPI_FAILURE(status)) {
642 * Only error is underflow, and this indicates
643 * a missing or null operand!
645 ACPI_EXCEPTION((AE_INFO, status,
646 "Missing or null operand"));
647 return_ACPI_STATUS(status);
650 /* Create an ACPI_INTERNAL_OBJECT for the argument */
653 acpi_ut_create_internal_object(op_info->
656 return_ACPI_STATUS(AE_NO_MEMORY);
659 /* Initialize the new object */
662 acpi_ds_init_object_from_op(walk_state, arg, opcode,
664 if (ACPI_FAILURE(status)) {
665 acpi_ut_delete_object_desc(obj_desc);
666 return_ACPI_STATUS(status);
670 /* Put the operand object on the object stack */
672 status = acpi_ds_obj_stack_push(obj_desc, walk_state);
673 if (ACPI_FAILURE(status)) {
674 return_ACPI_STATUS(status);
677 ACPI_DEBUGGER_EXEC(acpi_db_display_argument_object
678 (obj_desc, walk_state));
681 return_ACPI_STATUS(AE_OK);
684 /*******************************************************************************
686 * FUNCTION: acpi_ds_create_operands
688 * PARAMETERS: walk_state - Current state
689 * first_arg - First argument of a parser argument tree
693 * DESCRIPTION: Convert an operator's arguments from a parse tree format to
694 * namespace objects and place those argument object on the object
695 * stack in preparation for evaluation by the interpreter.
697 ******************************************************************************/
700 acpi_ds_create_operands(struct acpi_walk_state *walk_state,
701 union acpi_parse_object *first_arg)
703 acpi_status status = AE_OK;
704 union acpi_parse_object *arg;
705 union acpi_parse_object *arguments[ACPI_OBJ_NUM_OPERANDS];
707 u32 index = walk_state->num_operands;
710 ACPI_FUNCTION_TRACE_PTR(ds_create_operands, first_arg);
712 /* Get all arguments in the list */
716 if (index >= ACPI_OBJ_NUM_OPERANDS) {
717 return_ACPI_STATUS(AE_BAD_DATA);
720 arguments[index] = arg;
721 walk_state->operands[index] = NULL;
723 /* Move on to next argument, if any */
725 arg = arg->common.next;
732 /* It is the appropriate order to get objects from the Result stack */
734 for (i = 0; i < arg_count; i++) {
735 arg = arguments[index];
737 /* Force the filling of the operand stack in inverse order */
739 walk_state->operand_index = (u8) index;
741 status = acpi_ds_create_operand(walk_state, arg, index);
742 if (ACPI_FAILURE(status)) {
748 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
749 "Arg #%u (%p) done, Arg1=%p\n", index, arg,
753 return_ACPI_STATUS(status);
757 * We must undo everything done above; meaning that we must
758 * pop everything off of the operand stack and delete those
761 acpi_ds_obj_stack_pop_and_delete(arg_count, walk_state);
763 ACPI_EXCEPTION((AE_INFO, status, "While creating Arg %u", index));
764 return_ACPI_STATUS(status);
767 /*****************************************************************************
769 * FUNCTION: acpi_ds_evaluate_name_path
771 * PARAMETERS: walk_state - Current state of the parse tree walk,
772 * the opcode of current operation should be
773 * AML_INT_NAMEPATH_OP
777 * DESCRIPTION: Translate the -name_path- parse tree object to the equivalent
778 * interpreter object, convert it to value, if needed, duplicate
779 * it, if needed, and push it onto the current result stack.
781 ****************************************************************************/
783 acpi_status acpi_ds_evaluate_name_path(struct acpi_walk_state *walk_state)
785 acpi_status status = AE_OK;
786 union acpi_parse_object *op = walk_state->op;
787 union acpi_operand_object **operand = &walk_state->operands[0];
788 union acpi_operand_object *new_obj_desc;
791 ACPI_FUNCTION_TRACE_PTR(ds_evaluate_name_path, walk_state);
793 if (!op->common.parent) {
795 /* This happens after certain exception processing */
800 if ((op->common.parent->common.aml_opcode == AML_PACKAGE_OP) ||
801 (op->common.parent->common.aml_opcode == AML_VAR_PACKAGE_OP) ||
802 (op->common.parent->common.aml_opcode == AML_REF_OF_OP)) {
804 /* TBD: Should we specify this feature as a bit of op_info->Flags of these opcodes? */
809 status = acpi_ds_create_operand(walk_state, op, 0);
810 if (ACPI_FAILURE(status)) {
814 if (op->common.flags & ACPI_PARSEOP_TARGET) {
815 new_obj_desc = *operand;
819 type = (*operand)->common.type;
821 status = acpi_ex_resolve_to_value(operand, walk_state);
822 if (ACPI_FAILURE(status)) {
826 if (type == ACPI_TYPE_INTEGER) {
828 /* It was incremented by acpi_ex_resolve_to_value */
830 acpi_ut_remove_reference(*operand);
833 acpi_ut_copy_iobject_to_iobject(*operand, &new_obj_desc,
835 if (ACPI_FAILURE(status)) {
840 * The object either was anew created or is
841 * a Namespace node - don't decrement it.
843 new_obj_desc = *operand;
846 /* Cleanup for name-path operand */
848 status = acpi_ds_obj_stack_pop(1, walk_state);
849 if (ACPI_FAILURE(status)) {
850 walk_state->result_obj = new_obj_desc;
856 walk_state->result_obj = new_obj_desc;
858 status = acpi_ds_result_push(walk_state->result_obj, walk_state);
859 if (ACPI_SUCCESS(status)) {
861 /* Force to take it from stack */
863 op->common.flags |= ACPI_PARSEOP_IN_STACK;
868 return_ACPI_STATUS(status);