[libfirm] / ir / ir / irdump.c

/*
 * Copyright (C) 1995-2007 University of Karlsruhe.  All right reserved.
 *
 * This file is part of libFirm.
 *
 * This file may be distributed and/or modified under the terms of the
 * GNU General Public License version 2 as published by the Free Software
 * Foundation and appearing in the file LICENSE.GPL included in the
 * packaging of this file.
 *
 * Licensees holding valid libFirm Professional Edition licenses may use
 * this file in accordance with the libFirm Commercial License.
 * Agreement provided with the Software.
 *
 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE.
 */

/**
 * @file
 * @brief   Write vcg representation of firm to file.
 * @author  Martin Trapp, Christian Schaefer, Goetz Lindenmaier, Hubert Schmidt
 * @version $Id$
 */
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

#ifdef HAVE_STRING_H
#include <string.h>
#endif
#ifdef HAVE_STDLIB_H
#include <stdlib.h>
#endif
#include <stdarg.h>

#include "firm_common_t.h"

#include "list.h"

#include "irnode.h"
#include "irgraph.h"
#include "irprog_t.h"
#include "entity_t.h"
#include "irop.h"

#include "irdump_t.h"

#include "irgwalk.h"
#include "tv_t.h"
#include "irouts.h"
#include "irdom.h"
#include "irloop_t.h"
#include "callgraph.h"
#include "irextbb_t.h"
#include "irhooks.h"
#include "dbginfo_t.h"
#include "irtools.h"

#include "irvrfy.h"

#include "error.h"
#include "array.h"
#include "pmap.h"
#include "eset.h"
#include "pset.h"

#if DO_HEAPANALYSIS
extern void dump_irn_chi_term(FILE *FL, ir_node *n);
extern void dump_irn_state(FILE *FL, ir_node *n);
extern int  get_opt_dump_abstvals(void);
typedef unsigned long SeqNo;
extern SeqNo get_Block_seqno(ir_node *n);
#endif

/* basis for a color range for vcg */
static int n_colors   = 0;
static int base_color = 0;

/** Dump only irgs with names that start with this string */
static ident *dump_file_filter_id = NULL;

#define ERROR_TXT       "<ERROR>"

/*******************************************************************/
/* flags to steer output                                           */
/*******************************************************************/

/** An option to turn off edge labels */
static int edge_label = 1;
/** An option to turn off dumping values of constant entities */
static int const_entities = 1;
/** An option to dump the keep alive edges */
static int dump_keepalive = 0;
/** An option to dump ld_names instead of names. */
static int dump_ld_name = 1;
/** Compiler options to dump analysis information in dump_ir_graph */
static int dump_out_edge_flag = 0;
static int dump_loop_information_flag = 0;
static int dump_backedge_information_flag = 1;
static int dump_const_local = 0;
/** An option to dump all graph anchors */
static int dump_anchors = 0;

int dump_dominator_information_flag = 0;
int opt_dump_analysed_type_info = 1;
int opt_dump_pointer_values_to_info = 0;  /* default off: for test compares!! */

static dumper_colors overrule_nodecolor = ird_color_default;

/** The vcg node attribute hook. */
static DUMP_IR_GRAPH_FUNC dump_ir_graph_hook = NULL;
/** The vcg node attribute hook. */
static DUMP_NODE_VCGATTR_FUNC dump_node_vcgattr_hook = NULL;
/** The vcg edge attribute hook. */
static DUMP_EDGE_VCGATTR_FUNC dump_edge_vcgattr_hook = NULL;
/** The vcg dump block edge hook */
static DUMP_NODE_EDGE_FUNC dump_block_edge_hook = NULL;
/** The vcg dump node edge hook. */
static DUMP_NODE_EDGE_FUNC dump_node_edge_hook = NULL;

/* Set the hook to be called to dump additional edges to a node. */
void set_dump_node_edge_hook(DUMP_NODE_EDGE_FUNC func) {
        dump_node_edge_hook = func;
}

/* Get the additional edge dump hook. */
DUMP_NODE_EDGE_FUNC get_dump_node_edge_hook(void) {
        return dump_node_edge_hook;
}

/* Set the hook to be called to dump additional edges to a block. */
void set_dump_block_edge_hook(DUMP_NODE_EDGE_FUNC func) {
        dump_block_edge_hook = func;
}

/* Get the additional block edge dump hook. */
DUMP_NODE_EDGE_FUNC get_dump_block_edge_hook(void) {
        return dump_node_edge_hook;
}

/* set the ir graph hook */
void set_dump_ir_graph_hook(DUMP_IR_GRAPH_FUNC hook) {
        dump_ir_graph_hook = hook;
}

/* set the node attribute hook */
void set_dump_node_vcgattr_hook(DUMP_NODE_VCGATTR_FUNC hook) {
        dump_node_vcgattr_hook = hook;
}

/* set the edge attribute hook */
void set_dump_edge_vcgattr_hook(DUMP_EDGE_VCGATTR_FUNC hook) {
        dump_edge_vcgattr_hook = hook;
}

/* Returns 0 if dump_out_edge_flag or dump_loop_information_flag
 * are set, else returns dump_const_local_flag.
 */
int get_opt_dump_const_local(void) {
        if (!dump_out_edge_flag && !dump_loop_information_flag)
                return dump_const_local;
        else
                return 0;
}

/* Set a prefix filter for output functions. */
void only_dump_method_with_name(ident *name) {
        dump_file_filter_id = name;
}

/* Returns the prefix filter set with only_dump_method_with_name(). */
ident *get_dump_file_filter_ident(void) {
        return dump_file_filter_id;
}

/* Returns non-zero if dump file filter is not set, or if it is a prefix of name. */
int is_filtered_dump_name(ident *name) {
        if (!dump_file_filter_id) return 1;
        return id_is_prefix(dump_file_filter_id, name);
}

/* To turn off display of edge labels.  Edge labels often cause xvcg to
   abort with a segmentation fault. */
void turn_off_edge_labels(void) {
        edge_label = 0;
}

void dump_consts_local(int flag) {
        dump_const_local = flag;
}

void dump_constant_entity_values(int flag) {
        const_entities = flag;
}

void dump_keepalive_edges(int flag) {
        dump_keepalive = flag;
}

int get_opt_dump_keepalive_edges(void) {
        return dump_keepalive;
}

void dump_out_edges(int flag) {
        dump_out_edge_flag = flag;
}

void dump_dominator_information(int flag) {
        dump_dominator_information_flag = flag;
}

void dump_loop_information(int flag) {
        dump_loop_information_flag = flag;
}

void dump_backedge_information(int flag) {
        dump_backedge_information_flag = flag;
}

/* 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 set_opt_dump_analysed_type_info(int flag) {
        opt_dump_analysed_type_info = flag;
}

void dump_pointer_values_to_info(int flag) {
        opt_dump_pointer_values_to_info = flag;
}

void dump_ld_names(int flag) {
        dump_ld_name = flag;
}

void dump_all_anchors(int flag) {
        dump_anchors = flag;
}

/* -------------- some extended helper functions ----------------- */

/**
 * returns the name of a mode or <ERROR> if mode is NOT a mode object.
 * in the later case, sets bad
 */
const char *get_mode_name_ex(ir_mode *mode, int *bad) {
        if (is_mode(mode))
                return get_mode_name(mode);
        *bad |= 1;
        return ERROR_TXT;
}

/**
 * returns the name of a type or <ERROR> if mode is NOT a mode object.
 * in the later case, sets bad
 */
const char *get_type_name_ex(ir_type *tp, int *bad) {
        if (is_type(tp))
                return get_type_name(tp);
        *bad |= 1;
        return ERROR_TXT;
}

/**
 * printf the VCG color to a file
 */
static void print_vcg_color(FILE *F, dumper_colors color) {
        static const char *color_names[32] = {
                "white",        "blue",      "red",        "green",
                "yellow",       "magenta",   "cyan",       "darkgray",
                "darkblue",     "darkred",   "darkgreen",  "darkyellow",
                "darkmagenta",  "darkcyan",  "gold",       "lightgray",
                "lightblue",    "lightred",  "lightgreen", "lightyellow",
                "lightmagenta", "lightcyan", "lilac",      "turquoise",
                "aquamarine",   "khaki",     "purple",     "yellowgreen",
                "pink",         "orange",    "orchid",     "black"
        };

        if (color != ird_color_default)
                fprintf(F, "color:%s", color_names[color]);
}

/**
 * prints the edge from a type S to a type T with additional info fmt, ...
 * to the file F
 */
static void print_type_type_edge(FILE *F, ir_type *S, ir_type *T, const char *fmt, ...)
{
        va_list ap;

        va_start(ap, fmt);
        fprintf(F, "edge: { sourcename: "); PRINT_TYPEID(S);
        fprintf(F, " targetname: "); PRINT_TYPEID(T);
        vfprintf(F, fmt, ap);
        fprintf(F,"}\n");
        va_end(ap);
}

/**
 * prints the edge from a type T to an entity E with additional info fmt, ...
 * to the file F
 */
static void print_type_ent_edge(FILE *F, ir_type *T, ir_entity *E, const char *fmt, ...)
{
        va_list ap;

        va_start(ap, fmt);
        fprintf(F, "edge: { sourcename: "); PRINT_TYPEID(T);
        fprintf(F, " targetname: \""); PRINT_ENTID(E); fprintf(F, "\"");
        vfprintf(F, fmt, ap);
        fprintf(F, "}\n");
        va_end(ap);
}

/**
 * prints the edge from an entity E to an entity T with additional info fmt, ...
 * to the file F
 */
static void print_ent_ent_edge(FILE *F, ir_entity *E, ir_entity *T, int backedge, const char *fmt, ...)
{
        va_list ap;

        va_start(ap, fmt);
        if (backedge)
                fprintf(F, "backedge: { sourcename: \"");
        else
                fprintf(F, "edge: { sourcename: \"");
        PRINT_ENTID(E);
        fprintf(F, "\" targetname: \""); PRINT_ENTID(T);  fprintf(F, "\"");
        vfprintf(F, fmt, ap);
        fprintf(F, "}\n");
        va_end(ap);
}

/**
 * prints the edge from an entity E to a type T with additional info fmt, ...
 * to the file F
 */
static void print_ent_type_edge(FILE *F, ir_entity *E, ir_type *T, const char *fmt, ...)
{
        va_list ap;

        va_start(ap, fmt);
        fprintf(F, "edge: { sourcename: \""); PRINT_ENTID(E);
        fprintf(F, "\" targetname: "); PRINT_TYPEID(T);
        vfprintf(F, fmt, ap);
        fprintf(F,"}\n");
        va_end(ap);
}

/**
 * prints the edge from a node N to a type T with additional info fmt, ...
 * to the file F
 */
static void print_node_type_edge(FILE *F, const ir_node *N, ir_type *T, const char *fmt, ...)
{
        va_list ap;

        va_start(ap, fmt);
        fprintf(F, "edge: { sourcename: \""); PRINT_NODEID(N);
        fprintf(F, "\" targetname: "); PRINT_TYPEID(T);
        vfprintf(F, fmt, ap);
        fprintf(F,"}\n");
        va_end(ap);
}

/**
 * prints the edge from a node N to an entity E with additional info fmt, ...
 * to the file F
 */
static void print_node_ent_edge(FILE *F, const ir_node *N, ir_entity *E, const char *fmt, ...)
{
        va_list ap;

        va_start(ap, fmt);
        fprintf(F, "edge: { sourcename: \""); PRINT_NODEID(N);
        fprintf(F, "\" targetname: \""); PRINT_ENTID(E);
        fprintf(F, "\"");
        vfprintf(F, fmt, ap);
        fprintf(F,"}\n");
        va_end(ap);
}

/**
 * prints the edge from an entity E to a node N with additional info fmt, ...
 * to the file F
 */
static void print_ent_node_edge(FILE *F, ir_entity *E, const ir_node *N, const char *fmt, ...)
{
        va_list ap;

        va_start(ap, fmt);
        fprintf(F, "edge: { sourcename: \""); PRINT_ENTID(E);
        fprintf(F, "\" targetname: \""); PRINT_NODEID(N); fprintf(F, "\"");
        vfprintf(F, fmt, ap);
        fprintf(F,"}\n");
        va_end(ap);
}

/**
 * prints the edge from a type E to an enumeration item item with additional info fmt, ...
 * to the file F
 */
static void print_enum_item_edge(FILE *F, ir_type *E, int item, const char *fmt, ...)
{
        va_list ap;

        va_start(ap, fmt);
        fprintf(F, "edge: { sourcename: "); PRINT_TYPEID(E);
        fprintf(F, " targetname: \""); PRINT_ITEMID(E, item); fprintf(F, "\" ");
        vfprintf(F, fmt, ap);
        fprintf(F,"}\n");
        va_end(ap);
}

/*-----------------------------------------------------------------*/
/* global and ahead declarations                                   */
/*-----------------------------------------------------------------*/

static void dump_whole_node(ir_node *n, void *env);
static INLINE void dump_loop_nodes_into_graph(FILE *F, ir_graph *irg);

/*-----------------------------------------------------------------*/
/* Helper functions.                                                */
/*-----------------------------------------------------------------*/

