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  * @brief
  25  *  Dump routines for the ir graph and all type information.
  26  *
  27  *  The dump format of most functions is vcg.  This is a text based graph
  28  *  representation. Some use the original format,
  29  *  but most generate an extended format that is only read by some special
  30  *  versions of xvcg or by the comercialized version now calles aiSee.
  31  *  A test version of aiSee is available at
  32  *   http://www.absint.de/aisee/download/index.htm.
  33  *
  34  *  We have developed an own advanced viewer called ycomp:
  35  *    http://www.info.uni-karlsruhe.de/software/ycomp/
  36  */
  37 #ifndef FIRM_IR_IRDUMP_H
  38 #define FIRM_IR_IRDUMP_H
  39
  40 #include <stdio.h>
  41
  42 #include "firm_types.h"
  43 #include "begin.h"
  44
  45 /** @defgroup convenience_dumper   Convenience interface for dumpers */
  46 /*@{*/
  47
  48 /**
  49  * Convenience interface for dumping a graph as vcg file.
  50  *
  51  * For details on how the filename is constructed see #dump_ir_graph_ext
  52  */
  53 FIRM_API void dump_ir_graph(ir_graph *graph, const char *suffix);
  54
  55 /**
  56  * type for dumpers that dump information about the whole program
  57  */
  58 typedef void (*ir_prog_dump_func)(FILE *out);
  59
  60 /**
  61  * Convenience interface for dumping the whole compilation-unit/program.
  62  *
  63  * The filename is constructed by combining a counter, the name of the current
  64  * ir_prog and the given @p suffix. The file-extensions is determined by looking
  65  * at @p mime_type.
  66  * The file is stored into the directory specified by #ir_set_dump_path
  67  *
  68  * @param func       Dumper. Usually one of #dump_callgraph, #dump_typegraph,
  69  *                   #dump_class_hierarchy, #dump_types_as_text,
  70  *                   #dump_globals_as_text
  71  * @param suffix     Suffix to append to the name
  72  */
  73 FIRM_API void dump_ir_prog_ext(ir_prog_dump_func func, const char *suffix);
  74
  75 /**
  76  * type for graph dumpers
  77  */
  78 typedef void (*ir_graph_dump_func)(FILE *out, ir_graph *graph);
  79
  80 /**
  81  * Convenience interface for dumping graphs.
  82  * The filename is constructed by combining a counter, the name of the graphs
  83  * entity and the given @p suffix. The file-extensions is determined by looking
  84  * at @p mime_type.
  85  * The file is stored into the directory specified by #ir_set_dump_path
  86  *
  87  * @param func      Dumper. Usually one of #dump_cfg, #dump_loop_tree,
  88  *                  #dump_ir_graph_file
  89  * @param graph     the graph to dump
  90  * @param suffix    suffix
  91  */
  92 FIRM_API void dump_ir_graph_ext(ir_graph_dump_func func, ir_graph *graph,
  93                                 const char *suffix);
  94
  95 /**
  96  * A walker that calls a dumper for each graph in the program
  97  *
  98  * @param suffix        A suffix for the file name.
  99  */
 100 FIRM_API void dump_all_ir_graphs(const char *suffix);
 101
 102 /**
 103  * Specifies output path for the dump_ir_graph function
 104  */
 105 FIRM_API void ir_set_dump_path(const char *path);
 106
 107 /**
 108  * Set a prefix filter for output functions.
 109  *
 110  * All graph dumpers check this name.  If the name is != "" and
 111  * not a prefix of the graph to be dumped, the dumper does not
 112  * dump the graph.
 113  *
 114  * @param name The prefix of the name of the method entity to be dumped.
 115  */
 116 FIRM_API void ir_set_dump_filter(const char *name);
 117
 118 /** Returns the prefix filter set with #ir_set_dump_filter */
 119 FIRM_API const char *ir_get_dump_filter(void);
 120
 121 /** Returns true if dump file filter is not set, or if it is a prefix of name */
 122 FIRM_API int ir_should_dump(const char *name);
 123
 124 /**
 125  * Creates an ir_prog pass for dump_all_ir_graphs().
 126  *
 127  * @param name          the name of this pass or NULL
 128  * @param suffix        A suffix for the file name.
 129  *
 130  * @return  the newly created ir_prog pass
 131  */
 132 FIRM_API ir_prog_pass_t *dump_all_ir_graph_pass(const char *name,
 133                                                 const char *suffix);
 134
 135 /*@}*/
 136
 137 /**
 138  * @defgroup dumper     Dump information to file
 139  * This is the low-level interface for dumping information as text files
 140  * and xvcg graphs.
 141  * Normally you should use the convenience interface @ref convenience_dumper
 142  * instead of the functions in this group.
 143  */
 144 /*@{*/
 145
 146 /**
 147  * Dumps all Firm nodes of a single graph for a single procedure in
 148  * standard xvcg format.
 149  *
 150  * @param graph  The firm graph to be dumped.
 151  * @param out    Output stream the graph is written to
 152  */
 153 FIRM_API void dump_ir_graph_file(FILE *out, ir_graph *graph);
 154
 155 /**
 156  * Dump the control flow graph of a procedure.
 157  *
 158  * @param graph   The firm graph whose CFG shall be dumped.
 159  * @param out     Output stream the CFG is written to
 160  *
 161  * Dumps the control flow graph of a procedure in standard xvcg format.
 162  */
 163 FIRM_API void dump_cfg(FILE *out, ir_graph *graph);
 164
 165 /**
 166  * Dump the call graph.
 167  *
 168  * @param out    Output stream the callgraph is written to
 169  */
 170 FIRM_API void dump_callgraph(FILE *out);
 171
 172 /**
 173  * Dumps all type information.
 174  *
 175  * @param out     Output stream the typegraph is written to
 176  *
 177  * Dumps all type information that is somehow reachable in standard vcg
 178  * format.
 179  */
 180 FIRM_API void dump_typegraph(FILE *out);
 181
 182 /**
 183  * Dumps the class hierarchy with or without entities.
 184  *
 185  * @param out         Output stream
 186  *
 187  * Does not dump the global type.
 188  * Dumps a node for all classes and the sub/supertype relations.  If
 189  * entities is set to true also dumps the entities of classes, but without
 190  * any additional information as the entities type.  The overwrites relation
 191  * is dumped along with the entities.
 192  */
 193 FIRM_API void dump_class_hierarchy(FILE *out);
 194
 195 /**
 196  * Dump a standalone loop tree, which contains the loop nodes and the firm nodes
 197  * belonging to one loop packed together in one subgraph.
 198  *
 199  * @param out     Output stream
 200  * @param graph   Dump the loop tree for this graph.
 201  */
 202 FIRM_API void dump_loop_tree(FILE *out, ir_graph *graph);
 203
 204 /**
 205  * Dumps the loop tree over the call graph.
 206  *
 207  * @param out   Output stream
 208  */
 209 FIRM_API void dump_callgraph_loop_tree(FILE *out);
 210
 211 /**
 212  * Dump type information as text.
 213  *
 214  * Often type graphs are unhandy in their vcg representation.  The text dumper
 215  * represents the information for a single type more compact, but the relations
 216  * between the types only implicitly. Dumps only 'real' types, i.e., those in
 217  * the type list.  Does not dump the global type nor frame types or the like.
 218  */
 219 FIRM_API void dump_types_as_text(FILE *out);
 220
 221 /**
 222  * Dumps all global variables as text.
 223  *
 224  * @param out         Output stream
 225  *
 226  * Dumps a text representation of the entities in the global type.
 227  */
 228 FIRM_API void dump_globals_as_text(FILE *out);
 229
 230 /**
 231  * Dumps the firm nodes in the sub-loop-tree of loop to a vcg file.
 232  *
 233  * @param out     Output stream
 234  * @param loop    Dump the loop tree for this loop.
 235  */
 236 FIRM_API void dump_loop(FILE *out, ir_loop *loop);
 237
 238 /** Write the irnode and all its attributes to the file passed. */
 239 FIRM_API void dump_irnode_to_file(FILE *out, ir_node *node);
 240
 241 /** Write the graph and all its attributes to the file passed.
 242  *  Does not write the nodes. */
 243 FIRM_API void dump_graph_as_text(FILE *out, ir_graph *graph);
 244
 245 /** Write the entity and all its attributes to the passed file. */
 246 FIRM_API void dump_entity_to_file(FILE *out, ir_entity *entity);
 247
 248 /** Write the type and all its attributes to the file passed. */
 249 FIRM_API void dump_type_to_file(FILE *out, ir_type *type);
 250
 251 /** Verbosity for text dumpers */
 252 typedef enum {
 253         dump_verbosity_onlynames         = 0x00000001,   /**< Only dump names. Turns off all other
 254                                                               flags up to 0x00010000. */
 255         dump_verbosity_fields            = 0x00000002,   /**< Dump types and fields (like a type declaration). */
 256         dump_verbosity_methods           = 0x00000004,   /**< Dump types and methods (like a type declaration). */
 257         dump_verbosity_nostatic          = 0x00000040,   /**< Dump types and dynamic allocated fields (like a
 258                                                               type declaration). This excludes methods and
 259                                                               static, polymorphic fields. */
 260         dump_verbosity_typeattrs         = 0x00000008,   /**< Dump all type attributes. */
 261         dump_verbosity_entattrs          = 0x00000010,   /**< Dump all entity attributes. */
 262         dump_verbosity_entconsts         = 0x00000020,   /**< Dump entity constants. */
 263
 264         dump_verbosity_accessStats       = 0x00000100,   /**< Dump entity access statistics. */
 265
 266         dump_verbosity_noClassTypes      = 0x00001000,   /**< Dump no class       types. */
 267         dump_verbosity_noStructTypes     = 0x00002000,   /**< Dump no struct      types. */
 268         dump_verbosity_noUnionTypes      = 0x00004000,   /**< Dump no union       types. */
 269         dump_verbosity_noArrayTypes      = 0x00008000,   /**< Dump no array       types. */
 270         dump_verbosity_noPointerTypes    = 0x00010000,   /**< Dump no pointer     types. */
 271         dump_verbosity_noMethodTypes     = 0x00020000,   /**< Dump no method      types. */
 272         dump_verbosity_noPrimitiveTypes  = 0x00040000,   /**< Dump no primitive   types .*/
 273         dump_verbosity_noEnumerationTypes= 0x00080000,   /**< Dump no enumeration types. */
 274
 275         dump_verbosity_onlyClassTypes     = 0x000FE000,  /**< Dump only class     types. */
 276         dump_verbosity_onlyStructTypes    = 0x000FD000,  /**< Dump only struct    types. */
 277         dump_verbosity_onlyUnionTypes     = 0x000FB000,  /**< Dump only union     types. */
 278         dump_verbosity_onlyArrayTypes     = 0x000F7000,  /**< Dump only array     types. */
 279         dump_verbosity_onlyPointerTypes   = 0x000EF000,  /**< Dump only pointer   types. */
 280         dump_verbosity_onlyMethodTypes    = 0x000DF000,  /**< Dump only method    types. */
 281         dump_verbosity_onlyPrimitiveTypes = 0x000BF000,  /**< Dump only primitive types. */
 282         dump_verbosity_onlyEnumerationTypes=0x0007F000,  /**< Dump only enumeration types. */
 283
 284         dump_verbosity_max                = 0x4FF00FBE   /**< Turn everything on */
 285 } ir_dump_verbosity_t;
 286 ENUM_BITSET(ir_dump_verbosity_t)
 287
 288 /** override currently set text dump flags with new ones */
 289 FIRM_API void ir_set_dump_verbosity(ir_dump_verbosity_t verbosity);
 290 /** return currently set text dump flags */
 291 FIRM_API ir_dump_verbosity_t ir_get_dump_verbosity(void);
 292
 293 /**
 294  * A bitset indicating various options that affect what information is dumped
 295  * and how exactly it is dumped. This affects the dumpers that produce vcg
 296  * graphs.
 297  */
 298 typedef enum {
 299         /** dump basic blocks as subgraphs which contain the nodes in the block */
 300         ir_dump_flag_blocks_as_subgraphs   = 1U << 0,
 301         /** display blocks in extended basic grouped inside a subgraph */
 302         ir_dump_flag_group_extbb           = 1U << 1,
 303         /** dump (parts of) typegraph along with nodes */
 304         ir_dump_flag_with_typegraph        = 1U << 2,
 305         /** Sets the vcg flag "display_edge_labels" to no.
 306          * This is necessary as xvcg and aisee both fail to display graphs
 307          * with self-edges if these edges have labels. */
 308         ir_dump_flag_disable_edge_labels   = 1U << 3,
 309         /** If set constants will be replicated for every use. In non blocked view
 310          * edges from constant to block are skipped.  Vcg then layouts the graphs
 311          * more compact, this makes them better readable. */
 312         ir_dump_flag_consts_local          = 1U << 4,
 313         /** if set node idx will be added to node labels */
 314         ir_dump_flag_idx_label             = 1U << 5,
 315         /** if set node number will be added to node labels */
 316         ir_dump_flag_number_label          = 1U << 6,
 317         /** show keepalive edges from the end node */
 318         ir_dump_flag_keepalive_edges       = 1U << 7,
 319         /** dump out edges */
 320         ir_dump_flag_out_edges             = 1U << 8,
 321         /** if set dumps edges from blocks to their immediate dominator */
 322         ir_dump_flag_dominance             = 1U << 9,
 323         /** If set the dumper dumps loop nodes and edges from these nodes to the
 324          * contained ir nodes. */
 325         ir_dump_flag_loops                 = 1U << 10,
 326         /** if set (and backedge info is computed) dump backedges */
 327         ir_dump_flag_back_edges            = 1U << 11,
 328         /** dump type info from ana/irtypeinfo.h in the node labels */
 329         ir_dump_flag_analysed_types        = 1U << 12,
 330         /** dump backedges from iredges.h */
 331         ir_dump_flag_iredges               = 1U << 13,
 332         /** write node addresses into the vcg info */
 333         ir_dump_flag_node_addresses        = 1U << 14,
 334         /** dump all anchor nodes, even the unused ones */
 335         ir_dump_flag_all_anchors           = 1U << 15,
 336         /** dumps marked blocks with an asterisk in the label */
 337         ir_dump_flag_show_marks            = 1U << 16,
 338
 339         /** turns of dumping of constant entity values in typegraphs */
 340         ir_dump_flag_no_entity_values      = 1U << 20,
 341         /** dumps ld_names of entities instead of their names */
 342         ir_dump_flag_ld_names              = 1U << 21,
 343         /** dump entities in class hierarchies */
 344         ir_dump_flag_entities_in_hierarchy = 1U << 22,
 345 } ir_dump_flags_t;
 346 ENUM_BITSET(ir_dump_flags_t)
 347
 348 /** override currently set dump flags with new ones */
 349 FIRM_API void ir_set_dump_flags(ir_dump_flags_t flags);
 350 /** add flags to the currently set dump flags */
 351 FIRM_API void ir_add_dump_flags(ir_dump_flags_t flags);
 352 /** disable certain dump flags */
 353 FIRM_API void ir_remove_dump_flags(ir_dump_flags_t flags);
 354 /** return currently set dump flags */
 355 FIRM_API ir_dump_flags_t ir_get_dump_flags(void);
 356
 357 /**
 358  * This hook is called to dump the vcg attributes of a node to a file.
 359  * If this function returns zero, the default attributes are added, else
 360  * removed.
 361  */
 362 typedef int (*dump_node_vcgattr_func)(FILE *out, ir_node *node, ir_node *local);
 363
 364 /**
 365  * This hook is called to dump the vcg attributes of an edge to a file.
 366  * If this function returns zero, the default attributes are added, else
 367  * removed.
 368  */
 369 typedef int (*dump_edge_vcgattr_func)(FILE *out, ir_node *node, int to);
 370
 371 typedef void (*dump_node_edge_func)(FILE *out, ir_node *node);
 372
 373 /** Set the node_vcgattr hook. */
 374 FIRM_API void set_dump_node_vcgattr_hook(dump_node_vcgattr_func hook);
 375 /** Set the edge_vcgattr hook. */
 376 FIRM_API void set_dump_edge_vcgattr_hook(dump_edge_vcgattr_func hook);
 377
 378 /**
 379  * Set the hook to be called to dump additional edges to a node.
 380  * @param func The hook to be called.
 381  */
 382 FIRM_API void set_dump_node_edge_hook(dump_node_edge_func func);
 383
 384 /**
 385  * Get the additional edge dump hook.
 386  * @return The current additional edge dump hook.]
 387  */
 388 FIRM_API dump_node_edge_func get_dump_node_edge_hook(void);
 389
 390 /**
 391  * Set the hook to be called to dump additional edges to a block.
 392  * @param func The hook to be called.
 393  */
 394 FIRM_API void set_dump_block_edge_hook(dump_node_edge_func func);
 395
 396 /**
 397  * Get the additional block edge dump hook.
 398  * @return The current additional block edge dump hook.
 399  */
 400 FIRM_API dump_node_edge_func get_dump_block_edge_hook(void);
 401
 402 /** A node info dumper callback. */
 403 typedef void (dump_node_info_cb_t)(void *data, FILE *out, const ir_node *n);
 404
 405 /**
 406  * Adds a new node info dumper callback. It is possible to add an unlimited
 407  * number of callbacks. The callbacks are called at the end of the default
 408  * info dumper.
 409  *
 410  * @param cb    the callback function to be called
 411  * @param data  a context parameter
 412  *
 413  * @return A callback handle.
 414  *
 415  * @note This functionality is only available, if Firm hooks are enabled.
 416  */
 417 FIRM_API void *dump_add_node_info_callback(dump_node_info_cb_t *cb, void *data);
 418
 419 /**
 420  * Remove a previously added info dumper callback.
 421  *
 422  * @param handle  the callback handle returned from
 423  *                dump_add_node_info_callback()
 424  */
 425 FIRM_API void dump_remove_node_info_callback(void *handle);
 426
 427 /*@}*/
 428
 429 #include "end.h"
 430
 431 #endif