improve peephole API, do IncSP stuff as peephole opts, add IncSP -4 -> Pop opt
[libfirm] / ir / lower / lower_intrinsics.c
1 /*
2  * Copyright (C) 1995-2007 University of Karlsruhe.  All right reserved.
3  *
4  * This file is part of libFirm.
5  *
6  * This file may be distributed and/or modified under the terms of the
7  * GNU General Public License version 2 as published by the Free Software
8  * Foundation and appearing in the file LICENSE.GPL included in the
9  * packaging of this file.
10  *
11  * Licensees holding valid libFirm Professional Edition licenses may use
12  * this file in accordance with the libFirm Commercial License.
13  * Agreement provided with the Software.
14  *
15  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE.
18  */
19
20 /**
21  * @file
22  * @brief   lowering of Calls of intrinsic functions
23  * @author  Michael Beck
24  * @version $Id$
25  */
26
27 #ifdef HAVE_CONFIG_H
28 #include "config.h"
29 #endif
30
31 #include "lowering.h"
32 #include "irop_t.h"
33 #include "irprog_t.h"
34 #include "irnode_t.h"
35 #include "irprog_t.h"
36 #include "irgwalk.h"
37 #include "ircons.h"
38 #include "irgmod.h"
39 #include "irgopt.h"
40 #include "trouts.h"
41 #include "pmap.h"
42 #include "xmalloc.h"
43
44 /** Walker environment */
45 typedef struct _walker_env {
46         pmap     *c_map;              /**< The intrinsic call map. */
47         unsigned nr_of_intrinsics;    /**< statistics */
48         i_instr_record **i_map;       /**< The intrinsic instruction map. */
49 } walker_env_t;
50
51 /**
52  * walker: call all mapper functions
53  */
54 static void call_mapper(ir_node *node, void *env) {
55         walker_env_t *wenv = env;
56         ir_op *op = get_irn_op(node);
57
58         if (op == op_Call) {
59                 ir_node *symconst;
60                 pmap_entry *p;
61                 const i_call_record *r;
62                 ir_entity *ent;
63
64                 symconst = get_Call_ptr(node);
65                 if (get_irn_op(symconst) != op_SymConst ||
66                         get_SymConst_kind(symconst) != symconst_addr_ent)
67                         return;
68
69                 ent = get_SymConst_entity(symconst);
70                 p   = pmap_find(wenv->c_map, ent);
71
72                 if (p) {
73                         r = p->value;
74                         wenv->nr_of_intrinsics += r->i_mapper(node, r->ctx) ? 1 : 0;
75                 }
76         } else {
77                 if (op->code < (unsigned) ARR_LEN(wenv->i_map)) {
78                         const i_instr_record *r = wenv->i_map[op->code];
79                         /* run all possible mapper */
80                         while (r) {
81                                 if (r->i_mapper(node, r->ctx)) {
82                                         ++wenv->nr_of_intrinsics;
83                                         break;
84                                 }
85                                 r = r->link;
86                         }
87                 }
88         }
89 }
90
91 /* Go through all graphs and map calls to intrinsic functions. */
92 unsigned lower_intrinsics(i_record *list, int length, int part_block_used) {
93         int            i, n_ops = get_irp_n_opcodes();
94         ir_graph       *irg;
95         pmap           *c_map = pmap_create_ex(length);
96         i_instr_record **i_map;
97         unsigned       nr_of_intrinsics = 0;
98         walker_env_t   wenv;
99
100         /* we use the ir_op generic pointers here */
101         NEW_ARR_A(const i_instr_record *, i_map, n_ops);
102         memset((void *)i_map, 0, sizeof(*i_map) * n_ops);
103
104         /* fill a map for faster search */
105         for (i = length - 1; i >= 0; --i) {
106                 if (list[i].i_call.kind == INTRINSIC_CALL) {
107                         pmap_insert(c_map, list[i].i_call.i_ent, (void *)&list[i].i_call);
108                 } else {
109                         ir_op *op = list[i].i_instr.op;
110                         assert(op->code < (unsigned) ARR_LEN(i_map));
111
112                         list[i].i_instr.link = i_map[op->code];
113                         i_map[op->code] = &list[i].i_instr;
114                 }
115         }
116
117         wenv.c_map = c_map;
118         wenv.i_map = i_map;
119
120         for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
121                 irg = get_irp_irg(i);
122
123                 if (part_block_used)
124                         collect_phiprojs(irg);
125
126                 wenv.nr_of_intrinsics = 0;
127                 irg_walk_graph(irg, NULL, call_mapper, &wenv);
128
129                 if (wenv.nr_of_intrinsics) {
130                         /* changes detected */
131                         set_irg_outs_inconsistent(irg);
132                         set_irg_callee_info_state(irg, irg_callee_info_inconsistent);
133
134                         /* exception control flow might have changed */
135                         set_irg_doms_inconsistent(irg);
136                         set_irg_extblk_inconsistent(irg);
137                         set_irg_loopinfo_inconsistent(irg);
138
139                         /* calls might be removed/added */
140                         set_trouts_inconsistent();
141
142                         /* optimize it, tuple might be created */
143                         local_optimize_graph(irg);
144
145                         nr_of_intrinsics += wenv.nr_of_intrinsics;
146                 }
147         }
148         pmap_destroy(c_map);
149
150         return nr_of_intrinsics;
151 }
152
153 /* A mapper for the integer abs. */
154 int i_mapper_Abs(ir_node *call, void *ctx) {
155         ir_node *mem   = get_Call_mem(call);
156         ir_node *block = get_nodes_block(call);
157         ir_node *op    = get_Call_param(call, 0);
158         ir_node *irn;
159         dbg_info *dbg  = get_irn_dbg_info(call);
160         (void) ctx;
161
162         irn = new_rd_Abs(dbg, current_ir_graph, block, op, get_irn_mode(op));
163         irn = new_Tuple(1, &irn);
164
165         turn_into_tuple(call, pn_Call_max);
166         set_Tuple_pred(call, pn_Call_M_regular, mem);
167         set_Tuple_pred(call, pn_Call_X_regular, new_r_Jmp(current_ir_graph, block));
168         set_Tuple_pred(call, pn_Call_X_except, new_Bad());
169         set_Tuple_pred(call, pn_Call_T_result, irn);
170         set_Tuple_pred(call, pn_Call_M_except, mem);
171         set_Tuple_pred(call, pn_Call_P_value_res_base, new_Bad());
172
173         return 1;
174 }
175
176 /* A mapper for the alloca() function. */
177 int i_mapper_Alloca(ir_node *call, void *ctx) {
178         ir_node *mem   = get_Call_mem(call);
179         ir_node *block = get_nodes_block(call);
180         ir_node *op    = get_Call_param(call, 0);
181         ir_node *irn, *exc, *no_exc;
182         dbg_info *dbg  = get_irn_dbg_info(call);
183         (void) ctx;
184
185         irn    = new_rd_Alloc(dbg, current_ir_graph, block, mem, op, firm_unknown_type, stack_alloc);
186         mem    = new_Proj(irn, mode_M, pn_Alloc_M);
187         no_exc = new_Proj(irn, mode_X, pn_Alloc_X_regular);
188         exc    = new_Proj(irn, mode_X, pn_Alloc_X_except);
189         irn    = new_Proj(irn, get_modeP_data(), pn_Alloc_res);
190         irn    = new_Tuple(1, &irn);
191
192         turn_into_tuple(call, pn_Call_max);
193         set_Tuple_pred(call, pn_Call_M_regular, mem);
194         set_Tuple_pred(call, pn_Call_X_regular, no_exc);
195         set_Tuple_pred(call, pn_Call_X_except, exc);
196         set_Tuple_pred(call, pn_Call_T_result, irn);
197         set_Tuple_pred(call, pn_Call_M_except, mem);
198         set_Tuple_pred(call, pn_Call_P_value_res_base, new_Bad());
199
200         return 1;
201 }
202
203 /**
204  * Returns the result mode of a node.
205  */
206 static ir_mode *get_irn_res_mode(ir_node *node) {
207         switch (get_irn_opcode(node)) {
208         case iro_Load:   return get_Load_mode(node);
209         case iro_Quot:   return get_Quot_resmode(node);
210         case iro_Div:    return get_Div_resmode(node);
211         case iro_Mod:    return get_Mod_resmode(node);
212         case iro_DivMod: return get_DivMod_resmode(node);
213         default: return NULL;
214         }
215 }
216
217 #define LMAX(a, b) ((a) > (b) ? (a) : (b))
218
219 /* A mapper for mapping unsupported instructions to runtime calls. */
220 int i_mapper_RuntimeCall(ir_node *node, runtime_rt *rt) {
221         int i, j, arity, first, n_param, n_res;
222         long n_proj;
223         ir_type *mtp;
224         ir_node *mem, *bl, *call, *addr, *res_proj;
225         ir_node **in;
226         ir_graph *irg;
227         symconst_symbol sym;
228         ir_mode *mode = get_irn_mode(node);
229
230         if (mode != rt->mode)
231                 return 0;
232         /* check if the result modes match */
233         if (mode == mode_T && rt->res_mode != NULL) {
234                 mode = get_irn_res_mode(node);
235                 if (mode != rt->res_mode)
236                         return 0;
237         }
238
239         arity = get_irn_arity(node);
240         if (arity <= 0)
241                 return 0;
242
243         mtp     = get_entity_type(rt->ent);
244         n_param = get_method_n_params(mtp);
245         irg     = current_ir_graph;
246
247         mem = get_irn_n(node, 0);
248         if (get_irn_mode(mem) != mode_M) {
249                 mem = new_r_NoMem(irg);
250                 first = 0;
251         } else
252                 first = 1;
253
254         /* check if the modes of the predecessors match the parameter modes */
255         if (arity - first != n_param)
256                 return 0;
257
258         for (i = first, j = 0; i < arity; ++i, ++j) {
259                 ir_type *param_tp = get_method_param_type(mtp, j);
260                 ir_node *pred = get_irn_n(node, i);
261
262                 if (get_type_mode(param_tp) != get_irn_mode(pred))
263                         return 0;
264         }
265
266         n_res = get_method_n_ress(mtp);
267
268         /* step 0: calculate the number of needed Proj's */
269         n_proj = 0;
270         n_proj = LMAX(n_proj, rt->mem_proj_nr + 1);
271         n_proj = LMAX(n_proj, rt->regular_proj_nr + 1);
272         n_proj = LMAX(n_proj, rt->exc_proj_nr + 1);
273         n_proj = LMAX(n_proj, rt->exc_mem_proj_nr + 1);
274         n_proj = LMAX(n_proj, rt->res_proj_nr + 1);
275
276         if (n_proj > 0) {
277                 if (rt->mode != mode_T) /* must be mode_T */
278                         return 0;
279         } else {
280                 if (n_res > 0)
281                         /* must match */
282                         if (get_type_mode(get_method_res_type(mtp, 0)) != rt->mode)
283                                 return 0;
284         }
285
286         /* ok, when we are here, the number of predecessors match as well as the parameter modes */
287         bl = get_nodes_block(node);
288
289         in = NULL;
290         if (n_param > 0) {
291                 NEW_ARR_A(ir_node *, in, n_param);
292                 for (i = 0; i < n_param; ++i)
293                         in[i] = get_irn_n(node, first + i);
294         }
295
296         /* step 1: create the call */
297         sym.entity_p = rt->ent;
298         addr = new_r_SymConst(irg, bl, sym, symconst_addr_ent);
299         call = new_rd_Call(get_irn_dbg_info(node), irg, bl, mem, addr, n_param, in, mtp);
300         set_irn_pinned(call, get_irn_pinned(node));
301
302         if (n_res > 0)
303                 res_proj = new_r_Proj(irg, bl, call, mode_T, pn_Call_T_result);
304         else
305                 res_proj = NULL;
306
307         if (n_proj > 0) {
308                 n_proj += n_res - 1;
309
310                 /* we are ready */
311                 turn_into_tuple(node, n_proj);
312
313                 for (i = 0; i < n_proj; ++i)
314                         set_Tuple_pred(node, i, new_r_Bad(irg));
315                 if (rt->mem_proj_nr >= 0)
316                         set_Tuple_pred(node, rt->mem_proj_nr, new_r_Proj(irg, bl, call, mode_M, pn_Call_M_regular));
317                 if (get_irn_op(mem) != op_NoMem) {
318                         /* Exceptions can only be handled with real memory */
319                         if (rt->regular_proj_nr >= 0)
320                                 set_Tuple_pred(node, rt->regular_proj_nr, new_r_Proj(irg, bl, call, mode_X, pn_Call_X_regular));
321                         if (rt->exc_proj_nr >= 0)
322                                 set_Tuple_pred(node, rt->exc_proj_nr, new_r_Proj(irg, bl, call, mode_X, pn_Call_X_except));
323                         if (rt->exc_mem_proj_nr >= 0)
324                                 set_Tuple_pred(node, rt->mem_proj_nr, new_r_Proj(irg, bl, call, mode_M, pn_Call_M_except));
325                 }
326
327                 if (rt->res_proj_nr >= 0)
328                         for (i = 0; i < n_res; ++i)
329                                 set_Tuple_pred(node, rt->res_proj_nr + i,
330                                 new_r_Proj(irg, bl, res_proj, get_type_mode(get_method_res_type(mtp, i)), i));
331                         return 1;
332         } else {
333                 /* only one return value supported */
334                 if (n_res > 0) {
335                         ir_mode *mode = get_type_mode(get_method_res_type(mtp, 0));
336
337                         res_proj = new_r_Proj(irg, bl, call, mode_T, pn_Call_T_result);
338                         res_proj = new_r_Proj(irg, bl, res_proj, mode, 0);
339
340                         exchange(node, res_proj);
341                         return 1;
342                 }
343         }
344         /* should not happen */
345         return 0;
346 }