1/* 2 * wpa_supplicant/hostapd / common helper functions, etc. 3 * Copyright (c) 2002-2007, Jouni Malinen <j@w1.fi> 4 * 5 * This software may be distributed under the terms of the BSD license. 6 * See README for more details. 7 */ 8 9#ifndef COMMON_H 10#define COMMON_H 11 12#include "os.h" 13 14#if defined(__linux__) || defined(__GLIBC__) 15#include <endian.h> 16#include <byteswap.h> 17#endif /* __linux__ */ 18 19#if defined(__FreeBSD__) || defined(__NetBSD__) || defined(__DragonFly__) || \ 20 defined(__OpenBSD__) 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 26#ifdef __OpenBSD__ 27#define bswap_16 swap16 28#define bswap_32 swap32 29#define bswap_64 swap64 30#else /* __OpenBSD__ */ 31#define bswap_16 bswap16 32#define bswap_32 bswap32 33#define bswap_64 bswap64 34#endif /* __OpenBSD__ */ 35#endif /* defined(__FreeBSD__) || defined(__NetBSD__) || 36 * defined(__DragonFly__) || defined(__OpenBSD__) */ 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 44static inline unsigned short bswap_16(unsigned short v) 45{ 46 return ((v & 0xff) << 8) | (v >> 8); 47} 48 49static 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 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 65#ifdef CONFIG_NATIVE_WINDOWS 66#include <winsock.h> 67 68typedef 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 89typedef UINT64 u64; 90typedef UINT32 u32; 91typedef UINT16 u16; 92typedef UINT8 u8; 93typedef INT64 s64; 94typedef INT32 s32; 95typedef INT16 s16; 96typedef INT8 s8; 97#define WPA_TYPES_DEFINED 98#endif /* _MSC_VER */ 99 100#ifdef __vxworks 101typedef unsigned long long u64; 102typedef UINT32 u32; 103typedef UINT16 u16; 104typedef UINT8 u8; 105typedef long long s64; 106typedef INT32 s32; 107typedef INT16 s16; 108typedef INT8 s8; 109#define WPA_TYPES_DEFINED 110#endif /* __vxworks */ 111 112#ifndef WPA_TYPES_DEFINED 113#ifdef CONFIG_USE_INTTYPES_H 114#include <inttypes.h> 115#else 116#include <stdint.h> 117#endif 118typedef uint64_t u64; 119typedef uint32_t u32; 120typedef uint16_t u16; 121typedef uint8_t u8; 122typedef int64_t s64; 123typedef int32_t s32; 124typedef int16_t s16; 125typedef 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 134static inline unsigned short wpa_swap_16(unsigned short v) 135{ 136 return ((v & 0xff) << 8) | (v >> 8); 137} 138 139static 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) 150#define host_to_le32(n) (n) 151#define be_to_host32(n) wpa_swap_32(n) 152#define host_to_be32(n) wpa_swap_32(n) 153#define host_to_le64(n) (n) 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) 193#define host_to_le32(n) bswap_32(n) 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 213static inline u16 WPA_GET_BE16(const u8 *a) 214{ 215 return (a[0] << 8) | a[1]; 216} 217 218static inline void WPA_PUT_BE16(u8 *a, u16 val) 219{ 220 a[0] = val >> 8; 221 a[1] = val & 0xff; 222} 223 224static inline u16 WPA_GET_LE16(const u8 *a) 225{ 226 return (a[1] << 8) | a[0]; 227} 228 229static inline void WPA_PUT_LE16(u8 *a, u16 val) 230{ 231 a[1] = val >> 8; 232 a[0] = val & 0xff; 233} 234 235static inline u32 WPA_GET_BE24(const u8 *a) 236{ 237 return (a[0] << 16) | (a[1] << 8) | a[2]; 238} 239 240static 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 247static inline u32 WPA_GET_BE32(const u8 *a) 248{ 249 return ((u32) a[0] << 24) | (a[1] << 16) | (a[2] << 8) | a[3]; 250} 251 252static 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 260static inline u32 WPA_GET_LE32(const u8 *a) 261{ 262 return ((u32) a[3] << 24) | (a[2] << 16) | (a[1] << 8) | a[0]; 263} 264 265static 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 273static 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 281static 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 293static 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 301static 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} 312 313 314#ifndef ETH_ALEN 315#define ETH_ALEN 6 316#endif 317#ifndef ETH_HLEN 318#define ETH_HLEN 14 319#endif 320#ifndef IFNAMSIZ 321#define IFNAMSIZ 16 322#endif 323#ifndef ETH_P_ALL 324#define ETH_P_ALL 0x0003 325#endif 326#ifndef ETH_P_IP 327#define ETH_P_IP 0x0800 328#endif 329#ifndef ETH_P_80211_ENCAP 330#define ETH_P_80211_ENCAP 0x890d /* TDLS comes under this category */ 331#endif 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 */ 344#ifndef ETH_P_OUI 345#define ETH_P_OUI 0x88B7 346#endif /* ETH_P_OUI */ 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. */ 365int snprintf(char *str, size_t size, const char *format, ...); 366 367/* vsnprintf - only used for wpa_msg() in wpa_supplicant.c */ 368int 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 */ 372int getopt(int argc, char *const argv[], const char *optstring); 373extern char *optarg; 374extern int optind; 375 376#ifndef CONFIG_NO_SOCKLEN_T_TYPEDEF 377#ifndef __socklen_t_defined 378typedef 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 409void 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" 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" 423#endif 424 425#ifndef BIT 426#define BIT(x) (1U << (x)) 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)) 435#undef __bitwise 436#define __bitwise __attribute__((bitwise)) 437#else 438#define __force 439#undef __bitwise 440#define __bitwise 441#endif 442 443typedef u16 __bitwise be16; 444typedef u16 __bitwise le16; 445typedef u32 __bitwise be32; 446typedef u32 __bitwise le32; 447typedef u64 __bitwise be64; 448typedef 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 */ 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 */ 465 466#define SSID_MAX_LEN 32 467 468struct wpa_ssid_value { 469 u8 ssid[SSID_MAX_LEN]; 470 size_t ssid_len; 471}; 472 473int hwaddr_aton(const char *txt, u8 *addr); 474int hwaddr_masked_aton(const char *txt, u8 *addr, u8 *mask, u8 maskable); 475int hwaddr_compact_aton(const char *txt, u8 *addr); 476int hwaddr_aton2(const char *txt, u8 *addr); 477int hex2byte(const char *hex); 478int hexstr2bin(const char *hex, u8 *buf, size_t len); 479void inc_byte_array(u8 *counter, size_t len); 480void buf_shift_right(u8 *buf, size_t len, size_t bits); 481void wpa_get_ntp_timestamp(u8 *buf); 482int wpa_scnprintf(char *buf, size_t size, const char *fmt, ...); 483int wpa_snprintf_hex_sep(char *buf, size_t buf_size, const u8 *data, size_t len, 484 char sep); 485int wpa_snprintf_hex(char *buf, size_t buf_size, const u8 *data, size_t len); 486int wpa_snprintf_hex_uppercase(char *buf, size_t buf_size, const u8 *data, 487 size_t len); 488 489int hwaddr_mask_txt(char *buf, size_t len, const u8 *addr, const u8 *mask); 490int ssid_parse(const char *buf, struct wpa_ssid_value *ssid); 491 492#ifdef CONFIG_NATIVE_WINDOWS 493void wpa_unicode2ascii_inplace(TCHAR *str); 494TCHAR * wpa_strdup_tchar(const char *str); 495#else /* CONFIG_NATIVE_WINDOWS */ 496#define wpa_unicode2ascii_inplace(s) do { } while (0) 497#define wpa_strdup_tchar(s) strdup((s)) 498#endif /* CONFIG_NATIVE_WINDOWS */ 499 500void printf_encode(char *txt, size_t maxlen, const u8 *data, size_t len); 501size_t printf_decode(u8 *buf, size_t maxlen, const char *str); 502 503const char * wpa_ssid_txt(const u8 *ssid, size_t ssid_len); 504 505char * wpa_config_parse_string(const char *value, size_t *len); 506int is_hex(const u8 *data, size_t len); 507int has_ctrl_char(const u8 *data, size_t len); 508int has_newline(const char *str); 509size_t merge_byte_arrays(u8 *res, size_t res_len, 510 const u8 *src1, size_t src1_len, 511 const u8 *src2, size_t src2_len); 512char * dup_binstr(const void *src, size_t len); 513 514static inline int is_zero_ether_addr(const u8 *a) 515{ 516 return !(a[0] | a[1] | a[2] | a[3] | a[4] | a[5]); 517} 518 519static inline int is_broadcast_ether_addr(const u8 *a) 520{ 521 return (a[0] & a[1] & a[2] & a[3] & a[4] & a[5]) == 0xff; 522} 523 524static inline int is_multicast_ether_addr(const u8 *a) 525{ 526 return a[0] & 0x01; 527} 528 529#define broadcast_ether_addr (const u8 *) "\xff\xff\xff\xff\xff\xff" 530 531#include "wpa_debug.h" 532 533 534struct wpa_freq_range_list { 535 struct wpa_freq_range { 536 unsigned int min; 537 unsigned int max; 538 } *range; 539 unsigned int num; 540}; 541 542int freq_range_list_parse(struct wpa_freq_range_list *res, const char *value); 543int freq_range_list_includes(const struct wpa_freq_range_list *list, 544 unsigned int freq); 545char * freq_range_list_str(const struct wpa_freq_range_list *list); 546 547int int_array_len(const int *a); 548void int_array_concat(int **res, const int *a); 549void int_array_sort_unique(int *a); 550void int_array_add_unique(int **res, int a); 551 552#define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0])) 553 554void str_clear_free(char *str); 555void bin_clear_free(void *bin, size_t len); 556 557int random_mac_addr(u8 *addr); 558int random_mac_addr_keep_oui(u8 *addr); 559 560const char * cstr_token(const char *str, const char *delim, const char **last); 561char * str_token(char *str, const char *delim, char **context); 562size_t utf8_escape(const char *inp, size_t in_size, 563 char *outp, size_t out_size); 564size_t utf8_unescape(const char *inp, size_t in_size, 565 char *outp, size_t out_size); 566int is_ctrl_char(char c); 567 568int str_starts(const char *str, const char *start); 569 570u8 rssi_to_rcpi(int rssi); 571char * get_param(const char *cmd, const char *param); 572 573void forced_memzero(void *ptr, size_t len); 574 575/* 576 * gcc 4.4 ends up generating strict-aliasing warnings about some very common 577 * networking socket uses that do not really result in a real problem and 578 * cannot be easily avoided with union-based type-punning due to struct 579 * definitions including another struct in system header files. To avoid having 580 * to fully disable strict-aliasing warnings, provide a mechanism to hide the 581 * typecast from aliasing for now. A cleaner solution will hopefully be found 582 * in the future to handle these cases. 583 */ 584void * __hide_aliasing_typecast(void *foo); 585#define aliasing_hide_typecast(a,t) (t *) __hide_aliasing_typecast((a)) 586 587#ifdef CONFIG_VALGRIND 588#include <valgrind/memcheck.h> 589#define WPA_MEM_DEFINED(ptr, len) VALGRIND_MAKE_MEM_DEFINED((ptr), (len)) 590#else /* CONFIG_VALGRIND */ 591#define WPA_MEM_DEFINED(ptr, len) do { } while (0) 592#endif /* CONFIG_VALGRIND */ 593 594#endif /* COMMON_H */ 595