5e206d9202c892972c7f387b531e112aa92d46e8
[libfirm] / ir / be / beraextern.c
1 /**
2  * Author:      Daniel Grund
3  * Date:                17.01.2006
4  * Copyright:   (c) Universitaet Karlsruhe
5  * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
6  *
7  * Implementation of the RA-Interface for an external, (non-SSA) register allocator.
8  *
9  * The external register allocator is a program:
10  *    PROG -i INPUTFILE -o OUTPUTFILE
11  *
12  *   1) Input file defines the interference graph
13  *   2) Output file contains the instructions to perform
14  *
15
16
17 The input file format
18 ----------------------
19
20 inputfile       ::= regs nodes interf affinities .
21
22 regs            ::= 'regs' regcount .                                           // Anzahl der register (0..regcount-1), die zur Verfuegung stehen
23
24 nodes           ::= 'nodes' '{' node* '}' .                                     // All nodes in the graph
25
26 node            ::= node-info
27                           | node-info '<' reg-nr '>' .                          // Reg-nr is present in case of constraints
28
29 node-info       ::= node-nr spill-costs .
30
31 interf          ::= 'interferences' '{' i-edge* '}' .           // Interference edges of the graph
32
33 i-edge          ::= '(' node-nr ',' node-nr ')' .
34
35 affinities      ::= 'affinities' '{' a-edge* '}' .                      // Affinity edges of the graph
36
37 a-edge          ::= '(' node-nr ',' node-nr ',' weight ')' .
38
39
40 weight, regcount, node-nr ::= int32 .
41 spill-costs ::= int32 .                                                                 // negative spill costs indicate unspillable
42
43 The output file format
44 -----------------------
45
46 outputfile      ::= spills | allocs .
47
48 spills          ::= 'spills' node-nr+ .
49
50 allocs          ::= 'allocs' alloc* .
51
52 alloc           ::= node-nr reg-nr .
53
54
55 ******** End of file format docu ********/
56
57 #ifdef HAVE_CONFIG_H
58 #include "config.h"
59 #endif
60
61 #ifdef HAVE_MALLOC_H
62  #include <malloc.h>
63 #endif
64 #ifdef HAVE_ALLOCA_H
65  #include <alloca.h>
66 #endif
67
68 #include <stdio.h>
69 #include <stdlib.h>
70 #include <limits.h>
71 #ifdef WITH_LIBCORE
72 #include <libcore/lc_opts.h>
73 #include <libcore/lc_opts_enum.h>
74 #endif
75
76 #include "set.h"
77 #include "pset.h"
78 #include "pmap.h"
79 #include "bitset.h"
80
81 #include "irprintf_t.h"
82 #include "irnode_t.h"
83 #include "irgraph_t.h"
84 #include "irgwalk.h"
85 #include "iredges_t.h"
86 #include "irdom_t.h"
87 #include "phiclass.h"
88
89 #include "beraextern.h"
90 #include "beabi.h"
91 #include "bearch.h"
92 #include "benode_t.h"
93 #include "beirgmod.h"
94 #include "besched_t.h"
95 #include "beutil.h"
96 #include "belive_t.h"
97 #include "beinsn_t.h"
98
99 #include "bessadestrsimple.h"
100
101 #define DBG_LEVEL 2
102
103 /**
104  * Environment with all the needed stuff
105  */
106 typedef struct _be_raext_env_t {
107         arch_env_t *aenv;
108         const arch_register_class_t *cls;
109         be_lv_t *lv;
110         ir_graph *irg;
111         dom_front_info_t *dom_info;
112
113         FILE *f;                                /**< file handle used for out- and input file */
114         set *vars;                              /**< contains all be_var_info_t */
115         int n_cls_vars;                 /**< length of the array cls_vars */
116         be_var_info_t **cls_vars;       /**< only the var_infos for current cls. needed for double iterating */
117         DEBUG_ONLY(firm_dbg_module_t *dbg;)
118 } be_raext_env_t;
119
120
121
122 /******************************************************************************
123     _    _      _
124    | |  | |    | |
125    | |__| | ___| |_ __   ___ _ __ ___
126    |  __  |/ _ \ | '_ \ / _ \ '__/ __|
127    | |  | |  __/ | |_) |  __/ |  \__ \
128    |_|  |_|\___|_| .__/ \___|_|  |___/
129                  | |
130                  |_|
131  *****************************************************************************/
132
133
134 #define pset_foreach(pset, irn)  for(irn=pset_first(pset); irn; irn=pset_next(pset))
135 #define set_foreach(set, e)  for(e=set_first(set); e; e=set_next(set))
136
137 /**
138  * Checks if _the_ result of the irn belongs to the
139  * current register class (raenv->cls)
140  * NOTE: Only the first result is checked.
141  */
142 #define is_res_in_reg_class(irn) arch_irn_has_reg_class(raenv->aenv, irn, -1, raenv->cls)
143
144 static INLINE ir_node *get_first_non_phi(pset *s) {
145         ir_node *irn;
146
147         pset_foreach(s, irn)
148                 if (!is_Phi(irn)) {
149                         pset_break(s);
150                         return irn;
151                 }
152
153         assert(0 && "There must be a non-phi-irn in this");
154         return NULL;
155 }
156
157 static INLINE ir_node *get_first_phi(pset *s) {
158         ir_node *irn;
159
160         pset_foreach(s, irn)
161                 if (is_Phi(irn)) {
162                         pset_break(s);
163                         return irn;
164                 }
165
166         assert(0 && "There must be a phi in this");
167         return NULL;
168 }
169
170 static int get_loop_weight(ir_node *irn) {
171         int cost = 0;
172         ir_loop *loop = get_irn_loop(get_nodes_block(irn));
173
174         if (loop) {
175                 int d = get_loop_depth(loop);
176                 cost = d*d;
177         }
178         return cost+1;
179 }
180
181 #define get_const_weight(irn) (1)
182
183 #define get_spill_weight(irn)    get_loop_weight(irn)
184 #define get_reload_weight(irn)   get_loop_weight(irn)
185 #define get_affinity_weight(irn) get_loop_weight(irn)
186
187 /******************************************************************************
188     _____                _            _____            _
189    / ____|              | |          / ____|          (_)
190   | |     ___  _ __  ___| |_ _ __   | |     ___  _ __  _  ___  ___
191   | |    / _ \| '_ \/ __| __| '__|  | |    / _ \| '_ \| |/ _ \/ __|
192   | |___| (_) | | | \__ \ |_| |     | |___| (_) | |_) | |  __/\__ \
193    \_____\___/|_| |_|___/\__|_|      \_____\___/| .__/|_|\___||___/
194                                                 | |
195                                                 |_|
196  *****************************************************************************/
197
198 static void handle_constraints_insn(be_raext_env_t *env, be_insn_t *insn)
199 {
200         ir_node *bl = get_nodes_block(insn->irn);
201         int i;
202
203         for(i = 0; i < insn->use_start; ++i) {
204                 be_operand_t *op = &insn->ops[i];
205
206                 if(op->has_constraints) {
207                         ir_node *cpy = be_new_Copy(op->req.cls, env->irg, bl, op->carrier);
208                         sched_add_before(insn->next_insn, cpy);
209                         edges_reroute(op->carrier, cpy, env->irg);
210                 }
211         }
212
213         for(i = insn->use_start; i < insn->n_ops; ++i) {
214                 be_operand_t *op = &insn->ops[i];
215
216                 if(op->has_constraints) {
217                         ir_node *cpy = be_new_Copy(op->req.cls, env->irg, bl, op->carrier);
218                         sched_add_before(insn->irn, cpy);
219                         set_irn_n(insn->irn, op->pos, cpy);
220                         be_set_constr_limited(cpy, BE_OUT_POS(0), &op->req);
221                 }
222         }
223 }
224
225 static void handle_constraints_block(ir_node *bl, void *data)
226 {
227         be_raext_env_t *raenv = data;
228         int active            = bl != get_irg_start_block(raenv->irg);
229
230         ir_node *irn;
231         be_insn_env_t ie;
232         struct obstack obst;
233
234         ie.cls           = raenv->cls;
235         ie.aenv          = raenv->aenv;
236         ie.obst          = &obst;
237         ie.ignore_colors = NULL;
238         obstack_init(&obst);
239
240         irn = sched_first(bl);
241         while(!sched_is_end(irn)) {
242                 be_insn_t *insn = be_scan_insn(&ie, irn);
243
244                 if(insn->has_constraints)
245                         handle_constraints_insn(raenv, insn);
246
247                 if(be_is_Barrier(irn))
248                         active = !active;
249
250                 irn = insn->next_insn;
251                 obstack_free(&obst, insn);
252         }
253 }
254
255 static void handle_constraints(be_raext_env_t *raenv) {
256         irg_block_walk_graph(raenv->irg, NULL, handle_constraints_block, raenv);
257 }
258
259
260
261
262 /******************************************************************************
263     _____
264    |  __ \
265    | |  | |_   _ _ __ ___  _ __   ___ _ __
266    | |  | | | | | '_ ` _ \| '_ \ / _ \ '__|
267    | |__| | |_| | | | | | | |_) |  __/ |
268    |_____/ \__,_|_| |_| |_| .__/ \___|_|
269                           | |
270                           |_|
271  *****************************************************************************/
272
273
274 static void extract_vars_of_cls(be_raext_env_t *raenv) {
275         int count = 0;
276         be_var_info_t *vi;
277
278         raenv->cls_vars = xmalloc(set_count(raenv->vars) * sizeof(*raenv->cls_vars));
279         assert(raenv->cls_vars);
280
281         set_foreach(raenv->vars, vi)
282                 if (is_res_in_reg_class(get_first_non_phi(vi->values)))
283                         raenv->cls_vars[count++] = vi;
284
285         raenv->cls_vars = realloc(raenv->cls_vars, count * sizeof(*raenv->cls_vars));
286         assert(raenv->cls_vars);
287
288         raenv->n_cls_vars = count;
289 }
290
291
292 /**
293  * Check if node irn has a limited-constraint at position pos.
294  * If yes, dump it to FILE raenv->f
295  */
296 static INLINE void dump_constraint(be_raext_env_t *raenv, ir_node *irn, int pos) {
297         bitset_t *bs = bitset_alloca(raenv->cls->n_regs);
298         arch_register_req_t req;
299
300         arch_get_register_req(raenv->aenv, &req, irn, pos);
301         if (arch_register_req_is(&req, limited)) {
302                 int reg_nr;
303                 req.limited(req.limited_env, bs);
304                 reg_nr = bitset_next_set(bs, 0);
305                 fprintf(raenv->f, "<%d>", reg_nr);
306                 assert(-1 == bitset_next_set(bs, reg_nr+1) && "Constraints with more than 1 possible register are not supported");
307         }
308 }
309
310 #define UNSPILLABLE -1
311
312 static INLINE int get_spill_costs(be_raext_env_t *raenv, be_var_info_t *vi) {
313         ir_node *irn;
314         int c_spills=0, c_reloads=0;
315
316         pset_foreach(vi->values, irn) {
317                 if (arch_irn_is(raenv->aenv, irn, ignore) || be_is_Reload(irn)) {
318                         pset_break(vi->values);
319                         return UNSPILLABLE;
320                 }
321
322                 if (is_Phi(irn)) {
323                         /* number of reloads is the number of non-phi uses of all values of this var */
324                         const ir_edge_t *edge;
325                         foreach_out_edge(irn, edge)
326                                 if (!is_Phi(edge->src))
327                                         c_reloads += get_reload_weight(edge->src);
328                 } else {
329                         /* number of spills is the number of non-phi values for this var */
330                         c_spills += get_spill_weight(irn);
331                 }
332         }
333
334         return c_spills + c_reloads;
335 }
336
337 static void dump_nodes(be_raext_env_t *raenv) {
338         FILE *f = raenv->f;
339         int i;
340
341         fprintf(f, "\nnodes {\n");
342
343         for (i=0; i<raenv->n_cls_vars; ++i) {
344                 be_var_info_t *vi = raenv->cls_vars[i];
345
346                 if (vi->var_nr == SET_REMOVED)
347                         continue;
348
349                 fprintf(f, "%d %d", vi->var_nr, get_spill_costs(raenv, vi));
350                 dump_constraint(raenv, get_first_non_phi(vi->values), -1);
351                 fprintf(f, "\n");
352         }
353
354         fprintf(f, "}\n");
355         fflush(f);
356 }
357
358
359 static void dump_interferences(be_raext_env_t *raenv) {
360         int i,o;
361         be_var_info_t *vi1, *vi2;
362         ir_node *irn1, *irn2;
363         FILE *f = raenv->f;
364
365         fprintf(f, "\ninterferences {\n");
366
367         for (i=0; i<raenv->n_cls_vars; ++i) {
368                 vi1 = raenv->cls_vars[i];
369
370                 if (vi1->var_nr == SET_REMOVED)
371                         continue;
372
373                 for (o=i+1; o<raenv->n_cls_vars; ++o) {
374                         vi2 = raenv->cls_vars[o];
375
376                         if (vi2->var_nr == SET_REMOVED)
377                                 continue;
378
379                         pset_foreach(vi1->values, irn1)
380                                 pset_foreach(vi2->values, irn2)
381                                         if (values_interfere(raenv->lv, irn1, irn2)) {
382                                                 pset_break(vi1->values);
383                                                 pset_break(vi2->values);
384                                                 fprintf(f, "(%d, %d)\n", vi1->var_nr, vi2->var_nr);
385                                                 goto NextVar;
386                                         }
387
388 NextVar: ;
389                 }
390         }
391         fprintf(f, "}\n");
392 }
393
394 static void dump_affinities_walker(ir_node *irn, void *env) {
395         be_raext_env_t *raenv = env;
396         arch_register_req_t req;
397         int pos, max;
398         be_var_info_t *vi1, *vi2;
399
400         if (arch_get_irn_reg_class(raenv->aenv, irn, -1) != raenv->cls || arch_irn_is(raenv->aenv, irn, ignore))
401                 return;
402
403         vi1 = be_get_var_info(irn);
404
405         /* copies have affinities */
406         if (arch_irn_classify(raenv->aenv, irn) == arch_irn_class_copy) {
407                 ir_node *other = be_get_Copy_op(irn);
408
409                 if (! arch_irn_is(raenv->aenv, other, ignore)) {
410                         vi2 = be_get_var_info(other);
411
412                         fprintf(raenv->f, "(%d, %d, %d)\n",  vi1->var_nr, vi2->var_nr, get_affinity_weight(irn));
413                 }
414         }
415
416
417         /* should_be_equal constraints are affinites */
418         for (pos = 0, max = get_irn_arity(irn); pos<max; ++pos) {
419                 arch_get_register_req(raenv->aenv, &req, irn, pos);
420
421                 if (arch_register_req_is(&req, should_be_same) && arch_irn_is(raenv->aenv, req.other_same, ignore)) {
422                         vi2 = be_get_var_info(req.other_same);
423
424                         fprintf(raenv->f, "(%d, %d, %d)\n",  vi1->var_nr, vi2->var_nr, get_affinity_weight(irn));
425                 }
426         }
427 }
428
429
430 static void dump_affinities(be_raext_env_t *raenv) {
431         fprintf(raenv->f, "\naffinities {\n");
432         irg_walk_graph(raenv->irg, NULL, dump_affinities_walker, raenv);
433         fprintf(raenv->f, "}\n");
434 }
435
436 /**
437  * Dump all information needed by the external
438  * register allocator to a single file.
439  */
440 static void dump_to_file(be_raext_env_t *raenv, char *filename) {
441         FILE *f;
442
443         if (!(f = fopen(filename, "wt"))) {
444                 fprintf(stderr, "Could not open file %s for writing\n", filename);
445                 assert(0);
446                 exit(0xdeadbeef);
447         }
448         raenv->f = f;
449
450         /* dump register info */
451         fprintf(f, "regs %d\n", arch_register_class_n_regs(raenv->cls));
452
453         /* dump the interference graph */
454         dump_nodes(raenv);
455         dump_interferences(raenv);
456         dump_affinities(raenv);
457
458         fclose(f);
459 }
460
461 /******************************************************************************
462     ______                     _
463    |  ____|                   | |
464    | |__  __  _____  ___ _   _| |_ ___
465    |  __| \ \/ / _ \/ __| | | | __/ _ \
466    | |____ >  <  __/ (__| |_| | ||  __/
467    |______/_/\_\___|\___|\__,_|\__\___|
468  *****************************************************************************/
469
470 /**
471  * Execute the external register allocator specified in the
472  * firm-option firm.be.ra.ext.callee
473  */
474 static void execute(char *prog_to_call, char *out_file, char *result_file) {
475         char cmd_line[1024];
476         int ret_status;
477
478         snprintf(cmd_line, sizeof(cmd_line), "%s -i %s -o %s", prog_to_call, out_file, result_file);
479         cmd_line[sizeof(cmd_line) - 1] = '\0';
480
481         ret_status = system(cmd_line);
482         assert(ret_status != -1 && "Invokation of external register allocator failed");
483         assert(ret_status == 0 && "External register allocator is unhappy with sth.");
484 }
485
486 /******************************************************************************
487                          _         _____                 _ _
488        /\               | |       |  __ \               | | |
489       /  \   _ __  _ __ | |_   _  | |__) |___  ___ _   _| | |_
490      / /\ \ | '_ \| '_ \| | | | | |  _  // _ \/ __| | | | | __|
491     / ____ \| |_) | |_) | | |_| | | | \ \  __/\__ \ |_| | | |_
492    /_/    \_\ .__/| .__/|_|\__, | |_|  \_\___||___/\__,_|_|\__|
493             | |   | |       __/ |
494             |_|   |_|      |___/
495  *****************************************************************************/
496
497 /**
498  * Spill a variable and add reloads before all uses.
499  */
500 static INLINE void var_add_spills_and_reloads(be_raext_env_t *raenv, int var_nr) {
501         be_var_info_t *vi = be_var_find(raenv->vars, var_nr);
502         ir_node *spill=NULL, *ctx, *irn;
503         ir_mode *mode;
504         const ir_edge_t *edge, *ne;
505         pset *spills  = pset_new_ptr(4);        /* the spills of this variable */
506         pset *reloads = pset_new_ptr(4);        /* the reloads of this variable */
507         int new_size, n_spills, n_reloads;
508
509         assert(vi && "Variable nr does not exist!");
510         assert(pset_count(vi->values) && "There are no values associated to this variable");
511
512         /* the spill context is set to an arbitrary node of the phi-class,
513          * or the node itself if it is not member of a phi class
514          */
515         if (pset_count(vi->values) == 1)
516                 ctx = get_first_non_phi(vi->values);
517         else
518                 ctx = get_first_phi(vi->values);
519
520         DBG((raenv->dbg, LEVEL_2, "Spill context: %+F\n", ctx));
521
522         /* for each value of this variable insert the spills */
523         pset_foreach(vi->values, irn) {
524                 if (is_Phi(irn)) {
525                         sched_remove(irn);
526                         continue;
527                 }
528
529                 /* all ordinary nodes must be spilled */
530                 DBG((raenv->dbg, LEVEL_2, "  spilling %+F\n", irn));
531                 spill = be_spill(raenv->aenv, irn, ctx);
532
533                 /* remember the spill */
534                 pset_insert_ptr(spills, spill);
535         }
536
537         assert(spill && "There must be at least one non-phi-node");
538
539         mode = get_irn_mode(get_irn_n(spill, be_pos_Spill_val));
540
541         /* insert reloads and wire them arbitrary*/
542         pset_foreach(vi->values, irn)
543                 foreach_out_edge_safe(irn, edge, ne) {
544                         ir_node *reload, *src = edge->src;
545                         if (is_Phi(src) || be_is_Spill(src))
546                                 continue;
547
548                         /* all real uses must be reloaded */
549                         DBG((raenv->dbg, LEVEL_2, "  reloading before %+F\n", src));
550                         reload = be_reload(raenv->aenv, raenv->cls, edge->src, mode, spill);
551                         set_irn_n(edge->src, edge->pos, reload);
552
553                         /* remember the reload */
554                         pset_insert_ptr(reloads, reload);
555                 }
556
557         /* correct the reload->spill pointers... */
558         be_ssa_constr_set(raenv->dom_info, raenv->lv, spills);
559
560
561         /****** correct the variable <--> values mapping: ******
562          *
563          *  - if we had a phi class it gets split into several new variables
564          *  - all reloads are new variables
565          */
566         n_spills = pset_count(spills);
567         n_reloads = pset_count(reloads);
568
569         /* first make room for new pointers in the cls_var array */
570         new_size = raenv->n_cls_vars + n_reloads + ((n_spills>1) ? n_spills : 0);
571         raenv->cls_vars = realloc(raenv->cls_vars, (new_size) * sizeof(*raenv->cls_vars));
572         assert(raenv->cls_vars && "Out of mem!?");
573
574         /* if we had a real phi-class, we must... */
575         if (pset_count(spills) > 1) {
576                 /* ...remove the old variable corresponding to the phi class */
577                 vi->var_nr = SET_REMOVED;
578
579                 /* ...add new vars for each non-phi-member */
580                 pset_foreach(spills, irn) {
581                         ir_node *spilled = get_irn_n(irn, be_pos_Spill_val);
582                         raenv->cls_vars[raenv->n_cls_vars++] = be_var_add_value(raenv->vars, get_irn_node_nr(spilled), spilled);
583                 }
584         }
585
586         /* add new variables for all reloads */
587         pset_foreach(reloads, irn) {
588                 assert(get_irn_node_nr(irn) != 1089);
589                 raenv->cls_vars[raenv->n_cls_vars++] = be_var_add_value(raenv->vars, get_irn_node_nr(irn), irn);
590         }
591
592         del_pset(spills);
593         del_pset(reloads);
594 }
595
596 #define INVALID_FILE_FORMAT assert(0 && "Invalid file format.")
597 #define BUFLEN 32
598 #define BUFCONV " %32s "
599
600 /**
601  * Read in the actions performed by the external allocator.
602  * Apply these transformations to the irg.
603  * @return 1 if an allocation was read in. 0 otherwise.
604  */
605 static int read_and_apply_results(be_raext_env_t *raenv, char *filename) {
606         FILE *f;
607         char buf[BUFLEN];
608         int is_allocation = 0;
609
610         if (!(f = fopen(filename, "rt"))) {
611                 fprintf(stderr, "Could not open file %s for reading\n", filename);
612                 assert(0);
613                 exit(0xdeadbeef);
614         }
615         raenv->f = f;
616
617         /* read the action */
618         if (fscanf(f, BUFCONV, buf) != 1)
619                 INVALID_FILE_FORMAT;
620
621         /* do we spill */
622         if (!strcmp(buf, "spills")) {
623                 int var_nr;
624                 while (fscanf(f, " %d ", &var_nr) == 1)
625                         var_add_spills_and_reloads(raenv, var_nr);
626         } else
627
628         /* or do we allocate */
629         if (!strcmp(buf, "allocs")) {
630                 int var_nr, reg_nr;
631
632                 is_allocation = 1;
633                 while (fscanf(f, " %d %d ", &var_nr, &reg_nr) == 2) {
634                         ir_node *irn;
635                         pset *vals = be_get_var_values(raenv->vars, var_nr);
636
637                         assert(vals && "Variable nr does not exist!");
638                         pset_foreach(vals, irn)
639                                 arch_set_irn_register(raenv->aenv, irn, arch_register_for_index(raenv->cls, reg_nr));
640                 }
641         } else
642                 INVALID_FILE_FORMAT;
643
644         if (!feof(f))
645                 INVALID_FILE_FORMAT;
646
647         fclose(f);
648
649         return is_allocation;
650 }
651
652 static void check_allocation(be_raext_env_t *raenv) {
653         int i, o;
654
655         for (i=0; i<raenv->n_cls_vars; ++i) {
656                 be_var_info_t *vi1 = raenv->cls_vars[i];
657
658                 if (vi1->var_nr == SET_REMOVED)
659                         continue;
660
661                 for (o=0; o<i; ++o) {
662                         be_var_info_t *vi2 = raenv->cls_vars[o];
663                         ir_node *irn1, *irn2;
664
665                         if (vi2->var_nr == SET_REMOVED)
666                                 continue;
667
668                         pset_foreach(vi1->values, irn1)
669                                 pset_foreach(vi2->values, irn2)
670                                         if (values_interfere(raenv->lv, irn1, irn2) && arch_get_irn_register(raenv->aenv, irn1) == arch_get_irn_register(raenv->aenv, irn2)) {
671                                                 dump_ir_block_graph_sched(raenv->irg, "ERROR");
672                                                 ir_fprintf(stdout, "SSA values %+F and %+F interfere. They belong to variable %d and %d respectively.\n", irn1, irn2, vi1->var_nr, vi2->var_nr);
673                                                 assert(0 && "ERROR graph dumped");
674                                         }
675                 }
676         }
677 }
678
679 /******************************************************************************
680     __  __       _
681    |  \/  |     (_)
682    | \  / | __ _ _ _ __
683    | |\/| |/ _` | | '_ \
684    | |  | | (_| | | | | |
685    |_|  |_|\__,_|_|_| |_|
686  *****************************************************************************/
687
688 /**
689  * Default values for options
690  */
691 static set* (*ssa_destr)(ir_graph*,const arch_env_t*) = be_ssa_destr_simple;
692 static char callee[128] = "\"E:/user/kimohoff/public/register allocator\"";
693 //static char callee[128] = "/ben/kimohoff/ipd-registerallocator/register_allocator";
694
695
696 /**
697  * Allocate registers with an external program using a text-file interface.
698  *
699  * Do some computations (SSA-destruction and mapping of values--vars)
700  * Write file
701  * Execute external program
702  * Read in results and apply them
703  *
704  */
705 static be_ra_timer_t *be_ra_extern_main(const be_irg_t *bi) {
706         be_main_env_t *env = bi->main_env;
707         ir_graph *irg = bi->irg;
708
709         be_raext_env_t raenv;
710         int clsnr, clss;
711
712         compute_doms(irg);
713         edges_assure(irg);
714
715         raenv.lv       = be_liveness(irg);
716         raenv.irg      = irg;
717         raenv.aenv     = env->arch_env;
718         raenv.dom_info = be_compute_dominance_frontiers(irg);
719         FIRM_DBG_REGISTER(raenv.dbg, "firm.be.raextern");
720
721         /* Insert copies for constraints */
722         for(clsnr = 0, clss = arch_isa_get_n_reg_class(raenv.aenv->isa); clsnr < clss; ++clsnr) {
723                 raenv.cls = arch_isa_get_reg_class(raenv.aenv->isa, clsnr);
724                 handle_constraints(&raenv);
725         }
726
727         be_dump(irg, "-extern-constr", dump_ir_block_graph_sched);
728
729         /* SSA destruction respectively transformation into "Conventional SSA" */
730         raenv.vars = be_ssa_destr_simple(irg, env->arch_env);
731         be_dump(irg, "-extern-ssadestr", dump_ir_block_graph_sched);
732
733
734         /* For all register classes */
735         for(clsnr = 0, clss = arch_isa_get_n_reg_class(raenv.aenv->isa); clsnr < clss; ++clsnr) {
736                 int done, round = 1;
737                 char out[256], in[256];
738
739                 raenv.cls = arch_isa_get_reg_class(raenv.aenv->isa, clsnr);
740
741                 extract_vars_of_cls(&raenv);
742
743                 do {
744                         ir_snprintf(out, sizeof(out), "%F-%s-%d.ra", irg, raenv.cls->name, round);
745                         ir_snprintf(in, sizeof(in), "%F-%s-%d.ra.res", irg, raenv.cls->name, round);
746
747                         be_liveness(irg);
748
749                         dump_to_file(&raenv, out);
750                         execute(callee, out, in);
751                         done = read_and_apply_results(&raenv, in);
752                         be_abi_fix_stack_nodes(bi->abi, raenv.lv);
753
754                         ir_snprintf(in, sizeof(in), "-extern-%s-round-%d", raenv.cls->name, round);
755                         be_dump(irg, in, dump_ir_block_graph_sched);
756
757                         round++;
758                 } while (!done);
759
760                 check_allocation(&raenv);
761
762                 free(raenv.cls_vars);
763         }
764
765         be_dump(irg, "-extern-alloc", dump_ir_block_graph_sched);
766
767         /* Clean up */
768         free_ssa_destr_simple(raenv.vars);
769         be_free_dominance_frontiers(raenv.dom_info);
770         be_liveness_free(raenv.lv);
771
772         return NULL;
773 }
774
775 /******************************************************************************
776      ____        _   _
777     / __ \      | | (_)
778    | |  | |_ __ | |_ _  ___  _ __  ___
779    | |  | | '_ \| __| |/ _ \| '_ \/ __|
780    | |__| | |_) | |_| | (_) | | | \__ \
781     \____/| .__/ \__|_|\___/|_| |_|___/
782           | |
783           |_|
784  *****************************************************************************/
785
786 #ifdef WITH_LIBCORE
787
788
789 static const lc_opt_enum_func_ptr_items_t ssa_destr_items[] = {
790         { "simple",     (int (*)()) be_ssa_destr_simple }, /* TODO make (void*) casts nicer */
791         { NULL,      NULL }
792 };
793
794 static lc_opt_enum_func_ptr_var_t ssa_destr_var = {
795          (int (**)()) &ssa_destr, ssa_destr_items
796 };
797
798 static const lc_opt_table_entry_t be_ra_extern_options[] = {
799         LC_OPT_ENT_ENUM_FUNC_PTR("ssa_destr", "SSA destruction flavor", &ssa_destr_var),
800         LC_OPT_ENT_STR("callee", "The external program to call", callee, sizeof(callee)),
801         { NULL }
802 };
803
804 static void be_ra_extern_register_options(lc_opt_entry_t *root) {
805         lc_opt_entry_t *grp = lc_opt_get_grp(root, "ext");
806
807         lc_opt_add_table(grp, be_ra_extern_options);
808 }
809
810 #endif /* WITH_LIBCORE */
811
812 const be_ra_t be_ra_external_allocator = {
813 #ifdef WITH_LIBCORE
814         be_ra_extern_register_options,
815 #endif
816         be_ra_extern_main
817 };