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       Main spill driver.
  23  * @author      Daniel Grund, Sebastian Hack, Matthias Braun
  24  * @date                29.09.2005
  25  * @version     $Id$
  26  */
  27 #ifndef FIRM_BE_BESPILL_H
  28 #define FIRM_BE_BESPILL_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(be_irg_t *birg);
  42
  43 /**
  44  * Deletes a spill environment.
  45  */
  46 void be_delete_spill_env(spill_env_t *senv);
  47
  48 /**
  49  * Sets the debug module of a spill environment.
  50  */
  51 DEBUG_ONLY(void be_set_spill_env_dbg_module(spill_env_t *env, firm_dbg_module_t *dbg));
  52
  53 /**
  54  * Inserts a new entry into the list of reloads to place (the real nodes will
  55  * be created when be_insert_spills_reloads is run). You don't have to
  56  * explicitly create spill nodes, they will be created automatically after
  57  * the definition of a value as soon as a reload is created. (we should add a
  58  * possibility for explicit spill placement in the future)
  59  *
  60  * @param senv        The spill environment
  61  * @param to_spill    The node which is about to be spilled
  62  * @param before      The node before the reload should be added
  63  * @param reload_cls  The register class the reloaded value will be put into
  64  * @param allow_remat Set to 1 if the node may be rematerialized instead of reloaded
  65  */
  66 void be_add_reload(spill_env_t *senv, ir_node *to_spill, ir_node *before,
  67         const arch_register_class_t *reload_cls, int allow_remat);
  68
  69 /**
  70  * Analog to be_add_reload, but places the reload "on an edge" between 2 blocks
  71  * @see be_add_reload
  72  */
  73 void be_add_reload_on_edge(spill_env_t *senv, ir_node *to_spill, ir_node *bl, int pos,
  74         const arch_register_class_t *reload_cls, int allow_remat);
  75
  76 /**
  77  * Analog to be_add_reload but adds an already created rematerialized node.
  78  */
  79 void be_add_remat(spill_env_t *env, ir_node *to_spill, ir_node *before, ir_node *rematted_node);
  80
  81 /**
  82  * The main function that places real spills/reloads (or rematerializes values)
  83  * for all values where be_add_reload was called. It then rebuilds the
  84  * SSA-form and updates liveness information
  85  */
  86 void be_insert_spills_reloads(spill_env_t *senv);
  87
  88 /**
  89  * There are 2 possibilities to spill a phi node: Only it's value, or replacing
  90  * the whole phi-node with a memory phi. Normally only the value of a phi will
  91  * be spilled unless you mark the phi with be_spill_phi.
  92  * (Remember that each phi needs a register, so you have to spill phis when
  93  *  there are more phis than registers in a block)
  94  */
  95 void be_spill_phi(spill_env_t *env, ir_node *node);
  96
  97 /**
  98  * Returns the estimated costs if a node would get reloaded at a specific place
  99  * This usually returns the cost of spill + reload operation. But might return
 100  * smaller values if the value has already been spilled in a former run or
 101  * when it is possible to rematerialize the value.
 102  */
 103 int be_get_reload_costs(spill_env_t *env, ir_node *to_spill, ir_node *before);
 104
 105 /**
 106  * Analog to be_get_reload_costs but returns the cost if the reload would be
 107  * placed "on an edge" between 2 blocks
 108  */
 109 int be_get_reload_costs_on_edge(spill_env_t *env, ir_node *to_spill, ir_node *block, int pos);
 110
 111 #endif /* FIRM_BE_BESPILL_H */