24335650ac14a13b9d16f4d0f1ee63309c75f3c3
[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_RegParams,
38         beo_StackParam,
39         beo_FrameLoad,
40         beo_FrameStore,
41         beo_FrameAddr,
42         beo_Last
43 } be_opcode_t;
44
45 typedef enum {
46         be_stack_dir_along = 0,
47         be_stack_dir_against = 1
48 } be_stack_dir_t;
49
50 typedef enum {
51         be_frame_flag_spill = 1,
52         be_frame_flag_local = 2,
53         be_frame_flag_arg   = 4
54 } be_frame_flag_t;
55
56 #define BE_STACK_FRAME_SIZE ((unsigned) -1)
57
58 void be_node_init(void);
59
60 const arch_irn_handler_t be_node_irn_handler;
61
62 ir_node *be_new_Spill(const arch_register_class_t *cls, ir_graph *irg, ir_node *bl, ir_node *node_to_spill, ir_node *ctx);
63 ir_node *be_new_Reload(const arch_register_class_t *cls, ir_graph *irg, ir_node *bl, ir_mode *mode, ir_node *spill_node);
64 ir_node *be_new_Copy(const arch_register_class_t *cls, ir_graph *irg, ir_node *block, ir_node *in);
65 ir_node *be_new_Perm(const arch_register_class_t *cls, ir_graph *irg, ir_node *bl, int arity, ir_node *in[]);
66 ir_node *be_new_Keep(const arch_register_class_t *cls, ir_graph *irg, ir_node *bl, int arity, ir_node *in[]);
67
68 ir_node *be_new_FrameLoad(const arch_register_class_t *cls_frame, const arch_register_class_t *cls_data,
69                                                   ir_graph *irg, ir_node *bl, ir_node *mem, ir_node *frame, entity *ent);
70 ir_node *be_new_FrameStore(const arch_register_class_t *cls_frame, const arch_register_class_t *cls_data,
71                                                    ir_graph *irg, ir_node *bl, ir_node *mem, ir_node *frame, ir_node *data, entity *ent);
72 ir_node *be_new_FrameAddr(const arch_register_class_t *cls_frame, ir_graph *irg, ir_node *bl, ir_node *frame, entity *ent);
73
74 ir_node *be_new_AddSP(const arch_register_t *sp, ir_graph *irg, ir_node *bl, ir_node *old_sp, ir_node *operand);
75
76 /**
77  * Make a stack pointer increase/decrease node.
78  * @param sp     The stack poitner register.
79  * @param irg    The graph to insert the node to.
80  * @param bl     The block to insert the node into.
81  * @param old_sp The node defining the former stack pointer.
82  * @param amount The mount of bytes the stack pointer shall be increased/decreased.
83  * @param dir    The direction in which the stack pointer shall be modified:
84  *               Along the stack's growing direction or against.
85  * @return       A new stack pointer increment/decrement node.
86  * @note         This node sets a register constraint to the @p sp register on its output.
87  */
88 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);
89
90 void     be_set_IncSP_offset(ir_node *irn, unsigned offset);
91 unsigned be_get_IncSP_offset(ir_node *irn);
92
93 void           be_set_IncSP_direction(ir_node *irn, be_stack_dir_t dir);
94 be_stack_dir_t be_get_IncSP_direction(ir_node *irn);
95
96 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[]);
97 ir_node *be_new_Return(ir_graph *irg, ir_node *bl, int n, ir_node *in[]);
98 ir_node *be_new_StackParam(const arch_register_class_t *cls, ir_graph *irg, ir_node *bl, ir_mode *mode, ir_node *frame_pointer, entity *ent);
99 ir_node *be_new_RegParams(ir_graph *irg, ir_node *bl, int n_out);
100 ir_node *be_new_NoReg(const arch_register_t *reg, ir_graph *irg, ir_node *bl);
101
102 ir_node *be_spill(const arch_env_t *arch_env, ir_node *irn,ir_node *spill_ctx);
103 ir_node *be_reload(const arch_env_t *arch_env, const arch_register_class_t *cls, ir_node *irn, int pos, ir_mode *mode, ir_node *spill);
104
105 be_opcode_t be_get_irn_opcode(const ir_node *irn);
106
107 int be_is_Spill(const ir_node *irn);
108 int be_is_Reload(const ir_node *irn);
109 int be_is_Copy(const ir_node *irn);
110 int be_is_Perm(const ir_node *irn);
111 int be_is_Keep(const ir_node *irn);
112 int be_is_Call(const ir_node *irn);
113 int be_is_IncSP(const ir_node *irn);
114 int be_is_AddSP(const ir_node *irn);
115 int be_is_RegParams(const ir_node *irn);
116 int be_is_StackParam(const ir_node *irn);
117 int be_is_NoReg(const ir_node *irn);
118
119
120 /**
121  * Get the entity on the stack frame the given node uses.
122  * @param irn The node.
123  * @return The entity on the stack frame used by the node or NULL,
124  *         if the node does not access the stack frame or is no back-end node.
125  *
126  */
127 entity *be_get_frame_entity(ir_node *irn);
128
129 void   be_set_Spill_entity(ir_node *irn, entity *ent);
130 entity *be_get_spill_entity(ir_node *irn);
131
132 ir_node *be_get_Spill_context(const ir_node *irn);
133
134 /**
135  * Impose a register constraint on a backend node.
136  * @param irn The node.
137  * @param pos The position of the argument/result. Results range from -1..-m and arguments form 0..n
138  * @param reg The register which is admissible for that node, argument/result and position.
139  */
140 void be_set_constr_single_reg(ir_node *irn, int pos, const arch_register_t *reg);
141
142 /**
143  * Impose register constraints on a backend node.
144  * The register subsets given by the limited function in @p req are copied to the backend node.
145  * This requires that the constraint type of the @p req is arch_register_req_type_limited.
146  * @param irn The backend node.
147  * @param pos The position (@see be_set_constr_single_reg()).
148  * @param req The register requirements which shall be transferred.
149  */
150 void be_set_constr_limited(ir_node *irn, int pos, const arch_register_req_t *req);
151
152 void be_node_set_flags(ir_node *irn, int pos, arch_irn_flags_t flags);
153
154 void be_node_set_reg_class(ir_node *irn, int pos, const arch_register_class_t *cls);
155
156 /**
157  * Insert a Perm node after a specific node in the schedule.
158  * The Perm permutes over all values live at the given node.
159  * This means that all liveness intervals are cut apart at this
160  * location in the program.
161  */
162 ir_node *insert_Perm_after(const arch_env_t *env,
163                                                    const arch_register_class_t *cls,
164                                                    dom_front_info_t *dom_front,
165                                                    ir_node *pos);
166
167
168 #endif /* _BENODE_T_H */