sparc: initial support for Alloc/Free nodes
[libfirm] / ir / be / sparc / sparc_stackframe.c
1 /*
2  * Copyright (C) 1995-2010 University of Karlsruhe.  All right reserved.
3  *
4  * This file is part of libFirm.
5  *
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.
10  *
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.
14  *
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
17  * PURPOSE.
18  */
19
20 /**
21  * @file
22  * @brief   Manage addressing into the stackframe
23  * @author  Matthias Braun
24  * @version $Id$
25  */
26 #include "config.h"
27
28 #include "firm_types.h"
29 #include "irnode_t.h"
30 #include "bearch_sparc_t.h"
31 #include "sparc_new_nodes.h"
32 #include "sparc_cconv.h"
33 #include "bitfiddle.h"
34 #include "../bearch.h"
35 #include "../benode.h"
36 #include "../besched.h"
37
38 static void set_irn_sp_bias(ir_node *node, int new_bias)
39 {
40         if (be_is_IncSP(node)) {
41                 be_set_IncSP_offset(node, new_bias);
42         } else if (is_sparc_Save(node)) {
43                 sparc_attr_t *attr = get_sparc_attr(node);
44                 attr->immediate_value = -new_bias;
45         } else if (is_sparc_Restore(node)) {
46                 sparc_attr_t *attr = get_sparc_attr(node);
47                 attr->immediate_value = new_bias;
48         }
49 }
50
51 static void process_bias(ir_node *block, bool sp_relative, int bias,
52                          int free_bytes)
53 {
54         const ir_edge_t *edge;
55         ir_node         *irn;
56
57         mark_Block_block_visited(block);
58
59         /* process schedule */
60         sched_foreach(block, irn) {
61                 int irn_bias;
62
63                 /* set bias to nodes with entities */
64                 ir_entity *entity = arch_get_frame_entity(irn);
65                 if (entity != NULL) {
66                         int offset = get_entity_offset(entity);
67                         if (sp_relative)
68                                 offset -= bias;
69                         arch_set_frame_offset(irn, offset);
70                 }
71
72                 irn_bias = arch_get_sp_bias(irn);
73                 if (irn_bias == 0) {
74                         /* do nothing */
75                 } else if (irn_bias == SP_BIAS_RESET) {
76                         bias = 0;
77                 } else {
78                         /* adjust values to respect stack alignment */
79                         int new_bias_unaligned;
80                         int new_bias_aligned;
81                         irn_bias -= free_bytes;
82
83                         new_bias_unaligned = bias + irn_bias;
84                         new_bias_aligned
85                                 = round_up2(new_bias_unaligned, SPARC_STACK_ALIGNMENT);
86                         free_bytes = new_bias_aligned - new_bias_unaligned;
87                         set_irn_sp_bias(irn, new_bias_aligned - bias);
88                         bias = new_bias_aligned;
89                 }
90         }
91
92 #ifndef NDEBUG
93         if (block == get_irg_end_block(get_irn_irg(block))) {
94                 assert(bias == 0);
95         }
96 #endif
97
98         /* continue at the successor blocks */
99         foreach_block_succ(block, edge) {
100                 ir_node *succ = get_edge_src_irn(edge);
101                 if (Block_block_visited(succ))
102                         continue;
103                 process_bias(succ, sp_relative, bias, free_bytes);
104         }
105 }
106
107 static void adjust_entity_offsets(ir_type *type, long offset)
108 {
109         size_t n_members = get_compound_n_members(type);
110         size_t i;
111
112         for (i = 0; i < n_members; ++i) {
113                 ir_entity *member        = get_compound_member(type, i);
114                 int        member_offset = get_entity_offset(member);
115                 set_entity_offset(member, member_offset + offset);
116         }
117 }
118
119 bool sparc_variadic_fixups(ir_graph *irg, calling_convention_t *cconv)
120 {
121         ir_entity *entity = get_irg_entity(irg);
122         ir_type   *mtp    = get_entity_type(entity);
123         if (get_method_variadicity(mtp) != variadicity_variadic)
124                 return false;
125
126         if (cconv->n_param_regs >= SPARC_N_PARAM_REGS)
127                 return false;
128
129         {
130         size_t         n_params     = get_method_n_params(mtp);
131         type_dbg_info *dbgi         = get_type_dbg_info(mtp);
132         size_t         n_ress       = get_method_n_ress(mtp);
133         size_t         new_n_params
134                 = n_params + (SPARC_N_PARAM_REGS - cconv->n_param_regs);
135         ir_type       *new_mtp      = new_d_type_method(new_n_params, n_ress, dbgi);
136         ir_mode       *gp_reg_mode  = sparc_reg_classes[CLASS_sparc_gp].mode;
137         ir_type       *gp_reg_type  = get_type_for_mode(gp_reg_mode);
138         ir_type       *frame_type   = get_irg_frame_type(irg);
139         size_t         i;
140
141         for (i = 0; i < n_ress; ++i) {
142                 ir_type *type = get_method_res_type(mtp, i);
143                 set_method_res_type(new_mtp, i, type);
144         }
145         for (i = 0; i < n_params; ++i) {
146                 ir_type *type = get_method_param_type(mtp, i);
147                 set_method_param_type(new_mtp, i, type);
148         }
149         for ( ; i < new_n_params; ++i) {
150                 set_method_param_type(new_mtp, i, gp_reg_type);
151                 new_parameter_entity(frame_type, i, gp_reg_type);
152         }
153
154         set_method_variadicity(new_mtp, get_method_variadicity(mtp));
155         set_method_calling_convention(new_mtp, get_method_calling_convention(mtp));
156         set_method_additional_properties(new_mtp, get_method_additional_properties(mtp));
157         set_lowered_type(mtp, new_mtp);
158
159         set_entity_type(entity, new_mtp);
160         }
161         return true;
162 }
163
164 static ir_type *compute_arg_type(ir_graph *irg, calling_convention_t *cconv,
165                                  ir_type *between_type)
166 {
167         ir_entity       *va_start_entity = NULL;
168         const ir_entity *entity          = get_irg_entity(irg);
169         const ir_type   *mtp             = get_entity_type(entity);
170         size_t           n_params        = get_method_n_params(mtp);
171         ir_entity      **param_map       = ALLOCANZ(ir_entity*, n_params);
172
173         ir_type *frame_type      = get_irg_frame_type(irg);
174         size_t   n_frame_members = get_compound_n_members(frame_type);
175         size_t   f;
176         size_t   i;
177
178         ir_type *res = new_type_struct(id_mangle_u(get_entity_ident(entity), new_id_from_chars("arg_type", 8)));
179
180         /* search for existing value_param entities */
181         for (f = n_frame_members; f > 0; ) {
182                 ir_entity *member = get_compound_member(frame_type, --f);
183                 size_t     num;
184
185                 if (!is_parameter_entity(member))
186                         continue;
187                 num = get_entity_parameter_number(member);
188                 if (num == IR_VA_START_PARAMETER_NUMBER) {
189                         if (va_start_entity != NULL)
190                                 panic("multiple va_start entities found (%+F,%+F)",
191                                       va_start_entity, member);
192                         va_start_entity = member;
193                         continue;
194                 }
195                 assert(num < n_params);
196                 if (param_map[num] != NULL)
197                         panic("multiple entities for parameter %u in %+F found", f, irg);
198
199                 param_map[num] = member;
200                 /* move to new arg_type */
201                 set_entity_owner(member, res);
202         }
203
204         /* calculate offsets/create missing entities */
205         for (i = 0; i < n_params; ++i) {
206                 reg_or_stackslot_t *param  = &cconv->parameters[i];
207                 ir_entity          *entity = param_map[i];
208
209                 if (param->reg0 != NULL) {
210                         /* use reserved spill space on between type */
211                         if (entity != NULL) {
212                                 long offset = SPARC_PARAMS_SPILL_OFFSET + i*4;
213                                 assert(i < SPARC_N_PARAM_REGS);
214                                 set_entity_owner(entity, between_type);
215                                 set_entity_offset(entity, offset);
216                         }
217                         continue;
218                 }
219
220                 if (entity == NULL)
221                         entity = new_parameter_entity(res, i, param->type);
222                 param->entity = entity;
223                 set_entity_offset(entity, param->offset);
224         }
225
226         if (va_start_entity != NULL) {
227                 /* sparc_variadic_fixups() fiddled with our type, find out the
228                  * original number of parameters */
229                 ir_type *non_lowered   = get_associated_type(mtp);
230                 size_t   orig_n_params = get_method_n_params(non_lowered);
231                 long     offset;
232                 assert(get_method_variadicity(mtp) == variadicity_variadic);
233                 if (orig_n_params < n_params) {
234                         assert(param_map[orig_n_params] != NULL);
235                         offset = get_entity_offset(param_map[orig_n_params]);
236                         set_entity_owner(va_start_entity, between_type);
237                         set_entity_offset(va_start_entity, offset);
238                 } else {
239                         set_entity_owner(va_start_entity, res);
240                         set_entity_offset(va_start_entity, cconv->param_stack_size);
241                 }
242         }
243         set_type_size_bytes(res, cconv->param_stack_size);
244
245         return res;
246 }
247
248 void sparc_create_stacklayout(ir_graph *irg, calling_convention_t *cconv)
249 {
250         be_stack_layout_t *layout = be_get_irg_stack_layout(irg);
251         ir_type           *between_type;
252         memset(layout, 0, sizeof(*layout));
253
254         between_type = new_type_class(new_id_from_str("sparc_between_type"));
255         set_type_size_bytes(between_type, SPARC_MIN_STACKSIZE);
256
257         layout->frame_type     = get_irg_frame_type(irg);
258         layout->between_type   = between_type;
259         layout->arg_type       = compute_arg_type(irg, cconv, between_type);
260         layout->initial_offset = 0;
261         layout->initial_bias   = 0;
262         layout->sp_relative    = cconv->omit_fp;
263
264         assert(N_FRAME_TYPES == 3);
265         layout->order[0] = layout->frame_type;
266         layout->order[1] = layout->between_type;
267         layout->order[2] = layout->arg_type;
268 }
269
270 /* Assign entity offsets, to all stack-related entities.
271  * The offsets are relative to the begin of the stack frame.
272  */
273 static void process_frame_types(ir_graph *irg)
274 {
275         be_stack_layout_t *layout = be_get_irg_stack_layout(irg);
276
277         /* initially the stackpointer points to the begin of our stackframe.
278          * Situation at the begin of our function:
279          *
280          *      high address |-----------------------------|
281          *                   |            ...              |
282          *          arg-type |         stackarg 1          |
283          *                   |         stackarg 0          |
284          *                   |-----------------------------|
285          *                   | space for storing regarg0-5 |
286          *      between type | pointer to aggregate return |
287          *                   |      16 words save are      |
288          *  stack pointer -> |-----------------------------|
289          *                   |    high end of stackframe   |
290          *                   |            ...              |
291          *                   |    low end of stackframe    |
292          *      low address  |-----------------------------|
293          */
294         ir_type *between_type = layout->between_type;
295         unsigned between_size = get_type_size_bytes(between_type);
296
297         ir_type *frame_type = get_irg_frame_type(irg);
298         unsigned frame_size = get_type_size_bytes(frame_type);
299
300         ir_type *arg_type = layout->arg_type;
301
302         adjust_entity_offsets(frame_type, -(long)frame_size);
303         /* no need to adjust between type, it's already at 0 */
304         adjust_entity_offsets(arg_type, between_size);
305 }
306
307 void sparc_fix_stack_bias(ir_graph *irg)
308 {
309         ir_node *start_block = get_irg_start_block(irg);
310
311         process_frame_types(irg);
312
313         ir_reserve_resources(irg, IR_RESOURCE_BLOCK_VISITED);
314         inc_irg_block_visited(irg);
315         process_bias(start_block, be_get_irg_stack_layout(irg)->sp_relative, 0, 0);
316         ir_free_resources(irg, IR_RESOURCE_BLOCK_VISITED);
317 }