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