beifg: Let be_ifg_foreach_neighbour() declare the node variable.
[libfirm] / scripts / gen_ir.py
index 3696854..5b76e61 100755 (executable)
@@ -1,10 +1,8 @@
 #!/usr/bin/env python
 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 ir_spec import nodes
+from spec_util import is_dynamic_pinned, isAbstract, setdefault, load_spec
+from filters import format_arguments, filter_isnot, filter_hasnot, filter_notset
 
 def format_parameterlist(parameterlist):
        return "\n".join(parameterlist)
@@ -159,22 +157,6 @@ def format_escape_keywords(word):
                return word + "_"
        return word
 
-def filter_isnot(list, flag):
-       return filter(lambda x: not hasattr(x, flag), list)
-
-def filter_hasnot(list, flag):
-       return filter(lambda x: flag not in x, list)
-
-def format_arguments(string, voidwhenempty = False):
-       args = re.split('\s*\n\s*', string)
-       if args[0] == '':
-               args = args[1:]
-       if len(args) > 0 and args[-1] == '':
-               args = args[:-1]
-       if len(args) == 0 and voidwhenempty:
-               return "void"
-       return ", ".join(args)
-
 def format_parameters(string):
        return format_arguments(string, voidwhenempty = True)
 
@@ -216,8 +198,6 @@ def prepare_attr(attr):
                        comment = attr["comment"])
 
 def preprocess_node(node):
-       verify_node(node)
-
        setdefault(node, "attrs_name", node.name.lower())
        setdefault(node, "block", "block")
 