/**
 * This map is used as a private link attr to be able to call dumper
 * anywhere without destroying link fields.
 */
static pmap *irdump_link_map = NULL;

/** NOT A STANDARD LIBFIRM INIT METHOD
 *
 * We do not want to integrate dumping into libfirm, i.e., if the dumpers
 * are off, we want to have as few interferences as possible.  Therefore the
 * initialization is performed lazily and not called from within init_firm.
 *
 * Creates the link attribute map. */
static void init_irdump(void) {
        /* We need a new, empty map. */
        if (irdump_link_map) pmap_destroy(irdump_link_map);
        irdump_link_map = pmap_create();
        if (!dump_file_filter_id)
                dump_file_filter_id = new_id_from_str("");
}

/**
 * Returns the private link field.
 */
static void *ird_get_irn_link(ir_node *n) {
        void *res = NULL;
        if (!irdump_link_map) return NULL;

        if (pmap_contains(irdump_link_map, (void *)n))
                res = pmap_get(irdump_link_map, (void *)n);
        return res;
}

/**
 * Sets the private link field.
 */
static void ird_set_irn_link(ir_node *n, void *x) {
        if (!irdump_link_map)
                init_irdump();
        pmap_insert(irdump_link_map, (void *)n, x);
}

/**
 * Gets the private link field of an irg.
 */
static void *ird_get_irg_link(ir_graph *irg) {
        void *res = NULL;
        if (!irdump_link_map) return NULL;

        if (pmap_contains(irdump_link_map, (void *)irg))
                res = pmap_get(irdump_link_map, (void *)irg);
        return res;
}

/**
 * Sets the private link field of an irg.
 */
static void ird_set_irg_link(ir_graph *irg, void *x) {
        if (!irdump_link_map) init_irdump();
        pmap_insert(irdump_link_map, (void *)irg, x);
}

/**
 * Walker, clears the private link field.
 */
static void clear_link(ir_node * node, void * env) {
        (void) env;
        ird_set_irn_link(node, NULL);
}

/**
 * If the entity has a ld_name, returns it if the dump_ld_name is set,
 * else returns the name of the entity.
 */
static const char *_get_ent_dump_name(ir_entity *ent, int dump_ld_name) {
        if (!ent)
                return "<NULL entity>";
        if (dump_ld_name) {
                /* Don't use get_entity_ld_ident (ent) as it computes the mangled name! */
                if (ent->ld_name) return get_id_str(ent->ld_name);
        }
        return get_id_str(ent->name);
}

/**
 * If the entity has a ld_name, returns it if the option dump_ld_name is set,
 * else returns the name of the entity.
 */
const char *get_ent_dump_name(ir_entity *ent) {
        return _get_ent_dump_name(ent, dump_ld_name);
}

/* Returns the name of an IRG. */
const char *get_irg_dump_name(ir_graph *irg) {
        /* Don't use get_entity_ld_ident (ent) as it computes the mangled name! */
        return _get_ent_dump_name(get_irg_entity(irg), 1);
}

/**
 * Returns non-zero if a node is in floating state.
 */
static int node_floats(ir_node *n) {
        return ((get_irn_pinned(n) == op_pin_state_floats) &&
                (get_irg_pinned(current_ir_graph) == op_pin_state_floats));
}

/**
 *  Walker that visits the anchors
 */
static void ird_walk_graph(ir_graph *irg, irg_walk_func *pre, irg_walk_func *post, void *env) {
        if (dump_anchors) {
                int i;

                if (pre)
                        pre(irg->anchor, env);

                for (i = get_irg_n_anchors(irg) - 1; i >= 0; --i) {
                        ir_node *n = get_irg_anchor(irg, i);

                        if (n) {
                                /* reset the visit flag: will be increase in the walker */
                                set_irg_visited(irg, get_irg_visited(irg) - 1);
                                irg_walk(n, pre, post, env);
                        }
                }
                if (post)
                        post(irg->anchor, env);
        } else {
                irg_walk_graph(irg, pre, post, env);
        }
}

/**
 * Walker, allocates an array for all blocks and puts it's nodes non-floating nodes into this array.
 */
static void collect_node(ir_node * node, void *env) {
        (void) env;
        if (is_Block(node)
            || node_floats(node)
            || get_irn_op(node) == op_Bad
            || get_irn_op(node) == op_Unknown
            || get_irn_op(node) == op_NoMem) {
                ir_node ** arr = (ir_node **) ird_get_irg_link(get_irn_irg(node));
                if (!arr) arr = NEW_ARR_F(ir_node *, 0);
                ARR_APP1(ir_node *, arr, node);
                ird_set_irg_link(get_irn_irg(node), arr);    /* arr is an l-value, APP_ARR might change it! */
        } else {
                ir_node * block = get_nodes_block(node);

                if (is_Bad(block)) {
                        /* this node is in a Bad block, so we must place it into the graph's list */
                        ir_node ** arr = (ir_node **) ird_get_irg_link(get_irn_irg(node));
                        if (!arr) arr = NEW_ARR_F(ir_node *, 0);
                        ARR_APP1(ir_node *, arr, node);
                        ird_set_irg_link(get_irn_irg(node), arr);    /* arr is an l-value, APP_ARR might change it! */
                } else {
                        ird_set_irn_link(node, ird_get_irn_link(block));
                        ird_set_irn_link(block, node);
                }
        }
}

/** Construct lists to walk ir block-wise.
 *
 * Collects all blocks, nodes not op_pin_state_pinned,
 * Bad, NoMem and Unknown into a flexible array in link field of
 * irg they belong to.  Sets the irg link field to NULL in all
 * graphs not visited.
 * Free the list with DEL_ARR_F().
 */
static ir_node **construct_block_lists(ir_graph *irg) {
        int      i;
        int      rem_view  = get_interprocedural_view();
        int      walk_flag = using_visited(irg);
        ir_graph *rem      = current_ir_graph;

        current_ir_graph = irg;

        if(walk_flag)
                clear_using_visited(current_ir_graph);

        for (i = get_irp_n_irgs() - 1; i >= 0; --i)
                ird_set_irg_link(get_irp_irg(i), NULL);

        ird_walk_graph(current_ir_graph, clear_link, collect_node, current_ir_graph);

        /* Collect also EndReg and EndExcept. We do not want to change the walker. */
        set_interprocedural_view(0);

        set_irg_visited(current_ir_graph, get_irg_visited(current_ir_graph)-1);
        irg_walk(get_irg_end_reg(current_ir_graph), clear_link, collect_node, current_ir_graph);
        set_irg_visited(current_ir_graph, get_irg_visited(current_ir_graph)-1);
        irg_walk(get_irg_end_except(current_ir_graph), clear_link, collect_node, current_ir_graph);

        set_interprocedural_view(rem_view);

        if(walk_flag)
                set_using_visited(current_ir_graph);

        current_ir_graph = rem;
        return ird_get_irg_link(irg);
}

typedef struct _list_tuple {
        ir_node **blk_list;
        ir_extblk **extbb_list;
} list_tuple;

/** Construct lists to walk IR extended block-wise.
 * Free the lists in the tuple with DEL_ARR_F().
 * Sets the irg link field to NULL in all
 * graphs not visited.
 */
static list_tuple *construct_extblock_lists(ir_graph *irg) {
        ir_node **blk_list = construct_block_lists(irg);
        int i;
        ir_graph *rem = current_ir_graph;
        list_tuple *lists = xmalloc(sizeof(*lists));

        current_ir_graph = irg;

        lists->blk_list   = NEW_ARR_F(ir_node *, 0);
        lists->extbb_list = NEW_ARR_F(ir_extblk *, 0);

        inc_irg_block_visited(irg);
        for (i = ARR_LEN(blk_list) - 1; i >= 0; --i) {
                ir_extblk *ext;

                if (is_Block(blk_list[i])) {
                        ext = get_Block_extbb(blk_list[i]);

                        if (extbb_not_visited(ext)) {
                                ARR_APP1(ir_extblk *, lists->extbb_list, ext);
                                mark_extbb_visited(ext);
                        }
                } else
                        ARR_APP1(ir_node *, lists->blk_list, blk_list[i]);
        }
        DEL_ARR_F(blk_list);

        current_ir_graph = rem;
        ird_set_irg_link(irg, lists);
        return lists;
}

/*-----------------------------------------------------------------*/
/* Routines to dump information about a single ir node.            */
/*-----------------------------------------------------------------*/

/*
 * dump the name of a node n to the File F.
 */
int dump_node_opcode(FILE *F, ir_node *n)
{
        int bad = 0;
        const ir_op_ops *ops = get_op_ops(get_irn_op(n));

        /* call the dump_node operation if available */
        if (ops->dump_node)
                return ops->dump_node(n, F, dump_node_opcode_txt);

        /* implementation for default nodes */
        switch (get_irn_opcode(n)) {

        case iro_Const: {
                int res;
                char buf[1024];
                res = tarval_snprintf(buf, sizeof(buf), get_Const_tarval(n));
                assert(res < (int) sizeof(buf) && "buffer to small for tarval_snprintf");
                fprintf(F, buf);
        } break;

        case iro_SymConst: {
                switch (get_SymConst_kind(n)) {
                case symconst_addr_name:
                        /* don't use get_SymConst_ptr_info as it mangles the name. */
                        fprintf(F, "SymC %s", get_id_str(get_SymConst_name(n)));
                        break;
                case symconst_addr_ent:
                        fprintf(F, "SymC &%s", get_entity_name(get_SymConst_entity(n)));
                        break;
                case symconst_ofs_ent:
                        fprintf(F, "SymC %s offset", get_entity_name(get_SymConst_entity(n)));
                        break;
                case symconst_type_tag:
                        fprintf(F, "SymC %s tag", get_type_name_ex(get_SymConst_type(n), &bad));
                        break;
                case symconst_type_size:
                        fprintf(F, "SymC %s size", get_type_name_ex(get_SymConst_type(n), &bad));
                        break;
                case symconst_type_align:
                        fprintf(F, "SymC %s align", get_type_name_ex(get_SymConst_type(n), &bad));
                        break;
                case symconst_enum_const:
                        fprintf(F, "SymC %s enum", get_enumeration_name(get_SymConst_enum(n)));
                        break;
                }
        } break;

        case iro_Filter: {
                if (!get_interprocedural_view())
                        fprintf(F, "Proj'");
                else
                        goto default_case;
        } break;

        case iro_Proj: {
                ir_node *pred = get_Proj_pred(n);

                if (get_irn_opcode(pred) == iro_Cond
                        && get_Proj_proj(n) == get_Cond_defaultProj(pred)
                        && get_irn_mode(get_Cond_selector(pred)) != mode_b)
                        fprintf(F, "defProj");
                else
                        goto default_case;
        } break;
        case iro_Start:
        case iro_End:
        case iro_EndExcept:
        case iro_EndReg: {
                if (get_interprocedural_view()) {
                        fprintf(F, "%s %s", get_irn_opname(n), get_ent_dump_name(get_irg_entity(get_irn_irg(n))));
                        break;
                } else
                        goto default_case;
        }
        case iro_CallBegin: {
                ir_node *addr = get_CallBegin_ptr(n);
                ir_entity *ent = NULL;
                if (get_irn_op(addr) == op_Sel)
                        ent = get_Sel_entity(addr);
                else if ((get_irn_op(addr) == op_SymConst) && (get_SymConst_kind(addr) == symconst_addr_ent))
                        ent = get_SymConst_entity(addr);
                fprintf(F, "%s", get_irn_opname(n));
                if (ent) fprintf(F, " %s", get_entity_name(ent));
                break;
        }
        case iro_Load:
                fprintf(F, "%s[%s]", get_irn_opname(n), get_mode_name_ex(get_Load_mode(n), &bad));
                break;
        case iro_Block:
                fprintf(F, "%s%s", is_Block_dead(n) ? "Dead " : "", get_irn_opname(n));
                break;
        case iro_Conv:
                if (get_Conv_strict(n))
                        fprintf(F, "strict");
                fprintf(F, "%s", get_irn_opname(n));
                break;

        default:
default_case:
                fprintf(F, "%s", get_irn_opname(n));

        }  /* end switch */
        return bad;
}

/**
 * Dump the mode of a node n to a file F.
 * Ignore modes that are "always known".
 */
static int dump_node_mode(FILE *F, ir_node *n)
{
        int bad = 0;
        const ir_op_ops *ops = get_op_ops(get_irn_op(n));
        ir_opcode iro;

        /* call the dump_node operation if available */
        if (ops->dump_node)
                return ops->dump_node(n, F, dump_node_mode_txt);

        /* default implementation */
        iro = get_irn_opcode(n);
        switch (iro) {
        case iro_SymConst:
        case iro_Sel:
        case iro_End:
        case iro_Return:
        case iro_Free:
        case iro_Sync:
        case iro_Jmp:
        case iro_NoMem:
                break;
        default: {
                ir_mode *mode = get_irn_mode(n);

                if (mode && mode != mode_BB && mode != mode_ANY && mode != mode_BAD &&
                        (mode != mode_T || iro == iro_Proj))
                        fprintf(F, "%s", get_mode_name_ex(mode, &bad));
        }
        }

        return bad;
}

/**
 * Dump the type of a node n to a file F if it's known.
 */
