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 - 2018, 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 /****************************************************************************** 166 * 167 * FUNCTION: AeExceptionHandler 168 * 169 * PARAMETERS: Standard exception handler parameters 170 * 171 * RETURN: Status 172 * 173 * DESCRIPTION: System exception handler for AcpiExec utility. Called from 174 * the core ACPICA code after any exception during method 175 * execution. 176 * 177 *****************************************************************************/ 178 179 ACPI_STATUS 180 AeExceptionHandler ( 181 ACPI_STATUS AmlStatus, 182 ACPI_NAME Name, 183 UINT16 Opcode, 184 UINT32 AmlOffset, 185 void *Context) 186 { 187 ACPI_STATUS NewAmlStatus = AmlStatus; 188 ACPI_STATUS Status; 189 ACPI_BUFFER ReturnObj; 190 ACPI_OBJECT_LIST ArgList; 191 ACPI_OBJECT Arg[3]; 192 const char *Exception; 193 ACPI_HANDLE ErrHandle; 194 195 196 Exception = AcpiFormatException (AmlStatus); 197 AcpiOsPrintf (AE_PREFIX 198 "Exception %s during execution\n", Exception); 199 200 if (Name) 201 { 202 if (ACPI_COMPARE_NAME (&Name, ACPI_ROOT_PATHNAME)) 203 { 204 AcpiOsPrintf (AE_PREFIX 205 "Evaluating executable code at [%s]\n", ACPI_NAMESPACE_ROOT); 206 } 207 else 208 { 209 AcpiOsPrintf (AE_PREFIX 210 "Evaluating Method or Node: [%4.4s]\n", (char *) &Name); 211 } 212 } 213 214 /* Be terse about loop timeouts */ 215 216 if ((AmlStatus == AE_AML_LOOP_TIMEOUT) && AcpiGbl_AbortLoopOnTimeout) 217 { 218 AcpiOsPrintf (AE_PREFIX "Aborting loop after timeout\n"); 219 return (AE_OK); 220 } 221 222 AcpiOsPrintf ("\n" AE_PREFIX 223 "AML Opcode [%s], Method Offset ~%5.5X\n", 224 AcpiPsGetOpcodeName (Opcode), AmlOffset); 225 226 /* Invoke the _ERR method if present */ 227 228 Status = AcpiGetHandle (NULL, "\\_ERR", &ErrHandle); 229 if (ACPI_FAILURE (Status)) 230 { 231 goto Cleanup; 232 } 233 234 /* Setup parameter object */ 235 236 ArgList.Count = 3; 237 ArgList.Pointer = Arg; 238 239 Arg[0].Type = ACPI_TYPE_INTEGER; 240 Arg[0].Integer.Value = AmlStatus; 241 242 Arg[1].Type = ACPI_TYPE_STRING; 243 Arg[1].String.Pointer = ACPI_CAST_PTR (char, Exception); 244 Arg[1].String.Length = strlen (Exception); 245 246 Arg[2].Type = ACPI_TYPE_INTEGER; 247 Arg[2].Integer.Value = AcpiOsGetThreadId(); 248 249 /* Setup return buffer */ 250 251 ReturnObj.Pointer = NULL; 252 ReturnObj.Length = ACPI_ALLOCATE_BUFFER; 253 254 Status = AcpiEvaluateObject (ErrHandle, NULL, &ArgList, &ReturnObj); 255 if (ACPI_SUCCESS (Status)) 256 { 257 if (ReturnObj.Pointer) 258 { 259 /* Override original status */ 260 261 NewAmlStatus = (ACPI_STATUS) 262 ((ACPI_OBJECT *) ReturnObj.Pointer)->Integer.Value; 263 264 /* Free a buffer created via ACPI_ALLOCATE_BUFFER */ 265 266 AcpiOsFree (ReturnObj.Pointer); 267 } 268 } 269 else if (Status != AE_NOT_FOUND) 270 { 271 AcpiOsPrintf (AE_PREFIX 272 "Could not execute _ERR method, %s\n", 273 AcpiFormatException (Status)); 274 } 275 276 Cleanup: 277 278 if (AcpiGbl_IgnoreErrors) 279 { 280 /* Global option to ignore all method errors, just return OK */ 281 282 NewAmlStatus = AE_OK; 283 } 284 if (NewAmlStatus != AmlStatus) 285 { 286 /* Request to override actual status with a different status */ 287 288 AcpiOsPrintf (AE_PREFIX 289 "Exception override, new status %s\n\n", 290 AcpiFormatException (NewAmlStatus)); 291 } 292 293 return (NewAmlStatus); 294 } 295 296 297 /****************************************************************************** 298 * 299 * FUNCTION: AeSignalHandler 300 * 301 * PARAMETERS: Sig 302 * 303 * RETURN: none 304 * 305 * DESCRIPTION: Master signal handler. Currently handles SIGINT (ctrl-c), 306 * and SIGSEGV (Segment violation). 307 * 308 *****************************************************************************/ 309 310 void ACPI_SYSTEM_XFACE 311 AeSignalHandler ( 312 int Sig) 313 { 314 315 fflush(stdout); 316 AcpiOsPrintf ("\n" AE_PREFIX); 317 318 switch (Sig) 319 { 320 case SIGINT: 321 signal(Sig, SIG_IGN); 322 AcpiOsPrintf ("<Control-C>\n"); 323 324 /* Abort the application if there are no methods executing */ 325 326 if (!AcpiGbl_MethodExecuting) 327 { 328 break; 329 } 330 331 /* 332 * Abort the method(s). This will also dump the method call 333 * stack so there is no need to do it here. The application 334 * will then drop back into the debugger interface. 335 */ 336 AcpiGbl_AbortMethod = TRUE; 337 AcpiOsPrintf (AE_PREFIX "Control Method Call Stack:\n"); 338 signal (SIGINT, AeSignalHandler); 339 return; 340 341 case SIGSEGV: 342 AcpiOsPrintf ("Segmentation Fault\n"); 343 AeDisplayMethodCallStack (); 344 break; 345 346 default: 347 AcpiOsPrintf ("Unknown Signal, %X\n", Sig); 348 break; 349 } 350 351 /* Terminate application -- cleanup then exit */ 352 353 AcpiOsPrintf (AE_PREFIX "Terminating\n"); 354 (void) AcpiOsTerminate (); 355 exit (0); 356 } 357 358 359 /****************************************************************************** 360 * 361 * FUNCTION: AeDisplayMethodCallStack 362 * 363 * PARAMETERS: None 364 * 365 * RETURN: None 366 * 367 * DESCRIPTION: Display current method call stack, if possible. 368 * 369 * NOTE: Currently only called from a SIGSEGV, so AcpiExec is about 370 * to terminate. 371 * 372 *****************************************************************************/ 373 374 static void 375 AeDisplayMethodCallStack ( 376 void) 377 { 378 ACPI_WALK_STATE *WalkState; 379 ACPI_THREAD_STATE *ThreadList = AcpiGbl_CurrentWalkList; 380 char *FullPathname = NULL; 381 382 383 if (!AcpiGbl_MethodExecuting) 384 { 385 AcpiOsPrintf (AE_PREFIX "No method is executing\n"); 386 return; 387 } 388 389 /* 390 * Try to find the currently executing control method(s) 391 * 392 * Note: The following code may fault if the data structures are 393 * in an indeterminate state when the interrupt occurs. However, 394 * in practice, this works quite well and can provide very 395 * valuable information. 396 * 397 * 1) Walk the global thread list 398 */ 399 while (ThreadList && 400 (ThreadList->DescriptorType == ACPI_DESC_TYPE_STATE_THREAD)) 401 { 402 /* 2) Walk the walk state list for this thread */ 403 404 WalkState = ThreadList->WalkStateList; 405 while (WalkState && 406 (WalkState->DescriptorType == ACPI_DESC_TYPE_WALK)) 407 { 408 /* An executing control method */ 409 410 if (WalkState->MethodNode) 411 { 412 FullPathname = AcpiNsGetExternalPathname ( 413 WalkState->MethodNode); 414 415 AcpiOsPrintf (AE_PREFIX 416 "Executing Method: %s\n", FullPathname); 417 } 418 419 /* Execution of a deferred opcode/node */ 420 421 if (WalkState->DeferredNode) 422 { 423 FullPathname = AcpiNsGetExternalPathname ( 424 WalkState->DeferredNode); 425 426 AcpiOsPrintf (AE_PREFIX 427 "Evaluating deferred node: %s\n", FullPathname); 428 } 429 430 /* Get the currently executing AML opcode */ 431 432 if ((WalkState->Opcode != AML_INT_METHODCALL_OP) && 433 FullPathname) 434 { 435 AcpiOsPrintf (AE_PREFIX 436 "Current AML Opcode in %s: [%s]-0x%4.4X at %p\n", 437 FullPathname, AcpiPsGetOpcodeName (WalkState->Opcode), 438 WalkState->Opcode, WalkState->Aml); 439 } 440 441 if (FullPathname) 442 { 443 ACPI_FREE (FullPathname); 444 FullPathname = NULL; 445 } 446 447 WalkState = WalkState->Next; 448 } 449 450 ThreadList = ThreadList->Next; 451 } 452 } 453