a0fd212d467711b1e1e2f55d1545046e2b6192df
[libfirm] / ir / be / ia32 / ia32_x87.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 implements the x87 support and virtual to stack
23  *              register translation for the ia32 backend.
24  * @author      Michael Beck
25  * @version     $Id$
26  */
27 #ifdef HAVE_CONFIG_H
28 #include "config.h"
29 #endif
30
31 #include <assert.h>
32
33 #include "irnode_t.h"
34 #include "irop_t.h"
35 #include "irprog.h"
36 #include "iredges_t.h"
37 #include "irgmod.h"
38 #include "ircons.h"
39 #include "irgwalk.h"
40 #include "obst.h"
41 #include "pmap.h"
42 #include "array_t.h"
43 #include "pdeq.h"
44 #include "irprintf.h"
45 #include "debug.h"
46 #include "error.h"
47
48 #include "../belive_t.h"
49 #include "../besched_t.h"
50 #include "../benode_t.h"
51 #include "bearch_ia32_t.h"
52 #include "ia32_new_nodes.h"
53 #include "gen_ia32_new_nodes.h"
54 #include "gen_ia32_regalloc_if.h"
55 #include "ia32_x87.h"
56 #include "ia32_architecture.h"
57
58 #define N_x87_REGS 8
59
60 /* the unop index */
61 #define UNOP_IDX 0
62
63 #define MASK_TOS(x)             ((x) & (N_x87_REGS - 1))
64
65 /** the debug handle */
66 DEBUG_ONLY(static firm_dbg_module_t *dbg = NULL;)
67
68 /* Forward declaration. */
69 typedef struct _x87_simulator x87_simulator;
70
71 /**
72  * An exchange template.
73  * Note that our virtual functions have the same inputs
74  * and attributes as the real ones, so we can simple exchange
75  * their opcodes!
76  * Further, x87 supports inverse instructions, so we can handle them.
77  */
78 typedef struct _exchange_tmpl {
79         ir_op *normal_op;       /**< the normal one */
80         ir_op *reverse_op;      /**< the reverse one if exists */
81         ir_op *normal_pop_op;   /**< the normal one with tos pop */
82         ir_op *reverse_pop_op;  /**< the reverse one with tos pop */
83 } exchange_tmpl;
84
85 /**
86  * An entry on the simulated x87 stack.
87  */
88 typedef struct _st_entry {
89         int     reg_idx;        /**< the virtual register index of this stack value */
90         ir_node *node;          /**< the node that produced this value */
91 } st_entry;
92
93 /**
94  * The x87 state.
95  */
96 typedef struct _x87_state {
97         st_entry st[N_x87_REGS];  /**< the register stack */
98         int depth;                /**< the current stack depth */
99         int tos;                  /**< position of the tos */
100         x87_simulator *sim;       /**< The simulator. */
101 } x87_state;
102
103 /** An empty state, used for blocks without fp instructions. */
104 static x87_state _empty = { { {0, NULL}, }, 0, 0, NULL };
105 static x87_state *empty = (x87_state *)&_empty;
106
107 enum {
108         NO_NODE_ADDED = 0,  /**< No node was added. */
109         NODE_ADDED = 1      /**< A node was added by the simulator in the schedule. */
110 };
111
112 /**
113  * The type of an instruction simulator function.
114  *
115  * @param state  the x87 state
116  * @param n      the node to be simulated
117  *
118  * @return NODE_ADDED if a node was added AFTER n in schedule,
119  *         NO_NODE_ADDED else
120  */
121 typedef int (*sim_func)(x87_state *state, ir_node *n);
122
123 /**
124  * A block state: Every block has a x87 state at the beginning and at the end.
125  */
126 typedef struct _blk_state {
127         x87_state *begin;   /**< state at the begin or NULL if not assigned */
128         x87_state *end;     /**< state at the end or NULL if not assigned */
129 } blk_state;
130
131 #define PTR_TO_BLKSTATE(p)      ((blk_state *)(p))
132
133 /** liveness bitset for vfp registers. */
134 typedef unsigned char vfp_liveness;
135
136 /**
137  * The x87 simulator.
138  */
139 struct _x87_simulator {
140         struct obstack obst;        /**< An obstack for fast allocating. */
141         pmap *blk_states;           /**< Map blocks to states. */
142         const arch_env_t *arch_env; /**< The architecture environment. */
143         be_lv_t *lv;                /**< intrablock liveness. */
144         vfp_liveness *live;         /**< Liveness information. */
145         unsigned n_idx;             /**< The cached get_irg_last_idx() result. */
146         waitq *worklist;            /**< Worklist of blocks that must be processed. */
147         ia32_isa_t *isa;            /**< the ISA object */
148 };
149
150 /**
151  * Returns the current stack depth.
152  *
153  * @param state  the x87 state
154  *
155  * @return the x87 stack depth
156  */
157 static int x87_get_depth(const x87_state *state)
158 {
159         return state->depth;
160 }  /* x87_get_depth */
161
162 /**
163  * Return the virtual register index at st(pos).
164  *
165  * @param state  the x87 state
166  * @param pos    a stack position
167  *
168  * @return the vfp register index that produced the value at st(pos)
169  */
170 static int x87_get_st_reg(const x87_state *state, int pos)
171 {
172         assert(pos < state->depth);
173         return state->st[MASK_TOS(state->tos + pos)].reg_idx;
174 }  /* x87_get_st_reg */
175
176 #ifdef DEBUG_libfirm
177 /**
178  * Return the node at st(pos).
179  *
180  * @param state  the x87 state
181  * @param pos    a stack position
182  *
183  * @return the IR node that produced the value at st(pos)
184  */
185 static ir_node *x87_get_st_node(const x87_state *state, int pos)
186 {
187         assert(pos < state->depth);
188         return state->st[MASK_TOS(state->tos + pos)].node;
189 }  /* x87_get_st_node */
190
191 /**
192  * Dump the stack for debugging.
193  *
194  * @param state  the x87 state
195  */
196 static void x87_dump_stack(const x87_state *state)
197 {
198         int i;
199
200         for (i = state->depth - 1; i >= 0; --i) {
201                 DB((dbg, LEVEL_2, "vf%d(%+F) ", x87_get_st_reg(state, i),
202                     x87_get_st_node(state, i)));
203         }
204         DB((dbg, LEVEL_2, "<-- TOS\n"));
205 }  /* x87_dump_stack */
206 #endif /* DEBUG_libfirm */
207
208 /**
209  * Set a virtual register to st(pos).
210  *
211  * @param state    the x87 state
212  * @param reg_idx  the vfp register index that should be set
213  * @param node     the IR node that produces the value of the vfp register
214  * @param pos      the stack position where the new value should be entered
215  */
216 static void x87_set_st(x87_state *state, int reg_idx, ir_node *node, int pos)
217 {
218         assert(0 < state->depth);
219         state->st[MASK_TOS(state->tos + pos)].reg_idx = reg_idx;
220         state->st[MASK_TOS(state->tos + pos)].node    = node;
221
222         DB((dbg, LEVEL_2, "After SET_REG: "));
223         DEBUG_ONLY(x87_dump_stack(state));
224 }  /* x87_set_st */
225
226 /**
227  * Set the tos virtual register.
228  *
229  * @param state    the x87 state
230  * @param reg_idx  the vfp register index that should be set
231  * @param node     the IR node that produces the value of the vfp register
232  */
233 static void x87_set_tos(x87_state *state, int reg_idx, ir_node *node)
234 {
235         x87_set_st(state, reg_idx, node, 0);
236 }  /* x87_set_tos */
237
238 /**
239  * Swap st(0) with st(pos).
240  *
241  * @param state    the x87 state
242  * @param pos      the stack position to change the tos with
243  */
244 static void x87_fxch(x87_state *state, int pos)
245 {
246         st_entry entry;
247         assert(pos < state->depth);
248
249         entry = state->st[MASK_TOS(state->tos + pos)];
250         state->st[MASK_TOS(state->tos + pos)] = state->st[MASK_TOS(state->tos)];
251         state->st[MASK_TOS(state->tos)] = entry;
252
253         DB((dbg, LEVEL_2, "After FXCH: ")); DEBUG_ONLY(x87_dump_stack(state));
254 }  /* x87_fxch */
255
256 /**
257  * Convert a virtual register to the stack index.
258  *
259  * @param state    the x87 state
260  * @param reg_idx  the register vfp index
261  *
262  * @return the stack position where the register is stacked
263  *         or -1 if the virtual register was not found
264  */
265 static int x87_on_stack(const x87_state *state, int reg_idx)
266 {
267         int i, tos = state->tos;
268
269         for (i = 0; i < state->depth; ++i)
270                 if (state->st[MASK_TOS(tos + i)].reg_idx == reg_idx)
271                         return i;
272         return -1;
273 }  /* x87_on_stack */
274
275 /**
276  * Push a virtual Register onto the stack, double pushed allowed.
277  *
278  * @param state     the x87 state
279  * @param reg_idx   the register vfp index
280  * @param node      the node that produces the value of the vfp register
281  */
282 static void x87_push_dbl(x87_state *state, int reg_idx, ir_node *node)
283 {
284         assert(state->depth < N_x87_REGS && "stack overrun");
285
286         ++state->depth;
287         state->tos = MASK_TOS(state->tos - 1);
288         state->st[state->tos].reg_idx = reg_idx;
289         state->st[state->tos].node    = node;
290
291         DB((dbg, LEVEL_2, "After PUSH: ")); DEBUG_ONLY(x87_dump_stack(state));
292 }  /* x87_push_dbl */
293
294 /**
295  * Push a virtual Register onto the stack, double pushes are NOT allowed.
296  *
297  * @param state     the x87 state
298  * @param reg_idx   the register vfp index
299  * @param node      the node that produces the value of the vfp register
300  * @param dbl_push  if != 0 double pushes are allowed
301  */
302 static void x87_push(x87_state *state, int reg_idx, ir_node *node)
303 {
304         assert(x87_on_stack(state, reg_idx) == -1 && "double push");
305
306         x87_push_dbl(state, reg_idx, node);
307 }  /* x87_push */
308
309 /**
310  * Pop a virtual Register from the stack.
311  *
312  * @param state     the x87 state
313  */
314 static void x87_pop(x87_state *state)
315 {
316         assert(state->depth > 0 && "stack underrun");
317
318         --state->depth;
319         state->tos = MASK_TOS(state->tos + 1);
320
321         DB((dbg, LEVEL_2, "After POP: ")); DEBUG_ONLY(x87_dump_stack(state));
322 }  /* x87_pop */
323
324 /**
325  * Empty the fpu stack
326  *
327  * @param state     the x87 state
328  */
329 static void x87_emms(x87_state *state)
330 {
331         state->depth = 0;
332         state->tos   = 0;
333 }
334
335 /**
336  * Returns the block state of a block.
337  *
338  * @param sim    the x87 simulator handle
339  * @param block  the current block
340  *
341  * @return the block state
342  */
343 static blk_state *x87_get_bl_state(x87_simulator *sim, ir_node *block)
344 {
345         pmap_entry *entry = pmap_find(sim->blk_states, block);
346
347         if (! entry) {
348                 blk_state *bl_state = obstack_alloc(&sim->obst, sizeof(*bl_state));
349                 bl_state->begin = NULL;
350                 bl_state->end   = NULL;
351
352                 pmap_insert(sim->blk_states, block, bl_state);
353                 return bl_state;
354         }
355
356         return PTR_TO_BLKSTATE(entry->value);
357 }  /* x87_get_bl_state */
358
359 /**
360  * Creates a new x87 state.
361  *
362  * @param sim    the x87 simulator handle
363  *
364  * @return a new x87 state
365  */
366 static x87_state *x87_alloc_state(x87_simulator *sim)
367 {
368         x87_state *res = obstack_alloc(&sim->obst, sizeof(*res));
369
370         res->sim = sim;
371         return res;
372 }  /* x87_alloc_state */
373
374 /**
375  * Clone a x87 state.
376  *
377  * @param sim    the x87 simulator handle
378  * @param src    the x87 state that will be cloned
379  *
380  * @return a cloned copy of the src state
381  */
382 static x87_state *x87_clone_state(x87_simulator *sim, const x87_state *src)
383 {
384         x87_state *res = x87_alloc_state(sim);
385
386         memcpy(res, src, sizeof(*res));
387         return res;
388 }  /* x87_clone_state */
389
390 /**
391  * Patch a virtual instruction into a x87 one and return
392  * the node representing the result value.
393  *
394  * @param n   the IR node to patch
395  * @param op  the x87 opcode to patch in
396  */
397 static ir_node *x87_patch_insn(ir_node *n, ir_op *op)
398 {
399         ir_mode *mode = get_irn_mode(n);
400         ir_node *res = n;
401
402         set_irn_op(n, op);
403
404         if (mode == mode_T) {
405                 /* patch all Proj's */
406                 const ir_edge_t *edge;
407
408                 foreach_out_edge(n, edge) {
409                         ir_node *proj = get_edge_src_irn(edge);
410                         if (is_Proj(proj)) {
411                                 mode = get_irn_mode(proj);
412                                 if (mode_is_float(mode)) {
413                                         res = proj;
414                                         set_irn_mode(proj, mode_E);
415                                 }
416                         }
417                 }
418         } else if (mode_is_float(mode))
419                 set_irn_mode(n, mode_E);
420         return res;
421 }  /* x87_patch_insn */
422
423 /**
424  * Returns the first Proj of a mode_T node having a given mode.
425  *
426  * @param n  the mode_T node
427  * @param m  the desired mode of the Proj
428  * @return The first Proj of mode @p m found or NULL.
429  */
430 static ir_node *get_irn_Proj_for_mode(ir_node *n, ir_mode *m)
431 {
432         const ir_edge_t *edge;
433
434         assert(get_irn_mode(n) == mode_T && "Need mode_T node");
435
436         foreach_out_edge(n, edge) {
437                 ir_node *proj = get_edge_src_irn(edge);
438                 if (get_irn_mode(proj) == m)
439                         return proj;
440         }
441
442         return NULL;
443 }  /* get_irn_Proj_for_mode */
444
445 /**
446  * Wrap the arch_* function here so we can check for errors.
447  */
448 static INLINE const arch_register_t *x87_get_irn_register(const ir_node *irn)
449 {
450         const arch_register_t *res = arch_get_irn_register(irn);
451
452         assert(res->reg_class->regs == ia32_vfp_regs);
453         return res;
454 }  /* x87_get_irn_register */
455
456 /* -------------- x87 perm --------------- */
457
458 /**
459  * Creates a fxch for shuffle.
460  *
461  * @param state     the x87 state
462  * @param pos       parameter for fxch
463  * @param block     the block were fxch is inserted
464  *
465  * Creates a new fxch node and reroute the user of the old node
466  * to the fxch.
467  *
468  * @return the fxch node
469  */
470 static ir_node *x87_fxch_shuffle(x87_state *state, int pos, ir_node *block)
471 {
472         ir_node         *fxch;
473         ia32_x87_attr_t *attr;
474
475         fxch = new_rd_ia32_fxch(NULL, get_irn_irg(block), block);
476         attr = get_ia32_x87_attr(fxch);
477         attr->x87[0] = &ia32_st_regs[pos];
478         attr->x87[2] = &ia32_st_regs[0];
479
480         keep_alive(fxch);
481
482         x87_fxch(state, pos);
483         return fxch;
484 }  /* x87_fxch_shuffle */
485
486 /**
487  * Calculate the necessary permutations to reach dst_state.
488  *
489  * These permutations are done with fxch instructions and placed
490  * at the end of the block.
491  *
492  * Note that critical edges are removed here, so we need only
493  * a shuffle if the current block has only one successor.
494  *
495  * @param sim        the simulator handle
496  * @param block      the current block
497  * @param state      the current x87 stack state, might be modified
498  * @param dst_block  the destination block
499  * @param dst_state  destination state
500  *
501  * @return state
502  */
503 static x87_state *x87_shuffle(x87_simulator *sim, ir_node *block,
504                               x87_state *state, ir_node *dst_block,
505                               const x87_state *dst_state)
506 {
507         int      i, n_cycles, k, ri;
508         unsigned cycles[4], all_mask;
509         char     cycle_idx[4][8];
510         ir_node  *fxch, *before, *after;
511         (void) sim;
512         (void) dst_block;
513
514         assert(state->depth == dst_state->depth);
515
516         /* Some mathematics here:
517            If we have a cycle of length n that includes the tos,
518            we need n-1 exchange operations.
519            We can always add the tos and restore it, so we need
520            n+1 exchange operations for a cycle not containing the tos.
521            So, the maximum of needed operations is for a cycle of 7
522            not including the tos == 8.
523            This is the same number of ops we would need for using stores,
524            so exchange is cheaper (we save the loads).
525            On the other hand, we might need an additional exchange
526            in the next block to bring one operand on top, so the
527            number of ops in the first case is identical.
528            Further, no more than 4 cycles can exists (4 x 2).
529         */
530         all_mask = (1 << (state->depth)) - 1;
531
532         for (n_cycles = 0; all_mask; ++n_cycles) {
533                 int src_idx, dst_idx;
534
535                 /* find the first free slot */
536                 for (i = 0; i < state->depth; ++i) {
537                         if (all_mask & (1 << i)) {
538                                 all_mask &= ~(1 << i);
539
540                                 /* check if there are differences here */
541                                 if (x87_get_st_reg(state, i) != x87_get_st_reg(dst_state, i))
542                                         break;
543                         }
544                 }
545
546                 if (! all_mask) {
547                         /* no more cycles found */
548                         break;
549                 }
550
551                 k = 0;
552                 cycles[n_cycles] = (1 << i);
553                 cycle_idx[n_cycles][k++] = i;
554                 for (src_idx = i; ; src_idx = dst_idx) {
555                         dst_idx = x87_on_stack(dst_state, x87_get_st_reg(state, src_idx));
556
557                         if ((all_mask & (1 << dst_idx)) == 0)
558                                 break;
559
560                         cycle_idx[n_cycles][k++] = dst_idx;
561                         cycles[n_cycles] |=  (1 << dst_idx);
562                         all_mask       &= ~(1 << dst_idx);
563                 }
564                 cycle_idx[n_cycles][k] = -1;
565         }
566
567         if (n_cycles <= 0) {
568                 /* no permutation needed */
569                 return state;
570         }
571
572         /* Hmm: permutation needed */
573         DB((dbg, LEVEL_2, "\n%+F needs permutation: from\n", block));
574         DEBUG_ONLY(x87_dump_stack(state));
575         DB((dbg, LEVEL_2, "                  to\n"));
576         DEBUG_ONLY(x87_dump_stack(dst_state));
577
578
579 #ifdef DEBUG_libfirm
580         DB((dbg, LEVEL_2, "Need %d cycles\n", n_cycles));
581         for (ri = 0; ri < n_cycles; ++ri) {
582                 DB((dbg, LEVEL_2, " Ring %d:\n ", ri));
583                 for (k = 0; cycle_idx[ri][k] != -1; ++k)
584                         DB((dbg, LEVEL_2, " st%d ->", cycle_idx[ri][k]));
585                 DB((dbg, LEVEL_2, "\n"));
586         }
587 #endif
588
589         after = NULL;
590
591         /*
592          * Find the place node must be insert.
593          * We have only one successor block, so the last instruction should
594          * be a jump.
595          */
596         before = sched_last(block);
597         assert(is_cfop(before));
598
599         /* now do the permutations */
600         for (ri = 0; ri < n_cycles; ++ri) {
601                 if ((cycles[ri] & 1) == 0) {
602                         /* this cycle does not include the tos */
603                         fxch = x87_fxch_shuffle(state, cycle_idx[ri][0], block);
604                         if (after)
605                                 sched_add_after(after, fxch);
606                         else
607                                 sched_add_before(before, fxch);
608                         after = fxch;
609                 }
610                 for (k = 1; cycle_idx[ri][k] != -1; ++k) {
611                         fxch = x87_fxch_shuffle(state, cycle_idx[ri][k], block);
612                         if (after)
613                                 sched_add_after(after, fxch);
614                         else
615                                 sched_add_before(before, fxch);
616                         after = fxch;
617                 }
618                 if ((cycles[ri] & 1) == 0) {
619                         /* this cycle does not include the tos */
620                         fxch = x87_fxch_shuffle(state, cycle_idx[ri][0], block);
621                         sched_add_after(after, fxch);
622                 }
623         }
624         return state;
625 }  /* x87_shuffle */
626
627 /**
628  * Create a fxch node before another node.
629  *
630  * @param state   the x87 state
631  * @param n       the node after the fxch
632  * @param pos     exchange st(pos) with st(0)
633  *
634  * @return the fxch
635  */
636 static ir_node *x87_create_fxch(x87_state *state, ir_node *n, int pos)
637 {
638         ir_node         *fxch;
639         ia32_x87_attr_t *attr;
640         ir_graph        *irg = get_irn_irg(n);
641         ir_node         *block = get_nodes_block(n);
642
643         x87_fxch(state, pos);
644
645         fxch = new_rd_ia32_fxch(NULL, irg, block);
646         attr = get_ia32_x87_attr(fxch);
647         attr->x87[0] = &ia32_st_regs[pos];
648         attr->x87[2] = &ia32_st_regs[0];
649
650         keep_alive(fxch);
651
652         sched_add_before(n, fxch);
653         DB((dbg, LEVEL_1, "<<< %s %s, %s\n", get_irn_opname(fxch), attr->x87[0]->name, attr->x87[2]->name));
654         return fxch;
655 }  /* x87_create_fxch */
656
657 /**
658  * Create a fpush before node n.
659  *
660  * @param state     the x87 state
661  * @param n         the node after the fpush
662  * @param pos       push st(pos) on stack
663  * @param op_idx    replace input op_idx of n with the fpush result
664  */
665 static void x87_create_fpush(x87_state *state, ir_node *n, int pos, int op_idx)
666 {
667         ir_node               *fpush, *pred = get_irn_n(n, op_idx);
668         ia32_x87_attr_t       *attr;
669         const arch_register_t *out = x87_get_irn_register(pred);
670
671         x87_push_dbl(state, arch_register_get_index(out), pred);
672
673         fpush = new_rd_ia32_fpush(NULL, get_irn_irg(n), get_nodes_block(n));
674         attr  = get_ia32_x87_attr(fpush);
675         attr->x87[0] = &ia32_st_regs[pos];
676         attr->x87[2] = &ia32_st_regs[0];
677
678         keep_alive(fpush);
679         sched_add_before(n, fpush);
680
681         DB((dbg, LEVEL_1, "<<< %s %s, %s\n", get_irn_opname(fpush), attr->x87[0]->name, attr->x87[2]->name));
682 }  /* x87_create_fpush */
683
684 /**
685  * Create a fpop before node n.
686  *
687  * @param state   the x87 state
688  * @param n       the node after the fpop
689  * @param num     pop 1 or 2 values
690  *
691  * @return the fpop node
692  */
693 static ir_node *x87_create_fpop(x87_state *state, ir_node *n, int num)
694 {
695         ir_node         *fpop = NULL;
696         ia32_x87_attr_t *attr;
697
698         assert(num > 0);
699         while (num > 0) {
700                 x87_pop(state);
701                 if (ia32_cg_config.use_ffreep)
702                         fpop = new_rd_ia32_ffreep(NULL, get_irn_irg(n), get_nodes_block(n));
703                 else
704                         fpop = new_rd_ia32_fpop(NULL, get_irn_irg(n), get_nodes_block(n));
705                 attr = get_ia32_x87_attr(fpop);
706                 attr->x87[0] = &ia32_st_regs[0];
707                 attr->x87[1] = &ia32_st_regs[0];
708                 attr->x87[2] = &ia32_st_regs[0];
709
710                 keep_alive(fpop);
711                 sched_add_before(n, fpop);
712                 DB((dbg, LEVEL_1, "<<< %s %s\n", get_irn_opname(fpop), attr->x87[0]->name));
713
714                 --num;
715         }
716         return fpop;
717 }  /* x87_create_fpop */
718
719 /**
720  * Creates an fldz before node n
721  *
722  * @param state   the x87 state
723  * @param n       the node after the fldz
724  *
725  * @return the fldz node
726  */
727 static ir_node *x87_create_fldz(x87_state *state, ir_node *n, int regidx)
728 {
729         ir_graph *irg = get_irn_irg(n);
730         ir_node *block = get_nodes_block(n);
731         ir_node *fldz;
732
733         fldz = new_rd_ia32_fldz(NULL, irg, block, mode_E);
734
735         sched_add_before(n, fldz);
736         DB((dbg, LEVEL_1, "<<< %s\n", get_irn_opname(fldz)));
737         keep_alive(fldz);
738
739         x87_push(state, regidx, fldz);
740
741         return fldz;
742 }
743
744 /* --------------------------------- liveness ------------------------------------------ */
745
746 /**
747  * The liveness transfer function.
748  * Updates a live set over a single step from a given node to its predecessor.
749  * Everything defined at the node is removed from the set, the uses of the node get inserted.
750  *
751  * @param sim      The simulator handle.
752  * @param irn      The node at which liveness should be computed.
753  * @param live     The bitset of registers live before @p irn. This set gets modified by updating it to
754  *                 the registers live after irn.
755  *
756  * @return The live bitset.
757  */
758 static vfp_liveness vfp_liveness_transfer(x87_simulator *sim, ir_node *irn, vfp_liveness live)
759 {
760         int i, n;
761         const arch_register_class_t *cls = &ia32_reg_classes[CLASS_ia32_vfp];
762         const arch_env_t *arch_env = sim->arch_env;
763
764         if (get_irn_mode(irn) == mode_T) {
765                 const ir_edge_t *edge;
766
767                 foreach_out_edge(irn, edge) {
768                         ir_node *proj = get_edge_src_irn(edge);
769
770                         if (arch_irn_consider_in_reg_alloc(arch_env, cls, proj)) {
771                                 const arch_register_t *reg = x87_get_irn_register(proj);
772                                 live &= ~(1 << arch_register_get_index(reg));
773                         }
774                 }
775         }
776
777         if (arch_irn_consider_in_reg_alloc(arch_env, cls, irn)) {
778                 const arch_register_t *reg = x87_get_irn_register(irn);
779                 live &= ~(1 << arch_register_get_index(reg));
780         }
781
782         for (i = 0, n = get_irn_arity(irn); i < n; ++i) {
783                 ir_node *op = get_irn_n(irn, i);
784
785                 if (mode_is_float(get_irn_mode(op)) && arch_irn_consider_in_reg_alloc(arch_env, cls, op)) {
786                         const arch_register_t *reg = x87_get_irn_register(op);
787                         live |= 1 << arch_register_get_index(reg);
788                 }
789         }
790         return live;
791 }  /* vfp_liveness_transfer */
792
793 /**
794  * Put all live virtual registers at the end of a block into a bitset.
795  *
796  * @param sim      the simulator handle
797  * @param lv       the liveness information
798  * @param bl       the block
799  *
800  * @return The live bitset at the end of this block
801  */
802 static vfp_liveness vfp_liveness_end_of_block(x87_simulator *sim, const ir_node *block)
803 {
804         int i;
805         vfp_liveness live = 0;
806         const arch_register_class_t *cls = &ia32_reg_classes[CLASS_ia32_vfp];
807         const arch_env_t *arch_env = sim->arch_env;
808         const be_lv_t *lv = sim->lv;
809
810         be_lv_foreach(lv, block, be_lv_state_end, i) {
811                 const arch_register_t *reg;
812                 const ir_node *node = be_lv_get_irn(lv, block, i);
813                 if (!arch_irn_consider_in_reg_alloc(arch_env, cls, node))
814                         continue;
815
816                 reg = x87_get_irn_register(node);
817                 live |= 1 << arch_register_get_index(reg);
818         }
819
820         return live;
821 }  /* vfp_liveness_end_of_block */
822
823 /** get the register mask from an arch_register */
824 #define REGMASK(reg)    (1 << (arch_register_get_index(reg)))
825
826 /**
827  * Return a bitset of argument registers which are live at the end of a node.
828  *
829  * @param sim    the simulator handle
830  * @param pos    the node
831  * @param kill   kill mask for the output registers
832  *
833  * @return The live bitset.
834  */
835 static unsigned vfp_live_args_after(x87_simulator *sim, const ir_node *pos, unsigned kill)
836 {
837         unsigned idx = get_irn_idx(pos);
838
839         assert(idx < sim->n_idx);
840         return sim->live[idx] & ~kill;
841 }  /* vfp_live_args_after */
842
843 /**
844  * Calculate the liveness for a whole block and cache it.
845  *
846  * @param sim   the simulator handle
847  * @param lv    the liveness handle
848  * @param block the block
849  */
850 static void update_liveness(x87_simulator *sim, ir_node *block)
851 {
852         vfp_liveness live = vfp_liveness_end_of_block(sim, block);
853         unsigned idx;
854         ir_node *irn;
855
856         /* now iterate through the block backward and cache the results */
857         sched_foreach_reverse(block, irn) {
858                 /* stop at the first Phi: this produces the live-in */
859                 if (is_Phi(irn))
860                         break;
861
862                 idx = get_irn_idx(irn);
863                 sim->live[idx] = live;
864
865                 live = vfp_liveness_transfer(sim, irn, live);
866         }
867         idx = get_irn_idx(block);
868         sim->live[idx] = live;
869 }  /* update_liveness */
870
871 /**
872  * Returns true if a register is live in a set.
873  *
874  * @param reg_idx  the vfp register index
875  * @param live     a live bitset
876  */
877 #define is_vfp_live(reg_idx, live) ((live) & (1 << (reg_idx)))
878
879 #ifdef DEBUG_libfirm
880 /**
881  * Dump liveness info.
882  *
883  * @param live  the live bitset
884  */
885 static void vfp_dump_live(vfp_liveness live)
886 {
887         int i;
888
889         DB((dbg, LEVEL_2, "Live after: "));
890         for (i = 0; i < 8; ++i) {
891                 if (live & (1 << i)) {
892                         DB((dbg, LEVEL_2, "vf%d ", i));
893                 }
894         }
895         DB((dbg, LEVEL_2, "\n"));
896 }  /* vfp_dump_live */
897 #endif /* DEBUG_libfirm */
898
899 /* --------------------------------- simulators ---------------------------------------- */
900
901 #define XCHG(a, b) do { int t = (a); (a) = (b); (b) = t; } while (0)
902
903 /* Pseudocode:
904
905
906
907
908
909
910 */
911
912 /**
913  * Simulate a virtual binop.
914  *
915  * @param state  the x87 state
916  * @param n      the node that should be simulated (and patched)
917  * @param tmpl   the template containing the 4 possible x87 opcodes
918  *
919  * @return NO_NODE_ADDED
920  */
921 static int sim_binop(x87_state *state, ir_node *n, const exchange_tmpl *tmpl)
922 {
923         int op2_idx = 0, op1_idx;
924         int out_idx, do_pop = 0;
925         ia32_x87_attr_t *attr;
926         int permuted;
927         ir_node *patched_insn;
928         ir_op *dst;
929         x87_simulator         *sim     = state->sim;
930         ir_node               *op1     = get_irn_n(n, n_ia32_binary_left);
931         ir_node               *op2     = get_irn_n(n, n_ia32_binary_right);
932         const arch_register_t *op1_reg = x87_get_irn_register(op1);
933         const arch_register_t *op2_reg = x87_get_irn_register(op2);
934         const arch_register_t *out     = x87_get_irn_register(n);
935         int reg_index_1                = arch_register_get_index(op1_reg);
936         int reg_index_2                = arch_register_get_index(op2_reg);
937         vfp_liveness           live    = vfp_live_args_after(sim, n, REGMASK(out));
938         int                    op1_live_after;
939         int                    op2_live_after;
940
941         DB((dbg, LEVEL_1, ">>> %+F %s, %s -> %s\n", n,
942                 arch_register_get_name(op1_reg), arch_register_get_name(op2_reg),
943                 arch_register_get_name(out)));
944         DEBUG_ONLY(vfp_dump_live(live));
945         DB((dbg, LEVEL_1, "Stack before: "));
946         DEBUG_ONLY(x87_dump_stack(state));
947
948         if (reg_index_1 == REG_VFP_UKNWN) {
949                 op1_idx        = 0;
950                 op1_live_after = 1;
951         } else {
952                 op1_idx = x87_on_stack(state, reg_index_1);
953                 assert(op1_idx >= 0);
954                 op1_live_after = is_vfp_live(arch_register_get_index(op1_reg), live);
955         }
956
957         attr     = get_ia32_x87_attr(n);
958         permuted = attr->attr.data.ins_permuted;
959
960         if (reg_index_2 != REG_VFP_NOREG) {
961                 assert(!permuted);
962
963                 if (reg_index_2 == REG_VFP_UKNWN) {
964                         op2_idx        = 0;
965                         op2_live_after = 1;
966                 } else {
967                         /* second operand is a vfp register */
968                         op2_idx = x87_on_stack(state, reg_index_2);
969                         assert(op2_idx >= 0);
970                         op2_live_after
971                                 = is_vfp_live(arch_register_get_index(op2_reg), live);
972                 }
973
974                 if (op2_live_after) {
975                         /* Second operand is live. */
976
977                         if (op1_live_after) {
978                                 /* Both operands are live: push the first one.
979                                    This works even for op1 == op2. */
980                                 x87_create_fpush(state, n, op1_idx, n_ia32_binary_right);
981                                 /* now do fxxx (tos=tos X op) */
982                                 op1_idx = 0;
983                                 op2_idx += 1;
984                                 out_idx = 0;
985                                 dst = tmpl->normal_op;
986                         } else {
987                                 /* Second live, first operand is dead here, bring it to tos. */
988                                 if (op1_idx != 0) {
989                                         x87_create_fxch(state, n, op1_idx);
990                                         if (op2_idx == 0)
991                                                 op2_idx = op1_idx;
992                                         op1_idx = 0;
993                                 }
994                                 /* now do fxxx (tos=tos X op) */
995                                 out_idx = 0;
996                                 dst = tmpl->normal_op;
997                         }
998                 } else {
999                         /* Second operand is dead. */
1000                         if (op1_live_after) {
1001                                 /* First operand is live: bring second to tos. */
1002                                 if (op2_idx != 0) {
1003                                         x87_create_fxch(state, n, op2_idx);
1004                                         if (op1_idx == 0)
1005                                                 op1_idx = op2_idx;
1006                                         op2_idx = 0;
1007                                 }
1008                                 /* now do fxxxr (tos = op X tos) */
1009                                 out_idx = 0;
1010                                 dst = tmpl->reverse_op;
1011                         } else {
1012                                 /* Both operands are dead here, pop them from the stack. */
1013                                 if (op2_idx == 0) {
1014                                         if (op1_idx == 0) {
1015                                                 /* Both are identically and on tos, no pop needed. */
1016                                                 /* here fxxx (tos = tos X tos) */
1017                                                 dst = tmpl->normal_op;
1018                                                 out_idx = 0;
1019                                         } else {
1020                                                 /* now do fxxxp (op = op X tos, pop) */
1021                                                 dst = tmpl->normal_pop_op;
1022                                                 do_pop = 1;
1023                                                 out_idx = op1_idx;
1024                                         }
1025                                 } else if (op1_idx == 0) {
1026                                         assert(op1_idx != op2_idx);
1027                                         /* now do fxxxrp (op = tos X op, pop) */
1028                                         dst = tmpl->reverse_pop_op;
1029                                         do_pop = 1;
1030                                         out_idx = op2_idx;
1031                                 } else {
1032                                         /* Bring the second on top. */
1033                                         x87_create_fxch(state, n, op2_idx);
1034                                         if (op1_idx == op2_idx) {
1035                                                 /* Both are identically and on tos now, no pop needed. */
1036                                                 op1_idx = 0;
1037                                                 op2_idx = 0;
1038                                                 /* use fxxx (tos = tos X tos) */
1039                                                 dst = tmpl->normal_op;
1040                                                 out_idx = 0;
1041                                         } else {
1042                                                 /* op2 is on tos now */
1043                                                 op2_idx = 0;
1044                                                 /* use fxxxp (op = op X tos, pop) */
1045                                                 dst = tmpl->normal_pop_op;
1046                                                 out_idx = op1_idx;
1047                                                 do_pop = 1;
1048                                         }
1049                                 }
1050                         }
1051                 }
1052         } else {
1053                 /* second operand is an address mode */
1054                 if (op1_live_after) {
1055                         /* first operand is live: push it here */
1056                         x87_create_fpush(state, n, op1_idx, n_ia32_binary_left);
1057                         op1_idx = 0;
1058                 } else {
1059                         /* first operand is dead: bring it to tos */
1060                         if (op1_idx != 0) {
1061                                 x87_create_fxch(state, n, op1_idx);
1062                                 op1_idx = 0;
1063                         }
1064                 }
1065
1066                 /* use fxxx (tos = tos X mem) */
1067                 dst = permuted ? tmpl->reverse_op : tmpl->normal_op;
1068                 out_idx = 0;
1069         }
1070
1071         patched_insn = x87_patch_insn(n, dst);
1072         x87_set_st(state, arch_register_get_index(out), patched_insn, out_idx);
1073         if (do_pop) {
1074                 x87_pop(state);
1075         }
1076
1077         /* patch the operation */
1078         attr->x87[0] = op1_reg = &ia32_st_regs[op1_idx];
1079         if (reg_index_2 != REG_VFP_NOREG) {
1080                 attr->x87[1] = op2_reg = &ia32_st_regs[op2_idx];
1081         }
1082         attr->x87[2] = out = &ia32_st_regs[out_idx];
1083
1084         if (reg_index_2 != REG_VFP_NOREG) {
1085                 DB((dbg, LEVEL_1, "<<< %s %s, %s -> %s\n", get_irn_opname(n),
1086                         arch_register_get_name(op1_reg), arch_register_get_name(op2_reg),
1087                         arch_register_get_name(out)));
1088         } else {
1089                 DB((dbg, LEVEL_1, "<<< %s %s, [AM] -> %s\n", get_irn_opname(n),
1090                         arch_register_get_name(op1_reg),
1091                         arch_register_get_name(out)));
1092         }
1093
1094         return NO_NODE_ADDED;
1095 }  /* sim_binop */
1096
1097 /**
1098  * Simulate a virtual Unop.
1099  *
1100  * @param state  the x87 state
1101  * @param n      the node that should be simulated (and patched)
1102  * @param op     the x87 opcode that will replace n's opcode
1103  *
1104  * @return NO_NODE_ADDED
1105  */
1106 static int sim_unop(x87_state *state, ir_node *n, ir_op *op)
1107 {
1108         int op1_idx, out_idx;
1109         x87_simulator         *sim = state->sim;
1110         const arch_register_t *op1 = x87_get_irn_register(get_irn_n(n, UNOP_IDX));
1111         const arch_register_t *out = x87_get_irn_register(n);
1112         ia32_x87_attr_t *attr;
1113         unsigned live = vfp_live_args_after(sim, n, REGMASK(out));
1114
1115         DB((dbg, LEVEL_1, ">>> %+F -> %s\n", n, out->name));
1116         DEBUG_ONLY(vfp_dump_live(live));
1117
1118         op1_idx = x87_on_stack(state, arch_register_get_index(op1));
1119
1120         if (is_vfp_live(arch_register_get_index(op1), live)) {
1121                 /* push the operand here */
1122                 x87_create_fpush(state, n, op1_idx, UNOP_IDX);
1123                 op1_idx = 0;
1124         }
1125         else {
1126                 /* operand is dead, bring it to tos */
1127                 if (op1_idx != 0) {
1128                         x87_create_fxch(state, n, op1_idx);
1129                         op1_idx = 0;
1130                 }
1131         }
1132
1133         x87_set_tos(state, arch_register_get_index(out), x87_patch_insn(n, op));
1134         out_idx = 0;
1135         attr = get_ia32_x87_attr(n);
1136         attr->x87[0] = op1 = &ia32_st_regs[0];
1137         attr->x87[2] = out = &ia32_st_regs[0];
1138         DB((dbg, LEVEL_1, "<<< %s -> %s\n", get_irn_opname(n), out->name));
1139
1140         return NO_NODE_ADDED;
1141 }  /* sim_unop */
1142
1143 /**
1144  * Simulate a virtual Load instruction.
1145  *
1146  * @param state  the x87 state
1147  * @param n      the node that should be simulated (and patched)
1148  * @param op     the x87 opcode that will replace n's opcode
1149  *
1150  * @return NO_NODE_ADDED
1151  */
1152 static int sim_load(x87_state *state, ir_node *n, ir_op *op)
1153 {
1154         const arch_register_t *out = x87_get_irn_register(n);
1155         ia32_x87_attr_t *attr;
1156
1157         DB((dbg, LEVEL_1, ">>> %+F -> %s\n", n, arch_register_get_name(out)));
1158         x87_push(state, arch_register_get_index(out), x87_patch_insn(n, op));
1159         assert(out == x87_get_irn_register(n));
1160         attr = get_ia32_x87_attr(n);
1161         attr->x87[2] = out = &ia32_st_regs[0];
1162         DB((dbg, LEVEL_1, "<<< %s -> %s\n", get_irn_opname(n), arch_register_get_name(out)));
1163
1164         return NO_NODE_ADDED;
1165 }  /* sim_load */
1166
1167 /**
1168  * Rewire all users of @p old_val to @new_val iff they are scheduled after @p store.
1169  *
1170  * @param store   The store
1171  * @param old_val The former value
1172  * @param new_val The new value
1173  */
1174 static void collect_and_rewire_users(ir_node *store, ir_node *old_val, ir_node *new_val)
1175 {
1176         const ir_edge_t *edge, *ne;
1177
1178         foreach_out_edge_safe(old_val, edge, ne) {
1179                 ir_node *user = get_edge_src_irn(edge);
1180
1181                 if (! user || user == store)
1182                         continue;
1183
1184                 /* if the user is scheduled after the store: rewire */
1185                 if (sched_is_scheduled(user) && sched_comes_after(store, user)) {
1186                         int i;
1187                         /* find the input of the user pointing to the old value */
1188                         for (i = get_irn_arity(user) - 1; i >= 0; i--) {
1189                                 if (get_irn_n(user, i) == old_val)
1190                                         set_irn_n(user, i, new_val);
1191                         }
1192                 }
1193         }
1194 }  /* collect_and_rewire_users */
1195
1196 /**
1197  * Simulate a virtual Store.
1198  *
1199  * @param state  the x87 state
1200  * @param n      the node that should be simulated (and patched)
1201  * @param op     the x87 store opcode
1202  * @param op_p   the x87 store and pop opcode
1203  */
1204 static int sim_store(x87_state *state, ir_node *n, ir_op *op, ir_op *op_p)
1205 {
1206         ir_node               *val = get_irn_n(n, n_ia32_vfst_val);
1207         const arch_register_t *op2 = x87_get_irn_register(val);
1208         unsigned              live = vfp_live_args_after(state->sim, n, 0);
1209         int                   insn = NO_NODE_ADDED;
1210         ia32_x87_attr_t *attr;
1211         int op2_reg_idx, op2_idx, depth;
1212         int live_after_node;
1213         ir_mode *mode;
1214
1215         op2_reg_idx = arch_register_get_index(op2);
1216         if (op2_reg_idx == REG_VFP_UKNWN) {
1217                 /* just take any value from stack */
1218                 if (state->depth > 0) {
1219                         op2_idx = 0;
1220                         DEBUG_ONLY(op2 = NULL);
1221                         live_after_node = 1;
1222                 } else {
1223                         /* produce a new value which we will consume immediately */
1224                         x87_create_fldz(state, n, op2_reg_idx);
1225                         live_after_node = 0;
1226                         op2_idx = x87_on_stack(state, op2_reg_idx);
1227                         assert(op2_idx >= 0);
1228                 }
1229         } else {
1230                 op2_idx = x87_on_stack(state, op2_reg_idx);
1231                 live_after_node = is_vfp_live(arch_register_get_index(op2), live);
1232                 DB((dbg, LEVEL_1, ">>> %+F %s ->\n", n, arch_register_get_name(op2)));
1233                 assert(op2_idx >= 0);
1234         }
1235
1236         mode  = get_ia32_ls_mode(n);
1237         depth = x87_get_depth(state);
1238
1239         if (live_after_node) {
1240                 /*
1241                         Problem: fst doesn't support mode_E (spills), only fstp does
1242                         Solution:
1243                                 - stack not full: push value and fstp
1244                                 - stack full: fstp value and load again
1245                         Note that we cannot test on mode_E, because floats might be 96bit ...
1246                 */
1247                 if (get_mode_size_bits(mode) > 64 || mode == mode_Ls) {
1248                         if (depth < N_x87_REGS) {
1249                                 /* ok, we have a free register: push + fstp */
1250                                 x87_create_fpush(state, n, op2_idx, n_ia32_vfst_val);
1251                                 x87_pop(state);
1252                                 x87_patch_insn(n, op_p);
1253                         } else {
1254                                 ir_node  *vfld, *mem, *block, *rproj, *mproj;
1255                                 ir_graph *irg;
1256
1257                                 /* stack full here: need fstp + load */
1258                                 x87_pop(state);
1259                                 x87_patch_insn(n, op_p);
1260
1261                                 block = get_nodes_block(n);
1262                                 irg   = get_irn_irg(n);
1263                                 vfld  = new_rd_ia32_vfld(NULL, irg, block, get_irn_n(n, 0), get_irn_n(n, 1), new_rd_NoMem(irg), get_ia32_ls_mode(n));
1264
1265                                 /* copy all attributes */
1266                                 set_ia32_frame_ent(vfld, get_ia32_frame_ent(n));
1267                                 if (is_ia32_use_frame(n))
1268                                         set_ia32_use_frame(vfld);
1269                                 set_ia32_op_type(vfld, ia32_AddrModeS);
1270                                 add_ia32_am_offs_int(vfld, get_ia32_am_offs_int(n));
1271                                 set_ia32_am_sc(vfld, get_ia32_am_sc(n));
1272                                 set_ia32_ls_mode(vfld, get_ia32_ls_mode(n));
1273
1274                                 rproj = new_r_Proj(irg, block, vfld, get_ia32_ls_mode(vfld), pn_ia32_vfld_res);
1275                                 mproj = new_r_Proj(irg, block, vfld, mode_M, pn_ia32_vfld_M);
1276                                 mem   = get_irn_Proj_for_mode(n, mode_M);
1277
1278                                 assert(mem && "Store memory not found");
1279
1280                                 arch_set_irn_register(rproj, op2);
1281
1282                                 /* reroute all former users of the store memory to the load memory */
1283                                 edges_reroute(mem, mproj, irg);
1284                                 /* set the memory input of the load to the store memory */
1285                                 set_irn_n(vfld, n_ia32_vfld_mem, mem);
1286
1287                                 sched_add_after(n, vfld);
1288                                 sched_add_after(vfld, rproj);
1289
1290                                 /* rewire all users, scheduled after the store, to the loaded value */
1291                                 collect_and_rewire_users(n, val, rproj);
1292
1293                                 insn = NODE_ADDED;
1294                         }
1295                 } else {
1296                         /* we can only store the tos to memory */
1297                         if (op2_idx != 0)
1298                                 x87_create_fxch(state, n, op2_idx);
1299
1300                         /* mode != mode_E -> use normal fst */
1301                         x87_patch_insn(n, op);
1302                 }
1303         } else {
1304                 /* we can only store the tos to memory */
1305                 if (op2_idx != 0)
1306                         x87_create_fxch(state, n, op2_idx);
1307
1308                 x87_pop(state);
1309                 x87_patch_insn(n, op_p);
1310         }
1311
1312         attr = get_ia32_x87_attr(n);
1313         attr->x87[1] = op2 = &ia32_st_regs[0];
1314         DB((dbg, LEVEL_1, "<<< %s %s ->\n", get_irn_opname(n), arch_register_get_name(op2)));
1315
1316         return insn;
1317 }  /* sim_store */
1318
1319 #define _GEN_BINOP(op, rev) \
1320 static int sim_##op(x87_state *state, ir_node *n) { \
1321         exchange_tmpl tmpl = { op_ia32_##op, op_ia32_##rev, op_ia32_##op##p, op_ia32_##rev##p }; \
1322         return sim_binop(state, n, &tmpl); \
1323 }
1324
1325 #define GEN_BINOP(op)   _GEN_BINOP(op, op)
1326 #define GEN_BINOPR(op)  _GEN_BINOP(op, op##r)
1327
1328 #define GEN_LOAD2(op, nop) \
1329 static int sim_##op(x87_state *state, ir_node *n) { \
1330         return sim_load(state, n, op_ia32_##nop); \
1331 }
1332
1333 #define GEN_LOAD(op)    GEN_LOAD2(op, op)
1334
1335 #define GEN_UNOP(op) \
1336 static int sim_##op(x87_state *state, ir_node *n) { \
1337         return sim_unop(state, n, op_ia32_##op); \
1338 }
1339
1340 #define GEN_STORE(op) \
1341 static int sim_##op(x87_state *state, ir_node *n) { \
1342         return sim_store(state, n, op_ia32_##op, op_ia32_##op##p); \
1343 }
1344
1345 /* all stubs */
1346 GEN_BINOP(fadd)
1347 GEN_BINOPR(fsub)
1348 GEN_BINOP(fmul)
1349 GEN_BINOPR(fdiv)
1350 GEN_BINOP(fprem)
1351
1352 GEN_UNOP(fabs)
1353 GEN_UNOP(fchs)
1354
1355 GEN_LOAD(fld)
1356 GEN_LOAD(fild)
1357 GEN_LOAD(fldz)
1358 GEN_LOAD(fld1)
1359
1360 GEN_STORE(fst)
1361 GEN_STORE(fist)
1362
1363 /**
1364 * Simulate a virtual fisttp.
1365 *
1366 * @param state  the x87 state
1367 * @param n      the node that should be simulated (and patched)
1368 */
1369 static int sim_fisttp(x87_state *state, ir_node *n)
1370 {
1371         ir_node               *val = get_irn_n(n, n_ia32_vfst_val);
1372         const arch_register_t *op2 = x87_get_irn_register(val);
1373         int                   insn = NO_NODE_ADDED;
1374         ia32_x87_attr_t *attr;
1375         int op2_reg_idx, op2_idx, depth;
1376
1377         op2_reg_idx = arch_register_get_index(op2);
1378         if (op2_reg_idx == REG_VFP_UKNWN) {
1379                 /* just take any value from stack */
1380                 if (state->depth > 0) {
1381                         op2_idx = 0;
1382                         DEBUG_ONLY(op2 = NULL);
1383                 } else {
1384                         /* produce a new value which we will consume immediately */
1385                         x87_create_fldz(state, n, op2_reg_idx);
1386                         op2_idx = x87_on_stack(state, op2_reg_idx);
1387                         assert(op2_idx >= 0);
1388                 }
1389         } else {
1390                 op2_idx = x87_on_stack(state, op2_reg_idx);
1391                 DB((dbg, LEVEL_1, ">>> %+F %s ->\n", n, arch_register_get_name(op2)));
1392                 assert(op2_idx >= 0);
1393         }
1394
1395         depth = x87_get_depth(state);
1396
1397         /* Note: although the value is still live here, it is destroyed because
1398            of the pop. The register allocator is aware of that and introduced a copy
1399            if the value must be alive. */
1400
1401         /* we can only store the tos to memory */
1402         if (op2_idx != 0)
1403                 x87_create_fxch(state, n, op2_idx);
1404
1405         x87_pop(state);
1406         x87_patch_insn(n, op_ia32_fisttp);
1407
1408         attr = get_ia32_x87_attr(n);
1409         attr->x87[1] = op2 = &ia32_st_regs[0];
1410         DB((dbg, LEVEL_1, "<<< %s %s ->\n", get_irn_opname(n), arch_register_get_name(op2)));
1411
1412         return insn;
1413 }  /* sim_fisttp */
1414
1415 static int sim_FtstFnstsw(x87_state *state, ir_node *n)
1416 {
1417         x87_simulator         *sim         = state->sim;
1418         ia32_x87_attr_t       *attr        = get_ia32_x87_attr(n);
1419         ir_node               *op1_node    = get_irn_n(n, n_ia32_vFtstFnstsw_left);
1420         const arch_register_t *reg1        = x87_get_irn_register(op1_node);
1421         int                    reg_index_1 = arch_register_get_index(reg1);
1422         int                    op1_idx     = x87_on_stack(state, reg_index_1);
1423         unsigned               live        = vfp_live_args_after(sim, n, 0);
1424
1425         DB((dbg, LEVEL_1, ">>> %+F %s\n", n, arch_register_get_name(reg1)));
1426         DEBUG_ONLY(vfp_dump_live(live));
1427         DB((dbg, LEVEL_1, "Stack before: "));
1428         DEBUG_ONLY(x87_dump_stack(state));
1429         assert(op1_idx >= 0);
1430
1431         if (op1_idx != 0) {
1432                 /* bring the value to tos */
1433                 x87_create_fxch(state, n, op1_idx);
1434                 op1_idx = 0;
1435         }
1436
1437         /* patch the operation */
1438         x87_patch_insn(n, op_ia32_FtstFnstsw);
1439         reg1 = &ia32_st_regs[op1_idx];
1440         attr->x87[0] = reg1;
1441         attr->x87[1] = NULL;
1442         attr->x87[2] = NULL;
1443
1444         if (!is_vfp_live(reg_index_1, live)) {
1445                 x87_create_fpop(state, sched_next(n), 1);
1446                 return NODE_ADDED;
1447         }
1448
1449         return NO_NODE_ADDED;
1450 }
1451
1452 /**
1453  * @param state  the x87 state
1454  * @param n      the node that should be simulated (and patched)
1455  */
1456 static int sim_Fucom(x87_state *state, ir_node *n)
1457 {
1458         int op1_idx;
1459         int op2_idx = -1;
1460         ia32_x87_attr_t *attr = get_ia32_x87_attr(n);
1461         ir_op *dst;
1462         x87_simulator         *sim = state->sim;
1463         ir_node               *op1_node = get_irn_n(n, n_ia32_vFucomFnstsw_left);
1464         ir_node               *op2_node = get_irn_n(n, n_ia32_vFucomFnstsw_right);
1465         const arch_register_t *op1      = x87_get_irn_register(op1_node);
1466         const arch_register_t *op2      = x87_get_irn_register(op2_node);
1467         int reg_index_1 = arch_register_get_index(op1);
1468         int reg_index_2 = arch_register_get_index(op2);
1469         unsigned live = vfp_live_args_after(sim, n, 0);
1470         int                    permuted = attr->attr.data.ins_permuted;
1471         int xchg = 0;
1472         int pops = 0;
1473         int node_added = NO_NODE_ADDED;
1474
1475         DB((dbg, LEVEL_1, ">>> %+F %s, %s\n", n,
1476                 arch_register_get_name(op1), arch_register_get_name(op2)));
1477         DEBUG_ONLY(vfp_dump_live(live));
1478         DB((dbg, LEVEL_1, "Stack before: "));
1479         DEBUG_ONLY(x87_dump_stack(state));
1480
1481         op1_idx = x87_on_stack(state, reg_index_1);
1482         assert(op1_idx >= 0);
1483
1484         /* BEWARE: check for comp a,a cases, they might happen */
1485         if (reg_index_2 != REG_VFP_NOREG) {
1486                 /* second operand is a vfp register */
1487                 op2_idx = x87_on_stack(state, reg_index_2);
1488                 assert(op2_idx >= 0);
1489
1490                 if (is_vfp_live(reg_index_2, live)) {
1491                         /* second operand is live */
1492
1493                         if (is_vfp_live(reg_index_1, live)) {
1494                                 /* both operands are live */
1495
1496                                 if (op1_idx == 0) {
1497                                         /* res = tos X op */
1498                                 } else if (op2_idx == 0) {
1499                                         /* res = op X tos */
1500                                         permuted = !permuted;
1501                                         xchg    = 1;
1502                                 } else {
1503                                         /* bring the first one to tos */
1504                                         x87_create_fxch(state, n, op1_idx);
1505                                         if (op2_idx == 0)
1506                                                 op2_idx = op1_idx;
1507                                         op1_idx = 0;
1508                                         /* res = tos X op */
1509                                 }
1510                         } else {
1511                                 /* second live, first operand is dead here, bring it to tos.
1512                                    This means further, op1_idx != op2_idx. */
1513                                 assert(op1_idx != op2_idx);
1514                                 if (op1_idx != 0) {
1515                                         x87_create_fxch(state, n, op1_idx);
1516                                         if (op2_idx == 0)
1517                                                 op2_idx = op1_idx;
1518                                         op1_idx = 0;
1519                                 }
1520                                 /* res = tos X op, pop */
1521                                 pops = 1;
1522                         }
1523                 } else {
1524                         /* second operand is dead */
1525                         if (is_vfp_live(reg_index_1, live)) {
1526                                 /* first operand is live: bring second to tos.
1527                                    This means further, op1_idx != op2_idx. */
1528                                 assert(op1_idx != op2_idx);
1529                                 if (op2_idx != 0) {
1530                                         x87_create_fxch(state, n, op2_idx);
1531                                         if (op1_idx == 0)
1532                                                 op1_idx = op2_idx;
1533                                         op2_idx = 0;
1534                                 }
1535                                 /* res = op X tos, pop */
1536                                 pops    = 1;
1537                                 permuted = !permuted;
1538                                 xchg    = 1;
1539                         } else {
1540                                 /* both operands are dead here, check first for identity. */
1541                                 if (op1_idx == op2_idx) {
1542                                         /* identically, one pop needed */
1543                                         if (op1_idx != 0) {
1544                                                 x87_create_fxch(state, n, op1_idx);
1545                                                 op1_idx = 0;
1546                                                 op2_idx = 0;
1547                                         }
1548                                         /* res = tos X op, pop */
1549                                         pops    = 1;
1550                                 }
1551                                 /* different, move them to st and st(1) and pop both.
1552                                    The tricky part is to get one into st(1).*/
1553                                 else if (op2_idx == 1) {
1554                                         /* good, second operand is already in the right place, move the first */
1555                                         if (op1_idx != 0) {
1556                                                 /* bring the first on top */
1557                                                 x87_create_fxch(state, n, op1_idx);
1558                                                 assert(op2_idx != 0);
1559                                                 op1_idx = 0;
1560                                         }
1561                                         /* res = tos X op, pop, pop */
1562                                         pops = 2;
1563                                 } else if (op1_idx == 1) {
1564                                         /* good, first operand is already in the right place, move the second */
1565                                         if (op2_idx != 0) {
1566                                                 /* bring the first on top */
1567                                                 x87_create_fxch(state, n, op2_idx);
1568                                                 assert(op1_idx != 0);
1569                                                 op2_idx = 0;
1570                                         }
1571                                         /* res = op X tos, pop, pop */
1572                                         permuted = !permuted;
1573                                         xchg    = 1;
1574                                         pops    = 2;
1575                                 } else {
1576                                         /* if one is already the TOS, we need two fxch */
1577                                         if (op1_idx == 0) {
1578                                                 /* first one is TOS, move to st(1) */
1579                                                 x87_create_fxch(state, n, 1);
1580                                                 assert(op2_idx != 1);
1581                                                 op1_idx = 1;
1582                                                 x87_create_fxch(state, n, op2_idx);
1583                                                 op2_idx = 0;
1584                                                 /* res = op X tos, pop, pop */
1585                                                 pops    = 2;
1586                                                 permuted = !permuted;
1587                                                 xchg    = 1;
1588                                         } else if (op2_idx == 0) {
1589                                                 /* second one is TOS, move to st(1) */
1590                                                 x87_create_fxch(state, n, 1);
1591                                                 assert(op1_idx != 1);
1592                                                 op2_idx = 1;
1593                                                 x87_create_fxch(state, n, op1_idx);
1594                                                 op1_idx = 0;
1595                                                 /* res = tos X op, pop, pop */
1596                                                 pops    = 2;
1597                                         } else {
1598                                                 /* none of them is either TOS or st(1), 3 fxch needed */
1599                                                 x87_create_fxch(state, n, op2_idx);
1600                                                 assert(op1_idx != 0);
1601                                                 x87_create_fxch(state, n, 1);
1602                                                 op2_idx = 1;
1603                                                 x87_create_fxch(state, n, op1_idx);
1604                                                 op1_idx = 0;
1605                                                 /* res = tos X op, pop, pop */
1606                                                 pops    = 2;
1607                                         }
1608                                 }
1609                         }
1610                 }
1611         } else {
1612                 /* second operand is an address mode */
1613                 if (is_vfp_live(reg_index_1, live)) {
1614                         /* first operand is live: bring it to TOS */
1615                         if (op1_idx != 0) {
1616                                 x87_create_fxch(state, n, op1_idx);
1617                                 op1_idx = 0;
1618                         }
1619                 } else {
1620                         /* first operand is dead: bring it to tos */
1621                         if (op1_idx != 0) {
1622                                 x87_create_fxch(state, n, op1_idx);
1623                                 op1_idx = 0;
1624                         }
1625                         pops = 1;
1626                 }
1627         }
1628
1629         /* patch the operation */
1630         if (is_ia32_vFucomFnstsw(n)) {
1631                 int i;
1632
1633                 switch (pops) {
1634                 case 0: dst = op_ia32_FucomFnstsw;   break;
1635                 case 1: dst = op_ia32_FucompFnstsw;  break;
1636                 case 2: dst = op_ia32_FucomppFnstsw; break;
1637                 default: panic("invalid popcount in sim_Fucom");
1638                 }
1639
1640                 for (i = 0; i < pops; ++i) {
1641                         x87_pop(state);
1642                 }
1643         } else if (is_ia32_vFucomi(n)) {
1644                 switch (pops) {
1645                 case 0: dst = op_ia32_Fucomi;                  break;
1646                 case 1: dst = op_ia32_Fucompi; x87_pop(state); break;
1647                 case 2:
1648                         dst = op_ia32_Fucompi;
1649                         x87_pop(state);
1650                         x87_create_fpop(state, sched_next(n), 1);
1651                         node_added = NODE_ADDED;
1652                         break;
1653                 default: panic("invalid popcount in sim_Fucom");
1654                 }
1655         } else {
1656                 panic("invalid operation %+F in sim_FucomFnstsw", n);
1657         }
1658
1659         x87_patch_insn(n, dst);
1660         if (xchg) {
1661                 int tmp = op1_idx;
1662                 op1_idx = op2_idx;
1663                 op2_idx = tmp;
1664         }
1665
1666         op1 = &ia32_st_regs[op1_idx];
1667         attr->x87[0] = op1;
1668         if (op2_idx >= 0) {
1669                 op2 = &ia32_st_regs[op2_idx];
1670                 attr->x87[1] = op2;
1671         }
1672         attr->x87[2] = NULL;
1673         attr->attr.data.ins_permuted = permuted;
1674
1675         if (op2_idx >= 0) {
1676                 DB((dbg, LEVEL_1, "<<< %s %s, %s\n", get_irn_opname(n),
1677                         arch_register_get_name(op1), arch_register_get_name(op2)));
1678         } else {
1679                 DB((dbg, LEVEL_1, "<<< %s %s, [AM]\n", get_irn_opname(n),
1680                         arch_register_get_name(op1)));
1681         }
1682
1683         return node_added;
1684 }
1685
1686 static int sim_Keep(x87_state *state, ir_node *node)
1687 {
1688         const ir_node         *op;
1689         const arch_register_t *op_reg;
1690         int                    reg_id;
1691         int                    op_stack_idx;
1692         unsigned               live;
1693         int                    i, arity;
1694         int                    node_added = NO_NODE_ADDED;
1695
1696         DB((dbg, LEVEL_1, ">>> %+F\n", node));
1697
1698         arity = get_irn_arity(node);
1699         for (i = 0; i < arity; ++i) {
1700                 op      = get_irn_n(node, i);
1701                 op_reg  = arch_get_irn_register(op);
1702                 if (arch_register_get_class(op_reg) != &ia32_reg_classes[CLASS_ia32_vfp])
1703                         continue;
1704
1705                 reg_id = arch_register_get_index(op_reg);
1706                 live   = vfp_live_args_after(state->sim, node, 0);
1707
1708                 op_stack_idx = x87_on_stack(state, reg_id);
1709                 if (op_stack_idx >= 0 && !is_vfp_live(reg_id, live)) {
1710                         x87_create_fpop(state, sched_next(node), 1);
1711                         node_added = NODE_ADDED;
1712                 }
1713         }
1714
1715         DB((dbg, LEVEL_1, "Stack after: "));
1716         DEBUG_ONLY(x87_dump_stack(state));
1717
1718         return node_added;
1719 }
1720
1721 static void keep_float_node_alive(ir_node *node)
1722 {
1723         ir_graph                    *irg;
1724         ir_node                     *block;
1725         ir_node                     *in[1];
1726         ir_node                     *keep;
1727         const arch_register_class_t *cls;
1728
1729         irg    = get_irn_irg(node);
1730         block  = get_nodes_block(node);
1731         cls    = arch_get_irn_reg_class(node, -1);
1732         in[0]  = node;
1733         keep   = be_new_Keep(cls, irg, block, 1, in);
1734
1735         assert(sched_is_scheduled(node));
1736         sched_add_after(node, keep);
1737 }
1738
1739 /**
1740  * Create a copy of a node. Recreate the node if it's a constant.
1741  *
1742  * @param state  the x87 state
1743  * @param n      the node to be copied
1744  *
1745  * @return the copy of n
1746  */
1747 static ir_node *create_Copy(x87_state *state, ir_node *n)
1748 {
1749         ir_graph *irg = get_irn_irg(n);
1750         dbg_info *n_dbg = get_irn_dbg_info(n);
1751         ir_mode *mode = get_irn_mode(n);
1752         ir_node *block = get_nodes_block(n);
1753         ir_node *pred = get_irn_n(n, 0);
1754         ir_node *(*cnstr)(dbg_info *, ir_graph *, ir_node *, ir_mode *) = NULL;
1755         ir_node *res;
1756         const arch_register_t *out;
1757         const arch_register_t *op1;
1758         ia32_x87_attr_t *attr;
1759
1760         /* Do not copy constants, recreate them. */
1761         switch (get_ia32_irn_opcode(pred)) {
1762         case iro_ia32_Unknown_VFP:
1763         case iro_ia32_fldz:
1764                 cnstr = new_rd_ia32_fldz;
1765                 break;
1766         case iro_ia32_fld1:
1767                 cnstr = new_rd_ia32_fld1;
1768                 break;
1769         case iro_ia32_fldpi:
1770                 cnstr = new_rd_ia32_fldpi;
1771                 break;
1772         case iro_ia32_fldl2e:
1773                 cnstr = new_rd_ia32_fldl2e;
1774                 break;
1775         case iro_ia32_fldl2t:
1776                 cnstr = new_rd_ia32_fldl2t;
1777                 break;
1778         case iro_ia32_fldlg2:
1779                 cnstr = new_rd_ia32_fldlg2;
1780                 break;
1781         case iro_ia32_fldln2:
1782                 cnstr = new_rd_ia32_fldln2;
1783                 break;
1784         default:
1785                 break;
1786         }
1787
1788         out = x87_get_irn_register(n);
1789         op1 = x87_get_irn_register(pred);
1790
1791         if (cnstr != NULL) {
1792                 /* copy a constant */
1793                 res = (*cnstr)(n_dbg, irg, block, mode);
1794
1795                 x87_push(state, arch_register_get_index(out), res);
1796
1797                 attr = get_ia32_x87_attr(res);
1798                 attr->x87[2] = &ia32_st_regs[0];
1799         } else {
1800                 int op1_idx = x87_on_stack(state, arch_register_get_index(op1));
1801
1802                 res = new_rd_ia32_fpushCopy(n_dbg, irg, block, pred, mode);
1803
1804                 x87_push(state, arch_register_get_index(out), res);
1805
1806                 attr = get_ia32_x87_attr(res);
1807                 attr->x87[0] = &ia32_st_regs[op1_idx];
1808                 attr->x87[2] = &ia32_st_regs[0];
1809         }
1810         arch_set_irn_register(res, out);
1811
1812         return res;
1813 }  /* create_Copy */
1814
1815 /**
1816  * Simulate a be_Copy.
1817  *
1818  * @param state  the x87 state
1819  * @param n      the node that should be simulated (and patched)
1820  *
1821  * @return NO_NODE_ADDED
1822  */
1823 static int sim_Copy(x87_state *state, ir_node *n)
1824 {
1825         ir_node                     *pred;
1826         const arch_register_t       *out;
1827         const arch_register_t       *op1;
1828         const arch_register_class_t *cls;
1829         ir_node                     *node, *next;
1830         ia32_x87_attr_t             *attr;
1831         int                         op1_idx, out_idx;
1832         unsigned                    live;
1833
1834         cls = arch_get_irn_reg_class(n, -1);
1835         if (cls->regs != ia32_vfp_regs)
1836                 return 0;
1837
1838         pred = get_irn_n(n, 0);
1839         out  = x87_get_irn_register(n);
1840         op1  = x87_get_irn_register(pred);
1841         live = vfp_live_args_after(state->sim, n, REGMASK(out));
1842
1843         DB((dbg, LEVEL_1, ">>> %+F %s -> %s\n", n,
1844                 arch_register_get_name(op1), arch_register_get_name(out)));
1845         DEBUG_ONLY(vfp_dump_live(live));
1846
1847         /* handle the infamous unknown value */
1848         if (arch_register_get_index(op1) == REG_VFP_UKNWN) {
1849                 /* Operand is still live, a real copy. We need here an fpush that can
1850                    hold a a register, so use the fpushCopy or recreate constants */
1851                 node = create_Copy(state, n);
1852
1853                 assert(is_ia32_fldz(node));
1854                 next = sched_next(n);
1855                 sched_remove(n);
1856                 exchange(n, node);
1857                 sched_add_before(next, node);
1858
1859                 DB((dbg, LEVEL_1, "<<< %+F %s -> %s\n", node, op1->name,
1860                     arch_get_irn_register(node)->name));
1861                 return NO_NODE_ADDED;
1862         }
1863
1864         op1_idx = x87_on_stack(state, arch_register_get_index(op1));
1865
1866         if (is_vfp_live(arch_register_get_index(op1), live)) {
1867                 ir_node *pred = get_irn_n(n, 0);
1868
1869                 /* Operand is still live, a real copy. We need here an fpush that can
1870                    hold a a register, so use the fpushCopy or recreate constants */
1871                 node = create_Copy(state, n);
1872
1873                 /* We have to make sure the old value doesn't go dead (which can happen
1874                  * when we recreate constants). As the simulator expected that value in
1875                  * the pred blocks. This is unfortunate as removing it would save us 1
1876                  * instruction, but we would have to rerun all the simulation to get
1877                  * this correct...
1878                  */
1879                 next = sched_next(n);
1880                 sched_remove(n);
1881                 exchange(n, node);
1882                 sched_add_before(next, node);
1883
1884                 if (get_irn_n_edges(pred) == 0) {
1885                         keep_float_node_alive(pred);
1886                 }
1887
1888                 DB((dbg, LEVEL_1, "<<< %+F %s -> ?\n", node, op1->name));
1889         } else {
1890                 out_idx = x87_on_stack(state, arch_register_get_index(out));
1891
1892                 if (out_idx >= 0 && out_idx != op1_idx) {
1893                         /* Matze: out already on stack? how can this happen? */
1894                         assert(0);
1895
1896                         /* op1 must be killed and placed where out is */
1897                         if (out_idx == 0) {
1898                                 /* best case, simple remove and rename */
1899                                 x87_patch_insn(n, op_ia32_Pop);
1900                                 attr = get_ia32_x87_attr(n);
1901                                 attr->x87[0] = op1 = &ia32_st_regs[0];
1902
1903                                 x87_pop(state);
1904                                 x87_set_st(state, arch_register_get_index(out), n, op1_idx - 1);
1905                         } else {
1906                                 /* move op1 to tos, store and pop it */
1907                                 if (op1_idx != 0) {
1908                                         x87_create_fxch(state, n, op1_idx);
1909                                         op1_idx = 0;
1910                                 }
1911                                 x87_patch_insn(n, op_ia32_Pop);
1912                                 attr = get_ia32_x87_attr(n);
1913                                 attr->x87[0] = op1 = &ia32_st_regs[out_idx];
1914
1915                                 x87_pop(state);
1916                                 x87_set_st(state, arch_register_get_index(out), n, out_idx - 1);
1917                         }
1918                         DB((dbg, LEVEL_1, "<<< %+F %s\n", n, op1->name));
1919                 } else {
1920                         /* just a virtual copy */
1921                         x87_set_st(state, arch_register_get_index(out), get_unop_op(n), op1_idx);
1922                         /* don't remove the node to keep the verifier quiet :),
1923                            the emitter won't emit any code for the node */
1924 #if 0
1925                         sched_remove(n);
1926                         DB((dbg, LEVEL_1, "<<< KILLED %s\n", get_irn_opname(n)));
1927                         exchange(n, get_unop_op(n));
1928 #endif
1929                 }
1930         }
1931         return NO_NODE_ADDED;
1932 }  /* sim_Copy */
1933
1934 /**
1935  * Returns the result proj of the call
1936  */
1937 static ir_node *get_call_result_proj(ir_node *call)
1938 {
1939         const ir_edge_t *edge;
1940
1941         /* search the result proj */
1942         foreach_out_edge(call, edge) {
1943                 ir_node *proj = get_edge_src_irn(edge);
1944                 long pn = get_Proj_proj(proj);
1945
1946                 if (pn == pn_ia32_Call_vf0) {
1947                         return proj;
1948                 }
1949         }
1950
1951         return NULL;
1952 }  /* get_call_result_proj */
1953
1954 /**
1955  * Simulate a ia32_Call.
1956  *
1957  * @param state      the x87 state
1958  * @param n          the node that should be simulated
1959  *
1960  * @return NO_NODE_ADDED
1961  */
1962 static int sim_Call(x87_state *state, ir_node *n)
1963 {
1964         ir_type *call_tp = get_ia32_call_attr_const(n)->call_tp;
1965         ir_type *res_type;
1966         ir_mode *mode;
1967         ir_node *resproj;
1968         const arch_register_t *reg;
1969
1970         DB((dbg, LEVEL_1, ">>> %+F\n", n));
1971
1972         /* at the begin of a call the x87 state should be empty */
1973         assert(state->depth == 0 && "stack not empty before call");
1974
1975         if (get_method_n_ress(call_tp) <= 0)
1976                 goto end_call;
1977
1978         /*
1979          * If the called function returns a float, it is returned in st(0).
1980          * This even happens if the return value is NOT used.
1981          * Moreover, only one return result is supported.
1982          */
1983         res_type = get_method_res_type(call_tp, 0);
1984         mode     = get_type_mode(res_type);
1985
1986         if (mode == NULL || !mode_is_float(mode))
1987                 goto end_call;
1988
1989         resproj = get_call_result_proj(n);
1990         assert(resproj != NULL);
1991
1992         reg = x87_get_irn_register(resproj);
1993         x87_push(state, arch_register_get_index(reg), resproj);
1994
1995 end_call:
1996         DB((dbg, LEVEL_1, "Stack after: "));
1997         DEBUG_ONLY(x87_dump_stack(state));
1998
1999         return NO_NODE_ADDED;
2000 }  /* sim_Call */
2001
2002 /**
2003  * Simulate a be_Spill.
2004  *
2005  * @param state  the x87 state
2006  * @param n      the node that should be simulated (and patched)
2007  *
2008  * Should not happen, spills are lowered before x87 simulator see them.
2009  */
2010 static int sim_Spill(x87_state *state, ir_node *n)
2011 {
2012         assert(0 && "Spill not lowered");
2013         return sim_fst(state, n);
2014 }  /* sim_Spill */
2015
2016 /**
2017  * Simulate a be_Reload.
2018  *
2019  * @param state  the x87 state
2020  * @param n      the node that should be simulated (and patched)
2021  *
2022  * Should not happen, reloads are lowered before x87 simulator see them.
2023  */
2024 static int sim_Reload(x87_state *state, ir_node *n)
2025 {
2026         assert(0 && "Reload not lowered");
2027         return sim_fld(state, n);
2028 }  /* sim_Reload */
2029
2030 /**
2031  * Simulate a be_Return.
2032  *
2033  * @param state  the x87 state
2034  * @param n      the node that should be simulated (and patched)
2035  *
2036  * @return NO_NODE_ADDED
2037  */
2038 static int sim_Return(x87_state *state, ir_node *n)
2039 {
2040         int n_res = be_Return_get_n_rets(n);
2041         int i, n_float_res = 0;
2042
2043         /* only floating point return values must reside on stack */
2044         for (i = 0; i < n_res; ++i) {
2045                 ir_node *res = get_irn_n(n, be_pos_Return_val + i);
2046
2047                 if (mode_is_float(get_irn_mode(res)))
2048                         ++n_float_res;
2049         }
2050         assert(x87_get_depth(state) == n_float_res);
2051
2052         /* pop them virtually */
2053         for (i = n_float_res - 1; i >= 0; --i)
2054                 x87_pop(state);
2055
2056         return NO_NODE_ADDED;
2057 }  /* sim_Return */
2058
2059 typedef struct _perm_data_t {
2060         const arch_register_t *in;
2061         const arch_register_t *out;
2062 } perm_data_t;
2063
2064 /**
2065  * Simulate a be_Perm.
2066  *
2067  * @param state  the x87 state
2068  * @param irn    the node that should be simulated (and patched)
2069  *
2070  * @return NO_NODE_ADDED
2071  */
2072 static int sim_Perm(x87_state *state, ir_node *irn)
2073 {
2074         int             i, n;
2075         ir_node         *pred = get_irn_n(irn, 0);
2076         int             *stack_pos;
2077         const ir_edge_t *edge;
2078
2079         /* handle only floating point Perms */
2080         if (! mode_is_float(get_irn_mode(pred)))
2081                 return NO_NODE_ADDED;
2082
2083         DB((dbg, LEVEL_1, ">>> %+F\n", irn));
2084
2085         /* Perm is a pure virtual instruction on x87.
2086            All inputs must be on the FPU stack and are pairwise
2087            different from each other.
2088            So, all we need to do is to permutate the stack state. */
2089         n = get_irn_arity(irn);
2090         NEW_ARR_A(int, stack_pos, n);
2091
2092         /* collect old stack positions */
2093         for (i = 0; i < n; ++i) {
2094                 const arch_register_t *inreg = x87_get_irn_register(get_irn_n(irn, i));
2095                 int idx = x87_on_stack(state, arch_register_get_index(inreg));
2096
2097                 assert(idx >= 0 && "Perm argument not on x87 stack");
2098
2099                 stack_pos[i] = idx;
2100         }
2101         /* now do the permutation */
2102         foreach_out_edge(irn, edge) {
2103                 ir_node               *proj = get_edge_src_irn(edge);
2104                 const arch_register_t *out  = x87_get_irn_register(proj);
2105                 long                  num   = get_Proj_proj(proj);
2106
2107                 assert(0 <= num && num < n && "More Proj's than Perm inputs");
2108                 x87_set_st(state, arch_register_get_index(out), proj, stack_pos[(unsigned)num]);
2109         }
2110         DB((dbg, LEVEL_1, "<<< %+F\n", irn));
2111
2112         return NO_NODE_ADDED;
2113 }  /* sim_Perm */
2114
2115 static int sim_Barrier(x87_state *state, ir_node *node)
2116 {
2117         //const arch_env_t *arch_env = state->sim->arch_env;
2118         int i, arity;
2119
2120         /* materialize unknown if needed */
2121         arity = get_irn_arity(node);
2122         for (i = 0; i < arity; ++i) {
2123                 const arch_register_t       *reg;
2124                 ir_node                     *zero;
2125                 ir_node                     *block;
2126                 ia32_x87_attr_t             *attr;
2127                 ir_node                     *in    = get_irn_n(node, i);
2128
2129                 if (!is_ia32_Unknown_VFP(in))
2130                         continue;
2131
2132                 /* TODO: not completely correct... */
2133                 reg = &ia32_vfp_regs[REG_VFP_UKNWN];
2134
2135                 /* create a zero */
2136                 block = get_nodes_block(node);
2137                 zero  = new_rd_ia32_fldz(NULL, current_ir_graph, block, mode_E);
2138                 x87_push(state, arch_register_get_index(reg), zero);
2139
2140                 attr = get_ia32_x87_attr(zero);
2141                 attr->x87[2] = &ia32_st_regs[0];
2142
2143                 sched_add_before(node, zero);
2144
2145                 set_irn_n(node, i, zero);
2146         }
2147
2148         return NO_NODE_ADDED;
2149 }
2150
2151
2152 /**
2153  * Kill any dead registers at block start by popping them from the stack.
2154  *
2155  * @param sim          the simulator handle
2156  * @param block        the current block
2157  * @param start_state  the x87 state at the begin of the block
2158  *
2159  * @return the x87 state after dead register killed
2160  */
2161 static x87_state *x87_kill_deads(x87_simulator *sim, ir_node *block, x87_state *start_state)
2162 {
2163         x87_state *state = start_state;
2164         ir_node *first_insn = sched_first(block);
2165         ir_node *keep = NULL;
2166         unsigned live = vfp_live_args_after(sim, block, 0);
2167         unsigned kill_mask;
2168         int i, depth, num_pop;
2169
2170         kill_mask = 0;
2171         depth = x87_get_depth(state);
2172         for (i = depth - 1; i >= 0; --i) {
2173                 int reg = x87_get_st_reg(state, i);
2174
2175                 if (! is_vfp_live(reg, live))
2176                         kill_mask |= (1 << i);
2177         }
2178
2179         if (kill_mask) {
2180                 /* create a new state, will be changed */
2181                 state = x87_clone_state(sim, state);
2182
2183                 DB((dbg, LEVEL_1, "Killing deads:\n"));
2184                 DEBUG_ONLY(vfp_dump_live(live));
2185                 DEBUG_ONLY(x87_dump_stack(state));
2186
2187                 if (kill_mask != 0 && live == 0) {
2188                         /* special case: kill all registers */
2189                         if (ia32_cg_config.use_femms || ia32_cg_config.use_emms) {
2190                                 if (ia32_cg_config.use_femms) {
2191                                         /* use FEMMS on AMD processors to clear all */
2192                                         keep = new_rd_ia32_femms(NULL, get_irn_irg(block), block);
2193                                 } else {
2194                                         /* use EMMS to clear all */
2195                                         keep = new_rd_ia32_emms(NULL, get_irn_irg(block), block);
2196                                 }
2197                                 sched_add_before(first_insn, keep);
2198                                 keep_alive(keep);
2199                                 x87_emms(state);
2200                                 return state;
2201                         }
2202                 }
2203                 /* now kill registers */
2204                 while (kill_mask) {
2205                         /* we can only kill from TOS, so bring them up */
2206                         if (! (kill_mask & 1)) {
2207                                 /* search from behind, because we can to a double-pop */
2208                                 for (i = depth - 1; i >= 0; --i) {
2209                                         if (kill_mask & (1 << i)) {
2210                                                 kill_mask &= ~(1 << i);
2211                                                 kill_mask |= 1;
2212                                                 break;
2213                                         }
2214                                 }
2215
2216                                 if (keep)
2217                                         x87_set_st(state, -1, keep, i);
2218                                 x87_create_fxch(state, first_insn, i);
2219                         }
2220
2221                         if ((kill_mask & 3) == 3) {
2222                                 /* we can do a double-pop */
2223                                 num_pop = 2;
2224                         }
2225                         else {
2226                                 /* only a single pop */
2227                                 num_pop = 1;
2228                         }
2229
2230                         depth -= num_pop;
2231                         kill_mask >>= num_pop;
2232                         keep = x87_create_fpop(state, first_insn, num_pop);
2233                 }
2234                 keep_alive(keep);
2235         }
2236         return state;
2237 }  /* x87_kill_deads */
2238
2239 /**
2240  * If we have PhiEs with unknown operands then we have to make sure that some
2241  * value is actually put onto the stack.
2242  */
2243 static void fix_unknown_phis(x87_state *state, ir_node *block,
2244                              ir_node *pred_block, int pos)
2245 {
2246         ir_node *node, *op;
2247
2248         sched_foreach(block, node) {
2249                 ir_node               *zero;
2250                 const arch_register_t *reg;
2251                 ia32_x87_attr_t       *attr;
2252
2253                 if (!is_Phi(node))
2254                         break;
2255
2256                 op = get_Phi_pred(node, pos);
2257                 if (!is_ia32_Unknown_VFP(op))
2258                         continue;
2259
2260                 reg = arch_get_irn_register(node);
2261
2262                 /* create a zero at end of pred block */
2263                 zero = new_rd_ia32_fldz(NULL, current_ir_graph, pred_block, mode_E);
2264                 x87_push(state, arch_register_get_index(reg), zero);
2265
2266                 attr = get_ia32_x87_attr(zero);
2267                 attr->x87[2] = &ia32_st_regs[0];
2268
2269                 assert(is_ia32_fldz(zero));
2270                 sched_add_before(sched_last(pred_block), zero);
2271
2272                 set_Phi_pred(node, pos, zero);
2273         }
2274 }
2275
2276 /**
2277  * Run a simulation and fix all virtual instructions for a block.
2278  *
2279  * @param sim          the simulator handle
2280  * @param block        the current block
2281  */
2282 static void x87_simulate_block(x87_simulator *sim, ir_node *block)
2283 {
2284         ir_node *n, *next;
2285         blk_state *bl_state = x87_get_bl_state(sim, block);
2286         x87_state *state = bl_state->begin;
2287         const ir_edge_t *edge;
2288         ir_node *start_block;
2289
2290         assert(state != NULL);
2291         /* already processed? */
2292         if (bl_state->end != NULL)
2293                 return;
2294
2295         DB((dbg, LEVEL_1, "Simulate %+F\n", block));
2296         DB((dbg, LEVEL_2, "State at Block begin:\n "));
2297         DEBUG_ONLY(x87_dump_stack(state));
2298
2299         /* at block begin, kill all dead registers */
2300         state = x87_kill_deads(sim, block, state);
2301         /* create a new state, will be changed */
2302         state = x87_clone_state(sim, state);
2303
2304         /* beware, n might change */
2305         for (n = sched_first(block); !sched_is_end(n); n = next) {
2306                 int node_inserted;
2307                 sim_func func;
2308                 ir_op *op = get_irn_op(n);
2309
2310                 next = sched_next(n);
2311                 if (op->ops.generic == NULL)
2312                         continue;
2313
2314                 func = (sim_func)op->ops.generic;
2315
2316                 /* simulate it */
2317                 node_inserted = (*func)(state, n);
2318
2319                 /*
2320                         sim_func might have added an additional node after n,
2321                         so update next node
2322                         beware: n must not be changed by sim_func
2323                         (i.e. removed from schedule) in this case
2324                 */
2325                 if (node_inserted != NO_NODE_ADDED)
2326                         next = sched_next(n);
2327         }
2328
2329         start_block = get_irg_start_block(get_irn_irg(block));
2330
2331         DB((dbg, LEVEL_2, "State at Block end:\n ")); DEBUG_ONLY(x87_dump_stack(state));
2332
2333         /* check if the state must be shuffled */
2334         foreach_block_succ(block, edge) {
2335                 ir_node *succ = get_edge_src_irn(edge);
2336                 blk_state *succ_state;
2337
2338                 if (succ == start_block)
2339                         continue;
2340
2341                 succ_state = x87_get_bl_state(sim, succ);
2342
2343                 fix_unknown_phis(state, succ, block, get_edge_src_pos(edge));
2344
2345                 if (succ_state->begin == NULL) {
2346                         DB((dbg, LEVEL_2, "Set begin state for succ %+F:\n", succ));
2347                         DEBUG_ONLY(x87_dump_stack(state));
2348                         succ_state->begin = state;
2349
2350                         waitq_put(sim->worklist, succ);
2351                 } else {
2352                         DB((dbg, LEVEL_2, "succ %+F already has a state, shuffling\n", succ));
2353                         /* There is already a begin state for the successor, bad.
2354                            Do the necessary permutations.
2355                            Note that critical edges are removed, so this is always possible:
2356                            If the successor has more than one possible input, then it must
2357                            be the only one.
2358                          */
2359                         x87_shuffle(sim, block, state, succ, succ_state->begin);
2360                 }
2361         }
2362         bl_state->end = state;
2363 }  /* x87_simulate_block */
2364
2365 static void register_sim(ir_op *op, sim_func func)
2366 {
2367         assert(op->ops.generic == NULL);
2368         op->ops.generic = (op_func) func;
2369 }
2370
2371 /**
2372  * Create a new x87 simulator.
2373  *
2374  * @param sim       a simulator handle, will be initialized
2375  * @param irg       the current graph
2376  * @param arch_env  the architecture environment
2377  */
2378 static void x87_init_simulator(x87_simulator *sim, ir_graph *irg,
2379                                const arch_env_t *arch_env)
2380 {
2381         obstack_init(&sim->obst);
2382         sim->blk_states = pmap_create();
2383         sim->arch_env   = arch_env;
2384         sim->n_idx      = get_irg_last_idx(irg);
2385         sim->live       = obstack_alloc(&sim->obst, sizeof(*sim->live) * sim->n_idx);
2386
2387         DB((dbg, LEVEL_1, "--------------------------------\n"
2388                 "x87 Simulator started for %+F\n", irg));
2389
2390         /* set the generic function pointer of instruction we must simulate */
2391         clear_irp_opcodes_generic_func();
2392
2393         register_sim(op_ia32_Call,         sim_Call);
2394         register_sim(op_ia32_vfld,         sim_fld);
2395         register_sim(op_ia32_vfild,        sim_fild);
2396         register_sim(op_ia32_vfld1,        sim_fld1);
2397         register_sim(op_ia32_vfldz,        sim_fldz);
2398         register_sim(op_ia32_vfadd,        sim_fadd);
2399         register_sim(op_ia32_vfsub,        sim_fsub);
2400         register_sim(op_ia32_vfmul,        sim_fmul);
2401         register_sim(op_ia32_vfdiv,        sim_fdiv);
2402         register_sim(op_ia32_vfprem,       sim_fprem);
2403         register_sim(op_ia32_vfabs,        sim_fabs);
2404         register_sim(op_ia32_vfchs,        sim_fchs);
2405         register_sim(op_ia32_vfist,        sim_fist);
2406         register_sim(op_ia32_vfisttp,      sim_fisttp);
2407         register_sim(op_ia32_vfst,         sim_fst);
2408         register_sim(op_ia32_vFtstFnstsw,  sim_FtstFnstsw);
2409         register_sim(op_ia32_vFucomFnstsw, sim_Fucom);
2410         register_sim(op_ia32_vFucomi,      sim_Fucom);
2411         register_sim(op_be_Copy,           sim_Copy);
2412         register_sim(op_be_Spill,          sim_Spill);
2413         register_sim(op_be_Reload,         sim_Reload);
2414         register_sim(op_be_Return,         sim_Return);
2415         register_sim(op_be_Perm,           sim_Perm);
2416         register_sim(op_be_Keep,           sim_Keep);
2417         register_sim(op_be_Barrier,        sim_Barrier);
2418 }  /* x87_init_simulator */
2419
2420 /**
2421  * Destroy a x87 simulator.
2422  *
2423  * @param sim  the simulator handle
2424  */
2425 static void x87_destroy_simulator(x87_simulator *sim)
2426 {
2427         pmap_destroy(sim->blk_states);
2428         obstack_free(&sim->obst, NULL);
2429         DB((dbg, LEVEL_1, "x87 Simulator stopped\n\n"));
2430 }  /* x87_destroy_simulator */
2431
2432 /**
2433  * Pre-block walker: calculate the liveness information for the block
2434  * and store it into the sim->live cache.
2435  */
2436 static void update_liveness_walker(ir_node *block, void *data)
2437 {
2438         x87_simulator *sim = data;
2439         update_liveness(sim, block);
2440 }  /* update_liveness_walker */
2441
2442 /**
2443  * Run a simulation and fix all virtual instructions for a graph.
2444  *
2445  * @param env       the architecture environment
2446  * @param irg       the current graph
2447  *
2448  * Needs a block-schedule.
2449  */
2450 void x87_simulate_graph(const arch_env_t *arch_env, be_irg_t *birg)
2451 {
2452         ir_node       *block, *start_block;
2453         blk_state     *bl_state;
2454         x87_simulator sim;
2455         ir_graph      *irg = be_get_birg_irg(birg);
2456
2457         /* create the simulator */
2458         x87_init_simulator(&sim, irg, arch_env);
2459
2460         start_block = get_irg_start_block(irg);
2461         bl_state    = x87_get_bl_state(&sim, start_block);
2462
2463         /* start with the empty state */
2464         bl_state->begin = empty;
2465         empty->sim      = &sim;
2466
2467         sim.worklist = new_waitq();
2468         waitq_put(sim.worklist, start_block);
2469
2470         be_assure_liveness(birg);
2471         sim.lv = be_get_birg_liveness(birg);
2472 //      sim.lv = be_liveness(be_get_birg_irg(birg));
2473         be_liveness_assure_sets(sim.lv);
2474
2475         /* Calculate the liveness for all nodes. We must precalculate this info,
2476          * because the simulator adds new nodes (possible before Phi nodes) which
2477          * would let a lazy calculation fail.
2478          * On the other hand we reduce the computation amount due to
2479          * precaching from O(n^2) to O(n) at the expense of O(n) cache memory.
2480          */
2481         irg_block_walk_graph(irg, update_liveness_walker, NULL, &sim);
2482
2483         /* iterate */
2484         do {
2485                 block = waitq_get(sim.worklist);
2486                 x87_simulate_block(&sim, block);
2487         } while (! waitq_empty(sim.worklist));
2488
2489         /* kill it */
2490         del_waitq(sim.worklist);
2491         x87_destroy_simulator(&sim);
2492 }  /* x87_simulate_graph */
2493
2494 void ia32_init_x87(void)
2495 {
2496         FIRM_DBG_REGISTER(dbg, "firm.be.ia32.x87");
2497 }  /* ia32_init_x87 */