Added a belady version with a different global pass.
[libfirm] / ir / be / scripts / generate_regalloc_if.pl
1 #!/usr/bin/perl -w
2
3 #
4 # Copyright (C) 1995-2007 University of Karlsruhe.  All right reserved.
5 #
6 # This file is part of libFirm.
7 #
8 # This file may be distributed and/or modified under the terms of the
9 # GNU General Public License version 2 as published by the Free Software
10 # Foundation and appearing in the file LICENSE.GPL included in the
11 # packaging of this file.
12 #
13 # Licensees holding valid libFirm Professional Edition licenses may use
14 # this file in accordance with the libFirm Commercial License.
15 # Agreement provided with the Software.
16 #
17 # This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
18 # WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
19 # PURPOSE.
20 #
21
22 # This script generates C code which creates ands sets up functions and
23 # data structures for the register allocator.
24 # Creation: 2005/11/14
25 # $Id$
26
27 use strict;
28 use Data::Dumper;
29 use integer;
30
31 my $specfile   = $ARGV[0];
32 my $target_dir = $ARGV[1];
33
34 our $arch;
35 our %reg_classes;
36 our %cpu;
37 our %flags = ();
38
39 # include spec file
40
41 my $return;
42
43 use strict "subs";
44 unless ($return = do $specfile) {
45         die "Fatal error: couldn't parse $specfile: $@" if $@;
46         die "Fatal error: couldn't do $specfile: $!"    unless defined $return;
47         die "Fatal error: couldn't run $specfile"       unless $return;
48 }
49 use strict "subs";
50
51 my $target_c   = $target_dir."/gen_".$arch."_regalloc_if.c";
52 my $target_h   = $target_dir."/gen_".$arch."_regalloc_if.h";
53
54 # helper function
55 sub translate_reg_type {
56         my $t = shift;
57
58         if ($t == 0) {
59                 return "arch_register_type_none";
60         }
61         else {
62                 my @types;
63
64                 if ($t & 1) {
65                         push(@types, "arch_register_type_caller_save");
66                 }
67
68                 if ($t & 2) {
69                         push(@types, "arch_register_type_callee_save");
70                 }
71
72                 if ($t & 4) {
73                         push(@types, "arch_register_type_ignore");
74                 }
75
76                 if ($t & 8) {
77                         push(@types, "arch_register_type_joker");
78                 }
79
80                 if ($t & 16) {
81                         push(@types, "arch_register_type_virtual");
82                 }
83
84                 if ($t & 32) {
85                         push(@types, "arch_register_type_state");
86                 }
87
88                 return join(" | ", @types);
89         }
90 }
91
92 # stacks for output
93 my @obst_regtypes_def; # stack for the register type variables definitions
94 my @obst_regtypes_decl;# stack for the register type variables declarations
95 my @obst_regclasses;   # stack for the register class variables
96 my @obst_classdef;     # stack to define a name for a class index
97 my @obst_regdef;       # stack to define a name for a register index
98 my @obst_reginit;      # stack for the register type inits
99 my @obst_req;          # stack for the register requirements
100 my @obst_limit_func;   # stack for functions to return a subset of a register class
101 my @obst_header_all;   # stack for some extern struct defs needed for bearch_$arch include
102
103 my $numregs;
104 my $class_ptr;
105 my $class_idx = 0;
106
107 my $tmp;
108
109 my %reg2class;
110 my %regclass2len;
111
112 push(@obst_classdef, "enum reg_classes {\n");
113
114 my $class_mode;
115
116 # generate register type and class variable, init function and default requirements
117 foreach my $class_name (keys(%reg_classes)) {
118         my @class         = @{ $reg_classes{"$class_name"} };
119         my $old_classname = $class_name;
120
121         $class_name = $arch."_".$class_name;
122         $numregs    = "N_".$class_name."_REGS";
123         $class_ptr  = "&".$arch."_reg_classes[CLASS_".$class_name."]";
124         $class_mode = pop(@class)->{"mode"};
125
126         push(@obst_regtypes_decl, "extern const arch_register_t ${class_name}_regs[$numregs];\n");
127
128         push(@obst_classdef, "\tCLASS_$class_name = $class_idx,\n");
129         push(@obst_regclasses, "{ \"$class_name\", $numregs, NULL, ".$class_name."_regs }");
130
131         my $idx = 0;
132         push(@obst_reginit, "\t/* set largest possible mode for '$class_name' */\n");
133         push(@obst_reginit, "\t$arch\_reg_classes[CLASS_".$class_name."].mode = $class_mode;\n\n");
134         push(@obst_regtypes_def, "const arch_register_t ${class_name}_regs[$numregs] = {\n");
135
136         push(@obst_regdef, "enum reg_${class_name}_indices {\n");
137         foreach (@class) {
138                 my $ucname = uc($_->{"name"});
139                 my $type = translate_reg_type($_->{"type"});
140                 # realname is name if not set by user
141                 $_->{"realname"} = $_->{"name"} if (! exists($_->{"realname"}));
142                 my $realname = $_->{realname};
143                 my $execunitvarname = get_execunit_variable_name($_->{"unit"});
144
145
146                 $reg2class{$_->{"name"}} = { "class" => $old_classname, "index" => $idx }; # remember reg to class for later use
147                 push(@obst_regdef, "\tREG_${ucname},\n");
148
149                 push(@obst_regtypes_def, "\t{\n");
150                 push(@obst_regtypes_def, "\t\t\"$realname\",\n");
151                 push(@obst_regtypes_def, "\t\t$class_ptr,\n");
152                 push(@obst_regtypes_def, "\t\tREG_${ucname},\n");
153                 push(@obst_regtypes_def, "\t\t$type,\n");
154                 push(@obst_regtypes_def, "\t\t$execunitvarname\n");
155                 push(@obst_regtypes_def, "\t},\n");
156
157                 $idx++;
158         }
159         push(@obst_regtypes_def, "};\n");
160
161         $regclass2len{$old_classname} = $idx;
162         push(@obst_regdef, "\t$numregs = $idx\n");
163         push(@obst_regdef, "};\n\n");
164
165         $class_idx++;
166 }
167
168 push(@obst_regdef, "enum flag_indices {\n");
169 foreach my $flag (keys(%flags)) {
170         my %f = %{ $flags{$flag} };
171
172         push(@obst_regdef, "\tFLAG_$flag,\n");
173 }
174 push(@obst_regdef, "\tFLAG_LAST\n");
175 push(@obst_regdef, "};\n");
176 push(@obst_regtypes_decl, "extern arch_flag_t ${arch}_flags[];\n");
177
178 push(@obst_classdef, "\tN_CLASSES = ".scalar(keys(%reg_classes))."\n");
179 push(@obst_classdef, "};\n\n");
180
181 $tmp = uc($arch);
182
183 # generate header (external usage) file
184 open(OUT, ">$target_h") || die("Fatal error: Could not open $target_h, reason: $!\n");
185
186 my $creation_time = localtime(time());
187
188 print OUT<<EOF;
189 /**
190  * \@file
191  * \@brief Contains additional external requirements defs for external includes.
192  * \@note   DO NOT EDIT THIS FILE, your changes will be lost.
193  *         Edit $specfile instead.
194  *         created by: $0 $specfile $target_dir
195  * \@date   $creation_time
196  */
197 #ifndef FIRM_BE_${tmp}_GEN_${tmp}_REGALLOC_IF_H
198 #define FIRM_BE_${tmp}_GEN_${tmp}_REGALLOC_IF_H
199
200 #include "../bearch.h"
201 #include "${arch}_nodes_attr.h"
202
203 EOF
204
205 print OUT @obst_regdef, "\n";
206
207 print OUT @obst_classdef, "\n";
208
209 print OUT @obst_regtypes_decl, "\n";
210
211 print OUT "extern arch_register_class_t $arch\_reg_classes[N_CLASSES];\n\n";
212
213 print OUT "void ".$arch."_register_init(void);\n\n";
214
215 print OUT @obst_header_all, "\n";
216
217 print OUT "\n#endif\n";
218
219 close(OUT);
220
221
222
223 # generate c file
224 open(OUT, ">$target_c") || die("Fatal error: Could not open $target_c, reason: $!\n");
225
226 $creation_time = localtime(time());
227
228 print OUT<<EOF;
229 /**
230  * \@file
231  * \@brief  The generated interface for the register allocator.
232  *          Contains register classes and types and register constraints
233  *          for all nodes where constraints were given in spec.
234  * \@note    DO NOT EDIT THIS FILE, your changes will be lost.
235  *          Edit $specfile instead.
236  *          created by: $0 $specfile $target_dir
237  * \$date    $creation_time
238  */
239 #ifdef HAVE_CONFIG_H
240 #include "config.h"
241 #endif
242
243 #include "gen_${arch}_regalloc_if.h"
244 #include "gen_${arch}_machine.h"
245 #include "bearch_${arch}_t.h"
246 #include "${arch}_map_regs.h"
247 #include "irmode.h"
248
249 EOF
250
251 print OUT "arch_register_class_t ${arch}_reg_classes[] = {\n\t".join(",\n\t", @obst_regclasses)."\n};\n\n";
252
253 print OUT @obst_regtypes_def, "\n";
254
255 print OUT "void ${arch}_register_init(void) {\n";
256 print OUT @obst_reginit;
257 print OUT "}\n\n";
258
259 print OUT @obst_limit_func;
260
261 print OUT @obst_req;
262
263 close(OUT);
264
265 ###
266 # Gets the variable name for the execution unit assigned to this register.
267 ###
268 sub get_execunit_variable_name {
269         my $unit    = shift;
270         my $name    = "NULL";
271         my $uc_arch = uc($arch);
272
273         if ($unit) {
274                 my $found = 0;
275 SRCH:   foreach my $cur_type (keys(%cpu)) {
276                         foreach my $cur_unit (@{ $cpu{"$cur_type"} }) {
277                                 if ($unit eq $cur_unit) {
278                                         my $tp_name   = "$arch\_execution_units_$cur_type";
279                                         my $unit_name = "$uc_arch\_EXECUNIT_TP_$cur_type\_$unit";
280                                         $name  = "&".$tp_name."[".$unit_name."]";
281                                         $found = 1;
282                                         last SRCH;
283                                 }
284                         }
285                 }
286
287                 if (! $found) {
288                         print STDERR "Invalid execution unit $unit specified!\n";
289                 }
290         }
291
292         return $name;
293 }