static int dump_node_typeinfo(FILE *F, ir_node *n) {
        int bad = 0;

        if (opt_dump_analysed_type_info) {
                if (get_irg_typeinfo_state(current_ir_graph) == ir_typeinfo_consistent  ||
                        get_irg_typeinfo_state(current_ir_graph) == ir_typeinfo_inconsistent) {
                        ir_type *tp = get_irn_typeinfo_type(n);
                        if (tp != firm_none_type)
                                fprintf(F, "[%s] ", get_type_name_ex(tp, &bad));
                        else
                                fprintf(F, "[] ");
                }
        }
        return bad;
}

typedef struct _pns_lookup {
        long       nr;      /**< the proj number */
        const char *name;   /**< the name of the Proj */
} pns_lookup_t;

typedef struct _proj_lookup {
        ir_opcode          code;      /**< the opcode of the Proj predecessor */
        unsigned           num_data;  /**< number of data entries */
        const pns_lookup_t *data;     /**< the data */
} proj_lookup_t;

#define ARR_SIZE(a)       (sizeof(a)/sizeof(a[0]))

/** the lookup table for Proj(Start) names */
static const pns_lookup_t start_lut[] = {
#define X(a)    { pn_Start_##a, #a }
        X(X_initial_exec),
        X(P_frame_base),
        X(P_globals),
        X(P_tls),
        X(T_args),
        X(P_value_arg_base)
#undef X
};

/** the lookup table for Proj(Cond) names */
static const pns_lookup_t cond_lut[] = {
#define X(a)    { pn_Cond_##a, #a }
        X(false),
        X(true)
#undef X
};

/** the lookup table for Proj(Call) names */
static const pns_lookup_t call_lut[] = {
#define X(a)    { pn_Call_##a, #a }
        X(M_regular),
        X(X_regular),
        X(X_except),
        X(T_result),
        X(M_except),
        X(P_value_res_base)
#undef X
};

/** the lookup table for Proj(Quot) names */
static const pns_lookup_t quot_lut[] = {
#define X(a)    { pn_Quot_##a, #a }
        X(M),
        X(X_regular),
        X(X_except),
        X(res)
#undef X
};

/** the lookup table for Proj(DivMod) names */
static const pns_lookup_t divmod_lut[] = {
#define X(a)    { pn_DivMod_##a, #a }
        X(M),
        X(X_regular),
        X(X_except),
        X(res_div),
        X(res_mod)
#undef X
};

/** the lookup table for Proj(Div) names */
static const pns_lookup_t div_lut[] = {
#define X(a)    { pn_Div_##a, #a }
        X(M),
        X(X_regular),
        X(X_except),
        X(res)
#undef X
};

/** the lookup table for Proj(Mod) names */
static const pns_lookup_t mod_lut[] = {
#define X(a)    { pn_Mod_##a, #a }
        X(M),
        X(X_regular),
        X(X_except),
        X(res)
#undef X
};

/** the lookup table for Proj(Load) names */
static const pns_lookup_t load_lut[] = {
#define X(a)    { pn_Load_##a, #a }
        X(M),
        X(X_regular),
        X(X_except),
        X(res)
#undef X
};

/** the lookup table for Proj(Store) names */
static const pns_lookup_t store_lut[] = {
#define X(a)    { pn_Store_##a, #a }
        X(M),
        X(X_regular),
        X(X_except)
#undef X
};

/** the lookup table for Proj(Alloc) names */
static const pns_lookup_t alloc_lut[] = {
#define X(a)    { pn_Alloc_##a, #a }
        X(M),
        X(X_regular),
        X(X_except),
        X(res)
#undef X
};

/** the lookup table for Proj(CopyB) names */
static const pns_lookup_t copyb_lut[] = {
#define X(a)    { pn_CopyB_##a, #a }
        X(M),
        X(X_regular),
        X(X_except),
        X(M_except)
#undef X
};

/** the lookup table for Proj(InstOf) names */
static const pns_lookup_t instof_lut[] = {
#define X(a)    { pn_InstOf_##a, #a }
        X(M),
        X(X_regular),
        X(X_except),
        X(res),
        X(M_except),
#undef X
};

/** the lookup table for Proj(Raise) names */
static const pns_lookup_t raise_lut[] = {
#define X(a)    { pn_Raise_##a, #a }
        X(M),
        X(X),
#undef X
};

/** the lookup table for Proj(Bound) names */
static const pns_lookup_t bound_lut[] = {
#define X(a)    { pn_Bound_##a, #a }
        X(M),
        X(X_regular),
        X(X_except),
        X(res),
#undef X
};

/** the Proj lookup table */
static const proj_lookup_t proj_lut[] = {
#define E(a)  ARR_SIZE(a), a
        { iro_Start,   E(start_lut) },
        { iro_Cond,    E(cond_lut) },
        { iro_Call,    E(call_lut) },
        { iro_Quot,    E(quot_lut) },
        { iro_DivMod,  E(divmod_lut) },
        { iro_Div,     E(div_lut) },
        { iro_Mod,     E(mod_lut) },
        { iro_Load,    E(load_lut) },
        { iro_Store,   E(store_lut) },
        { iro_Alloc,   E(alloc_lut) },
        { iro_CopyB,   E(copyb_lut) },
        { iro_InstOf,  E(instof_lut) },
        { iro_Raise,   E(raise_lut) },
        { iro_Bound,   E(bound_lut) }
#undef E
};

/**
 * Dump additional node attributes of some nodes to a file F.
 */
static int
dump_node_nodeattr(FILE *F, ir_node *n)
{
        int bad = 0;
        ir_node *pred;
        ir_opcode code;
        long proj_nr;
        const ir_op_ops *ops = get_op_ops(get_irn_op(n));

        /* call the dump_node operation if available */
        if (ops->dump_node)
                return ops->dump_node(n, F, dump_node_nodeattr_txt);

        switch (get_irn_opcode(n)) {
        case iro_Start:
                if (0 && get_interprocedural_view()) {
                        fprintf(F, "%s ", get_ent_dump_name(get_irg_entity(current_ir_graph)));
                }
                break;

        case iro_Proj:
                pred    = get_Proj_pred(n);
                proj_nr = get_Proj_proj(n);
handle_lut:
                code    = get_irn_opcode(pred);

                if (code == iro_Cmp)
                        fprintf(F, "%s ", get_pnc_string(get_Proj_proj(n)));
                else if (code == iro_Proj && get_irn_opcode(get_Proj_pred(pred)) == iro_Start)
                        fprintf(F, "Arg %ld ", proj_nr);
                else if (code == iro_Cond && get_irn_mode(get_Cond_selector(pred)) != mode_b)
                        fprintf(F, "%ld ", proj_nr);
                else {
                        unsigned i, j, f = 0;

                        for (i = 0; i < ARR_SIZE(proj_lut); ++i) {
                                if (code == proj_lut[i].code) {
                                        for (j = 0; j < proj_lut[i].num_data; ++j) {
                                                if (proj_nr == proj_lut[i].data[j].nr) {
                                                        fprintf(F, "%s ", proj_lut[i].data[j].name);
                                                        f = 1;
                                                        break;
                                                }
                                        }
                                        break;
                                }
                        }
                        if (! f)
                                fprintf(F, "%ld ", proj_nr);
                        if (code == iro_Cond && get_Cond_jmp_pred(pred) != COND_JMP_PRED_NONE) {
                                if (proj_nr == pn_Cond_false && get_Cond_jmp_pred(pred) == COND_JMP_PRED_FALSE)
                                        fprintf(F, "PRED ");
                                if (proj_nr == pn_Cond_true && get_Cond_jmp_pred(pred) == COND_JMP_PRED_TRUE)
                                        fprintf(F, "PRED ");
                        }
                }
                break;
        case iro_Filter:
                proj_nr = get_Filter_proj(n);
                if (! get_interprocedural_view()) {
                        /* it's a Proj' */
                        pred    = get_Filter_pred(n);
                        goto handle_lut;
                } else
                        fprintf(F, "%ld ", proj_nr);
                break;
        case iro_Sel:
                fprintf(F, "%s ", get_ent_dump_name(get_Sel_entity(n)));
                break;
        case iro_Cast:
                fprintf(F, "(%s) ", get_type_name_ex(get_Cast_type(n), &bad));
                break;
        case iro_Confirm:
                fprintf(F, "%s ", get_pnc_string(get_Confirm_cmp(n)));
                break;
        case iro_CopyB:
                fprintf(F, "(%s) ", get_type_name_ex(get_CopyB_type(n), &bad));
                break;

        default:
                ;
        } /* end switch */

        return bad;
}

#include <math.h>
#include "execution_frequency.h"

static void dump_node_ana_vals(FILE *F, ir_node *n) {
        return;
        fprintf(F, " %lf*(%2.0lf + %2.0lf) = %2.0lf ",
                get_irn_exec_freq(n),
                get_irg_method_execution_frequency(get_irn_irg(n)),
                pow(5, get_irg_recursion_depth(get_irn_irg(n))),
                get_irn_exec_freq(n) * (get_irg_method_execution_frequency(get_irn_irg(n)) + pow(5, get_irg_recursion_depth(get_irn_irg(n))))
        );
}


/* Dumps a node label without the enclosing ". */
int dump_node_label(FILE *F, ir_node *n) {
        int bad = 0;

        bad |= dump_node_opcode(F, n);
        bad |= dump_node_mode(F, n);
        fprintf(F, " ");
        bad |= dump_node_typeinfo(F, n);
        bad |= dump_node_nodeattr(F, n);
        fprintf(F, "%ld:%d", get_irn_node_nr(n), get_irn_idx(n));

        return bad;
}


/**
 * Dumps the attributes of a node n into the file F.
 * Currently this is only the color of a node.
 */
static void dump_node_vcgattr(FILE *F, ir_node *node, ir_node *local, int bad)
{
        ir_node *n;

        if (bad) {
                print_vcg_color(F, ird_color_red);
                return;
        }

        if (dump_node_vcgattr_hook)
                if (dump_node_vcgattr_hook(F, node, local))
                        return;

        n = local ? local : node;

        if (overrule_nodecolor != ird_color_default) {
                print_vcg_color(F, overrule_nodecolor);
                return;
        }

        switch (get_irn_opcode(n)) {
        case iro_Start:
        case iro_EndReg:
                /* fall through */
        case iro_EndExcept:
                /* fall through */
        case iro_End:
                print_vcg_color(F, ird_color_blue);
                break;
        case iro_Block:
                if (is_Block_dead(n))
                        print_vcg_color(F, ird_color_lightred);
                else
                        print_vcg_color(F, ird_color_lightyellow);
                break;
        case iro_Phi:
                print_vcg_color(F, ird_color_green);
                break;
        case iro_Mux:
        case iro_Psi:
                print_vcg_color(F, ird_color_gold);
                break;
        case iro_Pin:
                print_vcg_color(F, ird_color_orchid);
                break;
        case iro_Const:
        case iro_Proj:
        case iro_Filter:
        case iro_Tuple:
                print_vcg_color(F, ird_color_yellow);
                break;
        case iro_ASM:
                print_vcg_color(F, ird_color_darkyellow);
                break;
        default:
                PRINT_DEFAULT_NODE_ATTR;
        }
}

/* Adds a new node info dumper callback. */
void *dump_add_node_info_callback(dump_node_info_cb_t *cb, void *data)
{
        hook_entry_t *info = xmalloc(sizeof(*info));

        info->hook._hook_node_info = cb;
        info->context              = data;
        register_hook(hook_node_info, info);

        return info;
}

/* Remove a previously added info dumper callback. */
void dump_remv_node_info_callback(void *handle)
{
        hook_entry_t *info = handle;
        unregister_hook(hook_node_info, info);
        xfree(info);
}

/**
 * Dump the node information of a node n to a file F.
 */
static INLINE int dump_node_info(FILE *F, ir_node *n)
{
        int bad = 0;
        const ir_op_ops *ops = get_op_ops(get_irn_op(n));

        fprintf(F, " info1: \"");
        bad = dump_irnode_to_file(F, n);
        /* call the dump_node operation if available */
        if (ops->dump_node)
                bad = ops->dump_node(n, F, dump_node_info_txt);

        /* allow additional info to be added */
        hook_node_info(F, n);
        fprintf(F, "\"\n");

        return bad;
}

/**
 * checks whether a node is "constant-like" ie can be treated "block-less"
 */
static INLINE
int is_constlike_node(ir_node *n) {
        ir_opcode code = get_irn_opcode(n);
        return (code == iro_Const || code == iro_Bad || code == iro_NoMem || code == iro_SymConst || code == iro_Unknown);
}


/** outputs the predecessors of n, that are constants, local.  I.e.,
   generates a copy of the constant predecessors for each node called with. */
