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
 110
 111 /**
 112  * Build internal optimization units structure
 113  */
 114 void co_build_ou_structure(copy_opt_t *co);
 115
 116 /**
 117  * Frees the space used by the opt unit representation.
 118  * Does NOT free the whole copyopt structure
 119  */
 120 void co_free_ou_structure(copy_opt_t *co);
 121
 122 /**
 123  * Solves the problem using a heuristic approach
 124  * Uses the OU data structure
 125  */
 126 int co_solve_heuristic(copy_opt_t *co);
 127
 128 /**
 129  * Apply Park/Moon coalescing to the graph.
 130  * @param co The copy optimization data structure.
 131  */
 132 void co_solve_park_moon(copy_opt_t *co);
 133
 134 /**
 135  * Solves the copy minimization problem using another heuristic approach.
 136  * Uses the OU and the GRAPH data structure.
 137  */
 138 int  co_solve_heuristic_new(copy_opt_t *co);
 139
 140 /**
 141  * Solves the copy minimization problem using another heuristic approach implemented in Java.
 142  * This function needs a JVM which is started to call the Java module.
 143  * Uses the GRAPH data structure.
 144  */
 145 int co_solve_heuristic_java(copy_opt_t *co);
 146
 147 /**
 148  * Returns the maximal costs possible, i.e. the costs if all
 149  * pairs would be assigned different registers.
 150  * Uses the OU data structure
 151  */
 152 int co_get_max_copy_costs(const copy_opt_t *co);
 153
 154 /**
 155  * Returns the inevitable costs, i.e. the costs of
 156  * all copy pairs which interfere.
 157  * Uses the OU data structure
 158  */
 159 int co_get_inevit_copy_costs(const copy_opt_t *co);
 160
 161 /**
 162  * Returns the current costs the copies are causing.
 163  * The result includes inevitable costs and the costs
 164  * of the copies regarding the current register allocation
 165  * Uses the OU data structure
 166  */
 167 int co_get_copy_costs(const copy_opt_t *co);
 168
 169 /**
 170  * Returns a lower bound for the costs of copies in this ou.
 171  * The result includes inevitable costs and the costs of a
 172  * minimal costs caused by the nodes of the ou.
 173  * Uses the OU data structure
 174  */
 175 int co_get_lower_bound(const copy_opt_t *co);
 176
 177 /**
 178  * Dump the interference graph according to the Appel/George coalescing contest file format.
 179  * See: http://www.cs.princeton.edu/~appel/coalesce/format.html
 180  * @note Requires graph structure.
 181  * @param co The copy opt object.
 182  * @param f  A file to dump to.
 183  */
 184 void co_dump_appel_graph(const copy_opt_t *co, FILE *f);
 185
 186 /**
 187  * Dumps the IFG of the program splitting after each instruction in the Appel format.
 188  * @param co The copy opt object.
 189  * @param f  The file to dump to.
 190  */
 191 void co_dump_appel_graph_cliques(const copy_opt_t *co, FILE *f);
 192 /**
 193  * Dump the interference graph with the affinity edges and the coloring.
 194  * @param co    The copy opt structure.
 195  * @param f     The file to dump to.
 196  * @param flags The dump flags (see enum above).
 197  */
 198 void co_dump_ifg_dot(const copy_opt_t *co, FILE *f, unsigned flags);
 199
 200 /**
 201  * Constructs another internal representation of the affinity edges
 202  */
 203 void co_build_graph_structure(copy_opt_t *co);
 204
 205 /**
 206  * Frees the space used by the graph representation.
 207  * Does NOT free the whole copyopt structure
 208  */
 209 void co_free_graph_structure(copy_opt_t *co);
 210
 211 /**
 212  * Solves the problem using mixed integer programming
 213  * @returns 1 iff solution state was optimal
 214  * NYI
 215  */
 216 int co_solve_ilp1(copy_opt_t *co, double time_limit);
 217
 218 /**
 219  * Solves the problem using mixed integer programming
 220  * @returns 1 iff solution state was optimal
 221  * Uses the OU and the GRAPH data structure
 222  * Dependency of the OU structure can be removed
 223  */
 224 int co_solve_ilp2(copy_opt_t *co);
 225
 226 /**
 227  * Checks if a node is optimizable, viz has something to do with coalescing.
 228  * Uses the GRAPH data structure
 229  */
 230 int co_gs_is_optimizable(copy_opt_t *co, ir_node *irn);
 231
 232 #endif /* _BECOPYOPT_H */