gen_docu: fix missing attributes, show generation time at the end
[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
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
221         setdefault(node, "attrs_name", node.name.lower())
222         setdefault(node, "block", "block")
223
224         # construct node arguments
225         arguments = [ ]
226         initattrs = [ ]
227         for input in node.ins:
228                 arguments.append(dict(
229                                 type    = "ir_node *",
230                                 name    = "irn_" + input[0],
231                                 comment = input[1]))
232
233         if node.arity == "variable" or node.arity == "dynamic":
234                 arguments.append(dict(
235                                 type    = "int",
236                                 name    = "arity",
237                                 comment = "size of additional inputs array"))
238                 arguments.append(dict(
239                                 type    = "ir_node *const *",
240                                 name    = "in",
241                                 comment = "additional inputs"))
242
243         if not hasattr(node, "mode"):
244                 arguments.append(dict(
245                                 type    = "ir_mode *",
246                                 name    = "mode",
247                                 comment = "mode of the operations result"))
248                 node.mode = "mode"
249
250         for attr in node.attrs:
251                 attr["fqname"] = "." + attr["name"]
252                 if "init" in attr:
253                         continue
254                 arguments.append(attr)
255
256         # dynamic pin state means more constructor arguments
257         if is_dynamic_pinned(node):
258                 if hasattr(node, "pinned_init"):
259                         initattrs.append(dict(
260                                 fqname = ".exc.pin_state",
261                                 init   = node.pinned_init
262                         ))
263                 else:
264                         node.constructor_args.append(
265                                 dict(
266                                         name    = "pin_state",
267                                         type    = "op_pin_state",
268                                         comment = "pinned state",
269                                 )
270                         )
271                         initattrs.append(dict(
272                                 fqname = ".exc.pin_state",
273                                 init   = "pin_state"
274                         ))
275         if hasattr(node, "throws_init"):
276                 initattrs.append(dict(
277                         fqname = ".exc.throws_exception",
278                         init   = node.throws_init
279                 ))
280
281         for arg in node.constructor_args:
282                 arguments.append(prepare_attr(arg))
283
284         node.arguments = arguments
285         node.initattrs = initattrs
286
287 #############################
288
289 gen_ircons_c_inl_template = env.from_string(
290 '''/* Warning: automatically generated code */
291
292 {%- for node in nodes %}
293 {%- if not node.noconstructor %}
294 ir_node *new_rd_{{node.name}}(
295         {%- filter parameters %}
296                 dbg_info *dbgi
297                 {{node|blockparameter}}
298                 {{node|nodeparameters}}
299         {% endfilter %})
300 {
301         ir_node *res;
302         {%- if node.arity == "dynamic" %}
303         int      i;
304         {%- endif %}
305         {{node|irgassign}}
306         {{node|insdecl}}
307
308         res = new_ir_node(
309                 {%- filter arguments %}
310                         dbgi
311                         irg
312                         {{node.block}}
313                         op_{{node.name}}
314                         {{node.mode}}
315                         {{node|arity_and_ins}}
316                 {% endfilter %});
317         {%- if node.arity == "dynamic" %}
318         for (i = 0; i < arity; ++i) {
319                 add_irn_n(res, in[i]);
320         }
321         {%- endif %}
322         {%- for attr in node.attrs %}
323         res->attr.{{node.attrs_name}}{{attr["fqname"]}} =
324                 {%- if "init" in attr %} {{ attr["init"] -}};
325                 {%- else              %} {{ attr["name"] -}};
326                 {%- endif %}
327         {%- endfor %}
328         {%- for attr in node.initattrs %}
329         res->attr.{{node.attrs_name}}{{attr["fqname"]}} = {{ attr["init"] -}};
330         {%- endfor %}
331         {{- node.init }}
332         irn_verify_irg(res, irg);
333         res = optimize_node(res);
334         {{- node.init_after_opt }}
335         return res;
336 }
337
338 ir_node *new_r_{{node.name}}(
339                 {%- filter parameters %}
340                         {{node|blockparameter}}
341                         {{node|nodeparameters}}
342                 {% endfilter %})
343 {
344         return new_rd_{{node.name}}(
345                 {%- filter arguments %}
346                         NULL
347                         {{node|blockargument}}
348                         {{node|nodearguments}}
349                 {% endfilter %});
350 }
351
352 ir_node *new_d_{{node.name}}(
353                 {%- filter parameters %}
354                         dbg_info *dbgi
355                         {{node|nodeparameters}}
356                 {% endfilter %})
357 {
358         ir_node *res;
359         assert(get_irg_phase_state(current_ir_graph) == phase_building);
360         res = new_rd_{{node.name}}(
361                 {%- filter parameters %}
362                         dbgi
363                         {{node|curblock}}
364                         {{node|nodearguments}}
365                 {% endfilter %});
366         return res;
367 }
368
369 ir_node *new_{{node.name}}(
370                 {%- filter parameters %}
371                         {{node|nodeparameters}}
372                 {% endfilter %})
373 {
374         return new_d_{{node.name}}(
375                 {%- filter arguments %}
376                         NULL
377                         {{node|nodearguments}}
378                 {% endfilter %});
379 }
380 {% endif %}
381 {%- endfor %}
382 ''')
383
384 irnode_h_template = env.from_string(
385 '''/* Warning: automatically generated code */
386
387 {%- for node in nodes|isnot('custom_is') %}
388 static inline int is_{{node.name}}_(const ir_node *node)
389 {
390         assert(node != NULL);
391         return get_irn_op_(node) == op_{{node.name}};
392 }
393 {%- endfor -%}
394
395 {% for node in nodes %}
396 #define is_{{node.name}}(node)    is_{{node.name}}_(node)
397 {%- endfor %}
398
399 ''')
400
401 irnode_template = env.from_string(
402 '''/* Warning: automatically generated code */
403 {% for node in nodes %}
404 int (is_{{node.name}})(const ir_node *node)
405 {
406         return is_{{node.name}}_(node);
407 }
408 {% endfor %}
409
410 {%- for node in nodes %}
411 {%- for attr in node.attrs|hasnot("noprop") %}
412 {{attr.type}} (get_{{node.name}}_{{attr.name}})(const ir_node *node)
413 {
414         assert(is_{{node.name}}(node));
415         return node->attr.{{node.attrs_name}}.{{attr.name}};
416 }
417
418 void (set_{{node.name}}_{{attr.name}})(ir_node *node, {{attr.type}} {{attr.name}})
419 {
420         assert(is_{{node.name}}(node));
421         node->attr.{{node.attrs_name}}.{{attr.name}} = {{attr.name}};
422 }
423 {% endfor -%}
424 {% endfor -%}
425
426 {%- for node in nodes %}
427 {%- for input in node.ins %}
428 ir_node *(get_{{node.name}}_{{input[0]}})(const ir_node *node)
429 {
430         assert(is_{{node.name}}(node));
431         return get_irn_n(node, n_{{node.name}}_{{input[0]}});
432 }
433
434 void (set_{{node.name}}_{{input[0]}})(ir_node *node, ir_node *{{input[0]|escape_keywords}})
435 {
436         assert(is_{{node.name}}(node));
437         set_irn_n(node, n_{{node.name}}_{{input[0]}}, {{input[0]|escape_keywords}});
438 }
439 {% endfor %}
440 {% endfor %}
441 ''')
442
443 irdump_template = env.from_string(
444 '''/* Warning: automatically generated code */
445 {% for node in nodes %}
446 {%- if node.outs %}
447 static const pns_lookup_t {{node.name}}_lut[] = {
448         {%- for out in node.outs %}
449         { pn_{{node.name}}_{{out[0]}}, "{{out[0]}}" },
450         {%- endfor %}
451 };
452 {% endif -%}
453 {%- endfor %}
454
455 static const proj_lookup_t proj_lut[] = {
456         {%- for node in nodes -%}
457         {%- if node.outs %}
458         { iro_{{node.name}}, ARRAY_SIZE({{node.name}}_lut), {{node.name}}_lut },
459         {%- endif %}
460         {%- endfor %}
461 };
462 ''')
463
464 irop_template = env.from_string(
465 '''/* Warning: automatically generated code */
466 {% for node in nodes %}
467 ir_op *op_{{node.name}}; ir_op *get_op_{{node.name}}(void) { return op_{{node.name}}; }
468 {%- endfor %}
469
470 void init_op(void)
471 {
472         {% for node in nodes %}
473         op_{{node.name}} = new_ir_op(
474                 {%- filter arguments %}
475                         iro_{{node.name}}
476                         "{{node.name}}"
477                         {{node|pinned}}
478                         {{node|flags}}
479                         {{node|arity}}
480                         {{node|opindex}}
481                         {{node|attr_size}}
482                         NULL
483                 {% endfilter %});
484         {%- if "fragile" in node.flags: %}
485         ir_op_set_fragile_indices(op_{{node.name}}, n_{{node.name}}_mem, pn_{{node.name}}_X_regular, pn_{{node.name}}_X_except);
486         {%- endif -%}
487         {%- endfor %}
488
489         be_init_op();
490 }
491
492 void finish_op(void)
493 {
494         {% for node in nodes %}
495         free_ir_op(op_{{node.name}}); op_{{node.name}} = NULL;
496         {%- endfor %}
497 }
498
499 ''')
500
501 nodeops_h_template = env.from_string(
502 '''/* Warning: automatically generated code */
503 #ifndef FIRM_IR_NODEOPS_H
504 #define FIRM_IR_NODEOPS_H
505
506 #include "firm_types.h"
507
508 #include "begin.h"
509
510 /**
511  * @addtogroup ir_node
512  * @{
513  */
514
515 {% for node in nodes -%}
516 {% if node.ins %}
517 /**
518  * Input numbers for {{node.name}} node
519  */
520 typedef enum {
521         {%- for input in node.ins %}
522         n_{{node.name}}_{{input[0]}},
523         {%- endfor %}
524         n_{{node.name}}_max = n_{{node.name}}_{{node.ins[-1][0]}}
525 } n_{{node.name}};
526 {% endif %}
527 {% if node.outs %}
528 /**
529  * Projection numbers for result of {{node.name}} node (use for Proj nodes)
530  */
531 typedef enum {
532         {% for out in node.outs -%}
533         pn_{{node.name}}_{{out[0]}}
534         {%- if out.__len__() > 2 %} = {{out[2]}}{% endif %}, /**< {{out[1]}} */
535         {% endfor -%}
536         pn_{{node.name}}_max = pn_{{node.name}}_{{node.outs[-1][0]}}
537 } pn_{{node.name}};
538 {% endif %}
539 {%- endfor %}
540
541 {% for node in nodes %}
542 {%- if not node.noconstructor %}
543 /**
544  * Construct {{node.name|a_an}} node.
545  *
546  * @param dbgi      A pointer to debug information.
547 {{ node|blockparameterhelp -}}
548 {{ node|nodeparametershelp -}}
549  */
550 FIRM_API ir_node *new_rd_{{node.name}}(
551         {%- filter parameters %}
552                 dbg_info *dbgi
553                 {{node|blockparameter}}
554                 {{node|nodeparameters}}
555         {% endfilter %});
556
557 /**
558  * Construct {{node.name|a_an}} node.
559  *
560 {{ node|blockparameterhelp -}}
561 {{ node|nodeparametershelp -}}
562  */
563 FIRM_API ir_node *new_r_{{node.name}}(
564         {%- filter parameters %}
565                 {{node|blockparameter}}
566                 {{node|nodeparameters}}
567         {% endfilter %});
568
569 /**
570  * Construct {{node.name|a_an}} node.
571  *
572  * @param dbgi      A pointer to debug information.
573 {{ node|nodeparametershelp -}}
574  */
575 FIRM_API ir_node *new_d_{{node.name}}(
576         {%- filter parameters %}
577                 dbg_info *dbgi
578                 {{node|nodeparameters}}
579         {% endfilter %});
580
581 /**
582  * Construct {{node.name|a_an}} node.
583  *
584 {{ node|nodeparametershelp -}}
585  */
586 FIRM_API ir_node *new_{{node.name}}(
587         {%- filter parameters %}
588                 {{node|nodeparameters}}
589         {% endfilter %});
590 {%- endif %}
591 {% endfor %}
592
593 {% for node in nodes %}
594 /** Return true if the node is a {{node.name}} node. */
595 FIRM_API int is_{{node.name}}(const ir_node *node);
596 {%- endfor %}
597
598 {% for node in nodes %}
599 {% for input in node.ins -%}
600 FIRM_API ir_node *get_{{node.name}}_{{input[0]}}(const ir_node *node);
601 FIRM_API void set_{{node.name}}_{{input[0]}}(ir_node *node, ir_node *{{input[0]|escape_keywords}});
602 {% endfor -%}
603 {% for attr in node.attrs|hasnot("noprop") -%}
604 FIRM_API {{attr.type}} get_{{node.name}}_{{attr.name}}(const ir_node *node);
605 FIRM_API void set_{{node.name}}_{{attr.name}}(ir_node *node, {{attr.type}} {{attr.name}});
606 {% endfor -%}
607 {% endfor -%}
608
609 /** @} */
610
611 #include "end.h"
612
613 #endif
614
615 ''')
616
617 opcodes_h_template = env.from_string(
618 '''/* Warning: automatically generated code */
619 #ifndef FIRM_IR_OPCODES_H
620 #define FIRM_IR_OPCODES_H
621
622 /** The opcodes of the libFirm predefined operations. */
623 typedef enum ir_opcode {
624 {%- for node in nodes %}
625         iro_{{node.name}},
626 {%- endfor %}
627         iro_First = iro_{{nodes[0].name}},
628         iro_Last = iro_{{nodes[-1].name}},
629
630         beo_First,
631         /* backend specific nodes */
632         beo_Spill = beo_First,
633         beo_Reload,
634         beo_Perm,
635         beo_MemPerm,
636         beo_Copy,
637         beo_Keep,
638         beo_CopyKeep,
639         beo_Call,
640         beo_Return,
641         beo_AddSP,
642         beo_SubSP,
643         beo_IncSP,
644         beo_Start,
645         beo_FrameAddr,
646         /* last backend node number */
647         beo_Last = beo_FrameAddr,
648         iro_MaxOpcode
649 } ir_opcode;
650
651 {% for node in nodes %}
652 FIRM_API ir_op *op_{{node.name}};
653 {%- endfor %}
654
655 {% for node in nodes %}
656 FIRM_API ir_op *get_op_{{node.name}}(void);
657 {%- endfor %}
658
659 #endif
660
661 ''')
662
663 #############################
664
665 def prepare_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         gendir = argv[2]
683         # hardcoded path to libfirm/include/libfirm
684         gendir2 = argv[2] + "/../../include/libfirm"
685
686         real_nodes = prepare_nodes()
687
688         file = open(gendir + "/gen_ir_cons.c.inl", "w")
689         file.write(gen_ircons_c_inl_template.render(nodes = real_nodes))
690         file.close()
691
692         file = open(gendir + "/gen_irnode.h", "w")
693         file.write(irnode_h_template.render(nodes = real_nodes))
694         file.close()
695
696         file = open(gendir + "/gen_irnode.c.inl", "w")
697         file.write(irnode_template.render(nodes = real_nodes))
698         file.close()
699
700         file = open(gendir + "/gen_irop.c.inl", "w")
701         file.write(irop_template.render(nodes = real_nodes))
702         file.close()
703
704         file = open(gendir + "/gen_irdump.c.inl", "w")
705         file.write(irdump_template.render(nodes = real_nodes))
706         file.close()
707
708         file = open(gendir2 + "/opcodes.h", "w")
709         file.write(opcodes_h_template.render(nodes = real_nodes))
710         file.close()
711
712         file = open(gendir2 + "/nodeops.h", "w")
713         file.write(nodeops_h_template.render(nodes = real_nodes))
714         file.close()
715
716 main(sys.argv)