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 <stdio.h>
  17 #include <stdarg.h> /* va_list */
  18
  19 #include "xbt/misc.h"
  20 #include "xbt/asserts.h"
  21
  22 SG_BEGIN_DECL()
  23
  24 /* FIXME: better place? */
  25 XBT_PUBLIC(int)   asprintf  (char **ptr, const char *fmt, /*args*/ ...) _XBT_GNUC_PRINTF(2,3);
  26 XBT_PUBLIC(int)   vasprintf (char **ptr, const char *fmt, va_list ap);
  27 XBT_PUBLIC(char*) bprintf   (const char*fmt, ...) _XBT_GNUC_PRINTF(1,2);
  28
  29 /* FIXME: ssize_t must be 'long' on windows, no idea whether we should define this explicitly */
  30 XBT_PUBLIC(ssize_t) getline(char **lineptr, size_t *n, FILE *stream);
  31
  32
  33 /* They live in asserts.h, but need to be declared before this module.
  34    double declaration to cut dependency cycle */
  35 /**
  36  * @addtogroup XBT_error
  37  *
  38  * @{
  39  */
  40 XBT_PUBLIC(void) xbt_abort(void) _XBT_GNUC_NORETURN;
  41 XBT_PUBLIC(void) xbt_die(const char *msg) _XBT_GNUC_NORETURN;
  42 /** @} */
  43
  44 /** @addtogroup XBT_syscall
  45  *  @brief Malloc and associated functions, killing the program on error (with \ref XBT_ex)
  46  *
  47  *  @{
  48  */
  49
  50 #if defined(__GNUC__) || defined(DOXYGEN)
  51 /** @brief Like strdup, but xbt_die() on error */
  52 static XBT_INLINE char *xbt_strdup(const char *s) {
  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 /** @brief Like malloc, but xbt_die() on error
  62     @hideinitializer */
  63 static XBT_INLINE void *xbt_malloc(int n){
  64   void *res=malloc(n);
  65   if (!res)
  66      xbt_die(bprintf("Memory allocation of %d bytes failed",n));
  67   return res;
  68 }
  69
  70 /** @brief like malloc, but xbt_die() on error and memset data to 0
  71     @hideinitializer */
  72 static XBT_INLINE void *xbt_malloc0(int n) {
  73   void *res=calloc(n,1);
  74   if (!res)
  75      xbt_die(bprintf("Memory callocation of %d bytes failed",n));
  76   return res;
  77 }
  78
  79 /** @brief like realloc, but xbt_die() on error
  80     @hideinitializer */
  81 static XBT_INLINE void *xbt_realloc(void*p,int s){
  82   void *res=res;
  83   if (s) {
  84     if (p) {
  85       res=realloc(p,s);
  86       if (!res)
  87         xbt_die(bprintf("memory (re)allocation of %d bytes failed",s));
  88     } else {
  89       res=xbt_malloc(s);
  90     }
  91   } else {
  92     if (p) {
  93       free(p);
  94     }
  95   }
  96   return res;
  97 }
  98 #else /* non __GNUC__  */
  99 #  define xbt_strdup(s)    strdup(s)
 100 #  define xbt_malloc(n)    malloc(n)
 101 #  define xbt_malloc0(n)   calloc(n,1)
 102 #  define xbt_realloc(p,s) realloc(p,s)
 103 #endif /* __GNUC__ ? */
 104
 105 /** @brief like free
 106     @hideinitializer */
 107 #define xbt_free free /*nothing specific to do here. A poor valgrind replacement?*/
 108 /*#define xbt_free_fct free * replacement with the guareenty of being a function  FIXME:KILLME*/
 109
 110 /** @brief like free
 111     @hideinitializer */
 112 XBT_PUBLIC(void) xbt_free_f(void* p);
 113
 114 /** @brief like calloc, but xbt_die() on error and don't memset to 0
 115     @hideinitializer */
 116 #define xbt_new(type, count)  ((type*)xbt_malloc (sizeof (type) * (count)))
 117 /** @brief like calloc, but xbt_die() on error
 118     @hideinitializer */
 119 #define xbt_new0(type, count) ((type*)xbt_malloc0 (sizeof (type) * (count)))
 120
 121 /** @} */
 122
 123
 124 SG_END_DECL()
 125
 126 #endif /* _XBT_SYSDEP_H */