@@ -298,14 +278,10 @@ ir_node *new_rd_{{node.name}}(
                {{node|nodeparameters}}
        {% endfilter %})
 {
-       ir_node *res;
-       {%- if node.arity == "dynamic" %}
-       int      i;
-       {%- endif %}
        {{node|irgassign}}
        {{node|insdecl}}
 
-       res = new_ir_node(
+       ir_node *res = new_ir_node(
                {%- filter arguments %}
                        dbgi
                        irg
@@ -315,7 +291,7 @@ ir_node *new_rd_{{node.name}}(
                        {{node|arity_and_ins}}
                {% endfilter %});
        {%- if node.arity == "dynamic" %}
-       for (i = 0; i < arity; ++i) {
+       for (int i = 0; i < arity; ++i) {
                add_irn_n(res, in[i]);
        }
        {%- endif %}
@@ -329,8 +305,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;
 }
@@ -355,9 +331,8 @@ ir_node *new_d_{{node.name}}(
                        {{node|nodeparameters}}
                {% endfilter %})
 {
-       ir_node *res;
-       assert(get_irg_phase_state(current_ir_graph) == phase_building);
-       res = new_rd_{{node.name}}(
+       assert(irg_is_constrained(current_ir_graph, IR_GRAPH_CONSTRAINT_CONSTRUCTION));
+       ir_node *res = new_rd_{{node.name}}(
                {%- filter parameters %}
                        dbgi
                        {{node|curblock}}
@@ -384,18 +359,83 @@ ir_node *new_{{node.name}}(
 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)
+{% for node in nodes %}
+#define is_{{node.name}}(node) is_{{node.name}}_(node)
+{%- for attr in node.attrs|hasnot("noprop") %}
+#define get_{{node.name}}_{{attr.name}}(node) get_{{node.name}}_{{attr.name}}_(node)
+#define set_{{node.name}}_{{attr.name}}(node, {{attr.name}}) set_{{node.name}}_{{attr.name}}_(node, {{attr.name}})
+{%- endfor -%}
+{%- for input in node.ins %}
+#define get_{{node.name}}_{{input[0]}}(node) get_{{node.name}}_{{input[0]}}_(node)
+#define set_{{node.name}}_{{input[0]}}(node, {{input[0]|escape_keywords}}) set_{{node.name}}_{{input[0]}}_(node, {{input[0]|escape_keywords}})
+{%- endfor -%}
+{%- if node.input_name %}
+#define get_{{node.name}}_n_{{node.input_name}}s(node) get_{{node.name}}_n_{{node.input_name}}s_(node)
+#define get_{{node.name}}_{{node.input_name}}(node, pos) get_{{node.name}}_{{node.input_name}}_(node, pos)
+#define set_{{node.name}}_{{node.input_name}}(node, pos, {{node.input_name}}) set_{{node.name}}_{{node.input_name}}_(node, pos, {{node.input_name}})
+#define get_{{node.name}}_{{node.input_name}}_arr(node) get_{{node.name}}_{{node.input_name}}_arr_(node)
+{%- endif %}
+{% endfor %}
+
+{%- for node in nodes %}
+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}};
+}
+{%  for attr in node.attrs|hasnot("noprop") %}
+static inline {{attr.type}} get_{{node.name}}_{{attr.name}}_(const ir_node *node)
+{
+       assert(is_{{node.name}}(node));
+       return node->attr.{{node.attrs_name}}.{{attr.name}};
 }
-{%- endfor -%}
 
-{% for node in nodes %}
-#define is_{{node.name}}(node)    _is_{{node.name}}(node)
-{%- endfor %}
+static inline void set_{{node.name}}_{{attr.name}}_(ir_node *node, {{attr.type}} {{attr.name}})
+{
+       assert(is_{{node.name}}(node));
+       node->attr.{{node.attrs_name}}.{{attr.name}} = {{attr.name}};
+}
+{% endfor -%}
+
+{%- for input in node.ins %}
+static inline ir_node *get_{{node.name}}_{{input[0]}}_(const ir_node *node)
+{
+       assert(is_{{node.name}}(node));
+       return get_irn_n(node, n_{{node.name}}_{{input[0]}});
+}
+
+static inline void set_{{node.name}}_{{input[0]}}_(ir_node *node, ir_node *{{input[0]|escape_keywords}})
+{
+       assert(is_{{node.name}}(node));
+       set_irn_n(node, n_{{node.name}}_{{input[0]}}, {{input[0]|escape_keywords}});
+}
+{% endfor %}
+
+{%- if node.input_name %}
+static inline int get_{{node.name}}_n_{{node.input_name}}s_(ir_node const *node)
+{
+       assert(is_{{node.name}}(node));
+       return get_irn_arity(node){% if node.ins %} - (n_{{node.name}}_max + 1){% endif %};
+}
+
+static inline ir_node *get_{{node.name}}_{{node.input_name}}_(ir_node const *node, int pos)
+{
+       assert(0 <= pos && pos < get_{{node.name}}_n_{{node.input_name}}s(node));
+       return get_irn_n(node, pos{% if node.ins %} + (n_{{node.name}}_max + 1){% endif %});
+}
 
+static inline void set_{{node.name}}_{{node.input_name}}_(ir_node *node, int pos, ir_node *{{node.input_name}})
+{
+       assert(0 <= pos && pos < get_{{node.name}}_n_{{node.input_name}}s(node));
+       set_irn_n(node, pos{% if node.ins %} + (n_{{node.name}}_max + 1){% endif %}, {{node.input_name}});
+}
+
+static inline ir_node **get_{{node.name}}_{{node.input_name}}_arr_(ir_node *node)
+{
+       assert(is_{{node.name}}(node));
+       return get_irn_in(node) + 1{% if node.ins %}+ (n_{{node.name}}_max + 1){% endif %};
+}
+{% endif -%}
+{% endfor -%}
 ''')
 
 irnode_template = env.from_string(
@@ -403,74 +443,108 @@ 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 %}
-
-{%- for node in nodes %}
-{%- for attr in node.attrs|hasnot("noprop") %}
+{%  for attr in node.attrs|hasnot("noprop") %}
 {{attr.type}} (get_{{node.name}}_{{attr.name}})(const ir_node *node)
 {
-       assert(is_{{node.name}}(node));
-       return node->attr.{{node.attrs_name}}.{{attr.name}};
+       return get_{{node.name}}_{{attr.name}}_(node);
 }
 
 void (set_{{node.name}}_{{attr.name}})(ir_node *node, {{attr.type}} {{attr.name}})
 {
-       assert(is_{{node.name}}(node));
-       node->attr.{{node.attrs_name}}.{{attr.name}} = {{attr.name}};
+       set_{{node.name}}_{{attr.name}}_(node, {{attr.name}});
 }
 {% endfor -%}
-{% endfor -%}
-
-{%- for node in nodes %}
 {%- 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, n_{{node.name}}_{{input[0]}});
+       return get_{{node.name}}_{{input[0]}}(node);
 }
 
 void (set_{{node.name}}_{{input[0]}})(ir_node *node, ir_node *{{input[0]|escape_keywords}})
 {
-       assert(is_{{node.name}}(node));
-       set_irn_n(node, n_{{node.name}}_{{input[0]}}, {{input[0]|escape_keywords}});
+       set_{{node.name}}_{{input[0]}}_(node, {{input[0]|escape_keywords}});
 }
 {% endfor %}
+
+{%- if node.input_name %}
+int (get_{{node.name}}_n_{{node.input_name}}s)(ir_node const *node)
+{
+       return get_{{node.name}}_n_{{node.input_name}}s_(node);
+}
+
+ir_node *(get_{{node.name}}_{{node.input_name}})(ir_node const *node, int pos)
+{
+       return get_{{node.name}}_{{node.input_name}}_(node, pos);
+}
+
+void (set_{{node.name}}_{{node.input_name}})(ir_node *node, int pos, ir_node *{{node.input_name}})
+{
+       set_{{node.name}}_{{node.input_name}}_(node, pos, {{node.input_name}});
+}
+
+ir_node **(get_{{node.name}}_{{node.input_name}}_arr)(ir_node *node)
+{
+       return get_{{node.name}}_{{node.input_name}}_arr_(node);
+}
+{% endif -%}
 {% 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 %}
+       { {{spec.name}}o_{{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}}
+                       {{spec.name}}o_{{node.name}}
                        "{{node.name}}"
                        {{node|pinned}}
                        {{node|flags}}
                        {{node|arity}}
                        {{node|opindex}}
                        {{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}}, n_{{node.name}}_mem, pn_{{node.name}}_X_regular, pn_{{node.name}}_X_except);
+       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 %}
 }
@@ -484,12 +558,21 @@ 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
@@ -500,7 +583,7 @@ typedef enum {
        {%- endfor %}
        n_{{node.name}}_max = n_{{node.name}}_{{node.ins[-1][0]}}
 } n_{{node.name}};
-{% endif %}
+{% endif -%}
 {% if node.outs %}
 /**
  * Projection numbers for result of {{node.name}} node (use for Proj nodes)
@@ -513,9 +596,6 @@ typedef enum {
        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.
@@ -565,26 +645,44 @@ 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 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") -%}
+{%- if node.input_name -%}
+/** Get the number of {{node.name}} {{node.input_name}}s. */
+FIRM_API int get_{{node.name}}_n_{{node.input_name}}s(ir_node const *node);
+/** Get the {{node.name}} {{node.input_name}} with index @p pos. */
+FIRM_API ir_node *get_{{node.name}}_{{node.input_name}}(ir_node const *node, int pos);
+/** Set the {{node.name}} {{node.input_name}} with index @p pos. */
+FIRM_API void set_{{node.name}}_{{node.input_name}}(ir_node *node, int pos, ir_node *{{node.input_name}});
+/** Get an array of all {{node.name}} {{node.input_name}}s. */
+ir_node **get_{{node.name}}_{{node.input_name}}_arr(ir_node *node);
+{% endif -%}
+
+{%- 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
 
 ''')
@@ -594,14 +692,17 @@ opcodes_h_template = env.from_string(
 #ifndef FIRM_IR_OPCODES_H
 #define FIRM_IR_OPCODES_H
 
-/** The opcodes of the libFirm predefined operations. */
-typedef enum ir_opcode {
+/** The opcodes of the libFirm predefined operations.
+ * @ingroup ir_op
+ */
+typedef enum {{spec.name}}_opcode {
 {%- for node in nodes %}
-       iro_{{node.name}},
+       {{spec.name}}o_{{node.name}},
 {%- endfor %}
-       iro_First = iro_{{nodes[0].name}},
-       iro_Last = iro_{{nodes[-1].name}},
+       {{spec.name}}o_First = {{spec.name}}o_{{nodes[0].name}},
+       {{spec.name}}o_Last  = {{spec.name}}o_{{nodes[-1].name}},
 
+{%- if spec.name == "ir" %}
        beo_First,
        /* backend specific nodes */
        beo_Spill = beo_First,
@@ -620,14 +721,23 @@ typedef enum ir_opcode {
        beo_FrameAddr,
        /* last backend node number */
        beo_Last = beo_FrameAddr,
-       iro_MaxOpcode
-} ir_opcode;
+{%- endif %}
+       {{spec.name}}o_MaxOpcode
+} {{spec.name}}_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 %}
 
@@ -637,7 +747,7 @@ FIRM_API ir_op *get_op_{{node.name}}(void);
 
 #############################
 
-def prepare_nodes():
+def prepare_nodes(nodes):
        real_nodes = []
        for node in nodes:
                if isAbstract(node):
@@ -654,34 +764,48 @@ def main(argv):
                print "usage: %s specname(ignored) destdirectory" % argv[0]
                sys.exit(1)
 
+       specfile = argv[1]
+       spec = load_spec(specfile)
+       nodes = spec.nodes
+
        gendir = argv[2]
        # hardcoded path to libfirm/include/libfirm
-       gendir2 = argv[2] + "/../../include/libfirm"
+       if len(argv) > 3:
+               gendir2 = argv[3]
+       else:
+               gendir2 = argv[2] + "/../../include/libfirm"
 
-       real_nodes = prepare_nodes()
+       real_nodes = prepare_nodes(nodes)
+
+       env.globals['nodes'] = real_nodes
+       env.globals['spec'] = spec
 
        file = open(gendir + "/gen_ir_cons.c.inl", "w")
-       file.write(gen_ircons_c_inl_template.render(nodes = real_nodes))
+       file.write(gen_ircons_c_inl_template.render())
        file.close()
 
        file = open(gendir + "/gen_irnode.h", "w")
-       file.write(irnode_h_template.render(nodes = real_nodes))
+       file.write(irnode_h_template.render())
        file.close()
 
        file = open(gendir + "/gen_irnode.c.inl", "w")
-       file.write(irnode_template.render(nodes = real_nodes))
+       file.write(irnode_template.render())
        file.close()
 
        file = open(gendir + "/gen_irop.c.inl", "w")
-       file.write(irop_template.render(nodes = real_nodes))
+       file.write(irop_template.render())
+       file.close()
+
+       file = open(gendir + "/gen_irdump.c.inl", "w")
+       file.write(irdump_template.render())
        file.close()
 
        file = open(gendir2 + "/opcodes.h", "w")
-       file.write(opcodes_h_template.render(nodes = real_nodes))
+       file.write(opcodes_h_template.render())
        file.close()
 
        file = open(gendir2 + "/nodeops.h", "w")
-       file.write(nodeops_h_template.render(nodes = real_nodes))
+       file.write(nodeops_h_template.render())
        file.close()
 
 main(sys.argv)