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 an intermediate operation.
23 * @author Martin Trapp, Christian Schaefer, Goetz Lindenmaier, Michael Beck
32 #include "irgraph_t.h"
34 #include "irbackedge_t.h"
38 #include "iredgekinds.h"
39 #include "iredges_t.h"
49 /* some constants fixing the positions of nodes predecessors
51 #define CALL_PARAM_OFFSET (n_Call_max+1)
52 #define BUILTIN_PARAM_OFFSET (n_Builtin_max+1)
53 #define SEL_INDEX_OFFSET (n_Sel_max+1)
54 #define RETURN_RESULT_OFFSET (n_Return_max+1)
55 #define END_KEEPALIVE_OFFSET 0
57 static const char *relation_names [] = {
69 "unordered_less_equal",
71 "unordered_greater_equal",
76 const char *get_relation_string(ir_relation relation)
78 assert(relation < (ir_relation)ARRAY_SIZE(relation_names));
79 return relation_names[relation];
82 ir_relation get_negated_relation(ir_relation relation)
84 return relation ^ ir_relation_true;
87 ir_relation get_inversed_relation(ir_relation relation)
89 ir_relation code = relation & ~(ir_relation_less|ir_relation_greater);
90 bool less = relation & ir_relation_less;
91 bool greater = relation & ir_relation_greater;
92 code |= (less ? ir_relation_greater : 0) | (greater ? ir_relation_less : 0);
97 * Indicates, whether additional data can be registered to ir nodes.
98 * If set to 1, this is not possible anymore.
100 static int forbid_new_data = 0;
103 * The amount of additional space for custom data to be allocated upon
104 * creating a new node.
106 unsigned firm_add_node_size = 0;
109 /* register new space for every node */
110 unsigned firm_register_additional_node_data(unsigned size)
112 assert(!forbid_new_data && "Too late to register additional node data");
117 return firm_add_node_size += size;
121 void init_irnode(void)
123 /* Forbid the addition of new data to an ir node. */
127 struct struct_align {
137 * irnode constructor.
138 * Create a new irnode in irg, with an op, mode, arity and
139 * some incoming irnodes.
140 * If arity is negative, a node with a dynamic array is created.
142 ir_node *new_ir_node(dbg_info *db, ir_graph *irg, ir_node *block, ir_op *op,
143 ir_mode *mode, int arity, ir_node *const *in)
146 unsigned align = offsetof(struct struct_align, s) - 1;
147 unsigned add_node_size = (firm_add_node_size + align) & ~align;
148 size_t node_size = offsetof(ir_node, attr) + op->attr_size + add_node_size;
155 p = (char*)obstack_alloc(irg->obst, node_size);
156 memset(p, 0, node_size);
157 res = (ir_node *)(p + add_node_size);
159 res->kind = k_ir_node;
163 res->node_idx = irg_register_node_idx(irg, res);
168 res->in = NEW_ARR_F(ir_node *, 1); /* 1: space for block */
170 /* not nice but necessary: End and Sync must always have a flexible array */
171 if (op == op_End || op == op_Sync)
172 res->in = NEW_ARR_F(ir_node *, (arity+1));
174 res->in = NEW_ARR_D(ir_node *, irg->obst, (arity+1));
175 memcpy(&res->in[1], in, sizeof(ir_node *) * arity);
179 set_irn_dbg_info(res, db);
181 res->node_nr = get_irp_new_node_nr();
183 for (i = 0; i < EDGE_KIND_LAST; ++i) {
184 INIT_LIST_HEAD(&res->edge_info[i].outs_head);
185 /* edges will be build immediately */
186 res->edge_info[i].edges_built = 1;
187 res->edge_info[i].out_count = 0;
190 /* don't put this into the for loop, arity is -1 for some nodes! */
191 edges_notify_edge(res, -1, res->in[0], NULL, irg);
192 for (i = 1; i <= arity; ++i)
193 edges_notify_edge(res, i - 1, res->in[i], NULL, irg);
195 hook_new_node(irg, res);
196 if (get_irg_phase_state(irg) == phase_backend) {
197 be_info_new_node(res);
203 /*-- getting some parameters from ir_nodes --*/
205 int (is_ir_node)(const void *thing)
207 return is_ir_node_(thing);
210 int (get_irn_arity)(const ir_node *node)
212 return get_irn_arity_(node);
215 /* Returns the array with ins. This array is shifted with respect to the
216 array accessed by get_irn_n: The block operand is at position 0 not -1.
217 (@@@ This should be changed.)
218 The order of the predecessors in this array is not guaranteed, except that
219 lists of operands as predecessors of Block or arguments of a Call are
221 ir_node **get_irn_in(const ir_node *node)
226 void set_irn_in(ir_node *node, int arity, ir_node **in)
230 ir_graph *irg = get_irn_irg(node);
235 assert(node != NULL && node->kind == k_ir_node);
237 for (i = 0; i < arity; ++i) {
238 assert(in[i] != NULL && in[0]->kind == k_ir_node);
242 for (i = 0; i < arity; i++) {
243 if (i < (int)ARR_LEN(*pOld_in)-1)
244 edges_notify_edge(node, i, in[i], (*pOld_in)[i+1], irg);
246 edges_notify_edge(node, i, in[i], NULL, irg);
248 for (;i < (int)ARR_LEN(*pOld_in)-1; i++) {
249 edges_notify_edge(node, i, NULL, (*pOld_in)[i+1], irg);
252 if (arity != (int)ARR_LEN(*pOld_in) - 1) {
253 ir_node * block = (*pOld_in)[0];
254 *pOld_in = NEW_ARR_D(ir_node *, irg->obst, arity + 1);
255 (*pOld_in)[0] = block;
257 fix_backedges(irg->obst, node);
259 memcpy((*pOld_in) + 1, in, sizeof(ir_node *) * arity);
261 /* update irg flags */
262 clear_irg_state(irg, IR_GRAPH_STATE_CONSISTENT_OUTS | IR_GRAPH_STATE_CONSISTENT_LOOPINFO);
265 ir_node *(get_irn_n)(const ir_node *node, int n)
267 return get_irn_n_(node, n);
270 void set_irn_n(ir_node *node, int n, ir_node *in)
272 ir_graph *irg = get_irn_irg(node);
273 assert(node && node->kind == k_ir_node);
275 assert(n < get_irn_arity(node));
276 assert(in && in->kind == k_ir_node);
279 hook_set_irn_n(node, n, in, node->in[n + 1]);
281 /* Here, we rely on src and tgt being in the current ir graph */
282 edges_notify_edge(node, n, in, node->in[n + 1], irg);
284 node->in[n + 1] = in;
286 /* update irg flags */
287 clear_irg_state(irg, IR_GRAPH_STATE_CONSISTENT_OUTS | IR_GRAPH_STATE_CONSISTENT_LOOPINFO);
290 int add_irn_n(ir_node *node, ir_node *in)
293 ir_graph *irg = get_irn_irg(node);
295 assert(node->op->opar == oparity_dynamic);
296 pos = ARR_LEN(node->in) - 1;
297 ARR_APP1(ir_node *, node->in, in);
298 edges_notify_edge(node, pos, node->in[pos + 1], NULL, irg);
301 hook_set_irn_n(node, pos, node->in[pos + 1], NULL);
306 void del_Sync_n(ir_node *n, int i)
308 int arity = get_Sync_n_preds(n);
309 ir_node *last_pred = get_Sync_pred(n, arity - 1);
310 set_Sync_pred(n, i, last_pred);
311 edges_notify_edge(n, arity - 1, NULL, last_pred, get_irn_irg(n));
312 ARR_SHRINKLEN(get_irn_in(n), arity);
315 int (get_irn_deps)(const ir_node *node)
317 return get_irn_deps_(node);
320 ir_node *(get_irn_dep)(const ir_node *node, int pos)
322 return get_irn_dep_(node, pos);
325 void (set_irn_dep)(ir_node *node, int pos, ir_node *dep)
327 set_irn_dep_(node, pos, dep);
330 int add_irn_dep(ir_node *node, ir_node *dep)
334 /* DEP edges are only allowed in backend phase */
335 assert(get_irg_phase_state(get_irn_irg(node)) == phase_backend);
336 if (node->deps == NULL) {
337 node->deps = NEW_ARR_F(ir_node *, 1);
343 for (i = 0, n = ARR_LEN(node->deps); i < n; ++i) {
344 if (node->deps[i] == NULL)
347 if (node->deps[i] == dep)
351 if (first_zero >= 0) {
352 node->deps[first_zero] = dep;
355 ARR_APP1(ir_node *, node->deps, dep);
360 edges_notify_edge_kind(node, res, dep, NULL, EDGE_KIND_DEP, get_irn_irg(node));
365 void add_irn_deps(ir_node *tgt, ir_node *src)
369 for (i = 0, n = get_irn_deps(src); i < n; ++i)
370 add_irn_dep(tgt, get_irn_dep(src, i));
374 ir_mode *(get_irn_mode)(const ir_node *node)
376 return get_irn_mode_(node);
379 void (set_irn_mode)(ir_node *node, ir_mode *mode)
381 set_irn_mode_(node, mode);
384 ir_op *(get_irn_op)(const ir_node *node)
386 return get_irn_op_(node);
389 /* should be private to the library: */
390 void (set_irn_op)(ir_node *node, ir_op *op)
392 set_irn_op_(node, op);
395 unsigned (get_irn_opcode)(const ir_node *node)
397 return get_irn_opcode_(node);
400 const char *get_irn_opname(const ir_node *node)
403 if (is_Phi0(node)) return "Phi0";
404 return get_id_str(node->op->name);
407 ident *get_irn_opident(const ir_node *node)
410 return node->op->name;
413 ir_visited_t (get_irn_visited)(const ir_node *node)
415 return get_irn_visited_(node);
418 void (set_irn_visited)(ir_node *node, ir_visited_t visited)
420 set_irn_visited_(node, visited);
423 void (mark_irn_visited)(ir_node *node)
425 mark_irn_visited_(node);
428 int (irn_visited)(const ir_node *node)
430 return irn_visited_(node);
433 int (irn_visited_else_mark)(ir_node *node)
435 return irn_visited_else_mark_(node);
438 void (set_irn_link)(ir_node *node, void *link)
440 set_irn_link_(node, link);
443 void *(get_irn_link)(const ir_node *node)
445 return get_irn_link_(node);
448 op_pin_state (get_irn_pinned)(const ir_node *node)
450 return get_irn_pinned_(node);
453 op_pin_state (is_irn_pinned_in_irg) (const ir_node *node)
455 return is_irn_pinned_in_irg_(node);
458 void set_irn_pinned(ir_node *node, op_pin_state state)
460 /* due to optimization an opt may be turned into a Tuple */
464 assert(node && get_op_pinned(get_irn_op(node)) >= op_pin_state_exc_pinned);
465 assert(state == op_pin_state_pinned || state == op_pin_state_floats);
467 node->attr.except.pin_state = state;
470 /* Outputs a unique number for this node */
471 long get_irn_node_nr(const ir_node *node)
474 return node->node_nr;
477 void *(get_irn_generic_attr)(ir_node *node)
479 assert(is_ir_node(node));
480 return get_irn_generic_attr_(node);
483 const void *(get_irn_generic_attr_const)(const ir_node *node)
485 assert(is_ir_node(node));
486 return get_irn_generic_attr_const_(node);
489 unsigned (get_irn_idx)(const ir_node *node)
491 assert(is_ir_node(node));
492 return get_irn_idx_(node);
495 int get_irn_pred_pos(ir_node *node, ir_node *arg)
498 for (i = get_irn_arity(node) - 1; i >= 0; i--) {
499 if (get_irn_n(node, i) == arg)
505 /** manipulate fields of individual nodes **/
507 ir_node *(get_nodes_block)(const ir_node *node)
509 return get_nodes_block_(node);
512 void set_nodes_block(ir_node *node, ir_node *block)
514 assert(node->op != op_Block);
515 set_irn_n(node, -1, block);
518 /* Test whether arbitrary node is frame pointer, i.e. Proj(pn_Start_P_frame_base)
519 * from Start. If so returns frame type, else Null. */
520 ir_type *is_frame_pointer(const ir_node *n)
522 if (is_Proj(n) && (get_Proj_proj(n) == pn_Start_P_frame_base)) {
523 ir_node *start = get_Proj_pred(n);
524 if (is_Start(start)) {
525 return get_irg_frame_type(get_irn_irg(start));
531 ir_node **get_Block_cfgpred_arr(ir_node *node)
533 assert(is_Block(node));
534 return (ir_node **)&(get_irn_in(node)[1]);
537 int (get_Block_n_cfgpreds)(const ir_node *node)
539 return get_Block_n_cfgpreds_(node);
542 ir_node *(get_Block_cfgpred)(const ir_node *node, int pos)
544 return get_Block_cfgpred_(node, pos);
547 void set_Block_cfgpred(ir_node *node, int pos, ir_node *pred)
549 assert(is_Block(node));
550 set_irn_n(node, pos, pred);
553 int get_Block_cfgpred_pos(const ir_node *block, const ir_node *pred)
557 for (i = get_Block_n_cfgpreds(block) - 1; i >= 0; --i) {
558 if (get_Block_cfgpred_block(block, i) == pred)
564 ir_node *(get_Block_cfgpred_block)(const ir_node *node, int pos)
566 return get_Block_cfgpred_block_(node, pos);
569 int get_Block_matured(const ir_node *node)
571 assert(is_Block(node));
572 return (int)node->attr.block.is_matured;
575 void set_Block_matured(ir_node *node, int matured)
577 assert(is_Block(node));
578 node->attr.block.is_matured = matured;
581 ir_visited_t (get_Block_block_visited)(const ir_node *node)
583 return get_Block_block_visited_(node);
586 void (set_Block_block_visited)(ir_node *node, ir_visited_t visit)
588 set_Block_block_visited_(node, visit);
591 void (mark_Block_block_visited)(ir_node *node)
593 mark_Block_block_visited_(node);
596 int (Block_block_visited)(const ir_node *node)
598 return Block_block_visited_(node);
601 ir_extblk *get_Block_extbb(const ir_node *block)
604 assert(is_Block(block));
605 res = block->attr.block.extblk;
606 assert(res == NULL || is_ir_extbb(res));
610 void set_Block_extbb(ir_node *block, ir_extblk *extblk)
612 assert(is_Block(block));
613 assert(extblk == NULL || is_ir_extbb(extblk));
614 block->attr.block.extblk = extblk;
617 /* returns the graph of a Block. */
618 ir_graph *(get_Block_irg)(const ir_node *block)
620 return get_Block_irg_(block);
623 ir_entity *create_Block_entity(ir_node *block)
626 assert(is_Block(block));
628 entity = block->attr.block.entity;
629 if (entity == NULL) {
633 glob = get_glob_type();
634 entity = new_entity(glob, id_unique("block_%u"), get_code_type());
635 set_entity_visibility(entity, ir_visibility_local);
636 set_entity_linkage(entity, IR_LINKAGE_CONSTANT);
637 nr = get_irp_next_label_nr();
638 set_entity_label(entity, nr);
639 set_entity_compiler_generated(entity, 1);
641 block->attr.block.entity = entity;
646 ir_entity *get_Block_entity(const ir_node *block)
648 assert(is_Block(block));
649 return block->attr.block.entity;
652 void set_Block_entity(ir_node *block, ir_entity *entity)
654 assert(is_Block(block));
655 assert(get_entity_type(entity) == get_code_type());
656 block->attr.block.entity = entity;
659 int has_Block_entity(const ir_node *block)
661 return block->attr.block.entity != NULL;
664 ir_node *(get_Block_phis)(const ir_node *block)
666 return get_Block_phis_(block);
669 void (set_Block_phis)(ir_node *block, ir_node *phi)
671 set_Block_phis_(block, phi);
674 void (add_Block_phi)(ir_node *block, ir_node *phi)
676 add_Block_phi_(block, phi);
679 /* Get the Block mark (single bit). */
680 unsigned (get_Block_mark)(const ir_node *block)
682 return get_Block_mark_(block);
685 /* Set the Block mark (single bit). */
686 void (set_Block_mark)(ir_node *block, unsigned mark)
688 set_Block_mark_(block, mark);
691 int get_End_n_keepalives(const ir_node *end)
694 return (get_irn_arity(end) - END_KEEPALIVE_OFFSET);
697 ir_node *get_End_keepalive(const ir_node *end, int pos)
700 return get_irn_n(end, pos + END_KEEPALIVE_OFFSET);
703 void add_End_keepalive(ir_node *end, ir_node *ka)
709 void set_End_keepalive(ir_node *end, int pos, ir_node *ka)
712 set_irn_n(end, pos + END_KEEPALIVE_OFFSET, ka);
715 /* Set new keep-alives */
716 void set_End_keepalives(ir_node *end, int n, ir_node *in[])
720 ir_graph *irg = get_irn_irg(end);
722 /* notify that edges are deleted */
723 for (e = END_KEEPALIVE_OFFSET; e < ARR_LEN(end->in) - 1; ++e) {
724 edges_notify_edge(end, e, NULL, end->in[e + 1], irg);
726 ARR_RESIZE(ir_node *, end->in, n + 1 + END_KEEPALIVE_OFFSET);
728 for (i = 0; i < n; ++i) {
729 end->in[1 + END_KEEPALIVE_OFFSET + i] = in[i];
730 edges_notify_edge(end, END_KEEPALIVE_OFFSET + i, end->in[1 + END_KEEPALIVE_OFFSET + i], NULL, irg);
733 /* update irg flags */
734 clear_irg_state(irg, IR_GRAPH_STATE_CONSISTENT_OUTS);
737 /* Set new keep-alives from old keep-alives, skipping irn */
738 void remove_End_keepalive(ir_node *end, ir_node *irn)
740 int n = get_End_n_keepalives(end);
745 for (i = n -1; i >= 0; --i) {
746 ir_node *old_ka = end->in[1 + END_KEEPALIVE_OFFSET + i];
756 irg = get_irn_irg(end);
758 /* remove the edge */
759 edges_notify_edge(end, idx, NULL, irn, irg);
762 /* exchange with the last one */
763 ir_node *old = end->in[1 + END_KEEPALIVE_OFFSET + n - 1];
764 edges_notify_edge(end, n - 1, NULL, old, irg);
765 end->in[1 + END_KEEPALIVE_OFFSET + idx] = old;
766 edges_notify_edge(end, idx, old, NULL, irg);
768 /* now n - 1 keeps, 1 block input */
769 ARR_RESIZE(ir_node *, end->in, (n - 1) + 1 + END_KEEPALIVE_OFFSET);
771 /* update irg flags */
772 clear_irg_state(irg, IR_GRAPH_STATE_CONSISTENT_OUTS);
775 /* remove Bads, NoMems and doublets from the keep-alive set */
776 void remove_End_Bads_and_doublets(ir_node *end)
779 int idx, n = get_End_n_keepalives(end);
781 bool changed = false;
786 irg = get_irn_irg(end);
787 pset_new_init(&keeps);
789 for (idx = n - 1; idx >= 0; --idx) {
790 ir_node *ka = get_End_keepalive(end, idx);
792 if (is_Bad(ka) || is_NoMem(ka) || pset_new_contains(&keeps, ka)) {
794 /* remove the edge */
795 edges_notify_edge(end, idx, NULL, ka, irg);
798 /* exchange with the last one */
799 ir_node *old = end->in[1 + END_KEEPALIVE_OFFSET + n - 1];
800 edges_notify_edge(end, n - 1, NULL, old, irg);
801 end->in[1 + END_KEEPALIVE_OFFSET + idx] = old;
802 edges_notify_edge(end, idx, old, NULL, irg);
806 pset_new_insert(&keeps, ka);
809 /* n keeps, 1 block input */
810 ARR_RESIZE(ir_node *, end->in, n + 1 + END_KEEPALIVE_OFFSET);
812 pset_new_destroy(&keeps);
815 clear_irg_state(irg, IR_GRAPH_STATE_CONSISTENT_OUTS);
819 void free_End(ir_node *end)
824 end->in = NULL; /* @@@ make sure we get an error if we use the
825 in array afterwards ... */
828 size_t get_Return_n_ress(const ir_node *node)
830 assert(is_Return(node));
831 return (size_t)(get_irn_arity(node) - RETURN_RESULT_OFFSET);
834 ir_node **get_Return_res_arr(ir_node *node)
836 assert(is_Return(node));
837 if (get_Return_n_ress(node) > 0)
838 return (ir_node **)&(get_irn_in(node)[1 + RETURN_RESULT_OFFSET]);
843 ir_node *get_Return_res(const ir_node *node, int pos)
845 assert(is_Return(node));
847 assert(get_Return_n_ress(node) > (size_t)pos);
848 return get_irn_n(node, pos + RETURN_RESULT_OFFSET);
851 void set_Return_res(ir_node *node, int pos, ir_node *res)
853 assert(is_Return(node));
854 set_irn_n(node, pos + RETURN_RESULT_OFFSET, res);
857 int (is_Const_null)(const ir_node *node)
859 return is_Const_null_(node);
862 int (is_Const_one)(const ir_node *node)
864 return is_Const_one_(node);
867 int (is_Const_all_one)(const ir_node *node)
869 return is_Const_all_one_(node);
874 symconst_kind get_SymConst_kind(const ir_node *node)
876 assert(is_SymConst(node));
877 return node->attr.symc.kind;
880 void set_SymConst_kind(ir_node *node, symconst_kind kind)
882 assert(is_SymConst(node));
883 node->attr.symc.kind = kind;
886 ir_type *get_SymConst_type(const ir_node *node)
888 /* the cast here is annoying, but we have to compensate for
890 ir_node *irn = (ir_node *)node;
891 assert(is_SymConst(node) &&
892 (SYMCONST_HAS_TYPE(get_SymConst_kind(node))));
893 return irn->attr.symc.sym.type_p;
896 void set_SymConst_type(ir_node *node, ir_type *tp)
898 assert(is_SymConst(node) &&
899 (SYMCONST_HAS_TYPE(get_SymConst_kind(node))));
900 node->attr.symc.sym.type_p = tp;
904 /* Only to access SymConst of kind symconst_addr_ent. Else assertion: */
905 ir_entity *get_SymConst_entity(const ir_node *node)
907 assert(is_SymConst(node) && SYMCONST_HAS_ENT(get_SymConst_kind(node)));
908 return node->attr.symc.sym.entity_p;
911 void set_SymConst_entity(ir_node *node, ir_entity *ent)
913 assert(is_SymConst(node) && SYMCONST_HAS_ENT(get_SymConst_kind(node)));
914 node->attr.symc.sym.entity_p = ent;
917 ir_enum_const *get_SymConst_enum(const ir_node *node)
919 assert(is_SymConst(node) && SYMCONST_HAS_ENUM(get_SymConst_kind(node)));
920 return node->attr.symc.sym.enum_p;
923 void set_SymConst_enum(ir_node *node, ir_enum_const *ec)
925 assert(is_SymConst(node) && SYMCONST_HAS_ENUM(get_SymConst_kind(node)));
926 node->attr.symc.sym.enum_p = ec;
929 union symconst_symbol
930 get_SymConst_symbol(const ir_node *node)
932 assert(is_SymConst(node));
933 return node->attr.symc.sym;
936 void set_SymConst_symbol(ir_node *node, union symconst_symbol sym)
938 assert(is_SymConst(node));
939 node->attr.symc.sym = sym;
942 int get_Sel_n_indexs(const ir_node *node)
944 assert(is_Sel(node));
945 return (get_irn_arity(node) - SEL_INDEX_OFFSET);
948 ir_node **get_Sel_index_arr(ir_node *node)
950 assert(is_Sel(node));
951 if (get_Sel_n_indexs(node) > 0)
952 return (ir_node **)& get_irn_in(node)[SEL_INDEX_OFFSET + 1];
957 ir_node *get_Sel_index(const ir_node *node, int pos)
959 assert(is_Sel(node));
960 return get_irn_n(node, pos + SEL_INDEX_OFFSET);
963 void set_Sel_index(ir_node *node, int pos, ir_node *index)
965 assert(is_Sel(node));
966 set_irn_n(node, pos + SEL_INDEX_OFFSET, index);
969 ir_node **get_Call_param_arr(ir_node *node)
971 assert(is_Call(node));
972 return &get_irn_in(node)[CALL_PARAM_OFFSET + 1];
975 size_t get_Call_n_params(const ir_node *node)
977 assert(is_Call(node));
978 return (size_t) (get_irn_arity(node) - CALL_PARAM_OFFSET);
981 ir_node *get_Call_param(const ir_node *node, int pos)
983 assert(is_Call(node));
984 return get_irn_n(node, pos + CALL_PARAM_OFFSET);
987 void set_Call_param(ir_node *node, int pos, ir_node *param)
989 assert(is_Call(node));
990 set_irn_n(node, pos + CALL_PARAM_OFFSET, param);
993 ir_node **get_Builtin_param_arr(ir_node *node)
995 assert(is_Builtin(node));
996 return &get_irn_in(node)[BUILTIN_PARAM_OFFSET + 1];
999 int get_Builtin_n_params(const ir_node *node)
1001 assert(is_Builtin(node));
1002 return (get_irn_arity(node) - BUILTIN_PARAM_OFFSET);
1005 ir_node *get_Builtin_param(const ir_node *node, int pos)
1007 assert(is_Builtin(node));
1008 return get_irn_n(node, pos + BUILTIN_PARAM_OFFSET);
1011 void set_Builtin_param(ir_node *node, int pos, ir_node *param)
1013 assert(is_Builtin(node));
1014 set_irn_n(node, pos + BUILTIN_PARAM_OFFSET, param);
1017 /* Returns a human readable string for the ir_builtin_kind. */
1018 const char *get_builtin_kind_name(ir_builtin_kind kind)
1020 #define X(a) case a: return #a
1023 X(ir_bk_debugbreak);
1024 X(ir_bk_return_address);
1025 X(ir_bk_frame_address);
1035 X(ir_bk_inner_trampoline);
1042 int Call_has_callees(const ir_node *node)
1044 assert(is_Call(node));
1045 return ((get_irg_callee_info_state(get_irn_irg(node)) != irg_callee_info_none) &&
1046 (node->attr.call.callee_arr != NULL));
1049 size_t get_Call_n_callees(const ir_node *node)
1051 assert(is_Call(node) && node->attr.call.callee_arr);
1052 return ARR_LEN(node->attr.call.callee_arr);
1055 ir_entity *get_Call_callee(const ir_node *node, size_t pos)
1057 assert(pos < get_Call_n_callees(node));
1058 return node->attr.call.callee_arr[pos];
1061 void set_Call_callee_arr(ir_node *node, size_t n, ir_entity ** arr)
1063 ir_graph *irg = get_irn_irg(node);
1065 assert(is_Call(node));
1066 if (node->attr.call.callee_arr == NULL || get_Call_n_callees(node) != n) {
1067 node->attr.call.callee_arr = NEW_ARR_D(ir_entity *, irg->obst, n);
1069 memcpy(node->attr.call.callee_arr, arr, n * sizeof(ir_entity *));
1072 void remove_Call_callee_arr(ir_node *node)
1074 assert(is_Call(node));
1075 node->attr.call.callee_arr = NULL;
1078 /* Checks for upcast.
1080 * Returns true if the Cast node casts a class type to a super type.
1082 int is_Cast_upcast(ir_node *node)
1084 ir_type *totype = get_Cast_type(node);
1085 ir_type *fromtype = get_irn_typeinfo_type(get_Cast_op(node));
1087 assert(get_irg_typeinfo_state(get_irn_irg(node)) == ir_typeinfo_consistent);
1090 while (is_Pointer_type(totype) && is_Pointer_type(fromtype)) {
1091 totype = get_pointer_points_to_type(totype);
1092 fromtype = get_pointer_points_to_type(fromtype);
1097 if (!is_Class_type(totype)) return 0;
1098 return is_SubClass_of(fromtype, totype);
1101 /* Checks for downcast.
1103 * Returns true if the Cast node casts a class type to a sub type.
1105 int is_Cast_downcast(ir_node *node)
1107 ir_type *totype = get_Cast_type(node);
1108 ir_type *fromtype = get_irn_typeinfo_type(get_Cast_op(node));
1110 assert(get_irg_typeinfo_state(get_irn_irg(node)) == ir_typeinfo_consistent);
1113 while (is_Pointer_type(totype) && is_Pointer_type(fromtype)) {
1114 totype = get_pointer_points_to_type(totype);
1115 fromtype = get_pointer_points_to_type(fromtype);
1120 if (!is_Class_type(totype)) return 0;
1121 return is_SubClass_of(totype, fromtype);
1124 int (is_unop)(const ir_node *node)
1126 return is_unop_(node);
1129 ir_node *get_unop_op(const ir_node *node)
1131 if (node->op->opar == oparity_unary)
1132 return get_irn_n(node, node->op->op_index);
1134 assert(node->op->opar == oparity_unary);
1138 void set_unop_op(ir_node *node, ir_node *op)
1140 if (node->op->opar == oparity_unary)
1141 set_irn_n(node, node->op->op_index, op);
1143 assert(node->op->opar == oparity_unary);
1146 int (is_binop)(const ir_node *node)
1148 return is_binop_(node);
1151 ir_node *get_binop_left(const ir_node *node)
1153 assert(node->op->opar == oparity_binary);
1154 return get_irn_n(node, node->op->op_index);
1157 void set_binop_left(ir_node *node, ir_node *left)
1159 assert(node->op->opar == oparity_binary);
1160 set_irn_n(node, node->op->op_index, left);
1163 ir_node *get_binop_right(const ir_node *node)
1165 assert(node->op->opar == oparity_binary);
1166 return get_irn_n(node, node->op->op_index + 1);
1169 void set_binop_right(ir_node *node, ir_node *right)
1171 assert(node->op->opar == oparity_binary);
1172 set_irn_n(node, node->op->op_index + 1, right);
1175 int is_Phi0(const ir_node *n)
1179 return ((get_irn_op(n) == op_Phi) &&
1180 (get_irn_arity(n) == 0) &&
1181 (get_irg_phase_state(get_irn_irg(n)) == phase_building));
1184 ir_node **get_Phi_preds_arr(ir_node *node)
1186 assert(is_Phi(node));
1187 return (ir_node **)&(get_irn_in(node)[1]);
1190 int get_Phi_n_preds(const ir_node *node)
1192 assert(is_Phi(node) || is_Phi0(node));
1193 return (get_irn_arity(node));
1196 ir_node *get_Phi_pred(const ir_node *node, int pos)
1198 assert(is_Phi(node) || is_Phi0(node));
1199 return get_irn_n(node, pos);
1202 void set_Phi_pred(ir_node *node, int pos, ir_node *pred)
1204 assert(is_Phi(node) || is_Phi0(node));
1205 set_irn_n(node, pos, pred);
1208 ir_node *(get_Phi_next)(const ir_node *phi)
1210 return get_Phi_next_(phi);
1213 void (set_Phi_next)(ir_node *phi, ir_node *next)
1215 set_Phi_next_(phi, next);
1218 int is_memop(const ir_node *node)
1220 unsigned code = get_irn_opcode(node);
1221 return (code == iro_Load || code == iro_Store);
1224 ir_node *get_memop_mem(const ir_node *node)
1226 assert(is_memop(node));
1227 assert(n_Load_mem == 0 && n_Store_mem == 0);
1228 return get_irn_n(node, 0);
1231 void set_memop_mem(ir_node *node, ir_node *mem)
1233 assert(is_memop(node));
1234 assert(n_Load_mem == 0 && n_Store_mem == 0);
1235 set_irn_n(node, 0, mem);
1238 ir_node *get_memop_ptr(const ir_node *node)
1240 assert(is_memop(node));
1241 assert(n_Load_mem == 1 && n_Store_mem == 1);
1242 return get_irn_n(node, 1);
1245 void set_memop_ptr(ir_node *node, ir_node *ptr)
1247 assert(is_memop(node));
1248 assert(n_Load_mem == 1 && n_Store_mem == 1);
1249 set_irn_n(node, 1, ptr);
1253 ir_node **get_Sync_preds_arr(ir_node *node)
1255 assert(is_Sync(node));
1256 return (ir_node **)&(get_irn_in(node)[1]);
1259 int get_Sync_n_preds(const ir_node *node)
1261 assert(is_Sync(node));
1262 return (get_irn_arity(node));
1266 void set_Sync_n_preds(ir_node *node, int n_preds)
1268 assert(is_Sync(node));
1272 ir_node *get_Sync_pred(const ir_node *node, int pos)
1274 assert(is_Sync(node));
1275 return get_irn_n(node, pos);
1278 void set_Sync_pred(ir_node *node, int pos, ir_node *pred)
1280 assert(is_Sync(node));
1281 set_irn_n(node, pos, pred);
1284 /* Add a new Sync predecessor */
1285 void add_Sync_pred(ir_node *node, ir_node *pred)
1287 assert(is_Sync(node));
1288 add_irn_n(node, pred);
1291 int (is_arg_Proj)(const ir_node *node)
1293 return is_arg_Proj_(node);
1296 int is_x_except_Proj(const ir_node *node)
1301 pred = get_Proj_pred(node);
1302 if (!is_fragile_op(pred))
1304 return get_Proj_proj(node) == pred->op->pn_x_except;
1307 int is_x_regular_Proj(const ir_node *node)
1312 pred = get_Proj_pred(node);
1313 if (!is_fragile_op(pred))
1315 return get_Proj_proj(node) == pred->op->pn_x_regular;
1318 void ir_set_throws_exception(ir_node *node, int throws_exception)
1320 except_attr *attr = &node->attr.except;
1321 assert(is_fragile_op(node));
1322 attr->throws_exception = throws_exception;
1325 int ir_throws_exception(const ir_node *node)
1327 const except_attr *attr = &node->attr.except;
1328 assert(is_fragile_op(node));
1329 return attr->throws_exception;
1332 ir_node **get_Tuple_preds_arr(ir_node *node)
1334 assert(is_Tuple(node));
1335 return (ir_node **)&(get_irn_in(node)[1]);
1338 int get_Tuple_n_preds(const ir_node *node)
1340 assert(is_Tuple(node));
1341 return get_irn_arity(node);
1344 ir_node *get_Tuple_pred(const ir_node *node, int pos)
1346 assert(is_Tuple(node));
1347 return get_irn_n(node, pos);
1350 void set_Tuple_pred(ir_node *node, int pos, ir_node *pred)
1352 assert(is_Tuple(node));
1353 set_irn_n(node, pos, pred);
1356 int get_ASM_n_input_constraints(const ir_node *node)
1358 assert(is_ASM(node));
1359 return ARR_LEN(node->attr.assem.input_constraints);
1362 int get_ASM_n_output_constraints(const ir_node *node)
1364 assert(is_ASM(node));
1365 return ARR_LEN(node->attr.assem.output_constraints);
1368 int get_ASM_n_clobbers(const ir_node *node)
1370 assert(is_ASM(node));
1371 return ARR_LEN(node->attr.assem.clobbers);
1374 /* returns the graph of a node */
1375 ir_graph *(get_irn_irg)(const ir_node *node)
1377 return get_irn_irg_(node);
1381 /*----------------------------------------------------------------*/
1382 /* Auxiliary routines */
1383 /*----------------------------------------------------------------*/
1385 ir_node *skip_Proj(ir_node *node)
1387 /* don't assert node !!! */
1392 node = get_Proj_pred(node);
1398 skip_Proj_const(const ir_node *node)
1400 /* don't assert node !!! */
1405 node = get_Proj_pred(node);
1410 ir_node *skip_Tuple(ir_node *node)
1415 if (is_Proj(node)) {
1416 pred = get_Proj_pred(node);
1418 if (is_Proj(pred)) { /* nested Tuple ? */
1419 pred = skip_Tuple(pred);
1421 if (is_Tuple(pred)) {
1422 node = get_Tuple_pred(pred, get_Proj_proj(node));
1425 } else if (is_Tuple(pred)) {
1426 node = get_Tuple_pred(pred, get_Proj_proj(node));
1433 /* returns operand of node if node is a Cast */
1434 ir_node *skip_Cast(ir_node *node)
1437 return get_Cast_op(node);
1441 /* returns operand of node if node is a Cast */
1442 const ir_node *skip_Cast_const(const ir_node *node)
1445 return get_Cast_op(node);
1449 /* returns operand of node if node is a Pin */
1450 ir_node *skip_Pin(ir_node *node)
1453 return get_Pin_op(node);
1457 /* returns operand of node if node is a Confirm */
1458 ir_node *skip_Confirm(ir_node *node)
1460 if (is_Confirm(node))
1461 return get_Confirm_value(node);
1465 /* skip all high-level ops */
1466 ir_node *skip_HighLevel_ops(ir_node *node)
1468 while (is_op_highlevel(get_irn_op(node))) {
1469 node = get_irn_n(node, 0);
1475 /* This should compact Id-cycles to self-cycles. It has the same (or less?) complexity
1476 * than any other approach, as Id chains are resolved and all point to the real node, or
1477 * all id's are self loops.
1479 * Note: This function takes 10% of mostly ANY the compiler run, so it's
1480 * a little bit "hand optimized".
1482 ir_node *skip_Id(ir_node *node)
1485 /* don't assert node !!! */
1487 if (!node || (node->op != op_Id)) return node;
1489 /* Don't use get_Id_pred(): We get into an endless loop for
1490 self-referencing Ids. */
1491 pred = node->in[0+1];
1493 if (pred->op != op_Id) return pred;
1495 if (node != pred) { /* not a self referencing Id. Resolve Id chain. */
1496 ir_node *rem_pred, *res;
1498 if (pred->op != op_Id) return pred; /* shortcut */
1501 assert(get_irn_arity (node) > 0);
1503 node->in[0+1] = node; /* turn us into a self referencing Id: shorten Id cycles. */
1504 res = skip_Id(rem_pred);
1505 if (is_Id(res)) /* self-loop */ return node;
1507 node->in[0+1] = res; /* Turn Id chain into Ids all referencing the chain end. */
1514 int (is_strictConv)(const ir_node *node)
1516 return is_strictConv_(node);
1519 /* Returns true if node is a SymConst node with kind symconst_addr_ent. */
1520 int (is_SymConst_addr_ent)(const ir_node *node)
1522 return is_SymConst_addr_ent_(node);
1525 /* Returns true if the operation manipulates control flow. */
1526 int is_cfop(const ir_node *node)
1528 if (is_fragile_op(node) && ir_throws_exception(node))
1531 return is_op_cfopcode(get_irn_op(node));
1534 int is_unknown_jump(const ir_node *node)
1536 return is_op_unknown_jump(get_irn_op(node));
1539 /* Returns true if the operation can change the control flow because
1541 int is_fragile_op(const ir_node *node)
1543 return is_op_fragile(get_irn_op(node));
1546 /* Returns the memory operand of fragile operations. */
1547 ir_node *get_fragile_op_mem(ir_node *node)
1549 assert(node && is_fragile_op(node));
1550 return get_irn_n(node, node->op->fragile_mem_index);
1553 /* Returns true if the operation is a forking control flow operation. */
1554 int (is_irn_forking)(const ir_node *node)
1556 return is_irn_forking_(node);
1559 void (copy_node_attr)(ir_graph *irg, const ir_node *old_node, ir_node *new_node)
1561 copy_node_attr_(irg, old_node, new_node);
1564 /* Return the type attribute of a node n (SymConst, Call, Alloc, Free,
1566 ir_type *(get_irn_type_attr)(ir_node *node)
1568 return get_irn_type_attr_(node);
1571 /* Return the entity attribute of a node n (SymConst, Sel) or NULL. */
1572 ir_entity *(get_irn_entity_attr)(ir_node *node)
1574 return get_irn_entity_attr_(node);
1577 /* Returns non-zero for constant-like nodes. */
1578 int (is_irn_constlike)(const ir_node *node)
1580 return is_irn_constlike_(node);
1584 * Returns non-zero for nodes that are allowed to have keep-alives and
1585 * are neither Block nor PhiM.
1587 int (is_irn_keep)(const ir_node *node)
1589 return is_irn_keep_(node);
1593 * Returns non-zero for nodes that are always placed in the start block.
1595 int (is_irn_start_block_placed)(const ir_node *node)
1597 return is_irn_start_block_placed_(node);
1600 /* Returns non-zero for nodes that are CSE neutral to its users. */
1601 int (is_irn_cse_neutral)(const ir_node *node)
1603 return is_irn_cse_neutral_(node);
1606 /* Gets the string representation of the jump prediction .*/
1607 const char *get_cond_jmp_predicate_name(cond_jmp_predicate pred)
1609 #define X(a) case a: return #a
1611 X(COND_JMP_PRED_NONE);
1612 X(COND_JMP_PRED_TRUE);
1613 X(COND_JMP_PRED_FALSE);
1619 /** Return the attribute type of a SymConst node if exists */
1620 static ir_type *get_SymConst_attr_type(const ir_node *self)
1622 symconst_kind kind = get_SymConst_kind(self);
1623 if (SYMCONST_HAS_TYPE(kind))
1624 return get_SymConst_type(self);
1628 /** Return the attribute entity of a SymConst node if exists */
1629 static ir_entity *get_SymConst_attr_entity(const ir_node *self)
1631 symconst_kind kind = get_SymConst_kind(self);
1632 if (SYMCONST_HAS_ENT(kind))
1633 return get_SymConst_entity(self);
1637 /** the get_type_attr operation must be always implemented */
1638 static ir_type *get_Null_type(const ir_node *n)
1641 return firm_unknown_type;
1644 /* Sets the get_type operation for an ir_op_ops. */
1645 void firm_set_default_get_type_attr(unsigned code, ir_op_ops *ops)
1648 case iro_Alloc: ops->get_type_attr = get_Alloc_type; break;
1649 case iro_Builtin: ops->get_type_attr = get_Builtin_type; break;
1650 case iro_Call: ops->get_type_attr = get_Call_type; break;
1651 case iro_Cast: ops->get_type_attr = get_Cast_type; break;
1652 case iro_CopyB: ops->get_type_attr = get_CopyB_type; break;
1653 case iro_Free: ops->get_type_attr = get_Free_type; break;
1654 case iro_InstOf: ops->get_type_attr = get_InstOf_type; break;
1655 case iro_SymConst: ops->get_type_attr = get_SymConst_attr_type; break;
1657 /* not allowed to be NULL */
1658 if (! ops->get_type_attr)
1659 ops->get_type_attr = get_Null_type;
1664 /** the get_entity_attr operation must be always implemented */
1665 static ir_entity *get_Null_ent(const ir_node *n)
1671 /* Sets the get_type operation for an ir_op_ops. */
1672 void firm_set_default_get_entity_attr(unsigned code, ir_op_ops *ops)
1675 case iro_SymConst: ops->get_entity_attr = get_SymConst_attr_entity; break;
1676 case iro_Sel: ops->get_entity_attr = get_Sel_entity; break;
1678 /* not allowed to be NULL */
1679 if (! ops->get_entity_attr)
1680 ops->get_entity_attr = get_Null_ent;
1685 /* Sets the debug information of a node. */
1686 void (set_irn_dbg_info)(ir_node *n, dbg_info *db)
1688 set_irn_dbg_info_(n, db);
1692 * Returns the debug information of an node.
1694 * @param n The node.
1696 dbg_info *(get_irn_dbg_info)(const ir_node *n)
1698 return get_irn_dbg_info_(n);
1701 ir_switch_table *ir_new_switch_table(ir_graph *irg, size_t n_entries)
1703 struct obstack *obst = get_irg_obstack(irg);
1704 ir_switch_table *res = OALLOCFZ(obst, ir_switch_table, entries, n_entries);
1705 res->n_entries = n_entries;
1709 void ir_switch_table_set(ir_switch_table *table, size_t n,
1710 ir_tarval *min, ir_tarval *max, long pn)
1712 ir_switch_table_entry *entry = ir_switch_table_get_entry(table, n);
1718 size_t (ir_switch_table_get_n_entries)(const ir_switch_table *table)
1720 return ir_switch_table_get_n_entries_(table);
1723 ir_tarval *ir_switch_table_get_max(const ir_switch_table *table, size_t e)
1725 return ir_switch_table_get_entry_const(table, e)->max;
1728 ir_tarval *ir_switch_table_get_min(const ir_switch_table *table, size_t e)
1730 return ir_switch_table_get_entry_const(table, e)->min;
1733 long ir_switch_table_get_pn(const ir_switch_table *table, size_t e)
1735 return ir_switch_table_get_entry_const(table, e)->pn;
1738 ir_switch_table *ir_switch_table_duplicate(ir_graph *irg,
1739 const ir_switch_table *table)
1741 size_t n_entries = ir_switch_table_get_n_entries(table);
1743 ir_switch_table *res = ir_new_switch_table(irg, n_entries);
1744 for (e = 0; e < n_entries; ++e) {
1745 const ir_switch_table_entry *entry
1746 = ir_switch_table_get_entry_const(table, e);
1747 ir_switch_table_entry *new_entry = ir_switch_table_get_entry(res, e);
1748 *new_entry = *entry;
1754 * Calculate a hash value of a node.
1756 unsigned firm_default_hash(const ir_node *node)
1761 /* hash table value = 9*(9*(9*(9*(9*arity+in[0])+in[1])+ ...)+mode)+code */
1762 h = irn_arity = get_irn_arity(node);
1764 /* consider all in nodes... except the block if not a control flow. */
1765 for (i = is_cfop(node) ? -1 : 0; i < irn_arity; ++i) {
1766 ir_node *pred = get_irn_n(node, i);
1767 if (is_irn_cse_neutral(pred))
1770 h = 9*h + HASH_PTR(pred);
1774 h = 9*h + HASH_PTR(get_irn_mode(node));
1776 h = 9*h + HASH_PTR(get_irn_op(node));
1781 /* include generated code */
1782 #include "gen_irnode.c.inl"