1 /*******************************************************************************
3 * Module Name: utdelete - object deletion and reference count utilities
5 ******************************************************************************/
8 * Copyright (C) 2000 - 2016, 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
*start_desc
;
79 union acpi_operand_object
**last_obj_ptr
;
81 ACPI_FUNCTION_TRACE_PTR(ut_delete_internal_obj
, object
);
88 * Must delete or free any pointers within the object that are not
89 * actual ACPI objects (for example, a raw buffer pointer).
91 switch (object
->common
.type
) {
92 case ACPI_TYPE_STRING
:
94 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
,
95 "**** String %p, ptr %p\n", object
,
96 object
->string
.pointer
));
98 /* Free the actual string buffer */
100 if (!(object
->common
.flags
& AOPOBJ_STATIC_POINTER
)) {
102 /* But only if it is NOT a pointer into an ACPI table */
104 obj_pointer
= object
->string
.pointer
;
108 case ACPI_TYPE_BUFFER
:
110 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
,
111 "**** Buffer %p, ptr %p\n", object
,
112 object
->buffer
.pointer
));
114 /* Free the actual buffer */
116 if (!(object
->common
.flags
& AOPOBJ_STATIC_POINTER
)) {
118 /* But only if it is NOT a pointer into an ACPI table */
120 obj_pointer
= object
->buffer
.pointer
;
124 case ACPI_TYPE_PACKAGE
:
126 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
,
127 " **** Package of count %X\n",
128 object
->package
.count
));
131 * Elements of the package are not handled here, they are deleted
135 /* Free the (variable length) element pointer array */
137 obj_pointer
= object
->package
.elements
;
141 * These objects have a possible list of notify handlers.
142 * Device object also may have a GPE block.
144 case ACPI_TYPE_DEVICE
:
146 if (object
->device
.gpe_block
) {
147 (void)acpi_ev_delete_gpe_block(object
->device
.
151 /*lint -fallthrough */
153 case ACPI_TYPE_PROCESSOR
:
154 case ACPI_TYPE_THERMAL
:
156 /* Walk the address handler list for this object */
158 handler_desc
= object
->common_notify
.handler
;
159 while (handler_desc
) {
160 next_desc
= handler_desc
->address_space
.next
;
161 acpi_ut_remove_reference(handler_desc
);
162 handler_desc
= next_desc
;
166 case ACPI_TYPE_MUTEX
:
168 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
,
169 "***** Mutex %p, OS Mutex %p\n",
170 object
, object
->mutex
.os_mutex
));
172 if (object
== acpi_gbl_global_lock_mutex
) {
174 /* Global Lock has extra semaphore */
177 acpi_os_delete_semaphore
178 (acpi_gbl_global_lock_semaphore
);
179 acpi_gbl_global_lock_semaphore
= NULL
;
181 acpi_os_delete_mutex(object
->mutex
.os_mutex
);
182 acpi_gbl_global_lock_mutex
= NULL
;
184 acpi_ex_unlink_mutex(object
);
185 acpi_os_delete_mutex(object
->mutex
.os_mutex
);
189 case ACPI_TYPE_EVENT
:
191 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
,
192 "***** Event %p, OS Semaphore %p\n",
193 object
, object
->event
.os_semaphore
));
195 (void)acpi_os_delete_semaphore(object
->event
.os_semaphore
);
196 object
->event
.os_semaphore
= NULL
;
199 case ACPI_TYPE_METHOD
:
201 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
,
202 "***** Method %p\n", object
));
204 /* Delete the method mutex if it exists */
206 if (object
->method
.mutex
) {
207 acpi_os_delete_mutex(object
->method
.mutex
->mutex
.
209 acpi_ut_delete_object_desc(object
->method
.mutex
);
210 object
->method
.mutex
= NULL
;
213 if (object
->method
.node
) {
214 object
->method
.node
= NULL
;
218 case ACPI_TYPE_REGION
:
220 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
,
221 "***** Region %p\n", object
));
224 * Update address_range list. However, only permanent regions
225 * are installed in this list. (Not created within a method)
227 if (!(object
->region
.node
->flags
& ANOBJ_TEMPORARY
)) {
228 acpi_ut_remove_address_range(object
->region
.space_id
,
229 object
->region
.node
);
232 second_desc
= acpi_ns_get_secondary_object(object
);
235 * Free the region_context if and only if the handler is one of the
236 * default handlers -- and therefore, we created the context object
237 * locally, it was not created by an external caller.
239 handler_desc
= object
->region
.handler
;
242 handler_desc
->address_space
.region_list
;
243 start_desc
= next_desc
;
245 &handler_desc
->address_space
.region_list
;
247 /* Remove the region object from the handler list */
250 if (next_desc
== object
) {
252 next_desc
->region
.next
;
256 /* Walk the linked list of handlers */
258 last_obj_ptr
= &next_desc
->region
.next
;
259 next_desc
= next_desc
->region
.next
;
261 /* Prevent infinite loop if list is corrupted */
263 if (next_desc
== start_desc
) {
265 "Circular region list in address handler object %p",
271 if (handler_desc
->address_space
.handler_flags
&
272 ACPI_ADDR_HANDLER_DEFAULT_INSTALLED
) {
274 /* Deactivate region and free region context */
276 if (handler_desc
->address_space
.setup
) {
278 address_space
.setup(object
,
279 ACPI_REGION_DEACTIVATE
,
289 acpi_ut_remove_reference(handler_desc
);
292 /* Now we can free the Extra object */
294 acpi_ut_delete_object_desc(second_desc
);
298 case ACPI_TYPE_BUFFER_FIELD
:
300 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
,
301 "***** Buffer Field %p\n", object
));
303 second_desc
= acpi_ns_get_secondary_object(object
);
305 acpi_ut_delete_object_desc(second_desc
);
309 case ACPI_TYPE_LOCAL_BANK_FIELD
:
311 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
,
312 "***** Bank Field %p\n", object
));
314 second_desc
= acpi_ns_get_secondary_object(object
);
316 acpi_ut_delete_object_desc(second_desc
);
325 /* Free any allocated memory (pointer within the object) found above */
328 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
,
329 "Deleting Object Subptr %p\n", obj_pointer
));
330 ACPI_FREE(obj_pointer
);
333 /* Now the object can be safely deleted */
335 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
, "Deleting Object %p [%s]\n",
336 object
, acpi_ut_get_object_type_name(object
)));
338 acpi_ut_delete_object_desc(object
);
342 /*******************************************************************************
344 * FUNCTION: acpi_ut_delete_internal_object_list
346 * PARAMETERS: obj_list - Pointer to the list to be deleted
350 * DESCRIPTION: This function deletes an internal object list, including both
351 * simple objects and package objects
353 ******************************************************************************/
355 void acpi_ut_delete_internal_object_list(union acpi_operand_object
**obj_list
)
357 union acpi_operand_object
**internal_obj
;
359 ACPI_FUNCTION_ENTRY();
361 /* Walk the null-terminated internal list */
363 for (internal_obj
= obj_list
; *internal_obj
; internal_obj
++) {
364 acpi_ut_remove_reference(*internal_obj
);
367 /* Free the combined parameter pointer list and object array */
373 /*******************************************************************************
375 * FUNCTION: acpi_ut_update_ref_count
377 * PARAMETERS: object - Object whose ref count is to be updated
378 * action - What to do (REF_INCREMENT or REF_DECREMENT)
380 * RETURN: None. Sets new reference count within the object
382 * DESCRIPTION: Modify the reference count for an internal acpi object
384 ******************************************************************************/
387 acpi_ut_update_ref_count(union acpi_operand_object
*object
, u32 action
)
391 acpi_cpu_flags lock_flags
;
393 ACPI_FUNCTION_NAME(ut_update_ref_count
);
400 * Always get the reference count lock. Note: Interpreter and/or
401 * Namespace is not always locked when this function is called.
403 lock_flags
= acpi_os_acquire_lock(acpi_gbl_reference_count_lock
);
404 original_count
= object
->common
.reference_count
;
406 /* Perform the reference count action (increment, decrement) */
411 new_count
= original_count
+ 1;
412 object
->common
.reference_count
= new_count
;
413 acpi_os_release_lock(acpi_gbl_reference_count_lock
, lock_flags
);
415 /* The current reference count should never be zero here */
417 if (!original_count
) {
418 ACPI_WARNING((AE_INFO
,
419 "Obj %p, Reference Count was zero before increment\n",
423 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
,
424 "Obj %p Type %.2X Refs %.2X [Incremented]\n",
425 object
, object
->common
.type
, new_count
));
430 /* The current reference count must be non-zero */
432 if (original_count
) {
433 new_count
= original_count
- 1;
434 object
->common
.reference_count
= new_count
;
437 acpi_os_release_lock(acpi_gbl_reference_count_lock
, lock_flags
);
439 if (!original_count
) {
440 ACPI_WARNING((AE_INFO
,
441 "Obj %p, Reference Count is already zero, cannot decrement\n",
445 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
,
446 "Obj %p Type %.2X Refs %.2X [Decremented]\n",
447 object
, object
->common
.type
, new_count
));
449 /* Actually delete the object on a reference count of zero */
451 if (new_count
== 0) {
452 acpi_ut_delete_internal_obj(object
);
458 acpi_os_release_lock(acpi_gbl_reference_count_lock
, lock_flags
);
459 ACPI_ERROR((AE_INFO
, "Unknown Reference Count action (0x%X)",
465 * Sanity check the reference count, for debug purposes only.
466 * (A deleted object will have a huge reference count)
468 if (new_count
> ACPI_MAX_REFERENCE_COUNT
) {
469 ACPI_WARNING((AE_INFO
,
470 "Large Reference Count (0x%X) in object %p, Type=0x%.2X",
471 new_count
, object
, object
->common
.type
));
475 /*******************************************************************************
477 * FUNCTION: acpi_ut_update_object_reference
479 * PARAMETERS: object - Increment ref count for this object
480 * and all sub-objects
481 * action - Either REF_INCREMENT or REF_DECREMENT
485 * DESCRIPTION: Increment the object reference count
487 * Object references are incremented when:
488 * 1) An object is attached to a Node (namespace object)
489 * 2) An object is copied (all subobjects must be incremented)
491 * Object references are decremented when:
492 * 1) An object is detached from an Node
494 ******************************************************************************/
497 acpi_ut_update_object_reference(union acpi_operand_object
*object
, u16 action
)
499 acpi_status status
= AE_OK
;
500 union acpi_generic_state
*state_list
= NULL
;
501 union acpi_operand_object
*next_object
= NULL
;
502 union acpi_operand_object
*prev_object
;
503 union acpi_generic_state
*state
;
506 ACPI_FUNCTION_NAME(ut_update_object_reference
);
510 /* Make sure that this isn't a namespace handle */
512 if (ACPI_GET_DESCRIPTOR_TYPE(object
) == ACPI_DESC_TYPE_NAMED
) {
513 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
,
514 "Object %p is NS handle\n", object
));
519 * All sub-objects must have their reference count incremented
520 * also. Different object types have different subobjects.
522 switch (object
->common
.type
) {
523 case ACPI_TYPE_DEVICE
:
524 case ACPI_TYPE_PROCESSOR
:
525 case ACPI_TYPE_POWER
:
526 case ACPI_TYPE_THERMAL
:
528 * Update the notify objects for these types (if present)
529 * Two lists, system and device notify handlers.
531 for (i
= 0; i
< ACPI_NUM_NOTIFY_TYPES
; i
++) {
533 object
->common_notify
.notify_list
[i
];
534 while (prev_object
) {
536 prev_object
->notify
.next
[i
];
537 acpi_ut_update_ref_count(prev_object
,
539 prev_object
= next_object
;
544 case ACPI_TYPE_PACKAGE
:
546 * We must update all the sub-objects of the package,
547 * each of whom may have their own sub-objects.
549 for (i
= 0; i
< object
->package
.count
; i
++) {
551 * Null package elements are legal and can be simply
554 next_object
= object
->package
.elements
[i
];
559 switch (next_object
->common
.type
) {
560 case ACPI_TYPE_INTEGER
:
561 case ACPI_TYPE_STRING
:
562 case ACPI_TYPE_BUFFER
:
564 * For these very simple sub-objects, we can just
565 * update the reference count here and continue.
566 * Greatly increases performance of this operation.
568 acpi_ut_update_ref_count(next_object
,
574 * For complex sub-objects, push them onto the stack
575 * for later processing (this eliminates recursion.)
578 acpi_ut_create_update_state_and_push
579 (next_object
, action
, &state_list
);
580 if (ACPI_FAILURE(status
)) {
589 case ACPI_TYPE_BUFFER_FIELD
:
591 next_object
= object
->buffer_field
.buffer_obj
;
594 case ACPI_TYPE_LOCAL_REGION_FIELD
:
596 next_object
= object
->field
.region_obj
;
599 case ACPI_TYPE_LOCAL_BANK_FIELD
:
601 next_object
= object
->bank_field
.bank_obj
;
603 acpi_ut_create_update_state_and_push(object
->
608 if (ACPI_FAILURE(status
)) {
613 case ACPI_TYPE_LOCAL_INDEX_FIELD
:
615 next_object
= object
->index_field
.index_obj
;
617 acpi_ut_create_update_state_and_push(object
->
622 if (ACPI_FAILURE(status
)) {
627 case ACPI_TYPE_LOCAL_REFERENCE
:
629 * The target of an Index (a package, string, or buffer) or a named
630 * reference must track changes to the ref count of the index or
633 if ((object
->reference
.class == ACPI_REFCLASS_INDEX
) ||
634 (object
->reference
.class == ACPI_REFCLASS_NAME
)) {
635 next_object
= object
->reference
.object
;
639 case ACPI_TYPE_REGION
:
642 break; /* No subobjects for all other types */
646 * Now we can update the count in the main object. This can only
647 * happen after we update the sub-objects in case this causes the
648 * main object to be deleted.
650 acpi_ut_update_ref_count(object
, action
);
653 /* Move on to the next object to be updated */
656 object
= next_object
;
658 } else if (state_list
) {
659 state
= acpi_ut_pop_generic_state(&state_list
);
660 object
= state
->update
.object
;
661 acpi_ut_delete_generic_state(state
);
669 ACPI_EXCEPTION((AE_INFO
, status
,
670 "Could not update object reference count"));
672 /* Free any stacked Update State objects */
675 state
= acpi_ut_pop_generic_state(&state_list
);
676 acpi_ut_delete_generic_state(state
);
682 /*******************************************************************************
684 * FUNCTION: acpi_ut_add_reference
686 * PARAMETERS: object - Object whose reference count is to be
691 * DESCRIPTION: Add one reference to an ACPI object
693 ******************************************************************************/
695 void acpi_ut_add_reference(union acpi_operand_object
*object
)
698 ACPI_FUNCTION_NAME(ut_add_reference
);
700 /* Ensure that we have a valid object */
702 if (!acpi_ut_valid_internal_object(object
)) {
706 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
,
707 "Obj %p Current Refs=%X [To Be Incremented]\n",
708 object
, object
->common
.reference_count
));
710 /* Increment the reference count */
712 (void)acpi_ut_update_object_reference(object
, REF_INCREMENT
);
716 /*******************************************************************************
718 * FUNCTION: acpi_ut_remove_reference
720 * PARAMETERS: object - Object whose ref count will be decremented
724 * DESCRIPTION: Decrement the reference count of an ACPI internal object
726 ******************************************************************************/
728 void acpi_ut_remove_reference(union acpi_operand_object
*object
)
731 ACPI_FUNCTION_NAME(ut_remove_reference
);
734 * Allow a NULL pointer to be passed in, just ignore it. This saves
735 * each caller from having to check. Also, ignore NS nodes.
738 (ACPI_GET_DESCRIPTOR_TYPE(object
) == ACPI_DESC_TYPE_NAMED
)) {
742 /* Ensure that we have a valid object */
744 if (!acpi_ut_valid_internal_object(object
)) {
748 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
,
749 "Obj %p Current Refs=%X [To Be Decremented]\n",
750 object
, object
->common
.reference_count
));
753 * Decrement the reference count, and only actually delete the object
754 * if the reference count becomes 0. (Must also decrement the ref count
755 * of all subobjects!)
757 (void)acpi_ut_update_object_reference(object
, REF_DECREMENT
);