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_ATTRIB_PRINTF( format_idx, arg_idx )    \
  31      __attribute__((__format__ (__MINGW_PRINTF_FORMAT, format_idx, arg_idx)))
  32 #else
  33   # define XBT_ATTRIB_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_ATTRIB_SCANF( format_idx, arg_idx )     \
  39          __attribute__((__MINGW_SCANF_FORMAT (__scanf__, format_idx, arg_idx)))
  40 #else
  41   # define XBT_ATTRIB_SCANF( format_idx, arg_idx )     \
  42          __attribute__((__format__ (__scanf__, format_idx, arg_idx)))
  43 #endif
  44
  45 # define XBT_ATTRIB_NORETURN __attribute__((__noreturn__))
  46 # define XBT_ATTRIB_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 #elif defined(_MSC_VER) /* Microsoft Visual Thing */
  60 # define XBT_ATTRIB_PRINTF( format_idx, arg_idx )
  61 # define XBT_ATTRIB_SCANF( format_idx, arg_idx )
  62 # define XBT_ATTRIB_NORETURN __declspec(noreturn)
  63 # define XBT_ATTRIB_UNUSED
  64 # define _XBT_GNUC_CONSTRUCTOR(prio)
  65 # define _XBT_GNUC_DESTRUCTOR(prio)
  66 # define _XBT_NEED_INIT_PRAGMA 1
  67 #else
  68 # define XBT_ATTRIB_PRINTF( format_idx, arg_idx )
  69 # define XBT_ATTRIB_SCANF( format_idx, arg_idx )
  70 # define XBT_ATTRIB_NORETURN
  71 # define XBT_ATTRIB_UNUSED
  72 # define _XBT_GNUC_CONSTRUCTOR(prio)
  73 # define _XBT_GNUC_DESTRUCTOR(prio)
  74 # define _XBT_NEED_INIT_PRAGMA 1
  75
  76 #endif                          /* gcc or MSVC else */
  77
  78 /* inline and __FUNCTION__ are only in GCC when -ansi is off */
  79
  80 #if defined(__GNUC__) && ! defined(__STRICT_ANSI__)
  81 # define _XBT_FUNCTION __FUNCTION__
  82 #elif (defined(__STDC__) && defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L)
  83 # define _XBT_FUNCTION __func__ /* ISO-C99 compliant */
  84 #else
  85 # define _XBT_FUNCTION "function"
  86 #endif
  87
  88 #if defined(__GNUC__)
  89 #   define XBT_ALWAYS_INLINE inline __attribute__ ((always_inline))
  90 #else
  91 #   define XBT_ALWAYS_INLINE inline
  92 #endif
  93
  94 #if defined(__GNUC__)
  95 #   define XBT_THREAD_LOCAL __thread
  96 #elif defined(_MSC_VER)
  97 #   define XBT_THREAD_LOCAL __declspec(thread)
  98 #else
  99 #   define XBT_THREAD_LOCAL No thread local on this architecture
 100 #endif
 101
 102 /* improvable on gcc (by evaluating arguments only once), but wouldn't be portable */
 103 #ifdef MIN
 104 # undef MIN
 105 #endif
 106 #define MIN(a,b) ((a)<(b)?(a):(b))
 107
 108 #ifdef MAX
 109 # undef MAX
 110 #endif
 111 #define MAX(a,b) ((a)>(b)?(a):(b))
 112
 113 /*
 114  * Expands to `one' if there is only one argument for the variadic part.
 115  * Otherwise, expands to `more'.
 116  * Works with up to 63 arguments, which is the maximum mandated by the C99 standard.
 117  */
 118 #define _XBT_IF_ONE_ARG(one, more, ...)                                 \
 119     _XBT_IF_ONE_ARG_(__VA_ARGS__,                                       \
 120                      more, more, more, more, more, more, more, more,    \
 121                      more, more, more, more, more, more, more, more,    \
 122                      more, more, more, more, more, more, more, more,    \
 123                      more, more, more, more, more, more, more, more,    \
 124                      more, more, more, more, more, more, more, more,    \
 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, one)
 128 #define _XBT_IF_ONE_ARG_(a64, a63, a62, a61, a60, a59, a58, a57,        \
 129                          a56, a55, a54, a53, a52, a51, a50, a49,        \
 130                          a48, a47, a46, a45, a44, a43, a42, a41,        \
 131                          a40, a39, a38, a37, a36, a35, a34, a33,        \
 132                          a32, a31, a30, a29, a28, a27, a26, a25,        \
 133                          a24, a23, a22, a21, a20, a19, a18, a17,        \
 134                          a16, a15, a14, a13, a12, a11, a10, a9,         \
 135                          a8, a7, a6, a5, a4, a3, a2, a1, N, ...) N
 136
 137 /* Handle import/export stuff
 138  *
 139  * Rational of XBT_PUBLIC:
 140  *   * This is for library symbols visible from the application-land.
 141  *     Basically, any symbols defined in the include/directory must be like this (plus some other globals).
 142  *
 143  *     UNIX coders should just think of it as a special way to say "extern".
 144  *
 145  *   * If you build the DLL, define the DLL_EXPORT symbol so that all symbols actually get exported by this file.
 146  *
 147  *   * If you link your application against the DLL or if you do a UNIX build, don't do anything special. This file
 148  *     will do the right thing for you by default.
 149  *
 150  * Rational of XBT_EXPORT_NO_IMPORT: (windows-only)
 151  *   * Symbols which must be exported in the DLL, but not imported from it.
 152  *
 153  *   * This is obviously useful for initialized globals (which cannot be  extern or similar).
 154  *   * This is also used in the log mechanism where a macro creates the variable automatically. When the macro is
 155  *     called from within SimGrid, the symbol must be exported, but when called  from within the client code, it must
 156  *     not try to retrieve the symbol from the DLL since it's not in there.
 157  *
 158  * Rational of XBT_IMPORT_NO_EXPORT: (windows-only)
 159  *   * Symbols which must be imported from the DLL, but not explicitly  exported from it.
 160  *
 161  *   * The root log category is already exported, but not imported explicitly when creating a subcategory since we
 162  *     cannot import the parent category to deal with the fact that the parent may be in application space, not DLL
 163  *     space.
 164  */
 165
 166 /* Build the DLL */
 167 #if defined(DLL_EXPORT)
 168 #  define XBT_PUBLIC(type)            __declspec(dllexport) type
 169 #  define XBT_EXPORT_NO_IMPORT(type)  __declspec(dllexport) type
 170 #  define XBT_IMPORT_NO_EXPORT(type)  type
 171 #  define XBT_PUBLIC_DATA(type)       extern __declspec(dllexport) type
 172 #  define XBT_PUBLIC_CLASS            class __declspec(dllexport)
 173 #  define XBT_PRIVATE
 174
 175 /* Link against the DLL */
 176 #elif (defined(_WIN32) && !defined(DLL_EXPORT))
 177 #  define XBT_PUBLIC(type)            __declspec(dllimport) type
 178 #  define XBT_EXPORT_NO_IMPORT(type)  type
 179 #  define XBT_IMPORT_NO_EXPORT(type)  __declspec(dllimport) type
 180 #  define XBT_PUBLIC_DATA(type)       extern __declspec(dllimport) type
 181 #  define XBT_PUBLIC_CLASS            class __declspec(dllimport)
 182 #  define XBT_PRIVATE
 183
 184 #elif defined(__ELF__)
 185 #  define XBT_PUBLIC(type)            __attribute__((visibility("default"))) type
 186 #  define XBT_EXPORT_NO_IMPORT(type)  __attribute__((visibility("default"))) type
 187 #  define XBT_IMPORT_NO_EXPORT(type)  __attribute__((visibility("default"))) type
 188 #  define XBT_PUBLIC_DATA(type)       extern __attribute__((visibility("default"))) type
 189 #  define XBT_PUBLIC_CLASS            class __attribute__((visibility("default")))
 190 #  define XBT_PRIVATE                 __attribute__((visibility("hidden")))
 191
 192 #else
 193 #  define XBT_PUBLIC(type)            type
 194 #  define XBT_EXPORT_NO_IMPORT(type)  type
 195 #  define XBT_IMPORT_NO_EXPORT(type)  type
 196 #  define XBT_PUBLIC_DATA(type)       extern type
 197 #  define XBT_PUBLIC_CLASS            class
 198 #  define XBT_PRIVATE
 199
 200 #endif
 201
 202 #if !defined (max) && !defined(__cplusplus)
 203 #  define max(a,b)  (((a) > (b)) ? (a) : (b))
 204 #endif
 205 #if !defined (min) && !defined(__cplusplus)
 206 #  define min(a,b)  (((a) < (b)) ? (a) : (b))
 207 #endif
 208
 209 #define TRUE  1
 210 #define FALSE 0
 211
 212 /*! C++ users need love */
 213 #ifndef SG_BEGIN_DECL
 214 # ifdef __cplusplus
 215 #  define SG_BEGIN_DECL() extern "C" {
 216 # else
 217 #  define SG_BEGIN_DECL()
 218 # endif
 219 #endif
 220
 221 #ifndef SG_END_DECL
 222 # ifdef __cplusplus
 223 #  define SG_END_DECL() }
 224 # else
 225 #  define SG_END_DECL()
 226 # endif
 227 #endif
 228 /* End of cruft for C++ */
 229
 230 #endif