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"
34 typedef struct beabi_helper_env_t beabi_helper_env_t;
35 typedef struct be_stackorder_t be_stackorder_t;
38 * Creates a helper object for the ABI constraint handling.
40 beabi_helper_env_t *be_abihelper_prepare(ir_graph *irg);
43 * Terminates a helper object for the ABI constraint handling.
45 void be_abihelper_finish(beabi_helper_env_t *env);
48 * Mark a registers value at the beginning of the function as significant.
49 * This is necessary for things like:
50 * - Callee-Save registers (we need to restore that value at the end)
51 * - Parameters passed in registers
52 * - stack pointer, base pointer, ...
53 * It is possible to specify additional irn flags (useful to mark a value
54 * as ignore or produces_sp).
56 void be_prolog_add_reg(beabi_helper_env_t *env, const arch_register_t *reg,
57 arch_register_req_type_t flags);
60 * Creates a start node.
61 * Must be called after all prolog_add_reg calls
63 ir_node *be_prolog_create_start(beabi_helper_env_t *env, dbg_info *dbgi,
67 * Get "value" of a register.
68 * This usually creates a Proj node for the start-node.
69 * Or returns the value set by a abi_helper_set_reg_value call
71 ir_node *be_prolog_get_reg_value(beabi_helper_env_t *env,
72 const arch_register_t *reg);
74 ir_node *be_prolog_get_memory(beabi_helper_env_t *env);
77 * Set current register value.
79 void be_prolog_set_reg_value(beabi_helper_env_t *env,
80 const arch_register_t *reg, ir_node *value);
82 void be_prolog_set_memory(beabi_helper_env_t *env, ir_node *value);
85 * Set value of register at the end of the function. Necessary for:
86 * - Callee-save registers
87 * - Return values in registers
88 * - stack pointer, base pointer
90 void be_epilog_add_reg(beabi_helper_env_t *env, const arch_register_t *reg,
91 arch_register_req_type_t flags, ir_node *value);
93 void be_epilog_set_reg_value(beabi_helper_env_t *env,
94 const arch_register_t *reg, ir_node *value);
96 ir_node *be_epilog_get_reg_value(beabi_helper_env_t *env,
97 const arch_register_t *reg);
99 void be_epilog_set_memory(beabi_helper_env_t *env, ir_node *value);
101 ir_node *be_epilog_get_memory(beabi_helper_env_t *env);
103 void be_epilog_begin(beabi_helper_env_t *env);
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 * In the normal firm representation some nodes like pure calls, builtins
118 * have no memory inputs+outputs. However in the backend these sometimes have to
119 * access the stack to work and therefore suddenly need to be enqueued into the
121 * This API creates a possible order to enqueue them so we can be sure to create
122 * a legal dependency graph when transforming them.
124 be_stackorder_t *be_collect_stacknodes(ir_graph *irg);
127 * return node that should produce the predecessor stack node in a block.
128 * returns NULL if there's no predecessor in the current block.
130 ir_node *be_get_stack_pred(const be_stackorder_t *env, const ir_node *node);
133 * free memory associated with a stackorder structure
135 void be_free_stackorder(be_stackorder_t *env);
138 * In case where a parameter is transmitted via register but someone takes its
139 * address a store to the frame which can be references is necessary.
140 * This function can be used as a preprocessing phase before transformation to
141 * do this. The assumption is that all parameter_entities which are passed
142 * through the stack are already moved to the arg_type and all remaining
143 * parameter_entities on the frame type need stores.
145 void be_add_parameter_entity_stores(ir_graph *irg);