]>
git.ipfire.org Git - thirdparty/hostap.git/blob - src/utils/common.h
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__ */
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__ */
65 #ifdef CONFIG_NATIVE_WINDOWS
68 typedef int socklen_t
;
71 #define MSG_DONTWAIT 0 /* not supported */
74 #endif /* CONFIG_NATIVE_WINDOWS */
77 #define inline __inline
80 #define vsnprintf _vsnprintf
82 #define close closesocket
86 /* Define platform specific integer types */
97 #define WPA_TYPES_DEFINED
101 typedef unsigned long long u64
;
105 typedef long long s64
;
109 #define WPA_TYPES_DEFINED
110 #endif /* __vxworks */
112 #ifndef WPA_TYPES_DEFINED
113 #ifdef CONFIG_USE_INTTYPES_H
114 #include <inttypes.h>
118 typedef uint64_t u64
;
119 typedef uint32_t u32
;
120 typedef uint16_t u16
;
126 #define WPA_TYPES_DEFINED
127 #endif /* !WPA_TYPES_DEFINED */
130 /* Define platform specific byte swapping macros */
132 #if defined(__CYGWIN__) || defined(CONFIG_NATIVE_WINDOWS)
134 static inline unsigned short wpa_swap_16(unsigned short v
)
136 return ((v
& 0xff) << 8) | (v
>> 8);
139 static inline unsigned int wpa_swap_32(unsigned int v
)
141 return ((v
& 0xff) << 24) | ((v
& 0xff00) << 8) |
142 ((v
& 0xff0000) >> 8) | (v
>> 24);
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)
155 #define WPA_BYTE_SWAP_DEFINED
157 #endif /* __CYGWIN__ || CONFIG_NATIVE_WINDOWS */
160 #ifndef WPA_BYTE_SWAP_DEFINED
163 #ifndef __LITTLE_ENDIAN
165 #define __LITTLE_ENDIAN 1234
166 #define __BIG_ENDIAN 4321
168 #define __BYTE_ORDER __BIG_ENDIAN
170 #endif /* __BIG_ENDIAN */
171 #endif /* __LITTLE_ENDIAN */
172 #endif /* __BYTE_ORDER */
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
204 #error Could not determine CPU byte order
207 #define WPA_BYTE_SWAP_DEFINED
208 #endif /* !WPA_BYTE_SWAP_DEFINED */
211 /* Macros for handling unaligned memory accesses */
213 static inline u16
WPA_GET_BE16(const u8
*a
)
215 return (a
[0] << 8) | a
[1];
218 static inline void WPA_PUT_BE16(u8
*a
, u16 val
)
224 static inline u16
WPA_GET_LE16(const u8
*a
)
226 return (a
[1] << 8) | a
[0];
229 static inline void WPA_PUT_LE16(u8
*a
, u16 val
)
235 static inline u32
WPA_GET_BE24(const u8
*a
)
237 return (a
[0] << 16) | (a
[1] << 8) | a
[2];
240 static inline void WPA_PUT_BE24(u8
*a
, u32 val
)
242 a
[0] = (val
>> 16) & 0xff;
243 a
[1] = (val
>> 8) & 0xff;
247 static inline u32
WPA_GET_BE32(const u8
*a
)
249 return ((u32
) a
[0] << 24) | (a
[1] << 16) | (a
[2] << 8) | a
[3];
252 static inline void WPA_PUT_BE32(u8
*a
, u32 val
)
254 a
[0] = (val
>> 24) & 0xff;
255 a
[1] = (val
>> 16) & 0xff;
256 a
[2] = (val
>> 8) & 0xff;
260 static inline u32
WPA_GET_LE32(const u8
*a
)
262 return ((u32
) a
[3] << 24) | (a
[2] << 16) | (a
[1] << 8) | a
[0];
265 static inline void WPA_PUT_LE32(u8
*a
, u32 val
)
267 a
[3] = (val
>> 24) & 0xff;
268 a
[2] = (val
>> 16) & 0xff;
269 a
[1] = (val
>> 8) & 0xff;
273 static inline u64
WPA_GET_BE64(const u8
*a
)
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]);
281 static inline void WPA_PUT_BE64(u8
*a
, u64 val
)
293 static inline u64
WPA_GET_LE64(const u8
*a
)
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]);
301 static inline void WPA_PUT_LE64(u8
*a
, u64 val
)
324 #define ETH_P_ALL 0x0003
327 #define ETH_P_IP 0x0800
329 #ifndef ETH_P_80211_ENCAP
330 #define ETH_P_80211_ENCAP 0x890d /* TDLS comes under this category */
333 #define ETH_P_PAE 0x888E /* Port Access Entity (IEEE 802.1X) */
334 #endif /* ETH_P_PAE */
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 */
342 #define ETH_P_RRB 0x890D
343 #endif /* ETH_P_RRB */
345 #define ETH_P_OUI 0x88B7
346 #endif /* ETH_P_OUI */
350 #define PRINTF_FORMAT(a,b) __attribute__ ((format (printf, (a), (b))))
351 #define STRUCT_PACKED __attribute__ ((packed))
353 #define PRINTF_FORMAT(a,b)
354 #define STRUCT_PACKED
358 #ifdef CONFIG_ANSI_C_EXTRA
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
365 int snprintf(char *str
, size_t size
, const char *format
, ...);
367 /* vsnprintf - only used for wpa_msg() in wpa_supplicant.c */
368 int vsnprintf(char *str
, size_t size
, const char *format
, va_list ap
);
369 #endif /* !defined(_MSC_VER) || _MSC_VER < 1400 */
371 /* getopt - only used in main.c */
372 int getopt(int argc
, char *const argv
[], const char *optstring
);
376 #ifndef CONFIG_NO_SOCKLEN_T_TYPEDEF
377 #ifndef __socklen_t_defined
378 typedef int socklen_t
;
382 /* inline - define as __inline or just define it to be empty, if needed */
383 #ifdef CONFIG_NO_INLINE
386 #define inline __inline
390 #define __func__ "__func__ not defined"
394 #define bswap_16(a) ((((u16) (a) << 8) & 0xff00) | (((u16) (a) >> 8) & 0xff))
398 #define bswap_32(a) ((((u32) (a) << 24) & 0xff000000) | \
399 (((u32) (a) << 8) & 0xff0000) | \
400 (((u32) (a) >> 8) & 0xff00) | \
401 (((u32) (a) >> 24) & 0xff))
405 #define MSG_DONTWAIT 0
409 void perror(const char *s
);
410 #endif /* _WIN32_WCE */
412 #endif /* CONFIG_ANSI_C_EXTRA */
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"
419 * Compact form for string representation of MAC address
420 * To be used, e.g., for constructing dbus paths for P2P Devices
422 #define COMPACT_MACSTR "%02x%02x%02x%02x%02x%02x"
426 #define BIT(x) (1U << (x))
430 * Definitions for sparse validation
431 * (http://kernel.org/pub/linux/kernel/people/josh/sparse/)
434 #define __force __attribute__((force))
436 #define __bitwise __attribute__((bitwise))
443 typedef u16 __bitwise be16
;
444 typedef u16 __bitwise le16
;
445 typedef u32 __bitwise be32
;
446 typedef u32 __bitwise le32
;
447 typedef u64 __bitwise be64
;
448 typedef u64 __bitwise le64
;
451 #if __GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 4)
452 #define __must_check __attribute__((__warn_unused_result__))
455 #endif /* __GNUC__ */
456 #endif /* __must_check */
458 #ifndef __maybe_unused
459 #if __GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 4)
460 #define __maybe_unused __attribute__((unused))
462 #define __maybe_unused
463 #endif /* __GNUC__ */
464 #endif /* __must_check */
466 #define SSID_MAX_LEN 32
468 struct wpa_ssid_value
{
469 u8 ssid
[SSID_MAX_LEN
];
473 int hwaddr_aton(const char *txt
, u8
*addr
);
474 int hwaddr_masked_aton(const char *txt
, u8
*addr
, u8
*mask
, u8 maskable
);
475 int hwaddr_compact_aton(const char *txt
, u8
*addr
);
476 int hwaddr_aton2(const char *txt
, u8
*addr
);
477 int hex2byte(const char *hex
);
478 int hexstr2bin(const char *hex
, u8
*buf
, size_t len
);
479 void inc_byte_array(u8
*counter
, size_t len
);
480 void wpa_get_ntp_timestamp(u8
*buf
);
481 int wpa_scnprintf(char *buf
, size_t size
, const char *fmt
, ...);
482 int wpa_snprintf_hex_sep(char *buf
, size_t buf_size
, const u8
*data
, size_t len
,
484 int wpa_snprintf_hex(char *buf
, size_t buf_size
, const u8
*data
, size_t len
);
485 int wpa_snprintf_hex_uppercase(char *buf
, size_t buf_size
, const u8
*data
,
488 int hwaddr_mask_txt(char *buf
, size_t len
, const u8
*addr
, const u8
*mask
);
489 int ssid_parse(const char *buf
, struct wpa_ssid_value
*ssid
);
491 #ifdef CONFIG_NATIVE_WINDOWS
492 void wpa_unicode2ascii_inplace(TCHAR
*str
);
493 TCHAR
* wpa_strdup_tchar(const char *str
);
494 #else /* CONFIG_NATIVE_WINDOWS */
495 #define wpa_unicode2ascii_inplace(s) do { } while (0)
496 #define wpa_strdup_tchar(s) strdup((s))
497 #endif /* CONFIG_NATIVE_WINDOWS */
499 void printf_encode(char *txt
, size_t maxlen
, const u8
*data
, size_t len
);
500 size_t printf_decode(u8
*buf
, size_t maxlen
, const char *str
);
502 const char * wpa_ssid_txt(const u8
*ssid
, size_t ssid_len
);
504 char * wpa_config_parse_string(const char *value
, size_t *len
);
505 int is_hex(const u8
*data
, size_t len
);
506 int has_ctrl_char(const u8
*data
, size_t len
);
507 int has_newline(const char *str
);
508 size_t merge_byte_arrays(u8
*res
, size_t res_len
,
509 const u8
*src1
, size_t src1_len
,
510 const u8
*src2
, size_t src2_len
);
511 char * dup_binstr(const void *src
, size_t len
);
513 static inline int is_zero_ether_addr(const u8
*a
)
515 return !(a
[0] | a
[1] | a
[2] | a
[3] | a
[4] | a
[5]);
518 static inline int is_broadcast_ether_addr(const u8
*a
)
520 return (a
[0] & a
[1] & a
[2] & a
[3] & a
[4] & a
[5]) == 0xff;
523 static inline int is_multicast_ether_addr(const u8
*a
)
528 #define broadcast_ether_addr (const u8 *) "\xff\xff\xff\xff\xff\xff"
530 #include "wpa_debug.h"
533 struct wpa_freq_range_list
{
534 struct wpa_freq_range
{
541 int freq_range_list_parse(struct wpa_freq_range_list
*res
, const char *value
);
542 int freq_range_list_includes(const struct wpa_freq_range_list
*list
,
544 char * freq_range_list_str(const struct wpa_freq_range_list
*list
);
546 int int_array_len(const int *a
);
547 void int_array_concat(int **res
, const int *a
);
548 void int_array_sort_unique(int *a
);
549 void int_array_add_unique(int **res
, int a
);
551 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
553 void str_clear_free(char *str
);
554 void bin_clear_free(void *bin
, size_t len
);
556 int random_mac_addr(u8
*addr
);
557 int random_mac_addr_keep_oui(u8
*addr
);
559 const char * cstr_token(const char *str
, const char *delim
, const char **last
);
560 char * str_token(char *str
, const char *delim
, char **context
);
561 size_t utf8_escape(const char *inp
, size_t in_size
,
562 char *outp
, size_t out_size
);
563 size_t utf8_unescape(const char *inp
, size_t in_size
,
564 char *outp
, size_t out_size
);
565 int is_ctrl_char(char c
);
567 int str_starts(const char *str
, const char *start
);
569 u8
rssi_to_rcpi(int rssi
);
572 * gcc 4.4 ends up generating strict-aliasing warnings about some very common
573 * networking socket uses that do not really result in a real problem and
574 * cannot be easily avoided with union-based type-punning due to struct
575 * definitions including another struct in system header files. To avoid having
576 * to fully disable strict-aliasing warnings, provide a mechanism to hide the
577 * typecast from aliasing for now. A cleaner solution will hopefully be found
578 * in the future to handle these cases.
580 void * __hide_aliasing_typecast(void *foo
);
581 #define aliasing_hide_typecast(a,t) (t *) __hide_aliasing_typecast((a))
583 #ifdef CONFIG_VALGRIND
584 #include <valgrind/memcheck.h>
585 #define WPA_MEM_DEFINED(ptr, len) VALGRIND_MAKE_MEM_DEFINED((ptr), (len))
586 #else /* CONFIG_VALGRIND */
587 #define WPA_MEM_DEFINED(ptr, len) do { } while (0)
588 #endif /* CONFIG_VALGRIND */
590 #endif /* COMMON_H */