1/******************************************************************************* 2 * 3 * Module Name: utmutex - local mutex support 4 * 5 ******************************************************************************/ 6 7/****************************************************************************** 8 * 9 * 1. Copyright Notice 10 * 11 * Some or all of this work - Copyright (c) 1999 - 2016, Intel Corp. 12 * All rights reserved. 13 * 14 * 2. License 15 * 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 19 * property rights. 20 * 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 27 * 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; 36 * 37 * The above copyright and patent license is granted only if the following 38 * conditions are met: 39 * 40 * 3. Conditions 41 * 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. 53 * 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 64 * make. 65 * 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 70 * distribution. 71 * 72 * 3.4. Intel retains all right, title, and interest in and to the Original 73 * Intel Code. 74 * 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. 79 * 80 * 4. Disclaimer and Export Compliance 81 * 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 88 * PARTICULAR PURPOSE. 89 * 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 97 * LIMITED REMEDY. 98 * 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. 113 * 114 *****************************************************************************/ 115 116#include "acpi.h" 117#include "accommon.h" 118 119#define _COMPONENT ACPI_UTILITIES 120 ACPI_MODULE_NAME ("utmutex") 121 122/* Local prototypes */ 123 124static ACPI_STATUS 125AcpiUtCreateMutex ( 126 ACPI_MUTEX_HANDLE MutexId); 127 128static void 129AcpiUtDeleteMutex ( 130 ACPI_MUTEX_HANDLE MutexId); 131 132 133/******************************************************************************* 134 * 135 * FUNCTION: AcpiUtMutexInitialize 136 * 137 * PARAMETERS: None. 138 * 139 * RETURN: Status 140 * 141 * DESCRIPTION: Create the system mutex objects. This includes mutexes, 142 * spin locks, and reader/writer locks. 143 * 144 ******************************************************************************/ 145 146ACPI_STATUS 147AcpiUtMutexInitialize ( 148 void) 149{ 150 UINT32 i; 151 ACPI_STATUS Status; 152 153 154 ACPI_FUNCTION_TRACE (UtMutexInitialize); 155 156 157 /* Create each of the predefined mutex objects */ 158 159 for (i = 0; i < ACPI_NUM_MUTEX; i++) 160 { 161 Status = AcpiUtCreateMutex (i); 162 if (ACPI_FAILURE (Status)) 163 { 164 return_ACPI_STATUS (Status); 165 } 166 } 167 168 /* Create the spinlocks for use at interrupt level or for speed */ 169 170 Status = AcpiOsCreateLock (&AcpiGbl_GpeLock); 171 if (ACPI_FAILURE (Status)) 172 { 173 return_ACPI_STATUS (Status); 174 } 175 176 Status = AcpiOsCreateLock (&AcpiGbl_HardwareLock); 177 if (ACPI_FAILURE (Status)) 178 { 179 return_ACPI_STATUS (Status); 180 } 181 182 Status = AcpiOsCreateLock (&AcpiGbl_ReferenceCountLock); 183 if (ACPI_FAILURE (Status)) 184 { 185 return_ACPI_STATUS (Status); 186 } 187 188 /* Mutex for _OSI support */ 189 190 Status = AcpiOsCreateMutex (&AcpiGbl_OsiMutex); 191 if (ACPI_FAILURE (Status)) 192 { 193 return_ACPI_STATUS (Status); 194 } 195 196 /* Create the reader/writer lock for namespace access */ 197 198 Status = AcpiUtCreateRwLock (&AcpiGbl_NamespaceRwLock); 199 if (ACPI_FAILURE (Status)) 200 { 201 return_ACPI_STATUS (Status); 202 } 203 204#ifdef ACPI_DEBUGGER 205 206 /* Debugger Support */ 207 208 Status = AcpiOsCreateMutex (&AcpiGbl_DbCommandReady); 209 if (ACPI_FAILURE (Status)) 210 { 211 return_ACPI_STATUS (Status); 212 } 213 214 Status = AcpiOsCreateMutex (&AcpiGbl_DbCommandComplete); 215#endif 216 217 return_ACPI_STATUS (Status); 218} 219 220 221/******************************************************************************* 222 * 223 * FUNCTION: AcpiUtMutexTerminate 224 * 225 * PARAMETERS: None. 226 * 227 * RETURN: None. 228 * 229 * DESCRIPTION: Delete all of the system mutex objects. This includes mutexes, 230 * spin locks, and reader/writer locks. 231 * 232 ******************************************************************************/ 233 234void 235AcpiUtMutexTerminate ( 236 void) 237{ 238 UINT32 i; 239 240 241 ACPI_FUNCTION_TRACE (UtMutexTerminate); 242 243 244 /* Delete each predefined mutex object */ 245 246 for (i = 0; i < ACPI_NUM_MUTEX; i++) 247 { 248 AcpiUtDeleteMutex (i); 249 } 250 251 AcpiOsDeleteMutex (AcpiGbl_OsiMutex); 252 253 /* Delete the spinlocks */ 254 255 AcpiOsDeleteLock (AcpiGbl_GpeLock); 256 AcpiOsDeleteLock (AcpiGbl_HardwareLock); 257 AcpiOsDeleteLock (AcpiGbl_ReferenceCountLock); 258 259 /* Delete the reader/writer lock */ 260 261 AcpiUtDeleteRwLock (&AcpiGbl_NamespaceRwLock); 262 263#ifdef ACPI_DEBUGGER 264 AcpiOsDeleteMutex (AcpiGbl_DbCommandReady); 265 AcpiOsDeleteMutex (AcpiGbl_DbCommandComplete); 266#endif 267 268 return_VOID; 269} 270 271 272/******************************************************************************* 273 * 274 * FUNCTION: AcpiUtCreateMutex 275 * 276 * PARAMETERS: MutexID - ID of the mutex to be created 277 * 278 * RETURN: Status 279 * 280 * DESCRIPTION: Create a mutex object. 281 * 282 ******************************************************************************/ 283 284static ACPI_STATUS 285AcpiUtCreateMutex ( 286 ACPI_MUTEX_HANDLE MutexId) 287{ 288 ACPI_STATUS Status = AE_OK; 289 290 291 ACPI_FUNCTION_TRACE_U32 (UtCreateMutex, MutexId); 292 293 294 if (!AcpiGbl_MutexInfo[MutexId].Mutex) 295 { 296 Status = AcpiOsCreateMutex (&AcpiGbl_MutexInfo[MutexId].Mutex); 297 AcpiGbl_MutexInfo[MutexId].ThreadId = ACPI_MUTEX_NOT_ACQUIRED; 298 AcpiGbl_MutexInfo[MutexId].UseCount = 0; 299 } 300 301 return_ACPI_STATUS (Status); 302} 303 304 305/******************************************************************************* 306 * 307 * FUNCTION: AcpiUtDeleteMutex 308 * 309 * PARAMETERS: MutexID - ID of the mutex to be deleted 310 * 311 * RETURN: Status 312 * 313 * DESCRIPTION: Delete a mutex object. 314 * 315 ******************************************************************************/ 316 317static void 318AcpiUtDeleteMutex ( 319 ACPI_MUTEX_HANDLE MutexId) 320{ 321 322 ACPI_FUNCTION_TRACE_U32 (UtDeleteMutex, MutexId); 323 324 325 AcpiOsDeleteMutex (AcpiGbl_MutexInfo[MutexId].Mutex); 326 327 AcpiGbl_MutexInfo[MutexId].Mutex = NULL; 328 AcpiGbl_MutexInfo[MutexId].ThreadId = ACPI_MUTEX_NOT_ACQUIRED; 329 330 return_VOID; 331} 332 333 334/******************************************************************************* 335 * 336 * FUNCTION: AcpiUtAcquireMutex 337 * 338 * PARAMETERS: MutexID - ID of the mutex to be acquired 339 * 340 * RETURN: Status 341 * 342 * DESCRIPTION: Acquire a mutex object. 343 * 344 ******************************************************************************/ 345 346ACPI_STATUS 347AcpiUtAcquireMutex ( 348 ACPI_MUTEX_HANDLE MutexId) 349{ 350 ACPI_STATUS Status; 351 ACPI_THREAD_ID ThisThreadId; 352 353 354 ACPI_FUNCTION_NAME (UtAcquireMutex); 355 356 357 if (MutexId > ACPI_MAX_MUTEX) 358 { 359 return (AE_BAD_PARAMETER); 360 } 361 362 ThisThreadId = AcpiOsGetThreadId (); 363 364#ifdef ACPI_MUTEX_DEBUG 365 { 366 UINT32 i; 367 /* 368 * Mutex debug code, for internal debugging only. 369 * 370 * Deadlock prevention. Check if this thread owns any mutexes of value 371 * greater than or equal to this one. If so, the thread has violated 372 * the mutex ordering rule. This indicates a coding error somewhere in 373 * the ACPI subsystem code. 374 */ 375 for (i = MutexId; i < ACPI_NUM_MUTEX; i++) 376 { 377 if (AcpiGbl_MutexInfo[i].ThreadId == ThisThreadId) 378 { 379 if (i == MutexId) 380 { 381 ACPI_ERROR ((AE_INFO, 382 "Mutex [%s] already acquired by this thread [%u]", 383 AcpiUtGetMutexName (MutexId), 384 (UINT32) ThisThreadId)); 385 386 return (AE_ALREADY_ACQUIRED); 387 } 388 389 ACPI_ERROR ((AE_INFO, 390 "Invalid acquire order: Thread %u owns [%s], wants [%s]", 391 (UINT32) ThisThreadId, AcpiUtGetMutexName (i), 392 AcpiUtGetMutexName (MutexId))); 393 394 return (AE_ACQUIRE_DEADLOCK); 395 } 396 } 397 } 398#endif 399 400 ACPI_DEBUG_PRINT ((ACPI_DB_MUTEX, 401 "Thread %u attempting to acquire Mutex [%s]\n", 402 (UINT32) ThisThreadId, AcpiUtGetMutexName (MutexId))); 403 404 Status = AcpiOsAcquireMutex ( 405 AcpiGbl_MutexInfo[MutexId].Mutex, ACPI_WAIT_FOREVER); 406 if (ACPI_SUCCESS (Status)) 407 { 408 ACPI_DEBUG_PRINT ((ACPI_DB_MUTEX, 409 "Thread %u acquired Mutex [%s]\n", 410 (UINT32) ThisThreadId, AcpiUtGetMutexName (MutexId))); 411 412 AcpiGbl_MutexInfo[MutexId].UseCount++; 413 AcpiGbl_MutexInfo[MutexId].ThreadId = ThisThreadId; 414 } 415 else 416 { 417 ACPI_EXCEPTION ((AE_INFO, Status, 418 "Thread %u could not acquire Mutex [0x%X]", 419 (UINT32) ThisThreadId, MutexId)); 420 } 421 422 return (Status); 423} 424 425 426/******************************************************************************* 427 * 428 * FUNCTION: AcpiUtReleaseMutex 429 * 430 * PARAMETERS: MutexID - ID of the mutex to be released 431 * 432 * RETURN: Status 433 * 434 * DESCRIPTION: Release a mutex object. 435 * 436 ******************************************************************************/ 437 438ACPI_STATUS 439AcpiUtReleaseMutex ( 440 ACPI_MUTEX_HANDLE MutexId) 441{ 442 ACPI_FUNCTION_NAME (UtReleaseMutex); 443 444 445 ACPI_DEBUG_PRINT ((ACPI_DB_MUTEX, "Thread %u releasing Mutex [%s]\n", 446 (UINT32) AcpiOsGetThreadId (), AcpiUtGetMutexName (MutexId))); 447 448 if (MutexId > ACPI_MAX_MUTEX) 449 { 450 return (AE_BAD_PARAMETER); 451 } 452 453 /* 454 * Mutex must be acquired in order to release it! 455 */ 456 if (AcpiGbl_MutexInfo[MutexId].ThreadId == ACPI_MUTEX_NOT_ACQUIRED) 457 { 458 ACPI_ERROR ((AE_INFO, 459 "Mutex [0x%X] is not acquired, cannot release", MutexId)); 460 461 return (AE_NOT_ACQUIRED); 462 } 463 464#ifdef ACPI_MUTEX_DEBUG 465 { 466 UINT32 i; 467 /* 468 * Mutex debug code, for internal debugging only. 469 * 470 * Deadlock prevention. Check if this thread owns any mutexes of value 471 * greater than this one. If so, the thread has violated the mutex 472 * ordering rule. This indicates a coding error somewhere in 473 * the ACPI subsystem code. 474 */ 475 for (i = MutexId; i < ACPI_NUM_MUTEX; i++) 476 { 477 if (AcpiGbl_MutexInfo[i].ThreadId == AcpiOsGetThreadId ()) 478 { 479 if (i == MutexId) 480 { 481 continue; 482 } 483 484 ACPI_ERROR ((AE_INFO, 485 "Invalid release order: owns [%s], releasing [%s]", 486 AcpiUtGetMutexName (i), AcpiUtGetMutexName (MutexId))); 487 488 return (AE_RELEASE_DEADLOCK); 489 } 490 } 491 } 492#endif 493 494 /* Mark unlocked FIRST */ 495 496 AcpiGbl_MutexInfo[MutexId].ThreadId = ACPI_MUTEX_NOT_ACQUIRED; 497 498 AcpiOsReleaseMutex (AcpiGbl_MutexInfo[MutexId].Mutex); 499 return (AE_OK); 500} 501