-/* Copyright (C) 1998 - 2000 by Universitaet Karlsruhe
-** All rights reserved.
-**
-** Authors: Martin Trapp, Christian Schaefer
-**
-** dump an ir graph, for further use with xvcg
-*/
+/*
+ * Project: libFIRM
+ * File name: ir/ir/irdump.h
+ * Purpose: Write vcg representation of firm to file.
+ * Author: Martin Trapp, Christian Schaefer
+ * Modified by: Goetz Lindenmaier, Hubert Schmidt
+ * Created:
+ * CVS-ID: $Id$
+ * Copyright: (c) 1998-2003 Universität Karlsruhe
+ * Licence: This file protected by GPL - GNU GENERAL PUBLIC LICENSE.
+ */
+
+
+/**
+ * @file irdump.h
+ *
+ * Dump routines for the ir graph and all type information.
+ *
+ * @author Martin Trapp, Christian Schaefer
+ *
+ * The dump format of most functions is vcg. This is a text based graph
+ * representation. Some use the original format,
+ * but most generate an extended format that is only read by some special
+ * versions of xvcg or by the comercialized version now calles aiSee.
+ * A test version of aiSee is available at
+ * http://www.absint.de/aisee/download/index.htm.
+ *
+ * Most routines use the name of the passed entity as the name of the
+ * file dumped to.
+ */
-/* $Id$ */
# ifndef _IRDUMP_H_
# define _IRDUMP_H_
# include "irnode.h"
# include "irgraph.h"
+# include "irloop.h"
-/****h* libfirm/irdump
- *
- * NAME
- * irdump -- dump routines for the graph and all type information
- * NOTES
- * The dump format of most functions is vcg. This is a text based graph
- * representation. Some use the original format,
- * but most generate an extended format that is only read by some special
- * versions of xvcg or by the comercialized version now calles aiSee.
- * A test version of aiSee is available at http://www.absint.de/aisee/download/index.htm.
+/**
+ * The value of this string will be added to the file name before .vcg
*
- * Most routines use the name of the passed entity as the name of the
- * file dumped to.
- *
- ******
+ * @todo GL: A hack -- add parameter to dumper function.
*/
-
-#if 0
-/* The following routines use a global variable that is not external.
- Therefore removed from interface. */
-/* dump a simple node */
-void dump_ir_node (ir_node *node);
-/* dump the edge to the block this node belongs to */
-void dump_ir_block_edge(ir_node *n);
-/* dump edges to our inputs */
-void dump_ir_data_edges(ir_node *n);
-#endif
-/* @@@ GL: A hack */
extern char *dump_file_suffix;
-/****m* irdump/dump_ir_graph
+/**
+ * Dump a firm graph.
+ *
+ * @param irg The firm graph to be dumped.
+ *
+ * @return
+ * A file containing the firm graph in vcg format.
*
- * NAME
- * dump_ir_graph -- dump a firm graph
- * SYNOPSIS
- * void dump_ir_graph (ir_graph *irg);
- * FUNCTION
* Dumps all Firm nodes of a single graph for a single procedure in
- * standard xvcg format.
- * Dumps the graph to a file. The file name is constructed from the
- * name of the entity describing the procedure (irg->entity) and the
- * ending .vcg. Eventually overwrites existing files.
- * INPUTS
- * irg: The firm graph to be dumped.
- * RESULT
- * A file containing the firm graph in vcg format.
- * SEE ALSO
- * turn_of_edge_labels
- ***
+ * standard xvcg format. Dumps the graph to a file. The file name
+ * is constructed from the name of the entity describing the
+ * procedure (irg->entity) and the ending -pure<-ip>.vcg. Eventually
+ * overwrites existing files. Visits all nodes in
+ * interprocedural_view.
+ *
+ * @see turn_off_edge_labels()
*/
void dump_ir_graph (ir_graph *irg);
+#define dump_cg_graph dump_ir_graph
-/****m* irdump/dump_ir_block_graph
+/**
+ * Dump a firm graph without explicit block nodes.
+ *
+ * @param irg The firm graph to be dumped.
+ *
+ * @return
+ * A file containing the firm graph in vcg format.
*
- * NAME
- * dump_ir_block_graph -- dump a firm graph without explicit block nodes.
- * SYNOPSIS
- * void dump_ir_block_graph (ir_graph *irg);
- * FUNCTION
* Dumps all Firm nodes of a single graph for a single procedure in
* extended xvcg format.
* Dumps the graph to a file. The file name is constructed from the
* name of the entity describing the procedure (irg->entity) and the
- * ending .vcg. Eventually overwrites existing files.
- * INPUTS
- * irg: The firm graph to be dumped.
- * RESULT
- * A file containing the firm graph in vcg format.
- * SEE ALSO
- * turn_of_edge_labels
- ***
+ * ending <-ip>.vcg. Eventually overwrites existing files. Dumps several
+ * procedures in boxes if interprocedural_view.
+ *
+ * @see turn_off_edge_labels()
*/
void dump_ir_block_graph (ir_graph *irg);
+#define dump_cg_block_graph dump_ir_block_graph
+
+/** Dumps all graphs in interprocedural view to a file named All_graphs.vcg.
+ */
+void dump_all_cg_block_graph(void);
+
+/**
+ * Dumps a firm graph and all the type information needed for Calls,
+ * Sels, ... in this graph.
+ *
+ * @param irg The firm graph to be dumped with its type information.
+ *
+ * @return
+ * A file containing the firm graph and the type information of the firm graph in vcg format.
+ *
+ * Dumps the graph to a file. The file name is constructed from the
+ * name of the entity describing the procedure (irg->entity) and the
+ * ending -all.vcg. Eventually overwrites existing files.
+ *
+ * @see turn_off_edge_labels()
+ */
+void dump_ir_graph_w_types (ir_graph *irg);
+
+/**
+ * Dumps a firm graph and all the type information needed for Calls,
+ * Sels, ... in this graph.
+ *
+ * @param irg The firm graph to be dumped with its type information.
+ *
+ * @return
+ * A file containing the firm graph and the type information of the firm graph in vcg format.
+ *
+ * The graph is in blocked format.
+ * Dumps the graph to a file. The file name is constructed from the
+ * name of the entity describing the procedure (irg->entity) and the
+ * ending -all.vcg. Eventually overwrites existing files.
+ *
+ * @see turn_off_edge_labels()
+ */
+void dump_ir_block_graph_w_types (ir_graph *irg);
+
+/**
+ * The type of a walker function that is called for each graph.
+ *
+ * @param irg current visited graph
+ */
+typedef void dump_graph_func(ir_graph *irg);
+
+/**
+ * A walker that calls a dumper for each graph.
+ *
+ * @param dump_graph The dumper to be used for dumping.
+ *
+ * @return
+ * Whatever the dumper creates.
+ *
+ * Walks over all firm graphs and calls a dumper for each graph.
+ * The following dumpers can be passed as arguments:
+ * - dump_ir_graph()
+ * - dump_ir_block_graph()
+ * - dump_cfg()
+ * - dump_type_graph()
+ * - dump_ir_graph_w_types()
+ *
+ * @see turn_off_edge_labels()
+ */
+void dump_all_ir_graphs (dump_graph_func *dump_graph);
-/****m* irdump/dump_cfg
+
+/**
+ * Dump the control flow graph of a procedure.
+ *
+ * @param irg The firm graph whose CFG shall be dumped.
+ *
+ * @return
+ * A file containing the CFG in vcg format.
*
- * NAME
- * dump_cfg -- Dump the control flow graph of a procedure
- * SYNOPSIS
- * void dump_cfg (ir_graph *irg);
- * FUNCTION
* Dumps the control flow graph of a procedure in standard xvcg format.
* Dumps the graph to a file. The file name is constructed from the
* name of the entity describing the procedure (irg->entity) and the
* ending -cfg.vcg. Eventually overwrites existing files.
- * INPUTS
- * irg: The firm graph whose CFG shall be dumped.
- * RESULT
- * A file containing the CFG in vcg format.
- * SEE ALSO
- * turn_of_edge_labels
- ***
+ *
+ * @see turn_off_edge_labels()
*/
void dump_cfg (ir_graph *irg);
-/****m* irdump/dump_type_graph
- *
- * NAME
- * dump_type_graph --
- * SYNOPSIS
- * void dump_type_graph (ir_graph *irg);
- * FUNCTION
+/**
* Dumps all the type information needed for Calls, Sels, ... in this graph.
+ * Does not dump the graph!
+ *
+ * @param irg The firm graph whose type information is to be dumped.
+ * @return
+ * A file containing the type information of the firm graph in vcg format.
+ *
* Dumps this graph to a file. The file name is constructed from the
* name of the entity describing the procedure (irg->entity) and the
* ending -type.vcg. Eventually overwrites existing files.
- * INPUTS
- * irg: The firm graph whose type information is to be dumped.
- * RESULT
- * A file containing the type information of the firm graph in vcg format.
- * SEE ALSO
- * turn_of_edge_labels
- ***
+ *
+ * @see turn_off_edge_labels()
*/
void dump_type_graph (ir_graph *irg);
-/****m* irdump/dump_all_types
+/**
+ * Dumps all type information.
+ *
+ * @return
+ * A file containing all type information for the program in standard
+ * vcg format.
*
- * NAME
- * dump_all_types -- Dumps all type information
- * SYNOPSIS
- * void dump_all_types (void);
- * FUNCTION
* Dumps all type information that is somehow reachable in standard vcg
* format.
* Dumps the graph to a file named All_types.vcg.
- * INPUTS
- * No inputs.
- * RESULT
- * A file containing all type information for the program in standard
- * vcg format.
- * SEE ALSO
- * turn_of_edge_labels
- ***
+ *
+ * @see turn_off_edge_labels()
*/
void dump_all_types (void);
-/****m* irdump/dump_ir_graph_w_types
+/**
+ * Dumps the class hierarchy with or without entities.
*
- * NAME
- * dump_ir_graph_w_types
- * SYNOPSIS
- * void dump_ir_graph_w_types (ir_graph *irg);
- * FUNCTION
- * Dumps a firm graph and all the type information needed for Calls,
- * Sels, ... in this graph.
- * Dumps the graph to a file. The file name is constructed from the
- * name of the entity describing the procedure (irg->entity) and the
- * ending -all.vcg. Eventually overwrites existing files.
- * INPUTS
- * irg: The firm graph to be dumped with its type information.
- * RESULT
- * A file containing the firm graph and the type information of the firm graph in vcg format.
- * SEE ALSO
- * turn_of_edge_labels
- ***
+ * @param entities Flag whether to dump the entities.
+ *
+ * @return
+ * A file containing the class hierarchy tree for the program in standard
+ * vcg format.
+ *
+ * Does not dump the global type.
+ * Dumps a node for all classes and the sub/supertype relations. If
+ * entities is set to true also dumps the entities of classes, but without
+ * any additional information as the entities type. The overwrites relation
+ * is dumped along with the entities.
+ * Dumps to a file class_hierarchy.vcg
*/
+void dump_class_hierarchy (bool entities);
-void dump_ir_graph_w_types (ir_graph *irg);
- /****m* irdump/dump_ir_block_graph_w_types
+
+/**
+ * Dump a standalone loop tree, which contains the loop nodes and the firm nodes
+ * belonging to one loop packed together in one subgraph. Dumps to file
+ * <name of irg><suffix>-looptree.vcg
+ * Turns on edge labels by default.
*
- * NAME
- * dump_ir_block_graph_w_types
- * SYNOPSIS
- * void dump_ir_block_graph_w_types (ir_graph *irg);
- * FUNCTION
- * Dumps a firm graph and all the type information needed for Calls,
- * Sels, ... in this graph. The graph is in blocked format.
- * Dumps the graph to a file. The file name is constructed from the
- * name of the entity describing the procedure (irg->entity) and the
- * ending -all.vcg. Eventually overwrites existing files.
- * INPUTS
- * irg: The firm graph to be dumped with its type information.
- * RESULT
- * A file containing the firm graph and the type information of the firm graph in vcg format.
- * SEE ALSO
- * turn_of_edge_labels
- ***
+ * Implementing this dumper was stimulated by Florian Liekwegs similar dumper.
+ *
+ * @arg irg Dump the loop tree for this graph.
+ * @arg suffix Suffix to filename.
*/
-void dump_ir_block_graph_w_types (ir_graph *irg);
+void dump_loop_tree(ir_graph *irg, char *suffix);
-/****m* irdump/dump_all_ir_graphs
+/** Dumps the firm nodes in the sub-loop-tree of loop to a graph.
+ * Dumps the loop nodes if dump_loop_information() is set.
*
- * NAME
- * dump_all_ir_graphs -- a walker that calls a dumper for each graph
- * SYNOPSIS
- * void dump_all_ir_graphs (void dump_graph(ir_graph*));
- * FUNCTION
- * Walks over all firm graphs and calls a dumper for each graph.
- * The following dumpers can be passed as arguments:
- * dump_ir_graph
- * dump_ir_block_graph
- * dump_cfg
- * dump_type_graph
- * dump_ir_graph_w_types
- * INPUTS
- * The dumper to be used for dumping.
- * RESULT
- * Whatever the dumper creates.
- * SEE ALSO
- * turn_of_edge_labels
- ***
+ * The name of the file is loop_<loop_nr><suffix>.vcg.
+ *
+ * @arg loop Dump the loop tree for this loop.
+ * @arg suffix Suffix to filename.
*/
-void dump_all_ir_graphs (void dump_graph(ir_graph*));
+void dump_loop (ir_loop *l, char *suffix);
-/****m* irdump/turn_off_edge_labels
+/**
+ * Sets the vcg flag "display_edge_labels" to no.
*
- * NAME
- * turn_off_edge_labels
- * SYNOPSIS
- * void turn_off_edge_labels();
- * FUNCTION
- * Sets the vcg flag "display_edge_labels" to no. This is necessary
+ * This is necessary
* as xvcg and aisee both fail to display graphs with self-edges if these
* edges have labes.
- * INPUTS
- * No inputs
- * RESULT
- * dumpers will generate vcg flags with a different header.
- * SEE ALSO
- *
- ***
+ * Dumpers will generate vcg flags with a different header.
*/
-void turn_off_edge_labels();
+void turn_off_edge_labels(void);
+/**
+ * If set to true constants will be replicated for every use. In non blocked
+ * view edges from constant to block are scipped. Vcg
+ * then layouts the graphs more compact, this makes them better readable.
+ * The flag is automatically and temporarily set to false if other
+ * edges are dumped, as outs, loop, ...
+ * Default setting: false.
+ */
+void dump_consts_local(bool b);
+/**
+ * Returns false if dump_out_edge_flag or dump_loop_information_flag
+ * are set, else returns dump_const_local_flag.
+ */
+bool get_opt_dump_const_local(void);
-/****m* irdump/turn_off_constant_entity_values
- *
- * NAME
- * turn_off_constant_entity_values
- * SYNOPSIS
- * void turn_off_constant_entity_values()
- * FUNCTION
+/**
* Turns off dumping the values of constant entities. Makes type graphs
* better readable.
- * INPUTS
- * No inputs
- * RESULT
- * SEE ALSO
- *
- ***
*/
-void turn_off_constant_entity_values();
-
+void turn_off_constant_entity_values(void);
-/****m* irdump/dump_keepalive_edges
- *
- * NAME
- * dump_keepalive_edges
- * SYNOPSIS
- * void dump_keepalive_edges()
- * FUNCTION
+/**
* Turns on dumping the edges from the End node to nodes to be kept
* alive
- * INPUTS
- * No inputs
- * RESULT
- * SEE ALSO
- *
- ***
*/
-void dump_keepalive_edges();
+void dump_keepalive_edges(bool b);
+bool get_opt_dump_keepalive_edges(void);
-
-/****m* irdump/dump_out_edges
- *
- * NAME
- * dump_out_edges
- * SYNOPSIS
- * void dump_out_edges()
- * FUNCTION
+/**
* Turns on dumping the out edges starting from the Start block in
* dump_ir_graph. To test the consistency of the out datastructure.
- * INPUTS
- * No inputs
- * RESULT
- * SEE ALSO
- *
- ***
*/
-void dump_out_edges();
+void dump_out_edges(void);
-
-/****m* irdump/dump_dominator_information
- *
- * NAME
- * dump_dominator_information
- * SYNOPSIS
- * void dump_dominator_information()
- * FUNCTION
+/**
* If this flag is set the dumper dumps edges to immediate dominator in cfg.
- * INPUTS
- * No inputs
- * RESULT
- * SEE ALSO
- *
- ***
*/
-void dump_dominator_information();
+void dump_dominator_information(void);
+
+/**
+ * If this flag is set the dumper dumps loop nodes and edges from
+ * these nodes to the contained ir nodes.
+ * Can be turned off with dont_dump_loop_information().
+ * If the loops are interprocedural nodes can be missing.
+ */
+void dump_loop_information(void);
+
+/**
+ * @see dump_loop_information()
+ */
+void dont_dump_loop_information(void);
+
+/**
+ * If set and backedge info is computed, backedges are dumped dashed
+ * and as vcg 'backedge' construct. Default: set.
+ */
+void dump_backedge_information(bool b);
+
+/**
+ * Dump the information of type field specified in ana/irtypeinfo.h.
+ * If the flag is set, the type name is output in [] in the node label,
+ * else it is output as info.
+ */
+void dump_analysed_type_info(bool b);
+
+/**
+ * Write the address of a node into the vcg info.
+ * This is off per default for automatic comparisons of
+ * vcg graphs -- these will differ in the pointer values!
+ */
+void dump_pointer_values_to_info(bool b);
# endif /* _IRDUMP_H_ */
projects / libfirm / blobdiff