remove Bound node
[libfirm] / ir / ir / iredges_t.h
index 8a30b12..6820ce6 100644 (file)
@@ -1,24 +1,31 @@
 /*
- * Project:     libFIRM
- * File name:   ir/ir/iredges_t.h
- * Purpose:     Everlasting outs -- private header.
- * Author:      Sebastian Hack
- * Created:     15.01.2005
- * CVS-ID:      $Id$
- * Copyright:   (c) 1998-2005 Universit�t Karlsruhe
- * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
- */
-
-/**
- * everlasting outs.
- * @author Sebastian Hack
- * @date 15.1.2005
- */
+ * Copyright (C) 1995-2011 University of Karlsruhe.  All right reserved.
+ *
+ * This file is part of libFirm.
+ *
+ * This file may be distributed and/or modified under the terms of the
+ * GNU General Public License version 2 as published by the Free Software
+ * Foundation and appearing in the file LICENSE.GPL included in the
+ * packaging of this file.
+ *
+ * Licensees holding valid libFirm Professional Edition licenses may use
+ * this file in accordance with the libFirm Commercial License.
+ * Agreement provided with the Software.
+ *
+ * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
+ * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE.
+ */
+
+/**
+ * @file
+ * @brief   Everlasting outs -- private header.
+ * @author  Sebastian Hack, Andreas Schoesser
+ * @date    15.01.2005
+ */
+#ifndef FIRM_IR_EDGES_T_H
+#define FIRM_IR_EDGES_T_H
 
-#ifndef _FIRM_EDGES_T_H
-#define _FIRM_EDGES_T_H
-
-#include "firm_config.h"
 #include "debug.h"
 
 #include "set.h"
 #include "irnode_t.h"
 #include "irgraph_t.h"
 
+#include "iredgekinds.h"
 #include "iredges.h"
 
-#define DBG_EDGES  "firm.ir.edges"
+#define get_irn_n_edges_kind(irn, kind)   get_irn_n_edges_kind_(irn, kind)
+#define get_edge_src_irn(edge)            get_edge_src_irn_(edge)
+#define get_edge_src_pos(edge)            get_edge_src_pos_(edge)
+#define get_irn_out_edge_next(irn, last, kind)  get_irn_out_edge_next_(irn, last, kind)
+#define get_irn_n_edges(irn)              get_irn_n_edges_kind_(irn, EDGE_KIND_NORMAL)
+#define get_irn_out_edge_first(irn)       get_irn_out_edge_first_kind_(irn, EDGE_KIND_NORMAL)
+#define get_block_succ_first(irn)         get_irn_out_edge_first_kind_(irn, EDGE_KIND_BLOCK)
+#define get_block_succ_next(irn, last)    get_irn_out_edge_next_(irn, last, EDGE_KIND_BLOCK)
 
 /**
  * An edge.
  */
