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