/*
-** Copyright (C) 2001 by Universitaet Karlsruhe
-** All rights reserved.
-**
-** Authors: Goetz Lindenmaier
-**
-** dbginfo: This is the Firm interface to debugging support. 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.
-** Firm supports administrating a reference to the debug information
-** in every firm node. Further Firm optimizations call routines to
-** propagate debug information from old nodes to new nodes if the optimization
-** replaces the old ones by the new ones.
-**
-*/
-
-/* $Id$ */
-
-# ifndef _DBGINFO_H_
-# define _DBGINFO_H_
+ * Project: libFIRM
+ * File name: ir/debug/dbginfo.h
+ * Purpose: Implements the Firm interface to debug information.
+ * Author: Goetz Lindenmaier
+ * Modified by: Michael Beck
+ * Created: 2001
+ * CVS-ID: $Id$
+ * Copyright: (c) 2001-2003 Universität Karlsruhe
+ * Licence: This file protected by GPL - GNU GENERAL PUBLIC LICENSE.
+ */
-#include "ident.h"
+/**
+ * @file dbginfo.h
+ *
+ * This is the Firm interface to debugging support.
+ *
+ * @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. Firm supports administrating a reference to the debug
+ * information in every firm node. Further Firm optimizations call
+ * routines to propagate debug information from old nodes to new nodes
+ * if the optimization replaces the old ones by the new ones.
+ *
+ */
-#ifndef _IR_NODE_TYPEDEF_
-#define _IR_NODE_TYPEDEF_
-typedef struct ir_node ir_node;
-#endif
+#ifndef _DBGINFO_H_
+#define _DBGINFO_H_
-/* to resolve recursion between entity.h and type.h */
-#ifndef _ENTITY_TYPEDEF_
-#define _ENTITY_TYPEDEF_
-typedef struct entity entity;
-#endif
+#include "firm_types.h"
+#include "ident.h"
-#ifndef _TYPE_TYPEDEF_
-#define _TYPE_TYPEDEF_
-typedef struct type type;
+#ifdef __cplusplus
+extern "C" {
#endif
-/****s* dbginfo/dbg_info
+/**
+ * @defgroup debug The Firm interface to debugging support.
+ *
+ * @{
+ */
+
+/**
+ * An abstract data type containing information for
+ * debugging support.
*
- * NAME
- * dbg_info - An abstract data type containing information for
- * debugging support.
- * NOTE
- * This datatype is not defined in the firm library, but pointers
- * to this type can be stored in firm nodes.
- * SEE ALSO
- * SOURCE
+ * This opaque data type is not defined anywhere 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. */
-INLINE void set_irn_dbg_info(ir_node *n, dbg_info* db);
-INLINE dbg_info *get_irn_dbg_info(ir_node *n);
-/* Routines to access the field of an entity containing the
- debugging information. */
-INLINE void set_entity_dbg_info(entity *ent, dbg_info* db);
-INLINE dbg_info *get_entity_dbg_info(entity *ent);
-/* Routines to access the field of a type containing the
- debugging information. */
-INLINE void set_type_dbg_info(type *tp, dbg_info* db);
-INLINE dbg_info *get_type_dbg_info(type *tp);
-/*****/
-
-/****s* dbginfo/dbg_action
- *
- * NAME
- * dbg_action - An enumeration indicating the action performed by a
- * transformation.
- * NOTE
- * SOURCE
+
+/**
+ * Sets the debug information of a node.
+ */
+void set_irn_dbg_info(ir_node *n, dbg_info *db);
+
+/**
+ * Returns the debug information of an node.
+ */
+dbg_info *get_irn_dbg_info(const ir_node *n);
+
+/**
+ * Sets the debug information of an entity.
+ */
+void set_entity_dbg_info(entity *ent, dbg_info *db);
+
+/**
+ * Returns the debug information of an entity.
+ */
+dbg_info *get_entity_dbg_info(entity *ent);
+
+/**
+ * Sets the debug information of a type.
+ */
+void set_type_dbg_info(ir_type *tp, dbg_info *db);
+
+/**
+ * Returns the debug information of a type.
+ */
+dbg_info *get_type_dbg_info(ir_type *tp);
+
+/**
+ * An enumeration indicating the action performed by a transformation.
*/
typedef enum {
dbg_error = 0,
- dbg_opt_ssa, /* Optimization of the SSA representation, e.g., removal
- of superfluent phi nodes. */
- dbg_opt_auxnode, /* Removal of unnecessary auxilliary nodes. */
- dbg_const_eval, /* A Firm subgraph was evaluated to a single constant. */
- 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_opt_ssa, /**< Optimization of the SSA representation, e.g., removal of superfluent phi nodes. */
+ dbg_opt_auxnode, /**< Removal of unnecessary auxiliary nodes. */
+ dbg_const_eval, /**< A Firm subgraph was evaluated to a single constant. */
+ dbg_opt_cse, /**< A Firm node was replaced due to common subexpression elimination. */
+ 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, /**< 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_read_after_write, /**< A Firm subgraph was replaced because of a read
+ after write optimization. */
+ dbg_read_after_read, /**< A Firm subgraph was replaced because of a read
+ after read optimization. */
+ dbg_read_a_const, /**< A Firm subgraph was replaced because of a read
+ a constant optimization. */
+ dbg_rem_poly_call, /**< Remove polymorphic call. */
+ dbg_dead_code, /**< Removing unreachable code, I.e. blocks that are never executed. */
+ dbg_opt_confirm, /**< A Firm subgraph was replace because of a Confirmation */
+ dbg_backend, /**< Backend transformation */
+ dbg_max /**< Maximum value. */
} dbg_action;
-/*****/
-
-
-/****f* dbginfo/dbg_action_2_str
- *
- * NAME
- * dbg_action_2_str - converts enum to string
- * SYNOPSIS
- * INPUTS
- * RESULT
- ***
- */
-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;
- case dbg_opt_auxnode: return "dbg_opt_auxnode"; break;
- case dbg_const_eval: return "dbg_const_eval"; break;
- case dbg_straightening: return "dbg_straightening"; break;
- case dbg_if_simplification: return "dbg_if_simplification"; break;
- case dbg_algebraic_simplification:
- 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;
- default:
- if (a <= dbg_max)
- return "string conversion not implemented";
- else
- assert(0);
- }
-}
+/**
+ * Converts a debug_action into a string.
+ *
+ * @param a the debug action
+ */
+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 *new_node, ir_node *old_node, dbg_action action);
-/****f* dbginfo/dbg_init
+/**
+ * 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 **new_node_array, int new_num_entries, ir_node **old_node_array, int old_num_entries, dbg_action action);
+
+/**
+ * The type of the debug info to human readable string function.
+ *
+ * @param buf pointer to a buffer that will hold the info
+ * @param len length of the buffer
+ * @param dbg the debug info
+ *
+ * @return Number of written characters to the buffer.
+ *
+ * @see dbg_init()
+ */
+typedef unsigned snprint_dbg_func(char *buf, unsigned len, const dbg_info *dbg);
+
+/**
+ * Initializes the debug support.
+ *
+ * @param dbg_info_merge_pair see function description
+ * @param dbg_info_merge_sets see function description
+ * @param snprint_dbg 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.
*
- * NAME
- * dbg_init - initializes the debug support.
- * SYNOPSIS
- * void dbg_init( void (merge_pair)(ir_node *nw, ir_node *old, dbg_action info),
- * void (merge_sets)(ir_node **new_nodes, int n_new_nodes,
- * ir_node **old_nodes, int n_old_nodes,
- * dbg_action info));
- * INPUTS
- * 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
* might be a recent allocated node not containing any debug information,
* semantics.
* - dbg_info_merge_sets() is called in the following situation:
* The optimization replaced a subgraph by another subgraph. There is no
- * obviouse mapping between single nodes in both subgraphs. The optimization
+ * obviously mapping between single nodes in both subgraphs. The optimization
* simply passes two lists to the debug module, one containing the nodes in
* the old subgraph, the other containing the nodes in the new subgraph.
* The same node can be in both lists.
+ *
* Further both functions pass an enumeration indicating the action
* performed by the transformation, e.g. the kind of optimization performed.
- * RESULT
- * No result.
- ***
+ *
+ * The third argument snprint_dbg is called to convert a debug info into a human readable string.
+ * This string is the dumped in the dumper functions.
+ *
+ * Note that if NULL is passed for dbg_info_merge_pair or dbg_info_merge_sets, the default
+ * implementations default_dbg_info_merge_pair() and default_dbg_info_merge_sets() are used.
+ * NULL passed for snprint_dbg means no output.
*/
+void dbg_init(merge_pair_func *dbg_info_merge_pair, merge_sets_func *dbg_info_merge_sets, snprint_dbg_func *snprint_dbg);
+/** @} */
-typedef void (merge_pair_func)(ir_node *, ir_node *, dbg_action);
-typedef void (merge_sets_func)(ir_node **, int, ir_node **, int, dbg_action);
+/**
+ * The default merge_pair_func implementation, simply copies the debug info
+ * from old to new.
+ */
+void default_dbg_info_merge_pair(ir_node *nw, ir_node *old, dbg_action info);
-void dbg_init(merge_pair_func *mpf, merge_sets_func *msf);
+/**
+ * The default merge_sets_func implementation, does nothing
+ */
+void default_dbg_info_merge_sets(ir_node **new_nodes, int n_new_nodes,
+ ir_node **old_nodes, int n_old_nodes,
+ dbg_action info);
+#ifdef __cplusplus
+}
+#endif
#endif /* _DBGINFO_H_ */
projects / libfirm / blobdiff