Clarify a comment.
[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 be_lv_t  *lv;
49 static bitset_t *non_address_mode_nodes;
50
51 /**
52  * Recursive worker for checking if a DAG with root node can be represented as a simple immediate,
53  *
54  * @param node       the node
55  * @param symconsts  number of symconsts found so far
56  * @param negate     if set, the immediate must be negated
57  *
58  * @return non-zero if the DAG represents an immediate, 0 else
59  */
60 static int do_is_immediate(const ir_node *node, int *symconsts, int negate)
61 {
62         ir_node *left;
63         ir_node *right;
64
65         switch (get_irn_opcode(node)) {
66         case iro_Const:
67                 /* Consts are typically immediates */
68                 if (!tarval_is_long(get_Const_tarval(node))) {
69 #ifdef DEBUG_libfirm
70                         ir_fprintf(stderr, "Optimisation warning tarval of %+F(%+F) is not "
71                                    "a long.\n", node, current_ir_graph);
72 #endif
73                         return 0;
74                 }
75                 return 1;
76         case iro_SymConst:
77                 /* the first SymConst of a DAG can be fold into an immediate */
78 #ifndef SUPPORT_NEGATIVE_SYMCONSTS
79                 /* unfortunately the assembler/linker doesn't support -symconst */
80                 if(negate)
81                         return 0;
82 #endif
83
84                 if(get_SymConst_kind(node) != symconst_addr_ent)
85                         return 0;
86                 (*symconsts)++;
87                 if(*symconsts > 1)
88                         return 0;
89
90                 return 1;
91         case iro_Add:
92         case iro_Sub:
93                 /* Add's and Sub's are typically supported as long as both operands are immediates */
94                 if(bitset_is_set(non_address_mode_nodes, get_irn_idx(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 "
168                               "calculation");
169                 }
170                 addr->symconst_ent  = get_SymConst_entity(node);
171 #ifndef SUPPORT_NEGATIVE_SYMCONSTS
172                 assert(!negate);
173 #endif
174                 addr->symconst_sign = negate;
175                 break;
176         case iro_Add:
177                 assert(!bitset_is_set(non_address_mode_nodes, get_irn_idx(node)));
178                 left  = get_Add_left(node);
179                 right = get_Add_right(node);
180                 eat_immediate(addr, left, negate);
181                 eat_immediate(addr, right, negate);
182                 break;
183         case iro_Sub:
184                 assert(!bitset_is_set(non_address_mode_nodes, get_irn_idx(node)));
185                 left  = get_Sub_left(node);
186                 right = get_Sub_right(node);
187                 eat_immediate(addr, left, negate);
188                 eat_immediate(addr, right, !negate);
189                 break;
190         default:
191                 panic("Internal error in immediate address calculation");
192         }
193 }
194
195 /**
196  * Place operands of node into an address mode.
197  *
198  * @param addr    the address mode data so far
199  * @param node    the node
200  * @param force   if set, ignore the marking of node as a non-address-mode node
201  *
202  * @return the folded node
203  */
204 static ir_node *eat_immediates(ia32_address_t *addr, ir_node *node, int force)
205 {
206         if(!force && bitset_is_set(non_address_mode_nodes, get_irn_idx(node)))
207                 return node;
208
209         if(is_Add(node)) {
210                 ir_node *left  = get_Add_left(node);
211                 ir_node *right = get_Add_right(node);
212
213                 if(is_immediate(addr, left, 0)) {
214                         eat_immediate(addr, left, 0);
215                         return eat_immediates(addr, right, 0);
216                 }
217                 if(is_immediate(addr, right, 0)) {
218                         eat_immediate(addr, right, 0);
219                         return eat_immediates(addr, left, 0);
220                 }
221         } else if(is_Sub(node)) {
222                 ir_node *left  = get_Sub_left(node);
223                 ir_node *right = get_Sub_right(node);
224
225                 if(is_immediate(addr, right, 1)) {
226                         eat_immediate(addr, right, 1);
227                         return eat_immediates(addr, left, 0);
228                 }
229         }
230
231         return node;
232 }
233
234 /**
235  * Try to place a Shl into an address mode.
236  *
237  * @param addr    the address mode data so far
238  * @param node   the node to place
239  *
240  * @return non-zero on success
241  */
242 static int eat_shl(ia32_address_t *addr, ir_node *node)
243 {
244         ir_node *shifted_val;
245         long     val;
246
247         if(is_Shl(node)) {
248                 ir_node *right = get_Shl_right(node);
249                 tarval  *tv;
250
251                 /* we can use shl with 1, 2 or 3 shift */
252                 if(!is_Const(right))
253                         return 0;
254                 tv = get_Const_tarval(right);
255                 if(!tarval_is_long(tv))
256                         return 0;
257
258                 val = get_tarval_long(tv);
259                 if(val < 0 || val > 3)
260                         return 0;
261                 if(val == 0) {
262                         ir_fprintf(stderr, "Optimisation warning: unoptimized Shl(,0) "
263                                    "found\n");
264                 }
265
266                 shifted_val = get_Shl_left(node);
267         } else if(is_Add(node)) {
268                 /* might be an add x, x */
269                 ir_node *left  = get_Add_left(node);
270                 ir_node *right = get_Add_right(node);
271
272                 if(left != right)
273                         return 0;
274                 if(is_Const(left))
275                         return 0;
276
277                 val         = 1;
278                 shifted_val = left;
279         } else {
280                 return 0;
281         }
282
283         /* we can only eat a shl if we don't have a scale or index set yet */
284         if(addr->scale != 0 || addr->index != NULL)
285                 return 0;
286         if(bitset_is_set(non_address_mode_nodes, get_irn_idx(node)))
287                 return 0;
288
289 #ifndef AGGRESSIVE_AM
290         if(get_irn_n_edges(node) > 1)
291                 return 0;
292 #endif
293
294         addr->scale = val;
295         addr->index = shifted_val;
296         return 1;
297 }
298
299 /**
300  * Returns non-zero if a value of a given mode can be stored in GP registers.
301  */
302 static INLINE int mode_needs_gp_reg(ir_mode *mode) {
303         if(mode == mode_fpcw)
304                 return 0;
305         if(get_mode_size_bits(mode) > 32)
306                 return 0;
307         return mode_is_int(mode) || mode_is_reference(mode) || mode == mode_b;
308 }
309
310 /* Create an address mode for a given node. */
311 void ia32_create_address_mode(ia32_address_t *addr, ir_node *node, int force)
312 {
313         int      res = 0;
314         ir_node *eat_imms;
315
316         if(is_immediate(addr, node, 0)) {
317                 eat_immediate(addr, node, 0);
318                 return;
319         }
320
321 #ifndef AGGRESSIVE_AM
322         if(!force && get_irn_n_edges(node) > 1) {
323                 addr->base = node;
324                 return;
325         }
326 #endif
327
328         if(!force && bitset_is_set(non_address_mode_nodes, get_irn_idx(node))) {
329                 addr->base = node;
330                 return;
331         }
332
333         eat_imms = eat_immediates(addr, node, force);
334         if(eat_imms != node) {
335                 if(force) {
336                         eat_imms = ia32_skip_downconv(eat_imms);
337                 }
338
339                 res  = 1;
340                 node = eat_imms;
341 #ifndef AGGRESSIVE_AM
342                 if(get_irn_n_edges(node) > 1) {
343                         addr->base = node;
344                         return;
345                 }
346 #endif
347                 if(bitset_is_set(non_address_mode_nodes, get_irn_idx(node))) {
348                         addr->base = node;
349                         return;
350                 }
351         }
352
353         /* starting point Add, Sub or Shl, FrameAddr */
354         if(is_Shl(node)) {
355                 /* We don't want to eat add x, x as shl here, so only test for real Shl
356                  * instructions, because we want the former as Lea x, x, not Shl x, 1 */
357                 if(eat_shl(addr, node))
358                         return;
359         } else if(is_immediate(addr, node, 0)) {
360                 eat_immediate(addr, node, 0);
361                 return;
362         } else if(be_is_FrameAddr(node)) {
363                 assert(addr->base == NULL);
364                 assert(addr->frame_entity == NULL);
365                 addr->base         = be_get_FrameAddr_frame(node);
366                 addr->use_frame    = 1;
367                 addr->frame_entity = be_get_FrameAddr_entity(node);
368                 return;
369         } else if(is_Add(node)) {
370                 ir_node *left  = get_Add_left(node);
371                 ir_node *right = get_Add_right(node);
372
373                 if(force) {
374                         left  = ia32_skip_downconv(left);
375                         right = ia32_skip_downconv(right);
376                 }
377
378                 assert(force || !is_immediate(addr, left, 0));
379                 assert(force || !is_immediate(addr, right, 0));
380
381                 if(eat_shl(addr, left)) {
382                         left = NULL;
383                 } else if(eat_shl(addr, right)) {
384                         right = NULL;
385                 }
386                 if(left != NULL && be_is_FrameAddr(left)
387                                 && !bitset_is_set(non_address_mode_nodes, get_irn_idx(left))) {
388                         assert(addr->base == NULL);
389                         assert(addr->frame_entity == NULL);
390                         addr->base         = be_get_FrameAddr_frame(left);
391                         addr->use_frame    = 1;
392                         addr->frame_entity = be_get_FrameAddr_entity(left);
393                         left               = NULL;
394                 } else if(right != NULL && be_is_FrameAddr(right)
395                                 && !bitset_is_set(non_address_mode_nodes, get_irn_idx(right))) {
396                         assert(addr->base == NULL);
397                         assert(addr->frame_entity == NULL);
398                         addr->base         = be_get_FrameAddr_frame(right);
399                         addr->use_frame    = 1;
400                         addr->frame_entity = be_get_FrameAddr_entity(right);
401                         right              = NULL;
402                 }
403
404                 if(left != NULL) {
405                         if(addr->base != NULL) {
406                                 assert(addr->index == NULL && addr->scale == 0);
407                                 assert(right == NULL);
408                                 addr->index = left;
409                         } else {
410                                 addr->base = left;
411                         }
412                 }
413                 if(right != NULL) {
414                         if(addr->base == NULL) {
415                                 addr->base = right;
416                         } else {
417                                 assert(addr->index == NULL && addr->scale == 0);
418                                 addr->index = right;
419                         }
420                 }
421                 return;
422         }
423
424         addr->base = node;
425 }
426
427 void ia32_mark_non_am(ir_node *node)
428 {
429         bitset_set(non_address_mode_nodes, get_irn_idx(node));
430 }
431
432 /**
433  * Walker: mark those nodes that cannot be part of an address mode because
434  * there value must be access through an register
435  */
436 static void mark_non_address_nodes(ir_node *node, void *env)
437 {
438         int i, arity;
439         ir_node *ptr;
440         ir_node *mem;
441         ir_node *val;
442         ir_node *block;
443         ir_node *left;
444         ir_node *right;
445         ir_mode *mode;
446         const ir_edge_t *edge;
447         (void) env;
448
449         mode = get_irn_mode(node);
450         if(!mode_is_int(mode) && !mode_is_reference(mode) && mode != mode_b)
451                 return;
452
453         switch(get_irn_opcode(node)) {
454         case iro_Load:
455                 ptr = get_Load_ptr(node);
456                 mem = get_Load_mem(node);
457
458                 bitset_set(non_address_mode_nodes, get_irn_idx(mem));
459                 break;
460
461         case iro_Store:
462                 val = get_Store_value(node);
463                 ptr = get_Store_ptr(node);
464                 mem = get_Store_mem(node);
465
466                 bitset_set(non_address_mode_nodes, get_irn_idx(val));
467                 bitset_set(non_address_mode_nodes, get_irn_idx(mem));
468                 break;
469
470         case iro_Shl:
471         case iro_Add:
472                 /* only 1 user: AM folding is always beneficial */
473                 if(get_irn_n_edges(node) <= 1)
474                         break;
475
476                 /* for adds and shls with multiple users we use this heuristic:
477                  * we do not fold them into address mode if their operands don't live
478                  * out of the block, because in this case we will reduce register
479                  * pressure. Otherwise we fold them in aggressively in the hope, that
480                  * the node itself doesn't exist anymore and we were able to save the
481                  * register for the result */
482                 block = get_nodes_block(node);
483                 left  = get_binop_left(node);
484                 right = get_binop_right(node);
485
486                 /* live end: we won't save a register by AM folding */
487                 if(be_is_live_end(lv, block, left) || be_is_live_end(lv, block, right))
488                         return;
489
490                 /* if multiple nodes in this block use left/right values, then we
491                  * can't really decide wether the values will die after node.
492                  * We use aggressive mode then, since it's usually just multiple address
493                  * calculations. */
494                 foreach_out_edge(left, edge) {
495                         ir_node *user = get_edge_src_irn(edge);
496                         if(user != node && get_nodes_block(user) == block)
497                                 return;
498                 }
499                 foreach_out_edge(right, edge) {
500                         ir_node *user = get_edge_src_irn(edge);
501                         if(user != node && get_nodes_block(user) == block)
502                                 return;
503                 }
504
505                 /* noone-else in this block is using left/right so we'll reduce register
506                  * pressure if we don't fold the node */
507                 bitset_set(non_address_mode_nodes, get_irn_idx(node));
508                 break;
509
510         default:
511                 arity = get_irn_arity(node);
512
513                 for(i = 0; i < arity; ++i) {
514                         ir_node *in = get_irn_n(node, i);
515                         bitset_set(non_address_mode_nodes, get_irn_idx(in));
516                 }
517                 break;
518         }
519 }
520
521 void ia32_calculate_non_address_mode_nodes(be_irg_t *birg)
522 {
523         ir_graph *irg = be_get_birg_irg(birg);
524
525         lv                     = be_assure_liveness(birg);
526         non_address_mode_nodes = bitset_malloc(get_irg_last_idx(irg));
527
528         irg_walk_graph(irg, NULL, mark_non_address_nodes, NULL);
529 }
530
531 void ia32_free_non_address_mode_nodes(void)
532 {
533         bitset_free(non_address_mode_nodes);
534 }