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_EXCEPTION((AE_INFO, status,
104 "Could not get result from predicate evaluation"));
106 return_ACPI_STATUS(status);
109 status = acpi_ds_create_operand(walk_state, walk_state->op, 0);
110 if (ACPI_FAILURE(status)) {
111 return_ACPI_STATUS(status);
115 acpi_ex_resolve_to_value(&walk_state->operands[0],
117 if (ACPI_FAILURE(status)) {
118 return_ACPI_STATUS(status);
121 obj_desc = walk_state->operands[0];
126 "No predicate obj_desc=%p State=%p",
127 obj_desc, walk_state));
129 return_ACPI_STATUS(AE_AML_NO_OPERAND);
133 * Result of predicate evaluation must be an Integer
134 * object. Implicitly convert the argument if necessary.
136 status = acpi_ex_convert_to_integer(obj_desc, &local_obj_desc, 16);
137 if (ACPI_FAILURE(status)) {
141 if (ACPI_GET_OBJECT_TYPE(local_obj_desc) != ACPI_TYPE_INTEGER) {
143 "Bad predicate (not an integer) obj_desc=%p State=%p Type=%X",
144 obj_desc, walk_state,
145 ACPI_GET_OBJECT_TYPE(obj_desc)));
147 status = AE_AML_OPERAND_TYPE;
151 /* Truncate the predicate to 32-bits if necessary */
153 acpi_ex_truncate_for32bit_table(local_obj_desc);
156 * Save the result of the predicate evaluation on
159 if (local_obj_desc->integer.value) {
160 walk_state->control_state->common.value = TRUE;
163 * Predicate is FALSE, we will just toss the
164 * rest of the package
166 walk_state->control_state->common.value = FALSE;
167 status = AE_CTRL_FALSE;
172 ACPI_DEBUG_PRINT((ACPI_DB_EXEC, "Completed a predicate eval=%X Op=%p\n",
173 walk_state->control_state->common.value,
176 /* Break to debugger to display result */
178 ACPI_DEBUGGER_EXEC(acpi_db_display_result_object
179 (local_obj_desc, walk_state));
182 * Delete the predicate result object (we know that
183 * we don't need it anymore)
185 if (local_obj_desc != obj_desc) {
186 acpi_ut_remove_reference(local_obj_desc);
188 acpi_ut_remove_reference(obj_desc);
190 walk_state->control_state->common.state = ACPI_CONTROL_NORMAL;
191 return_ACPI_STATUS(status);
194 /*****************************************************************************
196 * FUNCTION: acpi_ds_exec_begin_op
198 * PARAMETERS: walk_state - Current state of the parse tree walk
199 * out_op - Where to return op if a new one is created
203 * DESCRIPTION: Descending callback used during the execution of control
204 * methods. This is where most operators and operands are
205 * dispatched to the interpreter.
207 ****************************************************************************/
210 acpi_ds_exec_begin_op(struct acpi_walk_state *walk_state,
211 union acpi_parse_object **out_op)
213 union acpi_parse_object *op;
214 acpi_status status = AE_OK;
217 ACPI_FUNCTION_TRACE_PTR("ds_exec_begin_op", walk_state);
221 status = acpi_ds_load2_begin_op(walk_state, out_op);
222 if (ACPI_FAILURE(status)) {
223 return_ACPI_STATUS(status);
228 walk_state->opcode = op->common.aml_opcode;
229 walk_state->op_info =
230 acpi_ps_get_opcode_info(op->common.aml_opcode);
232 if (acpi_ns_opens_scope(walk_state->op_info->object_type)) {
233 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
234 "(%s) Popping scope for Op %p\n",
235 acpi_ut_get_type_name(walk_state->
240 status = acpi_ds_scope_stack_pop(walk_state);
241 if (ACPI_FAILURE(status)) {
242 return_ACPI_STATUS(status);
247 if (op == walk_state->origin) {
252 return_ACPI_STATUS(AE_OK);
256 * If the previous opcode was a conditional, this opcode
257 * must be the beginning of the associated predicate.
258 * Save this knowledge in the current scope descriptor
260 if ((walk_state->control_state) &&
261 (walk_state->control_state->common.state ==
262 ACPI_CONTROL_CONDITIONAL_EXECUTING)) {
263 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
264 "Exec predicate Op=%p State=%p\n", op,
267 walk_state->control_state->common.state =
268 ACPI_CONTROL_PREDICATE_EXECUTING;
270 /* Save start of predicate */
272 walk_state->control_state->control.predicate_op = op;
275 opcode_class = walk_state->op_info->class;
277 /* We want to send namepaths to the load code */
279 if (op->common.aml_opcode == AML_INT_NAMEPATH_OP) {
280 opcode_class = AML_CLASS_NAMED_OBJECT;
284 * Handle the opcode based upon the opcode type
286 switch (opcode_class) {
287 case AML_CLASS_CONTROL:
289 status = acpi_ds_result_stack_push(walk_state);
290 if (ACPI_FAILURE(status)) {
291 return_ACPI_STATUS(status);
294 status = acpi_ds_exec_begin_control_op(walk_state, op);
297 case AML_CLASS_NAMED_OBJECT:
299 if (walk_state->walk_type == ACPI_WALK_METHOD) {
301 * Found a named object declaration during method execution;
302 * we must enter this object into the namespace. The created
303 * object is temporary and will be deleted upon completion of
304 * the execution of this method.
306 status = acpi_ds_load2_begin_op(walk_state, NULL);
309 if (op->common.aml_opcode == AML_REGION_OP) {
310 status = acpi_ds_result_stack_push(walk_state);
314 case AML_CLASS_EXECUTE:
315 case AML_CLASS_CREATE:
317 * Most operators with arguments.
318 * Start a new result/operand state
320 if (walk_state->opcode != AML_CREATE_FIELD_OP) {
321 status = acpi_ds_result_stack_push(walk_state);
329 /* Nothing to do here during method execution */
331 return_ACPI_STATUS(status);
334 /*****************************************************************************
336 * FUNCTION: acpi_ds_exec_end_op
338 * PARAMETERS: walk_state - Current state of the parse tree walk
342 * DESCRIPTION: Ascending callback used during the execution of control
343 * methods. The only thing we really need to do here is to
344 * notice the beginning of IF, ELSE, and WHILE blocks.
346 ****************************************************************************/
348 acpi_status acpi_ds_exec_end_op(struct acpi_walk_state *walk_state)
350 union acpi_parse_object *op;
351 acpi_status status = AE_OK;
354 union acpi_parse_object *next_op;
355 union acpi_parse_object *first_arg;
357 ACPI_FUNCTION_TRACE_PTR("ds_exec_end_op", walk_state);
360 op_type = walk_state->op_info->type;
361 op_class = walk_state->op_info->class;
363 if (op_class == AML_CLASS_UNKNOWN) {
364 ACPI_ERROR((AE_INFO, "Unknown opcode %X",
365 op->common.aml_opcode));
366 return_ACPI_STATUS(AE_NOT_IMPLEMENTED);
369 first_arg = op->common.value.arg;
371 /* Init the walk state */
373 walk_state->num_operands = 0;
374 walk_state->return_desc = NULL;
375 walk_state->result_obj = NULL;
377 /* Call debugger for single step support (DEBUG build only) */
379 ACPI_DEBUGGER_EXEC(status =
380 acpi_db_single_step(walk_state, op, op_class));
381 ACPI_DEBUGGER_EXEC(if (ACPI_FAILURE(status)) {
382 return_ACPI_STATUS(status);}
385 /* Decode the Opcode Class */
388 case AML_CLASS_ARGUMENT: /* constants, literals, etc. - do nothing */
391 case AML_CLASS_EXECUTE: /* most operators with arguments */
393 /* Build resolved operand stack */
395 status = acpi_ds_create_operands(walk_state, first_arg);
396 if (ACPI_FAILURE(status)) {
400 /* Done with this result state (Now that operand stack is built) */
402 status = acpi_ds_result_stack_pop(walk_state);
403 if (ACPI_FAILURE(status)) {
408 * All opcodes require operand resolution, with the only exceptions
409 * being the object_type and size_of operators.
411 if (!(walk_state->op_info->flags & AML_NO_OPERAND_RESOLVE)) {
413 /* Resolve all operands */
415 status = acpi_ex_resolve_operands(walk_state->opcode,
421 if (ACPI_SUCCESS(status)) {
422 ACPI_DUMP_OPERANDS(ACPI_WALK_OPERANDS,
424 acpi_ps_get_opcode_name
425 (walk_state->opcode),
426 walk_state->num_operands,
427 "after ex_resolve_operands");
431 if (ACPI_SUCCESS(status)) {
433 * Dispatch the request to the appropriate interpreter handler
434 * routine. There is one routine per opcode "type" based upon the
435 * number of opcode arguments and return type.
438 acpi_gbl_op_type_dispatch[op_type] (walk_state);
441 * Treat constructs of the form "Store(local_x,local_x)" as noops when the
442 * Local is uninitialized.
444 if ((status == AE_AML_UNINITIALIZED_LOCAL) &&
445 (walk_state->opcode == AML_STORE_OP) &&
446 (walk_state->operands[0]->common.type ==
447 ACPI_TYPE_LOCAL_REFERENCE)
448 && (walk_state->operands[1]->common.type ==
449 ACPI_TYPE_LOCAL_REFERENCE)
450 && (walk_state->operands[0]->reference.opcode ==
451 walk_state->operands[1]->reference.opcode)
452 && (walk_state->operands[0]->reference.offset ==
453 walk_state->operands[1]->reference.offset)) {
456 ACPI_EXCEPTION((AE_INFO, status,
457 "While resolving operands for [%s]",
458 acpi_ps_get_opcode_name
459 (walk_state->opcode)));
463 /* Always delete the argument objects and clear the operand stack */
465 acpi_ds_clear_operands(walk_state);
468 * If a result object was returned from above, push it on the
469 * current result stack
471 if (ACPI_SUCCESS(status) && walk_state->result_obj) {
473 acpi_ds_result_push(walk_state->result_obj,
482 case AML_TYPE_CONTROL: /* Type 1 opcode, IF/ELSE/WHILE/NOOP */
484 /* 1 Operand, 0 external_result, 0 internal_result */
486 status = acpi_ds_exec_end_control_op(walk_state, op);
488 /* Make sure to properly pop the result stack */
490 if (ACPI_SUCCESS(status)) {
491 status = acpi_ds_result_stack_pop(walk_state);
492 } else if (status == AE_CTRL_PENDING) {
493 status = acpi_ds_result_stack_pop(walk_state);
494 if (ACPI_SUCCESS(status)) {
495 status = AE_CTRL_PENDING;
500 case AML_TYPE_METHOD_CALL:
503 * If the method is referenced from within a package
504 * declaration, it is not a invocation of the method, just
507 if ((op->asl.parent) &&
508 ((op->asl.parent->asl.aml_opcode == AML_PACKAGE_OP)
509 || (op->asl.parent->asl.aml_opcode ==
510 AML_VAR_PACKAGE_OP))) {
511 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
512 "Method Reference in a Package, Op=%p\n",
515 (struct acpi_namespace_node *)op->asl.value.
516 arg->asl.node->object;
517 acpi_ut_add_reference(op->asl.value.arg->asl.
519 return_ACPI_STATUS(AE_OK);
522 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
523 "Method invocation, Op=%p\n", op));
526 * (AML_METHODCALL) Op->Asl.Value.Arg->Asl.Node contains
527 * the method Node pointer
529 /* next_op points to the op that holds the method name */
533 /* next_op points to first argument op */
535 next_op = next_op->common.next;
538 * Get the method's arguments and put them on the operand stack
540 status = acpi_ds_create_operands(walk_state, next_op);
541 if (ACPI_FAILURE(status)) {
546 * Since the operands will be passed to another control method,
547 * we must resolve all local references here (Local variables,
548 * arguments to *this* method, etc.)
550 status = acpi_ds_resolve_operands(walk_state);
551 if (ACPI_FAILURE(status)) {
553 /* On error, clear all resolved operands */
555 acpi_ds_clear_operands(walk_state);
560 * Tell the walk loop to preempt this running method and
561 * execute the new method
563 status = AE_CTRL_TRANSFER;
566 * Return now; we don't want to disturb anything,
567 * especially the operand count!
569 return_ACPI_STATUS(status);
571 case AML_TYPE_CREATE_FIELD:
573 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
574 "Executing create_field Buffer/Index Op=%p\n",
577 status = acpi_ds_load2_end_op(walk_state);
578 if (ACPI_FAILURE(status)) {
583 acpi_ds_eval_buffer_field_operands(walk_state, op);
586 case AML_TYPE_CREATE_OBJECT:
588 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
589 "Executing create_object (Buffer/Package) Op=%p\n",
592 switch (op->common.parent->common.aml_opcode) {
596 * Put the Node on the object stack (Contains the ACPI Name
599 walk_state->operands[0] =
600 (void *)op->common.parent->common.node;
601 walk_state->num_operands = 1;
603 status = acpi_ds_create_node(walk_state,
607 if (ACPI_FAILURE(status)) {
612 /*lint -fallthrough */
614 case AML_INT_EVAL_SUBTREE_OP:
617 acpi_ds_eval_data_object_operands
619 acpi_ns_get_attached_object(op->common.
627 acpi_ds_eval_data_object_operands
628 (walk_state, op, NULL);
632 /* Done with result state (Now that operand stack is built) */
634 status = acpi_ds_result_stack_pop(walk_state);
635 if (ACPI_FAILURE(status)) {
640 * If a result object was returned from above, push it on the
641 * current result stack
643 if (walk_state->result_obj) {
645 acpi_ds_result_push(walk_state->result_obj,
650 case AML_TYPE_NAMED_FIELD:
651 case AML_TYPE_NAMED_COMPLEX:
652 case AML_TYPE_NAMED_SIMPLE:
653 case AML_TYPE_NAMED_NO_OBJ:
655 status = acpi_ds_load2_end_op(walk_state);
656 if (ACPI_FAILURE(status)) {
660 if (op->common.aml_opcode == AML_REGION_OP) {
661 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
662 "Executing op_region Address/Length Op=%p\n",
666 acpi_ds_eval_region_operands(walk_state,
668 if (ACPI_FAILURE(status)) {
672 status = acpi_ds_result_stack_pop(walk_state);
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=%X type=%X Opcode=%X Op=%p",
694 op_class, op_type, op->common.aml_opcode,
697 status = AE_NOT_IMPLEMENTED;
703 * ACPI 2.0 support for 64-bit integers: Truncate numeric
704 * result value if we are executing from a 32-bit ACPI table
706 acpi_ex_truncate_for32bit_table(walk_state->result_obj);
709 * Check if we just completed the evaluation of a
710 * 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_DEBUGGER_EXEC(acpi_db_display_result_object
731 (walk_state->result_obj, walk_state));
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);