fixed some minor bugs
[libfirm] / ir / be / benode_t.h
1 /**
2  * @file   benode_t.h
3  * @date   17.05.2005
4  * @author Sebastian Hack
5  *
6  * Backend node support.
7  *
8  * Copyright (C) 2005 Universitaet Karlsruhe
9  * Released under the GPL
10  */
11
12 #ifndef _BENODE_T_H
13 #define _BENODE_T_H
14
15 #include "firm_config.h"
16 #include "pmap.h"
17
18 #include "irmode.h"
19 #include "irnode.h"
20 #include "entity_t.h"
21
22 #include "be_t.h"
23 #include "bearch.h"
24
25 #define BE_OUT_POS(p) (-((p) + 1))
26
27 /**
28  * The benode op's.  Must be available to register emitter function.
29  */
30 extern ir_op *op_be_Spill;
31 extern ir_op *op_be_Reload;
32 extern ir_op *op_be_Perm;
33 extern ir_op *op_be_Copy;
34 extern ir_op *op_be_Keep;
35 extern ir_op *op_be_Call;
36 extern ir_op *op_be_Return;
37 extern ir_op *op_be_IncSP;
38 extern ir_op *op_be_Alloca;
39 extern ir_op *op_be_SetSP;
40 extern ir_op *op_be_RegParams;
41 extern ir_op *op_be_StackParam;
42 extern ir_op *op_be_FrameAddr;
43 extern ir_op *op_be_FrameLoad;
44 extern ir_op *op_be_FrameStore;
45
46 typedef enum {
47         beo_NoBeOp = 0,
48         beo_Spill,
49         beo_Reload,
50         beo_Perm,
51         beo_Copy,
52         beo_Keep,
53         beo_NoReg,
54         beo_Call,
55         beo_Return,
56         beo_Alloca,
57         beo_IncSP,
58         beo_SetSP,
59         beo_RegParams,
60         beo_StackParam,
61         beo_FrameLoad,
62         beo_FrameStore,
63         beo_FrameAddr,
64         beo_Last
65 } be_opcode_t;
66
67 /** Expresses the direction of the stack pointer increment of IncSP nodes. */
68 typedef enum {
69         be_stack_dir_along = 0,
70         be_stack_dir_against = 1
71 } be_stack_dir_t;
72
73 /** Not used yet. */
74 typedef enum {
75         be_frame_flag_spill = 1,
76         be_frame_flag_local = 2,
77         be_frame_flag_arg   = 4
78 } be_frame_flag_t;
79
80 /**
81  * A "symbolic constant" for the size of the stack frame to use with IncSP nodes.
82  * It gets back-patched to the real size as soon it is known.
83  */
84 #define BE_STACK_FRAME_SIZE ((unsigned) -1)
85
86 void be_node_init(void);
87
88 const arch_irn_handler_t be_node_irn_handler;
89
90 enum {
91         be_pos_Spill_frame = 0,
92         be_pos_Spill_val   = 1
93 };
94 ir_node *be_new_Spill(const arch_register_class_t *cls, const arch_register_class_t *cls_frame, ir_graph *irg, ir_node *bl, ir_node *frame, ir_node *node_to_spill, ir_node *ctx);
95
96 enum {
97         be_pos_Reload_frame = 0,
98         be_pos_Reload_mem   = 1
99 };
100 ir_node *be_new_Reload(const arch_register_class_t *cls, const arch_register_class_t *cls_frame, ir_graph *irg, ir_node *bl, ir_node *frame, ir_node *spill_node, ir_mode *mode);
101
102 enum {
103         be_pos_Copy_orig = 0
104 };
105 ir_node *be_new_Copy(const arch_register_class_t *cls, ir_graph *irg, ir_node *block, ir_node *in);
106 ir_node *be_new_Perm(const arch_register_class_t *cls, ir_graph *irg, ir_node *bl, int arity, ir_node *in[]);
107 ir_node *be_new_Keep(const arch_register_class_t *cls, ir_graph *irg, ir_node *bl, int arity, ir_node *in[]);
108
109 ir_node *be_new_FrameLoad(const arch_register_class_t *cls_frame, const arch_register_class_t *cls_data,
110                                                   ir_graph *irg, ir_node *bl, ir_node *mem, ir_node *frame, entity *ent);
111 ir_node *be_new_FrameStore(const arch_register_class_t *cls_frame, const arch_register_class_t *cls_data,
112                                                    ir_graph *irg, ir_node *bl, ir_node *mem, ir_node *frame, ir_node *data, entity *ent);
113 ir_node *be_new_FrameAddr(const arch_register_class_t *cls_frame, ir_graph *irg, ir_node *bl, ir_node *frame, entity *ent);
114
115 ir_node *be_new_Alloca(const arch_register_t *sp, ir_graph *irg, ir_node *bl, ir_node *mem, ir_node *old_sp, ir_node *sz);
116
117 ir_node *be_new_SetSP(const arch_register_t *sp, ir_graph *irg, ir_node *bl, ir_node *old_sp, ir_node *operand, ir_node *mem);
118
119 /**
120  * Make a stack pointer increase/decrease node.
121  * @param sp     The stack pointer register.
122  * @param irg    The graph to insert the node to.
123  * @param bl     The block to insert the node into.
124  * @param old_sp The node defining the former stack pointer.
125  * @param amount The mount of bytes the stack pointer shall be increased/decreased.
126  * @param dir    The direction in which the stack pointer shall be modified:
127  *               Along the stack's growing direction or against.
128  * @return       A new stack pointer increment/decrement node.
129  * @note         This node sets a register constraint to the @p sp register on its output.
130  */
131 ir_node *be_new_IncSP(const arch_register_t *sp, ir_graph *irg, ir_node *bl, ir_node *old_sp, ir_node *mem, unsigned amount, be_stack_dir_t dir);
132
133 void     be_set_IncSP_offset(ir_node *irn, unsigned offset);
134 unsigned be_get_IncSP_offset(const ir_node *irn);
135
136 void           be_set_IncSP_direction(ir_node *irn, be_stack_dir_t dir);
137 be_stack_dir_t be_get_IncSP_direction(const ir_node *irn);
138
139 entity *be_Call_get_entity(const ir_node *call);
140 void    be_Call_set_entity(ir_node *call, entity *ent);
141
142 enum {
143         be_pos_Call_mem = 0,
144         be_pos_Call_sp  = 1,
145         be_pos_Call_ptr = 2
146 };
147
148 ir_node *be_new_Call(ir_graph *irg, ir_node *bl, ir_node *mem, ir_node *sp, ir_node *ptr, int n_outs, int n, ir_node *in[]);
149 ir_node *be_new_Return(ir_graph *irg, ir_node *bl, int n, ir_node *in[]);
150 ir_node *be_new_StackParam(const arch_register_class_t *cls, const arch_register_class_t *cls_frame, ir_graph *irg, ir_node *bl, ir_mode *mode, ir_node *frame_pointer, entity *ent);
151 ir_node *be_new_RegParams(ir_graph *irg, ir_node *bl, int n_out);
152
153 ir_node *be_spill(const arch_env_t *arch_env, ir_node *irn,ir_node *spill_ctx);
154 ir_node *be_reload(const arch_env_t *arch_env, const arch_register_class_t *cls, ir_node *reloader, ir_mode *mode, ir_node *spill);
155
156 /**
157  * Get the backend opcode of a backend node.
158  * @param irn The node.
159  * @return The backend opcode.
160  */
161 be_opcode_t be_get_irn_opcode(const ir_node *irn);
162
163 int be_is_Spill(const ir_node *irn);
164 int be_is_Reload(const ir_node *irn);
165 int be_is_Copy(const ir_node *irn);
166 int be_is_Perm(const ir_node *irn);
167 int be_is_Keep(const ir_node *irn);
168 int be_is_Call(const ir_node *irn);
169 int be_is_Return(const ir_node *irn);
170 int be_is_IncSP(const ir_node *irn);
171 int be_is_SetSP(const ir_node *irn);
172 int be_is_Alloca(const ir_node *irn);
173 int be_is_RegParams(const ir_node *irn);
174 int be_is_StackParam(const ir_node *irn);
175 int be_is_FrameAddr(const ir_node *irn);
176 int be_is_FrameLoad(const ir_node *irn);
177 int be_is_FrameStore(const ir_node *irn);
178
179 /**
180  * Get the entity on the stack frame the given node uses.
181  * @param irn The node.
182  * @return The entity on the stack frame used by the node or NULL,
183  *         if the node does not access the stack frame or is no back-end node.
184  *
185  */
186 entity *be_get_frame_entity(const ir_node *irn);
187
188 void   be_set_Spill_entity(ir_node *irn, entity *ent);
189 entity *be_get_spill_entity(const ir_node *irn);
190
191 ir_node *be_get_Spill_context(const ir_node *irn);
192
193 /**
194  * Set the entities of a Reload to the ones of the Spill it is pointing to.
195  * @param irg The graph.
196  */
197 void be_copy_entities_to_reloads(ir_graph *irg);
198
199 /**
200  * Impose a register constraint on a backend node.
201  * @param irn The node.
202  * @param pos The position of the argument/result. Results range from -1..-m and arguments form 0..n
203  * @param reg The register which is admissible for that node, argument/result and position.
204  */
205 void be_set_constr_single_reg(ir_node *irn, int pos, const arch_register_t *reg);
206
207 /**
208  * Impose register constraints on a backend node.
209  * The register subsets given by the limited function in @p req are copied to the backend node.
210  * This requires that the constraint type of the @p req is arch_register_req_type_limited.
211  * @param irn The backend node.
212  * @param pos The position (@see be_set_constr_single_reg()).
213  * @param req The register requirements which shall be transferred.
214  */
215 void be_set_constr_limited(ir_node *irn, int pos, const arch_register_req_t *req);
216
217 /**
218  * Set the flags of a node.
219  * @param irn The node itself.
220  * @param pos The position (0..n) for arguments, (-1..-m) for results.
221  * @param flags The flags to set for that node and position.
222  */
223 void be_node_set_flags(ir_node *irn, int pos, arch_irn_flags_t flags);
224
225 /**
226  * Set the register class of a node.
227  * @param irn The node itself.
228  * @param pos The position (0..n) for arguments, (-1..-m) for results.
229  * @param flags The register class to set for that node and position.
230  */
231 void be_node_set_reg_class(ir_node *irn, int pos, const arch_register_class_t *cls);
232
233 /**
234  * Insert a Perm node after a specific node in the schedule.
235  * The Perm permutes over all values live at the given node.
236  * This means that all liveness intervals are cut apart at this
237  * location in the program.
238  */
239 ir_node *insert_Perm_after(const arch_env_t *env,
240                                                    const arch_register_class_t *cls,
241                                                    dom_front_info_t *dom_front,
242                                                    ir_node *pos);
243
244
245 #endif /* _BENODE_T_H */