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