sys/contrib/dev/acpica/exmutex.c

   1
   2 /******************************************************************************
   3  *
   4  * Module Name: exmutex - ASL Mutex Acquire/Release functions
   5  *              $Revision: 18 $
   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 /* $DragonFly: src/sys/contrib/dev/acpica/Attic/exmutex.c,v 1.1 2003/09/24 03:32:16 drhodus Exp $                                                               */
 118
 119 #define __EXMUTEX_C__
 120
 121 #include "acpi.h"
 122 #include "acinterp.h"
 123
 124 #define _COMPONENT          ACPI_EXECUTER
 125         ACPI_MODULE_NAME    ("exmutex")
 126
 127
 128 /*******************************************************************************
 129  *
 130  * FUNCTION:    AcpiExUnlinkMutex
 131  *
 132  * PARAMETERS:  *ObjDesc            - The mutex to be unlinked
 133  *
 134  * RETURN:      Status
 135  *
 136  * DESCRIPTION: Remove a mutex from the "AcquiredMutex" list
 137  *
 138  ******************************************************************************/
 139
 140 void
 141 AcpiExUnlinkMutex (
 142     ACPI_OPERAND_OBJECT     *ObjDesc)
 143 {
 144     ACPI_THREAD_STATE       *Thread = ObjDesc->Mutex.OwnerThread;
 145
 146
 147     if (!Thread)
 148     {
 149         return;
 150     }
 151
 152     if (ObjDesc->Mutex.Next)
 153     {
 154         (ObjDesc->Mutex.Next)->Mutex.Prev = ObjDesc->Mutex.Prev;
 155     }
 156
 157     if (ObjDesc->Mutex.Prev)
 158     {
 159         (ObjDesc->Mutex.Prev)->Mutex.Next = ObjDesc->Mutex.Next;
 160     }
 161     else
 162     {
 163         Thread->AcquiredMutexList = ObjDesc->Mutex.Next;
 164     }
 165 }
 166
 167
 168 /*******************************************************************************
 169  *
 170  * FUNCTION:    AcpiExLinkMutex
 171  *
 172  * PARAMETERS:  *ObjDesc            - The mutex to be linked
 173  *              *ListHead           - head of the "AcquiredMutex" list
 174  *
 175  * RETURN:      Status
 176  *
 177  * DESCRIPTION: Add a mutex to the "AcquiredMutex" list for this walk
 178  *
 179  ******************************************************************************/
 180
 181 void
 182 AcpiExLinkMutex (
 183     ACPI_OPERAND_OBJECT     *ObjDesc,
 184     ACPI_THREAD_STATE       *Thread)
 185 {
 186     ACPI_OPERAND_OBJECT     *ListHead;
 187
 188
 189     ListHead = Thread->AcquiredMutexList;
 190
 191     /* This object will be the first object in the list */
 192
 193     ObjDesc->Mutex.Prev = NULL;
 194     ObjDesc->Mutex.Next = ListHead;
 195
 196     /* Update old first object to point back to this object */
 197
 198     if (ListHead)
 199     {
 200         ListHead->Mutex.Prev = ObjDesc;
 201     }
 202
 203     /* Update list head */
 204
 205     Thread->AcquiredMutexList = ObjDesc;
 206 }
 207
 208
 209 /*******************************************************************************
 210  *
 211  * FUNCTION:    AcpiExAcquireMutex
 212  *
 213  * PARAMETERS:  *TimeDesc           - The 'time to delay' object descriptor
 214  *              *ObjDesc            - The object descriptor for this op
 215  *
 216  * RETURN:      Status
 217  *
 218  * DESCRIPTION: Acquire an AML mutex
 219  *
 220  ******************************************************************************/
 221
 222 ACPI_STATUS
 223 AcpiExAcquireMutex (
 224     ACPI_OPERAND_OBJECT     *TimeDesc,
 225     ACPI_OPERAND_OBJECT     *ObjDesc,
 226     ACPI_WALK_STATE         *WalkState)
 227 {
 228     ACPI_STATUS             Status;
 229
 230
 231     ACPI_FUNCTION_TRACE_PTR ("ExAcquireMutex", ObjDesc);
 232
 233
 234     if (!ObjDesc)
 235     {
 236         return_ACPI_STATUS (AE_BAD_PARAMETER);
 237     }
 238
 239     /* Sanity check -- we must have a valid thread ID */
 240
 241     if (!WalkState->Thread)
 242     {
 243         ACPI_REPORT_ERROR (("Cannot acquire Mutex [%4.4s], null thread info\n",
 244                 ObjDesc->Mutex.Node->Name.Ascii));
 245         return_ACPI_STATUS (AE_AML_INTERNAL);
 246     }
 247
 248     /*
 249      * Current Sync must be less than or equal to the sync level of the
 250      * mutex.  This mechanism provides some deadlock prevention
 251      */
 252     if (WalkState->Thread->CurrentSyncLevel > ObjDesc->Mutex.SyncLevel)
 253     {
 254         ACPI_REPORT_ERROR (("Cannot acquire Mutex [%4.4s], incorrect SyncLevel\n",
 255                 ObjDesc->Mutex.Node->Name.Ascii));
 256         return_ACPI_STATUS (AE_AML_MUTEX_ORDER);
 257     }
 258
 259     /*
 260      * Support for multiple acquires by the owning thread
 261      */
 262
 263     if ((ObjDesc->Mutex.OwnerThread) &&
 264         (ObjDesc->Mutex.OwnerThread->ThreadId == WalkState->Thread->ThreadId))
 265     {
 266         /*
 267          * The mutex is already owned by this thread,
 268          * just increment the acquisition depth
 269          */
 270         ObjDesc->Mutex.AcquisitionDepth++;
 271         return_ACPI_STATUS (AE_OK);
 272     }
 273
 274     /* Acquire the mutex, wait if necessary */
 275
 276     Status = AcpiExSystemAcquireMutex (TimeDesc, ObjDesc);
 277     if (ACPI_FAILURE (Status))
 278     {
 279         /* Includes failure from a timeout on TimeDesc */
 280
 281         return_ACPI_STATUS (Status);
 282     }
 283
 284     /* Have the mutex, update mutex and walk info */
 285
 286     ObjDesc->Mutex.OwnerThread      = WalkState->Thread;
 287     ObjDesc->Mutex.AcquisitionDepth = 1;
 288
 289     WalkState->Thread->CurrentSyncLevel = ObjDesc->Mutex.SyncLevel;
 290
 291     /* Link the mutex to the current thread for force-unlock at method exit */
 292
 293     AcpiExLinkMutex (ObjDesc, WalkState->Thread);
 294
 295     return_ACPI_STATUS (AE_OK);
 296 }
 297
 298
 299 /*******************************************************************************
 300  *
 301  * FUNCTION:    AcpiExReleaseMutex
 302  *
 303  * PARAMETERS:  *ObjDesc            - The object descriptor for this op
 304  *
 305  * RETURN:      Status
 306  *
 307  * DESCRIPTION: Release a previously acquired Mutex.
 308  *
 309  ******************************************************************************/
 310
 311 ACPI_STATUS
 312 AcpiExReleaseMutex (
 313     ACPI_OPERAND_OBJECT     *ObjDesc,
 314     ACPI_WALK_STATE         *WalkState)
 315 {
 316     ACPI_STATUS             Status;
 317
 318
 319     ACPI_FUNCTION_TRACE ("ExReleaseMutex");
 320
 321
 322     if (!ObjDesc)
 323     {
 324         return_ACPI_STATUS (AE_BAD_PARAMETER);
 325     }
 326
 327     /* The mutex must have been previously acquired in order to release it */
 328
 329     if (!ObjDesc->Mutex.OwnerThread)
 330     {
 331         ACPI_REPORT_ERROR (("Cannot release Mutex [%4.4s], not acquired\n",
 332                 ObjDesc->Mutex.Node->Name.Ascii));
 333         return_ACPI_STATUS (AE_AML_MUTEX_NOT_ACQUIRED);
 334     }
 335
 336     /* Sanity check -- we must have a valid thread ID */
 337
 338     if (!WalkState->Thread)
 339     {
 340         ACPI_REPORT_ERROR (("Cannot release Mutex [%4.4s], null thread info\n",
 341                 ObjDesc->Mutex.Node->Name.Ascii));
 342         return_ACPI_STATUS (AE_AML_INTERNAL);
 343     }
 344
 345     /* The Mutex is owned, but this thread must be the owner */
 346
 347     if (ObjDesc->Mutex.OwnerThread->ThreadId != WalkState->Thread->ThreadId)
 348     {
 349         ACPI_REPORT_ERROR ((
 350             "Thread %X cannot release Mutex [%4.4s] acquired by thread %X\n",
 351             WalkState->Thread->ThreadId,
 352             ObjDesc->Mutex.Node->Name.Ascii,
 353             ObjDesc->Mutex.OwnerThread->ThreadId));
 354         return_ACPI_STATUS (AE_AML_NOT_OWNER);
 355     }
 356
 357     /*
 358      * The sync level of the mutex must be less than or
 359      * equal to the current sync level
 360      */
 361     if (ObjDesc->Mutex.SyncLevel > WalkState->Thread->CurrentSyncLevel)
 362     {
 363         ACPI_REPORT_ERROR (("Cannot release Mutex [%4.4s], incorrect SyncLevel\n",
 364                 ObjDesc->Mutex.Node->Name.Ascii));
 365         return_ACPI_STATUS (AE_AML_MUTEX_ORDER);
 366     }
 367
 368     /*
 369      * Match multiple Acquires with multiple Releases
 370      */
 371     ObjDesc->Mutex.AcquisitionDepth--;
 372     if (ObjDesc->Mutex.AcquisitionDepth != 0)
 373     {
 374         /* Just decrement the depth and return */
 375
 376         return_ACPI_STATUS (AE_OK);
 377     }
 378
 379     /* Unlink the mutex from the owner's list */
 380
 381     AcpiExUnlinkMutex (ObjDesc);
 382
 383     /* Release the mutex */
 384
 385     Status = AcpiExSystemReleaseMutex (ObjDesc);
 386
 387     /* Update the mutex and walk state */
 388
 389     ObjDesc->Mutex.OwnerThread = NULL;
 390     WalkState->Thread->CurrentSyncLevel = ObjDesc->Mutex.SyncLevel;
 391
 392     return_ACPI_STATUS (Status);
 393 }
 394
 395
 396 /*******************************************************************************
 397  *
 398  * FUNCTION:    AcpiExReleaseAllMutexes
 399  *
 400  * PARAMETERS:  *MutexList            - Head of the mutex list
 401  *
 402  * RETURN:      Status
 403  *
 404  * DESCRIPTION: Release all mutexes in the list
 405  *
 406  ******************************************************************************/
 407
 408 void
 409 AcpiExReleaseAllMutexes (
 410     ACPI_THREAD_STATE       *Thread)
 411 {
 412     ACPI_OPERAND_OBJECT     *Next = Thread->AcquiredMutexList;
 413     ACPI_OPERAND_OBJECT     *This;
 414     ACPI_STATUS             Status;
 415
 416
 417     ACPI_FUNCTION_ENTRY ();
 418
 419
 420     /*
 421      * Traverse the list of owned mutexes, releasing each one.
 422      */
 423     while (Next)
 424     {
 425         This = Next;
 426         Next = This->Mutex.Next;
 427
 428         This->Mutex.AcquisitionDepth = 1;
 429         This->Mutex.Prev             = NULL;
 430         This->Mutex.Next             = NULL;
 431
 432          /* Release the mutex */
 433
 434         Status = AcpiExSystemReleaseMutex (This);
 435         if (ACPI_FAILURE (Status))
 436         {
 437             continue;
 438         }
 439
 440         /* Mark mutex unowned */
 441
 442         This->Mutex.OwnerThread      = NULL;
 443     }
 444 }
 445
 446