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

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