added missing source
[libfirm] / ir / be / beirgmod.h
index 6d5240c..07799d9 100644 (file)
@@ -1,22 +1,88 @@
-
 /**
- * IRG modifications for be routines.
- * @date 4.5.2005
+ * @file
+ * @brief
+ * This file contains the following IRG modifications for be routines:
+ * - SSA construction for a set of nodes
+ * - insertion of Perm nodes
+ * - empty block elimination
+ * - a simple dead node elimination (set inputs of unreachable nodes to BAD)
  *
- * Copyright (C) 2005 Universitaet Karlsruhe.
- * Released under the GPL.
+ * @author      Sebastian Hack, Daniel Grund, Matthias Braun, Christian Wuerdig
+ * @date        04.05.2005
+ * @version     $Id$
+ * Copyright:   (c) Universitaet Karlsruhe
+ * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
  */
+#ifndef _FIRM_BE_IRGMOD_H_
+#define _FIRM_BE_IRGMOD_H_
+
+#include "firm_types.h"
+#include "pset.h"
+#include "irnodeset.h"
 
-#ifndef _BEIRGMOD_H
-#define _BEIRGMOD_H
+#include "bedomfront.h"
+#include "belive.h"
 
-typedef struct _dom_front_info_t dom_front_info_t;
+/**
+ * Introduce several copies for one node.
+ *
+ * A copy in this context means, that you want to introduce several new
+ * abstract values (in Firm: nodes) for which you know, that they
+ * represent the same concrete value. This is the case if you
+ * - copy
+ * - spill and reload
+ * - re-materialize
+ * a value.
+ *
+ * This function reroutes all uses of the original value to the copies in the
+ * corresponding dominance subtrees and creates Phi functions where necessary.
+ *
+ * @note The visited flag and link fields are used.
+ *
+ * @param info           Dominance frontier information.
+ * @param lv          Liveness information to be updated. If NULL, no liveness
+ *                    updating is performed.
+ * @param value       The value that has been duplicated.
+ * @param copies_len  the length of the copies array
+ * @param copie       an array holding all copies of the value
+ * @param phis        An ARR_F where all newly created phis will be inserted,
+ *                    may be NULL
+ * @param ignore_uses A set of nodes probably using one of the nodes in
+ *                    @p nodes. Their usage will not adjusted. They remain
+ *                    untouched by this function. May be NULL.
+ */
+ir_node **be_ssa_construction(const be_dom_front_info_t *info, be_lv_t *lv,
+                            ir_node *value, int copies_len, ir_node **copies,
+                            const ir_nodeset_t *ignore_uses, int need_new_phis);
 
-dom_front_info_t *be_compute_dominance_frontiers(ir_graph *irg);
-pset *be_get_dominance_frontier(dom_front_info_t *info, ir_node *block);
-void be_free_dominance_frontiers(dom_front_info_t *info);
+/** @deprecated */
+void be_ssa_constr_set_ignore(const be_dom_front_info_t *info, be_lv_t *lv,
+                              pset *nodes, pset *ignores);
 
-void be_introduce_copies(dom_front_info_t *info, ir_node *orig,
-    int n, ir_node *copy_nodes[]);
+/**
+ * Insert a Perm which permutes all (non-ignore) live values of a given register class
+ * after a certain instruction.
+ * @param arch_env  The architecture environment.
+ * @param lv        Liveness Information.
+ * @param cls       The register class.
+ * @param dom_front Dominance frontier information.
+ * @param irn       The node to insert the Perm after.
+ * @return          The Perm or NULL if nothing was live before @p irn.
+ */
+ir_node *insert_Perm_after(const arch_env_t *arch_env,
+                                                  be_lv_t *lv,
+                                                  const arch_register_class_t *cls,
+                                                  be_dom_front_info_t *dom_front,
+                                                  ir_node *irn);
+
+/**
+ * Removes basic blocks that only contain a jump instruction
+ * (this will potentially create critical edges).
+ *
+ * @param irg  the graph that will be changed
+ *
+ * @return non-zero if the graph was changed, zero else
+ */
+int be_remove_empty_blocks(ir_graph *irg);
 
-#endif
+#endif /* _BEIRGMOD_H */