1 /******************************************************************************* 2 * 3 * Module Name: nssearch - Namespace search 4 * $Revision: 1.123 $ 5 * 6 ******************************************************************************/ 7 8 /****************************************************************************** 9 * 10 * 1. Copyright Notice 11 * 12 * Some or all of this work - Copyright (c) 1999 - 2008, 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 /* Local prototypes */ 127 128 static ACPI_STATUS 129 AcpiNsSearchParentTree ( 130 UINT32 TargetName, 131 ACPI_NAMESPACE_NODE *Node, 132 ACPI_OBJECT_TYPE Type, 133 ACPI_NAMESPACE_NODE **ReturnNode); 134 135 136 /******************************************************************************* 137 * 138 * FUNCTION: AcpiNsSearchOneScope 139 * 140 * PARAMETERS: TargetName - Ascii ACPI name to search for 141 * ParentNode - 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 * Note: CPU execution analysis has shown that the AML interpreter spends 162 * a very small percentage of its time searching the namespace. Therefore, 163 * the linear search seems to be sufficient, as there would seem to be 164 * little value in improving the search. 165 * 166 ******************************************************************************/ 167 168 ACPI_STATUS 169 AcpiNsSearchOneScope ( 170 UINT32 TargetName, 171 ACPI_NAMESPACE_NODE *ParentNode, 172 ACPI_OBJECT_TYPE Type, 173 ACPI_NAMESPACE_NODE **ReturnNode) 174 { 175 ACPI_NAMESPACE_NODE *Node; 176 177 178 ACPI_FUNCTION_TRACE (NsSearchOneScope); 179 180 181 #ifdef ACPI_DEBUG_OUTPUT 182 if (ACPI_LV_NAMES & AcpiDbgLevel) 183 { 184 char *ScopeName; 185 186 ScopeName = AcpiNsGetExternalPathname (ParentNode); 187 if (ScopeName) 188 { 189 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, 190 "Searching %s (%p) For [%4.4s] (%s)\n", 191 ScopeName, ParentNode, ACPI_CAST_PTR (char, &TargetName), 192 AcpiUtGetTypeName (Type))); 193 194 ACPI_FREE (ScopeName); 195 } 196 } 197 #endif 198 199 /* 200 * Search for name at this namespace level, which is to say that we 201 * must search for the name among the children of this object 202 */ 203 Node = ParentNode->Child; 204 while (Node) 205 { 206 /* Check for match against the name */ 207 208 if (Node->Name.Integer == TargetName) 209 { 210 /* Resolve a control method alias if any */ 211 212 if (AcpiNsGetType (Node) == ACPI_TYPE_LOCAL_METHOD_ALIAS) 213 { 214 Node = ACPI_CAST_PTR (ACPI_NAMESPACE_NODE, Node->Object); 215 } 216 217 /* Found matching entry */ 218 219 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, 220 "Name [%4.4s] (%s) %p found in scope [%4.4s] %p\n", 221 ACPI_CAST_PTR (char, &TargetName), 222 AcpiUtGetTypeName (Node->Type), 223 Node, AcpiUtGetNodeName (ParentNode), ParentNode)); 224 225 *ReturnNode = Node; 226 return_ACPI_STATUS (AE_OK); 227 } 228 229 /* 230 * The last entry in the list points back to the parent, 231 * so a flag is used to indicate the end-of-list 232 */ 233 if (Node->Flags & ANOBJ_END_OF_PEER_LIST) 234 { 235 /* Searched entire list, we are done */ 236 237 break; 238 } 239 240 /* Didn't match name, move on to the next peer object */ 241 242 Node = Node->Peer; 243 } 244 245 /* Searched entire namespace level, not found */ 246 247 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, 248 "Name [%4.4s] (%s) not found in search in scope [%4.4s] %p first child %p\n", 249 ACPI_CAST_PTR (char, &TargetName), AcpiUtGetTypeName (Type), 250 AcpiUtGetNodeName (ParentNode), ParentNode, ParentNode->Child)); 251 252 return_ACPI_STATUS (AE_NOT_FOUND); 253 } 254 255 256 /******************************************************************************* 257 * 258 * FUNCTION: AcpiNsSearchParentTree 259 * 260 * PARAMETERS: TargetName - Ascii ACPI name to search for 261 * Node - Starting node where search will begin 262 * Type - Object type to match 263 * ReturnNode - Where the matched Node is returned 264 * 265 * RETURN: Status 266 * 267 * DESCRIPTION: Called when a name has not been found in the current namespace 268 * level. Before adding it or giving up, ACPI scope rules require 269 * searching enclosing scopes in cases identified by AcpiNsLocal(). 270 * 271 * "A name is located by finding the matching name in the current 272 * name space, and then in the parent name space. If the parent 273 * name space does not contain the name, the search continues 274 * recursively until either the name is found or the name space 275 * does not have a parent (the root of the name space). This 276 * indicates that the name is not found" (From ACPI Specification, 277 * section 5.3) 278 * 279 ******************************************************************************/ 280 281 static ACPI_STATUS 282 AcpiNsSearchParentTree ( 283 UINT32 TargetName, 284 ACPI_NAMESPACE_NODE *Node, 285 ACPI_OBJECT_TYPE Type, 286 ACPI_NAMESPACE_NODE **ReturnNode) 287 { 288 ACPI_STATUS Status; 289 ACPI_NAMESPACE_NODE *ParentNode; 290 291 292 ACPI_FUNCTION_TRACE (NsSearchParentTree); 293 294 295 ParentNode = AcpiNsGetParentNode (Node); 296 297 /* 298 * If there is no parent (i.e., we are at the root) or type is "local", 299 * we won't be searching the parent tree. 300 */ 301 if (!ParentNode) 302 { 303 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, "[%4.4s] has no parent\n", 304 ACPI_CAST_PTR (char, &TargetName))); 305 return_ACPI_STATUS (AE_NOT_FOUND); 306 } 307 308 if (AcpiNsLocal (Type)) 309 { 310 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, 311 "[%4.4s] type [%s] must be local to this scope (no parent search)\n", 312 ACPI_CAST_PTR (char, &TargetName), AcpiUtGetTypeName (Type))); 313 return_ACPI_STATUS (AE_NOT_FOUND); 314 } 315 316 /* Search the parent tree */ 317 318 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, 319 "Searching parent [%4.4s] for [%4.4s]\n", 320 AcpiUtGetNodeName (ParentNode), ACPI_CAST_PTR (char, &TargetName))); 321 322 /* 323 * Search parents until target is found or we have backed up to the root 324 */ 325 while (ParentNode) 326 { 327 /* 328 * Search parent scope. Use TYPE_ANY because we don't care about the 329 * object type at this point, we only care about the existence of 330 * the actual name we are searching for. Typechecking comes later. 331 */ 332 Status = AcpiNsSearchOneScope ( 333 TargetName, ParentNode, ACPI_TYPE_ANY, ReturnNode); 334 if (ACPI_SUCCESS (Status)) 335 { 336 return_ACPI_STATUS (Status); 337 } 338 339 /* Not found here, go up another level (until we reach the root) */ 340 341 ParentNode = AcpiNsGetParentNode (ParentNode); 342 } 343 344 /* Not found in parent tree */ 345 346 return_ACPI_STATUS (AE_NOT_FOUND); 347 } 348 349 350 /******************************************************************************* 351 * 352 * FUNCTION: AcpiNsSearchAndEnter 353 * 354 * PARAMETERS: TargetName - Ascii ACPI name to search for (4 chars) 355 * WalkState - Current state of the walk 356 * Node - Starting node where search will begin 357 * InterpreterMode - Add names only in ACPI_MODE_LOAD_PASS_x. 358 * Otherwise,search only. 359 * Type - Object type to match 360 * Flags - Flags describing the search restrictions 361 * ReturnNode - Where the Node is returned 362 * 363 * RETURN: Status 364 * 365 * DESCRIPTION: Search for a name segment in a single namespace level, 366 * optionally adding it if it is not found. If the passed 367 * Type is not Any and the type previously stored in the 368 * entry was Any (i.e. unknown), update the stored type. 369 * 370 * In ACPI_IMODE_EXECUTE, search only. 371 * In other modes, search and add if not found. 372 * 373 ******************************************************************************/ 374 375 ACPI_STATUS 376 AcpiNsSearchAndEnter ( 377 UINT32 TargetName, 378 ACPI_WALK_STATE *WalkState, 379 ACPI_NAMESPACE_NODE *Node, 380 ACPI_INTERPRETER_MODE InterpreterMode, 381 ACPI_OBJECT_TYPE Type, 382 UINT32 Flags, 383 ACPI_NAMESPACE_NODE **ReturnNode) 384 { 385 ACPI_STATUS Status; 386 ACPI_NAMESPACE_NODE *NewNode; 387 388 389 ACPI_FUNCTION_TRACE (NsSearchAndEnter); 390 391 392 /* Parameter validation */ 393 394 if (!Node || !TargetName || !ReturnNode) 395 { 396 ACPI_ERROR ((AE_INFO, 397 "Null parameter: Node %p Name %X ReturnNode %p", 398 Node, TargetName, ReturnNode)); 399 return_ACPI_STATUS (AE_BAD_PARAMETER); 400 } 401 402 /* 403 * Name must consist of valid ACPI characters. We will repair the name if 404 * necessary because we don't want to abort because of this, but we want 405 * all namespace names to be printable. A warning message is appropriate. 406 * 407 * This issue came up because there are in fact machines that exhibit 408 * this problem, and we want to be able to enable ACPI support for them, 409 * even though there are a few bad names. 410 */ 411 AcpiUtRepairName (ACPI_CAST_PTR (char, &TargetName)); 412 413 /* Try to find the name in the namespace level specified by the caller */ 414 415 *ReturnNode = ACPI_ENTRY_NOT_FOUND; 416 Status = AcpiNsSearchOneScope (TargetName, Node, Type, ReturnNode); 417 if (Status != AE_NOT_FOUND) 418 { 419 /* 420 * If we found it AND the request specifies that a find is an error, 421 * return the error 422 */ 423 if ((Status == AE_OK) && 424 (Flags & ACPI_NS_ERROR_IF_FOUND)) 425 { 426 Status = AE_ALREADY_EXISTS; 427 } 428 429 /* Either found it or there was an error: finished either way */ 430 431 return_ACPI_STATUS (Status); 432 } 433 434 /* 435 * The name was not found. If we are NOT performing the first pass 436 * (name entry) of loading the namespace, search the parent tree (all the 437 * way to the root if necessary.) We don't want to perform the parent 438 * search when the namespace is actually being loaded. We want to perform 439 * the search when namespace references are being resolved (load pass 2) 440 * and during the execution phase. 441 */ 442 if ((InterpreterMode != ACPI_IMODE_LOAD_PASS1) && 443 (Flags & ACPI_NS_SEARCH_PARENT)) 444 { 445 /* 446 * Not found at this level - search parent tree according to the 447 * ACPI specification 448 */ 449 Status = AcpiNsSearchParentTree (TargetName, Node, Type, ReturnNode); 450 if (ACPI_SUCCESS (Status)) 451 { 452 return_ACPI_STATUS (Status); 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 ACPI_CAST_PTR (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 #ifdef ACPI_ASL_COMPILER 476 /* 477 * Node is an object defined by an External() statement 478 */ 479 if (Flags & ACPI_NS_EXTERNAL) 480 { 481 NewNode->Flags |= ANOBJ_IS_EXTERNAL; 482 } 483 #endif 484 485 if (Flags & ACPI_NS_TEMPORARY) 486 { 487 NewNode->Flags |= ANOBJ_TEMPORARY; 488 } 489 490 /* Install the new object into the parent's list of children */ 491 492 AcpiNsInstallNode (WalkState, Node, NewNode, Type); 493 *ReturnNode = NewNode; 494 return_ACPI_STATUS (AE_OK); 495 } 496 497