1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
|
-- GHDL Run Time (GRT) - Error handling.
-- Copyright (C) 2002 - 2014 Tristan Gingold
--
-- GHDL is free software; you can redistribute it and/or modify it under
-- the terms of the GNU General Public License as published by the Free
-- Software Foundation; either version 2, or (at your option) any later
-- version.
--
-- GHDL is distributed in the hope that it will be useful, but WITHOUT ANY
-- WARRANTY; without even the implied warranty of MERCHANTABILITY or
-- FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
-- for more details.
--
-- You should have received a copy of the GNU General Public License
-- along with GCC; see the file COPYING. If not, write to the Free
-- Software Foundation, 59 Temple Place - Suite 330, Boston, MA
-- 02111-1307, USA.
--
-- As a special exception, if other files instantiate generics from this
-- unit, or you link this unit with other files to produce an executable,
-- this unit does not by itself cause the resulting executable to be
-- covered by the GNU General Public License. This exception does not
-- however invalidate any other reasons why the executable file might be
-- covered by the GNU Public License.
with Grt.Types; use Grt.Types;
with Grt.Hooks;
with Grt.Stdio;
package Grt.Errors is
pragma Preelaborate (Grt.Errors);
-- Set the stream for error messages. Must be called before using this
-- package.
procedure Set_Error_Stream (Stream : Grt.Stdio.FILEs);
function Get_Error_Stream return Grt.Stdio.FILEs;
-- Use of diagnostics:
-- Use Error_S/Report_S/Info_S to start a message.
-- Use Diag_C to continue the message (to display arguments)
-- Use Error_E/Report_E/Info_E to finish the message.
--
-- The XXX_S and XXX_E must match. Diag_C calls are optional.
-- 'S' stands for start, 'C' for continue and 'E' for end.
--
-- Example:
-- Error_S ("option '");
-- Diag_C (Name);
-- Error_E ("' needs an argument");
--
-- The reason to have 3+ steps is that XXX_S display a different header
-- (like 'filename:error:'), while XXX_E may return or not.
-- Continue to display a message during a diagnostic.
procedure Diag_C (Str : String);
procedure Diag_C (C : Character);
procedure Diag_C (N : Integer);
procedure Diag_C (N : Ghdl_I32);
procedure Diag_C (Str : Ghdl_C_String);
procedure Diag_C (Str : Std_String_Ptr);
procedure Diag_C_Std (Str : Std_String_Uncons);
procedure Diag_C_Now;
-- Multi-call error diagnostic.
procedure Error_S (Str : String := "");
procedure Error_E (Str : String := "");
pragma No_Return (Error_E);
-- Multi-call report diagnostic. Do not exit at end.
procedure Report_S (Str : String := "");
procedure Report_E;
-- Multi-call warning diagnostic. Do not exit at end.
procedure Warning_S (Str : String := "");
procedure Warning_E;
-- Complete error message.
procedure Error (Str : String);
pragma No_Return (Error);
-- Complete error message with a call stack. SKIP is the number of
-- frame to skip, 0 means the caller of this procedure is displayed.
procedure Error_Call_Stack (Str : String; Skip : Natural);
procedure Error (Str : String;
Filename : Ghdl_C_String;
Line : Ghdl_I32);
pragma No_Return (Error);
-- Warning message.
procedure Warning (Str : String);
-- Internal error. The message must contain the subprogram name which
-- has called this procedure.
procedure Internal_Error (Msg : String);
pragma No_Return (Internal_Error);
-- Display a message which is not an error.
procedure Info_S (Str : String := "");
procedure Info_E;
-- Backtrace used to report call stack in case of error.
-- Note: for simplicity we assume that a PC is enough to display the
-- corresponding file name, line number and routine name. Might not be
-- true on some platforms.
-- There is a C version of this record in grt_itf.h
type Integer_Address_Array is array (Natural range <>) of Integer_Address;
type Backtrace_Addrs is record
Size : Natural;
Skip : Natural;
Addrs : Integer_Address_Array (0 .. 31);
end record;
pragma Convention (C, Backtrace_Addrs);
type Backtrace_Addrs_Acc is access Backtrace_Addrs;
-- Save the current backtrace to BT, but skip SKIP frame. 0 means that
-- the caller of this procedure will be in the backtrace.
procedure Save_Backtrace (Bt : out Backtrace_Addrs; Skip : Natural);
pragma Import (C, Save_Backtrace, "grt_save_backtrace");
-- Finish error message with a call stack.
procedure Error_E_Call_Stack (Bt : Backtrace_Addrs);
pragma No_Return (Error_E_Call_Stack);
procedure Error_E_Call_Stack (Bt : Backtrace_Addrs_Acc);
pragma No_Return (Error_E_Call_Stack);
-- Display an error message for an overflow.
procedure Grt_Overflow_Error (Bt : Backtrace_Addrs_Acc);
pragma No_Return (Grt_Overflow_Error);
-- Display an error message for a NULL access dereference.
procedure Grt_Null_Access_Error (Bt : Backtrace_Addrs_Acc);
pragma No_Return (Grt_Null_Access_Error);
-- Called at end of error message. Central point for failures.
procedure Fatal_Error;
pragma No_Return (Fatal_Error);
pragma Export (C, Fatal_Error, "__ghdl_fatal");
-- Stop or finish simulation (for VHPI or std.env).
Exit_Status : Integer := 0;
procedure Exit_Simulation;
-- Simulation status,
-- Runtime error.
Run_Error : constant Integer := -1;
-- No process has been run.
Run_None : constant Integer := 1;
-- At least one process was run.
Run_Resumed : constant Integer := 2;
-- Simulation is finished.
Run_Finished : constant Integer := 3;
-- Simulation finished because of a user-defined time or delta limit.
Run_Limit : constant Integer := 4;
-- Stop/finish request from user (via std.env).
Run_Stop : constant Integer := 5;
-- Hook called in case of error.
Error_Hook : Grt.Hooks.Proc_Hook_Type := null;
-- If true, an error is expected and the exit status is inverted.
Expect_Failure : Boolean := False;
-- Internal subprograms, to be called only by the symbolizer.
procedure Put_Err (C : Character) renames Diag_C;
procedure Put_Err (Str : String) renames Diag_C;
procedure Put_Err (Str : Ghdl_C_String) renames Diag_C;
procedure Put_Err (N : Integer) renames Diag_C;
procedure Newline_Err;
private
pragma Export (C, Grt_Overflow_Error, "grt_overflow_error");
pragma Export (C, Grt_Null_Access_Error, "grt_null_access_error");
end Grt.Errors;
|