static void dump_const_node_local(FILE *F, ir_node *n) {
        int i;
        if (!get_opt_dump_const_local()) return;

        /* Use visited flag to avoid outputting nodes twice.
        initialize it first. */
        for (i = 0; i < get_irn_arity(n); i++) {
                ir_node *con = get_irn_n(n, i);
                if (is_constlike_node(con)) {
                        set_irn_visited(con, get_irg_visited(current_ir_graph) - 1);
                }
        }

        for (i = 0; i < get_irn_arity(n); i++) {
                ir_node *con = get_irn_n(n, i);
                if (is_constlike_node(con) && irn_not_visited(con)) {
                        int bad = 0;

                        mark_irn_visited(con);
                        /* Generate a new name for the node by appending the names of
                        n and const. */
                        fprintf(F, "node: {title: "); PRINT_CONSTID(n, con);
                        fprintf(F, " label: \"");
                        bad |= dump_node_label(F, con);
                        fprintf(F, "\" ");
                        bad |= dump_node_info(F, con);
                        dump_node_vcgattr(F, n, con, bad);
                        fprintf(F, "}\n");
                }
        }
}

/** If the block of an edge is a const_like node, dump it local with an edge */
static void dump_const_block_local(FILE *F, ir_node *n) {
        ir_node *blk;

        if (!get_opt_dump_const_local()) return;

        blk = get_nodes_block(n);
        if (is_constlike_node(blk)) {
                int bad = 0;

                /* Generate a new name for the node by appending the names of
                n and blk. */
                fprintf(F, "node: {title: \""); PRINT_CONSTBLKID(n, blk);
                fprintf(F, "\" label: \"");
                bad |= dump_node_label(F, blk);
                fprintf(F, "\" ");
                bad |= dump_node_info(F, blk);
                dump_node_vcgattr(F, n, blk, bad);
                fprintf(F, "}\n");

                fprintf(F, "edge: { sourcename: \"");
                PRINT_NODEID(n);
                fprintf(F, "\" targetname: \""); PRINT_CONSTBLKID(n,blk);

                if (dump_edge_vcgattr_hook) {
                        fprintf(F, "\" ");
                        if (dump_edge_vcgattr_hook(F, n, -1)) {
                                fprintf(F, "}\n");
                                return;
                        } else {
                                fprintf(F, " " BLOCK_EDGE_ATTR "}\n");
                                return;
                        }
                }

                fprintf(F, "\" "   BLOCK_EDGE_ATTR "}\n");
        }
}

/**
 * prints the error message of a node to a file F as info2.
 */
static void print_node_error(FILE *F, const char *err_msg)
{
        if (! err_msg)
                return;

        fprintf(F, " info2: \"%s\"", err_msg);
}

/**
 * prints debug messages of a node to file F as info3.
 */
static void print_dbg_info(FILE *F, dbg_info *dbg)
{
        char buf[1024];

        if (__dbg_info_snprint) {
                buf[0] = '\0';
                if (__dbg_info_snprint(buf, sizeof(buf), dbg) > 0)
                        fprintf(F, " info3: \"%s\"\n", buf);
        }
}

/**
 * Dump a node
 */
static void dump_node(FILE *F, ir_node *n)
{
        int bad = 0;
        const char *p;

        if (get_opt_dump_const_local() && is_constlike_node(n))
                return;

        /* dump this node */
        fprintf(F, "node: {title: \""); PRINT_NODEID(n); fprintf(F, "\" label: \"");

        bad = ! irn_vrfy_irg_dump(n, current_ir_graph, &p);
        bad |= dump_node_label(F, n);
        dump_node_ana_vals(F, n);
        //dump_node_ana_info(F, n);
        fprintf(F, "\" ");
        bad |= dump_node_info(F, n);
        print_node_error(F, p);
        print_dbg_info(F, get_irn_dbg_info(n));
        dump_node_vcgattr(F, n, NULL, bad);
        fprintf(F, "}\n");
        dump_const_node_local(F, n);

        if(dump_node_edge_hook)
                dump_node_edge_hook(F, n);
#if DO_HEAPANALYSIS
        dump_irn_chi_term(F, n);
        dump_irn_state(F, n);
#endif
}

/** dump the edge to the block this node belongs to */
static void
dump_ir_block_edge(FILE *F, ir_node *n)  {
        if (get_opt_dump_const_local() && is_constlike_node(n)) return;
        if (is_no_Block(n)) {
                ir_node *block = get_nodes_block(n);

                if (get_opt_dump_const_local() && is_constlike_node(block)) {
                        dump_const_block_local(F, n);
                } else {
                        fprintf(F, "edge: { sourcename: \"");
                        PRINT_NODEID(n);
                        fprintf(F, "\" targetname: ");
                        fprintf(F, "\""); PRINT_NODEID(block); fprintf(F, "\"");

                        if (dump_edge_vcgattr_hook) {
                                fprintf(F, " ");
                                if (dump_edge_vcgattr_hook(F, n, -1)) {
                                        fprintf(F, "}\n");
                                        return;
                                } else {
                                        fprintf(F, " "  BLOCK_EDGE_ATTR "}\n");
                                        return;
                                }
                        }

                        fprintf(F, " "   BLOCK_EDGE_ATTR "}\n");
                }
        }
}

static void
print_data_edge_vcgattr(FILE *F, ir_node *from, int to) {
        /*
         * do not use get_nodes_block() here, will fail
         * if the irg is not pinned.
         */
        if (get_irn_n(from, -1) == get_irn_n(get_irn_n(from, to), -1))
                fprintf(F, INTRA_DATA_EDGE_ATTR);
        else
                fprintf(F, INTER_DATA_EDGE_ATTR);
}

static void
print_mem_edge_vcgattr(FILE *F, ir_node *from, int to) {
        /*
         * do not use get_nodes_block() here, will fail
         * if the irg is not pinned.
         */
        if (get_irn_n(from, -1) == get_irn_n(get_irn_n(from, to), -1))
                fprintf(F, INTRA_MEM_EDGE_ATTR);
        else
                fprintf(F, INTER_MEM_EDGE_ATTR);
}

/** Print the vcg attributes for the edge from node from to it's to's input */
static void print_edge_vcgattr(FILE *F, ir_node *from, int to) {
        assert(from);

        if (dump_edge_vcgattr_hook)
                if (dump_edge_vcgattr_hook(F, from, to))
                        return;

        if (dump_backedge_information_flag && is_backedge(from, to))
                fprintf(F, BACK_EDGE_ATTR);

        switch (get_irn_opcode(from)) {
        case iro_Block:
                fprintf(F, CF_EDGE_ATTR);
                break;
        case iro_Start:  break;
        case iro_End:
                if (to >= 0) {
                        if (get_irn_mode(get_End_keepalive(from, to)) == mode_BB)
                                fprintf(F, KEEP_ALIVE_CF_EDGE_ATTR);
                        else
                                fprintf(F, KEEP_ALIVE_DF_EDGE_ATTR);
                }
                break;
        default:
                if (is_Proj(from)) {
                        if (get_irn_mode(from) == mode_M)
                                print_mem_edge_vcgattr(F, from, to);
                        else if (get_irn_mode(from) == mode_X)
                                fprintf(F, CF_EDGE_ATTR);
                        else
                                print_data_edge_vcgattr(F, from, to);
                }
                else if (get_irn_mode(get_irn_n(from, to)) == mode_M)
                        print_mem_edge_vcgattr(F, from, to);
                else if (get_irn_mode(get_irn_n(from, to)) == mode_X)
                        fprintf(F, CF_EDGE_ATTR);
                else
                        print_data_edge_vcgattr(F, from, to);
        }
}

/** dump edges to our inputs */
static void dump_ir_data_edges(FILE *F, ir_node *n)  {
        int i;
        unsigned long visited = get_irn_visited(n);

        if ((get_irn_op(n) == op_End) && (!dump_keepalive))
                return;

        /* dump the dependency edges. */
        for (i = 0; i < get_irn_deps(n); ++i) {
                ir_node *dep = get_irn_dep(n, i);

                if(dep) {
                        fprintf(F, "edge: {sourcename: \"");
                        PRINT_NODEID(n);
                        fprintf(F, "\" targetname: ");
                        if ((get_opt_dump_const_local()) && is_constlike_node(dep)) {
                                PRINT_CONSTID(n, dep);
                        } else {
                                fprintf(F, "\"");
                                PRINT_NODEID(dep);
                                fprintf(F, "\"");
                        }
                        fprintf(F, " label: \"%d\" ", i);
                        fprintf(F, " color: darkgreen}\n");
                }
        }

        for (i = 0; i < get_irn_arity(n); i++) {
                ir_node * pred = get_irn_n(n, i);
                assert(pred);

                if ((get_interprocedural_view() && get_irn_visited(pred) < visited))
                        continue; /* pred not dumped */

                if (dump_backedge_information_flag && is_backedge(n, i))
                        fprintf(F, "backedge: {sourcename: \"");
                else
                        fprintf(F, "edge: {sourcename: \"");
                PRINT_NODEID(n);
                fprintf(F, "\" targetname: ");
                if ((get_opt_dump_const_local()) && is_constlike_node(pred)) {
                        PRINT_CONSTID(n, pred);
                } else {
                        fprintf(F, "\""); PRINT_NODEID(pred); fprintf(F, "\"");
                }
                fprintf(F, " label: \"%d\" ", i);
                print_edge_vcgattr(F, n, i);
                fprintf(F, "}\n");
        }
}

/** Dumps a node and its edges but not the block edge
 */
static INLINE void
dump_node_wo_blockedge(ir_node *n, void *env) {
        FILE *F = env;
        dump_node(F, n);
        dump_ir_data_edges(F, n);
}

/** Dumps a node and its edges.
 */
static void
dump_whole_node(ir_node *n, void *env) {
        FILE *F = env;
        dump_node_wo_blockedge(n, env);
        if (!node_floats(n)) dump_ir_block_edge(F, n);
}

static void
dump_const_node(ir_node *n, void *env) {
        if (is_Block(n)) return;
        dump_node_wo_blockedge(n, env);
}

/***********************************************************************/
/* the following routines dump the nodes/irgs bracketed to graphs.     */
/***********************************************************************/

/** Dumps a constant expression as entity initializer, array bound ...
 */
static void dump_const_expression(FILE *F, ir_node *value) {
        ir_graph *rem = current_ir_graph;
        int rem_dump_const_local = dump_const_local;
        dump_const_local = 0;
        current_ir_graph = get_const_code_irg();
        irg_walk(value, dump_const_node, NULL, F);
        /* Decrease visited flag so that we walk with the same flag for the next
           expression.  This guarantees that we don't dump the same node twice,
           as for const expressions cse is performed to save memory. */
        set_irg_visited(current_ir_graph, get_irg_visited(current_ir_graph) -1);
        current_ir_graph = rem;
        dump_const_local = rem_dump_const_local;
}

/** Dump a block as graph containing its nodes.
 *
 *  Expects to find nodes belonging to the block as list in its
 *  link field.
 *  Dumps the edges of all nodes including itself. */
static void
dump_whole_block(FILE *F, ir_node *block) {
        ir_node *node;
        dumper_colors color = ird_color_yellow;

        assert(is_Block(block));

        fprintf(F, "graph: { title: \"");
        PRINT_NODEID(block);
        fprintf(F, "\"  label: \"");
        dump_node_label(F, block);
#if DO_HEAPANALYSIS
        if (get_opt_dump_abstvals())
                fprintf(F, " seqno: %d", (int)get_Block_seqno(block));
#endif

        /* colorize blocks */
        if (! get_Block_matured(block))
                color = ird_color_red;
        if (is_Block_dead(block))
                color = ird_color_orange;

        fprintf(F, "\" status:clustered ");
        print_vcg_color(F, color);
        fprintf(F, "\n");

        /* yComp can show attributes for blocks, XVCG parses but ignores them */
        dump_node_info(F, block);
        print_dbg_info(F, get_irn_dbg_info(block));

        /* dump the blocks edges */
        dump_ir_data_edges(F, block);

        if (dump_block_edge_hook)
                dump_block_edge_hook(F, block);

        /* dump the nodes that go into the block */
        for (node = ird_get_irn_link(block); node; node = ird_get_irn_link(node)) {
                dump_node(F, node);
                dump_ir_data_edges(F, node);
        }

        /* Close the vcg information for the block */
        fprintf(F, "}\n");
        dump_const_node_local(F, block);
#if DO_HEAPANALYSIS
        dump_irn_chi_term(F, block);
#endif
        fprintf(F, "\n");
}

/** dumps a graph block-wise. Expects all blockless nodes in arr in irgs link.
 *  The outermost nodes: blocks and nodes not op_pin_state_pinned, Bad, Unknown. */
static void
dump_block_graph(FILE *F, ir_graph *irg) {
        int i;
        ir_graph *rem = current_ir_graph;
        ir_node **arr = ird_get_irg_link(irg);
        current_ir_graph = irg;

        for (i = ARR_LEN(arr) - 1; i >= 0; --i) {
                ir_node * node = arr[i];
                if (is_Block(node)) {
                /* Dumps the block and all the nodes in the block, which are to
                        be found in Block->link. */
                        dump_whole_block(F, node);
                } else {
                        /* Nodes that are not in a Block. */
                        dump_node(F, node);
                        if (!node_floats(node) && is_Bad(get_nodes_block(node))) {
                                dump_const_block_local(F, node);
                        }
                        dump_ir_data_edges(F, node);
                }
        }

        if (dump_loop_information_flag && (get_irg_loopinfo_state(irg) & loopinfo_valid))
                dump_loop_nodes_into_graph(F, irg);

        current_ir_graph = rem;
}

/**
 * Dump the info for an irg.
 * Parsed by XVCG but not shown. use yComp.
 */
