4 # Copyright (C) 1995-2007 University of Karlsruhe. All right reserved.
6 # This file is part of libFirm.
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.
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.
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
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
31 my $specfile = $ARGV[0];
32 my $target_dir = $ARGV[1];
38 our $additional_opcodes;
41 our $default_cmp_attr;
42 our $default_attr_type;
49 unless ($return = do $specfile) {
50 die "couldn't parse $specfile: $@" if $@;
51 die "couldn't do $specfile: $!" unless defined $return;
52 die "couldn't run $specfile" unless $return;
56 my $target_c = $target_dir."/gen_".$arch."_new_nodes.c.inl";
57 my $target_h = $target_dir."/gen_".$arch."_new_nodes.h";
59 if(!defined($default_attr_type)) {
60 $default_attr_type = "${arch}_attr_t";
63 #print Dumper(%nodes);
64 #print Dumper(%operands);
66 # create c code file from specs
68 my @obst_opvar; # stack for the "ir_op *op_<arch>_<op-name> = NULL;" statements
69 my @obst_get_opvar; # stack for the get_op_<arch>_<op-name>() functions
70 my @obst_constructor; # stack for node constructor functions
71 my @obst_new_irop; # stack for the new_ir_op calls
72 my @obst_enum_op; # stack for creating the <arch>_opcode enum
73 my @obst_header; # stack for function prototypes
74 my @obst_is_archirn; # stack for the is_$arch_irn() function
75 my @obst_cmp_attr; # stack for the compare attribute functions
76 my @obst_proj; # stack for the pn_ numbers
81 my $n_opcodes = 0; # number of opcodes
83 # for registering additional opcodes
84 $n_opcodes += $additional_opcodes if (defined($additional_opcodes));
86 push(@obst_header, "void ".$arch."_create_opcodes(void);\n");
88 # create default compare function
89 if(defined($default_cmp_attr)) {
90 my $cmpcode = $default_cmp_attr;
91 push(@obst_cmp_attr, "static int default_cmp_attr(ir_node *a, ir_node *b) {\n");
92 if($cmpcode =~ m/attr_a/) {
93 push(@obst_cmp_attr, "\t${default_attr_type} *attr_a = get_irn_generic_attr(a);\n");
95 if($cmpcode =~ m/attr_b/) {
96 push(@obst_cmp_attr, "\t${default_attr_type} *attr_b = get_irn_generic_attr(b);\n");
98 push(@obst_cmp_attr, "\t${cmpcode}\n");
99 push(@obst_cmp_attr, "}\n\n");
102 push(@obst_enum_op, "typedef enum _$arch\_opcodes {\n");
103 foreach my $op (keys(%nodes)) {
104 my %n = %{ $nodes{"$op"} };
110 # determine arity from in requirements
111 $arity = exists($n{"arity"}) ? $n{"arity"} : 0;
112 if (exists($n{"reg_req"}) && exists($n{"reg_req"}{"in"})) {
113 $arity = scalar(@{ $n{"reg_req"}{"in"} });
120 # define some proj numbers
121 if (exists($n{"outs"})) {
124 @outs = @{ $n{"outs"} };
125 $num_outs = $#outs + 1;
127 push(@obst_proj, "\nenum pn_$op {\n");
129 for (my $idx = 0; $idx <= $#outs; $idx++) {
130 # check, if we have additional flags annotated to out
131 if ($outs[$idx] =~ /:((S|I)(\|(S|I))*)/) {
132 push(@out_flags, $1);
133 $outs[$idx] =~ s/:((S|I)(\|(S|I))*)//;
135 push(@obst_proj, "\tpn_$op\_".$outs[$idx]." = $idx,\n");
138 push(@obst_proj, "};\n");
139 # outs have names, it must be a mode_T node
140 $known_mode = "mode_T";
142 if (exists($n{"ins"})) {
145 @ins = @{ $n{"ins"} };
146 my $num_ins = $#ins + 1;
148 push(@obst_proj, "\nenum n_$op {\n");
150 for (my $idx = 0; $idx <= $#ins; $idx++) {
151 push(@obst_proj, "\tn_${op}_".$ins[$idx]." = $idx,\n");
154 push(@obst_proj, "};\n");
156 if (exists($n{"mode"})) {
157 $known_mode = $n{"mode"};
160 push(@obst_opvar, "ir_op *op_$op = NULL;\n");
161 push(@obst_get_opvar, "ir_op *get_op_$op(void) { return op_$op; }\n");
162 push(@obst_get_opvar, "int is_$op(const ir_node *n) { return get_$arch\_irn_opcode(n) == iro_$op; }\n\n");
164 push(@obst_is_archirn, "is_$op(node)");
166 push(@obst_header, "extern ir_op *op_$op;\n");
167 push(@obst_header, "ir_op *get_op_$op(void);\n");
168 push(@obst_header, "int is_$op(const ir_node *n);\n");
170 my $attr_type= $n{"attr_type"};
171 if(!defined($attr_type)) {
172 $attr_type = $default_attr_type;
176 if(defined($default_cmp_attr)) {
177 $cmp_attr_func = "default_cmp_attr";
179 # create compare attribute function if needed
180 if (exists($n{"cmp_attr"})) {
181 my $cmpcode = $n{"cmp_attr"};
183 push(@obst_cmp_attr, "static int cmp_attr_$op(ir_node *a, ir_node *b) {\n");
184 if($cmpcode =~ m/attr_a/) {
185 push(@obst_cmp_attr, "\t${attr_type} *attr_a = get_irn_generic_attr(a);\n");
187 if($cmpcode =~ m/attr_b/) {
188 push(@obst_cmp_attr, "\t${attr_type} *attr_b = get_irn_generic_attr(b);\n");
190 push(@obst_cmp_attr, "\t${cmpcode}\n");
191 push(@obst_cmp_attr, "}\n\n");
193 $cmp_attr_func = "cmp_attr_${op}";
196 if (exists($n{"rd_constructor"}) && $n{"rd_constructor"} =~ /^NONE$/i) {
197 # we explicitly skip the constructor if the specification entry says NONE
200 $n{"comment"} = "construct $op" if(!exists($n{"comment"}));
201 $n{"comment"} =~ s/^"|"$//g; # remove "
202 $n{"comment"} = "/* ".$n{"comment"}." */\n";
203 push(@obst_constructor, $n{"comment"});
205 # create constructor head
206 my $complete_args = "";
210 $temp = "ir_node *new_rd_$op(dbg_info *db, ir_graph *irg, ir_node *block";
211 if (!exists($n{"args"}) || $n{"args"} =~ /^DEFAULT$/i) { # default args
212 if ($arity !~ /^\d+$/) {
213 print "DEFAULT args require numeric arity (0, 1, 2, ...)! Ignoring op $orig_op!\n";
216 for (my $i = 1; $i <= $arity; $i++) {
217 $complete_args .= ", ir_node *op".$i;
218 $arg_names .= ", op".$i;
220 if (!defined($known_mode)) {
221 $complete_args .= ", ir_mode *mode";
222 $arg_names .= ", mode";
225 else { # user defined args
226 for my $href (@{ $n{"args"} }) {
227 $href->{"type"} .= " " if ($href->{"type"} !~ / [*]?$/); # put a space between name and type if there is none at the end
228 $complete_args .= ", ".$href->{"type"}.$href->{"name"};
229 $arg_names .= ", ".$href->{"name"};
233 # we have additional attribute arguements
234 if (exists($n{"attr"})) {
235 $complete_args .= ", ".$n{"attr"};
238 # $complete_args = substr($complete_args, 2);
239 $temp .= "$complete_args)";
240 push(@obst_constructor, $temp." {\n");
241 push(@obst_header, $n{"comment"});
242 push(@obst_header, $temp.";\n");
244 # emit constructor code
245 if (!exists($n{"rd_constructor"}) || $n{"rd_constructor"} =~ /^DEFAULT$/i) { # default constructor
246 if ($arity !~ /^\d+$/) {
247 print "DEFAULT rd_constructor requires numeric arity! Ignoring op $orig_op!\n";
251 $temp = "\tir_node *res;\n";
252 $temp .= "\tir_node *in[$arity];\n" if ($arity > 0);
253 $temp .= "\tint flags = 0;\n";
254 $temp .= "\t${attr_type} *attr;\n" if (exists($n{"init_attr"}));
256 my $exec_units = "NULL";
257 # set up static variables for cpu execution unit assigments
258 if (exists($n{"units"})) {
259 $temp .= gen_execunit_list_initializer($n{"units"});
260 $exec_units = "_exec_units";
263 undef my $in_req_var;
264 undef my $out_req_var;
266 # set up static variables for requirements and registers
267 if (exists($n{"reg_req"})) {
268 my %req = %{ $n{"reg_req"} };
272 @in = @{ $req{"in"} } if (exists($req{"in"}));
274 @out = @{ $req{"out"} } if exists(($req{"out"}));
277 $in_req_var = "_in_req_$op";
278 $temp .= "\tstatic const arch_register_req_t *".$in_req_var."[] =\n";
280 for ($idx = 0; $idx <= $#in; $idx++) {
281 $temp .= "\t\t&".$op."_reg_req_in_".$idx.",\n";
287 $out_req_var = "_out_req_$op";
289 $temp .= "\tstatic const arch_register_req_t *".$out_req_var."[] =\n";
291 for ($idx = 0; $idx <= $#out; $idx++) {
292 $temp .= "\t\t&".$op."_reg_req_out_".$idx.",\n";
299 $temp .= "\tassert(op_$op != NULL);\n\n";
301 for (my $i = 1; $i <= $arity; $i++) {
302 $temp .= "\tin[".($i - 1)."] = op".$i.";\n";
306 if (exists($n{"irn_flags"})) {
307 foreach my $flag (split(/\|/, $n{"irn_flags"})) {
309 $temp .= "\tflags |= arch_irn_flags_rematerializable; /* op can be easily recalculated */\n";
311 elsif ($flag eq "N") {
312 $temp .= "\tflags |= arch_irn_flags_dont_spill; /* op is NOT spillable */\n";
314 elsif ($flag eq "I") {
315 $temp .= "\tflags |= arch_irn_flags_ignore; /* ignore op for register allocation */\n";
317 elsif ($flag eq "S") {
318 $temp .= "\tflags |= arch_irn_flags_modify_sp; /* op modifies stack pointer */\n";
325 # allocate memory and set pointer to register requirements
326 if (exists($n{"reg_req"})) {
327 my %req = %{ $n{"reg_req"} };
330 @in = @{ $req{"in"} } if (exists($req{"in"}));
332 @out = @{ $req{"out"} } if exists(($req{"out"}));
335 $in_param = $in_req_var;
343 $out_param = "$out_req_var, $exec_units, $n_res";
346 $out_param = "NULL, $exec_units, 0";
351 $out_param = "NULL, $exec_units, 0";
353 $temp .= "\n\t/* create node */\n";
356 if (exists($n{"latency"})) {
357 $latency = $n{"latency"};
361 if (defined($known_mode)) {
364 $temp .= "\tres = new_ir_node(db, irg, block, op_$op, $mode, $arity, ".($arity > 0 ? "in" : "NULL").");\n";
366 $temp .= "\n\t/* init node attributes */\n";
367 $temp .= "\tinit_$arch\_attributes(res, flags, $in_param, $out_param, $latency);\n";
370 if ($#out_flags >= 0) {
371 $temp .= "\n\t/* set flags for outs */\n";
372 for (my $idx = 0; $idx <= $#out_flags; $idx++) {
376 foreach my $flag (split(/\|/, $out_flags[$idx])) {
378 $flags .= $prefix."arch_irn_flags_ignore";
381 elsif ($flag eq "S") {
382 $flags .= $prefix."arch_irn_flags_modify_sp";
387 $temp .= "\tset_$arch\_out_flags(res, $flags, $idx);\n";
392 if (exists($n{"init_attr"})) {
393 $temp .= "\tattr = get_$arch\_attr(res);\n";
394 $temp .= $n{"init_attr"}."\n";
397 $temp .= "\n\t/* optimize node */\n";
398 $temp .= "\tres = optimize_node(res);\n";
399 $temp .= "\tirn_vrfy_irg(res, irg);\n\n";
401 $temp .= "\n\treturn res;\n";
403 push(@obst_constructor, $temp);
405 else { # user defined constructor
406 push(@obst_constructor, $n{"rd_constructor"});
409 # close constructor function
410 push(@obst_constructor, "}\n\n");
411 } # constructor creation
413 # set default values for state and flags if not given
414 $n{"state"} = "floats" if (! exists($n{"state"}));
415 $n{"op_flags"} = "N" if (! exists($n{"op_flags"}));
418 push(@obst_new_irop, "\n\tmemset(&ops, 0, sizeof(ops));\n");
419 push(@obst_new_irop, "\tops.dump_node = $arch\_dump_node;\n");
421 if (defined($cmp_attr_func)) {
422 push(@obst_new_irop, "\tops.node_cmp_attr = ${cmp_attr_func};\n");
426 $temp = "\top_$op = new_ir_op(cur_opcode + iro_$op, \"$op\", op_pin_state_".$n{"state"}.", ".$n{"op_flags"};
427 $temp .= "|M, ".translate_arity($arity).", 0, sizeof(${attr_type}) + $n_res * sizeof(arch_register_t *), &ops);\n";
428 push(@obst_new_irop, $temp);
429 push(@obst_new_irop, "\tset_op_tag(op_$op, &$arch\_op_tag);\n");
430 push(@obst_enum_op, "\tiro_$op,\n");
432 push(@obst_header, "\n");
434 push(@obst_enum_op, "\tiro_$arch\_last_generated,\n");
435 push(@obst_enum_op, "\tiro_$arch\_last = iro_$arch\_last_generated");
436 push(@obst_enum_op, " + $additional_opcodes") if (defined($additional_opcodes));
437 push(@obst_enum_op, "\n} $arch\_opcodes;\n\n");
441 open(OUT, ">$target_c") || die("Could not open $target_c, reason: $!\n");
443 print OUT "#include \"gen_$arch\_regalloc_if_t.h\"\n\n";
444 print OUT @obst_cmp_attr;
446 print OUT @obst_opvar;
448 print OUT @obst_get_opvar;
453 static int $arch\_opcode_start = -1;
454 static int $arch\_opcode_end = -1;
458 # build the FOURCC arguments from $arch
460 my ($a, $b, $c, $d) = ('\0', '\0', '\0', '\0');
462 if (length($arch) >= 1) {
463 $a = uc(substr($arch, 0, 1));
466 if (length($arch) >= 2) {
467 $b = uc(substr($arch, 1, 1));
470 if (length($arch) >= 3) {
471 $c = uc(substr($arch, 2, 1));
474 if (length($arch) >= 4) {
475 $d = uc(substr($arch, 3, 1));
478 print OUT<<ENDOFISIRN;
480 /** A tag for the $arch opcodes. Note that the address is used as a tag value, NOT the FOURCC code. */
481 static unsigned $arch\_op_tag = FOURCC('$a', '$b', '$c', '$d');
483 /** Return the opcode number of the first $arch opcode. */
484 int get_$arch\_opcode_first(void) {
485 return $arch\_opcode_start;
488 /** Return the opcode number of the last $arch opcode + 1. */
489 int get_$arch\_opcode_last(void) {
490 return $arch\_opcode_end;
493 /** Return 1 if the given opcode is a $arch machine op, 0 otherwise */
494 int is_$arch\_op(const ir_op *op) {
495 return get_op_tag(op) == &$arch\_op_tag;
498 /** Return 1 if the given node is a $arch machine node, 0 otherwise */
499 int is_$arch\_irn(const ir_node *node) {
500 return is_$arch\_op(get_irn_op(node));
503 int get_$arch\_irn_opcode(const ir_node *node) {
504 if (is_$arch\_irn(node))
505 return get_irn_opcode(node) - $arch\_opcode_start;
511 print OUT @obst_constructor;
513 print OUT<<ENDOFMAIN;
515 * Creates the $arch specific Firm machine operations
516 * needed for the assembler irgs.
518 void $arch\_create_opcodes(void) {
519 #define N irop_flag_none
520 #define L irop_flag_labeled
521 #define C irop_flag_commutative
522 #define X irop_flag_cfopcode
523 #define I irop_flag_ip_cfopcode
524 #define F irop_flag_fragile
525 #define Y irop_flag_forking
526 #define H irop_flag_highlevel
527 #define c irop_flag_constlike
528 #define K irop_flag_keep
529 #define M irop_flag_machine
530 #define O irop_flag_machine_op
531 #define R (irop_flag_user << 0)
535 static int run_once = 0;
541 cur_opcode = get_next_ir_opcodes(iro_$arch\_last);
543 $arch\_opcode_start = cur_opcode;
546 print OUT @obst_new_irop;
548 print OUT "\t$arch\_register_additional_opcodes(cur_opcode);\n" if (defined($additional_opcodes));
549 print OUT "\t$arch\_opcode_end = cur_opcode + iro_$arch\_last";
550 print OUT " + $additional_opcodes" if (defined($additional_opcodes));
556 open(OUT, ">$target_h") || die("Could not open $target_h, reason: $!\n");
558 my $creation_time = localtime(time());
564 * \@brief Function prototypes for the new opcode functions.
565 * \@note DO NOT EDIT THIS FILE, your changes will be lost.
566 * Edit $specfile instead.
567 * created by: $0 $specfile $target_dir
568 * \@date $creation_time
570 #ifndef FIRM_BE_${tmp}_GEN_${tmp}_NEW_NODES_H
571 #define FIRM_BE_${tmp}_GEN_${tmp}_NEW_NODES_H
575 print OUT @obst_enum_op;
576 print OUT "int is_$arch\_irn(const ir_node *node);\n\n";
577 print OUT "int get_$arch\_opcode_first(void);\n";
578 print OUT "int get_$arch\_opcode_last(void);\n";
579 print OUT "int get_$arch\_irn_opcode(const ir_node *node);\n";
580 print OUT @obst_header;
581 print OUT @obst_proj;
590 # Translates numeric arity into string constant.
592 sub translate_arity {
595 if ($arity =~ /^\d+$/) {
597 return "oparity_zero";
599 elsif ($arity == 1) {
600 return "oparity_unary";
602 elsif ($arity == 2) {
603 return "oparity_binary";
605 elsif ($arity == 3) {
606 return "oparity_trinary";
609 return "oparity_any";
613 return "oparity_".$arity;
618 # Return the list of pointers for the given execution units.
620 sub gen_execunit_list_initializer {
622 my $uc_arch = uc($arch);
627 foreach my $unit (@{ $units }) {
628 if ($unit eq "DUMMY") {
629 push(@{ $init{"DUMMY"} }, "\t\t&be_machine_execution_units_DUMMY[0]");
631 elsif (exists($cpu{"$unit"})) {
632 # operation can be executed on all units of this type
634 my $tp_name = "$arch\_execution_units_$unit";
636 foreach (@{ $cpu{"$unit"} }) {
637 next if ($idx++ == 0); # skip first element (it's not a unit)
638 my $unit_name = "$uc_arch\_EXECUNIT_TP_$unit\_$_";
639 push(@{ $init{"$unit"} }, "\t\t&".$tp_name."[".$unit_name."]");
643 # operation can be executed only a certain unit
644 # -> find corresponding unit type
646 TP_SEARCH: foreach my $cur_type (keys(%cpu)) {
647 foreach my $cur_unit (@{ $cpu{"$cur_type"} }) {
648 if ($unit eq $cur_unit) {
649 my $tp_name = "$arch\_execution_units_$cur_type";
650 my $unit_name = "$uc_arch\_EXECUNIT_TP_$cur_type\_$unit";
651 push(@{ $init{"$unit"} }, "\t\t&".$tp_name."[".$unit_name."]");
659 print STDERR "Invalid execution unit $unit specified!\n";
664 # prepare the 2-dim array init
665 foreach my $key (keys(%init)) {
666 $ret .= "\tstatic const be_execution_unit_t *_allowed_units_".$key."[] =\n";
668 foreach (@{ $init{"$key"} }) {
671 $ret .= "\t\tNULL\n";
673 $ret2 .= "\t\t_allowed_units_$key,\n";
675 $ret2 .= "\t\tNULL\n";
677 $ret .= "\tstatic const be_execution_unit_t **_exec_units[] =\n";