Rev 1498 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed
Rev | Author | Line No. | Line |
---|---|---|---|
1498 | serge | 1 | /******************************************************************************* |
2 | * |
||
3 | * Module Name: nssearch - Namespace search |
||
4 | * |
||
5 | ******************************************************************************/ |
||
6 | |||
7 | /****************************************************************************** |
||
8 | * |
||
9 | * 1. Copyright Notice |
||
10 | * |
||
2216 | Serge | 11 | * Some or all of this work - Copyright (c) 1999 - 2011, Intel Corp. |
1498 | serge | 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 | #define __NSSEARCH_C__ |
||
117 | |||
118 | #include "acpi.h" |
||
119 | #include "accommon.h" |
||
120 | #include "acnamesp.h" |
||
121 | |||
122 | #ifdef ACPI_ASL_COMPILER |
||
123 | #include "amlcode.h" |
||
124 | #endif |
||
125 | |||
126 | #define _COMPONENT ACPI_NAMESPACE |
||
127 | ACPI_MODULE_NAME ("nssearch") |
||
128 | |||
129 | /* Local prototypes */ |
||
130 | |||
131 | static ACPI_STATUS |
||
132 | AcpiNsSearchParentTree ( |
||
133 | UINT32 TargetName, |
||
134 | ACPI_NAMESPACE_NODE *Node, |
||
135 | ACPI_OBJECT_TYPE Type, |
||
136 | ACPI_NAMESPACE_NODE **ReturnNode); |
||
137 | |||
138 | |||
139 | /******************************************************************************* |
||
140 | * |
||
141 | * FUNCTION: AcpiNsSearchOneScope |
||
142 | * |
||
143 | * PARAMETERS: TargetName - Ascii ACPI name to search for |
||
144 | * ParentNode - Starting node where search will begin |
||
145 | * Type - Object type to match |
||
146 | * ReturnNode - Where the matched Named obj is returned |
||
147 | * |
||
148 | * RETURN: Status |
||
149 | * |
||
150 | * DESCRIPTION: Search a single level of the namespace. Performs a |
||
151 | * simple search of the specified level, and does not add |
||
152 | * entries or search parents. |
||
153 | * |
||
154 | * |
||
155 | * Named object lists are built (and subsequently dumped) in the |
||
156 | * order in which the names are encountered during the namespace load; |
||
157 | * |
||
158 | * All namespace searching is linear in this implementation, but |
||
159 | * could be easily modified to support any improved search |
||
160 | * algorithm. However, the linear search was chosen for simplicity |
||
161 | * and because the trees are small and the other interpreter |
||
162 | * execution overhead is relatively high. |
||
163 | * |
||
164 | * Note: CPU execution analysis has shown that the AML interpreter spends |
||
165 | * a very small percentage of its time searching the namespace. Therefore, |
||
166 | * the linear search seems to be sufficient, as there would seem to be |
||
167 | * little value in improving the search. |
||
168 | * |
||
169 | ******************************************************************************/ |
||
170 | |||
171 | ACPI_STATUS |
||
172 | AcpiNsSearchOneScope ( |
||
173 | UINT32 TargetName, |
||
174 | ACPI_NAMESPACE_NODE *ParentNode, |
||
175 | ACPI_OBJECT_TYPE Type, |
||
176 | ACPI_NAMESPACE_NODE **ReturnNode) |
||
177 | { |
||
178 | ACPI_NAMESPACE_NODE *Node; |
||
179 | |||
180 | |||
181 | ACPI_FUNCTION_TRACE (NsSearchOneScope); |
||
182 | |||
183 | |||
184 | #ifdef ACPI_DEBUG_OUTPUT |
||
185 | if (ACPI_LV_NAMES & AcpiDbgLevel) |
||
186 | { |
||
187 | char *ScopeName; |
||
188 | |||
189 | ScopeName = AcpiNsGetExternalPathname (ParentNode); |
||
190 | if (ScopeName) |
||
191 | { |
||
192 | ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, |
||
193 | "Searching %s (%p) For [%4.4s] (%s)\n", |
||
194 | ScopeName, ParentNode, ACPI_CAST_PTR (char, &TargetName), |
||
195 | AcpiUtGetTypeName (Type))); |
||
196 | |||
197 | ACPI_FREE (ScopeName); |
||
198 | } |
||
199 | } |
||
200 | #endif |
||
201 | |||
202 | /* |
||
203 | * Search for name at this namespace level, which is to say that we |
||
204 | * must search for the name among the children of this object |
||
205 | */ |
||
206 | Node = ParentNode->Child; |
||
207 | while (Node) |
||
208 | { |
||
209 | /* Check for match against the name */ |
||
210 | |||
211 | if (Node->Name.Integer == TargetName) |
||
212 | { |
||
213 | /* Resolve a control method alias if any */ |
||
214 | |||
215 | if (AcpiNsGetType (Node) == ACPI_TYPE_LOCAL_METHOD_ALIAS) |
||
216 | { |
||
217 | Node = ACPI_CAST_PTR (ACPI_NAMESPACE_NODE, Node->Object); |
||
218 | } |
||
219 | |||
220 | /* Found matching entry */ |
||
221 | |||
222 | ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, |
||
223 | "Name [%4.4s] (%s) %p found in scope [%4.4s] %p\n", |
||
224 | ACPI_CAST_PTR (char, &TargetName), |
||
225 | AcpiUtGetTypeName (Node->Type), |
||
226 | Node, AcpiUtGetNodeName (ParentNode), ParentNode)); |
||
227 | |||
228 | *ReturnNode = Node; |
||
229 | return_ACPI_STATUS (AE_OK); |
||
230 | } |
||
231 | |||
232 | /* Didn't match name, move on to the next peer object */ |
||
233 | |||
234 | Node = Node->Peer; |
||
235 | } |
||
236 | |||
237 | /* Searched entire namespace level, not found */ |
||
238 | |||
239 | ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, |
||
240 | "Name [%4.4s] (%s) not found in search in scope [%4.4s] " |
||
241 | "%p first child %p\n", |
||
242 | ACPI_CAST_PTR (char, &TargetName), AcpiUtGetTypeName (Type), |
||
243 | AcpiUtGetNodeName (ParentNode), ParentNode, ParentNode->Child)); |
||
244 | |||
245 | return_ACPI_STATUS (AE_NOT_FOUND); |
||
246 | } |
||
247 | |||
248 | |||
249 | /******************************************************************************* |
||
250 | * |
||
251 | * FUNCTION: AcpiNsSearchParentTree |
||
252 | * |
||
253 | * PARAMETERS: TargetName - Ascii ACPI name to search for |
||
254 | * Node - Starting node where search will begin |
||
255 | * Type - Object type to match |
||
256 | * ReturnNode - Where the matched Node is returned |
||
257 | * |
||
258 | * RETURN: Status |
||
259 | * |
||
260 | * DESCRIPTION: Called when a name has not been found in the current namespace |
||
261 | * level. Before adding it or giving up, ACPI scope rules require |
||
262 | * searching enclosing scopes in cases identified by AcpiNsLocal(). |
||
263 | * |
||
264 | * "A name is located by finding the matching name in the current |
||
265 | * name space, and then in the parent name space. If the parent |
||
266 | * name space does not contain the name, the search continues |
||
267 | * recursively until either the name is found or the name space |
||
268 | * does not have a parent (the root of the name space). This |
||
269 | * indicates that the name is not found" (From ACPI Specification, |
||
270 | * section 5.3) |
||
271 | * |
||
272 | ******************************************************************************/ |
||
273 | |||
274 | static ACPI_STATUS |
||
275 | AcpiNsSearchParentTree ( |
||
276 | UINT32 TargetName, |
||
277 | ACPI_NAMESPACE_NODE *Node, |
||
278 | ACPI_OBJECT_TYPE Type, |
||
279 | ACPI_NAMESPACE_NODE **ReturnNode) |
||
280 | { |
||
281 | ACPI_STATUS Status; |
||
282 | ACPI_NAMESPACE_NODE *ParentNode; |
||
283 | |||
284 | |||
285 | ACPI_FUNCTION_TRACE (NsSearchParentTree); |
||
286 | |||
287 | |||
288 | ParentNode = Node->Parent; |
||
289 | |||
290 | /* |
||
291 | * If there is no parent (i.e., we are at the root) or type is "local", |
||
292 | * we won't be searching the parent tree. |
||
293 | */ |
||
294 | if (!ParentNode) |
||
295 | { |
||
296 | ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, "[%4.4s] has no parent\n", |
||
297 | ACPI_CAST_PTR (char, &TargetName))); |
||
298 | return_ACPI_STATUS (AE_NOT_FOUND); |
||
299 | } |
||
300 | |||
301 | if (AcpiNsLocal (Type)) |
||
302 | { |
||
303 | ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, |
||
304 | "[%4.4s] type [%s] must be local to this scope (no parent search)\n", |
||
305 | ACPI_CAST_PTR (char, &TargetName), AcpiUtGetTypeName (Type))); |
||
306 | return_ACPI_STATUS (AE_NOT_FOUND); |
||
307 | } |
||
308 | |||
309 | /* Search the parent tree */ |
||
310 | |||
311 | ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, |
||
312 | "Searching parent [%4.4s] for [%4.4s]\n", |
||
313 | AcpiUtGetNodeName (ParentNode), ACPI_CAST_PTR (char, &TargetName))); |
||
314 | |||
315 | /* Search parents until target is found or we have backed up to the root */ |
||
316 | |||
317 | while (ParentNode) |
||
318 | { |
||
319 | /* |
||
320 | * Search parent scope. Use TYPE_ANY because we don't care about the |
||
321 | * object type at this point, we only care about the existence of |
||
322 | * the actual name we are searching for. Typechecking comes later. |
||
323 | */ |
||
324 | Status = AcpiNsSearchOneScope ( |
||
325 | TargetName, ParentNode, ACPI_TYPE_ANY, ReturnNode); |
||
326 | if (ACPI_SUCCESS (Status)) |
||
327 | { |
||
328 | return_ACPI_STATUS (Status); |
||
329 | } |
||
330 | |||
331 | /* Not found here, go up another level (until we reach the root) */ |
||
332 | |||
333 | ParentNode = ParentNode->Parent; |
||
334 | } |
||
335 | |||
336 | /* Not found in parent tree */ |
||
337 | |||
338 | return_ACPI_STATUS (AE_NOT_FOUND); |
||
339 | } |
||
340 | |||
341 | |||
342 | /******************************************************************************* |
||
343 | * |
||
344 | * FUNCTION: AcpiNsSearchAndEnter |
||
345 | * |
||
346 | * PARAMETERS: TargetName - Ascii ACPI name to search for (4 chars) |
||
347 | * WalkState - Current state of the walk |
||
348 | * Node - Starting node where search will begin |
||
349 | * InterpreterMode - Add names only in ACPI_MODE_LOAD_PASS_x. |
||
350 | * Otherwise,search only. |
||
351 | * Type - Object type to match |
||
352 | * Flags - Flags describing the search restrictions |
||
353 | * ReturnNode - Where the Node is returned |
||
354 | * |
||
355 | * RETURN: Status |
||
356 | * |
||
357 | * DESCRIPTION: Search for a name segment in a single namespace level, |
||
358 | * optionally adding it if it is not found. If the passed |
||
359 | * Type is not Any and the type previously stored in the |
||
360 | * entry was Any (i.e. unknown), update the stored type. |
||
361 | * |
||
362 | * In ACPI_IMODE_EXECUTE, search only. |
||
363 | * In other modes, search and add if not found. |
||
364 | * |
||
365 | ******************************************************************************/ |
||
366 | |||
367 | ACPI_STATUS |
||
368 | AcpiNsSearchAndEnter ( |
||
369 | UINT32 TargetName, |
||
370 | ACPI_WALK_STATE *WalkState, |
||
371 | ACPI_NAMESPACE_NODE *Node, |
||
372 | ACPI_INTERPRETER_MODE InterpreterMode, |
||
373 | ACPI_OBJECT_TYPE Type, |
||
374 | UINT32 Flags, |
||
375 | ACPI_NAMESPACE_NODE **ReturnNode) |
||
376 | { |
||
377 | ACPI_STATUS Status; |
||
378 | ACPI_NAMESPACE_NODE *NewNode; |
||
379 | |||
380 | |||
381 | ACPI_FUNCTION_TRACE (NsSearchAndEnter); |
||
382 | |||
383 | |||
384 | /* Parameter validation */ |
||
385 | |||
386 | if (!Node || !TargetName || !ReturnNode) |
||
387 | { |
||
388 | ACPI_ERROR ((AE_INFO, |
||
389 | "Null parameter: Node %p Name 0x%X ReturnNode %p", |
||
390 | Node, TargetName, ReturnNode)); |
||
391 | return_ACPI_STATUS (AE_BAD_PARAMETER); |
||
392 | } |
||
393 | |||
394 | /* |
||
395 | * Name must consist of valid ACPI characters. We will repair the name if |
||
396 | * necessary because we don't want to abort because of this, but we want |
||
397 | * all namespace names to be printable. A warning message is appropriate. |
||
398 | * |
||
399 | * This issue came up because there are in fact machines that exhibit |
||
400 | * this problem, and we want to be able to enable ACPI support for them, |
||
401 | * even though there are a few bad names. |
||
402 | */ |
||
403 | AcpiUtRepairName (ACPI_CAST_PTR (char, &TargetName)); |
||
404 | |||
405 | /* Try to find the name in the namespace level specified by the caller */ |
||
406 | |||
407 | *ReturnNode = ACPI_ENTRY_NOT_FOUND; |
||
408 | Status = AcpiNsSearchOneScope (TargetName, Node, Type, ReturnNode); |
||
409 | if (Status != AE_NOT_FOUND) |
||
410 | { |
||
411 | /* |
||
412 | * If we found it AND the request specifies that a find is an error, |
||
413 | * return the error |
||
414 | */ |
||
415 | if ((Status == AE_OK) && |
||
416 | (Flags & ACPI_NS_ERROR_IF_FOUND)) |
||
417 | { |
||
418 | Status = AE_ALREADY_EXISTS; |
||
419 | } |
||
420 | |||
421 | #ifdef ACPI_ASL_COMPILER |
||
422 | if (*ReturnNode && (*ReturnNode)->Type == ACPI_TYPE_ANY) |
||
423 | { |
||
424 | (*ReturnNode)->Flags |= ANOBJ_IS_EXTERNAL; |
||
425 | } |
||
426 | #endif |
||
427 | |||
428 | /* Either found it or there was an error: 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 | /* In execute mode, just search, never add names. Exit now */ |
||
456 | |||
457 | if (InterpreterMode == ACPI_IMODE_EXECUTE) |
||
458 | { |
||
459 | ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, |
||
460 | "%4.4s Not found in %p [Not adding]\n", |
||
461 | ACPI_CAST_PTR (char, &TargetName), Node)); |
||
462 | |||
463 | return_ACPI_STATUS (AE_NOT_FOUND); |
||
464 | } |
||
465 | |||
466 | /* Create the new named object */ |
||
467 | |||
468 | NewNode = AcpiNsCreateNode (TargetName); |
||
469 | if (!NewNode) |
||
470 | { |
||
471 | return_ACPI_STATUS (AE_NO_MEMORY); |
||
472 | } |
||
473 | |||
474 | #ifdef ACPI_ASL_COMPILER |
||
475 | |||
476 | /* Node is an object defined by an External() statement */ |
||
477 | |||
478 | if (Flags & ACPI_NS_EXTERNAL || |
||
479 | (WalkState && WalkState->Opcode == AML_SCOPE_OP)) |
||
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 |