renames all is_x*_type() functions to is_X*_type() to prevent name clash with EDG...
[libfirm] / ir / common / firmwalk.c
index 5f3a566..30019c0 100644 (file)
@@ -1,26 +1,43 @@
+/*
+ * Project:     libFIRM
+ * File name:   ir/common/firmwalk.c
+ * Purpose:     Walker that touches all Firm data structures
+ * Author:      Sebastian Felis
+ * Modified by:
+ * Created:     7.2003
+ * CVS-ID:      $Id$
+ * Copyright:   (c) 2003 Universität Karlsruhe
+ * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
+ */
 
 #ifdef HAVE_CONFIG_H
-# include <config.h>
+# include "config.h"
+#endif
+
+#ifdef HAVE_STRING_H
+# include <string.h>
 #endif
 
 #include "firmwalk.h"
-#include "pmap.h"
-#include "entity.h"
-#include "irprog.h"
+
+#include "entity_t.h"
+#include "irnode_t.h"
+#include "irprog_t.h"
 #include "irgwalk.h"
+
 #include "array.h"
 #include "obst.h"
-#include <string.h>
+#include "pmap.h"
 
 /** obstack for firm walker */
 static struct obstack fw_obst;
 
 /** This map stores all types of firm */
 static pmap *mode_map = NULL;
-/** This list stores all types of firm */
-static type **type_list = NULL;
-/** This list stores all entities of firm */
-static entity **entity_list = NULL;
+/** This map stores all types of firm */
+static pmap *type_map = NULL;
+/** This map stores all entities of firm */
+static pmap *entity_map = NULL;
 
 /** Internal data structure of firm walker to collect
  *  some information of firm ir. The collected data will be stored
@@ -33,13 +50,13 @@ typedef struct {
                        get_firm_walk_link. */
 } fw_data;
 
-//@{
+/*@{ */
 /** Access macros to fw_data structure */
 #define FW_GET_DATA_LIST(s)     ((s)->list)
 #define FW_SET_DATA_LIST(s, t)  ((s)->list = (t))
 #define FW_GET_DATA_LINK(s)     ((s)->link)
 #define FW_SET_DATA_LINK(s, t)  ((s)->link = (t))
-//@}
+/*@} */
 
 /** Returns own data struct of the firm walker.
  *
@@ -85,13 +102,15 @@ fw_data *fw_get_data(void *thing)
       }
     }
     break;
-  default: {} // other kinds of firm nodes
+  default: {} /*  other kinds of firm nodes */
   }
 
   return data;
 }
 
-/** Free all collected data in ir graphs and nodes. */
+/** Free all collected data in ir graphs and nodes.
+ *  An ir graph or an ir block node has a list as a
+ *  dynamic array, which will be deleted here.  */
 static
 void fw_free_data(void *thing)
 {
@@ -121,11 +140,11 @@ void fw_free_data(void *thing)
       }
     }
     break;
-  default: {} // other kinds of firm nodes
+  default: {} /*  other kinds of firm nodes */
   }
 }
 
-// documentation in header file
+/*  documentation in header file */
 void set_firm_walk_link(void *thing, void *link)
 {
   fw_data *data;
@@ -154,11 +173,11 @@ void set_firm_walk_link(void *thing, void *link)
   case k_ir_mode:
     set_mode_link(thing, link);
     break;
-  default: {} // other kinds of firm nodes
+  default: {} /*  other kinds of firm nodes */
   }
 }
 
-// documentation in header file
+/*  documentation in header file */
 void *get_firm_walk_link(void *thing)
 {
   fw_data *data;
@@ -193,11 +212,12 @@ void fw_clear_link(ir_node * node, void * env)
   set_irn_link(node, NULL);
 }
 
-/** Fill maps of type and entity
+/** Fill maps of type and entity.
  *  This function will be called by the firm walk initializer
  *  to collect all types and entities of program's firm ir.
  *  All types will be colleced in the hash table type_map
- *  and all entity are stored in entity_map.
+ *  and all entity are stored in entity_map. The mode of an
+ *  type will be collected as well.
  *
  *  @param tore Type or entity
  *  @param env Environment pointer (currently unused)
@@ -212,16 +232,18 @@ void fw_collect_tore(type_or_ent *tore, void *env)
   switch (get_kind(tore)) {
   case k_entity:
     ent = (entity *)tore;
-    // append entity to list
+    /*  append entity to list */
     set_entity_link(ent, NULL);
-    ARR_APP1(entity *, entity_list, ent);
+    if (!pmap_contains(entity_map, ent))
+      pmap_insert(entity_map, ent, env);
     break;
   case k_type:
     tp = (type *)tore;
     mode = get_type_mode(tp);
-    // append type to list
+    /*  append type to list */
     set_type_link(tp, NULL);
