-#ifndef _LTTNG_UST_ENDIAN_H
-#define _LTTNG_UST_ENDIAN_H
+// SPDX-FileCopyrightText: 2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
+//
+// SPDX-License-Identifier: MIT
/*
- * lttng/ust-endian.h
- *
- * Copyright 2012 (c) - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
- *
- * endian.h compatibility layer.
+ * This header defines the following endian macros based on the current
+ * platform endian headers:
*
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
+ * BYTE_ORDER this macro shall have a value equal to one
+ * of the *_ENDIAN macros in this header.
+ * FLOAT_WORD_ORDER this macro shall have a value equal to one
+ * of the *_ENDIAN macros in this header.
+ * LITTLE_ENDIAN if BYTE_ORDER == LITTLE_ENDIAN, the host
+ * byte order is from least significant to
+ * most significant.
+ * BIG_ENDIAN if BYTE_ORDER == BIG_ENDIAN, the host byte
+ * order is from most significant to least
+ * significant.
*
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
+ * Direct byte swapping interfaces:
*
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
+ * uint16_t bswap_16(uint16_t x); (* swap bytes 16-bit word *)
+ * uint32_t bswap_32(uint32_t x); (* swap bytes 32-bit word *)
+ * uint64_t bswap_64(uint32_t x); (* swap bytes 64-bit word *)
*/
+#ifndef _LTTNG_UST_ENDIAN_H
+#define _LTTNG_UST_ENDIAN_H
+
#if (defined(__linux__) || defined(__CYGWIN__))
#include <endian.h>
#include <byteswap.h>
-#elif defined(__FreeBSD__)
-#include <sys/endian.h>
-#define bswap_16(x) bswap16(x)
-#define bswap_32(x) bswap32(x)
-#define bswap_64(x) bswap64(x)
-#else
-#error "Please add support for your OS."
-#endif
-
-/*
- * BYTE_ORDER, LITTLE_ENDIAN, and BIG_ENDIAN are only defined on Linux
- * if __USE_BSD is defined. Force their definition.
- */
-#ifndef BYTE_ORDER
-#define BYTE_ORDER __BYTE_ORDER
-#endif
-#ifndef LITTLE_ENDIAN
-#define LITTLE_ENDIAN __LITTLE_ENDIAN
-#endif
+#define lttng_ust_bswap_16(x) bswap_16(x)
+#define lttng_ust_bswap_32(x) bswap_32(x)
+#define lttng_ust_bswap_64(x) bswap_64(x)
-#ifndef BIG_ENDIAN
-#define BIG_ENDIAN __BIG_ENDIAN
-#endif
+#define LTTNG_UST_BYTE_ORDER __BYTE_ORDER
+#define LTTNG_UST_LITTLE_ENDIAN __LITTLE_ENDIAN
+#define LTTNG_UST_BIG_ENDIAN __BIG_ENDIAN
-#ifndef FLOAT_WORD_ORDER
#ifdef __FLOAT_WORD_ORDER
-#define FLOAT_WORD_ORDER __FLOAT_WORD_ORDER
+#define LTTNG_UST_FLOAT_WORD_ORDER __FLOAT_WORD_ORDER
#else /* __FLOAT_WORD_ORDER */
-#define FLOAT_WORD_ORDER BYTE_ORDER
+#define LTTNG_UST_FLOAT_WORD_ORDER __BYTE_ORDER
#endif /* __FLOAT_WORD_ORDER */
-#endif /* FLOAT_WORD_ORDER */
+
+#elif defined(__FreeBSD__)
+
+#include <sys/endian.h>
+
+#define lttng_ust_bswap_16(x) bswap16(x)
+#define lttng_ust_bswap_32(x) bswap32(x)
+#define lttng_ust_bswap_64(x) bswap64(x)
+
+#define LTTNG_UST_BYTE_ORDER BYTE_ORDER
+#define LTTNG_UST_LITTLE_ENDIAN LITTLE_ENDIAN
+#define LTTNG_UST_BIG_ENDIAN BIG_ENDIAN
+#define LTTNG_UST_FLOAT_WORD_ORDER BYTE_ORDER
+
+#else
+#error "Please add support for your OS."
+#endif
#endif /* _LTTNG_UST_ENDIAN_H */
projects / lttng-ust.git / blobdiff