2 * Copyright (C) 1995-2008 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 Helper functions for handling ABI constraints in the code
24 * @author Matthias Braun
27 #ifndef FIRM_BE_BEABI_HELPER_H
28 #define FIRM_BE_BEABI_HELPER_H
30 #include "firm_types.h"
33 typedef struct beabi_helper_env_t beabi_helper_env_t;
35 beabi_helper_env_t *be_abihelper_prepare(ir_graph *irg);
37 void be_abihelper_finish(beabi_helper_env_t *env);
40 * Mark a registers value at the beginning of the function as significant.
41 * This is necessary for things like:
42 * - Callee-Save registers (we need to restore that value at the end)
43 * - Parameters passed in registers
44 * - stack pointer, base pointer, ...
45 * It is possible to specify additional irn flags (usefull to mark a value
46 * as ignore or produces_sp).
48 void be_prolog_add_reg(beabi_helper_env_t *env, const arch_register_t *reg,
49 arch_irn_flags_t flags);
52 * Creates a start node.
53 * Must be called after all prolog_add_reg calls
55 ir_node *be_prolog_create_start(beabi_helper_env_t *env, dbg_info *dbgi,
59 * Creates a barrier node which lets all registers specified by prolog_add_reg
62 ir_node *be_prolog_create_barrier(beabi_helper_env_t *env, ir_node *block);
65 * Get "value" of a register.
66 * This usually creates a Proj node for the start-node or barrier-node.
67 * Or returns the value set by a abi_helper_set_reg_value call
69 ir_node *be_prolog_get_reg_value(beabi_helper_env_t *env,
70 const arch_register_t *reg);
72 ir_node *be_prolog_get_memory(beabi_helper_env_t *env);
75 * Set current register value.
77 void be_prolog_set_reg_value(beabi_helper_env_t *env,
78 const arch_register_t *reg, ir_node *value);
80 void be_prolog_set_memory(beabi_helper_env_t *env, ir_node *value);
83 * Set value of register at the end of the function. Necessary for:
84 * - Callee-save registers
85 * - Return values in registers
86 * - stack pointer, base pointer
88 void be_epilog_add_reg(beabi_helper_env_t *env, const arch_register_t *reg,
89 arch_irn_flags_t flags, ir_node *value);
91 void be_epilog_set_reg_value(beabi_helper_env_t *env,
92 const arch_register_t *reg, ir_node *value);
94 ir_node *be_epilog_get_reg_value(beabi_helper_env_t *env,
95 const arch_register_t *reg);
97 void be_epilog_set_memory(beabi_helper_env_t *env, ir_node *value);
99 ir_node *be_epilog_get_memory(beabi_helper_env_t *env);
101 void be_epilog_begin(beabi_helper_env_t *env);
103 ir_node *be_epilog_create_barrier(beabi_helper_env_t *env, ir_node *block);
106 * Create return node and finishes epilog handling
108 ir_node *be_epilog_create_return(beabi_helper_env_t *env, dbg_info *dbgi,
112 * Adds a X->Proj->Keep for each output value of X which has no Proj yet
114 void be_add_missing_keeps(ir_graph *irg);
117 * Collect firm nodes that will probably modify the stack.
118 * Put them into an order that respects all their dependencies.
120 void be_collect_stacknodes(beabi_helper_env_t *env);
123 * return node that should produce the predecessor stack node in a block.
124 * returns NULL if there's no predecessor in the current block.
126 ir_node *be_get_stack_pred(const beabi_helper_env_t *env, const ir_node *node);