OSDN Git Service

2003-12-11 Ed Falis <falis@gnat.com>
[pf3gnuchains/gcc-fork.git] / gcc / ada / raise.c
1 /****************************************************************************
2  *                                                                          *
3  *                         GNAT COMPILER COMPONENTS                         *
4  *                                                                          *
5  *                                R A I S E                                 *
6  *                                                                          *
7  *                          C Implementation File                           *
8  *                                                                          *
9  *             Copyright (C) 1992-2003, 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,  59 Temple Place - Suite 330,  Boston, *
20  * MA 02111-1307, USA.                                                      *
21  *                                                                          *
22  * As a  special  exception,  if you  link  this file  with other  files to *
23  * produce an executable,  this file does not by itself cause the resulting *
24  * executable to be covered by the GNU General Public License. This except- *
25  * ion does not  however invalidate  any other reasons  why the  executable *
26  * file might be covered by the  GNU Public License.                        *
27  *                                                                          *
28  * GNAT was originally developed  by the GNAT team at  New York University. *
29  * Extensive contributions were provided by Ada Core Technologies Inc.      *
30  *                                                                          *
31  ****************************************************************************/
32
33 /* Routines to support runtime exception handling */
34
35 #ifdef IN_RTS
36 #include "tconfig.h"
37 /* In the top-of-tree GCC, tconfig does not include tm.h, but in GCC 3.2
38    it does.  To avoid branching raise.c just for that purpose, we kludge by
39    looking for a symbol always defined by tm.h and if it's not defined,
40    we include it.  */
41 #ifndef FIRST_PSEUDO_REGISTER
42 #include "coretypes.h"
43 #include "tm.h"
44 #endif
45 #include "tsystem.h"
46 #include <sys/stat.h>
47 typedef char bool;
48 # define true 1
49 # define false 0
50 #else
51 #include "config.h"
52 #include "system.h"
53 #endif
54
55 #include "adaint.h"
56 #include "raise.h"
57
58 /*  We have not yet figured out how to import this directly */
59
60 void
61 _gnat_builtin_longjmp (void *ptr, int flag ATTRIBUTE_UNUSED)
62 {
63    __builtin_longjmp (ptr, 1);
64 }
65
66 /* When an exception is raised for which no handler exists, the procedure
67    Ada.Exceptions.Unhandled_Exception is called, which performs the call to
68    adafinal to complete finalization, and then prints out the error messages
69    for the unhandled exception. The final step is to call this routine, which
70    performs any system dependent cleanup required.  */
71
72 void
73 __gnat_unhandled_terminate (void)
74 {
75   /* Special termination handling for VMS */
76
77 #ifdef VMS
78     {
79       long prvhnd;
80
81       /* Remove the exception vector so it won't intercept any errors
82          in the call to exit, and go into and endless loop */
83
84       SYS$SETEXV (1, 0, 3, &prvhnd);
85       __gnat_os_exit (1);
86     }
87
88 /* Termination handling for all other systems. */
89
90 #elif !defined (__RT__)
91     __gnat_os_exit (1);
92 #endif
93 }
94
95 /* Below is the code related to the integration of the GCC mechanism for
96    exception handling.  */
97
98 #include "unwind.h"
99
100 /* The names of a couple of "standard" routines for unwinding/propagation
101    actually vary depending on the underlying GCC scheme for exception handling
102    (SJLJ or DWARF). We need a consistently named interface to import from
103    a-except, so stubs are defined here.  */
104
105 typedef struct _Unwind_Context _Unwind_Context;
106 typedef struct _Unwind_Exception _Unwind_Exception;
107
108 _Unwind_Reason_Code
109 __gnat_Unwind_RaiseException (_Unwind_Exception *);
110
111 _Unwind_Reason_Code
112 __gnat_Unwind_ForcedUnwind (_Unwind_Exception *, void *, void *);
113
114
115 #ifdef IN_RTS   /* For eh personality routine */
116
117 #include "dwarf2.h"
118 #include "unwind-dw2-fde.h"
119 #include "unwind-pe.h"
120
121
122 /* --------------------------------------------------------------
123    -- The DB stuff below is there for debugging purposes only. --
124    -------------------------------------------------------------- */
125
126 #define DB_PHASES     0x1
127 #define DB_CSITE      0x2
128 #define DB_ACTIONS    0x4
129 #define DB_REGIONS    0x8
130
131 #define DB_ERR        0x1000
132
133 /* The "action" stuff below is also there for debugging purposes only.  */
134
135 typedef struct
136 {
137   _Unwind_Action phase;
138   char * description;
139 } phase_descriptor;
140
141 static phase_descriptor phase_descriptors[]
142   = {{ _UA_SEARCH_PHASE,  "SEARCH_PHASE" },
143      { _UA_CLEANUP_PHASE, "CLEANUP_PHASE" },
144      { _UA_HANDLER_FRAME, "HANDLER_FRAME" },
145      { _UA_FORCE_UNWIND,  "FORCE_UNWIND" },
146      { -1, 0}};
147
148 static int
149 db_accepted_codes (void)
150 {
151   static int accepted_codes = -1;
152
153   if (accepted_codes == -1)
154     {
155       char * db_env = getenv ("EH_DEBUG");
156
157       accepted_codes = db_env ? (atoi (db_env) | DB_ERR) : 0;
158       /* Arranged for ERR stuff to always be visible when the variable
159          is defined. One may just set the variable to 0 to see the ERR
160          stuff only.  */
161     }
162
163   return accepted_codes;
164 }
165
166 #define DB_INDENT_INCREASE 0x01
167 #define DB_INDENT_DECREASE 0x02
168 #define DB_INDENT_OUTPUT   0x04
169 #define DB_INDENT_NEWLINE  0x08
170 #define DB_INDENT_RESET    0x10
171
172 #define DB_INDENT_UNIT     8
173
174 static void
175 db_indent (int requests)
176 {
177   static int current_indentation_level = 0;
178
179   if (requests & DB_INDENT_RESET)
180     {
181       current_indentation_level = 0;
182     }
183
184   if (requests & DB_INDENT_INCREASE)
185     {
186       current_indentation_level ++;
187     }
188
189   if (requests & DB_INDENT_DECREASE)
190     {
191       current_indentation_level --;
192     }
193
194   if (requests & DB_INDENT_NEWLINE)
195     {
196       fprintf (stderr, "\n");
197     }
198
199   if (requests & DB_INDENT_OUTPUT)
200     {
201       fprintf (stderr, "%*s",
202                current_indentation_level * DB_INDENT_UNIT, " ");
203     }
204
205 }
206
207 static void
208 db (int db_code, char * msg_format, ...)
209 {
210   if (db_accepted_codes () & db_code)
211     {
212       va_list msg_args;
213
214       db_indent (DB_INDENT_OUTPUT);
215
216       va_start (msg_args, msg_format);
217       vfprintf (stderr, msg_format, msg_args);
218       va_end (msg_args);
219     }
220 }
221
222 static void
223 db_phases (int phases)
224 {
225   phase_descriptor *a = phase_descriptors;
226
227   if (! (db_accepted_codes() & DB_PHASES))
228     return;
229
230   db (DB_PHASES, "\n");
231
232   for (; a->description != 0; a++)
233     if (phases & a->phase)
234       db (DB_PHASES, "%s ", a->description);
235
236   db (DB_PHASES, " :\n");
237 }
238
239
240 /* ---------------------------------------------------------------
241    --  Now come a set of useful structures and helper routines. --
242    --------------------------------------------------------------- */
243
244 /* There are three major runtime tables involved, generated by the
245    GCC back-end. Contents slightly vary depending on the underlying
246    implementation scheme (dwarf zero cost / sjlj).
247
248    =======================================
249    * Tables for the dwarf zero cost case *
250    =======================================
251
252    call_site []
253    -------------------------------------------------------------------
254    * region-start | region-length | landing-pad | first-action-index *
255    -------------------------------------------------------------------
256
257    Identify possible actions to be taken and where to resume control
258    for that when an exception propagates through a pc inside the region
259    delimited by start and length.
260
261    A null landing-pad indicates that nothing is to be done.
262
263    Otherwise, first-action-index provides an entry into the action[]
264    table which heads a list of possible actions to be taken (see below).
265
266    If it is determined that indeed an action should be taken, that
267    is, if one action filter matches the exception beeing propagated,
268    then control should be transfered to landing-pad.
269
270    A null first-action-index indicates that there are only cleanups
271    to run there.
272
273    action []
274    -------------------------------
275    * action-filter | next-action *
276    -------------------------------
277
278    This table contains lists (called action chains) of possible actions
279    associated with call-site entries described in the call-site [] table.
280    There is at most one action list per call-site entry.
281
282    A null action-filter indicates a cleanup.
283
284    Non null action-filters provide an index into the ttypes [] table
285    (see below), from which information may be retrieved to check if it
286    matches the exception beeing propagated.
287
288    action-filter > 0  means there is a regular handler to be run,
289
290    action-filter < 0  means there is a some "exception_specification"
291                       data to retrieve, which is only relevant for C++
292                       and should never show up for Ada.
293
294    next-action indexes the next entry in the list. 0 indicates there is
295    no other entry.
296
297    ttypes []
298    ---------------
299    * ttype-value *
300    ---------------
301
302    A null value indicates a catch-all handler in C++, and an "others"
303    handler in Ada.
304
305    Non null values are used to match the exception beeing propagated:
306    In C++ this is a pointer to some rtti data, while in Ada this is an
307    exception id.
308
309    The special id value 1 indicates an "all_others" handler.
310
311    For C++, this table is actually also used to store "exception
312    specification" data. The differentiation between the two kinds
313    of entries is made by the sign of the associated action filter,
314    which translates into positive or negative offsets from the
315    so called base of the table:
316
317    Exception Specification data is stored at positive offsets from
318    the ttypes table base, which Exception Type data is stored at
319    negative offsets:
320
321    ---------------------------------------------------------------------------
322
323    Here is a quick summary of the tables organization:
324
325           +-- Unwind_Context (pc, ...)
326           |
327           |(pc)
328           |
329           |   CALL-SITE[]
330           |
331           |   +=============================================================+
332           |   | region-start + length |  landing-pad   | first-action-index |
333           |   +=============================================================+
334           +-> |       pc range          0 => no-action   0 => cleanups only |
335               |                         !0 => jump @              N --+     |
336               +====================================================== | ====+
337                                                                       |
338                                                                       |
339        ACTION []                                                      |
340                                                                       |
341        +==========================================================+   |
342        |              action-filter           |   next-action     |   |
343        +==========================================================+   |
344        |  0 => cleanup                                            |   |
345        | >0 => ttype index for handler ------+  0 => end of chain | <-+
346        | <0 => ttype index for spec data     |                    |
347        +==================================== | ===================+
348                                              |
349                                              |
350        TTYPES []                             |
351                                              |  Offset negated from
352                  +=====================+     |  the actual base.
353                  |     ttype-value     |     |
354     +============+=====================+     |
355     |            |  0 => "others"      |     |
356     |    ...     |  1 => "all others"  | <---+
357     |            |  X => exception id  |
358     |  handlers  +---------------------+
359     |            |        ...          |
360     |    ...     |        ...          |
361     |            |        ...          |
362     +============+=====================+ <<------ Table base
363     |    ...     |        ...          |
364     |   specs    |        ...          | (should not see negative filter
365     |    ...     |        ...          |  values for Ada).
366     +============+=====================+
367
368
369    ============================
370    * Tables for the sjlj case *
371    ============================
372
373    So called "function contexts" are pushed on a context stack by calls to
374    _Unwind_SjLj_Register on function entry, and popped off at exit points by
375    calls to _Unwind_SjLj_Unregister. The current call_site for a function is
376    updated in the function context as the function's code runs along.
377
378    The generic unwinding engine in _Unwind_RaiseException walks the function
379    context stack and not the actual call chain.
380
381    The ACTION and TTYPES tables remain unchanged, which allows to search them
382    during the propagation phase to determine wether or not the propagated
383    exception is handled somewhere. When it is, we only "jump" up once directly
384    to the context where the handler will be found. Besides, this allows "break
385    exception unhandled" to work also
386
387    The CALL-SITE table is setup differently, though: the pc attached to the
388    unwind context is a direct index into the table, so the entries in this
389    table do not hold region bounds any more.
390
391    A special index (-1) is used to indicate that no action is possibly
392    connected with the context at hand, so null landing pads cannot appear
393    in the table.
394
395    Additionally, landing pad values in the table do not represent code address
396    to jump at, but so called "dispatch" indices used by a common landing pad
397    for the function to switch to the appropriate post-landing-pad.
398
399    +-- Unwind_Context (pc, ...)
400    |
401    | pc = call-site index
402    |  0 => terminate (should not see this for Ada)
403    | -1 => no-action
404    |
405    |   CALL-SITE[]
406    |
407    |   +=====================================+
408    |   |  landing-pad   | first-action-index |
409    |   +=====================================+
410    +-> |                  0 => cleanups only |
411        | dispatch index             N        |
412        +=====================================+
413
414
415    ===================================
416    * Basic organization of this unit *
417    ===================================
418
419    The major point of this unit is to provide an exception propagation
420    personality routine for Ada. This is __gnat_eh_personality.
421
422    It is provided with a pointer to the propagated exception, an unwind
423    context describing a location the propagation is going through, and a
424    couple of other arguments including a description of the current
425    propagation phase.
426
427    It shall return to the generic propagation engine what is to be performed
428    next, after possible context adjustments, depending on what it finds in the
429    traversed context (a handler for the exception, a cleanup, nothing, ...),
430    and on the propagation phase.
431
432    A number of structures and subroutines are used for this purpose, as
433    sketched below:
434
435    o region_descriptor: General data associated with the context (base pc,
436      call-site table, action table, ttypes table, ...)
437
438    o action_descriptor: Data describing the action to be taken for the
439      propagated exception in the provided context (kind of action: nothing,
440      handler, cleanup; pointer to the action table entry, ...).
441
442    raise
443      |
444     ... (a-except.adb)
445      |
446    Propagate_Exception (a-exexpr.adb)
447      |
448      |
449    _Unwind_RaiseException (libgcc)
450      |
451      |   (Ada frame)
452      |
453      +--> __gnat_eh_personality (context, exception)
454            |
455            +--> get_region_descriptor_for (context)
456            |
457            +--> get_action_descriptor_for (context, exception, region)
458            |       |
459            |       +--> get_call_site_action_for (context, region)
460            |            (one version for each underlying scheme)
461            |
462            +--> setup_to_install (context)
463
464    This unit is inspired from the C++ version found in eh_personality.cc,
465    part of libstdc++-v3.
466
467 */
468
469
470 /* This is the structure of exception objects as built by the GNAT runtime
471    library (a-exexpr.adb). The layouts should exactly match, and the "common"
472    header is mandated by the exception handling ABI.  */
473
474 typedef struct
475 {
476   _Unwind_Exception common;
477   /* ABI header, maximally aligned. */
478
479   _Unwind_Ptr id;
480   /* Id of the exception beeing propagated, filled by Propagate_Exception.
481
482      This is compared against the ttype entries associated with actions in the
483      examined context to see if one of these actions matches.  */
484
485   bool handled_by_others;
486   /* Indicates wether a "when others" may catch this exception, also filled by
487      Propagate_Exception.
488
489      This is used to decide if a GNAT_OTHERS ttype entry matches.  */
490
491   int  n_cleanups_to_trigger;
492   /* Number of cleanups on the propagation way for the occurrence. This is
493      initialized to 0 by Propagate_Exception and computed by the personality
494      routine during the first phase of the propagation (incremented for each
495      context in which only cleanup actions match).
496
497      This is used by Propagate_Exception when the occurrence is not handled,
498      to control a forced unwinding phase aimed at triggering all the cleanups
499      before calling Unhandled_Exception_Terminate.
500
501      This is also used by __gnat_eh_personality to identify the point at which
502      the notification routine shall be called for a handled occurrence.  */
503 } _GNAT_Exception;
504
505 /* The two constants below are specific ttype identifiers for special
506    exception ids. Their value is currently hardcoded at the gigi level
507    (see N_Exception_Handler).  */
508
509 #define GNAT_OTHERS      ((_Unwind_Ptr) 0x0)
510 #define GNAT_ALL_OTHERS  ((_Unwind_Ptr) 0x1)
511
512 /* Describe the useful region data associated with an unwind context.  */
513
514 typedef struct
515 {
516   /* The base pc of the region.  */
517   _Unwind_Ptr base;
518
519   /* Pointer to the Language Specific Data for the region.  */
520   _Unwind_Ptr lsda;
521
522   /* Call-Site data associated with this region.  */
523   unsigned char call_site_encoding;
524   const unsigned char *call_site_table;
525
526   /* The base to which are relative landing pad offsets inside the call-site
527      entries .  */
528   _Unwind_Ptr lp_base;
529
530   /* Action-Table associated with this region.  */
531   const unsigned char *action_table;
532
533   /* Ttype data associated with this region.  */
534   unsigned char ttype_encoding;
535   const unsigned char *ttype_table;
536   _Unwind_Ptr ttype_base;
537
538 } region_descriptor;
539
540 static void
541 db_region_for (region_descriptor *region, _Unwind_Context *uw_context)
542 {
543   _Unwind_Ptr ip = _Unwind_GetIP (uw_context) - 1;
544
545   if (! (db_accepted_codes () & DB_REGIONS))
546     return;
547
548   db (DB_REGIONS, "For ip @ 0x%08x => ", ip);
549
550   if (region->lsda)
551     db (DB_REGIONS, "lsda @ 0x%x", region->lsda);
552   else
553     db (DB_REGIONS, "no lsda");
554
555   db (DB_REGIONS, "\n");
556 }
557
558 /* Retrieve the ttype entry associated with FILTER in the REGION's
559    ttype table.  */
560
561 static const _Unwind_Ptr
562 get_ttype_entry_for (region_descriptor *region, long filter)
563 {
564   _Unwind_Ptr ttype_entry;
565
566   filter *= size_of_encoded_value (region->ttype_encoding);
567   read_encoded_value_with_base
568     (region->ttype_encoding, region->ttype_base,
569      region->ttype_table - filter, &ttype_entry);
570
571   return ttype_entry;
572 }
573
574 /* Fill out the REGION descriptor for the provided UW_CONTEXT.  */
575
576 static void
577 get_region_description_for (_Unwind_Context *uw_context,
578                             region_descriptor *region)
579 {
580   const unsigned char * p;
581   _Unwind_Word tmp;
582   unsigned char lpbase_encoding;
583
584   /* Get the base address of the lsda information. If the provided context
585      is null or if there is no associated language specific data, there's
586      nothing we can/should do.  */
587   region->lsda
588     = (_Unwind_Ptr) (uw_context
589                      ? _Unwind_GetLanguageSpecificData (uw_context) : 0);
590
591   if (! region->lsda)
592     return;
593
594   /* Parse the lsda and fill the region descriptor.  */
595   p = (char *)region->lsda;
596
597   region->base = _Unwind_GetRegionStart (uw_context);
598
599   /* Find @LPStart, the base to which landing pad offsets are relative.  */
600   lpbase_encoding = *p++;
601   if (lpbase_encoding != DW_EH_PE_omit)
602     p = read_encoded_value
603       (uw_context, lpbase_encoding, p, &region->lp_base);
604   else
605     region->lp_base = region->base;
606
607   /* Find @TType, the base of the handler and exception spec type data.  */
608   region->ttype_encoding = *p++;
609   if (region->ttype_encoding != DW_EH_PE_omit)
610     {
611       p = read_uleb128 (p, &tmp);
612       region->ttype_table = p + tmp;
613     }
614    else
615      region->ttype_table = 0;
616
617   region->ttype_base
618     = base_of_encoded_value (region->ttype_encoding, uw_context);
619
620   /* Get the encoding and length of the call-site table; the action table
621      immediately follows.  */
622   region->call_site_encoding = *p++;
623   region->call_site_table = read_uleb128 (p, &tmp);
624
625   region->action_table = region->call_site_table + tmp;
626 }
627
628
629 /* Describe an action to be taken when propagating an exception up to
630    some context.  */
631
632 typedef enum
633 {
634   /* Found some call site base data, but need to analyze further
635      before beeing able to decide.  */
636   unknown,
637
638   /* There is nothing relevant in the context at hand. */
639   nothing,
640
641   /* There are only cleanups to run in this context.  */
642   cleanup,
643
644   /* There is a handler for the exception in this context.  */
645   handler
646 } action_kind;
647
648
649 typedef struct
650 {
651   /* The kind of action to be taken.  */
652   action_kind kind;
653
654   /* A pointer to the action record entry.  */
655   const unsigned char *table_entry;
656
657   /* Where we should jump to actually take an action (trigger a cleanup or an
658      exception handler).  */
659   _Unwind_Ptr landing_pad;
660
661   /* If we have a handler matching our exception, these are the filter to
662      trigger it and the corresponding id.  */
663   _Unwind_Sword ttype_filter;
664   _Unwind_Ptr   ttype_entry;
665
666 } action_descriptor;
667
668
669 static void
670 db_action_for (action_descriptor *action, _Unwind_Context *uw_context)
671 {
672   _Unwind_Ptr ip = _Unwind_GetIP (uw_context) - 1;
673
674   db (DB_ACTIONS, "For ip @ 0x%08x => ", ip);
675
676   switch (action->kind)
677      {
678      case unknown:
679        db (DB_ACTIONS, "lpad @ 0x%x, record @ 0x%x\n",
680            ip, action->landing_pad, action->table_entry);
681        break;
682
683      case nothing:
684        db (DB_ACTIONS, "Nothing\n");
685        break;
686
687      case cleanup:
688        db (DB_ACTIONS, "Cleanup\n");
689        break;
690
691      case handler:
692        db (DB_ACTIONS, "Handler, filter = %d\n", action->ttype_filter);
693        break;
694
695      default:
696        db (DB_ACTIONS, "Err? Unexpected action kind !\n");
697        break;
698     }
699
700   return;
701 }
702
703
704 /* Search the call_site_table of REGION for an entry appropriate for the
705    UW_CONTEXT's ip. If one is found, store the associated landing_pad and
706    action_table entry, and set the ACTION kind to unknown for further
707    analysis. Otherwise, set the ACTION kind to nothing.
708
709    There are two variants of this routine, depending on the underlying
710    mechanism (dwarf/sjlj), which account for differences in the tables
711    organization.
712 */
713
714 #ifdef __USING_SJLJ_EXCEPTIONS__
715
716 #define __builtin_eh_return_data_regno(x) x
717
718 static void
719 get_call_site_action_for (_Unwind_Context *uw_context,
720                           region_descriptor *region,
721                           action_descriptor *action)
722 {
723   _Unwind_Ptr call_site
724     = _Unwind_GetIP (uw_context) - 1;
725   /* Subtract 1 because GetIP returns the actual call_site value + 1.  */
726
727   /* call_site is a direct index into the call-site table, with two special
728      values : -1 for no-action and 0 for "terminate". The latter should never
729      show up for Ada. To test for the former, beware that _Unwind_Ptr might be
730      unsigned.  */
731
732   if ((int)call_site < 0)
733     {
734       action->kind = nothing;
735       return;
736     }
737   else if (call_site == 0)
738     {
739       db (DB_ERR, "========> Err, null call_site for Ada/sjlj\n");
740       action->kind = nothing;
741       return;
742     }
743   else
744     {
745       _Unwind_Word cs_lp, cs_action;
746
747       /* Let the caller know there may be an action to take, but let it
748          determine the kind.  */
749       action->kind = unknown;
750
751       /* We have a direct index into the call-site table, but this table is
752          made of leb128 values, the encoding length of which is variable. We
753          can't merely compute an offset from the index, then, but have to read
754          all the entries before the one of interest.  */
755
756       const unsigned char * p = region->call_site_table;
757
758       do {
759         p = read_uleb128 (p, &cs_lp);
760         p = read_uleb128 (p, &cs_action);
761       } while (--call_site);
762
763
764       action->landing_pad = cs_lp + 1;
765
766       if (cs_action)
767         action->table_entry = region->action_table + cs_action - 1;
768       else
769         action->table_entry = 0;
770
771       return;
772     }
773 }
774
775 #else
776 /* ! __USING_SJLJ_EXCEPTIONS__ */
777
778 static void
779 get_call_site_action_for (_Unwind_Context *uw_context,
780                           region_descriptor *region,
781                           action_descriptor *action)
782 {
783   _Unwind_Ptr ip
784     = _Unwind_GetIP (uw_context) - 1;
785   /* Substract 1 because GetIP yields a call return address while we are
786      interested in information for the call point. This does not always yield
787      the exact call instruction address but always brings the ip back within
788      the corresponding region.
789
790      ??? When unwinding up from a signal handler triggered by a trap on some
791      instruction, we usually have the faulting instruction address here and
792      subtracting 1 might get us into the wrong region.  */
793
794   const unsigned char * p
795     = region->call_site_table;
796
797   /* Unless we are able to determine otherwise ... */
798   action->kind = nothing;
799
800   db (DB_CSITE, "\n");
801
802   while (p < region->action_table)
803     {
804       _Unwind_Ptr cs_start, cs_len, cs_lp;
805       _Unwind_Word cs_action;
806
807       /* Note that all call-site encodings are "absolute" displacements.  */
808       p = read_encoded_value (0, region->call_site_encoding, p, &cs_start);
809       p = read_encoded_value (0, region->call_site_encoding, p, &cs_len);
810       p = read_encoded_value (0, region->call_site_encoding, p, &cs_lp);
811       p = read_uleb128 (p, &cs_action);
812
813       db (DB_CSITE,
814           "c_site @ 0x%08x (+0x%03x), len = %3d, lpad @ 0x%08x (+0x%03x)\n",
815           region->base+cs_start, cs_start, cs_len,
816           region->lp_base+cs_lp, cs_lp);
817
818       /* The table is sorted, so if we've passed the ip, stop.  */
819       if (ip < region->base + cs_start)
820         break;
821
822       /* If we have a match, fill the ACTION fields accordingly.  */
823       else if (ip < region->base + cs_start + cs_len)
824         {
825           /* Let the caller know there may be an action to take, but let it
826              determine the kind.  */
827           action->kind = unknown;
828
829           if (cs_lp)
830             action->landing_pad = region->lp_base + cs_lp;
831           else
832             action->landing_pad = 0;
833
834           if (cs_action)
835             action->table_entry = region->action_table + cs_action - 1;
836           else
837             action->table_entry = 0;
838
839           db (DB_CSITE, "+++\n");
840           return;
841         }
842     }
843
844   db (DB_CSITE, "---\n");
845 }
846
847 #endif
848
849 /* Fill out the ACTION to be taken from propagating UW_EXCEPTION up to
850    UW_CONTEXT in REGION.  */
851
852 static void
853 get_action_description_for (_Unwind_Context *uw_context,
854                             _Unwind_Exception *uw_exception,
855                             region_descriptor *region,
856                             action_descriptor *action)
857 {
858   _GNAT_Exception * gnat_exception = (_GNAT_Exception *) uw_exception;
859
860   /* Search the call site table first, which may get us a landing pad as well
861      as the head of an action record list.  */
862   get_call_site_action_for (uw_context, region, action);
863   db_action_for (action, uw_context);
864
865   /* If there is not even a call_site entry, we are done.  */
866   if (action->kind == nothing)
867     return;
868
869   /* Otherwise, check what we have at the place of the call site  */
870
871   /* No landing pad => no cleanups or handlers.  */
872   if (action->landing_pad == 0)
873     {
874       action->kind = nothing;
875       return;
876     }
877
878   /* Landing pad + null table entry => only cleanups.  */
879   else if (action->table_entry == 0)
880     {
881       action->kind = cleanup;
882       return;
883     }
884
885   /* Landing pad + Table entry => handlers + possible cleanups.  */
886   else
887     {
888       const unsigned char * p = action->table_entry;
889
890       _Unwind_Sword ar_filter, ar_disp;
891
892       action->kind = nothing;
893
894       while (1)
895         {
896           p = read_sleb128 (p, &ar_filter);
897           read_sleb128 (p, &ar_disp);
898           /* Don't assign p here, as it will be incremented by ar_disp
899              below.  */
900
901           /* Null filters are for cleanups. */
902           if (ar_filter == 0)
903             action->kind = cleanup;
904
905           /* Positive filters are for regular handlers.  */
906           else if (ar_filter > 0)
907             {
908               /* See if the filter we have is for an exception which matches
909                  the one we are propagating.  */
910               _Unwind_Ptr eid = get_ttype_entry_for (region, ar_filter);
911
912               if (eid == gnat_exception->id
913                   || eid == GNAT_ALL_OTHERS
914                   || (eid == GNAT_OTHERS && gnat_exception->handled_by_others))
915                 {
916                   action->ttype_filter = ar_filter;
917                   action->ttype_entry = eid;
918                   action->kind = handler;
919                   return;
920                 }
921             }
922
923           /* Negative filter values are for C++ exception specifications.
924              Should not be there for Ada :/  */
925           else
926             db (DB_ERR, "========> Err, filter < 0 for Ada/dwarf\n");
927
928           if (ar_disp == 0)
929             return;
930
931           p += ar_disp;
932         }
933     }
934 }
935
936 /* Setup in UW_CONTEXT the eh return target IP and data registers, which will
937    be restored with the others and retrieved by the landing pad once the jump
938    occured.  */
939
940 static void
941 setup_to_install (_Unwind_Context *uw_context,
942                   _Unwind_Exception *uw_exception,
943                   _Unwind_Ptr uw_landing_pad,
944                   int uw_filter)
945 {
946 #ifndef EH_RETURN_DATA_REGNO
947   /* We should not be called if the appropriate underlying support is not
948      there.  */
949   abort ();
950 #else
951   /* 1/ exception object pointer, which might be provided back to
952      _Unwind_Resume (and thus to this personality routine) if we are jumping
953      to a cleanup.  */
954   _Unwind_SetGR (uw_context, __builtin_eh_return_data_regno (0),
955                  (_Unwind_Word)uw_exception);
956
957   /* 2/ handler switch value register, which will also be used by the target
958      landing pad to decide what action it shall take.  */
959   _Unwind_SetGR (uw_context, __builtin_eh_return_data_regno (1),
960                  (_Unwind_Word)uw_filter);
961
962   /* Setup the address we should jump at to reach the code where there is the
963      "something" we found.  */
964   _Unwind_SetIP (uw_context, uw_landing_pad);
965 #endif
966 }
967
968 /* The following is defined from a-except.adb. Its purpose is to enable
969    automatic backtraces upon exception raise, as provided through the
970    GNAT.Traceback facilities.  */
971 extern void __gnat_notify_handled_exception (void);
972 extern void __gnat_notify_unhandled_exception (void);
973
974 /* Below is the eh personality routine per se. We currently assume that only
975    GNU-Ada exceptions are met.  */
976
977 _Unwind_Reason_Code
978 __gnat_eh_personality (int uw_version,
979                        _Unwind_Action uw_phases,
980                        _Unwind_Exception_Class uw_exception_class,
981                        _Unwind_Exception *uw_exception,
982                        _Unwind_Context *uw_context)
983 {
984   _GNAT_Exception * gnat_exception = (_GNAT_Exception *) uw_exception;
985
986   region_descriptor region;
987   action_descriptor action;
988
989   if (uw_version != 1)
990     return _URC_FATAL_PHASE1_ERROR;
991
992   db_indent (DB_INDENT_RESET);
993   db_phases (uw_phases);
994   db_indent (DB_INDENT_INCREASE);
995
996   /* Get the region description for the context we were provided with. This
997      will tell us if there is some lsda, call_site, action and/or ttype data
998      for the associated ip.  */
999   get_region_description_for (uw_context, &region);
1000   db_region_for (&region, uw_context);
1001
1002   /* No LSDA => no handlers or cleanups => we shall unwind further up.  */
1003   if (! region.lsda)
1004     return _URC_CONTINUE_UNWIND;
1005
1006   /* Search the call-site and action-record tables for the action associated
1007      with this IP.  */
1008   get_action_description_for (uw_context, uw_exception, &region, &action);
1009   db_action_for (&action, uw_context);
1010
1011   /* Whatever the phase, if there is nothing relevant in this frame,
1012      unwinding should just go on.  */
1013   if (action.kind == nothing)
1014     return _URC_CONTINUE_UNWIND;
1015
1016   /* If we found something in search phase, we should return a code indicating
1017      what to do next depending on what we found. If we only have cleanups
1018      around, we shall try to unwind further up to find a handler, otherwise,
1019      tell we have a handler, which will trigger the second phase.  */
1020   if (uw_phases & _UA_SEARCH_PHASE)
1021     {
1022       if (action.kind == cleanup)
1023         {
1024           gnat_exception->n_cleanups_to_trigger ++;
1025           return _URC_CONTINUE_UNWIND;
1026         }
1027       else
1028         {
1029           /* Trigger the appropriate notification routines before the second
1030              phase starts, which ensures the stack is still intact. */
1031           __gnat_notify_handled_exception ();
1032
1033           return _URC_HANDLER_FOUND;
1034         }
1035     }
1036
1037   /* We found something in cleanup/handler phase, which might be the handler
1038      or a cleanup for a handled occurrence, or a cleanup for an unhandled
1039      occurrence (we are in a FORCED_UNWIND phase in this case). Install the
1040      context to get there.  */
1041
1042   /* If we are going to install a cleanup context, decrement the cleanup
1043      count.  This is required in a FORCED_UNWINDing phase (for an unhandled
1044      exception), as this is used from the forced unwinding handler in
1045      Ada.Exceptions.Exception_Propagation to decide wether unwinding should
1046      proceed further or Unhandled_Exception_Terminate should be called.  */
1047   if (action.kind == cleanup)
1048     gnat_exception->n_cleanups_to_trigger --;
1049
1050   setup_to_install
1051     (uw_context, uw_exception, action.landing_pad, action.ttype_filter);
1052
1053   return _URC_INSTALL_CONTEXT;
1054 }
1055
1056 /* Define the consistently named stubs imported by Propagate_Exception.  */
1057
1058 #ifdef __USING_SJLJ_EXCEPTIONS__
1059
1060 #undef _Unwind_RaiseException
1061
1062 _Unwind_Reason_Code
1063 __gnat_Unwind_RaiseException (_Unwind_Exception *e)
1064 {
1065   return _Unwind_SjLj_RaiseException (e);
1066 }
1067
1068
1069 #undef _Unwind_ForcedUnwind
1070
1071 _Unwind_Reason_Code
1072 __gnat_Unwind_ForcedUnwind (_Unwind_Exception *e,
1073                             void * handler,
1074                             void * argument)
1075 {
1076   return _Unwind_SjLj_ForcedUnwind (e, handler, argument);
1077 }
1078
1079
1080 #else /* __USING_SJLJ_EXCEPTIONS__ */
1081
1082 _Unwind_Reason_Code
1083 __gnat_Unwind_RaiseException (_Unwind_Exception *e)
1084 {
1085   return _Unwind_RaiseException (e);
1086 }
1087
1088 _Unwind_Reason_Code
1089 __gnat_Unwind_ForcedUnwind (_Unwind_Exception *e,
1090                             void * handler,
1091                             void * argument)
1092 {
1093   return _Unwind_ForcedUnwind (e, handler, argument);
1094 }
1095
1096 #endif /* __USING_SJLJ_EXCEPTIONS__ */
1097
1098 #else
1099 /* ! IN_RTS  */
1100
1101 /* The calls to the GCC runtime interface for exception raising are currently
1102    issued from a-exexpr.adb, which is used by both the runtime library and the
1103    compiler.
1104
1105    As the compiler binary is not linked against the GCC runtime library, we
1106    need also need stubs for this interface in the compiler case. We should not
1107    be using the GCC eh mechanism for the compiler, however, so expect these
1108    functions never to be called.  */
1109
1110 _Unwind_Reason_Code
1111 __gnat_Unwind_RaiseException (_Unwind_Exception *e ATTRIBUTE_UNUSED)
1112 {
1113   abort ();
1114 }
1115
1116
1117 _Unwind_Reason_Code
1118 __gnat_Unwind_ForcedUnwind (_Unwind_Exception *e ATTRIBUTE_UNUSED,
1119                             void * handler ATTRIBUTE_UNUSED,
1120                             void * argument ATTRIBUTE_UNUSED)
1121 {
1122   abort ();
1123 }
1124
1125 #endif /* IN_RTS */