static void dump_graph_info(FILE *F, ir_graph *irg) {
        fprintf(F, "info1: \"");
        dump_entity_to_file(F, get_irg_entity(irg), dump_verbosity_entattrs | dump_verbosity_entconsts);
        fprintf(F, "\"\n");
}

/** Dumps an irg as a graph clustered by block nodes.
 *  If interprocedural view edges can point to nodes out of this graph.
 */
static void dump_graph_from_list(FILE *F, ir_graph *irg) {
        ir_entity *ent = get_irg_entity(irg);

        fprintf(F, "graph: { title: \"");
        PRINT_IRGID(irg);
        fprintf(F, "\" label: \"%s\" status:clustered color:white \n",
          get_ent_dump_name(ent));

        dump_graph_info(F, irg);
        print_dbg_info(F, get_entity_dbg_info(ent));

        dump_block_graph(F, irg);

        /* Close the vcg information for the irg */
        fprintf(F, "}\n\n");
}

/** dumps a graph extended block-wise. Expects all blockless nodes in arr in irgs link.
 *  The outermost nodes: blocks and nodes not op_pin_state_pinned, Bad, Unknown. */
static void
dump_extblock_graph(FILE *F, ir_graph *irg) {
        int i;
        ir_graph *rem = current_ir_graph;
        ir_extblk **arr = ird_get_irg_link(irg);
        current_ir_graph = irg;

        for (i = ARR_LEN(arr) - 1; i >= 0; --i) {
                ir_extblk *extbb = arr[i];
                ir_node *leader = get_extbb_leader(extbb);
                int j;

                fprintf(F, "graph: { title: \"");
                PRINT_EXTBBID(leader);
                fprintf(F, "\"  label: \"ExtBB %ld\" status:clustered color:lightgreen\n",
                        get_irn_node_nr(leader));

                for (j = ARR_LEN(extbb->blks) - 1; j >= 0; --j) {
                        ir_node * node = extbb->blks[j];
                        if (is_Block(node)) {
                        /* Dumps the block and all the nodes in the block, which are to
                                be found in Block->link. */
                                dump_whole_block(F, node);
                        } else {
                                /* Nodes that are not in a Block. */
                                dump_node(F, node);
                                if (is_Bad(get_nodes_block(node)) && !node_floats(node)) {
                                        dump_const_block_local(F, node);
                                }
                                dump_ir_data_edges(F, node);
                        }
                }
                fprintf(F, "}\n");
        }

        if (dump_loop_information_flag && (get_irg_loopinfo_state(irg) & loopinfo_valid))
                dump_loop_nodes_into_graph(F, irg);

        current_ir_graph = rem;
        free_extbb(irg);
}


/*******************************************************************/
/* Basic type and entity nodes and edges.                          */
/*******************************************************************/

/** dumps the edges between nodes and their type or entity attributes. */
static void dump_node2type_edges(ir_node *n, void *env)
{
        FILE *F = env;
        assert(n);

        switch (get_irn_opcode(n)) {
        case iro_Const :
                /* @@@ some consts have an entity */
                break;
        case iro_SymConst:
                if (SYMCONST_HAS_TYPE(get_SymConst_kind(n)))
                        print_node_type_edge(F,n,get_SymConst_type(n),NODE2TYPE_EDGE_ATTR);
                break;
        case iro_Sel:
                print_node_ent_edge(F,n,get_Sel_entity(n),NODE2TYPE_EDGE_ATTR);
                break;
        case iro_Call:
                print_node_type_edge(F,n,get_Call_type(n),NODE2TYPE_EDGE_ATTR);
                break;
        case iro_Alloc:
                print_node_type_edge(F,n,get_Alloc_type(n),NODE2TYPE_EDGE_ATTR);
                break;
        case iro_Free:
                print_node_type_edge(F,n,get_Free_type(n),NODE2TYPE_EDGE_ATTR);
                break;
        case iro_Cast:
                print_node_type_edge(F,n,get_Cast_type(n),NODE2TYPE_EDGE_ATTR);
                break;
        default:
                break;
        }
}

#if 0
static int print_type_info(FILE *F, ir_type *tp) {
        int bad = 0;

        if (get_type_state(tp) == layout_undefined) {
                fprintf(F, "state: layout_undefined\n");
        } else {
                fprintf(F, "state: layout_fixed,\n");
        }
        if (get_type_mode(tp))
                fprintf(F, "mode: %s,\n", get_mode_name_ex(get_type_mode(tp), &bad));
        fprintf(F, "size: %db,\n", get_type_size_bits(tp));

        return bad;
}

static void print_typespecific_info(FILE *F, ir_type *tp) {
        switch (get_type_tpop_code(tp)) {
        case tpo_class:
                fprintf(F, "peculiarity: %s\n", get_peculiarity_string(get_class_peculiarity(tp)));
                break;
        case tpo_struct:
                break;
        case tpo_method:
                fprintf(F, "variadicity: %s\n", get_variadicity_name(get_method_variadicity(tp)));
                fprintf(F, "params: %d\n", get_method_n_params(tp));
                fprintf(F, "results: %d\n", get_method_n_ress(tp));
                break;
        case tpo_union:
                break;
        case tpo_array:
                break;
        case tpo_enumeration:
                break;
        case tpo_pointer:
                break;
        case tpo_primitive:
                break;
        default:
                break;
        } /* switch type */
}
#endif

static void print_typespecific_vcgattr(FILE *F, ir_type *tp) {
        switch (get_type_tpop_code(tp)) {
        case tpo_class:
                if (peculiarity_existent == get_class_peculiarity(tp))
                        fprintf(F, " " TYPE_CLASS_NODE_ATTR);
                else
                        fprintf(F, " " TYPE_DESCRIPTION_NODE_ATTR);
                break;
        case tpo_struct:
                fprintf(F, " " TYPE_METH_NODE_ATTR);
                break;
        case tpo_method:
                break;
        case tpo_union:
                break;
        case tpo_array:
                break;
        case tpo_enumeration:
                break;
        case tpo_pointer:
                break;
        case tpo_primitive:
                break;
        default:
                break;
        } /* switch type */
}


int dump_type_node(FILE *F, ir_type *tp)
{
        int bad = 0;

        fprintf(F, "node: {title: ");
        PRINT_TYPEID(tp);
        fprintf(F, " label: \"%s %s\"", get_type_tpop_name(tp), get_type_name_ex(tp, &bad));
        fprintf(F, " info1: \"");
#if 0
        bad |= print_type_info(F, tp);
        print_typespecific_info(F, tp);
#else
        dump_type_to_file(F, tp, dump_verbosity_max);
#endif
        fprintf(F, "\"\n");
        print_dbg_info(F, get_type_dbg_info(tp));
        print_typespecific_vcgattr(F, tp);
        fprintf(F, "}\n");

        return bad;
}


void dump_entity_node(FILE *F, ir_entity *ent, int color)
{
        fprintf(F, "node: {title: \"");
        PRINT_ENTID(ent); fprintf(F, "\"");
        fprintf(F, DEFAULT_TYPE_ATTRIBUTE);
        fprintf(F, "label: ");
        fprintf(F, "\"ent %s\" ", get_ent_dump_name(ent));
        if (color)
                fprintf(F, "color:%d", color);
        else
                fprintf(F, ENTITY_NODE_ATTR);
        fprintf(F, "\n info1: \"");

        dump_entity_to_file(F, ent, dump_verbosity_entattrs | dump_verbosity_entconsts);

        fprintf(F, "\"\n");
        print_dbg_info(F, get_entity_dbg_info(ent));
        fprintf(F, "}\n");
}

static void dump_enum_item(FILE *F, ir_type *tp, int pos)
{
        char buf[1024];
        ir_enum_const *ec = get_enumeration_const(tp, pos);
        ident         *id = get_enumeration_nameid(ec);
        tarval        *tv = get_enumeration_value(ec);

        if (tv)
                tarval_snprintf(buf, sizeof(buf), tv);
        else
                strncpy(buf, "<not set>", sizeof(buf));
        fprintf(F, "node: {title: \"");
        PRINT_ITEMID(tp, pos); fprintf(F, "\"");
        fprintf(F, DEFAULT_ENUM_ITEM_ATTRIBUTE);
        fprintf(F, "label: ");
        fprintf(F, "\"enum item %s\" " ENUM_ITEM_NODE_ATTR, get_id_str(id));
        fprintf(F, "\n info1: \"value: %s\"}\n", buf);
}

/* dumps a type or entity and it's edges. */
static void
dump_type_info(type_or_ent *tore, void *env) {
        FILE *F = env;
        int i = 0;  /* to shutup gcc */

        /* dump this type or entity */

        switch (get_kind(tore)) {
        case k_entity: {
                ir_entity *ent = (ir_entity *)tore;
                ir_node *value;
                /* The node */
                dump_entity_node(F, ent, 0);
                /* The Edges */
                /* skip this to reduce graph.  Member edge of type is parallel to this edge. *
                fprintf(F, "edge: { sourcename: \"%p\" targetname: \"%p\" "
                ENT_OWN_EDGE_ATTR "}\n", ent, get_entity_owner(ent));*/
                print_ent_type_edge(F,ent, get_entity_type(ent), ENT_TYPE_EDGE_ATTR);
                if (is_Class_type(get_entity_owner(ent))) {
                        for(i = 0; i < get_entity_n_overwrites(ent); i++)
                                print_ent_ent_edge(F,ent, get_entity_overwrites(ent, i), 0, ENT_OVERWRITES_EDGE_ATTR);
                }
                /* attached subgraphs */
                if (const_entities && (get_entity_variability(ent) != variability_uninitialized)) {
                        if (is_atomic_entity(ent)) {
                                value = get_atomic_ent_value(ent);
                                if (value) {
                                        print_ent_node_edge(F, ent, value, ENT_VALUE_EDGE_ATTR, i);
                                        /* DDMN(value);  $$$ */
                                        dump_const_expression(F, value);
                                }
                        }
                        if (is_compound_entity(ent)) {
                                for (i = 0; i < get_compound_ent_n_values(ent); i++) {
                                        value = get_compound_ent_value(ent, i);
                                        if (value) {
                                                print_ent_node_edge(F, ent, value, ENT_VALUE_EDGE_ATTR, i);
                                                dump_const_expression(F, value);
                                                print_ent_ent_edge(F, ent, get_compound_ent_value_member(ent, i), 0, ENT_CORR_EDGE_ATTR, i);
                                                /*
                                                fprintf(F, "edge: { sourcename: \"%p\" targetname: \"%p\" "
                                                ENT_CORR_EDGE_ATTR  "}\n", GET_ENTID(ent),
                                                get_compound_ent_value_member(ent, i), i);
                                                */
                                        }
                                }
                        }
                }
                break;
        }
        case k_type: {
                ir_type *tp = (ir_type *)tore;
                dump_type_node(F, tp);
                /* and now the edges */
                switch (get_type_tpop_code(tp)) {
                case tpo_class:
                        for (i=0; i < get_class_n_supertypes(tp); i++)
                                print_type_type_edge(F, tp,get_class_supertype(tp, i),TYPE_SUPER_EDGE_ATTR);
                        for (i=0; i < get_class_n_members(tp); i++)
                                print_type_ent_edge(F,tp,get_class_member(tp, i),TYPE_MEMBER_EDGE_ATTR);
                        break;
                case tpo_struct:
                        for (i=0; i < get_struct_n_members(tp); i++)
                                print_type_ent_edge(F,tp,get_struct_member(tp, i),TYPE_MEMBER_EDGE_ATTR);
                        break;
                case tpo_method:
                        for (i = 0; i < get_method_n_params(tp); i++)
                                print_type_type_edge(F,tp,get_method_param_type(tp, i),METH_PAR_EDGE_ATTR,i);
                        for (i = 0; i < get_method_n_ress(tp); i++)
                                print_type_type_edge(F,tp,get_method_res_type(tp, i),METH_RES_EDGE_ATTR,i);
                        break;
                case tpo_union:
                        for (i = 0; i < get_union_n_members(tp); i++)
                                print_type_ent_edge(F,tp,get_union_member(tp, i),UNION_EDGE_ATTR);
                        break;
                case tpo_array:
                        print_type_type_edge(F,tp,get_array_element_type(tp),ARR_ELT_TYPE_EDGE_ATTR);
                        print_type_ent_edge(F,tp,get_array_element_entity(tp),ARR_ENT_EDGE_ATTR);
                        for (i = 0; i < get_array_n_dimensions(tp); i++) {
                                ir_node *upper = get_array_upper_bound(tp, i);
                                ir_node *lower = get_array_lower_bound(tp, i);
                                print_node_type_edge(F, upper, tp, "label: \"upper %d\"", get_array_order(tp, i));
                                print_node_type_edge(F, lower, tp, "label: \"lower %d\"", get_array_order(tp, i));
                                dump_const_expression(F, upper);
                                dump_const_expression(F, lower);
                        }
                        break;
                case tpo_enumeration:
                        for (i = 0; i < get_enumeration_n_enums(tp); ++i) {
                                dump_enum_item(F, tp, i);
                                print_enum_item_edge(F, tp, i, "label: \"item %d\"", i);
                        }
                        break;
                case tpo_pointer:
                        print_type_type_edge(F,tp,get_pointer_points_to_type(tp), PTR_PTS_TO_EDGE_ATTR);
                        break;
                case tpo_primitive:
                        break;
                default:
                        break;
                } /* switch type */
                break; /* case k_type */
        }
        default:
                printf(" *** irdump,  dump_type_info(l.%i), faulty type.\n", __LINE__);
        } /* switch kind_or_entity */
}

