nssearch.c revision 126372
1/******************************************************************************* 2 * 3 * Module Name: nssearch - Namespace search 4 * $Revision: 100 $ 5 * 6 ******************************************************************************/ 7 8/****************************************************************************** 9 * 10 * 1. Copyright Notice 11 * 12 * Some or all of this work - Copyright (c) 1999 - 2004, 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 "acnamesp.h" 121 122 123#define _COMPONENT ACPI_NAMESPACE 124 ACPI_MODULE_NAME ("nssearch") 125 126 127/******************************************************************************* 128 * 129 * FUNCTION: AcpiNsSearchNode 130 * 131 * PARAMETERS: *TargetName - Ascii ACPI name to search for 132 * *Node - Starting node where search will begin 133 * Type - Object type to match 134 * **ReturnNode - Where the matched Named obj is returned 135 * 136 * RETURN: Status 137 * 138 * DESCRIPTION: Search a single level of the namespace. Performs a 139 * simple search of the specified level, and does not add 140 * entries or search parents. 141 * 142 * 143 * Named object lists are built (and subsequently dumped) in the 144 * order in which the names are encountered during the namespace load; 145 * 146 * All namespace searching is linear in this implementation, but 147 * could be easily modified to support any improved search 148 * algorithm. However, the linear search was chosen for simplicity 149 * and because the trees are small and the other interpreter 150 * execution overhead is relatively high. 151 * 152 ******************************************************************************/ 153 154ACPI_STATUS 155AcpiNsSearchNode ( 156 UINT32 TargetName, 157 ACPI_NAMESPACE_NODE *Node, 158 ACPI_OBJECT_TYPE Type, 159 ACPI_NAMESPACE_NODE **ReturnNode) 160{ 161 ACPI_NAMESPACE_NODE *NextNode; 162 163 164 ACPI_FUNCTION_TRACE ("NsSearchNode"); 165 166 167#ifdef ACPI_DEBUG_OUTPUT 168 if (ACPI_LV_NAMES & AcpiDbgLevel) 169 { 170 char *ScopeName; 171 172 ScopeName = AcpiNsGetExternalPathname (Node); 173 if (ScopeName) 174 { 175 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, "Searching %s (%p) For [%4.4s] (%s)\n", 176 ScopeName, Node, (char *) &TargetName, AcpiUtGetTypeName (Type))); 177 178 ACPI_MEM_FREE (ScopeName); 179 } 180 } 181#endif 182 183 /* 184 * Search for name at this namespace level, which is to say that we 185 * must search for the name among the children of this object 186 */ 187 NextNode = Node->Child; 188 while (NextNode) 189 { 190 /* Check for match against the name */ 191 192 if (NextNode->Name.Integer == TargetName) 193 { 194 /* 195 * Found matching entry. 196 */ 197 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, 198 "Name [%4.4s] (%s) %p found in scope [%4.4s] %p\n", 199 (char *) &TargetName, AcpiUtGetTypeName (NextNode->Type), 200 NextNode, AcpiUtGetNodeName (Node), Node)); 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, 225 "Name [%4.4s] (%s) not found in search in scope [%4.4s] %p first child %p\n", 226 (char *) &TargetName, AcpiUtGetTypeName (Type), 227 AcpiUtGetNodeName (Node), Node, Node->Child)); 228 229 return_ACPI_STATUS (AE_NOT_FOUND); 230} 231 232 233/******************************************************************************* 234 * 235 * FUNCTION: AcpiNsSearchParentTree 236 * 237 * PARAMETERS: *TargetName - Ascii ACPI name to search for 238 * *Node - Starting node where search will begin 239 * Type - Object type to match 240 * **ReturnNode - Where the matched Named Obj is returned 241 * 242 * RETURN: Status 243 * 244 * DESCRIPTION: Called when a name has not been found in the current namespace 245 * level. Before adding it or giving up, ACPI scope rules require 246 * searching enclosing scopes in cases identified by AcpiNsLocal(). 247 * 248 * "A name is located by finding the matching name in the current 249 * name space, and then in the parent name space. If the parent 250 * name space does not contain the name, the search continues 251 * recursively until either the name is found or the name space 252 * does not have a parent (the root of the name space). This 253 * indicates that the name is not found" (From ACPI Specification, 254 * section 5.3) 255 * 256 ******************************************************************************/ 257 258static ACPI_STATUS 259AcpiNsSearchParentTree ( 260 UINT32 TargetName, 261 ACPI_NAMESPACE_NODE *Node, 262 ACPI_OBJECT_TYPE Type, 263 ACPI_NAMESPACE_NODE **ReturnNode) 264{ 265 ACPI_STATUS Status; 266 ACPI_NAMESPACE_NODE *ParentNode; 267 268 269 ACPI_FUNCTION_TRACE ("NsSearchParentTree"); 270 271 272 ParentNode = AcpiNsGetParentNode (Node); 273 274 /* 275 * If there is no parent (i.e., we are at the root) or 276 * type is "local", we won't be searching the parent tree. 277 */ 278 if (!ParentNode) 279 { 280 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, "[%4.4s] has no parent\n", 281 (char *) &TargetName)); 282 return_ACPI_STATUS (AE_NOT_FOUND); 283 } 284 285 if (AcpiNsLocal (Type)) 286 { 287 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, 288 "[%4.4s] type [%s] must be local to this scope (no parent search)\n", 289 (char *) &TargetName, AcpiUtGetTypeName (Type))); 290 return_ACPI_STATUS (AE_NOT_FOUND); 291 } 292 293 /* Search the parent tree */ 294 295 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, "Searching parent for %4.4s\n", (char *) &TargetName)); 296 297 /* 298 * Search parents until found the target or we have backed up to 299 * the root 300 */ 301 while (ParentNode) 302 { 303 /* 304 * Search parent scope. Use TYPE_ANY because we don't care about the 305 * object type at this point, we only care about the existence of 306 * the actual name we are searching for. Typechecking comes later. 307 */ 308 Status = AcpiNsSearchNode (TargetName, ParentNode, 309 ACPI_TYPE_ANY, ReturnNode); 310 if (ACPI_SUCCESS (Status)) 311 { 312 return_ACPI_STATUS (Status); 313 } 314 315 /* 316 * Not found here, go up another level 317 * (until we reach the root) 318 */ 319 ParentNode = AcpiNsGetParentNode (ParentNode); 320 } 321 322 /* Not found in parent tree */ 323 324 return_ACPI_STATUS (AE_NOT_FOUND); 325} 326 327 328/******************************************************************************* 329 * 330 * FUNCTION: AcpiNsSearchAndEnter 331 * 332 * PARAMETERS: TargetName - Ascii ACPI name to search for (4 chars) 333 * WalkState - Current state of the walk 334 * *Node - Starting node where search will begin 335 * InterpreterMode - Add names only in ACPI_MODE_LOAD_PASS_x. 336 * Otherwise,search only. 337 * Type - Object type to match 338 * Flags - Flags describing the search restrictions 339 * **ReturnNode - Where the Node is returned 340 * 341 * RETURN: Status 342 * 343 * DESCRIPTION: Search for a name segment in a single namespace level, 344 * optionally adding it if it is not found. If the passed 345 * Type is not Any and the type previously stored in the 346 * entry was Any (i.e. unknown), update the stored type. 347 * 348 * In ACPI_IMODE_EXECUTE, search only. 349 * In other modes, search and add if not found. 350 * 351 ******************************************************************************/ 352 353ACPI_STATUS 354AcpiNsSearchAndEnter ( 355 UINT32 TargetName, 356 ACPI_WALK_STATE *WalkState, 357 ACPI_NAMESPACE_NODE *Node, 358 ACPI_INTERPRETER_MODE InterpreterMode, 359 ACPI_OBJECT_TYPE Type, 360 UINT32 Flags, 361 ACPI_NAMESPACE_NODE **ReturnNode) 362{ 363 ACPI_STATUS Status; 364 ACPI_NAMESPACE_NODE *NewNode; 365 366 367 ACPI_FUNCTION_TRACE ("NsSearchAndEnter"); 368 369 370 /* Parameter validation */ 371 372 if (!Node || !TargetName || !ReturnNode) 373 { 374 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Null param: Node %p Name %X ReturnNode %p\n", 375 Node, TargetName, ReturnNode)); 376 377 ACPI_REPORT_ERROR (("NsSearchAndEnter: Null parameter\n")); 378 return_ACPI_STATUS (AE_BAD_PARAMETER); 379 } 380 381 /* Name must consist of printable characters */ 382 383 if (!AcpiUtValidAcpiName (TargetName)) 384 { 385 ACPI_REPORT_ERROR (("NsSearchAndEnter: Bad character in ACPI Name: %X\n", 386 TargetName)); 387 return_ACPI_STATUS (AE_BAD_CHARACTER); 388 } 389 390 /* Try to find the name in the namespace level specified by the caller */ 391 392 *ReturnNode = ACPI_ENTRY_NOT_FOUND; 393 Status = AcpiNsSearchNode (TargetName, Node, Type, ReturnNode); 394 if (Status != AE_NOT_FOUND) 395 { 396 /* 397 * If we found it AND the request specifies that a find is an error, 398 * return the error 399 */ 400 if ((Status == AE_OK) && 401 (Flags & ACPI_NS_ERROR_IF_FOUND)) 402 { 403 Status = AE_ALREADY_EXISTS; 404 } 405 406 /* 407 * Either found it or there was an error 408 * -- finished either way 409 */ 410 return_ACPI_STATUS (Status); 411 } 412 413 /* 414 * The name was not found. If we are NOT performing the 415 * first pass (name entry) of loading the namespace, search 416 * the parent tree (all the way to the root if necessary.) 417 * We don't want to perform the parent search when the 418 * namespace is actually being loaded. We want to perform 419 * the search when namespace references are being resolved 420 * (load pass 2) and during the execution phase. 421 */ 422 if ((InterpreterMode != ACPI_IMODE_LOAD_PASS1) && 423 (Flags & ACPI_NS_SEARCH_PARENT)) 424 { 425 /* 426 * Not found at this level - search parent tree according 427 * to ACPI specification 428 */ 429 Status = AcpiNsSearchParentTree (TargetName, Node, 430 Type, ReturnNode); 431 if (ACPI_SUCCESS (Status)) 432 { 433 return_ACPI_STATUS (Status); 434 } 435 } 436 437 /* 438 * In execute mode, just search, never add names. Exit now. 439 */ 440 if (InterpreterMode == ACPI_IMODE_EXECUTE) 441 { 442 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, "%4.4s Not found in %p [Not adding]\n", 443 (char *) &TargetName, Node)); 444 445 return_ACPI_STATUS (AE_NOT_FOUND); 446 } 447 448 /* Create the new named object */ 449 450 NewNode = AcpiNsCreateNode (TargetName); 451 if (!NewNode) 452 { 453 return_ACPI_STATUS (AE_NO_MEMORY); 454 } 455 456 /* Install the new object into the parent's list of children */ 457 458 AcpiNsInstallNode (WalkState, Node, NewNode, Type); 459 *ReturnNode = NewNode; 460 461 return_ACPI_STATUS (AE_OK); 462} 463 464