2 * Copyright (C) 1995-2007 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
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.
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.
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
22 * @brief Main spill driver.
23 * @author Daniel Grund, Sebastian Hack, Matthias Braun
27 #ifndef FIRM_BE_BESPILL_H
28 #define FIRM_BE_BESPILL_H
30 #include "firm_types.h"
36 typedef struct spill_env_t spill_env_t;
39 * Creates a new spill environment.
41 spill_env_t *be_new_spill_env(be_irg_t *birg);
44 * Deletes a spill environment.
46 void be_delete_spill_env(spill_env_t *senv);
49 * Inserts a new entry into the list of reloads to place (the real nodes will
50 * be created when be_insert_spills_reloads is run). You don't have to
51 * explicitly create spill nodes, they will be created automatically after
52 * the definition of a value as soon as a reload is created. (we should add a
53 * possibility for explicit spill placement in the future)
55 * @param senv The spill environment
56 * @param to_spill The node which is about to be spilled
57 * @param before The node before the reload should be added
58 * @param reload_cls The register class the reloaded value will be put into
59 * @param allow_remat Set to 1 if the node may be rematerialized instead of reloaded
61 void be_add_reload(spill_env_t *senv, ir_node *to_spill, ir_node *before,
62 const arch_register_class_t *reload_cls, int allow_remat);
65 * Analog to be_add_reload, but places the reload "on an edge" between 2 blocks
68 void be_add_reload_on_edge(spill_env_t *senv, ir_node *to_spill, ir_node *bl, int pos,
69 const arch_register_class_t *reload_cls, int allow_remat);
72 * Analog to be_add_reload but adds an already created rematerialized node.
74 void be_add_remat(spill_env_t *env, ir_node *to_spill, ir_node *before, ir_node *rematted_node);
77 * The main function that places real spills/reloads (or rematerializes values)
78 * for all values where be_add_reload was called. It then rebuilds the
79 * SSA-form and updates liveness information
81 void be_insert_spills_reloads(spill_env_t *senv);
84 * There are 2 possibilities to spill a phi node: Only it's value, or replacing
85 * the whole phi-node with a memory phi. Normally only the value of a phi will
86 * be spilled unless you mark the phi with be_spill_phi.
87 * (Remember that each phi needs a register, so you have to spill phis when
88 * there are more phis than registers in a block)
90 void be_spill_phi(spill_env_t *env, ir_node *node);
93 * Returns the estimated costs if a node would get reloaded at a specific place
94 * This usually returns the cost of spill + reload operation. But might return
95 * smaller values if the value has already been spilled in a former run or
96 * when it is possible to rematerialize the value.
98 int be_get_reload_costs(spill_env_t *env, ir_node *to_spill, ir_node *before);
101 * Analog to be_get_reload_costs but returns the cost if the reload would be
102 * placed "on an edge" between 2 blocks
104 int be_get_reload_costs_on_edge(spill_env_t *env, ir_node *to_spill, ir_node *block, int pos);
106 #endif /* FIRM_BE_BESPILL_H */