2 * Copyright (C) 1995-2008 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
6 * This file may be distributed and/or modified under the terms of the
7 * GNU General Public License version 2 as published by the Free Software
8 * Foundation and appearing in the file LICENSE.GPL included in the
9 * packaging of this file.
11 * Licensees holding valid libFirm Professional Edition licenses may use
12 * this file in accordance with the libFirm Commercial License.
13 * Agreement provided with the Software.
15 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * @brief Debug facility.
23 * @author Michael Beck, Sebastian Hack
27 #ifndef FIRM_COMMON_DEBUG_H
28 #define FIRM_COMMON_DEBUG_H
30 #include "firm_config.h"
32 /* WITH DEBUG OUTPUT */
37 enum firm_dbg_level_t {
38 LEVEL_DEFAULT = 0, /**< Prints always. Use with DBG(). */
45 SET_LEVEL_0 = 0, /**< use with firm_dbg_set_mask(). */
51 SET_LEVEL_ALL = SET_LEVEL_5
54 typedef struct _firm_dbg_module_t firm_dbg_module_t;
56 /* Internal function to the debug module. */
57 void *_firm_dbg_make_msg(const firm_dbg_module_t *mod, unsigned mask, const char *fmt, ...);
59 /* Internal function to the debug module. */
60 void _firm_dbg_print_msg(const char *filename, int line, const char *func, void *data);
62 /* Internal function to the debug module. */
63 void _firm_dbg_print(const firm_dbg_module_t *mod, unsigned mask, const char *fmt, ...);
66 * Register a module to the firm debug facility.
67 * If the module has already been registered, no new module is allocated
68 * but the handle is returned. By default, all messages go to @c stderr
69 * and the debug mask is set to 0, i.e. the module is muted.
70 * @param name The name of the module to register.
71 * @return The module handle.
73 firm_dbg_module_t *firm_dbg_register(const char *name);
76 * Set the mask of a module.
77 * @param module The module.
78 * @param mask The new mask for the module.
80 void firm_dbg_set_mask(firm_dbg_module_t *module, unsigned mask);
83 * Get the mask of a module.
84 * @param module The module handle.
85 * @return The mask currently used by the module.
87 unsigned firm_dbg_get_mask(const firm_dbg_module_t *module);
90 * Set the output file of a module.
91 * @param module The module handle.
92 * @param file The new file to use by this handle.
94 void firm_dbg_set_file(firm_dbg_module_t *module, FILE *file);
96 #define _DBG_MAIN(func,args) \
97 _firm_dbg_print_msg(__FILE__, __LINE__, func, _firm_dbg_make_msg args)
99 /* If we have C99 use the __func__ variable for calling functions name. */
100 #if defined(__STD_VERSION__) && __STD_VERSION >= 199901L
101 #define _DBG(args) _DBG_MAIN(__func__, args)
104 /* Else, check for gcc and use the proprietary __FUNCTION__ macro. */
106 #define _DBG(args) _DBG_MAIN(__FUNCTION__, args)
109 /* Else go without the name of the calling function. */
110 #define _DBG(args) _DBG_MAIN("", args)
111 #endif /* __GNUC__ */
112 #endif /* __STD_VERSION__ ... */
114 #define _DB(args) _firm_dbg_print args
117 * Debug messages issued with this macro are always printed, even in
121 #define DBG_RETAIL(args) _DBG(args)
122 #define DB_RETAIL(args) _DB(args)
125 * Issue a debug message.
126 * @param args The arguments.
128 * The arguments is a list surrounded by parentheses. The items
130 * - The module handle as returned by firm_dbg_register().
131 * - The debug mask that you want associate with this message.
132 * - A format string for the message to pass to ir_printf().
133 * - Further optional arguments are passed to ir_printf().
135 * The mask is anded against the module's mask. If both have some bits
136 * in common, the message is issued. If the given mask is 0, the message
137 * is always dumped regardless of the module's mask. You can also use
138 * the mask in a level based manner, see firm_dbg_level_t.
140 * Here is an example:
142 * DBG((my_mod, MASK_ERR, "ir node %n is not green", node))
144 * DBG((my_mod, LEVEL_DEFAULT, "entity %e has type %t", ent, type))
147 #define DBG(args) _DBG(args)
148 #define DB(args) _DB(args)
150 /** create a debug handle in debug mode */
151 #define FIRM_DBG_REGISTER(handle, name) handle = firm_dbg_register(name)
152 #define DEBUG_ONLY(code) code
153 #define RELEASE_ONLY(code)
155 #else /* ndef DEBUG_libfirm */
157 /* DEBUG OUTPUT IS COMPLETELY DISABLED */
162 /** create a debug handle in release mode */
163 #define FIRM_DBG_REGISTER(handle, name)
164 #define DEBUG_ONLY(code)
165 #define RELEASE_ONLY(code) code
167 #define firm_dbg_set_mask(module, mask)
168 #define firm_dbg_get_mask(module)
169 #define firm_dbg_set_file(module, file)
171 #endif /* DEBUG_libfirm */