PM / sleep: Asynchronous threads for suspend_noirq
[linux/fpc-iii.git] / drivers / acpi / acpica / utdelete.c
blobc07d2227ea42587937ecf7bf37d88e91a6f65a66
1 /*******************************************************************************
3 * Module Name: utdelete - object deletion and reference count utilities
5 ******************************************************************************/
7 /*
8 * Copyright (C) 2000 - 2013, Intel Corp.
9 * All rights reserved.
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.
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.
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.
44 #include <acpi/acpi.h>
45 #include "accommon.h"
46 #include "acinterp.h"
47 #include "acnamesp.h"
48 #include "acevents.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);
56 static void
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
65 * RETURN: None
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 **last_obj_ptr;
80 ACPI_FUNCTION_TRACE_PTR(ut_delete_internal_obj, object);
82 if (!object) {
83 return_VOID;
87 * Must delete or free any pointers within the object that are not
88 * actual ACPI objects (for example, a raw buffer pointer).
90 switch (object->common.type) {
91 case ACPI_TYPE_STRING:
93 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
94 "**** String %p, ptr %p\n", object,
95 object->string.pointer));
97 /* Free the actual string buffer */
99 if (!(object->common.flags & AOPOBJ_STATIC_POINTER)) {
101 /* But only if it is NOT a pointer into an ACPI table */
103 obj_pointer = object->string.pointer;
105 break;
107 case ACPI_TYPE_BUFFER:
109 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
110 "**** Buffer %p, ptr %p\n", object,
111 object->buffer.pointer));
113 /* Free the actual buffer */
115 if (!(object->common.flags & AOPOBJ_STATIC_POINTER)) {
117 /* But only if it is NOT a pointer into an ACPI table */
119 obj_pointer = object->buffer.pointer;
121 break;
123 case ACPI_TYPE_PACKAGE:
125 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
126 " **** Package of count %X\n",
127 object->package.count));
130 * Elements of the package are not handled here, they are deleted
131 * separately
134 /* Free the (variable length) element pointer array */
136 obj_pointer = object->package.elements;
137 break;
140 * These objects have a possible list of notify handlers.
141 * Device object also may have a GPE block.
143 case ACPI_TYPE_DEVICE:
145 if (object->device.gpe_block) {
146 (void)acpi_ev_delete_gpe_block(object->device.
147 gpe_block);
150 /*lint -fallthrough */
152 case ACPI_TYPE_PROCESSOR:
153 case ACPI_TYPE_THERMAL:
155 /* Walk the address handler list for this object */
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;
163 break;
165 case ACPI_TYPE_MUTEX:
167 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
168 "***** Mutex %p, OS Mutex %p\n",
169 object, object->mutex.os_mutex));
171 if (object == acpi_gbl_global_lock_mutex) {
173 /* Global Lock has extra semaphore */
175 (void)
176 acpi_os_delete_semaphore
177 (acpi_gbl_global_lock_semaphore);
178 acpi_gbl_global_lock_semaphore = NULL;
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);
186 break;
188 case ACPI_TYPE_EVENT:
190 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
191 "***** Event %p, OS Semaphore %p\n",
192 object, object->event.os_semaphore));
194 (void)acpi_os_delete_semaphore(object->event.os_semaphore);
195 object->event.os_semaphore = NULL;
196 break;
198 case ACPI_TYPE_METHOD:
200 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
201 "***** Method %p\n", object));
203 /* Delete the method mutex if it exists */
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;
211 break;
213 case ACPI_TYPE_REGION:
215 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
216 "***** Region %p\n", object));
219 * Update address_range list. However, only permanent regions
220 * are installed in this list. (Not created within a method)
222 if (!(object->region.node->flags & ANOBJ_TEMPORARY)) {
223 acpi_ut_remove_address_range(object->region.space_id,
224 object->region.node);
227 second_desc = acpi_ns_get_secondary_object(object);
228 if (second_desc) {
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.
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;
241 /* Remove the region object from the handler's list */
243 while (next_desc) {
244 if (next_desc == object) {
245 *last_obj_ptr =
246 next_desc->region.next;
247 break;
250 /* Walk the linked list of handler */
252 last_obj_ptr = &next_desc->region.next;
253 next_desc = next_desc->region.next;
256 if (handler_desc->address_space.handler_flags &
257 ACPI_ADDR_HANDLER_DEFAULT_INSTALLED) {
259 /* Deactivate region and free region context */
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);
274 acpi_ut_remove_reference(handler_desc);
277 /* Now we can free the Extra object */
279 acpi_ut_delete_object_desc(second_desc);
281 break;
283 case ACPI_TYPE_BUFFER_FIELD:
285 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
286 "***** Buffer Field %p\n", object));
288 second_desc = acpi_ns_get_secondary_object(object);
289 if (second_desc) {
290 acpi_ut_delete_object_desc(second_desc);
292 break;
294 case ACPI_TYPE_LOCAL_BANK_FIELD:
296 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
297 "***** Bank Field %p\n", object));
299 second_desc = acpi_ns_get_secondary_object(object);
300 if (second_desc) {
301 acpi_ut_delete_object_desc(second_desc);
303 break;
305 default:
307 break;
310 /* Free any allocated memory (pointer within the object) found above */
312 if (obj_pointer) {
313 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
314 "Deleting Object Subptr %p\n", obj_pointer));
315 ACPI_FREE(obj_pointer);
318 /* Now the object can be safely deleted */
320 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS, "Deleting Object %p [%s]\n",
321 object, acpi_ut_get_object_type_name(object)));
323 acpi_ut_delete_object_desc(object);
324 return_VOID;
327 /*******************************************************************************
329 * FUNCTION: acpi_ut_delete_internal_object_list
331 * PARAMETERS: obj_list - Pointer to the list to be deleted
333 * RETURN: None
335 * DESCRIPTION: This function deletes an internal object list, including both
336 * simple objects and package objects
338 ******************************************************************************/
340 void acpi_ut_delete_internal_object_list(union acpi_operand_object **obj_list)
342 union acpi_operand_object **internal_obj;
344 ACPI_FUNCTION_ENTRY();
346 /* Walk the null-terminated internal list */
348 for (internal_obj = obj_list; *internal_obj; internal_obj++) {
349 acpi_ut_remove_reference(*internal_obj);
352 /* Free the combined parameter pointer list and object array */
354 ACPI_FREE(obj_list);
355 return;
358 /*******************************************************************************
360 * FUNCTION: acpi_ut_update_ref_count
362 * PARAMETERS: object - Object whose ref count is to be updated
363 * action - What to do (REF_INCREMENT or REF_DECREMENT)
365 * RETURN: None. Sets new reference count within the object
367 * DESCRIPTION: Modify the reference count for an internal acpi object
369 ******************************************************************************/
371 static void
372 acpi_ut_update_ref_count(union acpi_operand_object *object, u32 action)
374 u16 original_count;
375 u16 new_count = 0;
376 acpi_cpu_flags lock_flags;
378 ACPI_FUNCTION_NAME(ut_update_ref_count);
380 if (!object) {
381 return;
385 * Always get the reference count lock. Note: Interpreter and/or
386 * Namespace is not always locked when this function is called.
388 lock_flags = acpi_os_acquire_lock(acpi_gbl_reference_count_lock);
389 original_count = object->common.reference_count;
391 /* Perform the reference count action (increment, decrement) */
393 switch (action) {
394 case REF_INCREMENT:
396 new_count = original_count + 1;
397 object->common.reference_count = new_count;
398 acpi_os_release_lock(acpi_gbl_reference_count_lock, lock_flags);
400 /* The current reference count should never be zero here */
402 if (!original_count) {
403 ACPI_WARNING((AE_INFO,
404 "Obj %p, Reference Count was zero before increment\n",
405 object));
408 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
409 "Obj %p Type %.2X Refs %.2X [Incremented]\n",
410 object, object->common.type, new_count));
411 break;
413 case REF_DECREMENT:
415 /* The current reference count must be non-zero */
417 if (original_count) {
418 new_count = original_count - 1;
419 object->common.reference_count = new_count;
422 acpi_os_release_lock(acpi_gbl_reference_count_lock, lock_flags);
424 if (!original_count) {
425 ACPI_WARNING((AE_INFO,
426 "Obj %p, Reference Count is already zero, cannot decrement\n",
427 object));
430 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
431 "Obj %p Type %.2X Refs %.2X [Decremented]\n",
432 object, object->common.type, new_count));
434 /* Actually delete the object on a reference count of zero */
436 if (new_count == 0) {
437 acpi_ut_delete_internal_obj(object);
439 break;
441 default:
443 acpi_os_release_lock(acpi_gbl_reference_count_lock, lock_flags);
444 ACPI_ERROR((AE_INFO, "Unknown Reference Count action (0x%X)",
445 action));
446 return;
450 * Sanity check the reference count, for debug purposes only.
451 * (A deleted object will have a huge reference count)
453 if (new_count > ACPI_MAX_REFERENCE_COUNT) {
454 ACPI_WARNING((AE_INFO,
455 "Large Reference Count (0x%X) in object %p, Type=0x%.2X",
456 new_count, object, object->common.type));
460 /*******************************************************************************
462 * FUNCTION: acpi_ut_update_object_reference
464 * PARAMETERS: object - Increment ref count for this object
465 * and all sub-objects
466 * action - Either REF_INCREMENT or REF_DECREMENT
468 * RETURN: Status
470 * DESCRIPTION: Increment the object reference count
472 * Object references are incremented when:
473 * 1) An object is attached to a Node (namespace object)
474 * 2) An object is copied (all subobjects must be incremented)
476 * Object references are decremented when:
477 * 1) An object is detached from an Node
479 ******************************************************************************/
481 acpi_status
482 acpi_ut_update_object_reference(union acpi_operand_object *object, u16 action)
484 acpi_status status = AE_OK;
485 union acpi_generic_state *state_list = NULL;
486 union acpi_operand_object *next_object = NULL;
487 union acpi_operand_object *prev_object;
488 union acpi_generic_state *state;
489 u32 i;
491 ACPI_FUNCTION_NAME(ut_update_object_reference);
493 while (object) {
495 /* Make sure that this isn't a namespace handle */
497 if (ACPI_GET_DESCRIPTOR_TYPE(object) == ACPI_DESC_TYPE_NAMED) {
498 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
499 "Object %p is NS handle\n", object));
500 return (AE_OK);
504 * All sub-objects must have their reference count incremented also.
505 * Different object types have different subobjects.
507 switch (object->common.type) {
508 case ACPI_TYPE_DEVICE:
509 case ACPI_TYPE_PROCESSOR:
510 case ACPI_TYPE_POWER:
511 case ACPI_TYPE_THERMAL:
513 * Update the notify objects for these types (if present)
514 * Two lists, system and device notify handlers.
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;
527 break;
529 case ACPI_TYPE_PACKAGE:
531 * We must update all the sub-objects of the package,
532 * each of whom may have their own sub-objects.
534 for (i = 0; i < object->package.count; i++) {
536 * Null package elements are legal and can be simply
537 * ignored.
539 next_object = object->package.elements[i];
540 if (!next_object) {
541 continue;
544 switch (next_object->common.type) {
545 case ACPI_TYPE_INTEGER:
546 case ACPI_TYPE_STRING:
547 case ACPI_TYPE_BUFFER:
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.
553 acpi_ut_update_ref_count(next_object,
554 action);
555 break;
557 default:
559 * For complex sub-objects, push them onto the stack
560 * for later processing (this eliminates recursion.)
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;
568 break;
571 next_object = NULL;
572 break;
574 case ACPI_TYPE_BUFFER_FIELD:
576 next_object = object->buffer_field.buffer_obj;
577 break;
579 case ACPI_TYPE_LOCAL_REGION_FIELD:
581 next_object = object->field.region_obj;
582 break;
584 case ACPI_TYPE_LOCAL_BANK_FIELD:
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;
596 break;
598 case ACPI_TYPE_LOCAL_INDEX_FIELD:
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;
610 break;
612 case ACPI_TYPE_LOCAL_REFERENCE:
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.
618 if ((object->reference.class == ACPI_REFCLASS_INDEX) ||
619 (object->reference.class == ACPI_REFCLASS_NAME)) {
620 next_object = object->reference.object;
622 break;
624 case ACPI_TYPE_REGION:
625 default:
627 break; /* No subobjects for all other types */
631 * Now we can update the count in the main object. This can only
632 * happen after we update the sub-objects in case this causes the
633 * main object to be deleted.
635 acpi_ut_update_ref_count(object, action);
636 object = NULL;
638 /* Move on to the next object to be updated */
640 if (next_object) {
641 object = next_object;
642 next_object = NULL;
643 } else if (state_list) {
644 state = acpi_ut_pop_generic_state(&state_list);
645 object = state->update.object;
646 acpi_ut_delete_generic_state(state);
650 return (AE_OK);
652 error_exit:
654 ACPI_EXCEPTION((AE_INFO, status,
655 "Could not update object reference count"));
657 /* Free any stacked Update State objects */
659 while (state_list) {
660 state = acpi_ut_pop_generic_state(&state_list);
661 acpi_ut_delete_generic_state(state);
664 return (status);
667 /*******************************************************************************
669 * FUNCTION: acpi_ut_add_reference
671 * PARAMETERS: object - Object whose reference count is to be
672 * incremented
674 * RETURN: None
676 * DESCRIPTION: Add one reference to an ACPI object
678 ******************************************************************************/
680 void acpi_ut_add_reference(union acpi_operand_object *object)
683 ACPI_FUNCTION_NAME(ut_add_reference);
685 /* Ensure that we have a valid object */
687 if (!acpi_ut_valid_internal_object(object)) {
688 return;
691 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
692 "Obj %p Current Refs=%X [To Be Incremented]\n",
693 object, object->common.reference_count));
695 /* Increment the reference count */
697 (void)acpi_ut_update_object_reference(object, REF_INCREMENT);
698 return;
701 /*******************************************************************************
703 * FUNCTION: acpi_ut_remove_reference
705 * PARAMETERS: object - Object whose ref count will be decremented
707 * RETURN: None
709 * DESCRIPTION: Decrement the reference count of an ACPI internal object
711 ******************************************************************************/
713 void acpi_ut_remove_reference(union acpi_operand_object *object)
716 ACPI_FUNCTION_NAME(ut_remove_reference);
719 * Allow a NULL pointer to be passed in, just ignore it. This saves
720 * each caller from having to check. Also, ignore NS nodes.
722 if (!object ||
723 (ACPI_GET_DESCRIPTOR_TYPE(object) == ACPI_DESC_TYPE_NAMED)) {
724 return;
727 /* Ensure that we have a valid object */
729 if (!acpi_ut_valid_internal_object(object)) {
730 return;
733 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
734 "Obj %p Current Refs=%X [To Be Decremented]\n",
735 object, object->common.reference_count));
738 * Decrement the reference count, and only actually delete the object
739 * if the reference count becomes 0. (Must also decrement the ref count
740 * of all subobjects!)
742 (void)acpi_ut_update_object_reference(object, REF_DECREMENT);
743 return;