Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge pull request #302 from mpoquet/rename-s4u-synchro-examples
[simgrid.git] / include / xbt / asserts.h
index df2d1f2..5e78a3b 100644 (file)
@@ -1,65 +1,51 @@
-/* $Id$ */
-/*  xbt/asserts.h -- assertion mecanism                                     */
+/*  xbt/asserts.h -- assertion mechanism                                    */
 
-/* Copyright (c) 2004,2005 Martin Quinson. All rights reserved.             */
+/* Copyright (c) 2005-2018. The SimGrid Team. All rights reserved.          */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
 
-#ifndef _XBT_ASSERTS_H
-#define _XBT_ASSERTS_H
+#ifndef XBT_ASSERTS_H
+#define XBT_ASSERTS_H
+
+#include <xbt/ex.h>
+#include <xbt/log.h>
+#include <xbt/misc.h>
 
-#include "xbt/misc.h"
-  
 SG_BEGIN_DECL()
+XBT_PUBLIC_DATA int xbt_log_no_loc; /* Do not show the backtrace on failed backtrace when doing our tests */
 
 /**
  * @addtogroup XBT_error
  * @brief Those are the SimGrid version of the good ol' assert macro.
  *
- * <center><table><tr><td><b>Top</b>    <td> [\ref index]::[\ref XBT_API]
- *                <tr><td><b>Prev</b>   <td> [\ref XBT_log]
- *                <tr><td><b>Next</b>   <td> [\ref XBT_config]     </table></center>
- *
  * You can pass them a format message and arguments, just as if it where a printf.
- * It is converted to a CRITICALn logging request.
+ * It is converted to a XBT_CRITICAL logging request.
+ * Be careful: the boolean expression that you want to test should not have side effects, because assertions are
+ * disabled at compile time if NDEBUG is set.
  *
  * @{
  */
 #ifdef NDEBUG
-#define xbt_assert(cond)
-#define xbt_assert0(cond,msg)
-#define xbt_assert1(cond,msg,a)
-#define xbt_assert2(cond,msg,a,b)
-#define xbt_assert3(cond,msg,a,b,c)
-#define xbt_assert4(cond,msg,a,b,c,d)
-#define xbt_assert5(cond,msg,a,b,c,d,e)
-#define xbt_assert6(cond,msg,a,b,c,d,e,f)
+#define xbt_assert(...) ((void)0)
 #else
-     /** @brief The condition which failed will be displayed.
-        @hideinitializer  */
-#define xbt_assert(cond)                  if (!(cond)) { CRITICAL1("Assertion %s failed", #cond); xbt_abort(); }
-     /** @hideinitializer  */
-#define xbt_assert0(cond,msg)             if (!(cond)) { CRITICAL0(msg); xbt_abort(); }
-     /** @hideinitializer  */
-#define xbt_assert1(cond,msg,a)           if (!(cond)) { CRITICAL1(msg,a); xbt_abort(); }
-     /** @hideinitializer  */
-#define xbt_assert2(cond,msg,a,b)         if (!(cond)) { CRITICAL2(msg,a,b); xbt_abort(); }
-     /** @hideinitializer  */
-#define xbt_assert3(cond,msg,a,b,c)       if (!(cond)) { CRITICAL3(msg,a,b,c); xbt_abort(); }
-     /** @hideinitializer  */
-#define xbt_assert4(cond,msg,a,b,c,d)     if (!(cond)) { CRITICAL4(msg,a,b,c,d); xbt_abort(); }
-     /** @hideinitializer  */
-#define xbt_assert5(cond,msg,a,b,c,d,e)   if (!(cond)) { CRITICAL5(msg,a,b,c,d,e); xbt_abort(); }
-     /** @hideinitializer  */
-#define xbt_assert6(cond,msg,a,b,c,d,e,f) if (!(cond)) { CRITICAL6(msg,a,b,c,d,e,f); xbt_abort(); }
+   /** @brief The condition which failed will be displayed.
+   @hideinitializer  */
+#define xbt_assert(...) \
+  _XBT_IF_ONE_ARG(_xbt_assert_ARG1, _xbt_assert_ARGN, __VA_ARGS__)(__VA_ARGS__)
+#define _xbt_assert_ARG1(cond) \
+  _xbt_assert_ARGN(cond, "Assertion %s failed", #cond)
+#define _xbt_assert_ARGN(cond, ...)                                                                                    \
+  do {                                                                                                                 \
+    if (!(cond)) {                                                                                                     \
+      XBT_CCRITICAL(root, __VA_ARGS__);                                                                                \
+      if (!xbt_log_no_loc)                                                                                             \
+        xbt_backtrace_display_current();                                                                               \
+      abort();                                                                                                         \
+    }                                                                                                                  \
+  } while (0)
 #endif
-     
-void xbt_abort(void) _XBT_GNUC_NORETURN;
-void xbt_die(const char *msg) _XBT_GNUC_NORETURN;
 
-/** @} */     
-  
+/** @} */
 SG_END_DECL()
-
-#endif /* _XBT_ASSERTS_H */
+#endif                          /* XBT_ASSERTS_H */