nsz Git - libfirm/blob - include/libfirm/irdump.h

   1 /*
   2  * Copyright (C) 1995-2008 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 vcg representation of firm to file.
  23  * @author  Martin Trapp, Christian Schaefer, Goetz Lindenmaier, Hubert Schmidt
  24  * @version $Id$
  25  * @brief
  26  *  Dump routines for the ir graph and all type information.
  27  *
  28  *  The dump format of most functions is vcg.  This is a text based graph
  29  *  representation. Some use the original format,
  30  *  but most generate an extended format that is only read by some special
  31  *  versions of xvcg or by the comercialized version now calles aiSee.
  32  *  A test version of aiSee is available at
  33  *   http://www.absint.de/aisee/download/index.htm.
  34  *
  35  *  We have developed an own advanced viewer called ycomp:
  36  *    http://www.info.uni-karlsruhe.de/software.php/id=6&lang=en
  37  *
  38  *  Most routines use the name of the passed entity as the name of the
  39  *  file dumped to.
  40  */
  41 #ifndef FIRM_IR_IRDUMP_H
  42 #define FIRM_IR_IRDUMP_H
  43
  44 #include <stdio.h>
  45
  46 #include "firm_types.h"
  47 #include "begin.h"
  48
  49 /**
  50  * Symbolic names for the different dumping colors.
  51  */
  52 typedef enum ird_color_t {
  53         ird_color_prog_background,
  54         ird_color_block_background,
  55         ird_color_dead_block_background,
  56         ird_color_block_inout,
  57         ird_color_default_node,
  58         ird_color_phi,
  59         ird_color_memory,
  60         ird_color_controlflow,
  61         ird_color_const,
  62         ird_color_anchor,
  63         ird_color_proj,
  64         ird_color_uses_memory,
  65         ird_color_error,
  66         ird_color_entity,
  67         ird_color_count
  68 } ird_color_t;
  69
  70 /**
  71  * Edge kinds.
  72  */
  73 typedef enum {
  74         data_edge           = 0x01,   /**< A data edge between two basic blocks. */
  75         block_edge          = 0x02,   /**< An edge from a node to its basic block. */
  76         cf_edge             = 0x03,   /**< A regularly control flow edge. */
  77         exc_cf_edge         = 0x04,   /**< An exceptional control flow edge. */
  78         mem_edge            = 0x05,   /**< A memory edge. */
  79         dominator_edge      = 0x06,   /**< A dominator edge from a block to its immediate dominator. */
  80         node2type_edge      = 0x07,   /**< An edge from an IR node to a type. */
  81
  82         ent_type_edge       = 0x11,   /**< An edge from an entity to its type. */
  83         ent_own_edge        = 0x12,   /**< An edge from an entity to its owner type. */
  84         ent_overwrites_edge = 0x13,   /**< An edge from an entity to the entity it overwrites. */
  85         ent_value_edge      = 0x14,   /**< An edge from an entity to its value entity. */
  86         ent_corr_edge       = 0x15,   /**< An edge from an entity to the member entity its initializes. */
  87
  88         meth_par_edge       = 0x21,   /**< An edge from a method type to one of its parameter types. */
  89         meth_res_edge       = 0x22,   /**< An edge from a method type to one of its result types. */
  90         type_super_edge     = 0x23,   /**< An edge from a class type to its super/basis type. */
  91         union_edge          = 0x24,   /**< An edge from a union type to its member types. */
  92         ptr_pts_to_edge     = 0x25,   /**< An edge from a pointer type to its points-to type. */
  93         arr_elt_type_edge   = 0x26,   /**< An edge from an array type to its element type. */
  94         arr_ent_edge        = 0x27,   /**< An edge from a array type to its element entity. */
  95         type_member_edge    = 0x28,   /**< An edge from a compound type to its member entities. */
  96
  97         /* additional flags */
  98         intra_edge          = 0,      /**< Intra edge flag: edge do not cross basic block boundaries */
  99         inter_edge          = 0x40,   /**< Inter edge flag: edge cross basic block boundaries */
 100         back_edge           = 0x80    /**< Backwards edge flag. */
 101 } edge_kind;
 102
 103 /* **************************************************************************** */
 104 /*                                 GRAPH DUMPERS                                */
 105 /* **************************************************************************** */
 106
 107 /**
 108  * This hook is called to insert some special nodes into dumped graph
 109  */
 110 typedef int (*DUMP_IR_GRAPH_FUNC)(FILE *F, ir_graph *irg);
 111 /**
 112  * This hook is called to dump the vcg attributes of a node to a file.
 113  * If this function returns zero, the default attributes are added, else
 114  * removed.
 115  */
 116 typedef int (*DUMP_NODE_VCGATTR_FUNC)(FILE *F, ir_node *node, ir_node *local);
 117 /**
 118  * This hook is called to dump the vcg attributes of an edge to a file.
 119  * If this function returns zero, the default attributes are added, else
 120  * removed.
 121  */
 122 typedef int (*DUMP_EDGE_VCGATTR_FUNC)(FILE *F, ir_node *node, int to);
 123
 124 /** Set the ir graph dump hook. */
 125 FIRM_DLL void set_dump_ir_graph_hook(DUMP_IR_GRAPH_FUNC hook);
 126 /** Set the node_vcgattr hook. */
 127 FIRM_DLL void set_dump_node_vcgattr_hook(DUMP_NODE_VCGATTR_FUNC hook);
 128 /** Set the edge_vcgattr hook. */
 129 FIRM_DLL void set_dump_edge_vcgattr_hook(DUMP_EDGE_VCGATTR_FUNC hook);
 130
 131 typedef int (*DUMP_NODE_EDGE_FUNC)(FILE *f, ir_node *node);
 132
 133 /**
 134  * Set the hook to be called to dump additional edges to a node.
 135  * @param func The hook to be called.
 136  */
 137 FIRM_DLL void set_dump_node_edge_hook(DUMP_NODE_EDGE_FUNC func);
 138
 139 /**
 140  * Get the additional edge dump hook.
 141  * @return The current additional edge dump hook.]
 142  */
 143 FIRM_DLL DUMP_NODE_EDGE_FUNC get_dump_node_edge_hook(void);
 144
 145 /**
 146  * Set the hook to be called to dump additional edges to a block.
 147  * @param func The hook to be called.
 148  */
 149 FIRM_DLL void set_dump_block_edge_hook(DUMP_NODE_EDGE_FUNC func);
 150
 151 /**
 152  * Get the additional block edge dump hook.
 153  * @return The current additional block edge dump hook.
 154  */
 155 FIRM_DLL DUMP_NODE_EDGE_FUNC get_dump_block_edge_hook(void);
 156
 157 /** Dump a firm graph.
 158  *
 159  *  @param irg     The firm graph to be dumped.
 160  *  @param suffix  A suffix for the file name.
 161  *
 162  *  @return
 163  *     A file containing the firm graph in vcg format.
 164  *
 165  *  Dumps all Firm nodes of a single graph for a single procedure in
 166  *  standard xvcg format.  Dumps the graph to a file.  The file name
 167  *  is constructed from the name of the entity describing the
 168  *  procedure (irg->entity) and the ending -pure<-ip>.vcg.  Eventually
 169  *  overwrites existing files.  Visits all nodes in
 170  *  interprocedural_view.
 171  *
 172  * @see turn_off_edge_labels()
 173  */
 174 FIRM_DLL void dump_ir_graph(ir_graph *irg, const char *suffix);
 175 FIRM_DLL void dump_ir_graph_file(ir_graph *irg, FILE *out);
 176
 177 /** Dump a firm graph without explicit block nodes.
 178  *
 179  *  @param irg     The firm graph to be dumped.
 180  *  @param suffix  A suffix for the file name.
 181  *
 182  *  @return
 183  *     A file containing the firm graph in vcg format.
 184  *
 185  *  Dumps all Firm nodes of a single graph for a single procedure in
 186  *  extended xvcg format.
 187  *  Dumps the graph to a file.  The file name is constructed from the
 188  *  name of the entity describing the procedure (irg->entity) and the
 189  *  ending <-ip>.vcg.  Eventually overwrites existing files.  Dumps several
 190  *  procedures in boxes if interprocedural_view.
 191  *
 192  * @see turn_off_edge_labels()
 193  */
 194 FIRM_DLL void dump_ir_block_graph(ir_graph *irg, const char *suffix);
 195
 196 /**
 197  * Does the same as dump_ir_block_graph but dumps to a stream
 198  * @see dump_ir_block_graph()
 199  */
 200 FIRM_DLL void dump_ir_block_graph_file(ir_graph *irg, FILE *out);
 201
 202 /** Dump a firm graph without explicit block nodes but grouped in extended blocks.
 203  *
 204  *  @param irg     The firm graph to be dumped.
 205  *  @param suffix  suffix to append after the irgname (but before the .vcg)
 206  *
 207  *  @return
 208  *     A file containing the firm graph in vcg format.
 209  *
 210  *  Dumps all Firm nodes of a single graph for a single procedure in
 211  *  extended xvcg format.
 212  *  Dumps the graph to a file.  The file name is constructed from the
 213  *  name of the entity describing the procedure (irg->entity) and the
 214  *  ending <-ip>.vcg.  Eventually overwrites existing files.  Dumps several
 215  *  procedures in boxes if interprocedural_view.
 216  *
 217  * @see turn_off_edge_labels()
 218  */
 219 FIRM_DLL void dump_ir_extblock_graph(ir_graph *irg, const char *suffix);
 220
 221 /**
 222  * Does the same as dump_ir_extrblock_graph but dumps to a stream
 223  * @see dump_ir_extblock_graph()
 224  */
 225 FIRM_DLL void dump_ir_extblock_graph_file(ir_graph *irg, FILE *out);
 226
 227 /** Dumps all graphs in interprocedural view to a file named All_graphs\<suffix\>.vcg.
 228  *
 229  * @param suffix  A suffix for the file name.
 230  */
 231 FIRM_DLL void dump_all_cg_block_graph(const char *suffix);
 232
 233 /** Dumps a firm graph and  all the type information needed for Calls,
 234  *  Sels, ... in this graph.
 235  *
 236  *  @param irg     The firm graph to be dumped with its type information.
 237  *  @param suffix  A suffix for the file name.
 238  *
 239  *  @return
 240  *      A file containing the firm graph and the type information of the firm graph in vcg format.
 241  *
 242  *  Dumps the graph to a file.  The file name is constructed from the
 243  *  name of the entity describing the procedure (irg->entity) and the
 244  *  ending -all.vcg.  Eventually overwrites existing files.
 245  *
 246  * @see turn_off_edge_labels()
 247  */
 248 FIRM_DLL void dump_ir_graph_w_types(ir_graph *irg, const char *suffix);
 249
 250 /**
 251  * Does the same as dump_ir_graph_w_types but dumps to a stream
 252  * @see dump_ir_graph_w_types()
 253  */
 254 FIRM_DLL void dump_ir_graph_w_types_file(ir_graph *irg, FILE *out);
 255
 256 /** Dumps a firm graph and  all the type information needed for Calls,
 257  *  Sels, ... in this graph.
 258  *
 259  *  @param irg     The firm graph to be dumped with its type information.
 260  *  @param suffix  A suffix for the file name.
 261  *
 262  *  @return
 263  *      A file containing the firm graph and the type information of the firm graph in vcg format.
 264  *
 265  *  The graph is in blocked format.
 266  *  Dumps the graph to a file.  The file name is constructed from the
 267  *  name of the entity describing the procedure (irg->entity) and the
 268  *  ending -all.vcg.  Eventually overwrites existing files.
 269  *
 270  * @see turn_off_edge_labels()
 271  */
 272 FIRM_DLL void dump_ir_block_graph_w_types(ir_graph *irg, const char *suffix);
 273
 274 /**
 275  * same as @see dump_ir_block_graph_w_types() but dumps to a stream
 276  * @param irg  the graph to dump
 277  * @param out  stream to dump to
 278  */
 279 FIRM_DLL void dump_ir_block_graph_w_types_file(ir_graph *irg, FILE *out);
 280
 281 /** The type of a dump function that is called for each graph.
 282  *
 283  *  @param irg     current visited graph
 284  *  @param suffix  A suffix for the file name.
 285  */
 286 typedef void dump_graph_func(ir_graph *irg, const char *suffix);
 287
 288 /**
 289  * A walker that calls a dumper for each graph.
 290  *
 291  * @param dump_graph    The dumper to be used for dumping.
 292  * @param suffix        A suffix for the file name.
 293  *
 294  * @return
 295  *      Whatever the dumper creates.
 296  *
 297  *  Walks over all firm graphs and  calls a dumper for each graph.
 298  *  The following dumpers can be passed as arguments:
 299  *   - dump_ir_graph()
 300  *   - dump_ir_block_graph()
 301  *   - dump_cfg()
 302  *   - dump_type_graph()
 303  *   - dump_ir_graph_w_types()
 304  *
 305  * @see turn_off_edge_labels()
 306  */
 307 FIRM_DLL void dump_all_ir_graphs(dump_graph_func *dump_graph,
 308                                  const char *suffix);
 309
 310 /**
 311  * Creates an ir_prog pass for dump_all_ir_graphs().
 312  *
 313  * @param name          the name of this pass or NULL
 314  * @param dump_graph    The dumper to be used for dumping.
 315  * @param suffix        A suffix for the file name.
 316  *
 317  * @return  the newly created ir_prog pass
 318  */
 319 FIRM_DLL ir_prog_pass_t *dump_all_ir_graph_pass(
 320         const char *name, dump_graph_func *dump_graph, const char *suffix);
 321
 322 /**
 323  * Dump the control flow graph of a procedure.
 324  *
 325  * @param irg     The firm graph whose CFG shall be dumped.
 326  * @param suffix  A suffix for the file name.
 327  *
 328  * @return
 329  *      A file containing the CFG in vcg format.
 330  *
 331  * Dumps the control flow graph of a procedure in standard xvcg format.
 332  * Dumps the graph to a file.  The file name is constructed from the
 333  * name of the entity describing the procedure (irg->entity) and the
 334  * ending -cfg.vcg.  Eventually overwrites existing files.
 335  *
 336  * @see turn_off_edge_labels()
 337  */
 338 FIRM_DLL void dump_cfg(ir_graph *irg, const char *suffix);
 339
 340 /**
 341  * Dump a node and its predecessors forming a subgraph to a vcg file.
 342  *
 343  * @param root   The node serving as root for the subgraph.
 344  * @param depth  Dump nodes on paths starting at root with length depth.
 345  * @param suffix A suffix for the file name.
 346  *
 347  * Dumps the graph to a file.  The file name is constructed from the
 348  * name of the entity describing the procedure the passed node is
 349  * in, suffix and the ending -subg_\<nr\>.vcg.  nr is a unique number
 350  * for each graph dumped. Eventually overwrites existing files.
 351  *
 352  * @return
 353  *      A file containing the subgraph in vcg format.
 354  */
 355 FIRM_DLL void dump_subgraph(ir_node *root, int depth, const char *suffix);
 356
 357 /* **************************************************************************** */
 358 /*                              CALLGRAPH DUMPERS                               */
 359 /* **************************************************************************** */
 360
 361
 362 /** Dump the call graph.
 363  *
 364  * Dumps the callgraph to a file "Callgraph"\<suffix\>".vcg".
 365  *
 366  * @param suffix A suffix for the file name.
 367  *
 368  * @see dump_callgraph_loop_tree(const char *suffix)
 369  */
 370 FIRM_DLL void dump_callgraph(const char *suffix);
 371
 372 /* **************************************************************************** */
 373 /*                              TYPEGRAPH DUMPERS                               */
 374 /* **************************************************************************** */
 375
 376 /**
 377  * Dumps all the type information needed for Calls, Sels, ... in this graph.
 378  * Does not dump the graph!
 379  *
 380  * @param irg    The firm graph whose type information is to be dumped.
 381  * @param suffix A suffix for the file name.
 382  *
 383  * @return
 384  *      A file containing the type information of the firm graph in vcg format.
 385  *
 386  *  Dumps this graph to a file.  The file name is constructed from the
 387  *  name of the entity describing the procedure (irg->entity) and the
 388  *  ending -type.vcg.  Eventually overwrites existing files.
 389  *
 390  * @see turn_off_edge_labels()
 391  */
 392 FIRM_DLL void dump_type_graph(ir_graph *irg, const char *suffix);
 393
 394 /**
 395  * Dumps all type information.
 396  *
 397  * @param suffix A suffix for the file name.
 398  *
 399  * @return
 400  *      A file containing all type information for the program in standard
 401  *      vcg format.
 402  *
 403  * Dumps all type information that is somehow reachable in standard vcg
 404  * format.
 405  * Dumps the graph to a file named All_types.vcg.
 406  *
 407  * @see turn_off_edge_labels()
 408  */
 409 FIRM_DLL void dump_all_types(const char *suffix);
 410
 411 /**
 412  * Dumps the class hierarchy with or without entities.
 413  *
 414  * @param entities    Flag whether to dump the entities.
 415  * @param suffix      A suffix for the file name.
 416  *
 417  * @return
 418  *      A file containing the class hierarchy tree for the program in standard
 419  *      vcg format.
 420  *
 421  * Does not dump the global type.
 422  * Dumps a node for all classes and the sub/supertype relations.  If
 423  * entities is set to true also dumps the entities of classes, but without
 424  * any additional information as the entities type.  The overwrites relation
 425  * is dumped along with the entities.
 426  * Dumps to a file class_hierarchy.vcg
 427  */
 428 FIRM_DLL void dump_class_hierarchy(int entities, const char *suffix);
 429
 430 /* **************************************************************************** */
 431 /*                              LOOPTREE DUMPERS                                */
 432 /* **************************************************************************** */
 433
 434 /**
 435  * Dump a standalone loop tree, which contains the loop nodes and the firm nodes
 436  * belonging to one loop packed together in one subgraph.  Dumps to file
 437  * \<name of irg\>\<suffix\>-looptree.vcg
 438  * Turns on edge labels by default.
 439  *
 440  * Implementing this dumper was stimulated by Florian Liekwegs similar dumper.
 441  *
 442  * @param irg     Dump the loop tree for this graph.
 443  * @param suffix  A suffix for the file name.
 444  */
 445 FIRM_DLL void dump_loop_tree(ir_graph *irg, const char *suffix);
 446
 447 /** Dumps the firm nodes in the sub-loop-tree of loop to a graph.
 448  *
 449  * Dumps the loop nodes if dump_loop_information() is set.
 450  * The name of the file is loop_<loop_nr>\<suffix\>.vcg.
 451  *
 452  * @param l       Dump the loop tree for this loop.
 453  * @param suffix  A suffix for the file name.
 454  */
 455 FIRM_DLL void dump_loop(ir_loop *l, const char *suffix);
 456
 457 /** Dumps the loop tree over the call graph.
 458  *
 459  * See for yourself what you can use this for.
 460  * The filename is "Callgraph_looptree\<suffix\>.vcg".
 461  *
 462  * @param suffix  A suffix for the file name.
 463  */
 464 FIRM_DLL void dump_callgraph_loop_tree(const char *suffix);
 465
 466
 467 /* **************************************************************************** */
 468 /*                                TEXT DUMPERS                                  */
 469 /* **************************************************************************** */
 470
 471
 472 /** Write the irnode and all its attributes to the file passed. */
 473 FIRM_DLL int dump_irnode_to_file(FILE *f, ir_node *n);
 474
 475 /** Write the irnode and all its attributes to stdout. */
 476 FIRM_DLL void dump_irnode(ir_node *n);
 477
 478 /** Write the graph and all its attributes to the file passed.
 479  *  Does not write the nodes. */
 480 FIRM_DLL void dump_graph_to_file(FILE *F, ir_graph *irg);
 481
 482 /** Write the graph and all its attributes to stdout.
 483  *  Does not write the nodes. */
 484 FIRM_DLL void dump_graph(ir_graph *g);
 485
 486
 487 /** Dump graph information as text.
 488  *
 489  *  Often graphs are unhandy in their vcg representation.  The text
 490  *  dumper represents the information for the firm nodes more compact,
 491  *  but the relations between the nodes only implicitly.
 492  *
 493  *  The file name is the graph name (get_entity_name()), appended by
 494  *  \<suffix\>.txt.
 495  */
 496 FIRM_DLL void dump_graph_as_text(ir_graph *irg, const char *suffix);
 497
 498
 499 /** Verbosity for text dumpers */
 500 typedef enum {
 501         dump_verbosity_onlynames         = 0x00000001,   /**< Only dump names. Turns off all other
 502                                                               flags up to 0x00010000. */
 503         dump_verbosity_fields            = 0x00000002,   /**< Dump types and fields (like a type declaration). */
 504         dump_verbosity_methods           = 0x00000004,   /**< Dump types and methods (like a type declaration). */
 505         dump_verbosity_nostatic          = 0x00000040,   /**< Dump types and dynamic allocated fields (like a
 506                                                               type declaration). This excludes methods and
 507                                                               static, polymorphic fields. */
 508         dump_verbosity_typeattrs         = 0x00000008,   /**< Dump all type attributes. */
 509         dump_verbosity_entattrs          = 0x00000010,   /**< Dump all entity attributes. */
 510         dump_verbosity_entconsts         = 0x00000020,   /**< Dump entity constants. */
 511
 512         dump_verbosity_accessStats       = 0x00000100,   /**< Dump entity access statistics. */
 513
 514         dump_verbosity_noClassTypes      = 0x00001000,   /**< Dump no class       types. */
 515         dump_verbosity_noStructTypes     = 0x00002000,   /**< Dump no struct      types. */
 516         dump_verbosity_noUnionTypes      = 0x00004000,   /**< Dump no union       types. */
 517         dump_verbosity_noArrayTypes      = 0x00008000,   /**< Dump no array       types. */
 518         dump_verbosity_noPointerTypes    = 0x00010000,   /**< Dump no pointer     types. */
 519         dump_verbosity_noMethodTypes     = 0x00020000,   /**< Dump no method      types. */
 520         dump_verbosity_noPrimitiveTypes  = 0x00040000,   /**< Dump no primitive   types .*/
 521         dump_verbosity_noEnumerationTypes= 0x00080000,   /**< Dump no enumeration types. */
 522
 523         dump_verbosity_onlyClassTypes     = 0x000FE000,  /**< Dump only class     types. */
 524         dump_verbosity_onlyStructTypes    = 0x000FD000,  /**< Dump only struct    types. */
 525         dump_verbosity_onlyUnionTypes     = 0x000FB000,  /**< Dump only union     types. */
 526         dump_verbosity_onlyArrayTypes     = 0x000F7000,  /**< Dump only array     types. */
 527         dump_verbosity_onlyPointerTypes   = 0x000EF000,  /**< Dump only pointer   types. */
 528         dump_verbosity_onlyMethodTypes    = 0x000DF000,  /**< Dump only method    types. */
 529         dump_verbosity_onlyPrimitiveTypes = 0x000BF000,  /**< Dump only primitive types. */
 530         dump_verbosity_onlyEnumerationTypes=0x0007F000,  /**< Dump only enumeration types. */
 531
 532         dump_verbosity_max                = 0x4FF00FBE   /**< Turn on all verbosity.
 533                                                               Do not turn on negative flags!
 534                                                               @@@ Because of a bug in gcc 3.2 we can not set the
 535                                                               first two bits. */
 536 } dump_verbosity;
 537
 538
 539 /** Write the entity and all its attributes to the passed file.
 540  *  */
 541 FIRM_DLL void dump_entity_to_file(FILE *F, ir_entity *ent, unsigned verbosity);
 542
 543 /** Write the entity and all its attributes to the stdout.
 544  *
 545  *  Calls dump_entity_to_file().  */
 546 FIRM_DLL void dump_entity(ir_entity *ent);
 547
 548 /** Write the type and all its attributes to the file passed. */
 549 FIRM_DLL void dump_type_to_file(FILE *f, ir_type *tp, dump_verbosity verbosity);
 550
 551 /** Write the type and all its attributes to stdout. */
 552 void dump_type(ir_type *tp);
 553
 554
 555 /** Dump type information as text.
 556  *
 557  *  Often type graphs are unhandy in their vcg representation.  The text
 558  *  dumper represents the information for a single type more compact, but
 559  *  the relations between the types only implicitly.
 560  *  Dumps only 'real' types, i.e., those in the type list.  Does not dump
 561  *  the global type nor frame types or the like.
 562  *
 563  *  The file name is the program name (get_irp_name()), or 'TextTypes'
 564  *  if the program name is not set, appended by \<suffix\>-types.txt.
 565  *  For verbosity see the documentation of the verbosity flags above.
 566  */
 567 FIRM_DLL void dump_types_as_text(unsigned verbosity, const char *suffix);
 568
 569 /** Dumps all global variables as text.
 570  *
 571  * @param verbosity   verbosity flag
 572  * @param suffix      A suffix for the file name.
 573  *
 574  * Dumps a text representation of the entities in the global type.
 575  *
 576  * The file name is the program name (get_irp_name()), or 'TextTypes'
 577  * if the program name is not set, appended by \<suffix\>-globals.txt.
 578  * For verbosity see the documentation of the verbosity flags above.
 579  */
 580 FIRM_DLL void dump_globals_as_text(unsigned verbosity, const char *suffix);
 581
 582 /* **************************************************************************** */
 583 /*                                    FLAGS                                     */
 584 /* **************************************************************************** */
 585
 586 /** Set a prefix filter for output functions.
 587  *
 588  * All graph dumpers check this name.  If the name is != "" and
 589  * not a prefix of the graph to be dumped, the dumper does not
 590  * dump the graph.
 591  *
 592  * @param name The prefix of the name (not the ld_name) of the method
 593  *              entity to be dumped.
 594  */
 595 FIRM_DLL void only_dump_method_with_name(ident *name);
 596
 597 /** Returns the prefix filter set with only_dump_method_with_name(). */
 598 FIRM_DLL ident *get_dump_file_filter_ident(void);
 599
 600 /** Returns true if dump file filter is not set, or if it is a
 601  *  prefix of name. */
 602 FIRM_DLL int is_filtered_dump_name(ident *name);
 603
 604 /** Sets the vcg flag "display_edge_labels" to no.
 605  *
 606  * This is necessary as xvcg and aisee both fail to display graphs
 607  * with self-edges if these edges have labels.
 608  */
 609 FIRM_DLL void turn_off_edge_labels(void);
 610
 611 /**
 612  * If set to non-zero constants will be replicated for every use. In non
 613  * blocked view edges from constant to block are skipped.  Vcg then
 614  * layouts the graphs more compact, this makes them better readable.
 615  * The flag is automatically and temporarily set to false if other
 616  * edges are dumped, as outs, loop, ...
 617  * Default setting: false.
 618  */
 619 FIRM_DLL void dump_consts_local(int flag);
 620
 621 /**
 622  * if set to non-zero node idx will be added to node labels
 623  */
 624 FIRM_DLL void dump_node_idx_label(int flag);
 625
 626 /**  Turns off dumping the values of constant entities. Makes type graphs
 627  *   better readable.
 628  */
 629 FIRM_DLL void dump_constant_entity_values(int flag);
 630
 631 /**  Turns on dumping the edges from the End node to nodes to be kept
 632  *   alive.
 633  */
 634 FIRM_DLL void dump_keepalive_edges(int flag);
 635 FIRM_DLL int get_opt_dump_keepalive_edges(void);
 636
 637 /** Turns on dumping the out edges starting from the Start block in
 638  *  dump_ir_graph.
 639  *
 640  *  To test the consistency of the out data structure.
 641  */
 642 FIRM_DLL void dump_out_edges(int flag);
 643
 644 /** If this flag is set the dumper dumps edges to immediate dominator in cfg. */
 645 FIRM_DLL void dump_dominator_information(int flag);
 646
 647 /** If this flag is set the dumper dumps loop nodes and edges from
 648  *  these nodes to the contained ir nodes.
 649  *
 650  *  If the loops are interprocedural nodes can be missing.
 651  */
 652 FIRM_DLL void dump_loop_information(int flag);
 653
 654 /** If set and backedge info is computed, backedges are dumped dashed
 655  *  and as vcg 'backedge' construct.
 656  *
 657  *  Default: set.
 658  */
 659 FIRM_DLL void dump_backedge_information(int flag);
 660
 661 /** Dump the information of type field specified in ana/irtypeinfo.h.
 662  *
 663  *  If the flag is set, the type name is output in [] in the node label,
 664  *  else it is output as info.
 665  */
 666 FIRM_DLL void set_opt_dump_analysed_type_info(int flag);
 667
 668 /**
 669  * dump iredges (new style out edges)
 670  */
 671 FIRM_DLL void dump_new_edges(int flag);
 672
 673 /** Write the address of a node into the vcg info.
 674  *
 675  *  This is off per default for automatic comparisons of
 676  *  vcg graphs -- these will differ in the pointer values!
 677  */
 678 FIRM_DLL void dump_pointer_values_to_info(int flag);
 679
 680 /** Dumps ld_names of entities instead of there names.
 681  *
 682  * This option is on per default.
 683  */
 684 FIRM_DLL void dump_ld_names(int flag);
 685
 686 /** Dumps all graph anchor nodes, even if they
 687  * are dead.
 688  *
 689  * This option is off per default.
 690  */
 691 FIRM_DLL void dump_all_anchors(int flag);
 692
 693 /** Dumps a MacroBlock edge from every Block to its
 694  * MacroBlock header.
 695  *
 696  * This option is off per default.
 697  */
 698 FIRM_DLL void dump_macroblock_edges(int flag);
 699
 700 /** Dumps a marked blocks with a asterisk in the title.
 701  *
 702  * This option is off per default.
 703  */
 704 FIRM_DLL void dump_block_marker_in_title(int flag);
 705
 706 /** A node info dumper callback. */
 707 typedef void (dump_node_info_cb_t)(void *data, FILE *f, const ir_node *n);
 708
 709 /**
 710  * Adds a new node info dumper callback. It is possible to add an unlimited
 711  * number of callbacks. The callbacks are called at the end of the default
 712  * info dumper.
 713  *
 714  * @param cb    the callback function to be called
 715  * @param data  a context parameter
 716  *
 717  * @return A callback handle.
 718  *
 719  * @note This functionality is only available, if Firm hooks are enabled (default).
 720  */
 721 FIRM_DLL void *dump_add_node_info_callback(dump_node_info_cb_t *cb, void *data);
 722
 723 /**
 724  * Remove a previously added info dumper callback.
 725  *
 726  * @param handle  the callback handle returned from dump_add_node_info_callback()
 727  */
 728 FIRM_DLL void dump_remv_node_info_callback(void *handle);
 729
 730 #include "end.h"
 731
 732 #endif