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);
255 /* update irg flags */
256 set_irg_outs_inconsistent(irg);
257 set_irg_loopinfo_inconsistent(irg);
260 ir_node *(get_irn_n)(const ir_node *node, int n)
262 return _get_irn_n(node, n);
265 void set_irn_n(ir_node *node, int n, ir_node *in)
267 ir_graph *irg = get_irn_irg(node);
268 assert(node && node->kind == k_ir_node);
270 assert(n < get_irn_arity(node));
271 assert(in && in->kind == k_ir_node);
274 hook_set_irn_n(node, n, in, node->in[n + 1]);
276 /* Here, we rely on src and tgt being in the current ir graph */
277 edges_notify_edge(node, n, in, node->in[n + 1], irg);
279 node->in[n + 1] = in;
281 /* update irg flags */
282 set_irg_outs_inconsistent(irg);
283 set_irg_loopinfo_inconsistent(irg);
286 int add_irn_n(ir_node *node, ir_node *in)
289 ir_graph *irg = get_irn_irg(node);
291 assert(node->op->opar == oparity_dynamic);
292 pos = ARR_LEN(node->in) - 1;
293 ARR_APP1(ir_node *, node->in, in);
294 edges_notify_edge(node, pos, node->in[pos + 1], NULL, irg);
297 hook_set_irn_n(node, pos, node->in[pos + 1], NULL);
302 void del_Sync_n(ir_node *n, int i)
304 int arity = get_Sync_n_preds(n);
305 ir_node *last_pred = get_Sync_pred(n, arity - 1);
306 set_Sync_pred(n, i, last_pred);
307 edges_notify_edge(n, arity - 1, NULL, last_pred, get_irn_irg(n));
308 ARR_SHRINKLEN(get_irn_in(n), arity);
311 int (get_irn_deps)(const ir_node *node)
313 return _get_irn_deps(node);
316 ir_node *(get_irn_dep)(const ir_node *node, int pos)
318 return _get_irn_dep(node, pos);
321 void (set_irn_dep)(ir_node *node, int pos, ir_node *dep)
323 _set_irn_dep(node, pos, dep);
326 int add_irn_dep(ir_node *node, ir_node *dep)
330 /* DEP edges are only allowed in backend phase */
331 assert(get_irg_phase_state(get_irn_irg(node)) == phase_backend);
332 if (node->deps == NULL) {
333 node->deps = NEW_ARR_F(ir_node *, 1);
339 for (i = 0, n = ARR_LEN(node->deps); i < n; ++i) {
340 if (node->deps[i] == NULL)
343 if (node->deps[i] == dep)
347 if (first_zero >= 0) {
348 node->deps[first_zero] = dep;
351 ARR_APP1(ir_node *, node->deps, dep);
356 edges_notify_edge_kind(node, res, dep, NULL, EDGE_KIND_DEP, get_irn_irg(node));
361 void add_irn_deps(ir_node *tgt, ir_node *src)
365 for (i = 0, n = get_irn_deps(src); i < n; ++i)
366 add_irn_dep(tgt, get_irn_dep(src, i));
370 ir_mode *(get_irn_mode)(const ir_node *node)
372 return _get_irn_mode(node);
375 void (set_irn_mode)(ir_node *node, ir_mode *mode)
377 _set_irn_mode(node, mode);
380 ir_op *(get_irn_op)(const ir_node *node)
382 return _get_irn_op(node);
385 /* should be private to the library: */
386 void (set_irn_op)(ir_node *node, ir_op *op)
388 _set_irn_op(node, op);
391 unsigned (get_irn_opcode)(const ir_node *node)
393 return _get_irn_opcode(node);
396 const char *get_irn_opname(const ir_node *node)
399 if (is_Phi0(node)) return "Phi0";
400 return get_id_str(node->op->name);
403 ident *get_irn_opident(const ir_node *node)
406 return node->op->name;
409 ir_visited_t (get_irn_visited)(const ir_node *node)
411 return _get_irn_visited(node);
414 void (set_irn_visited)(ir_node *node, ir_visited_t visited)
416 _set_irn_visited(node, visited);
419 void (mark_irn_visited)(ir_node *node)
421 _mark_irn_visited(node);
424 int (irn_visited)(const ir_node *node)
426 return _irn_visited(node);
429 int (irn_visited_else_mark)(ir_node *node)
431 return _irn_visited_else_mark(node);
434 void (set_irn_link)(ir_node *node, void *link)
436 _set_irn_link(node, link);
439 void *(get_irn_link)(const ir_node *node)
441 return _get_irn_link(node);
444 op_pin_state (get_irn_pinned)(const ir_node *node)
446 return _get_irn_pinned(node);
449 op_pin_state (is_irn_pinned_in_irg) (const ir_node *node)
451 return _is_irn_pinned_in_irg(node);
454 void set_irn_pinned(ir_node *node, op_pin_state state)
456 /* due to optimization an opt may be turned into a Tuple */
460 assert(node && get_op_pinned(get_irn_op(node)) >= op_pin_state_exc_pinned);
461 assert(state == op_pin_state_pinned || state == op_pin_state_floats);
463 node->attr.except.pin_state = state;
466 /* Outputs a unique number for this node */
467 long get_irn_node_nr(const ir_node *node)
470 return node->node_nr;
473 void *(get_irn_generic_attr)(ir_node *node)
475 assert(is_ir_node(node));
476 return _get_irn_generic_attr(node);
479 const void *(get_irn_generic_attr_const)(const ir_node *node)
481 assert(is_ir_node(node));
482 return _get_irn_generic_attr_const(node);
485 unsigned (get_irn_idx)(const ir_node *node)
487 assert(is_ir_node(node));
488 return _get_irn_idx(node);
491 int get_irn_pred_pos(ir_node *node, ir_node *arg)
494 for (i = get_irn_arity(node) - 1; i >= 0; i--) {
495 if (get_irn_n(node, i) == arg)
501 /** manipulate fields of individual nodes **/
503 ir_node *(get_nodes_block)(const ir_node *node)
505 return _get_nodes_block(node);
508 void set_nodes_block(ir_node *node, ir_node *block)
510 assert(node->op != op_Block);
511 set_irn_n(node, -1, block);
514 /* Test whether arbitrary node is frame pointer, i.e. Proj(pn_Start_P_frame_base)
515 * from Start. If so returns frame type, else Null. */
516 ir_type *is_frame_pointer(const ir_node *n)
518 if (is_Proj(n) && (get_Proj_proj(n) == pn_Start_P_frame_base)) {
519 ir_node *start = get_Proj_pred(n);
520 if (is_Start(start)) {
521 return get_irg_frame_type(get_irn_irg(start));
527 ir_node **get_Block_cfgpred_arr(ir_node *node)
529 assert(is_Block(node));
530 return (ir_node **)&(get_irn_in(node)[1]);
533 int (get_Block_n_cfgpreds)(const ir_node *node)
535 return _get_Block_n_cfgpreds(node);
538 ir_node *(get_Block_cfgpred)(const ir_node *node, int pos)
540 return _get_Block_cfgpred(node, pos);
543 void set_Block_cfgpred(ir_node *node, int pos, ir_node *pred)
545 assert(is_Block(node));
546 set_irn_n(node, pos, pred);
549 int get_Block_cfgpred_pos(const ir_node *block, const ir_node *pred)
553 for (i = get_Block_n_cfgpreds(block) - 1; i >= 0; --i) {
554 if (get_Block_cfgpred_block(block, i) == pred)
560 ir_node *(get_Block_cfgpred_block)(const ir_node *node, int pos)
562 return _get_Block_cfgpred_block(node, pos);
565 int get_Block_matured(const ir_node *node)
567 assert(is_Block(node));
568 return (int)node->attr.block.is_matured;
571 void set_Block_matured(ir_node *node, int matured)
573 assert(is_Block(node));
574 node->attr.block.is_matured = matured;
577 ir_visited_t (get_Block_block_visited)(const ir_node *node)
579 return _get_Block_block_visited(node);
582 void (set_Block_block_visited)(ir_node *node, ir_visited_t visit)
584 _set_Block_block_visited(node, visit);
587 void (mark_Block_block_visited)(ir_node *node)
589 _mark_Block_block_visited(node);
592 int (Block_block_visited)(const ir_node *node)
594 return _Block_block_visited(node);
597 ir_extblk *get_Block_extbb(const ir_node *block)
600 assert(is_Block(block));
601 res = block->attr.block.extblk;
602 assert(res == NULL || is_ir_extbb(res));
606 void set_Block_extbb(ir_node *block, ir_extblk *extblk)
608 assert(is_Block(block));
609 assert(extblk == NULL || is_ir_extbb(extblk));
610 block->attr.block.extblk = extblk;
613 /* returns the graph of a Block. */
614 ir_graph *(get_Block_irg)(const ir_node *block)
616 return _get_Block_irg(block);
619 ir_entity *create_Block_entity(ir_node *block)
622 assert(is_Block(block));
624 entity = block->attr.block.entity;
625 if (entity == NULL) {
629 glob = get_glob_type();
630 entity = new_entity(glob, id_unique("block_%u"), get_code_type());
631 set_entity_visibility(entity, ir_visibility_local);
632 set_entity_linkage(entity, IR_LINKAGE_CONSTANT);
633 nr = get_irp_next_label_nr();
634 set_entity_label(entity, nr);
635 set_entity_compiler_generated(entity, 1);
637 block->attr.block.entity = entity;
642 ir_entity *get_Block_entity(const ir_node *block)
644 assert(is_Block(block));
645 return block->attr.block.entity;
648 void set_Block_entity(ir_node *block, ir_entity *entity)
650 assert(is_Block(block));
651 assert(get_entity_type(entity) == get_code_type());
652 block->attr.block.entity = entity;
655 int has_Block_entity(const ir_node *block)
657 return block->attr.block.entity != NULL;
660 ir_node *(get_Block_phis)(const ir_node *block)
662 return _get_Block_phis(block);
665 void (set_Block_phis)(ir_node *block, ir_node *phi)
667 _set_Block_phis(block, phi);
670 void (add_Block_phi)(ir_node *block, ir_node *phi)
672 _add_Block_phi(block, phi);
675 /* Get the Block mark (single bit). */
676 unsigned (get_Block_mark)(const ir_node *block)
678 return _get_Block_mark(block);
681 /* Set the Block mark (single bit). */
682 void (set_Block_mark)(ir_node *block, unsigned mark)
684 _set_Block_mark(block, mark);
687 int get_End_n_keepalives(const ir_node *end)
690 return (get_irn_arity(end) - END_KEEPALIVE_OFFSET);
693 ir_node *get_End_keepalive(const ir_node *end, int pos)
696 return get_irn_n(end, pos + END_KEEPALIVE_OFFSET);
699 void add_End_keepalive(ir_node *end, ir_node *ka)
705 void set_End_keepalive(ir_node *end, int pos, ir_node *ka)
708 set_irn_n(end, pos + END_KEEPALIVE_OFFSET, ka);
711 /* Set new keep-alives */
712 void set_End_keepalives(ir_node *end, int n, ir_node *in[])
716 ir_graph *irg = get_irn_irg(end);
718 /* notify that edges are deleted */
719 for (e = END_KEEPALIVE_OFFSET; e < ARR_LEN(end->in) - 1; ++e) {
720 edges_notify_edge(end, e, NULL, end->in[e + 1], irg);
722 ARR_RESIZE(ir_node *, end->in, n + 1 + END_KEEPALIVE_OFFSET);
724 for (i = 0; i < n; ++i) {
725 end->in[1 + END_KEEPALIVE_OFFSET + i] = in[i];
726 edges_notify_edge(end, END_KEEPALIVE_OFFSET + i, end->in[1 + END_KEEPALIVE_OFFSET + i], NULL, irg);
729 /* update irg flags */
730 set_irg_outs_inconsistent(irg);
733 /* Set new keep-alives from old keep-alives, skipping irn */
734 void remove_End_keepalive(ir_node *end, ir_node *irn)
736 int n = get_End_n_keepalives(end);
741 for (i = n -1; i >= 0; --i) {
742 ir_node *old_ka = end->in[1 + END_KEEPALIVE_OFFSET + i];
752 irg = get_irn_irg(end);
754 /* remove the edge */
755 edges_notify_edge(end, idx, NULL, irn, irg);
758 /* exchange with the last one */
759 ir_node *old = end->in[1 + END_KEEPALIVE_OFFSET + n - 1];
760 edges_notify_edge(end, n - 1, NULL, old, irg);
761 end->in[1 + END_KEEPALIVE_OFFSET + idx] = old;
762 edges_notify_edge(end, idx, old, NULL, irg);
764 /* now n - 1 keeps, 1 block input */
765 ARR_RESIZE(ir_node *, end->in, (n - 1) + 1 + END_KEEPALIVE_OFFSET);
767 /* update irg flags */
768 set_irg_outs_inconsistent(irg);
771 /* remove Bads, NoMems and doublets from the keep-alive set */
772 void remove_End_Bads_and_doublets(ir_node *end)
775 int idx, n = get_End_n_keepalives(end);
777 bool changed = false;
782 irg = get_irn_irg(end);
783 pset_new_init(&keeps);
785 for (idx = n - 1; idx >= 0; --idx) {
786 ir_node *ka = get_End_keepalive(end, idx);
788 if (is_Bad(ka) || is_NoMem(ka) || pset_new_contains(&keeps, ka)) {
790 /* remove the edge */
791 edges_notify_edge(end, idx, NULL, ka, irg);
794 /* exchange with the last one */
795 ir_node *old = end->in[1 + END_KEEPALIVE_OFFSET + n - 1];
796 edges_notify_edge(end, n - 1, NULL, old, irg);
797 end->in[1 + END_KEEPALIVE_OFFSET + idx] = old;
798 edges_notify_edge(end, idx, old, NULL, irg);
802 pset_new_insert(&keeps, ka);
805 /* n keeps, 1 block input */
806 ARR_RESIZE(ir_node *, end->in, n + 1 + END_KEEPALIVE_OFFSET);
808 pset_new_destroy(&keeps);
811 set_irg_outs_inconsistent(irg);
815 void free_End(ir_node *end)
820 end->in = NULL; /* @@@ make sure we get an error if we use the
821 in array afterwards ... */
824 size_t get_Return_n_ress(const ir_node *node)
826 assert(is_Return(node));
827 return (size_t)(get_irn_arity(node) - RETURN_RESULT_OFFSET);
830 ir_node **get_Return_res_arr(ir_node *node)
832 assert(is_Return(node));
833 if (get_Return_n_ress(node) > 0)
834 return (ir_node **)&(get_irn_in(node)[1 + RETURN_RESULT_OFFSET]);
839 ir_node *get_Return_res(const ir_node *node, int pos)
841 assert(is_Return(node));
843 assert(get_Return_n_ress(node) > (size_t)pos);
844 return get_irn_n(node, pos + RETURN_RESULT_OFFSET);
847 void set_Return_res(ir_node *node, int pos, ir_node *res)
849 assert(is_Return(node));
850 set_irn_n(node, pos + RETURN_RESULT_OFFSET, res);
853 int (is_Const_null)(const ir_node *node)
855 return _is_Const_null(node);
858 int (is_Const_one)(const ir_node *node)
860 return _is_Const_one(node);
863 int (is_Const_all_one)(const ir_node *node)
865 return _is_Const_all_one(node);
870 symconst_kind get_SymConst_kind(const ir_node *node)
872 assert(is_SymConst(node));
873 return node->attr.symc.kind;
876 void set_SymConst_kind(ir_node *node, symconst_kind kind)
878 assert(is_SymConst(node));
879 node->attr.symc.kind = kind;
882 ir_type *get_SymConst_type(const ir_node *node)
884 /* the cast here is annoying, but we have to compensate for
886 ir_node *irn = (ir_node *)node;
887 assert(is_SymConst(node) &&
888 (SYMCONST_HAS_TYPE(get_SymConst_kind(node))));
889 return irn->attr.symc.sym.type_p;
892 void set_SymConst_type(ir_node *node, ir_type *tp)
894 assert(is_SymConst(node) &&
895 (SYMCONST_HAS_TYPE(get_SymConst_kind(node))));
896 node->attr.symc.sym.type_p = tp;
900 /* Only to access SymConst of kind symconst_addr_ent. Else assertion: */
901 ir_entity *get_SymConst_entity(const ir_node *node)
903 assert(is_SymConst(node) && SYMCONST_HAS_ENT(get_SymConst_kind(node)));
904 return node->attr.symc.sym.entity_p;
907 void set_SymConst_entity(ir_node *node, ir_entity *ent)
909 assert(is_SymConst(node) && SYMCONST_HAS_ENT(get_SymConst_kind(node)));
910 node->attr.symc.sym.entity_p = ent;
913 ir_enum_const *get_SymConst_enum(const ir_node *node)
915 assert(is_SymConst(node) && SYMCONST_HAS_ENUM(get_SymConst_kind(node)));
916 return node->attr.symc.sym.enum_p;
919 void set_SymConst_enum(ir_node *node, ir_enum_const *ec)
921 assert(is_SymConst(node) && SYMCONST_HAS_ENUM(get_SymConst_kind(node)));
922 node->attr.symc.sym.enum_p = ec;
925 union symconst_symbol
926 get_SymConst_symbol(const ir_node *node)
928 assert(is_SymConst(node));
929 return node->attr.symc.sym;
932 void set_SymConst_symbol(ir_node *node, union symconst_symbol sym)
934 assert(is_SymConst(node));
935 node->attr.symc.sym = sym;
938 int get_Sel_n_indexs(const ir_node *node)
940 assert(is_Sel(node));
941 return (get_irn_arity(node) - SEL_INDEX_OFFSET);
944 ir_node **get_Sel_index_arr(ir_node *node)
946 assert(is_Sel(node));
947 if (get_Sel_n_indexs(node) > 0)
948 return (ir_node **)& get_irn_in(node)[SEL_INDEX_OFFSET + 1];
953 ir_node *get_Sel_index(const ir_node *node, int pos)
955 assert(is_Sel(node));
956 return get_irn_n(node, pos + SEL_INDEX_OFFSET);
959 void set_Sel_index(ir_node *node, int pos, ir_node *index)
961 assert(is_Sel(node));
962 set_irn_n(node, pos + SEL_INDEX_OFFSET, index);
965 ir_node **get_Call_param_arr(ir_node *node)
967 assert(is_Call(node));
968 return &get_irn_in(node)[CALL_PARAM_OFFSET + 1];
971 size_t get_Call_n_params(const ir_node *node)
973 assert(is_Call(node));
974 return (size_t) (get_irn_arity(node) - CALL_PARAM_OFFSET);
977 ir_node *get_Call_param(const ir_node *node, int pos)
979 assert(is_Call(node));
980 return get_irn_n(node, pos + CALL_PARAM_OFFSET);
983 void set_Call_param(ir_node *node, int pos, ir_node *param)
985 assert(is_Call(node));
986 set_irn_n(node, pos + CALL_PARAM_OFFSET, param);
989 ir_node **get_Builtin_param_arr(ir_node *node)
991 assert(is_Builtin(node));
992 return &get_irn_in(node)[BUILDIN_PARAM_OFFSET + 1];
995 int get_Builtin_n_params(const ir_node *node)
997 assert(is_Builtin(node));
998 return (get_irn_arity(node) - BUILDIN_PARAM_OFFSET);
1001 ir_node *get_Builtin_param(const ir_node *node, int pos)
1003 assert(is_Builtin(node));
1004 return get_irn_n(node, pos + BUILDIN_PARAM_OFFSET);
1007 void set_Builtin_param(ir_node *node, int pos, ir_node *param)
1009 assert(is_Builtin(node));
1010 set_irn_n(node, pos + BUILDIN_PARAM_OFFSET, param);
1013 /* Returns a human readable string for the ir_builtin_kind. */
1014 const char *get_builtin_kind_name(ir_builtin_kind kind)
1016 #define X(a) case a: return #a
1019 X(ir_bk_debugbreak);
1020 X(ir_bk_return_address);
1021 X(ir_bk_frame_address);
1031 X(ir_bk_inner_trampoline);
1038 int Call_has_callees(const ir_node *node)
1040 assert(is_Call(node));
1041 return ((get_irg_callee_info_state(get_irn_irg(node)) != irg_callee_info_none) &&
1042 (node->attr.call.callee_arr != NULL));
1045 size_t get_Call_n_callees(const ir_node *node)
1047 assert(is_Call(node) && node->attr.call.callee_arr);
1048 return ARR_LEN(node->attr.call.callee_arr);
1051 ir_entity *get_Call_callee(const ir_node *node, size_t pos)
1053 assert(pos < get_Call_n_callees(node));
1054 return node->attr.call.callee_arr[pos];
1057 void set_Call_callee_arr(ir_node *node, size_t n, ir_entity ** arr)
1059 ir_graph *irg = get_irn_irg(node);
1061 assert(is_Call(node));
1062 if (node->attr.call.callee_arr == NULL || get_Call_n_callees(node) != n) {
1063 node->attr.call.callee_arr = NEW_ARR_D(ir_entity *, irg->obst, n);
1065 memcpy(node->attr.call.callee_arr, arr, n * sizeof(ir_entity *));
1068 void remove_Call_callee_arr(ir_node *node)
1070 assert(is_Call(node));
1071 node->attr.call.callee_arr = NULL;
1075 * Returns non-zero if a Call is surely a self-recursive Call.
1076 * Beware: if this functions returns 0, the call might be self-recursive!
1078 int is_self_recursive_Call(const ir_node *call)
1080 const ir_node *callee = get_Call_ptr(call);
1082 if (is_SymConst_addr_ent(callee)) {
1083 const ir_entity *ent = get_SymConst_entity(callee);
1084 const ir_graph *irg = get_entity_irg(ent);
1085 if (irg == get_irn_irg(call))
1091 /* Checks for upcast.
1093 * Returns true if the Cast node casts a class type to a super type.
1095 int is_Cast_upcast(ir_node *node)
1097 ir_type *totype = get_Cast_type(node);
1098 ir_type *fromtype = get_irn_typeinfo_type(get_Cast_op(node));
1100 assert(get_irg_typeinfo_state(get_irn_irg(node)) == ir_typeinfo_consistent);
1103 while (is_Pointer_type(totype) && is_Pointer_type(fromtype)) {
1104 totype = get_pointer_points_to_type(totype);
1105 fromtype = get_pointer_points_to_type(fromtype);
1110 if (!is_Class_type(totype)) return 0;
1111 return is_SubClass_of(fromtype, totype);
1114 /* Checks for downcast.
1116 * Returns true if the Cast node casts a class type to a sub type.
1118 int is_Cast_downcast(ir_node *node)
1120 ir_type *totype = get_Cast_type(node);
1121 ir_type *fromtype = get_irn_typeinfo_type(get_Cast_op(node));
1123 assert(get_irg_typeinfo_state(get_irn_irg(node)) == ir_typeinfo_consistent);
1126 while (is_Pointer_type(totype) && is_Pointer_type(fromtype)) {
1127 totype = get_pointer_points_to_type(totype);
1128 fromtype = get_pointer_points_to_type(fromtype);
1133 if (!is_Class_type(totype)) return 0;
1134 return is_SubClass_of(totype, fromtype);
1137 int (is_unop)(const ir_node *node)
1139 return _is_unop(node);
1142 ir_node *get_unop_op(const ir_node *node)
1144 if (node->op->opar == oparity_unary)
1145 return get_irn_n(node, node->op->op_index);
1147 assert(node->op->opar == oparity_unary);
1151 void set_unop_op(ir_node *node, ir_node *op)
1153 if (node->op->opar == oparity_unary)
1154 set_irn_n(node, node->op->op_index, op);
1156 assert(node->op->opar == oparity_unary);
1159 int (is_binop)(const ir_node *node)
1161 return _is_binop(node);
1164 ir_node *get_binop_left(const ir_node *node)
1166 assert(node->op->opar == oparity_binary);
1167 return get_irn_n(node, node->op->op_index);
1170 void set_binop_left(ir_node *node, ir_node *left)
1172 assert(node->op->opar == oparity_binary);
1173 set_irn_n(node, node->op->op_index, left);
1176 ir_node *get_binop_right(const ir_node *node)
1178 assert(node->op->opar == oparity_binary);
1179 return get_irn_n(node, node->op->op_index + 1);
1182 void set_binop_right(ir_node *node, ir_node *right)
1184 assert(node->op->opar == oparity_binary);
1185 set_irn_n(node, node->op->op_index + 1, right);
1188 int is_Phi0(const ir_node *n)
1192 return ((get_irn_op(n) == op_Phi) &&
1193 (get_irn_arity(n) == 0) &&
1194 (get_irg_phase_state(get_irn_irg(n)) == phase_building));
1197 ir_node **get_Phi_preds_arr(ir_node *node)
1199 assert(is_Phi(node));
1200 return (ir_node **)&(get_irn_in(node)[1]);
1203 int get_Phi_n_preds(const ir_node *node)
1205 assert(is_Phi(node) || is_Phi0(node));
1206 return (get_irn_arity(node));
1209 ir_node *get_Phi_pred(const ir_node *node, int pos)
1211 assert(is_Phi(node) || is_Phi0(node));
1212 return get_irn_n(node, pos);
1215 void set_Phi_pred(ir_node *node, int pos, ir_node *pred)
1217 assert(is_Phi(node) || is_Phi0(node));
1218 set_irn_n(node, pos, pred);
1221 ir_node *(get_Phi_next)(const ir_node *phi)
1223 return _get_Phi_next(phi);
1226 void (set_Phi_next)(ir_node *phi, ir_node *next)
1228 _set_Phi_next(phi, next);
1231 int is_memop(const ir_node *node)
1233 unsigned code = get_irn_opcode(node);
1234 return (code == iro_Load || code == iro_Store);
1237 ir_node *get_memop_mem(const ir_node *node)
1239 assert(is_memop(node));
1240 assert(n_Load_mem == 0 && n_Store_mem == 0);
1241 return get_irn_n(node, 0);
1244 void set_memop_mem(ir_node *node, ir_node *mem)
1246 assert(is_memop(node));
1247 assert(n_Load_mem == 0 && n_Store_mem == 0);
1248 set_irn_n(node, 0, mem);
1251 ir_node *get_memop_ptr(const ir_node *node)
1253 assert(is_memop(node));
1254 assert(n_Load_mem == 1 && n_Store_mem == 1);
1255 return get_irn_n(node, 1);
1258 void set_memop_ptr(ir_node *node, ir_node *ptr)
1260 assert(is_memop(node));
1261 assert(n_Load_mem == 1 && n_Store_mem == 1);
1262 set_irn_n(node, 1, ptr);
1266 ir_node **get_Sync_preds_arr(ir_node *node)
1268 assert(is_Sync(node));
1269 return (ir_node **)&(get_irn_in(node)[1]);
1272 int get_Sync_n_preds(const ir_node *node)
1274 assert(is_Sync(node));
1275 return (get_irn_arity(node));
1279 void set_Sync_n_preds(ir_node *node, int n_preds)
1281 assert(is_Sync(node));
1285 ir_node *get_Sync_pred(const ir_node *node, int pos)
1287 assert(is_Sync(node));
1288 return get_irn_n(node, pos);
1291 void set_Sync_pred(ir_node *node, int pos, ir_node *pred)
1293 assert(is_Sync(node));
1294 set_irn_n(node, pos, pred);
1297 /* Add a new Sync predecessor */
1298 void add_Sync_pred(ir_node *node, ir_node *pred)
1300 assert(is_Sync(node));
1301 add_irn_n(node, pred);
1304 int (is_arg_Proj)(const ir_node *node)
1306 return _is_arg_Proj(node);
1309 int is_x_except_Proj(const ir_node *node)
1314 pred = get_Proj_pred(node);
1315 if (!is_fragile_op(pred))
1317 return get_Proj_proj(node) == pred->op->pn_x_except;
1320 int is_x_regular_Proj(const ir_node *node)
1325 pred = get_Proj_pred(node);
1326 if (!is_fragile_op(pred))
1328 return get_Proj_proj(node) == pred->op->pn_x_except;
1331 ir_node **get_Tuple_preds_arr(ir_node *node)
1333 assert(is_Tuple(node));
1334 return (ir_node **)&(get_irn_in(node)[1]);
1337 int get_Tuple_n_preds(const ir_node *node)
1339 assert(is_Tuple(node));
1340 return get_irn_arity(node);
1343 ir_node *get_Tuple_pred(const ir_node *node, int pos)
1345 assert(is_Tuple(node));
1346 return get_irn_n(node, pos);
1349 void set_Tuple_pred(ir_node *node, int pos, ir_node *pred)
1351 assert(is_Tuple(node));
1352 set_irn_n(node, pos, pred);
1355 int get_ASM_n_input_constraints(const ir_node *node)
1357 assert(is_ASM(node));
1358 return ARR_LEN(node->attr.assem.input_constraints);
1361 int get_ASM_n_output_constraints(const ir_node *node)
1363 assert(is_ASM(node));
1364 return ARR_LEN(node->attr.assem.output_constraints);
1367 int get_ASM_n_clobbers(const ir_node *node)
1369 assert(is_ASM(node));
1370 return ARR_LEN(node->attr.assem.clobbers);
1373 /* returns the graph of a node */
1374 ir_graph *(get_irn_irg)(const ir_node *node)
1376 return _get_irn_irg(node);
1380 /*----------------------------------------------------------------*/
1381 /* Auxiliary routines */
1382 /*----------------------------------------------------------------*/
1384 ir_node *skip_Proj(ir_node *node)
1386 /* don't assert node !!! */
1391 node = get_Proj_pred(node);
1397 skip_Proj_const(const ir_node *node)
1399 /* don't assert node !!! */
1404 node = get_Proj_pred(node);
1409 ir_node *skip_Tuple(ir_node *node)
1414 if (is_Proj(node)) {
1415 pred = get_Proj_pred(node);
1417 if (is_Proj(pred)) { /* nested Tuple ? */
1418 pred = skip_Tuple(pred);
1420 if (is_Tuple(pred)) {
1421 node = get_Tuple_pred(pred, get_Proj_proj(node));
1424 } else if (is_Tuple(pred)) {
1425 node = get_Tuple_pred(pred, get_Proj_proj(node));
1432 /* returns operand of node if node is a Cast */
1433 ir_node *skip_Cast(ir_node *node)
1436 return get_Cast_op(node);
1440 /* returns operand of node if node is a Cast */
1441 const ir_node *skip_Cast_const(const ir_node *node)
1444 return get_Cast_op(node);
1448 /* returns operand of node if node is a Pin */
1449 ir_node *skip_Pin(ir_node *node)
1452 return get_Pin_op(node);
1456 /* returns operand of node if node is a Confirm */
1457 ir_node *skip_Confirm(ir_node *node)
1459 if (is_Confirm(node))
1460 return get_Confirm_value(node);
1464 /* skip all high-level ops */
1465 ir_node *skip_HighLevel_ops(ir_node *node)
1467 while (is_op_highlevel(get_irn_op(node))) {
1468 node = get_irn_n(node, 0);
1474 /* This should compact Id-cycles to self-cycles. It has the same (or less?) complexity
1475 * than any other approach, as Id chains are resolved and all point to the real node, or
1476 * all id's are self loops.
1478 * Note: This function takes 10% of mostly ANY the compiler run, so it's
1479 * a little bit "hand optimized".
1481 ir_node *skip_Id(ir_node *node)
1484 /* don't assert node !!! */
1486 if (!node || (node->op != op_Id)) return node;
1488 /* Don't use get_Id_pred(): We get into an endless loop for
1489 self-referencing Ids. */
1490 pred = node->in[0+1];
1492 if (pred->op != op_Id) return pred;
1494 if (node != pred) { /* not a self referencing Id. Resolve Id chain. */
1495 ir_node *rem_pred, *res;
1497 if (pred->op != op_Id) return pred; /* shortcut */
1500 assert(get_irn_arity (node) > 0);
1502 node->in[0+1] = node; /* turn us into a self referencing Id: shorten Id cycles. */
1503 res = skip_Id(rem_pred);
1504 if (is_Id(res)) /* self-loop */ return node;
1506 node->in[0+1] = res; /* Turn Id chain into Ids all referencing the chain end. */
1513 int (is_strictConv)(const ir_node *node)
1515 return _is_strictConv(node);
1518 /* Returns true if node is a SymConst node with kind symconst_addr_ent. */
1519 int (is_SymConst_addr_ent)(const ir_node *node)
1521 return _is_SymConst_addr_ent(node);
1524 /* Returns true if the operation manipulates control flow. */
1525 int is_cfop(const ir_node *node)
1527 return is_op_cfopcode(get_irn_op(node));
1530 int is_unknown_jump(const ir_node *node)
1532 return is_op_unknown_jump(get_irn_op(node));
1535 /* Returns true if the operation can change the control flow because
1537 int is_fragile_op(const ir_node *node)
1539 return is_op_fragile(get_irn_op(node));
1542 /* Returns the memory operand of fragile operations. */
1543 ir_node *get_fragile_op_mem(ir_node *node)
1545 assert(node && is_fragile_op(node));
1546 return get_irn_n(node, node->op->fragile_mem_index);
1549 /* Returns true if the operation is a forking control flow operation. */
1550 int (is_irn_forking)(const ir_node *node)
1552 return _is_irn_forking(node);
1555 void (copy_node_attr)(ir_graph *irg, const ir_node *old_node, ir_node *new_node)
1557 _copy_node_attr(irg, old_node, new_node);
1560 /* Return the type attribute of a node n (SymConst, Call, Alloc, Free,
1562 ir_type *(get_irn_type_attr)(ir_node *node)
1564 return _get_irn_type_attr(node);
1567 /* Return the entity attribute of a node n (SymConst, Sel) or NULL. */
1568 ir_entity *(get_irn_entity_attr)(ir_node *node)
1570 return _get_irn_entity_attr(node);
1573 /* Returns non-zero for constant-like nodes. */
1574 int (is_irn_constlike)(const ir_node *node)
1576 return _is_irn_constlike(node);
1580 * Returns non-zero for nodes that are allowed to have keep-alives and
1581 * are neither Block nor PhiM.
1583 int (is_irn_keep)(const ir_node *node)
1585 return _is_irn_keep(node);
1589 * Returns non-zero for nodes that are always placed in the start block.
1591 int (is_irn_start_block_placed)(const ir_node *node)
1593 return _is_irn_start_block_placed(node);
1596 /* Returns non-zero for nodes that are machine operations. */
1597 int (is_irn_machine_op)(const ir_node *node)
1599 return _is_irn_machine_op(node);
1602 /* Returns non-zero for nodes that are machine operands. */
1603 int (is_irn_machine_operand)(const ir_node *node)
1605 return _is_irn_machine_operand(node);
1608 /* Returns non-zero for nodes that have the n'th user machine flag set. */
1609 int (is_irn_machine_user)(const ir_node *node, unsigned n)
1611 return _is_irn_machine_user(node, n);
1614 /* Returns non-zero for nodes that are CSE neutral to its users. */
1615 int (is_irn_cse_neutral)(const ir_node *node)
1617 return _is_irn_cse_neutral(node);
1620 /* Gets the string representation of the jump prediction .*/
1621 const char *get_cond_jmp_predicate_name(cond_jmp_predicate pred)
1623 #define X(a) case a: return #a
1625 X(COND_JMP_PRED_NONE);
1626 X(COND_JMP_PRED_TRUE);
1627 X(COND_JMP_PRED_FALSE);
1633 /** Return the attribute type of a SymConst node if exists */
1634 static ir_type *get_SymConst_attr_type(const ir_node *self)
1636 symconst_kind kind = get_SymConst_kind(self);
1637 if (SYMCONST_HAS_TYPE(kind))
1638 return get_SymConst_type(self);
1642 /** Return the attribute entity of a SymConst node if exists */
1643 static ir_entity *get_SymConst_attr_entity(const ir_node *self)
1645 symconst_kind kind = get_SymConst_kind(self);
1646 if (SYMCONST_HAS_ENT(kind))
1647 return get_SymConst_entity(self);
1651 /** the get_type_attr operation must be always implemented */
1652 static ir_type *get_Null_type(const ir_node *n)
1655 return firm_unknown_type;
1658 /* Sets the get_type operation for an ir_op_ops. */
1659 ir_op_ops *firm_set_default_get_type_attr(unsigned code, ir_op_ops *ops)
1662 case iro_SymConst: ops->get_type_attr = get_SymConst_attr_type; break;
1663 case iro_Call: ops->get_type_attr = get_Call_type; break;
1664 case iro_Alloc: ops->get_type_attr = get_Alloc_type; break;
1665 case iro_Free: ops->get_type_attr = get_Free_type; break;
1666 case iro_Cast: ops->get_type_attr = get_Cast_type; break;
1668 /* not allowed to be NULL */
1669 if (! ops->get_type_attr)
1670 ops->get_type_attr = get_Null_type;
1676 /** the get_entity_attr operation must be always implemented */
1677 static ir_entity *get_Null_ent(const ir_node *n)
1683 /* Sets the get_type operation for an ir_op_ops. */
1684 ir_op_ops *firm_set_default_get_entity_attr(unsigned code, ir_op_ops *ops)
1687 case iro_SymConst: ops->get_entity_attr = get_SymConst_attr_entity; break;
1688 case iro_Sel: ops->get_entity_attr = get_Sel_entity; break;
1690 /* not allowed to be NULL */
1691 if (! ops->get_entity_attr)
1692 ops->get_entity_attr = get_Null_ent;
1698 /* Sets the debug information of a node. */
1699 void (set_irn_dbg_info)(ir_node *n, dbg_info *db)
1701 _set_irn_dbg_info(n, db);
1705 * Returns the debug information of an node.
1707 * @param n The node.
1709 dbg_info *(get_irn_dbg_info)(const ir_node *n)
1711 return _get_irn_dbg_info(n);
1714 /* checks whether a node represents a global address */
1715 int is_Global(const ir_node *node)
1717 return is_SymConst_addr_ent(node);
1720 /* returns the entity of a global address */
1721 ir_entity *get_Global_entity(const ir_node *node)
1723 return get_SymConst_entity(node);
1727 * Calculate a hash value of a node.
1729 unsigned firm_default_hash(const ir_node *node)
1734 /* hash table value = 9*(9*(9*(9*(9*arity+in[0])+in[1])+ ...)+mode)+code */
1735 h = irn_arity = get_irn_arity(node);
1737 /* consider all in nodes... except the block if not a control flow. */
1738 for (i = is_cfop(node) ? -1 : 0; i < irn_arity; ++i) {
1739 ir_node *pred = get_irn_n(node, i);
1740 if (is_irn_cse_neutral(pred))
1743 h = 9*h + HASH_PTR(pred);
1747 h = 9*h + HASH_PTR(get_irn_mode(node));
1749 h = 9*h + HASH_PTR(get_irn_op(node));
1752 } /* firm_default_hash */
1754 /* include generated code */
1755 #include "gen_irnode.c.inl"