X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;f=scripts%2Fgen_ir.py;h=bd1105de62da61e0cbc1d73ef9d904123f25564a;hb=2fae02ed33d1d18ef852ccbee3b420bb600b0b41;hp=636bcfed14d0991226efab46a0228ce3984b04f4;hpb=54df083637219c3da80172bf8491fc0865c2ce54;p=libfirm

diff --git a/scripts/gen_ir.py b/scripts/gen_ir.py
index 636bcfed1..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"):
@@ -160,10 +179,13 @@ def format_parameters(string):
 	return format_arguments(string, voidwhenempty = True)
 
 env = Environment()
+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
@@ -182,12 +204,20 @@ 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")
@@ -196,21 +226,33 @@ def preprocess_node(node):
 	arguments = [ ]
 	initattrs = [ ]
 	for input in node.ins:
-		arguments.append(dict(type = "ir_node *", name = "irn_" + input[0]))
+		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"
 
 	for attr in node.attrs:
 		attr["fqname"] = "." + attr["name"]
-
-		if not "init" in attr:
-			arguments.append(prepare_attr(attr))
+		if "init" in attr:
+			continue
+		arguments.append(attr)
 
 	# dynamic pin state means more constructor arguments
 	if is_dynamic_pinned(node):
@@ -222,14 +264,20 @@ def preprocess_node(node):
 		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(
 				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))
@@ -282,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;
 }
@@ -338,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 %}
 
 ''')
@@ -356,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 %}
 
@@ -377,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}}
@@ -411,16 +480,19 @@ 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 %}
 }
@@ -434,12 +506,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)
@@ -449,30 +541,86 @@ 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 %});
 
-{% for node in nodes %}
-/** Return true of the node is a {{node.name}} node. */
+/**
+ * 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);
-{%- endfor %}
 
-{% for node in nodes %}
-{% for in in node.ins -%}
-FIRM_API ir_node *get_{{node.name}}_{{in[0]}}(const ir_node *node);
-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
+
 ''')
 
 opcodes_h_template = env.from_string(
@@ -480,7 +628,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}},
@@ -504,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
+
 ''')
 
 #############################
@@ -562,6 +720,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()