blob: 80bb6515411791898cacbee2c3c71c92bcc85180 [file] [log] [blame]
Robert Moore73459f72005-06-24 00:00:00 -04001/*******************************************************************************
2 *
3 * Module Name: utmutex - local mutex support
4 *
5 ******************************************************************************/
6
7/*
Len Brown75a44ce2008-04-23 23:00:13 -04008 * Copyright (C) 2000 - 2008, Intel Corp.
Robert Moore73459f72005-06-24 00:00:00 -04009 * 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
Robert Moore73459f72005-06-24 00:00:00 -040044#include <acpi/acpi.h>
Len Browne2f7a772009-01-09 00:30:03 -050045#include "accommon.h"
Robert Moore73459f72005-06-24 00:00:00 -040046
47#define _COMPONENT ACPI_UTILITIES
Len Brown4be44fc2005-08-05 00:44:28 -040048ACPI_MODULE_NAME("utmutex")
Robert Moore73459f72005-06-24 00:00:00 -040049
50/* Local prototypes */
Len Brown4be44fc2005-08-05 00:44:28 -040051static acpi_status acpi_ut_create_mutex(acpi_mutex_handle mutex_id);
Robert Moore73459f72005-06-24 00:00:00 -040052
Len Brown4be44fc2005-08-05 00:44:28 -040053static acpi_status acpi_ut_delete_mutex(acpi_mutex_handle mutex_id);
Robert Moore73459f72005-06-24 00:00:00 -040054
55/*******************************************************************************
56 *
57 * FUNCTION: acpi_ut_mutex_initialize
58 *
59 * PARAMETERS: None.
60 *
61 * RETURN: Status
62 *
Bob Moore8a335a232009-03-09 16:31:04 +080063 * DESCRIPTION: Create the system mutex objects. This includes mutexes,
64 * spin locks, and reader/writer locks.
Robert Moore73459f72005-06-24 00:00:00 -040065 *
66 ******************************************************************************/
67
Len Brown4be44fc2005-08-05 00:44:28 -040068acpi_status acpi_ut_mutex_initialize(void)
Robert Moore73459f72005-06-24 00:00:00 -040069{
Len Brown4be44fc2005-08-05 00:44:28 -040070 u32 i;
71 acpi_status status;
Robert Moore73459f72005-06-24 00:00:00 -040072
Bob Mooreb229cf92006-04-21 17:15:00 -040073 ACPI_FUNCTION_TRACE(ut_mutex_initialize);
Robert Moore73459f72005-06-24 00:00:00 -040074
Bob Moore8a335a232009-03-09 16:31:04 +080075 /* Create each of the predefined mutex objects */
76
Bob Moore4c90ece2006-06-08 16:29:00 -040077 for (i = 0; i < ACPI_NUM_MUTEX; i++) {
Len Brown4be44fc2005-08-05 00:44:28 -040078 status = acpi_ut_create_mutex(i);
79 if (ACPI_FAILURE(status)) {
80 return_ACPI_STATUS(status);
Robert Moore73459f72005-06-24 00:00:00 -040081 }
82 }
83
Bob Moore4c90ece2006-06-08 16:29:00 -040084 /* Create the spinlocks for use at interrupt level */
85
Bob Moore967440e32006-06-23 17:04:00 -040086 spin_lock_init(acpi_gbl_gpe_lock);
87 spin_lock_init(acpi_gbl_hardware_lock);
Bob Moore4c90ece2006-06-08 16:29:00 -040088
Bob Moore8a335a232009-03-09 16:31:04 +080089 /* Create the reader/writer lock for namespace access */
90
91 status = acpi_ut_create_rw_lock(&acpi_gbl_namespace_rw_lock);
Len Brown4be44fc2005-08-05 00:44:28 -040092 return_ACPI_STATUS(status);
Robert Moore73459f72005-06-24 00:00:00 -040093}
94
Robert Moore73459f72005-06-24 00:00:00 -040095/*******************************************************************************
96 *
97 * FUNCTION: acpi_ut_mutex_terminate
98 *
99 * PARAMETERS: None.
100 *
101 * RETURN: None.
102 *
Bob Moore8a335a232009-03-09 16:31:04 +0800103 * DESCRIPTION: Delete all of the system mutex objects. This includes mutexes,
104 * spin locks, and reader/writer locks.
Robert Moore73459f72005-06-24 00:00:00 -0400105 *
106 ******************************************************************************/
107
Len Brown4be44fc2005-08-05 00:44:28 -0400108void acpi_ut_mutex_terminate(void)
Robert Moore73459f72005-06-24 00:00:00 -0400109{
Len Brown4be44fc2005-08-05 00:44:28 -0400110 u32 i;
Robert Moore73459f72005-06-24 00:00:00 -0400111
Bob Mooreb229cf92006-04-21 17:15:00 -0400112 ACPI_FUNCTION_TRACE(ut_mutex_terminate);
Robert Moore73459f72005-06-24 00:00:00 -0400113
Bob Moore8a335a232009-03-09 16:31:04 +0800114 /* Delete each predefined mutex object */
115
Bob Moore4c90ece2006-06-08 16:29:00 -0400116 for (i = 0; i < ACPI_NUM_MUTEX; i++) {
Len Brown4be44fc2005-08-05 00:44:28 -0400117 (void)acpi_ut_delete_mutex(i);
Robert Moore73459f72005-06-24 00:00:00 -0400118 }
119
Bob Moore4c90ece2006-06-08 16:29:00 -0400120 /* Delete the spinlocks */
121
Len Brown4be44fc2005-08-05 00:44:28 -0400122 acpi_os_delete_lock(acpi_gbl_gpe_lock);
Bob Moore4c90ece2006-06-08 16:29:00 -0400123 acpi_os_delete_lock(acpi_gbl_hardware_lock);
Bob Moore8a335a232009-03-09 16:31:04 +0800124
125 /* Delete the reader/writer lock */
126
127 acpi_ut_delete_rw_lock(&acpi_gbl_namespace_rw_lock);
Robert Moore73459f72005-06-24 00:00:00 -0400128 return_VOID;
129}
130
Robert Moore73459f72005-06-24 00:00:00 -0400131/*******************************************************************************
132 *
133 * FUNCTION: acpi_ut_create_mutex
134 *
135 * PARAMETERS: mutex_iD - ID of the mutex to be created
136 *
137 * RETURN: Status
138 *
139 * DESCRIPTION: Create a mutex object.
140 *
141 ******************************************************************************/
142
Len Brown4be44fc2005-08-05 00:44:28 -0400143static acpi_status acpi_ut_create_mutex(acpi_mutex_handle mutex_id)
Robert Moore73459f72005-06-24 00:00:00 -0400144{
Len Brown4be44fc2005-08-05 00:44:28 -0400145 acpi_status status = AE_OK;
Robert Moore73459f72005-06-24 00:00:00 -0400146
Bob Mooreb229cf92006-04-21 17:15:00 -0400147 ACPI_FUNCTION_TRACE_U32(ut_create_mutex, mutex_id);
Robert Moore73459f72005-06-24 00:00:00 -0400148
Bob Moore4c90ece2006-06-08 16:29:00 -0400149 if (mutex_id > ACPI_MAX_MUTEX) {
Len Brown4be44fc2005-08-05 00:44:28 -0400150 return_ACPI_STATUS(AE_BAD_PARAMETER);
Robert Moore73459f72005-06-24 00:00:00 -0400151 }
152
153 if (!acpi_gbl_mutex_info[mutex_id].mutex) {
Bob Moore967440e32006-06-23 17:04:00 -0400154 status =
155 acpi_os_create_mutex(&acpi_gbl_mutex_info[mutex_id].mutex);
Len Brown4be44fc2005-08-05 00:44:28 -0400156 acpi_gbl_mutex_info[mutex_id].thread_id =
157 ACPI_MUTEX_NOT_ACQUIRED;
Robert Moore73459f72005-06-24 00:00:00 -0400158 acpi_gbl_mutex_info[mutex_id].use_count = 0;
159 }
160
Len Brown4be44fc2005-08-05 00:44:28 -0400161 return_ACPI_STATUS(status);
Robert Moore73459f72005-06-24 00:00:00 -0400162}
163
Robert Moore73459f72005-06-24 00:00:00 -0400164/*******************************************************************************
165 *
166 * FUNCTION: acpi_ut_delete_mutex
167 *
168 * PARAMETERS: mutex_iD - ID of the mutex to be deleted
169 *
170 * RETURN: Status
171 *
172 * DESCRIPTION: Delete a mutex object.
173 *
174 ******************************************************************************/
175
Len Brown4be44fc2005-08-05 00:44:28 -0400176static acpi_status acpi_ut_delete_mutex(acpi_mutex_handle mutex_id)
Robert Moore73459f72005-06-24 00:00:00 -0400177{
Robert Moore73459f72005-06-24 00:00:00 -0400178
Bob Mooreb229cf92006-04-21 17:15:00 -0400179 ACPI_FUNCTION_TRACE_U32(ut_delete_mutex, mutex_id);
Robert Moore73459f72005-06-24 00:00:00 -0400180
Bob Moore4c90ece2006-06-08 16:29:00 -0400181 if (mutex_id > ACPI_MAX_MUTEX) {
Len Brown4be44fc2005-08-05 00:44:28 -0400182 return_ACPI_STATUS(AE_BAD_PARAMETER);
Robert Moore73459f72005-06-24 00:00:00 -0400183 }
184
Bob Moore967440e32006-06-23 17:04:00 -0400185 acpi_os_delete_mutex(acpi_gbl_mutex_info[mutex_id].mutex);
Robert Moore73459f72005-06-24 00:00:00 -0400186
187 acpi_gbl_mutex_info[mutex_id].mutex = NULL;
Robert Mooref9f46012005-07-08 00:00:00 -0400188 acpi_gbl_mutex_info[mutex_id].thread_id = ACPI_MUTEX_NOT_ACQUIRED;
Robert Moore73459f72005-06-24 00:00:00 -0400189
Bob Moore967440e32006-06-23 17:04:00 -0400190 return_ACPI_STATUS(AE_OK);
Robert Moore73459f72005-06-24 00:00:00 -0400191}
192
Robert Moore73459f72005-06-24 00:00:00 -0400193/*******************************************************************************
194 *
195 * FUNCTION: acpi_ut_acquire_mutex
196 *
197 * PARAMETERS: mutex_iD - ID of the mutex to be acquired
198 *
199 * RETURN: Status
200 *
201 * DESCRIPTION: Acquire a mutex object.
202 *
203 ******************************************************************************/
204
Len Brown4be44fc2005-08-05 00:44:28 -0400205acpi_status acpi_ut_acquire_mutex(acpi_mutex_handle mutex_id)
Robert Moore73459f72005-06-24 00:00:00 -0400206{
Len Brown4be44fc2005-08-05 00:44:28 -0400207 acpi_status status;
Bob Moore83135242006-10-03 00:00:00 -0400208 acpi_thread_id this_thread_id;
Robert Moore73459f72005-06-24 00:00:00 -0400209
Bob Mooreb229cf92006-04-21 17:15:00 -0400210 ACPI_FUNCTION_NAME(ut_acquire_mutex);
Robert Moore73459f72005-06-24 00:00:00 -0400211
Bob Moore4c90ece2006-06-08 16:29:00 -0400212 if (mutex_id > ACPI_MAX_MUTEX) {
Robert Moore73459f72005-06-24 00:00:00 -0400213 return (AE_BAD_PARAMETER);
214 }
215
Len Brown4be44fc2005-08-05 00:44:28 -0400216 this_thread_id = acpi_os_get_thread_id();
Robert Moore73459f72005-06-24 00:00:00 -0400217
218#ifdef ACPI_MUTEX_DEBUG
219 {
Len Brown4be44fc2005-08-05 00:44:28 -0400220 u32 i;
Robert Moore73459f72005-06-24 00:00:00 -0400221 /*
222 * Mutex debug code, for internal debugging only.
223 *
224 * Deadlock prevention. Check if this thread owns any mutexes of value
225 * greater than or equal to this one. If so, the thread has violated
226 * the mutex ordering rule. This indicates a coding error somewhere in
227 * the ACPI subsystem code.
228 */
Bob Mooreb53ce3f2008-06-10 14:30:04 +0800229 for (i = mutex_id; i < ACPI_NUM_MUTEX; i++) {
Robert Moorebda663d2005-09-16 16:51:15 -0400230 if (acpi_gbl_mutex_info[i].thread_id == this_thread_id) {
Robert Moore73459f72005-06-24 00:00:00 -0400231 if (i == mutex_id) {
Bob Mooreb8e4d892006-01-27 16:43:00 -0500232 ACPI_ERROR((AE_INFO,
Bob Moore10b65752009-04-22 11:39:10 +0800233 "Mutex [%s] already acquired by this thread [%p]",
Bob Mooreb8e4d892006-01-27 16:43:00 -0500234 acpi_ut_get_mutex_name
235 (mutex_id),
Bob Moore10b65752009-04-22 11:39:10 +0800236 ACPI_CAST_PTR(void,
237 this_thread_id)));
Robert Moore73459f72005-06-24 00:00:00 -0400238
239 return (AE_ALREADY_ACQUIRED);
240 }
241
Bob Mooreb8e4d892006-01-27 16:43:00 -0500242 ACPI_ERROR((AE_INFO,
Bob Moore10b65752009-04-22 11:39:10 +0800243 "Invalid acquire order: Thread %p owns [%s], wants [%s]",
244 ACPI_CAST_PTR(void, this_thread_id),
Bob Mooreb8e4d892006-01-27 16:43:00 -0500245 acpi_ut_get_mutex_name(i),
246 acpi_ut_get_mutex_name(mutex_id)));
Robert Moore73459f72005-06-24 00:00:00 -0400247
248 return (AE_ACQUIRE_DEADLOCK);
249 }
250 }
251 }
252#endif
253
Len Brown4be44fc2005-08-05 00:44:28 -0400254 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX,
Bob Moore10b65752009-04-22 11:39:10 +0800255 "Thread %p attempting to acquire Mutex [%s]\n",
256 ACPI_CAST_PTR(void, this_thread_id),
Martin Bligh965a3d42006-10-20 14:30:26 -0700257 acpi_ut_get_mutex_name(mutex_id)));
Robert Moore73459f72005-06-24 00:00:00 -0400258
Bob Moore967440e32006-06-23 17:04:00 -0400259 status = acpi_os_acquire_mutex(acpi_gbl_mutex_info[mutex_id].mutex,
260 ACPI_WAIT_FOREVER);
Len Brown4be44fc2005-08-05 00:44:28 -0400261 if (ACPI_SUCCESS(status)) {
262 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX,
Bob Moore10b65752009-04-22 11:39:10 +0800263 "Thread %p acquired Mutex [%s]\n",
264 ACPI_CAST_PTR(void, this_thread_id),
Len Brown4be44fc2005-08-05 00:44:28 -0400265 acpi_ut_get_mutex_name(mutex_id)));
Robert Moore73459f72005-06-24 00:00:00 -0400266
267 acpi_gbl_mutex_info[mutex_id].use_count++;
Robert Mooref9f46012005-07-08 00:00:00 -0400268 acpi_gbl_mutex_info[mutex_id].thread_id = this_thread_id;
Len Brown4be44fc2005-08-05 00:44:28 -0400269 } else {
Bob Mooreb8e4d892006-01-27 16:43:00 -0500270 ACPI_EXCEPTION((AE_INFO, status,
Bob Moore10b65752009-04-22 11:39:10 +0800271 "Thread %p could not acquire Mutex [%X]",
272 ACPI_CAST_PTR(void, this_thread_id), mutex_id));
Robert Moore73459f72005-06-24 00:00:00 -0400273 }
274
275 return (status);
276}
277
Robert Moore73459f72005-06-24 00:00:00 -0400278/*******************************************************************************
279 *
280 * FUNCTION: acpi_ut_release_mutex
281 *
282 * PARAMETERS: mutex_iD - ID of the mutex to be released
283 *
284 * RETURN: Status
285 *
286 * DESCRIPTION: Release a mutex object.
287 *
288 ******************************************************************************/
289
Len Brown4be44fc2005-08-05 00:44:28 -0400290acpi_status acpi_ut_release_mutex(acpi_mutex_handle mutex_id)
Robert Moore73459f72005-06-24 00:00:00 -0400291{
Bob Moore83135242006-10-03 00:00:00 -0400292 acpi_thread_id this_thread_id;
Robert Moore73459f72005-06-24 00:00:00 -0400293
Bob Mooreb229cf92006-04-21 17:15:00 -0400294 ACPI_FUNCTION_NAME(ut_release_mutex);
Robert Moore73459f72005-06-24 00:00:00 -0400295
Len Brown4be44fc2005-08-05 00:44:28 -0400296 this_thread_id = acpi_os_get_thread_id();
Bob Moore10b65752009-04-22 11:39:10 +0800297 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX, "Thread %p releasing Mutex [%s]\n",
298 ACPI_CAST_PTR(void, this_thread_id),
Len Brown4be44fc2005-08-05 00:44:28 -0400299 acpi_ut_get_mutex_name(mutex_id)));
Robert Moore73459f72005-06-24 00:00:00 -0400300
Bob Moore4c90ece2006-06-08 16:29:00 -0400301 if (mutex_id > ACPI_MAX_MUTEX) {
Robert Moore73459f72005-06-24 00:00:00 -0400302 return (AE_BAD_PARAMETER);
303 }
304
305 /*
306 * Mutex must be acquired in order to release it!
307 */
Robert Mooref9f46012005-07-08 00:00:00 -0400308 if (acpi_gbl_mutex_info[mutex_id].thread_id == ACPI_MUTEX_NOT_ACQUIRED) {
Bob Mooreb8e4d892006-01-27 16:43:00 -0500309 ACPI_ERROR((AE_INFO,
310 "Mutex [%X] is not acquired, cannot release",
311 mutex_id));
Robert Moore73459f72005-06-24 00:00:00 -0400312
313 return (AE_NOT_ACQUIRED);
314 }
Robert Moore73459f72005-06-24 00:00:00 -0400315#ifdef ACPI_MUTEX_DEBUG
316 {
Len Brown4be44fc2005-08-05 00:44:28 -0400317 u32 i;
Robert Moore73459f72005-06-24 00:00:00 -0400318 /*
319 * Mutex debug code, for internal debugging only.
320 *
321 * Deadlock prevention. Check if this thread owns any mutexes of value
322 * greater than this one. If so, the thread has violated the mutex
323 * ordering rule. This indicates a coding error somewhere in
324 * the ACPI subsystem code.
325 */
Bob Mooreb53ce3f2008-06-10 14:30:04 +0800326 for (i = mutex_id; i < ACPI_NUM_MUTEX; i++) {
Robert Moorebda663d2005-09-16 16:51:15 -0400327 if (acpi_gbl_mutex_info[i].thread_id == this_thread_id) {
Robert Moore73459f72005-06-24 00:00:00 -0400328 if (i == mutex_id) {
329 continue;
330 }
331
Bob Mooreb8e4d892006-01-27 16:43:00 -0500332 ACPI_ERROR((AE_INFO,
333 "Invalid release order: owns [%s], releasing [%s]",
334 acpi_ut_get_mutex_name(i),
335 acpi_ut_get_mutex_name(mutex_id)));
Robert Moore73459f72005-06-24 00:00:00 -0400336
337 return (AE_RELEASE_DEADLOCK);
338 }
339 }
340 }
341#endif
342
343 /* Mark unlocked FIRST */
344
Robert Mooref9f46012005-07-08 00:00:00 -0400345 acpi_gbl_mutex_info[mutex_id].thread_id = ACPI_MUTEX_NOT_ACQUIRED;
Robert Moore73459f72005-06-24 00:00:00 -0400346
Bob Moore967440e32006-06-23 17:04:00 -0400347 acpi_os_release_mutex(acpi_gbl_mutex_info[mutex_id].mutex);
348 return (AE_OK);
Robert Moore73459f72005-06-24 00:00:00 -0400349}