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