libfirm/irdump.h

Go to the documentation of this file.

/*
 * Copyright (C) 1995-2008 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.
 */

#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 int ir_should_dump(const char *name);

FIRM_API ir_prog_pass_t *dump_all_ir_graph_pass(const char *name,
                                                const char *suffix);

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, ir_graph *graph);

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

FIRM_API void dump_type_to_file(FILE *out, 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_noClassTypes      = 0x00001000,   
    dump_verbosity_noStructTypes     = 0x00002000,   
    dump_verbosity_noUnionTypes      = 0x00004000,   
    dump_verbosity_noArrayTypes      = 0x00008000,   
    dump_verbosity_noPointerTypes    = 0x00010000,   
    dump_verbosity_noMethodTypes     = 0x00020000,   
    dump_verbosity_noPrimitiveTypes  = 0x00040000,   
    dump_verbosity_noEnumerationTypes= 0x00080000,   
    dump_verbosity_onlyClassTypes     = 0x000FE000,  
    dump_verbosity_onlyStructTypes    = 0x000FD000,  
    dump_verbosity_onlyUnionTypes     = 0x000FB000,  
    dump_verbosity_onlyArrayTypes     = 0x000F7000,  
    dump_verbosity_onlyPointerTypes   = 0x000EF000,  
    dump_verbosity_onlyMethodTypes    = 0x000DF000,  
    dump_verbosity_onlyPrimitiveTypes = 0x000BF000,  
    dump_verbosity_onlyEnumerationTypes=0x0007F000,  
    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_group_extbb           = 1U << 1,
    ir_dump_flag_with_typegraph        = 1U << 2,
    ir_dump_flag_disable_edge_labels   = 1U << 3,
    ir_dump_flag_consts_local          = 1U << 4,
    ir_dump_flag_idx_label             = 1U << 5,
    ir_dump_flag_number_label          = 1U << 6,
    ir_dump_flag_keepalive_edges       = 1U << 7,
    ir_dump_flag_out_edges             = 1U << 8,
    ir_dump_flag_dominance             = 1U << 9,
    ir_dump_flag_loops                 = 1U << 10,
    ir_dump_flag_back_edges            = 1U << 11,
    ir_dump_flag_analysed_types        = 1U << 12,
    ir_dump_flag_iredges               = 1U << 13,
    ir_dump_flag_node_addresses        = 1U << 14,
    ir_dump_flag_all_anchors           = 1U << 15,
    ir_dump_flag_show_marks            = 1U << 16,

    ir_dump_flag_no_entity_values      = 1U << 20,
    ir_dump_flag_ld_names              = 1U << 21,
    ir_dump_flag_entities_in_hierarchy = 1U << 22,
} 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 void *dump_add_node_info_callback(dump_node_info_cb_t *cb, void *data);

FIRM_API void dump_remove_node_info_callback(void *handle);

#include "end.h"

#endif