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