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
33 #include "irgraph_t.h"
35 #include "irbackedge_t.h"
39 #include "iredgekinds.h"
40 #include "iredges_t.h"
50 /* some constants fixing the positions of nodes predecessors
52 #define CALL_PARAM_OFFSET 2
53 #define BUILDIN_PARAM_OFFSET 1
54 #define SEL_INDEX_OFFSET 2
55 #define RETURN_RESULT_OFFSET 1 /* mem is not a result */
56 #define END_KEEPALIVE_OFFSET 0
58 static const char *relation_names [] = {
70 "unordered_less_equal",
72 "unordered_greater_equal",
77 const char *get_relation_string(ir_relation relation)
79 assert(relation < (ir_relation)ARRAY_SIZE(relation_names));
80 return relation_names[relation];
83 ir_relation get_negated_relation(ir_relation relation)
85 return relation ^ ir_relation_true;
88 ir_relation get_inversed_relation(ir_relation relation)
90 ir_relation code = relation & ~(ir_relation_less|ir_relation_greater);
91 bool less = relation & ir_relation_less;
92 bool greater = relation & ir_relation_greater;
93 code |= (less ? ir_relation_greater : 0) | (greater ? ir_relation_less : 0);
98 * Indicates, whether additional data can be registered to ir nodes.
99 * If set to 1, this is not possible anymore.
101 static int forbid_new_data = 0;
104 * The amount of additional space for custom data to be allocated upon
105 * creating a new node.
107 unsigned firm_add_node_size = 0;
110 /* register new space for every node */
111 unsigned firm_register_additional_node_data(unsigned size)
113 assert(!forbid_new_data && "Too late to register additional node data");
118 return firm_add_node_size += size;
122 void init_irnode(void)
124 /* Forbid the addition of new data to an ir node. */
128 struct struct_align {
138 * irnode constructor.
139 * Create a new irnode in irg, with an op, mode, arity and
140 * some incoming irnodes.
141 * If arity is negative, a node with a dynamic array is created.
143 ir_node *new_ir_node(dbg_info *db, ir_graph *irg, ir_node *block, ir_op *op,
144 ir_mode *mode, int arity, ir_node *const *in)
147 unsigned align = offsetof(struct struct_align, s) - 1;
148 unsigned add_node_size = (firm_add_node_size + align) & ~align;
149 size_t node_size = offsetof(ir_node, attr) + op->attr_size + add_node_size;
156 p = (char*)obstack_alloc(irg->obst, node_size);
157 memset(p, 0, node_size);
158 res = (ir_node *)(p + add_node_size);
160 res->kind = k_ir_node;
164 res->node_idx = irg_register_node_idx(irg, res);
169 res->in = NEW_ARR_F(ir_node *, 1); /* 1: space for block */
171 /* not nice but necessary: End and Sync must always have a flexible array */
172 if (op == op_End || op == op_Sync)
173 res->in = NEW_ARR_F(ir_node *, (arity+1));
175 res->in = NEW_ARR_D(ir_node *, irg->obst, (arity+1));
176 memcpy(&res->in[1], in, sizeof(ir_node *) * arity);
180 set_irn_dbg_info(res, db);
182 res->node_nr = get_irp_new_node_nr();
184 for (i = 0; i < EDGE_KIND_LAST; ++i) {
185 INIT_LIST_HEAD(&res->edge_info[i].outs_head);
186 /* edges will be build immediately */
187 res->edge_info[i].edges_built = 1;
188 res->edge_info[i].out_count = 0;
191 /* don't put this into the for loop, arity is -1 for some nodes! */
192 edges_notify_edge(res, -1, res->in[0], NULL, irg);
193 for (i = 1; i <= arity; ++i)
194 edges_notify_edge(res, i - 1, res->in[i], NULL, irg);
196 hook_new_node(irg, res);
197 if (get_irg_phase_state(irg) == phase_backend) {
198 be_info_new_node(res);
204 /*-- getting some parameters from ir_nodes --*/
206 int (is_ir_node)(const void *thing)
208 return _is_ir_node(thing);
211 int (get_irn_arity)(const ir_node *node)
213 return _get_irn_arity(node);
216 /* Returns the array with ins. This array is shifted with respect to the
217 array accessed by get_irn_n: The block operand is at position 0 not -1.
218 (@@@ This should be changed.)
219 The order of the predecessors in this array is not guaranteed, except that
220 lists of operands as predecessors of Block or arguments of a Call are
222 ir_node **get_irn_in(const ir_node *node)
227 void set_irn_in(ir_node *node, int arity, ir_node **in)
231 ir_graph *irg = get_irn_irg(node);
236 for (i = 0; i < arity; i++) {
237 if (i < (int)ARR_LEN(*pOld_in)-1)
238 edges_notify_edge(node, i, in[i], (*pOld_in)[i+1], irg);
240 edges_notify_edge(node, i, in[i], NULL, irg);
242 for (;i < (int)ARR_LEN(*pOld_in)-1; i++) {
243 edges_notify_edge(node, i, NULL, (*pOld_in)[i+1], irg);
246 if (arity != (int)ARR_LEN(*pOld_in) - 1) {
247 ir_node * block = (*pOld_in)[0];
248 *pOld_in = NEW_ARR_D(ir_node *, irg->obst, arity + 1);
249 (*pOld_in)[0] = block;
251 fix_backedges(irg->obst, node);
253 memcpy((*pOld_in) + 1, in, sizeof(ir_node *) * arity);
256 ir_node *(get_irn_n)(const ir_node *node, int n)
258 return _get_irn_n(node, n);
261 void set_irn_n(ir_node *node, int n, ir_node *in)
263 ir_graph *irg = get_irn_irg(node);
264 assert(node && node->kind == k_ir_node);
266 assert(n < get_irn_arity(node));
267 assert(in && in->kind == k_ir_node);
270 hook_set_irn_n(node, n, in, node->in[n + 1]);
272 /* Here, we rely on src and tgt being in the current ir graph */
273 edges_notify_edge(node, n, in, node->in[n + 1], irg);
275 node->in[n + 1] = in;
278 int add_irn_n(ir_node *node, ir_node *in)
281 ir_graph *irg = get_irn_irg(node);
283 assert(node->op->opar == oparity_dynamic);
284 pos = ARR_LEN(node->in) - 1;
285 ARR_APP1(ir_node *, node->in, in);
286 edges_notify_edge(node, pos, node->in[pos + 1], NULL, irg);
289 hook_set_irn_n(node, pos, node->in[pos + 1], NULL);
294 void del_Sync_n(ir_node *n, int i)
296 int arity = get_Sync_n_preds(n);
297 ir_node *last_pred = get_Sync_pred(n, arity - 1);
298 set_Sync_pred(n, i, last_pred);
299 edges_notify_edge(n, arity - 1, NULL, last_pred, get_irn_irg(n));
300 ARR_SHRINKLEN(get_irn_in(n), arity);
303 int (get_irn_deps)(const ir_node *node)
305 return _get_irn_deps(node);
308 ir_node *(get_irn_dep)(const ir_node *node, int pos)
310 return _get_irn_dep(node, pos);
313 void (set_irn_dep)(ir_node *node, int pos, ir_node *dep)
315 _set_irn_dep(node, pos, dep);
318 int add_irn_dep(ir_node *node, ir_node *dep)
322 /* DEP edges are only allowed in backend phase */
323 assert(get_irg_phase_state(get_irn_irg(node)) == phase_backend);
324 if (node->deps == NULL) {
325 node->deps = NEW_ARR_F(ir_node *, 1);
331 for (i = 0, n = ARR_LEN(node->deps); i < n; ++i) {
332 if (node->deps[i] == NULL)
335 if (node->deps[i] == dep)
339 if (first_zero >= 0) {
340 node->deps[first_zero] = dep;
343 ARR_APP1(ir_node *, node->deps, dep);
348 edges_notify_edge_kind(node, res, dep, NULL, EDGE_KIND_DEP, get_irn_irg(node));
353 void add_irn_deps(ir_node *tgt, ir_node *src)
357 for (i = 0, n = get_irn_deps(src); i < n; ++i)
358 add_irn_dep(tgt, get_irn_dep(src, i));
362 ir_mode *(get_irn_mode)(const ir_node *node)
364 return _get_irn_mode(node);
367 void (set_irn_mode)(ir_node *node, ir_mode *mode)
369 _set_irn_mode(node, mode);
372 ir_op *(get_irn_op)(const ir_node *node)
374 return _get_irn_op(node);
377 /* should be private to the library: */
378 void (set_irn_op)(ir_node *node, ir_op *op)
380 _set_irn_op(node, op);
383 unsigned (get_irn_opcode)(const ir_node *node)
385 return _get_irn_opcode(node);
388 const char *get_irn_opname(const ir_node *node)
391 if (is_Phi0(node)) return "Phi0";
392 return get_id_str(node->op->name);
395 ident *get_irn_opident(const ir_node *node)
398 return node->op->name;
401 ir_visited_t (get_irn_visited)(const ir_node *node)
403 return _get_irn_visited(node);
406 void (set_irn_visited)(ir_node *node, ir_visited_t visited)
408 _set_irn_visited(node, visited);
411 void (mark_irn_visited)(ir_node *node)
413 _mark_irn_visited(node);
416 int (irn_visited)(const ir_node *node)
418 return _irn_visited(node);
421 int (irn_visited_else_mark)(ir_node *node)
423 return _irn_visited_else_mark(node);
426 void (set_irn_link)(ir_node *node, void *link)
428 _set_irn_link(node, link);
431 void *(get_irn_link)(const ir_node *node)
433 return _get_irn_link(node);
436 op_pin_state (get_irn_pinned)(const ir_node *node)
438 return _get_irn_pinned(node);
441 op_pin_state (is_irn_pinned_in_irg) (const ir_node *node)
443 return _is_irn_pinned_in_irg(node);
446 void set_irn_pinned(ir_node *node, op_pin_state state)
448 /* due to optimization an opt may be turned into a Tuple */
452 assert(node && get_op_pinned(get_irn_op(node)) >= op_pin_state_exc_pinned);
453 assert(state == op_pin_state_pinned || state == op_pin_state_floats);
455 node->attr.except.pin_state = state;
458 /* Outputs a unique number for this node */
459 long get_irn_node_nr(const ir_node *node)
462 return node->node_nr;
465 void *(get_irn_generic_attr)(ir_node *node)
467 assert(is_ir_node(node));
468 return _get_irn_generic_attr(node);
471 const void *(get_irn_generic_attr_const)(const ir_node *node)
473 assert(is_ir_node(node));
474 return _get_irn_generic_attr_const(node);
477 unsigned (get_irn_idx)(const ir_node *node)
479 assert(is_ir_node(node));
480 return _get_irn_idx(node);
483 int get_irn_pred_pos(ir_node *node, ir_node *arg)
486 for (i = get_irn_arity(node) - 1; i >= 0; i--) {
487 if (get_irn_n(node, i) == arg)
493 /** manipulate fields of individual nodes **/
495 ir_node *(get_nodes_block)(const ir_node *node)
497 return _get_nodes_block(node);
500 void set_nodes_block(ir_node *node, ir_node *block)
502 assert(node->op != op_Block);
503 set_irn_n(node, -1, block);
506 /* Test whether arbitrary node is frame pointer, i.e. Proj(pn_Start_P_frame_base)
507 * from Start. If so returns frame type, else Null. */
508 ir_type *is_frame_pointer(const ir_node *n)
510 if (is_Proj(n) && (get_Proj_proj(n) == pn_Start_P_frame_base)) {
511 ir_node *start = get_Proj_pred(n);
512 if (is_Start(start)) {
513 return get_irg_frame_type(get_irn_irg(start));
519 ir_node **get_Block_cfgpred_arr(ir_node *node)
521 assert(is_Block(node));
522 return (ir_node **)&(get_irn_in(node)[1]);
525 int (get_Block_n_cfgpreds)(const ir_node *node)
527 return _get_Block_n_cfgpreds(node);
530 ir_node *(get_Block_cfgpred)(const ir_node *node, int pos)
532 return _get_Block_cfgpred(node, pos);
535 void set_Block_cfgpred(ir_node *node, int pos, ir_node *pred)
537 assert(is_Block(node));
538 set_irn_n(node, pos, pred);
541 int get_Block_cfgpred_pos(const ir_node *block, const ir_node *pred)
545 for (i = get_Block_n_cfgpreds(block) - 1; i >= 0; --i) {
546 if (get_Block_cfgpred_block(block, i) == pred)
552 ir_node *(get_Block_cfgpred_block)(const ir_node *node, int pos)
554 return _get_Block_cfgpred_block(node, pos);
557 int get_Block_matured(const ir_node *node)
559 assert(is_Block(node));
560 return (int)node->attr.block.is_matured;
563 void set_Block_matured(ir_node *node, int matured)
565 assert(is_Block(node));
566 node->attr.block.is_matured = matured;
569 ir_visited_t (get_Block_block_visited)(const ir_node *node)
571 return _get_Block_block_visited(node);
574 void (set_Block_block_visited)(ir_node *node, ir_visited_t visit)
576 _set_Block_block_visited(node, visit);
579 void (mark_Block_block_visited)(ir_node *node)
581 _mark_Block_block_visited(node);
584 int (Block_block_visited)(const ir_node *node)
586 return _Block_block_visited(node);
589 ir_node *(set_Block_dead)(ir_node *block)
591 return _set_Block_dead(block);
594 int (is_Block_dead)(const ir_node *block)
596 return _is_Block_dead(block);
599 ir_extblk *get_Block_extbb(const ir_node *block)
602 assert(is_Block(block));
603 res = block->attr.block.extblk;
604 assert(res == NULL || is_ir_extbb(res));
608 void set_Block_extbb(ir_node *block, ir_extblk *extblk)
610 assert(is_Block(block));
611 assert(extblk == NULL || is_ir_extbb(extblk));
612 block->attr.block.extblk = extblk;
615 /* returns the graph of a Block. */
616 ir_graph *(get_Block_irg)(const ir_node *block)
618 return _get_Block_irg(block);
621 ir_entity *create_Block_entity(ir_node *block)
624 assert(is_Block(block));
626 entity = block->attr.block.entity;
627 if (entity == NULL) {
631 glob = get_glob_type();
632 entity = new_entity(glob, id_unique("block_%u"), get_code_type());
633 set_entity_visibility(entity, ir_visibility_local);
634 set_entity_linkage(entity, IR_LINKAGE_CONSTANT);
635 nr = get_irp_next_label_nr();
636 set_entity_label(entity, nr);
637 set_entity_compiler_generated(entity, 1);
639 block->attr.block.entity = entity;
644 ir_entity *get_Block_entity(const ir_node *block)
646 assert(is_Block(block));
647 return block->attr.block.entity;
650 void set_Block_entity(ir_node *block, ir_entity *entity)
652 assert(is_Block(block));
653 assert(get_entity_type(entity) == get_code_type());
654 block->attr.block.entity = entity;
657 int has_Block_entity(const ir_node *block)
659 return block->attr.block.entity != NULL;
662 ir_node *(get_Block_phis)(const ir_node *block)
664 return _get_Block_phis(block);
667 void (set_Block_phis)(ir_node *block, ir_node *phi)
669 _set_Block_phis(block, phi);
672 void (add_Block_phi)(ir_node *block, ir_node *phi)
674 _add_Block_phi(block, phi);
677 /* Get the Block mark (single bit). */
678 unsigned (get_Block_mark)(const ir_node *block)
680 return _get_Block_mark(block);
683 /* Set the Block mark (single bit). */
684 void (set_Block_mark)(ir_node *block, unsigned mark)
686 _set_Block_mark(block, mark);
689 int get_End_n_keepalives(const ir_node *end)
692 return (get_irn_arity(end) - END_KEEPALIVE_OFFSET);
695 ir_node *get_End_keepalive(const ir_node *end, int pos)
698 return get_irn_n(end, pos + END_KEEPALIVE_OFFSET);
701 void add_End_keepalive(ir_node *end, ir_node *ka)
707 void set_End_keepalive(ir_node *end, int pos, ir_node *ka)
710 set_irn_n(end, pos + END_KEEPALIVE_OFFSET, ka);
713 /* Set new keep-alives */
714 void set_End_keepalives(ir_node *end, int n, ir_node *in[])
718 ir_graph *irg = get_irn_irg(end);
720 /* notify that edges are deleted */
721 for (e = END_KEEPALIVE_OFFSET; e < ARR_LEN(end->in) - 1; ++e) {
722 edges_notify_edge(end, e, NULL, end->in[e + 1], irg);
724 ARR_RESIZE(ir_node *, end->in, n + 1 + END_KEEPALIVE_OFFSET);
726 for (i = 0; i < n; ++i) {
727 end->in[1 + END_KEEPALIVE_OFFSET + i] = in[i];
728 edges_notify_edge(end, END_KEEPALIVE_OFFSET + i, end->in[1 + END_KEEPALIVE_OFFSET + i], NULL, irg);
732 /* Set new keep-alives from old keep-alives, skipping irn */
733 void remove_End_keepalive(ir_node *end, ir_node *irn)
735 int n = get_End_n_keepalives(end);
740 for (i = n -1; i >= 0; --i) {
741 ir_node *old_ka = end->in[1 + END_KEEPALIVE_OFFSET + i];
751 irg = get_irn_irg(end);
753 /* remove the edge */
754 edges_notify_edge(end, idx, NULL, irn, irg);
757 /* exchange with the last one */
758 ir_node *old = end->in[1 + END_KEEPALIVE_OFFSET + n - 1];
759 edges_notify_edge(end, n - 1, NULL, old, irg);
760 end->in[1 + END_KEEPALIVE_OFFSET + idx] = old;
761 edges_notify_edge(end, idx, old, NULL, irg);
763 /* now n - 1 keeps, 1 block input */
764 ARR_RESIZE(ir_node *, end->in, (n - 1) + 1 + END_KEEPALIVE_OFFSET);
767 /* remove Bads, NoMems and doublets from the keep-alive set */
768 void remove_End_Bads_and_doublets(ir_node *end)
771 int idx, n = get_End_n_keepalives(end);
777 irg = get_irn_irg(end);
778 pset_new_init(&keeps);
780 for (idx = n - 1; idx >= 0; --idx) {
781 ir_node *ka = get_End_keepalive(end, idx);
783 if (is_Bad(ka) || is_NoMem(ka) || pset_new_contains(&keeps, ka)) {
784 /* remove the edge */
785 edges_notify_edge(end, idx, NULL, ka, irg);
788 /* exchange with the last one */
789 ir_node *old = end->in[1 + END_KEEPALIVE_OFFSET + n - 1];
790 edges_notify_edge(end, n - 1, NULL, old, irg);
791 end->in[1 + END_KEEPALIVE_OFFSET + idx] = old;
792 edges_notify_edge(end, idx, old, NULL, irg);
796 pset_new_insert(&keeps, ka);
799 /* n keeps, 1 block input */
800 ARR_RESIZE(ir_node *, end->in, n + 1 + END_KEEPALIVE_OFFSET);
802 pset_new_destroy(&keeps);
805 void free_End(ir_node *end)
810 end->in = NULL; /* @@@ make sure we get an error if we use the
811 in array afterwards ... */
814 size_t get_Return_n_ress(const ir_node *node)
816 assert(is_Return(node));
817 return (size_t)(get_irn_arity(node) - RETURN_RESULT_OFFSET);
820 ir_node **get_Return_res_arr(ir_node *node)
822 assert(is_Return(node));
823 if (get_Return_n_ress(node) > 0)
824 return (ir_node **)&(get_irn_in(node)[1 + RETURN_RESULT_OFFSET]);
829 ir_node *get_Return_res(const ir_node *node, int pos)
831 assert(is_Return(node));
833 assert(get_Return_n_ress(node) > (size_t)pos);
834 return get_irn_n(node, pos + RETURN_RESULT_OFFSET);
837 void set_Return_res(ir_node *node, int pos, ir_node *res)
839 assert(is_Return(node));
840 set_irn_n(node, pos + RETURN_RESULT_OFFSET, res);
843 int (is_Const_null)(const ir_node *node)
845 return _is_Const_null(node);
848 int (is_Const_one)(const ir_node *node)
850 return _is_Const_one(node);
853 int (is_Const_all_one)(const ir_node *node)
855 return _is_Const_all_one(node);
860 symconst_kind get_SymConst_kind(const ir_node *node)
862 assert(is_SymConst(node));
863 return node->attr.symc.kind;
866 void set_SymConst_kind(ir_node *node, symconst_kind kind)
868 assert(is_SymConst(node));
869 node->attr.symc.kind = kind;
872 ir_type *get_SymConst_type(const ir_node *node)
874 /* the cast here is annoying, but we have to compensate for
876 ir_node *irn = (ir_node *)node;
877 assert(is_SymConst(node) &&
878 (SYMCONST_HAS_TYPE(get_SymConst_kind(node))));
879 return irn->attr.symc.sym.type_p;
882 void set_SymConst_type(ir_node *node, ir_type *tp)
884 assert(is_SymConst(node) &&
885 (SYMCONST_HAS_TYPE(get_SymConst_kind(node))));
886 node->attr.symc.sym.type_p = tp;
890 /* Only to access SymConst of kind symconst_addr_ent. Else assertion: */
891 ir_entity *get_SymConst_entity(const ir_node *node)
893 assert(is_SymConst(node) && SYMCONST_HAS_ENT(get_SymConst_kind(node)));
894 return node->attr.symc.sym.entity_p;
897 void set_SymConst_entity(ir_node *node, ir_entity *ent)
899 assert(is_SymConst(node) && SYMCONST_HAS_ENT(get_SymConst_kind(node)));
900 node->attr.symc.sym.entity_p = ent;
903 ir_enum_const *get_SymConst_enum(const ir_node *node)
905 assert(is_SymConst(node) && SYMCONST_HAS_ENUM(get_SymConst_kind(node)));
906 return node->attr.symc.sym.enum_p;
909 void set_SymConst_enum(ir_node *node, ir_enum_const *ec)
911 assert(is_SymConst(node) && SYMCONST_HAS_ENUM(get_SymConst_kind(node)));
912 node->attr.symc.sym.enum_p = ec;
915 union symconst_symbol
916 get_SymConst_symbol(const ir_node *node)
918 assert(is_SymConst(node));
919 return node->attr.symc.sym;
922 void set_SymConst_symbol(ir_node *node, union symconst_symbol sym)
924 assert(is_SymConst(node));
925 node->attr.symc.sym = sym;
928 int get_Sel_n_indexs(const ir_node *node)
930 assert(is_Sel(node));
931 return (get_irn_arity(node) - SEL_INDEX_OFFSET);
934 ir_node **get_Sel_index_arr(ir_node *node)
936 assert(is_Sel(node));
937 if (get_Sel_n_indexs(node) > 0)
938 return (ir_node **)& get_irn_in(node)[SEL_INDEX_OFFSET + 1];
943 ir_node *get_Sel_index(const ir_node *node, int pos)
945 assert(is_Sel(node));
946 return get_irn_n(node, pos + SEL_INDEX_OFFSET);
949 void set_Sel_index(ir_node *node, int pos, ir_node *index)
951 assert(is_Sel(node));
952 set_irn_n(node, pos + SEL_INDEX_OFFSET, index);
955 ir_node **get_Call_param_arr(ir_node *node)
957 assert(is_Call(node));
958 return &get_irn_in(node)[CALL_PARAM_OFFSET + 1];
961 size_t get_Call_n_params(const ir_node *node)
963 assert(is_Call(node));
964 return (size_t) (get_irn_arity(node) - CALL_PARAM_OFFSET);
967 ir_node *get_Call_param(const ir_node *node, int pos)
969 assert(is_Call(node));
970 return get_irn_n(node, pos + CALL_PARAM_OFFSET);
973 void set_Call_param(ir_node *node, int pos, ir_node *param)
975 assert(is_Call(node));
976 set_irn_n(node, pos + CALL_PARAM_OFFSET, param);
979 ir_node **get_Builtin_param_arr(ir_node *node)
981 assert(is_Builtin(node));
982 return &get_irn_in(node)[BUILDIN_PARAM_OFFSET + 1];
985 int get_Builtin_n_params(const ir_node *node)
987 assert(is_Builtin(node));
988 return (get_irn_arity(node) - BUILDIN_PARAM_OFFSET);
991 ir_node *get_Builtin_param(const ir_node *node, int pos)
993 assert(is_Builtin(node));
994 return get_irn_n(node, pos + BUILDIN_PARAM_OFFSET);
997 void set_Builtin_param(ir_node *node, int pos, ir_node *param)
999 assert(is_Builtin(node));
1000 set_irn_n(node, pos + BUILDIN_PARAM_OFFSET, param);
1003 /* Returns a human readable string for the ir_builtin_kind. */
1004 const char *get_builtin_kind_name(ir_builtin_kind kind)
1006 #define X(a) case a: return #a
1009 X(ir_bk_debugbreak);
1010 X(ir_bk_return_address);
1011 X(ir_bk_frame_address);
1021 X(ir_bk_inner_trampoline);
1028 int Call_has_callees(const ir_node *node)
1030 assert(is_Call(node));
1031 return ((get_irg_callee_info_state(get_irn_irg(node)) != irg_callee_info_none) &&
1032 (node->attr.call.callee_arr != NULL));
1035 size_t get_Call_n_callees(const ir_node *node)
1037 assert(is_Call(node) && node->attr.call.callee_arr);
1038 return ARR_LEN(node->attr.call.callee_arr);
1041 ir_entity *get_Call_callee(const ir_node *node, size_t pos)
1043 assert(pos < get_Call_n_callees(node));
1044 return node->attr.call.callee_arr[pos];
1047 void set_Call_callee_arr(ir_node *node, size_t n, ir_entity ** arr)
1049 ir_graph *irg = get_irn_irg(node);
1051 assert(is_Call(node));
1052 if (node->attr.call.callee_arr == NULL || get_Call_n_callees(node) != n) {
1053 node->attr.call.callee_arr = NEW_ARR_D(ir_entity *, irg->obst, n);
1055 memcpy(node->attr.call.callee_arr, arr, n * sizeof(ir_entity *));
1058 void remove_Call_callee_arr(ir_node *node)
1060 assert(is_Call(node));
1061 node->attr.call.callee_arr = NULL;
1065 * Returns non-zero if a Call is surely a self-recursive Call.
1066 * Beware: if this functions returns 0, the call might be self-recursive!
1068 int is_self_recursive_Call(const ir_node *call)
1070 const ir_node *callee = get_Call_ptr(call);
1072 if (is_SymConst_addr_ent(callee)) {
1073 const ir_entity *ent = get_SymConst_entity(callee);
1074 const ir_graph *irg = get_entity_irg(ent);
1075 if (irg == get_irn_irg(call))
1081 /* Checks for upcast.
1083 * Returns true if the Cast node casts a class type to a super type.
1085 int is_Cast_upcast(ir_node *node)
1087 ir_type *totype = get_Cast_type(node);
1088 ir_type *fromtype = get_irn_typeinfo_type(get_Cast_op(node));
1090 assert(get_irg_typeinfo_state(get_irn_irg(node)) == ir_typeinfo_consistent);
1093 while (is_Pointer_type(totype) && is_Pointer_type(fromtype)) {
1094 totype = get_pointer_points_to_type(totype);
1095 fromtype = get_pointer_points_to_type(fromtype);
1100 if (!is_Class_type(totype)) return 0;
1101 return is_SubClass_of(fromtype, totype);
1104 /* Checks for downcast.
1106 * Returns true if the Cast node casts a class type to a sub type.
1108 int is_Cast_downcast(ir_node *node)
1110 ir_type *totype = get_Cast_type(node);
1111 ir_type *fromtype = get_irn_typeinfo_type(get_Cast_op(node));
1113 assert(get_irg_typeinfo_state(get_irn_irg(node)) == ir_typeinfo_consistent);
1116 while (is_Pointer_type(totype) && is_Pointer_type(fromtype)) {
1117 totype = get_pointer_points_to_type(totype);
1118 fromtype = get_pointer_points_to_type(fromtype);
1123 if (!is_Class_type(totype)) return 0;
1124 return is_SubClass_of(totype, fromtype);
1127 int (is_unop)(const ir_node *node)
1129 return _is_unop(node);
1132 ir_node *get_unop_op(const ir_node *node)
1134 if (node->op->opar == oparity_unary)
1135 return get_irn_n(node, node->op->op_index);
1137 assert(node->op->opar == oparity_unary);
1141 void set_unop_op(ir_node *node, ir_node *op)
1143 if (node->op->opar == oparity_unary)
1144 set_irn_n(node, node->op->op_index, op);
1146 assert(node->op->opar == oparity_unary);
1149 int (is_binop)(const ir_node *node)
1151 return _is_binop(node);
1154 ir_node *get_binop_left(const ir_node *node)
1156 assert(node->op->opar == oparity_binary);
1157 return get_irn_n(node, node->op->op_index);
1160 void set_binop_left(ir_node *node, ir_node *left)
1162 assert(node->op->opar == oparity_binary);
1163 set_irn_n(node, node->op->op_index, left);
1166 ir_node *get_binop_right(const ir_node *node)
1168 assert(node->op->opar == oparity_binary);
1169 return get_irn_n(node, node->op->op_index + 1);
1172 void set_binop_right(ir_node *node, ir_node *right)
1174 assert(node->op->opar == oparity_binary);
1175 set_irn_n(node, node->op->op_index + 1, right);
1178 int is_Phi0(const ir_node *n)
1182 return ((get_irn_op(n) == op_Phi) &&
1183 (get_irn_arity(n) == 0) &&
1184 (get_irg_phase_state(get_irn_irg(n)) == phase_building));
1187 ir_node **get_Phi_preds_arr(ir_node *node)
1189 assert(is_Phi(node));
1190 return (ir_node **)&(get_irn_in(node)[1]);
1193 int get_Phi_n_preds(const ir_node *node)
1195 assert(is_Phi(node) || is_Phi0(node));
1196 return (get_irn_arity(node));
1199 ir_node *get_Phi_pred(const ir_node *node, int pos)
1201 assert(is_Phi(node) || is_Phi0(node));
1202 return get_irn_n(node, pos);
1205 void set_Phi_pred(ir_node *node, int pos, ir_node *pred)
1207 assert(is_Phi(node) || is_Phi0(node));
1208 set_irn_n(node, pos, pred);
1211 ir_node *(get_Phi_next)(const ir_node *phi)
1213 return _get_Phi_next(phi);
1216 void (set_Phi_next)(ir_node *phi, ir_node *next)
1218 _set_Phi_next(phi, next);
1221 int is_memop(const ir_node *node)
1223 unsigned code = get_irn_opcode(node);
1224 return (code == iro_Load || code == iro_Store);
1227 ir_node *get_memop_mem(const ir_node *node)
1229 assert(is_memop(node));
1230 return get_irn_n(node, 0);
1233 void set_memop_mem(ir_node *node, ir_node *mem)
1235 assert(is_memop(node));
1236 set_irn_n(node, 0, mem);
1239 ir_node *get_memop_ptr(const ir_node *node)
1241 assert(is_memop(node));
1242 return get_irn_n(node, 1);
1245 void set_memop_ptr(ir_node *node, ir_node *ptr)
1247 assert(is_memop(node));
1248 set_irn_n(node, 1, ptr);
1252 ir_node **get_Sync_preds_arr(ir_node *node)
1254 assert(is_Sync(node));
1255 return (ir_node **)&(get_irn_in(node)[1]);
1258 int get_Sync_n_preds(const ir_node *node)
1260 assert(is_Sync(node));
1261 return (get_irn_arity(node));
1265 void set_Sync_n_preds(ir_node *node, int n_preds)
1267 assert(is_Sync(node));
1271 ir_node *get_Sync_pred(const ir_node *node, int pos)
1273 assert(is_Sync(node));
1274 return get_irn_n(node, pos);
1277 void set_Sync_pred(ir_node *node, int pos, ir_node *pred)
1279 assert(is_Sync(node));
1280 set_irn_n(node, pos, pred);
1283 /* Add a new Sync predecessor */
1284 void add_Sync_pred(ir_node *node, ir_node *pred)
1286 assert(is_Sync(node));
1287 add_irn_n(node, pred);
1290 int (is_arg_Proj)(const ir_node *node)
1292 return _is_arg_Proj(node);
1295 ir_node **get_Tuple_preds_arr(ir_node *node)
1297 assert(is_Tuple(node));
1298 return (ir_node **)&(get_irn_in(node)[1]);
1301 int get_Tuple_n_preds(const ir_node *node)
1303 assert(is_Tuple(node));
1304 return get_irn_arity(node);
1307 ir_node *get_Tuple_pred(const ir_node *node, int pos)
1309 assert(is_Tuple(node));
1310 return get_irn_n(node, pos);
1313 void set_Tuple_pred(ir_node *node, int pos, ir_node *pred)
1315 assert(is_Tuple(node));
1316 set_irn_n(node, pos, pred);
1319 int get_ASM_n_input_constraints(const ir_node *node)
1321 assert(is_ASM(node));
1322 return ARR_LEN(node->attr.assem.input_constraints);
1325 int get_ASM_n_output_constraints(const ir_node *node)
1327 assert(is_ASM(node));
1328 return ARR_LEN(node->attr.assem.output_constraints);
1331 int get_ASM_n_clobbers(const ir_node *node)
1333 assert(is_ASM(node));
1334 return ARR_LEN(node->attr.assem.clobbers);
1337 /* returns the graph of a node */
1338 ir_graph *(get_irn_irg)(const ir_node *node)
1340 return _get_irn_irg(node);
1344 /*----------------------------------------------------------------*/
1345 /* Auxiliary routines */
1346 /*----------------------------------------------------------------*/
1348 ir_node *skip_Proj(ir_node *node)
1350 /* don't assert node !!! */
1355 node = get_Proj_pred(node);
1361 skip_Proj_const(const ir_node *node)
1363 /* don't assert node !!! */
1368 node = get_Proj_pred(node);
1373 ir_node *skip_Tuple(ir_node *node)
1378 if (is_Proj(node)) {
1379 pred = get_Proj_pred(node);
1381 if (is_Proj(pred)) { /* nested Tuple ? */
1382 pred = skip_Tuple(pred);
1384 if (is_Tuple(pred)) {
1385 node = get_Tuple_pred(pred, get_Proj_proj(node));
1388 } else if (is_Tuple(pred)) {
1389 node = get_Tuple_pred(pred, get_Proj_proj(node));
1396 /* returns operand of node if node is a Cast */
1397 ir_node *skip_Cast(ir_node *node)
1400 return get_Cast_op(node);
1404 /* returns operand of node if node is a Cast */
1405 const ir_node *skip_Cast_const(const ir_node *node)
1408 return get_Cast_op(node);
1412 /* returns operand of node if node is a Pin */
1413 ir_node *skip_Pin(ir_node *node)
1416 return get_Pin_op(node);
1420 /* returns operand of node if node is a Confirm */
1421 ir_node *skip_Confirm(ir_node *node)
1423 if (is_Confirm(node))
1424 return get_Confirm_value(node);
1428 /* skip all high-level ops */
1429 ir_node *skip_HighLevel_ops(ir_node *node)
1431 while (is_op_highlevel(get_irn_op(node))) {
1432 node = get_irn_n(node, 0);
1438 /* This should compact Id-cycles to self-cycles. It has the same (or less?) complexity
1439 * than any other approach, as Id chains are resolved and all point to the real node, or
1440 * all id's are self loops.
1442 * Note: This function takes 10% of mostly ANY the compiler run, so it's
1443 * a little bit "hand optimized".
1445 ir_node *skip_Id(ir_node *node)
1448 /* don't assert node !!! */
1450 if (!node || (node->op != op_Id)) return node;
1452 /* Don't use get_Id_pred(): We get into an endless loop for
1453 self-referencing Ids. */
1454 pred = node->in[0+1];
1456 if (pred->op != op_Id) return pred;
1458 if (node != pred) { /* not a self referencing Id. Resolve Id chain. */
1459 ir_node *rem_pred, *res;
1461 if (pred->op != op_Id) return pred; /* shortcut */
1464 assert(get_irn_arity (node) > 0);
1466 node->in[0+1] = node; /* turn us into a self referencing Id: shorten Id cycles. */
1467 res = skip_Id(rem_pred);
1468 if (is_Id(res)) /* self-loop */ return node;
1470 node->in[0+1] = res; /* Turn Id chain into Ids all referencing the chain end. */
1477 int (is_strictConv)(const ir_node *node)
1479 return _is_strictConv(node);
1482 /* Returns true if node is a SymConst node with kind symconst_addr_ent. */
1483 int (is_SymConst_addr_ent)(const ir_node *node)
1485 return _is_SymConst_addr_ent(node);
1488 /* Returns true if the operation manipulates control flow. */
1489 int is_cfop(const ir_node *node)
1491 return is_op_cfopcode(get_irn_op(node));
1494 /* Returns true if the operation can change the control flow because
1496 int is_fragile_op(const ir_node *node)
1498 return is_op_fragile(get_irn_op(node));
1501 /* Returns the memory operand of fragile operations. */
1502 ir_node *get_fragile_op_mem(ir_node *node)
1504 assert(node && is_fragile_op(node));
1506 switch (get_irn_opcode(node)) {
1515 return get_irn_n(node, pn_Generic_M);
1520 panic("should not be reached");
1524 /* Returns true if the operation is a forking control flow operation. */
1525 int (is_irn_forking)(const ir_node *node)
1527 return _is_irn_forking(node);
1530 void (copy_node_attr)(ir_graph *irg, const ir_node *old_node, ir_node *new_node)
1532 _copy_node_attr(irg, old_node, new_node);
1535 /* Return the type attribute of a node n (SymConst, Call, Alloc, Free,
1537 ir_type *(get_irn_type_attr)(ir_node *node)
1539 return _get_irn_type_attr(node);
1542 /* Return the entity attribute of a node n (SymConst, Sel) or NULL. */
1543 ir_entity *(get_irn_entity_attr)(ir_node *node)
1545 return _get_irn_entity_attr(node);
1548 /* Returns non-zero for constant-like nodes. */
1549 int (is_irn_constlike)(const ir_node *node)
1551 return _is_irn_constlike(node);
1555 * Returns non-zero for nodes that are allowed to have keep-alives and
1556 * are neither Block nor PhiM.
1558 int (is_irn_keep)(const ir_node *node)
1560 return _is_irn_keep(node);
1564 * Returns non-zero for nodes that are always placed in the start block.
1566 int (is_irn_start_block_placed)(const ir_node *node)
1568 return _is_irn_start_block_placed(node);
1571 /* Returns non-zero for nodes that are machine operations. */
1572 int (is_irn_machine_op)(const ir_node *node)
1574 return _is_irn_machine_op(node);
1577 /* Returns non-zero for nodes that are machine operands. */
1578 int (is_irn_machine_operand)(const ir_node *node)
1580 return _is_irn_machine_operand(node);
1583 /* Returns non-zero for nodes that have the n'th user machine flag set. */
1584 int (is_irn_machine_user)(const ir_node *node, unsigned n)
1586 return _is_irn_machine_user(node, n);
1589 /* Returns non-zero for nodes that are CSE neutral to its users. */
1590 int (is_irn_cse_neutral)(const ir_node *node)
1592 return _is_irn_cse_neutral(node);
1595 /* Gets the string representation of the jump prediction .*/
1596 const char *get_cond_jmp_predicate_name(cond_jmp_predicate pred)
1598 #define X(a) case a: return #a
1600 X(COND_JMP_PRED_NONE);
1601 X(COND_JMP_PRED_TRUE);
1602 X(COND_JMP_PRED_FALSE);
1608 /** Return the attribute type of a SymConst node if exists */
1609 static ir_type *get_SymConst_attr_type(const ir_node *self)
1611 symconst_kind kind = get_SymConst_kind(self);
1612 if (SYMCONST_HAS_TYPE(kind))
1613 return get_SymConst_type(self);
1617 /** Return the attribute entity of a SymConst node if exists */
1618 static ir_entity *get_SymConst_attr_entity(const ir_node *self)
1620 symconst_kind kind = get_SymConst_kind(self);
1621 if (SYMCONST_HAS_ENT(kind))
1622 return get_SymConst_entity(self);
1626 /** the get_type_attr operation must be always implemented */
1627 static ir_type *get_Null_type(const ir_node *n)
1630 return firm_unknown_type;
1633 /* Sets the get_type operation for an ir_op_ops. */
1634 ir_op_ops *firm_set_default_get_type_attr(unsigned code, ir_op_ops *ops)
1637 case iro_SymConst: ops->get_type_attr = get_SymConst_attr_type; break;
1638 case iro_Call: ops->get_type_attr = get_Call_type; break;
1639 case iro_Alloc: ops->get_type_attr = get_Alloc_type; break;
1640 case iro_Free: ops->get_type_attr = get_Free_type; break;
1641 case iro_Cast: ops->get_type_attr = get_Cast_type; break;
1643 /* not allowed to be NULL */
1644 if (! ops->get_type_attr)
1645 ops->get_type_attr = get_Null_type;
1651 /** the get_entity_attr operation must be always implemented */
1652 static ir_entity *get_Null_ent(const ir_node *n)
1658 /* Sets the get_type operation for an ir_op_ops. */
1659 ir_op_ops *firm_set_default_get_entity_attr(unsigned code, ir_op_ops *ops)
1662 case iro_SymConst: ops->get_entity_attr = get_SymConst_attr_entity; break;
1663 case iro_Sel: ops->get_entity_attr = get_Sel_entity; break;
1665 /* not allowed to be NULL */
1666 if (! ops->get_entity_attr)
1667 ops->get_entity_attr = get_Null_ent;
1673 /* Sets the debug information of a node. */
1674 void (set_irn_dbg_info)(ir_node *n, dbg_info *db)
1676 _set_irn_dbg_info(n, db);
1680 * Returns the debug information of an node.
1682 * @param n The node.
1684 dbg_info *(get_irn_dbg_info)(const ir_node *n)
1686 return _get_irn_dbg_info(n);
1689 /* checks whether a node represents a global address */
1690 int is_Global(const ir_node *node)
1692 return is_SymConst_addr_ent(node);
1695 /* returns the entity of a global address */
1696 ir_entity *get_Global_entity(const ir_node *node)
1698 return get_SymConst_entity(node);
1702 * Calculate a hash value of a node.
1704 unsigned firm_default_hash(const ir_node *node)
1709 /* hash table value = 9*(9*(9*(9*(9*arity+in[0])+in[1])+ ...)+mode)+code */
1710 h = irn_arity = get_irn_arity(node);
1712 /* consider all in nodes... except the block if not a control flow. */
1713 for (i = is_cfop(node) ? -1 : 0; i < irn_arity; ++i) {
1714 ir_node *pred = get_irn_n(node, i);
1715 if (is_irn_cse_neutral(pred))
1718 h = 9*h + HASH_PTR(pred);
1722 h = 9*h + HASH_PTR(get_irn_mode(node));
1724 h = 9*h + HASH_PTR(get_irn_op(node));
1727 } /* firm_default_hash */
1729 /* include generated code */
1730 #include "gen_irnode.c.inl"