sys/contrib/dev/acpica-unix-20061109/utilities/utmutex.c

   1 /*******************************************************************************
   2  *
   3  * Module Name: utmutex - local mutex support
   4  *              $Revision: 1.11 $
   5  *
   6  ******************************************************************************/
   7
   8 /******************************************************************************
   9  *
  10  * 1. Copyright Notice
  11  *
  12  * Some or all of this work - Copyright (c) 1999 - 2006, Intel Corp.
  13  * All rights reserved.
  14  *
  15  * 2. License
  16  *
  17  * 2.1. This is your license from Intel Corp. under its intellectual property
  18  * rights.  You may have additional license terms from the party that provided
  19  * you this software, covering your right to use that party's intellectual
  20  * property rights.
  21  *
  22  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  23  * copy of the source code appearing in this file ("Covered Code") an
  24  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  25  * base code distributed originally by Intel ("Original Intel Code") to copy,
  26  * make derivatives, distribute, use and display any portion of the Covered
  27  * Code in any form, with the right to sublicense such rights; and
  28  *
  29  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  30  * license (with the right to sublicense), under only those claims of Intel
  31  * patents that are infringed by the Original Intel Code, to make, use, sell,
  32  * offer to sell, and import the Covered Code and derivative works thereof
  33  * solely to the minimum extent necessary to exercise the above copyright
  34  * license, and in no event shall the patent license extend to any additions
  35  * to or modifications of the Original Intel Code.  No other license or right
  36  * is granted directly or by implication, estoppel or otherwise;
  37  *
  38  * The above copyright and patent license is granted only if the following
  39  * conditions are met:
  40  *
  41  * 3. Conditions
  42  *
  43  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  44  * Redistribution of source code of any substantial portion of the Covered
  45  * Code or modification with rights to further distribute source must include
  46  * the above Copyright Notice, the above License, this list of Conditions,
  47  * and the following Disclaimer and Export Compliance provision.  In addition,
  48  * Licensee must cause all Covered Code to which Licensee contributes to
  49  * contain a file documenting the changes Licensee made to create that Covered
  50  * Code and the date of any change.  Licensee must include in that file the
  51  * documentation of any changes made by any predecessor Licensee.  Licensee
  52  * must include a prominent statement that the modification is derived,
  53  * directly or indirectly, from Original Intel Code.
  54  *
  55  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  56  * Redistribution of source code of any substantial portion of the Covered
  57  * Code or modification without rights to further distribute source must
  58  * include the following Disclaimer and Export Compliance provision in the
  59  * documentation and/or other materials provided with distribution.  In
  60  * addition, Licensee may not authorize further sublicense of source of any
  61  * portion of the Covered Code, and must include terms to the effect that the
  62  * license from Licensee to its licensee is limited to the intellectual
  63  * property embodied in the software Licensee provides to its licensee, and
  64  * not to intellectual property embodied in modifications its licensee may
  65  * make.
  66  *
  67  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  68  * substantial portion of the Covered Code or modification must reproduce the
  69  * above Copyright Notice, and the following Disclaimer and Export Compliance
  70  * provision in the documentation and/or other materials provided with the
  71  * distribution.
  72  *
  73  * 3.4. Intel retains all right, title, and interest in and to the Original
  74  * Intel Code.
  75  *
  76  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  77  * Intel shall be used in advertising or otherwise to promote the sale, use or
  78  * other dealings in products derived from or relating to the Covered Code
  79  * without prior written authorization from Intel.
  80  *
  81  * 4. Disclaimer and Export Compliance
  82  *
  83  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  84  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  85  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
  86  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
  87  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
  88  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  89  * PARTICULAR PURPOSE.
  90  *
  91  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  92  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  93  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  94  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  95  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  96  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
  97  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  98  * LIMITED REMEDY.
  99  *
 100  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 101  * software or system incorporating such software without first obtaining any
 102  * required license or other approval from the U. S. Department of Commerce or
 103  * any other agency or department of the United States Government.  In the
 104  * event Licensee exports any such software from the United States or
 105  * re-exports any such software from a foreign destination, Licensee shall
 106  * ensure that the distribution and export/re-export of the software is in
 107  * compliance with all laws, regulations, orders, or other restrictions of the
 108  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 109  * any of its subsidiaries will export/re-export any technical data, process,
 110  * software, or service, directly or indirectly, to any country for which the
 111  * United States government or any agency thereof requires an export license,
 112  * other governmental approval, or letter of assurance, without first obtaining
 113  * such license, approval or letter.
 114  *
 115  *****************************************************************************/
 116
 117
 118 #define __UTMUTEX_C__
 119
 120 #include "acpi.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.
 145  *
 146  ******************************************************************************/
 147
 148 ACPI_STATUS
 149 AcpiUtMutexInitialize (
 150     void)
 151 {
 152     UINT32                  i;
 153     ACPI_STATUS             Status;
 154
 155
 156     ACPI_FUNCTION_TRACE (UtMutexInitialize);
 157
 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     return_ACPI_STATUS (Status);
 181 }
 182
 183
 184 /*******************************************************************************
 185  *
 186  * FUNCTION:    AcpiUtMutexTerminate
 187  *
 188  * PARAMETERS:  None.
 189  *
 190  * RETURN:      None.
 191  *
 192  * DESCRIPTION: Delete all of the system mutex objects.
 193  *
 194  ******************************************************************************/
 195
 196 void
 197 AcpiUtMutexTerminate (
 198     void)
 199 {
 200     UINT32                  i;
 201
 202
 203     ACPI_FUNCTION_TRACE (UtMutexTerminate);
 204
 205
 206     /*
 207      * Delete each predefined mutex object
 208      */
 209     for (i = 0; i < ACPI_NUM_MUTEX; i++)
 210     {
 211         (void) AcpiUtDeleteMutex (i);
 212     }
 213
 214     /* Delete the spinlocks */
 215
 216     AcpiOsDeleteLock (AcpiGbl_GpeLock);
 217     AcpiOsDeleteLock (AcpiGbl_HardwareLock);
 218     return_VOID;
 219 }
 220
 221
 222 /*******************************************************************************
 223  *
 224  * FUNCTION:    AcpiUtCreateMutex
 225  *
 226  * PARAMETERS:  MutexID         - ID of the mutex to be created
 227  *
 228  * RETURN:      Status
 229  *
 230  * DESCRIPTION: Create a mutex object.
 231  *
 232  ******************************************************************************/
 233
 234 static ACPI_STATUS
 235 AcpiUtCreateMutex (
 236     ACPI_MUTEX_HANDLE       MutexId)
 237 {
 238     ACPI_STATUS             Status = AE_OK;
 239
 240
 241     ACPI_FUNCTION_TRACE_U32 (UtCreateMutex, MutexId);
 242
 243
 244     if (MutexId > ACPI_MAX_MUTEX)
 245     {
 246         return_ACPI_STATUS (AE_BAD_PARAMETER);
 247     }
 248
 249     if (!AcpiGbl_MutexInfo[MutexId].Mutex)
 250     {
 251         Status = AcpiOsCreateMutex (&AcpiGbl_MutexInfo[MutexId].Mutex);
 252         AcpiGbl_MutexInfo[MutexId].ThreadId = ACPI_MUTEX_NOT_ACQUIRED;
 253         AcpiGbl_MutexInfo[MutexId].UseCount = 0;
 254     }
 255
 256     return_ACPI_STATUS (Status);
 257 }
 258
 259
 260 /*******************************************************************************
 261  *
 262  * FUNCTION:    AcpiUtDeleteMutex
 263  *
 264  * PARAMETERS:  MutexID         - ID of the mutex to be deleted
 265  *
 266  * RETURN:      Status
 267  *
 268  * DESCRIPTION: Delete a mutex object.
 269  *
 270  ******************************************************************************/
 271
 272 static ACPI_STATUS
 273 AcpiUtDeleteMutex (
 274     ACPI_MUTEX_HANDLE       MutexId)
 275 {
 276
 277     ACPI_FUNCTION_TRACE_U32 (UtDeleteMutex, MutexId);
 278
 279
 280     if (MutexId > ACPI_MAX_MUTEX)
 281     {
 282         return_ACPI_STATUS (AE_BAD_PARAMETER);
 283     }
 284
 285     AcpiOsDeleteMutex (AcpiGbl_MutexInfo[MutexId].Mutex);
 286
 287     AcpiGbl_MutexInfo[MutexId].Mutex = NULL;
 288     AcpiGbl_MutexInfo[MutexId].ThreadId = ACPI_MUTEX_NOT_ACQUIRED;
 289
 290     return_ACPI_STATUS (AE_OK);
 291 }
 292
 293
 294 /*******************************************************************************
 295  *
 296  * FUNCTION:    AcpiUtAcquireMutex
 297  *
 298  * PARAMETERS:  MutexID         - ID of the mutex to be acquired
 299  *
 300  * RETURN:      Status
 301  *
 302  * DESCRIPTION: Acquire a mutex object.
 303  *
 304  ******************************************************************************/
 305
 306 ACPI_STATUS
 307 AcpiUtAcquireMutex (
 308     ACPI_MUTEX_HANDLE       MutexId)
 309 {
 310     ACPI_STATUS             Status;
 311     ACPI_THREAD_ID          ThisThreadId;
 312
 313
 314     ACPI_FUNCTION_NAME (UtAcquireMutex);
 315
 316
 317     if (MutexId > ACPI_MAX_MUTEX)
 318     {
 319         return (AE_BAD_PARAMETER);
 320     }
 321
 322     ThisThreadId = AcpiOsGetThreadId ();
 323
 324 #ifdef ACPI_MUTEX_DEBUG
 325     {
 326         UINT32                  i;
 327         /*
 328          * Mutex debug code, for internal debugging only.
 329          *
 330          * Deadlock prevention.  Check if this thread owns any mutexes of value
 331          * greater than or equal to this one.  If so, the thread has violated
 332          * the mutex ordering rule.  This indicates a coding error somewhere in
 333          * the ACPI subsystem code.
 334          */
 335         for (i = MutexId; i < ACPI_MAX_MUTEX; i++)
 336         {
 337             if (AcpiGbl_MutexInfo[i].ThreadId == ThisThreadId)
 338             {
 339                 if (i == MutexId)
 340                 {
 341                     ACPI_ERROR ((AE_INFO,
 342                         "Mutex [%s] already acquired by this thread [%X]",
 343                         AcpiUtGetMutexName (MutexId), ThisThreadId));
 344
 345                     return (AE_ALREADY_ACQUIRED);
 346                 }
 347
 348                 ACPI_ERROR ((AE_INFO,
 349                     "Invalid acquire order: Thread %X owns [%s], wants [%s]",
 350                     ThisThreadId, AcpiUtGetMutexName (i),
 351                     AcpiUtGetMutexName (MutexId)));
 352
 353                 return (AE_ACQUIRE_DEADLOCK);
 354             }
 355         }
 356     }
 357 #endif
 358
 359     ACPI_DEBUG_PRINT ((ACPI_DB_MUTEX,
 360         "Thread %X attempting to acquire Mutex [%s]\n",
 361         ThisThreadId, AcpiUtGetMutexName (MutexId)));
 362
 363     Status = AcpiOsAcquireMutex (AcpiGbl_MutexInfo[MutexId].Mutex,
 364                 ACPI_WAIT_FOREVER);
 365     if (ACPI_SUCCESS (Status))
 366     {
 367         ACPI_DEBUG_PRINT ((ACPI_DB_MUTEX, "Thread %X acquired Mutex [%s]\n",
 368             ThisThreadId, AcpiUtGetMutexName (MutexId)));
 369
 370         AcpiGbl_MutexInfo[MutexId].UseCount++;
 371         AcpiGbl_MutexInfo[MutexId].ThreadId = ThisThreadId;
 372     }
 373     else
 374     {
 375         ACPI_EXCEPTION ((AE_INFO, Status,
 376             "Thread %X could not acquire Mutex [%X]", ThisThreadId, MutexId));
 377     }
 378
 379     return (Status);
 380 }
 381
 382
 383 /*******************************************************************************
 384  *
 385  * FUNCTION:    AcpiUtReleaseMutex
 386  *
 387  * PARAMETERS:  MutexID         - ID of the mutex to be released
 388  *
 389  * RETURN:      Status
 390  *
 391  * DESCRIPTION: Release a mutex object.
 392  *
 393  ******************************************************************************/
 394
 395 ACPI_STATUS
 396 AcpiUtReleaseMutex (
 397     ACPI_MUTEX_HANDLE       MutexId)
 398 {
 399     ACPI_THREAD_ID          ThisThreadId;
 400
 401
 402     ACPI_FUNCTION_NAME (UtReleaseMutex);
 403
 404
 405     ThisThreadId = AcpiOsGetThreadId ();
 406     ACPI_DEBUG_PRINT ((ACPI_DB_MUTEX,
 407         "Thread %X releasing Mutex [%s]\n", ThisThreadId,
 408         AcpiUtGetMutexName (MutexId)));
 409
 410     if (MutexId > ACPI_MAX_MUTEX)
 411     {
 412         return (AE_BAD_PARAMETER);
 413     }
 414
 415     /*
 416      * Mutex must be acquired in order to release it!
 417      */
 418     if (AcpiGbl_MutexInfo[MutexId].ThreadId == ACPI_MUTEX_NOT_ACQUIRED)
 419     {
 420         ACPI_ERROR ((AE_INFO,
 421             "Mutex [%X] is not acquired, cannot release", MutexId));
 422
 423         return (AE_NOT_ACQUIRED);
 424     }
 425
 426 #ifdef ACPI_MUTEX_DEBUG
 427     {
 428         UINT32                  i;
 429         /*
 430          * Mutex debug code, for internal debugging only.
 431          *
 432          * Deadlock prevention.  Check if this thread owns any mutexes of value
 433          * greater than this one.  If so, the thread has violated the mutex
 434          * ordering rule.  This indicates a coding error somewhere in
 435          * the ACPI subsystem code.
 436          */
 437         for (i = MutexId; i < ACPI_MAX_MUTEX; i++)
 438         {
 439             if (AcpiGbl_MutexInfo[i].ThreadId == ThisThreadId)
 440             {
 441                 if (i == MutexId)
 442                 {
 443                     continue;
 444                 }
 445
 446                 ACPI_ERROR ((AE_INFO,
 447                     "Invalid release order: owns [%s], releasing [%s]",
 448                     AcpiUtGetMutexName (i), AcpiUtGetMutexName (MutexId)));
 449
 450                 return (AE_RELEASE_DEADLOCK);
 451             }
 452         }
 453     }
 454 #endif
 455
 456     /* Mark unlocked FIRST */
 457
 458     AcpiGbl_MutexInfo[MutexId].ThreadId = ACPI_MUTEX_NOT_ACQUIRED;
 459
 460     AcpiOsReleaseMutex (AcpiGbl_MutexInfo[MutexId].Mutex);
 461     return (AE_OK);
 462 }
 463
 464