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