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
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, $n{"cmp_attr"});
106 push(@obst_cmp_attr, "}\n\n");
111 if (exists($n{"rd_constructor"}) && $n{"rd_constructor"} =~ /^NONE$/i) {
112 # we explicitly skip the constructor if the specification entry says NONE
115 $n{"comment"} = "construct $op" if(!exists($n{"comment"}));
116 $n{"comment"} =~ s/^"|"$//g; # remove "
117 $n{"comment"} = "/* ".$n{"comment"}." */\n";
118 push(@obst_constructor, $n{"comment"});
120 # create constructor head
121 my $complete_args = "";
125 $temp = "ir_node *new_rd_$op(dbg_info *db, ir_graph *irg, ir_node *block";
126 if (!exists($n{"args"}) || $n{"args"} =~ /^DEFAULT$/i) { # default args
127 if ($arity !~ /^\d+$/) {
128 print "DEFAULT args require numeric arity (0, 1, 2, ...)! Ignoring op $orig_op!\n";
131 for (my $i = 1; $i <= $arity; $i++) {
132 $complete_args .= ", ir_node *op".$i;
133 $arg_names .= ", op".$i;
136 $complete_args .= ", ir_mode *mode";
137 $arg_names .= ", mode";
140 else { # user defined args
141 for my $href (@{ $n{"args"} }) {
142 $href->{"type"} .= " " if ($href->{"type"} !~ / [*]?$/); # put a space between name and type if there is none at the end
143 $complete_args .= ", ".$href->{"type"}.$href->{"name"};
144 $arg_names .= ", ".$href->{"name"};
148 # we have additional attribute arguements
149 if (exists($n{"attr"})) {
150 $complete_args .= ", ".$n{"attr"};
153 # $complete_args = substr($complete_args, 2);
154 $temp .= "$complete_args)";
155 push(@obst_constructor, $temp." {\n");
156 push(@obst_header, $n{"comment"});
157 push(@obst_header, $temp.";\n");
159 # emit constructor code
160 if (!exists($n{"rd_constructor"}) || $n{"rd_constructor"} =~ /^DEFAULT$/i) { # default constructor
161 if ($arity !~ /^\d+$/) {
162 print "DEFAULT rd_constructor requires numeric arity! Ignoring op $orig_op!\n";
166 $temp = " ir_node *res;\n";
167 $temp .= " ir_node *in[$arity];\n" if ($arity > 0);
168 $temp .= " int flags = 0;\n";
169 $temp .= " $arch\_attr_t *attr;\n" if (exists($n{"init_attr"}));
171 undef my $in_req_var;
172 undef my $out_req_var;
174 # set up static variables for requirements and registers
175 if (exists($n{"reg_req"})) {
176 my %req = %{ $n{"reg_req"} };
180 @in = @{ $req{"in"} } if (exists($req{"in"}));
182 @out = @{ $req{"out"} } if exists(($req{"out"}));
185 $in_req_var = "_in_req_$op";
186 $temp .= " static const $arch\_register_req_t *".$in_req_var."[] =\n {\n";
187 for ($idx = 0; $idx <= $#in; $idx++) {
188 $temp .= " ".$op."_reg_req_in_".$idx.",\n";
194 $out_req_var = "_out_req_$op";
196 $temp .= " static const $arch\_register_req_t *".$out_req_var."[] =\n {\n";
197 for ($idx = 0; $idx <= $#out; $idx++) {
198 $temp .= " ".$op."_reg_req_out_".$idx.",\n";
205 $temp .= " if (!op_$op) {\n";
206 $temp .= " assert(0);\n";
207 $temp .= " return NULL;\n";
209 for (my $i = 1; $i <= $arity; $i++) {
210 $temp .= " in[".($i - 1)."] = op".$i.";\n";
214 if (exists($n{"irn_flags"})) {
215 foreach my $flag (split(/\|/, $n{"irn_flags"})) {
217 $temp .= " flags |= arch_irn_flags_rematerializable; /* op can be easily recalculated */\n";
219 elsif ($flag eq "N") {
220 $temp .= " flags |= arch_irn_flags_dont_spill; /* op is NOT spillable */\n";
222 elsif ($flag eq "I") {
223 $temp .= " flags |= arch_irn_flags_ignore; /* ignore op for register allocation */\n";
230 # allocate memory and set pointer to register requirements
231 if (exists($n{"reg_req"})) {
232 my %req = %{ $n{"reg_req"} };
235 @in = @{ $req{"in"} } if (exists($req{"in"}));
237 @out = @{ $req{"out"} } if exists(($req{"out"}));
240 $in_param = $in_req_var;
247 $out_param = $out_req_var.", ".($#out + 1);
251 $out_param = "NULL, 0";
254 $temp .= "\n /* create node */\n";
259 $temp .= " res = new_ir_node(db, irg, block, op_$op, $mode, $arity, ".($arity > 0 ? "in" : "NULL").");\n";
261 $temp .= "\n /* init node attributes */\n";
262 $temp .= " init_$arch\_attributes(res, flags, $in_param, $out_param);\n";
264 if (exists($n{"init_attr"})) {
265 $temp .= " attr = get_$arch\_attr(res);\n";
266 $temp .= $n{"init_attr"}."\n";
269 $temp .= "\n /* optimize node */\n";
270 $temp .= " res = optimize_node(res);\n";
271 $temp .= " irn_vrfy_irg(res, irg);\n\n";
273 $temp .= "\n return res;\n";
275 push(@obst_constructor, $temp);
277 else { # user defined constructor
278 push(@obst_constructor, $n{"rd_constructor"});
281 # close constructor function
282 push(@obst_constructor, "}\n\n");
283 } # constructor creation
285 # set default values for state and flags if not given
286 $n{"state"} = "floats" if (! exists($n{"state"}));
287 $n{"op_flags"} = "N" if (! exists($n{"op_flags"}));
290 push(@obst_new_irop, "\n memset(&ops, 0, sizeof(ops));\n");
291 push(@obst_new_irop, " ops.dump_node = $arch\_dump_node;\n");
293 if ($cmp_attr_func) {
294 push(@obst_new_irop, " ops.node_cmp_attr = cmp_attr_$op;\n");
298 $temp = " op_$op = new_ir_op(cur_opcode + iro_$op, \"$op\", op_pin_state_".$n{"state"}.", ".$n{"op_flags"};
299 $temp .= "|M, ".translate_arity($arity).", 0, sizeof($arch\_attr_t) + $n_res * sizeof(arch_register_t *), &ops);\n";
300 push(@obst_new_irop, $temp);
301 push(@obst_enum_op, " iro_$op,\n");
303 push(@obst_header, "\n");
305 push(@obst_enum_op, " iro_$arch\_last_generated,\n");
306 push(@obst_enum_op, " iro_$arch\_last = iro_$arch\_last_generated");
307 push(@obst_enum_op, " + $additional_opcodes") if (defined($additional_opcodes));
308 push(@obst_enum_op, "\n} $arch\_opcodes;\n\n");
312 open(OUT, ">$target_c") || die("Could not open $target_c, reason: $!\n");
314 print OUT "#include \"gen_$arch\_regalloc_if_t.h\"\n\n";
315 print OUT @obst_cmp_attr;
317 print OUT @obst_opvar;
319 print OUT @obst_get_opvar;
322 print OUT<<ENDOFISIRN;
324 static int $arch\_opcode_start = -1;
325 static int $arch\_opcode_end = -1;
327 /** Return the opcode number of the first $arch opcode. */
328 int get_$arch\_opcode_first(void) {
329 return $arch\_opcode_start;
332 /** Return the opcode number of the last $arch opcode + 1. */
333 int get_$arch\_opcode_last(void) {
334 return $arch\_opcode_end;
337 /** Return non-zero if the given node is a $arch machine node. */
338 int is_$arch\_irn(const ir_node *node) {
339 unsigned opc = (unsigned)get_irn_opcode(node);
341 assert($arch\_opcode_start > 0 && "missing opcode init");
342 assert($arch\_opcode_end > 0 && "missing opcode init");
344 if (opc - (unsigned)$arch\_opcode_start < (unsigned)($arch\_opcode_end - $arch\_opcode_start))
350 int get_$arch\_irn_opcode(const ir_node *node) {
351 if (is_$arch\_irn(node))
352 return get_irn_opcode(node) - $arch\_opcode_start;
358 print OUT @obst_constructor;
360 print OUT<<ENDOFMAIN;
362 * Creates the $arch specific Firm machine operations
363 * needed for the assembler irgs.
365 void $arch\_create_opcodes(void) {
366 #define N irop_flag_none
367 #define L irop_flag_labeled
368 #define C irop_flag_commutative
369 #define X irop_flag_cfopcode
370 #define I irop_flag_ip_cfopcode
371 #define F irop_flag_fragile
372 #define Y irop_flag_forking
373 #define H irop_flag_highlevel
374 #define c irop_flag_constlike
375 #define K irop_flag_keep
376 #define M irop_flag_machine
377 #define O irop_flag_machine_op
378 #define R (irop_flag_user << 0)
381 int cur_opcode = get_next_ir_opcodes(iro_$arch\_last);
383 $arch\_opcode_start = cur_opcode;
386 print OUT @obst_new_irop;
388 print OUT " $arch\_register_additional_opcodes(cur_opcode);\n" if (defined($additional_opcodes));
389 print OUT " $arch\_opcode_end = cur_opcode + iro_$arch\_last";
390 print OUT " + $additional_opcodes" if (defined($additional_opcodes));
396 open(OUT, ">$target_h") || die("Could not open $target_h, reason: $!\n");
398 print OUT "#ifndef __GEN_$arch\_NEW_NODES_H__\n";
399 print OUT "#define __GEN_$arch\_NEW_NODES_H__\n\n";
400 print OUT @obst_enum_op;
401 print OUT "int is_$arch\_irn(const ir_node *node);\n\n";
402 print OUT "int get_$arch\_opcode_first(void);\n";
403 print OUT "int get_$arch\_opcode_last(void);\n";
404 print OUT "int get_$arch\_irn_opcode(const ir_node *node);\n";
405 print OUT @obst_header;
406 print OUT @obst_proj;
407 print OUT "\n#endif /* __GEN_$arch\_NEW_NODES_H__ */\n";
412 # Translates numeric arity into string constant.
414 sub translate_arity {
417 if ($arity =~ /^\d+$/) {
419 return "oparity_zero";
421 elsif ($arity == 1) {
422 return "oparity_unary";
424 elsif ($arity == 2) {
425 return "oparity_binary";
427 elsif ($arity == 3) {
428 return "oparity_trinary";
435 return "oparity_".$arity;