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

   1 #!/usr/bin/perl -w
   2
   3 #
   4 # Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
   5 #
   6 # This file is part of libFirm.
   7 #
   8 # This file may be distributed and/or modified under the terms of the
   9 # GNU General Public License version 2 as published by the Free Software
  10 # Foundation and appearing in the file LICENSE.GPL included in the
  11 # packaging of this file.
  12 #
  13 # Licensees holding valid libFirm Professional Edition licenses may use
  14 # this file in accordance with the libFirm Commercial License.
  15 # Agreement provided with the Software.
  16 #
  17 # This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
  18 # WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  19 # PURPOSE.
  20 #
  21
  22 # This script generates the C code which creates the irop's and
  23 # their coresponding node constructors for all operations in a given spec
  24 # so they can be used as normal firm nodes.
  25 # Creation: 2005/10/19
  26 # $Id$
  27
  28 use strict;
  29 use Data::Dumper;
  30
  31 my $specfile   = $ARGV[0];
  32 my $target_dir = $ARGV[1];
  33 my $state      = 1;
  34 my $cur_op     = "";
  35 my $line_nr    = 0;
  36
  37 our $arch;
  38 our $additional_opcodes;
  39 our %nodes;
  40 our %operands;
  41 our %cpu;
  42 our $default_op_attr_type;
  43 our $default_attr_type;
  44 our $default_cmp_attr;
  45 our $default_copy_attr;
  46 our %init_attr;
  47 our $custom_init_attr_func;
  48 our %compare_attr;
  49 our %copy_attr;
  50 our %reg_classes;
  51
  52 # include spec file
  53
  54 my $return;
  55
  56 no strict "subs";
  57 unless ($return = do $specfile) {
  58         die "Fatal error: couldn't parse $specfile: $@" if $@;
  59         die "Fatal error: couldn't do $specfile: $!"    unless defined $return;
  60         die "Fatal error: couldn't run $specfile"       unless $return;
  61 }
  62 use strict "subs";
  63
  64 my $target_c = $target_dir."/gen_".$arch."_new_nodes.c.inl";
  65 my $target_h = $target_dir."/gen_".$arch."_new_nodes.h";
  66
  67 if(!defined($default_attr_type)) {
  68         $default_attr_type = "${arch}_attr_t";
  69 }
  70 if(!defined(%init_attr)) {
  71         %init_attr = (
  72                 "$default_attr_type" => "\tinit_${arch}_attributes(res, flags, in_reqs, out_reqs, exec_units, n_res);",
  73         );
  74 }
  75 if(!defined($default_cmp_attr)) {
  76         $default_cmp_attr = "${arch}_compare_attr";
  77 }
  78 if(!defined(%compare_attr)) {
  79         %compare_attr = (
  80                 "${default_attr_type}" => "${default_cmp_attr}",
  81         );
  82 }
  83
  84 # Operands are really just nodes with some special constraints, we check
  85 # these and create new entries in the nodes hashmap
  86 foreach my $op (keys(%operands)) {
  87         my %operand = %{ $operands{"$op"} };
  88         my %op_node;
  89
  90         # constraints
  91         if(defined($operand{op_flags})) { die "Fatal error: operands can't have op_flags ($op)"; }
  92         if(defined($operand{cmp_attr})) { die "Fatal error: cmp_attr not allowed for operands ($op)"; }
  93         if(defined($operand{mode})) { die "Operand must not have a mode defined ($op)"; }
  94         if(defined($operand{out_arity})) { die "operand must not have out_arity defined ($op)"; }
  95         if(defined($nodes{$op})) { die "$op defined as operand and as node"; };
  96
  97
  98         foreach my $flag (keys(%operand)) {
  99                 $op_node{$flag} = $operand{$flag};
 100         }
 101         $op_node{op_flags} = "O";
 102         $op_node{cmp_attr} = 'return 1;';
 103         $op_node{mode}     = 'mode_ANY';
 104
 105         $nodes{$op} = \%op_node;
 106 }
 107
 108 #print Dumper(%nodes);
 109 #print Dumper(%operands);
 110
 111 # create c code file from specs
 112
 113 my @obst_limit_func;
 114 my @obst_reg_reqs;
 115 my @obst_opvar;       # stack for the "ir_op *op_<arch>_<op-name> = NULL;" statements
 116 my @obst_get_opvar;   # stack for the get_op_<arch>_<op-name>() functions
 117 my @obst_constructor; # stack for node constructor functions
 118 my @obst_new_irop;    # stack for the new_ir_op calls
 119 my @obst_enum_op;     # stack for creating the <arch>_opcode enum
 120 my @obst_header;      # stack for function prototypes
 121 my @obst_is_archirn;  # stack for the is_$arch_irn() function
 122 my @obst_cmp_attr;    # stack for the compare attribute functions
 123 my @obst_proj;        # stack for the pn_ numbers
 124 my $orig_op;
 125 my $arity;
 126 my $cmp_attr_func;
 127 my $temp;
 128 my $n_opcodes = 0;    # number of opcodes
 129 my $ARITY_VARIABLE = -1;
 130 my $ARITY_DYNAMIC  = -2;
 131 my %requirements = ();
 132 my %limit_bitsets = ();
 133 my %reg2class = ();
 134 my %regclass2len = ();
 135
 136 # build register->class hashes
 137 foreach my $class_name (keys(%reg_classes)) {
 138         my @class         = @{ $reg_classes{"$class_name"} };
 139         my $old_classname = $class_name;
 140
 141         pop(@class);
 142
 143         $class_name = $arch."_".$class_name;
 144
 145         my $idx = 0;
 146         foreach (@class) {
 147                 $reg2class{$_->{name}} = {
 148                         "class" => $old_classname,
 149                         "index" => $idx
 150                 };
 151                 $idx++;
 152         }
 153
 154         $regclass2len{$old_classname} = $idx;
 155 }
 156
 157
 158 # for registering additional opcodes
 159 $n_opcodes += $additional_opcodes if (defined($additional_opcodes));
 160
 161 push(@obst_header, "void ".$arch."_create_opcodes(const arch_irn_ops_t *be_ops);\n");
 162
 163 push(@obst_enum_op, "typedef enum _$arch\_opcodes {\n");
 164 foreach my $op (keys(%nodes)) {
 165         my %n        = %{ $nodes{"$op"} };
 166         my $known_mode;
 167         my $num_outs = 0;
 168         my $out_arity;
 169         my @out_flags;
 170
 171         # determine arity
 172         $arity = 0;
 173         if(exists($n{"arity"})) {
 174                 $arity = $n{"arity"};
 175         } elsif (exists($n{"reg_req"}) && exists($n{"reg_req"}{"in"})) {
 176                 $arity = scalar(@{ $n{"reg_req"}{"in"} });
 177         } elsif (exists($n{"ins"})) {
 178                 $arity = scalar(@{ $n{"ins"} });
 179         }
 180         if($arity eq "variable") {
 181                 $arity = $ARITY_VARIABLE;
 182         } elsif($arity eq "dynamic") {
 183                 $arity = $ARITY_DYNAMIC;
 184         }
 185
 186         # determine out arity
 187         $out_arity = 0;
 188         if(exists($n{"out_arity"})) {
 189                 $out_arity = $n{"out_arity"};
 190         } elsif (exists($n{"reg_req"}) && exists($n{"reg_req"}{"out"})) {
 191                 $out_arity = scalar(@{ $n{"reg_req"}{"out"} });
 192         } elsif (exists($n{"outs"})) {
 193                 $out_arity = scalar(@{ $n{"outs"} });
 194         }
 195         if($out_arity eq "variable") {
 196                 $out_arity = $ARITY_VARIABLE;
 197         } elsif($out_arity eq "dynamic") {
 198                 $out_arity = $ARITY_DYNAMIC;
 199         }
 200
 201         $orig_op = $op;
 202         $op      = $arch."_".$op;
 203         $temp    = "";
 204
 205         # define proj numbers and in numbers
 206         if (exists($n{"outs"})) {
 207                 undef my @outs;
 208
 209                 @outs     = @{ $n{"outs"} };
 210                 if($out_arity >= 0 && scalar(@outs) != $out_arity) {
 211                         die "Fatal error: Op ${op} has different number of outs and out_arity\n";
 212                 }
 213
 214                 $num_outs = $#outs + 1;
 215
 216                 push(@obst_proj, "\nenum pn_$op {\n");
 217
 218                 for (my $idx = 0; $idx <= $#outs; $idx++) {
 219                         # check, if we have additional flags annotated to out
 220                         if ($outs[$idx] =~ /:((S|I)(\|(S|I))*)/) {
 221                                 push(@out_flags, $1);
 222                                 $outs[$idx] =~ s/:((S|I)(\|(S|I))*)//;
 223                         }
 224                         push(@obst_proj, "\tpn_$op\_".$outs[$idx]." = $idx,\n");
 225                 }
 226
 227                 push(@obst_proj, "};\n");
 228                 # outs have names, it must be a mode_T node
 229                 $known_mode = "mode_T";
 230         }
 231         if (exists($n{"ins"})) {
 232                 undef my @ins;
 233
 234                 @ins = @{ $n{"ins"} };
 235                 if($arity >= 0 && scalar(@ins) != $arity) {
 236                         die "Fatal error: Op ${op} has different number of ins and arity\n";
 237                 }
 238
 239                 push(@obst_proj, "\nenum n_$op {\n");
 240
 241                 for (my $idx = 0; $idx <= $#ins; $idx++) {
 242                         push(@obst_proj, "\tn_${op}_".$ins[$idx]." = $idx,\n");
 243                 }
 244
 245                 push(@obst_proj, "};\n");
 246         }
 247
 248         # determine mode
 249         if (exists($n{"mode"})) {
 250                 $known_mode = $n{"mode"};
 251         }
 252
 253         push(@obst_opvar, "ir_op *op_$op = NULL;\n");
 254         push(@obst_get_opvar, "ir_op *get_op_$op(void)         { return op_$op; }\n");
 255         push(@obst_get_opvar, "int    is_$op(const ir_node *n) { return get_$arch\_irn_opcode(n) == iro_$op; }\n\n");
 256
 257         push(@obst_is_archirn, "is_$op(node)");
 258
 259         push(@obst_header, "extern ir_op *op_$op;\n");
 260         push(@obst_header, "ir_op *get_op_$op(void);\n");
 261         push(@obst_header, "int is_$op(const ir_node *n);\n");
 262
 263         my $attr_type= $n{"attr_type"};
 264         if(!defined($attr_type)) {
 265                 $attr_type = $default_attr_type;
 266         }
 267
 268         # determine hash function
 269         my $hash_func;
 270         if (exists($n{"hash_func"})) {
 271                 $hash_func = $n{"hash_func"};
 272         }
 273
 274         # determine compare function
 275         my $cmp_attr_func;
 276         if (exists($n{"cmp_attr"})) {
 277                 my $cmpcode = $n{"cmp_attr"};
 278
 279                 push(@obst_cmp_attr, "static int cmp_attr_$op(ir_node *a, ir_node *b) {\n");
 280                 if($cmpcode =~ m/attr_a/) {
 281                         push(@obst_cmp_attr, "\t${attr_type} *attr_a = get_irn_generic_attr(a);\n");
 282                 } else {
 283                         push(@obst_cmp_attr, "\t(void) a;\n");
 284                 }
 285                 if($cmpcode =~ m/attr_b/) {
 286                         push(@obst_cmp_attr, "\t${attr_type} *attr_b = get_irn_generic_attr(b);\n");
 287                 } else {
 288                         push(@obst_cmp_attr, "\t(void) b;\n");
 289                 }
 290                 push(@obst_cmp_attr, "\t${cmpcode}\n");
 291                 push(@obst_cmp_attr, "}\n\n");
 292
 293                 $cmp_attr_func = "cmp_attr_${op}";
 294         } else {
 295                 if(defined($compare_attr{${attr_type}})) {
 296                         $cmp_attr_func = $compare_attr{${attr_type}};
 297                 } else {
 298                         die "Fatal error: No compare function defined for ${attr_type} attributes.";
 299                 }
 300         }
 301
 302         if (exists($n{"rd_constructor"}) && $n{"rd_constructor"} =~ /^NONE$/i) {
 303                 # we explicitly skip the constructor if the specification entry says NONE
 304         } else {
 305                 my $comment = $n{"comment"};
 306                 if(!exists($n{"comment"})) {
 307                         $comment = "construct ${orig_op} node";
 308                 }
 309                 $comment =
 310                         "/**\n".
 311                         " * ${comment}\n".
 312                         " */\n";
 313
 314                 push(@obst_constructor, $comment);
 315
 316                 # create constructor head
 317                 my $complete_args = "";
 318                 $temp             = "";
 319
 320                 $temp = "ir_node *new_bd_$op(dbg_info *db, ir_node *block";
 321                 if (!exists($n{"args"})) { # default args
 322                         if ($arity == $ARITY_VARIABLE) {
 323                                 $complete_args = ", int arity, ir_node *in[]";
 324                         } elsif ($arity == $ARITY_DYNAMIC) {
 325                                 $complete_args = "";
 326                         } else {
 327                                 for (my $i = 0; $i < $arity; $i++) {
 328                                         my $opname = "op${i}";
 329                                         if (exists($n{"ins"})) {
 330                                                 my @ins = @{ $n{"ins"} };
 331                                                 $opname = $ins[$i];
 332                                         }
 333
 334                                         $complete_args .= ", ir_node *${opname}";
 335                                 }
 336                         }
 337                         if ($out_arity == $ARITY_VARIABLE) {
 338                                 $complete_args .= ", int n_res";
 339                         }
 340
 341                         if (!defined($known_mode)) {
 342                                 $complete_args .= ", ir_mode *mode";
 343                         }
 344                 } else { # user defined args
 345                         for my $href (@{ $n{"args"} }) {
 346                                 $href->{"type"} .= " " if ($href->{"type"} !~ / [*]?$/); # put a space between name and type if there is none at the end
 347                                 $complete_args  .= ", ".$href->{"type"}.$href->{"name"};
 348                         }
 349                 }
 350
 351                 # we have additional attribute arguements
 352                 if (exists($n{"attr"})) {
 353                         $complete_args .= ", ".$n{"attr"};
 354                 }
 355
 356                 $temp .= "$complete_args)";
 357                 push(@obst_constructor, $temp."\n{\n");
 358                 push(@obst_header, $comment);
 359                 push(@obst_header, $temp.";\n");
 360
 361                 # emit constructor code
 362                 if (!exists($n{"rd_constructor"})) { # default constructor
 363                         $temp  = "\tir_node  *res;\n";
 364                         $temp .= "\tir_op    *op      = op_${op};\n";
 365                         $temp .= "\tint       flags   = 0;\n";
 366
 367                         if($arity == $ARITY_DYNAMIC) {
 368                                 $temp .= "\tint        arity   = -1;\n";
 369                                 $temp .= "\tir_node  **in      = NULL;\n";
 370                         } elsif($arity == $ARITY_VARIABLE) {
 371                         } else {
 372                                 $temp .= "\tint       arity   = $arity;\n";
 373                                 if($arity > 0) {
 374                                         $temp .= "\tir_node  *in[$arity];\n";
 375                                 } else {
 376                                         $temp .= "\tir_node **in    = NULL;\n";
 377                                 }
 378                         }
 379                         if($out_arity == $ARITY_DYNAMIC) {
 380                                 $temp .= "\tint       n_res   = -1;\n";
 381                         } elsif($out_arity == $ARITY_VARIABLE) {
 382                         } else {
 383                                 $temp .= "\tint       n_res   = ${out_arity};\n";
 384                         }
 385
 386                         if (defined($known_mode)) {
 387                                 $temp .= "\tir_mode  *mode    = ${known_mode};\n";
 388                         }
 389
 390                         # set up static variables for cpu execution unit assigments
 391                         if (exists($n{"units"})) {
 392                                 $temp .= gen_execunit_list_initializer($n{"units"});
 393                         } else {
 394                                 $temp .= "\tstatic const be_execution_unit_t ***exec_units = NULL;\n";
 395                         }
 396
 397                         undef my $in_req_var;
 398                         undef my $out_req_var;
 399
 400                         # set up static variables for requirements and registers
 401                         if (exists($n{"reg_req"})) {
 402                                 my %req = %{ $n{"reg_req"} };
 403                                 my $idx;
 404
 405                                 undef my @in;
 406                                 @in = @{ $req{"in"} } if (exists($req{"in"}));
 407                                 undef my @out;
 408                                 @out = @{ $req{"out"} } if exists(($req{"out"}));
 409
 410                                 for(my $idx = 0; $idx < $#in; $idx++) {
 411                                         my $req = $in[$idx];
 412                                         generate_requirements($req, \%n, $op, $idx, 1);
 413                                 }
 414                                 for(my $idx = 0; $idx < $#out; $idx++) {
 415                                         my $req = $out[$idx];
 416                                         generate_requirements($req, \%n, $op, $idx, 0);
 417                                 }
 418
 419                                 if (@in) {
 420                                         if($arity >= 0 && scalar(@in) != $arity) {
 421                                                 die "Fatal error: Arity and number of in requirements don't match for ${op}\n";
 422                                         }
 423
 424                                         $temp .= "\tstatic const arch_register_req_t *in_reqs[] =\n";
 425                                         $temp .= "\t{\n";
 426                                         for ($idx = 0; $idx <= $#in; $idx++) {
 427                                                 my $req = $in[$idx];
 428                                                 my $reqstruct = generate_requirements($req, \%n, $op, $idx, 1);
 429                                                 $temp .= "\t\t& ${reqstruct},\n";
 430                                         }
 431                                         $temp .= "\t};\n";
 432                                 } else {
 433                                         if($arity > 0) {
 434                                                 die "Fatal error: need in requirements for ${op}\n";
 435                                         }
 436                                         $temp .= "\tstatic const arch_register_req_t **in_reqs = NULL;\n";
 437                                 }
 438
 439                                 if (@out) {
 440                                         if($out_arity >= 0 && scalar(@out) != $out_arity) {
 441                                                 die "Fatal error: Out-Arity and number of out requirements don't match for ${op}\n";
 442                                         }
 443
 444                                         $temp .= "\tstatic const arch_register_req_t *out_reqs[] =\n";
 445                                         $temp .= "\t{\n";
 446                                         for ($idx = 0; $idx <= $#out; $idx++) {
 447                                                 my $req = $out[$idx];
 448                                                 my $reqstruct = generate_requirements($req, \%n, $op, $idx, 0);
 449                                                 $temp .= "\t\t& ${reqstruct},\n";
 450                                         }
 451                                         $temp .= "\t};\n";
 452                                 } else {
 453                                         if($out_arity > 0) {
 454                                                 die "Fatal error: need out requirements for ${op}\n";
 455                                         }
 456                                         $temp .= "\tstatic const arch_register_req_t **out_reqs = NULL;\n";
 457                                 }
 458                         } else {
 459                                 $temp .= "\tstatic const arch_register_req_t **in_reqs = NULL;\n";
 460                                 $temp .= "\tstatic const arch_register_req_t **out_reqs = NULL;\n";
 461                         }
 462                         if(exists($n{"init_attr"})) {
 463                                 $temp .= "\t${attr_type} *attr;\n";
 464                         }
 465
 466                         $temp .= "\n";
 467
 468                         if($arity > 0) {
 469                                 $temp .= "\t/* construct in array */\n";
 470                                 for (my $i = 0; $i < $arity; $i++) {
 471                                         my $opname = "op${i}";
 472                                         if (exists($n{"ins"})) {
 473                                                 my @ins = @{ $n{"ins"} };
 474                                                 $opname = $ins[$i];
 475                                         }
 476
 477                                         $temp .= "\tin[${i}] = ${opname};\n";
 478                                 }
 479                                 $temp .= "\n";
 480                         }
 481
 482                         # set flags
 483                         if (exists($n{"irn_flags"})) {
 484                                 $temp .= "\t/* flags */\n";
 485                                 foreach my $flag (split(/\|/, $n{"irn_flags"})) {
 486                                         if ($flag eq "R") {
 487                                                 $temp .= "\tflags |= arch_irn_flags_rematerializable;\n";
 488                                         } elsif ($flag eq "N") {
 489                                                 $temp .= "\tflags |= arch_irn_flags_dont_spill;\n";
 490                                         } else {
 491                                                 die "Fatal error: unknown flag $flag for ${op}\n";
 492                                         }
 493                                 }
 494                                 $temp .= "\n";
 495                         }
 496
 497                         $temp .= "\t/* create node */\n";
 498                         $temp .= "\tassert(op != NULL);\n";
 499                         $temp .= "\tres = new_ir_node(db, current_ir_graph, block, op, mode, arity, in);\n";
 500                         $temp .= "\n";
 501
 502                         $temp .= "\t/* init node attributes */\n";
 503                         # lookup init function
 504                         my $attr_init_code = $init_attr{$attr_type};
 505                         if(!defined($attr_init_code)) {
 506                                 die "Fatal error: Couldn't find attribute initialisation code for type '${attr_type}'";
 507                         }
 508                         $temp .= "${attr_init_code}\n";
 509                         if(defined($custom_init_attr_func)) {
 510                                 $temp .= &$custom_init_attr_func(\%n, $op);
 511                         }
 512                         $temp .= "\n";
 513
 514                         if (exists($n{"init_attr"})) {
 515                                 $temp .= "\tattr = get_irn_generic_attr(res);\n";
 516                                 $temp .= "\t".$n{"init_attr"}."\n";
 517                         }
 518
 519                         $temp .= "\t/* optimize node */\n";
 520                         $temp .= "\tres = optimize_node(res);\n";
 521                         $temp .= "\tirn_vrfy_irg(res, current_ir_graph);\n";
 522                         $temp .= "\n";
 523
 524                         $temp .= "\treturn res;\n";
 525
 526                         push(@obst_constructor, $temp);
 527                 }
 528                 else { # user defined constructor
 529                         push(@obst_constructor, $n{"rd_constructor"});
 530                 }
 531
 532                 # close constructor function
 533                 push(@obst_constructor, "}\n\n");
 534         } # constructor creation
 535
 536         # set default values for state and flags if not given
 537         $n{"state"}    = "floats" if (! exists($n{"state"}));
 538         $n{"op_flags"} = "N"      if (! exists($n{"op_flags"}));
 539
 540
 541         push(@obst_new_irop, "\n\tmemset(&ops, 0, sizeof(ops));\n");
 542         push(@obst_new_irop, "\tops.be_ops        = be_ops;\n");
 543         push(@obst_new_irop, "\tops.dump_node     = $arch\_dump_node;\n");
 544
 545         if (defined($cmp_attr_func)) {
 546                 push(@obst_new_irop, "\tops.node_cmp_attr = ${cmp_attr_func};\n");
 547         }
 548         my $copy_attr_func = $copy_attr{$attr_type};
 549         if (!defined($copy_attr_func)) {
 550                 $copy_attr_func = $default_copy_attr;
 551         }
 552         if (defined($copy_attr_func)) {
 553                 push(@obst_new_irop, "\tops.copy_attr = ${copy_attr_func};\n");
 554         }
 555         if (defined($hash_func)) {
 556                 push(@obst_new_irop, "\tops.hash = ${hash_func};\n");
 557         }
 558
 559         $n_opcodes++;
 560         my $n_res = $out_arity;
 561         if($n_res < 0) {
 562                 $n_res = "20"; # hacky....
 563         }
 564         $temp  = "\top_$op = new_ir_op(cur_opcode + iro_$op, \"$op\", op_pin_state_".$n{"state"}.", ".$n{"op_flags"};
 565         $temp .= "|M, ".translate_arity($arity).", 0, sizeof(${attr_type}), &ops);\n";
 566         push(@obst_new_irop, $temp);
 567         push(@obst_new_irop, "\tset_op_tag(op_$op, $arch\_op_tag);\n");
 568         if(defined($default_op_attr_type)) {
 569                 push(@obst_new_irop, "\tattr = &attrs[iro_$op];\n");
 570                 if(defined($n{op_attr_init})) {
 571                         push(@obst_new_irop, "\t".$n{op_attr_init}."\n");
 572                 }
 573                 push(@obst_new_irop, "\tset_op_attr(op_$op, attr);\n");
 574         }
 575
 576         push(@obst_enum_op, "\tiro_$op,\n");
 577
 578         push(@obst_header, "\n");
 579 }
 580 push(@obst_enum_op, "\tiro_$arch\_last_generated,\n");
 581 push(@obst_enum_op, "\tiro_$arch\_last = iro_$arch\_last_generated");
 582 push(@obst_enum_op, " + $additional_opcodes") if (defined($additional_opcodes));
 583 push(@obst_enum_op, "\n} $arch\_opcodes;\n\n");
 584
 585 # emit the code
 586
 587 open(OUT, ">$target_c") || die("Fatal error: Could not open $target_c, reason: $!\n");
 588
 589 print OUT "#include \"gen_$arch\_regalloc_if.h\"\n\n";
 590 print OUT @obst_cmp_attr;
 591 print OUT "\n";
 592 print OUT @obst_opvar;
 593 print OUT "\n";
 594 print OUT @obst_get_opvar;
 595 print OUT "\n";
 596
 597 print OUT<<EOF;
 598
 599 static int $arch\_opcode_start = -1;
 600 static int $arch\_opcode_end   = -1;
 601
 602 EOF
 603
 604 # build the FOURCC arguments from $arch
 605
 606 my ($a, $b, $c, $d) = ('\0', '\0', '\0', '\0');
 607
 608 if (length($arch) >= 1) {
 609         $a = uc(substr($arch, 0, 1));
 610 }
 611
 612 if (length($arch) >= 2) {
 613         $b = uc(substr($arch, 1, 1));
 614 }
 615
 616 if (length($arch) >= 3) {
 617         $c = uc(substr($arch, 2, 1));
 618 }
 619
 620 if (length($arch) >= 4) {
 621         $d = uc(substr($arch, 3, 1));
 622 }
 623
 624 print OUT<<ENDOFISIRN;
 625
 626 /** A tag for the $arch opcodes. Note that the address is used as a tag value, NOT the FOURCC code. */
 627 #define $arch\_op_tag FOURCC('$a', '$b', '$c', '$d')
 628
 629 /** Return the opcode number of the first $arch opcode. */
 630 int get_$arch\_opcode_first(void) {
 631         return $arch\_opcode_start;
 632 }
 633
 634 /** Return the opcode number of the last $arch opcode + 1. */
 635 int get_$arch\_opcode_last(void) {
 636         return $arch\_opcode_end;
 637 }
 638
 639 /** Return 1 if the given opcode is a $arch machine op, 0 otherwise */
 640 int is_$arch\_op(const ir_op *op) {
 641         return get_op_tag(op) == $arch\_op_tag;
 642 }
 643
 644 /** Return 1 if the given node is a $arch machine node, 0 otherwise */
 645 int is_$arch\_irn(const ir_node *node) {
 646         return is_$arch\_op(get_irn_op(node));
 647 }
 648
 649 int get_$arch\_irn_opcode(const ir_node *node) {
 650         if (is_$arch\_irn(node))
 651                 return get_irn_opcode(node) - $arch\_opcode_start;
 652         return -1;
 653 }
 654
 655 ENDOFISIRN
 656
 657 print OUT <<END;
 658 #ifdef BIT
 659 #undef BIT
 660 #endif
 661 #define BIT(x)  (1 << (x % 32))
 662
 663 END
 664
 665 print OUT @obst_limit_func;
 666 print OUT "\n";
 667
 668 print OUT @obst_reg_reqs;
 669 print OUT "\n";
 670
 671 print OUT @obst_constructor;
 672
 673 print OUT<<ENDOFMAIN;
 674 /**
 675  * Creates the $arch specific Firm machine operations
 676  * needed for the assembler irgs.
 677  */
 678 void $arch\_create_opcodes(const arch_irn_ops_t *be_ops) {
 679 #define N   irop_flag_none
 680 #define L   irop_flag_labeled
 681 #define C   irop_flag_commutative
 682 #define X   irop_flag_cfopcode
 683 #define I   irop_flag_ip_cfopcode
 684 #define F   irop_flag_fragile
 685 #define Y   irop_flag_forking
 686 #define H   irop_flag_highlevel
 687 #define c   irop_flag_constlike
 688 #define K   irop_flag_keep
 689 #define M   irop_flag_machine
 690 #define O   irop_flag_machine_op
 691 #define NB  irop_flag_dump_noblock
 692 #define NI  irop_flag_dump_noinput
 693 #define R   (irop_flag_user << 0)
 694
 695         ir_op_ops  ops;
 696         int        cur_opcode;
 697         static int run_once = 0;
 698         int        i;
 699 ENDOFMAIN
 700
 701         if (defined($default_op_attr_type)) {
 702                 print OUT "\t$default_op_attr_type *attr, *attrs;\n";
 703         }
 704
 705 print OUT<<ENDOFMAIN;
 706
 707         if (run_once)
 708                 return;
 709         run_once = 1;
 710
 711         /* we handle all middleend nodes as well that have no other handler */
 712         for (i = 0; i <= iro_Last; ++i) {
 713                 ir_op *op      = get_irp_opcode(i);
 714                 if (op->ops.be_ops == NULL)
 715                         op->ops.be_ops = be_ops;
 716         }
 717
 718         cur_opcode = get_next_ir_opcodes(iro_$arch\_last);
 719
 720         $arch\_opcode_start = cur_opcode;
 721 ENDOFMAIN
 722
 723         if (defined($default_op_attr_type)) {
 724                 print OUT "\tattrs = xmalloc(sizeof(attr[0]) * iro_$arch\_last);\n";
 725                 print OUT "\tmemset(attrs, 0, sizeof(attr[0]) * iro_$arch\_last);\n";
 726         }
 727
 728 print OUT @obst_new_irop;
 729 print OUT "\n";
 730 print OUT "\t$arch\_register_additional_opcodes(cur_opcode);\n" if (defined($additional_opcodes));
 731 print OUT "\t$arch\_opcode_end = cur_opcode + iro_$arch\_last";
 732 print OUT " + $additional_opcodes" if (defined($additional_opcodes));
 733 print OUT ";\n";
 734 print OUT "}\n";
 735
 736 close(OUT);
 737
 738 open(OUT, ">$target_h") || die("Fatal error: Could not open $target_h, reason: $!\n");
 739
 740 my $creation_time = localtime(time());
 741 my $tmp = uc($arch);
 742
 743 print OUT<<EOF;
 744 /**
 745  * \@file
 746  * \@brief Function prototypes for the new opcode functions.
 747  * \@note  DO NOT EDIT THIS FILE, your changes will be lost.
 748  *        Edit $specfile instead.
 749  *        created by: $0 $specfile $target_dir
 750  * \@date  $creation_time
 751  */
 752 #ifndef FIRM_BE_${tmp}_GEN_${tmp}_NEW_NODES_H
 753 #define FIRM_BE_${tmp}_GEN_${tmp}_NEW_NODES_H
 754
 755 EOF
 756
 757 print OUT @obst_enum_op;
 758 print OUT "int is_$arch\_irn(const ir_node *node);\n\n";
 759 print OUT "int get_$arch\_opcode_first(void);\n";
 760 print OUT "int get_$arch\_opcode_last(void);\n";
 761 print OUT "int get_$arch\_irn_opcode(const ir_node *node);\n";
 762 print OUT @obst_header;
 763 print OUT @obst_proj;
 764
 765 print OUT <<EOF;
 766 #endif
 767 EOF
 768
 769 close(OUT);
 770
 771 ###
 772 # Translates numeric arity into string constant.
 773 ###
 774 sub translate_arity {
 775         my $arity = shift;
 776
 777         if ($arity =~ /^\d+$/) {
 778                 if    ($arity == 0) {
 779                         return "oparity_zero";
 780                 }
 781                 elsif ($arity == 1) {
 782                         return "oparity_unary";
 783                 }
 784                 elsif ($arity == 2) {
 785                         return "oparity_binary";
 786                 }
 787                 elsif ($arity == 3) {
 788                         return "oparity_trinary";
 789                 }
 790                 else {
 791                         return "oparity_any";
 792                 }
 793         } elsif ($arity == $ARITY_VARIABLE) {
 794                 return "oparity_variable";
 795         } elsif ($arity == $ARITY_DYNAMIC) {
 796                 return "oparity_dynamic";
 797         } else {
 798                 die "Fatal error: Unknown arity $arity";
 799         }
 800 }
 801
 802 ###
 803 # Return the list of pointers for the given execution units.
 804 ###
 805 sub gen_execunit_list_initializer {
 806         my $units   = shift;
 807         my $uc_arch = uc($arch);
 808         my $ret     = "";
 809         my $ret2    = "";
 810         my %init;
 811
 812         foreach my $unit (@{ $units }) {
 813                 if ($unit eq "DUMMY") {
 814                         push(@{ $init{"DUMMY"} }, "\t\t&be_machine_execution_units_DUMMY[0]");
 815                 }
 816                 elsif (exists($cpu{"$unit"})) {
 817                         # operation can be executed on all units of this type
 818                         # -> add them all
 819                         my $tp_name = "$arch\_execution_units_$unit";
 820                         my $idx     = 0;
 821                         foreach (@{ $cpu{"$unit"} }) {
 822                                 next if ($idx++ == 0);  # skip first element (it's not a unit)
 823                                 my $unit_name = "$uc_arch\_EXECUNIT_TP_$unit\_$_";
 824                                 push(@{ $init{"$unit"} }, "\t\t&".$tp_name."[".$unit_name."]");
 825                         }
 826                 }
 827                 else {
 828                         # operation can be executed only a certain unit
 829                         # -> find corresponding unit type
 830                         my $found = 0;
 831 TP_SEARCH:      foreach my $cur_type (keys(%cpu)) {
 832                                 foreach my $cur_unit (@{ $cpu{"$cur_type"} }) {
 833                                         if ($unit eq $cur_unit) {
 834                                                 my $tp_name   = "$arch\_execution_units_$cur_type";
 835                                                 my $unit_name = "$uc_arch\_EXECUNIT_TP_$cur_type\_$unit";
 836                                                 push(@{ $init{"$unit"} }, "\t\t&".$tp_name."[".$unit_name."]");
 837                                                 $found = 1;
 838                                                 last TP_SEARCH;
 839                                         }
 840                                 }
 841                         }
 842
 843                         if (! $found) {
 844                                 print STDERR "Invalid execution unit $unit specified!\n";
 845                         }
 846                 }
 847         }
 848
 849         # prepare the 2-dim array init
 850         foreach my $key (keys(%init)) {
 851                 $ret .= "\tstatic const be_execution_unit_t *allowed_units_".$key."[] =\n";
 852                 $ret .= "\t{\n";
 853                 foreach (@{ $init{"$key"} }) {
 854                         $ret .= "$_,\n";
 855                 }
 856                 $ret .= "\t\tNULL\n";
 857                 $ret .= "\t};\n";
 858                 $ret2 .= "\t\tallowed_units_$key,\n";
 859         }
 860         $ret2 .= "\t\tNULL\n";
 861
 862         $ret .= "\tstatic const be_execution_unit_t **exec_units[] =\n";
 863         $ret .= "\t{\n";
 864         $ret .= $ret2;
 865         $ret .= "\t};\n";
 866
 867         return $ret;
 868 }
 869
 870 sub mangle_requirements {
 871         my $reqs  = shift;
 872         my $class = shift;
 873         my $flags = shift;
 874
 875         my @alternatives = split(/ /, $reqs);
 876         for(my $idx = 0; $idx < scalar(@alternatives); $idx++) {
 877                 $alternatives[$idx] =~ s/!/not_/g;
 878         }
 879
 880         @alternatives = sort @alternatives;
 881
 882         my $name = $class."_".join('_', @alternatives);
 883         if (defined($flags)) {
 884                 $flags =~ s/\|/_/g;
 885                 $name .= "_$flags";
 886         }
 887
 888         return $name;
 889 }
 890
 891 ###
 892 # Determines whether $name is a specified register class or not.
 893 # @return 1 if name is register class, 0 otherwise
 894 ###
 895 sub is_reg_class {
 896     my $name = shift;
 897     return 1 if exists($reg_classes{"$name"});
 898     return 0;
 899 }
 900
 901 ###
 902 # Returns the register class for a given register.
 903 # @return class or undef
 904 ###
 905 sub get_reg_class {
 906     my $reg = shift;
 907     $reg = substr($reg, 1) if ($reg =~ /!.*/);
 908     return $reg2class{"$reg"}{"class"} if (exists($reg2class{"$reg"}));
 909     return undef;
 910 }
 911
 912 ###
 913 # Returns the index of a given register within it's register class.
 914 # @return index or undef
 915 ###
 916 sub get_reg_index {
 917     my $reg = shift;
 918     return $reg2class{"$reg"}{"index"} if (exists($reg2class{"$reg"}));
 919     return undef;
 920 }
 921
 922 ###
 923 # Remember the register class for each index in the given requirements.
 924 # We need this information for requirements like "in_sX" or "out_dX"
 925 # @return array of classes corresponding to the requirement for each index
 926 ###
 927 sub build_inout_idx_class {
 928         my $n     = shift;
 929         my $op    = shift;
 930         my $is_in = shift;
 931         my @idx_class;
 932
 933         my $inout = ($is_in ? "in" : "out");
 934
 935         if (exists($n->{"reg_req"}{"$inout"})) {
 936                 my @reqs = @{ $n->{"reg_req"}{"$inout"} };
 937
 938                 for (my $idx = 0; $idx <= $#reqs; $idx++) {
 939                         my $class = undef;
 940                         my ($req,) = split(/:/, $reqs[$idx]);
 941
 942                         if ($req eq "none") {
 943                                 $class = "none";
 944                         } elsif (is_reg_class($req)) {
 945                                 $class = $req;
 946                         } else {
 947                                 my @regs = split(/ /, $req);
 948 GET_CLASS:              foreach my $reg (@regs) {
 949                                         if ($reg =~ /!?(in|out)\_r\d+/ || $reg =~ /!in/) {
 950                                                 $class = "UNKNOWN_CLASS";
 951                                         } else {
 952                                                 $class = get_reg_class($reg);
 953                                                 if (!defined $class) {
 954                                                         die("Fatal error: Could not get ".uc($inout)." register class for '$op' pos $idx (reg $reg) ... exiting.\n");
 955                                                 } else {
 956                                                         last GET_CLASS;
 957                                                 } # !defined class
 958                                         } # if (reg =~ ...
 959                                 } # foreach
 960                         } # if
 961
 962                         push(@idx_class, $class);
 963                 } # for
 964         } # if
 965
 966         return @idx_class;
 967 }
 968
 969 ###
 970 # Generates the function for a given $op and a given IN-index
 971 # which returns a subset of possible register from a register class
 972 # @return classname from which the subset is derived or undef and
 973 #         pos which corresponds to in/out reference position or undef
 974 ###
 975 sub build_subset_class_func {
 976         my $neg           = undef;
 977         my $class         = undef;
 978         my $has_limit     = 0;
 979         my $limit_name;
 980         my $same_pos      = 0;
 981         my $different_pos = 0;
 982         my $temp;
 983         my @obst_init;
 984         my @obst_limits;
 985         my @obst_ignore;
 986         my @limit_array;
 987         my $limit_reqs;   #used for name mangling
 988
 989         # build function header
 990         my $node  = shift;
 991         my $op    = shift;
 992         my $idx   = shift;
 993         my $is_in = shift;
 994         my @regs  = split(/ /, shift);
 995         my $flags = shift;
 996
 997         my @idx_class = build_inout_idx_class($node, $op, !$is_in);
 998
 999         # set/unset registers
1000 CHECK_REQS: foreach (@regs) {
1001                 if (!$is_in && /(!)?in_r(\d+)/) {
1002                         my $bit_pos = 1 << ($2 - 1);
1003                         if ($different_pos & $bit_pos) {
1004                                 if ($1) {
1005                                         print STDERR "duplicate !in constraint\n";
1006                                 } else {
1007                                         print STDERR "conflicting !in and in constraints\n";
1008                                 }
1009                                 return (undef, undef, undef, undef);
1010                         }
1011
1012                         if ($same_pos & $bit_pos) {
1013                                 if ($1) {
1014                                         print STDERR "conflicting !in and in constraints\n";
1015                                 } else {
1016                                         print STDERR "duplicate in constraint\n";
1017                                 }
1018                                 return (undef, undef, undef, undef);
1019                         }
1020
1021                         if ($1) {
1022                                 $different_pos |= $bit_pos;
1023                         } else {
1024                                 $same_pos      |= $bit_pos;
1025                         }
1026
1027                         $class = $idx_class[$2 - 1];
1028                         next CHECK_REQS;
1029                 }
1030
1031                 # check for negate
1032                 if (substr($_, 0, 1) eq "!") {
1033                         if (defined($neg) && $neg == 0) {
1034                                 # we have seen a positiv constraint as first one but this one is negative
1035                                 # this doesn't make sense
1036                                 print STDERR "Mixed positive and negative constraints for the same slot are not allowed.\n";
1037                                 return (undef, undef, undef, undef);
1038                         }
1039
1040                         if (!defined($neg)) {
1041                                 $has_limit = 1;
1042                         }
1043
1044                         $_   = substr($_, 1); # skip '!'
1045                         $neg = 1;
1046                 } else {
1047                         if (defined($neg) && $neg == 1) {
1048                                 # we have seen a negative constraint as first one but this one is positive
1049                                 # this doesn't make sense
1050                                 print STDERR "Mixed positive and negative constraints for the same slot are not allowed.\n";
1051                                 return (undef, undef, undef, undef);
1052                         }
1053
1054                         $has_limit = 1;
1055                         $neg = 0;
1056                 }
1057
1058                 # check if register belongs to one of the given classes
1059                 $temp = get_reg_class($_);
1060                 if (!defined($temp)) {
1061                         print STDERR "Unknown register '$_'!\n";
1062                         return (undef, undef, undef, undef);
1063                 }
1064
1065                 # set class
1066                 if (!defined($class)) {
1067                         $class = $temp;
1068                 } elsif ($class ne $temp) {
1069                         # all registers must belong to the same class
1070                         print STDERR "Registerclass mismatch. '$_' is not member of class '$class'.\n";
1071                         return (undef, undef, undef, undef);
1072                 }
1073
1074                 # calculate position inside the initializer bitfield (only 32 bits per
1075                 # element)
1076                 my $regidx = get_reg_index($_);
1077                 my $arrayp = $regidx / 32;
1078                 push(@{$limit_array[$arrayp]}, $_);
1079                 $limit_reqs .= "$_ ";
1080         }
1081
1082         # don't allow ignore regs in negative constraints
1083         if($neg) {
1084                 my @cur_class = @{ $reg_classes{"$class"} };
1085                 for (my $idx = 0; $idx <= $#cur_class; $idx++) {
1086                         if (defined($cur_class[$idx]{"type"}) && ($cur_class[$idx]{"type"} & 4)) {
1087                                 my $reg    = $cur_class[$idx]{"name"};
1088                                 my $regix  = get_reg_index($reg);
1089                                 my $arrayp = $regix / 32;
1090                                 push(@{$limit_array[$arrayp]}, $reg);
1091                                 $limit_reqs .= "$reg ";
1092                         }
1093                 }
1094         }
1095
1096         if ($has_limit == 1) {
1097                 $limit_name = "${arch}_limit_".mangle_requirements($limit_reqs, $class);
1098
1099                 if(defined($limit_bitsets{$limit_name})) {
1100                         $limit_name = $limit_bitsets{$limit_name};
1101                         return ($class, $limit_name, $same_pos, $different_pos);
1102                 }
1103
1104                 $limit_bitsets{$limit_name} = $limit_name;
1105
1106                 push(@obst_limit_func, "static const unsigned " . $limit_name . "[] = { ");
1107                 my $first = 1;
1108                 my $limitbitsetlen = $regclass2len{$class};
1109                 my $limitarraylen = $limitbitsetlen / 32 + ($limitbitsetlen % 32 > 0 ? 1 : 0);
1110                 for(my $i = 0; $i < $limitarraylen; $i++) {
1111
1112                         my $limitarraypart = $limit_array[$i];
1113                         if($first) {
1114                                 $first = 0;
1115                         } else {
1116                                 push(@obst_limit_func, ", ");
1117                         }
1118                         my $temp;
1119                         if($neg) {
1120                                 $temp = "0xFFFFFFFF";
1121                         }
1122                         foreach my $reg (@{$limitarraypart}) {
1123                                 if($neg) {
1124                                         $temp .= " & ~";
1125                                 } elsif(defined($temp)) {
1126                                         $temp .= " | ";
1127                                 }
1128                                 $temp .= "BIT(REG_".uc(${reg}).")";
1129                         }
1130                         if(defined($temp)) {
1131                                 push(@obst_limit_func, "${temp}");
1132                         } else {
1133                                 push(@obst_limit_func, "0");
1134                         }
1135                 }
1136                 push(@obst_limit_func, " };\n");
1137         }
1138
1139         return ($class, $limit_name, $same_pos, $different_pos);
1140 }
1141
1142 ###
1143 # Generate register requirements structure
1144 ###
1145 sub generate_requirements {
1146         my ($reqs, $flags) = split(/:/, shift);
1147         my $node  = shift;
1148         my $op    = shift;
1149         my $idx   = shift;
1150         my $is_in = shift;
1151         my $class = "";
1152         my $result;
1153
1154         my @req_type_mask;
1155         if (defined($flags)) {
1156                 foreach my $f (split(/|/, $flags)) {
1157                         if ($f eq "I") {
1158                                 push(@req_type_mask, "arch_register_req_type_ignore");
1159                         } elsif ($f eq "S") {
1160                                 push(@req_type_mask, "arch_register_req_type_produces_sp");
1161                         }
1162                 }
1163         }
1164
1165         if ($reqs eq "none") {
1166
1167                 $result = <<EOF;
1168 {
1169         arch_register_req_type_none,
1170         NULL,                         /* regclass */
1171         NULL,                         /* limit bitset */
1172         0,                            /* same pos */
1173         0                             /* different pos */
1174 };
1175
1176 EOF
1177         } elsif (is_reg_class($reqs)) {
1178                 push(@req_type_mask, "arch_register_req_type_normal");
1179                 my $reqtype = join(" | ", @req_type_mask);
1180                 $class  = $reqs;
1181                 $result = <<EOF;
1182 {
1183         ${reqtype},
1184         & ${arch}_reg_classes[CLASS_${arch}_${class}],
1185         NULL,        /* limit bitset */
1186         0,           /* same pos */
1187         0            /* different pos */
1188 };
1189
1190 EOF
1191
1192         } else {
1193                 my ($regclass, $limit_bitset, $same_pos, $different_pos)
1194                         = build_subset_class_func($node, $op, $idx, $is_in, $reqs, $flags);
1195
1196                 if (!defined($regclass)) {
1197                         die("Fatal error: Could not build subset for requirements '$reqs' of '$op' pos $idx ... exiting.\n");
1198                 }
1199
1200                 if (defined($limit_bitset) && $limit_bitset ne "NULL") {
1201                         push(@req_type_mask, "arch_register_req_type_limited");
1202                 }
1203                 if ($same_pos != 0) {
1204                         push(@req_type_mask, "arch_register_req_type_should_be_same");
1205                 }
1206                 if ($different_pos != 0) {
1207                         push(@req_type_mask, "arch_register_req_type_must_be_different");
1208                 }
1209                 my $reqtype = join(" | ", @req_type_mask);
1210
1211                 if(!defined($limit_bitset)) {
1212                         $limit_bitset = "NULL";
1213                 }
1214
1215                 $class  = $regclass;
1216                 $result = <<EOF;
1217 {
1218         ${reqtype},
1219         & ${arch}_reg_classes[CLASS_${arch}_${class}],
1220         ${limit_bitset},
1221         ${same_pos},        /* same pos */
1222         ${different_pos}        /* different pos */
1223 };
1224
1225 EOF
1226         }
1227
1228         my $name = "${arch}_requirements_".mangle_requirements($reqs, $class, $flags);
1229         if(defined($requirements{$name})) {
1230                 return $name;
1231         }
1232         $requirements{$name} = $name;
1233         push(@obst_reg_reqs, <<EOF);
1234 static const arch_register_req_t ${name} = ${result}
1235 EOF
1236
1237         return $name;
1238 }