add cfg verifier ensuring 1 cfop per block and only 1 user for each mode_X node
[libfirm] / ir / ir / irverify.c
index ec368e7..28a9fe6 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 1995-2010 University of Karlsruhe.  All right reserved.
+ * Copyright (C) 1995-2011 University of Karlsruhe.  All right reserved.
  *
  * This file is part of libFirm.
  *
@@ -36,6 +36,7 @@
 #include "irouts.h"
 #include "irflag_t.h"
 #include "irpass_t.h"
+#include "irnodeset.h"
 
 /** if this flag is set, verify entity types in Load & Store nodes */
 static int verify_entities = 0;
@@ -233,7 +234,7 @@ static void show_node_on_graph(ir_graph *irg, ir_node *n)
  */
 static void show_call_param(ir_node *n, ir_type *mt)
 {
-       int i;
+       size_t i;
        char type_name[256];
        ir_print_type(type_name, sizeof(type_name), mt);
 
@@ -273,9 +274,10 @@ static void show_return_nres(ir_graph *irg, ir_node *n, ir_type *mt)
        ir_entity *ent = get_irg_entity(irg);
 
        show_entity_failure(n);
-       fprintf(stderr, "  Return node %ld in entity \"%s\" has %d results different from type %d\n",
+       fprintf(stderr, "  Return node %ld in entity \"%s\" has %lu results different from type %lu\n",
                get_irn_node_nr(n), get_entity_name(ent),
-               get_Return_n_ress(n), get_method_n_ress(mt));
+               (unsigned long) get_Return_n_ress(n),
+               (unsigned long) get_method_n_ress(mt));
 }
 
 /**
@@ -332,7 +334,6 @@ static int verify_node_Proj_Start(ir_node *n, ir_node *p)
                        (proj == pn_Start_X_initial_exec && mode == mode_X) ||
                        (proj == pn_Start_M              && mode == mode_M) ||
                        (proj == pn_Start_P_frame_base   && mode_is_reference(mode)) ||
-                       (proj == pn_Start_P_tls          && mode_is_reference(mode)) ||
                        (proj == pn_Start_T_args         && mode == mode_T)
                ),
                "wrong Proj from Start", 0,
@@ -413,8 +414,7 @@ static int verify_node_Proj_Call(ir_node *n, ir_node *p)
                        (proj == pn_Call_M                && mode == mode_M) ||
                        (proj == pn_Call_X_regular        && mode == mode_X) ||
                        (proj == pn_Call_X_except         && mode == mode_X) ||
-                       (proj == pn_Call_T_result         && mode == mode_T) ||
-                       (proj == pn_Call_P_value_res_base && mode_is_reference(mode))
+                       (proj == pn_Call_T_result         && mode == mode_T)
                ),
                "wrong Proj from Call", 0,
                show_proj_failure(p);
@@ -431,73 +431,6 @@ static int verify_node_Proj_Call(ir_node *n, ir_node *p)
        return 1;
 }
 
-/**
- * verify a Proj(Quot) node
- */
-static int verify_node_Proj_Quot(ir_node *n, ir_node *p)
-{
-       ir_mode *mode = get_irn_mode(p);
-       long proj     = get_Proj_proj(p);
-
-       ASSERT_AND_RET_DBG(
-               (
-                       (proj == pn_Quot_M         && mode == mode_M) ||
-                       (proj == pn_Quot_X_regular && mode == mode_X) ||
-                       (proj == pn_Quot_X_except  && mode == mode_X) ||
-                       (proj == pn_Quot_res       && mode_is_float(mode) && mode == get_Quot_resmode(n))
-               ),
-               "wrong Proj from Quot", 0,
-               show_proj_failure(p);
-       );
-       if (proj == pn_Quot_X_regular)
-               ASSERT_AND_RET(
-                       get_irn_pinned(n) == op_pin_state_pinned,
-                       "Regular Proj from unpinned Quot", 0);
-       else if (proj == pn_Quot_X_except)
-               ASSERT_AND_RET(
-                       get_irn_pinned(n) == op_pin_state_pinned,
-                       "Exception Proj from unpinned Quot", 0);
-       else if (proj == pn_Quot_M)
-               ASSERT_AND_RET(
-                       get_irn_pinned(n) == op_pin_state_pinned,
-                       "Memory Proj from unpinned Quot", 0);
-       return 1;
-}
-
-/**
- * verify a Proj(DivMod) node
- */
-static int verify_node_Proj_DivMod(ir_node *n, ir_node *p)
-{
-       ir_mode *mode = get_irn_mode(p);
-       long proj     = get_Proj_proj(p);
-
-       ASSERT_AND_RET_DBG(
-               (
-                       (proj == pn_DivMod_M         && mode == mode_M) ||
-                       (proj == pn_DivMod_X_regular && mode == mode_X) ||
-                       (proj == pn_DivMod_X_except  && mode == mode_X) ||
-                       (proj == pn_DivMod_res_div   && mode_is_int(mode) && mode == get_DivMod_resmode(n)) ||
-                       (proj == pn_DivMod_res_mod   && mode_is_int(mode) && mode == get_DivMod_resmode(n))
-               ),
-               "wrong Proj from DivMod", 0,
-               show_proj_failure(p);
-       );
-       if (proj == pn_DivMod_X_regular)
-               ASSERT_AND_RET(
-                       get_irn_pinned(n) == op_pin_state_pinned,
-                       "Regular Proj from unpinned DivMod", 0);
-       else if (proj == pn_DivMod_X_except)
-               ASSERT_AND_RET(
-                       get_irn_pinned(n) == op_pin_state_pinned,
-                       "Exception Proj from unpinned DivMod", 0);
-       else if (proj == pn_DivMod_M)
-               ASSERT_AND_RET(
-                       get_irn_pinned(n) == op_pin_state_pinned,
-                       "Memory Proj from unpinned DivMod", 0);
-       return 1;
-}
-
 /**
  * verify a Proj(Div) node
  */
