1 /******************************************************************************
3 * Module Name: psloop - Main AML parse loop
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2017, 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, (such as
46 * Perl) do. Parsing is done by hand rather than with a YACC generated parser
47 * to tightly constrain stack and dynamic memory usage. Parsing is kept
48 * flexible and the code fairly compact by parsing based on a list of AML
49 * opcode templates in aml_op_info[].
52 #include <acpi/acpi.h>
58 #include "acconvert.h"
60 #define _COMPONENT ACPI_PARSER
61 ACPI_MODULE_NAME("psloop")
63 /* Local prototypes */
65 acpi_ps_get_arguments(struct acpi_walk_state *walk_state,
66 u8 * aml_op_start, union acpi_parse_object *op);
69 acpi_ps_link_module_code(union acpi_parse_object *parent_op,
70 u8 *aml_start, u32 aml_length, acpi_owner_id owner_id);
72 /*******************************************************************************
74 * FUNCTION: acpi_ps_get_arguments
76 * PARAMETERS: walk_state - Current state
77 * aml_op_start - Op start in AML
82 * DESCRIPTION: Get arguments for passed Op.
84 ******************************************************************************/
87 acpi_ps_get_arguments(struct acpi_walk_state *walk_state,
88 u8 * aml_op_start, union acpi_parse_object *op)
90 acpi_status status = AE_OK;
91 union acpi_parse_object *arg = NULL;
92 const struct acpi_opcode_info *op_info;
94 ACPI_FUNCTION_TRACE_PTR(ps_get_arguments, walk_state);
96 ACPI_DEBUG_PRINT((ACPI_DB_PARSE,
97 "Get arguments for opcode [%s]\n",
98 op->common.aml_op_name));
100 switch (op->common.aml_opcode) {
101 case AML_BYTE_OP: /* AML_BYTEDATA_ARG */
102 case AML_WORD_OP: /* AML_WORDDATA_ARG */
103 case AML_DWORD_OP: /* AML_DWORDATA_ARG */
104 case AML_QWORD_OP: /* AML_QWORDATA_ARG */
105 case AML_STRING_OP: /* AML_ASCIICHARLIST_ARG */
107 /* Fill in constant or string argument directly */
109 acpi_ps_get_next_simple_arg(&(walk_state->parser_state),
110 GET_CURRENT_ARG_TYPE(walk_state->
115 case AML_INT_NAMEPATH_OP: /* AML_NAMESTRING_ARG */
117 status = acpi_ps_get_next_namepath(walk_state,
118 &(walk_state->parser_state),
120 ACPI_POSSIBLE_METHOD_CALL);
121 if (ACPI_FAILURE(status)) {
122 return_ACPI_STATUS(status);
125 walk_state->arg_types = 0;
130 * Op is not a constant or string, append each argument to the Op
132 while (GET_CURRENT_ARG_TYPE(walk_state->arg_types) &&
133 !walk_state->arg_count) {
134 walk_state->aml = walk_state->parser_state.aml;
136 switch (op->common.aml_opcode) {
140 case AML_VARIABLE_PACKAGE_OP:
147 ASL_CV_CAPTURE_COMMENTS(walk_state);
152 acpi_ps_get_next_arg(walk_state,
153 &(walk_state->parser_state),
155 (walk_state->arg_types), &arg);
156 if (ACPI_FAILURE(status)) {
157 return_ACPI_STATUS(status);
161 acpi_ps_append_arg(op, arg);
164 INCREMENT_ARG_LIST(walk_state->arg_types);
168 * Handle executable code at "module-level". This refers to
169 * executable opcodes that appear outside of any control method.
171 if ((walk_state->pass_number <= ACPI_IMODE_LOAD_PASS2) &&
172 ((walk_state->parse_flags & ACPI_PARSE_DISASSEMBLE) == 0)) {
174 * We want to skip If/Else/While constructs during Pass1 because we
175 * want to actually conditionally execute the code during Pass2.
177 * Except for disassembly, where we always want to walk the
178 * If/Else/While packages
180 switch (op->common.aml_opcode) {
185 * Currently supported module-level opcodes are:
186 * IF/ELSE/WHILE. These appear to be the most common,
187 * and easiest to support since they open an AML
190 if (walk_state->pass_number ==
191 ACPI_IMODE_LOAD_PASS1) {
192 acpi_ps_link_module_code(op->common.
204 ACPI_DEBUG_PRINT((ACPI_DB_PARSE,
205 "Pass1: Skipping an If/Else/While body\n"));
207 /* Skip body of if/else/while in pass 1 */
209 walk_state->parser_state.aml =
210 walk_state->parser_state.pkg_end;
211 walk_state->arg_count = 0;
216 * Check for an unsupported executable opcode at module
217 * level. We must be in PASS1, the parent must be a SCOPE,
218 * The opcode class must be EXECUTE, and the opcode must
219 * not be an argument to another opcode.
221 if ((walk_state->pass_number ==
222 ACPI_IMODE_LOAD_PASS1)
223 && (op->common.parent->common.aml_opcode ==
226 acpi_ps_get_opcode_info(op->common.
228 if ((op_info->class ==
229 AML_CLASS_EXECUTE) && (!arg)) {
230 ACPI_WARNING((AE_INFO,
231 "Unsupported module-level executable opcode "
232 "0x%.2X at table offset 0x%.4X",
242 acpi_table_header))));
249 /* Special processing for certain opcodes */
251 switch (op->common.aml_opcode) {
254 * Skip parsing of control method because we don't have enough
255 * info in the first pass to parse it correctly.
257 * Save the length and address of the body
259 op->named.data = walk_state->parser_state.aml;
260 op->named.length = (u32)
261 (walk_state->parser_state.pkg_end -
262 walk_state->parser_state.aml);
264 /* Skip body of method */
266 walk_state->parser_state.aml =
267 walk_state->parser_state.pkg_end;
268 walk_state->arg_count = 0;
273 case AML_VARIABLE_PACKAGE_OP:
275 if ((op->common.parent) &&
276 (op->common.parent->common.aml_opcode ==
278 && (walk_state->pass_number <=
279 ACPI_IMODE_LOAD_PASS2)) {
281 * Skip parsing of Buffers and Packages because we don't have
282 * enough info in the first pass to parse them correctly.
284 op->named.data = aml_op_start;
285 op->named.length = (u32)
286 (walk_state->parser_state.pkg_end -
291 walk_state->parser_state.aml =
292 walk_state->parser_state.pkg_end;
293 walk_state->arg_count = 0;
299 if (walk_state->control_state) {
300 walk_state->control_state->control.package_end =
301 walk_state->parser_state.pkg_end;
307 /* No action for all other opcodes */
315 return_ACPI_STATUS(AE_OK);
318 /*******************************************************************************
320 * FUNCTION: acpi_ps_link_module_code
322 * PARAMETERS: parent_op - Parent parser op
323 * aml_start - Pointer to the AML
324 * aml_length - Length of executable AML
325 * owner_id - owner_id of module level code
329 * DESCRIPTION: Wrap the module-level code with a method object and link the
330 * object to the global list. Note, the mutex field of the method
331 * object is used to link multiple module-level code objects.
333 ******************************************************************************/
336 acpi_ps_link_module_code(union acpi_parse_object *parent_op,
337 u8 *aml_start, u32 aml_length, acpi_owner_id owner_id)
339 union acpi_operand_object *prev;
340 union acpi_operand_object *next;
341 union acpi_operand_object *method_obj;
342 struct acpi_namespace_node *parent_node;
344 ACPI_FUNCTION_TRACE(ps_link_module_code);
346 /* Get the tail of the list */
348 prev = next = acpi_gbl_module_code_list;
351 next = next->method.mutex;
355 * Insert the module level code into the list. Merge it if it is
356 * adjacent to the previous element.
359 ((prev->method.aml_start + prev->method.aml_length) != aml_start)) {
361 /* Create, initialize, and link a new temporary method object */
363 method_obj = acpi_ut_create_internal_object(ACPI_TYPE_METHOD);
368 ACPI_DEBUG_PRINT((ACPI_DB_PARSE,
369 "Create/Link new code block: %p\n",
372 if (parent_op->common.node) {
373 parent_node = parent_op->common.node;
375 parent_node = acpi_gbl_root_node;
378 method_obj->method.aml_start = aml_start;
379 method_obj->method.aml_length = aml_length;
380 method_obj->method.owner_id = owner_id;
381 method_obj->method.info_flags |= ACPI_METHOD_MODULE_LEVEL;
384 * Save the parent node in next_object. This is cheating, but we
385 * don't want to expand the method object.
387 method_obj->method.next_object =
388 ACPI_CAST_PTR(union acpi_operand_object, parent_node);
391 acpi_gbl_module_code_list = method_obj;
393 prev->method.mutex = method_obj;
396 ACPI_DEBUG_PRINT((ACPI_DB_PARSE,
397 "Appending to existing code block: %p\n",
400 prev->method.aml_length += aml_length;
406 /*******************************************************************************
408 * FUNCTION: acpi_ps_parse_loop
410 * PARAMETERS: walk_state - Current state
414 * DESCRIPTION: Parse AML (pointed to by the current parser state) and return
417 ******************************************************************************/
419 acpi_status acpi_ps_parse_loop(struct acpi_walk_state *walk_state)
421 acpi_status status = AE_OK;
422 union acpi_parse_object *op = NULL; /* current op */
423 struct acpi_parse_state *parser_state;
424 u8 *aml_op_start = NULL;
426 ACPI_FUNCTION_TRACE_PTR(ps_parse_loop, walk_state);
428 if (walk_state->descending_callback == NULL) {
429 return_ACPI_STATUS(AE_BAD_PARAMETER);
432 parser_state = &walk_state->parser_state;
433 walk_state->arg_types = 0;
435 #if (!defined (ACPI_NO_METHOD_EXECUTION) && !defined (ACPI_CONSTANT_EVAL_ONLY))
437 if (walk_state->walk_type & ACPI_WALK_METHOD_RESTART) {
439 /* We are restarting a preempted control method */
441 if (acpi_ps_has_completed_scope(parser_state)) {
443 * We must check if a predicate to an IF or WHILE statement
446 if ((parser_state->scope->parse_scope.op) &&
447 ((parser_state->scope->parse_scope.op->common.
448 aml_opcode == AML_IF_OP)
449 || (parser_state->scope->parse_scope.op->common.
450 aml_opcode == AML_WHILE_OP))
451 && (walk_state->control_state)
452 && (walk_state->control_state->common.state ==
453 ACPI_CONTROL_PREDICATE_EXECUTING)) {
455 * A predicate was just completed, get the value of the
456 * predicate and branch based on that value
458 walk_state->op = NULL;
460 acpi_ds_get_predicate_value(walk_state,
463 if (ACPI_FAILURE(status)
464 && ((status & AE_CODE_MASK) !=
466 if (status == AE_AML_NO_RETURN_VALUE) {
467 ACPI_EXCEPTION((AE_INFO, status,
468 "Invoked method did not return a value"));
471 ACPI_EXCEPTION((AE_INFO, status,
472 "GetPredicate Failed"));
473 return_ACPI_STATUS(status);
477 acpi_ps_next_parse_state(walk_state, op,
481 acpi_ps_pop_scope(parser_state, &op,
482 &walk_state->arg_types,
483 &walk_state->arg_count);
484 ACPI_DEBUG_PRINT((ACPI_DB_PARSE,
485 "Popped scope, Op=%p\n", op));
486 } else if (walk_state->prev_op) {
488 /* We were in the middle of an op */
490 op = walk_state->prev_op;
491 walk_state->arg_types = walk_state->prev_arg_types;
496 /* Iterative parsing loop, while there is more AML to process: */
498 while ((parser_state->aml < parser_state->aml_end) || (op)) {
499 ASL_CV_CAPTURE_COMMENTS(walk_state);
501 aml_op_start = parser_state->aml;
504 acpi_ps_create_op(walk_state, aml_op_start, &op);
505 if (ACPI_FAILURE(status)) {
506 if (status == AE_CTRL_PARSE_CONTINUE) {
510 if (status == AE_CTRL_PARSE_PENDING) {
514 if (status == AE_CTRL_TERMINATE) {
515 return_ACPI_STATUS(status);
519 acpi_ps_complete_op(walk_state, &op,
521 if (ACPI_FAILURE(status)) {
522 return_ACPI_STATUS(status);
528 acpi_ex_start_trace_opcode(op, walk_state);
532 * Start arg_count at zero because we don't know if there are
535 walk_state->arg_count = 0;
537 switch (op->common.aml_opcode) {
547 ASL_CV_CAPTURE_COMMENTS(walk_state);
551 /* Are there any arguments that must be processed? */
553 if (walk_state->arg_types) {
558 acpi_ps_get_arguments(walk_state, aml_op_start, op);
559 if (ACPI_FAILURE(status)) {
561 acpi_ps_complete_op(walk_state, &op,
563 if (ACPI_FAILURE(status)) {
564 return_ACPI_STATUS(status);
571 /* Check for arguments that need to be processed */
573 if (walk_state->arg_count) {
575 * There are arguments (complex ones), push Op and
576 * prepare for argument
578 status = acpi_ps_push_scope(parser_state, op,
579 walk_state->arg_types,
580 walk_state->arg_count);
581 if (ACPI_FAILURE(status)) {
583 acpi_ps_complete_op(walk_state, &op,
585 if (ACPI_FAILURE(status)) {
586 return_ACPI_STATUS(status);
597 * All arguments have been processed -- Op is complete,
600 walk_state->op_info =
601 acpi_ps_get_opcode_info(op->common.aml_opcode);
602 if (walk_state->op_info->flags & AML_NAMED) {
603 if (op->common.aml_opcode == AML_REGION_OP ||
604 op->common.aml_opcode == AML_DATA_REGION_OP) {
606 * Skip parsing of control method or opregion body,
607 * because we don't have enough info in the first pass
608 * to parse them correctly.
610 * Completed parsing an op_region declaration, we now
614 (u32) (parser_state->aml - op->named.data);
618 if (walk_state->op_info->flags & AML_CREATE) {
620 * Backup to beginning of create_XXXfield declaration (1 for
623 * body_length is unknown until we parse the body
626 (u32) (parser_state->aml - op->named.data);
629 if (op->common.aml_opcode == AML_BANK_FIELD_OP) {
631 * Backup to beginning of bank_field declaration
633 * body_length is unknown until we parse the body
636 (u32) (parser_state->aml - op->named.data);
639 /* This op complete, notify the dispatcher */
641 if (walk_state->ascending_callback != NULL) {
643 walk_state->opcode = op->common.aml_opcode;
645 status = walk_state->ascending_callback(walk_state);
647 acpi_ps_next_parse_state(walk_state, op, status);
648 if (status == AE_CTRL_PENDING) {
653 status = acpi_ps_complete_op(walk_state, &op, status);
654 if (ACPI_FAILURE(status)) {
655 return_ACPI_STATUS(status);
658 } /* while parser_state->Aml */
660 status = acpi_ps_complete_final_op(walk_state, op, status);
661 return_ACPI_STATUS(status);