1 /*******************************************************************************
3 * Module Name: utdelete - object deletion and reference count utilities
5 ******************************************************************************/
8 * Copyright (C) 2000 - 2008, 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 #include <acpi/acpi.h>
45 #include <acpi/acinterp.h>
46 #include <acpi/acnamesp.h>
47 #include <acpi/acevents.h>
48 #include <acpi/amlcode.h>
50 #define _COMPONENT ACPI_UTILITIES
51 ACPI_MODULE_NAME("utdelete")
53 /* Local prototypes */
54 static void acpi_ut_delete_internal_obj(union acpi_operand_object
*object
);
57 acpi_ut_update_ref_count(union acpi_operand_object
*object
, u32 action
);
59 /*******************************************************************************
61 * FUNCTION: acpi_ut_delete_internal_obj
63 * PARAMETERS: Object - Object to be deleted
67 * DESCRIPTION: Low level object deletion, after reference counts have been
68 * updated (All reference counts, including sub-objects!)
70 ******************************************************************************/
72 static void acpi_ut_delete_internal_obj(union acpi_operand_object
*object
)
74 void *obj_pointer
= NULL
;
75 union acpi_operand_object
*handler_desc
;
76 union acpi_operand_object
*second_desc
;
77 union acpi_operand_object
*next_desc
;
79 ACPI_FUNCTION_TRACE_PTR(ut_delete_internal_obj
, object
);
86 * Must delete or free any pointers within the object that are not
87 * actual ACPI objects (for example, a raw buffer pointer).
89 switch (ACPI_GET_OBJECT_TYPE(object
)) {
90 case ACPI_TYPE_STRING
:
92 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
,
93 "**** String %p, ptr %p\n", object
,
94 object
->string
.pointer
));
96 /* Free the actual string buffer */
98 if (!(object
->common
.flags
& AOPOBJ_STATIC_POINTER
)) {
100 /* But only if it is NOT a pointer into an ACPI table */
102 obj_pointer
= object
->string
.pointer
;
106 case ACPI_TYPE_BUFFER
:
108 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
,
109 "**** Buffer %p, ptr %p\n", object
,
110 object
->buffer
.pointer
));
112 /* Free the actual buffer */
114 if (!(object
->common
.flags
& AOPOBJ_STATIC_POINTER
)) {
116 /* But only if it is NOT a pointer into an ACPI table */
118 obj_pointer
= object
->buffer
.pointer
;
122 case ACPI_TYPE_PACKAGE
:
124 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
,
125 " **** Package of count %X\n",
126 object
->package
.count
));
129 * Elements of the package are not handled here, they are deleted
133 /* Free the (variable length) element pointer array */
135 obj_pointer
= object
->package
.elements
;
139 * These objects have a possible list of notify handlers.
140 * Device object also may have a GPE block.
142 case ACPI_TYPE_DEVICE
:
144 if (object
->device
.gpe_block
) {
145 (void)acpi_ev_delete_gpe_block(object
->device
.
149 /*lint -fallthrough */
151 case ACPI_TYPE_PROCESSOR
:
152 case ACPI_TYPE_THERMAL
:
154 /* Walk the notify handler list for this object */
156 handler_desc
= object
->common_notify
.handler
;
157 while (handler_desc
) {
158 next_desc
= handler_desc
->address_space
.next
;
159 acpi_ut_remove_reference(handler_desc
);
160 handler_desc
= next_desc
;
164 case ACPI_TYPE_MUTEX
:
166 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
,
167 "***** Mutex %p, OS Mutex %p\n",
168 object
, object
->mutex
.os_mutex
));
170 if (object
== acpi_gbl_global_lock_mutex
) {
172 /* Global Lock has extra semaphore */
175 acpi_os_delete_semaphore
176 (acpi_gbl_global_lock_semaphore
);
177 acpi_gbl_global_lock_semaphore
= NULL
;
179 acpi_os_delete_mutex(object
->mutex
.os_mutex
);
180 acpi_gbl_global_lock_mutex
= NULL
;
182 acpi_ex_unlink_mutex(object
);
183 acpi_os_delete_mutex(object
->mutex
.os_mutex
);
187 case ACPI_TYPE_EVENT
:
189 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
,
190 "***** Event %p, OS Semaphore %p\n",
191 object
, object
->event
.os_semaphore
));
193 (void)acpi_os_delete_semaphore(object
->event
.os_semaphore
);
194 object
->event
.os_semaphore
= NULL
;
197 case ACPI_TYPE_METHOD
:
199 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
,
200 "***** Method %p\n", object
));
202 /* Delete the method mutex if it exists */
204 if (object
->method
.mutex
) {
205 acpi_os_delete_mutex(object
->method
.mutex
->mutex
.
207 acpi_ut_delete_object_desc(object
->method
.mutex
);
208 object
->method
.mutex
= NULL
;
212 case ACPI_TYPE_REGION
:
214 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
,
215 "***** Region %p\n", object
));
217 second_desc
= acpi_ns_get_secondary_object(object
);
220 * Free the region_context if and only if the handler is one of the
221 * default handlers -- and therefore, we created the context object
222 * locally, it was not created by an external caller.
224 handler_desc
= object
->region
.handler
;
226 if (handler_desc
->address_space
.handler_flags
&
227 ACPI_ADDR_HANDLER_DEFAULT_INSTALLED
) {
229 /* Deactivate region and free region context */
231 if (handler_desc
->address_space
.setup
) {
233 address_space
.setup(object
,
234 ACPI_REGION_DEACTIVATE
,
244 acpi_ut_remove_reference(handler_desc
);
247 /* Now we can free the Extra object */
249 acpi_ut_delete_object_desc(second_desc
);
253 case ACPI_TYPE_BUFFER_FIELD
:
255 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
,
256 "***** Buffer Field %p\n", object
));
258 second_desc
= acpi_ns_get_secondary_object(object
);
260 acpi_ut_delete_object_desc(second_desc
);
264 case ACPI_TYPE_LOCAL_BANK_FIELD
:
266 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
,
267 "***** Bank Field %p\n", object
));
269 second_desc
= acpi_ns_get_secondary_object(object
);
271 acpi_ut_delete_object_desc(second_desc
);
279 /* Free any allocated memory (pointer within the object) found above */
282 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
,
283 "Deleting Object Subptr %p\n", obj_pointer
));
284 ACPI_FREE(obj_pointer
);
287 /* Now the object can be safely deleted */
289 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
, "Deleting Object %p [%s]\n",
290 object
, acpi_ut_get_object_type_name(object
)));
292 acpi_ut_delete_object_desc(object
);
296 /*******************************************************************************
298 * FUNCTION: acpi_ut_delete_internal_object_list
300 * PARAMETERS: obj_list - Pointer to the list to be deleted
304 * DESCRIPTION: This function deletes an internal object list, including both
305 * simple objects and package objects
307 ******************************************************************************/
309 void acpi_ut_delete_internal_object_list(union acpi_operand_object
**obj_list
)
311 union acpi_operand_object
**internal_obj
;
313 ACPI_FUNCTION_TRACE(ut_delete_internal_object_list
);
315 /* Walk the null-terminated internal list */
317 for (internal_obj
= obj_list
; *internal_obj
; internal_obj
++) {
318 acpi_ut_remove_reference(*internal_obj
);
321 /* Free the combined parameter pointer list and object array */
327 /*******************************************************************************
329 * FUNCTION: acpi_ut_update_ref_count
331 * PARAMETERS: Object - Object whose ref count is to be updated
332 * Action - What to do
334 * RETURN: New ref count
336 * DESCRIPTION: Modify the ref count and return it.
338 ******************************************************************************/
341 acpi_ut_update_ref_count(union acpi_operand_object
*object
, u32 action
)
346 ACPI_FUNCTION_NAME(ut_update_ref_count
);
352 count
= object
->common
.reference_count
;
356 * Perform the reference count action (increment, decrement, force delete)
362 object
->common
.reference_count
= new_count
;
364 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
,
365 "Obj %p Refs=%X, [Incremented]\n",
372 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
,
373 "Obj %p Refs=%X, can't decrement! (Set to 0)\n",
380 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
,
381 "Obj %p Refs=%X, [Decremented]\n",
385 if (ACPI_GET_OBJECT_TYPE(object
) == ACPI_TYPE_METHOD
) {
386 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
,
387 "Method Obj %p Refs=%X, [Decremented]\n",
391 object
->common
.reference_count
= new_count
;
392 if (new_count
== 0) {
393 acpi_ut_delete_internal_obj(object
);
397 case REF_FORCE_DELETE
:
399 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
,
400 "Obj %p Refs=%X, Force delete! (Set to 0)\n",
404 object
->common
.reference_count
= new_count
;
405 acpi_ut_delete_internal_obj(object
);
410 ACPI_ERROR((AE_INFO
, "Unknown action (%X)", action
));
415 * Sanity check the reference count, for debug purposes only.
416 * (A deleted object will have a huge reference count)
418 if (count
> ACPI_MAX_REFERENCE_COUNT
) {
419 ACPI_WARNING((AE_INFO
,
420 "Large Reference Count (%X) in object %p", count
,
425 /*******************************************************************************
427 * FUNCTION: acpi_ut_update_object_reference
429 * PARAMETERS: Object - Increment ref count for this object
430 * and all sub-objects
431 * Action - Either REF_INCREMENT or REF_DECREMENT or
436 * DESCRIPTION: Increment the object reference count
438 * Object references are incremented when:
439 * 1) An object is attached to a Node (namespace object)
440 * 2) An object is copied (all subobjects must be incremented)
442 * Object references are decremented when:
443 * 1) An object is detached from an Node
445 ******************************************************************************/
448 acpi_ut_update_object_reference(union acpi_operand_object
*object
, u16 action
)
450 acpi_status status
= AE_OK
;
451 union acpi_generic_state
*state_list
= NULL
;
452 union acpi_operand_object
*next_object
= NULL
;
453 union acpi_generic_state
*state
;
456 ACPI_FUNCTION_TRACE_PTR(ut_update_object_reference
, object
);
460 /* Make sure that this isn't a namespace handle */
462 if (ACPI_GET_DESCRIPTOR_TYPE(object
) == ACPI_DESC_TYPE_NAMED
) {
463 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
,
464 "Object %p is NS handle\n", object
));
465 return_ACPI_STATUS(AE_OK
);
469 * All sub-objects must have their reference count incremented also.
470 * Different object types have different subobjects.
472 switch (ACPI_GET_OBJECT_TYPE(object
)) {
473 case ACPI_TYPE_DEVICE
:
474 case ACPI_TYPE_PROCESSOR
:
475 case ACPI_TYPE_POWER
:
476 case ACPI_TYPE_THERMAL
:
478 /* Update the notify objects for these types (if present) */
480 acpi_ut_update_ref_count(object
->common_notify
.
481 system_notify
, action
);
482 acpi_ut_update_ref_count(object
->common_notify
.
483 device_notify
, action
);
486 case ACPI_TYPE_PACKAGE
:
488 * We must update all the sub-objects of the package,
489 * each of whom may have their own sub-objects.
491 for (i
= 0; i
< object
->package
.count
; i
++) {
493 * Push each element onto the stack for later processing.
494 * Note: There can be null elements within the package,
495 * these are simply ignored
498 acpi_ut_create_update_state_and_push
499 (object
->package
.elements
[i
], action
,
501 if (ACPI_FAILURE(status
)) {
507 case ACPI_TYPE_BUFFER_FIELD
:
509 next_object
= object
->buffer_field
.buffer_obj
;
512 case ACPI_TYPE_LOCAL_REGION_FIELD
:
514 next_object
= object
->field
.region_obj
;
517 case ACPI_TYPE_LOCAL_BANK_FIELD
:
519 next_object
= object
->bank_field
.bank_obj
;
521 acpi_ut_create_update_state_and_push(object
->
526 if (ACPI_FAILURE(status
)) {
531 case ACPI_TYPE_LOCAL_INDEX_FIELD
:
533 next_object
= object
->index_field
.index_obj
;
535 acpi_ut_create_update_state_and_push(object
->
540 if (ACPI_FAILURE(status
)) {
545 case ACPI_TYPE_LOCAL_REFERENCE
:
547 * The target of an Index (a package, string, or buffer) or a named
548 * reference must track changes to the ref count of the index or
551 if ((object
->reference
.opcode
== AML_INDEX_OP
) ||
552 (object
->reference
.opcode
== AML_INT_NAMEPATH_OP
)) {
553 next_object
= object
->reference
.object
;
557 case ACPI_TYPE_REGION
:
559 break; /* No subobjects for all other types */
563 * Now we can update the count in the main object. This can only
564 * happen after we update the sub-objects in case this causes the
565 * main object to be deleted.
567 acpi_ut_update_ref_count(object
, action
);
570 /* Move on to the next object to be updated */
573 object
= next_object
;
575 } else if (state_list
) {
576 state
= acpi_ut_pop_generic_state(&state_list
);
577 object
= state
->update
.object
;
578 acpi_ut_delete_generic_state(state
);
582 return_ACPI_STATUS(AE_OK
);
586 ACPI_EXCEPTION((AE_INFO
, status
,
587 "Could not update object reference count"));
589 return_ACPI_STATUS(status
);
592 /*******************************************************************************
594 * FUNCTION: acpi_ut_add_reference
596 * PARAMETERS: Object - Object whose reference count is to be
601 * DESCRIPTION: Add one reference to an ACPI object
603 ******************************************************************************/
605 void acpi_ut_add_reference(union acpi_operand_object
*object
)
608 ACPI_FUNCTION_TRACE_PTR(ut_add_reference
, object
);
610 /* Ensure that we have a valid object */
612 if (!acpi_ut_valid_internal_object(object
)) {
616 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
,
617 "Obj %p Current Refs=%X [To Be Incremented]\n",
618 object
, object
->common
.reference_count
));
620 /* Increment the reference count */
622 (void)acpi_ut_update_object_reference(object
, REF_INCREMENT
);
626 /*******************************************************************************
628 * FUNCTION: acpi_ut_remove_reference
630 * PARAMETERS: Object - Object whose ref count will be decremented
634 * DESCRIPTION: Decrement the reference count of an ACPI internal object
636 ******************************************************************************/
638 void acpi_ut_remove_reference(union acpi_operand_object
*object
)
641 ACPI_FUNCTION_TRACE_PTR(ut_remove_reference
, object
);
644 * Allow a NULL pointer to be passed in, just ignore it. This saves
645 * each caller from having to check. Also, ignore NS nodes.
649 (ACPI_GET_DESCRIPTOR_TYPE(object
) == ACPI_DESC_TYPE_NAMED
)) {
653 /* Ensure that we have a valid object */
655 if (!acpi_ut_valid_internal_object(object
)) {
659 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
,
660 "Obj %p Current Refs=%X [To Be Decremented]\n",
661 object
, object
->common
.reference_count
));
664 * Decrement the reference count, and only actually delete the object
665 * if the reference count becomes 0. (Must also decrement the ref count
666 * of all subobjects!)
668 (void)acpi_ut_update_object_reference(object
, REF_DECREMENT
);