typedef struct _h_env {
        int dump_ent;
        FILE *f;
} h_env_t;

/** For dumping class hierarchies.
 * Dumps a class type node and a superclass edge.
 * If env->dump_ent dumps entities of classes and overwrites edges.
 */
static void
dump_class_hierarchy_node(type_or_ent *tore, void *ctx) {
        h_env_t *env = ctx;
        FILE *F = env->f;
        int i = 0;  /* to shutup gcc */

        /* dump this type or entity */
        switch (get_kind(tore)) {
        case k_entity: {
                ir_entity *ent = (ir_entity *)tore;
                if (get_entity_owner(ent) == get_glob_type()) break;
                if (!is_Method_type(get_entity_type(ent))) break;  /* GL */
                if (env->dump_ent && is_Class_type(get_entity_owner(ent))) {
                        /* The node */
                        dump_entity_node(F, ent, 0);
                        /* The edges */
                        print_type_ent_edge(F,get_entity_owner(ent),ent,TYPE_MEMBER_EDGE_ATTR);
                        for(i = 0; i < get_entity_n_overwrites(ent); i++)
                                print_ent_ent_edge(F, get_entity_overwrites(ent, i), ent, 0, ENT_OVERWRITES_EDGE_ATTR);
                }
                break;
        }
        case k_type: {
                ir_type *tp = (ir_type *)tore;
                if (tp == get_glob_type()) break;
                switch (get_type_tpop_code(tp)) {
                case tpo_class:
                        dump_type_node(F, tp);
                        /* and now the edges */
                        for (i=0; i < get_class_n_supertypes(tp); i++) {
                                print_type_type_edge(F,tp,get_class_supertype(tp, i),TYPE_SUPER_EDGE_ATTR);
                        }
                        break;
                default: break;
                } /* switch type */
                break; /* case k_type */
        }
        default:
                printf(" *** irdump,  dump_class_hierarchy_node(l.%i), faulty type.\n", __LINE__);
        } /* switch kind_or_entity */
}

/*******************************************************************/
/* dump analysis information that is expressed in graph terms.     */
/*******************************************************************/

/* dump out edges */
static void
dump_out_edge(ir_node *n, void *env) {
        FILE *F = env;
        int i;
        for (i = 0; i < get_irn_n_outs(n); i++) {
                assert(get_irn_out(n, i));
                fprintf(F, "edge: {sourcename: \"");
                PRINT_NODEID(n);
                fprintf(F, "\" targetname: \"");
                PRINT_NODEID(get_irn_out(n, i));
                fprintf(F, "\" color: red linestyle: dashed");
                fprintf(F, "}\n");
        }
}

static INLINE void
dump_loop_label(FILE *F, ir_loop *loop) {
        fprintf(F, "loop %d, %d sons, %d nodes",
                get_loop_depth(loop), get_loop_n_sons(loop), get_loop_n_nodes(loop));
}

static INLINE void dump_loop_info(FILE *F, ir_loop *loop) {
        fprintf(F, " info1: \"");
        fprintf(F, " loop nr: %d", get_loop_loop_nr(loop));
#ifdef DEBUG_libfirm   /* GL @@@ debug analyses */
        fprintf(F, "\n The loop was analyzed %d times.", PTR_TO_INT(get_loop_link(loop)));
#endif
        fprintf(F, "\"");
}

static INLINE void
dump_loop_node(FILE *F, ir_loop *loop) {
        fprintf(F, "node: {title: \"");
        PRINT_LOOPID(loop);
        fprintf(F, "\" label: \"");
        dump_loop_label(F, loop);
        fprintf(F, "\" ");
        dump_loop_info(F, loop);
        fprintf(F, "}\n");
}

static INLINE void
dump_loop_node_edge(FILE *F, ir_loop *loop, int i) {
        assert(loop);
        fprintf(F, "edge: {sourcename: \"");
        PRINT_LOOPID(loop);
        fprintf(F, "\" targetname: \"");
        PRINT_NODEID(get_loop_node(loop, i));
        fprintf(F, "\" color: green");
        fprintf(F, "}\n");
}

static INLINE void
dump_loop_son_edge(FILE *F, ir_loop *loop, int i) {
        assert(loop);
        fprintf(F, "edge: {sourcename: \"");
        PRINT_LOOPID(loop);
        fprintf(F, "\" targetname: \"");
        PRINT_LOOPID(get_loop_son(loop, i));
        fprintf(F, "\" color: darkgreen label: \"%d\"}\n",
                get_loop_element_pos(loop, get_loop_son(loop, i)));
}

static
void dump_loops(FILE *F, ir_loop *loop) {
        int i;
        /* dump this loop node */
        dump_loop_node(F, loop);

        /* dump edges to nodes in loop -- only if it is a real loop */
        if (get_loop_depth(loop) != 0) {
                for (i = 0; i < get_loop_n_nodes(loop); i++) {
                        dump_loop_node_edge(F, loop, i);
                }
        }
        for (i = 0; i < get_loop_n_sons(loop); i++) {
                dump_loops(F, get_loop_son(loop, i));
                dump_loop_son_edge(F, loop, i);
        }
}

static INLINE
void dump_loop_nodes_into_graph(FILE *F, ir_graph *irg) {
        ir_graph *rem = current_ir_graph;
        current_ir_graph = irg;

        if (get_irg_loop(irg)) dump_loops(F, get_irg_loop(irg));

        current_ir_graph = rem;
}


/**
 * dumps the VCG header
 */
void dump_vcg_header(FILE *F, const char *name, const char *orientation) {
        char *label;

        if (edge_label) {
                label = "yes";
        } else {
                label = "no";
        }

        if (!orientation) orientation = "bottom_to_top";

        /* print header */
        fprintf(F,
                "graph: { title: \"ir graph of %s\"\n"
                "display_edge_labels: %s\n"
                "layoutalgorithm: mindepth\n"
                "manhattan_edges: yes\n"
                "port_sharing: no\n"
                "orientation: %s\n"
                "classname 1:  \"intrablock Data\"\n"
                "classname 2:  \"Block\"\n"
                "classname 3:  \"Entity type\"\n"
                "classname 4:  \"Entity owner\"\n"
                "classname 5:  \"Method Param\"\n"
                "classname 6:  \"Method Res\"\n"
                "classname 7:  \"Super\"\n"
                "classname 8:  \"Union\"\n"
                "classname 9:  \"Points-to\"\n"
                "classname 10: \"Array Element Type\"\n"
                "classname 11: \"Overwrites\"\n"
                "classname 12: \"Member\"\n"
                "classname 13: \"Control Flow\"\n"
                "classname 14: \"intrablock Memory\"\n"
                "classname 15: \"Dominators\"\n"
                "classname 16: \"interblock Data\"\n"
                "classname 17: \"interblock Memory\"\n"
                "classname 18: \"Exception Control Flow for Interval Analysis\"\n"
                "classname 19: \"Postdominators\"\n"
                "classname 20: \"Keep Alive\"\n"
                "infoname 1: \"Attribute\"\n"
                "infoname 2: \"Verification errors\"\n"
                "infoname 3: \"Debug info\"\n",
                name, label, orientation);

        /* don't use all, the range is too whith/black. */
        n_colors   = 18;
        base_color = 105;
        fprintf(F,
                "colorentry 100:    0   0    0\n"
                "colorentry 101:   20   0    0\n"
                "colorentry 102:   40   0    0\n"
                "colorentry 103:   60   0    0\n"
                "colorentry 104:   80   0    0\n"
                "colorentry 105:  100   0    0\n"
                "colorentry 106:  120   0    0\n"
                "colorentry 107:  140   0    0\n"
                "colorentry 108:  150   0    0\n"
                "colorentry 109:  180   0    0\n"
                "colorentry 110:  200   0    0\n"
                "colorentry 111:  220   0    0\n"
                "colorentry 112:  240   0    0\n"
                "colorentry 113:  255   0    0\n"
                "colorentry 113:  255  20   20\n"
                "colorentry 114:  255  40   40\n"
                "colorentry 115:  255  60   60\n"
                "colorentry 116:  255  80   80\n"
                "colorentry 117:  255 100  100\n"
                "colorentry 118:  255 120  120\n"
                "colorentry 119:  255 140  140\n"
                "colorentry 120:  255 150  150\n"
                "colorentry 121:  255 180  180\n"
                "colorentry 122:  255 200  200\n"
                "colorentry 123:  255 220  220\n"
                "colorentry 124:  255 240  240\n"
                "colorentry 125:  255 250  250\n"
                );

        fprintf(F, "\n");        /* a separator */
}

/**
 * open a vcg file
 *
 * @param irg     The graph to be dumped
 * @param suffix1 first filename suffix
 * @param suffix2 second filename suffix
 */
FILE *vcg_open(ir_graph *irg, const char * suffix1, const char *suffix2) {
        FILE *F;
        const char *nm = get_irg_dump_name(irg);
        int len = strlen(nm), i, j;
        char *fname;  /* filename to put the vcg information in */

        if (!suffix1) suffix1 = "";
        if (!suffix2) suffix2 = "";

        /* open file for vcg graph */
        fname = xmalloc (len * 2 + strlen(suffix1) + strlen(suffix2) + 5);

        /* strncpy (fname, nm, len); */     /* copy the filename */
        j = 0;
        for (i = 0; i < len; ++i) {  /* replace '/' in the name: escape by @. */
                if (nm[i] == '/') {
                        fname[j] = '@'; j++; fname[j] = '1'; j++;
                } else if (nm[i] == '@') {
                        fname[j] = '@'; j++; fname[j] = '2'; j++;
                } else {
                        fname[j] = nm[i]; j++;
                }
        }
        fname[j] = '\0';
        strcat(fname, suffix1);  /* append file suffix */
        strcat(fname, suffix2);  /* append file suffix */
        strcat(fname, ".vcg");   /* append the .vcg suffix */

        /* vcg really expect only a <CR> at end of line, so
         * the "b"inary mode is what you mean (and even needed for Win32)
         */
        F = fopen(fname, "wb");  /* open file for writing */
        if (!F) {
                perror(fname);
        }
        free(fname);

        return F;
}

/**
 * open a vcg file
 *
 * @param name    prefix file name
 * @param suffix  filename suffix
 */
FILE *vcg_open_name(const char *name, const char *suffix) {
        FILE *F;
        char *fname;  /* filename to put the vcg information in */
        int i, j, len = strlen(name);

        if (!suffix) suffix = "";

        /** open file for vcg graph */
        fname = xmalloc(len * 2 + 5 + strlen(suffix));
        /* strcpy (fname, name);*/    /* copy the filename */
        j = 0;
        for (i = 0; i < len; ++i) {  /* replace '/' in the name: escape by @. */
                if (name[i] == '/') {
                        fname[j] = '@'; j++; fname[j] = '1'; j++;
                } else if (name[i] == '@') {
                        fname[j] = '@'; j++; fname[j] = '2'; j++;
                } else {
                        fname[j] = name[i]; j++;
                }
        }
        fname[j] = '\0';
        strcat(fname, suffix);
        strcat(fname, ".vcg");  /* append the .vcg suffix */

        /* vcg really expect only a <CR> at end of line, so
         * the "b"inary mode is what you mean (and even needed for Win32)
         */
        F = fopen(fname, "wb");  /* open file for writing */
        if (!F) {
                perror(fname);
        }
        free(fname);

        return F;
}

/**
 * Dumps the vcg file footer
 */
static void dump_vcg_footer(FILE *F) {
        fprintf(F, "}\n");
}

/**
 * close the vcg file
 */
void vcg_close(FILE *F) {
        dump_vcg_footer(F);    /* print footer */
        fclose (F);           /* close vcg file */
}

/************************************************************************/
/************************************************************************/
/* Routines that dump all or parts of the firm representation to a file */
/************************************************************************/
/************************************************************************/

/************************************************************************/
/* Dump ir graphs, different formats and additional information.        */
/************************************************************************/

/** Routine to dump a graph, blocks as conventional nodes.  */
void
dump_ir_graph(ir_graph *irg, const char *suffix )
{
        FILE *f;
        ir_graph *rem;
        char *suffix1;

        if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg))))
                return;

        if (dump_backedge_information_flag && get_irg_loopinfo_state(irg) != loopinfo_consistent) {
                construct_backedges(irg);
        }

        rem = current_ir_graph;
        current_ir_graph = irg;
        if (get_interprocedural_view()) suffix1 = "-pure-ip";
        else                            suffix1 = "-pure";
        f = vcg_open(irg, suffix, suffix1);
        if (f != NULL) {
                dump_vcg_header(f, get_irg_dump_name(irg), NULL);

                /* call the dump graph hook */
                if (dump_ir_graph_hook)
                        if (dump_ir_graph_hook(f, irg)) {
                                current_ir_graph = rem;
                                return;
                        }

                        /* walk over the graph */
                        /* dump_whole_node must be called in post visiting predecessors */
                        ird_walk_graph(irg, NULL, dump_whole_node, f);

                        /* dump the out edges in a separate walk */
                        if ((dump_out_edge_flag) && (get_irg_outs_state(irg) != outs_none)) {
                                irg_out_walk(get_irg_start(irg), dump_out_edge, NULL, f);
                        }

                        vcg_close(f);
        }
        current_ir_graph = rem;
}

