[thirdparty/hostap.git] / src / utils / common.h

/*
 * wpa_supplicant/hostapd / common helper functions, etc.
 * Copyright (c) 2002-2007, Jouni Malinen <j@w1.fi>
 *
 * This software may be distributed under the terms of the BSD license.
 * See README for more details.
 */

#ifndef COMMON_H
#define COMMON_H

#include "os.h"

#if defined(__linux__) || defined(__GLIBC__)
#include <endian.h>
#include <byteswap.h>
#endif /* __linux__ */

#if defined(__FreeBSD__) || defined(__NetBSD__) || defined(__DragonFly__) || \
    defined(__OpenBSD__)
#include <sys/types.h>
#include <sys/endian.h>
#define __BYTE_ORDER	_BYTE_ORDER
#define	__LITTLE_ENDIAN	_LITTLE_ENDIAN
#define	__BIG_ENDIAN	_BIG_ENDIAN
#ifdef __OpenBSD__
#define bswap_16 swap16
#define bswap_32 swap32
#define bswap_64 swap64
#else /* __OpenBSD__ */
#define bswap_16 bswap16
#define bswap_32 bswap32
#define bswap_64 bswap64
#endif /* __OpenBSD__ */
#endif /* defined(__FreeBSD__) || defined(__NetBSD__) ||
	* defined(__DragonFly__) || defined(__OpenBSD__) */

#ifdef __APPLE__
#include <sys/types.h>
#include <machine/endian.h>
#define __BYTE_ORDER	_BYTE_ORDER
#define __LITTLE_ENDIAN	_LITTLE_ENDIAN
#define __BIG_ENDIAN	_BIG_ENDIAN
static inline unsigned short bswap_16(unsigned short v)
{
	return ((v & 0xff) << 8) | (v >> 8);
}

static inline unsigned int bswap_32(unsigned int v)
{
	return ((v & 0xff) << 24) | ((v & 0xff00) << 8) |
		((v & 0xff0000) >> 8) | (v >> 24);
}
#endif /* __APPLE__ */

#ifdef __rtems__
#include <rtems/endian.h>
#define __BYTE_ORDER BYTE_ORDER
#define __LITTLE_ENDIAN LITTLE_ENDIAN
#define __BIG_ENDIAN BIG_ENDIAN
#define bswap_16 CPU_swap_u16
#define bswap_32 CPU_swap_u32
#endif /* __rtems__ */

#ifdef CONFIG_NATIVE_WINDOWS
#include <winsock.h>

typedef int socklen_t;

#ifndef MSG_DONTWAIT
#define MSG_DONTWAIT 0 /* not supported */
#endif

#endif /* CONFIG_NATIVE_WINDOWS */

#ifdef _MSC_VER
#define inline __inline

#undef vsnprintf
#define vsnprintf _vsnprintf
#undef close
#define close closesocket
#endif /* _MSC_VER */


/* Define platform specific integer types */

#ifdef _MSC_VER
typedef UINT64 u64;
typedef UINT32 u32;
typedef UINT16 u16;
typedef UINT8 u8;
typedef INT64 s64;
typedef INT32 s32;
typedef INT16 s16;
typedef INT8 s8;
#define WPA_TYPES_DEFINED
#endif /* _MSC_VER */

#ifdef __vxworks
typedef unsigned long long u64;
typedef UINT32 u32;
typedef UINT16 u16;
typedef UINT8 u8;
typedef long long s64;
typedef INT32 s32;
typedef INT16 s16;
typedef INT8 s8;
#define WPA_TYPES_DEFINED
#endif /* __vxworks */

#ifndef WPA_TYPES_DEFINED
#ifdef CONFIG_USE_INTTYPES_H
#include <inttypes.h>
#else
#include <stdint.h>
#endif
typedef uint64_t u64;
typedef uint32_t u32;
typedef uint16_t u16;
typedef uint8_t u8;
typedef int64_t s64;
typedef int32_t s32;
typedef int16_t s16;
typedef int8_t s8;
#define WPA_TYPES_DEFINED
#endif /* !WPA_TYPES_DEFINED */


/* Define platform specific byte swapping macros */

#if defined(__CYGWIN__) || defined(CONFIG_NATIVE_WINDOWS)

static inline unsigned short wpa_swap_16(unsigned short v)
{
	return ((v & 0xff) << 8) | (v >> 8);
}

static inline unsigned int wpa_swap_32(unsigned int v)
{
	return ((v & 0xff) << 24) | ((v & 0xff00) << 8) |
		((v & 0xff0000) >> 8) | (v >> 24);
}

#define le_to_host16(n) (n)
#define host_to_le16(n) (n)
#define be_to_host16(n) wpa_swap_16(n)
#define host_to_be16(n) wpa_swap_16(n)
#define le_to_host32(n) (n)
#define host_to_le32(n) (n)
#define be_to_host32(n) wpa_swap_32(n)
#define host_to_be32(n) wpa_swap_32(n)
#define host_to_le64(n) (n)

#define WPA_BYTE_SWAP_DEFINED

#endif /* __CYGWIN__ || CONFIG_NATIVE_WINDOWS */


#ifndef WPA_BYTE_SWAP_DEFINED

#ifndef __BYTE_ORDER
#ifndef __LITTLE_ENDIAN
#ifndef __BIG_ENDIAN
#define __LITTLE_ENDIAN 1234
#define __BIG_ENDIAN 4321
#if defined(sparc)
#define __BYTE_ORDER __BIG_ENDIAN
#endif
#endif /* __BIG_ENDIAN */
#endif /* __LITTLE_ENDIAN */
#endif /* __BYTE_ORDER */

