betranshlp: cleanup, pretransform end node so keep_alive works in transformers
[libfirm] / ir / lower / lower_intrinsics.c
1 /*
2  * Copyright (C) 1995-2011 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 #include "config.h"
27
28 #include <stdbool.h>
29
30 #include "lowering.h"
31 #include "irop_t.h"
32 #include "irprog_t.h"
33 #include "irnode_t.h"
34 #include "irprog_t.h"
35 #include "irgwalk.h"
36 #include "ircons.h"
37 #include "irgmod.h"
38 #include "irgopt.h"
39 #include "trouts.h"
40 #include "irverify.h"
41 #include "pmap.h"
42 #include "array_t.h"
43 #include "irpass_t.h"
44 #include "iropt_dbg.h"
45 #include "error.h"
46 #include "be.h"
47
48 /** Walker environment. */
49 typedef struct walker_env {
50         pmap     *c_map;              /**< The intrinsic call map. */
51         size_t   nr_of_intrinsics;    /**< statistics */
52         i_instr_record **i_map;       /**< The intrinsic instruction map. */
53 } walker_env_t;
54
55 /**
56  * walker: call all mapper functions
57  */
58 static void call_mapper(ir_node *node, void *env)
59 {
60         walker_env_t *wenv = (walker_env_t*)env;
61         ir_op *op = get_irn_op(node);
62
63         if (op == op_Call) {
64                 ir_node *symconst;
65                 pmap_entry *p;
66                 const i_call_record *r;
67                 ir_entity *ent;
68
69                 symconst = get_Call_ptr(node);
70                 if (! is_Global(symconst))
71                         return;
72
73                 ent = get_Global_entity(symconst);
74                 p   = pmap_find(wenv->c_map, ent);
75
76                 if (p) {
77                         r = (const i_call_record*)p->value;
78                         wenv->nr_of_intrinsics += r->i_mapper(node, r->ctx) ? 1 : 0;
79                 }
80         } else {
81                 if (op->code < (unsigned) ARR_LEN(wenv->i_map)) {
82                         const i_instr_record *r = wenv->i_map[op->code];
83                         /* run all possible mapper */
84                         while (r) {
85                                 if (r->i_mapper(node, r->ctx)) {
86                                         ++wenv->nr_of_intrinsics;
87                                         break;
88                                 }
89                                 r = (const i_instr_record*)r->link;
90                         }
91                 }
92         }
93 }  /* call_mapper */
94
95 /* Go through all graphs and map calls to intrinsic functions. */
96 size_t lower_intrinsics(i_record *list, size_t length, int part_block_used)
97 {
98         size_t         i, n;
99         size_t         n_ops = get_irp_n_opcodes();
100         ir_graph       *irg;
101         pmap           *c_map = pmap_create_ex(length);
102         i_instr_record **i_map;
103         size_t         nr_of_intrinsics = 0;
104         walker_env_t   wenv;
105
106         /* we use the ir_op generic pointers here */
107         NEW_ARR_A(i_instr_record *, i_map, n_ops);
108         memset((void *)i_map, 0, sizeof(*i_map) * n_ops);
109
110         /* fill a map for faster search */
111         for (i = 0; i < length; ++i) {
112                 if (list[i].i_call.kind == INTRINSIC_CALL) {
113                         pmap_insert(c_map, list[i].i_call.i_ent, (void *)&list[i].i_call);
114                 } else {
115                         ir_op *op = list[i].i_instr.op;
116                         assert(op->code < (unsigned) ARR_LEN(i_map));
117
118                         list[i].i_instr.link = i_map[op->code];
119                         i_map[op->code] = &list[i].i_instr;
120                 }
121         }
122
123         wenv.c_map = c_map;
124         wenv.i_map = i_map;
125
126         for (i = 0, n = get_irp_n_irgs(); i < n; ++i) {
127                 irg = get_irp_irg(i);
128
129                 if (part_block_used) {
130                         ir_reserve_resources(irg, IR_RESOURCE_IRN_LINK | IR_RESOURCE_PHI_LIST);
131                         collect_phiprojs(irg);
132                 }
133
134                 wenv.nr_of_intrinsics = 0;
135                 irg_walk_graph(irg, NULL, call_mapper, &wenv);
136
137                 if (part_block_used)
138                         ir_free_resources(irg, IR_RESOURCE_IRN_LINK | IR_RESOURCE_PHI_LIST);
139
140                 if (wenv.nr_of_intrinsics > 0) {
141                         /* Changes detected: we might have added/removed nodes. */
142                         set_irg_outs_inconsistent(irg);
143                         set_irg_callee_info_state(irg, irg_callee_info_inconsistent);
144
145                         /* Exception control flow might have changed / new block might have added. */
146                         set_irg_doms_inconsistent(irg);
147                         set_irg_extblk_inconsistent(irg);
148                         set_irg_loopinfo_inconsistent(irg);
149
150                         /* Calls might be removed/added. */
151                         set_trouts_inconsistent();
152
153                         /* verify here */
154                         irg_verify(irg, VERIFY_NORMAL);
155
156                         /* Optimize it, tuple might be created. */
157                         optimize_graph_df(irg);
158
159                         nr_of_intrinsics += wenv.nr_of_intrinsics;
160                 }
161         }
162         pmap_destroy(c_map);
163
164         return nr_of_intrinsics;
165 }  /* lower_intrinsics */
166
167 typedef struct pass_t {
168         ir_prog_pass_t pass;
169
170         int      part_block_used;
171         size_t   length;
172         i_record list[1];
173 } pass_t;
174
175 /**
176  * Wrapper for running lower_intrinsics() as an ir_prog pass.
177  */
178 static int pass_wrapper(ir_prog *irp, void *context)
179 {
180         pass_t *pass = (pass_t*)context;
181         (void) irp; /* TODO: set current irp, or remove parameter */
182         lower_intrinsics(pass->list, pass->length, pass->part_block_used);
183         /* probably this pass should not run again */
184         return 0;
185 }
186
187 /**
188  * Creates an ir_prog pass for lower_intrinsics.
189  *
190  * @param name             the name of this pass or NULL
191  * @param list             an array of intrinsic map records
192  * @param length           the length of the array
193  * @param part_block_used  set to true if part_block() must be using during lowering
194  */
195 ir_prog_pass_t *lower_intrinsics_pass(
196         const char *name,
197         i_record *list, size_t length, int part_block_used)
198 {
199         pass_t *pass = (pass_t*)xmalloc(sizeof(*pass) + (length-1) * sizeof(pass->list[0]));
200
201         memcpy(pass->list, list, sizeof(list[0]) * length);
202         pass->length          = length;
203         pass->part_block_used = part_block_used;
204
205         return def_prog_pass_constructor(
206                 &pass->pass, name ? name : "lower_intrinsics", pass_wrapper);
207 }  /* lower_intrinsics_pass*/
208
209 /**
210  * Helper function, replace the call by the given node.
211  *
212  * @param irn      the result node
213  * @param call     the call to replace
214  * @param mem      the new mem result
215  * @param reg_jmp  new regular control flow, if NULL, a Jmp will be used
216  * @param exc_jmp  new exception control flow, if reg_jmp == NULL, a Bad will be used
217  */
218 static void replace_call(ir_node *irn, ir_node *call, ir_node *mem, ir_node *reg_jmp, ir_node *exc_jmp)
219 {
220         ir_node  *block = get_nodes_block(call);
221         ir_graph *irg   = get_irn_irg(block);
222
223         if (reg_jmp == NULL) {
224
225                 /* Beware: do we need here a protection against CSE? Better we do it. */
226                 int old_cse = get_opt_cse();
227                 set_opt_cse(0);
228                 reg_jmp = new_r_Jmp(block);
229                 set_opt_cse(old_cse);
230                 exc_jmp = new_r_Bad(irg);
231         }
232         irn = new_r_Tuple(block, 1, &irn);
233
234         turn_into_tuple(call, pn_Call_max);
235         set_Tuple_pred(call, pn_Call_M, mem);
236         set_Tuple_pred(call, pn_Call_X_regular, reg_jmp);
237         set_Tuple_pred(call, pn_Call_X_except, exc_jmp);
238         set_Tuple_pred(call, pn_Call_T_result, irn);
239         set_Tuple_pred(call, pn_Call_P_value_res_base, new_r_Bad(irg));
240 }  /* replace_call */
241
242 /* A mapper for the integer abs. */
243 int i_mapper_abs(ir_node *call, void *ctx)
244 {
245         ir_node  *mem      = get_Call_mem(call);
246         ir_node  *block    = get_nodes_block(call);
247         ir_node  *op       = get_Call_param(call, 0);
248         ir_graph *irg      = get_irn_irg(call);
249         ir_mode  *mode     = get_irn_mode(op);
250         dbg_info *dbg      = get_irn_dbg_info(call);
251         ir_node  *zero     = new_r_Const(irg, get_mode_null(mode));
252         ir_node  *cmp      = new_rd_Cmp(dbg, block, op, zero, ir_relation_less);
253         ir_node  *minus_op = new_rd_Minus(dbg, block, op, mode);
254         ir_node  *mux;
255         arch_allow_ifconv_func allow_ifconv = be_get_backend_param()->allow_ifconv;
256         (void) ctx;
257
258         /* mux allowed by backend? */
259         if (!allow_ifconv(cmp, op, minus_op))
260                 return 0;
261
262         /* construct Mux */
263         mux = new_rd_Mux(dbg, block, cmp, op, minus_op, mode);
264         DBG_OPT_ALGSIM0(call, mux, FS_OPT_RTS_ABS);
265         replace_call(mux, call, mem, NULL, NULL);
266         return 1;
267 }  /* i_mapper_abs */
268
269 /* A mapper for the integer bswap. */
270 int i_mapper_bswap(ir_node *call, void *ctx)
271 {
272         ir_node *mem   = get_Call_mem(call);
273         ir_node *block = get_nodes_block(call);
274         ir_node *op    = get_Call_param(call, 0);
275         ir_type *tp    = get_Call_type(call);
276         dbg_info *dbg  = get_irn_dbg_info(call);
277         ir_node *irn;
278         (void) ctx;
279
280         irn = new_rd_Builtin(dbg, block, get_irg_no_mem(current_ir_graph), 1, &op, ir_bk_bswap, tp);
281         set_irn_pinned(irn, op_pin_state_floats);
282         irn = new_r_Proj(irn, get_irn_mode(op), pn_Builtin_1_result);
283         replace_call(irn, call, mem, NULL, NULL);
284         return 1;
285 }  /* i_mapper_bswap */
286
287 /* A mapper for the alloca() function. */
288 int i_mapper_alloca(ir_node *call, void *ctx)
289 {
290         ir_node *mem   = get_Call_mem(call);
291         ir_node *block = get_nodes_block(call);
292         ir_node *op    = get_Call_param(call, 0);
293         ir_node *irn, *exc, *no_exc;
294         dbg_info *dbg  = get_irn_dbg_info(call);
295         (void) ctx;
296
297         if (mode_is_signed(get_irn_mode(op))) {
298                 ir_mode *mode = get_irn_mode(op);
299                 mode = find_unsigned_mode(mode);
300                 if (mode == NULL) {
301                         panic("Cannot find unsigned mode for %M", mode);
302                 }
303                 op = new_rd_Conv(dbg, block, op, mode);
304         }
305
306         irn    = new_rd_Alloc(dbg, block, mem, op, firm_unknown_type, stack_alloc);
307         mem    = new_rd_Proj(dbg, irn, mode_M, pn_Alloc_M);
308         no_exc = new_rd_Proj(dbg, irn, mode_X, pn_Alloc_X_regular);
309         exc    = new_rd_Proj(dbg, irn, mode_X, pn_Alloc_X_except);
310         irn    = new_rd_Proj(dbg, irn, get_modeP_data(), pn_Alloc_res);
311
312         DBG_OPT_ALGSIM0(call, irn, FS_OPT_RTS_ALLOCA);
313         replace_call(irn, call, mem, no_exc, exc);
314         return 1;
315 }  /* i_mapper_alloca */
316
317 /* A mapper for the floating point sqrt. */
318 int i_mapper_sqrt(ir_node *call, void *ctx)
319 {
320         ir_node   *mem;
321         ir_tarval *tv;
322         ir_node   *op = get_Call_param(call, 0);
323         (void) ctx;
324
325         if (!is_Const(op))
326                 return 0;
327
328         tv = get_Const_tarval(op);
329         if (! tarval_is_null(tv) && !tarval_is_one(tv))
330                 return 0;
331
332         mem = get_Call_mem(call);
333
334         /* sqrt(0) = 0, sqrt(1) = 1 */
335         DBG_OPT_ALGSIM0(call, op, FS_OPT_RTS_SQRT);
336         replace_call(op, call, mem, NULL, NULL);
337         return 1;
338 }  /* i_mapper_sqrt */
339
340 /* A mapper for the floating point cbrt. */
341 int i_mapper_cbrt(ir_node *call, void *ctx)
342 {
343         ir_node   *mem;
344         ir_tarval *tv;
345         ir_node   *op = get_Call_param(call, 0);
346         (void) ctx;
347
348         if (!is_Const(op))
349                 return 0;
350
351         tv = get_Const_tarval(op);
352         if (! tarval_is_null(tv) && !tarval_is_one(tv) && !tarval_is_minus_one(tv))
353                 return 0;
354
355         mem = get_Call_mem(call);
356
357         /* cbrt(0) = 0, cbrt(1) = 1, cbrt(-1) = -1 */
358         DBG_OPT_ALGSIM0(call, op, FS_OPT_RTS_CBRT);
359         replace_call(op, call, mem, NULL, NULL);
360         return 1;
361 }  /* i_mapper_cbrt */
362
363 /* A mapper for the floating point pow. */
364 int i_mapper_pow(ir_node *call, void *ctx)
365 {
366         dbg_info *dbg;
367         ir_node  *mem;
368         ir_node  *left  = get_Call_param(call, 0);
369         ir_node  *right = get_Call_param(call, 1);
370         ir_node  *block = get_nodes_block(call);
371         ir_graph *irg   = get_irn_irg(block);
372         ir_node  *irn, *reg_jmp = NULL, *exc_jmp = NULL;
373         (void) ctx;
374
375         if (is_Const(left) && is_Const_one(left)) {
376                 /* pow (1.0, x) = 1.0 */
377                 irn = left;
378         } else if (is_Const(right)) {
379                 ir_tarval *tv = get_Const_tarval(right);
380                 if (tarval_is_null(tv)) {
381                         /* pow(x, 0.0) = 1.0 */
382                         ir_mode *mode = get_tarval_mode(tv);
383                         irn = new_r_Const(irg, get_mode_one(mode));
384                 } else if (tarval_is_one(tv)) {
385                         /* pow(x, 1.0) = x */
386                         irn = left;
387                 } else if (tarval_is_minus_one(tv)) {
388                         /* pow(x, -1.0) = 1/x */
389                         irn = NULL;
390                 } else
391                         return 0;
392         } else {
393                 return 0;
394         }
395
396         mem = get_Call_mem(call);
397         dbg = get_irn_dbg_info(call);
398
399         if (irn == NULL) {
400                 ir_mode *mode = get_irn_mode(left);
401                 ir_node *div;
402
403                 irn  = new_r_Const(irg, get_mode_one(mode));
404                 div  = new_rd_Div(dbg, block, mem, irn, left, mode, op_pin_state_pinned);
405                 mem  = new_r_Proj(div, mode_M, pn_Div_M);
406                 irn  = new_r_Proj(div, mode, pn_Div_res);
407                 reg_jmp = new_r_Proj(div, mode_X, pn_Div_X_regular);
408                 exc_jmp = new_r_Proj(div, mode_X, pn_Div_X_except);
409         }
410         DBG_OPT_ALGSIM0(call, irn, FS_OPT_RTS_POW);
411         replace_call(irn, call, mem, reg_jmp, exc_jmp);
412         return 1;
413 }  /* i_mapper_pow */
414
415 /* A mapper for the floating point exp. */
416 int i_mapper_exp(ir_node *call, void *ctx)
417 {
418         ir_node *val  = get_Call_param(call, 0);
419         (void) ctx;
420
421         if (is_Const(val) && is_Const_null(val)) {
422                 /* exp(0.0) = 1.0 */
423                 ir_graph *irg  = get_irn_irg(val);
424                 ir_mode *mode  = get_irn_mode(val);
425                 ir_node *irn   = new_r_Const(irg, get_mode_one(mode));
426                 ir_node *mem   = get_Call_mem(call);
427                 DBG_OPT_ALGSIM0(call, irn, FS_OPT_RTS_EXP);
428                 replace_call(irn, call, mem, NULL, NULL);
429                 return 1;
430         }
431         return 0;
432 }  /* i_mapper_exp */
433
434 /**
435  * A mapper for mapping f(0.0) to 0.0.
436  */
437 static int i_mapper_zero_to_zero(ir_node *call, void *ctx, int reason)
438 {
439         ir_node *val  = get_Call_param(call, 0);
440         (void) ctx;
441
442         if (is_Const(val) && is_Const_null(val)) {
443                 /* f(0.0) = 0.0 */
444                 ir_node *mem = get_Call_mem(call);
445                 DBG_OPT_ALGSIM0(call, val, reason);
446                 replace_call(val, call, mem, NULL, NULL);
447                 return 1;
448         }
449         return 0;
450 }  /* i_mapper_zero_to_zero */
451
452 /**
453  * A mapper for mapping f(1.0) to 0.0.
454  */
455 static int i_mapper_one_to_zero(ir_node *call, void *ctx, int reason)
456 {
457         ir_node *val  = get_Call_param(call, 0);
458         (void) ctx;
459
460         if (is_Const(val) && is_Const_one(val)) {
461                 /* acos(1.0) = 0.0 */
462                 ir_graph *irg = get_irn_irg(val);
463                 ir_mode *mode = get_irn_mode(val);
464                 ir_node *irn  = new_r_Const(irg, get_mode_null(mode));
465                 ir_node *mem  = get_Call_mem(call);
466                 DBG_OPT_ALGSIM0(call, irn, reason);
467                 replace_call(irn, call, mem, NULL, NULL);
468                 return 1;
469         }
470         return 0;
471 }  /* i_mapper_one_to_zero */
472
473 /**
474  * A mapper for mapping a functions with the following characteristics:
475  * f(-x)  = f(x).
476  * f(0.0) = 1.0
477  */
478 static int i_mapper_symmetric_zero_to_one(ir_node *call, void *ctx, int reason)
479 {
480         ir_node *val  = get_Call_param(call, 0);
481         (void) ctx;
482
483         if (is_strictConv(val)) {
484                 ir_node *op = get_Conv_op(val);
485                 if (is_Minus(op)) {
486                         /* f(-x) = f(x) with strictConv */
487                         ir_node *block = get_nodes_block(call);
488                         ir_mode *mode  = get_irn_mode(val);
489                         dbg_info *dbg  = get_irn_dbg_info(val);
490
491                         op = get_Minus_op(op);
492                         val = new_rd_Conv(dbg, block, op, mode);
493                         if (is_Conv(val)) {
494                                 /* still a Conv ? */
495                                 set_Conv_strict(val, 1);
496                         }
497                         DBG_OPT_ALGSIM2(call, op, call, FS_OPT_RTS_SYMMETRIC);
498                         set_Call_param(call, 0, val);
499                 }
500         } else if (is_Minus(val)) {
501                 /* f(-x) = f(x) */
502                 val = get_Minus_op(val);
503                 DBG_OPT_ALGSIM2(call, val, call, FS_OPT_RTS_SYMMETRIC);
504                 set_Call_param(call, 0, val);
505         }
506
507         if (is_Const(val) && is_Const_null(val)) {
508                 /* f(0.0) = 1.0 */
509                 ir_graph *irg  = get_irn_irg(val);
510                 ir_mode *mode  = get_irn_mode(val);
511                 ir_node *irn   = new_r_Const(irg, get_mode_one(mode));
512                 ir_node *mem   = get_Call_mem(call);
513                 DBG_OPT_ALGSIM0(call, irn, reason);
514                 replace_call(irn, call, mem, NULL, NULL);
515                 return 1;
516         }
517         return 0;
518 }  /* i_mapper_symmetric_zero_to_one */
519
520 /* A mapper for the floating point log. */
521 int i_mapper_log(ir_node *call, void *ctx)
522 {
523         /* log(1.0) = 0.0 */
524         return i_mapper_one_to_zero(call, ctx, FS_OPT_RTS_LOG);
525 }  /* i_mapper_log */
526
527 /* A mapper for the floating point sin. */
528 int i_mapper_sin(ir_node *call, void *ctx)
529 {
530         /* sin(0.0) = 0.0 */
531         return i_mapper_zero_to_zero(call, ctx, FS_OPT_RTS_SIN);
532 }  /* i_mapper_sin */
533
534 /* A mapper for the floating point cos. */
535 int i_mapper_cos(ir_node *call, void *ctx)
536 {
537         /* cos(0.0) = 1.0, cos(-x) = x */
538         return i_mapper_symmetric_zero_to_one(call, ctx, FS_OPT_RTS_COS);
539 }  /* i_mapper_cos */
540
541 /* A mapper for the floating point tan. */
542 int i_mapper_tan(ir_node *call, void *ctx)
543 {
544         /* tan(0.0) = 0.0 */
545         return i_mapper_zero_to_zero(call, ctx, FS_OPT_RTS_TAN);
546 }  /* i_mapper_tan */
547
548 /* A mapper for the floating point asin. */
549 int i_mapper_asin(ir_node *call, void *ctx)
550 {
551         /* asin(0.0) = 0.0 */
552         return i_mapper_zero_to_zero(call, ctx, FS_OPT_RTS_ASIN);
553 }  /* i_mapper_asin */
554
555 /* A mapper for the floating point acos. */
556 int i_mapper_acos(ir_node *call, void *ctx)
557 {
558         /* acos(1.0) = 0.0 */
559         return i_mapper_one_to_zero(call, ctx, FS_OPT_RTS_ACOS);
560 }  /* i_mapper_acos */
561
562 /* A mapper for the floating point atan. */
563 int i_mapper_atan(ir_node *call, void *ctx)
564 {
565         /* atan(0.0) = 0.0 */
566         return i_mapper_zero_to_zero(call, ctx, FS_OPT_RTS_ATAN);
567 }  /* i_mapper_atan */
568
569 /* A mapper for the floating point sinh. */
570 int i_mapper_sinh(ir_node *call, void *ctx)
571 {
572         /* sinh(0.0) = 0.0 */
573         return i_mapper_zero_to_zero(call, ctx, FS_OPT_RTS_SINH);
574 }  /* i_mapper_sinh */
575
576 /* A mapper for the floating point cosh. */
577 int i_mapper_cosh(ir_node *call, void *ctx)
578 {
579         /* cosh(0.0) = 1.0, cosh(-x) = x */
580         return i_mapper_symmetric_zero_to_one(call, ctx, FS_OPT_RTS_COSH);
581 }  /* i_mapper_cosh */
582
583 /* A mapper for the floating point tanh. */
584 int i_mapper_tanh(ir_node *call, void *ctx)
585 {
586         /* tanh(0.0) = 0.0 */
587         return i_mapper_zero_to_zero(call, ctx, FS_OPT_RTS_TANH);
588 }  /* i_mapper_tanh */
589
590 /**
591  * Return the const entity that is accessed through the pointer ptr or
592  * NULL if there is no entity (or the entity is not constant).
593  *
594  * @param ptr  the pointer
595  */
596 static ir_entity *get_const_entity(ir_node *ptr)
597 {
598         if (is_Global(ptr)) {
599                 ir_entity *ent = get_Global_entity(ptr);
600
601                 if (get_entity_linkage(ent) & IR_LINKAGE_CONSTANT) {
602                         /* a constant entity */
603                         return ent;
604                 }
605         }
606         return NULL;
607 }  /* get_const_entity */
608
609 static bool initializer_val_is_null(ir_initializer_t *init)
610 {
611         ir_tarval *tv;
612
613         if (get_initializer_kind(init) == IR_INITIALIZER_NULL)
614                 return true;
615
616         if (get_initializer_kind(init) == IR_INITIALIZER_TARVAL) {
617                 tv = get_initializer_tarval_value(init);
618         } else if (get_initializer_kind(init) == IR_INITIALIZER_CONST) {
619                 ir_node *irn = get_initializer_const_value(init);
620                 if (!is_Const(irn))
621                         return false;
622                 tv = get_Const_tarval(irn);
623         } else {
624                 return false;
625         }
626
627         return tarval_is_null(tv);
628 }
629
630 /**
631  * Calculate the value of strlen if possible.
632  *
633  * @param ent     the entity
634  * @param res_tp  the result type
635  *
636  * @return a Const node containing the strlen() result or NULL
637  *         if the evaluation fails
638  */
639 static ir_node *eval_strlen(ir_graph *irg, ir_entity *ent, ir_type *res_tp)
640 {
641         ir_type *tp = get_entity_type(ent);
642         ir_mode *mode;
643         ir_initializer_t *initializer;
644         unsigned          size;
645         unsigned          i;
646
647         if (! is_Array_type(tp))
648                 return NULL;
649         tp = get_array_element_type(tp);
650         if (! is_Primitive_type(tp))
651                 return NULL;
652         mode = get_type_mode(tp);
653
654         /* FIXME: This is too restrict, as the type char might be more the 8bits */
655         if (!mode_is_int(mode) || get_mode_size_bits(mode) != 8)
656                 return NULL;
657
658         if (!has_entity_initializer(ent)) {
659                 size_t i, n;
660
661                 n = get_compound_ent_n_values(ent);
662                 for (i = 0; i < n; ++i) {
663                         ir_node *irn = get_compound_ent_value(ent, i);
664
665                         if (! is_Const(irn))
666                                 return NULL;
667
668                         if (is_Const_null(irn)) {
669                                 /* found the length */
670                                 ir_tarval *tv = new_tarval_from_long(i, get_type_mode(res_tp));
671                                 return new_r_Const(irg, tv);
672                         }
673                 }
674                 return NULL;
675         }
676
677         initializer = get_entity_initializer(ent);
678         if (get_initializer_kind(initializer) != IR_INITIALIZER_COMPOUND)
679                 return NULL;
680
681         size = get_initializer_compound_n_entries(initializer);
682         for (i = 0; i < size; ++i) {
683                 ir_initializer_t *val = get_initializer_compound_value(initializer, i);
684                 if (initializer_val_is_null(val)) {
685                         ir_tarval *tv = new_tarval_from_long(i, get_type_mode(res_tp));
686                         return new_r_Const(irg, tv);
687                 }
688         }
689
690         return NULL;
691 }  /* eval_strlen */
692
693 /* A mapper for strlen */
694 int i_mapper_strlen(ir_node *call, void *ctx)
695 {
696         ir_node *s     = get_Call_param(call, 0);
697         ir_entity *ent = get_const_entity(s);
698
699         (void) ctx;
700
701         /* FIXME: this cannot handle constant strings inside struct initializers yet */
702         if (ent != NULL) {
703                 /* a constant entity */
704                 ir_type *tp = get_Call_type(call);
705                 ir_node *irn;
706
707                 tp  = get_method_res_type(tp, 0);
708                 irn = eval_strlen(get_irn_irg(call), ent, tp);
709
710                 if (irn) {
711                         ir_node *mem = get_Call_mem(call);
712                         DBG_OPT_ALGSIM0(call, irn, FS_OPT_RTS_STRLEN);
713                         replace_call(irn, call, mem, NULL, NULL);
714                         return 1;
715                 }
716         }
717         return 0;
718 }  /* i_mapper_strlen */
719
720 /**
721  * Calculate the value of strlen if possible.
722  *
723  * @param left    the left entity
724  * @param right   the right entity
725  * @param res_tp  the result type
726  *
727  * @return a Const node containing the strcmp() result or NULL
728  *         if the evaluation fails
729  */
730 static ir_node *eval_strcmp(ir_graph *irg, ir_entity *left, ir_entity *right,
731                             ir_type *res_tp)
732 {
733         ir_type *tp;
734         ir_mode *mode;
735
736         tp = get_entity_type(left);
737         if (! is_Array_type(tp))
738                 return NULL;
739         tp = get_array_element_type(tp);
740         if (! is_Primitive_type(tp))
741                 return NULL;
742         mode = get_type_mode(tp);
743
744         /* FIXME: This is too restrict, as the type char might be more the 8bits */
745         if (!mode_is_int(mode) || get_mode_size_bits(mode) != 8)
746                 return NULL;
747
748         tp = get_entity_type(right);
749         if (! is_Array_type(tp))
750                 return NULL;
751         tp = get_array_element_type(tp);
752         if (! is_Primitive_type(tp))
753                 return NULL;
754         mode = get_type_mode(tp);
755
756         /* FIXME: This is too restrict, as the type char might be more the 8bits */
757         if (!mode_is_int(mode) || get_mode_size_bits(mode) != 8)
758                 return NULL;
759
760         if (!has_entity_initializer(left) && !has_entity_initializer(right)) {
761                 /* code that uses deprecated compound_graph_path stuff */
762                 size_t n   = get_compound_ent_n_values(left);
763                 size_t n_r = get_compound_ent_n_values(right);
764                 size_t i;
765                 int    res = 0;
766
767                 if (n_r < n)
768                         n = n_r;
769                 for (i = 0; i < n; ++i) {
770                         ir_node *irn;
771                         long v_l, v_r;
772                         ir_tarval *tv;
773
774                         irn = get_compound_ent_value(left, i);
775                         if (! is_Const(irn))
776                                 return NULL;
777                         tv = get_Const_tarval(irn);
778                         v_l = get_tarval_long(tv);
779
780                         irn = get_compound_ent_value(right, i);
781                         if (! is_Const(irn))
782                                 return NULL;
783                         tv = get_Const_tarval(irn);
784                         v_r = get_tarval_long(tv);
785
786                         if (v_l < v_r) {
787                                 res = -1;
788                                 break;
789                         }
790                         if (v_l > v_r) {
791                                 res = +1;
792                                 break;
793                         }
794
795                         if (v_l == 0) {
796                                 res = 0;
797                                 break;
798                         }
799                 }
800                 if (i < n) {
801                         /* we found an end */
802                         ir_tarval *tv = new_tarval_from_long(res, get_type_mode(res_tp));
803                         return new_r_Const(irg, tv);
804                 }
805                 return NULL;
806         }
807
808         /* TODO */
809
810         return NULL;
811 }  /* eval_strcmp */
812
813 /**
814  * Checks if an entity represents the empty string.
815  *
816  * @param ent     the entity
817  *
818  * @return non-zero if ent represents the empty string
819  */
820 static int is_empty_string(ir_entity *ent)
821 {
822         ir_type          *tp = get_entity_type(ent);
823         ir_mode          *mode;
824         ir_node          *irn;
825         ir_initializer_t *initializer;
826         ir_initializer_t *init0;
827
828         if (! is_Array_type(tp))
829                 return 0;
830         tp = get_array_element_type(tp);
831         if (! is_Primitive_type(tp))
832                 return 0;
833         mode = get_type_mode(tp);
834
835         /* FIXME: This is too restrict, as the type char might be more the 8bits */
836         if (!mode_is_int(mode) || get_mode_size_bits(mode) != 8)
837                 return 0;
838
839         if (!has_entity_initializer(ent)) {
840                 /* code for deprecated compound_graph_path stuff */
841                 size_t n = get_compound_ent_n_values(ent);
842                 if (n < 1)
843                         return 0;
844                 irn = get_compound_ent_value(ent, 0);
845
846                 return is_Const(irn) && is_Const_null(irn);
847         }
848
849         initializer = get_entity_initializer(ent);
850         if (get_initializer_kind(initializer) != IR_INITIALIZER_COMPOUND)
851                 return 0;
852
853         if (get_initializer_compound_n_entries(initializer) < 1)
854                 return 0;
855
856         init0 = get_initializer_compound_value(initializer, 0);
857         return initializer_val_is_null(init0);
858 }  /* is_empty_string */
859
860 /* A mapper for strcmp */
861 int i_mapper_strcmp(ir_node *call, void *ctx)
862 {
863         ir_node   *left    = get_Call_param(call, 0);
864         ir_node   *right   = get_Call_param(call, 1);
865         ir_node   *irn     = NULL;
866         ir_node   *exc     = NULL;
867         ir_node   *reg     = NULL;
868         ir_type   *call_tp = get_Call_type(call);
869         ir_type   *res_tp  = get_method_res_type(call_tp, 0);
870         ir_entity *ent_l, *ent_r;
871         ir_type   *char_tp;
872         ir_node   *v;
873
874         (void) ctx;
875
876         /* do some type checks first */
877         if (! is_Primitive_type(res_tp))
878                 return 0;
879         char_tp = get_method_param_type(call_tp, 0);
880         if (char_tp != get_method_param_type(call_tp, 1))
881                 return 0;
882         if (! is_Pointer_type(char_tp))
883                 return 0;
884         char_tp = get_pointer_points_to_type(char_tp);
885
886         if (left == right) {
887                 /* a strcmp(s, s) ==> 0 */
888                 ir_graph *irg  = get_irn_irg(call);
889                 ir_node *mem   = get_Call_mem(call);
890                 ir_mode *mode  = get_type_mode(res_tp);
891
892                 irn = new_r_Const(irg, get_mode_null(mode));
893                 DBG_OPT_ALGSIM0(call, irn, FS_OPT_RTS_STRCMP);
894                 replace_call(irn, call, mem, NULL, NULL);
895                 return 1;
896         }
897         ent_l = get_const_entity(left);
898         ent_r = get_const_entity(right);
899
900         if (ent_l != NULL && ent_r != NULL) {
901                 /* both entities are const, try to evaluate */
902                 irn = eval_strcmp(get_irn_irg(call), ent_l, ent_r, res_tp);
903         } else if (ent_l != NULL) {
904                 if (is_empty_string(ent_l)) {
905                         /* s strcmp("", s) ==> -(*s)*/
906                         v = right;
907                         goto replace_by_call;
908                 }
909         } else if (ent_r != NULL) {
910                 if (is_empty_string(ent_r)) {
911                         /* s strcmp(s, "") ==> (*s) */
912                         ir_node  *mem, *block;
913                         dbg_info *dbg;
914                         ir_mode  *mode;
915
916                         v = left;
917 replace_by_call:
918                         mem   = get_Call_mem(call);
919                         block = get_nodes_block(call);
920                         dbg   = get_irn_dbg_info(call);
921                         mode  = get_type_mode(char_tp);
922
923                         /* replace the strcmp by (*x) */
924                         irn = new_rd_Load(dbg, block, mem, v, mode, cons_none);
925                         mem = new_r_Proj(irn, mode_M, pn_Load_M);
926                         exc = new_r_Proj(irn, mode_X, pn_Load_X_except);
927                         reg = new_r_Proj(irn, mode_X, pn_Load_X_regular);
928                         irn = new_r_Proj(irn, mode, pn_Load_res);
929
930                         /* conv to the result mode */
931                         mode = get_type_mode(res_tp);
932                         irn  = new_rd_Conv(dbg, block, irn, mode);
933
934                         if (v == right) {
935                                 /* negate in the ("", s) case */
936                                 irn = new_rd_Minus(dbg, block, irn, mode);
937                         }
938                 }
939         }
940
941         if (irn != NULL) {
942                 ir_node *mem = get_Call_mem(call);
943                 DBG_OPT_ALGSIM0(call, irn, FS_OPT_RTS_STRCMP);
944                 replace_call(irn, call, mem, reg, exc);
945                 return 1;
946         }
947
948         return 0;
949 }  /* i_mapper_strcmp */
950
951 /* A mapper for strncmp */
952 int i_mapper_strncmp(ir_node *call, void *ctx)
953 {
954         ir_node *left  = get_Call_param(call, 0);
955         ir_node *right = get_Call_param(call, 1);
956         ir_node *len   = get_Call_param(call, 2);
957         ir_node *irn;
958         (void) ctx;
959
960         if (left == right || (is_Const(len) && is_Const_null(len))) {
961                 /* a strncmp(s, s, len) ==> 0 OR
962                    a strncmp(a, b, 0) ==> 0 */
963                 ir_graph  *irg     = get_irn_irg(call);
964                 ir_node   *mem     = get_Call_mem(call);
965                 ir_node   *adr     = get_Call_ptr(call);
966                 ir_entity *ent     = get_SymConst_entity(adr);
967                 ir_type   *call_tp = get_entity_type(ent);
968                 ir_type   *res_tp  = get_method_res_type(call_tp, 0);
969                 ir_mode   *mode    = get_type_mode(res_tp);
970
971                 irn = new_r_Const(irg, get_mode_null(mode));
972                 DBG_OPT_ALGSIM0(call, irn, FS_OPT_RTS_STRNCMP);
973                 replace_call(irn, call, mem, NULL, NULL);
974                 return 1;
975         }
976         return 0;
977 }  /* i_mapper_strncmp */
978
979 /* A mapper for strcpy */
980 int i_mapper_strcpy(ir_node *call, void *ctx)
981 {
982         ir_node *dst = get_Call_param(call, 0);
983         ir_node *src = get_Call_param(call, 1);
984         (void) ctx;
985
986         if (dst == src) {
987                 /* a strcpy(d, s) ==> d */
988                 ir_node *mem = get_Call_mem(call);
989                 ir_node *dst = get_Call_param(call, 0);
990
991                 DBG_OPT_ALGSIM0(call, dst, FS_OPT_RTS_STRCPY);
992                 replace_call(dst, call, mem, NULL, NULL);
993                 return 1;
994         }
995         return 0;
996 }  /* i_mapper_strcpy */
997
998 /* A mapper for memcpy */
999 int i_mapper_memcpy(ir_node *call, void *ctx)
1000 {
1001         ir_node *dst = get_Call_param(call, 0);
1002         ir_node *src = get_Call_param(call, 1);
1003         ir_node *len = get_Call_param(call, 2);
1004         (void) ctx;
1005
1006         if (dst == src || (is_Const(len) && is_Const_null(len))) {
1007                 /* a memcpy(d, d, len) ==> d OR
1008                    a memcpy(d, s, 0) ==> d */
1009                 ir_node *mem = get_Call_mem(call);
1010
1011                 DBG_OPT_ALGSIM0(call, dst, FS_OPT_RTS_MEMCPY);
1012                 replace_call(dst, call, mem, NULL, NULL);
1013                 return 1;
1014         }
1015         return 0;
1016 }  /* i_mapper_memcpy */
1017
1018 /* A mapper for mempcpy */
1019 int i_mapper_mempcpy(ir_node *call, void *ctx)
1020 {
1021         ir_node *dst = get_Call_param(call, 0);
1022         ir_node *src = get_Call_param(call, 1);
1023         ir_node *len = get_Call_param(call, 2);
1024         (void) ctx;
1025
1026         if (dst == src || (is_Const(len) && is_Const_null(len))) {
1027                 /* a memcpy(d, d, len) ==> d + len OR
1028                    a memcpy(d, s, 0) ==> d + 0 */
1029                 dbg_info *dbg = get_irn_dbg_info(call);
1030                 ir_node *mem  = get_Call_mem(call);
1031                 ir_node *blk  = get_nodes_block(call);
1032                 ir_mode *mode = get_irn_mode(dst);
1033                 ir_node *res  = new_rd_Add(dbg, blk, dst, len, mode);
1034
1035                 DBG_OPT_ALGSIM0(call, res, FS_OPT_RTS_MEMPCPY);
1036                 replace_call(res, call, mem, NULL, NULL);
1037                 return 1;
1038         }
1039         return 0;
1040 }  /* i_mapper_mempcpy */
1041
1042 /* A mapper for memmove */
1043 int i_mapper_memmove(ir_node *call, void *ctx)
1044 {
1045         ir_node *dst = get_Call_param(call, 0);
1046         ir_node *src = get_Call_param(call, 1);
1047         ir_node *len = get_Call_param(call, 2);
1048         (void) ctx;
1049
1050         if (dst == src || (is_Const(len) && is_Const_null(len))) {
1051                 /* a memmove(d, d, len) ==> d OR
1052                    a memmove(d, s, 0) ==> d */
1053                 ir_node *mem = get_Call_mem(call);
1054
1055                 DBG_OPT_ALGSIM0(call, dst, FS_OPT_RTS_MEMMOVE);
1056                 replace_call(dst, call, mem, NULL, NULL);
1057                 return 1;
1058         }
1059         return 0;
1060 }  /* i_mapper_memmove */
1061
1062 /* A mapper for memset */
1063 int i_mapper_memset(ir_node *call, void *ctx)
1064 {
1065         ir_node *len = get_Call_param(call, 2);
1066         (void) ctx;
1067
1068         if (is_Const(len) && is_Const_null(len)) {
1069                 /* a memset(d, C, 0) ==> d */
1070                 ir_node *mem = get_Call_mem(call);
1071                 ir_node *dst = get_Call_param(call, 0);
1072
1073                 DBG_OPT_ALGSIM0(call, dst, FS_OPT_RTS_MEMSET);
1074                 replace_call(dst, call, mem, NULL, NULL);
1075                 return 1;
1076         }
1077         return 0;
1078 }  /* i_mapper_memset */
1079
1080 /* A mapper for memcmp */
1081 int i_mapper_memcmp(ir_node *call, void *ctx)
1082 {
1083         ir_node *left  = get_Call_param(call, 0);
1084         ir_node *right = get_Call_param(call, 1);
1085         ir_node *len   = get_Call_param(call, 2);
1086         ir_node *irn;
1087         (void) ctx;
1088
1089         if (left == right || (is_Const(len) && is_Const_null(len))) {
1090                 /* a memcmp(s, s, len) ==> 0 OR
1091                    a memcmp(a, b, 0) ==> 0 */
1092                 ir_graph  *irg     = get_irn_irg(call);
1093                 ir_node   *mem     = get_Call_mem(call);
1094                 ir_node   *adr     = get_Call_ptr(call);
1095                 ir_entity *ent     = get_SymConst_entity(adr);
1096                 ir_type   *call_tp = get_entity_type(ent);
1097                 ir_type   *res_tp  = get_method_res_type(call_tp, 0);
1098                 ir_mode   *mode    = get_type_mode(res_tp);
1099
1100                 irn = new_r_Const(irg, get_mode_null(mode));
1101                 DBG_OPT_ALGSIM0(call, irn, FS_OPT_RTS_STRNCMP);
1102                 replace_call(irn, call, mem, NULL, NULL);
1103                 return 1;
1104         }
1105         return 0;
1106 }  /* i_mapper_memcmp */
1107
1108 /**
1109  * Returns the result mode of a node.
1110  */
1111 static ir_mode *get_irn_res_mode(ir_node *node)
1112 {
1113         switch (get_irn_opcode(node)) {
1114         case iro_Load:   return get_Load_mode(node);
1115         case iro_Div:    return get_Div_resmode(node);
1116         case iro_Mod:    return get_Mod_resmode(node);
1117         default: return NULL;
1118         }
1119 }  /* get_irn_res_mode */
1120
1121 #define LMAX(a, b) ((a) > (b) ? (a) : (b))
1122
1123 /* A mapper for mapping unsupported instructions to runtime calls. */
1124 int i_mapper_RuntimeCall(ir_node *node, runtime_rt *rt)
1125 {
1126         int i, j, arity, first, n_param, n_res;
1127         long n_proj;
1128         ir_type *mtp;
1129         ir_node *mem, *bl, *call, *addr, *res_proj;
1130         ir_node **in;
1131         ir_graph *irg;
1132         symconst_symbol sym;
1133         ir_mode *mode = get_irn_mode(node);
1134
1135         if (mode != rt->mode)
1136                 return 0;
1137         /* check if the result modes match */
1138         if (mode == mode_T && rt->res_mode != NULL) {
1139                 mode = get_irn_res_mode(node);
1140                 if (mode != rt->res_mode)
1141                         return 0;
1142         }
1143
1144         arity = get_irn_arity(node);
1145         if (arity <= 0)
1146                 return 0;
1147
1148         mtp     = get_entity_type(rt->ent);
1149         n_param = get_method_n_params(mtp);
1150         irg     = current_ir_graph;
1151
1152         mem = get_irn_n(node, 0);
1153         if (get_irn_mode(mem) != mode_M) {
1154                 mem = new_r_NoMem(irg);
1155                 first = 0;
1156         } else
1157                 first = 1;
1158
1159         /* check if the modes of the predecessors match the parameter modes */
1160         if (arity - first != n_param)
1161                 return 0;
1162
1163         for (i = first, j = 0; i < arity; ++i, ++j) {
1164                 ir_type *param_tp = get_method_param_type(mtp, j);
1165                 ir_node *pred = get_irn_n(node, i);
1166
1167                 if (get_type_mode(param_tp) != get_irn_mode(pred))
1168                         return 0;
1169         }
1170
1171         n_res = get_method_n_ress(mtp);
1172
1173         /* step 0: calculate the number of needed Proj's */
1174         n_proj = 0;
1175         n_proj = LMAX(n_proj, rt->mem_proj_nr + 1);
1176         n_proj = LMAX(n_proj, rt->regular_proj_nr + 1);
1177         n_proj = LMAX(n_proj, rt->exc_proj_nr + 1);
1178         n_proj = LMAX(n_proj, rt->exc_mem_proj_nr + 1);
1179         n_proj = LMAX(n_proj, rt->res_proj_nr + 1);
1180
1181         if (n_proj > 0) {
1182                 if (rt->mode != mode_T) /* must be mode_T */
1183                         return 0;
1184         } else {
1185                 if (n_res > 0)
1186                         /* must match */
1187                         if (get_type_mode(get_method_res_type(mtp, 0)) != rt->mode)
1188                                 return 0;
1189         }
1190
1191         /* ok, when we are here, the number of predecessors match as well as the parameter modes */
1192         bl = get_nodes_block(node);
1193
1194         in = NULL;
1195         if (n_param > 0) {
1196                 NEW_ARR_A(ir_node *, in, n_param);
1197                 for (i = 0; i < n_param; ++i)
1198                         in[i] = get_irn_n(node, first + i);
1199         }
1200
1201         /* step 1: create the call */
1202         sym.entity_p = rt->ent;
1203         addr = new_r_SymConst(irg, mode_P_code, sym, symconst_addr_ent);
1204         call = new_rd_Call(get_irn_dbg_info(node), bl, mem, addr, n_param, in, mtp);
1205         set_irn_pinned(call, get_irn_pinned(node));
1206
1207         if (n_res > 0)
1208                 res_proj = new_r_Proj(call, mode_T, pn_Call_T_result);
1209         else
1210                 res_proj = NULL;
1211
1212         if (n_proj > 0) {
1213                 n_proj += n_res - 1;
1214
1215                 /* we are ready */
1216                 turn_into_tuple(node, n_proj);
1217
1218                 for (i = 0; i < n_proj; ++i)
1219                         set_Tuple_pred(node, i, new_r_Bad(irg));
1220                 if (rt->mem_proj_nr >= 0)
1221                         set_Tuple_pred(node, rt->mem_proj_nr, new_r_Proj(call, mode_M, pn_Call_M));
1222                 if (!is_NoMem(mem)) {
1223                         /* Exceptions can only be handled with real memory */
1224                         if (rt->regular_proj_nr >= 0)
1225                                 set_Tuple_pred(node, rt->regular_proj_nr, new_r_Proj(call, mode_X, pn_Call_X_regular));
1226                         if (rt->exc_proj_nr >= 0)
1227                                 set_Tuple_pred(node, rt->exc_proj_nr, new_r_Proj(call, mode_X, pn_Call_X_except));
1228                         if (rt->exc_mem_proj_nr >= 0)
1229                                 set_Tuple_pred(node, rt->mem_proj_nr, new_r_Proj(call, mode_M, pn_Call_M));
1230                 }
1231
1232                 if (rt->res_proj_nr >= 0)
1233                         for (i = 0; i < n_res; ++i)
1234                                 set_Tuple_pred(node, rt->res_proj_nr + i,
1235                                 new_r_Proj(res_proj, get_type_mode(get_method_res_type(mtp, i)), i));
1236                         return 1;
1237         } else {
1238                 /* only one return value supported */
1239                 if (n_res > 0) {
1240                         ir_mode *mode = get_type_mode(get_method_res_type(mtp, 0));
1241
1242                         res_proj = new_r_Proj(call, mode_T, pn_Call_T_result);
1243                         res_proj = new_r_Proj(res_proj, mode, 0);
1244
1245                         exchange(node, res_proj);
1246                         return 1;
1247                 }
1248         }
1249         /* should not happen */
1250         return 0;
1251 }  /* i_mapper_RuntimeCall */