Implement binary emitter for Minus64Bit.
[libfirm] / ir / be / ia32 / ia32_address_mode.c
1 /*
2  * Copyright (C) 1995-2008 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 contains functions for matching firm graphs for
23  *              nodes that can be used as address mode for x86 instructions
24  * @author      Matthias Braun
25  * @version     $Id$
26  */
27 #include "config.h"
28
29 #include "ia32_address_mode.h"
30 #include "ia32_transform.h"
31
32 #include "irtypes.h"
33 #include "irnode_t.h"
34 #include "irprintf.h"
35 #include "error.h"
36 #include "iredges_t.h"
37 #include "irgwalk.h"
38
39 #include "../benode.h"
40 #include "../belive.h"
41
42 #define AGGRESSIVE_AM
43
44 /* gas/ld don't support negative symconsts :-( */
45 #undef SUPPORT_NEGATIVE_SYMCONSTS
46
47 static bitset_t *non_address_mode_nodes;
48
49 /**
50  * Recursive worker for checking if a DAG with root node can be represented as a simple immediate,
51  *
52  * @param node       the node
53  * @param symconsts  number of symconsts found so far
54  * @param negate     if set, the immediate must be negated
55  *
56  * @return non-zero if the DAG represents an immediate, 0 else
57  */
58 static int do_is_immediate(const ir_node *node, int *symconsts, int negate)
59 {
60         ir_node *left;
61         ir_node *right;
62
63         switch (get_irn_opcode(node)) {
64         case iro_Const:
65                 /* Consts are typically immediates */
66                 if (!tarval_is_long(get_Const_tarval(node))) {
67 #ifdef DEBUG_libfirm
68                         ir_fprintf(stderr,
69                                    "Optimisation warning tarval of %+F(%+F) is not a long.\n",
70                                    node, current_ir_graph);
71 #endif
72                         return 0;
73                 }
74                 return 1;
75         case iro_SymConst:
76                 /* the first SymConst of a DAG can be fold into an immediate */
77 #ifndef SUPPORT_NEGATIVE_SYMCONSTS
78                 /* unfortunately the assembler/linker doesn't support -symconst */
79                 if (negate)
80                         return 0;
81 #endif
82
83                 if (get_SymConst_kind(node) != symconst_addr_ent)
84                         return 0;
85                 (*symconsts)++;
86                 if (*symconsts > 1)
87                         return 0;
88
89                 return 1;
90         case iro_Add:
91         case iro_Sub:
92                 /* Add's and Sub's are typically supported as long as both operands are
93                  * immediates */
94                 if (ia32_is_non_address_mode_node(node))
95                         return 0;
96
97                 left  = get_binop_left(node);
98                 right = get_binop_right(node);
99                 if (!do_is_immediate(left, symconsts, negate))
100                         return 0;
101                 if (!do_is_immediate(right, symconsts, is_Sub(node) ? !negate : negate))
102                         return 0;
103
104                 return 1;
105         default:
106                 /* all other nodes are NO immediates */
107                 return 0;
108         }
109 }
110
111 /**
112  * Checks if a DAG with a single root node can be represented as a simple immediate.
113  *
114  * @param node  the node
115  *
116  * @return non-zero if the DAG represents an immediate, 0 else
117  */
118 #if 0
119 static int is_immediate_simple(const ir_node *node) {
120         int symconsts = 0;
121         return do_is_immediate(node, &symconsts, 0);
122 }
123 #endif
124
125 /**
126  * Check if a DAG starting with root node can be folded into an address mode
127  * as an immediate.
128  *
129  * @param addr    the address mode data so far
130  * @param node    the node
131  * @param negate  if set, the immediate must be negated
132  */
133 static int is_immediate(ia32_address_t *addr, const ir_node *node, int negate)
134 {
135         int symconsts = (addr->symconst_ent != NULL);
136         return do_is_immediate(node, &symconsts, negate);
137 }
138
139 /**
140  * Place a DAG with root node into an address mode.
141  *
142  * @param addr    the address mode data so far
143  * @param node    the node
144  * @param negate  if set, the immediate must be negated
145  */
146 static void eat_immediate(ia32_address_t *addr, ir_node *node, int negate)
147 {
148         tarval  *tv;
149         ir_node *left;
150         ir_node *right;
151         long    val;
152
153         switch (get_irn_opcode(node)) {
154         case iro_Const:
155                 /* simply add the value to the offset */
156                 tv = get_Const_tarval(node);
157                 val = get_tarval_long(tv);
158                 if (negate) {
159                         addr->offset -= val;
160                 } else {
161                         addr->offset += val;
162                 }
163                 break;
164         case iro_SymConst:
165                 /* place the entity into the symconst */
166                 if (addr->symconst_ent != NULL) {
167                         panic("Internal error: more than 1 symconst in address calculation");
168                 }
169                 addr->symconst_ent  = get_SymConst_entity(node);
170 #ifndef SUPPORT_NEGATIVE_SYMCONSTS
171                 assert(!negate);
172 #endif
173                 addr->symconst_sign = negate;
174                 break;
175         case iro_Add:
176                 assert(!ia32_is_non_address_mode_node(node));
177                 left  = get_Add_left(node);
178                 right = get_Add_right(node);
179                 eat_immediate(addr, left, negate);
180                 eat_immediate(addr, right, negate);
181                 break;
182         case iro_Sub:
183                 assert(!ia32_is_non_address_mode_node(node));
184                 left  = get_Sub_left(node);
185                 right = get_Sub_right(node);
186                 eat_immediate(addr, left, negate);
187                 eat_immediate(addr, right, !negate);
188                 break;
189         default:
190                 panic("Internal error in immediate address calculation");
191         }
192 }
193
194 /**
195  * Place operands of node into an address mode.
196  *
197  * @param addr    the address mode data so far
198  * @param node    the node
199  * @param flags   the flags
200  *
201  * @return the folded node
202  */
203 static ir_node *eat_immediates(ia32_address_t *addr, ir_node *node,
204                                ia32_create_am_flags_t flags)
205 {
206         if (!(flags & ia32_create_am_force)     &&
207                         ia32_is_non_address_mode_node(node) &&
208                         (!(flags & ia32_create_am_double_use) || get_irn_n_edges(node) > 2))
209                 return node;
210
211         if (is_Add(node)) {
212                 ir_node *left  = get_Add_left(node);
213                 ir_node *right = get_Add_right(node);
214
215                 if (is_immediate(addr, left, 0)) {
216                         eat_immediate(addr, left, 0);
217                         return eat_immediates(addr, right, 0);
218                 }
219                 if (is_immediate(addr, right, 0)) {
220                         eat_immediate(addr, right, 0);
221                         return eat_immediates(addr, left, 0);
222                 }
223         } else if (is_Sub(node)) {
224                 ir_node *left  = get_Sub_left(node);
225                 ir_node *right = get_Sub_right(node);
226
227                 if (is_immediate(addr, right, 1)) {
228                         eat_immediate(addr, right, 1);
229                         return eat_immediates(addr, left, 0);
230                 }
231         }
232
233         return node;
234 }
235
236 /**
237  * Try to place a Shl into an address mode.
238  *
239  * @param addr    the address mode data so far
240  * @param node   the node to place
241  *
242  * @return non-zero on success
243  */
244 static int eat_shl(ia32_address_t *addr, ir_node *node)
245 {
246         ir_node *shifted_val;
247         long     val;
248
249         if (is_Shl(node)) {
250                 ir_node *right = get_Shl_right(node);
251                 tarval  *tv;
252
253                 /* we can use shl with 1, 2 or 3 shift */
254                 if (!is_Const(right))
255                         return 0;
256                 tv = get_Const_tarval(right);
257                 if (!tarval_is_long(tv))
258                         return 0;
259
260                 val = get_tarval_long(tv);
261                 if (val < 0 || val > 3)
262                         return 0;
263                 if (val == 0) {
264                         ir_fprintf(stderr, "Optimisation warning: unoptimized Shl(,0) found\n");
265                 }
266
267                 shifted_val = get_Shl_left(node);
268         } else if (is_Add(node)) {
269                 /* might be an add x, x */
270                 ir_node *left  = get_Add_left(node);
271                 ir_node *right = get_Add_right(node);
272
273                 if (left != right)
274                         return 0;
275                 if (is_Const(left))
276                         return 0;
277
278                 val         = 1;
279                 shifted_val = left;
280         } else {
281                 return 0;
282         }
283
284         /* we can only eat a shl if we don't have a scale or index set yet */
285         if (addr->scale != 0 || addr->index != NULL)
286                 return 0;
287         if (ia32_is_non_address_mode_node(node))
288                 return 0;
289
290 #ifndef AGGRESSIVE_AM
291         if (get_irn_n_edges(node) > 1)
292                 return 0;
293 #endif
294
295         addr->scale = val;
296         addr->index = shifted_val;
297         return 1;
298 }
299
300 /* Create an address mode for a given node. */
301 void ia32_create_address_mode(ia32_address_t *addr, ir_node *node, ia32_create_am_flags_t flags)
302 {
303         int      res = 0;
304         ir_node *eat_imms;
305
306         if (is_immediate(addr, node, 0)) {
307                 eat_immediate(addr, node, 0);
308                 return;
309         }
310
311 #ifndef AGGRESSIVE_AM
312         if (!(flags & ia32_create_am_force) && get_irn_n_edges(node) > 1) {
313                 addr->base = node;
314                 return;
315         }
316 #endif
317
318         if (!(flags & ia32_create_am_force)     &&
319                         ia32_is_non_address_mode_node(node) &&
320                         (!(flags & ia32_create_am_double_use) || get_irn_n_edges(node) > 2)) {
321                 addr->base = node;
322                 return;
323         }
324
325         eat_imms = eat_immediates(addr, node, flags);
326         if (eat_imms != node) {
327                 if (flags & ia32_create_am_force) {
328                         eat_imms = ia32_skip_downconv(eat_imms);
329                 }
330
331                 res  = 1;
332                 node = eat_imms;
333 #ifndef AGGRESSIVE_AM
334                 if (get_irn_n_edges(node) > 1) {
335                         addr->base = node;
336                         return;
337                 }
338 #endif
339                 if (ia32_is_non_address_mode_node(node)) {
340                         addr->base = node;
341                         return;
342                 }
343         }
344
345         /* starting point Add, Sub or Shl, FrameAddr */
346         if (is_Shl(node)) {
347                 /* We don't want to eat add x, x as shl here, so only test for real Shl
348                  * instructions, because we want the former as Lea x, x, not Shl x, 1 */
349                 if (eat_shl(addr, node))
350                         return;
351         } else if (is_immediate(addr, node, 0)) {
352                 eat_immediate(addr, node, 0);
353                 return;
354         } else if (be_is_FrameAddr(node)) {
355                 assert(addr->base == NULL);
356                 assert(addr->frame_entity == NULL);
357                 addr->base         = be_get_FrameAddr_frame(node);
358                 addr->use_frame    = 1;
359                 addr->frame_entity = be_get_FrameAddr_entity(node);
360                 return;
361         } else if (is_Add(node)) {
362                 ir_node *left  = get_Add_left(node);
363                 ir_node *right = get_Add_right(node);
364
365                 if (flags & ia32_create_am_force) {
366                         left  = ia32_skip_downconv(left);
367                         right = ia32_skip_downconv(right);
368                 }
369
370                 assert(flags & ia32_create_am_force || !is_immediate(addr, left,  0));
371                 assert(flags & ia32_create_am_force || !is_immediate(addr, right, 0));
372
373                 if (eat_shl(addr, left)) {
374                         left = NULL;
375                 } else if (eat_shl(addr, right)) {
376                         right = NULL;
377                 }
378                 if (left != NULL          &&
379                                 be_is_FrameAddr(left) &&
380                                 !ia32_is_non_address_mode_node(left)) {
381                         assert(addr->base == NULL);
382                         assert(addr->frame_entity == NULL);
383                         addr->base         = be_get_FrameAddr_frame(left);
384                         addr->use_frame    = 1;
385                         addr->frame_entity = be_get_FrameAddr_entity(left);
386                         left               = NULL;
387                 } else if (right != NULL   &&
388                                 be_is_FrameAddr(right) &&
389                                 !ia32_is_non_address_mode_node(right)) {
390                         assert(addr->base == NULL);
391                         assert(addr->frame_entity == NULL);
392                         addr->base         = be_get_FrameAddr_frame(right);
393                         addr->use_frame    = 1;
394                         addr->frame_entity = be_get_FrameAddr_entity(right);
395                         right              = NULL;
396                 }
397
398                 if (left != NULL) {
399                         if (addr->base != NULL) {
400                                 assert(addr->index == NULL && addr->scale == 0);
401                                 assert(right == NULL);
402                                 addr->index = left;
403                         } else {
404                                 addr->base = left;
405                         }
406                 }
407                 if (right != NULL) {
408                         if (addr->base == NULL) {
409                                 addr->base = right;
410                         } else {
411                                 assert(addr->index == NULL && addr->scale == 0);
412                                 addr->index = right;
413                         }
414                 }
415                 return;
416         }
417
418         addr->base = node;
419 }
420
421 void ia32_mark_non_am(ir_node *node)
422 {
423         bitset_set(non_address_mode_nodes, get_irn_idx(node));
424 }
425
426 int ia32_is_non_address_mode_node(ir_node const *node)
427 {
428         return bitset_is_set(non_address_mode_nodes, get_irn_idx(node));
429 }
430
431 static int value_last_used_here(be_lv_t *lv, ir_node *here, ir_node *value)
432 {
433         ir_node         *block = get_nodes_block(here);
434         const ir_edge_t *edge;
435
436         /* If the value is live end it is for sure it does not die here */
437         if (be_is_live_end(lv, block, value)) return 0;
438
439         /* if multiple nodes in this block use the value, then we cannot decide
440          * whether the value will die here (because there is no schedule yet).
441          * Assume it does not die in this case. */
442         foreach_out_edge(value, edge) {
443                 ir_node *user = get_edge_src_irn(edge);
444                 if (user != here && get_nodes_block(user) == block) {
445                         return 0;
446                 }
447         }
448
449         return 1;
450 }
451
452 /**
453  * Walker: mark those nodes that cannot be part of an address mode because
454  * their value must be accessed through a register
455  */
456 static void mark_non_address_nodes(ir_node *node, void *env)
457 {
458         be_lv_t *lv = env;
459         int      arity;
460         int      i;
461         ir_node *val;
462         ir_node *left;
463         ir_node *right;
464         ir_mode *mode;
465
466         mode = get_irn_mode(node);
467         if (!mode_is_int(mode) && !mode_is_reference(mode) && mode != mode_b)
468                 return;
469
470         switch (get_irn_opcode(node)) {
471         case iro_Load:
472                 /* Nothing to do. especially do not mark the pointer, because we want to
473                  * turn it into AM. */
474                 break;
475
476         case iro_Store:
477                 /* Do not mark the pointer, because we want to turn it into AM. */
478                 val = get_Store_value(node);
479                 ia32_mark_non_am(val);
480                 break;
481
482         case iro_Shl:
483         case iro_Add:
484                 /* only 1 user: AM folding is always beneficial */
485                 if (get_irn_n_edges(node) <= 1)
486                         break;
487
488                 /* for adds and shls with multiple users we use this heuristic:
489                  * we do not fold them into address mode if their operands don't live
490                  * out of the block, because in this case we will reduce register
491                  * pressure. Otherwise we fold them in aggressively in the hope, that
492                  * the node itself doesn't exist anymore and we were able to save the
493                  * register for the result */
494                 left  = get_binop_left(node);
495                 right = get_binop_right(node);
496
497                 /* Fold AM if any of the two operands does not die here.  This duplicates
498                  * an addition and has the same register pressure for the case that only
499                  * one operand dies, but is faster (on Pentium 4).
500                  * && instead of || only folds AM if both operands do not die here */
501                 if (!value_last_used_here(lv, node, left) ||
502                                 !value_last_used_here(lv, node, right)) {
503                         return;
504                 }
505
506                 /* At least one of left and right are not used by anyone else, so it is
507                  * beneficial for the register pressure (if both are unused otherwise,
508                  * else neutral) and ALU use to not fold AM. */
509                 ia32_mark_non_am(node);
510                 break;
511
512         default:
513                 arity = get_irn_arity(node);
514
515                 for (i = 0; i < arity; ++i) {
516                         ir_node *in = get_irn_n(node, i);
517                         ia32_mark_non_am(in);
518                 }
519                 break;
520         }
521 }
522
523 void ia32_calculate_non_address_mode_nodes(be_irg_t *birg)
524 {
525         ir_graph *irg = be_get_birg_irg(birg);
526         be_lv_t  *lv  = be_assure_liveness(birg);
527
528         non_address_mode_nodes = bitset_malloc(get_irg_last_idx(irg));
529
530         irg_walk_graph(irg, NULL, mark_non_address_nodes, lv);
531 }
532
533 void ia32_free_non_address_mode_nodes(void)
534 {
535         bitset_free(non_address_mode_nodes);
536 }