support for local common symbols (whatever that is good for); introduce ir_visibility...
[libfirm] / scripts / gen_ir.py
index 3c5409b..98219f0 100755 (executable)
@@ -3,86 +3,84 @@ import sys
 import re
 from jinja2 import Environment, Template
 from jinja2.filters import do_dictsort
-from spec_util import is_dynamic_pinned, verify_node
+from spec_util import is_dynamic_pinned, verify_node, isAbstract, setdefault
 from ir_spec import nodes
 
 def format_argdecls(node, first = False, voidwhenempty = False):
-       if not node.has_key("args") or len(node["args"]) == 0:
+       if len(node.arguments) == 0:
                if voidwhenempty:
                        return "void"
                else:
                        return ""
 
+       arguments = map(lambda arg: arg["type"] + " " + arg["name"], node.arguments)
        res = ""
        if not first:
-               comma = ", "
-       else:
-               comma = ""
-       for arg in node["args"]:
-               res = res + (comma + arg["type"] + " " + arg["name"])
-               comma = ", "
+               res = ", "
+       res += ", ".join(arguments)
        return res
 
 def format_args(node, first = False):
-       if not node.has_key("args"):
-               return ""
-
        res = ""
-       if not first:
-               comma = ", "
-       else:
-               comma = ""
-       for arg in node["args"]:
-               res = res + (comma + arg["name"])
-               comma = ", "
+       if not first and node.arguments != []:
+               res = ", "
+
+       arguments = map(lambda arg: arg["name"], node.arguments)
+       res += ", ".join(arguments)
        return res
 
 def format_blockdecl(node):
-       if node.get("knownBlock"):
+       if hasattr(node, "knownBlock"):
+               return "ir_graph *irg"
+       else:
+               return "ir_node *block"
+
+def format_irgassign(node):
+       if hasattr(node, "knownBlock"):
                return ""
        else:
-               return ", ir_node *block"
+               return "ir_graph *irg = get_Block_irg(block);\n"
 
 def format_block(node):
-       if node.get("knownBlock"):
-               return ""
+       if hasattr(node, "knownBlock"):
+               return "irg"
        else:
-               return "block"
+               return "block"
 
 def format_curblock(node):
-       if node.get("knownBlock"):
-               return ""
+       if hasattr(node, "knownBlock"):
+               return "current_ir_graph"
        else:
-               return "current_ir_graph->current_block"
+               return "current_ir_graph->current_block"
 
 def format_insdecl(node):
-       arity = node["arity"]
-       if arity == "variable" and len(node["ins"]) == 0 or arity == "dynamic" or arity == 0:
+       arity = node.arity
+       if arity == "variable" and len(node.ins) == 0 or arity == "dynamic" or arity == 0:
                return ""
 
        if arity == "variable":
-               insarity = len(node["ins"])
+               insarity = len(node.ins)
                res = "int r_arity = arity + " + `insarity` + ";\n\tir_node **r_in;\n\t" \
                        + "NEW_ARR_A(ir_node *, r_in, r_arity);\n\t"
                i = 0
-               for input in node["ins"]:
+               for input in node.ins:
                        res += "r_in[" + `i` + "] = irn_" + input + ";\n\t"
                        i += 1
                res += "memcpy(&r_in[" + `insarity` + "], in, sizeof(ir_node *) * arity);\n\t"
        else:
                res = "ir_node *in[" + `arity` + "];\n\t"
                i = 0
-               for input in node["ins"]:
+               for input in node.ins:
                        res += "in[" + `i` + "] = irn_" + input + ";\n\t"
                        i += 1
        return res
 
 def format_arity_and_ins(node):
-       arity = node["arity"]
+       arity = node.arity
        if arity == "dynamic":
                return "-1, NULL"
        elif arity == "variable":
-               if len(node["ins"]) == 0:
+               if len(node.ins) == 0:
                        return "arity, in"
                else:
                        return "r_arity, r_in"
@@ -92,7 +90,9 @@ def format_arity_and_ins(node):
                return `arity` + ", in"
 
 def format_arity(node):
