fixed bug: Wrong opcode range was requested in be
[libfirm] / ir / be / arm / arm_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 arm
24  *         assembler irg.
25  * @author Oliver Richter, Tobias Gneist
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 "arm_nodes_attr.h"
49 #include "arm_new_nodes.h"
50 #include "gen_arm_regalloc_if_t.h"
51
52 #include "../beabi.h"
53 #include "bearch_arm_t.h"
54
55 /**
56  * Returns the shift modifier string.
57  */
58 const char *arm_shf_mod_name(arm_shift_modifier mod) {
59   static const char *names[] = { NULL, NULL, "asr", "lsl", "lsr", "ror", "rrx" };
60         return names[mod];
61 }
62
63 /***********************************************************************************
64  *      _                                   _       _             __
65  *     | |                                 (_)     | |           / _|
66  *   __| |_   _ _ __ ___  _ __   ___ _ __   _ _ __ | |_ ___ _ __| |_ __ _  ___ ___
67  *  / _` | | | | '_ ` _ \| '_ \ / _ \ '__| | | '_ \| __/ _ \ '__|  _/ _` |/ __/ _ \
68  * | (_| | |_| | | | | | | |_) |  __/ |    | | | | | ||  __/ |  | || (_| | (_|  __/
69  *  \__,_|\__,_|_| |_| |_| .__/ \___|_|    |_|_| |_|\__\___|_|  |_| \__,_|\___\___|
70  *                       | |
71  *                       |_|
72  ***********************************************************************************/
73
74 /**
75  * Dumps the register requirements for either in or out.
76  */
77 static void dump_reg_req(FILE *F, const ir_node *node,
78                          const arch_register_req_t **reqs, int inout) {
79         char *dir = inout ? "out" : "in";
80         int   max = inout ? get_arm_n_res(node) : get_irn_arity(node);
81         char  buf[1024];
82         int   i;
83
84         memset(buf, 0, sizeof(buf));
85
86         if (reqs) {
87                 for (i = 0; i < max; i++) {
88                         fprintf(F, "%sreq #%d =", dir, i);
89
90                         if (reqs[i]->type == arch_register_req_type_none) {
91                                 fprintf(F, " n/a");
92                         }
93
94                         if (reqs[i]->type & arch_register_req_type_normal) {
95                                 fprintf(F, " %s", reqs[i]->cls->name);
96                         }
97
98                         if (reqs[i]->type & arch_register_req_type_limited) {
99                                 fprintf(F, " %s",
100                                         arch_register_req_format(buf, sizeof(buf), reqs[i], node));
101                         }
102
103                         if (reqs[i]->type & arch_register_req_type_should_be_same) {
104                                 ir_fprintf(F, " same as %+F", get_irn_n(node, reqs[i]->other_same));
105                         }
106
107                         if (reqs[i]->type & arch_register_req_type_should_be_different) {
108                                 ir_fprintf(F, " different from %+F", get_irn_n(node, reqs[i]->other_different));
109                         }
110
111                         fprintf(F, "\n");
112                 }
113
114                 fprintf(F, "\n");
115         } else {
116                 fprintf(F, "%sreq = N/A\n", dir);
117         }
118 }
119
120 /**
121  * Dumper interface for dumping arm nodes in vcg.
122  * @param n        the node to dump
123  * @param F        the output file
124  * @param reason   indicates which kind of information should be dumped
125  * @return 0 on success or != 0 on failure
126  */
127 static int arm_dump_node(ir_node *n, FILE *F, dump_reason_t reason) {
128         ir_mode     *mode = NULL;
129         int          bad  = 0;
130         int          i;
131         arm_attr_t  *attr = get_arm_attr(n);
132         const arch_register_req_t **reqs;
133         const arch_register_t     **slots;
134         arm_shift_modifier        mod;
135
136         switch (reason) {
137                 case dump_node_opcode_txt:
138                         fprintf(F, "%s", get_irn_opname(n));
139                         break;
140
141                 case dump_node_mode_txt:
142                         mode = get_irn_mode(n);
143
144                         if (mode) {
145                                 fprintf(F, "[%s]", get_mode_name(mode));
146                         }
147                         else {
148                                 fprintf(F, "[?NOMODE?]");
149                         }
150                         break;
151
152                 case dump_node_nodeattr_txt:
153                         mod = ARM_GET_SHF_MOD(attr);
154                         if (ARM_HAS_SHIFT(mod)) {
155                                 fprintf(F, "[%s #%ld]", arm_shf_mod_name(mod), get_tarval_long(attr->value));
156                         }
157                         else if (mod == ARM_SHF_IMM) {
158                                 /* immediate */
159                                 fprintf(F, "[#0x%X]", arm_decode_imm_w_shift(attr->value));
160                         }
161                         break;
162
163                 case dump_node_info_txt:
164                         fprintf(F, "=== arm attr begin ===\n");
165
166                         /* dump IN requirements */
167                         if (get_irn_arity(n) > 0) {
168                                 reqs = get_arm_in_req_all(n);
169                                 dump_reg_req(F, n, reqs, 0);
170                         }
171
172                         /* dump OUT requirements */
173                         if (attr->n_res > 0) {
174                                 reqs = get_arm_out_req_all(n);
175                                 dump_reg_req(F, n, reqs, 1);
176                         }
177
178                         /* dump assigned registers */
179                         slots = get_arm_slots(n);
180                         if (slots && attr->n_res > 0) {
181                                 for (i = 0; i < attr->n_res; i++) {
182                                         if (slots[i]) {
183                                                 fprintf(F, "reg #%d = %s\n", i, slots[i]->name);
184                                         }
185                                         else {
186                                                 fprintf(F, "reg #%d = n/a\n", i);
187                                         }
188                                 }
189                         }
190                         fprintf(F, "\n");
191
192                         /* dump n_res */
193                         fprintf(F, "n_res = %d\n", get_arm_n_res(n));
194
195                         /* dump flags */
196                         fprintf(F, "flags =");
197                         if (attr->flags == arch_irn_flags_none) {
198                                 fprintf(F, " none");
199                         }
200                         else {
201                                 if (attr->flags & arch_irn_flags_dont_spill) {
202                                         fprintf(F, " unspillable");
203                                 }
204                                 if (attr->flags & arch_irn_flags_rematerializable) {
205                                         fprintf(F, " remat");
206                                 }
207                                 if (attr->flags & arch_irn_flags_ignore) {
208                                         fprintf(F, " ignore");
209                                 }
210                         }
211                         fprintf(F, " (%d)\n", attr->flags);
212
213                         if (get_arm_value(n)) {
214                                 if (is_arm_CopyB(n)) {
215                                         fprintf(F, "size = %lu\n", get_tarval_long(get_arm_value(n)));
216                                 } else {
217                                         if (mode_is_float(get_irn_mode(n))) {
218                                                 fprintf(F, "float value = (%f)\n", (double) get_tarval_double(get_arm_value(n)));
219                                         } else if (mode_is_int(get_irn_mode(n))) {
220                                                 long v =  get_tarval_long(get_arm_value(n));
221                                                 fprintf(F, "long value = %ld (0x%08lx)\n", v, v);
222                                         } else if (mode_is_reference(get_irn_mode(n))) {
223                                                 fprintf(F, "pointer\n");
224                                         } else {
225                                                 assert(0 && "unbehandelter Typ im const-Knoten");
226                                         }
227                                 }
228                         }
229                         if (get_arm_proj_num(n) >= 0) {
230                                 fprintf(F, "proj_num = (%d)\n", get_arm_proj_num(n));
231                         }
232                         /* TODO: dump all additional attributes */
233
234                         fprintf(F, "=== arm attr end ===\n");
235                         /* end of: case dump_node_info_txt */
236                         break;
237         }
238         return bad;
239 }
240
241
242
243 /***************************************************************************************************
244  *        _   _                   _       __        _                    _   _               _
245  *       | | | |                 | |     / /       | |                  | | | |             | |
246  *   __ _| |_| |_ _ __   ___  ___| |_   / /_ _  ___| |_   _ __ ___   ___| |_| |__   ___   __| |___
247  *  / _` | __| __| '__| / __|/ _ \ __| / / _` |/ _ \ __| | '_ ` _ \ / _ \ __| '_ \ / _ \ / _` / __|
248  * | (_| | |_| |_| |    \__ \  __/ |_ / / (_| |  __/ |_  | | | | | |  __/ |_| | | | (_) | (_| \__ \
249  *  \__,_|\__|\__|_|    |___/\___|\__/_/ \__, |\___|\__| |_| |_| |_|\___|\__|_| |_|\___/ \__,_|___/
250  *                                        __/ |
251  *                                       |___/
252  ***************************************************************************************************/
253
254 /**
255  * Wraps get_irn_generic_attr() as it takes no const ir_node, so we need to do a cast.
256  * Firm was made by people hating const :-(
257  */
258 arm_attr_t *get_arm_attr(const ir_node *node) {
259         assert(is_arm_irn(node) && "need arm node to get attributes");
260         return (arm_attr_t *)get_irn_generic_attr((ir_node *)node);
261 }
262
263 /**
264  * Returns the argument register requirements of a arm node.
265  */
266 const arch_register_req_t **get_arm_in_req_all(const ir_node *node) {
267         arm_attr_t *attr = get_arm_attr(node);
268         return attr->in_req;
269 }
270
271 /**
272  * Returns the result register requirements of an arm node.
273  */
274 const arch_register_req_t **get_arm_out_req_all(const ir_node *node) {
275         arm_attr_t *attr = get_arm_attr(node);
276         return attr->out_req;
277 }
278
279 /**
280  * Returns the argument register requirement at position pos of an arm node.
281  */
282 const arch_register_req_t *get_arm_in_req(const ir_node *node, int pos) {
283         arm_attr_t *attr = get_arm_attr(node);
284         return attr->in_req[pos];
285 }
286
287 /**
288  * Returns the result register requirement at position pos of an arm node.
289  */
290 const arch_register_req_t *get_arm_out_req(const ir_node *node, int pos) {
291         arm_attr_t *attr = get_arm_attr(node);
292         return attr->out_req[pos];
293 }
294
295 /**
296  * Sets the OUT register requirements at position pos.
297  */
298 void set_arm_req_out(ir_node *node, const arch_register_req_t *req, int pos) {
299         arm_attr_t *attr   = get_arm_attr(node);
300         attr->out_req[pos] = req;
301 }
302
303 /**
304  * Sets the complete OUT requirements of node.
305  */
306 void set_arm_req_out_all(ir_node *node, const arch_register_req_t **reqs) {
307         arm_attr_t *attr = get_arm_attr(node);
308         attr->out_req    = reqs;
309 }
310
311 /**
312  * Sets the IN register requirements at position pos.
313  */
314 void set_arm_req_in(ir_node *node, const arch_register_req_t *req, int pos) {
315         arm_attr_t *attr  = get_arm_attr(node);
316         attr->in_req[pos] = req;
317 }
318
319 /**
320  * Returns the register flag of an arm node.
321  */
322 arch_irn_flags_t get_arm_flags(const ir_node *node) {
323         arm_attr_t *attr = get_arm_attr(node);
324         return attr->flags;
325 }
326
327 /**
328  * Sets the register flag of an arm node.
329  */
330 void set_arm_flags(const ir_node *node, arch_irn_flags_t flags) {
331         arm_attr_t *attr = get_arm_attr(node);
332         attr->flags      = flags;
333 }
334
335 /**
336  * Returns the result register slots of an arm node.
337  */
338 const arch_register_t **get_arm_slots(const ir_node *node) {
339         arm_attr_t *attr = get_arm_attr(node);
340         return attr->slots;
341 }
342
343 /**
344  * Returns the name of the OUT register at position pos.
345  */
346 const char *get_arm_out_reg_name(const ir_node *node, int pos) {
347         arm_attr_t *attr = get_arm_attr(node);
348
349         assert(is_arm_irn(node) && "Not an arm node.");
350         assert(pos < attr->n_res && "Invalid OUT position.");
351         assert(attr->slots[pos]  && "No register assigned");
352
353         return arch_register_get_name(attr->slots[pos]);
354 }
355
356 /**
357  * Returns the index of the OUT register at position pos within its register class.
358  */
359 int get_arm_out_regnr(const ir_node *node, int pos) {
360         arm_attr_t *attr = get_arm_attr(node);
361
362         assert(is_arm_irn(node) && "Not an arm node.");
363         assert(pos < attr->n_res && "Invalid OUT position.");
364         assert(attr->slots[pos]  && "No register assigned");
365
366         return arch_register_get_index(attr->slots[pos]);
367 }
368
369 /**
370  * Returns the OUT register at position pos.
371  */
372 const arch_register_t *get_arm_out_reg(const ir_node *node, int pos) {
373         arm_attr_t *attr = get_arm_attr(node);
374
375         assert(is_arm_irn(node) && "Not an arm node.");
376         assert(pos < attr->n_res && "Invalid OUT position.");
377         assert(attr->slots[pos]  && "No register assigned");
378
379         return attr->slots[pos];
380 }
381
382 /**
383  * Sets the number of results.
384  */
385 void set_arm_n_res(ir_node *node, int n_res) {
386         arm_attr_t *attr = get_arm_attr(node);
387         attr->n_res      = n_res;
388 }
389
390 /**
391  * Returns the number of results.
392  */
393 int get_arm_n_res(const ir_node *node) {
394         arm_attr_t *attr = get_arm_attr(node);
395         return attr->n_res;
396 }
397 /**
398  * Returns the tarvalue
399  */
400 tarval *get_arm_value(const ir_node *node) {
401         arm_attr_t *attr = get_arm_attr(node);
402         return attr->value;
403 }
404
405 /**
406  * Sets the tarvalue
407  */
408 void set_arm_value(ir_node *node, tarval *tv) {
409         arm_attr_t *attr = get_arm_attr(node);
410         attr->value = tv;
411 }
412
413 /**
414  * Returns the proj num
415  */
416 int get_arm_proj_num(const ir_node *node) {
417         arm_attr_t *attr = get_arm_attr(node);
418         return attr->proj_num;
419 }
420
421 /**
422  * Sets the proj num
423  */
424 void set_arm_proj_num(ir_node *node, int proj_num) {
425         arm_attr_t *attr = get_arm_attr(node);
426         attr->proj_num      = proj_num;
427 }
428
429 /**
430  * Returns the SymConst label
431  */
432 ident *get_arm_symconst_id(const ir_node *node) {
433         arm_attr_t *attr = get_arm_attr(node);
434         return attr->symconst_id;
435 }
436
437 /**
438  * Sets the SymConst label
439  */
440 void set_arm_symconst_id(ir_node *node, ident *symconst_id) {
441         arm_attr_t *attr = get_arm_attr(node);
442         attr->symconst_id = symconst_id;
443 }
444
445
446 /**
447  * Returns the number of projs.
448  */
449 int get_arm_n_projs(const ir_node *node) {
450         arm_attr_t *attr = get_arm_attr(node);
451         return attr->n_projs;
452 }
453
454 /**
455  * Sets the number of projs.
456  */
457 void set_arm_n_projs(ir_node *node, int n_projs) {
458         arm_attr_t *attr = get_arm_attr(node);
459         attr->n_projs = n_projs;
460 }
461
462 /**
463  * Returns the default_proj_num.
464  */
465 long get_arm_default_proj_num(const ir_node *node) {
466         arm_attr_t *attr = get_arm_attr(node);
467         return attr->default_proj_num;
468 }
469
470 /**
471  * Sets the default_proj_num.
472  */
473 void set_arm_default_proj_num(ir_node *node, long default_proj_num) {
474         arm_attr_t *attr = get_arm_attr(node);
475         attr->default_proj_num = default_proj_num;
476 }
477
478 /**
479  * Gets the shift modifier attribute.
480  */
481 arm_shift_modifier get_arm_shift_modifier(const ir_node *node) {
482         arm_attr_t *attr = get_arm_attr(node);
483         return ARM_GET_SHF_MOD(attr);
484 }
485
486 /* Set the ARM machine node attributes to default values. */
487 void init_arm_attributes(ir_node *node, int flags, const arch_register_req_t ** in_reqs,
488                                                  const arch_register_req_t ** out_reqs, const be_execution_unit_t ***execution_units,
489                                                  int n_res, unsigned latency) {
490         arm_attr_t *attr = get_arm_attr(node);
491         attr->in_req           = in_reqs;
492         attr->out_req          = out_reqs;
493         attr->n_res            = n_res;
494         attr->flags            = flags;
495         attr->instr_fl         = (ARM_COND_AL << 3) | ARM_SHF_NONE;
496         attr->value            = NULL;
497         attr->proj_num         = -42;
498         attr->symconst_id      = NULL;
499         attr->n_projs          = 0;
500         attr->default_proj_num = 0;
501
502         memset((void *)attr->slots, 0, n_res * sizeof(attr->slots[0]));
503 }
504
505 static int arm_comp_condJmp(arm_attr_t *attr_a, arm_attr_t *attr_b) {
506         return 1;
507 }
508
509
510 /***************************************************************************************
511  *                  _                            _                   _
512  *                 | |                          | |                 | |
513  *  _ __   ___   __| | ___    ___ ___  _ __  ___| |_ _ __ _   _  ___| |_ ___  _ __ ___
514  * | '_ \ / _ \ / _` |/ _ \  / __/ _ \| '_ \/ __| __| '__| | | |/ __| __/ _ \| '__/ __|
515  * | | | | (_) | (_| |  __/ | (_| (_) | | | \__ \ |_| |  | |_| | (__| || (_) | |  \__ \
516  * |_| |_|\___/ \__,_|\___|  \___\___/|_| |_|___/\__|_|   \__,_|\___|\__\___/|_|  |___/
517  *
518  ***************************************************************************************/
519
520 #ifdef BIT
521 #undef BIT
522 #endif
523 #define BIT(x)  (1 << (x % 32))
524
525 static unsigned arm_req_sp_limited[] = { BIT(REG_SP) };
526 static const arch_register_req_t _arm_req_sp = {
527         arch_register_req_type_limited,
528         &arm_reg_classes[CLASS_arm_gp],
529         arm_req_sp_limited,
530         -1,
531         -1
532 };
533
534 /* construct Store: Store(ptr, val, mem) = ST ptr,val */
535 ir_node *new_r_arm_StoreStackMInc(ir_graph *irg, ir_node *block, ir_node *mem,
536                                   ir_node *sp, int n_regs, ir_node **regs,
537                                   ir_mode *mode) {
538         ir_node *res;
539         ir_node *in[16];
540         int flags = 0;
541         static const arch_register_req_t *_in_req_arm_StoreStackM4Inc[] =
542         {
543                 &arm_StoreStackM4Inc_reg_req_in_0,
544                 &arm_StoreStackM4Inc_reg_req_in_1,
545                 &arm_StoreStackM4Inc_reg_req_in_2,
546                 &arm_StoreStackM4Inc_reg_req_in_2,
547                 &arm_StoreStackM4Inc_reg_req_in_2,
548                 &arm_StoreStackM4Inc_reg_req_in_2,
549                 &arm_StoreStackM4Inc_reg_req_in_2,
550                 &arm_StoreStackM4Inc_reg_req_in_2,
551                 &arm_StoreStackM4Inc_reg_req_in_2,
552                 &arm_StoreStackM4Inc_reg_req_in_2,
553                 &arm_StoreStackM4Inc_reg_req_in_2,
554                 &arm_StoreStackM4Inc_reg_req_in_2,
555                 &arm_StoreStackM4Inc_reg_req_in_2,
556                 &arm_StoreStackM4Inc_reg_req_in_2,
557                 &arm_StoreStackM4Inc_reg_req_in_2,
558                 &arm_StoreStackM4Inc_reg_req_in_2,
559                 &arm_StoreStackM4Inc_reg_req_in_2,
560         };
561
562         assert(n_regs <= 15);
563
564         in[0] = mem;
565         in[1] = sp;
566         memcpy(&in[2], regs, n_regs * sizeof(in[0]));
567         res = new_ir_node(NULL, irg, block, op_arm_StoreStackM4Inc, mode, 2 + n_regs, in);
568         flags |= arch_irn_flags_rematerializable;   /* op can be easily recalculated */
569
570         /* init node attributes */
571         init_arm_attributes(res, flags, _in_req_arm_StoreStackM4Inc, NULL, NULL, 0, 1);
572
573         res = optimize_node(res);
574         irn_vrfy_irg(res, irg);
575
576         return res;
577 }
578
579 /************************************************
580  *   ___        _   _           _               *
581  *  / _ \ _ __ | |_(_)_ __ ___ (_)_______ _ __  *
582  * | | | | '_ \| __| | '_ ` _ \| |_  / _ \ '__| *
583  * | |_| | |_) | |_| | | | | | | |/ /  __/ |    *
584  *  \___/| .__/ \__|_|_| |_| |_|_/___\___|_|    *
585  *       |_|                                    *
586  ************************************************/
587
588 typedef struct _opt_tuple {
589         ir_op *op_imm_left;             /**< immediate is left */
590         ir_op *op_imm_right;    /**< immediate is right */
591         ir_op *op_shf_left;             /**< shift operand on left */
592         ir_op *op_shf_right;    /**< shift operand on right */
593 } opt_tuple;
594
595 //static const opt_tuple *opt_ops[iro_arm_last];
596
597 void arm_set_optimizers(void) {
598         /*
599 #define STD(op)         p_##op = { op_arm_##op##_i, op_arm_##op##_i, op_arm_##op, op_arm_##op }
600 #define LEFT(op)        p_##op = { op_arm_##op##_i, NULL, op_arm_##op, NULL }
601 #define SET(op)   opt_ops[iro_arm_##op] = &p_##op;
602
603         static const opt_tuple
604                 STD(Add),
605                 STD(And),
606                 STD(Or),
607                 STD(Eor),
608                 LEFT(Bic),
609                 LEFT(Shl),
610                 LEFT(Shr),
611                 LEFT(Shrs),
612                 p_Sub = { op_arm_Sub_i, op_arm_Rsb_i, op_arm_Sub, op_arm_Rsb },
613
614         memset(opt_ops, 0, sizeof(opt_ops));
615         SET(Add);
616         SET(And);
617         SET(Or);
618         SET(Eor);
619         SET(Sub);
620         SET(Bic);
621         SET(Shl);
622         SET(Shr);
623         SET(Shrs);
624         */
625 }
626
627 /* Include the generated constructor functions */
628 #include "gen_arm_new_nodes.c.inl"