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>
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
;
78 union acpi_operand_object
**last_obj_ptr
;
80 ACPI_FUNCTION_TRACE_PTR(ut_delete_internal_obj
, object
);
87 * Must delete or free any pointers within the object that are not
88 * actual ACPI objects (for example, a raw buffer pointer).
90 switch (object
->common
.type
) {
91 case ACPI_TYPE_STRING
:
93 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
,
94 "**** String %p, ptr %p\n", object
,
95 object
->string
.pointer
));
97 /* Free the actual string buffer */
99 if (!(object
->common
.flags
& AOPOBJ_STATIC_POINTER
)) {
101 /* But only if it is NOT a pointer into an ACPI table */
103 obj_pointer
= object
->string
.pointer
;
107 case ACPI_TYPE_BUFFER
:
109 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
,
110 "**** Buffer %p, ptr %p\n", object
,
111 object
->buffer
.pointer
));
113 /* Free the actual buffer */
115 if (!(object
->common
.flags
& AOPOBJ_STATIC_POINTER
)) {
117 /* But only if it is NOT a pointer into an ACPI table */
119 obj_pointer
= object
->buffer
.pointer
;
123 case ACPI_TYPE_PACKAGE
:
125 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
,
126 " **** Package of count %X\n",
127 object
->package
.count
));
130 * Elements of the package are not handled here, they are deleted
134 /* Free the (variable length) element pointer array */
136 obj_pointer
= object
->package
.elements
;
140 * These objects have a possible list of notify handlers.
141 * Device object also may have a GPE block.
143 case ACPI_TYPE_DEVICE
:
145 if (object
->device
.gpe_block
) {
146 (void)acpi_ev_delete_gpe_block(object
->device
.
150 /*lint -fallthrough */
152 case ACPI_TYPE_PROCESSOR
:
153 case ACPI_TYPE_THERMAL
:
155 /* Walk the notify handler list for this object */
157 handler_desc
= object
->common_notify
.handler
;
158 while (handler_desc
) {
159 next_desc
= handler_desc
->address_space
.next
;
160 acpi_ut_remove_reference(handler_desc
);
161 handler_desc
= next_desc
;
165 case ACPI_TYPE_MUTEX
:
167 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
,
168 "***** Mutex %p, OS Mutex %p\n",
169 object
, object
->mutex
.os_mutex
));
171 if (object
== acpi_gbl_global_lock_mutex
) {
173 /* Global Lock has extra semaphore */
176 acpi_os_delete_semaphore
177 (acpi_gbl_global_lock_semaphore
);
178 acpi_gbl_global_lock_semaphore
= NULL
;
180 acpi_os_delete_mutex(object
->mutex
.os_mutex
);
181 acpi_gbl_global_lock_mutex
= NULL
;
183 acpi_ex_unlink_mutex(object
);
184 acpi_os_delete_mutex(object
->mutex
.os_mutex
);
188 case ACPI_TYPE_EVENT
:
190 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
,
191 "***** Event %p, OS Semaphore %p\n",
192 object
, object
->event
.os_semaphore
));
194 (void)acpi_os_delete_semaphore(object
->event
.os_semaphore
);
195 object
->event
.os_semaphore
= NULL
;
198 case ACPI_TYPE_METHOD
:
200 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
,
201 "***** Method %p\n", object
));
203 /* Delete the method mutex if it exists */
205 if (object
->method
.mutex
) {
206 acpi_os_delete_mutex(object
->method
.mutex
->mutex
.
208 acpi_ut_delete_object_desc(object
->method
.mutex
);
209 object
->method
.mutex
= NULL
;
213 case ACPI_TYPE_REGION
:
215 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
,
216 "***** Region %p\n", object
));
218 /* Invalidate the region address/length via the host OS */
220 acpi_os_invalidate_address(object
->region
.space_id
,
221 object
->region
.address
,
222 (acpi_size
) object
->region
.length
);
224 second_desc
= acpi_ns_get_secondary_object(object
);
227 * Free the region_context if and only if the handler is one of the
228 * default handlers -- and therefore, we created the context object
229 * locally, it was not created by an external caller.
231 handler_desc
= object
->region
.handler
;
234 handler_desc
->address_space
.region_list
;
236 &handler_desc
->address_space
.region_list
;
238 /* Remove the region object from the handler's list */
241 if (next_desc
== object
) {
243 next_desc
->region
.next
;
247 /* Walk the linked list of handler */
249 last_obj_ptr
= &next_desc
->region
.next
;
250 next_desc
= next_desc
->region
.next
;
253 if (handler_desc
->address_space
.handler_flags
&
254 ACPI_ADDR_HANDLER_DEFAULT_INSTALLED
) {
256 /* Deactivate region and free region context */
258 if (handler_desc
->address_space
.setup
) {
260 address_space
.setup(object
,
261 ACPI_REGION_DEACTIVATE
,
271 acpi_ut_remove_reference(handler_desc
);
274 /* Now we can free the Extra object */
276 acpi_ut_delete_object_desc(second_desc
);
280 case ACPI_TYPE_BUFFER_FIELD
:
282 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
,
283 "***** Buffer Field %p\n", object
));
285 second_desc
= acpi_ns_get_secondary_object(object
);
287 acpi_ut_delete_object_desc(second_desc
);
291 case ACPI_TYPE_LOCAL_BANK_FIELD
:
293 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
,
294 "***** Bank Field %p\n", object
));
296 second_desc
= acpi_ns_get_secondary_object(object
);
298 acpi_ut_delete_object_desc(second_desc
);
306 /* Free any allocated memory (pointer within the object) found above */
309 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
,
310 "Deleting Object Subptr %p\n", obj_pointer
));
311 ACPI_FREE(obj_pointer
);
314 /* Now the object can be safely deleted */
316 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
, "Deleting Object %p [%s]\n",
317 object
, acpi_ut_get_object_type_name(object
)));
319 acpi_ut_delete_object_desc(object
);
323 /*******************************************************************************
325 * FUNCTION: acpi_ut_delete_internal_object_list
327 * PARAMETERS: obj_list - Pointer to the list to be deleted
331 * DESCRIPTION: This function deletes an internal object list, including both
332 * simple objects and package objects
334 ******************************************************************************/
336 void acpi_ut_delete_internal_object_list(union acpi_operand_object
**obj_list
)
338 union acpi_operand_object
**internal_obj
;
340 ACPI_FUNCTION_TRACE(ut_delete_internal_object_list
);
342 /* Walk the null-terminated internal list */
344 for (internal_obj
= obj_list
; *internal_obj
; internal_obj
++) {
345 acpi_ut_remove_reference(*internal_obj
);
348 /* Free the combined parameter pointer list and object array */
354 /*******************************************************************************
356 * FUNCTION: acpi_ut_update_ref_count
358 * PARAMETERS: Object - Object whose ref count is to be updated
359 * Action - What to do
361 * RETURN: New ref count
363 * DESCRIPTION: Modify the ref count and return it.
365 ******************************************************************************/
368 acpi_ut_update_ref_count(union acpi_operand_object
*object
, u32 action
)
373 ACPI_FUNCTION_NAME(ut_update_ref_count
);
379 count
= object
->common
.reference_count
;
383 * Perform the reference count action (increment, decrement, force delete)
389 object
->common
.reference_count
= new_count
;
391 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
,
392 "Obj %p Refs=%X, [Incremented]\n",
399 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
,
400 "Obj %p Refs=%X, can't decrement! (Set to 0)\n",
407 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
,
408 "Obj %p Refs=%X, [Decremented]\n",
412 if (object
->common
.type
== ACPI_TYPE_METHOD
) {
413 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
,
414 "Method Obj %p Refs=%X, [Decremented]\n",
418 object
->common
.reference_count
= new_count
;
419 if (new_count
== 0) {
420 acpi_ut_delete_internal_obj(object
);
424 case REF_FORCE_DELETE
:
426 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
,
427 "Obj %p Refs=%X, Force delete! (Set to 0)\n",
431 object
->common
.reference_count
= new_count
;
432 acpi_ut_delete_internal_obj(object
);
437 ACPI_ERROR((AE_INFO
, "Unknown action (%X)", action
));
442 * Sanity check the reference count, for debug purposes only.
443 * (A deleted object will have a huge reference count)
445 if (count
> ACPI_MAX_REFERENCE_COUNT
) {
446 ACPI_WARNING((AE_INFO
,
447 "Large Reference Count (%X) in object %p", count
,
452 /*******************************************************************************
454 * FUNCTION: acpi_ut_update_object_reference
456 * PARAMETERS: Object - Increment ref count for this object
457 * and all sub-objects
458 * Action - Either REF_INCREMENT or REF_DECREMENT or
463 * DESCRIPTION: Increment the object reference count
465 * Object references are incremented when:
466 * 1) An object is attached to a Node (namespace object)
467 * 2) An object is copied (all subobjects must be incremented)
469 * Object references are decremented when:
470 * 1) An object is detached from an Node
472 ******************************************************************************/
475 acpi_ut_update_object_reference(union acpi_operand_object
*object
, u16 action
)
477 acpi_status status
= AE_OK
;
478 union acpi_generic_state
*state_list
= NULL
;
479 union acpi_operand_object
*next_object
= NULL
;
480 union acpi_generic_state
*state
;
483 ACPI_FUNCTION_TRACE_PTR(ut_update_object_reference
, object
);
487 /* Make sure that this isn't a namespace handle */
489 if (ACPI_GET_DESCRIPTOR_TYPE(object
) == ACPI_DESC_TYPE_NAMED
) {
490 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
,
491 "Object %p is NS handle\n", object
));
492 return_ACPI_STATUS(AE_OK
);
496 * All sub-objects must have their reference count incremented also.
497 * Different object types have different subobjects.
499 switch (object
->common
.type
) {
500 case ACPI_TYPE_DEVICE
:
501 case ACPI_TYPE_PROCESSOR
:
502 case ACPI_TYPE_POWER
:
503 case ACPI_TYPE_THERMAL
:
505 /* Update the notify objects for these types (if present) */
507 acpi_ut_update_ref_count(object
->common_notify
.
508 system_notify
, action
);
509 acpi_ut_update_ref_count(object
->common_notify
.
510 device_notify
, action
);
513 case ACPI_TYPE_PACKAGE
:
515 * We must update all the sub-objects of the package,
516 * each of whom may have their own sub-objects.
518 for (i
= 0; i
< object
->package
.count
; i
++) {
520 * Push each element onto the stack for later processing.
521 * Note: There can be null elements within the package,
522 * these are simply ignored
525 acpi_ut_create_update_state_and_push
526 (object
->package
.elements
[i
], action
,
528 if (ACPI_FAILURE(status
)) {
534 case ACPI_TYPE_BUFFER_FIELD
:
536 next_object
= object
->buffer_field
.buffer_obj
;
539 case ACPI_TYPE_LOCAL_REGION_FIELD
:
541 next_object
= object
->field
.region_obj
;
544 case ACPI_TYPE_LOCAL_BANK_FIELD
:
546 next_object
= object
->bank_field
.bank_obj
;
548 acpi_ut_create_update_state_and_push(object
->
553 if (ACPI_FAILURE(status
)) {
558 case ACPI_TYPE_LOCAL_INDEX_FIELD
:
560 next_object
= object
->index_field
.index_obj
;
562 acpi_ut_create_update_state_and_push(object
->
567 if (ACPI_FAILURE(status
)) {
572 case ACPI_TYPE_LOCAL_REFERENCE
:
574 * The target of an Index (a package, string, or buffer) or a named
575 * reference must track changes to the ref count of the index or
578 if ((object
->reference
.class == ACPI_REFCLASS_INDEX
) ||
579 (object
->reference
.class == ACPI_REFCLASS_NAME
)) {
580 next_object
= object
->reference
.object
;
584 case ACPI_TYPE_REGION
:
586 break; /* No subobjects for all other types */
590 * Now we can update the count in the main object. This can only
591 * happen after we update the sub-objects in case this causes the
592 * main object to be deleted.
594 acpi_ut_update_ref_count(object
, action
);
597 /* Move on to the next object to be updated */
600 object
= next_object
;
602 } else if (state_list
) {
603 state
= acpi_ut_pop_generic_state(&state_list
);
604 object
= state
->update
.object
;
605 acpi_ut_delete_generic_state(state
);
609 return_ACPI_STATUS(AE_OK
);
613 ACPI_EXCEPTION((AE_INFO
, status
,
614 "Could not update object reference count"));
616 /* Free any stacked Update State objects */
619 state
= acpi_ut_pop_generic_state(&state_list
);
620 acpi_ut_delete_generic_state(state
);
623 return_ACPI_STATUS(status
);
626 /*******************************************************************************
628 * FUNCTION: acpi_ut_add_reference
630 * PARAMETERS: Object - Object whose reference count is to be
635 * DESCRIPTION: Add one reference to an ACPI object
637 ******************************************************************************/
639 void acpi_ut_add_reference(union acpi_operand_object
*object
)
642 ACPI_FUNCTION_TRACE_PTR(ut_add_reference
, object
);
644 /* Ensure that we have a valid object */
646 if (!acpi_ut_valid_internal_object(object
)) {
650 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
,
651 "Obj %p Current Refs=%X [To Be Incremented]\n",
652 object
, object
->common
.reference_count
));
654 /* Increment the reference count */
656 (void)acpi_ut_update_object_reference(object
, REF_INCREMENT
);
660 /*******************************************************************************
662 * FUNCTION: acpi_ut_remove_reference
664 * PARAMETERS: Object - Object whose ref count will be decremented
668 * DESCRIPTION: Decrement the reference count of an ACPI internal object
670 ******************************************************************************/
672 void acpi_ut_remove_reference(union acpi_operand_object
*object
)
675 ACPI_FUNCTION_TRACE_PTR(ut_remove_reference
, object
);
678 * Allow a NULL pointer to be passed in, just ignore it. This saves
679 * each caller from having to check. Also, ignore NS nodes.
683 (ACPI_GET_DESCRIPTOR_TYPE(object
) == ACPI_DESC_TYPE_NAMED
)) {
687 /* Ensure that we have a valid object */
689 if (!acpi_ut_valid_internal_object(object
)) {
693 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
,
694 "Obj %p Current Refs=%X [To Be Decremented]\n",
695 object
, object
->common
.reference_count
));
698 * Decrement the reference count, and only actually delete the object
699 * if the reference count becomes 0. (Must also decrement the ref count
700 * of all subobjects!)
702 (void)acpi_ut_update_object_reference(object
, REF_DECREMENT
);