1 /*******************************************************************************
3 * Module Name: utmutex - local mutex support
5 ******************************************************************************/
8 * Copyright (C) 2000 - 2010, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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.
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.
44 #include <acpi/acpi.h>
47 #define _COMPONENT ACPI_UTILITIES
48 ACPI_MODULE_NAME("utmutex")
50 /* Local prototypes */
51 static acpi_status acpi_ut_create_mutex(acpi_mutex_handle mutex_id);
53 static void acpi_ut_delete_mutex(acpi_mutex_handle mutex_id);
55 /*******************************************************************************
57 * FUNCTION: acpi_ut_mutex_initialize
63 * DESCRIPTION: Create the system mutex objects. This includes mutexes,
64 * spin locks, and reader/writer locks.
66 ******************************************************************************/
68 acpi_status acpi_ut_mutex_initialize(void)
73 ACPI_FUNCTION_TRACE(ut_mutex_initialize);
75 /* Create each of the predefined mutex objects */
77 for (i = 0; i < ACPI_NUM_MUTEX; i++) {
78 status = acpi_ut_create_mutex(i);
79 if (ACPI_FAILURE(status)) {
80 return_ACPI_STATUS(status);
84 /* Create the spinlocks for use at interrupt level */
86 spin_lock_init(acpi_gbl_gpe_lock);
87 spin_lock_init(acpi_gbl_hardware_lock);
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);
95 /* Create the reader/writer lock for namespace access */
97 status = acpi_ut_create_rw_lock(&acpi_gbl_namespace_rw_lock);
98 return_ACPI_STATUS(status);
101 /*******************************************************************************
103 * FUNCTION: acpi_ut_mutex_terminate
109 * DESCRIPTION: Delete all of the system mutex objects. This includes mutexes,
110 * spin locks, and reader/writer locks.
112 ******************************************************************************/
114 void acpi_ut_mutex_terminate(void)
118 ACPI_FUNCTION_TRACE(ut_mutex_terminate);
120 /* Delete each predefined mutex object */
122 for (i = 0; i < ACPI_NUM_MUTEX; i++) {
123 acpi_ut_delete_mutex(i);
126 acpi_os_delete_mutex(acpi_gbl_osi_mutex);
128 /* Delete the spinlocks */
130 acpi_os_delete_lock(acpi_gbl_gpe_lock);
131 acpi_os_delete_lock(acpi_gbl_hardware_lock);
133 /* Delete the reader/writer lock */
135 acpi_ut_delete_rw_lock(&acpi_gbl_namespace_rw_lock);
139 /*******************************************************************************
141 * FUNCTION: acpi_ut_create_mutex
143 * PARAMETERS: mutex_iD - ID of the mutex to be created
147 * DESCRIPTION: Create a mutex object.
149 ******************************************************************************/
151 static acpi_status acpi_ut_create_mutex(acpi_mutex_handle mutex_id)
153 acpi_status status = AE_OK;
155 ACPI_FUNCTION_TRACE_U32(ut_create_mutex, mutex_id);
157 if (!acpi_gbl_mutex_info[mutex_id].mutex) {
159 acpi_os_create_mutex(&acpi_gbl_mutex_info[mutex_id].mutex);
160 acpi_gbl_mutex_info[mutex_id].thread_id =
161 ACPI_MUTEX_NOT_ACQUIRED;
162 acpi_gbl_mutex_info[mutex_id].use_count = 0;
165 return_ACPI_STATUS(status);
168 /*******************************************************************************
170 * FUNCTION: acpi_ut_delete_mutex
172 * PARAMETERS: mutex_iD - ID of the mutex to be deleted
176 * DESCRIPTION: Delete a mutex object.
178 ******************************************************************************/
180 static void acpi_ut_delete_mutex(acpi_mutex_handle mutex_id)
183 ACPI_FUNCTION_TRACE_U32(ut_delete_mutex, mutex_id);
185 acpi_os_delete_mutex(acpi_gbl_mutex_info[mutex_id].mutex);
187 acpi_gbl_mutex_info[mutex_id].mutex = NULL;
188 acpi_gbl_mutex_info[mutex_id].thread_id = ACPI_MUTEX_NOT_ACQUIRED;
191 /*******************************************************************************
193 * FUNCTION: acpi_ut_acquire_mutex
195 * PARAMETERS: mutex_iD - ID of the mutex to be acquired
199 * DESCRIPTION: Acquire a mutex object.
201 ******************************************************************************/
203 acpi_status acpi_ut_acquire_mutex(acpi_mutex_handle mutex_id)
206 acpi_thread_id this_thread_id;
208 ACPI_FUNCTION_NAME(ut_acquire_mutex);
210 if (mutex_id > ACPI_MAX_MUTEX) {
211 return (AE_BAD_PARAMETER);
214 this_thread_id = acpi_os_get_thread_id();
216 #ifdef ACPI_MUTEX_DEBUG
220 * Mutex debug code, for internal debugging only.
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.
227 for (i = mutex_id; i < ACPI_NUM_MUTEX; i++) {
228 if (acpi_gbl_mutex_info[i].thread_id == this_thread_id) {
231 "Mutex [%s] already acquired by this thread [%u]",
232 acpi_ut_get_mutex_name
234 (u32)this_thread_id));
236 return (AE_ALREADY_ACQUIRED);
240 "Invalid acquire order: Thread %u owns [%s], wants [%s]",
242 acpi_ut_get_mutex_name(i),
243 acpi_ut_get_mutex_name(mutex_id)));
245 return (AE_ACQUIRE_DEADLOCK);
251 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX,
252 "Thread %u attempting to acquire Mutex [%s]\n",
254 acpi_ut_get_mutex_name(mutex_id)));
256 status = acpi_os_acquire_mutex(acpi_gbl_mutex_info[mutex_id].mutex,
258 if (ACPI_SUCCESS(status)) {
259 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX,
260 "Thread %u acquired Mutex [%s]\n",
262 acpi_ut_get_mutex_name(mutex_id)));
264 acpi_gbl_mutex_info[mutex_id].use_count++;
265 acpi_gbl_mutex_info[mutex_id].thread_id = this_thread_id;
267 ACPI_EXCEPTION((AE_INFO, status,
268 "Thread %u could not acquire Mutex [0x%X]",
269 (u32)this_thread_id, mutex_id));
275 /*******************************************************************************
277 * FUNCTION: acpi_ut_release_mutex
279 * PARAMETERS: mutex_iD - ID of the mutex to be released
283 * DESCRIPTION: Release a mutex object.
285 ******************************************************************************/
287 acpi_status acpi_ut_release_mutex(acpi_mutex_handle mutex_id)
289 acpi_thread_id this_thread_id;
291 ACPI_FUNCTION_NAME(ut_release_mutex);
293 this_thread_id = acpi_os_get_thread_id();
295 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX, "Thread %u releasing Mutex [%s]\n",
297 acpi_ut_get_mutex_name(mutex_id)));
299 if (mutex_id > ACPI_MAX_MUTEX) {
300 return (AE_BAD_PARAMETER);
304 * Mutex must be acquired in order to release it!
306 if (acpi_gbl_mutex_info[mutex_id].thread_id == ACPI_MUTEX_NOT_ACQUIRED) {
308 "Mutex [0x%X] is not acquired, cannot release",
311 return (AE_NOT_ACQUIRED);
313 #ifdef ACPI_MUTEX_DEBUG
317 * Mutex debug code, for internal debugging only.
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.
324 for (i = mutex_id; i < ACPI_NUM_MUTEX; i++) {
325 if (acpi_gbl_mutex_info[i].thread_id == this_thread_id) {
331 "Invalid release order: owns [%s], releasing [%s]",
332 acpi_ut_get_mutex_name(i),
333 acpi_ut_get_mutex_name(mutex_id)));
335 return (AE_RELEASE_DEADLOCK);
341 /* Mark unlocked FIRST */
343 acpi_gbl_mutex_info[mutex_id].thread_id = ACPI_MUTEX_NOT_ACQUIRED;
345 acpi_os_release_mutex(acpi_gbl_mutex_info[mutex_id].mutex);