#if __BYTE_ORDER == __LITTLE_ENDIAN
#define le_to_host16(n) ((__force u16) (le16) (n))
#define host_to_le16(n) ((__force le16) (u16) (n))
#define be_to_host16(n) bswap_16((__force u16) (be16) (n))
#define host_to_be16(n) ((__force be16) bswap_16((n)))
#define le_to_host32(n) ((__force u32) (le32) (n))
#define host_to_le32(n) ((__force le32) (u32) (n))
#define be_to_host32(n) bswap_32((__force u32) (be32) (n))
#define host_to_be32(n) ((__force be32) bswap_32((n)))
#define le_to_host64(n) ((__force u64) (le64) (n))
#define host_to_le64(n) ((__force le64) (u64) (n))
#define be_to_host64(n) bswap_64((__force u64) (be64) (n))
#define host_to_be64(n) ((__force be64) bswap_64((n)))
#elif __BYTE_ORDER == __BIG_ENDIAN
#define le_to_host16(n) bswap_16(n)
#define host_to_le16(n) bswap_16(n)
#define be_to_host16(n) (n)
#define host_to_be16(n) (n)
#define le_to_host32(n) bswap_32(n)
#define host_to_le32(n) bswap_32(n)
#define be_to_host32(n) (n)
#define host_to_be32(n) (n)
#define le_to_host64(n) bswap_64(n)
#define host_to_le64(n) bswap_64(n)
#define be_to_host64(n) (n)
#define host_to_be64(n) (n)
#ifndef WORDS_BIGENDIAN
#define WORDS_BIGENDIAN
#endif
#else
#error Could not determine CPU byte order
#endif

#define WPA_BYTE_SWAP_DEFINED
#endif /* !WPA_BYTE_SWAP_DEFINED */


/* Macros for handling unaligned memory accesses */

static inline u16 WPA_GET_BE16(const u8 *a)
{
	return (a[0] << 8) | a[1];
}

static inline void WPA_PUT_BE16(u8 *a, u16 val)
{
	a[0] = val >> 8;
	a[1] = val & 0xff;
}

static inline u16 WPA_GET_LE16(const u8 *a)
{
	return (a[1] << 8) | a[0];
}

static inline void WPA_PUT_LE16(u8 *a, u16 val)
{
	a[1] = val >> 8;
	a[0] = val & 0xff;
}

static inline u32 WPA_GET_BE24(const u8 *a)
{
	return (a[0] << 16) | (a[1] << 8) | a[2];
}

static inline void WPA_PUT_BE24(u8 *a, u32 val)
{
	a[0] = (val >> 16) & 0xff;
	a[1] = (val >> 8) & 0xff;
	a[2] = val & 0xff;
}

static inline u32 WPA_GET_BE32(const u8 *a)
{
	return ((u32) a[0] << 24) | (a[1] << 16) | (a[2] << 8) | a[3];
}

static inline void WPA_PUT_BE32(u8 *a, u32 val)
{
	a[0] = (val >> 24) & 0xff;
	a[1] = (val >> 16) & 0xff;
	a[2] = (val >> 8) & 0xff;
	a[3] = val & 0xff;
}

static inline u32 WPA_GET_LE32(const u8 *a)
{
	return ((u32) a[3] << 24) | (a[2] << 16) | (a[1] << 8) | a[0];
}

static inline void WPA_PUT_LE32(u8 *a, u32 val)
{
	a[3] = (val >> 24) & 0xff;
	a[2] = (val >> 16) & 0xff;
	a[1] = (val >> 8) & 0xff;
	a[0] = val & 0xff;
}

static inline u64 WPA_GET_BE64(const u8 *a)
{
	return (((u64) a[0]) << 56) | (((u64) a[1]) << 48) |
		(((u64) a[2]) << 40) | (((u64) a[3]) << 32) |
		(((u64) a[4]) << 24) | (((u64) a[5]) << 16) |
		(((u64) a[6]) << 8) | ((u64) a[7]);
}

static inline void WPA_PUT_BE64(u8 *a, u64 val)
{
	a[0] = val >> 56;
	a[1] = val >> 48;
	a[2] = val >> 40;
	a[3] = val >> 32;
	a[4] = val >> 24;
	a[5] = val >> 16;
	a[6] = val >> 8;
	a[7] = val & 0xff;
}

static inline u64 WPA_GET_LE64(const u8 *a)
{
	return (((u64) a[7]) << 56) | (((u64) a[6]) << 48) |
		(((u64) a[5]) << 40) | (((u64) a[4]) << 32) |
		(((u64) a[3]) << 24) | (((u64) a[2]) << 16) |
		(((u64) a[1]) << 8) | ((u64) a[0]);
}

static inline void WPA_PUT_LE64(u8 *a, u64 val)
{
	a[7] = val >> 56;
	a[6] = val >> 48;
	a[5] = val >> 40;
	a[4] = val >> 32;
	a[3] = val >> 24;
	a[2] = val >> 16;
	a[1] = val >> 8;
	a[0] = val & 0xff;
}


#ifndef ETH_ALEN
#define ETH_ALEN 6
#endif
#ifndef ETH_HLEN
#define ETH_HLEN 14
#endif
#ifndef IFNAMSIZ
#define IFNAMSIZ 16
#endif
#ifndef ETH_P_ALL
#define ETH_P_ALL 0x0003
#endif
#ifndef ETH_P_IP
#define ETH_P_IP 0x0800
#endif
#ifndef ETH_P_80211_ENCAP
#define ETH_P_80211_ENCAP 0x890d /* TDLS comes under this category */
#endif
#ifndef ETH_P_PAE
#define ETH_P_PAE 0x888E /* Port Access Entity (IEEE 802.1X) */
#endif /* ETH_P_PAE */
#ifndef ETH_P_EAPOL
#define ETH_P_EAPOL ETH_P_PAE
#endif /* ETH_P_EAPOL */
#ifndef ETH_P_RSN_PREAUTH
#define ETH_P_RSN_PREAUTH 0x88c7
#endif /* ETH_P_RSN_PREAUTH */
#ifndef ETH_P_RRB
#define ETH_P_RRB 0x890D
#endif /* ETH_P_RRB */
#ifndef ETH_P_OUI
#define ETH_P_OUI 0x88B7
#endif /* ETH_P_OUI */


