Subversion Repositories Kolibri OS

/*******************************************************************************

 *

 * Module Name: nsalloc - Namespace allocation and deletion utilities

 *

 ******************************************************************************/

/******************************************************************************

 *

 * 1. Copyright Notice

 *

 * Some or all of this work - Copyright (c) 1999 - 2011, Intel Corp.

 * All rights reserved.

 *

 * 2. License

 *

 * 2.1. This is your license from Intel Corp. under its intellectual property

 * rights.  You may have additional license terms from the party that provided

 * you this software, covering your right to use that party's intellectual

 * property rights.

 *

 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a

 * copy of the source code appearing in this file ("Covered Code") an

 * irrevocable, perpetual, worldwide license under Intel's copyrights in the

 * base code distributed originally by Intel ("Original Intel Code") to copy,

 * make derivatives, distribute, use and display any portion of the Covered

 * Code in any form, with the right to sublicense such rights; and

 *

 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent

 * license (with the right to sublicense), under only those claims of Intel

 * patents that are infringed by the Original Intel Code, to make, use, sell,

 * offer to sell, and import the Covered Code and derivative works thereof

 * solely to the minimum extent necessary to exercise the above copyright

 * license, and in no event shall the patent license extend to any additions

 * to or modifications of the Original Intel Code.  No other license or right

 * is granted directly or by implication, estoppel or otherwise;

 *

 * The above copyright and patent license is granted only if the following

 * conditions are met:

 *

 * 3. Conditions

 *

 * 3.1. Redistribution of Source with Rights to Further Distribute Source.

 * Redistribution of source code of any substantial portion of the Covered

 * Code or modification with rights to further distribute source must include

 * the above Copyright Notice, the above License, this list of Conditions,

 * and the following Disclaimer and Export Compliance provision.  In addition,

 * Licensee must cause all Covered Code to which Licensee contributes to

 * contain a file documenting the changes Licensee made to create that Covered

 * Code and the date of any change.  Licensee must include in that file the

 * documentation of any changes made by any predecessor Licensee.  Licensee

 * must include a prominent statement that the modification is derived,

 * directly or indirectly, from Original Intel Code.

 *

 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.

 * Redistribution of source code of any substantial portion of the Covered

 * Code or modification without rights to further distribute source must

 * include the following Disclaimer and Export Compliance provision in the

 * documentation and/or other materials provided with distribution.  In

 * addition, Licensee may not authorize further sublicense of source of any

 * portion of the Covered Code, and must include terms to the effect that the

 * license from Licensee to its licensee is limited to the intellectual

 * property embodied in the software Licensee provides to its licensee, and

 * not to intellectual property embodied in modifications its licensee may

 * make.

 *

 * 3.3. Redistribution of Executable. Redistribution in executable form of any

 * substantial portion of the Covered Code or modification must reproduce the

 * above Copyright Notice, and the following Disclaimer and Export Compliance

 * provision in the documentation and/or other materials provided with the

 * distribution.

 *

 * 3.4. Intel retains all right, title, and interest in and to the Original

 * Intel Code.

 *

 * 3.5. Neither the name Intel nor any other trademark owned or controlled by

 * Intel shall be used in advertising or otherwise to promote the sale, use or

 * other dealings in products derived from or relating to the Covered Code

 * without prior written authorization from Intel.

 *

 * 4. Disclaimer and Export Compliance

 *

 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED

 * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE

 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,

 * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY

 * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY

 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A

 * PARTICULAR PURPOSE.

 *

 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES

 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR

 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,

 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY

 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL

 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS

 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY

 * LIMITED REMEDY.

 *

 * 4.3. Licensee shall not export, either directly or indirectly, any of this

 * software or system incorporating such software without first obtaining any

 * required license or other approval from the U. S. Department of Commerce or

 * any other agency or department of the United States Government.  In the

 * event Licensee exports any such software from the United States or

 * re-exports any such software from a foreign destination, Licensee shall

 * ensure that the distribution and export/re-export of the software is in

 * compliance with all laws, regulations, orders, or other restrictions of the

 * U.S. Export Administration Regulations. Licensee agrees that neither it nor

 * any of its subsidiaries will export/re-export any technical data, process,

 * software, or service, directly or indirectly, to any country for which the

 * United States government or any agency thereof requires an export license,

 * other governmental approval, or letter of assurance, without first obtaining

 * such license, approval or letter.

 *

 *****************************************************************************/

#define __NSALLOC_C__

#include "acpi.h"

#include "accommon.h"

#include "acnamesp.h"

#define _COMPONENT          ACPI_NAMESPACE

        ACPI_MODULE_NAME    ("nsalloc")

