nsz Git - libfirm/blob - ir/ir/irdump.h

   1 /*
   2  * Project:     libFIRM
   3  * File name:   ir/ir/irdump.h
   4  * Purpose:     Write vcg representation of firm to file.
   5  * Author:      Martin Trapp, Christian Schaefer
   6  * Modified by: Goetz Lindenmaier, Hubert Schmidt
   7  * Created:
   8  * CVS-ID:      $Id$
   9  * Copyright:   (c) 1998-2003 Universität Karlsruhe
  10  * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
  11  */
  12
  13
  14 /**
  15  * @file irdump.h
  16  *
  17  * Dump routines for the ir graph and all type information.
  18  *
  19  * @author Martin Trapp, Christian Schaefer
  20  *
  21  * The dump format of most functions is vcg.  This is a text based graph
  22  * representation. Some use the original format,
  23  * but most generate an extended format that is only read by some special
  24  * versions of xvcg or by the comercialized version now calles aiSee.
  25  * A test version of aiSee is available at
  26  * http://www.absint.de/aisee/download/index.htm.
  27  *
  28  * Most routines use the name of the passed entity as the name of the
  29  * file dumped to.
  30  */
  31
  32
  33 # ifndef _IRDUMP_H_
  34 # define _IRDUMP_H_
  35
  36 # include "irnode.h"
  37 # include "irgraph.h"
  38 # include "irloop.h"
  39
  40
  41 /* **************************************************************************** */
  42 /*                                 GRAPH DUMPERS                                */
  43 /* **************************************************************************** */
  44
  45 /**
  46  * This hook is called to dump the vcg attributes of a node to a file.
  47  * If this function returns zero, the default attributes are added, else
  48  * removed.
  49  */
  50 typedef int (*DUMP_NODE_VCGATTR_FUNC)(FILE *F, ir_node *node, ir_node *local);
  51
  52 /** Set the node_vcgattr hook. */
  53 void set_dump_node_vcgattr_hook(DUMP_NODE_VCGATTR_FUNC hook);
  54
  55 /** Dump a firm graph.
  56  *
  57  *  @param irg  The firm graph to be dumped.
  58  *
  59  *  @return
  60  *     A file containing the firm graph in vcg format.
  61  *
  62  *  Dumps all Firm nodes of a single graph for a single procedure in
  63  *  standard xvcg format.  Dumps the graph to a file.  The file name
  64  *  is constructed from the name of the entity describing the
  65  *  procedure (irg->entity) and the ending -pure<-ip>.vcg.  Eventually
  66  *  overwrites existing files.  Visits all nodes in
  67  *  interprocedural_view.
  68  *
  69  * @see turn_off_edge_labels()
  70  */
  71 void dump_ir_graph (ir_graph *irg, const char *suffix);
  72
  73 /** Dump a firm graph without explicit block nodes.
  74  *
  75  *  @param irg   The firm graph to be dumped.
  76  *
  77  *  @return
  78  *     A file containing the firm graph in vcg format.
  79  *
  80  *  Dumps all Firm nodes of a single graph for a single procedure in
  81  *  extended xvcg format.
  82  *  Dumps the graph to a file.  The file name is constructed from the
  83  *  name of the entity describing the procedure (irg->entity) and the
  84  *  ending <-ip>.vcg.  Eventually overwrites existing files.  Dumps several
  85  *  procedures in boxes if interprocedural_view.
  86  *
  87  * @see turn_off_edge_labels()
  88  */
  89 void dump_ir_block_graph (ir_graph *irg, const char *suffix);
  90
  91 /** Dumps all graphs in interprocedural view to a file named All_graphs.vcg.
  92  */
  93 void dump_all_cg_block_graph(const char *suffix);
  94
  95 /** Dumps a firm graph and  all the type information needed for Calls,
  96  *  Sels, ... in this graph.
  97  *
  98  *  @param irg   The firm graph to be dumped with its type information.
  99  *
 100  *  @return
 101  *      A file containing the firm graph and the type information of the firm graph in vcg format.
 102  *
 103  *  Dumps the graph to a file.  The file name is constructed from the
 104  *  name of the entity describing the procedure (irg->entity) and the
 105  *  ending -all.vcg.  Eventually overwrites existing files.
 106  *
 107  * @see turn_off_edge_labels()
 108  */
 109 void dump_ir_graph_w_types (ir_graph *irg, const char *suffix);
 110
 111 /** Dumps a firm graph and  all the type information needed for Calls,
 112  *  Sels, ... in this graph.
 113  *
 114  *  @param irg   The firm graph to be dumped with its type information.
 115  *
 116  *  @return
 117  *      A file containing the firm graph and the type information of the firm graph in vcg format.
 118  *
 119  *  The graph is in blocked format.
 120  *  Dumps the graph to a file.  The file name is constructed from the
 121  *  name of the entity describing the procedure (irg->entity) and the
 122  *  ending -all.vcg.  Eventually overwrites existing files.
 123  *
 124  * @see turn_off_edge_labels()
 125  */
 126 void dump_ir_block_graph_w_types (ir_graph *irg, const char *suffix);
 127
 128 /** The type of a walker function that is called for each graph.
 129  *
 130  *  @param irg   current visited graph
 131  */
 132 typedef void dump_graph_func(ir_graph *irg, const char *suffix);
 133
 134 /**  A walker that calls a dumper for each graph.
 135  *
 136  *   @param dump_graph    The dumper to be used for dumping.
 137  *
 138  *   @return
 139  *      Whatever the dumper creates.
 140  *
 141  *   Walks over all firm graphs and  calls a dumper for each graph.
 142  *   The following dumpers can be passed as arguments:
 143  *   - dump_ir_graph()
 144  *   - dump_ir_block_graph()
 145  *   - dump_cfg()
 146  *   - dump_type_graph()
 147  *   - dump_ir_graph_w_types()
 148  *
 149  * @see turn_off_edge_labels()
 150  */
 151 void dump_all_ir_graphs (dump_graph_func *dump_graph, const char *suffix);
 152
 153
 154 /**  Dump the control flow graph of a procedure.
 155  *
 156  *   @param irg  The firm graph whose CFG shall be dumped.
 157  *
 158  *   @return
 159  *      A file containing the CFG in vcg format.
 160  *
 161  *   Dumps the control flow graph of a procedure in standard xvcg format.
 162  *   Dumps the graph to a file.  The file name is constructed from the
 163  *   name of the entity describing the procedure (irg->entity) and the
 164  *   ending -cfg.vcg.  Eventually overwrites existing files.
 165  *
 166  * @see turn_off_edge_labels()
 167  */
 168 void dump_cfg (ir_graph *irg, const char *suffix);
 169
 170 /**  Dump a node and its predecessors forming a subgraph to a vcg file.
 171  *
 172  *   @param root   The node serving as root for the subgraph.
 173  *   @param depth  Dump nodes on paths starting at root with length depth.
 174  *   @param suffix A suffix for the file name.
 175  *
 176  *   Dumps the graph to a file.  The file name is constructed from the
 177  *   name of the entity describing the procedure the passed node is
 178  *   in, suffix and the ending -subg_<nr>.vcg.  nr is a unique number
 179  *   for each graph dumped. Eventually overwrites existing files.
 180  *
 181  *   @return
 182  *      A file containing the subgraph in vcg format.
 183  */
 184 void dump_subgraph (ir_node *root, int depth, const char *suffix);
 185
 186 /* **************************************************************************** */
 187 /*                              CALLGRAPH DUMPERS                               */
 188 /* **************************************************************************** */
 189
 190
 191 /** Dump the call graph.
 192  *
 193  * Dumps the callgraph to a file "Callgraph"<suffix>".vcg".
 194  *
 195  * @see dump_callgraph_loop_tree(const char *suffix)
 196  */
 197 void dump_callgraph(const char *suffix);
 198
 199 /* **************************************************************************** */
 200 /*                              TYPEGRAPH DUMPERS                               */
 201 /* **************************************************************************** */
 202
 203 /**
 204  *  Dumps all the type information needed for Calls, Sels, ... in this graph.
 205  *  Does not dump the graph!
 206  *
 207  *  @param irg   The firm graph whose type information is to be dumped.
 208  *  @return
 209  *      A file containing the type information of the firm graph in vcg format.
 210  *
 211  *  Dumps this 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 -type.vcg.  Eventually overwrites existing files.
 214  *
 215  * @see turn_off_edge_labels()
 216  */
 217 void dump_type_graph (ir_graph *irg, const char *suffix);
 218
 219 /**  Dumps all type information.
 220  *
 221  *   @return
 222  *      A file containing all type information for the program in standard
 223  *      vcg format.
 224  *
 225  *   Dumps all type information that is somehow reachable in standard vcg
 226  *   format.
 227  *   Dumps the graph to a file named All_types.vcg.
 228  *
 229  * @see turn_off_edge_labels()
 230  */
 231 void dump_all_types (const char *suffix);
 232
 233 /**  Dumps the class hierarchy with or without entities.
 234  *
 235  *   @param entities    Flag whether to dump the entities.
 236  *
 237  *   @return
 238  *      A file containing the class hierarchy tree for the program in standard
 239  *      vcg format.
 240  *
 241  *   Does not dump the global type.
 242  *   Dumps a node for all classes and the sub/supertype relations.  If
 243  *   entities is set to true also dumps the entities of classes, but without
 244  *   any additional information as the entities type.  The overwrites relation
 245  *   is dumped along with the entities.
 246  *   Dumps to a file class_hierarchy.vcg
 247  */
 248 void dump_class_hierarchy (bool entities, const char *suffix);
 249
 250 /* **************************************************************************** */
 251 /*                              LOOPTREE DUMPERS                                */
 252 /* **************************************************************************** */
 253
 254 /**
 255  * Dump a standalone loop tree, which contains the loop nodes and the firm nodes
 256  * belonging to one loop packed together in one subgraph.  Dumps to file
 257  * <name of irg><suffix>-looptree.vcg
 258  * Turns on edge labels by default.
 259  *
 260  * Implementing this dumper was stimulated by Florian Liekwegs similar dumper.
 261  *
 262  * @arg irg     Dump the loop tree for this graph.
 263  * @arg suffix  Suffix to filename.
 264  */
 265 void dump_loop_tree(ir_graph *irg, const char *suffix);
 266
 267 /** Dumps the firm nodes in the sub-loop-tree of loop to a graph.
 268  *
 269  *  Dumps the loop nodes if dump_loop_information() is set.
 270  *  The name of the file is loop_<loop_nr><suffix>.vcg.
 271  *
 272  *  @arg loop    Dump the loop tree for this loop.
 273  *  @arg suffix  Suffix to filename.
 274  */
 275 void dump_loop (ir_loop *l, const char *suffix);
 276
 277 /** Dumps the loop tree over the call graph.
 278  *
 279  *  See for yourself what you can use this for.
 280  *  The filename is "Callgraph_looptree<suffix>.vcg".
 281  *
 282  *  @arg suffix  Suffix to filename.
 283  */
 284 void dump_callgraph_loop_tree(const char *suffix);
 285
 286
 287 /* **************************************************************************** */
 288 /*                                TEXT DUMPERS                                  */
 289 /* **************************************************************************** */
 290
 291
 292 /** Write the irnode and all its attributes to the file passed.
 293  * */
 294 int dump_irnode_to_file (FILE *f, ir_node *n);
 295
 296 /** Write the irnode and all its attributes to stdout.
 297  *  */
 298 void dump_irnode (ir_node *n);
 299
 300 /** Write the graph and all its attributes to the file passed.
 301  *  Does not write the nodes.
 302  * */
 303 void dump_graph_to_file(FILE *F, ir_graph *irg);
 304
 305 /** Write the graph and all its attributes to stdout.
 306  *  Does not write the nodes.
 307  *  */
 308 void dump_graph(ir_graph *g);
 309
 310
 311 /** Dump graph information as text.
 312  *
 313  *  Often graphs are unhandy in their vcg representation.  The text
 314  *  dumper represents the information for the firm nodes more compact,
 315  *  but the relations between the nodes only implicitly.
 316  *
 317  *  The file name is the graph name (get_entity_name()), appended by
 318  *  <suffix>.txt.
 319  */
 320 void dump_graph_as_text(ir_graph *irg, const char *suffix);
 321
 322
 323 /** Verbosity for text dumpers */
 324 typedef enum {
 325   dump_verbosity_onlynames         = 0x00000001,   /**< only dump names. turns off all other
 326                                                       flags up to 0x00010000. */
 327   dump_verbosity_fields            = 0x00000002,   /**< dump types and fields (like a type declaration) */
 328   dump_verbosity_methods           = 0x00000004,   /**< dump types and methods (like a type declaration) */
 329   dump_verbosity_nostatic          = 0x00000040,   /**< dump types and dynamic allocated fields (like a
 330                                                         type declaration). This excludes methods and
 331                                                         static, polymorphic fields. */
 332   dump_verbosity_typeattrs         = 0x00000008,   /**< dump all type attributes */
 333   dump_verbosity_entattrs          = 0x00000010,   /**< dump all entity attributes */
 334   dump_verbosity_entconsts         = 0x00000020,   /**< dump entity constants */
 335
 336   dump_verbosity_accessStats       = 0x00000100,   /**< dump entity access statistics */
 337   dump_verbosity_csv               = 0x00000200,   /**< dump access statistics as comma separated list */
 338
 339   dump_verbosity_noClassTypes      = 0x00001000,   /**< dump no class       types */
 340   dump_verbosity_noStructTypes     = 0x00002000,   /**< dump no struct      types */
 341   dump_verbosity_noUnionTypes      = 0x00004000,   /**< dump no union       types */
 342   dump_verbosity_noArrayTypes      = 0x00008000,   /**< dump no array       types */
 343   dump_verbosity_noPointerTypes    = 0x00010000,   /**< dump no pointer     types */
 344   dump_verbosity_noMethodTypes     = 0x00020000,   /**< dump no method      types */
 345   dump_verbosity_noPrimitiveTypes  = 0x00040000,   /**< dump no primitive   types */
 346   dump_verbosity_noEnumerationTypes= 0x00080000,   /**< dump no enumeration types */
 347
 348   dump_verbosity_onlyClassTypes     = 0x000FE000,  /**< dump only class     types */
 349   dump_verbosity_onlyStructTypes    = 0x000FD000,  /**< dump only struct    types */
 350   dump_verbosity_onlyUnionTypes     = 0x000FB000,  /**< dump only union     types */
 351   dump_verbosity_onlyArrayTypes     = 0x000F7000,  /**< dump only array     types */
 352   dump_verbosity_onlyPointerTypes   = 0x000EF000,  /**< dump only pointer   types */
 353   dump_verbosity_onlyMethodTypes    = 0x000DF000,  /**< dump only method    types */
 354   dump_verbosity_onlyPrimitiveTypes = 0x000BF000,  /**< dump only primitive types */
 355   dump_verbosity_onlyEnumerationTypes=0x0007F000,  /**< dump only enumeration types */
 356
 357   dump_verbosity_max                = 0x4FF00FBE   /**< turn on all verbosity.
 358                                                         Do not turn on negative flags!
 359                                                         @@@ Because of a bug in gcc 3.2 we can not set the
 360                                                         first two bits. */
 361 } dump_verbosity;
 362
 363
 364 /** Write the entity and all its attributes to the passed file.
 365  *  */
 366 void    dump_entity_to_file (FILE *F, entity *ent, unsigned verbosity);
 367
 368 /** Write the entity and all its attributes to the stdout.
 369  *
 370  *  Calls dump_entity_to_file().  */
 371 void    dump_entity (entity *ent);
 372
 373 /** Write the type and all its attributes to the file passed.
 374  * */
 375 void    dump_type_to_file (FILE *f, type *tp, dump_verbosity verbosity);
 376
 377 /** Write the type and all its attributes to stdout.
 378  *  */
 379 void    dump_type (type *tp);
 380
 381
 382 /** Dump type information as text.
 383  *
 384  *  Often type graphs are unhandy in their vcg representation.  The text
 385  *  dumper represents the information for a single type more compact, but
 386  *  the relations between the types only implicitly.
 387  *  Dumps only 'real' types, i.e., those in the type list.  Does not dump
 388  *  the global type nor frame types or the like.
 389  *
 390  *  The file name is the program name (get_irp_name()), or 'TextTypes'
 391  *  if the program name is not set, appended by <suffix>-types.txt.
 392  *  For verbosity see the documentation of the verbosity flags above.
 393  */
 394 void dump_types_as_text(unsigned verbosity, const char *suffix);
 395
 396 /** Dumps all global variables as text.
 397  *
 398  */
 399 void dump_globals_as_text(unsigned verbosity, const char *suffix);
 400
 401 /* **************************************************************************** */
 402 /*                                    FLAGS                                     */
 403 /* **************************************************************************** */
 404
 405 /** Output a selected graph.
 406  *
 407  *  All graph dumpers check this name.  If the name is != "" and
 408  *  not a prefix of the graph to be dumped, the dumper does not
 409  *  dump the graph.
 410  *
 411  *  @param name The prefix of the name (not the ld_name) of the method
 412  *              entity to be dumped.
 413  */
 414 void   only_dump_method_with_name(ident *name);
 415
 416 /** Returns the name set with only_dump_method_with_name(). */
 417 ident *get_dump_file_filter_ident(void);
 418
 419 /** Returns true if dump file filter is not set, or if it is a
 420  *  prefix of name. */
 421 int is_filtered_dump_name(ident *name);
 422
 423 /**  Sets the vcg flag "display_edge_labels" to no.
 424  *
 425  *   This is necessary as xvcg and aisee both fail to display graphs
 426  *   with self-edges if these edges have lables.
 427  */
 428 void turn_off_edge_labels(void);
 429
 430 /**
 431  *  If set to true constants will be replicated for every use. In non
 432  *  blocked view edges from constant to block are skipped.  Vcg then
 433  *  layouts the graphs more compact, this makes them better readable.
 434  *  The flag is automatically and temporarily set to false if other
 435  *  edges are dumped, as outs, loop, ...
 436  *  Default setting: false.
 437  */
 438 void dump_consts_local(bool b);
 439
 440 /**
 441  * Returns false if dump_out_edge_flag or dump_loop_information_flag
 442  * are set, else returns dump_const_local_flag.
 443  */
 444 bool get_opt_dump_const_local(void);
 445
 446 /**  Turns off dumping the values of constant entities. Makes type graphs
 447  *   better readable.
 448  */
 449 void dump_constant_entity_values(bool b);
 450
 451 /**  Turns on dumping the edges from the End node to nodes to be kept
 452  *   alive.
 453  */
 454 void dump_keepalive_edges(bool b);
 455 bool get_opt_dump_keepalive_edges(void);
 456
 457 /** Turns on dumping the out edges starting from the Start block in
 458  *  dump_ir_graph.
 459  *
 460  *  To test the consistency of the out datastructure.
 461  */
 462 void dump_out_edges(bool b);
 463
 464 /** If this flag is set the dumper dumps edges to immediate dominator in cfg.
 465  */
 466 void dump_dominator_information(bool b);
 467
 468 /** If this flag is set the dumper dumps loop nodes and edges from
 469  *  these nodes to the contained ir nodes.
 470  *
 471  *  If the loops are interprocedural nodes can be missing.
 472  */
 473 void dump_loop_information(bool b);
 474
 475 /** If set and backedge info is computed, backedges are dumped dashed
 476  *  and as vcg 'backedge' construct.
 477  *
 478  *  Default: set.
 479  */
 480 void dump_backedge_information(bool b);
 481
 482 /** Dump the information of type field specified in ana/irtypeinfo.h.
 483  *
 484  *  If the flag is set, the type name is output in [] in the node label,
 485  *  else it is output as info.
 486  */
 487 void set_opt_dump_analysed_type_info(bool b);
 488
 489 /** Write the address of a node into the vcg info.
 490  *
 491  *  This is off per default for automatic comparisons of
 492  *  vcg graphs -- these will differ in the pointer values!
 493  */
 494 void dump_pointer_values_to_info(bool b);
 495
 496
 497 # endif /* _IRDUMP_H_ */