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