/*******************************************************************************

 *

 * FUNCTION:    AcpiNsCreateNode

 *

 * PARAMETERS:  Name            - Name of the new node (4 char ACPI name)

 *

 * RETURN:      New namespace node (Null on failure)

 *

 * DESCRIPTION: Create a namespace node

 *

 ******************************************************************************/

ACPI_NAMESPACE_NODE *

AcpiNsCreateNode (

    UINT32                  Name)

{

    ACPI_NAMESPACE_NODE     *Node;

#ifdef ACPI_DBG_TRACK_ALLOCATIONS

    UINT32                  Temp;

#endif

    ACPI_FUNCTION_TRACE (NsCreateNode);

    Node = AcpiOsAcquireObject (AcpiGbl_NamespaceCache);

    if (!Node)

    {

        return_PTR (NULL);

    }

    ACPI_MEM_TRACKING (AcpiGbl_NsNodeList->TotalAllocated++);

#ifdef ACPI_DBG_TRACK_ALLOCATIONS

        Temp = AcpiGbl_NsNodeList->TotalAllocated -

                AcpiGbl_NsNodeList->TotalFreed;

        if (Temp > AcpiGbl_NsNodeList->MaxOccupied)

        {

            AcpiGbl_NsNodeList->MaxOccupied = Temp;

        }

#endif

    Node->Name.Integer = Name;

    ACPI_SET_DESCRIPTOR_TYPE (Node, ACPI_DESC_TYPE_NAMED);

    return_PTR (Node);

}

/*******************************************************************************

 *

 * FUNCTION:    AcpiNsDeleteNode

 *

 * PARAMETERS:  Node            - Node to be deleted

 *

 * RETURN:      None

 *

 * DESCRIPTION: Delete a namespace node. All node deletions must come through

 *              here. Detaches any attached objects, including any attached

 *              data. If a handler is associated with attached data, it is

 *              invoked before the node is deleted.

 *

 ******************************************************************************/

void

AcpiNsDeleteNode (

    ACPI_NAMESPACE_NODE     *Node)

{

    ACPI_OPERAND_OBJECT     *ObjDesc;

    ACPI_FUNCTION_NAME (NsDeleteNode);

    /* Detach an object if there is one */

    AcpiNsDetachObject (Node);

    /*

     * Delete an attached data object if present (an object that was created

     * and attached via AcpiAttachData). Note: After any normal object is

     * detached above, the only possible remaining object is a data object.

     */

    ObjDesc = Node->Object;

    if (ObjDesc &&

        (ObjDesc->Common.Type == ACPI_TYPE_LOCAL_DATA))

    {

        /* Invoke the attached data deletion handler if present */

        if (ObjDesc->Data.Handler)

        {

            ObjDesc->Data.Handler (Node, ObjDesc->Data.Pointer);

        }

        AcpiUtRemoveReference (ObjDesc);

    }

    /* Now we can delete the node */

    (void) AcpiOsReleaseObject (AcpiGbl_NamespaceCache, Node);

    ACPI_MEM_TRACKING (AcpiGbl_NsNodeList->TotalFreed++);

    ACPI_DEBUG_PRINT ((ACPI_DB_ALLOCATIONS, "Node %p, Remaining %X\n",

        Node, AcpiGbl_CurrentNodeCount));

}

/*******************************************************************************

 *

 * FUNCTION:    AcpiNsRemoveNode

 *

 * PARAMETERS:  Node            - Node to be removed/deleted

 *

 * RETURN:      None

 *

 * DESCRIPTION: Remove (unlink) and delete a namespace node

 *

 ******************************************************************************/

void

AcpiNsRemoveNode (

    ACPI_NAMESPACE_NODE     *Node)

{

    ACPI_NAMESPACE_NODE     *ParentNode;

    ACPI_NAMESPACE_NODE     *PrevNode;

    ACPI_NAMESPACE_NODE     *NextNode;

    ACPI_FUNCTION_TRACE_PTR (NsRemoveNode, Node);

    ParentNode = Node->Parent;

    PrevNode = NULL;

    NextNode = ParentNode->Child;

    /* Find the node that is the previous peer in the parent's child list */

    while (NextNode != Node)

    {

        PrevNode = NextNode;

        NextNode = NextNode->Peer;

    }

    if (PrevNode)

    {

        /* Node is not first child, unlink it */

        PrevNode->Peer = Node->Peer;

    }

    else

    {

        /*

         * Node is first child (has no previous peer).

         * Link peer list to parent

         */

        ParentNode->Child = Node->Peer;

    }

    /* Delete the node and any attached objects */

    AcpiNsDeleteNode (Node);

    return_VOID;

}

