fix address mode calculation: we can not eat immediates for shifted values (well...
[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 #if 0
118 static int is_immediate_simple(const ir_node *node) {
119         int symconsts = 0;
120         return do_is_immediate(node, &symconsts, 0);
121 }
122 #endif
123
124 /**
125  * Check if a DAG starting with root node can be folded into an address mode
126  * as an immediate.
127  *
128  * @param addr    the address mode data so far
129  * @param node    the node
130  * @param negate  if set, the immediate must be negated
131  */
132 static int is_immediate(ia32_address_t *addr, const ir_node *node, int negate)
133 {
134         int symconsts = (addr->symconst_ent != NULL);
135         return do_is_immediate(node, &symconsts, negate);
136 }
137
138 /**
139  * Place a DAG with root node into an address mode.
140  *
141  * @param addr    the address mode data so far
142  * @param node    the node
143  * @param negate  if set, the immediate must be negated
144  */
145 static void eat_immediate(ia32_address_t *addr, ir_node *node, int negate)
146 {
147         tarval  *tv;
148         ir_node *left;
149         ir_node *right;
150         long    val;
151
152         switch (get_irn_opcode(node)) {
153         case iro_Const:
154                 /* simply add the value to the offset */
155                 tv = get_Const_tarval(node);
156                 val = get_tarval_long(tv);
157                 if (negate) {
158                         addr->offset -= val;
159                 } else {
160                         addr->offset += val;
161                 }
162                 break;
163         case iro_SymConst:
164                 /* place the entity into the symconst */
165                 if (addr->symconst_ent != NULL) {
166                         panic("Internal error: more than 1 symconst in address "
167                               "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(!bitset_is_set(non_address_mode_nodes, get_irn_idx(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(!bitset_is_set(non_address_mode_nodes, get_irn_idx(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 force   if set, ignore the marking of node as a non-address-mode node
200  *
201  * @return the folded node
202  */
203 static ir_node *eat_immediates(ia32_address_t *addr, ir_node *node, int force)
204 {
205         if(!force && bitset_is_set(non_address_mode_nodes, get_irn_idx(node)))
206                 return node;
207
208         if(is_Add(node)) {
209                 ir_node *left  = get_Add_left(node);
210                 ir_node *right = get_Add_right(node);
211
212                 if(is_immediate(addr, left, 0)) {
213                         eat_immediate(addr, left, 0);
214                         return eat_immediates(addr, right, 0);
215                 }
216                 if(is_immediate(addr, right, 0)) {
217                         eat_immediate(addr, right, 0);
218                         return eat_immediates(addr, left, 0);
219                 }
220         } else if(is_Sub(node)) {
221                 ir_node *left  = get_Sub_left(node);
222                 ir_node *right = get_Sub_right(node);
223
224                 if(is_immediate(addr, right, 1)) {
225                         eat_immediate(addr, right, 1);
226                         return eat_immediates(addr, left, 0);
227                 }
228         }
229
230         return node;
231 }
232
233 /**
234  * Try to place a Shl into an address mode.
235  *
236  * @param addr    the address mode data so far
237  * @param node   the node to place
238  *
239  * @return non-zero on success
240  */
241 static int eat_shl(ia32_address_t *addr, ir_node *node)
242 {
243         ir_node *shifted_val;
244         long     val;
245
246         if(is_Shl(node)) {
247                 ir_node *right = get_Shl_right(node);
248                 tarval  *tv;
249
250                 /* we can use shl with 1, 2 or 3 shift */
251                 if(!is_Const(right))
252                         return 0;
253                 tv = get_Const_tarval(right);
254                 if(!tarval_is_long(tv))
255                         return 0;
256
257                 val = get_tarval_long(tv);
258                 if(val < 0 || val > 3)
259                         return 0;
260                 if(val == 0) {
261                         ir_fprintf(stderr, "Optimisation warning: unoptimized Shl(,0) "
262                                    "found\n");
263                 }
264
265                 shifted_val = get_Shl_left(node);
266         } else if(is_Add(node)) {
267                 /* might be an add x, x */
268                 ir_node *left  = get_Add_left(node);
269                 ir_node *right = get_Add_right(node);
270
271                 if(left != right)
272                         return 0;
273                 if(is_Const(left))
274                         return 0;
275
276                 val         = 1;
277                 shifted_val = left;
278         } else {
279                 return 0;
280         }
281
282         /* we can only eat a shl if we don't have a scale or index set yet */
283         if(addr->scale != 0 || addr->index != NULL)
284                 return 0;
285         if(bitset_is_set(non_address_mode_nodes, get_irn_idx(node)))
286                 return 0;
287
288 #ifndef AGGRESSIVE_AM
289         if(get_irn_n_edges(node) > 1)
290                 return 0;
291 #endif
292
293         addr->scale = val;
294         addr->index = shifted_val;
295         return 1;
296 }
297
298 /**
299  * Returns non-zero if a value of a given mode can be stored in GP registers.
300  */
301 static INLINE int mode_needs_gp_reg(ir_mode *mode) {
302         if(mode == mode_fpcw)
303                 return 0;
304         if(get_mode_size_bits(mode) > 32)
305                 return 0;
306         return mode_is_int(mode) || mode_is_reference(mode) || mode == mode_b;
307 }
308
309 /* Create an address mode for a given node. */
310 void ia32_create_address_mode(ia32_address_t *addr, ir_node *node, int force)
311 {
312         int      res = 0;
313         ir_node *eat_imms;
314
315         if(is_immediate(addr, node, 0)) {
316                 eat_immediate(addr, node, 0);
317                 return;
318         }
319
320 #ifndef AGGRESSIVE_AM
321         if(!force && get_irn_n_edges(node) > 1) {
322                 addr->base = node;
323                 return;
324         }
325 #endif
326
327         if(!force && bitset_is_set(non_address_mode_nodes, get_irn_idx(node))) {
328                 addr->base = node;
329                 return;
330         }
331
332         eat_imms = eat_immediates(addr, node, force);
333         if(eat_imms != node) {
334                 if(force) {
335                         eat_imms = ia32_skip_downconv(eat_imms);
336                 }
337
338                 res  = 1;
339                 node = eat_imms;
340 #ifndef AGGRESSIVE_AM
341                 if(get_irn_n_edges(node) > 1) {
342                         addr->base = node;
343                         return;
344                 }
345 #endif
346                 if(bitset_is_set(non_address_mode_nodes, get_irn_idx(node))) {
347                         addr->base = node;
348                         return;
349                 }
350         }
351
352         /* starting point Add, Sub or Shl, FrameAddr */
353         if(is_Shl(node)) { /* we don't want to eat add x, x as shl here, so only
354                               test for real Shl instructions */
355                 if(eat_shl(addr, node))
356                         return;
357         } else if(is_immediate(addr, node, 0)) {
358                 eat_immediate(addr, node, 0);
359                 return;
360         } else if(be_is_FrameAddr(node)) {
361                 assert(addr->base == NULL);
362                 assert(addr->frame_entity == NULL);
363                 addr->base         = be_get_FrameAddr_frame(node);
364                 addr->use_frame    = 1;
365                 addr->frame_entity = be_get_FrameAddr_entity(node);
366                 return;
367         } else if(is_Add(node)) {
368                 ir_node *left  = get_Add_left(node);
369                 ir_node *right = get_Add_right(node);
370
371                 if(force) {
372                         left  = ia32_skip_downconv(left);
373                         right = ia32_skip_downconv(right);
374                 }
375
376                 assert(force || !is_immediate(addr, left, 0));
377                 assert(force || !is_immediate(addr, right, 0));
378
379                 if(eat_shl(addr, left)) {
380                         left = NULL;
381                 } else if(eat_shl(addr, right)) {
382                         right = NULL;
383                 }
384                 if(left != NULL && be_is_FrameAddr(left)
385                                 && !bitset_is_set(non_address_mode_nodes, get_irn_idx(left))) {
386                         assert(addr->base == NULL);
387                         assert(addr->frame_entity == NULL);
388                         addr->base         = be_get_FrameAddr_frame(left);
389                         addr->use_frame    = 1;
390                         addr->frame_entity = be_get_FrameAddr_entity(left);
391                         left               = NULL;
392                 } else if(right != NULL && be_is_FrameAddr(right)
393                                 && !bitset_is_set(non_address_mode_nodes, get_irn_idx(right))) {
394                         assert(addr->base == NULL);
395                         assert(addr->frame_entity == NULL);
396                         addr->base         = be_get_FrameAddr_frame(right);
397                         addr->use_frame    = 1;
398                         addr->frame_entity = be_get_FrameAddr_entity(right);
399                         right              = NULL;
400                 }
401
402                 if(left != NULL) {
403                         if(addr->base != NULL) {
404                                 assert(addr->index == NULL && addr->scale == 0);
405                                 assert(right == NULL);
406                                 addr->index = left;
407                         } else {
408                                 addr->base = left;
409                         }
410                 }
411                 if(right != NULL) {
412                         if(addr->base == NULL) {
413                                 addr->base = right;
414                         } else {
415                                 assert(addr->index == NULL && addr->scale == 0);
416                                 addr->index = right;
417                         }
418                 }
419                 return;
420         }
421
422         addr->base = node;
423 }
424
425 void ia32_mark_non_am(ir_node *node)
426 {
427         bitset_set(non_address_mode_nodes, get_irn_idx(node));
428 }
429
430 /**
431  * Walker: mark those nodes that cannot be part of an address mode because
432  * there value must be access through an register
433  */
434 static void mark_non_address_nodes(ir_node *node, void *env)
435 {
436         int i, arity;
437         ir_node *ptr;
438         ir_node *mem;
439         ir_node *val;
440         ir_node *left;
441         ir_node *right;
442         ir_mode *mode;
443         (void) env;
444
445         mode = get_irn_mode(node);
446         if(!mode_is_int(mode) && !mode_is_reference(mode) && mode != mode_b)
447                 return;
448
449         switch(get_irn_opcode(node)) {
450         case iro_Load:
451                 ptr = get_Load_ptr(node);
452                 mem = get_Load_mem(node);
453
454                 bitset_set(non_address_mode_nodes, get_irn_idx(mem));
455                 break;
456
457         case iro_Store:
458                 val = get_Store_value(node);
459                 ptr = get_Store_ptr(node);
460                 mem = get_Store_mem(node);
461
462                 bitset_set(non_address_mode_nodes, get_irn_idx(val));
463                 bitset_set(non_address_mode_nodes, get_irn_idx(mem));
464                 break;
465
466         case iro_Add:
467                 left  = get_Add_left(node);
468                 right = get_Add_right(node);
469 #if 0
470                 /* if we can do source address mode then we will never fold the add
471                  * into address mode */
472                 if((is_immediate_simple(right)) ||
473                          (!ia32_use_source_address_mode(get_nodes_block(node), left, right)
474                      && !ia32_use_source_address_mode(get_nodes_block(node), right, left)))
475                 {
476                     break;
477                 }
478                 bitset_set(non_address_mode_nodes, get_irn_idx(node));
479 #else
480                 break;
481 #endif
482                 /* fallthrough */
483
484         default:
485                 arity = get_irn_arity(node);
486
487                 for(i = 0; i < arity; ++i) {
488                         ir_node *in = get_irn_n(node, i);
489                         bitset_set(non_address_mode_nodes, get_irn_idx(in));
490                 }
491                 break;
492         }
493 }
494
495 void ia32_calculate_non_address_mode_nodes(ir_graph *irg)
496 {
497         non_address_mode_nodes = bitset_malloc(get_irg_last_idx(irg));
498
499         irg_walk_graph(irg, NULL, mark_non_address_nodes, NULL);
500 }
501
502 void ia32_free_non_address_mode_nodes(void)
503 {
504         bitset_free(non_address_mode_nodes);
505 }