nsz Git - libfirm/blob - ir/be/becopyopt.h

   1 /*
   2  * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
   3  *
   4  * This file is part of libFirm.
   5  *
   6  * This file may be distributed and/or modified under the terms of the
   7  * GNU General Public License version 2 as published by the Free Software
   8  * Foundation and appearing in the file LICENSE.GPL included in the
   9  * packaging of this file.
  10  *
  11  * Licensees holding valid libFirm Professional Edition licenses may use
  12  * this file in accordance with the libFirm Commercial License.
  13  * Agreement provided with the Software.
  14  *
  15  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
  16  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17  * PURPOSE.
  18  */
  19
  20 /**
  21  * @file
  22  * @brief       Copy minimization driver.
  23  * @author      Daniel Grund
  24  * @date        11.04.2005
  25  * @version     $Id$
  26  *
  27  * Main file for the optimization reducing the copies needed for:
  28  * - Phi coalescing
  29  * - Register-constrained nodes
  30  * - Two-address code instructions
  31  */
  32 #ifndef FIRM_BE_BECOPYOPT_H
  33 #define FIRM_BE_BECOPYOPT_H
  34
  35 #include <stdio.h>
  36
  37 #include "firm_types.h"
  38 #include "bechordal.h"
  39 #include "beutil.h"
  40
  41 /**
  42  * Flags for dumping the IFG.
  43  */
  44 enum {
  45         CO_IFG_DUMP_COLORS = 1, /**< Dump the graph colored. */
  46         CO_IFG_DUMP_LABELS = 2, /**< Dump node/edge labels. */
  47         CO_IFG_DUMP_SHAPE  = 4, /**< Give constrained nodes special shapes. */
  48         CO_IFG_DUMP_CONSTR = 8  /**< Dump the node constraints in the label. */
  49 };
  50
  51 /**
  52  * Algorithms.
  53  */
  54 enum {
  55         CO_ALGO_NONE,
  56         CO_ALGO_HEUR,
  57         CO_ALGO_HEUR2,
  58         CO_ALGO_HEUR3,
  59         CO_ALGO_HEUR4,
  60         CO_ALGO_ILP,
  61         CO_ALGO_LAST
  62 };
  63
  64 /** The driver for copy minimization. */
  65 void co_driver(be_chordal_env_t *cenv);
  66
  67 typedef struct _copy_opt_t copy_opt_t;
  68
  69 typedef int(*cost_fct_t)(const copy_opt_t *, ir_node *, ir_node *, int);
  70
  71 /** A coalescing algorithm. */
  72 typedef int (co_algo_t)(copy_opt_t *);
  73
  74 /**
  75  * Generate the problem. Collect all information and optimizable nodes.
  76  */
  77 copy_opt_t *new_copy_opt(be_chordal_env_t *chordal_env, cost_fct_t get_costs);
  78
  79 /**
  80  * Free the space used...
  81  */
  82 void free_copy_opt(copy_opt_t *co);
  83
  84 /**
  85  * Checks if a node is optimizable, viz. has something to do with coalescing
  86  * @param arch The architecture environment
  87  * @param irn  The irn to check
  88  */
  89 int co_is_optimizable_root(const copy_opt_t *co, ir_node *irn);
  90
  91 /**
  92  * Computes the costs of a copy according to loop depth
  93  * @param co   The copy opt object.
  94  * @param pos   the argument position of arg in the root arguments
  95  * @return Must be >= 0 in all cases.
  96  */
  97 int co_get_costs_loop_depth(const copy_opt_t *co, ir_node *root, ir_node* arg, int pos);
  98
  99 /**
 100  * Computes the costs of a copy according to execution frequency
 101  * @param co   The copy opt object.
 102  * @param pos   the argument position of arg in the root arguments
 103  * @return Must be >= 0 in all cases.
 104  */
 105 int co_get_costs_exec_freq(const copy_opt_t *co, ir_node *root, ir_node* arg, int pos);
 106
 107 /**
 108  * All costs equal 1. Using this will reduce the _number_ of copies.
 109  * @param co   The copy opt object.
 110  * @return Must be >= 0 in all cases.
 111  */
 112 int co_get_costs_all_one(const copy_opt_t *co, ir_node *root, ir_node* arg, int pos);
 113
 114 /**
 115  * Statistics over a copy optimization module.
 116  */
 117 typedef struct {
 118         ulong64 aff_edges;            /**< number of affinity edges. */
 119         ulong64 aff_nodes;            /**< number of nodes with incident affinity edges. */
 120         ulong64 aff_int;              /**< number of affinity edges whose nodes also interfere. */
 121         ulong64 inevit_costs;         /**< costs which cannot be evited (due to interfering affinities). */
 122         ulong64 max_costs;            /**< all costs of the affinities. */
 123         ulong64 costs;                /**< The costs of the current coloring. */
 124         ulong64 unsatisfied_edges;    /**< The number of unequally colored affinity edges. */
 125 } co_complete_stats_t;
 126
 127 /**
 128  * Collect statistics of a copy optimization module.
 129  * @param co    The copy optimization environment.
 130  * @param stat  Where to put the stats.
 131  * @note  This requires the graph info to be computed.
 132  */
 133 void co_complete_stats(const copy_opt_t *co, co_complete_stats_t *stat);
 134
 135
 136 /**
 137  * Build internal optimization units structure
 138  */
 139 void co_build_ou_structure(copy_opt_t *co);
 140
 141 /**
 142  * Frees the space used by the opt unit representation.
 143  * Does NOT free the whole copyopt structure
 144  */
 145 void co_free_ou_structure(copy_opt_t *co);
 146
 147 /**
 148  * Solves the problem using a heuristic approach
 149  * Uses the OU data structure
 150  */
 151 int co_solve_heuristic(copy_opt_t *co);
 152
 153 /**
 154  * Apply Park/Moon coalescing to the graph.
 155  * @param co The copy optimization data structure.
 156  */
 157 void co_solve_park_moon(copy_opt_t *co);
 158
 159 /**
 160  * Solves the copy minimization problem using another heuristic approach.
 161  * Uses the OU and the GRAPH data structure.
 162  */
 163 int co_solve_heuristic_new(copy_opt_t *co);
 164
 165 /**
 166  * Solves the copy minimization problem using another heuristic approach implemented in Java.
 167  * This function needs a JVM which is started to call the Java module.
 168  * Uses the GRAPH data structure.
 169  */
 170 int co_solve_heuristic_java(copy_opt_t *co);
 171
 172 /**
 173  * This is the pure C implementation of co_solve_heuristic_java().
 174  */
 175 int co_solve_heuristic_mst(copy_opt_t *co);
 176
 177 /**
 178  * Returns the maximal costs possible, i.e. the costs if all
 179  * pairs would be assigned different registers.
 180  * Uses the OU data structure
 181  */
 182 int co_get_max_copy_costs(const copy_opt_t *co);
 183
 184 /**
 185  * Returns the inevitable costs, i.e. the costs of
 186  * all copy pairs which interfere.
 187  * Uses the OU data structure
 188  */
 189 int co_get_inevit_copy_costs(const copy_opt_t *co);
 190
 191 /**
 192  * Returns the current costs the copies are causing.
 193  * The result includes inevitable costs and the costs
 194  * of the copies regarding the current register allocation
 195  * Uses the OU data structure
 196  */
 197 int co_get_copy_costs(const copy_opt_t *co);
 198
 199 /**
 200  * Returns a lower bound for the costs of copies in this ou.
 201  * The result includes inevitable costs and the costs of a
 202  * minimal costs caused by the nodes of the ou.
 203  * Uses the OU data structure
 204  */
 205 int co_get_lower_bound(const copy_opt_t *co);
 206
 207 /**
 208  * Dump the interference graph according to the Appel/George coalescing contest file format.
 209  * See: http://www.cs.princeton.edu/~appel/coalesce/format.html
 210  * @note Requires graph structure.
 211  * @param co The copy opt object.
 212  * @param f  A file to dump to.
 213  */
 214 void co_dump_appel_graph(const copy_opt_t *co, FILE *f);
 215
 216 /**
 217  * Dumps the IFG of the program splitting after each instruction in the Appel format.
 218  * @param co The copy opt object.
 219  * @param f  The file to dump to.
 220  */
 221 void co_dump_appel_graph_cliques(const copy_opt_t *co, FILE *f);
 222 /**
 223  * Dump the interference graph with the affinity edges and the coloring.
 224  * @param co    The copy opt structure.
 225  * @param f     The file to dump to.
 226  * @param flags The dump flags (see enum above).
 227  */
 228 void co_dump_ifg_dot(const copy_opt_t *co, FILE *f, unsigned flags);
 229
 230 /**
 231  * Constructs another internal representation of the affinity edges
 232  */
 233 void co_build_graph_structure(copy_opt_t *co);
 234
 235 /**
 236  * Frees the space used by the graph representation.
 237  * Does NOT free the whole copyopt structure
 238  */
 239 void co_free_graph_structure(copy_opt_t *co);
 240
 241 /**
 242  * Solves the problem using mixed integer programming
 243  * @returns 1 iff solution state was optimal
 244  * NYI
 245  */
 246 int co_solve_ilp1(copy_opt_t *co, double time_limit);
 247
 248 /**
 249  * Solves the problem using mixed integer programming
 250  * @returns 1 iff solution state was optimal
 251  * Uses the OU and the GRAPH data structure
 252  * Dependency of the OU structure can be removed
 253  */
 254 int co_solve_ilp2(copy_opt_t *co);
 255
 256 /**
 257  * Checks if a node is optimizable, viz has something to do with coalescing.
 258  * Uses the GRAPH data structure
 259  */
 260 int co_gs_is_optimizable(copy_opt_t *co, ir_node *irn);
 261
 262 #endif /* FIRM_BE_BECOPYOPT_H */