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