verify: Clarify assertion message.
[libfirm] / ir / ir / irnode_t.h
index c32ad54..b9d5f26 100644 (file)
 #include "array.h"
 #include "iredges_t.h"
 
+/* This section MUST come first, so the inline functions get used in this header. */
+#define is_ir_node(thing)                     is_ir_node_(thing)
+#define get_irn_arity(node)                   get_irn_arity_(node)
+#define get_irn_n(node, n)                    get_irn_n_(node, n)
+#define get_irn_mode(node)                    get_irn_mode_(node)
+#define set_irn_mode(node, mode)              set_irn_mode_(node, mode)
+#define get_irn_irg(node)                     get_irn_irg_(node)
+#define get_nodes_block(node)                 get_nodes_block_(node)
+#define get_irn_op(node)                      get_irn_op_(node)
+#define set_irn_op(node, op)                  set_irn_op_(node, op)
+#define get_irn_opcode(node)                  get_irn_opcode_(node)
+#define get_irn_visited(node)                 get_irn_visited_(node)
+#define set_irn_visited(node, v)              set_irn_visited_(node, v)
+#define mark_irn_visited(node)                mark_irn_visited_(node)
+#define irn_visited(node)                     irn_visited_(node)
+#define irn_visited_else_mark(node)           irn_visited_else_mark_(node)
+#define set_irn_link(node, link)              set_irn_link_(node, link)
+#define get_irn_link(node)                    get_irn_link_(node)
+#define get_irn_pinned(node)                  get_irn_pinned_(node)
+#define is_irn_pinned_in_irg(node)            is_irn_pinned_in_irg_(node)
+#define is_unop(node)                         is_unop_(node)
+#define is_binop(node)                        is_binop_(node)
+#define is_SymConst_addr_ent(node)            is_SymConst_addr_ent_(node)
+#define get_Block_n_cfgpreds(node)            get_Block_n_cfgpreds_(node)
+#define get_Block_cfgpred(node, pos)          get_Block_cfgpred_(node, pos)
+#define get_Block_cfgpred_block(node, pos)    get_Block_cfgpred_block_(node, pos)
+#define get_Block_block_visited(node)         get_Block_block_visited_(node)
+#define set_Block_block_visited(node, visit)  set_Block_block_visited_(node, visit)
+#define mark_Block_block_visited(node)        mark_Block_block_visited_(node)
+#define Block_block_visited(node)             Block_block_visited_(node)
+#define get_Block_irg(block)                  get_Block_irg_(block)
+#define is_Const_null(node)                   is_Const_null_(node)
+#define is_Const_one(node)                    is_Const_one_(node)
+#define is_Const_all_one(node)                is_Const_all_one_(node)
+#define is_irn_forking(node)                  is_irn_forking_(node)
+#define copy_node_attr(irg,oldn,newn)         copy_node_attr_(irg,oldn,newn)
+#define get_irn_type(node)                    get_irn_type_(node)
+#define get_irn_type_attr(node)               get_irn_type_attr_(node)
+#define get_irn_entity_attr(node)             get_irn_entity_attr_(node)
+#define is_irn_constlike(node)                is_irn_constlike_(node)
+#define is_irn_keep(node)                     is_irn_keep_(node)
+#define is_irn_start_block_placed(node)       is_irn_start_block_placed_(node)
+#define is_irn_cse_neutral(node)              is_irn_cse_neutral_(node)
+#define get_irn_generic_attr(node)            get_irn_generic_attr_(node)
+#define get_irn_generic_attr_const(node)      get_irn_generic_attr_const_(node)
+#define get_irn_idx(node)                     get_irn_idx_(node)
+
+#define get_irn_deps(node)                    get_irn_deps_(node)
+#define get_irn_dep(node, pos)                get_irn_dep_(node, pos)
+
+#define get_irn_ins_or_deps(node)             get_irn_ins_or_deps_(node)
+#define get_irn_in_or_dep(node, pos)          get_irn_in_or_dep_(node, pos)
+
+#define get_irn_dbg_info(node)                get_irn_dbg_info_(node)
+#define set_irn_dbg_info(node, db)            set_irn_dbg_info_(node, db)
+
+#define set_Block_phis(block, phi)            set_Block_phis_(block, phi)
+#define get_Block_phis(block)                 get_Block_phis_(block)
+#define add_Block_phi(block, phi)             add_Block_phi_(block, phi)
+#define get_Block_mark(block)                 get_Block_mark_(block)
+#define set_Block_mark(block, mark)           set_Block_mark_(block, mark)
+
+#define set_Phi_next(node, phi)               set_Phi_next_(node, phi)
+#define get_Phi_next(node)                    get_Phi_next_(node)
+
+#define is_arg_Proj(node)                     is_arg_Proj_(node)
+#define ir_switch_table_get_n_entries(table)  ir_switch_table_get_n_entries_(table)
+
 /**
  * Returns the array with the ins.  The content of the array may not be
  * changed.
  */
 ir_node **get_irn_in(const ir_node *node);
 
