Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Expose signals Activity::on_suspend and Activity::on_resume in s4u
[simgrid.git] / include / xbt / sysdep.h
index 2d7c63c..280093d 100644 (file)
-/* $Id$ */
-
-/* gras/sysdep.h -- all system dependency                                   */
+/*  xbt/sysdep.h -- all system dependency                                   */
 /*  no system header should be loaded out of this file so that we have only */
 /*  one file to check when porting to another OS                            */
 
-/* Authors: Martin Quinson                                                  */
-/* Copyright (C) 2004 the OURAGAN project.                                  */
+/* Copyright (c) 2004-2022. 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. */
+ * under the terms of the license (GNU LGPL) which comes with this package. */
+
+#ifndef XBT_SYSDEP_H
+#define XBT_SYSDEP_H
 
+#include <xbt/asserts.h>
+#include <xbt/log.h>
 
-#ifndef _GRAS_SYSDEP_H
-#define _GRAS_SYSDEP_H
+#include <simgrid/config.h>
 
-#include <string.h> /* Included directly for speed */
+#include <string.h>
+#include <stdlib.h>
+#include <stdarg.h>             /* va_list */
 
-#include <time.h> /* FIXME: remove */
-#include <unistd.h> /* FIXME: remove */
+SG_BEGIN_DECL
 
-#ifdef  __cplusplus
-extern "C" 
+#ifdef XBT_LOG_LOCALLY_DEFINE_XBT_CHANNEL
+XBT_LOG_NEW_CATEGORY(xbt, "All XBT categories (simgrid toolbox)");
+XBT_LOG_NEW_SUBCATEGORY(xbt_help, xbt, "Help messages");
+#else
+XBT_LOG_EXTERNAL_CATEGORY(xbt);
+XBT_LOG_EXTERNAL_CATEGORY(xbt_help);
 #endif
 
-void* gras_malloc  (long int bytes);
-void* gras_malloc0 (long int bytes);
-void* gras_realloc (void  *memory, long int bytes);
-void  gras_free    (void  *memory);
-
-#define gras_new(type, count)  ((type*)gras_malloc (sizeof (type) * (count)))
-#define gras_new0(type, count) ((type*)gras_malloc0 (sizeof (type) * (count)))
-
-#if     __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ > 4)
-#define _GRAS_GNUC_PRINTF( format_idx, arg_idx )    \
-          __attribute__((__format__ (__printf__, format_idx, arg_idx)))
-#define _GRAS_GNUC_SCANF( format_idx, arg_idx )     \
-              __attribute__((__format__ (__scanf__, format_idx, arg_idx)))
-#define _GRAS_GNUC_FORMAT( arg_idx )                \
-                  __attribute__((__format_arg__ (arg_idx)))
-#define _GRAS_GNUC_NORETURN                         \
-     __attribute__((__noreturn__))
-#else   /* !__GNUC__ */
-#define _GRAS_GNUC_PRINTF( format_idx, arg_idx )
-#define _GRAS_GNUC_SCANF( format_idx, arg_idx )
-#define _GRAS_GNUC_FORMAT( arg_idx )
-#define _GRAS_GNUC_NORETURN
-#endif  /* !__GNUC__ */
-
-void gras_abort(void) _GRAS_GNUC_NORETURN;
-
-/* FIXME: This is a very good candidate to rewrite (along with a proper string stuff) 
-   but I'm too lazy right now, so copy the definition */
-long int strtol(const char *nptr, char **endptr, int base);
-double strtod(const char *nptr, char **endptr);
-int atoi(const char *nptr);
-
-
-   
-#ifdef  __cplusplus
+/** @addtogroup XBT_syscall
+ *  @brief Malloc and associated functions, killing the program on error (with @ref XBT_ex)
+ *
+ *  @{
+ */
+
+/** @brief Like strdup, but xbt_die() on error */
+static XBT_ALWAYS_INLINE char *xbt_strdup(const char *s) {
+  char *res = NULL;
+  if (s) {
+    res = strdup(s);
+    xbt_assert(res, "memory allocation error (strdup returned NULL)");
+  }
+  return res;
+}
+
+/** @brief Like malloc, but xbt_die() on error
+    @hideinitializer */
+static XBT_ALWAYS_INLINE void *xbt_malloc(size_t n) {
+  void* res = malloc(n);
+  xbt_assert(res, "Memory allocation of %lu bytes failed", (unsigned long)n);
+  return res;
+}
+
+/** @brief like malloc, but xbt_die() on error and memset data to 0
+    @hideinitializer */
+static XBT_ALWAYS_INLINE void *xbt_malloc0(size_t n) {
+  void* res = calloc(n, 1);
+  xbt_assert(res, "Memory callocation of %lu bytes failed", (unsigned long)n);
+  return res;
+}
+
+/** @brief like realloc, but xbt_die() on error
+    @hideinitializer */
+static XBT_ALWAYS_INLINE void *xbt_realloc(void *p, size_t s) {
+  void *res = NULL;
+  if (s) {
+    if (p) {
+      res = realloc(p, s);
+      xbt_assert(res, "memory (re)allocation of %lu bytes failed", (unsigned long)s);
+    } else {
+      res = xbt_malloc(s);
+    }
+  } else {
+    free(p);
+  }
+  return res;
 }
+
+/** @brief like free
+    @hideinitializer */
+#define xbt_free(p) free(p) /*nothing specific to do here. A poor valgrind replacement? */
+
+#ifdef __cplusplus
+#define XBT_FREE_NOEXCEPT noexcept(noexcept(::free))
+#else
+#define XBT_FREE_NOEXCEPT
 #endif
 
-#endif /* _GRAS_SYSDEP_H */
+/** @brief like free, but you can be sure that it is a function  */
+XBT_PUBLIC void xbt_free_f(void* p) XBT_FREE_NOEXCEPT;
+/** @brief should be given a pointer to pointer, and frees the second one */
+XBT_PUBLIC void xbt_free_ref(void* d) XBT_FREE_NOEXCEPT;
+
+SG_END_DECL
+
+#define xbt_new(type, count)  ((type*)xbt_malloc (sizeof (type) * (count)))
+/** @brief like calloc, but xbt_die() on error
+    @hideinitializer */
+#define xbt_new0(type, count) ((type*)xbt_malloc0 (sizeof (type) * (count)))
+
+/** @} */
+
+#endif                          /* XBT_SYSDEP_H */