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