Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /******************************************************************************* |
2 | * | |
3 | * Module Name: nssearch - Namespace search | |
4 | * | |
5 | ******************************************************************************/ | |
6 | ||
7 | /* | |
4a90c7e8 | 8 | * Copyright (C) 2000 - 2006, R. Byron Moore |
1da177e4 LT |
9 | * All rights reserved. |
10 | * | |
11 | * Redistribution and use in source and binary forms, with or without | |
12 | * modification, are permitted provided that the following conditions | |
13 | * are met: | |
14 | * 1. Redistributions of source code must retain the above copyright | |
15 | * notice, this list of conditions, and the following disclaimer, | |
16 | * without modification. | |
17 | * 2. Redistributions in binary form must reproduce at minimum a disclaimer | |
18 | * substantially similar to the "NO WARRANTY" disclaimer below | |
19 | * ("Disclaimer") and any redistribution must be conditioned upon | |
20 | * including a substantially similar Disclaimer requirement for further | |
21 | * binary redistribution. | |
22 | * 3. Neither the names of the above-listed copyright holders nor the names | |
23 | * of any contributors may be used to endorse or promote products derived | |
24 | * from this software without specific prior written permission. | |
25 | * | |
26 | * Alternatively, this software may be distributed under the terms of the | |
27 | * GNU General Public License ("GPL") version 2 as published by the Free | |
28 | * Software Foundation. | |
29 | * | |
30 | * NO WARRANTY | |
31 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
32 | * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | |
33 | * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR | |
34 | * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | |
35 | * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | |
36 | * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | |
37 | * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | |
38 | * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, | |
39 | * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING | |
40 | * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE | |
41 | * POSSIBILITY OF SUCH DAMAGES. | |
42 | */ | |
43 | ||
1da177e4 LT |
44 | #include <acpi/acpi.h> |
45 | #include <acpi/acnamesp.h> | |
46 | ||
1da177e4 | 47 | #define _COMPONENT ACPI_NAMESPACE |
4be44fcd | 48 | ACPI_MODULE_NAME("nssearch") |
1da177e4 | 49 | |
44f6c012 | 50 | /* Local prototypes */ |
44f6c012 | 51 | static acpi_status |
4be44fcd LB |
52 | acpi_ns_search_parent_tree(u32 target_name, |
53 | struct acpi_namespace_node *node, | |
54 | acpi_object_type type, | |
55 | struct acpi_namespace_node **return_node); | |
1da177e4 LT |
56 | |
57 | /******************************************************************************* | |
58 | * | |
59 | * FUNCTION: acpi_ns_search_node | |
60 | * | |
44f6c012 RM |
61 | * PARAMETERS: target_name - Ascii ACPI name to search for |
62 | * Node - Starting node where search will begin | |
63 | * Type - Object type to match | |
64 | * return_node - Where the matched Named obj is returned | |
1da177e4 LT |
65 | * |
66 | * RETURN: Status | |
67 | * | |
68 | * DESCRIPTION: Search a single level of the namespace. Performs a | |
69 | * simple search of the specified level, and does not add | |
70 | * entries or search parents. | |
71 | * | |
72 | * | |
73 | * Named object lists are built (and subsequently dumped) in the | |
74 | * order in which the names are encountered during the namespace load; | |
75 | * | |
76 | * All namespace searching is linear in this implementation, but | |
77 | * could be easily modified to support any improved search | |
78 | * algorithm. However, the linear search was chosen for simplicity | |
79 | * and because the trees are small and the other interpreter | |
80 | * execution overhead is relatively high. | |
81 | * | |
82 | ******************************************************************************/ | |
83 | ||
84 | acpi_status | |
4be44fcd LB |
85 | acpi_ns_search_node(u32 target_name, |
86 | struct acpi_namespace_node *node, | |
87 | acpi_object_type type, | |
88 | struct acpi_namespace_node **return_node) | |
1da177e4 | 89 | { |
4be44fcd | 90 | struct acpi_namespace_node *next_node; |
1da177e4 | 91 | |
b229cf92 | 92 | ACPI_FUNCTION_TRACE(ns_search_node); |
1da177e4 LT |
93 | |
94 | #ifdef ACPI_DEBUG_OUTPUT | |
95 | if (ACPI_LV_NAMES & acpi_dbg_level) { | |
4be44fcd | 96 | char *scope_name; |
1da177e4 | 97 | |
4be44fcd | 98 | scope_name = acpi_ns_get_external_pathname(node); |
1da177e4 | 99 | if (scope_name) { |
4be44fcd LB |
100 | ACPI_DEBUG_PRINT((ACPI_DB_NAMES, |
101 | "Searching %s (%p) For [%4.4s] (%s)\n", | |
defba1d8 BM |
102 | scope_name, node, ACPI_CAST_PTR(char, |
103 | &target_name), | |
4be44fcd | 104 | acpi_ut_get_type_name(type))); |
1da177e4 | 105 | |
8313524a | 106 | ACPI_FREE(scope_name); |
1da177e4 LT |
107 | } |
108 | } | |
109 | #endif | |
110 | ||
111 | /* | |
112 | * Search for name at this namespace level, which is to say that we | |
113 | * must search for the name among the children of this object | |
114 | */ | |
115 | next_node = node->child; | |
116 | while (next_node) { | |
52fc0b02 | 117 | |
1da177e4 LT |
118 | /* Check for match against the name */ |
119 | ||
120 | if (next_node->name.integer == target_name) { | |
52fc0b02 | 121 | |
1da177e4 LT |
122 | /* Resolve a control method alias if any */ |
123 | ||
4be44fcd LB |
124 | if (acpi_ns_get_type(next_node) == |
125 | ACPI_TYPE_LOCAL_METHOD_ALIAS) { | |
126 | next_node = | |
127 | ACPI_CAST_PTR(struct acpi_namespace_node, | |
128 | next_node->object); | |
1da177e4 LT |
129 | } |
130 | ||
793c2388 BM |
131 | /* Found matching entry */ |
132 | ||
4be44fcd LB |
133 | ACPI_DEBUG_PRINT((ACPI_DB_NAMES, |
134 | "Name [%4.4s] (%s) %p found in scope [%4.4s] %p\n", | |
defba1d8 | 135 | ACPI_CAST_PTR(char, &target_name), |
4be44fcd LB |
136 | acpi_ut_get_type_name(next_node-> |
137 | type), | |
138 | next_node, | |
139 | acpi_ut_get_node_name(node), node)); | |
1da177e4 LT |
140 | |
141 | *return_node = next_node; | |
4be44fcd | 142 | return_ACPI_STATUS(AE_OK); |
1da177e4 LT |
143 | } |
144 | ||
145 | /* | |
146 | * The last entry in the list points back to the parent, | |
147 | * so a flag is used to indicate the end-of-list | |
148 | */ | |
149 | if (next_node->flags & ANOBJ_END_OF_PEER_LIST) { | |
52fc0b02 | 150 | |
1da177e4 LT |
151 | /* Searched entire list, we are done */ |
152 | ||
153 | break; | |
154 | } | |
155 | ||
156 | /* Didn't match name, move on to the next peer object */ | |
157 | ||
158 | next_node = next_node->peer; | |
159 | } | |
160 | ||
161 | /* Searched entire namespace level, not found */ | |
162 | ||
4be44fcd LB |
163 | ACPI_DEBUG_PRINT((ACPI_DB_NAMES, |
164 | "Name [%4.4s] (%s) not found in search in scope [%4.4s] %p first child %p\n", | |
defba1d8 BM |
165 | ACPI_CAST_PTR(char, &target_name), |
166 | acpi_ut_get_type_name(type), | |
4be44fcd | 167 | acpi_ut_get_node_name(node), node, node->child)); |
1da177e4 | 168 | |
4be44fcd | 169 | return_ACPI_STATUS(AE_NOT_FOUND); |
1da177e4 LT |
170 | } |
171 | ||
1da177e4 LT |
172 | /******************************************************************************* |
173 | * | |
174 | * FUNCTION: acpi_ns_search_parent_tree | |
175 | * | |
44f6c012 RM |
176 | * PARAMETERS: target_name - Ascii ACPI name to search for |
177 | * Node - Starting node where search will begin | |
178 | * Type - Object type to match | |
179 | * return_node - Where the matched Node is returned | |
1da177e4 LT |
180 | * |
181 | * RETURN: Status | |
182 | * | |
183 | * DESCRIPTION: Called when a name has not been found in the current namespace | |
184 | * level. Before adding it or giving up, ACPI scope rules require | |
185 | * searching enclosing scopes in cases identified by acpi_ns_local(). | |
186 | * | |
187 | * "A name is located by finding the matching name in the current | |
188 | * name space, and then in the parent name space. If the parent | |
189 | * name space does not contain the name, the search continues | |
190 | * recursively until either the name is found or the name space | |
191 | * does not have a parent (the root of the name space). This | |
192 | * indicates that the name is not found" (From ACPI Specification, | |
193 | * section 5.3) | |
194 | * | |
195 | ******************************************************************************/ | |
196 | ||
197 | static acpi_status | |
4be44fcd LB |
198 | acpi_ns_search_parent_tree(u32 target_name, |
199 | struct acpi_namespace_node *node, | |
200 | acpi_object_type type, | |
201 | struct acpi_namespace_node **return_node) | |
1da177e4 | 202 | { |
4be44fcd LB |
203 | acpi_status status; |
204 | struct acpi_namespace_node *parent_node; | |
1da177e4 | 205 | |
b229cf92 | 206 | ACPI_FUNCTION_TRACE(ns_search_parent_tree); |
1da177e4 | 207 | |
4be44fcd | 208 | parent_node = acpi_ns_get_parent_node(node); |
1da177e4 LT |
209 | |
210 | /* | |
211 | * If there is no parent (i.e., we are at the root) or type is "local", | |
212 | * we won't be searching the parent tree. | |
213 | */ | |
214 | if (!parent_node) { | |
4be44fcd | 215 | ACPI_DEBUG_PRINT((ACPI_DB_NAMES, "[%4.4s] has no parent\n", |
defba1d8 | 216 | ACPI_CAST_PTR(char, &target_name))); |
4be44fcd | 217 | return_ACPI_STATUS(AE_NOT_FOUND); |
1da177e4 LT |
218 | } |
219 | ||
4be44fcd LB |
220 | if (acpi_ns_local(type)) { |
221 | ACPI_DEBUG_PRINT((ACPI_DB_NAMES, | |
222 | "[%4.4s] type [%s] must be local to this scope (no parent search)\n", | |
defba1d8 | 223 | ACPI_CAST_PTR(char, &target_name), |
4be44fcd LB |
224 | acpi_ut_get_type_name(type))); |
225 | return_ACPI_STATUS(AE_NOT_FOUND); | |
1da177e4 LT |
226 | } |
227 | ||
228 | /* Search the parent tree */ | |
229 | ||
4be44fcd LB |
230 | ACPI_DEBUG_PRINT((ACPI_DB_NAMES, |
231 | "Searching parent [%4.4s] for [%4.4s]\n", | |
232 | acpi_ut_get_node_name(parent_node), | |
defba1d8 | 233 | ACPI_CAST_PTR(char, &target_name))); |
1da177e4 LT |
234 | |
235 | /* | |
236 | * Search parents until target is found or we have backed up to the root | |
237 | */ | |
238 | while (parent_node) { | |
239 | /* | |
240 | * Search parent scope. Use TYPE_ANY because we don't care about the | |
241 | * object type at this point, we only care about the existence of | |
242 | * the actual name we are searching for. Typechecking comes later. | |
243 | */ | |
4be44fcd LB |
244 | status = acpi_ns_search_node(target_name, parent_node, |
245 | ACPI_TYPE_ANY, return_node); | |
246 | if (ACPI_SUCCESS(status)) { | |
247 | return_ACPI_STATUS(status); | |
1da177e4 LT |
248 | } |
249 | ||
793c2388 BM |
250 | /* Not found here, go up another level (until we reach the root) */ |
251 | ||
4be44fcd | 252 | parent_node = acpi_ns_get_parent_node(parent_node); |
1da177e4 LT |
253 | } |
254 | ||
255 | /* Not found in parent tree */ | |
256 | ||
4be44fcd | 257 | return_ACPI_STATUS(AE_NOT_FOUND); |
1da177e4 LT |
258 | } |
259 | ||
1da177e4 LT |
260 | /******************************************************************************* |
261 | * | |
262 | * FUNCTION: acpi_ns_search_and_enter | |
263 | * | |
264 | * PARAMETERS: target_name - Ascii ACPI name to search for (4 chars) | |
265 | * walk_state - Current state of the walk | |
44f6c012 | 266 | * Node - Starting node where search will begin |
1da177e4 LT |
267 | * interpreter_mode - Add names only in ACPI_MODE_LOAD_PASS_x. |
268 | * Otherwise,search only. | |
269 | * Type - Object type to match | |
270 | * Flags - Flags describing the search restrictions | |
44f6c012 | 271 | * return_node - Where the Node is returned |
1da177e4 LT |
272 | * |
273 | * RETURN: Status | |
274 | * | |
275 | * DESCRIPTION: Search for a name segment in a single namespace level, | |
276 | * optionally adding it if it is not found. If the passed | |
277 | * Type is not Any and the type previously stored in the | |
278 | * entry was Any (i.e. unknown), update the stored type. | |
279 | * | |
280 | * In ACPI_IMODE_EXECUTE, search only. | |
281 | * In other modes, search and add if not found. | |
282 | * | |
283 | ******************************************************************************/ | |
284 | ||
285 | acpi_status | |
4be44fcd LB |
286 | acpi_ns_search_and_enter(u32 target_name, |
287 | struct acpi_walk_state *walk_state, | |
288 | struct acpi_namespace_node *node, | |
289 | acpi_interpreter_mode interpreter_mode, | |
290 | acpi_object_type type, | |
291 | u32 flags, struct acpi_namespace_node **return_node) | |
1da177e4 | 292 | { |
4be44fcd LB |
293 | acpi_status status; |
294 | struct acpi_namespace_node *new_node; | |
1da177e4 | 295 | |
b229cf92 | 296 | ACPI_FUNCTION_TRACE(ns_search_and_enter); |
1da177e4 LT |
297 | |
298 | /* Parameter validation */ | |
299 | ||
300 | if (!node || !target_name || !return_node) { | |
b8e4d893 | 301 | ACPI_ERROR((AE_INFO, |
b229cf92 | 302 | "Null param: Node %p Name %X ReturnNode %p", |
b8e4d893 | 303 | node, target_name, return_node)); |
4be44fcd | 304 | return_ACPI_STATUS(AE_BAD_PARAMETER); |
1da177e4 LT |
305 | } |
306 | ||
793c2388 BM |
307 | /* |
308 | * Name must consist of valid ACPI characters. We will repair the name if | |
309 | * necessary because we don't want to abort because of this, but we want | |
310 | * all namespace names to be printable. A warning message is appropriate. | |
311 | * | |
312 | * This issue came up because there are in fact machines that exhibit | |
313 | * this problem, and we want to be able to enable ACPI support for them, | |
314 | * even though there are a few bad names. | |
315 | */ | |
4be44fcd | 316 | if (!acpi_ut_valid_acpi_name(target_name)) { |
793c2388 BM |
317 | target_name = acpi_ut_repair_name(target_name); |
318 | ||
319 | /* Report warning only if in strict mode or debug mode */ | |
320 | ||
321 | if (!acpi_gbl_enable_interpreter_slack) { | |
322 | ACPI_WARNING((AE_INFO, | |
323 | "Found bad character(s) in name, repaired: [%4.4s]\n", | |
324 | ACPI_CAST_PTR(char, &target_name))); | |
325 | } else { | |
326 | ACPI_DEBUG_PRINT((ACPI_DB_WARN, | |
327 | "Found bad character(s) in name, repaired: [%4.4s]\n", | |
328 | ACPI_CAST_PTR(char, &target_name))); | |
329 | } | |
1da177e4 LT |
330 | } |
331 | ||
332 | /* Try to find the name in the namespace level specified by the caller */ | |
333 | ||
334 | *return_node = ACPI_ENTRY_NOT_FOUND; | |
4be44fcd | 335 | status = acpi_ns_search_node(target_name, node, type, return_node); |
1da177e4 LT |
336 | if (status != AE_NOT_FOUND) { |
337 | /* | |
338 | * If we found it AND the request specifies that a find is an error, | |
339 | * return the error | |
340 | */ | |
4be44fcd | 341 | if ((status == AE_OK) && (flags & ACPI_NS_ERROR_IF_FOUND)) { |
1da177e4 LT |
342 | status = AE_ALREADY_EXISTS; |
343 | } | |
344 | ||
793c2388 BM |
345 | /* Either found it or there was an error: finished either way */ |
346 | ||
4be44fcd | 347 | return_ACPI_STATUS(status); |
1da177e4 LT |
348 | } |
349 | ||
350 | /* | |
351 | * The name was not found. If we are NOT performing the first pass | |
352 | * (name entry) of loading the namespace, search the parent tree (all the | |
353 | * way to the root if necessary.) We don't want to perform the parent | |
354 | * search when the namespace is actually being loaded. We want to perform | |
355 | * the search when namespace references are being resolved (load pass 2) | |
356 | * and during the execution phase. | |
357 | */ | |
358 | if ((interpreter_mode != ACPI_IMODE_LOAD_PASS1) && | |
4be44fcd | 359 | (flags & ACPI_NS_SEARCH_PARENT)) { |
1da177e4 LT |
360 | /* |
361 | * Not found at this level - search parent tree according to the | |
362 | * ACPI specification | |
363 | */ | |
4be44fcd LB |
364 | status = |
365 | acpi_ns_search_parent_tree(target_name, node, type, | |
366 | return_node); | |
367 | if (ACPI_SUCCESS(status)) { | |
368 | return_ACPI_STATUS(status); | |
1da177e4 LT |
369 | } |
370 | } | |
371 | ||
793c2388 BM |
372 | /* In execute mode, just search, never add names. Exit now */ |
373 | ||
1da177e4 | 374 | if (interpreter_mode == ACPI_IMODE_EXECUTE) { |
4be44fcd LB |
375 | ACPI_DEBUG_PRINT((ACPI_DB_NAMES, |
376 | "%4.4s Not found in %p [Not adding]\n", | |
defba1d8 | 377 | ACPI_CAST_PTR(char, &target_name), node)); |
1da177e4 | 378 | |
4be44fcd | 379 | return_ACPI_STATUS(AE_NOT_FOUND); |
1da177e4 LT |
380 | } |
381 | ||
382 | /* Create the new named object */ | |
383 | ||
4be44fcd | 384 | new_node = acpi_ns_create_node(target_name); |
1da177e4 | 385 | if (!new_node) { |
4be44fcd | 386 | return_ACPI_STATUS(AE_NO_MEMORY); |
1da177e4 LT |
387 | } |
388 | ||
389 | /* Install the new object into the parent's list of children */ | |
390 | ||
4be44fcd | 391 | acpi_ns_install_node(walk_state, node, new_node, type); |
1da177e4 | 392 | *return_node = new_node; |
4be44fcd | 393 | return_ACPI_STATUS(AE_OK); |
1da177e4 | 394 | } |