- new spillslots dump phase

[libfirm] / ir / be / becopyopt.h

diff --git a/ir/be/becopyopt.h b/ir/be/becopyopt.h
index d13c367..23b497f 100644 (file)
--- a/ir/be/becopyopt.h
+++ b/ir/be/becopyopt.h
@@ -13,18 +13,53 @@
 #ifndef _BECOPYOPT_H
 #define _BECOPYOPT_H
 
+#include <stdio.h>
+
 #include "firm_types.h"
 #include "bechordal.h"
 
+#ifdef WITH_LIBCORE
+#include <libcore/lc_opts.h>
+extern void co_register_options(lc_opt_entry_t *grp);
+#endif
+
+/**
+ * Flags for dumping the IFG.
+ */
+enum {
+       CO_IFG_DUMP_COLORS = 1, /**< Dump the graph colored. */
+       CO_IFG_DUMP_LABELS = 2, /**< Dump node/edge labels. */
+       CO_IFG_DUMP_SHAPE  = 4, /**< Give constrained nodes special shapes. */
+       CO_IFG_DUMP_CONSTR = 8  /**< Dump the node constraints in the label. */
+};
+
+/**
+ * Algorithms.
+ */
+enum {
+       CO_ALGO_NONE,
+       CO_ALGO_HEUR,
+       CO_ALGO_HEUR2,
+       CO_ALGO_HEUR3,
+       CO_ALGO_ILP,
+       CO_ALGO_LAST
+};
+
+/** The driver for copy minimization. */
+void co_driver(be_chordal_env_t *cenv);
+
 /**
  * Has to be called during the firm init phase
  */
 void be_copy_opt_init(void);
 
-typedef int(*cost_fct_t)(ir_node*, ir_node*, int);
-
 typedef struct _copy_opt_t copy_opt_t;
 
+typedef int(*cost_fct_t)(const copy_opt_t *, ir_node*, ir_node*, int);
+
+/** A coalescing algorithm. */
+typedef int (co_algo_t)(copy_opt_t *);
+
 /**
  * Generate the problem. Collect all information and optimizable nodes.
  */
@@ -49,16 +84,26 @@ int co_is_optimizable_arg(const copy_opt_t *co, ir_node *irn);
 
 /**
  * Computes the costs of a copy according to loop depth
- * @param pos: the argument position of arg in the root arguments
+ * @param co   The copy opt object.
+ * @param pos  the argument position of arg in the root arguments
+ * @return Must be >= 0 in all cases.
+ */
+int co_get_costs_loop_depth(const copy_opt_t *co, ir_node *root, ir_node* arg, int pos);
+
+/**
+ * Computes the costs of a copy according to execution frequency
+ * @param co   The copy opt object.
+ * @param pos  the argument position of arg in the root arguments
  * @return Must be >= 0 in all cases.
  */
-int co_get_costs_loop_depth(ir_node *root, ir_node* arg, int pos);
+int co_get_costs_exec_freq(const copy_opt_t *co, ir_node *root, ir_node* arg, int pos);
 
 /**
  * All costs equal 1. Using this will reduce the _number_ of copies.
+ * @param co   The copy opt object.
  * @return Must be >= 0 in all cases.
  */
-int co_get_costs_all_one(ir_node *root, ir_node* arg, int pos);
+int co_get_costs_all_one(const copy_opt_t *co, ir_node *root, ir_node* arg, int pos);
 
 
 
@@ -80,6 +125,25 @@ void co_free_ou_structure(copy_opt_t *co);
  */
 int co_solve_heuristic(copy_opt_t *co);
 
+/**
+ * Apply Park/Moon coalescing to the graph.
+ * @param co The copy optimization data structure.
+ */
+void co_solve_park_moon(copy_opt_t *co);
+
+/**
+ * Solves the copy minimization problem using another heuristic approach.
+ * Uses the OU and the GRAPH data structure.
+ */
+int  co_solve_heuristic_new(copy_opt_t *co);
+
+/**
+ * Solves the copy minimization problem using another heuristic approach implemented in Java.
+ * This function needs a JVM which is started to call the Java module.
+ * Uses the GRAPH data structure.
+ */
+int co_solve_heuristic_java(copy_opt_t *co);
+
 /**
  * Returns the maximal costs possible, i.e. the costs if all
  * pairs would be assigned different registers.
@@ -110,9 +174,28 @@ int co_get_copy_costs(const copy_opt_t *co);
  */
 int co_get_lower_bound(const copy_opt_t *co);
 
+/**
+ * Dump the interference graph according to the Appel/George coalescing contest file format.
+ * See: http://www.cs.princeton.edu/~appel/coalesce/format.html
+ * @note Requires graph structure.
+ * @param co The copy opt object.
+ * @param f  A file to dump to.
+ */
+void co_dump_appel_graph(const copy_opt_t *co, FILE *f);
 
-
-
+/**
+ * Dumps the IFG of the program splitting after each instruction in the Appel format.
+ * @param co The copy opt object.
+ * @param f  The file to dump to.
+ */
+void co_dump_appel_graph_cliques(const copy_opt_t *co, FILE *f);
+/**
+ * Dump the interference graph with the affinity edges and the coloring.
+ * @param co    The copy opt structure.
+ * @param f     The file to dump to.
+ * @param flags The dump flags (see enum above).
+ */
+void co_dump_ifg_dot(const copy_opt_t *co, FILE *f, unsigned flags);
 
 /**
  * Constructs another internal representation of the affinity edges
@@ -136,11 +219,12 @@ int co_solve_ilp1(copy_opt_t *co, double time_limit);
  * Solves the problem using mixed integer programming
  * @returns 1 iff solution state was optimal
  * Uses the OU and the GRAPH data structure
+ * Dependency of the OU structure can be removed
  */
-int co_solve_ilp2(copy_opt_t *co, double time_limit);
+int co_solve_ilp2(copy_opt_t *co);
 
 /**
- * Checks if a node is optimizable, viz. has somthing to do with coalescing.
+ * Checks if a node is optimizable, viz has something to do with coalescing.
  * Uses the GRAPH data structure
  */
 int co_gs_is_optimizable(copy_opt_t *co, ir_node *irn);