1 /*******************************************************************************
3 * Module Name: utmutex - local mutex support
5 ******************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2018, Intel Corp.
12 * All rights reserved.
16 * 2.1. This is your license from Intel Corp. under its intellectual property
17 * rights. You may have additional license terms from the party that provided
18 * you this software, covering your right to use that party's intellectual
21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22 * copy of the source code appearing in this file ("Covered Code") an
23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24 * base code distributed originally by Intel ("Original Intel Code") to copy,
25 * make derivatives, distribute, use and display any portion of the Covered
26 * Code in any form, with the right to sublicense such rights; and
28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29 * license (with the right to sublicense), under only those claims of Intel
30 * patents that are infringed by the Original Intel Code, to make, use, sell,
31 * offer to sell, and import the Covered Code and derivative works thereof
32 * solely to the minimum extent necessary to exercise the above copyright
33 * license, and in no event shall the patent license extend to any additions
34 * to or modifications of the Original Intel Code. No other license or right
35 * is granted directly or by implication, estoppel or otherwise;
37 * The above copyright and patent license is granted only if the following
42 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43 * Redistribution of source code of any substantial portion of the Covered
44 * Code or modification with rights to further distribute source must include
45 * the above Copyright Notice, the above License, this list of Conditions,
46 * and the following Disclaimer and Export Compliance provision. In addition,
47 * Licensee must cause all Covered Code to which Licensee contributes to
48 * contain a file documenting the changes Licensee made to create that Covered
49 * Code and the date of any change. Licensee must include in that file the
50 * documentation of any changes made by any predecessor Licensee. Licensee
51 * must include a prominent statement that the modification is derived,
52 * directly or indirectly, from Original Intel Code.
54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55 * Redistribution of source code of any substantial portion of the Covered
56 * Code or modification without rights to further distribute source must
57 * include the following Disclaimer and Export Compliance provision in the
58 * documentation and/or other materials provided with distribution. In
59 * addition, Licensee may not authorize further sublicense of source of any
60 * portion of the Covered Code, and must include terms to the effect that the
61 * license from Licensee to its licensee is limited to the intellectual
62 * property embodied in the software Licensee provides to its licensee, and
63 * not to intellectual property embodied in modifications its licensee may
66 * 3.3. Redistribution of Executable. Redistribution in executable form of any
67 * substantial portion of the Covered Code or modification must reproduce the
68 * above Copyright Notice, and the following Disclaimer and Export Compliance
69 * provision in the documentation and/or other materials provided with the
72 * 3.4. Intel retains all right, title, and interest in and to the Original
75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76 * Intel shall be used in advertising or otherwise to promote the sale, use or
77 * other dealings in products derived from or relating to the Covered Code
78 * without prior written authorization from Intel.
80 * 4. Disclaimer and Export Compliance
82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
99 * 4.3. Licensee shall not export, either directly or indirectly, any of this
100 * software or system incorporating such software without first obtaining any
101 * required license or other approval from the U. S. Department of Commerce or
102 * any other agency or department of the United States Government. In the
103 * event Licensee exports any such software from the United States or
104 * re-exports any such software from a foreign destination, Licensee shall
105 * ensure that the distribution and export/re-export of the software is in
106 * compliance with all laws, regulations, orders, or other restrictions of the
107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108 * any of its subsidiaries will export/re-export any technical data, process,
109 * software, or service, directly or indirectly, to any country for which the
110 * United States government or any agency thereof requires an export license,
111 * other governmental approval, or letter of assurance, without first obtaining
112 * such license, approval or letter.
114 *****************************************************************************
116 * Alternatively, you may choose to be licensed under the terms of the
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
122 * 1. Redistributions of source code must retain the above copyright
123 * notice, this list of conditions, and the following disclaimer,
124 * without modification.
125 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126 * substantially similar to the "NO WARRANTY" disclaimer below
127 * ("Disclaimer") and any redistribution must be conditioned upon
128 * including a substantially similar Disclaimer requirement for further
129 * binary redistribution.
130 * 3. Neither the names of the above-listed copyright holders nor the names
131 * of any contributors may be used to endorse or promote products derived
132 * from this software without specific prior written permission.
134 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
146 * Alternatively, you may choose to be licensed under the terms of the
147 * GNU General Public License ("GPL") version 2 as published by the Free
148 * Software Foundation.
150 *****************************************************************************/
153 #include "accommon.h"
155 #define _COMPONENT ACPI_UTILITIES
156 ACPI_MODULE_NAME ("utmutex")
158 /* Local prototypes */
162 ACPI_MUTEX_HANDLE MutexId
);
166 ACPI_MUTEX_HANDLE MutexId
);
169 /*******************************************************************************
171 * FUNCTION: AcpiUtMutexInitialize
177 * DESCRIPTION: Create the system mutex objects. This includes mutexes,
178 * spin locks, and reader/writer locks.
180 ******************************************************************************/
183 AcpiUtMutexInitialize (
190 ACPI_FUNCTION_TRACE (UtMutexInitialize
);
193 /* Create each of the predefined mutex objects */
195 for (i
= 0; i
< ACPI_NUM_MUTEX
; i
++)
197 Status
= AcpiUtCreateMutex (i
);
198 if (ACPI_FAILURE (Status
))
200 return_ACPI_STATUS (Status
);
204 /* Create the spinlocks for use at interrupt level or for speed */
206 Status
= AcpiOsCreateLock (&AcpiGbl_GpeLock
);
207 if (ACPI_FAILURE (Status
))
209 return_ACPI_STATUS (Status
);
212 Status
= AcpiOsCreateLock (&AcpiGbl_HardwareLock
);
213 if (ACPI_FAILURE (Status
))
215 return_ACPI_STATUS (Status
);
218 Status
= AcpiOsCreateLock (&AcpiGbl_ReferenceCountLock
);
219 if (ACPI_FAILURE (Status
))
221 return_ACPI_STATUS (Status
);
224 /* Mutex for _OSI support */
226 Status
= AcpiOsCreateMutex (&AcpiGbl_OsiMutex
);
227 if (ACPI_FAILURE (Status
))
229 return_ACPI_STATUS (Status
);
232 /* Create the reader/writer lock for namespace access */
234 Status
= AcpiUtCreateRwLock (&AcpiGbl_NamespaceRwLock
);
235 if (ACPI_FAILURE (Status
))
237 return_ACPI_STATUS (Status
);
240 return_ACPI_STATUS (Status
);
244 /*******************************************************************************
246 * FUNCTION: AcpiUtMutexTerminate
252 * DESCRIPTION: Delete all of the system mutex objects. This includes mutexes,
253 * spin locks, and reader/writer locks.
255 ******************************************************************************/
258 AcpiUtMutexTerminate (
264 ACPI_FUNCTION_TRACE (UtMutexTerminate
);
267 /* Delete each predefined mutex object */
269 for (i
= 0; i
< ACPI_NUM_MUTEX
; i
++)
271 AcpiUtDeleteMutex (i
);
274 AcpiOsDeleteMutex (AcpiGbl_OsiMutex
);
276 /* Delete the spinlocks */
278 AcpiOsDeleteLock (AcpiGbl_GpeLock
);
279 AcpiOsDeleteLock (AcpiGbl_HardwareLock
);
280 AcpiOsDeleteLock (AcpiGbl_ReferenceCountLock
);
282 /* Delete the reader/writer lock */
284 AcpiUtDeleteRwLock (&AcpiGbl_NamespaceRwLock
);
289 /*******************************************************************************
291 * FUNCTION: AcpiUtCreateMutex
293 * PARAMETERS: MutexID - ID of the mutex to be created
297 * DESCRIPTION: Create a mutex object.
299 ******************************************************************************/
303 ACPI_MUTEX_HANDLE MutexId
)
305 ACPI_STATUS Status
= AE_OK
;
308 ACPI_FUNCTION_TRACE_U32 (UtCreateMutex
, MutexId
);
311 if (!AcpiGbl_MutexInfo
[MutexId
].Mutex
)
313 Status
= AcpiOsCreateMutex (&AcpiGbl_MutexInfo
[MutexId
].Mutex
);
314 AcpiGbl_MutexInfo
[MutexId
].ThreadId
= ACPI_MUTEX_NOT_ACQUIRED
;
315 AcpiGbl_MutexInfo
[MutexId
].UseCount
= 0;
318 return_ACPI_STATUS (Status
);
322 /*******************************************************************************
324 * FUNCTION: AcpiUtDeleteMutex
326 * PARAMETERS: MutexID - ID of the mutex to be deleted
330 * DESCRIPTION: Delete a mutex object.
332 ******************************************************************************/
336 ACPI_MUTEX_HANDLE MutexId
)
339 ACPI_FUNCTION_TRACE_U32 (UtDeleteMutex
, MutexId
);
342 AcpiOsDeleteMutex (AcpiGbl_MutexInfo
[MutexId
].Mutex
);
344 AcpiGbl_MutexInfo
[MutexId
].Mutex
= NULL
;
345 AcpiGbl_MutexInfo
[MutexId
].ThreadId
= ACPI_MUTEX_NOT_ACQUIRED
;
351 /*******************************************************************************
353 * FUNCTION: AcpiUtAcquireMutex
355 * PARAMETERS: MutexID - ID of the mutex to be acquired
359 * DESCRIPTION: Acquire a mutex object.
361 ******************************************************************************/
365 ACPI_MUTEX_HANDLE MutexId
)
368 ACPI_THREAD_ID ThisThreadId
;
371 ACPI_FUNCTION_NAME (UtAcquireMutex
);
374 if (MutexId
> ACPI_MAX_MUTEX
)
376 return (AE_BAD_PARAMETER
);
379 ThisThreadId
= AcpiOsGetThreadId ();
381 #ifdef ACPI_MUTEX_DEBUG
385 * Mutex debug code, for internal debugging only.
387 * Deadlock prevention. Check if this thread owns any mutexes of value
388 * greater than or equal to this one. If so, the thread has violated
389 * the mutex ordering rule. This indicates a coding error somewhere in
390 * the ACPI subsystem code.
392 for (i
= MutexId
; i
< ACPI_NUM_MUTEX
; i
++)
394 if (AcpiGbl_MutexInfo
[i
].ThreadId
== ThisThreadId
)
398 ACPI_ERROR ((AE_INFO
,
399 "Mutex [%s] already acquired by this thread [%u]",
400 AcpiUtGetMutexName (MutexId
),
401 (UINT32
) ThisThreadId
));
403 return (AE_ALREADY_ACQUIRED
);
406 ACPI_ERROR ((AE_INFO
,
407 "Invalid acquire order: Thread %u owns [%s], wants [%s]",
408 (UINT32
) ThisThreadId
, AcpiUtGetMutexName (i
),
409 AcpiUtGetMutexName (MutexId
)));
411 return (AE_ACQUIRE_DEADLOCK
);
417 ACPI_DEBUG_PRINT ((ACPI_DB_MUTEX
,
418 "Thread %u attempting to acquire Mutex [%s]\n",
419 (UINT32
) ThisThreadId
, AcpiUtGetMutexName (MutexId
)));
421 Status
= AcpiOsAcquireMutex (
422 AcpiGbl_MutexInfo
[MutexId
].Mutex
, ACPI_WAIT_FOREVER
);
423 if (ACPI_SUCCESS (Status
))
425 ACPI_DEBUG_PRINT ((ACPI_DB_MUTEX
,
426 "Thread %u acquired Mutex [%s]\n",
427 (UINT32
) ThisThreadId
, AcpiUtGetMutexName (MutexId
)));
429 AcpiGbl_MutexInfo
[MutexId
].UseCount
++;
430 AcpiGbl_MutexInfo
[MutexId
].ThreadId
= ThisThreadId
;
434 ACPI_EXCEPTION ((AE_INFO
, Status
,
435 "Thread %u could not acquire Mutex [%s] (0x%X)",
436 (UINT32
) ThisThreadId
, AcpiUtGetMutexName (MutexId
), MutexId
));
443 /*******************************************************************************
445 * FUNCTION: AcpiUtReleaseMutex
447 * PARAMETERS: MutexID - ID of the mutex to be released
451 * DESCRIPTION: Release a mutex object.
453 ******************************************************************************/
457 ACPI_MUTEX_HANDLE MutexId
)
459 ACPI_FUNCTION_NAME (UtReleaseMutex
);
462 ACPI_DEBUG_PRINT ((ACPI_DB_MUTEX
, "Thread %u releasing Mutex [%s]\n",
463 (UINT32
) AcpiOsGetThreadId (), AcpiUtGetMutexName (MutexId
)));
465 if (MutexId
> ACPI_MAX_MUTEX
)
467 return (AE_BAD_PARAMETER
);
471 * Mutex must be acquired in order to release it!
473 if (AcpiGbl_MutexInfo
[MutexId
].ThreadId
== ACPI_MUTEX_NOT_ACQUIRED
)
475 ACPI_ERROR ((AE_INFO
,
476 "Mutex [%s] (0x%X) is not acquired, cannot release",
477 AcpiUtGetMutexName (MutexId
), MutexId
));
479 return (AE_NOT_ACQUIRED
);
482 #ifdef ACPI_MUTEX_DEBUG
486 * Mutex debug code, for internal debugging only.
488 * Deadlock prevention. Check if this thread owns any mutexes of value
489 * greater than this one. If so, the thread has violated the mutex
490 * ordering rule. This indicates a coding error somewhere in
491 * the ACPI subsystem code.
493 for (i
= MutexId
; i
< ACPI_NUM_MUTEX
; i
++)
495 if (AcpiGbl_MutexInfo
[i
].ThreadId
== AcpiOsGetThreadId ())
502 ACPI_ERROR ((AE_INFO
,
503 "Invalid release order: owns [%s], releasing [%s]",
504 AcpiUtGetMutexName (i
), AcpiUtGetMutexName (MutexId
)));
506 return (AE_RELEASE_DEADLOCK
);
512 /* Mark unlocked FIRST */
514 AcpiGbl_MutexInfo
[MutexId
].ThreadId
= ACPI_MUTEX_NOT_ACQUIRED
;
516 AcpiOsReleaseMutex (AcpiGbl_MutexInfo
[MutexId
].Mutex
);