-struct _ir_edge_t {
-  ir_node *src;           /**< The source node of the edge. */
-  int pos;                /**< The position of the edge at @p src. */
-  unsigned invalid : 1;   /**< edges that are removed are marked invalid. */
-  unsigned present : 1;   /**< Used by the verifier. Don't rely on its content. */
-  struct list_head list;  /**< The list head to queue all out edges at a node. */
+struct ir_edge_t {
+       ir_node  *src;          /**< The source node of the edge. */
+       int      pos;           /**< The position of the edge at @p src. */
 #ifdef DEBUG_libfirm
-  long src_nr;            /**< The node number of the source node. */
+       unsigned present : 1;   /**< Used by the verifier. Don't rely on its content. */
 #endif
-};
-
-/**
- * A block edge inherits from a normal edge.
- * They represent edges leading from a block to a control flow node
- * and are used to quickly find all control flow successors of
- * a block.
- */
-struct _ir_block_edge_t {
-  struct _ir_edge_t edge;      /**< The inherited data. */
-  struct list_head succ_list;  /**< List element listing all
-                                 control flow edges to the
-                                 successors of a block. */
+       struct list_head list;  /**< The list head to queue all out edges at a node. */
 };
 
 /** Accessor for private irn info. */
-#define _get_irn_edge_info(irn) (&(irn)->edge_info)
+static inline irn_edge_info_t *get_irn_edge_info(ir_node *node,
+                                                 ir_edge_kind_t kind)
+{
+       return &node->edge_info[kind];
+}
 
-/** Accessor for private irg info. */
-#define _get_irg_edge_info(irg) (&(irg)->edge_info)
+static inline const irn_edge_info_t *get_irn_edge_info_const(
+               const ir_node *node, ir_edge_kind_t kind)
+{
+       return &node->edge_info[kind];
+}
 
-/**
- * Convenience macro to get the outs_head from a irn_edge_info_t
- * struct.
- */
-#define _get_irn_outs_head(irn) (&_get_irn_edge_info(irn)->outs_head)
+/** Accessor for private irg info. */
+static inline irg_edge_info_t *get_irg_edge_info(ir_graph *irg,
+                                                 ir_edge_kind_t kind)
+{
+       return &irg->edge_info[kind];
+}
 
-/**
- * Convenience macro to get the succ_head from a block_attr
- * struct.
- */
-#define _get_block_succ_head(bl) (&((bl)->attr.block.succ_head))
+/** Accessor for private irg info. */
+static inline const irg_edge_info_t *get_irg_edge_info_const(
+               const ir_graph *irg, ir_edge_kind_t kind)
+{
+       return &irg->edge_info[kind];
+}
 
 /**
  * Get the first edge pointing to some node.
@@ -83,10 +92,12 @@ struct _ir_block_edge_t {
  * @param irn The node.
  * @return The first out edge that points to this node.
  */
-static INLINE const ir_edge_t *_get_irn_out_edge_first(const ir_node *irn)
+static inline const ir_edge_t *get_irn_out_edge_first_kind_(const ir_node *irn, ir_edge_kind_t kind)
 {
-  const struct list_head *head = _get_irn_outs_head(irn);
-  return list_empty(head) ? NULL : list_entry(head->next, ir_edge_t, list);
+       const struct list_head *head;
+       assert(edges_activated_kind(get_irn_irg(irn), kind));
+       head = &get_irn_edge_info_const(irn, kind)->outs_head;
+       return list_empty(head) ? NULL : list_entry(head->next, ir_edge_t, list);
 }
 
 /**
@@ -95,160 +106,92 @@ static INLINE const ir_edge_t *_get_irn_out_edge_first(const ir_node *irn)
  * @param last The last out edge you have seen.
  * @return The next out edge in @p irn 's out list after @p last.
  */
-static INLINE const ir_edge_t *_get_irn_out_edge_next(const ir_node *irn, const ir_edge_t *last)
+static inline const ir_edge_t *get_irn_out_edge_next_(const ir_node *irn, const ir_edge_t *last, ir_edge_kind_t kind)
 {
-  struct list_head *next = last->list.next;
-  return next == _get_irn_outs_head(irn) ? NULL : list_entry(next, ir_edge_t, list);
+       struct list_head *next = last->list.next;
+       const struct list_head *head
+               = &get_irn_edge_info_const(irn, kind)->outs_head;
+       return next == head ? NULL : list_entry(next, ir_edge_t, list);
 }
 
 /**
- * Get the first successor edge of a block.
- * A successor edge is an edge originated from another block, pointing
- * to a mode_X node in the given block and is thus a control flow
- * successor edge.
- * @param irn The block.
- * @return The first successor edge of the block.
+ * Get the number of edges pointing to a node.
+ * @param irn The node.
+ * @return The number of edges pointing to this node.
  */
-static INLINE const ir_edge_t *_get_block_succ_first(const ir_node *irn)
+static inline int get_irn_n_edges_kind_(const ir_node *irn, ir_edge_kind_t kind)
 {
-  const struct list_head *head;
-
-  assert(is_Block(irn) && "Node must be a block here");
-  head = _get_block_succ_head(irn);
-  return (ir_edge_t *) (list_empty(head) ? NULL :
-      list_entry(head->next, ir_block_edge_t, succ_list));
+       return get_irn_edge_info_const(irn, kind)->out_count;
 }
 
-/**
- * Get the next block successor edge.
- * @see See _get_block_succ_first() for details.
- * @param irn The block.
- * @param last The last edge.
- * @return The next edge, or NULL if there is no further.
- */
-static INLINE const ir_edge_t *_get_block_succ_next(const ir_node *irn, const ir_edge_t *last)
+static inline int edges_activated_kind_(const ir_graph *irg, ir_edge_kind_t kind)
 {
-  const ir_block_edge_t *block_edge;
-  struct list_head *next;
-
-  assert(is_Block(irn) && "Node must be a block here");
-  block_edge = (const ir_block_edge_t *) last;
-  next = block_edge->succ_list.next;
-  return (ir_edge_t *) (next == _get_block_succ_head(irn) ? NULL :
-      list_entry(next, ir_block_edge_t, succ_list));
+       return get_irg_edge_info_const(irg, kind)->activated;
 }
 
-/**
- * Get the source node of an edge.
- * @param edge The edge.
- * @return The source node of that edge.
- */
-static INLINE  ir_node *_get_edge_src_irn(const ir_edge_t *edge)
+static inline int edges_activated_(const ir_graph *irg)
 {
-  return edge ? edge->src : NULL;
+       return edges_activated_kind(irg, EDGE_KIND_NORMAL)
+           && edges_activated_kind(irg, EDGE_KIND_BLOCK);
 }
 
 /**
- * Get the position of an edge.
- * @param edge  The edge.
- * @return The position in the in array of that edges source.
+ * Assure, that the edges information is present for a certain graph.
+ * @param irg The graph.
  */
-static INLINE int _get_edge_src_pos(const ir_edge_t *edge)
+static inline void edges_assure_kind_(ir_graph *irg, ir_edge_kind_t kind)
 {
-  return edge ? edge->pos : -1;
+       if(!edges_activated_kind_(irg, kind))
+               edges_activate_kind(irg, kind);
 }
 
+void edges_init_graph_kind(ir_graph *irg, ir_edge_kind_t kind);
+
+void edges_node_deleted(ir_node *irn);
+
 /**
- * Get the number of edges pointing to a node.
- * @param irn The node.
- * @return The number of edges pointing to this node.
+ * A node might be revivaled by CSE.
  */
-static INLINE int _get_irn_n_edges(const ir_node *irn)
-{
-/* Perhaps out_count was buggy. This code does it more safely. */
-#if 1
-       int res = 0;
-       const struct list_head *pos, *head = _get_irn_outs_head(irn);
-       list_for_each(pos, head)
-               res++;
-       return res;
-#else
-       return _get_irn_edge_info(irn)->out_count;
-#endif
-}
+void edges_node_revival(ir_node *node);
 
-static INLINE int _edges_activated(const ir_graph *irg)
+void edges_invalidate_kind(ir_node *irn, ir_edge_kind_t kind);
+
+static inline ir_node *get_edge_src_irn_(const ir_edge_t *edge)
 {
-  return _get_irg_edge_info(irg)->activated;
+       return edge->src;
 }
 
-/**
- * Assure, that the edges information is present for a certain graph.
- * @param irg The graph.
- */
-static INLINE void _edges_assure(ir_graph *irg)
+static inline int get_edge_src_pos_(const ir_edge_t *edge)
 {
-       if(!_edges_activated(irg))
-               edges_activate(irg);
+       return edge->pos;
 }
 
-void edges_reroute(ir_node *old, ir_node *nw, ir_graph *irg);
-
-void edges_init_graph(ir_graph *irg);
-
 /**
- * Notify of a edge change.
- * The edge from (src, pos) -> old_tgt is redirected to tgt
+ * Returns the edge object of an outgoing edge at a node.
+ * @param  irn  The node at which the edge originates.
+ * @param  pos  The position of the edge.
+ * @param  kind The kind of the edge.
+ * @return      The corresponding edge object or NULL,
+ *              if no such edge exists.
  */
-void edges_notify_edge(ir_node *src, int pos, ir_node *tgt, ir_node *old_tgt, ir_graph *irg);
+FIRM_API const ir_edge_t *get_irn_edge_kind(const ir_node *irn,
+                                            int pos, ir_edge_kind_t kind);
 
 /**
- * A node is deleted.
+ * Initialize the out edges.
+ * This must be called before firm is initialized.
  */
-void edges_node_deleted(ir_node *old, ir_graph *irg);
-
-void edges_invalidate(ir_node *irn, ir_graph *irg);
+extern void init_edges(void);
 
-/**
- * Register additional memory in an edge.
- * This must be called before Firm is initialized.
- * @param  n Number of bytes you need.
- * @return A number you have to keep and to pass
- *         edges_get_private_data()
- *         to get a pointer to your data.
- */
-int edges_register_private_data(size_t n);
+void edges_invalidate_all(ir_node *irn);
 
 /**
- * Get a pointer to the private data you registered.
- * @param  edge The edge.
- * @param  ofs  The number, you obtained with
- *              edges_register_private_data().
- * @return A pointer to the private data.
+ * Helper function to dump the edge set of a graph,
+ * unused in normal code.
  */
-static INLINE void *_get_edge_private_data(const ir_edge_t *edge, int ofs)
-{
-       /* Get the size of the edge. */
-       size_t size =
-               is_Block(edge->src) ? sizeof(ir_block_edge_t) : sizeof(ir_edge_t);
+void edges_dump_kind(ir_graph *irg, ir_edge_kind_t kind);
 
-       return (void *) ((char *) edge + size + ofs);
-}
-
-/**
- * Initialize the out edges.
- * This must be called before firm is initialized.
- */
-extern void init_edges(void);
+void edges_notify_edge(ir_node *src, int pos, ir_node *tgt, ir_node *old_tgt,
+                       ir_graph *irg);
 
-#define get_irn_out_edge_first(irn)      _get_irn_out_edge_first(irn)
-#define get_irn_out_edge_next(irn,last)  _get_irn_out_edge_next(irn, last)
-#define get_block_succ_first(irn)        _get_block_succ_first(irn)
-#define get_block_succ_next(irn,last)    _get_block_succ_next(irn, last)
-#define get_edge_src_irn(edge)           _get_edge_src_irn(edge)
-#define get_edge_src_pos(edge)           _get_edge_src_pos(edge)
-#define get_edge_private_data(edge,ofs)  _get_edge_private_data(edge,ofs)
-#define edges_activated(irg)             _edges_activated(irg)
-#define edges_assure(irg)                _edges_assure(irg)
-
-#endif /* _FIRM_EDGES_T_H */
+#endif