utmutex.c revision 210976
150472Speter/******************************************************************************* 218666Speter * 349866Sobrien * Module Name: utmutex - local mutex support 418666Speter * 549866Sobrien ******************************************************************************/ 618666Speter 745337Sobrien/****************************************************************************** 845337Sobrien * 918666Speter * 1. Copyright Notice 1045299Sobrien * 1118666Speter * Some or all of this work - Copyright (c) 1999 - 2010, Intel Corp. 1218666Speter * All rights reserved. 1349866Sobrien * 1449866Sobrien * 2. License 1545299Sobrien * 1618666Speter * 2.1. This is your license from Intel Corp. under its intellectual property 1740204Speter * rights. You may have additional license terms from the party that provided 1840204Speter * you this software, covering your right to use that party's intellectual 1940204Speter * property rights. 2018666Speter * 2118666Speter * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 2245299Sobrien * copy of the source code appearing in this file ("Covered Code") an 2345299Sobrien * irrevocable, perpetual, worldwide license under Intel's copyrights in the 2418666Speter * base code distributed originally by Intel ("Original Intel Code") to copy, 2545299Sobrien * make derivatives, distribute, use and display any portion of the Covered 2645299Sobrien * Code in any form, with the right to sublicense such rights; and 2718666Speter * 2845299Sobrien * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 2945299Sobrien * license (with the right to sublicense), under only those claims of Intel 3045299Sobrien * patents that are infringed by the Original Intel Code, to make, use, sell, 3145299Sobrien * offer to sell, and import the Covered Code and derivative works thereof 3245299Sobrien * solely to the minimum extent necessary to exercise the above copyright 3345299Sobrien * license, and in no event shall the patent license extend to any additions 3445299Sobrien * to or modifications of the Original Intel Code. No other license or right 3545299Sobrien * is granted directly or by implication, estoppel or otherwise; 3645299Sobrien * 3745299Sobrien * The above copyright and patent license is granted only if the following 3845299Sobrien * conditions are met: 3945299Sobrien * 4045299Sobrien * 3. Conditions 4118666Speter * 4245299Sobrien * 3.1. Redistribution of Source with Rights to Further Distribute Source. 4345299Sobrien * Redistribution of source code of any substantial portion of the Covered 4418666Speter * Code or modification with rights to further distribute source must include 4545299Sobrien * the above Copyright Notice, the above License, this list of Conditions, 4618666Speter * and the following Disclaimer and Export Compliance provision. In addition, 4718666Speter * Licensee must cause all Covered Code to which Licensee contributes to 4818666Speter * contain a file documenting the changes Licensee made to create that Covered 4918666Speter * Code and the date of any change. Licensee must include in that file the 5018666Speter * documentation of any changes made by any predecessor Licensee. Licensee 5145299Sobrien * must include a prominent statement that the modification is derived, 5218666Speter * directly or indirectly, from Original Intel Code. 5318666Speter * 5418666Speter * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 5518666Speter * Redistribution of source code of any substantial portion of the Covered 5618666Speter * Code or modification without rights to further distribute source must 5733799Sbde * include the following Disclaimer and Export Compliance provision in the 5818666Speter * documentation and/or other materials provided with distribution. In 5945299Sobrien * addition, Licensee may not authorize further sublicense of source of any 6018666Speter * portion of the Covered Code, and must include terms to the effect that the 6145299Sobrien * license from Licensee to its licensee is limited to the intellectual 6245299Sobrien * property embodied in the software Licensee provides to its licensee, and 6345299Sobrien * not to intellectual property embodied in modifications its licensee may 6445299Sobrien * make. 6545299Sobrien * 6645299Sobrien * 3.3. Redistribution of Executable. Redistribution in executable form of any 6745299Sobrien * substantial portion of the Covered Code or modification must reproduce the 6845299Sobrien * above Copyright Notice, and the following Disclaimer and Export Compliance 6918666Speter * provision in the documentation and/or other materials provided with the 7045419Sobrien * distribution. 7118666Speter * 7245465Sobrien * 3.4. Intel retains all right, title, and interest in and to the Original 7349866Sobrien * Intel Code. 7449866Sobrien * 7549866Sobrien * 3.5. Neither the name Intel nor any other trademark owned or controlled by 7645454Sobrien * Intel shall be used in advertising or otherwise to promote the sale, use or 7718666Speter * other dealings in products derived from or relating to the Covered Code 7849866Sobrien * without prior written authorization from Intel. 7945454Sobrien * 8018666Speter * 4. Disclaimer and Export Compliance 8145419Sobrien * 8245299Sobrien * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 8318666Speter * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 8418666Speter * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 8518666Speter * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 8634707Sbde * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 8734707Sbde * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 8834707Sbde * PARTICULAR PURPOSE. 8934707Sbde * 9034707Sbde * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 9118666Speter * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 9245299Sobrien * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 9334707Sbde * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 9418666Speter * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 9534707Sbde * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 9618666Speter * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 9734707Sbde * LIMITED REMEDY. 9834707Sbde * 9934707Sbde * 4.3. Licensee shall not export, either directly or indirectly, any of this 10018666Speter * software or system incorporating such software without first obtaining any 10134707Sbde * required license or other approval from the U. S. Department of Commerce or 10234707Sbde * any other agency or department of the United States Government. In the 10318666Speter * event Licensee exports any such software from the United States or 10434707Sbde * re-exports any such software from a foreign destination, Licensee shall 10518666Speter * ensure that the distribution and export/re-export of the software is in 10634707Sbde * compliance with all laws, regulations, orders, or other restrictions of the 10718666Speter * U.S. Export Administration Regulations. Licensee agrees that neither it nor 10834707Sbde * any of its subsidiaries will export/re-export any technical data, process, 10934707Sbde * software, or service, directly or indirectly, to any country for which the 11034707Sbde * United States government or any agency thereof requires an export license, 11118666Speter * other governmental approval, or letter of assurance, without first obtaining 11234707Sbde * such license, approval or letter. 11334707Sbde * 11424749Speter *****************************************************************************/ 11545339Sobrien 11645339Sobrien 11734707Sbde#define __UTMUTEX_C__ 11818666Speter 11934707Sbde#include <contrib/dev/acpica/include/acpi.h> 12018666Speter#include <contrib/dev/acpica/include/accommon.h> 12134707Sbde 12234707Sbde#define _COMPONENT ACPI_UTILITIES 12334707Sbde ACPI_MODULE_NAME ("utmutex") 12418666Speter 12534707Sbde/* Local prototypes */ 12634707Sbde 12718666Speterstatic ACPI_STATUS 12834707SbdeAcpiUtCreateMutex ( 12918666Speter ACPI_MUTEX_HANDLE MutexId); 13034707Sbde 13118666Speterstatic void 13234707SbdeAcpiUtDeleteMutex ( 13334707Sbde ACPI_MUTEX_HANDLE MutexId); 13434707Sbde 13518666Speter 13634707Sbde/******************************************************************************* 13734707Sbde * 13824749Speter * FUNCTION: AcpiUtMutexInitialize 13945339Sobrien * 14045339Sobrien * PARAMETERS: None. 14134707Sbde * 14218666Speter * RETURN: Status 14334707Sbde * 14418666Speter * DESCRIPTION: Create the system mutex objects. This includes mutexes, 14534707Sbde * spin locks, and reader/writer locks. 14634707Sbde * 14734707Sbde ******************************************************************************/ 14818666Speter 14934707SbdeACPI_STATUS 15034707SbdeAcpiUtMutexInitialize ( 15118666Speter void) 15234707Sbde{ 15318666Speter UINT32 i; 15434707Sbde ACPI_STATUS Status; 15518666Speter 15634707Sbde 15734707Sbde ACPI_FUNCTION_TRACE (UtMutexInitialize); 15834707Sbde 15918666Speter 16034707Sbde /* Create each of the predefined mutex objects */ 16134707Sbde 16224749Speter for (i = 0; i < ACPI_NUM_MUTEX; i++) 16345339Sobrien { 16445339Sobrien Status = AcpiUtCreateMutex (i); 16534707Sbde if (ACPI_FAILURE (Status)) 16618666Speter { 16734707Sbde return_ACPI_STATUS (Status); 16818666Speter } 16934707Sbde } 17034707Sbde 17134707Sbde /* Create the spinlocks for use at interrupt level */ 17218666Speter 17334707Sbde Status = AcpiOsCreateLock (&AcpiGbl_GpeLock); 17434707Sbde if (ACPI_FAILURE (Status)) 17518666Speter { 17634707Sbde return_ACPI_STATUS (Status); 17718666Speter } 17834707Sbde 17918666Speter Status = AcpiOsCreateLock (&AcpiGbl_HardwareLock); 18045419Sobrien if (ACPI_FAILURE (Status)) 18145419Sobrien { 18245419Sobrien return_ACPI_STATUS (Status); 18345419Sobrien } 18445454Sobrien 18549866Sobrien /* Mutex for _OSI support */ 18645454Sobrien Status = AcpiOsCreateMutex (&AcpiGbl_OsiMutex); 18745419Sobrien if (ACPI_FAILURE (Status)) 18818666Speter { 189 return_ACPI_STATUS (Status); 190 } 191 192 /* Create the reader/writer lock for namespace access */ 193 194 Status = AcpiUtCreateRwLock (&AcpiGbl_NamespaceRwLock); 195 return_ACPI_STATUS (Status); 196} 197 198 199/******************************************************************************* 200 * 201 * FUNCTION: AcpiUtMutexTerminate 202 * 203 * PARAMETERS: None. 204 * 205 * RETURN: None. 206 * 207 * DESCRIPTION: Delete all of the system mutex objects. This includes mutexes, 208 * spin locks, and reader/writer locks. 209 * 210 ******************************************************************************/ 211 212void 213AcpiUtMutexTerminate ( 214 void) 215{ 216 UINT32 i; 217 218 219 ACPI_FUNCTION_TRACE (UtMutexTerminate); 220 221 222 /* Delete each predefined mutex object */ 223 224 for (i = 0; i < ACPI_NUM_MUTEX; i++) 225 { 226 AcpiUtDeleteMutex (i); 227 } 228 229 AcpiOsDeleteMutex (AcpiGbl_OsiMutex); 230 231 /* Delete the spinlocks */ 232 233 AcpiOsDeleteLock (AcpiGbl_GpeLock); 234 AcpiOsDeleteLock (AcpiGbl_HardwareLock); 235 236 /* Delete the reader/writer lock */ 237 238 AcpiUtDeleteRwLock (&AcpiGbl_NamespaceRwLock); 239 return_VOID; 240} 241 242 243/******************************************************************************* 244 * 245 * FUNCTION: AcpiUtCreateMutex 246 * 247 * PARAMETERS: MutexID - ID of the mutex to be created 248 * 249 * RETURN: Status 250 * 251 * DESCRIPTION: Create a mutex object. 252 * 253 ******************************************************************************/ 254 255static ACPI_STATUS 256AcpiUtCreateMutex ( 257 ACPI_MUTEX_HANDLE MutexId) 258{ 259 ACPI_STATUS Status = AE_OK; 260 261 262 ACPI_FUNCTION_TRACE_U32 (UtCreateMutex, MutexId); 263 264 265 if (!AcpiGbl_MutexInfo[MutexId].Mutex) 266 { 267 Status = AcpiOsCreateMutex (&AcpiGbl_MutexInfo[MutexId].Mutex); 268 AcpiGbl_MutexInfo[MutexId].ThreadId = ACPI_MUTEX_NOT_ACQUIRED; 269 AcpiGbl_MutexInfo[MutexId].UseCount = 0; 270 } 271 272 return_ACPI_STATUS (Status); 273} 274 275 276/******************************************************************************* 277 * 278 * FUNCTION: AcpiUtDeleteMutex 279 * 280 * PARAMETERS: MutexID - ID of the mutex to be deleted 281 * 282 * RETURN: Status 283 * 284 * DESCRIPTION: Delete a mutex object. 285 * 286 ******************************************************************************/ 287 288static void 289AcpiUtDeleteMutex ( 290 ACPI_MUTEX_HANDLE MutexId) 291{ 292 293 ACPI_FUNCTION_TRACE_U32 (UtDeleteMutex, MutexId); 294 295 296 AcpiOsDeleteMutex (AcpiGbl_MutexInfo[MutexId].Mutex); 297 298 AcpiGbl_MutexInfo[MutexId].Mutex = NULL; 299 AcpiGbl_MutexInfo[MutexId].ThreadId = ACPI_MUTEX_NOT_ACQUIRED; 300} 301 302 303/******************************************************************************* 304 * 305 * FUNCTION: AcpiUtAcquireMutex 306 * 307 * PARAMETERS: MutexID - ID of the mutex to be acquired 308 * 309 * RETURN: Status 310 * 311 * DESCRIPTION: Acquire a mutex object. 312 * 313 ******************************************************************************/ 314 315ACPI_STATUS 316AcpiUtAcquireMutex ( 317 ACPI_MUTEX_HANDLE MutexId) 318{ 319 ACPI_STATUS Status; 320 ACPI_THREAD_ID ThisThreadId; 321 322 323 ACPI_FUNCTION_NAME (UtAcquireMutex); 324 325 326 if (MutexId > ACPI_MAX_MUTEX) 327 { 328 return (AE_BAD_PARAMETER); 329 } 330 331 ThisThreadId = AcpiOsGetThreadId (); 332 333#ifdef ACPI_MUTEX_DEBUG 334 { 335 UINT32 i; 336 /* 337 * Mutex debug code, for internal debugging only. 338 * 339 * Deadlock prevention. Check if this thread owns any mutexes of value 340 * greater than or equal to this one. If so, the thread has violated 341 * the mutex ordering rule. This indicates a coding error somewhere in 342 * the ACPI subsystem code. 343 */ 344 for (i = MutexId; i < ACPI_NUM_MUTEX; i++) 345 { 346 if (AcpiGbl_MutexInfo[i].ThreadId == ThisThreadId) 347 { 348 if (i == MutexId) 349 { 350 ACPI_ERROR ((AE_INFO, 351 "Mutex [%s] already acquired by this thread [%p]", 352 AcpiUtGetMutexName (MutexId), 353 ACPI_CAST_PTR (void, ThisThreadId))); 354 355 return (AE_ALREADY_ACQUIRED); 356 } 357 358 ACPI_ERROR ((AE_INFO, 359 "Invalid acquire order: Thread %p owns [%s], wants [%s]", 360 ACPI_CAST_PTR (void, ThisThreadId), AcpiUtGetMutexName (i), 361 AcpiUtGetMutexName (MutexId))); 362 363 return (AE_ACQUIRE_DEADLOCK); 364 } 365 } 366 } 367#endif 368 369 ACPI_DEBUG_PRINT ((ACPI_DB_MUTEX, 370 "Thread %p attempting to acquire Mutex [%s]\n", 371 ACPI_CAST_PTR (void, ThisThreadId), AcpiUtGetMutexName (MutexId))); 372 373 Status = AcpiOsAcquireMutex (AcpiGbl_MutexInfo[MutexId].Mutex, 374 ACPI_WAIT_FOREVER); 375 if (ACPI_SUCCESS (Status)) 376 { 377 ACPI_DEBUG_PRINT ((ACPI_DB_MUTEX, "Thread %p acquired Mutex [%s]\n", 378 ACPI_CAST_PTR (void, ThisThreadId), AcpiUtGetMutexName (MutexId))); 379 380 AcpiGbl_MutexInfo[MutexId].UseCount++; 381 AcpiGbl_MutexInfo[MutexId].ThreadId = ThisThreadId; 382 } 383 else 384 { 385 ACPI_EXCEPTION ((AE_INFO, Status, 386 "Thread %p could not acquire Mutex [0x%X]", 387 ACPI_CAST_PTR (void, ThisThreadId), MutexId)); 388 } 389 390 return (Status); 391} 392 393 394/******************************************************************************* 395 * 396 * FUNCTION: AcpiUtReleaseMutex 397 * 398 * PARAMETERS: MutexID - ID of the mutex to be released 399 * 400 * RETURN: Status 401 * 402 * DESCRIPTION: Release a mutex object. 403 * 404 ******************************************************************************/ 405 406ACPI_STATUS 407AcpiUtReleaseMutex ( 408 ACPI_MUTEX_HANDLE MutexId) 409{ 410 ACPI_THREAD_ID ThisThreadId; 411 412 413 ACPI_FUNCTION_NAME (UtReleaseMutex); 414 415 416 ThisThreadId = AcpiOsGetThreadId (); 417 ACPI_DEBUG_PRINT ((ACPI_DB_MUTEX, "Thread %p releasing Mutex [%s]\n", 418 ACPI_CAST_PTR (void, ThisThreadId), AcpiUtGetMutexName (MutexId))); 419 420 if (MutexId > ACPI_MAX_MUTEX) 421 { 422 return (AE_BAD_PARAMETER); 423 } 424 425 /* 426 * Mutex must be acquired in order to release it! 427 */ 428 if (AcpiGbl_MutexInfo[MutexId].ThreadId == ACPI_MUTEX_NOT_ACQUIRED) 429 { 430 ACPI_ERROR ((AE_INFO, 431 "Mutex [0x%X] is not acquired, cannot release", MutexId)); 432 433 return (AE_NOT_ACQUIRED); 434 } 435 436#ifdef ACPI_MUTEX_DEBUG 437 { 438 UINT32 i; 439 /* 440 * Mutex debug code, for internal debugging only. 441 * 442 * Deadlock prevention. Check if this thread owns any mutexes of value 443 * greater than this one. If so, the thread has violated the mutex 444 * ordering rule. This indicates a coding error somewhere in 445 * the ACPI subsystem code. 446 */ 447 for (i = MutexId; i < ACPI_NUM_MUTEX; i++) 448 { 449 if (AcpiGbl_MutexInfo[i].ThreadId == ThisThreadId) 450 { 451 if (i == MutexId) 452 { 453 continue; 454 } 455 456 ACPI_ERROR ((AE_INFO, 457 "Invalid release order: owns [%s], releasing [%s]", 458 AcpiUtGetMutexName (i), AcpiUtGetMutexName (MutexId))); 459 460 return (AE_RELEASE_DEADLOCK); 461 } 462 } 463 } 464#endif 465 466 /* Mark unlocked FIRST */ 467 468 AcpiGbl_MutexInfo[MutexId].ThreadId = ACPI_MUTEX_NOT_ACQUIRED; 469 470 AcpiOsReleaseMutex (AcpiGbl_MutexInfo[MutexId].Mutex); 471 return (AE_OK); 472} 473 474 475