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  * Author:      Daniel Grund, Sebastian Hack, Matthias Braun
  22  * Date:                29.09.2005
  23  * Copyright:   (c) Universitaet Karlsruhe
  24  * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
  25  */
  26 #ifndef BESPILL_H_
  27 #define BESPILL_H_
  28
  29 #include "firm_types.h"
  30 #include "set.h"
  31 #include "pset.h"
  32 #include "debug.h"
  33
  34 #include "bechordal.h"
  35 #include "be_t.h"
  36
  37 #include "bearch_t.h"
  38
  39 typedef struct _spill_env_t spill_env_t;
  40
  41 /**
  42  * Creates a new spill environment.
  43  */
  44 spill_env_t *be_new_spill_env(be_irg_t *birg);
  45
  46 /**
  47  * Deletes a spill environment.
  48  */
  49 void be_delete_spill_env(spill_env_t *senv);
  50
  51 /**
  52  * Sets the debug module of a spill environment.
  53  */
  54 DEBUG_ONLY(void be_set_spill_env_dbg_module(spill_env_t *env, firm_dbg_module_t *dbg));
  55
  56 /**
  57  * Inserts a new entry into the list of reloads to place (the real nodes will
  58  * be created when be_insert_spills_reloads is run). You don't have to
  59  * explicitly create spill nodes, they will be created automatically after
  60  * the definition of a value as soon as a reload is created. (we should add a
  61  * possibility for explicit spill placement in the future)
  62  *
  63  * @param senv        The spill environment
  64  * @param to_spill    The node which is about to be spilled
  65  * @param before      The node before the reload should be added
  66  * @param reload_cls  The register class the reloaded value will be put into
  67  * @param allow_remat Set to 1 if the node may be rematerialized instead of reloaded
  68  */
  69 void be_add_reload(spill_env_t *senv, ir_node *to_spill, ir_node *before,
  70         const arch_register_class_t *reload_cls, int allow_remat);
  71
  72 /**
  73  * Analog to be_add_reload, but places the reload "on an edge" between 2 blocks
  74  * @see be_add_reload
  75  */
  76 void be_add_reload_on_edge(spill_env_t *senv, ir_node *to_spill, ir_node *bl, int pos,
  77         const arch_register_class_t *reload_cls, int allow_remat);
  78
  79 /**
  80  * Analog to be_add_reload but adds an already created rematerialized node.
  81  */
  82 void be_add_remat(spill_env_t *env, ir_node *to_spill, ir_node *before, 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 get reloaded at a specific place
 102  * This usually returns the cost of spill + reload operation. But might return
 103  * smaller values if the value has already been spilled in a former run or
 104  * when it is possible to rematerialize the value.
 105  */
 106 int be_get_reload_costs(spill_env_t *env, ir_node *to_spill, ir_node *before);
 107
 108 /**
 109  * Analog to be_get_reload_costs but returns the cost if the reload would be
 110  * placed "on an edge" between 2 blocks
 111  */
 112 int be_get_reload_costs_on_edge(spill_env_t *env, ir_node *to_spill, ir_node *block, int pos);
 113
 114 #endif