-/**
- * The amount of additional space for custom data to be allocated upon creating a new node.
- */
-extern unsigned firm_add_node_size;
-
-/**
- * Returns an array with the predecessors of the Block. Depending on
- * the implementation of the graph data structure this can be a copy of
- * the internal representation of predecessors as well as the internal
- * array itself. Therefore writing to this array might obstruct the IR.
- */
-ir_node **get_Block_cfgpred_arr(ir_node *node);
-
 /*-------------------------------------------------------------------*/
 /*  These function are most used in libfirm.  Give them as static    */
 /*  functions so they can be inlined.                                */
@@ -68,19 +123,22 @@ static inline int is_ir_node_(const void *thing)
        return (get_kind(thing) == k_ir_node);
 }
 
+static inline unsigned get_irn_idx_(const ir_node *node)
+{
+       return node->node_idx;
+}
+
 /**
  * Gets the op of a node.
  * Intern version for libFirm.
  */
 static inline ir_op *get_irn_op_(const ir_node *node)
 {
-       assert(node);
        return node->op;
 }
 
 static inline void set_irn_op_(ir_node *node, ir_op *op)
 {
-       assert(node);
        node->op = op;
 }
 
@@ -102,7 +160,6 @@ static inline void copy_node_attr_(ir_graph *irg, const ir_node *old_node,
 static inline unsigned get_irn_opcode_(const ir_node *node)
 {
        assert(k_ir_node == get_kind(node));
-       assert(node->op);
        return node->op->code;
 }
 
@@ -115,6 +172,10 @@ static inline int get_irn_arity_(const ir_node *node)
        return (int)(ARR_LEN(node->in) - 1);
 }
 
+/* forward decl... */
+#define is_Id(node) is_Id_(node)
+static inline int is_Id_(const ir_node *node);
+
 /**
  * Intern version for libFirm.
  */
@@ -130,6 +191,9 @@ static inline ir_node *get_irn_n_(const ir_node *node, int n)
        return (node->in[n + 1] = skip_Id(nn));
 }
 
+/* include generated code */
+#include "gen_irnode.h"
+
 /**
  * returns a hash value for a node
  */
@@ -145,7 +209,6 @@ static inline int get_irn_deps_(const ir_node *node)
 
 static inline ir_node *get_irn_dep_(const ir_node *node, int pos)
 {
-       assert(node->deps && "dependency array node yet allocated. use add_irn_dep()");
        assert(pos >= 0 && pos < (int)ARR_LEN(node->deps) && "dependency index out of range");
        return node->deps[pos];
 }
@@ -170,7 +233,6 @@ static inline ir_node *get_irn_in_or_dep_(const ir_node *irn, int pos)
  */
 static inline ir_mode *get_irn_mode_(const ir_node *node)
 {
-       assert(node);
        return node->mode;
 }
 
@@ -180,7 +242,6 @@ static inline ir_mode *get_irn_mode_(const ir_node *node)
  */
 static inline void set_irn_mode_(ir_node *node, ir_mode *mode)
 {
-       assert(node);
        node->mode = mode;
 }
 
