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