#ifdef __GNUC__
#define PRINTF_FORMAT(a,b) __attribute__ ((format (printf, (a), (b))))
#define STRUCT_PACKED __attribute__ ((packed))
#else
#define PRINTF_FORMAT(a,b)
#define STRUCT_PACKED
#endif


#ifdef CONFIG_ANSI_C_EXTRA

#if !defined(_MSC_VER) || _MSC_VER < 1400
/* snprintf - used in number of places; sprintf() is _not_ a good replacement
 * due to possible buffer overflow; see, e.g.,
 * http://www.ijs.si/software/snprintf/ for portable implementation of
 * snprintf. */
int snprintf(char *str, size_t size, const char *format, ...);

/* vsnprintf - only used for wpa_msg() in wpa_supplicant.c */
int vsnprintf(char *str, size_t size, const char *format, va_list ap);
#endif /* !defined(_MSC_VER) || _MSC_VER < 1400 */

/* getopt - only used in main.c */
int getopt(int argc, char *const argv[], const char *optstring);
extern char *optarg;
extern int optind;

#ifndef CONFIG_NO_SOCKLEN_T_TYPEDEF
#ifndef __socklen_t_defined
typedef int socklen_t;
#endif
#endif

/* inline - define as __inline or just define it to be empty, if needed */
#ifdef CONFIG_NO_INLINE
#define inline
#else
#define inline __inline
#endif

#ifndef __func__
#define __func__ "__func__ not defined"
#endif

#ifndef bswap_16
#define bswap_16(a) ((((u16) (a) << 8) & 0xff00) | (((u16) (a) >> 8) & 0xff))
#endif

#ifndef bswap_32
#define bswap_32(a) ((((u32) (a) << 24) & 0xff000000) | \
		     (((u32) (a) << 8) & 0xff0000) | \
     		     (((u32) (a) >> 8) & 0xff00) | \
     		     (((u32) (a) >> 24) & 0xff))
#endif

#ifndef MSG_DONTWAIT
#define MSG_DONTWAIT 0
#endif

#ifdef _WIN32_WCE
void perror(const char *s);
#endif /* _WIN32_WCE */

#endif /* CONFIG_ANSI_C_EXTRA */

#ifndef MAC2STR
#define MAC2STR(a) (a)[0], (a)[1], (a)[2], (a)[3], (a)[4], (a)[5]
#define MACSTR "%02x:%02x:%02x:%02x:%02x:%02x"

/*
 * Compact form for string representation of MAC address
 * To be used, e.g., for constructing dbus paths for P2P Devices
 */
#define COMPACT_MACSTR "%02x%02x%02x%02x%02x%02x"
#endif

#ifndef BIT
#define BIT(x) (1U << (x))
#endif

/*
 * Definitions for sparse validation
 * (http://kernel.org/pub/linux/kernel/people/josh/sparse/)
 */
#ifdef __CHECKER__
#define __force __attribute__((force))
#undef __bitwise
#define __bitwise __attribute__((bitwise))
#else
#define __force
#undef __bitwise
#define __bitwise
#endif

typedef u16 __bitwise be16;
typedef u16 __bitwise le16;
typedef u32 __bitwise be32;
typedef u32 __bitwise le32;
typedef u64 __bitwise be64;
typedef u64 __bitwise le64;

#ifndef __must_check
#if __GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 4)
#define __must_check __attribute__((__warn_unused_result__))
#else
#define __must_check
#endif /* __GNUC__ */
#endif /* __must_check */

#ifndef __maybe_unused
#if __GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 4)
#define __maybe_unused __attribute__((unused))
#else
#define __maybe_unused
#endif /* __GNUC__ */
#endif /* __must_check */

#define SSID_MAX_LEN 32

struct wpa_ssid_value {
	u8 ssid[SSID_MAX_LEN];
	size_t ssid_len;
};

int hwaddr_aton(const char *txt, u8 *addr);
int hwaddr_masked_aton(const char *txt, u8 *addr, u8 *mask, u8 maskable);
int hwaddr_compact_aton(const char *txt, u8 *addr);
int hwaddr_aton2(const char *txt, u8 *addr);
int hex2byte(const char *hex);
int hexstr2bin(const char *hex, u8 *buf, size_t len);
void inc_byte_array(u8 *counter, size_t len);
void wpa_get_ntp_timestamp(u8 *buf);
int wpa_scnprintf(char *buf, size_t size, const char *fmt, ...);
int wpa_snprintf_hex_sep(char *buf, size_t buf_size, const u8 *data, size_t len,
			 char sep);
int wpa_snprintf_hex(char *buf, size_t buf_size, const u8 *data, size_t len);
int wpa_snprintf_hex_uppercase(char *buf, size_t buf_size, const u8 *data,
			       size_t len);

int hwaddr_mask_txt(char *buf, size_t len, const u8 *addr, const u8 *mask);
int ssid_parse(const char *buf, struct wpa_ssid_value *ssid);

#ifdef CONFIG_NATIVE_WINDOWS
void wpa_unicode2ascii_inplace(TCHAR *str);
TCHAR * wpa_strdup_tchar(const char *str);
#else /* CONFIG_NATIVE_WINDOWS */
#define wpa_unicode2ascii_inplace(s) do { } while (0)
#define wpa_strdup_tchar(s) strdup((s))
#endif /* CONFIG_NATIVE_WINDOWS */

void printf_encode(char *txt, size_t maxlen, const u8 *data, size_t len);
size_t printf_decode(u8 *buf, size_t maxlen, const char *str);

const char * wpa_ssid_txt(const u8 *ssid, size_t ssid_len);

char * wpa_config_parse_string(const char *value, size_t *len);
int is_hex(const u8 *data, size_t len);
int has_ctrl_char(const u8 *data, size_t len);
int has_newline(const char *str);
size_t merge_byte_arrays(u8 *res, size_t res_len,
			 const u8 *src1, size_t src1_len,
			 const u8 *src2, size_t src2_len);
