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