X-Git-Url: http://git.lttng.org/?a=blobdiff_plain;f=include%2Flttng%2Fust-compiler.h;h=674b519cd11991ee4a04b42abdb081e86d2d7843;hb=89350fda665ceeba49bb7dbabe3ce68e4aa5040d;hp=c289628580ee420346a24e6e72bc9f7fa9299ebd;hpb=e1904921db97b70d94e69f0ab3264c6f7fe62f32;p=lttng-ust.git

diff --git a/include/lttng/ust-compiler.h b/include/lttng/ust-compiler.h
index c2896285..674b519c 100644
--- a/include/lttng/ust-compiler.h
+++ b/include/lttng/ust-compiler.h
@@ -1,31 +1,16 @@
-#ifndef _LTTNG_UST_COMPILER_H
-#define _LTTNG_UST_COMPILER_H
-
 /*
- * Copyright 2011-2012 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
- *                       Paul Woegerer <paul_woegerer@mentor.com>
- *
- * 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:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
+ * SPDX-License-Identifier: MIT
  *
- * 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.
+ * Copyright (C) 2011-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
+ * Copyright (C) 2011-2012 Paul Woegerer <paul_woegerer@mentor.com>
  */
 
+#ifndef _LTTNG_UST_COMPILER_H
+#define _LTTNG_UST_COMPILER_H
+
+#include <assert.h>
+
 #define lttng_ust_notrace __attribute__((no_instrument_function))
-#define LTTNG_PACKED	__attribute__((__packed__))
 
 /*
  * Clang supports the no_sanitize variable attribute on global variables.
@@ -49,8 +34,8 @@
  */
 #if defined (__cplusplus) && defined (__GNUC__) && \
 	(__GNUC__ < 4) || ((__GNUC__ == 4) && (__GNUC_MINOR__ <= 8))
-# ifndef LTTNG_ALLOCATE_COMPOUND_LITERAL_ON_HEAP
-#  define LTTNG_ALLOCATE_COMPOUND_LITERAL_ON_HEAP
+# ifndef LTTNG_UST_ALLOCATE_COMPOUND_LITERAL_ON_HEAP
+#  define LTTNG_UST_ALLOCATE_COMPOUND_LITERAL_ON_HEAP
 # endif
 #endif
 
@@ -59,16 +44,46 @@
  * Compound literals are part of the C99 and C11 standards, but not
  * part of the C++ standards. However, those are supported by both g++ and
  * clang. In order to be strictly C++11 compliant, defining
- * LTTNG_ALLOCATE_COMPOUND_LITERAL_ON_HEAP before including this header
+ * LTTNG_UST_ALLOCATE_COMPOUND_LITERAL_ON_HEAP before including this header
  * allocates those on the heap in C++.
  *
  * Example use:
- * static struct mystruct *var = __LTTNG_COMPOUND_LITERAL(struct mystruct, { 1, 2, 3 });
+ * static struct mystruct *var = LTTNG_UST_COMPOUND_LITERAL(struct mystruct, { 1, 2, 3 });
  */
-#if defined (__cplusplus) && defined (LTTNG_ALLOCATE_COMPOUND_LITERAL_ON_HEAP)
-#define __LTTNG_COMPOUND_LITERAL(type, ...)	new (type) __VA_ARGS__
+#if defined (__cplusplus) && defined (LTTNG_UST_ALLOCATE_COMPOUND_LITERAL_ON_HEAP)
+#define LTTNG_UST_COMPOUND_LITERAL(type, ...)	new (type) __VA_ARGS__
 #else
-#define __LTTNG_COMPOUND_LITERAL(type, ...)	(type[]) { __VA_ARGS__ }
+#define LTTNG_UST_COMPOUND_LITERAL(type, ...)	(type[]) { __VA_ARGS__ }
+#endif
+
+/*
+ * Compile time assertion.
+ * - predicate: boolean expression to evaluate,
+ * - msg: string to print to the user on failure when `static_assert()` is
+ *   supported,
+ * - c_identifier_msg: message to be included in the typedef to emulate a
+ *   static assertion. This parameter must be a valid C identifier as it will
+ *   be used as a typedef name.
+ */
+#ifdef __cplusplus
+#define lttng_ust_static_assert(predicate, msg, c_identifier_msg)  \
+	static_assert(predicate, msg)
+#elif __STDC_VERSION__ >= 201112L
+#define lttng_ust_static_assert(predicate, msg, c_identifier_msg)  \
+	_Static_assert(predicate, msg)
+#else
+/*
+ * Evaluates the predicate and emit a compilation error on failure.
+ *
+ * If the predicate evaluates to true, this macro emits a typedef of an array
+ * of size 0.
+ *
+ * If the predicate evaluates to false, this macro emits a typedef of an array
+ * of negative size which is invalid in C and forces a compiler error. The msg
+ * parameter is used in the tentative typedef so it is printed to the user.
+ */
+#define lttng_ust_static_assert(predicate, msg, c_identifier_msg)  \
+    typedef char lttng_ust_static_assert_##c_identifier_msg[2*!!(predicate)-1]
 #endif
 
 #endif /* _LTTNG_UST_COMPILER_H */