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(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 /************************************************************************
 216  * Dumps the left hand side of the rule
 217  ************************************************************************/
 218
 219 static int dump_pattern(grgen_dumpinfo_t *dump_info, FILE *fp)
 220 {
 221         struct pmap *nodes_to_dump = dump_info->nodes_to_dump;
 222         pmap_entry *entry;
 223         int uses_memory = 0;
 224
 225         // Dump all nodes
 226         foreach_pmap(nodes_to_dump, entry)
 227         {
 228                 ir_node *n = (ir_node *) entry->key;
 229
 230                 // Dump node
 231                 if(get_irn_opcode(n) == iro_Proj && get_irn_modecode(n) == irm_M)
 232                         uses_memory = 1;
 233                 dump_grg_node(n, dump_info, fp);
 234                 dump_grgen_mode(n, dump_info, fp, NULL);
 235         }
 236
 237         // Dump all edges
 238         foreach_pmap(nodes_to_dump, entry)
 239         {
 240                 ir_node *n = (ir_node *) entry->key;
 241                 int i;
 242
 243                 // Dump edges
 244                 for(i = -1; i < get_irn_arity(n); i++)
 245                         dump_grg_egde(n, i, dump_info, fp);
 246         }
 247
 248         fprintf(fp, "%seval {\n", indent);
 249         set_indent(6);
 250         foreach_pmap(nodes_to_dump, entry)
 251         {
 252                 ir_node *n = (ir_node *) entry->key;
 253                 dump_grgen_eval(n, dump_info, fp);
 254         }
 255         set_indent(4);
 256         fprintf(fp, "%s}\n", indent);
 257
 258
 259         set_indent(2);
 260         fprintf(fp, "%s} /* Replacement */\n", indent);
 261         return(uses_memory);
 262 }
 263
 264
 265
 266 /************************************************************************
 267 * Dumps a node in GrGen Format
 268 ************************************************************************/
 269
 270 static void dump_grg_node(ir_node *n, grgen_dumpinfo_t *dump_info, FILE *fp)
 271 {
 272         char *node_name;
 273
 274         // Already dumped the node? Then do nothing
 275         if(pmap_contains(dump_info -> node_name_map, n))
 276                 return;
 277
 278         // Else generate new node name and dump the node
 279
 280         node_name = obstack_alloc(&(dump_info -> node_names), MAX_NODENAME_LEN);
 281
 282         sprintf(node_name, "%s%ld", get_op_name(get_irn_op(n)), get_irn_node_nr(n));
 283         fprintf(fp, "%s%s : %s;\n", indent, node_name, get_op_name(get_irn_op(n)));
 284
 285         pmap_insert(dump_info -> node_name_map, n, node_name);
 286         node_counter++;
 287 }
 288
 289
 290
 291 /************************************************************************
 292 * Dumps an edge in GrGen format
 293 ************************************************************************/
 294
 295 static void dump_grg_egde(ir_node *n, int n_edge, grgen_dumpinfo_t *dump_info, FILE *fp)
 296 {
 297         ir_node *to_node;
 298         char *from_node_name, *to_node_name;
 299         char **nodes_edge_names;
 300
 301
 302         // Check if to_node has also to be dumped. If not, skip this edge
 303         // We have to dump to_node here, because to_node has to be known by grgen before
 304         // connecting an edge to it.
 305         to_node =  get_irn_n(n, n_edge);
 306         if(!pmap_contains(dump_info -> nodes_to_dump, to_node))
 307                 return;
 308
 309         if((nodes_edge_names = pmap_get(dump_info -> edge_name_map, n)) == NULL)
 310         {
 311                 nodes_edge_names = (char **) obstack_alloc(&(dump_info->node_names), (get_irn_arity(n) + 1) * sizeof(char *));
 312                 memset(nodes_edge_names, 0, (get_irn_arity(n) + 1) * sizeof(char *));
 313                 pmap_insert(dump_info->edge_name_map, n, nodes_edge_names);
 314         }
 315
 316         assert(pmap_contains(dump_info -> node_name_map, n));
 317         assert(pmap_contains(dump_info -> node_name_map, to_node));
 318         from_node_name = (char *) pmap_get(dump_info -> node_name_map, n);
 319         to_node_name = (char *) pmap_get(dump_info -> node_name_map, to_node);
 320
 321         {
 322
 323         char edge_name[50], *edge_name_obst;
 324
 325         sprintf(edge_name, "pos%d_%d", n_edge + 1, edge_counter++);
 326         edge_name_obst = obstack_alloc(&(dump_info->node_names), strlen(edge_name) + 1);
 327         strcpy(edge_name_obst, edge_name);
 328         nodes_edge_names[n_edge + 1] = edge_name_obst;
 329
 330         fprintf(fp, "%s%s -%s:df-> %s;\n", indent, from_node_name, edge_name_obst, to_node_name);
 331         }
 332
 333
 334 }
 335
 336
 337
 338 /************************************************************************
 339 * Dumps an FIRM Mode as GrGen Code
 340 * If source_node_name == NULL, that name of n that was already
 341 * generated is used.
 342 * If source_node_name != NULL, this given source will be used
 343 * (useful for retyped nodes)
 344 ************************************************************************/
 345
 346 static void dump_grgen_mode(ir_node *n, grgen_dumpinfo_t *dump_info, FILE *fp, ir_mode *alt_mode)
 347 {
 348         char *node_name = (char *) pmap_get(dump_info -> node_name_map, n);
 349         ir_mode *irn_mode = (alt_mode != NULL) ? alt_mode : get_irn_mode(n);
 350         char edge_name[50];
 351         char *mode_node_name;
 352
 353         mode_node_name = dump_grgen_mode_node(irn_mode, dump_info, fp);
 354
 355         //mode_code =  get_mode_modecode(irn_mode);
 356         //mode_name =  get_mode_name(irn_mode);
 357
 358         // Yes, use the given mode-node
 359         //mode_node_name = pmap_get(dump_info -> mode_name_map, (void *) mode_code);
 360         sprintf(edge_name, "m%d", edge_counter++);
 361
 362         if(pmap_get(dump_info->mode_edge_map, n) == NULL)
 363         {
 364                 char *edge_name_obst = obstack_alloc(&(dump_info->node_names), strlen(edge_name) + 1);
 365                 strcpy(edge_name_obst, edge_name);
 366                 pmap_insert(dump_info->mode_edge_map, n, edge_name_obst);
 367         }
 368
 369         // Dump the edge from the current node to it's mode node
 370         fprintf(fp, "%s%s -%s:has_mode-> %s;\n", indent, node_name, edge_name, mode_node_name);
 371 }
 372
 373
 374
 375 /************************************************************************
 376 * Dumps a node representing a node
 377 ************************************************************************/
 378
 379 static char *dump_grgen_mode_node(ir_mode *irn_mode, grgen_dumpinfo_t *dump_info, FILE *fp)
 380 {
 381         modecode mode_code = get_mode_modecode(irn_mode);
 382         const char *mode_name =  get_mode_name(irn_mode);
 383         char *mode_node_name;
 384
 385         if(!pmap_contains(dump_info -> mode_name_map, (void *) mode_code))
 386         {
 387                 // No, create a new mode-node
 388                 mode_node_name = obstack_alloc(&(dump_info -> mode_names), MAX_NODENAME_LEN);
 389                 sprintf(mode_node_name, "mode_%s_node", mode_name);
 390                 pmap_insert(dump_info -> mode_name_map, (void *) mode_code, mode_node_name);
 391                 fprintf(fp, "%s%s : Mode_%s;\n", indent, mode_node_name, mode_name);
 392                 return(mode_node_name);
 393         }
 394         else
 395         {
 396                 return((char *) pmap_get(dump_info -> mode_name_map, (void *) mode_code));
 397         }
 398
 399 }
 400
 401
 402
 403 /************************************************************************
 404 * Dumps the condition for the given node, depending on the node's
 405 * attributes and the node's opcode
 406 ************************************************************************/
 407
 408 static void dump_grgen_eval(ir_node *n, grgen_dumpinfo_t *dump_info, FILE *fp)
 409 {
 410         char *node_name;
 411         ir_opcode code = get_irn_opcode(n);
 412
 413         if(code == iro_Const)
 414         {
 415                 node_name = pmap_get(dump_info->node_name_map, n);
 416                 fprintf(fp, "%s%s.value = \"%ld\";\n", indent, node_name, get_tarval_long(get_Const_tarval(n)));
 417         }
 418
 419
 420         if(code == iro_Proj)
 421         {
 422                 node_name = pmap_get(dump_info->node_name_map, n);
 423                 fprintf(fp, "%s%s.proj = %ld;\n", indent, node_name, get_Proj_proj(n));
 424         }
 425
 426         /*if(code == iro_Block)
 427         {
 428                 node_name = pmap_get(dump_info->node_name_map, n);
 429                 fprintf(fp, "%s%s.pos = %d;\n", indent, node_name, ??);
 430         }
 431
 432         if(code == iro_Phi)
 433         {
 434                 node_name = pmap_get(dump_info->node_name_map, n);
 435                 fprintf(fp, "%s%s.pos = %d;\n", indent, node_name, ??);
 436         }*/
 437
 438         // TODO: Dump Block evals: edge numbers
 439
 440
 441         if(code == iro_Phi || code == iro_Block)
 442         {
 443                 char **edge_names;
 444                 int i;
 445
 446                 //assert((get_irn_arity(n) == get_irn_arity(phi_block)) && "Phi has other arity than it's block! Pattern seems to be broken.");
 447
 448                 // Load the edge names that have been saved
 449                 edge_names = pmap_get(dump_info->edge_name_map, n);
 450                 assert(edge_names && "Some edge names have not been dumped!");
 451
 452                 // Correlate the matched phi edges with the matched block edges
 453                 // Caution: Position 0 in the edge_names array is the block edge, so start at 1
 454                 for(i = 0; i < get_irn_arity(n) + 1; i++)
 455                 {
 456                         assert(edge_names[i] != NULL && "Some edges have not been dumped!");
 457
 458                         fprintf(fp, "%s%s.pos = %d;\n", indent, edge_names[i], i);
 459                 }
 460                 return;
 461         }
 462 }
 463
 464
 465
 466
 467
 468 /************************************************************************
 469 * Sets current indent
 470 ************************************************************************/
 471
 472 static void set_indent(int i)
 473 {
 474         int j;
 475
 476         // Generate a string containing i blank characters
 477         if(i < MAX_INDENT - 1)
 478         {
 479                 for(j = 0; j < i; j++)
 480                         indent[j] = ' ';
 481                 indent[j] = 0x0;
 482         }
 483 }