/*******************************************************************************

 *

 * FUNCTION:    AcpiNsInstallNode

 *

 * PARAMETERS:  WalkState       - Current state of the walk

 *              ParentNode      - The parent of the new Node

 *              Node            - The new Node to install

 *              Type            - ACPI object type of the new Node

 *

 * RETURN:      None

 *

 * DESCRIPTION: Initialize a new namespace node and install it amongst

 *              its peers.

 *

 *              Note: Current namespace lookup is linear search. This appears

 *              to be sufficient as namespace searches consume only a small

 *              fraction of the execution time of the ACPI subsystem.

 *

 ******************************************************************************/

void

AcpiNsInstallNode (

    ACPI_WALK_STATE         *WalkState,

    ACPI_NAMESPACE_NODE     *ParentNode,    /* Parent */

    ACPI_NAMESPACE_NODE     *Node,          /* New Child*/

    ACPI_OBJECT_TYPE        Type)

{

    ACPI_OWNER_ID           OwnerId = 0;

    ACPI_NAMESPACE_NODE     *ChildNode;

    ACPI_FUNCTION_TRACE (NsInstallNode);

    if (WalkState)

    {

        /*

         * Get the owner ID from the Walk state. The owner ID is used to

         * track table deletion and deletion of objects created by methods.

         */

        OwnerId = WalkState->OwnerId;

        if ((WalkState->MethodDesc) &&

            (ParentNode != WalkState->MethodNode))

        {

            /*

             * A method is creating a new node that is not a child of the

             * method (it is non-local). Mark the executing method as having

             * modified the namespace. This is used for cleanup when the

             * method exits.

             */

            WalkState->MethodDesc->Method.InfoFlags |= ACPI_METHOD_MODIFIED_NAMESPACE;

        }

    }

    /* Link the new entry into the parent and existing children */

    Node->Peer = NULL;

    Node->Parent = ParentNode;

    ChildNode = ParentNode->Child;

    if (!ChildNode)

    {

        ParentNode->Child = Node;

    }

    else

    {

        /* Add node to the end of the peer list */

        while (ChildNode->Peer)

        {

            ChildNode = ChildNode->Peer;

        }

        ChildNode->Peer = Node;

    }

    /* Init the new entry */

    Node->OwnerId = OwnerId;

    Node->Type = (UINT8) Type;

    ACPI_DEBUG_PRINT ((ACPI_DB_NAMES,

        "%4.4s (%s) [Node %p Owner %X] added to %4.4s (%s) [Node %p]\n",

        AcpiUtGetNodeName (Node), AcpiUtGetTypeName (Node->Type), Node, OwnerId,

        AcpiUtGetNodeName (ParentNode), AcpiUtGetTypeName (ParentNode->Type),

        ParentNode));

    return_VOID;

}

/*******************************************************************************

 *

 * FUNCTION:    AcpiNsDeleteChildren

 *

 * PARAMETERS:  ParentNode      - Delete this objects children

 *

 * RETURN:      None.

 *

 * DESCRIPTION: Delete all children of the parent object. In other words,

 *              deletes a "scope".

 *

 ******************************************************************************/

void

AcpiNsDeleteChildren (

    ACPI_NAMESPACE_NODE     *ParentNode)

{

    ACPI_NAMESPACE_NODE     *NextNode;

    ACPI_NAMESPACE_NODE     *NodeToDelete;

    ACPI_FUNCTION_TRACE_PTR (NsDeleteChildren, ParentNode);

    if (!ParentNode)

    {

        return_VOID;

    }

    /* Deallocate all children at this level */

    NextNode = ParentNode->Child;

    while (NextNode)

    {

        /* Grandchildren should have all been deleted already */

        if (NextNode->Child)

        {

            ACPI_ERROR ((AE_INFO, "Found a grandchild! P=%p C=%p",

                ParentNode, NextNode));

        }

        /*

         * Delete this child node and move on to the next child in the list.

         * No need to unlink the node since we are deleting the entire branch.

         */

        NodeToDelete = NextNode;

        NextNode = NextNode->Peer;

        AcpiNsDeleteNode (NodeToDelete);

    };

    /* Clear the parent's child pointer */

    ParentNode->Child = NULL;

    return_VOID;

}

/*******************************************************************************

 *

 * FUNCTION:    AcpiNsDeleteNamespaceSubtree

 *

 * PARAMETERS:  ParentNode      - Root of the subtree to be deleted

 *

 * RETURN:      None.

 *

 * DESCRIPTION: Delete a subtree of the namespace.  This includes all objects

 *              stored within the subtree.

 *

 ******************************************************************************/

