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