source/components/namespace/nsparse.c - third_party/acpica - Git at Google

 /******************************************************************************
  *
  * Module Name: nsparse - namespace interface to AML parser
  *
  *****************************************************************************/

 /*
  * Copyright (C) 2000 - 2020, Intel Corp.
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
  * 1. Redistributions of source code must retain the above copyright
  *    notice, this list of conditions, and the following disclaimer,
  *    without modification.
  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
  *    substantially similar to the "NO WARRANTY" disclaimer below
  *    ("Disclaimer") and any redistribution must be conditioned upon
  *    including a substantially similar Disclaimer requirement for further
  *    binary redistribution.
  * 3. Neither the names of the above-listed copyright holders nor the names
  *    of any contributors may be used to endorse or promote products derived
  *    from this software without specific prior written permission.
  *
  * NO WARRANTY
  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  * POSSIBILITY OF SUCH DAMAGES.
  */

 #include "acpi.h"
 #include "accommon.h"
 #include "acnamesp.h"
 #include "acparser.h"
 #include "acdispat.h"
 #include "actables.h"
 #include "acinterp.h"


 #define _COMPONENT          ACPI_NAMESPACE
         ACPI_MODULE_NAME    ("nsparse")


 /*******************************************************************************
  *
  * FUNCTION:    NsExecuteTable
  *
  * PARAMETERS:  TableDesc       - An ACPI table descriptor for table to parse
  *              StartNode       - Where to enter the table into the namespace
  *
  * RETURN:      Status
  *
  * DESCRIPTION: Load ACPI/AML table by executing the entire table as a single
  *              large control method.
  *
  * NOTE: The point of this is to execute any module-level code in-place
  * as the table is parsed. Some AML code depends on this behavior.
  *
  * It is a run-time option at this time, but will eventually become
  * the default.
  *
  * Note: This causes the table to only have a single-pass parse.
  * However, this is compatible with other ACPI implementations.
  *
  ******************************************************************************/

 ACPI_STATUS
 AcpiNsExecuteTable (
     UINT32                  TableIndex,
     ACPI_NAMESPACE_NODE     *StartNode)
 {
     ACPI_STATUS             Status;
     ACPI_TABLE_HEADER       *Table;
     ACPI_OWNER_ID           OwnerId;
     ACPI_EVALUATE_INFO      *Info = NULL;
     UINT32                  AmlLength;
     UINT8                   *AmlStart;
     ACPI_OPERAND_OBJECT     *MethodObj = NULL;


     ACPI_FUNCTION_TRACE (NsExecuteTable);


     Status = AcpiGetTableByIndex (TableIndex, &Table);
     if (ACPI_FAILURE (Status))
     {
         return_ACPI_STATUS (Status);
     }

     /* Table must consist of at least a complete header */

     if (Table->Length < sizeof (ACPI_TABLE_HEADER))
     {
         return_ACPI_STATUS (AE_BAD_HEADER);
     }

     AmlStart = (UINT8 *) Table + sizeof (ACPI_TABLE_HEADER);
     AmlLength = Table->Length - sizeof (ACPI_TABLE_HEADER);

     Status = AcpiTbGetOwnerId (TableIndex, &OwnerId);
     if (ACPI_FAILURE (Status))
     {
         return_ACPI_STATUS (Status);
     }

     /* Create, initialize, and link a new temporary method object */

     MethodObj = AcpiUtCreateInternalObject (ACPI_TYPE_METHOD);
     if (!MethodObj)
     {
         return_ACPI_STATUS (AE_NO_MEMORY);
     }

     /* Allocate the evaluation information block */

     Info = ACPI_ALLOCATE_ZEROED (sizeof (ACPI_EVALUATE_INFO));
     if (!Info)
     {
         Status = AE_NO_MEMORY;
         goto Cleanup;
     }

     ACPI_DEBUG_PRINT_RAW ((ACPI_DB_PARSE,
         "%s: Create table pseudo-method for [%4.4s] @%p, method %p\n",
         ACPI_GET_FUNCTION_NAME, Table->Signature, Table, MethodObj));

     MethodObj->Method.AmlStart = AmlStart;
     MethodObj->Method.AmlLength = AmlLength;
     MethodObj->Method.OwnerId = OwnerId;
     MethodObj->Method.InfoFlags |= ACPI_METHOD_MODULE_LEVEL;

     Info->PassNumber = ACPI_IMODE_EXECUTE;
     Info->Node = StartNode;
     Info->ObjDesc = MethodObj;
     Info->NodeFlags = Info->Node->Flags;
     Info->FullPathname = AcpiNsGetNormalizedPathname (Info->Node, TRUE);
     if (!Info->FullPathname)
     {
         Status = AE_NO_MEMORY;
         goto Cleanup;
     }

     /* Optional object evaluation log */

     ACPI_DEBUG_PRINT_RAW ((ACPI_DB_EVALUATION,
         "%-26s:  (Definition Block level)\n", "Module-level evaluation"));

     Status = AcpiPsExecuteTable (Info);

     /* Optional object evaluation log */

     ACPI_DEBUG_PRINT_RAW ((ACPI_DB_EVALUATION,
         "%-26s:  (Definition Block level)\n", "Module-level complete"));

 Cleanup:
     if (Info)
     {
         ACPI_FREE (Info->FullPathname);
         Info->FullPathname = NULL;
     }
     ACPI_FREE (Info);
     AcpiUtRemoveReference (MethodObj);
     return_ACPI_STATUS (Status);
 }


 /*******************************************************************************
  *
  * FUNCTION:    NsOneCompleteParse
  *
  * PARAMETERS:  PassNumber              - 1 or 2
  *              TableDesc               - The table to be parsed.
  *
  * RETURN:      Status
  *
  * DESCRIPTION: Perform one complete parse of an ACPI/AML table.
  *
  ******************************************************************************/

 ACPI_STATUS
 AcpiNsOneCompleteParse (
     UINT32                  PassNumber,
     UINT32                  TableIndex,
     ACPI_NAMESPACE_NODE     *StartNode)
 {
     ACPI_PARSE_OBJECT       *ParseRoot;
     ACPI_STATUS             Status;
     UINT32                  AmlLength;
     UINT8                   *AmlStart;
     ACPI_WALK_STATE         *WalkState;
     ACPI_TABLE_HEADER       *Table;
     ACPI_OWNER_ID           OwnerId;


     ACPI_FUNCTION_TRACE (NsOneCompleteParse);


     Status = AcpiGetTableByIndex (TableIndex, &Table);
     if (ACPI_FAILURE (Status))
     {
         return_ACPI_STATUS (Status);
     }

     /* Table must consist of at least a complete header */

     if (Table->Length < sizeof (ACPI_TABLE_HEADER))
     {
         return_ACPI_STATUS (AE_BAD_HEADER);
     }

     AmlStart = (UINT8 *) Table + sizeof (ACPI_TABLE_HEADER);
     AmlLength = Table->Length - sizeof (ACPI_TABLE_HEADER);

     Status = AcpiTbGetOwnerId (TableIndex, &OwnerId);
     if (ACPI_FAILURE (Status))
     {
         return_ACPI_STATUS (Status);
     }

     /* Create and init a Root Node */

     ParseRoot = AcpiPsCreateScopeOp (AmlStart);
     if (!ParseRoot)
     {
         return_ACPI_STATUS (AE_NO_MEMORY);
     }

     /* Create and initialize a new walk state */

     WalkState = AcpiDsCreateWalkState (OwnerId, NULL, NULL, NULL);
     if (!WalkState)
     {
         AcpiPsFreeOp (ParseRoot);
         return_ACPI_STATUS (AE_NO_MEMORY);
     }

     Status = AcpiDsInitAmlWalk (WalkState, ParseRoot, NULL,
         AmlStart, AmlLength, NULL, (UINT8) PassNumber);
     if (ACPI_FAILURE (Status))
     {
         AcpiDsDeleteWalkState (WalkState);
         goto Cleanup;
     }

     /* Found OSDT table, enable the namespace override feature */

     if (ACPI_COMPARE_NAMESEG (Table->Signature, ACPI_SIG_OSDT) &&
         PassNumber == ACPI_IMODE_LOAD_PASS1)
     {
         WalkState->NamespaceOverride = TRUE;
     }

     /* StartNode is the default location to load the table  */

     if (StartNode && StartNode != AcpiGbl_RootNode)
     {
         Status = AcpiDsScopeStackPush (
             StartNode, ACPI_TYPE_METHOD, WalkState);
         if (ACPI_FAILURE (Status))
         {
             AcpiDsDeleteWalkState (WalkState);
             goto Cleanup;
         }
     }

     /* Parse the AML */

     ACPI_DEBUG_PRINT ((ACPI_DB_PARSE,
         "*PARSE* pass %u parse\n", PassNumber));
     AcpiExEnterInterpreter ();
     Status = AcpiPsParseAml (WalkState);
     AcpiExExitInterpreter ();

 Cleanup:
     AcpiPsDeleteParseTree (ParseRoot);
     return_ACPI_STATUS (Status);
 }


 /*******************************************************************************
  *
  * FUNCTION:    AcpiNsParseTable
  *
  * PARAMETERS:  TableDesc       - An ACPI table descriptor for table to parse
  *              StartNode       - Where to enter the table into the namespace
  *
  * RETURN:      Status
  *
  * DESCRIPTION: Parse AML within an ACPI table and return a tree of ops
  *
  ******************************************************************************/

 ACPI_STATUS
 AcpiNsParseTable (
     UINT32                  TableIndex,
     ACPI_NAMESPACE_NODE     *StartNode)
 {
     ACPI_STATUS             Status;


     ACPI_FUNCTION_TRACE (NsParseTable);


     /*
      * Executes the AML table as one large control method.
      * The point of this is to execute any module-level code in-place
      * as the table is parsed. Some AML code depends on this behavior.
      *
      * Note: This causes the table to only have a single-pass parse.
      * However, this is compatible with other ACPI implementations.
      */
     ACPI_DEBUG_PRINT_RAW ((ACPI_DB_PARSE,
         "%s: **** Start table execution pass\n", ACPI_GET_FUNCTION_NAME));

     Status = AcpiNsExecuteTable (TableIndex, StartNode);

     return_ACPI_STATUS (Status);
 }
	/******************************************************************************
	*
	* Module Name: nsparse - namespace interface to AML parser
	*
	*****************************************************************************/

	/*
	* Copyright (C) 2000 - 2020, Intel Corp.
	* All rights reserved.
	*
	* Redistribution and use in source and binary forms, with or without
	* modification, are permitted provided that the following conditions
	* are met:
	* 1. Redistributions of source code must retain the above copyright
	* notice, this list of conditions, and the following disclaimer,
	* without modification.
	* 2. Redistributions in binary form must reproduce at minimum a disclaimer
	* substantially similar to the "NO WARRANTY" disclaimer below
	* ("Disclaimer") and any redistribution must be conditioned upon
	* including a substantially similar Disclaimer requirement for further
	* binary redistribution.
	* 3. Neither the names of the above-listed copyright holders nor the names
	* of any contributors may be used to endorse or promote products derived
	* from this software without specific prior written permission.
	*
	* NO WARRANTY
	* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
	* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
	* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
	* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
	* HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
	* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
	* IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
	* POSSIBILITY OF SUCH DAMAGES.
	*/

	#include "acpi.h"
	#include "accommon.h"
	#include "acnamesp.h"
	#include "acparser.h"
	#include "acdispat.h"
	#include "actables.h"
	#include "acinterp.h"


	#define _COMPONENT ACPI_NAMESPACE
	ACPI_MODULE_NAME ("nsparse")


	/*******************************************************************************
	*
	* FUNCTION: NsExecuteTable
	*
	* PARAMETERS: TableDesc - An ACPI table descriptor for table to parse
	* StartNode - Where to enter the table into the namespace
	*
	* RETURN: Status
	*
	* DESCRIPTION: Load ACPI/AML table by executing the entire table as a single
	* large control method.
	*
	* NOTE: The point of this is to execute any module-level code in-place
	* as the table is parsed. Some AML code depends on this behavior.
	*
	* It is a run-time option at this time, but will eventually become
	* the default.
	*
	* Note: This causes the table to only have a single-pass parse.
	* However, this is compatible with other ACPI implementations.
	*
	******************************************************************************/

	ACPI_STATUS
	AcpiNsExecuteTable (
	UINT32 TableIndex,
	ACPI_NAMESPACE_NODE *StartNode)
	{
	ACPI_STATUS Status;
	ACPI_TABLE_HEADER *Table;
	ACPI_OWNER_ID OwnerId;
	ACPI_EVALUATE_INFO *Info = NULL;
	UINT32 AmlLength;
	UINT8 *AmlStart;
	ACPI_OPERAND_OBJECT *MethodObj = NULL;


	ACPI_FUNCTION_TRACE (NsExecuteTable);


	Status = AcpiGetTableByIndex (TableIndex, &Table);
	if (ACPI_FAILURE (Status))
	{
	return_ACPI_STATUS (Status);
	}

	/* Table must consist of at least a complete header */

	if (Table->Length < sizeof (ACPI_TABLE_HEADER))
	{
	return_ACPI_STATUS (AE_BAD_HEADER);
	}

	AmlStart = (UINT8 *) Table + sizeof (ACPI_TABLE_HEADER);
	AmlLength = Table->Length - sizeof (ACPI_TABLE_HEADER);

	Status = AcpiTbGetOwnerId (TableIndex, &OwnerId);
	if (ACPI_FAILURE (Status))
	{
	return_ACPI_STATUS (Status);
	}

	/* Create, initialize, and link a new temporary method object */

	MethodObj = AcpiUtCreateInternalObject (ACPI_TYPE_METHOD);
	if (!MethodObj)
	{
	return_ACPI_STATUS (AE_NO_MEMORY);
	}

	/* Allocate the evaluation information block */

	Info = ACPI_ALLOCATE_ZEROED (sizeof (ACPI_EVALUATE_INFO));
	if (!Info)
	{
	Status = AE_NO_MEMORY;
	goto Cleanup;
	}

	ACPI_DEBUG_PRINT_RAW ((ACPI_DB_PARSE,
	"%s: Create table pseudo-method for [%4.4s] @%p, method %p\n",
	ACPI_GET_FUNCTION_NAME, Table->Signature, Table, MethodObj));

	MethodObj->Method.AmlStart = AmlStart;
	MethodObj->Method.AmlLength = AmlLength;
	MethodObj->Method.OwnerId = OwnerId;
	MethodObj->Method.InfoFlags \|= ACPI_METHOD_MODULE_LEVEL;

	Info->PassNumber = ACPI_IMODE_EXECUTE;
	Info->Node = StartNode;
	Info->ObjDesc = MethodObj;
	Info->NodeFlags = Info->Node->Flags;
	Info->FullPathname = AcpiNsGetNormalizedPathname (Info->Node, TRUE);
	if (!Info->FullPathname)
	{
	Status = AE_NO_MEMORY;
	goto Cleanup;
	}

	/* Optional object evaluation log */

	ACPI_DEBUG_PRINT_RAW ((ACPI_DB_EVALUATION,
	"%-26s: (Definition Block level)\n", "Module-level evaluation"));

	Status = AcpiPsExecuteTable (Info);

	/* Optional object evaluation log */

	ACPI_DEBUG_PRINT_RAW ((ACPI_DB_EVALUATION,
	"%-26s: (Definition Block level)\n", "Module-level complete"));

	Cleanup:
	if (Info)
	{
	ACPI_FREE (Info->FullPathname);
	Info->FullPathname = NULL;
	}
	ACPI_FREE (Info);
	AcpiUtRemoveReference (MethodObj);
	return_ACPI_STATUS (Status);
	}


	/*******************************************************************************
	*
	* FUNCTION: NsOneCompleteParse
	*
	* PARAMETERS: PassNumber - 1 or 2
	* TableDesc - The table to be parsed.
	*
	* RETURN: Status
	*
	* DESCRIPTION: Perform one complete parse of an ACPI/AML table.
	*
	******************************************************************************/

	ACPI_STATUS
	AcpiNsOneCompleteParse (
	UINT32 PassNumber,
	UINT32 TableIndex,
	ACPI_NAMESPACE_NODE *StartNode)
	{
	ACPI_PARSE_OBJECT *ParseRoot;
	ACPI_STATUS Status;
	UINT32 AmlLength;
	UINT8 *AmlStart;
	ACPI_WALK_STATE *WalkState;
	ACPI_TABLE_HEADER *Table;
	ACPI_OWNER_ID OwnerId;


	ACPI_FUNCTION_TRACE (NsOneCompleteParse);


	Status = AcpiGetTableByIndex (TableIndex, &Table);
	if (ACPI_FAILURE (Status))
	{
	return_ACPI_STATUS (Status);
	}

	/* Table must consist of at least a complete header */

	if (Table->Length < sizeof (ACPI_TABLE_HEADER))
	{
	return_ACPI_STATUS (AE_BAD_HEADER);
	}

	AmlStart = (UINT8 *) Table + sizeof (ACPI_TABLE_HEADER);
	AmlLength = Table->Length - sizeof (ACPI_TABLE_HEADER);

	Status = AcpiTbGetOwnerId (TableIndex, &OwnerId);
	if (ACPI_FAILURE (Status))
	{
	return_ACPI_STATUS (Status);
	}

	/* Create and init a Root Node */

	ParseRoot = AcpiPsCreateScopeOp (AmlStart);
	if (!ParseRoot)
	{
	return_ACPI_STATUS (AE_NO_MEMORY);
	}

	/* Create and initialize a new walk state */

	WalkState = AcpiDsCreateWalkState (OwnerId, NULL, NULL, NULL);
	if (!WalkState)
	{
	AcpiPsFreeOp (ParseRoot);
	return_ACPI_STATUS (AE_NO_MEMORY);
	}

	Status = AcpiDsInitAmlWalk (WalkState, ParseRoot, NULL,
	AmlStart, AmlLength, NULL, (UINT8) PassNumber);
	if (ACPI_FAILURE (Status))
	{
	AcpiDsDeleteWalkState (WalkState);
	goto Cleanup;
	}

	/* Found OSDT table, enable the namespace override feature */

	if (ACPI_COMPARE_NAMESEG (Table->Signature, ACPI_SIG_OSDT) &&
	PassNumber == ACPI_IMODE_LOAD_PASS1)
	{
	WalkState->NamespaceOverride = TRUE;
	}

	/* StartNode is the default location to load the table */

	if (StartNode && StartNode != AcpiGbl_RootNode)
	{
	Status = AcpiDsScopeStackPush (
	StartNode, ACPI_TYPE_METHOD, WalkState);
	if (ACPI_FAILURE (Status))
	{
	AcpiDsDeleteWalkState (WalkState);
	goto Cleanup;
	}
	}

	/* Parse the AML */

	ACPI_DEBUG_PRINT ((ACPI_DB_PARSE,
	"PARSE pass %u parse\n", PassNumber));
	AcpiExEnterInterpreter ();
	Status = AcpiPsParseAml (WalkState);
	AcpiExExitInterpreter ();

	Cleanup:
	AcpiPsDeleteParseTree (ParseRoot);
	return_ACPI_STATUS (Status);
	}


	/*******************************************************************************
	*
	* FUNCTION: AcpiNsParseTable
	*
	* PARAMETERS: TableDesc - An ACPI table descriptor for table to parse
	* StartNode - Where to enter the table into the namespace
	*
	* RETURN: Status
	*
	* DESCRIPTION: Parse AML within an ACPI table and return a tree of ops
	*
	******************************************************************************/

	ACPI_STATUS
	AcpiNsParseTable (
	UINT32 TableIndex,
	ACPI_NAMESPACE_NODE *StartNode)
	{
	ACPI_STATUS Status;


	ACPI_FUNCTION_TRACE (NsParseTable);


	/*
	* Executes the AML table as one large control method.
	* The point of this is to execute any module-level code in-place
	* as the table is parsed. Some AML code depends on this behavior.
	*
	* Note: This causes the table to only have a single-pass parse.
	* However, this is compatible with other ACPI implementations.
	*/
	ACPI_DEBUG_PRINT_RAW ((ACPI_DB_PARSE,
	"%s: **** Start table execution pass\n", ACPI_GET_FUNCTION_NAME));

	Status = AcpiNsExecuteTable (TableIndex, StartNode);

	return_ACPI_STATUS (Status);
	}