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