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
  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
 195 /**
 196  * Does the same as dump_ir_block_graph but dumps to a stream
 197  * @see dump_ir_block_graph()
 198  */
 199 void dump_ir_block_graph_file(ir_graph *irg, FILE *out);
 200
 201 /** Dump a firm graph without explicit block nodes but grouped in extended blocks.
 202  *
 203  *  @param irg     The firm graph to be dumped.
 204  *  @param suffix  suffix to append after the irgname (but before the .vcg)
 205  *
 206  *  @return
 207  *     A file containing the firm graph in vcg format.
 208  *
 209  *  Dumps all Firm nodes of a single graph for a single procedure in
 210  *  extended xvcg format.
 211  *  Dumps the graph to a file.  The file name is constructed from the
 212  *  name of the entity describing the procedure (irg->entity) and the
 213  *  ending <-ip>.vcg.  Eventually overwrites existing files.  Dumps several
 214  *  procedures in boxes if interprocedural_view.
 215  *
 216  * @see turn_off_edge_labels()
 217  */
 218 void dump_ir_extblock_graph(ir_graph *irg, const char *suffix);
 219
 220 /**
 221  * Does the same as dump_ir_extrblock_graph but dumps to a stream
 222  * @see dump_ir_extblock_graph()
 223  */
 224 void dump_ir_extblock_graph_file(ir_graph *irg, FILE *out);
 225
 226 /** Dumps all graphs in interprocedural view to a file named All_graphs\<suffix\>.vcg.
 227  *
 228  * @param suffix  A suffix for the file name.
 229  */
 230 void dump_all_cg_block_graph(const char *suffix);
 231
 232 /** Dumps a firm graph and  all the type information needed for Calls,
 233  *  Sels, ... in this graph.
 234  *
 235  *  @param irg     The firm graph to be dumped with its type information.
 236  *  @param suffix  A suffix for the file name.
 237  *
 238  *  @return
 239  *      A file containing the firm graph and the type information of the firm graph in vcg format.
 240  *
 241  *  Dumps the graph to a file.  The file name is constructed from the
 242  *  name of the entity describing the procedure (irg->entity) and the
 243  *  ending -all.vcg.  Eventually overwrites existing files.
 244  *
 245  * @see turn_off_edge_labels()
 246  */
 247 void dump_ir_graph_w_types(ir_graph *irg, const char *suffix);
 248
 249 /**
 250  * Does the same as dump_ir_graph_w_types but dumps to a stream
 251  * @see dump_ir_graph_w_types()
 252  */
 253 void dump_ir_graph_w_types_file(ir_graph *irg, FILE *out);
 254
 255 /** Dumps a firm graph and  all the type information needed for Calls,
 256  *  Sels, ... in this graph.
 257  *
 258  *  @param irg     The firm graph to be dumped with its type information.
 259  *  @param suffix  A suffix for the file name.
 260  *
 261  *  @return
 262  *      A file containing the firm graph and the type information of the firm graph in vcg format.
 263  *
 264  *  The graph is in blocked format.
 265  *  Dumps the graph to a file.  The file name is constructed from the
 266  *  name of the entity describing the procedure (irg->entity) and the
 267  *  ending -all.vcg.  Eventually overwrites existing files.
 268  *
 269  * @see turn_off_edge_labels()
 270  */
 271 void dump_ir_block_graph_w_types(ir_graph *irg, const char *suffix);
 272
 273 /** The type of a dump function that is called for each graph.
 274  *
 275  *  @param irg     current visited graph
 276  *  @param suffix  A suffix for the file name.
 277  */
 278 typedef void dump_graph_func(ir_graph *irg, const char *suffix);
 279
 280 /**
 281  * A walker that calls a dumper for each graph.
 282  *
 283  * @param dump_graph    The dumper to be used for dumping.
 284  * @param suffix        A suffix for the file name.
 285  *
 286  * @return
 287  *      Whatever the dumper creates.
 288  *
 289  *  Walks over all firm graphs and  calls a dumper for each graph.
 290  *  The following dumpers can be passed as arguments:
 291  *   - dump_ir_graph()
 292  *   - dump_ir_block_graph()
 293  *   - dump_cfg()
 294  *   - dump_type_graph()
 295  *   - dump_ir_graph_w_types()
 296  *
 297  * @see turn_off_edge_labels()
 298  */
 299 void dump_all_ir_graphs(dump_graph_func *dump_graph, const char *suffix);
 300
 301 /**
 302  * Creates an ir_prog pass for dump_all_ir_graphs().
 303  *
 304  * @param name          the name of this pass or NULL
 305  * @param dump_graph    The dumper to be used for dumping.
 306  * @param suffix        A suffix for the file name.
 307  *
 308  * @return  the newly created ir_prog pass
 309  */
 310 ir_prog_pass_t *dump_all_ir_graph_pass(
 311         const char *name, dump_graph_func *dump_graph, const char *suffix);
 312
 313 /**
 314  * Dump the control flow graph of a procedure.
 315  *
 316  * @param irg     The firm graph whose CFG shall be dumped.
 317  * @param suffix  A suffix for the file name.
 318  *
 319  * @return
 320  *      A file containing the CFG in vcg format.
 321  *
 322  * Dumps the control flow graph of a procedure in standard xvcg format.
 323  * Dumps the graph to a file.  The file name is constructed from the
 324  * name of the entity describing the procedure (irg->entity) and the
 325  * ending -cfg.vcg.  Eventually overwrites existing files.
 326  *
 327  * @see turn_off_edge_labels()
 328  */
 329 void dump_cfg(ir_graph *irg, const char *suffix);
 330
 331 /**
 332  * Dump a node and its predecessors forming a subgraph to a vcg file.
 333  *
 334  * @param root   The node serving as root for the subgraph.
 335  * @param depth  Dump nodes on paths starting at root with length depth.
 336  * @param suffix A suffix for the file name.
 337  *
 338  * Dumps the graph to a file.  The file name is constructed from the
 339  * name of the entity describing the procedure the passed node is
 340  * in, suffix and the ending -subg_\<nr\>.vcg.  nr is a unique number
 341  * for each graph dumped. Eventually overwrites existing files.
 342  *
 343  * @return
 344  *      A file containing the subgraph in vcg format.
 345  */
 346 void dump_subgraph(ir_node *root, int depth, const char *suffix);
 347
 348 /* **************************************************************************** */
 349 /*                              CALLGRAPH DUMPERS                               */
 350 /* **************************************************************************** */
 351
 352
 353 /** Dump the call graph.
 354  *
 355  * Dumps the callgraph to a file "Callgraph"\<suffix\>".vcg".
 356  *
 357  * @param suffix A suffix for the file name.
 358  *
 359  * @see dump_callgraph_loop_tree(const char *suffix)
 360  */
 361 void dump_callgraph(const char *suffix);
 362
 363 /* **************************************************************************** */
 364 /*                              TYPEGRAPH DUMPERS                               */
 365 /* **************************************************************************** */
 366
 367 /**
 368  * Dumps all the type information needed for Calls, Sels, ... in this graph.
 369  * Does not dump the graph!
 370  *
 371  * @param irg    The firm graph whose type information is to be dumped.
 372  * @param suffix A suffix for the file name.
 373  *
 374  * @return
 375  *      A file containing the type information of the firm graph in vcg format.
 376  *
 377  *  Dumps this graph to a file.  The file name is constructed from the
 378  *  name of the entity describing the procedure (irg->entity) and the
 379  *  ending -type.vcg.  Eventually overwrites existing files.
 380  *
 381  * @see turn_off_edge_labels()
 382  */
 383 void dump_type_graph(ir_graph *irg, const char *suffix);
 384
 385 /**
 386  * Dumps all type information.
 387  *
 388  * @param suffix A suffix for the file name.
 389  *
 390  * @return
 391  *      A file containing all type information for the program in standard
 392  *      vcg format.
 393  *
 394  * Dumps all type information that is somehow reachable in standard vcg
 395  * format.
 396  * Dumps the graph to a file named All_types.vcg.
 397  *
 398  * @see turn_off_edge_labels()
 399  */
 400 void dump_all_types(const char *suffix);
 401
 402 /**
 403  * Dumps the class hierarchy with or without entities.
 404  *
 405  * @param entities    Flag whether to dump the entities.
 406  * @param suffix      A suffix for the file name.
 407  *
 408  * @return
 409  *      A file containing the class hierarchy tree for the program in standard
 410  *      vcg format.
 411  *
 412  * Does not dump the global type.
 413  * Dumps a node for all classes and the sub/supertype relations.  If
 414  * entities is set to true also dumps the entities of classes, but without
 415  * any additional information as the entities type.  The overwrites relation
 416  * is dumped along with the entities.
 417  * Dumps to a file class_hierarchy.vcg
 418  */
 419 void dump_class_hierarchy(int entities, const char *suffix);
 420
 421 /* **************************************************************************** */
 422 /*                              LOOPTREE DUMPERS                                */
 423 /* **************************************************************************** */
 424
 425 /**
 426  * Dump a standalone loop tree, which contains the loop nodes and the firm nodes
 427  * belonging to one loop packed together in one subgraph.  Dumps to file
 428  * \<name of irg\>\<suffix\>-looptree.vcg
 429  * Turns on edge labels by default.
 430  *
 431  * Implementing this dumper was stimulated by Florian Liekwegs similar dumper.
 432  *
 433  * @param irg     Dump the loop tree for this graph.
 434  * @param suffix  A suffix for the file name.
 435  */
 436 void dump_loop_tree(ir_graph *irg, const char *suffix);
 437
 438 /** Dumps the firm nodes in the sub-loop-tree of loop to a graph.
 439  *
 440  * Dumps the loop nodes if dump_loop_information() is set.
 441  * The name of the file is loop_<loop_nr>\<suffix\>.vcg.
 442  *
 443  * @param l       Dump the loop tree for this loop.
 444  * @param suffix  A suffix for the file name.
 445  */
 446 void dump_loop(ir_loop *l, const char *suffix);
 447
 448 /** Dumps the loop tree over the call graph.
 449  *
 450  * See for yourself what you can use this for.
 451  * The filename is "Callgraph_looptree\<suffix\>.vcg".
 452  *
 453  * @param suffix  A suffix for the file name.
 454  */
 455 void dump_callgraph_loop_tree(const char *suffix);
 456
 457
 458 /* **************************************************************************** */
 459 /*                                TEXT DUMPERS                                  */
 460 /* **************************************************************************** */
 461
 462
 463 /** Write the irnode and all its attributes to the file passed.
 464  * */
 465 int dump_irnode_to_file(FILE *f, ir_node *n);
 466
 467 /** Write the irnode and all its attributes to stdout.
 468  *  */
 469 void dump_irnode(ir_node *n);
 470
 471 /** Write the graph and all its attributes to the file passed.
 472  *  Does not write the nodes.
 473  * */
 474 void dump_graph_to_file(FILE *F, ir_graph *irg);
 475
 476 /** Write the graph and all its attributes to stdout.
 477  *  Does not write the nodes.
 478  *  */
 479 void dump_graph(ir_graph *g);
 480
 481
 482 /** Dump graph information as text.
 483  *
 484  *  Often graphs are unhandy in their vcg representation.  The text
 485  *  dumper represents the information for the firm nodes more compact,
 486  *  but the relations between the nodes only implicitly.
 487  *
 488  *  The file name is the graph name (get_entity_name()), appended by
 489  *  \<suffix\>.txt.
 490  */
 491 void dump_graph_as_text(ir_graph *irg, const char *suffix);
 492
 493
 494 /** Verbosity for text dumpers */
 495 typedef enum {
 496         dump_verbosity_onlynames         = 0x00000001,   /**< Only dump names. Turns off all other
 497                                                               flags up to 0x00010000. */
 498         dump_verbosity_fields            = 0x00000002,   /**< Dump types and fields (like a type declaration). */
 499         dump_verbosity_methods           = 0x00000004,   /**< Dump types and methods (like a type declaration). */
 500         dump_verbosity_nostatic          = 0x00000040,   /**< Dump types and dynamic allocated fields (like a
 501                                                               type declaration). This excludes methods and
 502                                                               static, polymorphic fields. */
 503         dump_verbosity_typeattrs         = 0x00000008,   /**< Dump all type attributes. */
 504         dump_verbosity_entattrs          = 0x00000010,   /**< Dump all entity attributes. */
 505         dump_verbosity_entconsts         = 0x00000020,   /**< Dump entity constants. */
 506
 507         dump_verbosity_accessStats       = 0x00000100,   /**< Dump entity access statistics. */
 508
 509         dump_verbosity_noClassTypes      = 0x00001000,   /**< Dump no class       types. */
 510         dump_verbosity_noStructTypes     = 0x00002000,   /**< Dump no struct      types. */
 511         dump_verbosity_noUnionTypes      = 0x00004000,   /**< Dump no union       types. */
 512         dump_verbosity_noArrayTypes      = 0x00008000,   /**< Dump no array       types. */
 513         dump_verbosity_noPointerTypes    = 0x00010000,   /**< Dump no pointer     types. */
 514         dump_verbosity_noMethodTypes     = 0x00020000,   /**< Dump no method      types. */
 515         dump_verbosity_noPrimitiveTypes  = 0x00040000,   /**< Dump no primitive   types .*/
 516         dump_verbosity_noEnumerationTypes= 0x00080000,   /**< Dump no enumeration types. */
 517
 518         dump_verbosity_onlyClassTypes     = 0x000FE000,  /**< Dump only class     types. */
 519         dump_verbosity_onlyStructTypes    = 0x000FD000,  /**< Dump only struct    types. */
 520         dump_verbosity_onlyUnionTypes     = 0x000FB000,  /**< Dump only union     types. */
 521         dump_verbosity_onlyArrayTypes     = 0x000F7000,  /**< Dump only array     types. */
 522         dump_verbosity_onlyPointerTypes   = 0x000EF000,  /**< Dump only pointer   types. */
 523         dump_verbosity_onlyMethodTypes    = 0x000DF000,  /**< Dump only method    types. */
 524         dump_verbosity_onlyPrimitiveTypes = 0x000BF000,  /**< Dump only primitive types. */
 525         dump_verbosity_onlyEnumerationTypes=0x0007F000,  /**< Dump only enumeration types. */
 526
 527         dump_verbosity_max                = 0x4FF00FBE   /**< Turn on all verbosity.
 528                                                               Do not turn on negative flags!
 529                                                               @@@ Because of a bug in gcc 3.2 we can not set the
 530                                                               first two bits. */
 531 } dump_verbosity;
 532
 533
 534 /** Write the entity and all its attributes to the passed file.
 535  *  */
 536 void    dump_entity_to_file(FILE *F, ir_entity *ent, unsigned verbosity);
 537
 538 /** Write the entity and all its attributes to the stdout.
 539  *
 540  *  Calls dump_entity_to_file().  */
 541 void    dump_entity(ir_entity *ent);
 542
 543 /** Write the type and all its attributes to the file passed.
 544  * */
 545 void    dump_type_to_file(FILE *f, ir_type *tp, dump_verbosity verbosity);
 546
 547 /** Write the type and all its attributes to stdout.
 548  *  */
 549 void    dump_type(ir_type *tp);
 550
 551
 552 /** Dump type information as text.
 553  *
 554  *  Often type graphs are unhandy in their vcg representation.  The text
 555  *  dumper represents the information for a single type more compact, but
 556  *  the relations between the types only implicitly.
 557  *  Dumps only 'real' types, i.e., those in the type list.  Does not dump
 558  *  the global type nor frame types or the like.
 559  *
 560  *  The file name is the program name (get_irp_name()), or 'TextTypes'
 561  *  if the program name is not set, appended by \<suffix\>-types.txt.
 562  *  For verbosity see the documentation of the verbosity flags above.
 563  */
 564 void dump_types_as_text(unsigned verbosity, const char *suffix);
 565
 566 /** Dumps all global variables as text.
 567  *
 568  * @param verbosity   verbosity flag
 569  * @param suffix      A suffix for the file name.
 570  *
 571  * Dumps a text representation of the entities in the global type.
 572  *
 573  * The file name is the program name (get_irp_name()), or 'TextTypes'
 574  * if the program name is not set, appended by \<suffix\>-globals.txt.
 575  * For verbosity see the documentation of the verbosity flags above.
 576  */
 577 void dump_globals_as_text(unsigned verbosity, const char *suffix);
 578
 579 /* **************************************************************************** */
 580 /*                                    FLAGS                                     */
 581 /* **************************************************************************** */
 582
 583 /** Set a prefix filter for output functions.
 584  *
 585  * All graph dumpers check this name.  If the name is != "" and
 586  * not a prefix of the graph to be dumped, the dumper does not
 587  * dump the graph.
 588  *
 589  * @param name The prefix of the name (not the ld_name) of the method
 590  *              entity to be dumped.
 591  */
 592 void   only_dump_method_with_name(ident *name);
 593
 594 /** Returns the prefix filter set with only_dump_method_with_name(). */
 595 ident *get_dump_file_filter_ident(void);
 596
 597 /** Returns true if dump file filter is not set, or if it is a
 598  *  prefix of name. */
 599 int is_filtered_dump_name(ident *name);
 600
 601 /** Sets the vcg flag "display_edge_labels" to no.
 602  *
 603  * This is necessary as xvcg and aisee both fail to display graphs
 604  * with self-edges if these edges have labels.
 605  */
 606 void turn_off_edge_labels(void);
 607
 608 /**
 609  * If set to non-zero constants will be replicated for every use. In non
 610  * blocked view edges from constant to block are skipped.  Vcg then
 611  * layouts the graphs more compact, this makes them better readable.
 612  * The flag is automatically and temporarily set to false if other
 613  * edges are dumped, as outs, loop, ...
 614  * Default setting: false.
 615  */
 616 void dump_consts_local(int flag);
 617
 618 /**
 619  * if set to non-zero node idx will be added to node labels
 620  */
 621 void dump_node_idx_label(int flag);
 622
 623 /**  Turns off dumping the values of constant entities. Makes type graphs
 624  *   better readable.
 625  */
 626 void dump_constant_entity_values(int flag);
 627
 628 /**  Turns on dumping the edges from the End node to nodes to be kept
 629  *   alive.
 630  */
 631 void dump_keepalive_edges(int flag);
 632 int get_opt_dump_keepalive_edges(void);
 633
 634 /** Turns on dumping the out edges starting from the Start block in
 635  *  dump_ir_graph.
 636  *
 637  *  To test the consistency of the out data structure.
 638  */
 639 void dump_out_edges(int flag);
 640
 641 /** If this flag is set the dumper dumps edges to immediate dominator in cfg.
 642  */
 643 void dump_dominator_information(int flag);
 644
 645 /** If this flag is set the dumper dumps loop nodes and edges from
 646  *  these nodes to the contained ir nodes.
 647  *
 648  *  If the loops are interprocedural nodes can be missing.
 649  */
 650 void dump_loop_information(int flag);
 651
 652 /** If set and backedge info is computed, backedges are dumped dashed
 653  *  and as vcg 'backedge' construct.
 654  *
 655  *  Default: set.
 656  */
 657 void dump_backedge_information(int flag);
 658
 659 /** Dump the information of type field specified in ana/irtypeinfo.h.
 660  *
 661  *  If the flag is set, the type name is output in [] in the node label,
 662  *  else it is output as info.
 663  */
 664 void set_opt_dump_analysed_type_info(int flag);
 665
 666 /**
 667  * dump iredges (new style out edges)
 668  */
 669 void dump_new_edges(int flag);
 670
 671 /** Write the address of a node into the vcg info.
 672  *
 673  *  This is off per default for automatic comparisons of
 674  *  vcg graphs -- these will differ in the pointer values!
 675  */
 676 void dump_pointer_values_to_info(int flag);
 677
 678 /** Dumps ld_names of entities instead of there names.
 679  *
 680  * This option is on per default.
 681  */
 682 void dump_ld_names(int flag);
 683
 684 /** Dumps all graph anchor nodes, even if they
 685  * are dead.
 686  *
 687  * This option is off per default.
 688  */
 689 void dump_all_anchors(int flag);
 690
 691 /** Dumps a MacroBlock edge from every Block to its
 692  * MacroBlock header.
 693  *
 694  * This option is off per default.
 695  */
 696 void dump_macroblock_edges(int flag);
 697
 698 /** Dumps a marked blocks with a asterisk in the title.
 699  *
 700  * This option is off per default.
 701  */
 702 void dump_block_marker_in_title(int flag);
 703
 704 /** A node info dumper callback. */
 705 typedef void (dump_node_info_cb_t)(void *data, FILE *f, const ir_node *n);
 706
 707 /**
 708  * Adds a new node info dumper callback. It is possible to add an unlimited
 709  * number of callbacks. The callbacks are called at the end of the default
 710  * info dumper.
 711  *
 712  * @param cb    the callback function to be called
 713  * @param data  a context parameter
 714  *
 715  * @return A callback handle.
 716  *
 717  * @note This functionality is only available, if Firm hooks are enabled (default).
 718  */
 719 void *dump_add_node_info_callback(dump_node_info_cb_t *cb, void *data);
 720
 721 /**
 722  * Remove a previously added info dumper callback.
 723  *
 724  * @param handle  the callback handle returned from dump_add_node_info_callback()
 725  */
 726 void dump_remv_node_info_callback(void *handle);
 727
 728 #endif