sys/contrib/dev/acpica-unix-20031203/interpreter/executer/exmutex.c

   1
   2 /******************************************************************************
   3  *
   4  * Module Name: exmutex - ASL Mutex Acquire/Release functions
   5  *              $Revision: 19 $
   6  *
   7  *****************************************************************************/
   8
   9 /******************************************************************************
  10  *
  11  * 1. Copyright Notice
  12  *
  13  * Some or all of this work - Copyright (c) 1999 - 2003, Intel Corp.
  14  * All rights reserved.
  15  *
  16  * 2. License
  17  *
  18  * 2.1. This is your license from Intel Corp. under its intellectual property
  19  * rights.  You may have additional license terms from the party that provided
  20  * you this software, covering your right to use that party's intellectual
  21  * property rights.
  22  *
  23  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  24  * copy of the source code appearing in this file ("Covered Code") an
  25  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  26  * base code distributed originally by Intel ("Original Intel Code") to copy,
  27  * make derivatives, distribute, use and display any portion of the Covered
  28  * Code in any form, with the right to sublicense such rights; and
  29  *
  30  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  31  * license (with the right to sublicense), under only those claims of Intel
  32  * patents that are infringed by the Original Intel Code, to make, use, sell,
  33  * offer to sell, and import the Covered Code and derivative works thereof
  34  * solely to the minimum extent necessary to exercise the above copyright
  35  * license, and in no event shall the patent license extend to any additions
  36  * to or modifications of the Original Intel Code.  No other license or right
  37  * is granted directly or by implication, estoppel or otherwise;
  38  *
  39  * The above copyright and patent license is granted only if the following
  40  * conditions are met:
  41  *
  42  * 3. Conditions
  43  *
  44  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  45  * Redistribution of source code of any substantial portion of the Covered
  46  * Code or modification with rights to further distribute source must include
  47  * the above Copyright Notice, the above License, this list of Conditions,
  48  * and the following Disclaimer and Export Compliance provision.  In addition,
  49  * Licensee must cause all Covered Code to which Licensee contributes to
  50  * contain a file documenting the changes Licensee made to create that Covered
  51  * Code and the date of any change.  Licensee must include in that file the
  52  * documentation of any changes made by any predecessor Licensee.  Licensee
  53  * must include a prominent statement that the modification is derived,
  54  * directly or indirectly, from Original Intel Code.
  55  *
  56  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  57  * Redistribution of source code of any substantial portion of the Covered
  58  * Code or modification without rights to further distribute source must
  59  * include the following Disclaimer and Export Compliance provision in the
  60  * documentation and/or other materials provided with distribution.  In
  61  * addition, Licensee may not authorize further sublicense of source of any
  62  * portion of the Covered Code, and must include terms to the effect that the
  63  * license from Licensee to its licensee is limited to the intellectual
  64  * property embodied in the software Licensee provides to its licensee, and
  65  * not to intellectual property embodied in modifications its licensee may
  66  * make.
  67  *
  68  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  69  * substantial portion of the Covered Code or modification must reproduce the
  70  * above Copyright Notice, and the following Disclaimer and Export Compliance
  71  * provision in the documentation and/or other materials provided with the
  72  * distribution.
  73  *
  74  * 3.4. Intel retains all right, title, and interest in and to the Original
  75  * Intel Code.
  76  *
  77  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  78  * Intel shall be used in advertising or otherwise to promote the sale, use or
  79  * other dealings in products derived from or relating to the Covered Code
  80  * without prior written authorization from Intel.
  81  *
  82  * 4. Disclaimer and Export Compliance
  83  *
  84  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  85  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  86  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
  87  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
  88  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
  89  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  90  * PARTICULAR PURPOSE.
  91  *
  92  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  93  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  94  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  95  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  96  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  97  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
  98  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  99  * LIMITED REMEDY.
 100  *
 101  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 102  * software or system incorporating such software without first obtaining any
 103  * required license or other approval from the U. S. Department of Commerce or
 104  * any other agency or department of the United States Government.  In the
 105  * event Licensee exports any such software from the United States or
 106  * re-exports any such software from a foreign destination, Licensee shall
 107  * ensure that the distribution and export/re-export of the software is in
 108  * compliance with all laws, regulations, orders, or other restrictions of the
 109  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 110  * any of its subsidiaries will export/re-export any technical data, process,
 111  * software, or service, directly or indirectly, to any country for which the
 112  * United States government or any agency thereof requires an export license,
 113  * other governmental approval, or letter of assurance, without first obtaining
 114  * such license, approval or letter.
 115  *
 116  *****************************************************************************/
 117
 118 #define __EXMUTEX_C__
 119
 120 #include "acpi.h"
 121 #include "acinterp.h"
 122
 123 #define _COMPONENT          ACPI_EXECUTER
 124         ACPI_MODULE_NAME    ("exmutex")
 125
 126
 127 /*******************************************************************************
 128  *
 129  * FUNCTION:    AcpiExUnlinkMutex
 130  *
 131  * PARAMETERS:  *ObjDesc            - The mutex to be unlinked
 132  *
 133  * RETURN:      Status
 134  *
 135  * DESCRIPTION: Remove a mutex from the "AcquiredMutex" list
 136  *
 137  ******************************************************************************/
 138
 139 void
 140 AcpiExUnlinkMutex (
 141     ACPI_OPERAND_OBJECT     *ObjDesc)
 142 {
 143     ACPI_THREAD_STATE       *Thread = ObjDesc->Mutex.OwnerThread;
 144
 145
 146     if (!Thread)
 147     {
 148         return;
 149     }
 150
 151     if (ObjDesc->Mutex.Next)
 152     {
 153         (ObjDesc->Mutex.Next)->Mutex.Prev = ObjDesc->Mutex.Prev;
 154     }
 155
 156     if (ObjDesc->Mutex.Prev)
 157     {
 158         (ObjDesc->Mutex.Prev)->Mutex.Next = ObjDesc->Mutex.Next;
 159     }
 160     else
 161     {
 162         Thread->AcquiredMutexList = ObjDesc->Mutex.Next;
 163     }
 164 }
 165
 166
 167 /*******************************************************************************
 168  *
 169  * FUNCTION:    AcpiExLinkMutex
 170  *
 171  * PARAMETERS:  *ObjDesc            - The mutex to be linked
 172  *              *ListHead           - head of the "AcquiredMutex" list
 173  *
 174  * RETURN:      Status
 175  *
 176  * DESCRIPTION: Add a mutex to the "AcquiredMutex" list for this walk
 177  *
 178  ******************************************************************************/
 179
 180 void
 181 AcpiExLinkMutex (
 182     ACPI_OPERAND_OBJECT     *ObjDesc,
 183     ACPI_THREAD_STATE       *Thread)
 184 {
 185     ACPI_OPERAND_OBJECT     *ListHead;
 186
 187
 188     ListHead = Thread->AcquiredMutexList;
 189
 190     /* This object will be the first object in the list */
 191
 192     ObjDesc->Mutex.Prev = NULL;
 193     ObjDesc->Mutex.Next = ListHead;
 194
 195     /* Update old first object to point back to this object */
 196
 197     if (ListHead)
 198     {
 199         ListHead->Mutex.Prev = ObjDesc;
 200     }
 201
 202     /* Update list head */
 203
 204     Thread->AcquiredMutexList = ObjDesc;
 205 }
 206
 207
 208 /*******************************************************************************
 209  *
 210  * FUNCTION:    AcpiExAcquireMutex
 211  *
 212  * PARAMETERS:  *TimeDesc           - The 'time to delay' object descriptor
 213  *              *ObjDesc            - The object descriptor for this op
 214  *
 215  * RETURN:      Status
 216  *
 217  * DESCRIPTION: Acquire an AML mutex
 218  *
 219  ******************************************************************************/
 220
 221 ACPI_STATUS
 222 AcpiExAcquireMutex (
 223     ACPI_OPERAND_OBJECT     *TimeDesc,
 224     ACPI_OPERAND_OBJECT     *ObjDesc,
 225     ACPI_WALK_STATE         *WalkState)
 226 {
 227     ACPI_STATUS             Status;
 228
 229
 230     ACPI_FUNCTION_TRACE_PTR ("ExAcquireMutex", ObjDesc);
 231
 232
 233     if (!ObjDesc)
 234     {
 235         return_ACPI_STATUS (AE_BAD_PARAMETER);
 236     }
 237
 238     /* Sanity check -- we must have a valid thread ID */
 239
 240     if (!WalkState->Thread)
 241     {
 242         ACPI_REPORT_ERROR (("Cannot acquire Mutex [%4.4s], null thread info\n",
 243                 AcpiUtGetNodeName (ObjDesc->Mutex.Node)));
 244         return_ACPI_STATUS (AE_AML_INTERNAL);
 245     }
 246
 247     /*
 248      * Current Sync must be less than or equal to the sync level of the
 249      * mutex.  This mechanism provides some deadlock prevention
 250      */
 251     if (WalkState->Thread->CurrentSyncLevel > ObjDesc->Mutex.SyncLevel)
 252     {
 253         ACPI_REPORT_ERROR (("Cannot acquire Mutex [%4.4s], incorrect SyncLevel\n",
 254                 AcpiUtGetNodeName (ObjDesc->Mutex.Node)));
 255         return_ACPI_STATUS (AE_AML_MUTEX_ORDER);
 256     }
 257
 258     /*
 259      * Support for multiple acquires by the owning thread
 260      */
 261
 262     if ((ObjDesc->Mutex.OwnerThread) &&
 263         (ObjDesc->Mutex.OwnerThread->ThreadId == WalkState->Thread->ThreadId))
 264     {
 265         /*
 266          * The mutex is already owned by this thread,
 267          * just increment the acquisition depth
 268          */
 269         ObjDesc->Mutex.AcquisitionDepth++;
 270         return_ACPI_STATUS (AE_OK);
 271     }
 272
 273     /* Acquire the mutex, wait if necessary */
 274
 275     Status = AcpiExSystemAcquireMutex (TimeDesc, ObjDesc);
 276     if (ACPI_FAILURE (Status))
 277     {
 278         /* Includes failure from a timeout on TimeDesc */
 279
 280         return_ACPI_STATUS (Status);
 281     }
 282
 283     /* Have the mutex, update mutex and walk info */
 284
 285     ObjDesc->Mutex.OwnerThread      = WalkState->Thread;
 286     ObjDesc->Mutex.AcquisitionDepth = 1;
 287
 288     WalkState->Thread->CurrentSyncLevel = ObjDesc->Mutex.SyncLevel;
 289
 290     /* Link the mutex to the current thread for force-unlock at method exit */
 291
 292     AcpiExLinkMutex (ObjDesc, WalkState->Thread);
 293
 294     return_ACPI_STATUS (AE_OK);
 295 }
 296
 297
 298 /*******************************************************************************
 299  *
 300  * FUNCTION:    AcpiExReleaseMutex
 301  *
 302  * PARAMETERS:  *ObjDesc            - The object descriptor for this op
 303  *
 304  * RETURN:      Status
 305  *
 306  * DESCRIPTION: Release a previously acquired Mutex.
 307  *
 308  ******************************************************************************/
 309
 310 ACPI_STATUS
 311 AcpiExReleaseMutex (
 312     ACPI_OPERAND_OBJECT     *ObjDesc,
 313     ACPI_WALK_STATE         *WalkState)
 314 {
 315     ACPI_STATUS             Status;
 316
 317
 318     ACPI_FUNCTION_TRACE ("ExReleaseMutex");
 319
 320
 321     if (!ObjDesc)
 322     {
 323         return_ACPI_STATUS (AE_BAD_PARAMETER);
 324     }
 325
 326     /* The mutex must have been previously acquired in order to release it */
 327
 328     if (!ObjDesc->Mutex.OwnerThread)
 329     {
 330         ACPI_REPORT_ERROR (("Cannot release Mutex [%4.4s], not acquired\n",
 331                 AcpiUtGetNodeName (ObjDesc->Mutex.Node)));
 332         return_ACPI_STATUS (AE_AML_MUTEX_NOT_ACQUIRED);
 333     }
 334
 335     /* Sanity check -- we must have a valid thread ID */
 336
 337     if (!WalkState->Thread)
 338     {
 339         ACPI_REPORT_ERROR (("Cannot release Mutex [%4.4s], null thread info\n",
 340                 AcpiUtGetNodeName (ObjDesc->Mutex.Node)));
 341         return_ACPI_STATUS (AE_AML_INTERNAL);
 342     }
 343
 344     /* The Mutex is owned, but this thread must be the owner */
 345
 346     if (ObjDesc->Mutex.OwnerThread->ThreadId != WalkState->Thread->ThreadId)
 347     {
 348         ACPI_REPORT_ERROR ((
 349             "Thread %X cannot release Mutex [%4.4s] acquired by thread %X\n",
 350             WalkState->Thread->ThreadId,
 351             AcpiUtGetNodeName (ObjDesc->Mutex.Node),
 352             ObjDesc->Mutex.OwnerThread->ThreadId));
 353         return_ACPI_STATUS (AE_AML_NOT_OWNER);
 354     }
 355
 356     /*
 357      * The sync level of the mutex must be less than or
 358      * equal to the current sync level
 359      */
 360     if (ObjDesc->Mutex.SyncLevel > WalkState->Thread->CurrentSyncLevel)
 361     {
 362         ACPI_REPORT_ERROR (("Cannot release Mutex [%4.4s], incorrect SyncLevel\n",
 363                 AcpiUtGetNodeName (ObjDesc->Mutex.Node)));
 364         return_ACPI_STATUS (AE_AML_MUTEX_ORDER);
 365     }
 366
 367     /*
 368      * Match multiple Acquires with multiple Releases
 369      */
 370     ObjDesc->Mutex.AcquisitionDepth--;
 371     if (ObjDesc->Mutex.AcquisitionDepth != 0)
 372     {
 373         /* Just decrement the depth and return */
 374
 375         return_ACPI_STATUS (AE_OK);
 376     }
 377
 378     /* Unlink the mutex from the owner's list */
 379
 380     AcpiExUnlinkMutex (ObjDesc);
 381
 382     /* Release the mutex */
 383
 384     Status = AcpiExSystemReleaseMutex (ObjDesc);
 385
 386     /* Update the mutex and walk state */
 387
 388     ObjDesc->Mutex.OwnerThread = NULL;
 389     WalkState->Thread->CurrentSyncLevel = ObjDesc->Mutex.SyncLevel;
 390
 391     return_ACPI_STATUS (Status);
 392 }
 393
 394
 395 /*******************************************************************************
 396  *
 397  * FUNCTION:    AcpiExReleaseAllMutexes
 398  *
 399  * PARAMETERS:  *MutexList            - Head of the mutex list
 400  *
 401  * RETURN:      Status
 402  *
 403  * DESCRIPTION: Release all mutexes in the list
 404  *
 405  ******************************************************************************/
 406
 407 void
 408 AcpiExReleaseAllMutexes (
 409     ACPI_THREAD_STATE       *Thread)
 410 {
 411     ACPI_OPERAND_OBJECT     *Next = Thread->AcquiredMutexList;
 412     ACPI_OPERAND_OBJECT     *This;
 413     ACPI_STATUS             Status;
 414
 415
 416     ACPI_FUNCTION_ENTRY ();
 417
 418
 419     /*
 420      * Traverse the list of owned mutexes, releasing each one.
 421      */
 422     while (Next)
 423     {
 424         This = Next;
 425         Next = This->Mutex.Next;
 426
 427         This->Mutex.AcquisitionDepth = 1;
 428         This->Mutex.Prev             = NULL;
 429         This->Mutex.Next             = NULL;
 430
 431          /* Release the mutex */
 432
 433         Status = AcpiExSystemReleaseMutex (This);
 434         if (ACPI_FAILURE (Status))
 435         {
 436             continue;
 437         }
 438
 439         /* Mark mutex unowned */
 440
 441         This->Mutex.OwnerThread      = NULL;
 442     }
 443 }
 444
 445