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