Control flow optimization: Merge consecutive blocks.
[libfirm] / scripts / gen_ir.py
index 47bf618..fe3d4db 100755 (executable)
@@ -3,7 +3,7 @@ import sys
 import re
 from jinja2 import Environment, Template
 from jinja2.filters import do_dictsort
-from spec_util import is_dynamic_pinned, verify_node, isAbstract, setdefault
+from spec_util import is_dynamic_pinned, verify_node, isAbstract, setdefault, trim_docstring
 from ir_spec import nodes
 
 def format_parameterlist(parameterlist):
@@ -217,6 +217,7 @@ def prepare_attr(attr):
 
 def preprocess_node(node):
        verify_node(node)
+       node.doc = trim_docstring(node.__doc__)
 
        setdefault(node, "attrs_name", node.name.lower())
        setdefault(node, "block", "block")
@@ -272,6 +273,11 @@ def preprocess_node(node):
                                fqname = ".exc.pin_state",
                                init   = "pin_state"
                        ))
+       if hasattr(node, "throws_init"):
+               initattrs.append(dict(
+                       fqname = ".exc.throws_exception",
+                       init   = node.throws_init
+               ))
 
        for arg in node.constructor_args:
                arguments.append(prepare_attr(arg))
@@ -324,8 +330,8 @@ ir_node *new_rd_{{node.name}}(
        res->attr.{{node.attrs_name}}{{attr["fqname"]}} = {{ attr["init"] -}};
        {%- endfor %}
        {{- node.init }}
-       res = optimize_node(res);
        irn_verify_irg(res, irg);
+       res = optimize_node(res);
        {{- node.init_after_opt }}
        return res;
 }
@@ -380,15 +386,15 @@ irnode_h_template = env.from_string(
 '''/* Warning: automatically generated code */
 
 {%- for node in nodes|isnot('custom_is') %}
-static inline int _is_{{node.name}}(const ir_node *node)
+static inline int is_{{node.name}}_(const ir_node *node)
 {
        assert(node != NULL);
-       return _get_irn_op(node) == op_{{node.name}};
+       return get_irn_op_(node) == op_{{node.name}};
 }
 {%- endfor -%}
 
 {% for node in nodes %}
-#define is_{{node.name}}(node)    _is_{{node.name}}(node)
+#define is_{{node.name}}(node)    is_{{node.name}}_(node)
 {%- endfor %}
 
 ''')