char * dup_binstr(const void *src, size_t len);

static inline int is_zero_ether_addr(const u8 *a)
{
	return !(a[0] | a[1] | a[2] | a[3] | a[4] | a[5]);
}

static inline int is_broadcast_ether_addr(const u8 *a)
{
	return (a[0] & a[1] & a[2] & a[3] & a[4] & a[5]) == 0xff;
}

static inline int is_multicast_ether_addr(const u8 *a)
{
	return a[0] & 0x01;
}

#define broadcast_ether_addr (const u8 *) "\xff\xff\xff\xff\xff\xff"

#include "wpa_debug.h"


struct wpa_freq_range_list {
	struct wpa_freq_range {
		unsigned int min;
		unsigned int max;
	} *range;
	unsigned int num;
};

int freq_range_list_parse(struct wpa_freq_range_list *res, const char *value);
int freq_range_list_includes(const struct wpa_freq_range_list *list,
			     unsigned int freq);
char * freq_range_list_str(const struct wpa_freq_range_list *list);

int int_array_len(const int *a);
void int_array_concat(int **res, const int *a);
void int_array_sort_unique(int *a);
void int_array_add_unique(int **res, int a);

#define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))

void str_clear_free(char *str);
void bin_clear_free(void *bin, size_t len);

int random_mac_addr(u8 *addr);
int random_mac_addr_keep_oui(u8 *addr);

const char * cstr_token(const char *str, const char *delim, const char **last);
char * str_token(char *str, const char *delim, char **context);
size_t utf8_escape(const char *inp, size_t in_size,
		   char *outp, size_t out_size);
size_t utf8_unescape(const char *inp, size_t in_size,
		     char *outp, size_t out_size);
int is_ctrl_char(char c);

int str_starts(const char *str, const char *start);

u8 rssi_to_rcpi(int rssi);
char * get_param(const char *cmd, const char *param);

/*
 * gcc 4.4 ends up generating strict-aliasing warnings about some very common
 * networking socket uses that do not really result in a real problem and
 * cannot be easily avoided with union-based type-punning due to struct
 * definitions including another struct in system header files. To avoid having
 * to fully disable strict-aliasing warnings, provide a mechanism to hide the
 * typecast from aliasing for now. A cleaner solution will hopefully be found
 * in the future to handle these cases.
 */
void * __hide_aliasing_typecast(void *foo);
#define aliasing_hide_typecast(a,t) (t *) __hide_aliasing_typecast((a))

#ifdef CONFIG_VALGRIND
#include <valgrind/memcheck.h>
#define WPA_MEM_DEFINED(ptr, len) VALGRIND_MAKE_MEM_DEFINED((ptr), (len))
#else /* CONFIG_VALGRIND */
#define WPA_MEM_DEFINED(ptr, len) do { } while (0)
#endif /* CONFIG_VALGRIND */

#endif /* COMMON_H */
Commit	Line	Data
6fc6879b JM	1	/*
	2	* wpa_supplicant/hostapd / common helper functions, etc.
	3	* Copyright (c) 2002-2007, Jouni Malinen <j@w1.fi>
	4	*
0f3d578e JM	5	* This software may be distributed under the terms of the BSD license.
0f3d578e JM	6	* See README for more details.
6fc6879b JM	7	*/
	8
	9	#ifndef COMMON_H
	10	#define COMMON_H
	11
	12	#include "os.h"
	13
09bd6e8c	14	#if defined(__linux__) \|\| defined(__GLIBC__)
6fc6879b JM	15	#include <endian.h>
	16	#include <byteswap.h>
	17	#endif /* __linux__ */
	18
80cc6bf6 MH	19	#if defined(__FreeBSD__) \|\| defined(__NetBSD__) \|\| defined(__DragonFly__) \|\| \
80cc6bf6 MH	20	defined(__OpenBSD__)
6fc6879b JM	21	#include <sys/types.h>
	22	#include <sys/endian.h>
	23	#define __BYTE_ORDER _BYTE_ORDER
	24	#define __LITTLE_ENDIAN _LITTLE_ENDIAN
	25	#define __BIG_ENDIAN _BIG_ENDIAN
80cc6bf6 MH	26	#ifdef __OpenBSD__
	27	#define bswap_16 swap16
	28	#define bswap_32 swap32
	29	#define bswap_64 swap64
	30	#else /* __OpenBSD__ */
6fc6879b JM	31	#define bswap_16 bswap16
	32	#define bswap_32 bswap32
	33	#define bswap_64 bswap64
80cc6bf6	34	#endif /* __OpenBSD__ */
6fc6879b	35	#endif /* defined(__FreeBSD__) \|\| defined(__NetBSD__) \|\|
80cc6bf6	36	* defined(__DragonFly__) \|\| defined(__OpenBSD__) */
6fc6879b JM	37
	38	#ifdef __APPLE__
	39	#include <sys/types.h>
	40	#include <machine/endian.h>
	41	#define __BYTE_ORDER _BYTE_ORDER
	42	#define __LITTLE_ENDIAN _LITTLE_ENDIAN
	43	#define __BIG_ENDIAN _BIG_ENDIAN
	44	static inline unsigned short bswap_16(unsigned short v)
	45	{
	46	return ((v & 0xff) << 8) \| (v >> 8);
	47	}
	48
	49	static inline unsigned int bswap_32(unsigned int v)
	50	{
	51	return ((v & 0xff) << 24) \| ((v & 0xff00) << 8) \|
	52	((v & 0xff0000) >> 8) \| (v >> 24);
	53	}
	54	#endif /* __APPLE__ */
	55
853cfa87 JL	56	#ifdef __rtems__
	57	#include <rtems/endian.h>
	58	#define __BYTE_ORDER BYTE_ORDER
	59	#define __LITTLE_ENDIAN LITTLE_ENDIAN
	60	#define __BIG_ENDIAN BIG_ENDIAN
	61	#define bswap_16 CPU_swap_u16
	62	#define bswap_32 CPU_swap_u32
	63	#endif /* __rtems__ */
	64