@@ -189,6 +250,12 @@ static inline int ir_has_irg_ref(const ir_node *node)
        return is_Block(node) || is_Bad(node) || is_Anchor(node);
 }
 
+static inline ir_node *get_nodes_block_(const ir_node *node)
+{
+       assert(!is_Block(node));
+       return get_irn_n(node, -1);
+}
+
 static inline ir_graph *get_irn_irg_(const ir_node *node)
 {
        if (! is_Block(node))
@@ -197,19 +264,12 @@ static inline ir_graph *get_irn_irg_(const ir_node *node)
        return node->attr.irg.irg;
 }
 
-static inline ir_node *get_nodes_block_(const ir_node *node)
-{
-       assert(!is_Block(node));
-       return get_irn_n(node, -1);
-}
-
 /**
  * Gets the visited counter of a node.
  * Intern version for libFirm.
  */
 static inline ir_visited_t get_irn_visited_(const ir_node *node)
 {
-       assert(node);
        return node->visited;
 }
 
@@ -219,7 +279,6 @@ static inline ir_visited_t get_irn_visited_(const ir_node *node)
  */
 static inline void set_irn_visited_(ir_node *node, ir_visited_t visited)
 {
-       assert(node);
        node->visited = visited;
 }
 
@@ -256,7 +315,6 @@ static inline int irn_visited_else_mark_(ir_node *node)
  */
 static inline void set_irn_link_(ir_node *node, void *link)
 {
-       assert(node);
        node->link = link;
 }
 
@@ -266,7 +324,7 @@ static inline void set_irn_link_(ir_node *node, void *link)
  */
 static inline void *get_irn_link_(const ir_node *node)
 {
-       assert(node && is_ir_node_(node));
+       assert(is_ir_node_(node));
        return node->link;
 }
 
@@ -279,7 +337,7 @@ static inline void *get_irn_link_(const ir_node *node)
 static inline op_pin_state get_irn_pinned_(const ir_node *node)
 {
        op_pin_state state;
-       assert(node && is_ir_node_(node));
+       assert(is_ir_node_(node));
        /* Check opcode */
        state = get_op_pinned_(get_irn_op_(node));
 
@@ -296,53 +354,30 @@ static inline op_pin_state is_irn_pinned_in_irg_(const ir_node *node)
        return op_pin_state_pinned;
 }
 
-/* include generated code */
-#include "gen_irnode.h"
-
 static inline int is_unop_(const ir_node *node)
 {
-       assert(node && is_ir_node_(node));
+       assert(is_ir_node_(node));
        return (node->op->opar == oparity_unary);
 }
 
 static inline int is_binop_(const ir_node *node)
 {
-       assert(node && is_ir_node_(node));
+       assert(is_ir_node_(node));
        return (node->op->opar == oparity_binary);
 }
 
-static inline int is_strictConv_(const ir_node *node)
-{
-       return is_Conv_(node) && get_Conv_strict(node);
-}
-
 static inline int is_SymConst_addr_ent_(const ir_node *node)
 {
        return is_SymConst(node) && get_SymConst_kind(node) == symconst_addr_ent;
 }
 
-static inline int get_Block_n_cfgpreds_(const ir_node *node)
-{
-       assert(is_Block_(node));
-       return get_irn_arity_(node);
-}
-
-static inline ir_node *get_Block_cfgpred_(const ir_node *node, int pos)
-{
-       assert(is_Block_(node));
-       return get_irn_n_(node, pos);
-}
-
-/* Get the predecessor block.
+/**
+ * Get the predecessor block.
  *
- *  Returns the block corresponding to the predecessor pos.
+ * Returns the block corresponding to the predecessor pos.
  *
- *  There are several ambiguities we resolve with this function:
- *  - The direct predecessor can be a Proj, which is not pinned.
- *    We walk from the predecessor to the next pinned node
- *    (skip_Proj) and return the block that node is in.
- *  - If we encounter the Bad node, this function does not return
- *    the Start block, but the Bad node.
+ * If we encounter the Bad node, this function does not return the Start block,
+ * but the Bad node.
  */
 static inline ir_node *get_Block_cfgpred_block_(const ir_node *node, int pos)
 {
@@ -352,7 +387,7 @@ static inline ir_node *get_Block_cfgpred_block_(const ir_node *node, int pos)
                ir_graph *irg = get_irn_irg(node);
                return new_r_Bad(irg, mode_BB);
        } else {
-               return get_nodes_block(skip_Proj(res));
+               return get_nodes_block(res);
        }
 }
 
