Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
C++ needs love
[simgrid.git] / include / xbt / sysdep.h
1 /* $Id$ */
2 /*  xbt/sysdep.h -- all system dependency                                   */
3 /*  no system header should be loaded out of this file so that we have only */
4 /*  one file to check when porting to another OS                            */
5
6 /* Copyright (c) 2004 Martin Quinson. 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 #include <string.h>
15 #include <stdlib.h>
16 #include <stdarg.h>             /* va_list */
17
18 #include "xbt/misc.h"
19 #include "xbt/asserts.h"
20
21 SG_BEGIN_DECL()
22
23 /* They live in asserts.h, but need to be declared before this module.
24    double declaration to cut dependency cycle */
25 /**
26  * @addtogroup XBT_error
27  *
28  * @{
29  */
30 XBT_PUBLIC(void) xbt_abort(void) _XBT_GNUC_NORETURN;
31 XBT_PUBLIC(void) xbt_die(const char *msg) _XBT_GNUC_NORETURN;
32 /** @} */
33
34 /* these ones live in str.h, but redeclare them here so that we do
35    not need to load the whole str.h and its heavy dependencies */
36 #ifndef __USE_GNU               /* do not redeclare existing headers */
37 XBT_PUBLIC(int) asprintf(char **ptr, const char *fmt,   /*args */
38                          ...) _XBT_GNUC_PRINTF(2, 3);
39 XBT_PUBLIC(int) vasprintf(char **ptr, const char *fmt, va_list ap);
40 #endif
41 XBT_PUBLIC(char *) bprintf(const char *fmt, ...) _XBT_GNUC_PRINTF(1, 2);
42
43 /** @addtogroup XBT_syscall
44  *  @brief Malloc and associated functions, killing the program on error (with \ref XBT_ex)
45  *
46  *  @{
47  */
48
49 #if defined(__GNUC__) || defined(DOXYGEN)
50 /** @brief Like strdup, but xbt_die() on error */
51      static XBT_INLINE char *xbt_strdup(const char *s)
52 {
53   char *res = NULL;
54   if (s) {
55     res = strdup(s);
56     if (!res)
57       xbt_die("memory allocation error (strdup returned NULL)");
58   }
59   return res;
60 }
61
62 XBT_PUBLIC(void) xbt_backtrace_display_current(void);
63
64 /** @brief Like malloc, but xbt_die() on error
65     @hideinitializer */
66 static XBT_INLINE void *xbt_malloc(unsigned int n)
67 {
68   void *res;
69 /*  if (n==0) {
70      xbt_backtrace_display_current();
71      xbt_die("malloc(0) is not portable");
72   }*/
73
74   res = malloc(n);
75   if (!res)
76     xbt_die(bprintf("Memory allocation of %d bytes failed", n));
77   return res;
78 }
79
80 /** @brief like malloc, but xbt_die() on error and memset data to 0
81     @hideinitializer */
82 static XBT_INLINE void *xbt_malloc0(unsigned int n)
83 {
84   void *res;
85   //if (n==0) xbt_die("calloc(0) is not portable");
86   res = calloc(n, 1);
87   if (!res)
88     xbt_die(bprintf("Memory callocation of %d bytes failed", n));
89   return res;
90 }
91
92 /** @brief like realloc, but xbt_die() on error
93     @hideinitializer */
94 static XBT_INLINE void *xbt_realloc(void *p, unsigned int s)
95 {
96   void *res = res;
97   //if (s==0) xbt_die("realloc(0) is not portable");
98   if (s) {
99     if (p) {
100       res = realloc(p, s);
101       if (!res)
102         xbt_die(bprintf("memory (re)allocation of %d bytes failed", s));
103     } else {
104       res = xbt_malloc(s);
105     }
106   } else {
107     if (p) {
108       free(p);
109     }
110   }
111   return res;
112 }
113 #else /* non __GNUC__  */
114 #  define xbt_strdup(s)    strdup(s)
115 #  define xbt_malloc(n)    malloc(n)
116 #  define xbt_malloc0(n)   calloc(n,1)
117 #  define xbt_realloc(p,s) realloc(p,s)
118 #endif /* __GNUC__ ? */
119
120 /** @brief like free
121     @hideinitializer */
122 #define xbt_free free           /*nothing specific to do here. A poor valgrind replacement? */
123 /*#define xbt_free_fct free * replacement with the guareenty of being a function  FIXME:KILLME*/
124
125 /** @brief like free, but you can be sure that it is a function  */
126 XBT_PUBLIC(void) xbt_free_f(void *p);
127 /** @brief should be given a pointer to pointer, and frees the second one */
128 XBT_PUBLIC(void) xbt_free_ref(void *d);
129
130 /** @brief like calloc, but xbt_die() on error and don't memset to 0
131     @hideinitializer */
132 #define xbt_new(type, count)  ((type*)xbt_malloc (sizeof (type) * (count)))
133 /** @brief like calloc, but xbt_die() on error
134     @hideinitializer */
135 #define xbt_new0(type, count) ((type*)xbt_malloc0 (sizeof (type) * (count)))
136
137 /** @} */
138
139
140 SG_END_DECL()
141 #endif /* _XBT_SYSDEP_H */