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