Add arch_get_register_req_out().
[libfirm] / ir / be / becopyopt.h
index eea0819..471fccd 100644 (file)
@@ -1,36 +1,75 @@
+/*
+ * Copyright (C) 1995-2008 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.
+ */
+
 /**
- * Author:      Daniel Grund
- * Date:               11.04.2005
- * Copyright:   (c) Universitaet Karlsruhe
- * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
+ * @file
+ * @brief       Copy minimization driver.
+ * @author      Daniel Grund
+ * @date        11.04.2005
+ * @version     $Id$
  *
  * Main file for the optimization reducing the copies needed for:
  * - Phi coalescing
  * - Register-constrained nodes
  * - Two-address code instructions
  */
-
-#ifndef _BECOPYOPT_H
-#define _BECOPYOPT_H
+#ifndef FIRM_BE_BECOPYOPT_H
+#define FIRM_BE_BECOPYOPT_H
 
 #include <stdio.h>
 
 #include "firm_types.h"
 #include "bechordal.h"
+#include "beutil.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. */
+};
 
 /**
- * Has to be called during the firm init phase
+ * Algorithms.
  */
-void be_copy_opt_init(void);
+enum {
+       CO_ALGO_NONE,
+       CO_ALGO_HEUR,
+       CO_ALGO_HEUR2,
+       CO_ALGO_HEUR3,
+       CO_ALGO_HEUR4,
+       CO_ALGO_ILP,
+       CO_ALGO_LAST
+};
+
+/** The driver for copy minimization. */
+void co_driver(be_chordal_env_t *cenv);
 
 typedef struct _copy_opt_t copy_opt_t;
 
-typedef int(*cost_fct_t)(const copy_opt_t *, ir_node*, ir_node*, int);
+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.
@@ -42,18 +81,6 @@ copy_opt_t *new_copy_opt(be_chordal_env_t *chordal_env, cost_fct_t get_costs);
  */
 void free_copy_opt(copy_opt_t *co);
 
-/**
- * Checks if a node is optimizable, viz. has something to do with coalescing
- * @param arch The architecture environment
- * @param irn  The irn to check
- */
-int co_is_optimizable_root(const copy_opt_t *co, ir_node *irn);
-
-/**
- * Checks if the irn is a non-interfering argument of a node which 'is_optimizable'
- */
-int co_is_optimizable_arg(const copy_opt_t *co, ir_node *irn);
-
 /**
  * Computes the costs of a copy according to loop depth
  * @param co   The copy opt object.
@@ -77,7 +104,26 @@ int co_get_costs_exec_freq(const copy_opt_t *co, ir_node *root, ir_node* arg, in
  */
 int co_get_costs_all_one(const copy_opt_t *co, ir_node *root, ir_node* arg, int pos);
 
+/**
+ * Statistics over a copy optimization module.
+ */
+typedef struct {
+       ulong64 aff_edges;            /**< number of affinity edges. */
+       ulong64 aff_nodes;            /**< number of nodes with incident affinity edges. */
+       ulong64 aff_int;              /**< number of affinity edges whose nodes also interfere. */
+       ulong64 inevit_costs;         /**< costs which cannot be evited (due to interfering affinities). */
+       ulong64 max_costs;            /**< all costs of the affinities. */
+       ulong64 costs;                /**< The costs of the current coloring. */
+       ulong64 unsatisfied_edges;    /**< The number of unequally colored affinity edges. */
+} co_complete_stats_t;
 
+/**
+ * Collect statistics of a copy optimization module.
+ * @param co    The copy optimization environment.
+ * @param stat  Where to put the stats.
+ * @note  This requires the graph info to be computed.
+ */
+void co_complete_stats(const copy_opt_t *co, co_complete_stats_t *stat);
 
 
 /**
@@ -97,10 +143,6 @@ void co_free_ou_structure(copy_opt_t *co);
  */
 int co_solve_heuristic(copy_opt_t *co);
 
-void co_solve_heuristic_new(copy_opt_t *co);
-
-void co_solve_heuristic_java(copy_opt_t *co);
-
 /**
  * Apply Park/Moon coalescing to the graph.
  * @param co The copy optimization data structure.
@@ -111,7 +153,19 @@ 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.
  */
-void co_solve_heuristic_new(copy_opt_t *co);
+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);
+
+/**
+ * This is the pure C implementation of co_solve_heuristic_java().
+ */
+int co_solve_heuristic_mst(copy_opt_t *co);
 
 /**
  * Returns the maximal costs possible, i.e. the costs if all
@@ -158,14 +212,11 @@ void co_dump_appel_graph(const copy_opt_t *co, FILE *f);
  * @param f  The file to dump to.
  */
 void co_dump_appel_graph_cliques(const copy_opt_t *co, FILE *f);
-
-enum {
-       CO_IFG_DUMP_COLORS = 1,
-       CO_IFG_DUMP_LABELS = 2
-};
-
 /**
  * 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);
 
@@ -193,7 +244,7 @@ int co_solve_ilp1(copy_opt_t *co, double time_limit);
  * 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 something to do with coalescing.
@@ -201,4 +252,4 @@ int co_solve_ilp2(copy_opt_t *co, double time_limit);
  */
 int co_gs_is_optimizable(copy_opt_t *co, ir_node *irn);
 
-#endif /* _BECOPYOPT_H */
+#endif /* FIRM_BE_BECOPYOPT_H */