dab9fc8cc0dd8279579cce8a446617fed86c933d
[libfirm] / lower_hl.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   Lower some High-level constructs, moved from the firmlower.
23  * @author  Boris Boesler, Goetz Lindenmaier, Michael Beck
24  * @version $Id$
25  */
26 #include "config.h"
27
28 #include "lowering.h"
29 #include "irmode_t.h"
30 #include "irnode_t.h"
31 #include "entity_t.h"
32 #include "typerep.h"
33 #include "irprog_t.h"
34 #include "ircons.h"
35 #include "irhooks.h"
36 #include "irgmod.h"
37 #include "irgwalk.h"
38 #include "irtools.h"
39 #include "irpass_t.h"
40
41 /**
42  * Lower a Sel node. Do not touch Sels accessing entities on the frame type.
43  */
44 static void lower_sel(ir_node *sel)
45 {
46         ir_graph *irg = current_ir_graph;
47         ir_entity   *ent;
48         ir_node  *newn, *cnst, *index, *ptr, *bl;
49         tarval   *tv;
50         ir_mode  *basemode, *mode, *mode_Int;
51         ir_type  *basetyp, *owner;
52         dbg_info *dbg;
53
54         assert(is_Sel(sel));
55
56         /* Do not lower frame type/global offset table access: must be lowered by the backend. */
57         ptr = get_Sel_ptr(sel);
58         if (ptr == get_irg_frame(current_ir_graph))
59                 return;
60
61         ent   = get_Sel_entity(sel);
62         owner = get_entity_owner(ent);
63
64         /*
65          * Cannot handle value param entities or frame type entities here.
66          * Must be lowered by the backend.
67          */
68         if (is_value_param_type(owner) || is_frame_type(owner))
69                 return;
70
71         dbg  = get_irn_dbg_info(sel);
72         mode = get_irn_mode(sel);
73
74         mode_Int = get_reference_mode_signed_eq(mode);
75
76         /* TLS access, must be handled by the linker */
77         if (get_tls_type() == owner) {
78                 symconst_symbol sym;
79
80                 sym.entity_p = ent;
81                 bl = get_nodes_block(sel);
82
83                 cnst = new_rd_SymConst(dbg, irg, mode, sym, symconst_addr_ent);
84                 newn = new_rd_Add(dbg, bl, ptr, cnst, mode);
85         } else {
86                 /* not TLS */
87
88                 assert(get_type_state(get_entity_owner(ent)) == layout_fixed);
89                 assert(get_type_state(get_entity_type(ent)) == layout_fixed);
90
91                 bl = get_nodes_block(sel);
92                 if (0 < get_Sel_n_indexs(sel)) {
93                         /* an Array access */
94                         basetyp = get_entity_type(ent);
95                         if (is_Primitive_type(basetyp))
96                                 basemode = get_type_mode(basetyp);
97                         else
98                                 basemode = mode_P_data;
99
100                         assert(basemode && "no mode for lowering Sel");
101                         assert((get_mode_size_bits(basemode) % 8 == 0) && "can not deal with unorthodox modes");
102                         index = get_Sel_index(sel, 0);
103
104                         if (is_Array_type(owner)) {
105                                 ir_type *arr_ty = owner;
106                                 int      dims   = get_array_n_dimensions(arr_ty);
107                                 int     *map    = ALLOCAN(int, dims);
108                                 ir_node *last_size;
109                                 int      i;
110
111                                 assert(dims == get_Sel_n_indexs(sel)
112                                         && "array dimension must match number of indices of Sel node");
113
114                                 for (i = 0; i < dims; i++) {
115                                         int order = get_array_order(arr_ty, i);
116
117                                         assert(order < dims &&
118                                                 "order of a dimension must be smaller than the arrays dim");
119                                         map[order] = i;
120                                 }
121                                 newn = get_Sel_ptr(sel);
122
123                                 /* Size of the array element */
124                                 tv = new_tarval_from_long(get_type_size_bytes(basetyp), mode_Int);
125                                 last_size = new_rd_Const(dbg, irg, tv);
126
127                                 /*
128                                  * We compute the offset part of dimension d_i recursively
129                                  * with the the offset part of dimension d_{i-1}
130                                  *
131                                  *     off_0 = sizeof(array_element_type);
132                                  *     off_i = (u_i - l_i) * off_{i-1}  ; i >= 1
133                                  *
134                                  * whereas u_i is the upper bound of the current dimension
135                                  * and l_i the lower bound of the current dimension.
136                                  */
137                                 for (i = dims - 1; i >= 0; i--) {
138                                         int dim = map[i];
139                                         ir_node *lb, *ub, *elms, *n, *ind;
140
141                                         elms = NULL;
142                                         lb = get_array_lower_bound(arr_ty, dim);
143                                         ub = get_array_upper_bound(arr_ty, dim);
144
145                                         assert(irg == current_ir_graph);
146                                         if (! is_Unknown(lb))
147                                                 lb = new_rd_Conv(dbg, bl, copy_const_value(get_irn_dbg_info(sel), lb), mode_Int);
148                                         else
149                                                 lb = NULL;
150
151                                         if (! is_Unknown(ub))
152                                                 ub = new_rd_Conv(dbg, bl, copy_const_value(get_irn_dbg_info(sel), ub), mode_Int);
153                                         else
154                                                 ub = NULL;
155
156                                         /*
157                                          * If the array has more than one dimension, lower and upper
158                                          * bounds have to be set in the non-last dimension.
159                                          */
160                                         if (i > 0) {
161                                                 assert(lb != NULL && "lower bound has to be set in multi-dim array");
162                                                 assert(ub != NULL && "upper bound has to be set in multi-dim array");
163
164                                                 /* Elements in one Dimension */
165                                                 elms = new_rd_Sub(dbg, bl, ub, lb, mode_Int);
166                                         }
167
168                                         ind = new_rd_Conv(dbg, bl, get_Sel_index(sel, dim), mode_Int);
169
170                                         /*
171                                          * Normalize index, id lower bound is set, also assume
172                                          * lower bound == 0
173                                          */
174                                         if (lb != NULL)
175                                                 ind = new_rd_Sub(dbg, bl, ind, lb, mode_Int);
176
177                                         n = new_rd_Mul(dbg, bl, ind, last_size, mode_Int);
178
179                                         /*
180                                          * see comment above.
181                                          */
182                                         if (i > 0)
183                                                 last_size = new_rd_Mul(dbg, bl, last_size, elms, mode_Int);
184
185                                         newn = new_rd_Add(dbg, bl, newn, n, mode);
186                                 }
187                         } else {
188                                 /* no array type */
189                                 ir_mode *idx_mode = get_irn_mode(index);
190                                 tarval *tv = new_tarval_from_long(get_mode_size_bytes(basemode), idx_mode);
191
192                                 newn = new_rd_Add(dbg, bl, get_Sel_ptr(sel),
193                                         new_rd_Mul(dbg, bl, index,
194                                         new_r_Const(irg, tv),
195                                         idx_mode),
196                                         mode);
197                         }
198                 } else if (is_Method_type(get_entity_type(ent)) &&
199                            is_Class_type(owner) &&
200                            (owner != get_glob_type()) &&
201                            (!is_frame_type(owner)))  {
202                         ir_node *add;
203                         ir_mode *ent_mode = get_type_mode(get_entity_type(ent));
204
205                         /* We need an additional load when accessing methods from a dispatch table. */
206                         tv   = new_tarval_from_long(get_entity_offset(ent), mode_Int);
207                         cnst = new_rd_Const(dbg, irg, tv);
208                         add  = new_rd_Add(dbg, bl, get_Sel_ptr(sel), cnst, mode);
209 #ifdef DO_CACHEOPT  /* cacheopt version */
210                         newn = new_rd_Load(dbg, bl, get_Sel_mem(sel), sel, ent_mode, 0);
211                         cacheopt_map_addrs_register_node(newn);
212                         set_Load_ptr(newn, add);
213 #else /* normal code */
214                         newn = new_rd_Load(dbg, bl, get_Sel_mem(sel), add, ent_mode, 0);
215 #endif
216                         newn = new_r_Proj(bl, newn, ent_mode, pn_Load_res);
217
218                 } else if (get_entity_owner(ent) != get_glob_type()) {
219                         int offset;
220
221                         /* replace Sel by add(obj, const(ent.offset)) */
222                         newn   = get_Sel_ptr(sel);
223                         offset = get_entity_offset(ent);
224                         if (offset != 0) {
225                                 ir_mode *mode_UInt = get_reference_mode_unsigned_eq(mode);
226
227                                 tv = new_tarval_from_long(offset, mode_UInt);
228                                 cnst = new_r_Const(irg, tv);
229                                 newn = new_rd_Add(dbg, bl, newn, cnst, mode);
230                         }
231                 } else {
232                         /* global_type */
233                         newn = new_rd_SymConst_addr_ent(NULL, irg, mode, ent, firm_unknown_type);
234                 }
235         }
236         /* run the hooks */
237         hook_lower(sel);
238
239         exchange(sel, newn);
240 }  /* lower_sel */
241
242 /**
243  * Lower a all possible SymConst nodes.
244  */
245 static void lower_symconst(ir_node *symc)
246 {
247         ir_node       *newn;
248         ir_type       *tp;
249         ir_entity     *ent;
250         tarval        *tv;
251         ir_enum_const *ec;
252         ir_mode       *mode;
253
254         switch (get_SymConst_kind(symc)) {
255         case symconst_type_tag:
256                 assert(!"SymConst kind symconst_type_tag not implemented");
257                 break;
258         case symconst_type_size:
259                 /* rewrite the SymConst node by a Const node */
260                 tp   = get_SymConst_type(symc);
261                 assert(get_type_state(tp) == layout_fixed);
262                 mode = get_irn_mode(symc);
263                 newn = new_Const_long(mode, get_type_size_bytes(tp));
264                 assert(newn);
265                 /* run the hooks */
266                 hook_lower(symc);
267                 exchange(symc, newn);
268                 break;
269         case symconst_type_align:
270                 /* rewrite the SymConst node by a Const node */
271                 tp   = get_SymConst_type(symc);
272                 assert(get_type_state(tp) == layout_fixed);
273                 mode = get_irn_mode(symc);
274                 newn = new_Const_long(mode, get_type_alignment_bytes(tp));
275                 assert(newn);
276                 /* run the hooks */
277                 hook_lower(symc);
278                 exchange(symc, newn);
279                 break;
280         case symconst_addr_name:
281                 /* do not rewrite - pass info to back end */
282                 break;
283         case symconst_addr_ent:
284                 /* leave */
285                 break;
286         case symconst_ofs_ent:
287                 /* rewrite the SymConst node by a Const node */
288                 ent  = get_SymConst_entity(symc);
289                 assert(get_type_state(get_entity_type(ent)) == layout_fixed);
290                 mode = get_irn_mode(symc);
291                 newn = new_Const_long(mode, get_entity_offset(ent));
292                 assert(newn);
293                 /* run the hooks */
294                 hook_lower(symc);
295                 exchange(symc, newn);
296                 break;
297         case symconst_enum_const:
298                 /* rewrite the SymConst node by a Const node */
299                 ec   = get_SymConst_enum(symc);
300                 assert(get_type_state(get_enumeration_owner(ec)) == layout_fixed);
301                 tv   = get_enumeration_value(ec);
302                 newn = new_Const(tv);
303                 assert(newn);
304                 /* run the hooks */
305                 hook_lower(symc);
306                 exchange(symc, newn);
307                 break;
308
309         default:
310                 assert(!"unknown SymConst kind");
311                 break;
312         }
313 }  /* lower_symconst */
314
315 /**
316  * Checks, whether a size is an integral size
317  *
318  * @param size  the size on bits
319  */
320 static int is_integral_size(int size)
321 {
322         /* must be a 2^n */
323         if (size & (size-1))
324                 return 0;
325         /* must be at least byte size */
326         return size >= 8;
327 }  /* is_integral_size */
328
329 /**
330  * lower bitfield load access.
331  *
332  * @param proj  the Proj(result) node
333  * @param load  the Load node
334  */
335 static void lower_bitfields_loads(ir_node *proj, ir_node *load)
336 {
337         ir_node *sel = get_Load_ptr(load);
338         ir_node *block, *n_proj, *res, *ptr;
339         ir_entity *ent;
340         ir_type *bf_type;
341         ir_mode *bf_mode, *mode;
342         int offset, bit_offset, bits, bf_bits, old_cse;
343         dbg_info *db;
344
345         if (!is_Sel(sel))
346                 return;
347
348         ent     = get_Sel_entity(sel);
349         bf_type = get_entity_type(ent);
350
351         /* must be a bitfield type */
352         if (!is_Primitive_type(bf_type) || get_primitive_base_type(bf_type) == NULL)
353                 return;
354
355         /* We have a bitfield access, if either a bit offset is given, or
356            the size is not integral. */
357         bf_mode = get_type_mode(bf_type);
358         if (! bf_mode)
359                 return;
360
361         mode       = get_irn_mode(proj);
362         block      = get_nodes_block(proj);
363         bf_bits    = get_mode_size_bits(bf_mode);
364         bit_offset = get_entity_offset_bits_remainder(ent);
365
366         if (bit_offset == 0 && is_integral_size(bf_bits) && bf_mode == get_Load_mode(load))
367                 return;
368
369         bits   = get_mode_size_bits(mode);
370         offset = get_entity_offset(ent);
371
372         /*
373          * ok, here we are: now convert the Proj_mode_bf(Load) into And(Shr(Proj_mode(Load)) for unsigned
374          * and Shr(Shl(Proj_mode(load)) for signed
375          */
376
377         /* abandon bitfield sel */
378         ptr = get_Sel_ptr(sel);
379         db  = get_irn_dbg_info(sel);
380         ptr = new_rd_Add(db, block, ptr, new_Const_long(mode_Is, offset), get_irn_mode(ptr));
381
382         set_Load_ptr(load, ptr);
383         set_Load_mode(load, mode);
384
385
386         /* create new proj, switch off CSE or we may get the old one back */
387         old_cse = get_opt_cse();
388         set_opt_cse(0);
389         res = n_proj = new_r_Proj(block, load, mode, pn_Load_res);
390         set_opt_cse(old_cse);
391
392         if (mode_is_signed(mode)) { /* signed */
393                 int shift_count_up    = bits - (bf_bits + bit_offset);
394                 int shift_count_down  = bits - bf_bits;
395
396                 if (shift_count_up) {
397                         res = new_r_Shl(block, res,     new_Const_long(mode_Iu, shift_count_up), mode);
398                 }
399                 if (shift_count_down) {
400                         res = new_r_Shrs(block, res, new_Const_long(mode_Iu, shift_count_down), mode);
401                 }
402         } else { /* unsigned */
403                 int shift_count_down  = bit_offset;
404                 unsigned mask = ((unsigned)-1) >> (bits - bf_bits);
405
406                 if (shift_count_down) {
407                         res = new_r_Shr(block, res,     new_Const_long(mode_Iu, shift_count_down), mode);
408                 }
409                 if (bits != bf_bits) {
410                         res = new_r_And(block, res, new_Const_long(mode, mask), mode);
411                 }
412         }
413
414         exchange(proj, res);
415 }  /* lower_bitfields_loads */
416
417 /**
418  * lower bitfield store access.
419  *
420  * @todo: It adds a load which may produce an exception!
421  */
422 static void lower_bitfields_stores(ir_node *store)
423 {
424         ir_node   *sel = get_Store_ptr(store);
425         ir_node   *ptr, *value;
426         ir_entity *ent;
427         ir_type *bf_type;
428         ir_mode *bf_mode, *mode;
429         ir_node *mem, *irn, *block;
430         unsigned mask, neg_mask;
431         int bf_bits, bits_mask, offset, bit_offset;
432         dbg_info *db;
433
434         /* check bitfield access */
435         if (!is_Sel(sel))
436                 return;
437
438         ent     = get_Sel_entity(sel);
439         bf_type = get_entity_type(ent);
440
441         /* must be a bitfield type */
442         if (!is_Primitive_type(bf_type) || get_primitive_base_type(bf_type) == NULL)
443                 return;
444
445         /* We have a bitfield access, if either a bit offset is given, or
446            the size is not integral. */
447         bf_mode = get_type_mode(bf_type);
448         if (! bf_mode)
449                 return;
450
451         value      = get_Store_value(store);
452         mode       = get_irn_mode(value);
453         block      = get_nodes_block(store);
454
455         bf_bits    = get_mode_size_bits(bf_mode);
456         bit_offset = get_entity_offset_bits_remainder(ent);
457
458         if (bit_offset == 0 && is_integral_size(bf_bits) && bf_mode == get_irn_mode(value))
459                 return;
460
461         /*
462          * ok, here we are: now convert the Store(Sel(), value) into Or(And(Load(Sel),c), And(Value,c))
463          */
464         mem        = get_Store_mem(store);
465         offset     = get_entity_offset(ent);
466
467         bits_mask = get_mode_size_bits(mode) - bf_bits;
468         mask = ((unsigned)-1) >> bits_mask;
469         mask <<= bit_offset;
470         neg_mask = ~mask;
471
472         /* abandon bitfield sel */
473         ptr = get_Sel_ptr(sel);
474         db  = get_irn_dbg_info(sel);
475         ptr = new_rd_Add(db, block, ptr, new_Const_long(mode_Is, offset), get_irn_mode(ptr));
476
477         if (neg_mask) {
478                 /* there are some bits, normal case */
479                 irn  = new_r_Load( block, mem, ptr, mode, 0);
480                 mem  = new_r_Proj( block, irn, mode_M, pn_Load_M);
481                 irn  = new_r_Proj( block, irn, mode, pn_Load_res);
482
483                 irn = new_r_And(block, irn, new_Const_long(mode, neg_mask), mode);
484
485                 if (bit_offset > 0) {
486                         value = new_r_Shl(block, value, new_Const_long(mode_Iu, bit_offset), mode);
487                 }
488
489                 value = new_r_And(block, value, new_Const_long(mode, mask), mode);
490
491                 value = new_r_Or(block, value, irn, mode);
492         }
493
494         set_Store_mem(store, mem);
495         set_Store_value(store, value);
496         set_Store_ptr(store, ptr);
497 }  /* lower_bitfields_stores */
498
499 /**
500  * Lowers unaligned Loads.
501  */
502 static void lower_unaligned_Load(ir_node *load)
503 {
504   (void) load;
505         /* NYI */
506 }
507
508 /**
509  * Lowers unaligned Stores
510  */
511 static void lower_unaligned_Store(ir_node *store)
512 {
513         (void) store;
514         /* NYI */
515 }
516
517 /**
518  * lowers IR-nodes, called from walker
519  */
520 static void lower_irnode(ir_node *irn, void *env)
521 {
522         (void) env;
523         switch (get_irn_opcode(irn)) {
524         case iro_Sel:
525                 lower_sel(irn);
526                 break;
527         case iro_SymConst:
528                 lower_symconst(irn);
529                 break;
530         case iro_Load:
531                 if (env != NULL && get_Load_align(irn) == align_non_aligned)
532                         lower_unaligned_Load(irn);
533                 break;
534         case iro_Store:
535                 if (env != NULL && get_Store_align(irn) == align_non_aligned)
536                         lower_unaligned_Store(irn);
537                 break;
538         case iro_Cast:
539                 exchange(irn, get_Cast_op(irn));
540                 break;
541         default:
542                 break;
543         }
544 }
545
546 /**
547  * Walker: lowers IR-nodes for bitfield access
548  */
549 static void lower_bf_access(ir_node *irn, void *env)
550 {
551         (void) env;
552         switch (get_irn_opcode(irn)) {
553         case iro_Proj:
554         {
555                 long proj     = get_Proj_proj(irn);
556                 ir_node *pred = get_Proj_pred(irn);
557
558                 if (proj == pn_Load_res && is_Load(pred))
559                         lower_bitfields_loads(irn, pred);
560                 break;
561         }
562         case iro_Store:
563                 lower_bitfields_stores(irn);
564                 break;
565
566         default:
567                 break;
568         }
569 }
570
571 /*
572  * Replaces SymConsts by a real constant if possible.
573  * Replace Sel nodes by address computation.  Also resolves array access.
574  * Handle Bitfields by added And/Or calculations.
575  */
576 void lower_highlevel_graph(ir_graph *irg, int lower_bitfields)
577 {
578         if (lower_bitfields) {
579                 /* First step: lower bitfield access: must be run as long as Sels still
580                  * exists. */
581                 irg_walk_graph(irg, NULL, lower_bf_access, NULL);
582         }
583
584         /* Finally: lower SymConst-Size and Sel nodes, Casts, unaligned Load/Stores. */
585         irg_walk_graph(irg, NULL, lower_irnode, NULL);
586
587         set_irg_outs_inconsistent(irg);
588 }
589
590 struct pass_t {
591         ir_graph_pass_t pass;
592         int            lower_bitfields;
593 };
594
595 /**
596  * Wrapper for running lower_highlevel_graph() as an ir_graph pass.
597  */
598 static int lower_highlevel_graph_wrapper(ir_graph *irg, void *context)
599 {
600         struct pass_t *pass = context;
601
602         lower_highlevel_graph(irg, pass->lower_bitfields);
603         return 0;
604 }  /* lower_highlevel_graph_wrapper */
605
606 ir_graph_pass_t *lower_highlevel_graph_pass(const char *name, int lower_bitfields)
607 {
608         struct pass_t *pass = XMALLOCZ(struct pass_t);
609
610         pass->lower_bitfields = lower_bitfields;
611         return def_graph_pass_constructor(
612                 &pass->pass, name ? name : "lower_hl", lower_highlevel_graph_wrapper);
613 }  /* lower_highlevel_graph_pass */
614
615 /*
616  * does the same as lower_highlevel() for all nodes on the const code irg
617  */
618 void lower_const_code(void)
619 {
620         walk_const_code(NULL, lower_irnode, NULL);
621 }  /* lower_const_code */
622
623 ir_prog_pass_t *lower_const_code_pass(const char *name)
624 {
625         return def_prog_pass(name ? name : "lower_const_code", lower_const_code);
626 }
627
628 /*
629  * Replaces SymConsts by a real constant if possible.
630  * Replace Sel nodes by address computation.  Also resolves array access.
631  * Handle Bitfields by added And/Or calculations.
632  */
633 void lower_highlevel(int lower_bitfields)
634 {
635         int i, n;
636
637         n = get_irp_n_irgs();
638         for (i = 0; i < n; ++i) {
639                 ir_graph *irg = get_irp_irg(i);
640                 lower_highlevel_graph(irg, lower_bitfields);
641         }
642         lower_const_code();
643 }  /* lower_highlevel */