1 /*******************************************************************************
3 * Module Name: nssearch - Namespace search
5 ******************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2015, Intel Corp.
12 * All rights reserved.
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
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
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;
37 * The above copyright and patent license is granted only if the following
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.
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
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
72 * 3.4. Intel retains all right, title, and interest in and to the Original
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.
80 * 4. Disclaimer and Export Compliance
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
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
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.
114 *****************************************************************************/
117 #include "accommon.h"
118 #include "acnamesp.h"
120 #ifdef ACPI_ASL_COMPILER
124 #define _COMPONENT ACPI_NAMESPACE
125 ACPI_MODULE_NAME ("nssearch")
127 /* Local prototypes */
130 AcpiNsSearchParentTree (
132 ACPI_NAMESPACE_NODE
*Node
,
133 ACPI_OBJECT_TYPE Type
,
134 ACPI_NAMESPACE_NODE
**ReturnNode
);
137 /*******************************************************************************
139 * FUNCTION: AcpiNsSearchOneScope
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
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.
153 * Named object lists are built (and subsequently dumped) in the
154 * order in which the names are encountered during the namespace load;
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.
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.
167 ******************************************************************************/
170 AcpiNsSearchOneScope (
172 ACPI_NAMESPACE_NODE
*ParentNode
,
173 ACPI_OBJECT_TYPE Type
,
174 ACPI_NAMESPACE_NODE
**ReturnNode
)
176 ACPI_NAMESPACE_NODE
*Node
;
179 ACPI_FUNCTION_TRACE (NsSearchOneScope
);
182 #ifdef ACPI_DEBUG_OUTPUT
183 if (ACPI_LV_NAMES
& AcpiDbgLevel
)
187 ScopeName
= AcpiNsGetExternalPathname (ParentNode
);
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
)));
195 ACPI_FREE (ScopeName
);
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
204 Node
= ParentNode
->Child
;
207 /* Check for match against the name */
209 if (Node
->Name
.Integer
== TargetName
)
211 /* Resolve a control method alias if any */
213 if (AcpiNsGetType (Node
) == ACPI_TYPE_LOCAL_METHOD_ALIAS
)
215 Node
= ACPI_CAST_PTR (ACPI_NAMESPACE_NODE
, Node
->Object
);
218 /* Found matching entry */
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
));
227 return_ACPI_STATUS (AE_OK
);
230 /* Didn't match name, move on to the next peer object */
235 /* Searched entire namespace level, not found */
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
));
243 return_ACPI_STATUS (AE_NOT_FOUND
);
247 /*******************************************************************************
249 * FUNCTION: AcpiNsSearchParentTree
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
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().
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,
270 ******************************************************************************/
273 AcpiNsSearchParentTree (
275 ACPI_NAMESPACE_NODE
*Node
,
276 ACPI_OBJECT_TYPE Type
,
277 ACPI_NAMESPACE_NODE
**ReturnNode
)
280 ACPI_NAMESPACE_NODE
*ParentNode
;
283 ACPI_FUNCTION_TRACE (NsSearchParentTree
);
286 ParentNode
= Node
->Parent
;
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.
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
);
299 if (AcpiNsLocal (Type
))
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
);
307 /* Search the parent tree */
309 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES
,
310 "Searching parent [%4.4s] for [%4.4s]\n",
311 AcpiUtGetNodeName (ParentNode
), ACPI_CAST_PTR (char, &TargetName
)));
313 /* Search parents until target is found or we have backed up to the root */
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.
322 Status
= AcpiNsSearchOneScope (
323 TargetName
, ParentNode
, ACPI_TYPE_ANY
, ReturnNode
);
324 if (ACPI_SUCCESS (Status
))
326 return_ACPI_STATUS (Status
);
329 /* Not found here, go up another level (until we reach the root) */
331 ParentNode
= ParentNode
->Parent
;
334 /* Not found in parent tree */
336 return_ACPI_STATUS (AE_NOT_FOUND
);
340 /*******************************************************************************
342 * FUNCTION: AcpiNsSearchAndEnter
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
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.
360 * In ACPI_IMODE_EXECUTE, search only.
361 * In other modes, search and add if not found.
363 ******************************************************************************/
366 AcpiNsSearchAndEnter (
368 ACPI_WALK_STATE
*WalkState
,
369 ACPI_NAMESPACE_NODE
*Node
,
370 ACPI_INTERPRETER_MODE InterpreterMode
,
371 ACPI_OBJECT_TYPE Type
,
373 ACPI_NAMESPACE_NODE
**ReturnNode
)
376 ACPI_NAMESPACE_NODE
*NewNode
;
379 ACPI_FUNCTION_TRACE (NsSearchAndEnter
);
382 /* Parameter validation */
384 if (!Node
|| !TargetName
|| !ReturnNode
)
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
);
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.
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.
401 AcpiUtRepairName (ACPI_CAST_PTR (char, &TargetName
));
403 /* Try to find the name in the namespace level specified by the caller */
405 *ReturnNode
= ACPI_ENTRY_NOT_FOUND
;
406 Status
= AcpiNsSearchOneScope (TargetName
, Node
, Type
, ReturnNode
);
407 if (Status
!= AE_NOT_FOUND
)
410 * If we found it AND the request specifies that a find is an error,
413 if ((Status
== AE_OK
) &&
414 (Flags
& ACPI_NS_ERROR_IF_FOUND
))
416 Status
= AE_ALREADY_EXISTS
;
419 #ifdef ACPI_ASL_COMPILER
420 if (*ReturnNode
&& (*ReturnNode
)->Type
== ACPI_TYPE_ANY
)
422 (*ReturnNode
)->Flags
|= ANOBJ_IS_EXTERNAL
;
426 /* Either found it or there was an error: finished either way */
428 return_ACPI_STATUS (Status
);
432 * The name was not found. If we are NOT performing the first pass
433 * (name entry) of loading the namespace, search the parent tree (all the
434 * way to the root if necessary.) We don't want to perform the parent
435 * search when the namespace is actually being loaded. We want to perform
436 * the search when namespace references are being resolved (load pass 2)
437 * and during the execution phase.
439 if ((InterpreterMode
!= ACPI_IMODE_LOAD_PASS1
) &&
440 (Flags
& ACPI_NS_SEARCH_PARENT
))
443 * Not found at this level - search parent tree according to the
446 Status
= AcpiNsSearchParentTree (TargetName
, Node
, Type
, ReturnNode
);
447 if (ACPI_SUCCESS (Status
))
449 return_ACPI_STATUS (Status
);
453 /* In execute mode, just search, never add names. Exit now */
455 if (InterpreterMode
== ACPI_IMODE_EXECUTE
)
457 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES
,
458 "%4.4s Not found in %p [Not adding]\n",
459 ACPI_CAST_PTR (char, &TargetName
), Node
));
461 return_ACPI_STATUS (AE_NOT_FOUND
);
464 /* Create the new named object */
466 NewNode
= AcpiNsCreateNode (TargetName
);
469 return_ACPI_STATUS (AE_NO_MEMORY
);
472 #ifdef ACPI_ASL_COMPILER
474 /* Node is an object defined by an External() statement */
476 if (Flags
& ACPI_NS_EXTERNAL
||
477 (WalkState
&& WalkState
->Opcode
== AML_SCOPE_OP
))
479 NewNode
->Flags
|= ANOBJ_IS_EXTERNAL
;
483 if (Flags
& ACPI_NS_TEMPORARY
)
485 NewNode
->Flags
|= ANOBJ_TEMPORARY
;
488 /* Install the new object into the parent's list of children */
490 AcpiNsInstallNode (WalkState
, Node
, NewNode
, Type
);
491 *ReturnNode
= NewNode
;
492 return_ACPI_STATUS (AE_OK
);