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