afw_endian.h

Go to the documentation of this file.

// See the 'COPYING' file in the project root for licensing information.
/*
 * Adaptive Framework Endian Header
 *
 * Copyright (c) 2010-2023 Clemson University
 *
 */
 
#ifndef __AFW_ENDIAN_H__
#define __AFW_ENDIAN_H__
 
#include "afw_common.h"
 
AFW_BEGIN_DECLARES
 
#define AFW_ENDIAN_IS_BIG APR_IS_BIGENDIAN
 
#define AFW_ENDIAN_SWAP(_X_, _Y_) \
    _X_ ^= _Y_; \
    _Y_ ^= _X_; \
    _X_ ^= _Y_
 
#define AFW_ENDIAN_SWITCH_64(_N_) \
    AFW_ENDIAN_SWAP(((unsigned char *)(_N_))[0], ((unsigned char *)(_N_))[7]); \
    AFW_ENDIAN_SWAP(((unsigned char *)(_N_))[1], ((unsigned char *)(_N_))[6]); \
    AFW_ENDIAN_SWAP(((unsigned char *)(_N_))[2], ((unsigned char *)(_N_))[5]); \
    AFW_ENDIAN_SWAP(((unsigned char *)(_N_))[3], ((unsigned char *)(_N_))[4]); \
 
#define AFW_ENDIAN_SWITCH_32(_N_) \
    AFW_ENDIAN_SWAP(((unsigned char *)(_N_))[0], ((unsigned char *)(_N_))[3]); \
    AFW_ENDIAN_SWAP(((unsigned char *)(_N_))[1], ((unsigned char *)(_N_))[2]); \
 
#define AFW_ENDIAN_SWITCH_16(_N_) \
    AFW_ENDIAN_SWAP(((unsigned char *)(_N_))[0], ((unsigned char *)(_N_))[1]); \
 
 
#if AFW_ENDIAN_IS_BIG
#define AFW_ENDIAN_IS_LITTLE 0
#define AFW_ENDIAN_NATIVE_TO_LITTLE_64(_N_) AFW_ENDIAN_SWITCH_64(_N_)
#define AFW_ENDIAN_LITTLE_TO_NATIVE_64(_N_) AFW_ENDIAN_SWITCH_64(_N_)
#define AFW_ENDIAN_NATIVE_TO_LITTLE_32(_N_) AFW_ENDIAN_SWITCH_32(_N_)
#define AFW_ENDIAN_LITTLE_TO_NATIVE_32(_N_) AFW_ENDIAN_SWITCH_32(_N_)
#define AFW_ENDIAN_NATIVE_TO_LITTLE_16(_N_) AFW_ENDIAN_SWITCH_16(_N_)
#define AFW_ENDIAN_LITTLE_TO_NATIVE_16(_N_) AFW_ENDIAN_SWITCH_16(_N_)
#define AFW_ENDIAN_NATIVE_TO_BIG_64(_N_)
#define AFW_ENDIAN_BIG_TO_NATIVE_64(_N_)
#define AFW_ENDIAN_NATIVE_TO_BIG_32(_N_)
#define AFW_ENDIAN_BIG_TO_NATIVE_32(_N_)
#define AFW_ENDIAN_NATIVE_TO_BIG_16(_N_)
#define AFW_ENDIAN_BIG_TO_NATIVE_16(_N_)
#else
#define AFW_ENDIAN_IS_LITTLE 1
#define AFW_ENDIAN_NATIVE_TO_LITTLE_64(_N_)
#define AFW_ENDIAN_LITTLE_TO_NATIVE_64(_N_)
#define AFW_ENDIAN_NATIVE_TO_LITTLE_32(_N_)
#define AFW_ENDIAN_LITTLE_TO_NATIVE_32(_N_)
#define AFW_ENDIAN_NATIVE_TO_LITTLE_16(_N_)
#define AFW_ENDIAN_LITTLE_TO_NATIVE_16(_N_)
#define AFW_ENDIAN_NATIVE_TO_BIG_64(_N_) AFW_ENDIAN_SWITCH_64(_N_)
#define AFW_ENDIAN_BIG_TO_NATIVE_64(_N_) AFW_ENDIAN_SWITCH_64(_N_)
#define AFW_ENDIAN_NATIVE_TO_BIG_32(_N_) AFW_ENDIAN_SWITCH_32(_N_)
#define AFW_ENDIAN_BIG_TO_NATIVE_32(_N_) AFW_ENDIAN_SWITCH_32(_N_)
#define AFW_ENDIAN_NATIVE_TO_BIG_16(_N_) AFW_ENDIAN_SWITCH_16(_N_)
#define AFW_ENDIAN_BIG_TO_NATIVE_16(_N_) AFW_ENDIAN_SWITCH_16(_N_)
#endif
 
