libeap/src/utils/common.h

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