1 /* xbt.h - Public interface to the xbt (SimGrid's toolbox) */
3 /* Copyright (c) 2004-2023. 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 #define XBT_ATTRIB_PRINTF(format_idx, arg_idx) __attribute__((__format__(__printf__, (format_idx), (arg_idx))))
17 #define XBT_ATTRIB_SCANF(format_idx, arg_idx) __attribute__((__format__(__scanf__, (format_idx), (arg_idx))))
19 #if defined(__cplusplus)
20 #if __cplusplus >= 201103L
21 #define XBT_ATTRIB_NORETURN [[noreturn]]
23 #if __cplusplus >= 201703L
24 #define XBT_ATTRIB_UNUSED [[maybe_unused]]
26 #if __cplusplus >= 201402L
27 #define XBT_ATTRIB_DEPRECATED(mesg) [[deprecated(mesg)]]
29 #elif defined(__STDC_VERSION__)
30 #if __STDC_VERSION__ >= 201112L
31 #define XBT_ATTRIB_NORETURN _Noreturn
35 #ifndef XBT_ATTRIB_NORETURN
36 #define XBT_ATTRIB_NORETURN __attribute__((noreturn))
38 #ifndef XBT_ATTRIB_UNUSED
39 #define XBT_ATTRIB_UNUSED __attribute__((unused))
41 #ifndef XBT_ATTRIB_DEPRECATED
42 #define XBT_ATTRIB_DEPRECATED(mesg) __attribute__((deprecated(mesg)))
45 #define XBT_ATTRIB_DEPRECATED_v336(mesg) \
46 XBT_ATTRIB_DEPRECATED(mesg " (this compatibility wrapper will be dropped after v3.35)")
47 #define XBT_ATTRIB_DEPRECATED_v338(mesg) \
48 XBT_ATTRIB_DEPRECATED(mesg " (this compatibility wrapper will be dropped after v3.37)")
49 #define XBT_ATTRIB_DEPRECATED_v339(mesg) \
50 XBT_ATTRIB_DEPRECATED(mesg " (this compatibility wrapper will be dropped after v3.38)")
52 /* Work around https://github.com/microsoft/vscode-cpptools/issues/4503 */
53 #ifdef __INTELLISENSE__
54 #pragma diag_suppress 1094
57 #if !defined(__APPLE__)
58 # define XBT_ATTRIB_CONSTRUCTOR(prio) __attribute__((__constructor__(prio)))
59 # define XBT_ATTRIB_DESTRUCTOR(prio) __attribute__((__destructor__(prio)))
61 # define XBT_ATTRIB_CONSTRUCTOR(prio) __attribute__((__constructor__))
62 # define XBT_ATTRIB_DESTRUCTOR(prio) __attribute__((__destructor__))
65 #define XBT_ATTRIB_NOINLINE __attribute__((noinline))
68 #define XBT_ALWAYS_INLINE inline __attribute__((always_inline))
70 #define XBT_ALWAYS_INLINE inline
73 /* Stringify argument. */
74 #define _XBT_STRINGIFY(a) #a
76 /* Concatenate arguments. _XBT_CONCAT2 adds a level of indirection over _XBT_CONCAT. */
77 #define _XBT_CONCAT(a, b) a##b
78 #define _XBT_CONCAT2(a, b) _XBT_CONCAT(a, b)
79 #define _XBT_CONCAT3(a, b, c) _XBT_CONCAT2(_XBT_CONCAT2(a, b), c)
80 #define _XBT_CONCAT4(a, b, c, d) _XBT_CONCAT2(_XBT_CONCAT3(a, b, c), d)
83 * Expands to `one' if there is only one argument for the variadic part.
84 * Otherwise, expands to `more'.
85 * Works with up to 63 arguments, which is the maximum mandated by the C99 standard.
87 #define _XBT_IF_ONE_ARG(one, more, ...) \
88 _XBT_IF_ONE_ARG_(__VA_ARGS__, \
89 more, more, more, more, more, more, more, more, \
90 more, more, more, more, more, more, more, more, \
91 more, more, more, more, more, more, more, more, \
92 more, more, more, more, more, more, more, more, \
93 more, more, more, more, more, more, more, more, \
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, one)
97 #define _XBT_IF_ONE_ARG_(a64, a63, a62, a61, a60, a59, a58, a57, \
98 a56, a55, a54, a53, a52, a51, a50, a49, \
99 a48, a47, a46, a45, a44, a43, a42, a41, \
100 a40, a39, a38, a37, a36, a35, a34, a33, \
101 a32, a31, a30, a29, a28, a27, a26, a25, \
102 a24, a23, a22, a21, a20, a19, a18, a17, \
103 a16, a15, a14, a13, a12, a11, a10, a9, \
104 a8, a7, a6, a5, a4, a3, a2, a1, N, ...) N
106 /* Expands to number of arguments. */
107 #define _XBT_COUNT_ARGS(...) _XBT_IF_ONE_ARG_(__VA_ARGS__, \
108 64, 63, 62, 61, 60, 59, 58, 57, 56, 55, 54, 53, 52, 51, 50, 49, \
109 48, 47, 46, 45, 44, 43, 42, 41, 40, 39, 38, 37, 36, 35, 34, 33, \
110 32, 31, 30, 29, 28, 27, 26, 25, 24, 23, 22, 21, 20, 19, 18, 17, \
111 16, 15, 14, 13, 12, 11, 10, 9, 8, 7, 6, 5, 4, 3, 2, 1)
113 /* Expands to list with each argument rendered as string. Add more cases if needed. */
114 #define _XBT_STRINGIFY_ARGS(...) _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_02_, __VA_ARGS__)(__VA_ARGS__)
115 #define _XBT_STRINGIFY_A_02_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_03_, __VA_ARGS__)(__VA_ARGS__)
116 #define _XBT_STRINGIFY_A_03_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_04_, __VA_ARGS__)(__VA_ARGS__)
117 #define _XBT_STRINGIFY_A_04_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_05_, __VA_ARGS__)(__VA_ARGS__)
118 #define _XBT_STRINGIFY_A_05_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_06_, __VA_ARGS__)(__VA_ARGS__)
119 #define _XBT_STRINGIFY_A_06_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_07_, __VA_ARGS__)(__VA_ARGS__)
120 #define _XBT_STRINGIFY_A_07_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_08_, __VA_ARGS__)(__VA_ARGS__)
121 #define _XBT_STRINGIFY_A_08_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_09_, __VA_ARGS__)(__VA_ARGS__)
122 #define _XBT_STRINGIFY_A_09_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_10_, __VA_ARGS__)(__VA_ARGS__)
123 #define _XBT_STRINGIFY_A_10_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_11_, __VA_ARGS__)(__VA_ARGS__)
124 #define _XBT_STRINGIFY_A_11_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_12_, __VA_ARGS__)(__VA_ARGS__)
125 #define _XBT_STRINGIFY_A_12_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_13_, __VA_ARGS__)(__VA_ARGS__)
126 #define _XBT_STRINGIFY_A_13_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_14_, __VA_ARGS__)(__VA_ARGS__)
127 #define _XBT_STRINGIFY_A_14_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_15_, __VA_ARGS__)(__VA_ARGS__)
128 #define _XBT_STRINGIFY_A_15_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_16_, __VA_ARGS__)(__VA_ARGS__)
129 #define _XBT_STRINGIFY_A_16_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_17_, __VA_ARGS__)(__VA_ARGS__)
130 #define _XBT_STRINGIFY_A_17_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_18_, __VA_ARGS__)(__VA_ARGS__)
131 #define _XBT_STRINGIFY_A_18_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_19_, __VA_ARGS__)(__VA_ARGS__)
132 #define _XBT_STRINGIFY_A_19_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_20_, __VA_ARGS__)(__VA_ARGS__)
133 #define _XBT_STRINGIFY_A_20_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_21_, __VA_ARGS__)(__VA_ARGS__)
134 #define _XBT_STRINGIFY_A_21_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_22_, __VA_ARGS__)(__VA_ARGS__)
135 #define _XBT_STRINGIFY_A_22_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_23_, __VA_ARGS__)(__VA_ARGS__)
136 #define _XBT_STRINGIFY_A_23_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_24_, __VA_ARGS__)(__VA_ARGS__)
137 #define _XBT_STRINGIFY_A_24_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_25_, __VA_ARGS__)(__VA_ARGS__)
138 #define _XBT_STRINGIFY_A_25_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_26_, __VA_ARGS__)(__VA_ARGS__)
139 #define _XBT_STRINGIFY_A_26_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_27_, __VA_ARGS__)(__VA_ARGS__)
140 #define _XBT_STRINGIFY_A_27_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_28_, __VA_ARGS__)(__VA_ARGS__)
141 #define _XBT_STRINGIFY_A_28_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_29_, __VA_ARGS__)(__VA_ARGS__)
142 #define _XBT_STRINGIFY_A_29_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_30_, __VA_ARGS__)(__VA_ARGS__)
143 #define _XBT_STRINGIFY_A_30_(...) error_maximum_size_of_XBT_STRINGIFY_ARGS_reached
145 /* Rationale of XBT_PUBLIC:
146 * * This is for library symbols visible from the application-land.
147 * Basically, any symbols defined in the include/directory must be like this (plus some other globals).
149 * Just think of it as a special way to say "extern".
153 #define XBT_PUBLIC __attribute__((visibility("default")))
154 # define XBT_PUBLIC_DATA extern __attribute__((visibility("default")))
155 # define XBT_PRIVATE __attribute__((visibility("hidden")))
158 #define XBT_PUBLIC /* public */
159 # define XBT_PUBLIC_DATA extern
160 # define XBT_PRIVATE /** @private */
164 /* C++ users need love */
165 #ifndef SG_BEGIN_DECL
167 # define SG_BEGIN_DECL extern "C" {
169 # define SG_BEGIN_DECL
175 # define SG_END_DECL }
180 /* End of cruft for C++ */