1 /******************************************************************************
3 * Module Name: psparse - Parser top level AML parse routines
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2015, 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>
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;
140 acpi_status status = AE_OK;
142 ACPI_FUNCTION_TRACE_PTR(ps_complete_this_op, op);
144 /* Check for null Op, can happen if AML code is corrupt */
147 return_ACPI_STATUS(AE_OK); /* OK for now */
150 acpi_ex_stop_trace_opcode(op, walk_state);
152 /* Delete this op and the subtree below it if asked to */
154 if (((walk_state->parse_flags & ACPI_PARSE_TREE_MASK) !=
155 ACPI_PARSE_DELETE_TREE)
156 || (walk_state->op_info->class == AML_CLASS_ARGUMENT)) {
157 return_ACPI_STATUS(AE_OK);
160 /* Make sure that we only delete this subtree */
162 if (op->common.parent) {
163 prev = op->common.parent->common.value.arg;
166 /* Nothing more to do */
172 * Check if we need to replace the operator and its subtree
173 * with a return value op (placeholder op)
176 acpi_ps_get_opcode_info(op->common.parent->common.
179 switch (parent_info->class) {
180 case AML_CLASS_CONTROL:
184 case AML_CLASS_CREATE:
186 * These opcodes contain term_arg operands. The current
187 * op must be replaced by a placeholder return op
190 acpi_ps_alloc_op(AML_INT_RETURN_VALUE_OP,
192 if (!replacement_op) {
193 status = AE_NO_MEMORY;
197 case AML_CLASS_NAMED_OBJECT:
199 * These opcodes contain term_arg operands. The current
200 * op must be replaced by a placeholder return op
202 if ((op->common.parent->common.aml_opcode ==
204 || (op->common.parent->common.aml_opcode ==
206 || (op->common.parent->common.aml_opcode ==
208 || (op->common.parent->common.aml_opcode ==
210 || (op->common.parent->common.aml_opcode ==
212 || (op->common.parent->common.aml_opcode ==
213 AML_VAR_PACKAGE_OP)) {
215 acpi_ps_alloc_op(AML_INT_RETURN_VALUE_OP,
217 if (!replacement_op) {
218 status = AE_NO_MEMORY;
221 if ((op->common.parent->common.aml_opcode ==
223 && (walk_state->pass_number <=
224 ACPI_IMODE_LOAD_PASS2)) {
225 if ((op->common.aml_opcode == AML_BUFFER_OP)
226 || (op->common.aml_opcode == AML_PACKAGE_OP)
227 || (op->common.aml_opcode ==
228 AML_VAR_PACKAGE_OP)) {
230 acpi_ps_alloc_op(op->common.
233 if (!replacement_op) {
234 status = AE_NO_MEMORY;
236 replacement_op->named.data =
238 replacement_op->named.length =
248 acpi_ps_alloc_op(AML_INT_RETURN_VALUE_OP,
250 if (!replacement_op) {
251 status = AE_NO_MEMORY;
255 /* We must unlink this op from the parent tree */
259 /* This op is the first in the list */
261 if (replacement_op) {
262 replacement_op->common.parent =
264 replacement_op->common.value.arg = NULL;
265 replacement_op->common.node = op->common.node;
266 op->common.parent->common.value.arg =
268 replacement_op->common.next = op->common.next;
270 op->common.parent->common.value.arg =
275 /* Search the parent list */
280 /* Traverse all siblings in the parent's argument list */
282 next = prev->common.next;
284 if (replacement_op) {
285 replacement_op->common.parent =
287 replacement_op->common.value.
289 replacement_op->common.node =
293 replacement_op->common.next =
308 /* Now we can actually delete the subtree rooted at Op */
310 acpi_ps_delete_parse_tree(op);
311 return_ACPI_STATUS(status);
314 /*******************************************************************************
316 * FUNCTION: acpi_ps_next_parse_state
318 * PARAMETERS: walk_state - Current state
319 * op - Current parse op
320 * callback_status - Status from previous operation
324 * DESCRIPTION: Update the parser state based upon the return exception from
325 * the parser callback.
327 ******************************************************************************/
330 acpi_ps_next_parse_state(struct acpi_walk_state *walk_state,
331 union acpi_parse_object *op,
332 acpi_status callback_status)
334 struct acpi_parse_state *parser_state = &walk_state->parser_state;
335 acpi_status status = AE_CTRL_PENDING;
337 ACPI_FUNCTION_TRACE_PTR(ps_next_parse_state, op);
339 switch (callback_status) {
340 case AE_CTRL_TERMINATE:
342 * A control method was terminated via a RETURN statement.
343 * The walk of this method is complete.
345 parser_state->aml = parser_state->aml_end;
346 status = AE_CTRL_TERMINATE;
351 parser_state->aml = walk_state->aml_last_while;
352 walk_state->control_state->common.value = FALSE;
353 status = AE_CTRL_BREAK;
356 case AE_CTRL_CONTINUE:
358 parser_state->aml = walk_state->aml_last_while;
359 status = AE_CTRL_CONTINUE;
362 case AE_CTRL_PENDING:
364 parser_state->aml = walk_state->aml_last_while;
370 parser_state->aml = parser_state->scope->parse_scope.pkg_end;
377 * Predicate of an IF was true, and we are at the matching ELSE.
378 * Just close out this package
380 parser_state->aml = acpi_ps_get_next_package_end(parser_state);
381 status = AE_CTRL_PENDING;
386 * Either an IF/WHILE Predicate was false or we encountered a BREAK
387 * opcode. In both cases, we do not execute the rest of the
388 * package; We simply close out the parent (finishing the walk of
389 * this branch of the tree) and continue execution at the parent
392 parser_state->aml = parser_state->scope->parse_scope.pkg_end;
394 /* In the case of a BREAK, just force a predicate (if any) to FALSE */
396 walk_state->control_state->common.value = FALSE;
397 status = AE_CTRL_END;
400 case AE_CTRL_TRANSFER:
402 /* A method call (invocation) -- transfer control */
404 status = AE_CTRL_TRANSFER;
405 walk_state->prev_op = op;
406 walk_state->method_call_op = op;
407 walk_state->method_call_node =
408 (op->common.value.arg)->common.node;
410 /* Will return value (if any) be used by the caller? */
412 walk_state->return_used =
413 acpi_ds_is_result_used(op, walk_state);
418 status = callback_status;
419 if ((callback_status & AE_CODE_MASK) == AE_CODE_CONTROL) {
425 return_ACPI_STATUS(status);
428 /*******************************************************************************
430 * FUNCTION: acpi_ps_parse_aml
432 * PARAMETERS: walk_state - Current state
437 * DESCRIPTION: Parse raw AML and return a tree of ops
439 ******************************************************************************/
441 acpi_status acpi_ps_parse_aml(struct acpi_walk_state *walk_state)
444 struct acpi_thread_state *thread;
445 struct acpi_thread_state *prev_walk_list = acpi_gbl_current_walk_list;
446 struct acpi_walk_state *previous_walk_state;
448 ACPI_FUNCTION_TRACE(ps_parse_aml);
450 ACPI_DEBUG_PRINT((ACPI_DB_PARSE,
451 "Entered with WalkState=%p Aml=%p size=%X\n",
452 walk_state, walk_state->parser_state.aml,
453 walk_state->parser_state.aml_size));
455 if (!walk_state->parser_state.aml) {
456 return_ACPI_STATUS(AE_NULL_OBJECT);
459 /* Create and initialize a new thread state */
461 thread = acpi_ut_create_thread_state();
463 if (walk_state->method_desc) {
465 /* Executing a control method - additional cleanup */
467 acpi_ds_terminate_control_method(walk_state->
472 acpi_ds_delete_walk_state(walk_state);
473 return_ACPI_STATUS(AE_NO_MEMORY);
476 walk_state->thread = thread;
479 * If executing a method, the starting sync_level is this method's
482 if (walk_state->method_desc) {
483 walk_state->thread->current_sync_level =
484 walk_state->method_desc->method.sync_level;
487 acpi_ds_push_walk_state(walk_state, thread);
490 * This global allows the AML debugger to get a handle to the currently
491 * executing control method.
493 acpi_gbl_current_walk_list = thread;
496 * Execute the walk loop as long as there is a valid Walk State. This
497 * handles nested control method invocations without recursion.
499 ACPI_DEBUG_PRINT((ACPI_DB_PARSE, "State=%p\n", walk_state));
503 if (ACPI_SUCCESS(status)) {
505 * The parse_loop executes AML until the method terminates
506 * or calls another method.
508 status = acpi_ps_parse_loop(walk_state);
511 ACPI_DEBUG_PRINT((ACPI_DB_PARSE,
512 "Completed one call to walk loop, %s State=%p\n",
513 acpi_format_exception(status), walk_state));
515 if (status == AE_CTRL_TRANSFER) {
517 * A method call was detected.
518 * Transfer control to the called control method
521 acpi_ds_call_control_method(thread, walk_state,
523 if (ACPI_FAILURE(status)) {
525 acpi_ds_method_error(status, walk_state);
529 * If the transfer to the new method method call worked
530 *, a new walk state was created -- get it
532 walk_state = acpi_ds_get_current_walk_state(thread);
534 } else if (status == AE_CTRL_TERMINATE) {
536 } else if ((status != AE_OK) && (walk_state->method_desc)) {
538 /* Either the method parse or actual execution failed */
540 ACPI_ERROR_METHOD("Method parse/execution failed",
541 walk_state->method_node, NULL,
544 /* Check for possible multi-thread reentrancy problem */
546 if ((status == AE_ALREADY_EXISTS) &&
547 (!(walk_state->method_desc->method.info_flags &
548 ACPI_METHOD_SERIALIZED))) {
550 * Method is not serialized and tried to create an object
551 * twice. The probable cause is that the method cannot
552 * handle reentrancy. Mark as "pending serialized" now, and
553 * then mark "serialized" when the last thread exits.
555 walk_state->method_desc->method.info_flags |=
556 ACPI_METHOD_SERIALIZED_PENDING;
560 /* We are done with this walk, move on to the parent if any */
562 walk_state = acpi_ds_pop_walk_state(thread);
564 /* Reset the current scope to the beginning of scope stack */
566 acpi_ds_scope_stack_clear(walk_state);
569 * If we just returned from the execution of a control method or if we
570 * encountered an error during the method parse phase, there's lots of
573 if (((walk_state->parse_flags & ACPI_PARSE_MODE_MASK) ==
574 ACPI_PARSE_EXECUTE) || (ACPI_FAILURE(status))) {
575 acpi_ds_terminate_control_method(walk_state->
580 /* Delete this walk state and all linked control states */
582 acpi_ps_cleanup_scope(&walk_state->parser_state);
583 previous_walk_state = walk_state;
585 ACPI_DEBUG_PRINT((ACPI_DB_PARSE,
586 "ReturnValue=%p, ImplicitValue=%p State=%p\n",
587 walk_state->return_desc,
588 walk_state->implicit_return_obj, walk_state));
590 /* Check if we have restarted a preempted walk */
592 walk_state = acpi_ds_get_current_walk_state(thread);
594 if (ACPI_SUCCESS(status)) {
596 * There is another walk state, restart it.
597 * If the method return value is not used by the parent,
598 * The object is deleted
600 if (!previous_walk_state->return_desc) {
602 * In slack mode execution, if there is no return value
603 * we should implicitly return zero (0) as a default value.
605 if (acpi_gbl_enable_interpreter_slack &&
606 !previous_walk_state->
607 implicit_return_obj) {
608 previous_walk_state->
609 implicit_return_obj =
610 acpi_ut_create_integer_object
612 if (!previous_walk_state->
613 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 or implicit return */
646 acpi_ut_remove_reference(previous_walk_state->
648 acpi_ds_clear_implicit_return
649 (previous_walk_state);
654 * Just completed a 1st-level method, save the final internal return
657 else if (previous_walk_state->caller_return_desc) {
658 if (previous_walk_state->implicit_return_obj) {
659 *(previous_walk_state->caller_return_desc) =
660 previous_walk_state->implicit_return_obj;
662 /* NULL if no return value */
664 *(previous_walk_state->caller_return_desc) =
665 previous_walk_state->return_desc;
668 if (previous_walk_state->return_desc) {
670 /* Caller doesn't want it, must delete it */
672 acpi_ut_remove_reference(previous_walk_state->
675 if (previous_walk_state->implicit_return_obj) {
677 /* Caller doesn't want it, must delete it */
679 acpi_ut_remove_reference(previous_walk_state->
680 implicit_return_obj);
684 acpi_ds_delete_walk_state(previous_walk_state);
689 acpi_ex_release_all_mutexes(thread);
690 acpi_ut_delete_generic_state(ACPI_CAST_PTR
691 (union acpi_generic_state, thread));
692 acpi_gbl_current_walk_list = prev_walk_list;
693 return_ACPI_STATUS(status);