2 * wpa_supplicant/hostapd / common helper functions, etc.
3 * Copyright (c) 2002-2007, Jouni Malinen <j@w1.fi>
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
14 #if defined(__linux__) || defined(__GLIBC__)
17 #endif /* __linux__ */
19 #if defined(__FreeBSD__) || defined(__NetBSD__) || defined(__DragonFly__) || \
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
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__) */
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)
46 return ((v & 0xff) << 8) | (v >> 8);
49 static inline unsigned int bswap_32(unsigned int v)
51 return ((v & 0xff) << 24) | ((v & 0xff00) << 8) |
52 ((v & 0xff0000) >> 8) | (v >> 24);
54 #endif /* __APPLE__ */
56 #ifdef CONFIG_NATIVE_WINDOWS
64 typedef int socklen_t;
67 #define MSG_DONTWAIT 0 /* not supported */
70 #endif /* CONFIG_NATIVE_WINDOWS */
74 #define inline __inline
78 #define vsnprintf _vsnprintf
80 #define close closesocket
84 /* Define platform specific integer types */
95 #define WPA_TYPES_DEFINED
99 typedef unsigned long long u64;
103 typedef long long s64;
107 #define WPA_TYPES_DEFINED
108 #endif /* __vxworks */
110 #ifndef WPA_TYPES_DEFINED
111 #ifdef CONFIG_USE_INTTYPES_H
112 #include <inttypes.h>
116 typedef uint64_t u64;
117 typedef uint32_t u32;
118 typedef uint16_t u16;
124 #define WPA_TYPES_DEFINED
125 #endif /* !WPA_TYPES_DEFINED */
128 /* Define platform specific byte swapping macros */
130 #if defined(__CYGWIN__) || defined(CONFIG_NATIVE_WINDOWS)
132 static inline unsigned short wpa_swap_16(unsigned short v)
134 return ((v & 0xff) << 8) | (v >> 8);
137 static inline unsigned int wpa_swap_32(unsigned int v)
139 return ((v & 0xff) << 24) | ((v & 0xff00) << 8) |
140 ((v & 0xff0000) >> 8) | (v >> 24);
143 #define le_to_host16(n) (n)
144 #define host_to_le16(n) (n)
145 #define be_to_host16(n) wpa_swap_16(n)
146 #define host_to_be16(n) wpa_swap_16(n)
147 #define le_to_host32(n) (n)
148 #define host_to_le32(n) (n)
149 #define be_to_host32(n) wpa_swap_32(n)
150 #define host_to_be32(n) wpa_swap_32(n)
152 #define WPA_BYTE_SWAP_DEFINED
154 #endif /* __CYGWIN__ || CONFIG_NATIVE_WINDOWS */
157 #ifndef WPA_BYTE_SWAP_DEFINED
160 #ifndef __LITTLE_ENDIAN
162 #define __LITTLE_ENDIAN 1234
163 #define __BIG_ENDIAN 4321
165 #define __BYTE_ORDER __BIG_ENDIAN
167 #endif /* __BIG_ENDIAN */
168 #endif /* __LITTLE_ENDIAN */
169 #endif /* __BYTE_ORDER */
171 #if __BYTE_ORDER == __LITTLE_ENDIAN
172 #define le_to_host16(n) ((__force u16) (le16) (n))
173 #define host_to_le16(n) ((__force le16) (u16) (n))
174 #define be_to_host16(n) bswap_16((__force u16) (be16) (n))
175 #define host_to_be16(n) ((__force be16) bswap_16((n)))
176 #define le_to_host32(n) ((__force u32) (le32) (n))
177 #define host_to_le32(n) ((__force le32) (u32) (n))
178 #define be_to_host32(n) bswap_32((__force u32) (be32) (n))
179 #define host_to_be32(n) ((__force be32) bswap_32((n)))
180 #define le_to_host64(n) ((__force u64) (le64) (n))
181 #define host_to_le64(n) ((__force le64) (u64) (n))
182 #define be_to_host64(n) bswap_64((__force u64) (be64) (n))
183 #define host_to_be64(n) ((__force be64) bswap_64((n)))
184 #elif __BYTE_ORDER == __BIG_ENDIAN
185 #define le_to_host16(n) bswap_16(n)
186 #define host_to_le16(n) bswap_16(n)
187 #define be_to_host16(n) (n)
188 #define host_to_be16(n) (n)
189 #define le_to_host32(n) bswap_32(n)
190 #define host_to_le32(n) bswap_32(n)
191 #define be_to_host32(n) (n)
192 #define host_to_be32(n) (n)
193 #define le_to_host64(n) bswap_64(n)
194 #define host_to_le64(n) bswap_64(n)
195 #define be_to_host64(n) (n)
196 #define host_to_be64(n) (n)
197 #ifndef WORDS_BIGENDIAN
198 #define WORDS_BIGENDIAN
201 #error Could not determine CPU byte order
204 #define WPA_BYTE_SWAP_DEFINED
205 #endif /* !WPA_BYTE_SWAP_DEFINED */
208 /* Macros for handling unaligned memory accesses */
210 static inline u16 WPA_GET_BE16(const u8 *a)
212 return (a[0] << 8) | a[1];
215 static inline void WPA_PUT_BE16(u8 *a, u16 val)
221 static inline u16 WPA_GET_LE16(const u8 *a)
223 return (a[1] << 8) | a[0];
226 static inline void WPA_PUT_LE16(u8 *a, u16 val)
232 static inline u32 WPA_GET_BE24(const u8 *a)
234 return (a[0] << 16) | (a[1] << 8) | a[2];
237 static inline void WPA_PUT_BE24(u8 *a, u32 val)
239 a[0] = (val >> 16) & 0xff;
240 a[1] = (val >> 8) & 0xff;
244 static inline u32 WPA_GET_BE32(const u8 *a)
246 return ((u32) a[0] << 24) | (a[1] << 16) | (a[2] << 8) | a[3];
249 static inline void WPA_PUT_BE32(u8 *a, u32 val)
251 a[0] = (val >> 24) & 0xff;
252 a[1] = (val >> 16) & 0xff;
253 a[2] = (val >> 8) & 0xff;
257 static inline u32 WPA_GET_LE32(const u8 *a)
259 return ((u32) a[3] << 24) | (a[2] << 16) | (a[1] << 8) | a[0];
262 static inline void WPA_PUT_LE32(u8 *a, u32 val)
264 a[3] = (val >> 24) & 0xff;
265 a[2] = (val >> 16) & 0xff;
266 a[1] = (val >> 8) & 0xff;
270 static inline u64 WPA_GET_BE64(const u8 *a)
272 return (((u64) a[0]) << 56) | (((u64) a[1]) << 48) |
273 (((u64) a[2]) << 40) | (((u64) a[3]) << 32) |
274 (((u64) a[4]) << 24) | (((u64) a[5]) << 16) |
275 (((u64) a[6]) << 8) | ((u64) a[7]);
278 static inline void WPA_PUT_BE64(u8 *a, u64 val)
290 static inline u64 WPA_GET_LE64(const u8 *a)
292 return (((u64) a[7]) << 56) | (((u64) a[6]) << 48) |
293 (((u64) a[5]) << 40) | (((u64) a[4]) << 32) |
294 (((u64) a[3]) << 24) | (((u64) a[2]) << 16) |
295 (((u64) a[1]) << 8) | ((u64) a[0]);
298 static inline void WPA_PUT_LE64(u8 *a, u64 val)
321 #define ETH_P_ALL 0x0003
324 #define ETH_P_IP 0x0800
326 #ifndef ETH_P_80211_ENCAP
327 #define ETH_P_80211_ENCAP 0x890d /* TDLS comes under this category */
330 #define ETH_P_PAE 0x888E /* Port Access Entity (IEEE 802.1X) */
331 #endif /* ETH_P_PAE */
333 #define ETH_P_EAPOL ETH_P_PAE
334 #endif /* ETH_P_EAPOL */
335 #ifndef ETH_P_RSN_PREAUTH
336 #define ETH_P_RSN_PREAUTH 0x88c7
337 #endif /* ETH_P_RSN_PREAUTH */
339 #define ETH_P_RRB 0x890D
340 #endif /* ETH_P_RRB */
344 #define PRINTF_FORMAT(a,b) __attribute__ ((format (printf, (a), (b))))
345 #define STRUCT_PACKED __attribute__ ((packed))
346 #define UNUSED __attribute__ ((unused))
348 #define PRINTF_FORMAT(a,b)
349 #define STRUCT_PACKED
354 #ifdef CONFIG_ANSI_C_EXTRA
356 #if !defined(_MSC_VER) || _MSC_VER < 1400
357 /* snprintf - used in number of places; sprintf() is _not_ a good replacement
358 * due to possible buffer overflow; see, e.g.,
359 * http://www.ijs.si/software/snprintf/ for portable implementation of
361 int snprintf(char *str, size_t size, const char *format, ...);
363 /* vsnprintf - only used for wpa_msg() in wpa_supplicant.c */
364 int vsnprintf(char *str, size_t size, const char *format, va_list ap);
365 #endif /* !defined(_MSC_VER) || _MSC_VER < 1400 */
367 /* getopt - only used in main.c */
368 int getopt(int argc, char *const argv[], const char *optstring);
372 #ifndef CONFIG_NO_SOCKLEN_T_TYPEDEF
373 #ifndef __socklen_t_defined
374 typedef int socklen_t;
378 /* inline - define as __inline or just define it to be empty, if needed */
379 #ifdef CONFIG_NO_INLINE
382 #define inline __inline
386 #define __func__ "__func__ not defined"
390 #define bswap_16(a) ((((u16) (a) << 8) & 0xff00) | (((u16) (a) >> 8) & 0xff))
394 #define bswap_32(a) ((((u32) (a) << 24) & 0xff000000) | \
395 (((u32) (a) << 8) & 0xff0000) | \
396 (((u32) (a) >> 8) & 0xff00) | \
397 (((u32) (a) >> 24) & 0xff))
401 #define MSG_DONTWAIT 0
405 void perror(const char *s);
406 #endif /* _WIN32_WCE */
408 #endif /* CONFIG_ANSI_C_EXTRA */
411 #define MAC2STR(a) (a)[0], (a)[1], (a)[2], (a)[3], (a)[4], (a)[5]
412 #define MACSTR "%02x:%02x:%02x:%02x:%02x:%02x"
415 * Compact form for string representation of MAC address
416 * To be used, e.g., for constructing dbus paths for P2P Devices
418 #define COMPACT_MACSTR "%02x%02x%02x%02x%02x%02x"
422 #define BIT(x) (1U << (x))
426 * Definitions for sparse validation
427 * (http://kernel.org/pub/linux/kernel/people/josh/sparse/)
430 #define __force __attribute__((force))
432 #define __bitwise __attribute__((bitwise))
438 typedef u16 __bitwise be16;
439 typedef u16 __bitwise le16;
440 typedef u32 __bitwise be32;
441 typedef u32 __bitwise le32;
442 typedef u64 __bitwise be64;
443 typedef u64 __bitwise le64;
446 #if __GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 4)
447 #define __must_check __attribute__((__warn_unused_result__))
450 #endif /* __GNUC__ */
451 #endif /* __must_check */
453 #ifndef __maybe_unused
454 #if __GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 4)
455 #define __maybe_unused __attribute__((unused))
457 #define __maybe_unused
458 #endif /* __GNUC__ */
459 #endif /* __must_check */
461 #define SSID_MAX_LEN 32
463 struct wpa_ssid_value {
464 u8 ssid[SSID_MAX_LEN];
468 int hwaddr_aton(const char *txt, u8 *addr);
469 int hwaddr_masked_aton(const char *txt, u8 *addr, u8 *mask, u8 maskable);
470 int hwaddr_compact_aton(const char *txt, u8 *addr);
471 int hwaddr_aton2(const char *txt, u8 *addr);
472 int hex2byte(const char *hex);
473 int hexstr2bin(const char *hex, u8 *buf, size_t len);
474 void inc_byte_array(u8 *counter, size_t len);
475 void wpa_get_ntp_timestamp(u8 *buf);
476 int wpa_scnprintf(char *buf, size_t size, const char *fmt, ...);
477 int wpa_snprintf_hex_sep(char *buf, size_t buf_size, const u8 *data, size_t len,
479 int wpa_snprintf_hex(char *buf, size_t buf_size, const u8 *data, size_t len);
480 int wpa_snprintf_hex_uppercase(char *buf, size_t buf_size, const u8 *data,
483 int hwaddr_mask_txt(char *buf, size_t len, const u8 *addr, const u8 *mask);
484 int ssid_parse(const char *buf, struct wpa_ssid_value *ssid);
486 #ifdef CONFIG_NATIVE_WINDOWS
487 void wpa_unicode2ascii_inplace(TCHAR *str);
488 TCHAR * wpa_strdup_tchar(const char *str);
489 #else /* CONFIG_NATIVE_WINDOWS */
490 #define wpa_unicode2ascii_inplace(s) do { } while (0)
491 #define wpa_strdup_tchar(s) strdup((s))
492 #endif /* CONFIG_NATIVE_WINDOWS */
494 void printf_encode(char *txt, size_t maxlen, const u8 *data, size_t len);
495 size_t printf_decode(u8 *buf, size_t maxlen, const char *str);
497 const char * wpa_ssid_txt(const u8 *ssid, size_t ssid_len);
499 char * wpa_config_parse_string(const char *value, size_t *len);
500 int is_hex(const u8 *data, size_t len);
501 int has_ctrl_char(const u8 *data, size_t len);
502 int has_newline(const char *str);
503 size_t merge_byte_arrays(u8 *res, size_t res_len,
504 const u8 *src1, size_t src1_len,
505 const u8 *src2, size_t src2_len);
506 char * dup_binstr(const void *src, size_t len);
508 static inline int is_zero_ether_addr(const u8 *a)
510 return !(a[0] | a[1] | a[2] | a[3] | a[4] | a[5]);
513 static inline int is_broadcast_ether_addr(const u8 *a)
515 return (a[0] & a[1] & a[2] & a[3] & a[4] & a[5]) == 0xff;
518 static inline int is_multicast_ether_addr(const u8 *a)
523 #define broadcast_ether_addr (const u8 *) "\xff\xff\xff\xff\xff\xff"
525 #include "wpa_debug.h"
528 struct wpa_freq_range_list {
529 struct wpa_freq_range {
536 int freq_range_list_parse(struct wpa_freq_range_list *res, const char *value);
537 int freq_range_list_includes(const struct wpa_freq_range_list *list,
539 char * freq_range_list_str(const struct wpa_freq_range_list *list);
541 int int_array_len(const int *a);
542 void int_array_concat(int **res, const int *a);
543 void int_array_sort_unique(int *a);
544 void int_array_add_unique(int **res, int a);
546 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
548 void str_clear_free(char *str);
549 void bin_clear_free(void *bin, size_t len);
551 int random_mac_addr(u8 *addr);
552 int random_mac_addr_keep_oui(u8 *addr);
554 const char * cstr_token(const char *str, const char *delim, const char **last);
555 char * str_token(char *str, const char *delim, char **context);
556 size_t utf8_escape(const char *inp, size_t in_size,
557 char *outp, size_t out_size);
558 size_t utf8_unescape(const char *inp, size_t in_size,
559 char *outp, size_t out_size);
560 int is_ctrl_char(char c);
562 int str_starts(const char *str, const char *start);
566 * gcc 4.4 ends up generating strict-aliasing warnings about some very common
567 * networking socket uses that do not really result in a real problem and
568 * cannot be easily avoided with union-based type-punning due to struct
569 * definitions including another struct in system header files. To avoid having
570 * to fully disable strict-aliasing warnings, provide a mechanism to hide the
571 * typecast from aliasing for now. A cleaner solution will hopefully be found
572 * in the future to handle these cases.
574 void * __hide_aliasing_typecast(void *foo);
575 #define aliasing_hide_typecast(a,t) (t *) __hide_aliasing_typecast((a))
577 #ifdef CONFIG_VALGRIND
578 #include <valgrind/memcheck.h>
579 #define WPA_MEM_DEFINED(ptr, len) VALGRIND_MAKE_MEM_DEFINED((ptr), (len))
580 #else /* CONFIG_VALGRIND */
581 #define WPA_MEM_DEFINED(ptr, len) do { } while (0)
582 #endif /* CONFIG_VALGRIND */
584 #endif /* COMMON_H */