X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;f=ir%2Fir%2Firdump.h;h=40a767fd37c5dc077e2ed0fca0e5aa10b514ff3a;hb=694e43d5c03f5ac9ae82373fb54baf01c5678bf0;hp=be72fbd2cef7f373c24a30a40ba5404a8156a557;hpb=26516d16e923b5e1312daad53fcccdbd5645ddad;p=libfirm diff --git a/ir/ir/irdump.h b/ir/ir/irdump.h index be72fbd2c..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,29 +27,112 @@ * 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 */ /* **************************************************************************** */ +/** + * This hook is called to insert some special nodes into dumped graph + */ +typedef int (*DUMP_IR_GRAPH_FUNC)(FILE *F, ir_graph *irg); /** * This hook is called to dump the vcg attributes of a node to a file. * If this function returns zero, the default attributes are added, else * removed. */ typedef int (*DUMP_NODE_VCGATTR_FUNC)(FILE *F, ir_node *node, ir_node *local); +/** + * This hook is called to dump the vcg attributes of an edge to a file. + * If this function returns zero, the default attributes are added, else + * removed. + */ +typedef int (*DUMP_EDGE_VCGATTR_FUNC)(FILE *F, ir_node *node, int to); +/** Set the ir graph dump hook. */ +void set_dump_ir_graph_hook(DUMP_IR_GRAPH_FUNC hook); /** Set the node_vcgattr hook. */ void set_dump_node_vcgattr_hook(DUMP_NODE_VCGATTR_FUNC hook); +/** Set the edge_vcgattr hook. */ +void set_dump_edge_vcgattr_hook(DUMP_EDGE_VCGATTR_FUNC hook); typedef int (*DUMP_NODE_EDGE_FUNC)(FILE *f, ir_node *node); @@ -66,9 +148,22 @@ 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. + * @param irg The firm graph to be dumped. + * @param suffix A suffix for the file name. * * @return * A file containing the firm graph in vcg format. @@ -86,7 +181,8 @@ void dump_ir_graph (ir_graph *irg, const char *suffix); /** Dump a firm graph without explicit block nodes. * - * @param irg The firm graph to be dumped. + * @param irg The firm graph to be dumped. + * @param suffix A suffix for the file name. * * @return * A file containing the firm graph in vcg format. @@ -120,14 +216,17 @@ void dump_ir_block_graph (ir_graph *irg, const char *suffix); */ void dump_ir_extblock_graph (ir_graph *irg, const char *suffix); -/** Dumps all graphs in interprocedural view to a file named All_graphs.vcg. +/** Dumps all graphs in interprocedural view to a file named All_graphs.vcg. + * + * @param suffix A suffix for the file name. */ void dump_all_cg_block_graph(const char *suffix); /** Dumps a firm graph and all the type information needed for Calls, * Sels, ... in this graph. * - * @param irg The firm graph to be dumped with its type information. + * @param irg The firm graph to be dumped with its type information. + * @param suffix A suffix for the file name. * * @return * A file containing the firm graph and the type information of the firm graph in vcg format. @@ -143,7 +242,8 @@ void dump_ir_graph_w_types (ir_graph *irg, const char *suffix); /** Dumps a firm graph and all the type information needed for Calls, * Sels, ... in this graph. * - * @param irg The firm graph to be dumped with its type information. + * @param irg The firm graph to be dumped with its type information. + * @param suffix A suffix for the file name. * * @return * A file containing the firm graph and the type information of the firm graph in vcg format. @@ -157,21 +257,24 @@ void dump_ir_graph_w_types (ir_graph *irg, const char *suffix); */ void dump_ir_block_graph_w_types (ir_graph *irg, const char *suffix); -/** The type of a walker function that is called for each graph. +/** The type of a dump function that is called for each graph. * - * @param irg current visited graph + * @param irg current visited graph + * @param suffix A suffix for the file name. */ typedef void dump_graph_func(ir_graph *irg, const char *suffix); -/** A walker that calls a dumper for each graph. +/** + * A walker that calls a dumper for each graph. * - * @param dump_graph The dumper to be used for dumping. + * @param dump_graph The dumper to be used for dumping. + * @param suffix A suffix for the file name. * - * @return + * @return * Whatever the dumper creates. * - * Walks over all firm graphs and calls a dumper for each graph. - * The following dumpers can be passed as arguments: + * Walks over all firm graphs and calls a dumper for each graph. + * The following dumpers can be passed as arguments: * - dump_ir_graph() * - dump_ir_block_graph() * - dump_cfg() @@ -183,34 +286,37 @@ typedef void dump_graph_func(ir_graph *irg, const char *suffix); void dump_all_ir_graphs (dump_graph_func *dump_graph, const char *suffix); -/** Dump the control flow graph of a procedure. +/** + * Dump the control flow graph of a procedure. * - * @param irg The firm graph whose CFG shall be dumped. + * @param irg The firm graph whose CFG shall be dumped. + * @param suffix A suffix for the file name. * - * @return + * @return * A file containing the CFG in vcg format. * - * Dumps the control flow graph of a procedure in standard xvcg format. - * Dumps the graph to a file. The file name is constructed from the - * name of the entity describing the procedure (irg->entity) and the - * ending -cfg.vcg. Eventually overwrites existing files. + * Dumps the control flow graph of a procedure in standard xvcg format. + * Dumps the graph to a file. The file name is constructed from the + * name of the entity describing the procedure (irg->entity) and the + * ending -cfg.vcg. Eventually overwrites existing files. * * @see turn_off_edge_labels() */ void dump_cfg (ir_graph *irg, const char *suffix); -/** Dump a node and its predecessors forming a subgraph to a vcg file. +/** + * Dump a node and its predecessors forming a subgraph to a vcg file. * - * @param root The node serving as root for the subgraph. - * @param depth Dump nodes on paths starting at root with length depth. - * @param suffix A suffix for the file name. + * @param root The node serving as root for the subgraph. + * @param depth Dump nodes on paths starting at root with length depth. + * @param suffix A suffix for the file name. * - * Dumps the graph to a file. The file name is constructed from the - * name of the entity describing the procedure the passed node is - * in, suffix and the ending -subg_.vcg. nr is a unique number - * for each graph dumped. Eventually overwrites existing files. + * Dumps the graph to a file. The file name is constructed from the + * name of the entity describing the procedure the passed node is + * in, suffix and the ending -subg_.vcg. nr is a unique number + * for each graph dumped. Eventually overwrites existing files. * - * @return + * @return * A file containing the subgraph in vcg format. */ void dump_subgraph (ir_node *root, int depth, const char *suffix); @@ -224,6 +330,8 @@ void dump_subgraph (ir_node *root, int depth, const char *suffix); * * Dumps the callgraph to a file "Callgraph"".vcg". * + * @param suffix A suffix for the file name. + * * @see dump_callgraph_loop_tree(const char *suffix) */ void dump_callgraph(const char *suffix); @@ -233,11 +341,13 @@ void dump_callgraph(const char *suffix); /* **************************************************************************** */ /** - * Dumps all the type information needed for Calls, Sels, ... in this graph. - * Does not dump the graph! + * Dumps all the type information needed for Calls, Sels, ... in this graph. + * Does not dump the graph! * - * @param irg The firm graph whose type information is to be dumped. - * @return + * @param irg The firm graph whose type information is to be dumped. + * @param suffix A suffix for the file name. + * + * @return * A file containing the type information of the firm graph in vcg format. * * Dumps this graph to a file. The file name is constructed from the @@ -248,36 +358,41 @@ void dump_callgraph(const char *suffix); */ void dump_type_graph (ir_graph *irg, const char *suffix); -/** Dumps all type information. +/** + * Dumps all type information. + * + * @param suffix A suffix for the file name. * - * @return + * @return * A file containing all type information for the program in standard * vcg format. * - * Dumps all type information that is somehow reachable in standard vcg - * format. - * Dumps the graph to a file named All_types.vcg. + * Dumps all type information that is somehow reachable in standard vcg + * format. + * Dumps the graph to a file named All_types.vcg. * * @see turn_off_edge_labels() */ void dump_all_types (const char *suffix); -/** Dumps the class hierarchy with or without entities. +/** + * Dumps the class hierarchy with or without entities. * - * @param entities Flag whether to dump the entities. + * @param entities Flag whether to dump the entities. + * @param suffix A suffix for the file name. * - * @return + * @return * A file containing the class hierarchy tree for the program in standard * vcg format. * - * Does not dump the global type. - * Dumps a node for all classes and the sub/supertype relations. If - * entities is set to true also dumps the entities of classes, but without - * any additional information as the entities type. The overwrites relation - * is dumped along with the entities. - * Dumps to a file class_hierarchy.vcg + * Does not dump the global type. + * Dumps a node for all classes and the sub/supertype relations. If + * entities is set to true also dumps the entities of classes, but without + * any additional information as the entities type. The overwrites relation + * 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 */ @@ -291,27 +406,27 @@ void dump_class_hierarchy (bool entities, const char *suffix); * * Implementing this dumper was stimulated by Florian Liekwegs similar dumper. * - * @arg irg Dump the loop tree for this graph. - * @arg suffix Suffix to filename. + * @param irg Dump the loop tree for this graph. + * @param suffix A suffix for the file name. */ void dump_loop_tree(ir_graph *irg, const char *suffix); /** Dumps the firm nodes in the sub-loop-tree of loop to a graph. * - * Dumps the loop nodes if dump_loop_information() is set. - * The name of the file is loop_.vcg. + * Dumps the loop nodes if dump_loop_information() is set. + * The name of the file is loop_.vcg. * - * @arg loop Dump the loop tree for this loop. - * @arg suffix Suffix to filename. + * @param l Dump the loop tree for this loop. + * @param suffix A suffix for the file name. */ void dump_loop (ir_loop *l, const char *suffix); /** Dumps the loop tree over the call graph. * - * See for yourself what you can use this for. - * The filename is "Callgraph_looptree.vcg". + * See for yourself what you can use this for. + * The filename is "Callgraph_looptree.vcg". * - * @arg suffix Suffix to filename. + * @param suffix A suffix for the file name. */ void dump_callgraph_loop_tree(const char *suffix); @@ -355,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 */ @@ -387,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; @@ -404,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. @@ -427,11 +542,13 @@ void dump_types_as_text(unsigned verbosity, const char *suffix); /** Dumps all global variables as text. * - * Dumps a text representation of the entities in the global type. + * @param suffix A suffix for the file name. * - * The file name is the program name (get_irp_name()), or 'TextTypes' - * if the program name is not set, appended by -globals.txt. - * For verbosity see the documentation of the verbosity flags above. + * Dumps a text representation of the entities in the global type. + * + * The file name is the program name (get_irp_name()), or 'TextTypes' + * if the program name is not set, appended by -globals.txt. + * For verbosity see the documentation of the verbosity flags above. */ void dump_globals_as_text(unsigned verbosity, const char *suffix); @@ -441,11 +558,11 @@ void dump_globals_as_text(unsigned verbosity, const char *suffix); /** Output a selected graph. * - * All graph dumpers check this name. If the name is != "" and - * not a prefix of the graph to be dumped, the dumper does not - * dump the graph. + * All graph dumpers check this name. If the name is != "" and + * not a prefix of the graph to be dumped, the dumper does not + * dump the graph. * - * @param name The prefix of the name (not the ld_name) of the method + * @param name The prefix of the name (not the ld_name) of the method * entity to be dumped. */ void only_dump_method_with_name(ident *name); @@ -457,83 +574,114 @@ ident *get_dump_file_filter_ident(void); * prefix of name. */ int is_filtered_dump_name(ident *name); -/** Sets the vcg flag "display_edge_labels" to no. +/** Sets the vcg flag "display_edge_labels" to no. * - * This is necessary as xvcg and aisee both fail to display graphs - * with self-edges if these edges have labels. + * This is necessary as xvcg and aisee both fail to display graphs + * with self-edges if these edges have labels. */ void turn_off_edge_labels(void); /** - * If set to true 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. + * 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_ */