sys/contrib/dev/acpica/source/components/namespace/nsload.c

   1 /******************************************************************************
   2  *
   3  * Module Name: nsload - namespace loading/expanding/contracting procedures
   4  *
   5  *****************************************************************************/
   6
   7 /******************************************************************************
   8  *
   9  * 1. Copyright Notice
  10  *
  11  * Some or all of this work - Copyright (c) 1999 - 2021, 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 "acpi.h"
 153 #include "accommon.h"
 154 #include "acnamesp.h"
 155 #include "acdispat.h"
 156 #include "actables.h"
 157 #include "acinterp.h"
 158
 159
 160 #define _COMPONENT          ACPI_NAMESPACE
 161         ACPI_MODULE_NAME    ("nsload")
 162
 163 /* Local prototypes */
 164
 165 #ifdef ACPI_FUTURE_IMPLEMENTATION
 166 ACPI_STATUS
 167 AcpiNsUnloadNamespace (
 168     ACPI_HANDLE             Handle);
 169
 170 static ACPI_STATUS
 171 AcpiNsDeleteSubtree (
 172     ACPI_HANDLE             StartHandle);
 173 #endif
 174
 175
 176 /*******************************************************************************
 177  *
 178  * FUNCTION:    AcpiNsLoadTable
 179  *
 180  * PARAMETERS:  TableIndex      - Index for table to be loaded
 181  *              Node            - Owning NS node
 182  *
 183  * RETURN:      Status
 184  *
 185  * DESCRIPTION: Load one ACPI table into the namespace
 186  *
 187  ******************************************************************************/
 188
 189 ACPI_STATUS
 190 AcpiNsLoadTable (
 191     UINT32                  TableIndex,
 192     ACPI_NAMESPACE_NODE     *Node)
 193 {
 194     ACPI_STATUS             Status;
 195
 196
 197     ACPI_FUNCTION_TRACE (NsLoadTable);
 198
 199
 200     /* If table already loaded into namespace, just return */
 201
 202     if (AcpiTbIsTableLoaded (TableIndex))
 203     {
 204         Status = AE_ALREADY_EXISTS;
 205         goto Unlock;
 206     }
 207
 208     ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
 209         "**** Loading table into namespace ****\n"));
 210
 211     Status = AcpiTbAllocateOwnerId (TableIndex);
 212     if (ACPI_FAILURE (Status))
 213     {
 214         goto Unlock;
 215     }
 216
 217     /*
 218      * Parse the table and load the namespace with all named
 219      * objects found within. Control methods are NOT parsed
 220      * at this time. In fact, the control methods cannot be
 221      * parsed until the entire namespace is loaded, because
 222      * if a control method makes a forward reference (call)
 223      * to another control method, we can't continue parsing
 224      * because we don't know how many arguments to parse next!
 225      */
 226     Status = AcpiNsParseTable (TableIndex, Node);
 227     if (ACPI_SUCCESS (Status))
 228     {
 229         AcpiTbSetTableLoadedFlag (TableIndex, TRUE);
 230     }
 231     else
 232     {
 233         /*
 234          * On error, delete any namespace objects created by this table.
 235          * We cannot initialize these objects, so delete them. There are
 236          * a couple of especially bad cases:
 237          * AE_ALREADY_EXISTS - namespace collision.
 238          * AE_NOT_FOUND - the target of a Scope operator does not
 239          * exist. This target of Scope must already exist in the
 240          * namespace, as per the ACPI specification.
 241          */
 242         AcpiNsDeleteNamespaceByOwner (
 243             AcpiGbl_RootTableList.Tables[TableIndex].OwnerId);
 244
 245         AcpiTbReleaseOwnerId (TableIndex);
 246         return_ACPI_STATUS (Status);
 247     }
 248
 249 Unlock:
 250     if (ACPI_FAILURE (Status))
 251     {
 252         return_ACPI_STATUS (Status);
 253     }
 254
 255     /*
 256      * Now we can parse the control methods. We always parse
 257      * them here for a sanity check, and if configured for
 258      * just-in-time parsing, we delete the control method
 259      * parse trees.
 260      */
 261     ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
 262         "**** Begin Table Object Initialization\n"));
 263
 264     AcpiExEnterInterpreter ();
 265     Status = AcpiDsInitializeObjects (TableIndex, Node);
 266     AcpiExExitInterpreter ();
 267
 268     ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
 269         "**** Completed Table Object Initialization\n"));
 270
 271     return_ACPI_STATUS (Status);
 272 }
 273
 274
 275 #ifdef ACPI_OBSOLETE_FUNCTIONS
 276 /*******************************************************************************
 277  *
 278  * FUNCTION:    AcpiLoadNamespace
 279  *
 280  * PARAMETERS:  None
 281  *
 282  * RETURN:      Status
 283  *
 284  * DESCRIPTION: Load the name space from what ever is pointed to by DSDT.
 285  *              (DSDT points to either the BIOS or a buffer.)
 286  *
 287  ******************************************************************************/
 288
 289 ACPI_STATUS
 290 AcpiNsLoadNamespace (
 291     void)
 292 {
 293     ACPI_STATUS             Status;
 294
 295
 296     ACPI_FUNCTION_TRACE (AcpiLoadNameSpace);
 297
 298
 299     /* There must be at least a DSDT installed */
 300
 301     if (AcpiGbl_DSDT == NULL)
 302     {
 303         ACPI_ERROR ((AE_INFO, "DSDT is not in memory"));
 304         return_ACPI_STATUS (AE_NO_ACPI_TABLES);
 305     }
 306
 307     /*
 308      * Load the namespace. The DSDT is required,
 309      * but the SSDT and PSDT tables are optional.
 310      */
 311     Status = AcpiNsLoadTableByType (ACPI_TABLE_ID_DSDT);
 312     if (ACPI_FAILURE (Status))
 313     {
 314         return_ACPI_STATUS (Status);
 315     }
 316
 317     /* Ignore exceptions from these */
 318
 319     (void) AcpiNsLoadTableByType (ACPI_TABLE_ID_SSDT);
 320     (void) AcpiNsLoadTableByType (ACPI_TABLE_ID_PSDT);
 321
 322     ACPI_DEBUG_PRINT_RAW ((ACPI_DB_INIT,
 323         "ACPI Namespace successfully loaded at root %p\n",
 324         AcpiGbl_RootNode));
 325
 326     return_ACPI_STATUS (Status);
 327 }
 328 #endif
 329
 330 #ifdef ACPI_FUTURE_IMPLEMENTATION
 331 /*******************************************************************************
 332  *
 333  * FUNCTION:    AcpiNsDeleteSubtree
 334  *
 335  * PARAMETERS:  StartHandle         - Handle in namespace where search begins
 336  *
 337  * RETURNS      Status
 338  *
 339  * DESCRIPTION: Walks the namespace starting at the given handle and deletes
 340  *              all objects, entries, and scopes in the entire subtree.
 341  *
 342  *              Namespace/Interpreter should be locked or the subsystem should
 343  *              be in shutdown before this routine is called.
 344  *
 345  ******************************************************************************/
 346
 347 static ACPI_STATUS
 348 AcpiNsDeleteSubtree (
 349     ACPI_HANDLE             StartHandle)
 350 {
 351     ACPI_STATUS             Status;
 352     ACPI_HANDLE             ChildHandle;
 353     ACPI_HANDLE             ParentHandle;
 354     ACPI_HANDLE             NextChildHandle;
 355     ACPI_HANDLE             Dummy;
 356     UINT32                  Level;
 357
 358
 359     ACPI_FUNCTION_TRACE (NsDeleteSubtree);
 360
 361
 362     ParentHandle = StartHandle;
 363     ChildHandle = NULL;
 364     Level = 1;
 365
 366     /*
 367      * Traverse the tree of objects until we bubble back up
 368      * to where we started.
 369      */
 370     while (Level > 0)
 371     {
 372         /* Attempt to get the next object in this scope */
 373
 374         Status = AcpiGetNextObject (ACPI_TYPE_ANY, ParentHandle,
 375             ChildHandle, &NextChildHandle);
 376
 377         ChildHandle = NextChildHandle;
 378
 379         /* Did we get a new object? */
 380
 381         if (ACPI_SUCCESS (Status))
 382         {
 383             /* Check if this object has any children */
 384
 385             if (ACPI_SUCCESS (AcpiGetNextObject (ACPI_TYPE_ANY, ChildHandle,
 386                 NULL, &Dummy)))
 387             {
 388                 /*
 389                  * There is at least one child of this object,
 390                  * visit the object
 391                  */
 392                 Level++;
 393                 ParentHandle = ChildHandle;
 394                 ChildHandle  = NULL;
 395             }
 396         }
 397         else
 398         {
 399             /*
 400              * No more children in this object, go back up to
 401              * the object's parent
 402              */
 403             Level--;
 404
 405             /* Delete all children now */
 406
 407             AcpiNsDeleteChildren (ChildHandle);
 408
 409             ChildHandle = ParentHandle;
 410             Status = AcpiGetParent (ParentHandle, &ParentHandle);
 411             if (ACPI_FAILURE (Status))
 412             {
 413                 return_ACPI_STATUS (Status);
 414             }
 415         }
 416     }
 417
 418     /* Now delete the starting object, and we are done */
 419
 420     AcpiNsRemoveNode (ChildHandle);
 421     return_ACPI_STATUS (AE_OK);
 422 }
 423
 424
 425 /*******************************************************************************
 426  *
 427  *  FUNCTION:       AcpiNsUnloadNameSpace
 428  *
 429  *  PARAMETERS:     Handle          - Root of namespace subtree to be deleted
 430  *
 431  *  RETURN:         Status
 432  *
 433  *  DESCRIPTION:    Shrinks the namespace, typically in response to an undocking
 434  *                  event. Deletes an entire subtree starting from (and
 435  *                  including) the given handle.
 436  *
 437  ******************************************************************************/
 438
 439 ACPI_STATUS
 440 AcpiNsUnloadNamespace (
 441     ACPI_HANDLE             Handle)
 442 {
 443     ACPI_STATUS             Status;
 444
 445
 446     ACPI_FUNCTION_TRACE (NsUnloadNameSpace);
 447
 448
 449     /* Parameter validation */
 450
 451     if (!AcpiGbl_RootNode)
 452     {
 453         return_ACPI_STATUS (AE_NO_NAMESPACE);
 454     }
 455
 456     if (!Handle)
 457     {
 458         return_ACPI_STATUS (AE_BAD_PARAMETER);
 459     }
 460
 461     /* This function does the real work */
 462
 463     Status = AcpiNsDeleteSubtree (Handle);
 464     return_ACPI_STATUS (Status);
 465 }
 466 #endif