sys/contrib/dev/acpica/nssearch.c

   1 /*******************************************************************************
   2  *
   3  * Module Name: nssearch - Namespace search
   4  *              $Revision: 95 $
   5  *
   6  ******************************************************************************/
   7
   8 /******************************************************************************
   9  *
  10  * 1. Copyright Notice
  11  *
  12  * Some or all of this work - Copyright (c) 1999 - 2003, Intel Corp.
  13  * All rights reserved.
  14  *
  15  * 2. License
  16  *
  17  * 2.1. This is your license from Intel Corp. under its intellectual property
  18  * rights.  You may have additional license terms from the party that provided
  19  * you this software, covering your right to use that party's intellectual
  20  * property rights.
  21  *
  22  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  23  * copy of the source code appearing in this file ("Covered Code") an
  24  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  25  * base code distributed originally by Intel ("Original Intel Code") to copy,
  26  * make derivatives, distribute, use and display any portion of the Covered
  27  * Code in any form, with the right to sublicense such rights; and
  28  *
  29  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  30  * license (with the right to sublicense), under only those claims of Intel
  31  * patents that are infringed by the Original Intel Code, to make, use, sell,
  32  * offer to sell, and import the Covered Code and derivative works thereof
  33  * solely to the minimum extent necessary to exercise the above copyright
  34  * license, and in no event shall the patent license extend to any additions
  35  * to or modifications of the Original Intel Code.  No other license or right
  36  * is granted directly or by implication, estoppel or otherwise;
  37  *
  38  * The above copyright and patent license is granted only if the following
  39  * conditions are met:
  40  *
  41  * 3. Conditions
  42  *
  43  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  44  * Redistribution of source code of any substantial portion of the Covered
  45  * Code or modification with rights to further distribute source must include
  46  * the above Copyright Notice, the above License, this list of Conditions,
  47  * and the following Disclaimer and Export Compliance provision.  In addition,
  48  * Licensee must cause all Covered Code to which Licensee contributes to
  49  * contain a file documenting the changes Licensee made to create that Covered
  50  * Code and the date of any change.  Licensee must include in that file the
  51  * documentation of any changes made by any predecessor Licensee.  Licensee
  52  * must include a prominent statement that the modification is derived,
  53  * directly or indirectly, from Original Intel Code.
  54  *
  55  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  56  * Redistribution of source code of any substantial portion of the Covered
  57  * Code or modification without rights to further distribute source must
  58  * include the following Disclaimer and Export Compliance provision in the
  59  * documentation and/or other materials provided with distribution.  In
  60  * addition, Licensee may not authorize further sublicense of source of any
  61  * portion of the Covered Code, and must include terms to the effect that the
  62  * license from Licensee to its licensee is limited to the intellectual
  63  * property embodied in the software Licensee provides to its licensee, and
  64  * not to intellectual property embodied in modifications its licensee may
  65  * make.
  66  *
  67  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  68  * substantial portion of the Covered Code or modification must reproduce the
  69  * above Copyright Notice, and the following Disclaimer and Export Compliance
  70  * provision in the documentation and/or other materials provided with the
  71  * distribution.
  72  *
  73  * 3.4. Intel retains all right, title, and interest in and to the Original
  74  * Intel Code.
  75  *
  76  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  77  * Intel shall be used in advertising or otherwise to promote the sale, use or
  78  * other dealings in products derived from or relating to the Covered Code
  79  * without prior written authorization from Intel.
  80  *
  81  * 4. Disclaimer and Export Compliance
  82  *
  83  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  84  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  85  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
  86  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
  87  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
  88  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  89  * PARTICULAR PURPOSE.
  90  *
  91  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  92  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  93  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  94  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  95  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  96  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
  97  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  98  * LIMITED REMEDY.
  99  *
 100  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 101  * software or system incorporating such software without first obtaining any
 102  * required license or other approval from the U. S. Department of Commerce or
 103  * any other agency or department of the United States Government.  In the
 104  * event Licensee exports any such software from the United States or
 105  * re-exports any such software from a foreign destination, Licensee shall
 106  * ensure that the distribution and export/re-export of the software is in
 107  * compliance with all laws, regulations, orders, or other restrictions of the
 108  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 109  * any of its subsidiaries will export/re-export any technical data, process,
 110  * software, or service, directly or indirectly, to any country for which the
 111  * United States government or any agency thereof requires an export license,
 112  * other governmental approval, or letter of assurance, without first obtaining
 113  * such license, approval or letter.
 114  *
 115  *****************************************************************************/
 116 /* $DragonFly: src/sys/contrib/dev/acpica/Attic/nssearch.c,v 1.1 2003/09/24 03:32:16 drhodus Exp $                                                               */
 117
 118 #define __NSSEARCH_C__
 119
 120 #include "acpi.h"
 121 #include "acnamesp.h"
 122
 123
 124 #define _COMPONENT          ACPI_NAMESPACE
 125         ACPI_MODULE_NAME    ("nssearch")
 126
 127
 128 /*******************************************************************************
 129  *
 130  * FUNCTION:    AcpiNsSearchNode
 131  *
 132  * PARAMETERS:  *TargetName         - Ascii ACPI name to search for
 133  *              *Node               - Starting node where search will begin
 134  *              Type                - Object type to match
 135  *              **ReturnNode        - Where the matched Named obj is returned
 136  *
 137  * RETURN:      Status
 138  *
 139  * DESCRIPTION: Search a single level of the namespace.  Performs a
 140  *              simple search of the specified level, and does not add
 141  *              entries or search parents.
 142  *
 143  *
 144  *      Named object lists are built (and subsequently dumped) in the
 145  *      order in which the names are encountered during the namespace load;
 146  *
 147  *      All namespace searching is linear in this implementation, but
 148  *      could be easily modified to support any improved search
 149  *      algorithm.  However, the linear search was chosen for simplicity
 150  *      and because the trees are small and the other interpreter
 151  *      execution overhead is relatively high.
 152  *
 153  ******************************************************************************/
 154
 155 ACPI_STATUS
 156 AcpiNsSearchNode (
 157     UINT32                  TargetName,
 158     ACPI_NAMESPACE_NODE     *Node,
 159     ACPI_OBJECT_TYPE        Type,
 160     ACPI_NAMESPACE_NODE     **ReturnNode)
 161 {
 162     ACPI_NAMESPACE_NODE     *NextNode;
 163
 164
 165     ACPI_FUNCTION_TRACE ("NsSearchNode");
 166
 167
 168 #ifdef ACPI_DEBUG_OUTPUT
 169     if (ACPI_LV_NAMES & AcpiDbgLevel)
 170     {
 171         char                *ScopeName;
 172
 173         ScopeName = AcpiNsGetExternalPathname (Node);
 174         if (ScopeName)
 175         {
 176             ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, "Searching %s [%p] For %4.4s (%s)\n",
 177                 ScopeName, Node, (char *) &TargetName, AcpiUtGetTypeName (Type)));
 178
 179             ACPI_MEM_FREE (ScopeName);
 180         }
 181     }
 182 #endif
 183
 184     /*
 185      * Search for name at this namespace level, which is to say that we
 186      * must search for the name among the children of this object
 187      */
 188     NextNode = Node->Child;
 189     while (NextNode)
 190     {
 191         /* Check for match against the name */
 192
 193         if (NextNode->Name.Integer == TargetName)
 194         {
 195             /*
 196              * Found matching entry.
 197              */
 198             ACPI_DEBUG_PRINT ((ACPI_DB_NAMES,
 199                 "Name %4.4s Type [%s] found at %p\n",
 200                 (char *) &TargetName, AcpiUtGetTypeName (NextNode->Type), NextNode));
 201
 202             *ReturnNode = NextNode;
 203             return_ACPI_STATUS (AE_OK);
 204         }
 205
 206         /*
 207          * The last entry in the list points back to the parent,
 208          * so a flag is used to indicate the end-of-list
 209          */
 210         if (NextNode->Flags & ANOBJ_END_OF_PEER_LIST)
 211         {
 212             /* Searched entire list, we are done */
 213
 214             break;
 215         }
 216
 217         /* Didn't match name, move on to the next peer object */
 218
 219         NextNode = NextNode->Peer;
 220     }
 221
 222     /* Searched entire namespace level, not found */
 223
 224     ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, "Name %4.4s Type [%s] not found at %p\n",
 225         (char *) &TargetName, AcpiUtGetTypeName (Type), NextNode));
 226
 227     return_ACPI_STATUS (AE_NOT_FOUND);
 228 }
 229
 230
 231 /*******************************************************************************
 232  *
 233  * FUNCTION:    AcpiNsSearchParentTree
 234  *
 235  * PARAMETERS:  *TargetName         - Ascii ACPI name to search for
 236  *              *Node               - Starting node where search will begin
 237  *              Type                - Object type to match
 238  *              **ReturnNode        - Where the matched Named Obj is returned
 239  *
 240  * RETURN:      Status
 241  *
 242  * DESCRIPTION: Called when a name has not been found in the current namespace
 243  *              level.  Before adding it or giving up, ACPI scope rules require
 244  *              searching enclosing scopes in cases identified by AcpiNsLocal().
 245  *
 246  *              "A name is located by finding the matching name in the current
 247  *              name space, and then in the parent name space. If the parent
 248  *              name space does not contain the name, the search continues
 249  *              recursively until either the name is found or the name space
 250  *              does not have a parent (the root of the name space).  This
 251  *              indicates that the name is not found" (From ACPI Specification,
 252  *              section 5.3)
 253  *
 254  ******************************************************************************/
 255
 256 static ACPI_STATUS
 257 AcpiNsSearchParentTree (
 258     UINT32                  TargetName,
 259     ACPI_NAMESPACE_NODE     *Node,
 260     ACPI_OBJECT_TYPE        Type,
 261     ACPI_NAMESPACE_NODE     **ReturnNode)
 262 {
 263     ACPI_STATUS             Status;
 264     ACPI_NAMESPACE_NODE     *ParentNode;
 265
 266
 267     ACPI_FUNCTION_TRACE ("NsSearchParentTree");
 268
 269
 270     ParentNode = AcpiNsGetParentNode (Node);
 271
 272     /*
 273      * If there is no parent (i.e., we are at the root) or
 274      * type is "local", we won't be searching the parent tree.
 275      */
 276     if (!ParentNode)
 277     {
 278         ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, "[%4.4s] has no parent\n",
 279             (char *) &TargetName));
 280          return_ACPI_STATUS (AE_NOT_FOUND);
 281     }
 282
 283     if (AcpiNsLocal (Type))
 284     {
 285         ACPI_DEBUG_PRINT ((ACPI_DB_NAMES,
 286             "[%4.4s] type [%s] must be local to this scope (no parent search)\n",
 287             (char *) &TargetName, AcpiUtGetTypeName (Type)));
 288         return_ACPI_STATUS (AE_NOT_FOUND);
 289     }
 290
 291     /* Search the parent tree */
 292
 293     ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, "Searching parent for %4.4s\n", (char *) &TargetName));
 294
 295     /*
 296      * Search parents until found the target or we have backed up to
 297      * the root
 298      */
 299     while (ParentNode)
 300     {
 301         /*
 302          * Search parent scope.  Use TYPE_ANY because we don't care about the
 303          * object type at this point, we only care about the existence of
 304          * the actual name we are searching for.  Typechecking comes later.
 305          */
 306         Status = AcpiNsSearchNode (TargetName, ParentNode,
 307                                         ACPI_TYPE_ANY, ReturnNode);
 308         if (ACPI_SUCCESS (Status))
 309         {
 310             return_ACPI_STATUS (Status);
 311         }
 312
 313         /*
 314          * Not found here, go up another level
 315          * (until we reach the root)
 316          */
 317         ParentNode = AcpiNsGetParentNode (ParentNode);
 318     }
 319
 320     /* Not found in parent tree */
 321
 322     return_ACPI_STATUS (AE_NOT_FOUND);
 323 }
 324
 325
 326 /*******************************************************************************
 327  *
 328  * FUNCTION:    AcpiNsSearchAndEnter
 329  *
 330  * PARAMETERS:  TargetName          - Ascii ACPI name to search for (4 chars)
 331  *              WalkState           - Current state of the walk
 332  *              *Node               - Starting node where search will begin
 333  *              InterpreterMode     - Add names only in ACPI_MODE_LOAD_PASS_x.
 334  *                                    Otherwise,search only.
 335  *              Type                - Object type to match
 336  *              Flags               - Flags describing the search restrictions
 337  *              **ReturnNode        - Where the Node is returned
 338  *
 339  * RETURN:      Status
 340  *
 341  * DESCRIPTION: Search for a name segment in a single namespace level,
 342  *              optionally adding it if it is not found.  If the passed
 343  *              Type is not Any and the type previously stored in the
 344  *              entry was Any (i.e. unknown), update the stored type.
 345  *
 346  *              In ACPI_IMODE_EXECUTE, search only.
 347  *              In other modes, search and add if not found.
 348  *
 349  ******************************************************************************/
 350
 351 ACPI_STATUS
 352 AcpiNsSearchAndEnter (
 353     UINT32                  TargetName,
 354     ACPI_WALK_STATE         *WalkState,
 355     ACPI_NAMESPACE_NODE     *Node,
 356     ACPI_INTERPRETER_MODE   InterpreterMode,
 357     ACPI_OBJECT_TYPE        Type,
 358     UINT32                  Flags,
 359     ACPI_NAMESPACE_NODE     **ReturnNode)
 360 {
 361     ACPI_STATUS             Status;
 362     ACPI_NAMESPACE_NODE     *NewNode;
 363
 364
 365     ACPI_FUNCTION_TRACE ("NsSearchAndEnter");
 366
 367
 368     /* Parameter validation */
 369
 370     if (!Node || !TargetName || !ReturnNode)
 371     {
 372         ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Null param: Node %p Name %X ReturnNode %p\n",
 373             Node, TargetName, ReturnNode));
 374
 375         ACPI_REPORT_ERROR (("NsSearchAndEnter: Null parameter\n"));
 376         return_ACPI_STATUS (AE_BAD_PARAMETER);
 377     }
 378
 379     /* Name must consist of printable characters */
 380
 381     if (!AcpiUtValidAcpiName (TargetName))
 382     {
 383         ACPI_REPORT_ERROR (("NsSearchAndEnter: Bad character in ACPI Name: %X\n",
 384             TargetName));
 385         return_ACPI_STATUS (AE_BAD_CHARACTER);
 386     }
 387
 388     /* Try to find the name in the namespace level specified by the caller */
 389
 390     *ReturnNode = ACPI_ENTRY_NOT_FOUND;
 391     Status = AcpiNsSearchNode (TargetName, Node, Type, ReturnNode);
 392     if (Status != AE_NOT_FOUND)
 393     {
 394         /*
 395          * If we found it AND the request specifies that a find is an error,
 396          * return the error
 397          */
 398         if ((Status == AE_OK) &&
 399             (Flags & ACPI_NS_ERROR_IF_FOUND))
 400         {
 401             Status = AE_ALREADY_EXISTS;
 402         }
 403
 404         /*
 405          * Either found it or there was an error
 406          * -- finished either way
 407          */
 408         return_ACPI_STATUS (Status);
 409     }
 410
 411     /*
 412      * The name was not found.  If we are NOT performing the
 413      * first pass (name entry) of loading the namespace, search
 414      * the parent tree (all the way to the root if necessary.)
 415      * We don't want to perform the parent search when the
 416      * namespace is actually being loaded.  We want to perform
 417      * the search when namespace references are being resolved
 418      * (load pass 2) and during the execution phase.
 419      */
 420     if ((InterpreterMode != ACPI_IMODE_LOAD_PASS1) &&
 421         (Flags & ACPI_NS_SEARCH_PARENT))
 422     {
 423         /*
 424          * Not found at this level - search parent tree according
 425          * to ACPI specification
 426          */
 427         Status = AcpiNsSearchParentTree (TargetName, Node,
 428                                             Type, ReturnNode);
 429         if (ACPI_SUCCESS (Status))
 430         {
 431             return_ACPI_STATUS (Status);
 432         }
 433     }
 434
 435     /*
 436      * In execute mode, just search, never add names.  Exit now.
 437      */
 438     if (InterpreterMode == ACPI_IMODE_EXECUTE)
 439     {
 440         ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, "%4.4s Not found in %p [Not adding]\n",
 441             (char *) &TargetName, Node));
 442
 443         return_ACPI_STATUS (AE_NOT_FOUND);
 444     }
 445
 446     /* Create the new named object */
 447
 448     NewNode = AcpiNsCreateNode (TargetName);
 449     if (!NewNode)
 450     {
 451         return_ACPI_STATUS (AE_NO_MEMORY);
 452     }
 453
 454     /* Install the new object into the parent's list of children */
 455
 456     AcpiNsInstallNode (WalkState, Node, NewNode, Type);
 457     *ReturnNode = NewNode;
 458
 459     return_ACPI_STATUS (AE_OK);
 460 }
 461