@@ -511,7 +444,7 @@ static int verify_node_Proj_Div(ir_node *n, ir_node *p)
                        (proj == pn_Div_M         && mode == mode_M) ||
                        (proj == pn_Div_X_regular && mode == mode_X) ||
                        (proj == pn_Div_X_except  && mode == mode_X) ||
-                       (proj == pn_Div_res       && mode_is_int(mode) && mode == get_Div_resmode(n))
+                       (proj == pn_Div_res       && mode_is_data(mode) && mode == get_Div_resmode(n))
                ),
                "wrong Proj from Div", 0,
                show_proj_failure(p);
@@ -544,7 +477,7 @@ static int verify_node_Proj_Mod(ir_node *n, ir_node *p)
                        (proj == pn_Mod_M         && mode == mode_M) ||
                        (proj == pn_Mod_X_regular && mode == mode_X) ||
                        (proj == pn_Mod_X_except  && mode == mode_X) ||
-                       (proj == pn_Mod_res       && mode_is_int(mode) && mode == get_Mod_resmode(n))
+                       (proj == pn_Mod_res       && mode == get_Mod_resmode(n))
                ),
                "wrong Proj from Mod", 0,
                show_proj_failure(p);
@@ -564,28 +497,6 @@ static int verify_node_Proj_Mod(ir_node *n, ir_node *p)
        return 1;
 }
 
-/**
- * verify a Proj(Cmp) node
- */
-static int verify_node_Proj_Cmp(ir_node *n, ir_node *p)
-{
-       ir_mode *mode = get_irn_mode(p);
-       long proj     = get_Proj_proj(p);
-       (void) n;
-
-       ASSERT_AND_RET_DBG(
-               (proj >= 0 && proj <= 15 && mode == mode_b),
-               "wrong Proj from Cmp", 0,
-               show_proj_failure(p);
-       );
-       ASSERT_AND_RET_DBG(
-               (mode_is_float(get_irn_mode(get_Cmp_left(n))) || !(proj & pn_Cmp_Uo)),
-               "unordered Proj for non-float Cmp", 0,
-               show_proj_failure(p);
-       );
-       return 1;
-}
-
 /**
  * verify a Proj(Load) node
  */
@@ -711,7 +622,7 @@ static int verify_node_Proj_Proj(ir_node *pred, ir_node *p)
                                (proj >= 0 && mode_is_datab(mode)),
                                "wrong Proj from Proj from Start", 0);
                        ASSERT_AND_RET(
-                               (proj < get_method_n_params(mt)),
+                               (proj < (int)get_method_n_params(mt)),
                                "More Projs for args than args in type", 0
                                );
                        if ((mode_is_reference(mode)) && is_compound_type(get_method_param_type(mt, proj)))
@@ -736,7 +647,7 @@ static int verify_node_Proj_Proj(ir_node *pred, ir_node *p)
                        ASSERT_AND_RET(mt == get_unknown_type() || is_Method_type(mt),
                                        "wrong call type on call", 0);
                        ASSERT_AND_RET(
-                               (proj < get_method_n_ress(mt)),
+                               (proj < (int)get_method_n_ress(mt)),
                                "More Projs for results than results in type.", 0);
                        if ((mode_is_reference(mode)) && is_compound_type(get_method_res_type(mt, proj)))
                                /* value result */ break;
