3 * @author Michael Beck, Sebastian Hack
10 #include "firm_config.h"
14 #include <libcore/debug.h>
16 /* use the newer debug implementation in libcore */
17 typedef dbg_module_t firm_dbg_module_t;
19 extern firm_dbg_module_t *firm_dbg_register(const char *name);
21 #define firm_dbg_set_mask(module, mask) dbg_set_mask(module, mask)
22 #define firm_dbg_get_mask(module) dbg_get_mask(module)
23 #define firm_dbg_set_file(module, file) dbg_set_file(module, file)
26 /* use the builtin debug implementation */
30 enum firm_dbg_level_t {
31 LEVEL_DEFAULT = 0, /**< Prints always. Use with DBG(). */
38 SET_LEVEL_1 = 1, /**< use with firm_dbg_set_mask(). */
45 typedef struct _firm_dbg_module_t firm_dbg_module_t;
47 /* Internal function to the debug module. */
48 void *_firm_dbg_make_msg(const firm_dbg_module_t *mod, unsigned mask, const char *fmt, ...);
50 /* Internal function to the debug module. */
51 void _firm_dbg_print_msg(const char *filename, int line, const char *func, void *data);
54 * Register a module to the firm debug facility.
55 * If the module has already been registered, no new module is allocated
56 * but the handle is returned. By default, all messages go to @c stderr
57 * and the debug mask is set to 0, i.e. the module is muted.
58 * @param name The name of the module to register.
59 * @return The module handle.
61 firm_dbg_module_t *firm_dbg_register(const char *name);
64 * Set the mask of a module.
65 * @param module The module.
66 * @param mask The new mask for the module.
68 void firm_dbg_set_mask(firm_dbg_module_t *module, unsigned mask);
71 * Get the mask of a module.
72 * @param module The module handle.
73 * @return The mask currently used by the module.
75 unsigned firm_dbg_get_mask(const firm_dbg_module_t *module);
78 * Set the output file of a module.
79 * @param module The module handle.
80 * @param file The new file to use by this handle.
82 void firm_dbg_set_file(firm_dbg_module_t *module, FILE *file);
84 #define _DBG_MAIN(func,args) \
85 _firm_dbg_print_msg(__FILE__, __LINE__, func, _firm_dbg_make_msg args)
87 /* If we have C99 use the __func__ variable for calling functions name. */
88 #if defined(__STD_VERSION__) && __STD_VERSION >= 199901L
89 #define _DBG(args) _DBG_MAIN(__func__, args)
92 /* Else, check for gcc and use the proprietary __FUNCTION__ macro. */
94 #define _DBG(args) _DBG_MAIN(__FUNCTION__, args)
97 /* Else go without the name of the calling function. */
98 #define _DBG(args) _DBG_MAIN("", args)
103 * Debug messages issued with this macro are always printed, even in
107 #define DBG_RETAIL(args) _DBG(args)
112 * Issue a debug message.
113 * @param args The arguments.
115 * The arguments is a list surrounded by parentheses. The items
117 * - The module handle as returned by firm_dbg_register().
118 * - The debug mask that you want associate with this message.
119 * - A format string for the message to pass to ir_printf().
120 * - Further optional arguments are passed to ir_printf().
122 * The mask is anded against the module's mask. If both have some bits
123 * in common, the message is issued. If the given mask is 0, the message
124 * is always dumped regardless of the module's mask. You can also use
125 * the mask in a level based manner, see firm_dbg_level_t.
127 * Here is an example:
129 * DBG((my_mod, MASK_ERR, "ir node %n is not green", node))
131 * DBG((my_mod, LEVEL_DEFAULT, "entity %e has type %t", ent, type))
134 #define DBG(args) _DBG(args)
140 #endif /* WITH_LIBCORE */
142 #endif /* _FIRM_DEBUG_H */