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 - 2018, 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 * Alternatively, you may choose to be licensed under the terms of the 117 * following license: 118 * 119 * Redistribution and use in source and binary forms, with or without 120 * modification, are permitted provided that the following conditions 121 * are met: 122 * 1. Redistributions of source code must retain the above copyright 123 * notice, this list of conditions, and the following disclaimer, 124 * without modification. 125 * 2. Redistributions in binary form must reproduce at minimum a disclaimer 126 * substantially similar to the "NO WARRANTY" disclaimer below 127 * ("Disclaimer") and any redistribution must be conditioned upon 128 * including a substantially similar Disclaimer requirement for further 129 * binary redistribution. 130 * 3. Neither the names of the above-listed copyright holders nor the names 131 * of any contributors may be used to endorse or promote products derived 132 * from this software without specific prior written permission. 133 * 134 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 135 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 136 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 137 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 138 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 139 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 140 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 141 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 142 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 143 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 144 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 145 * 146 * Alternatively, you may choose to be licensed under the terms of the 147 * GNU General Public License ("GPL") version 2 as published by the Free 148 * Software Foundation. 149 * 150 *****************************************************************************/ 151 152 #include "acpi.h" 153 #include "accommon.h" 154 #include "acnamesp.h" 155 156 157 #define _COMPONENT ACPI_NAMESPACE 158 ACPI_MODULE_NAME ("nsalloc") 159 160 161 /******************************************************************************* 162 * 163 * FUNCTION: AcpiNsCreateNode 164 * 165 * PARAMETERS: Name - Name of the new node (4 char ACPI name) 166 * 167 * RETURN: New namespace node (Null on failure) 168 * 169 * DESCRIPTION: Create a namespace node 170 * 171 ******************************************************************************/ 172 173 ACPI_NAMESPACE_NODE * 174 AcpiNsCreateNode ( 175 UINT32 Name) 176 { 177 ACPI_NAMESPACE_NODE *Node; 178 #ifdef ACPI_DBG_TRACK_ALLOCATIONS 179 UINT32 Temp; 180 #endif 181 182 183 ACPI_FUNCTION_TRACE (NsCreateNode); 184 185 186 Node = AcpiOsAcquireObject (AcpiGbl_NamespaceCache); 187 if (!Node) 188 { 189 return_PTR (NULL); 190 } 191 192 ACPI_MEM_TRACKING (AcpiGbl_NsNodeList->TotalAllocated++); 193 194 #ifdef ACPI_DBG_TRACK_ALLOCATIONS 195 Temp = AcpiGbl_NsNodeList->TotalAllocated - 196 AcpiGbl_NsNodeList->TotalFreed; 197 if (Temp > AcpiGbl_NsNodeList->MaxOccupied) 198 { 199 AcpiGbl_NsNodeList->MaxOccupied = Temp; 200 } 201 #endif 202 203 Node->Name.Integer = Name; 204 ACPI_SET_DESCRIPTOR_TYPE (Node, ACPI_DESC_TYPE_NAMED); 205 return_PTR (Node); 206 } 207 208 209 /******************************************************************************* 210 * 211 * FUNCTION: AcpiNsDeleteNode 212 * 213 * PARAMETERS: Node - Node to be deleted 214 * 215 * RETURN: None 216 * 217 * DESCRIPTION: Delete a namespace node. All node deletions must come through 218 * here. Detaches any attached objects, including any attached 219 * data. If a handler is associated with attached data, it is 220 * invoked before the node is deleted. 221 * 222 ******************************************************************************/ 223 224 void 225 AcpiNsDeleteNode ( 226 ACPI_NAMESPACE_NODE *Node) 227 { 228 ACPI_OPERAND_OBJECT *ObjDesc; 229 ACPI_OPERAND_OBJECT *NextDesc; 230 231 232 ACPI_FUNCTION_NAME (NsDeleteNode); 233 234 235 /* Detach an object if there is one */ 236 237 AcpiNsDetachObject (Node); 238 239 /* 240 * Delete an attached data object list if present (objects that were 241 * attached via AcpiAttachData). Note: After any normal object is 242 * detached above, the only possible remaining object(s) are data 243 * objects, in a linked list. 244 */ 245 ObjDesc = Node->Object; 246 while (ObjDesc && 247 (ObjDesc->Common.Type == ACPI_TYPE_LOCAL_DATA)) 248 { 249 /* Invoke the attached data deletion handler if present */ 250 251 if (ObjDesc->Data.Handler) 252 { 253 ObjDesc->Data.Handler (Node, ObjDesc->Data.Pointer); 254 } 255 256 NextDesc = ObjDesc->Common.NextObject; 257 AcpiUtRemoveReference (ObjDesc); 258 ObjDesc = NextDesc; 259 } 260 261 /* Special case for the statically allocated root node */ 262 263 if (Node == AcpiGbl_RootNode) 264 { 265 return; 266 } 267 268 /* Now we can delete the node */ 269 270 (void) AcpiOsReleaseObject (AcpiGbl_NamespaceCache, Node); 271 272 ACPI_MEM_TRACKING (AcpiGbl_NsNodeList->TotalFreed++); 273 ACPI_DEBUG_PRINT ((ACPI_DB_ALLOCATIONS, "Node %p, Remaining %X\n", 274 Node, AcpiGbl_CurrentNodeCount)); 275 } 276 277 278 /******************************************************************************* 279 * 280 * FUNCTION: AcpiNsRemoveNode 281 * 282 * PARAMETERS: Node - Node to be removed/deleted 283 * 284 * RETURN: None 285 * 286 * DESCRIPTION: Remove (unlink) and delete a namespace node 287 * 288 ******************************************************************************/ 289 290 void 291 AcpiNsRemoveNode ( 292 ACPI_NAMESPACE_NODE *Node) 293 { 294 ACPI_NAMESPACE_NODE *ParentNode; 295 ACPI_NAMESPACE_NODE *PrevNode; 296 ACPI_NAMESPACE_NODE *NextNode; 297 298 299 ACPI_FUNCTION_TRACE_PTR (NsRemoveNode, Node); 300 301 302 ParentNode = Node->Parent; 303 304 PrevNode = NULL; 305 NextNode = ParentNode->Child; 306 307 /* Find the node that is the previous peer in the parent's child list */ 308 309 while (NextNode != Node) 310 { 311 PrevNode = NextNode; 312 NextNode = NextNode->Peer; 313 } 314 315 if (PrevNode) 316 { 317 /* Node is not first child, unlink it */ 318 319 PrevNode->Peer = Node->Peer; 320 } 321 else 322 { 323 /* 324 * Node is first child (has no previous peer). 325 * Link peer list to parent 326 */ 327 ParentNode->Child = Node->Peer; 328 } 329 330 /* Delete the node and any attached objects */ 331 332 AcpiNsDeleteNode (Node); 333 return_VOID; 334 } 335 336 337 /******************************************************************************* 338 * 339 * FUNCTION: AcpiNsInstallNode 340 * 341 * PARAMETERS: WalkState - Current state of the walk 342 * ParentNode - The parent of the new Node 343 * Node - The new Node to install 344 * Type - ACPI object type of the new Node 345 * 346 * RETURN: None 347 * 348 * DESCRIPTION: Initialize a new namespace node and install it amongst 349 * its peers. 350 * 351 * Note: Current namespace lookup is linear search. This appears 352 * to be sufficient as namespace searches consume only a small 353 * fraction of the execution time of the ACPI subsystem. 354 * 355 ******************************************************************************/ 356 357 void 358 AcpiNsInstallNode ( 359 ACPI_WALK_STATE *WalkState, 360 ACPI_NAMESPACE_NODE *ParentNode, /* Parent */ 361 ACPI_NAMESPACE_NODE *Node, /* New Child*/ 362 ACPI_OBJECT_TYPE Type) 363 { 364 ACPI_OWNER_ID OwnerId = 0; 365 ACPI_NAMESPACE_NODE *ChildNode; 366 367 368 ACPI_FUNCTION_TRACE (NsInstallNode); 369 370 371 if (WalkState) 372 { 373 /* 374 * Get the owner ID from the Walk state. The owner ID is used to 375 * track table deletion and deletion of objects created by methods. 376 */ 377 OwnerId = WalkState->OwnerId; 378 379 if ((WalkState->MethodDesc) && 380 (ParentNode != WalkState->MethodNode)) 381 { 382 /* 383 * A method is creating a new node that is not a child of the 384 * method (it is non-local). Mark the executing method as having 385 * modified the namespace. This is used for cleanup when the 386 * method exits. 387 */ 388 WalkState->MethodDesc->Method.InfoFlags |= 389 ACPI_METHOD_MODIFIED_NAMESPACE; 390 } 391 } 392 393 /* Link the new entry into the parent and existing children */ 394 395 Node->Peer = NULL; 396 Node->Parent = ParentNode; 397 ChildNode = ParentNode->Child; 398 399 if (!ChildNode) 400 { 401 ParentNode->Child = Node; 402 } 403 else 404 { 405 /* Add node to the end of the peer list */ 406 407 while (ChildNode->Peer) 408 { 409 ChildNode = ChildNode->Peer; 410 } 411 412 ChildNode->Peer = Node; 413 } 414 415 /* Init the new entry */ 416 417 Node->OwnerId = OwnerId; 418 Node->Type = (UINT8) Type; 419 420 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, 421 "%4.4s (%s) [Node %p Owner %X] added to %4.4s (%s) [Node %p]\n", 422 AcpiUtGetNodeName (Node), AcpiUtGetTypeName (Node->Type), Node, OwnerId, 423 AcpiUtGetNodeName (ParentNode), AcpiUtGetTypeName (ParentNode->Type), 424 ParentNode)); 425 426 return_VOID; 427 } 428 429 430 /******************************************************************************* 431 * 432 * FUNCTION: AcpiNsDeleteChildren 433 * 434 * PARAMETERS: ParentNode - Delete this objects children 435 * 436 * RETURN: None. 437 * 438 * DESCRIPTION: Delete all children of the parent object. In other words, 439 * deletes a "scope". 440 * 441 ******************************************************************************/ 442 443 void 444 AcpiNsDeleteChildren ( 445 ACPI_NAMESPACE_NODE *ParentNode) 446 { 447 ACPI_NAMESPACE_NODE *NextNode; 448 ACPI_NAMESPACE_NODE *NodeToDelete; 449 450 451 ACPI_FUNCTION_TRACE_PTR (NsDeleteChildren, ParentNode); 452 453 454 if (!ParentNode) 455 { 456 return_VOID; 457 } 458 459 /* Deallocate all children at this level */ 460 461 NextNode = ParentNode->Child; 462 while (NextNode) 463 { 464 /* Grandchildren should have all been deleted already */ 465 466 if (NextNode->Child) 467 { 468 ACPI_ERROR ((AE_INFO, "Found a grandchild! P=%p C=%p", 469 ParentNode, NextNode)); 470 } 471 472 /* 473 * Delete this child node and move on to the next child in the list. 474 * No need to unlink the node since we are deleting the entire branch. 475 */ 476 NodeToDelete = NextNode; 477 NextNode = NextNode->Peer; 478 AcpiNsDeleteNode (NodeToDelete); 479 }; 480 481 /* Clear the parent's child pointer */ 482 483 ParentNode->Child = NULL; 484 return_VOID; 485 } 486 487 488 /******************************************************************************* 489 * 490 * FUNCTION: AcpiNsDeleteNamespaceSubtree 491 * 492 * PARAMETERS: ParentNode - Root of the subtree to be deleted 493 * 494 * RETURN: None. 495 * 496 * DESCRIPTION: Delete a subtree of the namespace. This includes all objects 497 * stored within the subtree. 498 * 499 ******************************************************************************/ 500 501 void 502 AcpiNsDeleteNamespaceSubtree ( 503 ACPI_NAMESPACE_NODE *ParentNode) 504 { 505 ACPI_NAMESPACE_NODE *ChildNode = NULL; 506 UINT32 Level = 1; 507 ACPI_STATUS Status; 508 509 510 ACPI_FUNCTION_TRACE (NsDeleteNamespaceSubtree); 511 512 513 if (!ParentNode) 514 { 515 return_VOID; 516 } 517 518 /* Lock namespace for possible update */ 519 520 Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE); 521 if (ACPI_FAILURE (Status)) 522 { 523 return_VOID; 524 } 525 526 /* 527 * Traverse the tree of objects until we bubble back up 528 * to where we started. 529 */ 530 while (Level > 0) 531 { 532 /* Get the next node in this scope (NULL if none) */ 533 534 ChildNode = AcpiNsGetNextNode (ParentNode, ChildNode); 535 if (ChildNode) 536 { 537 /* Found a child node - detach any attached object */ 538 539 AcpiNsDetachObject (ChildNode); 540 541 /* Check if this node has any children */ 542 543 if (ChildNode->Child) 544 { 545 /* 546 * There is at least one child of this node, 547 * visit the node 548 */ 549 Level++; 550 ParentNode = ChildNode; 551 ChildNode = NULL; 552 } 553 } 554 else 555 { 556 /* 557 * No more children of this parent node. 558 * Move up to the grandparent. 559 */ 560 Level--; 561 562 /* 563 * Now delete all of the children of this parent 564 * all at the same time. 565 */ 566 AcpiNsDeleteChildren (ParentNode); 567 568 /* New "last child" is this parent node */ 569 570 ChildNode = ParentNode; 571 572 /* Move up the tree to the grandparent */ 573 574 ParentNode = ParentNode->Parent; 575 } 576 } 577 578 (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE); 579 return_VOID; 580 } 581 582 583 /******************************************************************************* 584 * 585 * FUNCTION: AcpiNsDeleteNamespaceByOwner 586 * 587 * PARAMETERS: OwnerId - All nodes with this owner will be deleted 588 * 589 * RETURN: Status 590 * 591 * DESCRIPTION: Delete entries within the namespace that are owned by a 592 * specific ID. Used to delete entire ACPI tables. All 593 * reference counts are updated. 594 * 595 * MUTEX: Locks namespace during deletion walk. 596 * 597 ******************************************************************************/ 598 599 void 600 AcpiNsDeleteNamespaceByOwner ( 601 ACPI_OWNER_ID OwnerId) 602 { 603 ACPI_NAMESPACE_NODE *ChildNode; 604 ACPI_NAMESPACE_NODE *DeletionNode; 605 ACPI_NAMESPACE_NODE *ParentNode; 606 UINT32 Level; 607 ACPI_STATUS Status; 608 609 610 ACPI_FUNCTION_TRACE_U32 (NsDeleteNamespaceByOwner, OwnerId); 611 612 613 if (OwnerId == 0) 614 { 615 return_VOID; 616 } 617 618 /* Lock namespace for possible update */ 619 620 Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE); 621 if (ACPI_FAILURE (Status)) 622 { 623 return_VOID; 624 } 625 626 DeletionNode = NULL; 627 ParentNode = AcpiGbl_RootNode; 628 ChildNode = NULL; 629 Level = 1; 630 631 /* 632 * Traverse the tree of nodes until we bubble back up 633 * to where we started. 634 */ 635 while (Level > 0) 636 { 637 /* 638 * Get the next child of this parent node. When ChildNode is NULL, 639 * the first child of the parent is returned 640 */ 641 ChildNode = AcpiNsGetNextNode (ParentNode, ChildNode); 642 643 if (DeletionNode) 644 { 645 AcpiNsDeleteChildren (DeletionNode); 646 AcpiNsRemoveNode (DeletionNode); 647 DeletionNode = NULL; 648 } 649 650 if (ChildNode) 651 { 652 if (ChildNode->OwnerId == OwnerId) 653 { 654 /* Found a matching child node - detach any attached object */ 655 656 AcpiNsDetachObject (ChildNode); 657 } 658 659 /* Check if this node has any children */ 660 661 if (ChildNode->Child) 662 { 663 /* 664 * There is at least one child of this node, 665 * visit the node 666 */ 667 Level++; 668 ParentNode = ChildNode; 669 ChildNode = NULL; 670 } 671 else if (ChildNode->OwnerId == OwnerId) 672 { 673 DeletionNode = ChildNode; 674 } 675 } 676 else 677 { 678 /* 679 * No more children of this parent node. 680 * Move up to the grandparent. 681 */ 682 Level--; 683 if (Level != 0) 684 { 685 if (ParentNode->OwnerId == OwnerId) 686 { 687 DeletionNode = ParentNode; 688 } 689 } 690 691 /* New "last child" is this parent node */ 692 693 ChildNode = ParentNode; 694 695 /* Move up the tree to the grandparent */ 696 697 ParentNode = ParentNode->Parent; 698 } 699 } 700 701 (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE); 702 return_VOID; 703 } 704