Home | History | Annotate | Line # | Download | only in executer
exmutex.c revision 1.1.1.14
      1       1.1    jruoho /******************************************************************************
      2       1.1    jruoho  *
      3       1.1    jruoho  * Module Name: exmutex - ASL Mutex Acquire/Release functions
      4       1.1    jruoho  *
      5       1.1    jruoho  *****************************************************************************/
      6       1.1    jruoho 
      7  1.1.1.14  christos /******************************************************************************
      8  1.1.1.14  christos  *
      9  1.1.1.14  christos  * 1. Copyright Notice
     10  1.1.1.14  christos  *
     11  1.1.1.14  christos  * Some or all of this work - Copyright (c) 1999 - 2024, Intel Corp.
     12       1.1    jruoho  * All rights reserved.
     13       1.1    jruoho  *
     14  1.1.1.14  christos  * 2. License
     15  1.1.1.14  christos  *
     16  1.1.1.14  christos  * 2.1. This is your license from Intel Corp. under its intellectual property
     17  1.1.1.14  christos  * rights. You may have additional license terms from the party that provided
     18  1.1.1.14  christos  * you this software, covering your right to use that party's intellectual
     19  1.1.1.14  christos  * property rights.
     20  1.1.1.14  christos  *
     21  1.1.1.14  christos  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
     22  1.1.1.14  christos  * copy of the source code appearing in this file ("Covered Code") an
     23  1.1.1.14  christos  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
     24  1.1.1.14  christos  * base code distributed originally by Intel ("Original Intel Code") to copy,
     25  1.1.1.14  christos  * make derivatives, distribute, use and display any portion of the Covered
     26  1.1.1.14  christos  * Code in any form, with the right to sublicense such rights; and
     27  1.1.1.14  christos  *
     28  1.1.1.14  christos  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
     29  1.1.1.14  christos  * license (with the right to sublicense), under only those claims of Intel
     30  1.1.1.14  christos  * patents that are infringed by the Original Intel Code, to make, use, sell,
     31  1.1.1.14  christos  * offer to sell, and import the Covered Code and derivative works thereof
     32  1.1.1.14  christos  * solely to the minimum extent necessary to exercise the above copyright
     33  1.1.1.14  christos  * license, and in no event shall the patent license extend to any additions
     34  1.1.1.14  christos  * to or modifications of the Original Intel Code. No other license or right
     35  1.1.1.14  christos  * is granted directly or by implication, estoppel or otherwise;
     36  1.1.1.14  christos  *
     37  1.1.1.14  christos  * The above copyright and patent license is granted only if the following
     38  1.1.1.14  christos  * conditions are met:
     39  1.1.1.14  christos  *
     40  1.1.1.14  christos  * 3. Conditions
     41  1.1.1.14  christos  *
     42  1.1.1.14  christos  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
     43  1.1.1.14  christos  * Redistribution of source code of any substantial portion of the Covered
     44  1.1.1.14  christos  * Code or modification with rights to further distribute source must include
     45  1.1.1.14  christos  * the above Copyright Notice, the above License, this list of Conditions,
     46  1.1.1.14  christos  * and the following Disclaimer and Export Compliance provision. In addition,
     47  1.1.1.14  christos  * Licensee must cause all Covered Code to which Licensee contributes to
     48  1.1.1.14  christos  * contain a file documenting the changes Licensee made to create that Covered
     49  1.1.1.14  christos  * Code and the date of any change. Licensee must include in that file the
     50  1.1.1.14  christos  * documentation of any changes made by any predecessor Licensee. Licensee
     51  1.1.1.14  christos  * must include a prominent statement that the modification is derived,
     52  1.1.1.14  christos  * directly or indirectly, from Original Intel Code.
     53  1.1.1.14  christos  *
     54  1.1.1.14  christos  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
     55  1.1.1.14  christos  * Redistribution of source code of any substantial portion of the Covered
     56  1.1.1.14  christos  * Code or modification without rights to further distribute source must
     57  1.1.1.14  christos  * include the following Disclaimer and Export Compliance provision in the
     58  1.1.1.14  christos  * documentation and/or other materials provided with distribution. In
     59  1.1.1.14  christos  * addition, Licensee may not authorize further sublicense of source of any
     60  1.1.1.14  christos  * portion of the Covered Code, and must include terms to the effect that the
     61  1.1.1.14  christos  * license from Licensee to its licensee is limited to the intellectual
     62  1.1.1.14  christos  * property embodied in the software Licensee provides to its licensee, and
     63  1.1.1.14  christos  * not to intellectual property embodied in modifications its licensee may
     64  1.1.1.14  christos  * make.
     65  1.1.1.14  christos  *
     66  1.1.1.14  christos  * 3.3. Redistribution of Executable. Redistribution in executable form of any
     67  1.1.1.14  christos  * substantial portion of the Covered Code or modification must reproduce the
     68  1.1.1.14  christos  * above Copyright Notice, and the following Disclaimer and Export Compliance
     69  1.1.1.14  christos  * provision in the documentation and/or other materials provided with the
     70  1.1.1.14  christos  * distribution.
     71  1.1.1.14  christos  *
     72  1.1.1.14  christos  * 3.4. Intel retains all right, title, and interest in and to the Original
     73  1.1.1.14  christos  * Intel Code.
     74  1.1.1.14  christos  *
     75  1.1.1.14  christos  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
     76  1.1.1.14  christos  * Intel shall be used in advertising or otherwise to promote the sale, use or
     77  1.1.1.14  christos  * other dealings in products derived from or relating to the Covered Code
     78  1.1.1.14  christos  * without prior written authorization from Intel.
     79  1.1.1.14  christos  *
     80  1.1.1.14  christos  * 4. Disclaimer and Export Compliance
     81  1.1.1.14  christos  *
     82  1.1.1.14  christos  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
     83  1.1.1.14  christos  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
     84  1.1.1.14  christos  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
     85  1.1.1.14  christos  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
     86  1.1.1.14  christos  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
     87  1.1.1.14  christos  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
     88  1.1.1.14  christos  * PARTICULAR PURPOSE.
     89  1.1.1.14  christos  *
     90  1.1.1.14  christos  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
     91  1.1.1.14  christos  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
     92  1.1.1.14  christos  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
     93  1.1.1.14  christos  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
     94  1.1.1.14  christos  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
     95  1.1.1.14  christos  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
     96  1.1.1.14  christos  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
     97  1.1.1.14  christos  * LIMITED REMEDY.
     98  1.1.1.14  christos  *
     99  1.1.1.14  christos  * 4.3. Licensee shall not export, either directly or indirectly, any of this
    100  1.1.1.14  christos  * software or system incorporating such software without first obtaining any
    101  1.1.1.14  christos  * required license or other approval from the U. S. Department of Commerce or
    102  1.1.1.14  christos  * any other agency or department of the United States Government. In the
    103  1.1.1.14  christos  * event Licensee exports any such software from the United States or
    104  1.1.1.14  christos  * re-exports any such software from a foreign destination, Licensee shall
    105  1.1.1.14  christos  * ensure that the distribution and export/re-export of the software is in
    106  1.1.1.14  christos  * compliance with all laws, regulations, orders, or other restrictions of the
    107  1.1.1.14  christos  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
    108  1.1.1.14  christos  * any of its subsidiaries will export/re-export any technical data, process,
    109  1.1.1.14  christos  * software, or service, directly or indirectly, to any country for which the
    110  1.1.1.14  christos  * United States government or any agency thereof requires an export license,
    111  1.1.1.14  christos  * other governmental approval, or letter of assurance, without first obtaining
    112  1.1.1.14  christos  * such license, approval or letter.
    113  1.1.1.14  christos  *
    114  1.1.1.14  christos  *****************************************************************************
    115  1.1.1.14  christos  *
    116  1.1.1.14  christos  * Alternatively, you may choose to be licensed under the terms of the
    117  1.1.1.14  christos  * following license:
    118  1.1.1.14  christos  *
    119   1.1.1.2    jruoho  * Redistribution and use in source and binary forms, with or without
    120   1.1.1.2    jruoho  * modification, are permitted provided that the following conditions
    121   1.1.1.2    jruoho  * are met:
    122   1.1.1.2    jruoho  * 1. Redistributions of source code must retain the above copyright
    123   1.1.1.2    jruoho  *    notice, this list of conditions, and the following disclaimer,
    124   1.1.1.2    jruoho  *    without modification.
    125   1.1.1.2    jruoho  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
    126   1.1.1.2    jruoho  *    substantially similar to the "NO WARRANTY" disclaimer below
    127   1.1.1.2    jruoho  *    ("Disclaimer") and any redistribution must be conditioned upon
    128   1.1.1.2    jruoho  *    including a substantially similar Disclaimer requirement for further
    129   1.1.1.2    jruoho  *    binary redistribution.
    130   1.1.1.2    jruoho  * 3. Neither the names of the above-listed copyright holders nor the names
    131   1.1.1.2    jruoho  *    of any contributors may be used to endorse or promote products derived
    132   1.1.1.2    jruoho  *    from this software without specific prior written permission.
    133   1.1.1.2    jruoho  *
    134   1.1.1.2    jruoho  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
    135   1.1.1.2    jruoho  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
    136  1.1.1.11  christos  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
    137   1.1.1.2    jruoho  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
    138  1.1.1.14  christos  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
    139  1.1.1.14  christos  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
    140  1.1.1.14  christos  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
    141  1.1.1.14  christos  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
    142  1.1.1.14  christos  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
    143  1.1.1.14  christos  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
    144  1.1.1.14  christos  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    145  1.1.1.14  christos  *
    146  1.1.1.14  christos  * Alternatively, you may choose to be licensed under the terms of the
    147  1.1.1.14  christos  * GNU General Public License ("GPL") version 2 as published by the Free
    148  1.1.1.14  christos  * Software Foundation.
    149  1.1.1.14  christos  *
    150  1.1.1.14  christos  *****************************************************************************/
    151       1.1    jruoho 
    152       1.1    jruoho #include "acpi.h"
    153       1.1    jruoho #include "accommon.h"
    154       1.1    jruoho #include "acinterp.h"
    155       1.1    jruoho #include "acevents.h"
    156       1.1    jruoho 
    157       1.1    jruoho #define _COMPONENT          ACPI_EXECUTER
    158       1.1    jruoho         ACPI_MODULE_NAME    ("exmutex")
    159       1.1    jruoho 
    160       1.1    jruoho /* Local prototypes */
    161       1.1    jruoho 
    162       1.1    jruoho static void
    163       1.1    jruoho AcpiExLinkMutex (
    164       1.1    jruoho     ACPI_OPERAND_OBJECT     *ObjDesc,
    165       1.1    jruoho     ACPI_THREAD_STATE       *Thread);
    166       1.1    jruoho 
    167       1.1    jruoho 
    168       1.1    jruoho /*******************************************************************************
    169       1.1    jruoho  *
    170       1.1    jruoho  * FUNCTION:    AcpiExUnlinkMutex
    171       1.1    jruoho  *
    172       1.1    jruoho  * PARAMETERS:  ObjDesc             - The mutex to be unlinked
    173       1.1    jruoho  *
    174       1.1    jruoho  * RETURN:      None
    175       1.1    jruoho  *
    176       1.1    jruoho  * DESCRIPTION: Remove a mutex from the "AcquiredMutex" list
    177       1.1    jruoho  *
    178       1.1    jruoho  ******************************************************************************/
    179       1.1    jruoho 
    180       1.1    jruoho void
    181       1.1    jruoho AcpiExUnlinkMutex (
    182       1.1    jruoho     ACPI_OPERAND_OBJECT     *ObjDesc)
    183       1.1    jruoho {
    184       1.1    jruoho     ACPI_THREAD_STATE       *Thread = ObjDesc->Mutex.OwnerThread;
    185       1.1    jruoho 
    186       1.1    jruoho 
    187       1.1    jruoho     if (!Thread)
    188       1.1    jruoho     {
    189       1.1    jruoho         return;
    190       1.1    jruoho     }
    191       1.1    jruoho 
    192       1.1    jruoho     /* Doubly linked list */
    193       1.1    jruoho 
    194       1.1    jruoho     if (ObjDesc->Mutex.Next)
    195       1.1    jruoho     {
    196       1.1    jruoho         (ObjDesc->Mutex.Next)->Mutex.Prev = ObjDesc->Mutex.Prev;
    197       1.1    jruoho     }
    198       1.1    jruoho 
    199       1.1    jruoho     if (ObjDesc->Mutex.Prev)
    200       1.1    jruoho     {
    201       1.1    jruoho         (ObjDesc->Mutex.Prev)->Mutex.Next = ObjDesc->Mutex.Next;
    202       1.1    jruoho 
    203       1.1    jruoho         /*
    204       1.1    jruoho          * Migrate the previous sync level associated with this mutex to
    205       1.1    jruoho          * the previous mutex on the list so that it may be preserved.
    206       1.1    jruoho          * This handles the case where several mutexes have been acquired
    207       1.1    jruoho          * at the same level, but are not released in opposite order.
    208       1.1    jruoho          */
    209       1.1    jruoho         (ObjDesc->Mutex.Prev)->Mutex.OriginalSyncLevel =
    210       1.1    jruoho             ObjDesc->Mutex.OriginalSyncLevel;
    211       1.1    jruoho     }
    212       1.1    jruoho     else
    213       1.1    jruoho     {
    214       1.1    jruoho         Thread->AcquiredMutexList = ObjDesc->Mutex.Next;
    215       1.1    jruoho     }
    216       1.1    jruoho }
    217       1.1    jruoho 
    218       1.1    jruoho 
    219       1.1    jruoho /*******************************************************************************
    220       1.1    jruoho  *
    221       1.1    jruoho  * FUNCTION:    AcpiExLinkMutex
    222       1.1    jruoho  *
    223       1.1    jruoho  * PARAMETERS:  ObjDesc             - The mutex to be linked
    224       1.1    jruoho  *              Thread              - Current executing thread object
    225       1.1    jruoho  *
    226       1.1    jruoho  * RETURN:      None
    227       1.1    jruoho  *
    228       1.1    jruoho  * DESCRIPTION: Add a mutex to the "AcquiredMutex" list for this walk
    229       1.1    jruoho  *
    230       1.1    jruoho  ******************************************************************************/
    231       1.1    jruoho 
    232       1.1    jruoho static void
    233       1.1    jruoho AcpiExLinkMutex (
    234       1.1    jruoho     ACPI_OPERAND_OBJECT     *ObjDesc,
    235       1.1    jruoho     ACPI_THREAD_STATE       *Thread)
    236       1.1    jruoho {
    237       1.1    jruoho     ACPI_OPERAND_OBJECT     *ListHead;
    238       1.1    jruoho 
    239       1.1    jruoho 
    240       1.1    jruoho     ListHead = Thread->AcquiredMutexList;
    241       1.1    jruoho 
    242       1.1    jruoho     /* This object will be the first object in the list */
    243       1.1    jruoho 
    244       1.1    jruoho     ObjDesc->Mutex.Prev = NULL;
    245       1.1    jruoho     ObjDesc->Mutex.Next = ListHead;
    246       1.1    jruoho 
    247       1.1    jruoho     /* Update old first object to point back to this object */
    248       1.1    jruoho 
    249       1.1    jruoho     if (ListHead)
    250       1.1    jruoho     {
    251       1.1    jruoho         ListHead->Mutex.Prev = ObjDesc;
    252       1.1    jruoho     }
    253       1.1    jruoho 
    254       1.1    jruoho     /* Update list head */
    255       1.1    jruoho 
    256       1.1    jruoho     Thread->AcquiredMutexList = ObjDesc;
    257       1.1    jruoho }
    258       1.1    jruoho 
    259       1.1    jruoho 
    260       1.1    jruoho /*******************************************************************************
    261       1.1    jruoho  *
    262       1.1    jruoho  * FUNCTION:    AcpiExAcquireMutexObject
    263       1.1    jruoho  *
    264       1.1    jruoho  * PARAMETERS:  Timeout             - Timeout in milliseconds
    265       1.1    jruoho  *              ObjDesc             - Mutex object
    266       1.1    jruoho  *              ThreadId            - Current thread state
    267       1.1    jruoho  *
    268       1.1    jruoho  * RETURN:      Status
    269       1.1    jruoho  *
    270       1.1    jruoho  * DESCRIPTION: Acquire an AML mutex, low-level interface. Provides a common
    271       1.1    jruoho  *              path that supports multiple acquires by the same thread.
    272       1.1    jruoho  *
    273       1.1    jruoho  * MUTEX:       Interpreter must be locked
    274       1.1    jruoho  *
    275       1.1    jruoho  * NOTE: This interface is called from three places:
    276       1.1    jruoho  * 1) From AcpiExAcquireMutex, via an AML Acquire() operator
    277       1.1    jruoho  * 2) From AcpiExAcquireGlobalLock when an AML Field access requires the
    278       1.1    jruoho  *    global lock
    279       1.1    jruoho  * 3) From the external interface, AcpiAcquireGlobalLock
    280       1.1    jruoho  *
    281       1.1    jruoho  ******************************************************************************/
    282       1.1    jruoho 
    283       1.1    jruoho ACPI_STATUS
    284       1.1    jruoho AcpiExAcquireMutexObject (
    285       1.1    jruoho     UINT16                  Timeout,
    286       1.1    jruoho     ACPI_OPERAND_OBJECT     *ObjDesc,
    287       1.1    jruoho     ACPI_THREAD_ID          ThreadId)
    288       1.1    jruoho {
    289       1.1    jruoho     ACPI_STATUS             Status;
    290       1.1    jruoho 
    291       1.1    jruoho 
    292       1.1    jruoho     ACPI_FUNCTION_TRACE_PTR (ExAcquireMutexObject, ObjDesc);
    293       1.1    jruoho 
    294       1.1    jruoho 
    295       1.1    jruoho     if (!ObjDesc)
    296       1.1    jruoho     {
    297       1.1    jruoho         return_ACPI_STATUS (AE_BAD_PARAMETER);
    298       1.1    jruoho     }
    299       1.1    jruoho 
    300       1.1    jruoho     /* Support for multiple acquires by the owning thread */
    301       1.1    jruoho 
    302       1.1    jruoho     if (ObjDesc->Mutex.ThreadId == ThreadId)
    303       1.1    jruoho     {
    304       1.1    jruoho         /*
    305       1.1    jruoho          * The mutex is already owned by this thread, just increment the
    306       1.1    jruoho          * acquisition depth
    307       1.1    jruoho          */
    308       1.1    jruoho         ObjDesc->Mutex.AcquisitionDepth++;
    309       1.1    jruoho         return_ACPI_STATUS (AE_OK);
    310       1.1    jruoho     }
    311       1.1    jruoho 
    312       1.1    jruoho     /* Acquire the mutex, wait if necessary. Special case for Global Lock */
    313       1.1    jruoho 
    314       1.1    jruoho     if (ObjDesc == AcpiGbl_GlobalLockMutex)
    315       1.1    jruoho     {
    316       1.1    jruoho         Status = AcpiEvAcquireGlobalLock (Timeout);
    317       1.1    jruoho     }
    318       1.1    jruoho     else
    319       1.1    jruoho     {
    320   1.1.1.6  christos         Status = AcpiExSystemWaitMutex (ObjDesc->Mutex.OsMutex, Timeout);
    321       1.1    jruoho     }
    322       1.1    jruoho 
    323       1.1    jruoho     if (ACPI_FAILURE (Status))
    324       1.1    jruoho     {
    325       1.1    jruoho         /* Includes failure from a timeout on TimeDesc */
    326       1.1    jruoho 
    327       1.1    jruoho         return_ACPI_STATUS (Status);
    328       1.1    jruoho     }
    329       1.1    jruoho 
    330       1.1    jruoho     /* Acquired the mutex: update mutex object */
    331       1.1    jruoho 
    332       1.1    jruoho     ObjDesc->Mutex.ThreadId = ThreadId;
    333       1.1    jruoho     ObjDesc->Mutex.AcquisitionDepth = 1;
    334       1.1    jruoho     ObjDesc->Mutex.OriginalSyncLevel = 0;
    335       1.1    jruoho     ObjDesc->Mutex.OwnerThread = NULL;      /* Used only for AML Acquire() */
    336       1.1    jruoho 
    337       1.1    jruoho     return_ACPI_STATUS (AE_OK);
    338       1.1    jruoho }
    339       1.1    jruoho 
    340       1.1    jruoho 
    341       1.1    jruoho /*******************************************************************************
    342       1.1    jruoho  *
    343       1.1    jruoho  * FUNCTION:    AcpiExAcquireMutex
    344       1.1    jruoho  *
    345       1.1    jruoho  * PARAMETERS:  TimeDesc            - Timeout integer
    346       1.1    jruoho  *              ObjDesc             - Mutex object
    347       1.1    jruoho  *              WalkState           - Current method execution state
    348       1.1    jruoho  *
    349       1.1    jruoho  * RETURN:      Status
    350       1.1    jruoho  *
    351       1.1    jruoho  * DESCRIPTION: Acquire an AML mutex
    352       1.1    jruoho  *
    353       1.1    jruoho  ******************************************************************************/
    354       1.1    jruoho 
    355       1.1    jruoho ACPI_STATUS
    356       1.1    jruoho AcpiExAcquireMutex (
    357       1.1    jruoho     ACPI_OPERAND_OBJECT     *TimeDesc,
    358       1.1    jruoho     ACPI_OPERAND_OBJECT     *ObjDesc,
    359       1.1    jruoho     ACPI_WALK_STATE         *WalkState)
    360       1.1    jruoho {
    361       1.1    jruoho     ACPI_STATUS             Status;
    362       1.1    jruoho 
    363       1.1    jruoho 
    364       1.1    jruoho     ACPI_FUNCTION_TRACE_PTR (ExAcquireMutex, ObjDesc);
    365       1.1    jruoho 
    366       1.1    jruoho 
    367       1.1    jruoho     if (!ObjDesc)
    368       1.1    jruoho     {
    369       1.1    jruoho         return_ACPI_STATUS (AE_BAD_PARAMETER);
    370       1.1    jruoho     }
    371       1.1    jruoho 
    372       1.1    jruoho     /* Must have a valid thread state struct */
    373       1.1    jruoho 
    374       1.1    jruoho     if (!WalkState->Thread)
    375       1.1    jruoho     {
    376       1.1    jruoho         ACPI_ERROR ((AE_INFO,
    377       1.1    jruoho             "Cannot acquire Mutex [%4.4s], null thread info",
    378       1.1    jruoho             AcpiUtGetNodeName (ObjDesc->Mutex.Node)));
    379       1.1    jruoho         return_ACPI_STATUS (AE_AML_INTERNAL);
    380       1.1    jruoho     }
    381       1.1    jruoho 
    382       1.1    jruoho     /*
    383   1.1.1.6  christos      * Current sync level must be less than or equal to the sync level
    384   1.1.1.6  christos      * of the mutex. This mechanism provides some deadlock prevention.
    385       1.1    jruoho      */
    386       1.1    jruoho     if (WalkState->Thread->CurrentSyncLevel > ObjDesc->Mutex.SyncLevel)
    387       1.1    jruoho     {
    388       1.1    jruoho         ACPI_ERROR ((AE_INFO,
    389   1.1.1.6  christos             "Cannot acquire Mutex [%4.4s], "
    390   1.1.1.6  christos             "current SyncLevel is too large (%u)",
    391       1.1    jruoho             AcpiUtGetNodeName (ObjDesc->Mutex.Node),
    392       1.1    jruoho             WalkState->Thread->CurrentSyncLevel));
    393       1.1    jruoho         return_ACPI_STATUS (AE_AML_MUTEX_ORDER);
    394       1.1    jruoho     }
    395       1.1    jruoho 
    396   1.1.1.6  christos     ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
    397   1.1.1.6  christos         "Acquiring: Mutex SyncLevel %u, Thread SyncLevel %u, "
    398   1.1.1.6  christos         "Depth %u TID %p\n",
    399   1.1.1.6  christos         ObjDesc->Mutex.SyncLevel, WalkState->Thread->CurrentSyncLevel,
    400   1.1.1.6  christos         ObjDesc->Mutex.AcquisitionDepth, WalkState->Thread));
    401   1.1.1.6  christos 
    402       1.1    jruoho     Status = AcpiExAcquireMutexObject ((UINT16) TimeDesc->Integer.Value,
    403   1.1.1.6  christos         ObjDesc, WalkState->Thread->ThreadId);
    404   1.1.1.6  christos 
    405       1.1    jruoho     if (ACPI_SUCCESS (Status) && ObjDesc->Mutex.AcquisitionDepth == 1)
    406       1.1    jruoho     {
    407       1.1    jruoho         /* Save Thread object, original/current sync levels */
    408       1.1    jruoho 
    409       1.1    jruoho         ObjDesc->Mutex.OwnerThread = WalkState->Thread;
    410   1.1.1.6  christos         ObjDesc->Mutex.OriginalSyncLevel =
    411   1.1.1.6  christos             WalkState->Thread->CurrentSyncLevel;
    412   1.1.1.6  christos         WalkState->Thread->CurrentSyncLevel =
    413   1.1.1.6  christos             ObjDesc->Mutex.SyncLevel;
    414       1.1    jruoho 
    415       1.1    jruoho         /* Link the mutex to the current thread for force-unlock at method exit */
    416       1.1    jruoho 
    417       1.1    jruoho         AcpiExLinkMutex (ObjDesc, WalkState->Thread);
    418       1.1    jruoho     }
    419       1.1    jruoho 
    420   1.1.1.6  christos     ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
    421   1.1.1.6  christos         "Acquired: Mutex SyncLevel %u, Thread SyncLevel %u, Depth %u\n",
    422   1.1.1.6  christos         ObjDesc->Mutex.SyncLevel, WalkState->Thread->CurrentSyncLevel,
    423   1.1.1.6  christos         ObjDesc->Mutex.AcquisitionDepth));
    424   1.1.1.6  christos 
    425       1.1    jruoho     return_ACPI_STATUS (Status);
    426       1.1    jruoho }
    427       1.1    jruoho 
    428       1.1    jruoho 
    429       1.1    jruoho /*******************************************************************************
    430       1.1    jruoho  *
    431       1.1    jruoho  * FUNCTION:    AcpiExReleaseMutexObject
    432       1.1    jruoho  *
    433       1.1    jruoho  * PARAMETERS:  ObjDesc             - The object descriptor for this op
    434       1.1    jruoho  *
    435       1.1    jruoho  * RETURN:      Status
    436       1.1    jruoho  *
    437       1.1    jruoho  * DESCRIPTION: Release a previously acquired Mutex, low level interface.
    438       1.1    jruoho  *              Provides a common path that supports multiple releases (after
    439       1.1    jruoho  *              previous multiple acquires) by the same thread.
    440       1.1    jruoho  *
    441       1.1    jruoho  * MUTEX:       Interpreter must be locked
    442       1.1    jruoho  *
    443       1.1    jruoho  * NOTE: This interface is called from three places:
    444       1.1    jruoho  * 1) From AcpiExReleaseMutex, via an AML Acquire() operator
    445       1.1    jruoho  * 2) From AcpiExReleaseGlobalLock when an AML Field access requires the
    446       1.1    jruoho  *    global lock
    447       1.1    jruoho  * 3) From the external interface, AcpiReleaseGlobalLock
    448       1.1    jruoho  *
    449       1.1    jruoho  ******************************************************************************/
    450       1.1    jruoho 
    451       1.1    jruoho ACPI_STATUS
    452       1.1    jruoho AcpiExReleaseMutexObject (
    453       1.1    jruoho     ACPI_OPERAND_OBJECT     *ObjDesc)
    454       1.1    jruoho {
    455       1.1    jruoho     ACPI_STATUS             Status = AE_OK;
    456       1.1    jruoho 
    457       1.1    jruoho 
    458       1.1    jruoho     ACPI_FUNCTION_TRACE (ExReleaseMutexObject);
    459       1.1    jruoho 
    460       1.1    jruoho 
    461       1.1    jruoho     if (ObjDesc->Mutex.AcquisitionDepth == 0)
    462       1.1    jruoho     {
    463   1.1.1.3  christos         return_ACPI_STATUS (AE_NOT_ACQUIRED);
    464       1.1    jruoho     }
    465       1.1    jruoho 
    466       1.1    jruoho     /* Match multiple Acquires with multiple Releases */
    467       1.1    jruoho 
    468       1.1    jruoho     ObjDesc->Mutex.AcquisitionDepth--;
    469       1.1    jruoho     if (ObjDesc->Mutex.AcquisitionDepth != 0)
    470       1.1    jruoho     {
    471       1.1    jruoho         /* Just decrement the depth and return */
    472       1.1    jruoho 
    473       1.1    jruoho         return_ACPI_STATUS (AE_OK);
    474       1.1    jruoho     }
    475       1.1    jruoho 
    476       1.1    jruoho     if (ObjDesc->Mutex.OwnerThread)
    477       1.1    jruoho     {
    478       1.1    jruoho         /* Unlink the mutex from the owner's list */
    479       1.1    jruoho 
    480       1.1    jruoho         AcpiExUnlinkMutex (ObjDesc);
    481       1.1    jruoho         ObjDesc->Mutex.OwnerThread = NULL;
    482       1.1    jruoho     }
    483       1.1    jruoho 
    484       1.1    jruoho     /* Release the mutex, special case for Global Lock */
    485       1.1    jruoho 
    486       1.1    jruoho     if (ObjDesc == AcpiGbl_GlobalLockMutex)
    487       1.1    jruoho     {
    488       1.1    jruoho         Status = AcpiEvReleaseGlobalLock ();
    489       1.1    jruoho     }
    490       1.1    jruoho     else
    491       1.1    jruoho     {
    492       1.1    jruoho         AcpiOsReleaseMutex (ObjDesc->Mutex.OsMutex);
    493       1.1    jruoho     }
    494       1.1    jruoho 
    495       1.1    jruoho     /* Clear mutex info */
    496       1.1    jruoho 
    497       1.1    jruoho     ObjDesc->Mutex.ThreadId = 0;
    498       1.1    jruoho     return_ACPI_STATUS (Status);
    499       1.1    jruoho }
    500       1.1    jruoho 
    501       1.1    jruoho 
    502       1.1    jruoho /*******************************************************************************
    503       1.1    jruoho  *
    504       1.1    jruoho  * FUNCTION:    AcpiExReleaseMutex
    505       1.1    jruoho  *
    506       1.1    jruoho  * PARAMETERS:  ObjDesc             - The object descriptor for this op
    507       1.1    jruoho  *              WalkState           - Current method execution state
    508       1.1    jruoho  *
    509       1.1    jruoho  * RETURN:      Status
    510       1.1    jruoho  *
    511       1.1    jruoho  * DESCRIPTION: Release a previously acquired Mutex.
    512       1.1    jruoho  *
    513       1.1    jruoho  ******************************************************************************/
    514       1.1    jruoho 
    515       1.1    jruoho ACPI_STATUS
    516       1.1    jruoho AcpiExReleaseMutex (
    517       1.1    jruoho     ACPI_OPERAND_OBJECT     *ObjDesc,
    518       1.1    jruoho     ACPI_WALK_STATE         *WalkState)
    519       1.1    jruoho {
    520       1.1    jruoho     UINT8                   PreviousSyncLevel;
    521       1.1    jruoho     ACPI_THREAD_STATE       *OwnerThread;
    522   1.1.1.6  christos     ACPI_STATUS             Status = AE_OK;
    523       1.1    jruoho 
    524       1.1    jruoho 
    525       1.1    jruoho     ACPI_FUNCTION_TRACE (ExReleaseMutex);
    526       1.1    jruoho 
    527       1.1    jruoho 
    528       1.1    jruoho     if (!ObjDesc)
    529       1.1    jruoho     {
    530       1.1    jruoho         return_ACPI_STATUS (AE_BAD_PARAMETER);
    531       1.1    jruoho     }
    532       1.1    jruoho 
    533       1.1    jruoho     OwnerThread = ObjDesc->Mutex.OwnerThread;
    534       1.1    jruoho 
    535       1.1    jruoho     /* The mutex must have been previously acquired in order to release it */
    536       1.1    jruoho 
    537       1.1    jruoho     if (!OwnerThread)
    538       1.1    jruoho     {
    539       1.1    jruoho         ACPI_ERROR ((AE_INFO,
    540       1.1    jruoho             "Cannot release Mutex [%4.4s], not acquired",
    541       1.1    jruoho             AcpiUtGetNodeName (ObjDesc->Mutex.Node)));
    542       1.1    jruoho         return_ACPI_STATUS (AE_AML_MUTEX_NOT_ACQUIRED);
    543       1.1    jruoho     }
    544       1.1    jruoho 
    545       1.1    jruoho     /* Must have a valid thread ID */
    546       1.1    jruoho 
    547       1.1    jruoho     if (!WalkState->Thread)
    548       1.1    jruoho     {
    549       1.1    jruoho         ACPI_ERROR ((AE_INFO,
    550       1.1    jruoho             "Cannot release Mutex [%4.4s], null thread info",
    551       1.1    jruoho             AcpiUtGetNodeName (ObjDesc->Mutex.Node)));
    552       1.1    jruoho         return_ACPI_STATUS (AE_AML_INTERNAL);
    553       1.1    jruoho     }
    554       1.1    jruoho 
    555       1.1    jruoho     /*
    556       1.1    jruoho      * The Mutex is owned, but this thread must be the owner.
    557       1.1    jruoho      * Special case for Global Lock, any thread can release
    558       1.1    jruoho      */
    559       1.1    jruoho     if ((OwnerThread->ThreadId != WalkState->Thread->ThreadId) &&
    560       1.1    jruoho         (ObjDesc != AcpiGbl_GlobalLockMutex))
    561       1.1    jruoho     {
    562       1.1    jruoho         ACPI_ERROR ((AE_INFO,
    563   1.1.1.2    jruoho             "Thread %u cannot release Mutex [%4.4s] acquired by thread %u",
    564   1.1.1.2    jruoho             (UINT32) WalkState->Thread->ThreadId,
    565       1.1    jruoho             AcpiUtGetNodeName (ObjDesc->Mutex.Node),
    566   1.1.1.2    jruoho             (UINT32) OwnerThread->ThreadId));
    567       1.1    jruoho         return_ACPI_STATUS (AE_AML_NOT_OWNER);
    568       1.1    jruoho     }
    569       1.1    jruoho 
    570       1.1    jruoho     /*
    571       1.1    jruoho      * The sync level of the mutex must be equal to the current sync level. In
    572       1.1    jruoho      * other words, the current level means that at least one mutex at that
    573       1.1    jruoho      * level is currently being held. Attempting to release a mutex of a
    574       1.1    jruoho      * different level can only mean that the mutex ordering rule is being
    575       1.1    jruoho      * violated. This behavior is clarified in ACPI 4.0 specification.
    576       1.1    jruoho      */
    577       1.1    jruoho     if (ObjDesc->Mutex.SyncLevel != OwnerThread->CurrentSyncLevel)
    578       1.1    jruoho     {
    579       1.1    jruoho         ACPI_ERROR ((AE_INFO,
    580   1.1.1.6  christos             "Cannot release Mutex [%4.4s], SyncLevel mismatch: "
    581   1.1.1.6  christos             "mutex %u current %u",
    582       1.1    jruoho             AcpiUtGetNodeName (ObjDesc->Mutex.Node),
    583       1.1    jruoho             ObjDesc->Mutex.SyncLevel, WalkState->Thread->CurrentSyncLevel));
    584       1.1    jruoho         return_ACPI_STATUS (AE_AML_MUTEX_ORDER);
    585       1.1    jruoho     }
    586       1.1    jruoho 
    587       1.1    jruoho     /*
    588       1.1    jruoho      * Get the previous SyncLevel from the head of the acquired mutex list.
    589       1.1    jruoho      * This handles the case where several mutexes at the same level have been
    590       1.1    jruoho      * acquired, but are not released in reverse order.
    591       1.1    jruoho      */
    592       1.1    jruoho     PreviousSyncLevel =
    593       1.1    jruoho         OwnerThread->AcquiredMutexList->Mutex.OriginalSyncLevel;
    594       1.1    jruoho 
    595   1.1.1.6  christos     ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
    596   1.1.1.6  christos         "Releasing: Object SyncLevel %u, Thread SyncLevel %u, "
    597   1.1.1.6  christos         "Prev SyncLevel %u, Depth %u TID %p\n",
    598   1.1.1.6  christos         ObjDesc->Mutex.SyncLevel, WalkState->Thread->CurrentSyncLevel,
    599   1.1.1.6  christos         PreviousSyncLevel, ObjDesc->Mutex.AcquisitionDepth,
    600   1.1.1.6  christos         WalkState->Thread));
    601   1.1.1.6  christos 
    602       1.1    jruoho     Status = AcpiExReleaseMutexObject (ObjDesc);
    603       1.1    jruoho     if (ACPI_FAILURE (Status))
    604       1.1    jruoho     {
    605       1.1    jruoho         return_ACPI_STATUS (Status);
    606       1.1    jruoho     }
    607       1.1    jruoho 
    608       1.1    jruoho     if (ObjDesc->Mutex.AcquisitionDepth == 0)
    609       1.1    jruoho     {
    610       1.1    jruoho         /* Restore the previous SyncLevel */
    611       1.1    jruoho 
    612       1.1    jruoho         OwnerThread->CurrentSyncLevel = PreviousSyncLevel;
    613       1.1    jruoho     }
    614       1.1    jruoho 
    615   1.1.1.6  christos     ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
    616   1.1.1.6  christos         "Released: Object SyncLevel %u, Thread SyncLevel, %u, "
    617   1.1.1.6  christos         "Prev SyncLevel %u, Depth %u\n",
    618   1.1.1.6  christos         ObjDesc->Mutex.SyncLevel, WalkState->Thread->CurrentSyncLevel,
    619   1.1.1.6  christos         PreviousSyncLevel, ObjDesc->Mutex.AcquisitionDepth));
    620   1.1.1.6  christos 
    621       1.1    jruoho     return_ACPI_STATUS (Status);
    622       1.1    jruoho }
    623       1.1    jruoho 
    624       1.1    jruoho 
    625       1.1    jruoho /*******************************************************************************
    626       1.1    jruoho  *
    627       1.1    jruoho  * FUNCTION:    AcpiExReleaseAllMutexes
    628       1.1    jruoho  *
    629       1.1    jruoho  * PARAMETERS:  Thread              - Current executing thread object
    630       1.1    jruoho  *
    631       1.1    jruoho  * RETURN:      Status
    632       1.1    jruoho  *
    633       1.1    jruoho  * DESCRIPTION: Release all mutexes held by this thread
    634       1.1    jruoho  *
    635       1.1    jruoho  * NOTE: This function is called as the thread is exiting the interpreter.
    636       1.1    jruoho  * Mutexes are not released when an individual control method is exited, but
    637       1.1    jruoho  * only when the parent thread actually exits the interpreter. This allows one
    638       1.1    jruoho  * method to acquire a mutex, and a different method to release it, as long as
    639       1.1    jruoho  * this is performed underneath a single parent control method.
    640       1.1    jruoho  *
    641       1.1    jruoho  ******************************************************************************/
    642       1.1    jruoho 
    643       1.1    jruoho void
    644       1.1    jruoho AcpiExReleaseAllMutexes (
    645       1.1    jruoho     ACPI_THREAD_STATE       *Thread)
    646       1.1    jruoho {
    647       1.1    jruoho     ACPI_OPERAND_OBJECT     *Next = Thread->AcquiredMutexList;
    648       1.1    jruoho     ACPI_OPERAND_OBJECT     *ObjDesc;
    649       1.1    jruoho 
    650       1.1    jruoho 
    651   1.1.1.6  christos     ACPI_FUNCTION_TRACE (ExReleaseAllMutexes);
    652       1.1    jruoho 
    653       1.1    jruoho 
    654       1.1    jruoho     /* Traverse the list of owned mutexes, releasing each one */
    655       1.1    jruoho 
    656       1.1    jruoho     while (Next)
    657       1.1    jruoho     {
    658       1.1    jruoho         ObjDesc = Next;
    659   1.1.1.3  christos         ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
    660   1.1.1.6  christos             "Mutex [%4.4s] force-release, SyncLevel %u Depth %u\n",
    661   1.1.1.6  christos             ObjDesc->Mutex.Node->Name.Ascii, ObjDesc->Mutex.SyncLevel,
    662   1.1.1.6  christos             ObjDesc->Mutex.AcquisitionDepth));
    663   1.1.1.3  christos 
    664       1.1    jruoho         /* Release the mutex, special case for Global Lock */
    665       1.1    jruoho 
    666       1.1    jruoho         if (ObjDesc == AcpiGbl_GlobalLockMutex)
    667       1.1    jruoho         {
    668       1.1    jruoho             /* Ignore errors */
    669       1.1    jruoho 
    670       1.1    jruoho             (void) AcpiEvReleaseGlobalLock ();
    671       1.1    jruoho         }
    672       1.1    jruoho         else
    673       1.1    jruoho         {
    674       1.1    jruoho             AcpiOsReleaseMutex (ObjDesc->Mutex.OsMutex);
    675       1.1    jruoho         }
    676       1.1    jruoho 
    677   1.1.1.6  christos         /* Update Thread SyncLevel (Last mutex is the important one) */
    678   1.1.1.6  christos 
    679   1.1.1.6  christos         Thread->CurrentSyncLevel = ObjDesc->Mutex.OriginalSyncLevel;
    680   1.1.1.6  christos 
    681       1.1    jruoho         /* Mark mutex unowned */
    682       1.1    jruoho 
    683   1.1.1.6  christos         Next = ObjDesc->Mutex.Next;
    684   1.1.1.6  christos 
    685   1.1.1.6  christos         ObjDesc->Mutex.Prev = NULL;
    686   1.1.1.6  christos         ObjDesc->Mutex.Next = NULL;
    687   1.1.1.6  christos         ObjDesc->Mutex.AcquisitionDepth = 0;
    688       1.1    jruoho         ObjDesc->Mutex.OwnerThread = NULL;
    689       1.1    jruoho         ObjDesc->Mutex.ThreadId = 0;
    690       1.1    jruoho     }
    691   1.1.1.6  christos 
    692   1.1.1.6  christos     return_VOID;
    693       1.1    jruoho }
    694