give Bad nodes a mode
[libfirm] / ir / be / becopyopt.h
index a36875b..6646e5d 100644 (file)
@@ -1,27 +1,42 @@
+/*
+ * 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"
-
-#ifdef WITH_LIBCORE
-#include <libcore/lc_opts.h>
-extern void co_register_options(lc_opt_entry_t *grp);
-#endif
+#include "beutil.h"
 
 /**
  * Flags for dumping the IFG.
@@ -40,22 +55,33 @@ enum {
        CO_ALGO_NONE,
        CO_ALGO_HEUR,
        CO_ALGO_HEUR2,
-       CO_ALGO_HEUR3,
+       CO_ALGO_HEUR4,
        CO_ALGO_ILP,
+       CO_ALGO_PBQP,
        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 struct {
+       int (*copyopt)(copy_opt_t *co); /**< function ptr to run copyopt */
+       int        can_improve_existing;
+} co_algo_info;
+
 
 /**
- * Has to be called during the firm init phase
+ * Register a new copy optimization algorithm.
+ *
+ * @param name     the name of the copy optimazation algorithm,
+ *                 used to select it
+ * @param copyopt  a copy optimazation entry
  */
-void be_copy_opt_init(void);
+void be_register_copyopt(const char *name, co_algo_info *copyopt);
 
-typedef struct _copy_opt_t copy_opt_t;
-
-typedef int(*cost_fct_t)(const copy_opt_t *, ir_node*, ir_node*, int);
+/** The driver for copy minimization. */
+void co_driver(be_chordal_env_t *cenv);
 
 /** A coalescing algorithm. */
 typedef int (co_algo_t)(copy_opt_t *);
@@ -70,30 +96,18 @@ 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.
- * @param pos  the argument position of arg in the root arguments
- * @return Must be >= 0 in all cases.
+ * @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
+ * @param pos  the argument position of arg in the root arguments
  * @return Must be >= 0 in all cases.
  */
 int co_get_costs_exec_freq(const copy_opt_t *co, ir_node *root, ir_node* arg, int pos);
@@ -105,17 +119,33 @@ 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);
 
+#ifdef _MSC_VER
+typedef          __int64 long64;
+typedef unsigned __int64 ulong64;
+
+#define LL_FMT   "i64"
+#define ULL_FMT  "ui64"
+
+#else
+typedef          long long long64;
+typedef unsigned long long ulong64;
+
+#define LL_FMT   "ll"
+#define ULL_FMT  "llu"
+
+#endif
+
 /**
  * Statistics over a copy optimization module.
  */
 typedef struct {
-       unsigned long long int aff_edges;            /**< number of affinity edges. */
-       unsigned long long int aff_nodes;            /**< number of nodes with incident affinity edges. */
-       unsigned long long int aff_int;              /**< number of affinity edges whose nodes also interfere. */
-       unsigned long long int inevit_costs;         /**< costs which cannot be evited (due to interfering affinities). */
-       unsigned long long int max_costs;            /**< all costs of the affinities. */
-       unsigned long long int costs;                /**< The costs of the current coloring. */
-       unsigned long long int unsatisfied_edges;    /**< The number of unequally colored affinity edges. */
+       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;
 
 /**
@@ -154,14 +184,7 @@ 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);
+int co_solve_heuristic_new(copy_opt_t *co);
 
 /**
  * Returns the maximal costs possible, i.e. the costs if all
@@ -227,13 +250,6 @@ void co_build_graph_structure(copy_opt_t *co);
  */
 void co_free_graph_structure(copy_opt_t *co);
 
-/**
- * Solves the problem using mixed integer programming
- * @returns 1 iff solution state was optimal
- * NYI
- */
-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
@@ -248,4 +264,4 @@ int co_solve_ilp2(copy_opt_t *co);
  */
 int co_gs_is_optimizable(copy_opt_t *co, ir_node *irn);
 
-#endif /* _BECOPYOPT_H */
+#endif