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 /* Test whether arbitrary node is tls pointer, i.e. Proj(pn_Start_P_tls)
520 * from Start. If so returns tls type, else Null. */
521 ir_type *is_tls_pointer(const ir_node *n)
523 if (is_Proj(n) && (get_Proj_proj(n) == pn_Start_P_tls)) {
524 ir_node *start = get_Proj_pred(n);
525 if (is_Start(start)) {
526 return get_tls_type();
532 ir_node **get_Block_cfgpred_arr(ir_node *node)
534 assert(is_Block(node));
535 return (ir_node **)&(get_irn_in(node)[1]);
538 int (get_Block_n_cfgpreds)(const ir_node *node)
540 return _get_Block_n_cfgpreds(node);
543 ir_node *(get_Block_cfgpred)(const ir_node *node, int pos)
545 return _get_Block_cfgpred(node, pos);
548 void set_Block_cfgpred(ir_node *node, int pos, ir_node *pred)
550 assert(is_Block(node));
551 set_irn_n(node, pos, pred);
554 int get_Block_cfgpred_pos(const ir_node *block, const ir_node *pred)
558 for (i = get_Block_n_cfgpreds(block) - 1; i >= 0; --i) {
559 if (get_Block_cfgpred_block(block, i) == pred)
565 ir_node *(get_Block_cfgpred_block)(const ir_node *node, int pos)
567 return _get_Block_cfgpred_block(node, pos);
570 int get_Block_matured(const ir_node *node)
572 assert(is_Block(node));
573 return (int)node->attr.block.is_matured;
576 void set_Block_matured(ir_node *node, int matured)
578 assert(is_Block(node));
579 node->attr.block.is_matured = matured;
582 ir_visited_t (get_Block_block_visited)(const ir_node *node)
584 return _get_Block_block_visited(node);
587 void (set_Block_block_visited)(ir_node *node, ir_visited_t visit)
589 _set_Block_block_visited(node, visit);
592 void (mark_Block_block_visited)(ir_node *node)
594 _mark_Block_block_visited(node);
597 int (Block_block_visited)(const ir_node *node)
599 return _Block_block_visited(node);
602 ir_node *(set_Block_dead)(ir_node *block)
604 return _set_Block_dead(block);
607 int (is_Block_dead)(const ir_node *block)
609 return _is_Block_dead(block);
612 ir_extblk *get_Block_extbb(const ir_node *block)
615 assert(is_Block(block));
616 res = block->attr.block.extblk;
617 assert(res == NULL || is_ir_extbb(res));
621 void set_Block_extbb(ir_node *block, ir_extblk *extblk)
623 assert(is_Block(block));
624 assert(extblk == NULL || is_ir_extbb(extblk));
625 block->attr.block.extblk = extblk;
628 /* returns the graph of a Block. */
629 ir_graph *(get_Block_irg)(const ir_node *block)
631 return _get_Block_irg(block);
634 ir_entity *create_Block_entity(ir_node *block)
637 assert(is_Block(block));
639 entity = block->attr.block.entity;
640 if (entity == NULL) {
644 glob = get_glob_type();
645 entity = new_entity(glob, id_unique("block_%u"), get_code_type());
646 set_entity_visibility(entity, ir_visibility_local);
647 set_entity_linkage(entity, IR_LINKAGE_CONSTANT);
648 nr = get_irp_next_label_nr();
649 set_entity_label(entity, nr);
650 set_entity_compiler_generated(entity, 1);
652 block->attr.block.entity = entity;
657 ir_entity *get_Block_entity(const ir_node *block)
659 assert(is_Block(block));
660 return block->attr.block.entity;
663 void set_Block_entity(ir_node *block, ir_entity *entity)
665 assert(is_Block(block));
666 assert(get_entity_type(entity) == get_code_type());
667 block->attr.block.entity = entity;
670 int has_Block_entity(const ir_node *block)
672 return block->attr.block.entity != NULL;
675 ir_node *(get_Block_phis)(const ir_node *block)
677 return _get_Block_phis(block);
680 void (set_Block_phis)(ir_node *block, ir_node *phi)
682 _set_Block_phis(block, phi);
685 void (add_Block_phi)(ir_node *block, ir_node *phi)
687 _add_Block_phi(block, phi);
690 /* Get the Block mark (single bit). */
691 unsigned (get_Block_mark)(const ir_node *block)
693 return _get_Block_mark(block);
696 /* Set the Block mark (single bit). */
697 void (set_Block_mark)(ir_node *block, unsigned mark)
699 _set_Block_mark(block, mark);
702 int get_End_n_keepalives(const ir_node *end)
705 return (get_irn_arity(end) - END_KEEPALIVE_OFFSET);
708 ir_node *get_End_keepalive(const ir_node *end, int pos)
711 return get_irn_n(end, pos + END_KEEPALIVE_OFFSET);
714 void add_End_keepalive(ir_node *end, ir_node *ka)
720 void set_End_keepalive(ir_node *end, int pos, ir_node *ka)
723 set_irn_n(end, pos + END_KEEPALIVE_OFFSET, ka);
726 /* Set new keep-alives */
727 void set_End_keepalives(ir_node *end, int n, ir_node *in[])
731 ir_graph *irg = get_irn_irg(end);
733 /* notify that edges are deleted */
734 for (e = END_KEEPALIVE_OFFSET; e < ARR_LEN(end->in) - 1; ++e) {
735 edges_notify_edge(end, e, NULL, end->in[e + 1], irg);
737 ARR_RESIZE(ir_node *, end->in, n + 1 + END_KEEPALIVE_OFFSET);
739 for (i = 0; i < n; ++i) {
740 end->in[1 + END_KEEPALIVE_OFFSET + i] = in[i];
741 edges_notify_edge(end, END_KEEPALIVE_OFFSET + i, end->in[1 + END_KEEPALIVE_OFFSET + i], NULL, irg);
745 /* Set new keep-alives from old keep-alives, skipping irn */
746 void remove_End_keepalive(ir_node *end, ir_node *irn)
748 int n = get_End_n_keepalives(end);
753 for (i = n -1; i >= 0; --i) {
754 ir_node *old_ka = end->in[1 + END_KEEPALIVE_OFFSET + i];
764 irg = get_irn_irg(end);
766 /* remove the edge */
767 edges_notify_edge(end, idx, NULL, irn, irg);
770 /* exchange with the last one */
771 ir_node *old = end->in[1 + END_KEEPALIVE_OFFSET + n - 1];
772 edges_notify_edge(end, n - 1, NULL, old, irg);
773 end->in[1 + END_KEEPALIVE_OFFSET + idx] = old;
774 edges_notify_edge(end, idx, old, NULL, irg);
776 /* now n - 1 keeps, 1 block input */
777 ARR_RESIZE(ir_node *, end->in, (n - 1) + 1 + END_KEEPALIVE_OFFSET);
780 /* remove Bads, NoMems and doublets from the keep-alive set */
781 void remove_End_Bads_and_doublets(ir_node *end)
784 int idx, n = get_End_n_keepalives(end);
790 irg = get_irn_irg(end);
791 pset_new_init(&keeps);
793 for (idx = n - 1; idx >= 0; --idx) {
794 ir_node *ka = get_End_keepalive(end, idx);
796 if (is_Bad(ka) || is_NoMem(ka) || pset_new_contains(&keeps, ka)) {
797 /* remove the edge */
798 edges_notify_edge(end, idx, NULL, ka, irg);
801 /* exchange with the last one */
802 ir_node *old = end->in[1 + END_KEEPALIVE_OFFSET + n - 1];
803 edges_notify_edge(end, n - 1, NULL, old, irg);
804 end->in[1 + END_KEEPALIVE_OFFSET + idx] = old;
805 edges_notify_edge(end, idx, old, NULL, irg);
809 pset_new_insert(&keeps, ka);
812 /* n keeps, 1 block input */
813 ARR_RESIZE(ir_node *, end->in, n + 1 + END_KEEPALIVE_OFFSET);
815 pset_new_destroy(&keeps);
818 void free_End(ir_node *end)
823 end->in = NULL; /* @@@ make sure we get an error if we use the
824 in array afterwards ... */
827 size_t get_Return_n_ress(const ir_node *node)
829 assert(is_Return(node));
830 return (size_t)(get_irn_arity(node) - RETURN_RESULT_OFFSET);
833 ir_node **get_Return_res_arr(ir_node *node)
835 assert(is_Return(node));
836 if (get_Return_n_ress(node) > 0)
837 return (ir_node **)&(get_irn_in(node)[1 + RETURN_RESULT_OFFSET]);
842 ir_node *get_Return_res(const ir_node *node, int pos)
844 assert(is_Return(node));
846 assert(get_Return_n_ress(node) > (size_t)pos);
847 return get_irn_n(node, pos + RETURN_RESULT_OFFSET);
850 void set_Return_res(ir_node *node, int pos, ir_node *res)
852 assert(is_Return(node));
853 set_irn_n(node, pos + RETURN_RESULT_OFFSET, res);
856 int (is_Const_null)(const ir_node *node)
858 return _is_Const_null(node);
861 int (is_Const_one)(const ir_node *node)
863 return _is_Const_one(node);
866 int (is_Const_all_one)(const ir_node *node)
868 return _is_Const_all_one(node);
873 symconst_kind get_SymConst_kind(const ir_node *node)
875 assert(is_SymConst(node));
876 return node->attr.symc.kind;
879 void set_SymConst_kind(ir_node *node, symconst_kind kind)
881 assert(is_SymConst(node));
882 node->attr.symc.kind = kind;
885 ir_type *get_SymConst_type(const ir_node *node)
887 /* the cast here is annoying, but we have to compensate for
889 ir_node *irn = (ir_node *)node;
890 assert(is_SymConst(node) &&
891 (SYMCONST_HAS_TYPE(get_SymConst_kind(node))));
892 return irn->attr.symc.sym.type_p;
895 void set_SymConst_type(ir_node *node, ir_type *tp)
897 assert(is_SymConst(node) &&
898 (SYMCONST_HAS_TYPE(get_SymConst_kind(node))));
899 node->attr.symc.sym.type_p = tp;
903 /* Only to access SymConst of kind symconst_addr_ent. Else assertion: */
904 ir_entity *get_SymConst_entity(const ir_node *node)
906 assert(is_SymConst(node) && SYMCONST_HAS_ENT(get_SymConst_kind(node)));
907 return node->attr.symc.sym.entity_p;
910 void set_SymConst_entity(ir_node *node, ir_entity *ent)
912 assert(is_SymConst(node) && SYMCONST_HAS_ENT(get_SymConst_kind(node)));
913 node->attr.symc.sym.entity_p = ent;
916 ir_enum_const *get_SymConst_enum(const ir_node *node)
918 assert(is_SymConst(node) && SYMCONST_HAS_ENUM(get_SymConst_kind(node)));
919 return node->attr.symc.sym.enum_p;
922 void set_SymConst_enum(ir_node *node, ir_enum_const *ec)
924 assert(is_SymConst(node) && SYMCONST_HAS_ENUM(get_SymConst_kind(node)));
925 node->attr.symc.sym.enum_p = ec;
928 union symconst_symbol
929 get_SymConst_symbol(const ir_node *node)
931 assert(is_SymConst(node));
932 return node->attr.symc.sym;
935 void set_SymConst_symbol(ir_node *node, union symconst_symbol sym)
937 assert(is_SymConst(node));
938 node->attr.symc.sym = sym;
941 int get_Sel_n_indexs(const ir_node *node)
943 assert(is_Sel(node));
944 return (get_irn_arity(node) - SEL_INDEX_OFFSET);
947 ir_node **get_Sel_index_arr(ir_node *node)
949 assert(is_Sel(node));
950 if (get_Sel_n_indexs(node) > 0)
951 return (ir_node **)& get_irn_in(node)[SEL_INDEX_OFFSET + 1];
956 ir_node *get_Sel_index(const ir_node *node, int pos)
958 assert(is_Sel(node));
959 return get_irn_n(node, pos + SEL_INDEX_OFFSET);
962 void set_Sel_index(ir_node *node, int pos, ir_node *index)
964 assert(is_Sel(node));
965 set_irn_n(node, pos + SEL_INDEX_OFFSET, index);
968 ir_node **get_Call_param_arr(ir_node *node)
970 assert(is_Call(node));
971 return &get_irn_in(node)[CALL_PARAM_OFFSET + 1];
974 size_t get_Call_n_params(const ir_node *node)
976 assert(is_Call(node));
977 return (size_t) (get_irn_arity(node) - CALL_PARAM_OFFSET);
980 ir_node *get_Call_param(const ir_node *node, int pos)
982 assert(is_Call(node));
983 return get_irn_n(node, pos + CALL_PARAM_OFFSET);
986 void set_Call_param(ir_node *node, int pos, ir_node *param)
988 assert(is_Call(node));
989 set_irn_n(node, pos + CALL_PARAM_OFFSET, param);
992 ir_node **get_Builtin_param_arr(ir_node *node)
994 assert(is_Builtin(node));
995 return &get_irn_in(node)[BUILDIN_PARAM_OFFSET + 1];
998 int get_Builtin_n_params(const ir_node *node)
1000 assert(is_Builtin(node));
1001 return (get_irn_arity(node) - BUILDIN_PARAM_OFFSET);
1004 ir_node *get_Builtin_param(const ir_node *node, int pos)
1006 assert(is_Builtin(node));
1007 return get_irn_n(node, pos + BUILDIN_PARAM_OFFSET);
1010 void set_Builtin_param(ir_node *node, int pos, ir_node *param)
1012 assert(is_Builtin(node));
1013 set_irn_n(node, pos + BUILDIN_PARAM_OFFSET, param);
1016 /* Returns a human readable string for the ir_builtin_kind. */
1017 const char *get_builtin_kind_name(ir_builtin_kind kind)
1019 #define X(a) case a: return #a
1022 X(ir_bk_debugbreak);
1023 X(ir_bk_return_address);
1024 X(ir_bk_frame_address);
1034 X(ir_bk_inner_trampoline);
1041 int Call_has_callees(const ir_node *node)
1043 assert(is_Call(node));
1044 return ((get_irg_callee_info_state(get_irn_irg(node)) != irg_callee_info_none) &&
1045 (node->attr.call.callee_arr != NULL));
1048 size_t get_Call_n_callees(const ir_node *node)
1050 assert(is_Call(node) && node->attr.call.callee_arr);
1051 return ARR_LEN(node->attr.call.callee_arr);
1054 ir_entity *get_Call_callee(const ir_node *node, size_t pos)
1056 assert(pos < get_Call_n_callees(node));
1057 return node->attr.call.callee_arr[pos];
1060 void set_Call_callee_arr(ir_node *node, size_t n, ir_entity ** arr)
1062 ir_graph *irg = get_irn_irg(node);
1064 assert(is_Call(node));
1065 if (node->attr.call.callee_arr == NULL || get_Call_n_callees(node) != n) {
1066 node->attr.call.callee_arr = NEW_ARR_D(ir_entity *, irg->obst, n);
1068 memcpy(node->attr.call.callee_arr, arr, n * sizeof(ir_entity *));
1071 void remove_Call_callee_arr(ir_node *node)
1073 assert(is_Call(node));
1074 node->attr.call.callee_arr = NULL;
1078 * Returns non-zero if a Call is surely a self-recursive Call.
1079 * Beware: if this functions returns 0, the call might be self-recursive!
1081 int is_self_recursive_Call(const ir_node *call)
1083 const ir_node *callee = get_Call_ptr(call);
1085 if (is_SymConst_addr_ent(callee)) {
1086 const ir_entity *ent = get_SymConst_entity(callee);
1087 const ir_graph *irg = get_entity_irg(ent);
1088 if (irg == get_irn_irg(call))
1094 /* Checks for upcast.
1096 * Returns true if the Cast node casts a class type to a super type.
1098 int is_Cast_upcast(ir_node *node)
1100 ir_type *totype = get_Cast_type(node);
1101 ir_type *fromtype = get_irn_typeinfo_type(get_Cast_op(node));
1103 assert(get_irg_typeinfo_state(get_irn_irg(node)) == ir_typeinfo_consistent);
1106 while (is_Pointer_type(totype) && is_Pointer_type(fromtype)) {
1107 totype = get_pointer_points_to_type(totype);
1108 fromtype = get_pointer_points_to_type(fromtype);
1113 if (!is_Class_type(totype)) return 0;
1114 return is_SubClass_of(fromtype, totype);
1117 /* Checks for downcast.
1119 * Returns true if the Cast node casts a class type to a sub type.
1121 int is_Cast_downcast(ir_node *node)
1123 ir_type *totype = get_Cast_type(node);
1124 ir_type *fromtype = get_irn_typeinfo_type(get_Cast_op(node));
1126 assert(get_irg_typeinfo_state(get_irn_irg(node)) == ir_typeinfo_consistent);
1129 while (is_Pointer_type(totype) && is_Pointer_type(fromtype)) {
1130 totype = get_pointer_points_to_type(totype);
1131 fromtype = get_pointer_points_to_type(fromtype);
1136 if (!is_Class_type(totype)) return 0;
1137 return is_SubClass_of(totype, fromtype);
1140 int (is_unop)(const ir_node *node)
1142 return _is_unop(node);
1145 ir_node *get_unop_op(const ir_node *node)
1147 if (node->op->opar == oparity_unary)
1148 return get_irn_n(node, node->op->op_index);
1150 assert(node->op->opar == oparity_unary);
1154 void set_unop_op(ir_node *node, ir_node *op)
1156 if (node->op->opar == oparity_unary)
1157 set_irn_n(node, node->op->op_index, op);
1159 assert(node->op->opar == oparity_unary);
1162 int (is_binop)(const ir_node *node)
1164 return _is_binop(node);
1167 ir_node *get_binop_left(const ir_node *node)
1169 assert(node->op->opar == oparity_binary);
1170 return get_irn_n(node, node->op->op_index);
1173 void set_binop_left(ir_node *node, ir_node *left)
1175 assert(node->op->opar == oparity_binary);
1176 set_irn_n(node, node->op->op_index, left);
1179 ir_node *get_binop_right(const ir_node *node)
1181 assert(node->op->opar == oparity_binary);
1182 return get_irn_n(node, node->op->op_index + 1);
1185 void set_binop_right(ir_node *node, ir_node *right)
1187 assert(node->op->opar == oparity_binary);
1188 set_irn_n(node, node->op->op_index + 1, right);
1191 int is_Phi0(const ir_node *n)
1195 return ((get_irn_op(n) == op_Phi) &&
1196 (get_irn_arity(n) == 0) &&
1197 (get_irg_phase_state(get_irn_irg(n)) == phase_building));
1200 ir_node **get_Phi_preds_arr(ir_node *node)
1202 assert(is_Phi(node));
1203 return (ir_node **)&(get_irn_in(node)[1]);
1206 int get_Phi_n_preds(const ir_node *node)
1208 assert(is_Phi(node) || is_Phi0(node));
1209 return (get_irn_arity(node));
1212 ir_node *get_Phi_pred(const ir_node *node, int pos)
1214 assert(is_Phi(node) || is_Phi0(node));
1215 return get_irn_n(node, pos);
1218 void set_Phi_pred(ir_node *node, int pos, ir_node *pred)
1220 assert(is_Phi(node) || is_Phi0(node));
1221 set_irn_n(node, pos, pred);
1224 ir_node *(get_Phi_next)(const ir_node *phi)
1226 return _get_Phi_next(phi);
1229 void (set_Phi_next)(ir_node *phi, ir_node *next)
1231 _set_Phi_next(phi, next);
1234 int is_memop(const ir_node *node)
1236 unsigned code = get_irn_opcode(node);
1237 return (code == iro_Load || code == iro_Store);
1240 ir_node *get_memop_mem(const ir_node *node)
1242 assert(is_memop(node));
1243 return get_irn_n(node, 0);
1246 void set_memop_mem(ir_node *node, ir_node *mem)
1248 assert(is_memop(node));
1249 set_irn_n(node, 0, mem);
1252 ir_node *get_memop_ptr(const ir_node *node)
1254 assert(is_memop(node));
1255 return get_irn_n(node, 1);
1258 void set_memop_ptr(ir_node *node, ir_node *ptr)
1260 assert(is_memop(node));
1261 set_irn_n(node, 1, ptr);
1265 ir_node **get_Sync_preds_arr(ir_node *node)
1267 assert(is_Sync(node));
1268 return (ir_node **)&(get_irn_in(node)[1]);
1271 int get_Sync_n_preds(const ir_node *node)
1273 assert(is_Sync(node));
1274 return (get_irn_arity(node));
1278 void set_Sync_n_preds(ir_node *node, int n_preds)
1280 assert(is_Sync(node));
1284 ir_node *get_Sync_pred(const ir_node *node, int pos)
1286 assert(is_Sync(node));
1287 return get_irn_n(node, pos);
1290 void set_Sync_pred(ir_node *node, int pos, ir_node *pred)
1292 assert(is_Sync(node));
1293 set_irn_n(node, pos, pred);
1296 /* Add a new Sync predecessor */
1297 void add_Sync_pred(ir_node *node, ir_node *pred)
1299 assert(is_Sync(node));
1300 add_irn_n(node, pred);
1303 int (is_arg_Proj)(const ir_node *node)
1305 return _is_arg_Proj(node);
1308 ir_node **get_Tuple_preds_arr(ir_node *node)
1310 assert(is_Tuple(node));
1311 return (ir_node **)&(get_irn_in(node)[1]);
1314 int get_Tuple_n_preds(const ir_node *node)
1316 assert(is_Tuple(node));
1317 return get_irn_arity(node);
1320 ir_node *get_Tuple_pred(const ir_node *node, int pos)
1322 assert(is_Tuple(node));
1323 return get_irn_n(node, pos);
1326 void set_Tuple_pred(ir_node *node, int pos, ir_node *pred)
1328 assert(is_Tuple(node));
1329 set_irn_n(node, pos, pred);
1332 int get_ASM_n_input_constraints(const ir_node *node)
1334 assert(is_ASM(node));
1335 return ARR_LEN(node->attr.assem.input_constraints);
1338 int get_ASM_n_output_constraints(const ir_node *node)
1340 assert(is_ASM(node));
1341 return ARR_LEN(node->attr.assem.output_constraints);
1344 int get_ASM_n_clobbers(const ir_node *node)
1346 assert(is_ASM(node));
1347 return ARR_LEN(node->attr.assem.clobbers);
1350 /* returns the graph of a node */
1351 ir_graph *(get_irn_irg)(const ir_node *node)
1353 return _get_irn_irg(node);
1357 /*----------------------------------------------------------------*/
1358 /* Auxiliary routines */
1359 /*----------------------------------------------------------------*/
1361 ir_node *skip_Proj(ir_node *node)
1363 /* don't assert node !!! */
1368 node = get_Proj_pred(node);
1374 skip_Proj_const(const ir_node *node)
1376 /* don't assert node !!! */
1381 node = get_Proj_pred(node);
1386 ir_node *skip_Tuple(ir_node *node)
1391 if (is_Proj(node)) {
1392 pred = get_Proj_pred(node);
1394 if (is_Proj(pred)) { /* nested Tuple ? */
1395 pred = skip_Tuple(pred);
1397 if (is_Tuple(pred)) {
1398 node = get_Tuple_pred(pred, get_Proj_proj(node));
1401 } else if (is_Tuple(pred)) {
1402 node = get_Tuple_pred(pred, get_Proj_proj(node));
1409 /* returns operand of node if node is a Cast */
1410 ir_node *skip_Cast(ir_node *node)
1413 return get_Cast_op(node);
1417 /* returns operand of node if node is a Cast */
1418 const ir_node *skip_Cast_const(const ir_node *node)
1421 return get_Cast_op(node);
1425 /* returns operand of node if node is a Pin */
1426 ir_node *skip_Pin(ir_node *node)
1429 return get_Pin_op(node);
1433 /* returns operand of node if node is a Confirm */
1434 ir_node *skip_Confirm(ir_node *node)
1436 if (is_Confirm(node))
1437 return get_Confirm_value(node);
1441 /* skip all high-level ops */
1442 ir_node *skip_HighLevel_ops(ir_node *node)
1444 while (is_op_highlevel(get_irn_op(node))) {
1445 node = get_irn_n(node, 0);
1451 /* This should compact Id-cycles to self-cycles. It has the same (or less?) complexity
1452 * than any other approach, as Id chains are resolved and all point to the real node, or
1453 * all id's are self loops.
1455 * Note: This function takes 10% of mostly ANY the compiler run, so it's
1456 * a little bit "hand optimized".
1458 ir_node *skip_Id(ir_node *node)
1461 /* don't assert node !!! */
1463 if (!node || (node->op != op_Id)) return node;
1465 /* Don't use get_Id_pred(): We get into an endless loop for
1466 self-referencing Ids. */
1467 pred = node->in[0+1];
1469 if (pred->op != op_Id) return pred;
1471 if (node != pred) { /* not a self referencing Id. Resolve Id chain. */
1472 ir_node *rem_pred, *res;
1474 if (pred->op != op_Id) return pred; /* shortcut */
1477 assert(get_irn_arity (node) > 0);
1479 node->in[0+1] = node; /* turn us into a self referencing Id: shorten Id cycles. */
1480 res = skip_Id(rem_pred);
1481 if (is_Id(res)) /* self-loop */ return node;
1483 node->in[0+1] = res; /* Turn Id chain into Ids all referencing the chain end. */
1490 int (is_strictConv)(const ir_node *node)
1492 return _is_strictConv(node);
1495 /* Returns true if node is a SymConst node with kind symconst_addr_ent. */
1496 int (is_SymConst_addr_ent)(const ir_node *node)
1498 return _is_SymConst_addr_ent(node);
1501 /* Returns true if the operation manipulates control flow. */
1502 int is_cfop(const ir_node *node)
1504 return is_op_cfopcode(get_irn_op(node));
1507 /* Returns true if the operation can change the control flow because
1509 int is_fragile_op(const ir_node *node)
1511 return is_op_fragile(get_irn_op(node));
1514 /* Returns the memory operand of fragile operations. */
1515 ir_node *get_fragile_op_mem(ir_node *node)
1517 assert(node && is_fragile_op(node));
1519 switch (get_irn_opcode(node)) {
1528 return get_irn_n(node, pn_Generic_M);
1533 panic("should not be reached");
1537 /* Returns true if the operation is a forking control flow operation. */
1538 int (is_irn_forking)(const ir_node *node)
1540 return _is_irn_forking(node);
1543 void (copy_node_attr)(ir_graph *irg, const ir_node *old_node, ir_node *new_node)
1545 _copy_node_attr(irg, old_node, new_node);
1548 /* Return the type attribute of a node n (SymConst, Call, Alloc, Free,
1550 ir_type *(get_irn_type_attr)(ir_node *node)
1552 return _get_irn_type_attr(node);
1555 /* Return the entity attribute of a node n (SymConst, Sel) or NULL. */
1556 ir_entity *(get_irn_entity_attr)(ir_node *node)
1558 return _get_irn_entity_attr(node);
1561 /* Returns non-zero for constant-like nodes. */
1562 int (is_irn_constlike)(const ir_node *node)
1564 return _is_irn_constlike(node);
1568 * Returns non-zero for nodes that are allowed to have keep-alives and
1569 * are neither Block nor PhiM.
1571 int (is_irn_keep)(const ir_node *node)
1573 return _is_irn_keep(node);
1577 * Returns non-zero for nodes that are always placed in the start block.
1579 int (is_irn_start_block_placed)(const ir_node *node)
1581 return _is_irn_start_block_placed(node);
1584 /* Returns non-zero for nodes that are machine operations. */
1585 int (is_irn_machine_op)(const ir_node *node)
1587 return _is_irn_machine_op(node);
1590 /* Returns non-zero for nodes that are machine operands. */
1591 int (is_irn_machine_operand)(const ir_node *node)
1593 return _is_irn_machine_operand(node);
1596 /* Returns non-zero for nodes that have the n'th user machine flag set. */
1597 int (is_irn_machine_user)(const ir_node *node, unsigned n)
1599 return _is_irn_machine_user(node, n);
1602 /* Returns non-zero for nodes that are CSE neutral to its users. */
1603 int (is_irn_cse_neutral)(const ir_node *node)
1605 return _is_irn_cse_neutral(node);
1608 /* Gets the string representation of the jump prediction .*/
1609 const char *get_cond_jmp_predicate_name(cond_jmp_predicate pred)
1611 #define X(a) case a: return #a
1613 X(COND_JMP_PRED_NONE);
1614 X(COND_JMP_PRED_TRUE);
1615 X(COND_JMP_PRED_FALSE);
1621 /** Return the attribute type of a SymConst node if exists */
1622 static ir_type *get_SymConst_attr_type(const ir_node *self)
1624 symconst_kind kind = get_SymConst_kind(self);
1625 if (SYMCONST_HAS_TYPE(kind))
1626 return get_SymConst_type(self);
1630 /** Return the attribute entity of a SymConst node if exists */
1631 static ir_entity *get_SymConst_attr_entity(const ir_node *self)
1633 symconst_kind kind = get_SymConst_kind(self);
1634 if (SYMCONST_HAS_ENT(kind))
1635 return get_SymConst_entity(self);
1639 /** the get_type_attr operation must be always implemented */
1640 static ir_type *get_Null_type(const ir_node *n)
1643 return firm_unknown_type;
1646 /* Sets the get_type operation for an ir_op_ops. */
1647 ir_op_ops *firm_set_default_get_type_attr(ir_opcode code, ir_op_ops *ops)
1650 case iro_SymConst: ops->get_type_attr = get_SymConst_attr_type; break;
1651 case iro_Call: ops->get_type_attr = get_Call_type; break;
1652 case iro_Alloc: ops->get_type_attr = get_Alloc_type; break;
1653 case iro_Free: ops->get_type_attr = get_Free_type; break;
1654 case iro_Cast: ops->get_type_attr = get_Cast_type; break;
1656 /* not allowed to be NULL */
1657 if (! ops->get_type_attr)
1658 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 ir_op_ops *firm_set_default_get_entity_attr(ir_opcode 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;
1686 /* Sets the debug information of a node. */
1687 void (set_irn_dbg_info)(ir_node *n, dbg_info *db)
1689 _set_irn_dbg_info(n, db);
1693 * Returns the debug information of an node.
1695 * @param n The node.
1697 dbg_info *(get_irn_dbg_info)(const ir_node *n)
1699 return _get_irn_dbg_info(n);
1702 /* checks whether a node represents a global address */
1703 int is_Global(const ir_node *node)
1705 return is_SymConst_addr_ent(node);
1708 /* returns the entity of a global address */
1709 ir_entity *get_Global_entity(const ir_node *node)
1711 return get_SymConst_entity(node);
1715 * Calculate a hash value of a node.
1717 unsigned firm_default_hash(const ir_node *node)
1722 /* hash table value = 9*(9*(9*(9*(9*arity+in[0])+in[1])+ ...)+mode)+code */
1723 h = irn_arity = get_irn_arity(node);
1725 /* consider all in nodes... except the block if not a control flow. */
1726 for (i = is_cfop(node) ? -1 : 0; i < irn_arity; ++i) {
1727 ir_node *pred = get_irn_n(node, i);
1728 if (is_irn_cse_neutral(pred))
1731 h = 9*h + HASH_PTR(pred);
1735 h = 9*h + HASH_PTR(get_irn_mode(node));
1737 h = 9*h + HASH_PTR(get_irn_op(node));
1740 } /* firm_default_hash */
1742 /* include generated code */
1743 #include "gen_irnode.c.inl"