@@ -368,6 +403,12 @@ static inline void set_Block_block_visited_(ir_node *node, ir_visited_t visit)
        node->attr.block.block_visited = visit;
 }
 
+static inline ir_graph *get_Block_irg_(const ir_node *block)
+{
+       assert(is_Block(block));
+       return block->attr.irg.irg;
+}
+
 static inline void mark_Block_block_visited_(ir_node *node)
 {
        ir_graph *irg = get_Block_irg(node);
@@ -380,18 +421,6 @@ static inline int Block_block_visited_(const ir_node *node)
        return node->attr.block.block_visited >= get_irg_block_visited(irg);
 }
 
-static inline ir_graph *get_Block_irg_(const ir_node *block)
-{
-       assert(is_Block(block));
-       return block->attr.irg.irg;
-}
-
-static inline ir_tarval *get_Const_tarval_(const ir_node *node)
-{
-       assert(is_Const(node));
-       return node->attr.con.tarval;
-}
-
 static inline int is_Const_null_(const ir_node *node)
 {
        return tarval_is_null(get_Const_tarval_(node));
@@ -442,18 +471,6 @@ static inline int is_irn_cse_neutral_(const ir_node *node)
        return is_op_cse_neutral(get_irn_op_(node));
 }
 
-static inline cond_jmp_predicate get_Cond_jmp_pred_(const ir_node *node)
-{
-       assert(is_Cond(node));
-       return node->attr.cond.jmp_pred;
-}
-
-static inline void set_Cond_jmp_pred_(ir_node *node, cond_jmp_predicate pred)
-{
-       assert(is_Cond(node));
-       node->attr.cond.jmp_pred = pred;
-}
-
 static inline void *get_irn_generic_attr_(ir_node *node)
 {
        return &node->attr;
@@ -464,11 +481,6 @@ static inline const void *get_irn_generic_attr_const_(const ir_node *node)
        return &node->attr;
 }
 
