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>
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
;
171 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
, "Completed a predicate eval=%X Op=%p\n",
172 walk_state
->control_state
->common
.value
,
175 /* Break to debugger to display result */
177 ACPI_DEBUGGER_EXEC(acpi_db_display_result_object
178 (local_obj_desc
, walk_state
));
181 * Delete the predicate result object (we know that
182 * we don't need it anymore)
184 if (local_obj_desc
!= obj_desc
) {
185 acpi_ut_remove_reference(local_obj_desc
);
187 acpi_ut_remove_reference(obj_desc
);
189 walk_state
->control_state
->common
.state
= ACPI_CONTROL_NORMAL
;
190 return_ACPI_STATUS(status
);
193 /*****************************************************************************
195 * FUNCTION: acpi_ds_exec_begin_op
197 * PARAMETERS: walk_state - Current state of the parse tree walk
198 * out_op - Where to return op if a new one is created
202 * DESCRIPTION: Descending callback used during the execution of control
203 * methods. This is where most operators and operands are
204 * dispatched to the interpreter.
206 ****************************************************************************/
209 acpi_ds_exec_begin_op(struct acpi_walk_state
*walk_state
,
210 union acpi_parse_object
**out_op
)
212 union acpi_parse_object
*op
;
213 acpi_status status
= AE_OK
;
216 ACPI_FUNCTION_TRACE_PTR(ds_exec_begin_op
, walk_state
);
220 status
= acpi_ds_load2_begin_op(walk_state
, out_op
);
221 if (ACPI_FAILURE(status
)) {
222 return_ACPI_STATUS(status
);
227 walk_state
->opcode
= op
->common
.aml_opcode
;
228 walk_state
->op_info
=
229 acpi_ps_get_opcode_info(op
->common
.aml_opcode
);
231 if (acpi_ns_opens_scope(walk_state
->op_info
->object_type
)) {
232 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH
,
233 "(%s) Popping scope for Op %p\n",
234 acpi_ut_get_type_name(walk_state
->
239 status
= acpi_ds_scope_stack_pop(walk_state
);
240 if (ACPI_FAILURE(status
)) {
241 return_ACPI_STATUS(status
);
246 if (op
== walk_state
->origin
) {
251 return_ACPI_STATUS(AE_OK
);
255 * If the previous opcode was a conditional, this opcode
256 * must be the beginning of the associated predicate.
257 * Save this knowledge in the current scope descriptor
259 if ((walk_state
->control_state
) &&
260 (walk_state
->control_state
->common
.state
==
261 ACPI_CONTROL_CONDITIONAL_EXECUTING
)) {
262 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
,
263 "Exec predicate Op=%p State=%p\n", op
,
266 walk_state
->control_state
->common
.state
=
267 ACPI_CONTROL_PREDICATE_EXECUTING
;
269 /* Save start of predicate */
271 walk_state
->control_state
->control
.predicate_op
= op
;
274 opcode_class
= walk_state
->op_info
->class;
276 /* We want to send namepaths to the load code */
278 if (op
->common
.aml_opcode
== AML_INT_NAMEPATH_OP
) {
279 opcode_class
= AML_CLASS_NAMED_OBJECT
;
283 * Handle the opcode based upon the opcode type
285 switch (opcode_class
) {
286 case AML_CLASS_CONTROL
:
288 status
= acpi_ds_result_stack_push(walk_state
);
289 if (ACPI_FAILURE(status
)) {
290 return_ACPI_STATUS(status
);
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
);
308 if (op
->common
.aml_opcode
== AML_REGION_OP
) {
309 status
= acpi_ds_result_stack_push(walk_state
);
313 case AML_CLASS_EXECUTE
:
314 case AML_CLASS_CREATE
:
316 * Most operators with arguments (except create_xxx_field operators)
317 * Start a new result/operand state
319 if (walk_state
->op_info
->object_type
!= ACPI_TYPE_BUFFER_FIELD
) {
320 status
= acpi_ds_result_stack_push(walk_state
);
328 /* Nothing to do here during method execution */
330 return_ACPI_STATUS(status
);
333 /*****************************************************************************
335 * FUNCTION: acpi_ds_exec_end_op
337 * PARAMETERS: walk_state - Current state of the parse tree walk
341 * DESCRIPTION: Ascending callback used during the execution of control
342 * methods. The only thing we really need to do here is to
343 * notice the beginning of IF, ELSE, and WHILE blocks.
345 ****************************************************************************/
347 acpi_status
acpi_ds_exec_end_op(struct acpi_walk_state
*walk_state
)
349 union acpi_parse_object
*op
;
350 acpi_status status
= AE_OK
;
353 union acpi_parse_object
*next_op
;
354 union acpi_parse_object
*first_arg
;
356 ACPI_FUNCTION_TRACE_PTR(ds_exec_end_op
, walk_state
);
359 op_type
= walk_state
->op_info
->type
;
360 op_class
= walk_state
->op_info
->class;
362 if (op_class
== AML_CLASS_UNKNOWN
) {
363 ACPI_ERROR((AE_INFO
, "Unknown opcode %X",
364 op
->common
.aml_opcode
));
365 return_ACPI_STATUS(AE_NOT_IMPLEMENTED
);
368 first_arg
= op
->common
.value
.arg
;
370 /* Init the walk state */
372 walk_state
->num_operands
= 0;
373 walk_state
->return_desc
= NULL
;
374 walk_state
->result_obj
= NULL
;
376 /* Call debugger for single step support (DEBUG build only) */
378 ACPI_DEBUGGER_EXEC(status
=
379 acpi_db_single_step(walk_state
, op
, op_class
));
380 ACPI_DEBUGGER_EXEC(if (ACPI_FAILURE(status
)) {
381 return_ACPI_STATUS(status
);}
384 /* Decode the Opcode Class */
387 case AML_CLASS_ARGUMENT
: /* constants, literals, etc. - do nothing */
390 case AML_CLASS_EXECUTE
: /* most operators with arguments */
392 /* Build resolved operand stack */
394 status
= acpi_ds_create_operands(walk_state
, first_arg
);
395 if (ACPI_FAILURE(status
)) {
399 /* Done with this result state (Now that operand stack is built) */
401 status
= acpi_ds_result_stack_pop(walk_state
);
402 if (ACPI_FAILURE(status
)) {
407 * All opcodes require operand resolution, with the only exceptions
408 * being the object_type and size_of operators.
410 if (!(walk_state
->op_info
->flags
& AML_NO_OPERAND_RESOLVE
)) {
412 /* Resolve all operands */
414 status
= acpi_ex_resolve_operands(walk_state
->opcode
,
420 if (ACPI_SUCCESS(status
)) {
421 ACPI_DUMP_OPERANDS(ACPI_WALK_OPERANDS
,
423 acpi_ps_get_opcode_name
424 (walk_state
->opcode
),
425 walk_state
->num_operands
,
426 "after ExResolveOperands");
430 if (ACPI_SUCCESS(status
)) {
432 * Dispatch the request to the appropriate interpreter handler
433 * routine. There is one routine per opcode "type" based upon the
434 * number of opcode arguments and return type.
437 acpi_gbl_op_type_dispatch
[op_type
] (walk_state
);
440 * Treat constructs of the form "Store(LocalX,LocalX)" as noops when the
441 * Local is uninitialized.
443 if ((status
== AE_AML_UNINITIALIZED_LOCAL
) &&
444 (walk_state
->opcode
== AML_STORE_OP
) &&
445 (walk_state
->operands
[0]->common
.type
==
446 ACPI_TYPE_LOCAL_REFERENCE
)
447 && (walk_state
->operands
[1]->common
.type
==
448 ACPI_TYPE_LOCAL_REFERENCE
)
449 && (walk_state
->operands
[0]->reference
.opcode
==
450 walk_state
->operands
[1]->reference
.opcode
)
451 && (walk_state
->operands
[0]->reference
.offset
==
452 walk_state
->operands
[1]->reference
.offset
)) {
455 ACPI_EXCEPTION((AE_INFO
, status
,
456 "While resolving operands for [%s]",
457 acpi_ps_get_opcode_name
458 (walk_state
->opcode
)));
462 /* Always delete the argument objects and clear the operand stack */
464 acpi_ds_clear_operands(walk_state
);
467 * If a result object was returned from above, push it on the
468 * current result stack
470 if (ACPI_SUCCESS(status
) && walk_state
->result_obj
) {
472 acpi_ds_result_push(walk_state
->result_obj
,
480 case AML_TYPE_CONTROL
: /* Type 1 opcode, IF/ELSE/WHILE/NOOP */
482 /* 1 Operand, 0 external_result, 0 internal_result */
484 status
= acpi_ds_exec_end_control_op(walk_state
, op
);
486 /* Make sure to properly pop the result stack */
488 if (ACPI_SUCCESS(status
)) {
489 status
= acpi_ds_result_stack_pop(walk_state
);
490 } else if (status
== AE_CTRL_PENDING
) {
491 status
= acpi_ds_result_stack_pop(walk_state
);
492 if (ACPI_SUCCESS(status
)) {
493 status
= AE_CTRL_PENDING
;
498 case AML_TYPE_METHOD_CALL
:
501 * If the method is referenced from within a package
502 * declaration, it is not a invocation of the method, just
505 if ((op
->asl
.parent
) &&
506 ((op
->asl
.parent
->asl
.aml_opcode
== AML_PACKAGE_OP
)
507 || (op
->asl
.parent
->asl
.aml_opcode
==
508 AML_VAR_PACKAGE_OP
))) {
509 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH
,
510 "Method Reference in a Package, Op=%p\n",
514 (struct acpi_namespace_node
*)op
->asl
.value
.
515 arg
->asl
.node
->object
;
516 acpi_ut_add_reference(op
->asl
.value
.arg
->asl
.
518 return_ACPI_STATUS(AE_OK
);
521 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH
,
522 "Method invocation, Op=%p\n", op
));
525 * (AML_METHODCALL) Op->Asl.Value.Arg->Asl.Node contains
526 * the method Node pointer
528 /* next_op points to the op that holds the method name */
532 /* next_op points to first argument op */
534 next_op
= next_op
->common
.next
;
537 * Get the method's arguments and put them on the operand stack
539 status
= acpi_ds_create_operands(walk_state
, next_op
);
540 if (ACPI_FAILURE(status
)) {
545 * Since the operands will be passed to another control method,
546 * we must resolve all local references here (Local variables,
547 * arguments to *this* method, etc.)
549 status
= acpi_ds_resolve_operands(walk_state
);
550 if (ACPI_FAILURE(status
)) {
552 /* On error, clear all resolved operands */
554 acpi_ds_clear_operands(walk_state
);
559 * Tell the walk loop to preempt this running method and
560 * execute the new method
562 status
= AE_CTRL_TRANSFER
;
565 * Return now; we don't want to disturb anything,
566 * especially the operand count!
568 return_ACPI_STATUS(status
);
570 case AML_TYPE_CREATE_FIELD
:
572 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
,
573 "Executing CreateField Buffer/Index Op=%p\n",
576 status
= acpi_ds_load2_end_op(walk_state
);
577 if (ACPI_FAILURE(status
)) {
582 acpi_ds_eval_buffer_field_operands(walk_state
, op
);
585 case AML_TYPE_CREATE_OBJECT
:
587 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
,
588 "Executing CreateObject (Buffer/Package) Op=%p\n",
591 switch (op
->common
.parent
->common
.aml_opcode
) {
595 * Put the Node on the object stack (Contains the ACPI Name
598 walk_state
->operands
[0] =
599 (void *)op
->common
.parent
->common
.node
;
600 walk_state
->num_operands
= 1;
602 status
= acpi_ds_create_node(walk_state
,
606 if (ACPI_FAILURE(status
)) {
611 /*lint -fallthrough */
613 case AML_INT_EVAL_SUBTREE_OP
:
616 acpi_ds_eval_data_object_operands
618 acpi_ns_get_attached_object(op
->common
.
626 acpi_ds_eval_data_object_operands
627 (walk_state
, op
, NULL
);
631 /* Done with result state (Now that operand stack is built) */
633 status
= acpi_ds_result_stack_pop(walk_state
);
634 if (ACPI_FAILURE(status
)) {
639 * If a result object was returned from above, push it on the
640 * current result stack
642 if (walk_state
->result_obj
) {
644 acpi_ds_result_push(walk_state
->result_obj
,
649 case AML_TYPE_NAMED_FIELD
:
650 case AML_TYPE_NAMED_COMPLEX
:
651 case AML_TYPE_NAMED_SIMPLE
:
652 case AML_TYPE_NAMED_NO_OBJ
:
654 status
= acpi_ds_load2_end_op(walk_state
);
655 if (ACPI_FAILURE(status
)) {
659 if (op
->common
.aml_opcode
== AML_REGION_OP
) {
660 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
,
661 "Executing OpRegion Address/Length Op=%p\n",
665 acpi_ds_eval_region_operands(walk_state
,
667 if (ACPI_FAILURE(status
)) {
671 status
= acpi_ds_result_stack_pop(walk_state
);
675 case AML_TYPE_UNDEFINED
:
678 "Undefined opcode type Op=%p", op
));
679 return_ACPI_STATUS(AE_NOT_IMPLEMENTED
);
683 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH
,
684 "Internal opcode=%X type Op=%p\n",
685 walk_state
->opcode
, op
));
691 "Unimplemented opcode, class=%X type=%X Opcode=%X Op=%p",
692 op_class
, op_type
, op
->common
.aml_opcode
,
695 status
= AE_NOT_IMPLEMENTED
;
701 * ACPI 2.0 support for 64-bit integers: Truncate numeric
702 * result value if we are executing from a 32-bit ACPI table
704 acpi_ex_truncate_for32bit_table(walk_state
->result_obj
);
707 * Check if we just completed the evaluation of a
708 * conditional predicate
710 if ((ACPI_SUCCESS(status
)) &&
711 (walk_state
->control_state
) &&
712 (walk_state
->control_state
->common
.state
==
713 ACPI_CONTROL_PREDICATE_EXECUTING
) &&
714 (walk_state
->control_state
->control
.predicate_op
== op
)) {
716 acpi_ds_get_predicate_value(walk_state
,
717 walk_state
->result_obj
);
718 walk_state
->result_obj
= NULL
;
723 if (walk_state
->result_obj
) {
725 /* Break to debugger to display result */
727 ACPI_DEBUGGER_EXEC(acpi_db_display_result_object
728 (walk_state
->result_obj
, walk_state
));
731 * Delete the result op if and only if:
732 * Parent will not use the result -- such as any
733 * non-nested type2 op in a method (parent will be method)
735 acpi_ds_delete_result_if_not_used(op
, walk_state
->result_obj
,
738 #ifdef _UNDER_DEVELOPMENT
740 if (walk_state
->parser_state
.aml
== walk_state
->parser_state
.aml_end
) {
741 acpi_db_method_end(walk_state
);
745 /* Invoke exception handler on error */
747 if (ACPI_FAILURE(status
)) {
748 status
= acpi_ds_method_error(status
, walk_state
);
751 /* Always clear the object stack */
753 walk_state
->num_operands
= 0;
754 return_ACPI_STATUS(status
);