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 sub translate_reg_type {
40 return "arch_register_type_none";
46 push(@types, "arch_register_type_caller_save");
50 push(@types, "arch_register_type_callee_save");
54 push(@types, "arch_register_type_ignore");
57 return join(" | ", @types);
62 my @obst_regtypes; # stack for the register type variables
63 my @obst_regclasses; # stack for the register class variables
64 my @obst_classdef; # stack to define a name for a class index
65 my @obst_regdef; # stack to define a name for a register index
66 my @obst_reginit; # stack for the register type inits
67 my @obst_req; # stack for the register requirements
68 my @obst_limit_func; # stack for functions to return a subset of a register class
69 my @obst_defreq_head; # stack for prototypes of default requirement function
70 my @obst_header_all; # stack for some extern struct defs needed for bearch_$arch include
71 my @obst_requirement_def; # stack for requirement name defines
81 # there is a default NONE requirement
82 $tmp = "/* Default NONE register requirements */\n";
83 $tmp .= "const $arch\_register_req_t $arch\_default_req_none = {\n";
85 $tmp .= " arch_register_req_type_none, /* register type */\n";
86 $tmp .= " NULL, /* register class */\n";
87 $tmp .= " NULL, /* limit function */\n";
88 $tmp .= " NULL, /* limit environment */\n";
89 $tmp .= " NULL, /* node for same */\n";
90 $tmp .= " NULL /* node for different */\n";
92 $tmp .= " 0, /* same pos */\n";
93 $tmp .= " 0 /* different pos */\n";
95 push(@obst_req, $tmp);
96 push(@obst_header_all, "extern const $arch\_register_req_t $arch\_default_req_none;\n");
98 push(@obst_classdef, "#define N_CLASSES ".scalar(keys(%reg_classes))."\n");
102 # generate register type and class variable, init function and default requirements
103 foreach my $class_name (keys(%reg_classes)) {
104 my @class = @{ $reg_classes{"$class_name"} };
105 my $old_classname = $class_name;
107 $class_name = $arch."_".$class_name;
108 $numregs = "N_".$class_name."_REGS";
109 $class_ptr = "&".$arch."_reg_classes[CLASS_".$class_name."]";
110 $class_mode = pop(@class)->{"mode"};
112 push(@obst_regtypes, "#define $numregs ".($#class + 1)."\n");
113 push(@obst_regtypes, "arch_register_t ".$class_name."_regs[$numregs];\n\n");
115 push(@obst_classdef, "#define CLASS_$class_name $class_idx\n");
116 push(@obst_regclasses, "{ \"$class_name\", $numregs, NULL, ".$class_name."_regs }");
118 # there is a default NORMAL requirement for each class
119 $tmp = "/* Default NORMAL register requirements for class $class_name */\n";
120 $tmp .= "const $arch\_register_req_t $arch\_default_req_$class_name = {\n";
122 $tmp .= " arch_register_req_type_normal,\n";
123 $tmp .= " $class_ptr,\n";
124 $tmp .= " NULL, /* limit function */ \n";
125 $tmp .= " NULL, /* limit environment */\n";
126 $tmp .= " NULL, /* node for same */\n";
127 $tmp .= " NULL /* node for different */\n";
129 $tmp .= " 0, /* same pos */\n";
130 $tmp .= " 0 /* different pos */\n";
132 push(@obst_req, $tmp);
133 push(@obst_header_all, "extern const $arch\_register_req_t $arch\_default_req_$class_name;\n");
136 push(@obst_reginit, " /* Init of all registers in class '$class_name' */\n\n");
137 push(@obst_reginit, " /* set largest possible mode for '$class_name' */\n");
138 push(@obst_reginit, " $arch\_reg_classes[CLASS_".$class_name."].mode = $class_mode;\n\n");
140 # For each class we build for each of it's member registers a limit function
141 # which limits the class to this particular register. We also build the
142 # corresponding requirement structs.
143 # We need those functions to set register requirements on demand in transformation
144 # esp. for Call and RegParams where we can mix int and float parameters.
146 my $limit_func_name = $arch."_limit_".$class_name."_".$_->{"name"};
148 # push the function prototype
149 $tmp = "void $limit_func_name(void *_unused, bitset_t *bs)";
150 push(@obst_defreq_head, $tmp.";\n");
152 # push the function definition
154 $tmp .= " bs = bitset_clear_all(bs);\n";
155 $tmp .= " bitset_set(bs, REG_".uc($_->{"name"}).");\n"; # REGISTER to index assignment is done some lines down
157 push(@obst_limit_func, $tmp);
159 # push the default requirement struct
160 $tmp = "const $arch\_register_req_t $arch\_default_req_$class_name\_".$_->{"name"}." = {\n";
162 $tmp .= " arch_register_req_type_limited,\n";
163 $tmp .= " $class_ptr,\n";
164 $tmp .= " $limit_func_name,\n";
165 $tmp .= " NULL, /* limit environment */\n";
166 $tmp .= " NULL, /* node for same */\n";
167 $tmp .= " NULL /* node for different */\n";
169 $tmp .= " 0, /* same pos */\n";
170 $tmp .= " 0 /* different pos */\n";
172 push(@obst_req, $tmp);
173 push(@obst_header_all,"extern const $arch\_register_req_t $arch\_default_req_$class_name\_".$_->{"name"}.";\n");
175 $reg2class{$_->{"name"}} = { "class" => $old_classname, "index" => $idx }; # remember reg to class for later use
176 push(@obst_regdef, "#define REG_".uc($_->{"name"})." $idx\n");
177 push(@obst_reginit, " ".$class_name."_regs[$idx].name = \"".$_->{"name"}."\";\n");
178 push(@obst_reginit, " ".$class_name."_regs[$idx].reg_class = $class_ptr;\n");
179 push(@obst_reginit, " ".$class_name."_regs[$idx].index = $idx;\n");
180 push(@obst_reginit, " ".$class_name."_regs[$idx].type = ".translate_reg_type($_->{"type"}).";\n");
181 push(@obst_reginit, "\n");
188 # generate node-register constraints
189 foreach my $op (keys(%nodes)) {
190 my %n = %{ $nodes{"$op"} };
192 next if (!exists($n{"reg_req"}));
196 push(@obst_req, "/* IN requirements for '$op' */\n");
197 # check for argument requirements
198 if (exists($n{"reg_req"}{"in"})) {
199 generate_requirements(\%n, $op, "in");
202 push(@obst_req, "/* OUT requirements for '$op' */\n");
203 # check for result requirements
204 if (exists($n{"reg_req"}{"out"})) {
205 generate_requirements(\%n, $op, "out");
211 # generate header _t (internal usage) file
212 open(OUT, ">$target_h_t") || die("Could not open $target_h_t, reason: $!\n");
214 my $creation_time = localtime(time());
219 #ifndef _GEN_$tmp\_REGALLOC_IF_T_H_
220 #define _GEN_$tmp\_REGALLOC_IF_T_H_
223 * Generated register classes from spec.
225 * DO NOT EDIT THIS FILE, your changes will be lost.
226 * Edit $specfile instead.
227 * created by: $0 $specfile $target_dir
228 * date: $creation_time
233 print OUT @obst_requirement_def;
235 print OUT "\n#endif /* _GEN_$tmp\_REGALLOC_IF_T_H_ */\n";
239 # generate header (external usage) file
240 open(OUT, ">$target_h") || die("Could not open $target_h, reason: $!\n");
242 $creation_time = localtime(time());
245 #ifndef _GEN_$tmp\_REGALLOC_IF_H_
246 #define _GEN_$tmp\_REGALLOC_IF_H_
249 * Contains additional external requirements defs for external includes.
251 * DO NOT EDIT THIS FILE, your changes will be lost.
252 * Edit $specfile instead.
253 * created by: $0 $specfile $target_dir
254 * date: $creation_time
257 #include "../bearch.h"
258 #include "$arch\_nodes_attr.h"
262 print OUT @obst_regdef, "\n";
264 print OUT @obst_classdef, "\n";
266 print OUT @obst_regtypes, "\n";
268 print OUT "extern arch_register_class_t $arch\_reg_classes[N_CLASSES];\n\n";
270 print OUT "void ".$arch."_register_init(void *isa_ptr);\n\n";
272 print OUT @obst_header_all, "\n";
274 print OUT @obst_defreq_head, "\n";
276 print OUT "\n#endif /* _GEN_$tmp\_REGALLOC_IF_H_ */\n";
282 # generate c inline file
283 open(OUT, ">$target_c") || die("Could not open $target_c, reason: $!\n");
285 $creation_time = localtime(time());
289 * The generated interface for the register allocator.
290 * Contains register classes and types and register constraints
291 * for all nodes where constraints were given in spec.
293 * DO NOT EDIT THIS FILE, your changes will be lost.
294 * Edit $specfile instead.
295 * created by: $0 $specfile $target_dir
296 * date: $creation_time
299 #include "gen_$arch\_regalloc_if.h"
300 #include "bearch_ia32_t.h" /* we need this to put the caller saved registers into the isa set */
301 #include "ia32_map_regs.h"
306 print OUT "arch_register_class_t $arch\_reg_classes[] = {\n ".join(",\n ", @obst_regclasses)."\n};\n\n";
308 print OUT "void ".$arch."_register_init(void *isa_ptr) {\n";
309 print OUT " ia32_isa_t *isa = (ia32_isa_t *)isa_ptr;\n\n";
310 print OUT @obst_reginit;
313 print OUT @obst_limit_func;
320 # Remember the register class for each index in the given requirements.
321 # We need this information for requirements like "in_sX" or "out_dX"
322 # @return array of classes corresponding to the requirement for each index
324 sub build_inout_idx_class {
330 if (exists($n->{"reg_req"}{"$inout"})) {
331 my @reqs = @{ $n->{"reg_req"}{"$inout"} };
333 for (my $idx = 0; $idx <= $#reqs; $idx++) {
336 if ($reqs[$idx] eq "none") {
339 elsif (is_reg_class($reqs[$idx])) {
340 $class = $reqs[$idx];
343 my @regs = split(/ /, $reqs[$idx]);
344 GET_CLASS: foreach my $reg (@regs) {
345 if ($reg =~ /!?(in|out)\_r\d+/) {
346 $class = "UNKNOWN_CLASS";
349 $class = get_reg_class($reg);
350 if (!defined $class) {
351 die("Could not get ".uc($inout)." register class for '$op' pos $idx (reg $reg) ... exiting.\n");
360 push(@idx_class, $class);
368 # Generates the requirements for the given description
370 sub generate_requirements {
375 # get classes for the complementary direction
376 my $outin = ($inout eq "in") ? "out" : "in";
378 my @reqs = @{ $n->{"reg_req"}{"$inout"} };
380 for (my $idx = 0; $idx <= $#reqs; $idx++) {
383 my $tmp2 = "const $arch\_register_req_t _".$op."_reg_req_$inout\_$idx = ";
384 my $tmp = "#define ".$op."_reg_req_$inout\_$idx ";
386 if ($reqs[$idx] eq "none") {
387 $tmp .= "&$arch\_default_req_none\n";
389 elsif (is_reg_class($reqs[$idx])) {
390 $tmp .= "&$arch\_default_req_".$arch."_".$reqs[$idx]."\n";
394 my ($class, $has_limit, $same_pos, $different_pos) = build_subset_class_func($n, $op, $idx, (($inout eq "in") ? 1 : 0), $reqs[$idx]);
396 if (!defined($class)) {
397 die("Could not build subset for ".uc($inout)." requirements '$op' pos $idx ... exiting.\n");
401 push(@req_type_mask, "arch_register_req_type_limited");
403 if (defined($same_pos)) {
404 push(@req_type_mask, "arch_register_req_type_should_be_same");
406 if (defined($different_pos)) {
407 push(@req_type_mask, "arch_register_req_type_should_be_different");
410 $tmp .= "&_".$op."_reg_req_$inout\_$idx\n";
413 $tmp2 .= " ".join(" | ", @req_type_mask).",\n";
414 $tmp2 .= " &$arch\_reg_classes[CLASS_$arch\_".$class."],\n";
415 $tmp2 .= " ".($has_limit ? "limit_reg_".$op."_$inout\_".$idx : "NULL").",\n";
416 $tmp2 .= " NULL, /* limit environment */\n";
417 $tmp2 .= " NULL, /* same node */\n";
418 $tmp2 .= " NULL /* different node */\n";
420 $tmp2 .= " ".(defined($same_pos) ? $same_pos : "0").",\n";
421 $tmp2 .= " ".(defined($different_pos) ? $different_pos : "0")."\n";
424 push(@obst_req, $tmp2."\n");
425 push(@obst_header_all, "extern const $arch\_register_req_t _".$op."_reg_req_$inout\_$idx;\n");
428 push(@obst_requirement_def, $tmp);
434 # Determines whether $name is a specified register class or not.
435 # @return 1 if name is register class, 0 otherwise
439 return 1 if exists($reg_classes{"$name"});
444 # Returns the register class for a given register.
445 # @return class or undef
449 return $reg2class{"$reg"}{"class"} if (exists($reg2class{"$reg"}));
454 # Returns the index of a given register within it's register class.
455 # @return index or undef
459 return $reg2class{"$reg"}{"index"} if (exists($reg2class{"$reg"}));
464 # Generates the function for a given $op and a given IN-index
465 # which returns a subset of possible register from a register class
466 # @return classname from which the subset is derived or undef and
467 # pos which corresponds to in/out reference position or undef
469 sub build_subset_class_func {
473 my $same_pos = undef;
474 my $different_pos = undef;
479 # build function header
485 my $outin = $in ? "out" : "in";
486 my @regs = split(/ /, shift);
488 my @idx_class = build_inout_idx_class($n, $op, $outin);
490 # set/unset registers
491 CHECK_REQS: foreach (@regs) {
492 if (/(!)?$outin\_r(\d+)/) {
493 if (($1 && defined($different_pos)) || defined($same_pos)) {
494 print STDERR "Multiple in/out references of same type in one requirement not allowed.\n";
495 return (undef, undef, undef, undef);
499 $different_pos = $in ? -$2 : $2 - 1;
502 $same_pos = $in ? -$2 : $2 - 1;
505 $class = $idx_class[$2 - 1];
510 if (substr($_, 0, 1) eq "!") {
511 if (defined($neg) && $neg == 0) {
512 # we have seen a positiv constraint as first one but this one is negative
513 # this doesn't make sense
514 print STDERR "Mixed positive and negative constraints for the same slot are not allowed.\n";
515 return (undef, undef, undef, undef);
518 if (!defined($neg)) {
520 push(@temp_obst, " bs = bitset_set_all(bs); /* allow all register (negative constraints given) */\n");
523 $_ = substr($_, 1); # skip '!'
527 if (defined($neg) && $neg == 1) {
528 # we have seen a negative constraint as first one but this one is positive
529 # this doesn't make sense
530 print STDERR "Mixed positive and negative constraints for the same slot are not allowed.\n";
531 return (undef, undef, undef, undef);
534 if (!defined($neg)) {
536 push(@temp_obst, " bs = bitset_clear_all(bs); /* disallow all register (positive constraints given) */\n");
541 # check if register belongs to one of the given classes
542 $temp = get_reg_class($_);
543 if (!defined($temp)) {
544 print STDERR "Unknown register '$_'!\n";
545 return (undef, undef, undef, undef);
549 if (!defined($class)) {
552 elsif ($class ne $temp) {
553 # all registers must belong to the same class
554 print STDERR "Registerclass mismatch. '$_' is not member of class '$class'.\n";
555 return (undef, undef, undef, undef);
560 push(@temp_obst, " bitset_clear(bs, ".get_reg_index($_)."); /* disallow $_ */\n");
564 push(@temp_obst, " bitset_set(bs, ".get_reg_index($_)."); /* allow $_ */\n");
568 if ($has_limit == 1) {
569 push(@obst_header_all, "void limit_reg_".$op."_".($in ? "in" : "out")."_".$idx."(void *_unused, bitset_t *bs);\n");
571 push(@obst_limit_func, "/* limit the possible registers for ".($in ? "IN" : "OUT")." $idx at op $op */\n");
572 push(@obst_limit_func, "void limit_reg_".$op."_".($in ? "in" : "out")."_".$idx."(void *_unused, bitset_t *bs) {\n");
573 push(@obst_limit_func, @temp_obst);
574 push(@obst_limit_func, "}\n\n");
577 return ($class, $has_limit, $same_pos, $different_pos);