-/* Copyright (C) 1998 - 2000 by Universitaet Karlsruhe
-* All rights reserved.
-*/
+/*
+ * 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
* file dumped to.
*/
-/* $Id$ */
# ifndef _IRDUMP_H_
# define _IRDUMP_H_
# include "irnode.h"
# include "irgraph.h"
+# include "irloop.h"
/**
* The value of this string will be added to the file name before .vcg
*
- * @todo GL: A hack
+ * @todo GL: A hack -- add parameter to dumper function.
*/
extern char *dump_file_suffix;
* A file containing the firm graph in vcg format.
*
* 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.
+ * 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
/**
* Dump a firm graph without explicit block nodes.
* 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.
+ * 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);
+
/**
* Dump the control flow graph of a procedure.
/**
* 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
*/
void dump_class_hierarchy (bool entities);
-/**
- * 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);
-
-/**
- * Dumps a interprocedural firm graph as dump_ir_graph.
- *
- * @param irg The firm graph to be dumped.
- *
- * @return
- * A file containing the firm graph in vcg format.
- */
-void dump_cg_graph(ir_graph * irg);
-
-/**
- * Dumps a interprocedural firm graph as dump_ir_block_graph.
- *
- * @param irg The firm graph to be dumped.
+ * 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.
*
- * @return
- * A file containing the firm graph in vcg format.
- */
-void dump_cg_block_graph(ir_graph * irg);
-
-
-void dump_all_cg_block_graph(void);
-
-/**
- * The type of a walker function that is called for each graph.
+ * Implementing this dumper was stimulated by Florian Liekwegs similar dumper.
*
- * @param irg current visited graph
+ * @arg irg Dump the loop tree for this graph.
+ * @arg suffix Suffix to filename.
*/
-typedef void dump_graph_func(ir_graph *irg);
+void dump_loop_tree(ir_graph *irg, char *suffix);
-/**
- * A walker that calls a dumper for each graph.
+/** Dumps the firm nodes in the sub-loop-tree of loop to a graph.
+ * Dumps the loop nodes if dump_loop_information() is set.
*
- * @param dump_graph The dumper to be used for dumping.
+ * The name of the file is loop_<loop_nr><suffix>.vcg.
*
- * @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()
+ * @arg loop Dump the loop tree for this loop.
+ * @arg suffix Suffix to filename.
*/
-void dump_all_ir_graphs (dump_graph_func *dump_graph);
+void dump_loop (ir_loop *l, char *suffix);
/**
* Sets the vcg flag "display_edge_labels" to no.
*/
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