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 Representation of opcode of intermediate operation.
23 * @author Christian Schaefer, Goetz Lindenmaier, Michael Beck
32 #include "irbackedge_t.h"
35 #include "irverify_t.h"
36 #include "reassoc_t.h"
41 static ir_op **opcodes;
42 /** the available next opcode */
43 static unsigned next_iro = iro_MaxOpcode;
45 static ir_type *default_get_type_attr(const ir_node *node);
46 static ir_entity *default_get_entity_attr(const ir_node *node);
47 static unsigned default_hash_node(const ir_node *node);
48 static void default_copy_attr(ir_graph *irg, const ir_node *old_node,
51 ir_op *new_ir_op(unsigned code, const char *name, op_pin_state p,
52 irop_flags flags, op_arity opar, int op_index,
55 ir_op *res = XMALLOCZ(ir_op);
58 res->name = new_id_from_chars(name, strlen(name));
60 res->attr_size = attr_size;
63 res->op_index = op_index;
66 memset(&res->ops, 0, sizeof(res->ops));
67 res->ops.hash = default_hash_node;
68 res->ops.copy_attr = default_copy_attr;
69 res->ops.get_type_attr = default_get_type_attr;
70 res->ops.get_entity_attr = default_get_entity_attr;
73 size_t len = ARR_LEN(opcodes);
74 if ((size_t)code >= len) {
75 ARR_RESIZE(ir_op*, opcodes, (size_t)code+1);
76 memset(&opcodes[len], 0, (code-len+1) * sizeof(opcodes[0]));
78 if (opcodes[code] != NULL)
79 panic("opcode registered twice");
87 void free_ir_op(ir_op *code)
89 hook_free_ir_op(code);
91 assert(opcodes[code->code] == code);
92 opcodes[code->code] = NULL;
97 unsigned ir_get_n_opcodes(void)
99 return ARR_LEN(opcodes);
102 ir_op *ir_get_opcode(unsigned code)
104 assert((size_t)code < ARR_LEN(opcodes));
105 return opcodes[code];
108 void ir_clear_opcodes_generic_func(void)
110 size_t n = ir_get_n_opcodes();
113 for (i = 0; i < n; ++i) {
114 ir_op *op = ir_get_opcode(i);
116 op->ops.generic = (op_func)NULL;
120 void ir_op_set_memory_index(ir_op *op, int memory_index)
122 assert(op->flags & irop_flag_uses_memory);
123 op->memory_index = memory_index;
126 void ir_op_set_fragile_indices(ir_op *op, int pn_x_regular, int pn_x_except)
128 assert(op->flags & irop_flag_fragile);
129 op->pn_x_regular = pn_x_regular;
130 op->pn_x_except = pn_x_except;
133 const char *get_op_name (const ir_op *op)
135 return get_id_str(op->name);
138 unsigned (get_op_code)(const ir_op *op)
140 return get_op_code_(op);
143 ident *(get_op_ident)(const ir_op *op)
145 return get_op_ident_(op);
148 const char *get_op_pin_state_name(op_pin_state s)
151 #define XXX(s) case s: return #s
152 XXX(op_pin_state_floats);
153 XXX(op_pin_state_pinned);
154 XXX(op_pin_state_exc_pinned);
155 XXX(op_pin_state_mem_pinned);
161 op_pin_state (get_op_pinned)(const ir_op *op)
163 return get_op_pinned_(op);
166 void set_op_pinned(ir_op *op, op_pin_state pinned)
168 if (op == op_Block || op == op_Phi || is_op_cfopcode(op)) return;
169 op->pin_state = pinned;
172 unsigned get_next_ir_opcode(void)
177 unsigned get_next_ir_opcodes(unsigned num)
179 unsigned base = next_iro;
184 op_func (get_generic_function_ptr)(const ir_op *op)
186 return get_generic_function_ptr_(op);
189 void (set_generic_function_ptr)(ir_op *op, op_func func)
191 set_generic_function_ptr_(op, func);
194 ir_op_ops *(get_op_ops)(ir_op *op)
196 return get_op_ops_(op);
199 irop_flags get_op_flags(const ir_op *op)
201 return (irop_flags)op->flags;
204 static ir_type *default_get_type_attr(const ir_node *node)
207 return get_unknown_type();
210 static ir_entity *default_get_entity_attr(const ir_node *node)
216 static unsigned default_hash_node(const ir_node *node)
221 /* hash table value = 9*(9*(9*(9*(9*arity+in[0])+in[1])+ ...)+mode)+code */
222 h = irn_arity = get_irn_arity(node);
224 /* consider all in nodes... except the block if not a control flow. */
225 for (i = is_cfop(node) ? -1 : 0; i < irn_arity; ++i) {
226 ir_node *pred = get_irn_n(node, i);
227 if (is_irn_cse_neutral(pred))
230 h = 9*h + hash_ptr(pred);
234 h = 9*h + hash_ptr(get_irn_mode(node));
236 h = 9*h + hash_ptr(get_irn_op(node));
242 * Calculate a hash value of a Const node.
244 static unsigned hash_Const(const ir_node *node)
248 /* special value for const, as they only differ in their tarval. */
249 h = hash_ptr(node->attr.con.tarval);
255 * Calculate a hash value of a SymConst node.
257 static unsigned hash_SymConst(const ir_node *node)
261 /* all others are pointers */
262 h = hash_ptr(node->attr.symc.sym.type_p);
267 /** Compares two exception attributes */
268 static int node_cmp_exception(const ir_node *a, const ir_node *b)
270 const except_attr *ea = &a->attr.except;
271 const except_attr *eb = &b->attr.except;
272 return ea->pin_state != eb->pin_state;
275 /** Compares the attributes of two Const nodes. */
276 static int node_cmp_attr_Const(const ir_node *a, const ir_node *b)
278 return get_Const_tarval(a) != get_Const_tarval(b);
281 /** Compares the attributes of two Proj nodes. */
282 static int node_cmp_attr_Proj(const ir_node *a, const ir_node *b)
284 return a->attr.proj.proj != b->attr.proj.proj;
287 /** Compares the attributes of two Alloc nodes. */
288 static int node_cmp_attr_Alloc(const ir_node *a, const ir_node *b)
290 const alloc_attr *pa = &a->attr.alloc;
291 const alloc_attr *pb = &b->attr.alloc;
292 if (pa->where != pb->where || pa->type != pb->type)
294 return node_cmp_exception(a, b);
297 /** Compares the attributes of two Free nodes. */
298 static int node_cmp_attr_Free(const ir_node *a, const ir_node *b)
300 const free_attr *pa = &a->attr.free;
301 const free_attr *pb = &b->attr.free;
302 return (pa->where != pb->where) || (pa->type != pb->type);
305 /** Compares the attributes of two SymConst nodes. */
306 static int node_cmp_attr_SymConst(const ir_node *a, const ir_node *b)
308 const symconst_attr *pa = &a->attr.symc;
309 const symconst_attr *pb = &b->attr.symc;
310 return (pa->kind != pb->kind)
311 || (pa->sym.type_p != pb->sym.type_p);
314 /** Compares the attributes of two Call nodes. */
315 static int node_cmp_attr_Call(const ir_node *a, const ir_node *b)
317 const call_attr *pa = &a->attr.call;
318 const call_attr *pb = &b->attr.call;
319 if (pa->type != pb->type)
321 return node_cmp_exception(a, b);
324 /** Compares the attributes of two Sel nodes. */
325 static int node_cmp_attr_Sel(const ir_node *a, const ir_node *b)
327 const ir_entity *a_ent = get_Sel_entity(a);
328 const ir_entity *b_ent = get_Sel_entity(b);
329 return a_ent != b_ent;
332 /** Compares the attributes of two Phi nodes. */
333 static int node_cmp_attr_Phi(const ir_node *a, const ir_node *b)
336 /* do not CSE Phi-nodes without any inputs when building new graphs */
337 if (get_irn_arity(a) == 0 &&
338 get_irg_phase_state(get_irn_irg(a)) == phase_building) {
344 /** Compares the attributes of two Conv nodes. */
345 static int node_cmp_attr_Conv(const ir_node *a, const ir_node *b)
347 return get_Conv_strict(a) != get_Conv_strict(b);
350 /** Compares the attributes of two Cast nodes. */
351 static int node_cmp_attr_Cast(const ir_node *a, const ir_node *b)
353 return get_Cast_type(a) != get_Cast_type(b);
356 /** Compares the attributes of two Load nodes. */
357 static int node_cmp_attr_Load(const ir_node *a, const ir_node *b)
359 if (get_Load_volatility(a) == volatility_is_volatile ||
360 get_Load_volatility(b) == volatility_is_volatile)
361 /* NEVER do CSE on volatile Loads */
363 /* do not CSE Loads with different alignment. Be conservative. */
364 if (get_Load_unaligned(a) != get_Load_unaligned(b))
366 if (get_Load_mode(a) != get_Load_mode(b))
368 return node_cmp_exception(a, b);
371 /** Compares the attributes of two Store nodes. */
372 static int node_cmp_attr_Store(const ir_node *a, const ir_node *b)
374 /* do not CSE Stores with different alignment. Be conservative. */
375 if (get_Store_unaligned(a) != get_Store_unaligned(b))
377 /* NEVER do CSE on volatile Stores */
378 if (get_Store_volatility(a) == volatility_is_volatile ||
379 get_Store_volatility(b) == volatility_is_volatile)
381 return node_cmp_exception(a, b);
384 static int node_cmp_attr_CopyB(const ir_node *a, const ir_node *b)
386 if (get_CopyB_type(a) != get_CopyB_type(b))
389 return node_cmp_exception(a, b);
392 static int node_cmp_attr_Bound(const ir_node *a, const ir_node *b)
394 return node_cmp_exception(a, b);
397 /** Compares the attributes of two Div nodes. */
398 static int node_cmp_attr_Div(const ir_node *a, const ir_node *b)
400 const div_attr *ma = &a->attr.div;
401 const div_attr *mb = &b->attr.div;
402 if (ma->resmode != mb->resmode || ma->no_remainder != mb->no_remainder)
404 return node_cmp_exception(a, b);
407 /** Compares the attributes of two Mod nodes. */
408 static int node_cmp_attr_Mod(const ir_node *a, const ir_node *b)
410 const mod_attr *ma = &a->attr.mod;
411 const mod_attr *mb = &b->attr.mod;
412 if (ma->resmode != mb->resmode)
414 return node_cmp_exception(a, b);
417 static int node_cmp_attr_Cmp(const ir_node *a, const ir_node *b)
419 const cmp_attr *ma = &a->attr.cmp;
420 const cmp_attr *mb = &b->attr.cmp;
421 return ma->relation != mb->relation;
424 /** Compares the attributes of two Confirm nodes. */
425 static int node_cmp_attr_Confirm(const ir_node *a, const ir_node *b)
427 const confirm_attr *ma = &a->attr.confirm;
428 const confirm_attr *mb = &b->attr.confirm;
429 return ma->relation != mb->relation;
432 /** Compares the attributes of two Builtin nodes. */
433 static int node_cmp_attr_Builtin(const ir_node *a, const ir_node *b)
435 if (get_Builtin_kind(a) != get_Builtin_kind(b))
437 if (get_Builtin_type(a) != get_Builtin_type(b))
439 return node_cmp_exception(a, b);
442 /** Compares the attributes of two ASM nodes. */
443 static int node_cmp_attr_ASM(const ir_node *a, const ir_node *b)
445 if (get_ASM_text(a) != get_ASM_text(b))
448 int n_inputs = get_ASM_n_inputs(a);
449 if (n_inputs != get_ASM_n_inputs(b))
452 const ir_asm_constraint *in_a = get_ASM_input_constraints(a);
453 const ir_asm_constraint *in_b = get_ASM_input_constraints(b);
454 for (int i = 0; i < n_inputs; ++i) {
455 if (in_a[i].pos != in_b[i].pos
456 || in_a[i].constraint != in_b[i].constraint
457 || in_a[i].mode != in_b[i].mode)
461 size_t n_outputs = get_ASM_n_output_constraints(a);
462 if (n_outputs != get_ASM_n_output_constraints(b))
465 const ir_asm_constraint *out_a = get_ASM_output_constraints(a);
466 const ir_asm_constraint *out_b = get_ASM_output_constraints(b);
467 for (size_t i = 0; i < n_outputs; ++i) {
468 if (out_a[i].pos != out_b[i].pos
469 || out_a[i].constraint != out_b[i].constraint
470 || out_a[i].mode != out_b[i].mode)
474 size_t n_clobbers = get_ASM_n_clobbers(a);
475 if (n_clobbers != get_ASM_n_clobbers(b))
478 ident **cla = get_ASM_clobbers(a);
479 ident **clb = get_ASM_clobbers(b);
480 for (size_t i = 0; i < n_clobbers; ++i) {
481 if (cla[i] != clb[i])
485 return node_cmp_exception(a, b);
488 /** Compares the inexistent attributes of two Dummy nodes. */
489 static int node_cmp_attr_Dummy(const ir_node *a, const ir_node *b)
493 /* Dummy nodes never equal by definition */
497 static int node_cmp_attr_InstOf(const ir_node *a, const ir_node *b)
499 if (get_InstOf_type(a) != get_InstOf_type(b))
501 return node_cmp_exception(a, b);
504 static void default_copy_attr(ir_graph *irg, const ir_node *old_node,
507 unsigned size = firm_add_node_size;
510 assert(get_irn_op(old_node) == get_irn_op(new_node));
511 memcpy(&new_node->attr, &old_node->attr, get_op_attr_size(get_irn_op(old_node)));
514 /* copy additional node data */
515 memcpy(get_irn_data(new_node, void, size), get_irn_data(old_node, void, size), size);
520 * Copies all Call attributes stored in the old node to the new node.
522 static void call_copy_attr(ir_graph *irg, const ir_node *old_node,
525 default_copy_attr(irg, old_node, new_node);
526 remove_Call_callee_arr(new_node);
530 * Copies all Block attributes stored in the old node to the new node.
532 static void block_copy_attr(ir_graph *irg, const ir_node *old_node,
535 default_copy_attr(irg, old_node, new_node);
536 new_node->attr.block.irg.irg = irg;
537 new_node->attr.block.phis = NULL;
538 new_node->attr.block.backedge = new_backedge_arr(irg->obst, get_irn_arity(new_node));
539 new_node->attr.block.block_visited = 0;
540 memset(&new_node->attr.block.dom, 0, sizeof(new_node->attr.block.dom));
541 memset(&new_node->attr.block.pdom, 0, sizeof(new_node->attr.block.pdom));
542 /* It should be safe to copy the entity here, as it has no back-link to the old block.
543 * It serves just as a label number, so copying a labeled block results in an exact copy.
544 * This is at least what we need for DCE to work. */
545 new_node->attr.block.entity = old_node->attr.block.entity;
546 new_node->attr.block.phis = NULL;
550 * Copies all phi attributes stored in old node to the new node
552 static void phi_copy_attr(ir_graph *irg, const ir_node *old_node,
555 default_copy_attr(irg, old_node, new_node);
556 new_node->attr.phi.next = NULL;
557 new_node->attr.phi.u.backedge = new_backedge_arr(irg->obst, get_irn_arity(new_node));
561 * Copies all ASM attributes stored in old node to the new node
563 static void ASM_copy_attr(ir_graph *irg, const ir_node *old_node,
566 default_copy_attr(irg, old_node, new_node);
567 new_node->attr.assem.input_constraints = DUP_ARR_D(ir_asm_constraint, irg->obst, old_node->attr.assem.input_constraints);
568 new_node->attr.assem.output_constraints = DUP_ARR_D(ir_asm_constraint, irg->obst, old_node->attr.assem.output_constraints);
569 new_node->attr.assem.clobbers = DUP_ARR_D(ident*, irg->obst, old_node->attr.assem.clobbers);
572 static void switch_copy_attr(ir_graph *irg, const ir_node *old_node,
575 const ir_switch_table *table = get_Switch_table(old_node);
576 new_node->attr.switcha.table = ir_switch_table_duplicate(irg, table);
577 new_node->attr.switcha.n_outs = old_node->attr.switcha.n_outs;
580 static void register_node_cmp_func(ir_op *op, node_cmp_attr_func func)
582 op->ops.node_cmp_attr = func;
585 static void register_node_hash_func(ir_op *op, hash_func func)
590 static void register_node_copy_attr_func(ir_op *op, copy_attr_func func)
592 op->ops.copy_attr = func;
595 static void generated_init_op(void);
596 static void generated_finish_op(void);
598 void firm_init_op(void)
600 opcodes = NEW_ARR_F(ir_op*, 0);
604 register_node_cmp_func(op_ASM, node_cmp_attr_ASM);
605 register_node_cmp_func(op_Alloc, node_cmp_attr_Alloc);
606 register_node_cmp_func(op_Bound, node_cmp_attr_Bound);
607 register_node_cmp_func(op_Builtin, node_cmp_attr_Builtin);
608 register_node_cmp_func(op_Call, node_cmp_attr_Call);
609 register_node_cmp_func(op_Cast, node_cmp_attr_Cast);
610 register_node_cmp_func(op_Cmp, node_cmp_attr_Cmp);
611 register_node_cmp_func(op_Confirm, node_cmp_attr_Confirm);
612 register_node_cmp_func(op_Const, node_cmp_attr_Const);
613 register_node_cmp_func(op_Conv, node_cmp_attr_Conv);
614 register_node_cmp_func(op_CopyB, node_cmp_attr_CopyB);
615 register_node_cmp_func(op_Div, node_cmp_attr_Div);
616 register_node_cmp_func(op_Dummy, node_cmp_attr_Dummy);
617 register_node_cmp_func(op_Free, node_cmp_attr_Free);
618 register_node_cmp_func(op_InstOf, node_cmp_attr_InstOf);
619 register_node_cmp_func(op_Load, node_cmp_attr_Load);
620 register_node_cmp_func(op_Mod, node_cmp_attr_Mod);
621 register_node_cmp_func(op_Phi, node_cmp_attr_Phi);
622 register_node_cmp_func(op_Proj, node_cmp_attr_Proj);
623 register_node_cmp_func(op_Div, node_cmp_attr_Div);
624 register_node_cmp_func(op_Dummy, node_cmp_attr_Dummy);
625 register_node_cmp_func(op_Free, node_cmp_attr_Free);
626 register_node_cmp_func(op_InstOf, node_cmp_attr_InstOf);
627 register_node_cmp_func(op_Load, node_cmp_attr_Load);
628 register_node_cmp_func(op_Mod, node_cmp_attr_Mod);
629 register_node_cmp_func(op_Phi, node_cmp_attr_Phi);
630 register_node_cmp_func(op_Proj, node_cmp_attr_Proj);
631 register_node_cmp_func(op_Sel, node_cmp_attr_Sel);
632 register_node_cmp_func(op_Store, node_cmp_attr_Store);
633 register_node_cmp_func(op_SymConst, node_cmp_attr_SymConst);
635 register_node_hash_func(op_Const, hash_Const);
636 register_node_hash_func(op_SymConst, hash_SymConst);
638 register_node_copy_attr_func(op_Call, call_copy_attr);
639 register_node_copy_attr_func(op_Block, block_copy_attr);
640 register_node_copy_attr_func(op_Phi, phi_copy_attr);
641 register_node_copy_attr_func(op_ASM, ASM_copy_attr);
642 register_node_copy_attr_func(op_Switch, switch_copy_attr);
644 ir_register_opt_node_ops();
645 ir_register_reassoc_node_ops();
646 ir_register_verify_node_ops();
649 void firm_finish_op(void)
652 generated_finish_op();
657 #include "gen_irop.c.inl"