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