1 /*******************************************************************************
3 * Module Name: nsalloc - Namespace allocation and deletion utilities
6 ******************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2004, Intel Corp.
13 * All rights reserved.
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
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
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;
38 * The above copyright and patent license is granted only if the following
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.
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
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
73 * 3.4. Intel retains all right, title, and interest in and to the Original
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.
81 * 4. Disclaimer and Export Compliance
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
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
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.
115 *****************************************************************************/
118 #define __NSALLOC_C__
121 #include "acnamesp.h"
124 #define _COMPONENT ACPI_NAMESPACE
125 ACPI_MODULE_NAME ("nsalloc")
128 /*******************************************************************************
130 * FUNCTION: AcpiNsCreateNode
132 * PARAMETERS: AcpiName - Name of the new node
136 * DESCRIPTION: Create a namespace node
138 ******************************************************************************/
140 ACPI_NAMESPACE_NODE *
144 ACPI_NAMESPACE_NODE *Node;
147 ACPI_FUNCTION_TRACE ("NsCreateNode");
150 Node = ACPI_MEM_CALLOCATE (sizeof (ACPI_NAMESPACE_NODE));
156 ACPI_MEM_TRACKING (AcpiGbl_MemoryLists[ACPI_MEM_LIST_NSNODE].TotalAllocated++);
158 Node->Name.Integer = Name;
159 Node->ReferenceCount = 1;
160 ACPI_SET_DESCRIPTOR_TYPE (Node, ACPI_DESC_TYPE_NAMED);
166 /*******************************************************************************
168 * FUNCTION: AcpiNsDeleteNode
170 * PARAMETERS: Node - Node to be deleted
174 * DESCRIPTION: Delete a namespace node
176 ******************************************************************************/
180 ACPI_NAMESPACE_NODE *Node)
182 ACPI_NAMESPACE_NODE *ParentNode;
183 ACPI_NAMESPACE_NODE *PrevNode;
184 ACPI_NAMESPACE_NODE *NextNode;
187 ACPI_FUNCTION_TRACE_PTR ("NsDeleteNode", Node);
190 ParentNode = AcpiNsGetParentNode (Node);
193 NextNode = ParentNode->Child;
195 /* Find the node that is the previous peer in the parent's child list */
197 while (NextNode != Node)
200 NextNode = PrevNode->Peer;
205 /* Node is not first child, unlink it */
207 PrevNode->Peer = NextNode->Peer;
208 if (NextNode->Flags & ANOBJ_END_OF_PEER_LIST)
210 PrevNode->Flags |= ANOBJ_END_OF_PEER_LIST;
215 /* Node is first child (has no previous peer) */
217 if (NextNode->Flags & ANOBJ_END_OF_PEER_LIST)
219 /* No peers at all */
221 ParentNode->Child = NULL;
224 { /* Link peer list to parent */
226 ParentNode->Child = NextNode->Peer;
231 ACPI_MEM_TRACKING (AcpiGbl_MemoryLists[ACPI_MEM_LIST_NSNODE].TotalFreed++);
234 * Detach an object if there is one then delete the node
236 AcpiNsDetachObject (Node);
237 ACPI_MEM_FREE (Node);
242 #ifdef ACPI_ALPHABETIC_NAMESPACE
243 /*******************************************************************************
245 * FUNCTION: AcpiNsCompareNames
247 * PARAMETERS: Name1 - First name to compare
248 * Name2 - Second name to compare
250 * RETURN: value from strncmp
252 * DESCRIPTION: Compare two ACPI names. Names that are prefixed with an
253 * underscore are forced to be alphabetically first.
255 ******************************************************************************/
262 char ReversedName1[ACPI_NAME_SIZE];
263 char ReversedName2[ACPI_NAME_SIZE];
269 * Replace all instances of "underscore" with a value that is smaller so
270 * that all names that are prefixed with underscore(s) are alphabetically
273 * Reverse the name bytewise so we can just do a 32-bit compare instead
276 for (i = 0, j= (ACPI_NAME_SIZE - 1); i < ACPI_NAME_SIZE; i++, j--)
278 ReversedName1[j] = Name1[i];
281 ReversedName1[j] = '*';
284 ReversedName2[j] = Name2[i];
287 ReversedName2[j] = '*';
291 return (*(int *) ReversedName1 - *(int *) ReversedName2);
296 /*******************************************************************************
298 * FUNCTION: AcpiNsInstallNode
300 * PARAMETERS: WalkState - Current state of the walk
301 * ParentNode - The parent of the new Node
302 * Node - The new Node to install
303 * Type - ACPI object type of the new Node
307 * DESCRIPTION: Initialize a new namespace node and install it amongst
310 * Note: Current namespace lookup is linear search. However, the
311 * nodes are linked in alphabetical order to 1) put all reserved
312 * names (start with underscore) first, and to 2) make a readable
315 ******************************************************************************/
319 ACPI_WALK_STATE *WalkState,
320 ACPI_NAMESPACE_NODE *ParentNode, /* Parent */
321 ACPI_NAMESPACE_NODE *Node, /* New Child*/
322 ACPI_OBJECT_TYPE Type)
325 ACPI_NAMESPACE_NODE *ChildNode;
326 #ifdef ACPI_ALPHABETIC_NAMESPACE
328 ACPI_NAMESPACE_NODE *PreviousChildNode;
332 ACPI_FUNCTION_TRACE ("NsInstallNode");
336 * Get the owner ID from the Walk state
337 * The owner ID is used to track table deletion and
338 * deletion of objects created by methods
342 OwnerId = WalkState->OwnerId;
345 /* Link the new entry into the parent and existing children */
347 ChildNode = ParentNode->Child;
350 ParentNode->Child = Node;
351 Node->Flags |= ANOBJ_END_OF_PEER_LIST;
352 Node->Peer = ParentNode;
356 #ifdef ACPI_ALPHABETIC_NAMESPACE
358 * Walk the list whilst searching for the correct
359 * alphabetic placement.
361 PreviousChildNode = NULL;
362 while (AcpiNsCompareNames (AcpiUtGetNodeName (ChildNode), AcpiUtGetNodeName (Node)) < 0)
364 if (ChildNode->Flags & ANOBJ_END_OF_PEER_LIST)
366 /* Last peer; Clear end-of-list flag */
368 ChildNode->Flags &= ~ANOBJ_END_OF_PEER_LIST;
370 /* This node is the new peer to the child node */
372 ChildNode->Peer = Node;
374 /* This node is the new end-of-list */
376 Node->Flags |= ANOBJ_END_OF_PEER_LIST;
377 Node->Peer = ParentNode;
383 PreviousChildNode = ChildNode;
384 ChildNode = ChildNode->Peer;
387 /* Did the node get inserted at the end-of-list? */
389 if (!(Node->Flags & ANOBJ_END_OF_PEER_LIST))
392 * Loop above terminated without reaching the end-of-list.
393 * Insert the new node at the current location
395 if (PreviousChildNode)
397 /* Insert node alphabetically */
399 Node->Peer = ChildNode;
400 PreviousChildNode->Peer = Node;
404 /* Insert node alphabetically at start of list */
406 Node->Peer = ChildNode;
407 ParentNode->Child = Node;
411 while (!(ChildNode->Flags & ANOBJ_END_OF_PEER_LIST))
413 ChildNode = ChildNode->Peer;
416 ChildNode->Peer = Node;
418 /* Clear end-of-list flag */
420 ChildNode->Flags &= ~ANOBJ_END_OF_PEER_LIST;
421 Node->Flags |= ANOBJ_END_OF_PEER_LIST;
422 Node->Peer = ParentNode;
426 /* Init the new entry */
428 Node->OwnerId = OwnerId;
429 Node->Type = (UINT8) Type;
431 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES,
432 "%4.4s (%s) [Node %p Owner %X] added to %4.4s (%s) [Node %p]\n",
433 AcpiUtGetNodeName (Node), AcpiUtGetTypeName (Node->Type), Node, OwnerId,
434 AcpiUtGetNodeName (ParentNode), AcpiUtGetTypeName (ParentNode->Type),
438 * Increment the reference count(s) of all parents up to
441 while ((Node = AcpiNsGetParentNode (Node)) != NULL)
443 Node->ReferenceCount++;
450 /*******************************************************************************
452 * FUNCTION: AcpiNsDeleteChildren
454 * PARAMETERS: ParentNode - Delete this objects children
458 * DESCRIPTION: Delete all children of the parent object. In other words,
461 ******************************************************************************/
464 AcpiNsDeleteChildren (
465 ACPI_NAMESPACE_NODE *ParentNode)
467 ACPI_NAMESPACE_NODE *ChildNode;
468 ACPI_NAMESPACE_NODE *NextNode;
469 ACPI_NAMESPACE_NODE *Node;
473 ACPI_FUNCTION_TRACE_PTR ("NsDeleteChildren", ParentNode);
481 /* If no children, all done! */
483 ChildNode = ParentNode->Child;
490 * Deallocate all children at this level
494 /* Get the things we need */
496 NextNode = ChildNode->Peer;
497 Flags = ChildNode->Flags;
499 /* Grandchildren should have all been deleted already */
501 if (ChildNode->Child)
503 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Found a grandchild! P=%p C=%p\n",
504 ParentNode, ChildNode));
507 /* Now we can free this child object */
509 ACPI_MEM_TRACKING (AcpiGbl_MemoryLists[ACPI_MEM_LIST_NSNODE].TotalFreed++);
511 ACPI_DEBUG_PRINT ((ACPI_DB_ALLOCATIONS, "Object %p, Remaining %X\n",
512 ChildNode, AcpiGbl_CurrentNodeCount));
515 * Detach an object if there is one, then free the child node
517 AcpiNsDetachObject (ChildNode);
520 * Decrement the reference count(s) of all parents up to
521 * the root! (counts were incremented when the node was created)
524 while ((Node = AcpiNsGetParentNode (Node)) != NULL)
526 Node->ReferenceCount--;
529 /* There should be only one reference remaining on this node */
531 if (ChildNode->ReferenceCount != 1)
533 ACPI_REPORT_WARNING (("Existing references (%d) on node being deleted (%p)\n",
534 ChildNode->ReferenceCount, ChildNode));
537 /* Now we can delete the node */
539 ACPI_MEM_FREE (ChildNode);
541 /* And move on to the next child in the list */
543 ChildNode = NextNode;
545 } while (!(Flags & ANOBJ_END_OF_PEER_LIST));
548 /* Clear the parent's child pointer */
550 ParentNode->Child = NULL;
556 /*******************************************************************************
558 * FUNCTION: AcpiNsDeleteNamespaceSubtree
560 * PARAMETERS: ParentNode - Root of the subtree to be deleted
564 * DESCRIPTION: Delete a subtree of the namespace. This includes all objects
565 * stored within the subtree.
567 ******************************************************************************/
570 AcpiNsDeleteNamespaceSubtree (
571 ACPI_NAMESPACE_NODE *ParentNode)
573 ACPI_NAMESPACE_NODE *ChildNode = NULL;
577 ACPI_FUNCTION_TRACE ("NsDeleteNamespaceSubtree");
586 * Traverse the tree of objects until we bubble back up
587 * to where we started.
591 /* Get the next node in this scope (NULL if none) */
593 ChildNode = AcpiNsGetNextNode (ACPI_TYPE_ANY, ParentNode,
597 /* Found a child node - detach any attached object */
599 AcpiNsDetachObject (ChildNode);
601 /* Check if this node has any children */
603 if (AcpiNsGetNextNode (ACPI_TYPE_ANY, ChildNode, 0))
606 * There is at least one child of this node,
610 ParentNode = ChildNode;
617 * No more children of this parent node.
618 * Move up to the grandparent.
623 * Now delete all of the children of this parent
624 * all at the same time.
626 AcpiNsDeleteChildren (ParentNode);
628 /* New "last child" is this parent node */
630 ChildNode = ParentNode;
632 /* Move up the tree to the grandparent */
634 ParentNode = AcpiNsGetParentNode (ParentNode);
642 /*******************************************************************************
644 * FUNCTION: AcpiNsRemoveReference
646 * PARAMETERS: Node - Named node whose reference count is to be
651 * DESCRIPTION: Remove a Node reference. Decrements the reference count
652 * of all parent Nodes up to the root. Any node along
653 * the way that reaches zero references is freed.
655 ******************************************************************************/
658 AcpiNsRemoveReference (
659 ACPI_NAMESPACE_NODE *Node)
661 ACPI_NAMESPACE_NODE *ParentNode;
662 ACPI_NAMESPACE_NODE *ThisNode;
665 ACPI_FUNCTION_ENTRY ();
669 * Decrement the reference count(s) of this node and all
670 * nodes up to the root, Delete anything with zero remaining references.
675 /* Prepare to move up to parent */
677 ParentNode = AcpiNsGetParentNode (ThisNode);
679 /* Decrement the reference count on this node */
681 ThisNode->ReferenceCount--;
683 /* Delete the node if no more references */
685 if (!ThisNode->ReferenceCount)
687 /* Delete all children and delete the node */
689 AcpiNsDeleteChildren (ThisNode);
690 AcpiNsDeleteNode (ThisNode);
693 ThisNode = ParentNode;
698 /*******************************************************************************
700 * FUNCTION: AcpiNsDeleteNamespaceByOwner
702 * PARAMETERS: OwnerId - All nodes with this owner will be deleted
706 * DESCRIPTION: Delete entries within the namespace that are owned by a
707 * specific ID. Used to delete entire ACPI tables. All
708 * reference counts are updated.
710 ******************************************************************************/
713 AcpiNsDeleteNamespaceByOwner (
716 ACPI_NAMESPACE_NODE *ChildNode;
717 ACPI_NAMESPACE_NODE *DeletionNode;
719 ACPI_NAMESPACE_NODE *ParentNode;
722 ACPI_FUNCTION_TRACE_U32 ("NsDeleteNamespaceByOwner", OwnerId);
725 ParentNode = AcpiGbl_RootNode;
731 * Traverse the tree of nodes until we bubble back up
732 * to where we started.
737 * Get the next child of this parent node. When ChildNode is NULL,
738 * the first child of the parent is returned
740 ChildNode = AcpiNsGetNextNode (ACPI_TYPE_ANY, ParentNode, ChildNode);
744 AcpiNsRemoveReference (DeletionNode);
750 if (ChildNode->OwnerId == OwnerId)
752 /* Found a matching child node - detach any attached object */
754 AcpiNsDetachObject (ChildNode);
757 /* Check if this node has any children */
759 if (AcpiNsGetNextNode (ACPI_TYPE_ANY, ChildNode, NULL))
762 * There is at least one child of this node,
766 ParentNode = ChildNode;
769 else if (ChildNode->OwnerId == OwnerId)
771 DeletionNode = ChildNode;
777 * No more children of this parent node.
778 * Move up to the grandparent.
783 if (ParentNode->OwnerId == OwnerId)
785 DeletionNode = ParentNode;
789 /* New "last child" is this parent node */
791 ChildNode = ParentNode;
793 /* Move up the tree to the grandparent */
795 ParentNode = AcpiNsGetParentNode (ParentNode);