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