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;
48 unless ($return = do $specfile) {
49 die "couldn't parse $specfile: $@" if $@;
50 die "couldn't do $specfile: $!" unless defined $return;
51 die "couldn't run $specfile" unless $return;
55 my $target_c = $target_dir."/gen_".$arch."_new_nodes.c.inl";
56 my $target_h = $target_dir."/gen_".$arch."_new_nodes.h";
58 #print Dumper(%nodes);
59 #print Dumper(%operands);
61 # create c code file from specs
63 my @obst_opvar; # stack for the "ir_op *op_<arch>_<op-name> = NULL;" statements
64 my @obst_get_opvar; # stack for the get_op_<arch>_<op-name>() functions
65 my @obst_constructor; # stack for node constructor functions
66 my @obst_new_irop; # stack for the new_ir_op calls
67 my @obst_enum_op; # stack for creating the <arch>_opcode enum
68 my @obst_header; # stack for function prototypes
69 my @obst_is_archirn; # stack for the is_$arch_irn() function
70 my @obst_cmp_attr; # stack for the compare attribute functions
71 my @obst_proj; # stack for the pn_ numbers
76 my $n_opcodes = 0; # number of opcodes
78 # for registering additional opcodes
79 $n_opcodes += $additional_opcodes if (defined($additional_opcodes));
81 push(@obst_header, "void ".$arch."_create_opcodes(void);\n");
83 # create default compare function
84 if(defined($default_cmp_attr)) {
85 my $cmpcode = $default_cmp_attr;
86 push(@obst_cmp_attr, "static int default_cmp_attr(ir_node *a, ir_node *b) {\n");
87 if($cmpcode =~ m/attr_a/) {
88 push(@obst_cmp_attr, "\t$arch\_attr_t *attr_a = get_$arch\_attr(a);\n");
90 if($cmpcode =~ m/attr_b/) {
91 push(@obst_cmp_attr, "\t$arch\_attr_t *attr_b = get_$arch\_attr(b);\n");
93 push(@obst_cmp_attr, "\t${cmpcode}\n");
94 push(@obst_cmp_attr, "}\n\n");
97 push(@obst_enum_op, "typedef enum _$arch\_opcodes {\n");
98 foreach my $op (keys(%nodes)) {
99 my %n = %{ $nodes{"$op"} };
105 # determine arity from in requirements
106 $arity = exists($n{"arity"}) ? $n{"arity"} : 0;
107 if (exists($n{"reg_req"}) && exists($n{"reg_req"}{"in"})) {
108 $arity = scalar(@{ $n{"reg_req"}{"in"} });
115 # define some proj numbers
116 if (exists($n{"outs"})) {
119 @outs = @{ $n{"outs"} };
120 $num_outs = $#outs + 1;
122 push(@obst_proj, "\nenum pn_$op {\n");
124 for (my $idx = 0; $idx <= $#outs; $idx++) {
125 # check, if we have additional flags annotated to out
126 if ($outs[$idx] =~ /:((S|I)(\|(S|I))*)/) {
127 push(@out_flags, $1);
128 $outs[$idx] =~ s/:((S|I)(\|(S|I))*)//;
130 push(@obst_proj, "\tpn_$op\_".$outs[$idx]." = $idx,\n");
133 push(@obst_proj, "};\n");
134 # outs have names, it must be a mode_T node
135 $known_mode = "mode_T";
137 if (exists($n{"ins"})) {
140 @ins = @{ $n{"ins"} };
141 my $num_ins = $#ins + 1;
143 push(@obst_proj, "\nenum n_$op {\n");
145 for (my $idx = 0; $idx <= $#ins; $idx++) {
146 push(@obst_proj, "\tn_${op}_".$ins[$idx]." = $idx,\n");
149 push(@obst_proj, "};\n");
151 if (exists($n{"mode"})) {
152 $known_mode = $n{"mode"};
155 push(@obst_opvar, "ir_op *op_$op = NULL;\n");
156 push(@obst_get_opvar, "ir_op *get_op_$op(void) { return op_$op; }\n");
157 push(@obst_get_opvar, "int is_$op(const ir_node *n) { return get_$arch\_irn_opcode(n) == iro_$op; }\n\n");
159 push(@obst_is_archirn, "is_$op(node)");
161 push(@obst_header, "extern ir_op *op_$op;\n");
162 push(@obst_header, "ir_op *get_op_$op(void);\n");
163 push(@obst_header, "int is_$op(const ir_node *n);\n");
166 if(defined($default_cmp_attr)) {
167 $cmp_attr_func = "default_cmp_attr";
169 # create compare attribute function if needed
170 if (exists($n{"cmp_attr"})) {
171 my $cmpcode = $n{"cmp_attr"};
173 push(@obst_cmp_attr, "static int cmp_attr_$op(ir_node *a, ir_node *b) {\n");
174 if($cmpcode =~ m/attr_a/) {
175 push(@obst_cmp_attr, "\t$arch\_attr_t *attr_a = get_$arch\_attr(a);\n");
177 if($cmpcode =~ m/attr_b/) {
178 push(@obst_cmp_attr, "\t$arch\_attr_t *attr_b = get_$arch\_attr(b);\n");
180 push(@obst_cmp_attr, "\t${cmpcode}\n");
181 push(@obst_cmp_attr, "}\n\n");
183 $cmp_attr_func = "cmp_attr_${op}";
186 if (exists($n{"rd_constructor"}) && $n{"rd_constructor"} =~ /^NONE$/i) {
187 # we explicitly skip the constructor if the specification entry says NONE
190 $n{"comment"} = "construct $op" if(!exists($n{"comment"}));
191 $n{"comment"} =~ s/^"|"$//g; # remove "
192 $n{"comment"} = "/* ".$n{"comment"}." */\n";
193 push(@obst_constructor, $n{"comment"});
195 # create constructor head
196 my $complete_args = "";
200 $temp = "ir_node *new_rd_$op(dbg_info *db, ir_graph *irg, ir_node *block";
201 if (!exists($n{"args"}) || $n{"args"} =~ /^DEFAULT$/i) { # default args
202 if ($arity !~ /^\d+$/) {
203 print "DEFAULT args require numeric arity (0, 1, 2, ...)! Ignoring op $orig_op!\n";
206 for (my $i = 1; $i <= $arity; $i++) {
207 $complete_args .= ", ir_node *op".$i;
208 $arg_names .= ", op".$i;
210 if (!defined($known_mode)) {
211 $complete_args .= ", ir_mode *mode";
212 $arg_names .= ", mode";
215 else { # user defined args
216 for my $href (@{ $n{"args"} }) {
217 $href->{"type"} .= " " if ($href->{"type"} !~ / [*]?$/); # put a space between name and type if there is none at the end
218 $complete_args .= ", ".$href->{"type"}.$href->{"name"};
219 $arg_names .= ", ".$href->{"name"};
223 # we have additional attribute arguements
224 if (exists($n{"attr"})) {
225 $complete_args .= ", ".$n{"attr"};
228 # $complete_args = substr($complete_args, 2);
229 $temp .= "$complete_args)";
230 push(@obst_constructor, $temp." {\n");
231 push(@obst_header, $n{"comment"});
232 push(@obst_header, $temp.";\n");
234 # emit constructor code
235 if (!exists($n{"rd_constructor"}) || $n{"rd_constructor"} =~ /^DEFAULT$/i) { # default constructor
236 if ($arity !~ /^\d+$/) {
237 print "DEFAULT rd_constructor requires numeric arity! Ignoring op $orig_op!\n";
241 $temp = "\tir_node *res;\n";
242 $temp .= "\tir_node *in[$arity];\n" if ($arity > 0);
243 $temp .= "\tint flags = 0;\n";
244 $temp .= "\t$arch\_attr_t *attr;\n" if (exists($n{"init_attr"}));
246 my $exec_units = "NULL";
247 # set up static variables for cpu execution unit assigments
248 if (exists($n{"units"})) {
249 $temp .= gen_execunit_list_initializer($n{"units"});
250 $exec_units = "_exec_units";
253 undef my $in_req_var;
254 undef my $out_req_var;
256 # set up static variables for requirements and registers
257 if (exists($n{"reg_req"})) {
258 my %req = %{ $n{"reg_req"} };
262 @in = @{ $req{"in"} } if (exists($req{"in"}));
264 @out = @{ $req{"out"} } if exists(($req{"out"}));
267 $in_req_var = "_in_req_$op";
268 $temp .= "\tstatic const arch_register_req_t *".$in_req_var."[] =\n";
270 for ($idx = 0; $idx <= $#in; $idx++) {
271 $temp .= "\t\t&".$op."_reg_req_in_".$idx.",\n";
277 $out_req_var = "_out_req_$op";
279 $temp .= "\tstatic const arch_register_req_t *".$out_req_var."[] =\n";
281 for ($idx = 0; $idx <= $#out; $idx++) {
282 $temp .= "\t\t&".$op."_reg_req_out_".$idx.",\n";
289 $temp .= "\tassert(op_$op != NULL);\n\n";
291 for (my $i = 1; $i <= $arity; $i++) {
292 $temp .= "\tin[".($i - 1)."] = op".$i.";\n";
296 if (exists($n{"irn_flags"})) {
297 foreach my $flag (split(/\|/, $n{"irn_flags"})) {
299 $temp .= "\tflags |= arch_irn_flags_rematerializable; /* op can be easily recalculated */\n";
301 elsif ($flag eq "N") {
302 $temp .= "\tflags |= arch_irn_flags_dont_spill; /* op is NOT spillable */\n";
304 elsif ($flag eq "I") {
305 $temp .= "\tflags |= arch_irn_flags_ignore; /* ignore op for register allocation */\n";
307 elsif ($flag eq "S") {
308 $temp .= "\tflags |= arch_irn_flags_modify_sp; /* op modifies stack pointer */\n";
315 # allocate memory and set pointer to register requirements
316 if (exists($n{"reg_req"})) {
317 my %req = %{ $n{"reg_req"} };
320 @in = @{ $req{"in"} } if (exists($req{"in"}));
322 @out = @{ $req{"out"} } if exists(($req{"out"}));
325 $in_param = $in_req_var;
333 $out_param = "$out_req_var, $exec_units, $n_res";
336 $out_param = "NULL, $exec_units, 0";
341 $out_param = "NULL, $exec_units, 0";
343 $temp .= "\n\t/* create node */\n";
346 if (exists($n{"latency"})) {
347 $latency = $n{"latency"};
351 if (defined($known_mode)) {
354 $temp .= "\tres = new_ir_node(db, irg, block, op_$op, $mode, $arity, ".($arity > 0 ? "in" : "NULL").");\n";
356 $temp .= "\n\t/* init node attributes */\n";
357 $temp .= "\tinit_$arch\_attributes(res, flags, $in_param, $out_param, $latency);\n";
360 if ($#out_flags >= 0) {
361 $temp .= "\n\t/* set flags for outs */\n";
362 for (my $idx = 0; $idx <= $#out_flags; $idx++) {
366 foreach my $flag (split(/\|/, $out_flags[$idx])) {
368 $flags .= $prefix."arch_irn_flags_ignore";
371 elsif ($flag eq "S") {
372 $flags .= $prefix."arch_irn_flags_modify_sp";
377 $temp .= "\tset_$arch\_out_flags(res, $flags, $idx);\n";
382 if (exists($n{"init_attr"})) {
383 $temp .= "\tattr = get_$arch\_attr(res);\n";
384 $temp .= $n{"init_attr"}."\n";
387 $temp .= "\n\t/* optimize node */\n";
388 $temp .= "\tres = optimize_node(res);\n";
389 $temp .= "\tirn_vrfy_irg(res, irg);\n\n";
391 $temp .= "\n\treturn res;\n";
393 push(@obst_constructor, $temp);
395 else { # user defined constructor
396 push(@obst_constructor, $n{"rd_constructor"});
399 # close constructor function
400 push(@obst_constructor, "}\n\n");
401 } # constructor creation
403 # set default values for state and flags if not given
404 $n{"state"} = "floats" if (! exists($n{"state"}));
405 $n{"op_flags"} = "N" if (! exists($n{"op_flags"}));
408 push(@obst_new_irop, "\n\tmemset(&ops, 0, sizeof(ops));\n");
409 push(@obst_new_irop, "\tops.dump_node = $arch\_dump_node;\n");
411 if (defined($cmp_attr_func)) {
412 push(@obst_new_irop, "\tops.node_cmp_attr = ${cmp_attr_func};\n");
416 $temp = "\top_$op = new_ir_op(cur_opcode + iro_$op, \"$op\", op_pin_state_".$n{"state"}.", ".$n{"op_flags"};
417 $temp .= "|M, ".translate_arity($arity).", 0, sizeof($arch\_attr_t) + $n_res * sizeof(arch_register_t *), &ops);\n";
418 push(@obst_new_irop, $temp);
419 push(@obst_new_irop, "\tset_op_tag(op_$op, &$arch\_op_tag);\n");
420 push(@obst_enum_op, "\tiro_$op,\n");
422 push(@obst_header, "\n");
424 push(@obst_enum_op, "\tiro_$arch\_last_generated,\n");
425 push(@obst_enum_op, "\tiro_$arch\_last = iro_$arch\_last_generated");
426 push(@obst_enum_op, " + $additional_opcodes") if (defined($additional_opcodes));
427 push(@obst_enum_op, "\n} $arch\_opcodes;\n\n");
431 open(OUT, ">$target_c") || die("Could not open $target_c, reason: $!\n");
433 print OUT "#include \"gen_$arch\_regalloc_if_t.h\"\n\n";
434 print OUT @obst_cmp_attr;
436 print OUT @obst_opvar;
438 print OUT @obst_get_opvar;
443 static int $arch\_opcode_start = -1;
444 static int $arch\_opcode_end = -1;
448 # build the FOURCC arguments from $arch
450 my ($a, $b, $c, $d) = ('\0', '\0', '\0', '\0');
452 if (length($arch) >= 1) {
453 $a = uc(substr($arch, 0, 1));
456 if (length($arch) >= 2) {
457 $b = uc(substr($arch, 1, 1));
460 if (length($arch) >= 3) {
461 $c = uc(substr($arch, 2, 1));
464 if (length($arch) >= 4) {
465 $d = uc(substr($arch, 3, 1));
468 print OUT "static unsigned $arch\_op_tag = FOURCC('$a', '$b', '$c', '$d');\n";
470 print OUT<<ENDOFISIRN;
472 /** Return the opcode number of the first $arch opcode. */
473 int get_$arch\_opcode_first(void) {
474 return $arch\_opcode_start;
477 /** Return the opcode number of the last $arch opcode + 1. */
478 int get_$arch\_opcode_last(void) {
479 return $arch\_opcode_end;
482 /** Return 1 if the given node is a $arch machine node, 0 otherwise */
483 int is_$arch\_irn(const ir_node *node) {
484 return get_op_tag(get_irn_op(node)) == &$arch\_op_tag;
487 int get_$arch\_irn_opcode(const ir_node *node) {
488 if (is_$arch\_irn(node))
489 return get_irn_opcode(node) - $arch\_opcode_start;
495 print OUT @obst_constructor;
497 print OUT<<ENDOFMAIN;
499 * Creates the $arch specific Firm machine operations
500 * needed for the assembler irgs.
502 void $arch\_create_opcodes(void) {
503 #define N irop_flag_none
504 #define L irop_flag_labeled
505 #define C irop_flag_commutative
506 #define X irop_flag_cfopcode
507 #define I irop_flag_ip_cfopcode
508 #define F irop_flag_fragile
509 #define Y irop_flag_forking
510 #define H irop_flag_highlevel
511 #define c irop_flag_constlike
512 #define K irop_flag_keep
513 #define M irop_flag_machine
514 #define O irop_flag_machine_op
515 #define R (irop_flag_user << 0)
519 static int run_once = 0;
525 cur_opcode = get_next_ir_opcodes(iro_$arch\_last);
527 $arch\_opcode_start = cur_opcode;
530 print OUT @obst_new_irop;
532 print OUT "\t$arch\_register_additional_opcodes(cur_opcode);\n" if (defined($additional_opcodes));
533 print OUT "\t$arch\_opcode_end = cur_opcode + iro_$arch\_last";
534 print OUT " + $additional_opcodes" if (defined($additional_opcodes));
540 open(OUT, ">$target_h") || die("Could not open $target_h, reason: $!\n");
542 my $creation_time = localtime(time());
548 * \@brief Function prototypes for the new opcode functions.
549 * \@note DO NOT EDIT THIS FILE, your changes will be lost.
550 * Edit $specfile instead.
551 * created by: $0 $specfile $target_dir
552 * \@date $creation_time
554 #ifndef FIRM_BE_${tmp}_GEN_${tmp}_NEW_NODES_H
555 #define FIRM_BE_${tmp}_GEN_${tmp}_NEW_NODES_H
559 print OUT @obst_enum_op;
560 print OUT "int is_$arch\_irn(const ir_node *node);\n\n";
561 print OUT "int get_$arch\_opcode_first(void);\n";
562 print OUT "int get_$arch\_opcode_last(void);\n";
563 print OUT "int get_$arch\_irn_opcode(const ir_node *node);\n";
564 print OUT @obst_header;
565 print OUT @obst_proj;
574 # Translates numeric arity into string constant.
576 sub translate_arity {
579 if ($arity =~ /^\d+$/) {
581 return "oparity_zero";
583 elsif ($arity == 1) {
584 return "oparity_unary";
586 elsif ($arity == 2) {
587 return "oparity_binary";
589 elsif ($arity == 3) {
590 return "oparity_trinary";
593 return "oparity_any";
597 return "oparity_".$arity;
602 # Return the list of pointers for the given execution units.
604 sub gen_execunit_list_initializer {
606 my $uc_arch = uc($arch);
611 foreach my $unit (@{ $units }) {
612 if ($unit eq "DUMMY") {
613 push(@{ $init{"DUMMY"} }, "\t\t&be_machine_execution_units_DUMMY[0]");
615 elsif (exists($cpu{"$unit"})) {
616 # operation can be executed on all units of this type
618 my $tp_name = "$arch\_execution_units_$unit";
620 foreach (@{ $cpu{"$unit"} }) {
621 next if ($idx++ == 0); # skip first element (it's not a unit)
622 my $unit_name = "$uc_arch\_EXECUNIT_TP_$unit\_$_";
623 push(@{ $init{"$unit"} }, "\t\t&".$tp_name."[".$unit_name."]");
627 # operation can be executed only a certain unit
628 # -> find corresponding unit type
630 TP_SEARCH: foreach my $cur_type (keys(%cpu)) {
631 foreach my $cur_unit (@{ $cpu{"$cur_type"} }) {
632 if ($unit eq $cur_unit) {
633 my $tp_name = "$arch\_execution_units_$cur_type";
634 my $unit_name = "$uc_arch\_EXECUNIT_TP_$cur_type\_$unit";
635 push(@{ $init{"$unit"} }, "\t\t&".$tp_name."[".$unit_name."]");
643 print STDERR "Invalid execution unit $unit specified!\n";
648 # prepare the 2-dim array init
649 foreach my $key (keys(%init)) {
650 $ret .= "\tstatic const be_execution_unit_t *_allowed_units_".$key."[] =\n";
652 foreach (@{ $init{"$key"} }) {
655 $ret .= "\t\tNULL\n";
657 $ret2 .= "\t\t_allowed_units_$key,\n";
659 $ret2 .= "\t\tNULL\n";
661 $ret .= "\tstatic const be_execution_unit_t **_exec_units[] =\n";