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_irn_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         if hasattr(node, "throws_init"):
 276                 initattrs.append(dict(
 277                         fqname = ".exc.throws_exception",
 278                         init   = node.throws_init
 279                 ))
 280
 281         for arg in node.constructor_args:
 282                 arguments.append(prepare_attr(arg))
 283
 284         node.arguments = arguments
 285         node.initattrs = initattrs
 286
 287 #############################
 288
 289 gen_ircons_c_inl_template = env.from_string(
 290 '''/* Warning: automatically generated code */
 291
 292 {%- for node in nodes %}
 293 {%- if not node.noconstructor %}
 294 ir_node *new_rd_{{node.name}}(
 295         {%- filter parameters %}
 296                 dbg_info *dbgi
 297                 {{node|blockparameter}}
 298                 {{node|nodeparameters}}
 299         {% endfilter %})
 300 {
 301         ir_node *res;
 302         {%- if node.arity == "dynamic" %}
 303         int      i;
 304         {%- endif %}
 305         {{node|irgassign}}
 306         {{node|insdecl}}
 307
 308         res = new_ir_node(
 309                 {%- filter arguments %}
 310                         dbgi
 311                         irg
 312                         {{node.block}}
 313                         op_{{node.name}}
 314                         {{node.mode}}
 315                         {{node|arity_and_ins}}
 316                 {% endfilter %});
 317         {%- if node.arity == "dynamic" %}
 318         for (i = 0; i < arity; ++i) {
 319                 add_irn_n(res, in[i]);
 320         }
 321         {%- endif %}
 322         {%- for attr in node.attrs %}
 323         res->attr.{{node.attrs_name}}{{attr["fqname"]}} =
 324                 {%- if "init" in attr %} {{ attr["init"] -}};
 325                 {%- else              %} {{ attr["name"] -}};
 326                 {%- endif %}
 327         {%- endfor %}
 328         {%- for attr in node.initattrs %}
 329         res->attr.{{node.attrs_name}}{{attr["fqname"]}} = {{ attr["init"] -}};
 330         {%- endfor %}
 331         {{- node.init }}
 332         res = optimize_node(res);
 333         irn_verify_irg(res, irg);
 334         {{- node.init_after_opt }}
 335         return res;
 336 }
 337
 338 ir_node *new_r_{{node.name}}(
 339                 {%- filter parameters %}
 340                         {{node|blockparameter}}
 341                         {{node|nodeparameters}}
 342                 {% endfilter %})
 343 {
 344         return new_rd_{{node.name}}(
 345                 {%- filter arguments %}
 346                         NULL
 347                         {{node|blockargument}}
 348                         {{node|nodearguments}}
 349                 {% endfilter %});
 350 }
 351
 352 ir_node *new_d_{{node.name}}(
 353                 {%- filter parameters %}
 354                         dbg_info *dbgi
 355                         {{node|nodeparameters}}
 356                 {% endfilter %})
 357 {
 358         ir_node *res;
 359         assert(get_irg_phase_state(current_ir_graph) == phase_building);
 360         res = new_rd_{{node.name}}(
 361                 {%- filter parameters %}
 362                         dbgi
 363                         {{node|curblock}}
 364                         {{node|nodearguments}}
 365                 {% endfilter %});
 366         return res;
 367 }
 368
 369 ir_node *new_{{node.name}}(
 370                 {%- filter parameters %}
 371                         {{node|nodeparameters}}
 372                 {% endfilter %})
 373 {
 374         return new_d_{{node.name}}(
 375                 {%- filter arguments %}
 376                         NULL
 377                         {{node|nodearguments}}
 378                 {% endfilter %});
 379 }
 380 {% endif %}
 381 {%- endfor %}
 382 ''')
 383
 384 irnode_h_template = env.from_string(
 385 '''/* Warning: automatically generated code */
 386
 387 {%- for node in nodes|isnot('custom_is') %}
 388 static inline int _is_{{node.name}}(const ir_node *node)
 389 {
 390         assert(node != NULL);
 391         return _get_irn_op(node) == op_{{node.name}};
 392 }
 393 {%- endfor -%}
 394
 395 {% for node in nodes %}
 396 #define is_{{node.name}}(node)    _is_{{node.name}}(node)
 397 {%- endfor %}
 398
 399 ''')
 400
 401 irnode_template = env.from_string(
 402 '''/* Warning: automatically generated code */
 403 {% for node in nodes %}
 404 int (is_{{node.name}})(const ir_node *node)
 405 {
 406         return _is_{{node.name}}(node);
 407 }
 408 {% endfor %}
 409
 410 {%- for node in nodes %}
 411 {%- for attr in node.attrs|hasnot("noprop") %}
 412 {{attr.type}} (get_{{node.name}}_{{attr.name}})(const ir_node *node)
 413 {
 414         assert(is_{{node.name}}(node));
 415         return node->attr.{{node.attrs_name}}.{{attr.name}};
 416 }
 417
 418 void (set_{{node.name}}_{{attr.name}})(ir_node *node, {{attr.type}} {{attr.name}})
 419 {
 420         assert(is_{{node.name}}(node));
 421         node->attr.{{node.attrs_name}}.{{attr.name}} = {{attr.name}};
 422 }
 423 {% endfor -%}
 424 {% endfor -%}
 425
 426 {%- for node in nodes %}
 427 {%- for input in node.ins %}
 428 ir_node *(get_{{node.name}}_{{input[0]}})(const ir_node *node)
 429 {
 430         assert(is_{{node.name}}(node));
 431         return get_irn_n(node, n_{{node.name}}_{{input[0]}});
 432 }
 433
 434 void (set_{{node.name}}_{{input[0]}})(ir_node *node, ir_node *{{input[0]|escape_keywords}})
 435 {
 436         assert(is_{{node.name}}(node));
 437         set_irn_n(node, n_{{node.name}}_{{input[0]}}, {{input[0]|escape_keywords}});
 438 }
 439 {% endfor %}
 440 {% endfor %}
 441 ''')
 442
 443 irop_template = env.from_string(
 444 '''/* Warning: automatically generated code */
 445 {% for node in nodes %}
 446 ir_op *op_{{node.name}}; ir_op *get_op_{{node.name}}(void) { return op_{{node.name}}; }
 447 {%- endfor %}
 448
 449 void init_op(void)
 450 {
 451         {% for node in nodes %}
 452         op_{{node.name}} = new_ir_op(
 453                 {%- filter arguments %}
 454                         iro_{{node.name}}
 455                         "{{node.name}}"
 456                         {{node|pinned}}
 457                         {{node|flags}}
 458                         {{node|arity}}
 459                         {{node|opindex}}
 460                         {{node|attr_size}}
 461                         NULL
 462                 {% endfilter %});
 463         {%- if "fragile" in node.flags: %}
 464         ir_op_set_fragile_indices(op_{{node.name}}, n_{{node.name}}_mem, pn_{{node.name}}_X_regular, pn_{{node.name}}_X_except);
 465         {%- endif -%}
 466         {%- endfor %}
 467
 468         be_init_op();
 469 }
 470
 471 void finish_op(void)
 472 {
 473         {% for node in nodes %}
 474         free_ir_op(op_{{node.name}}); op_{{node.name}} = NULL;
 475         {%- endfor %}
 476 }
 477
 478 ''')
 479
 480 nodeops_h_template = env.from_string(
 481 '''/* Warning: automatically generated code */
 482 #ifndef FIRM_IR_NODEOPS_H
 483 #define FIRM_IR_NODEOPS_H
 484
 485 #include "firm_types.h"
 486
 487 /**
 488  * @addtogroup ir_node
 489  * @{
 490  */
 491
 492 {% for node in nodes -%}
 493 {% if node.ins %}
 494 /**
 495  * Input numbers for {{node.name}} node
 496  */
 497 typedef enum {
 498         {%- for input in node.ins %}
 499         n_{{node.name}}_{{input[0]}},
 500         {%- endfor %}
 501         n_{{node.name}}_max = n_{{node.name}}_{{node.ins[-1][0]}}
 502 } n_{{node.name}};
 503 {% endif %}
 504 {% if node.outs %}
 505 /**
 506  * Projection numbers for result of {{node.name}} node (use for Proj nodes)
 507  */
 508 typedef enum {
 509         {% for out in node.outs -%}
 510         pn_{{node.name}}_{{out[0]}}
 511         {%- if out.__len__() > 2 %} = {{out[2]}}{% endif %}, /**< {{out[1]}} */
 512         {% endfor -%}
 513         pn_{{node.name}}_max = pn_{{node.name}}_{{node.outs[-1][0]}}
 514 } pn_{{node.name}};
 515 {% endif %}
 516 {%- endfor %}
 517
 518 {% for node in nodes %}
 519 {%- if not node.noconstructor %}
 520 /**
 521  * Construct {{node.name|a_an}} node.
 522  *
 523  * @param dbgi      A pointer to debug information.
 524 {{ node|blockparameterhelp -}}
 525 {{ node|nodeparametershelp -}}
 526  */
 527 FIRM_API ir_node *new_rd_{{node.name}}(
 528         {%- filter parameters %}
 529                 dbg_info *dbgi
 530                 {{node|blockparameter}}
 531                 {{node|nodeparameters}}
 532         {% endfilter %});
 533
 534 /**
 535  * Construct {{node.name|a_an}} node.
 536  *
 537 {{ node|blockparameterhelp -}}
 538 {{ node|nodeparametershelp -}}
 539  */
 540 FIRM_API ir_node *new_r_{{node.name}}(
 541         {%- filter parameters %}
 542                 {{node|blockparameter}}
 543                 {{node|nodeparameters}}
 544         {% endfilter %});
 545
 546 /**
 547  * Construct {{node.name|a_an}} node.
 548  *
 549  * @param dbgi      A pointer to debug information.
 550 {{ node|nodeparametershelp -}}
 551  */
 552 FIRM_API ir_node *new_d_{{node.name}}(
 553         {%- filter parameters %}
 554                 dbg_info *dbgi
 555                 {{node|nodeparameters}}
 556         {% endfilter %});
 557
 558 /**
 559  * Construct {{node.name|a_an}} node.
 560  *
 561 {{ node|nodeparametershelp -}}
 562  */
 563 FIRM_API ir_node *new_{{node.name}}(
 564         {%- filter parameters %}
 565                 {{node|nodeparameters}}
 566         {% endfilter %});
 567 {%- endif %}
 568 {% endfor %}
 569
 570 {% for node in nodes %}
 571 /** Return true of the node is a {{node.name}} node. */
 572 FIRM_API int is_{{node.name}}(const ir_node *node);
 573 {%- endfor %}
 574
 575 {% for node in nodes %}
 576 {% for input in node.ins -%}
 577 FIRM_API ir_node *get_{{node.name}}_{{input[0]}}(const ir_node *node);
 578 FIRM_API void set_{{node.name}}_{{input[0]}}(ir_node *node, ir_node *{{input[0]|escape_keywords}});
 579 {% endfor -%}
 580 {% for attr in node.attrs|hasnot("noprop") -%}
 581 FIRM_API {{attr.type}} get_{{node.name}}_{{attr.name}}(const ir_node *node);
 582 FIRM_API void set_{{node.name}}_{{attr.name}}(ir_node *node, {{attr.type}} {{attr.name}});
 583 {% endfor -%}
 584 {% endfor -%}
 585
 586 /** @} */
 587
 588 #endif
 589
 590 ''')
 591
 592 opcodes_h_template = env.from_string(
 593 '''/* Warning: automatically generated code */
 594 #ifndef FIRM_IR_OPCODES_H
 595 #define FIRM_IR_OPCODES_H
 596
 597 /** The opcodes of the libFirm predefined operations. */
 598 typedef enum ir_opcode {
 599 {%- for node in nodes %}
 600         iro_{{node.name}},
 601 {%- endfor %}
 602         iro_First = iro_{{nodes[0].name}},
 603         iro_Last = iro_{{nodes[-1].name}},
 604
 605         beo_First,
 606         /* backend specific nodes */
 607         beo_Spill = beo_First,
 608         beo_Reload,
 609         beo_Perm,
 610         beo_MemPerm,
 611         beo_Copy,
 612         beo_Keep,
 613         beo_CopyKeep,
 614         beo_Call,
 615         beo_Return,
 616         beo_AddSP,
 617         beo_SubSP,
 618         beo_IncSP,
 619         beo_Start,
 620         beo_FrameAddr,
 621         /* last backend node number */
 622         beo_Last = beo_FrameAddr,
 623         iro_MaxOpcode
 624 } ir_opcode;
 625
 626 {% for node in nodes %}
 627 FIRM_API ir_op *op_{{node.name}};
 628 {%- endfor %}
 629
 630 {% for node in nodes %}
 631 FIRM_API ir_op *get_op_{{node.name}}(void);
 632 {%- endfor %}
 633
 634 #endif
 635
 636 ''')
 637
 638 #############################
 639
 640 def prepare_nodes():
 641         real_nodes = []
 642         for node in nodes:
 643                 if isAbstract(node):
 644                         continue
 645                 real_nodes.append(node)
 646
 647         for node in real_nodes:
 648                 preprocess_node(node)
 649
 650         return real_nodes
 651
 652 def main(argv):
 653         if len(argv) < 3:
 654                 print "usage: %s specname(ignored) destdirectory" % argv[0]
 655                 sys.exit(1)
 656
 657         gendir = argv[2]
 658         # hardcoded path to libfirm/include/libfirm
 659         gendir2 = argv[2] + "/../../include/libfirm"
 660
 661         real_nodes = prepare_nodes()
 662
 663         file = open(gendir + "/gen_ir_cons.c.inl", "w")
 664         file.write(gen_ircons_c_inl_template.render(nodes = real_nodes))
 665         file.close()
 666
 667         file = open(gendir + "/gen_irnode.h", "w")
 668         file.write(irnode_h_template.render(nodes = real_nodes))
 669         file.close()
 670
 671         file = open(gendir + "/gen_irnode.c.inl", "w")
 672         file.write(irnode_template.render(nodes = real_nodes))
 673         file.close()
 674
 675         file = open(gendir + "/gen_irop.c.inl", "w")
 676         file.write(irop_template.render(nodes = real_nodes))
 677         file.close()
 678
 679         file = open(gendir2 + "/opcodes.h", "w")
 680         file.write(opcodes_h_template.render(nodes = real_nodes))
 681         file.close()
 682
 683         file = open(gendir2 + "/nodeops.h", "w")
 684         file.write(nodeops_h_template.render(nodes = real_nodes))
 685         file.close()
 686
 687 main(sys.argv)