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