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