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 - 2009, 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)
173 {
174 Gbl_ErrorLog = Enode;
175 return;
176 }
177
178 /* List is sorted according to line number */
179
180 if (!Gbl_ErrorLog)
181 {
182 Gbl_ErrorLog = Enode;
183 return;
184 }
185
186 /* Walk error list until we find a line number greater than ours */
187
188 Prev = NULL;
189 Next = Gbl_ErrorLog;
190
191 while ((Next) &&
192 (Next->LogicalLineNumber <= Enode->LogicalLineNumber))
193 {
194 Prev = Next;
195 Next = Next->Next;
196 }
197
198 /* Found our place in the list */
199
200 Enode->Next = Next;
201
202 if (Prev)
203 {
204 Prev->Next = Enode;
205 }
206 else
207 {
208 Gbl_ErrorLog = Enode;
209 }
210}
211
212
213/*******************************************************************************
214 *
215 * FUNCTION: AePrintException
216 *
217 * PARAMETERS: FileId - ID of output file
218 * Enode - Error node to print
219 * Header - Additional text before each message
220 *
221 * RETURN: None
222 *
223 * DESCRIPTION: Print the contents of an error node.
224 *
225 * NOTE: We don't use the FlxxxFile I/O functions here because on error
226 * they abort the compiler and call this function! Since we
227 * are reporting errors here, we ignore most output errors and
228 * just try to get out as much as we can.
229 *
230 ******************************************************************************/
231
232void
233AePrintException (
234 UINT32 FileId,
235 ASL_ERROR_MSG *Enode,
236 char *Header)
237{
238 UINT8 SourceByte;
239 int Actual;
240 size_t RActual;
241 UINT32 MsgLength;
242 char *MainMessage;
243 char *ExtraMessage;
244 UINT32 SourceColumn;
245 UINT32 ErrorColumn;
246 FILE *OutputFile;
247 FILE *SourceFile;
248
249
250 if (Gbl_NoErrors)
251 {
252 return;
253 }
254
255 /*
256 * Only listing files have a header, and remarks/optimizations
257 * are always output
258 */
259 if (!Header)
260 {
261 /* Ignore remarks if requested */
262
263 switch (Enode->Level)
264 {
265 case ASL_REMARK:
266 if (!Gbl_DisplayRemarks)
267 {
268 return;
269 }
270 break;
271
272 case ASL_OPTIMIZATION:
273 if (!Gbl_DisplayOptimizations)
274 {
275 return;
276 }
277 break;
278
279 default:
280 break;
281 }
282 }
283
284 /* Get the file handles */
285
286 OutputFile = Gbl_Files[FileId].Handle;
287 SourceFile = Gbl_Files[ASL_FILE_SOURCE_OUTPUT].Handle;
288
289 if (Header)
290 {
291 fprintf (OutputFile, "%s", Header);
292 }
293
294 /* Print filename and line number if present and valid */
295
296 if (Enode->Filename)
297 {
298 if (Gbl_VerboseErrors)
299 {
300 fprintf (OutputFile, "%6s", Enode->Filename);
301
302 if (Enode->LineNumber)
303 {
304 fprintf (OutputFile, "%6u: ", Enode->LineNumber);
305
306 /*
307 * Seek to the offset in the combined source file, read the source
308 * line, and write it to the output.
309 */
310 Actual = fseek (SourceFile, (long) Enode->LogicalByteOffset,
311 (int) SEEK_SET);
312 if (Actual)
313 {
314 fprintf (OutputFile,
315 "[*** iASL: Seek error on source code temp file %s ***]",
316 Gbl_Files[ASL_FILE_SOURCE_OUTPUT].Filename);
317 }
318 else
319 {
320 RActual = fread (&SourceByte, 1, 1, SourceFile);
321 if (!RActual)
322 {
323 fprintf (OutputFile,
324 "[*** iASL: Read error on source code temp file %s ***]",
325 Gbl_Files[ASL_FILE_SOURCE_OUTPUT].Filename);
326 }
327
328 else while (RActual && SourceByte && (SourceByte != '\n'))
329 {
330 fwrite (&SourceByte, 1, 1, OutputFile);
331 RActual = fread (&SourceByte, 1, 1, SourceFile);
332 }
333 }
334 fprintf (OutputFile, "\n");
335 }
336 }
337 else
338 {
339 fprintf (OutputFile, "%s", Enode->Filename);
340
341 if (Enode->LineNumber)
342 {
343 fprintf (OutputFile, "(%u) : ", Enode->LineNumber);
344 }
345 }
346 }
347
348 /* NULL message ID, just print the raw message */
349
350 if (Enode->MessageId == 0)
351 {
352 fprintf (OutputFile, "%s\n", Enode->Message);
353 }
354 else
355 {
356 /* Decode the message ID */
357
358 fprintf (OutputFile, "%s %4.4d -",
359 AslErrorLevel[Enode->Level],
360 Enode->MessageId + ((Enode->Level+1) * 1000));
361
362 MainMessage = AslMessages[Enode->MessageId];
363 ExtraMessage = Enode->Message;
364
365 if (Enode->LineNumber)
366 {
367 MsgLength = strlen (MainMessage);
368 if (MsgLength == 0)
369 {
370 MainMessage = Enode->Message;
371
372 MsgLength = strlen (MainMessage);
373 ExtraMessage = NULL;
374 }
375
376 if (Gbl_VerboseErrors)
377 {
378 SourceColumn = Enode->Column + Enode->FilenameLength + 6 + 2;
379 ErrorColumn = ASL_ERROR_LEVEL_LENGTH + 5 + 2 + 1;
380
381 if ((MsgLength + ErrorColumn) < (SourceColumn - 1))
382 {
383 fprintf (OutputFile, "%*s%s",
384 (int) ((SourceColumn - 1) - ErrorColumn),
385 MainMessage, " ^ ");
386 }
387 else
388 {
389 fprintf (OutputFile, "%*s %s",
390 (int) ((SourceColumn - ErrorColumn) + 1), "^",
391 MainMessage);
392 }
393 }
394 else
395 {
396 fprintf (OutputFile, " %s", MainMessage);
397 }
398
399 /* Print the extra info message if present */
400
401 if (ExtraMessage)
402 {
403 fprintf (OutputFile, " (%s)", ExtraMessage);
404 }
405
406 fprintf (OutputFile, "\n");
407 if (Gbl_VerboseErrors)
408 {
409 fprintf (OutputFile, "\n");
410 }
411 }
412 else
413 {
414 fprintf (OutputFile, " %s %s\n\n", MainMessage, ExtraMessage);
415 }
416 }
417}
418
419
420/*******************************************************************************
421 *
422 * FUNCTION: AePrintErrorLog
423 *
424 * PARAMETERS: FileId - Where to output the error log
425 *
426 * RETURN: None
427 *
428 * DESCRIPTION: Print the entire contents of the error log
429 *
430 ******************************************************************************/
431
432void
433AePrintErrorLog (
434 UINT32 FileId)
435{
436 ASL_ERROR_MSG *Enode = Gbl_ErrorLog;
437
438
439 /* Walk the error node list */
440
441 while (Enode)
442 {
443 AePrintException (FileId, Enode, NULL);
444 Enode = Enode->Next;
445 }
446}
447
448
449/*******************************************************************************
450 *
451 * FUNCTION: AslCommonError
452 *
453 * PARAMETERS: Level - Seriousness (Warning/error, etc.)
454 * MessageId - Index into global message buffer
455 * CurrentLineNumber - Actual file line number
456 * LogicalLineNumber - Cumulative line number
457 * LogicalByteOffset - Byte offset in source file
458 * Column - Column in current line
459 * Filename - source filename
460 * ExtraMessage - additional error message
461 *
462 * RETURN: None
463 *
464 * DESCRIPTION: Create a new error node and add it to the error log
465 *
466 ******************************************************************************/
467
468void
469AslCommonError (
470 UINT8 Level,
471 UINT8 MessageId,
472 UINT32 CurrentLineNumber,
473 UINT32 LogicalLineNumber,
474 UINT32 LogicalByteOffset,
475 UINT32 Column,
476 char *Filename,
477 char *ExtraMessage)
478{
479 UINT32 MessageSize;
480 char *MessageBuffer = NULL;
481 ASL_ERROR_MSG *Enode;
482
483
484 Enode = UtLocalCalloc (sizeof (ASL_ERROR_MSG));
485
486 if (ExtraMessage)
487 {
488 /* Allocate a buffer for the message and a new error node */
489
490 MessageSize = strlen (ExtraMessage) + 1;
491 MessageBuffer = UtLocalCalloc (MessageSize);
492
493 /* Keep a copy of the extra message */
494
495 ACPI_STRCPY (MessageBuffer, ExtraMessage);
496 }
497
498 /* Initialize the error node */
499
500 if (Filename)
501 {
502 Enode->Filename = Filename;
503 Enode->FilenameLength = strlen (Filename);
504 if (Enode->FilenameLength < 6)
505 {
506 Enode->FilenameLength = 6;
507 }
508 }
509
510 Enode->MessageId = MessageId;
511 Enode->Level = Level;
512 Enode->LineNumber = CurrentLineNumber;
513 Enode->LogicalLineNumber = LogicalLineNumber;
514 Enode->LogicalByteOffset = LogicalByteOffset;
515 Enode->Column = Column;
516 Enode->Message = MessageBuffer;
517
518 /* Add the new node to the error node list */
519
520 AeAddToErrorLog (Enode);
521
522 if (Gbl_DebugFlag)
523 {
524 /* stderr is a file, send error to it immediately */
525
526 AePrintException (ASL_FILE_STDERR, Enode, NULL);
527 }
528
529 Gbl_ExceptionCount[Level]++;
530 if (Gbl_ExceptionCount[ASL_ERROR] > ASL_MAX_ERROR_COUNT)
531 {
532 printf ("\nMaximum error count (%d) exceeded\n", ASL_MAX_ERROR_COUNT);
533
534 Gbl_SourceLine = 0;
535 Gbl_NextError = Gbl_ErrorLog;
536 CmDoOutputFiles ();
537 CmCleanupAndExit ();
|
539 }
540
541 return;
542}
543
544
545/*******************************************************************************
546 *
547 * FUNCTION: AslError
548 *
549 * PARAMETERS: Level - Seriousness (Warning/error, etc.)
550 * MessageId - Index into global message buffer
551 * Op - Parse node where error happened
552 * ExtraMessage - additional error message
553 *
554 * RETURN: None
555 *
556 * DESCRIPTION: Main error reporting routine for the ASL compiler (all code
557 * except the parser.)
558 *
559 ******************************************************************************/
560
561void
562AslError (
563 UINT8 Level,
564 UINT8 MessageId,
565 ACPI_PARSE_OBJECT *Op,
566 char *ExtraMessage)
567{
568
569 switch (Level)
570 {
571 case ASL_WARNING2:
572 case ASL_WARNING3:
573 if (Gbl_WarningLevel < Level)
574 {
575 return;
576 }
577 break;
578
579 default:
580 break;
581 }
582
583
584 if (Op)
585 {
586 AslCommonError (Level, MessageId, Op->Asl.LineNumber,
587 Op->Asl.LogicalLineNumber,
588 Op->Asl.LogicalByteOffset,
589 Op->Asl.Column,
590 Op->Asl.Filename, ExtraMessage);
591 }
592 else
593 {
594 AslCommonError (Level, MessageId, 0,
595 0, 0, 0, NULL, ExtraMessage);
596 }
597}
598
599
600/*******************************************************************************
601 *
602 * FUNCTION: AslCoreSubsystemError
603 *
604 * PARAMETERS: Op - Parse node where error happened
605 * Status - The ACPI CA Exception
606 * ExtraMessage - additional error message
607 * Abort - TRUE -> Abort compilation
608 *
609 * RETURN: None
610 *
611 * DESCRIPTION: Error reporting routine for exceptions returned by the ACPI
612 * CA core subsystem.
613 *
614 ******************************************************************************/
615
616void
617AslCoreSubsystemError (
618 ACPI_PARSE_OBJECT *Op,
619 ACPI_STATUS Status,
620 char *ExtraMessage,
621 BOOLEAN Abort)
622{
623
624 sprintf (MsgBuffer, "%s %s", AcpiFormatException (Status), ExtraMessage);
625
626 if (Op)
627 {
628 AslCommonError (ASL_ERROR, ASL_MSG_CORE_EXCEPTION, Op->Asl.LineNumber,
629 Op->Asl.LogicalLineNumber,
630 Op->Asl.LogicalByteOffset,
631 Op->Asl.Column,
632 Op->Asl.Filename, MsgBuffer);
633 }
634 else
635 {
636 AslCommonError (ASL_ERROR, ASL_MSG_CORE_EXCEPTION, 0,
637 0, 0, 0, NULL, MsgBuffer);
638 }
639
640 if (Abort)
641 {
642 AslAbort ();
643 }
644}
645
646
647/*******************************************************************************
648 *
649 * FUNCTION: AslCompilererror
650 *
651 * PARAMETERS: CompilerMessage - Error message from the parser
652 *
653 * RETURN: Status (0 for now)
654 *
655 * DESCRIPTION: Report an error situation discovered in a production
656 * NOTE: don't change the name of this function, it is called
657 * from the auto-generated parser.
658 *
659 ******************************************************************************/
660
661int
662AslCompilererror (
663 char *CompilerMessage)
664{
665
666 AslCommonError (ASL_ERROR, ASL_MSG_SYNTAX, Gbl_CurrentLineNumber,
667 Gbl_LogicalLineNumber, Gbl_CurrentLineOffset,
668 Gbl_CurrentColumn, Gbl_Files[ASL_FILE_INPUT].Filename,
669 CompilerMessage);
670
671 return 0;
672}
673
674
|