1a04635dd27740897751b245f9a4adc5fa76797b
[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 /**
154  * Helper function, replace the call by the given node.
155  *
156  * @param irn      the result node
157  * @param call     the call to replace
158  * @param mem      the new mem result
159  * @param reg_jmp  new regular control flow, if NULL, a Jmp will be used
160  * @param exc_jmp  new exception control flow, if reg_jmp == NULL, a Bad will be used
161  */
162 static void replace_call(ir_node *irn, ir_node *call, ir_node *mem, ir_node *reg_jmp, ir_node *exc_jmp) {
163         if (reg_jmp == NULL) {
164                 ir_node *block = get_nodes_block(call);
165
166                 /* Beware: do we need here a protection against CSE? Better we do it. */
167                 int old_cse = get_opt_cse();
168                 set_opt_cse(0);
169                 reg_jmp = new_r_Jmp(current_ir_graph, block);
170                 set_opt_cse(old_cse);
171                 exc_jmp = new_Bad();
172         }
173         irn = new_Tuple(1, &irn);
174
175         turn_into_tuple(call, pn_Call_max);
176         set_Tuple_pred(call, pn_Call_M_regular, mem);
177         set_Tuple_pred(call, pn_Call_X_regular, reg_jmp);
178         set_Tuple_pred(call, pn_Call_X_except, exc_jmp);
179         set_Tuple_pred(call, pn_Call_T_result, irn);
180         set_Tuple_pred(call, pn_Call_M_except, mem);
181         set_Tuple_pred(call, pn_Call_P_value_res_base, new_Bad());
182 }
183
184 /* A mapper for the integer abs. */
185 int i_mapper_Abs(ir_node *call, void *ctx) {
186         ir_node *mem   = get_Call_mem(call);
187         ir_node *block = get_nodes_block(call);
188         ir_node *op    = get_Call_param(call, 0);
189         ir_node *irn;
190         dbg_info *dbg  = get_irn_dbg_info(call);
191         (void) ctx;
192
193         irn = new_rd_Abs(dbg, current_ir_graph, block, op, get_irn_mode(op));
194         replace_call(irn, call, mem, NULL, NULL);
195         return 1;
196 }
197
198 /* A mapper for the alloca() function. */
199 int i_mapper_Alloca(ir_node *call, void *ctx) {
200         ir_node *mem   = get_Call_mem(call);
201         ir_node *block = get_nodes_block(call);
202         ir_node *op    = get_Call_param(call, 0);
203         ir_node *irn, *exc, *no_exc;
204         dbg_info *dbg  = get_irn_dbg_info(call);
205         (void) ctx;
206
207         irn    = new_rd_Alloc(dbg, current_ir_graph, block, mem, op, firm_unknown_type, stack_alloc);
208         mem    = new_Proj(irn, mode_M, pn_Alloc_M);
209         no_exc = new_Proj(irn, mode_X, pn_Alloc_X_regular);
210         exc    = new_Proj(irn, mode_X, pn_Alloc_X_except);
211         irn    = new_Proj(irn, get_modeP_data(), pn_Alloc_res);
212
213         replace_call(irn, call, mem, no_exc, exc);
214         return 1;
215 }
216
217 /* A mapper for the floating point sqrt. */
218 int i_mapper_Sqrt(ir_node *call, void *ctx) {
219         ir_node *mem;
220         tarval *tv;
221         ir_node *op = get_Call_param(call, 0);
222         (void) ctx;
223
224         if (!is_Const(op))
225                 return 0;
226
227         tv = get_Const_tarval(op);
228         if (! tarval_is_null(tv) && !tarval_is_one(tv))
229                 return 0;
230
231         mem = get_Call_mem(call);
232
233         /* sqrt(0) = 0, sqrt(1) = 1 */
234         replace_call(op, call, mem, NULL, NULL);
235         return 1;
236 }
237
238 /* A mapper for the floating point pow. */
239 int i_mapper_Pow(ir_node *call, void *ctx) {
240         dbg_info *dbg;
241         ir_node *mem;
242         ir_node *left  = get_Call_param(call, 0);
243         ir_node *right = get_Call_param(call, 1);
244         ir_node *block = get_nodes_block(call);
245         ir_node *irn, *reg_jmp = NULL, *exc_jmp = NULL;
246         (void) ctx;
247
248         if (is_Const(left) && is_Const_one(left)) {
249                 /* pow (1.0, x) = 1.0 */
250                 irn = left;
251         } else if (is_Const(right)) {
252                 tarval *tv = get_Const_tarval(right);
253                 if (tarval_is_null(tv)) {
254                         /* pow(x, 0.0) = 1.0 */
255                         ir_mode *mode = get_tarval_mode(tv);
256                         irn = new_r_Const(current_ir_graph, block, mode, get_mode_one(mode));
257                 } else if (tarval_is_one(tv)) {
258                         /* pow(x, 1.0) = x */
259                         irn = left;
260                 } else if (tarval_is_minus_one(tv)) {
261                         /* pow(x, -1.0) = 1/x */
262                         irn = NULL;
263                 } else
264                         return 0;
265         }
266
267         mem = get_Call_mem(call);
268         dbg = get_irn_dbg_info(call);
269
270         if (irn == NULL) {
271                 ir_mode *mode = get_irn_mode(left);
272                 ir_node *quot;
273
274                 irn  = new_r_Const(current_ir_graph, block, mode, get_mode_one(mode));
275                 quot = new_rd_Quot(dbg, current_ir_graph, block, mem, irn, left, mode, op_pin_state_pinned);
276                 mem  = new_r_Proj(current_ir_graph, block, quot, mode_M, pn_Quot_M);
277                 irn  = new_r_Proj(current_ir_graph, block, quot, mode, pn_Quot_res);
278                 reg_jmp = new_r_Proj(current_ir_graph, block, quot, mode_X, pn_Quot_X_regular);
279                 exc_jmp = new_r_Proj(current_ir_graph, block, quot, mode_X, pn_Quot_X_except);
280         }
281         replace_call(irn, call, mem, reg_jmp, exc_jmp);
282         return 1;
283 }
284
285 /* A mapper for strcmp */
286 int i_mapper_Strcmp(ir_node *call, void *ctx) {
287         ir_node *left  = get_Call_param(call, 0);
288         ir_node *right = get_Call_param(call, 1);
289         ir_node *irn;
290         (void) ctx;
291
292         if (left == right) {
293                 /* a strcmp(s, s) ==> 0 */
294                 ir_node   *mem     = get_Call_mem(call);
295                 ir_node   *adr     = get_Call_ptr(call);
296                 ir_entity *ent     = get_SymConst_entity(adr);
297                 ir_type   *call_tp = get_entity_type(ent);
298                 ir_type   *res_tp  = get_method_res_type(call_tp, 0);
299                 ir_mode   *mode    = get_type_mode(res_tp);
300                 ir_node   *block   = get_nodes_block(call);
301
302                 irn = new_r_Const(current_ir_graph, block, mode, get_mode_null(mode));
303                 replace_call(irn, call, mem, NULL, NULL);
304                 return 1;
305         }
306         return 0;
307 }
308
309 /* A mapper for memcpy */
310 int i_mapper_Memcpy(ir_node *call, void *ctx) {
311         ir_node *count = get_Call_param(call, 2);
312         ir_node *irn;
313         (void) ctx;
314
315         if (is_Const(count) && is_Const_null(count)) {
316                 /* a memcpy(d, s, 0) ==> d */
317                 ir_node *mem = get_Call_mem(call);
318                 ir_node *dst = get_Call_param(call, 0);
319
320                 replace_call(dst, call, mem, NULL, NULL);
321                 return 1;
322         }
323         return 0;
324 }
325
326 /**
327  * Returns the result mode of a node.
328  */
329 static ir_mode *get_irn_res_mode(ir_node *node) {
330         switch (get_irn_opcode(node)) {
331         case iro_Load:   return get_Load_mode(node);
332         case iro_Quot:   return get_Quot_resmode(node);
333         case iro_Div:    return get_Div_resmode(node);
334         case iro_Mod:    return get_Mod_resmode(node);
335         case iro_DivMod: return get_DivMod_resmode(node);
336         default: return NULL;
337         }
338 }
339
340 #define LMAX(a, b) ((a) > (b) ? (a) : (b))
341
342 /* A mapper for mapping unsupported instructions to runtime calls. */
343 int i_mapper_RuntimeCall(ir_node *node, runtime_rt *rt) {
344         int i, j, arity, first, n_param, n_res;
345         long n_proj;
346         ir_type *mtp;
347         ir_node *mem, *bl, *call, *addr, *res_proj;
348         ir_node **in;
349         ir_graph *irg;
350         symconst_symbol sym;
351         ir_mode *mode = get_irn_mode(node);
352
353         if (mode != rt->mode)
354                 return 0;
355         /* check if the result modes match */
356         if (mode == mode_T && rt->res_mode != NULL) {
357                 mode = get_irn_res_mode(node);
358                 if (mode != rt->res_mode)
359                         return 0;
360         }
361
362         arity = get_irn_arity(node);
363         if (arity <= 0)
364                 return 0;
365
366         mtp     = get_entity_type(rt->ent);
367         n_param = get_method_n_params(mtp);
368         irg     = current_ir_graph;
369
370         mem = get_irn_n(node, 0);
371         if (get_irn_mode(mem) != mode_M) {
372                 mem = new_r_NoMem(irg);
373                 first = 0;
374         } else
375                 first = 1;
376
377         /* check if the modes of the predecessors match the parameter modes */
378         if (arity - first != n_param)
379                 return 0;
380
381         for (i = first, j = 0; i < arity; ++i, ++j) {
382                 ir_type *param_tp = get_method_param_type(mtp, j);
383                 ir_node *pred = get_irn_n(node, i);
384
385                 if (get_type_mode(param_tp) != get_irn_mode(pred))
386                         return 0;
387         }
388
389         n_res = get_method_n_ress(mtp);
390
391         /* step 0: calculate the number of needed Proj's */
392         n_proj = 0;
393         n_proj = LMAX(n_proj, rt->mem_proj_nr + 1);
394         n_proj = LMAX(n_proj, rt->regular_proj_nr + 1);
395         n_proj = LMAX(n_proj, rt->exc_proj_nr + 1);
396         n_proj = LMAX(n_proj, rt->exc_mem_proj_nr + 1);
397         n_proj = LMAX(n_proj, rt->res_proj_nr + 1);
398
399         if (n_proj > 0) {
400                 if (rt->mode != mode_T) /* must be mode_T */
401                         return 0;
402         } else {
403                 if (n_res > 0)
404                         /* must match */
405                         if (get_type_mode(get_method_res_type(mtp, 0)) != rt->mode)
406                                 return 0;
407         }
408
409         /* ok, when we are here, the number of predecessors match as well as the parameter modes */
410         bl = get_nodes_block(node);
411
412         in = NULL;
413         if (n_param > 0) {
414                 NEW_ARR_A(ir_node *, in, n_param);
415                 for (i = 0; i < n_param; ++i)
416                         in[i] = get_irn_n(node, first + i);
417         }
418
419         /* step 1: create the call */
420         sym.entity_p = rt->ent;
421         addr = new_r_SymConst(irg, bl, sym, symconst_addr_ent);
422         call = new_rd_Call(get_irn_dbg_info(node), irg, bl, mem, addr, n_param, in, mtp);
423         set_irn_pinned(call, get_irn_pinned(node));
424
425         if (n_res > 0)
426                 res_proj = new_r_Proj(irg, bl, call, mode_T, pn_Call_T_result);
427         else
428                 res_proj = NULL;
429
430         if (n_proj > 0) {
431                 n_proj += n_res - 1;
432
433                 /* we are ready */
434                 turn_into_tuple(node, n_proj);
435
436                 for (i = 0; i < n_proj; ++i)
437                         set_Tuple_pred(node, i, new_r_Bad(irg));
438                 if (rt->mem_proj_nr >= 0)
439                         set_Tuple_pred(node, rt->mem_proj_nr, new_r_Proj(irg, bl, call, mode_M, pn_Call_M_regular));
440                 if (get_irn_op(mem) != op_NoMem) {
441                         /* Exceptions can only be handled with real memory */
442                         if (rt->regular_proj_nr >= 0)
443                                 set_Tuple_pred(node, rt->regular_proj_nr, new_r_Proj(irg, bl, call, mode_X, pn_Call_X_regular));
444                         if (rt->exc_proj_nr >= 0)
445                                 set_Tuple_pred(node, rt->exc_proj_nr, new_r_Proj(irg, bl, call, mode_X, pn_Call_X_except));
446                         if (rt->exc_mem_proj_nr >= 0)
447                                 set_Tuple_pred(node, rt->mem_proj_nr, new_r_Proj(irg, bl, call, mode_M, pn_Call_M_except));
448                 }
449
450                 if (rt->res_proj_nr >= 0)
451                         for (i = 0; i < n_res; ++i)
452                                 set_Tuple_pred(node, rt->res_proj_nr + i,
453                                 new_r_Proj(irg, bl, res_proj, get_type_mode(get_method_res_type(mtp, i)), i));
454                         return 1;
455         } else {
456                 /* only one return value supported */
457                 if (n_res > 0) {
458                         ir_mode *mode = get_type_mode(get_method_res_type(mtp, 0));
459
460                         res_proj = new_r_Proj(irg, bl, call, mode_T, pn_Call_T_result);
461                         res_proj = new_r_Proj(irg, bl, res_proj, mode, 0);
462
463                         exchange(node, res_proj);
464                         return 1;
465                 }
466         }
467         /* should not happen */
468         return 0;
469 }