/* Dump a firm graph without explicit block nodes. */
void dump_ir_block_graph(ir_graph *irg, const char *suffix)
{
        FILE *f;
        int i;
        char *suffix1;

        if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg))))
                return;

        if (get_interprocedural_view()) suffix1 = "-ip";
        else                            suffix1 = "";
        f = vcg_open(irg, suffix, suffix1);

        if (f != NULL) {
                dump_vcg_header(f, get_irg_dump_name(irg), NULL);

                construct_block_lists(irg);

                /*
                 * If we are in the interprocedural view, we dump not
                 * only the requested irg but also all irgs that can be reached
                 * from irg.
                 */
                for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
                        ir_node **arr = ird_get_irg_link(get_irp_irg(i));
                        if (arr) {
                                dump_graph_from_list(f, get_irp_irg(i));
                                DEL_ARR_F(arr);
                        }
                }

                vcg_close(f);
        }
}

/* Dump a firm graph without explicit block nodes but grouped in extended blocks. */
void dump_ir_extblock_graph(ir_graph *irg, const char *suffix)
{
        FILE *F;
        int i;
        char *suffix1;
        ir_entity *ent;

        if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg))))
                return;

        if (get_irg_extblk_state(irg) != extblk_valid)
                compute_extbb(irg);

        if (get_interprocedural_view()) suffix1 = "-ip";
        else                            suffix1 = "";

        ent = get_irg_entity(irg);

        F = vcg_open(irg, suffix, suffix1);
        if (F != NULL) {
                dump_vcg_header(F, get_irg_dump_name(irg), NULL);

                construct_extblock_lists(irg);

                fprintf(F, "graph: { title: \"");
                PRINT_IRGID(irg);
                fprintf(F, "\" label: \"%s\" status:clustered color: white \n",
                        get_ent_dump_name(ent));

                dump_graph_info(F, irg);
                print_dbg_info(F, get_entity_dbg_info(ent));

                for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
                        ir_graph *irg     = get_irp_irg(i);
                        list_tuple *lists = ird_get_irg_link(irg);

                        if (lists) {
                                /* dump the extended blocks first */
                                if (ARR_LEN(lists->extbb_list)) {
                                        ird_set_irg_link(irg, lists->extbb_list);
                                        dump_extblock_graph(F, irg);
                                }

                                /* we may have blocks without extended blocks, bad for instance */
                                if (ARR_LEN(lists->blk_list)) {
                                        ird_set_irg_link(irg, lists->blk_list);
                                        dump_block_graph(F, irg);
                                }

                                DEL_ARR_F(lists->extbb_list);
                                DEL_ARR_F(lists->blk_list);
                                xfree(lists);
                        }
                }

                /* Close the vcg information for the irg */
                fprintf(F, "}\n\n");

                vcg_close(F);
                free_extbb(irg);
        }
}

/* dumps a graph with type information */
void
dump_ir_graph_w_types(ir_graph *irg, const char *suffix)
{
        FILE *f;
        char *suffix1;

        /* if a filter is set, dump only the irg's that match the filter */
        if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg))))
                return;

        if (get_interprocedural_view()) suffix1 = "-pure-wtypes-ip";
        else                            suffix1 = "-pure-wtypes";
        f = vcg_open(irg,suffix, suffix1);
        if (f != NULL) {
                ir_graph *rem = current_ir_graph;
                int rem_dump_const_local;

                current_ir_graph = irg;
                rem_dump_const_local = dump_const_local;
                /* dumping types does not work with local nodes */
                dump_const_local = 0;

                dump_vcg_header(f, get_irg_dump_name(irg), NULL);

                /* dump common ir graph */
                irg_walk(get_irg_end(irg), NULL, dump_whole_node, f);
                /* dump type info */
                type_walk_irg(irg, dump_type_info, NULL, f);
                inc_irg_visited(get_const_code_irg());
                /* dump edges from graph to type info */
                irg_walk(get_irg_end(irg), dump_node2type_edges, NULL, f);

                vcg_close(f);
                dump_const_local = rem_dump_const_local;
                current_ir_graph = rem;
        }
}

void
dump_ir_block_graph_w_types(ir_graph *irg, const char *suffix)
{
        FILE *f;
        int i;
        char *suffix1;

        /* if a filter is set, dump only the irg's that match the filter */
        if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg))))
                return;

        if (get_interprocedural_view()) suffix1 = "-wtypes-ip";
        else                            suffix1 = "-wtypes";
        f = vcg_open(irg, suffix, suffix1);
        if (f != NULL) {
                ir_graph *rem = current_ir_graph;
                int rem_dump_const_local;

                rem_dump_const_local = dump_const_local;
                /* dumping types does not work with local nodes */
                dump_const_local = 0;

                dump_vcg_header(f, get_irg_dump_name(irg), NULL);

                /* dump common blocked ir graph */
                construct_block_lists(irg);

                for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
                        ir_node **arr = ird_get_irg_link(get_irp_irg(i));
                        if (arr) {
                                dump_graph_from_list(f, get_irp_irg(i));
                                DEL_ARR_F(arr);
                        }
                }

                /* dump type info */
                current_ir_graph = irg;
                type_walk_irg(irg, dump_type_info, NULL, f);
                inc_irg_visited(get_const_code_irg());

                /* dump edges from graph to type info */
                irg_walk(get_irg_end(irg), dump_node2type_edges, NULL, f);

                vcg_close(f);
                dump_const_local = rem_dump_const_local;
                current_ir_graph = rem;
        }
}

/*---------------------------------------------------------------------*/
/* The following routines dump a control flow graph.                   */
/*---------------------------------------------------------------------*/

static void
dump_block_to_cfg(ir_node *block, void *env) {
        FILE *F = env;
        int i, fl = 0;
        ir_node *pred;

        if (is_Block(block)) {
                /* This is a block. Dump a node for the block. */
                fprintf(F, "node: {title: \""); PRINT_NODEID(block);
                fprintf(F, "\" label: \"");
                if (block == get_irg_start_block(get_irn_irg(block)))
                        fprintf(F, "Start ");
                if (block == get_irg_end_block(get_irn_irg(block)))
                        fprintf(F, "End ");

                fprintf(F, "%s ", get_op_name(get_irn_op(block)));
                PRINT_NODEID(block);
                fprintf(F, "\" ");
                fprintf(F, "info1:\"");

                /* the generic version. */
                dump_irnode_to_file(F, block);

                /* Check whether we have bad predecessors to color the block. */
                for (i = 0; i < get_Block_n_cfgpreds(block); ++i)
                        if ((fl = is_Bad(get_Block_cfgpred(block, i))))
                                break;

                fprintf(F, "\"");  /* closing quote of info */

                if ((block == get_irg_start_block(get_irn_irg(block))) ||
                        (block == get_irg_end_block(get_irn_irg(block)))     )
                        fprintf(F, " color:blue ");
                else if (fl)
                        fprintf(F, " color:yellow ");

                fprintf(F, "}\n");
                /* Dump the edges */
                for ( i = 0; i < get_Block_n_cfgpreds(block); i++)
                        if (get_irn_op(skip_Proj(get_Block_cfgpred(block, i))) != op_Bad) {
                                pred = get_nodes_block(skip_Proj(get_Block_cfgpred(block, i)));
                                fprintf(F, "edge: { sourcename: \"");
                                PRINT_NODEID(block);
                                fprintf(F, "\" targetname: \"");
                                PRINT_NODEID(pred);
                                fprintf(F, "\"}\n");
                        }

                /* Dump dominator/postdominator edge */
                if (dump_dominator_information_flag) {
                        if (get_irg_dom_state(current_ir_graph) == dom_consistent && get_Block_idom(block)) {
                                pred = get_Block_idom(block);
                                fprintf(F, "edge: { sourcename: \"");
                                PRINT_NODEID(block);
                                fprintf(F, "\" targetname: \"");
                                PRINT_NODEID(pred);
                                fprintf(F, "\" " DOMINATOR_EDGE_ATTR "}\n");
                        }
                        if (get_irg_postdom_state(current_ir_graph) == dom_consistent && get_Block_ipostdom(block)) {
                                pred = get_Block_ipostdom(block);
                                fprintf(F, "edge: { sourcename: \"");
                                PRINT_NODEID(block);
                                fprintf(F, "\" targetname: \"");
                                PRINT_NODEID(pred);
                                fprintf(F, "\" " POSTDOMINATOR_EDGE_ATTR "}\n");
                        }
                }
        }
}

void
dump_cfg(ir_graph *irg, const char *suffix)
{
        FILE *f;
        /* if a filter is set, dump only the irg's that match the filter */
        if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg))))
                return;

        f = vcg_open(irg, suffix, "-cfg");
        if (f != NULL) {
                ir_graph *rem = current_ir_graph;
                int ipv = get_interprocedural_view();

                current_ir_graph = irg;
                dump_vcg_header(f, get_irg_dump_name(irg), NULL);

                if (ipv) {
                        printf("Warning: dumping cfg not in interprocedural view!\n");
                        set_interprocedural_view(0);
                }

                /* walk over the blocks in the graph */
                irg_block_walk(get_irg_end(irg), dump_block_to_cfg, NULL, f);
                dump_node(f, get_irg_bad(irg));

                set_interprocedural_view(ipv);
                vcg_close(f);
                current_ir_graph = rem;
        }
}


static void descend_and_dump(FILE *F, ir_node *n, int depth, pset *mark_set) {
        if (pset_find_ptr(mark_set, n)) return;

        pset_insert_ptr(mark_set, n);

        if (depth > 0) {
                int i, start = is_Block(n) ? 0 : -1;
                dump_whole_node(n, F);
                for (i = start; i < get_irn_arity(n); ++i)
                        descend_and_dump(F, get_irn_n(n, i), depth-1, mark_set);
        } else {
                dump_node(F, n);
                /* Don't dump edges to nodes further out.  These might be edges to
                   nodes we already dumped, if there is a shorter path to these. */
        }
}

static int subgraph_counter = 0;
void dump_subgraph(ir_node *root, int depth, const char *suffix) {
        FILE *F;
        char buf[32];

        sprintf(buf, "-subg_%03d", subgraph_counter++);
        F = vcg_open(get_irn_irg(root), suffix, buf);
        if (F != NULL) {
                pset *mark_set = pset_new_ptr(1);
                dump_vcg_header(F, get_irg_dump_name(get_irn_irg(root)), NULL);
                descend_and_dump(F, root, depth, mark_set);
                vcg_close(F);
                del_pset(mark_set);
        }
}


static int weight_overall(int rec, int loop) {
        return 2*rec + loop;
}

static int compute_color(int my, int max) {
        int color;
        if (!max) {
                color = 0;
        } else {
                int step;

                /* if small, scale to the full color range. */
                if (max < n_colors)
                        my = my * (n_colors/max);

                step = 1 + (max / n_colors);

                color = my/step;
        }
        return base_color + n_colors - color;
}

/**
 * Calculate a entity color depending on it's execution propability.
 */
static int get_entity_color(ir_entity *ent) {
        ir_graph *irg = get_entity_irg(ent);
        assert(irg);

        {
                int rec_depth     = get_irg_recursion_depth(irg);
                int loop_depth    = get_irg_loop_depth(irg);
                int overall_depth = weight_overall(rec_depth, loop_depth);

                int max_rec_depth     = irp->max_callgraph_recursion_depth;
                int max_loop_depth    = irp->max_callgraph_loop_depth;
                int max_overall_depth = weight_overall(max_rec_depth, max_loop_depth);

                /* int my_rec_color     = compute_color(rec_depth, max_rec_depth); */
                /* int my_loop_color    = compute_color(loop_depth, max_loop_depth); */
                int my_overall_color = compute_color(overall_depth, max_overall_depth);

                return my_overall_color;
        }
}

void dump_callgraph(const char *suffix) {
        FILE *F = vcg_open_name("Callgraph", suffix);

        if (F != NULL) {
                int i, rem = edge_label, colorize;
                edge_label = 1;
                dump_vcg_header(F, "Callgraph", NULL);

                colorize = get_irp_callgraph_state() == irp_callgraph_and_calltree_consistent;

                for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
                        ir_graph *irg = get_irp_irg(i);
                        ir_entity *ent = get_irg_entity(irg);
                        int j, n_callees = get_irg_n_callees(irg);
                        int color;

                        color = colorize ? get_entity_color(ent) : ird_color_green;
                        dump_entity_node(F, ent, color);
                        for (j = 0; j < n_callees; ++j) {
                                ir_entity *c = get_irg_entity(get_irg_callee(irg, j));
                                //if (id_is_prefix(prefix, get_entity_ld_ident(c))) continue;
                                int be = is_irg_callee_backedge(irg, j);
                                char *attr;
                                attr = (be) ?
                                        "label:\"recursion %d\" color:%d" :
                                "label:\"calls %d\" color:%d";
                                print_ent_ent_edge(F, ent, c, be, attr, get_irg_callee_loop_depth(irg, j), color);
                        }
                }

                edge_label = rem;
                vcg_close(F);
        }
}

