1 /* xbt.h - Public interface to the xbt (simgrid's toolbox) */
3 /* Copyright (c) 2004-2019. 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 #if defined(__cplusplus)
49 #if __cplusplus >= 201103L
50 #define XBT_ATTRIB_NORETURN [[noreturn]]
52 #if __cplusplus >= 201703L
53 #define XBT_ATTRIB_UNUSED [[maybe_unused]]
55 #if __cplusplus >= 201402L
56 #define XBT_ATTRIB_DEPRECATED(mesg) [[deprecated(mesg)]]
58 #elif defined(__STDC_VERSION__)
59 #if __STDC_VERSION__ >= 201112L
60 #define XBT_ATTRIB_NORETURN _Noreturn
64 #ifndef XBT_ATTRIB_NORETURN
65 #define XBT_ATTRIB_NORETURN __attribute__((noreturn))
67 #ifndef XBT_ATTRIB_UNUSED
68 #define XBT_ATTRIB_UNUSED __attribute__((unused))
70 #ifndef XBT_ATTRIB_DEPRECATED
71 #define XBT_ATTRIB_DEPRECATED(mesg) __attribute__((deprecated(mesg)))
74 #define XBT_ATTRIB_DEPRECATED_v323(mesg) \
75 XBT_ATTRIB_DEPRECATED(mesg " (this compatibility wrapper will be dropped in v3.23)") /* Will be dropped in v3.23 */
76 #define XBT_ATTRIB_DEPRECATED_v324(mesg) \
77 XBT_ATTRIB_DEPRECATED(mesg " (this compatibility wrapper will be dropped in v3.24)") /* Will be dropped in v3.24 */
78 #define XBT_ATTRIB_DEPRECATED_v325(mesg) \
79 XBT_ATTRIB_DEPRECATED(mesg " (this compatibility wrapper will be dropped in v3.25)") /* Will be dropped in v3.25 */
80 #define XBT_ATTRIB_DEPRECATED_v326(mesg) \
81 XBT_ATTRIB_DEPRECATED(mesg " (this compatibility wrapper will be dropped in v3.26)") /* Will be dropped in v3.26 */
83 #if !defined(__APPLE__)
84 # define XBT_ATTRIB_CONSTRUCTOR(prio) __attribute__((__constructor__(prio)))
85 # define XBT_ATTRIB_DESTRUCTOR(prio) __attribute__((__destructor__(prio)))
87 # define XBT_ATTRIB_CONSTRUCTOR(prio) __attribute__((__constructor__))
88 # define XBT_ATTRIB_DESTRUCTOR(prio) __attribute__((__destructor__))
91 #ifndef XBT_ALWAYS_INLINE /* defined also in libsosp */
92 # if defined(__GNUC__)
93 # define XBT_ALWAYS_INLINE inline __attribute__ ((always_inline))
95 # define XBT_ALWAYS_INLINE inline
100 * Expands to `one' if there is only one argument for the variadic part.
101 * Otherwise, expands to `more'.
102 * Works with up to 63 arguments, which is the maximum mandated by the C99 standard.
104 #define _XBT_IF_ONE_ARG(one, more, ...) \
105 _XBT_IF_ONE_ARG_(__VA_ARGS__, \
106 more, more, more, more, more, more, more, more, \
107 more, more, more, more, more, more, more, more, \
108 more, more, more, more, more, more, more, more, \
109 more, more, more, more, more, more, more, more, \
110 more, more, more, more, more, more, more, more, \
111 more, more, more, more, more, more, more, more, \
112 more, more, more, more, more, more, more, more, \
113 more, more, more, more, more, more, more, one)
114 #define _XBT_IF_ONE_ARG_(a64, a63, a62, a61, a60, a59, a58, a57, \
115 a56, a55, a54, a53, a52, a51, a50, a49, \
116 a48, a47, a46, a45, a44, a43, a42, a41, \
117 a40, a39, a38, a37, a36, a35, a34, a33, \
118 a32, a31, a30, a29, a28, a27, a26, a25, \
119 a24, a23, a22, a21, a20, a19, a18, a17, \
120 a16, a15, a14, a13, a12, a11, a10, a9, \
121 a8, a7, a6, a5, a4, a3, a2, a1, N, ...) N
123 /* Handle import/export stuff
125 * Rationale of XBT_PUBLIC:
126 * * This is for library symbols visible from the application-land.
127 * Basically, any symbols defined in the include/directory must be like this (plus some other globals).
129 * UNIX coders should just think of it as a special way to say "extern".
131 * * If you build the DLL, define the DLL_EXPORT symbol so that all symbols actually get exported by this file.
133 * * If you link your application against the DLL or if you do a UNIX build, don't do anything special. This file
134 * will do the right thing for you by default.
136 * Rationale of XBT_EXPORT_NO_IMPORT: (windows-only)
137 * * Symbols which must be exported in the DLL, but not imported from it.
139 * * This is obviously useful for initialized globals (which cannot be extern or similar).
140 * * This is also used in the log mechanism where a macro creates the variable automatically. When the macro is
141 * called from within SimGrid, the symbol must be exported, but when called from within the client code, it must
142 * not try to retrieve the symbol from the DLL since it's not in there.
144 * Rationale of XBT_IMPORT_NO_EXPORT: (windows-only)
145 * * Symbols which must be imported from the DLL, but not explicitly exported from it.
147 * * The root log category is already exported, but not imported explicitly when creating a subcategory since we
148 * cannot import the parent category to deal with the fact that the parent may be in application space, not DLL
153 #if defined(DLL_EXPORT)
154 # define XBT_PUBLIC __declspec(dllexport)
155 # define XBT_EXPORT_NO_IMPORT __declspec(dllexport)
156 # define XBT_IMPORT_NO_EXPORT
157 # define XBT_PUBLIC_DATA extern __declspec(dllexport)
160 /* Link against the DLL */
161 #elif (defined(_WIN32) && !defined(DLL_EXPORT))
162 # define XBT_PUBLIC __declspec(dllimport)
163 # define XBT_EXPORT_NO_IMPORT
164 # define XBT_IMPORT_NO_EXPORT __declspec(dllimport)
165 # define XBT_PUBLIC_DATA extern __declspec(dllimport)
168 #elif defined(__ELF__)
169 # define XBT_PUBLIC __attribute__((visibility("default")))
170 # define XBT_EXPORT_NO_IMPORT __attribute__((visibility("default")))
171 # define XBT_IMPORT_NO_EXPORT __attribute__((visibility("default")))
172 # define XBT_PUBLIC_DATA extern __attribute__((visibility("default")))
173 # define XBT_PRIVATE __attribute__((visibility("hidden")))
176 # define XBT_PUBLIC /* public */
177 # define XBT_EXPORT_NO_IMPORT
178 # define XBT_IMPORT_NO_EXPORT
179 # define XBT_PUBLIC_DATA extern
180 # define XBT_PRIVATE /** @private */
184 /* C++ users need love */
185 #ifndef SG_BEGIN_DECL
187 # define SG_BEGIN_DECL() extern "C" {
189 # define SG_BEGIN_DECL()
195 # define SG_END_DECL() }
197 # define SG_END_DECL()
200 /* End of cruft for C++ */