1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
5 -- A D A . E X C E P T I O N S --
9 -- Copyright (C) 1992-2009, Free Software Foundation, Inc. --
11 -- GNAT is free software; you can redistribute it and/or modify it under --
12 -- terms of the GNU General Public License as published by the Free Soft- --
13 -- ware Foundation; either version 3, or (at your option) any later ver- --
14 -- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
15 -- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
16 -- or FITNESS FOR A PARTICULAR PURPOSE. --
18 -- As a special exception under Section 7 of GPL version 3, you are granted --
19 -- additional permissions described in the GCC Runtime Library Exception, --
20 -- version 3.1, as published by the Free Software Foundation. --
22 -- You should have received a copy of the GNU General Public License and --
23 -- a copy of the GCC Runtime Library Exception along with this program; --
24 -- see the files COPYING3 and COPYING.RUNTIME respectively. If not, see --
25 -- <http://www.gnu.org/licenses/>. --
27 -- GNAT was originally developed by the GNAT team at New York University. --
28 -- Extensive contributions were provided by Ada Core Technologies Inc. --
30 ------------------------------------------------------------------------------
32 -- This version of Ada.Exceptions is a full Ada 95 version, and Ada 2005
33 -- features such as the additional definitions of Exception_Name returning
34 -- Wide_[Wide_]String.
36 -- It is used for building the compiler and the basic tools, since these
37 -- builds may be done with bootstrap compilers that cannot handle these
38 -- additions. The full version of Ada.Exceptions can be found in the files
39 -- a-except-2005.ads/adb, and is used for all other builds where full Ada
40 -- 2005 functionality is required. In particular, it is used for building
41 -- run times on all targets.
45 pragma Style_Checks
(All_Checks
);
46 -- No subprogram ordering check, due to logical grouping
49 -- We must turn polling off for this unit, because otherwise we get
50 -- elaboration circularities with System.Exception_Tables.
52 with System
; use System
;
53 with System
.Exceptions
; use System
.Exceptions
;
54 with System
.Standard_Library
; use System
.Standard_Library
;
55 with System
.Soft_Links
; use System
.Soft_Links
;
57 package body Ada
.Exceptions
is
59 pragma Suppress
(All_Checks
);
60 -- We definitely do not want exceptions occurring within this unit, or we
61 -- are in big trouble. If an exceptional situation does occur, better that
62 -- it not be raised, since raising it can cause confusing chaos.
64 -----------------------
65 -- Local Subprograms --
66 -----------------------
68 -- Note: the exported subprograms in this package body are called directly
69 -- from C clients using the given external name, even though they are not
70 -- technically visible in the Ada sense.
72 procedure Process_Raise_Exception
(E
: Exception_Id
);
73 pragma No_Return
(Process_Raise_Exception
);
74 -- This is the lowest level raise routine. It raises the exception
75 -- referenced by Current_Excep.all in the TSD, without deferring abort
76 -- (the caller must ensure that abort is deferred on entry).
78 procedure To_Stderr
(S
: String);
79 pragma Export
(Ada
, To_Stderr
, "__gnat_to_stderr");
80 -- Little routine to output string to stderr that is also used in the
83 procedure To_Stderr
(C
: Character);
84 pragma Inline
(To_Stderr
);
85 pragma Export
(Ada
, To_Stderr
, "__gnat_to_stderr_char");
86 -- Little routine to output a character to stderr, used by some of the
87 -- separate units below.
89 package Exception_Data
is
91 ---------------------------------
92 -- Exception messages routines --
93 ---------------------------------
95 procedure Set_Exception_C_Msg
97 Msg1
: System
.Address
;
99 Msg2
: System
.Address
:= System
.Null_Address
);
100 -- This routine is called to setup the exception referenced by the
101 -- Current_Excep field in the TSD to contain the indicated Id value
102 -- and message. Msg1 is a null terminated string which is generated
103 -- as the exception message. If line is non-zero, then a colon and
104 -- the decimal representation of this integer is appended to the
105 -- message. When Msg2 is non-null, a space and this additional null
106 -- terminated string is added to the message.
108 procedure Set_Exception_Msg
111 -- This routine is called to setup the exception referenced by the
112 -- Current_Excep field in the TSD to contain the indicated Id value and
113 -- message. Message is a string which is generated as the exception
116 --------------------------------------
117 -- Exception information subprogram --
118 --------------------------------------
120 function Exception_Information
(X
: Exception_Occurrence
) return String;
121 -- The format of the exception information is as follows:
123 -- Exception_Name: <exception name> (as in Exception_Name)
124 -- Message: <message> (only if Exception_Message is empty)
125 -- PID=nnnn (only if != 0)
126 -- Call stack traceback locations: (only if at least one location)
127 -- <0xyyyyyyyy 0xyyyyyyyy ...> (is recorded)
129 -- The lines are separated by a ASCII.LF character
131 -- The nnnn is the partition Id given as decimal digits
133 -- The 0x... line represents traceback program counter locations, in
134 -- execution order with the first one being the exception location. It
137 -- The Exception_Name and Message lines are omitted in the abort signal
138 -- case, since this is not really an exception.
140 -- Note: If the format of the generated string is changed, please note
141 -- that an equivalent modification to the routine String_To_EO must be
142 -- made to preserve proper functioning of the stream attributes.
144 ---------------------------------------
145 -- Exception backtracing subprograms --
146 ---------------------------------------
148 -- What is automatically output when exception tracing is on is the
149 -- usual exception information with the call chain backtrace possibly
150 -- tailored by a backtrace decorator. Modifying Exception_Information
151 -- itself is not a good idea because the decorated output is completely
152 -- out of control and would break all our code related to the streaming
153 -- of exceptions. We then provide an alternative function to compute
154 -- the possibly tailored output, which is equivalent if no decorator is
157 function Tailored_Exception_Information
158 (X
: Exception_Occurrence
) return String;
159 -- Exception information to be output in the case of automatic tracing
160 -- requested through GNAT.Exception_Traces.
162 -- This is the same as Exception_Information if no backtrace decorator
163 -- is currently in place. Otherwise, this is Exception_Information with
164 -- the call chain raw addresses replaced by the result of a call to the
165 -- current decorator provided with the call chain addresses.
168 (Ada
, Tailored_Exception_Information
,
169 "__gnat_tailored_exception_information");
170 -- This is currently used by System.Tasking.Stages
174 package Exception_Traces
is
177 -- Imports Tailored_Exception_Information
179 ----------------------------------------------
180 -- Run-Time Exception Notification Routines --
181 ----------------------------------------------
183 -- These subprograms provide a common run-time interface to trigger the
184 -- actions required when an exception is about to be propagated (e.g.
185 -- user specified actions or output of exception information). They are
186 -- exported to be usable by the Ada exception handling personality
187 -- routine when the GCC 3 mechanism is used.
189 procedure Notify_Handled_Exception
;
191 (C
, Notify_Handled_Exception
, "__gnat_notify_handled_exception");
192 -- This routine is called for a handled occurrence is about to be
195 procedure Notify_Unhandled_Exception
;
197 (C
, Notify_Unhandled_Exception
, "__gnat_notify_unhandled_exception");
198 -- This routine is called when an unhandled occurrence is about to be
201 procedure Unhandled_Exception_Terminate
;
202 pragma No_Return
(Unhandled_Exception_Terminate
);
203 -- This procedure is called to terminate program execution following an
204 -- unhandled exception. The exception information, including traceback
205 -- if available is output, and execution is then terminated. Note that
206 -- at the point where this routine is called, the stack has typically
209 end Exception_Traces
;
211 package Exception_Propagation
is
213 procedure Setup_Exception
216 Reraised
: Boolean := False);
217 -- Dummy routine used to share a-exexda.adb, do nothing
219 end Exception_Propagation
;
221 package Stream_Attributes
is
223 --------------------------------
224 -- Stream attributes routines --
225 --------------------------------
227 function EId_To_String
(X
: Exception_Id
) return String;
228 function String_To_EId
(S
: String) return Exception_Id
;
229 -- Functions for implementing Exception_Id stream attributes
231 function EO_To_String
(X
: Exception_Occurrence
) return String;
232 function String_To_EO
(S
: String) return Exception_Occurrence
;
233 -- Functions for implementing Exception_Occurrence stream
236 end Stream_Attributes
;
238 procedure Raise_Current_Excep
(E
: Exception_Id
);
239 pragma No_Return
(Raise_Current_Excep
);
240 pragma Export
(C
, Raise_Current_Excep
, "__gnat_raise_nodefer_with_msg");
241 -- This is a simple wrapper to Process_Raise_Exception.
243 -- This external name for Raise_Current_Excep is historical, and probably
244 -- should be changed but for now we keep it, because gdb and gigi know
247 procedure Raise_Exception_No_Defer
248 (E
: Exception_Id
; Message
: String := "");
250 (Ada
, Raise_Exception_No_Defer
,
251 "ada__exceptions__raise_exception_no_defer");
252 pragma No_Return
(Raise_Exception_No_Defer
);
253 -- Similar to Raise_Exception, but with no abort deferral
255 procedure Raise_With_Msg
(E
: Exception_Id
);
256 pragma No_Return
(Raise_With_Msg
);
257 pragma Export
(C
, Raise_With_Msg
, "__gnat_raise_with_msg");
258 -- Raises an exception with given exception id value. A message is
259 -- associated with the raise, and has already been stored in the exception
260 -- occurrence referenced by the Current_Excep in the TSD. Abort is deferred
261 -- before the raise call.
263 procedure Raise_With_Location_And_Msg
267 M
: System
.Address
:= System
.Null_Address
);
268 pragma No_Return
(Raise_With_Location_And_Msg
);
269 -- Raise an exception with given exception id value. A filename and line
270 -- number is associated with the raise and is stored in the exception
271 -- occurrence and in addition a string message M is appended to this
274 procedure Raise_Constraint_Error
275 (File
: System
.Address
;
277 pragma No_Return
(Raise_Constraint_Error
);
279 (C
, Raise_Constraint_Error
, "__gnat_raise_constraint_error");
280 -- Raise constraint error with file:line information
282 procedure Raise_Constraint_Error_Msg
283 (File
: System
.Address
;
285 Msg
: System
.Address
);
286 pragma No_Return
(Raise_Constraint_Error_Msg
);
288 (C
, Raise_Constraint_Error_Msg
, "__gnat_raise_constraint_error_msg");
289 -- Raise constraint error with file:line + msg information
291 procedure Raise_Program_Error
292 (File
: System
.Address
;
294 pragma No_Return
(Raise_Program_Error
);
296 (C
, Raise_Program_Error
, "__gnat_raise_program_error");
297 -- Raise program error with file:line information
299 procedure Raise_Program_Error_Msg
300 (File
: System
.Address
;
302 Msg
: System
.Address
);
303 pragma No_Return
(Raise_Program_Error_Msg
);
305 (C
, Raise_Program_Error_Msg
, "__gnat_raise_program_error_msg");
306 -- Raise program error with file:line + msg information
308 procedure Raise_Storage_Error
309 (File
: System
.Address
;
311 pragma No_Return
(Raise_Storage_Error
);
313 (C
, Raise_Storage_Error
, "__gnat_raise_storage_error");
314 -- Raise storage error with file:line information
316 procedure Raise_Storage_Error_Msg
317 (File
: System
.Address
;
319 Msg
: System
.Address
);
320 pragma No_Return
(Raise_Storage_Error_Msg
);
322 (C
, Raise_Storage_Error_Msg
, "__gnat_raise_storage_error_msg");
323 -- Raise storage error with file:line + reason msg information
325 -- The exception raising process and the automatic tracing mechanism rely
326 -- on some careful use of flags attached to the exception occurrence. The
327 -- graph below illustrates the relations between the Raise_ subprograms
328 -- and identifies the points where basic flags such as Exception_Raised
331 -- (i) signs indicate the flags initialization points. R stands for Raise,
332 -- W for With, and E for Exception.
334 -- R_No_Msg R_E R_Pe R_Ce R_Se
336 -- +--+ +--+ +---+ | +---+
338 -- R_E_No_Defer(i) R_W_Msg(i) R_W_Loc
340 -- +------------+ | +-----------+ +--+
342 -- | | | Set_E_C_Msg(i)
344 -- Raise_Current_Excep
347 pragma No_Return
(Reraise
);
348 pragma Export
(C
, Reraise
, "__gnat_reraise");
349 -- Reraises the exception referenced by the Current_Excep field of the TSD
350 -- (all fields of this exception occurrence are set). Abort is deferred
351 -- before the reraise operation.
353 -- Save_Occurrence variations: As the management of the private data
354 -- attached to occurrences is delicate, whether or not pointers to such
355 -- data has to be copied in various situations is better made explicit.
356 -- The following procedures provide an internal interface to help making
359 procedure Save_Occurrence_No_Private
360 (Target
: out Exception_Occurrence
;
361 Source
: Exception_Occurrence
);
362 -- Copy all the components of Source to Target, except the
363 -- Private_Data pointer.
365 procedure Transfer_Occurrence
366 (Target
: Exception_Occurrence_Access
;
367 Source
: Exception_Occurrence
);
368 pragma Export
(C
, Transfer_Occurrence
, "__gnat_transfer_occurrence");
369 -- Called from System.Tasking.RendezVous.Exceptional_Complete_RendezVous
370 -- to setup Target from Source as an exception to be propagated in the
371 -- caller task. Target is expected to be a pointer to the fixed TSD
372 -- occurrence for this task.
374 -----------------------------
375 -- Run-Time Check Routines --
376 -----------------------------
378 -- Routines to a specific exception with a reason message attached. The
379 -- parameters are the file name and line number in each case. The names are
380 -- keyed to the codes defined in types.ads and a-types.h (for example, the
381 -- name Rcheck_05 refers to the Reason RT_Exception_Code'Val (5)).
383 procedure Rcheck_00
(File
: System
.Address
; Line
: Integer);
384 procedure Rcheck_01
(File
: System
.Address
; Line
: Integer);
385 procedure Rcheck_02
(File
: System
.Address
; Line
: Integer);
386 procedure Rcheck_03
(File
: System
.Address
; Line
: Integer);
387 procedure Rcheck_04
(File
: System
.Address
; Line
: Integer);
388 procedure Rcheck_05
(File
: System
.Address
; Line
: Integer);
389 procedure Rcheck_06
(File
: System
.Address
; Line
: Integer);
390 procedure Rcheck_07
(File
: System
.Address
; Line
: Integer);
391 procedure Rcheck_08
(File
: System
.Address
; Line
: Integer);
392 procedure Rcheck_09
(File
: System
.Address
; Line
: Integer);
393 procedure Rcheck_10
(File
: System
.Address
; Line
: Integer);
394 procedure Rcheck_11
(File
: System
.Address
; Line
: Integer);
395 procedure Rcheck_12
(File
: System
.Address
; Line
: Integer);
396 procedure Rcheck_13
(File
: System
.Address
; Line
: Integer);
397 procedure Rcheck_14
(File
: System
.Address
; Line
: Integer);
398 procedure Rcheck_15
(File
: System
.Address
; Line
: Integer);
399 procedure Rcheck_16
(File
: System
.Address
; Line
: Integer);
400 procedure Rcheck_17
(File
: System
.Address
; Line
: Integer);
401 procedure Rcheck_18
(File
: System
.Address
; Line
: Integer);
402 procedure Rcheck_19
(File
: System
.Address
; Line
: Integer);
403 procedure Rcheck_20
(File
: System
.Address
; Line
: Integer);
404 procedure Rcheck_21
(File
: System
.Address
; Line
: Integer);
405 procedure Rcheck_22
(File
: System
.Address
; Line
: Integer);
406 procedure Rcheck_23
(File
: System
.Address
; Line
: Integer);
407 procedure Rcheck_24
(File
: System
.Address
; Line
: Integer);
408 procedure Rcheck_25
(File
: System
.Address
; Line
: Integer);
409 procedure Rcheck_26
(File
: System
.Address
; Line
: Integer);
410 procedure Rcheck_27
(File
: System
.Address
; Line
: Integer);
411 procedure Rcheck_28
(File
: System
.Address
; Line
: Integer);
412 procedure Rcheck_29
(File
: System
.Address
; Line
: Integer);
413 procedure Rcheck_30
(File
: System
.Address
; Line
: Integer);
414 procedure Rcheck_31
(File
: System
.Address
; Line
: Integer);
415 procedure Rcheck_32
(File
: System
.Address
; Line
: Integer);
416 procedure Rcheck_33
(File
: System
.Address
; Line
: Integer);
418 pragma Export
(C
, Rcheck_00
, "__gnat_rcheck_00");
419 pragma Export
(C
, Rcheck_01
, "__gnat_rcheck_01");
420 pragma Export
(C
, Rcheck_02
, "__gnat_rcheck_02");
421 pragma Export
(C
, Rcheck_03
, "__gnat_rcheck_03");
422 pragma Export
(C
, Rcheck_04
, "__gnat_rcheck_04");
423 pragma Export
(C
, Rcheck_05
, "__gnat_rcheck_05");
424 pragma Export
(C
, Rcheck_06
, "__gnat_rcheck_06");
425 pragma Export
(C
, Rcheck_07
, "__gnat_rcheck_07");
426 pragma Export
(C
, Rcheck_08
, "__gnat_rcheck_08");
427 pragma Export
(C
, Rcheck_09
, "__gnat_rcheck_09");
428 pragma Export
(C
, Rcheck_10
, "__gnat_rcheck_10");
429 pragma Export
(C
, Rcheck_11
, "__gnat_rcheck_11");
430 pragma Export
(C
, Rcheck_12
, "__gnat_rcheck_12");
431 pragma Export
(C
, Rcheck_13
, "__gnat_rcheck_13");
432 pragma Export
(C
, Rcheck_14
, "__gnat_rcheck_14");
433 pragma Export
(C
, Rcheck_15
, "__gnat_rcheck_15");
434 pragma Export
(C
, Rcheck_16
, "__gnat_rcheck_16");
435 pragma Export
(C
, Rcheck_17
, "__gnat_rcheck_17");
436 pragma Export
(C
, Rcheck_18
, "__gnat_rcheck_18");
437 pragma Export
(C
, Rcheck_19
, "__gnat_rcheck_19");
438 pragma Export
(C
, Rcheck_20
, "__gnat_rcheck_20");
439 pragma Export
(C
, Rcheck_21
, "__gnat_rcheck_21");
440 pragma Export
(C
, Rcheck_22
, "__gnat_rcheck_22");
441 pragma Export
(C
, Rcheck_23
, "__gnat_rcheck_23");
442 pragma Export
(C
, Rcheck_24
, "__gnat_rcheck_24");
443 pragma Export
(C
, Rcheck_25
, "__gnat_rcheck_25");
444 pragma Export
(C
, Rcheck_26
, "__gnat_rcheck_26");
445 pragma Export
(C
, Rcheck_27
, "__gnat_rcheck_27");
446 pragma Export
(C
, Rcheck_28
, "__gnat_rcheck_28");
447 pragma Export
(C
, Rcheck_29
, "__gnat_rcheck_29");
448 pragma Export
(C
, Rcheck_30
, "__gnat_rcheck_30");
449 pragma Export
(C
, Rcheck_31
, "__gnat_rcheck_31");
450 pragma Export
(C
, Rcheck_32
, "__gnat_rcheck_32");
451 pragma Export
(C
, Rcheck_33
, "__gnat_rcheck_33");
453 -- None of these procedures ever returns (they raise an exception!). By
454 -- using pragma No_Return, we ensure that any junk code after the call,
455 -- such as normal return epilog stuff, can be eliminated).
457 pragma No_Return
(Rcheck_00
);
458 pragma No_Return
(Rcheck_01
);
459 pragma No_Return
(Rcheck_02
);
460 pragma No_Return
(Rcheck_03
);
461 pragma No_Return
(Rcheck_04
);
462 pragma No_Return
(Rcheck_05
);
463 pragma No_Return
(Rcheck_06
);
464 pragma No_Return
(Rcheck_07
);
465 pragma No_Return
(Rcheck_08
);
466 pragma No_Return
(Rcheck_09
);
467 pragma No_Return
(Rcheck_10
);
468 pragma No_Return
(Rcheck_11
);
469 pragma No_Return
(Rcheck_12
);
470 pragma No_Return
(Rcheck_13
);
471 pragma No_Return
(Rcheck_14
);
472 pragma No_Return
(Rcheck_15
);
473 pragma No_Return
(Rcheck_16
);
474 pragma No_Return
(Rcheck_17
);
475 pragma No_Return
(Rcheck_18
);
476 pragma No_Return
(Rcheck_19
);
477 pragma No_Return
(Rcheck_20
);
478 pragma No_Return
(Rcheck_21
);
479 pragma No_Return
(Rcheck_22
);
480 pragma No_Return
(Rcheck_23
);
481 pragma No_Return
(Rcheck_24
);
482 pragma No_Return
(Rcheck_25
);
483 pragma No_Return
(Rcheck_26
);
484 pragma No_Return
(Rcheck_27
);
485 pragma No_Return
(Rcheck_28
);
486 pragma No_Return
(Rcheck_29
);
487 pragma No_Return
(Rcheck_30
);
488 pragma No_Return
(Rcheck_32
);
489 pragma No_Return
(Rcheck_33
);
491 ---------------------------------------------
492 -- Reason Strings for Run-Time Check Calls --
493 ---------------------------------------------
495 -- These strings are null-terminated and are used by Rcheck_nn. The
496 -- strings correspond to the definitions for Types.RT_Exception_Code.
500 Rmsg_00
: constant String := "access check failed" & NUL
;
501 Rmsg_01
: constant String := "access parameter is null" & NUL
;
502 Rmsg_02
: constant String := "discriminant check failed" & NUL
;
503 Rmsg_03
: constant String := "divide by zero" & NUL
;
504 Rmsg_04
: constant String := "explicit raise" & NUL
;
505 Rmsg_05
: constant String := "index check failed" & NUL
;
506 Rmsg_06
: constant String := "invalid data" & NUL
;
507 Rmsg_07
: constant String := "length check failed" & NUL
;
508 Rmsg_08
: constant String := "null Exception_Id" & NUL
;
509 Rmsg_09
: constant String := "null-exclusion check failed" & NUL
;
510 Rmsg_10
: constant String := "overflow check failed" & NUL
;
511 Rmsg_11
: constant String := "partition check failed" & NUL
;
512 Rmsg_12
: constant String := "range check failed" & NUL
;
513 Rmsg_13
: constant String := "tag check failed" & NUL
;
514 Rmsg_14
: constant String := "access before elaboration" & NUL
;
515 Rmsg_15
: constant String := "accessibility check failed" & NUL
;
516 Rmsg_16
: constant String := "attempt to take address of" &
517 " intrinsic subprogram" & NUL
;
518 Rmsg_17
: constant String := "all guards closed" & NUL
;
519 Rmsg_18
: constant String := "Current_Task referenced in entry" &
521 Rmsg_19
: constant String := "duplicated entry address" & NUL
;
522 Rmsg_20
: constant String := "explicit raise" & NUL
;
523 Rmsg_21
: constant String := "finalize/adjust raised exception" & NUL
;
524 Rmsg_22
: constant String := "implicit return with No_Return" & NUL
;
525 Rmsg_23
: constant String := "misaligned address value" & NUL
;
526 Rmsg_24
: constant String := "missing return" & NUL
;
527 Rmsg_25
: constant String := "overlaid controlled object" & NUL
;
528 Rmsg_26
: constant String := "potentially blocking operation" & NUL
;
529 Rmsg_27
: constant String := "stubbed subprogram called" & NUL
;
530 Rmsg_28
: constant String := "unchecked union restriction" & NUL
;
531 Rmsg_29
: constant String := "actual/returned class-wide" &
532 " value not transportable" & NUL
;
533 Rmsg_30
: constant String := "empty storage pool" & NUL
;
534 Rmsg_31
: constant String := "explicit raise" & NUL
;
535 Rmsg_32
: constant String := "infinite recursion" & NUL
;
536 Rmsg_33
: constant String := "object too large" & NUL
;
538 -----------------------
539 -- Polling Interface --
540 -----------------------
542 type Unsigned
is mod 2 ** 32;
544 Counter
: Unsigned
:= 0;
545 pragma Warnings
(Off
, Counter
);
546 -- This counter is provided for convenience. It can be used in Poll to
547 -- perform periodic but not systematic operations.
549 procedure Poll
is separate;
550 -- The actual polling routine is separate, so that it can easily be
551 -- replaced with a target dependent version.
553 ------------------------------
554 -- Current_Target_Exception --
555 ------------------------------
557 function Current_Target_Exception
return Exception_Occurrence
is
559 return Null_Occurrence
;
560 end Current_Target_Exception
;
566 function EId_To_String
(X
: Exception_Id
) return String
567 renames Stream_Attributes
.EId_To_String
;
573 -- We use the null string to represent the null occurrence, otherwise we
574 -- output the Exception_Information string for the occurrence.
576 function EO_To_String
(X
: Exception_Occurrence
) return String
577 renames Stream_Attributes
.EO_To_String
;
579 ------------------------
580 -- Exception_Identity --
581 ------------------------
583 function Exception_Identity
584 (X
: Exception_Occurrence
) return Exception_Id
587 -- Note that the following test used to be here for the original Ada 95
588 -- semantics, but these were modified by AI-241 to require returning
589 -- Null_Id instead of raising Constraint_Error.
591 -- if X.Id = Null_Id then
592 -- raise Constraint_Error;
596 end Exception_Identity
;
598 ---------------------------
599 -- Exception_Information --
600 ---------------------------
602 function Exception_Information
(X
: Exception_Occurrence
) return String is
604 if X
.Id
= Null_Id
then
605 raise Constraint_Error
;
608 return Exception_Data
.Exception_Information
(X
);
609 end Exception_Information
;
611 -----------------------
612 -- Exception_Message --
613 -----------------------
615 function Exception_Message
(X
: Exception_Occurrence
) return String is
617 if X
.Id
= Null_Id
then
618 raise Constraint_Error
;
621 return X
.Msg
(1 .. X
.Msg_Length
);
622 end Exception_Message
;
628 function Exception_Name
(Id
: Exception_Id
) return String is
631 raise Constraint_Error
;
634 return To_Ptr
(Id
.Full_Name
) (1 .. Id
.Name_Length
- 1);
637 function Exception_Name
(X
: Exception_Occurrence
) return String is
639 return Exception_Name
(X
.Id
);
642 ---------------------------
643 -- Exception_Name_Simple --
644 ---------------------------
646 function Exception_Name_Simple
(X
: Exception_Occurrence
) return String is
647 Name
: constant String := Exception_Name
(X
);
653 exit when Name
(P
- 1) = '.';
657 -- Return result making sure lower bound is 1
660 subtype Rname
is String (1 .. Name
'Length - P
+ 1);
662 return Rname
(Name
(P
.. Name
'Length));
664 end Exception_Name_Simple
;
670 package body Exception_Data
is separate;
671 -- This package can be easily dummied out if we do not want the basic
672 -- support for exception messages (such as in Ada 83).
674 package body Exception_Propagation
is
676 procedure Setup_Exception
679 Reraised
: Boolean := False)
681 pragma Warnings
(Off
, Excep
);
682 pragma Warnings
(Off
, Current
);
683 pragma Warnings
(Off
, Reraised
);
688 end Exception_Propagation
;
690 ----------------------
691 -- Exception_Traces --
692 ----------------------
694 package body Exception_Traces
is separate;
695 -- Depending on the underlying support for IO the implementation will
696 -- differ. Moreover we would like to dummy out this package in case we do
697 -- not want any exception tracing support. This is why this package is
700 -----------------------
701 -- Stream Attributes --
702 -----------------------
704 package body Stream_Attributes
is separate;
705 -- This package can be easily dummied out if we do not want the
706 -- support for streaming Exception_Ids and Exception_Occurrences.
708 -----------------------------
709 -- Process_Raise_Exception --
710 -----------------------------
712 procedure Process_Raise_Exception
(E
: Exception_Id
) is
713 pragma Inspection_Point
(E
);
714 -- This is so the debugger can reliably inspect the parameter
716 Jumpbuf_Ptr
: constant Address
:= Get_Jmpbuf_Address
.all;
717 Excep
: constant EOA
:= Get_Current_Excep
.all;
719 procedure builtin_longjmp
(buffer
: Address
; Flag
: Integer);
720 pragma No_Return
(builtin_longjmp
);
721 pragma Import
(C
, builtin_longjmp
, "_gnat_builtin_longjmp");
724 -- WARNING: There should be no exception handler for this body because
725 -- this would cause gigi to prepend a setup for a new jmpbuf to the
726 -- sequence of statements in case of built-in sjljl. We would then
727 -- always get this new buf in Jumpbuf_Ptr instead of the one for the
728 -- exception we are handling, which would completely break the whole
729 -- design of this procedure.
731 -- If the jump buffer pointer is non-null, transfer control using it.
732 -- Otherwise announce an unhandled exception (note that this means that
733 -- we have no finalizations to do other than at the outer level).
734 -- Perform the necessary notification tasks in both cases.
736 if Jumpbuf_Ptr
/= Null_Address
then
737 if not Excep
.Exception_Raised
then
738 Excep
.Exception_Raised
:= True;
739 Exception_Traces
.Notify_Handled_Exception
;
742 builtin_longjmp
(Jumpbuf_Ptr
, 1);
745 Exception_Traces
.Notify_Unhandled_Exception
;
746 Exception_Traces
.Unhandled_Exception_Terminate
;
748 end Process_Raise_Exception
;
750 ----------------------------
751 -- Raise_Constraint_Error --
752 ----------------------------
754 procedure Raise_Constraint_Error
755 (File
: System
.Address
;
759 Raise_With_Location_And_Msg
760 (Constraint_Error_Def
'Access, File
, Line
);
761 end Raise_Constraint_Error
;
763 --------------------------------
764 -- Raise_Constraint_Error_Msg --
765 --------------------------------
767 procedure Raise_Constraint_Error_Msg
768 (File
: System
.Address
;
770 Msg
: System
.Address
)
773 Raise_With_Location_And_Msg
774 (Constraint_Error_Def
'Access, File
, Line
, Msg
);
775 end Raise_Constraint_Error_Msg
;
777 -------------------------
778 -- Raise_Current_Excep --
779 -------------------------
781 procedure Raise_Current_Excep
(E
: Exception_Id
) is
783 pragma Inspection_Point
(E
);
784 -- This is so the debugger can reliably inspect the parameter when
785 -- inserting a breakpoint at the start of this procedure.
787 Id
: Exception_Id
:= E
;
788 pragma Volatile
(Id
);
789 pragma Warnings
(Off
, Id
);
790 -- In order to provide support for breakpoints on unhandled exceptions,
791 -- the debugger will also need to be able to inspect the value of E from
792 -- another (inner) frame. So we need to make sure that if E is passed in
793 -- a register, its value is also spilled on stack. For this, we store
794 -- the parameter value in a local variable, and add a pragma Volatile to
795 -- make sure it is spilled. The pragma Warnings (Off) is needed because
796 -- the compiler knows that Id is not referenced and that this use of
797 -- pragma Volatile is peculiar!
800 Debug_Raise_Exception
(E
=> SSL
.Exception_Data_Ptr
(E
));
801 Process_Raise_Exception
(E
);
802 end Raise_Current_Excep
;
804 ---------------------
805 -- Raise_Exception --
806 ---------------------
808 procedure Raise_Exception
810 Message
: String := "")
812 EF
: Exception_Id
:= E
;
815 -- Raise CE if E = Null_ID (AI-446)
818 EF
:= Constraint_Error
'Identity;
821 -- Go ahead and raise appropriate exception
823 Exception_Data
.Set_Exception_Msg
(EF
, Message
);
825 Raise_Current_Excep
(EF
);
828 ----------------------------
829 -- Raise_Exception_Always --
830 ----------------------------
832 procedure Raise_Exception_Always
834 Message
: String := "")
837 Exception_Data
.Set_Exception_Msg
(E
, Message
);
839 Raise_Current_Excep
(E
);
840 end Raise_Exception_Always
;
842 -------------------------------------
843 -- Raise_From_Controlled_Operation --
844 -------------------------------------
846 procedure Raise_From_Controlled_Operation
847 (X
: Ada
.Exceptions
.Exception_Occurrence
)
849 Prefix
: constant String := "adjust/finalize raised ";
850 Orig_Msg
: constant String := Exception_Message
(X
);
851 New_Msg
: constant String := Prefix
& Exception_Name
(X
);
854 if Orig_Msg
'Length >= Prefix
'Length
856 Orig_Msg
(Orig_Msg
'First .. Orig_Msg
'First + Prefix
'Length - 1) =
859 -- Message already has proper prefix, just re-reraise PROGRAM_ERROR
861 Raise_Exception_No_Defer
862 (E
=> Program_Error
'Identity,
863 Message
=> Orig_Msg
);
865 elsif Orig_Msg
= "" then
867 -- No message present: just provide our own
869 Raise_Exception_No_Defer
870 (E
=> Program_Error
'Identity,
874 -- Message present, add informational prefix
876 Raise_Exception_No_Defer
877 (E
=> Program_Error
'Identity,
878 Message
=> New_Msg
& ": " & Orig_Msg
);
880 end Raise_From_Controlled_Operation
;
882 -------------------------------
883 -- Raise_From_Signal_Handler --
884 -------------------------------
886 procedure Raise_From_Signal_Handler
891 Exception_Data
.Set_Exception_C_Msg
(E
, M
);
893 Process_Raise_Exception
(E
);
894 end Raise_From_Signal_Handler
;
896 -------------------------
897 -- Raise_Program_Error --
898 -------------------------
900 procedure Raise_Program_Error
901 (File
: System
.Address
;
905 Raise_With_Location_And_Msg
906 (Program_Error_Def
'Access, File
, Line
);
907 end Raise_Program_Error
;
909 -----------------------------
910 -- Raise_Program_Error_Msg --
911 -----------------------------
913 procedure Raise_Program_Error_Msg
914 (File
: System
.Address
;
916 Msg
: System
.Address
)
919 Raise_With_Location_And_Msg
920 (Program_Error_Def
'Access, File
, Line
, Msg
);
921 end Raise_Program_Error_Msg
;
923 -------------------------
924 -- Raise_Storage_Error --
925 -------------------------
927 procedure Raise_Storage_Error
928 (File
: System
.Address
;
932 Raise_With_Location_And_Msg
933 (Storage_Error_Def
'Access, File
, Line
);
934 end Raise_Storage_Error
;
936 -----------------------------
937 -- Raise_Storage_Error_Msg --
938 -----------------------------
940 procedure Raise_Storage_Error_Msg
941 (File
: System
.Address
;
943 Msg
: System
.Address
)
946 Raise_With_Location_And_Msg
947 (Storage_Error_Def
'Access, File
, Line
, Msg
);
948 end Raise_Storage_Error_Msg
;
950 ---------------------------------
951 -- Raise_With_Location_And_Msg --
952 ---------------------------------
954 procedure Raise_With_Location_And_Msg
958 M
: System
.Address
:= System
.Null_Address
)
961 Exception_Data
.Set_Exception_C_Msg
(E
, F
, L
, M
);
963 Raise_Current_Excep
(E
);
964 end Raise_With_Location_And_Msg
;
970 procedure Raise_With_Msg
(E
: Exception_Id
) is
971 Excep
: constant EOA
:= Get_Current_Excep
.all;
974 Excep
.Exception_Raised
:= False;
976 Excep
.Num_Tracebacks
:= 0;
977 Excep
.Cleanup_Flag
:= False;
978 Excep
.Pid
:= Local_Partition_ID
;
980 Raise_Current_Excep
(E
);
983 --------------------------------------
984 -- Calls to Run-Time Check Routines --
985 --------------------------------------
987 procedure Rcheck_00
(File
: System
.Address
; Line
: Integer) is
989 Raise_Constraint_Error_Msg
(File
, Line
, Rmsg_00
'Address);
992 procedure Rcheck_01
(File
: System
.Address
; Line
: Integer) is
994 Raise_Constraint_Error_Msg
(File
, Line
, Rmsg_01
'Address);
997 procedure Rcheck_02
(File
: System
.Address
; Line
: Integer) is
999 Raise_Constraint_Error_Msg
(File
, Line
, Rmsg_02
'Address);
1002 procedure Rcheck_03
(File
: System
.Address
; Line
: Integer) is
1004 Raise_Constraint_Error_Msg
(File
, Line
, Rmsg_03
'Address);
1007 procedure Rcheck_04
(File
: System
.Address
; Line
: Integer) is
1009 Raise_Constraint_Error_Msg
(File
, Line
, Rmsg_04
'Address);
1012 procedure Rcheck_05
(File
: System
.Address
; Line
: Integer) is
1014 Raise_Constraint_Error_Msg
(File
, Line
, Rmsg_05
'Address);
1017 procedure Rcheck_06
(File
: System
.Address
; Line
: Integer) is
1019 Raise_Constraint_Error_Msg
(File
, Line
, Rmsg_06
'Address);
1022 procedure Rcheck_07
(File
: System
.Address
; Line
: Integer) is
1024 Raise_Constraint_Error_Msg
(File
, Line
, Rmsg_07
'Address);
1027 procedure Rcheck_08
(File
: System
.Address
; Line
: Integer) is
1029 Raise_Constraint_Error_Msg
(File
, Line
, Rmsg_08
'Address);
1032 procedure Rcheck_09
(File
: System
.Address
; Line
: Integer) is
1034 Raise_Constraint_Error_Msg
(File
, Line
, Rmsg_09
'Address);
1037 procedure Rcheck_10
(File
: System
.Address
; Line
: Integer) is
1039 Raise_Constraint_Error_Msg
(File
, Line
, Rmsg_10
'Address);
1042 procedure Rcheck_11
(File
: System
.Address
; Line
: Integer) is
1044 Raise_Constraint_Error_Msg
(File
, Line
, Rmsg_11
'Address);
1047 procedure Rcheck_12
(File
: System
.Address
; Line
: Integer) is
1049 Raise_Constraint_Error_Msg
(File
, Line
, Rmsg_12
'Address);
1052 procedure Rcheck_13
(File
: System
.Address
; Line
: Integer) is
1054 Raise_Constraint_Error_Msg
(File
, Line
, Rmsg_13
'Address);
1057 procedure Rcheck_14
(File
: System
.Address
; Line
: Integer) is
1059 Raise_Program_Error_Msg
(File
, Line
, Rmsg_14
'Address);
1062 procedure Rcheck_15
(File
: System
.Address
; Line
: Integer) is
1064 Raise_Program_Error_Msg
(File
, Line
, Rmsg_15
'Address);
1067 procedure Rcheck_16
(File
: System
.Address
; Line
: Integer) is
1069 Raise_Program_Error_Msg
(File
, Line
, Rmsg_16
'Address);
1072 procedure Rcheck_17
(File
: System
.Address
; Line
: Integer) is
1074 Raise_Program_Error_Msg
(File
, Line
, Rmsg_17
'Address);
1077 procedure Rcheck_18
(File
: System
.Address
; Line
: Integer) is
1079 Raise_Program_Error_Msg
(File
, Line
, Rmsg_18
'Address);
1082 procedure Rcheck_19
(File
: System
.Address
; Line
: Integer) is
1084 Raise_Program_Error_Msg
(File
, Line
, Rmsg_19
'Address);
1087 procedure Rcheck_20
(File
: System
.Address
; Line
: Integer) is
1089 Raise_Program_Error_Msg
(File
, Line
, Rmsg_20
'Address);
1092 procedure Rcheck_21
(File
: System
.Address
; Line
: Integer) is
1094 Raise_Program_Error_Msg
(File
, Line
, Rmsg_21
'Address);
1097 procedure Rcheck_22
(File
: System
.Address
; Line
: Integer) is
1099 Raise_Program_Error_Msg
(File
, Line
, Rmsg_22
'Address);
1102 procedure Rcheck_23
(File
: System
.Address
; Line
: Integer) is
1104 Raise_Program_Error_Msg
(File
, Line
, Rmsg_23
'Address);
1107 procedure Rcheck_24
(File
: System
.Address
; Line
: Integer) is
1109 Raise_Program_Error_Msg
(File
, Line
, Rmsg_24
'Address);
1112 procedure Rcheck_25
(File
: System
.Address
; Line
: Integer) is
1114 Raise_Program_Error_Msg
(File
, Line
, Rmsg_25
'Address);
1117 procedure Rcheck_26
(File
: System
.Address
; Line
: Integer) is
1119 Raise_Program_Error_Msg
(File
, Line
, Rmsg_26
'Address);
1122 procedure Rcheck_27
(File
: System
.Address
; Line
: Integer) is
1124 Raise_Program_Error_Msg
(File
, Line
, Rmsg_27
'Address);
1127 procedure Rcheck_28
(File
: System
.Address
; Line
: Integer) is
1129 Raise_Program_Error_Msg
(File
, Line
, Rmsg_28
'Address);
1132 procedure Rcheck_29
(File
: System
.Address
; Line
: Integer) is
1134 Raise_Program_Error_Msg
(File
, Line
, Rmsg_29
'Address);
1137 procedure Rcheck_30
(File
: System
.Address
; Line
: Integer) is
1139 Raise_Storage_Error_Msg
(File
, Line
, Rmsg_30
'Address);
1142 procedure Rcheck_31
(File
: System
.Address
; Line
: Integer) is
1144 Raise_Storage_Error_Msg
(File
, Line
, Rmsg_31
'Address);
1147 procedure Rcheck_32
(File
: System
.Address
; Line
: Integer) is
1149 Raise_Storage_Error_Msg
(File
, Line
, Rmsg_32
'Address);
1152 procedure Rcheck_33
(File
: System
.Address
; Line
: Integer) is
1154 Raise_Storage_Error_Msg
(File
, Line
, Rmsg_33
'Address);
1161 procedure Reraise
is
1162 Excep
: constant EOA
:= Get_Current_Excep
.all;
1166 Raise_Current_Excep
(Excep
.Id
);
1169 ------------------------
1170 -- Reraise_Occurrence --
1171 ------------------------
1173 procedure Reraise_Occurrence
(X
: Exception_Occurrence
) is
1175 if X
.Id
/= null then
1177 Save_Occurrence_No_Private
(Get_Current_Excep
.all.all, X
);
1178 Raise_Current_Excep
(X
.Id
);
1180 end Reraise_Occurrence
;
1182 -------------------------------
1183 -- Reraise_Occurrence_Always --
1184 -------------------------------
1186 procedure Reraise_Occurrence_Always
(X
: Exception_Occurrence
) is
1189 Save_Occurrence_No_Private
(Get_Current_Excep
.all.all, X
);
1190 Raise_Current_Excep
(X
.Id
);
1191 end Reraise_Occurrence_Always
;
1193 ---------------------------------
1194 -- Reraise_Occurrence_No_Defer --
1195 ---------------------------------
1197 procedure Reraise_Occurrence_No_Defer
(X
: Exception_Occurrence
) is
1199 Save_Occurrence_No_Private
(Get_Current_Excep
.all.all, X
);
1200 Raise_Current_Excep
(X
.Id
);
1201 end Reraise_Occurrence_No_Defer
;
1203 ---------------------
1204 -- Save_Occurrence --
1205 ---------------------
1207 procedure Save_Occurrence
1208 (Target
: out Exception_Occurrence
;
1209 Source
: Exception_Occurrence
)
1212 Save_Occurrence_No_Private
(Target
, Source
);
1213 end Save_Occurrence
;
1215 function Save_Occurrence
(Source
: Exception_Occurrence
) return EOA
is
1216 Target
: constant EOA
:= new Exception_Occurrence
;
1218 Save_Occurrence
(Target
.all, Source
);
1220 end Save_Occurrence
;
1222 --------------------------------
1223 -- Save_Occurrence_No_Private --
1224 --------------------------------
1226 procedure Save_Occurrence_No_Private
1227 (Target
: out Exception_Occurrence
;
1228 Source
: Exception_Occurrence
)
1231 Target
.Id
:= Source
.Id
;
1232 Target
.Msg_Length
:= Source
.Msg_Length
;
1233 Target
.Num_Tracebacks
:= Source
.Num_Tracebacks
;
1234 Target
.Pid
:= Source
.Pid
;
1235 Target
.Cleanup_Flag
:= Source
.Cleanup_Flag
;
1237 Target
.Msg
(1 .. Target
.Msg_Length
) :=
1238 Source
.Msg
(1 .. Target
.Msg_Length
);
1240 Target
.Tracebacks
(1 .. Target
.Num_Tracebacks
) :=
1241 Source
.Tracebacks
(1 .. Target
.Num_Tracebacks
);
1242 end Save_Occurrence_No_Private
;
1244 -------------------------
1245 -- Transfer_Occurrence --
1246 -------------------------
1248 procedure Transfer_Occurrence
1249 (Target
: Exception_Occurrence_Access
;
1250 Source
: Exception_Occurrence
)
1253 -- Setup Target as an exception to be propagated in the calling task
1254 -- (rendezvous-wise), taking care not to clobber the associated private
1255 -- data. Target is expected to be a pointer to the calling task's fixed
1256 -- TSD occurrence, which is very different from Get_Current_Excep here
1257 -- because this subprogram is called from the called task.
1259 Save_Occurrence_No_Private
(Target
.all, Source
);
1260 end Transfer_Occurrence
;
1266 function String_To_EId
(S
: String) return Exception_Id
1267 renames Stream_Attributes
.String_To_EId
;
1273 function String_To_EO
(S
: String) return Exception_Occurrence
1274 renames Stream_Attributes
.String_To_EO
;
1276 ------------------------------
1277 -- Raise_Exception_No_Defer --
1278 ------------------------------
1280 procedure Raise_Exception_No_Defer
1282 Message
: String := "")
1285 Exception_Data
.Set_Exception_Msg
(E
, Message
);
1287 -- Do not call Abort_Defer.all, as specified by the spec
1289 Raise_Current_Excep
(E
);
1290 end Raise_Exception_No_Defer
;
1296 procedure To_Stderr
(C
: Character) is
1297 type int
is new Integer;
1299 procedure put_char_stderr
(C
: int
);
1300 pragma Import
(C
, put_char_stderr
, "put_char_stderr");
1303 put_char_stderr
(Character'Pos (C
));
1306 procedure To_Stderr
(S
: String) is
1308 for J
in S
'Range loop
1309 if S
(J
) /= ASCII
.CR
then