sys/sys/endian.h

199767f8919635c4928607450d9e0abb932109ceToomas Soome/*-
199767f8919635c4928607450d9e0abb932109ceToomas Soome * Copyright (c) 2002 Thomas Moestl <tmm@FreeBSD.org>
199767f8919635c4928607450d9e0abb932109ceToomas Soome * All rights reserved.
199767f8919635c4928607450d9e0abb932109ceToomas Soome *
199767f8919635c4928607450d9e0abb932109ceToomas Soome * Redistribution and use in source and binary forms, with or without
199767f8919635c4928607450d9e0abb932109ceToomas Soome * modification, are permitted provided that the following conditions
199767f8919635c4928607450d9e0abb932109ceToomas Soome * are met:
199767f8919635c4928607450d9e0abb932109ceToomas Soome * 1. Redistributions of source code must retain the above copyright
199767f8919635c4928607450d9e0abb932109ceToomas Soome *    notice, this list of conditions and the following disclaimer.
199767f8919635c4928607450d9e0abb932109ceToomas Soome * 2. Redistributions in binary form must reproduce the above copyright
199767f8919635c4928607450d9e0abb932109ceToomas Soome *    notice, this list of conditions and the following disclaimer in the
199767f8919635c4928607450d9e0abb932109ceToomas Soome *    documentation and/or other materials provided with the distribution.
199767f8919635c4928607450d9e0abb932109ceToomas Soome *
199767f8919635c4928607450d9e0abb932109ceToomas Soome * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
199767f8919635c4928607450d9e0abb932109ceToomas Soome * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
199767f8919635c4928607450d9e0abb932109ceToomas Soome * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
199767f8919635c4928607450d9e0abb932109ceToomas Soome * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
199767f8919635c4928607450d9e0abb932109ceToomas Soome * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
199767f8919635c4928607450d9e0abb932109ceToomas Soome * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
199767f8919635c4928607450d9e0abb932109ceToomas Soome * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
199767f8919635c4928607450d9e0abb932109ceToomas Soome * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
199767f8919635c4928607450d9e0abb932109ceToomas Soome * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
199767f8919635c4928607450d9e0abb932109ceToomas Soome * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
199767f8919635c4928607450d9e0abb932109ceToomas Soome * SUCH DAMAGE.
199767f8919635c4928607450d9e0abb932109ceToomas Soome *
199767f8919635c4928607450d9e0abb932109ceToomas Soome * $FreeBSD$
199767f8919635c4928607450d9e0abb932109ceToomas Soome */
199767f8919635c4928607450d9e0abb932109ceToomas Soome
199767f8919635c4928607450d9e0abb932109ceToomas Soome#ifndef _SYS_ENDIAN_H_
199767f8919635c4928607450d9e0abb932109ceToomas Soome#define _SYS_ENDIAN_H_
199767f8919635c4928607450d9e0abb932109ceToomas Soome
199767f8919635c4928607450d9e0abb932109ceToomas Soome#include <sys/cdefs.h>
199767f8919635c4928607450d9e0abb932109ceToomas Soome#include <sys/_types.h>
199767f8919635c4928607450d9e0abb932109ceToomas Soome#include <machine/endian.h>
199767f8919635c4928607450d9e0abb932109ceToomas Soome
199767f8919635c4928607450d9e0abb932109ceToomas Soome#ifndef _UINT8_T_DECLARED
199767f8919635c4928607450d9e0abb932109ceToomas Soometypedef __uint8_t   uint8_t;
199767f8919635c4928607450d9e0abb932109ceToomas Soome#define _UINT8_T_DECLARED
199767f8919635c4928607450d9e0abb932109ceToomas Soome#endif
199767f8919635c4928607450d9e0abb932109ceToomas Soome
199767f8919635c4928607450d9e0abb932109ceToomas Soome#ifndef _UINT16_T_DECLARED
199767f8919635c4928607450d9e0abb932109ceToomas Soometypedef __uint16_t  uint16_t;
199767f8919635c4928607450d9e0abb932109ceToomas Soome#define _UINT16_T_DECLARED
199767f8919635c4928607450d9e0abb932109ceToomas Soome#endif
199767f8919635c4928607450d9e0abb932109ceToomas Soome
199767f8919635c4928607450d9e0abb932109ceToomas Soome#ifndef _UINT32_T_DECLARED
199767f8919635c4928607450d9e0abb932109ceToomas Soometypedef __uint32_t  uint32_t;
199767f8919635c4928607450d9e0abb932109ceToomas Soome#define _UINT32_T_DECLARED
199767f8919635c4928607450d9e0abb932109ceToomas Soome#endif
199767f8919635c4928607450d9e0abb932109ceToomas Soome
199767f8919635c4928607450d9e0abb932109ceToomas Soome#ifndef _UINT64_T_DECLARED
199767f8919635c4928607450d9e0abb932109ceToomas Soometypedef __uint64_t  uint64_t;
199767f8919635c4928607450d9e0abb932109ceToomas Soome#define _UINT64_T_DECLARED
199767f8919635c4928607450d9e0abb932109ceToomas Soome#endif
199767f8919635c4928607450d9e0abb932109ceToomas Soome
199767f8919635c4928607450d9e0abb932109ceToomas Soome/*
199767f8919635c4928607450d9e0abb932109ceToomas Soome * General byte order swapping functions.
199767f8919635c4928607450d9e0abb932109ceToomas Soome */
199767f8919635c4928607450d9e0abb932109ceToomas Soome#define bswap16(x)  __bswap16(x)
199767f8919635c4928607450d9e0abb932109ceToomas Soome#define bswap32(x)  __bswap32(x)
199767f8919635c4928607450d9e0abb932109ceToomas Soome#define bswap64(x)  __bswap64(x)
199767f8919635c4928607450d9e0abb932109ceToomas Soome
199767f8919635c4928607450d9e0abb932109ceToomas Soome/*
199767f8919635c4928607450d9e0abb932109ceToomas Soome * Host to big endian, host to little endian, big endian to host, and little
199767f8919635c4928607450d9e0abb932109ceToomas Soome * endian to host byte order functions as detailed in byteorder(9).
199767f8919635c4928607450d9e0abb932109ceToomas Soome */
199767f8919635c4928607450d9e0abb932109ceToomas Soome#if _BYTE_ORDER == _LITTLE_ENDIAN
199767f8919635c4928607450d9e0abb932109ceToomas Soome#define htobe16(x)  bswap16((x))
199767f8919635c4928607450d9e0abb932109ceToomas Soome#define htobe32(x)  bswap32((x))
199767f8919635c4928607450d9e0abb932109ceToomas Soome#define htobe64(x)  bswap64((x))
199767f8919635c4928607450d9e0abb932109ceToomas Soome#define htole16(x)  ((uint16_t)(x))
199767f8919635c4928607450d9e0abb932109ceToomas Soome#define htole32(x)  ((uint32_t)(x))
199767f8919635c4928607450d9e0abb932109ceToomas Soome#define htole64(x)  ((uint64_t)(x))
199767f8919635c4928607450d9e0abb932109ceToomas Soome
199767f8919635c4928607450d9e0abb932109ceToomas Soome#define be16toh(x)  bswap16((x))
199767f8919635c4928607450d9e0abb932109ceToomas Soome#define be32toh(x)  bswap32((x))
199767f8919635c4928607450d9e0abb932109ceToomas Soome#define be64toh(x)  bswap64((x))
199767f8919635c4928607450d9e0abb932109ceToomas Soome#define le16toh(x)  ((uint16_t)(x))
199767f8919635c4928607450d9e0abb932109ceToomas Soome#define le32toh(x)  ((uint32_t)(x))
199767f8919635c4928607450d9e0abb932109ceToomas Soome#define le64toh(x)  ((uint64_t)(x))
199767f8919635c4928607450d9e0abb932109ceToomas Soome#else /* _BYTE_ORDER != _LITTLE_ENDIAN */
199767f8919635c4928607450d9e0abb932109ceToomas Soome#define htobe16(x)  ((uint16_t)(x))
199767f8919635c4928607450d9e0abb932109ceToomas Soome#define htobe32(x)  ((uint32_t)(x))
199767f8919635c4928607450d9e0abb932109ceToomas Soome#define htobe64(x)  ((uint64_t)(x))
199767f8919635c4928607450d9e0abb932109ceToomas Soome#define htole16(x)  bswap16((x))
199767f8919635c4928607450d9e0abb932109ceToomas Soome#define htole32(x)  bswap32((x))
199767f8919635c4928607450d9e0abb932109ceToomas Soome#define htole64(x)  bswap64((x))
199767f8919635c4928607450d9e0abb932109ceToomas Soome
199767f8919635c4928607450d9e0abb932109ceToomas Soome#define be16toh(x)  ((uint16_t)(x))
199767f8919635c4928607450d9e0abb932109ceToomas Soome#define be32toh(x)  ((uint32_t)(x))
199767f8919635c4928607450d9e0abb932109ceToomas Soome#define be64toh(x)  ((uint64_t)(x))
199767f8919635c4928607450d9e0abb932109ceToomas Soome#define le16toh(x)  bswap16((x))
199767f8919635c4928607450d9e0abb932109ceToomas Soome#define le32toh(x)  bswap32((x))
199767f8919635c4928607450d9e0abb932109ceToomas Soome#define le64toh(x)  bswap64((x))
199767f8919635c4928607450d9e0abb932109ceToomas Soome#endif /* _BYTE_ORDER == _LITTLE_ENDIAN */
199767f8919635c4928607450d9e0abb932109ceToomas Soome
199767f8919635c4928607450d9e0abb932109ceToomas Soome/* Alignment-agnostic encode/decode bytestream to/from little/big endian. */
199767f8919635c4928607450d9e0abb932109ceToomas Soome
199767f8919635c4928607450d9e0abb932109ceToomas Soomestatic __inline uint16_t
199767f8919635c4928607450d9e0abb932109ceToomas Soomebe16dec(const void *pp)
199767f8919635c4928607450d9e0abb932109ceToomas Soome{
199767f8919635c4928607450d9e0abb932109ceToomas Soome    uint8_t const *p = (uint8_t const *)pp;
199767f8919635c4928607450d9e0abb932109ceToomas Soome
199767f8919635c4928607450d9e0abb932109ceToomas Soome    return ((p[0] << 8) | p[1]);
199767f8919635c4928607450d9e0abb932109ceToomas Soome}
199767f8919635c4928607450d9e0abb932109ceToomas Soome
199767f8919635c4928607450d9e0abb932109ceToomas Soomestatic __inline uint32_t
199767f8919635c4928607450d9e0abb932109ceToomas Soomebe32dec(const void *pp)
199767f8919635c4928607450d9e0abb932109ceToomas Soome{
199767f8919635c4928607450d9e0abb932109ceToomas Soome    uint8_t const *p = (uint8_t const *)pp;
199767f8919635c4928607450d9e0abb932109ceToomas Soome
199767f8919635c4928607450d9e0abb932109ceToomas Soome    return (((unsigned)p[0] << 24) | (p[1] << 16) | (p[2] << 8) | p[3]);
199767f8919635c4928607450d9e0abb932109ceToomas Soome}
199767f8919635c4928607450d9e0abb932109ceToomas Soome
199767f8919635c4928607450d9e0abb932109ceToomas Soomestatic __inline uint64_t
199767f8919635c4928607450d9e0abb932109ceToomas Soomebe64dec(const void *pp)
199767f8919635c4928607450d9e0abb932109ceToomas Soome{
199767f8919635c4928607450d9e0abb932109ceToomas Soome    uint8_t const *p = (uint8_t const *)pp;
199767f8919635c4928607450d9e0abb932109ceToomas Soome
199767f8919635c4928607450d9e0abb932109ceToomas Soome    return (((uint64_t)be32dec(p) << 32) | be32dec(p + 4));
199767f8919635c4928607450d9e0abb932109ceToomas Soome}
199767f8919635c4928607450d9e0abb932109ceToomas Soome
199767f8919635c4928607450d9e0abb932109ceToomas Soomestatic __inline uint16_t
199767f8919635c4928607450d9e0abb932109ceToomas Soomele16dec(const void *pp)
199767f8919635c4928607450d9e0abb932109ceToomas Soome{
199767f8919635c4928607450d9e0abb932109ceToomas Soome    uint8_t const *p = (uint8_t const *)pp;
199767f8919635c4928607450d9e0abb932109ceToomas Soome
199767f8919635c4928607450d9e0abb932109ceToomas Soome    return ((p[1] << 8) | p[0]);
199767f8919635c4928607450d9e0abb932109ceToomas Soome}
199767f8919635c4928607450d9e0abb932109ceToomas Soome
199767f8919635c4928607450d9e0abb932109ceToomas Soomestatic __inline uint32_t
199767f8919635c4928607450d9e0abb932109ceToomas Soomele32dec(const void *pp)
199767f8919635c4928607450d9e0abb932109ceToomas Soome{
199767f8919635c4928607450d9e0abb932109ceToomas Soome    uint8_t const *p = (uint8_t const *)pp;
199767f8919635c4928607450d9e0abb932109ceToomas Soome
199767f8919635c4928607450d9e0abb932109ceToomas Soome    return (((unsigned)p[3] << 24) | (p[2] << 16) | (p[1] << 8) | p[0]);
199767f8919635c4928607450d9e0abb932109ceToomas Soome}
199767f8919635c4928607450d9e0abb932109ceToomas Soome
199767f8919635c4928607450d9e0abb932109ceToomas Soomestatic __inline uint64_t
199767f8919635c4928607450d9e0abb932109ceToomas Soomele64dec(const void *pp)
199767f8919635c4928607450d9e0abb932109ceToomas Soome{
199767f8919635c4928607450d9e0abb932109ceToomas Soome    uint8_t const *p = (uint8_t const *)pp;
199767f8919635c4928607450d9e0abb932109ceToomas Soome
199767f8919635c4928607450d9e0abb932109ceToomas Soome    return (((uint64_t)le32dec(p + 4) << 32) | le32dec(p));
199767f8919635c4928607450d9e0abb932109ceToomas Soome}
199767f8919635c4928607450d9e0abb932109ceToomas Soome
199767f8919635c4928607450d9e0abb932109ceToomas Soomestatic __inline void
199767f8919635c4928607450d9e0abb932109ceToomas Soomebe16enc(void *pp, uint16_t u)
199767f8919635c4928607450d9e0abb932109ceToomas Soome{
199767f8919635c4928607450d9e0abb932109ceToomas Soome    uint8_t *p = (uint8_t *)pp;
199767f8919635c4928607450d9e0abb932109ceToomas Soome
199767f8919635c4928607450d9e0abb932109ceToomas Soome    p[0] = (u >> 8) & 0xff;
199767f8919635c4928607450d9e0abb932109ceToomas Soome    p[1] = u & 0xff;
199767f8919635c4928607450d9e0abb932109ceToomas Soome}
199767f8919635c4928607450d9e0abb932109ceToomas Soome
199767f8919635c4928607450d9e0abb932109ceToomas Soomestatic __inline void
199767f8919635c4928607450d9e0abb932109ceToomas Soomebe32enc(void *pp, uint32_t u)
199767f8919635c4928607450d9e0abb932109ceToomas Soome{
199767f8919635c4928607450d9e0abb932109ceToomas Soome    uint8_t *p = (uint8_t *)pp;
199767f8919635c4928607450d9e0abb932109ceToomas Soome
199767f8919635c4928607450d9e0abb932109ceToomas Soome    p[0] = (u >> 24) & 0xff;
199767f8919635c4928607450d9e0abb932109ceToomas Soome    p[1] = (u >> 16) & 0xff;
199767f8919635c4928607450d9e0abb932109ceToomas Soome    p[2] = (u >> 8) & 0xff;
199767f8919635c4928607450d9e0abb932109ceToomas Soome    p[3] = u & 0xff;
199767f8919635c4928607450d9e0abb932109ceToomas Soome}
199767f8919635c4928607450d9e0abb932109ceToomas Soome
199767f8919635c4928607450d9e0abb932109ceToomas Soomestatic __inline void
199767f8919635c4928607450d9e0abb932109ceToomas Soomebe64enc(void *pp, uint64_t u)
199767f8919635c4928607450d9e0abb932109ceToomas Soome{
199767f8919635c4928607450d9e0abb932109ceToomas Soome    uint8_t *p = (uint8_t *)pp;
199767f8919635c4928607450d9e0abb932109ceToomas Soome
199767f8919635c4928607450d9e0abb932109ceToomas Soome    be32enc(p, (uint32_t)(u >> 32));
199767f8919635c4928607450d9e0abb932109ceToomas Soome    be32enc(p + 4, (uint32_t)(u & 0xffffffffU));
199767f8919635c4928607450d9e0abb932109ceToomas Soome}
199767f8919635c4928607450d9e0abb932109ceToomas Soome
199767f8919635c4928607450d9e0abb932109ceToomas Soomestatic __inline void
199767f8919635c4928607450d9e0abb932109ceToomas Soomele16enc(void *pp, uint16_t u)
199767f8919635c4928607450d9e0abb932109ceToomas Soome{
199767f8919635c4928607450d9e0abb932109ceToomas Soome    uint8_t *p = (uint8_t *)pp;
199767f8919635c4928607450d9e0abb932109ceToomas Soome
199767f8919635c4928607450d9e0abb932109ceToomas Soome    p[0] = u & 0xff;
199767f8919635c4928607450d9e0abb932109ceToomas Soome    p[1] = (u >> 8) & 0xff;
199767f8919635c4928607450d9e0abb932109ceToomas Soome}
199767f8919635c4928607450d9e0abb932109ceToomas Soome
199767f8919635c4928607450d9e0abb932109ceToomas Soomestatic __inline void
199767f8919635c4928607450d9e0abb932109ceToomas Soomele32enc(void *pp, uint32_t u)
199767f8919635c4928607450d9e0abb932109ceToomas Soome{
199767f8919635c4928607450d9e0abb932109ceToomas Soome    uint8_t *p = (uint8_t *)pp;
199767f8919635c4928607450d9e0abb932109ceToomas Soome
199767f8919635c4928607450d9e0abb932109ceToomas Soome    p[0] = u & 0xff;
199767f8919635c4928607450d9e0abb932109ceToomas Soome    p[1] = (u >> 8) & 0xff;
199767f8919635c4928607450d9e0abb932109ceToomas Soome    p[2] = (u >> 16) & 0xff;
199767f8919635c4928607450d9e0abb932109ceToomas Soome    p[3] = (u >> 24) & 0xff;
199767f8919635c4928607450d9e0abb932109ceToomas Soome}
199767f8919635c4928607450d9e0abb932109ceToomas Soome
199767f8919635c4928607450d9e0abb932109ceToomas Soomestatic __inline void
199767f8919635c4928607450d9e0abb932109ceToomas Soomele64enc(void *pp, uint64_t u)
199767f8919635c4928607450d9e0abb932109ceToomas Soome{
199767f8919635c4928607450d9e0abb932109ceToomas Soome    uint8_t *p = (uint8_t *)pp;
199767f8919635c4928607450d9e0abb932109ceToomas Soome
199767f8919635c4928607450d9e0abb932109ceToomas Soome    le32enc(p, (uint32_t)(u & 0xffffffffU));
199767f8919635c4928607450d9e0abb932109ceToomas Soome    le32enc(p + 4, (uint32_t)(u >> 32));
199767f8919635c4928607450d9e0abb932109ceToomas Soome}
199767f8919635c4928607450d9e0abb932109ceToomas Soome
199767f8919635c4928607450d9e0abb932109ceToomas Soome#endif  /* _SYS_ENDIAN_H_ */