nssearch.c revision 80062
1/******************************************************************************* 2 * 3 * Module Name: nssearch - Namespace search 4 * $Revision: 71 $ 5 * 6 ******************************************************************************/ 7 8/****************************************************************************** 9 * 10 * 1. Copyright Notice 11 * 12 * Some or all of this work - Copyright (c) 1999, 2000, 2001, 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 117#define __NSSEARCH_C__ 118 119#include "acpi.h" 120#include "amlcode.h" 121#include "acinterp.h" 122#include "acnamesp.h" 123 124 125#define _COMPONENT ACPI_NAMESPACE 126 MODULE_NAME ("nssearch") 127 128 129/******************************************************************************* 130 * 131 * FUNCTION: AcpiNsSearchNode 132 * 133 * PARAMETERS: *TargetName - Ascii ACPI name to search for 134 * *Node - Starting table where search will begin 135 * Type - Object type to match 136 * **ReturnNode - Where the matched Named obj is returned 137 * 138 * RETURN: Status 139 * 140 * DESCRIPTION: Search a single namespace table. Performs a simple search, 141 * does not add 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 155ACPI_STATUS 156AcpiNsSearchNode ( 157 UINT32 TargetName, 158 ACPI_NAMESPACE_NODE *Node, 159 ACPI_OBJECT_TYPE8 Type, 160 ACPI_NAMESPACE_NODE **ReturnNode) 161{ 162 ACPI_NAMESPACE_NODE *NextNode; 163 164 165 FUNCTION_TRACE ("NsSearchNode"); 166 167 168#ifdef ACPI_DEBUG 169 if (TRACE_NAMES & AcpiDbgLevel) 170 { 171 NATIVE_CHAR *ScopeName; 172 173 ScopeName = AcpiNsGetTablePathname (Node); 174 if (ScopeName) 175 { 176 DEBUG_PRINTP (TRACE_NAMES, ("Searching %s [%p] For %4.4s (type %X)\n", 177 ScopeName, Node, &TargetName, Type)); 178 179 ACPI_MEM_FREE (ScopeName); 180 } 181 } 182#endif 183 184 185 /* 186 * Search for name in this table, which is to say that we must search 187 * for the name among the children of this object 188 */ 189 190 NextNode = Node->Child; 191 while (NextNode) 192 { 193 /* Check for match against the name */ 194 195 if (NextNode->Name == TargetName) 196 { 197 /* 198 * Found matching entry. Capture the type if appropriate, before 199 * returning the entry. 200 * 201 * The DefFieldDefn and BankFieldDefn cases are actually looking up 202 * the Region in which the field will be defined 203 */ 204 205 if ((INTERNAL_TYPE_FIELD_DEFN == Type) || 206 (INTERNAL_TYPE_BANK_FIELD_DEFN == Type)) 207 { 208 Type = ACPI_TYPE_REGION; 209 } 210 211 /* 212 * Scope, DefAny, and IndexFieldDefn are bogus "types" which do not 213 * actually have anything to do with the type of the name being 214 * looked up. For any other value of Type, if the type stored in 215 * the entry is Any (i.e. unknown), save the actual type. 216 */ 217 218 if (Type != INTERNAL_TYPE_SCOPE && 219 Type != INTERNAL_TYPE_DEF_ANY && 220 Type != INTERNAL_TYPE_INDEX_FIELD_DEFN && 221 NextNode->Type == ACPI_TYPE_ANY) 222 { 223 NextNode->Type = (UINT8) Type; 224 } 225 226 DEBUG_PRINTP (TRACE_NAMES, 227 ("Name %4.4s (actual type %X) found at %p\n", 228 &TargetName, NextNode->Type, NextNode)); 229 230 *ReturnNode = NextNode; 231 return_ACPI_STATUS (AE_OK); 232 } 233 234 235 /* 236 * The last entry in the list points back to the parent, 237 * so a flag is used to indicate the end-of-list 238 */ 239 if (NextNode->Flags & ANOBJ_END_OF_PEER_LIST) 240 { 241 /* Searched entire list, we are done */ 242 243 break; 244 } 245 246 /* Didn't match name, move on to the next peer object */ 247 248 NextNode = NextNode->Peer; 249 } 250 251 252 /* Searched entire table, not found */ 253 254 DEBUG_PRINTP (TRACE_NAMES, ("Name %4.4s (type %X) not found at %p\n", 255 &TargetName, Type, NextNode)); 256 257 return_ACPI_STATUS (AE_NOT_FOUND); 258} 259 260 261/******************************************************************************* 262 * 263 * FUNCTION: AcpiNsSearchParentTree 264 * 265 * PARAMETERS: *TargetName - Ascii ACPI name to search for 266 * *Node - Starting table where search will begin 267 * Type - Object type to match 268 * **ReturnNode - Where the matched Named Obj is returned 269 * 270 * RETURN: Status 271 * 272 * DESCRIPTION: Called when a name has not been found in the current namespace 273 * table. Before adding it or giving up, ACPI scope rules require 274 * searching enclosing scopes in cases identified by AcpiNsLocal(). 275 * 276 * "A name is located by finding the matching name in the current 277 * name space, and then in the parent name space. If the parent 278 * name space does not contain the name, the search continues 279 * recursively until either the name is found or the name space 280 * does not have a parent (the root of the name space). This 281 * indicates that the name is not found" (From ACPI Specification, 282 * section 5.3) 283 * 284 ******************************************************************************/ 285 286static ACPI_STATUS 287AcpiNsSearchParentTree ( 288 UINT32 TargetName, 289 ACPI_NAMESPACE_NODE *Node, 290 ACPI_OBJECT_TYPE8 Type, 291 ACPI_NAMESPACE_NODE **ReturnNode) 292{ 293 ACPI_STATUS Status; 294 ACPI_NAMESPACE_NODE *ParentNode; 295 296 297 FUNCTION_TRACE ("NsSearchParentTree"); 298 299 300 ParentNode = AcpiNsGetParentObject (Node); 301 302 /* 303 * If there is no parent (at the root) or type is "local", we won't be 304 * searching the parent tree. 305 */ 306 if ((AcpiNsLocal (Type)) || 307 (!ParentNode)) 308 { 309 if (!ParentNode) 310 { 311 DEBUG_PRINTP (TRACE_NAMES, ("[%4.4s] has no parent\n", 312 &TargetName)); 313 } 314 315 if (AcpiNsLocal (Type)) 316 { 317 DEBUG_PRINTP (TRACE_NAMES, ("[%4.4s] type %X is local(no search)\n", 318 &TargetName, Type)); 319 } 320 321 return_ACPI_STATUS (AE_NOT_FOUND); 322 } 323 324 325 /* Search the parent tree */ 326 327 DEBUG_PRINTP (TRACE_NAMES, ("Searching parent for %4.4s\n", &TargetName)); 328 329 /* 330 * Search parents until found the target or we have backed up to 331 * the root 332 */ 333 while (ParentNode) 334 { 335 /* Search parent scope */ 336 /* TBD: [Investigate] Why ACPI_TYPE_ANY? */ 337 338 Status = AcpiNsSearchNode (TargetName, ParentNode, 339 ACPI_TYPE_ANY, ReturnNode); 340 341 if (ACPI_SUCCESS (Status)) 342 { 343 return_ACPI_STATUS (Status); 344 } 345 346 /* 347 * Not found here, go up another level 348 * (until we reach the root) 349 */ 350 351 ParentNode = AcpiNsGetParentObject (ParentNode); 352 } 353 354 355 /* Not found in parent tree */ 356 357 return_ACPI_STATUS (AE_NOT_FOUND); 358} 359 360 361/******************************************************************************* 362 * 363 * FUNCTION: AcpiNsSearchAndEnter 364 * 365 * PARAMETERS: TargetName - Ascii ACPI name to search for (4 chars) 366 * WalkState - Current state of the walk 367 * *Node - Starting table where search will begin 368 * InterpreterMode - Add names only in MODE_LoadPassX. 369 * Otherwise,search only. 370 * Type - Object type to match 371 * Flags - Flags describing the search restrictions 372 * **ReturnNode - Where the Node is returned 373 * 374 * RETURN: Status 375 * 376 * DESCRIPTION: Search for a name segment in a single name table, 377 * optionally adding it if it is not found. If the passed 378 * Type is not Any and the type previously stored in the 379 * entry was Any (i.e. unknown), update the stored type. 380 * 381 * In IMODE_EXECUTE, search only. 382 * In other modes, search and add if not found. 383 * 384 ******************************************************************************/ 385 386ACPI_STATUS 387AcpiNsSearchAndEnter ( 388 UINT32 TargetName, 389 ACPI_WALK_STATE *WalkState, 390 ACPI_NAMESPACE_NODE *Node, 391 OPERATING_MODE InterpreterMode, 392 ACPI_OBJECT_TYPE8 Type, 393 UINT32 Flags, 394 ACPI_NAMESPACE_NODE **ReturnNode) 395{ 396 ACPI_STATUS Status; 397 ACPI_NAMESPACE_NODE *NewNode; 398 399 400 FUNCTION_TRACE ("NsSearchAndEnter"); 401 402 403 /* Parameter validation */ 404 405 if (!Node || !TargetName || !ReturnNode) 406 { 407 DEBUG_PRINTP (ACPI_ERROR, ("Null param- Table %p Name %p Return %p\n", 408 Node, TargetName, ReturnNode)); 409 410 REPORT_ERROR (("NsSearchAndEnter: bad (null) parameter\n")); 411 return_ACPI_STATUS (AE_BAD_PARAMETER); 412 } 413 414 415 /* Name must consist of printable characters */ 416 417 if (!AcpiUtValidAcpiName (TargetName)) 418 { 419 DEBUG_PRINTP (ACPI_ERROR, ("*** Bad character in name: %08lx *** \n", 420 TargetName)); 421 422 REPORT_ERROR (("NsSearchAndEnter: Bad character in ACPI Name\n")); 423 return_ACPI_STATUS (AE_BAD_CHARACTER); 424 } 425 426 427 /* Try to find the name in the table specified by the caller */ 428 429 *ReturnNode = ENTRY_NOT_FOUND; 430 Status = AcpiNsSearchNode (TargetName, Node, Type, ReturnNode); 431 if (Status != AE_NOT_FOUND) 432 { 433 /* 434 * If we found it AND the request specifies that a find is an error, 435 * return the error 436 */ 437 if ((Status == AE_OK) && 438 (Flags & NS_ERROR_IF_FOUND)) 439 { 440 Status = AE_EXIST; 441 } 442 443 /* 444 * Either found it or there was an error 445 * -- finished either way 446 */ 447 return_ACPI_STATUS (Status); 448 } 449 450 451 /* 452 * Not found in the table. If we are NOT performing the 453 * first pass (name entry) of loading the namespace, search 454 * the parent tree (all the way to the root if necessary.) 455 * We don't want to perform the parent search when the 456 * namespace is actually being loaded. We want to perform 457 * the search when namespace references are being resolved 458 * (load pass 2) and during the execution phase. 459 */ 460 461 if ((InterpreterMode != IMODE_LOAD_PASS1) && 462 (Flags & NS_SEARCH_PARENT)) 463 { 464 /* 465 * Not found in table - search parent tree according 466 * to ACPI specification 467 */ 468 469 Status = AcpiNsSearchParentTree (TargetName, Node, 470 Type, ReturnNode); 471 if (ACPI_SUCCESS (Status)) 472 { 473 return_ACPI_STATUS (Status); 474 } 475 } 476 477 478 /* 479 * In execute mode, just search, never add names. Exit now. 480 */ 481 if (InterpreterMode == IMODE_EXECUTE) 482 { 483 DEBUG_PRINTP (TRACE_NAMES, ("%4.4s Not found in %p [Not adding]\n", 484 &TargetName, Node)); 485 486 return_ACPI_STATUS (AE_NOT_FOUND); 487 } 488 489 490 /* Create the new named object */ 491 492 NewNode = AcpiNsCreateNode (TargetName); 493 if (!NewNode) 494 { 495 return_ACPI_STATUS (AE_NO_MEMORY); 496 } 497 498 /* Install the new object into the parent's list of children */ 499 500 AcpiNsInstallNode (WalkState, Node, NewNode, Type); 501 *ReturnNode = NewNode; 502 503 return_ACPI_STATUS (AE_OK); 504} 505 506