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