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