Fixes
[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 /**
26  * The benode op's.  Must be available to register emitter function.
27  */
28 extern ir_op *op_be_Spill;
29 extern ir_op *op_be_Reload;
30 extern ir_op *op_be_Perm;
31 extern ir_op *op_be_Copy;
32 extern ir_op *op_be_Keep;
33 extern ir_op *op_be_Call;
34 extern ir_op *op_be_Return;
35 extern ir_op *op_be_IncSP;
36 extern ir_op *op_be_AddSP;
37 extern ir_op *op_be_SetSP;
38 extern ir_op *op_be_RegParams;
39 extern ir_op *op_be_StackParam;
40 extern ir_op *op_be_FrameAddr;
41 extern ir_op *op_be_FrameLoad;
42 extern ir_op *op_be_FrameStore;
43
44 typedef enum {
45         beo_NoBeOp = 0,
46         beo_Spill,
47         beo_Reload,
48         beo_Perm,
49         beo_Copy,
50         beo_Keep,
51         beo_NoReg,
52         beo_Call,
53         beo_Return,
54         beo_AddSP,
55         beo_IncSP,
56         beo_SetSP,
57         beo_RegParams,
58         beo_StackParam,
59         beo_FrameLoad,
60         beo_FrameStore,
61         beo_FrameAddr,
62         beo_Last
63 } be_opcode_t;
64
65 /** Expresses the direction of the stack pointer increment of IncSP nodes. */
66 typedef enum {
67         be_stack_dir_along = 0,
68         be_stack_dir_against = 1
69 } be_stack_dir_t;
70
71 /** Not used yet. */
72 typedef enum {
73         be_frame_flag_spill = 1,
74         be_frame_flag_local = 2,
75         be_frame_flag_arg   = 4
76 } be_frame_flag_t;
77
78 /**
79  * A "symbolic constant" for the size of the stack frame to use with IncSP nodes.
80  * It gets back-patched to the real size as soon it is known.
81  */
82 #define BE_STACK_FRAME_SIZE ((unsigned) -1)
83
84 void be_node_init(void);
85
86 const arch_irn_handler_t be_node_irn_handler;
87
88 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);
89 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);
90 ir_node *be_new_Copy(const arch_register_class_t *cls, ir_graph *irg, ir_node *block, ir_node *in);
91 ir_node *be_new_Perm(const arch_register_class_t *cls, ir_graph *irg, ir_node *bl, int arity, ir_node *in[]);
92 ir_node *be_new_Keep(const arch_register_class_t *cls, ir_graph *irg, ir_node *bl, int arity, ir_node *in[]);
93
94 ir_node *be_new_FrameLoad(const arch_register_class_t *cls_frame, const arch_register_class_t *cls_data,
95                                                   ir_graph *irg, ir_node *bl, ir_node *mem, ir_node *frame, entity *ent);
96 ir_node *be_new_FrameStore(const arch_register_class_t *cls_frame, const arch_register_class_t *cls_data,
97                                                    ir_graph *irg, ir_node *bl, ir_node *mem, ir_node *frame, ir_node *data, entity *ent);
98 ir_node *be_new_FrameAddr(const arch_register_class_t *cls_frame, ir_graph *irg, ir_node *bl, ir_node *frame, entity *ent);
99
100 ir_node *be_new_AddSP(const arch_register_t *sp, ir_graph *irg, ir_node *bl, ir_node *old_sp, ir_node *operand);
101
102 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);
103
104 /**
105  * Make a stack pointer increase/decrease node.
106  * @param sp     The stack pointer register.
107  * @param irg    The graph to insert the node to.
108  * @param bl     The block to insert the node into.
109  * @param old_sp The node defining the former stack pointer.
110  * @param amount The mount of bytes the stack pointer shall be increased/decreased.
111  * @param dir    The direction in which the stack pointer shall be modified:
112  *               Along the stack's growing direction or against.
113  * @return       A new stack pointer increment/decrement node.
114  * @note         This node sets a register constraint to the @p sp register on its output.
115  */
116 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);
117
118 void     be_set_IncSP_offset(ir_node *irn, unsigned offset);
119 unsigned be_get_IncSP_offset(const ir_node *irn);
120
121 void           be_set_IncSP_direction(ir_node *irn, be_stack_dir_t dir);
122 be_stack_dir_t be_get_IncSP_direction(const ir_node *irn);
123
124 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[]);
125 ir_node *be_new_Return(ir_graph *irg, ir_node *bl, int n, ir_node *in[]);
126 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);
127 ir_node *be_new_RegParams(ir_graph *irg, ir_node *bl, int n_out);
128
129 ir_node *be_spill(const arch_env_t *arch_env, ir_node *irn,ir_node *spill_ctx);
130 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);
131
132 /**
133  * Get the backend opcode of a backend node.
134  * @param irn The node.
135  * @return The backend opcode.
136  */
137 be_opcode_t be_get_irn_opcode(const ir_node *irn);
138
139 int be_is_Spill(const ir_node *irn);
140 int be_is_Reload(const ir_node *irn);
141 int be_is_Copy(const ir_node *irn);
142 int be_is_Perm(const ir_node *irn);
143 int be_is_Keep(const ir_node *irn);
144 int be_is_Call(const ir_node *irn);
145 int be_is_IncSP(const ir_node *irn);
146 int be_is_AddSP(const ir_node *irn);
147 int be_is_RegParams(const ir_node *irn);
148 int be_is_StackParam(const ir_node *irn);
149
150 /**
151  * Get the entity on the stack frame the given node uses.
152  * @param irn The node.
153  * @return The entity on the stack frame used by the node or NULL,
154  *         if the node does not access the stack frame or is no back-end node.
155  *
156  */
157 entity *be_get_frame_entity(const ir_node *irn);
158
159 void   be_set_Spill_entity(ir_node *irn, entity *ent);
160 entity *be_get_spill_entity(const ir_node *irn);
161
162 ir_node *be_get_Spill_context(const ir_node *irn);
163
164 /**
165  * Impose a register constraint on a backend node.
166  * @param irn The node.
167  * @param pos The position of the argument/result. Results range from -1..-m and arguments form 0..n
168  * @param reg The register which is admissible for that node, argument/result and position.
169  */
170 void be_set_constr_single_reg(ir_node *irn, int pos, const arch_register_t *reg);
171
172 /**
173  * Impose register constraints on a backend node.
174  * The register subsets given by the limited function in @p req are copied to the backend node.
175  * This requires that the constraint type of the @p req is arch_register_req_type_limited.
176  * @param irn The backend node.
177  * @param pos The position (@see be_set_constr_single_reg()).
178  * @param req The register requirements which shall be transferred.
179  */
180 void be_set_constr_limited(ir_node *irn, int pos, const arch_register_req_t *req);
181
182 /**
183  * Set the flags of a node.
184  * @param irn The node itself.
185  * @param pos The position (0..n) for arguments, (-1..-m) for results.
186  * @param flags The flags to set for that node and position.
187  */
188 void be_node_set_flags(ir_node *irn, int pos, arch_irn_flags_t flags);
189
190 /**
191  * Set the register class of a node.
192  * @param irn The node itself.
193  * @param pos The position (0..n) for arguments, (-1..-m) for results.
194  * @param flags The register class to set for that node and position.
195  */
196 void be_node_set_reg_class(ir_node *irn, int pos, const arch_register_class_t *cls);
197
198 /**
199  * Insert a Perm node after a specific node in the schedule.
200  * The Perm permutes over all values live at the given node.
201  * This means that all liveness intervals are cut apart at this
202  * location in the program.
203  */
204 ir_node *insert_Perm_after(const arch_env_t *env,
205                                                    const arch_register_class_t *cls,
206                                                    dom_front_info_t *dom_front,
207                                                    ir_node *pos);
208
209
210 #endif /* _BENODE_T_H */