X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;f=ir%2Fdebug%2Fdbginfo.h;h=34445cc5922ecb3cff93445e00f6f14ef3f83c7a;hb=dc30bc05425b79a5c927daf6ca83ba38bcae84ef;hp=137a677ebc41c3a08199266f7c5200412c60ed18;hpb=1fe0a74e03ac1ba1f5d5b8c3de2ab01e0e67251c;p=libfirm diff --git a/ir/debug/dbginfo.h b/ir/debug/dbginfo.h index 137a677eb..34445cc59 100644 --- a/ir/debug/dbginfo.h +++ b/ir/debug/dbginfo.h @@ -1,10 +1,16 @@ /* * Copyright (C) 2001 by Universitaet Karlsruhe * All rights reserved. +*/ + +/** +* @file dbginfo.h * -* Authors: Goetz Lindenmaier +* This is the Firm interface to debugging support. * -* dbginfo: This is the Firm interface to debugging support. Firm requires +* @author Goetz Lindenmaier +* +* Firm requires * a debugging module fulfilling this interface, else no debugging information * is passed to the backend. * The interface requires a datatype representing the debugging information. @@ -39,24 +45,48 @@ typedef struct type type; #endif /** + * @defgroup debug The Firm interface to debugging support. * - * An abstract data type containing information for - * debugging support. - * This datatype is not defined in the firm library, but pointers - * to this type can be stored in firm nodes. + * @{ + */ + +/** + * An abstract data type containing information for + * debugging support. + * + * This datatype is not defined anywere in the firm library, but pointers + * to this type can be stored in firm nodes. */ typedef struct dbg_info dbg_info; -/* Routines to access the field of an ir node containing the - debugging information. */ + +/** + * Sets the debug information of a node. + */ INLINE void set_irn_dbg_info(ir_node *n, dbg_info* db); + +/** + * Returns the debug information of an node. + */ INLINE dbg_info *get_irn_dbg_info(ir_node *n); -/* Routines to access the field of an entity containing the - debugging information. */ + +/** + * Sets the debug information of an entity. + */ INLINE void set_entity_dbg_info(entity *ent, dbg_info* db); + +/** + * Returns the debug information of an entity. + */ INLINE dbg_info *get_entity_dbg_info(entity *ent); -/* Routines to access the field of a type containing the - debugging information. */ + +/** + * Sets the debug information of a type. + */ INLINE void set_type_dbg_info(type *tp, dbg_info* db); + +/** + * Returns the debug information of a type. + */ INLINE dbg_info *get_type_dbg_info(type *tp); /** @@ -70,17 +100,26 @@ typedef enum { dbg_straightening, /**< A Firm subgraph was replaced by a single, existing block. */ dbg_if_simplification, /**< The control flow of an if is changed as either the else, the then or both blocks are empty. */ - dbg_algebraic_simplification, - dbg_write_after_write, - dbg_write_after_read, - dbg_max + dbg_algebraic_simplification, /**< A Firm subgraph was replaced because of an algebraic + simplification. */ + dbg_write_after_write, /**< A Firm subgraph was replaced because of a write + after write optimization. */ + dbg_write_after_read, /**< A Firm subgraph was replaced because of a write + after read optimization. */ + dbg_rem_poly_call, /**< Remove polymorphic call. */ + dbg_max /**< Maximum value. */ + } dbg_action; /** - * converts enum values to strings + * Converts enum values to strings. */ -extern INLINE const char* dbg_action_2_str(dbg_action a) { +#ifdef __GNUC__ +INLINE static const char* dbg_action_2_str(dbg_action) __attribute__ ((unused)); +#endif + +INLINE static const char* dbg_action_2_str(dbg_action a) { switch(a) { case dbg_error: return "dbg_error"; break; case dbg_opt_ssa: return "dbg_opt_ssa"; break; @@ -92,6 +131,7 @@ extern INLINE const char* dbg_action_2_str(dbg_action a) { return "dbg_algebraic_simplification"; break; case dbg_write_after_write: return "dbg_write_after_write"; break; case dbg_write_after_read: return "dbg_write_after_read"; break; + case dbg_rem_poly_call: return "dbg_rem_poly_call"; break; default: if (a <= dbg_max) return "string conversion not implemented"; @@ -103,26 +143,37 @@ extern INLINE const char* dbg_action_2_str(dbg_action a) { /** * The type of the debug info merge function. * + * @param new_node the new ir node + * @param old_node the old ir node + * @param action the action that triggers the merge + * * @see dbg_init() */ -typedef void (merge_pair_func)(ir_node *, ir_node *, dbg_action); +typedef void merge_pair_func(ir_node *new_node, ir_node *old_node, dbg_action action); /** - * The type of the debug info merge function. + * The type of the debug info merge sets function. + * + * @param new_node_array array of new nodes + * @param new_num_entries number of entries in new_node_array + * @param old_node_array array of old nodes + * @param old_num_entries number of entries in old_node_array + * @param action the action that triggers the merge * * @see dbg_init() */ -typedef void (merge_sets_func)(ir_node **, int, ir_node **, int, dbg_action); +typedef void merge_sets_func(ir_node **new_node_array, int new_num_entries, ir_node **old_node_array, int old_num_entries, dbg_action action); /** - * Initializes the debug support. + * Initializes the debug support. * - * @param dbg_info_merge_pair see function description - * @param dbg_info_merge_sets see function description + * @param dbg_info_merge_pair see function description + * @param dbg_info_merge_sets see function description * - * This function takes Pointers to two functions that merge the debug information when a - * transformation of a firm graph is performed. - * Firm transformations call one of these functions. + * This function takes Pointers to two functions that merge the + * debug information when a + * transformation of a firm graph is performed. + * Firm transformations call one of these functions. * * - dbg_info_merge_pair() is called in the following situation: * The optimization replaced the old node by the new one. The new node @@ -138,11 +189,9 @@ typedef void (merge_sets_func)(ir_node **, int, ir_node **, int, dbg_action); * * Further both functions pass an enumeration indicating the action * performed by the transformation, e.g. the kind of optimization performed. - * - * @return No result. - * */ void dbg_init(merge_pair_func *dbg_info_merge_pair, merge_sets_func *dbg_info_merge_sets); +/** @} */ #endif /* _DBGINFO_H_ */