c390794d7bad77c9954ab26aaa2b29234f36355c
[libfirm] / ir / be / mips / mips_new_nodes.c
1 /*
2  * Copyright (C) 1995-2007 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    This file implements the creation of the architecture specific firm
23  *           opcodes and the corresponding node constructors for the MIPS
24  *           assembler irg.
25  * @author   Matthias Braun, Mehdi
26  * @version  $Id$
27  */
28 #ifdef HAVE_CONFIG_H
29 #include "config.h"
30 #endif
31
32 #include <stdlib.h>
33
34 #include "irprog_t.h"
35 #include "irgraph_t.h"
36 #include "irnode_t.h"
37 #include "irmode_t.h"
38 #include "ircons_t.h"
39 #include "iropt_t.h"
40 #include "irop.h"
41 #include "firm_common_t.h"
42 #include "irvrfy_t.h"
43 #include "irprintf.h"
44 #include "xmalloc.h"
45
46 #include "../bearch_t.h"
47
48 #include "mips_nodes_attr.h"
49 #include "mips_new_nodes.h"
50 #include "gen_mips_regalloc_if.h"
51
52
53
54 /***********************************************************************************
55  *      _                                   _       _             __
56  *     | |                                 (_)     | |           / _|
57  *   __| |_   _ _ __ ___  _ __   ___ _ __   _ _ __ | |_ ___ _ __| |_ __ _  ___ ___
58  *  / _` | | | | '_ ` _ \| '_ \ / _ \ '__| | | '_ \| __/ _ \ '__|  _/ _` |/ __/ _ \
59  * | (_| | |_| | | | | | | |_) |  __/ |    | | | | | ||  __/ |  | || (_| | (_|  __/
60  *  \__,_|\__,_|_| |_| |_| .__/ \___|_|    |_|_| |_|\__\___|_|  |_| \__,_|\___\___|
61  *                       | |
62  *                       |_|
63  ***********************************************************************************/
64
65 /**
66  * Dumps the register requirements for either in or out.
67  */
68 static void dump_reg_req(FILE *F, ir_node *n, const arch_register_req_t **reqs,
69                          int inout)
70 {
71         const mips_attr_t *attr = get_mips_attr_const(n);
72         char *dir = inout ? "out" : "in";
73         int   max = inout ? ARR_LEN(attr->slots) : get_irn_arity(n);
74         char  buf[1024];
75         int   i;
76
77         memset(buf, 0, sizeof(buf));
78
79         if (reqs) {
80                 for (i = 0; i < max; i++) {
81                         fprintf(F, "%sreq #%d =", dir, i);
82
83                         if (reqs[i]->type == arch_register_req_type_none) {
84                                 fprintf(F, " n/a");
85                         }
86
87                         if (reqs[i]->type & arch_register_req_type_normal) {
88                                 fprintf(F, " %s", reqs[i]->cls->name);
89                         }
90
91                         if (reqs[i]->type & arch_register_req_type_limited) {
92                                 fprintf(F, " %s",
93                                         arch_register_req_format(buf, sizeof(buf), reqs[i], n));
94                         }
95
96                         if (reqs[i]->type & arch_register_req_type_should_be_same) {
97                                 ir_fprintf(F, " same as %+F", get_irn_n(n, reqs[i]->other_same[0]));
98                                 if (reqs[i]->other_same[1] != -1)
99                                         ir_fprintf(F, " or %+F", get_irn_n(n, reqs[i]->other_same[1]));
100                         }
101
102                         if (reqs[i]->type & arch_register_req_type_should_be_different) {
103                                 ir_fprintf(F, " different from %+F", get_irn_n(n, reqs[i]->other_different));
104                         }
105
106                         fprintf(F, "\n");
107                 }
108
109                 fprintf(F, "\n");
110         } else {
111                 fprintf(F, "%sreq = N/A\n", dir);
112         }
113 }
114
115
116 /**
117  * Dumper interface for dumping mips nodes in vcg.
118  * @param n        the node to dump
119  * @param F        the output file
120  * @param reason   indicates which kind of information should be dumped
121  * @return 0 on success or != 0 on failure
122  */
123 static int mips_dump_node(ir_node *n, FILE *F, dump_reason_t reason) {
124         int          bad  = 0;
125         int          i;
126         const mips_attr_t *attr = get_mips_attr_const(n);
127         const arch_register_req_t **reqs;
128         const arch_register_t     **slots;
129
130         switch (reason) {
131                 case dump_node_opcode_txt:
132                         fprintf(F, "%s", get_irn_opname(n));
133                         break;
134
135                 case dump_node_mode_txt:
136                         break;
137
138                 case dump_node_nodeattr_txt:
139
140                         if(is_mips_Immediate(n)) {
141                                 const mips_immediate_attr_t *attr
142                                         = get_mips_immediate_attr_const(n);
143                                 switch(attr->imm_type) {
144                                 case MIPS_IMM_CONST:
145                                         fprintf(F, " %ld ", attr->val);
146                                         break;
147                                 case MIPS_IMM_SYMCONST_LO:
148                                         fprintf(F, " lo(%s", get_entity_ld_name(attr->entity));
149                                         if(attr->val != 0) {
150                                                 fprintf(F, "%+ld", attr->val);
151                                         }
152                                         fprintf(F, ") ");
153                                         break;
154                                 case MIPS_IMM_SYMCONST_HI:
155                                         fprintf(F, " hi(%s", get_entity_ld_name(attr->entity));
156                                         if(attr->val != 0) {
157                                                 fprintf(F, "%+ld", attr->val);
158                                         }
159                                         fprintf(F, ") ");
160                                         break;
161                                 default:
162                                         fprintf(F, " INVALID ");
163                                         break;
164                                 }
165                         }
166                         break;
167
168                 case dump_node_info_txt:
169                         attr = get_mips_attr(n);
170                         fprintf(F, "=== mips attr begin ===\n");
171
172                         /* dump IN requirements */
173                         if (get_irn_arity(n) > 0) {
174                                 reqs = get_mips_in_req_all(n);
175                                 dump_reg_req(F, n, reqs, 0);
176                         }
177
178                         /* dump OUT requirements */
179                         if (ARR_LEN(attr->slots) > 0) {
180                                 reqs = get_mips_out_req_all(n);
181                                 dump_reg_req(F, n, reqs, 1);
182                         }
183
184                         /* dump assigned registers */
185                         slots = get_mips_slots(n);
186                         if (slots && ARR_LEN(attr->slots) > 0) {
187                                 for (i = 0; i < ARR_LEN(attr->slots); i++) {
188                                         if (slots[i]) {
189                                                 fprintf(F, "reg #%d = %s\n", i, slots[i]->name);
190                                         }
191                                         else {
192                                                 fprintf(F, "reg #%d = n/a\n", i);
193                                         }
194                                 }
195                         }
196                         fprintf(F, "\n");
197
198                         /* dump n_res */
199                         fprintf(F, "n_res = %d\n", ARR_LEN(attr->slots));
200
201                         /* dump flags */
202                         fprintf(F, "flags =");
203                         if (attr->flags == arch_irn_flags_none) {
204                                 fprintf(F, " none");
205                         }
206                         else {
207                                 if (attr->flags & arch_irn_flags_dont_spill) {
208                                         fprintf(F, " unspillable");
209                                 }
210                                 if (attr->flags & arch_irn_flags_rematerializable) {
211                                         fprintf(F, " remat");
212                                 }
213                                 if (attr->flags & arch_irn_flags_ignore) {
214                                         fprintf(F, " ignore");
215                                 }
216                         }
217                         fprintf(F, " (%d)\n", attr->flags);
218
219                         fprintf(F, "=== mips attr end ===\n");
220                         /* end of: case dump_node_info_txt */
221                         break;
222         }
223
224
225         return bad;
226 }
227
228
229
230 /***************************************************************************************************
231  *        _   _                   _       __        _                    _   _               _
232  *       | | | |                 | |     / /       | |                  | | | |             | |
233  *   __ _| |_| |_ _ __   ___  ___| |_   / /_ _  ___| |_   _ __ ___   ___| |_| |__   ___   __| |___
234  *  / _` | __| __| '__| / __|/ _ \ __| / / _` |/ _ \ __| | '_ ` _ \ / _ \ __| '_ \ / _ \ / _` / __|
235  * | (_| | |_| |_| |    \__ \  __/ |_ / / (_| |  __/ |_  | | | | | |  __/ |_| | | | (_) | (_| \__ \
236  *  \__,_|\__|\__|_|    |___/\___|\__/_/ \__, |\___|\__| |_| |_| |_|\___|\__|_| |_|\___/ \__,_|___/
237  *                                        __/ |
238  *                                       |___/
239  ***************************************************************************************************/
240
241 mips_attr_t *get_mips_attr(ir_node *node)
242 {
243         assert(is_mips_irn(node) && "need mips node to get attributes");
244         return (mips_attr_t *) get_irn_generic_attr(node);
245 }
246
247 const mips_attr_t *get_mips_attr_const(const ir_node *node)
248 {
249         assert(is_mips_irn(node) && "need mips node to get attributes");
250         return get_irn_generic_attr_const(node);
251 }
252
253 const mips_immediate_attr_t *get_mips_immediate_attr_const(const ir_node *node)
254 {
255         assert(is_mips_irn(node) && "need mips node to get attributes");
256         return get_irn_generic_attr_const(node);
257 }
258
259 const mips_load_store_attr_t *get_mips_load_store_attr_const(
260                 const ir_node *node)
261 {
262         assert(is_mips_irn(node) && "need mips node to get attributes");
263         return get_irn_generic_attr_const(node);
264 }
265
266 /**
267  * Returns the argument register requirements of a mips node.
268  */
269 const arch_register_req_t **get_mips_in_req_all(const ir_node *node)
270 {
271         const mips_attr_t *attr = get_mips_attr_const(node);
272         return attr->in_req;
273 }
274
275 /**
276  * Returns the result register requirements of an mips node.
277  */
278 const arch_register_req_t **get_mips_out_req_all(const ir_node *node)
279 {
280         const mips_attr_t *attr = get_mips_attr_const(node);
281         return attr->out_req;
282 }
283
284 /**
285  * Returns the argument register requirement at position pos of an mips node.
286  */
287 const arch_register_req_t *get_mips_in_req(const ir_node *node, int pos)
288 {
289         const mips_attr_t *attr = get_mips_attr_const(node);
290         return attr->in_req[pos];
291 }
292
293 /**
294  * Returns the result register requirement at position pos of an mips node.
295  */
296 const arch_register_req_t *get_mips_out_req(const ir_node *node, int pos)
297 {
298         const mips_attr_t *attr = get_mips_attr_const(node);
299         return attr->out_req[pos];
300 }
301
302 /**
303  * Sets the OUT register requirements at position pos.
304  */
305 void set_mips_req_out(ir_node *node, const arch_register_req_t *req, int pos)
306 {
307         mips_attr_t *attr   = get_mips_attr(node);
308         attr->out_req[pos] = req;
309 }
310
311 /**
312  * Sets the IN register requirements at position pos.
313  */
314 void set_mips_req_in(ir_node *node, const arch_register_req_t *req, int pos)
315 {
316         mips_attr_t *attr  = get_mips_attr(node);
317         attr->in_req[pos] = req;
318 }
319
320 /**
321  * Returns the register flag of an mips node.
322  */
323 arch_irn_flags_t get_mips_flags(const ir_node *node)
324 {
325         const mips_attr_t *attr = get_mips_attr_const(node);
326         return attr->flags;
327 }
328
329 /**
330  * Sets the register flag of an mips node.
331  */
332 void set_mips_flags(ir_node *node, arch_irn_flags_t flags)
333 {
334         mips_attr_t *attr = get_mips_attr(node);
335         attr->flags      = flags;
336 }
337
338 /**
339  * Returns the result register slots of an mips node.
340  */
341 const arch_register_t **get_mips_slots(const ir_node *node)
342 {
343         const mips_attr_t *attr = get_mips_attr_const(node);
344         return attr->slots;
345 }
346
347 /**
348  * Returns the name of the OUT register at position pos.
349  */
350 const char *get_mips_out_reg_name(const ir_node *node, int pos)
351 {
352         const mips_attr_t *attr = get_mips_attr_const(node);
353
354         assert(is_mips_irn(node) && "Not an mips node.");
355         assert(pos < ARR_LEN(attr->slots) && "Invalid OUT position.");
356         assert(attr->slots[pos]  && "No register assigned");
357
358         return arch_register_get_name(attr->slots[pos]);
359 }
360
361 /**
362  * Returns the index of the OUT register at position pos within its register class.
363  */
364 int get_mips_out_regnr(const ir_node *node, int pos)
365 {
366         const mips_attr_t *attr = get_mips_attr_const(node);
367
368         assert(is_mips_irn(node) && "Not an mips node.");
369         assert(pos < ARR_LEN(attr->slots) && "Invalid OUT position.");
370         assert(attr->slots[pos]  && "No register assigned");
371
372         return arch_register_get_index(attr->slots[pos]);
373 }
374
375 /**
376  * Returns the OUT register at position pos.
377  */
378 const arch_register_t *get_mips_out_reg(const ir_node *node, int pos)
379 {
380         const mips_attr_t *attr = get_mips_attr_const(node);
381
382         assert(is_mips_irn(node) && "Not an mips node.");
383         assert(pos < ARR_LEN(attr->slots) && "Invalid OUT position.");
384         assert(attr->slots[pos]  && "No register assigned");
385
386         return attr->slots[pos];
387 }
388
389 /**
390  * Initializes the nodes attributes.
391  */
392 static void init_mips_attributes(ir_node *node, arch_irn_flags_t flags,
393                                  const arch_register_req_t **in_reqs,
394                                  const arch_register_req_t **out_reqs,
395                                  const be_execution_unit_t ***execution_units,
396                                  int n_res, unsigned latency)
397 {
398         ir_graph       *irg  = get_irn_irg(node);
399         struct obstack *obst = get_irg_obstack(irg);
400         mips_attr_t    *attr = get_mips_attr(node);
401         (void) execution_units;
402         (void) latency;
403
404         attr->flags   = flags;
405         attr->out_req = out_reqs;
406         attr->in_req  = in_reqs;
407
408         attr->slots = NEW_ARR_D(const arch_register_t*, obst, n_res);
409         memset(attr->slots, 0, n_res * sizeof(attr->slots[0]));
410 }
411
412 static void init_mips_immediate_attributes(ir_node *node,
413                                            mips_immediate_type_t type,
414                                            ir_entity *entity, long val)
415 {
416         mips_immediate_attr_t *attr = get_irn_generic_attr(node);
417
418         attr->imm_type = type;
419         attr->entity   = entity;
420         attr->val      = val;
421 }
422
423 static void init_mips_load_store_attributes(ir_node *node, ir_entity *entity,
424                                             long offset)
425 {
426         mips_load_store_attr_t *attr = get_irn_generic_attr(node);
427         attr->stack_entity = entity;
428         attr->offset       = offset;
429 }
430
431 static int mips_compare_nodes_attr(ir_node *node_a, ir_node *node_b)
432 {
433         const mips_attr_t *a = get_mips_attr_const(node_a);
434         const mips_attr_t *b = get_mips_attr_const(node_b);
435
436         if(a->flags != b->flags)
437                 return 1;
438         if(ARR_LEN(a->slots) != ARR_LEN(b->slots))
439                 return 1;
440         if(a->switch_default_pn != b->switch_default_pn)
441                 return 1;
442
443         return 0;
444 }
445
446 static int mips_compare_immediate_attr(ir_node *node_a, ir_node *node_b)
447 {
448         const mips_immediate_attr_t *a = get_mips_immediate_attr_const(node_a);
449         const mips_immediate_attr_t *b = get_mips_immediate_attr_const(node_b);
450
451         if(a->attr.flags != b->attr.flags)
452                 return 1;
453         if(a->val != b->val)
454                 return 1;
455
456         return 0;
457 }
458
459 static int mips_compare_load_store_attr(ir_node *node_a, ir_node *node_b)
460 {
461         const mips_load_store_attr_t *a = get_mips_load_store_attr_const(node_a);
462         const mips_load_store_attr_t *b = get_mips_load_store_attr_const(node_b);
463
464         if(mips_compare_nodes_attr(node_a, node_b))
465                 return 1;
466         if(a->stack_entity != b->stack_entity)
467                 return 1;
468         if(a->offset != b->offset)
469                 return 1;
470
471         return 0;
472 }
473
474 static void mips_copy_attr(const ir_node *old_node , ir_node *new_node)
475 {
476         ir_graph          *irg      = get_irn_irg(new_node);
477         struct obstack    *obst     = get_irg_obstack(irg);
478         const mips_attr_t *attr_old = get_mips_attr_const(old_node);
479         mips_attr_t       *attr_new = get_mips_attr(new_node);
480
481         /* copy the attributes */
482         memcpy(attr_new, attr_old, get_op_attr_size(get_irn_op(old_node)));
483
484         /* copy register assignments */
485         attr_new->slots = DUP_ARR_D(arch_register_t*, obst, attr_old->slots);
486 }
487
488 /***************************************************************************************
489  *                  _                            _                   _
490  *                 | |                          | |                 | |
491  *  _ __   ___   __| | ___    ___ ___  _ __  ___| |_ _ __ _   _  ___| |_ ___  _ __ ___
492  * | '_ \ / _ \ / _` |/ _ \  / __/ _ \| '_ \/ __| __| '__| | | |/ __| __/ _ \| '__/ __|
493  * | | | | (_) | (_| |  __/ | (_| (_) | | | \__ \ |_| |  | |_| | (__| || (_) | |  \__ \
494  * |_| |_|\___/ \__,_|\___|  \___\___/|_| |_|___/\__|_|   \__,_|\___|\__\___/|_|  |___/
495  *
496  ***************************************************************************************/
497
498 /* Include the generated constructor functions */
499 #include "gen_mips_new_nodes.c.inl"