2 /******************************************************************************
4 * Module Name: exmutex - ASL Mutex Acquire/Release functions
7 *****************************************************************************/
9 /******************************************************************************
13 * Some or all of this work - Copyright (c) 1999 - 2005, Intel Corp.
14 * All rights reserved.
18 * 2.1. This is your license from Intel Corp. under its intellectual property
19 * rights. You may have additional license terms from the party that provided
20 * you this software, covering your right to use that party's intellectual
23 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
24 * copy of the source code appearing in this file ("Covered Code") an
25 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
26 * base code distributed originally by Intel ("Original Intel Code") to copy,
27 * make derivatives, distribute, use and display any portion of the Covered
28 * Code in any form, with the right to sublicense such rights; and
30 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
31 * license (with the right to sublicense), under only those claims of Intel
32 * patents that are infringed by the Original Intel Code, to make, use, sell,
33 * offer to sell, and import the Covered Code and derivative works thereof
34 * solely to the minimum extent necessary to exercise the above copyright
35 * license, and in no event shall the patent license extend to any additions
36 * to or modifications of the Original Intel Code. No other license or right
37 * is granted directly or by implication, estoppel or otherwise;
39 * The above copyright and patent license is granted only if the following
44 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
45 * Redistribution of source code of any substantial portion of the Covered
46 * Code or modification with rights to further distribute source must include
47 * the above Copyright Notice, the above License, this list of Conditions,
48 * and the following Disclaimer and Export Compliance provision. In addition,
49 * Licensee must cause all Covered Code to which Licensee contributes to
50 * contain a file documenting the changes Licensee made to create that Covered
51 * Code and the date of any change. Licensee must include in that file the
52 * documentation of any changes made by any predecessor Licensee. Licensee
53 * must include a prominent statement that the modification is derived,
54 * directly or indirectly, from Original Intel Code.
56 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
57 * Redistribution of source code of any substantial portion of the Covered
58 * Code or modification without rights to further distribute source must
59 * include the following Disclaimer and Export Compliance provision in the
60 * documentation and/or other materials provided with distribution. In
61 * addition, Licensee may not authorize further sublicense of source of any
62 * portion of the Covered Code, and must include terms to the effect that the
63 * license from Licensee to its licensee is limited to the intellectual
64 * property embodied in the software Licensee provides to its licensee, and
65 * not to intellectual property embodied in modifications its licensee may
68 * 3.3. Redistribution of Executable. Redistribution in executable form of any
69 * substantial portion of the Covered Code or modification must reproduce the
70 * above Copyright Notice, and the following Disclaimer and Export Compliance
71 * provision in the documentation and/or other materials provided with the
74 * 3.4. Intel retains all right, title, and interest in and to the Original
77 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
78 * Intel shall be used in advertising or otherwise to promote the sale, use or
79 * other dealings in products derived from or relating to the Covered Code
80 * without prior written authorization from Intel.
82 * 4. Disclaimer and Export Compliance
84 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
85 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
86 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
87 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
88 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
89 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
92 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
93 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
94 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
95 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
96 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
97 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
98 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
101 * 4.3. Licensee shall not export, either directly or indirectly, any of this
102 * software or system incorporating such software without first obtaining any
103 * required license or other approval from the U. S. Department of Commerce or
104 * any other agency or department of the United States Government. In the
105 * event Licensee exports any such software from the United States or
106 * re-exports any such software from a foreign destination, Licensee shall
107 * ensure that the distribution and export/re-export of the software is in
108 * compliance with all laws, regulations, orders, or other restrictions of the
109 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
110 * any of its subsidiaries will export/re-export any technical data, process,
111 * software, or service, directly or indirectly, to any country for which the
112 * United States government or any agency thereof requires an export license,
113 * other governmental approval, or letter of assurance, without first obtaining
114 * such license, approval or letter.
116 *****************************************************************************/
118 #define __EXMUTEX_C__
120 #include <contrib/dev/acpica/acpi.h>
121 #include <contrib/dev/acpica/acinterp.h>
123 #define _COMPONENT ACPI_EXECUTER
124 ACPI_MODULE_NAME ("exmutex")
126 /* Local prototypes */
130 ACPI_OPERAND_OBJECT *ObjDesc,
131 ACPI_THREAD_STATE *Thread);
134 /*******************************************************************************
136 * FUNCTION: AcpiExUnlinkMutex
138 * PARAMETERS: ObjDesc - The mutex to be unlinked
142 * DESCRIPTION: Remove a mutex from the "AcquiredMutex" list
144 ******************************************************************************/
148 ACPI_OPERAND_OBJECT *ObjDesc)
150 ACPI_THREAD_STATE *Thread = ObjDesc->Mutex.OwnerThread;
158 /* Doubly linked list */
160 if (ObjDesc->Mutex.Next)
162 (ObjDesc->Mutex.Next)->Mutex.Prev = ObjDesc->Mutex.Prev;
165 if (ObjDesc->Mutex.Prev)
167 (ObjDesc->Mutex.Prev)->Mutex.Next = ObjDesc->Mutex.Next;
171 Thread->AcquiredMutexList = ObjDesc->Mutex.Next;
176 /*******************************************************************************
178 * FUNCTION: AcpiExLinkMutex
180 * PARAMETERS: ObjDesc - The mutex to be linked
181 * Thread - Current executing thread object
185 * DESCRIPTION: Add a mutex to the "AcquiredMutex" list for this walk
187 ******************************************************************************/
191 ACPI_OPERAND_OBJECT *ObjDesc,
192 ACPI_THREAD_STATE *Thread)
194 ACPI_OPERAND_OBJECT *ListHead;
197 ListHead = Thread->AcquiredMutexList;
199 /* This object will be the first object in the list */
201 ObjDesc->Mutex.Prev = NULL;
202 ObjDesc->Mutex.Next = ListHead;
204 /* Update old first object to point back to this object */
208 ListHead->Mutex.Prev = ObjDesc;
211 /* Update list head */
213 Thread->AcquiredMutexList = ObjDesc;
217 /*******************************************************************************
219 * FUNCTION: AcpiExAcquireMutex
221 * PARAMETERS: TimeDesc - Timeout integer
222 * ObjDesc - Mutex object
223 * WalkState - Current method execution state
227 * DESCRIPTION: Acquire an AML mutex
229 ******************************************************************************/
233 ACPI_OPERAND_OBJECT *TimeDesc,
234 ACPI_OPERAND_OBJECT *ObjDesc,
235 ACPI_WALK_STATE *WalkState)
240 ACPI_FUNCTION_TRACE_PTR ("ExAcquireMutex", ObjDesc);
245 return_ACPI_STATUS (AE_BAD_PARAMETER);
248 /* Sanity check -- we must have a valid thread ID */
250 if (!WalkState->Thread)
252 ACPI_REPORT_ERROR (("Cannot acquire Mutex [%4.4s], null thread info\n",
253 AcpiUtGetNodeName (ObjDesc->Mutex.Node)));
254 return_ACPI_STATUS (AE_AML_INTERNAL);
258 * Current Sync must be less than or equal to the sync level of the
259 * mutex. This mechanism provides some deadlock prevention
261 if (WalkState->Thread->CurrentSyncLevel > ObjDesc->Mutex.SyncLevel)
264 "Cannot acquire Mutex [%4.4s], incorrect SyncLevel\n",
265 AcpiUtGetNodeName (ObjDesc->Mutex.Node)));
266 return_ACPI_STATUS (AE_AML_MUTEX_ORDER);
269 /* Support for multiple acquires by the owning thread */
271 if (ObjDesc->Mutex.OwnerThread)
273 /* Special case for Global Lock, allow all threads */
275 if ((ObjDesc->Mutex.OwnerThread->ThreadId ==
276 WalkState->Thread->ThreadId) ||
277 (ObjDesc->Mutex.Semaphore ==
278 AcpiGbl_GlobalLockSemaphore))
281 * The mutex is already owned by this thread,
282 * just increment the acquisition depth
284 ObjDesc->Mutex.AcquisitionDepth++;
285 return_ACPI_STATUS (AE_OK);
289 /* Acquire the mutex, wait if necessary */
291 Status = AcpiExSystemAcquireMutex (TimeDesc, ObjDesc);
292 if (ACPI_FAILURE (Status))
294 /* Includes failure from a timeout on TimeDesc */
296 return_ACPI_STATUS (Status);
299 /* Have the mutex: update mutex and walk info and save the SyncLevel */
301 ObjDesc->Mutex.OwnerThread = WalkState->Thread;
302 ObjDesc->Mutex.AcquisitionDepth = 1;
303 ObjDesc->Mutex.OriginalSyncLevel = WalkState->Thread->CurrentSyncLevel;
305 WalkState->Thread->CurrentSyncLevel = ObjDesc->Mutex.SyncLevel;
307 /* Link the mutex to the current thread for force-unlock at method exit */
309 AcpiExLinkMutex (ObjDesc, WalkState->Thread);
311 return_ACPI_STATUS (AE_OK);
315 /*******************************************************************************
317 * FUNCTION: AcpiExReleaseMutex
319 * PARAMETERS: ObjDesc - The object descriptor for this op
320 * WalkState - Current method execution state
324 * DESCRIPTION: Release a previously acquired Mutex.
326 ******************************************************************************/
330 ACPI_OPERAND_OBJECT *ObjDesc,
331 ACPI_WALK_STATE *WalkState)
336 ACPI_FUNCTION_TRACE ("ExReleaseMutex");
341 return_ACPI_STATUS (AE_BAD_PARAMETER);
344 /* The mutex must have been previously acquired in order to release it */
346 if (!ObjDesc->Mutex.OwnerThread)
348 ACPI_REPORT_ERROR (("Cannot release Mutex [%4.4s], not acquired\n",
349 AcpiUtGetNodeName (ObjDesc->Mutex.Node)));
350 return_ACPI_STATUS (AE_AML_MUTEX_NOT_ACQUIRED);
353 /* Sanity check -- we must have a valid thread ID */
355 if (!WalkState->Thread)
357 ACPI_REPORT_ERROR (("Cannot release Mutex [%4.4s], null thread info\n",
358 AcpiUtGetNodeName (ObjDesc->Mutex.Node)));
359 return_ACPI_STATUS (AE_AML_INTERNAL);
363 * The Mutex is owned, but this thread must be the owner.
364 * Special case for Global Lock, any thread can release
366 if ((ObjDesc->Mutex.OwnerThread->ThreadId != WalkState->Thread->ThreadId) &&
367 (ObjDesc->Mutex.Semaphore != AcpiGbl_GlobalLockSemaphore))
370 "Thread %X cannot release Mutex [%4.4s] acquired by thread %X\n",
371 WalkState->Thread->ThreadId,
372 AcpiUtGetNodeName (ObjDesc->Mutex.Node),
373 ObjDesc->Mutex.OwnerThread->ThreadId));
374 return_ACPI_STATUS (AE_AML_NOT_OWNER);
378 * The sync level of the mutex must be less than or
379 * equal to the current sync level
381 if (ObjDesc->Mutex.SyncLevel > WalkState->Thread->CurrentSyncLevel)
384 "Cannot release Mutex [%4.4s], incorrect SyncLevel\n",
385 AcpiUtGetNodeName (ObjDesc->Mutex.Node)));
386 return_ACPI_STATUS (AE_AML_MUTEX_ORDER);
389 /* Match multiple Acquires with multiple Releases */
391 ObjDesc->Mutex.AcquisitionDepth--;
392 if (ObjDesc->Mutex.AcquisitionDepth != 0)
394 /* Just decrement the depth and return */
396 return_ACPI_STATUS (AE_OK);
399 /* Unlink the mutex from the owner's list */
401 AcpiExUnlinkMutex (ObjDesc);
403 /* Release the mutex */
405 Status = AcpiExSystemReleaseMutex (ObjDesc);
407 /* Update the mutex and walk state, restore SyncLevel before acquire */
409 ObjDesc->Mutex.OwnerThread = NULL;
410 WalkState->Thread->CurrentSyncLevel = ObjDesc->Mutex.OriginalSyncLevel;
412 return_ACPI_STATUS (Status);
416 /*******************************************************************************
418 * FUNCTION: AcpiExReleaseAllMutexes
420 * PARAMETERS: Thread - Current executing thread object
424 * DESCRIPTION: Release all mutexes held by this thread
426 ******************************************************************************/
429 AcpiExReleaseAllMutexes (
430 ACPI_THREAD_STATE *Thread)
432 ACPI_OPERAND_OBJECT *Next = Thread->AcquiredMutexList;
433 ACPI_OPERAND_OBJECT *This;
437 ACPI_FUNCTION_ENTRY ();
440 /* Traverse the list of owned mutexes, releasing each one */
445 Next = This->Mutex.Next;
447 This->Mutex.AcquisitionDepth = 1;
448 This->Mutex.Prev = NULL;
449 This->Mutex.Next = NULL;
451 /* Release the mutex */
453 Status = AcpiExSystemReleaseMutex (This);
454 if (ACPI_FAILURE (Status))
459 /* Mark mutex unowned */
461 This->Mutex.OwnerThread = NULL;
463 /* Update Thread SyncLevel (Last mutex is the important one) */
465 Thread->CurrentSyncLevel = This->Mutex.OriginalSyncLevel;