nsz Git - libfirm/blob - ir/ir/irdump_grgen.c

   1 /*
   2 * Copyright (C) 1995-2007 University of Karlsruhe.  All right reserved.
   3 *
   4 * This file is part of libFirm.
   5 *
   6 * This file may be distributed and/or modified under the terms of the
   7 * GNU General Public License version 2 as published by the Free Software
   8 * Foundation and appearing in the file LICENSE.GPL included in the
   9 * packaging of this file.
  10 *
  11 * Licensees holding valid libFirm Professional Edition licenses may use
  12 * this file in accordance with the libFirm Commercial License.
  13 * Agreement provided with the Software.
  14 *
  15 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
  16 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17 * PURPOSE.
  18 */
  19
  20 /**
  21 * @file
  22 * @brief   Write ir graph as a grgen construction rule
  23 * @author  Andreas Schoesser
  24 * @version $Id$
  25 */
  26
  27 /*
  28  * THIS IS A COMPLETE QUICK HACK! USE WITH CARE
  29  * NOT FOR PRODUCTION BUILD ;-)
  30  */
  31
  32 #define MAX_NODENAME_LEN 100
  33
  34 #include <assert.h>
  35 #include <stdio.h>
  36 #include <obst.h>
  37
  38
  39 #include "irgraph.h"
  40 #include "firm_types.h"
  41 #include "pmap.h"
  42 #include "tv.h"
  43 #include "irgwalk.h"
  44 #include "firm_types.h"
  45
  46
  47 typedef struct
  48 {
  49         ir_graph *irg;
  50         struct pmap *mode_edge_map;
  51         struct pmap *edge_name_map;
  52         struct pmap *node_name_map;  // Contains the mapping firm node -> node name
  53         struct obstack node_names;   // Contains the node name data
  54         struct pmap *mode_name_map;  // Contains the mapping firm mode -> mode node name
  55         struct obstack mode_names;   // Contains the "mode node name" data
  56         struct pmap *nodes_to_dump;  // Contains firm nodes, that have to be dumped
  57 } grgen_dumpinfo_t;
  58
  59 typedef struct                  // Holds information needed througout the usage of a grgen dumper instance
  60 {
  61         FILE *output_file;      // The file the grgen rules will be dumped to
  62 } irg_grgen_dumper_env_t;
  63
  64 static void dump_grg_node(ir_node *n, grgen_dumpinfo_t *dump_info, FILE *fp);
  65 static void dump_grg_egde(ir_node *n, int n_edge, grgen_dumpinfo_t *dump_info, FILE *fp);
  66 static void dump_grgen_mode(ir_node *n, grgen_dumpinfo_t *dump_info, FILE *fp, ir_mode *alt_mode);
  67 static char *dump_grgen_mode_node(ir_mode *irn_mode, grgen_dumpinfo_t *dump_info, FILE *fp);
  68 static void dump_grgen_eval(ir_node *n, grgen_dumpinfo_t *dump_info, FILE *fp);
  69 static int dump_pattern(grgen_dumpinfo_t *dump_info, FILE *fp);
  70 static void set_indent(int i);
  71
  72
  73
  74 /*****************************************************************************
  75 * Program:              grgen_dumper.c
  76 * Function:             Dumps parts of a firm graph (those which have to be extracted
  77 *                               as search and replace patterns) as a grGen rule.
  78 * Depends on:   Needs the analysis info generated by the pattern creator
  79 * Author:               Andreas Schoesser
  80 * Date:         2006-12-07
  81 *****************************************************************************/
  82
  83
  84 // ---------------------------- INCLUDES --------------------------------
  85
  86
  87
  88
  89 /* #include "grgen_dumper__t.h"
  90 #include "create_pattern_t.h"
  91 #include "firm_node_ext.h" */
  92
  93 // ----------------------------- GLOABALS --------------------------------
  94
  95 // Saves the current indent value and keeps spaces in a string
  96 #define MAX_INDENT 100
  97 static char indent[MAX_INDENT] = "";
  98
  99 // Saves the current node number to generate node names
 100 static int node_counter;
 101 static int edge_counter;
 102
 103
 104
 105
 106 /************************************************************************
 107 * Initializes the grgen_dumper module and dumps the GrGen File header
 108 * Returns:              An environment to be passed to all functions of the GrGen
 109 *                               dumper.
 110 * Parameters:   file:   filename of the file to dump to
 111 *                               append: 1 if the previous file content should be
 112 *                                               maintained.
 113 ************************************************************************/
 114
 115 irg_grgen_dumper_env_t *init_irg_grgen_dumper(char *file, int append)
 116 {
 117         irg_grgen_dumper_env_t *const grgen_dumper_env = xmalloc(sizeof(*grgen_dumper_env));
 118         FILE *fp;
 119
 120         if(append)
 121                 fp = fopen(file, "at");
 122         else
 123         {
 124                 fp = fopen(file, "wt");
 125
 126                 // *** Dump header
 127                 fprintf(fp, "%susing Firm;\n\n", indent);
 128         }
 129
 130         grgen_dumper_env -> output_file = fp;
 131         return(grgen_dumper_env);
 132 }
 133
 134
 135
 136 /************************************************************************
 137 * Frees information used by the grgen_dumper and closes the output file
 138 ************************************************************************/
 139
 140 void deinit_irg_grgen_dumper(irg_grgen_dumper_env_t *grgen_dumper_env)
 141 {
 142         fclose(grgen_dumper_env->output_file);
 143         xfree(grgen_dumper_env);
 144 }
 145
 146 static void collect_nodes(ir_node *n, void * env)
 147 {
 148         pmap *nodes_to_dump = (pmap *) env;
 149
 150         pmap_insert(nodes_to_dump, n, NULL);
 151 }
 152
 153
 154
 155
 156 /************************************************************************
 157  * Starts dumping
 158  ************************************************************************/
 159
 160 void dump_irg_grgen_file(ir_graph *irg, char *filename, int append)
 161 {
 162         FILE *fp;
 163         grgen_dumpinfo_t dump_info;
 164         int uses_memory = 0;
 165
 166
 167         irg_grgen_dumper_env_t *grgen_dumper_env = init_irg_grgen_dumper(filename, append);
 168         fp = grgen_dumper_env -> output_file;
 169
 170         // Do initialization
 171         dump_info.irg = irg;                    // Basically copy the graph_ana_struct, ugly
 172         dump_info.mode_edge_map = pmap_create();                // Create some additional pmaps to hold
 173         dump_info.edge_name_map = pmap_create();                // node and edge name information etc.
 174         dump_info.node_name_map = pmap_create();
 175         dump_info.mode_name_map = pmap_create();
 176         dump_info.nodes_to_dump = pmap_create();
 177
 178         // Node and egde count start at 0 for each pattern to be dumped.
 179         node_counter = 0;
 180         edge_counter = 0;
 181         obstack_init(&(dump_info.node_names));
 182         obstack_init(&(dump_info.mode_names));
 183
 184         // Dump rule header
 185         set_indent(0);
 186         fprintf(fp, "\n\n%srule %s\n%s{\n", indent, get_entity_name(get_irg_entity(irg)), indent);
 187         set_indent(2);
 188
 189         fprintf(fp, "%spattern { }\n", indent);                  // Empty pattern
 190         fprintf(fp, "%sreplace\n%s{\n", indent, indent); // Graph is contrcuted in the replacement part
 191
 192         set_indent(4);
 193
 194         irg_walk_graph(irg, collect_nodes, NULL, dump_info.nodes_to_dump);
 195         uses_memory = dump_pattern(&dump_info, fp);
 196
 197         // *** Dump footer
 198         set_indent(0);
 199         fprintf(fp, "%s}\n", indent);
 200
 201         // Clean up
 202         pmap_destroy(dump_info.mode_edge_map);
 203         pmap_destroy(dump_info.edge_name_map);
 204         pmap_destroy(dump_info.node_name_map);
 205         pmap_destroy(dump_info.mode_name_map);
 206         obstack_free(&(dump_info.node_names), NULL);
 207         obstack_finish(&(dump_info.node_names));
 208         obstack_free(&(dump_info.mode_names), NULL);
 209         obstack_finish(&(dump_info.mode_names));
 210
 211         deinit_irg_grgen_dumper(grgen_dumper_env);
 212 }
 213
 214
 215 void dump_irg_grgen(ir_graph *irg, char *suffix)
 216 {
 217   char filename[100] = "";
 218
 219   strncat(filename, get_entity_name(get_irg_entity(irg)), 100);
 220   strncat(filename, suffix, 100);
 221   strncat(filename, ".grg", 100);
 222
 223   dump_irg_grgen_file(irg, filename, 0);
 224 }
 225
 226
 227 /************************************************************************
 228  * Dumps the left hand side of the rule
 229  ************************************************************************/
 230
 231 static int dump_pattern(grgen_dumpinfo_t *dump_info, FILE *fp)
 232 {
 233         struct pmap *nodes_to_dump = dump_info->nodes_to_dump;
 234         pmap_entry *entry;
 235         int uses_memory = 0;
 236
 237         // Dump all nodes
 238         foreach_pmap(nodes_to_dump, entry)
 239         {
 240                 ir_node *n = (ir_node *) entry->key;
 241
 242                 // Dump node
 243                 if(get_irn_opcode(n) == iro_Proj && get_irn_modecode(n) == irm_M)
 244                         uses_memory = 1;
 245                 dump_grg_node(n, dump_info, fp);
 246                 dump_grgen_mode(n, dump_info, fp, NULL);
 247         }
 248
 249         // Dump all edges
 250         foreach_pmap(nodes_to_dump, entry)
 251         {
 252                 ir_node *n = (ir_node *) entry->key;
 253                 int i;
 254
 255                 // Dump edges
 256                 for(i = is_Block(n) ? 0 : -1; i < get_irn_arity(n); i++)
 257                         dump_grg_egde(n, i, dump_info, fp);
 258         }
 259
 260         fprintf(fp, "%seval {\n", indent);
 261         set_indent(6);
 262         foreach_pmap(nodes_to_dump, entry)
 263         {
 264                 ir_node *n = (ir_node *) entry->key;
 265                 dump_grgen_eval(n, dump_info, fp);
 266         }
 267         set_indent(4);
 268         fprintf(fp, "%s}\n", indent);
 269
 270
 271         set_indent(2);
 272         fprintf(fp, "%s} /* Replacement */\n", indent);
 273         return(uses_memory);
 274 }
 275
 276
 277
 278 /************************************************************************
 279 * Dumps a node in GrGen Format
 280 ************************************************************************/
 281
 282 static void dump_grg_node(ir_node *n, grgen_dumpinfo_t *dump_info, FILE *fp)
 283 {
 284         char *node_name;
 285
 286         // Already dumped the node? Then do nothing
 287         if(pmap_contains(dump_info -> node_name_map, n))
 288                 return;
 289
 290         // Else generate new node name and dump the node
 291
 292         node_name = obstack_alloc(&(dump_info -> node_names), MAX_NODENAME_LEN);
 293
 294         sprintf(node_name, "%s%ld", get_op_name(get_irn_op(n)), get_irn_node_nr(n));
 295         fprintf(fp, "%s%s : %s;\n", indent, node_name, get_op_name(get_irn_op(n)));
 296
 297         pmap_insert(dump_info -> node_name_map, n, node_name);
 298         node_counter++;
 299 }
 300
 301
 302
 303 /************************************************************************
 304 * Dumps an edge in GrGen format
 305 ************************************************************************/
 306
 307 static void dump_grg_egde(ir_node *n, int n_edge, grgen_dumpinfo_t *dump_info, FILE *fp)
 308 {
 309         ir_node *to_node;
 310         char *from_node_name, *to_node_name;
 311         char **nodes_edge_names;
 312
 313
 314         // Check if to_node has also to be dumped. If not, skip this edge
 315         // We have to dump to_node here, because to_node has to be known by grgen before
 316         // connecting an edge to it.
 317         to_node =  get_irn_n(n, n_edge);
 318         if(!pmap_contains(dump_info -> nodes_to_dump, to_node))
 319                 return;
 320
 321         if((nodes_edge_names = pmap_get(dump_info -> edge_name_map, n)) == NULL)
 322         {
 323                 nodes_edge_names = (char **) obstack_alloc(&(dump_info->node_names), (get_irn_arity(n) + 1) * sizeof(char *));
 324                 memset(nodes_edge_names, 0, (get_irn_arity(n) + 1) * sizeof(char *));
 325                 pmap_insert(dump_info->edge_name_map, n, nodes_edge_names);
 326         }
 327
 328         assert(pmap_contains(dump_info -> node_name_map, n));
 329         assert(pmap_contains(dump_info -> node_name_map, to_node));
 330         from_node_name = (char *) pmap_get(dump_info -> node_name_map, n);
 331         to_node_name = (char *) pmap_get(dump_info -> node_name_map, to_node);
 332
 333         {
 334
 335         char edge_name[50], *edge_name_obst;
 336
 337         sprintf(edge_name, "pos%d_%d", n_edge + 1, edge_counter++);
 338         edge_name_obst = obstack_alloc(&(dump_info->node_names), strlen(edge_name) + 1);
 339         strcpy(edge_name_obst, edge_name);
 340         nodes_edge_names[n_edge + 1] = edge_name_obst;
 341
 342         fprintf(fp, "%s%s -%s:df-> %s;\n", indent, from_node_name, edge_name_obst, to_node_name);
 343         }
 344
 345
 346 }
 347
 348
 349
 350 /************************************************************************
 351 * Dumps an FIRM Mode as GrGen Code
 352 * If source_node_name == NULL, that name of n that was already
 353 * generated is used.
 354 * If source_node_name != NULL, this given source will be used
 355 * (useful for retyped nodes)
 356 ************************************************************************/
 357
 358 static void dump_grgen_mode(ir_node *n, grgen_dumpinfo_t *dump_info, FILE *fp, ir_mode *alt_mode)
 359 {
 360         char *node_name = (char *) pmap_get(dump_info -> node_name_map, n);
 361         ir_mode *irn_mode = (alt_mode != NULL) ? alt_mode : get_irn_mode(n);
 362         char edge_name[50];
 363         char *mode_node_name;
 364
 365         mode_node_name = dump_grgen_mode_node(irn_mode, dump_info, fp);
 366
 367         //mode_code =  get_mode_modecode(irn_mode);
 368         //mode_name =  get_mode_name(irn_mode);
 369
 370         // Yes, use the given mode-node
 371         //mode_node_name = pmap_get(dump_info -> mode_name_map, (void *) mode_code);
 372         sprintf(edge_name, "m%d", edge_counter++);
 373
 374         if(pmap_get(dump_info->mode_edge_map, n) == NULL)
 375         {
 376                 char *edge_name_obst = obstack_alloc(&(dump_info->node_names), strlen(edge_name) + 1);
 377                 strcpy(edge_name_obst, edge_name);
 378                 pmap_insert(dump_info->mode_edge_map, n, edge_name_obst);
 379         }
 380
 381         // Dump the edge from the current node to it's mode node
 382         fprintf(fp, "%s%s -%s:has_mode-> %s;\n", indent, node_name, edge_name, mode_node_name);
 383 }
 384
 385
 386
 387 /************************************************************************
 388 * Dumps a node representing a node
 389 ************************************************************************/
 390
 391 static char *dump_grgen_mode_node(ir_mode *irn_mode, grgen_dumpinfo_t *dump_info, FILE *fp)
 392 {
 393         modecode mode_code = get_mode_modecode(irn_mode);
 394         const char *mode_name =  get_mode_name(irn_mode);
 395         char *mode_node_name;
 396
 397         if(!pmap_contains(dump_info -> mode_name_map, (void *) mode_code))
 398         {
 399                 // No, create a new mode-node
 400                 mode_node_name = obstack_alloc(&(dump_info -> mode_names), MAX_NODENAME_LEN);
 401                 sprintf(mode_node_name, "mode_%s_node", mode_name);
 402                 pmap_insert(dump_info -> mode_name_map, (void *) mode_code, mode_node_name);
 403                 fprintf(fp, "%s%s : Mode_%s;\n", indent, mode_node_name, mode_name);
 404                 return(mode_node_name);
 405         }
 406         else
 407         {
 408                 return((char *) pmap_get(dump_info -> mode_name_map, (void *) mode_code));
 409         }
 410
 411 }
 412
 413
 414
 415 /************************************************************************
 416 * Dumps the condition for the given node, depending on the node's
 417 * attributes and the node's opcode
 418 ************************************************************************/
 419
 420 static void dump_grgen_eval(ir_node *n, grgen_dumpinfo_t *dump_info, FILE *fp)
 421 {
 422         char *node_name;
 423         ir_opcode code = get_irn_opcode(n);
 424
 425         if(code == iro_Const)
 426         {
 427                 node_name = pmap_get(dump_info->node_name_map, n);
 428                 fprintf(fp, "%s%s.value = \"%ld\";\n", indent, node_name, get_tarval_long(get_Const_tarval(n)));
 429         }
 430
 431
 432         if(code == iro_Proj)
 433         {
 434                 node_name = pmap_get(dump_info->node_name_map, n);
 435                 fprintf(fp, "%s%s.proj = %ld;\n", indent, node_name, get_Proj_proj(n));
 436         }
 437
 438         /*if(code == iro_Block)
 439         {
 440                 node_name = pmap_get(dump_info->node_name_map, n);
 441                 fprintf(fp, "%s%s.pos = %d;\n", indent, node_name, ??);
 442         }
 443
 444         if(code == iro_Phi)
 445         {
 446                 node_name = pmap_get(dump_info->node_name_map, n);
 447                 fprintf(fp, "%s%s.pos = %d;\n", indent, node_name, ??);
 448         }*/
 449
 450         // TODO: Dump Block evals: edge numbers
 451
 452
 453         if(code == iro_Phi || code == iro_Block)
 454         {
 455                 char **edge_names;
 456                 int i;
 457
 458                 //assert((get_irn_arity(n) == get_irn_arity(phi_block)) && "Phi has other arity than it's block! Pattern seems to be broken.");
 459
 460                 // Load the edge names that have been saved
 461                 edge_names = pmap_get(dump_info->edge_name_map, n);
 462                 assert(edge_names && "Some edge names have not been dumped!");
 463
 464                 // Correlate the matched phi edges with the matched block edges
 465                 // Caution: Position 0 in the edge_names array is the block edge, so start at 1
 466                 for(i = code == iro_Block; i < get_irn_arity(n) + 1; i++)
 467                 {
 468                         assert(edge_names[i] != NULL && "Some edges have not been dumped!");
 469
 470                         fprintf(fp, "%s%s.pos = %d;\n", indent, edge_names[i], i);
 471                 }
 472                 return;
 473         }
 474 }
 475
 476
 477
 478
 479
 480 /************************************************************************
 481 * Sets current indent
 482 ************************************************************************/
 483
 484 static void set_indent(int i)
 485 {
 486         int j;
 487
 488         // Generate a string containing i blank characters
 489         if(i < MAX_INDENT - 1)
 490         {
 491                 for(j = 0; j < i; j++)
 492                         indent[j] = ' ';
 493                 indent[j] = 0x0;
 494         }
 495 }