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