blob: 5b4e3b1a7523c939edbdc869f4644bc536e434c9 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*******************************************************************************
2 *
3 * Module Name: utdelete - object deletion and reference count utilities
4 *
5 ******************************************************************************/
6
7/*
Len Brown75a44ce2008-04-23 23:00:13 -04008 * Copyright (C) 2000 - 2008, Intel Corp.
Linus Torvalds1da177e2005-04-16 15:20:36 -07009 * 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
Linus Torvalds1da177e2005-04-16 15:20:36 -070044#include <acpi/acpi.h>
Bob Moore50df4d82008-12-31 03:01:23 +080045#include <acpi/accommon.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070046#include <acpi/acinterp.h>
47#include <acpi/acnamesp.h>
48#include <acpi/acevents.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070049
50#define _COMPONENT ACPI_UTILITIES
Len Brown4be44fc2005-08-05 00:44:28 -040051ACPI_MODULE_NAME("utdelete")
Linus Torvalds1da177e2005-04-16 15:20:36 -070052
Robert Moore44f6c012005-04-18 22:49:35 -040053/* Local prototypes */
Len Brown4be44fc2005-08-05 00:44:28 -040054static void acpi_ut_delete_internal_obj(union acpi_operand_object *object);
Robert Moore44f6c012005-04-18 22:49:35 -040055
56static void
Len Brown4be44fc2005-08-05 00:44:28 -040057acpi_ut_update_ref_count(union acpi_operand_object *object, u32 action);
Linus Torvalds1da177e2005-04-16 15:20:36 -070058
59/*******************************************************************************
60 *
61 * FUNCTION: acpi_ut_delete_internal_obj
62 *
Robert Moore44f6c012005-04-18 22:49:35 -040063 * PARAMETERS: Object - Object to be deleted
Linus Torvalds1da177e2005-04-16 15:20:36 -070064 *
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
Len Brown4be44fc2005-08-05 00:44:28 -040072static void acpi_ut_delete_internal_obj(union acpi_operand_object *object)
Linus Torvalds1da177e2005-04-16 15:20:36 -070073{
Len Brown4be44fc2005-08-05 00:44:28 -040074 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;
Linus Torvalds1da177e2005-04-16 15:20:36 -070078
Bob Mooreb229cf92006-04-21 17:15:00 -040079 ACPI_FUNCTION_TRACE_PTR(ut_delete_internal_obj, object);
Linus Torvalds1da177e2005-04-16 15:20:36 -070080
81 if (!object) {
82 return_VOID;
83 }
84
85 /*
86 * Must delete or free any pointers within the object that are not
87 * actual ACPI objects (for example, a raw buffer pointer).
88 */
Len Brown4be44fc2005-08-05 00:44:28 -040089 switch (ACPI_GET_OBJECT_TYPE(object)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -070090 case ACPI_TYPE_STRING:
91
Len Brown4be44fc2005-08-05 00:44:28 -040092 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
93 "**** String %p, ptr %p\n", object,
94 object->string.pointer));
Linus Torvalds1da177e2005-04-16 15:20:36 -070095
96 /* Free the actual string buffer */
97
98 if (!(object->common.flags & AOPOBJ_STATIC_POINTER)) {
Bob Moore52fc0b02006-10-02 00:00:00 -040099
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100 /* But only if it is NOT a pointer into an ACPI table */
101
102 obj_pointer = object->string.pointer;
103 }
104 break;
105
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106 case ACPI_TYPE_BUFFER:
107
Len Brown4be44fc2005-08-05 00:44:28 -0400108 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
109 "**** Buffer %p, ptr %p\n", object,
110 object->buffer.pointer));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111
112 /* Free the actual buffer */
113
114 if (!(object->common.flags & AOPOBJ_STATIC_POINTER)) {
Bob Moore52fc0b02006-10-02 00:00:00 -0400115
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116 /* But only if it is NOT a pointer into an ACPI table */
117
118 obj_pointer = object->buffer.pointer;
119 }
120 break;
121
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122 case ACPI_TYPE_PACKAGE:
123
Len Brown4be44fc2005-08-05 00:44:28 -0400124 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
125 " **** Package of count %X\n",
126 object->package.count));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127
128 /*
129 * Elements of the package are not handled here, they are deleted
130 * separately
131 */
132
133 /* Free the (variable length) element pointer array */
134
135 obj_pointer = object->package.elements;
136 break;
137
Bob Moore2843ae72008-07-04 10:41:41 +0800138 /*
139 * These objects have a possible list of notify handlers.
140 * Device object also may have a GPE block.
141 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142 case ACPI_TYPE_DEVICE:
143
144 if (object->device.gpe_block) {
Len Brown4be44fc2005-08-05 00:44:28 -0400145 (void)acpi_ev_delete_gpe_block(object->device.
146 gpe_block);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147 }
148
Bob Moore2843ae72008-07-04 10:41:41 +0800149 /*lint -fallthrough */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150
Bob Moore2843ae72008-07-04 10:41:41 +0800151 case ACPI_TYPE_PROCESSOR:
152 case ACPI_TYPE_THERMAL:
153
154 /* Walk the notify handler list for this object */
155
156 handler_desc = object->common_notify.handler;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157 while (handler_desc) {
158 next_desc = handler_desc->address_space.next;
Len Brown4be44fc2005-08-05 00:44:28 -0400159 acpi_ut_remove_reference(handler_desc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160 handler_desc = next_desc;
161 }
162 break;
163
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164 case ACPI_TYPE_MUTEX:
165
Len Brown4be44fc2005-08-05 00:44:28 -0400166 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
Bob Moore967440e2006-06-23 17:04:00 -0400167 "***** Mutex %p, OS Mutex %p\n",
168 object, object->mutex.os_mutex));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169
Bob Mooreba886cd2008-04-10 19:06:37 +0400170 if (object == acpi_gbl_global_lock_mutex) {
Bob Moorec81da662007-02-02 19:48:18 +0300171
172 /* Global Lock has extra semaphore */
Bob Moore967440e2006-06-23 17:04:00 -0400173
174 (void)
175 acpi_os_delete_semaphore
176 (acpi_gbl_global_lock_semaphore);
177 acpi_gbl_global_lock_semaphore = NULL;
Bob Moorec81da662007-02-02 19:48:18 +0300178
179 acpi_os_delete_mutex(object->mutex.os_mutex);
180 acpi_gbl_global_lock_mutex = NULL;
181 } else {
Len Brown262a7a22007-05-09 23:01:59 -0400182 acpi_ex_unlink_mutex(object);
Bob Moorec81da662007-02-02 19:48:18 +0300183 acpi_os_delete_mutex(object->mutex.os_mutex);
Bob Moore967440e2006-06-23 17:04:00 -0400184 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185 break;
186
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187 case ACPI_TYPE_EVENT:
188
Len Brown4be44fc2005-08-05 00:44:28 -0400189 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
Bob Moore967440e2006-06-23 17:04:00 -0400190 "***** Event %p, OS Semaphore %p\n",
191 object, object->event.os_semaphore));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192
Bob Moore967440e2006-06-23 17:04:00 -0400193 (void)acpi_os_delete_semaphore(object->event.os_semaphore);
194 object->event.os_semaphore = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195 break;
196
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197 case ACPI_TYPE_METHOD:
198
Len Brown4be44fc2005-08-05 00:44:28 -0400199 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
200 "***** Method %p\n", object));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201
Bob Moore967440e2006-06-23 17:04:00 -0400202 /* Delete the method mutex if it exists */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203
Bob Moore967440e2006-06-23 17:04:00 -0400204 if (object->method.mutex) {
205 acpi_os_delete_mutex(object->method.mutex->mutex.
206 os_mutex);
207 acpi_ut_delete_object_desc(object->method.mutex);
208 object->method.mutex = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209 }
210 break;
211
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212 case ACPI_TYPE_REGION:
213
Len Brown4be44fc2005-08-05 00:44:28 -0400214 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
215 "***** Region %p\n", object));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216
Len Brown4be44fc2005-08-05 00:44:28 -0400217 second_desc = acpi_ns_get_secondary_object(object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218 if (second_desc) {
219 /*
220 * Free the region_context if and only if the handler is one of the
221 * default handlers -- and therefore, we created the context object
222 * locally, it was not created by an external caller.
223 */
224 handler_desc = object->region.handler;
225 if (handler_desc) {
Bob Moore616861242006-03-17 16:44:00 -0500226 if (handler_desc->address_space.handler_flags &
Len Brown4be44fc2005-08-05 00:44:28 -0400227 ACPI_ADDR_HANDLER_DEFAULT_INSTALLED) {
Bob Moore793c2382006-03-31 00:00:00 -0500228
229 /* Deactivate region and free region context */
230
231 if (handler_desc->address_space.setup) {
232 (void)handler_desc->
233 address_space.setup(object,
234 ACPI_REGION_DEACTIVATE,
235 handler_desc->
236 address_space.
237 context,
238 &second_desc->
239 extra.
240 region_context);
241 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242 }
243
Len Brown4be44fc2005-08-05 00:44:28 -0400244 acpi_ut_remove_reference(handler_desc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245 }
246
247 /* Now we can free the Extra object */
248
Len Brown4be44fc2005-08-05 00:44:28 -0400249 acpi_ut_delete_object_desc(second_desc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250 }
251 break;
252
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253 case ACPI_TYPE_BUFFER_FIELD:
254
Len Brown4be44fc2005-08-05 00:44:28 -0400255 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
256 "***** Buffer Field %p\n", object));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257
Len Brown4be44fc2005-08-05 00:44:28 -0400258 second_desc = acpi_ns_get_secondary_object(object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259 if (second_desc) {
Len Brown4be44fc2005-08-05 00:44:28 -0400260 acpi_ut_delete_object_desc(second_desc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261 }
262 break;
263
Lin Mingef805d92008-04-10 19:06:41 +0400264 case ACPI_TYPE_LOCAL_BANK_FIELD:
265
266 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
267 "***** Bank Field %p\n", object));
268
269 second_desc = acpi_ns_get_secondary_object(object);
270 if (second_desc) {
271 acpi_ut_delete_object_desc(second_desc);
272 }
273 break;
274
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275 default:
276 break;
277 }
278
279 /* Free any allocated memory (pointer within the object) found above */
280
281 if (obj_pointer) {
Len Brown4be44fc2005-08-05 00:44:28 -0400282 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
283 "Deleting Object Subptr %p\n", obj_pointer));
Bob Moore83135242006-10-03 00:00:00 -0400284 ACPI_FREE(obj_pointer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285 }
286
287 /* Now the object can be safely deleted */
288
Len Brown4be44fc2005-08-05 00:44:28 -0400289 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS, "Deleting Object %p [%s]\n",
290 object, acpi_ut_get_object_type_name(object)));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291
Len Brown4be44fc2005-08-05 00:44:28 -0400292 acpi_ut_delete_object_desc(object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293 return_VOID;
294}
295
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296/*******************************************************************************
297 *
298 * FUNCTION: acpi_ut_delete_internal_object_list
299 *
Robert Moore44f6c012005-04-18 22:49:35 -0400300 * PARAMETERS: obj_list - Pointer to the list to be deleted
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301 *
302 * RETURN: None
303 *
304 * DESCRIPTION: This function deletes an internal object list, including both
305 * simple objects and package objects
306 *
307 ******************************************************************************/
308
Len Brown4be44fc2005-08-05 00:44:28 -0400309void acpi_ut_delete_internal_object_list(union acpi_operand_object **obj_list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310{
Len Brown4be44fc2005-08-05 00:44:28 -0400311 union acpi_operand_object **internal_obj;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312
Bob Mooreb229cf92006-04-21 17:15:00 -0400313 ACPI_FUNCTION_TRACE(ut_delete_internal_object_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314
315 /* Walk the null-terminated internal list */
316
317 for (internal_obj = obj_list; *internal_obj; internal_obj++) {
Len Brown4be44fc2005-08-05 00:44:28 -0400318 acpi_ut_remove_reference(*internal_obj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319 }
320
321 /* Free the combined parameter pointer list and object array */
322
Bob Moore83135242006-10-03 00:00:00 -0400323 ACPI_FREE(obj_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324 return_VOID;
325}
326
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327/*******************************************************************************
328 *
329 * FUNCTION: acpi_ut_update_ref_count
330 *
Robert Moore44f6c012005-04-18 22:49:35 -0400331 * PARAMETERS: Object - Object whose ref count is to be updated
Linus Torvalds1da177e2005-04-16 15:20:36 -0700332 * Action - What to do
333 *
334 * RETURN: New ref count
335 *
336 * DESCRIPTION: Modify the ref count and return it.
337 *
338 ******************************************************************************/
339
340static void
Len Brown4be44fc2005-08-05 00:44:28 -0400341acpi_ut_update_ref_count(union acpi_operand_object *object, u32 action)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342{
Len Brown4be44fc2005-08-05 00:44:28 -0400343 u16 count;
344 u16 new_count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345
Bob Mooreb229cf92006-04-21 17:15:00 -0400346 ACPI_FUNCTION_NAME(ut_update_ref_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347
348 if (!object) {
349 return;
350 }
351
352 count = object->common.reference_count;
353 new_count = count;
354
355 /*
Bob Moore41195322006-05-26 16:36:00 -0400356 * Perform the reference count action (increment, decrement, force delete)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357 */
358 switch (action) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359 case REF_INCREMENT:
360
361 new_count++;
362 object->common.reference_count = new_count;
363
Len Brown4be44fc2005-08-05 00:44:28 -0400364 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
365 "Obj %p Refs=%X, [Incremented]\n",
366 object, new_count));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367 break;
368
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369 case REF_DECREMENT:
370
371 if (count < 1) {
Len Brown4be44fc2005-08-05 00:44:28 -0400372 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
373 "Obj %p Refs=%X, can't decrement! (Set to 0)\n",
374 object, new_count));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375
376 new_count = 0;
Len Brown4be44fc2005-08-05 00:44:28 -0400377 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378 new_count--;
379
Len Brown4be44fc2005-08-05 00:44:28 -0400380 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
381 "Obj %p Refs=%X, [Decremented]\n",
382 object, new_count));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383 }
384
Len Brown4be44fc2005-08-05 00:44:28 -0400385 if (ACPI_GET_OBJECT_TYPE(object) == ACPI_TYPE_METHOD) {
386 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
387 "Method Obj %p Refs=%X, [Decremented]\n",
388 object, new_count));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389 }
390
391 object->common.reference_count = new_count;
392 if (new_count == 0) {
Len Brown4be44fc2005-08-05 00:44:28 -0400393 acpi_ut_delete_internal_obj(object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395 break;
396
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397 case REF_FORCE_DELETE:
398
Len Brown4be44fc2005-08-05 00:44:28 -0400399 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
400 "Obj %p Refs=%X, Force delete! (Set to 0)\n",
401 object, count));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402
403 new_count = 0;
404 object->common.reference_count = new_count;
Len Brown4be44fc2005-08-05 00:44:28 -0400405 acpi_ut_delete_internal_obj(object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406 break;
407
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408 default:
409
Bob Mooreb8e4d892006-01-27 16:43:00 -0500410 ACPI_ERROR((AE_INFO, "Unknown action (%X)", action));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411 break;
412 }
413
414 /*
415 * Sanity check the reference count, for debug purposes only.
416 * (A deleted object will have a huge reference count)
417 */
418 if (count > ACPI_MAX_REFERENCE_COUNT) {
Bob Mooreb8e4d892006-01-27 16:43:00 -0500419 ACPI_WARNING((AE_INFO,
Bob Moore41195322006-05-26 16:36:00 -0400420 "Large Reference Count (%X) in object %p", count,
421 object));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423}
424
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425/*******************************************************************************
426 *
427 * FUNCTION: acpi_ut_update_object_reference
428 *
Robert Moore44f6c012005-04-18 22:49:35 -0400429 * PARAMETERS: Object - Increment ref count for this object
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430 * and all sub-objects
431 * Action - Either REF_INCREMENT or REF_DECREMENT or
432 * REF_FORCE_DELETE
433 *
434 * RETURN: Status
435 *
436 * DESCRIPTION: Increment the object reference count
437 *
438 * Object references are incremented when:
439 * 1) An object is attached to a Node (namespace object)
440 * 2) An object is copied (all subobjects must be incremented)
441 *
442 * Object references are decremented when:
443 * 1) An object is detached from an Node
444 *
445 ******************************************************************************/
446
447acpi_status
Bob Moore41195322006-05-26 16:36:00 -0400448acpi_ut_update_object_reference(union acpi_operand_object *object, u16 action)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449{
Len Brown4be44fc2005-08-05 00:44:28 -0400450 acpi_status status = AE_OK;
451 union acpi_generic_state *state_list = NULL;
452 union acpi_operand_object *next_object = NULL;
453 union acpi_generic_state *state;
Bob Moore67a119f2008-06-10 13:42:13 +0800454 u32 i;
David Shaohua Li4c3ffbd2005-07-14 00:00:00 -0400455
Bob Mooreb229cf92006-04-21 17:15:00 -0400456 ACPI_FUNCTION_TRACE_PTR(ut_update_object_reference, object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457
Robert Mooref9f46012005-07-08 00:00:00 -0400458 while (object) {
Bob Moore52fc0b02006-10-02 00:00:00 -0400459
Robert Mooref9f46012005-07-08 00:00:00 -0400460 /* Make sure that this isn't a namespace handle */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461
Len Brown4be44fc2005-08-05 00:44:28 -0400462 if (ACPI_GET_DESCRIPTOR_TYPE(object) == ACPI_DESC_TYPE_NAMED) {
463 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
464 "Object %p is NS handle\n", object));
465 return_ACPI_STATUS(AE_OK);
Robert Mooref9f46012005-07-08 00:00:00 -0400466 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467
468 /*
469 * All sub-objects must have their reference count incremented also.
470 * Different object types have different subobjects.
471 */
Len Brown4be44fc2005-08-05 00:44:28 -0400472 switch (ACPI_GET_OBJECT_TYPE(object)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473 case ACPI_TYPE_DEVICE:
Bob Mooref6dd9222006-07-07 20:44:38 -0400474 case ACPI_TYPE_PROCESSOR:
475 case ACPI_TYPE_POWER:
476 case ACPI_TYPE_THERMAL:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477
Bob Mooref6dd9222006-07-07 20:44:38 -0400478 /* Update the notify objects for these types (if present) */
479
480 acpi_ut_update_ref_count(object->common_notify.
481 system_notify, action);
482 acpi_ut_update_ref_count(object->common_notify.
483 device_notify, action);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484 break;
485
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486 case ACPI_TYPE_PACKAGE:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700487 /*
Robert Mooref9f46012005-07-08 00:00:00 -0400488 * We must update all the sub-objects of the package,
489 * each of whom may have their own sub-objects.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490 */
491 for (i = 0; i < object->package.count; i++) {
492 /*
493 * Push each element onto the stack for later processing.
494 * Note: There can be null elements within the package,
495 * these are simply ignored
496 */
Len Brown4be44fc2005-08-05 00:44:28 -0400497 status =
498 acpi_ut_create_update_state_and_push
499 (object->package.elements[i], action,
500 &state_list);
501 if (ACPI_FAILURE(status)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502 goto error_exit;
503 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504 }
505 break;
506
Linus Torvalds1da177e2005-04-16 15:20:36 -0700507 case ACPI_TYPE_BUFFER_FIELD:
508
Robert Mooref9f46012005-07-08 00:00:00 -0400509 next_object = object->buffer_field.buffer_obj;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510 break;
511
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512 case ACPI_TYPE_LOCAL_REGION_FIELD:
513
Robert Mooref9f46012005-07-08 00:00:00 -0400514 next_object = object->field.region_obj;
515 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516
517 case ACPI_TYPE_LOCAL_BANK_FIELD:
518
Robert Mooref9f46012005-07-08 00:00:00 -0400519 next_object = object->bank_field.bank_obj;
Len Brown4be44fc2005-08-05 00:44:28 -0400520 status =
521 acpi_ut_create_update_state_and_push(object->
522 bank_field.
523 region_obj,
524 action,
525 &state_list);
526 if (ACPI_FAILURE(status)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527 goto error_exit;
528 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529 break;
530
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531 case ACPI_TYPE_LOCAL_INDEX_FIELD:
532
Robert Mooref9f46012005-07-08 00:00:00 -0400533 next_object = object->index_field.index_obj;
Len Brown4be44fc2005-08-05 00:44:28 -0400534 status =
535 acpi_ut_create_update_state_and_push(object->
536 index_field.
537 data_obj,
538 action,
539 &state_list);
540 if (ACPI_FAILURE(status)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541 goto error_exit;
542 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543 break;
544
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545 case ACPI_TYPE_LOCAL_REFERENCE:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546 /*
Bob Moore9e41d932008-04-10 19:06:39 +0400547 * The target of an Index (a package, string, or buffer) or a named
548 * reference must track changes to the ref count of the index or
549 * target object.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550 */
Bob Moore1044f1f2008-09-27 11:08:41 +0800551 if ((object->reference.class == ACPI_REFCLASS_INDEX) ||
552 (object->reference.class == ACPI_REFCLASS_NAME)) {
Robert Mooref9f46012005-07-08 00:00:00 -0400553 next_object = object->reference.object;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554 }
555 break;
556
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557 case ACPI_TYPE_REGION:
558 default:
Bob Moore41195322006-05-26 16:36:00 -0400559 break; /* No subobjects for all other types */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700560 }
561
562 /*
Bob Moore41195322006-05-26 16:36:00 -0400563 * Now we can update the count in the main object. This can only
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564 * happen after we update the sub-objects in case this causes the
565 * main object to be deleted.
566 */
Len Brown4be44fc2005-08-05 00:44:28 -0400567 acpi_ut_update_ref_count(object, action);
Robert Mooref9f46012005-07-08 00:00:00 -0400568 object = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569
570 /* Move on to the next object to be updated */
571
Robert Mooref9f46012005-07-08 00:00:00 -0400572 if (next_object) {
573 object = next_object;
574 next_object = NULL;
Len Brown4be44fc2005-08-05 00:44:28 -0400575 } else if (state_list) {
576 state = acpi_ut_pop_generic_state(&state_list);
Robert Mooref9f46012005-07-08 00:00:00 -0400577 object = state->update.object;
Len Brown4be44fc2005-08-05 00:44:28 -0400578 acpi_ut_delete_generic_state(state);
Robert Mooref9f46012005-07-08 00:00:00 -0400579 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580 }
581
Len Brown4be44fc2005-08-05 00:44:28 -0400582 return_ACPI_STATUS(AE_OK);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583
Len Brown4be44fc2005-08-05 00:44:28 -0400584 error_exit:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585
Bob Mooreb8e4d892006-01-27 16:43:00 -0500586 ACPI_EXCEPTION((AE_INFO, status,
587 "Could not update object reference count"));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588
Lin Mingcf058bd2008-09-27 11:29:57 +0800589 /* Free any stacked Update State objects */
590
591 while (state_list) {
592 state = acpi_ut_pop_generic_state(&state_list);
593 acpi_ut_delete_generic_state(state);
594 }
595
Len Brown4be44fc2005-08-05 00:44:28 -0400596 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597}
598
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599/*******************************************************************************
600 *
601 * FUNCTION: acpi_ut_add_reference
602 *
Robert Moore44f6c012005-04-18 22:49:35 -0400603 * PARAMETERS: Object - Object whose reference count is to be
604 * incremented
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605 *
606 * RETURN: None
607 *
608 * DESCRIPTION: Add one reference to an ACPI object
609 *
610 ******************************************************************************/
611
Len Brown4be44fc2005-08-05 00:44:28 -0400612void acpi_ut_add_reference(union acpi_operand_object *object)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613{
614
Bob Mooreb229cf92006-04-21 17:15:00 -0400615 ACPI_FUNCTION_TRACE_PTR(ut_add_reference, object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616
617 /* Ensure that we have a valid object */
618
Len Brown4be44fc2005-08-05 00:44:28 -0400619 if (!acpi_ut_valid_internal_object(object)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620 return_VOID;
621 }
622
Len Brown4be44fc2005-08-05 00:44:28 -0400623 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
624 "Obj %p Current Refs=%X [To Be Incremented]\n",
625 object, object->common.reference_count));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626
627 /* Increment the reference count */
628
Len Brown4be44fc2005-08-05 00:44:28 -0400629 (void)acpi_ut_update_object_reference(object, REF_INCREMENT);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630 return_VOID;
631}
632
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633/*******************************************************************************
634 *
635 * FUNCTION: acpi_ut_remove_reference
636 *
Robert Moore44f6c012005-04-18 22:49:35 -0400637 * PARAMETERS: Object - Object whose ref count will be decremented
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638 *
639 * RETURN: None
640 *
641 * DESCRIPTION: Decrement the reference count of an ACPI internal object
642 *
643 ******************************************************************************/
644
Len Brown4be44fc2005-08-05 00:44:28 -0400645void acpi_ut_remove_reference(union acpi_operand_object *object)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646{
647
Bob Mooreb229cf92006-04-21 17:15:00 -0400648 ACPI_FUNCTION_TRACE_PTR(ut_remove_reference, object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700649
650 /*
Bob Moore41195322006-05-26 16:36:00 -0400651 * Allow a NULL pointer to be passed in, just ignore it. This saves
652 * each caller from having to check. Also, ignore NS nodes.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653 *
654 */
655 if (!object ||
Len Brown4be44fc2005-08-05 00:44:28 -0400656 (ACPI_GET_DESCRIPTOR_TYPE(object) == ACPI_DESC_TYPE_NAMED)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657 return_VOID;
658 }
659
660 /* Ensure that we have a valid object */
661
Len Brown4be44fc2005-08-05 00:44:28 -0400662 if (!acpi_ut_valid_internal_object(object)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663 return_VOID;
664 }
665
Len Brown4be44fc2005-08-05 00:44:28 -0400666 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
667 "Obj %p Current Refs=%X [To Be Decremented]\n",
668 object, object->common.reference_count));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669
670 /*
671 * Decrement the reference count, and only actually delete the object
Bob Moore41195322006-05-26 16:36:00 -0400672 * if the reference count becomes 0. (Must also decrement the ref count
Linus Torvalds1da177e2005-04-16 15:20:36 -0700673 * of all subobjects!)
674 */
Len Brown4be44fc2005-08-05 00:44:28 -0400675 (void)acpi_ut_update_object_reference(object, REF_DECREMENT);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700676 return_VOID;
677}