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) __attribute__((__MINGW_SCANF_FORMAT(__scanf__, (format_idx), (arg_idx))))
41 #define XBT_ATTRIB_PRINTF(format_idx, arg_idx) __attribute__((__format__(__printf__, (format_idx), (arg_idx))))
42 #define XBT_ATTRIB_SCANF(format_idx, arg_idx) __attribute__((__format__(__scanf__, (format_idx), (arg_idx))))
45 #if defined(__cplusplus)
46 #if __cplusplus >= 201103L
47 #define XBT_ATTRIB_NORETURN [[noreturn]]
49 #if __cplusplus >= 201703L
50 #define XBT_ATTRIB_UNUSED [[maybe_unused]]
52 #if __cplusplus >= 201402L
53 #define XBT_ATTRIB_DEPRECATED(mesg) [[deprecated(mesg)]]
55 #elif defined(__STDC_VERSION__)
56 #if __STDC_VERSION__ >= 201112L
57 #define XBT_ATTRIB_NORETURN _Noreturn
61 #ifndef XBT_ATTRIB_NORETURN
62 #define XBT_ATTRIB_NORETURN __attribute__((noreturn))
64 #ifndef XBT_ATTRIB_UNUSED
65 #define XBT_ATTRIB_UNUSED __attribute__((unused))
67 #ifndef XBT_ATTRIB_DEPRECATED
68 #define XBT_ATTRIB_DEPRECATED(mesg) __attribute__((deprecated(mesg)))
71 #define XBT_ATTRIB_DEPRECATED_v328(mesg) \
72 XBT_ATTRIB_DEPRECATED(mesg " (this compatibility wrapper will be dropped in v3.28)")
73 #define XBT_ATTRIB_DEPRECATED_v329(mesg) \
74 XBT_ATTRIB_DEPRECATED(mesg " (this compatibility wrapper will be dropped in v3.29)")
76 #if !defined(__APPLE__)
77 # define XBT_ATTRIB_CONSTRUCTOR(prio) __attribute__((__constructor__(prio)))
78 # define XBT_ATTRIB_DESTRUCTOR(prio) __attribute__((__destructor__(prio)))
80 # define XBT_ATTRIB_CONSTRUCTOR(prio) __attribute__((__constructor__))
81 # define XBT_ATTRIB_DESTRUCTOR(prio) __attribute__((__destructor__))
84 #ifndef XBT_ALWAYS_INLINE /* defined also in libsosp */
85 # if defined(__GNUC__)
86 # define XBT_ALWAYS_INLINE inline __attribute__ ((always_inline))
88 # define XBT_ALWAYS_INLINE inline
92 /* Stringify argument. */
93 #define _XBT_STRINGIFY(a) #a
95 /* Concatenate arguments. _XBT_CONCAT2 adds a level of indirection over _XBT_CONCAT. */
96 #define _XBT_CONCAT(a, b) a##b
97 #define _XBT_CONCAT2(a, b) _XBT_CONCAT(a, b)
98 #define _XBT_CONCAT3(a, b, c) _XBT_CONCAT2(_XBT_CONCAT(a, b), c)
99 #define _XBT_CONCAT4(a, b, c, d) _XBT_CONCAT2(_XBT_CONCAT3(a, b, c), d)
102 * Expands to `one' if there is only one argument for the variadic part.
103 * Otherwise, expands to `more'.
104 * Works with up to 63 arguments, which is the maximum mandated by the C99 standard.
106 #define _XBT_IF_ONE_ARG(one, more, ...) \
107 _XBT_IF_ONE_ARG_(__VA_ARGS__, \
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, more, \
114 more, more, more, more, more, more, more, more, \
115 more, more, more, more, more, more, more, one)
116 #define _XBT_IF_ONE_ARG_(a64, a63, a62, a61, a60, a59, a58, a57, \
117 a56, a55, a54, a53, a52, a51, a50, a49, \
118 a48, a47, a46, a45, a44, a43, a42, a41, \
119 a40, a39, a38, a37, a36, a35, a34, a33, \
120 a32, a31, a30, a29, a28, a27, a26, a25, \
121 a24, a23, a22, a21, a20, a19, a18, a17, \
122 a16, a15, a14, a13, a12, a11, a10, a9, \
123 a8, a7, a6, a5, a4, a3, a2, a1, N, ...) N
125 /* Handle import/export stuff
127 * Rationale of XBT_PUBLIC:
128 * * This is for library symbols visible from the application-land.
129 * Basically, any symbols defined in the include/directory must be like this (plus some other globals).
131 * UNIX coders should just think of it as a special way to say "extern".
133 * * If you build the DLL, define the DLL_EXPORT symbol so that all symbols actually get exported by this file.
135 * * If you link your application against the DLL or if you do a UNIX build, don't do anything special. This file
136 * will do the right thing for you by default.
138 * Rationale of XBT_EXPORT_NO_IMPORT: (windows-only)
139 * * Symbols which must be exported in the DLL, but not imported from it.
141 * * This is obviously useful for initialized globals (which cannot be extern or similar).
142 * * This is also used in the log mechanism where a macro creates the variable automatically. When the macro is
143 * called from within SimGrid, the symbol must be exported, but when called from within the client code, it must
144 * not try to retrieve the symbol from the DLL since it's not in there.
146 * Rationale of XBT_IMPORT_NO_EXPORT: (windows-only)
147 * * Symbols which must be imported from the DLL, but not explicitly exported from it.
149 * * The root log category is already exported, but not imported explicitly when creating a subcategory since we
150 * cannot import the parent category to deal with the fact that the parent may be in application space, not DLL
155 #if defined(DLL_EXPORT)
156 # define XBT_PUBLIC __declspec(dllexport)
157 # define XBT_EXPORT_NO_IMPORT __declspec(dllexport)
158 # define XBT_IMPORT_NO_EXPORT
159 # define XBT_PUBLIC_DATA extern __declspec(dllexport)
162 /* Link against the DLL */
163 #elif (defined(_WIN32) && !defined(DLL_EXPORT))
164 # define XBT_PUBLIC __declspec(dllimport)
165 # define XBT_EXPORT_NO_IMPORT
166 # define XBT_IMPORT_NO_EXPORT __declspec(dllimport)
167 # define XBT_PUBLIC_DATA extern __declspec(dllimport)
170 #elif defined(__ELF__)
171 # define XBT_PUBLIC __attribute__((visibility("default")))
172 # define XBT_EXPORT_NO_IMPORT __attribute__((visibility("default")))
173 # define XBT_IMPORT_NO_EXPORT __attribute__((visibility("default")))
174 # define XBT_PUBLIC_DATA extern __attribute__((visibility("default")))
175 # define XBT_PRIVATE __attribute__((visibility("hidden")))
178 # define XBT_PUBLIC /* public */
179 # define XBT_EXPORT_NO_IMPORT
180 # define XBT_IMPORT_NO_EXPORT
181 # define XBT_PUBLIC_DATA extern
182 # define XBT_PRIVATE /** @private */
186 /* C++ users need love */
187 #ifndef SG_BEGIN_DECL
189 # define SG_BEGIN_DECL() extern "C" {
191 # define SG_BEGIN_DECL()
197 # define SG_END_DECL() }
199 # define SG_END_DECL()
202 /* End of cruft for C++ */