include/xbt/base.h

   1 /* xbt.h - Public interface to the xbt (simgrid's toolbox)                     */
   2
   3 /* Copyright (c) 2004-2015. The SimGrid Team.
   4  * All rights reserved.                                                     */
   5
   6 /* This program is free software; you can redistribute it and/or modify it
   7  * under the terms of the license (GNU LGPL) which comes with this package. */
   8
   9 #ifndef XBT_BASE_H
  10 #define XBT_BASE_H
  11
  12 #include "simgrid_config.h"
  13
  14 /* Define _GNU_SOURCE for getline, isfinite, etc. */
  15 #ifndef _GNU_SOURCE
  16         #define _GNU_SOURCE
  17 #endif
  18
  19 /* Attributes are only in recent versions of GCC */
  20 #if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ > 4))
  21
  22 /* On MinGW, stdio.h defines __MINGW_PRINTF_FORMAT and __MINGW_SCANF_FORMAT
  23    which are the suitable format style (either gnu_printf or ms_printf)
  24    depending on which version is available (__USE_MINGW_ANSI_STDIO): */
  25 #ifdef __MINGW32__
  26   #include <stdio.h>
  27 #endif
  28
  29 #if defined(__MINGW32__) && defined(__MINGW_PRINTF_FORMAT)
  30   # define _XBT_GNUC_PRINTF( format_idx, arg_idx )    \
  31      __attribute__((__format__ (__MINGW_PRINTF_FORMAT, format_idx, arg_idx)))
  32 #else
  33   # define _XBT_GNUC_PRINTF( format_idx, arg_idx )    \
  34      __attribute__((__format__ (__printf__, format_idx, arg_idx)))
  35 #endif
  36
  37 #if defined(__MINGW32__) && defined(__MINGW_SCANF_FORMAT)
  38   # define _XBT_GNUC_SCANF( format_idx, arg_idx )     \
  39          __attribute__((__MINGW_SCANF_FORMAT (__scanf__, format_idx, arg_idx)))
  40 #else
  41   # define _XBT_GNUC_SCANF( format_idx, arg_idx )     \
  42          __attribute__((__format__ (__scanf__, format_idx, arg_idx)))
  43 #endif
  44
  45 # define _XBT_GNUC_NORETURN __attribute__((__noreturn__))
  46 # define _XBT_GNUC_UNUSED  __attribute__((__unused__))
  47
  48 /* Constructor priorities exist since gcc 4.3.  Apparently, they are however not
  49  * supported on Macs. */
  50 # if (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 3)) && !defined(__APPLE__)
  51 #  define _XBT_GNUC_CONSTRUCTOR(prio) __attribute__((__constructor__ (prio)))
  52 #  define _XBT_GNUC_DESTRUCTOR(prio) __attribute__((__destructor__ (prio)))
  53 # else
  54 #  define _XBT_GNUC_CONSTRUCTOR(prio) __attribute__((__constructor__))
  55 #  define _XBT_GNUC_DESTRUCTOR(prio) __attribute__((__destructor__))
  56 # endif
  57 # undef _XBT_NEED_INIT_PRAGMA
  58
  59 #else                           /* !__GNUC__ */
  60 # define _XBT_GNUC_PRINTF( format_idx, arg_idx )
  61 # define _XBT_GNUC_SCANF( format_idx, arg_idx )
  62 # define _XBT_GNUC_NORETURN
  63 # define _XBT_GNUC_UNUSED
  64 # define _XBT_GNUC_CONSTRUCTOR(prio)
  65 # define _XBT_GNUC_DESTRUCTOR(prio)
  66 # define  _XBT_NEED_INIT_PRAGMA 1
  67
  68 #endif                          /* !__GNUC__ */
  69
  70 /* inline and __FUNCTION__ are only in GCC when -ansi is off */
  71
  72 #if defined(__GNUC__) && ! defined(__STRICT_ANSI__)
  73 # define _XBT_FUNCTION __FUNCTION__
  74 #elif (defined(__STDC__) && defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L)
  75 # define _XBT_FUNCTION __func__ /* ISO-C99 compliant */
  76 #else
  77 # define _XBT_FUNCTION "function"
  78 #endif
  79
  80 #ifdef DOXYGEN
  81 #  define XBT_INLINE
  82 #else
  83 #  ifndef __cplusplus
  84 #    if defined(__GNUC__) && ! defined(__STRICT_ANSI__)
  85 #        define XBT_INLINE inline
  86 #    elif (defined(__STDC__) && defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L)
  87 #        define XBT_INLINE inline
  88 #    else
  89 #        define XBT_INLINE
  90 #    endif
  91 #  else
  92 #     if defined (_MSC_VER)
  93 #       define XBT_INLINE __inline
  94 #     else
  95 #       define XBT_INLINE  inline
  96 #     endif
  97 #  endif /* __cplusplus */
  98 #endif
  99
 100 #if defined(__GNUC__)
 101 #   define XBT_ALWAYS_INLINE inline __attribute__ ((always_inline))
 102 #else
 103 #   define XBT_ALWAYS_INLINE XBT_INLINE
 104 #endif
 105
 106 /* improvable on gcc (by evaluating arguments only once), but wouldn't be portable */
 107 #ifdef MIN
 108 # undef MIN
 109 #endif
 110 #define MIN(a,b) ((a)<(b)?(a):(b))
 111
 112 #ifdef MAX
 113 # undef MAX
 114 #endif
 115 #define MAX(a,b) ((a)>(b)?(a):(b))
 116
 117 /*
 118  * Expands to `one' if there is only one argument for the variadic part.
 119  * Otherwise, expands to `more'.
 120  * Works with up to 63 arguments, which is the maximum mandated by the C99
 121  * standard.
 122  */
 123 #define _XBT_IF_ONE_ARG(one, more, ...)                                 \
 124     _XBT_IF_ONE_ARG_(__VA_ARGS__,                                       \
 125                      more, more, more, more, more, more, more, more,    \
 126                      more, more, more, more, more, more, more, more,    \
 127                      more, more, more, more, more, more, more, more,    \
 128                      more, more, more, more, more, more, more, more,    \
 129                      more, more, more, more, more, more, more, more,    \
 130                      more, more, more, more, more, more, more, more,    \
 131                      more, more, more, more, more, more, more, more,    \
 132                      more, more, more, more, more, more, more, one)
 133 #define _XBT_IF_ONE_ARG_(a64, a63, a62, a61, a60, a59, a58, a57,        \
 134                          a56, a55, a54, a53, a52, a51, a50, a49,        \
 135                          a48, a47, a46, a45, a44, a43, a42, a41,        \
 136                          a40, a39, a38, a37, a36, a35, a34, a33,        \
 137                          a32, a31, a30, a29, a28, a27, a26, a25,        \
 138                          a24, a23, a22, a21, a20, a19, a18, a17,        \
 139                          a16, a15, a14, a13, a12, a11, a10, a9,         \
 140                          a8, a7, a6, a5, a4, a3, a2, a1, N, ...) N
 141
 142 /*
 143  * Function calling convention (not used for now)
 144  */
 145
 146 #ifdef _XBT_WIN32
 147 #  ifndef _XBT_CALL
 148 #    define _XBT_CALL __cdecl
 149 #   endif
 150 #else
 151 #  define _XBT_CALL
 152 #endif
 153
 154 /* Handle import/export stuff
 155  *
 156  * Rational of XBT_PUBLIC:
 157  *   * This is for library symbols visible from the application-land.
 158  *     Basically, any symbols defined in the include/directory must be
 159  *     like this (plus some other globals).
 160  *
 161  *     UNIX coders should just think of it as a special way to say "extern".
 162  *
 163  *   * If you build the DLL, define the DLL_EXPORT symbol so that all symbols
 164  *     actually get exported by this file.
 165
 166  *   * If you do a static windows compilation, define DLL_STATIC, both when
 167  *     compiling the application files and when compiling the library.
 168  *
 169  *   * If you link your application against the DLL or if you do a UNIX build,
 170  *     don't do anything special. This file will do the right thing for you
 171  *     by default.
 172  *
 173  *
 174  * Rational of XBT_EXPORT_NO_IMPORT: (windows-only)
 175  *   * Symbols which must be exported in the DLL, but not imported from it.
 176  *
 177  *   * This is obviously useful for initialized globals (which cannot be
 178  *     extern or similar).
 179  *   * This is also used in the log mechanism where a macro creates the
 180  *     variable automatically. When the macro is called from within SimGrid,
 181  *     the symbol must be exported, but when called  from within the client
 182  *     code, it must not try to retrieve the symbol from the DLL since it's
 183  *      not in there.
 184  *
 185  * Rational of XBT_IMPORT_NO_EXPORT: (windows-only)
 186  *   * Symbols which must be imported from the DLL, but not explicitly
 187  *     exported from it.
 188  *
 189  *   * The root log category is already exported, but not imported explicitly
 190  *     when creating a subcategory since we cannot import the parent category
 191  *     to deal with the fact that the parent may be in application space, not
 192  *     DLL space.
 193  */
 194
 195 /* Build the DLL */
 196 #if defined(DLL_EXPORT)
 197 #  define XBT_PUBLIC(type)            __declspec(dllexport) type
 198 #  define XBT_EXPORT_NO_IMPORT(type)  __declspec(dllexport) type
 199 #  define XBT_IMPORT_NO_EXPORT(type)  type
 200 #  define XBT_PUBLIC_DATA(type)       extern __declspec(dllexport) type
 201 #  define XBT_PUBLIC_CLASS            class __declspec(dllexport)
 202
 203
 204 /* Pack everything up statically */
 205 #elif defined(DLL_STATIC)
 206 #  define XBT_PUBLIC(type)            type
 207 #  define XBT_EXPORT_NO_IMPORT(type)  type
 208 #  define XBT_IMPORT_NO_EXPORT(type)  type
 209 #  define XBT_PUBLIC_DATA(type)       extern type
 210 #  define XBT_PUBLIC_CLASS            class
 211
 212
 213 /* Link against the DLL */
 214 #elif (defined(_XBT_WIN32) && !defined(DLL_EXPORT) && !defined(DLL_STATIC))
 215 #  define XBT_PUBLIC(type)            __declspec(dllimport) type
 216 #  define XBT_EXPORT_NO_IMPORT(type)  type
 217 #  define XBT_IMPORT_NO_EXPORT(type)  __declspec(dllimport) type
 218 #  define XBT_PUBLIC_DATA(type)       extern __declspec(dllimport) type
 219 #  define XBT_PUBLIC_CLASS            class __declspec(dllimport)
 220
 221
 222 /* UNIX build */
 223 #else
 224 #  define XBT_PUBLIC(type)            type
 225 #  define XBT_EXPORT_NO_IMPORT(type)  type
 226 #  define XBT_IMPORT_NO_EXPORT(type)  type
 227 #  define XBT_PUBLIC_DATA(type)       extern type
 228 #  define XBT_PUBLIC_CLASS            class
 229
 230 #endif
 231
 232 #ifdef _XBT_WIN32
 233 #define XBT_INTERNAL
 234 #else
 235 #define XBT_INTERNAL __attribute__((visibility ("hidden")))
 236 #endif
 237
 238 #if !defined (max) && !defined(__cplusplus)
 239 #  define max(a,b)  (((a) > (b)) ? (a) : (b))
 240 #endif
 241 #if !defined (min) && !defined(__cplusplus)
 242 #  define min(a,b)  (((a) < (b)) ? (a) : (b))
 243 #endif
 244
 245 #define TRUE  1
 246 #define FALSE 0
 247
 248 /*! C++ users need love */
 249 #ifndef SG_BEGIN_DECL
 250 # ifdef __cplusplus
 251 #  define SG_BEGIN_DECL() extern "C" {
 252 # else
 253 #  define SG_BEGIN_DECL()
 254 # endif
 255 #endif
 256
 257 #ifndef SG_END_DECL
 258 # ifdef __cplusplus
 259 #  define SG_END_DECL() }
 260 # else
 261 #  define SG_END_DECL()
 262 # endif
 263 #endif
 264 /* End of cruft for C++ */
 265
 266 #endif