]>
Commit | Line | Data |
---|---|---|
73459f73 RM |
1 | /******************************************************************************* |
2 | * | |
3 | * Module Name: utmutex - local mutex support | |
4 | * | |
5 | ******************************************************************************/ | |
6 | ||
7 | /* | |
a8357b0c | 8 | * Copyright (C) 2000 - 2010, 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 | |
2147d3f0 | 53 | static void 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 | |
b0ed7a91 LM |
89 | /* Mutex for _OSI support */ |
90 | status = acpi_os_create_mutex(&acpi_gbl_osi_mutex); | |
91 | if (ACPI_FAILURE(status)) { | |
92 | return_ACPI_STATUS(status); | |
93 | } | |
94 | ||
8a335a23 BM |
95 | /* Create the reader/writer lock for namespace access */ |
96 | ||
97 | status = acpi_ut_create_rw_lock(&acpi_gbl_namespace_rw_lock); | |
4be44fcd | 98 | return_ACPI_STATUS(status); |
73459f73 RM |
99 | } |
100 | ||
73459f73 RM |
101 | /******************************************************************************* |
102 | * | |
103 | * FUNCTION: acpi_ut_mutex_terminate | |
104 | * | |
105 | * PARAMETERS: None. | |
106 | * | |
107 | * RETURN: None. | |
108 | * | |
8a335a23 BM |
109 | * DESCRIPTION: Delete all of the system mutex objects. This includes mutexes, |
110 | * spin locks, and reader/writer locks. | |
73459f73 RM |
111 | * |
112 | ******************************************************************************/ | |
113 | ||
4be44fcd | 114 | void acpi_ut_mutex_terminate(void) |
73459f73 | 115 | { |
4be44fcd | 116 | u32 i; |
73459f73 | 117 | |
b229cf92 | 118 | ACPI_FUNCTION_TRACE(ut_mutex_terminate); |
73459f73 | 119 | |
8a335a23 BM |
120 | /* Delete each predefined mutex object */ |
121 | ||
4c90ece2 | 122 | for (i = 0; i < ACPI_NUM_MUTEX; i++) { |
2147d3f0 | 123 | acpi_ut_delete_mutex(i); |
73459f73 RM |
124 | } |
125 | ||
b0ed7a91 LM |
126 | acpi_os_delete_mutex(acpi_gbl_osi_mutex); |
127 | ||
4c90ece2 BM |
128 | /* Delete the spinlocks */ |
129 | ||
4be44fcd | 130 | acpi_os_delete_lock(acpi_gbl_gpe_lock); |
4c90ece2 | 131 | acpi_os_delete_lock(acpi_gbl_hardware_lock); |
8a335a23 BM |
132 | |
133 | /* Delete the reader/writer lock */ | |
134 | ||
135 | acpi_ut_delete_rw_lock(&acpi_gbl_namespace_rw_lock); | |
73459f73 RM |
136 | return_VOID; |
137 | } | |
138 | ||
73459f73 RM |
139 | /******************************************************************************* |
140 | * | |
141 | * FUNCTION: acpi_ut_create_mutex | |
142 | * | |
143 | * PARAMETERS: mutex_iD - ID of the mutex to be created | |
144 | * | |
145 | * RETURN: Status | |
146 | * | |
147 | * DESCRIPTION: Create a mutex object. | |
148 | * | |
149 | ******************************************************************************/ | |
150 | ||
4be44fcd | 151 | static acpi_status acpi_ut_create_mutex(acpi_mutex_handle mutex_id) |
73459f73 | 152 | { |
4be44fcd | 153 | acpi_status status = AE_OK; |
73459f73 | 154 | |
b229cf92 | 155 | ACPI_FUNCTION_TRACE_U32(ut_create_mutex, mutex_id); |
73459f73 | 156 | |
73459f73 | 157 | if (!acpi_gbl_mutex_info[mutex_id].mutex) { |
967440e3 BM |
158 | status = |
159 | acpi_os_create_mutex(&acpi_gbl_mutex_info[mutex_id].mutex); | |
4be44fcd LB |
160 | acpi_gbl_mutex_info[mutex_id].thread_id = |
161 | ACPI_MUTEX_NOT_ACQUIRED; | |
73459f73 RM |
162 | acpi_gbl_mutex_info[mutex_id].use_count = 0; |
163 | } | |
164 | ||
4be44fcd | 165 | return_ACPI_STATUS(status); |
73459f73 RM |
166 | } |
167 | ||
73459f73 RM |
168 | /******************************************************************************* |
169 | * | |
170 | * FUNCTION: acpi_ut_delete_mutex | |
171 | * | |
172 | * PARAMETERS: mutex_iD - ID of the mutex to be deleted | |
173 | * | |
174 | * RETURN: Status | |
175 | * | |
176 | * DESCRIPTION: Delete a mutex object. | |
177 | * | |
178 | ******************************************************************************/ | |
179 | ||
2147d3f0 | 180 | static void acpi_ut_delete_mutex(acpi_mutex_handle mutex_id) |
73459f73 | 181 | { |
73459f73 | 182 | |
b229cf92 | 183 | ACPI_FUNCTION_TRACE_U32(ut_delete_mutex, mutex_id); |
73459f73 | 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 RM |
189 | } |
190 | ||
73459f73 RM |
191 | /******************************************************************************* |
192 | * | |
193 | * FUNCTION: acpi_ut_acquire_mutex | |
194 | * | |
195 | * PARAMETERS: mutex_iD - ID of the mutex to be acquired | |
196 | * | |
197 | * RETURN: Status | |
198 | * | |
199 | * DESCRIPTION: Acquire a mutex object. | |
200 | * | |
201 | ******************************************************************************/ | |
202 | ||
4be44fcd | 203 | acpi_status acpi_ut_acquire_mutex(acpi_mutex_handle mutex_id) |
73459f73 | 204 | { |
4be44fcd | 205 | acpi_status status; |
8313524a | 206 | acpi_thread_id this_thread_id; |
73459f73 | 207 | |
b229cf92 | 208 | ACPI_FUNCTION_NAME(ut_acquire_mutex); |
73459f73 | 209 | |
4c90ece2 | 210 | if (mutex_id > ACPI_MAX_MUTEX) { |
73459f73 RM |
211 | return (AE_BAD_PARAMETER); |
212 | } | |
213 | ||
4be44fcd | 214 | this_thread_id = acpi_os_get_thread_id(); |
73459f73 RM |
215 | |
216 | #ifdef ACPI_MUTEX_DEBUG | |
217 | { | |
4be44fcd | 218 | u32 i; |
73459f73 RM |
219 | /* |
220 | * Mutex debug code, for internal debugging only. | |
221 | * | |
222 | * Deadlock prevention. Check if this thread owns any mutexes of value | |
223 | * greater than or equal to this one. If so, the thread has violated | |
224 | * the mutex ordering rule. This indicates a coding error somewhere in | |
225 | * the ACPI subsystem code. | |
226 | */ | |
b53ce3f7 | 227 | for (i = mutex_id; i < ACPI_NUM_MUTEX; i++) { |
bda663d3 | 228 | if (acpi_gbl_mutex_info[i].thread_id == this_thread_id) { |
73459f73 | 229 | if (i == mutex_id) { |
b8e4d893 | 230 | ACPI_ERROR((AE_INFO, |
28eb3fcf | 231 | "Mutex [%s] already acquired by this thread [%u]", |
b8e4d893 BM |
232 | acpi_ut_get_mutex_name |
233 | (mutex_id), | |
28eb3fcf | 234 | (u32)this_thread_id)); |
73459f73 RM |
235 | |
236 | return (AE_ALREADY_ACQUIRED); | |
237 | } | |
238 | ||
b8e4d893 | 239 | ACPI_ERROR((AE_INFO, |
28eb3fcf LM |
240 | "Invalid acquire order: Thread %u owns [%s], wants [%s]", |
241 | (u32)this_thread_id, | |
b8e4d893 BM |
242 | acpi_ut_get_mutex_name(i), |
243 | acpi_ut_get_mutex_name(mutex_id))); | |
73459f73 RM |
244 | |
245 | return (AE_ACQUIRE_DEADLOCK); | |
246 | } | |
247 | } | |
248 | } | |
249 | #endif | |
250 | ||
4be44fcd | 251 | ACPI_DEBUG_PRINT((ACPI_DB_MUTEX, |
28eb3fcf LM |
252 | "Thread %u attempting to acquire Mutex [%s]\n", |
253 | (u32)this_thread_id, | |
965a3d44 | 254 | acpi_ut_get_mutex_name(mutex_id))); |
73459f73 | 255 | |
967440e3 BM |
256 | status = acpi_os_acquire_mutex(acpi_gbl_mutex_info[mutex_id].mutex, |
257 | ACPI_WAIT_FOREVER); | |
4be44fcd LB |
258 | if (ACPI_SUCCESS(status)) { |
259 | ACPI_DEBUG_PRINT((ACPI_DB_MUTEX, | |
28eb3fcf LM |
260 | "Thread %u acquired Mutex [%s]\n", |
261 | (u32)this_thread_id, | |
4be44fcd | 262 | acpi_ut_get_mutex_name(mutex_id))); |
73459f73 RM |
263 | |
264 | acpi_gbl_mutex_info[mutex_id].use_count++; | |
f9f4601f | 265 | acpi_gbl_mutex_info[mutex_id].thread_id = this_thread_id; |
4be44fcd | 266 | } else { |
b8e4d893 | 267 | ACPI_EXCEPTION((AE_INFO, status, |
28eb3fcf LM |
268 | "Thread %u could not acquire Mutex [0x%X]", |
269 | (u32)this_thread_id, mutex_id)); | |
73459f73 RM |
270 | } |
271 | ||
272 | return (status); | |
273 | } | |
274 | ||
73459f73 RM |
275 | /******************************************************************************* |
276 | * | |
277 | * FUNCTION: acpi_ut_release_mutex | |
278 | * | |
279 | * PARAMETERS: mutex_iD - ID of the mutex to be released | |
280 | * | |
281 | * RETURN: Status | |
282 | * | |
283 | * DESCRIPTION: Release a mutex object. | |
284 | * | |
285 | ******************************************************************************/ | |
286 | ||
4be44fcd | 287 | acpi_status acpi_ut_release_mutex(acpi_mutex_handle mutex_id) |
73459f73 | 288 | { |
28eb3fcf LM |
289 | acpi_thread_id this_thread_id; |
290 | ||
b229cf92 | 291 | ACPI_FUNCTION_NAME(ut_release_mutex); |
73459f73 | 292 | |
28eb3fcf LM |
293 | this_thread_id = acpi_os_get_thread_id(); |
294 | ||
295 | ACPI_DEBUG_PRINT((ACPI_DB_MUTEX, "Thread %u releasing Mutex [%s]\n", | |
296 | (u32)this_thread_id, | |
4be44fcd | 297 | acpi_ut_get_mutex_name(mutex_id))); |
73459f73 | 298 | |
4c90ece2 | 299 | if (mutex_id > ACPI_MAX_MUTEX) { |
73459f73 RM |
300 | return (AE_BAD_PARAMETER); |
301 | } | |
302 | ||
303 | /* | |
304 | * Mutex must be acquired in order to release it! | |
305 | */ | |
f9f4601f | 306 | if (acpi_gbl_mutex_info[mutex_id].thread_id == ACPI_MUTEX_NOT_ACQUIRED) { |
b8e4d893 | 307 | ACPI_ERROR((AE_INFO, |
f6a22b0b | 308 | "Mutex [0x%X] is not acquired, cannot release", |
b8e4d893 | 309 | mutex_id)); |
73459f73 RM |
310 | |
311 | return (AE_NOT_ACQUIRED); | |
312 | } | |
73459f73 RM |
313 | #ifdef ACPI_MUTEX_DEBUG |
314 | { | |
4be44fcd | 315 | u32 i; |
73459f73 RM |
316 | /* |
317 | * Mutex debug code, for internal debugging only. | |
318 | * | |
319 | * Deadlock prevention. Check if this thread owns any mutexes of value | |
320 | * greater than this one. If so, the thread has violated the mutex | |
321 | * ordering rule. This indicates a coding error somewhere in | |
322 | * the ACPI subsystem code. | |
323 | */ | |
b53ce3f7 | 324 | for (i = mutex_id; i < ACPI_NUM_MUTEX; i++) { |
bda663d3 | 325 | if (acpi_gbl_mutex_info[i].thread_id == this_thread_id) { |
73459f73 RM |
326 | if (i == mutex_id) { |
327 | continue; | |
328 | } | |
329 | ||
b8e4d893 BM |
330 | ACPI_ERROR((AE_INFO, |
331 | "Invalid release order: owns [%s], releasing [%s]", | |
332 | acpi_ut_get_mutex_name(i), | |
333 | acpi_ut_get_mutex_name(mutex_id))); | |
73459f73 RM |
334 | |
335 | return (AE_RELEASE_DEADLOCK); | |
336 | } | |
337 | } | |
338 | } | |
339 | #endif | |
340 | ||
341 | /* Mark unlocked FIRST */ | |
342 | ||
f9f4601f | 343 | acpi_gbl_mutex_info[mutex_id].thread_id = ACPI_MUTEX_NOT_ACQUIRED; |
73459f73 | 344 | |
967440e3 BM |
345 | acpi_os_release_mutex(acpi_gbl_mutex_info[mutex_id].mutex); |
346 | return (AE_OK); | |
73459f73 | 347 | } |