Home | History | Annotate | Line # | Download | only in dispatcher
dsmethod.c revision 1.1
      1  1.1  jruoho /******************************************************************************
      2  1.1  jruoho  *
      3  1.1  jruoho  * Module Name: dsmethod - Parser/Interpreter interface - control method parsing
      4  1.1  jruoho  *
      5  1.1  jruoho  *****************************************************************************/
      6  1.1  jruoho 
      7  1.1  jruoho /******************************************************************************
      8  1.1  jruoho  *
      9  1.1  jruoho  * 1. Copyright Notice
     10  1.1  jruoho  *
     11  1.1  jruoho  * Some or all of this work - Copyright (c) 1999 - 2010, Intel Corp.
     12  1.1  jruoho  * All rights reserved.
     13  1.1  jruoho  *
     14  1.1  jruoho  * 2. License
     15  1.1  jruoho  *
     16  1.1  jruoho  * 2.1. This is your license from Intel Corp. under its intellectual property
     17  1.1  jruoho  * rights.  You may have additional license terms from the party that provided
     18  1.1  jruoho  * you this software, covering your right to use that party's intellectual
     19  1.1  jruoho  * property rights.
     20  1.1  jruoho  *
     21  1.1  jruoho  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
     22  1.1  jruoho  * copy of the source code appearing in this file ("Covered Code") an
     23  1.1  jruoho  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
     24  1.1  jruoho  * base code distributed originally by Intel ("Original Intel Code") to copy,
     25  1.1  jruoho  * make derivatives, distribute, use and display any portion of the Covered
     26  1.1  jruoho  * Code in any form, with the right to sublicense such rights; and
     27  1.1  jruoho  *
     28  1.1  jruoho  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
     29  1.1  jruoho  * license (with the right to sublicense), under only those claims of Intel
     30  1.1  jruoho  * patents that are infringed by the Original Intel Code, to make, use, sell,
     31  1.1  jruoho  * offer to sell, and import the Covered Code and derivative works thereof
     32  1.1  jruoho  * solely to the minimum extent necessary to exercise the above copyright
     33  1.1  jruoho  * license, and in no event shall the patent license extend to any additions
     34  1.1  jruoho  * to or modifications of the Original Intel Code.  No other license or right
     35  1.1  jruoho  * is granted directly or by implication, estoppel or otherwise;
     36  1.1  jruoho  *
     37  1.1  jruoho  * The above copyright and patent license is granted only if the following
     38  1.1  jruoho  * conditions are met:
     39  1.1  jruoho  *
     40  1.1  jruoho  * 3. Conditions
     41  1.1  jruoho  *
     42  1.1  jruoho  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
     43  1.1  jruoho  * Redistribution of source code of any substantial portion of the Covered
     44  1.1  jruoho  * Code or modification with rights to further distribute source must include
     45  1.1  jruoho  * the above Copyright Notice, the above License, this list of Conditions,
     46  1.1  jruoho  * and the following Disclaimer and Export Compliance provision.  In addition,
     47  1.1  jruoho  * Licensee must cause all Covered Code to which Licensee contributes to
     48  1.1  jruoho  * contain a file documenting the changes Licensee made to create that Covered
     49  1.1  jruoho  * Code and the date of any change.  Licensee must include in that file the
     50  1.1  jruoho  * documentation of any changes made by any predecessor Licensee.  Licensee
     51  1.1  jruoho  * must include a prominent statement that the modification is derived,
     52  1.1  jruoho  * directly or indirectly, from Original Intel Code.
     53  1.1  jruoho  *
     54  1.1  jruoho  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
     55  1.1  jruoho  * Redistribution of source code of any substantial portion of the Covered
     56  1.1  jruoho  * Code or modification without rights to further distribute source must
     57  1.1  jruoho  * include the following Disclaimer and Export Compliance provision in the
     58  1.1  jruoho  * documentation and/or other materials provided with distribution.  In
     59  1.1  jruoho  * addition, Licensee may not authorize further sublicense of source of any
     60  1.1  jruoho  * portion of the Covered Code, and must include terms to the effect that the
     61  1.1  jruoho  * license from Licensee to its licensee is limited to the intellectual
     62  1.1  jruoho  * property embodied in the software Licensee provides to its licensee, and
     63  1.1  jruoho  * not to intellectual property embodied in modifications its licensee may
     64  1.1  jruoho  * make.
     65  1.1  jruoho  *
     66  1.1  jruoho  * 3.3. Redistribution of Executable. Redistribution in executable form of any
     67  1.1  jruoho  * substantial portion of the Covered Code or modification must reproduce the
     68  1.1  jruoho  * above Copyright Notice, and the following Disclaimer and Export Compliance
     69  1.1  jruoho  * provision in the documentation and/or other materials provided with the
     70  1.1  jruoho  * distribution.
     71  1.1  jruoho  *
     72  1.1  jruoho  * 3.4. Intel retains all right, title, and interest in and to the Original
     73  1.1  jruoho  * Intel Code.
     74  1.1  jruoho  *
     75  1.1  jruoho  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
     76  1.1  jruoho  * Intel shall be used in advertising or otherwise to promote the sale, use or
     77  1.1  jruoho  * other dealings in products derived from or relating to the Covered Code
     78  1.1  jruoho  * without prior written authorization from Intel.
     79  1.1  jruoho  *
     80  1.1  jruoho  * 4. Disclaimer and Export Compliance
     81  1.1  jruoho  *
     82  1.1  jruoho  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
     83  1.1  jruoho  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
     84  1.1  jruoho  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
     85  1.1  jruoho  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
     86  1.1  jruoho  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
     87  1.1  jruoho  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
     88  1.1  jruoho  * PARTICULAR PURPOSE.
     89  1.1  jruoho  *
     90  1.1  jruoho  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
     91  1.1  jruoho  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
     92  1.1  jruoho  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
     93  1.1  jruoho  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
     94  1.1  jruoho  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
     95  1.1  jruoho  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
     96  1.1  jruoho  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
     97  1.1  jruoho  * LIMITED REMEDY.
     98  1.1  jruoho  *
     99  1.1  jruoho  * 4.3. Licensee shall not export, either directly or indirectly, any of this
    100  1.1  jruoho  * software or system incorporating such software without first obtaining any
    101  1.1  jruoho  * required license or other approval from the U. S. Department of Commerce or
    102  1.1  jruoho  * any other agency or department of the United States Government.  In the
    103  1.1  jruoho  * event Licensee exports any such software from the United States or
    104  1.1  jruoho  * re-exports any such software from a foreign destination, Licensee shall
    105  1.1  jruoho  * ensure that the distribution and export/re-export of the software is in
    106  1.1  jruoho  * compliance with all laws, regulations, orders, or other restrictions of the
    107  1.1  jruoho  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
    108  1.1  jruoho  * any of its subsidiaries will export/re-export any technical data, process,
    109  1.1  jruoho  * software, or service, directly or indirectly, to any country for which the
    110  1.1  jruoho  * United States government or any agency thereof requires an export license,
    111  1.1  jruoho  * other governmental approval, or letter of assurance, without first obtaining
    112  1.1  jruoho  * such license, approval or letter.
    113  1.1  jruoho  *
    114  1.1  jruoho  *****************************************************************************/
    115  1.1  jruoho 
    116  1.1  jruoho #define __DSMETHOD_C__
    117  1.1  jruoho 
    118  1.1  jruoho #include "acpi.h"
    119  1.1  jruoho #include "accommon.h"
    120  1.1  jruoho #include "amlcode.h"
    121  1.1  jruoho #include "acdispat.h"
    122  1.1  jruoho #include "acinterp.h"
    123  1.1  jruoho #include "acnamesp.h"
    124  1.1  jruoho #include "acdisasm.h"
    125  1.1  jruoho 
    126  1.1  jruoho 
    127  1.1  jruoho #define _COMPONENT          ACPI_DISPATCHER
    128  1.1  jruoho         ACPI_MODULE_NAME    ("dsmethod")
    129  1.1  jruoho 
    130  1.1  jruoho /* Local prototypes */
    131  1.1  jruoho 
    132  1.1  jruoho static ACPI_STATUS
    133  1.1  jruoho AcpiDsCreateMethodMutex (
    134  1.1  jruoho     ACPI_OPERAND_OBJECT     *MethodDesc);
    135  1.1  jruoho 
    136  1.1  jruoho 
    137  1.1  jruoho /*******************************************************************************
    138  1.1  jruoho  *
    139  1.1  jruoho  * FUNCTION:    AcpiDsMethodError
    140  1.1  jruoho  *
    141  1.1  jruoho  * PARAMETERS:  Status          - Execution status
    142  1.1  jruoho  *              WalkState       - Current state
    143  1.1  jruoho  *
    144  1.1  jruoho  * RETURN:      Status
    145  1.1  jruoho  *
    146  1.1  jruoho  * DESCRIPTION: Called on method error. Invoke the global exception handler if
    147  1.1  jruoho  *              present, dump the method data if the disassembler is configured
    148  1.1  jruoho  *
    149  1.1  jruoho  *              Note: Allows the exception handler to change the status code
    150  1.1  jruoho  *
    151  1.1  jruoho  ******************************************************************************/
    152  1.1  jruoho 
    153  1.1  jruoho ACPI_STATUS
    154  1.1  jruoho AcpiDsMethodError (
    155  1.1  jruoho     ACPI_STATUS             Status,
    156  1.1  jruoho     ACPI_WALK_STATE         *WalkState)
    157  1.1  jruoho {
    158  1.1  jruoho     ACPI_FUNCTION_ENTRY ();
    159  1.1  jruoho 
    160  1.1  jruoho 
    161  1.1  jruoho     /* Ignore AE_OK and control exception codes */
    162  1.1  jruoho 
    163  1.1  jruoho     if (ACPI_SUCCESS (Status) ||
    164  1.1  jruoho         (Status & AE_CODE_CONTROL))
    165  1.1  jruoho     {
    166  1.1  jruoho         return (Status);
    167  1.1  jruoho     }
    168  1.1  jruoho 
    169  1.1  jruoho     /* Invoke the global exception handler */
    170  1.1  jruoho 
    171  1.1  jruoho     if (AcpiGbl_ExceptionHandler)
    172  1.1  jruoho     {
    173  1.1  jruoho         /* Exit the interpreter, allow handler to execute methods */
    174  1.1  jruoho 
    175  1.1  jruoho         AcpiExExitInterpreter ();
    176  1.1  jruoho 
    177  1.1  jruoho         /*
    178  1.1  jruoho          * Handler can map the exception code to anything it wants, including
    179  1.1  jruoho          * AE_OK, in which case the executing method will not be aborted.
    180  1.1  jruoho          */
    181  1.1  jruoho         Status = AcpiGbl_ExceptionHandler (Status,
    182  1.1  jruoho                     WalkState->MethodNode ?
    183  1.1  jruoho                         WalkState->MethodNode->Name.Integer : 0,
    184  1.1  jruoho                     WalkState->Opcode, WalkState->AmlOffset, NULL);
    185  1.1  jruoho         AcpiExEnterInterpreter ();
    186  1.1  jruoho     }
    187  1.1  jruoho 
    188  1.1  jruoho     AcpiDsClearImplicitReturn (WalkState);
    189  1.1  jruoho 
    190  1.1  jruoho #ifdef ACPI_DISASSEMBLER
    191  1.1  jruoho     if (ACPI_FAILURE (Status))
    192  1.1  jruoho     {
    193  1.1  jruoho         /* Display method locals/args if disassembler is present */
    194  1.1  jruoho 
    195  1.1  jruoho         AcpiDmDumpMethodInfo (Status, WalkState, WalkState->Op);
    196  1.1  jruoho     }
    197  1.1  jruoho #endif
    198  1.1  jruoho 
    199  1.1  jruoho     return (Status);
    200  1.1  jruoho }
    201  1.1  jruoho 
    202  1.1  jruoho 
    203  1.1  jruoho /*******************************************************************************
    204  1.1  jruoho  *
    205  1.1  jruoho  * FUNCTION:    AcpiDsCreateMethodMutex
    206  1.1  jruoho  *
    207  1.1  jruoho  * PARAMETERS:  ObjDesc             - The method object
    208  1.1  jruoho  *
    209  1.1  jruoho  * RETURN:      Status
    210  1.1  jruoho  *
    211  1.1  jruoho  * DESCRIPTION: Create a mutex object for a serialized control method
    212  1.1  jruoho  *
    213  1.1  jruoho  ******************************************************************************/
    214  1.1  jruoho 
    215  1.1  jruoho static ACPI_STATUS
    216  1.1  jruoho AcpiDsCreateMethodMutex (
    217  1.1  jruoho     ACPI_OPERAND_OBJECT     *MethodDesc)
    218  1.1  jruoho {
    219  1.1  jruoho     ACPI_OPERAND_OBJECT     *MutexDesc;
    220  1.1  jruoho     ACPI_STATUS             Status;
    221  1.1  jruoho 
    222  1.1  jruoho 
    223  1.1  jruoho     ACPI_FUNCTION_TRACE (DsCreateMethodMutex);
    224  1.1  jruoho 
    225  1.1  jruoho 
    226  1.1  jruoho     /* Create the new mutex object */
    227  1.1  jruoho 
    228  1.1  jruoho     MutexDesc = AcpiUtCreateInternalObject (ACPI_TYPE_MUTEX);
    229  1.1  jruoho     if (!MutexDesc)
    230  1.1  jruoho     {
    231  1.1  jruoho         return_ACPI_STATUS (AE_NO_MEMORY);
    232  1.1  jruoho     }
    233  1.1  jruoho 
    234  1.1  jruoho     /* Create the actual OS Mutex */
    235  1.1  jruoho 
    236  1.1  jruoho     Status = AcpiOsCreateMutex (&MutexDesc->Mutex.OsMutex);
    237  1.1  jruoho     if (ACPI_FAILURE (Status))
    238  1.1  jruoho     {
    239  1.1  jruoho         return_ACPI_STATUS (Status);
    240  1.1  jruoho     }
    241  1.1  jruoho 
    242  1.1  jruoho     MutexDesc->Mutex.SyncLevel = MethodDesc->Method.SyncLevel;
    243  1.1  jruoho     MethodDesc->Method.Mutex = MutexDesc;
    244  1.1  jruoho     return_ACPI_STATUS (AE_OK);
    245  1.1  jruoho }
    246  1.1  jruoho 
    247  1.1  jruoho 
    248  1.1  jruoho /*******************************************************************************
    249  1.1  jruoho  *
    250  1.1  jruoho  * FUNCTION:    AcpiDsBeginMethodExecution
    251  1.1  jruoho  *
    252  1.1  jruoho  * PARAMETERS:  MethodNode          - Node of the method
    253  1.1  jruoho  *              ObjDesc             - The method object
    254  1.1  jruoho  *              WalkState           - current state, NULL if not yet executing
    255  1.1  jruoho  *                                    a method.
    256  1.1  jruoho  *
    257  1.1  jruoho  * RETURN:      Status
    258  1.1  jruoho  *
    259  1.1  jruoho  * DESCRIPTION: Prepare a method for execution.  Parses the method if necessary,
    260  1.1  jruoho  *              increments the thread count, and waits at the method semaphore
    261  1.1  jruoho  *              for clearance to execute.
    262  1.1  jruoho  *
    263  1.1  jruoho  ******************************************************************************/
    264  1.1  jruoho 
    265  1.1  jruoho ACPI_STATUS
    266  1.1  jruoho AcpiDsBeginMethodExecution (
    267  1.1  jruoho     ACPI_NAMESPACE_NODE     *MethodNode,
    268  1.1  jruoho     ACPI_OPERAND_OBJECT     *ObjDesc,
    269  1.1  jruoho     ACPI_WALK_STATE         *WalkState)
    270  1.1  jruoho {
    271  1.1  jruoho     ACPI_STATUS             Status = AE_OK;
    272  1.1  jruoho 
    273  1.1  jruoho 
    274  1.1  jruoho     ACPI_FUNCTION_TRACE_PTR (DsBeginMethodExecution, MethodNode);
    275  1.1  jruoho 
    276  1.1  jruoho 
    277  1.1  jruoho     if (!MethodNode)
    278  1.1  jruoho     {
    279  1.1  jruoho         return_ACPI_STATUS (AE_NULL_ENTRY);
    280  1.1  jruoho     }
    281  1.1  jruoho 
    282  1.1  jruoho     /* Prevent wraparound of thread count */
    283  1.1  jruoho 
    284  1.1  jruoho     if (ObjDesc->Method.ThreadCount == ACPI_UINT8_MAX)
    285  1.1  jruoho     {
    286  1.1  jruoho         ACPI_ERROR ((AE_INFO,
    287  1.1  jruoho             "Method reached maximum reentrancy limit (255)"));
    288  1.1  jruoho         return_ACPI_STATUS (AE_AML_METHOD_LIMIT);
    289  1.1  jruoho     }
    290  1.1  jruoho 
    291  1.1  jruoho     /*
    292  1.1  jruoho      * If this method is serialized, we need to acquire the method mutex.
    293  1.1  jruoho      */
    294  1.1  jruoho     if (ObjDesc->Method.MethodFlags & AML_METHOD_SERIALIZED)
    295  1.1  jruoho     {
    296  1.1  jruoho         /*
    297  1.1  jruoho          * Create a mutex for the method if it is defined to be Serialized
    298  1.1  jruoho          * and a mutex has not already been created. We defer the mutex creation
    299  1.1  jruoho          * until a method is actually executed, to minimize the object count
    300  1.1  jruoho          */
    301  1.1  jruoho         if (!ObjDesc->Method.Mutex)
    302  1.1  jruoho         {
    303  1.1  jruoho             Status = AcpiDsCreateMethodMutex (ObjDesc);
    304  1.1  jruoho             if (ACPI_FAILURE (Status))
    305  1.1  jruoho             {
    306  1.1  jruoho                 return_ACPI_STATUS (Status);
    307  1.1  jruoho             }
    308  1.1  jruoho         }
    309  1.1  jruoho 
    310  1.1  jruoho         /*
    311  1.1  jruoho          * The CurrentSyncLevel (per-thread) must be less than or equal to
    312  1.1  jruoho          * the sync level of the method. This mechanism provides some
    313  1.1  jruoho          * deadlock prevention
    314  1.1  jruoho          *
    315  1.1  jruoho          * Top-level method invocation has no walk state at this point
    316  1.1  jruoho          */
    317  1.1  jruoho         if (WalkState &&
    318  1.1  jruoho             (WalkState->Thread->CurrentSyncLevel > ObjDesc->Method.Mutex->Mutex.SyncLevel))
    319  1.1  jruoho         {
    320  1.1  jruoho             ACPI_ERROR ((AE_INFO,
    321  1.1  jruoho                 "Cannot acquire Mutex for method [%4.4s], current SyncLevel is too large (%u)",
    322  1.1  jruoho                 AcpiUtGetNodeName (MethodNode),
    323  1.1  jruoho                 WalkState->Thread->CurrentSyncLevel));
    324  1.1  jruoho 
    325  1.1  jruoho             return_ACPI_STATUS (AE_AML_MUTEX_ORDER);
    326  1.1  jruoho         }
    327  1.1  jruoho 
    328  1.1  jruoho         /*
    329  1.1  jruoho          * Obtain the method mutex if necessary. Do not acquire mutex for a
    330  1.1  jruoho          * recursive call.
    331  1.1  jruoho          */
    332  1.1  jruoho         if (!WalkState ||
    333  1.1  jruoho             !ObjDesc->Method.Mutex->Mutex.ThreadId ||
    334  1.1  jruoho             (WalkState->Thread->ThreadId != ObjDesc->Method.Mutex->Mutex.ThreadId))
    335  1.1  jruoho         {
    336  1.1  jruoho             /*
    337  1.1  jruoho              * Acquire the method mutex. This releases the interpreter if we
    338  1.1  jruoho              * block (and reacquires it before it returns)
    339  1.1  jruoho              */
    340  1.1  jruoho             Status = AcpiExSystemWaitMutex (ObjDesc->Method.Mutex->Mutex.OsMutex,
    341  1.1  jruoho                         ACPI_WAIT_FOREVER);
    342  1.1  jruoho             if (ACPI_FAILURE (Status))
    343  1.1  jruoho             {
    344  1.1  jruoho                 return_ACPI_STATUS (Status);
    345  1.1  jruoho             }
    346  1.1  jruoho 
    347  1.1  jruoho             /* Update the mutex and walk info and save the original SyncLevel */
    348  1.1  jruoho 
    349  1.1  jruoho             if (WalkState)
    350  1.1  jruoho             {
    351  1.1  jruoho                 ObjDesc->Method.Mutex->Mutex.OriginalSyncLevel =
    352  1.1  jruoho                     WalkState->Thread->CurrentSyncLevel;
    353  1.1  jruoho 
    354  1.1  jruoho                 ObjDesc->Method.Mutex->Mutex.ThreadId = WalkState->Thread->ThreadId;
    355  1.1  jruoho                 WalkState->Thread->CurrentSyncLevel = ObjDesc->Method.SyncLevel;
    356  1.1  jruoho             }
    357  1.1  jruoho             else
    358  1.1  jruoho             {
    359  1.1  jruoho                 ObjDesc->Method.Mutex->Mutex.OriginalSyncLevel =
    360  1.1  jruoho                     ObjDesc->Method.Mutex->Mutex.SyncLevel;
    361  1.1  jruoho             }
    362  1.1  jruoho         }
    363  1.1  jruoho 
    364  1.1  jruoho         /* Always increase acquisition depth */
    365  1.1  jruoho 
    366  1.1  jruoho         ObjDesc->Method.Mutex->Mutex.AcquisitionDepth++;
    367  1.1  jruoho     }
    368  1.1  jruoho 
    369  1.1  jruoho     /*
    370  1.1  jruoho      * Allocate an Owner ID for this method, only if this is the first thread
    371  1.1  jruoho      * to begin concurrent execution. We only need one OwnerId, even if the
    372  1.1  jruoho      * method is invoked recursively.
    373  1.1  jruoho      */
    374  1.1  jruoho     if (!ObjDesc->Method.OwnerId)
    375  1.1  jruoho     {
    376  1.1  jruoho         Status = AcpiUtAllocateOwnerId (&ObjDesc->Method.OwnerId);
    377  1.1  jruoho         if (ACPI_FAILURE (Status))
    378  1.1  jruoho         {
    379  1.1  jruoho             goto Cleanup;
    380  1.1  jruoho         }
    381  1.1  jruoho     }
    382  1.1  jruoho 
    383  1.1  jruoho     /*
    384  1.1  jruoho      * Increment the method parse tree thread count since it has been
    385  1.1  jruoho      * reentered one more time (even if it is the same thread)
    386  1.1  jruoho      */
    387  1.1  jruoho     ObjDesc->Method.ThreadCount++;
    388  1.1  jruoho     AcpiMethodCount++;
    389  1.1  jruoho     return_ACPI_STATUS (Status);
    390  1.1  jruoho 
    391  1.1  jruoho 
    392  1.1  jruoho Cleanup:
    393  1.1  jruoho     /* On error, must release the method mutex (if present) */
    394  1.1  jruoho 
    395  1.1  jruoho     if (ObjDesc->Method.Mutex)
    396  1.1  jruoho     {
    397  1.1  jruoho         AcpiOsReleaseMutex (ObjDesc->Method.Mutex->Mutex.OsMutex);
    398  1.1  jruoho     }
    399  1.1  jruoho     return_ACPI_STATUS (Status);
    400  1.1  jruoho }
    401  1.1  jruoho 
    402  1.1  jruoho 
    403  1.1  jruoho /*******************************************************************************
    404  1.1  jruoho  *
    405  1.1  jruoho  * FUNCTION:    AcpiDsCallControlMethod
    406  1.1  jruoho  *
    407  1.1  jruoho  * PARAMETERS:  Thread              - Info for this thread
    408  1.1  jruoho  *              ThisWalkState       - Current walk state
    409  1.1  jruoho  *              Op                  - Current Op to be walked
    410  1.1  jruoho  *
    411  1.1  jruoho  * RETURN:      Status
    412  1.1  jruoho  *
    413  1.1  jruoho  * DESCRIPTION: Transfer execution to a called control method
    414  1.1  jruoho  *
    415  1.1  jruoho  ******************************************************************************/
    416  1.1  jruoho 
    417  1.1  jruoho ACPI_STATUS
    418  1.1  jruoho AcpiDsCallControlMethod (
    419  1.1  jruoho     ACPI_THREAD_STATE       *Thread,
    420  1.1  jruoho     ACPI_WALK_STATE         *ThisWalkState,
    421  1.1  jruoho     ACPI_PARSE_OBJECT       *Op)
    422  1.1  jruoho {
    423  1.1  jruoho     ACPI_STATUS             Status;
    424  1.1  jruoho     ACPI_NAMESPACE_NODE     *MethodNode;
    425  1.1  jruoho     ACPI_WALK_STATE         *NextWalkState = NULL;
    426  1.1  jruoho     ACPI_OPERAND_OBJECT     *ObjDesc;
    427  1.1  jruoho     ACPI_EVALUATE_INFO      *Info;
    428  1.1  jruoho     UINT32                  i;
    429  1.1  jruoho 
    430  1.1  jruoho 
    431  1.1  jruoho     ACPI_FUNCTION_TRACE_PTR (DsCallControlMethod, ThisWalkState);
    432  1.1  jruoho 
    433  1.1  jruoho     ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH, "Calling method %p, currentstate=%p\n",
    434  1.1  jruoho         ThisWalkState->PrevOp, ThisWalkState));
    435  1.1  jruoho 
    436  1.1  jruoho     /*
    437  1.1  jruoho      * Get the namespace entry for the control method we are about to call
    438  1.1  jruoho      */
    439  1.1  jruoho     MethodNode = ThisWalkState->MethodCallNode;
    440  1.1  jruoho     if (!MethodNode)
    441  1.1  jruoho     {
    442  1.1  jruoho         return_ACPI_STATUS (AE_NULL_ENTRY);
    443  1.1  jruoho     }
    444  1.1  jruoho 
    445  1.1  jruoho     ObjDesc = AcpiNsGetAttachedObject (MethodNode);
    446  1.1  jruoho     if (!ObjDesc)
    447  1.1  jruoho     {
    448  1.1  jruoho         return_ACPI_STATUS (AE_NULL_OBJECT);
    449  1.1  jruoho     }
    450  1.1  jruoho 
    451  1.1  jruoho     /* Init for new method, possibly wait on method mutex */
    452  1.1  jruoho 
    453  1.1  jruoho     Status = AcpiDsBeginMethodExecution (MethodNode, ObjDesc,
    454  1.1  jruoho                 ThisWalkState);
    455  1.1  jruoho     if (ACPI_FAILURE (Status))
    456  1.1  jruoho     {
    457  1.1  jruoho         return_ACPI_STATUS (Status);
    458  1.1  jruoho     }
    459  1.1  jruoho 
    460  1.1  jruoho     /* Begin method parse/execution. Create a new walk state */
    461  1.1  jruoho 
    462  1.1  jruoho     NextWalkState = AcpiDsCreateWalkState (ObjDesc->Method.OwnerId,
    463  1.1  jruoho                         NULL, ObjDesc, Thread);
    464  1.1  jruoho     if (!NextWalkState)
    465  1.1  jruoho     {
    466  1.1  jruoho         Status = AE_NO_MEMORY;
    467  1.1  jruoho         goto Cleanup;
    468  1.1  jruoho     }
    469  1.1  jruoho 
    470  1.1  jruoho     /*
    471  1.1  jruoho      * The resolved arguments were put on the previous walk state's operand
    472  1.1  jruoho      * stack. Operands on the previous walk state stack always
    473  1.1  jruoho      * start at index 0. Also, null terminate the list of arguments
    474  1.1  jruoho      */
    475  1.1  jruoho     ThisWalkState->Operands [ThisWalkState->NumOperands] = NULL;
    476  1.1  jruoho 
    477  1.1  jruoho     /*
    478  1.1  jruoho      * Allocate and initialize the evaluation information block
    479  1.1  jruoho      * TBD: this is somewhat inefficient, should change interface to
    480  1.1  jruoho      * DsInitAmlWalk. For now, keeps this struct off the CPU stack
    481  1.1  jruoho      */
    482  1.1  jruoho     Info = ACPI_ALLOCATE_ZEROED (sizeof (ACPI_EVALUATE_INFO));
    483  1.1  jruoho     if (!Info)
    484  1.1  jruoho     {
    485  1.1  jruoho         return_ACPI_STATUS (AE_NO_MEMORY);
    486  1.1  jruoho     }
    487  1.1  jruoho 
    488  1.1  jruoho     Info->Parameters = &ThisWalkState->Operands[0];
    489  1.1  jruoho 
    490  1.1  jruoho     Status = AcpiDsInitAmlWalk (NextWalkState, NULL, MethodNode,
    491  1.1  jruoho                 ObjDesc->Method.AmlStart, ObjDesc->Method.AmlLength,
    492  1.1  jruoho                 Info, ACPI_IMODE_EXECUTE);
    493  1.1  jruoho 
    494  1.1  jruoho     ACPI_FREE (Info);
    495  1.1  jruoho     if (ACPI_FAILURE (Status))
    496  1.1  jruoho     {
    497  1.1  jruoho         goto Cleanup;
    498  1.1  jruoho     }
    499  1.1  jruoho 
    500  1.1  jruoho     /*
    501  1.1  jruoho      * Delete the operands on the previous walkstate operand stack
    502  1.1  jruoho      * (they were copied to new objects)
    503  1.1  jruoho      */
    504  1.1  jruoho     for (i = 0; i < ObjDesc->Method.ParamCount; i++)
    505  1.1  jruoho     {
    506  1.1  jruoho         AcpiUtRemoveReference (ThisWalkState->Operands [i]);
    507  1.1  jruoho         ThisWalkState->Operands [i] = NULL;
    508  1.1  jruoho     }
    509  1.1  jruoho 
    510  1.1  jruoho     /* Clear the operand stack */
    511  1.1  jruoho 
    512  1.1  jruoho     ThisWalkState->NumOperands = 0;
    513  1.1  jruoho 
    514  1.1  jruoho     ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH,
    515  1.1  jruoho         "**** Begin nested execution of [%4.4s] **** WalkState=%p\n",
    516  1.1  jruoho         MethodNode->Name.Ascii, NextWalkState));
    517  1.1  jruoho 
    518  1.1  jruoho     /* Invoke an internal method if necessary */
    519  1.1  jruoho 
    520  1.1  jruoho     if (ObjDesc->Method.MethodFlags & AML_METHOD_INTERNAL_ONLY)
    521  1.1  jruoho     {
    522  1.1  jruoho         Status = ObjDesc->Method.Extra.Implementation (NextWalkState);
    523  1.1  jruoho         if (Status == AE_OK)
    524  1.1  jruoho         {
    525  1.1  jruoho             Status = AE_CTRL_TERMINATE;
    526  1.1  jruoho         }
    527  1.1  jruoho     }
    528  1.1  jruoho 
    529  1.1  jruoho     return_ACPI_STATUS (Status);
    530  1.1  jruoho 
    531  1.1  jruoho 
    532  1.1  jruoho Cleanup:
    533  1.1  jruoho 
    534  1.1  jruoho     /* On error, we must terminate the method properly */
    535  1.1  jruoho 
    536  1.1  jruoho     AcpiDsTerminateControlMethod (ObjDesc, NextWalkState);
    537  1.1  jruoho     if (NextWalkState)
    538  1.1  jruoho     {
    539  1.1  jruoho         AcpiDsDeleteWalkState (NextWalkState);
    540  1.1  jruoho     }
    541  1.1  jruoho 
    542  1.1  jruoho     return_ACPI_STATUS (Status);
    543  1.1  jruoho }
    544  1.1  jruoho 
    545  1.1  jruoho 
    546  1.1  jruoho /*******************************************************************************
    547  1.1  jruoho  *
    548  1.1  jruoho  * FUNCTION:    AcpiDsRestartControlMethod
    549  1.1  jruoho  *
    550  1.1  jruoho  * PARAMETERS:  WalkState           - State for preempted method (caller)
    551  1.1  jruoho  *              ReturnDesc          - Return value from the called method
    552  1.1  jruoho  *
    553  1.1  jruoho  * RETURN:      Status
    554  1.1  jruoho  *
    555  1.1  jruoho  * DESCRIPTION: Restart a method that was preempted by another (nested) method
    556  1.1  jruoho  *              invocation.  Handle the return value (if any) from the callee.
    557  1.1  jruoho  *
    558  1.1  jruoho  ******************************************************************************/
    559  1.1  jruoho 
    560  1.1  jruoho ACPI_STATUS
    561  1.1  jruoho AcpiDsRestartControlMethod (
    562  1.1  jruoho     ACPI_WALK_STATE         *WalkState,
    563  1.1  jruoho     ACPI_OPERAND_OBJECT     *ReturnDesc)
    564  1.1  jruoho {
    565  1.1  jruoho     ACPI_STATUS             Status;
    566  1.1  jruoho     int                     SameAsImplicitReturn;
    567  1.1  jruoho 
    568  1.1  jruoho 
    569  1.1  jruoho     ACPI_FUNCTION_TRACE_PTR (DsRestartControlMethod, WalkState);
    570  1.1  jruoho 
    571  1.1  jruoho 
    572  1.1  jruoho     ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH,
    573  1.1  jruoho         "****Restart [%4.4s] Op %p ReturnValueFromCallee %p\n",
    574  1.1  jruoho         AcpiUtGetNodeName (WalkState->MethodNode),
    575  1.1  jruoho         WalkState->MethodCallOp, ReturnDesc));
    576  1.1  jruoho 
    577  1.1  jruoho     ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH,
    578  1.1  jruoho         "    ReturnFromThisMethodUsed?=%X ResStack %p Walk %p\n",
    579  1.1  jruoho         WalkState->ReturnUsed,
    580  1.1  jruoho         WalkState->Results, WalkState));
    581  1.1  jruoho 
    582  1.1  jruoho     /* Did the called method return a value? */
    583  1.1  jruoho 
    584  1.1  jruoho     if (ReturnDesc)
    585  1.1  jruoho     {
    586  1.1  jruoho         /* Is the implicit return object the same as the return desc? */
    587  1.1  jruoho 
    588  1.1  jruoho         SameAsImplicitReturn = (WalkState->ImplicitReturnObj == ReturnDesc);
    589  1.1  jruoho 
    590  1.1  jruoho         /* Are we actually going to use the return value? */
    591  1.1  jruoho 
    592  1.1  jruoho         if (WalkState->ReturnUsed)
    593  1.1  jruoho         {
    594  1.1  jruoho             /* Save the return value from the previous method */
    595  1.1  jruoho 
    596  1.1  jruoho             Status = AcpiDsResultPush (ReturnDesc, WalkState);
    597  1.1  jruoho             if (ACPI_FAILURE (Status))
    598  1.1  jruoho             {
    599  1.1  jruoho                 AcpiUtRemoveReference (ReturnDesc);
    600  1.1  jruoho                 return_ACPI_STATUS (Status);
    601  1.1  jruoho             }
    602  1.1  jruoho 
    603  1.1  jruoho             /*
    604  1.1  jruoho              * Save as THIS method's return value in case it is returned
    605  1.1  jruoho              * immediately to yet another method
    606  1.1  jruoho              */
    607  1.1  jruoho             WalkState->ReturnDesc = ReturnDesc;
    608  1.1  jruoho         }
    609  1.1  jruoho 
    610  1.1  jruoho         /*
    611  1.1  jruoho          * The following code is the optional support for the so-called
    612  1.1  jruoho          * "implicit return". Some AML code assumes that the last value of the
    613  1.1  jruoho          * method is "implicitly" returned to the caller, in the absence of an
    614  1.1  jruoho          * explicit return value.
    615  1.1  jruoho          *
    616  1.1  jruoho          * Just save the last result of the method as the return value.
    617  1.1  jruoho          *
    618  1.1  jruoho          * NOTE: this is optional because the ASL language does not actually
    619  1.1  jruoho          * support this behavior.
    620  1.1  jruoho          */
    621  1.1  jruoho         else if (!AcpiDsDoImplicitReturn (ReturnDesc, WalkState, FALSE) ||
    622  1.1  jruoho                  SameAsImplicitReturn)
    623  1.1  jruoho         {
    624  1.1  jruoho             /*
    625  1.1  jruoho              * Delete the return value if it will not be used by the
    626  1.1  jruoho              * calling method or remove one reference if the explicit return
    627  1.1  jruoho              * is the same as the implicit return value.
    628  1.1  jruoho              */
    629  1.1  jruoho             AcpiUtRemoveReference (ReturnDesc);
    630  1.1  jruoho         }
    631  1.1  jruoho     }
    632  1.1  jruoho 
    633  1.1  jruoho     return_ACPI_STATUS (AE_OK);
    634  1.1  jruoho }
    635  1.1  jruoho 
    636  1.1  jruoho 
    637  1.1  jruoho /*******************************************************************************
    638  1.1  jruoho  *
    639  1.1  jruoho  * FUNCTION:    AcpiDsTerminateControlMethod
    640  1.1  jruoho  *
    641  1.1  jruoho  * PARAMETERS:  MethodDesc          - Method object
    642  1.1  jruoho  *              WalkState           - State associated with the method
    643  1.1  jruoho  *
    644  1.1  jruoho  * RETURN:      None
    645  1.1  jruoho  *
    646  1.1  jruoho  * DESCRIPTION: Terminate a control method.  Delete everything that the method
    647  1.1  jruoho  *              created, delete all locals and arguments, and delete the parse
    648  1.1  jruoho  *              tree if requested.
    649  1.1  jruoho  *
    650  1.1  jruoho  * MUTEX:       Interpreter is locked
    651  1.1  jruoho  *
    652  1.1  jruoho  ******************************************************************************/
    653  1.1  jruoho 
    654  1.1  jruoho void
    655  1.1  jruoho AcpiDsTerminateControlMethod (
    656  1.1  jruoho     ACPI_OPERAND_OBJECT     *MethodDesc,
    657  1.1  jruoho     ACPI_WALK_STATE         *WalkState)
    658  1.1  jruoho {
    659  1.1  jruoho 
    660  1.1  jruoho     ACPI_FUNCTION_TRACE_PTR (DsTerminateControlMethod, WalkState);
    661  1.1  jruoho 
    662  1.1  jruoho 
    663  1.1  jruoho     /* MethodDesc is required, WalkState is optional */
    664  1.1  jruoho 
    665  1.1  jruoho     if (!MethodDesc)
    666  1.1  jruoho     {
    667  1.1  jruoho         return_VOID;
    668  1.1  jruoho     }
    669  1.1  jruoho 
    670  1.1  jruoho     if (WalkState)
    671  1.1  jruoho     {
    672  1.1  jruoho         /* Delete all arguments and locals */
    673  1.1  jruoho 
    674  1.1  jruoho         AcpiDsMethodDataDeleteAll (WalkState);
    675  1.1  jruoho 
    676  1.1  jruoho         /*
    677  1.1  jruoho          * If method is serialized, release the mutex and restore the
    678  1.1  jruoho          * current sync level for this thread
    679  1.1  jruoho          */
    680  1.1  jruoho         if (MethodDesc->Method.Mutex)
    681  1.1  jruoho         {
    682  1.1  jruoho             /* Acquisition Depth handles recursive calls */
    683  1.1  jruoho 
    684  1.1  jruoho             MethodDesc->Method.Mutex->Mutex.AcquisitionDepth--;
    685  1.1  jruoho             if (!MethodDesc->Method.Mutex->Mutex.AcquisitionDepth)
    686  1.1  jruoho             {
    687  1.1  jruoho                 WalkState->Thread->CurrentSyncLevel =
    688  1.1  jruoho                     MethodDesc->Method.Mutex->Mutex.OriginalSyncLevel;
    689  1.1  jruoho 
    690  1.1  jruoho                 AcpiOsReleaseMutex (MethodDesc->Method.Mutex->Mutex.OsMutex);
    691  1.1  jruoho                 MethodDesc->Method.Mutex->Mutex.ThreadId = 0;
    692  1.1  jruoho             }
    693  1.1  jruoho         }
    694  1.1  jruoho 
    695  1.1  jruoho         /*
    696  1.1  jruoho          * Delete any namespace objects created anywhere within the
    697  1.1  jruoho          * namespace by the execution of this method. Unless this method
    698  1.1  jruoho          * is a module-level executable code method, in which case we
    699  1.1  jruoho          * want make the objects permanent.
    700  1.1  jruoho          */
    701  1.1  jruoho         if (!(MethodDesc->Method.Flags & AOPOBJ_MODULE_LEVEL))
    702  1.1  jruoho         {
    703  1.1  jruoho             /* Delete any direct children of (created by) this method */
    704  1.1  jruoho 
    705  1.1  jruoho             AcpiNsDeleteNamespaceSubtree (WalkState->MethodNode);
    706  1.1  jruoho 
    707  1.1  jruoho             /*
    708  1.1  jruoho              * Delete any objects that were created by this method
    709  1.1  jruoho              * elsewhere in the namespace (if any were created).
    710  1.1  jruoho              */
    711  1.1  jruoho             if (MethodDesc->Method.Flags & AOPOBJ_MODIFIED_NAMESPACE)
    712  1.1  jruoho             {
    713  1.1  jruoho                 AcpiNsDeleteNamespaceByOwner (MethodDesc->Method.OwnerId);
    714  1.1  jruoho             }
    715  1.1  jruoho         }
    716  1.1  jruoho     }
    717  1.1  jruoho 
    718  1.1  jruoho     /* Decrement the thread count on the method */
    719  1.1  jruoho 
    720  1.1  jruoho     if (MethodDesc->Method.ThreadCount)
    721  1.1  jruoho     {
    722  1.1  jruoho         MethodDesc->Method.ThreadCount--;
    723  1.1  jruoho     }
    724  1.1  jruoho     else
    725  1.1  jruoho     {
    726  1.1  jruoho         ACPI_ERROR ((AE_INFO,
    727  1.1  jruoho             "Invalid zero thread count in method"));
    728  1.1  jruoho     }
    729  1.1  jruoho 
    730  1.1  jruoho     /* Are there any other threads currently executing this method? */
    731  1.1  jruoho 
    732  1.1  jruoho     if (MethodDesc->Method.ThreadCount)
    733  1.1  jruoho     {
    734  1.1  jruoho         /*
    735  1.1  jruoho          * Additional threads. Do not release the OwnerId in this case,
    736  1.1  jruoho          * we immediately reuse it for the next thread executing this method
    737  1.1  jruoho          */
    738  1.1  jruoho         ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH,
    739  1.1  jruoho             "*** Completed execution of one thread, %u threads remaining\n",
    740  1.1  jruoho             MethodDesc->Method.ThreadCount));
    741  1.1  jruoho     }
    742  1.1  jruoho     else
    743  1.1  jruoho     {
    744  1.1  jruoho         /* This is the only executing thread for this method */
    745  1.1  jruoho 
    746  1.1  jruoho         /*
    747  1.1  jruoho          * Support to dynamically change a method from NotSerialized to
    748  1.1  jruoho          * Serialized if it appears that the method is incorrectly written and
    749  1.1  jruoho          * does not support multiple thread execution. The best example of this
    750  1.1  jruoho          * is if such a method creates namespace objects and blocks. A second
    751  1.1  jruoho          * thread will fail with an AE_ALREADY_EXISTS exception
    752  1.1  jruoho          *
    753  1.1  jruoho          * This code is here because we must wait until the last thread exits
    754  1.1  jruoho          * before creating the synchronization semaphore.
    755  1.1  jruoho          */
    756  1.1  jruoho         if ((MethodDesc->Method.MethodFlags & AML_METHOD_SERIALIZED) &&
    757  1.1  jruoho             (!MethodDesc->Method.Mutex))
    758  1.1  jruoho         {
    759  1.1  jruoho             (void) AcpiDsCreateMethodMutex (MethodDesc);
    760  1.1  jruoho         }
    761  1.1  jruoho 
    762  1.1  jruoho         /* No more threads, we can free the OwnerId */
    763  1.1  jruoho 
    764  1.1  jruoho         if (!(MethodDesc->Method.Flags & AOPOBJ_MODULE_LEVEL))
    765  1.1  jruoho         {
    766  1.1  jruoho             AcpiUtReleaseOwnerId (&MethodDesc->Method.OwnerId);
    767  1.1  jruoho         }
    768  1.1  jruoho     }
    769  1.1  jruoho 
    770  1.1  jruoho     return_VOID;
    771  1.1  jruoho }
    772  1.1  jruoho 
    773  1.1  jruoho 
    774