3 # This script generates C code which emits assembler code for the
4 # assembler ir nodes. It takes a "emit" key from the node specification
5 # and substitutes lines starting with . with a corresponding fprintf().
12 my $specfile = $ARGV[0];
13 my $target_dir = $ARGV[1];
24 unless ($return = do $specfile) {
25 warn "couldn't parse $specfile: $@" if $@;
26 warn "couldn't do $specfile: $!" unless defined $return;
27 warn "couldn't run $specfile" unless $return;
31 my $target_c = $target_dir."/gen_".$arch."_regalloc_if.c";
32 my $target_h = $target_dir."/gen_".$arch."_regalloc_if.h";
33 my $target_h_t = $target_dir."/gen_".$arch."_regalloc_if_t.h";
36 my @rt = ("arch_register_type_none",
37 "arch_register_type_write_invariant",
38 "arch_register_type_caller_saved",
39 "arch_register_type_callee_saved",
40 "arch_register_type_ignore");
43 my @obst_regtypes; # stack for the register type variables
44 my @obst_regclasses; # stack for the register class variables
45 my @obst_classdef; # stack to define a name for a class index
46 my @obst_regdef; # stack to define a name for a register index
47 my @obst_reginit; # stack for the register type inits
48 my @obst_req; # stack for the register requirements
49 my @obst_limit_func; # stack for functions to return a subset of a register class
50 my @obst_defreq_head; # stack for prototypes of default requirement function
51 my @obst_header_all; # stack for some extern struct defs needed for bearch_$arch include
52 my @obst_projnum_map; # stack for mapping register projnums to requirements
62 # there is a default NONE requirement
63 $tmp = "/* Default NONE register requirements */\n";
64 $tmp .= "const $arch\_register_req_t $arch\_default_req_none = {\n";
66 $tmp .= " arch_register_req_type_none,\n";
73 push(@obst_req, $tmp);
75 push(@obst_header_all, "extern arch_register_class_t $arch\_reg_classes[N_CLASSES];\n\n");
76 push(@obst_header_all, "extern const $arch\_register_req_t $arch\_default_req_none;\n");
78 push(@obst_classdef, "#define N_CLASSES ".scalar(keys(%reg_classes))."\n");
80 my $global_projnum_idx = 0;
82 # generate register type and class variable, init function and default requirements
83 foreach my $class_name (keys(%reg_classes)) {
84 my @class = @{ $reg_classes{"$class_name"} };
85 my $old_classname = $class_name;
87 $class_name = $arch."_".$class_name;
88 $numregs = "N_".$class_name."_REGS";
89 $class_ptr = "&".$arch."_reg_classes[CLASS_".$class_name."]";
91 push(@obst_regtypes, "#define $numregs ".($#class + 1)."\n");
92 push(@obst_regtypes, "arch_register_t ".$class_name."_regs[$numregs];\n\n");
94 push(@obst_classdef, "#define CLASS_$class_name $class_idx\n");
95 push(@obst_regclasses, "{ \"$class_name\", $numregs, ".$class_name."_regs }");
97 # there is a default NORMAL requirement for each class
98 $tmp = "/* Default NORMAL register requirements for class $class_name */\n";
99 $tmp .= "const $arch\_register_req_t $arch\_default_req_$class_name = {\n";
101 $tmp .= " arch_register_req_type_normal,\n";
102 $tmp .= " $class_ptr,\n";
108 push(@obst_req, $tmp);
110 push(@obst_header_all, "\nextern const $arch\_register_req_t $arch\_default_req_$class_name;\n");
113 push(@obst_reginit, " /* Init of all registers in class '$class_name' */\n\n");
115 # For each class we build for each of it's member registers a limit function
116 # which limits the class to this particular register. We also build the
117 # corresponding requirement structs.
118 # We need those functions to set register requirements on demand in transformation
119 # esp. for Call and RegParams where we can mix int and float parameters.
121 my $limit_func_name = $arch."_limit_".$class_name."_".$_->{"name"};
123 # push the function prototype
124 $tmp = "void $limit_func_name(const ir_node *irn, int pos, bitset_t *bs)";
125 push(@obst_defreq_head, $tmp.";\n");
127 # push the function definition
129 $tmp .= " bs = bitset_clear_all(bs);\n";
130 $tmp .= " bitset_set(bs, REG_".uc($_->{"name"}).");\n"; # REGISTER to index assignment is done some lines down
132 push(@obst_limit_func, $tmp);
134 # push the default requirement struct
135 $tmp = "const $arch\_register_req_t $arch\_default_req_$class_name\_".$_->{"name"}." = {\n";
137 $tmp .= " arch_register_req_type_limited,\n";
138 $tmp .= " $class_ptr,\n";
139 $tmp .= " $limit_func_name,\n";
144 push(@obst_req, $tmp);
146 push(@obst_header_all, "extern const $arch\_register_req_t $arch\_default_req_$class_name\_".$_->{"name"}.";\n");
148 $reg2class{$_->{"name"}} = { "class" => $old_classname, "index" => $idx }; # remember reg to class for later use
149 push(@obst_regdef, "#define REG_".uc($_->{"name"})." $idx\n");
150 push(@obst_reginit, " ".$class_name."_regs[$idx].name = \"".$_->{"name"}."\";\n");
151 push(@obst_reginit, " ".$class_name."_regs[$idx].reg_class = $class_ptr;\n");
152 push(@obst_reginit, " ".$class_name."_regs[$idx].index = $idx;\n");
153 push(@obst_reginit, " ".$class_name."_regs[$idx].type = ".$rt[$_->{"type"}].";\n");
154 if ($_->{"type"} == 2) {
155 # this is a caller saved register
156 push(@obst_reginit, " ia32_set_reg_projnum(&".$class_name."_regs[$idx], $global_projnum_idx, isa->reg_projnum_map);\n");
157 push(@obst_projnum_map, "&$arch\_default_req_$class_name\_".$_->{"name"});
158 $global_projnum_idx++;
160 push(@obst_reginit, "\n");
167 push(@obst_regdef, "\n#define N_CALLER_SAVE_REGS ".scalar(@obst_projnum_map)."\n");
169 push(@obst_header_all, "\nextern const $arch\_register_req_t *$arch\_projnum_reg_req_map[N_CALLER_SAVE_REGS];\n\n");
170 push(@obst_header_all, "\n/* node specific requirements */\n");
172 # generate node-register constraints
173 foreach my $op (keys(%nodes)) {
174 my %n = %{ $nodes{"$op"} };
176 next if (!exists($n{"reg_req"}));
180 push(@obst_req, "/* IN requirements for '$op' */\n");
181 # check for argument requirements
182 if (exists($n{"reg_req"}{"in"})) {
183 generate_requirements(\%n, $op, "in");
186 push(@obst_req, "/* OUT requirements for '$op' */\n");
187 # check for result requirements
188 if (exists($n{"reg_req"}{"out"})) {
189 generate_requirements(\%n, $op, "out");
195 # generate header _t (internal usage) file
196 open(OUT, ">$target_h_t") || die("Could not open $target_h_t, reason: $!\n");
198 my $creation_time = localtime(time());
203 #ifndef _GEN_$tmp\_REGALLOC_IF_T_H_
204 #define _GEN_$tmp\_REGALLOC_IF_T_H_
207 * Generated register classes from spec.
209 * DO NOT EDIT THIS FILE, your changes will be lost.
210 * Edit $specfile instead.
211 * created by: $0 $specfile $target_dir
212 * date: $creation_time
215 #include "../bearch.h"
216 #include "$arch\_nodes_attr.h"
220 print OUT @obst_regdef, "\n";
222 print OUT @obst_classdef, "\n";
224 print OUT @obst_regtypes, "\n";
226 print OUT @obst_defreq_head, "\n";
228 print OUT "void ".$arch."_register_init(void *isa_ptr);\n\n";
230 print OUT "\n#endif /* _GEN_$tmp\_REGALLOC_IF_T_H_ */\n";
234 # generate header (external usage) file
235 open(OUT, ">$target_h") || die("Could not open $target_h, reason: $!\n");
237 $creation_time = localtime(time());
240 #ifndef _GEN_$tmp\_REGALLOC_IF_H_
241 #define _GEN_$tmp\_REGALLOC_IF_H_
244 * Contains additional external requirements defs for external includes.
246 * DO NOT EDIT THIS FILE, your changes will be lost.
247 * Edit $specfile instead.
248 * created by: $0 $specfile $target_dir
249 * date: $creation_time
252 #include "gen_$arch\_regalloc_if_t.h"
256 print OUT @obst_header_all;
258 print OUT "\n#endif /* _GEN_$tmp\_REGALLOC_IF_H_ */\n";
264 # generate c inline file
265 open(OUT, ">$target_c") || die("Could not open $target_c, reason: $!\n");
267 $creation_time = localtime(time());
271 * The generated interface for the register allocator.
272 * Contains register classes and types and register constraints
273 * for all nodes where constraints were given in spec.
275 * DO NOT EDIT THIS FILE, your changes will be lost.
276 * Edit $specfile instead.
277 * created by: $0 $specfile $target_dir
278 * date: $creation_time
281 #include "gen_$arch\_regalloc_if.h"
282 #include "bearch_ia32_t.h" /* we need this to put the caller saved registers into the isa set */
283 #include "ia32_map_regs.h"
287 print OUT "arch_register_class_t $arch\_reg_classes[] = {\n ".join(",\n ", @obst_regclasses)."\n};\n\n";
289 print OUT "const $arch\_register_req_t *$arch\_projnum_reg_req_map[] = {\n ".join(",\n ", @obst_projnum_map)."\n};\n\n";
291 print OUT "void ".$arch."_register_init(void *isa_ptr) {\n";
292 print OUT " ia32_isa_t *isa = (ia32_isa_t *)isa_ptr;\n\n";
293 print OUT @obst_reginit;
296 print OUT @obst_limit_func;
302 # Remember the register class for each index in the given requirements.
303 # We need this information for requirements like "in_sX" or "out_dX"
304 # @return array of classes corresponding to the requirement for each index
306 sub build_inout_idx_class {
312 if (exists($n->{"reg_req"}{"$inout"})) {
313 my @reqs = @{ $n->{"reg_req"}{"$inout"} };
315 for (my $idx = 0; $idx <= $#reqs; $idx++) {
318 if ($reqs[$idx] eq "none") {
321 elsif (is_reg_class($reqs[$idx])) {
322 $class = $reqs[$idx];
325 my @regs = split(/ /, $reqs[$idx]);
326 GET_CLASS: foreach my $reg (@regs) {
327 if ($reg =~ /!?(in|out)\_r\d+/) {
328 $class = "UNKNOWN_CLASS";
331 $class = get_reg_class($reg);
332 if (!defined $class) {
333 die("Could not get ".uc($inout)." register class for '$op' pos $idx (reg $reg) ... exiting.\n");
342 push(@idx_class, $class);
350 # Generates the requirements for the given description
352 sub generate_requirements {
357 # get classes for the complementary direction
358 my $outin = ($inout eq "in") ? "out" : "in";
360 my @reqs = @{ $n->{"reg_req"}{"$inout"} };
362 for (my $idx = 0; $idx <= $#reqs; $idx++) {
365 my $tmp2 = "const $arch\_register_req_t _".$op."_reg_req_$inout\_$idx = ";
366 my $tmp = "const $arch\_register_req_t *".$op."_reg_req_$inout\_$idx = ";
368 push(@obst_header_all, "extern const $arch\_register_req_t *".$op."_reg_req_$inout\_$idx;\n");
370 if ($reqs[$idx] eq "none") {
371 $tmp .= "&$arch\_default_req_none;\n";
373 elsif (is_reg_class($reqs[$idx])) {
374 $tmp .= "&$arch\_default_req_".$arch."_".$reqs[$idx].";\n";
378 my ($class, $has_limit, $pos, $same) = build_subset_class_func($n, $op, $idx, (($inout eq "in") ? 1 : 0), $reqs[$idx]);
379 if (!defined($class)) {
380 die("Could not build subset for ".uc($inout)." requirements '$op' pos $idx ... exiting.\n");
383 push(@req_type_mask, "arch_register_req_type_limited");
386 push(@req_type_mask, "arch_register_req_type_should_be_".($same ? "same" : "different"));
388 $tmp .= "&_".$op."_reg_req_$inout\_$idx;\n";
391 $tmp2 .= " ".join(" | ", @req_type_mask).",\n";
392 $tmp2 .= " &$arch\_reg_classes[CLASS_$arch\_".$class."],\n";
393 $tmp2 .= " ".($has_limit ? "limit_reg_".$op."_$inout\_".$idx : "NULL").",\n";
396 $tmp2 .= " ".(defined($pos) ? $pos : "0")."\n};\n";
401 push(@obst_req, $tmp."\n");
407 # Determines whether $name is a specified register class or not.
408 # @return 1 if name is register class, 0 otherwise
412 return 1 if exists($reg_classes{"$name"});
417 # Returns the register class for a given register.
418 # @return class or undef
422 return $reg2class{"$reg"}{"class"} if (exists($reg2class{"$reg"}));
427 # Returns the index of a given register within it's register class.
428 # @return index or undef
432 return $reg2class{"$reg"}{"index"} if (exists($reg2class{"$reg"}));
437 # Generates the function for a given $op and a given IN-index
438 # which returns a subset of possible register from a register class
439 # @return classname from which the subset is derived or undef and
440 # pos which corresponds to in/out reference position or undef
442 sub build_subset_class_func {
448 # build function header
458 my $outin = $in ? "out" : "in";
459 my @regs = split(/ /, shift);
461 my @idx_class = build_inout_idx_class($n, $op, $outin);
463 # set/unset registers
464 CHECK_REQS: foreach (@regs) {
465 if (/(!)?$outin\_r(\d+)/) {
467 print STDERR "Multiple in/out references in one requirement not allowed.\n";
468 return (undef, undef, undef, undef);
471 $class = $idx_class[$2 - 1];
472 $pos = $in ? -$2 : $2 - 1;
477 if (substr($_, 0, 1) eq "!") {
478 if (defined($neg) && $neg == 0) {
479 # we have seen a positiv constraint as first one but this one is negative
480 # this doesn't make sense
481 print STDERR "Mixed positive and negative constraints for the same slot are not allowed.\n";
482 return (undef, undef, undef, undef);
485 if (!defined($neg)) {
487 push(@temp_obst, " bs = bitset_set_all(bs); /* allow all register (negative constraints given) */\n");
490 $_ = substr($_, 1); # skip '!'
494 if (defined($neg) && $neg == 1) {
495 # we have seen a negative constraint as first one but this one is positive
496 # this doesn't make sense
497 print STDERR "Mixed positive and negative constraints for the same slot are not allowed.\n";
498 return (undef, undef, undef, undef);
501 if (!defined($neg)) {
503 push(@temp_obst, " bs = bitset_clear_all(bs); /* disallow all register (positive constraints given) */\n");
508 # check if register belongs to one of the given classes
509 $temp = get_reg_class($_);
510 if (!defined($temp)) {
511 print STDERR "Unknown register '$_'!\n";
512 return (undef, undef, undef, undef);
516 if (!defined($class)) {
519 elsif ($class ne $temp) {
520 # all registers must belong to the same class
521 print STDERR "Registerclass mismatch. '$_' is not member of class '$class'.\n";
522 return (undef, undef, undef, undef);
527 push(@temp_obst, " bitset_clear(bs, ".get_reg_index($_)."); /* disallow $_ */\n");
531 push(@temp_obst, " bitset_set(bs, ".get_reg_index($_)."); /* allow $_ */\n");
535 if ($has_limit == 1) {
536 push(@obst_limit_func, "/* limit the possible registers for ".($in ? "IN" : "OUT")." $idx at op $op */\n");
537 push(@obst_limit_func, "void limit_reg_".$op."_".($in ? "in" : "out")."_".$idx."(const ir_node *irn, int pos, bitset_t *bs) {\n");
538 push(@obst_limit_func, @temp_obst);
539 push(@obst_limit_func, "}\n\n");
542 return ($class, $has_limit, $pos, $same);