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
  27 use strict;
  28 use Data::Dumper;
  29
  30 my $specfile   = $ARGV[0];
  31 my $target_dir = $ARGV[1];
  32 my $state      = 1;
  33 my $cur_op     = "";
  34 my $line_nr    = 0;
  35
  36 our $arch;
  37 our $additional_opcodes;
  38 our %nodes;
  39 our %operands;
  40 our %cpu;
  41 our $default_op_attr_type;
  42 our $default_attr_type;
  43 our $default_cmp_attr;
  44 our $default_copy_attr;
  45 our %init_attr;
  46 our $custom_init_attr_func;
  47 our %compare_attr;
  48 our %copy_attr;
  49 our %reg_classes;
  50 our %custom_irn_flags;
  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, irn_flags_, in_reqs, 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 $obst_header .= "void ${arch}_create_opcodes(const arch_irn_ops_t *be_ops);\n";
 162
 163 sub create_constructor {
 164         my $op   = shift;
 165         my $name = shift;
 166         my $n    = shift;
 167         my $on   = shift;
 168         my $known_mode;
 169
 170         my $suffix = "";
 171         if ($name ne "") {
 172                 $suffix = "_${name}";
 173         }
 174
 175         # determine mode
 176         if (exists($n->{mode})) {
 177                 $known_mode = $n->{mode};
 178         }
 179
 180         # determine arity
 181         my $arity = 0;
 182         if(exists($n->{"arity"})) {
 183                 $arity = $n->{"arity"};
 184         } elsif (exists($n->{"reg_req"}) && exists($n->{"reg_req"}{"in"})) {
 185                 $arity = scalar(@{ $n->{"reg_req"}{"in"} });
 186         } elsif (exists($n->{"ins"})) {
 187                 $arity = scalar(@{ $n->{"ins"} });
 188         }
 189         if($arity eq "variable") {
 190                 $arity = $ARITY_VARIABLE;
 191         } elsif($arity eq "dynamic") {
 192                 $arity = $ARITY_DYNAMIC;
 193         }
 194
 195         # determine out arity
 196         my $out_arity = 0;
 197         if(exists($n->{"out_arity"})) {
 198                 $out_arity = $n->{"out_arity"};
 199         } elsif (exists($n->{"reg_req"}) && exists($n->{"reg_req"}{"out"})) {
 200                 $out_arity = scalar(@{ $n->{"reg_req"}{"out"} });
 201         } elsif (exists($n->{"outs"})) {
 202                 $out_arity = scalar(@{ $n->{"outs"} });
 203         }
 204         if($out_arity eq "variable") {
 205                 $out_arity = $ARITY_VARIABLE;
 206         } elsif($out_arity eq "dynamic") {
 207                 $out_arity = $ARITY_DYNAMIC;
 208         }
 209         if ($out_arity != 0 && $out_arity != 1 && !defined($known_mode)) {
 210                 $known_mode = "mode_T";
 211         }
 212
 213         my $comment = $n->{"comment"};
 214         if(!exists($n->{"comment"})) {
 215                 $comment = "construct ${orig_op} node";
 216         }
 217         $comment =
 218                 "/**\n".
 219                 " * ${comment}\n".
 220                 " */\n";
 221
 222         $obst_constructor .= $comment;
 223
 224         # create constructor head
 225         my $complete_args = "";
 226         $temp             = "";
 227
 228         $temp = "ir_node *new_bd_${arch}_${op}${suffix}(dbg_info *dbgi, ir_node *block";
 229         if (!exists($n->{"args"})) { # default args
 230                 if ($arity == $ARITY_VARIABLE) {
 231                         $complete_args = ", int arity, ir_node *in[]";
 232                 } elsif ($arity == $ARITY_DYNAMIC) {
 233                         $complete_args = "";
 234                 } else {
 235                         for (my $i = 0; $i < $arity; $i++) {
 236                                 my $opname = "op${i}";
 237                                 if (exists($n->{"ins"})) {
 238                                         my @ins = @{ $n->{"ins"} };
 239                                         $opname = $ins[$i];
 240                                 }
 241
 242                                 $complete_args .= ", ir_node *${opname}";
 243                         }
 244                 }
 245                 if ($out_arity == $ARITY_VARIABLE) {
 246                         $complete_args .= ", int n_res";
 247                 }
 248
 249                 if (!defined($known_mode)) {
 250                         $complete_args .= ", ir_mode *mode";
 251                 }
 252         } else { # user defined args
 253                 for my $href (@{ $n->{"args"} }) {
 254                         $href->{"type"} .= " " if ($href->{"type"} !~ / [*]?$/); # put a space between name and type if there is none at the end
 255                         $complete_args  .= ", ".$href->{"type"}.$href->{"name"};
 256                 }
 257         }
 258
 259         # we have additional attribute arguements
 260         if (exists($n->{"attr"})) {
 261                 $complete_args .= ", ".$n->{"attr"};
 262         }
 263
 264         $temp .= "$complete_args)";
 265         $obst_constructor .= "${temp}\n{\n";
 266
 267         $obst_header .= $comment;
 268         $obst_header .= "${temp};\n";
 269
 270         # emit constructor code
 271         $temp = <<EOF;
 272         ir_graph         *irg        = get_irn_irg(block);
 273         ir_op            *op         = op_${arch}_${op};
 274         arch_irn_flags_t  irn_flags_ = arch_irn_flags_none;
 275         ir_node          *res;
 276         backend_info_t   *info;
 277 EOF
 278
 279         if($arity == $ARITY_DYNAMIC) {
 280                 $temp .= <<EOF;
 281         int             arity   = -1;
 282         ir_node       **in      = NULL;
 283 EOF
 284         } elsif($arity == $ARITY_VARIABLE) {
 285         } else {
 286                 $temp .= <<EOF;
 287         int             arity   = $arity;
 288 EOF
 289                 if($arity > 0) {
 290                         $temp .= <<EOF;
 291         ir_node        *in[$arity];
 292 EOF
 293                 } else {
 294                         $temp .= <<EOF;
 295         ir_node       **in      = NULL;
 296 EOF
 297                 }
 298         }
 299         if($out_arity == $ARITY_DYNAMIC) {
 300                 $temp .= <<EOF;
 301         int             n_res   = -1;
 302 EOF
 303         } elsif($out_arity == $ARITY_VARIABLE) {
 304         } else {
 305                 $temp .= <<EOF;
 306         int             n_res   = ${out_arity};
 307 EOF
 308         }
 309
 310         if (defined($known_mode)) {
 311                 $temp .= <<EOF;
 312         ir_mode        *mode    = ${known_mode};
 313 EOF
 314         }
 315
 316         undef my $in_req_var;
 317         undef my $out_req_var;
 318
 319         my $set_out_reqs = "";
 320
 321         # set up static variables for requirements and registers
 322         if (exists($n->{"reg_req"})) {
 323                 my %req = %{ $n->{"reg_req"} };
 324                 my $idx;
 325
 326                 undef my @in;
 327                 @in = @{ $req{"in"} } if (exists($req{"in"}));
 328                 undef my @out;
 329                 @out = @{ $req{"out"} } if exists(($req{"out"}));
 330
 331                 for(my $idx = 0; $idx < $#in; $idx++) {
 332                         my $req = $in[$idx];
 333                         generate_requirements($req, $n, "${arch}_${op}", $idx, 1);
 334                 }
 335                 for(my $idx = 0; $idx < $#out; $idx++) {
 336                         my $req = $out[$idx];
 337                         generate_requirements($req, $n, "${arch}_${op}", $idx, 0);
 338                 }
 339
 340                 if (@in) {
 341                         if($arity >= 0 && scalar(@in) != $arity) {
 342                                 die "Fatal error: Arity and number of in requirements don't match for ${op}\n";
 343                         }
 344
 345                         $temp .= "\tstatic const arch_register_req_t *in_reqs[] =\n";
 346                         $temp .= "\t{\n";
 347                         for ($idx = 0; $idx <= $#in; $idx++) {
 348                                 my $req = $in[$idx];
 349                                 my $reqstruct = generate_requirements($req, $n, "${arch}_${op}", $idx, 1);
 350                                 $temp .= "\t\t& ${reqstruct},\n";
 351                         }
 352                         $temp .= "\t};\n";
 353                 } else {
 354                         if($arity > 0) {
 355                                 die "Fatal error: need in requirements for ${op}\n";
 356                         }
 357                         $temp .= "\tstatic const arch_register_req_t **in_reqs = NULL;\n";
 358                 }
 359
 360                 if (@out) {
 361                         if($out_arity >= 0 && scalar(@out) != $out_arity) {
 362                                 die "Fatal error: Out-Arity and number of out requirements don't match for ${op}\n";
 363                         }
 364
 365                         for ($idx = 0; $idx <= $#out; $idx++) {
 366                                 my $req = $out[$idx];
 367                                 my $reqstruct = generate_requirements($req, $n, "${arch}_${op}", $idx, 0);
 368                                 $set_out_reqs .= <<EOF;
 369         info->out_infos[${idx}].req = &${reqstruct};
 370 EOF
 371                         }
 372                 } else {
 373                         if($out_arity > 0) {
 374                                 die "Fatal error: need out requirements for ${op}\n";
 375                         }
 376                 }
 377         } else {
 378                 $temp .= "\tstatic const arch_register_req_t **in_reqs = NULL;\n";
 379         }
 380         my $attr_type = $on->{attr_type};
 381         if(exists($n->{"init_attr"})) {
 382                 $temp .= "\t${attr_type} *attr;\n";
 383         }
 384
 385         $temp .= "\n";
 386
 387         if($arity > 0) {
 388                 $temp .= "\t/* construct in array */\n";
 389                 for (my $i = 0; $i < $arity; $i++) {
 390                         my $opname = "op${i}";
 391                         if (exists($n->{"ins"})) {
 392                                 my @ins = @{ $n->{"ins"} };
 393                                 $opname = $ins[$i];
 394                         }
 395
 396                         $temp .= "\tin[${i}] = ${opname};\n";
 397                 }
 398                 $temp .= "\n";
 399         }
 400
 401         # set flags
 402         if (exists($n->{"irn_flags"})) {
 403                 $temp .= "\t/* flags */\n";
 404                 my %known_irn_flags = (
 405                         "none"             => "arch_irn_flags_none",
 406                         "dont_spill"       => "arch_irn_flags_dont_spill",
 407                         "rematerializable" => "arch_irn_flags_rematerializable",
 408                         "modify_flags"     => "arch_irn_flags_modify_flags",
 409                         "simple_jump"      => "arch_irn_flags_simple_jump",
 410                         "not_scheduled"    => "arch_irn_flags_not_scheduled",
 411                 );
 412                 if (defined(%custom_irn_flags)) {
 413                         %known_irn_flags = (%known_irn_flags, %custom_irn_flags);
 414                 }
 415                 foreach my $flag (@{$n->{"irn_flags"}}) {
 416                         if (not defined($known_irn_flags{$flag})) {
 417                                 print STDERR "WARNING: irn_flag '$flag' in opcode $op is unknown\n";
 418                         } else {
 419                                 $temp .= "\tirn_flags_ |= " . $known_irn_flags{$flag} . ";\n";
 420                         }
 421                 }
 422                 $temp .= "\n";
 423         }
 424
 425         # lookup init function
 426         my $attr_init_code = "(void)in;(void)irn_flags_;(void)in_reqs;(void)n_res;";
 427         if ($attr_type ne "") {
 428                 $attr_init_code = $init_attr{$attr_type};
 429                 if(!defined($attr_init_code)) {
 430                         die "Fatal error: Couldn't find attribute initialisation code for type '${attr_type}'";
 431                 }
 432         }
 433         my $custominit = "";
 434         if(defined($custom_init_attr_func)) {
 435                 $custominit .= &$custom_init_attr_func($n, $on, "${arch}_${op}");
 436         }
 437         if(defined($n->{custominit})) {
 438                 $custominit .= $n->{custominit};
 439         }
 440
 441         $temp .= <<EOF;
 442         /* create node */
 443         assert(op != NULL);
 444         res = new_ir_node(dbgi, irg, block, op, mode, arity, in);
 445
 446         /* init node attributes */
 447         ${attr_init_code}
 448         ${custominit}
 449         info = be_get_info(res);
 450         (void) info; /* avoid potential warning */
 451 ${set_out_reqs}
 452
 453 EOF
 454
 455         if (exists($n->{"init_attr"})) {
 456                 $temp .= "\tattr = (${attr_type}*)get_irn_generic_attr(res);\n";
 457                 $temp .= "\t(void) attr; /* avoid potential warning */\n";
 458                 $temp .= "\t".$n->{"init_attr"}."\n";
 459         }
 460
 461         $temp .= <<EOF;
 462         /* optimize node */
 463         res = optimize_node(res);
 464         irn_verify_irg(res, irg);
 465
 466         return res;
 467 EOF
 468
 469         $obst_constructor .= $temp;
 470
 471         # close constructor function
 472         $obst_constructor .= "}\n\n";
 473 }
 474
 475 push(@obst_enum_op, "typedef enum ${arch}_opcodes {\n");
 476 foreach my $op (keys(%nodes)) {
 477         my %n        = %{ $nodes{"$op"} };
 478         my $known_mode;
 479         my $num_outs = 0;
 480         my $out_arity;
 481         my @out_flags;
 482
 483         # determine arity
 484         $arity = 0;
 485         if(exists($n{"arity"})) {
 486                 $arity = $n{"arity"};
 487         } elsif (exists($n{"reg_req"}) && exists($n{"reg_req"}{"in"})) {
 488                 $arity = scalar(@{ $n{"reg_req"}{"in"} });
 489         } elsif (exists($n{"ins"})) {
 490                 $arity = scalar(@{ $n{"ins"} });
 491         }
 492         if($arity eq "variable") {
 493                 $arity = $ARITY_VARIABLE;
 494         } elsif($arity eq "dynamic") {
 495                 $arity = $ARITY_DYNAMIC;
 496         }
 497
 498         # determine out arity
 499         $out_arity = 0;
 500         if(exists($n{"out_arity"})) {
 501                 $out_arity = $n{"out_arity"};
 502         } elsif (exists($n{"reg_req"}) && exists($n{"reg_req"}{"out"})) {
 503                 $out_arity = scalar(@{ $n{"reg_req"}{"out"} });
 504         } elsif (exists($n{"outs"})) {
 505                 $out_arity = scalar(@{ $n{"outs"} });
 506         }
 507         if($out_arity eq "variable") {
 508                 $out_arity = $ARITY_VARIABLE;
 509         } elsif($out_arity eq "dynamic") {
 510                 $out_arity = $ARITY_DYNAMIC;
 511         }
 512
 513         $orig_op = $op;
 514         $op      = $arch."_".$op;
 515         $temp    = "";
 516
 517         # define proj numbers and in numbers
 518         if (exists($n{"outs"})) {
 519                 undef my @outs;
 520
 521                 @outs = @{ $n{"outs"} };
 522                 if($out_arity >= 0 && scalar(@outs) != $out_arity) {
 523                         die "Fatal error: Op ${op} has different number of outs and out_arity\n";
 524                 }
 525
 526                 $num_outs = $#outs + 1;
 527
 528                 if ($num_outs > 0) {
 529                         $obst_proj .= "\nenum pn_${op} {\n";
 530
 531                         for (my $idx = 0; $idx <= $#outs; $idx++) {
 532                                 # check, if we have additional flags annotated to out
 533                                 if ($outs[$idx] =~ /:((S|I)(\|(S|I))*)/) {
 534                                         push(@out_flags, $1);
 535                                         $outs[$idx] =~ s/:((S|I)(\|(S|I))*)//;
 536                                 }
 537                                 $obst_proj .= "\tpn_${op}_".$outs[$idx]." = ${idx},\n";
 538                         }
 539
 540                         $obst_proj .= "};\n";
 541                 }
 542                 # outs have names, it must be a mode_T node
 543                 if (!defined($n{mode})) {
 544                         $n{mode} = "mode_T";
 545                 }
 546         }
 547         if (exists($n{"ins"})) {
 548                 undef my @ins;
 549
 550                 @ins = @{ $n{"ins"} };
 551                 if($arity >= 0 && scalar(@ins) != $arity) {
 552                         die "Fatal error: Op ${op} has different number of ins and arity\n";
 553                 }
 554
 555                 if ($#ins >= 0) {
 556                         $obst_proj .= "\nenum n_$op {\n";
 557                         for (my $idx = 0; $idx <= $#ins; $idx++) {
 558                                 $obst_proj .= "\tn_${op}_".$ins[$idx]." = ${idx},\n";
 559                         }
 560                         $obst_proj .= "};\n";
 561                 }
 562         }
 563
 564         # Create opcode
 565         push(@obst_opvar, "ir_op *op_$op = NULL;\n");
 566         push(@obst_get_opvar, "ir_op *get_op_$op(void)         { return op_$op; }\n");
 567         push(@obst_get_opvar, "int    is_$op(const ir_node *n) { return get_$arch\_irn_opcode(n) == iro_$op; }\n\n");
 568
 569         push(@obst_is_archirn, "is_$op(node)");
 570
 571         $obst_header .= <<EOF;
 572 extern ir_op *op_${op};
 573 ir_op *get_op_${op}(void);
 574 int is_${op}(const ir_node *n);
 575 EOF
 576
 577         my $attr_type= $n{attr_type};
 578         if(!defined($attr_type)) {
 579                 $attr_type = $default_attr_type;
 580                 $n{attr_type} = $attr_type;
 581         }
 582
 583         # determine hash function
 584         my $hash_func;
 585         if (exists($n{"hash_func"})) {
 586                 $hash_func = $n{"hash_func"};
 587         }
 588
 589         # determine compare function
 590         my $cmp_attr_func;
 591         if (exists($n{"cmp_attr"})) {
 592                 my $cmpcode = $n{"cmp_attr"};
 593
 594                 push(@obst_cmp_attr, "static int cmp_attr_$op(const ir_node *a, const ir_node *b) {\n");
 595                 if($cmpcode =~ m/attr_a/) {
 596                         push(@obst_cmp_attr, "\tconst ${attr_type} *attr_a = get_irn_generic_attr_const(a);\n");
 597                 } else {
 598                         push(@obst_cmp_attr, "\t(void) a;\n");
 599                 }
 600                 if($cmpcode =~ m/attr_b/) {
 601                         push(@obst_cmp_attr, "\tconst ${attr_type} *attr_b = get_irn_generic_attr_const(b);\n");
 602                 } else {
 603                         push(@obst_cmp_attr, "\t(void) b;\n");
 604                 }
 605                 push(@obst_cmp_attr, "\t${cmpcode}\n");
 606                 push(@obst_cmp_attr, "}\n\n");
 607
 608                 $cmp_attr_func = "cmp_attr_${op}";
 609         } elsif ($attr_type eq "") {
 610                 $cmp_attr_func = "NULL";
 611         } else {
 612                 if(defined($compare_attr{${attr_type}})) {
 613                         $cmp_attr_func = $compare_attr{${attr_type}};
 614                 } else {
 615                         die "Fatal error: No compare function defined for ${attr_type} attributes.";
 616                 }
 617         }
 618
 619         my %constructors;
 620         if (exists($n{constructors})) {
 621                 %constructors = %{ $n{constructors} };
 622         } else {
 623                 # Create 1 default constructor
 624                 my %constructor = ();
 625                 foreach my $a ("comment", "ins", "outs", "args", "attr", "units",
 626                                 "reg_req", "init_attr", "irn_flags", "mode", "arity",
 627                                 "out_arity", "custominit") {
 628                         if (defined($n{$a})) {
 629                                 $constructor{$a} = $n{$a};
 630                         }
 631                 }
 632                 %constructors = ( "" => \%constructor );
 633         }
 634
 635         foreach my $constr (keys(%constructors)) {
 636                 my %cstr = %{ $constructors{$constr} };
 637                 # Copy some values from outer node if they don't exists in the constr
 638                 foreach my $a ("ins", "outs", "irn_flags", "mode", "args", "attr",
 639                                "custominit") {
 640                         if (!defined($cstr{$a}) && defined($n{$a})) {
 641                                 $cstr{$a} = $n{$a};
 642                         }
 643                 }
 644                 create_constructor($orig_op, $constr, \%cstr, \%n);
 645         }
 646
 647         # set default values for state and flags if not given
 648         $n{"state"}     = "floats" if (! exists($n{"state"}));
 649         $n{"op_flags"}  = ["none"] if (! exists($n{"op_flags"}));
 650         $n{"dump_func"} = "${arch}_dump_node" if (!exists($n{"dump_func"}));
 651         my $dump_func = $n{"dump_func"};
 652
 653         push(@obst_new_irop, "\n\tmemset(&ops, 0, sizeof(ops));\n");
 654         push(@obst_new_irop, "\tops.be_ops        = be_ops;\n");
 655         push(@obst_new_irop, "\tops.dump_node     = ${dump_func};\n");
 656
 657         if (defined($cmp_attr_func)) {
 658                 push(@obst_new_irop, "\tops.node_cmp_attr = ${cmp_attr_func};\n");
 659         }
 660         my $copy_attr_func = $copy_attr{$attr_type};
 661         if (!defined($copy_attr_func)) {
 662                 if ($attr_type eq "") {
 663                         $copy_attr_func = "NULL";
 664                 } else {
 665                         $copy_attr_func = $default_copy_attr;
 666                 }
 667         }
 668         if (defined($copy_attr_func)) {
 669                 push(@obst_new_irop, "\tops.copy_attr = ${copy_attr_func};\n");
 670         }
 671         if (defined($hash_func)) {
 672                 push(@obst_new_irop, "\tops.hash = ${hash_func};\n");
 673         }
 674
 675         my %known_flags = map { $_ => 1 } (
 676                 "none", "labeled", "commutative", "cfopcode", "unknown_jump", "fragile",
 677                 "forking", "highlevel", "constlike", "always_opt", "keep",
 678                 "start_block", "uses_memory", "dump_noblock", "dump_noinput",
 679                 "machine", "machine_op", "cse_neutral"
 680         );
 681         my $is_fragile = 0;
 682         foreach my $flag (@{$n{"op_flags"}}) {
 683                 if (not defined($known_flags{$flag})) {
 684                         print STDERR "WARNING: Flag '$flag' in opcode $op is unknown\n";
 685                 }
 686                 if ($flag eq "fragile") {
 687                         $is_fragile = 1;
 688                 }
 689         }
 690         my @mapped = map { "irop_flag_$_" } @{$n{"op_flags"}};
 691         my $op_flags = join('|', @mapped);
 692
 693         my $attr_size = "0";
 694         if ($attr_type ne "") {
 695                 $attr_size = "sizeof(${attr_type})"
 696         }
 697
 698         $n_opcodes++;
 699         $temp  = "\top_$op = new_ir_op(cur_opcode + iro_$op, \"$op\", op_pin_state_".$n{"state"}.", $op_flags";
 700         $temp .= "|irop_flag_machine, ".translate_arity($arity).", 0, ${attr_size}, &ops);\n";
 701         push(@obst_new_irop, $temp);
 702         if ($is_fragile) {
 703                 push(@obst_new_irop, "\tir_op_set_fragile_indices(op_${op}, n_${op}_mem, pn_${op}_X_regular, pn_${op}_X_except);\n");
 704         }
 705         push(@obst_new_irop, "\tset_op_tag(op_$op, $arch\_op_tag);\n");
 706         if(defined($default_op_attr_type)) {
 707                 push(@obst_new_irop, "\tattr = &attrs[iro_$op];\n");
 708                 if(defined($n{op_attr_init})) {
 709                         push(@obst_new_irop, "\t".$n{op_attr_init}."\n");
 710                 }
 711                 push(@obst_new_irop, "\tset_op_attr(op_$op, attr);\n");
 712         }
 713
 714         push(@obst_enum_op, "\tiro_$op,\n");
 715
 716         $obst_header .= "\n";
 717 }
 718 push(@obst_enum_op, "\tiro_$arch\_last_generated,\n");
 719 push(@obst_enum_op, "\tiro_$arch\_last = iro_$arch\_last_generated");
 720 push(@obst_enum_op, " + $additional_opcodes") if (defined($additional_opcodes));
 721 push(@obst_enum_op, "\n} $arch\_opcodes;\n\n");
 722
 723 # emit the code
 724
 725 open(OUT, ">$target_c") || die("Fatal error: Could not open $target_c, reason: $!\n");
 726
 727 print OUT "#include \"gen_$arch\_regalloc_if.h\"\n";
 728 print OUT "#include \"irverify_t.h\"\n";
 729 print OUT "\n";
 730 print OUT @obst_cmp_attr;
 731 print OUT "\n";
 732 print OUT @obst_opvar;
 733 print OUT "\n";
 734 print OUT @obst_get_opvar;
 735 print OUT "\n";
 736
 737 print OUT<<EOF;
 738
 739 static int $arch\_opcode_start = -1;
 740 static int $arch\_opcode_end   = -1;
 741
 742 EOF
 743
 744 # build the FOURCC arguments from $arch
 745
 746 my ($a, $b, $c, $d) = ('\0', '\0', '\0', '\0');
 747
 748 if (length($arch) >= 1) {
 749         $a = uc(substr($arch, 0, 1));
 750 }
 751
 752 if (length($arch) >= 2) {
 753         $b = uc(substr($arch, 1, 1));
 754 }
 755
 756 if (length($arch) >= 3) {
 757         $c = uc(substr($arch, 2, 1));
 758 }
 759
 760 if (length($arch) >= 4) {
 761         $d = uc(substr($arch, 3, 1));
 762 }
 763
 764 print OUT<<ENDOFISIRN;
 765
 766 /** A tag for the $arch opcodes. Note that the address is used as a tag value, NOT the FOURCC code. */
 767 #define $arch\_op_tag FOURCC('$a', '$b', '$c', '$d')
 768
 769 /** Return the opcode number of the first $arch opcode. */
 770 int get_$arch\_opcode_first(void) {
 771         return $arch\_opcode_start;
 772 }
 773
 774 /** Return the opcode number of the last $arch opcode + 1. */
 775 int get_$arch\_opcode_last(void) {
 776         return $arch\_opcode_end;
 777 }
 778
 779 /** Return 1 if the given opcode is a $arch machine op, 0 otherwise */
 780 int is_$arch\_op(const ir_op *op) {
 781         return get_op_tag(op) == $arch\_op_tag;
 782 }
 783
 784 /** Return 1 if the given node is a $arch machine node, 0 otherwise */
 785 int is_$arch\_irn(const ir_node *node) {
 786         return is_$arch\_op(get_irn_op(node));
 787 }
 788
 789 int get_$arch\_irn_opcode(const ir_node *node) {
 790         if (is_$arch\_irn(node))
 791                 return get_irn_opcode(node) - $arch\_opcode_start;
 792         return -1;
 793 }
 794
 795 ENDOFISIRN
 796
 797 print OUT <<END;
 798 #ifdef BIT
 799 #undef BIT
 800 #endif
 801 #define BIT(x)  (1 << (x))
 802
 803 END
 804
 805 print OUT @obst_limit_func;
 806 print OUT "\n";
 807
 808 print OUT @obst_reg_reqs;
 809 print OUT "\n";
 810
 811 print OUT<<ENDOFMAIN;
 812 $obst_constructor
 813
 814 /**
 815  * Creates the $arch specific Firm machine operations
 816  * needed for the assembler irgs.
 817  */
 818 void $arch\_create_opcodes(const arch_irn_ops_t *be_ops) {
 819         ir_op_ops  ops;
 820         int        cur_opcode;
 821         static int run_once = 0;
 822 ENDOFMAIN
 823
 824         if (defined($default_op_attr_type)) {
 825                 print OUT "\t$default_op_attr_type *attr, *attrs;\n";
 826         }
 827
 828 print OUT<<ENDOFMAIN;
 829
 830         if (run_once)
 831                 return;
 832         run_once = 1;
 833
 834         cur_opcode = get_next_ir_opcodes(iro_$arch\_last);
 835
 836         $arch\_opcode_start = cur_opcode;
 837 ENDOFMAIN
 838
 839         if (defined($default_op_attr_type)) {
 840                 print OUT "\tattrs = XMALLOCNZ(${default_op_attr_type}, iro_${arch}_last);\n";
 841         }
 842
 843 print OUT @obst_new_irop;
 844 print OUT "\n";
 845 print OUT "\t$arch\_register_additional_opcodes(cur_opcode);\n" if (defined($additional_opcodes));
 846 print OUT "\t$arch\_opcode_end = cur_opcode + iro_$arch\_last";
 847 print OUT " + $additional_opcodes" if (defined($additional_opcodes));
 848 print OUT ";\n";
 849 print OUT "}\n";
 850
 851 close(OUT);
 852
 853 open(OUT, ">$target_h") || die("Fatal error: Could not open $target_h, reason: $!\n");
 854
 855 my $creation_time = localtime(time());
 856 my $tmp = uc($arch);
 857
 858 print OUT<<EOF;
 859 /**
 860  * \@file
 861  * \@brief Function prototypes for the new opcode functions.
 862  * \@note  DO NOT EDIT THIS FILE, your changes will be lost.
 863  *        Edit $specfile instead.
 864  *        created by: $0 $specfile $target_dir
 865  * \@date  $creation_time
 866  */
 867 #ifndef FIRM_BE_${tmp}_GEN_${tmp}_NEW_NODES_H
 868 #define FIRM_BE_${tmp}_GEN_${tmp}_NEW_NODES_H
 869
 870 EOF
 871
 872 print OUT @obst_enum_op;
 873 print OUT <<EOF;
 874 int is_${arch}_irn(const ir_node *node);
 875 int is_${arch}_op(const ir_op *op);
 876
 877 int get_${arch}_opcode_first(void);
 878 int get_${arch}_opcode_last(void);
 879 int get_${arch}_irn_opcode(const ir_node *node);
 880 ${obst_header}
 881 ${obst_proj}
 882
 883 #endif
 884 EOF
 885
 886 close(OUT);
 887
 888 ###
 889 # Translates numeric arity into string constant.
 890 ###
 891 sub translate_arity {
 892         my $arity = shift;
 893
 894         if ($arity =~ /^\d+$/) {
 895                 if    ($arity == 0) {
 896                         return "oparity_zero";
 897                 }
 898                 elsif ($arity == 1) {
 899                         return "oparity_unary";
 900                 }
 901                 elsif ($arity == 2) {
 902                         return "oparity_binary";
 903                 }
 904                 elsif ($arity == 3) {
 905                         return "oparity_trinary";
 906                 }
 907                 else {
 908                         return "oparity_any";
 909                 }
 910         } elsif ($arity == $ARITY_VARIABLE) {
 911                 return "oparity_variable";
 912         } elsif ($arity == $ARITY_DYNAMIC) {
 913                 return "oparity_dynamic";
 914         } else {
 915                 die "Fatal error: Unknown arity $arity";
 916         }
 917 }
 918
 919 sub mangle_requirements {
 920         my $reqs  = shift;
 921         my $class = shift;
 922         my $flags = shift;
 923
 924         my @alternatives = split(/ /, $reqs);
 925         for(my $idx = 0; $idx < scalar(@alternatives); $idx++) {
 926                 $alternatives[$idx] =~ s/!/not_/g;
 927         }
 928
 929         @alternatives = sort @alternatives;
 930
 931         my $name = $class."_".join('_', @alternatives);
 932         if (defined($flags)) {
 933                 $flags =~ s/\|/_/g;
 934                 $name .= "_$flags";
 935         }
 936
 937         return $name;
 938 }
 939
 940 ###
 941 # Determines whether $name is a specified register class or not.
 942 # @return 1 if name is register class, 0 otherwise
 943 ###
 944 sub is_reg_class {
 945     my $name = shift;
 946     return 1 if exists($reg_classes{"$name"});
 947     return 0;
 948 }
 949
 950 ###
 951 # Returns the register class for a given register.
 952 # @return class or undef
 953 ###
 954 sub get_reg_class {
 955     my $reg = shift;
 956     $reg = substr($reg, 1) if ($reg =~ /!.*/);
 957     return $reg2class{"$reg"}{"class"} if (exists($reg2class{"$reg"}));
 958     return undef;
 959 }
 960
 961 ###
 962 # Returns the index of a given register within its register class.
 963 # @return index or undef
 964 ###
 965 sub get_reg_index {
 966     my $reg = shift;
 967     return $reg2class{"$reg"}{"index"} if (exists($reg2class{"$reg"}));
 968     return undef;
 969 }
 970
 971 ###
 972 # Remember the register class for each index in the given requirements.
 973 # We need this information for requirements like "in_sX" or "out_dX"
 974 # @return array of classes corresponding to the requirement for each index
 975 ###
 976 sub build_inout_idx_class {
 977         my $n     = shift;
 978         my $op    = shift;
 979         my $is_in = shift;
 980         my @idx_class;
 981
 982         my $inout = ($is_in ? "in" : "out");
 983
 984         if (exists($n->{"reg_req"}{"$inout"})) {
 985                 my @reqs = @{ $n->{"reg_req"}{"$inout"} };
 986
 987                 for (my $idx = 0; $idx <= $#reqs; $idx++) {
 988                         my $class = undef;
 989                         my ($req,) = split(/:/, $reqs[$idx]);
 990
 991                         if ($req eq "none") {
 992                                 $class = "none";
 993                         } elsif (is_reg_class($req)) {
 994                                 $class = $req;
 995                         } else {
 996                                 my @regs = split(/ /, $req);
 997 GET_CLASS:              foreach my $reg (@regs) {
 998                                         if ($reg =~ /!?(in|out)\_r\d+/ || $reg =~ /!in/) {
 999                                                 $class = "UNKNOWN_CLASS";
1000                                         } else {
1001                                                 $class = get_reg_class($reg);
1002                                                 if (!defined $class) {
1003                                                         die("Fatal error: Could not get ".uc($inout)." register class for '$op' pos $idx (reg $reg) ... exiting.\n");
1004                                                 } else {
1005                                                         last GET_CLASS;
1006                                                 } # !defined class
1007                                         } # if (reg =~ ...
1008                                 } # foreach
1009                         } # if
1010
1011                         push(@idx_class, $class);
1012                 } # for
1013         } # if
1014
1015         return @idx_class;
1016 }
1017
1018 ###
1019 # Generates the function for a given $op and a given IN-index
1020 # which returns a subset of possible register from a register class
1021 # @return classname from which the subset is derived or undef and
1022 #         pos which corresponds to in/out reference position or undef
1023 ###
1024 sub build_subset_class_func {
1025         my $neg           = undef;
1026         my $class         = undef;
1027         my $has_limit     = 0;
1028         my $limit_name;
1029         my $same_pos      = 0;
1030         my $different_pos = 0;
1031         my $temp;
1032         my @obst_init;
1033         my @obst_limits;
1034         my @obst_ignore;
1035         my @limit_array;
1036         my $limit_reqs;   #used for name mangling
1037
1038         # build function header
1039         my $node  = shift;
1040         my $op    = shift;
1041         my $idx   = shift;
1042         my $is_in = shift;
1043         my @regs  = split(/ /, shift);
1044         my $flags = shift;
1045
1046         my @idx_class = build_inout_idx_class($node, $op, !$is_in);
1047
1048         # set/unset registers
1049 CHECK_REQS: foreach (@regs) {
1050                 if (!$is_in && /(!)?in_r(\d+)/) {
1051                         my $bit_pos = 1 << ($2 - 1);
1052                         if ($different_pos & $bit_pos) {
1053                                 if ($1) {
1054                                         print STDERR "duplicate !in constraint\n";
1055                                 } else {
1056                                         print STDERR "conflicting !in and in constraints\n";
1057                                 }
1058                                 return (undef, undef, undef, undef);
1059                         }
1060
1061                         if ($same_pos & $bit_pos) {
1062                                 if ($1) {
1063                                         print STDERR "conflicting !in and in constraints\n";
1064                                 } else {
1065                                         print STDERR "duplicate in constraint\n";
1066                                 }
1067                                 return (undef, undef, undef, undef);
1068                         }
1069
1070                         if ($1) {
1071                                 $different_pos |= $bit_pos;
1072                         } else {
1073                                 $same_pos      |= $bit_pos;
1074                         }
1075
1076                         $class = $idx_class[$2 - 1];
1077                         next CHECK_REQS;
1078                 }
1079
1080                 # check for negate
1081                 if (substr($_, 0, 1) eq "!") {
1082                         if (defined($neg) && $neg == 0) {
1083                                 # we have seen a positiv constraint as first one but this one is negative
1084                                 # this doesn't make sense
1085                                 print STDERR "Mixed positive and negative constraints for the same slot are not allowed.\n";
1086                                 return (undef, undef, undef, undef);
1087                         }
1088
1089                         if (!defined($neg)) {
1090                                 $has_limit = 1;
1091                         }
1092
1093                         $_   = substr($_, 1); # skip '!'
1094                         $neg = 1;
1095                 } else {
1096                         if (defined($neg) && $neg == 1) {
1097                                 # we have seen a negative constraint as first one but this one is positive
1098                                 # this doesn't make sense
1099                                 print STDERR "Mixed positive and negative constraints for the same slot are not allowed.\n";
1100                                 return (undef, undef, undef, undef);
1101                         }
1102
1103                         $has_limit = 1;
1104                         $neg = 0;
1105                 }
1106
1107                 # check if register belongs to one of the given classes
1108                 $temp = get_reg_class($_);
1109                 if (!defined($temp)) {
1110                         print STDERR "Unknown register '$_'!\n";
1111                         return (undef, undef, undef, undef);
1112                 }
1113
1114                 # set class
1115                 if (!defined($class)) {
1116                         $class = $temp;
1117                 } elsif ($class ne $temp) {
1118                         # all registers must belong to the same class
1119                         print STDERR "Registerclass mismatch. '$_' is not member of class '$class'.\n";
1120                         return (undef, undef, undef, undef);
1121                 }
1122
1123                 # calculate position inside the initializer bitfield (only 32 bits per
1124                 # element)
1125                 my $regidx = get_reg_index($_);
1126                 my $arrayp = $regidx / 32;
1127                 push(@{$limit_array[$arrayp]}, $_);
1128                 $limit_reqs .= "$_ ";
1129         }
1130
1131         # don't allow ignore regs in negative constraints
1132         if($neg) {
1133                 my @cur_class = @{ $reg_classes{"$class"} };
1134                 for (my $idx = 0; $idx <= $#cur_class; $idx++) {
1135                         if (defined($cur_class[$idx]{"type"}) && ($cur_class[$idx]{"type"} & 4)) {
1136                                 my $reg    = $cur_class[$idx]{"name"};
1137                                 my $regix  = get_reg_index($reg);
1138                                 my $arrayp = $regix / 32;
1139                                 push(@{$limit_array[$arrayp]}, $reg);
1140                                 $limit_reqs .= "$reg ";
1141                         }
1142                 }
1143         }
1144
1145         if ($has_limit == 1) {
1146                 $limit_name = "${arch}_limit_".mangle_requirements($limit_reqs, $class);
1147
1148                 if(defined($limit_bitsets{$limit_name})) {
1149                         $limit_name = $limit_bitsets{$limit_name};
1150                         return ($class, $limit_name, $same_pos, $different_pos);
1151                 }
1152
1153                 $limit_bitsets{$limit_name} = $limit_name;
1154
1155                 push(@obst_limit_func, "static const unsigned " . $limit_name . "[] = { ");
1156                 my $first = 1;
1157                 my $limitbitsetlen = $regclass2len{$class};
1158                 my $limitarraylen = ($limitbitsetlen+31) / 32;
1159                 for(my $i = 0; $i < $limitarraylen; $i++) {
1160
1161                         my $limitarraypart = $limit_array[$i];
1162                         if($first) {
1163                                 $first = 0;
1164                         } else {
1165                                 push(@obst_limit_func, ", ");
1166                         }
1167                         my $temp;
1168                         if($neg) {
1169                                 $temp = "0xFFFFFFFF";
1170                         }
1171                         foreach my $reg (@{$limitarraypart}) {
1172                                 if($neg) {
1173                                         $temp .= " & ~";
1174                                 } elsif(defined($temp)) {
1175                                         $temp .= " | ";
1176                                 }
1177                                 my $firstreg = uc($reg_classes{$class}[0]->{"name"});
1178                                 my $classuc = uc($class);
1179                                 my $reguc = uc($reg);
1180                                 $temp .= "BIT(REG_${classuc}_${reguc})";
1181                         }
1182                         if(defined($temp)) {
1183                                 push(@obst_limit_func, "${temp}");
1184                         } else {
1185                                 push(@obst_limit_func, "0");
1186                         }
1187                 }
1188                 push(@obst_limit_func, " };\n");
1189         }
1190
1191         return ($class, $limit_name, $same_pos, $different_pos);
1192 }
1193
1194 ###
1195 # Generate register requirements structure
1196 ###
1197 sub generate_requirements {
1198         my ($reqs, $flags) = split(/:/, shift);
1199         my $node  = shift;
1200         my $op    = shift;
1201         my $idx   = shift;
1202         my $is_in = shift;
1203         my $class = "";
1204         my $width = 1;
1205         my $result;
1206
1207         my @req_type_mask;
1208         if (defined($flags)) {
1209                 foreach my $f (split(/|/, $flags)) {
1210                         if ($f eq "I") {
1211                                 push(@req_type_mask, "arch_register_req_type_ignore");
1212                         } elsif ($f eq "S") {
1213                                 push(@req_type_mask, "arch_register_req_type_produces_sp");
1214                         } elsif ($f eq "a") {
1215                                 push(@req_type_mask, "arch_register_req_type_aligned");
1216                         } elsif ($f eq "2" or $f eq "4" or $f eq "8") {
1217                                 $width = int($f);
1218                         }
1219                 }
1220         }
1221
1222         if ($reqs eq "none") {
1223
1224                 $result = <<EOF;
1225 {
1226         arch_register_req_type_none,
1227         NULL,                         /* regclass */
1228         NULL,                         /* limit bitset */
1229         0,                            /* same pos */
1230         0,                            /* different pos */
1231         0                             /* width */
1232 };
1233
1234 EOF
1235         } elsif (is_reg_class($reqs)) {
1236                 push(@req_type_mask, "arch_register_req_type_normal");
1237                 my $reqtype = join(" | ", @req_type_mask);
1238                 $class  = $reqs;
1239                 $result = <<EOF;
1240 {
1241         ${reqtype},
1242         & ${arch}_reg_classes[CLASS_${arch}_${class}],
1243         NULL,        /* limit bitset */
1244         0,           /* same pos */
1245         0,           /* different pos */
1246         $width            /* width */
1247 };
1248
1249 EOF
1250
1251         } else {
1252                 my ($regclass, $limit_bitset, $same_pos, $different_pos)
1253                         = build_subset_class_func($node, $op, $idx, $is_in, $reqs, $flags);
1254
1255                 if (!defined($regclass)) {
1256                         die("Fatal error: Could not build subset for requirements '$reqs' of '$op' pos $idx ... exiting.\n");
1257                 }
1258
1259                 if (defined($limit_bitset) && $limit_bitset ne "NULL") {
1260                         push(@req_type_mask, "arch_register_req_type_limited");
1261                 }
1262                 if ($same_pos != 0) {
1263                         push(@req_type_mask, "arch_register_req_type_should_be_same");
1264                 }
1265                 if ($different_pos != 0) {
1266                         push(@req_type_mask, "arch_register_req_type_must_be_different");
1267                 }
1268                 my $reqtype = join(" | ", @req_type_mask);
1269
1270                 if(!defined($limit_bitset)) {
1271                         $limit_bitset = "NULL";
1272                 }
1273
1274                 $class  = $regclass;
1275                 $result = <<EOF;
1276 {
1277         ${reqtype},
1278         & ${arch}_reg_classes[CLASS_${arch}_${class}],
1279         ${limit_bitset},
1280         ${same_pos},        /* same pos */
1281         ${different_pos},       /* different pos */
1282         $width             /* width */
1283 };
1284
1285 EOF
1286         }
1287
1288         my $name = "${arch}_requirements_".mangle_requirements($reqs, $class, $flags);
1289         if(defined($requirements{$name})) {
1290                 return $name;
1291         }
1292         $requirements{$name} = $name;
1293         push(@obst_reg_reqs, <<EOF);
1294 static const arch_register_req_t ${name} = ${result}
1295 EOF
1296
1297         return $name;
1298 }