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  *
  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 FIRM_BE_BECOPYOPT_H
  32 #define FIRM_BE_BECOPYOPT_H
  33
  34 #include <stdio.h>
  35 #include <stdbool.h>
  36
  37 #include "firm_types.h"
  38 #include "bechordal.h"
  39 #include "beutil.h"
  40
  41 typedef struct copy_opt_t copy_opt_t;
  42
  43 typedef int(*cost_fct_t)(const copy_opt_t *, ir_node *, ir_node *, int);
  44
  45 typedef struct {
  46         int (*copyopt)(copy_opt_t *co); /**< function ptr to run copyopt */
  47         bool can_improve_existing;
  48 } co_algo_info;
  49
  50 /**
  51  * Register a new copy optimization algorithm.
  52  *
  53  * @param name     the name of the copy optimazation algorithm,
  54  *                 used to select it
  55  * @param copyopt  a copy optimazation entry
  56  */
  57 void be_register_copyopt(const char *name, co_algo_info *copyopt);
  58
  59 /** The driver for copy minimization. */
  60 void co_driver(be_chordal_env_t *cenv);
  61
  62 /**
  63  * Generate the problem. Collect all information and optimizable nodes.
  64  */
  65 copy_opt_t *new_copy_opt(be_chordal_env_t *chordal_env, cost_fct_t get_costs);
  66
  67 /**
  68  * Free the space used...
  69  */
  70 void free_copy_opt(copy_opt_t *co);
  71
  72 /**
  73  * Computes the costs of a copy according to loop depth
  74  * @param co   The copy opt object.
  75  * @param pos  the argument position of arg in the root arguments
  76  * @return     Must be >= 0 in all cases.
  77  */
  78 int co_get_costs_loop_depth(const copy_opt_t *co, ir_node *root, ir_node* arg, int pos);
  79
  80 /**
  81  * Computes the costs of a copy according to execution frequency
  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_exec_freq(const copy_opt_t *co, ir_node *root, ir_node* arg, int pos);
  87
  88 /**
  89  * All costs equal 1. Using this will reduce the _number_ of copies.
  90  * @param co   The copy opt object.
  91  * @return Must be >= 0 in all cases.
  92  */
  93 int co_get_costs_all_one(const copy_opt_t *co, ir_node *root, ir_node* arg, int pos);
  94
  95 /**
  96  * Statistics over a copy optimization module.
  97  */
  98 typedef struct {
  99         unsigned long long aff_edges;            /**< number of affinity edges. */
 100         unsigned long long aff_nodes;            /**< number of nodes with incident affinity edges. */
 101         unsigned long long aff_int;              /**< number of affinity edges whose nodes also interfere. */
 102         unsigned long long inevit_costs;         /**< costs which cannot be evited (due to interfering affinities). */
 103         unsigned long long max_costs;            /**< all costs of the affinities. */
 104         unsigned long long costs;                /**< The costs of the current coloring. */
 105         unsigned long long unsatisfied_edges;    /**< The number of unequally colored affinity edges. */
 106 } co_complete_stats_t;
 107
 108 /**
 109  * Collect statistics of a copy optimization module.
 110  * @param co    The copy optimization environment.
 111  * @param stat  Where to put the stats.
 112  * @note  This requires the graph info to be computed.
 113  */
 114 void co_complete_stats(const copy_opt_t *co, co_complete_stats_t *stat);
 115
 116
 117 /**
 118  * Build internal optimization units structure
 119  */
 120 void co_build_ou_structure(copy_opt_t *co);
 121
 122 /**
 123  * Frees the space used by the opt unit representation.
 124  * Does NOT free the whole copyopt structure
 125  */
 126 void co_free_ou_structure(copy_opt_t *co);
 127
 128 /**
 129  * Solves the problem using a heuristic approach
 130  * Uses the OU data structure
 131  */
 132 int co_solve_heuristic(copy_opt_t *co);
 133
 134 /**
 135  * Returns the maximal costs possible, i.e. the costs if all
 136  * pairs would be assigned different registers.
 137  * Uses the OU data structure
 138  */
 139 int co_get_max_copy_costs(const copy_opt_t *co);
 140
 141 /**
 142  * Returns the inevitable costs, i.e. the costs of
 143  * all copy pairs which interfere.
 144  * Uses the OU data structure
 145  */
 146 int co_get_inevit_copy_costs(const copy_opt_t *co);
 147
 148 /**
 149  * Returns the current costs the copies are causing.
 150  * The result includes inevitable costs and the costs
 151  * of the copies regarding the current register allocation
 152  * Uses the OU data structure
 153  */
 154 int co_get_copy_costs(const copy_opt_t *co);
 155
 156 /**
 157  * Returns a lower bound for the costs of copies in this ou.
 158  * The result includes inevitable costs and the costs of a
 159  * minimal costs caused by the nodes of the ou.
 160  * Uses the OU data structure
 161  */
 162 int co_get_lower_bound(const copy_opt_t *co);
 163
 164 /**
 165  * Dump the interference graph according to the Appel/George coalescing contest file format.
 166  * See: http://www.cs.princeton.edu/~appel/coalesce/format.html
 167  * @note Requires graph structure.
 168  * @param co The copy opt object.
 169  * @param f  A file to dump to.
 170  */
 171 void co_dump_appel_graph(const copy_opt_t *co, FILE *f);
 172
 173 /**
 174  * Dumps the IFG of the program splitting after each instruction in the Appel format.
 175  * @param co The copy opt object.
 176  * @param f  The file to dump to.
 177  */
 178 void co_dump_appel_graph_cliques(const copy_opt_t *co, FILE *f);
 179 /**
 180  * Dump the interference graph with the affinity edges and the coloring.
 181  * @param co    The copy opt structure.
 182  * @param f     The file to dump to.
 183  * @param flags The dump flags (see enum above).
 184  */
 185 void co_dump_ifg_dot(const copy_opt_t *co, FILE *f, unsigned flags);
 186
 187 /**
 188  * Constructs another internal representation of the affinity edges
 189  */
 190 void co_build_graph_structure(copy_opt_t *co);
 191
 192 /**
 193  * Frees the space used by the graph representation.
 194  * Does NOT free the whole copyopt structure
 195  */
 196 void co_free_graph_structure(copy_opt_t *co);
 197
 198 /**
 199  * Checks if a node is optimizable, viz has something to do with coalescing.
 200  * Uses the GRAPH data structure
 201  */
 202 int co_gs_is_optimizable(copy_opt_t *co, ir_node *irn);
 203
 204 #endif