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