objc/
[official-gcc.git] / gcc / ada / a-exexpr.adb
blob8cccf1699e9f111a7ca3b117b11c9aa6fb9e2e18
1 ------------------------------------------------------------------------------
2 -- --
3 -- GNAT COMPILER COMPONENTS --
4 -- --
5 -- A D A . E X C E P T I O N S . E X C E P T I O N _ P R O P A G A T I O N --
6 -- --
7 -- B o d y --
8 -- --
9 -- Copyright (C) 1992-2004 Free Software Foundation, Inc. --
10 -- --
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 2, 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. See the GNU General Public License --
17 -- for more details. You should have received a copy of the GNU General --
18 -- Public License distributed with GNAT; see file COPYING. If not, write --
19 -- to the Free Software Foundation, 51 Franklin Street, Fifth Floor, --
20 -- Boston, MA 02110-1301, USA. --
21 -- --
22 -- As a special exception, if other files instantiate generics from this --
23 -- unit, or you link this unit with other files to produce an executable, --
24 -- this unit does not by itself cause the resulting executable to be --
25 -- covered by the GNU General Public License. This exception does not --
26 -- however invalidate any other reasons why the executable file might be --
27 -- covered by the GNU Public License. --
28 -- --
29 -- GNAT was originally developed by the GNAT team at New York University. --
30 -- Extensive contributions were provided by Ada Core Technologies Inc. --
31 -- --
32 ------------------------------------------------------------------------------
34 with Interfaces;
36 with Ada.Unchecked_Conversion;
37 with Ada.Unchecked_Deallocation;
39 with System.Storage_Elements; use System.Storage_Elements;
41 pragma Warnings (Off);
42 -- Since several constructs give warnings in 3.14a1, including unreferenced
43 -- variables and pragma Unreferenced itself.
45 separate (Ada.Exceptions)
46 package body Exception_Propagation is
48 ------------------------------------------------
49 -- Entities to interface with the GCC runtime --
50 ------------------------------------------------
52 -- These come from "C++ ABI for Itanium: Exception handling", which is
53 -- the reference for GCC. They are used only when we are relying on
54 -- back-end tables for exception propagation, which in turn is currenly
55 -- only the case for Zero_Cost_Exceptions in GNAT5.
57 -- Return codes from the GCC runtime functions used to propagate
58 -- an exception.
60 type Unwind_Reason_Code is
61 (URC_NO_REASON,
62 URC_FOREIGN_EXCEPTION_CAUGHT,
63 URC_PHASE2_ERROR,
64 URC_PHASE1_ERROR,
65 URC_NORMAL_STOP,
66 URC_END_OF_STACK,
67 URC_HANDLER_FOUND,
68 URC_INSTALL_CONTEXT,
69 URC_CONTINUE_UNWIND);
71 pragma Unreferenced
72 (URC_FOREIGN_EXCEPTION_CAUGHT,
73 URC_PHASE2_ERROR,
74 URC_PHASE1_ERROR,
75 URC_NORMAL_STOP,
76 URC_END_OF_STACK,
77 URC_HANDLER_FOUND,
78 URC_INSTALL_CONTEXT,
79 URC_CONTINUE_UNWIND);
81 pragma Convention (C, Unwind_Reason_Code);
83 -- Phase identifiers
85 type Unwind_Action is
86 (UA_SEARCH_PHASE,
87 UA_CLEANUP_PHASE,
88 UA_HANDLER_FRAME,
89 UA_FORCE_UNWIND);
91 for Unwind_Action use
92 (UA_SEARCH_PHASE => 1,
93 UA_CLEANUP_PHASE => 2,
94 UA_HANDLER_FRAME => 4,
95 UA_FORCE_UNWIND => 8);
97 pragma Convention (C, Unwind_Action);
99 -- Mandatory common header for any exception object handled by the
100 -- GCC unwinding runtime.
102 subtype Exception_Class is Interfaces.Unsigned_64;
104 GNAT_Exception_Class : constant Exception_Class := 16#474e552d41646100#;
105 -- "GNU-Ada\0"
107 type Unwind_Word is mod 2 ** System.Word_Size;
108 for Unwind_Word'Size use System.Word_Size;
109 -- Map the corresponding C type used in Unwind_Exception below
111 type Unwind_Exception is record
112 Class : Exception_Class := GNAT_Exception_Class;
113 Cleanup : System.Address := System.Null_Address;
114 Private1 : Unwind_Word;
115 Private2 : Unwind_Word;
116 end record;
117 -- Map the GCC struct used for exception handling
119 for Unwind_Exception'Alignment use Standard'Maximum_Alignment;
120 -- The C++ ABI mandates the common exception header to be at least
121 -- doubleword aligned, and the libGCC implementation actually makes it
122 -- maximally aligned (see unwind.h). See additional comments on the
123 -- alignment below.
125 --------------------------------------------------------------
126 -- GNAT Specific Entities To Deal With The GCC EH Circuitry --
127 --------------------------------------------------------------
129 -- A GNAT exception object to be dealt with by the personality routine
130 -- called by the GCC unwinding runtime.
132 type GNAT_GCC_Exception is record
133 Header : Unwind_Exception;
134 -- ABI Exception header first
136 Id : Exception_Id;
137 -- GNAT Exception identifier. This is filled by Propagate_Exception
138 -- and then used by the personality routine to determine if the context
139 -- it examines contains a handler for the exception beeing propagated.
141 N_Cleanups_To_Trigger : Integer;
142 -- Number of cleanup only frames encountered in SEARCH phase. This is
143 -- initialized to 0 by Propagate_Exception and maintained by the
144 -- personality routine to control a forced unwinding phase triggering
145 -- all the cleanups before calling Unhandled_Exception_Terminate when
146 -- an exception is not handled.
148 Next_Exception : EOA;
149 -- Used to create a linked list of exception occurrences
150 end record;
152 pragma Convention (C, GNAT_GCC_Exception);
154 -- There is a subtle issue with the common header alignment, since the C
155 -- version is aligned on BIGGEST_ALIGNMENT, the Ada version is aligned on
156 -- Standard'Maximum_Alignment, and those two values don't quite represent
157 -- the same concepts and so may be decoupled someday. One typical reason
158 -- is that BIGGEST_ALIGNMENT may be larger than what the underlying system
159 -- allocator guarantees, and there are extra costs involved in allocating
160 -- objects aligned to such factors.
162 -- To deal with the potential alignment differences between the C and Ada
163 -- representations, the Ada part of the whole structure is only accessed
164 -- by the personality routine through the accessors declared below. Ada
165 -- specific fields are thus always accessed through consistent layout, and
166 -- we expect the actual alignment to always be large enough to avoid traps
167 -- from the C accesses to the common header. Besides, accessors aleviate
168 -- the need for a C struct whole conterpart, both painful and errorprone
169 -- to maintain anyway.
171 type GNAT_GCC_Exception_Access is access all GNAT_GCC_Exception;
173 function To_GNAT_GCC_Exception is new
174 Unchecked_Conversion (System.Address, GNAT_GCC_Exception_Access);
176 procedure Free is new Unchecked_Deallocation
177 (GNAT_GCC_Exception, GNAT_GCC_Exception_Access);
179 procedure Free is new Unchecked_Deallocation
180 (Exception_Occurrence, EOA);
182 function CleanupUnwind_Handler
183 (UW_Version : Integer;
184 UW_Phases : Unwind_Action;
185 UW_Eclass : Exception_Class;
186 UW_Exception : access GNAT_GCC_Exception;
187 UW_Context : System.Address;
188 UW_Argument : System.Address) return Unwind_Reason_Code;
189 -- Hook called at each step of the forced unwinding we perform to
190 -- trigger cleanups found during the propagation of an unhandled
191 -- exception.
193 -- GCC runtime functions used. These are C non-void functions, actually,
194 -- but we ignore the return values. See raise.c as to why we are using
195 -- __gnat stubs for these.
197 procedure Unwind_RaiseException
198 (UW_Exception : access GNAT_GCC_Exception);
199 pragma Import (C, Unwind_RaiseException, "__gnat_Unwind_RaiseException");
201 procedure Unwind_ForcedUnwind
202 (UW_Exception : access GNAT_GCC_Exception;
203 UW_Handler : System.Address;
204 UW_Argument : System.Address);
205 pragma Import (C, Unwind_ForcedUnwind, "__gnat_Unwind_ForcedUnwind");
207 ------------------------------------------------------------------
208 -- Occurrence Stack Management Facilities for the GCC-EH Scheme --
209 ------------------------------------------------------------------
211 function Remove
212 (Top : EOA;
213 Excep : GNAT_GCC_Exception_Access) return Boolean;
214 -- Remove Excep from the stack starting at Top.
215 -- Return True if Excep was found and removed, false otherwise.
217 -- Hooks called when entering/leaving an exception handler for a given
218 -- occurrence, aimed at handling the stack of active occurrences. The
219 -- calls are generated by gigi in tree_transform/N_Exception_Handler.
221 procedure Begin_Handler (GCC_Exception : GNAT_GCC_Exception_Access);
222 pragma Export (C, Begin_Handler, "__gnat_begin_handler");
224 procedure End_Handler (GCC_Exception : GNAT_GCC_Exception_Access);
225 pragma Export (C, End_Handler, "__gnat_end_handler");
227 Setup_Key : constant := 16#DEAD#;
228 -- To handle the case of a task "transferring" an exception occurrence to
229 -- another task, for instance via Exceptional_Complete_Rendezvous, we need
230 -- to be able to identify occurrences which have been Setup and not yet
231 -- Propagated. We hijack one of the common header fields for that purpose,
232 -- setting it to a special key value during the setup process, clearing it
233 -- at the very beginning of the propagation phase, and expecting it never
234 -- to be reset to the special value later on. A 16-bit value is used rather
235 -- than a 32-bit value for static compatibility with 16-bit targets such as
236 -- AAMP (where type Unwind_Word will be 16 bits).
238 function Is_Setup_And_Not_Propagated (E : EOA) return Boolean;
240 procedure Set_Setup_And_Not_Propagated (E : EOA);
241 procedure Clear_Setup_And_Not_Propagated (E : EOA);
243 ------------------------------------------------------------
244 -- Accessors to basic components of a GNAT exception data --
245 ------------------------------------------------------------
247 -- As of today, these are only used by the C implementation of the
248 -- GCC propagation personality routine to avoid having to rely on a C
249 -- counterpart of the whole exception_data structure, which is both
250 -- painful and error prone. These subprograms could be moved to a
251 -- more widely visible location if need be.
253 function Is_Handled_By_Others (E : Exception_Data_Ptr) return Boolean;
254 pragma Export (C, Is_Handled_By_Others, "__gnat_is_handled_by_others");
256 function Language_For (E : Exception_Data_Ptr) return Character;
257 pragma Export (C, Language_For, "__gnat_language_for");
259 function Import_Code_For (E : Exception_Data_Ptr) return Exception_Code;
260 pragma Export (C, Import_Code_For, "__gnat_import_code_for");
262 function EID_For (GNAT_Exception : GNAT_GCC_Exception_Access)
263 return Exception_Id;
264 pragma Export (C, EID_For, "__gnat_eid_for");
266 procedure Adjust_N_Cleanups_For
267 (GNAT_Exception : GNAT_GCC_Exception_Access;
268 Adjustment : Integer);
269 pragma Export (C, Adjust_N_Cleanups_For, "__gnat_adjust_n_cleanups_for");
271 ---------------------------------------------------------------------------
272 -- Objects to materialize "others" and "all others" in the GCC EH tables --
273 ---------------------------------------------------------------------------
275 -- Currently, these only have their address taken and compared so there is
276 -- no real point having whole exception data blocks allocated. In any case
277 -- the types should match what gigi and the personality routine expect.
278 -- The initial value is an arbitrary value that will not exceed the range
279 -- of Integer on 16-bit targets (such as AAMP).
281 Others_Value : constant Integer := 16#7FFF#;
282 pragma Export (C, Others_Value, "__gnat_others_value");
284 All_Others_Value : constant Integer := 16#7FFF#;
285 pragma Export (C, All_Others_Value, "__gnat_all_others_value");
287 ------------
288 -- Remove --
289 ------------
291 function Remove
292 (Top : EOA;
293 Excep : GNAT_GCC_Exception_Access) return Boolean
295 Prev : GNAT_GCC_Exception_Access := null;
296 Iter : EOA := Top;
297 GCC_Exception : GNAT_GCC_Exception_Access;
299 begin
300 -- Pop stack
302 loop
303 pragma Assert (Iter.Private_Data /= System.Null_Address);
305 GCC_Exception := To_GNAT_GCC_Exception (Iter.Private_Data);
307 if GCC_Exception = Excep then
308 if Prev = null then
310 -- Special case for the top of the stack: shift the contents
311 -- of the next item to the top, since top is at a fixed
312 -- location and can't be changed.
314 Iter := GCC_Exception.Next_Exception;
316 if Iter = null then
318 -- Stack is now empty
320 Top.Private_Data := System.Null_Address;
322 else
323 Save_Occurrence_And_Private (Top.all, Iter.all);
324 Free (Iter);
325 end if;
327 else
328 Prev.Next_Exception := GCC_Exception.Next_Exception;
329 Free (Iter);
330 end if;
332 Free (GCC_Exception);
334 return True;
335 end if;
337 exit when GCC_Exception.Next_Exception = null;
339 Prev := GCC_Exception;
340 Iter := GCC_Exception.Next_Exception;
341 end loop;
343 return False;
344 end Remove;
346 ---------------------------
347 -- CleanupUnwind_Handler --
348 ---------------------------
350 function CleanupUnwind_Handler
351 (UW_Version : Integer;
352 UW_Phases : Unwind_Action;
353 UW_Eclass : Exception_Class;
354 UW_Exception : access GNAT_GCC_Exception;
355 UW_Context : System.Address;
356 UW_Argument : System.Address) return Unwind_Reason_Code
358 begin
359 -- Terminate as soon as we know there is nothing more to run. The
360 -- count is maintained by the personality routine.
362 if UW_Exception.N_Cleanups_To_Trigger = 0 then
363 Unhandled_Exception_Terminate;
364 end if;
366 -- We know there is at least one cleanup further up. Return so that it
367 -- is searched and entered, after which Unwind_Resume will be called
368 -- and this hook will gain control (with an updated count) again.
370 return URC_NO_REASON;
371 end CleanupUnwind_Handler;
373 ---------------------------------
374 -- Is_Setup_And_Not_Propagated --
375 ---------------------------------
377 function Is_Setup_And_Not_Propagated (E : EOA) return Boolean is
378 GCC_E : GNAT_GCC_Exception_Access :=
379 To_GNAT_GCC_Exception (E.Private_Data);
380 begin
381 return GCC_E /= null and then GCC_E.Header.Private1 = Setup_Key;
382 end Is_Setup_And_Not_Propagated;
384 ------------------------------------
385 -- Clear_Setup_And_Not_Propagated --
386 ------------------------------------
388 procedure Clear_Setup_And_Not_Propagated (E : EOA) is
389 GCC_E : GNAT_GCC_Exception_Access :=
390 To_GNAT_GCC_Exception (E.Private_Data);
391 begin
392 pragma Assert (GCC_E /= null);
393 GCC_E.Header.Private1 := 0;
394 end Clear_Setup_And_Not_Propagated;
396 ----------------------------------
397 -- Set_Setup_And_Not_Propagated --
398 ----------------------------------
400 procedure Set_Setup_And_Not_Propagated (E : EOA) is
401 GCC_E : GNAT_GCC_Exception_Access :=
402 To_GNAT_GCC_Exception (E.Private_Data);
403 begin
404 pragma Assert (GCC_E /= null);
405 GCC_E.Header.Private1 := Setup_Key;
406 end Set_Setup_And_Not_Propagated;
408 ---------------------
409 -- Setup_Exception --
410 ---------------------
412 -- In the GCC-EH implementation of the propagation scheme, this
413 -- subprogram should be understood as : Setup the exception occurrence
414 -- stack headed at Current for a forthcoming raise of Excep.
416 -- In the GNAT-SJLJ case this "stack" only exists implicitely, by way of
417 -- local occurrence declarations together with save/restore operations
418 -- generated by the front-end, and this routine has nothing to do.
420 -- The differenciation is done here and not in the callers to avoid having
421 -- to spread out the test in numerous places.
423 procedure Setup_Exception
424 (Excep : EOA;
425 Current : EOA;
426 Reraised : Boolean := False)
428 Top : constant EOA := Current;
429 Next : EOA;
430 GCC_Exception : GNAT_GCC_Exception_Access;
432 begin
433 -- Just return if we're not in the GCC-EH case. What is otherwise
434 -- performed is useless and even harmful since it potentially involves
435 -- dynamic allocations that would never be released, and participates
436 -- in the Setup_And_Not_Propagated predicate management, only properly
437 -- handled by the rest of the GCC-EH scheme.
439 if Zero_Cost_Exceptions = 0 then
440 return;
441 end if;
443 -- Otherwise, the exception Excep is soon to be propagated, and the
444 -- storage used for that will be the occurrence statically allocated
445 -- for the current thread. This storage might currently be used for a
446 -- still active occurrence, so we need to push it on the thread's
447 -- occurrence stack (headed at that static occurrence) before it gets
448 -- clobbered.
450 -- What we do here is to trigger this push when need be, and allocate a
451 -- Private_Data block for the forthcoming Propagation.
453 -- Some tasking rendez-vous attempts lead to an occurrence transfer
454 -- from the server to the client (see Exceptional_Complete_Rendezvous).
455 -- In those cases Setup is called twice for the very same occurrence
456 -- before it gets propagated: once from the server, because this is
457 -- where the occurrence contents is elaborated and known, and then
458 -- once from the client when it detects the case and actually raises
459 -- the exception in its own context.
461 -- The Is_Setup_And_Not_Propagated predicate tells us when we are in
462 -- the second call to Setup for a Transferred occurrence, and there is
463 -- nothing to be done here in this situation. This predicate cannot be
464 -- True if we are dealing with a Reraise, and we may even be called
465 -- with a raw uninitialized Excep occurrence in this case so we should
466 -- not check anyway. Observe the front-end expansion for a "raise;" to
467 -- see that happening. We get a local occurrence and a direct call to
468 -- Save_Occurrence without the intermediate init-proc call.
470 if not Reraised and then Is_Setup_And_Not_Propagated (Excep) then
471 return;
472 end if;
474 -- Allocate what will be the Private_Data block for the exception
475 -- to be propagated.
477 GCC_Exception := new GNAT_GCC_Exception;
479 -- If the Top of the occurrence stack is not currently used for an
480 -- active exception (the stack is empty) we just need to setup the
481 -- Private_Data pointer.
483 -- Otherwise, we also need to shift the contents of the Top of the
484 -- stack in a freshly allocated entry and link everything together.
486 if Top.Private_Data /= System.Null_Address then
487 Next := new Exception_Occurrence;
488 Save_Occurrence_And_Private (Next.all, Top.all);
490 GCC_Exception.Next_Exception := Next;
491 Top.Private_Data := GCC_Exception.all'Address;
492 end if;
494 Top.Private_Data := GCC_Exception.all'Address;
496 Set_Setup_And_Not_Propagated (Top);
497 end Setup_Exception;
499 -------------------
500 -- Begin_Handler --
501 -------------------
503 procedure Begin_Handler (GCC_Exception : GNAT_GCC_Exception_Access) is
504 begin
505 -- Every necessary operation related to the occurrence stack has
506 -- already been performed by Propagate_Exception. This hook remains for
507 -- potential future necessity in optimizing the overall scheme, as well
508 -- a useful debugging tool.
510 null;
511 end Begin_Handler;
513 -----------------
514 -- End_Handler --
515 -----------------
517 procedure End_Handler (GCC_Exception : GNAT_GCC_Exception_Access) is
518 Removed : Boolean;
519 begin
520 Removed := Remove (Get_Current_Excep.all, GCC_Exception);
521 pragma Assert (Removed);
522 end End_Handler;
524 -------------------------
525 -- Propagate_Exception --
526 -------------------------
528 -- Build an object suitable for the libgcc processing and call
529 -- Unwind_RaiseException to actually throw, taking care of handling
530 -- the two phase scheme it implements.
532 procedure Propagate_Exception (From_Signal_Handler : Boolean) is
533 Excep : EOA := Get_Current_Excep.all;
534 GCC_Exception : GNAT_GCC_Exception_Access;
536 begin
537 pragma Assert (Excep.Private_Data /= System.Null_Address);
539 -- Retrieve the Private_Data for this occurrence and set the useful
540 -- flags for the personality routine, which will be called for each
541 -- frame via Unwind_RaiseException below.
543 GCC_Exception := To_GNAT_GCC_Exception (Excep.Private_Data);
545 Clear_Setup_And_Not_Propagated (Excep);
547 GCC_Exception.Id := Excep.Id;
548 GCC_Exception.N_Cleanups_To_Trigger := 0;
550 -- Compute the backtrace for this occurrence if the corresponding
551 -- binder option has been set. Call_Chain takes care of the reraise
552 -- case.
554 -- ??? Using Call_Chain here means we are going to walk up the stack
555 -- once only for backtracing purposes before doing it again for the
556 -- propagation per se.
558 -- The first inspection is much lighter, though, as it only requires
559 -- partial unwinding of each frame. Additionally, although we could use
560 -- the personality routine to record the addresses while propagating,
561 -- this method has two drawbacks:
563 -- 1) the trace is incomplete if the exception is handled since we
564 -- don't walk past the frame with the handler,
566 -- and
568 -- 2) we would miss the frames for which our personality routine is not
569 -- called, e.g. if C or C++ calls are on the way.
571 Call_Chain (Excep);
573 -- Perform a standard raise first. If a regular handler is found, it
574 -- will be entered after all the intermediate cleanups have run. If
575 -- there is no regular handler, control will get back to after the
576 -- call, with N_Cleanups_To_Trigger set to the number of frames with
577 -- cleanups found on the way up, and none of these already run.
579 Unwind_RaiseException (GCC_Exception);
581 -- If we get here we know the exception is not handled, as otherwise
582 -- Unwind_RaiseException arranges for the handler to be entered. Take
583 -- the necessary steps to enable the debugger to gain control while the
584 -- stack is still intact.
586 Notify_Unhandled_Exception;
588 -- Now, if cleanups have been found, run a forced unwind to trigger
589 -- them. Control should not resume there, as the unwinding hook calls
590 -- Unhandled_Exception_Terminate as soon as the last cleanup has been
591 -- triggered.
593 if GCC_Exception.N_Cleanups_To_Trigger /= 0 then
594 Unwind_ForcedUnwind (GCC_Exception,
595 CleanupUnwind_Handler'Address,
596 System.Null_Address);
597 end if;
599 -- We get here when there is no handler or cleanup to be run at
600 -- all. The debugger has been notified before the second step above.
602 Unhandled_Exception_Terminate;
603 end Propagate_Exception;
605 ---------------------------
606 -- Adjust_N_Cleanups_For --
607 ---------------------------
609 procedure Adjust_N_Cleanups_For
610 (GNAT_Exception : GNAT_GCC_Exception_Access;
611 Adjustment : Integer)
613 begin
614 GNAT_Exception.N_Cleanups_To_Trigger :=
615 GNAT_Exception.N_Cleanups_To_Trigger + Adjustment;
616 end Adjust_N_Cleanups_For;
618 -------------
619 -- EID_For --
620 -------------
622 function EID_For
623 (GNAT_Exception : GNAT_GCC_Exception_Access) return Exception_Id
625 begin
626 return GNAT_Exception.Id;
627 end EID_For;
629 ---------------------
630 -- Import_Code_For --
631 ---------------------
633 function Import_Code_For
634 (E : SSL.Exception_Data_Ptr) return Exception_Code
636 begin
637 return E.all.Import_Code;
638 end Import_Code_For;
640 --------------------------
641 -- Is_Handled_By_Others --
642 --------------------------
644 function Is_Handled_By_Others
645 (E : SSL.Exception_Data_Ptr) return Boolean
647 begin
648 return not E.all.Not_Handled_By_Others;
649 end Is_Handled_By_Others;
651 ------------------
652 -- Language_For --
653 ------------------
655 function Language_For
656 (E : SSL.Exception_Data_Ptr) return Character
658 begin
659 return E.all.Lang;
660 end Language_For;
662 -----------
663 -- Notes --
664 -----------
666 -- The current model implemented for the stack of occurrences is a
667 -- simplification of previous attempts, which all prooved to be flawed or
668 -- would have needed significant additional circuitry to be made to work
669 -- correctly.
671 -- We now represent every propagation by a new entry on the stack, which
672 -- means that an exception occurrence may appear more than once (e.g. when
673 -- it is reraised during the course of its own handler).
675 -- This may seem overcostly compared to the C++ model as implemented in
676 -- the g++ v3 libstd. This is actually understandable when one considers
677 -- the extra variations of possible run-time configurations induced by the
678 -- freedom offered by the Save_Occurrence/Reraise_Occurrence public
679 -- interface.
681 -- The basic point is that arranging for an occurrence to always appear at
682 -- most once on the stack requires a way to determine if a given occurence
683 -- is already there, which is not as easy as it might seem.
685 -- An attempt was made to use the Private_Data pointer for this purpose.
686 -- It did not work because:
688 -- 1) The Private_Data has to be saved by Save_Occurrence to be usable
689 -- as a key in case of a later reraise,
691 -- 2) There is no easy way to synchronize End_Handler for an occurrence
692 -- and the data attached to potential copies, so these copies may end
693 -- up pointing to stale data. Moreover ...
695 -- 3) The same address may be reused for different occurrences, which
696 -- defeats the idea of using it as a key.
698 -- The example below illustrates:
700 -- Saved_CE : Exception_Occurrence;
702 -- begin
703 -- raise Constraint_Error;
704 -- exception
705 -- when CE: others =>
706 -- Save_Occurrence (Saved_CE, CE); <= Saved_CE.PDA = CE.PDA
707 -- end;
709 -- <= Saved_CE.PDA is stale (!)
711 -- begin
712 -- raise Program_Error; <= Saved_CE.PDA = PE.PDA (!!)
713 -- exception
714 -- when others =>
715 -- Reraise_Occurrence (Saved_CE);
716 -- end;
718 -- Not releasing the Private_Data via End_Handler could be an option,
719 -- but making this to work while still avoiding memory leaks is far
720 -- from trivial.
722 -- The current scheme has the advantage of beeing simple, and induces
723 -- extra costs only in reraise cases which is acceptable.
725 end Exception_Propagation;