1 /*******************************************************************************
3 * Module Name: utdelete - object deletion and reference count utilities
5 ******************************************************************************/
8 * Copyright (C) 2000 - 2006, R. Byron Moore
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;
138 case ACPI_TYPE_DEVICE:
140 if (object->device.gpe_block) {
141 (void)acpi_ev_delete_gpe_block(object->device.
145 /* Walk the handler list for this device */
147 handler_desc = object->device.handler;
148 while (handler_desc) {
149 next_desc = handler_desc->address_space.next;
150 acpi_ut_remove_reference(handler_desc);
151 handler_desc = next_desc;
155 case ACPI_TYPE_MUTEX:
157 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
158 "***** Mutex %p, Semaphore %p\n",
159 object, object->mutex.semaphore));
161 acpi_ex_unlink_mutex(object);
162 (void)acpi_os_delete_semaphore(object->mutex.semaphore);
165 case ACPI_TYPE_EVENT:
167 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
168 "***** Event %p, Semaphore %p\n",
169 object, object->event.semaphore));
171 (void)acpi_os_delete_semaphore(object->event.semaphore);
172 object->event.semaphore = NULL;
175 case ACPI_TYPE_METHOD:
177 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
178 "***** Method %p\n", object));
180 /* Delete the method semaphore if it exists */
182 if (object->method.semaphore) {
183 (void)acpi_os_delete_semaphore(object->method.
185 object->method.semaphore = NULL;
189 case ACPI_TYPE_REGION:
191 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
192 "***** Region %p\n", object));
194 second_desc = acpi_ns_get_secondary_object(object);
197 * Free the region_context if and only if the handler is one of the
198 * default handlers -- and therefore, we created the context object
199 * locally, it was not created by an external caller.
201 handler_desc = object->region.handler;
203 if (handler_desc->address_space.handler_flags &
204 ACPI_ADDR_HANDLER_DEFAULT_INSTALLED) {
206 /* Deactivate region and free region context */
208 if (handler_desc->address_space.setup) {
210 address_space.setup(object,
211 ACPI_REGION_DEACTIVATE,
221 acpi_ut_remove_reference(handler_desc);
224 /* Now we can free the Extra object */
226 acpi_ut_delete_object_desc(second_desc);
230 case ACPI_TYPE_BUFFER_FIELD:
232 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
233 "***** Buffer Field %p\n", object));
235 second_desc = acpi_ns_get_secondary_object(object);
237 acpi_ut_delete_object_desc(second_desc);
245 /* Free any allocated memory (pointer within the object) found above */
248 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
249 "Deleting Object Subptr %p\n", obj_pointer));
250 ACPI_FREE(obj_pointer);
253 /* Now the object can be safely deleted */
255 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS, "Deleting Object %p [%s]\n",
256 object, acpi_ut_get_object_type_name(object)));
258 acpi_ut_delete_object_desc(object);
262 /*******************************************************************************
264 * FUNCTION: acpi_ut_delete_internal_object_list
266 * PARAMETERS: obj_list - Pointer to the list to be deleted
270 * DESCRIPTION: This function deletes an internal object list, including both
271 * simple objects and package objects
273 ******************************************************************************/
275 void acpi_ut_delete_internal_object_list(union acpi_operand_object **obj_list)
277 union acpi_operand_object **internal_obj;
279 ACPI_FUNCTION_TRACE(ut_delete_internal_object_list);
281 /* Walk the null-terminated internal list */
283 for (internal_obj = obj_list; *internal_obj; internal_obj++) {
284 acpi_ut_remove_reference(*internal_obj);
287 /* Free the combined parameter pointer list and object array */
293 /*******************************************************************************
295 * FUNCTION: acpi_ut_update_ref_count
297 * PARAMETERS: Object - Object whose ref count is to be updated
298 * Action - What to do
300 * RETURN: New ref count
302 * DESCRIPTION: Modify the ref count and return it.
304 ******************************************************************************/
307 acpi_ut_update_ref_count(union acpi_operand_object *object, u32 action)
312 ACPI_FUNCTION_NAME(ut_update_ref_count);
318 count = object->common.reference_count;
322 * Perform the reference count action (increment, decrement, force delete)
328 object->common.reference_count = new_count;
330 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
331 "Obj %p Refs=%X, [Incremented]\n",
338 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
339 "Obj %p Refs=%X, can't decrement! (Set to 0)\n",
346 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
347 "Obj %p Refs=%X, [Decremented]\n",
351 if (ACPI_GET_OBJECT_TYPE(object) == ACPI_TYPE_METHOD) {
352 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
353 "Method Obj %p Refs=%X, [Decremented]\n",
357 object->common.reference_count = new_count;
358 if (new_count == 0) {
359 acpi_ut_delete_internal_obj(object);
363 case REF_FORCE_DELETE:
365 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
366 "Obj %p Refs=%X, Force delete! (Set to 0)\n",
370 object->common.reference_count = new_count;
371 acpi_ut_delete_internal_obj(object);
376 ACPI_ERROR((AE_INFO, "Unknown action (%X)", action));
381 * Sanity check the reference count, for debug purposes only.
382 * (A deleted object will have a huge reference count)
384 if (count > ACPI_MAX_REFERENCE_COUNT) {
385 ACPI_WARNING((AE_INFO,
386 "Large Reference Count (%X) in object %p", count,
391 /*******************************************************************************
393 * FUNCTION: acpi_ut_update_object_reference
395 * PARAMETERS: Object - Increment ref count for this object
396 * and all sub-objects
397 * Action - Either REF_INCREMENT or REF_DECREMENT or
402 * DESCRIPTION: Increment the object reference count
404 * Object references are incremented when:
405 * 1) An object is attached to a Node (namespace object)
406 * 2) An object is copied (all subobjects must be incremented)
408 * Object references are decremented when:
409 * 1) An object is detached from an Node
411 ******************************************************************************/
414 acpi_ut_update_object_reference(union acpi_operand_object *object, u16 action)
416 acpi_status status = AE_OK;
417 union acpi_generic_state *state_list = NULL;
418 union acpi_operand_object *next_object = NULL;
419 union acpi_generic_state *state;
422 ACPI_FUNCTION_TRACE_PTR(ut_update_object_reference, object);
426 /* Make sure that this isn't a namespace handle */
428 if (ACPI_GET_DESCRIPTOR_TYPE(object) == ACPI_DESC_TYPE_NAMED) {
429 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
430 "Object %p is NS handle\n", object));
431 return_ACPI_STATUS(AE_OK);
435 * All sub-objects must have their reference count incremented also.
436 * Different object types have different subobjects.
438 switch (ACPI_GET_OBJECT_TYPE(object)) {
439 case ACPI_TYPE_DEVICE:
441 acpi_ut_update_ref_count(object->device.system_notify,
443 acpi_ut_update_ref_count(object->device.device_notify,
447 case ACPI_TYPE_PACKAGE:
449 * We must update all the sub-objects of the package,
450 * each of whom may have their own sub-objects.
452 for (i = 0; i < object->package.count; i++) {
454 * Push each element onto the stack for later processing.
455 * Note: There can be null elements within the package,
456 * these are simply ignored
459 acpi_ut_create_update_state_and_push
460 (object->package.elements[i], action,
462 if (ACPI_FAILURE(status)) {
468 case ACPI_TYPE_BUFFER_FIELD:
470 next_object = object->buffer_field.buffer_obj;
473 case ACPI_TYPE_LOCAL_REGION_FIELD:
475 next_object = object->field.region_obj;
478 case ACPI_TYPE_LOCAL_BANK_FIELD:
480 next_object = object->bank_field.bank_obj;
482 acpi_ut_create_update_state_and_push(object->
487 if (ACPI_FAILURE(status)) {
492 case ACPI_TYPE_LOCAL_INDEX_FIELD:
494 next_object = object->index_field.index_obj;
496 acpi_ut_create_update_state_and_push(object->
501 if (ACPI_FAILURE(status)) {
506 case ACPI_TYPE_LOCAL_REFERENCE:
508 * The target of an Index (a package, string, or buffer) must track
509 * changes to the ref count of the index.
511 if (object->reference.opcode == AML_INDEX_OP) {
512 next_object = object->reference.object;
516 case ACPI_TYPE_REGION:
518 break; /* No subobjects for all other types */
522 * Now we can update the count in the main object. This can only
523 * happen after we update the sub-objects in case this causes the
524 * main object to be deleted.
526 acpi_ut_update_ref_count(object, action);
529 /* Move on to the next object to be updated */
532 object = next_object;
534 } else if (state_list) {
535 state = acpi_ut_pop_generic_state(&state_list);
536 object = state->update.object;
537 acpi_ut_delete_generic_state(state);
541 return_ACPI_STATUS(AE_OK);
545 ACPI_EXCEPTION((AE_INFO, status,
546 "Could not update object reference count"));
548 return_ACPI_STATUS(status);
551 /*******************************************************************************
553 * FUNCTION: acpi_ut_add_reference
555 * PARAMETERS: Object - Object whose reference count is to be
560 * DESCRIPTION: Add one reference to an ACPI object
562 ******************************************************************************/
564 void acpi_ut_add_reference(union acpi_operand_object *object)
567 ACPI_FUNCTION_TRACE_PTR(ut_add_reference, object);
569 /* Ensure that we have a valid object */
571 if (!acpi_ut_valid_internal_object(object)) {
575 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
576 "Obj %p Current Refs=%X [To Be Incremented]\n",
577 object, object->common.reference_count));
579 /* Increment the reference count */
581 (void)acpi_ut_update_object_reference(object, REF_INCREMENT);
585 /*******************************************************************************
587 * FUNCTION: acpi_ut_remove_reference
589 * PARAMETERS: Object - Object whose ref count will be decremented
593 * DESCRIPTION: Decrement the reference count of an ACPI internal object
595 ******************************************************************************/
597 void acpi_ut_remove_reference(union acpi_operand_object *object)
600 ACPI_FUNCTION_TRACE_PTR(ut_remove_reference, object);
603 * Allow a NULL pointer to be passed in, just ignore it. This saves
604 * each caller from having to check. Also, ignore NS nodes.
608 (ACPI_GET_DESCRIPTOR_TYPE(object) == ACPI_DESC_TYPE_NAMED)) {
612 /* Ensure that we have a valid object */
614 if (!acpi_ut_valid_internal_object(object)) {
618 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
619 "Obj %p Current Refs=%X [To Be Decremented]\n",
620 object, object->common.reference_count));
623 * Decrement the reference count, and only actually delete the object
624 * if the reference count becomes 0. (Must also decrement the ref count
625 * of all subobjects!)
627 (void)acpi_ut_update_object_reference(object, REF_DECREMENT);