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