6fc6879b JM	65	#ifdef CONFIG_NATIVE_WINDOWS
	66	#include <winsock.h>
	67
	68	typedef int socklen_t;
	69
	70	#ifndef MSG_DONTWAIT
	71	#define MSG_DONTWAIT 0 /* not supported */
	72	#endif
	73
	74	#endif /* CONFIG_NATIVE_WINDOWS */
	75
	76	#ifdef _MSC_VER
	77	#define inline __inline
	78
	79	#undef vsnprintf
	80	#define vsnprintf _vsnprintf
	81	#undef close
	82	#define close closesocket
	83	#endif /* _MSC_VER */
	84
	85
	86	/* Define platform specific integer types */
	87
	88	#ifdef _MSC_VER
	89	typedef UINT64 u64;
	90	typedef UINT32 u32;
	91	typedef UINT16 u16;
	92	typedef UINT8 u8;
	93	typedef INT64 s64;
	94	typedef INT32 s32;
	95	typedef INT16 s16;
	96	typedef INT8 s8;
	97	#define WPA_TYPES_DEFINED
	98	#endif /* _MSC_VER */
	99
	100	#ifdef __vxworks
	101	typedef unsigned long long u64;
	102	typedef UINT32 u32;
	103	typedef UINT16 u16;
	104	typedef UINT8 u8;
	105	typedef long long s64;
	106	typedef INT32 s32;
	107	typedef INT16 s16;
	108	typedef INT8 s8;
	109	#define WPA_TYPES_DEFINED
	110	#endif /* __vxworks */
	111
6fc6879b JM	112	#ifndef WPA_TYPES_DEFINED
	113	#ifdef CONFIG_USE_INTTYPES_H
	114	#include <inttypes.h>
	115	#else
	116	#include <stdint.h>
	117	#endif
	118	typedef uint64_t u64;
	119	typedef uint32_t u32;
	120	typedef uint16_t u16;
	121	typedef uint8_t u8;
	122	typedef int64_t s64;
	123	typedef int32_t s32;
	124	typedef int16_t s16;
	125	typedef int8_t s8;
	126	#define WPA_TYPES_DEFINED
	127	#endif /* !WPA_TYPES_DEFINED */
	128
	129
	130	/* Define platform specific byte swapping macros */
	131
	132	#if defined(__CYGWIN__) \|\| defined(CONFIG_NATIVE_WINDOWS)
	133
	134	static inline unsigned short wpa_swap_16(unsigned short v)
	135	{
	136	return ((v & 0xff) << 8) \| (v >> 8);
	137	}
	138
	139	static inline unsigned int wpa_swap_32(unsigned int v)
	140	{
	141	return ((v & 0xff) << 24) \| ((v & 0xff00) << 8) \|
	142	((v & 0xff0000) >> 8) \| (v >> 24);
	143	}
	144
	145	#define le_to_host16(n) (n)
	146	#define host_to_le16(n) (n)
	147	#define be_to_host16(n) wpa_swap_16(n)
	148	#define host_to_be16(n) wpa_swap_16(n)
	149	#define le_to_host32(n) (n)
6dbbef96	150	#define host_to_le32(n) (n)
6fc6879b JM	151	#define be_to_host32(n) wpa_swap_32(n)
6fc6879b JM	152	#define host_to_be32(n) wpa_swap_32(n)
9ec0dfa3	153	#define host_to_le64(n) (n)
6fc6879b JM	154
	155	#define WPA_BYTE_SWAP_DEFINED
	156
	157	#endif /* __CYGWIN__ \|\| CONFIG_NATIVE_WINDOWS */
	158
	159
	160	#ifndef WPA_BYTE_SWAP_DEFINED
	161
	162	#ifndef __BYTE_ORDER
	163	#ifndef __LITTLE_ENDIAN
	164	#ifndef __BIG_ENDIAN
	165	#define __LITTLE_ENDIAN 1234
	166	#define __BIG_ENDIAN 4321
	167	#if defined(sparc)
	168	#define __BYTE_ORDER __BIG_ENDIAN
	169	#endif
	170	#endif /* __BIG_ENDIAN */
	171	#endif /* __LITTLE_ENDIAN */
	172	#endif /* __BYTE_ORDER */
	173
	174	#if __BYTE_ORDER == __LITTLE_ENDIAN
	175	#define le_to_host16(n) ((__force u16) (le16) (n))
	176	#define host_to_le16(n) ((__force le16) (u16) (n))
	177	#define be_to_host16(n) bswap_16((__force u16) (be16) (n))
	178	#define host_to_be16(n) ((__force be16) bswap_16((n)))
	179	#define le_to_host32(n) ((__force u32) (le32) (n))
	180	#define host_to_le32(n) ((__force le32) (u32) (n))
	181	#define be_to_host32(n) bswap_32((__force u32) (be32) (n))
	182	#define host_to_be32(n) ((__force be32) bswap_32((n)))
	183	#define le_to_host64(n) ((__force u64) (le64) (n))
	184	#define host_to_le64(n) ((__force le64) (u64) (n))
	185	#define be_to_host64(n) bswap_64((__force u64) (be64) (n))
	186	#define host_to_be64(n) ((__force be64) bswap_64((n)))
	187	#elif __BYTE_ORDER == __BIG_ENDIAN
	188	#define le_to_host16(n) bswap_16(n)
	189	#define host_to_le16(n) bswap_16(n)
	190	#define be_to_host16(n) (n)
	191	#define host_to_be16(n) (n)
	192	#define le_to_host32(n) bswap_32(n)
