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