Logo AND Algorithmique Numérique Distribuée

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