include/xbt/base.h

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