2 * wpa_supplicant/hostapd / Debug prints
3 * Copyright (c) 2002-2007, Jouni Malinen <j@w1.fi>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2 as
7 * published by the Free Software Foundation.
9 * Alternatively, this software may be distributed under the terms of BSD
12 * See README and COPYING for more details.
20 /* Debugging function - conditional printf and hex dump. Driver wrappers can
21 * use these for debugging purposes. */
23 enum { MSG_MSGDUMP, MSG_DEBUG, MSG_INFO, MSG_WARNING, MSG_ERROR };
25 #ifdef CONFIG_ANDROID_LOG
27 #define wpa_debug_print_timestamp() do {} while (0)
28 #define wpa_hexdump(...) do {} while (0)
29 #define wpa_hexdump_key(...) do {} while (0)
30 #define wpa_hexdump_buf(l,t,b) do {} while (0)
31 #define wpa_hexdump_buf_key(l,t,b) do {} while (0)
32 #define wpa_hexdump_ascii(...) do {} while (0)
33 #define wpa_hexdump_ascii_key(...) do {} while (0)
34 #define wpa_debug_open_file(...) do {} while (0)
35 #define wpa_debug_close_file() do {} while (0)
37 void android_printf(int level, char *format, ...);
39 #define wpa_printf(level, ...) \
41 if ((level) >= MSG_DEBUG) { \
42 android_printf((level), __VA_ARGS__); \
46 #else /* CONFIG_ANDROID_LOG */
48 #ifdef CONFIG_NO_STDOUT_DEBUG
50 #define wpa_debug_print_timestamp() do { } while (0)
51 #define wpa_printf(args...) do { } while (0)
52 #define wpa_hexdump(l,t,b,le) do { } while (0)
53 #define wpa_hexdump_buf(l,t,b) do { } while (0)
54 #define wpa_hexdump_key(l,t,b,le) do { } while (0)
55 #define wpa_hexdump_buf_key(l,t,b) do { } while (0)
56 #define wpa_hexdump_ascii(l,t,b,le) do { } while (0)
57 #define wpa_hexdump_ascii_key(l,t,b,le) do { } while (0)
58 #define wpa_debug_open_file(p) do { } while (0)
59 #define wpa_debug_close_file() do { } while (0)
61 #else /* CONFIG_NO_STDOUT_DEBUG */
63 int wpa_debug_open_file(const char *path);
64 void wpa_debug_close_file(void);
67 * wpa_debug_printf_timestamp - Print timestamp for debug output
69 * This function prints a timestamp in seconds_from_1970.microsoconds
70 * format if debug output has been configured to include timestamps in debug
73 void wpa_debug_print_timestamp(void);
76 * wpa_printf - conditional printf
77 * @level: priority level (MSG_*) of the message
78 * @fmt: printf format string, followed by optional arguments
80 * This function is used to print conditional debugging and error messages. The
81 * output may be directed to stdout, stderr, and/or syslog based on
84 * Note: New line '\n' is added to the end of the text when printing to stdout.
86 void wpa_printf(int level, char *fmt, ...)
90 * wpa_hexdump - conditional hex dump
91 * @level: priority level (MSG_*) of the message
92 * @title: title of for the message
93 * @buf: data buffer to be dumped
94 * @len: length of the buf
96 * This function is used to print conditional debugging and error messages. The
97 * output may be directed to stdout, stderr, and/or syslog based on
98 * configuration. The contents of buf is printed out has hex dump.
100 void wpa_hexdump(int level, const char *title, const u8 *buf, size_t len);
102 static inline void wpa_hexdump_buf(int level, const char *title,
103 const struct wpabuf *buf)
105 wpa_hexdump(level, title, wpabuf_head(buf), wpabuf_len(buf));
109 * wpa_hexdump_key - conditional hex dump, hide keys
110 * @level: priority level (MSG_*) of the message
111 * @title: title of for the message
112 * @buf: data buffer to be dumped
113 * @len: length of the buf
115 * This function is used to print conditional debugging and error messages. The
116 * output may be directed to stdout, stderr, and/or syslog based on
117 * configuration. The contents of buf is printed out has hex dump. This works
118 * like wpa_hexdump(), but by default, does not include secret keys (passwords,
119 * etc.) in debug output.
121 void wpa_hexdump_key(int level, const char *title, const u8 *buf, size_t len);
123 static inline void wpa_hexdump_buf_key(int level, const char *title,
124 const struct wpabuf *buf)
126 wpa_hexdump_key(level, title, wpabuf_head(buf), wpabuf_len(buf));
130 * wpa_hexdump_ascii - conditional hex dump
131 * @level: priority level (MSG_*) of the message
132 * @title: title of for the message
133 * @buf: data buffer to be dumped
134 * @len: length of the buf
136 * This function is used to print conditional debugging and error messages. The
137 * output may be directed to stdout, stderr, and/or syslog based on
138 * configuration. The contents of buf is printed out has hex dump with both
139 * the hex numbers and ASCII characters (for printable range) are shown. 16
140 * bytes per line will be shown.
142 void wpa_hexdump_ascii(int level, const char *title, const u8 *buf,
146 * wpa_hexdump_ascii_key - conditional hex dump, hide keys
147 * @level: priority level (MSG_*) of the message
148 * @title: title of for the message
149 * @buf: data buffer to be dumped
150 * @len: length of the buf
152 * This function is used to print conditional debugging and error messages. The
153 * output may be directed to stdout, stderr, and/or syslog based on
154 * configuration. The contents of buf is printed out has hex dump with both
155 * the hex numbers and ASCII characters (for printable range) are shown. 16
156 * bytes per line will be shown. This works like wpa_hexdump_ascii(), but by
157 * default, does not include secret keys (passwords, etc.) in debug output.
159 void wpa_hexdump_ascii_key(int level, const char *title, const u8 *buf,
162 #endif /* CONFIG_NO_STDOUT_DEBUG */
164 #endif /* CONFIG_ANDROID_LOG */
166 #ifdef CONFIG_NO_WPA_MSG
167 #define wpa_msg(args...) do { } while (0)
168 #define wpa_msg_register_cb(f) do { } while (0)
169 #else /* CONFIG_NO_WPA_MSG */
171 * wpa_msg - Conditional printf for default target and ctrl_iface monitors
172 * @ctx: Pointer to context data; this is the ctx variable registered
173 * with struct wpa_driver_ops::init()
174 * @level: priority level (MSG_*) of the message
175 * @fmt: printf format string, followed by optional arguments
177 * This function is used to print conditional debugging and error messages. The
178 * output may be directed to stdout, stderr, and/or syslog based on
179 * configuration. This function is like wpa_printf(), but it also sends the
180 * same message to all attached ctrl_iface monitors.
182 * Note: New line '\n' is added to the end of the text when printing to stdout.
184 void wpa_msg(void *ctx, int level, char *fmt, ...) PRINTF_FORMAT(3, 4);
186 typedef void (*wpa_msg_cb_func)(void *ctx, int level, const char *txt,
190 * wpa_msg_register_cb - Register callback function for wpa_msg() messages
191 * @func: Callback function (%NULL to unregister)
193 void wpa_msg_register_cb(wpa_msg_cb_func func);
194 #endif /* CONFIG_NO_WPA_MSG */
197 #ifdef CONFIG_NO_HOSTAPD_LOGGER
198 #define hostapd_logger(args...) do { } while (0)
199 #define hostapd_logger_register_cb(f) do { } while (0)
200 #else /* CONFIG_NO_HOSTAPD_LOGGER */
201 void hostapd_logger(void *ctx, const u8 *addr, unsigned int module, int level,
202 const char *fmt, ...) PRINTF_FORMAT(5, 6);
204 typedef void (*hostapd_logger_cb_func)(void *ctx, const u8 *addr,
205 unsigned int module, int level,
206 const char *txt, size_t len);
209 * hostapd_logger_register_cb - Register callback function for hostapd_logger()
210 * @func: Callback function (%NULL to unregister)
212 void hostapd_logger_register_cb(hostapd_logger_cb_func func);
213 #endif /* CONFIG_NO_HOSTAPD_LOGGER */
215 #define HOSTAPD_MODULE_IEEE80211 0x00000001
216 #define HOSTAPD_MODULE_IEEE8021X 0x00000002
217 #define HOSTAPD_MODULE_RADIUS 0x00000004
218 #define HOSTAPD_MODULE_WPA 0x00000008
219 #define HOSTAPD_MODULE_DRIVER 0x00000010
220 #define HOSTAPD_MODULE_IAPP 0x00000020
221 #define HOSTAPD_MODULE_MLME 0x00000040
223 enum hostapd_logger_level {
224 HOSTAPD_LEVEL_DEBUG_VERBOSE = 0,
225 HOSTAPD_LEVEL_DEBUG = 1,
226 HOSTAPD_LEVEL_INFO = 2,
227 HOSTAPD_LEVEL_NOTICE = 3,
228 HOSTAPD_LEVEL_WARNING = 4
234 #define WPA_ASSERT(a) \
237 printf("WPA_ASSERT FAILED '" #a "' " \
239 __FUNCTION__, __FILE__, __LINE__); \
244 #define WPA_ASSERT(a) do { } while (0)
247 #endif /* WPA_DEBUG_H */