1 /******************************************************************************* 2 * 3 * Module Name: nssearch - Namespace search 4 * 5 ******************************************************************************/ 6 7 /****************************************************************************** 8 * 9 * 1. Copyright Notice 10 * 11 * Some or all of this work - Copyright (c) 1999 - 2016, Intel Corp. 12 * All rights reserved. 13 * 14 * 2. License 15 * 16 * 2.1. This is your license from Intel Corp. under its intellectual property 17 * rights. You may have additional license terms from the party that provided 18 * you this software, covering your right to use that party's intellectual 19 * property rights. 20 * 21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 22 * copy of the source code appearing in this file ("Covered Code") an 23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the 24 * base code distributed originally by Intel ("Original Intel Code") to copy, 25 * make derivatives, distribute, use and display any portion of the Covered 26 * Code in any form, with the right to sublicense such rights; and 27 * 28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 29 * license (with the right to sublicense), under only those claims of Intel 30 * patents that are infringed by the Original Intel Code, to make, use, sell, 31 * offer to sell, and import the Covered Code and derivative works thereof 32 * solely to the minimum extent necessary to exercise the above copyright 33 * license, and in no event shall the patent license extend to any additions 34 * to or modifications of the Original Intel Code. No other license or right 35 * is granted directly or by implication, estoppel or otherwise; 36 * 37 * The above copyright and patent license is granted only if the following 38 * conditions are met: 39 * 40 * 3. Conditions 41 * 42 * 3.1. Redistribution of Source with Rights to Further Distribute Source. 43 * Redistribution of source code of any substantial portion of the Covered 44 * Code or modification with rights to further distribute source must include 45 * the above Copyright Notice, the above License, this list of Conditions, 46 * and the following Disclaimer and Export Compliance provision. In addition, 47 * Licensee must cause all Covered Code to which Licensee contributes to 48 * contain a file documenting the changes Licensee made to create that Covered 49 * Code and the date of any change. Licensee must include in that file the 50 * documentation of any changes made by any predecessor Licensee. Licensee 51 * must include a prominent statement that the modification is derived, 52 * directly or indirectly, from Original Intel Code. 53 * 54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 55 * Redistribution of source code of any substantial portion of the Covered 56 * Code or modification without rights to further distribute source must 57 * include the following Disclaimer and Export Compliance provision in the 58 * documentation and/or other materials provided with distribution. In 59 * addition, Licensee may not authorize further sublicense of source of any 60 * portion of the Covered Code, and must include terms to the effect that the 61 * license from Licensee to its licensee is limited to the intellectual 62 * property embodied in the software Licensee provides to its licensee, and 63 * not to intellectual property embodied in modifications its licensee may 64 * make. 65 * 66 * 3.3. Redistribution of Executable. Redistribution in executable form of any 67 * substantial portion of the Covered Code or modification must reproduce the 68 * above Copyright Notice, and the following Disclaimer and Export Compliance 69 * provision in the documentation and/or other materials provided with the 70 * distribution. 71 * 72 * 3.4. Intel retains all right, title, and interest in and to the Original 73 * Intel Code. 74 * 75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by 76 * Intel shall be used in advertising or otherwise to promote the sale, use or 77 * other dealings in products derived from or relating to the Covered Code 78 * without prior written authorization from Intel. 79 * 80 * 4. Disclaimer and Export Compliance 81 * 82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 88 * PARTICULAR PURPOSE. 89 * 90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 97 * LIMITED REMEDY. 98 * 99 * 4.3. Licensee shall not export, either directly or indirectly, any of this 100 * software or system incorporating such software without first obtaining any 101 * required license or other approval from the U. S. Department of Commerce or 102 * any other agency or department of the United States Government. In the 103 * event Licensee exports any such software from the United States or 104 * re-exports any such software from a foreign destination, Licensee shall 105 * ensure that the distribution and export/re-export of the software is in 106 * compliance with all laws, regulations, orders, or other restrictions of the 107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor 108 * any of its subsidiaries will export/re-export any technical data, process, 109 * software, or service, directly or indirectly, to any country for which the 110 * United States government or any agency thereof requires an export license, 111 * other governmental approval, or letter of assurance, without first obtaining 112 * such license, approval or letter. 113 * 114 *****************************************************************************/ 115 116 #include "acpi.h" 117 #include "accommon.h" 118 #include "acnamesp.h" 119 120 #ifdef ACPI_ASL_COMPILER 121 #include "amlcode.h" 122 #endif 123 124 #define _COMPONENT ACPI_NAMESPACE 125 ACPI_MODULE_NAME ("nssearch") 126 127 /* Local prototypes */ 128 129 static ACPI_STATUS 130 AcpiNsSearchParentTree ( 131 UINT32 TargetName, 132 ACPI_NAMESPACE_NODE *Node, 133 ACPI_OBJECT_TYPE Type, 134 ACPI_NAMESPACE_NODE **ReturnNode); 135 136 137 /******************************************************************************* 138 * 139 * FUNCTION: AcpiNsSearchOneScope 140 * 141 * PARAMETERS: TargetName - Ascii ACPI name to search for 142 * ParentNode - Starting node where search will begin 143 * Type - Object type to match 144 * ReturnNode - Where the matched Named obj is returned 145 * 146 * RETURN: Status 147 * 148 * DESCRIPTION: Search a single level of the namespace. Performs a 149 * simple search of the specified level, and does not add 150 * entries or search parents. 151 * 152 * 153 * Named object lists are built (and subsequently dumped) in the 154 * order in which the names are encountered during the namespace load; 155 * 156 * All namespace searching is linear in this implementation, but 157 * could be easily modified to support any improved search 158 * algorithm. However, the linear search was chosen for simplicity 159 * and because the trees are small and the other interpreter 160 * execution overhead is relatively high. 161 * 162 * Note: CPU execution analysis has shown that the AML interpreter spends 163 * a very small percentage of its time searching the namespace. Therefore, 164 * the linear search seems to be sufficient, as there would seem to be 165 * little value in improving the search. 166 * 167 ******************************************************************************/ 168 169 ACPI_STATUS 170 AcpiNsSearchOneScope ( 171 UINT32 TargetName, 172 ACPI_NAMESPACE_NODE *ParentNode, 173 ACPI_OBJECT_TYPE Type, 174 ACPI_NAMESPACE_NODE **ReturnNode) 175 { 176 ACPI_NAMESPACE_NODE *Node; 177 178 179 ACPI_FUNCTION_TRACE (NsSearchOneScope); 180 181 182 #ifdef ACPI_DEBUG_OUTPUT 183 if (ACPI_LV_NAMES & AcpiDbgLevel) 184 { 185 char *ScopeName; 186 187 ScopeName = AcpiNsGetNormalizedPathname (ParentNode, TRUE); 188 if (ScopeName) 189 { 190 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, 191 "Searching %s (%p) For [%4.4s] (%s)\n", 192 ScopeName, ParentNode, ACPI_CAST_PTR (char, &TargetName), 193 AcpiUtGetTypeName (Type))); 194 195 ACPI_FREE (ScopeName); 196 } 197 } 198 #endif 199 200 /* 201 * Search for name at this namespace level, which is to say that we 202 * must search for the name among the children of this object 203 */ 204 Node = ParentNode->Child; 205 while (Node) 206 { 207 /* Check for match against the name */ 208 209 if (Node->Name.Integer == TargetName) 210 { 211 /* Resolve a control method alias if any */ 212 213 if (AcpiNsGetType (Node) == ACPI_TYPE_LOCAL_METHOD_ALIAS) 214 { 215 Node = ACPI_CAST_PTR (ACPI_NAMESPACE_NODE, Node->Object); 216 } 217 218 /* Found matching entry */ 219 220 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, 221 "Name [%4.4s] (%s) %p found in scope [%4.4s] %p\n", 222 ACPI_CAST_PTR (char, &TargetName), 223 AcpiUtGetTypeName (Node->Type), 224 Node, AcpiUtGetNodeName (ParentNode), ParentNode)); 225 226 *ReturnNode = Node; 227 return_ACPI_STATUS (AE_OK); 228 } 229 230 /* Didn't match name, move on to the next peer object */ 231 232 Node = Node->Peer; 233 } 234 235 /* Searched entire namespace level, not found */ 236 237 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, 238 "Name [%4.4s] (%s) not found in search in scope [%4.4s] " 239 "%p first child %p\n", 240 ACPI_CAST_PTR (char, &TargetName), AcpiUtGetTypeName (Type), 241 AcpiUtGetNodeName (ParentNode), ParentNode, ParentNode->Child)); 242 243 return_ACPI_STATUS (AE_NOT_FOUND); 244 } 245 246 247 /******************************************************************************* 248 * 249 * FUNCTION: AcpiNsSearchParentTree 250 * 251 * PARAMETERS: TargetName - Ascii ACPI name to search for 252 * Node - Starting node where search will begin 253 * Type - Object type to match 254 * ReturnNode - Where the matched Node is returned 255 * 256 * RETURN: Status 257 * 258 * DESCRIPTION: Called when a name has not been found in the current namespace 259 * level. Before adding it or giving up, ACPI scope rules require 260 * searching enclosing scopes in cases identified by AcpiNsLocal(). 261 * 262 * "A name is located by finding the matching name in the current 263 * name space, and then in the parent name space. If the parent 264 * name space does not contain the name, the search continues 265 * recursively until either the name is found or the name space 266 * does not have a parent (the root of the name space). This 267 * indicates that the name is not found" (From ACPI Specification, 268 * section 5.3) 269 * 270 ******************************************************************************/ 271 272 static ACPI_STATUS 273 AcpiNsSearchParentTree ( 274 UINT32 TargetName, 275 ACPI_NAMESPACE_NODE *Node, 276 ACPI_OBJECT_TYPE Type, 277 ACPI_NAMESPACE_NODE **ReturnNode) 278 { 279 ACPI_STATUS Status; 280 ACPI_NAMESPACE_NODE *ParentNode; 281 282 283 ACPI_FUNCTION_TRACE (NsSearchParentTree); 284 285 286 ParentNode = Node->Parent; 287 288 /* 289 * If there is no parent (i.e., we are at the root) or type is "local", 290 * we won't be searching the parent tree. 291 */ 292 if (!ParentNode) 293 { 294 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, "[%4.4s] has no parent\n", 295 ACPI_CAST_PTR (char, &TargetName))); 296 return_ACPI_STATUS (AE_NOT_FOUND); 297 } 298 299 if (AcpiNsLocal (Type)) 300 { 301 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, 302 "[%4.4s] type [%s] must be local to this scope (no parent search)\n", 303 ACPI_CAST_PTR (char, &TargetName), AcpiUtGetTypeName (Type))); 304 return_ACPI_STATUS (AE_NOT_FOUND); 305 } 306 307 /* Search the parent tree */ 308 309 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, 310 "Searching parent [%4.4s] for [%4.4s]\n", 311 AcpiUtGetNodeName (ParentNode), ACPI_CAST_PTR (char, &TargetName))); 312 313 /* Search parents until target is found or we have backed up to the root */ 314 315 while (ParentNode) 316 { 317 /* 318 * Search parent scope. Use TYPE_ANY because we don't care about the 319 * object type at this point, we only care about the existence of 320 * the actual name we are searching for. Typechecking comes later. 321 */ 322 Status = AcpiNsSearchOneScope ( 323 TargetName, ParentNode, ACPI_TYPE_ANY, ReturnNode); 324 if (ACPI_SUCCESS (Status)) 325 { 326 return_ACPI_STATUS (Status); 327 } 328 329 /* Not found here, go up another level (until we reach the root) */ 330 331 ParentNode = ParentNode->Parent; 332 } 333 334 /* Not found in parent tree */ 335 336 return_ACPI_STATUS (AE_NOT_FOUND); 337 } 338 339 340 /******************************************************************************* 341 * 342 * FUNCTION: AcpiNsSearchAndEnter 343 * 344 * PARAMETERS: TargetName - Ascii ACPI name to search for (4 chars) 345 * WalkState - Current state of the walk 346 * Node - Starting node where search will begin 347 * InterpreterMode - Add names only in ACPI_MODE_LOAD_PASS_x. 348 * Otherwise,search only. 349 * Type - Object type to match 350 * Flags - Flags describing the search restrictions 351 * ReturnNode - Where the Node is returned 352 * 353 * RETURN: Status 354 * 355 * DESCRIPTION: Search for a name segment in a single namespace level, 356 * optionally adding it if it is not found. If the passed 357 * Type is not Any and the type previously stored in the 358 * entry was Any (i.e. unknown), update the stored type. 359 * 360 * In ACPI_IMODE_EXECUTE, search only. 361 * In other modes, search and add if not found. 362 * 363 ******************************************************************************/ 364 365 ACPI_STATUS 366 AcpiNsSearchAndEnter ( 367 UINT32 TargetName, 368 ACPI_WALK_STATE *WalkState, 369 ACPI_NAMESPACE_NODE *Node, 370 ACPI_INTERPRETER_MODE InterpreterMode, 371 ACPI_OBJECT_TYPE Type, 372 UINT32 Flags, 373 ACPI_NAMESPACE_NODE **ReturnNode) 374 { 375 ACPI_STATUS Status; 376 ACPI_NAMESPACE_NODE *NewNode; 377 378 379 ACPI_FUNCTION_TRACE (NsSearchAndEnter); 380 381 382 /* Parameter validation */ 383 384 if (!Node || !TargetName || !ReturnNode) 385 { 386 ACPI_ERROR ((AE_INFO, 387 "Null parameter: Node %p Name 0x%X ReturnNode %p", 388 Node, TargetName, ReturnNode)); 389 return_ACPI_STATUS (AE_BAD_PARAMETER); 390 } 391 392 /* 393 * Name must consist of valid ACPI characters. We will repair the name if 394 * necessary because we don't want to abort because of this, but we want 395 * all namespace names to be printable. A warning message is appropriate. 396 * 397 * This issue came up because there are in fact machines that exhibit 398 * this problem, and we want to be able to enable ACPI support for them, 399 * even though there are a few bad names. 400 */ 401 AcpiUtRepairName (ACPI_CAST_PTR (char, &TargetName)); 402 403 /* Try to find the name in the namespace level specified by the caller */ 404 405 *ReturnNode = ACPI_ENTRY_NOT_FOUND; 406 Status = AcpiNsSearchOneScope (TargetName, Node, Type, ReturnNode); 407 if (Status != AE_NOT_FOUND) 408 { 409 /* 410 * If we found it AND the request specifies that a find is an error, 411 * return the error 412 */ 413 if (Status == AE_OK) 414 { 415 /* The node was found in the namespace */ 416 417 /* 418 * If the namespace override feature is enabled for this node, 419 * delete any existing attached sub-object and make the node 420 * look like a new node that is owned by the override table. 421 */ 422 if (Flags & ACPI_NS_OVERRIDE_IF_FOUND) 423 { 424 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, 425 "Namespace override: %4.4s pass %u type %X Owner %X\n", 426 ACPI_CAST_PTR(char, &TargetName), InterpreterMode, 427 (*ReturnNode)->Type, WalkState->OwnerId)); 428 429 AcpiNsDeleteChildren (*ReturnNode); 430 if (AcpiGbl_RuntimeNamespaceOverride) 431 { 432 AcpiUtRemoveReference ((*ReturnNode)->Object); 433 (*ReturnNode)->Object = NULL; 434 (*ReturnNode)->OwnerId = WalkState->OwnerId; 435 } 436 else 437 { 438 AcpiNsRemoveNode (*ReturnNode); 439 *ReturnNode = ACPI_ENTRY_NOT_FOUND; 440 } 441 } 442 443 /* Return an error if we don't expect to find the object */ 444 445 else if (Flags & ACPI_NS_ERROR_IF_FOUND) 446 { 447 Status = AE_ALREADY_EXISTS; 448 } 449 } 450 451 #ifdef ACPI_ASL_COMPILER 452 if (*ReturnNode && (*ReturnNode)->Type == ACPI_TYPE_ANY) 453 { 454 (*ReturnNode)->Flags |= ANOBJ_IS_EXTERNAL; 455 } 456 #endif 457 458 /* Either found it or there was an error: finished either way */ 459 460 return_ACPI_STATUS (Status); 461 } 462 463 /* 464 * The name was not found. If we are NOT performing the first pass 465 * (name entry) of loading the namespace, search the parent tree (all the 466 * way to the root if necessary.) We don't want to perform the parent 467 * search when the namespace is actually being loaded. We want to perform 468 * the search when namespace references are being resolved (load pass 2) 469 * and during the execution phase. 470 */ 471 if ((InterpreterMode != ACPI_IMODE_LOAD_PASS1) && 472 (Flags & ACPI_NS_SEARCH_PARENT)) 473 { 474 /* 475 * Not found at this level - search parent tree according to the 476 * ACPI specification 477 */ 478 Status = AcpiNsSearchParentTree (TargetName, Node, Type, ReturnNode); 479 if (ACPI_SUCCESS (Status)) 480 { 481 return_ACPI_STATUS (Status); 482 } 483 } 484 485 /* In execute mode, just search, never add names. Exit now */ 486 487 if (InterpreterMode == ACPI_IMODE_EXECUTE) 488 { 489 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, 490 "%4.4s Not found in %p [Not adding]\n", 491 ACPI_CAST_PTR (char, &TargetName), Node)); 492 493 return_ACPI_STATUS (AE_NOT_FOUND); 494 } 495 496 /* Create the new named object */ 497 498 NewNode = AcpiNsCreateNode (TargetName); 499 if (!NewNode) 500 { 501 return_ACPI_STATUS (AE_NO_MEMORY); 502 } 503 504 #ifdef ACPI_ASL_COMPILER 505 506 /* Node is an object defined by an External() statement */ 507 508 if (Flags & ACPI_NS_EXTERNAL || 509 (WalkState && WalkState->Opcode == AML_SCOPE_OP)) 510 { 511 NewNode->Flags |= ANOBJ_IS_EXTERNAL; 512 } 513 #endif 514 515 if (Flags & ACPI_NS_TEMPORARY) 516 { 517 NewNode->Flags |= ANOBJ_TEMPORARY; 518 } 519 520 /* Install the new object into the parent's list of children */ 521 522 AcpiNsInstallNode (WalkState, Node, NewNode, Type); 523 *ReturnNode = NewNode; 524 return_ACPI_STATUS (AE_OK); 525 } 526