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
26 #ifndef FIRM_COMMON_DEBUG_H
27 #define FIRM_COMMON_DEBUG_H
29 /* WITH DEBUG OUTPUT */
34 enum firm_dbg_level_t {
35 LEVEL_DEFAULT = 0, /**< Prints always. Use with DBG(). */
42 SET_LEVEL_0 = 0, /**< use with firm_dbg_set_mask(). */
48 SET_LEVEL_ALL = SET_LEVEL_5
51 typedef struct firm_dbg_module_t firm_dbg_module_t;
53 /* Internal function to the debug module. */
54 void *_firm_dbg_make_msg(const firm_dbg_module_t *mod, unsigned mask, const char *fmt, ...);
56 /* Internal function to the debug module. */
57 void _firm_dbg_print_msg(const char *filename, int line, const char *func, void *data);
59 /* Internal function to the debug module. */
60 void _firm_dbg_print(const firm_dbg_module_t *mod, unsigned mask, const char *fmt, ...);
63 * Register a module to the firm debug facility.
64 * If the module has already been registered, no new module is allocated
65 * but the handle is returned. By default, all messages go to @c stderr
66 * and the debug mask is set to 0, i.e. the module is muted.
67 * @param name The name of the module to register.
68 * @return The module handle.
70 firm_dbg_module_t *firm_dbg_register(const char *name);
73 * Set the mask of a module.
74 * @param module The module.
75 * @param mask The new mask for the module.
77 void firm_dbg_set_mask(firm_dbg_module_t *module, unsigned mask);
80 * Get the mask of a module.
81 * @param module The module handle.
82 * @return The mask currently used by the module.
84 unsigned firm_dbg_get_mask(const firm_dbg_module_t *module);
87 * Set the output file of a module.
88 * @param module The module handle.
89 * @param file The new file to use by this handle.
91 void firm_dbg_set_file(firm_dbg_module_t *module, FILE *file);
93 #define _DBG_MAIN(func,args) \
94 _firm_dbg_print_msg(__FILE__, __LINE__, func, _firm_dbg_make_msg args)
96 #define _DBG(args) _DBG_MAIN(__func__, args)
97 #define _DB(args) _firm_dbg_print args
100 * Debug messages issued with this macro are always printed, even in
104 #define DBG_RETAIL(args) _DBG(args)
105 #define DB_RETAIL(args) _DB(args)
108 * Issue a debug message.
109 * @param args The arguments.
111 * The arguments is a list surrounded by parentheses. The items
113 * - The module handle as returned by firm_dbg_register().
114 * - The debug mask that you want associate with this message.
115 * - A format string for the message to pass to ir_printf().
116 * - Further optional arguments are passed to ir_printf().
118 * The mask is anded against the module's mask. If both have some bits
119 * in common, the message is issued. If the given mask is 0, the message
120 * is always dumped regardless of the module's mask. You can also use
121 * the mask in a level based manner, see firm_dbg_level_t.
123 * Here is an example:
125 * DBG((my_mod, MASK_ERR, "ir node %n is not green", node))
127 * DBG((my_mod, LEVEL_DEFAULT, "entity %e has type %t", ent, type))
130 #define DBG(args) _DBG(args)
131 #define DB(args) _DB(args)
133 /** create a debug handle in debug mode */
134 #define FIRM_DBG_REGISTER(handle, name) handle = firm_dbg_register(name)
135 #define DEBUG_ONLY(code) code
136 #define RELEASE_ONLY(code)
138 #else /* ndef DEBUG_libfirm */
140 /* DEBUG OUTPUT IS COMPLETELY DISABLED */
142 #define DBG(x) (void)0
143 #define DB(x) (void)0
145 /** create a debug handle in release mode */
146 #define FIRM_DBG_REGISTER(handle, name) (void)0
147 #define DEBUG_ONLY(code)
148 #define RELEASE_ONLY(code) code
150 #define firm_dbg_set_mask(module, mask) (void)0
151 #define firm_dbg_get_mask(module) (void)0
152 #define firm_dbg_set_file(module, file) (void)0
154 #endif /* DEBUG_libfirm */