LMS 2012
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
wpa_debug.h File Reference
#include "wpabuf.h"

Go to the source code of this file.

Macros

#define HOSTAPD_MODULE_IEEE80211   0x00000001
 
#define HOSTAPD_MODULE_IEEE8021X   0x00000002
 
#define HOSTAPD_MODULE_RADIUS   0x00000004
 
#define HOSTAPD_MODULE_WPA   0x00000008
 
#define HOSTAPD_MODULE_DRIVER   0x00000010
 
#define HOSTAPD_MODULE_IAPP   0x00000020
 
#define HOSTAPD_MODULE_MLME   0x00000040
 
#define WPA_ASSERT(a)   do { } while (0)
 

Enumerations

enum  {
  MSG_MSGDUMP, MSG_DEBUG, MSG_INFO, MSG_WARNING,
  MSG_ERROR
}
 
enum  hostapd_logger_level {
  HOSTAPD_LEVEL_DEBUG_VERBOSE = 0, HOSTAPD_LEVEL_DEBUG = 1, HOSTAPD_LEVEL_INFO = 2, HOSTAPD_LEVEL_NOTICE = 3,
  HOSTAPD_LEVEL_WARNING = 4
}
 

Functions

int wpa_debug_open_file (const char *path)
 
void wpa_debug_close_file (void)
 
void wpa_debug_print_timestamp (void)
 
