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