@@ -858,13 +769,14 @@ static int verify_node_Block(ir_node *n, ir_graph *irg)
                ASSERT_AND_RET(
                        is_Bad(pred) || (get_irn_mode(pred) == mode_X),
                        "Block node must have a mode_X predecessor", 0);
+               ASSERT_AND_RET(is_cfop(skip_Proj(skip_Tuple(pred))), "Block predecessor must be a cfop", 0);
        }
 
        if (n == get_irg_start_block(irg)) {
                ASSERT_AND_RET(get_Block_n_cfgpreds(n) == 0, "Start Block node", 0);
        }
 
-       if (n == get_irg_end_block(irg) && get_irg_phase_state(irg) != phase_backend)
+       if (n == get_irg_end_block(irg) && get_irg_phase_state(irg) != phase_backend) {
                /* End block may only have Return, Raise or fragile ops as preds. */
                for (i = get_Block_n_cfgpreds(n) - 1; i >= 0; --i) {
                        ir_node *pred =  skip_Proj(get_Block_cfgpred(n, i));
@@ -879,9 +791,10 @@ static int verify_node_Block(ir_node *n, ir_graph *irg)
                                ),
                                "End Block node", 0);
                }
-               /*  irg attr must == graph we are in. */
-               ASSERT_AND_RET(((get_irn_irg(n) && get_irn_irg(n) == irg)), "Block node has wrong irg attribute", 0);
-               return 1;
+       }
+       /*  irg attr must == graph we are in. */
+       ASSERT_AND_RET(((get_irn_irg(n) && get_irn_irg(n) == irg)), "Block node has wrong irg attribute", 0);
+       return 1;
 }
 
 /**
@@ -970,7 +883,7 @@ static int verify_node_Return(ir_node *n, ir_graph *irg)
        ASSERT_AND_RET( mymode == mode_X, "Result X", 0 );   /* result X */
        /* Compare returned results with result types of method type */
        mt = get_entity_type(get_irg_entity(irg));
-       ASSERT_AND_RET_DBG( get_Return_n_ress(n) == get_method_n_ress(mt),
+       ASSERT_AND_RET_DBG(get_Return_n_ress(n) == get_method_n_ress(mt),
                "Number of results for Return doesn't match number of results in type.", 0,
                show_return_nres(irg, n, mt););
        for (i = get_Return_n_ress(n) - 1; i >= 0; --i) {
@@ -1118,7 +1031,8 @@ static int verify_node_Call(ir_node *n, ir_graph *irg)
        ir_mode *op1mode = get_irn_mode(get_Call_mem(n));
        ir_mode *op2mode = get_irn_mode(get_Call_ptr(n));
        ir_type *mt;
-       int i;
+       size_t i;
+       size_t n_params;
        (void) irg;
 
        /* Call: BB x M x ref x data1 x ... x datan
@@ -1133,7 +1047,8 @@ static int verify_node_Call(ir_node *n, ir_graph *irg)
                return 1;
        }
 
-       for (i = get_Call_n_params(n) - 1; i >= 0; --i) {
+       n_params = get_Call_n_params(n);
+       for (i = 0; i < n_params; ++i) {
                ASSERT_AND_RET( mode_is_datab(get_irn_mode(get_Call_param(n, i))), "Call node", 0 );  /* operand datai */
        }
 
@@ -1306,50 +1221,6 @@ static int verify_node_Mulh(ir_node *n, ir_graph *irg)
        return 1;
 }
 
-/**
- * verify a Quot node
- */
-static int verify_node_Quot(ir_node *n, ir_graph *irg)
-{
-       ir_mode *mymode  = get_irn_mode(n);
-       ir_mode *op1mode = get_irn_mode(get_Quot_mem(n));
-       ir_mode *op2mode = get_irn_mode(get_Quot_left(n));
-       ir_mode *op3mode = get_irn_mode(get_Quot_right(n));
-       (void) irg;
-
-       ASSERT_AND_RET_DBG(
-               /* Quot: BB x M x float x float --> M x X x float */
-               op1mode == mode_M && op2mode == op3mode &&
-               get_mode_sort(op2mode) == irms_float_number &&
-               mymode == mode_T,
-               "Quot node",0,
-               show_binop_failure(n, "/* Quot: BB x M x float x float --> M x X x float */");
-       );
-       return 1;
-}
-
-/**
- * verify a DivMod node
- */
-static int verify_node_DivMod(ir_node *n, ir_graph *irg)
-{
-       ir_mode *mymode  = get_irn_mode(n);
-       ir_mode *op1mode = get_irn_mode(get_DivMod_mem(n));
-       ir_mode *op2mode = get_irn_mode(get_DivMod_left(n));
-       ir_mode *op3mode = get_irn_mode(get_DivMod_right(n));
-       (void) irg;
-
-       ASSERT_AND_RET(
-               /* DivMod: BB x M x int x int --> M x X x int x int */
-               op1mode == mode_M &&
-               mode_is_int(op2mode) &&
-               op3mode == op2mode &&
-               mymode == mode_T,
-               "DivMod node", 0
-               );
-       return 1;
-}
-
 /**
  * verify a Div node
  */
