X-Git-Url: http://bilbo.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/1e18ccad74ce3d49299f1da9022c5d5e4ee76918..414839787a24ee470f3124f95659a5f6569a2cd5:/include/xbt/asserts.h

diff --git a/include/xbt/asserts.h b/include/xbt/asserts.h
index d5b9b9da5c..455e30883a 100644
--- a/include/xbt/asserts.h
+++ b/include/xbt/asserts.h
@@ -1,64 +1,69 @@
-/* $Id$ */
-/*  xbt/asserts.h -- assertion mecanism                                     */
+/*  xbt/asserts.h -- assertion mechanism                                    */
 
-/* Copyright (c) 2004,2005 Martin Quinson. All rights reserved.             */
+/* Copyright (c) 2005-2023. 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/misc.h"
-#include "xbt/log.h"
-#include "xbt/ex.h"
-  
-SG_BEGIN_DECL()
+#include <stdlib.h>
+#include <xbt/base.h>
+#include <xbt/log.h>
+
+SG_BEGIN_DECL
+XBT_PUBLIC_DATA int xbt_log_no_loc; /* Do not show the backtrace on failed backtrace when doing our tests */
+
+XBT_PUBLIC void xbt_backtrace_display_current();
 
 /**
  * @addtogroup XBT_error
- * @brief Those are the SimGrid version of the good ol' assert macro.
- *
- * You can pass them a format message and arguments, just as if it where a printf.
- * It is converted to a CRITICALn logging request.
  *
  * @{
  */
-void xbt_abort(void) _XBT_GNUC_NORETURN;
-void xbt_die(const char *msg) _XBT_GNUC_NORETURN;
+/** @brief Kill the program in silence */
+XBT_ATTRIB_NORETURN XBT_PUBLIC void xbt_abort(void);
 
-#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)
-#else
-     /** @brief The condition which failed will be displayed.
-	 @hideinitializer  */
-#define xbt_assert(cond)                  if (!(cond)) THROW1(0,0,"Assertion %s failed", #cond)
-     /** @hideinitializer  */
-#define xbt_assert0(cond,msg)             if (!(cond)) THROW0(0,0,msg)
-     /** @hideinitializer  */
-#define xbt_assert1(cond,msg,a)           if (!(cond)) THROW1(0,0,msg,a)
-     /** @hideinitializer  */
-#define xbt_assert2(cond,msg,a,b)         if (!(cond)) THROW2(0,0,msg,a,b)
-     /** @hideinitializer  */
-#define xbt_assert3(cond,msg,a,b,c)       if (!(cond)) THROW3(0,0,msg,a,b,c)
-     /** @hideinitializer  */
-#define xbt_assert4(cond,msg,a,b,c,d)     if (!(cond)) THROW4(0,0,msg,a,b,c,d)
-     /** @hideinitializer  */
-#define xbt_assert5(cond,msg,a,b,c,d,e)   if (!(cond)) THROW5(0,0,msg,a,b,c,d,e)
-     /** @hideinitializer  */
-#define xbt_assert6(cond,msg,a,b,c,d,e,f) if (!(cond)) THROW6(0,0,msg,a,b,c,d,e,f)
-#endif
-     
+/**
+ * @brief Kill the program with an error message
+ * @param ... a format string and its arguments
+ *
+ * Things are so messed up that the only thing to do now, is to stop the program.
+ *
+ * The message is handled by a CRITICAL logging request, and may consist of a format string with arguments.
+ */
+#define xbt_die(...)                                                                                                   \
+  do {                                                                                                                 \
+    XBT_CCRITICAL(root, __VA_ARGS__);                                                                                  \
+    xbt_abort();                                                                                                       \
+  } while (0)
 
-/** @} */     
-  
-SG_END_DECL()
+/**
+ * @brief Those are the SimGrid version of the good ol' assert macro.
+ *
+ * You can pass them a format message and arguments, just as if it where a printf.
+ * It is converted to a XBT_CRITICAL logging request.
+ * An execution backtrace is also displayed, unless the option --log=no_loc is given at run-time.
+ *
+ * Unlike the standard assert, xbt_assert is never disabled, even if the macro NDEBUG is defined at compile time.  So
+ * it's safe to have a condition with side effects.
+ */
+/** @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 /* _XBT_ASSERTS_H */
+/** @} */
+SG_END_DECL
+#endif                          /* XBT_ASSERTS_H */