acpica/namespace/nswalk.c

0001 /******************************************************************************
0002  *
0003  * Module Name: nswalk - Functions for walking the ACPI namespace
0004  *
0005  *****************************************************************************/
0006
0007 /******************************************************************************
0008  *
0009  * 1. Copyright Notice
0010  *
0011  * Some or all of this work - Copyright (c) 1999 - 2024, Intel Corp.
0012  * All rights reserved.
0013  *
0014  * 2. License
0015  *
0016  * 2.1. This is your license from Intel Corp. under its intellectual property
0017  * rights. You may have additional license terms from the party that provided
0018  * you this software, covering your right to use that party's intellectual
0019  * property rights.
0020  *
0021  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
0022  * copy of the source code appearing in this file ("Covered Code") an
0023  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
0024  * base code distributed originally by Intel ("Original Intel Code") to copy,
0025  * make derivatives, distribute, use and display any portion of the Covered
0026  * Code in any form, with the right to sublicense such rights; and
0027  *
0028  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
0029  * license (with the right to sublicense), under only those claims of Intel
0030  * patents that are infringed by the Original Intel Code, to make, use, sell,
0031  * offer to sell, and import the Covered Code and derivative works thereof
0032  * solely to the minimum extent necessary to exercise the above copyright
0033  * license, and in no event shall the patent license extend to any additions
0034  * to or modifications of the Original Intel Code. No other license or right
0035  * is granted directly or by implication, estoppel or otherwise;
0036  *
0037  * The above copyright and patent license is granted only if the following
0038  * conditions are met:
0039  *
0040  * 3. Conditions
0041  *
0042  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
0043  * Redistribution of source code of any substantial portion of the Covered
0044  * Code or modification with rights to further distribute source must include
0045  * the above Copyright Notice, the above License, this list of Conditions,
0046  * and the following Disclaimer and Export Compliance provision. In addition,
0047  * Licensee must cause all Covered Code to which Licensee contributes to
0048  * contain a file documenting the changes Licensee made to create that Covered
0049  * Code and the date of any change. Licensee must include in that file the
0050  * documentation of any changes made by any predecessor Licensee. Licensee
0051  * must include a prominent statement that the modification is derived,
0052  * directly or indirectly, from Original Intel Code.
0053  *
0054  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
0055  * Redistribution of source code of any substantial portion of the Covered
0056  * Code or modification without rights to further distribute source must
0057  * include the following Disclaimer and Export Compliance provision in the
0058  * documentation and/or other materials provided with distribution. In
0059  * addition, Licensee may not authorize further sublicense of source of any
0060  * portion of the Covered Code, and must include terms to the effect that the
0061  * license from Licensee to its licensee is limited to the intellectual
0062  * property embodied in the software Licensee provides to its licensee, and
0063  * not to intellectual property embodied in modifications its licensee may
0064  * make.
0065  *
0066  * 3.3. Redistribution of Executable. Redistribution in executable form of any
0067  * substantial portion of the Covered Code or modification must reproduce the
0068  * above Copyright Notice, and the following Disclaimer and Export Compliance
0069  * provision in the documentation and/or other materials provided with the
0070  * distribution.
0071  *
0072  * 3.4. Intel retains all right, title, and interest in and to the Original
0073  * Intel Code.
0074  *
0075  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
0076  * Intel shall be used in advertising or otherwise to promote the sale, use or
0077  * other dealings in products derived from or relating to the Covered Code
0078  * without prior written authorization from Intel.
0079  *
0080  * 4. Disclaimer and Export Compliance
0081  *
0082  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
0083  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
0084  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
0085  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
0086  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
0087  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
0088  * PARTICULAR PURPOSE.
0089  *
0090  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
0091  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
0092  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
0093  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
0094  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
0095  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
0096  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
0097  * LIMITED REMEDY.
0098  *
0099  * 4.3. Licensee shall not export, either directly or indirectly, any of this
0100  * software or system incorporating such software without first obtaining any
0101  * required license or other approval from the U. S. Department of Commerce or
0102  * any other agency or department of the United States Government. In the
0103  * event Licensee exports any such software from the United States or
0104  * re-exports any such software from a foreign destination, Licensee shall
0105  * ensure that the distribution and export/re-export of the software is in
0106  * compliance with all laws, regulations, orders, or other restrictions of the
0107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
0108  * any of its subsidiaries will export/re-export any technical data, process,
0109  * software, or service, directly or indirectly, to any country for which the
0110  * United States government or any agency thereof requires an export license,
0111  * other governmental approval, or letter of assurance, without first obtaining
0112  * such license, approval or letter.
0113  *
0114  *****************************************************************************
0115  *
0116  * Alternatively, you may choose to be licensed under the terms of the
0117  * following license:
0118  *
0119  * Redistribution and use in source and binary forms, with or without
0120  * modification, are permitted provided that the following conditions
0121  * are met:
0122  * 1. Redistributions of source code must retain the above copyright
0123  *    notice, this list of conditions, and the following disclaimer,
0124  *    without modification.
0125  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
0126  *    substantially similar to the "NO WARRANTY" disclaimer below
0127  *    ("Disclaimer") and any redistribution must be conditioned upon
0128  *    including a substantially similar Disclaimer requirement for further
0129  *    binary redistribution.
0130  * 3. Neither the names of the above-listed copyright holders nor the names
0131  *    of any contributors may be used to endorse or promote products derived
0132  *    from this software without specific prior written permission.
0133  *
0134  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
0135  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
0136  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
0137  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
0138  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
0139  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
0140  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
0141  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
0142  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
0143  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
0144  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
0145  *
0146  * Alternatively, you may choose to be licensed under the terms of the
0147  * GNU General Public License ("GPL") version 2 as published by the Free
0148  * Software Foundation.
0149  *
0150  *****************************************************************************/
0151
0152 #include "acpi.h"
0153 #include "accommon.h"
0154 #include "acnamesp.h"
0155
0156
0157 #define _COMPONENT          ACPI_NAMESPACE
0158         ACPI_MODULE_NAME    ("nswalk")
0159
0160
0161 /*******************************************************************************
0162  *
0163  * FUNCTION:    AcpiNsGetNextNode
0164  *
0165  * PARAMETERS:  ParentNode          - Parent node whose children we are
0166  *                                    getting
0167  *              ChildNode           - Previous child that was found.
0168  *                                    The NEXT child will be returned
0169  *
0170  * RETURN:      ACPI_NAMESPACE_NODE - Pointer to the NEXT child or NULL if
0171  *                                    none is found.
0172  *
0173  * DESCRIPTION: Return the next peer node within the namespace. If Handle
0174  *              is valid, Scope is ignored. Otherwise, the first node
0175  *              within Scope is returned.
0176  *
0177  ******************************************************************************/
0178
0179 ACPI_NAMESPACE_NODE *
0180 AcpiNsGetNextNode (
0181     ACPI_NAMESPACE_NODE     *ParentNode,
0182     ACPI_NAMESPACE_NODE     *ChildNode)
0183 {
0184     ACPI_FUNCTION_ENTRY ();
0185
0186
0187     if (!ChildNode)
0188     {
0189         /* It's really the parent's _scope_ that we want */
0190
0191         return (ParentNode->Child);
0192     }
0193
0194     /* Otherwise just return the next peer */
0195
0196     return (ChildNode->Peer);
0197 }
0198
0199
0200 /*******************************************************************************
0201  *
0202  * FUNCTION:    AcpiNsGetNextNodeTyped
0203  *
0204  * PARAMETERS:  Type                - Type of node to be searched for
0205  *              ParentNode          - Parent node whose children we are
0206  *                                    getting
0207  *              ChildNode           - Previous child that was found.
0208  *                                    The NEXT child will be returned
0209  *
0210  * RETURN:      ACPI_NAMESPACE_NODE - Pointer to the NEXT child or NULL if
0211  *                                    none is found.
0212  *
0213  * DESCRIPTION: Return the next peer node within the namespace. If Handle
0214  *              is valid, Scope is ignored. Otherwise, the first node
0215  *              within Scope is returned.
0216  *
0217  ******************************************************************************/
0218
0219 ACPI_NAMESPACE_NODE *
0220 AcpiNsGetNextNodeTyped (
0221     ACPI_OBJECT_TYPE        Type,
0222     ACPI_NAMESPACE_NODE     *ParentNode,
0223     ACPI_NAMESPACE_NODE     *ChildNode)
0224 {
0225     ACPI_NAMESPACE_NODE     *NextNode = NULL;
0226
0227
0228     ACPI_FUNCTION_ENTRY ();
0229
0230
0231     NextNode = AcpiNsGetNextNode (ParentNode, ChildNode);
0232
0233     /* If any type is OK, we are done */
0234
0235     if (Type == ACPI_TYPE_ANY)
0236     {
0237         /* NextNode is NULL if we are at the end-of-list */
0238
0239         return (NextNode);
0240     }
0241
0242     /* Must search for the node -- but within this scope only */
0243
0244     while (NextNode)
0245     {
0246         /* If type matches, we are done */
0247
0248         if (NextNode->Type == Type)
0249         {
0250             return (NextNode);
0251         }
0252
0253         /* Otherwise, move on to the next peer node */
0254
0255         NextNode = NextNode->Peer;
0256     }
0257
0258     /* Not found */
0259
0260     return (NULL);
0261 }
0262
0263
0264 /*******************************************************************************
0265  *
0266  * FUNCTION:    AcpiNsWalkNamespace
0267  *
0268  * PARAMETERS:  Type                - ACPI_OBJECT_TYPE to search for
0269  *              StartNode           - Handle in namespace where search begins
0270  *              MaxDepth            - Depth to which search is to reach
0271  *              Flags               - Whether to unlock the NS before invoking
0272  *                                    the callback routine
0273  *              DescendingCallback  - Called during tree descent
0274  *                                    when an object of "Type" is found
0275  *              AscendingCallback   - Called during tree ascent
0276  *                                    when an object of "Type" is found
0277  *              Context             - Passed to user function(s) above
0278  *              ReturnValue         - from the UserFunction if terminated
0279  *                                    early. Otherwise, returns NULL.
0280  * RETURNS:     Status
0281  *
0282  * DESCRIPTION: Performs a modified depth-first walk of the namespace tree,
0283  *              starting (and ending) at the node specified by StartHandle.
0284  *              The callback function is called whenever a node that matches
0285  *              the type parameter is found. If the callback function returns
0286  *              a non-zero value, the search is terminated immediately and
0287  *              this value is returned to the caller.
0288  *
0289  *              The point of this procedure is to provide a generic namespace
0290  *              walk routine that can be called from multiple places to
0291  *              provide multiple services; the callback function(s) can be
0292  *              tailored to each task, whether it is a print function,
0293  *              a compare function, etc.
0294  *
0295  ******************************************************************************/
0296
0297 ACPI_STATUS
0298 AcpiNsWalkNamespace (
0299     ACPI_OBJECT_TYPE        Type,
0300     ACPI_HANDLE             StartNode,
0301     UINT32                  MaxDepth,
0302     UINT32                  Flags,
0303     ACPI_WALK_CALLBACK      DescendingCallback,
0304     ACPI_WALK_CALLBACK      AscendingCallback,
0305     void                    *Context,
0306     void                    **ReturnValue)
0307 {
0308     ACPI_STATUS             Status;
0309     ACPI_STATUS             MutexStatus;
0310     ACPI_NAMESPACE_NODE     *ChildNode;
0311     ACPI_NAMESPACE_NODE     *ParentNode;
0312     ACPI_OBJECT_TYPE        ChildType;
0313     UINT32                  Level;
0314     BOOLEAN                 NodePreviouslyVisited = FALSE;
0315
0316
0317     ACPI_FUNCTION_TRACE (NsWalkNamespace);
0318
0319
0320     /* Special case for the namespace Root Node */
0321
0322     if (StartNode == ACPI_ROOT_OBJECT)
0323     {
0324         StartNode = AcpiGbl_RootNode;
0325         if (!StartNode)
0326         {
0327             return_ACPI_STATUS (AE_NO_NAMESPACE);
0328         }
0329     }
0330
0331     /* Null child means "get first node" */
0332
0333     ParentNode = StartNode;
0334     ChildNode = AcpiNsGetNextNode (ParentNode, NULL);
0335     ChildType = ACPI_TYPE_ANY;
0336     Level = 1;
0337
0338     /*
0339      * Traverse the tree of nodes until we bubble back up to where we
0340      * started. When Level is zero, the loop is done because we have
0341      * bubbled up to (and passed) the original parent handle (StartEntry)
0342      */
0343     while (Level > 0 && ChildNode)
0344     {
0345         Status = AE_OK;
0346
0347         /* Found next child, get the type if we are not searching for ANY */
0348
0349         if (Type != ACPI_TYPE_ANY)
0350         {
0351             ChildType = ChildNode->Type;
0352         }
0353
0354         /*
0355          * Ignore all temporary namespace nodes (created during control
0356          * method execution) unless told otherwise. These temporary nodes
0357          * can cause a race condition because they can be deleted during
0358          * the execution of the user function (if the namespace is
0359          * unlocked before invocation of the user function.) Only the
0360          * debugger namespace dump will examine the temporary nodes.
0361          */
0362         if ((ChildNode->Flags & ANOBJ_TEMPORARY) &&
0363             !(Flags & ACPI_NS_WALK_TEMP_NODES))
0364         {
0365             Status = AE_CTRL_DEPTH;
0366         }
0367
0368         /* Type must match requested type */
0369
0370         else if (ChildType == Type)
0371         {
0372             /*
0373              * Found a matching node, invoke the user callback function.
0374              * Unlock the namespace if flag is set.
0375              */
0376             if (Flags & ACPI_NS_WALK_UNLOCK)
0377             {
0378                 MutexStatus = AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
0379                 if (ACPI_FAILURE (MutexStatus))
0380                 {
0381                     return_ACPI_STATUS (MutexStatus);
0382                 }
0383             }
0384
0385             /*
0386              * Invoke the user function, either descending, ascending,
0387              * or both.
0388              */
0389             if (!NodePreviouslyVisited)
0390             {
0391                 if (DescendingCallback)
0392                 {
0393                     Status = DescendingCallback (ChildNode, Level,
0394                         Context, ReturnValue);
0395                 }
0396             }
0397             else
0398             {
0399                 if (AscendingCallback)
0400                 {
0401                     Status = AscendingCallback (ChildNode, Level,
0402                         Context, ReturnValue);
0403                 }
0404             }
0405
0406             if (Flags & ACPI_NS_WALK_UNLOCK)
0407             {
0408                 MutexStatus = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
0409                 if (ACPI_FAILURE (MutexStatus))
0410                 {
0411                     return_ACPI_STATUS (MutexStatus);
0412                 }
0413             }
0414
0415             switch (Status)
0416             {
0417             case AE_OK:
0418             case AE_CTRL_DEPTH:
0419
0420                 /* Just keep going */
0421                 break;
0422
0423             case AE_CTRL_TERMINATE:
0424
0425                 /* Exit now, with OK status */
0426
0427                 return_ACPI_STATUS (AE_OK);
0428
0429             default:
0430
0431                 /* All others are valid exceptions */
0432
0433                 return_ACPI_STATUS (Status);
0434             }
0435         }
0436
0437         /*
0438          * Depth first search: Attempt to go down another level in the
0439          * namespace if we are allowed to. Don't go any further if we have
0440          * reached the caller specified maximum depth or if the user
0441          * function has specified that the maximum depth has been reached.
0442          */
0443         if (!NodePreviouslyVisited &&
0444             (Level < MaxDepth) &&
0445             (Status != AE_CTRL_DEPTH))
0446         {
0447             if (ChildNode->Child)
0448             {
0449                 /* There is at least one child of this node, visit it */
0450
0451                 Level++;
0452                 ParentNode = ChildNode;
0453                 ChildNode = AcpiNsGetNextNode (ParentNode, NULL);
0454                 continue;
0455             }
0456         }
0457
0458         /* No more children, re-visit this node */
0459
0460         if (!NodePreviouslyVisited)
0461         {
0462             NodePreviouslyVisited = TRUE;
0463             continue;
0464         }
0465
0466         /* No more children, visit peers */
0467
0468         ChildNode = AcpiNsGetNextNode (ParentNode, ChildNode);
0469         if (ChildNode)
0470         {
0471             NodePreviouslyVisited = FALSE;
0472         }
0473
0474         /* No peers, re-visit parent */
0475
0476         else
0477         {
0478             /*
0479              * No more children of this node (AcpiNsGetNextNode failed), go
0480              * back upwards in the namespace tree to the node's parent.
0481              */
0482             Level--;
0483             ChildNode = ParentNode;
0484             ParentNode = ParentNode->Parent;
0485
0486             NodePreviouslyVisited = TRUE;
0487         }
0488     }
0489
0490     /* Complete walk, not terminated by user function */
0491
0492     return_ACPI_STATUS (AE_OK);
0493 }