-       arity = node['arity']
+       if hasattr(node, "arity_override"):
+               return node.arity_override
+       arity = node.arity
        if arity == "dynamic":
                return "oparity_dynamic"
        if arity == "variable":
@@ -108,7 +108,7 @@ def format_arity(node):
        return "oparity_any"
 
 def format_pinned(node):
-       pinned = node["pinned"]
+       pinned = node.pinned
        if pinned == "yes":
                return "op_pin_state_pinned"
        if pinned == "no":
@@ -121,30 +121,36 @@ def format_pinned(node):
        return ""
 
 def format_flags(node):
-       flags = node['flags']
-       flags = re.split("\s*,\s*", flags)
-       flags = map(lambda x : "irop_flag_" + x, flags)
+       flags = map(lambda x : "irop_flag_" + x, node.flags)
+       if flags == []:
+               flags = [ "irop_flag_none" ]
        return " | ".join(flags)
 
 def format_attr_size(node):
-       if "attr_struct" not in node:
+       if not hasattr(node, "attr_struct"):
                return "0"
-       return "sizeof(%s)" % node['attr_struct']
+       return "sizeof(%s)" % node.attr_struct
+
+def format_opindex(node):
+       if hasattr(node, "op_index"):
+               return node.op_index
+       return "-1"
 
 def filter_isnot(list, flag):
        result = []
-       for nodename, node in list:
-               if flag in node:
+       for node in list:
+               if hasattr(node, flag):
                        continue
-               result.append((nodename, node))
+               result.append(node)
        return result
 
 env = Environment()
-env.filters['argdecls']  = format_argdecls
-env.filters['args']      = format_args
-env.filters['blockdecl'] = format_blockdecl
-env.filters['block']     = format_block
-env.filters['curblock']  = format_curblock
+env.filters['argdecls']      = format_argdecls
+env.filters['args']          = format_args
+env.filters['blockdecl']     = format_blockdecl
+env.filters['irgassign']     = format_irgassign
+env.filters['block']         = format_block
+env.filters['curblock']      = format_curblock
 env.filters['insdecl']       = format_insdecl
 env.filters['arity_and_ins'] = format_arity_and_ins
 env.filters['arity']         = format_arity
@@ -152,14 +158,7 @@ env.filters['pinned']        = format_pinned
 env.filters['flags']         = format_flags
 env.filters['attr_size']     = format_attr_size
 env.filters['isnot']         = filter_isnot
-
-def add_attr(list, type, name, init = None, initname = None):
-       if initname == None:
-               initname = "." + name
-       if init != None:
-               list.append(dict(type = type, name = name, init = init, initname = initname))
-       else:
-               list.append(dict(type = type, name = name, initname = initname))
+env.filters['opindex']       = format_opindex
 
 def prepare_attr(attr):
        if "init" in attr:
@@ -167,72 +166,48 @@ def prepare_attr(attr):
        else:
                return dict(type = attr["type"], name = attr["name"])
 
-def preprocess_node(nodename, node):
-       # set default attributes
-       if "is_a" in node:
-               parent = nodes[node["is_a"]]
-               node["ins"] = parent["ins"]
-               if "outs" in parent:
-                       node["outs"] = parent["outs"]
-
-       if "outs" in node:
-               node["mode"] = "mode_T"
-       node["db"] = "db"
-       node["dbdecl"] = "dbg_info *db, "
-       node["dbdeclnocomma"] = "dbg_info *db"
-
-       if "flags" not in node and "abstract" not in node:
-               print "WARNING: no flags specified for %s (you should say at least 'none')\n" % nodename
-
-       node.setdefault("ins", [])
-       node.setdefault("arity", len(node["ins"]))
-       node.setdefault("attrs", [])
-       node.setdefault("constrname", nodename);
-       node.setdefault("constructor_args", [])
-       node.setdefault("attrs_name", nodename.lower())
-       node.setdefault("block", "block")
-       node.setdefault("pinned", "no")
-       node.setdefault("flags", "none")
-
+def preprocess_node(node):
        verify_node(node)
 
+       setdefault(node, "attrs_name", node.name.lower())
+       setdefault(node, "block", "block")
 
        # construct node arguments
        arguments = [ ]
        initattrs = [ ]
        specialconstrs = [ ]
