added missing ;
[libfirm] / ir / be / scripts / generate_new_opcodes.pl
1 #!/usr/bin/perl -w
2
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.
6 # Creation: 2005/10/19
7 # $Id$
8
9 use strict;
10 use Data::Dumper;
11
12 my $specfile   = $ARGV[0];
13 my $target_dir = $ARGV[1];
14 my $state      = 1;
15 my $cur_op     = "";
16 my $line_nr    = 0;
17
18 our $arch;
19 our %nodes;
20
21 # include spec file
22
23 my $return;
24
25 no strict "subs";
26 unless ($return = do $specfile) {
27         warn "couldn't parse $specfile: $@" if $@;
28         warn "couldn't do $specfile: $!"    unless defined $return;
29         warn "couldn't run $specfile"       unless $return;
30 }
31 use strict "subs";
32
33 my $target_c = $target_dir."/gen_".$arch."_new_nodes.c.inl";
34 my $target_h = $target_dir."/gen_".$arch."_new_nodes.h";
35
36 #print Dumper(%nodes);
37
38 # create c code file from specs
39
40 my @obst_opvar;       # stack for the "ir_op *op_<arch>_<op-name> = NULL;" statements
41 my @obst_get_opvar;   # stack for the get_op_<arch>_<op-name>() functions
42 my @obst_constructor; # stack for node constructor functions
43 my @obst_new_irop;    # stack for the new_ir_op calls
44 my @obst_header;      # stack for function prototypes
45 my @obst_is_archirn;  # stack for the is_$arch_irn() function
46 my @obst_cmp_attr;    # stack for the compare attribute functions
47 my $orig_op;
48 my $arity;
49 my $cmp_attr_func;
50 my $temp;
51 my $n_opcodes = 2;    # we have two additional border opcodes (lowest/highest)
52
53 push(@obst_header, "void ".$arch."_create_opcodes(void);\n");
54
55 foreach my $op (keys(%nodes)) {
56         my %n = %{ $nodes{"$op"} };
57
58         # determine arity from in requirements
59         $arity = 0;
60         if (exists($n{"reg_req"}) && exists($n{"reg_req"}{"in"})) {
61                 $arity = scalar(@{ $n{"reg_req"}{"in"} });
62         }
63
64         $orig_op = $op;
65         $op      = $arch."_".$op;
66         $temp    = "";
67
68         push(@obst_opvar, "ir_op *op_$op = NULL;\n");
69         push(@obst_get_opvar, "ir_op *get_op_$op(void)         { return op_$op; }\n");
70         push(@obst_get_opvar, "int    is_$op(const ir_node *n) { return get_irn_op(n) == op_$op; }\n\n");
71
72         push(@obst_is_archirn, "is_$op(node)");
73
74         push(@obst_header, "ir_op *get_op_$op(void);\n");
75         push(@obst_header, "int is_$op(const ir_node *n);\n");
76
77         $cmp_attr_func = 0;
78         # create compare attribute function if needed
79         if (exists($n{"cmp_attr"})) {
80                 push(@obst_cmp_attr, "static int cmp_attr_$op(ir_node *a, ir_node *b) {\n");
81                 push(@obst_cmp_attr, "  $arch\_attr_t *attr_a = get_$arch\_attr(a);\n");
82                 push(@obst_cmp_attr, "  $arch\_attr_t *attr_b = get_$arch\_attr(b);\n");
83                 push(@obst_cmp_attr, $n{"cmp_attr"});
84                 push(@obst_cmp_attr, "}\n\n");
85
86                 $cmp_attr_func = 1;
87         }
88
89         if (exists($n{"rd_constructor"}) && $n{"rd_constructor"} =~ /^NONE$/i) {
90                 # we explicitly skip the constructor if the specification entry says NONE
91         }
92         else {
93                 $n{"comment"} = "construct $op" if(!exists($n{"comment"}));
94                 $n{"comment"} =~ s/^"|"$//g;    # remove "
95                 $n{"comment"} = "/* ".$n{"comment"}." */\n";
96                 push(@obst_constructor, $n{"comment"});
97
98                 # create constructor head
99                 my $complete_args = "";
100                 my $arg_names     = "";
101                 $temp             = "";
102
103                 $temp = "ir_node *new_rd_$op(dbg_info *db, ir_graph *irg, ir_node *block";
104                 if (!exists($n{"args"}) || $n{"args"} =~ /^DEFAULT$/i) { # default args
105                         if ($arity !~ /^\d+$/) {
106                                 print "DEFAULT args require numeric arity (0, 1, 2, ...)! Ignoring op $orig_op!\n";
107                                 next;
108                         }
109                         for (my $i = 1; $i <= $arity; $i++) {
110                                 $complete_args .= ", ir_node *op".$i;
111                                 $arg_names     .= ", op".$i;
112                         }
113                         $complete_args .= ", ir_mode *mode";
114                         $arg_names     .= ", mode";
115                 }
116                 else { # user defined args
117                         for my $href (@{ $n{"args"} }) {
118                                 $href->{"type"} .= " " if ($href->{"type"} !~ / [*]?$/); # put a space between name and type if there is none at the end
119                                 $complete_args  .= ", ".$href->{"type"}.$href->{"name"};
120                                 $arg_names      .= ", ".$href->{"name"};
121                         }
122                 }
123                 $complete_args = substr($complete_args, 2);
124                 $temp .= ", $complete_args)";
125                 push(@obst_constructor, $temp." {\n");
126                 push(@obst_header, $temp.";\n");
127
128                 # emit constructor code
129                 if (!exists($n{"rd_constructor"}) || $n{"rd_constructor"} =~ /^DEFAULT$/i) { # default constructor
130                         if ($arity !~ /^\d+$/) {
131                                 print "DEFAULT rd_constructor requires numeric arity! Ignoring op $orig_op!\n";
132                                 next;
133                         }
134                         $temp  = "  $arch\_attr_t *attr;\n";
135                         $temp .= "  ir_node *res;\n";
136                         $temp .= "  ir_node *in[$arity];\n" if ($arity > 0);
137
138                         undef my $in_req_var;
139                         undef my $out_req_var;
140
141                         # set up static variables for requirements and registers
142                         if (exists($n{"reg_req"})) {
143                                 my %req = %{ $n{"reg_req"} };
144                                 my $idx;
145
146                                 undef my @in;
147                                 @in = @{ $req{"in"} } if (exists($req{"in"}));
148                                 undef my @out;
149                                 @out = @{ $req{"out"} } if exists(($req{"out"}));
150
151                                 if (@in) {
152                                         $in_req_var = "_in_req_$op";
153                                         $temp .= "  static const $arch\_register_req_t *".$in_req_var."[] =\n  {\n";
154                                         for ($idx = 0; $idx <= $#in; $idx++) {
155                                                 $temp .= "    ".$op."_reg_req_in_".$idx.",\n";
156                                         }
157                                         $temp .= "  };\n";
158                                 }
159
160                                 if (@out) {
161                                         $out_req_var = "_out_req_$op";
162
163                                         $temp .= "  static const $arch\_register_req_t *".$out_req_var."[] =\n  {\n";
164                                         for ($idx = 0; $idx <= $#out; $idx++) {
165                                                 $temp .= "    ".$op."_reg_req_out_".$idx.",\n";
166                                         }
167                                         $temp .= "  };\n";
168                                 }
169                         }
170
171                         $temp .= "\n";
172                         $temp .= "  if (!op_$op) {\n";
173                         $temp .= "    assert(0);\n";
174                         $temp .= "    return NULL;\n";
175                         $temp .= "  }\n\n";
176                         for (my $i = 1; $i <= $arity; $i++) {
177                                 $temp .= "  in[".($i - 1)."] = op".$i.";\n";
178                         }
179                         $temp .= "  res = new_ir_node(db, irg, block, op_$op, mode, $arity, ".($arity > 0 ? "in" : "NULL").");\n";
180                         $temp .= "  res = optimize_node(res);\n";
181                         $temp .= "  irn_vrfy_irg(res, irg);\n\n";
182
183                         # set flags
184                         $temp .= "  attr = get_$arch\_attr(res);\n\n";
185                         $temp .= "  attr->flags  = 0;                                 /* clear flags */\n";
186
187                         if (exists($n{"irn_flags"})) {
188                                 foreach my $flag (split(/\|/, $n{"irn_flags"})) {
189                                         if ($flag eq "R") {
190                                                 $temp .= "  attr->flags |= arch_irn_flags_rematerializable;   /* op can be easily recalulated */\n";
191                                         }
192                                         elsif ($flag eq "N") {
193                                                 $temp .= "  attr->flags |= arch_irn_flags_dont_spill;         /* op is NOT spillable */\n";
194                                         }
195                                         elsif ($flag eq "I") {
196                                                 $temp .= "  attr->flags |= arch_irn_flags_ignore;             /* ignore op for register allocation */\n";
197                                         }
198                                 }
199                         }
200
201                         # allocate memory and set pointer to register requirements
202                         if (exists($n{"reg_req"})) {
203                                 my %req = %{ $n{"reg_req"} };
204
205                                 undef my @in;
206                                 @in = @{ $req{"in"} } if (exists($req{"in"}));
207                                 undef my @out;
208                                 @out = @{ $req{"out"} } if exists(($req{"out"}));
209
210                                 $temp .= "\n  /* set IN register requirements */\n";
211                                 if (@in) {
212                                         $temp .= "  attr->in_req  = ".$in_req_var.";\n";
213                                 }
214                                 else {
215                                         $temp .= "  attr->in_req  = NULL;\n";
216                                 }
217
218                                 $temp .= "\n  /* set OUT register requirements and get space for registers */\n";
219                                 if (@out) {
220                                         $temp .= "  attr->out_req = ".$out_req_var.";\n";
221                                         $temp .= "  attr->slots   = xcalloc(".($#out + 1).", sizeof(attr->slots[0]));\n";
222                                         $temp .= "  attr->n_res   = ".($#out + 1).";\n";
223                                 }
224                                 else {
225                                         $temp .= "  attr->out_req = NULL;\n";
226                                         $temp .= "  attr->slots   = NULL;\n";
227                                         $temp .= "  attr->n_res   = 0;\n";
228                                 }
229                         }
230
231                         $temp .= "\n  return res;\n";
232
233                         push(@obst_constructor, $temp);
234                 }
235                 else { # user defined constructor
236                         push(@obst_constructor, $n{"rd_constructor"});
237                 }
238
239                 # close constructor function
240                 push(@obst_constructor, "}\n\n");
241
242         } # constructor creation
243
244         # set default values for state and flags if not given
245         $n{"state"}    = "floats" if (! exists($n{"state"}));
246         $n{"op_flags"} = "N"      if (! exists($n{"op_flags"}));
247
248         push(@obst_new_irop, "\n  memset(&ops, 0, sizeof(ops));\n");
249         push(@obst_new_irop, "  ops.dump_node     = dump_node_$arch;\n");
250
251         if ($cmp_attr_func) {
252                 push(@obst_new_irop, "  ops.node_cmp_attr = cmp_attr_$op;\n");
253         }
254
255         $n_opcodes++;
256         $temp  = "  op_$op = new_ir_op(cur_opcode++, \"$op\", op_pin_state_".$n{"state"}.", ".$n{"op_flags"};
257         $temp .= ", ".translate_arity($arity).", 2, sizeof($arch\_attr_t), &ops);\n";
258         push(@obst_new_irop, $temp);
259 }
260
261 # emit the code
262
263 open(OUT, ">$target_c") || die("Could not open $target_c, reason: $!\n");
264
265 print OUT "#include \"gen_$arch\_regalloc_if_t.h\"\n\n";
266 print OUT @obst_cmp_attr;
267 print OUT "\n";
268 print OUT @obst_opvar;
269 print OUT "\n";
270 print OUT @obst_get_opvar;
271 print OUT "\n";
272
273 print OUT<<ENDOFISIRN;
274
275 static opcode ia32_opcode_start = -1;
276 static opcode ia32_opcode_end   = -1;
277
278 int is_$arch\_irn(const ir_node *node) {
279   opcode opc = get_irn_opcode(node);
280
281   assert(ia32_opcode_start > 0 && "missing opcode init");
282   assert(ia32_opcode_end > 0 && "missing opcode init");
283
284   if (opc > ia32_opcode_start && opc < ia32_opcode_end)
285     return 1;
286
287   return 0;
288 }
289
290 ENDOFISIRN
291
292 print OUT @obst_constructor;
293
294 print OUT<<ENDOFMAIN;
295 /**
296  * Creates the $arch specific firm operations
297  * needed for the assembler irgs.
298  */
299 void $arch\_create_opcodes(void) {
300 #define N   irop_flag_none
301 #define L   irop_flag_labeled
302 #define C   irop_flag_commutative
303 #define X   irop_flag_cfopcode
304 #define I   irop_flag_ip_cfopcode
305 #define F   irop_flag_fragile
306 #define Y   irop_flag_forking
307 #define H   irop_flag_highlevel
308 #define c   irop_flag_constlike
309 #define K   irop_flag_keep
310
311   ir_op_ops ops;
312   int cur_opcode = get_next_ir_opcodes($n_opcodes);
313
314   ia32_opcode_start = cur_opcode++;
315
316 ENDOFMAIN
317
318 print OUT @obst_new_irop;
319 print OUT "\n  ia32_opcode_end = cur_opcode;\n";
320 print OUT "}\n";
321
322 close(OUT);
323
324 open(OUT, ">$target_h") || die("Could not open $target_h, reason: $!\n");
325
326 print OUT "int is_$arch\_irn(const ir_node *node);\n";
327 print OUT @obst_header;
328
329 close(OUT);
330
331 ###
332 # Translates numeric arity into string constant.
333 ###
334 sub translate_arity {
335         my $arity = shift;
336
337         if ($arity =~ /^\d+$/) {
338                 if    ($arity == 0) {
339                         return "oparity_zero";
340                 }
341                 elsif ($arity == 1) {
342                         return "oparity_unary";
343                 }
344                 elsif ($arity == 2) {
345                         return "oparity_binary";
346                 }
347                 elsif ($arity == 3) {
348                         return "oparity_trinary";
349                 }
350                 else {
351                         return "$arity";
352                 }
353         }
354         else {
355                 return "oparity_".$arity;
356         }
357 }