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