nsz Git - libfirm/blob - ir/be/scripts/generate_regalloc_if.pl

   1 #!/usr/bin/perl -w
   2
   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().
   6 # Creation: 2005/11/14
   7 # $Id$
   8
   9 use strict;
  10 use Data::Dumper;
  11
  12 my $specfile   = $ARGV[0];
  13 my $target_dir = $ARGV[1];
  14
  15 our $arch;
  16 our %reg_classes;
  17 our %nodes;
  18
  19 # include spec file
  20
  21 my $return;
  22
  23 no strict "subs";
  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;
  28 }
  29 use strict "subs";
  30
  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";
  34
  35 # helper function
  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");
  41
  42 # stacks for output
  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
  53
  54 my $numregs;
  55 my $class_ptr;
  56 my $class_idx = 0;
  57
  58 my $tmp;
  59
  60 my %reg2class;
  61
  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";
  65 $tmp .= "  {\n";
  66 $tmp .= "    arch_register_req_type_none,\n";
  67 $tmp .= "    NULL,\n";
  68 $tmp .= "    NULL,\n";
  69 $tmp .= "    NULL\n";
  70 $tmp .= "  },\n";
  71 $tmp .= "  0\n";
  72 $tmp .= "};\n\n";
  73 push(@obst_req, $tmp);
  74
  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");
  77
  78 push(@obst_classdef, "#define N_CLASSES ".scalar(keys(%reg_classes))."\n");
  79
  80 my $global_projnum_idx = 0;
  81
  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;
  86
  87         $class_name = $arch."_".$class_name;
  88         $numregs    = "N_".$class_name."_REGS";
  89         $class_ptr  = "&".$arch."_reg_classes[CLASS_".$class_name."]";
  90
  91         push(@obst_regtypes, "#define $numregs ".($#class + 1)."\n");
  92         push(@obst_regtypes, "arch_register_t ".$class_name."_regs[$numregs];\n\n");
  93
  94         push(@obst_classdef, "#define CLASS_$class_name $class_idx\n");
  95         push(@obst_regclasses, "{ \"$class_name\", $numregs, ".$class_name."_regs }");
  96
  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";
 100         $tmp .= "  {\n";
 101         $tmp .= "    arch_register_req_type_normal,\n";
 102         $tmp .= "    $class_ptr,\n";
 103         $tmp .= "    NULL,\n";
 104         $tmp .= "    NULL\n";
 105         $tmp .= "  },\n";
 106         $tmp .= "  0\n";
 107         $tmp .= "};\n\n";
 108         push(@obst_req, $tmp);
 109
 110         push(@obst_header_all, "\nextern const $arch\_register_req_t $arch\_default_req_$class_name;\n");
 111
 112         my $idx = 0;
 113         push(@obst_reginit, "  /* Init of all registers in class '$class_name' */\n\n");
 114         foreach (@class) {
 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.
 120
 121                 my $limit_func_name = $arch."_limit_".$class_name."_".$_->{"name"};
 122
 123                 # push the function prototype
 124                 $tmp = "int $limit_func_name(const ir_node *irn, int pos, bitset_t *bs)";
 125                 push(@obst_defreq_head, $tmp.";\n");
 126
 127                 # push the function definition
 128                 $tmp .= " {\n";
 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
 131                 $tmp .= "    return 1;\n";
 132                 $tmp .= "}\n\n";
 133                 push(@obst_limit_func, $tmp);
 134
 135                 # push the default requirement struct
 136                 $tmp  = "const $arch\_register_req_t $arch\_default_req_$class_name\_".$_->{"name"}." = {\n";
 137                 $tmp .= "  {\n";
 138                 $tmp .= "    arch_register_req_type_limited,\n";
 139                 $tmp .= "    $class_ptr,\n";
 140                 $tmp .= "    $limit_func_name,\n";
 141                 $tmp .= "    NULL\n";
 142                 $tmp .= "  },\n";
 143                 $tmp .= "  0\n";
 144                 $tmp .= "};\n\n";
 145                 push(@obst_req, $tmp);
 146
 147                 push(@obst_header_all, "extern const $arch\_register_req_t $arch\_default_req_$class_name\_".$_->{"name"}.";\n");
 148
 149                 $reg2class{$_->{"name"}} = { "class" => $old_classname, "index" => $idx }; # remember reg to class for later use
 150                 push(@obst_regdef, "#define REG_".uc($_->{"name"})." $idx\n");
 151                 push(@obst_reginit, "  ".$class_name."_regs[$idx].name      = \"".$_->{"name"}."\";\n");
 152                 push(@obst_reginit, "  ".$class_name."_regs[$idx].reg_class = $class_ptr;\n");
 153                 push(@obst_reginit, "  ".$class_name."_regs[$idx].index     = $idx;\n");
 154                 push(@obst_reginit, "  ".$class_name."_regs[$idx].type      = ".$rt[$_->{"type"}].";\n");
 155                 if ($_->{"type"} == 2) {
 156                         # this is a caller saved register
 157                         push(@obst_reginit, "  ia32_set_reg_projnum(&".$class_name."_regs[$idx], $global_projnum_idx, isa->reg_projnum_map);\n");
 158                         push(@obst_projnum_map, "&$arch\_default_req_$class_name\_".$_->{"name"});
 159                         $global_projnum_idx++;
 160                 }
 161                 push(@obst_reginit, "\n");
 162                 $idx++;
 163         }
 164
 165         $class_idx++;
 166 }
 167
 168 push(@obst_regdef, "\n#define N_CALLER_SAVE_REGS ".scalar(@obst_projnum_map)."\n");
 169
 170 push(@obst_header_all, "\nextern const $arch\_register_req_t *$arch\_projnum_reg_req_map[N_CALLER_SAVE_REGS];\n\n");
 171 push(@obst_header_all, "\n/* node specific requirements */\n");
 172
 173 # generate node-register constraints
 174 foreach my $op (keys(%nodes)) {
 175         my %n = %{ $nodes{"$op"} };
 176
 177         next if (!exists($n{"reg_req"}));
 178
 179         $op = $arch."_".$op;
 180
 181         push(@obst_req, "/* IN requirements for '$op' */\n");
 182         # check for argument requirements
 183         if (exists($n{"reg_req"}{"in"})) {
 184                 generate_requirements(\%n, $op, "in");
 185         }
 186
 187         push(@obst_req, "/* OUT requirements for '$op' */\n");
 188         # check for result requirements
 189         if (exists($n{"reg_req"}{"out"})) {
 190                 generate_requirements(\%n, $op, "out");
 191         }
 192 }
 193
 194
 195
 196 # generate header _t (internal usage) file
 197 open(OUT, ">$target_h_t") || die("Could not open $target_h_t, reason: $!\n");
 198
 199 my $creation_time = localtime(time());
 200
 201 $tmp = uc($arch);
 202
 203 print OUT<<EOF;
 204 #ifndef _GEN_$tmp\_REGALLOC_IF_T_H_
 205 #define _GEN_$tmp\_REGALLOC_IF_T_H_
 206
 207 /**
 208  * Generated register classes from spec.
 209  *
 210  * DO NOT EDIT THIS FILE, your changes will be lost.
 211  * Edit $specfile instead.
 212  * created by: $0 $specfile $target_dir
 213  * date:       $creation_time
 214  */
 215
 216 #include "../bearch.h"
 217 #include "$arch\_nodes_attr.h"
 218
 219 EOF
 220
 221 print OUT @obst_regdef, "\n";
 222
 223 print OUT @obst_classdef, "\n";
 224
 225 print OUT @obst_regtypes, "\n";
 226
 227 print OUT @obst_defreq_head, "\n";
 228
 229 print OUT "void ".$arch."_register_init(void *isa_ptr);\n\n";
 230
 231 print OUT "\n#endif /* _GEN_$tmp\_REGALLOC_IF_T_H_ */\n";
 232
 233
 234
 235 # generate header (external usage) file
 236 open(OUT, ">$target_h") || die("Could not open $target_h, reason: $!\n");
 237
 238 $creation_time = localtime(time());
 239
 240 print OUT<<EOF;
 241 #ifndef _GEN_$tmp\_REGALLOC_IF_H_
 242 #define _GEN_$tmp\_REGALLOC_IF_H_
 243
 244 /**
 245  * Contains additional external requirements defs for external includes.
 246  *
 247  * DO NOT EDIT THIS FILE, your changes will be lost.
 248  * Edit $specfile instead.
 249  * created by: $0 $specfile $target_dir
 250  * date:       $creation_time
 251  */
 252
 253 #include "gen_$arch\_regalloc_if_t.h"
 254
 255 EOF
 256
 257 print OUT @obst_header_all;
 258
 259 print OUT "\n#endif /* _GEN_$tmp\_REGALLOC_IF_H_ */\n";
 260
 261 close(OUT);
 262
 263
 264
 265 # generate c inline file
 266 open(OUT, ">$target_c") || die("Could not open $target_c, reason: $!\n");
 267
 268 $creation_time = localtime(time());
 269
 270 print OUT<<EOF;
 271 /**
 272  * The generated interface for the register allocator.
 273  * Contains register classes and types and register constraints
 274  * for all nodes where constraints were given in spec.
 275  *
 276  * DO NOT EDIT THIS FILE, your changes will be lost.
 277  * Edit $specfile instead.
 278  * created by: $0 $specfile $target_dir
 279  * date:       $creation_time
 280  */
 281
 282 #include "gen_$arch\_regalloc_if.h"
 283 #include "bearch_ia32_t.h"   /* we need this to put the caller saved registers into the isa set */
 284 #include "ia32_map_regs.h"
 285
 286 EOF
 287
 288 print OUT "arch_register_class_t $arch\_reg_classes[] = {\n  ".join(",\n  ", @obst_regclasses)."\n};\n\n";
 289
 290 print OUT "const $arch\_register_req_t *$arch\_projnum_reg_req_map[] = {\n  ".join(",\n  ", @obst_projnum_map)."\n};\n\n";
 291
 292 print OUT "void ".$arch."_register_init(void *isa_ptr) {\n";
 293 print OUT "  ia32_isa_t *isa = (ia32_isa_t *)isa_ptr;\n\n";
 294 print OUT @obst_reginit;
 295 print OUT "}\n\n";
 296
 297 print OUT @obst_limit_func;
 298 print OUT @obst_req;
 299
 300 close(OUT);
 301
 302 ###
 303 # Remember the register class for each index in the given requirements.
 304 # We need this information for requirements like "in_sX" or "out_dX"
 305 # @return array of classes corresponding to the requirement for each index
 306 ###
 307 sub build_inout_idx_class {
 308         my $n     = shift;
 309         my $op    = shift;
 310         my $inout = shift;
 311         my @idx_class;
 312
 313         if (exists($n->{"reg_req"}{"$inout"})) {
 314                 my @reqs = @{ $n->{"reg_req"}{"$inout"} };
 315
 316                 for (my $idx = 0; $idx <= $#reqs; $idx++) {
 317                         my $class = undef;
 318
 319                         if ($reqs[$idx] eq "none") {
 320                                 $class = "none";
 321                         }
 322                         elsif (is_reg_class($reqs[$idx])) {
 323                                 $class = $reqs[$idx];
 324                         }
 325                         else {
 326                                 my @regs = split(/ /, $reqs[$idx]);
 327 GET_CLASS:              foreach my $reg (@regs) {
 328                                         if ($reg =~ /!?(in|out)\_r\d+/) {
 329                                                 $class = "UNKNOWN_CLASS";
 330                                         }
 331                                         else {
 332                                                 $class = get_reg_class($reg);
 333                                                 if (!defined $class) {
 334                                                         die("Could not get ".uc($inout)." register class for '$op' pos $idx (reg $reg) ... exiting.\n");
 335                                                 }
 336                                                 else {
 337                                                         last GET_CLASS;
 338                                                 } # !defined class
 339                                         } # if (reg =~ ...
 340                                 } # foreach
 341                         } # if
 342
 343                         push(@idx_class, $class);
 344                 } # for
 345         } # if
 346
 347         return @idx_class;
 348 }
 349
 350 ###
 351 # Generates the requirements for the given description
 352 ###
 353 sub generate_requirements {
 354         my $n     = shift;
 355         my $op    = shift;
 356         my $inout = shift;
 357
 358         # get classes for the complementary direction
 359         my $outin     = ($inout eq "in") ? "out" : "in";
 360
 361         my @reqs = @{ $n->{"reg_req"}{"$inout"} };
 362
 363         for (my $idx = 0; $idx <= $#reqs; $idx++) {
 364                 my $class = undef;
 365
 366                 my $tmp2 = "const $arch\_register_req_t _".$op."_reg_req_$inout\_$idx = ";
 367                 my $tmp  = "const $arch\_register_req_t *".$op."_reg_req_$inout\_$idx = ";
 368
 369                 push(@obst_header_all, "extern const $arch\_register_req_t *".$op."_reg_req_$inout\_$idx;\n");
 370
 371                 if ($reqs[$idx] eq "none") {
 372                         $tmp .= "&$arch\_default_req_none;\n";
 373                 }
 374                 elsif (is_reg_class($reqs[$idx])) {
 375                         $tmp .= "&$arch\_default_req_".$arch."_".$reqs[$idx].";\n";
 376                 }
 377                 else {
 378                         my @req_type_mask;
 379                         my ($class, $has_limit, $pos, $same) = build_subset_class_func($n, $op, $idx, (($inout eq "in") ? 1 : 0), $reqs[$idx]);
 380                         if (!defined($class)) {
 381                                 die("Could not build subset for ".uc($inout)." requirements '$op' pos $idx ... exiting.\n");
 382                         }
 383                         if ($has_limit) {
 384                                 push(@req_type_mask, "arch_register_req_type_limited");
 385                         }
 386                         if (defined($pos)) {
 387                                 push(@req_type_mask, "arch_register_req_type_should_be_".($same ? "same" : "different"));
 388                         }
 389                         $tmp  .= "&_".$op."_reg_req_$inout\_$idx;\n";
 390                         $tmp2 .= " {\n";
 391                         $tmp2 .= "  {\n";
 392                         $tmp2 .= "    ".join(" | ", @req_type_mask).",\n";
 393                         $tmp2 .= "    &$arch\_reg_classes[CLASS_$arch\_".$class."],\n";
 394                         $tmp2 .= "    ".($has_limit ? "limit_reg_".$op."_$inout\_".$idx : "NULL").",\n";
 395                         $tmp2 .= "    NULL\n";
 396                         $tmp2 .= "  },\n";
 397                         $tmp2 .= "  ".(defined($pos) ? $pos : "0")."\n};\n";
 398
 399                         $tmp   = $tmp2.$tmp;
 400                 }
 401
 402                 push(@obst_req, $tmp."\n");
 403         }
 404
 405 }
 406
 407 ###
 408 # Determines whether $name is a specified register class or not.
 409 # @return 1 if name is register class, 0 otherwise
 410 ###
 411 sub is_reg_class {
 412         my $name = shift;
 413         return 1 if exists($reg_classes{"$name"});
 414         return 0;
 415 }
 416
 417 ###
 418 # Returns the register class for a given register.
 419 # @return class or undef
 420 ###
 421 sub get_reg_class {
 422         my $reg = shift;
 423         return $reg2class{"$reg"}{"class"} if (exists($reg2class{"$reg"}));
 424         return undef;
 425 }
 426
 427 ###
 428 # Returns the index of a given register within it's register class.
 429 # @return index or undef
 430 ###
 431 sub get_reg_index {
 432         my $reg = shift;
 433         return $reg2class{"$reg"}{"index"} if (exists($reg2class{"$reg"}));
 434         return undef;
 435 }
 436
 437 ###
 438 # Generates the function for a given $op and a given IN-index
 439 # which returns a subset of possible register from a register class
 440 # @return classname from which the subset is derived or undef and
 441 #         pos which corresponds to in/out reference position or undef
 442 ###
 443 sub build_subset_class_func {
 444         my $neg   = undef;
 445         my $class = undef;
 446         my $temp;
 447         my $has_limit = 0;
 448
 449         # build function header
 450         my $n    = shift;
 451         my $op   = shift;
 452         my $idx  = shift;
 453         my $in   = shift;
 454         my $pos  = undef;
 455         my $same = 1;
 456
 457         my @temp_obst;
 458
 459         my $outin = $in ? "out" : "in";
 460         my @regs  = split(/ /, shift);
 461
 462         my @idx_class = build_inout_idx_class($n, $op, $outin);
 463
 464         # set/unset registers
 465 CHECK_REQS: foreach (@regs) {
 466                 if (/(!)?$outin\_r(\d+)/) {
 467                         if (defined($pos)) {
 468                                 print STDERR "Multiple in/out references in one requirement not allowed.\n";
 469                                 return (undef, undef, undef, undef);
 470                         }
 471                         $same  = 0 if ($1);
 472                         $class = $idx_class[$2 - 1];
 473                         $pos   = $in ? -$2 : $2 - 1;
 474                         next CHECK_REQS;
 475                 }
 476
 477                 # check for negate
 478                 if (substr($_, 0, 1) eq "!") {
 479                         if (defined($neg) && $neg == 0) {
 480                                 # we have seen a positiv constraint as first one but this one is negative
 481                                 # this doesn't make sense
 482                                 print STDERR "Mixed positive and negative constraints for the same slot are not allowed.\n";
 483                                 return (undef, undef, undef, undef);
 484                         }
 485
 486                         if (!defined($neg)) {
 487                                 $has_limit = 1;
 488                                 push(@temp_obst, "  bs = bitset_set_all(bs);     /* allow all register (negative constraints given) */\n");
 489                         }
 490
 491                         $_   = substr($_, 1); # skip '!'
 492                         $neg = 1;
 493                 }
 494                 else {
 495                         if (defined($neg) && $neg == 1) {
 496                                 # we have seen a negative constraint as first one but this one is positive
 497                                 # this doesn't make sense
 498                                 print STDERR "Mixed positive and negative constraints for the same slot are not allowed.\n";
 499                                 return (undef, undef, undef, undef);
 500                         }
 501
 502                         if (!defined($neg)) {
 503                                 $has_limit = 1;
 504                                 push(@temp_obst, "  bs = bitset_clear_all(bs);   /* disallow all register (positive constraints given) */\n");
 505                         }
 506                         $neg = 0;
 507                 }
 508
 509                 # check if register belongs to one of the given classes
 510                 $temp = get_reg_class($_);
 511                 if (!defined($temp)) {
 512                         print STDERR "Unknown register '$_'!\n";
 513                         return (undef, undef, undef, undef);
 514                 }
 515
 516                 # set class
 517                 if (!defined($class)) {
 518                         $class = $temp;
 519                 }
 520                 elsif ($class ne $temp) {
 521                         # all registers must belong to the same class
 522                         print STDERR "Registerclass mismatch. '$_' is not member of class '$class'.\n";
 523                         return (undef, undef, undef, undef);
 524                 }
 525
 526                 if ($neg == 1) {
 527                         $has_limit = 1;
 528                         push(@temp_obst, "  bitset_clear(bs, ".get_reg_index($_).");         /* disallow $_ */\n");
 529                 }
 530                 else {
 531                         $has_limit = 1;
 532                         push(@temp_obst, "  bitset_set(bs, ".get_reg_index($_).");           /* allow $_ */\n");
 533                 }
 534         }
 535
 536         if ($has_limit == 1) {
 537                 push(@obst_limit_func, "/* limit the possible registers for ".($in ? "IN" : "OUT")." $idx at op $op */\n");
 538                 push(@obst_limit_func, "int limit_reg_".$op."_".($in ? "in" : "out")."_".$idx."(const ir_node *irn, int pos, bitset_t *bs) {\n");
 539                 push(@obst_limit_func, @temp_obst);
 540                 push(@obst_limit_func, "\n  return ".($neg ? scalar(@{ $reg_classes{"$class"} }) - scalar(@regs) : scalar(@regs)).";\n");
 541                 push(@obst_limit_func, "}\n\n");
 542         }
 543
 544         return ($class, $has_limit, $pos, $same);
 545 }