sys/contrib/dev/acpica/components/namespace/nsparse.c

   1 /******************************************************************************
   2  *
   3  * Module Name: nsparse - namespace interface to AML parser
   4  *
   5  *****************************************************************************/
   6
   7 /******************************************************************************
   8  *
   9  * 1. Copyright Notice
  10  *
  11  * Some or all of this work - Copyright (c) 1999 - 2018, Intel Corp.
  12  * All rights reserved.
  13  *
  14  * 2. License
  15  *
  16  * 2.1. This is your license from Intel Corp. under its intellectual property
  17  * rights. You may have additional license terms from the party that provided
  18  * you this software, covering your right to use that party's intellectual
  19  * property rights.
  20  *
  21  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  22  * copy of the source code appearing in this file ("Covered Code") an
  23  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  24  * base code distributed originally by Intel ("Original Intel Code") to copy,
  25  * make derivatives, distribute, use and display any portion of the Covered
  26  * Code in any form, with the right to sublicense such rights; and
  27  *
  28  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  29  * license (with the right to sublicense), under only those claims of Intel
  30  * patents that are infringed by the Original Intel Code, to make, use, sell,
  31  * offer to sell, and import the Covered Code and derivative works thereof
  32  * solely to the minimum extent necessary to exercise the above copyright
  33  * license, and in no event shall the patent license extend to any additions
  34  * to or modifications of the Original Intel Code. No other license or right
  35  * is granted directly or by implication, estoppel or otherwise;
  36  *
  37  * The above copyright and patent license is granted only if the following
  38  * conditions are met:
  39  *
  40  * 3. Conditions
  41  *
  42  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  43  * Redistribution of source code of any substantial portion of the Covered
  44  * Code or modification with rights to further distribute source must include
  45  * the above Copyright Notice, the above License, this list of Conditions,
  46  * and the following Disclaimer and Export Compliance provision. In addition,
  47  * Licensee must cause all Covered Code to which Licensee contributes to
  48  * contain a file documenting the changes Licensee made to create that Covered
  49  * Code and the date of any change. Licensee must include in that file the
  50  * documentation of any changes made by any predecessor Licensee. Licensee
  51  * must include a prominent statement that the modification is derived,
  52  * directly or indirectly, from Original Intel Code.
  53  *
  54  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  55  * Redistribution of source code of any substantial portion of the Covered
  56  * Code or modification without rights to further distribute source must
  57  * include the following Disclaimer and Export Compliance provision in the
  58  * documentation and/or other materials provided with distribution. In
  59  * addition, Licensee may not authorize further sublicense of source of any
  60  * portion of the Covered Code, and must include terms to the effect that the
  61  * license from Licensee to its licensee is limited to the intellectual
  62  * property embodied in the software Licensee provides to its licensee, and
  63  * not to intellectual property embodied in modifications its licensee may
  64  * make.
  65  *
  66  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  67  * substantial portion of the Covered Code or modification must reproduce the
  68  * above Copyright Notice, and the following Disclaimer and Export Compliance
  69  * provision in the documentation and/or other materials provided with the
  70  * distribution.
  71  *
  72  * 3.4. Intel retains all right, title, and interest in and to the Original
  73  * Intel Code.
  74  *
  75  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  76  * Intel shall be used in advertising or otherwise to promote the sale, use or
  77  * other dealings in products derived from or relating to the Covered Code
  78  * without prior written authorization from Intel.
  79  *
  80  * 4. Disclaimer and Export Compliance
  81  *
  82  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  83  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  84  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
  85  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
  86  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
  87  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  88  * PARTICULAR PURPOSE.
  89  *
  90  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  91  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  92  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  93  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  94  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  95  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
  96  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  97  * LIMITED REMEDY.
  98  *
  99  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 100  * software or system incorporating such software without first obtaining any
 101  * required license or other approval from the U. S. Department of Commerce or
 102  * any other agency or department of the United States Government. In the
 103  * event Licensee exports any such software from the United States or
 104  * re-exports any such software from a foreign destination, Licensee shall
 105  * ensure that the distribution and export/re-export of the software is in
 106  * compliance with all laws, regulations, orders, or other restrictions of the
 107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 108  * any of its subsidiaries will export/re-export any technical data, process,
 109  * software, or service, directly or indirectly, to any country for which the
 110  * United States government or any agency thereof requires an export license,
 111  * other governmental approval, or letter of assurance, without first obtaining
 112  * such license, approval or letter.
 113  *
 114  *****************************************************************************
 115  *
 116  * Alternatively, you may choose to be licensed under the terms of the
 117  * following license:
 118  *
 119  * Redistribution and use in source and binary forms, with or without
 120  * modification, are permitted provided that the following conditions
 121  * are met:
 122  * 1. Redistributions of source code must retain the above copyright
 123  *    notice, this list of conditions, and the following disclaimer,
 124  *    without modification.
 125  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
 126  *    substantially similar to the "NO WARRANTY" disclaimer below
 127  *    ("Disclaimer") and any redistribution must be conditioned upon
 128  *    including a substantially similar Disclaimer requirement for further
 129  *    binary redistribution.
 130  * 3. Neither the names of the above-listed copyright holders nor the names
 131  *    of any contributors may be used to endorse or promote products derived
 132  *    from this software without specific prior written permission.
 133  *
 134  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 135  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 136  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 137  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 138  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 139  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 140  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 141  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 142  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 143  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 144  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 145  *
 146  * Alternatively, you may choose to be licensed under the terms of the
 147  * GNU General Public License ("GPL") version 2 as published by the Free
 148  * Software Foundation.
 149  *
 150  *****************************************************************************/
 151
 152 #include <contrib/dev/acpica/include/acpi.h>
 153 #include <contrib/dev/acpica/include/accommon.h>
 154 #include <contrib/dev/acpica/include/acnamesp.h>
 155 #include <contrib/dev/acpica/include/acparser.h>
 156 #include <contrib/dev/acpica/include/acdispat.h>
 157 #include <contrib/dev/acpica/include/actables.h>
 158 #include <contrib/dev/acpica/include/acinterp.h>
 159
 160
 161 #define _COMPONENT          ACPI_NAMESPACE
 162         ACPI_MODULE_NAME    ("nsparse")
 163
 164
 165 /*******************************************************************************
 166  *
 167  * FUNCTION:    NsExecuteTable
 168  *
 169  * PARAMETERS:  TableDesc       - An ACPI table descriptor for table to parse
 170  *              StartNode       - Where to enter the table into the namespace
 171  *
 172  * RETURN:      Status
 173  *
 174  * DESCRIPTION: Load ACPI/AML table by executing the entire table as a
 175  *              TermList.
 176  *
 177  ******************************************************************************/
 178
 179 ACPI_STATUS
 180 AcpiNsExecuteTable (
 181     UINT32                  TableIndex,
 182     ACPI_NAMESPACE_NODE     *StartNode)
 183 {
 184     ACPI_STATUS             Status;
 185     ACPI_TABLE_HEADER       *Table;
 186     ACPI_OWNER_ID           OwnerId;
 187     ACPI_EVALUATE_INFO      *Info = NULL;
 188     UINT32                  AmlLength;
 189     UINT8                   *AmlStart;
 190     ACPI_OPERAND_OBJECT     *MethodObj = NULL;
 191
 192
 193     ACPI_FUNCTION_TRACE (NsExecuteTable);
 194
 195
 196     Status = AcpiGetTableByIndex (TableIndex, &Table);
 197     if (ACPI_FAILURE (Status))
 198     {
 199         return_ACPI_STATUS (Status);
 200     }
 201
 202     /* Table must consist of at least a complete header */
 203
 204     if (Table->Length < sizeof (ACPI_TABLE_HEADER))
 205     {
 206         return_ACPI_STATUS (AE_BAD_HEADER);
 207     }
 208
 209     AmlStart = (UINT8 *) Table + sizeof (ACPI_TABLE_HEADER);
 210     AmlLength = Table->Length - sizeof (ACPI_TABLE_HEADER);
 211
 212     Status = AcpiTbGetOwnerId (TableIndex, &OwnerId);
 213     if (ACPI_FAILURE (Status))
 214     {
 215         return_ACPI_STATUS (Status);
 216     }
 217
 218     /* Create, initialize, and link a new temporary method object */
 219
 220     MethodObj = AcpiUtCreateInternalObject (ACPI_TYPE_METHOD);
 221     if (!MethodObj)
 222     {
 223         return_ACPI_STATUS (AE_NO_MEMORY);
 224     }
 225
 226     /* Allocate the evaluation information block */
 227
 228     Info = ACPI_ALLOCATE_ZEROED (sizeof (ACPI_EVALUATE_INFO));
 229     if (!Info)
 230     {
 231         Status = AE_NO_MEMORY;
 232         goto Cleanup;
 233     }
 234
 235     ACPI_DEBUG_PRINT ((ACPI_DB_PARSE,
 236         "Create table code block: %p\n", MethodObj));
 237
 238     MethodObj->Method.AmlStart = AmlStart;
 239     MethodObj->Method.AmlLength = AmlLength;
 240     MethodObj->Method.OwnerId = OwnerId;
 241     MethodObj->Method.InfoFlags |= ACPI_METHOD_MODULE_LEVEL;
 242
 243     Info->PassNumber = ACPI_IMODE_EXECUTE;
 244     Info->Node = StartNode;
 245     Info->ObjDesc = MethodObj;
 246     Info->NodeFlags = Info->Node->Flags;
 247     Info->FullPathname = AcpiNsGetNormalizedPathname (Info->Node, TRUE);
 248     if (!Info->FullPathname)
 249     {
 250         Status = AE_NO_MEMORY;
 251         goto Cleanup;
 252     }
 253
 254     Status = AcpiPsExecuteTable (Info);
 255
 256 Cleanup:
 257     if (Info)
 258     {
 259         ACPI_FREE (Info->FullPathname);
 260         Info->FullPathname = NULL;
 261     }
 262     ACPI_FREE (Info);
 263     AcpiUtRemoveReference (MethodObj);
 264     return_ACPI_STATUS (Status);
 265 }
 266
 267
 268 /*******************************************************************************
 269  *
 270  * FUNCTION:    NsOneCompleteParse
 271  *
 272  * PARAMETERS:  PassNumber              - 1 or 2
 273  *              TableDesc               - The table to be parsed.
 274  *
 275  * RETURN:      Status
 276  *
 277  * DESCRIPTION: Perform one complete parse of an ACPI/AML table.
 278  *
 279  ******************************************************************************/
 280
 281 ACPI_STATUS
 282 AcpiNsOneCompleteParse (
 283     UINT32                  PassNumber,
 284     UINT32                  TableIndex,
 285     ACPI_NAMESPACE_NODE     *StartNode)
 286 {
 287     ACPI_PARSE_OBJECT       *ParseRoot;
 288     ACPI_STATUS             Status;
 289     UINT32                  AmlLength;
 290     UINT8                   *AmlStart;
 291     ACPI_WALK_STATE         *WalkState;
 292     ACPI_TABLE_HEADER       *Table;
 293     ACPI_OWNER_ID           OwnerId;
 294
 295
 296     ACPI_FUNCTION_TRACE (NsOneCompleteParse);
 297
 298
 299     Status = AcpiGetTableByIndex (TableIndex, &Table);
 300     if (ACPI_FAILURE (Status))
 301     {
 302         return_ACPI_STATUS (Status);
 303     }
 304
 305     /* Table must consist of at least a complete header */
 306
 307     if (Table->Length < sizeof (ACPI_TABLE_HEADER))
 308     {
 309         return_ACPI_STATUS (AE_BAD_HEADER);
 310     }
 311
 312     AmlStart = (UINT8 *) Table + sizeof (ACPI_TABLE_HEADER);
 313     AmlLength = Table->Length - sizeof (ACPI_TABLE_HEADER);
 314
 315     Status = AcpiTbGetOwnerId (TableIndex, &OwnerId);
 316     if (ACPI_FAILURE (Status))
 317     {
 318         return_ACPI_STATUS (Status);
 319     }
 320
 321     /* Create and init a Root Node */
 322
 323     ParseRoot = AcpiPsCreateScopeOp (AmlStart);
 324     if (!ParseRoot)
 325     {
 326         return_ACPI_STATUS (AE_NO_MEMORY);
 327     }
 328
 329     /* Create and initialize a new walk state */
 330
 331     WalkState = AcpiDsCreateWalkState (OwnerId, NULL, NULL, NULL);
 332     if (!WalkState)
 333     {
 334         AcpiPsFreeOp (ParseRoot);
 335         return_ACPI_STATUS (AE_NO_MEMORY);
 336     }
 337
 338     Status = AcpiDsInitAmlWalk (WalkState, ParseRoot, NULL,
 339         AmlStart, AmlLength, NULL, (UINT8) PassNumber);
 340     if (ACPI_FAILURE (Status))
 341     {
 342         AcpiDsDeleteWalkState (WalkState);
 343         goto Cleanup;
 344     }
 345
 346     /* Found OSDT table, enable the namespace override feature */
 347
 348     if (ACPI_COMPARE_NAME(Table->Signature, ACPI_SIG_OSDT) &&
 349         PassNumber == ACPI_IMODE_LOAD_PASS1)
 350     {
 351         WalkState->NamespaceOverride = TRUE;
 352     }
 353
 354     /* StartNode is the default location to load the table  */
 355
 356     if (StartNode && StartNode != AcpiGbl_RootNode)
 357     {
 358         Status = AcpiDsScopeStackPush (
 359             StartNode, ACPI_TYPE_METHOD, WalkState);
 360         if (ACPI_FAILURE (Status))
 361         {
 362             AcpiDsDeleteWalkState (WalkState);
 363             goto Cleanup;
 364         }
 365     }
 366
 367     /* Parse the AML */
 368
 369     ACPI_DEBUG_PRINT ((ACPI_DB_PARSE,
 370         "*PARSE* pass %u parse\n", PassNumber));
 371     AcpiExEnterInterpreter ();
 372     Status = AcpiPsParseAml (WalkState);
 373     AcpiExExitInterpreter ();
 374
 375 Cleanup:
 376     AcpiPsDeleteParseTree (ParseRoot);
 377     return_ACPI_STATUS (Status);
 378 }
 379
 380
 381 /*******************************************************************************
 382  *
 383  * FUNCTION:    AcpiNsParseTable
 384  *
 385  * PARAMETERS:  TableDesc       - An ACPI table descriptor for table to parse
 386  *              StartNode       - Where to enter the table into the namespace
 387  *
 388  * RETURN:      Status
 389  *
 390  * DESCRIPTION: Parse AML within an ACPI table and return a tree of ops
 391  *
 392  ******************************************************************************/
 393
 394 ACPI_STATUS
 395 AcpiNsParseTable (
 396     UINT32                  TableIndex,
 397     ACPI_NAMESPACE_NODE     *StartNode)
 398 {
 399     ACPI_STATUS             Status;
 400
 401
 402     ACPI_FUNCTION_TRACE (NsParseTable);
 403
 404
 405     if (AcpiGbl_ParseTableAsTermList)
 406     {
 407         ACPI_DEBUG_PRINT ((ACPI_DB_PARSE, "**** Start load pass\n"));
 408
 409         Status = AcpiNsExecuteTable (TableIndex, StartNode);
 410         if (ACPI_FAILURE (Status))
 411         {
 412             return_ACPI_STATUS (Status);
 413         }
 414     }
 415     else
 416     {
 417         /*
 418          * AML Parse, pass 1
 419          *
 420          * In this pass, we load most of the namespace. Control methods
 421          * are not parsed until later. A parse tree is not created.
 422          * Instead, each Parser Op subtree is deleted when it is finished.
 423          * This saves a great deal of memory, and allows a small cache of
 424          * parse objects to service the entire parse. The second pass of
 425          * the parse then performs another complete parse of the AML.
 426          */
 427         ACPI_DEBUG_PRINT ((ACPI_DB_PARSE, "**** Start pass 1\n"));
 428
 429         Status = AcpiNsOneCompleteParse (ACPI_IMODE_LOAD_PASS1,
 430             TableIndex, StartNode);
 431         if (ACPI_FAILURE (Status))
 432         {
 433             return_ACPI_STATUS (Status);
 434         }
 435
 436         /*
 437          * AML Parse, pass 2
 438          *
 439          * In this pass, we resolve forward references and other things
 440          * that could not be completed during the first pass.
 441          * Another complete parse of the AML is performed, but the
 442          * overhead of this is compensated for by the fact that the
 443          * parse objects are all cached.
 444          */
 445         ACPI_DEBUG_PRINT ((ACPI_DB_PARSE, "**** Start pass 2\n"));
 446         Status = AcpiNsOneCompleteParse (ACPI_IMODE_LOAD_PASS2,
 447             TableIndex, StartNode);
 448         if (ACPI_FAILURE (Status))
 449         {
 450             return_ACPI_STATUS (Status);
 451         }
 452     }
 453
 454     return_ACPI_STATUS (Status);
 455 }