nsz Git - libfirm/blob - ir/be/bespill.h

   1 /*
   2  * Copyright (C) 1995-2007 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_BESPILL_H
  29 #define FIRM_BE_BESPILL_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(be_irg_t *birg);
  43
  44 /**
  45  * Deletes a spill environment.
  46  */
  47 void be_delete_spill_env(spill_env_t *senv);
  48
  49 ir_node *be_get_end_of_block_insertion_point(const ir_node *block);
  50
  51 /**
  52  * Inserts a new entry into the list of reloads to place (the real nodes will
  53  * be created when be_insert_spills_reloads is run). You don't have to
  54  * explicitly create spill nodes, they will be created automatically after
  55  * the definition of a value as soon as a reload is created. (we should add a
  56  * possibility for explicit spill placement in the future)
  57  *
  58  * @param senv        The spill environment
  59  * @param to_spill    The node which is about to be spilled
  60  * @param before      The node before the reload should be added
  61  * @param reload_cls  The register class the reloaded value will be put into
  62  * @param allow_remat Set to 1 if the node may be rematerialized instead of
  63  *                    reloaded
  64  */
  65 void be_add_reload(spill_env_t *senv, ir_node *to_spill, ir_node *before,
  66                    const arch_register_class_t *reload_cls, int allow_remat);
  67
  68 /**
  69  * Add a reload at the end of a block.
  70  * Similar to be_add_reload_on_edge().
  71  */
  72 void be_add_reload_at_end(spill_env_t *env, ir_node *to_spill, const ir_node *block,
  73                           const arch_register_class_t *reload_cls,
  74                           int allow_remat);
  75
  76 /**
  77  * Analog to be_add_reload, but places the reload "on an edge" between 2 blocks
  78  * @see be_add_reload
  79  */
  80 void be_add_reload_on_edge(spill_env_t *senv, ir_node *to_spill, ir_node *bl,
  81                            int pos, const arch_register_class_t *reload_cls,
  82                            int allow_remat);
  83
  84 /**
  85  * Analog to be_add_reload but adds an already created rematerialized node.
  86  */
  87 void be_add_remat(spill_env_t *env, ir_node *to_spill, ir_node *before,
  88                   ir_node *rematted_node);
  89
  90 /**
  91  * The main function that places real spills/reloads (or rematerializes values)
  92  * for all values where be_add_reload was called. It then rebuilds the
  93  * SSA-form and updates liveness information
  94  */
  95 void be_insert_spills_reloads(spill_env_t *senv);
  96
  97 /**
  98  * There are 2 possibilities to spill a phi node: Only it's value, or replacing
  99  * the whole phi-node with a memory phi. Normally only the value of a phi will
 100  * be spilled unless you mark the phi with be_spill_phi.
 101  * (Remember that each phi needs a register, so you have to spill phis when
 102  *  there are more phis than registers in a block)
 103  */
 104 void be_spill_phi(spill_env_t *env, ir_node *node);
 105
 106 /**
 107  * Returns the estimated costs if a node would ge spilled. This does only return
 108  * the costs for the spill instructions, not the costs for needed reload
 109  * instructions. The value is weighted by the estimated execution frequency of
 110  * the spill.
 111  */
 112 double be_get_spill_costs(spill_env_t *env, ir_node *to_spill, ir_node *after);
 113
 114 /**
 115  * Returns the estimated costs if a node would get reloaded at a specific place
 116  * This returns the costs for a reload instructions, or when possible the costs
 117  * for a rematerialisation. The value is weighted by the estimated execution
 118  * frequency of the reload/rematerialisation.
 119  */
 120 double be_get_reload_costs(spill_env_t *env, ir_node *to_spill,
 121                            ir_node *before);
 122
 123 /**
 124  * Analog to be_get_reload_costs but returns the cost if the reload would be
 125  * placed "on an edge" between 2 blocks
 126  */
 127 double be_get_reload_costs_on_edge(spill_env_t *env, ir_node *to_spill,
 128                                    ir_node *block, int pos);
 129
 130 typedef struct {
 131         unsigned n_spills;
 132         unsigned n_reloads;
 133         double spill_costs;
 134         double reload_costs;
 135 } be_total_spill_costs_t;
 136
 137 /**
 138  * Collect spill/reload cost statistics for a graph.
 139  * @param birg   The backend graph.
 140  * @param costs  A struct which will be filled with the costs.
 141  */
 142 void be_get_total_spill_costs(be_irg_t *birg, be_total_spill_costs_t *costs);
 143
 144 /**
 145  * Check, if a node is rematerializable.
 146  * @param env  The spill env.
 147
 148  */
 149 int be_is_rematerializable(spill_env_t *env, const ir_node *to_remat, const ir_node *before);
 150
 151 #endif