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. */
16 #include "xbt/asserts.h"
18 #include "simgrid_config.h"
22 #include <stdarg.h> /* va_list */
26 /* They live in asserts.h, but need to be declared before this module.
27 double declaration to cut dependency cycle */
29 * @addtogroup XBT_error
33 /** @brief Kill the program in silence */
35 /* Call __gcov_flush on abort when compiling with coverage options. */
38 extern void __gcov_flush(void); \
43 #define xbt_abort() abort()
47 * @brief Kill the program with an error message
48 * \param ... a format string and its arguments
50 * Things are so messed up that the only thing to do now, is to stop the
53 * The message is handled by a CRITICAL logging request, and may consist of a
54 * format string with arguments.
56 #define xbt_die(...) \
58 XBT_LOG_EXTERNAL_CATEGORY(xbt); \
59 XBT_CCRITICAL(xbt, __VA_ARGS__); \
64 /* these ones live in str.h, but redeclare them here so that we do
65 not need to load the whole str.h and its heavy dependencies */
66 #ifndef __USE_GNU /* do not redeclare existing headers */
67 XBT_PUBLIC(int) asprintf(char **ptr, const char *fmt, /*args */
68 ...) _XBT_GNUC_PRINTF(2, 3);
69 XBT_PUBLIC(int) vasprintf(char **ptr, const char *fmt, va_list ap);
71 XBT_PUBLIC(char *) bprintf(const char *fmt, ...) _XBT_GNUC_PRINTF(1, 2);
73 /** @addtogroup XBT_syscall
74 * @brief Malloc and associated functions, killing the program on error (with \ref XBT_ex)
79 #if defined(__GNUC__) || defined(DOXYGEN)
80 /** @brief Like strdup, but xbt_die() on error */
81 static inline __attribute__ ((always_inline))
82 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 inline __attribute__ ((always_inline))
98 void *xbt_malloc(size_t n)
102 xbt_backtrace_display_current();
103 xbt_die("malloc(0) is not portable");
108 xbt_die("Memory allocation of %lu bytes failed", (unsigned long)n);
112 /** @brief like malloc, but xbt_die() on error and memset data to 0
114 static inline __attribute__ ((always_inline))
115 void *xbt_malloc0(size_t n)
118 //if (n==0) xbt_die("calloc(0) is not portable");
121 xbt_die("Memory callocation of %lu bytes failed", (unsigned long)n);
125 /** @brief like realloc, but xbt_die() on error
127 static inline __attribute__ ((always_inline))
128 void *xbt_realloc(void *p, size_t s)
131 //if (s==0) xbt_die("realloc(0) is not portable");
136 xbt_die("memory (re)allocation of %lu bytes failed", (unsigned long)s);
145 #else /* non __GNUC__ */
146 # define xbt_strdup(s) strdup(s)
147 # define xbt_malloc(n) malloc(n)
148 # define xbt_malloc0(n) calloc(n,1)
149 # define xbt_realloc(p,s) realloc(p,s)
150 #endif /* __GNUC__ ? */
154 #define xbt_free free /*nothing specific to do here. A poor valgrind replacement? */
156 /** @brief like free, but you can be sure that it is a function */
157 XBT_PUBLIC(void) xbt_free_f(void *p);
158 /** @brief should be given a pointer to pointer, and frees the second one */
159 XBT_PUBLIC(void) xbt_free_ref(void *d);
161 /** @brief like calloc, but xbt_die() on error and don't memset to 0
163 #define xbt_new(type, count) ((type*)xbt_malloc (sizeof (type) * (count)))
164 /** @brief like calloc, but xbt_die() on error
166 #define xbt_new0(type, count) ((type*)xbt_malloc0 (sizeof (type) * (count)))
172 #endif /* _XBT_SYSDEP_H */