HardenedBSD/include/endian.h
Warner Losh 1314d14c32 endian.h: Define uint{16,32,64}_t
The Draft Posix Issue 8 standard requires that these be defined. Define
them in the usual way that lets multiple headers define them. Opted to
not just use #include <stdint.h>, allowed by the draft, to be
conservative. Add notes about how we comply with Issue 8, and that we've
opted to define these only as macros, though the standard allows
functions, macros or both.

Sponsored by:		Netflix
2024-05-06 10:43:14 -06:00

68 lines
1.9 KiB
C

/*-
* Copyright (c) 2021 M. Warner Losh <imp@FreeBSD.org>
*
* SPDX-License-Identifier: BSD-2-Clause
*/
/*
* A mostly Linux/glibc-compatible endian.h
*/
#ifndef _ENDIAN_H_
#define _ENDIAN_H_
/*
* POSIX Issue 8 requires that endian.h define uint{16,32,64}_t. Although POSIX
* allows stdint.h symbols here, be conservative and only define there required
* ones. FreeBSD's sys/_endian.h doesn't need to expose those types since it
* implements all the [bl]eXtoh hto[bl]eX interfaces as macros calling builtin
* functions. POSIX allows functions, macros or both. We opt for macros only.
*/
#include <sys/_types.h>
#ifndef _UINT16_T_DECLARED
typedef __uint16_t uint16_t;
#define _UINT16_T_DECLARED
#endif
#ifndef _UINT32_T_DECLARED
typedef __uint32_t uint32_t;
#define _UINT32_T_DECLARED
#endif
#ifndef _UINT64_T_DECLARED
typedef __uint64_t uint64_t;
#define _UINT64_T_DECLARED
#endif
/*
* FreeBSD's sys/_endian.h is very close to the interface provided on Linux by
* glibc's endian.h as well as POSIX Issue 8's endian.h.
*/
#include <sys/_endian.h>
/*
* glibc uses double underscore for these symbols. Define these unconditionally.
* The compiler defines __BYTE_ORDER__ these days, so we don't do anything
* with that since sys/endian.h defines _BYTE_ORDER based on it.
*/
#define __BIG_ENDIAN _BIG_ENDIAN
#define __BYTE_ORDER _BYTE_ORDER
#define __LITTLE_ENDIAN _LITTLE_ENDIAN
#define __PDP_ENDIAN _PDP_ENDIAN
/*
* FreeBSD's sys/endian.h and machine/endian.h doesn't define a separate
* byte order for floats. Use the host non-float byte order.
*/
#define __FLOAT_WORD_ORDER _BYTE_ORDER
/*
* We don't define BIG_ENDI, LITTLE_ENDI, HIGH_HALF and LOW_HALF macros that
* glibc's endian.h defines since those appear to be internal to glibc.
* We also don't try to emulate the various helper macros that glibc uses to
* limit namespace visibility.
*/
#endif /* _ENDIAN_H_ */