nsz Git - libfirm/blob - ir/be/bespillutil.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       higher level abstraction for the creation of spill and reload
  23  *              instructions and rematerialisation of values.
  24  * @author      Daniel Grund, Sebastian Hack, Matthias Braun
  25  * @date        29.09.2005
  26  */
  27 #ifndef FIRM_BE_BESPILLUTIL_H
  28 #define FIRM_BE_BESPILLUTIL_H
  29
  30 #include "firm_types.h"
  31 #include "debug.h"
  32
  33 #include "bearch.h"
  34 #include "beirg.h"
  35
  36 typedef struct spill_env_t spill_env_t;
  37
  38 /**
  39  * Creates a new spill environment.
  40  */
  41 spill_env_t *be_new_spill_env(ir_graph *irg);
  42
  43 /**
  44  * Deletes a spill environment.
  45  */
  46 void be_delete_spill_env(spill_env_t *senv);
  47
  48 /**
  49  * Return the last control flow node of a block.
  50  */
  51 ir_node *be_get_end_of_block_insertion_point(const ir_node *block);
  52
  53 /**
  54  * Marks a point until which a node must be spilled.
  55  */
  56 void be_add_spill(spill_env_t *senv, ir_node *to_spill, ir_node *after);
  57
  58 /**
  59  * Inserts a new entry into the list of reloads to place (the real nodes will
  60  * be created when be_insert_spills_reloads is run). You don't have to
  61  * explicitly create spill nodes, they will be created automatically after
  62  * the definition of a value as soon as a reload is created. (we should add a
  63  * possibility for explicit spill placement in the future)
  64  *
  65  * @param senv        The spill environment
  66  * @param to_spill    The node which is about to be spilled
  67  * @param before      The node before the reload should be added
  68  * @param reload_cls  The register class the reloaded value will be put into
  69  * @param allow_remat Set to 1 if the node may be rematerialized instead of
  70  *                    reloaded
  71  */
  72 void be_add_reload(spill_env_t *senv, ir_node *to_spill, ir_node *before,
  73                    const arch_register_class_t *reload_cls, int allow_remat);
  74
  75 void be_add_reload2(spill_env_t *senv, ir_node *to_spill, ir_node *before, ir_node *can_spill_after,
  76                    const arch_register_class_t *reload_cls, int allow_remat);
  77
  78 /**
  79  * Add a reload at the end of a block.
  80  * Similar to be_add_reload_on_edge().
  81  */
  82 void be_add_reload_at_end(spill_env_t *env, ir_node *to_spill, const ir_node *block,
  83                           const arch_register_class_t *reload_cls,
  84                           int allow_remat);
  85
  86 /**
  87  * Analog to be_add_reload, but places the reload "on an edge" between 2 blocks
  88  * @see be_add_reload
  89  */
  90 void be_add_reload_on_edge(spill_env_t *senv, ir_node *to_spill, ir_node *bl,
  91                            int pos, const arch_register_class_t *reload_cls,
  92                            int allow_remat);
  93
  94 /**
  95  * The main function that places real spills/reloads (or rematerializes values)
  96  * for all values where be_add_reload was called. It then rebuilds the
  97  * SSA-form and updates liveness information
  98  */
  99 void be_insert_spills_reloads(spill_env_t *senv);
 100
 101 /**
 102  * There are 2 possibilities to spill a phi node: Only its value, or replacing
 103  * the whole phi-node with a memory phi. Normally only the value of a phi will
 104  * be spilled unless you mark the phi with be_spill_phi.
 105  * (Remember that each phi needs a register, so you have to spill phis when
 106  *  there are more phis than registers in a block)
 107  */
 108 void be_spill_phi(spill_env_t *env, ir_node *node);
 109
 110 /**
 111  * Returns the estimated costs if a node would ge spilled. This does only return
 112  * the costs for the spill instructions, not the costs for needed reload
 113  * instructions. The value is weighted by the estimated execution frequency of
 114  * the spill.
 115  */
 116 double be_get_spill_costs(spill_env_t *env, ir_node *to_spill, ir_node *before);
 117
 118 /**
 119  * Returns the estimated costs if a node would get reloaded at a specific place
 120  * This returns the costs for a reload instructions, or when possible the costs
 121  * for a rematerialisation. The value is weighted by the estimated execution
 122  * frequency of the reload/rematerialisation.
 123  */
 124 double be_get_reload_costs(spill_env_t *env, ir_node *to_spill,
 125                            ir_node *before);
 126
 127 unsigned be_get_reload_costs_no_weight(spill_env_t *env, const ir_node *to_spill,
 128                                        const ir_node *before);
 129
 130
 131 /**
 132  * Analog to be_get_reload_costs but returns the cost if the reload would be
 133  * placed "on an edge" between 2 blocks
 134  */
 135 double be_get_reload_costs_on_edge(spill_env_t *env, ir_node *to_spill,
 136                                    ir_node *block, int pos);
 137
 138 typedef struct {
 139         unsigned n_spills;
 140         unsigned n_reloads;
 141         double spill_costs;
 142         double reload_costs;
 143 } be_total_spill_costs_t;
 144
 145 /**
 146  * Insert a spill after the definition of the given node if there is a reload that is not dominated by some spill.
 147  * This function checks whether there is a reload that is not dominated by some spill for that node.
 148  * If so, it inserts a spill right after the definition of the node.
 149  * @param env The spill environment.
 150  * @param irn The node to check for.
 151  */
 152 void make_spill_locations_dominate_irn(spill_env_t *env, ir_node *irn);
 153
 154 /**
 155  * Collect spill/reload cost statistics for a graph.
 156  * @param irg    The graph.
 157  * @param costs  A struct which will be filled with the costs.
 158  */
 159 void be_get_total_spill_costs(ir_graph *irg, be_total_spill_costs_t *costs);
 160
 161 /**
 162  * Check, if a node is rematerializable.
 163  * @param env  The spill env.
 164
 165  */
 166 int be_is_rematerializable(spill_env_t *env, const ir_node *to_remat, const ir_node *before);
 167
 168 /**
 169  * Create a be_Spill node. This function is compatible to the
 170  * arch_env->new_spill callback.
 171  */
 172 ir_node *be_new_spill(ir_node *value, ir_node *after);
 173
 174 /**
 175  * Create a be_Reload node. This function is compatible to the
 176  * arch_env->new_reload interface.
 177  */
 178 ir_node *be_new_reload(ir_node *value, ir_node *spilled, ir_node *before);
 179
 180 #endif