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 #include "simgrid_config.h"
  13
  14 /* Define _GNU_SOURCE for getline, isfinite, etc. */
  15 #ifndef _GNU_SOURCE
  16   #define _GNU_SOURCE
  17 #endif
  18
  19 /* Attributes are only in recent versions of GCC */
  20 #if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ > 4))
  21
  22 /* On MinGW, stdio.h defines __MINGW_PRINTF_FORMAT and __MINGW_SCANF_FORMAT
  23    which are the suitable format style (either gnu_printf or ms_printf)
  24    depending on which version is available (__USE_MINGW_ANSI_STDIO): */
  25 #ifdef __MINGW32__
  26   #include <stdio.h>
  27 #endif
  28
  29 #if defined(__MINGW32__) && defined(__MINGW_PRINTF_FORMAT)
  30   # define XBT_ATTRIB_PRINTF( format_idx, arg_idx )    \
  31      __attribute__((__format__ (__MINGW_PRINTF_FORMAT, format_idx, arg_idx)))
  32 #else
  33   # define XBT_ATTRIB_PRINTF( format_idx, arg_idx )    \
  34      __attribute__((__format__ (__printf__, format_idx, arg_idx)))
  35 #endif
  36
  37 #if defined(__MINGW32__) && defined(__MINGW_SCANF_FORMAT)
  38   # define XBT_ATTRIB_SCANF( format_idx, arg_idx )     \
  39          __attribute__((__MINGW_SCANF_FORMAT (__scanf__, format_idx, arg_idx)))
  40 #else
  41   # define XBT_ATTRIB_SCANF( format_idx, arg_idx )     \
  42          __attribute__((__format__ (__scanf__, format_idx, arg_idx)))
  43 #endif
  44
  45 # define XBT_ATTRIB_NORETURN __attribute__((__noreturn__))
  46 # define XBT_ATTRIB_UNUSED  __attribute__((__unused__))
  47
  48 /* Constructor priorities exist since gcc 4.3.  Apparently, they are however not
  49  * supported on Macs. */
  50 # if (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 3)) && !defined(__APPLE__)
  51 #  define _XBT_GNUC_CONSTRUCTOR(prio) __attribute__((__constructor__ (prio)))
  52 #  define _XBT_GNUC_DESTRUCTOR(prio) __attribute__((__destructor__ (prio)))
  53 # else
  54 #  define _XBT_GNUC_CONSTRUCTOR(prio) __attribute__((__constructor__))
  55 #  define _XBT_GNUC_DESTRUCTOR(prio) __attribute__((__destructor__))
  56 # endif
  57 # undef _XBT_NEED_INIT_PRAGMA
  58
  59 #elif defined(_MSC_VER) /* Microsoft Visual Thing */
  60 # define XBT_ATTRIB_PRINTF( format_idx, arg_idx )
  61 # define XBT_ATTRIB_SCANF( format_idx, arg_idx )
  62 # define XBT_ATTRIB_NORETURN __declspec(noreturn)
  63 # define XBT_ATTRIB_UNUSED
  64 # define _XBT_GNUC_CONSTRUCTOR(prio)
  65 # define _XBT_GNUC_DESTRUCTOR(prio)
  66 # define  _XBT_NEED_INIT_PRAGMA 1
  67 #else
  68 # define XBT_ATTRIB_PRINTF( format_idx, arg_idx )
  69 # define XBT_ATTRIB_SCANF( format_idx, arg_idx )
  70 # define XBT_ATTRIB_NORETURN
  71 # define XBT_ATTRIB_UNUSED
  72 # define _XBT_GNUC_CONSTRUCTOR(prio)
  73 # define _XBT_GNUC_DESTRUCTOR(prio)
  74 # define  _XBT_NEED_INIT_PRAGMA 1
  75
  76 #endif                          /* gcc or MSVC else */
  77
  78 /* inline and __FUNCTION__ are only in GCC when -ansi is off */
  79
  80 #if defined(__GNUC__) && ! defined(__STRICT_ANSI__)
  81 # define _XBT_FUNCTION __FUNCTION__
  82 #elif (defined(__STDC__) && defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L)
  83 # define _XBT_FUNCTION __func__ /* ISO-C99 compliant */
  84 #else
  85 # define _XBT_FUNCTION "function"
  86 #endif
  87
  88 #ifdef DOXYGEN
  89 #  define XBT_INLINE
  90 #else
  91 #  ifndef __cplusplus
  92 #    if defined(__GNUC__) && ! defined(__STRICT_ANSI__)
  93 #        define XBT_INLINE inline
  94 #    elif (defined(__STDC__) && defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L)
  95 #        define XBT_INLINE inline
  96 #    else
  97 #        define XBT_INLINE
  98 #    endif
  99 #  else
 100 #     if defined (_MSC_VER)
 101 #       define XBT_INLINE __inline
 102 #     else
 103 #       define XBT_INLINE  inline
 104 #     endif
 105 #  endif /* __cplusplus */
 106 #endif
 107
 108 #if defined(__GNUC__)
 109 #   define XBT_ALWAYS_INLINE inline __attribute__ ((always_inline))
 110 #else
 111 #   define XBT_ALWAYS_INLINE XBT_INLINE
 112 #endif
 113
 114 #if defined(__GNUC__)
 115 #   define XBT_THREAD_LOCAL __thread
 116 #elif defined(_MSC_VER)
 117 #   define XBT_THREAD_LOCAL __declspec(thread)
 118 #else
 119 #   define XBT_THREAD_LOCAL No thread local on this architecture
 120 #endif
 121
 122 /* improvable on gcc (by evaluating arguments only once), but wouldn't be portable */
 123 #ifdef MIN
 124 # undef MIN
 125 #endif
 126 #define MIN(a,b) ((a)<(b)?(a):(b))
 127
 128 #ifdef MAX
 129 # undef MAX
 130 #endif
 131 #define MAX(a,b) ((a)>(b)?(a):(b))
 132
 133 /*
 134  * Expands to `one' if there is only one argument for the variadic part.
 135  * Otherwise, expands to `more'.
 136  * Works with up to 63 arguments, which is the maximum mandated by the C99 standard.
 137  */
 138 #define _XBT_IF_ONE_ARG(one, more, ...)                                 \
 139     _XBT_IF_ONE_ARG_(__VA_ARGS__,                                       \
 140                      more, more, more, more, more, more, more, more,    \
 141                      more, more, more, more, more, more, more, more,    \
 142                      more, more, more, more, more, more, more, more,    \
 143                      more, more, more, more, more, more, more, more,    \
 144                      more, more, more, more, more, more, more, more,    \
 145                      more, more, more, more, more, more, more, more,    \
 146                      more, more, more, more, more, more, more, more,    \
 147                      more, more, more, more, more, more, more, one)
 148 #define _XBT_IF_ONE_ARG_(a64, a63, a62, a61, a60, a59, a58, a57,        \
 149                          a56, a55, a54, a53, a52, a51, a50, a49,        \
 150                          a48, a47, a46, a45, a44, a43, a42, a41,        \
 151                          a40, a39, a38, a37, a36, a35, a34, a33,        \
 152                          a32, a31, a30, a29, a28, a27, a26, a25,        \
 153                          a24, a23, a22, a21, a20, a19, a18, a17,        \
 154                          a16, a15, a14, a13, a12, a11, a10, a9,         \
 155                          a8, a7, a6, a5, a4, a3, a2, a1, N, ...) N
 156
 157 /*
 158  * Function calling convention (not used for now)
 159  * http://unixwiz.net/techtips/win32-callconv.html <-- good documentation
 160  */
 161
 162 #ifdef _XBT_WIN32
 163 #  ifndef _XBT_CALL
 164 #    define _XBT_CALL __cdecl
 165 #   endif
 166 #else
 167 #  define _XBT_CALL
 168 #endif
 169
 170 /* Handle import/export stuff
 171  *
 172  * Rational of XBT_PUBLIC:
 173  *   * This is for library symbols visible from the application-land.
 174  *     Basically, any symbols defined in the include/directory must be like this (plus some other globals).
 175  *
 176  *     UNIX coders should just think of it as a special way to say "extern".
 177  *
 178  *   * If you build the DLL, define the DLL_EXPORT symbol so that all symbols actually get exported by this file.
 179  *
 180  *   * If you link your application against the DLL or if you do a UNIX build, don't do anything special. This file
 181  *     will do the right thing for you by default.
 182  *
 183  * Rational of XBT_EXPORT_NO_IMPORT: (windows-only)
 184  *   * Symbols which must be exported in the DLL, but not imported from it.
 185  *
 186  *   * This is obviously useful for initialized globals (which cannot be  extern or similar).
 187  *   * This is also used in the log mechanism where a macro creates the variable automatically. When the macro is
 188  *     called from within SimGrid, the symbol must be exported, but when called  from within the client code, it must
 189  *     not try to retrieve the symbol from the DLL since it's not in there.
 190  *
 191  * Rational of XBT_IMPORT_NO_EXPORT: (windows-only)
 192  *   * Symbols which must be imported from the DLL, but not explicitly  exported from it.
 193  *
 194  *   * The root log category is already exported, but not imported explicitly when creating a subcategory since we
 195  *     cannot import the parent category to deal with the fact that the parent may be in application space, not DLL
 196  *     space.
 197  */
 198
 199 /* Build the DLL */
 200 #if defined(DLL_EXPORT)
 201 #  define XBT_PUBLIC(type)            __declspec(dllexport) type
 202 #  define XBT_EXPORT_NO_IMPORT(type)  __declspec(dllexport) type
 203 #  define XBT_IMPORT_NO_EXPORT(type)  type
 204 #  define XBT_PUBLIC_DATA(type)       extern __declspec(dllexport) type
 205 #  define XBT_PUBLIC_CLASS            class __declspec(dllexport)
 206 #  define XBT_PRIVATE
 207
 208 /* Link against the DLL */
 209 #elif (defined(_XBT_WIN32) && !defined(DLL_EXPORT))
 210 #  define XBT_PUBLIC(type)            __declspec(dllimport) type
 211 #  define XBT_EXPORT_NO_IMPORT(type)  type
 212 #  define XBT_IMPORT_NO_EXPORT(type)  __declspec(dllimport) type
 213 #  define XBT_PUBLIC_DATA(type)       extern __declspec(dllimport) type
 214 #  define XBT_PUBLIC_CLASS            class __declspec(dllimport)
 215 #  define XBT_PRIVATE
 216
 217 #elif defined(__ELF__)
 218 #  define XBT_PUBLIC(type)            __attribute__((visibility("default"))) type
 219 #  define XBT_EXPORT_NO_IMPORT(type)  __attribute__((visibility("default"))) type
 220 #  define XBT_IMPORT_NO_EXPORT(type)  __attribute__((visibility("default"))) type
 221 #  define XBT_PUBLIC_DATA(type)       extern __attribute__((visibility("default"))) type
 222 #  define XBT_PUBLIC_CLASS            class __attribute__((visibility("default")))
 223 #  define XBT_PRIVATE                 __attribute__((visibility("hidden")))
 224
 225 #else
 226 #  define XBT_PUBLIC(type)            type
 227 #  define XBT_EXPORT_NO_IMPORT(type)  type
 228 #  define XBT_IMPORT_NO_EXPORT(type)  type
 229 #  define XBT_PUBLIC_DATA(type)       extern type
 230 #  define XBT_PUBLIC_CLASS            class
 231 #  define XBT_PRIVATE
 232
 233 #endif
 234
 235 #ifdef _MSC_VER /* MSVC has no ssize_t, and I fail to use the SSIZE_T declared in BaseTsd.h */
 236   #if defined(_WIN64)
 237     typedef __int64 ssize_t;
 238   #else
 239     typedef long ssize_t;
 240   #endif
 241
 242 /* Microsoft wants to improve the code quality blah blah blah */
 243 /* See: https://msdn.microsoft.com/en-us/library/8ef0s5kh.aspx */
 244   /* warning C4996: '_strdup': The POSIX name for this item is deprecated. Instead, use the ISO C and C++ conformant name: _strdup. */
 245   #define _CRT_NONSTDC_NO_WARNINGS
 246   /* warning C4996: 'fopen': This function or variable may be unsafe. Consider using fopen_s instead. */
 247   #define _CRT_SECURE_NO_WARNINGS
 248 #endif
 249
 250 #if !defined (max) && !defined(__cplusplus)
 251 #  define max(a,b)  (((a) > (b)) ? (a) : (b))
 252 #endif
 253 #if !defined (min) && !defined(__cplusplus)
 254 #  define min(a,b)  (((a) < (b)) ? (a) : (b))
 255 #endif
 256
 257 #define TRUE  1
 258 #define FALSE 0
 259
 260 /*! C++ users need love */
 261 #ifndef SG_BEGIN_DECL
 262 # ifdef __cplusplus
 263 #  define SG_BEGIN_DECL() extern "C" {
 264 # else
 265 #  define SG_BEGIN_DECL()
 266 # endif
 267 #endif
 268
 269 #ifndef SG_END_DECL
 270 # ifdef __cplusplus
 271 #  define SG_END_DECL() }
 272 # else
 273 #  define SG_END_DECL()
 274 # endif
 275 #endif
 276 /* End of cruft for C++ */
 277
 278 #endif