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