nsz Git - libfirm/blob - scripts/gen_ir.py

   1 #!/usr/bin/env python
   2 import sys
   3 import re
   4 from jinja2 import Environment, Template
   5 from jinja2.filters import do_dictsort
   6 from spec_util import is_dynamic_pinned, verify_node, isAbstract, setdefault
   7 from ir_spec import nodes
   8
   9 def format_parameterlist(parameterlist):
  10         return "\n".join(parameterlist)
  11
  12 def format_nodearguments(node):
  13         arguments = map(lambda arg: arg["name"], node.arguments)
  14         return format_parameterlist(arguments)
  15
  16 def format_nodeparameters(node):
  17         parameters = map(lambda arg: arg["type"] + " " + arg["name"], node.arguments)
  18         return format_parameterlist(parameters)
  19
  20 def format_nodeparametershelp(node):
  21         res = ""
  22         for param in node.arguments:
  23                 res += " * @param %-9s %s\n" % (param["name"], param["comment"])
  24         return res
  25
  26 def format_a_an(text):
  27         if text[0] in "aAeEuUoOiI":
  28                 return "an " + text
  29         return "a " + text
  30
  31 def format_blockparameter(node):
  32         if hasattr(node, "knownBlock"):
  33                 if hasattr(node, "knownGraph"):
  34                         return ""
  35                 return "ir_graph *irg"
  36         else:
  37                 return "ir_node *block"
  38
  39 def format_blockparameterhelp(node):
  40         if hasattr(node, "knownBlock"):
  41                 if hasattr(node, "knownGraph"):
  42                         return ""
  43                 return " * @param irg       The IR graph the node belongs to.\n"
  44         else:
  45                 return " * @param block     The IR block the node belongs to.\n"
  46
  47 def format_blockargument(node):
  48         if hasattr(node, "knownBlock"):
  49                 if hasattr(node, "knownGraph"):
  50                         return ""
  51                 return "irg"
  52         else:
  53                 return "block"
  54
  55 def format_irgassign(node):
  56         if hasattr(node, "knownGraph"):
  57                 return "ir_graph *irg = %s;\n" % node.graph
  58
  59         if hasattr(node, "knownBlock"):
  60                 return ""
  61         else:
  62                 return "ir_graph *irg = get_Block_irg(block);\n"
  63
  64 def format_curblock(node):
  65         if hasattr(node, "knownBlock"):
  66                 if hasattr(node, "knownGraph"):
  67                         return ""
  68                 return "current_ir_graph"
  69         else:
  70                 return "current_ir_graph->current_block"
  71
  72 def format_insdecl(node):
  73         arity = node.arity
  74         if arity == "variable" and len(node.ins) == 0 or arity == "dynamic" or arity == 0:
  75                 return ""
  76
  77         if arity == "variable":
  78                 insarity = len(node.ins)
  79                 res  = "int r_arity = arity + " + `insarity` + ";"
  80                 res += "\n\tir_node **r_in;"
  81                 res += "\n\tNEW_ARR_A(ir_node *, r_in, r_arity);"
  82                 i = 0
  83                 for input in node.ins:
  84                         res += "\n\tr_in[" + `i` + "] = irn_" + input[0] + ";"
  85                         i += 1
  86                 res += "\n\tmemcpy(&r_in[" + `insarity` + "], in, sizeof(ir_node *) * arity);\n\t"
  87         else:
  88                 res = "ir_node *in[" + `arity` + "];"
  89                 i = 0
  90                 for input in node.ins:
  91                         res += "\n\tin[" + `i` + "] = irn_" + input[0] + ";"
  92                         i += 1
  93         return res
  94
  95 def format_arity_and_ins(node):
  96         arity = node.arity
  97         if arity == "dynamic":
  98                 return "-1, NULL"
  99         elif arity == "variable":
 100                 if len(node.ins) == 0:
 101                         return "arity, in"
 102                 else:
 103                         return "r_arity, r_in"
 104         elif arity == 0:
 105                 return "0, NULL"
 106         else:
 107                 return `arity` + ", in"
 108
 109 def format_arity(node):
 110         if hasattr(node, "arity_override"):
 111                 return node.arity_override
 112         arity = node.arity
 113         if arity == "dynamic":
 114                 return "oparity_dynamic"
 115         if arity == "variable":
 116                 return "oparity_variable"
 117         if arity == 0:
 118                 return "oparity_zero"
 119         if arity == 1:
 120                 return "oparity_unary"
 121         if arity == 2:
 122                 return "oparity_binary"
 123         if arity == 3:
 124                 return "oparity_trinary"
 125         return "oparity_any"
 126
 127 def format_pinned(node):
 128         pinned = node.pinned
 129         if pinned == "yes":
 130                 return "op_pin_state_pinned"
 131         if pinned == "no":
 132                 return "op_pin_state_floats"
 133         if pinned == "exception":
 134                 return "op_pin_state_exc_pinned"
 135         if pinned == "memory":
 136                 return "op_pin_state_mem_pinned"
 137         print "WARNING: Unknown pinned state %s in format pined" % pinned
 138         return ""
 139
 140 def format_flags(node):
 141         flags = map(lambda x : "irop_flag_" + x, node.flags)
 142         if flags == []:
 143                 flags = [ "irop_flag_none" ]
 144         return " | ".join(flags)
 145
 146 def format_attr_size(node):
 147         if not hasattr(node, "attr_struct"):
 148                 return "0"
 149         return "sizeof(%s)" % node.attr_struct
 150
 151 def format_opindex(node):
 152         if hasattr(node, "op_index"):
 153                 return node.op_index
 154         return "-1"
 155
 156 keywords = frozenset([ "true", "false" ])
 157 def format_escape_keywords(word):
 158         if word in keywords:
 159                 return word + "_"
 160         return word
 161
 162 def filter_isnot(list, flag):
 163         return filter(lambda x: not hasattr(x, flag), list)
 164
 165 def filter_hasnot(list, flag):
 166         return filter(lambda x: flag not in x, list)
 167
 168 def format_arguments(string, voidwhenempty = False):
 169         args = re.split('\s*\n\s*', string)
 170         if args[0] == '':
 171                 args = args[1:]
 172         if len(args) > 0 and args[-1] == '':
 173                 args = args[:-1]
 174         if len(args) == 0 and voidwhenempty:
 175                 return "void"
 176         return ", ".join(args)
 177
 178 def format_parameters(string):
 179         return format_arguments(string, voidwhenempty = True)
 180
 181 env = Environment()
 182 env.filters['a_an']            = format_a_an
 183 env.filters['parameterlist']   = format_parameterlist
 184 env.filters['nodearguments']   = format_nodearguments
 185 env.filters['nodeparameters']  = format_nodeparameters
 186 env.filters['nodeparametershelp'] = format_nodeparametershelp
 187 env.filters['blockparameter']  = format_blockparameter
 188 env.filters['blockparameterhelp'] = format_blockparameterhelp
 189 env.filters['blockargument']   = format_blockargument
 190 env.filters['irgassign']       = format_irgassign
 191 env.filters['curblock']        = format_curblock
 192 env.filters['insdecl']         = format_insdecl
 193 env.filters['arity_and_ins']   = format_arity_and_ins
 194 env.filters['arity']           = format_arity
 195 env.filters['pinned']          = format_pinned
 196 env.filters['flags']           = format_flags
 197 env.filters['attr_size']       = format_attr_size
 198 env.filters['opindex']         = format_opindex
 199 env.filters['isnot']           = filter_isnot
 200 env.filters['hasnot']          = filter_hasnot
 201 env.filters['arguments']       = format_arguments
 202 env.filters['parameters']      = format_parameters
 203 env.filters['escape_keywords'] = format_escape_keywords
 204
 205 def prepare_attr(attr):
 206         if "init" in attr:
 207                 return dict(
 208                         type = attr["type"],
 209                         name = attr["name"],
 210                         init = attr["init"],
 211                         comment = attr["comment"])
 212         else:
 213                 return dict(
 214                         type = attr["type"],
 215                         name = attr["name"],
 216                         comment = attr["comment"])
 217
 218 def preprocess_node(node):
 219         verify_node(node)
 220
 221         setdefault(node, "attrs_name", node.name.lower())
 222         setdefault(node, "block", "block")
 223
 224         # construct node arguments
 225         arguments = [ ]
 226         initattrs = [ ]
 227         for input in node.ins:
 228                 arguments.append(dict(
 229                                 type    = "ir_node *",
 230                                 name    = "irn_" + input[0],
 231                                 comment = input[1]))
 232
 233         if node.arity == "variable" or node.arity == "dynamic":
 234                 arguments.append(dict(
 235                                 type    = "int",
 236                                 name    = "arity",
 237                                 comment = "size of additional inputs array"))
 238                 arguments.append(dict(
 239                                 type    = "ir_node *const *",
 240                                 name    = "in",
 241                                 comment = "additional inputs"))
 242
 243         if not hasattr(node, "mode"):
 244                 arguments.append(dict(
 245                                 type    = "ir_mode *",
 246                                 name    = "mode",
 247                                 comment = "mode of the operations result"))
 248                 node.mode = "mode"
 249
 250         for attr in node.attrs:
 251                 attr["fqname"] = "." + attr["name"]
 252                 if "init" in attr:
 253                         continue
 254                 arguments.append(attr)
 255
 256         # dynamic pin state means more constructor arguments
 257         if is_dynamic_pinned(node):
 258                 if hasattr(node, "pinned_init"):
 259                         initattrs.append(dict(
 260                                 fqname = ".exc.pin_state",
 261                                 init   = node.pinned_init
 262                         ))
 263                 else:
 264                         node.constructor_args.append(
 265                                 dict(
 266                                         name    = "pin_state",
 267                                         type    = "op_pin_state",
 268                                         comment = "pinned state",
 269                                 )
 270                         )
 271                         initattrs.append(dict(
 272                                 fqname = ".exc.pin_state",
 273                                 init   = "pin_state"
 274                         ))
 275
 276         for arg in node.constructor_args:
 277                 arguments.append(prepare_attr(arg))
 278
 279         node.arguments = arguments
 280         node.initattrs = initattrs
 281
 282 #############################
 283
 284 gen_ircons_c_inl_template = env.from_string(
 285 '''/* Warning: automatically generated code */
 286
 287 {%- for node in nodes %}
 288 {%- if not node.noconstructor %}
 289 ir_node *new_rd_{{node.name}}(
 290         {%- filter parameters %}
 291                 dbg_info *dbgi
 292                 {{node|blockparameter}}
 293                 {{node|nodeparameters}}
 294         {% endfilter %})
 295 {
 296         ir_node *res;
 297         {%- if node.arity == "dynamic" %}
 298         int      i;
 299         {%- endif %}
 300         {{node|irgassign}}
 301         {{node|insdecl}}
 302
 303         res = new_ir_node(
 304                 {%- filter arguments %}
 305                         dbgi
 306                         irg
 307                         {{node.block}}
 308                         op_{{node.name}}
 309                         {{node.mode}}
 310                         {{node|arity_and_ins}}
 311                 {% endfilter %});
 312         {%- if node.arity == "dynamic" %}
 313         for (i = 0; i < arity; ++i) {
 314                 add_irn_n(res, in[i]);
 315         }
 316         {%- endif %}
 317         {%- for attr in node.attrs %}
 318         res->attr.{{node.attrs_name}}{{attr["fqname"]}} =
 319                 {%- if "init" in attr %} {{ attr["init"] -}};
 320                 {%- else              %} {{ attr["name"] -}};
 321                 {%- endif %}
 322         {%- endfor %}
 323         {%- for attr in node.initattrs %}
 324         res->attr.{{node.attrs_name}}{{attr["fqname"]}} = {{ attr["init"] -}};
 325         {%- endfor %}
 326         {{- node.init }}
 327         res = optimize_node(res);
 328         irn_verify_irg(res, irg);
 329         {{- node.init_after_opt }}
 330         return res;
 331 }
 332
 333 ir_node *new_r_{{node.name}}(
 334                 {%- filter parameters %}
 335                         {{node|blockparameter}}
 336                         {{node|nodeparameters}}
 337                 {% endfilter %})
 338 {
 339         return new_rd_{{node.name}}(
 340                 {%- filter arguments %}
 341                         NULL
 342                         {{node|blockargument}}
 343                         {{node|nodearguments}}
 344                 {% endfilter %});
 345 }
 346
 347 ir_node *new_d_{{node.name}}(
 348                 {%- filter parameters %}
 349                         dbg_info *dbgi
 350                         {{node|nodeparameters}}
 351                 {% endfilter %})
 352 {
 353         ir_node *res;
 354         assert(get_irg_phase_state(current_ir_graph) == phase_building);
 355         res = new_rd_{{node.name}}(
 356                 {%- filter parameters %}
 357                         dbgi
 358                         {{node|curblock}}
 359                         {{node|nodearguments}}
 360                 {% endfilter %});
 361         return res;
 362 }
 363
 364 ir_node *new_{{node.name}}(
 365                 {%- filter parameters %}
 366                         {{node|nodeparameters}}
 367                 {% endfilter %})
 368 {
 369         return new_d_{{node.name}}(
 370                 {%- filter arguments %}
 371                         NULL
 372                         {{node|nodearguments}}
 373                 {% endfilter %});
 374 }
 375 {% endif %}
 376 {%- endfor %}
 377 ''')
 378
 379 irnode_h_template = env.from_string(
 380 '''/* Warning: automatically generated code */
 381
 382 {%- for node in nodes|isnot('custom_is') %}
 383 static inline int _is_{{node.name}}(const ir_node *node)
 384 {
 385         assert(node != NULL);
 386         return _get_irn_op(node) == op_{{node.name}};
 387 }
 388 {%- endfor -%}
 389
 390 {% for node in nodes %}
 391 #define is_{{node.name}}(node)    _is_{{node.name}}(node)
 392 {%- endfor %}
 393
 394 ''')
 395
 396 irnode_template = env.from_string(
 397 '''/* Warning: automatically generated code */
 398 {% for node in nodes %}
 399 int (is_{{node.name}})(const ir_node *node)
 400 {
 401         return _is_{{node.name}}(node);
 402 }
 403 {% endfor %}
 404
 405 {%- for node in nodes %}
 406 {%- for attr in node.attrs|hasnot("noprop") %}
 407 {{attr.type}} (get_{{node.name}}_{{attr.name}})(const ir_node *node)
 408 {
 409         assert(is_{{node.name}}(node));
 410         return node->attr.{{node.attrs_name}}.{{attr.name}};
 411 }
 412
 413 void (set_{{node.name}}_{{attr.name}})(ir_node *node, {{attr.type}} {{attr.name}})
 414 {
 415         assert(is_{{node.name}}(node));
 416         node->attr.{{node.attrs_name}}.{{attr.name}} = {{attr.name}};
 417 }
 418 {% endfor -%}
 419 {% endfor -%}
 420
 421 {%- for node in nodes %}
 422 {%- for in in node.ins %}
 423 ir_node *(get_{{node.name}}_{{in[0]}})(const ir_node *node)
 424 {
 425         assert(is_{{node.name}}(node));
 426         return get_irn_n(node, {{node.ins.index(in)}});
 427 }
 428
 429 void (set_{{node.name}}_{{in[0]}})(ir_node *node, ir_node *{{in[0]|escape_keywords}})
 430 {
 431         assert(is_{{node.name}}(node));
 432         set_irn_n(node, {{node.ins.index(in)}}, {{in[0]|escape_keywords}});
 433 }
 434 {% endfor %}
 435 {% endfor %}
 436 ''')
 437
 438 irop_template = env.from_string(
 439 '''/* Warning: automatically generated code */
 440 {% for node in nodes %}
 441 ir_op *op_{{node.name}}; ir_op *get_op_{{node.name}}(void) { return op_{{node.name}}; }
 442 {%- endfor %}
 443
 444 void init_op(void)
 445 {
 446         {% for node in nodes %}
 447         op_{{node.name}} = new_ir_op(
 448                 {%- filter arguments %}
 449                         iro_{{node.name}}
 450                         "{{node.name}}"
 451                         {{node|pinned}}
 452                         {{node|flags}}
 453                         {{node|arity}}
 454                         {{node|opindex}}
 455                         {{node|attr_size}}
 456                         NULL
 457                 {% endfilter %});
 458         {%- endfor %}
 459
 460         be_init_op();
 461 }
 462
 463 void finish_op(void)
 464 {
 465         {% for node in nodes %}
 466         free_ir_op(op_{{node.name}}); op_{{node.name}} = NULL;
 467         {%- endfor %}
 468 }
 469
 470 ''')
 471
 472 nodeops_h_template = env.from_string(
 473 '''/* Warning: automatically generated code */
 474 #ifndef FIRM_IR_NODEOPS_H
 475 #define FIRM_IR_NODEOPS_H
 476
 477 #include "firm_types.h"
 478
 479 /**
 480  * @addtogroup ir_node
 481  * @{
 482  */
 483
 484 {% for node in nodes -%}
 485 {% if node.outs %}
 486 /**
 487  * Projection numbers for result of {{node.name}} node (use for Proj nodes)
 488  */
 489 typedef enum {
 490         {% for out in node.outs -%}
 491         pn_{{node.name}}_{{out[0]}}
 492         {%- if out.__len__() > 2 %} = {{out[2]}}{% endif %}, /**< {{out[1]}} */
 493         {% endfor -%}
 494         pn_{{node.name}}_max
 495 } pn_{{node.name}};
 496 {% endif %}
 497 {%- endfor %}
 498
 499 {% for node in nodes %}
 500 {%- if not node.noconstructor %}
 501 /**
 502  * Construct {{node.name|a_an}} node.
 503  *
 504  * @param dbgi      A pointer to debug information.
 505 {{ node|blockparameterhelp -}}
 506 {{ node|nodeparametershelp -}}
 507  */
 508 FIRM_API ir_node *new_rd_{{node.name}}(
 509         {%- filter parameters %}
 510                 dbg_info *dbgi
 511                 {{node|blockparameter}}
 512                 {{node|nodeparameters}}
 513         {% endfilter %});
 514
 515 /**
 516  * Construct {{node.name|a_an}} node.
 517  *
 518 {{ node|blockparameterhelp -}}
 519 {{ node|nodeparametershelp -}}
 520  */
 521 FIRM_API ir_node *new_r_{{node.name}}(
 522         {%- filter parameters %}
 523                 {{node|blockparameter}}
 524                 {{node|nodeparameters}}
 525         {% endfilter %});
 526
 527 /**
 528  * Construct {{node.name|a_an}} node.
 529  *
 530  * @param dbgi      A pointer to debug information.
 531 {{ node|nodeparametershelp -}}
 532  */
 533 FIRM_API ir_node *new_d_{{node.name}}(
 534         {%- filter parameters %}
 535                 dbg_info *dbgi
 536                 {{node|nodeparameters}}
 537         {% endfilter %});
 538
 539 /**
 540  * Construct {{node.name|a_an}} node.
 541  *
 542 {{ node|nodeparametershelp -}}
 543  */
 544 FIRM_API ir_node *new_{{node.name}}(
 545         {%- filter parameters %}
 546                 {{node|nodeparameters}}
 547         {% endfilter %});
 548 {%- endif %}
 549 {% endfor %}
 550
 551 {% for node in nodes %}
 552 /** Return true of the node is a {{node.name}} node. */
 553 FIRM_API int is_{{node.name}}(const ir_node *node);
 554 {%- endfor %}
 555
 556 {% for node in nodes %}
 557 {% for in in node.ins -%}
 558 FIRM_API ir_node *get_{{node.name}}_{{in[0]}}(const ir_node *node);
 559 void set_{{node.name}}_{{in[0]}}(ir_node *node, ir_node *{{in[0]|escape_keywords}});
 560 {% endfor -%}
 561 {% for attr in node.attrs|hasnot("noprop") -%}
 562 FIRM_API {{attr.type}} get_{{node.name}}_{{attr.name}}(const ir_node *node);
 563 FIRM_API void set_{{node.name}}_{{attr.name}}(ir_node *node, {{attr.type}} {{attr.name}});
 564 {% endfor -%}
 565 {% endfor -%}
 566
 567 /** @} */
 568
 569 #endif
 570
 571 ''')
 572
 573 opcodes_h_template = env.from_string(
 574 '''/* Warning: automatically generated code */
 575 #ifndef FIRM_IR_OPCODES_H
 576 #define FIRM_IR_OPCODES_H
 577
 578 /** The opcodes of the libFirm predefined operations. */
 579 typedef enum ir_opcode {
 580 {%- for node in nodes %}
 581         iro_{{node.name}},
 582 {%- endfor %}
 583         iro_First = iro_{{nodes[0].name}},
 584         iro_Last = iro_{{nodes[-1].name}},
 585
 586         beo_First,
 587         /* backend specific nodes */
 588         beo_Spill = beo_First,
 589         beo_Reload,
 590         beo_Perm,
 591         beo_MemPerm,
 592         beo_Copy,
 593         beo_Keep,
 594         beo_CopyKeep,
 595         beo_Call,
 596         beo_Return,
 597         beo_AddSP,
 598         beo_SubSP,
 599         beo_IncSP,
 600         beo_Start,
 601         beo_FrameAddr,
 602         /* last backend node number */
 603         beo_Last = beo_FrameAddr,
 604         iro_MaxOpcode
 605 } ir_opcode;
 606
 607 {% for node in nodes %}
 608 FIRM_API ir_op *op_{{node.name}};
 609 {%- endfor %}
 610
 611 {% for node in nodes %}
 612 FIRM_API ir_op *get_op_{{node.name}}(void);
 613 {%- endfor %}
 614
 615 #endif
 616
 617 ''')
 618
 619 #############################
 620
 621 def prepare_nodes():
 622         real_nodes = []
 623         for node in nodes:
 624                 if isAbstract(node):
 625                         continue
 626                 real_nodes.append(node)
 627
 628         for node in real_nodes:
 629                 preprocess_node(node)
 630
 631         return real_nodes
 632
 633 def main(argv):
 634         if len(argv) < 3:
 635                 print "usage: %s specname(ignored) destdirectory" % argv[0]
 636                 sys.exit(1)
 637
 638         gendir = argv[2]
 639         # hardcoded path to libfirm/include/libfirm
 640         gendir2 = argv[2] + "/../../include/libfirm"
 641
 642         real_nodes = prepare_nodes()
 643
 644         file = open(gendir + "/gen_ir_cons.c.inl", "w")
 645         file.write(gen_ircons_c_inl_template.render(nodes = real_nodes))
 646         file.close()
 647
 648         file = open(gendir + "/gen_irnode.h", "w")
 649         file.write(irnode_h_template.render(nodes = real_nodes))
 650         file.close()
 651
 652         file = open(gendir + "/gen_irnode.c.inl", "w")
 653         file.write(irnode_template.render(nodes = real_nodes))
 654         file.close()
 655
 656         file = open(gendir + "/gen_irop.c.inl", "w")
 657         file.write(irop_template.render(nodes = real_nodes))
 658         file.close()
 659
 660         file = open(gendir2 + "/opcodes.h", "w")
 661         file.write(opcodes_h_template.render(nodes = real_nodes))
 662         file.close()
 663
 664         file = open(gendir2 + "/nodeops.h", "w")
 665         file.write(nodeops_h_template.render(nodes = real_nodes))
 666         file.close()
 667
 668 main(sys.argv)