182b2e53	193	#define host_to_le32(n) bswap_32(n)
6fc6879b JM	194	#define be_to_host32(n) (n)
	195	#define host_to_be32(n) (n)
	196	#define le_to_host64(n) bswap_64(n)
	197	#define host_to_le64(n) bswap_64(n)
	198	#define be_to_host64(n) (n)
	199	#define host_to_be64(n) (n)
	200	#ifndef WORDS_BIGENDIAN
	201	#define WORDS_BIGENDIAN
	202	#endif
	203	#else
	204	#error Could not determine CPU byte order
	205	#endif
	206
	207	#define WPA_BYTE_SWAP_DEFINED
	208	#endif /* !WPA_BYTE_SWAP_DEFINED */
	209
	210
	211	/* Macros for handling unaligned memory accesses */
	212
301ed630 JM	213	static inline u16 WPA_GET_BE16(const u8 *a)
	214	{
	215	return (a[0] << 8) \| a[1];
	216	}
	217
	218	static inline void WPA_PUT_BE16(u8 *a, u16 val)
	219	{
	220	a[0] = val >> 8;
	221	a[1] = val & 0xff;
	222	}
	223
	224	static inline u16 WPA_GET_LE16(const u8 *a)
	225	{
	226	return (a[1] << 8) \| a[0];
	227	}
	228
	229	static inline void WPA_PUT_LE16(u8 *a, u16 val)
	230	{
	231	a[1] = val >> 8;
	232	a[0] = val & 0xff;
	233	}
	234
	235	static inline u32 WPA_GET_BE24(const u8 *a)
	236	{
	237	return (a[0] << 16) \| (a[1] << 8) \| a[2];
	238	}
	239
	240	static inline void WPA_PUT_BE24(u8 *a, u32 val)
	241	{
	242	a[0] = (val >> 16) & 0xff;
	243	a[1] = (val >> 8) & 0xff;
	244	a[2] = val & 0xff;
	245	}
	246
	247	static inline u32 WPA_GET_BE32(const u8 *a)
	248	{
476a634d	249	return ((u32) a[0] << 24) \| (a[1] << 16) \| (a[2] << 8) \| a[3];
301ed630 JM	250	}
	251
	252	static inline void WPA_PUT_BE32(u8 *a, u32 val)
	253	{
	254	a[0] = (val >> 24) & 0xff;
	255	a[1] = (val >> 16) & 0xff;
	256	a[2] = (val >> 8) & 0xff;
	257	a[3] = val & 0xff;
	258	}
	259
	260	static inline u32 WPA_GET_LE32(const u8 *a)
	261	{
476a634d	262	return ((u32) a[3] << 24) \| (a[2] << 16) \| (a[1] << 8) \| a[0];
301ed630 JM	263	}
	264
	265	static inline void WPA_PUT_LE32(u8 *a, u32 val)
	266	{
	267	a[3] = (val >> 24) & 0xff;
	268	a[2] = (val >> 16) & 0xff;
	269	a[1] = (val >> 8) & 0xff;
	270	a[0] = val & 0xff;
	271	}
	272
	273	static inline u64 WPA_GET_BE64(const u8 *a)
	274	{
	275	return (((u64) a[0]) << 56) \| (((u64) a[1]) << 48) \|
	276	(((u64) a[2]) << 40) \| (((u64) a[3]) << 32) \|
	277	(((u64) a[4]) << 24) \| (((u64) a[5]) << 16) \|
	278	(((u64) a[6]) << 8) \| ((u64) a[7]);
	279	}
	280
	281	static inline void WPA_PUT_BE64(u8 *a, u64 val)
	282	{
	283	a[0] = val >> 56;
	284	a[1] = val >> 48;
	285	a[2] = val >> 40;
	286	a[3] = val >> 32;
	287	a[4] = val >> 24;
	288	a[5] = val >> 16;
	289	a[6] = val >> 8;
	290	a[7] = val & 0xff;
	291	}
	292
	293	static inline u64 WPA_GET_LE64(const u8 *a)
	294	{
	295	return (((u64) a[7]) << 56) \| (((u64) a[6]) << 48) \|
	296	(((u64) a[5]) << 40) \| (((u64) a[4]) << 32) \|
	297	(((u64) a[3]) << 24) \| (((u64) a[2]) << 16) \|
	298	(((u64) a[1]) << 8) \| ((u64) a[0]);
	299	}
	300
	301	static inline void WPA_PUT_LE64(u8 *a, u64 val)
	302	{
	303	a[7] = val >> 56;
	304	a[6] = val >> 48;
	305	a[5] = val >> 40;
	306	a[4] = val >> 32;
	307	a[3] = val >> 24;
	308	a[2] = val >> 16;
	309	a[1] = val >> 8;
	310	a[0] = val & 0xff;
	311	}
6fc6879b JM	312
	313
	314	#ifndef ETH_ALEN
	315	#define ETH_ALEN 6
	316	#endif
68975564 KP	317	#ifndef ETH_HLEN
	318	#define ETH_HLEN 14
	319	#endif
d994a9b5 JM	320	#ifndef IFNAMSIZ
	321	#define IFNAMSIZ 16
	322	#endif
	323	#ifndef ETH_P_ALL
	324	#define ETH_P_ALL 0x0003
	325	#endif
6d07e760 JM	326	#ifndef ETH_P_IP
	327	#define ETH_P_IP 0x0800
	328	#endif
281ff0aa GP	329	#ifndef ETH_P_80211_ENCAP
	330	#define ETH_P_80211_ENCAP 0x890d /* TDLS comes under this category */
	331	#endif
d994a9b5 JM	332	#ifndef ETH_P_PAE
	333	#define ETH_P_PAE 0x888E /* Port Access Entity (IEEE 802.1X) */
	334	#endif /* ETH_P_PAE */
	335	#ifndef ETH_P_EAPOL
	336	#define ETH_P_EAPOL ETH_P_PAE
	337	#endif /* ETH_P_EAPOL */
	338	#ifndef ETH_P_RSN_PREAUTH
	339	#define ETH_P_RSN_PREAUTH 0x88c7
	340	#endif /* ETH_P_RSN_PREAUTH */
	341	#ifndef ETH_P_RRB
	342	#define ETH_P_RRB 0x890D
	343	#endif /* ETH_P_RRB */
