sys/contrib/dev/acpica/namespace/nsalloc.c

   1 /*******************************************************************************
   2  *
   3  * Module Name: nsalloc - Namespace allocation and deletion utilities
   4  *
   5  ******************************************************************************/
   6
   7 /******************************************************************************
   8  *
   9  * 1. Copyright Notice
  10  *
  11  * Some or all of this work - Copyright (c) 1999 - 2009, Intel Corp.
  12  * All rights reserved.
  13  *
  14  * 2. License
  15  *
  16  * 2.1. This is your license from Intel Corp. under its intellectual property
  17  * rights.  You may have additional license terms from the party that provided
  18  * you this software, covering your right to use that party's intellectual
  19  * property rights.
  20  *
  21  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  22  * copy of the source code appearing in this file ("Covered Code") an
  23  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  24  * base code distributed originally by Intel ("Original Intel Code") to copy,
  25  * make derivatives, distribute, use and display any portion of the Covered
  26  * Code in any form, with the right to sublicense such rights; and
  27  *
  28  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  29  * license (with the right to sublicense), under only those claims of Intel
  30  * patents that are infringed by the Original Intel Code, to make, use, sell,
  31  * offer to sell, and import the Covered Code and derivative works thereof
  32  * solely to the minimum extent necessary to exercise the above copyright
  33  * license, and in no event shall the patent license extend to any additions
  34  * to or modifications of the Original Intel Code.  No other license or right
  35  * is granted directly or by implication, estoppel or otherwise;
  36  *
  37  * The above copyright and patent license is granted only if the following
  38  * conditions are met:
  39  *
  40  * 3. Conditions
  41  *
  42  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  43  * Redistribution of source code of any substantial portion of the Covered
  44  * Code or modification with rights to further distribute source must include
  45  * the above Copyright Notice, the above License, this list of Conditions,
  46  * and the following Disclaimer and Export Compliance provision.  In addition,
  47  * Licensee must cause all Covered Code to which Licensee contributes to
  48  * contain a file documenting the changes Licensee made to create that Covered
  49  * Code and the date of any change.  Licensee must include in that file the
  50  * documentation of any changes made by any predecessor Licensee.  Licensee
  51  * must include a prominent statement that the modification is derived,
  52  * directly or indirectly, from Original Intel Code.
  53  *
  54  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  55  * Redistribution of source code of any substantial portion of the Covered
  56  * Code or modification without rights to further distribute source must
  57  * include the following Disclaimer and Export Compliance provision in the
  58  * documentation and/or other materials provided with distribution.  In
  59  * addition, Licensee may not authorize further sublicense of source of any
  60  * portion of the Covered Code, and must include terms to the effect that the
  61  * license from Licensee to its licensee is limited to the intellectual
  62  * property embodied in the software Licensee provides to its licensee, and
  63  * not to intellectual property embodied in modifications its licensee may
  64  * make.
  65  *
  66  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  67  * substantial portion of the Covered Code or modification must reproduce the
  68  * above Copyright Notice, and the following Disclaimer and Export Compliance
  69  * provision in the documentation and/or other materials provided with the
  70  * distribution.
  71  *
  72  * 3.4. Intel retains all right, title, and interest in and to the Original
  73  * Intel Code.
  74  *
  75  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  76  * Intel shall be used in advertising or otherwise to promote the sale, use or
  77  * other dealings in products derived from or relating to the Covered Code
  78  * without prior written authorization from Intel.
  79  *
  80  * 4. Disclaimer and Export Compliance
  81  *
  82  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  83  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  84  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
  85  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
  86  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
  87  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  88  * PARTICULAR PURPOSE.
  89  *
  90  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  91  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  92  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  93  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  94  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  95  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
  96  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  97  * LIMITED REMEDY.
  98  *
  99  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 100  * software or system incorporating such software without first obtaining any
 101  * required license or other approval from the U. S. Department of Commerce or
 102  * any other agency or department of the United States Government.  In the
 103  * event Licensee exports any such software from the United States or
 104  * re-exports any such software from a foreign destination, Licensee shall
 105  * ensure that the distribution and export/re-export of the software is in
 106  * compliance with all laws, regulations, orders, or other restrictions of the
 107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 108  * any of its subsidiaries will export/re-export any technical data, process,
 109  * software, or service, directly or indirectly, to any country for which the
 110  * United States government or any agency thereof requires an export license,
 111  * other governmental approval, or letter of assurance, without first obtaining
 112  * such license, approval or letter.
 113  *
 114  *****************************************************************************/
 115
 116
 117 #define __NSALLOC_C__
 118
 119 #include <contrib/dev/acpica/include/acpi.h>
 120 #include <contrib/dev/acpica/include/accommon.h>
 121 #include <contrib/dev/acpica/include/acnamesp.h>
 122
 123
 124 #define _COMPONENT          ACPI_NAMESPACE
 125         ACPI_MODULE_NAME    ("nsalloc")
 126
 127
 128 /*******************************************************************************
 129  *
 130  * FUNCTION:    AcpiNsCreateNode
 131  *
 132  * PARAMETERS:  Name            - Name of the new node (4 char ACPI name)
 133  *
 134  * RETURN:      New namespace node (Null on failure)
 135  *
 136  * DESCRIPTION: Create a namespace node
 137  *
 138  ******************************************************************************/
 139
 140 ACPI_NAMESPACE_NODE *
 141 AcpiNsCreateNode (
 142     UINT32                  Name)
 143 {
 144     ACPI_NAMESPACE_NODE     *Node;
 145 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
 146     UINT32                  Temp;
 147 #endif
 148
 149
 150     ACPI_FUNCTION_TRACE (NsCreateNode);
 151
 152
 153     Node = AcpiOsAcquireObject (AcpiGbl_NamespaceCache);
 154     if (!Node)
 155     {
 156         return_PTR (NULL);
 157     }
 158
 159     ACPI_MEM_TRACKING (AcpiGbl_NsNodeList->TotalAllocated++);
 160
 161 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
 162         Temp = AcpiGbl_NsNodeList->TotalAllocated -
 163                 AcpiGbl_NsNodeList->TotalFreed;
 164         if (Temp > AcpiGbl_NsNodeList->MaxOccupied)
 165         {
 166             AcpiGbl_NsNodeList->MaxOccupied = Temp;
 167         }
 168 #endif
 169
 170     Node->Name.Integer = Name;
 171     ACPI_SET_DESCRIPTOR_TYPE (Node, ACPI_DESC_TYPE_NAMED);
 172     return_PTR (Node);
 173 }
 174
 175
 176 /*******************************************************************************
 177  *
 178  * FUNCTION:    AcpiNsDeleteNode
 179  *
 180  * PARAMETERS:  Node            - Node to be deleted
 181  *
 182  * RETURN:      None
 183  *
 184  * DESCRIPTION: Delete a namespace node
 185  *
 186  ******************************************************************************/
 187
 188 void
 189 AcpiNsDeleteNode (
 190     ACPI_NAMESPACE_NODE     *Node)
 191 {
 192     ACPI_NAMESPACE_NODE     *ParentNode;
 193     ACPI_NAMESPACE_NODE     *PrevNode;
 194     ACPI_NAMESPACE_NODE     *NextNode;
 195
 196
 197     ACPI_FUNCTION_TRACE_PTR (NsDeleteNode, Node);
 198
 199
 200     ParentNode = AcpiNsGetParentNode (Node);
 201
 202     PrevNode = NULL;
 203     NextNode = ParentNode->Child;
 204
 205     /* Find the node that is the previous peer in the parent's child list */
 206
 207     while (NextNode != Node)
 208     {
 209         PrevNode = NextNode;
 210         NextNode = PrevNode->Peer;
 211     }
 212
 213     if (PrevNode)
 214     {
 215         /* Node is not first child, unlink it */
 216
 217         PrevNode->Peer = NextNode->Peer;
 218         if (NextNode->Flags & ANOBJ_END_OF_PEER_LIST)
 219         {
 220             PrevNode->Flags |= ANOBJ_END_OF_PEER_LIST;
 221         }
 222     }
 223     else
 224     {
 225         /* Node is first child (has no previous peer) */
 226
 227         if (NextNode->Flags & ANOBJ_END_OF_PEER_LIST)
 228         {
 229             /* No peers at all */
 230
 231             ParentNode->Child = NULL;
 232         }
 233         else
 234         {   /* Link peer list to parent */
 235
 236             ParentNode->Child = NextNode->Peer;
 237         }
 238     }
 239
 240     ACPI_MEM_TRACKING (AcpiGbl_NsNodeList->TotalFreed++);
 241
 242     /* Detach an object if there is one, then delete the node */
 243
 244     AcpiNsDetachObject (Node);
 245     (void) AcpiOsReleaseObject (AcpiGbl_NamespaceCache, Node);
 246     return_VOID;
 247 }
 248
 249
 250 /*******************************************************************************
 251  *
 252  * FUNCTION:    AcpiNsInstallNode
 253  *
 254  * PARAMETERS:  WalkState       - Current state of the walk
 255  *              ParentNode      - The parent of the new Node
 256  *              Node            - The new Node to install
 257  *              Type            - ACPI object type of the new Node
 258  *
 259  * RETURN:      None
 260  *
 261  * DESCRIPTION: Initialize a new namespace node and install it amongst
 262  *              its peers.
 263  *
 264  *              Note: Current namespace lookup is linear search. This appears
 265  *              to be sufficient as namespace searches consume only a small
 266  *              fraction of the execution time of the ACPI subsystem.
 267  *
 268  ******************************************************************************/
 269
 270 void
 271 AcpiNsInstallNode (
 272     ACPI_WALK_STATE         *WalkState,
 273     ACPI_NAMESPACE_NODE     *ParentNode,    /* Parent */
 274     ACPI_NAMESPACE_NODE     *Node,          /* New Child*/
 275     ACPI_OBJECT_TYPE        Type)
 276 {
 277     ACPI_OWNER_ID           OwnerId = 0;
 278     ACPI_NAMESPACE_NODE     *ChildNode;
 279
 280
 281     ACPI_FUNCTION_TRACE (NsInstallNode);
 282
 283
 284     /*
 285      * Get the owner ID from the Walk state. The owner ID is used to track
 286      * table deletion and deletion of objects created by methods.
 287      */
 288     if (WalkState)
 289     {
 290         OwnerId = WalkState->OwnerId;
 291     }
 292
 293     /* Link the new entry into the parent and existing children */
 294
 295     ChildNode = ParentNode->Child;
 296     if (!ChildNode)
 297     {
 298         ParentNode->Child = Node;
 299         Node->Flags |= ANOBJ_END_OF_PEER_LIST;
 300         Node->Peer = ParentNode;
 301     }
 302     else
 303     {
 304         while (!(ChildNode->Flags & ANOBJ_END_OF_PEER_LIST))
 305         {
 306             ChildNode = ChildNode->Peer;
 307         }
 308
 309         ChildNode->Peer = Node;
 310
 311         /* Clear end-of-list flag */
 312
 313         ChildNode->Flags &= ~ANOBJ_END_OF_PEER_LIST;
 314         Node->Flags |= ANOBJ_END_OF_PEER_LIST;
 315         Node->Peer = ParentNode;
 316     }
 317
 318     /* Init the new entry */
 319
 320     Node->OwnerId = OwnerId;
 321     Node->Type = (UINT8) Type;
 322
 323     ACPI_DEBUG_PRINT ((ACPI_DB_NAMES,
 324         "%4.4s (%s) [Node %p Owner %X] added to %4.4s (%s) [Node %p]\n",
 325         AcpiUtGetNodeName (Node), AcpiUtGetTypeName (Node->Type), Node, OwnerId,
 326         AcpiUtGetNodeName (ParentNode), AcpiUtGetTypeName (ParentNode->Type),
 327         ParentNode));
 328
 329     return_VOID;
 330 }
 331
 332
 333 /*******************************************************************************
 334  *
 335  * FUNCTION:    AcpiNsDeleteChildren
 336  *
 337  * PARAMETERS:  ParentNode      - Delete this objects children
 338  *
 339  * RETURN:      None.
 340  *
 341  * DESCRIPTION: Delete all children of the parent object. In other words,
 342  *              deletes a "scope".
 343  *
 344  ******************************************************************************/
 345
 346 void
 347 AcpiNsDeleteChildren (
 348     ACPI_NAMESPACE_NODE     *ParentNode)
 349 {
 350     ACPI_NAMESPACE_NODE     *ChildNode;
 351     ACPI_NAMESPACE_NODE     *NextNode;
 352     UINT8                   Flags;
 353
 354
 355     ACPI_FUNCTION_TRACE_PTR (NsDeleteChildren, ParentNode);
 356
 357
 358     if (!ParentNode)
 359     {
 360         return_VOID;
 361     }
 362
 363     /* If no children, all done! */
 364
 365     ChildNode = ParentNode->Child;
 366     if (!ChildNode)
 367     {
 368         return_VOID;
 369     }
 370
 371     /* Deallocate all children at this level */
 372
 373     do
 374     {
 375         /* Get the things we need */
 376
 377         NextNode = ChildNode->Peer;
 378         Flags = ChildNode->Flags;
 379
 380         /* Grandchildren should have all been deleted already */
 381
 382         if (ChildNode->Child)
 383         {
 384             ACPI_ERROR ((AE_INFO, "Found a grandchild! P=%p C=%p",
 385                 ParentNode, ChildNode));
 386         }
 387
 388         /* Now we can free this child object */
 389
 390         ACPI_MEM_TRACKING (AcpiGbl_NsNodeList->TotalFreed++);
 391
 392         ACPI_DEBUG_PRINT ((ACPI_DB_ALLOCATIONS, "Object %p, Remaining %X\n",
 393             ChildNode, AcpiGbl_CurrentNodeCount));
 394
 395         /* Detach an object if there is one, then free the child node */
 396
 397         AcpiNsDetachObject (ChildNode);
 398
 399         /* Now we can delete the node */
 400
 401         (void) AcpiOsReleaseObject (AcpiGbl_NamespaceCache, ChildNode);
 402
 403         /* And move on to the next child in the list */
 404
 405         ChildNode = NextNode;
 406
 407     } while (!(Flags & ANOBJ_END_OF_PEER_LIST));
 408
 409     /* Clear the parent's child pointer */
 410
 411     ParentNode->Child = NULL;
 412     return_VOID;
 413 }
 414
 415
 416 /*******************************************************************************
 417  *
 418  * FUNCTION:    AcpiNsDeleteNamespaceSubtree
 419  *
 420  * PARAMETERS:  ParentNode      - Root of the subtree to be deleted
 421  *
 422  * RETURN:      None.
 423  *
 424  * DESCRIPTION: Delete a subtree of the namespace.  This includes all objects
 425  *              stored within the subtree.
 426  *
 427  ******************************************************************************/
 428
 429 void
 430 AcpiNsDeleteNamespaceSubtree (
 431     ACPI_NAMESPACE_NODE     *ParentNode)
 432 {
 433     ACPI_NAMESPACE_NODE     *ChildNode = NULL;
 434     UINT32                  Level = 1;
 435
 436
 437     ACPI_FUNCTION_TRACE (NsDeleteNamespaceSubtree);
 438
 439
 440     if (!ParentNode)
 441     {
 442         return_VOID;
 443     }
 444
 445     /*
 446      * Traverse the tree of objects until we bubble back up
 447      * to where we started.
 448      */
 449     while (Level > 0)
 450     {
 451         /* Get the next node in this scope (NULL if none) */
 452
 453         ChildNode = AcpiNsGetNextNode (ParentNode, ChildNode);
 454         if (ChildNode)
 455         {
 456             /* Found a child node - detach any attached object */
 457
 458             AcpiNsDetachObject (ChildNode);
 459
 460             /* Check if this node has any children */
 461
 462             if (ChildNode->Child)
 463             {
 464                 /*
 465                  * There is at least one child of this node,
 466                  * visit the node
 467                  */
 468                 Level++;
 469                 ParentNode = ChildNode;
 470                 ChildNode  = NULL;
 471             }
 472         }
 473         else
 474         {
 475             /*
 476              * No more children of this parent node.
 477              * Move up to the grandparent.
 478              */
 479             Level--;
 480
 481             /*
 482              * Now delete all of the children of this parent
 483              * all at the same time.
 484              */
 485             AcpiNsDeleteChildren (ParentNode);
 486
 487             /* New "last child" is this parent node */
 488
 489             ChildNode = ParentNode;
 490
 491             /* Move up the tree to the grandparent */
 492
 493             ParentNode = AcpiNsGetParentNode (ParentNode);
 494         }
 495     }
 496
 497     return_VOID;
 498 }
 499
 500
 501 /*******************************************************************************
 502  *
 503  * FUNCTION:    AcpiNsDeleteNamespaceByOwner
 504  *
 505  * PARAMETERS:  OwnerId     - All nodes with this owner will be deleted
 506  *
 507  * RETURN:      Status
 508  *
 509  * DESCRIPTION: Delete entries within the namespace that are owned by a
 510  *              specific ID.  Used to delete entire ACPI tables.  All
 511  *              reference counts are updated.
 512  *
 513  * MUTEX:       Locks namespace during deletion walk.
 514  *
 515  ******************************************************************************/
 516
 517 void
 518 AcpiNsDeleteNamespaceByOwner (
 519     ACPI_OWNER_ID            OwnerId)
 520 {
 521     ACPI_NAMESPACE_NODE     *ChildNode;
 522     ACPI_NAMESPACE_NODE     *DeletionNode;
 523     ACPI_NAMESPACE_NODE     *ParentNode;
 524     UINT32                  Level;
 525     ACPI_STATUS             Status;
 526
 527
 528     ACPI_FUNCTION_TRACE_U32 (NsDeleteNamespaceByOwner, OwnerId);
 529
 530
 531     if (OwnerId == 0)
 532     {
 533         return_VOID;
 534     }
 535
 536     /* Lock namespace for possible update */
 537
 538     Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
 539     if (ACPI_FAILURE (Status))
 540     {
 541         return_VOID;
 542     }
 543
 544     DeletionNode = NULL;
 545     ParentNode = AcpiGbl_RootNode;
 546     ChildNode = NULL;
 547     Level = 1;
 548
 549     /*
 550      * Traverse the tree of nodes until we bubble back up
 551      * to where we started.
 552      */
 553     while (Level > 0)
 554     {
 555         /*
 556          * Get the next child of this parent node. When ChildNode is NULL,
 557          * the first child of the parent is returned
 558          */
 559         ChildNode = AcpiNsGetNextNode (ParentNode, ChildNode);
 560
 561         if (DeletionNode)
 562         {
 563             AcpiNsDeleteChildren (DeletionNode);
 564             AcpiNsDeleteNode (DeletionNode);
 565             DeletionNode = NULL;
 566         }
 567
 568         if (ChildNode)
 569         {
 570             if (ChildNode->OwnerId == OwnerId)
 571             {
 572                 /* Found a matching child node - detach any attached object */
 573
 574                 AcpiNsDetachObject (ChildNode);
 575             }
 576
 577             /* Check if this node has any children */
 578
 579             if (ChildNode->Child)
 580             {
 581                 /*
 582                  * There is at least one child of this node,
 583                  * visit the node
 584                  */
 585                 Level++;
 586                 ParentNode = ChildNode;
 587                 ChildNode  = NULL;
 588             }
 589             else if (ChildNode->OwnerId == OwnerId)
 590             {
 591                 DeletionNode = ChildNode;
 592             }
 593         }
 594         else
 595         {
 596             /*
 597              * No more children of this parent node.
 598              * Move up to the grandparent.
 599              */
 600             Level--;
 601             if (Level != 0)
 602             {
 603                 if (ParentNode->OwnerId == OwnerId)
 604                 {
 605                     DeletionNode = ParentNode;
 606                 }
 607             }
 608
 609             /* New "last child" is this parent node */
 610
 611             ChildNode = ParentNode;
 612
 613             /* Move up the tree to the grandparent */
 614
 615             ParentNode = AcpiNsGetParentNode (ParentNode);
 616         }
 617     }
 618
 619     (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
 620     return_VOID;
 621 }
 622
 623