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 /**
  50  * Inserts a new entry into the list of reloads to place (the real nodes will
  51  * be created when be_insert_spills_reloads is run). You don't have to
  52  * explicitly create spill nodes, they will be created automatically after
  53  * the definition of a value as soon as a reload is created. (we should add a
  54  * possibility for explicit spill placement in the future)
  55  *
  56  * @param senv        The spill environment
  57  * @param to_spill    The node which is about to be spilled
  58  * @param before      The node before the reload should be added
  59  * @param reload_cls  The register class the reloaded value will be put into
  60  * @param allow_remat Set to 1 if the node may be rematerialized instead of
  61  *                    reloaded
  62  */
  63 void be_add_reload(spill_env_t *senv, ir_node *to_spill, ir_node *before,
  64                    const arch_register_class_t *reload_cls, int allow_remat);
  65
  66 void be_add_reload_at_end(spill_env_t *env, ir_node *to_spill, ir_node *block,
  67                           const arch_register_class_t *reload_cls,
  68                           int allow_remat);
  69
  70 /**
  71  * Analog to be_add_reload, but places the reload "on an edge" between 2 blocks
  72  * @see be_add_reload
  73  */
  74 void be_add_reload_on_edge(spill_env_t *senv, ir_node *to_spill, ir_node *bl,
  75                            int pos, const arch_register_class_t *reload_cls,
  76                            int allow_remat);
  77
  78 /**
  79  * Analog to be_add_reload but adds an already created rematerialized node.
  80  */
  81 void be_add_remat(spill_env_t *env, ir_node *to_spill, ir_node *before,
  82                   ir_node *rematted_node);
  83
  84 /**
  85  * The main function that places real spills/reloads (or rematerializes values)
  86  * for all values where be_add_reload was called. It then rebuilds the
  87  * SSA-form and updates liveness information
  88  */
  89 void be_insert_spills_reloads(spill_env_t *senv);
  90
  91 /**
  92  * There are 2 possibilities to spill a phi node: Only it's value, or replacing
  93  * the whole phi-node with a memory phi. Normally only the value of a phi will
  94  * be spilled unless you mark the phi with be_spill_phi.
  95  * (Remember that each phi needs a register, so you have to spill phis when
  96  *  there are more phis than registers in a block)
  97  */
  98 void be_spill_phi(spill_env_t *env, ir_node *node);
  99
 100 /**
 101  * Returns the estimated costs if a node would ge spilled. This does only return
 102  * the costs for the spill instructions, not the costs for needed reload
 103  * instructions. The value is weighted by the estimated execution frequency of
 104  * the spill.
 105  */
 106 double be_get_spill_costs(spill_env_t *env, ir_node *to_spill, ir_node *after);
 107
 108 /**
 109  * Returns the estimated costs if a node would get reloaded at a specific place
 110  * This returns the costs for a reload instructions, or when possible the costs
 111  * for a rematerialisation. The value is weighted by the estimated execution
 112  * frequency of the reload/rematerialisation.
 113  */
 114 double be_get_reload_costs(spill_env_t *env, ir_node *to_spill,
 115                            ir_node *before);
 116
 117 /**
 118  * Analog to be_get_reload_costs but returns the cost if the reload would be
 119  * placed "on an edge" between 2 blocks
 120  */
 121 double be_get_reload_costs_on_edge(spill_env_t *env, ir_node *to_spill,
 122                                    ir_node *block, int pos);
 123
 124 #endif