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