@@ -1362,10 +1233,10 @@ static int verify_node_Div(ir_node *n, ir_graph *irg)
        (void) irg;
 
        ASSERT_AND_RET(
-               /* Div: BB x M x int x int --> M x X x int */
+               /* Div: BB x M x data x data --> M x X x data */
                op1mode == mode_M &&
                op2mode == op3mode &&
-               mode_is_int(op2mode) &&
+               mode_is_data(op2mode) &&
                mymode == mode_T,
                "Div node", 0
                );
@@ -1406,7 +1277,7 @@ static int verify_node_Logic(ir_node *n, ir_graph *irg)
 
        ASSERT_AND_RET_DBG(
                /* And or Or or Eor: BB x int x int --> int */
-               (mode_is_int(mymode) || mymode == mode_b) &&
+               (mode_is_int(mymode) || mode_is_reference(mymode) || mymode == mode_b) &&
                op2mode == op1mode &&
                mymode == op2mode,
                "And, Or or Eor node", 0,
@@ -1452,7 +1323,7 @@ static int verify_node_Cmp(ir_node *n, ir_graph *irg)
                /* Cmp: BB x datab x datab --> b16 */
                mode_is_datab(op1mode) &&
                op2mode == op1mode &&
-               mymode == mode_T,
+               mymode == mode_b,
                "Cmp node", 0,
                show_binop_failure(n, "/* Cmp: BB x datab x datab --> b16 */");
        );
@@ -1969,6 +1840,121 @@ static void verify_wrap_ssa(ir_node *node, void *env)
 
 #endif /* DEBUG_libfirm */
 
