Tracepoint API namespacing 'TRACEPOINT_EVENT'

[lttng-ust.git] / include / lttng / ust-endian.h

diff --git a/include/lttng/ust-endian.h b/include/lttng/ust-endian.h
index 2426b1467214634f8daa0bc472e995f55860d6ef..06f8236407658ca5e3d1e525d631c3bd2097d2d4 100644 (file)
--- a/include/lttng/ust-endian.h
+++ b/include/lttng/ust-endian.h
@@ -1,31 +1,62 @@
-#ifndef _LTTNG_UST_ENDIAN_H
-#define _LTTNG_UST_ENDIAN_H
-
 /*
- * lttng/ust-endian.h
+ * SPDX-License-Identifier: MIT
  *
- * Copyright 2012 (c) - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
+ * Copyright (C) 2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
+ */
+
+/*
+ * This header defines the following endian macros based on the current
+ * platform endian headers:
  *
- * endian.h compatibility layer.
+ *   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.
  *
- * THIS MATERIAL IS PROVIDED AS IS, WITH ABSOLUTELY NO WARRANTY EXPRESSED
- * OR IMPLIED.  ANY USE IS AT YOUR OWN RISK.
+ * Direct byte swapping interfaces:
  *
- * Permission is hereby granted to use or copy this program
- * for any purpose,  provided the above notices are retained on all copies.
- * Permission to modify the code and to distribute modified code is granted,
- * provided the above notices are retained, and a notice that the code was
- * modified is included with the above copyright notice.
+ *   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 *)
  */
 
-#ifdef __linux__
+#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 <machine/endian.h>
+#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
+
+#ifndef BIG_ENDIAN
+#define BIG_ENDIAN __BIG_ENDIAN
+#endif
+
 #ifndef FLOAT_WORD_ORDER
 #ifdef __FLOAT_WORD_ORDER
 #define FLOAT_WORD_ORDER       __FLOAT_WORD_ORDER