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