include/xbt/base.h

   1 /* xbt.h - Public interface to the xbt (simgrid's toolbox)                  */
   2
   3 /* Copyright (c) 2004-2021. The SimGrid Team. All rights reserved.          */
   4
   5 /* This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the license (GNU LGPL) which comes with this package. */
   7
   8 #ifndef XBT_BASE_H
   9 #define XBT_BASE_H
  10
  11 /* Define _GNU_SOURCE for getline, isfinite, etc. */
  12 #ifndef _GNU_SOURCE
  13 #  define _GNU_SOURCE
  14 #endif
  15
  16 /* On MinGW, stdio.h defines __MINGW_PRINTF_FORMAT and __MINGW_SCANF_FORMAT
  17    which are the suitable format style (either gnu_printf or ms_printf)
  18    depending on which version is available (__USE_MINGW_ANSI_STDIO): */
  19 #ifdef __MINGW32__
  20 #  include <stdio.h>
  21
  22 #define XBT_ATTRIB_PRINTF(format_idx, arg_idx)                                                                         \
  23   __attribute__((__format__(__MINGW_PRINTF_FORMAT, (format_idx), (arg_idx))))
  24 #define XBT_ATTRIB_SCANF(format_idx, arg_idx) __attribute__((__MINGW_SCANF_FORMAT(__scanf__, (format_idx), (arg_idx))))
  25 #else
  26 #define XBT_ATTRIB_PRINTF(format_idx, arg_idx) __attribute__((__format__(__printf__, (format_idx), (arg_idx))))
  27 #define XBT_ATTRIB_SCANF(format_idx, arg_idx) __attribute__((__format__(__scanf__, (format_idx), (arg_idx))))
  28 #endif
  29
  30 #if defined(__cplusplus)
  31 #if __cplusplus >= 201103L
  32 #define XBT_ATTRIB_NORETURN [[noreturn]]
  33 #endif
  34 #if __cplusplus >= 201703L
  35 #define XBT_ATTRIB_UNUSED [[maybe_unused]]
  36 #endif
  37 #if __cplusplus >= 201402L
  38 #define XBT_ATTRIB_DEPRECATED(mesg) [[deprecated(mesg)]]
  39 #endif
  40 #elif defined(__STDC_VERSION__)
  41 #if __STDC_VERSION__ >= 201112L
  42 #define XBT_ATTRIB_NORETURN _Noreturn
  43 #endif
  44 #endif
  45
  46 #ifndef XBT_ATTRIB_NORETURN
  47 #define XBT_ATTRIB_NORETURN __attribute__((noreturn))
  48 #endif
  49 #ifndef XBT_ATTRIB_UNUSED
  50 #define XBT_ATTRIB_UNUSED  __attribute__((unused))
  51 #endif
  52 #ifndef XBT_ATTRIB_DEPRECATED
  53 #define XBT_ATTRIB_DEPRECATED(mesg) __attribute__((deprecated(mesg)))
  54 #endif
  55
  56 #define XBT_ATTRIB_DEPRECATED_v330(mesg)                                                                               \
  57   XBT_ATTRIB_DEPRECATED(mesg " (this compatibility wrapper will be dropped after v3.29)")
  58 #define XBT_ATTRIB_DEPRECATED_v331(mesg)                                                                               \
  59   XBT_ATTRIB_DEPRECATED(mesg " (this compatibility wrapper will be dropped after v3.30)")
  60 #define XBT_ATTRIB_DEPRECATED_v332(mesg)                                                                               \
  61   XBT_ATTRIB_DEPRECATED(mesg " (this compatibility wrapper will be dropped after v3.31)")
  62
  63 /* Work around https://github.com/microsoft/vscode-cpptools/issues/4503 */
  64 #ifdef __INTELLISENSE__
  65 #pragma diag_suppress 1094
  66 #endif
  67
  68 #if !defined(__APPLE__)
  69 #  define XBT_ATTRIB_CONSTRUCTOR(prio) __attribute__((__constructor__(prio)))
  70 #  define XBT_ATTRIB_DESTRUCTOR(prio) __attribute__((__destructor__(prio)))
  71 #else
  72 #  define XBT_ATTRIB_CONSTRUCTOR(prio) __attribute__((__constructor__))
  73 #  define XBT_ATTRIB_DESTRUCTOR(prio) __attribute__((__destructor__))
  74 #endif
  75
  76 #ifndef XBT_ALWAYS_INLINE /* defined also in libsosp */
  77 #  if defined(__GNUC__)
  78 #    define XBT_ALWAYS_INLINE inline __attribute__ ((always_inline))
  79 #  else
  80 #    define XBT_ALWAYS_INLINE inline
  81 #  endif
  82 #endif
  83
  84 /* Stringify argument. */
  85 #define _XBT_STRINGIFY(a) #a
  86
  87 /* Concatenate arguments. _XBT_CONCAT2 adds a level of indirection over _XBT_CONCAT. */
  88 #define _XBT_CONCAT(a, b) a##b
  89 #define _XBT_CONCAT2(a, b) _XBT_CONCAT(a, b)
  90 #define _XBT_CONCAT3(a, b, c) _XBT_CONCAT2(_XBT_CONCAT2(a, b), c)
  91 #define _XBT_CONCAT4(a, b, c, d) _XBT_CONCAT2(_XBT_CONCAT3(a, b, c), d)
  92
  93 /*
  94  * Expands to `one' if there is only one argument for the variadic part.
  95  * Otherwise, expands to `more'.
  96  * Works with up to 63 arguments, which is the maximum mandated by the C99 standard.
  97  */
  98 #define _XBT_IF_ONE_ARG(one, more, ...)                                 \
  99     _XBT_IF_ONE_ARG_(__VA_ARGS__,                                       \
 100                      more, more, more, more, more, more, more, more,    \
 101                      more, more, more, more, more, more, more, more,    \
 102                      more, more, more, more, more, more, more, more,    \
 103                      more, more, more, more, more, more, more, more,    \
 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, one)
 108 #define _XBT_IF_ONE_ARG_(a64, a63, a62, a61, a60, a59, a58, a57,        \
 109                          a56, a55, a54, a53, a52, a51, a50, a49,        \
 110                          a48, a47, a46, a45, a44, a43, a42, a41,        \
 111                          a40, a39, a38, a37, a36, a35, a34, a33,        \
 112                          a32, a31, a30, a29, a28, a27, a26, a25,        \
 113                          a24, a23, a22, a21, a20, a19, a18, a17,        \
 114                          a16, a15, a14, a13, a12, a11, a10, a9,         \
 115                          a8, a7, a6, a5, a4, a3, a2, a1, N, ...) N
 116
 117 /* Expands to number of arguments. */
 118 #define _XBT_COUNT_ARGS(...) _XBT_IF_ONE_ARG_(__VA_ARGS__,              \
 119                                               64, 63, 62, 61, 60, 59, 58, 57, 56, 55, 54, 53, 52, 51, 50, 49, \
 120                                               48, 47, 46, 45, 44, 43, 42, 41, 40, 39, 38, 37, 36, 35, 34, 33, \
 121                                               32, 31, 30, 29, 28, 27, 26, 25, 24, 23, 22, 21, 20, 19, 18, 17, \
 122                                               16, 15, 14, 13, 12, 11, 10, 9, 8, 7, 6, 5, 4, 3, 2, 1)
 123
 124 /* Expands to list with each argument rendered as string. Add more cases if needed. */
 125 #define _XBT_STRINGIFY_ARGS(...) _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_02_, __VA_ARGS__)(__VA_ARGS__)
 126 #define _XBT_STRINGIFY_A_02_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_03_, __VA_ARGS__)(__VA_ARGS__)
 127 #define _XBT_STRINGIFY_A_03_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_04_, __VA_ARGS__)(__VA_ARGS__)
 128 #define _XBT_STRINGIFY_A_04_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_05_, __VA_ARGS__)(__VA_ARGS__)
 129 #define _XBT_STRINGIFY_A_05_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_06_, __VA_ARGS__)(__VA_ARGS__)
 130 #define _XBT_STRINGIFY_A_06_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_07_, __VA_ARGS__)(__VA_ARGS__)
 131 #define _XBT_STRINGIFY_A_07_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_08_, __VA_ARGS__)(__VA_ARGS__)
 132 #define _XBT_STRINGIFY_A_08_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_09_, __VA_ARGS__)(__VA_ARGS__)
 133 #define _XBT_STRINGIFY_A_09_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_10_, __VA_ARGS__)(__VA_ARGS__)
 134 #define _XBT_STRINGIFY_A_10_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_11_, __VA_ARGS__)(__VA_ARGS__)
 135 #define _XBT_STRINGIFY_A_11_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_12_, __VA_ARGS__)(__VA_ARGS__)
 136 #define _XBT_STRINGIFY_A_12_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_13_, __VA_ARGS__)(__VA_ARGS__)
 137 #define _XBT_STRINGIFY_A_13_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_14_, __VA_ARGS__)(__VA_ARGS__)
 138 #define _XBT_STRINGIFY_A_14_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_15_, __VA_ARGS__)(__VA_ARGS__)
 139 #define _XBT_STRINGIFY_A_15_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_16_, __VA_ARGS__)(__VA_ARGS__)
 140 #define _XBT_STRINGIFY_A_16_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_17_, __VA_ARGS__)(__VA_ARGS__)
 141 #define _XBT_STRINGIFY_A_17_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_18_, __VA_ARGS__)(__VA_ARGS__)
 142 #define _XBT_STRINGIFY_A_18_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_19_, __VA_ARGS__)(__VA_ARGS__)
 143 #define _XBT_STRINGIFY_A_19_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_20_, __VA_ARGS__)(__VA_ARGS__)
 144 #define _XBT_STRINGIFY_A_20_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_21_, __VA_ARGS__)(__VA_ARGS__)
 145 #define _XBT_STRINGIFY_A_21_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_22_, __VA_ARGS__)(__VA_ARGS__)
 146 #define _XBT_STRINGIFY_A_22_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_23_, __VA_ARGS__)(__VA_ARGS__)
 147 #define _XBT_STRINGIFY_A_23_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_24_, __VA_ARGS__)(__VA_ARGS__)
 148 #define _XBT_STRINGIFY_A_24_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_25_, __VA_ARGS__)(__VA_ARGS__)
 149 #define _XBT_STRINGIFY_A_25_(...) error_maximum_size_of_XBT_STRINGIFY_ARGS_reached
 150
 151 /* Handle import/export stuff
 152  *
 153  * Rationale of XBT_PUBLIC:
 154  *   * This is for library symbols visible from the application-land.
 155  *     Basically, any symbols defined in the include/directory must be like this (plus some other globals).
 156  *
 157  *     UNIX coders should just think of it as a special way to say "extern".
 158  *
 159  *   * If you build the DLL, define the DLL_EXPORT symbol so that all symbols actually get exported by this file.
 160  *
 161  *   * If you link your application against the DLL or if you do a UNIX build, don't do anything special. This file
 162  *     will do the right thing for you by default.
 163  *
 164  * Rationale of XBT_EXPORT_NO_IMPORT: (windows-only)
 165  *   * Symbols which must be exported in the DLL, but not imported from it.
 166  *
 167  *   * This is obviously useful for initialized globals (which cannot be  extern or similar).
 168  *   * This is also used in the log mechanism where a macro creates the variable automatically. When the macro is
 169  *     called from within SimGrid, the symbol must be exported, but when called  from within the client code, it must
 170  *     not try to retrieve the symbol from the DLL since it's not in there.
 171  *
 172  * Rationale of XBT_IMPORT_NO_EXPORT: (windows-only)
 173  *   * Symbols which must be imported from the DLL, but not explicitly  exported from it.
 174  *
 175  *   * The root log category is already exported, but not imported explicitly when creating a subcategory since we
 176  *     cannot import the parent category to deal with the fact that the parent may be in application space, not DLL
 177  *     space.
 178  */
 179
 180 /* Build the DLL */
 181 #if defined(DLL_EXPORT)
 182 #  define XBT_PUBLIC            __declspec(dllexport)
 183 #  define XBT_EXPORT_NO_IMPORT  __declspec(dllexport)
 184 #  define XBT_IMPORT_NO_EXPORT
 185 #  define XBT_PUBLIC_DATA       extern __declspec(dllexport)
 186 #  define XBT_PRIVATE
 187
 188 /* Link against the DLL */
 189 #elif (defined(_WIN32) && !defined(DLL_EXPORT))
 190 #  define XBT_PUBLIC            __declspec(dllimport)
 191 #  define XBT_EXPORT_NO_IMPORT
 192 #  define XBT_IMPORT_NO_EXPORT  __declspec(dllimport)
 193 #  define XBT_PUBLIC_DATA       extern __declspec(dllimport)
 194 #  define XBT_PRIVATE
 195
 196 #elif defined(__ELF__)
 197 #  define XBT_PUBLIC            __attribute__((visibility("default")))
 198 #  define XBT_EXPORT_NO_IMPORT  __attribute__((visibility("default")))
 199 #  define XBT_IMPORT_NO_EXPORT  __attribute__((visibility("default")))
 200 #  define XBT_PUBLIC_DATA       extern __attribute__((visibility("default")))
 201 #  define XBT_PRIVATE           __attribute__((visibility("hidden")))
 202
 203 #else
 204 #  define XBT_PUBLIC            /* public */
 205 #  define XBT_EXPORT_NO_IMPORT
 206 #  define XBT_IMPORT_NO_EXPORT
 207 #  define XBT_PUBLIC_DATA       extern
 208 #  define XBT_PRIVATE           /** @private */
 209
 210 #endif
 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