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