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