/* Dump all irgs in interprocedural view to a single file. */
void dump_all_cg_block_graph(const char *suffix) {
        FILE *f = vcg_open_name("All_graphs", suffix);

        if (f != NULL) {
                int i;
                int rem_view = get_interprocedural_view();

                set_interprocedural_view(1);
                dump_vcg_header(f, "All_graphs", NULL);

                /* collect nodes in all irgs reachable in call graph*/
                for (i = get_irp_n_irgs() - 1; i >= 0; --i)
                        ird_set_irg_link(get_irp_irg(i), NULL);

                cg_walk(clear_link, collect_node, NULL);

                /* dump all graphs */
                for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
                        current_ir_graph = get_irp_irg(i);
                        assert(ird_get_irg_link(current_ir_graph));
                        dump_graph_from_list(f, current_ir_graph);
                        DEL_ARR_F(ird_get_irg_link(current_ir_graph));
                }

                vcg_close(f);
                set_interprocedural_view(rem_view);
        }
}

/*---------------------------------------------------------------------*/
/* the following routines dumps type information without any ir nodes. */
/*---------------------------------------------------------------------*/

void
dump_type_graph(ir_graph *irg, const char *suffix)
{
        FILE *f;

        /* if a filter is set, dump only the irg's that match the filter */
        if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg)))) return;

        f = vcg_open(irg, suffix, "-type");
        if (f != NULL) {
                ir_graph *rem = current_ir_graph;
                current_ir_graph = irg;

                dump_vcg_header(f, get_irg_dump_name(irg), NULL);

                /* walk over the blocks in the graph */
                type_walk_irg(irg, dump_type_info, NULL, f);
                /* The walker for the const code can be called several times for the
                   same (sub) expression.  So that no nodes are dumped several times
                   we decrease the visited flag of the corresponding graph after each
                   walk.  So now increase it finally. */
                inc_irg_visited(get_const_code_irg());

                vcg_close(f);
                current_ir_graph = rem;
        }
}

void
dump_all_types(const char *suffix)
{
        FILE *f = vcg_open_name("All_types", suffix);
        if (f) {
                dump_vcg_header(f, "All_types", NULL);
                type_walk(dump_type_info, NULL, f);
                inc_irg_visited(get_const_code_irg());
                vcg_close(f);
        }
}

void
dump_class_hierarchy(int entities, const char *suffix)
{
        FILE *f = vcg_open_name("class_hierarchy", suffix);

        if (f != NULL) {
                h_env_t env;
                env.f        = f;
                env.dump_ent = entities;
                dump_vcg_header(f, "class_hierarchy", NULL);
                type_walk(dump_class_hierarchy_node, NULL, &env);
                vcg_close(f);
        }
}

/*---------------------------------------------------------------------*/
/* dumps all graphs with the graph-dumper passed. Possible dumpers:    */
/*  dump_ir_graph                                                      */
/*  dump_ir_block_graph                                                */
/*  dump_cfg                                                           */
/*  dump_type_graph                                                    */
/*  dump_ir_graph_w_types                                              */
/*---------------------------------------------------------------------*/

void dump_all_ir_graphs(dump_graph_func *dmp_grph, const char *suffix) {
        int i;
        for (i = get_irp_n_irgs() - 1; i >= 0; --i)
                dmp_grph(get_irp_irg(i), suffix);
}


/*--------------------------------------------------------------------------------*
 * Dumps a stand alone loop graph with firm nodes which belong to one loop node   *
 * packed together in one subgraph/box                                            *
 *--------------------------------------------------------------------------------*/

void dump_loops_standalone(FILE *F, ir_loop *loop) {
        int i = 0, loop_node_started = 0, son_number = 0, first = 0;
        loop_element le;
        ir_loop *son = NULL;

        /* Dump a new loop node. */
        dump_loop_node(F, loop);

        /* Dump the loop elements. */

        for(i = 0; i < get_loop_n_elements(loop); i++) {
                le = get_loop_element(loop, i);
                son = le.son;
                if (get_kind(son) == k_ir_loop) {

                        /* We are a loop son -> Recurse */

                        if(loop_node_started) { /* Close the "firm-nodes" node first if we started one. */
                                fprintf(F, "\" }\n");
                                fprintf(F, "edge: {sourcename: \"");
                                PRINT_LOOPID(loop);
                                fprintf(F, "\" targetname: \"");
                                PRINT_LOOPID(loop);
                                fprintf(F, "-%d-nodes\" label:\"%d...%d\"}\n", first, first, i-1);
                                loop_node_started = 0;
                        }
                        dump_loop_son_edge(F, loop, son_number++);
                        dump_loops_standalone(F, son);
                } else if (get_kind(son) == k_ir_node) {
                        /* We are a loop node -> Collect firm nodes */

                        ir_node *n = le.node;
                        int bad = 0;

                        if (!loop_node_started) {
                                /* Start a new node which contains all firm nodes of the current loop */
                                fprintf(F, "node: { title: \"");
                                PRINT_LOOPID(loop);
                                fprintf(F, "-%d-nodes\" color: lightyellow label: \"", i);
                                loop_node_started = 1;
                                first = i;
                        } else
                                fprintf(F, "\n");

                        bad |= dump_node_label(F, n);
                        /* Causes indeterministic output: if (is_Block(n)) fprintf(F, "\t ->%d", (int)get_irn_link(n)); */
                        if (has_backedges(n)) fprintf(F, "\t loop head!");
                } else { /* for callgraph loop tree */
                        ir_graph *n;
                        assert(get_kind(son) == k_ir_graph);

                        /* We are a loop node -> Collect firm graphs */
                        n = (ir_graph *)le.node;
                        if (!loop_node_started) {
                                /* Start a new node which contains all firm nodes of the current loop */
                                fprintf(F, "node: { title: \"");
                                PRINT_LOOPID(loop);
                                fprintf(F, "-%d-nodes\" color: lightyellow label: \"", i);
                                loop_node_started = 1;
                                first = i;
                        } else
                                fprintf(F, "\n");
                        fprintf(F, " %s", get_irg_dump_name(n));
                        /* fprintf(F, " %s (depth %d)", get_irg_dump_name(n), n->callgraph_weighted_loop_depth); */
                }
        }

        if (loop_node_started) {
                fprintf(F, "\" }\n");
                fprintf(F, "edge: {sourcename: \"");
                PRINT_LOOPID(loop);
                fprintf(F, "\" targetname: \"");
                PRINT_LOOPID(loop);
                fprintf(F, "-%d-nodes\" label:\"%d...%d\"}\n", first, first, i-1);
                loop_node_started = 0;
        }
}

void dump_loop_tree(ir_graph *irg, const char *suffix)
{
        FILE *f;

        /* if a filter is set, dump only the irg's that match the filter */
        if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg)))) return;

        f = vcg_open(irg, suffix, "-looptree");
        if (f != NULL) {
                ir_graph *rem = current_ir_graph;
                int el_rem = edge_label;

                current_ir_graph = irg;
                edge_label = 1;

                dump_vcg_header(f, get_irg_dump_name(irg), "top_to_bottom");

                if (get_irg_loop(irg)) dump_loops_standalone(f, get_irg_loop(irg));

                vcg_close(f);

                edge_label = el_rem;
                current_ir_graph = rem;
        }
}

void dump_callgraph_loop_tree(const char *suffix) {
        FILE *F;
        F = vcg_open_name("Callgraph_looptree", suffix);
        dump_vcg_header(F, "callgraph looptree", "top_to_bottom");
        dump_loops_standalone(F, irp->outermost_cg_loop);
        vcg_close(F);
}


/*----------------------------------------------------------------------------*/
/* Dumps the firm nodes in the loop tree to a graph along with the loop nodes.*/
/*----------------------------------------------------------------------------*/

void collect_nodeloop(FILE *F, ir_loop *loop, eset *loopnodes) {
        int i, son_number = 0, node_number = 0;

        if (dump_loop_information_flag) dump_loop_node(F, loop);

        for (i = 0; i < get_loop_n_elements(loop); i++) {
                loop_element le = get_loop_element(loop, i);
                if (*(le.kind) == k_ir_loop) {
                        if (dump_loop_information_flag) dump_loop_son_edge(F, loop, son_number++);
                        /* Recur */
                        collect_nodeloop(F, le.son, loopnodes);
                } else {
                        if (dump_loop_information_flag) dump_loop_node_edge(F, loop, node_number++);
                        eset_insert(loopnodes, le.node);
                }
        }
}

void collect_nodeloop_external_nodes(ir_loop *loop, eset *loopnodes, eset *extnodes) {
        int i, j, start;

        for(i = 0; i < get_loop_n_elements(loop); i++) {
                loop_element le = get_loop_element(loop, i);
                if (*(le.kind) == k_ir_loop) {
                        /* Recur */
                        collect_nodeloop_external_nodes(le.son, loopnodes, extnodes);
                } else {
                        if (is_Block(le.node)) start = 0; else start = -1;
                        for (j = start; j < get_irn_arity(le.node); j++) {
                                ir_node *pred = get_irn_n(le.node, j);
                                if (!eset_contains(loopnodes, pred)) {
                                        eset_insert(extnodes, pred);
                                        if (!is_Block(pred)) {
                                                pred = get_nodes_block(pred);
                                                if (!eset_contains(loopnodes, pred)) eset_insert(extnodes, pred);
                                        }
                                }
                        }
                }
        }
}

void dump_loop(ir_loop *l, const char *suffix) {
        FILE *F;
        char name[50];

        snprintf(name, sizeof(name), "loop_%d", get_loop_loop_nr(l));
        F = vcg_open_name(name, suffix);
        if (F != NULL) {
                eset *loopnodes = eset_create();
                eset *extnodes = eset_create();
                ir_node *n, *b;

                dump_vcg_header(F, name, NULL);

                /* collect all nodes to dump */
                collect_nodeloop(F, l, loopnodes);
                collect_nodeloop_external_nodes(l, loopnodes, extnodes);

                /* build block lists */
                for (n = eset_first(loopnodes); n != NULL; n = eset_next(loopnodes))
                        set_irn_link(n, NULL);
                for (n = eset_first(extnodes); n != NULL; n = eset_next(extnodes))
                        set_irn_link(n, NULL);
                for (n = eset_first(loopnodes); n != NULL; n = eset_next(loopnodes)) {
                        if (!is_Block(n)) {
                                b = get_nodes_block(n);
                                set_irn_link(n, get_irn_link(b));
                                set_irn_link(b, n);
                        }
                }
                for (n = eset_first(extnodes); n != NULL; n = eset_next(extnodes)) {
                        if (!is_Block(n)) {
                                b = get_nodes_block(n);
                                set_irn_link(n, get_irn_link(b));
                                set_irn_link(b, n);
                        }
                }

                for (b = eset_first(loopnodes); b != NULL; b = eset_next(loopnodes)) {
                        if (is_Block(b)) {
                                fprintf(F, "graph: { title: \"");
                                PRINT_NODEID(b);
                                fprintf(F, "\"  label: \"");
                                dump_node_opcode(F, b);
                                fprintf(F, " %ld:%d", get_irn_node_nr(b), get_irn_idx(b));
                                fprintf(F, "\" status:clustered color:yellow\n");

                                /* dump the blocks edges */
                                dump_ir_data_edges(F, b);

                                /* dump the nodes that go into the block */
                                for (n = get_irn_link(b); n; n = get_irn_link(n)) {
                                        if (eset_contains(extnodes, n))
                                                overrule_nodecolor = ird_color_lightblue;
                                        dump_node(F, n);
                                        overrule_nodecolor = ird_color_default;
                                        if (!eset_contains(extnodes, n)) dump_ir_data_edges(F, n);
                                }

                                /* Close the vcg information for the block */
                                fprintf(F, "}\n");
                                dump_const_node_local(F, b);
                                fprintf(F, "\n");
                        }
                }
                for (b = eset_first(extnodes); b != NULL; b = eset_next(extnodes)) {
                        if (is_Block(b)) {
                                fprintf(F, "graph: { title: \"");
                                PRINT_NODEID(b);
                                fprintf(F, "\"  label: \"");
                                dump_node_opcode(F, b);
                                fprintf(F, " %ld:%d", get_irn_node_nr(b), get_irn_idx(b));
                                fprintf(F, "\" status:clustered color:lightblue\n");

                                /* dump the nodes that go into the block */
                                for (n = get_irn_link(b); n; n = get_irn_link(n)) {
                                        if (!eset_contains(loopnodes, n))
                                                overrule_nodecolor = ird_color_lightblue;
                                        dump_node(F, n);
                                        overrule_nodecolor = ird_color_default;
                                        if (eset_contains(loopnodes, n)) dump_ir_data_edges(F, n);
                                }

                                /* Close the vcg information for the block */
                                fprintf(F, "}\n");
                                dump_const_node_local(F, b);
                                fprintf(F, "\n");
                        }
                }
                eset_destroy(loopnodes);
                eset_destroy(extnodes);
                vcg_close(F);
        }
}