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 <stdbool.h>
  35
  36 #include "firm_types.h"
  37 #include "bechordal.h"
  38
  39 typedef int(*cost_fct_t)(const ir_node *node, int input);
  40
  41 typedef struct {
  42         int (*copyopt)(copy_opt_t *co); /**< function ptr to run copyopt */
  43         bool can_improve_existing;
  44 } co_algo_info;
  45
  46 /**
  47  * Register a new copy optimization algorithm.
  48  *
  49  * @param name     the name of the copy optimazation algorithm,
  50  *                 used to select it
  51  * @param copyopt  a copy optimazation entry
  52  */
  53 void be_register_copyopt(const char *name, co_algo_info *copyopt);
  54
  55 /** The driver for copy minimization. */
  56 void co_driver(be_chordal_env_t *cenv);
  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  * Statistics over a copy optimization module.
  70  */
  71 typedef struct {
  72         unsigned long long aff_edges;            /**< number of affinity edges. */
  73         unsigned long long aff_nodes;            /**< number of nodes with incident affinity edges. */
  74         unsigned long long aff_int;              /**< number of affinity edges whose nodes also interfere. */
  75         unsigned long long inevit_costs;         /**< costs which cannot be evited (due to interfering affinities). */
  76         unsigned long long max_costs;            /**< all costs of the affinities. */
  77         unsigned long long costs;                /**< The costs of the current coloring. */
  78         unsigned long long unsatisfied_edges;    /**< The number of unequally colored affinity edges. */
  79 } co_complete_stats_t;
  80
  81 /**
  82  * Collect statistics of a copy optimization module.
  83  * @param co    The copy optimization environment.
  84  * @param stat  Where to put the stats.
  85  * @note  This requires the graph info to be computed.
  86  */
  87 void co_complete_stats(const copy_opt_t *co, co_complete_stats_t *stat);
  88
  89
  90 /**
  91  * Build internal optimization units structure
  92  */
  93 void co_build_ou_structure(copy_opt_t *co);
  94
  95 /**
  96  * Frees the space used by the opt unit representation.
  97  * Does NOT free the whole copyopt structure
  98  */
  99 void co_free_ou_structure(copy_opt_t *co);
 100
 101 /**
 102  * Solves the problem using a heuristic approach
 103  * Uses the OU data structure
 104  */
 105 int co_solve_heuristic(copy_opt_t *co);
 106
 107 /**
 108  * Returns the maximal costs possible, i.e. the costs if all
 109  * pairs would be assigned different registers.
 110  * Uses the OU data structure
 111  */
 112 int co_get_max_copy_costs(const copy_opt_t *co);
 113
 114 /**
 115  * Returns the inevitable costs, i.e. the costs of
 116  * all copy pairs which interfere.
 117  * Uses the OU data structure
 118  */
 119 int co_get_inevit_copy_costs(const copy_opt_t *co);
 120
 121 /**
 122  * Returns the current costs the copies are causing.
 123  * The result includes inevitable costs and the costs
 124  * of the copies regarding the current register allocation
 125  * Uses the OU data structure
 126  */
 127 int co_get_copy_costs(const copy_opt_t *co);
 128
 129 /**
 130  * Returns a lower bound for the costs of copies in this ou.
 131  * The result includes inevitable costs and the costs of a
 132  * minimal costs caused by the nodes of the ou.
 133  * Uses the OU data structure
 134  */
 135 int co_get_lower_bound(const copy_opt_t *co);
 136
 137 /**
 138  * Constructs another internal representation of the affinity edges
 139  */
 140 void co_build_graph_structure(copy_opt_t *co);
 141
 142 /**
 143  * Frees the space used by the graph representation.
 144  * Does NOT free the whole copyopt structure
 145  */
 146 void co_free_graph_structure(copy_opt_t *co);
 147
 148 /**
 149  * Checks if a node is optimizable, viz has something to do with coalescing.
 150  * Uses the GRAPH data structure
 151  */
 152 int co_gs_is_optimizable(copy_opt_t *co, ir_node *irn);
 153
 154 #endif