1 /******************************************************************************
3 * Module Name: dswexec - Dispatcher method execution callbacks;
4 * dispatch to interpreter.
6 *****************************************************************************/
9 * Copyright (C) 2000 - 2006, R. Byron Moore
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>
46 #include <acpi/acparser.h>
47 #include <acpi/amlcode.h>
48 #include <acpi/acdispat.h>
49 #include <acpi/acinterp.h>
50 #include <acpi/acnamesp.h>
51 #include <acpi/acdebug.h>
52 #include <acpi/acdisasm.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_REPORT_ERROR(("Could not get result from predicate evaluation, %s\n", acpi_format_exception(status)));
105 return_ACPI_STATUS(status);
108 status = acpi_ds_create_operand(walk_state, walk_state->op, 0);
109 if (ACPI_FAILURE(status)) {
110 return_ACPI_STATUS(status);
114 acpi_ex_resolve_to_value(&walk_state->operands[0],
116 if (ACPI_FAILURE(status)) {
117 return_ACPI_STATUS(status);
120 obj_desc = walk_state->operands[0];
124 ACPI_REPORT_ERROR(("No predicate obj_desc=%p State=%p\n",
125 obj_desc, walk_state));
127 return_ACPI_STATUS(AE_AML_NO_OPERAND);
131 * Result of predicate evaluation must be an Integer
132 * object. Implicitly convert the argument if necessary.
134 status = acpi_ex_convert_to_integer(obj_desc, &local_obj_desc, 16);
135 if (ACPI_FAILURE(status)) {
139 if (ACPI_GET_OBJECT_TYPE(local_obj_desc) != ACPI_TYPE_INTEGER) {
140 ACPI_REPORT_ERROR(("Bad predicate (not an integer) obj_desc=%p State=%p Type=%X\n", obj_desc, walk_state, ACPI_GET_OBJECT_TYPE(obj_desc)));
142 status = AE_AML_OPERAND_TYPE;
146 /* Truncate the predicate to 32-bits if necessary */
148 acpi_ex_truncate_for32bit_table(local_obj_desc);
151 * Save the result of the predicate evaluation on
154 if (local_obj_desc->integer.value) {
155 walk_state->control_state->common.value = TRUE;
158 * Predicate is FALSE, we will just toss the
159 * rest of the package
161 walk_state->control_state->common.value = FALSE;
162 status = AE_CTRL_FALSE;
167 ACPI_DEBUG_PRINT((ACPI_DB_EXEC, "Completed a predicate eval=%X Op=%p\n",
168 walk_state->control_state->common.value,
171 /* Break to debugger to display result */
173 ACPI_DEBUGGER_EXEC(acpi_db_display_result_object
174 (local_obj_desc, walk_state));
177 * Delete the predicate result object (we know that
178 * we don't need it anymore)
180 if (local_obj_desc != obj_desc) {
181 acpi_ut_remove_reference(local_obj_desc);
183 acpi_ut_remove_reference(obj_desc);
185 walk_state->control_state->common.state = ACPI_CONTROL_NORMAL;
186 return_ACPI_STATUS(status);
189 /*****************************************************************************
191 * FUNCTION: acpi_ds_exec_begin_op
193 * PARAMETERS: walk_state - Current state of the parse tree walk
194 * out_op - Where to return op if a new one is created
198 * DESCRIPTION: Descending callback used during the execution of control
199 * methods. This is where most operators and operands are
200 * dispatched to the interpreter.
202 ****************************************************************************/
205 acpi_ds_exec_begin_op(struct acpi_walk_state *walk_state,
206 union acpi_parse_object **out_op)
208 union acpi_parse_object *op;
209 acpi_status status = AE_OK;
212 ACPI_FUNCTION_TRACE_PTR("ds_exec_begin_op", walk_state);
216 status = acpi_ds_load2_begin_op(walk_state, out_op);
217 if (ACPI_FAILURE(status)) {
218 return_ACPI_STATUS(status);
223 walk_state->opcode = op->common.aml_opcode;
224 walk_state->op_info =
225 acpi_ps_get_opcode_info(op->common.aml_opcode);
227 if (acpi_ns_opens_scope(walk_state->op_info->object_type)) {
228 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
229 "(%s) Popping scope for Op %p\n",
230 acpi_ut_get_type_name(walk_state->
235 status = acpi_ds_scope_stack_pop(walk_state);
236 if (ACPI_FAILURE(status)) {
237 return_ACPI_STATUS(status);
242 if (op == walk_state->origin) {
247 return_ACPI_STATUS(AE_OK);
251 * If the previous opcode was a conditional, this opcode
252 * must be the beginning of the associated predicate.
253 * Save this knowledge in the current scope descriptor
255 if ((walk_state->control_state) &&
256 (walk_state->control_state->common.state ==
257 ACPI_CONTROL_CONDITIONAL_EXECUTING)) {
258 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
259 "Exec predicate Op=%p State=%p\n", op,
262 walk_state->control_state->common.state =
263 ACPI_CONTROL_PREDICATE_EXECUTING;
265 /* Save start of predicate */
267 walk_state->control_state->control.predicate_op = op;
270 opcode_class = walk_state->op_info->class;
272 /* We want to send namepaths to the load code */
274 if (op->common.aml_opcode == AML_INT_NAMEPATH_OP) {
275 opcode_class = AML_CLASS_NAMED_OBJECT;
279 * Handle the opcode based upon the opcode type
281 switch (opcode_class) {
282 case AML_CLASS_CONTROL:
284 status = acpi_ds_result_stack_push(walk_state);
285 if (ACPI_FAILURE(status)) {
286 return_ACPI_STATUS(status);
289 status = acpi_ds_exec_begin_control_op(walk_state, op);
292 case AML_CLASS_NAMED_OBJECT:
294 if (walk_state->walk_type == ACPI_WALK_METHOD) {
296 * Found a named object declaration during method execution;
297 * we must enter this object into the namespace. The created
298 * object is temporary and will be deleted upon completion of
299 * the execution of this method.
301 status = acpi_ds_load2_begin_op(walk_state, NULL);
304 if (op->common.aml_opcode == AML_REGION_OP) {
305 status = acpi_ds_result_stack_push(walk_state);
309 case AML_CLASS_EXECUTE:
310 case AML_CLASS_CREATE:
312 * Most operators with arguments.
313 * Start a new result/operand state
315 if (walk_state->opcode != AML_CREATE_FIELD_OP) {
316 status = acpi_ds_result_stack_push(walk_state);
324 /* Nothing to do here during method execution */
326 return_ACPI_STATUS(status);
329 /*****************************************************************************
331 * FUNCTION: acpi_ds_exec_end_op
333 * PARAMETERS: walk_state - Current state of the parse tree walk
337 * DESCRIPTION: Ascending callback used during the execution of control
338 * methods. The only thing we really need to do here is to
339 * notice the beginning of IF, ELSE, and WHILE blocks.
341 ****************************************************************************/
343 acpi_status acpi_ds_exec_end_op(struct acpi_walk_state *walk_state)
345 union acpi_parse_object *op;
346 acpi_status status = AE_OK;
349 union acpi_parse_object *next_op;
350 union acpi_parse_object *first_arg;
352 ACPI_FUNCTION_TRACE_PTR("ds_exec_end_op", walk_state);
355 op_type = walk_state->op_info->type;
356 op_class = walk_state->op_info->class;
358 if (op_class == AML_CLASS_UNKNOWN) {
359 ACPI_REPORT_ERROR(("Unknown opcode %X\n",
360 op->common.aml_opcode));
361 return_ACPI_STATUS(AE_NOT_IMPLEMENTED);
364 first_arg = op->common.value.arg;
366 /* Init the walk state */
368 walk_state->num_operands = 0;
369 walk_state->return_desc = NULL;
370 walk_state->result_obj = NULL;
372 /* Call debugger for single step support (DEBUG build only) */
374 ACPI_DEBUGGER_EXEC(status =
375 acpi_db_single_step(walk_state, op, op_class));
376 ACPI_DEBUGGER_EXEC(if (ACPI_FAILURE(status)) {
377 return_ACPI_STATUS(status);}
380 /* Decode the Opcode Class */
383 case AML_CLASS_ARGUMENT: /* constants, literals, etc. - do nothing */
386 case AML_CLASS_EXECUTE: /* most operators with arguments */
388 /* Build resolved operand stack */
390 status = acpi_ds_create_operands(walk_state, first_arg);
391 if (ACPI_FAILURE(status)) {
395 /* Done with this result state (Now that operand stack is built) */
397 status = acpi_ds_result_stack_pop(walk_state);
398 if (ACPI_FAILURE(status)) {
403 * All opcodes require operand resolution, with the only exceptions
404 * being the object_type and size_of operators.
406 if (!(walk_state->op_info->flags & AML_NO_OPERAND_RESOLVE)) {
407 /* Resolve all operands */
409 status = acpi_ex_resolve_operands(walk_state->opcode,
415 if (ACPI_SUCCESS(status)) {
416 ACPI_DUMP_OPERANDS(ACPI_WALK_OPERANDS,
418 acpi_ps_get_opcode_name
419 (walk_state->opcode),
420 walk_state->num_operands,
421 "after ex_resolve_operands");
425 if (ACPI_SUCCESS(status)) {
427 * Dispatch the request to the appropriate interpreter handler
428 * routine. There is one routine per opcode "type" based upon the
429 * number of opcode arguments and return type.
432 acpi_gbl_op_type_dispatch[op_type] (walk_state);
435 * Treat constructs of the form "Store(local_x,local_x)" as noops when the
436 * Local is uninitialized.
438 if ((status == AE_AML_UNINITIALIZED_LOCAL) &&
439 (walk_state->opcode == AML_STORE_OP) &&
440 (walk_state->operands[0]->common.type ==
441 ACPI_TYPE_LOCAL_REFERENCE)
442 && (walk_state->operands[1]->common.type ==
443 ACPI_TYPE_LOCAL_REFERENCE)
444 && (walk_state->operands[0]->reference.opcode ==
445 walk_state->operands[1]->reference.opcode)
446 && (walk_state->operands[0]->reference.offset ==
447 walk_state->operands[1]->reference.offset)) {
450 ACPI_REPORT_ERROR(("[%s]: Could not resolve operands, %s\n", acpi_ps_get_opcode_name(walk_state->opcode), acpi_format_exception(status)));
454 /* Always delete the argument objects and clear the operand stack */
456 acpi_ds_clear_operands(walk_state);
459 * If a result object was returned from above, push it on the
460 * current result stack
462 if (ACPI_SUCCESS(status) && walk_state->result_obj) {
464 acpi_ds_result_push(walk_state->result_obj,
473 case AML_TYPE_CONTROL: /* Type 1 opcode, IF/ELSE/WHILE/NOOP */
475 /* 1 Operand, 0 external_result, 0 internal_result */
477 status = acpi_ds_exec_end_control_op(walk_state, op);
479 /* Make sure to properly pop the result stack */
481 if (ACPI_SUCCESS(status)) {
482 status = acpi_ds_result_stack_pop(walk_state);
483 } else if (status == AE_CTRL_PENDING) {
484 status = acpi_ds_result_stack_pop(walk_state);
485 if (ACPI_SUCCESS(status)) {
486 status = AE_CTRL_PENDING;
491 case AML_TYPE_METHOD_CALL:
494 * If the method is referenced from within a package
495 * declaration, it is not a invocation of the method, just
498 if ((op->asl.parent) &&
499 ((op->asl.parent->asl.aml_opcode == AML_PACKAGE_OP)
500 || (op->asl.parent->asl.aml_opcode ==
501 AML_VAR_PACKAGE_OP))) {
502 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
503 "Method Reference in a Package, Op=%p\n",
506 (struct acpi_namespace_node *)op->asl.value.
507 arg->asl.node->object;
508 acpi_ut_add_reference(op->asl.value.arg->asl.
510 return_ACPI_STATUS(AE_OK);
513 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
514 "Method invocation, Op=%p\n", op));
517 * (AML_METHODCALL) Op->Asl.Value.Arg->Asl.Node contains
518 * the method Node pointer
520 /* next_op points to the op that holds the method name */
524 /* next_op points to first argument op */
526 next_op = next_op->common.next;
529 * Get the method's arguments and put them on the operand stack
531 status = acpi_ds_create_operands(walk_state, next_op);
532 if (ACPI_FAILURE(status)) {
537 * Since the operands will be passed to another control method,
538 * we must resolve all local references here (Local variables,
539 * arguments to *this* method, etc.)
541 status = acpi_ds_resolve_operands(walk_state);
542 if (ACPI_FAILURE(status)) {
543 /* On error, clear all resolved operands */
545 acpi_ds_clear_operands(walk_state);
550 * Tell the walk loop to preempt this running method and
551 * execute the new method
553 status = AE_CTRL_TRANSFER;
556 * Return now; we don't want to disturb anything,
557 * especially the operand count!
559 return_ACPI_STATUS(status);
561 case AML_TYPE_CREATE_FIELD:
563 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
564 "Executing create_field Buffer/Index Op=%p\n",
567 status = acpi_ds_load2_end_op(walk_state);
568 if (ACPI_FAILURE(status)) {
573 acpi_ds_eval_buffer_field_operands(walk_state, op);
576 case AML_TYPE_CREATE_OBJECT:
578 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
579 "Executing create_object (Buffer/Package) Op=%p\n",
582 switch (op->common.parent->common.aml_opcode) {
586 * Put the Node on the object stack (Contains the ACPI Name
589 walk_state->operands[0] =
590 (void *)op->common.parent->common.node;
591 walk_state->num_operands = 1;
593 status = acpi_ds_create_node(walk_state,
597 if (ACPI_FAILURE(status)) {
602 /*lint -fallthrough */
604 case AML_INT_EVAL_SUBTREE_OP:
607 acpi_ds_eval_data_object_operands
609 acpi_ns_get_attached_object(op->common.
617 acpi_ds_eval_data_object_operands
618 (walk_state, op, NULL);
622 /* Done with result state (Now that operand stack is built) */
624 status = acpi_ds_result_stack_pop(walk_state);
625 if (ACPI_FAILURE(status)) {
630 * If a result object was returned from above, push it on the
631 * current result stack
633 if (walk_state->result_obj) {
635 acpi_ds_result_push(walk_state->result_obj,
640 case AML_TYPE_NAMED_FIELD:
641 case AML_TYPE_NAMED_COMPLEX:
642 case AML_TYPE_NAMED_SIMPLE:
643 case AML_TYPE_NAMED_NO_OBJ:
645 status = acpi_ds_load2_end_op(walk_state);
646 if (ACPI_FAILURE(status)) {
650 if (op->common.aml_opcode == AML_REGION_OP) {
651 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
652 "Executing op_region Address/Length Op=%p\n",
656 acpi_ds_eval_region_operands(walk_state,
658 if (ACPI_FAILURE(status)) {
662 status = acpi_ds_result_stack_pop(walk_state);
667 case AML_TYPE_UNDEFINED:
669 ACPI_REPORT_ERROR(("Undefined opcode type Op=%p\n",
671 return_ACPI_STATUS(AE_NOT_IMPLEMENTED);
675 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
676 "Internal opcode=%X type Op=%p\n",
677 walk_state->opcode, op));
682 ACPI_REPORT_ERROR(("Unimplemented opcode, class=%X type=%X Opcode=%X Op=%p\n", op_class, op_type, op->common.aml_opcode, op));
684 status = AE_NOT_IMPLEMENTED;
690 * ACPI 2.0 support for 64-bit integers: Truncate numeric
691 * result value if we are executing from a 32-bit ACPI table
693 acpi_ex_truncate_for32bit_table(walk_state->result_obj);
696 * Check if we just completed the evaluation of a
697 * conditional predicate
700 if ((ACPI_SUCCESS(status)) &&
701 (walk_state->control_state) &&
702 (walk_state->control_state->common.state ==
703 ACPI_CONTROL_PREDICATE_EXECUTING) &&
704 (walk_state->control_state->control.predicate_op == op)) {
706 acpi_ds_get_predicate_value(walk_state,
707 walk_state->result_obj);
708 walk_state->result_obj = NULL;
713 if (walk_state->result_obj) {
714 /* Break to debugger to display result */
716 ACPI_DEBUGGER_EXEC(acpi_db_display_result_object
717 (walk_state->result_obj, walk_state));
720 * Delete the result op if and only if:
721 * Parent will not use the result -- such as any
722 * non-nested type2 op in a method (parent will be method)
724 acpi_ds_delete_result_if_not_used(op, walk_state->result_obj,
727 #ifdef _UNDER_DEVELOPMENT
729 if (walk_state->parser_state.aml == walk_state->parser_state.aml_end) {
730 acpi_db_method_end(walk_state);
734 /* Invoke exception handler on error */
736 if (ACPI_FAILURE(status)) {
737 status = acpi_ds_method_error(status, walk_state);
740 /* Always clear the object stack */
742 walk_state->num_operands = 0;
743 return_ACPI_STATUS(status);