move is_liveness_node to irlivechk header and share it with belive
[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         {{node|irgassign}}
282         {{node|insdecl}}
283
284         ir_node *res = new_ir_node(
285                 {%- filter arguments %}
286                         dbgi
287                         irg
288                         {{node.block}}
289                         op_{{node.name}}
290                         {{node.mode}}
291                         {{node|arity_and_ins}}
292                 {% endfilter %});
293         {%- if node.arity == "dynamic" %}
294         for (int i = 0; i < arity; ++i) {
295                 add_irn_n(res, in[i]);
296         }
297         {%- endif %}
298         {%- for attr in node.attrs %}
299         res->attr.{{node.attrs_name}}{{attr["fqname"]}} =
300                 {%- if "init" in attr %} {{ attr["init"] -}};
301                 {%- else              %} {{ attr["name"] -}};
302                 {%- endif %}
303         {%- endfor %}
304         {%- for attr in node.initattrs %}
305         res->attr.{{node.attrs_name}}{{attr["fqname"]}} = {{ attr["init"] -}};
306         {%- endfor %}
307         {{- node.init }}
308         irn_verify_irg(res, irg);
309         res = optimize_node(res);
310         {{- node.init_after_opt }}
311         return res;
312 }
313
314 ir_node *new_r_{{node.name}}(
315                 {%- filter parameters %}
316                         {{node|blockparameter}}
317                         {{node|nodeparameters}}
318                 {% endfilter %})
319 {
320         return new_rd_{{node.name}}(
321                 {%- filter arguments %}
322                         NULL
323                         {{node|blockargument}}
324                         {{node|nodearguments}}
325                 {% endfilter %});
326 }
327
328 ir_node *new_d_{{node.name}}(
329                 {%- filter parameters %}
330                         dbg_info *dbgi
331                         {{node|nodeparameters}}
332                 {% endfilter %})
333 {
334         assert(irg_is_constrained(current_ir_graph, IR_GRAPH_CONSTRAINT_CONSTRUCTION));
335         ir_node *res = new_rd_{{node.name}}(
336                 {%- filter parameters %}
337                         dbgi
338                         {{node|curblock}}
339                         {{node|nodearguments}}
340                 {% endfilter %});
341         return res;
342 }
343
344 ir_node *new_{{node.name}}(
345                 {%- filter parameters %}
346                         {{node|nodeparameters}}
347                 {% endfilter %})
348 {
349         return new_d_{{node.name}}(
350                 {%- filter arguments %}
351                         NULL
352                         {{node|nodearguments}}
353                 {% endfilter %});
354 }
355 {% endif %}
356 {%- endfor %}
357 ''')
358
359 irnode_h_template = env.from_string(
360 '''/* Warning: automatically generated code */
361
362 {% for node in nodes %}
363 #define is_{{node.name}}(node)    is_{{node.name}}_(node)
364 {%- endfor %}
365
366 {%- for node in nodes|isnot('custom_is') %}
367 static inline int is_{{node.name}}_(const ir_node *node)
368 {
369         return get_irn_op(node) == op_{{node.name}};
370 }
371 {%- endfor %}
372 ''')
373
374 irnode_template = env.from_string(
375 '''/* Warning: automatically generated code */
376 {% for node in nodes %}
377 int (is_{{node.name}})(const ir_node *node)
378 {
379         return is_{{node.name}}_(node);
380 }
381 {% endfor %}
382
383 {%- for node in nodes %}
384 {%- for attr in node.attrs|hasnot("noprop") %}
385 {{attr.type}} (get_{{node.name}}_{{attr.name}})(const ir_node *node)
386 {
387         assert(is_{{node.name}}(node));
388         return node->attr.{{node.attrs_name}}.{{attr.name}};
389 }
390
391 void (set_{{node.name}}_{{attr.name}})(ir_node *node, {{attr.type}} {{attr.name}})
392 {
393         assert(is_{{node.name}}(node));
394         node->attr.{{node.attrs_name}}.{{attr.name}} = {{attr.name}};
395 }
396 {% endfor -%}
397 {% endfor -%}
398
399 {%- for node in nodes %}
400 {%- for input in node.ins %}
401 ir_node *(get_{{node.name}}_{{input[0]}})(const ir_node *node)
402 {
403         assert(is_{{node.name}}(node));
404         return get_irn_n(node, n_{{node.name}}_{{input[0]}});
405 }
406
407 void (set_{{node.name}}_{{input[0]}})(ir_node *node, ir_node *{{input[0]|escape_keywords}})
408 {
409         assert(is_{{node.name}}(node));
410         set_irn_n(node, n_{{node.name}}_{{input[0]}}, {{input[0]|escape_keywords}});
411 }
412 {% endfor %}
413 {% endfor %}
414 ''')
415
416 irdump_template = env.from_string(
417 '''/* Warning: automatically generated code */
418 {% for node in nodes %}
419 {%- if node.outs %}
420 static const pns_lookup_t {{node.name}}_lut[] = {
421         {%- for out in node.outs %}
422         { pn_{{node.name}}_{{out[0]}}, "{{out[0]}}" },
423         {%- endfor %}
424 };
425 {% endif -%}
426 {%- endfor %}
427
428 static const proj_lookup_t proj_lut[] = {
429         {%- for node in nodes -%}
430         {%- if node.outs %}
431         { {{spec.name}}o_{{node.name}}, ARRAY_SIZE({{node.name}}_lut), {{node.name}}_lut },
432         {%- endif %}
433         {%- endfor %}
434 };
435
436 ''')
437
438 irop_template = env.from_string(
439 '''/* Warning: automatically generated code */
440 {% for node in nodes %}
441 ir_op *op_{{node.name}}; ir_op *get_op_{{node.name}}(void) { return op_{{node.name}}; }
442 {%- endfor %}
443
444 static void generated_init_op(void)
445 {
446         {%- for node in nodes %}
447         op_{{node.name}} = new_ir_op(
448                 {%- filter arguments %}
449                         {{spec.name}}o_{{node.name}}
450                         "{{node.name}}"
451                         {{node|pinned}}
452                         {{node|flags}}
453                         {{node|arity}}
454                         {{node|opindex}}
455                         {{node|attr_size}}
456                 {% endfilter %});
457         {%- if "uses_memory" in node.flags: %}
458         ir_op_set_memory_index(op_{{node.name}}, n_{{node.name}}_mem);
459         {%- endif -%}
460         {%- if "fragile" in node.flags: %}
461         ir_op_set_fragile_indices(op_{{node.name}}, pn_{{node.name}}_X_regular, pn_{{node.name}}_X_except);
462         {%- endif -%}
463         {%- endfor %}
464 }
465
466 static void generated_finish_op(void)
467 {
468         {%- for node in nodes %}
469         free_ir_op(op_{{node.name}}); op_{{node.name}} = NULL;
470         {%- endfor %}
471 }
472
473 ''')
474
475 nodeops_h_template = env.from_string(
476 '''/* Warning: automatically generated code */
477 #ifndef FIRM_IR_NODEOPS_H
478 #define FIRM_IR_NODEOPS_H
479
480 #include "firm_types.h"
481
482 #include "begin.h"
483
484 /**
485  * @addtogroup ir_node
486  * @{
487  */
488
489 {% for node in nodes -%}
490
491 /**
492  * @defgroup {{node.name}} {{node.name}} node
493  *
494  * {{node.doc}}
495  * @{
496  */
497 {% if node.ins %}
498 /**
499  * Input numbers for {{node.name}} node
500  */
501 typedef enum {
502         {%- for input in node.ins %}
503         n_{{node.name}}_{{input[0]}},
504         {%- endfor %}
505         n_{{node.name}}_max = n_{{node.name}}_{{node.ins[-1][0]}}
506 } n_{{node.name}};
507 {% endif %}
508 {% if node.outs %}
509 /**
510  * Projection numbers for result of {{node.name}} node (use for Proj nodes)
511  */
512 typedef enum {
513         {% for out in node.outs -%}
514         pn_{{node.name}}_{{out[0]}}
515         {%- if out.__len__() > 2 %} = {{out[2]}}{% endif %}, /**< {{out[1]}} */
516         {% endfor -%}
517         pn_{{node.name}}_max = pn_{{node.name}}_{{node.outs[-1][0]}}
518 } pn_{{node.name}};
519 {% endif %}
520 {%- if not node.noconstructor %}
521 /**
522  * Construct {{node.name|a_an}} node.
523  *
524  * @param dbgi      A pointer to debug information.
525 {{ node|blockparameterhelp -}}
526 {{ node|nodeparametershelp -}}
527  */
528 FIRM_API ir_node *new_rd_{{node.name}}(
529         {%- filter parameters %}
530                 dbg_info *dbgi
531                 {{node|blockparameter}}
532                 {{node|nodeparameters}}
533         {% endfilter %});
534
535 /**
536  * Construct {{node.name|a_an}} node.
537  *
538 {{ node|blockparameterhelp -}}
539 {{ node|nodeparametershelp -}}
540  */
541 FIRM_API ir_node *new_r_{{node.name}}(
542         {%- filter parameters %}
543                 {{node|blockparameter}}
544                 {{node|nodeparameters}}
545         {% endfilter %});
546
547 /**
548  * Construct {{node.name|a_an}} node.
549  *
550  * @param dbgi      A pointer to debug information.
551 {{ node|nodeparametershelp -}}
552  */
553 FIRM_API ir_node *new_d_{{node.name}}(
554         {%- filter parameters %}
555                 dbg_info *dbgi
556                 {{node|nodeparameters}}
557         {% endfilter %});
558
559 /**
560  * Construct {{node.name|a_an}} node.
561  *
562 {{ node|nodeparametershelp -}}
563  */
564 FIRM_API ir_node *new_{{node.name}}(
565         {%- filter parameters %}
566                 {{node|nodeparameters}}
567         {% endfilter %});
568 {%- endif %}
569 /**
570  * Test if node is a {{node.name}}
571  * @returns 1 if the node is a {{node.name}} node, 0 otherwise
572  */
573 FIRM_API int is_{{node.name}}(const ir_node *node);
574
575 {% for input in node.ins -%}
576 /** Returns {{input[0]}} input of {{node.name|a_an}} node. */
577 FIRM_API ir_node *get_{{node.name}}_{{input[0]}}(const ir_node *node);
578 /** Sets {{input[0]}} input of {{node.name|a_an}} node. */
579 FIRM_API void set_{{node.name}}_{{input[0]}}(ir_node *node, ir_node *{{input[0]|escape_keywords}});
580 {% endfor -%}
581 {% for attr in node.attrs|hasnot("noprop") -%}
582 /** Returns {{attr.name}} attribute of {{node.name|a_an}} node. */
583 FIRM_API {{attr.type}} get_{{node.name}}_{{attr.name}}(const ir_node *node);
584 /** Sets {{attr.name}} attribute of {{node.name|a_an}} node. */
585 FIRM_API void set_{{node.name}}_{{attr.name}}(ir_node *node, {{attr.type}} {{attr.name}});
586 {% endfor -%}
587 /** @} */
588
589 {% endfor -%}
590
591 /** @} */
592
593 #include "end.h"
594
595 #endif
596
597 ''')
598
599 opcodes_h_template = env.from_string(
600 '''/* Warning: automatically generated code */
601 #ifndef FIRM_IR_OPCODES_H
602 #define FIRM_IR_OPCODES_H
603
604 /** The opcodes of the libFirm predefined operations.
605  * @ingroup ir_op
606  */
607 typedef enum {{spec.name}}_opcode {
608 {%- for node in nodes %}
609         {{spec.name}}o_{{node.name}},
610 {%- endfor %}
611         {{spec.name}}o_First = {{spec.name}}o_{{nodes[0].name}},
612         {{spec.name}}o_Last  = {{spec.name}}o_{{nodes[-1].name}},
613
614 {%- if spec.name == "ir" %}
615         beo_First,
616         /* backend specific nodes */
617         beo_Spill = beo_First,
618         beo_Reload,
619         beo_Perm,
620         beo_MemPerm,
621         beo_Copy,
622         beo_Keep,
623         beo_CopyKeep,
624         beo_Call,
625         beo_Return,
626         beo_AddSP,
627         beo_SubSP,
628         beo_IncSP,
629         beo_Start,
630         beo_FrameAddr,
631         /* last backend node number */
632         beo_Last = beo_FrameAddr,
633 {%- endif %}
634         {{spec.name}}o_MaxOpcode
635 } {{spec.name}}_opcode;
636
637 {% for node in nodes %}
638 /**
639  * @ingroup {{node.name}}
640  * {{node.name}} opcode
641  */
642 FIRM_API ir_op *op_{{node.name}};
643 {%- endfor %}
644
645 {% for node in nodes %}
646 /**
647  * @ingroup {{node.name}}
648  * Returns opcode for {{node.name}} nodes.
649  */
650 FIRM_API ir_op *get_op_{{node.name}}(void);
651 {%- endfor %}
652
653 #endif
654
655 ''')
656
657 #############################
658
659 def prepare_nodes(nodes):
660         real_nodes = []
661         for node in nodes:
662                 if isAbstract(node):
663                         continue
664                 real_nodes.append(node)
665
666         for node in real_nodes:
667                 preprocess_node(node)
668
669         return real_nodes
670
671 def main(argv):
672         if len(argv) < 3:
673                 print "usage: %s specname(ignored) destdirectory" % argv[0]
674                 sys.exit(1)
675
676         specfile = argv[1]
677         spec = load_spec(specfile)
678         nodes = spec.nodes
679
680         gendir = argv[2]
681         # hardcoded path to libfirm/include/libfirm
682         if len(argv) > 3:
683                 gendir2 = argv[3]
684         else:
685                 gendir2 = argv[2] + "/../../include/libfirm"
686
687         real_nodes = prepare_nodes(nodes)
688
689         env.globals['nodes'] = real_nodes
690         env.globals['spec'] = spec
691
692         file = open(gendir + "/gen_ir_cons.c.inl", "w")
693         file.write(gen_ircons_c_inl_template.render())
694         file.close()
695
696         file = open(gendir + "/gen_irnode.h", "w")
697         file.write(irnode_h_template.render())
698         file.close()
699
700         file = open(gendir + "/gen_irnode.c.inl", "w")
701         file.write(irnode_template.render())
702         file.close()
703
704         file = open(gendir + "/gen_irop.c.inl", "w")
705         file.write(irop_template.render())
706         file.close()
707
708         file = open(gendir + "/gen_irdump.c.inl", "w")
709         file.write(irdump_template.render())
710         file.close()
711
712         file = open(gendir2 + "/opcodes.h", "w")
713         file.write(opcodes_h_template.render())
714         file.close()
715
716         file = open(gendir2 + "/nodeops.h", "w")
717         file.write(nodeops_h_template.render())
718         file.close()
719
720 main(sys.argv)