moved methods here from irnode.c
[libfirm] / ir / st / exc.c
1 /*
2  * Project:     libFIRM
3  * File name:   ir/st/exc.c
4  * Purpose:     Helper functions for jack exceptions.
5  * Author:      Florian Liekweg
6  * Modified by:
7  * Created:     4.3.2002
8  * CVS-ID:      $Id$
9  * Copyright:   (c) 2002-2003 Universität Karlsruhe
10  * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
11  */
12
13 /**
14    NAME
15      exc
16    PURPOSE
17      Helper functions for exceptions
18    S
19      not quite complete
20 ***/
21
22 # include "exc.h"
23
24 static char* exc_strings [] = {
25   "Invalid",                                    /* invalid */
26   "Normal",                                             /* normal */
27   "Entry",                                              /* entry to region */
28   "Exit",                                               /* exit of region */
29   "Handler",                                    /* entry to handler */
30   "Cont"
31 };
32
33
34 /*
35   Return true iff (block b is a handler entry AND a dominates b) OR
36   (b has a CFG successor that is both a handler entry AND is dominated
37   by a)
38 */
39 static bool has_handler (ir_graph *graph, ir_node *b, ir_node *a)
40 {
41   int i         = 0;
42   int n         = get_irn_n_outs (b);
43   ir_node *succ = 0;
44
45   assert (0 && "Wrongly implemented");
46   /* must check for _immediate_ dominance !!! */
47
48   if (is_handler_entry (graph, b) && dominates (graph, a, b))
49         return (true);
50
51   for (i = 0; i < n; i ++)
52         {
53           succ = get_irn_out (b, i);
54
55           if (has_handler (graph, succ, a))
56                 return (true);
57         }
58
59   return (false);
60 }
61
62 /*
63   Return true iff the given node represents an exception jump
64 */
65 static bool is_exc_jmp (ir_node *node)
66 {
67   ir_op *op = get_irn_op (node);
68
69   /* Proj_X (Load), Proj_X (Sto), Proj_X (Div_Int),
70      Proj_X (Raise), Proj_X (Call), Proj_X (Alloc) */
71   if (op == op_Proj)
72         {
73           op = get_irn_op (get_Proj_pred (node));
74
75           assert ((is_fragile_op(get_Proj_pred(node))) &&
76                   (op != op_Bad) /*&& (op != op_Unknown)*/ &&
77                   (get_irn_mode(node) == mode_X));/* Check for proper Proj attr */
78           return (true);
79         }
80   else
81         {
82           return (false);
83         }
84 }
85
86 /*
87 Return true iff the given node represents a normal cfg jump
88 */
89 #if 0
90 static bool is_cfg_jmp (ir_node *node)
91 {
92   ir_op *op = get_irn_op (node);
93
94   if (op == op_Proj)
95     {
96       op = get_irn_op (get_Proj_pred (node));
97
98       /* Proj_X (Proj_Cmp (Cond)) */
99       if (op_Proj == op)
100         return (true);  /* check for op == op_Cmp and op == op_Cond */
101     }
102
103   return (false);
104 }
105 #endif
106
107 void set_Block_exc(ir_node *n, ir_node *exc) {
108 }
109
110 ir_node * get_Block_exc(ir_node *n) {
111   return NULL;
112 }
113
114
115
116 /*
117  Return true iff a new exception region must be left upon entry of this block.
118
119  If all CFG preds of this block are exception jumps, then we must
120  return true.
121 */
122 bool is_handler_entry (ir_graph *graph, ir_node *block)
123 {
124   bool is_entry = true;
125   int  i        = 0;
126   int  n        = get_irn_arity (block);
127
128   if (exc_invalid == get_Block_exc (block))
129         {
130           for (i = 0; (i < n) && (is_entry == true); i ++)
131                 if (is_exc_jmp (get_irn_n (block, i)))
132                   continue;
133                 else
134                   is_entry = false;
135
136           if (true == is_entry)
137                 set_Block_exc (block, exc_handler);
138         }
139
140   return (exc_handler == get_Block_exc (block));
141 }
142
143 /*
144  Return true iff a new exception region must be started upon entry of this block.
145
146  If this block immediately dominates a handler entry, we must return true.
147 */
148 bool is_region_entry  (ir_graph *graph, ir_node *block)
149 {
150   assert (0 && "Not implemented");
151
152   if (exc_invalid == get_Block_exc (block))
153         {
154           int i         = 0;
155           int n         = get_irn_n_outs (block);
156           ir_node *succ = 0;
157
158           bool no_handler = true;
159
160           for (i = 0; (i < n) && (no_handler == true); i ++)
161                 {
162                   succ = get_irn_out (block, i);
163
164                   if (has_handler (graph, succ, block))
165                         no_handler = false;
166                 }
167
168           if (false == no_handler)
169                 set_Block_exc (block, exc_region);
170         }
171
172   return (exc_region == get_Block_exc (block));
173
174   return (true);
175 }
176
177 /*
178  Return true iff this block is part of handler code.
179
180  If this block is dominated by a block for which {@link
181  is_handler_entry} is true, then this block is part of the handler.
182 */
183 bool is_handler_block (ir_graph *graph, ir_node *block)
184 {
185   assert (0 && "Not implemented");
186
187   if (exc_invalid == get_Block_exc (block))
188         {
189           bool no_handler = true;
190           dom_env_t *env  = get_dom_env (graph, block);
191           int block_index = env->index_a;
192           bs_t block_mask = 0x00000001 << block_index;
193           int n_blocks    = env->dt->n_blocks;
194           int i           = 0;
195
196           for (i = 0; (i < n_blocks) && (no_handler == true); i ++)
197                 if (0 != (env->dt->masks [i] & block_mask)) /* if dominator */
198                   if (is_handler_entry (graph, env->dt->blocks [i])) /* is handler entry */
199                         no_handler = false;
200
201           delete_dom_env (env);
202
203           if (false == no_handler)
204                 set_Block_exc (block, exc_handler);
205         }
206
207   return (exc_handler == get_Block_exc (block));
208 }
209
210 /*
211   Convert a value of type exc_t to a descriptive string.
212   Returns a reference to a statically allocated, constant string.
213 */
214
215 const char *exc_to_string (exc_t exc)
216 {
217   int exc_val = (int) exc;
218
219   assert ((0 <= (int) exc_val) && (exc_val < (int) exc_max));
220
221   return (exc_strings [exc_val]);
222 }