Fixed optimization of Div/Mod/DivMod nodes
[libfirm] / ir / ir / irdump.c
index 741ee3a..5f2c0d7 100644 (file)
@@ -6,7 +6,7 @@
  * Modified by: Goetz Lindenmaier, Hubert Schmidt
  * Created:
  * CVS-ID:      $Id$
- * Copyright:   (c) 1998-2003 Universität Karlsruhe
+ * Copyright:   (c) 1998-2003 Universitt Karlsruhe
  * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
  */
 #ifdef HAVE_CONFIG_H
 #include "type_or_entity.h"
 #include "irouts.h"
 #include "irdom.h"
-#include "irloop.h"
+#include "irloop_t.h"
 #include "callgraph.h"
+#include "irextbb_t.h"
+#include "dbginfo_t.h"
 
 #include "irvrfy.h"
 
@@ -239,12 +241,19 @@ static INLINE void dump_loop_nodes_into_graph(FILE *F, ir_graph *irg);
  */
 static pmap *irdump_link_map = NULL;
 
-/** Creates the link attribut map. */
+/** NOT A STANDARD LIBFIRM INIT METHOD
+ *
+ * We do not want to integrate dumping into libfirm, i.e., if the dumpers
+ * are off, we want to have as few interferences as possible.  Therefore the
+ * initialization is performed lazily and not called from within init_firm.
+ *
+ * Creates the link attribute map. */
 static void init_irdump(void) {
   /* We need a new, empty map. */
   if (irdump_link_map) pmap_destroy(irdump_link_map);
   irdump_link_map = pmap_create();
-  dump_file_filter_id = new_id_from_str("");
+  if (!dump_file_filter_id)
+    dump_file_filter_id = new_id_from_str("");
 }
 /**
  * Returns the private link field.
@@ -287,7 +296,7 @@ static void ird_set_irg_link(ir_graph *irg, void *x) {
 }
 
 /**
- * Walker, clears tzhe private link field
+ * Walker, clears the private link field.
  */
 static void clear_link(ir_node * node, void * env) {
   ird_set_irn_link(node, NULL);
@@ -357,7 +366,7 @@ static void collect_node(ir_node * node, void *env) {
  * graphs not visited.
  * Free the list with DEL_ARR_F().
  */
-static ir_node ** construct_block_lists(ir_graph *irg) {
+static ir_node **construct_block_lists(ir_graph *irg) {
   int i, rem_view = get_interprocedural_view();
   ir_graph *rem = current_ir_graph;
   current_ir_graph = irg;
@@ -381,6 +390,46 @@ static ir_node ** construct_block_lists(ir_graph *irg) {
   return ird_get_irg_link(irg);
 }
 
+typedef struct _list_tuple {
+  ir_node **blk_list;
+  ir_extblk **extbb_list;
+} list_tuple;
+
+/** Construct lists to walk ir extended block-wise.
+ * Free the lists in the tuple with DEL_ARR_F().
+ */
+static list_tuple *construct_extblock_lists(ir_graph *irg) {
+  ir_node **blk_list = construct_block_lists(irg);
+  int i;
+  ir_graph *rem = current_ir_graph;
+  list_tuple *lists = xmalloc(sizeof(*lists));
+
+  current_ir_graph = irg;
+
+  lists->blk_list   = NEW_ARR_F(ir_node *, 0);
+  lists->extbb_list = NEW_ARR_F(ir_extblk *, 0);
+
+  for (i = ARR_LEN(blk_list) - 1; i >= 0; --i) {
+    ir_extblk *ext;
+
+    if (is_Block(blk_list[i])) {
+      ext = get_Block_extbb(blk_list[i]);
+
+      if (extbb_not_visited(ext)) {
+        ARR_APP1(ir_extblk *, lists->extbb_list, ext);
+        mark_extbb_visited(ext);
+      }
+    }
+    else
+      ARR_APP1(ir_node *, lists->blk_list, blk_list[i]);
+  }
+
+  current_ir_graph = rem;
+  DEL_ARR_F(blk_list);
+  ird_set_irg_link(irg, lists);
+  return lists;
+}
+
 /*******************************************************************/
 /* flags to steer output                                           */
 /*******************************************************************/
@@ -402,12 +451,25 @@ bool opt_dump_pointer_values_to_info = 0;  /* default off: for test compares!! *
 
 static const char *overrule_nodecolor = NULL;
 
+/** An additional edge hook. */
+static DUMP_NODE_EDGE_FUNC dump_node_edge_hook = NULL;
+
+void set_dump_node_edge_hook(DUMP_NODE_EDGE_FUNC func)
+{
+    dump_node_edge_hook = func;
+}
+
+DUMP_NODE_EDGE_FUNC get_dump_node_edge_hook(void)
+{
+    return dump_node_edge_hook;
+}
+
+
 /** The vcg attribute hook. */
 static DUMP_NODE_VCGATTR_FUNC dump_node_vcgattr_hook = NULL;
 
 /* set the hook */
-void set_dump_node_vcgattr_hook(DUMP_NODE_VCGATTR_FUNC hook)
-{
+void set_dump_node_vcgattr_hook(DUMP_NODE_VCGATTR_FUNC hook) {
   dump_node_vcgattr_hook = hook;
 }
 
@@ -538,10 +600,6 @@ dump_node_opcode(FILE *F, ir_node *n)
         && get_Proj_proj(n) == get_Cond_defaultProj(pred)
         && get_irn_mode(get_Cond_selector(pred)) != mode_b)
       fprintf (F, "defProj");
-/*
- *   else if (get_irn_opcode(pred) == iro_Proj && get_irn_opcode(get_Proj_pred(pred)) == iro_Start)
- *     fprintf (F, "Arg");
- */
     else
       goto default_case;
   } break;
@@ -570,8 +628,8 @@ dump_node_opcode(FILE *F, ir_node *n)
     fprintf (F, "%s[%s]", get_irn_opname(n), get_mode_name_ex(get_Load_mode(n), &bad));
     break;
 
-default_case:
   default: {
+default_case:
     fprintf (F, "%s", get_irn_opname(n));
   }
 
@@ -612,7 +670,7 @@ dump_node_mode(FILE *F, ir_node *n)
 }
 
 /**
- * Dump the tpe of a node n to a file F if it's known.
+ * Dump the type of a node n to a file F if it's known.
  */
 static int dump_node_typeinfo(FILE *F, ir_node *n) {
   int bad = 0;
@@ -631,12 +689,13 @@ static int dump_node_typeinfo(FILE *F, ir_node *n) {
 }
 
 /**
- * Dump addinional node attributes of some nodes to a file F.
+ * Dump additional node attributes of some nodes to a file F.
  */
 static INLINE int
 dump_node_nodeattr(FILE *F, ir_node *n)
 {
   int bad = 0;
+  ir_node *pred;
 
   switch (get_irn_opcode(n)) {
   case iro_Start:
@@ -645,11 +704,26 @@ dump_node_nodeattr(FILE *F, ir_node *n)
     }
     break;
   case iro_Proj:
-    if (get_irn_opcode(get_Proj_pred(n)) == iro_Cmp) {
+    pred = get_Proj_pred(n);
+
+    if (get_irn_opcode(pred) == iro_Cmp)
       fprintf (F, "%s ", get_pnc_string(get_Proj_proj(n)));
-    } else {
-      fprintf (F, "%ld ", get_Proj_proj(n));
+    else if (get_irn_opcode(pred) == iro_Start) {
+      switch (get_Proj_proj(n)) {
+      case pn_Start_P_frame_base:
+        fprintf (F, "FrameBase "); break;
+      case pn_Start_P_globals:
+        fprintf (F, "GlobalBase "); break;
+      case pn_Start_P_value_arg_base:
+        fprintf (F, "ValueBase "); break;
+      default:
+        fprintf (F, "%ld ", get_Proj_proj(n));
+      }
     }
+    else if (get_irn_opcode(pred) == iro_Proj && get_irn_opcode(get_Proj_pred(pred)) == iro_Start)
+      fprintf (F, "Arg %ld ", get_Proj_proj(n));
+    else
+      fprintf (F, "%ld ", get_Proj_proj(n));
     break;
   case iro_Filter:
     fprintf (F, "%ld ", get_Filter_proj(n));
@@ -678,11 +752,11 @@ dump_node_nodeattr(FILE *F, ir_node *n)
 void dump_node_ana_vals(FILE *F, ir_node *n) {
   return;
   fprintf(F, " %lf*(%2.0lf + %2.0lf) = %2.0lf ",
-         get_irn_exec_freq(n),
-         get_irg_method_execution_frequency(get_irn_irg(n)),
-         pow(5, get_irg_recursion_depth(get_irn_irg(n))),
-         get_irn_exec_freq(n) * (get_irg_method_execution_frequency(get_irn_irg(n)) + pow(5, get_irg_recursion_depth(get_irn_irg(n))))
-         );
+          get_irn_exec_freq(n),
+          get_irg_method_execution_frequency(get_irn_irg(n)),
+          pow(5, get_irg_recursion_depth(get_irn_irg(n))),
+          get_irn_exec_freq(n) * (get_irg_method_execution_frequency(get_irn_irg(n)) + pow(5, get_irg_recursion_depth(get_irn_irg(n))))
+          );
 }
 
 
@@ -764,7 +838,7 @@ static INLINE int dump_node_info(FILE *F, ir_node *n)
 }
 
 /**
- * checks wheater a node is "constant-like", ie can be treated "block-less"
+ * checks whether a node is "constant-like" ie can be treated "block-less"
  */
 static INLINE
 bool is_constlike_node(ir_node *n) {
@@ -845,6 +919,20 @@ static void INLINE print_node_error(FILE *F, const char *err_msg)
   fprintf (F, " info2: \"%s\"", err_msg);
 }
 
+/**
+ * prints debug messages of a node to file F as info3.
+ */
+static void print_node_dbg_info(FILE *F, dbg_info *dbg)
+{
+  char buf[1024];
+
+  if (__dbg_info_snprint) {
+    buf[0] = '\0';
+    if (__dbg_info_snprint(buf, sizeof(buf), dbg) > 0)
+      fprintf (F, " info3: \"%s\"", buf);
+  }
+}
+
 /**
  * Dump a node
  */
@@ -866,9 +954,13 @@ static void dump_node(FILE *F, ir_node *n)
   fprintf(F, "\" ");
   bad |= dump_node_info(F, n);
   print_node_error(F, p);
+  print_node_dbg_info(F, get_irn_dbg_info(n));
   dump_node_vcgattr(F, n, NULL, bad);
   fprintf(F, "}\n");
   dump_const_node_local(F, n);
+
+  if(dump_node_edge_hook)
+    dump_node_edge_hook(F, n);
 #if DO_HEAPANALYSIS
   dump_irn_chi_term(F, n);
   dump_irn_state(F, n);
@@ -897,7 +989,11 @@ dump_ir_block_edge(FILE *F, ir_node *n)  {
 
 static void
 print_data_edge_vcgattr(FILE *F, ir_node *from, int to) {
-  if (get_nodes_block(from) == get_nodes_block(get_irn_n(from, to)))
+       /*
+        * do not use get_nodes_block() here, will fail
+        * if the irg is not pinned.
+        */
+  if (get_irn_n(from, -1) == get_irn_n(get_irn_n(from, to), -1))
     fprintf (F, INTRA_DATA_EDGE_ATTR);
   else
     fprintf (F, INTER_DATA_EDGE_ATTR);
@@ -905,7 +1001,11 @@ print_data_edge_vcgattr(FILE *F, ir_node *from, int to) {
 
 static void
 print_mem_edge_vcgattr(FILE *F, ir_node *from, int to) {
-  if (get_nodes_block(from) == get_nodes_block(get_irn_n(from, to)))
+       /*
+        * do not use get_nodes_block() here, will fail
+        * if the irg is not pinned.
+        */
+  if (get_irn_n(from, -1) == get_irn_n(get_irn_n(from, to), -1))
     fprintf (F, INTRA_MEM_EDGE_ATTR);
   else
     fprintf (F, INTER_MEM_EDGE_ATTR);
@@ -1106,7 +1206,7 @@ static void dump_const_expression(FILE *F, ir_node *value) {
   current_ir_graph = get_const_code_irg();
   irg_walk(value, dump_const_node, NULL, F);
   /* Decrease visited flag so that we walk with the same flag for the next
-     expresssion.  This guarantees that we don't dump the same node twice,
+     expression.  This guarantees that we don't dump the same node twice,
      as for const expressions cse is performed to save memory. */
   set_irg_visited(current_ir_graph, get_irg_visited(current_ir_graph) -1);
   current_ir_graph = rem;
@@ -1170,7 +1270,7 @@ dump_block_graph(FILE *F, ir_graph *irg) {
     } else {
       /* Nodes that are not in a Block. */
       dump_node(F, node);
-      if (is_Bad(get_nodes_block(node)) && !node_floats(node)) {
+      if (!node_floats(node) && is_Bad(get_nodes_block(node))) {
         dump_const_block_local(F, node);
       }
       dump_ir_data_edges(F, node);
@@ -1183,7 +1283,7 @@ dump_block_graph(FILE *F, ir_graph *irg) {
   current_ir_graph = rem;
 }
 
-/** Dumps an irg as a graph.
+/** Dumps an irg as a graph clustered by block nodes.
  *  If interprocedural view edges can point to nodes out of this graph.
  */
 static void dump_graph_from_list(FILE *F, ir_graph *irg) {
@@ -1199,6 +1299,52 @@ static void dump_graph_from_list(FILE *F, ir_graph *irg) {
   fprintf(F, "}\n\n");
 }
 
+/** dumps a graph extended block-wise. Expects all blockless nodes in arr in irgs link.
+ *  The outermost nodes: blocks and nodes not op_pin_state_pinned, Bad, Unknown. */
+static void
+dump_extblock_graph(FILE *F, ir_graph *irg) {
+  int i;
+  ir_graph *rem = current_ir_graph;
+  ir_extblk **arr = ird_get_irg_link(irg);
+  current_ir_graph = irg;
+
+  compute_extbb(irg);
+  for (i = ARR_LEN(arr) - 1; i >= 0; --i) {
+    ir_extblk *extbb = arr[i];
+    ir_node *leader = extbb->blks[0];
+    int j;
+
+    fprintf(F, "graph: { title: \"");
+    PRINT_EXTBBID(leader);
+    fprintf(F, "\"  label: \"ExtBB %ld\" status:clustered color:lightgreen\n",
+            get_irn_node_nr(leader));
+
+    for (j = ARR_LEN(extbb->blks) - 1; j >= 0; --j) {
+      ir_node * node = extbb->blks[j];
+      if (is_Block(node)) {
+        /* Dumps the block and all the nodes in the block, which are to
+           be found in Block->link. */
+        dump_whole_block(F, node);
+      } else {
+        /* Nodes that are not in a Block. */
+        dump_node(F, node);
+        if (is_Bad(get_nodes_block(node)) && !node_floats(node)) {
+          dump_const_block_local(F, node);
+        }
+        dump_ir_data_edges(F, node);
+      }
+    }
+    fprintf(F, "}\n");
+  }
+
+  if (dump_loop_information_flag && (get_irg_loopinfo_state(irg) & loopinfo_valid))
+    dump_loop_nodes_into_graph(F, irg);
+
+  current_ir_graph = rem;
+  free_extbb(irg);
+}
+
+
 /*******************************************************************/
 /* Basic type and entity nodes and edges.                          */
 /*******************************************************************/
@@ -1702,7 +1848,8 @@ INLINE void dump_vcg_header(FILE *F, const char *name, const char *orientation)
        "classname 11: \"Overwrites\"\n"
        "classname 12: \"Member\"\n"
        "infoname 1: \"Attribute\"\n"
-       "infoname 2: \"Verification errors\"\n",
+       "infoname 2: \"Verification errors\"\n"
+       "infoname 3: \"Debug info\"\n",
        name, label, orientation);
 
   /* don't use all, the range is too whith/black. */
@@ -1886,9 +2033,8 @@ dump_ir_graph (ir_graph *irg, const char *suffix )
   current_ir_graph = rem;
 }
 
-
-void
-dump_ir_block_graph (ir_graph *irg, const char *suffix)
+/* Dump a firm graph without explicit block nodes. */
+void dump_ir_block_graph (ir_graph *irg, const char *suffix)
 {
   FILE *f;
   int i;
@@ -1904,6 +2050,11 @@ dump_ir_block_graph (ir_graph *irg, const char *suffix)
 
   construct_block_lists(irg);
 
+  /*
+   * If we are in the interprocedural view, we dump not
+   * only the requested irg but also all irgs that can be reached
+   * from irg.
+   */
   for (i = 0; i < get_irp_n_irgs(); i++) {
     ir_node **arr = ird_get_irg_link(get_irp_irg(i));
     if (arr) {
@@ -1915,7 +2066,61 @@ dump_ir_block_graph (ir_graph *irg, const char *suffix)
   vcg_close(f);
 }
 
-/** dumps a graph with type information */
+/* Dump a firm graph without explicit block nodes but grouped in extended blocks. */
+void dump_ir_extblock_graph (ir_graph *irg, const char *suffix)
+{
+  FILE *F;
+  int i;
+  char *suffix1;
+
+  if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg))))
+    return;
+
+  compute_extbb(irg);
+
+  if (get_interprocedural_view()) suffix1 = "-ip";
+  else                            suffix1 = "";
+  F = vcg_open(irg, suffix, suffix1);
+  dump_vcg_header(F, get_irg_dump_name(irg), NULL);
+
+  construct_extblock_lists(irg);
+
+  fprintf(F, "graph: { title: \"");
+  PRINT_IRGID(irg);
+  fprintf(F, "\" label: \"%s\" status:clustered color:white \n",
+    get_ent_dump_name(get_irg_entity(irg)));
+
+  for (i = 0; i < get_irp_n_irgs(); i++) {
+    ir_graph *irg     = get_irp_irg(i);
+    list_tuple *lists = ird_get_irg_link(irg);
+
+    if (lists) {
+      /* dump the extended blocks first */
+      if (ARR_LEN(lists->extbb_list)) {
+        ird_set_irg_link(irg, lists->extbb_list);
+        dump_extblock_graph(F, irg);
+      }
+
+      /* we may have blocks without extended blocks, bad for instance */
+      if (ARR_LEN(lists->blk_list)) {
+        ird_set_irg_link(irg, lists->blk_list);
+        dump_block_graph(F, irg);
+      }
+
+      DEL_ARR_F(lists->extbb_list);
+      DEL_ARR_F(lists->blk_list);
+      xfree(lists);
+    }
+  }
+
+  /* Close the vcg information for the irg */
+  fprintf(F, "}\n\n");
+
+  vcg_close(F);
+  free_extbb(irg);
+}
+
+/* dumps a graph with type information */
 void
 dump_ir_graph_w_types (ir_graph *irg, const char *suffix)
 {
@@ -2022,10 +2227,10 @@ dump_block_to_cfg(ir_node *block, void *env) {
     for (fl = i = 0; i < get_Block_n_cfgpreds(block); ++i) {
       ir_node *pred = get_Block_cfgpred(block, i);
       if (is_Bad(pred)) {
-       if (! fl)
-         fprintf(F, "Bad pred at pos: ");
-       fprintf(F, "%d ", i);
-       fl = 1;
+        if (! fl)
+          fprintf(F, "Bad pred at pos: ");
+        fprintf(F, "%d ", i);
+        fl = 1;
       }
     }
     if (fl)
@@ -2037,7 +2242,7 @@ dump_block_to_cfg(ir_node *block, void *env) {
     /* Check whether we have bad predecessors to color the block. */
     for (i = 0; i < get_Block_n_cfgpreds(block); ++i)
       if ((fl = is_Bad(get_Block_cfgpred(block, i))))
-       break;
+        break;
 #endif
 
     fprintf (F, "\"");  /* closing quote of info */