-    ARR_APP1(type *, type_list, tp);
+    if (!pmap_contains(type_map, tp))
+      pmap_insert(type_map, tp, env);
 
     /* insert only modes (non atomic types, i.e. class, array or struct
        have no mode. The link field will be cleared in the walk_do_mode()
@@ -235,15 +257,23 @@ void fw_collect_tore(type_or_ent *tore, void *env)
 
 /** Collect all data from nodes. Block appends itself to
  *  the corresponding ir graph and other nodes appends itself
- *  to block list.
+ *  to block list. Collects also the modes of each node to get
+ *  non-type modes.
  *
  *  @param irn IR node pointer.
-f *  @param env Environment pointer (currently unused)
+ *  @param env Environment pointer (currently unused)
  */
 static
 void fw_collect_irn(ir_node *irn, void *env)
 {
   fw_data *data;
+  ir_mode *mode = get_irn_mode(irn);
+
+  /* The link field will be cleared in the walk_do_mode()
+    callback function. */
+  if ((NULL != mode) && (!pmap_contains(mode_map, mode)))
+    pmap_insert(mode_map, mode, env);
+
   /* block nodes. */
   if (is_Block(irn))
   {
@@ -255,7 +285,7 @@ void fw_collect_irn(ir_node *irn, void *env)
   else
   {
     /* add this node to block's node list */
-    ir_node *block = get_nodes_Block(irn);
+    ir_node *block = get_nodes_block(irn);
     data = fw_get_data(block);
     ARR_APP1(ir_node *, FW_GET_DATA_LIST(data), irn);
   }
@@ -292,34 +322,39 @@ void firm_walk_init(firm_walk_flags flags)
   }
   mode_map = pmap_create();
 
-  if (type_list)
+  if (type_map)
   {
-    DEL_ARR_F(type_list);
+    pmap_destroy(type_map);
   }
-  type_list = NEW_ARR_F(type *, 0);
+  type_map = pmap_create();
 
-  if (entity_list)
+  if (entity_map)
   {
-    DEL_ARR_F(entity_list);
+    pmap_destroy(entity_map);
   }
-  entity_list = NEW_ARR_F(entity *, 0);
+  entity_map = pmap_create();
 
   /* insert internal modes to mode hash. The link field will be cleared
      in the walk_do_mode() callback function.
      Other used modes are added by collecting types */
-  pmap_insert(mode_map, mode_BB, NULL);
-  pmap_insert(mode_map, mode_T, NULL);
-  pmap_insert(mode_map, mode_ANY, NULL);
-  pmap_insert(mode_map, mode_BAD, NULL);
-  pmap_insert(mode_map, mode_X, NULL);
-  pmap_insert(mode_map, mode_M, NULL);
-  pmap_insert(mode_map, mode_b, NULL);
-
-  // Collect all types (also unused types) if flag is set
+
+  /*
+     ### RG: should be done by inspection the mode of all irn
+
+     pmap_insert(mode_map, mode_BB, NULL);
+     pmap_insert(mode_map, mode_T, NULL);
+     pmap_insert(mode_map, mode_ANY, NULL);
+     pmap_insert(mode_map, mode_BAD, NULL);
+     pmap_insert(mode_map, mode_X, NULL);
+     pmap_insert(mode_map, mode_M, NULL);
+     pmap_insert(mode_map, mode_b, NULL);
+  */
+
+  /*  Collect all types (also unused types) if flag is set */
   if (FW_WITH_ALL_TYPES & flags)
     type_walk(fw_collect_tore, NULL, NULL);
 
-  // for each ir graph
+  /*  for each ir graph */
   for (i = 0; i < get_irp_n_irgs(); i++)
   {
     ir_graph *irg = get_irp_irg(i);
@@ -340,12 +375,12 @@ void firm_walk_finalize(void)
   /* free all used maps and lists */
   pmap_destroy(mode_map);
   mode_map = NULL;
-  DEL_ARR_F(type_list);
-  type_list = NULL;
-  DEL_ARR_F(entity_list);
-  entity_list = NULL;
+  pmap_destroy(type_map);
+  type_map = NULL;
+  pmap_destroy(entity_map);
+  entity_map = NULL;
 
-  // free all collected data from ir graphs and nodes
+  /*  free all collected data from ir graphs and nodes */
   for (i = 0; i < get_irp_n_irgs(); i++)
   {
     ir_graph *irg = get_irp_irg(i);
@@ -372,8 +407,8 @@ void firm_walk(firm_walk_interface *wif)
   int irg_i, block_i, block_list_len, irn_i, irn_list_len;
   pmap_entry *entry;
   fw_data *data;
-  ir_graph *irg;
   ir_node *block, **block_list, **irn_list;
+  ir_graph *saved_irg = current_ir_graph;
 
   assert(wif && "firm_walk() in firmwalk.c: No walking interface defined!");
 
@@ -393,9 +428,8 @@ void firm_walk(firm_walk_interface *wif)
   if (wif->do_type_init) wif->do_type_init(wif->env);
   if (wif->do_type)
   {
-    int type_i, type_list_len = ARR_LEN(type_list);
-    for (type_i = 0; type_i < type_list_len; type_i++)
-      wif->do_type(type_list[type_i], wif->env);
+    for (entry = pmap_first(type_map); entry; entry = pmap_next(type_map))
+      wif->do_type((type *)entry->key, wif->env);
   }
   if (wif->do_type_finalize) wif->do_type_finalize(wif->env);
 
@@ -403,9 +437,8 @@ void firm_walk(firm_walk_interface *wif)
   if (wif->do_entity_init) wif->do_entity_init(wif->env);
   if (wif->do_entity)
   {
-    int entity_i, entity_list_len = ARR_LEN(entity_list);
-    for (entity_i = 0; entity_i < entity_list_len; entity_i++)
-      wif->do_entity(entity_list[entity_i], wif->env);
+    for (entry = pmap_first(entity_map); entry; entry = pmap_next(entity_map))
+      wif->do_entity((entity *)entry->key, wif->env);
   }
   if (wif->do_entity_finalize) wif->do_entity_finalize(wif->env);
 
@@ -415,18 +448,18 @@ void firm_walk(firm_walk_interface *wif)
 
   for (irg_i = 0; irg_i < get_irp_n_irgs(); irg_i++)
   {
-    irg = get_irp_irg(irg_i);
+    current_ir_graph = get_irp_irg(irg_i);
 
     /* walk over all ir graph */
-    if (wif->do_graph) wif->do_graph(irg, wif->env);
+    if (wif->do_graph) wif->do_graph(current_ir_graph, wif->env);
 
     /* walk over all irg's block nested ========================== */
-    data = fw_get_data(irg);
+    data = fw_get_data(current_ir_graph);
     block_list = FW_GET_DATA_LIST(data);
     block_list_len = ARR_LEN(block_list);
     for (block_i = 0; block_i < block_list_len; block_i++)
     {
-      if (wif->do_block_init) wif->do_block_init(irg, wif->env);
+      if (wif->do_block_init) wif->do_block_init(current_ir_graph, wif->env);
 
       block = (ir_node *)block_list[block_i];
       if (wif->do_block) wif->do_block(block, wif->env);
@@ -436,12 +469,12 @@ void firm_walk(firm_walk_interface *wif)
       irn_list = FW_GET_DATA_LIST(data);
       irn_list_len = ARR_LEN(irn_list);
 
-      // call block as prefix ir node
+      /*  call block as prefix ir node */
       if ((wif->do_node) &&
-          (wif->flags & FW_DUMP_BLOCK_AS_IRN & !FW_DUMP_IRN_IN_PREFIX))
+          (wif->flags & (FW_DUMP_BLOCK_AS_IRN | FW_DUMP_IRN_IN_PREFIX)))
         wif->do_node(block, wif->env);
 
-      // do ir nodes in prefix or postfix order?
+      /*  do ir nodes in prefix or postfix order? */
       if (wif->flags & FW_DUMP_IRN_IN_PREFIX)
         irn_i = irn_list_len-1;
       else
@@ -451,26 +484,39 @@ void firm_walk(firm_walk_interface *wif)
       {
         if (wif->do_node) wif->do_node((ir_node *)irn_list[irn_i], wif->env);
 
-        // do ir nodes in prefix or postfix order?
+        /*  do ir nodes in prefix or postfix order? */
         if (wif->flags & FW_DUMP_IRN_IN_PREFIX)
           irn_i--;
         else
           irn_i++;
       }
-      // call block as postfix ir node
+      /*  call block as postfix ir node */
       if ((wif->do_node) &&
-          (wif->flags & (FW_DUMP_BLOCK_AS_IRN | FW_DUMP_IRN_IN_PREFIX)))
+          ((wif->flags & (FW_DUMP_BLOCK_AS_IRN | FW_DUMP_IRN_IN_PREFIX))
+          == FW_DUMP_BLOCK_AS_IRN))
         wif->do_node(block, wif->env);
 
       /* wall over all block's ir nodes nested end =============== */
 
-      if (wif->do_block_finalize) wif->do_block_finalize(irg, wif->env);
-    } // for each block
+      if(wif->do_block_post)
+       wif->do_block_post(block, wif->env);
+
+    } /*  for each block */
+
+    if (wif->do_block_finalize)
+      wif->do_block_finalize(current_ir_graph, wif->env);
 
     /* walk over all irg's block nested end ====================== */
+    if(wif->do_graph_post)
+      wif->do_graph_post(current_ir_graph, wif->env);
+
+  } /*  for each ir graph irg */
+
+  if(wif->do_graph_finalize)
+    wif->do_graph_finalize(wif->env);
 
-  } // for each ir graph irg
-  if (wif->do_graph_finalize) wif->do_graph_finalize(wif->env);
+  /** ### ToDo: Dump const_code_irg ?? No! Dump const code with entities, types etc. */
 
-  /** ### ToDo: Dump const_code_irg ?? */
+  /* restore the state of current_ir_graph */
+  current_ir_graph = saved_irg;
 }