x87: Enable x87_create_fpop() to remove entries other than just the tos.
[libfirm] / ir / be / ia32 / ia32_x87.c
1 /*
2  * Copyright (C) 1995-2010 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  */
26 #include "config.h"
27
28 #include <assert.h>
29
30 #include "irnode_t.h"
31 #include "irop_t.h"
32 #include "irprog.h"
33 #include "iredges_t.h"
34 #include "irgmod.h"
35 #include "ircons.h"
36 #include "irgwalk.h"
37 #include "obst.h"
38 #include "pmap.h"
39 #include "array_t.h"
40 #include "pdeq.h"
41 #include "irprintf.h"
42 #include "debug.h"
43 #include "error.h"
44
45 #include "belive_t.h"
46 #include "besched.h"
47 #include "benode.h"
48 #include "bearch_ia32_t.h"
49 #include "ia32_new_nodes.h"
50 #include "gen_ia32_new_nodes.h"
51 #include "gen_ia32_regalloc_if.h"
52 #include "ia32_x87.h"
53 #include "ia32_architecture.h"
54
55 /** the debug handle */
56 DEBUG_ONLY(static firm_dbg_module_t *dbg = NULL;)
57
58 /* Forward declaration. */
59 typedef struct x87_simulator x87_simulator;
60
61 /**
62  * An entry on the simulated x87 stack.
63  */
64 typedef struct st_entry {
65         int      reg_idx; /**< the virtual register index of this stack value */
66         ir_node *node;    /**< the node that produced this value */
67 } st_entry;
68
69 /**
70  * The x87 state.
71  */
72 typedef struct x87_state {
73         st_entry       st[N_ia32_st_REGS]; /**< the register stack */
74         int            depth;              /**< the current stack depth */
75         x87_simulator *sim;                /**< The simulator. */
76 } x87_state;
77
78 /** An empty state, used for blocks without fp instructions. */
79 static x87_state empty = { { {0, NULL}, }, 0, NULL };
80
81 /**
82  * Return values of the instruction simulator functions.
83  */
84 enum {
85         NO_NODE_ADDED = 0,  /**< No node that needs simulation was added. */
86         NODE_ADDED    = 1   /**< A node that must be simulated was added by the simulator
87                                  in the schedule AFTER the current node. */
88 };
89
90 /**
91  * The type of an instruction simulator function.
92  *
93  * @param state  the x87 state
94  * @param n      the node to be simulated
95  *
96  * @return NODE_ADDED    if a node was added AFTER n in schedule that MUST be
97  *                       simulated further
98  *         NO_NODE_ADDED otherwise
99  */
100 typedef int (*sim_func)(x87_state *state, ir_node *n);
101
102 /**
103  * A block state: Every block has a x87 state at the beginning and at the end.
104  */
105 typedef struct blk_state {
106         x87_state *begin;   /**< state at the begin or NULL if not assigned */
107         x87_state *end;     /**< state at the end or NULL if not assigned */
108 } blk_state;
109
110 /** liveness bitset for vfp registers. */
111 typedef unsigned char vfp_liveness;
112
113 /**
114  * The x87 simulator.
115  */
116 struct x87_simulator {
117         struct obstack obst;       /**< An obstack for fast allocating. */
118         pmap          *blk_states; /**< Map blocks to states. */
119         be_lv_t       *lv;         /**< intrablock liveness. */
120         vfp_liveness  *live;       /**< Liveness information. */
121         unsigned       n_idx;      /**< The cached get_irg_last_idx() result. */
122         waitq         *worklist;   /**< Worklist of blocks that must be processed. */
123 };
124
125 /**
126  * Returns the current stack depth.
127  *
128  * @param state  the x87 state
129  *
130  * @return the x87 stack depth
131  */
132 static int x87_get_depth(const x87_state *state)
133 {
134         return state->depth;
135 }
136
137 static st_entry *x87_get_entry(x87_state *const state, int const pos)
138 {
139         assert(0 <= pos && pos < state->depth);
140         return &state->st[N_ia32_st_REGS - state->depth + pos];
141 }
142
143 /**
144  * Return the virtual register index at st(pos).
145  *
146  * @param state  the x87 state
147  * @param pos    a stack position
148  *
149  * @return the vfp register index that produced the value at st(pos)
150  */
151 static int x87_get_st_reg(const x87_state *state, int pos)
152 {
153         return x87_get_entry((x87_state*)state, pos)->reg_idx;
154 }
155
156 #ifdef DEBUG_libfirm
157 /**
158  * Dump the stack for debugging.
159  *
160  * @param state  the x87 state
161  */
162 static void x87_dump_stack(const x87_state *state)
163 {
164         for (int i = state->depth; i-- != 0;) {
165                 st_entry const *const entry = x87_get_entry((x87_state*)state, i);
166                 DB((dbg, LEVEL_2, "vf%d(%+F) ", entry->reg_idx, entry->node));
167         }
168         DB((dbg, LEVEL_2, "<-- TOS\n"));
169 }
170 #endif /* DEBUG_libfirm */
171
172 /**
173  * Set a virtual register to st(pos).
174  *
175  * @param state    the x87 state
176  * @param reg_idx  the vfp register index that should be set
177  * @param node     the IR node that produces the value of the vfp register
178  * @param pos      the stack position where the new value should be entered
179  */
180 static void x87_set_st(x87_state *state, int reg_idx, ir_node *node, int pos)
181 {
182         st_entry *const entry = x87_get_entry(state, pos);
183         entry->reg_idx = reg_idx;
184         entry->node    = node;
185
186         DB((dbg, LEVEL_2, "After SET_REG: "));
187         DEBUG_ONLY(x87_dump_stack(state);)
188 }
189
190 /**
191  * Swap st(0) with st(pos).
192  *
193  * @param state    the x87 state
194  * @param pos      the stack position to change the tos with
195  */
196 static void x87_fxch(x87_state *state, int pos)
197 {
198         st_entry *const a = x87_get_entry(state, pos);
199         st_entry *const b = x87_get_entry(state, 0);
200         st_entry  const t = *a;
201         *a = *b;
202         *b = t;
203
204         DB((dbg, LEVEL_2, "After FXCH: "));
205         DEBUG_ONLY(x87_dump_stack(state);)
206 }
207
208 /**
209  * Convert a virtual register to the stack index.
210  *
211  * @param state    the x87 state
212  * @param reg_idx  the register vfp index
213  *
214  * @return the stack position where the register is stacked
215  *         or -1 if the virtual register was not found
216  */
217 static int x87_on_stack(const x87_state *state, int reg_idx)
218 {
219         for (int i = 0; i < state->depth; ++i) {
220                 if (x87_get_st_reg(state, i) == reg_idx)
221                         return i;
222         }
223         return -1;
224 }
225
226 /**
227  * Push a virtual Register onto the stack, double pushes are NOT allowed.
228  *
229  * @param state     the x87 state
230  * @param reg_idx   the register vfp index
231  * @param node      the node that produces the value of the vfp register
232  */
233 static void x87_push(x87_state *state, int reg_idx, ir_node *node)
234 {
235         assert(x87_on_stack(state, reg_idx) == -1 && "double push");
236         assert(state->depth < N_ia32_st_REGS && "stack overrun");
237
238         ++state->depth;
239         st_entry *const entry = x87_get_entry(state, 0);
240         entry->reg_idx = reg_idx;
241         entry->node    = node;
242
243         DB((dbg, LEVEL_2, "After PUSH: ")); DEBUG_ONLY(x87_dump_stack(state);)
244 }
245
246 /**
247  * Pop a virtual Register from the stack.
248  *
249  * @param state     the x87 state
250  */
251 static void x87_pop(x87_state *state)
252 {
253         assert(state->depth > 0 && "stack underrun");
254
255         --state->depth;
256
257         DB((dbg, LEVEL_2, "After POP: ")); DEBUG_ONLY(x87_dump_stack(state);)
258 }
259
260 /**
261  * Empty the fpu stack
262  *
263  * @param state     the x87 state
264  */
265 static void x87_emms(x87_state *state)
266 {
267         state->depth = 0;
268 }
269
270 /**
271  * Returns the block state of a block.
272  *
273  * @param sim    the x87 simulator handle
274  * @param block  the current block
275  *
276  * @return the block state
277  */
278 static blk_state *x87_get_bl_state(x87_simulator *sim, ir_node *block)
279 {
280         blk_state *res = pmap_get(blk_state, sim->blk_states, block);
281
282         if (res == NULL) {
283                 res = OALLOC(&sim->obst, blk_state);
284                 res->begin = NULL;
285                 res->end   = NULL;
286
287                 pmap_insert(sim->blk_states, block, res);
288         }
289
290         return res;
291 }
292
293 /**
294  * Clone a x87 state.
295  *
296  * @param sim    the x87 simulator handle
297  * @param src    the x87 state that will be cloned
298  *
299  * @return a cloned copy of the src state
300  */
301 static x87_state *x87_clone_state(x87_simulator *sim, const x87_state *src)
302 {
303         x87_state *const res = OALLOC(&sim->obst, x87_state);
304         *res = *src;
305         return res;
306 }
307
308 /**
309  * Patch a virtual instruction into a x87 one and return
310  * the node representing the result value.
311  *
312  * @param n   the IR node to patch
313  * @param op  the x87 opcode to patch in
314  */
315 static ir_node *x87_patch_insn(ir_node *n, ir_op *op)
316 {
317         ir_mode *mode = get_irn_mode(n);
318         ir_node *res = n;
319
320         set_irn_op(n, op);
321
322         if (mode == mode_T) {
323                 /* patch all Proj's */
324                 foreach_out_edge(n, edge) {
325                         ir_node *proj = get_edge_src_irn(edge);
326                         if (is_Proj(proj)) {
327                                 mode = get_irn_mode(proj);
328                                 if (mode_is_float(mode)) {
329                                         res = proj;
330                                         set_irn_mode(proj, ia32_reg_classes[CLASS_ia32_st].mode);
331                                 }
332                         }
333                 }
334         } else if (mode_is_float(mode))
335                 set_irn_mode(n, ia32_reg_classes[CLASS_ia32_st].mode);
336         return res;
337 }
338
339 /**
340  * Returns the first Proj of a mode_T node having a given mode.
341  *
342  * @param n  the mode_T node
343  * @param m  the desired mode of the Proj
344  * @return The first Proj of mode @p m found.
345  */
346 static ir_node *get_irn_Proj_for_mode(ir_node *n, ir_mode *m)
347 {
348         assert(get_irn_mode(n) == mode_T && "Need mode_T node");
349
350         foreach_out_edge(n, edge) {
351                 ir_node *proj = get_edge_src_irn(edge);
352                 if (get_irn_mode(proj) == m)
353                         return proj;
354         }
355
356         panic("Proj not found");
357 }
358
359 /**
360  * Wrap the arch_* function here so we can check for errors.
361  */
362 static inline const arch_register_t *x87_get_irn_register(const ir_node *irn)
363 {
364         const arch_register_t *res = arch_get_irn_register(irn);
365
366         assert(res->reg_class == &ia32_reg_classes[CLASS_ia32_vfp]);
367         return res;
368 }
369
370 static inline const arch_register_t *x87_irn_get_register(const ir_node *irn,
371                                                           int pos)
372 {
373         const arch_register_t *res = arch_get_irn_register_out(irn, pos);
374
375         assert(res->reg_class == &ia32_reg_classes[CLASS_ia32_vfp]);
376         return res;
377 }
378
379 static inline const arch_register_t *get_st_reg(int index)
380 {
381         return &ia32_registers[REG_ST0 + index];
382 }
383
384 /**
385  * Create a fxch node before another node.
386  *
387  * @param state   the x87 state
388  * @param n       the node after the fxch
389  * @param pos     exchange st(pos) with st(0)
390  */
391 static void x87_create_fxch(x87_state *state, ir_node *n, int pos)
392 {
393         x87_fxch(state, pos);
394
395         ir_node         *const block = get_nodes_block(n);
396         ir_node         *const fxch  = new_bd_ia32_fxch(NULL, block);
397         ia32_x87_attr_t *const attr  = get_ia32_x87_attr(fxch);
398         attr->reg = get_st_reg(pos);
399
400         keep_alive(fxch);
401
402         sched_add_before(n, fxch);
403         DB((dbg, LEVEL_1, "<<< %s %s\n", get_irn_opname(fxch), attr->reg->name));
404 }
405
406 /* -------------- x87 perm --------------- */
407
408 /**
409  * Calculate the necessary permutations to reach dst_state.
410  *
411  * These permutations are done with fxch instructions and placed
412  * at the end of the block.
413  *
414  * Note that critical edges are removed here, so we need only
415  * a shuffle if the current block has only one successor.
416  *
417  * @param block      the current block
418  * @param state      the current x87 stack state, might be modified
419  * @param dst_state  destination state
420  *
421  * @return state
422  */
423 static x87_state *x87_shuffle(ir_node *block, x87_state *state, const x87_state *dst_state)
424 {
425         int      i, n_cycles, k, ri;
426         unsigned cycles[4], all_mask;
427         char     cycle_idx[4][8];
428
429         assert(state->depth == dst_state->depth);
430
431         /* Some mathematics here:
432          * If we have a cycle of length n that includes the tos,
433          * we need n-1 exchange operations.
434          * We can always add the tos and restore it, so we need
435          * n+1 exchange operations for a cycle not containing the tos.
436          * So, the maximum of needed operations is for a cycle of 7
437          * not including the tos == 8.
438          * This is the same number of ops we would need for using stores,
439          * so exchange is cheaper (we save the loads).
440          * On the other hand, we might need an additional exchange
441          * in the next block to bring one operand on top, so the
442          * number of ops in the first case is identical.
443          * Further, no more than 4 cycles can exists (4 x 2). */
444         all_mask = (1 << (state->depth)) - 1;
445
446         for (n_cycles = 0; all_mask; ++n_cycles) {
447                 int src_idx, dst_idx;
448
449                 /* find the first free slot */
450                 for (i = 0; i < state->depth; ++i) {
451                         if (all_mask & (1 << i)) {
452                                 all_mask &= ~(1 << i);
453
454                                 /* check if there are differences here */
455                                 if (x87_get_st_reg(state, i) != x87_get_st_reg(dst_state, i))
456                                         break;
457                         }
458                 }
459
460                 if (! all_mask) {
461                         /* no more cycles found */
462                         break;
463                 }
464
465                 k = 0;
466                 cycles[n_cycles] = (1 << i);
467                 cycle_idx[n_cycles][k++] = i;
468                 for (src_idx = i; ; src_idx = dst_idx) {
469                         dst_idx = x87_on_stack(dst_state, x87_get_st_reg(state, src_idx));
470
471                         if ((all_mask & (1 << dst_idx)) == 0)
472                                 break;
473
474                         cycle_idx[n_cycles][k++] = dst_idx;
475                         cycles[n_cycles] |=  (1 << dst_idx);
476                         all_mask       &= ~(1 << dst_idx);
477                 }
478                 cycle_idx[n_cycles][k] = -1;
479         }
480
481         if (n_cycles <= 0) {
482                 /* no permutation needed */
483                 return state;
484         }
485
486         /* Hmm: permutation needed */
487         DB((dbg, LEVEL_2, "\n%+F needs permutation: from\n", block));
488         DEBUG_ONLY(x87_dump_stack(state);)
489         DB((dbg, LEVEL_2, "                  to\n"));
490         DEBUG_ONLY(x87_dump_stack(dst_state);)
491
492
493 #ifdef DEBUG_libfirm
494         DB((dbg, LEVEL_2, "Need %d cycles\n", n_cycles));
495         for (ri = 0; ri < n_cycles; ++ri) {
496                 DB((dbg, LEVEL_2, " Ring %d:\n ", ri));
497                 for (k = 0; cycle_idx[ri][k] != -1; ++k)
498                         DB((dbg, LEVEL_2, " st%d ->", cycle_idx[ri][k]));
499                 DB((dbg, LEVEL_2, "\n"));
500         }
501 #endif
502
503         /*
504          * Find the place node must be insert.
505          * We have only one successor block, so the last instruction should
506          * be a jump.
507          */
508         ir_node *const before = sched_last(block);
509         assert(is_cfop(before));
510
511         /* now do the permutations */
512         for (ri = 0; ri < n_cycles; ++ri) {
513                 if ((cycles[ri] & 1) == 0) {
514                         /* this cycle does not include the tos */
515                         x87_create_fxch(state, before, cycle_idx[ri][0]);
516                 }
517                 for (k = 1; cycle_idx[ri][k] != -1; ++k) {
518                         x87_create_fxch(state, before, cycle_idx[ri][k]);
519                 }
520                 if ((cycles[ri] & 1) == 0) {
521                         /* this cycle does not include the tos */
522                         x87_create_fxch(state, before, cycle_idx[ri][0]);
523                 }
524         }
525         return state;
526 }
527
528 /**
529  * Create a fpush before node n.
530  *
531  * @param state     the x87 state
532  * @param n         the node after the fpush
533  * @param pos       push st(pos) on stack
534  * @param val       the value to push
535  */
536 static void x87_create_fpush(x87_state *state, ir_node *n, int pos, int const out_reg_idx, ir_node *const val)
537 {
538         x87_push(state, out_reg_idx, val);
539
540         ir_node         *const fpush = new_bd_ia32_fpush(NULL, get_nodes_block(n));
541         ia32_x87_attr_t *const attr  = get_ia32_x87_attr(fpush);
542         attr->reg = get_st_reg(pos);
543
544         keep_alive(fpush);
545         sched_add_before(n, fpush);
546
547         DB((dbg, LEVEL_1, "<<< %s %s\n", get_irn_opname(fpush), attr->reg->name));
548 }
549
550 /**
551  * Create a fpop before node n.
552  * This overwrites st(pos) with st(0) and pops st(0).
553  *
554  * @param state   the x87 state
555  * @param n       the node after the fpop
556  * @param pos     the index of the entry to remove the register stack
557  *
558  * @return the fpop node
559  */
560 static ir_node *x87_create_fpop(x87_state *const state, ir_node *const n, int const pos)
561 {
562         if (pos != 0) {
563                 st_entry *const dst = x87_get_entry(state, pos);
564                 st_entry *const src = x87_get_entry(state, 0);
565                 *dst = *src;
566         }
567         x87_pop(state);
568         ir_node *const block = get_nodes_block(n);
569         ir_node *const fpop  = pos == 0 && ia32_cg_config.use_ffreep ?
570                 new_bd_ia32_ffreep(NULL, block) :
571                 new_bd_ia32_fpop(  NULL, block);
572         ia32_x87_attr_t *const attr = get_ia32_x87_attr(fpop);
573         attr->reg = get_st_reg(pos);
574
575         keep_alive(fpop);
576         sched_add_before(n, fpop);
577         DB((dbg, LEVEL_1, "<<< %s %s\n", get_irn_opname(fpop), attr->reg->name));
578         return fpop;
579 }
580
581 /* --------------------------------- liveness ------------------------------------------ */
582
583 /**
584  * The liveness transfer function.
585  * Updates a live set over a single step from a given node to its predecessor.
586  * Everything defined at the node is removed from the set, the uses of the node get inserted.
587  *
588  * @param irn      The node at which liveness should be computed.
589  * @param live     The bitset of registers live before @p irn. This set gets modified by updating it to
590  *                 the registers live after irn.
591  *
592  * @return The live bitset.
593  */
594 static vfp_liveness vfp_liveness_transfer(ir_node *irn, vfp_liveness live)
595 {
596         int i, n;
597         const arch_register_class_t *cls = &ia32_reg_classes[CLASS_ia32_vfp];
598
599         if (get_irn_mode(irn) == mode_T) {
600                 foreach_out_edge(irn, edge) {
601                         ir_node *proj = get_edge_src_irn(edge);
602
603                         if (arch_irn_consider_in_reg_alloc(cls, proj)) {
604                                 const arch_register_t *reg = x87_get_irn_register(proj);
605                                 live &= ~(1 << reg->index);
606                         }
607                 }
608         } else if (arch_irn_consider_in_reg_alloc(cls, irn)) {
609                 const arch_register_t *reg = x87_get_irn_register(irn);
610                 live &= ~(1 << reg->index);
611         }
612
613         for (i = 0, n = get_irn_arity(irn); i < n; ++i) {
614                 ir_node *op = get_irn_n(irn, i);
615
616                 if (mode_is_float(get_irn_mode(op)) &&
617                                 arch_irn_consider_in_reg_alloc(cls, op)) {
618                         const arch_register_t *reg = x87_get_irn_register(op);
619                         live |= 1 << reg->index;
620                 }
621         }
622         return live;
623 }
624
625 /**
626  * Put all live virtual registers at the end of a block into a bitset.
627  *
628  * @param sim      the simulator handle
629  * @param bl       the block
630  *
631  * @return The live bitset at the end of this block
632  */
633 static vfp_liveness vfp_liveness_end_of_block(x87_simulator *sim, const ir_node *block)
634 {
635         vfp_liveness live = 0;
636         const arch_register_class_t *cls = &ia32_reg_classes[CLASS_ia32_vfp];
637         const be_lv_t *lv = sim->lv;
638
639         be_lv_foreach(lv, block, be_lv_state_end, node) {
640                 const arch_register_t *reg;
641                 if (!arch_irn_consider_in_reg_alloc(cls, node))
642                         continue;
643
644                 reg = x87_get_irn_register(node);
645                 live |= 1 << reg->index;
646         }
647
648         return live;
649 }
650
651 /** get the register mask from an arch_register */
652 #define REGMASK(reg)    (1 << (reg->index))
653
654 /**
655  * Return a bitset of argument registers which are live at the end of a node.
656  *
657  * @param sim    the simulator handle
658  * @param pos    the node
659  * @param kill   kill mask for the output registers
660  *
661  * @return The live bitset.
662  */
663 static unsigned vfp_live_args_after(x87_simulator *sim, const ir_node *pos, unsigned kill)
664 {
665         unsigned idx = get_irn_idx(pos);
666
667         assert(idx < sim->n_idx);
668         return sim->live[idx] & ~kill;
669 }
670
671 /**
672  * Calculate the liveness for a whole block and cache it.
673  *
674  * @param sim   the simulator handle
675  * @param block the block
676  */
677 static void update_liveness(x87_simulator *sim, ir_node *block)
678 {
679         vfp_liveness live = vfp_liveness_end_of_block(sim, block);
680         unsigned idx;
681
682         /* now iterate through the block backward and cache the results */
683         sched_foreach_reverse(block, irn) {
684                 /* stop at the first Phi: this produces the live-in */
685                 if (is_Phi(irn))
686                         break;
687
688                 idx = get_irn_idx(irn);
689                 sim->live[idx] = live;
690
691                 live = vfp_liveness_transfer(irn, live);
692         }
693         idx = get_irn_idx(block);
694         sim->live[idx] = live;
695 }
696
697 /**
698  * Returns true if a register is live in a set.
699  *
700  * @param reg_idx  the vfp register index
701  * @param live     a live bitset
702  */
703 #define is_vfp_live(reg_idx, live) ((live) & (1 << (reg_idx)))
704
705 #ifdef DEBUG_libfirm
706 /**
707  * Dump liveness info.
708  *
709  * @param live  the live bitset
710  */
711 static void vfp_dump_live(vfp_liveness live)
712 {
713         int i;
714
715         DB((dbg, LEVEL_2, "Live after: "));
716         for (i = 0; i < 8; ++i) {
717                 if (live & (1 << i)) {
718                         DB((dbg, LEVEL_2, "vf%d ", i));
719                 }
720         }
721         DB((dbg, LEVEL_2, "\n"));
722 }
723 #endif /* DEBUG_libfirm */
724
725 /* --------------------------------- simulators ---------------------------------------- */
726
727 /**
728  * Simulate a virtual binop.
729  *
730  * @param state  the x87 state
731  * @param n      the node that should be simulated (and patched)
732  *
733  * @return NO_NODE_ADDED
734  */
735 static int sim_binop(x87_state *const state, ir_node *const n, ir_op *const op)
736 {
737         ir_node *patched_insn;
738         x87_simulator         *sim     = state->sim;
739         ir_node               *op1     = get_irn_n(n, n_ia32_binary_left);
740         ir_node               *op2     = get_irn_n(n, n_ia32_binary_right);
741         const arch_register_t *op1_reg = x87_get_irn_register(op1);
742         const arch_register_t *op2_reg = x87_get_irn_register(op2);
743         const arch_register_t *out     = x87_irn_get_register(n, pn_ia32_res);
744         int reg_index_1                = op1_reg->index;
745         int reg_index_2                = op2_reg->index;
746         vfp_liveness           live    = vfp_live_args_after(sim, n, REGMASK(out));
747         int                    op1_live_after;
748         int                    op2_live_after;
749
750         DB((dbg, LEVEL_1, ">>> %+F %s, %s -> %s\n", n, op1_reg->name, op2_reg->name, out->name));
751         DEBUG_ONLY(vfp_dump_live(live);)
752         DB((dbg, LEVEL_1, "Stack before: "));
753         DEBUG_ONLY(x87_dump_stack(state);)
754
755         int op1_idx = x87_on_stack(state, reg_index_1);
756         assert(op1_idx >= 0);
757         op1_live_after = is_vfp_live(reg_index_1, live);
758
759         int                    op2_idx;
760         int                    out_idx;
761         bool                   pop         = false;
762         int              const out_reg_idx = out->index;
763         ia32_x87_attr_t *const attr        = get_ia32_x87_attr(n);
764         if (reg_index_2 != REG_VFP_VFP_NOREG) {
765                 /* second operand is a vfp register */
766                 op2_idx = x87_on_stack(state, reg_index_2);
767                 assert(op2_idx >= 0);
768                 op2_live_after = is_vfp_live(reg_index_2, live);
769
770                 if (op2_live_after) {
771                         /* Second operand is live. */
772
773                         if (op1_live_after) {
774                                 /* Both operands are live: push the first one.
775                                  * This works even for op1 == op2. */
776                                 x87_create_fpush(state, n, op1_idx, out_reg_idx, op1);
777                                 /* now do fxxx (tos=tos X op) */
778                                 op1_idx = 0;
779                                 op2_idx += 1;
780                                 out_idx = 0;
781                         } else {
782                                 /* Second live, first operand is dead: Overwrite first. */
783                                 if (op1_idx != 0 && op2_idx != 0) {
784                                         /* Bring one operand to tos. */
785                                         x87_create_fxch(state, n, op1_idx);
786                                         op1_idx = 0;
787                                 }
788                                 out_idx = op1_idx;
789                         }
790                 } else {
791                         /* Second operand is dead. */
792                         if (op1_live_after) {
793                                 /* First operand is live, second is dead: Overwrite second. */
794                                 if (op1_idx != 0 && op2_idx != 0) {
795                                         /* Bring one operand to tos. */
796                                         x87_create_fxch(state, n, op2_idx);
797                                         op2_idx = 0;
798                                 }
799                                 out_idx = op2_idx;
800                         } else {
801                                 /* Both operands are dead. */
802                                 if (op1_idx != 0 && op2_idx != 0) {
803                                         /* Bring one operand to tos. */
804                                         x87_create_fxch(state, n, op1_idx);
805                                         if (op2_idx == op1_idx) op2_idx = 0;
806                                         op1_idx = 0;
807                                 }
808                                 out_idx = op1_idx != 0 ? op1_idx : op2_idx;
809                                 /* Only pop if the operands are differnt. */
810                                 pop     = op1_idx != op2_idx;
811                         }
812                 }
813         } else {
814                 /* second operand is an address mode */
815                 if (op1_live_after) {
816                         /* first operand is live: push it here */
817                         x87_create_fpush(state, n, op1_idx, out_reg_idx, op1);
818                 } else {
819                         /* first operand is dead: bring it to tos */
820                         if (op1_idx != 0)
821                                 x87_create_fxch(state, n, op1_idx);
822                 }
823
824                 op1_idx = attr->attr.data.ins_permuted ? -1 :  0;
825                 op2_idx = attr->attr.data.ins_permuted ?  0 : -1;
826                 out_idx = 0;
827         }
828         assert(op1_idx == 0       || op2_idx == 0);
829         assert(out_idx == op1_idx || out_idx == op2_idx);
830
831         patched_insn = x87_patch_insn(n, op);
832         x87_set_st(state, out_reg_idx, patched_insn, out_idx);
833         if (pop)
834                 x87_pop(state);
835
836         /* patch the operation */
837         int const reg_idx = op1_idx != 0 ? op1_idx : op2_idx;
838         attr->reg                    = reg_idx >= 0 ? get_st_reg(reg_idx) : NULL;
839         attr->attr.data.ins_permuted = op1_idx != 0;
840         attr->res_in_reg             = out_idx != 0;
841         attr->pop                    = pop;
842
843         DEBUG_ONLY(
844                 char const *const l = op1_idx >= 0 ? get_st_reg(op1_idx)->name : "[AM]";
845                 char const *const r = op2_idx >= 0 ? get_st_reg(op2_idx)->name : "[AM]";
846                 char const *const o = get_st_reg(out_idx)->name;
847                 DB((dbg, LEVEL_1, "<<< %s %s, %s -> %s\n", get_irn_opname(n), l, r, o));
848         );
849
850         return NO_NODE_ADDED;
851 }
852
853 /**
854  * Simulate a virtual Unop.
855  *
856  * @param state  the x87 state
857  * @param n      the node that should be simulated (and patched)
858  * @param op     the x87 opcode that will replace n's opcode
859  *
860  * @return NO_NODE_ADDED
861  */
862 static int sim_unop(x87_state *state, ir_node *n, ir_op *op)
863 {
864         arch_register_t const *const out  = x87_get_irn_register(n);
865         unsigned               const live = vfp_live_args_after(state->sim, n, REGMASK(out));
866         DB((dbg, LEVEL_1, ">>> %+F -> %s\n", n, out->name));
867         DEBUG_ONLY(vfp_dump_live(live);)
868
869         ir_node               *const op1         = get_irn_n(n, 0);
870         arch_register_t const *const op1_reg     = x87_get_irn_register(op1);
871         int                    const op1_reg_idx = op1_reg->index;
872         int                    const op1_idx     = x87_on_stack(state, op1_reg_idx);
873         int                    const out_reg_idx = out->index;
874         if (is_vfp_live(op1_reg_idx, live)) {
875                 /* push the operand here */
876                 x87_create_fpush(state, n, op1_idx, out_reg_idx, op1);
877         } else {
878                 /* operand is dead, bring it to tos */
879                 if (op1_idx != 0) {
880                         x87_create_fxch(state, n, op1_idx);
881                 }
882         }
883
884         x87_set_st(state, out_reg_idx, x87_patch_insn(n, op), 0);
885         DB((dbg, LEVEL_1, "<<< %s -> %s\n", get_irn_opname(n), get_st_reg(0)->name));
886
887         return NO_NODE_ADDED;
888 }
889
890 /**
891  * Simulate a virtual Load instruction.
892  *
893  * @param state  the x87 state
894  * @param n      the node that should be simulated (and patched)
895  * @param op     the x87 opcode that will replace n's opcode
896  *
897  * @return NO_NODE_ADDED
898  */
899 static int sim_load(x87_state *state, ir_node *n, ir_op *op, int res_pos)
900 {
901         const arch_register_t *out = x87_irn_get_register(n, res_pos);
902
903         DB((dbg, LEVEL_1, ">>> %+F -> %s\n", n, out->name));
904         x87_push(state, out->index, x87_patch_insn(n, op));
905         assert(out == x87_irn_get_register(n, res_pos));
906         DB((dbg, LEVEL_1, "<<< %s -> %s\n", get_irn_opname(n), get_st_reg(0)->name));
907
908         return NO_NODE_ADDED;
909 }
910
911 /**
912  * Rewire all users of @p old_val to @new_val iff they are scheduled after @p store.
913  *
914  * @param store   The store
915  * @param old_val The former value
916  * @param new_val The new value
917  */
918 static void collect_and_rewire_users(ir_node *store, ir_node *old_val, ir_node *new_val)
919 {
920         foreach_out_edge_safe(old_val, edge) {
921                 ir_node *user = get_edge_src_irn(edge);
922                 /* if the user is scheduled after the store: rewire */
923                 if (sched_is_scheduled(user) && sched_comes_after(store, user)) {
924                         set_irn_n(user, get_edge_src_pos(edge), new_val);
925                 }
926         }
927 }
928
929 /**
930  * Simulate a virtual Store.
931  *
932  * @param state  the x87 state
933  * @param n      the node that should be simulated (and patched)
934  * @param op     the x87 store opcode
935  */
936 static int sim_store(x87_state *state, ir_node *n, ir_op *op)
937 {
938         ir_node               *const val = get_irn_n(n, n_ia32_vfst_val);
939         arch_register_t const *const op2 = x87_get_irn_register(val);
940         DB((dbg, LEVEL_1, ">>> %+F %s ->\n", n, op2->name));
941
942         bool           do_pop          = false;
943         int            insn            = NO_NODE_ADDED;
944         int      const op2_reg_idx     = op2->index;
945         int      const op2_idx         = x87_on_stack(state, op2_reg_idx);
946         unsigned const live            = vfp_live_args_after(state->sim, n, 0);
947         int      const live_after_node = is_vfp_live(op2_reg_idx, live);
948         assert(op2_idx >= 0);
949         if (live_after_node) {
950                 /* Problem: fst doesn't support 80bit modes (spills), only fstp does
951                  *          fist doesn't support 64bit mode, only fistp
952                  * Solution:
953                  *   - stack not full: push value and fstp
954                  *   - stack full: fstp value and load again
955                  * Note that we cannot test on mode_E, because floats might be 80bit ... */
956                 ir_mode *const mode = get_ia32_ls_mode(n);
957                 if (get_mode_size_bits(mode) > (mode_is_int(mode) ? 32 : 64)) {
958                         if (x87_get_depth(state) < N_ia32_st_REGS) {
959                                 /* ok, we have a free register: push + fstp */
960                                 x87_create_fpush(state, n, op2_idx, REG_VFP_VFP_NOREG, val);
961                                 x87_patch_insn(n, op);
962                                 do_pop = true;
963                         } else {
964                                 /* stack full here: need fstp + load */
965                                 x87_patch_insn(n, op);
966                                 do_pop = true;
967
968                                 ir_node *const block = get_nodes_block(n);
969                                 ir_node *const mem   = get_irn_Proj_for_mode(n, mode_M);
970                                 ir_node *const vfld  = new_bd_ia32_vfld(NULL, block, get_irn_n(n, 0), get_irn_n(n, 1), mem, mode);
971
972                                 /* copy all attributes */
973                                 set_ia32_frame_ent(vfld, get_ia32_frame_ent(n));
974                                 if (is_ia32_use_frame(n))
975                                         set_ia32_use_frame(vfld);
976                                 set_ia32_op_type(vfld, ia32_AddrModeS);
977                                 add_ia32_am_offs_int(vfld, get_ia32_am_offs_int(n));
978                                 set_ia32_am_sc(vfld, get_ia32_am_sc(n));
979                                 set_ia32_ls_mode(vfld, mode);
980
981                                 ir_node *const rproj = new_r_Proj(vfld, mode, pn_ia32_vfld_res);
982                                 ir_node *const mproj = new_r_Proj(vfld, mode_M, pn_ia32_vfld_M);
983
984                                 arch_set_irn_register(rproj, op2);
985
986                                 /* reroute all former users of the store memory to the load memory */
987                                 edges_reroute_except(mem, mproj, vfld);
988
989                                 sched_add_after(n, vfld);
990
991                                 /* rewire all users, scheduled after the store, to the loaded value */
992                                 collect_and_rewire_users(n, val, rproj);
993
994                                 insn = NODE_ADDED;
995                         }
996                 } else {
997                         /* we can only store the tos to memory */
998                         if (op2_idx != 0)
999                                 x87_create_fxch(state, n, op2_idx);
1000
1001                         /* mode size 64 or smaller -> use normal fst */
1002                         x87_patch_insn(n, op);
1003                 }
1004         } else {
1005                 /* we can only store the tos to memory */
1006                 if (op2_idx != 0)
1007                         x87_create_fxch(state, n, op2_idx);
1008
1009                 x87_patch_insn(n, op);
1010                 do_pop = true;
1011         }
1012
1013         if (do_pop)
1014                 x87_pop(state);
1015
1016         ia32_x87_attr_t *const attr = get_ia32_x87_attr(n);
1017         attr->pop = do_pop;
1018         DB((dbg, LEVEL_1, "<<< %s %s ->\n", get_irn_opname(n), get_st_reg(0)->name));
1019
1020         return insn;
1021 }
1022
1023 #define GEN_BINOP(op) \
1024 static int sim_##op(x87_state *state, ir_node *n) { \
1025         return sim_binop(state, n, op_ia32_##op); \
1026 }
1027
1028 #define GEN_LOAD(op)                                              \
1029 static int sim_##op(x87_state *state, ir_node *n) {               \
1030         return sim_load(state, n, op_ia32_##op, pn_ia32_v##op##_res); \
1031 }
1032
1033 #define GEN_UNOP(op) \
1034 static int sim_##op(x87_state *state, ir_node *n) { \
1035         return sim_unop(state, n, op_ia32_##op); \
1036 }
1037
1038 #define GEN_STORE(op) \
1039 static int sim_##op(x87_state *state, ir_node *n) { \
1040         return sim_store(state, n, op_ia32_##op); \
1041 }
1042
1043 /* all stubs */
1044 GEN_BINOP(fadd)
1045 GEN_BINOP(fsub)
1046 GEN_BINOP(fmul)
1047 GEN_BINOP(fdiv)
1048
1049 GEN_UNOP(fabs)
1050 GEN_UNOP(fchs)
1051
1052 GEN_LOAD(fld)
1053 GEN_LOAD(fild)
1054 GEN_LOAD(fldz)
1055 GEN_LOAD(fld1)
1056
1057 GEN_STORE(fst)
1058 GEN_STORE(fist)
1059
1060 static int sim_fprem(x87_state *const state, ir_node *const n)
1061 {
1062         (void)state;
1063         (void)n;
1064         panic("TODO implement");
1065         return NO_NODE_ADDED;
1066 }
1067
1068 /**
1069  * Simulate a virtual fisttp.
1070  *
1071  * @param state  the x87 state
1072  * @param n      the node that should be simulated (and patched)
1073  *
1074  * @return NO_NODE_ADDED
1075  */
1076 static int sim_fisttp(x87_state *state, ir_node *n)
1077 {
1078         ir_node               *val = get_irn_n(n, n_ia32_vfst_val);
1079         const arch_register_t *op2 = x87_get_irn_register(val);
1080
1081         int const op2_idx = x87_on_stack(state, op2->index);
1082         DB((dbg, LEVEL_1, ">>> %+F %s ->\n", n, op2->name));
1083         assert(op2_idx >= 0);
1084
1085         /* Note: although the value is still live here, it is destroyed because
1086            of the pop. The register allocator is aware of that and introduced a copy
1087            if the value must be alive. */
1088
1089         /* we can only store the tos to memory */
1090         if (op2_idx != 0)
1091                 x87_create_fxch(state, n, op2_idx);
1092
1093         x87_pop(state);
1094         x87_patch_insn(n, op_ia32_fisttp);
1095
1096         DB((dbg, LEVEL_1, "<<< %s %s ->\n", get_irn_opname(n), get_st_reg(0)->name));
1097
1098         return NO_NODE_ADDED;
1099 }
1100
1101 /**
1102  * Simulate a virtual FtstFnstsw.
1103  *
1104  * @param state  the x87 state
1105  * @param n      the node that should be simulated (and patched)
1106  *
1107  * @return NO_NODE_ADDED
1108  */
1109 static int sim_FtstFnstsw(x87_state *state, ir_node *n)
1110 {
1111         x87_simulator         *sim         = state->sim;
1112         ir_node               *op1_node    = get_irn_n(n, n_ia32_vFtstFnstsw_left);
1113         const arch_register_t *reg1        = x87_get_irn_register(op1_node);
1114         int                    reg_index_1 = reg1->index;
1115         int                    op1_idx     = x87_on_stack(state, reg_index_1);
1116         unsigned               live        = vfp_live_args_after(sim, n, 0);
1117
1118         DB((dbg, LEVEL_1, ">>> %+F %s\n", n, reg1->name));
1119         DEBUG_ONLY(vfp_dump_live(live);)
1120         DB((dbg, LEVEL_1, "Stack before: "));
1121         DEBUG_ONLY(x87_dump_stack(state);)
1122         assert(op1_idx >= 0);
1123
1124         if (op1_idx != 0) {
1125                 /* bring the value to tos */
1126                 x87_create_fxch(state, n, op1_idx);
1127         }
1128
1129         /* patch the operation */
1130         x87_patch_insn(n, op_ia32_FtstFnstsw);
1131
1132         if (!is_vfp_live(reg_index_1, live))
1133                 x87_create_fpop(state, sched_next(n), 0);
1134
1135         return NO_NODE_ADDED;
1136 }
1137
1138 /**
1139  * Simulate a Fucom
1140  *
1141  * @param state  the x87 state
1142  * @param n      the node that should be simulated (and patched)
1143  *
1144  * @return NO_NODE_ADDED
1145  */
1146 static int sim_Fucom(x87_state *state, ir_node *n)
1147 {
1148         ia32_x87_attr_t *attr = get_ia32_x87_attr(n);
1149         ir_op *dst;
1150         x87_simulator         *sim        = state->sim;
1151         ir_node               *op1_node   = get_irn_n(n, n_ia32_vFucomFnstsw_left);
1152         ir_node               *op2_node   = get_irn_n(n, n_ia32_vFucomFnstsw_right);
1153         const arch_register_t *op1        = x87_get_irn_register(op1_node);
1154         const arch_register_t *op2        = x87_get_irn_register(op2_node);
1155         int                    reg_index_1 = op1->index;
1156         int                    reg_index_2 = op2->index;
1157         unsigned               live       = vfp_live_args_after(sim, n, 0);
1158
1159         DB((dbg, LEVEL_1, ">>> %+F %s, %s\n", n, op1->name, op2->name));
1160         DEBUG_ONLY(vfp_dump_live(live);)
1161         DB((dbg, LEVEL_1, "Stack before: "));
1162         DEBUG_ONLY(x87_dump_stack(state);)
1163
1164         int op1_idx = x87_on_stack(state, reg_index_1);
1165         assert(op1_idx >= 0);
1166
1167         int op2_idx;
1168         int pops = 0;
1169         /* BEWARE: check for comp a,a cases, they might happen */
1170         if (reg_index_2 != REG_VFP_VFP_NOREG) {
1171                 /* second operand is a vfp register */
1172                 op2_idx = x87_on_stack(state, reg_index_2);
1173                 assert(op2_idx >= 0);
1174
1175                 if (is_vfp_live(reg_index_2, live)) {
1176                         /* second operand is live */
1177
1178                         if (is_vfp_live(reg_index_1, live)) {
1179                                 /* both operands are live */
1180                                 if (op1_idx != 0 && op2_idx != 0) {
1181                                         /* bring the first one to tos */
1182                                         x87_create_fxch(state, n, op1_idx);
1183                                         if (op1_idx == op2_idx)
1184                                                 op2_idx = 0;
1185                                         op1_idx = 0;
1186                                         /* res = tos X op */
1187                                 }
1188                         } else {
1189                                 /* second live, first operand is dead here, bring it to tos.
1190                                    This means further, op1_idx != op2_idx. */
1191                                 assert(op1_idx != op2_idx);
1192                                 if (op1_idx != 0) {
1193                                         x87_create_fxch(state, n, op1_idx);
1194                                         if (op2_idx == 0)
1195                                                 op2_idx = op1_idx;
1196                                         op1_idx = 0;
1197                                 }
1198                                 /* res = tos X op, pop */
1199                                 pops = 1;
1200                         }
1201                 } else {
1202                         /* second operand is dead */
1203                         if (is_vfp_live(reg_index_1, live)) {
1204                                 /* first operand is live: bring second to tos.
1205                                    This means further, op1_idx != op2_idx. */
1206                                 assert(op1_idx != op2_idx);
1207                                 if (op2_idx != 0) {
1208                                         x87_create_fxch(state, n, op2_idx);
1209                                         if (op1_idx == 0)
1210                                                 op1_idx = op2_idx;
1211                                         op2_idx = 0;
1212                                 }
1213                                 /* res = op X tos, pop */
1214                                 pops = 1;
1215                         } else {
1216                                 /* both operands are dead here, check first for identity. */
1217                                 if (op1_idx == op2_idx) {
1218                                         /* identically, one pop needed */
1219                                         if (op1_idx != 0) {
1220                                                 x87_create_fxch(state, n, op1_idx);
1221                                                 op1_idx = 0;
1222                                                 op2_idx = 0;
1223                                         }
1224                                         /* res = tos X op, pop */
1225                                         pops    = 1;
1226                                 }
1227                                 /* different, move them to st and st(1) and pop both.
1228                                    The tricky part is to get one into st(1).*/
1229                                 else if (op2_idx == 1) {
1230                                         /* good, second operand is already in the right place, move the first */
1231                                         if (op1_idx != 0) {
1232                                                 /* bring the first on top */
1233                                                 x87_create_fxch(state, n, op1_idx);
1234                                                 assert(op2_idx != 0);
1235                                                 op1_idx = 0;
1236                                         }
1237                                         /* res = tos X op, pop, pop */
1238                                         pops = 2;
1239                                 } else if (op1_idx == 1) {
1240                                         /* good, first operand is already in the right place, move the second */
1241                                         if (op2_idx != 0) {
1242                                                 /* bring the first on top */
1243                                                 x87_create_fxch(state, n, op2_idx);
1244                                                 assert(op1_idx != 0);
1245                                                 op2_idx = 0;
1246                                         }
1247                                         /* res = op X tos, pop, pop */
1248                                         pops = 2;
1249                                 } else {
1250                                         /* if one is already the TOS, we need two fxch */
1251                                         if (op1_idx == 0) {
1252                                                 /* first one is TOS, move to st(1) */
1253                                                 x87_create_fxch(state, n, 1);
1254                                                 assert(op2_idx != 1);
1255                                                 op1_idx = 1;
1256                                                 x87_create_fxch(state, n, op2_idx);
1257                                                 op2_idx = 0;
1258                                                 /* res = op X tos, pop, pop */
1259                                                 pops    = 2;
1260                                         } else if (op2_idx == 0) {
1261                                                 /* second one is TOS, move to st(1) */
1262                                                 x87_create_fxch(state, n, 1);
1263                                                 assert(op1_idx != 1);
1264                                                 op2_idx = 1;
1265                                                 x87_create_fxch(state, n, op1_idx);
1266                                                 op1_idx = 0;
1267                                                 /* res = tos X op, pop, pop */
1268                                                 pops    = 2;
1269                                         } else {
1270                                                 /* none of them is either TOS or st(1), 3 fxch needed */
1271                                                 x87_create_fxch(state, n, op2_idx);
1272                                                 assert(op1_idx != 0);
1273                                                 x87_create_fxch(state, n, 1);
1274                                                 op2_idx = 1;
1275                                                 x87_create_fxch(state, n, op1_idx);
1276                                                 op1_idx = 0;
1277                                                 /* res = tos X op, pop, pop */
1278                                                 pops    = 2;
1279                                         }
1280                                 }
1281                         }
1282                 }
1283         } else {
1284                 /* second operand is an address mode */
1285                 if (op1_idx != 0)
1286                         x87_create_fxch(state, n, op1_idx);
1287                 /* Pop first operand, if it is dead. */
1288                 if (!is_vfp_live(reg_index_1, live))
1289                         pops = 1;
1290
1291                 op1_idx = attr->attr.data.ins_permuted ? -1 :  0;
1292                 op2_idx = attr->attr.data.ins_permuted ?  0 : -1;
1293         }
1294         assert(op1_idx == 0 || op2_idx == 0);
1295
1296         /* patch the operation */
1297         if (is_ia32_vFucomFnstsw(n)) {
1298                 dst = pops == 2 ? op_ia32_FucomppFnstsw : op_ia32_FucomFnstsw;
1299                 for (int i = 0; i < pops; ++i)
1300                         x87_pop(state);
1301         } else if (is_ia32_vFucomi(n)) {
1302                 dst = op_ia32_Fucomi;
1303                 if (pops != 0)
1304                         x87_pop(state);
1305                 if (pops == 2)
1306                         x87_create_fpop(state, sched_next(n), 0);
1307         } else {
1308                 panic("invalid operation %+F", n);
1309         }
1310
1311         x87_patch_insn(n, dst);
1312
1313         int const reg_idx = op1_idx != 0 ? op1_idx : op2_idx;
1314         attr->reg                    = reg_idx >= 0 ? get_st_reg(reg_idx) : NULL;
1315         attr->attr.data.ins_permuted = op1_idx != 0;
1316         attr->pop                    = pops != 0;
1317
1318         DEBUG_ONLY(
1319                 char const *const l = op1_idx >= 0 ? get_st_reg(op1_idx)->name : "[AM]";
1320                 char const *const r = op2_idx >= 0 ? get_st_reg(op2_idx)->name : "[AM]";
1321                 DB((dbg, LEVEL_1, "<<< %s %s, %s\n", get_irn_opname(n), l, r));
1322         );
1323
1324         return NO_NODE_ADDED;
1325 }
1326
1327 /**
1328  * Simulate a Keep.
1329  *
1330  * @param state  the x87 state
1331  * @param n      the node that should be simulated (and patched)
1332  *
1333  * @return NO_NODE_ADDED
1334  */
1335 static int sim_Keep(x87_state *state, ir_node *node)
1336 {
1337         const ir_node         *op;
1338         const arch_register_t *op_reg;
1339         int                    reg_id;
1340         int                    op_stack_idx;
1341         unsigned               live;
1342         int                    i, arity;
1343
1344         DB((dbg, LEVEL_1, ">>> %+F\n", node));
1345
1346         arity = get_irn_arity(node);
1347         for (i = 0; i < arity; ++i) {
1348                 op      = get_irn_n(node, i);
1349                 op_reg  = arch_get_irn_register(op);
1350                 if (op_reg->reg_class != &ia32_reg_classes[CLASS_ia32_vfp])
1351                         continue;
1352
1353                 reg_id = op_reg->index;
1354                 live   = vfp_live_args_after(state->sim, node, 0);
1355
1356                 op_stack_idx = x87_on_stack(state, reg_id);
1357                 if (op_stack_idx >= 0 && !is_vfp_live(reg_id, live))
1358                         x87_create_fpop(state, sched_next(node), 0);
1359         }
1360
1361         DB((dbg, LEVEL_1, "Stack after: "));
1362         DEBUG_ONLY(x87_dump_stack(state);)
1363
1364         return NO_NODE_ADDED;
1365 }
1366
1367 /**
1368  * Keep the given node alive by adding a be_Keep.
1369  *
1370  * @param node  the node to kept alive
1371  */
1372 static void keep_float_node_alive(ir_node *node)
1373 {
1374         ir_node *block = get_nodes_block(node);
1375         ir_node *keep  = be_new_Keep(block, 1, &node);
1376         sched_add_after(node, keep);
1377 }
1378
1379 /**
1380  * Create a copy of a node. Recreate the node if it's a constant.
1381  *
1382  * @param state  the x87 state
1383  * @param n      the node to be copied
1384  *
1385  * @return the copy of n
1386  */
1387 static ir_node *create_Copy(x87_state *state, ir_node *n)
1388 {
1389         dbg_info *n_dbg = get_irn_dbg_info(n);
1390         ir_mode *mode = get_irn_mode(n);
1391         ir_node *block = get_nodes_block(n);
1392         ir_node *pred = get_irn_n(n, 0);
1393         ir_node *(*cnstr)(dbg_info *, ir_node *, ir_mode *) = NULL;
1394         ir_node *res;
1395         const arch_register_t *out;
1396         const arch_register_t *op1;
1397
1398         /* Do not copy constants, recreate them. */
1399         switch (get_ia32_irn_opcode(pred)) {
1400         case iro_ia32_fldz:
1401                 cnstr = new_bd_ia32_fldz;
1402                 break;
1403         case iro_ia32_fld1:
1404                 cnstr = new_bd_ia32_fld1;
1405                 break;
1406         case iro_ia32_fldpi:
1407                 cnstr = new_bd_ia32_fldpi;
1408                 break;
1409         case iro_ia32_fldl2e:
1410                 cnstr = new_bd_ia32_fldl2e;
1411                 break;
1412         case iro_ia32_fldl2t:
1413                 cnstr = new_bd_ia32_fldl2t;
1414                 break;
1415         case iro_ia32_fldlg2:
1416                 cnstr = new_bd_ia32_fldlg2;
1417                 break;
1418         case iro_ia32_fldln2:
1419                 cnstr = new_bd_ia32_fldln2;
1420                 break;
1421         default:
1422                 break;
1423         }
1424
1425         out = x87_get_irn_register(n);
1426         op1 = x87_get_irn_register(pred);
1427
1428         if (cnstr != NULL) {
1429                 /* copy a constant */
1430                 res = (*cnstr)(n_dbg, block, mode);
1431
1432                 x87_push(state, out->index, res);
1433         } else {
1434                 int op1_idx = x87_on_stack(state, op1->index);
1435
1436                 res = new_bd_ia32_fpushCopy(n_dbg, block, pred, mode);
1437
1438                 x87_push(state, out->index, res);
1439
1440                 ia32_x87_attr_t *const attr = get_ia32_x87_attr(res);
1441                 attr->reg = get_st_reg(op1_idx);
1442         }
1443         arch_set_irn_register(res, out);
1444
1445         return res;
1446 }
1447
1448 /**
1449  * Simulate a be_Copy.
1450  *
1451  * @param state  the x87 state
1452  * @param n      the node that should be simulated (and patched)
1453  *
1454  * @return NO_NODE_ADDED
1455  */
1456 static int sim_Copy(x87_state *state, ir_node *n)
1457 {
1458         arch_register_class_t const *const cls = arch_get_irn_reg_class(n);
1459         if (cls != &ia32_reg_classes[CLASS_ia32_vfp])
1460                 return NO_NODE_ADDED;
1461
1462         ir_node               *const pred = be_get_Copy_op(n);
1463         arch_register_t const *const op1  = x87_get_irn_register(pred);
1464         arch_register_t const *const out  = x87_get_irn_register(n);
1465         unsigned               const live = vfp_live_args_after(state->sim, n, REGMASK(out));
1466
1467         DB((dbg, LEVEL_1, ">>> %+F %s -> %s\n", n, op1->name, out->name));
1468         DEBUG_ONLY(vfp_dump_live(live);)
1469
1470         if (is_vfp_live(op1->index, live)) {
1471                 /* Operand is still live, a real copy. We need here an fpush that can
1472                    hold a a register, so use the fpushCopy or recreate constants */
1473                 ir_node *const node = create_Copy(state, n);
1474
1475                 /* We have to make sure the old value doesn't go dead (which can happen
1476                  * when we recreate constants). As the simulator expected that value in
1477                  * the pred blocks. This is unfortunate as removing it would save us 1
1478                  * instruction, but we would have to rerun all the simulation to get
1479                  * this correct...
1480                  */
1481                 ir_node *const next = sched_next(n);
1482                 sched_remove(n);
1483                 exchange(n, node);
1484                 sched_add_before(next, node);
1485
1486                 if (get_irn_n_edges(pred) == 0) {
1487                         keep_float_node_alive(pred);
1488                 }
1489
1490                 DB((dbg, LEVEL_1, "<<< %+F %s -> ?\n", node, op1->name));
1491         } else {
1492                 /* Just a virtual copy. */
1493                 int const op1_idx = x87_on_stack(state, op1->index);
1494                 x87_set_st(state, out->index, n, op1_idx);
1495         }
1496         return NO_NODE_ADDED;
1497 }
1498
1499 /**
1500  * Returns the vf0 result Proj of a Call.
1501  *
1502  * @para call  the Call node
1503  */
1504 static ir_node *get_call_result_proj(ir_node *call)
1505 {
1506         /* search the result proj */
1507         foreach_out_edge(call, edge) {
1508                 ir_node *proj = get_edge_src_irn(edge);
1509                 long pn = get_Proj_proj(proj);
1510
1511                 if (pn == pn_ia32_Call_vf0)
1512                         return proj;
1513         }
1514
1515         panic("result Proj missing");
1516 }
1517
1518 static int sim_Asm(x87_state *const state, ir_node *const n)
1519 {
1520         (void)state;
1521
1522         for (size_t i = get_irn_arity(n); i-- != 0;) {
1523                 arch_register_req_t const *const req = arch_get_irn_register_req_in(n, i);
1524                 if (req->cls == &ia32_reg_classes[CLASS_ia32_vfp])
1525                         panic("cannot handle %+F with x87 constraints", n);
1526         }
1527
1528         for (size_t i = arch_get_irn_n_outs(n); i-- != 0;) {
1529                 arch_register_req_t const *const req = arch_get_irn_register_req_out(n, i);
1530                 if (req->cls == &ia32_reg_classes[CLASS_ia32_vfp])
1531                         panic("cannot handle %+F with x87 constraints", n);
1532         }
1533
1534         return NO_NODE_ADDED;
1535 }
1536
1537 /**
1538  * Simulate a ia32_Call.
1539  *
1540  * @param state      the x87 state
1541  * @param n          the node that should be simulated (and patched)
1542  *
1543  * @return NO_NODE_ADDED
1544  */
1545 static int sim_Call(x87_state *state, ir_node *n)
1546 {
1547         DB((dbg, LEVEL_1, ">>> %+F\n", n));
1548
1549         /* at the begin of a call the x87 state should be empty */
1550         assert(state->depth == 0 && "stack not empty before call");
1551
1552         ir_type *const call_tp = get_ia32_call_attr_const(n)->call_tp;
1553         if (get_method_n_ress(call_tp) != 0) {
1554                 /* If the called function returns a float, it is returned in st(0).
1555                  * This even happens if the return value is NOT used.
1556                  * Moreover, only one return result is supported. */
1557                 ir_type *const res_type = get_method_res_type(call_tp, 0);
1558                 ir_mode *const mode     = get_type_mode(res_type);
1559                 if (mode && mode_is_float(mode)) {
1560                         ir_node               *const resproj = get_call_result_proj(n);
1561                         arch_register_t const *const reg     = x87_get_irn_register(resproj);
1562                         x87_push(state, reg->index, resproj);
1563                 }
1564         }
1565         DB((dbg, LEVEL_1, "Stack after: "));
1566         DEBUG_ONLY(x87_dump_stack(state);)
1567
1568         return NO_NODE_ADDED;
1569 }
1570
1571 /**
1572  * Simulate a be_Return.
1573  *
1574  * @param state  the x87 state
1575  * @param n      the node that should be simulated (and patched)
1576  *
1577  * @return NO_NODE_ADDED
1578  */
1579 static int sim_Return(x87_state *state, ir_node *n)
1580 {
1581 #ifdef DEBUG_libfirm
1582         /* only floating point return values must reside on stack */
1583         int       n_float_res = 0;
1584         int const n_res       = be_Return_get_n_rets(n);
1585         for (int i = 0; i < n_res; ++i) {
1586                 ir_node *const res = get_irn_n(n, n_be_Return_val + i);
1587                 if (mode_is_float(get_irn_mode(res)))
1588                         ++n_float_res;
1589         }
1590         assert(x87_get_depth(state) == n_float_res);
1591 #endif
1592
1593         /* pop them virtually */
1594         x87_emms(state);
1595         return NO_NODE_ADDED;
1596 }
1597
1598 /**
1599  * Simulate a be_Perm.
1600  *
1601  * @param state  the x87 state
1602  * @param irn    the node that should be simulated (and patched)
1603  *
1604  * @return NO_NODE_ADDED
1605  */
1606 static int sim_Perm(x87_state *state, ir_node *irn)
1607 {
1608         int      i, n;
1609         ir_node *pred = get_irn_n(irn, 0);
1610         int     *stack_pos;
1611
1612         /* handle only floating point Perms */
1613         if (! mode_is_float(get_irn_mode(pred)))
1614                 return NO_NODE_ADDED;
1615
1616         DB((dbg, LEVEL_1, ">>> %+F\n", irn));
1617
1618         /* Perm is a pure virtual instruction on x87.
1619            All inputs must be on the FPU stack and are pairwise
1620            different from each other.
1621            So, all we need to do is to permutate the stack state. */
1622         n = get_irn_arity(irn);
1623         NEW_ARR_A(int, stack_pos, n);
1624
1625         /* collect old stack positions */
1626         for (i = 0; i < n; ++i) {
1627                 const arch_register_t *inreg = x87_get_irn_register(get_irn_n(irn, i));
1628                 int idx = x87_on_stack(state, inreg->index);
1629
1630                 assert(idx >= 0 && "Perm argument not on x87 stack");
1631
1632                 stack_pos[i] = idx;
1633         }
1634         /* now do the permutation */
1635         foreach_out_edge(irn, edge) {
1636                 ir_node               *proj = get_edge_src_irn(edge);
1637                 const arch_register_t *out  = x87_get_irn_register(proj);
1638                 long                  num   = get_Proj_proj(proj);
1639
1640                 assert(0 <= num && num < n && "More Proj's than Perm inputs");
1641                 x87_set_st(state, out->index, proj, stack_pos[(unsigned)num]);
1642         }
1643         DB((dbg, LEVEL_1, "<<< %+F\n", irn));
1644
1645         return NO_NODE_ADDED;
1646 }
1647
1648 /**
1649  * Kill any dead registers at block start by popping them from the stack.
1650  *
1651  * @param sim    the simulator handle
1652  * @param block  the current block
1653  * @param state  the x87 state at the begin of the block
1654  */
1655 static void x87_kill_deads(x87_simulator *const sim, ir_node *const block, x87_state *const state)
1656 {
1657         ir_node *first_insn = sched_first(block);
1658         ir_node *keep = NULL;
1659         unsigned live = vfp_live_args_after(sim, block, 0);
1660         unsigned kill_mask;
1661         int i, depth;
1662
1663         kill_mask = 0;
1664         depth = x87_get_depth(state);
1665         for (i = depth - 1; i >= 0; --i) {
1666                 int reg = x87_get_st_reg(state, i);
1667
1668                 if (! is_vfp_live(reg, live))
1669                         kill_mask |= (1 << i);
1670         }
1671
1672         if (kill_mask) {
1673                 DB((dbg, LEVEL_1, "Killing deads:\n"));
1674                 DEBUG_ONLY(vfp_dump_live(live);)
1675                 DEBUG_ONLY(x87_dump_stack(state);)
1676
1677                 if (kill_mask != 0 && live == 0) {
1678                         /* special case: kill all registers */
1679                         if (ia32_cg_config.use_femms || ia32_cg_config.use_emms) {
1680                                 if (ia32_cg_config.use_femms) {
1681                                         /* use FEMMS on AMD processors to clear all */
1682                                         keep = new_bd_ia32_femms(NULL, block);
1683                                 } else {
1684                                         /* use EMMS to clear all */
1685                                         keep = new_bd_ia32_emms(NULL, block);
1686                                 }
1687                                 sched_add_before(first_insn, keep);
1688                                 keep_alive(keep);
1689                                 x87_emms(state);
1690                                 return;
1691                         }
1692                 }
1693                 /* now kill registers */
1694                 while (kill_mask) {
1695                         /* we can only kill from TOS, so bring them up */
1696                         if (! (kill_mask & 1)) {
1697                                 /* search from behind, because we can to a double-pop */
1698                                 for (i = depth - 1; i >= 0; --i) {
1699                                         if (kill_mask & (1 << i)) {
1700                                                 kill_mask &= ~(1 << i);
1701                                                 kill_mask |= 1;
1702                                                 break;
1703                                         }
1704                                 }
1705
1706                                 if (keep)
1707                                         x87_set_st(state, -1, keep, i);
1708                                 x87_create_fxch(state, first_insn, i);
1709                         }
1710
1711                         depth      -= 1;
1712                         kill_mask >>= 1;
1713                         keep        = x87_create_fpop(state, first_insn, 0);
1714                 }
1715                 keep_alive(keep);
1716         }
1717 }
1718
1719 /**
1720  * Run a simulation and fix all virtual instructions for a block.
1721  *
1722  * @param sim          the simulator handle
1723  * @param block        the current block
1724  */
1725 static void x87_simulate_block(x87_simulator *sim, ir_node *block)
1726 {
1727         ir_node *n, *next;
1728         blk_state *bl_state = x87_get_bl_state(sim, block);
1729         x87_state *state = bl_state->begin;
1730         ir_node *start_block;
1731
1732         assert(state != NULL);
1733         /* already processed? */
1734         if (bl_state->end != NULL)
1735                 return;
1736
1737         DB((dbg, LEVEL_1, "Simulate %+F\n", block));
1738         DB((dbg, LEVEL_2, "State at Block begin:\n "));
1739         DEBUG_ONLY(x87_dump_stack(state);)
1740
1741         /* create a new state, will be changed */
1742         state = x87_clone_state(sim, state);
1743         /* at block begin, kill all dead registers */
1744         x87_kill_deads(sim, block, state);
1745
1746         /* beware, n might change */
1747         for (n = sched_first(block); !sched_is_end(n); n = next) {
1748                 int node_inserted;
1749                 sim_func func;
1750                 ir_op *op = get_irn_op(n);
1751
1752                 /*
1753                  * get the next node to be simulated here.
1754                  * n might be completely removed from the schedule-
1755                  */
1756                 next = sched_next(n);
1757                 if (op->ops.generic != NULL) {
1758                         func = (sim_func)op->ops.generic;
1759
1760                         /* simulate it */
1761                         node_inserted = (*func)(state, n);
1762
1763                         /*
1764                          * sim_func might have added an additional node after n,
1765                          * so update next node
1766                          * beware: n must not be changed by sim_func
1767                          * (i.e. removed from schedule) in this case
1768                          */
1769                         if (node_inserted != NO_NODE_ADDED)
1770                                 next = sched_next(n);
1771                 }
1772         }
1773
1774         start_block = get_irg_start_block(get_irn_irg(block));
1775
1776         DB((dbg, LEVEL_2, "State at Block end:\n ")); DEBUG_ONLY(x87_dump_stack(state);)
1777
1778         /* check if the state must be shuffled */
1779         foreach_block_succ(block, edge) {
1780                 ir_node *succ = get_edge_src_irn(edge);
1781                 blk_state *succ_state;
1782
1783                 if (succ == start_block)
1784                         continue;
1785
1786                 succ_state = x87_get_bl_state(sim, succ);
1787
1788                 if (succ_state->begin == NULL) {
1789                         DB((dbg, LEVEL_2, "Set begin state for succ %+F:\n", succ));
1790                         DEBUG_ONLY(x87_dump_stack(state);)
1791                         succ_state->begin = state;
1792
1793                         waitq_put(sim->worklist, succ);
1794                 } else {
1795                         DB((dbg, LEVEL_2, "succ %+F already has a state, shuffling\n", succ));
1796                         /* There is already a begin state for the successor, bad.
1797                            Do the necessary permutations.
1798                            Note that critical edges are removed, so this is always possible:
1799                            If the successor has more than one possible input, then it must
1800                            be the only one.
1801                          */
1802                         x87_shuffle(block, state, succ_state->begin);
1803                 }
1804         }
1805         bl_state->end = state;
1806 }
1807
1808 /**
1809  * Register a simulator function.
1810  *
1811  * @param op    the opcode to simulate
1812  * @param func  the simulator function for the opcode
1813  */
1814 static void register_sim(ir_op *op, sim_func func)
1815 {
1816         assert(op->ops.generic == NULL);
1817         op->ops.generic = (op_func) func;
1818 }
1819
1820 /**
1821  * Create a new x87 simulator.
1822  *
1823  * @param sim       a simulator handle, will be initialized
1824  * @param irg       the current graph
1825  */
1826 static void x87_init_simulator(x87_simulator *sim, ir_graph *irg)
1827 {
1828         obstack_init(&sim->obst);
1829         sim->blk_states = pmap_create();
1830         sim->n_idx      = get_irg_last_idx(irg);
1831         sim->live       = OALLOCN(&sim->obst, vfp_liveness, sim->n_idx);
1832
1833         DB((dbg, LEVEL_1, "--------------------------------\n"
1834                 "x87 Simulator started for %+F\n", irg));
1835
1836         /* set the generic function pointer of instruction we must simulate */
1837         ir_clear_opcodes_generic_func();
1838
1839         register_sim(op_ia32_Asm,          sim_Asm);
1840         register_sim(op_ia32_Call,         sim_Call);
1841         register_sim(op_ia32_vfld,         sim_fld);
1842         register_sim(op_ia32_vfild,        sim_fild);
1843         register_sim(op_ia32_vfld1,        sim_fld1);
1844         register_sim(op_ia32_vfldz,        sim_fldz);
1845         register_sim(op_ia32_vfadd,        sim_fadd);
1846         register_sim(op_ia32_vfsub,        sim_fsub);
1847         register_sim(op_ia32_vfmul,        sim_fmul);
1848         register_sim(op_ia32_vfdiv,        sim_fdiv);
1849         register_sim(op_ia32_vfprem,       sim_fprem);
1850         register_sim(op_ia32_vfabs,        sim_fabs);
1851         register_sim(op_ia32_vfchs,        sim_fchs);
1852         register_sim(op_ia32_vfist,        sim_fist);
1853         register_sim(op_ia32_vfisttp,      sim_fisttp);
1854         register_sim(op_ia32_vfst,         sim_fst);
1855         register_sim(op_ia32_vFtstFnstsw,  sim_FtstFnstsw);
1856         register_sim(op_ia32_vFucomFnstsw, sim_Fucom);
1857         register_sim(op_ia32_vFucomi,      sim_Fucom);
1858         register_sim(op_be_Copy,           sim_Copy);
1859         register_sim(op_be_Return,         sim_Return);
1860         register_sim(op_be_Perm,           sim_Perm);
1861         register_sim(op_be_Keep,           sim_Keep);
1862 }
1863
1864 /**
1865  * Destroy a x87 simulator.
1866  *
1867  * @param sim  the simulator handle
1868  */
1869 static void x87_destroy_simulator(x87_simulator *sim)
1870 {
1871         pmap_destroy(sim->blk_states);
1872         obstack_free(&sim->obst, NULL);
1873         DB((dbg, LEVEL_1, "x87 Simulator stopped\n\n"));
1874 }
1875
1876 /**
1877  * Pre-block walker: calculate the liveness information for the block
1878  * and store it into the sim->live cache.
1879  */
1880 static void update_liveness_walker(ir_node *block, void *data)
1881 {
1882         x87_simulator *sim = (x87_simulator*)data;
1883         update_liveness(sim, block);
1884 }
1885
1886 /*
1887  * Run a simulation and fix all virtual instructions for a graph.
1888  * Replaces all virtual floating point instructions and registers
1889  * by real ones.
1890  */
1891 void ia32_x87_simulate_graph(ir_graph *irg)
1892 {
1893         /* TODO improve code quality (less executed fxch) by using execfreqs */
1894
1895         ir_node       *block, *start_block;
1896         blk_state     *bl_state;
1897         x87_simulator sim;
1898
1899         /* create the simulator */
1900         x87_init_simulator(&sim, irg);
1901
1902         start_block = get_irg_start_block(irg);
1903         bl_state    = x87_get_bl_state(&sim, start_block);
1904
1905         /* start with the empty state */
1906         empty.sim       = &sim;
1907         bl_state->begin = &empty;
1908
1909         sim.worklist = new_waitq();
1910         waitq_put(sim.worklist, start_block);
1911
1912         be_assure_live_sets(irg);
1913         sim.lv = be_get_irg_liveness(irg);
1914
1915         /* Calculate the liveness for all nodes. We must precalculate this info,
1916          * because the simulator adds new nodes (possible before Phi nodes) which
1917          * would let a lazy calculation fail.
1918          * On the other hand we reduce the computation amount due to
1919          * precaching from O(n^2) to O(n) at the expense of O(n) cache memory.
1920          */
1921         irg_block_walk_graph(irg, update_liveness_walker, NULL, &sim);
1922
1923         /* iterate */
1924         do {
1925                 block = (ir_node*)waitq_get(sim.worklist);
1926                 x87_simulate_block(&sim, block);
1927         } while (! waitq_empty(sim.worklist));
1928
1929         /* kill it */
1930         del_waitq(sim.worklist);
1931         x87_destroy_simulator(&sim);
1932 }
1933
1934 /* Initializes the x87 simulator. */
1935 void ia32_init_x87(void)
1936 {
1937         FIRM_DBG_REGISTER(dbg, "firm.be.ia32.x87");
1938 }