-static inline unsigned get_irn_idx_(const ir_node *node)
-{
-       return node->node_idx;
-}
-
 static inline dbg_info *get_irn_dbg_info_(const ir_node *n)
 {
        return n->dbi;
@@ -565,81 +577,11 @@ static inline const ir_switch_table_entry *ir_switch_table_get_entry_const(
 
 void ir_register_getter_ops(void);
 
-/** initialize ir_node module */
-void init_irnode(void);
-
-/* this section MUST contain all inline functions */
-#define is_ir_node(thing)                     is_ir_node_(thing)
-#define get_irn_arity(node)                   get_irn_arity_(node)
-#define get_irn_n(node, n)                    get_irn_n_(node, n)
-#define get_irn_mode(node)                    get_irn_mode_(node)
-#define set_irn_mode(node, mode)              set_irn_mode_(node, mode)
-#define get_irn_irg(node)                     get_irn_irg_(node)
-#define get_nodes_block(node)                 get_nodes_block_(node)
-#define get_irn_op(node)                      get_irn_op_(node)
-#define set_irn_op(node, op)                  set_irn_op_(node, op)
-#define get_irn_opcode(node)                  get_irn_opcode_(node)
-#define get_irn_visited(node)                 get_irn_visited_(node)
-#define set_irn_visited(node, v)              set_irn_visited_(node, v)
-#define mark_irn_visited(node)                mark_irn_visited_(node)
-#define irn_visited(node)                     irn_visited_(node)
-#define irn_visited_else_mark(node)           irn_visited_else_mark_(node)
-#define set_irn_link(node, link)              set_irn_link_(node, link)
-#define get_irn_link(node)                    get_irn_link_(node)
-#define get_irn_pinned(node)                  get_irn_pinned_(node)
-#define is_irn_pinned_in_irg(node)            is_irn_pinned_in_irg_(node)
-#define is_unop(node)                         is_unop_(node)
-#define is_binop(node)                        is_binop_(node)
-#define is_Proj(node)                         is_Proj_(node)
-#define is_Phi(node)                          is_Phi_(node)
-#define is_strictConv(node)                   is_strictConv_(node)
-#define is_SymConst_addr_ent(node)            is_SymConst_addr_ent_(node)
-#define get_Block_n_cfgpreds(node)            get_Block_n_cfgpreds_(node)
-#define get_Block_cfgpred(node, pos)          get_Block_cfgpred_(node, pos)
-#define get_Block_cfgpred_block(node, pos)    get_Block_cfgpred_block_(node, pos)
-#define get_Block_block_visited(node)         get_Block_block_visited_(node)
-#define set_Block_block_visited(node, visit)  set_Block_block_visited_(node, visit)
-#define mark_Block_block_visited(node)        mark_Block_block_visited_(node)
-#define Block_block_visited(node)             Block_block_visited_(node)
-#define get_Block_irg(block)                  get_Block_irg_(block)
-#define get_Const_tarval(node)                get_Const_tarval_(node)
-#define is_Const_null(node)                   is_Const_null_(node)
-#define is_Const_one(node)                    is_Const_one_(node)
-#define is_Const_all_one(node)                is_Const_all_one_(node)
-#define is_irn_forking(node)                  is_irn_forking_(node)
-#define copy_node_attr(irg,oldn,newn)         copy_node_attr_(irg,oldn,newn)
-#define get_irn_type(node)                    get_irn_type_(node)
-#define get_irn_type_attr(node)               get_irn_type_attr_(node)
-#define get_irn_entity_attr(node)             get_irn_entity_attr_(node)
-#define is_irn_constlike(node)                is_irn_constlike_(node)
-#define is_irn_keep(node)                     is_irn_keep_(node)
-#define is_irn_start_block_placed(node)       is_irn_start_block_placed_(node)
-#define is_irn_cse_neutral(node)              is_irn_cse_neutral_(node)
-#define get_Cond_jmp_pred(node)               get_Cond_jmp_pred_(node)
-#define set_Cond_jmp_pred(node, pred)         set_Cond_jmp_pred_(node, pred)
-#define get_irn_generic_attr(node)            get_irn_generic_attr_(node)
-#define get_irn_generic_attr_const(node)      get_irn_generic_attr_const_(node)
-#define get_irn_idx(node)                     get_irn_idx_(node)
-
-#define get_irn_deps(node)                    get_irn_deps_(node)
-#define get_irn_dep(node, pos)                get_irn_dep_(node, pos)
-
-#define get_irn_ins_or_deps(node)             get_irn_ins_or_deps_(node)
-#define get_irn_in_or_dep(node, pos)          get_irn_in_or_dep_(node, pos)
-
-#define get_irn_dbg_info(node)                get_irn_dbg_info_(node)
-#define set_irn_dbg_info(node, db)            set_irn_dbg_info_(node, db)
-
-#define set_Block_phis(block, phi)            set_Block_phis_(block, phi)
-#define get_Block_phis(block)                 get_Block_phis_(block)
-#define add_Block_phi(block, phi)             add_Block_phi_(block, phi)
-#define get_Block_mark(block)                 get_Block_mark_(block)
-#define set_Block_mark(block, mark)           set_Block_mark_(block, mark)
-
-#define set_Phi_next(node, phi)               set_Phi_next_(node, phi)
-#define get_Phi_next(node)                    get_Phi_next_(node)
-
-#define is_arg_Proj(node)                     is_arg_Proj_(node)
-#define ir_switch_table_get_n_entries(table)  ir_switch_table_get_n_entries_(table)
+/**
+ * because firm keepalive edges are a broken concept, we have to make sure that
+ * nodes which are only held by a keepalive edges are never moved again.
+ * This function returns true in this case.
+ */
+bool only_used_by_keepalive(const ir_node *node);
 
 #endif