3 # This script generates the C code which creates the irop's and
4 # their coresponding node constructors for all operations in a given spec
5 # so they can be used as normal firm nodes.
12 my $specfile = $ARGV[0];
13 my $target_dir = $ARGV[1];
19 our $additional_opcodes;
27 unless ($return = do $specfile) {
28 warn "couldn't parse $specfile: $@" if $@;
29 warn "couldn't do $specfile: $!" unless defined $return;
30 warn "couldn't run $specfile" unless $return;
34 my $target_c = $target_dir."/gen_".$arch."_new_nodes.c.inl";
35 my $target_h = $target_dir."/gen_".$arch."_new_nodes.h";
37 #print Dumper(%nodes);
38 #print Dumper(%operands);
40 # create c code file from specs
42 my @obst_opvar; # stack for the "ir_op *op_<arch>_<op-name> = NULL;" statements
43 my @obst_get_opvar; # stack for the get_op_<arch>_<op-name>() functions
44 my @obst_constructor; # stack for node constructor functions
45 my @obst_new_irop; # stack for the new_ir_op calls
46 my @obst_enum_op; # stack for creating the <arch>_opcode enum
47 my @obst_header; # stack for function prototypes
48 my @obst_is_archirn; # stack for the is_$arch_irn() function
49 my @obst_cmp_attr; # stack for the compare attribute functions
50 my @obst_proj; # stack for the pn_ numbers
55 my $n_opcodes = 0; # number of opcodes
57 # for registering additional opcodes
58 $n_opcodes += $additional_opcodes if (defined($additional_opcodes));
60 push(@obst_header, "void ".$arch."_create_opcodes(void);\n");
62 push(@obst_enum_op, "typedef enum _$arch\_opcodes {\n");
63 foreach my $op (keys(%nodes)) {
64 my %n = %{ $nodes{"$op"} };
68 # determine arity from in requirements
69 $arity = exists($n{"arity"}) ? $n{"arity"} : 0;
70 if (exists($n{"reg_req"}) && exists($n{"reg_req"}{"in"})) {
71 $arity = scalar(@{ $n{"reg_req"}{"in"} });
78 if (exists($n{"outs"})) {
80 @outs = @{ $n{"outs"} };
81 push(@obst_proj, "\nenum pn_$op {\n");
82 for (my $idx = 0; $idx <= $#outs; $idx++) {
83 push(@obst_proj, " pn_$op\_".$outs[$idx]." = $idx,\n");
85 push(@obst_proj, "};\n");
89 push(@obst_opvar, "ir_op *op_$op = NULL;\n");
90 push(@obst_get_opvar, "ir_op *get_op_$op(void) { return op_$op; }\n");
91 push(@obst_get_opvar, "int is_$op(const ir_node *n) { return get_$arch\_irn_opcode(n) == iro_$op; }\n\n");
93 push(@obst_is_archirn, "is_$op(node)");
95 push(@obst_header, "extern ir_op *op_$op;\n");
96 push(@obst_header, "ir_op *get_op_$op(void);\n");
97 push(@obst_header, "int is_$op(const ir_node *n);\n");
100 # create compare attribute function if needed
101 if (exists($n{"cmp_attr"})) {
102 push(@obst_cmp_attr, "static int cmp_attr_$op(ir_node *a, ir_node *b) {\n");
103 push(@obst_cmp_attr, " $arch\_attr_t *attr_a = get_$arch\_attr(a);\n");
104 push(@obst_cmp_attr, " $arch\_attr_t *attr_b = get_$arch\_attr(b);\n");
105 push(@obst_cmp_attr, " (void) attr_a;\n");
106 push(@obst_cmp_attr, " (void) attr_b;\n");
107 push(@obst_cmp_attr, $n{"cmp_attr"});
108 push(@obst_cmp_attr, "}\n\n");
113 if (exists($n{"rd_constructor"}) && $n{"rd_constructor"} =~ /^NONE$/i) {
114 # we explicitly skip the constructor if the specification entry says NONE
117 $n{"comment"} = "construct $op" if(!exists($n{"comment"}));
118 $n{"comment"} =~ s/^"|"$//g; # remove "
119 $n{"comment"} = "/* ".$n{"comment"}." */\n";
120 push(@obst_constructor, $n{"comment"});
122 # create constructor head
123 my $complete_args = "";
127 $temp = "ir_node *new_rd_$op(dbg_info *db, ir_graph *irg, ir_node *block";
128 if (!exists($n{"args"}) || $n{"args"} =~ /^DEFAULT$/i) { # default args
129 if ($arity !~ /^\d+$/) {
130 print "DEFAULT args require numeric arity (0, 1, 2, ...)! Ignoring op $orig_op!\n";
133 for (my $i = 1; $i <= $arity; $i++) {
134 $complete_args .= ", ir_node *op".$i;
135 $arg_names .= ", op".$i;
138 $complete_args .= ", ir_mode *mode";
139 $arg_names .= ", mode";
142 else { # user defined args
143 for my $href (@{ $n{"args"} }) {
144 $href->{"type"} .= " " if ($href->{"type"} !~ / [*]?$/); # put a space between name and type if there is none at the end
145 $complete_args .= ", ".$href->{"type"}.$href->{"name"};
146 $arg_names .= ", ".$href->{"name"};
150 # we have additional attribute arguements
151 if (exists($n{"attr"})) {
152 $complete_args .= ", ".$n{"attr"};
155 # $complete_args = substr($complete_args, 2);
156 $temp .= "$complete_args)";
157 push(@obst_constructor, $temp." {\n");
158 push(@obst_header, $n{"comment"});
159 push(@obst_header, $temp.";\n");
161 # emit constructor code
162 if (!exists($n{"rd_constructor"}) || $n{"rd_constructor"} =~ /^DEFAULT$/i) { # default constructor
163 if ($arity !~ /^\d+$/) {
164 print "DEFAULT rd_constructor requires numeric arity! Ignoring op $orig_op!\n";
168 $temp = " ir_node *res;\n";
169 $temp .= " ir_node *in[$arity];\n" if ($arity > 0);
170 $temp .= " int flags = 0;\n";
171 $temp .= " $arch\_attr_t *attr;\n" if (exists($n{"init_attr"}));
173 undef my $in_req_var;
174 undef my $out_req_var;
176 # set up static variables for requirements and registers
177 if (exists($n{"reg_req"})) {
178 my %req = %{ $n{"reg_req"} };
182 @in = @{ $req{"in"} } if (exists($req{"in"}));
184 @out = @{ $req{"out"} } if exists(($req{"out"}));
187 $in_req_var = "_in_req_$op";
188 $temp .= " static const $arch\_register_req_t *".$in_req_var."[] =\n {\n";
189 for ($idx = 0; $idx <= $#in; $idx++) {
190 $temp .= " ".$op."_reg_req_in_".$idx.",\n";
196 $out_req_var = "_out_req_$op";
198 $temp .= " static const $arch\_register_req_t *".$out_req_var."[] =\n {\n";
199 for ($idx = 0; $idx <= $#out; $idx++) {
200 $temp .= " ".$op."_reg_req_out_".$idx.",\n";
207 $temp .= " if (!op_$op) {\n";
208 $temp .= " assert(0);\n";
209 $temp .= " return NULL;\n";
211 for (my $i = 1; $i <= $arity; $i++) {
212 $temp .= " in[".($i - 1)."] = op".$i.";\n";
216 if (exists($n{"irn_flags"})) {
217 foreach my $flag (split(/\|/, $n{"irn_flags"})) {
219 $temp .= " flags |= arch_irn_flags_rematerializable; /* op can be easily recalculated */\n";
221 elsif ($flag eq "N") {
222 $temp .= " flags |= arch_irn_flags_dont_spill; /* op is NOT spillable */\n";
224 elsif ($flag eq "I") {
225 $temp .= " flags |= arch_irn_flags_ignore; /* ignore op for register allocation */\n";
227 elsif ($flag eq "S") {
228 $temp .= " flags |= arch_irn_flags_modify_sp; /* op modifies stack pointer */\n";
235 # allocate memory and set pointer to register requirements
236 if (exists($n{"reg_req"})) {
237 my %req = %{ $n{"reg_req"} };
240 @in = @{ $req{"in"} } if (exists($req{"in"}));
242 @out = @{ $req{"out"} } if exists(($req{"out"}));
245 $in_param = $in_req_var;
252 $out_param = $out_req_var.", ".($#out + 1);
256 $out_param = "NULL, 0";
261 $out_param = "NULL, 0";
263 $temp .= "\n /* create node */\n";
266 if (exists($n{"latency"})) {
267 $latency = $n{"latency"};
274 $temp .= " res = new_ir_node(db, irg, block, op_$op, $mode, $arity, ".($arity > 0 ? "in" : "NULL").");\n";
276 $temp .= "\n /* init node attributes */\n";
277 $temp .= " init_$arch\_attributes(res, flags, $in_param, $out_param, $latency);\n";
279 if (exists($n{"init_attr"})) {
280 $temp .= " attr = get_$arch\_attr(res);\n";
281 $temp .= $n{"init_attr"}."\n";
284 $temp .= "\n /* optimize node */\n";
285 $temp .= " res = optimize_node(res);\n";
286 $temp .= " irn_vrfy_irg(res, irg);\n\n";
288 $temp .= "\n return res;\n";
290 push(@obst_constructor, $temp);
292 else { # user defined constructor
293 push(@obst_constructor, $n{"rd_constructor"});
296 # close constructor function
297 push(@obst_constructor, "}\n\n");
298 } # constructor creation
300 # set default values for state and flags if not given
301 $n{"state"} = "floats" if (! exists($n{"state"}));
302 $n{"op_flags"} = "N" if (! exists($n{"op_flags"}));
305 push(@obst_new_irop, "\n memset(&ops, 0, sizeof(ops));\n");
306 push(@obst_new_irop, " ops.dump_node = $arch\_dump_node;\n");
308 if ($cmp_attr_func) {
309 push(@obst_new_irop, " ops.node_cmp_attr = cmp_attr_$op;\n");
313 $temp = " op_$op = new_ir_op(cur_opcode + iro_$op, \"$op\", op_pin_state_".$n{"state"}.", ".$n{"op_flags"};
314 $temp .= "|M, ".translate_arity($arity).", 0, sizeof($arch\_attr_t) + $n_res * sizeof(arch_register_t *), &ops);\n";
315 push(@obst_new_irop, $temp);
316 push(@obst_new_irop, " set_op_tag(op_$op, &$arch\_op_tag);\n");
317 push(@obst_enum_op, " iro_$op,\n");
319 push(@obst_header, "\n");
321 push(@obst_enum_op, " iro_$arch\_last_generated,\n");
322 push(@obst_enum_op, " iro_$arch\_last = iro_$arch\_last_generated");
323 push(@obst_enum_op, " + $additional_opcodes") if (defined($additional_opcodes));
324 push(@obst_enum_op, "\n} $arch\_opcodes;\n\n");
328 open(OUT, ">$target_c") || die("Could not open $target_c, reason: $!\n");
330 print OUT "#include \"gen_$arch\_regalloc_if_t.h\"\n\n";
331 print OUT @obst_cmp_attr;
333 print OUT @obst_opvar;
335 print OUT @obst_get_opvar;
340 static int $arch\_opcode_start = -1;
341 static int $arch\_opcode_end = -1;
345 # build the FOURCC arguments from $arch
347 my ($a, $b, $c, $d) = ('\0', '\0', '\0', '\0');
349 if (length($arch) >= 1) {
350 $a = uc(substr($arch, 0, 1));
353 if (length($arch) >= 2) {
354 $b = uc(substr($arch, 1, 1));
357 if (length($arch) >= 3) {
358 $c = uc(substr($arch, 2, 1));
361 if (length($arch) >= 4) {
362 $d = uc(substr($arch, 3, 1));
365 print OUT "static unsigned $arch\_op_tag = FOURCC('$a', '$b', '$c', '$d');\n";
367 print OUT<<ENDOFISIRN;
369 /** Return the opcode number of the first $arch opcode. */
370 int get_$arch\_opcode_first(void) {
371 return $arch\_opcode_start;
374 /** Return the opcode number of the last $arch opcode + 1. */
375 int get_$arch\_opcode_last(void) {
376 return $arch\_opcode_end;
379 /** Return 1 if the given node is a $arch machine node, 0 otherwise */
380 int is_$arch\_irn(const ir_node *node) {
381 return get_op_tag(get_irn_op(node)) == &$arch\_op_tag;
384 int get_$arch\_irn_opcode(const ir_node *node) {
385 if (is_$arch\_irn(node))
386 return get_irn_opcode(node) - $arch\_opcode_start;
392 print OUT @obst_constructor;
394 print OUT<<ENDOFMAIN;
396 * Creates the $arch specific Firm machine operations
397 * needed for the assembler irgs.
399 void $arch\_create_opcodes(void) {
400 #define N irop_flag_none
401 #define L irop_flag_labeled
402 #define C irop_flag_commutative
403 #define X irop_flag_cfopcode
404 #define I irop_flag_ip_cfopcode
405 #define F irop_flag_fragile
406 #define Y irop_flag_forking
407 #define H irop_flag_highlevel
408 #define c irop_flag_constlike
409 #define K irop_flag_keep
410 #define M irop_flag_machine
411 #define O irop_flag_machine_op
412 #define R (irop_flag_user << 0)
415 int cur_opcode = get_next_ir_opcodes(iro_$arch\_last);
417 $arch\_opcode_start = cur_opcode;
420 print OUT @obst_new_irop;
422 print OUT " $arch\_register_additional_opcodes(cur_opcode);\n" if (defined($additional_opcodes));
423 print OUT " $arch\_opcode_end = cur_opcode + iro_$arch\_last";
424 print OUT " + $additional_opcodes" if (defined($additional_opcodes));
430 open(OUT, ">$target_h") || die("Could not open $target_h, reason: $!\n");
432 print OUT "#ifndef __GEN_$arch\_NEW_NODES_H__\n";
433 print OUT "#define __GEN_$arch\_NEW_NODES_H__\n\n";
434 print OUT @obst_enum_op;
435 print OUT "int is_$arch\_irn(const ir_node *node);\n\n";
436 print OUT "int get_$arch\_opcode_first(void);\n";
437 print OUT "int get_$arch\_opcode_last(void);\n";
438 print OUT "int get_$arch\_irn_opcode(const ir_node *node);\n";
439 print OUT @obst_header;
440 print OUT @obst_proj;
441 print OUT "\n#endif /* __GEN_$arch\_NEW_NODES_H__ */\n";
446 # Translates numeric arity into string constant.
448 sub translate_arity {
451 if ($arity =~ /^\d+$/) {
453 return "oparity_zero";
455 elsif ($arity == 1) {
456 return "oparity_unary";
458 elsif ($arity == 2) {
459 return "oparity_binary";
461 elsif ($arity == 3) {
462 return "oparity_trinary";
469 return "oparity_".$arity;