Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
further doxygen fixes (I'll try to stop for today)
[simgrid.git] / 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, 2005, 2006, 2007, 2008, 2009, 2010. 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 #include <string.h>
15 #include <stdlib.h>
16 #include <stdarg.h>             /* va_list */
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 /* They live in asserts.h, but need to be declared before this module.
27    double declaration to cut dependency cycle */
28 /**
29  * @addtogroup XBT_error
30  *
31  * @{
32  */
33 /** @brief Kill the program in silence */
34 #define xbt_abort() abort()
35
36 /**
37  * @brief Kill the program with an error message
38  * \param ... a format string and its arguments
39  *
40  * Things are so messed up that the only thing to do now, is to stop the
41  * program.
42  *
43  * The message is handled by a CRITICAL logging request, and may consist of a
44  * format string with arguments.
45  */
46 #define xbt_die(...)                            \
47   do {                                          \
48     XBT_LOG_EXTERNAL_CATEGORY(xbt);             \
49     XBT_CCRITICAL(xbt, __VA_ARGS__);            \
50     xbt_abort();                                \
51   } while (0)
52 /** @} */
53
54 /* these ones live in str.h, but redeclare them here so that we do
55    not need to load the whole str.h and its heavy dependencies */
56 #ifndef __USE_GNU               /* do not redeclare existing headers */
57 XBT_PUBLIC(int) asprintf(char **ptr, const char *fmt,   /*args */
58                          ...) _XBT_GNUC_PRINTF(2, 3);
59 XBT_PUBLIC(int) vasprintf(char **ptr, const char *fmt, va_list ap);
60 #endif
61 XBT_PUBLIC(char *) bprintf(const char *fmt, ...) _XBT_GNUC_PRINTF(1, 2);
62
63 /** @addtogroup XBT_syscall
64  *  @brief Malloc and associated functions, killing the program on error (with \ref XBT_ex)
65  *
66  *  @{
67  */
68
69 #if defined(__GNUC__) || defined(DOXYGEN)
70 /** @brief Like strdup, but xbt_die() on error */
71 static inline __attribute__ ((always_inline))
72 char *xbt_strdup(const char *s)
73 {
74   char *res = NULL;
75   if (s) {
76     res = strdup(s);
77     if (!res)
78       xbt_die("memory allocation error (strdup returned NULL)");
79   }
80   return res;
81 }
82
83 XBT_PUBLIC(void) xbt_backtrace_display_current(void);
84
85 /** @brief Like malloc, but xbt_die() on error
86     @hideinitializer */
87 static inline __attribute__ ((always_inline))
88 void *xbt_malloc(size_t n)
89 {
90   void *res;
91 /*  if (n==0) {
92      xbt_backtrace_display_current();
93      xbt_die("malloc(0) is not portable");
94   }*/
95
96   res = malloc(n);
97   if (!res)
98     xbt_die("Memory allocation of %lu bytes failed", (unsigned long)n);
99   return res;
100 }
101
102 /** @brief like malloc, but xbt_die() on error and memset data to 0
103     @hideinitializer */
104 static inline __attribute__ ((always_inline))
105 void *xbt_malloc0(size_t n)
106 {
107   void *res;
108   //if (n==0) xbt_die("calloc(0) is not portable");
109   res = calloc(n, 1);
110   if (!res)
111     xbt_die("Memory callocation of %lu bytes failed", (unsigned long)n);
112   return res;
113 }
114
115 /** @brief like realloc, but xbt_die() on error
116     @hideinitializer */
117 static inline __attribute__ ((always_inline))
118 void *xbt_realloc(void *p, size_t s)
119 {
120   void *res = NULL;
121   //if (s==0) xbt_die("realloc(0) is not portable");
122   if (s) {
123     if (p) {
124       res = realloc(p, s);
125       if (!res)
126         xbt_die("memory (re)allocation of %lu bytes failed", (unsigned long)s);
127     } else {
128       res = xbt_malloc(s);
129     }
130   } else {
131     if (p) {
132       free(p);
133     }
134   }
135   return res;
136 }
137 #else                           /* non __GNUC__  */
138 #  define xbt_strdup(s)    strdup(s)
139 #  define xbt_malloc(n)    malloc(n)
140 #  define xbt_malloc0(n)   calloc(n,1)
141 #  define xbt_realloc(p,s) realloc(p,s)
142 #endif                          /* __GNUC__ ? */
143
144 /** @brief like free
145     @hideinitializer */
146 #define xbt_free free           /*nothing specific to do here. A poor valgrind replacement? */
147 /*#define xbt_free_fct free * replacement with the guareenty of being a function  FIXME:KILLME*/
148
149 /** @brief like free, but you can be sure that it is a function  */
150 XBT_PUBLIC(void) xbt_free_f(void *p);
151 /** @brief should be given a pointer to pointer, and frees the second one */
152 XBT_PUBLIC(void) xbt_free_ref(void *d);
153
154 /** @brief like calloc, but xbt_die() on error and don't memset to 0
155     @hideinitializer */
156 #define xbt_new(type, count)  ((type*)xbt_malloc (sizeof (type) * (count)))
157 /** @brief like calloc, but xbt_die() on error
158     @hideinitializer */
159 #define xbt_new0(type, count) ((type*)xbt_malloc0 (sizeof (type) * (count)))
160
161 /** @} */
162
163
164 SG_END_DECL()
165 #endif                          /* _XBT_SYSDEP_H */