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-2014. 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"
26 #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_abort(void) _XBT_GNUC_NORETURN;
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 XBT_LOG_EXTERNAL_CATEGORY(xbt);
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);
66 XBT_PUBLIC(char *) bprintf(const char *fmt, ...) _XBT_GNUC_PRINTF(1, 2);
68 /** @addtogroup XBT_syscall
69 * @brief Malloc and associated functions, killing the program on error (with \ref XBT_ex)
74 #if defined(__GNUC__) || defined(DOXYGEN)
75 /** @brief Like strdup, but xbt_die() on error */
76 static inline __attribute__ ((always_inline))
77 char *xbt_strdup(const char *s)
83 xbt_die("memory allocation error (strdup returned NULL)");
88 XBT_PUBLIC(void) xbt_backtrace_display_current(void);
90 /** @brief Like malloc, but xbt_die() on error
92 static inline __attribute__ ((always_inline))
93 void *xbt_malloc(size_t n)
97 xbt_backtrace_display_current();
98 xbt_die("malloc(0) is not portable");
103 xbt_die("Memory allocation of %lu bytes failed", (unsigned long)n);
107 /** @brief like malloc, but xbt_die() on error and memset data to 0
109 static inline __attribute__ ((always_inline))
110 void *xbt_malloc0(size_t n)
113 //if (n==0) xbt_die("calloc(0) is not portable");
116 xbt_die("Memory callocation of %lu bytes failed", (unsigned long)n);
120 /** @brief like realloc, but xbt_die() on error
122 static inline __attribute__ ((always_inline))
123 void *xbt_realloc(void *p, size_t s)
126 //if (s==0) xbt_die("realloc(0) is not portable");
131 xbt_die("memory (re)allocation of %lu bytes failed", (unsigned long)s);
140 #else /* non __GNUC__ */
141 # define xbt_strdup(s) strdup(s)
142 # define xbt_malloc(n) malloc(n)
143 # define xbt_malloc0(n) calloc(n,1)
144 # define xbt_realloc(p,s) realloc(p,s)
145 #endif /* __GNUC__ ? */
149 #define xbt_free(p) free(p) /*nothing specific to do here. A poor valgrind replacement? */
151 /** @brief like free, but you can be sure that it is a function */
152 XBT_PUBLIC(void) xbt_free_f(void *p);
153 /** @brief should be given a pointer to pointer, and frees the second one */
154 XBT_PUBLIC(void) xbt_free_ref(void *d);
158 /** @brief like calloc, but xbt_die() on error and don't memset to 0
162 #define xbt_new(type, count) ((type*)xbt_malloc (sizeof (type) * (count)))
163 /** @brief like calloc, but xbt_die() on error
165 #define xbt_new0(type, count) ((type*)xbt_malloc0 (sizeof (type) * (count)))
169 /** C++ wrapper for xtb_new
171 * This ensures that we do not xbt_new things that need a constructor.
173 template<typename T> inline
174 T* xbt_new_(size_t count)
176 static_assert(std::is_trivial<T>(),
177 "Cannot xbt_new this type");
178 return (T*) xbt_malloc(sizeof(T) * count);
181 template<typename T> inline
182 T* xbt_new0_(size_t count)
184 static_assert(std::is_trivial<T>(),
185 "Cannot xbt_new0 this type");
186 return (T*) xbt_malloc0(sizeof(T) * count);
189 #define xbt_new(type, count) ::xbt_new_<type>(count)
190 #define xbt_new0(type, count) ::xbt_new0_<type>(count)
196 #endif /* _XBT_SYSDEP_H */