aslerror.c revision 212761
1 2/****************************************************************************** 3 * 4 * Module Name: aslerror - Error handling and statistics 5 * 6 *****************************************************************************/ 7 8/****************************************************************************** 9 * 10 * 1. Copyright Notice 11 * 12 * Some or all of this work - Copyright (c) 1999 - 2010, Intel Corp. 13 * All rights reserved. 14 * 15 * 2. License 16 * 17 * 2.1. This is your license from Intel Corp. under its intellectual property 18 * rights. You may have additional license terms from the party that provided 19 * you this software, covering your right to use that party's intellectual 20 * property rights. 21 * 22 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 23 * copy of the source code appearing in this file ("Covered Code") an 24 * irrevocable, perpetual, worldwide license under Intel's copyrights in the 25 * base code distributed originally by Intel ("Original Intel Code") to copy, 26 * make derivatives, distribute, use and display any portion of the Covered 27 * Code in any form, with the right to sublicense such rights; and 28 * 29 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 30 * license (with the right to sublicense), under only those claims of Intel 31 * patents that are infringed by the Original Intel Code, to make, use, sell, 32 * offer to sell, and import the Covered Code and derivative works thereof 33 * solely to the minimum extent necessary to exercise the above copyright 34 * license, and in no event shall the patent license extend to any additions 35 * to or modifications of the Original Intel Code. No other license or right 36 * is granted directly or by implication, estoppel or otherwise; 37 * 38 * The above copyright and patent license is granted only if the following 39 * conditions are met: 40 * 41 * 3. Conditions 42 * 43 * 3.1. Redistribution of Source with Rights to Further Distribute Source. 44 * Redistribution of source code of any substantial portion of the Covered 45 * Code or modification with rights to further distribute source must include 46 * the above Copyright Notice, the above License, this list of Conditions, 47 * and the following Disclaimer and Export Compliance provision. In addition, 48 * Licensee must cause all Covered Code to which Licensee contributes to 49 * contain a file documenting the changes Licensee made to create that Covered 50 * Code and the date of any change. Licensee must include in that file the 51 * documentation of any changes made by any predecessor Licensee. Licensee 52 * must include a prominent statement that the modification is derived, 53 * directly or indirectly, from Original Intel Code. 54 * 55 * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 56 * Redistribution of source code of any substantial portion of the Covered 57 * Code or modification without rights to further distribute source must 58 * include the following Disclaimer and Export Compliance provision in the 59 * documentation and/or other materials provided with distribution. In 60 * addition, Licensee may not authorize further sublicense of source of any 61 * portion of the Covered Code, and must include terms to the effect that the 62 * license from Licensee to its licensee is limited to the intellectual 63 * property embodied in the software Licensee provides to its licensee, and 64 * not to intellectual property embodied in modifications its licensee may 65 * make. 66 * 67 * 3.3. Redistribution of Executable. Redistribution in executable form of any 68 * substantial portion of the Covered Code or modification must reproduce the 69 * above Copyright Notice, and the following Disclaimer and Export Compliance 70 * provision in the documentation and/or other materials provided with the 71 * distribution. 72 * 73 * 3.4. Intel retains all right, title, and interest in and to the Original 74 * Intel Code. 75 * 76 * 3.5. Neither the name Intel nor any other trademark owned or controlled by 77 * Intel shall be used in advertising or otherwise to promote the sale, use or 78 * other dealings in products derived from or relating to the Covered Code 79 * without prior written authorization from Intel. 80 * 81 * 4. Disclaimer and Export Compliance 82 * 83 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 84 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 85 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 86 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 87 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 88 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 89 * PARTICULAR PURPOSE. 90 * 91 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 92 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 93 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 94 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 95 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 96 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 97 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 98 * LIMITED REMEDY. 99 * 100 * 4.3. Licensee shall not export, either directly or indirectly, any of this 101 * software or system incorporating such software without first obtaining any 102 * required license or other approval from the U. S. Department of Commerce or 103 * any other agency or department of the United States Government. In the 104 * event Licensee exports any such software from the United States or 105 * re-exports any such software from a foreign destination, Licensee shall 106 * ensure that the distribution and export/re-export of the software is in 107 * compliance with all laws, regulations, orders, or other restrictions of the 108 * U.S. Export Administration Regulations. Licensee agrees that neither it nor 109 * any of its subsidiaries will export/re-export any technical data, process, 110 * software, or service, directly or indirectly, to any country for which the 111 * United States government or any agency thereof requires an export license, 112 * other governmental approval, or letter of assurance, without first obtaining 113 * such license, approval or letter. 114 * 115 *****************************************************************************/ 116 117#define ASL_EXCEPTIONS 118#include <contrib/dev/acpica/compiler/aslcompiler.h> 119 120#define _COMPONENT ACPI_COMPILER 121 ACPI_MODULE_NAME ("aslerror") 122 123/* Local prototypes */ 124 125static void 126AeAddToErrorLog ( 127 ASL_ERROR_MSG *Enode); 128 129 130void 131AeClearErrorLog ( 132 void) 133{ 134 ASL_ERROR_MSG *Enode = Gbl_ErrorLog; 135 ASL_ERROR_MSG *Next; 136 137 /* Walk the error node list */ 138 139 while (Enode) 140 { 141 Next = Enode->Next; 142 ACPI_FREE (Enode); 143 Enode = Next; 144 } 145 146 Gbl_ErrorLog = NULL; 147} 148 149 150/******************************************************************************* 151 * 152 * FUNCTION: AeAddToErrorLog 153 * 154 * PARAMETERS: Enode - An error node to add to the log 155 * 156 * RETURN: None 157 * 158 * DESCRIPTION: Add a new error node to the error log. The error log is 159 * ordered by the "logical" line number (cumulative line number 160 * including all include files.) 161 * 162 ******************************************************************************/ 163 164static void 165AeAddToErrorLog ( 166 ASL_ERROR_MSG *Enode) 167{ 168 ASL_ERROR_MSG *Next; 169 ASL_ERROR_MSG *Prev; 170 171 172 /* If Gbl_ErrorLog is null, this is the first error node */ 173 174 if (!Gbl_ErrorLog) 175 { 176 Gbl_ErrorLog = Enode; 177 return; 178 } 179 180 /* 181 * Walk error list until we find a line number greater than ours. 182 * List is sorted according to line number. 183 */ 184 Prev = NULL; 185 Next = Gbl_ErrorLog; 186 187 while ((Next) && 188 (Next->LogicalLineNumber <= Enode->LogicalLineNumber)) 189 { 190 Prev = Next; 191 Next = Next->Next; 192 } 193 194 /* Found our place in the list */ 195 196 Enode->Next = Next; 197 198 if (Prev) 199 { 200 Prev->Next = Enode; 201 } 202 else 203 { 204 Gbl_ErrorLog = Enode; 205 } 206} 207 208 209/******************************************************************************* 210 * 211 * FUNCTION: AePrintException 212 * 213 * PARAMETERS: FileId - ID of output file 214 * Enode - Error node to print 215 * Header - Additional text before each message 216 * 217 * RETURN: None 218 * 219 * DESCRIPTION: Print the contents of an error node. 220 * 221 * NOTE: We don't use the FlxxxFile I/O functions here because on error 222 * they abort the compiler and call this function! Since we 223 * are reporting errors here, we ignore most output errors and 224 * just try to get out as much as we can. 225 * 226 ******************************************************************************/ 227 228void 229AePrintException ( 230 UINT32 FileId, 231 ASL_ERROR_MSG *Enode, 232 char *Header) 233{ 234 UINT8 SourceByte; 235 int Actual; 236 size_t RActual; 237 UINT32 MsgLength; 238 char *MainMessage; 239 char *ExtraMessage; 240 UINT32 SourceColumn; 241 UINT32 ErrorColumn; 242 FILE *OutputFile; 243 FILE *SourceFile; 244 245 246 if (Gbl_NoErrors) 247 { 248 return; 249 } 250 251 /* 252 * Only listing files have a header, and remarks/optimizations 253 * are always output 254 */ 255 if (!Header) 256 { 257 /* Ignore remarks if requested */ 258 259 switch (Enode->Level) 260 { 261 case ASL_REMARK: 262 if (!Gbl_DisplayRemarks) 263 { 264 return; 265 } 266 break; 267 268 case ASL_OPTIMIZATION: 269 if (!Gbl_DisplayOptimizations) 270 { 271 return; 272 } 273 break; 274 275 default: 276 break; 277 } 278 } 279 280 /* Get the file handles */ 281 282 OutputFile = Gbl_Files[FileId].Handle; 283 284 /* Use the merged header/source file if present, otherwise use input file */ 285 286 SourceFile = Gbl_Files[ASL_FILE_SOURCE_OUTPUT].Handle; 287 if (!SourceFile) 288 { 289 SourceFile = Gbl_Files[ASL_FILE_INPUT].Handle; 290 } 291 292 if (Header) 293 { 294 fprintf (OutputFile, "%s", Header); 295 } 296 297 /* Print filename and line number if present and valid */ 298 299 if (Enode->Filename) 300 { 301 if (Gbl_VerboseErrors) 302 { 303 fprintf (OutputFile, "%6s", Enode->Filename); 304 305 if (Enode->LineNumber) 306 { 307 fprintf (OutputFile, " %6u: ", Enode->LineNumber); 308 309 /* 310 * Seek to the offset in the combined source file, read the source 311 * line, and write it to the output. 312 */ 313 Actual = fseek (SourceFile, (long) Enode->LogicalByteOffset, 314 (int) SEEK_SET); 315 if (Actual) 316 { 317 fprintf (OutputFile, 318 "[*** iASL: Seek error on source code temp file %s ***]", 319 Gbl_Files[ASL_FILE_SOURCE_OUTPUT].Filename); 320 } 321 else 322 { 323 RActual = fread (&SourceByte, 1, 1, SourceFile); 324 if (!RActual) 325 { 326 fprintf (OutputFile, 327 "[*** iASL: Read error on source code temp file %s ***]", 328 Gbl_Files[ASL_FILE_SOURCE_OUTPUT].Filename); 329 } 330 331 else while (RActual && SourceByte && (SourceByte != '\n')) 332 { 333 fwrite (&SourceByte, 1, 1, OutputFile); 334 RActual = fread (&SourceByte, 1, 1, SourceFile); 335 } 336 } 337 fprintf (OutputFile, "\n"); 338 } 339 } 340 else 341 { 342 fprintf (OutputFile, "%s", Enode->Filename); 343 344 if (Enode->LineNumber) 345 { 346 fprintf (OutputFile, "(%u) : ", Enode->LineNumber); 347 } 348 } 349 } 350 351 /* NULL message ID, just print the raw message */ 352 353 if (Enode->MessageId == 0) 354 { 355 fprintf (OutputFile, "%s\n", Enode->Message); 356 } 357 else 358 { 359 /* Decode the message ID */ 360 361 fprintf (OutputFile, "%s %4.4d - ", 362 AslErrorLevel[Enode->Level], 363 Enode->MessageId + ((Enode->Level+1) * 1000)); 364 365 MainMessage = AslMessages[Enode->MessageId]; 366 ExtraMessage = Enode->Message; 367 368 if (Enode->LineNumber) 369 { 370 MsgLength = strlen (MainMessage); 371 if (MsgLength == 0) 372 { 373 MainMessage = Enode->Message; 374 375 MsgLength = strlen (MainMessage); 376 ExtraMessage = NULL; 377 } 378 379 if (Gbl_VerboseErrors) 380 { 381 SourceColumn = Enode->Column + Enode->FilenameLength + 6 + 2; 382 ErrorColumn = ASL_ERROR_LEVEL_LENGTH + 5 + 2 + 1; 383 384 if ((MsgLength + ErrorColumn) < (SourceColumn - 1)) 385 { 386 fprintf (OutputFile, "%*s%s", 387 (int) ((SourceColumn - 1) - ErrorColumn), 388 MainMessage, " ^ "); 389 } 390 else 391 { 392 fprintf (OutputFile, "%*s %s", 393 (int) ((SourceColumn - ErrorColumn) + 1), "^", 394 MainMessage); 395 } 396 } 397 else 398 { 399 fprintf (OutputFile, " %s", MainMessage); 400 } 401 402 /* Print the extra info message if present */ 403 404 if (ExtraMessage) 405 { 406 fprintf (OutputFile, " (%s)", ExtraMessage); 407 } 408 409 fprintf (OutputFile, "\n"); 410 if (Gbl_VerboseErrors) 411 { 412 fprintf (OutputFile, "\n"); 413 } 414 } 415 else 416 { 417 fprintf (OutputFile, " %s %s\n\n", MainMessage, ExtraMessage); 418 } 419 } 420} 421 422 423/******************************************************************************* 424 * 425 * FUNCTION: AePrintErrorLog 426 * 427 * PARAMETERS: FileId - Where to output the error log 428 * 429 * RETURN: None 430 * 431 * DESCRIPTION: Print the entire contents of the error log 432 * 433 ******************************************************************************/ 434 435void 436AePrintErrorLog ( 437 UINT32 FileId) 438{ 439 ASL_ERROR_MSG *Enode = Gbl_ErrorLog; 440 441 442 /* Walk the error node list */ 443 444 while (Enode) 445 { 446 AePrintException (FileId, Enode, NULL); 447 Enode = Enode->Next; 448 } 449} 450 451 452/******************************************************************************* 453 * 454 * FUNCTION: AslCommonError 455 * 456 * PARAMETERS: Level - Seriousness (Warning/error, etc.) 457 * MessageId - Index into global message buffer 458 * CurrentLineNumber - Actual file line number 459 * LogicalLineNumber - Cumulative line number 460 * LogicalByteOffset - Byte offset in source file 461 * Column - Column in current line 462 * Filename - source filename 463 * ExtraMessage - additional error message 464 * 465 * RETURN: None 466 * 467 * DESCRIPTION: Create a new error node and add it to the error log 468 * 469 ******************************************************************************/ 470 471void 472AslCommonError ( 473 UINT8 Level, 474 UINT8 MessageId, 475 UINT32 CurrentLineNumber, 476 UINT32 LogicalLineNumber, 477 UINT32 LogicalByteOffset, 478 UINT32 Column, 479 char *Filename, 480 char *ExtraMessage) 481{ 482 UINT32 MessageSize; 483 char *MessageBuffer = NULL; 484 ASL_ERROR_MSG *Enode; 485 486 487 Enode = UtLocalCalloc (sizeof (ASL_ERROR_MSG)); 488 489 if (ExtraMessage) 490 { 491 /* Allocate a buffer for the message and a new error node */ 492 493 MessageSize = strlen (ExtraMessage) + 1; 494 MessageBuffer = UtLocalCalloc (MessageSize); 495 496 /* Keep a copy of the extra message */ 497 498 ACPI_STRCPY (MessageBuffer, ExtraMessage); 499 } 500 501 /* Initialize the error node */ 502 503 if (Filename) 504 { 505 Enode->Filename = Filename; 506 Enode->FilenameLength = strlen (Filename); 507 if (Enode->FilenameLength < 6) 508 { 509 Enode->FilenameLength = 6; 510 } 511 } 512 513 Enode->MessageId = MessageId; 514 Enode->Level = Level; 515 Enode->LineNumber = CurrentLineNumber; 516 Enode->LogicalLineNumber = LogicalLineNumber; 517 Enode->LogicalByteOffset = LogicalByteOffset; 518 Enode->Column = Column; 519 Enode->Message = MessageBuffer; 520 521 /* Add the new node to the error node list */ 522 523 AeAddToErrorLog (Enode); 524 525 if (Gbl_DebugFlag) 526 { 527 /* stderr is a file, send error to it immediately */ 528 529 AePrintException (ASL_FILE_STDERR, Enode, NULL); 530 } 531 532 Gbl_ExceptionCount[Level]++; 533 if (Gbl_ExceptionCount[ASL_ERROR] > ASL_MAX_ERROR_COUNT) 534 { 535 printf ("\nMaximum error count (%u) exceeded\n", ASL_MAX_ERROR_COUNT); 536 537 Gbl_SourceLine = 0; 538 Gbl_NextError = Gbl_ErrorLog; 539 CmDoOutputFiles (); 540 CmCleanupAndExit (); 541 exit(1); 542 } 543 544 return; 545} 546 547 548/******************************************************************************* 549 * 550 * FUNCTION: AslError 551 * 552 * PARAMETERS: Level - Seriousness (Warning/error, etc.) 553 * MessageId - Index into global message buffer 554 * Op - Parse node where error happened 555 * ExtraMessage - additional error message 556 * 557 * RETURN: None 558 * 559 * DESCRIPTION: Main error reporting routine for the ASL compiler (all code 560 * except the parser.) 561 * 562 ******************************************************************************/ 563 564void 565AslError ( 566 UINT8 Level, 567 UINT8 MessageId, 568 ACPI_PARSE_OBJECT *Op, 569 char *ExtraMessage) 570{ 571 572 switch (Level) 573 { 574 case ASL_WARNING2: 575 case ASL_WARNING3: 576 if (Gbl_WarningLevel < Level) 577 { 578 return; 579 } 580 break; 581 582 default: 583 break; 584 } 585 586 587 if (Op) 588 { 589 AslCommonError (Level, MessageId, Op->Asl.LineNumber, 590 Op->Asl.LogicalLineNumber, 591 Op->Asl.LogicalByteOffset, 592 Op->Asl.Column, 593 Op->Asl.Filename, ExtraMessage); 594 } 595 else 596 { 597 AslCommonError (Level, MessageId, 0, 598 0, 0, 0, NULL, ExtraMessage); 599 } 600} 601 602 603/******************************************************************************* 604 * 605 * FUNCTION: AslCoreSubsystemError 606 * 607 * PARAMETERS: Op - Parse node where error happened 608 * Status - The ACPI CA Exception 609 * ExtraMessage - additional error message 610 * Abort - TRUE -> Abort compilation 611 * 612 * RETURN: None 613 * 614 * DESCRIPTION: Error reporting routine for exceptions returned by the ACPI 615 * CA core subsystem. 616 * 617 ******************************************************************************/ 618 619void 620AslCoreSubsystemError ( 621 ACPI_PARSE_OBJECT *Op, 622 ACPI_STATUS Status, 623 char *ExtraMessage, 624 BOOLEAN Abort) 625{ 626 627 sprintf (MsgBuffer, "%s %s", AcpiFormatException (Status), ExtraMessage); 628 629 if (Op) 630 { 631 AslCommonError (ASL_ERROR, ASL_MSG_CORE_EXCEPTION, Op->Asl.LineNumber, 632 Op->Asl.LogicalLineNumber, 633 Op->Asl.LogicalByteOffset, 634 Op->Asl.Column, 635 Op->Asl.Filename, MsgBuffer); 636 } 637 else 638 { 639 AslCommonError (ASL_ERROR, ASL_MSG_CORE_EXCEPTION, 0, 640 0, 0, 0, NULL, MsgBuffer); 641 } 642 643 if (Abort) 644 { 645 AslAbort (); 646 } 647} 648 649 650/******************************************************************************* 651 * 652 * FUNCTION: AslCompilererror 653 * 654 * PARAMETERS: CompilerMessage - Error message from the parser 655 * 656 * RETURN: Status (0 for now) 657 * 658 * DESCRIPTION: Report an error situation discovered in a production 659 * NOTE: don't change the name of this function, it is called 660 * from the auto-generated parser. 661 * 662 ******************************************************************************/ 663 664int 665AslCompilererror ( 666 char *CompilerMessage) 667{ 668 669 AslCommonError (ASL_ERROR, ASL_MSG_SYNTAX, Gbl_CurrentLineNumber, 670 Gbl_LogicalLineNumber, Gbl_CurrentLineOffset, 671 Gbl_CurrentColumn, Gbl_Files[ASL_FILE_INPUT].Filename, 672 CompilerMessage); 673 674 return 0; 675} 676 677 678