Home | History | Annotate | Line # | Download | only in acpiexec
      1 /******************************************************************************
      2  *
      3  * Module Name: aeexception - Exception and signal handlers
      4  *
      5  *****************************************************************************/
      6 
      7 /******************************************************************************
      8  *
      9  * 1. Copyright Notice
     10  *
     11  * Some or all of this work - Copyright (c) 1999 - 2025, Intel Corp.
     12  * All rights reserved.
     13  *
     14  * 2. License
     15  *
     16  * 2.1. This is your license from Intel Corp. under its intellectual property
     17  * rights. You may have additional license terms from the party that provided
     18  * you this software, covering your right to use that party's intellectual
     19  * property rights.
     20  *
     21  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
     22  * copy of the source code appearing in this file ("Covered Code") an
     23  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
     24  * base code distributed originally by Intel ("Original Intel Code") to copy,
     25  * make derivatives, distribute, use and display any portion of the Covered
     26  * Code in any form, with the right to sublicense such rights; and
     27  *
     28  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
     29  * license (with the right to sublicense), under only those claims of Intel
     30  * patents that are infringed by the Original Intel Code, to make, use, sell,
     31  * offer to sell, and import the Covered Code and derivative works thereof
     32  * solely to the minimum extent necessary to exercise the above copyright
     33  * license, and in no event shall the patent license extend to any additions
     34  * to or modifications of the Original Intel Code. No other license or right
     35  * is granted directly or by implication, estoppel or otherwise;
     36  *
     37  * The above copyright and patent license is granted only if the following
     38  * conditions are met:
     39  *
     40  * 3. Conditions
     41  *
     42  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
     43  * Redistribution of source code of any substantial portion of the Covered
     44  * Code or modification with rights to further distribute source must include
     45  * the above Copyright Notice, the above License, this list of Conditions,
     46  * and the following Disclaimer and Export Compliance provision. In addition,
     47  * Licensee must cause all Covered Code to which Licensee contributes to
     48  * contain a file documenting the changes Licensee made to create that Covered
     49  * Code and the date of any change. Licensee must include in that file the
     50  * documentation of any changes made by any predecessor Licensee. Licensee
     51  * must include a prominent statement that the modification is derived,
     52  * directly or indirectly, from Original Intel Code.
     53  *
     54  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
     55  * Redistribution of source code of any substantial portion of the Covered
     56  * Code or modification without rights to further distribute source must
     57  * include the following Disclaimer and Export Compliance provision in the
     58  * documentation and/or other materials provided with distribution. In
     59  * addition, Licensee may not authorize further sublicense of source of any
     60  * portion of the Covered Code, and must include terms to the effect that the
     61  * license from Licensee to its licensee is limited to the intellectual
     62  * property embodied in the software Licensee provides to its licensee, and
     63  * not to intellectual property embodied in modifications its licensee may
     64  * make.
     65  *
     66  * 3.3. Redistribution of Executable. Redistribution in executable form of any
     67  * substantial portion of the Covered Code or modification must reproduce the
     68  * above Copyright Notice, and the following Disclaimer and Export Compliance
     69  * provision in the documentation and/or other materials provided with the
     70  * distribution.
     71  *
     72  * 3.4. Intel retains all right, title, and interest in and to the Original
     73  * Intel Code.
     74  *
     75  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
     76  * Intel shall be used in advertising or otherwise to promote the sale, use or
     77  * other dealings in products derived from or relating to the Covered Code
     78  * without prior written authorization from Intel.
     79  *
     80  * 4. Disclaimer and Export Compliance
     81  *
     82  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
     83  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
     84  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
     85  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
     86  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
     87  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
     88  * PARTICULAR PURPOSE.
     89  *
     90  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
     91  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
     92  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
     93  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
     94  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
     95  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
     96  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
     97  * LIMITED REMEDY.
     98  *
     99  * 4.3. Licensee shall not export, either directly or indirectly, any of this
    100  * software or system incorporating such software without first obtaining any
    101  * required license or other approval from the U. S. Department of Commerce or
    102  * any other agency or department of the United States Government. In the
    103  * event Licensee exports any such software from the United States or
    104  * re-exports any such software from a foreign destination, Licensee shall
    105  * ensure that the distribution and export/re-export of the software is in
    106  * compliance with all laws, regulations, orders, or other restrictions of the
    107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
    108  * any of its subsidiaries will export/re-export any technical data, process,
    109  * software, or service, directly or indirectly, to any country for which the
    110  * United States government or any agency thereof requires an export license,
    111  * other governmental approval, or letter of assurance, without first obtaining
    112  * such license, approval or letter.
    113  *
    114  *****************************************************************************
    115  *
    116  * Alternatively, you may choose to be licensed under the terms of the
    117  * following license:
    118  *
    119  * Redistribution and use in source and binary forms, with or without
    120  * modification, are permitted provided that the following conditions
    121  * are met:
    122  * 1. Redistributions of source code must retain the above copyright
    123  *    notice, this list of conditions, and the following disclaimer,
    124  *    without modification.
    125  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
    126  *    substantially similar to the "NO WARRANTY" disclaimer below
    127  *    ("Disclaimer") and any redistribution must be conditioned upon
    128  *    including a substantially similar Disclaimer requirement for further
    129  *    binary redistribution.
    130  * 3. Neither the names of the above-listed copyright holders nor the names
    131  *    of any contributors may be used to endorse or promote products derived
    132  *    from this software without specific prior written permission.
    133  *
    134  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
    135  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
    136  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
    137  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
    138  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
    139  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
    140  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
    141  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
    142  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
    143  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
    144  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    145  *
    146  * Alternatively, you may choose to be licensed under the terms of the
    147  * GNU General Public License ("GPL") version 2 as published by the Free
    148  * Software Foundation.
    149  *
    150  *****************************************************************************/
    151 
    152 #include "aecommon.h"
    153 
    154 #define _COMPONENT          ACPI_TOOLS
    155         ACPI_MODULE_NAME    ("aeexception")
    156 
    157 
    158 /* Local prototypes */
    159 
    160 static void
    161 AeDisplayMethodCallStack (
    162     void);
    163 
    164 
    165 UINT32                      SigintCount = 0;
    166 #define ACPI_MAX_CONTROL_C  5
    167 
    168 
    169 /******************************************************************************
    170  *
    171  * FUNCTION:    AeExceptionHandler
    172  *
    173  * PARAMETERS:  Standard exception handler parameters
    174  *
    175  * RETURN:      Status
    176  *
    177  * DESCRIPTION: System exception handler for AcpiExec utility. Called from
    178  *              the core ACPICA code after any exception during method
    179  *              execution.
    180  *
    181  *****************************************************************************/
    182 
    183 ACPI_STATUS
    184 AeExceptionHandler (
    185     ACPI_STATUS             AmlStatus,
    186     ACPI_NAME               Name,
    187     UINT16                  Opcode,
    188     UINT32                  AmlOffset,
    189     void                    *Context)
    190 {
    191     ACPI_STATUS             NewAmlStatus = AmlStatus;
    192     ACPI_STATUS             Status;
    193     ACPI_BUFFER             ReturnObj;
    194     ACPI_OBJECT_LIST        ArgList;
    195     ACPI_OBJECT             Arg[3];
    196     const char              *Exception;
    197     ACPI_HANDLE             ErrHandle;
    198 
    199 
    200     Exception = AcpiFormatException (AmlStatus);
    201 
    202     if (AcpiGbl_VerboseHandlers)
    203     {
    204         AcpiOsPrintf (AE_PREFIX
    205             "Exception %s during execution\n", Exception);
    206 
    207         if (Name)
    208         {
    209             if (ACPI_COMPARE_NAMESEG (&Name, ACPI_ROOT_PATHNAME))
    210             {
    211                 AcpiOsPrintf (AE_PREFIX
    212                     "Evaluating executable code at [%s]\n", ACPI_NAMESPACE_ROOT);
    213             }
    214             else
    215             {
    216                 AcpiOsPrintf (AE_PREFIX
    217                     "Evaluating Method or Node: [%4.4s]\n", (char *) &Name);
    218             }
    219         }
    220 
    221         /* Be terse about loop timeouts */
    222 
    223         if ((AmlStatus == AE_AML_LOOP_TIMEOUT) && AcpiGbl_AbortLoopOnTimeout)
    224         {
    225             AcpiOsPrintf (AE_PREFIX "Aborting loop after timeout\n");
    226             return (AE_OK);
    227         }
    228 
    229         AcpiOsPrintf ("\n" AE_PREFIX
    230             "AML Opcode [%s], Method Offset ~%5.5X\n",
    231             AcpiPsGetOpcodeName (Opcode), AmlOffset);
    232     }
    233 
    234     /* Invoke the _ERR method if present */
    235 
    236     Status = AcpiGetHandle (NULL, "\\_ERR", &ErrHandle);
    237     if (ACPI_FAILURE (Status))
    238     {
    239         goto Cleanup;
    240     }
    241 
    242     /* Setup parameter object */
    243 
    244     ArgList.Count = 3;
    245     ArgList.Pointer = Arg;
    246 
    247     Arg[0].Type = ACPI_TYPE_INTEGER;
    248     Arg[0].Integer.Value = AmlStatus;
    249 
    250     Arg[1].Type = ACPI_TYPE_STRING;
    251     Arg[1].String.Pointer = ACPI_CAST_PTR (char, Exception);
    252     Arg[1].String.Length = strlen (Exception);
    253 
    254     Arg[2].Type = ACPI_TYPE_INTEGER;
    255     Arg[2].Integer.Value = AcpiOsGetThreadId();
    256 
    257     /* Setup return buffer */
    258 
    259     ReturnObj.Pointer = NULL;
    260     ReturnObj.Length = ACPI_ALLOCATE_BUFFER;
    261 
    262     Status = AcpiEvaluateObject (ErrHandle, NULL, &ArgList, &ReturnObj);
    263     if (ACPI_SUCCESS (Status))
    264     {
    265         if (ReturnObj.Pointer)
    266         {
    267             /* Override original status */
    268 
    269             NewAmlStatus = (ACPI_STATUS)
    270                 ((ACPI_OBJECT *) ReturnObj.Pointer)->Integer.Value;
    271 
    272             /* Free a buffer created via ACPI_ALLOCATE_BUFFER */
    273 
    274             AcpiOsFree (ReturnObj.Pointer);
    275         }
    276     }
    277     else if (Status != AE_NOT_FOUND)
    278     {
    279         AcpiOsPrintf (AE_PREFIX
    280             "Could not execute _ERR method, %s\n",
    281             AcpiFormatException (Status));
    282     }
    283 
    284 Cleanup:
    285 
    286     if (AcpiGbl_IgnoreErrors)
    287     {
    288         /* Global option to ignore all method errors, just return OK */
    289 
    290         NewAmlStatus = AE_OK;
    291     }
    292     if (NewAmlStatus != AmlStatus)
    293     {
    294         /* Request to override actual status with a different status */
    295 
    296         AcpiOsPrintf (AE_PREFIX
    297             "Exception override, new status %s\n\n",
    298             AcpiFormatException (NewAmlStatus));
    299     }
    300 
    301     return (NewAmlStatus);
    302 }
    303 
    304 
    305 /******************************************************************************
    306  *
    307  * FUNCTION:    AeSignalHandler
    308  *
    309  * PARAMETERS:  Sig
    310  *
    311  * RETURN:      none
    312  *
    313  * DESCRIPTION: Master signal handler. Currently handles SIGINT (ctrl-c),
    314  *              and SIGSEGV (Segment violation).
    315  *
    316  *****************************************************************************/
    317 
    318 void ACPI_SYSTEM_XFACE
    319 AeSignalHandler (
    320     int                     Sig)
    321 {
    322 
    323     fflush(stdout);
    324     AcpiOsPrintf ("\n" AE_PREFIX);
    325 
    326     switch (Sig)
    327     {
    328     case SIGINT:
    329         signal(Sig, SIG_IGN);
    330         AcpiOsPrintf ("<Control-C>\n");
    331 
    332         /* Force exit on multiple control-c */
    333 
    334         SigintCount++;
    335         if (SigintCount >= ACPI_MAX_CONTROL_C)
    336         {
    337             _exit (0);
    338         }
    339 
    340         /* Abort the application if there are no methods executing */
    341 
    342         if (!AcpiGbl_MethodExecuting)
    343         {
    344             break;
    345         }
    346 
    347         /*
    348          * Abort the method(s). This will also dump the method call
    349          * stack so there is no need to do it here. The application
    350          * will then drop back into the debugger interface.
    351          */
    352         AcpiGbl_AbortMethod = TRUE;
    353         AcpiOsPrintf (AE_PREFIX "Control Method Call Stack:\n");
    354         signal (SIGINT, AeSignalHandler);
    355         return;
    356 
    357     case SIGSEGV:
    358         AcpiOsPrintf ("Segmentation Fault\n");
    359         AeDisplayMethodCallStack ();
    360         break;
    361 
    362     default:
    363         AcpiOsPrintf ("Unknown Signal, %X\n", Sig);
    364         break;
    365     }
    366 
    367     /* Terminate application -- cleanup then exit */
    368 
    369     AcpiOsPrintf (AE_PREFIX "Terminating\n");
    370     (void) AcpiOsTerminate ();
    371     _exit (0);
    372 }
    373 
    374 
    375 /******************************************************************************
    376  *
    377  * FUNCTION:    AeDisplayMethodCallStack
    378  *
    379  * PARAMETERS:  None
    380  *
    381  * RETURN:      None
    382  *
    383  * DESCRIPTION: Display current method call stack, if possible.
    384  *
    385  * NOTE:        Currently only called from a SIGSEGV, so AcpiExec is about
    386  *              to terminate.
    387  *
    388  *****************************************************************************/
    389 
    390 static void
    391 AeDisplayMethodCallStack (
    392     void)
    393 {
    394     ACPI_WALK_STATE         *WalkState;
    395     ACPI_THREAD_STATE       *ThreadList = AcpiGbl_CurrentWalkList;
    396     char                    *FullPathname = NULL;
    397 
    398 
    399     if (!AcpiGbl_MethodExecuting)
    400     {
    401         AcpiOsPrintf (AE_PREFIX "No method is executing\n");
    402         return;
    403     }
    404 
    405     /*
    406      * Try to find the currently executing control method(s)
    407      *
    408      * Note: The following code may fault if the data structures are
    409      * in an indeterminate state when the interrupt occurs. However,
    410      * in practice, this works quite well and can provide very
    411      * valuable information.
    412      *
    413      * 1) Walk the global thread list
    414      */
    415     while (ThreadList &&
    416         (ThreadList->DescriptorType == ACPI_DESC_TYPE_STATE_THREAD))
    417     {
    418         /* 2) Walk the walk state list for this thread */
    419 
    420         WalkState = ThreadList->WalkStateList;
    421         while (WalkState &&
    422             (WalkState->DescriptorType == ACPI_DESC_TYPE_WALK))
    423         {
    424             /* An executing control method */
    425 
    426             if (WalkState->MethodNode)
    427             {
    428                 FullPathname = AcpiNsGetExternalPathname (
    429                     WalkState->MethodNode);
    430 
    431                 AcpiOsPrintf (AE_PREFIX
    432                     "Executing Method: %s\n", FullPathname);
    433             }
    434 
    435             /* Execution of a deferred opcode/node */
    436 
    437             if (WalkState->DeferredNode)
    438             {
    439                 FullPathname = AcpiNsGetExternalPathname (
    440                     WalkState->DeferredNode);
    441 
    442                 AcpiOsPrintf (AE_PREFIX
    443                     "Evaluating deferred node: %s\n", FullPathname);
    444             }
    445 
    446             /* Get the currently executing AML opcode */
    447 
    448             if ((WalkState->Opcode != AML_INT_METHODCALL_OP) &&
    449                 FullPathname)
    450             {
    451                 AcpiOsPrintf (AE_PREFIX
    452                     "Current AML Opcode in %s: [%s]-0x%4.4X at %p\n",
    453                     FullPathname, AcpiPsGetOpcodeName (WalkState->Opcode),
    454                     WalkState->Opcode, WalkState->Aml);
    455             }
    456 
    457             if (FullPathname)
    458             {
    459                 ACPI_FREE (FullPathname);
    460                 FullPathname = NULL;
    461             }
    462 
    463             WalkState = WalkState->Next;
    464         }
    465 
    466         ThreadList = ThreadList->Next;
    467     }
    468 }
    469