Merge branch 'upstream' of git://git.linux-mips.org/pub/scm/upstream-linus
[linux-btrfs-devel.git] / drivers / acpi / acpica / nsalloc.c
blob1d0ef15d158ff72779f32c814238130f13954425
1 /*******************************************************************************
3 * Module Name: nsalloc - Namespace allocation and deletion utilities
5 ******************************************************************************/
7 /*
8 * Copyright (C) 2000 - 2011, Intel Corp.
9 * All rights reserved.
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.
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.
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.
44 #include <acpi/acpi.h>
45 #include "accommon.h"
46 #include "acnamesp.h"
48 #define _COMPONENT ACPI_NAMESPACE
49 ACPI_MODULE_NAME("nsalloc")
51 /*******************************************************************************
53 * FUNCTION: acpi_ns_create_node
55 * PARAMETERS: Name - Name of the new node (4 char ACPI name)
57 * RETURN: New namespace node (Null on failure)
59 * DESCRIPTION: Create a namespace node
61 ******************************************************************************/
62 struct acpi_namespace_node *acpi_ns_create_node(u32 name)
64 struct acpi_namespace_node *node;
65 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
66 u32 temp;
67 #endif
69 ACPI_FUNCTION_TRACE(ns_create_node);
71 node = acpi_os_acquire_object(acpi_gbl_namespace_cache);
72 if (!node) {
73 return_PTR(NULL);
76 ACPI_MEM_TRACKING(acpi_gbl_ns_node_list->total_allocated++);
78 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
79 temp = acpi_gbl_ns_node_list->total_allocated -
80 acpi_gbl_ns_node_list->total_freed;
81 if (temp > acpi_gbl_ns_node_list->max_occupied) {
82 acpi_gbl_ns_node_list->max_occupied = temp;
84 #endif
86 node->name.integer = name;
87 ACPI_SET_DESCRIPTOR_TYPE(node, ACPI_DESC_TYPE_NAMED);
88 return_PTR(node);
91 /*******************************************************************************
93 * FUNCTION: acpi_ns_delete_node
95 * PARAMETERS: Node - Node to be deleted
97 * RETURN: None
99 * DESCRIPTION: Delete a namespace node. All node deletions must come through
100 * here. Detaches any attached objects, including any attached
101 * data. If a handler is associated with attached data, it is
102 * invoked before the node is deleted.
104 ******************************************************************************/
106 void acpi_ns_delete_node(struct acpi_namespace_node *node)
108 union acpi_operand_object *obj_desc;
110 ACPI_FUNCTION_NAME(ns_delete_node);
112 /* Detach an object if there is one */
114 acpi_ns_detach_object(node);
117 * Delete an attached data object if present (an object that was created
118 * and attached via acpi_attach_data). Note: After any normal object is
119 * detached above, the only possible remaining object is a data object.
121 obj_desc = node->object;
122 if (obj_desc && (obj_desc->common.type == ACPI_TYPE_LOCAL_DATA)) {
124 /* Invoke the attached data deletion handler if present */
126 if (obj_desc->data.handler) {
127 obj_desc->data.handler(node, obj_desc->data.pointer);
130 acpi_ut_remove_reference(obj_desc);
133 /* Now we can delete the node */
135 (void)acpi_os_release_object(acpi_gbl_namespace_cache, node);
137 ACPI_MEM_TRACKING(acpi_gbl_ns_node_list->total_freed++);
138 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS, "Node %p, Remaining %X\n",
139 node, acpi_gbl_current_node_count));
142 /*******************************************************************************
144 * FUNCTION: acpi_ns_remove_node
146 * PARAMETERS: Node - Node to be removed/deleted
148 * RETURN: None
150 * DESCRIPTION: Remove (unlink) and delete a namespace node
152 ******************************************************************************/
154 void acpi_ns_remove_node(struct acpi_namespace_node *node)
156 struct acpi_namespace_node *parent_node;
157 struct acpi_namespace_node *prev_node;
158 struct acpi_namespace_node *next_node;
160 ACPI_FUNCTION_TRACE_PTR(ns_remove_node, node);
162 parent_node = node->parent;
164 prev_node = NULL;
165 next_node = parent_node->child;
167 /* Find the node that is the previous peer in the parent's child list */
169 while (next_node != node) {
170 prev_node = next_node;
171 next_node = next_node->peer;
174 if (prev_node) {
176 /* Node is not first child, unlink it */
178 prev_node->peer = node->peer;
179 } else {
181 * Node is first child (has no previous peer).
182 * Link peer list to parent
184 parent_node->child = node->peer;
187 /* Delete the node and any attached objects */
189 acpi_ns_delete_node(node);
190 return_VOID;
193 /*******************************************************************************
195 * FUNCTION: acpi_ns_install_node
197 * PARAMETERS: walk_state - Current state of the walk
198 * parent_node - The parent of the new Node
199 * Node - The new Node to install
200 * Type - ACPI object type of the new Node
202 * RETURN: None
204 * DESCRIPTION: Initialize a new namespace node and install it amongst
205 * its peers.
207 * Note: Current namespace lookup is linear search. This appears
208 * to be sufficient as namespace searches consume only a small
209 * fraction of the execution time of the ACPI subsystem.
211 ******************************************************************************/
213 void acpi_ns_install_node(struct acpi_walk_state *walk_state, struct acpi_namespace_node *parent_node, /* Parent */
214 struct acpi_namespace_node *node, /* New Child */
215 acpi_object_type type)
217 acpi_owner_id owner_id = 0;
218 struct acpi_namespace_node *child_node;
220 ACPI_FUNCTION_TRACE(ns_install_node);
222 if (walk_state) {
224 * Get the owner ID from the Walk state. The owner ID is used to
225 * track table deletion and deletion of objects created by methods.
227 owner_id = walk_state->owner_id;
229 if ((walk_state->method_desc) &&
230 (parent_node != walk_state->method_node)) {
232 * A method is creating a new node that is not a child of the
233 * method (it is non-local). Mark the executing method as having
234 * modified the namespace. This is used for cleanup when the
235 * method exits.
237 walk_state->method_desc->method.info_flags |=
238 ACPI_METHOD_MODIFIED_NAMESPACE;
242 /* Link the new entry into the parent and existing children */
244 node->peer = NULL;
245 node->parent = parent_node;
246 child_node = parent_node->child;
248 if (!child_node) {
249 parent_node->child = node;
250 } else {
251 /* Add node to the end of the peer list */
253 while (child_node->peer) {
254 child_node = child_node->peer;
257 child_node->peer = node;
260 /* Init the new entry */
262 node->owner_id = owner_id;
263 node->type = (u8) type;
265 ACPI_DEBUG_PRINT((ACPI_DB_NAMES,
266 "%4.4s (%s) [Node %p Owner %X] added to %4.4s (%s) [Node %p]\n",
267 acpi_ut_get_node_name(node),
268 acpi_ut_get_type_name(node->type), node, owner_id,
269 acpi_ut_get_node_name(parent_node),
270 acpi_ut_get_type_name(parent_node->type),
271 parent_node));
273 return_VOID;
276 /*******************************************************************************
278 * FUNCTION: acpi_ns_delete_children
280 * PARAMETERS: parent_node - Delete this objects children
282 * RETURN: None.
284 * DESCRIPTION: Delete all children of the parent object. In other words,
285 * deletes a "scope".
287 ******************************************************************************/
289 void acpi_ns_delete_children(struct acpi_namespace_node *parent_node)
291 struct acpi_namespace_node *next_node;
292 struct acpi_namespace_node *node_to_delete;
294 ACPI_FUNCTION_TRACE_PTR(ns_delete_children, parent_node);
296 if (!parent_node) {
297 return_VOID;
300 /* Deallocate all children at this level */
302 next_node = parent_node->child;
303 while (next_node) {
305 /* Grandchildren should have all been deleted already */
307 if (next_node->child) {
308 ACPI_ERROR((AE_INFO, "Found a grandchild! P=%p C=%p",
309 parent_node, next_node));
313 * Delete this child node and move on to the next child in the list.
314 * No need to unlink the node since we are deleting the entire branch.
316 node_to_delete = next_node;
317 next_node = next_node->peer;
318 acpi_ns_delete_node(node_to_delete);
321 /* Clear the parent's child pointer */
323 parent_node->child = NULL;
324 return_VOID;
327 /*******************************************************************************
329 * FUNCTION: acpi_ns_delete_namespace_subtree
331 * PARAMETERS: parent_node - Root of the subtree to be deleted
333 * RETURN: None.
335 * DESCRIPTION: Delete a subtree of the namespace. This includes all objects
336 * stored within the subtree.
338 ******************************************************************************/
340 void acpi_ns_delete_namespace_subtree(struct acpi_namespace_node *parent_node)
342 struct acpi_namespace_node *child_node = NULL;
343 u32 level = 1;
344 acpi_status status;
346 ACPI_FUNCTION_TRACE(ns_delete_namespace_subtree);
348 if (!parent_node) {
349 return_VOID;
352 /* Lock namespace for possible update */
354 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
355 if (ACPI_FAILURE(status)) {
356 return_VOID;
360 * Traverse the tree of objects until we bubble back up
361 * to where we started.
363 while (level > 0) {
365 /* Get the next node in this scope (NULL if none) */
367 child_node = acpi_ns_get_next_node(parent_node, child_node);
368 if (child_node) {
370 /* Found a child node - detach any attached object */
372 acpi_ns_detach_object(child_node);
374 /* Check if this node has any children */
376 if (child_node->child) {
378 * There is at least one child of this node,
379 * visit the node
381 level++;
382 parent_node = child_node;
383 child_node = NULL;
385 } else {
387 * No more children of this parent node.
388 * Move up to the grandparent.
390 level--;
393 * Now delete all of the children of this parent
394 * all at the same time.
396 acpi_ns_delete_children(parent_node);
398 /* New "last child" is this parent node */
400 child_node = parent_node;
402 /* Move up the tree to the grandparent */
404 parent_node = parent_node->parent;
408 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
409 return_VOID;
412 /*******************************************************************************
414 * FUNCTION: acpi_ns_delete_namespace_by_owner
416 * PARAMETERS: owner_id - All nodes with this owner will be deleted
418 * RETURN: Status
420 * DESCRIPTION: Delete entries within the namespace that are owned by a
421 * specific ID. Used to delete entire ACPI tables. All
422 * reference counts are updated.
424 * MUTEX: Locks namespace during deletion walk.
426 ******************************************************************************/
428 void acpi_ns_delete_namespace_by_owner(acpi_owner_id owner_id)
430 struct acpi_namespace_node *child_node;
431 struct acpi_namespace_node *deletion_node;
432 struct acpi_namespace_node *parent_node;
433 u32 level;
434 acpi_status status;
436 ACPI_FUNCTION_TRACE_U32(ns_delete_namespace_by_owner, owner_id);
438 if (owner_id == 0) {
439 return_VOID;
442 /* Lock namespace for possible update */
444 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
445 if (ACPI_FAILURE(status)) {
446 return_VOID;
449 deletion_node = NULL;
450 parent_node = acpi_gbl_root_node;
451 child_node = NULL;
452 level = 1;
455 * Traverse the tree of nodes until we bubble back up
456 * to where we started.
458 while (level > 0) {
460 * Get the next child of this parent node. When child_node is NULL,
461 * the first child of the parent is returned
463 child_node = acpi_ns_get_next_node(parent_node, child_node);
465 if (deletion_node) {
466 acpi_ns_delete_children(deletion_node);
467 acpi_ns_remove_node(deletion_node);
468 deletion_node = NULL;
471 if (child_node) {
472 if (child_node->owner_id == owner_id) {
474 /* Found a matching child node - detach any attached object */
476 acpi_ns_detach_object(child_node);
479 /* Check if this node has any children */
481 if (child_node->child) {
483 * There is at least one child of this node,
484 * visit the node
486 level++;
487 parent_node = child_node;
488 child_node = NULL;
489 } else if (child_node->owner_id == owner_id) {
490 deletion_node = child_node;
492 } else {
494 * No more children of this parent node.
495 * Move up to the grandparent.
497 level--;
498 if (level != 0) {
499 if (parent_node->owner_id == owner_id) {
500 deletion_node = parent_node;
504 /* New "last child" is this parent node */
506 child_node = parent_node;
508 /* Move up the tree to the grandparent */
510 parent_node = parent_node->parent;
514 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
515 return_VOID;