2 * Copyright (C) 1995-2008 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
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.
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.
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
22 * @brief Lower some High-level constructs, moved from the firmlower.
23 * @author Boris Boesler, Goetz Lindenmaier, Michael Beck
42 * Lower a Sel node. Do not touch Sels accessing entities on the frame type.
44 static void lower_sel(ir_node *sel) {
45 ir_graph *irg = current_ir_graph;
47 ir_node *newn, *cnst, *index, *ptr, *bl;
49 ir_mode *basemode, *mode, *mode_Int;
50 ir_type *basetyp, *owner;
55 /* Do not lower frame type/global offset table access: must be lowered by the backend. */
56 ptr = get_Sel_ptr(sel);
57 if (ptr == get_irg_frame(current_ir_graph))
60 ent = get_Sel_entity(sel);
61 owner = get_entity_owner(ent);
64 * Cannot handle value param entities or frame type entities here.
65 * Must be lowered by the backend.
67 if (is_value_param_type(owner) || is_frame_type(owner))
70 dbg = get_irn_dbg_info(sel);
71 mode = get_irn_mode(sel);
73 mode_Int = get_reference_mode_signed_eq(mode);
75 /* TLS access, must be handled by the linker */
76 if (get_tls_type() == owner) {
80 bl = get_nodes_block(sel);
82 cnst = new_rd_SymConst(dbg, irg, mode, sym, symconst_addr_ent);
83 newn = new_rd_Add(dbg, bl, ptr, cnst, mode);
87 assert(get_type_state(get_entity_owner(ent)) == layout_fixed);
88 assert(get_type_state(get_entity_type(ent)) == layout_fixed);
90 bl = get_nodes_block(sel);
91 if (0 < get_Sel_n_indexs(sel)) {
93 basetyp = get_entity_type(ent);
94 if (is_Primitive_type(basetyp))
95 basemode = get_type_mode(basetyp);
97 basemode = mode_P_data;
99 assert(basemode && "no mode for lowering Sel");
100 assert((get_mode_size_bits(basemode) % 8 == 0) && "can not deal with unorthodox modes");
101 index = get_Sel_index(sel, 0);
103 if (is_Array_type(owner)) {
104 ir_type *arr_ty = owner;
105 int dims = get_array_n_dimensions(arr_ty);
106 int *map = ALLOCAN(int, dims);
110 assert(dims == get_Sel_n_indexs(sel)
111 && "array dimension must match number of indices of Sel node");
113 for (i = 0; i < dims; i++) {
114 int order = get_array_order(arr_ty, i);
116 assert(order < dims &&
117 "order of a dimension must be smaller than the arrays dim");
120 newn = get_Sel_ptr(sel);
122 /* Size of the array element */
123 tv = new_tarval_from_long(get_type_size_bytes(basetyp), mode_Int);
124 last_size = new_rd_Const(dbg, irg, tv);
127 * We compute the offset part of dimension d_i recursively
128 * with the the offset part of dimension d_{i-1}
130 * off_0 = sizeof(array_element_type);
131 * off_i = (u_i - l_i) * off_{i-1} ; i >= 1
133 * whereas u_i is the upper bound of the current dimension
134 * and l_i the lower bound of the current dimension.
136 for (i = dims - 1; i >= 0; i--) {
138 ir_node *lb, *ub, *elms, *n, *ind;
141 lb = get_array_lower_bound(arr_ty, dim);
142 ub = get_array_upper_bound(arr_ty, dim);
144 assert(irg == current_ir_graph);
145 if (! is_Unknown(lb))
146 lb = new_rd_Conv(dbg, bl, copy_const_value(get_irn_dbg_info(sel), lb), mode_Int);
150 if (! is_Unknown(ub))
151 ub = new_rd_Conv(dbg, bl, copy_const_value(get_irn_dbg_info(sel), ub), mode_Int);
156 * If the array has more than one dimension, lower and upper
157 * bounds have to be set in the non-last dimension.
160 assert(lb != NULL && "lower bound has to be set in multi-dim array");
161 assert(ub != NULL && "upper bound has to be set in multi-dim array");
163 /* Elements in one Dimension */
164 elms = new_rd_Sub(dbg, bl, ub, lb, mode_Int);
167 ind = new_rd_Conv(dbg, bl, get_Sel_index(sel, dim), mode_Int);
170 * Normalize index, id lower bound is set, also assume
174 ind = new_rd_Sub(dbg, bl, ind, lb, mode_Int);
176 n = new_rd_Mul(dbg, bl, ind, last_size, mode_Int);
182 last_size = new_rd_Mul(dbg, bl, last_size, elms, mode_Int);
184 newn = new_rd_Add(dbg, bl, newn, n, mode);
188 ir_mode *idx_mode = get_irn_mode(index);
189 tarval *tv = new_tarval_from_long(get_mode_size_bytes(basemode), idx_mode);
191 newn = new_rd_Add(dbg, bl, get_Sel_ptr(sel),
192 new_rd_Mul(dbg, bl, index,
193 new_r_Const(irg, tv),
197 } else if (is_Method_type(get_entity_type(ent)) &&
198 is_Class_type(owner) &&
199 (owner != get_glob_type()) &&
200 (!is_frame_type(owner))) {
202 ir_mode *ent_mode = get_type_mode(get_entity_type(ent));
204 /* We need an additional load when accessing methods from a dispatch table. */
205 tv = new_tarval_from_long(get_entity_offset(ent), mode_Int);
206 cnst = new_rd_Const(dbg, irg, tv);
207 add = new_rd_Add(dbg, bl, get_Sel_ptr(sel), cnst, mode);
208 #ifdef DO_CACHEOPT /* cacheopt version */
209 newn = new_rd_Load(dbg, bl, get_Sel_mem(sel), sel, ent_mode, 0);
210 cacheopt_map_addrs_register_node(newn);
211 set_Load_ptr(newn, add);
212 #else /* normal code */
213 newn = new_rd_Load(dbg, bl, get_Sel_mem(sel), add, ent_mode, 0);
215 newn = new_r_Proj(bl, newn, ent_mode, pn_Load_res);
217 } else if (get_entity_owner(ent) != get_glob_type()) {
220 /* replace Sel by add(obj, const(ent.offset)) */
221 assert(!(get_entity_allocation(ent) == allocation_static &&
222 (get_entity_n_overwrites(ent) == 0 && get_entity_n_overwrittenby(ent) == 0)));
223 newn = get_Sel_ptr(sel);
224 offset = get_entity_offset(ent);
226 ir_mode *mode_UInt = get_reference_mode_unsigned_eq(mode);
228 tv = new_tarval_from_long(offset, mode_UInt);
229 cnst = new_r_Const(irg, tv);
230 newn = new_rd_Add(dbg, bl, newn, cnst, mode);
234 newn = new_rd_SymConst_addr_ent(NULL, irg, mode, ent, firm_unknown_type);
244 * Lower a all possible SymConst nodes.
246 static void lower_symconst(ir_node *symc) {
254 switch (get_SymConst_kind(symc)) {
255 case symconst_type_tag:
256 assert(!"SymConst kind symconst_type_tag not implemented");
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));
267 exchange(symc, newn);
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));
278 exchange(symc, newn);
280 case symconst_addr_name:
281 /* do not rewrite - pass info to back end */
283 case symconst_addr_ent:
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));
295 exchange(symc, newn);
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);
306 exchange(symc, newn);
310 assert(!"unknown SymConst kind");
313 } /* lower_symconst */
316 * Checks, whether a size is an integral size
318 * @param size the size on bits
320 static int is_integral_size(int size) {
324 /* must be at least byte size */
326 } /* is_integral_size */
329 * lower bitfield load access.
331 * @param proj the Proj(result) node
332 * @param load the Load node
334 static void lower_bitfields_loads(ir_node *proj, ir_node *load) {
335 ir_node *sel = get_Load_ptr(load);
336 ir_node *block, *n_proj, *res, *ptr;
339 ir_mode *bf_mode, *mode;
340 int offset, bit_offset, bits, bf_bits, old_cse;
346 ent = get_Sel_entity(sel);
347 bf_type = get_entity_type(ent);
349 /* must be a bitfield type */
350 if (!is_Primitive_type(bf_type) || get_primitive_base_type(bf_type) == NULL)
353 /* We have a bitfield access, if either a bit offset is given, or
354 the size is not integral. */
355 bf_mode = get_type_mode(bf_type);
359 mode = get_irn_mode(proj);
360 block = get_nodes_block(proj);
361 bf_bits = get_mode_size_bits(bf_mode);
362 bit_offset = get_entity_offset_bits_remainder(ent);
364 if (bit_offset == 0 && is_integral_size(bf_bits) && bf_mode == get_Load_mode(load))
367 bits = get_mode_size_bits(mode);
368 offset = get_entity_offset(ent);
371 * ok, here we are: now convert the Proj_mode_bf(Load) into And(Shr(Proj_mode(Load)) for unsigned
372 * and Shr(Shl(Proj_mode(load)) for signed
375 /* abandon bitfield sel */
376 ptr = get_Sel_ptr(sel);
377 db = get_irn_dbg_info(sel);
378 ptr = new_rd_Add(db, block, ptr, new_Const_long(mode_Is, offset), get_irn_mode(ptr));
380 set_Load_ptr(load, ptr);
381 set_Load_mode(load, mode);
384 /* create new proj, switch off CSE or we may get the old one back */
385 old_cse = get_opt_cse();
387 res = n_proj = new_r_Proj(block, load, mode, pn_Load_res);
388 set_opt_cse(old_cse);
390 if (mode_is_signed(mode)) { /* signed */
391 int shift_count_up = bits - (bf_bits + bit_offset);
392 int shift_count_down = bits - bf_bits;
394 if (shift_count_up) {
395 res = new_r_Shl(block, res, new_Const_long(mode_Iu, shift_count_up), mode);
397 if (shift_count_down) {
398 res = new_r_Shrs(block, res, new_Const_long(mode_Iu, shift_count_down), mode);
400 } else { /* unsigned */
401 int shift_count_down = bit_offset;
402 unsigned mask = ((unsigned)-1) >> (bits - bf_bits);
404 if (shift_count_down) {
405 res = new_r_Shr(block, res, new_Const_long(mode_Iu, shift_count_down), mode);
407 if (bits != bf_bits) {
408 res = new_r_And(block, res, new_Const_long(mode, mask), mode);
413 } /* lower_bitfields_loads */
416 * lower bitfield store access.
418 * @todo: It adds a load which may produce an exception!
420 static void lower_bitfields_stores(ir_node *store) {
421 ir_node *sel = get_Store_ptr(store);
422 ir_node *ptr, *value;
425 ir_mode *bf_mode, *mode;
426 ir_node *mem, *irn, *block;
427 unsigned mask, neg_mask;
428 int bf_bits, bits_mask, offset, bit_offset;
431 /* check bitfield access */
435 ent = get_Sel_entity(sel);
436 bf_type = get_entity_type(ent);
438 /* must be a bitfield type */
439 if (!is_Primitive_type(bf_type) || get_primitive_base_type(bf_type) == NULL)
442 /* We have a bitfield access, if either a bit offset is given, or
443 the size is not integral. */
444 bf_mode = get_type_mode(bf_type);
448 value = get_Store_value(store);
449 mode = get_irn_mode(value);
450 block = get_nodes_block(store);
452 bf_bits = get_mode_size_bits(bf_mode);
453 bit_offset = get_entity_offset_bits_remainder(ent);
455 if (bit_offset == 0 && is_integral_size(bf_bits) && bf_mode == get_irn_mode(value))
459 * ok, here we are: now convert the Store(Sel(), value) into Or(And(Load(Sel),c), And(Value,c))
461 mem = get_Store_mem(store);
462 offset = get_entity_offset(ent);
464 bits_mask = get_mode_size_bits(mode) - bf_bits;
465 mask = ((unsigned)-1) >> bits_mask;
469 /* abandon bitfield sel */
470 ptr = get_Sel_ptr(sel);
471 db = get_irn_dbg_info(sel);
472 ptr = new_rd_Add(db, block, ptr, new_Const_long(mode_Is, offset), get_irn_mode(ptr));
475 /* there are some bits, normal case */
476 irn = new_r_Load( block, mem, ptr, mode, 0);
477 mem = new_r_Proj( block, irn, mode_M, pn_Load_M);
478 irn = new_r_Proj( block, irn, mode, pn_Load_res);
480 irn = new_r_And(block, irn, new_Const_long(mode, neg_mask), mode);
482 if (bit_offset > 0) {
483 value = new_r_Shl(block, value, new_Const_long(mode_Iu, bit_offset), mode);
486 value = new_r_And(block, value, new_Const_long(mode, mask), mode);
488 value = new_r_Or(block, value, irn, mode);
491 set_Store_mem(store, mem);
492 set_Store_value(store, value);
493 set_Store_ptr(store, ptr);
494 } /* lower_bitfields_stores */
497 * Lowers unaligned Loads.
499 static void lower_unaligned_Load(ir_node *load) {
505 * Lowers unaligned Stores
507 static void lower_unaligned_Store(ir_node *store) {
513 * lowers IR-nodes, called from walker
515 static void lower_irnode(ir_node *irn, void *env) {
517 switch (get_irn_opcode(irn)) {
525 if (env != NULL && get_Load_align(irn) == align_non_aligned)
526 lower_unaligned_Load(irn);
529 if (env != NULL && get_Store_align(irn) == align_non_aligned)
530 lower_unaligned_Store(irn);
533 exchange(irn, get_Cast_op(irn));
541 * Walker: lowers IR-nodes for bitfield access
543 static void lower_bf_access(ir_node *irn, void *env) {
545 switch (get_irn_opcode(irn)) {
548 long proj = get_Proj_proj(irn);
549 ir_node *pred = get_Proj_pred(irn);
551 if (proj == pn_Load_res && is_Load(pred))
552 lower_bitfields_loads(irn, pred);
556 lower_bitfields_stores(irn);
562 } /* lower_bf_access */
565 * Replaces SymConsts by a real constant if possible.
566 * Replace Sel nodes by address computation. Also resolves array access.
567 * Handle Bitfields by added And/Or calculations.
569 void lower_highlevel_graph(ir_graph *irg, int lower_bitfields) {
571 if (lower_bitfields) {
572 /* First step: lower bitfield access: must be run as long as Sels still
574 irg_walk_graph(irg, NULL, lower_bf_access, NULL);
577 /* Finally: lower SymConst-Size and Sel nodes, Casts, unaligned Load/Stores. */
578 irg_walk_graph(irg, NULL, lower_irnode, NULL);
579 } /* lower_highlevel_graph */
582 ir_graph_pass_t pass;
587 * Wrapper for running lower_highlevel_graph() as an ir_graph pass.
589 static int lower_highlevel_graph_wrapper(ir_graph *irg, void *context) {
590 struct pass_t *pass = context;
592 lower_highlevel_graph(irg, pass->lower_bitfields);
594 } /* lower_highlevel_graph_wrapper */
596 ir_graph_pass_t *lower_highlevel_graph_pass(const char *name, int lower_bitfields) {
597 struct pass_t *pass = XMALLOCZ(struct pass_t);
599 pass->lower_bitfields = lower_bitfields;
600 return def_graph_pass_constructor(
601 &pass->pass, name ? name : "lower_hl", lower_highlevel_graph_wrapper);
602 } /* lower_highlevel_graph_pass */
605 * does the same as lower_highlevel() for all nodes on the const code irg
607 void lower_const_code(void) {
608 walk_const_code(NULL, lower_irnode, NULL);
609 } /* lower_const_code */
611 ir_prog_pass_t *lower_const_code_pass(const char *name) {
612 return def_prog_pass(name ? name : "lower_const_code", lower_const_code);
616 * Replaces SymConsts by a real constant if possible.
617 * Replace Sel nodes by address computation. Also resolves array access.
618 * Handle Bitfields by added And/Or calculations.
620 void lower_highlevel(int lower_bitfields) {
623 n = get_irp_n_irgs();
624 for (i = 0; i < n; ++i) {
625 ir_graph *irg = get_irp_irg(i);
626 lower_highlevel_graph(irg, lower_bitfields);
629 } /* lower_highlevel */