+typedef struct check_cfg_env_t {
+       pmap *branch_nodes; /**< map blocks to their branching nodes,
+                                map mode_X nodes to the blocks they branch to */
+       int   res;
+       ir_nodeset_t ignore_nodes;
+       ir_nodeset_t kept_nodes;
+} check_cfg_env_t;
+
+static int check_cfg_node(ir_node *node, check_cfg_env_t *env)
+{
+       pmap    *branch_nodes = env->branch_nodes;
+       ir_mode *mode         = get_irn_mode(node);
+
+       if (ir_nodeset_contains(&env->ignore_nodes, node))
+               return 1;
+
+       if (mode == mode_X) {
+               ir_node *block         = get_nodes_block(node);
+               ir_node *former_branch = pmap_get(branch_nodes, block);
+               ir_node *branch        = node;
+
+               if (is_Proj(branch)) {
+                       branch = skip_Proj(skip_Tuple(branch));
+               }
+
+               ASSERT_AND_RET_DBG(former_branch == NULL || former_branch == branch,
+                                  "Multiple branching nodes in a block", 0,
+                                  ir_printf("nodes %+F,%+F in block %+F\n",
+                                            node, former_branch, block));
+               pmap_insert(branch_nodes, block, branch);
+       } else if (is_Block(node)) {
+               int n_cfgpreds = get_Block_n_cfgpreds(node);
+               int i;
+
+               for (i = 0; i < n_cfgpreds; ++i) {
+                       ir_node *branch = get_Block_cfgpred(node, i);
+                       ir_node *former_dest;
+                       if (is_Bad(branch))
+                               continue;
+                       former_dest = pmap_get(branch_nodes, branch);
+                       ASSERT_AND_RET_DBG(former_dest==NULL || is_unknown_jump(skip_Proj(branch)),
+                                          "Multiple users on mode_X node", 0,
+                                          ir_printf("node %+F\n", node));
+                       pmap_insert(branch_nodes, branch, node);
+               }
+       } else if (is_Tuple(node)) {
+               int arity = get_irn_arity(node);
+               int i;
+
+               for (i = 0; i < arity; ++i) {
+                       ir_node *in = get_irn_n(node, i);
+                       ir_nodeset_insert(&env->ignore_nodes, in);
+               }
+       }
+
+       return 1;
+}
+
+static void check_cfg_walk_func(ir_node *node, void *data)
+{
+       check_cfg_env_t *env = (check_cfg_env_t*)data;
+       int              res = check_cfg_node(node, env);
+       env->res &= res;
+}
+
+static int verify_block_branch(ir_node *block, check_cfg_env_t *env)
+{
+       ir_node *branch = pmap_get(env->branch_nodes, block);
+       ASSERT_AND_RET_DBG(branch != NULL || ir_nodeset_contains(&env->kept_nodes, block),
+                          "block contains no cfop", 0,
+                          ir_printf("block %+F\n", block));
+       return 1;
+}
+
+static void assert_branch(ir_node *node, void *data)
+{
+       check_cfg_env_t *env = (check_cfg_env_t*)data;
+       if (is_Block(node)) {
+               env->res &= verify_block_branch(node, env);
+       }
+}
+
+/**
+ * Checks CFG well-formedness
+ */
+static int check_cfg(ir_graph *irg)
+{
+       check_cfg_env_t env;
+       env.branch_nodes = pmap_create(); /**< map blocks to branch nodes */
+       env.res          = 1;
+       ir_nodeset_init(&env.ignore_nodes);
+
+       /* note that we do not use irg_walk_block because it will miss these
+        * invalid blocks without a jump instruction which we want to detect
+        * here */
+       irg_walk_graph(irg, check_cfg_walk_func, NULL, &env);
+       ir_nodeset_destroy(&env.ignore_nodes);
+
+       ir_nodeset_init(&env.kept_nodes);
+       {
+               ir_node *end   = get_irg_end(irg);
+               int      arity = get_irn_arity(end);
+               int      i;
+               for (i = 0; i < arity; ++i) {
+                       ir_node *n = get_irn_n(end, i);
+                       ir_nodeset_insert(&env.kept_nodes, n);
+               }
+       }
+       irg_walk_graph(irg, assert_branch, NULL, &env);
+
+       ir_nodeset_destroy(&env.kept_nodes);
+       pmap_destroy(env.branch_nodes);
+       return env.res;
+}
+
 /*
  * Calls irn_verify for each node in irg.
  * Graph must be in state "op_pin_state_pinned".
@@ -1978,23 +1964,26 @@ int irg_verify(ir_graph *irg, unsigned flags)
 {
        int res = 1;
 #ifdef DEBUG_libfirm
+       int pinned = get_irg_pinned(irg) == op_pin_state_pinned;
 
 #ifndef NDEBUG
-    last_irg_error = NULL;
+       last_irg_error = NULL;
 #endif /* NDEBUG */
 
-       assert(get_irg_pinned(irg) == op_pin_state_pinned && "Verification need pinned graph");
-
-       if (flags & VERIFY_ENFORCE_SSA)
+       if ((flags & VERIFY_ENFORCE_SSA) && pinned)
                compute_doms(irg);
 
        irg_walk_anchors(
                irg,
-               get_irg_dom_state(irg) == dom_consistent &&
-               get_irg_pinned(irg) == op_pin_state_pinned ? verify_wrap_ssa : verify_wrap,
-               NULL, &res
+               pinned && get_irg_dom_state(irg) == dom_consistent
+                       ? verify_wrap_ssa : verify_wrap,
+               NULL,
+               &res
        );
 
+       if (!check_cfg(irg))
+               res = 0;
+
        if (get_node_verification_mode() == FIRM_VERIFICATION_REPORT && ! res) {
                ir_entity *ent = get_irg_entity(irg);
 
@@ -2183,7 +2172,7 @@ int irg_verify_bads(ir_graph *irg, int flags)
 /*
  * set the default verify operation
  */
-void firm_set_default_verifyer(ir_opcode code, ir_op_ops *ops)
+void firm_set_default_verifier(unsigned code, ir_op_ops *ops)
 {
 #define CASE(a)                           \
    case iro_##a:                          \
@@ -2209,8 +2198,6 @@ void firm_set_default_verifyer(ir_opcode code, ir_op_ops *ops)
        CASE(Minus);
        CASE(Mul);
        CASE(Mulh);
-       CASE(Quot);
-       CASE(DivMod);
        CASE(Div);
        CASE(Mod);
        CASE(And);
@@ -2250,11 +2237,8 @@ void firm_set_default_verifyer(ir_opcode code, ir_op_ops *ops)
        CASE(Raise);
        CASE(InstOf);
        CASE(Call);
-       CASE(Quot);
-       CASE(DivMod);
        CASE(Div);
        CASE(Mod);
-       CASE(Cmp);
        CASE(Load);
        CASE(Store);
        CASE(Alloc);