Commit | Line | Data |
---|---|---|
73459f73 RM |
1 | /******************************************************************************* |
2 | * | |
3 | * Module Name: utmutex - local mutex support | |
4 | * | |
5 | ******************************************************************************/ | |
6 | ||
7 | /* | |
75a44ce0 | 8 | * Copyright (C) 2000 - 2008, Intel Corp. |
73459f73 RM |
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 | ||
73459f73 | 44 | #include <acpi/acpi.h> |
e2f7a777 | 45 | #include "accommon.h" |
73459f73 RM |
46 | |
47 | #define _COMPONENT ACPI_UTILITIES | |
4be44fcd | 48 | ACPI_MODULE_NAME("utmutex") |
73459f73 RM |
49 | |
50 | /* Local prototypes */ | |
4be44fcd | 51 | static acpi_status acpi_ut_create_mutex(acpi_mutex_handle mutex_id); |
73459f73 | 52 | |
4be44fcd | 53 | static acpi_status acpi_ut_delete_mutex(acpi_mutex_handle mutex_id); |
73459f73 RM |
54 | |
55 | /******************************************************************************* | |
56 | * | |
57 | * FUNCTION: acpi_ut_mutex_initialize | |
58 | * | |
59 | * PARAMETERS: None. | |
60 | * | |
61 | * RETURN: Status | |
62 | * | |
8a335a23 BM |
63 | * DESCRIPTION: Create the system mutex objects. This includes mutexes, |
64 | * spin locks, and reader/writer locks. | |
73459f73 RM |
65 | * |
66 | ******************************************************************************/ | |
67 | ||
4be44fcd | 68 | acpi_status acpi_ut_mutex_initialize(void) |
73459f73 | 69 | { |
4be44fcd LB |
70 | u32 i; |
71 | acpi_status status; | |
73459f73 | 72 | |
b229cf92 | 73 | ACPI_FUNCTION_TRACE(ut_mutex_initialize); |
73459f73 | 74 | |
8a335a23 BM |
75 | /* Create each of the predefined mutex objects */ |
76 | ||
4c90ece2 | 77 | for (i = 0; i < ACPI_NUM_MUTEX; i++) { |
4be44fcd LB |
78 | status = acpi_ut_create_mutex(i); |
79 | if (ACPI_FAILURE(status)) { | |
80 | return_ACPI_STATUS(status); | |
73459f73 RM |
81 | } |
82 | } | |
83 | ||
4c90ece2 BM |
84 | /* Create the spinlocks for use at interrupt level */ |
85 | ||
967440e3 BM |
86 | spin_lock_init(acpi_gbl_gpe_lock); |
87 | spin_lock_init(acpi_gbl_hardware_lock); | |
4c90ece2 | 88 | |
8a335a23 BM |
89 | /* Create the reader/writer lock for namespace access */ |
90 | ||
91 | status = acpi_ut_create_rw_lock(&acpi_gbl_namespace_rw_lock); | |
4be44fcd | 92 | return_ACPI_STATUS(status); |
73459f73 RM |
93 | } |
94 | ||
73459f73 RM |
95 | /******************************************************************************* |
96 | * | |
97 | * FUNCTION: acpi_ut_mutex_terminate | |
98 | * | |
99 | * PARAMETERS: None. | |
100 | * | |
101 | * RETURN: None. | |
102 | * | |
8a335a23 BM |
103 | * DESCRIPTION: Delete all of the system mutex objects. This includes mutexes, |
104 | * spin locks, and reader/writer locks. | |
73459f73 RM |
105 | * |
106 | ******************************************************************************/ | |
107 | ||
4be44fcd | 108 | void acpi_ut_mutex_terminate(void) |
73459f73 | 109 | { |
4be44fcd | 110 | u32 i; |
73459f73 | 111 | |
b229cf92 | 112 | ACPI_FUNCTION_TRACE(ut_mutex_terminate); |
73459f73 | 113 | |
8a335a23 BM |
114 | /* Delete each predefined mutex object */ |
115 | ||
4c90ece2 | 116 | for (i = 0; i < ACPI_NUM_MUTEX; i++) { |
4be44fcd | 117 | (void)acpi_ut_delete_mutex(i); |
73459f73 RM |
118 | } |
119 | ||
4c90ece2 BM |
120 | /* Delete the spinlocks */ |
121 | ||
4be44fcd | 122 | acpi_os_delete_lock(acpi_gbl_gpe_lock); |
4c90ece2 | 123 | acpi_os_delete_lock(acpi_gbl_hardware_lock); |
8a335a23 BM |
124 | |
125 | /* Delete the reader/writer lock */ | |
126 | ||
127 | acpi_ut_delete_rw_lock(&acpi_gbl_namespace_rw_lock); | |
73459f73 RM |
128 | return_VOID; |
129 | } | |
130 | ||
73459f73 RM |
131 | /******************************************************************************* |
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 | ||
4be44fcd | 143 | static acpi_status acpi_ut_create_mutex(acpi_mutex_handle mutex_id) |
73459f73 | 144 | { |
4be44fcd | 145 | acpi_status status = AE_OK; |
73459f73 | 146 | |
b229cf92 | 147 | ACPI_FUNCTION_TRACE_U32(ut_create_mutex, mutex_id); |
73459f73 | 148 | |
4c90ece2 | 149 | if (mutex_id > ACPI_MAX_MUTEX) { |
4be44fcd | 150 | return_ACPI_STATUS(AE_BAD_PARAMETER); |
73459f73 RM |
151 | } |
152 | ||
153 | if (!acpi_gbl_mutex_info[mutex_id].mutex) { | |
967440e3 BM |
154 | status = |
155 | acpi_os_create_mutex(&acpi_gbl_mutex_info[mutex_id].mutex); | |
4be44fcd LB |
156 | acpi_gbl_mutex_info[mutex_id].thread_id = |
157 | ACPI_MUTEX_NOT_ACQUIRED; | |
73459f73 RM |
158 | acpi_gbl_mutex_info[mutex_id].use_count = 0; |
159 | } | |
160 | ||
4be44fcd | 161 | return_ACPI_STATUS(status); |
73459f73 RM |
162 | } |
163 | ||
73459f73 RM |
164 | /******************************************************************************* |
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 | ||
4be44fcd | 176 | static acpi_status acpi_ut_delete_mutex(acpi_mutex_handle mutex_id) |
73459f73 | 177 | { |
73459f73 | 178 | |
b229cf92 | 179 | ACPI_FUNCTION_TRACE_U32(ut_delete_mutex, mutex_id); |
73459f73 | 180 | |
4c90ece2 | 181 | if (mutex_id > ACPI_MAX_MUTEX) { |
4be44fcd | 182 | return_ACPI_STATUS(AE_BAD_PARAMETER); |
73459f73 RM |
183 | } |
184 | ||
967440e3 | 185 | acpi_os_delete_mutex(acpi_gbl_mutex_info[mutex_id].mutex); |
73459f73 RM |
186 | |
187 | acpi_gbl_mutex_info[mutex_id].mutex = NULL; | |
f9f4601f | 188 | acpi_gbl_mutex_info[mutex_id].thread_id = ACPI_MUTEX_NOT_ACQUIRED; |
73459f73 | 189 | |
967440e3 | 190 | return_ACPI_STATUS(AE_OK); |
73459f73 RM |
191 | } |
192 | ||
73459f73 RM |
193 | /******************************************************************************* |
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 | ||
4be44fcd | 205 | acpi_status acpi_ut_acquire_mutex(acpi_mutex_handle mutex_id) |
73459f73 | 206 | { |
4be44fcd | 207 | acpi_status status; |
8313524a | 208 | acpi_thread_id this_thread_id; |
73459f73 | 209 | |
b229cf92 | 210 | ACPI_FUNCTION_NAME(ut_acquire_mutex); |
73459f73 | 211 | |
4c90ece2 | 212 | if (mutex_id > ACPI_MAX_MUTEX) { |
73459f73 RM |
213 | return (AE_BAD_PARAMETER); |
214 | } | |
215 | ||
4be44fcd | 216 | this_thread_id = acpi_os_get_thread_id(); |
73459f73 RM |
217 | |
218 | #ifdef ACPI_MUTEX_DEBUG | |
219 | { | |
4be44fcd | 220 | u32 i; |
73459f73 RM |
221 | /* |
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 | */ | |
b53ce3f7 | 229 | for (i = mutex_id; i < ACPI_NUM_MUTEX; i++) { |
bda663d3 | 230 | if (acpi_gbl_mutex_info[i].thread_id == this_thread_id) { |
73459f73 | 231 | if (i == mutex_id) { |
b8e4d893 | 232 | ACPI_ERROR((AE_INFO, |
10b6575b | 233 | "Mutex [%s] already acquired by this thread [%p]", |
b8e4d893 BM |
234 | acpi_ut_get_mutex_name |
235 | (mutex_id), | |
10b6575b BM |
236 | ACPI_CAST_PTR(void, |
237 | this_thread_id))); | |
73459f73 RM |
238 | |
239 | return (AE_ALREADY_ACQUIRED); | |
240 | } | |
241 | ||
b8e4d893 | 242 | ACPI_ERROR((AE_INFO, |
10b6575b BM |
243 | "Invalid acquire order: Thread %p owns [%s], wants [%s]", |
244 | ACPI_CAST_PTR(void, this_thread_id), | |
b8e4d893 BM |
245 | acpi_ut_get_mutex_name(i), |
246 | acpi_ut_get_mutex_name(mutex_id))); | |
73459f73 RM |
247 | |
248 | return (AE_ACQUIRE_DEADLOCK); | |
249 | } | |
250 | } | |
251 | } | |
252 | #endif | |
253 | ||
4be44fcd | 254 | ACPI_DEBUG_PRINT((ACPI_DB_MUTEX, |
10b6575b BM |
255 | "Thread %p attempting to acquire Mutex [%s]\n", |
256 | ACPI_CAST_PTR(void, this_thread_id), | |
965a3d44 | 257 | acpi_ut_get_mutex_name(mutex_id))); |
73459f73 | 258 | |
967440e3 BM |
259 | status = acpi_os_acquire_mutex(acpi_gbl_mutex_info[mutex_id].mutex, |
260 | ACPI_WAIT_FOREVER); | |
4be44fcd LB |
261 | if (ACPI_SUCCESS(status)) { |
262 | ACPI_DEBUG_PRINT((ACPI_DB_MUTEX, | |
10b6575b BM |
263 | "Thread %p acquired Mutex [%s]\n", |
264 | ACPI_CAST_PTR(void, this_thread_id), | |
4be44fcd | 265 | acpi_ut_get_mutex_name(mutex_id))); |
73459f73 RM |
266 | |
267 | acpi_gbl_mutex_info[mutex_id].use_count++; | |
f9f4601f | 268 | acpi_gbl_mutex_info[mutex_id].thread_id = this_thread_id; |
4be44fcd | 269 | } else { |
b8e4d893 | 270 | ACPI_EXCEPTION((AE_INFO, status, |
10b6575b BM |
271 | "Thread %p could not acquire Mutex [%X]", |
272 | ACPI_CAST_PTR(void, this_thread_id), mutex_id)); | |
73459f73 RM |
273 | } |
274 | ||
275 | return (status); | |
276 | } | |
277 | ||
73459f73 RM |
278 | /******************************************************************************* |
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 | ||
4be44fcd | 290 | acpi_status acpi_ut_release_mutex(acpi_mutex_handle mutex_id) |
73459f73 | 291 | { |
8313524a | 292 | acpi_thread_id this_thread_id; |
73459f73 | 293 | |
b229cf92 | 294 | ACPI_FUNCTION_NAME(ut_release_mutex); |
73459f73 | 295 | |
4be44fcd | 296 | this_thread_id = acpi_os_get_thread_id(); |
10b6575b BM |
297 | ACPI_DEBUG_PRINT((ACPI_DB_MUTEX, "Thread %p releasing Mutex [%s]\n", |
298 | ACPI_CAST_PTR(void, this_thread_id), | |
4be44fcd | 299 | acpi_ut_get_mutex_name(mutex_id))); |
73459f73 | 300 | |
4c90ece2 | 301 | if (mutex_id > ACPI_MAX_MUTEX) { |
73459f73 RM |
302 | return (AE_BAD_PARAMETER); |
303 | } | |
304 | ||
305 | /* | |
306 | * Mutex must be acquired in order to release it! | |
307 | */ | |
f9f4601f | 308 | if (acpi_gbl_mutex_info[mutex_id].thread_id == ACPI_MUTEX_NOT_ACQUIRED) { |
b8e4d893 BM |
309 | ACPI_ERROR((AE_INFO, |
310 | "Mutex [%X] is not acquired, cannot release", | |
311 | mutex_id)); | |
73459f73 RM |
312 | |
313 | return (AE_NOT_ACQUIRED); | |
314 | } | |
73459f73 RM |
315 | #ifdef ACPI_MUTEX_DEBUG |
316 | { | |
4be44fcd | 317 | u32 i; |
73459f73 RM |
318 | /* |
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 | */ | |
b53ce3f7 | 326 | for (i = mutex_id; i < ACPI_NUM_MUTEX; i++) { |
bda663d3 | 327 | if (acpi_gbl_mutex_info[i].thread_id == this_thread_id) { |
73459f73 RM |
328 | if (i == mutex_id) { |
329 | continue; | |
330 | } | |
331 | ||
b8e4d893 BM |
332 | 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))); | |
73459f73 RM |
336 | |
337 | return (AE_RELEASE_DEADLOCK); | |
338 | } | |
339 | } | |
340 | } | |
341 | #endif | |
342 | ||
343 | /* Mark unlocked FIRST */ | |
344 | ||
f9f4601f | 345 | acpi_gbl_mutex_info[mutex_id].thread_id = ACPI_MUTEX_NOT_ACQUIRED; |
73459f73 | 346 | |
967440e3 BM |
347 | acpi_os_release_mutex(acpi_gbl_mutex_info[mutex_id].mutex); |
348 | return (AE_OK); | |
73459f73 | 349 | } |