2 /******************************************************************************
4 * Module Name: exmutex - ASL Mutex Acquire/Release functions
6 *****************************************************************************/
9 * Copyright (C) 2000 - 2004, R. Byron Moore
10 * All rights reserved.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions, and the following disclaimer,
17 * without modification.
18 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
19 * substantially similar to the "NO WARRANTY" disclaimer below
20 * ("Disclaimer") and any redistribution must be conditioned upon
21 * including a substantially similar Disclaimer requirement for further
22 * binary redistribution.
23 * 3. Neither the names of the above-listed copyright holders nor the names
24 * of any contributors may be used to endorse or promote products derived
25 * from this software without specific prior written permission.
27 * Alternatively, this software may be distributed under the terms of the
28 * GNU General Public License ("GPL") version 2 as published by the Free
29 * Software Foundation.
32 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
33 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
34 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
35 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
36 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
37 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
38 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
39 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
40 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
41 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
42 * POSSIBILITY OF SUCH DAMAGES.
46 #include <acpi/acpi.h>
47 #include <acpi/acinterp.h>
49 #define _COMPONENT ACPI_EXECUTER
50 ACPI_MODULE_NAME ("exmutex")
53 /*******************************************************************************
55 * FUNCTION: acpi_ex_unlink_mutex
57 * PARAMETERS: *obj_desc - The mutex to be unlinked
61 * DESCRIPTION: Remove a mutex from the "acquired_mutex" list
63 ******************************************************************************/
66 acpi_ex_unlink_mutex (
67 union acpi_operand_object
*obj_desc
)
69 struct acpi_thread_state
*thread
= obj_desc
->mutex
.owner_thread
;
76 if (obj_desc
->mutex
.next
) {
77 (obj_desc
->mutex
.next
)->mutex
.prev
= obj_desc
->mutex
.prev
;
80 if (obj_desc
->mutex
.prev
) {
81 (obj_desc
->mutex
.prev
)->mutex
.next
= obj_desc
->mutex
.next
;
84 thread
->acquired_mutex_list
= obj_desc
->mutex
.next
;
89 /*******************************************************************************
91 * FUNCTION: acpi_ex_link_mutex
93 * PARAMETERS: *obj_desc - The mutex to be linked
94 * *list_head - head of the "acquired_mutex" list
98 * DESCRIPTION: Add a mutex to the "acquired_mutex" list for this walk
100 ******************************************************************************/
104 union acpi_operand_object
*obj_desc
,
105 struct acpi_thread_state
*thread
)
107 union acpi_operand_object
*list_head
;
110 list_head
= thread
->acquired_mutex_list
;
112 /* This object will be the first object in the list */
114 obj_desc
->mutex
.prev
= NULL
;
115 obj_desc
->mutex
.next
= list_head
;
117 /* Update old first object to point back to this object */
120 list_head
->mutex
.prev
= obj_desc
;
123 /* Update list head */
125 thread
->acquired_mutex_list
= obj_desc
;
129 /*******************************************************************************
131 * FUNCTION: acpi_ex_acquire_mutex
133 * PARAMETERS: *time_desc - The 'time to delay' object descriptor
134 * *obj_desc - The object descriptor for this op
138 * DESCRIPTION: Acquire an AML mutex
140 ******************************************************************************/
143 acpi_ex_acquire_mutex (
144 union acpi_operand_object
*time_desc
,
145 union acpi_operand_object
*obj_desc
,
146 struct acpi_walk_state
*walk_state
)
151 ACPI_FUNCTION_TRACE_PTR ("ex_acquire_mutex", obj_desc
);
155 return_ACPI_STATUS (AE_BAD_PARAMETER
);
158 /* Sanity check -- we must have a valid thread ID */
160 if (!walk_state
->thread
) {
161 ACPI_REPORT_ERROR (("Cannot acquire Mutex [%4.4s], null thread info\n",
162 acpi_ut_get_node_name (obj_desc
->mutex
.node
)));
163 return_ACPI_STATUS (AE_AML_INTERNAL
);
167 * Current Sync must be less than or equal to the sync level of the
168 * mutex. This mechanism provides some deadlock prevention
170 if (walk_state
->thread
->current_sync_level
> obj_desc
->mutex
.sync_level
) {
171 ACPI_REPORT_ERROR (("Cannot acquire Mutex [%4.4s], incorrect sync_level\n",
172 acpi_ut_get_node_name (obj_desc
->mutex
.node
)));
173 return_ACPI_STATUS (AE_AML_MUTEX_ORDER
);
177 * Support for multiple acquires by the owning thread
179 if (obj_desc
->mutex
.owner_thread
) {
180 /* Special case for Global Lock, allow all threads */
182 if ((obj_desc
->mutex
.owner_thread
->thread_id
== walk_state
->thread
->thread_id
) ||
183 (obj_desc
->mutex
.semaphore
== acpi_gbl_global_lock_semaphore
)) {
185 * The mutex is already owned by this thread,
186 * just increment the acquisition depth
188 obj_desc
->mutex
.acquisition_depth
++;
189 return_ACPI_STATUS (AE_OK
);
193 /* Acquire the mutex, wait if necessary */
195 status
= acpi_ex_system_acquire_mutex (time_desc
, obj_desc
);
196 if (ACPI_FAILURE (status
)) {
197 /* Includes failure from a timeout on time_desc */
199 return_ACPI_STATUS (status
);
202 /* Have the mutex, update mutex and walk info */
204 obj_desc
->mutex
.owner_thread
= walk_state
->thread
;
205 obj_desc
->mutex
.acquisition_depth
= 1;
207 walk_state
->thread
->current_sync_level
= obj_desc
->mutex
.sync_level
;
209 /* Link the mutex to the current thread for force-unlock at method exit */
211 acpi_ex_link_mutex (obj_desc
, walk_state
->thread
);
213 return_ACPI_STATUS (AE_OK
);
217 /*******************************************************************************
219 * FUNCTION: acpi_ex_release_mutex
221 * PARAMETERS: *obj_desc - The object descriptor for this op
225 * DESCRIPTION: Release a previously acquired Mutex.
227 ******************************************************************************/
230 acpi_ex_release_mutex (
231 union acpi_operand_object
*obj_desc
,
232 struct acpi_walk_state
*walk_state
)
237 ACPI_FUNCTION_TRACE ("ex_release_mutex");
241 return_ACPI_STATUS (AE_BAD_PARAMETER
);
244 /* The mutex must have been previously acquired in order to release it */
246 if (!obj_desc
->mutex
.owner_thread
) {
247 ACPI_REPORT_ERROR (("Cannot release Mutex [%4.4s], not acquired\n",
248 acpi_ut_get_node_name (obj_desc
->mutex
.node
)));
249 return_ACPI_STATUS (AE_AML_MUTEX_NOT_ACQUIRED
);
252 /* Sanity check -- we must have a valid thread ID */
254 if (!walk_state
->thread
) {
255 ACPI_REPORT_ERROR (("Cannot release Mutex [%4.4s], null thread info\n",
256 acpi_ut_get_node_name (obj_desc
->mutex
.node
)));
257 return_ACPI_STATUS (AE_AML_INTERNAL
);
261 * The Mutex is owned, but this thread must be the owner.
262 * Special case for Global Lock, any thread can release
264 if ((obj_desc
->mutex
.owner_thread
->thread_id
!= walk_state
->thread
->thread_id
) &&
265 (obj_desc
->mutex
.semaphore
!= acpi_gbl_global_lock_semaphore
)) {
267 "Thread %X cannot release Mutex [%4.4s] acquired by thread %X\n",
268 walk_state
->thread
->thread_id
,
269 acpi_ut_get_node_name (obj_desc
->mutex
.node
),
270 obj_desc
->mutex
.owner_thread
->thread_id
));
271 return_ACPI_STATUS (AE_AML_NOT_OWNER
);
275 * The sync level of the mutex must be less than or
276 * equal to the current sync level
278 if (obj_desc
->mutex
.sync_level
> walk_state
->thread
->current_sync_level
) {
279 ACPI_REPORT_ERROR (("Cannot release Mutex [%4.4s], incorrect sync_level\n",
280 acpi_ut_get_node_name (obj_desc
->mutex
.node
)));
281 return_ACPI_STATUS (AE_AML_MUTEX_ORDER
);
285 * Match multiple Acquires with multiple Releases
287 obj_desc
->mutex
.acquisition_depth
--;
288 if (obj_desc
->mutex
.acquisition_depth
!= 0) {
289 /* Just decrement the depth and return */
291 return_ACPI_STATUS (AE_OK
);
294 /* Unlink the mutex from the owner's list */
296 acpi_ex_unlink_mutex (obj_desc
);
298 /* Release the mutex */
300 status
= acpi_ex_system_release_mutex (obj_desc
);
302 /* Update the mutex and walk state */
304 obj_desc
->mutex
.owner_thread
= NULL
;
305 walk_state
->thread
->current_sync_level
= obj_desc
->mutex
.sync_level
;
307 return_ACPI_STATUS (status
);
311 /*******************************************************************************
313 * FUNCTION: acpi_ex_release_all_mutexes
315 * PARAMETERS: *mutex_list - Head of the mutex list
319 * DESCRIPTION: Release all mutexes in the list
321 ******************************************************************************/
324 acpi_ex_release_all_mutexes (
325 struct acpi_thread_state
*thread
)
327 union acpi_operand_object
*next
= thread
->acquired_mutex_list
;
328 union acpi_operand_object
*this;
332 ACPI_FUNCTION_ENTRY ();
336 * Traverse the list of owned mutexes, releasing each one.
340 next
= this->mutex
.next
;
342 this->mutex
.acquisition_depth
= 1;
343 this->mutex
.prev
= NULL
;
344 this->mutex
.next
= NULL
;
346 /* Release the mutex */
348 status
= acpi_ex_system_release_mutex (this);
349 if (ACPI_FAILURE (status
)) {
353 /* Mark mutex unowned */
355 this->mutex
.owner_thread
= NULL
;