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 /* On MinGW, stdio.h defines __MINGW_PRINTF_FORMAT and __MINGW_SCANF_FORMAT
  20    which are the suitable format style (either gnu_printf or ms_printf)
  21    depending on which version is available (__USE_MINGW_ANSI_STDIO): */
  22 #ifdef __MINGW32__
  23   #include <stdio.h>
  24 #endif
  25
  26 #if defined(__MINGW32__) && defined(__MINGW_PRINTF_FORMAT)
  27   # define XBT_ATTRIB_PRINTF( format_idx, arg_idx )    \
  28      __attribute__((__format__ (__MINGW_PRINTF_FORMAT, format_idx, arg_idx)))
  29 #else
  30   # define XBT_ATTRIB_PRINTF( format_idx, arg_idx )    \
  31      __attribute__((__format__ (__printf__, format_idx, arg_idx)))
  32 #endif
  33
  34 #if defined(__MINGW32__) && defined(__MINGW_SCANF_FORMAT)
  35   # define XBT_ATTRIB_SCANF( format_idx, arg_idx )     \
  36          __attribute__((__MINGW_SCANF_FORMAT (__scanf__, format_idx, arg_idx)))
  37 #else
  38   # define XBT_ATTRIB_SCANF( format_idx, arg_idx )     \
  39          __attribute__((__format__ (__scanf__, format_idx, arg_idx)))
  40 #endif
  41
  42 # define XBT_ATTRIB_NORETURN __attribute__((__noreturn__))
  43 # define XBT_ATTRIB_UNUSED  __attribute__((__unused__))
  44
  45 /* Constructor priorities exist since gcc 4.3.  Apparently, they are however not
  46  * supported on Macs. */
  47 # if (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 3)) && !defined(__APPLE__)
  48 #  define _XBT_GNUC_CONSTRUCTOR(prio) __attribute__((__constructor__ (prio)))
  49 #  define _XBT_GNUC_DESTRUCTOR(prio) __attribute__((__destructor__ (prio)))
  50 # else
  51 #  define _XBT_GNUC_CONSTRUCTOR(prio) __attribute__((__constructor__))
  52 #  define _XBT_GNUC_DESTRUCTOR(prio) __attribute__((__destructor__))
  53 # endif
  54 # undef _XBT_NEED_INIT_PRAGMA
  55
  56 /* inline and __FUNCTION__ are only in GCC when -ansi is off */
  57
  58 #if defined(__GNUC__) && ! defined(__STRICT_ANSI__)
  59 # define _XBT_FUNCTION __FUNCTION__
  60 #elif (defined(__STDC__) && defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L)
  61 # define _XBT_FUNCTION __func__ /* ISO-C99 compliant */
  62 #else
  63 # define _XBT_FUNCTION "function"
  64 #endif
  65
  66 #if defined(__GNUC__)
  67 #   define XBT_ALWAYS_INLINE inline __attribute__ ((always_inline))
  68 #else
  69 #   define XBT_ALWAYS_INLINE inline
  70 #endif
  71
  72 /* improvable on gcc (by evaluating arguments only once), but wouldn't be portable */
  73 #ifdef MIN
  74 # undef MIN
  75 #endif
  76 #define MIN(a,b) ((a)<(b)?(a):(b))
  77
  78 #ifdef MAX
  79 # undef MAX
  80 #endif
  81 #define MAX(a,b) ((a)>(b)?(a):(b))
  82
  83 /*
  84  * Expands to `one' if there is only one argument for the variadic part.
  85  * Otherwise, expands to `more'.
  86  * Works with up to 63 arguments, which is the maximum mandated by the C99 standard.
  87  */
  88 #define _XBT_IF_ONE_ARG(one, more, ...)                                 \
  89     _XBT_IF_ONE_ARG_(__VA_ARGS__,                                       \
  90                      more, more, more, more, more, more, more, more,    \
  91                      more, more, more, more, more, more, more, more,    \
  92                      more, more, more, more, more, more, more, more,    \
  93                      more, more, more, more, more, more, more, more,    \
  94                      more, more, more, more, more, more, more, more,    \
  95                      more, more, more, more, more, more, more, more,    \
  96                      more, more, more, more, more, more, more, more,    \
  97                      more, more, more, more, more, more, more, one)
  98 #define _XBT_IF_ONE_ARG_(a64, a63, a62, a61, a60, a59, a58, a57,        \
  99                          a56, a55, a54, a53, a52, a51, a50, a49,        \
 100                          a48, a47, a46, a45, a44, a43, a42, a41,        \
 101                          a40, a39, a38, a37, a36, a35, a34, a33,        \
 102                          a32, a31, a30, a29, a28, a27, a26, a25,        \
 103                          a24, a23, a22, a21, a20, a19, a18, a17,        \
 104                          a16, a15, a14, a13, a12, a11, a10, a9,         \
 105                          a8, a7, a6, a5, a4, a3, a2, a1, N, ...) N
 106
 107 /* Handle import/export stuff
 108  *
 109  * Rational of XBT_PUBLIC:
 110  *   * This is for library symbols visible from the application-land.
 111  *     Basically, any symbols defined in the include/directory must be like this (plus some other globals).
 112  *
 113  *     UNIX coders should just think of it as a special way to say "extern".
 114  *
 115  *   * If you build the DLL, define the DLL_EXPORT symbol so that all symbols actually get exported by this file.
 116  *
 117  *   * If you link your application against the DLL or if you do a UNIX build, don't do anything special. This file
 118  *     will do the right thing for you by default.
 119  *
 120  * Rational of XBT_EXPORT_NO_IMPORT: (windows-only)
 121  *   * Symbols which must be exported in the DLL, but not imported from it.
 122  *
 123  *   * This is obviously useful for initialized globals (which cannot be  extern or similar).
 124  *   * This is also used in the log mechanism where a macro creates the variable automatically. When the macro is
 125  *     called from within SimGrid, the symbol must be exported, but when called  from within the client code, it must
 126  *     not try to retrieve the symbol from the DLL since it's not in there.
 127  *
 128  * Rational of XBT_IMPORT_NO_EXPORT: (windows-only)
 129  *   * Symbols which must be imported from the DLL, but not explicitly  exported from it.
 130  *
 131  *   * The root log category is already exported, but not imported explicitly when creating a subcategory since we
 132  *     cannot import the parent category to deal with the fact that the parent may be in application space, not DLL
 133  *     space.
 134  */
 135
 136 /* Build the DLL */
 137 #if defined(DLL_EXPORT)
 138 #  define XBT_PUBLIC(type)            __declspec(dllexport) type
 139 #  define XBT_EXPORT_NO_IMPORT(type)  __declspec(dllexport) type
 140 #  define XBT_IMPORT_NO_EXPORT(type)  type
 141 #  define XBT_PUBLIC_DATA(type)       extern __declspec(dllexport) type
 142 #  define XBT_PUBLIC_CLASS            class __declspec(dllexport)
 143 #  define XBT_PRIVATE
 144
 145 /* Link against the DLL */
 146 #elif (defined(_WIN32) && !defined(DLL_EXPORT))
 147 #  define XBT_PUBLIC(type)            __declspec(dllimport) type
 148 #  define XBT_EXPORT_NO_IMPORT(type)  type
 149 #  define XBT_IMPORT_NO_EXPORT(type)  __declspec(dllimport) type
 150 #  define XBT_PUBLIC_DATA(type)       extern __declspec(dllimport) type
 151 #  define XBT_PUBLIC_CLASS            class __declspec(dllimport)
 152 #  define XBT_PRIVATE
 153
 154 #elif defined(__ELF__)
 155 #  define XBT_PUBLIC(type)            __attribute__((visibility("default"))) type
 156 #  define XBT_EXPORT_NO_IMPORT(type)  __attribute__((visibility("default"))) type
 157 #  define XBT_IMPORT_NO_EXPORT(type)  __attribute__((visibility("default"))) type
 158 #  define XBT_PUBLIC_DATA(type)       extern __attribute__((visibility("default"))) type
 159 #  define XBT_PUBLIC_CLASS            class __attribute__((visibility("default")))
 160 #  define XBT_PRIVATE                 __attribute__((visibility("hidden")))
 161
 162 #else
 163 #  define XBT_PUBLIC(type)            type
 164 #  define XBT_EXPORT_NO_IMPORT(type)  type
 165 #  define XBT_IMPORT_NO_EXPORT(type)  type
 166 #  define XBT_PUBLIC_DATA(type)       extern type
 167 #  define XBT_PUBLIC_CLASS            class
 168 #  define XBT_PRIVATE
 169
 170 #endif
 171
 172 #define TRUE  1
 173 #define FALSE 0
 174
 175 /*! C++ users need love */
 176 #ifndef SG_BEGIN_DECL
 177 # ifdef __cplusplus
 178 #  define SG_BEGIN_DECL() extern "C" {
 179 # else
 180 #  define SG_BEGIN_DECL()
 181 # endif
 182 #endif
 183
 184 #ifndef SG_END_DECL
 185 # ifdef __cplusplus
 186 #  define SG_END_DECL() }
 187 # else
 188 #  define SG_END_DECL()
 189 # endif
 190 #endif
 191 /* End of cruft for C++ */
 192
 193 #endif