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

   1 /*
   2  * Author:      Daniel Grund, Sebastian Hack, Matthias Braun
   3  * Date:                29.09.2005
   4  * Copyright:   (c) Universitaet Karlsruhe
   5  * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
   6  */
   7 #ifndef BESPILL_H_
   8 #define BESPILL_H_
   9
  10 #include "firm_types.h"
  11 #include "set.h"
  12 #include "pset.h"
  13 #include "debug.h"
  14
  15 #include "bechordal.h"
  16 #include "be_t.h"
  17
  18 #include "bearch.h"
  19
  20 typedef struct _spill_env_t spill_env_t;
  21
  22 /**
  23  * Creates a new spill environment.
  24  */
  25 spill_env_t *be_new_spill_env(be_irg_t *birg);
  26
  27 /**
  28  * Deletes a spill environment.
  29  */
  30 void be_delete_spill_env(spill_env_t *senv);
  31
  32 /**
  33  * Sets the debug module of a spill environment.
  34  */
  35 DEBUG_ONLY(void be_set_spill_env_dbg_module(spill_env_t *env, firm_dbg_module_t *dbg));
  36
  37 /**
  38  * Inserts a new entry into the list of reloads to place (the real nodes will
  39  * be created when be_insert_spills_reloads is run). You don't have to
  40  * explicitly create spill nodes, they will be created automatically after
  41  * the definition of a value as soon as a reload is created. (we should add a
  42  * possibility for explicit spill placement in the future)
  43  *
  44  * @param senv        The spill environment
  45  * @param to_spill    The node which is about to be spilled
  46  * @param before      The node before the reload should be added
  47  * @param reload_cls  The register class the reloaded value will be put into
  48  * @param allow_remat Set to 1 if the node may be rematerialized instead of reloaded
  49  */
  50 void be_add_reload(spill_env_t *senv, ir_node *to_spill, ir_node *before,
  51         const arch_register_class_t *reload_cls, int allow_remat);
  52
  53 /**
  54  * Analog to be_add_reload, but places the reload "on an edge" between 2 blocks
  55  * @see be_add_reload
  56  */
  57 void be_add_reload_on_edge(spill_env_t *senv, ir_node *to_spill, ir_node *bl, int pos,
  58         const arch_register_class_t *reload_cls, int allow_remat);
  59
  60 /**
  61  * Analog to be_add_reload but adds an already created rematerialized node.
  62  */
  63 void be_add_remat(spill_env_t *env, ir_node *to_spill, ir_node *before, ir_node *rematted_node);
  64
  65 /**
  66  * The main function that places real spills/reloads (or rematerializes values)
  67  * for all values where be_add_reload was called. It then rebuilds the
  68  * SSA-form and updates liveness information
  69  */
  70 void be_insert_spills_reloads(spill_env_t *senv);
  71
  72 /**
  73  * There are 2 possibilities to spill a phi node: Only it's value, or replacing
  74  * the whole phi-node with a memory phi. Normally only the value of a phi will
  75  * be spilled unless you mark the phi with be_spill_phi.
  76  * (Remember that each phi needs a register, so you have to spill phis when
  77  *  there are more phis than registers in a block)
  78  */
  79 void be_spill_phi(spill_env_t *env, ir_node *node);
  80
  81 /**
  82  * Returns the estimated costs if a node would get reloaded at a specific place
  83  * This usually returns the cost of spill + reload operation. But might return
  84  * smaller values if the value has already been spilled in a former run or
  85  * when it is possible to rematerialize the value.
  86  */
  87 int be_get_reload_costs(spill_env_t *env, ir_node *to_spill, ir_node *before);
  88
  89 /**
  90  * Analog to be_get_reload_costs but returns the cost if the reload would be
  91  * placed "on an edge" between 2 blocks
  92  */
  93 int be_get_reload_costs_on_edge(spill_env_t *env, ir_node *to_spill, ir_node *block, int pos);
  94
  95 #endif