1 /******************************************************************************
3 * Module Name: dswexec - Dispatcher method execution callbacks;
4 * dispatch to interpreter.
6 *****************************************************************************/
9 * Copyright (C) 2000 - 2008, Intel Corp.
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>
53 #define _COMPONENT ACPI_DISPATCHER
54 ACPI_MODULE_NAME("dswexec")
57 * Dispatch table for opcode classes
59 static ACPI_EXECUTE_OP acpi_gbl_op_type_dispatch
[] = {
60 acpi_ex_opcode_0A_0T_1R
,
61 acpi_ex_opcode_1A_0T_0R
,
62 acpi_ex_opcode_1A_0T_1R
,
63 acpi_ex_opcode_1A_1T_0R
,
64 acpi_ex_opcode_1A_1T_1R
,
65 acpi_ex_opcode_2A_0T_0R
,
66 acpi_ex_opcode_2A_0T_1R
,
67 acpi_ex_opcode_2A_1T_1R
,
68 acpi_ex_opcode_2A_2T_1R
,
69 acpi_ex_opcode_3A_0T_0R
,
70 acpi_ex_opcode_3A_1T_1R
,
71 acpi_ex_opcode_6A_0T_1R
74 /*****************************************************************************
76 * FUNCTION: acpi_ds_get_predicate_value
78 * PARAMETERS: walk_state - Current state of the parse tree walk
79 * result_obj - if non-zero, pop result from result stack
83 * DESCRIPTION: Get the result of a predicate evaluation
85 ****************************************************************************/
88 acpi_ds_get_predicate_value(struct acpi_walk_state
*walk_state
,
89 union acpi_operand_object
*result_obj
)
91 acpi_status status
= AE_OK
;
92 union acpi_operand_object
*obj_desc
;
93 union acpi_operand_object
*local_obj_desc
= NULL
;
95 ACPI_FUNCTION_TRACE_PTR(ds_get_predicate_value
, walk_state
);
97 walk_state
->control_state
->common
.state
= 0;
100 status
= acpi_ds_result_pop(&obj_desc
, walk_state
);
101 if (ACPI_FAILURE(status
)) {
102 ACPI_EXCEPTION((AE_INFO
, status
,
103 "Could not get result from predicate evaluation"));
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];
125 "No predicate ObjDesc=%p State=%p",
126 obj_desc
, walk_state
));
128 return_ACPI_STATUS(AE_AML_NO_OPERAND
);
132 * Result of predicate evaluation must be an Integer
133 * object. Implicitly convert the argument if necessary.
135 status
= acpi_ex_convert_to_integer(obj_desc
, &local_obj_desc
, 16);
136 if (ACPI_FAILURE(status
)) {
140 if (ACPI_GET_OBJECT_TYPE(local_obj_desc
) != ACPI_TYPE_INTEGER
) {
142 "Bad predicate (not an integer) ObjDesc=%p State=%p Type=%X",
143 obj_desc
, walk_state
,
144 ACPI_GET_OBJECT_TYPE(obj_desc
)));
146 status
= AE_AML_OPERAND_TYPE
;
150 /* Truncate the predicate to 32-bits if necessary */
152 acpi_ex_truncate_for32bit_table(local_obj_desc
);
155 * Save the result of the predicate evaluation on
158 if (local_obj_desc
->integer
.value
) {
159 walk_state
->control_state
->common
.value
= TRUE
;
162 * Predicate is FALSE, we will just toss the
163 * rest of the package
165 walk_state
->control_state
->common
.value
= FALSE
;
166 status
= AE_CTRL_FALSE
;
169 /* Predicate can be used for an implicit return value */
171 (void)acpi_ds_do_implicit_return(local_obj_desc
, walk_state
, TRUE
);
175 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
, "Completed a predicate eval=%X Op=%p\n",
176 walk_state
->control_state
->common
.value
,
179 /* Break to debugger to display result */
181 ACPI_DEBUGGER_EXEC(acpi_db_display_result_object
182 (local_obj_desc
, walk_state
));
185 * Delete the predicate result object (we know that
186 * we don't need it anymore)
188 if (local_obj_desc
!= obj_desc
) {
189 acpi_ut_remove_reference(local_obj_desc
);
191 acpi_ut_remove_reference(obj_desc
);
193 walk_state
->control_state
->common
.state
= ACPI_CONTROL_NORMAL
;
194 return_ACPI_STATUS(status
);
197 /*****************************************************************************
199 * FUNCTION: acpi_ds_exec_begin_op
201 * PARAMETERS: walk_state - Current state of the parse tree walk
202 * out_op - Where to return op if a new one is created
206 * DESCRIPTION: Descending callback used during the execution of control
207 * methods. This is where most operators and operands are
208 * dispatched to the interpreter.
210 ****************************************************************************/
213 acpi_ds_exec_begin_op(struct acpi_walk_state
*walk_state
,
214 union acpi_parse_object
**out_op
)
216 union acpi_parse_object
*op
;
217 acpi_status status
= AE_OK
;
220 ACPI_FUNCTION_TRACE_PTR(ds_exec_begin_op
, walk_state
);
224 status
= acpi_ds_load2_begin_op(walk_state
, out_op
);
225 if (ACPI_FAILURE(status
)) {
231 walk_state
->opcode
= op
->common
.aml_opcode
;
232 walk_state
->op_info
=
233 acpi_ps_get_opcode_info(op
->common
.aml_opcode
);
235 if (acpi_ns_opens_scope(walk_state
->op_info
->object_type
)) {
236 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH
,
237 "(%s) Popping scope for Op %p\n",
238 acpi_ut_get_type_name(walk_state
->
243 status
= acpi_ds_scope_stack_pop(walk_state
);
244 if (ACPI_FAILURE(status
)) {
250 if (op
== walk_state
->origin
) {
255 return_ACPI_STATUS(AE_OK
);
259 * If the previous opcode was a conditional, this opcode
260 * must be the beginning of the associated predicate.
261 * Save this knowledge in the current scope descriptor
263 if ((walk_state
->control_state
) &&
264 (walk_state
->control_state
->common
.state
==
265 ACPI_CONTROL_CONDITIONAL_EXECUTING
)) {
266 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
,
267 "Exec predicate Op=%p State=%p\n", op
,
270 walk_state
->control_state
->common
.state
=
271 ACPI_CONTROL_PREDICATE_EXECUTING
;
273 /* Save start of predicate */
275 walk_state
->control_state
->control
.predicate_op
= op
;
278 opcode_class
= walk_state
->op_info
->class;
280 /* We want to send namepaths to the load code */
282 if (op
->common
.aml_opcode
== AML_INT_NAMEPATH_OP
) {
283 opcode_class
= AML_CLASS_NAMED_OBJECT
;
287 * Handle the opcode based upon the opcode type
289 switch (opcode_class
) {
290 case AML_CLASS_CONTROL
:
292 status
= acpi_ds_exec_begin_control_op(walk_state
, op
);
295 case AML_CLASS_NAMED_OBJECT
:
297 if (walk_state
->walk_type
& ACPI_WALK_METHOD
) {
299 * Found a named object declaration during method execution;
300 * we must enter this object into the namespace. The created
301 * object is temporary and will be deleted upon completion of
302 * the execution of this method.
304 status
= acpi_ds_load2_begin_op(walk_state
, NULL
);
309 case AML_CLASS_EXECUTE
:
310 case AML_CLASS_CREATE
:
318 /* Nothing to do here during method execution */
320 return_ACPI_STATUS(status
);
323 status
= acpi_ds_method_error(status
, walk_state
);
324 return_ACPI_STATUS(status
);
327 /*****************************************************************************
329 * FUNCTION: acpi_ds_exec_end_op
331 * PARAMETERS: walk_state - Current state of the parse tree walk
335 * DESCRIPTION: Ascending callback used during the execution of control
336 * methods. The only thing we really need to do here is to
337 * notice the beginning of IF, ELSE, and WHILE blocks.
339 ****************************************************************************/
341 acpi_status
acpi_ds_exec_end_op(struct acpi_walk_state
*walk_state
)
343 union acpi_parse_object
*op
;
344 acpi_status status
= AE_OK
;
347 union acpi_parse_object
*next_op
;
348 union acpi_parse_object
*first_arg
;
350 ACPI_FUNCTION_TRACE_PTR(ds_exec_end_op
, walk_state
);
353 op_type
= walk_state
->op_info
->type
;
354 op_class
= walk_state
->op_info
->class;
356 if (op_class
== AML_CLASS_UNKNOWN
) {
357 ACPI_ERROR((AE_INFO
, "Unknown opcode %X",
358 op
->common
.aml_opcode
));
359 return_ACPI_STATUS(AE_NOT_IMPLEMENTED
);
362 first_arg
= op
->common
.value
.arg
;
364 /* Init the walk state */
366 walk_state
->num_operands
= 0;
367 walk_state
->operand_index
= 0;
368 walk_state
->return_desc
= NULL
;
369 walk_state
->result_obj
= NULL
;
371 /* Call debugger for single step support (DEBUG build only) */
373 ACPI_DEBUGGER_EXEC(status
=
374 acpi_db_single_step(walk_state
, op
, op_class
));
375 ACPI_DEBUGGER_EXEC(if (ACPI_FAILURE(status
)) {
376 return_ACPI_STATUS(status
);}
379 /* Decode the Opcode Class */
382 case AML_CLASS_ARGUMENT
: /* Constants, literals, etc. */
384 if (walk_state
->opcode
== AML_INT_NAMEPATH_OP
) {
385 status
= acpi_ds_evaluate_name_path(walk_state
);
386 if (ACPI_FAILURE(status
)) {
392 case AML_CLASS_EXECUTE
: /* Most operators with arguments */
394 /* Build resolved operand stack */
396 status
= acpi_ds_create_operands(walk_state
, first_arg
);
397 if (ACPI_FAILURE(status
)) {
402 * All opcodes require operand resolution, with the only exceptions
403 * being the object_type and size_of operators.
405 if (!(walk_state
->op_info
->flags
& AML_NO_OPERAND_RESOLVE
)) {
407 /* Resolve all operands */
409 status
= acpi_ex_resolve_operands(walk_state
->opcode
,
417 if (ACPI_SUCCESS(status
)) {
419 * Dispatch the request to the appropriate interpreter handler
420 * routine. There is one routine per opcode "type" based upon the
421 * number of opcode arguments and return type.
424 acpi_gbl_op_type_dispatch
[op_type
] (walk_state
);
427 * Treat constructs of the form "Store(LocalX,LocalX)" as noops when the
428 * Local is uninitialized.
430 if ((status
== AE_AML_UNINITIALIZED_LOCAL
) &&
431 (walk_state
->opcode
== AML_STORE_OP
) &&
432 (walk_state
->operands
[0]->common
.type
==
433 ACPI_TYPE_LOCAL_REFERENCE
)
434 && (walk_state
->operands
[1]->common
.type
==
435 ACPI_TYPE_LOCAL_REFERENCE
)
436 && (walk_state
->operands
[0]->reference
.class ==
437 walk_state
->operands
[1]->reference
.class)
438 && (walk_state
->operands
[0]->reference
.value
==
439 walk_state
->operands
[1]->reference
.value
)) {
442 ACPI_EXCEPTION((AE_INFO
, status
,
443 "While resolving operands for [%s]",
444 acpi_ps_get_opcode_name
445 (walk_state
->opcode
)));
449 /* Always delete the argument objects and clear the operand stack */
451 acpi_ds_clear_operands(walk_state
);
454 * If a result object was returned from above, push it on the
455 * current result stack
457 if (ACPI_SUCCESS(status
) && walk_state
->result_obj
) {
459 acpi_ds_result_push(walk_state
->result_obj
,
467 case AML_TYPE_CONTROL
: /* Type 1 opcode, IF/ELSE/WHILE/NOOP */
469 /* 1 Operand, 0 external_result, 0 internal_result */
471 status
= acpi_ds_exec_end_control_op(walk_state
, op
);
475 case AML_TYPE_METHOD_CALL
:
478 * If the method is referenced from within a package
479 * declaration, it is not a invocation of the method, just
482 if ((op
->asl
.parent
) &&
483 ((op
->asl
.parent
->asl
.aml_opcode
== AML_PACKAGE_OP
)
484 || (op
->asl
.parent
->asl
.aml_opcode
==
485 AML_VAR_PACKAGE_OP
))) {
486 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH
,
487 "Method Reference in a Package, Op=%p\n",
491 (struct acpi_namespace_node
*)op
->asl
.value
.
493 acpi_ut_add_reference(op
->asl
.value
.arg
->asl
.
495 return_ACPI_STATUS(AE_OK
);
498 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH
,
499 "Method invocation, Op=%p\n", op
));
502 * (AML_METHODCALL) Op->Asl.Value.Arg->Asl.Node contains
503 * the method Node pointer
505 /* next_op points to the op that holds the method name */
509 /* next_op points to first argument op */
511 next_op
= next_op
->common
.next
;
514 * Get the method's arguments and put them on the operand stack
516 status
= acpi_ds_create_operands(walk_state
, next_op
);
517 if (ACPI_FAILURE(status
)) {
522 * Since the operands will be passed to another control method,
523 * we must resolve all local references here (Local variables,
524 * arguments to *this* method, etc.)
526 status
= acpi_ds_resolve_operands(walk_state
);
527 if (ACPI_FAILURE(status
)) {
529 /* On error, clear all resolved operands */
531 acpi_ds_clear_operands(walk_state
);
536 * Tell the walk loop to preempt this running method and
537 * execute the new method
539 status
= AE_CTRL_TRANSFER
;
542 * Return now; we don't want to disturb anything,
543 * especially the operand count!
545 return_ACPI_STATUS(status
);
547 case AML_TYPE_CREATE_FIELD
:
549 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
,
550 "Executing CreateField Buffer/Index Op=%p\n",
553 status
= acpi_ds_load2_end_op(walk_state
);
554 if (ACPI_FAILURE(status
)) {
559 acpi_ds_eval_buffer_field_operands(walk_state
, op
);
562 case AML_TYPE_CREATE_OBJECT
:
564 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
,
565 "Executing CreateObject (Buffer/Package) Op=%p\n",
568 switch (op
->common
.parent
->common
.aml_opcode
) {
572 * Put the Node on the object stack (Contains the ACPI Name
575 walk_state
->operands
[0] =
576 (void *)op
->common
.parent
->common
.node
;
577 walk_state
->num_operands
= 1;
579 status
= acpi_ds_create_node(walk_state
,
583 if (ACPI_FAILURE(status
)) {
588 /*lint -fallthrough */
590 case AML_INT_EVAL_SUBTREE_OP
:
593 acpi_ds_eval_data_object_operands
595 acpi_ns_get_attached_object(op
->common
.
603 acpi_ds_eval_data_object_operands
604 (walk_state
, op
, NULL
);
609 * If a result object was returned from above, push it on the
610 * current result stack
612 if (walk_state
->result_obj
) {
614 acpi_ds_result_push(walk_state
->result_obj
,
619 case AML_TYPE_NAMED_FIELD
:
620 case AML_TYPE_NAMED_COMPLEX
:
621 case AML_TYPE_NAMED_SIMPLE
:
622 case AML_TYPE_NAMED_NO_OBJ
:
624 status
= acpi_ds_load2_end_op(walk_state
);
625 if (ACPI_FAILURE(status
)) {
629 if (op
->common
.aml_opcode
== AML_REGION_OP
) {
630 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
,
631 "Executing OpRegion Address/Length Op=%p\n",
635 acpi_ds_eval_region_operands(walk_state
,
637 if (ACPI_FAILURE(status
)) {
640 } else if (op
->common
.aml_opcode
== AML_DATA_REGION_OP
) {
641 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
,
642 "Executing DataTableRegion Strings Op=%p\n",
646 acpi_ds_eval_table_region_operands
648 if (ACPI_FAILURE(status
)) {
651 } else if (op
->common
.aml_opcode
== AML_BANK_FIELD_OP
) {
652 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
,
653 "Executing BankField Op=%p\n",
657 acpi_ds_eval_bank_field_operands(walk_state
,
659 if (ACPI_FAILURE(status
)) {
665 case AML_TYPE_UNDEFINED
:
668 "Undefined opcode type Op=%p", op
));
669 return_ACPI_STATUS(AE_NOT_IMPLEMENTED
);
673 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH
,
674 "Internal opcode=%X type Op=%p\n",
675 walk_state
->opcode
, op
));
681 "Unimplemented opcode, class=%X type=%X Opcode=%X Op=%p",
682 op_class
, op_type
, op
->common
.aml_opcode
,
685 status
= AE_NOT_IMPLEMENTED
;
691 * ACPI 2.0 support for 64-bit integers: Truncate numeric
692 * result value if we are executing from a 32-bit ACPI table
694 acpi_ex_truncate_for32bit_table(walk_state
->result_obj
);
697 * Check if we just completed the evaluation of a
698 * 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
) {
715 /* Break to debugger to display result */
717 ACPI_DEBUGGER_EXEC(acpi_db_display_result_object
718 (walk_state
->result_obj
, walk_state
));
721 * Delete the result op if and only if:
722 * Parent will not use the result -- such as any
723 * non-nested type2 op in a method (parent will be method)
725 acpi_ds_delete_result_if_not_used(op
, walk_state
->result_obj
,
728 #ifdef _UNDER_DEVELOPMENT
730 if (walk_state
->parser_state
.aml
== walk_state
->parser_state
.aml_end
) {
731 acpi_db_method_end(walk_state
);
735 /* Invoke exception handler on error */
737 if (ACPI_FAILURE(status
)) {
738 status
= acpi_ds_method_error(status
, walk_state
);
741 /* Always clear the object stack */
743 walk_state
->num_operands
= 0;
744 return_ACPI_STATUS(status
);