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