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");
58 push(@types, "arch_register_type_joker");
62 push(@types, "arch_register_type_virtual");
65 return join(" | ", @types);
70 my @obst_regtypes_def; # stack for the register type variables definitions
71 my @obst_regtypes_decl;# stack for the register type variables declarations
72 my @obst_regclasses; # stack for the register class variables
73 my @obst_classdef; # stack to define a name for a class index
74 my @obst_regdef; # stack to define a name for a register index
75 my @obst_reginit; # stack for the register type inits
76 my @obst_req; # stack for the register requirements
77 my @obst_limit_func; # stack for functions to return a subset of a register class
78 my @obst_defreq_head; # stack for prototypes of default requirement function
79 my @obst_header_all; # stack for some extern struct defs needed for bearch_$arch include
80 my @obst_requirement_def; # stack for requirement name defines
90 # there is a default NONE requirement
91 $tmp = "/* Default NONE register requirements */\n";
92 $tmp .= "const $arch\_register_req_t $arch\_default_req_none = {\n";
94 $tmp .= " arch_register_req_type_none, /* register type */\n";
95 $tmp .= " NULL, /* register class */\n";
96 $tmp .= " NULL, /* limit function */\n";
97 $tmp .= " NULL, /* limit environment */\n";
98 $tmp .= " NULL, /* node for same */\n";
99 $tmp .= " NULL /* node for different */\n";
101 $tmp .= " 0, /* same pos */\n";
102 $tmp .= " 0 /* different pos */\n";
104 push(@obst_req, $tmp);
105 push(@obst_header_all, "extern const $arch\_register_req_t $arch\_default_req_none;\n");
107 push(@obst_classdef, "enum reg_classes {\n");
111 # generate register type and class variable, init function and default requirements
112 foreach my $class_name (keys(%reg_classes)) {
113 my @class = @{ $reg_classes{"$class_name"} };
114 my $old_classname = $class_name;
116 $class_name = $arch."_".$class_name;
117 $numregs = "N_".$class_name."_REGS";
118 $class_ptr = "&".$arch."_reg_classes[CLASS_".$class_name."]";
119 $class_mode = pop(@class)->{"mode"};
121 push(@obst_regtypes_decl, "extern arch_register_t ".$class_name."_regs[$numregs];\n");
122 push(@obst_regtypes_def, "arch_register_t ".$class_name."_regs[$numregs];\n");
124 push(@obst_classdef, " CLASS_$class_name = $class_idx,\n");
125 push(@obst_regclasses, "{ \"$class_name\", $numregs, NULL, ".$class_name."_regs }");
127 # there is a default NORMAL requirement for each class
128 $tmp = "/* Default NORMAL register requirements for class $class_name */\n";
129 $tmp .= "const $arch\_register_req_t $arch\_default_req_$class_name = {\n";
131 $tmp .= " arch_register_req_type_normal,\n";
132 $tmp .= " $class_ptr,\n";
133 $tmp .= " NULL, /* limit function */ \n";
134 $tmp .= " NULL, /* limit environment */\n";
135 $tmp .= " NULL, /* node for same */\n";
136 $tmp .= " NULL /* node for different */\n";
138 $tmp .= " 0, /* same pos */\n";
139 $tmp .= " 0 /* different pos */\n";
141 push(@obst_req, $tmp);
142 push(@obst_header_all, "extern const $arch\_register_req_t $arch\_default_req_$class_name;\n");
145 push(@obst_reginit, " /* Init of all registers in class '$class_name' */\n\n");
146 push(@obst_reginit, " /* set largest possible mode for '$class_name' */\n");
147 push(@obst_reginit, " $arch\_reg_classes[CLASS_".$class_name."].mode = $class_mode;\n\n");
148 push(@obst_regdef, "enum reg_".$class_name."_values {\n");
150 # For each class we build for each of it's member registers a limit function
151 # which limits the class to this particular register. We also build the
152 # corresponding requirement structs.
153 # We need those functions to set register requirements on demand in transformation
154 # esp. for Call and RegParams where we can mix int and float parameters.
156 my $limit_func_name = $arch."_limit_".$class_name."_".$_->{"name"};
158 # push the function prototype
159 $tmp = "void $limit_func_name(void *_unused, bitset_t *bs)";
160 push(@obst_defreq_head, $tmp.";\n");
162 # push the function definition
164 $tmp .= " bs = bitset_clear_all(bs);\n";
165 $tmp .= " bitset_set(bs, REG_".uc($_->{"name"}).");\n"; # REGISTER to index assignment is done some lines down
167 push(@obst_limit_func, $tmp);
169 # push the default requirement struct
170 $tmp = "const $arch\_register_req_t $arch\_default_req_$class_name\_".$_->{"name"}." = {\n";
172 $tmp .= " arch_register_req_type_limited,\n";
173 $tmp .= " $class_ptr,\n";
174 $tmp .= " $limit_func_name,\n";
175 $tmp .= " NULL, /* limit environment */\n";
176 $tmp .= " NULL, /* node for same */\n";
177 $tmp .= " NULL /* node for different */\n";
179 $tmp .= " 0, /* same pos */\n";
180 $tmp .= " 0 /* different pos */\n";
182 push(@obst_req, $tmp);
183 push(@obst_header_all,"extern const $arch\_register_req_t $arch\_default_req_$class_name\_".$_->{"name"}.";\n");
185 $reg2class{$_->{"name"}} = { "class" => $old_classname, "index" => $idx }; # remember reg to class for later use
186 push(@obst_regdef, " REG_".uc($_->{"name"})." = $idx,\n");
187 push(@obst_reginit, " ".$class_name."_regs[$idx].name = \"".$_->{"name"}."\";\n");
188 push(@obst_reginit, " ".$class_name."_regs[$idx].reg_class = $class_ptr;\n");
189 push(@obst_reginit, " ".$class_name."_regs[$idx].index = $idx;\n");
190 push(@obst_reginit, " ".$class_name."_regs[$idx].type = ".translate_reg_type($_->{"type"}).";\n");
191 push(@obst_reginit, "\n");
194 push(@obst_regdef, " $numregs = $idx\n");
195 push(@obst_regdef, "};\n\n");
200 push(@obst_classdef, " N_CLASSES = ".scalar(keys(%reg_classes))."\n");
201 push(@obst_classdef, "};\n\n");
203 # generate node-register constraints
204 foreach my $op (keys(%nodes)) {
205 my %n = %{ $nodes{"$op"} };
207 next if (!exists($n{"reg_req"}));
211 push(@obst_req, "/* IN requirements for '$op' */\n");
212 # check for argument requirements
213 if (exists($n{"reg_req"}{"in"})) {
214 generate_requirements(\%n, $op, "in");
217 push(@obst_req, "/* OUT requirements for '$op' */\n");
218 # check for result requirements
219 if (exists($n{"reg_req"}{"out"})) {
220 generate_requirements(\%n, $op, "out");
226 # generate header _t (internal usage) file
227 open(OUT, ">$target_h_t") || die("Could not open $target_h_t, reason: $!\n");
229 my $creation_time = localtime(time());
234 #ifndef _GEN_$tmp\_REGALLOC_IF_T_H_
235 #define _GEN_$tmp\_REGALLOC_IF_T_H_
238 * Generated register classes from spec.
240 * DO NOT EDIT THIS FILE, your changes will be lost.
241 * Edit $specfile instead.
242 * created by: $0 $specfile $target_dir
243 * date: $creation_time
248 print OUT @obst_requirement_def;
250 print OUT "\n#endif /* _GEN_$tmp\_REGALLOC_IF_T_H_ */\n";
254 # generate header (external usage) file
255 open(OUT, ">$target_h") || die("Could not open $target_h, reason: $!\n");
257 $creation_time = localtime(time());
260 #ifndef _GEN_$tmp\_REGALLOC_IF_H_
261 #define _GEN_$tmp\_REGALLOC_IF_H_
264 * Contains additional external requirements defs for external includes.
266 * DO NOT EDIT THIS FILE, your changes will be lost.
267 * Edit $specfile instead.
268 * created by: $0 $specfile $target_dir
269 * date: $creation_time
272 #include "../bearch.h"
273 #include "$arch\_nodes_attr.h"
277 print OUT @obst_regdef, "\n";
279 print OUT @obst_classdef, "\n";
281 print OUT @obst_regtypes_decl, "\n";
283 print OUT "extern arch_register_class_t $arch\_reg_classes[N_CLASSES];\n\n";
285 print OUT "void ".$arch."_register_init(void *isa_ptr);\n\n";
287 print OUT @obst_header_all, "\n";
289 print OUT @obst_defreq_head, "\n";
291 print OUT "\n#endif /* _GEN_$tmp\_REGALLOC_IF_H_ */\n";
297 # generate c inline file
298 open(OUT, ">$target_c") || die("Could not open $target_c, reason: $!\n");
300 $creation_time = localtime(time());
304 * The generated interface for the register allocator.
305 * Contains register classes and types and register constraints
306 * for all nodes where constraints were given in spec.
308 * DO NOT EDIT THIS FILE, your changes will be lost.
309 * Edit $specfile instead.
310 * created by: $0 $specfile $target_dir
311 * date: $creation_time
314 #include "gen_$arch\_regalloc_if.h"
315 #include "bearch_$arch\_t.h" /* we need this to put the caller saved registers into the isa set */
316 #include "$arch\_map_regs.h"
321 print OUT "arch_register_class_t $arch\_reg_classes[] = {\n ".join(",\n ", @obst_regclasses)."\n};\n\n";
323 print OUT @obst_regtypes_def, "\n";
325 print OUT "void ".$arch."_register_init(void *isa_ptr) {\n";
326 print OUT @obst_reginit;
329 print OUT @obst_limit_func;
336 # Remember the register class for each index in the given requirements.
337 # We need this information for requirements like "in_sX" or "out_dX"
338 # @return array of classes corresponding to the requirement for each index
340 sub build_inout_idx_class {
346 if (exists($n->{"reg_req"}{"$inout"})) {
347 my @reqs = @{ $n->{"reg_req"}{"$inout"} };
349 for (my $idx = 0; $idx <= $#reqs; $idx++) {
352 if ($reqs[$idx] eq "none") {
355 elsif (is_reg_class($reqs[$idx])) {
356 $class = $reqs[$idx];
359 my @regs = split(/ /, $reqs[$idx]);
360 GET_CLASS: foreach my $reg (@regs) {
361 if ($reg =~ /!?(in|out)\_r\d+/ || $reg =~ /!in/) {
362 $class = "UNKNOWN_CLASS";
365 $class = get_reg_class($reg);
366 if (!defined $class) {
367 die("Could not get ".uc($inout)." register class for '$op' pos $idx (reg $reg) ... exiting.\n");
376 push(@idx_class, $class);
384 # Generates the requirements for the given description
386 sub generate_requirements {
391 # get classes for the complementary direction
392 my $outin = ($inout eq "in") ? "out" : "in";
394 my @reqs = @{ $n->{"reg_req"}{"$inout"} };
396 for (my $idx = 0; $idx <= $#reqs; $idx++) {
399 my $tmp2 = "const $arch\_register_req_t _".$op."_reg_req_$inout\_$idx = ";
400 my $tmp = "#define ".$op."_reg_req_$inout\_$idx ";
402 if ($reqs[$idx] eq "none") {
403 $tmp .= "&$arch\_default_req_none\n";
405 elsif ($reqs[$idx] =~ /^new_reg_(.*)$/) {
406 if (is_reg_class($1)) {
407 $tmp .= "&_".$op."_reg_req_$inout\_$idx\n";
410 $tmp2 .= " arch_register_req_type_should_be_different_from_all,\n";
411 $tmp2 .= " &$arch\_reg_classes[CLASS_$arch\_".$1."],\n";
412 $tmp2 .= " NULL, /* limit function */\n";
413 $tmp2 .= " NULL, /* limit environment */\n";
414 $tmp2 .= " NULL, /* same node */\n";
415 $tmp2 .= " NULL /* different node */\n";
421 push(@obst_req, $tmp2."\n");
422 push(@obst_header_all, "extern const $arch\_register_req_t _".$op."_reg_req_$inout\_$idx;\n");
425 print STDERR "Invalid register class '$1' given in OUT requirement $idx for '$op'.\n";
428 elsif (is_reg_class($reqs[$idx])) {
429 $tmp .= "&$arch\_default_req_".$arch."_".$reqs[$idx]."\n";
433 my ($class, $has_limit, $same_pos, $different_pos) = build_subset_class_func($n, $op, $idx, (($inout eq "in") ? 1 : 0), $reqs[$idx]);
435 if (!defined($class)) {
436 die("Could not build subset for ".uc($inout)." requirements '$op' pos $idx ... exiting.\n");
440 push(@req_type_mask, "arch_register_req_type_limited");
442 if (defined($same_pos)) {
443 push(@req_type_mask, "arch_register_req_type_should_be_same");
445 if (defined($different_pos)) {
446 if ($different_pos == 666) {
447 push(@req_type_mask, "arch_register_req_type_should_be_different_from_all");
448 undef $different_pos;
451 push(@req_type_mask, "arch_register_req_type_should_be_different");
455 $tmp .= "&_".$op."_reg_req_$inout\_$idx\n";
458 $tmp2 .= " ".join(" | ", @req_type_mask).",\n";
459 $tmp2 .= " &$arch\_reg_classes[CLASS_$arch\_".$class."],\n";
460 $tmp2 .= " ".($has_limit ? "limit_reg_".$op."_$inout\_".$idx : "NULL").",\n";
461 $tmp2 .= " NULL, /* limit environment */\n";
462 $tmp2 .= " NULL, /* same node */\n";
463 $tmp2 .= " NULL /* different node */\n";
465 $tmp2 .= " ".(defined($same_pos) ? $same_pos : "0").",\n";
466 $tmp2 .= " ".(defined($different_pos) ? $different_pos : "0")."\n";
469 push(@obst_req, $tmp2."\n");
470 push(@obst_header_all, "extern const $arch\_register_req_t _".$op."_reg_req_$inout\_$idx;\n");
473 push(@obst_requirement_def, $tmp);
479 # Determines whether $name is a specified register class or not.
480 # @return 1 if name is register class, 0 otherwise
484 return 1 if exists($reg_classes{"$name"});
489 # Returns the register class for a given register.
490 # @return class or undef
494 $reg = substr($reg, 1) if ($reg =~ /!.*/);
495 return $reg2class{"$reg"}{"class"} if (exists($reg2class{"$reg"}));
500 # Returns the index of a given register within it's register class.
501 # @return index or undef
505 return $reg2class{"$reg"}{"index"} if (exists($reg2class{"$reg"}));
510 # Generates the function for a given $op and a given IN-index
511 # which returns a subset of possible register from a register class
512 # @return classname from which the subset is derived or undef and
513 # pos which corresponds to in/out reference position or undef
515 sub build_subset_class_func {
519 my $same_pos = undef;
520 my $different_pos = undef;
527 # build function header
533 my $outin = $in ? "out" : "in";
534 my @regs = split(/ /, shift);
536 my @idx_class = build_inout_idx_class($n, $op, $outin);
538 # set/unset registers
539 CHECK_REQS: foreach (@regs) {
540 if (/(!)?$outin\_r(\d+)/) {
541 if (($1 && defined($different_pos)) || (!$1 && defined($same_pos))) {
542 print STDERR "Multiple in/out references of same type in one requirement not allowed.\n";
543 return (undef, undef, undef, undef);
547 $different_pos = $in ? -$2 : $2 - 1;
550 $same_pos = $in ? -$2 : $2 - 1;
553 $class = $idx_class[$2 - 1];
557 $class = $idx_class[0];
558 return ($class, 0, undef, 666);
562 if (substr($_, 0, 1) eq "!") {
563 if (defined($neg) && $neg == 0) {
564 # we have seen a positiv constraint as first one but this one is negative
565 # this doesn't make sense
566 print STDERR "Mixed positive and negative constraints for the same slot are not allowed.\n";
567 return (undef, undef, undef, undef);
570 if (!defined($neg)) {
572 push(@obst_init, " bs = bitset_set_all(bs); /* allow all register (negative constraints given) */\n");
575 $_ = substr($_, 1); # skip '!'
579 if (defined($neg) && $neg == 1) {
580 # we have seen a negative constraint as first one but this one is positive
581 # this doesn't make sense
582 print STDERR "Mixed positive and negative constraints for the same slot are not allowed.\n";
583 return (undef, undef, undef, undef);
586 if (!defined($neg)) {
588 push(@obst_init, " bs = bitset_clear_all(bs); /* disallow all register (positive constraints given) */\n");
593 # check if register belongs to one of the given classes
594 $temp = get_reg_class($_);
595 if (!defined($temp)) {
596 print STDERR "Unknown register '$_'!\n";
597 return (undef, undef, undef, undef);
601 if (!defined($class)) {
604 elsif ($class ne $temp) {
605 # all registers must belong to the same class
606 print STDERR "Registerclass mismatch. '$_' is not member of class '$class'.\n";
607 return (undef, undef, undef, undef);
612 push(@obst_limits, " bitset_clear(bs, ".get_reg_index($_)."); /* disallow $_ */\n");
616 push(@obst_limits, " bitset_set(bs, ".get_reg_index($_)."); /* allow $_ */\n");
620 my @cur_class = @{ $reg_classes{"$class"} };
621 for (my $idx = 0; $idx <= $#cur_class; $idx++) {
622 if (defined($cur_class[$idx]{"type"}) && ($cur_class[$idx]{"type"} & 4)) {
623 push(@obst_ignore, " bitset_clear(bs, ".get_reg_index($cur_class[$idx]{"name"}).");");
624 push(@obst_ignore, " /* disallow ignore reg ".$cur_class[$idx]{"name"}." */\n");
628 if ($has_limit == 1) {
629 push(@obst_header_all, "void limit_reg_".$op."_".($in ? "in" : "out")."_".$idx."(void *_unused, bitset_t *bs);\n");
631 push(@obst_limit_func, "/* limit the possible registers for ".($in ? "IN" : "OUT")." $idx at op $op */\n");
632 push(@obst_limit_func, "void limit_reg_".$op."_".($in ? "in" : "out")."_".$idx."(void *_unused, bitset_t *bs) {\n");
633 push(@obst_limit_func, @obst_init);
634 push(@obst_limit_func, @obst_ignore);
635 push(@obst_limit_func, @obst_limits);
636 push(@obst_limit_func, "}\n\n");
639 return ($class, $has_limit, $same_pos, $different_pos);