-       for input in node["ins"]:
+       for input in node.ins:
                arguments.append(dict(type = "ir_node *", name = "irn_" + input))
 
-       if node["arity"] == "variable" or node["arity"] == "dynamic":
+       if node.arity == "variable" or node.arity == "dynamic":
                arguments.append(dict(type = "int", name = "arity"))
                arguments.append(dict(type = "ir_node **", name = "in"))
 
-       if "mode" not in node:
+       if not hasattr(node, "mode"):
                arguments.append(dict(type = "ir_mode *", name = "mode"))
-               node["mode"] = "mode"
+               node.mode = "mode"
 
        attrs_with_special = 0
-       for attr in node["attrs"]:
+       for attr in node.attrs:
                attr.setdefault("initname", "." + attr["name"])
 
                if "special" in attr:
                        if not "init" in attr:
-                               print "Node type %s has an attribute with a \"special\" entry but without \"init\"" % nodename
+                               print "Node type %s has an attribute with a \"special\" entry but without \"init\"" % node.name
                                sys.exit(1)
 
                        if attrs_with_special != 0:
-                               print "Node type %s has more than one attribute with a \"special\" entry" % nodename
+                               print "Node type %s has more than one attribute with a \"special\" entry" % node.name
                                sys.exit(1)
 
                        attrs_with_special += 1
 
                        if "prefix" in attr["special"]:
-                               specialname = attr["special"]["prefix"] + nodename
+                               specialname = attr["special"]["prefix"] + node.name
                        elif "suffix" in attr["special"]:
-                               specialname = nodename + attr["special"]["suffix"]
+                               specialname = node.name + attr["special"]["suffix"]
                        else:
