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