sys/contrib/dev/acpica/utilities/utmutex.c

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