fix AM matcher seeing add x, x as value with scale 2
[libfirm] / ir / be / ia32 / ia32_address_mode.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 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 #ifdef HAVE_CONFIG_H
28 #include "config.h"
29 #endif
30
31 #include "ia32_address_mode.h"
32 #include "ia32_transform.h"
33
34 #include "irtypes.h"
35 #include "irnode_t.h"
36 #include "irprintf.h"
37 #include "error.h"
38 #include "iredges_t.h"
39 #include "irgwalk.h"
40
41 #include "../benode_t.h"
42
43 #define AGGRESSIVE_AM
44
45 /* gas/ld don't support negative symconsts :-( */
46 #undef SUPPORT_NEGATIVE_SYMCONSTS
47
48 static bitset_t *non_address_mode_nodes;
49
50 /**
51  * Recursive worker for checking if a DAG with root node can be represented as a simple immediate,
52  *
53  * @param node       the node
54  * @param symconsts  number of symconsts found so far
55  * @param negate     if set, the immediate must be negated
56  *
57  * @return non-zero if the DAG represents an immediate, 0 else
58  */
59 static int do_is_immediate(const ir_node *node, int *symconsts, int negate)
60 {
61         ir_node *left;
62         ir_node *right;
63
64         switch (get_irn_opcode(node)) {
65         case iro_Const:
66                 /* Consts are typically immediates */
67                 if (!tarval_is_long(get_Const_tarval(node))) {
68 #ifdef DEBUG_libfirm
69                         ir_fprintf(stderr, "Optimisation warning tarval of %+F(%+F) is not "
70                                    "a long.\n", 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 immediates */
93                 if(bitset_is_set(non_address_mode_nodes, get_irn_idx(node)))
94                         return 0;
95
96                 left  = get_binop_left(node);
97                 right = get_binop_right(node);
98                 if(!do_is_immediate(left, symconsts, negate))
99                         return 0;
100                 if(!do_is_immediate(right, symconsts, is_Sub(node) ? !negate : negate))
101                         return 0;
102
103                 return 1;
104         default:
105                 /* all other nodes are NO immediates */
106                 return 0;
107         }
108 }
109
110 /**
111  * Checks if a DAG with a single root node can be represented as a simple immediate.
112  *
113  * @param node  the node
114  *
115  * @return non-zero if the DAG represents an immediate, 0 else
116  */
117 static int is_immediate_simple(const ir_node *node) {
118         int symconsts = 0;
119         return do_is_immediate(node, &symconsts, 0);
120 }
121
122 /**
123  * Check if a DAG starting with root node can be folded into an address mode
124  * as an immediate.
125  *
126  * @param addr    the address mode data so far
127  * @param node    the node
128  * @param negate  if set, the immediate must be negated
129  */
130 static int is_immediate(ia32_address_t *addr, const ir_node *node, int negate)
131 {
132         int symconsts = (addr->symconst_ent != NULL);
133         return do_is_immediate(node, &symconsts, negate);
134 }
135
136 /**
137  * Place a DAG with root node into an address mode.
138  *
139  * @param addr    the address mode data so far
140  * @param node    the node
141  * @param negate  if set, the immediate must be negated
142  */
143 static void eat_immediate(ia32_address_t *addr, ir_node *node, int negate)
144 {
145         tarval  *tv;
146         ir_node *left;
147         ir_node *right;
148         long    val;
149
150         switch (get_irn_opcode(node)) {
151         case iro_Const:
152                 /* simply add the value to the offset */
153                 tv = get_Const_tarval(node);
154                 val = get_tarval_long(tv);
155                 if (negate) {
156                         addr->offset -= val;
157                 } else {
158                         addr->offset += val;
159                 }
160                 break;
161         case iro_SymConst:
162                 /* place the entity into the symconst */
163                 if (addr->symconst_ent != NULL) {
164                         panic("Internal error: more than 1 symconst in address "
165                               "calculation");
166                 }
167                 addr->symconst_ent  = get_SymConst_entity(node);
168 #ifndef SUPPORT_NEGATIVE_SYMCONSTS
169                 assert(!negate);
170 #endif
171                 addr->symconst_sign = negate;
172                 break;
173         case iro_Add:
174                 assert(!bitset_is_set(non_address_mode_nodes, get_irn_idx(node)));
175                 left  = get_Add_left(node);
176                 right = get_Add_right(node);
177                 eat_immediate(addr, left, negate);
178                 eat_immediate(addr, right, negate);
179                 break;
180         case iro_Sub:
181                 assert(!bitset_is_set(non_address_mode_nodes, get_irn_idx(node)));
182                 left  = get_Sub_left(node);
183                 right = get_Sub_right(node);
184                 eat_immediate(addr, left, negate);
185                 eat_immediate(addr, right, !negate);
186                 break;
187         default:
188                 panic("Internal error in immediate address calculation");
189         }
190 }
191
192 /**
193  * Place operands of node into an address mode.
194  *
195  * @param addr    the address mode data so far
196  * @param node    the node
197  * @param force   if set, ignore the marking of node as a non-address-mode node
198  *
199  * @return the folded node
200  */
201 static ir_node *eat_immediates(ia32_address_t *addr, ir_node *node, int force)
202 {
203         if(!force && bitset_is_set(non_address_mode_nodes, get_irn_idx(node)))
204                 return node;
205
206         if(is_Add(node)) {
207                 ir_node *left  = get_Add_left(node);
208                 ir_node *right = get_Add_right(node);
209
210                 if(is_immediate(addr, left, 0)) {
211                         eat_immediate(addr, left, 0);
212                         return eat_immediates(addr, right, 0);
213                 }
214                 if(is_immediate(addr, right, 0)) {
215                         eat_immediate(addr, right, 0);
216                         return eat_immediates(addr, left, 0);
217                 }
218         } else if(is_Sub(node)) {
219                 ir_node *left  = get_Sub_left(node);
220                 ir_node *right = get_Sub_right(node);
221
222                 if(is_immediate(addr, right, 1)) {
223                         eat_immediate(addr, right, 1);
224                         return eat_immediates(addr, left, 0);
225                 }
226         }
227
228         return node;
229 }
230
231 /**
232  * Try to place a Shl into an address mode.
233  *
234  * @param addr    the address mode data so far
235  * @param node   the node to place
236  *
237  * @return non-zero on success
238  */
239 static int eat_shl(ia32_address_t *addr, ir_node *node)
240 {
241         ir_node *shifted_val;
242         long     val;
243
244         if(is_Shl(node)) {
245                 ir_node *right = get_Shl_right(node);
246                 tarval  *tv;
247
248                 /* we can use shl with 1, 2 or 3 shift */
249                 if(!is_Const(right))
250                         return 0;
251                 tv = get_Const_tarval(right);
252                 if(!tarval_is_long(tv))
253                         return 0;
254
255                 val = get_tarval_long(tv);
256                 if(val < 0 || val > 3)
257                         return 0;
258                 if(val == 0) {
259                         ir_fprintf(stderr, "Optimisation warning: unoptimized Shl(,0) "
260                                    "found\n");
261                 }
262
263                 shifted_val = get_Shl_left(node);
264         } else if(is_Add(node)) {
265                 /* might be an add x, x */
266                 ir_node *left  = get_Add_left(node);
267                 ir_node *right = get_Add_right(node);
268
269                 if(left != right)
270                         return 0;
271                 if(is_Const(left))
272                         return 0;
273
274                 val         = 1;
275                 shifted_val = left;
276         } else {
277                 return 0;
278         }
279
280         /* we can only eat a shl if we don't have a scale or index set yet */
281         if(addr->scale != 0 || addr->index != NULL)
282                 return 0;
283         if(bitset_is_set(non_address_mode_nodes, get_irn_idx(node)))
284                 return 0;
285
286 #ifndef AGGRESSIVE_AM
287         if(get_irn_n_edges(node) > 1)
288                 return 0;
289 #endif
290
291         addr->scale = val;
292         addr->index = eat_immediates(addr, shifted_val, 0);
293         return 1;
294 }
295
296 /**
297  * Returns non-zero if a value of a given mode can be stored in GP registers.
298  */
299 static INLINE int mode_needs_gp_reg(ir_mode *mode) {
300         if(mode == mode_fpcw)
301                 return 0;
302         if(get_mode_size_bits(mode) > 32)
303                 return 0;
304         return mode_is_int(mode) || mode_is_reference(mode) || mode == mode_b;
305 }
306
307 /* Create an address mode for a given node. */
308 void ia32_create_address_mode(ia32_address_t *addr, ir_node *node, int force)
309 {
310         int      res = 0;
311         ir_node *eat_imms;
312
313         if(is_immediate(addr, node, 0)) {
314                 eat_immediate(addr, node, 0);
315                 return;
316         }
317
318 #ifndef AGGRESSIVE_AM
319         if(!force && get_irn_n_edges(node) > 1) {
320                 addr->base = node;
321                 return;
322         }
323 #endif
324
325         if(!force && bitset_is_set(non_address_mode_nodes, get_irn_idx(node))) {
326                 addr->base = node;
327                 return;
328         }
329
330         eat_imms = eat_immediates(addr, node, force);
331         if(eat_imms != node) {
332                 if(force) {
333                         eat_imms = ia32_skip_downconv(eat_imms);
334                 }
335
336                 res  = 1;
337                 node = eat_imms;
338 #ifndef AGGRESSIVE_AM
339                 if(get_irn_n_edges(node) > 1) {
340                         addr->base = node;
341                         return;
342                 }
343 #endif
344                 if(bitset_is_set(non_address_mode_nodes, get_irn_idx(node))) {
345                         addr->base = node;
346                         return;
347                 }
348         }
349
350         /* starting point Add, Sub or Shl, FrameAddr */
351         if(is_Shl(node)) { /* we don't want to eat add x, x as shl here, so only
352                               test for real Shl instructions */
353                 if(eat_shl(addr, node))
354                         return;
355         } else if(is_immediate(addr, node, 0)) {
356                 eat_immediate(addr, node, 0);
357                 return;
358         } else if(be_is_FrameAddr(node)) {
359                 assert(addr->base == NULL);
360                 assert(addr->frame_entity == NULL);
361                 addr->base         = be_get_FrameAddr_frame(node);
362                 addr->use_frame    = 1;
363                 addr->frame_entity = be_get_FrameAddr_entity(node);
364                 return;
365         } else if(is_Add(node)) {
366                 ir_node *left  = get_Add_left(node);
367                 ir_node *right = get_Add_right(node);
368
369                 if(force) {
370                         left  = ia32_skip_downconv(left);
371                         right = ia32_skip_downconv(right);
372                 }
373
374                 assert(force || !is_immediate(addr, left, 0));
375                 assert(force || !is_immediate(addr, right, 0));
376
377                 if(eat_shl(addr, left)) {
378                         left = NULL;
379                 } else if(eat_shl(addr, right)) {
380                         right = NULL;
381                 }
382                 if(left != NULL && be_is_FrameAddr(left)
383                                 && !bitset_is_set(non_address_mode_nodes, get_irn_idx(left))) {
384                         assert(addr->base == NULL);
385                         assert(addr->frame_entity == NULL);
386                         addr->base         = be_get_FrameAddr_frame(left);
387                         addr->use_frame    = 1;
388                         addr->frame_entity = be_get_FrameAddr_entity(left);
389                         left               = NULL;
390                 } else if(right != NULL && be_is_FrameAddr(right)
391                                 && !bitset_is_set(non_address_mode_nodes, get_irn_idx(right))) {
392                         assert(addr->base == NULL);
393                         assert(addr->frame_entity == NULL);
394                         addr->base         = be_get_FrameAddr_frame(right);
395                         addr->use_frame    = 1;
396                         addr->frame_entity = be_get_FrameAddr_entity(right);
397                         right              = NULL;
398                 }
399
400                 if(left != NULL) {
401                         if(addr->base != NULL) {
402                                 assert(addr->index == NULL && addr->scale == 0);
403                                 assert(right == NULL);
404                                 addr->index = left;
405                         } else {
406                                 addr->base = left;
407                         }
408                 }
409                 if(right != NULL) {
410                         if(addr->base == NULL) {
411                                 addr->base = right;
412                         } else {
413                                 assert(addr->index == NULL && addr->scale == 0);
414                                 addr->index = right;
415                         }
416                 }
417                 return;
418         }
419
420         addr->base = node;
421 }
422
423
424 /**
425  * Walker: mark those nodes that cannot be part of an address mode because
426  * there value must be access through an register
427  */
428 static void mark_non_address_nodes(ir_node *node, void *env)
429 {
430         int i, arity;
431         ir_node *ptr;
432         ir_node *mem;
433         ir_node *val;
434         ir_node *left;
435         ir_node *right;
436         (void) env;
437
438         switch(get_irn_opcode(node)) {
439         case iro_Load:
440                 ptr = get_Load_ptr(node);
441                 mem = get_Load_mem(node);
442
443                 bitset_set(non_address_mode_nodes, get_irn_idx(mem));
444                 break;
445
446         case iro_Store:
447                 val = get_Store_value(node);
448                 ptr = get_Store_ptr(node);
449                 mem = get_Store_mem(node);
450
451                 bitset_set(non_address_mode_nodes, get_irn_idx(val));
452                 bitset_set(non_address_mode_nodes, get_irn_idx(mem));
453                 break;
454
455         case iro_Add:
456                 left  = get_Add_left(node);
457                 right = get_Add_right(node);
458                 /* if we can do source address mode then we will never fold the add
459                  * into address mode */
460                 if(!mode_is_float(get_irn_mode(node)) && (is_immediate_simple(right) ||
461                          (!ia32_use_source_address_mode(get_nodes_block(node), left, right)
462                      && !ia32_use_source_address_mode(get_nodes_block(node), right, left))))
463                 {
464                     break;
465                 }
466                 bitset_set(non_address_mode_nodes, get_irn_idx(node));
467                 /* fallthrough */
468
469         default:
470                 arity = get_irn_arity(node);
471
472                 for(i = 0; i < arity; ++i) {
473                         ir_node *in = get_irn_n(node, i);
474                         bitset_set(non_address_mode_nodes, get_irn_idx(in));
475                 }
476                 break;
477         }
478 }
479
480 void calculate_non_address_mode_nodes(ir_graph *irg)
481 {
482         non_address_mode_nodes = bitset_malloc(get_irg_last_idx(irg));
483
484         irg_walk_graph(irg, NULL, mark_non_address_nodes, NULL);
485 }
486
487 void free_non_address_mode_nodes(void)
488 {
489         bitset_free(non_address_mode_nodes);
490 }