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