X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;f=ir%2Fir%2Firdump.h;h=40a767fd37c5dc077e2ed0fca0e5aa10b514ff3a;hb=23ea16875f38dc0c067cce24f64b5c70f3acc496;hp=6721d91cb35fff7a82ba23773bc82af12735714c;hpb=7ca3ea53a92e084499a439f299d224efdaae6546;p=libfirm diff --git a/ir/ir/irdump.h b/ir/ir/irdump.h index 6721d91cb..40a767fd3 100644 --- a/ir/ir/irdump.h +++ b/ir/ir/irdump.h @@ -10,7 +10,6 @@ * Licence: This file protected by GPL - GNU GENERAL PUBLIC LICENSE. */ - /** * @file irdump.h * @@ -28,15 +27,84 @@ * Most routines use the name of the passed entity as the name of the * file dumped to. */ +#ifndef _FIRM_IR_IRDUMP_H_ +#define _FIRM_IR_IRDUMP_H_ +#include "irnode.h" +#include "irgraph.h" +#include "irloop.h" -# ifndef _IRDUMP_H_ -# define _IRDUMP_H_ - -# include "irnode.h" -# include "irgraph.h" -# include "irloop.h" +/** + * Names of the 32 supported colors + */ +typedef enum { + ird_color_default = -1, + ird_color_white = 0, + ird_color_blue = 1, + ird_color_red = 2, + ird_color_green = 3, + ird_color_yellow = 4, + ird_color_magenta = 5, + ird_color_cyan = 6, + ird_color_darkgray = 7, + ird_color_darkblue = 8, + ird_color_darkred = 9, + ird_color_darkgreen = 10, + ird_color_darkyellow = 11, + ird_color_darkmagenta = 12, + ird_color_darkcyan = 13, + ird_color_gold = 14, + ird_color_lightgray = 15, + ird_color_lightblue = 16, + ird_color_lightred = 17, + ird_color_lightgreen = 18, + ird_color_lightyellow = 19, + ird_color_lightmagenta = 20, + ird_color_lightcyan = 21, + ird_color_lilac = 22, + ird_color_turquoise = 23, + ird_color_aquamarine = 24, + ird_color_khaki = 25, + ird_color_purple = 26, + ird_color_yellowgreen = 27, + ird_color_pink = 28, + ird_color_orange = 29, + ird_color_orchid = 30, + ird_color_black = 31 +} dumper_colors; +/** + * Edge kinds + */ +typedef enum { + data_edge = 0x01, /**< a data edge between two basic blocks */ + block_edge = 0x02, /**< an edge from a node to its basic block */ + cf_edge = 0x03, /**< regularly control flow edge */ + exc_cf_edge = 0x04, /**< exceptional control flow edge */ + mem_edge = 0x05, /**< memory edge */ + dominator_edge = 0x06, /**< dominator edge */ + node2type_edge = 0x07, /**< an edge from an IR node to a type */ + + ent_type_edge = 0x11, /**< an edge from an entity to its type */ + ent_own_edge = 0x12, /**< an edge from an entity to its owner type */ + ent_overwrites_edge = 0x13, /**< an edge from an entity to the entity it overwrites */ + ent_value_edge = 0x14, /**< an edge from an entity to its value entity */ + ent_corr_edge = 0x15, /**< an edge from an entity to the member entity its initializes */ + + meth_par_edge = 0x21, /**< an edge from a method type to one of its parameter types */ + meth_res_edge = 0x22, /**< an edge from a method type to one of its result types */ + type_super_edge = 0x23, /**< an edge from a class type to its super/basis type */ + union_edge = 0x24, /**< an edge from a union type to its member types */ + ptr_pts_to_edge = 0x25, /**< an edge from a pointer type to its points-to type */ + arr_elt_type_edge = 0x26, /**< an edge from an array type to its element type */ + arr_ent_edge = 0x27, /**< an edge from a array type to its element entity */ + type_member_edge = 0x28, /**< an edge from a compound type to its member entities */ + + /* additional flags */ + intra_edge = 0, /**< intra edge flag: edge do not cross basic block boundaries */ + inter_edge = 0x40, /**< inter edge flag: edge cross basic block boundaries */ + back_edge = 0x80 /**< backwards edge flag */ +} edge_kind; /* **************************************************************************** */ /* GRAPH DUMPERS */ @@ -80,6 +148,18 @@ void set_dump_node_edge_hook(DUMP_NODE_EDGE_FUNC func); */ DUMP_NODE_EDGE_FUNC get_dump_node_edge_hook(void); +/** + * Set the hook to be called to dump additional edges to a block. + * @param func The hook to be called. + */ +void set_dump_block_edge_hook(DUMP_NODE_EDGE_FUNC func); + +/** + * Get the additional block edge dump hook. + * @return The current additional block edge dump hook. + */ +DUMP_NODE_EDGE_FUNC get_dump_block_edge_hook(void); + /** Dump a firm graph. * * @param irg The firm graph to be dumped. @@ -312,7 +392,7 @@ void dump_all_types (const char *suffix); * is dumped along with the entities. * Dumps to a file class_hierarchy.vcg */ -void dump_class_hierarchy (bool entities, const char *suffix); +void dump_class_hierarchy (int entities, const char *suffix); /* **************************************************************************** */ /* LOOPTREE DUMPERS */ @@ -390,12 +470,12 @@ void dump_graph_as_text(ir_graph *irg, const char *suffix); /** Verbosity for text dumpers */ typedef enum { dump_verbosity_onlynames = 0x00000001, /**< only dump names. turns off all other - flags up to 0x00010000. */ + flags up to 0x00010000. */ dump_verbosity_fields = 0x00000002, /**< dump types and fields (like a type declaration) */ dump_verbosity_methods = 0x00000004, /**< dump types and methods (like a type declaration) */ dump_verbosity_nostatic = 0x00000040, /**< dump types and dynamic allocated fields (like a - type declaration). This excludes methods and - static, polymorphic fields. */ + type declaration). This excludes methods and + static, polymorphic fields. */ dump_verbosity_typeattrs = 0x00000008, /**< dump all type attributes */ dump_verbosity_entattrs = 0x00000010, /**< dump all entity attributes */ dump_verbosity_entconsts = 0x00000020, /**< dump entity constants */ @@ -422,9 +502,9 @@ typedef enum { dump_verbosity_onlyEnumerationTypes=0x0007F000, /**< dump only enumeration types */ dump_verbosity_max = 0x4FF00FBE /**< turn on all verbosity. - Do not turn on negative flags! - @@@ Because of a bug in gcc 3.2 we can not set the - first two bits. */ + Do not turn on negative flags! + @@@ Because of a bug in gcc 3.2 we can not set the + first two bits. */ } dump_verbosity; @@ -439,11 +519,11 @@ void dump_entity (entity *ent); /** Write the type and all its attributes to the file passed. * */ -void dump_type_to_file (FILE *f, type *tp, dump_verbosity verbosity); +void dump_type_to_file (FILE *f, ir_type *tp, dump_verbosity verbosity); /** Write the type and all its attributes to stdout. * */ -void dump_type (type *tp); +void dump_type (ir_type *tp); /** Dump type information as text. @@ -502,75 +582,106 @@ int is_filtered_dump_name(ident *name); void turn_off_edge_labels(void); /** - * If set to true constants will be replicated for every use. In non + * If set to non-zero constants will be replicated for every use. In non * blocked view edges from constant to block are skipped. Vcg then * layouts the graphs more compact, this makes them better readable. * The flag is automatically and temporarily set to false if other * edges are dumped, as outs, loop, ... * Default setting: false. */ -void dump_consts_local(bool b); +void dump_consts_local(int flag); /** - * Returns false if dump_out_edge_flag or dump_loop_information_flag + * Returns 0 if dump_out_edge_flag or dump_loop_information_flag * are set, else returns dump_const_local_flag. */ -bool get_opt_dump_const_local(void); +int get_opt_dump_const_local(void); /** Turns off dumping the values of constant entities. Makes type graphs * better readable. */ -void dump_constant_entity_values(bool b); +void dump_constant_entity_values(int flag); /** Turns on dumping the edges from the End node to nodes to be kept * alive. */ -void dump_keepalive_edges(bool b); -bool get_opt_dump_keepalive_edges(void); +void dump_keepalive_edges(int flag); +int get_opt_dump_keepalive_edges(void); /** Turns on dumping the out edges starting from the Start block in * dump_ir_graph. * * To test the consistency of the out data structure. */ -void dump_out_edges(bool b); +void dump_out_edges(int flag); /** If this flag is set the dumper dumps edges to immediate dominator in cfg. */ -void dump_dominator_information(bool b); +void dump_dominator_information(int flag); /** If this flag is set the dumper dumps loop nodes and edges from * these nodes to the contained ir nodes. * * If the loops are interprocedural nodes can be missing. */ -void dump_loop_information(bool b); +void dump_loop_information(int flag); /** If set and backedge info is computed, backedges are dumped dashed * and as vcg 'backedge' construct. * * Default: set. */ -void dump_backedge_information(bool b); +void dump_backedge_information(int 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(bool b); +void set_opt_dump_analysed_type_info(int flag); /** Write the address of a node into the vcg info. * * This is off per default for automatic comparisons of * vcg graphs -- these will differ in the pointer values! */ -void dump_pointer_values_to_info(bool b); +void dump_pointer_values_to_info(int flag); /** Dumps ld_names of entities instead of there names. * * This option is on per default. */ -void dump_ld_names(bool b); +void dump_ld_names(int flag); + +/** Dumps all graph anchor nodes, even if they + * are dead. + * + * This option is off per default. + */ +void dump_all_anchors(int flag); + +/** A node info dumper callback. */ +typedef void (dump_node_info_cb_t)(void *data, FILE *f, const ir_node *n); + +/** + * Adds a new node info dumper callback. It is possible to add an unlimited + * number of callbacks. The callbacks are called at the end of the default + * info dumper. + * + * @param cb the callback function to be called + * @param data a context parameter + * + * @return A callback handle. + * + * @note This functionality is only available, if Firm hooks are enabled (default). + */ +void *dump_add_node_info_callback(dump_node_info_cb_t *cb, void *data); + +/** + * Remove a previously added info dumper callback. + * + * @param handle the callback handle returned from dump_add_node_info_callback() + */ +void dump_remv_node_info_callback(void *handle); -# endif /* _IRDUMP_H_ */ +#endif /* _FIRM_IR_IRDUMP_H_ */