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