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         for input in node.ins:
 199                 arguments.append(dict(type = "ir_node *", name = "irn_" + input))
 200
 201         if node.arity == "variable" or node.arity == "dynamic":
 202                 arguments.append(dict(type = "int", name = "arity"))
 203                 arguments.append(dict(type = "ir_node **", name = "in"))
 204
 205         if not hasattr(node, "mode"):
 206                 arguments.append(dict(type = "ir_mode *", name = "mode"))
 207                 node.mode = "mode"
 208
 209         for attr in node.attrs:
 210                 attr.setdefault("initname", "." + attr["name"])
 211
 212                 if not "init" in attr:
 213                         arguments.append(prepare_attr(attr))
 214
 215         # dynamic pin state means more constructor arguments
 216         if is_dynamic_pinned(node):
 217                 if hasattr(node, "pinned_init"):
 218                         initattrs.append(dict(
 219                                 initname = ".exc.pin_state",
 220                                 init     = node.pinned_init
 221                         ))
 222                 else:
 223                         node.constructor_args.append(
 224                                 dict(
 225                                         name = "pin_state",
 226                                         type = "op_pin_state"
 227                                 )
 228                         )
 229                         initattrs.append(dict(
 230                                 initname = ".exc.pin_state",
 231                                 init     = "pin_state"
 232                         ))
 233
 234         for arg in node.constructor_args:
 235                 arguments.append(prepare_attr(arg))
 236                 if arg["type"] == "ir_cons_flags":
 237                         name = arg["name"]
 238                         initattrs.append(dict(initname = ".exc.pin_state",
 239                                 init = name + " & cons_floats ? op_pin_state_floats : op_pin_state_pinned"))
 240                         initattrs.append(dict(initname = ".volatility",
 241                                 init = name + " & cons_volatile ? volatility_is_volatile : volatility_non_volatile"))
 242                         initattrs.append(dict(initname = ".aligned",
 243                                 init = name + " & cons_unaligned ? align_non_aligned : align_is_aligned"))
 244
 245         node.arguments = arguments
 246         node.initattrs = initattrs
 247
 248 #############################
 249
 250 constructor_template = env.from_string('''
 251
 252 ir_node *new_rd_{{node.name}}(
 253         {%- filter parameters %}
 254                 dbg_info *dbgi
 255                 {{node|blockparameter}}
 256                 {{node|nodeparameters}}
 257         {% endfilter %})
 258 {
 259         ir_node *res;
 260         {%- if node.arity == "dynamic" %}
 261         int      i;
 262         {%- endif %}
 263         {{node|irgassign}}
 264         {{node|insdecl}}
 265
 266         res = new_ir_node(
 267                 {%- filter arguments %}
 268                         dbgi
 269                         irg
 270                         {{node.block}}
 271                         op_{{node.name}}
 272                         {{node.mode}}
 273                         {{node|arity_and_ins}}
 274                 {% endfilter %});
 275         {%- if node.arity == "dynamic" %}
 276         for (i = 0; i < arity; ++i) {
 277                 add_irn_n(res, in[i]);
 278         }
 279         {%- endif %}
 280         {%- for attr in node.attrs %}
 281         res->attr.{{node.attrs_name}}{{attr["initname"]}} =
 282                 {%- if "init" in attr %} {{ attr["init"] -}};
 283                 {%- else              %} {{ attr["name"] -}};
 284                 {%- endif %}
 285         {%- endfor %}
 286         {%- for attr in node.initattrs %}
 287         res->attr.{{node.attrs_name}}{{attr["initname"]}} = {{ attr["init"] -}};
 288         {%- endfor %}
 289         {{- node.init }}
 290         res = optimize_node(res);
 291         irn_verify_irg(res, irg);
 292         return res;
 293 }
 294
 295 ir_node *new_r_{{node.name}}(
 296                 {%- filter parameters %}
 297                         {{node|blockparameter}}
 298                         {{node|nodeparameters}}
 299                 {% endfilter %})
 300 {
 301         return new_rd_{{node.name}}(
 302                 {%- filter arguments %}
 303                         NULL
 304                         {{node|blockargument}}
 305                         {{node|nodearguments}}
 306                 {% endfilter %});
 307 }
 308
 309 ir_node *new_d_{{node.name}}(
 310                 {%- filter parameters %}
 311                         dbg_info *dbgi
 312                         {{node|nodeparameters}}
 313                 {% endfilter %})
 314 {
 315         ir_node *res;
 316         assert(get_irg_phase_state(current_ir_graph) == phase_building);
 317         res = new_rd_{{node.name}}(
 318                 {%- filter parameters %}
 319                         dbgi
 320                         {{node|curblock}}
 321                         {{node|nodearguments}}
 322                 {% endfilter %});
 323         return res;
 324 }
 325
 326 ir_node *new_{{node.name}}(
 327                 {%- filter parameters %}
 328                         {{node|nodeparameters}}
 329                 {% endfilter %})
 330 {
 331         return new_d_{{node.name}}(
 332                 {%- filter arguments %}
 333                         NULL
 334                         {{node|nodearguments}}
 335                 {% endfilter %});
 336 }
 337 ''')
 338
 339 irnode_h_template = env.from_string(
 340 '''/* Warning: automatically generated code */
 341
 342 {%- for node in nodes|isnot('custom_is') %}
 343 static inline int _is_{{node.name}}(const ir_node *node)
 344 {
 345         assert(node != NULL);
 346         return _get_irn_op(node) == op_{{node.name}};
 347 }
 348 {%- endfor -%}
 349
 350 {% for node in nodes %}
 351 #define is_{{node.name}}(node)    _is_{{node.name}}(node)
 352 {%- endfor %}
 353
 354 ''')
 355
 356 irnode_template = env.from_string(
 357 '''/* Warning: automatically generated code */
 358 {% for node in nodes %}
 359 int (is_{{node.name}})(const ir_node *node)
 360 {
 361         return _is_{{node.name}}(node);
 362 }
 363 {% endfor %}
 364
 365 {%- for node in nodes %}
 366 {%- for attr in node.attrs|hasnot("noprop") %}
 367 {{attr.type}} (get_{{node.name}}_{{attr.name}})(const ir_node *node)
 368 {
 369         assert(is_{{node.name}}(node));
 370         return node->attr.{{node.attrs_name}}.{{attr.name}};
 371 }
 372
 373 void (set_{{node.name}}_{{attr.name}})(ir_node *node, {{attr.type}} {{attr.name}})
 374 {
 375         assert(is_{{node.name}}(node));
 376         node->attr.{{node.attrs_name}}.{{attr.name}} = {{attr.name}};
 377 }
 378 {% endfor -%}
 379 {% endfor -%}
 380
 381 {%- for node in nodes %}
 382 {%- for in in node.ins %}
 383 ir_node *(get_{{node.name}}_{{in}})(const ir_node *node)
 384 {
 385         assert(is_{{node.name}}(node));
 386         return get_irn_n(node, {{node.ins.index(in)}});
 387 }
 388
 389 void (set_{{node.name}}_{{in}})(ir_node *node, ir_node *{{in|escape_keywords}})
 390 {
 391         assert(is_{{node.name}}(node));
 392         set_irn_n(node, {{node.ins.index(in)}}, {{in|escape_keywords}});
 393 }
 394 {% endfor %}
 395 {% endfor %}
 396 ''')
 397
 398 irop_template = env.from_string(
 399 '''/* Warning: automatically generated code */
 400 {% for node in nodes %}
 401 ir_op *op_{{node.name}}; ir_op *get_op_{{node.name}}(void) { return op_{{node.name}}; }
 402 {%- endfor %}
 403
 404 void init_op(void)
 405 {
 406         {% for node in nodes %}
 407         op_{{node.name}} = new_ir_op(
 408                 {%- filter arguments %}
 409                         iro_{{node.name}}
 410                         "{{node.name}}"
 411                         {{node|pinned}}
 412                         {{node|flags}}
 413                         {{node|arity}}
 414                         {{node|opindex}}
 415                         {{node|attr_size}}
 416                         NULL
 417                 {% endfilter %});
 418         {%- endfor %}
 419
 420         be_init_op();
 421 }
 422
 423 void finish_op(void)
 424 {
 425         {% for node in nodes %}
 426         free_ir_op(op_{{node.name}}); op_{{node.name}} = NULL;
 427         {%- endfor %}
 428 }
 429
 430 ''')
 431
 432 nodeops_h_template = env.from_string(
 433 '''/* Warning: automatically generated code */
 434 #ifndef FIRM_IR_NODEOPS_H
 435 #define FIRM_IR_NODEOPS_H
 436
 437 #include "firm_types.h"
 438
 439 /**
 440  * @addtogroup ir_node
 441  * @{
 442  */
 443
 444 {% for node in nodes -%}
 445 {% if node.outs %}
 446 /**
 447  * Projection numbers for result of {{node.name}} node (use for Proj nodes)
 448  */
 449 typedef enum {
 450         {% for out in node.outs -%}
 451         pn_{{node.name}}_{{out[0]}}
 452         {%- if out.__len__() > 2 %} = {{out[2]}}{% endif %}, /**< {{out[1]}} */
 453         {% endfor -%}
 454         pn_{{node.name}}_max
 455 } pn_{{node.name}};
 456 {% endif %}
 457 {%- endfor %}
 458
 459 {% for node in nodes %}
 460 /** Return true of the node is a {{node.name}} node. */
 461 FIRM_API int is_{{node.name}}(const ir_node *node);
 462 {%- endfor %}
 463
 464 {% for node in nodes %}
 465 {% for in in node.ins -%}
 466 FIRM_API ir_node *get_{{node.name}}_{{in}}(const ir_node *node);
 467 void set_{{node.name}}_{{in}}(ir_node *node, ir_node *{{in|escape_keywords}});
 468 {% endfor -%}
 469 {% for attr in node.attrs|hasnot("noprop") -%}
 470 FIRM_API {{attr.type}} get_{{node.name}}_{{attr.name}}(const ir_node *node);
 471 FIRM_API void set_{{node.name}}_{{attr.name}}(ir_node *node, {{attr.type}} {{attr.name}});
 472 {% endfor -%}
 473 {% endfor -%}
 474
 475 /** @} */
 476
 477 #endif
 478 ''')
 479
 480 opcodes_h_template = env.from_string(
 481 '''/* Warning: automatically generated code */
 482 #ifndef FIRM_IR_OPCODES_H
 483 #define FIRM_IR_OPCODES_H
 484
 485 /** The opcodes of the libFirm predefined operations. */
 486 typedef enum ir_opcode {
 487 {%- for node in nodes %}
 488         iro_{{node.name}},
 489 {%- endfor %}
 490         iro_First = iro_{{nodes[0].name}},
 491         iro_Last = iro_{{nodes[-1].name}},
 492
 493         beo_First,
 494         /* backend specific nodes */
 495         beo_Spill = beo_First,
 496         beo_Reload,
 497         beo_Perm,
 498         beo_MemPerm,
 499         beo_Copy,
 500         beo_Keep,
 501         beo_CopyKeep,
 502         beo_Call,
 503         beo_Return,
 504         beo_AddSP,
 505         beo_SubSP,
 506         beo_IncSP,
 507         beo_Start,
 508         beo_FrameAddr,
 509         beo_Barrier,
 510         /* last backend node number */
 511         beo_Last = beo_Barrier,
 512         iro_MaxOpcode
 513 } ir_opcode;
 514
 515 {% for node in nodes %}
 516 FIRM_API ir_op *op_{{node.name}};
 517 {%- endfor %}
 518
 519 {% for node in nodes %}
 520 FIRM_API ir_op *get_op_{{node.name}}(void);
 521 {%- endfor %}
 522
 523 #endif
 524 ''')
 525
 526 #############################
 527
 528 def prepare_nodes():
 529         real_nodes = []
 530         for node in nodes:
 531                 if isAbstract(node):
 532                         continue
 533                 real_nodes.append(node)
 534
 535         for node in real_nodes:
 536                 preprocess_node(node)
 537
 538         return real_nodes
 539
 540 def main(argv):
 541         if len(argv) < 3:
 542                 print "usage: %s specname(ignored) destdirectory" % argv[0]
 543                 sys.exit(1)
 544
 545         gendir = argv[2]
 546         # hardcoded path to libfirm/include/libfirm
 547         gendir2 = argv[2] + "/../../include/libfirm"
 548
 549         # List of TODOs
 550         niymap = [ "ASM", "Const", "Phi", "SymConst" ]
 551
 552         real_nodes = prepare_nodes()
 553         file = open(gendir + "/gen_ir_cons.c.inl", "w")
 554         for node in real_nodes:
 555                 if node.name in niymap:
 556                         continue
 557
 558                 if not isAbstract(node) and not hasattr(node, "noconstructor"):
 559                         file.write(constructor_template.render(vars()))
 560
 561         file.write("\n")
 562         file.close()
 563
 564         file = open(gendir + "/gen_irnode.h", "w")
 565         file.write(irnode_h_template.render(nodes = real_nodes))
 566         file.close()
 567
 568         file = open(gendir + "/gen_irnode.c.inl", "w")
 569         file.write(irnode_template.render(nodes = real_nodes))
 570         file.close()
 571
 572         file = open(gendir + "/gen_irop.c.inl", "w")
 573         file.write(irop_template.render(nodes = real_nodes))
 574         file.close()
 575
 576         file = open(gendir2 + "/opcodes.h", "w")
 577         file.write(opcodes_h_template.render(nodes = real_nodes))
 578         file.close()
 579
 580         file = open(gendir2 + "/nodeops.h", "w")
 581         file.write(nodeops_h_template.render(nodes = real_nodes))
 582         file.close()
 583
 584 main(sys.argv)