irdump.h

/*
 * This file is part of libFirm.
 * Copyright (C) 2012 University of Karlsruhe.
 */

#ifndef FIRM_IR_IRDUMP_H
#define FIRM_IR_IRDUMP_H

#include <stdio.h>

#include "firm_types.h"
#include "begin.h"

FIRM_API void dump_ir_graph(ir_graph *graph, const char *suffix);

typedef void (*ir_prog_dump_func)(FILE *out);

FIRM_API void dump_ir_prog_ext(ir_prog_dump_func func, const char *suffix);

typedef void (*ir_graph_dump_func)(FILE *out, ir_graph *graph);

FIRM_API void dump_ir_graph_ext(ir_graph_dump_func func, ir_graph *graph,
                                const char *suffix);

FIRM_API void dump_all_ir_graphs(const char *suffix);

FIRM_API void ir_set_dump_path(const char *path);

FIRM_API void ir_set_dump_filter(const char *name);

FIRM_API const char *ir_get_dump_filter(void);

FIRM_API void dump_ir_graph_file(FILE *out, ir_graph *graph);

FIRM_API void dump_cfg(FILE *out, ir_graph *graph);

FIRM_API void dump_callgraph(FILE *out);

FIRM_API void dump_typegraph(FILE *out);

FIRM_API void dump_class_hierarchy(FILE *out);

FIRM_API void dump_loop_tree(FILE *out, ir_graph *graph);

FIRM_API void dump_callgraph_loop_tree(FILE *out);

FIRM_API void dump_types_as_text(FILE *out);

FIRM_API void dump_globals_as_text(FILE *out);

FIRM_API void dump_loop(FILE *out, ir_loop *loop);

FIRM_API void dump_graph_as_text(FILE *out, const ir_graph *graph);

FIRM_API void dump_entity_to_file(FILE *out, const ir_entity *entity);

FIRM_API void dump_type_to_file(FILE *out, const ir_type *type);

typedef enum {
    dump_verbosity_onlynames         = 0x00000001,   
    dump_verbosity_fields            = 0x00000002,   
    dump_verbosity_methods           = 0x00000004,   
    dump_verbosity_nostatic          = 0x00000040,   
    dump_verbosity_typeattrs         = 0x00000008,   
    dump_verbosity_entattrs          = 0x00000010,   
    dump_verbosity_entconsts         = 0x00000020,   
    dump_verbosity_accessStats       = 0x00000100,   
    dump_verbosity_max                = 0x4FF00FBE   
} ir_dump_verbosity_t;
ENUM_BITSET(ir_dump_verbosity_t)


FIRM_API void ir_set_dump_verbosity(ir_dump_verbosity_t verbosity);
FIRM_API ir_dump_verbosity_t ir_get_dump_verbosity(void);

typedef enum {
    ir_dump_flag_blocks_as_subgraphs   = 1U <<  0,
    ir_dump_flag_with_typegraph        = 1U <<  1,
    ir_dump_flag_disable_edge_labels   = 1U <<  2,
    ir_dump_flag_consts_local          = 1U <<  3,
    ir_dump_flag_idx_label             = 1U <<  4,
    ir_dump_flag_number_label          = 1U <<  5,
    ir_dump_flag_keepalive_edges       = 1U <<  6,
    ir_dump_flag_out_edges             = 1U <<  7,
    ir_dump_flag_dominance             = 1U <<  8,
    ir_dump_flag_loops                 = 1U <<  9,
    ir_dump_flag_back_edges            = 1U << 10,
    ir_dump_flag_iredges               = 1U << 11,
    ir_dump_flag_all_anchors           = 1U << 12,
    ir_dump_flag_show_marks            = 1U << 13,

    ir_dump_flag_no_entity_values      = 1U << 14,
    ir_dump_flag_ld_names              = 1U << 15,
    ir_dump_flag_entities_in_hierarchy = 1U << 16,
} ir_dump_flags_t;
ENUM_BITSET(ir_dump_flags_t)


FIRM_API void ir_set_dump_flags(ir_dump_flags_t flags);
FIRM_API void ir_add_dump_flags(ir_dump_flags_t flags);
FIRM_API void ir_remove_dump_flags(ir_dump_flags_t flags);
FIRM_API ir_dump_flags_t ir_get_dump_flags(void);

typedef int (*dump_node_vcgattr_func)(FILE *out, const ir_node *node, const ir_node *local);

typedef int (*dump_edge_vcgattr_func)(FILE *out, const ir_node *node, int to);

typedef void (*dump_node_edge_func)(FILE *out, const ir_node *node);

FIRM_API void set_dump_node_vcgattr_hook(dump_node_vcgattr_func hook);
FIRM_API void set_dump_edge_vcgattr_hook(dump_edge_vcgattr_func hook);

FIRM_API void set_dump_node_edge_hook(dump_node_edge_func func);

FIRM_API dump_node_edge_func get_dump_node_edge_hook(void);

FIRM_API void set_dump_block_edge_hook(dump_node_edge_func func);

FIRM_API dump_node_edge_func get_dump_block_edge_hook(void);

typedef void (dump_node_info_cb_t)(void *data, FILE *out, const ir_node *n);

FIRM_API hook_entry_t *dump_add_node_info_callback(dump_node_info_cb_t *cb, void *data);

FIRM_API void dump_remove_node_info_callback(hook_entry_t *handle);

void dump_vcg_header(FILE *out, const char *name, const char *layout,
                     const char *orientation);

void dump_vcg_footer(FILE *out);

void dump_node(FILE *out, const ir_node *node);

void dump_ir_data_edges(FILE *out, const ir_node *node);

void print_nodeid(FILE *out, const ir_node *node);

void dump_begin_block_subgraph(FILE *out, const ir_node *block);

void dump_end_block_subgraph(FILE *out, const ir_node *block);

void dump_block_edges(FILE *out, const ir_node *block);

void dump_blocks_as_subgraphs(FILE *out, ir_graph *irg);


#include "end.h"

#endif