1 /* 2 * wpa_supplicant/hostapd / common helper functions, etc. 3 * Copyright (c) 2002-2007, Jouni Malinen <j (at) 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 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 56 #ifdef CONFIG_TI_COMPILER 57 #define __BIG_ENDIAN 4321 58 #define __LITTLE_ENDIAN 1234 59 #ifdef __big_endian__ 60 #define __BYTE_ORDER __BIG_ENDIAN 61 #else 62 #define __BYTE_ORDER __LITTLE_ENDIAN 63 #endif 64 #endif /* CONFIG_TI_COMPILER */ 65 66 #ifdef CONFIG_NATIVE_WINDOWS 67 #include <winsock.h> 68 69 typedef int socklen_t; 70 71 #ifndef MSG_DONTWAIT 72 #define MSG_DONTWAIT 0 /* not supported */ 73 #endif 74 75 #endif /* CONFIG_NATIVE_WINDOWS */ 76 77 #ifdef _MSC_VER 78 #define inline __inline 79 80 #undef vsnprintf 81 #define vsnprintf _vsnprintf 82 #undef close 83 #define close closesocket 84 #endif /* _MSC_VER */ 85 86 87 /* Define platform specific integer types */ 88 89 #ifdef _MSC_VER 90 typedef UINT64 u64; 91 typedef UINT32 u32; 92 typedef UINT16 u16; 93 typedef UINT8 u8; 94 typedef INT64 s64; 95 typedef INT32 s32; 96 typedef INT16 s16; 97 typedef INT8 s8; 98 #define WPA_TYPES_DEFINED 99 #endif /* _MSC_VER */ 100 101 #ifdef __vxworks 102 typedef unsigned long long u64; 103 typedef UINT32 u32; 104 typedef UINT16 u16; 105 typedef UINT8 u8; 106 typedef long long s64; 107 typedef INT32 s32; 108 typedef INT16 s16; 109 typedef INT8 s8; 110 #define WPA_TYPES_DEFINED 111 #endif /* __vxworks */ 112 113 #ifdef CONFIG_TI_COMPILER 114 #ifdef _LLONG_AVAILABLE 115 typedef unsigned long long u64; 116 #else 117 /* 118 * TODO: 64-bit variable not available. Using long as a workaround to test the 119 * build, but this will likely not work for all operations. 120 */ 121 typedef unsigned long u64; 122 #endif 123 typedef unsigned int u32; 124 typedef unsigned short u16; 125 typedef unsigned char u8; 126 #define WPA_TYPES_DEFINED 127 #endif /* CONFIG_TI_COMPILER */ 128 129 #ifndef WPA_TYPES_DEFINED 130 #ifdef CONFIG_USE_INTTYPES_H 131 #include <inttypes.h> 132 #else 133 #include <stdint.h> 134 #endif 135 typedef uint64_t u64; 136 typedef uint32_t u32; 137 typedef uint16_t u16; 138 typedef uint8_t u8; 139 typedef int64_t s64; 140 typedef int32_t s32; 141 typedef int16_t s16; 142 typedef int8_t s8; 143 #define WPA_TYPES_DEFINED 144 #endif /* !WPA_TYPES_DEFINED */ 145 146 147 /* Define platform specific byte swapping macros */ 148 149 #if defined(__CYGWIN__) || defined(CONFIG_NATIVE_WINDOWS) 150 151 static inline unsigned short wpa_swap_16(unsigned short v) 152 { 153 return ((v & 0xff) << 8) | (v >> 8); 154 } 155 156 static inline unsigned int wpa_swap_32(unsigned int v) 157 { 158 return ((v & 0xff) << 24) | ((v & 0xff00) << 8) | 159 ((v & 0xff0000) >> 8) | (v >> 24); 160 } 161 162 #define le_to_host16(n) (n) 163 #define host_to_le16(n) (n) 164 #define be_to_host16(n) wpa_swap_16(n) 165 #define host_to_be16(n) wpa_swap_16(n) 166 #define le_to_host32(n) (n) 167 #define be_to_host32(n) wpa_swap_32(n) 168 #define host_to_be32(n) wpa_swap_32(n) 169 170 #define WPA_BYTE_SWAP_DEFINED 171 172 #endif /* __CYGWIN__ || CONFIG_NATIVE_WINDOWS */ 173 174 175 #ifndef WPA_BYTE_SWAP_DEFINED 176 177 #ifndef __BYTE_ORDER 178 #ifndef __LITTLE_ENDIAN 179 #ifndef __BIG_ENDIAN 180 #define __LITTLE_ENDIAN 1234 181 #define __BIG_ENDIAN 4321 182 #if defined(sparc) 183 #define __BYTE_ORDER __BIG_ENDIAN 184 #endif 185 #endif /* __BIG_ENDIAN */ 186 #endif /* __LITTLE_ENDIAN */ 187 #endif /* __BYTE_ORDER */ 188 189 #if __BYTE_ORDER == __LITTLE_ENDIAN 190 #define le_to_host16(n) ((__force u16) (le16) (n)) 191 #define host_to_le16(n) ((__force le16) (u16) (n)) 192 #define be_to_host16(n) bswap_16((__force u16) (be16) (n)) 193 #define host_to_be16(n) ((__force be16) bswap_16((n))) 194 #define le_to_host32(n) ((__force u32) (le32) (n)) 195 #define host_to_le32(n) ((__force le32) (u32) (n)) 196 #define be_to_host32(n) bswap_32((__force u32) (be32) (n)) 197 #define host_to_be32(n) ((__force be32) bswap_32((n))) 198 #define le_to_host64(n) ((__force u64) (le64) (n)) 199 #define host_to_le64(n) ((__force le64) (u64) (n)) 200 #define be_to_host64(n) bswap_64((__force u64) (be64) (n)) 201 #define host_to_be64(n) ((__force be64) bswap_64((n))) 202 #elif __BYTE_ORDER == __BIG_ENDIAN 203 #define le_to_host16(n) bswap_16(n) 204 #define host_to_le16(n) bswap_16(n) 205 #define be_to_host16(n) (n) 206 #define host_to_be16(n) (n) 207 #define le_to_host32(n) bswap_32(n) 208 #define be_to_host32(n) (n) 209 #define host_to_be32(n) (n) 210 #define le_to_host64(n) bswap_64(n) 211 #define host_to_le64(n) bswap_64(n) 212 #define be_to_host64(n) (n) 213 #define host_to_be64(n) (n) 214 #ifndef WORDS_BIGENDIAN 215 #define WORDS_BIGENDIAN 216 #endif 217 #else 218 #error Could not determine CPU byte order 219 #endif 220 221 #define WPA_BYTE_SWAP_DEFINED 222 #endif /* !WPA_BYTE_SWAP_DEFINED */ 223 224 225 /* Macros for handling unaligned memory accesses */ 226 227 #define WPA_GET_BE16(a) ((u16) (((a)[0] << 8) | (a)[1])) 228 #define WPA_PUT_BE16(a, val) \ 229 do { \ 230 (a)[0] = ((u16) (val)) >> 8; \ 231 (a)[1] = ((u16) (val)) & 0xff; \ 232 } while (0) 233 234 #define WPA_GET_LE16(a) ((u16) (((a)[1] << 8) | (a)[0])) 235 #define WPA_PUT_LE16(a, val) \ 236 do { \ 237 (a)[1] = ((u16) (val)) >> 8; \ 238 (a)[0] = ((u16) (val)) & 0xff; \ 239 } while (0) 240 241 #define WPA_GET_BE24(a) ((((u32) (a)[0]) << 16) | (((u32) (a)[1]) << 8) | \ 242 ((u32) (a)[2])) 243 #define WPA_PUT_BE24(a, val) \ 244 do { \ 245 (a)[0] = (u8) ((((u32) (val)) >> 16) & 0xff); \ 246 (a)[1] = (u8) ((((u32) (val)) >> 8) & 0xff); \ 247 (a)[2] = (u8) (((u32) (val)) & 0xff); \ 248 } while (0) 249 250 #define WPA_GET_BE32(a) ((((u32) (a)[0]) << 24) | (((u32) (a)[1]) << 16) | \ 251 (((u32) (a)[2]) << 8) | ((u32) (a)[3])) 252 #define WPA_PUT_BE32(a, val) \ 253 do { \ 254 (a)[0] = (u8) ((((u32) (val)) >> 24) & 0xff); \ 255 (a)[1] = (u8) ((((u32) (val)) >> 16) & 0xff); \ 256 (a)[2] = (u8) ((((u32) (val)) >> 8) & 0xff); \ 257 (a)[3] = (u8) (((u32) (val)) & 0xff); \ 258 } while (0) 259 260 #define WPA_GET_LE32(a) ((((u32) (a)[3]) << 24) | (((u32) (a)[2]) << 16) | \ 261 (((u32) (a)[1]) << 8) | ((u32) (a)[0])) 262 #define WPA_PUT_LE32(a, val) \ 263 do { \ 264 (a)[3] = (u8) ((((u32) (val)) >> 24) & 0xff); \ 265 (a)[2] = (u8) ((((u32) (val)) >> 16) & 0xff); \ 266 (a)[1] = (u8) ((((u32) (val)) >> 8) & 0xff); \ 267 (a)[0] = (u8) (((u32) (val)) & 0xff); \ 268 } while (0) 269 270 #define WPA_GET_BE64(a) ((((u64) (a)[0]) << 56) | (((u64) (a)[1]) << 48) | \ 271 (((u64) (a)[2]) << 40) | (((u64) (a)[3]) << 32) | \ 272 (((u64) (a)[4]) << 24) | (((u64) (a)[5]) << 16) | \ 273 (((u64) (a)[6]) << 8) | ((u64) (a)[7])) 274 #define WPA_PUT_BE64(a, val) \ 275 do { \ 276 (a)[0] = (u8) (((u64) (val)) >> 56); \ 277 (a)[1] = (u8) (((u64) (val)) >> 48); \ 278 (a)[2] = (u8) (((u64) (val)) >> 40); \ 279 (a)[3] = (u8) (((u64) (val)) >> 32); \ 280 (a)[4] = (u8) (((u64) (val)) >> 24); \ 281 (a)[5] = (u8) (((u64) (val)) >> 16); \ 282 (a)[6] = (u8) (((u64) (val)) >> 8); \ 283 (a)[7] = (u8) (((u64) (val)) & 0xff); \ 284 } while (0) 285 286 #define WPA_GET_LE64(a) ((((u64) (a)[7]) << 56) | (((u64) (a)[6]) << 48) | \ 287 (((u64) (a)[5]) << 40) | (((u64) (a)[4]) << 32) | \ 288 (((u64) (a)[3]) << 24) | (((u64) (a)[2]) << 16) | \ 289 (((u64) (a)[1]) << 8) | ((u64) (a)[0])) 290 291 292 #ifndef ETH_ALEN 293 #define ETH_ALEN 6 294 #endif 295 #ifndef IFNAMSIZ 296 #define IFNAMSIZ 16 297 #endif 298 #ifndef ETH_P_ALL 299 #define ETH_P_ALL 0x0003 300 #endif 301 #ifndef ETH_P_80211_ENCAP 302 #define ETH_P_80211_ENCAP 0x890d /* TDLS comes under this category */ 303 #endif 304 #ifndef ETH_P_PAE 305 #define ETH_P_PAE 0x888E /* Port Access Entity (IEEE 802.1X) */ 306 #endif /* ETH_P_PAE */ 307 #ifndef ETH_P_EAPOL 308 #define ETH_P_EAPOL ETH_P_PAE 309 #endif /* ETH_P_EAPOL */ 310 #ifndef ETH_P_RSN_PREAUTH 311 #define ETH_P_RSN_PREAUTH 0x88c7 312 #endif /* ETH_P_RSN_PREAUTH */ 313 #ifndef ETH_P_RRB 314 #define ETH_P_RRB 0x890D 315 #endif /* ETH_P_RRB */ 316 317 318 #ifdef __GNUC__ 319 #define PRINTF_FORMAT(a,b) __attribute__ ((format (printf, (a), (b)))) 320 #define STRUCT_PACKED __attribute__ ((packed)) 321 #else 322 #define PRINTF_FORMAT(a,b) 323 #define STRUCT_PACKED 324 #endif 325 326 327 #ifdef CONFIG_ANSI_C_EXTRA 328 329 #if !defined(_MSC_VER) || _MSC_VER < 1400 330 /* snprintf - used in number of places; sprintf() is _not_ a good replacement 331 * due to possible buffer overflow; see, e.g., 332 * http://www.ijs.si/software/snprintf/ for portable implementation of 333 * snprintf. */ 334 int snprintf(char *str, size_t size, const char *format, ...); 335 336 /* vsnprintf - only used for wpa_msg() in wpa_supplicant.c */ 337 int vsnprintf(char *str, size_t size, const char *format, va_list ap); 338 #endif /* !defined(_MSC_VER) || _MSC_VER < 1400 */ 339 340 /* getopt - only used in main.c */ 341 int getopt(int argc, char *const argv[], const char *optstring); 342 extern char *optarg; 343 extern int optind; 344 345 #ifndef CONFIG_NO_SOCKLEN_T_TYPEDEF 346 #ifndef __socklen_t_defined 347 typedef int socklen_t; 348 #endif 349 #endif 350 351 /* inline - define as __inline or just define it to be empty, if needed */ 352 #ifdef CONFIG_NO_INLINE 353 #define inline 354 #else 355 #define inline __inline 356 #endif 357 358 #ifndef __func__ 359 #define __func__ "__func__ not defined" 360 #endif 361 362 #ifndef bswap_16 363 #define bswap_16(a) ((((u16) (a) << 8) & 0xff00) | (((u16) (a) >> 8) & 0xff)) 364 #endif 365 366 #ifndef bswap_32 367 #define bswap_32(a) ((((u32) (a) << 24) & 0xff000000) | \ 368 (((u32) (a) << 8) & 0xff0000) | \ 369 (((u32) (a) >> 8) & 0xff00) | \ 370 (((u32) (a) >> 24) & 0xff)) 371 #endif 372 373 #ifndef MSG_DONTWAIT 374 #define MSG_DONTWAIT 0 375 #endif 376 377 #ifdef _WIN32_WCE 378 void perror(const char *s); 379 #endif /* _WIN32_WCE */ 380 381 #endif /* CONFIG_ANSI_C_EXTRA */ 382 383 #ifndef MAC2STR 384 #define MAC2STR(a) (a)[0], (a)[1], (a)[2], (a)[3], (a)[4], (a)[5] 385 #define MACSTR "%02x:%02x:%02x:%02x:%02x:%02x" 386 387 /* 388 * Compact form for string representation of MAC address 389 * To be used, e.g., for constructing dbus paths for P2P Devices 390 */ 391 #define COMPACT_MACSTR "%02x%02x%02x%02x%02x%02x" 392 #endif 393 394 #ifndef BIT 395 #define BIT(x) (1 << (x)) 396 #endif 397 398 /* 399 * Definitions for sparse validation 400 * (http://kernel.org/pub/linux/kernel/people/josh/sparse/) 401 */ 402 #ifdef __CHECKER__ 403 #define __force __attribute__((force)) 404 #define __bitwise __attribute__((bitwise)) 405 #else 406 #define __force 407 #define __bitwise 408 #endif 409 410 typedef u16 __bitwise be16; 411 typedef u16 __bitwise le16; 412 typedef u32 __bitwise be32; 413 typedef u32 __bitwise le32; 414 typedef u64 __bitwise be64; 415 typedef u64 __bitwise le64; 416 417 #ifndef __must_check 418 #if __GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 4) 419 #define __must_check __attribute__((__warn_unused_result__)) 420 #else 421 #define __must_check 422 #endif /* __GNUC__ */ 423 #endif /* __must_check */ 424 425 int hwaddr_aton(const char *txt, u8 *addr); 426 int hwaddr_compact_aton(const char *txt, u8 *addr); 427 int hwaddr_aton2(const char *txt, u8 *addr); 428 int hex2byte(const char *hex); 429 int hexstr2bin(const char *hex, u8 *buf, size_t len); 430 void inc_byte_array(u8 *counter, size_t len); 431 void wpa_get_ntp_timestamp(u8 *buf); 432 int wpa_snprintf_hex(char *buf, size_t buf_size, const u8 *data, size_t len); 433 int wpa_snprintf_hex_uppercase(char *buf, size_t buf_size, const u8 *data, 434 size_t len); 435 436 #ifdef CONFIG_NATIVE_WINDOWS 437 void wpa_unicode2ascii_inplace(TCHAR *str); 438 TCHAR * wpa_strdup_tchar(const char *str); 439 #else /* CONFIG_NATIVE_WINDOWS */ 440 #define wpa_unicode2ascii_inplace(s) do { } while (0) 441 #define wpa_strdup_tchar(s) strdup((s)) 442 #endif /* CONFIG_NATIVE_WINDOWS */ 443 444 void printf_encode(char *txt, size_t maxlen, const u8 *data, size_t len); 445 size_t printf_decode(u8 *buf, size_t maxlen, const char *str); 446 447 const char * wpa_ssid_txt(const u8 *ssid, size_t ssid_len); 448 449 char * wpa_config_parse_string(const char *value, size_t *len); 450 int is_hex(const u8 *data, size_t len); 451 size_t merge_byte_arrays(u8 *res, size_t res_len, 452 const u8 *src1, size_t src1_len, 453 const u8 *src2, size_t src2_len); 454 455 static inline int is_zero_ether_addr(const u8 *a) 456 { 457 return !(a[0] | a[1] | a[2] | a[3] | a[4] | a[5]); 458 } 459 460 static inline int is_broadcast_ether_addr(const u8 *a) 461 { 462 return (a[0] & a[1] & a[2] & a[3] & a[4] & a[5]) == 0xff; 463 } 464 465 #define broadcast_ether_addr (const u8 *) "\xff\xff\xff\xff\xff\xff" 466 467 #include "wpa_debug.h" 468 469 470 /* 471 * gcc 4.4 ends up generating strict-aliasing warnings about some very common 472 * networking socket uses that do not really result in a real problem and 473 * cannot be easily avoided with union-based type-punning due to struct 474 * definitions including another struct in system header files. To avoid having 475 * to fully disable strict-aliasing warnings, provide a mechanism to hide the 476 * typecast from aliasing for now. A cleaner solution will hopefully be found 477 * in the future to handle these cases. 478 */ 479 void * __hide_aliasing_typecast(void *foo); 480 #define aliasing_hide_typecast(a,t) (t *) __hide_aliasing_typecast((a)) 481 482 #ifdef CONFIG_VALGRIND 483 #include <valgrind/memcheck.h> 484 #define WPA_MEM_DEFINED(ptr, len) VALGRIND_MAKE_MEM_DEFINED((ptr), (len)) 485 #else /* CONFIG_VALGRIND */ 486 #define WPA_MEM_DEFINED(ptr, len) do { } while (0) 487 #endif /* CONFIG_VALGRIND */ 488 489 #endif /* COMMON_H */ 490
