1/*******************************************************************************
2 *
3 * Module Name: nssearch - Namespace search
4 * $Revision: 84 $
5 *
6 ******************************************************************************/
7
8/******************************************************************************
9 *
10 * 1. Copyright Notice
11 *
12 * Some or all of this work - Copyright (c) 1999 - 2002, 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 "amlcode.h"
121#include "acinterp.h"
122#include "acnamesp.h"
123
124
125#define _COMPONENT ACPI_NAMESPACE
126 ACPI_MODULE_NAME ("nssearch")
127
128
129/*******************************************************************************
130 *
131 * FUNCTION: AcpiNsSearchNode
132 *
133 * PARAMETERS: *TargetName - Ascii ACPI name to search for
134 * *Node - Starting table where search will begin
135 * Type - Object type to match
136 * **ReturnNode - Where the matched Named obj is returned
137 *
138 * RETURN: Status
139 *
140 * DESCRIPTION: Search a single namespace table. Performs a simple search,
141 * does not add entries or search parents.
142 *
143 *
144 * Named object lists are built (and subsequently dumped) in the
145 * order in which the names are encountered during the namespace load;
146 *
147 * All namespace searching is linear in this implementation, but
148 * could be easily modified to support any improved search
149 * algorithm. However, the linear search was chosen for simplicity
150 * and because the trees are small and the other interpreter
151 * execution overhead is relatively high.
152 *
153 ******************************************************************************/
154
155ACPI_STATUS
156AcpiNsSearchNode (
157 UINT32 TargetName,
158 ACPI_NAMESPACE_NODE *Node,
159 ACPI_OBJECT_TYPE Type,
160 ACPI_NAMESPACE_NODE **ReturnNode)
161{
162 ACPI_NAMESPACE_NODE *NextNode;
163
164
165 ACPI_FUNCTION_TRACE ("NsSearchNode");
166
167
168#ifdef ACPI_DEBUG
169 if (ACPI_LV_NAMES & AcpiDbgLevel)
170 {
171 NATIVE_CHAR *ScopeName;
172
173 ScopeName = AcpiNsGetExternalPathname (Node);
174 if (ScopeName)
175 {
176 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, "Searching %s [%p] For %4.4s (type %s)\n",
177 ScopeName, Node, (char *) &TargetName, AcpiUtGetTypeName (Type)));
178
179 ACPI_MEM_FREE (ScopeName);
180 }
181 }
182#endif
183
184 /*
185 * Search for name in this table, which is to say that we must search
186 * for the name among the children of this object
187 */
188 NextNode = Node->Child;
189 while (NextNode)
190 {
191 /* Check for match against the name */
192
193 if (NextNode->Name.Integer == TargetName)
194 {
195 /*
196 * Found matching entry. Capture the type if appropriate, before
197 * returning the entry.
198 *
199 * The DefFieldDefn and BankFieldDefn cases are actually looking up
200 * the Region in which the field will be defined
201 */
202 if ((INTERNAL_TYPE_FIELD_DEFN == Type) ||
203 (INTERNAL_TYPE_BANK_FIELD_DEFN == Type))
204 {
205 Type = ACPI_TYPE_REGION;
206 }
207
208 /*
209 * Scope, DefAny, and IndexFieldDefn are bogus "types" which do not
210 * actually have anything to do with the type of the name being
211 * looked up. For any other value of Type, if the type stored in
212 * the entry is Any (i.e. unknown), save the actual type.
213 */
214 if (Type != INTERNAL_TYPE_SCOPE &&
215 Type != INTERNAL_TYPE_DEF_ANY &&
216 Type != INTERNAL_TYPE_INDEX_FIELD_DEFN &&
217 NextNode->Type == ACPI_TYPE_ANY)
218 {
219 NextNode->Type = (UINT8) Type;
220 }
221
222 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES,
223 "Name %4.4s Type [%s] found at %p\n",
224 (char *) &TargetName, AcpiUtGetTypeName (NextNode->Type), NextNode));
225
226 *ReturnNode = NextNode;
227 return_ACPI_STATUS (AE_OK);
228 }
229
230 /*
231 * The last entry in the list points back to the parent,
232 * so a flag is used to indicate the end-of-list
233 */
234 if (NextNode->Flags & ANOBJ_END_OF_PEER_LIST)
235 {
236 /* Searched entire list, we are done */
237
238 break;
239 }
240
241 /* Didn't match name, move on to the next peer object */
242
243 NextNode = NextNode->Peer;
244 }
245
246 /* Searched entire table, not found */
247
248 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, "Name %4.4s Type [%s] not found at %p\n",
249 (char *) &TargetName, AcpiUtGetTypeName (Type), NextNode));
250
251 return_ACPI_STATUS (AE_NOT_FOUND);
252}
253
254
255/*******************************************************************************
256 *
257 * FUNCTION: AcpiNsSearchParentTree
258 *
259 * PARAMETERS: *TargetName - Ascii ACPI name to search for
260 * *Node - Starting table where search will begin
261 * Type - Object type to match
262 * **ReturnNode - Where the matched Named Obj is returned
263 *
264 * RETURN: Status
265 *
266 * DESCRIPTION: Called when a name has not been found in the current namespace
267 * table. Before adding it or giving up, ACPI scope rules require
268 * searching enclosing scopes in cases identified by AcpiNsLocal().
269 *
270 * "A name is located by finding the matching name in the current
271 * name space, and then in the parent name space. If the parent
272 * name space does not contain the name, the search continues
273 * recursively until either the name is found or the name space
274 * does not have a parent (the root of the name space). This
275 * indicates that the name is not found" (From ACPI Specification,
276 * section 5.3)
277 *
278 ******************************************************************************/
279
280static ACPI_STATUS
281AcpiNsSearchParentTree (
282 UINT32 TargetName,
283 ACPI_NAMESPACE_NODE *Node,
284 ACPI_OBJECT_TYPE Type,
285 ACPI_NAMESPACE_NODE **ReturnNode)
286{
287 ACPI_STATUS Status;
288 ACPI_NAMESPACE_NODE *ParentNode;
289
290
291 ACPI_FUNCTION_TRACE ("NsSearchParentTree");
292
293
294 ParentNode = AcpiNsGetParentNode (Node);
295
296 /*
297 * If there is no parent (at the root) or type is "local", we won't be
298 * searching the parent tree.
299 */
300 if ((AcpiNsLocal (Type)) ||
301 (!ParentNode))
302 {
303 if (!ParentNode)
304 {
305 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, "[%4.4s] has no parent\n",
306 (char *) &TargetName));
307 }
308
309 if (AcpiNsLocal (Type))
310 {
311 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, "[%4.4s] type [%s] must be local to this scope (no parent search)\n",
312 (char *) &TargetName, AcpiUtGetTypeName (Type)));
313 }
314
315 return_ACPI_STATUS (AE_NOT_FOUND);
316 }
317
318 /* Search the parent tree */
319
320 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, "Searching parent for %4.4s\n", (char *) &TargetName));
321
322 /*
323 * Search parents until found the target or we have backed up to
324 * the root
325 */
326 while (ParentNode)
327 {
328 /*
329 * Search parent scope. Use TYPE_ANY because we don't care about the
330 * object type at this point, we only care about the existence of
331 * the actual name we are searching for. Typechecking comes later.
332 */
333 Status = AcpiNsSearchNode (TargetName, ParentNode,
334 ACPI_TYPE_ANY, ReturnNode);
335 if (ACPI_SUCCESS (Status))
336 {
337 return_ACPI_STATUS (Status);
338 }
339
340 /*
341 * Not found here, go up another level
342 * (until we reach the root)
343 */
344 ParentNode = AcpiNsGetParentNode (ParentNode);
345 }
346
347 /* Not found in parent tree */
348
349 return_ACPI_STATUS (AE_NOT_FOUND);
350}
351
352
353/*******************************************************************************
354 *
355 * FUNCTION: AcpiNsSearchAndEnter
356 *
357 * PARAMETERS: TargetName - Ascii ACPI name to search for (4 chars)
358 * WalkState - Current state of the walk
359 * *Node - Starting table where search will begin
360 * InterpreterMode - Add names only in MODE_LoadPassX.
361 * Otherwise,search only.
362 * Type - Object type to match
363 * Flags - Flags describing the search restrictions
364 * **ReturnNode - Where the Node is returned
365 *
366 * RETURN: Status
367 *
368 * DESCRIPTION: Search for a name segment in a single name table,
369 * optionally adding it if it is not found. If the passed
370 * Type is not Any and the type previously stored in the
371 * entry was Any (i.e. unknown), update the stored type.
372 *
373 * In IMODE_EXECUTE, search only.
374 * In other modes, search and add if not found.
375 *
376 ******************************************************************************/
377
378ACPI_STATUS
379AcpiNsSearchAndEnter (
380 UINT32 TargetName,
381 ACPI_WALK_STATE *WalkState,
382 ACPI_NAMESPACE_NODE *Node,
383 ACPI_INTERPRETER_MODE InterpreterMode,
384 ACPI_OBJECT_TYPE Type,
385 UINT32 Flags,
386 ACPI_NAMESPACE_NODE **ReturnNode)
387{
388 ACPI_STATUS Status;
389 ACPI_NAMESPACE_NODE *NewNode;
390
391
392 ACPI_FUNCTION_TRACE ("NsSearchAndEnter");
393
394
395 /* Parameter validation */
396
397 if (!Node || !TargetName || !ReturnNode)
398 {
399 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Null param- Table %p Name %X Return %p\n",
400 Node, TargetName, ReturnNode));
401
402 ACPI_REPORT_ERROR (("NsSearchAndEnter: bad (null) parameter\n"));
403 return_ACPI_STATUS (AE_BAD_PARAMETER);
404 }
405
406 /* Name must consist of printable characters */
407
408 if (!AcpiUtValidAcpiName (TargetName))
409 {
410 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "*** Bad character in name: %08x *** \n",
411 TargetName));
412
413 ACPI_REPORT_ERROR (("NsSearchAndEnter: Bad character in ACPI Name\n"));
414 return_ACPI_STATUS (AE_BAD_CHARACTER);
415 }
416
417 /* Try to find the name in the table specified by the caller */
418
419 *ReturnNode = ACPI_ENTRY_NOT_FOUND;
420 Status = AcpiNsSearchNode (TargetName, Node, Type, ReturnNode);
421 if (Status != AE_NOT_FOUND)
422 {
423 /*
424 * If we found it AND the request specifies that a find is an error,
425 * return the error
426 */
427 if ((Status == AE_OK) &&
428 (Flags & ACPI_NS_ERROR_IF_FOUND))
429 {
430 Status = AE_ALREADY_EXISTS;
431 }
432
433 /*
434 * Either found it or there was an error
435 * -- finished either way
436 */
437 return_ACPI_STATUS (Status);
438 }
439
440 /*
441 * The name was not found. If we are NOT performing the
442 * first pass (name entry) of loading the namespace, search
443 * the parent tree (all the way to the root if necessary.)
444 * We don't want to perform the parent search when the
445 * namespace is actually being loaded. We want to perform
446 * the search when namespace references are being resolved
447 * (load pass 2) and during the execution phase.
448 */
449 if ((InterpreterMode != ACPI_IMODE_LOAD_PASS1) &&
450 (Flags & ACPI_NS_SEARCH_PARENT))
451 {
452 /*
453 * Not found in table - search parent tree according
454 * to ACPI specification
455 */
456 Status = AcpiNsSearchParentTree (TargetName, Node,
457 Type, ReturnNode);
458 if (ACPI_SUCCESS (Status))
459 {
460 return_ACPI_STATUS (Status);
461 }
462 }
463
464 /*
465 * In execute mode, just search, never add names. Exit now.
466 */
467 if (InterpreterMode == ACPI_IMODE_EXECUTE)
468 {
469 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, "%4.4s Not found in %p [Not adding]\n",
470 (char *) &TargetName, Node));
471
472 return_ACPI_STATUS (AE_NOT_FOUND);
473 }
474
475 /* Create the new named object */
476
477 NewNode = AcpiNsCreateNode (TargetName);
478 if (!NewNode)
479 {
480 return_ACPI_STATUS (AE_NO_MEMORY);
481 }
482
483 /* Install the new object into the parent's list of children */
484
485 AcpiNsInstallNode (WalkState, Node, NewNode, Type);
486 *ReturnNode = NewNode;
487
488 return_ACPI_STATUS (AE_OK);
489}
490
2 *
3 * Module Name: nssearch - Namespace search
4 * $Revision: 84 $
5 *
6 ******************************************************************************/
7
8/******************************************************************************
9 *
10 * 1. Copyright Notice
11 *
12 * Some or all of this work - Copyright (c) 1999 - 2002, 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 "amlcode.h"
121#include "acinterp.h"
122#include "acnamesp.h"
123
124
125#define _COMPONENT ACPI_NAMESPACE
126 ACPI_MODULE_NAME ("nssearch")
127
128
129/*******************************************************************************
130 *
131 * FUNCTION: AcpiNsSearchNode
132 *
133 * PARAMETERS: *TargetName - Ascii ACPI name to search for
134 * *Node - Starting table where search will begin
135 * Type - Object type to match
136 * **ReturnNode - Where the matched Named obj is returned
137 *
138 * RETURN: Status
139 *
140 * DESCRIPTION: Search a single namespace table. Performs a simple search,
141 * does not add entries or search parents.
142 *
143 *
144 * Named object lists are built (and subsequently dumped) in the
145 * order in which the names are encountered during the namespace load;
146 *
147 * All namespace searching is linear in this implementation, but
148 * could be easily modified to support any improved search
149 * algorithm. However, the linear search was chosen for simplicity
150 * and because the trees are small and the other interpreter
151 * execution overhead is relatively high.
152 *
153 ******************************************************************************/
154
155ACPI_STATUS
156AcpiNsSearchNode (
157 UINT32 TargetName,
158 ACPI_NAMESPACE_NODE *Node,
159 ACPI_OBJECT_TYPE Type,
160 ACPI_NAMESPACE_NODE **ReturnNode)
161{
162 ACPI_NAMESPACE_NODE *NextNode;
163
164
165 ACPI_FUNCTION_TRACE ("NsSearchNode");
166
167
168#ifdef ACPI_DEBUG
169 if (ACPI_LV_NAMES & AcpiDbgLevel)
170 {
171 NATIVE_CHAR *ScopeName;
172
173 ScopeName = AcpiNsGetExternalPathname (Node);
174 if (ScopeName)
175 {
176 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, "Searching %s [%p] For %4.4s (type %s)\n",
177 ScopeName, Node, (char *) &TargetName, AcpiUtGetTypeName (Type)));
178
179 ACPI_MEM_FREE (ScopeName);
180 }
181 }
182#endif
183
184 /*
185 * Search for name in this table, which is to say that we must search
186 * for the name among the children of this object
187 */
188 NextNode = Node->Child;
189 while (NextNode)
190 {
191 /* Check for match against the name */
192
193 if (NextNode->Name.Integer == TargetName)
194 {
195 /*
196 * Found matching entry. Capture the type if appropriate, before
197 * returning the entry.
198 *
199 * The DefFieldDefn and BankFieldDefn cases are actually looking up
200 * the Region in which the field will be defined
201 */
202 if ((INTERNAL_TYPE_FIELD_DEFN == Type) ||
203 (INTERNAL_TYPE_BANK_FIELD_DEFN == Type))
204 {
205 Type = ACPI_TYPE_REGION;
206 }
207
208 /*
209 * Scope, DefAny, and IndexFieldDefn are bogus "types" which do not
210 * actually have anything to do with the type of the name being
211 * looked up. For any other value of Type, if the type stored in
212 * the entry is Any (i.e. unknown), save the actual type.
213 */
214 if (Type != INTERNAL_TYPE_SCOPE &&
215 Type != INTERNAL_TYPE_DEF_ANY &&
216 Type != INTERNAL_TYPE_INDEX_FIELD_DEFN &&
217 NextNode->Type == ACPI_TYPE_ANY)
218 {
219 NextNode->Type = (UINT8) Type;
220 }
221
222 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES,
223 "Name %4.4s Type [%s] found at %p\n",
224 (char *) &TargetName, AcpiUtGetTypeName (NextNode->Type), NextNode));
225
226 *ReturnNode = NextNode;
227 return_ACPI_STATUS (AE_OK);
228 }
229
230 /*
231 * The last entry in the list points back to the parent,
232 * so a flag is used to indicate the end-of-list
233 */
234 if (NextNode->Flags & ANOBJ_END_OF_PEER_LIST)
235 {
236 /* Searched entire list, we are done */
237
238 break;
239 }
240
241 /* Didn't match name, move on to the next peer object */
242
243 NextNode = NextNode->Peer;
244 }
245
246 /* Searched entire table, not found */
247
248 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, "Name %4.4s Type [%s] not found at %p\n",
249 (char *) &TargetName, AcpiUtGetTypeName (Type), NextNode));
250
251 return_ACPI_STATUS (AE_NOT_FOUND);
252}
253
254
255/*******************************************************************************
256 *
257 * FUNCTION: AcpiNsSearchParentTree
258 *
259 * PARAMETERS: *TargetName - Ascii ACPI name to search for
260 * *Node - Starting table where search will begin
261 * Type - Object type to match
262 * **ReturnNode - Where the matched Named Obj is returned
263 *
264 * RETURN: Status
265 *
266 * DESCRIPTION: Called when a name has not been found in the current namespace
267 * table. Before adding it or giving up, ACPI scope rules require
268 * searching enclosing scopes in cases identified by AcpiNsLocal().
269 *
270 * "A name is located by finding the matching name in the current
271 * name space, and then in the parent name space. If the parent
272 * name space does not contain the name, the search continues
273 * recursively until either the name is found or the name space
274 * does not have a parent (the root of the name space). This
275 * indicates that the name is not found" (From ACPI Specification,
276 * section 5.3)
277 *
278 ******************************************************************************/
279
280static ACPI_STATUS
281AcpiNsSearchParentTree (
282 UINT32 TargetName,
283 ACPI_NAMESPACE_NODE *Node,
284 ACPI_OBJECT_TYPE Type,
285 ACPI_NAMESPACE_NODE **ReturnNode)
286{
287 ACPI_STATUS Status;
288 ACPI_NAMESPACE_NODE *ParentNode;
289
290
291 ACPI_FUNCTION_TRACE ("NsSearchParentTree");
292
293
294 ParentNode = AcpiNsGetParentNode (Node);
295
296 /*
297 * If there is no parent (at the root) or type is "local", we won't be
298 * searching the parent tree.
299 */
300 if ((AcpiNsLocal (Type)) ||
301 (!ParentNode))
302 {
303 if (!ParentNode)
304 {
305 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, "[%4.4s] has no parent\n",
306 (char *) &TargetName));
307 }
308
309 if (AcpiNsLocal (Type))
310 {
311 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, "[%4.4s] type [%s] must be local to this scope (no parent search)\n",
312 (char *) &TargetName, AcpiUtGetTypeName (Type)));
313 }
314
315 return_ACPI_STATUS (AE_NOT_FOUND);
316 }
317
318 /* Search the parent tree */
319
320 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, "Searching parent for %4.4s\n", (char *) &TargetName));
321
322 /*
323 * Search parents until found the target or we have backed up to
324 * the root
325 */
326 while (ParentNode)
327 {
328 /*
329 * Search parent scope. Use TYPE_ANY because we don't care about the
330 * object type at this point, we only care about the existence of
331 * the actual name we are searching for. Typechecking comes later.
332 */
333 Status = AcpiNsSearchNode (TargetName, ParentNode,
334 ACPI_TYPE_ANY, ReturnNode);
335 if (ACPI_SUCCESS (Status))
336 {
337 return_ACPI_STATUS (Status);
338 }
339
340 /*
341 * Not found here, go up another level
342 * (until we reach the root)
343 */
344 ParentNode = AcpiNsGetParentNode (ParentNode);
345 }
346
347 /* Not found in parent tree */
348
349 return_ACPI_STATUS (AE_NOT_FOUND);
350}
351
352
353/*******************************************************************************
354 *
355 * FUNCTION: AcpiNsSearchAndEnter
356 *
357 * PARAMETERS: TargetName - Ascii ACPI name to search for (4 chars)
358 * WalkState - Current state of the walk
359 * *Node - Starting table where search will begin
360 * InterpreterMode - Add names only in MODE_LoadPassX.
361 * Otherwise,search only.
362 * Type - Object type to match
363 * Flags - Flags describing the search restrictions
364 * **ReturnNode - Where the Node is returned
365 *
366 * RETURN: Status
367 *
368 * DESCRIPTION: Search for a name segment in a single name table,
369 * optionally adding it if it is not found. If the passed
370 * Type is not Any and the type previously stored in the
371 * entry was Any (i.e. unknown), update the stored type.
372 *
373 * In IMODE_EXECUTE, search only.
374 * In other modes, search and add if not found.
375 *
376 ******************************************************************************/
377
378ACPI_STATUS
379AcpiNsSearchAndEnter (
380 UINT32 TargetName,
381 ACPI_WALK_STATE *WalkState,
382 ACPI_NAMESPACE_NODE *Node,
383 ACPI_INTERPRETER_MODE InterpreterMode,
384 ACPI_OBJECT_TYPE Type,
385 UINT32 Flags,
386 ACPI_NAMESPACE_NODE **ReturnNode)
387{
388 ACPI_STATUS Status;
389 ACPI_NAMESPACE_NODE *NewNode;
390
391
392 ACPI_FUNCTION_TRACE ("NsSearchAndEnter");
393
394
395 /* Parameter validation */
396
397 if (!Node || !TargetName || !ReturnNode)
398 {
399 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Null param- Table %p Name %X Return %p\n",
400 Node, TargetName, ReturnNode));
401
402 ACPI_REPORT_ERROR (("NsSearchAndEnter: bad (null) parameter\n"));
403 return_ACPI_STATUS (AE_BAD_PARAMETER);
404 }
405
406 /* Name must consist of printable characters */
407
408 if (!AcpiUtValidAcpiName (TargetName))
409 {
410 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "*** Bad character in name: %08x *** \n",
411 TargetName));
412
413 ACPI_REPORT_ERROR (("NsSearchAndEnter: Bad character in ACPI Name\n"));
414 return_ACPI_STATUS (AE_BAD_CHARACTER);
415 }
416
417 /* Try to find the name in the table specified by the caller */
418
419 *ReturnNode = ACPI_ENTRY_NOT_FOUND;
420 Status = AcpiNsSearchNode (TargetName, Node, Type, ReturnNode);
421 if (Status != AE_NOT_FOUND)
422 {
423 /*
424 * If we found it AND the request specifies that a find is an error,
425 * return the error
426 */
427 if ((Status == AE_OK) &&
428 (Flags & ACPI_NS_ERROR_IF_FOUND))
429 {
430 Status = AE_ALREADY_EXISTS;
431 }
432
433 /*
434 * Either found it or there was an error
435 * -- finished either way
436 */
437 return_ACPI_STATUS (Status);
438 }
439
440 /*
441 * The name was not found. If we are NOT performing the
442 * first pass (name entry) of loading the namespace, search
443 * the parent tree (all the way to the root if necessary.)
444 * We don't want to perform the parent search when the
445 * namespace is actually being loaded. We want to perform
446 * the search when namespace references are being resolved
447 * (load pass 2) and during the execution phase.
448 */
449 if ((InterpreterMode != ACPI_IMODE_LOAD_PASS1) &&
450 (Flags & ACPI_NS_SEARCH_PARENT))
451 {
452 /*
453 * Not found in table - search parent tree according
454 * to ACPI specification
455 */
456 Status = AcpiNsSearchParentTree (TargetName, Node,
457 Type, ReturnNode);
458 if (ACPI_SUCCESS (Status))
459 {
460 return_ACPI_STATUS (Status);
461 }
462 }
463
464 /*
465 * In execute mode, just search, never add names. Exit now.
466 */
467 if (InterpreterMode == ACPI_IMODE_EXECUTE)
468 {
469 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, "%4.4s Not found in %p [Not adding]\n",
470 (char *) &TargetName, Node));
471
472 return_ACPI_STATUS (AE_NOT_FOUND);
473 }
474
475 /* Create the new named object */
476
477 NewNode = AcpiNsCreateNode (TargetName);
478 if (!NewNode)
479 {
480 return_ACPI_STATUS (AE_NO_MEMORY);
481 }
482
483 /* Install the new object into the parent's list of children */
484
485 AcpiNsInstallNode (WalkState, Node, NewNode, Type);
486 *ReturnNode = NewNode;
487
488 return_ACPI_STATUS (AE_OK);
489}
490