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