X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;f=scripts%2Fgen_ir.py;h=bd1105de62da61e0cbc1d73ef9d904123f25564a;hb=2fae02ed33d1d18ef852ccbee3b420bb600b0b41;hp=a86792899d8dbfda024c9a058c7ac6d70c773818;hpb=604fda632cfbe469ea8d8a43fbecdcace308588a;p=libfirm diff --git a/scripts/gen_ir.py b/scripts/gen_ir.py index a86792899..bd1105de6 100755 --- a/scripts/gen_ir.py +++ b/scripts/gen_ir.py @@ -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): @@ -17,6 +17,17 @@ def format_nodeparameters(node): parameters = map(lambda arg: arg["type"] + " " + arg["name"], node.arguments) return format_parameterlist(parameters) +def format_nodeparametershelp(node): + res = "" + for param in node.arguments: + res += " * @param %-9s %s\n" % (param["name"], param["comment"]) + return res + +def format_a_an(text): + if text[0] in "aAeEuUoOiI": + return "an " + text + return "a " + text + def format_blockparameter(node): if hasattr(node, "knownBlock"): if hasattr(node, "knownGraph"): @@ -25,6 +36,14 @@ def format_blockparameter(node): else: return "ir_node *block" +def format_blockparameterhelp(node): + if hasattr(node, "knownBlock"): + if hasattr(node, "knownGraph"): + return "" + return " * @param irg The IR graph the node belongs to.\n" + else: + return " * @param block The IR block the node belongs to.\n" + def format_blockargument(node): if hasattr(node, "knownBlock"): if hasattr(node, "knownGraph"): @@ -40,7 +59,7 @@ def format_irgassign(node): if hasattr(node, "knownBlock"): return "" else: - return "ir_graph *irg = get_Block_irg(block);\n" + return "ir_graph *irg = get_irn_irg(block);\n" def format_curblock(node): if hasattr(node, "knownBlock"): @@ -62,14 +81,14 @@ def format_insdecl(node): res += "\n\tNEW_ARR_A(ir_node *, r_in, r_arity);" i = 0 for input in node.ins: - res += "\n\tr_in[" + `i` + "] = irn_" + input + ";" + res += "\n\tr_in[" + `i` + "] = irn_" + input[0] + ";" i += 1 res += "\n\tmemcpy(&r_in[" + `insarity` + "], in, sizeof(ir_node *) * arity);\n\t" else: res = "ir_node *in[" + `arity` + "];" i = 0 for input in node.ins: - res += "\n\tin[" + `i` + "] = irn_" + input + ";" + res += "\n\tin[" + `i` + "] = irn_" + input[0] + ";" i += 1 return res @@ -134,6 +153,12 @@ def format_opindex(node): return node.op_index return "-1" +keywords = frozenset([ "true", "false" ]) +def format_escape_keywords(word): + if word in keywords: + return word + "_" + return word + def filter_isnot(list, flag): return filter(lambda x: not hasattr(x, flag), list) @@ -154,33 +179,45 @@ def format_parameters(string): return format_arguments(string, voidwhenempty = True) env = Environment() -env.filters['parameterlist'] = format_parameterlist -env.filters['nodearguments'] = format_nodearguments -env.filters['nodeparameters'] = format_nodeparameters -env.filters['blockparameter'] = format_blockparameter -env.filters['blockargument'] = format_blockargument -env.filters['irgassign'] = format_irgassign -env.filters['curblock'] = format_curblock -env.filters['insdecl'] = format_insdecl -env.filters['arity_and_ins'] = format_arity_and_ins -env.filters['arity'] = format_arity -env.filters['pinned'] = format_pinned -env.filters['flags'] = format_flags -env.filters['attr_size'] = format_attr_size -env.filters['opindex'] = format_opindex -env.filters['isnot'] = filter_isnot -env.filters['hasnot'] = filter_hasnot -env.filters['arguments'] = format_arguments -env.filters['parameters'] = format_parameters +env.filters['a_an'] = format_a_an +env.filters['parameterlist'] = format_parameterlist +env.filters['nodearguments'] = format_nodearguments +env.filters['nodeparameters'] = format_nodeparameters +env.filters['nodeparametershelp'] = format_nodeparametershelp +env.filters['blockparameter'] = format_blockparameter +env.filters['blockparameterhelp'] = format_blockparameterhelp +env.filters['blockargument'] = format_blockargument +env.filters['irgassign'] = format_irgassign +env.filters['curblock'] = format_curblock +env.filters['insdecl'] = format_insdecl +env.filters['arity_and_ins'] = format_arity_and_ins +env.filters['arity'] = format_arity +env.filters['pinned'] = format_pinned +env.filters['flags'] = format_flags +env.filters['attr_size'] = format_attr_size +env.filters['opindex'] = format_opindex +env.filters['isnot'] = filter_isnot +env.filters['hasnot'] = filter_hasnot +env.filters['arguments'] = format_arguments +env.filters['parameters'] = format_parameters +env.filters['escape_keywords'] = format_escape_keywords def prepare_attr(attr): if "init" in attr: - return dict(type = attr["type"], name = attr["name"], init = attr["init"]) + return dict( + type = attr["type"], + name = attr["name"], + init = attr["init"], + comment = attr["comment"]) else: - return dict(type = attr["type"], name = attr["name"]) + return dict( + type = attr["type"], + name = attr["name"], + comment = attr["comment"]) def preprocess_node(node): verify_node(node) + node.doc = trim_docstring(node.__doc__) setdefault(node, "attrs_name", node.name.lower()) setdefault(node, "block", "block") @@ -188,89 +225,74 @@ def preprocess_node(node): # construct node arguments arguments = [ ] initattrs = [ ] - specialconstrs = [ ] for input in node.ins: - arguments.append(dict(type = "ir_node *", name = "irn_" + input)) + arguments.append(dict( + type = "ir_node *", + name = "irn_" + input[0], + comment = input[1])) if node.arity == "variable" or node.arity == "dynamic": - arguments.append(dict(type = "int", name = "arity")) - arguments.append(dict(type = "ir_node **", name = "in")) + arguments.append(dict( + type = "int", + name = "arity", + comment = "size of additional inputs array")) + arguments.append(dict( + type = "ir_node *const *", + name = "in", + comment = "additional inputs")) if not hasattr(node, "mode"): - arguments.append(dict(type = "ir_mode *", name = "mode")) + arguments.append(dict( + type = "ir_mode *", + name = "mode", + comment = "mode of the operations result")) node.mode = "mode" - attrs_with_special = 0 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\"" % node.name - sys.exit(1) - - if attrs_with_special != 0: - 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"] + node.name - elif "suffix" in attr["special"]: - specialname = node.name + attr["special"]["suffix"] - else: - print "Unknown special constructor type for node type %s" % node.name - sys.exit(1) - - specialconstrs.append( - dict( - constrname = specialname, - attr = attr - ) - ) - elif not "init" in attr: - arguments.append(prepare_attr(attr)) + attr["fqname"] = "." + attr["name"] + if "init" in attr: + continue + arguments.append(attr) # dynamic pin state means more constructor arguments if is_dynamic_pinned(node): if hasattr(node, "pinned_init"): initattrs.append(dict( - initname = ".exc.pin_state", - init = node.pinned_init + fqname = ".exc.pin_state", + init = node.pinned_init )) else: node.constructor_args.append( dict( - name = "pin_state", - type = "op_pin_state" + name = "pin_state", + type = "op_pin_state", + comment = "pinned state", ) ) initattrs.append(dict( - initname = ".exc.pin_state", - init = "pin_state" + 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)) - if arg["type"] == "ir_cons_flags": - name = arg["name"] - initattrs.append(dict(initname = ".exc.pin_state", - init = name + " & cons_floats ? op_pin_state_floats : op_pin_state_pinned")) - initattrs.append(dict(initname = ".volatility", - init = name + " & cons_volatile ? volatility_is_volatile : volatility_non_volatile")) - initattrs.append(dict(initname = ".aligned", - init = name + " & cons_unaligned ? align_non_aligned : align_is_aligned")) node.arguments = arguments node.initattrs = initattrs - node.special_constructors = specialconstrs ############################# -constructor_template = env.from_string(''' +gen_ircons_c_inl_template = env.from_string( +'''/* Warning: automatically generated code */ -ir_node *new_rd_{{node.constrname}}( +{%- for node in nodes %} +{%- if not node.noconstructor %} +ir_node *new_rd_{{node.name}}( {%- filter parameters %} dbg_info *dbgi {{node|blockparameter}} @@ -278,10 +300,12 @@ ir_node *new_rd_{{node.constrname}}( {% endfilter %}) { ir_node *res; - ir_graph *rem = current_ir_graph; + {%- if node.arity == "dynamic" %} + int i; + {%- endif %} {{node|irgassign}} {{node|insdecl}} - current_ir_graph = irg; + res = new_ir_node( {%- filter arguments %} dbgi @@ -291,31 +315,34 @@ ir_node *new_rd_{{node.constrname}}( {{node.mode}} {{node|arity_and_ins}} {% endfilter %}); + {%- if node.arity == "dynamic" %} + for (i = 0; i < arity; ++i) { + add_irn_n(res, in[i]); + } + {%- endif %} {%- for attr in node.attrs %} - res->attr.{{node.attrs_name}}{{attr["initname"]}} = + res->attr.{{node.attrs_name}}{{attr["fqname"]}} = {%- 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"] -}}; + res->attr.{{node.attrs_name}}{{attr["fqname"]}} = {{ attr["init"] -}}; {%- endfor %} {{- node.init }} - {%- if node.optimize != False %} + irn_verify_irg(res, irg); res = optimize_node(res); - {%- endif %} - IRN_VRFY_IRG(res, irg); - current_ir_graph = rem; + {{- node.init_after_opt }} return res; } -ir_node *new_r_{{node.constrname}}( +ir_node *new_r_{{node.name}}( {%- filter parameters %} {{node|blockparameter}} {{node|nodeparameters}} {% endfilter %}) { - return new_rd_{{node.constrname}}( + return new_rd_{{node.name}}( {%- filter arguments %} NULL {{node|blockargument}} @@ -323,61 +350,61 @@ ir_node *new_r_{{node.constrname}}( {% endfilter %}); } -ir_node *new_d_{{node.constrname}}( +ir_node *new_d_{{node.name}}( {%- filter parameters %} dbg_info *dbgi {{node|nodeparameters}} {% endfilter %}) { ir_node *res; - res = new_rd_{{node.constrname}}( + assert(get_irg_phase_state(current_ir_graph) == phase_building); + res = new_rd_{{node.name}}( {%- filter parameters %} dbgi {{node|curblock}} {{node|nodearguments}} {% endfilter %}); - {%- if "fragile" in node.flags %} - firm_alloc_frag_arr(res, op_{{node.name}}, &res->attr.except.frag_arr); - {%- endif %} return res; } -ir_node *new_{{node.constrname}}( +ir_node *new_{{node.name}}( {%- filter parameters %} {{node|nodeparameters}} {% endfilter %}) { - return new_d_{{node.constrname}}( + return new_d_{{node.name}}( {%- filter arguments %} NULL {{node|nodearguments}} {% endfilter %}); } +{% endif %} +{%- endfor %} ''') -irnode_h_template = env.from_string(''' -/* Warning: automatically generated code */ +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 %} ''') -irnode_template = env.from_string(''' -/* Warning: automatically generated code */ +irnode_template = env.from_string( +'''/* Warning: automatically generated code */ {% for node in nodes %} int (is_{{node.name}})(const ir_node *node) { - return _is_{{node.name}}(node); + return is_{{node.name}}_(node); } {% endfor %} @@ -398,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}})(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}})(ir_node *node, ir_node *{{in}}) +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}}); + set_irn_n(node, n_{{node.name}}_{{input[0]}}, {{input[0]|escape_keywords}}); } {% endfor %} {% endfor %} ''') -irop_template = env.from_string(''' -/* Warning: automatically generated code */ +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}} @@ -432,26 +480,58 @@ void init_op(void) {{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}}, 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 %} } ''') -projnumbers_h_template = env.from_string(''' -/* Warning: automatically generated code */ +nodeops_h_template = env.from_string( +'''/* Warning: automatically generated code */ +#ifndef FIRM_IR_NODEOPS_H +#define FIRM_IR_NODEOPS_H + +#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) @@ -461,19 +541,96 @@ 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 %} +{%- if not node.noconstructor %} +/** + * Construct {{node.name|a_an}} node. + * + * @param dbgi A pointer to debug information. +{{ node|blockparameterhelp -}} +{{ node|nodeparametershelp -}} + */ +FIRM_API ir_node *new_rd_{{node.name}}( + {%- filter parameters %} + dbg_info *dbgi + {{node|blockparameter}} + {{node|nodeparameters}} + {% endfilter %}); + +/** + * Construct {{node.name|a_an}} node. + * +{{ node|blockparameterhelp -}} +{{ node|nodeparametershelp -}} + */ +FIRM_API ir_node *new_r_{{node.name}}( + {%- filter parameters %} + {{node|blockparameter}} + {{node|nodeparameters}} + {% endfilter %}); + +/** + * Construct {{node.name|a_an}} node. + * + * @param dbgi A pointer to debug information. +{{ node|nodeparametershelp -}} + */ +FIRM_API ir_node *new_d_{{node.name}}( + {%- filter parameters %} + dbg_info *dbgi + {{node|nodeparameters}} + {% endfilter %}); + +/** + * Construct {{node.name|a_an}} node. + * +{{ node|nodeparametershelp -}} + */ +FIRM_API ir_node *new_{{node.name}}( + {%- filter parameters %} + {{node|nodeparameters}} + {% endfilter %}); +{%- endif %} +/** + * 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); + +{% 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 ''') -opcodes_h_template = env.from_string(''' -/* Warning: automatically generated code */ +opcodes_h_template = env.from_string( +'''/* Warning: automatically generated code */ #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}}, @@ -497,21 +654,29 @@ typedef enum ir_opcode { beo_IncSP, beo_Start, beo_FrameAddr, - beo_Barrier, /* last backend node number */ - beo_Last = beo_Barrier, + beo_Last = beo_FrameAddr, iro_MaxOpcode } 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 %} #endif + ''') ############################# @@ -537,24 +702,10 @@ def main(argv): # hardcoded path to libfirm/include/libfirm gendir2 = argv[2] + "/../../include/libfirm" - # List of TODOs - niymap = [ "ASM", "Const", "Phi", "SymConst", "Sync"] - real_nodes = prepare_nodes() - file = open(gendir + "/gen_ir_cons.c.inl", "w") - for node in real_nodes: - if node.name in niymap: - continue - - if not isAbstract(node) and not hasattr(node, "singleton"): - file.write(constructor_template.render(vars())) - 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 = open(gendir + "/gen_ir_cons.c.inl", "w") + file.write(gen_ircons_c_inl_template.render(nodes = real_nodes)) file.close() file = open(gendir + "/gen_irnode.h", "w") @@ -569,12 +720,16 @@ def main(argv): file.write(irop_template.render(nodes = real_nodes)) file.close() - file = open(gendir2 + "/projnumbers.h", "w") - file.write(projnumbers_h_template.render(nodes = real_nodes)) + 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() + file = open(gendir2 + "/nodeops.h", "w") + file.write(nodeops_h_template.render(nodes = real_nodes)) + file.close() + main(sys.argv)