1 /*******************************************************************************
3 * Module Name: utdelete - object deletion and reference count utilities
5 ******************************************************************************/
8 * Copyright (C) 2000 - 2012, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
44 #define __UTDELETE_C__
53 #define _COMPONENT ACPI_UTILITIES
54 ACPI_MODULE_NAME ("utdelete")
56 /* Local prototypes */
59 AcpiUtDeleteInternalObj (
60 ACPI_OPERAND_OBJECT *Object);
63 AcpiUtUpdateRefCount (
64 ACPI_OPERAND_OBJECT *Object,
68 /*******************************************************************************
70 * FUNCTION: AcpiUtDeleteInternalObj
72 * PARAMETERS: Object - Object to be deleted
76 * DESCRIPTION: Low level object deletion, after reference counts have been
77 * updated (All reference counts, including sub-objects!)
79 ******************************************************************************/
82 AcpiUtDeleteInternalObj (
83 ACPI_OPERAND_OBJECT *Object)
85 void *ObjPointer = NULL;
86 ACPI_OPERAND_OBJECT *HandlerDesc;
87 ACPI_OPERAND_OBJECT *SecondDesc;
88 ACPI_OPERAND_OBJECT *NextDesc;
89 ACPI_OPERAND_OBJECT **LastObjPtr;
92 ACPI_FUNCTION_TRACE_PTR (UtDeleteInternalObj, Object);
101 * Must delete or free any pointers within the object that are not
102 * actual ACPI objects (for example, a raw buffer pointer).
104 switch (Object->Common.Type)
106 case ACPI_TYPE_STRING:
108 ACPI_DEBUG_PRINT ((ACPI_DB_ALLOCATIONS, "**** String %p, ptr %p\n",
109 Object, Object->String.Pointer));
111 /* Free the actual string buffer */
113 if (!(Object->Common.Flags & AOPOBJ_STATIC_POINTER))
115 /* But only if it is NOT a pointer into an ACPI table */
117 ObjPointer = Object->String.Pointer;
122 case ACPI_TYPE_BUFFER:
124 ACPI_DEBUG_PRINT ((ACPI_DB_ALLOCATIONS, "**** Buffer %p, ptr %p\n",
125 Object, Object->Buffer.Pointer));
127 /* Free the actual buffer */
129 if (!(Object->Common.Flags & AOPOBJ_STATIC_POINTER))
131 /* But only if it is NOT a pointer into an ACPI table */
133 ObjPointer = Object->Buffer.Pointer;
138 case ACPI_TYPE_PACKAGE:
140 ACPI_DEBUG_PRINT ((ACPI_DB_ALLOCATIONS, " **** Package of count %X\n",
141 Object->Package.Count));
144 * Elements of the package are not handled here, they are deleted
148 /* Free the (variable length) element pointer array */
150 ObjPointer = Object->Package.Elements;
155 * These objects have a possible list of notify handlers.
156 * Device object also may have a GPE block.
158 case ACPI_TYPE_DEVICE:
160 if (Object->Device.GpeBlock)
162 (void) AcpiEvDeleteGpeBlock (Object->Device.GpeBlock);
165 /*lint -fallthrough */
167 case ACPI_TYPE_PROCESSOR:
168 case ACPI_TYPE_THERMAL:
170 /* Walk the notify handler list for this object */
172 HandlerDesc = Object->CommonNotify.Handler;
175 NextDesc = HandlerDesc->AddressSpace.Next;
176 AcpiUtRemoveReference (HandlerDesc);
177 HandlerDesc = NextDesc;
182 case ACPI_TYPE_MUTEX:
184 ACPI_DEBUG_PRINT ((ACPI_DB_ALLOCATIONS,
185 "***** Mutex %p, OS Mutex %p\n",
186 Object, Object->Mutex.OsMutex));
188 if (Object == AcpiGbl_GlobalLockMutex)
190 /* Global Lock has extra semaphore */
192 (void) AcpiOsDeleteSemaphore (AcpiGbl_GlobalLockSemaphore);
193 AcpiGbl_GlobalLockSemaphore = NULL;
195 AcpiOsDeleteMutex (Object->Mutex.OsMutex);
196 AcpiGbl_GlobalLockMutex = NULL;
200 AcpiExUnlinkMutex (Object);
201 AcpiOsDeleteMutex (Object->Mutex.OsMutex);
206 case ACPI_TYPE_EVENT:
208 ACPI_DEBUG_PRINT ((ACPI_DB_ALLOCATIONS,
209 "***** Event %p, OS Semaphore %p\n",
210 Object, Object->Event.OsSemaphore));
212 (void) AcpiOsDeleteSemaphore (Object->Event.OsSemaphore);
213 Object->Event.OsSemaphore = NULL;
217 case ACPI_TYPE_METHOD:
219 ACPI_DEBUG_PRINT ((ACPI_DB_ALLOCATIONS,
220 "***** Method %p\n", Object));
222 /* Delete the method mutex if it exists */
224 if (Object->Method.Mutex)
226 AcpiOsDeleteMutex (Object->Method.Mutex->Mutex.OsMutex);
227 AcpiUtDeleteObjectDesc (Object->Method.Mutex);
228 Object->Method.Mutex = NULL;
233 case ACPI_TYPE_REGION:
235 ACPI_DEBUG_PRINT ((ACPI_DB_ALLOCATIONS,
236 "***** Region %p\n", Object));
239 * Update AddressRange list. However, only permanent regions
240 * are installed in this list. (Not created within a method)
242 if (!(Object->Region.Node->Flags & ANOBJ_TEMPORARY))
244 AcpiUtRemoveAddressRange (Object->Region.SpaceId,
245 Object->Region.Node);
248 SecondDesc = AcpiNsGetSecondaryObject (Object);
252 * Free the RegionContext if and only if the handler is one of the
253 * default handlers -- and therefore, we created the context object
254 * locally, it was not created by an external caller.
256 HandlerDesc = Object->Region.Handler;
259 NextDesc = HandlerDesc->AddressSpace.RegionList;
260 LastObjPtr = &HandlerDesc->AddressSpace.RegionList;
262 /* Remove the region object from the handler's list */
266 if (NextDesc == Object)
268 *LastObjPtr = NextDesc->Region.Next;
272 /* Walk the linked list of handler */
274 LastObjPtr = &NextDesc->Region.Next;
275 NextDesc = NextDesc->Region.Next;
278 if (HandlerDesc->AddressSpace.HandlerFlags &
279 ACPI_ADDR_HANDLER_DEFAULT_INSTALLED)
281 /* Deactivate region and free region context */
283 if (HandlerDesc->AddressSpace.Setup)
285 (void) HandlerDesc->AddressSpace.Setup (Object,
286 ACPI_REGION_DEACTIVATE,
287 HandlerDesc->AddressSpace.Context,
288 &SecondDesc->Extra.RegionContext);
292 AcpiUtRemoveReference (HandlerDesc);
295 /* Now we can free the Extra object */
297 AcpiUtDeleteObjectDesc (SecondDesc);
302 case ACPI_TYPE_BUFFER_FIELD:
304 ACPI_DEBUG_PRINT ((ACPI_DB_ALLOCATIONS,
305 "***** Buffer Field %p\n", Object));
307 SecondDesc = AcpiNsGetSecondaryObject (Object);
310 AcpiUtDeleteObjectDesc (SecondDesc);
315 case ACPI_TYPE_LOCAL_BANK_FIELD:
317 ACPI_DEBUG_PRINT ((ACPI_DB_ALLOCATIONS,
318 "***** Bank Field %p\n", Object));
320 SecondDesc = AcpiNsGetSecondaryObject (Object);
323 AcpiUtDeleteObjectDesc (SecondDesc);
332 /* Free any allocated memory (pointer within the object) found above */
336 ACPI_DEBUG_PRINT ((ACPI_DB_ALLOCATIONS, "Deleting Object Subptr %p\n",
338 ACPI_FREE (ObjPointer);
341 /* Now the object can be safely deleted */
343 ACPI_DEBUG_PRINT ((ACPI_DB_ALLOCATIONS, "Deleting Object %p [%s]\n",
344 Object, AcpiUtGetObjectTypeName (Object)));
346 AcpiUtDeleteObjectDesc (Object);
351 /*******************************************************************************
353 * FUNCTION: AcpiUtDeleteInternalObjectList
355 * PARAMETERS: ObjList - Pointer to the list to be deleted
359 * DESCRIPTION: This function deletes an internal object list, including both
360 * simple objects and package objects
362 ******************************************************************************/
365 AcpiUtDeleteInternalObjectList (
366 ACPI_OPERAND_OBJECT **ObjList)
368 ACPI_OPERAND_OBJECT **InternalObj;
371 ACPI_FUNCTION_TRACE (UtDeleteInternalObjectList);
374 /* Walk the null-terminated internal list */
376 for (InternalObj = ObjList; *InternalObj; InternalObj++)
378 AcpiUtRemoveReference (*InternalObj);
381 /* Free the combined parameter pointer list and object array */
388 /*******************************************************************************
390 * FUNCTION: AcpiUtUpdateRefCount
392 * PARAMETERS: Object - Object whose ref count is to be updated
393 * Action - What to do
395 * RETURN: New ref count
397 * DESCRIPTION: Modify the ref count and return it.
399 ******************************************************************************/
402 AcpiUtUpdateRefCount (
403 ACPI_OPERAND_OBJECT *Object,
410 ACPI_FUNCTION_NAME (UtUpdateRefCount);
418 Count = Object->Common.ReferenceCount;
422 * Perform the reference count action (increment, decrement, force delete)
429 Object->Common.ReferenceCount = NewCount;
431 ACPI_DEBUG_PRINT ((ACPI_DB_ALLOCATIONS,
432 "Obj %p Refs=%X, [Incremented]\n",
440 ACPI_DEBUG_PRINT ((ACPI_DB_ALLOCATIONS,
441 "Obj %p Refs=%X, can't decrement! (Set to 0)\n",
450 ACPI_DEBUG_PRINT ((ACPI_DB_ALLOCATIONS,
451 "Obj %p Refs=%X, [Decremented]\n",
455 if (Object->Common.Type == ACPI_TYPE_METHOD)
457 ACPI_DEBUG_PRINT ((ACPI_DB_ALLOCATIONS,
458 "Method Obj %p Refs=%X, [Decremented]\n", Object, NewCount));
461 Object->Common.ReferenceCount = NewCount;
464 AcpiUtDeleteInternalObj (Object);
468 case REF_FORCE_DELETE:
470 ACPI_DEBUG_PRINT ((ACPI_DB_ALLOCATIONS,
471 "Obj %p Refs=%X, Force delete! (Set to 0)\n", Object, Count));
474 Object->Common.ReferenceCount = NewCount;
475 AcpiUtDeleteInternalObj (Object);
480 ACPI_ERROR ((AE_INFO, "Unknown action (0x%X)", Action));
485 * Sanity check the reference count, for debug purposes only.
486 * (A deleted object will have a huge reference count)
488 if (Count > ACPI_MAX_REFERENCE_COUNT)
490 ACPI_WARNING ((AE_INFO,
491 "Large Reference Count (0x%X) in object %p", Count, Object));
496 /*******************************************************************************
498 * FUNCTION: AcpiUtUpdateObjectReference
500 * PARAMETERS: Object - Increment ref count for this object
501 * and all sub-objects
502 * Action - Either REF_INCREMENT or REF_DECREMENT or
507 * DESCRIPTION: Increment the object reference count
509 * Object references are incremented when:
510 * 1) An object is attached to a Node (namespace object)
511 * 2) An object is copied (all subobjects must be incremented)
513 * Object references are decremented when:
514 * 1) An object is detached from an Node
516 ******************************************************************************/
519 AcpiUtUpdateObjectReference (
520 ACPI_OPERAND_OBJECT *Object,
523 ACPI_STATUS Status = AE_OK;
524 ACPI_GENERIC_STATE *StateList = NULL;
525 ACPI_OPERAND_OBJECT *NextObject = NULL;
526 ACPI_GENERIC_STATE *State;
530 ACPI_FUNCTION_TRACE_PTR (UtUpdateObjectReference, Object);
535 /* Make sure that this isn't a namespace handle */
537 if (ACPI_GET_DESCRIPTOR_TYPE (Object) == ACPI_DESC_TYPE_NAMED)
539 ACPI_DEBUG_PRINT ((ACPI_DB_ALLOCATIONS,
540 "Object %p is NS handle\n", Object));
541 return_ACPI_STATUS (AE_OK);
545 * All sub-objects must have their reference count incremented also.
546 * Different object types have different subobjects.
548 switch (Object->Common.Type)
550 case ACPI_TYPE_DEVICE:
551 case ACPI_TYPE_PROCESSOR:
552 case ACPI_TYPE_POWER:
553 case ACPI_TYPE_THERMAL:
555 /* Update the notify objects for these types (if present) */
557 AcpiUtUpdateRefCount (Object->CommonNotify.SystemNotify, Action);
558 AcpiUtUpdateRefCount (Object->CommonNotify.DeviceNotify, Action);
561 case ACPI_TYPE_PACKAGE:
563 * We must update all the sub-objects of the package,
564 * each of whom may have their own sub-objects.
566 for (i = 0; i < Object->Package.Count; i++)
569 * Push each element onto the stack for later processing.
570 * Note: There can be null elements within the package,
571 * these are simply ignored
573 Status = AcpiUtCreateUpdateStateAndPush (
574 Object->Package.Elements[i], Action, &StateList);
575 if (ACPI_FAILURE (Status))
582 case ACPI_TYPE_BUFFER_FIELD:
584 NextObject = Object->BufferField.BufferObj;
587 case ACPI_TYPE_LOCAL_REGION_FIELD:
589 NextObject = Object->Field.RegionObj;
592 case ACPI_TYPE_LOCAL_BANK_FIELD:
594 NextObject = Object->BankField.BankObj;
595 Status = AcpiUtCreateUpdateStateAndPush (
596 Object->BankField.RegionObj, Action, &StateList);
597 if (ACPI_FAILURE (Status))
603 case ACPI_TYPE_LOCAL_INDEX_FIELD:
605 NextObject = Object->IndexField.IndexObj;
606 Status = AcpiUtCreateUpdateStateAndPush (
607 Object->IndexField.DataObj, Action, &StateList);
608 if (ACPI_FAILURE (Status))
614 case ACPI_TYPE_LOCAL_REFERENCE:
616 * The target of an Index (a package, string, or buffer) or a named
617 * reference must track changes to the ref count of the index or
620 if ((Object->Reference.Class == ACPI_REFCLASS_INDEX) ||
621 (Object->Reference.Class== ACPI_REFCLASS_NAME))
623 NextObject = Object->Reference.Object;
627 case ACPI_TYPE_REGION:
629 break; /* No subobjects for all other types */
633 * Now we can update the count in the main object. This can only
634 * happen after we update the sub-objects in case this causes the
635 * main object to be deleted.
637 AcpiUtUpdateRefCount (Object, Action);
640 /* Move on to the next object to be updated */
649 State = AcpiUtPopGenericState (&StateList);
650 Object = State->Update.Object;
651 AcpiUtDeleteGenericState (State);
655 return_ACPI_STATUS (AE_OK);
660 ACPI_EXCEPTION ((AE_INFO, Status,
661 "Could not update object reference count"));
663 /* Free any stacked Update State objects */
667 State = AcpiUtPopGenericState (&StateList);
668 AcpiUtDeleteGenericState (State);
671 return_ACPI_STATUS (Status);
675 /*******************************************************************************
677 * FUNCTION: AcpiUtAddReference
679 * PARAMETERS: Object - Object whose reference count is to be
684 * DESCRIPTION: Add one reference to an ACPI object
686 ******************************************************************************/
690 ACPI_OPERAND_OBJECT *Object)
693 ACPI_FUNCTION_TRACE_PTR (UtAddReference, Object);
696 /* Ensure that we have a valid object */
698 if (!AcpiUtValidInternalObject (Object))
703 ACPI_DEBUG_PRINT ((ACPI_DB_ALLOCATIONS,
704 "Obj %p Current Refs=%X [To Be Incremented]\n",
705 Object, Object->Common.ReferenceCount));
707 /* Increment the reference count */
709 (void) AcpiUtUpdateObjectReference (Object, REF_INCREMENT);
714 /*******************************************************************************
716 * FUNCTION: AcpiUtRemoveReference
718 * PARAMETERS: Object - Object whose ref count will be decremented
722 * DESCRIPTION: Decrement the reference count of an ACPI internal object
724 ******************************************************************************/
727 AcpiUtRemoveReference (
728 ACPI_OPERAND_OBJECT *Object)
731 ACPI_FUNCTION_TRACE_PTR (UtRemoveReference, Object);
735 * Allow a NULL pointer to be passed in, just ignore it. This saves
736 * each caller from having to check. Also, ignore NS nodes.
740 (ACPI_GET_DESCRIPTOR_TYPE (Object) == ACPI_DESC_TYPE_NAMED))
746 /* Ensure that we have a valid object */
748 if (!AcpiUtValidInternalObject (Object))
753 ACPI_DEBUG_PRINT ((ACPI_DB_ALLOCATIONS,
754 "Obj %p Current Refs=%X [To Be Decremented]\n",
755 Object, Object->Common.ReferenceCount));
758 * Decrement the reference count, and only actually delete the object
759 * if the reference count becomes 0. (Must also decrement the ref count
760 * of all subobjects!)
762 (void) AcpiUtUpdateObjectReference (Object, REF_DECREMENT);