1 /******************************************************************************
3 * Module Name: psparse - Parser top level AML parse routines
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2008, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
45 * Parse the AML and build an operation tree as most interpreters,
46 * like Perl, do. Parsing is done by hand rather than with a YACC
47 * generated parser to tightly constrain stack and dynamic memory
48 * usage. At the same time, parsing is kept flexible and the code
49 * fairly compact by parsing based on a list of AML opcode
50 * templates in aml_op_info[]
53 #include <acpi/acpi.h>
54 #include <acpi/acparser.h>
55 #include <acpi/acdispat.h>
56 #include <acpi/amlcode.h>
57 #include <acpi/acnamesp.h>
58 #include <acpi/acinterp.h>
60 #define _COMPONENT ACPI_PARSER
61 ACPI_MODULE_NAME("psparse")
63 /*******************************************************************************
65 * FUNCTION: acpi_ps_get_opcode_size
67 * PARAMETERS: Opcode - An AML opcode
69 * RETURN: Size of the opcode, in bytes (1 or 2)
71 * DESCRIPTION: Get the size of the current opcode.
73 ******************************************************************************/
74 u32 acpi_ps_get_opcode_size(u32 opcode)
77 /* Extended (2-byte) opcode if > 255 */
79 if (opcode > 0x00FF) {
83 /* Otherwise, just a single byte opcode */
88 /*******************************************************************************
90 * FUNCTION: acpi_ps_peek_opcode
92 * PARAMETERS: parser_state - A parser state object
94 * RETURN: Next AML opcode
96 * DESCRIPTION: Get next AML opcode (without incrementing AML pointer)
98 ******************************************************************************/
100 u16 acpi_ps_peek_opcode(struct acpi_parse_state * parser_state)
105 aml = parser_state->aml;
106 opcode = (u16) ACPI_GET8(aml);
108 if (opcode == AML_EXTENDED_OP_PREFIX) {
110 /* Extended opcode, get the second opcode byte */
113 opcode = (u16) ((opcode << 8) | ACPI_GET8(aml));
119 /*******************************************************************************
121 * FUNCTION: acpi_ps_complete_this_op
123 * PARAMETERS: walk_state - Current State
124 * Op - Op to complete
128 * DESCRIPTION: Perform any cleanup at the completion of an Op.
130 ******************************************************************************/
133 acpi_ps_complete_this_op(struct acpi_walk_state * walk_state,
134 union acpi_parse_object * op)
136 union acpi_parse_object *prev;
137 union acpi_parse_object *next;
138 const struct acpi_opcode_info *parent_info;
139 union acpi_parse_object *replacement_op = NULL;
141 ACPI_FUNCTION_TRACE_PTR(ps_complete_this_op, op);
143 /* Check for null Op, can happen if AML code is corrupt */
146 return_ACPI_STATUS(AE_OK); /* OK for now */
149 /* Delete this op and the subtree below it if asked to */
151 if (((walk_state->parse_flags & ACPI_PARSE_TREE_MASK) !=
152 ACPI_PARSE_DELETE_TREE)
153 || (walk_state->op_info->class == AML_CLASS_ARGUMENT)) {
154 return_ACPI_STATUS(AE_OK);
157 /* Make sure that we only delete this subtree */
159 if (op->common.parent) {
160 prev = op->common.parent->common.value.arg;
163 /* Nothing more to do */
169 * Check if we need to replace the operator and its subtree
170 * with a return value op (placeholder op)
173 acpi_ps_get_opcode_info(op->common.parent->common.
176 switch (parent_info->class) {
177 case AML_CLASS_CONTROL:
180 case AML_CLASS_CREATE:
183 * These opcodes contain term_arg operands. The current
184 * op must be replaced by a placeholder return op
187 acpi_ps_alloc_op(AML_INT_RETURN_VALUE_OP);
188 if (!replacement_op) {
193 case AML_CLASS_NAMED_OBJECT:
196 * These opcodes contain term_arg operands. The current
197 * op must be replaced by a placeholder return op
199 if ((op->common.parent->common.aml_opcode ==
201 || (op->common.parent->common.aml_opcode ==
203 || (op->common.parent->common.aml_opcode ==
205 || (op->common.parent->common.aml_opcode ==
207 || (op->common.parent->common.aml_opcode ==
209 || (op->common.parent->common.aml_opcode ==
210 AML_VAR_PACKAGE_OP)) {
212 acpi_ps_alloc_op(AML_INT_RETURN_VALUE_OP);
213 if (!replacement_op) {
217 if ((op->common.parent->common.aml_opcode ==
219 && (walk_state->pass_number <=
220 ACPI_IMODE_LOAD_PASS2)) {
221 if ((op->common.aml_opcode == AML_BUFFER_OP)
222 || (op->common.aml_opcode == AML_PACKAGE_OP)
223 || (op->common.aml_opcode ==
224 AML_VAR_PACKAGE_OP)) {
226 acpi_ps_alloc_op(op->common.
228 if (!replacement_op) {
232 replacement_op->named.data =
234 replacement_op->named.length =
243 acpi_ps_alloc_op(AML_INT_RETURN_VALUE_OP);
244 if (!replacement_op) {
249 /* We must unlink this op from the parent tree */
253 /* This op is the first in the list */
255 if (replacement_op) {
256 replacement_op->common.parent =
258 replacement_op->common.value.arg = NULL;
259 replacement_op->common.node = op->common.node;
260 op->common.parent->common.value.arg =
262 replacement_op->common.next = op->common.next;
264 op->common.parent->common.value.arg =
269 /* Search the parent list */
274 /* Traverse all siblings in the parent's argument list */
276 next = prev->common.next;
278 if (replacement_op) {
279 replacement_op->common.parent =
281 replacement_op->common.value.
283 replacement_op->common.node =
287 replacement_op->common.next =
302 /* Now we can actually delete the subtree rooted at Op */
304 acpi_ps_delete_parse_tree(op);
305 return_ACPI_STATUS(AE_OK);
309 /* Always delete the subtree, even on error */
311 acpi_ps_delete_parse_tree(op);
312 return_ACPI_STATUS(AE_NO_MEMORY);
315 /*******************************************************************************
317 * FUNCTION: acpi_ps_next_parse_state
319 * PARAMETERS: walk_state - Current state
320 * Op - Current parse op
321 * callback_status - Status from previous operation
325 * DESCRIPTION: Update the parser state based upon the return exception from
326 * the parser callback.
328 ******************************************************************************/
331 acpi_ps_next_parse_state(struct acpi_walk_state *walk_state,
332 union acpi_parse_object *op,
333 acpi_status callback_status)
335 struct acpi_parse_state *parser_state = &walk_state->parser_state;
336 acpi_status status = AE_CTRL_PENDING;
338 ACPI_FUNCTION_TRACE_PTR(ps_next_parse_state, op);
340 switch (callback_status) {
341 case AE_CTRL_TERMINATE:
343 * A control method was terminated via a RETURN statement.
344 * The walk of this method is complete.
346 parser_state->aml = parser_state->aml_end;
347 status = AE_CTRL_TERMINATE;
352 parser_state->aml = walk_state->aml_last_while;
353 walk_state->control_state->common.value = FALSE;
354 status = AE_CTRL_BREAK;
357 case AE_CTRL_CONTINUE:
359 parser_state->aml = walk_state->aml_last_while;
360 status = AE_CTRL_CONTINUE;
363 case AE_CTRL_PENDING:
365 parser_state->aml = walk_state->aml_last_while;
371 parser_state->aml = parser_state->scope->parse_scope.pkg_end;
378 * Predicate of an IF was true, and we are at the matching ELSE.
379 * Just close out this package
381 parser_state->aml = acpi_ps_get_next_package_end(parser_state);
382 status = AE_CTRL_PENDING;
387 * Either an IF/WHILE Predicate was false or we encountered a BREAK
388 * opcode. In both cases, we do not execute the rest of the
389 * package; We simply close out the parent (finishing the walk of
390 * this branch of the tree) and continue execution at the parent
393 parser_state->aml = parser_state->scope->parse_scope.pkg_end;
395 /* In the case of a BREAK, just force a predicate (if any) to FALSE */
397 walk_state->control_state->common.value = FALSE;
398 status = AE_CTRL_END;
401 case AE_CTRL_TRANSFER:
403 /* A method call (invocation) -- transfer control */
405 status = AE_CTRL_TRANSFER;
406 walk_state->prev_op = op;
407 walk_state->method_call_op = op;
408 walk_state->method_call_node =
409 (op->common.value.arg)->common.node;
411 /* Will return value (if any) be used by the caller? */
413 walk_state->return_used =
414 acpi_ds_is_result_used(op, walk_state);
419 status = callback_status;
420 if ((callback_status & AE_CODE_MASK) == AE_CODE_CONTROL) {
426 return_ACPI_STATUS(status);
429 /*******************************************************************************
431 * FUNCTION: acpi_ps_parse_aml
433 * PARAMETERS: walk_state - Current state
438 * DESCRIPTION: Parse raw AML and return a tree of ops
440 ******************************************************************************/
442 acpi_status acpi_ps_parse_aml(struct acpi_walk_state *walk_state)
445 struct acpi_thread_state *thread;
446 struct acpi_thread_state *prev_walk_list = acpi_gbl_current_walk_list;
447 struct acpi_walk_state *previous_walk_state;
449 ACPI_FUNCTION_TRACE(ps_parse_aml);
451 ACPI_DEBUG_PRINT((ACPI_DB_PARSE,
452 "Entered with WalkState=%p Aml=%p size=%X\n",
453 walk_state, walk_state->parser_state.aml,
454 walk_state->parser_state.aml_size));
456 /* Create and initialize a new thread state */
458 thread = acpi_ut_create_thread_state();
460 acpi_ds_delete_walk_state(walk_state);
461 return_ACPI_STATUS(AE_NO_MEMORY);
464 walk_state->thread = thread;
467 * If executing a method, the starting sync_level is this method's
470 if (walk_state->method_desc) {
471 walk_state->thread->current_sync_level =
472 walk_state->method_desc->method.sync_level;
475 acpi_ds_push_walk_state(walk_state, thread);
478 * This global allows the AML debugger to get a handle to the currently
479 * executing control method.
481 acpi_gbl_current_walk_list = thread;
484 * Execute the walk loop as long as there is a valid Walk State. This
485 * handles nested control method invocations without recursion.
487 ACPI_DEBUG_PRINT((ACPI_DB_PARSE, "State=%p\n", walk_state));
491 if (ACPI_SUCCESS(status)) {
493 * The parse_loop executes AML until the method terminates
494 * or calls another method.
496 status = acpi_ps_parse_loop(walk_state);
499 ACPI_DEBUG_PRINT((ACPI_DB_PARSE,
500 "Completed one call to walk loop, %s State=%p\n",
501 acpi_format_exception(status), walk_state));
503 if (status == AE_CTRL_TRANSFER) {
505 * A method call was detected.
506 * Transfer control to the called control method
509 acpi_ds_call_control_method(thread, walk_state,
511 if (ACPI_FAILURE(status)) {
513 acpi_ds_method_error(status, walk_state);
517 * If the transfer to the new method method call worked, a new walk
518 * state was created -- get it
520 walk_state = acpi_ds_get_current_walk_state(thread);
522 } else if (status == AE_CTRL_TERMINATE) {
524 } else if ((status != AE_OK) && (walk_state->method_desc)) {
526 /* Either the method parse or actual execution failed */
528 ACPI_ERROR_METHOD("Method parse/execution failed",
529 walk_state->method_node, NULL,
532 /* Check for possible multi-thread reentrancy problem */
534 if ((status == AE_ALREADY_EXISTS) &&
535 (!walk_state->method_desc->method.mutex)) {
537 "Marking method %4.4s as Serialized because of AE_ALREADY_EXISTS error",
538 walk_state->method_node->name.
542 * Method tried to create an object twice. The probable cause is
543 * that the method cannot handle reentrancy.
545 * The method is marked not_serialized, but it tried to create
546 * a named object, causing the second thread entrance to fail.
547 * Workaround this problem by marking the method permanently
550 walk_state->method_desc->method.method_flags |=
551 AML_METHOD_SERIALIZED;
552 walk_state->method_desc->method.sync_level = 0;
556 /* We are done with this walk, move on to the parent if any */
558 walk_state = acpi_ds_pop_walk_state(thread);
560 /* Reset the current scope to the beginning of scope stack */
562 acpi_ds_scope_stack_clear(walk_state);
565 * If we just returned from the execution of a control method or if we
566 * encountered an error during the method parse phase, there's lots of
569 if (((walk_state->parse_flags & ACPI_PARSE_MODE_MASK) ==
570 ACPI_PARSE_EXECUTE) || (ACPI_FAILURE(status))) {
571 acpi_ds_terminate_control_method(walk_state->
576 /* Delete this walk state and all linked control states */
578 acpi_ps_cleanup_scope(&walk_state->parser_state);
579 previous_walk_state = walk_state;
581 ACPI_DEBUG_PRINT((ACPI_DB_PARSE,
582 "ReturnValue=%p, ImplicitValue=%p State=%p\n",
583 walk_state->return_desc,
584 walk_state->implicit_return_obj, walk_state));
586 /* Check if we have restarted a preempted walk */
588 walk_state = acpi_ds_get_current_walk_state(thread);
590 if (ACPI_SUCCESS(status)) {
592 * There is another walk state, restart it.
593 * If the method return value is not used by the parent,
594 * The object is deleted
596 if (!previous_walk_state->return_desc) {
598 * In slack mode execution, if there is no return value
599 * we should implicitly return zero (0) as a default value.
601 if (acpi_gbl_enable_interpreter_slack &&
602 !previous_walk_state->
603 implicit_return_obj) {
604 previous_walk_state->
605 implicit_return_obj =
606 acpi_ut_create_internal_object
608 if (!previous_walk_state->
609 implicit_return_obj) {
614 previous_walk_state->
615 implicit_return_obj->
619 /* Restart the calling control method */
622 acpi_ds_restart_control_method
624 previous_walk_state->
625 implicit_return_obj);
628 * We have a valid return value, delete any implicit
631 acpi_ds_clear_implicit_return
632 (previous_walk_state);
635 acpi_ds_restart_control_method
637 previous_walk_state->return_desc);
639 if (ACPI_SUCCESS(status)) {
640 walk_state->walk_type |=
641 ACPI_WALK_METHOD_RESTART;
644 /* On error, delete any return object */
646 acpi_ut_remove_reference(previous_walk_state->
652 * Just completed a 1st-level method, save the final internal return
655 else if (previous_walk_state->caller_return_desc) {
656 if (previous_walk_state->implicit_return_obj) {
657 *(previous_walk_state->caller_return_desc) =
658 previous_walk_state->implicit_return_obj;
660 /* NULL if no return value */
662 *(previous_walk_state->caller_return_desc) =
663 previous_walk_state->return_desc;
666 if (previous_walk_state->return_desc) {
668 /* Caller doesn't want it, must delete it */
670 acpi_ut_remove_reference(previous_walk_state->
673 if (previous_walk_state->implicit_return_obj) {
675 /* Caller doesn't want it, must delete it */
677 acpi_ut_remove_reference(previous_walk_state->
678 implicit_return_obj);
682 acpi_ds_delete_walk_state(previous_walk_state);
687 acpi_ex_release_all_mutexes(thread);
688 acpi_ut_delete_generic_state(ACPI_CAST_PTR
689 (union acpi_generic_state, thread));
690 acpi_gbl_current_walk_list = prev_walk_list;
691 return_ACPI_STATUS(status);