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