drivers/acpica/utmutex.c

0001 /*******************************************************************************
0002  *
0003  * Module Name: utmutex - local mutex support
0004  *
0005  ******************************************************************************/
0006
0007 /******************************************************************************
0008  *
0009  * 1. Copyright Notice
0010  *
0011  * Some or all of this work - Copyright (c) 1999 - 2009, Intel Corp.
0012  * All rights reserved.
0013  *
0014  * 2. License
0015  *
0016  * 2.1. This is your license from Intel Corp. under its intellectual property
0017  * rights.  You may have additional license terms from the party that provided
0018  * you this software, covering your right to use that party's intellectual
0019  * property rights.
0020  *
0021  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
0022  * copy of the source code appearing in this file ("Covered Code") an
0023  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
0024  * base code distributed originally by Intel ("Original Intel Code") to copy,
0025  * make derivatives, distribute, use and display any portion of the Covered
0026  * Code in any form, with the right to sublicense such rights; and
0027  *
0028  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
0029  * license (with the right to sublicense), under only those claims of Intel
0030  * patents that are infringed by the Original Intel Code, to make, use, sell,
0031  * offer to sell, and import the Covered Code and derivative works thereof
0032  * solely to the minimum extent necessary to exercise the above copyright
0033  * license, and in no event shall the patent license extend to any additions
0034  * to or modifications of the Original Intel Code.  No other license or right
0035  * is granted directly or by implication, estoppel or otherwise;
0036  *
0037  * The above copyright and patent license is granted only if the following
0038  * conditions are met:
0039  *
0040  * 3. Conditions
0041  *
0042  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
0043  * Redistribution of source code of any substantial portion of the Covered
0044  * Code or modification with rights to further distribute source must include
0045  * the above Copyright Notice, the above License, this list of Conditions,
0046  * and the following Disclaimer and Export Compliance provision.  In addition,
0047  * Licensee must cause all Covered Code to which Licensee contributes to
0048  * contain a file documenting the changes Licensee made to create that Covered
0049  * Code and the date of any change.  Licensee must include in that file the
0050  * documentation of any changes made by any predecessor Licensee.  Licensee
0051  * must include a prominent statement that the modification is derived,
0052  * directly or indirectly, from Original Intel Code.
0053  *
0054  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
0055  * Redistribution of source code of any substantial portion of the Covered
0056  * Code or modification without rights to further distribute source must
0057  * include the following Disclaimer and Export Compliance provision in the
0058  * documentation and/or other materials provided with distribution.  In
0059  * addition, Licensee may not authorize further sublicense of source of any
0060  * portion of the Covered Code, and must include terms to the effect that the
0061  * license from Licensee to its licensee is limited to the intellectual
0062  * property embodied in the software Licensee provides to its licensee, and
0063  * not to intellectual property embodied in modifications its licensee may
0064  * make.
0065  *
0066  * 3.3. Redistribution of Executable. Redistribution in executable form of any
0067  * substantial portion of the Covered Code or modification must reproduce the
0068  * above Copyright Notice, and the following Disclaimer and Export Compliance
0069  * provision in the documentation and/or other materials provided with the
0070  * distribution.
0071  *
0072  * 3.4. Intel retains all right, title, and interest in and to the Original
0073  * Intel Code.
0074  *
0075  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
0076  * Intel shall be used in advertising or otherwise to promote the sale, use or
0077  * other dealings in products derived from or relating to the Covered Code
0078  * without prior written authorization from Intel.
0079  *
0080  * 4. Disclaimer and Export Compliance
0081  *
0082  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
0083  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
0084  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
0085  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
0086  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
0087  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
0088  * PARTICULAR PURPOSE.
0089  *
0090  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
0091  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
0092  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
0093  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
0094  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
0095  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
0096  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
0097  * LIMITED REMEDY.
0098  *
0099  * 4.3. Licensee shall not export, either directly or indirectly, any of this
0100  * software or system incorporating such software without first obtaining any
0101  * required license or other approval from the U. S. Department of Commerce or
0102  * any other agency or department of the United States Government.  In the
0103  * event Licensee exports any such software from the United States or
0104  * re-exports any such software from a foreign destination, Licensee shall
0105  * ensure that the distribution and export/re-export of the software is in
0106  * compliance with all laws, regulations, orders, or other restrictions of the
0107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
0108  * any of its subsidiaries will export/re-export any technical data, process,
0109  * software, or service, directly or indirectly, to any country for which the
0110  * United States government or any agency thereof requires an export license,
0111  * other governmental approval, or letter of assurance, without first obtaining
0112  * such license, approval or letter.
0113  *
0114  *****************************************************************************/
0115
0116
0117 #define __UTMUTEX_C__
0118
0119 #include "acpi.h"
0120 #include "accommon.h"
0121
0122 #define _COMPONENT          ACPI_UTILITIES
0123         ACPI_MODULE_NAME    ("utmutex")
0124
0125 /* Local prototypes */
0126
0127 static ACPI_STATUS
0128 AcpiUtCreateMutex (
0129     ACPI_MUTEX_HANDLE       MutexId);
0130
0131 static ACPI_STATUS
0132 AcpiUtDeleteMutex (
0133     ACPI_MUTEX_HANDLE       MutexId);
0134
0135
0136 /*******************************************************************************
0137  *
0138  * FUNCTION:    AcpiUtMutexInitialize
0139  *
0140  * PARAMETERS:  None.
0141  *
0142  * RETURN:      Status
0143  *
0144  * DESCRIPTION: Create the system mutex objects. This includes mutexes,
0145  *              spin locks, and reader/writer locks.
0146  *
0147  ******************************************************************************/
0148
0149 ACPI_STATUS
0150 AcpiUtMutexInitialize (
0151     void)
0152 {
0153     UINT32                  i;
0154     ACPI_STATUS             Status;
0155
0156
0157     ACPI_FUNCTION_TRACE (UtMutexInitialize);
0158
0159
0160     /* Create each of the predefined mutex objects */
0161
0162     for (i = 0; i < ACPI_NUM_MUTEX; i++)
0163     {
0164         Status = AcpiUtCreateMutex (i);
0165         if (ACPI_FAILURE (Status))
0166         {
0167             return_ACPI_STATUS (Status);
0168         }
0169     }
0170
0171     /* Create the spinlocks for use at interrupt level */
0172
0173     Status = AcpiOsCreateLock (&AcpiGbl_GpeLock);
0174     if (ACPI_FAILURE (Status))
0175     {
0176         return_ACPI_STATUS (Status);
0177     }
0178
0179     Status = AcpiOsCreateLock (&AcpiGbl_HardwareLock);
0180     if (ACPI_FAILURE (Status))
0181     {
0182         return_ACPI_STATUS (Status);
0183     }
0184
0185     /* Create the reader/writer lock for namespace access */
0186
0187     Status = AcpiUtCreateRwLock (&AcpiGbl_NamespaceRwLock);
0188     return_ACPI_STATUS (Status);
0189 }
0190
0191
0192 /*******************************************************************************
0193  *
0194  * FUNCTION:    AcpiUtMutexTerminate
0195  *
0196  * PARAMETERS:  None.
0197  *
0198  * RETURN:      None.
0199  *
0200  * DESCRIPTION: Delete all of the system mutex objects. This includes mutexes,
0201  *              spin locks, and reader/writer locks.
0202  *
0203  ******************************************************************************/
0204
0205 void
0206 AcpiUtMutexTerminate (
0207     void)
0208 {
0209     UINT32                  i;
0210
0211
0212     ACPI_FUNCTION_TRACE (UtMutexTerminate);
0213
0214
0215     /* Delete each predefined mutex object */
0216
0217     for (i = 0; i < ACPI_NUM_MUTEX; i++)
0218     {
0219         (void) AcpiUtDeleteMutex (i);
0220     }
0221
0222     /* Delete the spinlocks */
0223
0224     AcpiOsDeleteLock (AcpiGbl_GpeLock);
0225     AcpiOsDeleteLock (AcpiGbl_HardwareLock);
0226
0227     /* Delete the reader/writer lock */
0228
0229     AcpiUtDeleteRwLock (&AcpiGbl_NamespaceRwLock);
0230     return_VOID;
0231 }
0232
0233
0234 /*******************************************************************************
0235  *
0236  * FUNCTION:    AcpiUtCreateMutex
0237  *
0238  * PARAMETERS:  MutexID         - ID of the mutex to be created
0239  *
0240  * RETURN:      Status
0241  *
0242  * DESCRIPTION: Create a mutex object.
0243  *
0244  ******************************************************************************/
0245
0246 static ACPI_STATUS
0247 AcpiUtCreateMutex (
0248     ACPI_MUTEX_HANDLE       MutexId)
0249 {
0250     ACPI_STATUS             Status = AE_OK;
0251
0252
0253     ACPI_FUNCTION_TRACE_U32 (UtCreateMutex, MutexId);
0254
0255
0256     if (MutexId > ACPI_MAX_MUTEX)
0257     {
0258         return_ACPI_STATUS (AE_BAD_PARAMETER);
0259     }
0260
0261     if (!AcpiGbl_MutexInfo[MutexId].Mutex)
0262     {
0263         Status = AcpiOsCreateMutex (&AcpiGbl_MutexInfo[MutexId].Mutex);
0264         AcpiGbl_MutexInfo[MutexId].ThreadId = ACPI_MUTEX_NOT_ACQUIRED;
0265         AcpiGbl_MutexInfo[MutexId].UseCount = 0;
0266     }
0267
0268     return_ACPI_STATUS (Status);
0269 }
0270
0271
0272 /*******************************************************************************
0273  *
0274  * FUNCTION:    AcpiUtDeleteMutex
0275  *
0276  * PARAMETERS:  MutexID         - ID of the mutex to be deleted
0277  *
0278  * RETURN:      Status
0279  *
0280  * DESCRIPTION: Delete a mutex object.
0281  *
0282  ******************************************************************************/
0283
0284 static ACPI_STATUS
0285 AcpiUtDeleteMutex (
0286     ACPI_MUTEX_HANDLE       MutexId)
0287 {
0288
0289     ACPI_FUNCTION_TRACE_U32 (UtDeleteMutex, MutexId);
0290
0291
0292     if (MutexId > ACPI_MAX_MUTEX)
0293     {
0294         return_ACPI_STATUS (AE_BAD_PARAMETER);
0295     }
0296
0297     AcpiOsDeleteMutex (AcpiGbl_MutexInfo[MutexId].Mutex);
0298
0299     AcpiGbl_MutexInfo[MutexId].Mutex = NULL;
0300     AcpiGbl_MutexInfo[MutexId].ThreadId = ACPI_MUTEX_NOT_ACQUIRED;
0301
0302     return_ACPI_STATUS (AE_OK);
0303 }
0304
0305
0306 /*******************************************************************************
0307  *
0308  * FUNCTION:    AcpiUtAcquireMutex
0309  *
0310  * PARAMETERS:  MutexID         - ID of the mutex to be acquired
0311  *
0312  * RETURN:      Status
0313  *
0314  * DESCRIPTION: Acquire a mutex object.
0315  *
0316  ******************************************************************************/
0317
0318 ACPI_STATUS
0319 AcpiUtAcquireMutex (
0320     ACPI_MUTEX_HANDLE       MutexId)
0321 {
0322     ACPI_STATUS             Status;
0323     ACPI_THREAD_ID          ThisThreadId;
0324
0325
0326     ACPI_FUNCTION_NAME (UtAcquireMutex);
0327
0328
0329     if (MutexId > ACPI_MAX_MUTEX)
0330     {
0331         return (AE_BAD_PARAMETER);
0332     }
0333
0334     ThisThreadId = AcpiOsGetThreadId ();
0335
0336 #ifdef ACPI_MUTEX_DEBUG
0337     {
0338         UINT32                  i;
0339         /*
0340          * Mutex debug code, for internal debugging only.
0341          *
0342          * Deadlock prevention.  Check if this thread owns any mutexes of value
0343          * greater than or equal to this one.  If so, the thread has violated
0344          * the mutex ordering rule.  This indicates a coding error somewhere in
0345          * the ACPI subsystem code.
0346          */
0347         for (i = MutexId; i < ACPI_NUM_MUTEX; i++)
0348         {
0349             if (AcpiGbl_MutexInfo[i].ThreadId == ThisThreadId)
0350             {
0351                 if (i == MutexId)
0352                 {
0353                     ACPI_ERROR ((AE_INFO,
0354                         "Mutex [%s] already acquired by this thread [%p]",
0355                         AcpiUtGetMutexName (MutexId),
0356                         ACPI_CAST_PTR (void, ThisThreadId)));
0357
0358                     return (AE_ALREADY_ACQUIRED);
0359                 }
0360
0361                 ACPI_ERROR ((AE_INFO,
0362                     "Invalid acquire order: Thread %p owns [%s], wants [%s]",
0363                     ACPI_CAST_PTR (void, ThisThreadId), AcpiUtGetMutexName (i),
0364                     AcpiUtGetMutexName (MutexId)));
0365
0366                 return (AE_ACQUIRE_DEADLOCK);
0367             }
0368         }
0369     }
0370 #endif
0371
0372     ACPI_DEBUG_PRINT ((ACPI_DB_MUTEX,
0373         "Thread %p attempting to acquire Mutex [%s]\n",
0374         ACPI_CAST_PTR (void, ThisThreadId), AcpiUtGetMutexName (MutexId)));
0375
0376     Status = AcpiOsAcquireMutex (AcpiGbl_MutexInfo[MutexId].Mutex,
0377                 ACPI_WAIT_FOREVER);
0378     if (ACPI_SUCCESS (Status))
0379     {
0380         ACPI_DEBUG_PRINT ((ACPI_DB_MUTEX, "Thread %p acquired Mutex [%s]\n",
0381             ACPI_CAST_PTR (void, ThisThreadId), AcpiUtGetMutexName (MutexId)));
0382
0383         AcpiGbl_MutexInfo[MutexId].UseCount++;
0384         AcpiGbl_MutexInfo[MutexId].ThreadId = ThisThreadId;
0385     }
0386     else
0387     {
0388         ACPI_EXCEPTION ((AE_INFO, Status,
0389             "Thread %p could not acquire Mutex [%X]",
0390             ACPI_CAST_PTR (void, ThisThreadId), MutexId));
0391     }
0392
0393     return (Status);
0394 }
0395
0396
0397 /*******************************************************************************
0398  *
0399  * FUNCTION:    AcpiUtReleaseMutex
0400  *
0401  * PARAMETERS:  MutexID         - ID of the mutex to be released
0402  *
0403  * RETURN:      Status
0404  *
0405  * DESCRIPTION: Release a mutex object.
0406  *
0407  ******************************************************************************/
0408
0409 ACPI_STATUS
0410 AcpiUtReleaseMutex (
0411     ACPI_MUTEX_HANDLE       MutexId)
0412 {
0413     ACPI_THREAD_ID          ThisThreadId;
0414
0415
0416     ACPI_FUNCTION_NAME (UtReleaseMutex);
0417
0418
0419     ThisThreadId = AcpiOsGetThreadId ();
0420     ACPI_DEBUG_PRINT ((ACPI_DB_MUTEX, "Thread %p releasing Mutex [%s]\n",
0421         ACPI_CAST_PTR (void, ThisThreadId), AcpiUtGetMutexName (MutexId)));
0422
0423     if (MutexId > ACPI_MAX_MUTEX)
0424     {
0425         return (AE_BAD_PARAMETER);
0426     }
0427
0428     /*
0429      * Mutex must be acquired in order to release it!
0430      */
0431     if (AcpiGbl_MutexInfo[MutexId].ThreadId == ACPI_MUTEX_NOT_ACQUIRED)
0432     {
0433         ACPI_ERROR ((AE_INFO,
0434             "Mutex [%X] is not acquired, cannot release", MutexId));
0435
0436         return (AE_NOT_ACQUIRED);
0437     }
0438
0439 #ifdef ACPI_MUTEX_DEBUG
0440     {
0441         UINT32                  i;
0442         /*
0443          * Mutex debug code, for internal debugging only.
0444          *
0445          * Deadlock prevention.  Check if this thread owns any mutexes of value
0446          * greater than this one.  If so, the thread has violated the mutex
0447          * ordering rule.  This indicates a coding error somewhere in
0448          * the ACPI subsystem code.
0449          */
0450         for (i = MutexId; i < ACPI_NUM_MUTEX; i++)
0451         {
0452             if (AcpiGbl_MutexInfo[i].ThreadId == ThisThreadId)
0453             {
0454                 if (i == MutexId)
0455                 {
0456                     continue;
0457                 }
0458
0459                 ACPI_ERROR ((AE_INFO,
0460                     "Invalid release order: owns [%s], releasing [%s]",
0461                     AcpiUtGetMutexName (i), AcpiUtGetMutexName (MutexId)));
0462
0463                 return (AE_RELEASE_DEADLOCK);
0464             }
0465         }
0466     }
0467 #endif
0468
0469     /* Mark unlocked FIRST */
0470
0471     AcpiGbl_MutexInfo[MutexId].ThreadId = ACPI_MUTEX_NOT_ACQUIRED;
0472
0473     AcpiOsReleaseMutex (AcpiGbl_MutexInfo[MutexId].Mutex);
0474     return (AE_OK);
0475 }
0476
0477