rework schedulers to register similar like regallocators/spillers
[libfirm] / ir / be / bespillutil.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       implementation of the spill/reload placement abstraction layer
23  * @author      Daniel Grund, Sebastian Hack, Matthias Braun
24  * @date        29.09.2005
25  * @version     $Id$
26  */
27 #include "config.h"
28
29 #include <stdlib.h>
30 #include <stdbool.h>
31
32 #include "pset.h"
33 #include "irnode_t.h"
34 #include "ircons_t.h"
35 #include "iredges_t.h"
36 #include "irbackedge_t.h"
37 #include "irprintf.h"
38 #include "ident_t.h"
39 #include "type_t.h"
40 #include "entity_t.h"
41 #include "debug.h"
42 #include "irgwalk.h"
43 #include "array.h"
44 #include "pdeq.h"
45 #include "execfreq.h"
46 #include "irnodeset.h"
47 #include "error.h"
48
49 #include "bearch.h"
50 #include "belive_t.h"
51 #include "besched.h"
52 #include "bespill.h"
53 #include "bespillutil.h"
54 #include "belive_t.h"
55 #include "benode.h"
56 #include "bechordal_t.h"
57 #include "bestatevent.h"
58 #include "bessaconstr.h"
59 #include "beirg.h"
60 #include "beirgmod.h"
61 #include "beintlive_t.h"
62 #include "bemodule.h"
63 #include "be_t.h"
64
65 DEBUG_ONLY(static firm_dbg_module_t *dbg = NULL;)
66
67 #define REMAT_COST_INFINITE  1000
68
69 typedef struct reloader_t reloader_t;
70 struct reloader_t {
71         reloader_t *next;
72         ir_node    *can_spill_after;
73         ir_node    *reloader;
74         ir_node    *rematted_node;
75         int         remat_cost_delta; /** costs needed for rematerialization,
76                                            compared to placing a reload */
77 };
78
79 typedef struct spill_t spill_t;
80 struct spill_t {
81         spill_t *next;
82         ir_node *after;  /**< spill has to be placed after this node (or earlier) */
83         ir_node *spill;
84 };
85
86 typedef struct spill_info_t spill_info_t;
87 struct spill_info_t {
88         ir_node    *to_spill;  /**< the value that should get spilled */
89         reloader_t *reloaders; /**< list of places where the value should get
90                                     reloaded */
91         spill_t    *spills;    /**< list of latest places where spill must be
92                                     placed */
93         double      spill_costs; /**< costs needed for spilling the value */
94         const arch_register_class_t *reload_cls; /** the register class in which the
95                                                      reload should be placed */
96 };
97
98 struct spill_env_t {
99         const arch_env_t *arch_env;
100         ir_graph         *irg;
101         struct obstack    obst;
102         int               spill_cost;     /**< the cost of a single spill node */
103         int               reload_cost;    /**< the cost of a reload node */
104         set              *spills;         /**< all spill_info_t's, which must be
105                                                placed */
106         ir_nodeset_t      mem_phis;       /**< set of all spilled phis. */
107         ir_exec_freq     *exec_freq;
108
109 #ifdef FIRM_STATISTICS
110         unsigned          spill_count;
111         unsigned          reload_count;
112         unsigned          remat_count;
113         unsigned          spilled_phi_count;
114 #endif
115 };
116
117 /**
118  * Compare two spill infos.
119  */
120 static int cmp_spillinfo(const void *x, const void *y, size_t size)
121 {
122         const spill_info_t *xx = (const spill_info_t*)x;
123         const spill_info_t *yy = (const spill_info_t*)y;
124         (void) size;
125
126         return xx->to_spill != yy->to_spill;
127 }
128
129 /**
130  * Returns spill info for a specific value (the value that is to be spilled)
131  */
132 static spill_info_t *get_spillinfo(const spill_env_t *env, ir_node *value)
133 {
134         spill_info_t info, *res;
135         int hash = hash_irn(value);
136
137         info.to_spill = value;
138         res = (spill_info_t*)set_find(env->spills, &info, sizeof(info), hash);
139
140         if (res == NULL) {
141                 info.reloaders   = NULL;
142                 info.spills      = NULL;
143                 info.spill_costs = -1;
144                 info.reload_cls  = NULL;
145                 res = (spill_info_t*)set_insert(env->spills, &info, sizeof(info), hash);
146         }
147
148         return res;
149 }
150
151 spill_env_t *be_new_spill_env(ir_graph *irg)
152 {
153         const arch_env_t *arch_env = be_get_irg_arch_env(irg);
154
155         spill_env_t *env = XMALLOC(spill_env_t);
156         env->spills         = new_set(cmp_spillinfo, 1024);
157         env->irg            = irg;
158         env->arch_env       = arch_env;
159         ir_nodeset_init(&env->mem_phis);
160         env->spill_cost     = arch_env->spill_cost;
161         env->reload_cost    = arch_env->reload_cost;
162         env->exec_freq      = be_get_irg_exec_freq(irg);
163         obstack_init(&env->obst);
164
165 #ifdef FIRM_STATISTICS
166         env->spill_count       = 0;
167         env->reload_count      = 0;
168         env->remat_count       = 0;
169         env->spilled_phi_count = 0;
170 #endif
171
172         return env;
173 }
174
175 void be_delete_spill_env(spill_env_t *env)
176 {
177         del_set(env->spills);
178         ir_nodeset_destroy(&env->mem_phis);
179         obstack_free(&env->obst, NULL);
180         free(env);
181 }
182
183 /*
184  *  ____  _                  ____      _                 _
185  * |  _ \| | __ _  ___ ___  |  _ \ ___| | ___   __ _  __| |___
186  * | |_) | |/ _` |/ __/ _ \ | |_) / _ \ |/ _ \ / _` |/ _` / __|
187  * |  __/| | (_| | (_|  __/ |  _ <  __/ | (_) | (_| | (_| \__ \
188  * |_|   |_|\__,_|\___\___| |_| \_\___|_|\___/ \__,_|\__,_|___/
189  *
190  */
191
192 void be_add_spill(spill_env_t *env, ir_node *to_spill, ir_node *after)
193 {
194         spill_info_t  *spill_info = get_spillinfo(env, to_spill);
195         spill_t       *spill;
196         spill_t       *s;
197         spill_t       *last;
198
199         assert(!arch_irn_is(skip_Proj_const(to_spill), dont_spill));
200         DB((dbg, LEVEL_1, "Add spill of %+F after %+F\n", to_spill, after));
201
202         /* Just for safety make sure that we do not insert the spill in front of a phi */
203         assert(!is_Phi(sched_next(after)));
204
205         /* spills that are dominated by others are not needed */
206         last = NULL;
207         s    = spill_info->spills;
208         for ( ; s != NULL; s = s->next) {
209                 /* no need to add this spill if it is dominated by another */
210                 if (value_dominates(s->after, after)) {
211                         DB((dbg, LEVEL_1, "...dominated by %+F, not added\n", s->after));
212                         return;
213                 }
214                 /* remove spills that we dominate */
215                 if (value_dominates(after, s->after)) {
216                         DB((dbg, LEVEL_1, "...remove old spill at %+F\n", s->after));
217                         if (last != NULL) {
218                                 last->next         = s->next;
219                         } else {
220                                 spill_info->spills = s->next;
221                         }
222                 } else {
223                         last = s;
224                 }
225         }
226
227         spill         = OALLOC(&env->obst, spill_t);
228         spill->after  = after;
229         spill->next   = spill_info->spills;
230         spill->spill  = NULL;
231
232         spill_info->spills = spill;
233 }
234
235 void be_add_remat(spill_env_t *env, ir_node *to_spill, ir_node *before,
236                   ir_node *rematted_node)
237 {
238         spill_info_t *spill_info;
239         reloader_t *reloader;
240
241         spill_info = get_spillinfo(env, to_spill);
242
243         /* add the remat information */
244         reloader                   = OALLOC(&env->obst, reloader_t);
245         reloader->next             = spill_info->reloaders;
246         reloader->reloader         = before;
247         reloader->rematted_node    = rematted_node;
248         reloader->remat_cost_delta = 0; /* We will never have a cost win over a
249                                            reload since we're not even allowed to
250                                            create a reload */
251
252         spill_info->reloaders  = reloader;
253
254         DBG((dbg, LEVEL_1, "creating spillinfo for %+F, will be rematerialized before %+F\n",
255                 to_spill, before));
256 }
257
258 void be_add_reload2(spill_env_t *env, ir_node *to_spill, ir_node *before,
259                 ir_node *can_spill_after, const arch_register_class_t *reload_cls,
260                 int allow_remat)
261 {
262         spill_info_t  *info;
263         reloader_t    *rel;
264
265         assert(!arch_irn_is(skip_Proj_const(to_spill), dont_spill));
266
267         info = get_spillinfo(env, to_spill);
268
269         if (is_Phi(to_spill)) {
270                 int i, arity;
271
272                 /* create spillinfos for the phi arguments */
273                 for (i = 0, arity = get_irn_arity(to_spill); i < arity; ++i) {
274                         ir_node *arg = get_irn_n(to_spill, i);
275                         get_spillinfo(env, arg);
276                 }
277         }
278
279         assert(!is_Proj(before) && !be_is_Keep(before));
280
281         /* put reload into list */
282         rel                   = OALLOC(&env->obst, reloader_t);
283         rel->next             = info->reloaders;
284         rel->reloader         = before;
285         rel->rematted_node    = NULL;
286         rel->can_spill_after  = can_spill_after;
287         rel->remat_cost_delta = allow_remat ? 0 : REMAT_COST_INFINITE;
288
289         info->reloaders  = rel;
290         assert(info->reload_cls == NULL || info->reload_cls == reload_cls);
291         info->reload_cls = reload_cls;
292
293         DBG((dbg, LEVEL_1, "creating spillinfo for %+F, will be reloaded before %+F, may%s be rematerialized\n",
294                 to_spill, before, allow_remat ? "" : " not"));
295 }
296
297 void be_add_reload(spill_env_t *senv, ir_node *to_spill, ir_node *before,
298                    const arch_register_class_t *reload_cls, int allow_remat)
299 {
300         be_add_reload2(senv, to_spill, before, to_spill, reload_cls, allow_remat);
301
302 }
303
304 ir_node *be_get_end_of_block_insertion_point(const ir_node *block)
305 {
306         ir_node *last = sched_last(block);
307
308         /* we might have keeps behind the jump... */
309         while (be_is_Keep(last)) {
310                 last = sched_prev(last);
311                 assert(!sched_is_end(last));
312         }
313
314         assert(is_cfop(last));
315
316         /* add the reload before the (cond-)jump */
317         return last;
318 }
319
320 static ir_node *skip_keeps_phis(ir_node *node)
321 {
322         while (true) {
323                 ir_node *next = sched_next(node);
324                 if (!is_Phi(next) && !be_is_Keep(next) && !be_is_CopyKeep(next))
325                         break;
326                 node = next;
327         }
328         return node;
329 }
330
331 /**
332  * Returns the point at which you can insert a node that should be executed
333  * before block @p block when coming from pred @p pos.
334  */
335 static ir_node *get_block_insertion_point(ir_node *block, int pos)
336 {
337         ir_node *predblock;
338
339         /* simply add the reload to the beginning of the block if we only have 1
340          * predecessor. We don't need to check for phis as there can't be any in a
341          * block with only 1 pred. */
342         if (get_Block_n_cfgpreds(block) == 1) {
343                 assert(!is_Phi(sched_first(block)));
344                 return sched_first(block);
345         }
346
347         /* We have to reload the value in pred-block */
348         predblock = get_Block_cfgpred_block(block, pos);
349         return be_get_end_of_block_insertion_point(predblock);
350 }
351
352 void be_add_reload_at_end(spill_env_t *env, ir_node *to_spill,
353                           const ir_node *block,
354                           const arch_register_class_t *reload_cls,
355                           int allow_remat)
356 {
357         ir_node *before = be_get_end_of_block_insertion_point(block);
358         be_add_reload(env, to_spill, before, reload_cls, allow_remat);
359 }
360
361 void be_add_reload_on_edge(spill_env_t *env, ir_node *to_spill, ir_node *block,
362                            int pos, const arch_register_class_t *reload_cls,
363                            int allow_remat)
364 {
365         ir_node *before = get_block_insertion_point(block, pos);
366         be_add_reload(env, to_spill, before, reload_cls, allow_remat);
367 }
368
369 void be_spill_phi(spill_env_t *env, ir_node *node)
370 {
371         ir_node *block;
372         int i, arity;
373
374         assert(is_Phi(node));
375
376         ir_nodeset_insert(&env->mem_phis, node);
377
378         /* create spills for the phi arguments */
379         block = get_nodes_block(node);
380         for (i = 0, arity = get_irn_arity(node); i < arity; ++i) {
381                 ir_node *arg = get_irn_n(node, i);
382                 ir_node *insert;
383
384                 /* some backends have virtual noreg/unknown nodes that are not scheduled
385                  * and simply always available. */
386                 if (!sched_is_scheduled(arg)) {
387                         ir_node *pred_block = get_Block_cfgpred_block(block, i);
388                         insert = be_get_end_of_block_insertion_point(pred_block);
389                         insert = sched_prev(insert);
390                 } else {
391                         insert = skip_keeps_phis(arg);
392                 }
393
394                 be_add_spill(env, arg, insert);
395         }
396 }
397
398 /*
399  *   ____                _         ____        _ _ _
400  *  / ___|_ __ ___  __ _| |_ ___  / ___| _ __ (_) | |___
401  * | |   | '__/ _ \/ _` | __/ _ \ \___ \| '_ \| | | / __|
402  * | |___| | |  __/ (_| | ||  __/  ___) | |_) | | | \__ \
403  *  \____|_|  \___|\__,_|\__\___| |____/| .__/|_|_|_|___/
404  *                                      |_|
405  */
406
407 static void determine_spill_costs(spill_env_t *env, spill_info_t *spillinfo);
408
409 /**
410  * Creates a spill.
411  *
412  * @param senv      the spill environment
413  * @param irn       the node that should be spilled
414  * @param ctx_irn   an user of the spilled node
415  *
416  * @return a be_Spill node
417  */
418 static void spill_irn(spill_env_t *env, spill_info_t *spillinfo)
419 {
420         ir_node       *to_spill = spillinfo->to_spill;
421         const ir_node *insn     = skip_Proj_const(to_spill);
422         spill_t *spill;
423
424         /* determine_spill_costs must have been run before */
425         assert(spillinfo->spill_costs >= 0);
426
427         /* some backends have virtual noreg/unknown nodes that are not scheduled
428          * and simply always available. */
429         if (!sched_is_scheduled(insn)) {
430                 /* override spillinfos or create a new one */
431                 ir_graph *irg = get_irn_irg(to_spill);
432                 spillinfo->spills->spill = new_r_NoMem(irg);
433                 DB((dbg, LEVEL_1, "don't spill %+F use NoMem\n", to_spill));
434                 return;
435         }
436
437         DBG((dbg, LEVEL_1, "spilling %+F ... \n", to_spill));
438         spill = spillinfo->spills;
439         for ( ; spill != NULL; spill = spill->next) {
440                 ir_node *after = spill->after;
441                 ir_node *block = get_block(after);
442
443                 after = skip_keeps_phis(after);
444
445                 spill->spill = be_spill(block, to_spill);
446                 sched_add_after(skip_Proj(after), spill->spill);
447                 DB((dbg, LEVEL_1, "\t%+F after %+F\n", spill->spill, after));
448 #ifdef FIRM_STATISTICS
449                 env->spill_count++;
450 #endif
451         }
452         DBG((dbg, LEVEL_1, "\n"));
453 }
454
455 static void spill_node(spill_env_t *env, spill_info_t *spillinfo);
456
457 /**
458  * If the first usage of a Phi result would be out of memory
459  * there is no sense in allocating a register for it.
460  * Thus we spill it and all its operands to the same spill slot.
461  * Therefore the phi/dataB becomes a phi/Memory
462  *
463  * @param senv      the spill environment
464  * @param phi       the Phi node that should be spilled
465  * @param ctx_irn   an user of the spilled node
466  */
467 static void spill_phi(spill_env_t *env, spill_info_t *spillinfo)
468 {
469         ir_graph *irg   = env->irg;
470         ir_node  *phi   = spillinfo->to_spill;
471         ir_node  *block = get_nodes_block(phi);
472         ir_node  *unknown;
473         ir_node **ins;
474         spill_t  *spill;
475         int       i;
476         int       arity;
477
478         assert(is_Phi(phi));
479         assert(!get_opt_cse());
480         DBG((dbg, LEVEL_1, "spilling Phi %+F:\n", phi));
481
482         /* build a new PhiM */
483         arity   = get_irn_arity(phi);
484         ins     = ALLOCAN(ir_node*, arity);
485         unknown = new_r_Unknown(irg, mode_M);
486         for (i = 0; i < arity; ++i) {
487                 ins[i] = unknown;
488         }
489
490         /* override or replace spills list... */
491         spill         = OALLOC(&env->obst, spill_t);
492         spill->after  = skip_keeps_phis(phi);
493         spill->spill  = new_r_Phi(block, arity, ins, mode_M);
494         spill->next   = NULL;
495
496         spillinfo->spills = spill;
497 #ifdef FIRM_STATISTICS
498         env->spilled_phi_count++;
499 #endif
500
501         for (i = 0; i < arity; ++i) {
502                 ir_node      *arg      = get_irn_n(phi, i);
503                 spill_info_t *arg_info = get_spillinfo(env, arg);
504
505                 determine_spill_costs(env, arg_info);
506                 spill_node(env, arg_info);
507
508                 set_irn_n(spill->spill, i, arg_info->spills->spill);
509         }
510         DBG((dbg, LEVEL_1, "... done spilling Phi %+F, created PhiM %+F\n", phi,
511              spill->spill));
512 }
513
514 /**
515  * Spill a node.
516  *
517  * @param senv      the spill environment
518  * @param to_spill  the node that should be spilled
519  */
520 static void spill_node(spill_env_t *env, spill_info_t *spillinfo)
521 {
522         ir_node *to_spill;
523
524         /* node is already spilled */
525         if (spillinfo->spills != NULL && spillinfo->spills->spill != NULL)
526                 return;
527
528         to_spill = spillinfo->to_spill;
529
530         if (is_Phi(to_spill) && ir_nodeset_contains(&env->mem_phis, to_spill)) {
531                 spill_phi(env, spillinfo);
532         } else {
533                 spill_irn(env, spillinfo);
534         }
535 }
536
537 /*
538  *
539  *  ____                      _            _       _ _
540  * |  _ \ ___ _ __ ___   __ _| |_ ___ _ __(_) __ _| (_)_______
541  * | |_) / _ \ '_ ` _ \ / _` | __/ _ \ '__| |/ _` | | |_  / _ \
542  * |  _ <  __/ | | | | | (_| | ||  __/ |  | | (_| | | |/ /  __/
543  * |_| \_\___|_| |_| |_|\__,_|\__\___|_|  |_|\__,_|_|_/___\___|
544  *
545  */
546
547 /**
548  * Tests whether value @p arg is available before node @p reloader
549  * @returns 1 if value is available, 0 otherwise
550  */
551 static int is_value_available(spill_env_t *env, const ir_node *arg,
552                               const ir_node *reloader)
553 {
554         if (is_Unknown(arg) || is_NoMem(arg))
555                 return 1;
556
557         if (be_is_Spill(skip_Proj_const(arg)))
558                 return 1;
559
560         if (arg == get_irg_frame(env->irg))
561                 return 1;
562
563         (void)reloader;
564
565         if (get_irn_mode(arg) == mode_T)
566                 return 0;
567
568         /*
569          * Ignore registers are always available
570          */
571         if (arch_irn_is_ignore(arg))
572                 return 1;
573
574         return 0;
575 }
576
577 /**
578  * Check if a node is rematerializable. This tests for the following conditions:
579  *
580  * - The node itself is rematerializable
581  * - All arguments of the node are available or also rematerialisable
582  * - The costs for the rematerialisation operation is less or equal a limit
583  *
584  * Returns the costs needed for rematerialisation or something
585  * >= REMAT_COST_INFINITE if remat is not possible.
586  */
587 static int check_remat_conditions_costs(spill_env_t *env,
588                 const ir_node *spilled, const ir_node *reloader, int parentcosts)
589 {
590         int i, arity;
591         int argremats;
592         int costs = 0;
593         const ir_node *insn = skip_Proj_const(spilled);
594
595         assert(!be_is_Spill(insn));
596         if (!arch_irn_is(insn, rematerializable))
597                 return REMAT_COST_INFINITE;
598
599         if (be_is_Reload(insn)) {
600                 costs += 2;
601         } else {
602                 costs += arch_get_op_estimated_cost(insn);
603         }
604         if (parentcosts + costs >= env->reload_cost + env->spill_cost) {
605                 return REMAT_COST_INFINITE;
606         }
607         /* never rematerialize a node which modifies the flags.
608          * (would be better to test wether the flags are actually live at point
609          * reloader...)
610          */
611         if (arch_irn_is(insn, modify_flags)) {
612                 return REMAT_COST_INFINITE;
613         }
614
615         argremats = 0;
616         for (i = 0, arity = get_irn_arity(insn); i < arity; ++i) {
617                 ir_node *arg = get_irn_n(insn, i);
618
619                 if (is_value_available(env, arg, reloader))
620                         continue;
621
622                 /* we have to rematerialize the argument as well */
623                 ++argremats;
624                 if (argremats > 1) {
625                         /* we only support rematerializing 1 argument at the moment,
626                          * as multiple arguments could increase register pressure */
627                         return REMAT_COST_INFINITE;
628                 }
629
630                 costs += check_remat_conditions_costs(env, arg, reloader,
631                                                       parentcosts + costs);
632                 if (parentcosts + costs >= env->reload_cost + env->spill_cost)
633                         return REMAT_COST_INFINITE;
634         }
635
636         return costs;
637 }
638
639 /**
640  * Re-materialize a node.
641  *
642  * @param senv      the spill environment
643  * @param spilled   the node that was spilled
644  * @param reloader  a irn that requires a reload
645  */
646 static ir_node *do_remat(spill_env_t *env, ir_node *spilled, ir_node *reloader)
647 {
648         int i, arity;
649         ir_node *res;
650         ir_node *bl;
651         ir_node **ins;
652
653         if (is_Block(reloader)) {
654                 bl = reloader;
655         } else {
656                 bl = get_nodes_block(reloader);
657         }
658
659         ins = ALLOCAN(ir_node*, get_irn_arity(spilled));
660         for (i = 0, arity = get_irn_arity(spilled); i < arity; ++i) {
661                 ir_node *arg = get_irn_n(spilled, i);
662
663                 if (is_value_available(env, arg, reloader)) {
664                         ins[i] = arg;
665                 } else {
666                         ins[i] = do_remat(env, arg, reloader);
667 #ifdef FIRM_STATISTICS
668                         /* don't count the recursive call as remat */
669                         env->remat_count--;
670 #endif
671                 }
672         }
673
674         /* create a copy of the node */
675         res = new_ir_node(get_irn_dbg_info(spilled), env->irg, bl,
676                           get_irn_op(spilled), get_irn_mode(spilled),
677                           get_irn_arity(spilled), ins);
678         copy_node_attr(env->irg, spilled, res);
679         arch_env_mark_remat(env->arch_env, res);
680
681         DBG((dbg, LEVEL_1, "Insert remat %+F of %+F before reloader %+F\n", res, spilled, reloader));
682
683         if (! is_Proj(res)) {
684                 /* insert in schedule */
685                 sched_reset(res);
686                 sched_add_before(reloader, res);
687 #ifdef FIRM_STATISTICS
688                 env->remat_count++;
689 #endif
690         }
691
692         return res;
693 }
694
695 double be_get_spill_costs(spill_env_t *env, ir_node *to_spill, ir_node *before)
696 {
697         ir_node *block = get_nodes_block(before);
698         double   freq  = get_block_execfreq(env->exec_freq, block);
699         (void) to_spill;
700
701         return env->spill_cost * freq;
702 }
703
704 unsigned be_get_reload_costs_no_weight(spill_env_t *env, const ir_node *to_spill,
705                                        const ir_node *before)
706 {
707         if (be_do_remats) {
708                 /* is the node rematerializable? */
709                 unsigned costs = check_remat_conditions_costs(env, to_spill, before, 0);
710                 if (costs < (unsigned) env->reload_cost)
711                         return costs;
712         }
713
714         return env->reload_cost;
715 }
716
717 double be_get_reload_costs(spill_env_t *env, ir_node *to_spill, ir_node *before)
718 {
719         ir_node      *block = get_nodes_block(before);
720         double        freq  = get_block_execfreq(env->exec_freq, block);
721
722         if (be_do_remats) {
723                 /* is the node rematerializable? */
724                 int costs = check_remat_conditions_costs(env, to_spill, before, 0);
725                 if (costs < env->reload_cost)
726                         return costs * freq;
727         }
728
729         return env->reload_cost * freq;
730 }
731
732 int be_is_rematerializable(spill_env_t *env, const ir_node *to_remat,
733                            const ir_node *before)
734 {
735         return check_remat_conditions_costs(env, to_remat, before, 0) < REMAT_COST_INFINITE;
736 }
737
738 double be_get_reload_costs_on_edge(spill_env_t *env, ir_node *to_spill,
739                                    ir_node *block, int pos)
740 {
741         ir_node *before = get_block_insertion_point(block, pos);
742         return be_get_reload_costs(env, to_spill, before);
743 }
744
745 /*
746  *  ___                     _     ____      _                 _
747  * |_ _|_ __  ___  ___ _ __| |_  |  _ \ ___| | ___   __ _  __| |___
748  *  | || '_ \/ __|/ _ \ '__| __| | |_) / _ \ |/ _ \ / _` |/ _` / __|
749  *  | || | | \__ \  __/ |  | |_  |  _ <  __/ | (_) | (_| | (_| \__ \
750  * |___|_| |_|___/\___|_|   \__| |_| \_\___|_|\___/ \__,_|\__,_|___/
751  *
752  */
753
754 /**
755  * analyzes how to best spill a node and determine costs for that
756  */
757 static void determine_spill_costs(spill_env_t *env, spill_info_t *spillinfo)
758 {
759         ir_node       *to_spill = spillinfo->to_spill;
760         const ir_node *insn     = skip_Proj_const(to_spill);
761         ir_node       *spill_block;
762         spill_t       *spill;
763         double         spill_execfreq;
764
765         /* already calculated? */
766         if (spillinfo->spill_costs >= 0)
767                 return;
768
769         assert(!arch_irn_is(insn, dont_spill));
770         assert(!be_is_Reload(insn));
771
772         /* some backends have virtual noreg/unknown nodes that are not scheduled
773          * and simply always available.
774          * TODO: this is kinda hairy, the NoMem is correct for an Unknown as Phi
775          * predecessor (of a PhiM) but this test might match other things too...
776          */
777         if (!sched_is_scheduled(insn)) {
778                 ir_graph *irg = get_irn_irg(to_spill);
779                 /* override spillinfos or create a new one */
780                 spill_t *spill = OALLOC(&env->obst, spill_t);
781                 spill->after = NULL;
782                 spill->next  = NULL;
783                 spill->spill = new_r_NoMem(irg);
784
785                 spillinfo->spills      = spill;
786                 spillinfo->spill_costs = 0;
787
788                 DB((dbg, LEVEL_1, "don't spill %+F use NoMem\n", to_spill));
789                 return;
790         }
791
792         spill_block    = get_nodes_block(insn);
793         spill_execfreq = get_block_execfreq(env->exec_freq, spill_block);
794
795         if (is_Phi(to_spill) && ir_nodeset_contains(&env->mem_phis, to_spill)) {
796                 /* TODO calculate correct costs...
797                  * (though we can't remat this node anyway so no big problem) */
798                 spillinfo->spill_costs = env->spill_cost * spill_execfreq;
799                 return;
800         }
801
802         if (spillinfo->spills != NULL) {
803                 spill_t *s;
804                 double   spills_execfreq;
805
806                 /* calculate sum of execution frequencies of individual spills */
807                 spills_execfreq = 0;
808                 s               = spillinfo->spills;
809                 for ( ; s != NULL; s = s->next) {
810                         ir_node *spill_block = get_block(s->after);
811                         double   freq = get_block_execfreq(env->exec_freq, spill_block);
812
813                         spills_execfreq += freq;
814                 }
815
816                 DB((dbg, LEVEL_1, "%+F: latespillcosts %f after def: %f\n", to_spill,
817                     spills_execfreq * env->spill_cost,
818                     spill_execfreq * env->spill_cost));
819
820                 /* multi-/latespill is advantageous -> return*/
821                 if (spills_execfreq < spill_execfreq) {
822                         DB((dbg, LEVEL_1, "use latespills for %+F\n", to_spill));
823                         spillinfo->spill_costs = spills_execfreq * env->spill_cost;
824                         return;
825                 }
826         }
827
828         /* override spillinfos or create a new one */
829         spill        = OALLOC(&env->obst, spill_t);
830         spill->after = skip_keeps_phis(to_spill);
831         spill->next  = NULL;
832         spill->spill = NULL;
833
834         spillinfo->spills      = spill;
835         spillinfo->spill_costs = spill_execfreq * env->spill_cost;
836         DB((dbg, LEVEL_1, "spill %+F after definition\n", to_spill));
837 }
838
839 void make_spill_locations_dominate_irn(spill_env_t *env, ir_node *irn)
840 {
841         const spill_info_t *si = get_spillinfo(env, irn);
842         ir_node *start_block   = get_irg_start_block(get_irn_irg(irn));
843         int n_blocks           = get_Block_dom_max_subtree_pre_num(start_block);
844         bitset_t *reloads      = bitset_alloca(n_blocks);
845         reloader_t *r;
846         spill_t *s;
847
848         if (si == NULL)
849                 return;
850
851         /* Fill the bitset with the dominance pre-order numbers
852          * of the blocks the reloads are located in. */
853         for (r = si->reloaders; r != NULL; r = r->next) {
854                 ir_node *bl = get_nodes_block(r->reloader);
855                 bitset_set(reloads, get_Block_dom_tree_pre_num(bl));
856         }
857
858         /* Now, cancel out all the blocks that are dominated by each spill.
859          * If the bitset is not empty after that, we have reloads that are
860          * not dominated by any spill. */
861         for (s = si->spills; s != NULL; s = s->next) {
862                 ir_node *bl = get_nodes_block(s->after);
863                 int start   = get_Block_dom_tree_pre_num(bl);
864                 int end     = get_Block_dom_max_subtree_pre_num(bl);
865
866                 bitset_clear_range(reloads, start, end);
867         }
868
869         if (!bitset_is_empty(reloads))
870                 be_add_spill(env, si->to_spill, si->to_spill);
871 }
872
873 void be_insert_spills_reloads(spill_env_t *env)
874 {
875         const ir_exec_freq    *exec_freq = env->exec_freq;
876         spill_info_t          *si;
877         ir_nodeset_iterator_t  iter;
878         ir_node               *node;
879
880         be_timer_push(T_RA_SPILL_APPLY);
881
882         /* create all phi-ms first, this is needed so, that phis, hanging on
883            spilled phis work correctly */
884         foreach_ir_nodeset(&env->mem_phis, node, iter) {
885                 spill_info_t *info = get_spillinfo(env, node);
886                 spill_node(env, info);
887         }
888
889         /* process each spilled node */
890         foreach_set(env->spills, spill_info_t*, si) {
891                 reloader_t *rld;
892                 ir_node  *to_spill        = si->to_spill;
893                 ir_mode  *mode            = get_irn_mode(to_spill);
894                 ir_node **copies          = NEW_ARR_F(ir_node*, 0);
895                 double    all_remat_costs = 0; /** costs when we would remat all nodes */
896                 int       force_remat     = 0;
897
898                 DBG((dbg, LEVEL_1, "\nhandling all reloaders of %+F:\n", to_spill));
899
900                 determine_spill_costs(env, si);
901
902                 /* determine possibility of rematerialisations */
903                 if (be_do_remats) {
904                         /* calculate cost savings for each indivial value when it would
905                            be rematted instead of reloaded */
906                         for (rld = si->reloaders; rld != NULL; rld = rld->next) {
907                                 double   freq;
908                                 int      remat_cost;
909                                 int      remat_cost_delta;
910                                 ir_node *block;
911                                 ir_node *reloader = rld->reloader;
912
913                                 if (rld->rematted_node != NULL) {
914                                         DBG((dbg, LEVEL_2, "\tforced remat %+F before %+F\n",
915                                              rld->rematted_node, reloader));
916                                         continue;
917                                 }
918                                 if (rld->remat_cost_delta >= REMAT_COST_INFINITE) {
919                                         DBG((dbg, LEVEL_2, "\treload before %+F is forbidden\n",
920                                              reloader));
921                                         all_remat_costs = REMAT_COST_INFINITE;
922                                         continue;
923                                 }
924
925                                 remat_cost  = check_remat_conditions_costs(env, to_spill,
926                                                                            reloader, 0);
927                                 if (remat_cost >= REMAT_COST_INFINITE) {
928                                         DBG((dbg, LEVEL_2, "\tremat before %+F not possible\n",
929                                              reloader));
930                                         rld->remat_cost_delta = REMAT_COST_INFINITE;
931                                         all_remat_costs       = REMAT_COST_INFINITE;
932                                         continue;
933                                 }
934
935                                 remat_cost_delta      = remat_cost - env->reload_cost;
936                                 rld->remat_cost_delta = remat_cost_delta;
937                                 block                 = is_Block(reloader) ? reloader : get_nodes_block(reloader);
938                                 freq                  = get_block_execfreq(exec_freq, block);
939                                 all_remat_costs      += remat_cost_delta * freq;
940                                 DBG((dbg, LEVEL_2, "\tremat costs delta before %+F: "
941                                      "%d (rel %f)\n", reloader, remat_cost_delta,
942                                      remat_cost_delta * freq));
943                         }
944                         if (all_remat_costs < REMAT_COST_INFINITE) {
945                                 /* we don't need the costs for the spill if we can remat
946                                    all reloaders */
947                                 all_remat_costs -= si->spill_costs;
948
949                                 DBG((dbg, LEVEL_2, "\tspill costs %d (rel %f)\n",
950                                      env->spill_cost, si->spill_costs));
951                         }
952
953                         if (all_remat_costs < 0) {
954                                 DBG((dbg, LEVEL_1, "\nforcing remats of all reloaders (%f)\n",
955                                      all_remat_costs));
956                                 force_remat = 1;
957                         }
958                 }
959
960                 /* go through all reloads for this spill */
961                 for (rld = si->reloaders; rld != NULL; rld = rld->next) {
962                         ir_node *copy; /* a reload is a "copy" of the original value */
963
964                         if (rld->rematted_node != NULL) {
965                                 copy = rld->rematted_node;
966                                 sched_add_before(rld->reloader, copy);
967                         } else if (be_do_remats &&
968                                         (force_remat || rld->remat_cost_delta < 0)) {
969                                 copy = do_remat(env, to_spill, rld->reloader);
970                         } else {
971                                 /* make sure we have a spill */
972                                 spill_node(env, si);
973
974                                 /* create a reload, use the first spill for now SSA
975                                  * reconstruction for memory comes below */
976                                 assert(si->spills != NULL);
977                                 copy = be_reload(si->reload_cls, rld->reloader, mode,
978                                                  si->spills->spill);
979 #ifdef FIRM_STATISTICS
980                                 env->reload_count++;
981 #endif
982                         }
983
984                         DBG((dbg, LEVEL_1, " %+F of %+F before %+F\n",
985                              copy, to_spill, rld->reloader));
986                         ARR_APP1(ir_node*, copies, copy);
987                 }
988
989                 /* if we had any reloads or remats, then we need to reconstruct the
990                  * SSA form for the spilled value */
991                 if (ARR_LEN(copies) > 0) {
992                         be_ssa_construction_env_t senv;
993                         /* be_lv_t *lv = be_get_irg_liveness(env->irg); */
994
995                         be_ssa_construction_init(&senv, env->irg);
996                         be_ssa_construction_add_copy(&senv, to_spill);
997                         be_ssa_construction_add_copies(&senv, copies, ARR_LEN(copies));
998                         be_ssa_construction_fix_users(&senv, to_spill);
999
1000 #if 0
1001                         /* no need to enable this as long as we invalidate liveness
1002                            after this function... */
1003                         be_ssa_construction_update_liveness_phis(&senv);
1004                         be_liveness_update(to_spill);
1005                         len = ARR_LEN(copies);
1006                         for (i = 0; i < len; ++i) {
1007                                 be_liveness_update(lv, copies[i]);
1008                         }
1009 #endif
1010                         be_ssa_construction_destroy(&senv);
1011                 }
1012                 /* need to reconstruct SSA form if we had multiple spills */
1013                 if (si->spills != NULL && si->spills->next != NULL) {
1014                         spill_t *spill;
1015                         int      spill_count = 0;
1016
1017                         be_ssa_construction_env_t senv;
1018
1019                         be_ssa_construction_init(&senv, env->irg);
1020                         spill = si->spills;
1021                         for ( ; spill != NULL; spill = spill->next) {
1022                                 /* maybe we rematerialized the value and need no spill */
1023                                 if (spill->spill == NULL)
1024                                         continue;
1025                                 be_ssa_construction_add_copy(&senv, spill->spill);
1026                                 spill_count++;
1027                         }
1028                         if (spill_count > 1) {
1029                                 /* all reloads are attached to the first spill, fix them now */
1030                                 be_ssa_construction_fix_users(&senv, si->spills->spill);
1031                         }
1032
1033                         be_ssa_construction_destroy(&senv);
1034                 }
1035
1036                 DEL_ARR_F(copies);
1037                 si->reloaders = NULL;
1038         }
1039
1040         stat_ev_dbl("spill_spills", env->spill_count);
1041         stat_ev_dbl("spill_reloads", env->reload_count);
1042         stat_ev_dbl("spill_remats", env->remat_count);
1043         stat_ev_dbl("spill_spilled_phis", env->spilled_phi_count);
1044
1045         /* Matze: In theory be_ssa_construction should take care of the liveness...
1046          * try to disable this again in the future */
1047         be_liveness_invalidate(be_get_irg_liveness(env->irg));
1048
1049         be_remove_dead_nodes_from_schedule(env->irg);
1050
1051         be_timer_pop(T_RA_SPILL_APPLY);
1052 }
1053
1054 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_spill);
1055 void be_init_spill(void)
1056 {
1057         FIRM_DBG_REGISTER(dbg, "firm.be.spill");
1058 }