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)
46 ir_graph *irg = current_ir_graph;
48 ir_node *newn, *cnst, *index, *ptr, *bl;
50 ir_mode *basemode, *mode, *mode_Int;
51 ir_type *basetyp, *owner;
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))
61 ent = get_Sel_entity(sel);
62 owner = get_entity_owner(ent);
65 * Cannot handle value param entities or frame type entities here.
66 * Must be lowered by the backend.
68 if (is_value_param_type(owner) || is_frame_type(owner))
71 dbg = get_irn_dbg_info(sel);
72 mode = get_irn_mode(sel);
74 mode_Int = get_reference_mode_signed_eq(mode);
76 assert(get_type_state(get_entity_owner(ent)) == layout_fixed);
77 assert(get_type_state(get_entity_type(ent)) == layout_fixed);
79 bl = get_nodes_block(sel);
80 if (0 < get_Sel_n_indexs(sel)) {
82 basetyp = get_entity_type(ent);
83 if (is_Primitive_type(basetyp))
84 basemode = get_type_mode(basetyp);
86 basemode = mode_P_data;
88 assert(basemode && "no mode for lowering Sel");
89 assert((get_mode_size_bits(basemode) % 8 == 0) && "can not deal with unorthodox modes");
90 index = get_Sel_index(sel, 0);
92 if (is_Array_type(owner)) {
93 ir_type *arr_ty = owner;
94 int dims = get_array_n_dimensions(arr_ty);
95 int *map = ALLOCAN(int, dims);
99 assert(dims == get_Sel_n_indexs(sel)
100 && "array dimension must match number of indices of Sel node");
102 for (i = 0; i < dims; i++) {
103 int order = get_array_order(arr_ty, i);
105 assert(order < dims &&
106 "order of a dimension must be smaller than the arrays dim");
109 newn = get_Sel_ptr(sel);
111 /* Size of the array element */
112 tv = new_tarval_from_long(get_type_size_bytes(basetyp), mode_Int);
113 last_size = new_rd_Const(dbg, irg, tv);
116 * We compute the offset part of dimension d_i recursively
117 * with the the offset part of dimension d_{i-1}
119 * off_0 = sizeof(array_element_type);
120 * off_i = (u_i - l_i) * off_{i-1} ; i >= 1
122 * whereas u_i is the upper bound of the current dimension
123 * and l_i the lower bound of the current dimension.
125 for (i = dims - 1; i >= 0; i--) {
127 ir_node *lb, *ub, *elms, *n, *ind;
130 lb = get_array_lower_bound(arr_ty, dim);
131 ub = get_array_upper_bound(arr_ty, dim);
133 assert(irg == current_ir_graph);
134 if (! is_Unknown(lb))
135 lb = new_rd_Conv(dbg, bl, copy_const_value(get_irn_dbg_info(sel), lb, bl), mode_Int);
139 if (! is_Unknown(ub))
140 ub = new_rd_Conv(dbg, bl, copy_const_value(get_irn_dbg_info(sel), ub, bl), mode_Int);
145 * If the array has more than one dimension, lower and upper
146 * bounds have to be set in the non-last dimension.
149 assert(lb != NULL && "lower bound has to be set in multi-dim array");
150 assert(ub != NULL && "upper bound has to be set in multi-dim array");
152 /* Elements in one Dimension */
153 elms = new_rd_Sub(dbg, bl, ub, lb, mode_Int);
156 ind = new_rd_Conv(dbg, bl, get_Sel_index(sel, dim), mode_Int);
159 * Normalize index, id lower bound is set, also assume
163 ind = new_rd_Sub(dbg, bl, ind, lb, mode_Int);
165 n = new_rd_Mul(dbg, bl, ind, last_size, mode_Int);
171 last_size = new_rd_Mul(dbg, bl, last_size, elms, mode_Int);
173 newn = new_rd_Add(dbg, bl, newn, n, mode);
177 ir_mode *idx_mode = get_irn_mode(index);
178 ir_tarval *tv = new_tarval_from_long(get_mode_size_bytes(basemode), idx_mode);
180 newn = new_rd_Add(dbg, bl, get_Sel_ptr(sel),
181 new_rd_Mul(dbg, bl, index,
182 new_r_Const(irg, tv),
186 } else if (is_Method_type(get_entity_type(ent)) &&
187 is_Class_type(owner) &&
188 (owner != get_glob_type()) &&
189 (!is_frame_type(owner))) {
191 ir_mode *ent_mode = get_type_mode(get_entity_type(ent));
193 /* We need an additional load when accessing methods from a dispatch table. */
194 tv = new_tarval_from_long(get_entity_offset(ent), mode_Int);
195 cnst = new_rd_Const(dbg, irg, tv);
196 add = new_rd_Add(dbg, bl, get_Sel_ptr(sel), cnst, mode);
197 newn = new_rd_Load(dbg, bl, get_Sel_mem(sel), add, ent_mode, cons_none);
198 newn = new_r_Proj(newn, ent_mode, pn_Load_res);
200 } else if (get_entity_owner(ent) != get_glob_type()) {
203 /* replace Sel by add(obj, const(ent.offset)) */
204 newn = get_Sel_ptr(sel);
205 offset = get_entity_offset(ent);
207 ir_mode *mode_UInt = get_reference_mode_unsigned_eq(mode);
209 tv = new_tarval_from_long(offset, mode_UInt);
210 cnst = new_r_Const(irg, tv);
211 newn = new_rd_Add(dbg, bl, newn, cnst, mode);
215 newn = new_rd_SymConst_addr_ent(NULL, irg, mode, ent);
225 * Lower a all possible SymConst nodes.
227 static void lower_symconst(ir_node *symc)
237 switch (get_SymConst_kind(symc)) {
238 case symconst_type_tag:
239 assert(!"SymConst kind symconst_type_tag not implemented");
241 case symconst_type_size:
242 /* rewrite the SymConst node by a Const node */
243 irg = get_irn_irg(symc);
244 tp = get_SymConst_type(symc);
245 assert(get_type_state(tp) == layout_fixed);
246 mode = get_irn_mode(symc);
247 newn = new_r_Const_long(irg, mode, get_type_size_bytes(tp));
251 exchange(symc, newn);
253 case symconst_type_align:
254 /* rewrite the SymConst node by a Const node */
255 irg = get_irn_irg(symc);
256 tp = get_SymConst_type(symc);
257 assert(get_type_state(tp) == layout_fixed);
258 mode = get_irn_mode(symc);
259 newn = new_r_Const_long(irg, mode, get_type_alignment_bytes(tp));
263 exchange(symc, newn);
265 case symconst_addr_ent:
268 case symconst_ofs_ent:
269 /* rewrite the SymConst node by a Const node */
270 irg = get_irn_irg(symc);
271 ent = get_SymConst_entity(symc);
272 assert(get_type_state(get_entity_type(ent)) == layout_fixed);
273 mode = get_irn_mode(symc);
274 newn = new_r_Const_long(irg, mode, get_entity_offset(ent));
278 exchange(symc, newn);
280 case symconst_enum_const:
281 /* rewrite the SymConst node by a Const node */
282 irg = get_irn_irg(symc);
283 ec = get_SymConst_enum(symc);
284 assert(get_type_state(get_enumeration_owner(ec)) == layout_fixed);
285 tv = get_enumeration_value(ec);
286 newn = new_r_Const(irg, tv);
290 exchange(symc, newn);
294 assert(!"unknown SymConst kind");
297 } /* lower_symconst */
300 * Checks, whether a size is an integral size
302 * @param size the size on bits
304 static int is_integral_size(int size)
309 /* must be at least byte size */
311 } /* is_integral_size */
314 * lower bitfield load access.
316 * @param proj the Proj(result) node
317 * @param load the Load node
319 static void lower_bitfields_loads(ir_node *proj, ir_node *load)
321 ir_node *sel = get_Load_ptr(load);
322 ir_node *block, *n_proj, *res, *ptr;
326 ir_mode *bf_mode, *mode;
327 int offset, bit_offset, bits, bf_bits, old_cse;
333 ent = get_Sel_entity(sel);
334 bf_type = get_entity_type(ent);
336 /* must be a bitfield type */
337 if (!is_Primitive_type(bf_type) || get_primitive_base_type(bf_type) == NULL)
340 /* We have a bitfield access, if either a bit offset is given, or
341 the size is not integral. */
342 bf_mode = get_type_mode(bf_type);
346 mode = get_irn_mode(proj);
347 block = get_nodes_block(proj);
348 bf_bits = get_mode_size_bits(bf_mode);
349 bit_offset = get_entity_offset_bits_remainder(ent);
351 if (bit_offset == 0 && is_integral_size(bf_bits) && bf_mode == get_Load_mode(load))
354 bits = get_mode_size_bits(mode);
355 offset = get_entity_offset(ent);
358 * ok, here we are: now convert the Proj_mode_bf(Load) into And(Shr(Proj_mode(Load)) for unsigned
359 * and Shr(Shl(Proj_mode(load)) for signed
362 /* abandon bitfield sel */
363 irg = get_irn_irg(sel);
364 ptr = get_Sel_ptr(sel);
365 db = get_irn_dbg_info(sel);
366 ptr = new_rd_Add(db, block, ptr, new_r_Const_long(irg, mode_Is, offset), get_irn_mode(ptr));
368 set_Load_ptr(load, ptr);
369 set_Load_mode(load, mode);
372 /* create new proj, switch off CSE or we may get the old one back */
373 old_cse = get_opt_cse();
375 res = n_proj = new_r_Proj(load, mode, pn_Load_res);
376 set_opt_cse(old_cse);
378 if (mode_is_signed(mode)) { /* signed */
379 int shift_count_up = bits - (bf_bits + bit_offset);
380 int shift_count_down = bits - bf_bits;
382 if (shift_count_up) {
383 res = new_r_Shl(block, res, new_r_Const_long(irg, mode_Iu, shift_count_up), mode);
385 if (shift_count_down) {
386 res = new_r_Shrs(block, res, new_r_Const_long(irg, mode_Iu, shift_count_down), mode);
388 } else { /* unsigned */
389 int shift_count_down = bit_offset;
390 unsigned mask = ((unsigned)-1) >> (bits - bf_bits);
392 if (shift_count_down) {
393 res = new_r_Shr(block, res, new_r_Const_long(irg, mode_Iu, shift_count_down), mode);
395 if (bits != bf_bits) {
396 res = new_r_And(block, res, new_r_Const_long(irg, mode, mask), mode);
401 } /* lower_bitfields_loads */
404 * lower bitfield store access.
406 * @todo: It adds a load which may produce an exception!
408 static void lower_bitfields_stores(ir_node *store)
410 ir_node *sel = get_Store_ptr(store);
411 ir_node *ptr, *value;
414 ir_mode *bf_mode, *mode;
415 ir_node *mem, *irn, *block;
417 unsigned mask, neg_mask;
418 int bf_bits, bits_mask, offset, bit_offset;
421 /* check bitfield access */
425 ent = get_Sel_entity(sel);
426 bf_type = get_entity_type(ent);
428 /* must be a bitfield type */
429 if (!is_Primitive_type(bf_type) || get_primitive_base_type(bf_type) == NULL)
432 /* We have a bitfield access, if either a bit offset is given, or
433 the size is not integral. */
434 bf_mode = get_type_mode(bf_type);
438 value = get_Store_value(store);
439 mode = get_irn_mode(value);
440 block = get_nodes_block(store);
442 bf_bits = get_mode_size_bits(bf_mode);
443 bit_offset = get_entity_offset_bits_remainder(ent);
445 if (bit_offset == 0 && is_integral_size(bf_bits) && bf_mode == get_irn_mode(value))
449 * ok, here we are: now convert the Store(Sel(), value) into Or(And(Load(Sel),c), And(Value,c))
451 mem = get_Store_mem(store);
452 offset = get_entity_offset(ent);
454 bits_mask = get_mode_size_bits(mode) - bf_bits;
455 mask = ((unsigned)-1) >> bits_mask;
459 /* abandon bitfield sel */
460 irg = get_irn_irg(sel);
461 ptr = get_Sel_ptr(sel);
462 db = get_irn_dbg_info(sel);
463 ptr = new_rd_Add(db, block, ptr, new_r_Const_long(irg, mode_Is, offset), get_irn_mode(ptr));
466 /* there are some bits, normal case */
467 irn = new_r_Load(block, mem, ptr, mode, cons_none);
468 mem = new_r_Proj(irn, mode_M, pn_Load_M);
469 irn = new_r_Proj(irn, mode, pn_Load_res);
471 irn = new_r_And(block, irn, new_r_Const_long(irg, mode, neg_mask), mode);
473 if (bit_offset > 0) {
474 value = new_r_Shl(block, value, new_r_Const_long(irg, mode_Iu, bit_offset), mode);
477 value = new_r_And(block, value, new_r_Const_long(irg, mode, mask), mode);
479 value = new_r_Or(block, value, irn, mode);
482 set_Store_mem(store, mem);
483 set_Store_value(store, value);
484 set_Store_ptr(store, ptr);
485 } /* lower_bitfields_stores */
488 * lowers IR-nodes, called from walker
490 static void lower_irnode(ir_node *irn, void *env)
493 switch (get_irn_opcode(irn)) {
501 exchange(irn, get_Cast_op(irn));
509 * Walker: lowers IR-nodes for bitfield access
511 static void lower_bf_access(ir_node *irn, void *env)
514 switch (get_irn_opcode(irn)) {
517 long proj = get_Proj_proj(irn);
518 ir_node *pred = get_Proj_pred(irn);
520 if (proj == pn_Load_res && is_Load(pred))
521 lower_bitfields_loads(irn, pred);
525 lower_bitfields_stores(irn);
534 * Replaces SymConsts by a real constant if possible.
535 * Replace Sel nodes by address computation. Also resolves array access.
536 * Handle Bitfields by added And/Or calculations.
538 void lower_highlevel_graph(ir_graph *irg, int lower_bitfields)
540 if (lower_bitfields) {
541 /* First step: lower bitfield access: must be run as long as Sels still
543 irg_walk_graph(irg, NULL, lower_bf_access, NULL);
546 /* Finally: lower SymConst-Size and Sel nodes, Casts, unaligned Load/Stores. */
547 irg_walk_graph(irg, NULL, lower_irnode, NULL);
549 set_irg_outs_inconsistent(irg);
552 typedef struct pass_t {
553 ir_graph_pass_t pass;
558 * Wrapper for running lower_highlevel_graph() as an ir_graph pass.
560 static int lower_highlevel_graph_wrapper(ir_graph *irg, void *context)
562 pass_t *pass = (pass_t*)context;
564 lower_highlevel_graph(irg, pass->lower_bitfields);
566 } /* lower_highlevel_graph_wrapper */
568 ir_graph_pass_t *lower_highlevel_graph_pass(const char *name, int lower_bitfields)
570 pass_t *pass = XMALLOCZ(pass_t);
572 pass->lower_bitfields = lower_bitfields;
573 return def_graph_pass_constructor(
574 &pass->pass, name ? name : "lower_hl", lower_highlevel_graph_wrapper);
575 } /* lower_highlevel_graph_pass */
578 * does the same as lower_highlevel() for all nodes on the const code irg
580 void lower_const_code(void)
582 walk_const_code(NULL, lower_irnode, NULL);
583 } /* lower_const_code */
585 ir_prog_pass_t *lower_const_code_pass(const char *name)
587 return def_prog_pass(name ? name : "lower_const_code", lower_const_code);
591 * Replaces SymConsts by a real constant if possible.
592 * Replace Sel nodes by address computation. Also resolves array access.
593 * Handle Bitfields by added And/Or calculations.
595 void lower_highlevel(int lower_bitfields)
599 n = get_irp_n_irgs();
600 for (i = 0; i < n; ++i) {
601 ir_graph *irg = get_irp_irg(i);
602 lower_highlevel_graph(irg, lower_bitfields);
605 } /* lower_highlevel */