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