nssearch.c revision 102550
1219820Sjeff/******************************************************************************* 2219820Sjeff * 3219820Sjeff * Module Name: nssearch - Namespace search 4219820Sjeff * $Revision: 89 $ 5219820Sjeff * 6219820Sjeff ******************************************************************************/ 7219820Sjeff 8219820Sjeff/****************************************************************************** 9219820Sjeff * 10219820Sjeff * 1. Copyright Notice 11219820Sjeff * 12219820Sjeff * Some or all of this work - Copyright (c) 1999 - 2002, Intel Corp. 13219820Sjeff * All rights reserved. 14219820Sjeff * 15219820Sjeff * 2. License 16219820Sjeff * 17219820Sjeff * 2.1. This is your license from Intel Corp. under its intellectual property 18219820Sjeff * rights. You may have additional license terms from the party that provided 19219820Sjeff * you this software, covering your right to use that party's intellectual 20219820Sjeff * property rights. 21219820Sjeff * 22219820Sjeff * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 23219820Sjeff * copy of the source code appearing in this file ("Covered Code") an 24219820Sjeff * irrevocable, perpetual, worldwide license under Intel's copyrights in the 25219820Sjeff * base code distributed originally by Intel ("Original Intel Code") to copy, 26219820Sjeff * make derivatives, distribute, use and display any portion of the Covered 27219820Sjeff * Code in any form, with the right to sublicense such rights; and 28219820Sjeff * 29219820Sjeff * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 30219820Sjeff * license (with the right to sublicense), under only those claims of Intel 31219820Sjeff * patents that are infringed by the Original Intel Code, to make, use, sell, 32219820Sjeff * offer to sell, and import the Covered Code and derivative works thereof 33219820Sjeff * solely to the minimum extent necessary to exercise the above copyright 34219820Sjeff * license, and in no event shall the patent license extend to any additions 35219820Sjeff * to or modifications of the Original Intel Code. No other license or right 36219820Sjeff * is granted directly or by implication, estoppel or otherwise; 37219820Sjeff * 38219820Sjeff * The above copyright and patent license is granted only if the following 39219820Sjeff * conditions are met: 40219820Sjeff * 41219820Sjeff * 3. Conditions 42219820Sjeff * 43219820Sjeff * 3.1. Redistribution of Source with Rights to Further Distribute Source. 44219820Sjeff * Redistribution of source code of any substantial portion of the Covered 45219820Sjeff * Code or modification with rights to further distribute source must include 46219820Sjeff * the above Copyright Notice, the above License, this list of Conditions, 47219820Sjeff * and the following Disclaimer and Export Compliance provision. In addition, 48219820Sjeff * Licensee must cause all Covered Code to which Licensee contributes to 49219820Sjeff * contain a file documenting the changes Licensee made to create that Covered 50219820Sjeff * Code and the date of any change. Licensee must include in that file the 51219820Sjeff * documentation of any changes made by any predecessor Licensee. Licensee 52219820Sjeff * must include a prominent statement that the modification is derived, 53219820Sjeff * directly or indirectly, from Original Intel Code. 54219820Sjeff * 55219820Sjeff * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 56219820Sjeff * Redistribution of source code of any substantial portion of the Covered 57219820Sjeff * Code or modification without rights to further distribute source must 58219820Sjeff * include the following Disclaimer and Export Compliance provision in the 59219820Sjeff * documentation and/or other materials provided with distribution. In 60219820Sjeff * addition, Licensee may not authorize further sublicense of source of any 61219820Sjeff * portion of the Covered Code, and must include terms to the effect that the 62219820Sjeff * license from Licensee to its licensee is limited to the intellectual 63219820Sjeff * property embodied in the software Licensee provides to its licensee, and 64219820Sjeff * not to intellectual property embodied in modifications its licensee may 65219820Sjeff * make. 66219820Sjeff * 67219820Sjeff * 3.3. Redistribution of Executable. Redistribution in executable form of any 68219820Sjeff * substantial portion of the Covered Code or modification must reproduce the 69219820Sjeff * above Copyright Notice, and the following Disclaimer and Export Compliance 70219820Sjeff * provision in the documentation and/or other materials provided with the 71219820Sjeff * distribution. 72219820Sjeff * 73219820Sjeff * 3.4. Intel retains all right, title, and interest in and to the Original 74219820Sjeff * Intel Code. 75219820Sjeff * 76219820Sjeff * 3.5. Neither the name Intel nor any other trademark owned or controlled by 77219820Sjeff * Intel shall be used in advertising or otherwise to promote the sale, use or 78219820Sjeff * other dealings in products derived from or relating to the Covered Code 79219820Sjeff * without prior written authorization from Intel. 80219820Sjeff * 81219820Sjeff * 4. Disclaimer and Export Compliance 82219820Sjeff * 83219820Sjeff * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 84219820Sjeff * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 85219820Sjeff * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 86219820Sjeff * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 87219820Sjeff * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 88219820Sjeff * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 89219820Sjeff * PARTICULAR PURPOSE. 90219820Sjeff * 91219820Sjeff * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 92219820Sjeff * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 93219820Sjeff * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 94219820Sjeff * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 95219820Sjeff * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 96219820Sjeff * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 97219820Sjeff * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 98219820Sjeff * LIMITED REMEDY. 99219820Sjeff * 100219820Sjeff * 4.3. Licensee shall not export, either directly or indirectly, any of this 101219820Sjeff * software or system incorporating such software without first obtaining any 102219820Sjeff * required license or other approval from the U. S. Department of Commerce or 103219820Sjeff * any other agency or department of the United States Government. In the 104219820Sjeff * event Licensee exports any such software from the United States or 105219820Sjeff * re-exports any such software from a foreign destination, Licensee shall 106219820Sjeff * ensure that the distribution and export/re-export of the software is in 107219820Sjeff * compliance with all laws, regulations, orders, or other restrictions of the 108219820Sjeff * U.S. Export Administration Regulations. Licensee agrees that neither it nor 109219820Sjeff * any of its subsidiaries will export/re-export any technical data, process, 110219820Sjeff * software, or service, directly or indirectly, to any country for which the 111219820Sjeff * United States government or any agency thereof requires an export license, 112219820Sjeff * other governmental approval, or letter of assurance, without first obtaining 113219820Sjeff * such license, approval or letter. 114219820Sjeff * 115219820Sjeff *****************************************************************************/ 116219820Sjeff 117219820Sjeff#define __NSSEARCH_C__ 118219820Sjeff 119219820Sjeff#include "acpi.h" 120219820Sjeff#include "acnamesp.h" 121219820Sjeff 122219820Sjeff 123219820Sjeff#define _COMPONENT ACPI_NAMESPACE 124219820Sjeff ACPI_MODULE_NAME ("nssearch") 125219820Sjeff 126219820Sjeff 127219820Sjeff/******************************************************************************* 128219820Sjeff * 129219820Sjeff * FUNCTION: AcpiNsSearchNode 130219820Sjeff * 131219820Sjeff * PARAMETERS: *TargetName - Ascii ACPI name to search for 132219820Sjeff * *Node - Starting table where search will begin 133219820Sjeff * Type - Object type to match 134219820Sjeff * **ReturnNode - Where the matched Named obj is returned 135219820Sjeff * 136219820Sjeff * RETURN: Status 137219820Sjeff * 138219820Sjeff * DESCRIPTION: Search a single namespace table. Performs a simple search, 139219820Sjeff * does not add entries or search parents. 140219820Sjeff * 141219820Sjeff * 142219820Sjeff * Named object lists are built (and subsequently dumped) in the 143219820Sjeff * order in which the names are encountered during the namespace load; 144219820Sjeff * 145219820Sjeff * All namespace searching is linear in this implementation, but 146219820Sjeff * could be easily modified to support any improved search 147219820Sjeff * algorithm. However, the linear search was chosen for simplicity 148219820Sjeff * and because the trees are small and the other interpreter 149219820Sjeff * execution overhead is relatively high. 150219820Sjeff * 151219820Sjeff ******************************************************************************/ 152219820Sjeff 153219820SjeffACPI_STATUS 154219820SjeffAcpiNsSearchNode ( 155219820Sjeff UINT32 TargetName, 156219820Sjeff ACPI_NAMESPACE_NODE *Node, 157219820Sjeff ACPI_OBJECT_TYPE Type, 158219820Sjeff ACPI_NAMESPACE_NODE **ReturnNode) 159219820Sjeff{ 160219820Sjeff ACPI_NAMESPACE_NODE *NextNode; 161219820Sjeff 162219820Sjeff 163219820Sjeff ACPI_FUNCTION_TRACE ("NsSearchNode"); 164219820Sjeff 165219820Sjeff 166219820Sjeff#ifdef ACPI_DEBUG_OUTPUT 167219820Sjeff if (ACPI_LV_NAMES & AcpiDbgLevel) 168219820Sjeff { 169219820Sjeff NATIVE_CHAR *ScopeName; 170219820Sjeff 171219820Sjeff ScopeName = AcpiNsGetExternalPathname (Node); 172219820Sjeff if (ScopeName) 173219820Sjeff { 174219820Sjeff ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, "Searching %s [%p] For %4.4s (type %s)\n", 175219820Sjeff ScopeName, Node, (char *) &TargetName, AcpiUtGetTypeName (Type))); 176219820Sjeff 177219820Sjeff ACPI_MEM_FREE (ScopeName); 178219820Sjeff } 179219820Sjeff } 180219820Sjeff#endif 181219820Sjeff 182219820Sjeff /* 183219820Sjeff * Search for name in this table, which is to say that we must search 184219820Sjeff * for the name among the children of this object 185219820Sjeff */ 186219820Sjeff NextNode = Node->Child; 187219820Sjeff while (NextNode) 188219820Sjeff { 189219820Sjeff /* Check for match against the name */ 190219820Sjeff 191219820Sjeff if (NextNode->Name.Integer == TargetName) 192219820Sjeff { 193219820Sjeff /* 194219820Sjeff * Found matching entry. Capture the type if appropriate, before 195219820Sjeff * returning the entry. 196219820Sjeff * 197219820Sjeff * The DefFieldDefn and BankFieldDefn cases are actually looking up 198219820Sjeff * the Region in which the field will be defined 199219820Sjeff */ 200219820Sjeff if ((INTERNAL_TYPE_FIELD_DEFN == Type) || 201219820Sjeff (INTERNAL_TYPE_BANK_FIELD_DEFN == Type)) 202219820Sjeff { 203219820Sjeff Type = ACPI_TYPE_REGION; 204219820Sjeff } 205219820Sjeff 206219820Sjeff /* 207219820Sjeff * Scope, DefAny, and IndexFieldDefn are bogus "types" which do not 208219820Sjeff * actually have anything to do with the type of the name being 209219820Sjeff * looked up. For any other value of Type, if the type stored in 210219820Sjeff * the entry is Any (i.e. unknown), save the actual type. 211219820Sjeff */ 212219820Sjeff if (Type != INTERNAL_TYPE_SCOPE && 213219820Sjeff Type != INTERNAL_TYPE_DEF_ANY && 214219820Sjeff Type != INTERNAL_TYPE_INDEX_FIELD_DEFN && 215219820Sjeff NextNode->Type == ACPI_TYPE_ANY) 216219820Sjeff { 217219820Sjeff NextNode->Type = (UINT8) Type; 218219820Sjeff } 219219820Sjeff 220219820Sjeff ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, 221219820Sjeff "Name %4.4s Type [%s] found at %p\n", 222219820Sjeff (char *) &TargetName, AcpiUtGetTypeName (NextNode->Type), NextNode)); 223219820Sjeff 224219820Sjeff *ReturnNode = NextNode; 225219820Sjeff return_ACPI_STATUS (AE_OK); 226219820Sjeff } 227219820Sjeff 228219820Sjeff /* 229219820Sjeff * The last entry in the list points back to the parent, 230219820Sjeff * so a flag is used to indicate the end-of-list 231219820Sjeff */ 232219820Sjeff if (NextNode->Flags & ANOBJ_END_OF_PEER_LIST) 233219820Sjeff { 234219820Sjeff /* Searched entire list, we are done */ 235219820Sjeff 236219820Sjeff break; 237219820Sjeff } 238219820Sjeff 239219820Sjeff /* Didn't match name, move on to the next peer object */ 240219820Sjeff 241219820Sjeff NextNode = NextNode->Peer; 242219820Sjeff } 243219820Sjeff 244219820Sjeff /* Searched entire table, not found */ 245219820Sjeff 246219820Sjeff ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, "Name %4.4s Type [%s] not found at %p\n", 247219820Sjeff (char *) &TargetName, AcpiUtGetTypeName (Type), NextNode)); 248219820Sjeff 249219820Sjeff return_ACPI_STATUS (AE_NOT_FOUND); 250219820Sjeff} 251219820Sjeff 252219820Sjeff 253219820Sjeff/******************************************************************************* 254219820Sjeff * 255219820Sjeff * FUNCTION: AcpiNsSearchParentTree 256219820Sjeff * 257219820Sjeff * PARAMETERS: *TargetName - Ascii ACPI name to search for 258219820Sjeff * *Node - Starting table where search will begin 259219820Sjeff * Type - Object type to match 260219820Sjeff * **ReturnNode - Where the matched Named Obj is returned 261219820Sjeff * 262219820Sjeff * RETURN: Status 263219820Sjeff * 264219820Sjeff * DESCRIPTION: Called when a name has not been found in the current namespace 265219820Sjeff * table. Before adding it or giving up, ACPI scope rules require 266219820Sjeff * searching enclosing scopes in cases identified by AcpiNsLocal(). 267219820Sjeff * 268219820Sjeff * "A name is located by finding the matching name in the current 269219820Sjeff * name space, and then in the parent name space. If the parent 270219820Sjeff * name space does not contain the name, the search continues 271219820Sjeff * recursively until either the name is found or the name space 272219820Sjeff * does not have a parent (the root of the name space). This 273219820Sjeff * indicates that the name is not found" (From ACPI Specification, 274219820Sjeff * section 5.3) 275219820Sjeff * 276219820Sjeff ******************************************************************************/ 277219820Sjeff 278219820Sjeffstatic ACPI_STATUS 279219820SjeffAcpiNsSearchParentTree ( 280219820Sjeff UINT32 TargetName, 281219820Sjeff ACPI_NAMESPACE_NODE *Node, 282219820Sjeff ACPI_OBJECT_TYPE Type, 283219820Sjeff ACPI_NAMESPACE_NODE **ReturnNode) 284219820Sjeff{ 285219820Sjeff ACPI_STATUS Status; 286219820Sjeff ACPI_NAMESPACE_NODE *ParentNode; 287219820Sjeff 288219820Sjeff 289219820Sjeff ACPI_FUNCTION_TRACE ("NsSearchParentTree"); 290219820Sjeff 291219820Sjeff 292219820Sjeff ParentNode = AcpiNsGetParentNode (Node); 293 294 /* 295 * If there is no parent (at the root) or type is "local", we won't be 296 * searching the parent tree. 297 */ 298 if ((AcpiNsLocal (Type)) || 299 (!ParentNode)) 300 { 301 if (!ParentNode) 302 { 303 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, "[%4.4s] has no parent\n", 304 (char *) &TargetName)); 305 } 306 307 if (AcpiNsLocal (Type)) 308 { 309 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, 310 "[%4.4s] type [%s] must be local to this scope (no parent search)\n", 311 (char *) &TargetName, AcpiUtGetTypeName (Type))); 312 } 313 314 return_ACPI_STATUS (AE_NOT_FOUND); 315 } 316 317 /* Search the parent tree */ 318 319 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, "Searching parent for %4.4s\n", (char *) &TargetName)); 320 321 /* 322 * Search parents until found the target or we have backed up to 323 * the root 324 */ 325 while (ParentNode) 326 { 327 /* 328 * Search parent scope. Use TYPE_ANY because we don't care about the 329 * object type at this point, we only care about the existence of 330 * the actual name we are searching for. Typechecking comes later. 331 */ 332 Status = AcpiNsSearchNode (TargetName, ParentNode, 333 ACPI_TYPE_ANY, ReturnNode); 334 if (ACPI_SUCCESS (Status)) 335 { 336 return_ACPI_STATUS (Status); 337 } 338 339 /* 340 * Not found here, go up another level 341 * (until we reach the root) 342 */ 343 ParentNode = AcpiNsGetParentNode (ParentNode); 344 } 345 346 /* Not found in parent tree */ 347 348 return_ACPI_STATUS (AE_NOT_FOUND); 349} 350 351 352/******************************************************************************* 353 * 354 * FUNCTION: AcpiNsSearchAndEnter 355 * 356 * PARAMETERS: TargetName - Ascii ACPI name to search for (4 chars) 357 * WalkState - Current state of the walk 358 * *Node - Starting table where search will begin 359 * InterpreterMode - Add names only in MODE_LoadPassX. 360 * Otherwise,search only. 361 * Type - Object type to match 362 * Flags - Flags describing the search restrictions 363 * **ReturnNode - Where the Node is returned 364 * 365 * RETURN: Status 366 * 367 * DESCRIPTION: Search for a name segment in a single name table, 368 * optionally adding it if it is not found. If the passed 369 * Type is not Any and the type previously stored in the 370 * entry was Any (i.e. unknown), update the stored type. 371 * 372 * In IMODE_EXECUTE, search only. 373 * In other modes, search and add if not found. 374 * 375 ******************************************************************************/ 376 377ACPI_STATUS 378AcpiNsSearchAndEnter ( 379 UINT32 TargetName, 380 ACPI_WALK_STATE *WalkState, 381 ACPI_NAMESPACE_NODE *Node, 382 ACPI_INTERPRETER_MODE InterpreterMode, 383 ACPI_OBJECT_TYPE Type, 384 UINT32 Flags, 385 ACPI_NAMESPACE_NODE **ReturnNode) 386{ 387 ACPI_STATUS Status; 388 ACPI_NAMESPACE_NODE *NewNode; 389 390 391 ACPI_FUNCTION_TRACE ("NsSearchAndEnter"); 392 393 394 /* Parameter validation */ 395 396 if (!Node || !TargetName || !ReturnNode) 397 { 398 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Null param: Node %p Name %X ReturnNode %p\n", 399 Node, TargetName, ReturnNode)); 400 401 ACPI_REPORT_ERROR (("NsSearchAndEnter: Null parameter\n")); 402 return_ACPI_STATUS (AE_BAD_PARAMETER); 403 } 404 405 /* Name must consist of printable characters */ 406 407 if (!AcpiUtValidAcpiName (TargetName)) 408 { 409 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "*** Bad character in name: %08x *** \n", 410 TargetName)); 411 412 ACPI_REPORT_ERROR (("NsSearchAndEnter: Bad character in ACPI Name\n")); 413 return_ACPI_STATUS (AE_BAD_CHARACTER); 414 } 415 416 /* Try to find the name in the table specified by the caller */ 417 418 *ReturnNode = ACPI_ENTRY_NOT_FOUND; 419 Status = AcpiNsSearchNode (TargetName, Node, Type, ReturnNode); 420 if (Status != AE_NOT_FOUND) 421 { 422 /* 423 * If we found it AND the request specifies that a find is an error, 424 * return the error 425 */ 426 if ((Status == AE_OK) && 427 (Flags & ACPI_NS_ERROR_IF_FOUND)) 428 { 429 Status = AE_ALREADY_EXISTS; 430 } 431 432 /* 433 * Either found it or there was an error 434 * -- finished either way 435 */ 436 return_ACPI_STATUS (Status); 437 } 438 439 /* 440 * The name was not found. If we are NOT performing the 441 * first pass (name entry) of loading the namespace, search 442 * the parent tree (all the way to the root if necessary.) 443 * We don't want to perform the parent search when the 444 * namespace is actually being loaded. We want to perform 445 * the search when namespace references are being resolved 446 * (load pass 2) and during the execution phase. 447 */ 448 if ((InterpreterMode != ACPI_IMODE_LOAD_PASS1) && 449 (Flags & ACPI_NS_SEARCH_PARENT)) 450 { 451 /* 452 * Not found in table - search parent tree according 453 * to ACPI specification 454 */ 455 Status = AcpiNsSearchParentTree (TargetName, Node, 456 Type, ReturnNode); 457 if (ACPI_SUCCESS (Status)) 458 { 459 return_ACPI_STATUS (Status); 460 } 461 } 462 463 /* 464 * In execute mode, just search, never add names. Exit now. 465 */ 466 if (InterpreterMode == ACPI_IMODE_EXECUTE) 467 { 468 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, "%4.4s Not found in %p [Not adding]\n", 469 (char *) &TargetName, Node)); 470 471 return_ACPI_STATUS (AE_NOT_FOUND); 472 } 473 474 /* Create the new named object */ 475 476 NewNode = AcpiNsCreateNode (TargetName); 477 if (!NewNode) 478 { 479 return_ACPI_STATUS (AE_NO_MEMORY); 480 } 481 482 /* Install the new object into the parent's list of children */ 483 484 AcpiNsInstallNode (WalkState, Node, NewNode, Type); 485 *ReturnNode = NewNode; 486 487 return_ACPI_STATUS (AE_OK); 488} 489 490