include/xbt/base.h

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