use xmalloc instead of malloc
[libfirm] / ir / ir / iredges_t.h
index ccac2e1..28e9968 100644 (file)
@@ -1,3 +1,13 @@
+/*
+ * 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.
@@ -8,7 +18,7 @@
 #ifndef _FIRM_EDGES_T_H
 #define _FIRM_EDGES_T_H
 
-#include "config.h"
+#include "firm_config.h"
 #include "debug.h"
 
 #include "set.h"
 
 #include "iredges.h"
 
-#define DBG_EDGES                              "edges"
+#define DBG_EDGES  "firm.ir.edges"
 
 /**
  * An edge.
  */
-typedef struct _ir_edge_t {
+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. */
 #ifdef DEBUG_libfirm
-       long src_nr;                                            /**< The node number of the source node. */
+  long src_nr;            /**< The node number of the source node. */
 #endif
-        ir_node *src;          /**< The source node of the edge. */
-       int pos;                                                                /**< The position of the edge at @p src. */
-       struct list_head list;  /**< The list head to queue all out edges at a node. */
-       unsigned invalid : 1;           /**< edges that are removed are marked invalid. */
-       unsigned present : 1;           /**< Used by the verifier. Don't rely on its content. */
-} ir_edge_t;
+};
+
+/**
+ * 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. */
+};
 
 /** Accessor for private irn info. */
-#define _get_irn_edge_info(irn) ((irn_edge_info_t *) &(irn)->edge_info)
+#define _get_irn_edge_info(irn) (&(irn)->edge_info)
 
 /** Accessor for private irg info. */
-#define _get_irg_edge_info(irg) ((irg_edge_info_t *) &(irg)->edge_info)
+#define _get_irg_edge_info(irg) (&(irg)->edge_info)
 
 /**
  * Convenience macro to get the outs_head from a irn_edge_info_t
@@ -47,6 +70,12 @@ typedef struct _ir_edge_t {
  */
 #define _get_irn_outs_head(irn) (&_get_irn_edge_info(irn)->outs_head)
 
+/**
+ * Convenience macro to get the succ_head from a block_attr
+ * struct.
+ */
+#define _get_block_succ_head(bl) (&((bl)->attr.block.succ_head))
+
 /**
  * Get the first edge pointing to some node.
  * @note There is no order on out edges. First in this context only
@@ -56,8 +85,8 @@ typedef struct _ir_edge_t {
  */
 static INLINE const ir_edge_t *_get_irn_out_edge_first(const ir_node *irn)
 {
-       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 = _get_irn_outs_head(irn);
+  return list_empty(head) ? NULL : list_entry(head->next, ir_edge_t, list);
 }
 
 /**
@@ -68,18 +97,46 @@ 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_next(const ir_node *irn, const ir_edge_t *last)
 {
-       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;
+  return next == _get_irn_outs_head(irn) ? NULL : list_entry(next, ir_edge_t, list);
 }
 
 /**
- * A convenience iteration macro over all out edges of a node.
- * @param irn The node.
- * @param edge An @c ir_edge_t pointer which shall be set to the current
- * edge.
+ * 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.
  */
-#define foreach_out_edge(irn,edge) \
-       for(edge = get_irn_out_edge_first(irn); edge; edge = get_irn_out_edge_next(irn, edge))
+static INLINE const ir_edge_t *_get_block_succ_first(const ir_node *irn)
+{
+  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));
+}
+
+/**
+ * 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)
+{
+  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));
+}
 
 /**
  * Get the source node of an edge.
@@ -88,7 +145,7 @@ static INLINE const ir_edge_t *_get_irn_out_edge_next(const ir_node *irn, const
  */
 static INLINE  ir_node *_get_edge_src_irn(const ir_edge_t *edge)
 {
-       return edge ? edge->src : NULL;
+  return edge ? edge->src : NULL;
 }
 
 /**
@@ -98,34 +155,100 @@ static INLINE  ir_node *_get_edge_src_irn(const ir_edge_t *edge)
  */
 static INLINE int _get_edge_src_pos(const ir_edge_t *edge)
 {
-       return edge ? edge->pos : -1;
+  return edge ? edge->pos : -1;
+}
+
+/**
+ * Get the number of edges pointing to a node.
+ * @param irn The node.
+ * @return The number of edges pointing to this node.
+ */
+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
 }
 
 static INLINE int _edges_activated(const ir_graph *irg)
 {
-       return _get_irg_edge_info(irg)->activated;
+  return _get_irg_edge_info(irg)->activated;
+}
+
+/**
+ * Assure, that the edges information is present for a certain graph.
+ * @param irg The graph.
+ */
+static INLINE void _edges_assure(ir_graph *irg)
+{
+       if(!_edges_activated(irg))
+               edges_activate(irg);
 }
 
 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
+ */
 void edges_notify_edge(ir_node *src, int pos, ir_node *tgt, ir_node *old_tgt, ir_graph *irg);
 
+/**
+ * A node is deleted.
+ */
 void edges_node_deleted(ir_node *old, ir_graph *irg);
 
 void edges_invalidate(ir_node *irn, ir_graph *irg);
 
+/**
+ * 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);
+
+/**
+ * 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.
+ */
+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);
+
+       return (void *) ((char *) edge + size + ofs);
+}
+
 /**
  * Initialize the out edges.
  * This must be called before firm is initialized.
  */
 extern void init_edges(void);
 
-#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_edge_src_irn(edge)                                                 _get_edge_src_irn(edge)
-#define get_edge_src_pos(edge)                                                 _get_edge_src_pos(edge)
-#define edges_activated(irg)                                                           _edges_activated(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 */