50bd8e0a MB	344	#ifndef ETH_P_OUI
	345	#define ETH_P_OUI 0x88B7
	346	#endif /* ETH_P_OUI */
6fc6879b JM	347
	348
	349	#ifdef __GNUC__
	350	#define PRINTF_FORMAT(a,b) __attribute__ ((format (printf, (a), (b))))
	351	#define STRUCT_PACKED __attribute__ ((packed))
	352	#else
	353	#define PRINTF_FORMAT(a,b)
	354	#define STRUCT_PACKED
	355	#endif
	356
	357
	358	#ifdef CONFIG_ANSI_C_EXTRA
	359
	360	#if !defined(_MSC_VER) \|\| _MSC_VER < 1400
	361	/* snprintf - used in number of places; sprintf() is _not_ a good replacement
	362	* due to possible buffer overflow; see, e.g.,
	363	* http://www.ijs.si/software/snprintf/ for portable implementation of
	364	* snprintf. */
	365	int snprintf(char str, size_t size, const char format, ...);
	366
	367	/* vsnprintf - only used for wpa_msg() in wpa_supplicant.c */
	368	int vsnprintf(char str, size_t size, const char format, va_list ap);
	369	#endif /* !defined(_MSC_VER) \|\| _MSC_VER < 1400 */
	370
	371	/* getopt - only used in main.c */
	372	int getopt(int argc, char const argv[], const char optstring);
	373	extern char *optarg;
	374	extern int optind;
	375
	376	#ifndef CONFIG_NO_SOCKLEN_T_TYPEDEF
	377	#ifndef __socklen_t_defined
	378	typedef int socklen_t;
	379	#endif
	380	#endif
	381
	382	/* inline - define as __inline or just define it to be empty, if needed */
	383	#ifdef CONFIG_NO_INLINE
	384	#define inline
	385	#else
	386	#define inline __inline
	387	#endif
	388
	389	#ifndef __func__
	390	#define __func__ "__func__ not defined"
	391	#endif
	392
	393	#ifndef bswap_16
	394	#define bswap_16(a) ((((u16) (a) << 8) & 0xff00) \| (((u16) (a) >> 8) & 0xff))
	395	#endif
	396
	397	#ifndef bswap_32
	398	#define bswap_32(a) ((((u32) (a) << 24) & 0xff000000) \| \
	399	(((u32) (a) << 8) & 0xff0000) \| \
	400	(((u32) (a) >> 8) & 0xff00) \| \
	401	(((u32) (a) >> 24) & 0xff))
	402	#endif
	403
	404	#ifndef MSG_DONTWAIT
	405	#define MSG_DONTWAIT 0
	406	#endif
	407
	408	#ifdef _WIN32_WCE
	409	void perror(const char *s);
	410	#endif /* _WIN32_WCE */
411
412	#endif /* CONFIG_ANSI_C_EXTRA */
413
414	#ifndef MAC2STR
415	#define MAC2STR(a) (a)[0], (a)[1], (a)[2], (a)[3], (a)[4], (a)[5]
416	#define MACSTR "%02x:%02x:%02x:%02x:%02x:%02x"
0c11c633 JB	417
	418	/*
	419	* Compact form for string representation of MAC address
	420	* To be used, e.g., for constructing dbus paths for P2P Devices
	421	*/
	422	#define COMPACT_MACSTR "%02x%02x%02x%02x%02x%02x"
6fc6879b JM	423	#endif
	424
	425	#ifndef BIT
32d6463f	426	#define BIT(x) (1U << (x))
6fc6879b JM	427	#endif
	428
	429	/*
	430	* Definitions for sparse validation
	431	* (http://kernel.org/pub/linux/kernel/people/josh/sparse/)
	432	*/
	433	#ifdef __CHECKER__
	434	#define __force __attribute__((force))
6527b52e	435	#undef __bitwise
6fc6879b JM	436	#define __bitwise __attribute__((bitwise))
	437	#else
	438	#define __force
f5b74b96	439	#undef __bitwise
6fc6879b JM	440	#define __bitwise
	441	#endif
	442
	443	typedef u16 __bitwise be16;
	444	typedef u16 __bitwise le16;
	445	typedef u32 __bitwise be32;
	446	typedef u32 __bitwise le32;
	447	typedef u64 __bitwise be64;
	448	typedef u64 __bitwise le64;
	449
	450	#ifndef __must_check
	451	#if __GNUC__ > 3 \|\| (__GNUC__ == 3 && __GNUC_MINOR__ >= 4)
	452	#define __must_check __attribute__((__warn_unused_result__))
	453	#else
	454	#define __must_check
	455	#endif /* __GNUC__ */
	456	#endif /* __must_check */
1450e1e3 JM	457
	458	#ifndef __maybe_unused
	459	#if __GNUC__ > 3 \|\| (__GNUC__ == 3 && __GNUC_MINOR__ >= 4)
	460	#define __maybe_unused __attribute__((unused))
	461	#else
	462	#define __maybe_unused
	463	#endif /* __GNUC__ */
	464	#endif /* __must_check */
6fc6879b	465
624b8a06 DS	466	#define SSID_MAX_LEN 32
	467
	468	struct wpa_ssid_value {
	469	u8 ssid[SSID_MAX_LEN];
	470	size_t ssid_len;
	471	};
	472
6fc6879b	473	int hwaddr_aton(const char txt, u8 addr);
79cd993a	474	int hwaddr_masked_aton(const char txt, u8 addr, u8 *mask, u8 maskable);
0c11c633	475	int hwaddr_compact_aton(const char txt, u8 addr);
448a0a19	476	int hwaddr_aton2(const char txt, u8 addr);
b3a6d9d4	477	int hex2byte(const char *hex);
6fc6879b JM	478	int hexstr2bin(const char hex, u8 buf, size_t len);
	479	void inc_byte_array(u8 *counter, size_t len);
	480	void wpa_get_ntp_timestamp(u8 *buf);
