1 // SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0
2 /*******************************************************************************
4 * Module Name: utdelete - object deletion and reference count utilities
6 ******************************************************************************/
14 #define _COMPONENT ACPI_UTILITIES
15 ACPI_MODULE_NAME("utdelete")
17 /* Local prototypes */
18 static void acpi_ut_delete_internal_obj(union acpi_operand_object
*object
);
21 acpi_ut_update_ref_count(union acpi_operand_object
*object
, u32 action
);
23 /*******************************************************************************
25 * FUNCTION: acpi_ut_delete_internal_obj
27 * PARAMETERS: object - Object to be deleted
31 * DESCRIPTION: Low level object deletion, after reference counts have been
32 * updated (All reference counts, including sub-objects!)
34 ******************************************************************************/
36 static void acpi_ut_delete_internal_obj(union acpi_operand_object
*object
)
38 void *obj_pointer
= NULL
;
39 union acpi_operand_object
*handler_desc
;
40 union acpi_operand_object
*second_desc
;
41 union acpi_operand_object
*next_desc
;
42 union acpi_operand_object
*start_desc
;
43 union acpi_operand_object
**last_obj_ptr
;
45 ACPI_FUNCTION_TRACE_PTR(ut_delete_internal_obj
, object
);
52 * Must delete or free any pointers within the object that are not
53 * actual ACPI objects (for example, a raw buffer pointer).
55 switch (object
->common
.type
) {
56 case ACPI_TYPE_STRING
:
58 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
,
59 "**** String %p, ptr %p\n", object
,
60 object
->string
.pointer
));
62 /* Free the actual string buffer */
64 if (!(object
->common
.flags
& AOPOBJ_STATIC_POINTER
)) {
66 /* But only if it is NOT a pointer into an ACPI table */
68 obj_pointer
= object
->string
.pointer
;
72 case ACPI_TYPE_BUFFER
:
74 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
,
75 "**** Buffer %p, ptr %p\n", object
,
76 object
->buffer
.pointer
));
78 /* Free the actual buffer */
80 if (!(object
->common
.flags
& AOPOBJ_STATIC_POINTER
)) {
82 /* But only if it is NOT a pointer into an ACPI table */
84 obj_pointer
= object
->buffer
.pointer
;
88 case ACPI_TYPE_PACKAGE
:
90 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
,
91 " **** Package of count %X\n",
92 object
->package
.count
));
95 * Elements of the package are not handled here, they are deleted
99 /* Free the (variable length) element pointer array */
101 obj_pointer
= object
->package
.elements
;
105 * These objects have a possible list of notify handlers.
106 * Device object also may have a GPE block.
108 case ACPI_TYPE_DEVICE
:
110 if (object
->device
.gpe_block
) {
111 (void)acpi_ev_delete_gpe_block(object
->device
.
115 /*lint -fallthrough */
117 case ACPI_TYPE_PROCESSOR
:
118 case ACPI_TYPE_THERMAL
:
120 /* Walk the address handler list for this object */
122 handler_desc
= object
->common_notify
.handler
;
123 while (handler_desc
) {
124 next_desc
= handler_desc
->address_space
.next
;
125 acpi_ut_remove_reference(handler_desc
);
126 handler_desc
= next_desc
;
130 case ACPI_TYPE_MUTEX
:
132 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
,
133 "***** Mutex %p, OS Mutex %p\n",
134 object
, object
->mutex
.os_mutex
));
136 if (object
== acpi_gbl_global_lock_mutex
) {
138 /* Global Lock has extra semaphore */
141 acpi_os_delete_semaphore
142 (acpi_gbl_global_lock_semaphore
);
143 acpi_gbl_global_lock_semaphore
= NULL
;
145 acpi_os_delete_mutex(object
->mutex
.os_mutex
);
146 acpi_gbl_global_lock_mutex
= NULL
;
148 acpi_ex_unlink_mutex(object
);
149 acpi_os_delete_mutex(object
->mutex
.os_mutex
);
153 case ACPI_TYPE_EVENT
:
155 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
,
156 "***** Event %p, OS Semaphore %p\n",
157 object
, object
->event
.os_semaphore
));
159 (void)acpi_os_delete_semaphore(object
->event
.os_semaphore
);
160 object
->event
.os_semaphore
= NULL
;
163 case ACPI_TYPE_METHOD
:
165 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
,
166 "***** Method %p\n", object
));
168 /* Delete the method mutex if it exists */
170 if (object
->method
.mutex
) {
171 acpi_os_delete_mutex(object
->method
.mutex
->mutex
.
173 acpi_ut_delete_object_desc(object
->method
.mutex
);
174 object
->method
.mutex
= NULL
;
177 if (object
->method
.node
) {
178 object
->method
.node
= NULL
;
182 case ACPI_TYPE_REGION
:
184 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
,
185 "***** Region %p\n", object
));
188 * Update address_range list. However, only permanent regions
189 * are installed in this list. (Not created within a method)
191 if (!(object
->region
.node
->flags
& ANOBJ_TEMPORARY
)) {
192 acpi_ut_remove_address_range(object
->region
.space_id
,
193 object
->region
.node
);
196 second_desc
= acpi_ns_get_secondary_object(object
);
199 * Free the region_context if and only if the handler is one of the
200 * default handlers -- and therefore, we created the context object
201 * locally, it was not created by an external caller.
203 handler_desc
= object
->region
.handler
;
206 handler_desc
->address_space
.region_list
;
207 start_desc
= next_desc
;
209 &handler_desc
->address_space
.region_list
;
211 /* Remove the region object from the handler list */
214 if (next_desc
== object
) {
216 next_desc
->region
.next
;
220 /* Walk the linked list of handlers */
222 last_obj_ptr
= &next_desc
->region
.next
;
223 next_desc
= next_desc
->region
.next
;
225 /* Prevent infinite loop if list is corrupted */
227 if (next_desc
== start_desc
) {
229 "Circular region list in address handler object %p",
235 if (handler_desc
->address_space
.handler_flags
&
236 ACPI_ADDR_HANDLER_DEFAULT_INSTALLED
) {
238 /* Deactivate region and free region context */
240 if (handler_desc
->address_space
.setup
) {
242 address_space
.setup(object
,
243 ACPI_REGION_DEACTIVATE
,
253 acpi_ut_remove_reference(handler_desc
);
256 /* Now we can free the Extra object */
258 acpi_ut_delete_object_desc(second_desc
);
262 case ACPI_TYPE_BUFFER_FIELD
:
264 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
,
265 "***** Buffer Field %p\n", object
));
267 second_desc
= acpi_ns_get_secondary_object(object
);
269 acpi_ut_delete_object_desc(second_desc
);
273 case ACPI_TYPE_LOCAL_BANK_FIELD
:
275 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
,
276 "***** Bank Field %p\n", object
));
278 second_desc
= acpi_ns_get_secondary_object(object
);
280 acpi_ut_delete_object_desc(second_desc
);
289 /* Free any allocated memory (pointer within the object) found above */
292 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
,
293 "Deleting Object Subptr %p\n", obj_pointer
));
294 ACPI_FREE(obj_pointer
);
297 /* Now the object can be safely deleted */
299 ACPI_DEBUG_PRINT_RAW((ACPI_DB_ALLOCATIONS
,
300 "%s: Deleting Object %p [%s]\n",
301 ACPI_GET_FUNCTION_NAME
, object
,
302 acpi_ut_get_object_type_name(object
)));
304 acpi_ut_delete_object_desc(object
);
308 /*******************************************************************************
310 * FUNCTION: acpi_ut_delete_internal_object_list
312 * PARAMETERS: obj_list - Pointer to the list to be deleted
316 * DESCRIPTION: This function deletes an internal object list, including both
317 * simple objects and package objects
319 ******************************************************************************/
321 void acpi_ut_delete_internal_object_list(union acpi_operand_object
**obj_list
)
323 union acpi_operand_object
**internal_obj
;
325 ACPI_FUNCTION_ENTRY();
327 /* Walk the null-terminated internal list */
329 for (internal_obj
= obj_list
; *internal_obj
; internal_obj
++) {
330 acpi_ut_remove_reference(*internal_obj
);
333 /* Free the combined parameter pointer list and object array */
339 /*******************************************************************************
341 * FUNCTION: acpi_ut_update_ref_count
343 * PARAMETERS: object - Object whose ref count is to be updated
344 * action - What to do (REF_INCREMENT or REF_DECREMENT)
346 * RETURN: None. Sets new reference count within the object
348 * DESCRIPTION: Modify the reference count for an internal acpi object
350 ******************************************************************************/
353 acpi_ut_update_ref_count(union acpi_operand_object
*object
, u32 action
)
357 acpi_cpu_flags lock_flags
;
359 ACPI_FUNCTION_NAME(ut_update_ref_count
);
366 * Always get the reference count lock. Note: Interpreter and/or
367 * Namespace is not always locked when this function is called.
369 lock_flags
= acpi_os_acquire_lock(acpi_gbl_reference_count_lock
);
370 original_count
= object
->common
.reference_count
;
372 /* Perform the reference count action (increment, decrement) */
377 new_count
= original_count
+ 1;
378 object
->common
.reference_count
= new_count
;
379 acpi_os_release_lock(acpi_gbl_reference_count_lock
, lock_flags
);
381 /* The current reference count should never be zero here */
383 if (!original_count
) {
384 ACPI_WARNING((AE_INFO
,
385 "Obj %p, Reference Count was zero before increment\n",
389 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
,
390 "Obj %p Type %.2X [%s] Refs %.2X [Incremented]\n",
391 object
, object
->common
.type
,
392 acpi_ut_get_object_type_name(object
),
398 /* The current reference count must be non-zero */
400 if (original_count
) {
401 new_count
= original_count
- 1;
402 object
->common
.reference_count
= new_count
;
405 acpi_os_release_lock(acpi_gbl_reference_count_lock
, lock_flags
);
407 if (!original_count
) {
408 ACPI_WARNING((AE_INFO
,
409 "Obj %p, Reference Count is already zero, cannot decrement\n",
413 ACPI_DEBUG_PRINT_RAW((ACPI_DB_ALLOCATIONS
,
414 "%s: Obj %p Type %.2X Refs %.2X [Decremented]\n",
415 ACPI_GET_FUNCTION_NAME
, object
,
416 object
->common
.type
, new_count
));
418 /* Actually delete the object on a reference count of zero */
420 if (new_count
== 0) {
421 acpi_ut_delete_internal_obj(object
);
427 acpi_os_release_lock(acpi_gbl_reference_count_lock
, lock_flags
);
428 ACPI_ERROR((AE_INFO
, "Unknown Reference Count action (0x%X)",
434 * Sanity check the reference count, for debug purposes only.
435 * (A deleted object will have a huge reference count)
437 if (new_count
> ACPI_MAX_REFERENCE_COUNT
) {
438 ACPI_WARNING((AE_INFO
,
439 "Large Reference Count (0x%X) in object %p, Type=0x%.2X",
440 new_count
, object
, object
->common
.type
));
444 /*******************************************************************************
446 * FUNCTION: acpi_ut_update_object_reference
448 * PARAMETERS: object - Increment ref count for this object
449 * and all sub-objects
450 * action - Either REF_INCREMENT or REF_DECREMENT
454 * DESCRIPTION: Increment the object reference count
456 * Object references are incremented when:
457 * 1) An object is attached to a Node (namespace object)
458 * 2) An object is copied (all subobjects must be incremented)
460 * Object references are decremented when:
461 * 1) An object is detached from an Node
463 ******************************************************************************/
466 acpi_ut_update_object_reference(union acpi_operand_object
*object
, u16 action
)
468 acpi_status status
= AE_OK
;
469 union acpi_generic_state
*state_list
= NULL
;
470 union acpi_operand_object
*next_object
= NULL
;
471 union acpi_operand_object
*prev_object
;
472 union acpi_generic_state
*state
;
475 ACPI_FUNCTION_NAME(ut_update_object_reference
);
479 /* Make sure that this isn't a namespace handle */
481 if (ACPI_GET_DESCRIPTOR_TYPE(object
) == ACPI_DESC_TYPE_NAMED
) {
482 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
,
483 "Object %p is NS handle\n", object
));
488 * All sub-objects must have their reference count incremented
489 * also. Different object types have different subobjects.
491 switch (object
->common
.type
) {
492 case ACPI_TYPE_DEVICE
:
493 case ACPI_TYPE_PROCESSOR
:
494 case ACPI_TYPE_POWER
:
495 case ACPI_TYPE_THERMAL
:
497 * Update the notify objects for these types (if present)
498 * Two lists, system and device notify handlers.
500 for (i
= 0; i
< ACPI_NUM_NOTIFY_TYPES
; i
++) {
502 object
->common_notify
.notify_list
[i
];
503 while (prev_object
) {
505 prev_object
->notify
.next
[i
];
506 acpi_ut_update_ref_count(prev_object
,
508 prev_object
= next_object
;
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 * Null package elements are legal and can be simply
523 next_object
= object
->package
.elements
[i
];
528 switch (next_object
->common
.type
) {
529 case ACPI_TYPE_INTEGER
:
530 case ACPI_TYPE_STRING
:
531 case ACPI_TYPE_BUFFER
:
533 * For these very simple sub-objects, we can just
534 * update the reference count here and continue.
535 * Greatly increases performance of this operation.
537 acpi_ut_update_ref_count(next_object
,
543 * For complex sub-objects, push them onto the stack
544 * for later processing (this eliminates recursion.)
547 acpi_ut_create_update_state_and_push
548 (next_object
, action
, &state_list
);
549 if (ACPI_FAILURE(status
)) {
558 case ACPI_TYPE_BUFFER_FIELD
:
560 next_object
= object
->buffer_field
.buffer_obj
;
563 case ACPI_TYPE_LOCAL_REGION_FIELD
:
565 next_object
= object
->field
.region_obj
;
568 case ACPI_TYPE_LOCAL_BANK_FIELD
:
570 next_object
= object
->bank_field
.bank_obj
;
572 acpi_ut_create_update_state_and_push(object
->
577 if (ACPI_FAILURE(status
)) {
582 case ACPI_TYPE_LOCAL_INDEX_FIELD
:
584 next_object
= object
->index_field
.index_obj
;
586 acpi_ut_create_update_state_and_push(object
->
591 if (ACPI_FAILURE(status
)) {
596 case ACPI_TYPE_LOCAL_REFERENCE
:
598 * The target of an Index (a package, string, or buffer) or a named
599 * reference must track changes to the ref count of the index or
602 if ((object
->reference
.class == ACPI_REFCLASS_INDEX
) ||
603 (object
->reference
.class == ACPI_REFCLASS_NAME
)) {
604 next_object
= object
->reference
.object
;
608 case ACPI_TYPE_REGION
:
611 break; /* No subobjects for all other types */
615 * Now we can update the count in the main object. This can only
616 * happen after we update the sub-objects in case this causes the
617 * main object to be deleted.
619 acpi_ut_update_ref_count(object
, action
);
622 /* Move on to the next object to be updated */
625 object
= next_object
;
627 } else if (state_list
) {
628 state
= acpi_ut_pop_generic_state(&state_list
);
629 object
= state
->update
.object
;
630 acpi_ut_delete_generic_state(state
);
638 ACPI_EXCEPTION((AE_INFO
, status
,
639 "Could not update object reference count"));
641 /* Free any stacked Update State objects */
644 state
= acpi_ut_pop_generic_state(&state_list
);
645 acpi_ut_delete_generic_state(state
);
651 /*******************************************************************************
653 * FUNCTION: acpi_ut_add_reference
655 * PARAMETERS: object - Object whose reference count is to be
660 * DESCRIPTION: Add one reference to an ACPI object
662 ******************************************************************************/
664 void acpi_ut_add_reference(union acpi_operand_object
*object
)
667 ACPI_FUNCTION_NAME(ut_add_reference
);
669 /* Ensure that we have a valid object */
671 if (!acpi_ut_valid_internal_object(object
)) {
675 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
,
676 "Obj %p Current Refs=%X [To Be Incremented]\n",
677 object
, object
->common
.reference_count
));
679 /* Increment the reference count */
681 (void)acpi_ut_update_object_reference(object
, REF_INCREMENT
);
685 /*******************************************************************************
687 * FUNCTION: acpi_ut_remove_reference
689 * PARAMETERS: object - Object whose ref count will be decremented
693 * DESCRIPTION: Decrement the reference count of an ACPI internal object
695 ******************************************************************************/
697 void acpi_ut_remove_reference(union acpi_operand_object
*object
)
700 ACPI_FUNCTION_NAME(ut_remove_reference
);
703 * Allow a NULL pointer to be passed in, just ignore it. This saves
704 * each caller from having to check. Also, ignore NS nodes.
707 (ACPI_GET_DESCRIPTOR_TYPE(object
) == ACPI_DESC_TYPE_NAMED
)) {
711 /* Ensure that we have a valid object */
713 if (!acpi_ut_valid_internal_object(object
)) {
717 ACPI_DEBUG_PRINT_RAW((ACPI_DB_ALLOCATIONS
,
718 "%s: Obj %p Current Refs=%X [To Be Decremented]\n",
719 ACPI_GET_FUNCTION_NAME
, object
,
720 object
->common
.reference_count
));
723 * Decrement the reference count, and only actually delete the object
724 * if the reference count becomes 0. (Must also decrement the ref count
725 * of all subobjects!)
727 (void)acpi_ut_update_object_reference(object
, REF_DECREMENT
);