include/xbt/sysdep.h

   1 /*  xbt/sysdep.h -- all system dependency                                   */
   2 /*  no system header should be loaded out of this file so that we have only */
   3 /*  one file to check when porting to another OS                            */
   4
   5 /* Copyright (c) 2004-2015. The SimGrid Team.
   6  * All rights reserved.                                                     */
   7
   8 /* This program is free software; you can redistribute it and/or modify it
   9  * under the terms of the license (GNU LGPL) which comes with this package. */
  10
  11 #ifndef _XBT_SYSDEP_H
  12 #define _XBT_SYSDEP_H
  13
  14 #ifdef __cplusplus
  15 #include <type_traits>
  16 #endif
  17
  18 #include "xbt/log.h"
  19 #include "xbt/misc.h"
  20 #include "xbt/asserts.h"
  21
  22 #include "simgrid_config.h"
  23
  24 SG_BEGIN_DECL()
  25
  26 #include <string.h>
  27 #include <stdlib.h>
  28 #include <stdarg.h>             /* va_list */
  29
  30 /* They live in asserts.h, but need to be declared before this module.
  31    double declaration to cut dependency cycle */
  32 /**
  33  * @addtogroup XBT_error
  34  *
  35  * @{
  36  */
  37 /** @brief Kill the program in silence */
  38 XBT_PUBLIC(void) xbt_abort(void) _XBT_GNUC_NORETURN;
  39
  40 /**
  41  * @brief Kill the program with an error message
  42  * \param ... a format string and its arguments
  43  *
  44  * Things are so messed up that the only thing to do now, is to stop the
  45  * program.
  46  *
  47  * The message is handled by a CRITICAL logging request, and may consist of a
  48  * format string with arguments.
  49  */
  50 #define xbt_die(...)                            \
  51   do {                                          \
  52     XBT_CCRITICAL(xbt, __VA_ARGS__);            \
  53     xbt_abort();                                \
  54   } while (0)
  55 /** @} */
  56
  57 XBT_LOG_EXTERNAL_CATEGORY(xbt);
  58
  59 /* these ones live in str.h, but redeclare them here so that we do
  60    not need to load the whole str.h and its heavy dependencies */
  61 #ifndef __USE_GNU               /* do not redeclare existing headers */
  62 XBT_PUBLIC(int) asprintf(char **ptr, const char *fmt,   /*args */
  63                          ...) _XBT_GNUC_PRINTF(2, 3);
  64 XBT_PUBLIC(int) vasprintf(char **ptr, const char *fmt, va_list ap);
  65 #endif
  66 XBT_PUBLIC(char *) bprintf(const char *fmt, ...) _XBT_GNUC_PRINTF(1, 2);
  67
  68 /** @addtogroup XBT_syscall
  69  *  @brief Malloc and associated functions, killing the program on error (with \ref XBT_ex)
  70  *
  71  *  @{
  72  */
  73
  74 #ifdef _MSC_VER /* Microsoft wants to improve the code quality blah blah blah */
  75 /* See: https://msdn.microsoft.com/en-us/library/8ef0s5kh.aspx */
  76
  77 /* warning C4996: '_strdup': The POSIX name for this item is deprecated. Instead, use the ISO C and C++ conformant name: _strdup. */
  78 # define _CRT_NONSTDC_NO_WARNINGS
  79 # define strdup _strdup
  80 /* warning C4996: 'fopen': This function or variable may be unsafe. Consider using fopen_s instead. */
  81 # define _CRT_SECURE_NO_WARNINGS
  82 #endif
  83
  84 /** @brief Like strdup, but xbt_die() on error */
  85 static XBT_ALWAYS_INLINE char *xbt_strdup(const char *s) {
  86   char *res = NULL;
  87   if (s) {
  88     res = strdup(s);
  89     if (!res)
  90       xbt_die("memory allocation error (strdup returned NULL)");
  91   }
  92   return res;
  93 }
  94
  95 XBT_PUBLIC(void) xbt_backtrace_display_current(void);
  96
  97 /** @brief Like malloc, but xbt_die() on error
  98     @hideinitializer */
  99 static XBT_ALWAYS_INLINE void *xbt_malloc(size_t n) {
 100   void *res;
 101 /*  if (n==0) {
 102      xbt_backtrace_display_current();
 103      xbt_die("malloc(0) is not portable");
 104   }*/
 105
 106   res = malloc(n);
 107   if (!res)
 108     xbt_die("Memory allocation of %lu bytes failed", (unsigned long)n);
 109   return res;
 110 }
 111
 112 /** @brief like malloc, but xbt_die() on error and memset data to 0
 113     @hideinitializer */
 114 static XBT_ALWAYS_INLINE void *xbt_malloc0(size_t n) {
 115   void *res;
 116   //if (n==0) xbt_die("calloc(0) is not portable");
 117   res = calloc(n, 1);
 118   if (!res)
 119     xbt_die("Memory callocation of %lu bytes failed", (unsigned long)n);
 120   return res;
 121 }
 122
 123 /** @brief like realloc, but xbt_die() on error
 124     @hideinitializer */
 125 static XBT_ALWAYS_INLINE void *xbt_realloc(void *p, size_t s) {
 126   void *res = NULL;
 127   //if (s==0) xbt_die("realloc(0) is not portable");
 128   if (s) {
 129     if (p) {
 130       res = realloc(p, s);
 131       if (!res)
 132         xbt_die("memory (re)allocation of %lu bytes failed", (unsigned long)s);
 133     } else {
 134       res = xbt_malloc(s);
 135     }
 136   } else {
 137     free(p);
 138   }
 139   return res;
 140 }
 141
 142 /** @brief like free
 143     @hideinitializer */
 144 #define xbt_free(p) free(p) /*nothing specific to do here. A poor valgrind replacement? */
 145
 146 /** @brief like free, but you can be sure that it is a function  */
 147 XBT_PUBLIC(void) xbt_free_f(void *p);
 148 /** @brief should be given a pointer to pointer, and frees the second one */
 149 XBT_PUBLIC(void) xbt_free_ref(void *d);
 150
 151 SG_END_DECL()
 152
 153 /** @brief like calloc, but xbt_die() on error and don't memset to 0
 154     @hideinitializer */
 155 #ifndef __cplusplus
 156
 157 #define xbt_new(type, count)  ((type*)xbt_malloc (sizeof (type) * (count)))
 158 /** @brief like calloc, but xbt_die() on error
 159     @hideinitializer */
 160 #define xbt_new0(type, count) ((type*)xbt_malloc0 (sizeof (type) * (count)))
 161
 162 #else
 163
 164 /** C++ wrapper for xtb_new
 165  *
 166  *  This ensures that we do not xbt_new things that need a constructor.
 167  */
 168 template<typename T> inline
 169 T* xbt_new_(size_t count)
 170 {
 171   static_assert(std::is_trivial<T>(),
 172     "Cannot xbt_new this type");
 173   return (T*) xbt_malloc(sizeof(T) * count);
 174 }
 175
 176 template<typename T> inline
 177 T* xbt_new0_(size_t count)
 178 {
 179   static_assert(std::is_trivial<T>(),
 180     "Cannot xbt_new0 this type");
 181   return (T*) xbt_malloc0(sizeof(T) * count);
 182 }
 183
 184 #define xbt_new(type, count)  ::xbt_new_<type>(count)
 185 #define xbt_new0(type, count) ::xbt_new0_<type>(count)
 186
 187 #endif
 188
 189 /** @} */
 190
 191 #endif                          /* _XBT_SYSDEP_H */