-                               print "Unknown special constructor type for node type %s" % nodename
+                               print "Unknown special constructor type for node type %s" % node.name
                                sys.exit(1)
 
                        specialconstrs.append(
@@ -246,13 +221,13 @@ def preprocess_node(nodename, node):
 
        # dynamic pin state means more constructor arguments
        if is_dynamic_pinned(node):
-               if "pinned_init" in node:
+               if hasattr(node, "pinned_init"):
                        initattrs.append(dict(
                                initname = ".exc.pin_state",
-                               init     = "op_pin_state_" + node["pinned_init"]
+                               init     = node.pinned_init
                        ))
                else:
-                       node["constructor_args"].append(
+                       node.constructor_args.append(
                                dict(
                                        name = "pin_state",
                                        type = "op_pin_state"
@@ -263,7 +238,7 @@ def preprocess_node(nodename, node):
                                init     = "pin_state"
                        ))
 
-       for arg in node["constructor_args"]:
+       for arg in node.constructor_args:
                arguments.append(prepare_attr(arg))
                if arg["type"] == "ir_cons_flags":
                        name = arg["name"]
@@ -274,32 +249,33 @@ def preprocess_node(nodename, node):
                        initattrs.append(dict(initname = ".aligned",
                                init = name + " & cons_unaligned ? align_non_aligned : align_is_aligned"))
 
-       node["args"] = arguments
-       node["initattrs"] = initattrs
-       node["special_constructors"] = specialconstrs
+       node.arguments = arguments
+       node.initattrs = initattrs
+       node.special_constructors = specialconstrs
 
 #############################
 
 constructor_template = env.from_string('''
 
-ir_node *new_rd_{{node["constrname"]}}({{node["dbdecl"]}}ir_graph *irg{{node|blockdecl}}{{node|argdecls}})
+ir_node *new_rd_{{node.constrname}}(dbg_info *dbgi, {{node|blockdecl}}{{node|argdecls}})
 {
        ir_node *res;
        ir_graph *rem = current_ir_graph;
+       {{node|irgassign}}
        {{node|insdecl}}
        current_ir_graph = irg;
-       res = new_ir_node({{node["db"]}}, irg, {{node["block"]}}, op_{{nodename}}, {{node["mode"]}}, {{node|arity_and_ins}});
-       {% for attr in node["attrs"] -%}
-               res->attr.{{node["attrs_name"]}}{{attr["initname"]}} =
+       res = new_ir_node(dbgi, irg, {{node.block}}, op_{{node.name}}, {{node.mode}}, {{node|arity_and_ins}});
+       {% for attr in node.attrs -%}
+               res->attr.{{node.attrs_name}}{{attr["initname"]}} =
                {%- if "init" in attr %} {{ attr["init"] -}};
                {%- else              %} {{ attr["name"] -}};
                {% endif %}
        {% endfor %}
-       {%- for attr in node["initattrs"] -%}
-               res->attr.{{node["attrs_name"]}}{{attr["initname"]}} = {{ attr["init"] -}};
+       {%- for attr in node.initattrs -%}
+               res->attr.{{node.attrs_name}}{{attr["initname"]}} = {{ attr["init"] -}};
        {%- endfor %}
-       {{- node["init"] }}
-       {% if node["optimize"] != False -%}
+       {{- node.init }}
+       {% if node.optimize != False -%}
                res = optimize_node(res);
        {% endif -%}
        IRN_VRFY_IRG(res, irg);
@@ -307,74 +283,76 @@ ir_node *new_rd_{{node["constrname"]}}({{node["dbdecl"]}}ir_graph *irg{{node|blo
        return res;
 }
 
-ir_node *new_r_{{node["constrname"]}}(ir_graph *irg{{node|blockdecl}}{{node|argdecls}})
+ir_node *new_r_{{node.constrname}}({{node|blockdecl}}{{node|argdecls}})
 {
-       {% if node["nodbginfo"] -%}
-               return new_rd_{{node["constrname"]}}(irg{{node|block}}{{node|args}});
-       {%- else -%}
-               return new_rd_{{node["constrname"]}}(NULL, irg{{node|block}}{{node|args}});
-       {%- endif %}
+       return new_rd_{{node.constrname}}(NULL, {{node|block}}{{node|args}});
 }
 
-ir_node *new_d_{{node["constrname"]}}({{node["dbdeclnocomma"]}}{{node|argdecls(node["nodbginfo"])}})
+ir_node *new_d_{{node.constrname}}(dbg_info *dbgi{{node|argdecls}})
 {
        ir_node *res;
-       {{ node["d_pre"] }}
-       {% if node["nodbginfo"] -%}
-               res = new_rd_{{node["constrname"]}}(current_ir_graph{{node|curblock}}{{node|args}});
-       {%- else -%}
-               res = new_rd_{{node["constrname"]}}(db, current_ir_graph{{node|curblock}}{{node|args}});
-       {%- endif %}
-       {{ node["d_post"] }}
+       {{ node.d_pre }}
+       res = new_rd_{{node.constrname}}(dbgi, {{node|curblock}}{{node|args}});
+       {{ node.d_post }}
        return res;
 }
 
-ir_node *new_{{node["constrname"]}}({{node|argdecls(True, True)}})
+ir_node *new_{{node.constrname}}({{node|argdecls(True, True)}})
 {
-       {% if node["nodbginfo"] -%}
-               return new_d_{{node["constrname"]}}({{node|args(True)}});
-       {%- else -%}
-               return new_d_{{node["constrname"]}}(NULL{{node|args}});
-       {%- endif %}
+       return new_d_{{node.constrname}}(NULL{{node|args}});
 }
 ''')
 
+# not used - as we have the pn_ declarations in libfirm/irnode.h where they
+# contain informative comments
+# {% for node in nodes %}
+# {% if node.outs %}
+# typedef enum {
+#      {%- for out in node.outs %}
+#      pn_{{node.name}}_{{out}},
+#      {%- endfor %}
+#      pn_{{node.name}}_max
+# } pn_{{node.name}};
+# {% endif %}
+# {% endfor %}
+
 irnode_h_template = env.from_string('''
 /* Warning: automatically generated code */
 
-{% for nodename, node in nodes|isnot('custom_is') %}
-static inline int _is_{{nodename}}(const ir_node *node)
+{% for node in nodes|isnot('custom_is') %}
+static inline int _is_{{node.name}}(const ir_node *node)
 {
        assert(node != NULL);
-       return _get_irn_op(node) == op_{{nodename}};
+       return _get_irn_op(node) == op_{{node.name}};
 }
 {% endfor %}
 
-{% for nodename, node in nodes %}
-#define is_{{nodename}}(node)    _is_{{nodename}}(node)
+{% for node in nodes %}
+#define is_{{node.name}}(node)    _is_{{node.name}}(node)
 {%- endfor %}
+
 ''')
 
 irnode_template = env.from_string('''
 /* Warning: automatically generated code */
-{% for nodename, node in nodes %}
-int (is_{{nodename}})(const ir_node *node)
+{% for node in nodes %}
+int (is_{{node.name}})(const ir_node *node)
 {
-       return _is_{{nodename}}(node);
+       return _is_{{node.name}}(node);
 }
 {% endfor %}
 ''')
 
 irop_template = env.from_string('''
 /* Warning: automatically generated code */
-{% for nodename, node in nodes %}
-ir_op *op_{{nodename}}; ir_op *get_op_{{nodename}}(void) { return op_{{nodename}}; }
+{% 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)
 {
-       {% for nodename, node in nodes %}
-       op_{{nodename}} = new_ir_op(iro_{{nodename}}, "{{nodename}}", {{node|pinned}}, {{node|flags}}, {{node|arity}}, -1, {{node|attr_size}}, NULL);
+       {% for node in nodes %}
+       op_{{node.name}} = new_ir_op(iro_{{node.name}}, "{{node.name}}", {{node|pinned}}, {{node|flags}}, {{node|arity}}, {{node|opindex}}, {{node|attr_size}}, NULL);
        {%- endfor %}
 
        be_init_op();
@@ -382,17 +360,16 @@ void init_op(void)
 
 void finish_op(void)
 {
-       {% for nodename, node in nodes %}
-       free_ir_op(op_{{nodename}}); op_{{nodename}} = NULL;
+       {% for node in nodes %}
+       free_ir_op(op_{{node.name}}); op_{{node.name}} = NULL;
        {%- endfor %}
 }
+
 ''')
 
 #############################
 
 def main(argv):
-       """the main function"""
-
        if len(argv) < 3:
                print "usage: %s specname(ignored) destdirectory" % argv[0]
                sys.exit(1)
@@ -400,33 +377,32 @@ def main(argv):
        gendir = argv[2]
 
        # List of TODOs
-       niymap = ["ASM", "CallBegin", "Const", "Const_type", "Const_long",
-               "defaultProj", "Dummy", "Phi", "simpleSel", "SymConst", "SymConst_type",
-               "Sync"]
+       niymap = [ "ASM", "Const", "Phi", "SymConst", "Sync"]
+
+       real_nodes = []
+       for node in nodes:
+               if isAbstract(node):
+                       continue
+               real_nodes.append(node)
 
        file = open(gendir + "/gen_ir_cons.c.inl", "w")
-       for nodename, node in do_dictsort(nodes):
-               preprocess_node(nodename, node)
-               if nodename in niymap:
+       for node in real_nodes:
+               preprocess_node(node)
+
+               if node.name in niymap:
                        continue
-               if "abstract" not in node and "singleton" not in node:
+
+               if not isAbstract(node) and not hasattr(node, "singleton"):
                        file.write(constructor_template.render(vars()))
 
-                       if "special_constructors" in node:
-                               for special in node["special_constructors"]:
-                                       node["constrname"] = special["constrname"]
+                       if hasattr(node, "special_constructors"):
+                               for special in node.special_constructors:
+                                       node.constrname = special["constrname"]
                                        special["attr"]["init"] = special["attr"]["special"]["init"]
                                        file.write(constructor_template.render(vars()))
        file.write("\n")
        file.close()
 
-       real_nodes = dict()
-       for nodename, node in nodes.iteritems():
-               if "abstract" in node:
-                       continue
-               real_nodes[nodename] = node
-       real_nodes = do_dictsort(real_nodes)
-
        file = open(gendir + "/gen_irnode.h", "w")
        file.write(irnode_h_template.render(nodes = real_nodes))
        file.close()
@@ -439,5 +415,4 @@ def main(argv):
        file.write(irop_template.render(nodes = real_nodes))
        file.close()
 
-if __name__ == "__main__":
-       main(sys.argv)
+main(sys.argv)