@@ -398,7 +404,7 @@ irnode_template = env.from_string(
 {% for node in nodes %}
 int (is_{{node.name}})(const ir_node *node)
 {
-       return _is_{{node.name}}(node);
+       return is_{{node.name}}_(node);
 }
 {% endfor %}
 
@@ -419,31 +425,52 @@ void (set_{{node.name}}_{{attr.name}})(ir_node *node, {{attr.type}} {{attr.name}
 {% endfor -%}
 
 {%- for node in nodes %}
-{%- for in in node.ins %}
-ir_node *(get_{{node.name}}_{{in[0]}})(const ir_node *node)
+{%- for input in node.ins %}
+ir_node *(get_{{node.name}}_{{input[0]}})(const ir_node *node)
 {
        assert(is_{{node.name}}(node));
-       return get_irn_n(node, {{node.ins.index(in)}});
+       return get_irn_n(node, n_{{node.name}}_{{input[0]}});
 }
 
-void (set_{{node.name}}_{{in[0]}})(ir_node *node, ir_node *{{in[0]|escape_keywords}})
+void (set_{{node.name}}_{{input[0]}})(ir_node *node, ir_node *{{input[0]|escape_keywords}})
 {
        assert(is_{{node.name}}(node));
-       set_irn_n(node, {{node.ins.index(in)}}, {{in[0]|escape_keywords}});
+       set_irn_n(node, n_{{node.name}}_{{input[0]}}, {{input[0]|escape_keywords}});
 }
 {% endfor %}
 {% endfor %}
 ''')
 
+irdump_template = env.from_string(
+'''/* Warning: automatically generated code */
+{% for node in nodes %}
+{%- if node.outs %}
+static const pns_lookup_t {{node.name}}_lut[] = {
+       {%- for out in node.outs %}
+       { pn_{{node.name}}_{{out[0]}}, "{{out[0]}}" },
+       {%- endfor %}
+};
+{% endif -%}
+{%- endfor %}
+
+static const proj_lookup_t proj_lut[] = {
+       {%- for node in nodes -%}
+       {%- if node.outs %}
+       { iro_{{node.name}}, ARRAY_SIZE({{node.name}}_lut), {{node.name}}_lut },
+       {%- endif %}
+       {%- endfor %}
+};
+''')
+
 irop_template = env.from_string(
 '''/* Warning: automatically generated code */
 {% for node in nodes %}
 ir_op *op_{{node.name}}; ir_op *get_op_{{node.name}}(void) { return op_{{node.name}}; }
 {%- endfor %}
 
-void init_op(void)
+static void generated_init_op(void)
 {
-       {% for node in nodes %}
+       {%- for node in nodes %}
        op_{{node.name}} = new_ir_op(
                {%- filter arguments %}
                        iro_{{node.name}}
@@ -455,14 +482,18 @@ void init_op(void)
                        {{node|attr_size}}
                        NULL
                {% endfilter %});
+       {%- if "uses_memory" in node.flags: %}
+       ir_op_set_memory_index(op_{{node.name}}, n_{{node.name}}_mem);
+       {%- endif -%}
+       {%- if "fragile" in node.flags: %}
+       ir_op_set_fragile_indices(op_{{node.name}}, pn_{{node.name}}_X_regular, pn_{{node.name}}_X_except);
+       {%- endif -%}
        {%- endfor %}
-
-       be_init_op();
 }
 
-void finish_op(void)
+static void generated_finish_op(void)
 {
-       {% for node in nodes %}
+       {%- for node in nodes %}
        free_ir_op(op_{{node.name}}); op_{{node.name}} = NULL;
        {%- endfor %}
 }
@@ -476,12 +507,32 @@ nodeops_h_template = env.from_string(
 
 #include "firm_types.h"
 
+#include "begin.h"
+
 /**
  * @addtogroup ir_node
  * @{
  */
 
 {% for node in nodes -%}
+
+/**
+ * @defgroup {{node.name}} {{node.name}} node
+ *
+ * {{node.doc}}
+ * @{
+ */
+{% if node.ins %}
+/**
+ * Input numbers for {{node.name}} node
+ */
+typedef enum {
+       {%- for input in node.ins %}
+       n_{{node.name}}_{{input[0]}},
+       {%- endfor %}
+       n_{{node.name}}_max = n_{{node.name}}_{{node.ins[-1][0]}}
+} n_{{node.name}};
+{% endif %}
 {% if node.outs %}
 /**
  * Projection numbers for result of {{node.name}} node (use for Proj nodes)
@@ -491,12 +542,9 @@ typedef enum {
        pn_{{node.name}}_{{out[0]}}
        {%- if out.__len__() > 2 %} = {{out[2]}}{% endif %}, /**< {{out[1]}} */
        {% endfor -%}
-       pn_{{node.name}}_max
+       pn_{{node.name}}_max = pn_{{node.name}}_{{node.outs[-1][0]}}
 } pn_{{node.name}};
 {% endif %}
-{%- endfor %}
-
-{% for node in nodes %}
 {%- if not node.noconstructor %}
 /**
  * Construct {{node.name|a_an}} node.
@@ -546,26 +594,32 @@ FIRM_API ir_node *new_{{node.name}}(
                {{node|nodeparameters}}
        {% endfilter %});
 {%- endif %}
-{% endfor %}
-
-{% for node in nodes %}
-/** Return true of the node is a {{node.name}} node. */
+/**
+ * Test if node is a {{node.name}}
+ * @returns 1 if the node is a {{node.name}} node, 0 otherwise
+ */
 FIRM_API int is_{{node.name}}(const ir_node *node);
-{%- endfor %}
 
-{% for node in nodes %}
-{% for in in node.ins -%}
-FIRM_API ir_node *get_{{node.name}}_{{in[0]}}(const ir_node *node);
-FIRM_API void set_{{node.name}}_{{in[0]}}(ir_node *node, ir_node *{{in[0]|escape_keywords}});
+{% for input in node.ins -%}
+/** Returns {{input[0]}} input of {{node.name|a_an}} node. */
+FIRM_API ir_node *get_{{node.name}}_{{input[0]}}(const ir_node *node);
+/** Sets {{input[0]}} input of {{node.name|a_an}} node. */
+FIRM_API void set_{{node.name}}_{{input[0]}}(ir_node *node, ir_node *{{input[0]|escape_keywords}});
 {% endfor -%}
 {% for attr in node.attrs|hasnot("noprop") -%}
+/** Returns {{attr.name}} attribute of {{node.name|a_an}} node. */
 FIRM_API {{attr.type}} get_{{node.name}}_{{attr.name}}(const ir_node *node);
+/** Sets {{attr.name}} attribute of {{node.name|a_an}} node. */
 FIRM_API void set_{{node.name}}_{{attr.name}}(ir_node *node, {{attr.type}} {{attr.name}});
 {% endfor -%}
+/** @} */
+
 {% endfor -%}
 
 /** @} */
 
+#include "end.h"
+
 #endif
 
 ''')
@@ -575,7 +629,9 @@ opcodes_h_template = env.from_string(
 #ifndef FIRM_IR_OPCODES_H
 #define FIRM_IR_OPCODES_H
 
-/** The opcodes of the libFirm predefined operations. */
+/** The opcodes of the libFirm predefined operations.
+ * @ingroup ir_op
+ */
 typedef enum ir_opcode {
 {%- for node in nodes %}
        iro_{{node.name}},
@@ -605,10 +661,18 @@ typedef enum ir_opcode {
 } ir_opcode;
 
 {% for node in nodes %}
+/**
+ * @ingroup {{node.name}}
+ * {{node.name}} opcode
+ */
 FIRM_API ir_op *op_{{node.name}};
 {%- endfor %}
 
 {% for node in nodes %}
+/**
+ * @ingroup {{node.name}}
+ * Returns opcode for {{node.name}} nodes.
+ */
 FIRM_API ir_op *get_op_{{node.name}}(void);
 {%- endfor %}
 
@@ -657,6 +721,10 @@ def main(argv):
        file.write(irop_template.render(nodes = real_nodes))
        file.close()
 
+       file = open(gendir + "/gen_irdump.c.inl", "w")
+       file.write(irdump_template.render(nodes = real_nodes))
+       file.close()
+
        file = open(gendir2 + "/opcodes.h", "w")
        file.write(opcodes_h_template.render(nodes = real_nodes))
        file.close()