More missing config.h
[libfirm] / ir / be / bespill.c
1 /*
2  * Author:      Daniel Grund, Sebastian Hack, Matthias Braun
3  * Date:                29.09.2005
4  * Copyright:   (c) Universitaet Karlsruhe
5  * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
6  */
7 #ifdef HAVE_CONFIG_H
8 #include "config.h"
9 #endif
10
11 #include <stdlib.h>
12
13 #include "pset.h"
14 #include "irnode_t.h"
15 #include "ircons_t.h"
16 #include "iredges_t.h"
17 #include "irbackedge_t.h"
18 #include "irprintf.h"
19 #include "ident_t.h"
20 #include "type_t.h"
21 #include "entity_t.h"
22 #include "debug.h"
23 #include "irgwalk.h"
24 #include "array.h"
25 #include "pdeq.h"
26 #include "unionfind.h"
27 #include "execfreq.h"
28
29 #include "belive_t.h"
30 #include "besched_t.h"
31 #include "bespill.h"
32 #include "belive_t.h"
33 #include "benode_t.h"
34 #include "bechordal_t.h"
35 #include "bejavacoal.h"
36 #include "benodesets.h"
37 #include "bespilloptions.h"
38 #include "bestatevent.h"
39
40 // only rematerialise when costs are less than REMAT_COST_LIMIT
41 // TODO determine a good value here...
42 #define REMAT_COST_LIMIT        10
43
44 typedef struct _reloader_t reloader_t;
45
46 struct _reloader_t {
47         reloader_t *next;
48         ir_node *reloader;
49 };
50
51 typedef struct _spill_info_t {
52         /** the value that should get spilled */
53         ir_node *spilled_node;
54         /** list of places where the value should get reloaded */
55         reloader_t *reloaders;
56
57         /** the spill node, or a PhiM node */
58         ir_node *spill;
59         /** if we had the value of a phi spilled before but not the phi itself then
60          * this field contains the spill for the phi value */
61         ir_node *old_spill;
62 } spill_info_t;
63
64 struct _spill_env_t {
65         const arch_register_class_t *cls;
66         const arch_env_t *arch_env;
67         const be_chordal_env_t *chordal_env;
68         struct obstack obst;
69         int spill_cost;     /**< the cost of a single spill node */
70         int reload_cost;    /**< the cost of a reload node */
71         set *spills;        /**< all spill_info_t's, which must be placed */
72         pset *mem_phis;     /**< set of all special spilled phis. allocated and freed separately */
73
74         DEBUG_ONLY(firm_dbg_module_t *dbg;)
75 };
76
77 /**
78  * Compare two spill infos.
79  */
80 static int cmp_spillinfo(const void *x, const void *y, size_t size) {
81         const spill_info_t *xx = x;
82         const spill_info_t *yy = y;
83         return xx->spilled_node != yy->spilled_node;
84 }
85
86 /**
87  * Returns spill info for a specific value (returns NULL if the info doesn't
88  * exist yet)
89  */
90 static spill_info_t *find_spillinfo(const spill_env_t *env, ir_node *value) {
91         spill_info_t info;
92         int hash = nodeset_hash(value);
93
94         info.spilled_node = value;
95
96         return set_find(env->spills, &info, sizeof(info), hash);
97 }
98
99 /**
100  * Returns spill info for a specific value (the value that is to be spilled)
101  */
102 static spill_info_t *get_spillinfo(const spill_env_t *env, ir_node *value) {
103         spill_info_t info, *res;
104         int hash = nodeset_hash(value);
105
106         info.spilled_node = value;
107         res = set_find(env->spills, &info, sizeof(info), hash);
108
109         if (res == NULL) {
110                 info.reloaders = NULL;
111                 info.spill = NULL;
112                 info.old_spill = NULL;
113                 res = set_insert(env->spills, &info, sizeof(info), hash);
114         }
115
116         return res;
117 }
118
119 DEBUG_ONLY(
120 /* Sets the debug module of a spill environment. */
121 void be_set_spill_env_dbg_module(spill_env_t *env, firm_dbg_module_t *dbg) {
122         env->dbg = dbg;
123 }
124 )
125
126 /* Creates a new spill environment. */
127 spill_env_t *be_new_spill_env(const be_chordal_env_t *chordal_env) {
128         spill_env_t *env        = xmalloc(sizeof(env[0]));
129         env->spills                     = new_set(cmp_spillinfo, 1024);
130         env->cls                        = chordal_env->cls;
131         env->chordal_env        = chordal_env;
132         env->arch_env       = env->chordal_env->birg->main_env->arch_env;
133         env->mem_phis           = pset_new_ptr_default();
134         // TODO, ask backend about costs...
135         env->spill_cost     = 8;
136         env->reload_cost    = 5;
137         obstack_init(&env->obst);
138         return env;
139 }
140
141 /* Deletes a spill environment. */
142 void be_delete_spill_env(spill_env_t *env) {
143         del_set(env->spills);
144         del_pset(env->mem_phis);
145         obstack_free(&env->obst, NULL);
146         free(env);
147 }
148
149 /*
150  *  ____  _                  ____      _                 _
151  * |  _ \| | __ _  ___ ___  |  _ \ ___| | ___   __ _  __| |___
152  * | |_) | |/ _` |/ __/ _ \ | |_) / _ \ |/ _ \ / _` |/ _` / __|
153  * |  __/| | (_| | (_|  __/ |  _ <  __/ | (_) | (_| | (_| \__ \
154  * |_|   |_|\__,_|\___\___| |_| \_\___|_|\___/ \__,_|\__,_|___/
155  *
156  */
157
158 void be_add_reload(spill_env_t *env, ir_node *to_spill, ir_node *before) {
159         spill_info_t *info;
160         reloader_t *rel;
161
162         assert(arch_irn_consider_in_reg_alloc(env->arch_env, env->cls, to_spill));
163
164         info = get_spillinfo(env, to_spill);
165
166         if(is_Phi(to_spill)) {
167                 int i, arity;
168                 // create spillinfos for the phi arguments
169                 for(i = 0, arity = get_irn_arity(to_spill); i < arity; ++i) {
170                         ir_node *arg = get_irn_n(to_spill, i);
171                         get_spillinfo(env, arg);
172                 }
173
174 #if 1
175                 // hackery... sometimes the morgan algo spilled the value of a phi,
176                 // the belady algo decides later to spill the whole phi, then sees the
177                 // spill node and adds a reload for that spill node, problem is the
178                 // reload gets attach to that same spill (and is totally unnecessary)
179                 if(info->old_spill != NULL &&
180                         (before == info->old_spill || value_dominates(before, info->old_spill))) {
181                         printf("spilledphi hack was needed...\n");
182                         before = sched_next(info->old_spill);
183                 }
184 #endif
185         }
186
187         rel           = obstack_alloc(&env->obst, sizeof(rel[0]));
188         rel->reloader = before;
189         rel->next     = info->reloaders;
190         info->reloaders = rel;
191 }
192
193 static ir_node *get_reload_insertion_point(ir_node *block, int pos) {
194         ir_node *predblock, *last;
195
196         /* simply add the reload to the beginning of the block if we only have 1 predecessor
197          * (we don't need to check for phis as there can't be any in a block with only 1 pred)
198          */
199         if(get_Block_n_cfgpreds(block) == 1) {
200                 assert(!is_Phi(sched_first(block)));
201                 return sched_first(block);
202         }
203
204         /* We have to reload the value in pred-block */
205         predblock = get_Block_cfgpred_block(block, pos);
206         last = sched_last(predblock);
207
208         /* we might have projs and keepanys behind the jump... */
209         while(is_Proj(last) || be_is_Keep(last)) {
210                 last = sched_prev(last);
211                 assert(!sched_is_end(last));
212         }
213
214         if(!is_cfop(last)) {
215                 ir_graph *irg = get_irn_irg(block);
216                 ir_node *startblock = get_irg_start_block(irg);
217
218                 last = sched_next(last);
219                 // last node must be a cfop, only exception is the start block
220                 assert(last     == startblock);
221         }
222
223         // add the reload before the (cond-)jump
224         return last;
225 }
226
227 void be_add_reload_on_edge(spill_env_t *env, ir_node *to_spill, ir_node *block, int pos) {
228         ir_node *before = get_reload_insertion_point(block, pos);
229         be_add_reload(env, to_spill, before);
230 }
231
232 void be_spill_phi(spill_env_t *env, ir_node *node) {
233         spill_info_t* spill;
234         int i, arity;
235
236         assert(is_Phi(node));
237
238         pset_insert_ptr(env->mem_phis, node);
239
240         // create spillinfos for the phi arguments
241         spill = get_spillinfo(env, node);
242         for(i = 0, arity = get_irn_arity(node); i < arity; ++i) {
243                 ir_node *arg = get_irn_n(node, i);
244                 get_spillinfo(env, arg);
245         }
246
247         // if we had a spill for the phi value before, then remove this spill from
248         // schedule, as we will remove it in the insert spill/reload phase
249         if(spill->spill != NULL && !is_Phi(spill->spill)) {
250                 assert(spill->old_spill == NULL);
251                 spill->old_spill = spill->spill;
252                 spill->spill = NULL;
253         }
254 }
255
256 /*
257  *   ____                _         ____        _ _ _
258  *  / ___|_ __ ___  __ _| |_ ___  / ___| _ __ (_) | |___
259  * | |   | '__/ _ \/ _` | __/ _ \ \___ \| '_ \| | | / __|
260  * | |___| | |  __/ (_| | ||  __/  ___) | |_) | | | \__ \
261  *  \____|_|  \___|\__,_|\__\___| |____/| .__/|_|_|_|___/
262  *                                      |_|
263  */
264
265 /**
266  * Schedules a node after an instruction. (That is the place after all projs and phis
267  * that are scheduled after the instruction)
268  * This function also skips phi nodes at the beginning of a block
269  */
270 static void sched_add_after_insn(ir_node *sched_after, ir_node *node) {
271         ir_node *next = sched_next(sched_after);
272         while(is_Proj(next) || is_Phi(next)) {
273                 next = sched_next(next);
274         }
275         assert(next != NULL);
276
277         if(sched_is_end(next)) {
278                 sched_add_after(sched_last(get_nodes_block(sched_after)), node);
279         } else {
280                 sched_add_before(next, node);
281         }
282 }
283
284 /**
285  * Creates a spill.
286  *
287  * @param senv      the spill environment
288  * @param irn       the node that should be spilled
289  * @param ctx_irn   an user of the spilled node
290  *
291  * @return a be_Spill node
292  */
293 static void spill_irn(spill_env_t *env, spill_info_t *spillinfo) {
294         ir_node *to_spill = spillinfo->spilled_node;
295
296         DBG((env->dbg, LEVEL_1, "%+F\n", to_spill));
297
298         /* Trying to spill an already spilled value, no need for a new spill
299          * node then, we can simply connect to the same one for this reload
300          *
301          * (although rematerialization code should handle most of these cases
302          * this can still happen when spilling Phis)
303          */
304         if(be_is_Reload(to_spill)) {
305                 spillinfo->spill = get_irn_n(to_spill, be_pos_Reload_mem);
306                 return;
307         }
308
309         if (arch_irn_is(env->arch_env, to_spill, dont_spill)) {
310                 if (env->chordal_env->opts->vrfy_option == BE_CH_VRFY_WARN)
311                         ir_fprintf(stderr, "Verify warning: spilling 'dont_spill' node %+F\n", to_spill);
312                 else if (env->chordal_env->opts->vrfy_option == BE_CH_VRFY_ASSERT)
313                         assert(0 && "Attempt to spill a node marked 'dont_spill'");
314         }
315
316         spillinfo->spill = be_spill(env->arch_env, to_spill);
317         sched_add_after_insn(to_spill, spillinfo->spill);
318 }
319
320 static void spill_node(spill_env_t *env, spill_info_t *spillinfo);
321
322 /**
323  * If the first usage of a Phi result would be out of memory
324  * there is no sense in allocating a register for it.
325  * Thus we spill it and all its operands to the same spill slot.
326  * Therefore the phi/dataB becomes a phi/Memory
327  *
328  * @param senv      the spill environment
329  * @param phi       the Phi node that should be spilled
330  * @param ctx_irn   an user of the spilled node
331  */
332 static void spill_phi(spill_env_t *env, spill_info_t *spillinfo) {
333         ir_node *phi = spillinfo->spilled_node;
334         int i;
335         int arity = get_irn_arity(phi);
336         ir_node     *block    = get_nodes_block(phi);
337         ir_node     **ins;
338
339         assert(is_Phi(phi));
340
341         /* build a new PhiM */
342         ins = alloca(sizeof(ir_node*) * arity);
343         for(i = 0; i < arity; ++i) {
344                 ins[i] = get_irg_bad(env->chordal_env->irg);
345         }
346         spillinfo->spill = new_r_Phi(env->chordal_env->irg, block, arity, ins, mode_M);
347
348         for(i = 0; i < arity; ++i) {
349                 ir_node *arg = get_irn_n(phi, i);
350                 spill_info_t *arg_info = get_spillinfo(env, arg);
351
352                 spill_node(env, arg_info);
353
354                 set_irn_n(spillinfo->spill, i, arg_info->spill);
355         }
356
357         // rewire reloads from old_spill to phi
358         if(spillinfo->old_spill != NULL) {
359                 const ir_edge_t *edge, *next;
360                 ir_node *old_spill = spillinfo->old_spill;
361
362                 foreach_out_edge_safe(old_spill, edge, next) {
363                         ir_node* reload = get_edge_src_irn(edge);
364                         assert(be_is_Reload(reload) || is_Phi(reload));
365                         set_irn_n(reload, get_edge_src_pos(edge), spillinfo->spill);
366                 }
367                 set_irn_n(old_spill, be_pos_Spill_frame, new_Bad());
368                 set_irn_n(old_spill, be_pos_Spill_val, new_Bad());
369                 //sched_remove(old_spill);
370                 spillinfo->old_spill = NULL;
371         }
372 }
373
374 /**
375  * Spill a node.
376  *
377  * @param senv      the spill environment
378  * @param to_spill  the node that should be spilled
379  */
380 static void spill_node(spill_env_t *env, spill_info_t *spillinfo) {
381         ir_node *to_spill;
382
383         // the node should be tagged for spilling already...
384         if(spillinfo->spill != NULL)
385                 return;
386
387         to_spill = spillinfo->spilled_node;
388         if (is_Phi(to_spill) && pset_find_ptr(env->mem_phis, spillinfo->spilled_node)) {
389                 spill_phi(env, spillinfo);
390         } else {
391                 spill_irn(env, spillinfo);
392         }
393 }
394
395 /*
396  *
397  *  ____                      _            _       _ _
398  * |  _ \ ___ _ __ ___   __ _| |_ ___ _ __(_) __ _| (_)_______
399  * | |_) / _ \ '_ ` _ \ / _` | __/ _ \ '__| |/ _` | | |_  / _ \
400  * |  _ <  __/ | | | | | (_| | ||  __/ |  | | (_| | | |/ /  __/
401  * |_| \_\___|_| |_| |_|\__,_|\__\___|_|  |_|\__,_|_|_/___\___|
402  *
403  */
404
405 /**
406  * Tests whether value @p arg is available before node @p reloader
407  * @returns 1 if value is available, 0 otherwise
408  */
409 static int is_value_available(spill_env_t *env, ir_node *arg, ir_node *reloader) {
410         if(is_Unknown(arg) || arg == new_NoMem())
411                 return 1;
412
413         if(be_is_Spill(arg))
414                 return 1;
415
416         if(arg == get_irg_frame(env->chordal_env->irg))
417                 return 1;
418
419         // hack for now (happens when command should be inserted at end of block)
420         if(is_Block(reloader)) {
421                 return 0;
422         }
423
424         /* the following test does not work while spilling,
425          * because the liveness info is not adapted yet to the effects of the
426          * additional spills/reloads.
427          *
428          * So we can only do this test for ignore registers (of our register class)
429          */
430         if(arch_get_irn_reg_class(env->arch_env, arg, -1) == env->chordal_env->cls
431            && arch_irn_is(env->arch_env, arg, ignore)) {
432                 int i, arity;
433
434                 /* we want to remat before the insn reloader
435                  * thus an arguments is alive if
436                  *   - it interferes with the reloaders result
437                  *   - or it is (last-) used by reloader itself
438                  */
439                 if (values_interfere(env->chordal_env->lv, reloader, arg)) {
440                         return 1;
441                 }
442
443                 arity = get_irn_arity(reloader);
444                 for (i = 0; i < arity; ++i) {
445                         ir_node *rel_arg = get_irn_n(reloader, i);
446                         if (rel_arg == arg)
447                                 return 1;
448                 }
449         }
450
451         return 0;
452 }
453
454 /**
455  * Checks whether the node can principally be rematerialized
456  */
457 static int is_remat_node(spill_env_t *env, ir_node *node) {
458         const arch_env_t *arch_env = env->arch_env;
459
460         assert(!be_is_Spill(node));
461
462         if(arch_irn_is(arch_env, node, rematerializable)) {
463                 return 1;
464         }
465
466         if(be_is_StackParam(node))
467                 return 1;
468
469         return 0;
470 }
471
472 /**
473  * Check if a node is rematerializable. This tests for the following conditions:
474  *
475  * - The node itself is rematerializable
476  * - All arguments of the node are available or also rematerialisable
477  * - The costs for the rematerialisation operation is less or equal a limit
478  *
479  * Returns the costs needed for rematerialisation or something
480  * > REMAT_COST_LIMIT if remat is not possible.
481  */
482 static int check_remat_conditions_costs(spill_env_t *env, ir_node *spilled, ir_node *reloader, int parentcosts) {
483         int i, arity;
484         int argremats;
485         int costs = 0;
486
487         if(!is_remat_node(env, spilled))
488                 return REMAT_COST_LIMIT;
489
490         if(be_is_Reload(spilled)) {
491                 costs += 2;
492         } else {
493                 costs += arch_get_op_estimated_cost(env->arch_env, spilled);
494         }
495         if(parentcosts + costs >= REMAT_COST_LIMIT) {
496                 return REMAT_COST_LIMIT;
497         }
498
499         argremats = 0;
500         for(i = 0, arity = get_irn_arity(spilled); i < arity; ++i) {
501                 ir_node *arg = get_irn_n(spilled, i);
502
503                 if(is_value_available(env, arg, reloader))
504                         continue;
505
506                 // we have to rematerialize the argument as well...
507                 if(argremats >= 1) {
508                         /* we only support rematerializing 1 argument at the moment,
509                          * so that we don't have to care about register pressure
510                          */
511                         return REMAT_COST_LIMIT;
512                 }
513                 argremats++;
514
515                 costs += check_remat_conditions_costs(env, arg, reloader, parentcosts + costs);
516                 if(parentcosts + costs >= REMAT_COST_LIMIT)
517                         return REMAT_COST_LIMIT;
518         }
519
520         return costs;
521 }
522
523 static int check_remat_conditions(spill_env_t *env, ir_node *spilled, ir_node *reloader) {
524         int costs = check_remat_conditions_costs(env, spilled, reloader, 0);
525
526         return costs < REMAT_COST_LIMIT;
527 }
528
529 /**
530  * Re-materialize a node.
531  *
532  * @param senv      the spill environment
533  * @param spilled   the node that was spilled
534  * @param reloader  a irn that requires a reload
535  */
536 static ir_node *do_remat(spill_env_t *env, ir_node *spilled, ir_node *reloader) {
537         int i, arity;
538         ir_node *res;
539         ir_node *bl;
540         ir_node **ins;
541
542         if(is_Block(reloader)) {
543                 bl = reloader;
544         } else {
545                 bl = get_nodes_block(reloader);
546         }
547
548         ins = alloca(get_irn_arity(spilled) * sizeof(ins[0]));
549         for(i = 0, arity = get_irn_arity(spilled); i < arity; ++i) {
550                 ir_node *arg = get_irn_n(spilled, i);
551
552                 if(is_value_available(env, arg, reloader)) {
553                         ins[i] = arg;
554                 } else {
555                         ins[i] = do_remat(env, arg, reloader);
556                 }
557         }
558
559         /* create a copy of the node */
560         res = new_ir_node(get_irn_dbg_info(spilled), env->chordal_env->irg, bl,
561                 get_irn_op(spilled),
562                 get_irn_mode(spilled),
563                 get_irn_arity(spilled),
564                 ins);
565         copy_node_attr(spilled, res);
566         new_backedge_info(res);
567
568         DBG((env->dbg, LEVEL_1, "Insert remat %+F before reloader %+F\n", res, reloader));
569
570         /* insert in schedule */
571         sched_add_before(reloader, res);
572
573         return res;
574 }
575
576 int be_get_reload_costs(spill_env_t *env, ir_node *to_spill, ir_node *before) {
577         spill_info_t *spill_info;
578
579         if(be_do_remats) {
580                 // is the node rematerializable?
581                 int costs = check_remat_conditions_costs(env, to_spill, before, 0);
582                 if(costs < REMAT_COST_LIMIT)
583                         return costs;
584         }
585
586         // do we already have a spill?
587         spill_info = find_spillinfo(env, to_spill);
588         if(spill_info != NULL && spill_info->spill != NULL)
589                 return env->reload_cost;
590
591         return env->spill_cost + env->reload_cost;
592 }
593
594 int be_get_reload_costs_on_edge(spill_env_t *env, ir_node *to_spill, ir_node *block, int pos) {
595         ir_node *before = get_reload_insertion_point(block, pos);
596         return be_get_reload_costs(env, to_spill, before);
597 }
598
599 /*
600  *  ___                     _     ____      _                 _
601  * |_ _|_ __  ___  ___ _ __| |_  |  _ \ ___| | ___   __ _  __| |___
602  *  | || '_ \/ __|/ _ \ '__| __| | |_) / _ \ |/ _ \ / _` |/ _` / __|
603  *  | || | | \__ \  __/ |  | |_  |  _ <  __/ | (_) | (_| | (_| \__ \
604  * |___|_| |_|___/\___|_|   \__| |_| \_\___|_|\___/ \__,_|\__,_|___/
605  *
606  */
607
608 void be_insert_spills_reloads(spill_env_t *env) {
609         const arch_env_t *arch_env = env->arch_env;
610         spill_info_t *si;
611         int remats = 0;
612         int reloads = 0;
613         int spills = 0;
614
615         /* process each spilled node */
616         for(si = set_first(env->spills); si; si = set_next(env->spills)) {
617                 reloader_t *rld;
618                 ir_mode *mode = get_irn_mode(si->spilled_node);
619                 pset *values = pset_new_ptr(16);
620
621                 /* go through all reloads for this spill */
622                 for(rld = si->reloaders; rld; rld = rld->next) {
623                         ir_node *new_val;
624
625                         if (be_do_remats && check_remat_conditions(env, si->spilled_node, rld->reloader)) {
626                                 new_val = do_remat(env, si->spilled_node, rld->reloader);
627                                 remats++;
628                         } else {
629                                 /* make sure we have a spill */
630                                 if(si->spill == NULL) {
631                                         spill_node(env, si);
632                                         spills++;
633                                 }
634
635                                 /* create a reload */
636                                 new_val = be_reload(arch_env, env->cls, rld->reloader, mode, si->spill);
637                                 reloads++;
638                         }
639
640                         DBG((env->dbg, LEVEL_1, " %+F of %+F before %+F\n", new_val, si->spilled_node, rld->reloader));
641                         pset_insert_ptr(values, new_val);
642                 }
643
644                 if(pset_count(values) > 0) {
645                         /* introduce copies, rewire the uses */
646                         pset_insert_ptr(values, si->spilled_node);
647                         be_ssa_constr_set_ignore(env->chordal_env->dom_front, env->chordal_env->lv, values, env->mem_phis);
648                 }
649
650                 del_pset(values);
651
652                 si->reloaders = NULL;
653         }
654
655         if(be_stat_ev_is_active()) {
656                 be_stat_ev("spill_spills", spills);
657                 be_stat_ev("spill_reloads", reloads);
658                 be_stat_ev("spill_remats", remats);
659         }
660
661         be_remove_dead_nodes_from_schedule(env->chordal_env->irg);
662         be_liveness_recompute(env->chordal_env->lv);
663 }