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

   1 /**
   2  * Author:      Daniel Grund
   3  * Date:                11.04.2005
   4  * Copyright:   (c) Universitaet Karlsruhe
   5  * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
   6  *
   7  * Main file for the optimization reducing the copies needed for:
   8  * - Phi coalescing
   9  * - Register-constrained nodes
  10  * - Two-address code instructions
  11  */
  12
  13 #ifndef _BECOPYOPT_H
  14 #define _BECOPYOPT_H
  15
  16 #include <stdio.h>
  17
  18 #include "firm_types.h"
  19 #include "bechordal.h"
  20
  21 #ifdef WITH_LIBCORE
  22 #include <libcore/lc_opts.h>
  23 extern void co_register_options(lc_opt_entry_t *grp);
  24 #endif
  25
  26 /**
  27  * Flags for dumping the IFG.
  28  */
  29 enum {
  30         CO_IFG_DUMP_COLORS = 1, /**< Dump the graph colored. */
  31         CO_IFG_DUMP_LABELS = 2, /**< Dump node/edge labels. */
  32         CO_IFG_DUMP_SHAPE  = 4, /**< Give constrained nodes special shapes. */
  33         CO_IFG_DUMP_CONSTR = 8  /**< Dump the node constraints in the label. */
  34 };
  35
  36 /**
  37  * Algorithms.
  38  */
  39 enum {
  40         CO_ALGO_NONE,
  41         CO_ALGO_HEUR,
  42         CO_ALGO_HEUR2,
  43         CO_ALGO_HEUR3,
  44         CO_ALGO_ILP,
  45         CO_ALGO_LAST
  46 };
  47
  48 /** The driver for copy minimization. */
  49 void co_driver(be_chordal_env_t *cenv);
  50
  51 /**
  52  * Has to be called during the firm init phase
  53  */
  54 void be_copy_opt_init(void);
  55
  56 typedef struct _copy_opt_t copy_opt_t;
  57
  58 typedef int(*cost_fct_t)(const copy_opt_t *, ir_node*, ir_node*, int);
  59
  60 /** A coalescing algorithm. */
  61 typedef int (co_algo_t)(copy_opt_t *);
  62
  63 /**
  64  * Generate the problem. Collect all information and optimizable nodes.
  65  */
  66 copy_opt_t *new_copy_opt(be_chordal_env_t *chordal_env, cost_fct_t get_costs);
  67
  68 /**
  69  * Free the space used...
  70  */
  71 void free_copy_opt(copy_opt_t *co);
  72
  73 /**
  74  * Checks if a node is optimizable, viz. has something to do with coalescing
  75  * @param arch The architecture environment
  76  * @param irn  The irn to check
  77  */
  78 int co_is_optimizable_root(const copy_opt_t *co, ir_node *irn);
  79
  80 /**
  81  * Checks if the irn is a non-interfering argument of a node which 'is_optimizable'
  82  */
  83 int co_is_optimizable_arg(const copy_opt_t *co, ir_node *irn);
  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         unsigned long long int aff_edges;            /**< number of affinity edges. */
 113         unsigned long long int aff_nodes;            /**< number of nodes with incident affinity edges. */
 114         unsigned long long int aff_int;              /**< number of affinity edges whose nodes also interfere. */
 115         unsigned long long int inevit_costs;         /**< costs which cannot be evited (due to interfering affinities). */
 116         unsigned long long int max_costs;            /**< all costs of the affinities. */
 117         unsigned long long int costs;                /**< The costs of the current coloring. */
 118         unsigned long long int 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  * Returns the maximal costs possible, i.e. the costs if all
 168  * pairs would be assigned different registers.
 169  * Uses the OU data structure
 170  */
 171 int co_get_max_copy_costs(const copy_opt_t *co);
 172
 173 /**
 174  * Returns the inevitable costs, i.e. the costs of
 175  * all copy pairs which interfere.
 176  * Uses the OU data structure
 177  */
 178 int co_get_inevit_copy_costs(const copy_opt_t *co);
 179
 180 /**
 181  * Returns the current costs the copies are causing.
 182  * The result includes inevitable costs and the costs
 183  * of the copies regarding the current register allocation
 184  * Uses the OU data structure
 185  */
 186 int co_get_copy_costs(const copy_opt_t *co);
 187
 188 /**
 189  * Returns a lower bound for the costs of copies in this ou.
 190  * The result includes inevitable costs and the costs of a
 191  * minimal costs caused by the nodes of the ou.
 192  * Uses the OU data structure
 193  */
 194 int co_get_lower_bound(const copy_opt_t *co);
 195
 196 /**
 197  * Dump the interference graph according to the Appel/George coalescing contest file format.
 198  * See: http://www.cs.princeton.edu/~appel/coalesce/format.html
 199  * @note Requires graph structure.
 200  * @param co The copy opt object.
 201  * @param f  A file to dump to.
 202  */
 203 void co_dump_appel_graph(const copy_opt_t *co, FILE *f);
 204
 205 /**
 206  * Dumps the IFG of the program splitting after each instruction in the Appel format.
 207  * @param co The copy opt object.
 208  * @param f  The file to dump to.
 209  */
 210 void co_dump_appel_graph_cliques(const copy_opt_t *co, FILE *f);
 211 /**
 212  * Dump the interference graph with the affinity edges and the coloring.
 213  * @param co    The copy opt structure.
 214  * @param f     The file to dump to.
 215  * @param flags The dump flags (see enum above).
 216  */
 217 void co_dump_ifg_dot(const copy_opt_t *co, FILE *f, unsigned flags);
 218
 219 /**
 220  * Constructs another internal representation of the affinity edges
 221  */
 222 void co_build_graph_structure(copy_opt_t *co);
 223
 224 /**
 225  * Frees the space used by the graph representation.
 226  * Does NOT free the whole copyopt structure
 227  */
 228 void co_free_graph_structure(copy_opt_t *co);
 229
 230 /**
 231  * Solves the problem using mixed integer programming
 232  * @returns 1 iff solution state was optimal
 233  * NYI
 234  */
 235 int co_solve_ilp1(copy_opt_t *co, double time_limit);
 236
 237 /**
 238  * Solves the problem using mixed integer programming
 239  * @returns 1 iff solution state was optimal
 240  * Uses the OU and the GRAPH data structure
 241  * Dependency of the OU structure can be removed
 242  */
 243 int co_solve_ilp2(copy_opt_t *co);
 244
 245 /**
 246  * Checks if a node is optimizable, viz has something to do with coalescing.
 247  * Uses the GRAPH data structure
 248  */
 249 int co_gs_is_optimizable(copy_opt_t *co, ir_node *irn);
 250
 251 #endif /* _BECOPYOPT_H */