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