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