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