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