2010-07-27 Paolo Carlini <paolo.carlini@oracle.com>
[official-gcc/alias-decl.git] / gcc / ada / a-except.ads
blob14aea1dd32605ccee981ec101386b4cc8f9f59b4
1 ------------------------------------------------------------------------------
2 -- --
3 -- GNAT RUN-TIME COMPONENTS --
4 -- --
5 -- A D A . E X C E P T I O N S --
6 -- --
7 -- S p e c --
8 -- --
9 -- Copyright (C) 1992-2009, Free Software Foundation, Inc. --
10 -- --
11 -- This specification is derived from the Ada Reference Manual for use with --
12 -- GNAT. The copyright notice above, and the license provisions that follow --
13 -- apply solely to the contents of the part following the private keyword. --
14 -- --
15 -- GNAT is free software; you can redistribute it and/or modify it under --
16 -- terms of the GNU General Public License as published by the Free Soft- --
17 -- ware Foundation; either version 3, or (at your option) any later ver- --
18 -- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
19 -- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
20 -- or FITNESS FOR A PARTICULAR PURPOSE. --
21 -- --
22 -- As a special exception under Section 7 of GPL version 3, you are granted --
23 -- additional permissions described in the GCC Runtime Library Exception, --
24 -- version 3.1, as published by the Free Software Foundation. --
25 -- --
26 -- You should have received a copy of the GNU General Public License and --
27 -- a copy of the GCC Runtime Library Exception along with this program; --
28 -- see the files COPYING3 and COPYING.RUNTIME respectively. If not, see --
29 -- <http://www.gnu.org/licenses/>. --
30 -- --
31 -- GNAT was originally developed by the GNAT team at New York University. --
32 -- Extensive contributions were provided by Ada Core Technologies Inc. --
33 -- --
34 ------------------------------------------------------------------------------
36 -- This version of Ada.Exceptions is a full Ada 95 version. It omits Ada 2005
37 -- features such as the additional definitions of Exception_Name returning
38 -- Wide_[Wide_]String.
40 -- It is used for building the compiler and the basic tools, since these
41 -- builds may be done with bootstrap compilers that cannot handle these
42 -- additions. The full version of Ada.Exceptions can be found in the files
43 -- a-except-2005.ads/adb, and is used for all other builds where full Ada
44 -- 2005 functionality is required. In particular, it is used for building
45 -- run times on all targets.
47 pragma Compiler_Unit;
49 pragma Polling (Off);
50 -- We must turn polling off for this unit, because otherwise we get
51 -- elaboration circularities with ourself.
53 with System;
54 with System.Parameters;
55 with System.Standard_Library;
56 with System.Traceback_Entries;
58 package Ada.Exceptions is
59 pragma Warnings (Off);
60 pragma Preelaborate_05;
61 pragma Warnings (On);
62 -- We make this preelaborable in Ada 2005 mode. If we did not do this, then
63 -- run time units used by the compiler (e.g. s-soflin.ads) would run
64 -- into trouble. Conformance is not an issue, since this version is used
65 -- only by the compiler.
67 type Exception_Id is private;
69 Null_Id : constant Exception_Id;
71 type Exception_Occurrence is limited private;
73 type Exception_Occurrence_Access is access all Exception_Occurrence;
75 Null_Occurrence : constant Exception_Occurrence;
77 function Exception_Name (X : Exception_Occurrence) return String;
78 -- Same as Exception_Name (Exception_Identity (X))
80 function Exception_Name (Id : Exception_Id) return String;
82 procedure Raise_Exception (E : Exception_Id; Message : String := "");
83 pragma No_Return (Raise_Exception);
84 -- Note: In accordance with AI-466, CE is raised if E = Null_Id
86 function Exception_Message (X : Exception_Occurrence) return String;
88 procedure Reraise_Occurrence (X : Exception_Occurrence);
89 -- Note: it would be really nice to give a pragma No_Return for this
90 -- procedure, but it would be wrong, since Reraise_Occurrence does return
91 -- if the argument is the null exception occurrence. See also procedure
92 -- Reraise_Occurrence_Always in the private part of this package.
94 function Exception_Identity (X : Exception_Occurrence) return Exception_Id;
96 function Exception_Information (X : Exception_Occurrence) return String;
97 -- The format of the exception information is as follows:
99 -- exception name (as in Exception_Name)
100 -- message (or a null line if no message)
101 -- PID=nnnn
102 -- 0xyyyyyyyy 0xyyyyyyyy ...
104 -- The lines are separated by a ASCII.LF character
105 -- The nnnn is the partition Id given as decimal digits.
106 -- The 0x... line represents traceback program counter locations,
107 -- in order with the first one being the exception location.
109 -- Note on ordering: the compiler uses the Save_Occurrence procedure, but
110 -- not the function from Rtsfind, so it is important that the procedure
111 -- come first, since Rtsfind finds the first matching entity.
113 procedure Save_Occurrence
114 (Target : out Exception_Occurrence;
115 Source : Exception_Occurrence);
117 function Save_Occurrence
118 (Source : Exception_Occurrence)
119 return Exception_Occurrence_Access;
121 private
122 package SSL renames System.Standard_Library;
123 package SP renames System.Parameters;
125 subtype EOA is Exception_Occurrence_Access;
127 Exception_Msg_Max_Length : constant := SP.Default_Exception_Msg_Max_Length;
129 ------------------
130 -- Exception_Id --
131 ------------------
133 subtype Code_Loc is System.Address;
134 -- Code location used in building exception tables and for call addresses
135 -- when propagating an exception. Values of this type are created by using
136 -- Label'Address or extracted from machine states using Get_Code_Loc.
138 Null_Loc : constant Code_Loc := System.Null_Address;
139 -- Null code location, used to flag outer level frame
141 type Exception_Id is new SSL.Exception_Data_Ptr;
143 function EId_To_String (X : Exception_Id) return String;
144 function String_To_EId (S : String) return Exception_Id;
145 pragma Stream_Convert (Exception_Id, String_To_EId, EId_To_String);
146 -- Functions for implementing Exception_Id stream attributes
148 Null_Id : constant Exception_Id := null;
150 -------------------------
151 -- Private Subprograms --
152 -------------------------
154 function Current_Target_Exception return Exception_Occurrence;
155 pragma Export
156 (Ada, Current_Target_Exception,
157 "__gnat_current_target_exception");
158 -- This routine should return the current raised exception on targets
159 -- which have built-in exception handling such as the Java Virtual
160 -- Machine. For other targets this routine is simply ignored. Currently,
161 -- only JGNAT uses this. See 4jexcept.ads for details. The pragma Export
162 -- allows this routine to be accessed elsewhere in the run-time, even
163 -- though it is in the private part of this package (it is not allowed
164 -- to be in the visible part, since this is set by the reference manual).
166 function Exception_Name_Simple (X : Exception_Occurrence) return String;
167 -- Like Exception_Name, but returns the simple non-qualified name of the
168 -- exception. This is used to implement the Exception_Name function in
169 -- Current_Exceptions (the DEC compatible unit). It is called from the
170 -- compiler generated code (using Rtsfind, which does not respect the
171 -- private barrier, so we can place this function in the private part
172 -- where the compiler can find it, but the spec is unchanged.)
174 procedure Raise_Exception_Always (E : Exception_Id; Message : String := "");
175 pragma No_Return (Raise_Exception_Always);
176 pragma Export (Ada, Raise_Exception_Always, "__gnat_raise_exception");
177 -- This differs from Raise_Exception only in that the caller has determined
178 -- that for sure the parameter E is not null, and that therefore no check
179 -- for Null_Id is required. The expander converts Raise_Exception calls to
180 -- Raise_Exception_Always if it can determine this is the case. The Export
181 -- allows this routine to be accessed from Pure units.
183 procedure Raise_From_Signal_Handler
184 (E : Exception_Id;
185 M : System.Address);
186 pragma Export
187 (Ada, Raise_From_Signal_Handler,
188 "ada__exceptions__raise_from_signal_handler");
189 pragma No_Return (Raise_From_Signal_Handler);
190 -- This routine is used to raise an exception from a signal handler. The
191 -- signal handler has already stored the machine state (i.e. the state that
192 -- corresponds to the location at which the signal was raised). E is the
193 -- Exception_Id specifying what exception is being raised, and M is a
194 -- pointer to a null-terminated string which is the message to be raised.
195 -- Note that this routine never returns, so it is permissible to simply
196 -- jump to this routine, rather than call it. This may be appropriate for
197 -- systems where the right way to get out of signal handler is to alter the
198 -- PC value in the machine state or in some other way ask the operating
199 -- system to return here rather than to the original location.
201 procedure Raise_From_Controlled_Operation
202 (X : Ada.Exceptions.Exception_Occurrence);
203 pragma No_Return (Raise_From_Controlled_Operation);
204 -- Raise Program_Error, providing information about X (an exception
205 -- raised during a controlled operation) in the exception message.
207 procedure Reraise_Occurrence_Always (X : Exception_Occurrence);
208 pragma No_Return (Reraise_Occurrence_Always);
209 -- This differs from Raise_Occurrence only in that the caller guarantees
210 -- that for sure the parameter X is not the null occurrence, and that
211 -- therefore this procedure cannot return. The expander uses this routine
212 -- in the translation of a raise statement with no parameter (reraise).
214 procedure Reraise_Occurrence_No_Defer (X : Exception_Occurrence);
215 pragma No_Return (Reraise_Occurrence_No_Defer);
216 -- Exactly like Reraise_Occurrence, except that abort is not deferred
217 -- before the call and the parameter X is known not to be the null
218 -- occurrence. This is used in generated code when it is known that
219 -- abort is already deferred.
221 -----------------------
222 -- Polling Interface --
223 -----------------------
225 -- The GNAT compiler has an option to generate polling calls to the Poll
226 -- routine in this package. Specifying the -gnatP option for a compilation
227 -- causes a call to Ada.Exceptions.Poll to be generated on every subprogram
228 -- entry and on every iteration of a loop, thus avoiding the possibility of
229 -- a case of unbounded time between calls.
231 -- This polling interface may be used for instrumentation or debugging
232 -- purposes (e.g. implementing watchpoints in software or in the debugger).
234 -- In the GNAT technology itself, this interface is used to implement
235 -- immediate asynchronous transfer of control and immediate abort on
236 -- targets which do not provide for one thread interrupting another.
238 -- Note: this used to be in a separate unit called System.Poll, but that
239 -- caused horrible circular elaboration problems between System.Poll and
240 -- Ada.Exceptions. One way of solving such circularities is unification!
242 procedure Poll;
243 -- Check for asynchronous abort. Note that we do not inline the body.
244 -- This makes the interface more useful for debugging purposes.
246 --------------------------
247 -- Exception_Occurrence --
248 --------------------------
250 package TBE renames System.Traceback_Entries;
252 Max_Tracebacks : constant := 50;
253 -- Maximum number of trace backs stored in exception occurrence
255 type Tracebacks_Array is array (1 .. Max_Tracebacks) of TBE.Traceback_Entry;
256 -- Traceback array stored in exception occurrence
258 type Exception_Occurrence is record
259 Id : Exception_Id;
260 -- Exception_Identity for this exception occurrence
261 -- WARNING System.System.Finalization_Implementation.Finalize_List
262 -- relies on the fact that this field is always first in the exception
263 -- occurrence
265 Msg_Length : Natural := 0;
266 -- Length of message (zero = no message)
268 Msg : String (1 .. Exception_Msg_Max_Length);
269 -- Characters of message
271 Cleanup_Flag : Boolean := False;
272 -- The cleanup flag is normally False, it is set True for an exception
273 -- occurrence passed to a cleanup routine, and will still be set True
274 -- when the cleanup routine does a Reraise_Occurrence call using this
275 -- exception occurrence. This is used to avoid recording a bogus trace
276 -- back entry from this reraise call.
278 Exception_Raised : Boolean := False;
279 -- Set to true to indicate that this exception occurrence has actually
280 -- been raised. When an exception occurrence is first created, this is
281 -- set to False, then when it is processed by Raise_Current_Exception,
282 -- it is set to True. If Raise_Current_Exception is used to raise an
283 -- exception for which this flag is already True, then it knows that
284 -- it is dealing with the reraise case (which is useful to distinguish
285 -- for exception tracing purposes).
287 Pid : Natural := 0;
288 -- Partition_Id for partition raising exception
290 Num_Tracebacks : Natural range 0 .. Max_Tracebacks := 0;
291 -- Number of traceback entries stored
293 Tracebacks : Tracebacks_Array;
294 -- Stored tracebacks (in Tracebacks (1 .. Num_Tracebacks))
296 Private_Data : System.Address := System.Null_Address;
297 -- Field used by low level exception mechanism to store specific data.
298 -- Currently used by the GCC exception mechanism to store a pointer to
299 -- a GNAT_GCC_Exception.
300 end record;
302 function "=" (Left, Right : Exception_Occurrence) return Boolean
303 is abstract;
304 -- Don't allow comparison on exception occurrences, we should not need
305 -- this, and it would not work right, because of the Msg and Tracebacks
306 -- fields which have unused entries not copied by Save_Occurrence.
308 function EO_To_String (X : Exception_Occurrence) return String;
309 function String_To_EO (S : String) return Exception_Occurrence;
310 pragma Stream_Convert (Exception_Occurrence, String_To_EO, EO_To_String);
311 -- Functions for implementing Exception_Occurrence stream attributes
313 Null_Occurrence : constant Exception_Occurrence := (
314 Id => null,
315 Msg_Length => 0,
316 Msg => (others => ' '),
317 Cleanup_Flag => False,
318 Exception_Raised => False,
319 Pid => 0,
320 Num_Tracebacks => 0,
321 Tracebacks => (others => TBE.Null_TB_Entry),
322 Private_Data => System.Null_Address);
324 end Ada.Exceptions;