3 # This file is part of libFirm.
4 # Copyright (C) 2012 Karlsruhe Institute of Technology.
6 from jinja2 import Environment, Template
7 from spec_util import is_dynamic_pinned, isAbstract, setdefault, load_spec
8 from filters import format_arguments, filter_isnot, filter_hasnot, filter_notset
10 def format_parameterlist(parameterlist):
11 return "\n".join(parameterlist)
13 def format_nodearguments(node):
14 arguments = map(lambda arg: arg["name"], node.arguments)
15 return format_parameterlist(arguments)
17 def format_nodeparameters(node):
18 parameters = map(lambda arg: arg["type"] + " " + arg["name"], node.arguments)
19 return format_parameterlist(parameters)
21 def format_nodeparametershelp(node):
23 for param in node.arguments:
24 res += " * @param %-9s %s\n" % (param["name"], param["comment"])
27 def format_a_an(text):
28 if text[0] in "aAeEuUoOiI":
32 def format_blockparameter(node):
33 if hasattr(node, "knownBlock"):
34 if hasattr(node, "knownGraph"):
36 return "ir_graph *irg"
38 return "ir_node *block"
40 def format_blockparameterhelp(node):
41 if hasattr(node, "knownBlock"):
42 if hasattr(node, "knownGraph"):
44 return " * @param irg The IR graph the node belongs to.\n"
46 return " * @param block The IR block the node belongs to.\n"
48 def format_blockargument(node):
49 if hasattr(node, "knownBlock"):
50 if hasattr(node, "knownGraph"):
56 def format_irgassign(node):
57 if hasattr(node, "knownGraph"):
58 return "ir_graph *irg = %s;\n" % node.graph
60 if hasattr(node, "knownBlock"):
63 return "ir_graph *irg = get_irn_irg(block);\n"
65 def format_curblock(node):
66 if hasattr(node, "knownBlock"):
67 if hasattr(node, "knownGraph"):
69 return "current_ir_graph"
71 return "current_ir_graph->current_block"
73 def format_insdecl(node):
75 if arity == "variable" and len(node.ins) == 0 or arity == "dynamic" or arity == 0:
78 if arity == "variable":
79 insarity = len(node.ins)
80 res = "int r_arity = arity + " + `insarity` + ";"
81 res += "\n\tir_node **r_in;"
82 res += "\n\tNEW_ARR_A(ir_node *, r_in, r_arity);"
84 for input in node.ins:
85 res += "\n\tr_in[" + `i` + "] = irn_" + input[0] + ";"
87 res += "\n\tmemcpy(&r_in[" + `insarity` + "], in, sizeof(ir_node *) * arity);\n\t"
89 res = "ir_node *in[" + `arity` + "];"
91 for input in node.ins:
92 res += "\n\tin[" + `i` + "] = irn_" + input[0] + ";"
96 def format_arity_and_ins(node):
98 if arity == "dynamic":
100 elif arity == "variable":
101 if len(node.ins) == 0:
104 return "r_arity, r_in"
108 return `arity` + ", in"
110 def format_arity(node):
111 if hasattr(node, "arity_override"):
112 return node.arity_override
114 if arity == "dynamic":
115 return "oparity_dynamic"
116 if arity == "variable":
117 return "oparity_variable"
119 return "oparity_zero"
121 return "oparity_unary"
123 return "oparity_binary"
125 return "oparity_trinary"
128 def format_pinned(node):
131 return "op_pin_state_pinned"
133 return "op_pin_state_floats"
134 if pinned == "exception":
135 return "op_pin_state_exc_pinned"
136 if pinned == "memory":
137 return "op_pin_state_mem_pinned"
138 print "WARNING: Unknown pinned state %s in format pined" % pinned
141 def format_flags(node):
142 flags = map(lambda x : "irop_flag_" + x, node.flags)
144 flags = [ "irop_flag_none" ]
145 return " | ".join(flags)
147 def format_attr_size(node):
148 if not hasattr(node, "attr_struct"):
150 return "sizeof(%s)" % node.attr_struct
152 def format_opindex(node):
153 if hasattr(node, "op_index"):
157 keywords = frozenset([ "true", "false" ])
158 def format_escape_keywords(word):
163 def format_parameters(string):
164 return format_arguments(string, voidwhenempty = True)
167 env.filters['a_an'] = format_a_an
168 env.filters['parameterlist'] = format_parameterlist
169 env.filters['nodearguments'] = format_nodearguments
170 env.filters['nodeparameters'] = format_nodeparameters
171 env.filters['nodeparametershelp'] = format_nodeparametershelp
172 env.filters['blockparameter'] = format_blockparameter
173 env.filters['blockparameterhelp'] = format_blockparameterhelp
174 env.filters['blockargument'] = format_blockargument
175 env.filters['irgassign'] = format_irgassign
176 env.filters['curblock'] = format_curblock
177 env.filters['insdecl'] = format_insdecl
178 env.filters['arity_and_ins'] = format_arity_and_ins
179 env.filters['arity'] = format_arity
180 env.filters['pinned'] = format_pinned
181 env.filters['flags'] = format_flags
182 env.filters['attr_size'] = format_attr_size
183 env.filters['opindex'] = format_opindex
184 env.filters['isnot'] = filter_isnot
185 env.filters['hasnot'] = filter_hasnot
186 env.filters['arguments'] = format_arguments
187 env.filters['parameters'] = format_parameters
188 env.filters['escape_keywords'] = format_escape_keywords
190 def prepare_attr(attr):
196 comment = attr["comment"])
201 comment = attr["comment"])
203 def preprocess_node(node):
204 setdefault(node, "attrs_name", node.name.lower())
205 setdefault(node, "block", "block")
207 # construct node arguments
210 for input in node.ins:
211 arguments.append(dict(
213 name = "irn_" + input[0],
216 if node.arity == "variable" or node.arity == "dynamic":
217 arguments.append(dict(
220 comment = "size of additional inputs array"))
221 arguments.append(dict(
222 type = "ir_node *const *",
224 comment = "additional inputs"))
226 if not hasattr(node, "mode"):
227 arguments.append(dict(
230 comment = "mode of the operations result"))
233 for attr in node.attrs:
234 attr["fqname"] = "." + attr["name"]
237 arguments.append(attr)
239 # dynamic pin state means more constructor arguments
240 if is_dynamic_pinned(node):
241 if hasattr(node, "pinned_init"):
242 initattrs.append(dict(
243 fqname = ".exc.pin_state",
244 init = node.pinned_init
247 node.constructor_args.append(
250 type = "op_pin_state",
251 comment = "pinned state",
254 initattrs.append(dict(
255 fqname = ".exc.pin_state",
258 if hasattr(node, "throws_init"):
259 initattrs.append(dict(
260 fqname = ".exc.throws_exception",
261 init = node.throws_init
264 for arg in node.constructor_args:
265 arguments.append(prepare_attr(arg))
267 node.arguments = arguments
268 node.initattrs = initattrs
270 #############################
272 gen_ircons_c_inl_template = env.from_string(
273 '''/* Warning: automatically generated code */
275 {%- for node in nodes %}
276 {%- if not node.noconstructor %}
277 ir_node *new_rd_{{node.name}}(
278 {%- filter parameters %}
280 {{node|blockparameter}}
281 {{node|nodeparameters}}
287 ir_node *res = new_ir_node(
288 {%- filter arguments %}
294 {{node|arity_and_ins}}
296 {%- if node.arity == "dynamic" %}
297 for (int i = 0; i < arity; ++i) {
298 add_irn_n(res, in[i]);
301 {%- for attr in node.attrs %}
302 res->attr.{{node.attrs_name}}{{attr["fqname"]}} =
303 {%- if "init" in attr %} {{ attr["init"] -}};
304 {%- else %} {{ attr["name"] -}};
307 {%- for attr in node.initattrs %}
308 res->attr.{{node.attrs_name}}{{attr["fqname"]}} = {{ attr["init"] -}};
311 irn_verify_irg(res, irg);
312 res = optimize_node(res);
313 {{- node.init_after_opt }}
317 ir_node *new_r_{{node.name}}(
318 {%- filter parameters %}
319 {{node|blockparameter}}
320 {{node|nodeparameters}}
323 return new_rd_{{node.name}}(
324 {%- filter arguments %}
326 {{node|blockargument}}
327 {{node|nodearguments}}
331 ir_node *new_d_{{node.name}}(
332 {%- filter parameters %}
334 {{node|nodeparameters}}
337 assert(irg_is_constrained(current_ir_graph, IR_GRAPH_CONSTRAINT_CONSTRUCTION));
338 ir_node *res = new_rd_{{node.name}}(
339 {%- filter parameters %}
342 {{node|nodearguments}}
347 ir_node *new_{{node.name}}(
348 {%- filter parameters %}
349 {{node|nodeparameters}}
352 return new_d_{{node.name}}(
353 {%- filter arguments %}
355 {{node|nodearguments}}
362 irnode_h_template = env.from_string(
363 '''/* Warning: automatically generated code */
365 {% for node in nodes %}
366 #define is_{{node.name}}(node) is_{{node.name}}_(node)
367 {%- for attr in node.attrs|hasnot("noprop") %}
368 #define get_{{node.name}}_{{attr.name}}(node) get_{{node.name}}_{{attr.name}}_(node)
369 #define set_{{node.name}}_{{attr.name}}(node, {{attr.name}}) set_{{node.name}}_{{attr.name}}_(node, {{attr.name}})
371 {%- for input in node.ins %}
372 #define get_{{node.name}}_{{input[0]}}(node) get_{{node.name}}_{{input[0]}}_(node)
373 #define set_{{node.name}}_{{input[0]}}(node, {{input[0]|escape_keywords}}) set_{{node.name}}_{{input[0]}}_(node, {{input[0]|escape_keywords}})
375 {%- if node.input_name %}
376 #define get_{{node.name}}_n_{{node.input_name}}s(node) get_{{node.name}}_n_{{node.input_name}}s_(node)
377 #define get_{{node.name}}_{{node.input_name}}(node, pos) get_{{node.name}}_{{node.input_name}}_(node, pos)
378 #define set_{{node.name}}_{{node.input_name}}(node, pos, {{node.input_name}}) set_{{node.name}}_{{node.input_name}}_(node, pos, {{node.input_name}})
379 #define get_{{node.name}}_{{node.input_name}}_arr(node) get_{{node.name}}_{{node.input_name}}_arr_(node)
383 {%- for node in nodes %}
384 static inline int is_{{node.name}}_(const ir_node *node)
386 return get_irn_op(node) == op_{{node.name}};
388 {% for attr in node.attrs|hasnot("noprop") %}
389 static inline {{attr.type}} get_{{node.name}}_{{attr.name}}_(const ir_node *node)
391 assert(is_{{node.name}}(node));
392 return node->attr.{{node.attrs_name}}.{{attr.name}};
395 static inline void set_{{node.name}}_{{attr.name}}_(ir_node *node, {{attr.type}} {{attr.name}})
397 assert(is_{{node.name}}(node));
398 node->attr.{{node.attrs_name}}.{{attr.name}} = {{attr.name}};
402 {%- for input in node.ins %}
403 static inline ir_node *get_{{node.name}}_{{input[0]}}_(const ir_node *node)
405 assert(is_{{node.name}}(node));
406 return get_irn_n(node, n_{{node.name}}_{{input[0]}});
409 static inline void set_{{node.name}}_{{input[0]}}_(ir_node *node, ir_node *{{input[0]|escape_keywords}})
411 assert(is_{{node.name}}(node));
412 set_irn_n(node, n_{{node.name}}_{{input[0]}}, {{input[0]|escape_keywords}});
416 {%- if node.input_name %}
417 static inline int get_{{node.name}}_n_{{node.input_name}}s_(ir_node const *node)
419 assert(is_{{node.name}}(node));
420 return get_irn_arity(node){% if node.ins %} - (n_{{node.name}}_max + 1){% endif %};
423 static inline ir_node *get_{{node.name}}_{{node.input_name}}_(ir_node const *node, int pos)
425 assert(0 <= pos && pos < get_{{node.name}}_n_{{node.input_name}}s(node));
426 return get_irn_n(node, pos{% if node.ins %} + (n_{{node.name}}_max + 1){% endif %});
429 static inline void set_{{node.name}}_{{node.input_name}}_(ir_node *node, int pos, ir_node *{{node.input_name}})
431 assert(0 <= pos && pos < get_{{node.name}}_n_{{node.input_name}}s(node));
432 set_irn_n(node, pos{% if node.ins %} + (n_{{node.name}}_max + 1){% endif %}, {{node.input_name}});
435 static inline ir_node **get_{{node.name}}_{{node.input_name}}_arr_(ir_node *node)
437 assert(is_{{node.name}}(node));
438 return get_irn_in(node) + 1{% if node.ins %}+ (n_{{node.name}}_max + 1){% endif %};
444 irnode_template = env.from_string(
445 '''/* Warning: automatically generated code */
446 {% for node in nodes %}
447 int (is_{{node.name}})(const ir_node *node)
449 return is_{{node.name}}_(node);
451 {% for attr in node.attrs|hasnot("noprop") %}
452 {{attr.type}} (get_{{node.name}}_{{attr.name}})(const ir_node *node)
454 return get_{{node.name}}_{{attr.name}}_(node);
457 void (set_{{node.name}}_{{attr.name}})(ir_node *node, {{attr.type}} {{attr.name}})
459 set_{{node.name}}_{{attr.name}}_(node, {{attr.name}});
462 {%- for input in node.ins %}
463 ir_node *(get_{{node.name}}_{{input[0]}})(const ir_node *node)
465 return get_{{node.name}}_{{input[0]}}(node);
468 void (set_{{node.name}}_{{input[0]}})(ir_node *node, ir_node *{{input[0]|escape_keywords}})
470 set_{{node.name}}_{{input[0]}}_(node, {{input[0]|escape_keywords}});
474 {%- if node.input_name %}
475 int (get_{{node.name}}_n_{{node.input_name}}s)(ir_node const *node)
477 return get_{{node.name}}_n_{{node.input_name}}s_(node);
480 ir_node *(get_{{node.name}}_{{node.input_name}})(ir_node const *node, int pos)
482 return get_{{node.name}}_{{node.input_name}}_(node, pos);
485 void (set_{{node.name}}_{{node.input_name}})(ir_node *node, int pos, ir_node *{{node.input_name}})
487 set_{{node.name}}_{{node.input_name}}_(node, pos, {{node.input_name}});
490 ir_node **(get_{{node.name}}_{{node.input_name}}_arr)(ir_node *node)
492 return get_{{node.name}}_{{node.input_name}}_arr_(node);
498 irdump_template = env.from_string(
499 '''/* Warning: automatically generated code */
500 {% for node in nodes %}
502 static const pns_lookup_t {{node.name}}_lut[] = {
503 {%- for out in node.outs %}
504 { pn_{{node.name}}_{{out[0]}}, "{{out[0]}}" },
510 static const proj_lookup_t proj_lut[] = {
511 {%- for node in nodes -%}
513 { {{spec.name}}o_{{node.name}}, ARRAY_SIZE({{node.name}}_lut), {{node.name}}_lut },
520 irop_template = env.from_string(
521 '''/* Warning: automatically generated code */
522 {% for node in nodes %}
523 ir_op *op_{{node.name}}; ir_op *get_op_{{node.name}}(void) { return op_{{node.name}}; }
526 static void generated_init_op(void)
528 {%- for node in nodes %}
529 op_{{node.name}} = new_ir_op(
530 {%- filter arguments %}
531 {{spec.name}}o_{{node.name}}
539 {%- if "uses_memory" in node.flags: %}
540 ir_op_set_memory_index(op_{{node.name}}, n_{{node.name}}_mem);
542 {%- if "fragile" in node.flags: %}
543 ir_op_set_fragile_indices(op_{{node.name}}, pn_{{node.name}}_X_regular, pn_{{node.name}}_X_except);
548 static void generated_finish_op(void)
550 {%- for node in nodes %}
551 free_ir_op(op_{{node.name}}); op_{{node.name}} = NULL;
557 nodeops_h_template = env.from_string(
558 '''/* Warning: automatically generated code */
559 #ifndef FIRM_IR_NODEOPS_H
560 #define FIRM_IR_NODEOPS_H
562 #include "firm_types.h"
567 * @addtogroup ir_node
571 {% for node in nodes -%}
574 * @defgroup {{node.name}} {{node.name}} node
581 * Input numbers for {{node.name}} node
584 {%- for input in node.ins %}
585 n_{{node.name}}_{{input[0]}},
587 n_{{node.name}}_max = n_{{node.name}}_{{node.ins[-1][0]}}
592 * Projection numbers for result of {{node.name}} node (use for Proj nodes)
595 {% for out in node.outs -%}
596 pn_{{node.name}}_{{out[0]}}
597 {%- if out.__len__() > 2 %} = {{out[2]}}{% endif %}, /**< {{out[1]}} */
599 pn_{{node.name}}_max = pn_{{node.name}}_{{node.outs[-1][0]}}
602 {%- if not node.noconstructor %}
604 * Construct {{node.name|a_an}} node.
606 * @param dbgi A pointer to debug information.
607 {{ node|blockparameterhelp -}}
608 {{ node|nodeparametershelp -}}
610 FIRM_API ir_node *new_rd_{{node.name}}(
611 {%- filter parameters %}
613 {{node|blockparameter}}
614 {{node|nodeparameters}}
618 * Construct {{node.name|a_an}} node.
620 {{ node|blockparameterhelp -}}
621 {{ node|nodeparametershelp -}}
623 FIRM_API ir_node *new_r_{{node.name}}(
624 {%- filter parameters %}
625 {{node|blockparameter}}
626 {{node|nodeparameters}}
630 * Construct {{node.name|a_an}} node.
632 * @param dbgi A pointer to debug information.
633 {{ node|nodeparametershelp -}}
635 FIRM_API ir_node *new_d_{{node.name}}(
636 {%- filter parameters %}
638 {{node|nodeparameters}}
642 * Construct {{node.name|a_an}} node.
644 {{ node|nodeparametershelp -}}
646 FIRM_API ir_node *new_{{node.name}}(
647 {%- filter parameters %}
648 {{node|nodeparameters}}
653 * Test if node is a {{node.name}}
654 * @returns 1 if the node is a {{node.name}} node, 0 otherwise
656 FIRM_API int is_{{node.name}}(const ir_node *node);
658 {% for input in node.ins -%}
659 /** Returns {{input[0]}} input of {{node.name|a_an}} node. */
660 FIRM_API ir_node *get_{{node.name}}_{{input[0]}}(const ir_node *node);
661 /** Sets {{input[0]}} input of {{node.name|a_an}} node. */
662 FIRM_API void set_{{node.name}}_{{input[0]}}(ir_node *node, ir_node *{{input[0]|escape_keywords}});
664 {%- if node.input_name -%}
665 /** Get the number of {{node.name}} {{node.input_name}}s. */
666 FIRM_API int get_{{node.name}}_n_{{node.input_name}}s(ir_node const *node);
667 /** Get the {{node.name}} {{node.input_name}} with index @p pos. */
668 FIRM_API ir_node *get_{{node.name}}_{{node.input_name}}(ir_node const *node, int pos);
669 /** Set the {{node.name}} {{node.input_name}} with index @p pos. */
670 FIRM_API void set_{{node.name}}_{{node.input_name}}(ir_node *node, int pos, ir_node *{{node.input_name}});
671 /** Get an array of all {{node.name}} {{node.input_name}}s. */
672 ir_node **get_{{node.name}}_{{node.input_name}}_arr(ir_node *node);
675 {%- for attr in node.attrs|hasnot("noprop") %}
676 /** Returns {{attr.name}} attribute of {{node.name|a_an}} node. */
677 FIRM_API {{attr.type}} get_{{node.name}}_{{attr.name}}(const ir_node *node);
678 /** Sets {{attr.name}} attribute of {{node.name|a_an}} node. */
679 FIRM_API void set_{{node.name}}_{{attr.name}}(ir_node *node, {{attr.type}} {{attr.name}});
693 opcodes_h_template = env.from_string(
694 '''/* Warning: automatically generated code */
695 #ifndef FIRM_IR_OPCODES_H
696 #define FIRM_IR_OPCODES_H
698 /** The opcodes of the libFirm predefined operations.
701 typedef enum {{spec.name}}_opcode {
702 {%- for node in nodes %}
703 {{spec.name}}o_{{node.name}},
705 {{spec.name}}o_First = {{spec.name}}o_{{nodes[0].name}},
706 {{spec.name}}o_Last = {{spec.name}}o_{{nodes[-1].name}},
708 {%- if spec.name == "ir" %}
710 /* backend specific nodes */
711 beo_Spill = beo_First,
725 /* last backend node number */
726 beo_Last = beo_FrameAddr,
728 {{spec.name}}o_MaxOpcode
729 } {{spec.name}}_opcode;
731 {% for node in nodes %}
733 * @ingroup {{node.name}}
734 * {{node.name}} opcode
736 FIRM_API ir_op *op_{{node.name}};
739 {% for node in nodes %}
741 * @ingroup {{node.name}}
742 * Returns opcode for {{node.name}} nodes.
744 FIRM_API ir_op *get_op_{{node.name}}(void);
751 #############################
753 def prepare_nodes(nodes):
758 real_nodes.append(node)
760 for node in real_nodes:
761 preprocess_node(node)
767 print "usage: %s specname(ignored) destdirectory" % argv[0]
771 spec = load_spec(specfile)
775 # hardcoded path to libfirm/include/libfirm
779 gendir2 = argv[2] + "/../../include/libfirm"
781 real_nodes = prepare_nodes(nodes)
783 env.globals['nodes'] = real_nodes
784 env.globals['spec'] = spec
786 file = open(gendir + "/gen_ir_cons.c.inl", "w")
787 file.write(gen_ircons_c_inl_template.render())
790 file = open(gendir + "/gen_irnode.h", "w")
791 file.write(irnode_h_template.render())
794 file = open(gendir + "/gen_irnode.c.inl", "w")
795 file.write(irnode_template.render())
798 file = open(gendir + "/gen_irop.c.inl", "w")
799 file.write(irop_template.render())
802 file = open(gendir + "/gen_irdump.c.inl", "w")
803 file.write(irdump_template.render())
806 file = open(gendir2 + "/opcodes.h", "w")
807 file.write(opcodes_h_template.render())
810 file = open(gendir2 + "/nodeops.h", "w")
811 file.write(nodeops_h_template.render())