+/*
+ * 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"
/**
- * Has to be called during the firm init phase
+ * Flags for dumping the IFG.
*/
-void be_copy_opt_init(void);
+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. */
+};
-typedef int(*cost_fct_t)(ir_node*, ir_node*, int);
+/**
+ * Algorithms.
+ */
+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);
+
+/** A coalescing algorithm. */
+typedef int (co_algo_t)(copy_opt_t *);
+
/**
* Generate the problem. Collect all information and optimizable nodes.
*/
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'
+ * Computes the costs of a copy according to loop depth
+ * @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_is_optimizable_arg(const copy_opt_t *co, ir_node *irn);
+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 loop depth
- * @param pos: the argument position of arg in the root arguments
+ * 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);
+/**
+ * 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);
/**
*/
int co_solve_heuristic(copy_opt_t *co);
-void co_solve_heuristic_new(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.
*/
-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
*/
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
* 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.
*/
int co_gs_is_optimizable(copy_opt_t *co, ir_node *irn);
-#endif /* _BECOPYOPT_H */
+#endif /* FIRM_BE_BECOPYOPT_H */
projects / libfirm / blobdiff