1 /*******************************************************************************
3 * Module Name: utdelete - object deletion and reference count utilities
5 ******************************************************************************/
8 * Copyright (C) 2000 - 2013, 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 address 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));
219 * Update address_range list. However, only permanent regions
220 * are installed in this list. (Not created within a method)
222 if (!(object->region.node->flags & ANOBJ_TEMPORARY)) {
223 acpi_ut_remove_address_range(object->region.space_id,
224 object->region.node);
227 second_desc = acpi_ns_get_secondary_object(object);
230 * Free the region_context if and only if the handler is one of the
231 * default handlers -- and therefore, we created the context object
232 * locally, it was not created by an external caller.
234 handler_desc = object->region.handler;
237 handler_desc->address_space.region_list;
239 &handler_desc->address_space.region_list;
241 /* Remove the region object from the handler's list */
244 if (next_desc == object) {
246 next_desc->region.next;
250 /* Walk the linked list of handler */
252 last_obj_ptr = &next_desc->region.next;
253 next_desc = next_desc->region.next;
256 if (handler_desc->address_space.handler_flags &
257 ACPI_ADDR_HANDLER_DEFAULT_INSTALLED) {
259 /* Deactivate region and free region context */
261 if (handler_desc->address_space.setup) {
263 address_space.setup(object,
264 ACPI_REGION_DEACTIVATE,
274 acpi_ut_remove_reference(handler_desc);
277 /* Now we can free the Extra object */
279 acpi_ut_delete_object_desc(second_desc);
283 case ACPI_TYPE_BUFFER_FIELD:
285 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
286 "***** Buffer Field %p\n", object));
288 second_desc = acpi_ns_get_secondary_object(object);
290 acpi_ut_delete_object_desc(second_desc);
294 case ACPI_TYPE_LOCAL_BANK_FIELD:
296 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
297 "***** Bank Field %p\n", object));
299 second_desc = acpi_ns_get_secondary_object(object);
301 acpi_ut_delete_object_desc(second_desc);
309 /* Free any allocated memory (pointer within the object) found above */
312 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
313 "Deleting Object Subptr %p\n", obj_pointer));
314 ACPI_FREE(obj_pointer);
317 /* Now the object can be safely deleted */
319 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS, "Deleting Object %p [%s]\n",
320 object, acpi_ut_get_object_type_name(object)));
322 acpi_ut_delete_object_desc(object);
326 /*******************************************************************************
328 * FUNCTION: acpi_ut_delete_internal_object_list
330 * PARAMETERS: obj_list - Pointer to the list to be deleted
334 * DESCRIPTION: This function deletes an internal object list, including both
335 * simple objects and package objects
337 ******************************************************************************/
339 void acpi_ut_delete_internal_object_list(union acpi_operand_object **obj_list)
341 union acpi_operand_object **internal_obj;
343 ACPI_FUNCTION_ENTRY();
345 /* Walk the null-terminated internal list */
347 for (internal_obj = obj_list; *internal_obj; internal_obj++) {
348 acpi_ut_remove_reference(*internal_obj);
351 /* Free the combined parameter pointer list and object array */
357 /*******************************************************************************
359 * FUNCTION: acpi_ut_update_ref_count
361 * PARAMETERS: object - Object whose ref count is to be updated
362 * action - What to do
364 * RETURN: New ref count
366 * DESCRIPTION: Modify the ref count and return it.
368 ******************************************************************************/
371 acpi_ut_update_ref_count(union acpi_operand_object *object, u32 action)
376 ACPI_FUNCTION_NAME(ut_update_ref_count);
382 count = object->common.reference_count;
386 * Perform the reference count action (increment, decrement, force delete)
392 object->common.reference_count = new_count;
394 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
395 "Obj %p Refs=%X, [Incremented]\n",
402 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
403 "Obj %p Refs=%X, can't decrement! (Set to 0)\n",
410 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
411 "Obj %p Refs=%X, [Decremented]\n",
415 if (object->common.type == ACPI_TYPE_METHOD) {
416 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
417 "Method Obj %p Refs=%X, [Decremented]\n",
421 object->common.reference_count = new_count;
422 if (new_count == 0) {
423 acpi_ut_delete_internal_obj(object);
427 case REF_FORCE_DELETE:
429 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
430 "Obj %p Refs=%X, Force delete! (Set to 0)\n",
434 object->common.reference_count = new_count;
435 acpi_ut_delete_internal_obj(object);
440 ACPI_ERROR((AE_INFO, "Unknown action (0x%X)", action));
445 * Sanity check the reference count, for debug purposes only.
446 * (A deleted object will have a huge reference count)
448 if (count > ACPI_MAX_REFERENCE_COUNT) {
449 ACPI_WARNING((AE_INFO,
450 "Large Reference Count (0x%X) in object %p",
455 /*******************************************************************************
457 * FUNCTION: acpi_ut_update_object_reference
459 * PARAMETERS: object - Increment ref count for this object
460 * and all sub-objects
461 * action - Either REF_INCREMENT or REF_DECREMENT or
466 * DESCRIPTION: Increment the object reference count
468 * Object references are incremented when:
469 * 1) An object is attached to a Node (namespace object)
470 * 2) An object is copied (all subobjects must be incremented)
472 * Object references are decremented when:
473 * 1) An object is detached from an Node
475 ******************************************************************************/
478 acpi_ut_update_object_reference(union acpi_operand_object *object, u16 action)
480 acpi_status status = AE_OK;
481 union acpi_generic_state *state_list = NULL;
482 union acpi_operand_object *next_object = NULL;
483 union acpi_operand_object *prev_object;
484 union acpi_generic_state *state;
487 ACPI_FUNCTION_NAME(ut_update_object_reference);
491 /* Make sure that this isn't a namespace handle */
493 if (ACPI_GET_DESCRIPTOR_TYPE(object) == ACPI_DESC_TYPE_NAMED) {
494 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
495 "Object %p is NS handle\n", object));
500 * All sub-objects must have their reference count incremented also.
501 * Different object types have different subobjects.
503 switch (object->common.type) {
504 case ACPI_TYPE_DEVICE:
505 case ACPI_TYPE_PROCESSOR:
506 case ACPI_TYPE_POWER:
507 case ACPI_TYPE_THERMAL:
510 * Update the notify objects for these types (if present)
511 * Two lists, system and device notify handlers.
513 for (i = 0; i < ACPI_NUM_NOTIFY_TYPES; i++) {
515 object->common_notify.notify_list[i];
516 while (prev_object) {
518 prev_object->notify.next[i];
519 acpi_ut_update_ref_count(prev_object,
521 prev_object = next_object;
526 case ACPI_TYPE_PACKAGE:
528 * We must update all the sub-objects of the package,
529 * each of whom may have their own sub-objects.
531 for (i = 0; i < object->package.count; i++) {
533 * Null package elements are legal and can be simply
536 next_object = object->package.elements[i];
541 switch (next_object->common.type) {
542 case ACPI_TYPE_INTEGER:
543 case ACPI_TYPE_STRING:
544 case ACPI_TYPE_BUFFER:
546 * For these very simple sub-objects, we can just
547 * update the reference count here and continue.
548 * Greatly increases performance of this operation.
550 acpi_ut_update_ref_count(next_object,
556 * For complex sub-objects, push them onto the stack
557 * for later processing (this eliminates recursion.)
560 acpi_ut_create_update_state_and_push
561 (next_object, action, &state_list);
562 if (ACPI_FAILURE(status)) {
571 case ACPI_TYPE_BUFFER_FIELD:
573 next_object = object->buffer_field.buffer_obj;
576 case ACPI_TYPE_LOCAL_REGION_FIELD:
578 next_object = object->field.region_obj;
581 case ACPI_TYPE_LOCAL_BANK_FIELD:
583 next_object = object->bank_field.bank_obj;
585 acpi_ut_create_update_state_and_push(object->
590 if (ACPI_FAILURE(status)) {
595 case ACPI_TYPE_LOCAL_INDEX_FIELD:
597 next_object = object->index_field.index_obj;
599 acpi_ut_create_update_state_and_push(object->
604 if (ACPI_FAILURE(status)) {
609 case ACPI_TYPE_LOCAL_REFERENCE:
611 * The target of an Index (a package, string, or buffer) or a named
612 * reference must track changes to the ref count of the index or
615 if ((object->reference.class == ACPI_REFCLASS_INDEX) ||
616 (object->reference.class == ACPI_REFCLASS_NAME)) {
617 next_object = object->reference.object;
621 case ACPI_TYPE_REGION:
623 break; /* No subobjects for all other types */
627 * Now we can update the count in the main object. This can only
628 * happen after we update the sub-objects in case this causes the
629 * main object to be deleted.
631 acpi_ut_update_ref_count(object, action);
634 /* Move on to the next object to be updated */
637 object = next_object;
639 } else if (state_list) {
640 state = acpi_ut_pop_generic_state(&state_list);
641 object = state->update.object;
642 acpi_ut_delete_generic_state(state);
650 ACPI_EXCEPTION((AE_INFO, status,
651 "Could not update object reference count"));
653 /* Free any stacked Update State objects */
656 state = acpi_ut_pop_generic_state(&state_list);
657 acpi_ut_delete_generic_state(state);
663 /*******************************************************************************
665 * FUNCTION: acpi_ut_add_reference
667 * PARAMETERS: object - Object whose reference count is to be
672 * DESCRIPTION: Add one reference to an ACPI object
674 ******************************************************************************/
676 void acpi_ut_add_reference(union acpi_operand_object *object)
679 ACPI_FUNCTION_NAME(ut_add_reference);
681 /* Ensure that we have a valid object */
683 if (!acpi_ut_valid_internal_object(object)) {
687 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
688 "Obj %p Current Refs=%X [To Be Incremented]\n",
689 object, object->common.reference_count));
691 /* Increment the reference count */
693 (void)acpi_ut_update_object_reference(object, REF_INCREMENT);
697 /*******************************************************************************
699 * FUNCTION: acpi_ut_remove_reference
701 * PARAMETERS: object - Object whose ref count will be decremented
705 * DESCRIPTION: Decrement the reference count of an ACPI internal object
707 ******************************************************************************/
709 void acpi_ut_remove_reference(union acpi_operand_object *object)
712 ACPI_FUNCTION_NAME(ut_remove_reference);
715 * Allow a NULL pointer to be passed in, just ignore it. This saves
716 * each caller from having to check. Also, ignore NS nodes.
720 (ACPI_GET_DESCRIPTOR_TYPE(object) == ACPI_DESC_TYPE_NAMED)) {
724 /* Ensure that we have a valid object */
726 if (!acpi_ut_valid_internal_object(object)) {
730 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
731 "Obj %p Current Refs=%X [To Be Decremented]\n",
732 object, object->common.reference_count));
735 * Decrement the reference count, and only actually delete the object
736 * if the reference count becomes 0. (Must also decrement the ref count
737 * of all subobjects!)
739 (void)acpi_ut_update_object_reference(object, REF_DECREMENT);