Loading...
1// SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0
2/*******************************************************************************
3 *
4 * Module Name: utdelete - object deletion and reference count utilities
5 *
6 ******************************************************************************/
7
8#include <acpi/acpi.h>
9#include "accommon.h"
10#include "acinterp.h"
11#include "acnamesp.h"
12#include "acevents.h"
13
14#define _COMPONENT ACPI_UTILITIES
15ACPI_MODULE_NAME("utdelete")
16
17/* Local prototypes */
18static void acpi_ut_delete_internal_obj(union acpi_operand_object *object);
19
20static void
21acpi_ut_update_ref_count(union acpi_operand_object *object, u32 action);
22
23/*******************************************************************************
24 *
25 * FUNCTION: acpi_ut_delete_internal_obj
26 *
27 * PARAMETERS: object - Object to be deleted
28 *
29 * RETURN: None
30 *
31 * DESCRIPTION: Low level object deletion, after reference counts have been
32 * updated (All reference counts, including sub-objects!)
33 *
34 ******************************************************************************/
35
36static void acpi_ut_delete_internal_obj(union acpi_operand_object *object)
37{
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;
44
45 ACPI_FUNCTION_TRACE_PTR(ut_delete_internal_obj, object);
46
47 if (!object) {
48 return_VOID;
49 }
50
51 /*
52 * Must delete or free any pointers within the object that are not
53 * actual ACPI objects (for example, a raw buffer pointer).
54 */
55 switch (object->common.type) {
56 case ACPI_TYPE_STRING:
57
58 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
59 "**** String %p, ptr %p\n", object,
60 object->string.pointer));
61
62 /* Free the actual string buffer */
63
64 if (!(object->common.flags & AOPOBJ_STATIC_POINTER)) {
65
66 /* But only if it is NOT a pointer into an ACPI table */
67
68 obj_pointer = object->string.pointer;
69 }
70 break;
71
72 case ACPI_TYPE_BUFFER:
73
74 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
75 "**** Buffer %p, ptr %p\n", object,
76 object->buffer.pointer));
77
78 /* Free the actual buffer */
79
80 if (!(object->common.flags & AOPOBJ_STATIC_POINTER)) {
81
82 /* But only if it is NOT a pointer into an ACPI table */
83
84 obj_pointer = object->buffer.pointer;
85 }
86 break;
87
88 case ACPI_TYPE_PACKAGE:
89
90 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
91 " **** Package of count %X\n",
92 object->package.count));
93
94 /*
95 * Elements of the package are not handled here, they are deleted
96 * separately
97 */
98
99 /* Free the (variable length) element pointer array */
100
101 obj_pointer = object->package.elements;
102 break;
103
104 /*
105 * These objects have a possible list of notify handlers.
106 * Device object also may have a GPE block.
107 */
108 case ACPI_TYPE_DEVICE:
109
110 if (object->device.gpe_block) {
111 (void)acpi_ev_delete_gpe_block(object->device.
112 gpe_block);
113 }
114
115 /*lint -fallthrough */
116
117 case ACPI_TYPE_PROCESSOR:
118 case ACPI_TYPE_THERMAL:
119
120 /* Walk the address handler list for this object */
121
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;
127 }
128 break;
129
130 case ACPI_TYPE_MUTEX:
131
132 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
133 "***** Mutex %p, OS Mutex %p\n",
134 object, object->mutex.os_mutex));
135
136 if (object == acpi_gbl_global_lock_mutex) {
137
138 /* Global Lock has extra semaphore */
139
140 (void)
141 acpi_os_delete_semaphore
142 (acpi_gbl_global_lock_semaphore);
143 acpi_gbl_global_lock_semaphore = NULL;
144
145 acpi_os_delete_mutex(object->mutex.os_mutex);
146 acpi_gbl_global_lock_mutex = NULL;
147 } else {
148 acpi_ex_unlink_mutex(object);
149 acpi_os_delete_mutex(object->mutex.os_mutex);
150 }
151 break;
152
153 case ACPI_TYPE_EVENT:
154
155 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
156 "***** Event %p, OS Semaphore %p\n",
157 object, object->event.os_semaphore));
158
159 (void)acpi_os_delete_semaphore(object->event.os_semaphore);
160 object->event.os_semaphore = NULL;
161 break;
162
163 case ACPI_TYPE_METHOD:
164
165 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
166 "***** Method %p\n", object));
167
168 /* Delete the method mutex if it exists */
169
170 if (object->method.mutex) {
171 acpi_os_delete_mutex(object->method.mutex->mutex.
172 os_mutex);
173 acpi_ut_delete_object_desc(object->method.mutex);
174 object->method.mutex = NULL;
175 }
176
177 if (object->method.node) {
178 object->method.node = NULL;
179 }
180 break;
181
182 case ACPI_TYPE_REGION:
183
184 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
185 "***** Region %p\n", object));
186
187 /*
188 * Update address_range list. However, only permanent regions
189 * are installed in this list. (Not created within a method)
190 */
191 if (!(object->region.node->flags & ANOBJ_TEMPORARY)) {
192 acpi_ut_remove_address_range(object->region.space_id,
193 object->region.node);
194 }
195
196 second_desc = acpi_ns_get_secondary_object(object);
197 if (second_desc) {
198 /*
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.
202 */
203 handler_desc = object->region.handler;
204 if (handler_desc) {
205 next_desc =
206 handler_desc->address_space.region_list;
207 start_desc = next_desc;
208 last_obj_ptr =
209 &handler_desc->address_space.region_list;
210
211 /* Remove the region object from the handler list */
212
213 while (next_desc) {
214 if (next_desc == object) {
215 *last_obj_ptr =
216 next_desc->region.next;
217 break;
218 }
219
220 /* Walk the linked list of handlers */
221
222 last_obj_ptr = &next_desc->region.next;
223 next_desc = next_desc->region.next;
224
225 /* Prevent infinite loop if list is corrupted */
226
227 if (next_desc == start_desc) {
228 ACPI_ERROR((AE_INFO,
229 "Circular region list in address handler object %p",
230 handler_desc));
231 return_VOID;
232 }
233 }
234
235 if (handler_desc->address_space.handler_flags &
236 ACPI_ADDR_HANDLER_DEFAULT_INSTALLED) {
237
238 /* Deactivate region and free region context */
239
240 if (handler_desc->address_space.setup) {
241 (void)handler_desc->
242 address_space.setup(object,
243 ACPI_REGION_DEACTIVATE,
244 handler_desc->
245 address_space.
246 context,
247 &second_desc->
248 extra.
249 region_context);
250 }
251 }
252
253 acpi_ut_remove_reference(handler_desc);
254 }
255
256 /* Now we can free the Extra object */
257
258 acpi_ut_delete_object_desc(second_desc);
259 }
260 if (object->field.internal_pcc_buffer) {
261 ACPI_FREE(object->field.internal_pcc_buffer);
262 }
263
264 break;
265
266 case ACPI_TYPE_BUFFER_FIELD:
267
268 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
269 "***** Buffer Field %p\n", object));
270
271 second_desc = acpi_ns_get_secondary_object(object);
272 if (second_desc) {
273 acpi_ut_delete_object_desc(second_desc);
274 }
275 break;
276
277 case ACPI_TYPE_LOCAL_BANK_FIELD:
278
279 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
280 "***** Bank Field %p\n", object));
281
282 second_desc = acpi_ns_get_secondary_object(object);
283 if (second_desc) {
284 acpi_ut_delete_object_desc(second_desc);
285 }
286 break;
287
288 default:
289
290 break;
291 }
292
293 /* Free any allocated memory (pointer within the object) found above */
294
295 if (obj_pointer) {
296 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
297 "Deleting Object Subptr %p\n", obj_pointer));
298 ACPI_FREE(obj_pointer);
299 }
300
301 /* Now the object can be safely deleted */
302
303 ACPI_DEBUG_PRINT_RAW((ACPI_DB_ALLOCATIONS,
304 "%s: Deleting Object %p [%s]\n",
305 ACPI_GET_FUNCTION_NAME, object,
306 acpi_ut_get_object_type_name(object)));
307
308 acpi_ut_delete_object_desc(object);
309 return_VOID;
310}
311
312/*******************************************************************************
313 *
314 * FUNCTION: acpi_ut_delete_internal_object_list
315 *
316 * PARAMETERS: obj_list - Pointer to the list to be deleted
317 *
318 * RETURN: None
319 *
320 * DESCRIPTION: This function deletes an internal object list, including both
321 * simple objects and package objects
322 *
323 ******************************************************************************/
324
325void acpi_ut_delete_internal_object_list(union acpi_operand_object **obj_list)
326{
327 union acpi_operand_object **internal_obj;
328
329 ACPI_FUNCTION_ENTRY();
330
331 /* Walk the null-terminated internal list */
332
333 for (internal_obj = obj_list; *internal_obj; internal_obj++) {
334 acpi_ut_remove_reference(*internal_obj);
335 }
336
337 /* Free the combined parameter pointer list and object array */
338
339 ACPI_FREE(obj_list);
340 return;
341}
342
343/*******************************************************************************
344 *
345 * FUNCTION: acpi_ut_update_ref_count
346 *
347 * PARAMETERS: object - Object whose ref count is to be updated
348 * action - What to do (REF_INCREMENT or REF_DECREMENT)
349 *
350 * RETURN: None. Sets new reference count within the object
351 *
352 * DESCRIPTION: Modify the reference count for an internal acpi object
353 *
354 ******************************************************************************/
355
356static void
357acpi_ut_update_ref_count(union acpi_operand_object *object, u32 action)
358{
359 u16 original_count;
360 u16 new_count = 0;
361 acpi_cpu_flags lock_flags;
362 char *message;
363
364 ACPI_FUNCTION_NAME(ut_update_ref_count);
365
366 if (!object) {
367 return;
368 }
369
370 /*
371 * Always get the reference count lock. Note: Interpreter and/or
372 * Namespace is not always locked when this function is called.
373 */
374 lock_flags = acpi_os_acquire_lock(acpi_gbl_reference_count_lock);
375 original_count = object->common.reference_count;
376
377 /* Perform the reference count action (increment, decrement) */
378
379 switch (action) {
380 case REF_INCREMENT:
381
382 new_count = original_count + 1;
383 object->common.reference_count = new_count;
384 acpi_os_release_lock(acpi_gbl_reference_count_lock, lock_flags);
385
386 /* The current reference count should never be zero here */
387
388 if (!original_count) {
389 ACPI_WARNING((AE_INFO,
390 "Obj %p, Reference Count was zero before increment\n",
391 object));
392 }
393
394 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
395 "Obj %p Type %.2X [%s] Refs %.2X [Incremented]\n",
396 object, object->common.type,
397 acpi_ut_get_object_type_name(object),
398 new_count));
399 message = "Incremement";
400 break;
401
402 case REF_DECREMENT:
403
404 /* The current reference count must be non-zero */
405
406 if (original_count) {
407 new_count = original_count - 1;
408 object->common.reference_count = new_count;
409 }
410
411 acpi_os_release_lock(acpi_gbl_reference_count_lock, lock_flags);
412
413 if (!original_count) {
414 ACPI_WARNING((AE_INFO,
415 "Obj %p, Reference Count is already zero, cannot decrement\n",
416 object));
417 }
418
419 ACPI_DEBUG_PRINT_RAW((ACPI_DB_ALLOCATIONS,
420 "%s: Obj %p Type %.2X Refs %.2X [Decremented]\n",
421 ACPI_GET_FUNCTION_NAME, object,
422 object->common.type, new_count));
423
424 /* Actually delete the object on a reference count of zero */
425
426 if (new_count == 0) {
427 acpi_ut_delete_internal_obj(object);
428 }
429 message = "Decrement";
430 break;
431
432 default:
433
434 acpi_os_release_lock(acpi_gbl_reference_count_lock, lock_flags);
435 ACPI_ERROR((AE_INFO, "Unknown Reference Count action (0x%X)",
436 action));
437 return;
438 }
439
440 /*
441 * Sanity check the reference count, for debug purposes only.
442 * (A deleted object will have a huge reference count)
443 */
444 if (new_count > ACPI_MAX_REFERENCE_COUNT) {
445 ACPI_WARNING((AE_INFO,
446 "Large Reference Count (0x%X) in object %p, Type=0x%.2X Operation=%s",
447 new_count, object, object->common.type, message));
448 }
449}
450
451/*******************************************************************************
452 *
453 * FUNCTION: acpi_ut_update_object_reference
454 *
455 * PARAMETERS: object - Increment or decrement the ref count for
456 * this object and all sub-objects
457 * action - Either REF_INCREMENT or REF_DECREMENT
458 *
459 * RETURN: Status
460 *
461 * DESCRIPTION: Increment or decrement the object reference count
462 *
463 * Object references are incremented when:
464 * 1) An object is attached to a Node (namespace object)
465 * 2) An object is copied (all subobjects must be incremented)
466 *
467 * Object references are decremented when:
468 * 1) An object is detached from an Node
469 *
470 ******************************************************************************/
471
472acpi_status
473acpi_ut_update_object_reference(union acpi_operand_object *object, u16 action)
474{
475 acpi_status status = AE_OK;
476 union acpi_generic_state *state_list = NULL;
477 union acpi_operand_object *next_object = NULL;
478 union acpi_operand_object *prev_object;
479 union acpi_generic_state *state;
480 u32 i;
481
482 ACPI_FUNCTION_NAME(ut_update_object_reference);
483
484 while (object) {
485
486 /* Make sure that this isn't a namespace handle */
487
488 if (ACPI_GET_DESCRIPTOR_TYPE(object) == ACPI_DESC_TYPE_NAMED) {
489 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
490 "Object %p is NS handle\n", object));
491 return (AE_OK);
492 }
493
494 /*
495 * All sub-objects must have their reference count updated
496 * also. Different object types have different subobjects.
497 */
498 switch (object->common.type) {
499 case ACPI_TYPE_DEVICE:
500 case ACPI_TYPE_PROCESSOR:
501 case ACPI_TYPE_POWER:
502 case ACPI_TYPE_THERMAL:
503 /*
504 * Update the notify objects for these types (if present)
505 * Two lists, system and device notify handlers.
506 */
507 for (i = 0; i < ACPI_NUM_NOTIFY_TYPES; i++) {
508 prev_object =
509 object->common_notify.notify_list[i];
510 while (prev_object) {
511 next_object =
512 prev_object->notify.next[i];
513 acpi_ut_update_ref_count(prev_object,
514 action);
515 prev_object = next_object;
516 }
517 }
518 break;
519
520 case ACPI_TYPE_PACKAGE:
521 /*
522 * We must update all the sub-objects of the package,
523 * each of whom may have their own sub-objects.
524 */
525 for (i = 0; i < object->package.count; i++) {
526 /*
527 * Null package elements are legal and can be simply
528 * ignored.
529 */
530 next_object = object->package.elements[i];
531 if (!next_object) {
532 continue;
533 }
534
535 switch (next_object->common.type) {
536 case ACPI_TYPE_INTEGER:
537 case ACPI_TYPE_STRING:
538 case ACPI_TYPE_BUFFER:
539 /*
540 * For these very simple sub-objects, we can just
541 * update the reference count here and continue.
542 * Greatly increases performance of this operation.
543 */
544 acpi_ut_update_ref_count(next_object,
545 action);
546 break;
547
548 default:
549 /*
550 * For complex sub-objects, push them onto the stack
551 * for later processing (this eliminates recursion.)
552 */
553 status =
554 acpi_ut_create_update_state_and_push
555 (next_object, action, &state_list);
556 if (ACPI_FAILURE(status)) {
557 goto error_exit;
558 }
559 break;
560 }
561 }
562
563 next_object = NULL;
564 break;
565
566 case ACPI_TYPE_BUFFER_FIELD:
567
568 next_object = object->buffer_field.buffer_obj;
569 break;
570
571 case ACPI_TYPE_LOCAL_BANK_FIELD:
572
573 next_object = object->bank_field.bank_obj;
574 status =
575 acpi_ut_create_update_state_and_push(object->
576 bank_field.
577 region_obj,
578 action,
579 &state_list);
580 if (ACPI_FAILURE(status)) {
581 goto error_exit;
582 }
583 break;
584
585 case ACPI_TYPE_LOCAL_INDEX_FIELD:
586
587 next_object = object->index_field.index_obj;
588 status =
589 acpi_ut_create_update_state_and_push(object->
590 index_field.
591 data_obj,
592 action,
593 &state_list);
594 if (ACPI_FAILURE(status)) {
595 goto error_exit;
596 }
597 break;
598
599 case ACPI_TYPE_LOCAL_REFERENCE:
600 /*
601 * The target of an Index (a package, string, or buffer) or a named
602 * reference must track changes to the ref count of the index or
603 * target object.
604 */
605 if ((object->reference.class == ACPI_REFCLASS_INDEX) ||
606 (object->reference.class == ACPI_REFCLASS_NAME)) {
607 next_object = object->reference.object;
608 }
609 break;
610
611 case ACPI_TYPE_LOCAL_REGION_FIELD:
612 case ACPI_TYPE_REGION:
613 default:
614
615 break; /* No subobjects for all other types */
616 }
617
618 /*
619 * Now we can update the count in the main object. This can only
620 * happen after we update the sub-objects in case this causes the
621 * main object to be deleted.
622 */
623 acpi_ut_update_ref_count(object, action);
624 object = NULL;
625
626 /* Move on to the next object to be updated */
627
628 if (next_object) {
629 object = next_object;
630 next_object = NULL;
631 } else if (state_list) {
632 state = acpi_ut_pop_generic_state(&state_list);
633 object = state->update.object;
634 acpi_ut_delete_generic_state(state);
635 }
636 }
637
638 return (AE_OK);
639
640error_exit:
641
642 ACPI_EXCEPTION((AE_INFO, status,
643 "Could not update object reference count"));
644
645 /* Free any stacked Update State objects */
646
647 while (state_list) {
648 state = acpi_ut_pop_generic_state(&state_list);
649 acpi_ut_delete_generic_state(state);
650 }
651
652 return (status);
653}
654
655/*******************************************************************************
656 *
657 * FUNCTION: acpi_ut_add_reference
658 *
659 * PARAMETERS: object - Object whose reference count is to be
660 * incremented
661 *
662 * RETURN: None
663 *
664 * DESCRIPTION: Add one reference to an ACPI object
665 *
666 ******************************************************************************/
667
668void acpi_ut_add_reference(union acpi_operand_object *object)
669{
670
671 ACPI_FUNCTION_NAME(ut_add_reference);
672
673 /* Ensure that we have a valid object */
674
675 if (!acpi_ut_valid_internal_object(object)) {
676 return;
677 }
678
679 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
680 "Obj %p Current Refs=%X [To Be Incremented]\n",
681 object, object->common.reference_count));
682
683 /* Increment the reference count */
684
685 (void)acpi_ut_update_object_reference(object, REF_INCREMENT);
686 return;
687}
688
689/*******************************************************************************
690 *
691 * FUNCTION: acpi_ut_remove_reference
692 *
693 * PARAMETERS: object - Object whose ref count will be decremented
694 *
695 * RETURN: None
696 *
697 * DESCRIPTION: Decrement the reference count of an ACPI internal object
698 *
699 ******************************************************************************/
700
701void acpi_ut_remove_reference(union acpi_operand_object *object)
702{
703
704 ACPI_FUNCTION_NAME(ut_remove_reference);
705
706 /*
707 * Allow a NULL pointer to be passed in, just ignore it. This saves
708 * each caller from having to check. Also, ignore NS nodes.
709 */
710 if (!object ||
711 (ACPI_GET_DESCRIPTOR_TYPE(object) == ACPI_DESC_TYPE_NAMED)) {
712 return;
713 }
714
715 /* Ensure that we have a valid object */
716
717 if (!acpi_ut_valid_internal_object(object)) {
718 return;
719 }
720
721 ACPI_DEBUG_PRINT_RAW((ACPI_DB_ALLOCATIONS,
722 "%s: Obj %p Current Refs=%X [To Be Decremented]\n",
723 ACPI_GET_FUNCTION_NAME, object,
724 object->common.reference_count));
725
726 /*
727 * Decrement the reference count, and only actually delete the object
728 * if the reference count becomes 0. (Must also decrement the ref count
729 * of all subobjects!)
730 */
731 (void)acpi_ut_update_object_reference(object, REF_DECREMENT);
732 return;
733}
1/*******************************************************************************
2 *
3 * Module Name: utdelete - object deletion and reference count utilities
4 *
5 ******************************************************************************/
6
7/*
8 * Copyright (C) 2000 - 2016, Intel Corp.
9 * All rights reserved.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
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.
25 *
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.
29 *
30 * NO WARRANTY
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.
42 */
43
44#include <acpi/acpi.h>
45#include "accommon.h"
46#include "acinterp.h"
47#include "acnamesp.h"
48#include "acevents.h"
49
50#define _COMPONENT ACPI_UTILITIES
51ACPI_MODULE_NAME("utdelete")
52
53/* Local prototypes */
54static void acpi_ut_delete_internal_obj(union acpi_operand_object *object);
55
56static void
57acpi_ut_update_ref_count(union acpi_operand_object *object, u32 action);
58
59/*******************************************************************************
60 *
61 * FUNCTION: acpi_ut_delete_internal_obj
62 *
63 * PARAMETERS: object - Object to be deleted
64 *
65 * RETURN: None
66 *
67 * DESCRIPTION: Low level object deletion, after reference counts have been
68 * updated (All reference counts, including sub-objects!)
69 *
70 ******************************************************************************/
71
72static void acpi_ut_delete_internal_obj(union acpi_operand_object *object)
73{
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;
80
81 ACPI_FUNCTION_TRACE_PTR(ut_delete_internal_obj, object);
82
83 if (!object) {
84 return_VOID;
85 }
86
87 /*
88 * Must delete or free any pointers within the object that are not
89 * actual ACPI objects (for example, a raw buffer pointer).
90 */
91 switch (object->common.type) {
92 case ACPI_TYPE_STRING:
93
94 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
95 "**** String %p, ptr %p\n", object,
96 object->string.pointer));
97
98 /* Free the actual string buffer */
99
100 if (!(object->common.flags & AOPOBJ_STATIC_POINTER)) {
101
102 /* But only if it is NOT a pointer into an ACPI table */
103
104 obj_pointer = object->string.pointer;
105 }
106 break;
107
108 case ACPI_TYPE_BUFFER:
109
110 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
111 "**** Buffer %p, ptr %p\n", object,
112 object->buffer.pointer));
113
114 /* Free the actual buffer */
115
116 if (!(object->common.flags & AOPOBJ_STATIC_POINTER)) {
117
118 /* But only if it is NOT a pointer into an ACPI table */
119
120 obj_pointer = object->buffer.pointer;
121 }
122 break;
123
124 case ACPI_TYPE_PACKAGE:
125
126 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
127 " **** Package of count %X\n",
128 object->package.count));
129
130 /*
131 * Elements of the package are not handled here, they are deleted
132 * separately
133 */
134
135 /* Free the (variable length) element pointer array */
136
137 obj_pointer = object->package.elements;
138 break;
139
140 /*
141 * These objects have a possible list of notify handlers.
142 * Device object also may have a GPE block.
143 */
144 case ACPI_TYPE_DEVICE:
145
146 if (object->device.gpe_block) {
147 (void)acpi_ev_delete_gpe_block(object->device.
148 gpe_block);
149 }
150
151 /*lint -fallthrough */
152
153 case ACPI_TYPE_PROCESSOR:
154 case ACPI_TYPE_THERMAL:
155
156 /* Walk the address handler list for this object */
157
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;
163 }
164 break;
165
166 case ACPI_TYPE_MUTEX:
167
168 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
169 "***** Mutex %p, OS Mutex %p\n",
170 object, object->mutex.os_mutex));
171
172 if (object == acpi_gbl_global_lock_mutex) {
173
174 /* Global Lock has extra semaphore */
175
176 (void)
177 acpi_os_delete_semaphore
178 (acpi_gbl_global_lock_semaphore);
179 acpi_gbl_global_lock_semaphore = NULL;
180
181 acpi_os_delete_mutex(object->mutex.os_mutex);
182 acpi_gbl_global_lock_mutex = NULL;
183 } else {
184 acpi_ex_unlink_mutex(object);
185 acpi_os_delete_mutex(object->mutex.os_mutex);
186 }
187 break;
188
189 case ACPI_TYPE_EVENT:
190
191 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
192 "***** Event %p, OS Semaphore %p\n",
193 object, object->event.os_semaphore));
194
195 (void)acpi_os_delete_semaphore(object->event.os_semaphore);
196 object->event.os_semaphore = NULL;
197 break;
198
199 case ACPI_TYPE_METHOD:
200
201 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
202 "***** Method %p\n", object));
203
204 /* Delete the method mutex if it exists */
205
206 if (object->method.mutex) {
207 acpi_os_delete_mutex(object->method.mutex->mutex.
208 os_mutex);
209 acpi_ut_delete_object_desc(object->method.mutex);
210 object->method.mutex = NULL;
211 }
212
213 if (object->method.node) {
214 object->method.node = NULL;
215 }
216 break;
217
218 case ACPI_TYPE_REGION:
219
220 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
221 "***** Region %p\n", object));
222
223 /*
224 * Update address_range list. However, only permanent regions
225 * are installed in this list. (Not created within a method)
226 */
227 if (!(object->region.node->flags & ANOBJ_TEMPORARY)) {
228 acpi_ut_remove_address_range(object->region.space_id,
229 object->region.node);
230 }
231
232 second_desc = acpi_ns_get_secondary_object(object);
233 if (second_desc) {
234 /*
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.
238 */
239 handler_desc = object->region.handler;
240 if (handler_desc) {
241 next_desc =
242 handler_desc->address_space.region_list;
243 start_desc = next_desc;
244 last_obj_ptr =
245 &handler_desc->address_space.region_list;
246
247 /* Remove the region object from the handler list */
248
249 while (next_desc) {
250 if (next_desc == object) {
251 *last_obj_ptr =
252 next_desc->region.next;
253 break;
254 }
255
256 /* Walk the linked list of handlers */
257
258 last_obj_ptr = &next_desc->region.next;
259 next_desc = next_desc->region.next;
260
261 /* Prevent infinite loop if list is corrupted */
262
263 if (next_desc == start_desc) {
264 ACPI_ERROR((AE_INFO,
265 "Circular region list in address handler object %p",
266 handler_desc));
267 return_VOID;
268 }
269 }
270
271 if (handler_desc->address_space.handler_flags &
272 ACPI_ADDR_HANDLER_DEFAULT_INSTALLED) {
273
274 /* Deactivate region and free region context */
275
276 if (handler_desc->address_space.setup) {
277 (void)handler_desc->
278 address_space.setup(object,
279 ACPI_REGION_DEACTIVATE,
280 handler_desc->
281 address_space.
282 context,
283 &second_desc->
284 extra.
285 region_context);
286 }
287 }
288
289 acpi_ut_remove_reference(handler_desc);
290 }
291
292 /* Now we can free the Extra object */
293
294 acpi_ut_delete_object_desc(second_desc);
295 }
296 break;
297
298 case ACPI_TYPE_BUFFER_FIELD:
299
300 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
301 "***** Buffer Field %p\n", object));
302
303 second_desc = acpi_ns_get_secondary_object(object);
304 if (second_desc) {
305 acpi_ut_delete_object_desc(second_desc);
306 }
307 break;
308
309 case ACPI_TYPE_LOCAL_BANK_FIELD:
310
311 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
312 "***** Bank Field %p\n", object));
313
314 second_desc = acpi_ns_get_secondary_object(object);
315 if (second_desc) {
316 acpi_ut_delete_object_desc(second_desc);
317 }
318 break;
319
320 default:
321
322 break;
323 }
324
325 /* Free any allocated memory (pointer within the object) found above */
326
327 if (obj_pointer) {
328 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
329 "Deleting Object Subptr %p\n", obj_pointer));
330 ACPI_FREE(obj_pointer);
331 }
332
333 /* Now the object can be safely deleted */
334
335 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS, "Deleting Object %p [%s]\n",
336 object, acpi_ut_get_object_type_name(object)));
337
338 acpi_ut_delete_object_desc(object);
339 return_VOID;
340}
341
342/*******************************************************************************
343 *
344 * FUNCTION: acpi_ut_delete_internal_object_list
345 *
346 * PARAMETERS: obj_list - Pointer to the list to be deleted
347 *
348 * RETURN: None
349 *
350 * DESCRIPTION: This function deletes an internal object list, including both
351 * simple objects and package objects
352 *
353 ******************************************************************************/
354
355void acpi_ut_delete_internal_object_list(union acpi_operand_object **obj_list)
356{
357 union acpi_operand_object **internal_obj;
358
359 ACPI_FUNCTION_ENTRY();
360
361 /* Walk the null-terminated internal list */
362
363 for (internal_obj = obj_list; *internal_obj; internal_obj++) {
364 acpi_ut_remove_reference(*internal_obj);
365 }
366
367 /* Free the combined parameter pointer list and object array */
368
369 ACPI_FREE(obj_list);
370 return;
371}
372
373/*******************************************************************************
374 *
375 * FUNCTION: acpi_ut_update_ref_count
376 *
377 * PARAMETERS: object - Object whose ref count is to be updated
378 * action - What to do (REF_INCREMENT or REF_DECREMENT)
379 *
380 * RETURN: None. Sets new reference count within the object
381 *
382 * DESCRIPTION: Modify the reference count for an internal acpi object
383 *
384 ******************************************************************************/
385
386static void
387acpi_ut_update_ref_count(union acpi_operand_object *object, u32 action)
388{
389 u16 original_count;
390 u16 new_count = 0;
391 acpi_cpu_flags lock_flags;
392
393 ACPI_FUNCTION_NAME(ut_update_ref_count);
394
395 if (!object) {
396 return;
397 }
398
399 /*
400 * Always get the reference count lock. Note: Interpreter and/or
401 * Namespace is not always locked when this function is called.
402 */
403 lock_flags = acpi_os_acquire_lock(acpi_gbl_reference_count_lock);
404 original_count = object->common.reference_count;
405
406 /* Perform the reference count action (increment, decrement) */
407
408 switch (action) {
409 case REF_INCREMENT:
410
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);
414
415 /* The current reference count should never be zero here */
416
417 if (!original_count) {
418 ACPI_WARNING((AE_INFO,
419 "Obj %p, Reference Count was zero before increment\n",
420 object));
421 }
422
423 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
424 "Obj %p Type %.2X Refs %.2X [Incremented]\n",
425 object, object->common.type, new_count));
426 break;
427
428 case REF_DECREMENT:
429
430 /* The current reference count must be non-zero */
431
432 if (original_count) {
433 new_count = original_count - 1;
434 object->common.reference_count = new_count;
435 }
436
437 acpi_os_release_lock(acpi_gbl_reference_count_lock, lock_flags);
438
439 if (!original_count) {
440 ACPI_WARNING((AE_INFO,
441 "Obj %p, Reference Count is already zero, cannot decrement\n",
442 object));
443 }
444
445 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
446 "Obj %p Type %.2X Refs %.2X [Decremented]\n",
447 object, object->common.type, new_count));
448
449 /* Actually delete the object on a reference count of zero */
450
451 if (new_count == 0) {
452 acpi_ut_delete_internal_obj(object);
453 }
454 break;
455
456 default:
457
458 acpi_os_release_lock(acpi_gbl_reference_count_lock, lock_flags);
459 ACPI_ERROR((AE_INFO, "Unknown Reference Count action (0x%X)",
460 action));
461 return;
462 }
463
464 /*
465 * Sanity check the reference count, for debug purposes only.
466 * (A deleted object will have a huge reference count)
467 */
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));
472 }
473}
474
475/*******************************************************************************
476 *
477 * FUNCTION: acpi_ut_update_object_reference
478 *
479 * PARAMETERS: object - Increment ref count for this object
480 * and all sub-objects
481 * action - Either REF_INCREMENT or REF_DECREMENT
482 *
483 * RETURN: Status
484 *
485 * DESCRIPTION: Increment the object reference count
486 *
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)
490 *
491 * Object references are decremented when:
492 * 1) An object is detached from an Node
493 *
494 ******************************************************************************/
495
496acpi_status
497acpi_ut_update_object_reference(union acpi_operand_object *object, u16 action)
498{
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;
504 u32 i;
505
506 ACPI_FUNCTION_NAME(ut_update_object_reference);
507
508 while (object) {
509
510 /* Make sure that this isn't a namespace handle */
511
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));
515 return (AE_OK);
516 }
517
518 /*
519 * All sub-objects must have their reference count incremented
520 * also. Different object types have different subobjects.
521 */
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:
527 /*
528 * Update the notify objects for these types (if present)
529 * Two lists, system and device notify handlers.
530 */
531 for (i = 0; i < ACPI_NUM_NOTIFY_TYPES; i++) {
532 prev_object =
533 object->common_notify.notify_list[i];
534 while (prev_object) {
535 next_object =
536 prev_object->notify.next[i];
537 acpi_ut_update_ref_count(prev_object,
538 action);
539 prev_object = next_object;
540 }
541 }
542 break;
543
544 case ACPI_TYPE_PACKAGE:
545 /*
546 * We must update all the sub-objects of the package,
547 * each of whom may have their own sub-objects.
548 */
549 for (i = 0; i < object->package.count; i++) {
550 /*
551 * Null package elements are legal and can be simply
552 * ignored.
553 */
554 next_object = object->package.elements[i];
555 if (!next_object) {
556 continue;
557 }
558
559 switch (next_object->common.type) {
560 case ACPI_TYPE_INTEGER:
561 case ACPI_TYPE_STRING:
562 case ACPI_TYPE_BUFFER:
563 /*
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.
567 */
568 acpi_ut_update_ref_count(next_object,
569 action);
570 break;
571
572 default:
573 /*
574 * For complex sub-objects, push them onto the stack
575 * for later processing (this eliminates recursion.)
576 */
577 status =
578 acpi_ut_create_update_state_and_push
579 (next_object, action, &state_list);
580 if (ACPI_FAILURE(status)) {
581 goto error_exit;
582 }
583 break;
584 }
585 }
586 next_object = NULL;
587 break;
588
589 case ACPI_TYPE_BUFFER_FIELD:
590
591 next_object = object->buffer_field.buffer_obj;
592 break;
593
594 case ACPI_TYPE_LOCAL_REGION_FIELD:
595
596 next_object = object->field.region_obj;
597 break;
598
599 case ACPI_TYPE_LOCAL_BANK_FIELD:
600
601 next_object = object->bank_field.bank_obj;
602 status =
603 acpi_ut_create_update_state_and_push(object->
604 bank_field.
605 region_obj,
606 action,
607 &state_list);
608 if (ACPI_FAILURE(status)) {
609 goto error_exit;
610 }
611 break;
612
613 case ACPI_TYPE_LOCAL_INDEX_FIELD:
614
615 next_object = object->index_field.index_obj;
616 status =
617 acpi_ut_create_update_state_and_push(object->
618 index_field.
619 data_obj,
620 action,
621 &state_list);
622 if (ACPI_FAILURE(status)) {
623 goto error_exit;
624 }
625 break;
626
627 case ACPI_TYPE_LOCAL_REFERENCE:
628 /*
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
631 * target object.
632 */
633 if ((object->reference.class == ACPI_REFCLASS_INDEX) ||
634 (object->reference.class == ACPI_REFCLASS_NAME)) {
635 next_object = object->reference.object;
636 }
637 break;
638
639 case ACPI_TYPE_REGION:
640 default:
641
642 break; /* No subobjects for all other types */
643 }
644
645 /*
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.
649 */
650 acpi_ut_update_ref_count(object, action);
651 object = NULL;
652
653 /* Move on to the next object to be updated */
654
655 if (next_object) {
656 object = next_object;
657 next_object = NULL;
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);
662 }
663 }
664
665 return (AE_OK);
666
667error_exit:
668
669 ACPI_EXCEPTION((AE_INFO, status,
670 "Could not update object reference count"));
671
672 /* Free any stacked Update State objects */
673
674 while (state_list) {
675 state = acpi_ut_pop_generic_state(&state_list);
676 acpi_ut_delete_generic_state(state);
677 }
678
679 return (status);
680}
681
682/*******************************************************************************
683 *
684 * FUNCTION: acpi_ut_add_reference
685 *
686 * PARAMETERS: object - Object whose reference count is to be
687 * incremented
688 *
689 * RETURN: None
690 *
691 * DESCRIPTION: Add one reference to an ACPI object
692 *
693 ******************************************************************************/
694
695void acpi_ut_add_reference(union acpi_operand_object *object)
696{
697
698 ACPI_FUNCTION_NAME(ut_add_reference);
699
700 /* Ensure that we have a valid object */
701
702 if (!acpi_ut_valid_internal_object(object)) {
703 return;
704 }
705
706 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
707 "Obj %p Current Refs=%X [To Be Incremented]\n",
708 object, object->common.reference_count));
709
710 /* Increment the reference count */
711
712 (void)acpi_ut_update_object_reference(object, REF_INCREMENT);
713 return;
714}
715
716/*******************************************************************************
717 *
718 * FUNCTION: acpi_ut_remove_reference
719 *
720 * PARAMETERS: object - Object whose ref count will be decremented
721 *
722 * RETURN: None
723 *
724 * DESCRIPTION: Decrement the reference count of an ACPI internal object
725 *
726 ******************************************************************************/
727
728void acpi_ut_remove_reference(union acpi_operand_object *object)
729{
730
731 ACPI_FUNCTION_NAME(ut_remove_reference);
732
733 /*
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.
736 */
737 if (!object ||
738 (ACPI_GET_DESCRIPTOR_TYPE(object) == ACPI_DESC_TYPE_NAMED)) {
739 return;
740 }
741
742 /* Ensure that we have a valid object */
743
744 if (!acpi_ut_valid_internal_object(object)) {
745 return;
746 }
747
748 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
749 "Obj %p Current Refs=%X [To Be Decremented]\n",
750 object, object->common.reference_count));
751
752 /*
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!)
756 */
757 (void)acpi_ut_update_object_reference(object, REF_DECREMENT);
758 return;
759}