1 /* xbt.h - Public interface to the xbt (simgrid's toolbox) */
3 /* Copyright (c) 2004-2017. The SimGrid Team. All rights reserved. */
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. */
11 /* Define _GNU_SOURCE for getline, isfinite, etc. */
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()
22 # define XBT_UNREACHABLE() abort()
24 #elif (__GNUC__ > 4) || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5)
25 # define XBT_UNREACHABLE() __builtin_unreachable()
28 # define XBT_UNREACHABLE() abort()
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): */
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)))
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)))
48 #define XBT_ATTRIB_NORETURN __attribute__((noreturn))
49 #define XBT_ATTRIB_UNUSED __attribute__((unused))
50 #define XBT_ATTRIB_DEPRECATED_v319(msg) __attribute__((deprecated(msg))) /* Will be dropped in v3.19 */
51 #define XBT_ATTRIB_DEPRECATED_v320(msg) __attribute__((deprecated(msg))) /* Will be dropped in v3.20 */
52 #define XBT_ATTRIB_DEPRECATED_v321(msg) __attribute__((deprecated(msg))) /* Will be dropped in v3.21 */
54 /* Constructor priorities exist since gcc 4.3. Apparently, they are however not
55 * supported on Macs. */
56 #if (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 3)) && !defined(__APPLE__)
57 # define _XBT_GNUC_CONSTRUCTOR(prio) __attribute__((__constructor__ (prio)))
58 # define _XBT_GNUC_DESTRUCTOR(prio) __attribute__((__destructor__ (prio)))
60 # define _XBT_GNUC_CONSTRUCTOR(prio) __attribute__((__constructor__))
61 # define _XBT_GNUC_DESTRUCTOR(prio) __attribute__((__destructor__))
65 # define XBT_ALWAYS_INLINE inline __attribute__ ((always_inline))
67 # define XBT_ALWAYS_INLINE inline
71 # define XBT_THREAD_LOCAL __thread
73 # define XBT_THREAD_LOCAL No thread local on this architecture
76 /* improvable on gcc (by evaluating arguments only once), but wouldn't be portable */
80 #define MIN(a,b) ((a)<(b)?(a):(b))
85 #define MAX(a,b) ((a)>(b)?(a):(b))
88 * Expands to `one' if there is only one argument for the variadic part.
89 * Otherwise, expands to `more'.
90 * Works with up to 63 arguments, which is the maximum mandated by the C99 standard.
92 #define _XBT_IF_ONE_ARG(one, more, ...) \
93 _XBT_IF_ONE_ARG_(__VA_ARGS__, \
94 more, more, more, more, more, more, more, more, \
95 more, more, more, more, more, more, more, more, \
96 more, more, more, more, more, more, more, more, \
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, one)
102 #define _XBT_IF_ONE_ARG_(a64, a63, a62, a61, a60, a59, a58, a57, \
103 a56, a55, a54, a53, a52, a51, a50, a49, \
104 a48, a47, a46, a45, a44, a43, a42, a41, \
105 a40, a39, a38, a37, a36, a35, a34, a33, \
106 a32, a31, a30, a29, a28, a27, a26, a25, \
107 a24, a23, a22, a21, a20, a19, a18, a17, \
108 a16, a15, a14, a13, a12, a11, a10, a9, \
109 a8, a7, a6, a5, a4, a3, a2, a1, N, ...) N
111 /* Handle import/export stuff
113 * Rational of XBT_PUBLIC:
114 * * This is for library symbols visible from the application-land.
115 * Basically, any symbols defined in the include/directory must be like this (plus some other globals).
117 * UNIX coders should just think of it as a special way to say "extern".
119 * * If you build the DLL, define the DLL_EXPORT symbol so that all symbols actually get exported by this file.
121 * * If you link your application against the DLL or if you do a UNIX build, don't do anything special. This file
122 * will do the right thing for you by default.
124 * Rational of XBT_EXPORT_NO_IMPORT: (windows-only)
125 * * Symbols which must be exported in the DLL, but not imported from it.
127 * * This is obviously useful for initialized globals (which cannot be extern or similar).
128 * * This is also used in the log mechanism where a macro creates the variable automatically. When the macro is
129 * called from within SimGrid, the symbol must be exported, but when called from within the client code, it must
130 * not try to retrieve the symbol from the DLL since it's not in there.
132 * Rational of XBT_IMPORT_NO_EXPORT: (windows-only)
133 * * Symbols which must be imported from the DLL, but not explicitly exported from it.
135 * * The root log category is already exported, but not imported explicitly when creating a subcategory since we
136 * cannot import the parent category to deal with the fact that the parent may be in application space, not DLL
141 #if defined(DLL_EXPORT)
142 # define XBT_ATTRIB_PUBLIC __declspec(dllexport)
143 # define XBT_PUBLIC(type) __declspec(dllexport) type
144 # define XBT_EXPORT_NO_IMPORT(type) __declspec(dllexport) type
145 # define XBT_IMPORT_NO_EXPORT(type) type
146 # define XBT_PUBLIC_DATA(type) extern __declspec(dllexport) type
147 # define XBT_PUBLIC_CLASS class __declspec(dllexport)
150 /* Link against the DLL */
151 #elif (defined(_WIN32) && !defined(DLL_EXPORT))
152 # define XBT_ATTRIB_PUBLIC __declspec(dllimport)
153 # define XBT_PUBLIC(type) __declspec(dllimport) type
154 # define XBT_EXPORT_NO_IMPORT(type) type
155 # define XBT_IMPORT_NO_EXPORT(type) __declspec(dllimport) type
156 # define XBT_PUBLIC_DATA(type) extern __declspec(dllimport) type
157 # define XBT_PUBLIC_CLASS class __declspec(dllimport)
160 #elif defined(__ELF__)
161 # define XBT_ATTRIB_PUBLIC __attribute__((visibility("default")))
162 # define XBT_PUBLIC(type) __attribute__((visibility("default"))) type
163 # define XBT_EXPORT_NO_IMPORT(type) __attribute__((visibility("default"))) type
164 # define XBT_IMPORT_NO_EXPORT(type) __attribute__((visibility("default"))) type
165 # define XBT_PUBLIC_DATA(type) extern __attribute__((visibility("default"))) type
166 # define XBT_PUBLIC_CLASS class __attribute__((visibility("default")))
167 # define XBT_PRIVATE __attribute__((visibility("hidden")))
170 # define XBT_ATTRIB_PUBLIC /* public */
171 # define XBT_PUBLIC(type) type
172 # define XBT_EXPORT_NO_IMPORT(type) type
173 # define XBT_IMPORT_NO_EXPORT(type) type
174 # define XBT_PUBLIC_DATA(type) extern type
175 # define XBT_PUBLIC_CLASS class
176 # define XBT_PRIVATE /** @private */
183 /* C++ users need love */
184 #ifndef SG_BEGIN_DECL
186 # define SG_BEGIN_DECL() extern "C" {
188 # define SG_BEGIN_DECL()
194 # define SG_END_DECL() }
196 # define SG_END_DECL()
199 /* End of cruft for C++ */