/*
- silctypes.h
+ silctypes.h
Author: Pekka Riikonen <priikone@silcnet.org>
- Copyright (C) 2002 Pekka Riikonen
+ Copyright (C) 2002 - 2007 Pekka Riikonen
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
#ifndef SILCTYPES_H
#define SILCTYPES_H
+/****d* silcutil/SILCTypes/SilcBool
+ *
+ * NAME
+ *
+ * typedef unigned char SilcBool;
+ *
+ * DESCRIPTION
+ *
+ * Boolean value, and is always 8-bits. Represents value 0 or 1.
+ *
+ ***/
+typedef unsigned char SilcBool;
+
+/* The bool macro is deprecated. Use SilcBool instead. */
+#ifdef SILC_MACOSX
+#define bool _Bool
+#endif
+#ifndef __cplusplus
+#ifndef bool
+#define bool unsigned char
+#endif
+#endif
+
+/****d* silcutil/SILCTypes/TRUE
+ *
+ * NAME
+ *
+ * #define TRUE ...
+ *
+ * DESCRIPTION
+ *
+ * Boolean true value indicator.
+ *
+ * SOURCE
+ */
#ifndef TRUE
#define TRUE 1
#endif
+/***/
+
+/****d* silcutil/SILCTypes/FALSE
+ *
+ * NAME
+ *
+ * #define FALSE ...
+ *
+ * DESCRIPTION
+ *
+ * Boolean false value indicator.
+ *
+ * SOURCE
+ */
#ifndef FALSE
#define FALSE 0
#endif
+/***/
-/* Define offsetof */
-#ifndef offsetof
-#define offsetof(TYPE, MEMBER) ((size_t) &((TYPE *)0)->MEMBER)
-#endif
+/* Our offsetof macro */
+#define silc_offsetof(TYPE, MEMBER) ((size_t) &((TYPE *)0)->MEMBER)
+
+/* silc_likely and silc_unlikely GCC branch prediction macros. Use only if
+ you have profiled the code first. */
+#if __GNUC__ >= 3
+#define silc_likely(expr) __builtin_expect(!!(expr), 1)
+#define silc_unlikely(expr) __builtin_expect(!!(expr), 0)
+#else
+#define silc_likely(expr) (expr)
+#define silc_unlikely(expr) (expr)
+#endif /* __GNUC__ >= 3 */
#if SILC_SIZEOF_SHORT > 2
#error "size of the short must be 2 bytes"
*
* SOURCE
*/
-#if SILC_SIZEOF_LONG == 4
-typedef unsigned long SilcUInt32;
-typedef signed long SilcInt32;
-#else
#if SILC_SIZEOF_INT == 4
typedef unsigned int SilcUInt32;
typedef signed int SilcInt32;
#else
+#if SILC_SIZEOF_LONG == 4
+typedef unsigned long SilcUInt32;
+typedef signed long SilcInt32;
+#else
#if SILC_SIZEOF_LONG_LONG >= 4
#ifndef WIN32
typedef unsigned long long SilcUInt32;
typedef unsigned long long SilcUInt64;
typedef signed long long SilcInt64;
#else
-typedef SilcUInt32 SilcUInt64; /* XXX Use Windows's own 64 bit types */
-typedef SilcInt32 SilcInt64;
+typedef unsigned __int64 SilcUInt64;
+typedef signed __int64 SilcInt64;
#endif
#else
typedef SilcUInt32 SilcUInt64;
typedef SilcUInt32 * void *;
#endif
-#ifndef __cplusplus
-#ifndef bool
-#define bool unsigned char
-#endif
+/****d* silcutil/SILCTypes/SilcSocket
+ *
+ * NAME
+ *
+ * SilcSocket
+ *
+ * DESCRIPTION
+ *
+ * Platform specific socket. On POSIX compliant systems this is simply
+ * an integer, representing the socket. On other systems it is platform
+ * specific socket context. Access it only through routines that can
+ * handle SilcSocket types, unless you know what you are doing.
+ *
+ * SOURCE
+ */
+#if defined(SILC_UNIX)
+typedef int SilcSocket;
+#elif defined(SILC_WIN32)
+typedef SOCKET SilcSocket;
+#elif defined(SILC_SYMBIAN)
+typedef void * SilcSocket;
#endif
+/***/
+
+/* Macros */
-#define GET_WORD(cp) ((SilcUInt32)(SilcUInt8)(cp)[0]) << 24 \
- | ((SilcUInt32)(SilcUInt8)(cp)[1] << 16) \
- | ((SilcUInt32)(SilcUInt8)(cp)[2] << 8) \
+#define SILC_GET_WORD(cp) ((SilcUInt32)(SilcUInt8)(cp)[0]) << 24 \
+ | ((SilcUInt32)(SilcUInt8)(cp)[1] << 16) \
+ | ((SilcUInt32)(SilcUInt8)(cp)[2] << 8) \
| ((SilcUInt32)(SilcUInt8)(cp)[3])
/****d* silcutil/SILCTypes/SILC_GET16_MSB
* SOURCE
*/
#define SILC_GET16_MSB(l, cp) \
- (l) = ((SilcUInt32)(SilcUInt8)(cp)[0] << 8) \
- | ((SilcUInt32)(SilcUInt8)(cp)[1])
+do { \
+ (l) = ((SilcUInt32)(SilcUInt8)(cp)[0] << 8) \
+ | ((SilcUInt32)(SilcUInt8)(cp)[1]); \
+} while(0)
/***/
-/****d* silcutil/SILCTypes/SILC_PUT16_MSB
+/****d* silcutil/SILCTypes/SILC_GET32_MSB
*
* NAME
*
- * #define SILC_PUT16_MSB ...
+ * #define SILC_GET32_MSB ...
*
* DESCRIPTION
*
- * Put two 8-bit bytes, most significant bytes first.
+ * Return four 8-bit bytes, most significant bytes first.
*
* SOURCE
*/
-#define SILC_PUT16_MSB(l, cp) \
- (cp)[0] = l >> 8; \
- (cp)[1] = l;
+#define SILC_GET32_MSB(l, cp) \
+do { \
+ (l) = ((SilcUInt32)(SilcUInt8)(cp)[0]) << 24 \
+ | ((SilcUInt32)(SilcUInt8)(cp)[1] << 16) \
+ | ((SilcUInt32)(SilcUInt8)(cp)[2] << 8) \
+ | ((SilcUInt32)(SilcUInt8)(cp)[3]); \
+} while(0)
+/***/
+
+/****d* silcutil/SILCTypes/SILC_GET64_MSB
+ *
+ * NAME
+ *
+ * #define SILC_GET64_MSB ...
+ *
+ * DESCRIPTION
+ *
+ * Return eight 8-bit bytes, most significant bytes first.
+ *
+ * SOURCE
+ */
+#define SILC_GET64_MSB(l, cp) \
+do { \
+ (l) = ((((SilcUInt64)SILC_GET_WORD((cp))) << 32) | \
+ ((SilcUInt64)SILC_GET_WORD((cp) + 4))); \
+} while(0)
/***/
/****d* silcutil/SILCTypes/SILC_GET16_LSB
*
* SOURCE
*/
+#if defined(SILC_I486) && defined(__GNUC__)
+#define SILC_GET16_LSB(l, cp) (l) = (*(SilcUInt16 *)(cp))
+#else
#define SILC_GET16_LSB(l, cp) \
- (l) = ((SilcUInt32)(SilcUInt8)(cp)[0]) \
- | ((SilcUInt32)(SilcUInt8)(cp)[1] << 8)
+do { \
+ (l) = ((SilcUInt32)(SilcUInt8)(cp)[0]) \
+ | ((SilcUInt32)(SilcUInt8)(cp)[1] << 8); \
+} while(0)
+#endif /* SILC_I486 && __GNUC__ */
/***/
-/****d* silcutil/SILCTypes/SILC_PUT16_LSB
+/****d* silcutil/SILCTypes/SILC_GET32_LSB
*
* NAME
*
- * #define SILC_PUT16_LSB ...
+ * #define SILC_GET32_LSB ...
*
* DESCRIPTION
*
- * Put two 8-bit bytes, least significant bytes first.
+ * Return four 8-bit bytes, least significant bytes first.
*
* SOURCE
*/
-#define SILC_PUT16_LSB(l, cp) \
- (cp)[0] = l; \
- (cp)[1] = l >> 8;
+#if defined(SILC_I486) && defined(__GNUC__)
+#define SILC_GET32_LSB(l, cp) (l) = (*(SilcUInt32 *)(cp))
+#else
+#define SILC_GET32_LSB(l, cp) \
+do { \
+ (l) = ((SilcUInt32)(SilcUInt8)(cp)[0]) \
+ | ((SilcUInt32)(SilcUInt8)(cp)[1] << 8) \
+ | ((SilcUInt32)(SilcUInt8)(cp)[2] << 16) \
+ | ((SilcUInt32)(SilcUInt8)(cp)[3] << 24); \
+} while(0)
+#endif /* SILC_I486 && __GNUC__ */
+
+/* Same as upper but XOR the result always. Special purpose macro. */
+#if defined(SILC_I486) && defined(__GNUC__)
+#define SILC_GET32_X_LSB(l, cp) (l) ^= (*(SilcUInt32 *)(cp))
+#else
+#define SILC_GET32_X_LSB(l, cp) \
+ (l) ^= ((SilcUInt32)(SilcUInt8)(cp)[0]) \
+ | ((SilcUInt32)(SilcUInt8)(cp)[1] << 8) \
+ | ((SilcUInt32)(SilcUInt8)(cp)[2] << 16) \
+ | ((SilcUInt32)(SilcUInt8)(cp)[3] << 24)
+#endif /* SILC_I486 && __GNUC__ */
/***/
-/****d* silcutil/SILCTypes/SILC_GET32_MSB
+/****d* silcutil/SILCTypes/SILC_PUT16_MSB
*
* NAME
*
- * #define SILC_GET32_MSB ...
+ * #define SILC_PUT16_MSB ...
*
* DESCRIPTION
*
- * Return four 8-bit bytes, most significant bytes first.
+ * Put two 8-bit bytes, most significant bytes first.
*
* SOURCE
*/
-#define SILC_GET32_MSB(l, cp) \
- (l) = ((SilcUInt32)(SilcUInt8)(cp)[0]) << 24 \
- | ((SilcUInt32)(SilcUInt8)(cp)[1] << 16) \
- | ((SilcUInt32)(SilcUInt8)(cp)[2] << 8) \
- | ((SilcUInt32)(SilcUInt8)(cp)[3])
+#define SILC_PUT16_MSB(l, cp) \
+do { \
+ (cp)[0] = (SilcUInt8)((l) >> 8); \
+ (cp)[1] = (SilcUInt8)(l); \
+} while(0)
/***/
/****d* silcutil/SILCTypes/SILC_PUT32_MSB
* SOURCE
*/
#define SILC_PUT32_MSB(l, cp) \
- (cp)[0] = l >> 24; \
- (cp)[1] = l >> 16; \
- (cp)[2] = l >> 8; \
- (cp)[3] = l;
+do { \
+ (cp)[0] = (SilcUInt8)((l) >> 24); \
+ (cp)[1] = (SilcUInt8)((l) >> 16); \
+ (cp)[2] = (SilcUInt8)((l) >> 8); \
+ (cp)[3] = (SilcUInt8)(l); \
+} while(0)
/***/
-/****d* silcutil/SILCTypes/SILC_GET32_LSB
+/****d* silcutil/SILCTypes/SILC_PUT64_MSB
*
* NAME
*
- * #define SILC_GET32_LSB ...
+ * #define SILC_PUT64_MSB ...
*
* DESCRIPTION
*
- * Return four 8-bit bytes, least significant bytes first.
+ * Put eight 8-bit bytes, most significant bytes first.
*
* SOURCE
*/
-#define SILC_GET32_LSB(l, cp) \
- (l) = ((SilcUInt32)(SilcUInt8)(cp)[0]) \
- | ((SilcUInt32)(SilcUInt8)(cp)[1] << 8) \
- | ((SilcUInt32)(SilcUInt8)(cp)[2] << 16) \
- | ((SilcUInt32)(SilcUInt8)(cp)[3] << 24)
+#define SILC_PUT64_MSB(l, cp) \
+do { \
+ SILC_PUT32_MSB((SilcUInt32)((SilcUInt64)(l) >> 32), (cp)); \
+ SILC_PUT32_MSB((SilcUInt32)(l), (cp) + 4); \
+} while(0)
+/***/
-/* Same as upper but XOR the result always. Special purpose macro. */
-#define SILC_GET32_X_LSB(l, cp) \
- (l) ^= ((SilcUInt32)(SilcUInt8)(cp)[0]) \
- | ((SilcUInt32)(SilcUInt8)(cp)[1] << 8) \
- | ((SilcUInt32)(SilcUInt8)(cp)[2] << 16) \
- | ((SilcUInt32)(SilcUInt8)(cp)[3] << 24)
+/****d* silcutil/SILCTypes/SILC_PUT16_LSB
+ *
+ * NAME
+ *
+ * #define SILC_PUT16_LSB ...
+ *
+ * DESCRIPTION
+ *
+ * Put two 8-bit bytes, least significant bytes first.
+ *
+ * SOURCE
+ */
+#if defined(SILC_I486) && defined(__GNUC__)
+#define SILC_PUT16_LSB(l, cp) (*(SilcUInt16 *)(cp)) = (l)
+#else
+#define SILC_PUT16_LSB(l, cp) \
+do { \
+ (cp)[0] = (SilcUInt8)(l); \
+ (cp)[1] = (SilcUInt8)((l) >> 8); \
+} while(0)
+#endif /* SILC_I486 && __GNUC__ */
/***/
/****d* silcutil/SILCTypes/SILC_PUT32_LSB
*
* SOURCE
*/
+#if defined(SILC_I486) && defined(__GNUC__)
+#define SILC_PUT32_LSB(l, cp) (*(SilcUInt32 *)(cp)) = (l)
+#else
#define SILC_PUT32_LSB(l, cp) \
- (cp)[0] = l; \
- (cp)[1] = l >> 8; \
- (cp)[2] = l >> 16; \
- (cp)[3] = l >> 24;
+do { \
+ (cp)[0] = (SilcUInt8)(l); \
+ (cp)[1] = (SilcUInt8)((l) >> 8); \
+ (cp)[2] = (SilcUInt8)((l) >> 16); \
+ (cp)[3] = (SilcUInt8)((l) >> 24); \
+} while(0)
+#endif /* SILC_I486 && __GNUC__ */
/***/
-/****d* silcutil/SILCTypes/SILC_GET64_MSB
+/****d* silcutil/SILCTypes/SILC_SWAB_16
*
* NAME
*
- * #define SILC_GET64_MSB ...
+ * #define SILC_SWAB_16 ...
*
* DESCRIPTION
*
- * Return eight 8-bit bytes, most significant bytes first.
+ * Swabs 16-bit unsigned integer byte order.
*
* SOURCE
*/
-#define SILC_GET64_MSB(l, cp) \
- (l) = ((((SilcUInt64)GET_WORD((cp))) << 32) | \
- ((SilcUInt64)GET_WORD((cp) + 4)))
+#define SILC_SWAB_16(l) \
+ ((SilcUInt16)(((SilcUInt16)(l) & (SilcUInt16)0x00FFU) << 8) | \
+ (((SilcUInt16)(l) & (SilcUInt16)0xFF00U) >> 8))
/***/
-/****d* silcutil/SILCTypes/SILC_PUT64_MSB
+/****d* silcutil/SILCTypes/SILC_SWAB_32
*
* NAME
*
- * #define SILC_PUT64_MSB ...
+ * #define SILC_SWAB_32 ...
*
* DESCRIPTION
*
- * Put eight 8-bit bytes, most significant bytes first.
+ * Swabs 32-bit unsigned integer byte order.
*
* SOURCE
*/
-#define SILC_PUT64_MSB(l, cp) \
-do { \
- SILC_PUT32_MSB((SilcUInt32)((SilcUInt64)(l) >> 32), (cp)); \
- SILC_PUT32_MSB((SilcUInt32)(l), (cp) + 4); \
-} while(0)
+#define SILC_SWAB_32(l) \
+ ((SilcUInt32)(((SilcUInt32)(l) & (SilcUInt32)0x000000FFUL) << 24) | \
+ (((SilcUInt32)(l) & (SilcUInt32)0x0000FF00UL) << 8) | \
+ (((SilcUInt32)(l) & (SilcUInt32)0x00FF0000UL) >> 8) | \
+ (((SilcUInt32)(l) & (SilcUInt32)0xFF000000UL) >> 24))
/***/
+/****d* silcutil/SILCTypes/SILC_PTR_TO_32
+ *
+ * NAME
+ *
+ * #define SILC_PTR_TO_32 ...
+ *
+ * DESCRIPTION
+ *
+ * Type casts a pointer's value into a 32-bit integer. Use this to
+ * avoid compiler warnings when type casting pointers to integers
+ * of different size.
+ *
+ * SOURCE
+ */
+#if SILC_SIZEOF_VOID_P < 8
+#define SILC_PTR_TO_32(_ptr__) ((SilcUInt32)(_ptr__))
+#else
+#define SILC_PTR_TO_32(_ptr__) \
+ ((SilcUInt32)((SilcUInt64)(_ptr__) & (SilcUInt32)0xFFFFFFFFUL))
+#endif
+/***/
+
+/****d* silcutil/SILCTypes/SILC_PTR_TO_64
+ *
+ * NAME
+ *
+ * #define SILC_PTR_TO_64 ...
+ *
+ * DESCRIPTION
+ *
+ * Type casts a pointer's value into a 64-bit integer. Use this to
+ * avoid compiler warnings when type casting pointers to integers
+ * of different size.
+ *
+ * SOURCE
+ */
+#if SILC_SIZEOF_VOID_P < 8
+#define SILC_PTR_TO_64(_ptr__) ((SilcUInt64)((SilcUInt32)(_ptr__)))
+#else
+#define SILC_PTR_TO_64(_ptr__) ((SilcUInt64)((SilcUInt64)(_ptr__)))
+#endif
+/***/
+
+/****d* silcutil/SILCTypes/SILC_32_TO_PTR
+ *
+ * NAME
+ *
+ * #define SILC_32_TO_PTR ...
+ *
+ * DESCRIPTION
+ *
+ * Type casts a 32-bit integer value into a pointer. Use this to
+ * avoid compiler warnings when type casting integers to pointers of
+ * different size.
+ *
+ * SOURCE
+ */
+#if SILC_SIZEOF_VOID_P < 8
+#define SILC_32_TO_PTR(_ival__) ((void *)((SilcUInt32)(_ival__)))
+#else
+#define SILC_32_TO_PTR(_ival__) ((void *)((SilcUInt64)(_ival__)))
+#endif
+/***/
+
+/****d* silcutil/SILCTypes/SILC_64_TO_PTR
+ *
+ * NAME
+ *
+ * #define SILC_64_TO_PTR ...
+ *
+ * DESCRIPTION
+ *
+ * Type casts a 64-bit integer value into a pointer. Use this to
+ * avoid compiler warnings when type casting integers to pointers of
+ * different size.
+ *
+ * SOURCE
+ */
+#if SILC_SIZEOF_VOID_P < 8
+#define SILC_64_TO_PTR(_ival__) \
+ ((void *)((SilcUInt32)((SilcUInt64)(_ival__) & (SilcUInt32)0xFFFFFFFFUL)))
+#else
+#define SILC_64_TO_PTR(_ival__) ((void *)((SilcUInt64)(_ival__)))
+#endif
+/***/
+
+typedef char __check_size1[sizeof(SilcInt8) == 1 ? 1 : -1];
+typedef char __check_size2[sizeof(SilcUInt8) == 1 ? 1 : -1];
+typedef char __check_size3[sizeof(SilcInt16) == 2 ? 1 : -1];
+typedef char __check_size4[sizeof(SilcUInt16) == 2 ? 1 : -1];
+typedef char __check_size5[sizeof(SilcInt32) == 4 ? 1 : -1];
+typedef char __check_size6[sizeof(SilcUInt32) == 4 ? 1 : -1];
+
#endif /* SILCTYPES_H */
projects / silc.git / blobdiff