verify: Clarify assertion message.
[libfirm] / ir / ir / iredges_t.h
index ced4650..f5b4d3a 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
+ * Copyright (C) 1995-2011 University of Karlsruhe.  All right reserved.
  *
  * This file is part of libFirm.
  *
@@ -22,7 +22,6 @@
  * @brief   Everlasting outs -- private header.
  * @author  Sebastian Hack, Andreas Schoesser
  * @date    15.01.2005
- * @version $Id$
  */
 #ifndef FIRM_IR_EDGES_T_H
 #define FIRM_IR_EDGES_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. */
-  unsigned kind    : 4;   /**< The kind of the edge. */
-  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. */
-  long edge_nr;           /**< A unique number identifying the edge. */
+       unsigned present : 1;   /**< Used by the verifier. Don't rely on its content. */
 #endif
+       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, kind) (&(((irn)->edge_info)[kind]))
+static inline irn_edge_info_t *get_irn_edge_info(ir_node *node,
+                                                 ir_edge_kind_t kind)
+{
+       return &node->edge_info[kind];
+}
+
+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];
+}
 
 /** Accessor for private irg info. */
-#define _get_irg_edge_info(irg, kind) (&(((irg)->edge_info)[kind]))
+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 outs_head from a irn_edge_info_t
-* struct.
-*/
-#define _get_irn_outs_head(irn, kind) (&_get_irn_edge_info(irn, kind)->outs_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.
-* @note There is no order on out edges. First in this context only
-* means, that you get some starting point into the list of edges.
-* @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_kind(const ir_node *irn, ir_edge_kind_t kind)
+ * Get the first edge pointing to some node.
+ * @note There is no order on out edges. First in this context only
+ * means, that you get some starting point into the list of edges.
+ * @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_kind_(const ir_node *irn, ir_edge_kind_t kind)
 {
-       const struct list_head *head = _get_irn_outs_head(irn, kind);
+       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);
 }
 
 /**
-* Get the next edge in the out list of some node.
-* @param irn The node.
-* @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)
+ * Get the next edge in the out list of some node.
+ * @param irn The node.
+ * @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, ir_edge_kind_t kind)
 {
        struct list_head *next = last->list.next;
-       return next == _get_irn_outs_head(irn, last->kind) ? NULL : list_entry(next, ir_edge_t, list);
+       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 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_kind(const ir_node *irn, int kind)
+ * 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_kind_(const ir_node *irn, ir_edge_kind_t kind)
 {
-       /* Perhaps out_count was buggy. This code does it more safely. */
-#if 0
-       int res = 0;
-       const struct list_head *pos, *head = _get_irn_outs_head(irn, kind);
-       list_for_each(pos, head)
-               res++;
-       return res;
-#else
-       return _get_irn_edge_info(irn, kind)->out_count;
-#endif
+       return get_irn_edge_info_const(irn, kind)->out_count;
 }
 
-static inline int _edges_activated_kind(const ir_graph *irg, ir_edge_kind_t kind)
+static inline int edges_activated_kind_(const ir_graph *irg, ir_edge_kind_t kind)
 {
-       return _get_irg_edge_info(irg, kind)->activated;
+       return get_irg_edge_info_const(irg, kind)->activated;
+}
+
+static inline int edges_activated_(const ir_graph *irg)
+{
+       return edges_activated_kind(irg, EDGE_KIND_NORMAL)
+           && edges_activated_kind(irg, EDGE_KIND_BLOCK);
 }
 
 /**
-* Assure, that the edges information is present for a certain graph.
-* @param irg The graph.
-*/
-static inline void _edges_assure_kind(ir_graph *irg, int kind)
+ * Assure, that the edges information is present for a certain graph.
+ * @param irg The graph.
+ */
+static inline void edges_assure_kind_(ir_graph *irg, ir_edge_kind_t kind)
 {
-       if(!_edges_activated_kind(irg, kind))
+       if(!edges_activated_kind_(irg, kind))
                edges_activate_kind(irg, kind);
 }
 
 void edges_init_graph_kind(ir_graph *irg, ir_edge_kind_t kind);
 
-/**
-* Notify of a edge change.
-* The edge from (src, pos) -> old_tgt is redirected to tgt
-*/
-void edges_notify_edge_kind(ir_node *src, int pos, ir_node *tgt, ir_node *old_tgt, ir_edge_kind_t kind, ir_graph *irg);
+void edges_node_deleted(ir_node *irn);
 
 /**
-* A node is deleted.
-*/
-void edges_node_deleted(ir_node *old, ir_graph *irg);
-
-void edges_invalidate_kind(ir_node *irn, ir_edge_kind_t kind, 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);
+ * A node might be revivaled by CSE.
+ */
+void edges_node_revival(ir_node *node);
 
-/**
-* 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)
-{
-       return (void *) ((char *) edge + sizeof(edge[0]) + ofs);
-}
+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)
+static inline ir_node *get_edge_src_irn_(const ir_edge_t *edge)
 {
        return edge->src;
 }
 
-static inline int _get_edge_src_pos(const ir_edge_t *edge)
+static inline int get_edge_src_pos_(const ir_edge_t *edge)
 {
        return edge->pos;
 }
 
 /**
-* Initialize the out edges.
-* This must be called before firm is initialized.
-*/
+ * Initialize the out edges.
+ * This must be called before firm is initialized.
+ */
 extern void init_edges(void);
 
+void edges_invalidate_all(ir_node *irn);
+
 /**
- * Set dbg information for edges.
+ * Helper function to dump the edge set of a graph,
+ * unused in normal code.
  */
-void edges_init_dbg(int do_dbg);
+void edges_dump_kind(ir_graph *irg, ir_edge_kind_t kind);
 
-void edges_invalidate_all(ir_node *irn, ir_graph *irg);
-
-#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_edge_private_data(edge, ofs)  _get_edge_private_data(edge,ofs)
-#define get_irn_out_edge_next(irn, last)  _get_irn_out_edge_next(irn, last)
-
-#ifndef get_irn_n_edges
-#define get_irn_n_edges(irn)              _get_irn_n_edges_kind(irn, EDGE_KIND_NORMAL)
-#endif
-
-#ifndef get_irn_out_edge_first
-#define get_irn_out_edge_first(irn)       _get_irn_out_edge_first_kind(irn, EDGE_KIND_NORMAL)
-#endif
-
-#ifndef get_block_succ_first
-#define get_block_succ_first(irn)         _get_irn_out_edge_first_kind(irn, EDGE_KIND_BLOCK)
-#endif
-
-#ifndef get_block_succ_next
-#define get_block_succ_next(irn, last)    _get_irn_out_edge_next(irn, last)
-#endif
+void edges_notify_edge(ir_node *src, int pos, ir_node *tgt, ir_node *old_tgt,
+                       ir_graph *irg);
 
 #endif