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 */
5 /* Copyright (c) 2004-2015. The SimGrid Team.
6 * All rights reserved. */
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. */
15 #include <type_traits>
20 #include "xbt/asserts.h"
22 #include "simgrid_config.h"
28 #include <stdarg.h> /* va_list */
30 /* They live in asserts.h, but need to be declared before this module.
31 double declaration to cut dependency cycle */
33 * @addtogroup XBT_error
37 /** @brief Kill the program in silence */
38 XBT_PUBLIC(void) XBT_ATTRIB_NORETURN xbt_abort(void);
41 * @brief Kill the program with an error message
42 * \param ... a format string and its arguments
44 * Things are so messed up that the only thing to do now, is to stop the
47 * The message is handled by a CRITICAL logging request, and may consist of a
48 * format string with arguments.
50 #define xbt_die(...) \
52 XBT_CCRITICAL(xbt, __VA_ARGS__); \
57 #ifdef XBT_LOG_LOCALLY_DEFINE_XBT_CHANNEL
58 XBT_LOG_NEW_CATEGORY(xbt, "All XBT categories (simgrid toolbox)");
60 XBT_LOG_EXTERNAL_CATEGORY(xbt);
63 /* these ones live in str.h, but redeclare them here so that we do
64 not need to load the whole str.h and its heavy dependencies */
65 #ifndef __USE_GNU /* do not redeclare existing headers */
66 XBT_PUBLIC(int) asprintf(char **ptr, const char *fmt, /*args */
67 ...) XBT_ATTRIB_PRINTF(2, 3);
68 XBT_PUBLIC(int) vasprintf(char **ptr, const char *fmt, va_list ap);
70 XBT_PUBLIC(char *) bprintf(const char *fmt, ...) XBT_ATTRIB_PRINTF(1, 2);
72 /** @addtogroup XBT_syscall
73 * @brief Malloc and associated functions, killing the program on error (with \ref XBT_ex)
78 #if defined(_MSC_VER) && !defined(strdup)
79 # define strdup _strdup /* POSIX name is not ANSI complient blabla */
82 /** @brief Like strdup, but xbt_die() on error */
83 static XBT_ALWAYS_INLINE char *xbt_strdup(const char *s) {
88 xbt_die("memory allocation error (strdup returned NULL)");
93 XBT_PUBLIC(void) xbt_backtrace_display_current(void);
95 /** @brief Like malloc, but xbt_die() on error
97 static XBT_ALWAYS_INLINE void *xbt_malloc(size_t n) {
100 xbt_backtrace_display_current();
101 xbt_die("malloc(0) is not portable");
106 xbt_die("Memory allocation of %lu bytes failed", (unsigned long)n);
110 /** @brief like malloc, but xbt_die() on error and memset data to 0
112 static XBT_ALWAYS_INLINE void *xbt_malloc0(size_t n) {
114 //if (n==0) xbt_die("calloc(0) is not portable");
117 xbt_die("Memory callocation of %lu bytes failed", (unsigned long)n);
121 /** @brief like realloc, but xbt_die() on error
123 static XBT_ALWAYS_INLINE void *xbt_realloc(void *p, size_t s) {
125 //if (s==0) xbt_die("realloc(0) is not portable");
130 xbt_die("memory (re)allocation of %lu bytes failed", (unsigned long)s);
142 #define xbt_free(p) free(p) /*nothing specific to do here. A poor valgrind replacement? */
144 /** @brief like free, but you can be sure that it is a function */
145 XBT_PUBLIC(void) xbt_free_f(void *p);
146 /** @brief should be given a pointer to pointer, and frees the second one */
147 XBT_PUBLIC(void) xbt_free_ref(void *d);
151 /** @brief like calloc, but xbt_die() on error and don't memset to 0
155 #define xbt_new(type, count) ((type*)xbt_malloc (sizeof (type) * (count)))
156 /** @brief like calloc, but xbt_die() on error
158 #define xbt_new0(type, count) ((type*)xbt_malloc0 (sizeof (type) * (count)))
162 /** C++ wrapper for xtb_new
164 * This ensures that we do not xbt_new things that need a constructor.
166 template<typename T> inline
167 T* xbt_new_(size_t count)
169 static_assert(std::is_trivial<T>(),
170 "Cannot xbt_new this type");
171 return (T*) xbt_malloc(sizeof(T) * count);
174 template<typename T> inline
175 T* xbt_new0_(size_t count)
177 static_assert(std::is_trivial<T>(),
178 "Cannot xbt_new0 this type");
179 return (T*) xbt_malloc0(sizeof(T) * count);
182 #define xbt_new(type, count) ::xbt_new_<type>(count)
183 #define xbt_new0(type, count) ::xbt_new0_<type>(count)
189 #endif /* _XBT_SYSDEP_H */