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 sub translate_reg_type {
  37         my $t = shift;
  38
  39         if ($t == 0) {
  40                 return "arch_register_type_none";
  41         }
  42         else {
  43                 my @types;
  44
  45                 if ($t & 1) {
  46                         push(@types, "arch_register_type_caller_save");
  47                 }
  48
  49                 if ($t & 2) {
  50                         push(@types, "arch_register_type_callee_save");
  51                 }
  52
  53                 if ($t & 4) {
  54                         push(@types, "arch_register_type_ignore");
  55                 }
  56
  57                 return join(" | ", @types);
  58         }
  59 }
  60
  61 # stacks for output
  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
  72
  73 my $numregs;
  74 my $class_ptr;
  75 my $class_idx = 0;
  76
  77 my $tmp;
  78
  79 my %reg2class;
  80
  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";
  84 $tmp .= "  {\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";
  91 $tmp .= "  },\n";
  92 $tmp .= "  0,                              /* same pos */\n";
  93 $tmp .= "  0                               /* different pos */\n";
  94 $tmp .= "};\n\n";
  95 push(@obst_req, $tmp);
  96 push(@obst_header_all, "extern const $arch\_register_req_t $arch\_default_req_none;\n");
  97
  98 push(@obst_classdef, "#define N_CLASSES ".scalar(keys(%reg_classes))."\n");
  99
 100 my $class_mode;
 101
 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;
 106
 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"};
 111
 112         push(@obst_regtypes, "#define $numregs ".($#class + 1)."\n");
 113         push(@obst_regtypes, "arch_register_t ".$class_name."_regs[$numregs];\n\n");
 114
 115         push(@obst_classdef, "#define CLASS_$class_name $class_idx\n");
 116         push(@obst_regclasses, "{ \"$class_name\", $numregs, NULL, ".$class_name."_regs }");
 117
 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";
 121         $tmp .= "  {\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";
 128         $tmp .= "  },\n";
 129         $tmp .= "  0,                         /* same pos */\n";
 130         $tmp .= "  0                          /* different pos */\n";
 131         $tmp .= "};\n\n";
 132         push(@obst_req, $tmp);
 133         push(@obst_header_all, "extern const $arch\_register_req_t $arch\_default_req_$class_name;\n");
 134
 135         my $idx = 0;
 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");
 139         foreach (@class) {
 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.
 145
 146                 my $limit_func_name = $arch."_limit_".$class_name."_".$_->{"name"};
 147
 148                 # push the function prototype
 149                 $tmp = "void $limit_func_name(void *_unused, bitset_t *bs)";
 150                 push(@obst_defreq_head, $tmp.";\n");
 151
 152                 # push the function definition
 153                 $tmp .= " {\n";
 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
 156                 $tmp .= "}\n\n";
 157                 push(@obst_limit_func, $tmp);
 158
 159                 # push the default requirement struct
 160                 $tmp  = "const $arch\_register_req_t $arch\_default_req_$class_name\_".$_->{"name"}." = {\n";
 161                 $tmp .= "  {\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";
 168                 $tmp .= "  },\n";
 169                 $tmp .= "  0,                          /* same pos */\n";
 170                 $tmp .= "  0                           /* different pos */\n";
 171                 $tmp .= "};\n\n";
 172                 push(@obst_req, $tmp);
 173                 push(@obst_header_all,"extern const $arch\_register_req_t $arch\_default_req_$class_name\_".$_->{"name"}.";\n");
 174
 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");
 182                 $idx++;
 183         }
 184
 185         $class_idx++;
 186 }
 187
 188 # generate node-register constraints
 189 foreach my $op (keys(%nodes)) {
 190         my %n = %{ $nodes{"$op"} };
 191
 192         next if (!exists($n{"reg_req"}));
 193
 194         $op = $arch."_".$op;
 195
 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");
 200         }
 201
 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");
 206         }
 207 }
 208
 209
 210
 211 # generate header _t (internal usage) file
 212 open(OUT, ">$target_h_t") || die("Could not open $target_h_t, reason: $!\n");
 213
 214 my $creation_time = localtime(time());
 215
 216 $tmp = uc($arch);
 217
 218 print OUT<<EOF;
 219 #ifndef _GEN_$tmp\_REGALLOC_IF_T_H_
 220 #define _GEN_$tmp\_REGALLOC_IF_T_H_
 221
 222 /**
 223  * Generated register classes from spec.
 224  *
 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
 229  */
 230
 231 EOF
 232
 233 print OUT @obst_requirement_def;
 234
 235 print OUT "\n#endif /* _GEN_$tmp\_REGALLOC_IF_T_H_ */\n";
 236
 237
 238
 239 # generate header (external usage) file
 240 open(OUT, ">$target_h") || die("Could not open $target_h, reason: $!\n");
 241
 242 $creation_time = localtime(time());
 243
 244 print OUT<<EOF;
 245 #ifndef _GEN_$tmp\_REGALLOC_IF_H_
 246 #define _GEN_$tmp\_REGALLOC_IF_H_
 247
 248 /**
 249  * Contains additional external requirements defs for external includes.
 250  *
 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
 255  */
 256
 257 #include "../bearch.h"
 258 #include "$arch\_nodes_attr.h"
 259
 260 EOF
 261
 262 print OUT @obst_regdef, "\n";
 263
 264 print OUT @obst_classdef, "\n";
 265
 266 print OUT @obst_regtypes, "\n";
 267
 268 print OUT "extern arch_register_class_t $arch\_reg_classes[N_CLASSES];\n\n";
 269
 270 print OUT "void ".$arch."_register_init(void *isa_ptr);\n\n";
 271
 272 print OUT @obst_header_all, "\n";
 273
 274 print OUT @obst_defreq_head, "\n";
 275
 276 print OUT "\n#endif /* _GEN_$tmp\_REGALLOC_IF_H_ */\n";
 277
 278 close(OUT);
 279
 280
 281
 282 # generate c inline file
 283 open(OUT, ">$target_c") || die("Could not open $target_c, reason: $!\n");
 284
 285 $creation_time = localtime(time());
 286
 287 print OUT<<EOF;
 288 /**
 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.
 292  *
 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
 297  */
 298
 299 #include "gen_$arch\_regalloc_if.h"
 300 #include "bearch_$arch\_t.h"   /* we need this to put the caller saved registers into the isa set */
 301 #include "$arch\_map_regs.h"
 302 #include "irmode.h"
 303
 304 EOF
 305
 306 print OUT "arch_register_class_t $arch\_reg_classes[] = {\n  ".join(",\n  ", @obst_regclasses)."\n};\n\n";
 307
 308 print OUT "void ".$arch."_register_init(void *isa_ptr) {\n";
 309 print OUT @obst_reginit;
 310 print OUT "}\n\n";
 311
 312 print OUT @obst_limit_func;
 313
 314 print OUT @obst_req;
 315
 316 close(OUT);
 317
 318 ###
 319 # Remember the register class for each index in the given requirements.
 320 # We need this information for requirements like "in_sX" or "out_dX"
 321 # @return array of classes corresponding to the requirement for each index
 322 ###
 323 sub build_inout_idx_class {
 324         my $n     = shift;
 325         my $op    = shift;
 326         my $inout = shift;
 327         my @idx_class;
 328
 329         if (exists($n->{"reg_req"}{"$inout"})) {
 330                 my @reqs = @{ $n->{"reg_req"}{"$inout"} };
 331
 332                 for (my $idx = 0; $idx <= $#reqs; $idx++) {
 333                         my $class = undef;
 334
 335                         if ($reqs[$idx] eq "none") {
 336                                 $class = "none";
 337                         }
 338                         elsif (is_reg_class($reqs[$idx])) {
 339                                 $class = $reqs[$idx];
 340                         }
 341                         else {
 342                                 my @regs = split(/ /, $reqs[$idx]);
 343 GET_CLASS:              foreach my $reg (@regs) {
 344                                         if ($reg =~ /!?(in|out)\_r\d+/) {
 345                                                 $class = "UNKNOWN_CLASS";
 346                                         }
 347                                         else {
 348                                                 $class = get_reg_class($reg);
 349                                                 if (!defined $class) {
 350                                                         die("Could not get ".uc($inout)." register class for '$op' pos $idx (reg $reg) ... exiting.\n");
 351                                                 }
 352                                                 else {
 353                                                         last GET_CLASS;
 354                                                 } # !defined class
 355                                         } # if (reg =~ ...
 356                                 } # foreach
 357                         } # if
 358
 359                         push(@idx_class, $class);
 360                 } # for
 361         } # if
 362
 363         return @idx_class;
 364 }
 365
 366 ###
 367 # Generates the requirements for the given description
 368 ###
 369 sub generate_requirements {
 370         my $n     = shift;
 371         my $op    = shift;
 372         my $inout = shift;
 373
 374         # get classes for the complementary direction
 375         my $outin     = ($inout eq "in") ? "out" : "in";
 376
 377         my @reqs = @{ $n->{"reg_req"}{"$inout"} };
 378
 379         for (my $idx = 0; $idx <= $#reqs; $idx++) {
 380                 my $class = undef;
 381
 382                 my $tmp2 = "const $arch\_register_req_t _".$op."_reg_req_$inout\_$idx = ";
 383                 my $tmp  = "#define ".$op."_reg_req_$inout\_$idx ";
 384
 385                 if ($reqs[$idx] eq "none") {
 386                         $tmp .= "&$arch\_default_req_none\n";
 387                 }
 388                 elsif (is_reg_class($reqs[$idx])) {
 389                         $tmp .= "&$arch\_default_req_".$arch."_".$reqs[$idx]."\n";
 390                 }
 391                 else {
 392                         my @req_type_mask;
 393                         my ($class, $has_limit, $same_pos, $different_pos) = build_subset_class_func($n, $op, $idx, (($inout eq "in") ? 1 : 0), $reqs[$idx]);
 394
 395                         if (!defined($class)) {
 396                                 die("Could not build subset for ".uc($inout)." requirements '$op' pos $idx ... exiting.\n");
 397                         }
 398
 399                         if ($has_limit) {
 400                                 push(@req_type_mask, "arch_register_req_type_limited");
 401                         }
 402                         if (defined($same_pos)) {
 403                                 push(@req_type_mask, "arch_register_req_type_should_be_same");
 404                         }
 405                         if (defined($different_pos)) {
 406                                 push(@req_type_mask, "arch_register_req_type_should_be_different");
 407                         }
 408
 409                         $tmp  .= "&_".$op."_reg_req_$inout\_$idx\n";
 410                         $tmp2 .= "{\n";
 411                         $tmp2 .= "  {\n";
 412                         $tmp2 .= "    ".join(" | ", @req_type_mask).",\n";
 413                         $tmp2 .= "    &$arch\_reg_classes[CLASS_$arch\_".$class."],\n";
 414                         $tmp2 .= "    ".($has_limit ? "limit_reg_".$op."_$inout\_".$idx : "NULL").",\n";
 415                         $tmp2 .= "    NULL,        /* limit environment */\n";
 416                         $tmp2 .= "    NULL,        /* same node */\n";
 417                         $tmp2 .= "    NULL         /* different node */\n";
 418                         $tmp2 .= "  },\n";
 419                         $tmp2 .= "  ".(defined($same_pos) ? $same_pos : "0").",\n";
 420                         $tmp2 .= "  ".(defined($different_pos) ? $different_pos : "0")."\n";
 421                         $tmp2 .= "};\n";
 422
 423                         push(@obst_req, $tmp2."\n");
 424                         push(@obst_header_all, "extern const $arch\_register_req_t _".$op."_reg_req_$inout\_$idx;\n");
 425                 }
 426
 427                 push(@obst_requirement_def, $tmp);
 428         }
 429
 430 }
 431
 432 ###
 433 # Determines whether $name is a specified register class or not.
 434 # @return 1 if name is register class, 0 otherwise
 435 ###
 436 sub is_reg_class {
 437         my $name = shift;
 438         return 1 if exists($reg_classes{"$name"});
 439         return 0;
 440 }
 441
 442 ###
 443 # Returns the register class for a given register.
 444 # @return class or undef
 445 ###
 446 sub get_reg_class {
 447         my $reg = shift;
 448         $reg = substr($reg, 1) if ($reg =~ /!.*/);
 449         return $reg2class{"$reg"}{"class"} if (exists($reg2class{"$reg"}));
 450         return undef;
 451 }
 452
 453 ###
 454 # Returns the index of a given register within it's register class.
 455 # @return index or undef
 456 ###
 457 sub get_reg_index {
 458         my $reg = shift;
 459         return $reg2class{"$reg"}{"index"} if (exists($reg2class{"$reg"}));
 460         return undef;
 461 }
 462
 463 ###
 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
 468 ###
 469 sub build_subset_class_func {
 470         my $neg           = undef;
 471         my $class         = undef;
 472         my $has_limit     = 0;
 473         my $same_pos      = undef;
 474         my $different_pos = undef;
 475         my $temp;
 476         my @temp_obst;
 477
 478
 479         # build function header
 480         my $n   = shift;
 481         my $op  = shift;
 482         my $idx = shift;
 483         my $in  = shift;
 484
 485         my $outin = $in ? "out" : "in";
 486         my @regs  = split(/ /, shift);
 487
 488         my @idx_class = build_inout_idx_class($n, $op, $outin);
 489
 490         # set/unset registers
 491 CHECK_REQS: foreach (@regs) {
 492                 if (/(!)?$outin\_r(\d+)/) {
 493                         if (($1 && defined($different_pos)) || (!$1 && 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);
 496                         }
 497
 498                         if ($1) {
 499                                 $different_pos = $in ? -$2 : $2 - 1;
 500                         }
 501                         else {
 502                                 $same_pos = $in ? -$2 : $2 - 1;
 503                         }
 504
 505                         $class = $idx_class[$2 - 1];
 506                         next CHECK_REQS;
 507                 }
 508
 509                 # check for negate
 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);
 516                         }
 517
 518                         if (!defined($neg)) {
 519                                 $has_limit = 1;
 520                                 push(@temp_obst, "  bs = bitset_set_all(bs);     /* allow all register (negative constraints given) */\n");
 521                         }
 522
 523                         $_   = substr($_, 1); # skip '!'
 524                         $neg = 1;
 525                 }
 526                 else {
 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);
 532                         }
 533
 534                         if (!defined($neg)) {
 535                                 $has_limit = 1;
 536                                 push(@temp_obst, "  bs = bitset_clear_all(bs);   /* disallow all register (positive constraints given) */\n");
 537                         }
 538                         $neg = 0;
 539                 }
 540
 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);
 546                 }
 547
 548                 # set class
 549                 if (!defined($class)) {
 550                         $class = $temp;
 551                 }
 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);
 556                 }
 557
 558                 if ($neg == 1) {
 559                         $has_limit = 1;
 560                         push(@temp_obst, "  bitset_clear(bs, ".get_reg_index($_).");         /* disallow $_ */\n");
 561                 }
 562                 else {
 563                         $has_limit = 1;
 564                         push(@temp_obst, "  bitset_set(bs, ".get_reg_index($_).");           /* allow $_ */\n");
 565                 }
 566         }
 567
 568         if ($has_limit == 1) {
 569                 push(@obst_header_all, "void limit_reg_".$op."_".($in ? "in" : "out")."_".$idx."(void *_unused, bitset_t *bs);\n");
 570
 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");
 575         }
 576
 577         return ($class, $has_limit, $same_pos, $different_pos);
 578 }