#define AFW_ENDIAN_NATIVE_TO_BIG(_N_, _BITS_) AFW_ENDIAN_NATIVE_TO_BIG_ ## _BITS_(_N_)
#define AFW_ENDIAN_BIG_TO_NATIVE(_N_, _BITS_) AFW_ENDIAN_BIG_TO_NATIVE_ ## _BITS_(_N_)
 
#define AFW_ENDIAN_INCREMENT_BIG_64(_N_) \
    AFW_ENDIAN_BIG_TO_NATIVE_64(_N_); \
    (_N_)++; \
    AFW_ENDIAN_NATIVE_TO_BIG_64(_N_)
 
#define AFW_ENDIAN_INCREMENT_BIG_32(_N_) \
    AFW_ENDIAN_BIG_TO_NATIVE_32(_N_); \
    (_N_)++; \
    AFW_ENDIAN_NATIVE_TO_BIG_32(_N_)
 
#define AFW_ENDIAN_INCREMENT_BIG_16(_N_) \
    AFW_ENDIAN_BIG_TO_NATIVE_16(_N_); \
    (_N_)++; \
    AFW_ENDIAN_NATIVE_TO_BIG_16(_N_)
 
typedef union {
    unsigned char c[8];
    afw_uint64_t i;
} afw_endian_big_uint64_t;
 
typedef union {
    unsigned char c[8];
    afw_uint64_t i;
} afw_endian_little_uint64_t;
 
typedef union {
    unsigned char c[8];
    afw_int64_t i;
} afw_endian_big_int64_t;
 
typedef union {
    unsigned char c[8];
    afw_int64_t i;
} afw_endian_little_int64_t;
 
typedef union {
    unsigned char c[4];
    afw_uint32_t i;
} afw_endian_big_uint32_t;
 
typedef union {
    unsigned char c[4];
    afw_uint32_t i;
} afw_endian_little_uint32_t;
 
typedef union {
    unsigned char c[4];
    afw_int32_t i;
} afw_endian_big_int32_t;
 
typedef union {
    unsigned char c[4];
    afw_int32_t i;
} afw_endian_little_int32_t;
 
typedef union {
    unsigned char c[2];
    afw_uint16_t i;
} afw_endian_big_uint16_t;
 
typedef union {
    unsigned char c[2];
    afw_uint16_t i;
} afw_endian_little_uint16_t;
 
typedef union {
    unsigned char c[2];
    afw_int16_t i;
} afw_endian_big_int16_t;
 
typedef union {
    unsigned char c[2];
    afw_int16_t i;
} afw_endian_little_int16_t;
 
AFW_DEFINE_STATIC_INLINE(afw_size_t)
afw_endian_safe_big_uint64_to_native_size_t(
    afw_endian_big_uint64_t big, afw_xctx_t *xctx)
{
    afw_uint64_t result = big.i;
 
    /* Convert to native and throw error if it didn't fit afw_size_t. */
    AFW_ENDIAN_BIG_TO_NATIVE_64(&result);
    if (result != (afw_size_t)result) {
        AFW_THROW_ERROR_Z(general,
            "Value in afw_endian_big_uint64_t exceeds the value that will "
            "fit in afw_size_t",
            xctx);
    }
 
    return (afw_size_t)result;
}
 
