1 /******************************************************************************
3 * Module Name: aslerror - Error handling and statistics
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2020, Intel Corp.
12 * All rights reserved.
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
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
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;
37 * The above copyright and patent license is granted only if the following
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.
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
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
72 * 3.4. Intel retains all right, title, and interest in and to the Original
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.
80 * 4. Disclaimer and Export Compliance
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
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
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.
114 *****************************************************************************
116 * Alternatively, you may choose to be licensed under the terms of the
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
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.
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.
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.
150 *****************************************************************************/
152 #include <contrib/dev/acpica/compiler/aslcompiler.h>
154 #define _COMPONENT ACPI_COMPILER
155 ACPI_MODULE_NAME ("aslerror")
157 /* Local prototypes */
161 ASL_ERROR_MSG *Enode);
164 AslIsExceptionExpected (
169 AslIsExceptionDisabled (
173 static void AslInitEnode (
174 ASL_ERROR_MSG **Enode,
178 UINT32 LogicalLineNumber,
179 UINT32 LogicalByteOffset,
184 ASL_ERROR_MSG *SubError);
191 UINT32 LogicalLineNumber,
192 UINT32 LogicalByteOffset,
197 ASL_ERROR_MSG *SubError);
202 ASL_ERROR_MSG *Enode);
210 /*******************************************************************************
218 * DESCRIPTION: Dump the error log and abort the compiler. Used for serious
221 ******************************************************************************/
228 AePrintErrorLog (ASL_FILE_STDERR);
229 if (AslGbl_DebugFlag)
231 /* Print error summary to stdout also */
233 AePrintErrorLog (ASL_FILE_STDOUT);
240 /*******************************************************************************
242 * FUNCTION: AeClearErrorLog
248 * DESCRIPTION: Empty the error list
250 ******************************************************************************/
256 ASL_ERROR_MSG *Enode = AslGbl_ErrorLog;
260 /* Walk the error node list */
269 AslGbl_ErrorLog = NULL;
273 /*******************************************************************************
275 * FUNCTION: AeAddToErrorLog
277 * PARAMETERS: Enode - An error node to add to the log
281 * DESCRIPTION: Add a new error node to the error log. The error log is
282 * ordered by the "logical" line number (cumulative line number
283 * including all include files.)
285 ******************************************************************************/
289 ASL_ERROR_MSG *Enode)
295 /* If Gbl_ErrorLog is null, this is the first error node */
297 if (!AslGbl_ErrorLog)
299 AslGbl_ErrorLog = Enode;
304 * Walk error list until we find a line number greater than ours.
305 * List is sorted according to line number.
308 Next = AslGbl_ErrorLog;
310 while ((Next) && (Next->LogicalLineNumber <= Enode->LogicalLineNumber))
316 /* Found our place in the list */
326 AslGbl_ErrorLog = Enode;
331 /*******************************************************************************
333 * FUNCTION: AeDecodeErrorMessageId
335 * PARAMETERS: OutputFile - Output file
336 * Enode - Error node to print
337 * PrematureEOF - True = PrematureEOF has been reached
338 * Total - Total length of line
342 * DESCRIPTION: Print the source line of an error.
344 ******************************************************************************/
347 AeDecodeErrorMessageId (
349 ASL_ERROR_MSG *Enode,
350 BOOLEAN PrematureEOF,
354 const char *MainMessage;
360 fprintf (OutputFile, "%s %4.4d -",
361 AeDecodeExceptionLevel (Enode->Level),
362 AeBuildFullExceptionCode (Enode->Level, Enode->MessageId));
364 MainMessage = AeDecodeMessageId (Enode->MessageId);
365 ExtraMessage = Enode->Message;
367 /* If a NULL line number, just print the decoded message */
369 if (!Enode->LineNumber)
371 fprintf (OutputFile, " %s %s\n\n", MainMessage, ExtraMessage);
375 MsgLength = strlen (MainMessage);
378 /* Use the secondary/extra message as main message */
380 MainMessage = Enode->Message;
386 MsgLength = strlen (MainMessage);
390 if (AslGbl_VerboseErrors && !PrematureEOF)
394 fprintf (OutputFile, " %s",
399 SourceColumn = Enode->Column + Enode->FilenameLength + 6 + 2;
400 ErrorColumn = ASL_ERROR_LEVEL_LENGTH + 5 + 2 + 1;
402 if ((MsgLength + ErrorColumn) < (SourceColumn - 1))
404 fprintf (OutputFile, "%*s%s",
405 (int) ((SourceColumn - 1) - ErrorColumn),
410 fprintf (OutputFile, "%*s %s",
411 (int) ((SourceColumn - ErrorColumn) + 1), "^",
418 fprintf (OutputFile, " %s", MainMessage);
421 /* Print the extra info message if present */
425 fprintf (OutputFile, " (%s)", ExtraMessage);
430 fprintf (OutputFile, " and premature End-Of-File");
433 fprintf (OutputFile, "\n");
434 if (AslGbl_VerboseErrors && !Enode->SubError)
436 fprintf (OutputFile, "\n");
441 /*******************************************************************************
443 * FUNCTION: AePrintErrorSourceLine
445 * PARAMETERS: OutputFile - Output file
446 * Enode - Error node to print
447 * PrematureEOF - True = PrematureEOF has been reached
448 * Total - Number of characters printed so far
453 * DESCRIPTION: Print the source line of an error.
455 ******************************************************************************/
458 AePrintErrorSourceLine (
460 ASL_ERROR_MSG *Enode,
461 BOOLEAN *PrematureEOF,
467 FILE *SourceFile = NULL;
471 if (!Enode->SourceLine)
474 * Use the merged header/source file if present, otherwise
477 SourceFile = FlGetFileHandle (ASL_FILE_SOURCE_OUTPUT,
478 ASL_FILE_SOURCE_OUTPUT, Enode->SourceFilename);
481 SourceFile = FlGetFileHandle (ASL_FILE_INPUT,
482 ASL_FILE_INPUT, Enode->Filename);
487 /* Determine if the error occurred at source file EOF */
489 fseek (SourceFile, 0, SEEK_END);
490 FileSize = ftell (SourceFile);
492 if ((long) Enode->LogicalByteOffset >= FileSize)
494 *PrematureEOF = TRUE;
500 "[*** iASL: Source File Does not exist ***]\n");
505 /* Print filename and line number if present and valid */
507 if (AslGbl_VerboseErrors)
509 fprintf (OutputFile, "%-8s", Enode->Filename);
511 if (Enode->SourceLine && Enode->LineNumber)
513 fprintf (OutputFile, " %6u: %s",
514 Enode->LineNumber, Enode->SourceLine);
516 else if (Enode->LineNumber)
518 fprintf (OutputFile, " %6u: ", Enode->LineNumber);
521 * If not at EOF, get the corresponding source code line
522 * and display it. Don't attempt this if we have a
523 * premature EOF condition.
527 fprintf (OutputFile, "\n");
532 * Seek to the offset in the combined source file,
533 * read the source line, and write it to the output.
535 Actual = fseek (SourceFile,
536 (long) Enode->LogicalByteOffset, (int) SEEK_SET);
540 "[*** iASL: Seek error on source code temp file %s ***]",
541 AslGbl_Files[ASL_FILE_SOURCE_OUTPUT].Filename);
543 fprintf (OutputFile, "\n");
546 RActual = fread (&SourceByte, 1, 1, SourceFile);
550 "[*** iASL: Read error on source code temp file %s ***]",
551 AslGbl_Files[ASL_FILE_SOURCE_OUTPUT].Filename);
555 /* Read/write the source line, up to the maximum line length */
557 while (RActual && SourceByte && (SourceByte != '\n'))
561 /* After the max line length, we will just read the line, no write */
563 if (fwrite (&SourceByte, 1, 1, OutputFile) != 1)
565 printf ("[*** iASL: Write error on output file ***]\n");
569 else if (*Total == 256)
572 "\n[*** iASL: Very long input line, message below refers to column %u ***]",
576 RActual = fread (&SourceByte, 1, 1, SourceFile);
580 "[*** iASL: Read error on source code temp file %s ***]",
581 AslGbl_Files[ASL_FILE_SOURCE_OUTPUT].Filename);
588 fprintf (OutputFile, "\n");
594 * Less verbose version of the error message, enabled via the
595 * -vi switch. The format is compatible with MS Visual Studio.
597 fprintf (OutputFile, "%s", Enode->Filename);
599 if (Enode->LineNumber)
601 fprintf (OutputFile, "(%u) : ",
609 /*******************************************************************************
611 * FUNCTION: AePrintException
613 * PARAMETERS: FileId - ID of output file
614 * Enode - Error node to print
615 * Header - Additional text before each message
619 * DESCRIPTION: Print the contents of an error node.
621 * NOTE: We don't use the FlxxxFile I/O functions here because on error
622 * they abort the compiler and call this function! Since we
623 * are reporting errors here, we ignore most output errors and
624 * just try to get out as much as we can.
626 ******************************************************************************/
631 ASL_ERROR_MSG *Enode,
635 BOOLEAN PrematureEOF = FALSE;
638 ASL_ERROR_MSG *Child = Enode->SubError;
647 * Only listing files have a header, and remarks/optimizations
652 /* Ignore remarks if requested */
654 switch (Enode->Level)
660 if (!AslGbl_DisplayWarnings)
668 if (!AslGbl_DisplayRemarks)
674 case ASL_OPTIMIZATION:
676 if (!AslGbl_DisplayOptimizations)
688 /* Get the various required file handles */
690 OutputFile = AslGbl_Files[FileId].Handle;
694 fprintf (OutputFile, "%s", Header);
697 if (!Enode->Filename)
699 AeDecodeErrorMessageId (OutputFile, Enode, PrematureEOF, Total);
703 Status = AePrintErrorSourceLine (OutputFile, Enode, &PrematureEOF, &Total);
704 if (ACPI_FAILURE (Status))
709 /* If a NULL message ID, just print the raw message */
711 if (Enode->MessageId == 0)
713 fprintf (OutputFile, "%s\n", Enode->Message);
717 AeDecodeErrorMessageId (OutputFile, Enode, PrematureEOF, Total);
721 fprintf (OutputFile, "\n");
722 AePrintSubError (OutputFile, Child);
723 Child = Child->SubError;
728 /*******************************************************************************
730 * FUNCTION: AePrintSubError
732 * PARAMETERS: OutputFile - Output file
733 * Enode - Error node to print
737 * DESCRIPTION: Print the contents of an error node. This function is tailored
738 * to print error nodes that are SubErrors within ASL_ERROR_MSG
740 ******************************************************************************/
745 ASL_ERROR_MSG *Enode)
748 BOOLEAN PrematureEOF = FALSE;
749 const char *MainMessage;
752 MainMessage = AeDecodeMessageId (Enode->MessageId);
754 fprintf (OutputFile, " %s", MainMessage);
758 fprintf (OutputFile, "(%s)", Enode->Message);
761 fprintf (OutputFile, "\n ");
762 (void) AePrintErrorSourceLine (OutputFile, Enode, &PrematureEOF, &Total);
763 fprintf (OutputFile, "\n");
767 /*******************************************************************************
769 * FUNCTION: AePrintErrorLog
771 * PARAMETERS: FileId - Where to output the error log
775 * DESCRIPTION: Print the entire contents of the error log
777 ******************************************************************************/
783 ASL_ERROR_MSG *Enode = AslGbl_ErrorLog;
786 /* Walk the error node list */
790 AePrintException (FileId, Enode, NULL);
796 /*******************************************************************************
798 * FUNCTION: AslInitEnode
800 * PARAMETERS: InputEnode - Input Error node to initialize
801 * Level - Seriousness (Warning/error, etc.)
802 * MessageId - Index into global message buffer
803 * CurrentLineNumber - Actual file line number
804 * LogicalLineNumber - Cumulative line number
805 * LogicalByteOffset - Byte offset in source file
806 * Column - Column in current line
807 * Filename - Source filename
808 * ExtraMessage - Additional error message
809 * SourceLine - Line of error source code
810 * SubError - SubError of this InputEnode
814 * DESCRIPTION: Initialize an Error node
816 ******************************************************************************/
818 static void AslInitEnode (
819 ASL_ERROR_MSG **InputEnode,
823 UINT32 LogicalLineNumber,
824 UINT32 LogicalByteOffset,
829 ASL_ERROR_MSG *SubError)
831 ASL_ERROR_MSG *Enode;
832 ASL_GLOBAL_FILE_NODE *FileNode;
835 *InputEnode = UtLocalCalloc (sizeof (ASL_ERROR_MSG));
837 Enode->Level = Level;
838 Enode->MessageId = MessageId;
839 Enode->LineNumber = LineNumber;
840 Enode->LogicalLineNumber = LogicalLineNumber;
841 Enode->LogicalByteOffset = LogicalByteOffset;
842 Enode->Column = Column;
843 Enode->SubError = SubError;
844 Enode->Message = NULL;
845 Enode->SourceLine = NULL;
846 Enode->Filename = NULL;
850 /* Allocate a buffer for the message and a new error node */
852 Enode->Message = UtLocalCacheCalloc (strlen (ExtraMessage) + 1);
854 /* Keep a copy of the extra message */
856 strcpy (Enode->Message, ExtraMessage);
861 Enode->SourceLine = UtLocalCalloc (strlen (SourceLine) + 1);
862 strcpy (Enode->SourceLine, SourceLine);
868 Enode->Filename = Filename;
869 Enode->FilenameLength = strlen (Filename);
870 if (Enode->FilenameLength < 6)
872 Enode->FilenameLength = 6;
876 * Attempt to get the file node of the filename listed in the parse
877 * node. If the name doesn't exist in the global file node, it is
878 * because the file is included by #include or ASL include. In this
879 * case, get the current file node. The source output of the current
880 * file will contain the contents of the file listed in the parse node.
882 FileNode = FlGetFileNode (ASL_FILE_INPUT, Filename);
885 FileNode = FlGetCurrentFileNode ();
888 Enode->SourceFilename =
889 FileNode->Files[ASL_FILE_SOURCE_OUTPUT].Filename;
894 /*******************************************************************************
896 * FUNCTION: AslCommonError2
898 * PARAMETERS: Level - Seriousness (Warning/error, etc.)
899 * MessageId - Index into global message buffer
900 * LineNumber - Actual file line number
901 * Column - Column in current line
902 * SourceLine - Actual source code line
903 * Filename - Source filename
904 * ExtraMessage - Additional error message
908 * DESCRIPTION: Create a new error node and add it to the error log
910 ******************************************************************************/
922 AslLogNewError (Level, MessageId, LineNumber, LineNumber, 0, Column,
923 Filename, ExtraMessage, SourceLine, NULL);
927 /*******************************************************************************
929 * FUNCTION: AslCommonError
931 * PARAMETERS: Level - Seriousness (Warning/error, etc.)
932 * MessageId - Index into global message buffer
933 * CurrentLineNumber - Actual file line number
934 * LogicalLineNumber - Cumulative line number
935 * LogicalByteOffset - Byte offset in source file
936 * Column - Column in current line
937 * Filename - Source filename
938 * ExtraMessage - Additional error message
942 * DESCRIPTION: Create a new error node and add it to the error log
944 ******************************************************************************/
950 UINT32 CurrentLineNumber,
951 UINT32 LogicalLineNumber,
952 UINT32 LogicalByteOffset,
957 /* Check if user wants to ignore this exception */
959 if (AslIsExceptionIgnored (Level, MessageId))
964 AslLogNewError (Level, MessageId, CurrentLineNumber, LogicalLineNumber,
965 LogicalByteOffset, Column, Filename, ExtraMessage,
970 /*******************************************************************************
972 * FUNCTION: AslLogNewError
974 * PARAMETERS: Level - Seriousness (Warning/error, etc.)
975 * MessageId - Index into global message buffer
976 * CurrentLineNumber - Actual file line number
977 * LogicalLineNumber - Cumulative line number
978 * LogicalByteOffset - Byte offset in source file
979 * Column - Column in current line
980 * Filename - Source filename
981 * Message - Additional error message
982 * SourceLine - Actual line of source code
983 * SubError - Sub-error associated with this error
987 * DESCRIPTION: Create a new error node and add it to the error log
989 ******************************************************************************/
995 UINT32 LogicalLineNumber,
996 UINT32 LogicalByteOffset,
1001 ASL_ERROR_MSG *SubError)
1003 ASL_ERROR_MSG *Enode = NULL;
1004 UINT8 ModifiedLevel = GetModifiedLevel (Level, MessageId);
1007 AslInitEnode (&Enode, ModifiedLevel, MessageId, LineNumber,
1008 LogicalLineNumber, LogicalByteOffset, Column, Filename, Message,
1009 SourceLine, SubError);
1011 /* Add the new node to the error node list */
1013 AeAddToErrorLog (Enode);
1015 if (AslGbl_DebugFlag)
1017 /* stderr is a file, send error to it immediately */
1019 AePrintException (ASL_FILE_STDERR, Enode, NULL);
1022 AslGbl_ExceptionCount[ModifiedLevel]++;
1023 if (!AslGbl_IgnoreErrors && AslGbl_ExceptionCount[ASL_ERROR] > ASL_MAX_ERROR_COUNT)
1025 printf ("\nMaximum error count (%u) exceeded\n", ASL_MAX_ERROR_COUNT);
1027 AslGbl_SourceLine = 0;
1028 AslGbl_NextError = AslGbl_ErrorLog;
1029 CmCleanupAndExit ();
1037 /*******************************************************************************
1039 * FUNCTION: GetModifiedLevel
1041 * PARAMETERS: Level - Seriousness (Warning/error, etc.)
1042 * MessageId - Index into global message buffer
1044 * RETURN: UINT8 - Modified level
1046 * DESCRIPTION: Get the modified level of exception codes that are reported as
1047 * errors from the -ww option.
1049 ******************************************************************************/
1057 UINT16 ExceptionCode;
1060 ExceptionCode = AeBuildFullExceptionCode (Level, MessageId);
1062 for (i = 0; i < AslGbl_ElevatedMessagesIndex; i++)
1064 if (ExceptionCode == AslGbl_ElevatedMessages[i])
1074 /*******************************************************************************
1076 * FUNCTION: AslIsExceptionIgnored
1078 * PARAMETERS: Level - Seriousness (Warning/error, etc.)
1079 * MessageId - Index into global message buffer
1083 * DESCRIPTION: Check if a particular exception is ignored. In this case it
1084 * means that the exception is (expected or disabled.
1086 ******************************************************************************/
1089 AslIsExceptionIgnored (
1093 BOOLEAN ExceptionIgnored;
1096 /* Note: this allows exception to be disabled and expected */
1098 ExceptionIgnored = AslIsExceptionDisabled (Level, MessageId);
1099 ExceptionIgnored |= AslIsExceptionExpected (Level, MessageId);
1101 return (AslGbl_AllExceptionsDisabled || ExceptionIgnored);
1105 /*******************************************************************************
1107 * FUNCTION: AslCheckExpectException
1113 * DESCRIPTION: Check the global expected messages table and raise an error
1114 * for each message that has not been received.
1116 ******************************************************************************/
1119 AslCheckExpectedExceptions (
1125 for (i = 0; i < AslGbl_ExpectedMessagesIndex; ++i)
1127 if (!AslGbl_ExpectedMessages[i].MessageReceived)
1129 AslError (ASL_ERROR, ASL_MSG_EXCEPTION_NOT_RECEIVED, NULL,
1130 AslGbl_ExpectedMessages[i].MessageIdStr);
1136 /*******************************************************************************
1138 * FUNCTION: AslExpectException
1140 * PARAMETERS: MessageIdString - ID of excepted exception during compile
1144 * DESCRIPTION: Enter a message ID into the global expected messages table
1145 * If these messages are not raised during the compilation, throw
1148 ******************************************************************************/
1151 AslExpectException (
1152 char *MessageIdString)
1157 /* Convert argument to an integer and validate it */
1159 MessageId = (UINT32) strtoul (MessageIdString, NULL, 0);
1161 if (MessageId > 6999)
1163 printf ("\"%s\" is not a valid warning/remark/erro ID\n",
1165 return (AE_BAD_PARAMETER);
1168 /* Insert value into the global expected message array */
1170 if (AslGbl_ExpectedMessagesIndex >= ASL_MAX_EXPECTED_MESSAGES)
1172 printf ("Too many messages have been registered as expected (max %d)\n",
1173 ASL_MAX_DISABLED_MESSAGES);
1177 AslGbl_ExpectedMessages[AslGbl_ExpectedMessagesIndex].MessageId = MessageId;
1178 AslGbl_ExpectedMessages[AslGbl_ExpectedMessagesIndex].MessageIdStr = MessageIdString;
1179 AslGbl_ExpectedMessages[AslGbl_ExpectedMessagesIndex].MessageReceived = FALSE;
1180 AslGbl_ExpectedMessagesIndex++;
1185 /*******************************************************************************
1187 * FUNCTION: AslDisableException
1189 * PARAMETERS: MessageIdString - ID to be disabled
1193 * DESCRIPTION: Enter a message ID into the global disabled messages table
1195 ******************************************************************************/
1198 AslDisableException (
1199 char *MessageIdString)
1204 /* Convert argument to an integer and validate it */
1206 MessageId = (UINT32) strtoul (MessageIdString, NULL, 0);
1208 if ((MessageId < 2000) || (MessageId > 6999))
1210 printf ("\"%s\" is not a valid warning/remark/error ID\n",
1212 return (AE_BAD_PARAMETER);
1215 /* Insert value into the global disabled message array */
1217 if (AslGbl_DisabledMessagesIndex >= ASL_MAX_DISABLED_MESSAGES)
1219 printf ("Too many messages have been disabled (max %d)\n",
1220 ASL_MAX_DISABLED_MESSAGES);
1224 AslGbl_DisabledMessages[AslGbl_DisabledMessagesIndex] = MessageId;
1225 AslGbl_DisabledMessagesIndex++;
1230 /*******************************************************************************
1232 * FUNCTION: AslElevateException
1234 * PARAMETERS: MessageIdString - ID of excepted exception during compile
1238 * DESCRIPTION: Enter a message ID into the global elevated exceptions table.
1239 * These messages will be considered as compilation errors.
1241 ******************************************************************************/
1244 AslElevateException (
1245 char *MessageIdString)
1250 /* Convert argument to an integer and validate it */
1252 MessageId = (UINT32) strtoul (MessageIdString, NULL, 0);
1254 if (MessageId > 6999)
1256 printf ("\"%s\" is not a valid warning/remark/erro ID\n",
1258 return (AE_BAD_PARAMETER);
1261 /* Insert value into the global expected message array */
1263 if (AslGbl_ElevatedMessagesIndex >= ASL_MAX_ELEVATED_MESSAGES)
1265 printf ("Too many messages have been registered as elevated (max %d)\n",
1266 ASL_MAX_DISABLED_MESSAGES);
1270 AslGbl_ElevatedMessages[AslGbl_ElevatedMessagesIndex] = MessageId;
1271 AslGbl_ElevatedMessagesIndex++;
1275 /*******************************************************************************
1277 * FUNCTION: AslIsExceptionDisabled
1279 * PARAMETERS: Level - Seriousness (Warning/error, etc.)
1280 * MessageId - Index into global message buffer
1282 * RETURN: TRUE if exception/message should be ignored
1284 * DESCRIPTION: Check if the user has specified options such that this
1285 * exception should be ignored
1287 ******************************************************************************/
1290 AslIsExceptionExpected (
1294 UINT32 EncodedMessageId;
1298 /* Mark this exception as received */
1300 EncodedMessageId = AeBuildFullExceptionCode (Level, MessageId);
1301 for (i = 0; i < AslGbl_ExpectedMessagesIndex; i++)
1303 /* Simple implementation via fixed array */
1305 if (EncodedMessageId == AslGbl_ExpectedMessages[i].MessageId)
1307 return (AslGbl_ExpectedMessages[i].MessageReceived = TRUE);
1315 /*******************************************************************************
1317 * FUNCTION: AslIsExceptionDisabled
1319 * PARAMETERS: Level - Seriousness (Warning/error, etc.)
1320 * MessageId - Index into global message buffer
1322 * RETURN: TRUE if exception/message should be ignored
1324 * DESCRIPTION: Check if the user has specified options such that this
1325 * exception should be ignored
1327 ******************************************************************************/
1330 AslIsExceptionDisabled (
1334 UINT32 EncodedMessageId;
1343 /* Check for global disable via -w1/-w2/-w3 options */
1345 if (Level > AslGbl_WarningLevel)
1355 * Ignore this error/warning/remark if it has been disabled by
1356 * the user (-vw option)
1358 EncodedMessageId = AeBuildFullExceptionCode (Level, MessageId);
1359 for (i = 0; i < AslGbl_DisabledMessagesIndex; i++)
1361 /* Simple implementation via fixed array */
1363 if (EncodedMessageId == AslGbl_DisabledMessages[i])
1378 /*******************************************************************************
1380 * FUNCTION: AslDualParseOpError
1382 * PARAMETERS: Level - Seriousness (Warning/error, etc.)
1383 * MainMsgId - Index into global message buffer
1384 * MainOp - Parse node where error happened
1385 * MainMsg - Message pertaining to the MainOp
1386 * SubMsgId - Index into global message buffer
1387 * SubOp - Additional parse node for better message
1388 * SubMsg - Message pertaining to SubOp
1393 * DESCRIPTION: Main error reporting routine for the ASL compiler for error
1394 * messages that point to multiple parse objects.
1396 ******************************************************************************/
1399 AslDualParseOpError (
1402 ACPI_PARSE_OBJECT *MainOp,
1405 ACPI_PARSE_OBJECT *SubOp,
1408 ASL_ERROR_MSG *SubEnode = NULL;
1411 /* Check if user wants to ignore this exception */
1413 if (AslIsExceptionIgnored (Level, MainMsgId) || !MainOp)
1420 AslInitEnode (&SubEnode, Level, SubMsgId, SubOp->Asl.LineNumber,
1421 SubOp->Asl.LogicalLineNumber, SubOp->Asl.LogicalByteOffset,
1422 SubOp->Asl.Column, SubOp->Asl.Filename, SubMsg,
1426 AslLogNewError (Level, MainMsgId, MainOp->Asl.LineNumber,
1427 MainOp->Asl.LogicalLineNumber, MainOp->Asl.LogicalByteOffset,
1428 MainOp->Asl.Column, MainOp->Asl.Filename, MainMsg,
1433 /*******************************************************************************
1435 * FUNCTION: AslError
1437 * PARAMETERS: Level - Seriousness (Warning/error, etc.)
1438 * MessageId - Index into global message buffer
1439 * Op - Parse node where error happened
1440 * ExtraMessage - Additional error message
1444 * DESCRIPTION: Main error reporting routine for the ASL compiler (all code
1445 * except the parser.)
1447 ******************************************************************************/
1453 ACPI_PARSE_OBJECT *Op,
1458 AslCommonError (Level, MessageId, Op->Asl.LineNumber,
1459 Op->Asl.LogicalLineNumber,
1460 Op->Asl.LogicalByteOffset,
1462 Op->Asl.Filename, ExtraMessage);
1466 AslCommonError (Level, MessageId, 0,
1467 0, 0, 0, NULL, ExtraMessage);
1472 /*******************************************************************************
1474 * FUNCTION: AslCoreSubsystemError
1476 * PARAMETERS: Op - Parse node where error happened
1477 * Status - The ACPICA Exception
1478 * ExtraMessage - Additional error message
1479 * Abort - TRUE -> Abort compilation
1483 * DESCRIPTION: Error reporting routine for exceptions returned by the ACPICA
1486 ******************************************************************************/
1489 AslCoreSubsystemError (
1490 ACPI_PARSE_OBJECT *Op,
1496 sprintf (AslGbl_MsgBuffer, "%s %s", AcpiFormatException (Status), ExtraMessage);
1500 AslCommonError (ASL_ERROR, ASL_MSG_CORE_EXCEPTION,
1502 Op->Asl.LogicalLineNumber,
1503 Op->Asl.LogicalByteOffset,
1505 Op->Asl.Filename, AslGbl_MsgBuffer);
1509 AslCommonError (ASL_ERROR, ASL_MSG_CORE_EXCEPTION,
1510 0, 0, 0, 0, NULL, AslGbl_MsgBuffer);
1520 /*******************************************************************************
1522 * FUNCTION: AslCompilererror
1524 * PARAMETERS: CompilerMessage - Error message from the parser
1526 * RETURN: Status (0 for now)
1528 * DESCRIPTION: Report an error situation discovered in a production
1529 * NOTE: don't change the name of this function, it is called
1530 * from the auto-generated parser.
1532 ******************************************************************************/
1536 const char *CompilerMessage)
1539 AslGbl_SyntaxError++;
1541 AslCommonError (ASL_ERROR, ASL_MSG_SYNTAX, AslGbl_CurrentLineNumber,
1542 AslGbl_LogicalLineNumber, AslGbl_CurrentLineOffset,
1543 AslGbl_CurrentColumn, AslGbl_Files[ASL_FILE_INPUT].Filename,
1544 ACPI_CAST_PTR (char, CompilerMessage));