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