71d263ea	481	int wpa_scnprintf(char buf, size_t size, const char fmt, ...);
2c1cf903 JM	482	int wpa_snprintf_hex_sep(char buf, size_t buf_size, const u8 data, size_t len,
2c1cf903 JM	483	char sep);
6fc6879b JM	484	int wpa_snprintf_hex(char buf, size_t buf_size, const u8 data, size_t len);
	485	int wpa_snprintf_hex_uppercase(char buf, size_t buf_size, const u8 data,
	486	size_t len);
	487
79cd993a	488	int hwaddr_mask_txt(char buf, size_t len, const u8 addr, const u8 *mask);
624b8a06	489	int ssid_parse(const char buf, struct wpa_ssid_value ssid);
79cd993a	490
6fc6879b JM	491	#ifdef CONFIG_NATIVE_WINDOWS
	492	void wpa_unicode2ascii_inplace(TCHAR *str);
	493	TCHAR * wpa_strdup_tchar(const char *str);
	494	#else /* CONFIG_NATIVE_WINDOWS */
	495	#define wpa_unicode2ascii_inplace(s) do { } while (0)
	496	#define wpa_strdup_tchar(s) strdup((s))
	497	#endif /* CONFIG_NATIVE_WINDOWS */
	498
0d7773b6 JM	499	void printf_encode(char txt, size_t maxlen, const u8 data, size_t len);
	500	size_t printf_decode(u8 buf, size_t maxlen, const char str);
	501
6fc6879b JM	502	const char * wpa_ssid_txt(const u8 *ssid, size_t ssid_len);
6fc6879b JM	503
b87d70c8	504	char * wpa_config_parse_string(const char value, size_t len);
e122bb70	505	int is_hex(const u8 *data, size_t len);
ecbb0b3d	506	int has_ctrl_char(const u8 *data, size_t len);
0fe5a234	507	int has_newline(const char *str);
3489cfb0 JM	508	size_t merge_byte_arrays(u8 *res, size_t res_len,
	509	const u8 *src1, size_t src1_len,
	510	const u8 *src2, size_t src2_len);
5e24dc8a	511	char * dup_binstr(const void *src, size_t len);
b87d70c8	512
a8e16edc JM	513	static inline int is_zero_ether_addr(const u8 *a)
	514	{
	515	return !(a[0] \| a[1] \| a[2] \| a[3] \| a[4] \| a[5]);
	516	}
6fc6879b	517
7d23e971 JM	518	static inline int is_broadcast_ether_addr(const u8 *a)
	519	{
	520	return (a[0] & a[1] & a[2] & a[3] & a[4] & a[5]) == 0xff;
	521	}
	522
36209df9 AN	523	static inline int is_multicast_ether_addr(const u8 *a)
	524	{
	525	return a[0] & 0x01;
	526	}
	527
0382097e JM	528	#define broadcast_ether_addr (const u8 *) "\xff\xff\xff\xff\xff\xff"
0382097e JM	529
6fc6879b JM	530	#include "wpa_debug.h"
6fc6879b JM	531
0ae7b086	532
af8a827b JM	533	struct wpa_freq_range_list {
	534	struct wpa_freq_range {
	535	unsigned int min;
	536	unsigned int max;
	537	} *range;
	538	unsigned int num;
	539	};
	540
	541	int freq_range_list_parse(struct wpa_freq_range_list res, const char value);
	542	int freq_range_list_includes(const struct wpa_freq_range_list *list,
	543	unsigned int freq);
	544	char * freq_range_list_str(const struct wpa_freq_range_list *list);
	545
98eda9c2 JM	546	int int_array_len(const int *a);
	547	void int_array_concat(int *res, const int a);
	548	void int_array_sort_unique(int *a);
	549	void int_array_add_unique(int **res, int a);
	550
39044a70 JM	551	#define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
39044a70 JM	552
19c48da0 JM	553	void str_clear_free(char *str);
	554	void bin_clear_free(void *bin, size_t len);
	555
4d8fb637	556	int random_mac_addr(u8 *addr);
1cbdb9d1	557	int random_mac_addr_keep_oui(u8 *addr);
4d8fb637	558
add59757	559	const char * cstr_token(const char str, const char delim, const char **last);
1b640fd2	560	char * str_token(char str, const char delim, char **context);
c3d6c717 BG	561	size_t utf8_escape(const char *inp, size_t in_size,
	562	char *outp, size_t out_size);
	563	size_t utf8_unescape(const char *inp, size_t in_size,
	564	char *outp, size_t out_size);
0f5acfba	565	int is_ctrl_char(char c);
1b640fd2	566
e55df99e JM	567	int str_starts(const char str, const char start);
e55df99e JM	568
b3060bf9	569	u8 rssi_to_rcpi(int rssi);
87d8435c	570	char * get_param(const char cmd, const char param);
19c48da0	571
0ae7b086 JM	572	/*
	573	* gcc 4.4 ends up generating strict-aliasing warnings about some very common
	574	* networking socket uses that do not really result in a real problem and
	575	* cannot be easily avoided with union-based type-punning due to struct
	576	* definitions including another struct in system header files. To avoid having
	577	* to fully disable strict-aliasing warnings, provide a mechanism to hide the
	578	* typecast from aliasing for now. A cleaner solution will hopefully be found
	579	* in the future to handle these cases.
	580	*/
	581	void * __hide_aliasing_typecast(void *foo);
	582	#define aliasing_hide_typecast(a,t) (t *) __hide_aliasing_typecast((a))
	583
c0647147 JM	584	#ifdef CONFIG_VALGRIND
	585	#include <valgrind/memcheck.h>
	586	#define WPA_MEM_DEFINED(ptr, len) VALGRIND_MAKE_MEM_DEFINED((ptr), (len))
	587	#else /* CONFIG_VALGRIND */
	588	#define WPA_MEM_DEFINED(ptr, len) do { } while (0)
	589	#endif /* CONFIG_VALGRIND */
	590
6fc6879b	591	#endif /* COMMON_H */