void wpa_printf (int level, const char *fmt,...) PRINTF_FORMAT(2
 
void void wpa_hexdump (int level, const char *title, const u8 *buf, size_t len)
 
void wpa_hexdump_key (int level, const char *title, const u8 *buf, size_t len)
 
void wpa_hexdump_ascii (int level, const char *title, const u8 *buf, size_t len)
 
void wpa_hexdump_ascii_key (int level, const char *title, const u8 *buf, size_t len)
 
void wpa_msg (void *ctx, int level, const char *fmt,...) PRINTF_FORMAT(3
 
void void wpa_msg_ctrl (void *ctx, int level, const char *fmt,...) PRINTF_FORMAT(3
 
void wpa_msg_register_cb (wpa_msg_cb_func func)
 
void hostapd_logger (void *ctx, const u8 *addr, unsigned int module, int level, const char *fmt,...) PRINTF_FORMAT(5
 
void hostapd_logger_register_cb (hostapd_logger_cb_func func)
 

Variables

void void typedef void(* wpa_msg_cb_func )(void *ctx, int level, const char *txt, size_t len)
 
void typedef void(* hostapd_logger_cb_func )(void *ctx, const u8 *addr, unsigned int module, int level, const char *txt, size_t len)
 

Macro Definition Documentation

#define HOSTAPD_MODULE_DRIVER   0x00000010

Definition at line 211 of file wpa_debug.h.

#define HOSTAPD_MODULE_IAPP   0x00000020

Definition at line 212 of file wpa_debug.h.

#define HOSTAPD_MODULE_IEEE80211   0x00000001

Definition at line 207 of file wpa_debug.h.

#define HOSTAPD_MODULE_IEEE8021X   0x00000002

Definition at line 208 of file wpa_debug.h.

#define HOSTAPD_MODULE_MLME   0x00000040

Definition at line 213 of file wpa_debug.h.

#define HOSTAPD_MODULE_RADIUS   0x00000004

Definition at line 209 of file wpa_debug.h.

#define HOSTAPD_MODULE_WPA   0x00000008

Definition at line 210 of file wpa_debug.h.

#define WPA_ASSERT (   a)    do { } while (0)

Definition at line 253 of file wpa_debug.h.

Enumeration Type Documentation

anonymous enum
Enumerator
MSG_MSGDUMP 
MSG_DEBUG 
MSG_INFO 
MSG_WARNING 
MSG_ERROR 

Definition at line 23 of file wpa_debug.h.

Enumerator
HOSTAPD_LEVEL_DEBUG_VERBOSE 
HOSTAPD_LEVEL_DEBUG 
HOSTAPD_LEVEL_INFO 
HOSTAPD_LEVEL_NOTICE 
HOSTAPD_LEVEL_WARNING 

Definition at line 215 of file wpa_debug.h.

Function Documentation

void hostapd_logger ( void *  ctx,
const u8 addr,
unsigned int  module,
int  level,
const char *  fmt,
  ... 
)
void hostapd_logger_register_cb ( hostapd_logger_cb_func  func)

hostapd_logger_register_cb - Register callback function for hostapd_logger() : Callback function (NULL to unregister)

void wpa_debug_close_file ( void  )
int wpa_debug_open_file ( const char *  path)
void wpa_debug_print_timestamp ( void  )

wpa_debug_printf_timestamp - Print timestamp for debug output

This function prints a timestamp in seconds_from_1970.microsoconds format if debug output has been configured to include timestamps in debug messages.

void void wpa_hexdump ( int  level,
const char *  title,
const u8 buf,
size_t  len 
)

wpa_hexdump - conditional hex dump : priority level (MSG_*) of the message : title of for the message : data buffer to be dumped : length of the buf

This function is used to print conditional debugging and error messages. The output may be directed to stdout, stderr, and/or syslog based on configuration. The contents of buf is printed out has hex dump.

void wpa_hexdump_ascii ( int  level,
const char *  title,
const u8 buf,
size_t  len 
)

wpa_hexdump_ascii - conditional hex dump : priority level (MSG_*) of the message : title of for the message : data buffer to be dumped : length of the buf

This function is used to print conditional debugging and error messages. The output may be directed to stdout, stderr, and/or syslog based on configuration. The contents of buf is printed out has hex dump with both the hex numbers and ASCII characters (for printable range) are shown. 16 bytes per line will be shown.

void wpa_hexdump_ascii_key ( int  level,
const char *  title,
const u8 buf,
size_t  len 
)

wpa_hexdump_ascii_key - conditional hex dump, hide keys : priority level (MSG_*) of the message : title of for the message : data buffer to be dumped : length of the buf

This function is used to print conditional debugging and error messages. The output may be directed to stdout, stderr, and/or syslog based on configuration. The contents of buf is printed out has hex dump with both the hex numbers and ASCII characters (for printable range) are shown. 16 bytes per line will be shown. This works like wpa_hexdump_ascii(), but by default, does not include secret keys (passwords, etc.) in debug output.

void wpa_hexdump_key ( int  level,
const char *  title,
const u8 buf,
size_t  len 
)

wpa_hexdump_key - conditional hex dump, hide keys : priority level (MSG_*) of the message : title of for the message : data buffer to be dumped : length of the buf

This function is used to print conditional debugging and error messages. The output may be directed to stdout, stderr, and/or syslog based on configuration. The contents of buf is printed out has hex dump. This works like wpa_hexdump(), but by default, does not include secret keys (passwords, etc.) in debug output.

void wpa_msg ( void *  ctx,
int  level,
const char *  fmt,
  ... 
)

wpa_msg - Conditional printf for default target and ctrl_iface monitors : Pointer to context data; this is the ctx variable registered with struct wpa_driver_ops::init() : priority level (MSG_*) of the message : printf format string, followed by optional arguments

This function is used to print conditional debugging and error messages. The output may be directed to stdout, stderr, and/or syslog based on configuration. This function is like wpa_printf(), but it also sends the same message to all attached ctrl_iface monitors.

Note: New line '
' is added to the end of the text when printing to stdout.

void void wpa_msg_ctrl ( void *  ctx,
int  level,
const char *  fmt,
  ... 
)

wpa_msg_ctrl - Conditional printf for ctrl_iface monitors : Pointer to context data; this is the ctx variable registered with struct wpa_driver_ops::init() : priority level (MSG_*) of the message : printf format string, followed by optional arguments

This function is used to print conditional debugging and error messages. This function is like wpa_msg(), but it sends the output only to the attached ctrl_iface monitors. In other words, it can be used for frequent events that do not need to be sent to syslog.

void wpa_msg_register_cb ( wpa_msg_cb_func  func)

wpa_msg_register_cb - Register callback function for wpa_msg() messages : Callback function (NULL to unregister)

void wpa_printf ( int  level,
const char *  fmt,
  ... 
)

wpa_printf - conditional printf : priority level (MSG_*) of the message : printf format string, followed by optional arguments

This function is used to print conditional debugging and error messages. The output may be directed to stdout, stderr, and/or syslog based on configuration.

Note: New line '
' is added to the end of the text when printing to stdout.

Variable Documentation

void typedef void(* hostapd_logger_cb_func)(void *ctx, const u8 *addr, unsigned int module, int level, const char *txt, size_t len)

Definition at line 196 of file wpa_debug.h.

void void typedef void(* wpa_msg_cb_func)(void *ctx, int level, const char *txt, size_t len)

Definition at line 178 of file wpa_debug.h.