AFW_DEFINE_STATIC_INLINE(afw_uint64_t)
afw_endian_big_to_native_uint64(
    afw_endian_big_uint64_t big)
{
    afw_uint64_t result = big.i;
    AFW_ENDIAN_BIG_TO_NATIVE_64(&result);
    return result;
}
 
AFW_DEFINE_STATIC_INLINE(afw_int64_t)
afw_endian_big_to_native_int64(
    afw_endian_big_int64_t big)
{
    afw_int64_t result = big.i;
    AFW_ENDIAN_BIG_TO_NATIVE_64(&result);
    return result;
}
 
AFW_DEFINE_STATIC_INLINE(afw_endian_big_uint64_t)
afw_endian_native_to_big_uint64(
    afw_uint64_t native)
{
    afw_endian_big_uint64_t result;
    result.i = native;
    AFW_ENDIAN_NATIVE_TO_BIG_64(&result);
    return result;
}
 
AFW_DEFINE_STATIC_INLINE(afw_endian_big_int64_t)
afw_endian_native_to_big_int64(
    afw_int64_t native)
{
    afw_endian_big_int64_t result;
    result.i = native;
    AFW_ENDIAN_NATIVE_TO_BIG_64(&result);
    return result;
}
 
AFW_DEFINE_STATIC_INLINE(afw_uint32_t)
afw_endian_big_to_native_uint32(
    afw_endian_big_uint32_t big)
{
    afw_uint32_t result = big.i;
    AFW_ENDIAN_BIG_TO_NATIVE_32(&result);
    return result;
}
 
AFW_DEFINE_STATIC_INLINE(afw_int32_t)
afw_endian_big_to_native_int32(
    afw_endian_big_int32_t big)
{
    afw_int32_t result = big.i;
    AFW_ENDIAN_BIG_TO_NATIVE_32(&result);
    return result;
}
 
AFW_DEFINE_STATIC_INLINE(afw_endian_big_uint32_t)
afw_endian_native_to_big_uint32(
    afw_uint32_t native)
{
    afw_endian_big_uint32_t result;
    result.i = native;
    AFW_ENDIAN_NATIVE_TO_BIG_32(&result);
    return result;
}
 
AFW_DEFINE_STATIC_INLINE(afw_endian_big_int32_t)
afw_endian_native_to_big_int32(
    afw_int32_t native)
{
    afw_endian_big_int32_t result;
    result.i = native;
    AFW_ENDIAN_NATIVE_TO_BIG_32(&result);
    return result;
}
 
AFW_DEFINE_STATIC_INLINE(afw_uint16_t)
afw_endian_big_to_native_uint16(
    afw_endian_big_uint16_t big)
{
    afw_uint16_t result = big.i;
    AFW_ENDIAN_BIG_TO_NATIVE_16(&result);
    return result;
}
 
AFW_DEFINE_STATIC_INLINE(afw_int16_t)
afw_endian_big_to_native_int16(
    afw_endian_big_int16_t big)
{
    afw_int16_t result = big.i;
    AFW_ENDIAN_BIG_TO_NATIVE_16(&result);
    return result;
}
 
AFW_DEFINE_STATIC_INLINE(afw_endian_big_uint16_t)
afw_endian_native_to_big_uint16(
    afw_uint16_t native)
{
    afw_endian_big_uint16_t result;
    result.i = native;
    AFW_ENDIAN_NATIVE_TO_BIG_16(&result);
    return result;
}
 
AFW_DEFINE_STATIC_INLINE(afw_endian_big_int16_t)
afw_endian_native_to_big_int16(
    afw_int16_t native)
{
    afw_endian_big_int16_t result;
    result.i = native;
    AFW_ENDIAN_NATIVE_TO_BIG_16(&result);
    return result;
}
 
AFW_DEFINE_STATIC_INLINE(afw_size_t)
afw_endian_safe_little_uint64_to_native_size_t(
    afw_endian_little_uint64_t little, afw_xctx_t *xctx)
{
    afw_uint64_t result = little.i;
 
    /* Convert to native and throw error if it didn't fit afw_size_t. */
    AFW_ENDIAN_LITTLE_TO_NATIVE_64(&result);
    if (result != (afw_size_t)result) {
        AFW_THROW_ERROR_Z(general,
            "Value in afw_endian_little_uint64_t exceeds the value that will "
            "fit in afw_size_t",
            xctx);
    }
 
    return (afw_size_t)result;
}
 
