reverted antic_in
[libfirm] / scripts / gen_ir.py
1 #!/usr/bin/env python
2 import sys
3 from jinja2 import Environment, Template
4 from spec_util import is_dynamic_pinned, isAbstract, setdefault, load_spec
5 from filters import format_arguments, filter_isnot, filter_hasnot, filter_notset
6
7 def format_parameterlist(parameterlist):
8         return "\n".join(parameterlist)
9
10 def format_nodearguments(node):
11         arguments = map(lambda arg: arg["name"], node.arguments)
12         return format_parameterlist(arguments)
13
14 def format_nodeparameters(node):
15         parameters = map(lambda arg: arg["type"] + " " + arg["name"], node.arguments)
16         return format_parameterlist(parameters)
17
18 def format_nodeparametershelp(node):
19         res = ""
20         for param in node.arguments:
21                 res += " * @param %-9s %s\n" % (param["name"], param["comment"])
22         return res
23
24 def format_a_an(text):
25         if text[0] in "aAeEuUoOiI":
26                 return "an " + text
27         return "a " + text
28
29 def format_blockparameter(node):
30         if hasattr(node, "knownBlock"):
31                 if hasattr(node, "knownGraph"):
32                         return ""
33                 return "ir_graph *irg"
34         else:
35                 return "ir_node *block"
36
37 def format_blockparameterhelp(node):
38         if hasattr(node, "knownBlock"):
39                 if hasattr(node, "knownGraph"):
40                         return ""
41                 return " * @param irg       The IR graph the node belongs to.\n"
42         else:
43                 return " * @param block     The IR block the node belongs to.\n"
44
45 def format_blockargument(node):
46         if hasattr(node, "knownBlock"):
47                 if hasattr(node, "knownGraph"):
48                         return ""
49                 return "irg"
50         else:
51                 return "block"
52
53 def format_irgassign(node):
54         if hasattr(node, "knownGraph"):
55                 return "ir_graph *irg = %s;\n" % node.graph
56
57         if hasattr(node, "knownBlock"):
58                 return ""
59         else:
60                 return "ir_graph *irg = get_irn_irg(block);\n"
61
62 def format_curblock(node):
63         if hasattr(node, "knownBlock"):
64                 if hasattr(node, "knownGraph"):
65                         return ""
66                 return "current_ir_graph"
67         else:
68                 return "current_ir_graph->current_block"
69
70 def format_insdecl(node):
71         arity = node.arity
72         if arity == "variable" and len(node.ins) == 0 or arity == "dynamic" or arity == 0:
73                 return ""
74
75         if arity == "variable":
76                 insarity = len(node.ins)
77                 res  = "int r_arity = arity + " + `insarity` + ";"
78                 res += "\n\tir_node **r_in;"
79                 res += "\n\tNEW_ARR_A(ir_node *, r_in, r_arity);"
80                 i = 0
81                 for input in node.ins:
82                         res += "\n\tr_in[" + `i` + "] = irn_" + input[0] + ";"
83                         i += 1
84                 res += "\n\tmemcpy(&r_in[" + `insarity` + "], in, sizeof(ir_node *) * arity);\n\t"
85         else:
86                 res = "ir_node *in[" + `arity` + "];"
87                 i = 0
88                 for input in node.ins:
89                         res += "\n\tin[" + `i` + "] = irn_" + input[0] + ";"
90                         i += 1
91         return res
92
93 def format_arity_and_ins(node):
94         arity = node.arity
95         if arity == "dynamic":
96                 return "-1, NULL"
97         elif arity == "variable":
98                 if len(node.ins) == 0:
99                         return "arity, in"
100                 else:
101                         return "r_arity, r_in"
102         elif arity == 0:
103                 return "0, NULL"
104         else:
105                 return `arity` + ", in"
106
107 def format_arity(node):
108         if hasattr(node, "arity_override"):
109                 return node.arity_override
110         arity = node.arity
111         if arity == "dynamic":
112                 return "oparity_dynamic"
113         if arity == "variable":
114                 return "oparity_variable"
115         if arity == 0:
116                 return "oparity_zero"
117         if arity == 1:
118                 return "oparity_unary"
119         if arity == 2:
120                 return "oparity_binary"
121         if arity == 3:
122                 return "oparity_trinary"
123         return "oparity_any"
124
125 def format_pinned(node):
126         pinned = node.pinned
127         if pinned == "yes":
128                 return "op_pin_state_pinned"
129         if pinned == "no":
130                 return "op_pin_state_floats"
131         if pinned == "exception":
132                 return "op_pin_state_exc_pinned"
133         if pinned == "memory":
134                 return "op_pin_state_mem_pinned"
135         print "WARNING: Unknown pinned state %s in format pined" % pinned
136         return ""
137
138 def format_flags(node):
139         flags = map(lambda x : "irop_flag_" + x, node.flags)
140         if flags == []:
141                 flags = [ "irop_flag_none" ]
142         return " | ".join(flags)
143
144 def format_attr_size(node):
145         if not hasattr(node, "attr_struct"):
146                 return "0"
147         return "sizeof(%s)" % node.attr_struct
148
149 def format_opindex(node):
150         if hasattr(node, "op_index"):
151                 return node.op_index
152         return "-1"
153
154 keywords = frozenset([ "true", "false" ])
155 def format_escape_keywords(word):
156         if word in keywords:
157                 return word + "_"
158         return word
159
160 def format_parameters(string):
161         return format_arguments(string, voidwhenempty = True)
162
163 env = Environment()
164 env.filters['a_an']            = format_a_an
165 env.filters['parameterlist']   = format_parameterlist
166 env.filters['nodearguments']   = format_nodearguments
167 env.filters['nodeparameters']  = format_nodeparameters
168 env.filters['nodeparametershelp'] = format_nodeparametershelp
169 env.filters['blockparameter']  = format_blockparameter
170 env.filters['blockparameterhelp'] = format_blockparameterhelp
171 env.filters['blockargument']   = format_blockargument
172 env.filters['irgassign']       = format_irgassign
173 env.filters['curblock']        = format_curblock
174 env.filters['insdecl']         = format_insdecl
175 env.filters['arity_and_ins']   = format_arity_and_ins
176 env.filters['arity']           = format_arity
177 env.filters['pinned']          = format_pinned
178 env.filters['flags']           = format_flags
179 env.filters['attr_size']       = format_attr_size
180 env.filters['opindex']         = format_opindex
181 env.filters['isnot']           = filter_isnot
182 env.filters['hasnot']          = filter_hasnot
183 env.filters['arguments']       = format_arguments
184 env.filters['parameters']      = format_parameters
185 env.filters['escape_keywords'] = format_escape_keywords
186
187 def prepare_attr(attr):
188         if "init" in attr:
189                 return dict(
190                         type = attr["type"],
191                         name = attr["name"],
192                         init = attr["init"],
193                         comment = attr["comment"])
194         else:
195                 return dict(
196                         type = attr["type"],
197                         name = attr["name"],
198                         comment = attr["comment"])
199
200 def preprocess_node(node):
201         setdefault(node, "attrs_name", node.name.lower())
202         setdefault(node, "block", "block")
203
204         # construct node arguments
205         arguments = [ ]
206         initattrs = [ ]
207         for input in node.ins:
208                 arguments.append(dict(
209                                 type    = "ir_node *",
210                                 name    = "irn_" + input[0],
211                                 comment = input[1]))
212
213         if node.arity == "variable" or node.arity == "dynamic":
214                 arguments.append(dict(
215                                 type    = "int",
216                                 name    = "arity",
217                                 comment = "size of additional inputs array"))
218                 arguments.append(dict(
219                                 type    = "ir_node *const *",
220                                 name    = "in",
221                                 comment = "additional inputs"))
222
223         if not hasattr(node, "mode"):
224                 arguments.append(dict(
225                                 type    = "ir_mode *",
226                                 name    = "mode",
227                                 comment = "mode of the operations result"))
228                 node.mode = "mode"
229
230         for attr in node.attrs:
231                 attr["fqname"] = "." + attr["name"]
232                 if "init" in attr:
233                         continue
234                 arguments.append(attr)
235
236         # dynamic pin state means more constructor arguments
237         if is_dynamic_pinned(node):
238                 if hasattr(node, "pinned_init"):
239                         initattrs.append(dict(
240                                 fqname = ".exc.pin_state",
241                                 init   = node.pinned_init
242                         ))
243                 else:
244                         node.constructor_args.append(
245                                 dict(
246                                         name    = "pin_state",
247                                         type    = "op_pin_state",
248                                         comment = "pinned state",
249                                 )
250                         )
251                         initattrs.append(dict(
252                                 fqname = ".exc.pin_state",
253                                 init   = "pin_state"
254                         ))
255         if hasattr(node, "throws_init"):
256                 initattrs.append(dict(
257                         fqname = ".exc.throws_exception",
258                         init   = node.throws_init
259                 ))
260
261         for arg in node.constructor_args:
262                 arguments.append(prepare_attr(arg))
263
264         node.arguments = arguments
265         node.initattrs = initattrs
266
267 #############################
268
269 gen_ircons_c_inl_template = env.from_string(
270 '''/* Warning: automatically generated code */
271
272 {%- for node in nodes %}
273 {%- if not node.noconstructor %}
274 ir_node *new_rd_{{node.name}}(
275         {%- filter parameters %}
276                 dbg_info *dbgi
277                 {{node|blockparameter}}
278                 {{node|nodeparameters}}
279         {% endfilter %})
280 {
281         ir_node *res;
282         {%- if node.arity == "dynamic" %}
283         int      i;
284         {%- endif %}
285         {{node|irgassign}}
286         {{node|insdecl}}
287
288         res = new_ir_node(
289                 {%- filter arguments %}
290                         dbgi
291                         irg
292                         {{node.block}}
293                         op_{{node.name}}
294                         {{node.mode}}
295                         {{node|arity_and_ins}}
296                 {% endfilter %});
297         {%- if node.arity == "dynamic" %}
298         for (i = 0; i < arity; ++i) {
299                 add_irn_n(res, in[i]);
300         }
301         {%- endif %}
302         {%- for attr in node.attrs %}
303         res->attr.{{node.attrs_name}}{{attr["fqname"]}} =
304                 {%- if "init" in attr %} {{ attr["init"] -}};
305                 {%- else              %} {{ attr["name"] -}};
306                 {%- endif %}
307         {%- endfor %}
308         {%- for attr in node.initattrs %}
309         res->attr.{{node.attrs_name}}{{attr["fqname"]}} = {{ attr["init"] -}};
310         {%- endfor %}
311         {{- node.init }}
312         irn_verify_irg(res, irg);
313         res = optimize_node(res);
314         {{- node.init_after_opt }}
315         return res;
316 }
317
318 ir_node *new_r_{{node.name}}(
319                 {%- filter parameters %}
320                         {{node|blockparameter}}
321                         {{node|nodeparameters}}
322                 {% endfilter %})
323 {
324         return new_rd_{{node.name}}(
325                 {%- filter arguments %}
326                         NULL
327                         {{node|blockargument}}
328                         {{node|nodearguments}}
329                 {% endfilter %});
330 }
331
332 ir_node *new_d_{{node.name}}(
333                 {%- filter parameters %}
334                         dbg_info *dbgi
335                         {{node|nodeparameters}}
336                 {% endfilter %})
337 {
338         ir_node *res;
339         assert(irg_is_constrained(current_ir_graph, IR_GRAPH_CONSTRAINT_CONSTRUCTION));
340         res = new_rd_{{node.name}}(
341                 {%- filter parameters %}
342                         dbgi
343                         {{node|curblock}}
344                         {{node|nodearguments}}
345                 {% endfilter %});
346         return res;
347 }
348
349 ir_node *new_{{node.name}}(
350                 {%- filter parameters %}
351                         {{node|nodeparameters}}
352                 {% endfilter %})
353 {
354         return new_d_{{node.name}}(
355                 {%- filter arguments %}
356                         NULL
357                         {{node|nodearguments}}
358                 {% endfilter %});
359 }
360 {% endif %}
361 {%- endfor %}
362 ''')
363
364 irnode_h_template = env.from_string(
365 '''/* Warning: automatically generated code */
366
367 {%- for node in nodes|isnot('custom_is') %}
368 static inline int is_{{node.name}}_(const ir_node *node)
369 {
370         assert(node != NULL);
371         return get_irn_op_(node) == op_{{node.name}};
372 }
373 {%- endfor -%}
374
375 {% for node in nodes %}
376 #define is_{{node.name}}(node)    is_{{node.name}}_(node)
377 {%- endfor %}
378
379 ''')
380
381 irnode_template = env.from_string(
382 '''/* Warning: automatically generated code */
383 {% for node in nodes %}
384 int (is_{{node.name}})(const ir_node *node)
385 {
386         return is_{{node.name}}_(node);
387 }
388 {% endfor %}
389
390 {%- for node in nodes %}
391 {%- for attr in node.attrs|hasnot("noprop") %}
392 {{attr.type}} (get_{{node.name}}_{{attr.name}})(const ir_node *node)
393 {
394         assert(is_{{node.name}}(node));
395         return node->attr.{{node.attrs_name}}.{{attr.name}};
396 }
397
398 void (set_{{node.name}}_{{attr.name}})(ir_node *node, {{attr.type}} {{attr.name}})
399 {
400         assert(is_{{node.name}}(node));
401         node->attr.{{node.attrs_name}}.{{attr.name}} = {{attr.name}};
402 }
403 {% endfor -%}
404 {% endfor -%}
405
406 {%- for node in nodes %}
407 {%- for input in node.ins %}
408 ir_node *(get_{{node.name}}_{{input[0]}})(const ir_node *node)
409 {
410         assert(is_{{node.name}}(node));
411         return get_irn_n(node, n_{{node.name}}_{{input[0]}});
412 }
413
414 void (set_{{node.name}}_{{input[0]}})(ir_node *node, ir_node *{{input[0]|escape_keywords}})
415 {
416         assert(is_{{node.name}}(node));
417         set_irn_n(node, n_{{node.name}}_{{input[0]}}, {{input[0]|escape_keywords}});
418 }
419 {% endfor %}
420 {% endfor %}
421 ''')
422
423 irdump_template = env.from_string(
424 '''/* Warning: automatically generated code */
425 {% for node in nodes %}
426 {%- if node.outs %}
427 static const pns_lookup_t {{node.name}}_lut[] = {
428         {%- for out in node.outs %}
429         { pn_{{node.name}}_{{out[0]}}, "{{out[0]}}" },
430         {%- endfor %}
431 };
432 {% endif -%}
433 {%- endfor %}
434
435 static const proj_lookup_t proj_lut[] = {
436         {%- for node in nodes -%}
437         {%- if node.outs %}
438         { {{spec.name}}o_{{node.name}}, ARRAY_SIZE({{node.name}}_lut), {{node.name}}_lut },
439         {%- endif %}
440         {%- endfor %}
441 };
442 ''')
443
444 irop_template = env.from_string(
445 '''/* Warning: automatically generated code */
446 {% for node in nodes %}
447 ir_op *op_{{node.name}}; ir_op *get_op_{{node.name}}(void) { return op_{{node.name}}; }
448 {%- endfor %}
449
450 static void generated_init_op(void)
451 {
452         {%- for node in nodes %}
453         op_{{node.name}} = new_ir_op(
454                 {%- filter arguments %}
455                         {{spec.name}}o_{{node.name}}
456                         "{{node.name}}"
457                         {{node|pinned}}
458                         {{node|flags}}
459                         {{node|arity}}
460                         {{node|opindex}}
461                         {{node|attr_size}}
462                 {% endfilter %});
463         {%- if "uses_memory" in node.flags: %}
464         ir_op_set_memory_index(op_{{node.name}}, n_{{node.name}}_mem);
465         {%- endif -%}
466         {%- if "fragile" in node.flags: %}
467         ir_op_set_fragile_indices(op_{{node.name}}, pn_{{node.name}}_X_regular, pn_{{node.name}}_X_except);
468         {%- endif -%}
469         {%- endfor %}
470 }
471
472 static void generated_finish_op(void)
473 {
474         {%- for node in nodes %}
475         free_ir_op(op_{{node.name}}); op_{{node.name}} = NULL;
476         {%- endfor %}
477 }
478
479 ''')
480
481 nodeops_h_template = env.from_string(
482 '''/* Warning: automatically generated code */
483 #ifndef FIRM_IR_NODEOPS_H
484 #define FIRM_IR_NODEOPS_H
485
486 #include "firm_types.h"
487
488 #include "begin.h"
489
490 /**
491  * @addtogroup ir_node
492  * @{
493  */
494
495 {% for node in nodes -%}
496
497 /**
498  * @defgroup {{node.name}} {{node.name}} node
499  *
500  * {{node.doc}}
501  * @{
502  */
503 {% if node.ins %}
504 /**
505  * Input numbers for {{node.name}} node
506  */
507 typedef enum {
508         {%- for input in node.ins %}
509         n_{{node.name}}_{{input[0]}},
510         {%- endfor %}
511         n_{{node.name}}_max = n_{{node.name}}_{{node.ins[-1][0]}}
512 } n_{{node.name}};
513 {% endif %}
514 {% if node.outs %}
515 /**
516  * Projection numbers for result of {{node.name}} node (use for Proj nodes)
517  */
518 typedef enum {
519         {% for out in node.outs -%}
520         pn_{{node.name}}_{{out[0]}}
521         {%- if out.__len__() > 2 %} = {{out[2]}}{% endif %}, /**< {{out[1]}} */
522         {% endfor -%}
523         pn_{{node.name}}_max = pn_{{node.name}}_{{node.outs[-1][0]}}
524 } pn_{{node.name}};
525 {% endif %}
526 {%- if not node.noconstructor %}
527 /**
528  * Construct {{node.name|a_an}} node.
529  *
530  * @param dbgi      A pointer to debug information.
531 {{ node|blockparameterhelp -}}
532 {{ node|nodeparametershelp -}}
533  */
534 FIRM_API ir_node *new_rd_{{node.name}}(
535         {%- filter parameters %}
536                 dbg_info *dbgi
537                 {{node|blockparameter}}
538                 {{node|nodeparameters}}
539         {% endfilter %});
540
541 /**
542  * Construct {{node.name|a_an}} node.
543  *
544 {{ node|blockparameterhelp -}}
545 {{ node|nodeparametershelp -}}
546  */
547 FIRM_API ir_node *new_r_{{node.name}}(
548         {%- filter parameters %}
549                 {{node|blockparameter}}
550                 {{node|nodeparameters}}
551         {% endfilter %});
552
553 /**
554  * Construct {{node.name|a_an}} node.
555  *
556  * @param dbgi      A pointer to debug information.
557 {{ node|nodeparametershelp -}}
558  */
559 FIRM_API ir_node *new_d_{{node.name}}(
560         {%- filter parameters %}
561                 dbg_info *dbgi
562                 {{node|nodeparameters}}
563         {% endfilter %});
564
565 /**
566  * Construct {{node.name|a_an}} node.
567  *
568 {{ node|nodeparametershelp -}}
569  */
570 FIRM_API ir_node *new_{{node.name}}(
571         {%- filter parameters %}
572                 {{node|nodeparameters}}
573         {% endfilter %});
574 {%- endif %}
575 /**
576  * Test if node is a {{node.name}}
577  * @returns 1 if the node is a {{node.name}} node, 0 otherwise
578  */
579 FIRM_API int is_{{node.name}}(const ir_node *node);
580
581 {% for input in node.ins -%}
582 /** Returns {{input[0]}} input of {{node.name|a_an}} node. */
583 FIRM_API ir_node *get_{{node.name}}_{{input[0]}}(const ir_node *node);
584 /** Sets {{input[0]}} input of {{node.name|a_an}} node. */
585 FIRM_API void set_{{node.name}}_{{input[0]}}(ir_node *node, ir_node *{{input[0]|escape_keywords}});
586 {% endfor -%}
587 {% for attr in node.attrs|hasnot("noprop") -%}
588 /** Returns {{attr.name}} attribute of {{node.name|a_an}} node. */
589 FIRM_API {{attr.type}} get_{{node.name}}_{{attr.name}}(const ir_node *node);
590 /** Sets {{attr.name}} attribute of {{node.name|a_an}} node. */
591 FIRM_API void set_{{node.name}}_{{attr.name}}(ir_node *node, {{attr.type}} {{attr.name}});
592 {% endfor -%}
593 /** @} */
594
595 {% endfor -%}
596
597 /** @} */
598
599 #include "end.h"
600
601 #endif
602
603 ''')
604
605 opcodes_h_template = env.from_string(
606 '''/* Warning: automatically generated code */
607 #ifndef FIRM_IR_OPCODES_H
608 #define FIRM_IR_OPCODES_H
609
610 /** The opcodes of the libFirm predefined operations.
611  * @ingroup ir_op
612  */
613 typedef enum {{spec.name}}_opcode {
614 {%- for node in nodes %}
615         {{spec.name}}o_{{node.name}},
616 {%- endfor %}
617         {{spec.name}}o_First = {{spec.name}}o_{{nodes[0].name}},
618         {{spec.name}}o_Last  = {{spec.name}}o_{{nodes[-1].name}},
619
620 {%- if spec.name == "ir" %}
621         beo_First,
622         /* backend specific nodes */
623         beo_Spill = beo_First,
624         beo_Reload,
625         beo_Perm,
626         beo_MemPerm,
627         beo_Copy,
628         beo_Keep,
629         beo_CopyKeep,
630         beo_Call,
631         beo_Return,
632         beo_AddSP,
633         beo_SubSP,
634         beo_IncSP,
635         beo_Start,
636         beo_FrameAddr,
637         /* last backend node number */
638         beo_Last = beo_FrameAddr,
639 {%- endif %}
640         {{spec.name}}o_MaxOpcode
641 } {{spec.name}}_opcode;
642
643 {% for node in nodes %}
644 /**
645  * @ingroup {{node.name}}
646  * {{node.name}} opcode
647  */
648 FIRM_API ir_op *op_{{node.name}};
649 {%- endfor %}
650
651 {% for node in nodes %}
652 /**
653  * @ingroup {{node.name}}
654  * Returns opcode for {{node.name}} nodes.
655  */
656 FIRM_API ir_op *get_op_{{node.name}}(void);
657 {%- endfor %}
658
659 #endif
660
661 ''')
662
663 #############################
664
665 def prepare_nodes(nodes):
666         real_nodes = []
667         for node in nodes:
668                 if isAbstract(node):
669                         continue
670                 real_nodes.append(node)
671
672         for node in real_nodes:
673                 preprocess_node(node)
674
675         return real_nodes
676
677 def main(argv):
678         if len(argv) < 3:
679                 print "usage: %s specname(ignored) destdirectory" % argv[0]
680                 sys.exit(1)
681
682         specfile = argv[1]
683         spec = load_spec(specfile)
684         nodes = spec.nodes
685
686         gendir = argv[2]
687         # hardcoded path to libfirm/include/libfirm
688         if len(argv) > 3:
689                 gendir2 = argv[3]
690         else:
691                 gendir2 = argv[2] + "/../../include/libfirm"
692
693         real_nodes = prepare_nodes(nodes)
694
695         env.globals['nodes'] = real_nodes
696         env.globals['spec'] = spec
697
698         file = open(gendir + "/gen_ir_cons.c.inl", "w")
699         file.write(gen_ircons_c_inl_template.render())
700         file.close()
701
702         file = open(gendir + "/gen_irnode.h", "w")
703         file.write(irnode_h_template.render())
704         file.close()
705
706         file = open(gendir + "/gen_irnode.c.inl", "w")
707         file.write(irnode_template.render())
708         file.close()
709
710         file = open(gendir + "/gen_irop.c.inl", "w")
711         file.write(irop_template.render())
712         file.close()
713
714         file = open(gendir + "/gen_irdump.c.inl", "w")
715         file.write(irdump_template.render())
716         file.close()
717
718         file = open(gendir2 + "/opcodes.h", "w")
719         file.write(opcodes_h_template.render())
720         file.close()
721
722         file = open(gendir2 + "/nodeops.h", "w")
723         file.write(nodeops_h_template.render())
724         file.close()
725
726 main(sys.argv)