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_v328(mesg)                                                                               \
  57   XBT_ATTRIB_DEPRECATED(mesg " (this compatibility wrapper will be dropped after v3.27)")
  58 #define XBT_ATTRIB_DEPRECATED_v329(mesg)                                                                               \
  59   XBT_ATTRIB_DEPRECATED(mesg " (this compatibility wrapper will be dropped after v3.28)")
  60 #define XBT_ATTRIB_DEPRECATED_v330(mesg)                                                                               \
  61   XBT_ATTRIB_DEPRECATED(mesg " (this compatibility wrapper will be dropped after v3.29)")
  62 #define XBT_ATTRIB_DEPRECATED_v331(mesg)                                                                               \
  63   XBT_ATTRIB_DEPRECATED(mesg " (this compatibility wrapper will be dropped after v3.30)")
  64
  65 #if !defined(__APPLE__)
  66 #  define XBT_ATTRIB_CONSTRUCTOR(prio) __attribute__((__constructor__(prio)))
  67 #  define XBT_ATTRIB_DESTRUCTOR(prio) __attribute__((__destructor__(prio)))
  68 #else
  69 #  define XBT_ATTRIB_CONSTRUCTOR(prio) __attribute__((__constructor__))
  70 #  define XBT_ATTRIB_DESTRUCTOR(prio) __attribute__((__destructor__))
  71 #endif
  72
  73 #ifndef XBT_ALWAYS_INLINE /* defined also in libsosp */
  74 #  if defined(__GNUC__)
  75 #    define XBT_ALWAYS_INLINE inline __attribute__ ((always_inline))
  76 #  else
  77 #    define XBT_ALWAYS_INLINE inline
  78 #  endif
  79 #endif
  80
  81 /* Stringify argument. */
  82 #define _XBT_STRINGIFY(a) #a
  83
  84 /* Concatenate arguments. _XBT_CONCAT2 adds a level of indirection over _XBT_CONCAT. */
  85 #define _XBT_CONCAT(a, b) a##b
  86 #define _XBT_CONCAT2(a, b) _XBT_CONCAT(a, b)
  87 #define _XBT_CONCAT3(a, b, c) _XBT_CONCAT2(_XBT_CONCAT2(a, b), c)
  88 #define _XBT_CONCAT4(a, b, c, d) _XBT_CONCAT2(_XBT_CONCAT3(a, b, c), d)
  89
  90 /*
  91  * Expands to `one' if there is only one argument for the variadic part.
  92  * Otherwise, expands to `more'.
  93  * Works with up to 63 arguments, which is the maximum mandated by the C99 standard.
  94  */
  95 #define _XBT_IF_ONE_ARG(one, more, ...)                                 \
  96     _XBT_IF_ONE_ARG_(__VA_ARGS__,                                       \
  97                      more, more, more, more, more, more, more, more,    \
  98                      more, more, more, more, more, more, more, more,    \
  99                      more, more, more, more, more, more, more, more,    \
 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, one)
 105 #define _XBT_IF_ONE_ARG_(a64, a63, a62, a61, a60, a59, a58, a57,        \
 106                          a56, a55, a54, a53, a52, a51, a50, a49,        \
 107                          a48, a47, a46, a45, a44, a43, a42, a41,        \
 108                          a40, a39, a38, a37, a36, a35, a34, a33,        \
 109                          a32, a31, a30, a29, a28, a27, a26, a25,        \
 110                          a24, a23, a22, a21, a20, a19, a18, a17,        \
 111                          a16, a15, a14, a13, a12, a11, a10, a9,         \
 112                          a8, a7, a6, a5, a4, a3, a2, a1, N, ...) N
 113
 114 /* Handle import/export stuff
 115  *
 116  * Rationale of XBT_PUBLIC:
 117  *   * This is for library symbols visible from the application-land.
 118  *     Basically, any symbols defined in the include/directory must be like this (plus some other globals).
 119  *
 120  *     UNIX coders should just think of it as a special way to say "extern".
 121  *
 122  *   * If you build the DLL, define the DLL_EXPORT symbol so that all symbols actually get exported by this file.
 123  *
 124  *   * If you link your application against the DLL or if you do a UNIX build, don't do anything special. This file
 125  *     will do the right thing for you by default.
 126  *
 127  * Rationale of XBT_EXPORT_NO_IMPORT: (windows-only)
 128  *   * Symbols which must be exported in the DLL, but not imported from it.
 129  *
 130  *   * This is obviously useful for initialized globals (which cannot be  extern or similar).
 131  *   * This is also used in the log mechanism where a macro creates the variable automatically. When the macro is
 132  *     called from within SimGrid, the symbol must be exported, but when called  from within the client code, it must
 133  *     not try to retrieve the symbol from the DLL since it's not in there.
 134  *
 135  * Rationale of XBT_IMPORT_NO_EXPORT: (windows-only)
 136  *   * Symbols which must be imported from the DLL, but not explicitly  exported from it.
 137  *
 138  *   * The root log category is already exported, but not imported explicitly when creating a subcategory since we
 139  *     cannot import the parent category to deal with the fact that the parent may be in application space, not DLL
 140  *     space.
 141  */
 142
 143 /* Build the DLL */
 144 #if defined(DLL_EXPORT)
 145 #  define XBT_PUBLIC            __declspec(dllexport)
 146 #  define XBT_EXPORT_NO_IMPORT  __declspec(dllexport)
 147 #  define XBT_IMPORT_NO_EXPORT
 148 #  define XBT_PUBLIC_DATA       extern __declspec(dllexport)
 149 #  define XBT_PRIVATE
 150
 151 /* Link against the DLL */
 152 #elif (defined(_WIN32) && !defined(DLL_EXPORT))
 153 #  define XBT_PUBLIC            __declspec(dllimport)
 154 #  define XBT_EXPORT_NO_IMPORT
 155 #  define XBT_IMPORT_NO_EXPORT  __declspec(dllimport)
 156 #  define XBT_PUBLIC_DATA       extern __declspec(dllimport)
 157 #  define XBT_PRIVATE
 158
 159 #elif defined(__ELF__)
 160 #  define XBT_PUBLIC            __attribute__((visibility("default")))
 161 #  define XBT_EXPORT_NO_IMPORT  __attribute__((visibility("default")))
 162 #  define XBT_IMPORT_NO_EXPORT  __attribute__((visibility("default")))
 163 #  define XBT_PUBLIC_DATA       extern __attribute__((visibility("default")))
 164 #  define XBT_PRIVATE           __attribute__((visibility("hidden")))
 165
 166 #else
 167 #  define XBT_PUBLIC            /* public */
 168 #  define XBT_EXPORT_NO_IMPORT
 169 #  define XBT_IMPORT_NO_EXPORT
 170 #  define XBT_PUBLIC_DATA       extern
 171 #  define XBT_PRIVATE           /** @private */
 172
 173 #endif
 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