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