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/accommon.h>
47 #include <acpi/acparser.h>
48 #include <acpi/amlcode.h>
49 #include <acpi/acdispat.h>
50 #include <acpi/acinterp.h>
51 #include <acpi/acnamesp.h>
52 #include <acpi/acdebug.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 ObjDesc=%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) ObjDesc=%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
;
170 /* Predicate can be used for an implicit return value */
172 (void)acpi_ds_do_implicit_return(local_obj_desc
, walk_state
, TRUE
);
176 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
, "Completed a predicate eval=%X Op=%p\n",
177 walk_state
->control_state
->common
.value
,
180 /* Break to debugger to display result */
182 ACPI_DEBUGGER_EXEC(acpi_db_display_result_object
183 (local_obj_desc
, walk_state
));
186 * Delete the predicate result object (we know that
187 * we don't need it anymore)
189 if (local_obj_desc
!= obj_desc
) {
190 acpi_ut_remove_reference(local_obj_desc
);
192 acpi_ut_remove_reference(obj_desc
);
194 walk_state
->control_state
->common
.state
= ACPI_CONTROL_NORMAL
;
195 return_ACPI_STATUS(status
);
198 /*****************************************************************************
200 * FUNCTION: acpi_ds_exec_begin_op
202 * PARAMETERS: walk_state - Current state of the parse tree walk
203 * out_op - Where to return op if a new one is created
207 * DESCRIPTION: Descending callback used during the execution of control
208 * methods. This is where most operators and operands are
209 * dispatched to the interpreter.
211 ****************************************************************************/
214 acpi_ds_exec_begin_op(struct acpi_walk_state
*walk_state
,
215 union acpi_parse_object
**out_op
)
217 union acpi_parse_object
*op
;
218 acpi_status status
= AE_OK
;
221 ACPI_FUNCTION_TRACE_PTR(ds_exec_begin_op
, walk_state
);
225 status
= acpi_ds_load2_begin_op(walk_state
, out_op
);
226 if (ACPI_FAILURE(status
)) {
232 walk_state
->opcode
= op
->common
.aml_opcode
;
233 walk_state
->op_info
=
234 acpi_ps_get_opcode_info(op
->common
.aml_opcode
);
236 if (acpi_ns_opens_scope(walk_state
->op_info
->object_type
)) {
237 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH
,
238 "(%s) Popping scope for Op %p\n",
239 acpi_ut_get_type_name(walk_state
->
244 status
= acpi_ds_scope_stack_pop(walk_state
);
245 if (ACPI_FAILURE(status
)) {
251 if (op
== walk_state
->origin
) {
256 return_ACPI_STATUS(AE_OK
);
260 * If the previous opcode was a conditional, this opcode
261 * must be the beginning of the associated predicate.
262 * Save this knowledge in the current scope descriptor
264 if ((walk_state
->control_state
) &&
265 (walk_state
->control_state
->common
.state
==
266 ACPI_CONTROL_CONDITIONAL_EXECUTING
)) {
267 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
,
268 "Exec predicate Op=%p State=%p\n", op
,
271 walk_state
->control_state
->common
.state
=
272 ACPI_CONTROL_PREDICATE_EXECUTING
;
274 /* Save start of predicate */
276 walk_state
->control_state
->control
.predicate_op
= op
;
279 opcode_class
= walk_state
->op_info
->class;
281 /* We want to send namepaths to the load code */
283 if (op
->common
.aml_opcode
== AML_INT_NAMEPATH_OP
) {
284 opcode_class
= AML_CLASS_NAMED_OBJECT
;
288 * Handle the opcode based upon the opcode type
290 switch (opcode_class
) {
291 case AML_CLASS_CONTROL
:
293 status
= acpi_ds_exec_begin_control_op(walk_state
, op
);
296 case AML_CLASS_NAMED_OBJECT
:
298 if (walk_state
->walk_type
& ACPI_WALK_METHOD
) {
300 * Found a named object declaration during method execution;
301 * we must enter this object into the namespace. The created
302 * object is temporary and will be deleted upon completion of
303 * the execution of this method.
305 status
= acpi_ds_load2_begin_op(walk_state
, NULL
);
310 case AML_CLASS_EXECUTE
:
311 case AML_CLASS_CREATE
:
319 /* Nothing to do here during method execution */
321 return_ACPI_STATUS(status
);
324 status
= acpi_ds_method_error(status
, walk_state
);
325 return_ACPI_STATUS(status
);
328 /*****************************************************************************
330 * FUNCTION: acpi_ds_exec_end_op
332 * PARAMETERS: walk_state - Current state of the parse tree walk
336 * DESCRIPTION: Ascending callback used during the execution of control
337 * methods. The only thing we really need to do here is to
338 * notice the beginning of IF, ELSE, and WHILE blocks.
340 ****************************************************************************/
342 acpi_status
acpi_ds_exec_end_op(struct acpi_walk_state
*walk_state
)
344 union acpi_parse_object
*op
;
345 acpi_status status
= AE_OK
;
348 union acpi_parse_object
*next_op
;
349 union acpi_parse_object
*first_arg
;
351 ACPI_FUNCTION_TRACE_PTR(ds_exec_end_op
, walk_state
);
354 op_type
= walk_state
->op_info
->type
;
355 op_class
= walk_state
->op_info
->class;
357 if (op_class
== AML_CLASS_UNKNOWN
) {
358 ACPI_ERROR((AE_INFO
, "Unknown opcode %X",
359 op
->common
.aml_opcode
));
360 return_ACPI_STATUS(AE_NOT_IMPLEMENTED
);
363 first_arg
= op
->common
.value
.arg
;
365 /* Init the walk state */
367 walk_state
->num_operands
= 0;
368 walk_state
->operand_index
= 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. */
385 if (walk_state
->opcode
== AML_INT_NAMEPATH_OP
) {
386 status
= acpi_ds_evaluate_name_path(walk_state
);
387 if (ACPI_FAILURE(status
)) {
393 case AML_CLASS_EXECUTE
: /* Most operators with arguments */
395 /* Build resolved operand stack */
397 status
= acpi_ds_create_operands(walk_state
, first_arg
);
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
)) {
408 /* Resolve all operands */
410 status
= acpi_ex_resolve_operands(walk_state
->opcode
,
418 if (ACPI_SUCCESS(status
)) {
420 * Dispatch the request to the appropriate interpreter handler
421 * routine. There is one routine per opcode "type" based upon the
422 * number of opcode arguments and return type.
425 acpi_gbl_op_type_dispatch
[op_type
] (walk_state
);
428 * Treat constructs of the form "Store(LocalX,LocalX)" as noops when the
429 * Local is uninitialized.
431 if ((status
== AE_AML_UNINITIALIZED_LOCAL
) &&
432 (walk_state
->opcode
== AML_STORE_OP
) &&
433 (walk_state
->operands
[0]->common
.type
==
434 ACPI_TYPE_LOCAL_REFERENCE
)
435 && (walk_state
->operands
[1]->common
.type
==
436 ACPI_TYPE_LOCAL_REFERENCE
)
437 && (walk_state
->operands
[0]->reference
.class ==
438 walk_state
->operands
[1]->reference
.class)
439 && (walk_state
->operands
[0]->reference
.value
==
440 walk_state
->operands
[1]->reference
.value
)) {
443 ACPI_EXCEPTION((AE_INFO
, status
,
444 "While resolving operands for [%s]",
445 acpi_ps_get_opcode_name
446 (walk_state
->opcode
)));
450 /* Always delete the argument objects and clear the operand stack */
452 acpi_ds_clear_operands(walk_state
);
455 * If a result object was returned from above, push it on the
456 * current result stack
458 if (ACPI_SUCCESS(status
) && walk_state
->result_obj
) {
460 acpi_ds_result_push(walk_state
->result_obj
,
468 case AML_TYPE_CONTROL
: /* Type 1 opcode, IF/ELSE/WHILE/NOOP */
470 /* 1 Operand, 0 external_result, 0 internal_result */
472 status
= acpi_ds_exec_end_control_op(walk_state
, op
);
476 case AML_TYPE_METHOD_CALL
:
479 * If the method is referenced from within a package
480 * declaration, it is not a invocation of the method, just
483 if ((op
->asl
.parent
) &&
484 ((op
->asl
.parent
->asl
.aml_opcode
== AML_PACKAGE_OP
)
485 || (op
->asl
.parent
->asl
.aml_opcode
==
486 AML_VAR_PACKAGE_OP
))) {
487 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH
,
488 "Method Reference in a Package, Op=%p\n",
492 (struct acpi_namespace_node
*)op
->asl
.value
.
494 acpi_ut_add_reference(op
->asl
.value
.arg
->asl
.
496 return_ACPI_STATUS(AE_OK
);
499 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH
,
500 "Method invocation, Op=%p\n", op
));
503 * (AML_METHODCALL) Op->Asl.Value.Arg->Asl.Node contains
504 * the method Node pointer
506 /* next_op points to the op that holds the method name */
510 /* next_op points to first argument op */
512 next_op
= next_op
->common
.next
;
515 * Get the method's arguments and put them on the operand stack
517 status
= acpi_ds_create_operands(walk_state
, next_op
);
518 if (ACPI_FAILURE(status
)) {
523 * Since the operands will be passed to another control method,
524 * we must resolve all local references here (Local variables,
525 * arguments to *this* method, etc.)
527 status
= acpi_ds_resolve_operands(walk_state
);
528 if (ACPI_FAILURE(status
)) {
530 /* On error, clear all resolved operands */
532 acpi_ds_clear_operands(walk_state
);
537 * Tell the walk loop to preempt this running method and
538 * execute the new method
540 status
= AE_CTRL_TRANSFER
;
543 * Return now; we don't want to disturb anything,
544 * especially the operand count!
546 return_ACPI_STATUS(status
);
548 case AML_TYPE_CREATE_FIELD
:
550 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
,
551 "Executing CreateField Buffer/Index Op=%p\n",
554 status
= acpi_ds_load2_end_op(walk_state
);
555 if (ACPI_FAILURE(status
)) {
560 acpi_ds_eval_buffer_field_operands(walk_state
, op
);
563 case AML_TYPE_CREATE_OBJECT
:
565 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
,
566 "Executing CreateObject (Buffer/Package) Op=%p\n",
569 switch (op
->common
.parent
->common
.aml_opcode
) {
573 * Put the Node on the object stack (Contains the ACPI Name
576 walk_state
->operands
[0] =
577 (void *)op
->common
.parent
->common
.node
;
578 walk_state
->num_operands
= 1;
580 status
= acpi_ds_create_node(walk_state
,
584 if (ACPI_FAILURE(status
)) {
589 /*lint -fallthrough */
591 case AML_INT_EVAL_SUBTREE_OP
:
594 acpi_ds_eval_data_object_operands
596 acpi_ns_get_attached_object(op
->common
.
604 acpi_ds_eval_data_object_operands
605 (walk_state
, op
, NULL
);
610 * If a result object was returned from above, push it on the
611 * current result stack
613 if (walk_state
->result_obj
) {
615 acpi_ds_result_push(walk_state
->result_obj
,
620 case AML_TYPE_NAMED_FIELD
:
621 case AML_TYPE_NAMED_COMPLEX
:
622 case AML_TYPE_NAMED_SIMPLE
:
623 case AML_TYPE_NAMED_NO_OBJ
:
625 status
= acpi_ds_load2_end_op(walk_state
);
626 if (ACPI_FAILURE(status
)) {
630 if (op
->common
.aml_opcode
== AML_REGION_OP
) {
631 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
,
632 "Executing OpRegion Address/Length Op=%p\n",
636 acpi_ds_eval_region_operands(walk_state
,
638 if (ACPI_FAILURE(status
)) {
641 } else if (op
->common
.aml_opcode
== AML_DATA_REGION_OP
) {
642 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
,
643 "Executing DataTableRegion Strings Op=%p\n",
647 acpi_ds_eval_table_region_operands
649 if (ACPI_FAILURE(status
)) {
652 } else if (op
->common
.aml_opcode
== AML_BANK_FIELD_OP
) {
653 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
,
654 "Executing BankField Op=%p\n",
658 acpi_ds_eval_bank_field_operands(walk_state
,
660 if (ACPI_FAILURE(status
)) {
666 case AML_TYPE_UNDEFINED
:
669 "Undefined opcode type Op=%p", op
));
670 return_ACPI_STATUS(AE_NOT_IMPLEMENTED
);
674 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH
,
675 "Internal opcode=%X type Op=%p\n",
676 walk_state
->opcode
, op
));
682 "Unimplemented opcode, class=%X type=%X Opcode=%X Op=%p",
683 op_class
, op_type
, op
->common
.aml_opcode
,
686 status
= AE_NOT_IMPLEMENTED
;
692 * ACPI 2.0 support for 64-bit integers: Truncate numeric
693 * result value if we are executing from a 32-bit ACPI table
695 acpi_ex_truncate_for32bit_table(walk_state
->result_obj
);
698 * Check if we just completed the evaluation of a
699 * conditional predicate
701 if ((ACPI_SUCCESS(status
)) &&
702 (walk_state
->control_state
) &&
703 (walk_state
->control_state
->common
.state
==
704 ACPI_CONTROL_PREDICATE_EXECUTING
) &&
705 (walk_state
->control_state
->control
.predicate_op
== op
)) {
707 acpi_ds_get_predicate_value(walk_state
,
708 walk_state
->result_obj
);
709 walk_state
->result_obj
= NULL
;
714 if (walk_state
->result_obj
) {
716 /* Break to debugger to display result */
718 ACPI_DEBUGGER_EXEC(acpi_db_display_result_object
719 (walk_state
->result_obj
, walk_state
));
722 * Delete the result op if and only if:
723 * Parent will not use the result -- such as any
724 * non-nested type2 op in a method (parent will be method)
726 acpi_ds_delete_result_if_not_used(op
, walk_state
->result_obj
,
729 #ifdef _UNDER_DEVELOPMENT
731 if (walk_state
->parser_state
.aml
== walk_state
->parser_state
.aml_end
) {
732 acpi_db_method_end(walk_state
);
736 /* Invoke exception handler on error */
738 if (ACPI_FAILURE(status
)) {
739 status
= acpi_ds_method_error(status
, walk_state
);
742 /* Always clear the object stack */
744 walk_state
->num_operands
= 0;
745 return_ACPI_STATUS(status
);