AFW_DEFINE_STATIC_INLINE(afw_uint64_t)
afw_endian_little_to_native_uint64(
    afw_endian_little_uint64_t little)
{
    afw_uint64_t result = little.i;
    AFW_ENDIAN_LITTLE_TO_NATIVE_64(&result);
    return result;
}
 
AFW_DEFINE_STATIC_INLINE(afw_int64_t)
afw_endian_little_to_native_int64(
    afw_endian_little_int64_t little)
{
    afw_int64_t result = little.i;
    AFW_ENDIAN_LITTLE_TO_NATIVE_64(&result);
    return result;
}
 
AFW_DEFINE_STATIC_INLINE(afw_endian_little_uint64_t)
afw_endian_native_to_little_uint64(
    afw_uint64_t native)
{
    afw_endian_little_uint64_t result;
    result.i = native;
    AFW_ENDIAN_NATIVE_TO_LITTLE_64(&result);
    return result;
}
 
AFW_DEFINE_STATIC_INLINE(afw_endian_little_int64_t)
afw_endian_native_to_little_int64(
    afw_int64_t native)
{
    afw_endian_little_int64_t result;
    result.i = native;
    AFW_ENDIAN_NATIVE_TO_LITTLE_64(&result);
    return result;
}
 
AFW_DEFINE_STATIC_INLINE(afw_uint32_t)
afw_endian_little_to_native_uint32(
    afw_endian_little_uint32_t little)
{
    afw_uint32_t result = little.i;
    AFW_ENDIAN_LITTLE_TO_NATIVE_32(&result);
    return result;
}
 
AFW_DEFINE_STATIC_INLINE(afw_int32_t)
afw_endian_little_to_native_int32(
    afw_endian_little_int32_t little)
{
    afw_int32_t result = little.i;
    AFW_ENDIAN_LITTLE_TO_NATIVE_32(&result);
    return result;
}
 
AFW_DEFINE_STATIC_INLINE(afw_endian_little_uint32_t)
afw_endian_native_to_little_uint32(
    afw_uint32_t native)
{
    afw_endian_little_uint32_t result;
    result.i = native;
    AFW_ENDIAN_NATIVE_TO_LITTLE_32(&result);
    return result;
}
 
AFW_DEFINE_STATIC_INLINE(afw_endian_little_int32_t)
afw_endian_native_to_little_int32(
    afw_int32_t native)
{
    afw_endian_little_int32_t result;
    result.i = native;
    AFW_ENDIAN_NATIVE_TO_LITTLE_32(&result);
    return result;
}
 
AFW_DEFINE_STATIC_INLINE(afw_uint16_t)
afw_endian_little_to_native_uint16(
    afw_endian_little_uint16_t little)
{
    afw_uint16_t result = little.i;
    AFW_ENDIAN_LITTLE_TO_NATIVE_16(&result);
    return result;
}
 
AFW_DEFINE_STATIC_INLINE(afw_int16_t)
afw_endian_little_to_native_int16(
    afw_endian_little_int16_t little)
{
    afw_int16_t result = little.i;
    AFW_ENDIAN_LITTLE_TO_NATIVE_16(&result);
    return result;
}
 
AFW_DEFINE_STATIC_INLINE(afw_endian_little_uint16_t)
afw_endian_native_to_little_uint16(
    afw_uint16_t native)
{
    afw_endian_little_uint16_t result;
    result.i = native;
    AFW_ENDIAN_NATIVE_TO_LITTLE_16(&result);
    return result;
}
 
AFW_DEFINE_STATIC_INLINE(afw_endian_little_int16_t)
afw_endian_native_to_little_int16(
    afw_int16_t native)
{
    afw_endian_little_int16_t result;
    result.i = native;
    AFW_ENDIAN_NATIVE_TO_LITTLE_16(&result);
    return result;
}
 
AFW_END_DECLARES
 
#endif /* __AFW_ENDIAN_H__ */