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_PBQP,
  62         CO_ALGO_LAST
  63 };
  64
  65 /** The driver for copy minimization. */
  66 void co_driver(be_chordal_env_t *cenv);
  67
  68 typedef struct _copy_opt_t copy_opt_t;
  69
  70 typedef int(*cost_fct_t)(const copy_opt_t *, ir_node *, ir_node *, int);
  71
  72 /** A coalescing algorithm. */
  73 typedef int (co_algo_t)(copy_opt_t *);
  74
  75 /**
  76  * Generate the problem. Collect all information and optimizable nodes.
  77  */
  78 copy_opt_t *new_copy_opt(be_chordal_env_t *chordal_env, cost_fct_t get_costs);
  79
  80 /**
  81  * Free the space used...
  82  */
  83 void free_copy_opt(copy_opt_t *co);
  84
  85 /**
  86  * Computes the costs of a copy according to loop depth
  87  * @param co   The copy opt object.
  88  * @param pos   the argument position of arg in the root arguments
  89  * @return Must be >= 0 in all cases.
  90  */
  91 int co_get_costs_loop_depth(const copy_opt_t *co, ir_node *root, ir_node* arg, int pos);
  92
  93 /**
  94  * Computes the costs of a copy according to execution frequency
  95  * @param co   The copy opt object.
  96  * @param pos   the argument position of arg in the root arguments
  97  * @return Must be >= 0 in all cases.
  98  */
  99 int co_get_costs_exec_freq(const copy_opt_t *co, ir_node *root, ir_node* arg, int pos);
 100
 101 /**
 102  * All costs equal 1. Using this will reduce the _number_ of copies.
 103  * @param co   The copy opt object.
 104  * @return Must be >= 0 in all cases.
 105  */
 106 int co_get_costs_all_one(const copy_opt_t *co, ir_node *root, ir_node* arg, int pos);
 107
 108 /**
 109  * Statistics over a copy optimization module.
 110  */
 111 typedef struct {
 112         ulong64 aff_edges;            /**< number of affinity edges. */
 113         ulong64 aff_nodes;            /**< number of nodes with incident affinity edges. */
 114         ulong64 aff_int;              /**< number of affinity edges whose nodes also interfere. */
 115         ulong64 inevit_costs;         /**< costs which cannot be evited (due to interfering affinities). */
 116         ulong64 max_costs;            /**< all costs of the affinities. */
 117         ulong64 costs;                /**< The costs of the current coloring. */
 118         ulong64 unsatisfied_edges;    /**< The number of unequally colored affinity edges. */
 119 } co_complete_stats_t;
 120
 121 /**
 122  * Collect statistics of a copy optimization module.
 123  * @param co    The copy optimization environment.
 124  * @param stat  Where to put the stats.
 125  * @note  This requires the graph info to be computed.
 126  */
 127 void co_complete_stats(const copy_opt_t *co, co_complete_stats_t *stat);
 128
 129
 130 /**
 131  * Build internal optimization units structure
 132  */
 133 void co_build_ou_structure(copy_opt_t *co);
 134
 135 /**
 136  * Frees the space used by the opt unit representation.
 137  * Does NOT free the whole copyopt structure
 138  */
 139 void co_free_ou_structure(copy_opt_t *co);
 140
 141 /**
 142  * Solves the problem using a heuristic approach
 143  * Uses the OU data structure
 144  */
 145 int co_solve_heuristic(copy_opt_t *co);
 146
 147 /**
 148  * Apply Park/Moon coalescing to the graph.
 149  * @param co The copy optimization data structure.
 150  */
 151 void co_solve_park_moon(copy_opt_t *co);
 152
 153 /**
 154  * Solves the copy minimization problem using another heuristic approach.
 155  * Uses the OU and the GRAPH data structure.
 156  */
 157 int co_solve_heuristic_new(copy_opt_t *co);
 158
 159 /**
 160  * Solves the copy minimization problem using another heuristic approach implemented in Java.
 161  * This function needs a JVM which is started to call the Java module.
 162  * Uses the GRAPH data structure.
 163  */
 164 int co_solve_heuristic_java(copy_opt_t *co);
 165
 166 /**
 167  * This is the pure C implementation of co_solve_heuristic_java().
 168  */
 169 int co_solve_heuristic_mst(copy_opt_t *co);
 170
 171 /**
 172  * Returns the maximal costs possible, i.e. the costs if all
 173  * pairs would be assigned different registers.
 174  * Uses the OU data structure
 175  */
 176 int co_get_max_copy_costs(const copy_opt_t *co);
 177
 178 /**
 179  * Returns the inevitable costs, i.e. the costs of
 180  * all copy pairs which interfere.
 181  * Uses the OU data structure
 182  */
 183 int co_get_inevit_copy_costs(const copy_opt_t *co);
 184
 185 /**
 186  * Returns the current costs the copies are causing.
 187  * The result includes inevitable costs and the costs
 188  * of the copies regarding the current register allocation
 189  * Uses the OU data structure
 190  */
 191 int co_get_copy_costs(const copy_opt_t *co);
 192
 193 /**
 194  * Returns a lower bound for the costs of copies in this ou.
 195  * The result includes inevitable costs and the costs of a
 196  * minimal costs caused by the nodes of the ou.
 197  * Uses the OU data structure
 198  */
 199 int co_get_lower_bound(const copy_opt_t *co);
 200
 201 /**
 202  * Dump the interference graph according to the Appel/George coalescing contest file format.
 203  * See: http://www.cs.princeton.edu/~appel/coalesce/format.html
 204  * @note Requires graph structure.
 205  * @param co The copy opt object.
 206  * @param f  A file to dump to.
 207  */
 208 void co_dump_appel_graph(const copy_opt_t *co, FILE *f);
 209
 210 /**
 211  * Dumps the IFG of the program splitting after each instruction in the Appel format.
 212  * @param co The copy opt object.
 213  * @param f  The file to dump to.
 214  */
 215 void co_dump_appel_graph_cliques(const copy_opt_t *co, FILE *f);
 216 /**
 217  * Dump the interference graph with the affinity edges and the coloring.
 218  * @param co    The copy opt structure.
 219  * @param f     The file to dump to.
 220  * @param flags The dump flags (see enum above).
 221  */
 222 void co_dump_ifg_dot(const copy_opt_t *co, FILE *f, unsigned flags);
 223
 224 /**
 225  * Constructs another internal representation of the affinity edges
 226  */
 227 void co_build_graph_structure(copy_opt_t *co);
 228
 229 /**
 230  * Frees the space used by the graph representation.
 231  * Does NOT free the whole copyopt structure
 232  */
 233 void co_free_graph_structure(copy_opt_t *co);
 234
 235 /**
 236  * Solves the problem using mixed integer programming
 237  * @returns 1 iff solution state was optimal
 238  * NYI
 239  */
 240 int co_solve_ilp1(copy_opt_t *co, double time_limit);
 241
 242 /**
 243  * Solves the problem using mixed integer programming
 244  * @returns 1 iff solution state was optimal
 245  * Uses the OU and the GRAPH data structure
 246  * Dependency of the OU structure can be removed
 247  */
 248 int co_solve_ilp2(copy_opt_t *co);
 249
 250 int co_solve_heuristic_pbqp(copy_opt_t *co);
 251
 252 /**
 253  * Checks if a node is optimizable, viz has something to do with coalescing.
 254  * Uses the GRAPH data structure
 255  */
 256 int co_gs_is_optimizable(copy_opt_t *co, ir_node *irn);
 257
 258 #endif /* FIRM_BE_BECOPYOPT_H */