void

AcpiNsDeleteNamespaceSubtree (

    ACPI_NAMESPACE_NODE     *ParentNode)

{

    ACPI_NAMESPACE_NODE     *ChildNode = NULL;

    UINT32                  Level = 1;

    ACPI_STATUS             Status;

    ACPI_FUNCTION_TRACE (NsDeleteNamespaceSubtree);

    if (!ParentNode)

    {

        return_VOID;

    }

    /* Lock namespace for possible update */

    Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);

    if (ACPI_FAILURE (Status))

    {

        return_VOID;

    }

    /*

     * Traverse the tree of objects until we bubble back up

     * to where we started.

     */

    while (Level > 0)

    {

        /* Get the next node in this scope (NULL if none) */

        ChildNode = AcpiNsGetNextNode (ParentNode, ChildNode);

        if (ChildNode)

        {

            /* Found a child node - detach any attached object */

            AcpiNsDetachObject (ChildNode);

            /* Check if this node has any children */

            if (ChildNode->Child)

            {

                /*

                 * There is at least one child of this node,

                 * visit the node

                 */

                Level++;

                ParentNode = ChildNode;

                ChildNode  = NULL;

            }

        }

        else

        {

            /*

             * No more children of this parent node.

             * Move up to the grandparent.

             */

            Level--;

            /*

             * Now delete all of the children of this parent

             * all at the same time.

             */

            AcpiNsDeleteChildren (ParentNode);

            /* New "last child" is this parent node */

            ChildNode = ParentNode;

            /* Move up the tree to the grandparent */

            ParentNode = ParentNode->Parent;

        }

    }

    (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);

    return_VOID;

}

/*******************************************************************************

 *

 * FUNCTION:    AcpiNsDeleteNamespaceByOwner

 *

 * PARAMETERS:  OwnerId     - All nodes with this owner will be deleted

 *

 * RETURN:      Status

 *

 * DESCRIPTION: Delete entries within the namespace that are owned by a

 *              specific ID.  Used to delete entire ACPI tables.  All

 *              reference counts are updated.

 *

 * MUTEX:       Locks namespace during deletion walk.

 *

 ******************************************************************************/

void

AcpiNsDeleteNamespaceByOwner (

    ACPI_OWNER_ID            OwnerId)

{

    ACPI_NAMESPACE_NODE     *ChildNode;

    ACPI_NAMESPACE_NODE     *DeletionNode;

    ACPI_NAMESPACE_NODE     *ParentNode;

    UINT32                  Level;

    ACPI_STATUS             Status;

    ACPI_FUNCTION_TRACE_U32 (NsDeleteNamespaceByOwner, OwnerId);

    if (OwnerId == 0)

    {

        return_VOID;

    }

    /* Lock namespace for possible update */

    Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);

    if (ACPI_FAILURE (Status))

    {

        return_VOID;

    }

    DeletionNode = NULL;

    ParentNode = AcpiGbl_RootNode;

    ChildNode = NULL;

    Level = 1;

    /*

     * Traverse the tree of nodes until we bubble back up

     * to where we started.

     */

    while (Level > 0)

    {

        /*

         * Get the next child of this parent node. When ChildNode is NULL,

         * the first child of the parent is returned

         */

        ChildNode = AcpiNsGetNextNode (ParentNode, ChildNode);

        if (DeletionNode)

        {

            AcpiNsDeleteChildren (DeletionNode);

            AcpiNsRemoveNode (DeletionNode);

            DeletionNode = NULL;

        }

        if (ChildNode)

        {

            if (ChildNode->OwnerId == OwnerId)

            {

                /* Found a matching child node - detach any attached object */

                AcpiNsDetachObject (ChildNode);

            }

            /* Check if this node has any children */

            if (ChildNode->Child)

            {

                /*

                 * There is at least one child of this node,

                 * visit the node

                 */

                Level++;

                ParentNode = ChildNode;

                ChildNode  = NULL;

            }

            else if (ChildNode->OwnerId == OwnerId)

            {

                DeletionNode = ChildNode;

            }

        }

        else

        {

            /*

             * No more children of this parent node.

             * Move up to the grandparent.

             */

            Level--;

            if (Level != 0)

            {

                if (ParentNode->OwnerId == OwnerId)

                {

                    DeletionNode = ParentNode;

                }

            }

            /* New "last child" is this parent node */

            ChildNode = ParentNode;

            /* Move up the tree to the grandparent */

            ParentNode = ParentNode->Parent;

        }

    }

    (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);

    return_VOID;

}