Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
cleanup around the free-like functions used as dealloc callbacks in dynar and dicts...
[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*/ ...) _XBT_GNUC_PRINTF(2,3);
38   XBT_PUBLIC(int) vasprintf (char **ptr, const char *fmt, va_list ap);
39 #endif
40 XBT_PUBLIC(char*) bprintf   (const char*fmt, ...) _XBT_GNUC_PRINTF(1,2);
41
42 /** @addtogroup XBT_syscall
43  *  @brief Malloc and associated functions, killing the program on error (with \ref XBT_ex)
44  *
45  *  @{
46  */
47
48 #if defined(__GNUC__) || defined(DOXYGEN)
49 /** @brief Like strdup, but xbt_die() on error */
50 static XBT_INLINE char *xbt_strdup(const char *s) {
51   char *res = NULL;
52   if (s) {
53     res=strdup(s);
54     if (!res) 
55       xbt_die("memory allocation error (strdup returned NULL)");
56   } 
57   return res;
58 }
59 /** @brief Like malloc, but xbt_die() on error 
60     @hideinitializer */
61 static XBT_INLINE void *xbt_malloc(unsigned int n){
62   void *res=malloc(n);
63   if (!res)
64      xbt_die(bprintf("Memory allocation of %d bytes failed",n));
65   return res;
66 }
67
68 /** @brief like malloc, but xbt_die() on error and memset data to 0
69     @hideinitializer */
70 static XBT_INLINE void *xbt_malloc0(unsigned int n) {
71   void *res=calloc(n,1);
72   if (!res)
73      xbt_die(bprintf("Memory callocation of %d bytes failed",n));
74   return res;
75 }
76   
77 /** @brief like realloc, but xbt_die() on error 
78     @hideinitializer */
79 static XBT_INLINE void *xbt_realloc(void*p,unsigned int s){
80   void *res=res;
81   if (s) {
82     if (p) {
83       res=realloc(p,s);
84       if (!res) 
85         xbt_die(bprintf("memory (re)allocation of %d bytes failed",s));
86     } else {
87       res=xbt_malloc(s);
88     }
89   } else {
90     if (p) {
91       free(p);
92     }
93   }
94   return res;
95 }
96 #else /* non __GNUC__  */
97 #  define xbt_strdup(s)    strdup(s)
98 #  define xbt_malloc(n)    malloc(n)
99 #  define xbt_malloc0(n)   calloc(n,1)
100 #  define xbt_realloc(p,s) realloc(p,s)
101 #endif /* __GNUC__ ? */
102
103 /** @brief like free
104     @hideinitializer */
105 #define xbt_free free /*nothing specific to do here. A poor valgrind replacement?*/
106 /*#define xbt_free_fct free * replacement with the guareenty of being a function  FIXME:KILLME*/
107
108 /** @brief like free, but you can be sure that it is a function  */
109 XBT_PUBLIC(void) xbt_free_f(void* p);
110 /** @brief should be given a pointer to pointer, and frees the second one */
111 XBT_PUBLIC(void) xbt_free_ref(void *d);
112
113 /** @brief like calloc, but xbt_die() on error and don't memset to 0
114     @hideinitializer */
115 #define xbt_new(type, count)  ((type*)xbt_malloc (sizeof (type) * (count)))
116 /** @brief like calloc, but xbt_die() on error
117     @hideinitializer */
118 #define xbt_new0(type, count) ((type*)xbt_malloc0 (sizeof (type) * (count)))
119
120 /** @} */  
121
122   
123 SG_END_DECL()
124
125 #endif /* _XBT_SYSDEP_H */