Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge pull request #302 from mpoquet/rename-s4u-synchro-examples
[simgrid.git] / include / xbt / sysdep.h
index 8d3a61e..86d62bb 100644 (file)
@@ -2,20 +2,19 @@
 /*  no system header should be loaded out of this file so that we have only */
 /*  one file to check when porting to another OS                            */
 
-/* Copyright (c) 2004-2012. The SimGrid Team.
- * All rights reserved.                                                     */
+/* Copyright (c) 2004-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_SYSDEP_H
-#define _XBT_SYSDEP_H
+#ifndef XBT_SYSDEP_H
+#define XBT_SYSDEP_H
 
-#include "xbt/log.h"
-#include "xbt/misc.h"
-#include "xbt/asserts.h"
+#include <xbt/asserts.h>
+#include <xbt/log.h>
+#include <xbt/misc.h>
 
-#include "simgrid_config.h"
+#include <simgrid/config.h>
 
 #include <string.h>
 #include <stdlib.h>
@@ -31,56 +30,37 @@ SG_BEGIN_DECL()
  * @{
  */
 /** @brief Kill the program in silence */
-#ifdef COVERAGE
-/* Call __gcov_flush on abort when compiling with coverage options. */
-#define xbt_abort()                             \
-  do {                                          \
-    extern void __gcov_flush(void);             \
-    __gcov_flush();                             \
-    abort();                                    \
-  } while (0)
-#else
-#define xbt_abort() abort()
-#endif
+XBT_ATTRIB_NORETURN XBT_PUBLIC void xbt_abort(void);
 
 /**
  * @brief Kill the program with an error message
- * \param ... a format string and its arguments
+ * @param ... a format string and its arguments
  *
- * Things are so messed up that the only thing to do now, is to stop the
- * program.
+ * 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.
+ * The message is handled by a CRITICAL logging request, and may consist of a format string with arguments.
  */
 #define xbt_die(...)                            \
   do {                                          \
-    XBT_LOG_EXTERNAL_CATEGORY(xbt);             \
     XBT_CCRITICAL(xbt, __VA_ARGS__);            \
     xbt_abort();                                \
   } while (0)
 /** @} */
 
-/* these ones live in str.h, but redeclare them here so that we do
-   not need to load the whole str.h and its heavy dependencies */
-#ifndef __USE_GNU               /* do not redeclare existing headers */
-XBT_PUBLIC(int) asprintf(char **ptr, const char *fmt,   /*args */
-                         ...) _XBT_GNUC_PRINTF(2, 3);
-XBT_PUBLIC(int) vasprintf(char **ptr, const char *fmt, va_list ap);
+#ifdef XBT_LOG_LOCALLY_DEFINE_XBT_CHANNEL
+XBT_LOG_NEW_CATEGORY(xbt, "All XBT categories (simgrid toolbox)");
+#else
+XBT_LOG_EXTERNAL_CATEGORY(xbt);
 #endif
-XBT_PUBLIC(char *) bprintf(const char *fmt, ...) _XBT_GNUC_PRINTF(1, 2);
 
 /** @addtogroup XBT_syscall
- *  @brief Malloc and associated functions, killing the program on error (with \ref XBT_ex)
+ *  @brief Malloc and associated functions, killing the program on error (with @ref XBT_ex)
  *
  *  @{
  */
 
-#if defined(__GNUC__) || defined(DOXYGEN)
 /** @brief Like strdup, but xbt_die() on error */
-static inline __attribute__ ((always_inline))
-char *xbt_strdup(const char *s)
-{
+static XBT_ALWAYS_INLINE char *xbt_strdup(const char *s) {
   char *res = NULL;
   if (s) {
     res = strdup(s);
@@ -90,20 +70,12 @@ char *xbt_strdup(const char *s)
   return res;
 }
 
-XBT_PUBLIC(void) xbt_backtrace_display_current(void);
+XBT_PUBLIC void xbt_backtrace_display_current();
 
 /** @brief Like malloc, but xbt_die() on error
     @hideinitializer */
-static inline __attribute__ ((always_inline))
-void *xbt_malloc(size_t n)
-{
-  void *res;
-/*  if (n==0) {
-     xbt_backtrace_display_current();
-     xbt_die("malloc(0) is not portable");
-  }*/
-
-  res = malloc(n);
+static XBT_ALWAYS_INLINE void *xbt_malloc(size_t n) {
+  void* res = malloc(n);
   if (!res)
     xbt_die("Memory allocation of %lu bytes failed", (unsigned long)n);
   return res;
@@ -111,12 +83,8 @@ void *xbt_malloc(size_t n)
 
 /** @brief like malloc, but xbt_die() on error and memset data to 0
     @hideinitializer */
-static inline __attribute__ ((always_inline))
-void *xbt_malloc0(size_t n)
-{
-  void *res;
-  //if (n==0) xbt_die("calloc(0) is not portable");
-  res = calloc(n, 1);
+static XBT_ALWAYS_INLINE void *xbt_malloc0(size_t n) {
+  void* res = calloc(n, 1);
   if (!res)
     xbt_die("Memory callocation of %lu bytes failed", (unsigned long)n);
   return res;
@@ -124,11 +92,8 @@ void *xbt_malloc0(size_t n)
 
 /** @brief like realloc, but xbt_die() on error
     @hideinitializer */
-static inline __attribute__ ((always_inline))
-void *xbt_realloc(void *p, size_t s)
-{
+static XBT_ALWAYS_INLINE void *xbt_realloc(void *p, size_t s) {
   void *res = NULL;
-  //if (s==0) xbt_die("realloc(0) is not portable");
   if (s) {
     if (p) {
       res = realloc(p, s);
@@ -142,24 +107,18 @@ void *xbt_realloc(void *p, size_t s)
   }
   return res;
 }
-#else                           /* non __GNUC__  */
-#  define xbt_strdup(s)    strdup(s)
-#  define xbt_malloc(n)    malloc(n)
-#  define xbt_malloc0(n)   calloc(n,1)
-#  define xbt_realloc(p,s) realloc(p,s)
-#endif                          /* __GNUC__ ? */
 
 /** @brief like free
     @hideinitializer */
-#define xbt_free free           /*nothing specific to do here. A poor valgrind replacement? */
+#define xbt_free(p) free(p) /*nothing specific to do here. A poor valgrind replacement? */
 
 /** @brief like free, but you can be sure that it is a function  */
-XBT_PUBLIC(void) xbt_free_f(void *p);
+XBT_PUBLIC void xbt_free_f(void* p);
 /** @brief should be given a pointer to pointer, and frees the second one */
-XBT_PUBLIC(void) xbt_free_ref(void *d);
+XBT_PUBLIC void xbt_free_ref(void* d);
+
+SG_END_DECL()
 
-/** @brief like calloc, but xbt_die() on error and don't memset to 0
-    @hideinitializer */
 #define xbt_new(type, count)  ((type*)xbt_malloc (sizeof (type) * (count)))
 /** @brief like calloc, but xbt_die() on error
     @hideinitializer */
@@ -167,6 +126,4 @@ XBT_PUBLIC(void) xbt_free_ref(void *d);
 
 /** @} */
 
-
-SG_END_DECL()
-#endif                          /* _XBT_SYSDEP_H */
+#endif                          /* XBT_SYSDEP_H */