Commit 4d0b4af9 authored by Mikhail Kouzmich's avatar Mikhail Kouzmich Committed by Len Brown
Browse files

ACPICA: Restructured module into multiple functions.



Restructured the AML ParseLoop function, breaking it into several
subfunctions in order to reduce CPU stack use and improve maintainability
Signed-off-by: default avatarBob Moore <robert.moore@intel.com>
Signed-off-by: default avatarAlexey Starikovskiy <alexey.y.starikovskiy@intel.com>
Signed-off-by: default avatarLen Brown <len.brown@intel.com>
parent 2b705a8a
......@@ -42,12 +42,11 @@
*/
/*
* Parse the AML and build an operation tree as most interpreters,
* like Perl, do. Parsing is done by hand rather than with a YACC
* generated parser to tightly constrain stack and dynamic memory
* usage. At the same time, parsing is kept flexible and the code
* fairly compact by parsing based on a list of AML opcode
* templates in aml_op_info[]
* Parse the AML and build an operation tree as most interpreters, (such as
* Perl) do. Parsing is done by hand rather than with a YACC generated parser
* to tightly constrain stack and dynamic memory usage. Parsing is kept
* flexible and the code fairly compact by parsing based on a list of AML
* opcode templates in aml_op_info[].
*/
#include <acpi/acpi.h>
......@@ -60,111 +59,53 @@ ACPI_MODULE_NAME("psloop")
static u32 acpi_gbl_depth = 0;
/* Local prototypes */
static acpi_status acpi_ps_get_aml_opcode(struct acpi_walk_state *walk_state);
static acpi_status
acpi_ps_build_named_op(struct acpi_walk_state *walk_state,
u8 * aml_op_start,
union acpi_parse_object *unnamed_op,
union acpi_parse_object **op);
static acpi_status
acpi_ps_create_op(struct acpi_walk_state *walk_state,
u8 * aml_op_start, union acpi_parse_object **new_op);
static acpi_status
acpi_ps_get_arguments(struct acpi_walk_state *walk_state,
u8 * aml_op_start, union acpi_parse_object *op);
static acpi_status
acpi_ps_complete_op(struct acpi_walk_state *walk_state,
union acpi_parse_object **op, acpi_status status);
static acpi_status
acpi_ps_complete_final_op(struct acpi_walk_state *walk_state,
union acpi_parse_object *op, acpi_status status);
/*******************************************************************************
*
* FUNCTION: acpi_ps_parse_loop
* FUNCTION: acpi_ps_get_aml_opcode
*
* PARAMETERS: walk_state - Current state
*
* RETURN: Status
*
* DESCRIPTION: Parse AML (pointed to by the current parser state) and return
* a tree of ops.
* DESCRIPTION: Extract the next AML opcode from the input stream.
*
******************************************************************************/
acpi_status acpi_ps_parse_loop(struct acpi_walk_state *walk_state)
static acpi_status acpi_ps_get_aml_opcode(struct acpi_walk_state *walk_state)
{
acpi_status status = AE_OK;
acpi_status status2;
union acpi_parse_object *op = NULL; /* current op */
union acpi_parse_object *arg = NULL;
union acpi_parse_object *pre_op = NULL;
struct acpi_parse_state *parser_state;
u8 *aml_op_start = NULL;
ACPI_FUNCTION_TRACE_PTR(ps_parse_loop, walk_state);
if (walk_state->descending_callback == NULL) {
return_ACPI_STATUS(AE_BAD_PARAMETER);
}
parser_state = &walk_state->parser_state;
walk_state->arg_types = 0;
#if (!defined (ACPI_NO_METHOD_EXECUTION) && !defined (ACPI_CONSTANT_EVAL_ONLY))
if (walk_state->walk_type & ACPI_WALK_METHOD_RESTART) {
/* We are restarting a preempted control method */
if (acpi_ps_has_completed_scope(parser_state)) {
/*
* We must check if a predicate to an IF or WHILE statement
* was just completed
*/
if ((parser_state->scope->parse_scope.op) &&
((parser_state->scope->parse_scope.op->common.
aml_opcode == AML_IF_OP)
|| (parser_state->scope->parse_scope.op->common.
aml_opcode == AML_WHILE_OP))
&& (walk_state->control_state)
&& (walk_state->control_state->common.state ==
ACPI_CONTROL_PREDICATE_EXECUTING)) {
/*
* A predicate was just completed, get the value of the
* predicate and branch based on that value
*/
walk_state->op = NULL;
status =
acpi_ds_get_predicate_value(walk_state,
ACPI_TO_POINTER
(TRUE));
if (ACPI_FAILURE(status)
&& ((status & AE_CODE_MASK) !=
AE_CODE_CONTROL)) {
if (status == AE_AML_NO_RETURN_VALUE) {
ACPI_EXCEPTION((AE_INFO, status,
"Invoked method did not return a value"));
}
ACPI_EXCEPTION((AE_INFO, status,
"GetPredicate Failed"));
return_ACPI_STATUS(status);
}
status =
acpi_ps_next_parse_state(walk_state, op,
status);
}
acpi_ps_pop_scope(parser_state, &op,
&walk_state->arg_types,
&walk_state->arg_count);
ACPI_DEBUG_PRINT((ACPI_DB_PARSE,
"Popped scope, Op=%p\n", op));
} else if (walk_state->prev_op) {
/* We were in the middle of an op */
op = walk_state->prev_op;
walk_state->arg_types = walk_state->prev_arg_types;
}
}
#endif
/* Iterative parsing loop, while there is more AML to process: */
while ((parser_state->aml < parser_state->aml_end) || (op)) {
aml_op_start = parser_state->aml;
if (!op) {
/* Get the next opcode from the AML stream */
ACPI_FUNCTION_TRACE_PTR(ps_get_aml_opcode, walk_state);
walk_state->aml_offset =
(u32) ACPI_PTR_DIFF(parser_state->aml,
parser_state->aml_start);
walk_state->opcode = acpi_ps_peek_opcode(parser_state);
(u32) ACPI_PTR_DIFF(walk_state->parser_state.aml,
walk_state->parser_state.aml_start);
walk_state->opcode = acpi_ps_peek_opcode(&(walk_state->parser_state));
/*
* First cut to determine what we have found:
......@@ -172,8 +113,8 @@ acpi_status acpi_ps_parse_loop(struct acpi_walk_state *walk_state)
* 2) A name string
* 3) An unknown/invalid opcode
*/
walk_state->op_info =
acpi_ps_get_opcode_info(walk_state->opcode);
walk_state->op_info = acpi_ps_get_opcode_info(walk_state->opcode);
switch (walk_state->op_info->class) {
case AML_CLASS_ASCII:
case AML_CLASS_PREFIX:
......@@ -191,80 +132,82 @@ acpi_status acpi_ps_parse_loop(struct acpi_walk_state *walk_state)
ACPI_ERROR((AE_INFO,
"Found unknown opcode %X at AML address %p offset %X, ignoring",
walk_state->opcode,
parser_state->aml,
walk_state->opcode, walk_state->parser_state.aml,
walk_state->aml_offset));
ACPI_DUMP_BUFFER(parser_state->aml, 128);
ACPI_DUMP_BUFFER(walk_state->parser_state.aml, 128);
/* Assume one-byte bad opcode */
parser_state->aml++;
continue;
walk_state->parser_state.aml++;
return_ACPI_STATUS(AE_CTRL_PARSE_CONTINUE);
default:
/* Found opcode info, this is a normal opcode */
parser_state->aml +=
walk_state->parser_state.aml +=
acpi_ps_get_opcode_size(walk_state->opcode);
walk_state->arg_types =
walk_state->op_info->parse_args;
walk_state->arg_types = walk_state->op_info->parse_args;
break;
}
/* Create Op structure and append to parent's argument list */
return_ACPI_STATUS(AE_OK);
}
if (walk_state->op_info->flags & AML_NAMED) {
/*******************************************************************************
*
* FUNCTION: acpi_ps_build_named_op
*
* PARAMETERS: walk_state - Current state
* aml_op_start - Begin of named Op in AML
* unnamed_op - Early Op (not a named Op)
* Op - Returned Op
*
* RETURN: Status
*
* DESCRIPTION: Parse a named Op
*
******************************************************************************/
/* Allocate a new pre_op if necessary */
static acpi_status
acpi_ps_build_named_op(struct acpi_walk_state *walk_state,
u8 * aml_op_start,
union acpi_parse_object *unnamed_op,
union acpi_parse_object **op)
{
acpi_status status = AE_OK;
union acpi_parse_object *arg = NULL;
if (!pre_op) {
pre_op =
acpi_ps_alloc_op(walk_state->
opcode);
if (!pre_op) {
status = AE_NO_MEMORY;
goto close_this_op;
}
}
ACPI_FUNCTION_TRACE_PTR(ps_build_named_op, walk_state);
pre_op->common.value.arg = NULL;
pre_op->common.aml_opcode = walk_state->opcode;
unnamed_op->common.value.arg = NULL;
unnamed_op->common.aml_opcode = walk_state->opcode;
/*
* Get and append arguments until we find the node that contains
* the name (the type ARGP_NAME).
*/
while (GET_CURRENT_ARG_TYPE
(walk_state->arg_types)
&&
(GET_CURRENT_ARG_TYPE
(walk_state->arg_types) != ARGP_NAME)) {
while (GET_CURRENT_ARG_TYPE(walk_state->arg_types) &&
(GET_CURRENT_ARG_TYPE(walk_state->arg_types) != ARGP_NAME)) {
status =
acpi_ps_get_next_arg(walk_state,
parser_state,
GET_CURRENT_ARG_TYPE
(walk_state->
arg_types),
&arg);
&(walk_state->parser_state),
GET_CURRENT_ARG_TYPE(walk_state->
arg_types), &arg);
if (ACPI_FAILURE(status)) {
goto close_this_op;
return_ACPI_STATUS(status);
}
acpi_ps_append_arg(pre_op, arg);
INCREMENT_ARG_LIST(walk_state->
arg_types);
acpi_ps_append_arg(unnamed_op, arg);
INCREMENT_ARG_LIST(walk_state->arg_types);
}
/*
* Make sure that we found a NAME and didn't run out of
* arguments
* Make sure that we found a NAME and didn't run out of arguments
*/
if (!GET_CURRENT_ARG_TYPE
(walk_state->arg_types)) {
status = AE_AML_NO_OPERAND;
goto close_this_op;
if (!GET_CURRENT_ARG_TYPE(walk_state->arg_types)) {
return_ACPI_STATUS(AE_AML_NO_OPERAND);
}
/* We know that this arg is a name, move to next arg */
......@@ -277,62 +220,97 @@ acpi_status acpi_ps_parse_loop(struct acpi_walk_state *walk_state)
*/
walk_state->op = NULL;
status =
walk_state->descending_callback(walk_state,
&op);
status = walk_state->descending_callback(walk_state, op);
if (ACPI_FAILURE(status)) {
ACPI_EXCEPTION((AE_INFO, status,
"During name lookup/catalog"));
goto close_this_op;
ACPI_EXCEPTION((AE_INFO, status, "During name lookup/catalog"));
return_ACPI_STATUS(status);
}
if (!op) {
continue;
return_ACPI_STATUS(AE_CTRL_PARSE_CONTINUE);
}
status =
acpi_ps_next_parse_state(walk_state, op,
status);
status = acpi_ps_next_parse_state(walk_state, *op, status);
if (ACPI_FAILURE(status)) {
if (status == AE_CTRL_PENDING) {
status = AE_OK;
goto close_this_op;
return_ACPI_STATUS(AE_CTRL_PARSE_PENDING);
}
if (ACPI_FAILURE(status)) {
goto close_this_op;
return_ACPI_STATUS(status);
}
acpi_ps_append_arg(op,
pre_op->common.value.arg);
acpi_ps_append_arg(*op, unnamed_op->common.value.arg);
acpi_gbl_depth++;
if (op->common.aml_opcode == AML_REGION_OP) {
if ((*op)->common.aml_opcode == AML_REGION_OP) {
/*
* Defer final parsing of an operation_region body,
* because we don't have enough info in the first pass
* to parse it correctly (i.e., there may be method
* calls within the term_arg elements of the body.)
* Defer final parsing of an operation_region body, because we don't
* have enough info in the first pass to parse it correctly (i.e.,
* there may be method calls within the term_arg elements of the body.)
*
* However, we must continue parsing because
* the opregion is not a standalone package --
* we don't know where the end is at this point.
* However, we must continue parsing because the opregion is not a
* standalone package -- we don't know where the end is at this point.
*
* (Length is unknown until parse of the body complete)
*/
op->named.data = aml_op_start;
op->named.length = 0;
(*op)->named.data = aml_op_start;
(*op)->named.length = 0;
}
} else {
/* Not a named opcode, just allocate Op and append to parent */
walk_state->op_info =
acpi_ps_get_opcode_info(walk_state->opcode);
return_ACPI_STATUS(AE_OK);
}
/*******************************************************************************
*
* FUNCTION: acpi_ps_create_op
*
* PARAMETERS: walk_state - Current state
* aml_op_start - Op start in AML
* new_op - Returned Op
*
* RETURN: Status
*
* DESCRIPTION: Get Op from AML
*
******************************************************************************/
static acpi_status
acpi_ps_create_op(struct acpi_walk_state *walk_state,
u8 * aml_op_start, union acpi_parse_object **new_op)
{
acpi_status status = AE_OK;
union acpi_parse_object *op;
union acpi_parse_object *named_op = NULL;
ACPI_FUNCTION_TRACE_PTR(ps_create_op, walk_state);
status = acpi_ps_get_aml_opcode(walk_state);
if (status == AE_CTRL_PARSE_CONTINUE) {
return_ACPI_STATUS(AE_CTRL_PARSE_CONTINUE);
}
/* Create Op structure and append to parent's argument list */
walk_state->op_info = acpi_ps_get_opcode_info(walk_state->opcode);
op = acpi_ps_alloc_op(walk_state->opcode);
if (!op) {
status = AE_NO_MEMORY;
goto close_this_op;
return_ACPI_STATUS(AE_NO_MEMORY);
}
if (walk_state->op_info->flags & AML_NAMED) {
status =
acpi_ps_build_named_op(walk_state, aml_op_start, op,
&named_op);
acpi_ps_free_op(op);
if (ACPI_FAILURE(status)) {
return_ACPI_STATUS(status);
}
*new_op = named_op;
return_ACPI_STATUS(AE_OK);
}
/* Not a named opcode, just allocate Op and append to parent */
if (walk_state->op_info->flags & AML_CREATE) {
/*
* Backup to beginning of create_xXXfield declaration
......@@ -343,57 +321,47 @@ acpi_status acpi_ps_parse_loop(struct acpi_walk_state *walk_state)
}
acpi_ps_append_arg(acpi_ps_get_parent_scope
(parser_state), op);
(&(walk_state->parser_state)), op);
if ((walk_state->descending_callback != NULL)) {
if (walk_state->descending_callback != NULL) {
/*
* Find the object. This will either insert the object into
* the namespace or simply look it up
*/
walk_state->op = op;
walk_state->op = *new_op = op;
status =
walk_state->
descending_callback(walk_state,
&op);
status =
acpi_ps_next_parse_state(walk_state,
op,
status);
status = walk_state->descending_callback(walk_state, &op);
status = acpi_ps_next_parse_state(walk_state, op, status);
if (status == AE_CTRL_PENDING) {
status = AE_OK;
goto close_this_op;
}
if (ACPI_FAILURE(status)) {
goto close_this_op;
}
}
}
op->common.aml_offset = walk_state->aml_offset;
if (walk_state->op_info) {
ACPI_DEBUG_PRINT((ACPI_DB_PARSE,
"Opcode %4.4X [%s] Op %p Aml %p AmlOffset %5.5X\n",
(u32) op->common.aml_opcode,
walk_state->op_info->name, op,
parser_state->aml,
op->common.aml_offset));
status = AE_CTRL_PARSE_PENDING;
}
}
/*
* Start arg_count at zero because we don't know if there are
* any args yet
*/
walk_state->arg_count = 0;
return_ACPI_STATUS(status);
}
/* Are there any arguments that must be processed? */
/*******************************************************************************
*
* FUNCTION: acpi_ps_get_arguments
*
* PARAMETERS: walk_state - Current state
* aml_op_start - Op start in AML
* Op - Current Op
*
* RETURN: Status
*
* DESCRIPTION: Get arguments for passed Op.
*
******************************************************************************/
if (walk_state->arg_types) {
static acpi_status
acpi_ps_get_arguments(struct acpi_walk_state *walk_state,
u8 * aml_op_start, union acpi_parse_object *op)
{
acpi_status status = AE_OK;
union acpi_parse_object *arg = NULL;
/* Get arguments */
ACPI_FUNCTION_TRACE_PTR(ps_get_arguments, walk_state);
switch (op->common.aml_opcode) {
case AML_BYTE_OP: /* AML_BYTEDATA_ARG */
......@@ -404,20 +372,20 @@ acpi_status acpi_ps_parse_loop(struct acpi_walk_state *walk_state)
/* Fill in constant or string argument directly */
acpi_ps_get_next_simple_arg(parser_state,
GET_CURRENT_ARG_TYPE
(walk_state->
arg_types), op);
acpi_ps_get_next_simple_arg(&(walk_state->parser_state),
GET_CURRENT_ARG_TYPE(walk_state->
arg_types),
op);
break;
case AML_INT_NAMEPATH_OP: /* AML_NAMESTRING_ARG */
status =
acpi_ps_get_next_namepath(walk_state,
parser_state, op,
&(walk_state->parser_state), op,
1);
if (ACPI_FAILURE(status)) {
goto close_this_op;
return_ACPI_STATUS(status);
}
walk_state->arg_types = 0;
......@@ -425,35 +393,30 @@ acpi_status acpi_ps_parse_loop(struct acpi_walk_state *walk_state)
default:
/*
* Op is not a constant or string, append each argument
* to the Op
* Op is not a constant or string, append each argument to the Op
*/
while (GET_CURRENT_ARG_TYPE
(walk_state->arg_types)
while (GET_CURRENT_ARG_TYPE(walk_state->arg_types)
&& !walk_state->arg_count) {
walk_state->aml_offset = (u32)
ACPI_PTR_DIFF(parser_state->aml,
parser_state->
walk_state->aml_offset =
(u32) ACPI_PTR_DIFF(walk_state->parser_state.aml,
walk_state->parser_state.
aml_start);
status =
acpi_ps_get_next_arg(walk_state,
parser_state,
&(walk_state->parser_state),
GET_CURRENT_ARG_TYPE
(walk_state->
arg_types),
&arg);
(walk_state->arg_types), &arg);
if (ACPI_FAILURE(status)) {
goto close_this_op;
return_ACPI_STATUS(status);
}
if (arg) {
arg->common.aml_offset =
walk_state->aml_offset;
arg->common.aml_offset = walk_state->aml_offset;
acpi_ps_append_arg(op, arg);
}
INCREMENT_ARG_LIST(walk_state->
arg_types);
INCREMENT_ARG_LIST(walk_state->arg_types);
}
/* Special processing for certain opcodes */
......@@ -462,19 +425,14 @@ acpi_status acpi_ps_parse_loop(struct acpi_walk_state *walk_state)
#ifdef ACPI_ENABLE_MODULE_LEVEL_CODE
if ((walk_state->pass_number <=
ACPI_IMODE_LOAD_PASS1)
&&
((walk_state->
parse_flags & ACPI_PARSE_DISASSEMBLE) ==
0)) {
if ((walk_state->pass_number <= ACPI_IMODE_LOAD_PASS1) &&
((walk_state->parse_flags & ACPI_PARSE_DISASSEMBLE) == 0)) {
/*
* We want to skip If/Else/While constructs during Pass1
* because we want to actually conditionally execute the
* code during Pass2.
* We want to skip If/Else/While constructs during Pass1 because we
* want to actually conditionally execute the code during Pass2.
*
* Except for disassembly, where we always want to
* walk the If/Else/While packages
* Except for disassembly, where we always want to walk the
* If/Else/While packages
*/
switch (op->common.aml_opcode) {
case AML_IF_OP:
......@@ -486,8 +444,8 @@ acpi_status acpi_ps_parse_loop(struct acpi_walk_state *walk_state)
/* Skip body of if/else/while in pass 1 */
parser_state->aml =
parser_state->pkg_end;
walk_state->parser_state.aml =
walk_state->parser_state.pkg_end;
walk_state->arg_count = 0;
break;
......@@ -496,25 +454,24 @@ acpi_status acpi_ps_parse_loop(struct acpi_walk_state *walk_state)