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